xref: /sqlite-3.40.0/src/expr.c (revision ae80ddea)
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
60*ae80ddeaSdrh ** sequence named by pToken.   Return a pointer to a new Expr node that
61*ae80ddeaSdrh ** implements the COLLATE operator.
628b4c40d8Sdrh */
638342e49fSdrh Expr *sqlite3ExprSetCollByToken(Parse *pParse, Expr *pExpr, Token *pCollName){
64*ae80ddeaSdrh   Expr *pNew = sqlite3ExprAlloc(pParse->db, TK_COLLATE, pCollName, 1);
65*ae80ddeaSdrh   if( pNew ){
66*ae80ddeaSdrh     pNew->pLeft = pExpr;
67*ae80ddeaSdrh     pNew->flags |= EP_Collate;
68*ae80ddeaSdrh   }
69*ae80ddeaSdrh   return pNew;
708b4c40d8Sdrh }
718b4c40d8Sdrh 
728b4c40d8Sdrh /*
73*ae80ddeaSdrh ** Return the collation sequence for the expression pExpr. If
74*ae80ddeaSdrh ** there is no defined collating sequence, return NULL.
75*ae80ddeaSdrh **
76*ae80ddeaSdrh ** The collating sequence might be determined by a COLLATE operator
77*ae80ddeaSdrh ** or by the presence of a column with a defined collating sequence.
78*ae80ddeaSdrh ** COLLATE operators take first precedence.  Left operands take
79*ae80ddeaSdrh ** precedence over right operands.
800202b29eSdanielk1977 */
817cedc8d4Sdanielk1977 CollSeq *sqlite3ExprCollSeq(Parse *pParse, Expr *pExpr){
82*ae80ddeaSdrh   sqlite3 *db = pParse->db;
837cedc8d4Sdanielk1977   CollSeq *pColl = 0;
847d10d5a6Sdrh   Expr *p = pExpr;
85*ae80ddeaSdrh   while( p && pColl==0 ){
86*ae80ddeaSdrh     int op = p->op;
87*ae80ddeaSdrh     if( op==TK_CAST || op==TK_UPLUS ){
88*ae80ddeaSdrh       p = p->pLeft;
89*ae80ddeaSdrh       continue;
90*ae80ddeaSdrh     }
91*ae80ddeaSdrh     if( op==TK_COLLATE ){
92*ae80ddeaSdrh       pColl = sqlite3FindCollSeq(db, ENC(db), p->u.zToken, 0);
93*ae80ddeaSdrh       break;
94*ae80ddeaSdrh     }
95*ae80ddeaSdrh     if( p->pTab!=0
96*ae80ddeaSdrh      && (op==TK_AGG_COLUMN || op==TK_COLUMN
97*ae80ddeaSdrh           || op==TK_REGISTER || op==TK_TRIGGER)
98*ae80ddeaSdrh     ){
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 ){
103*ae80ddeaSdrh         const char *zColl = p->pTab->aCol[j].zColl;
104c4a64facSdrh         pColl = sqlite3FindCollSeq(db, ENC(db), zColl, 0);
1050202b29eSdanielk1977       }
1067d10d5a6Sdrh       break;
1077d10d5a6Sdrh     }
108*ae80ddeaSdrh     if( p->flags & EP_Collate ){
109*ae80ddeaSdrh       if( p->pLeft->flags & EP_Collate ){
1107d10d5a6Sdrh         p = p->pLeft;
111*ae80ddeaSdrh       }else{
112*ae80ddeaSdrh         p = p->pRight;
113*ae80ddeaSdrh       }
114*ae80ddeaSdrh     }else{
115*ae80ddeaSdrh       break;
116*ae80ddeaSdrh     }
117*ae80ddeaSdrh #if 0
118*ae80ddeaSdrh     else if( p->flags & EP_TokenOnly ){
119*ae80ddeaSdrh       break;
120*ae80ddeaSdrh     }else{
121*ae80ddeaSdrh       pColl = sqlite3ExprCollSeq(pParse, p->pLeft);
122*ae80ddeaSdrh       p = p->pRight;
123*ae80ddeaSdrh     }
124*ae80ddeaSdrh #endif
1250202b29eSdanielk1977   }
1267cedc8d4Sdanielk1977   if( sqlite3CheckCollSeq(pParse, pColl) ){
1277cedc8d4Sdanielk1977     pColl = 0;
1287cedc8d4Sdanielk1977   }
1297cedc8d4Sdanielk1977   return pColl;
1300202b29eSdanielk1977 }
1310202b29eSdanielk1977 
1320202b29eSdanielk1977 /*
133626a879aSdrh ** pExpr is an operand of a comparison operator.  aff2 is the
134626a879aSdrh ** type affinity of the other operand.  This routine returns the
13553db1458Sdrh ** type affinity that should be used for the comparison operator.
13653db1458Sdrh */
137e014a838Sdanielk1977 char sqlite3CompareAffinity(Expr *pExpr, char aff2){
138bf3b721fSdanielk1977   char aff1 = sqlite3ExprAffinity(pExpr);
139e014a838Sdanielk1977   if( aff1 && aff2 ){
1408df447f0Sdrh     /* Both sides of the comparison are columns. If one has numeric
1418df447f0Sdrh     ** affinity, use that. Otherwise use no affinity.
142e014a838Sdanielk1977     */
1438a51256cSdrh     if( sqlite3IsNumericAffinity(aff1) || sqlite3IsNumericAffinity(aff2) ){
144e014a838Sdanielk1977       return SQLITE_AFF_NUMERIC;
145e014a838Sdanielk1977     }else{
146e014a838Sdanielk1977       return SQLITE_AFF_NONE;
147e014a838Sdanielk1977     }
148e014a838Sdanielk1977   }else if( !aff1 && !aff2 ){
1495f6a87b3Sdrh     /* Neither side of the comparison is a column.  Compare the
1505f6a87b3Sdrh     ** results directly.
151e014a838Sdanielk1977     */
1525f6a87b3Sdrh     return SQLITE_AFF_NONE;
153e014a838Sdanielk1977   }else{
154e014a838Sdanielk1977     /* One side is a column, the other is not. Use the columns affinity. */
155fe05af87Sdrh     assert( aff1==0 || aff2==0 );
156e014a838Sdanielk1977     return (aff1 + aff2);
157e014a838Sdanielk1977   }
158e014a838Sdanielk1977 }
159e014a838Sdanielk1977 
16053db1458Sdrh /*
16153db1458Sdrh ** pExpr is a comparison operator.  Return the type affinity that should
16253db1458Sdrh ** be applied to both operands prior to doing the comparison.
16353db1458Sdrh */
164e014a838Sdanielk1977 static char comparisonAffinity(Expr *pExpr){
165e014a838Sdanielk1977   char aff;
166e014a838Sdanielk1977   assert( pExpr->op==TK_EQ || pExpr->op==TK_IN || pExpr->op==TK_LT ||
167e014a838Sdanielk1977           pExpr->op==TK_GT || pExpr->op==TK_GE || pExpr->op==TK_LE ||
1686a2fe093Sdrh           pExpr->op==TK_NE || pExpr->op==TK_IS || pExpr->op==TK_ISNOT );
169e014a838Sdanielk1977   assert( pExpr->pLeft );
170bf3b721fSdanielk1977   aff = sqlite3ExprAffinity(pExpr->pLeft);
171e014a838Sdanielk1977   if( pExpr->pRight ){
172e014a838Sdanielk1977     aff = sqlite3CompareAffinity(pExpr->pRight, aff);
1736ab3a2ecSdanielk1977   }else if( ExprHasProperty(pExpr, EP_xIsSelect) ){
1746ab3a2ecSdanielk1977     aff = sqlite3CompareAffinity(pExpr->x.pSelect->pEList->a[0].pExpr, aff);
1756ab3a2ecSdanielk1977   }else if( !aff ){
176de087bd5Sdrh     aff = SQLITE_AFF_NONE;
177e014a838Sdanielk1977   }
178e014a838Sdanielk1977   return aff;
179e014a838Sdanielk1977 }
180e014a838Sdanielk1977 
181e014a838Sdanielk1977 /*
182e014a838Sdanielk1977 ** pExpr is a comparison expression, eg. '=', '<', IN(...) etc.
183e014a838Sdanielk1977 ** idx_affinity is the affinity of an indexed column. Return true
184e014a838Sdanielk1977 ** if the index with affinity idx_affinity may be used to implement
185e014a838Sdanielk1977 ** the comparison in pExpr.
186e014a838Sdanielk1977 */
187e014a838Sdanielk1977 int sqlite3IndexAffinityOk(Expr *pExpr, char idx_affinity){
188e014a838Sdanielk1977   char aff = comparisonAffinity(pExpr);
1898a51256cSdrh   switch( aff ){
1908a51256cSdrh     case SQLITE_AFF_NONE:
1918a51256cSdrh       return 1;
1928a51256cSdrh     case SQLITE_AFF_TEXT:
1938a51256cSdrh       return idx_affinity==SQLITE_AFF_TEXT;
1948a51256cSdrh     default:
1958a51256cSdrh       return sqlite3IsNumericAffinity(idx_affinity);
1968a51256cSdrh   }
197e014a838Sdanielk1977 }
198e014a838Sdanielk1977 
199a37cdde0Sdanielk1977 /*
20035573356Sdrh ** Return the P5 value that should be used for a binary comparison
201a37cdde0Sdanielk1977 ** opcode (OP_Eq, OP_Ge etc.) used to compare pExpr1 and pExpr2.
202a37cdde0Sdanielk1977 */
20335573356Sdrh static u8 binaryCompareP5(Expr *pExpr1, Expr *pExpr2, int jumpIfNull){
20435573356Sdrh   u8 aff = (char)sqlite3ExprAffinity(pExpr2);
2051bd10f8aSdrh   aff = (u8)sqlite3CompareAffinity(pExpr1, aff) | (u8)jumpIfNull;
20635573356Sdrh   return aff;
207a37cdde0Sdanielk1977 }
208a37cdde0Sdanielk1977 
209a2e00042Sdrh /*
2100202b29eSdanielk1977 ** Return a pointer to the collation sequence that should be used by
2110202b29eSdanielk1977 ** a binary comparison operator comparing pLeft and pRight.
2120202b29eSdanielk1977 **
2130202b29eSdanielk1977 ** If the left hand expression has a collating sequence type, then it is
2140202b29eSdanielk1977 ** used. Otherwise the collation sequence for the right hand expression
2150202b29eSdanielk1977 ** is used, or the default (BINARY) if neither expression has a collating
2160202b29eSdanielk1977 ** type.
217bcbb04e5Sdanielk1977 **
218bcbb04e5Sdanielk1977 ** Argument pRight (but not pLeft) may be a null pointer. In this case,
219bcbb04e5Sdanielk1977 ** it is not considered.
2200202b29eSdanielk1977 */
221bcbb04e5Sdanielk1977 CollSeq *sqlite3BinaryCompareCollSeq(
222bcbb04e5Sdanielk1977   Parse *pParse,
223bcbb04e5Sdanielk1977   Expr *pLeft,
224bcbb04e5Sdanielk1977   Expr *pRight
225bcbb04e5Sdanielk1977 ){
226ec41ddacSdrh   CollSeq *pColl;
227ec41ddacSdrh   assert( pLeft );
228*ae80ddeaSdrh   if( pLeft->flags & EP_Collate ){
229*ae80ddeaSdrh     pColl = sqlite3ExprCollSeq(pParse, pLeft);
230*ae80ddeaSdrh   }else if( pRight && (pRight->flags & EP_Collate)!=0 ){
231*ae80ddeaSdrh     pColl = sqlite3ExprCollSeq(pParse, pRight);
232ec41ddacSdrh   }else{
233ec41ddacSdrh     pColl = sqlite3ExprCollSeq(pParse, pLeft);
2340202b29eSdanielk1977     if( !pColl ){
2357cedc8d4Sdanielk1977       pColl = sqlite3ExprCollSeq(pParse, pRight);
2360202b29eSdanielk1977     }
237ec41ddacSdrh   }
2380202b29eSdanielk1977   return pColl;
2390202b29eSdanielk1977 }
2400202b29eSdanielk1977 
2410202b29eSdanielk1977 /*
242be5c89acSdrh ** Generate code for a comparison operator.
243be5c89acSdrh */
244be5c89acSdrh static int codeCompare(
245be5c89acSdrh   Parse *pParse,    /* The parsing (and code generating) context */
246be5c89acSdrh   Expr *pLeft,      /* The left operand */
247be5c89acSdrh   Expr *pRight,     /* The right operand */
248be5c89acSdrh   int opcode,       /* The comparison opcode */
24935573356Sdrh   int in1, int in2, /* Register holding operands */
250be5c89acSdrh   int dest,         /* Jump here if true.  */
251be5c89acSdrh   int jumpIfNull    /* If true, jump if either operand is NULL */
252be5c89acSdrh ){
25335573356Sdrh   int p5;
25435573356Sdrh   int addr;
25535573356Sdrh   CollSeq *p4;
25635573356Sdrh 
25735573356Sdrh   p4 = sqlite3BinaryCompareCollSeq(pParse, pLeft, pRight);
25835573356Sdrh   p5 = binaryCompareP5(pLeft, pRight, jumpIfNull);
25935573356Sdrh   addr = sqlite3VdbeAddOp4(pParse->pVdbe, opcode, in2, dest, in1,
26035573356Sdrh                            (void*)p4, P4_COLLSEQ);
2611bd10f8aSdrh   sqlite3VdbeChangeP5(pParse->pVdbe, (u8)p5);
26235573356Sdrh   return addr;
263be5c89acSdrh }
264be5c89acSdrh 
2654b5255acSdanielk1977 #if SQLITE_MAX_EXPR_DEPTH>0
2664b5255acSdanielk1977 /*
2674b5255acSdanielk1977 ** Check that argument nHeight is less than or equal to the maximum
2684b5255acSdanielk1977 ** expression depth allowed. If it is not, leave an error message in
2694b5255acSdanielk1977 ** pParse.
2704b5255acSdanielk1977 */
2717d10d5a6Sdrh int sqlite3ExprCheckHeight(Parse *pParse, int nHeight){
2724b5255acSdanielk1977   int rc = SQLITE_OK;
2734b5255acSdanielk1977   int mxHeight = pParse->db->aLimit[SQLITE_LIMIT_EXPR_DEPTH];
2744b5255acSdanielk1977   if( nHeight>mxHeight ){
2754b5255acSdanielk1977     sqlite3ErrorMsg(pParse,
2764b5255acSdanielk1977        "Expression tree is too large (maximum depth %d)", mxHeight
2774b5255acSdanielk1977     );
2784b5255acSdanielk1977     rc = SQLITE_ERROR;
2794b5255acSdanielk1977   }
2804b5255acSdanielk1977   return rc;
2814b5255acSdanielk1977 }
2824b5255acSdanielk1977 
2834b5255acSdanielk1977 /* The following three functions, heightOfExpr(), heightOfExprList()
2844b5255acSdanielk1977 ** and heightOfSelect(), are used to determine the maximum height
2854b5255acSdanielk1977 ** of any expression tree referenced by the structure passed as the
2864b5255acSdanielk1977 ** first argument.
2874b5255acSdanielk1977 **
2884b5255acSdanielk1977 ** If this maximum height is greater than the current value pointed
2894b5255acSdanielk1977 ** to by pnHeight, the second parameter, then set *pnHeight to that
2904b5255acSdanielk1977 ** value.
2914b5255acSdanielk1977 */
2924b5255acSdanielk1977 static void heightOfExpr(Expr *p, int *pnHeight){
2934b5255acSdanielk1977   if( p ){
2944b5255acSdanielk1977     if( p->nHeight>*pnHeight ){
2954b5255acSdanielk1977       *pnHeight = p->nHeight;
2964b5255acSdanielk1977     }
2974b5255acSdanielk1977   }
2984b5255acSdanielk1977 }
2994b5255acSdanielk1977 static void heightOfExprList(ExprList *p, int *pnHeight){
3004b5255acSdanielk1977   if( p ){
3014b5255acSdanielk1977     int i;
3024b5255acSdanielk1977     for(i=0; i<p->nExpr; i++){
3034b5255acSdanielk1977       heightOfExpr(p->a[i].pExpr, pnHeight);
3044b5255acSdanielk1977     }
3054b5255acSdanielk1977   }
3064b5255acSdanielk1977 }
3074b5255acSdanielk1977 static void heightOfSelect(Select *p, int *pnHeight){
3084b5255acSdanielk1977   if( p ){
3094b5255acSdanielk1977     heightOfExpr(p->pWhere, pnHeight);
3104b5255acSdanielk1977     heightOfExpr(p->pHaving, pnHeight);
3114b5255acSdanielk1977     heightOfExpr(p->pLimit, pnHeight);
3124b5255acSdanielk1977     heightOfExpr(p->pOffset, pnHeight);
3134b5255acSdanielk1977     heightOfExprList(p->pEList, pnHeight);
3144b5255acSdanielk1977     heightOfExprList(p->pGroupBy, pnHeight);
3154b5255acSdanielk1977     heightOfExprList(p->pOrderBy, pnHeight);
3164b5255acSdanielk1977     heightOfSelect(p->pPrior, pnHeight);
3174b5255acSdanielk1977   }
3184b5255acSdanielk1977 }
3194b5255acSdanielk1977 
3204b5255acSdanielk1977 /*
3214b5255acSdanielk1977 ** Set the Expr.nHeight variable in the structure passed as an
3224b5255acSdanielk1977 ** argument. An expression with no children, Expr.pList or
3234b5255acSdanielk1977 ** Expr.pSelect member has a height of 1. Any other expression
3244b5255acSdanielk1977 ** has a height equal to the maximum height of any other
3254b5255acSdanielk1977 ** referenced Expr plus one.
3264b5255acSdanielk1977 */
3274b5255acSdanielk1977 static void exprSetHeight(Expr *p){
3284b5255acSdanielk1977   int nHeight = 0;
3294b5255acSdanielk1977   heightOfExpr(p->pLeft, &nHeight);
3304b5255acSdanielk1977   heightOfExpr(p->pRight, &nHeight);
3316ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_xIsSelect) ){
3326ab3a2ecSdanielk1977     heightOfSelect(p->x.pSelect, &nHeight);
3336ab3a2ecSdanielk1977   }else{
3346ab3a2ecSdanielk1977     heightOfExprList(p->x.pList, &nHeight);
3356ab3a2ecSdanielk1977   }
3364b5255acSdanielk1977   p->nHeight = nHeight + 1;
3374b5255acSdanielk1977 }
3384b5255acSdanielk1977 
3394b5255acSdanielk1977 /*
3404b5255acSdanielk1977 ** Set the Expr.nHeight variable using the exprSetHeight() function. If
3414b5255acSdanielk1977 ** the height is greater than the maximum allowed expression depth,
3424b5255acSdanielk1977 ** leave an error in pParse.
3434b5255acSdanielk1977 */
3444b5255acSdanielk1977 void sqlite3ExprSetHeight(Parse *pParse, Expr *p){
3454b5255acSdanielk1977   exprSetHeight(p);
3467d10d5a6Sdrh   sqlite3ExprCheckHeight(pParse, p->nHeight);
3474b5255acSdanielk1977 }
3484b5255acSdanielk1977 
3494b5255acSdanielk1977 /*
3504b5255acSdanielk1977 ** Return the maximum height of any expression tree referenced
3514b5255acSdanielk1977 ** by the select statement passed as an argument.
3524b5255acSdanielk1977 */
3534b5255acSdanielk1977 int sqlite3SelectExprHeight(Select *p){
3544b5255acSdanielk1977   int nHeight = 0;
3554b5255acSdanielk1977   heightOfSelect(p, &nHeight);
3564b5255acSdanielk1977   return nHeight;
3574b5255acSdanielk1977 }
3584b5255acSdanielk1977 #else
3594b5255acSdanielk1977   #define exprSetHeight(y)
3604b5255acSdanielk1977 #endif /* SQLITE_MAX_EXPR_DEPTH>0 */
3614b5255acSdanielk1977 
362be5c89acSdrh /*
363b7916a78Sdrh ** This routine is the core allocator for Expr nodes.
364b7916a78Sdrh **
365a76b5dfcSdrh ** Construct a new expression node and return a pointer to it.  Memory
366b7916a78Sdrh ** for this node and for the pToken argument is a single allocation
367b7916a78Sdrh ** obtained from sqlite3DbMalloc().  The calling function
368a76b5dfcSdrh ** is responsible for making sure the node eventually gets freed.
369b7916a78Sdrh **
370b7916a78Sdrh ** If dequote is true, then the token (if it exists) is dequoted.
371b7916a78Sdrh ** If dequote is false, no dequoting is performance.  The deQuote
372b7916a78Sdrh ** parameter is ignored if pToken is NULL or if the token does not
373b7916a78Sdrh ** appear to be quoted.  If the quotes were of the form "..." (double-quotes)
374b7916a78Sdrh ** then the EP_DblQuoted flag is set on the expression node.
37533e619fcSdrh **
37633e619fcSdrh ** Special case:  If op==TK_INTEGER and pToken points to a string that
37733e619fcSdrh ** can be translated into a 32-bit integer, then the token is not
37833e619fcSdrh ** stored in u.zToken.  Instead, the integer values is written
37933e619fcSdrh ** into u.iValue and the EP_IntValue flag is set.  No extra storage
38033e619fcSdrh ** is allocated to hold the integer text and the dequote flag is ignored.
381a76b5dfcSdrh */
382b7916a78Sdrh Expr *sqlite3ExprAlloc(
383a1644fd8Sdanielk1977   sqlite3 *db,            /* Handle for sqlite3DbMallocZero() (may be null) */
38417435752Sdrh   int op,                 /* Expression opcode */
385b7916a78Sdrh   const Token *pToken,    /* Token argument.  Might be NULL */
386b7916a78Sdrh   int dequote             /* True to dequote */
38717435752Sdrh ){
388a76b5dfcSdrh   Expr *pNew;
38933e619fcSdrh   int nExtra = 0;
390cf697396Sshane   int iValue = 0;
391b7916a78Sdrh 
392b7916a78Sdrh   if( pToken ){
39333e619fcSdrh     if( op!=TK_INTEGER || pToken->z==0
39433e619fcSdrh           || sqlite3GetInt32(pToken->z, &iValue)==0 ){
395b7916a78Sdrh       nExtra = pToken->n+1;
396d50ffc41Sdrh       assert( iValue>=0 );
39733e619fcSdrh     }
398a76b5dfcSdrh   }
399b7916a78Sdrh   pNew = sqlite3DbMallocZero(db, sizeof(Expr)+nExtra);
400b7916a78Sdrh   if( pNew ){
4011bd10f8aSdrh     pNew->op = (u8)op;
402a58fdfb1Sdanielk1977     pNew->iAgg = -1;
403a76b5dfcSdrh     if( pToken ){
40433e619fcSdrh       if( nExtra==0 ){
40533e619fcSdrh         pNew->flags |= EP_IntValue;
40633e619fcSdrh         pNew->u.iValue = iValue;
40733e619fcSdrh       }else{
408d9da78a2Sdrh         int c;
40933e619fcSdrh         pNew->u.zToken = (char*)&pNew[1];
410b07028f7Sdrh         assert( pToken->z!=0 || pToken->n==0 );
411b07028f7Sdrh         if( pToken->n ) memcpy(pNew->u.zToken, pToken->z, pToken->n);
41233e619fcSdrh         pNew->u.zToken[pToken->n] = 0;
413b7916a78Sdrh         if( dequote && nExtra>=3
414d9da78a2Sdrh              && ((c = pToken->z[0])=='\'' || c=='"' || c=='[' || c=='`') ){
41533e619fcSdrh           sqlite3Dequote(pNew->u.zToken);
41624fb627aSdrh           if( c=='"' ) pNew->flags |= EP_DblQuoted;
417a34001c9Sdrh         }
418a34001c9Sdrh       }
41933e619fcSdrh     }
420b7916a78Sdrh #if SQLITE_MAX_EXPR_DEPTH>0
421b7916a78Sdrh     pNew->nHeight = 1;
422b7916a78Sdrh #endif
423a34001c9Sdrh   }
424a76b5dfcSdrh   return pNew;
425a76b5dfcSdrh }
426a76b5dfcSdrh 
427a76b5dfcSdrh /*
428b7916a78Sdrh ** Allocate a new expression node from a zero-terminated token that has
429b7916a78Sdrh ** already been dequoted.
430b7916a78Sdrh */
431b7916a78Sdrh Expr *sqlite3Expr(
432b7916a78Sdrh   sqlite3 *db,            /* Handle for sqlite3DbMallocZero() (may be null) */
433b7916a78Sdrh   int op,                 /* Expression opcode */
434b7916a78Sdrh   const char *zToken      /* Token argument.  Might be NULL */
435b7916a78Sdrh ){
436b7916a78Sdrh   Token x;
437b7916a78Sdrh   x.z = zToken;
438b7916a78Sdrh   x.n = zToken ? sqlite3Strlen30(zToken) : 0;
439b7916a78Sdrh   return sqlite3ExprAlloc(db, op, &x, 0);
440b7916a78Sdrh }
441b7916a78Sdrh 
442b7916a78Sdrh /*
443b7916a78Sdrh ** Attach subtrees pLeft and pRight to the Expr node pRoot.
444b7916a78Sdrh **
445b7916a78Sdrh ** If pRoot==NULL that means that a memory allocation error has occurred.
446b7916a78Sdrh ** In that case, delete the subtrees pLeft and pRight.
447b7916a78Sdrh */
448b7916a78Sdrh void sqlite3ExprAttachSubtrees(
449b7916a78Sdrh   sqlite3 *db,
450b7916a78Sdrh   Expr *pRoot,
451b7916a78Sdrh   Expr *pLeft,
452b7916a78Sdrh   Expr *pRight
453b7916a78Sdrh ){
454b7916a78Sdrh   if( pRoot==0 ){
455b7916a78Sdrh     assert( db->mallocFailed );
456b7916a78Sdrh     sqlite3ExprDelete(db, pLeft);
457b7916a78Sdrh     sqlite3ExprDelete(db, pRight);
458b7916a78Sdrh   }else{
459b7916a78Sdrh     if( pRight ){
460b7916a78Sdrh       pRoot->pRight = pRight;
461*ae80ddeaSdrh       pRoot->flags |= EP_Collate & pRight->flags;
462b7916a78Sdrh     }
463b7916a78Sdrh     if( pLeft ){
464b7916a78Sdrh       pRoot->pLeft = pLeft;
465*ae80ddeaSdrh       pRoot->flags |= EP_Collate & pLeft->flags;
466b7916a78Sdrh     }
467b7916a78Sdrh     exprSetHeight(pRoot);
468b7916a78Sdrh   }
469b7916a78Sdrh }
470b7916a78Sdrh 
471b7916a78Sdrh /*
472bf664469Sdrh ** Allocate a Expr node which joins as many as two subtrees.
473b7916a78Sdrh **
474bf664469Sdrh ** One or both of the subtrees can be NULL.  Return a pointer to the new
475bf664469Sdrh ** Expr node.  Or, if an OOM error occurs, set pParse->db->mallocFailed,
476bf664469Sdrh ** free the subtrees and return NULL.
477206f3d96Sdrh */
47817435752Sdrh Expr *sqlite3PExpr(
47917435752Sdrh   Parse *pParse,          /* Parsing context */
48017435752Sdrh   int op,                 /* Expression opcode */
48117435752Sdrh   Expr *pLeft,            /* Left operand */
48217435752Sdrh   Expr *pRight,           /* Right operand */
48317435752Sdrh   const Token *pToken     /* Argument token */
48417435752Sdrh ){
4855fb52caaSdrh   Expr *p;
4865fb52caaSdrh   if( op==TK_AND && pLeft && pRight ){
4875fb52caaSdrh     /* Take advantage of short-circuit false optimization for AND */
4885fb52caaSdrh     p = sqlite3ExprAnd(pParse->db, pLeft, pRight);
4895fb52caaSdrh   }else{
4905fb52caaSdrh     p = sqlite3ExprAlloc(pParse->db, op, pToken, 1);
491b7916a78Sdrh     sqlite3ExprAttachSubtrees(pParse->db, p, pLeft, pRight);
4925fb52caaSdrh   }
4932b359bdbSdan   if( p ) {
4942b359bdbSdan     sqlite3ExprCheckHeight(pParse, p->nHeight);
4952b359bdbSdan   }
4964e0cff60Sdrh   return p;
4974e0cff60Sdrh }
4984e0cff60Sdrh 
4994e0cff60Sdrh /*
5005fb52caaSdrh ** Return 1 if an expression must be FALSE in all cases and 0 if the
5015fb52caaSdrh ** expression might be true.  This is an optimization.  If is OK to
5025fb52caaSdrh ** return 0 here even if the expression really is always false (a
5035fb52caaSdrh ** false negative).  But it is a bug to return 1 if the expression
5045fb52caaSdrh ** might be true in some rare circumstances (a false positive.)
5055fb52caaSdrh **
5065fb52caaSdrh ** Note that if the expression is part of conditional for a
5075fb52caaSdrh ** LEFT JOIN, then we cannot determine at compile-time whether or not
5085fb52caaSdrh ** is it true or false, so always return 0.
5095fb52caaSdrh */
5105fb52caaSdrh static int exprAlwaysFalse(Expr *p){
5115fb52caaSdrh   int v = 0;
5125fb52caaSdrh   if( ExprHasProperty(p, EP_FromJoin) ) return 0;
5135fb52caaSdrh   if( !sqlite3ExprIsInteger(p, &v) ) return 0;
5145fb52caaSdrh   return v==0;
5155fb52caaSdrh }
5165fb52caaSdrh 
5175fb52caaSdrh /*
51891bb0eedSdrh ** Join two expressions using an AND operator.  If either expression is
51991bb0eedSdrh ** NULL, then just return the other expression.
5205fb52caaSdrh **
5215fb52caaSdrh ** If one side or the other of the AND is known to be false, then instead
5225fb52caaSdrh ** of returning an AND expression, just return a constant expression with
5235fb52caaSdrh ** a value of false.
52491bb0eedSdrh */
5251e536953Sdanielk1977 Expr *sqlite3ExprAnd(sqlite3 *db, Expr *pLeft, Expr *pRight){
52691bb0eedSdrh   if( pLeft==0 ){
52791bb0eedSdrh     return pRight;
52891bb0eedSdrh   }else if( pRight==0 ){
52991bb0eedSdrh     return pLeft;
5305fb52caaSdrh   }else if( exprAlwaysFalse(pLeft) || exprAlwaysFalse(pRight) ){
5315fb52caaSdrh     sqlite3ExprDelete(db, pLeft);
5325fb52caaSdrh     sqlite3ExprDelete(db, pRight);
5335fb52caaSdrh     return sqlite3ExprAlloc(db, TK_INTEGER, &sqlite3IntTokens[0], 0);
53491bb0eedSdrh   }else{
535b7916a78Sdrh     Expr *pNew = sqlite3ExprAlloc(db, TK_AND, 0, 0);
536b7916a78Sdrh     sqlite3ExprAttachSubtrees(db, pNew, pLeft, pRight);
537b7916a78Sdrh     return pNew;
538a76b5dfcSdrh   }
539a76b5dfcSdrh }
540a76b5dfcSdrh 
541a76b5dfcSdrh /*
542a76b5dfcSdrh ** Construct a new expression node for a function with multiple
543a76b5dfcSdrh ** arguments.
544a76b5dfcSdrh */
54517435752Sdrh Expr *sqlite3ExprFunction(Parse *pParse, ExprList *pList, Token *pToken){
546a76b5dfcSdrh   Expr *pNew;
547633e6d57Sdrh   sqlite3 *db = pParse->db;
5484b202ae2Sdanielk1977   assert( pToken );
549b7916a78Sdrh   pNew = sqlite3ExprAlloc(db, TK_FUNCTION, pToken, 1);
550a76b5dfcSdrh   if( pNew==0 ){
551d9da78a2Sdrh     sqlite3ExprListDelete(db, pList); /* Avoid memory leak when malloc fails */
552a76b5dfcSdrh     return 0;
553a76b5dfcSdrh   }
5546ab3a2ecSdanielk1977   pNew->x.pList = pList;
5556ab3a2ecSdanielk1977   assert( !ExprHasProperty(pNew, EP_xIsSelect) );
5564b5255acSdanielk1977   sqlite3ExprSetHeight(pParse, pNew);
557a76b5dfcSdrh   return pNew;
558a76b5dfcSdrh }
559a76b5dfcSdrh 
560a76b5dfcSdrh /*
561fa6bc000Sdrh ** Assign a variable number to an expression that encodes a wildcard
562fa6bc000Sdrh ** in the original SQL statement.
563fa6bc000Sdrh **
564fa6bc000Sdrh ** Wildcards consisting of a single "?" are assigned the next sequential
565fa6bc000Sdrh ** variable number.
566fa6bc000Sdrh **
567fa6bc000Sdrh ** Wildcards of the form "?nnn" are assigned the number "nnn".  We make
568fa6bc000Sdrh ** sure "nnn" is not too be to avoid a denial of service attack when
569fa6bc000Sdrh ** the SQL statement comes from an external source.
570fa6bc000Sdrh **
57151f49f17Sdrh ** Wildcards of the form ":aaa", "@aaa", or "$aaa" are assigned the same number
572fa6bc000Sdrh ** as the previous instance of the same wildcard.  Or if this is the first
573fa6bc000Sdrh ** instance of the wildcard, the next sequenial variable number is
574fa6bc000Sdrh ** assigned.
575fa6bc000Sdrh */
576fa6bc000Sdrh void sqlite3ExprAssignVarNumber(Parse *pParse, Expr *pExpr){
57717435752Sdrh   sqlite3 *db = pParse->db;
578b7916a78Sdrh   const char *z;
57917435752Sdrh 
580fa6bc000Sdrh   if( pExpr==0 ) return;
58133e619fcSdrh   assert( !ExprHasAnyProperty(pExpr, EP_IntValue|EP_Reduced|EP_TokenOnly) );
58233e619fcSdrh   z = pExpr->u.zToken;
583b7916a78Sdrh   assert( z!=0 );
584b7916a78Sdrh   assert( z[0]!=0 );
585b7916a78Sdrh   if( z[1]==0 ){
586fa6bc000Sdrh     /* Wildcard of the form "?".  Assign the next variable number */
587b7916a78Sdrh     assert( z[0]=='?' );
5888677d308Sdrh     pExpr->iColumn = (ynVar)(++pParse->nVar);
589124c0b49Sdrh   }else{
590124c0b49Sdrh     ynVar x = 0;
591124c0b49Sdrh     u32 n = sqlite3Strlen30(z);
592124c0b49Sdrh     if( z[0]=='?' ){
593fa6bc000Sdrh       /* Wildcard of the form "?nnn".  Convert "nnn" to an integer and
594fa6bc000Sdrh       ** use it as the variable number */
595c8d735aeSdan       i64 i;
596124c0b49Sdrh       int bOk = 0==sqlite3Atoi64(&z[1], &i, n-1, SQLITE_UTF8);
597124c0b49Sdrh       pExpr->iColumn = x = (ynVar)i;
598c5499befSdrh       testcase( i==0 );
599c5499befSdrh       testcase( i==1 );
600c5499befSdrh       testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]-1 );
601c5499befSdrh       testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] );
602c8d735aeSdan       if( bOk==0 || i<1 || i>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
603fa6bc000Sdrh         sqlite3ErrorMsg(pParse, "variable number must be between ?1 and ?%d",
604bb4957f8Sdrh             db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]);
605124c0b49Sdrh         x = 0;
606fa6bc000Sdrh       }
607fa6bc000Sdrh       if( i>pParse->nVar ){
6081df2db7fSshaneh         pParse->nVar = (int)i;
609fa6bc000Sdrh       }
610fa6bc000Sdrh     }else{
61151f49f17Sdrh       /* Wildcards like ":aaa", "$aaa" or "@aaa".  Reuse the same variable
612fa6bc000Sdrh       ** number as the prior appearance of the same name, or if the name
613fa6bc000Sdrh       ** has never appeared before, reuse the same variable number
614fa6bc000Sdrh       */
615124c0b49Sdrh       ynVar i;
616124c0b49Sdrh       for(i=0; i<pParse->nzVar; i++){
617124c0b49Sdrh         if( pParse->azVar[i] && memcmp(pParse->azVar[i],z,n+1)==0 ){
618124c0b49Sdrh           pExpr->iColumn = x = (ynVar)i+1;
619fa6bc000Sdrh           break;
620fa6bc000Sdrh         }
621fa6bc000Sdrh       }
622124c0b49Sdrh       if( x==0 ) x = pExpr->iColumn = (ynVar)(++pParse->nVar);
623fa6bc000Sdrh     }
624124c0b49Sdrh     if( x>0 ){
625124c0b49Sdrh       if( x>pParse->nzVar ){
626124c0b49Sdrh         char **a;
627124c0b49Sdrh         a = sqlite3DbRealloc(db, pParse->azVar, x*sizeof(a[0]));
628124c0b49Sdrh         if( a==0 ) return;  /* Error reported through db->mallocFailed */
629124c0b49Sdrh         pParse->azVar = a;
630124c0b49Sdrh         memset(&a[pParse->nzVar], 0, (x-pParse->nzVar)*sizeof(a[0]));
631124c0b49Sdrh         pParse->nzVar = x;
632124c0b49Sdrh       }
633124c0b49Sdrh       if( z[0]!='?' || pParse->azVar[x-1]==0 ){
634124c0b49Sdrh         sqlite3DbFree(db, pParse->azVar[x-1]);
635124c0b49Sdrh         pParse->azVar[x-1] = sqlite3DbStrNDup(db, z, n);
636fa6bc000Sdrh       }
637fa6bc000Sdrh     }
638fa6bc000Sdrh   }
639bb4957f8Sdrh   if( !pParse->nErr && pParse->nVar>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
640832b2664Sdanielk1977     sqlite3ErrorMsg(pParse, "too many SQL variables");
641832b2664Sdanielk1977   }
642fa6bc000Sdrh }
643fa6bc000Sdrh 
644fa6bc000Sdrh /*
645f6963f99Sdan ** Recursively delete an expression tree.
646a2e00042Sdrh */
647f6963f99Sdan void sqlite3ExprDelete(sqlite3 *db, Expr *p){
648f6963f99Sdan   if( p==0 ) return;
649d50ffc41Sdrh   /* Sanity check: Assert that the IntValue is non-negative if it exists */
650d50ffc41Sdrh   assert( !ExprHasProperty(p, EP_IntValue) || p->u.iValue>=0 );
651b7916a78Sdrh   if( !ExprHasAnyProperty(p, EP_TokenOnly) ){
652633e6d57Sdrh     sqlite3ExprDelete(db, p->pLeft);
653633e6d57Sdrh     sqlite3ExprDelete(db, p->pRight);
65433e619fcSdrh     if( !ExprHasProperty(p, EP_Reduced) && (p->flags2 & EP2_MallocedToken)!=0 ){
65533e619fcSdrh       sqlite3DbFree(db, p->u.zToken);
6566ab3a2ecSdanielk1977     }
6576ab3a2ecSdanielk1977     if( ExprHasProperty(p, EP_xIsSelect) ){
6586ab3a2ecSdanielk1977       sqlite3SelectDelete(db, p->x.pSelect);
6596ab3a2ecSdanielk1977     }else{
6606ab3a2ecSdanielk1977       sqlite3ExprListDelete(db, p->x.pList);
6616ab3a2ecSdanielk1977     }
6626ab3a2ecSdanielk1977   }
66333e619fcSdrh   if( !ExprHasProperty(p, EP_Static) ){
664633e6d57Sdrh     sqlite3DbFree(db, p);
665a2e00042Sdrh   }
66633e619fcSdrh }
667a2e00042Sdrh 
668d2687b77Sdrh /*
6696ab3a2ecSdanielk1977 ** Return the number of bytes allocated for the expression structure
6706ab3a2ecSdanielk1977 ** passed as the first argument. This is always one of EXPR_FULLSIZE,
6716ab3a2ecSdanielk1977 ** EXPR_REDUCEDSIZE or EXPR_TOKENONLYSIZE.
6726ab3a2ecSdanielk1977 */
6736ab3a2ecSdanielk1977 static int exprStructSize(Expr *p){
6746ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_TokenOnly) ) return EXPR_TOKENONLYSIZE;
6756ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_Reduced) ) return EXPR_REDUCEDSIZE;
6766ab3a2ecSdanielk1977   return EXPR_FULLSIZE;
6776ab3a2ecSdanielk1977 }
6786ab3a2ecSdanielk1977 
6796ab3a2ecSdanielk1977 /*
68033e619fcSdrh ** The dupedExpr*Size() routines each return the number of bytes required
68133e619fcSdrh ** to store a copy of an expression or expression tree.  They differ in
68233e619fcSdrh ** how much of the tree is measured.
68333e619fcSdrh **
68433e619fcSdrh **     dupedExprStructSize()     Size of only the Expr structure
68533e619fcSdrh **     dupedExprNodeSize()       Size of Expr + space for token
68633e619fcSdrh **     dupedExprSize()           Expr + token + subtree components
68733e619fcSdrh **
68833e619fcSdrh ***************************************************************************
68933e619fcSdrh **
69033e619fcSdrh ** The dupedExprStructSize() function returns two values OR-ed together:
69133e619fcSdrh ** (1) the space required for a copy of the Expr structure only and
69233e619fcSdrh ** (2) the EP_xxx flags that indicate what the structure size should be.
69333e619fcSdrh ** The return values is always one of:
69433e619fcSdrh **
69533e619fcSdrh **      EXPR_FULLSIZE
69633e619fcSdrh **      EXPR_REDUCEDSIZE   | EP_Reduced
69733e619fcSdrh **      EXPR_TOKENONLYSIZE | EP_TokenOnly
69833e619fcSdrh **
69933e619fcSdrh ** The size of the structure can be found by masking the return value
70033e619fcSdrh ** of this routine with 0xfff.  The flags can be found by masking the
70133e619fcSdrh ** return value with EP_Reduced|EP_TokenOnly.
70233e619fcSdrh **
70333e619fcSdrh ** Note that with flags==EXPRDUP_REDUCE, this routines works on full-size
70433e619fcSdrh ** (unreduced) Expr objects as they or originally constructed by the parser.
70533e619fcSdrh ** During expression analysis, extra information is computed and moved into
70633e619fcSdrh ** later parts of teh Expr object and that extra information might get chopped
70733e619fcSdrh ** off if the expression is reduced.  Note also that it does not work to
70833e619fcSdrh ** make a EXPRDUP_REDUCE copy of a reduced expression.  It is only legal
70933e619fcSdrh ** to reduce a pristine expression tree from the parser.  The implementation
71033e619fcSdrh ** of dupedExprStructSize() contain multiple assert() statements that attempt
71133e619fcSdrh ** to enforce this constraint.
7126ab3a2ecSdanielk1977 */
7136ab3a2ecSdanielk1977 static int dupedExprStructSize(Expr *p, int flags){
7146ab3a2ecSdanielk1977   int nSize;
71533e619fcSdrh   assert( flags==EXPRDUP_REDUCE || flags==0 ); /* Only one flag value allowed */
7166ab3a2ecSdanielk1977   if( 0==(flags&EXPRDUP_REDUCE) ){
7176ab3a2ecSdanielk1977     nSize = EXPR_FULLSIZE;
7186ab3a2ecSdanielk1977   }else{
71933e619fcSdrh     assert( !ExprHasAnyProperty(p, EP_TokenOnly|EP_Reduced) );
72033e619fcSdrh     assert( !ExprHasProperty(p, EP_FromJoin) );
72133e619fcSdrh     assert( (p->flags2 & EP2_MallocedToken)==0 );
72233e619fcSdrh     assert( (p->flags2 & EP2_Irreducible)==0 );
723*ae80ddeaSdrh     if( p->pLeft || p->pRight || p->x.pList ){
72433e619fcSdrh       nSize = EXPR_REDUCEDSIZE | EP_Reduced;
72533e619fcSdrh     }else{
72633e619fcSdrh       nSize = EXPR_TOKENONLYSIZE | EP_TokenOnly;
72733e619fcSdrh     }
7286ab3a2ecSdanielk1977   }
7296ab3a2ecSdanielk1977   return nSize;
7306ab3a2ecSdanielk1977 }
7316ab3a2ecSdanielk1977 
7326ab3a2ecSdanielk1977 /*
73333e619fcSdrh ** This function returns the space in bytes required to store the copy
73433e619fcSdrh ** of the Expr structure and a copy of the Expr.u.zToken string (if that
73533e619fcSdrh ** string is defined.)
7366ab3a2ecSdanielk1977 */
7376ab3a2ecSdanielk1977 static int dupedExprNodeSize(Expr *p, int flags){
73833e619fcSdrh   int nByte = dupedExprStructSize(p, flags) & 0xfff;
73933e619fcSdrh   if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
74033e619fcSdrh     nByte += sqlite3Strlen30(p->u.zToken)+1;
7416ab3a2ecSdanielk1977   }
742bc73971dSdanielk1977   return ROUND8(nByte);
7436ab3a2ecSdanielk1977 }
7446ab3a2ecSdanielk1977 
7456ab3a2ecSdanielk1977 /*
7466ab3a2ecSdanielk1977 ** Return the number of bytes required to create a duplicate of the
7476ab3a2ecSdanielk1977 ** expression passed as the first argument. The second argument is a
7486ab3a2ecSdanielk1977 ** mask containing EXPRDUP_XXX flags.
7496ab3a2ecSdanielk1977 **
7506ab3a2ecSdanielk1977 ** The value returned includes space to create a copy of the Expr struct
75133e619fcSdrh ** itself and the buffer referred to by Expr.u.zToken, if any.
7526ab3a2ecSdanielk1977 **
7536ab3a2ecSdanielk1977 ** If the EXPRDUP_REDUCE flag is set, then the return value includes
7546ab3a2ecSdanielk1977 ** space to duplicate all Expr nodes in the tree formed by Expr.pLeft
7556ab3a2ecSdanielk1977 ** and Expr.pRight variables (but not for any structures pointed to or
7566ab3a2ecSdanielk1977 ** descended from the Expr.x.pList or Expr.x.pSelect variables).
7576ab3a2ecSdanielk1977 */
7586ab3a2ecSdanielk1977 static int dupedExprSize(Expr *p, int flags){
7596ab3a2ecSdanielk1977   int nByte = 0;
7606ab3a2ecSdanielk1977   if( p ){
7616ab3a2ecSdanielk1977     nByte = dupedExprNodeSize(p, flags);
7626ab3a2ecSdanielk1977     if( flags&EXPRDUP_REDUCE ){
763b7916a78Sdrh       nByte += dupedExprSize(p->pLeft, flags) + dupedExprSize(p->pRight, flags);
7646ab3a2ecSdanielk1977     }
7656ab3a2ecSdanielk1977   }
7666ab3a2ecSdanielk1977   return nByte;
7676ab3a2ecSdanielk1977 }
7686ab3a2ecSdanielk1977 
7696ab3a2ecSdanielk1977 /*
7706ab3a2ecSdanielk1977 ** This function is similar to sqlite3ExprDup(), except that if pzBuffer
7716ab3a2ecSdanielk1977 ** is not NULL then *pzBuffer is assumed to point to a buffer large enough
77233e619fcSdrh ** to store the copy of expression p, the copies of p->u.zToken
7736ab3a2ecSdanielk1977 ** (if applicable), and the copies of the p->pLeft and p->pRight expressions,
7746ab3a2ecSdanielk1977 ** if any. Before returning, *pzBuffer is set to the first byte passed the
7756ab3a2ecSdanielk1977 ** portion of the buffer copied into by this function.
7766ab3a2ecSdanielk1977 */
7776ab3a2ecSdanielk1977 static Expr *exprDup(sqlite3 *db, Expr *p, int flags, u8 **pzBuffer){
7786ab3a2ecSdanielk1977   Expr *pNew = 0;                      /* Value to return */
7796ab3a2ecSdanielk1977   if( p ){
7806ab3a2ecSdanielk1977     const int isReduced = (flags&EXPRDUP_REDUCE);
7816ab3a2ecSdanielk1977     u8 *zAlloc;
78233e619fcSdrh     u32 staticFlag = 0;
7836ab3a2ecSdanielk1977 
7846ab3a2ecSdanielk1977     assert( pzBuffer==0 || isReduced );
7856ab3a2ecSdanielk1977 
7866ab3a2ecSdanielk1977     /* Figure out where to write the new Expr structure. */
7876ab3a2ecSdanielk1977     if( pzBuffer ){
7886ab3a2ecSdanielk1977       zAlloc = *pzBuffer;
78933e619fcSdrh       staticFlag = EP_Static;
7906ab3a2ecSdanielk1977     }else{
7916ab3a2ecSdanielk1977       zAlloc = sqlite3DbMallocRaw(db, dupedExprSize(p, flags));
7926ab3a2ecSdanielk1977     }
7936ab3a2ecSdanielk1977     pNew = (Expr *)zAlloc;
7946ab3a2ecSdanielk1977 
7956ab3a2ecSdanielk1977     if( pNew ){
7966ab3a2ecSdanielk1977       /* Set nNewSize to the size allocated for the structure pointed to
7976ab3a2ecSdanielk1977       ** by pNew. This is either EXPR_FULLSIZE, EXPR_REDUCEDSIZE or
7986ab3a2ecSdanielk1977       ** EXPR_TOKENONLYSIZE. nToken is set to the number of bytes consumed
79933e619fcSdrh       ** by the copy of the p->u.zToken string (if any).
8006ab3a2ecSdanielk1977       */
80133e619fcSdrh       const unsigned nStructSize = dupedExprStructSize(p, flags);
80233e619fcSdrh       const int nNewSize = nStructSize & 0xfff;
80333e619fcSdrh       int nToken;
80433e619fcSdrh       if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
80533e619fcSdrh         nToken = sqlite3Strlen30(p->u.zToken) + 1;
80633e619fcSdrh       }else{
80733e619fcSdrh         nToken = 0;
80833e619fcSdrh       }
8096ab3a2ecSdanielk1977       if( isReduced ){
8106ab3a2ecSdanielk1977         assert( ExprHasProperty(p, EP_Reduced)==0 );
8116ab3a2ecSdanielk1977         memcpy(zAlloc, p, nNewSize);
8126ab3a2ecSdanielk1977       }else{
8136ab3a2ecSdanielk1977         int nSize = exprStructSize(p);
8146ab3a2ecSdanielk1977         memcpy(zAlloc, p, nSize);
8156ab3a2ecSdanielk1977         memset(&zAlloc[nSize], 0, EXPR_FULLSIZE-nSize);
8166ab3a2ecSdanielk1977       }
8176ab3a2ecSdanielk1977 
81833e619fcSdrh       /* Set the EP_Reduced, EP_TokenOnly, and EP_Static flags appropriately. */
81933e619fcSdrh       pNew->flags &= ~(EP_Reduced|EP_TokenOnly|EP_Static);
82033e619fcSdrh       pNew->flags |= nStructSize & (EP_Reduced|EP_TokenOnly);
82133e619fcSdrh       pNew->flags |= staticFlag;
8226ab3a2ecSdanielk1977 
82333e619fcSdrh       /* Copy the p->u.zToken string, if any. */
8246ab3a2ecSdanielk1977       if( nToken ){
82533e619fcSdrh         char *zToken = pNew->u.zToken = (char*)&zAlloc[nNewSize];
82633e619fcSdrh         memcpy(zToken, p->u.zToken, nToken);
8276ab3a2ecSdanielk1977       }
8286ab3a2ecSdanielk1977 
8296ab3a2ecSdanielk1977       if( 0==((p->flags|pNew->flags) & EP_TokenOnly) ){
8306ab3a2ecSdanielk1977         /* Fill in the pNew->x.pSelect or pNew->x.pList member. */
8316ab3a2ecSdanielk1977         if( ExprHasProperty(p, EP_xIsSelect) ){
8326ab3a2ecSdanielk1977           pNew->x.pSelect = sqlite3SelectDup(db, p->x.pSelect, isReduced);
8336ab3a2ecSdanielk1977         }else{
8346ab3a2ecSdanielk1977           pNew->x.pList = sqlite3ExprListDup(db, p->x.pList, isReduced);
8356ab3a2ecSdanielk1977         }
8366ab3a2ecSdanielk1977       }
8376ab3a2ecSdanielk1977 
8386ab3a2ecSdanielk1977       /* Fill in pNew->pLeft and pNew->pRight. */
839b7916a78Sdrh       if( ExprHasAnyProperty(pNew, EP_Reduced|EP_TokenOnly) ){
8406ab3a2ecSdanielk1977         zAlloc += dupedExprNodeSize(p, flags);
8416ab3a2ecSdanielk1977         if( ExprHasProperty(pNew, EP_Reduced) ){
8426ab3a2ecSdanielk1977           pNew->pLeft = exprDup(db, p->pLeft, EXPRDUP_REDUCE, &zAlloc);
8436ab3a2ecSdanielk1977           pNew->pRight = exprDup(db, p->pRight, EXPRDUP_REDUCE, &zAlloc);
8446ab3a2ecSdanielk1977         }
8456ab3a2ecSdanielk1977         if( pzBuffer ){
8466ab3a2ecSdanielk1977           *pzBuffer = zAlloc;
8476ab3a2ecSdanielk1977         }
848b7916a78Sdrh       }else{
849b7916a78Sdrh         pNew->flags2 = 0;
850b7916a78Sdrh         if( !ExprHasAnyProperty(p, EP_TokenOnly) ){
8516ab3a2ecSdanielk1977           pNew->pLeft = sqlite3ExprDup(db, p->pLeft, 0);
8526ab3a2ecSdanielk1977           pNew->pRight = sqlite3ExprDup(db, p->pRight, 0);
8536ab3a2ecSdanielk1977         }
8546ab3a2ecSdanielk1977       }
855b7916a78Sdrh 
856b7916a78Sdrh     }
8576ab3a2ecSdanielk1977   }
8586ab3a2ecSdanielk1977   return pNew;
8596ab3a2ecSdanielk1977 }
8606ab3a2ecSdanielk1977 
8616ab3a2ecSdanielk1977 /*
862ff78bd2fSdrh ** The following group of routines make deep copies of expressions,
863ff78bd2fSdrh ** expression lists, ID lists, and select statements.  The copies can
864ff78bd2fSdrh ** be deleted (by being passed to their respective ...Delete() routines)
865ff78bd2fSdrh ** without effecting the originals.
866ff78bd2fSdrh **
8674adee20fSdanielk1977 ** The expression list, ID, and source lists return by sqlite3ExprListDup(),
8684adee20fSdanielk1977 ** sqlite3IdListDup(), and sqlite3SrcListDup() can not be further expanded
869ad3cab52Sdrh ** by subsequent calls to sqlite*ListAppend() routines.
870ff78bd2fSdrh **
871ad3cab52Sdrh ** Any tables that the SrcList might point to are not duplicated.
8726ab3a2ecSdanielk1977 **
873b7916a78Sdrh ** The flags parameter contains a combination of the EXPRDUP_XXX flags.
8746ab3a2ecSdanielk1977 ** If the EXPRDUP_REDUCE flag is set, then the structure returned is a
8756ab3a2ecSdanielk1977 ** truncated version of the usual Expr structure that will be stored as
8766ab3a2ecSdanielk1977 ** part of the in-memory representation of the database schema.
877ff78bd2fSdrh */
8786ab3a2ecSdanielk1977 Expr *sqlite3ExprDup(sqlite3 *db, Expr *p, int flags){
8796ab3a2ecSdanielk1977   return exprDup(db, p, flags, 0);
880ff78bd2fSdrh }
8816ab3a2ecSdanielk1977 ExprList *sqlite3ExprListDup(sqlite3 *db, ExprList *p, int flags){
882ff78bd2fSdrh   ExprList *pNew;
883145716b3Sdrh   struct ExprList_item *pItem, *pOldItem;
884ff78bd2fSdrh   int i;
885ff78bd2fSdrh   if( p==0 ) return 0;
88617435752Sdrh   pNew = sqlite3DbMallocRaw(db, sizeof(*pNew) );
887ff78bd2fSdrh   if( pNew==0 ) return 0;
88831dad9daSdanielk1977   pNew->iECursor = 0;
889d872bb18Sdrh   pNew->nExpr = i = p->nExpr;
890d872bb18Sdrh   if( (flags & EXPRDUP_REDUCE)==0 ) for(i=1; i<p->nExpr; i+=i){}
891d872bb18Sdrh   pNew->a = pItem = sqlite3DbMallocRaw(db,  i*sizeof(p->a[0]) );
892e0048400Sdanielk1977   if( pItem==0 ){
893633e6d57Sdrh     sqlite3DbFree(db, pNew);
894e0048400Sdanielk1977     return 0;
895e0048400Sdanielk1977   }
896145716b3Sdrh   pOldItem = p->a;
897145716b3Sdrh   for(i=0; i<p->nExpr; i++, pItem++, pOldItem++){
8986ab3a2ecSdanielk1977     Expr *pOldExpr = pOldItem->pExpr;
899b5526ea6Sdrh     pItem->pExpr = sqlite3ExprDup(db, pOldExpr, flags);
90017435752Sdrh     pItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
901b7916a78Sdrh     pItem->zSpan = sqlite3DbStrDup(db, pOldItem->zSpan);
902145716b3Sdrh     pItem->sortOrder = pOldItem->sortOrder;
9033e7bc9caSdrh     pItem->done = 0;
9044b3ac73cSdrh     pItem->iOrderByCol = pOldItem->iOrderByCol;
9058b213899Sdrh     pItem->iAlias = pOldItem->iAlias;
906ff78bd2fSdrh   }
907ff78bd2fSdrh   return pNew;
908ff78bd2fSdrh }
90993758c8dSdanielk1977 
91093758c8dSdanielk1977 /*
91193758c8dSdanielk1977 ** If cursors, triggers, views and subqueries are all omitted from
91293758c8dSdanielk1977 ** the build, then none of the following routines, except for
91393758c8dSdanielk1977 ** sqlite3SelectDup(), can be called. sqlite3SelectDup() is sometimes
91493758c8dSdanielk1977 ** called with a NULL argument.
91593758c8dSdanielk1977 */
9166a67fe8eSdanielk1977 #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_TRIGGER) \
9176a67fe8eSdanielk1977  || !defined(SQLITE_OMIT_SUBQUERY)
9186ab3a2ecSdanielk1977 SrcList *sqlite3SrcListDup(sqlite3 *db, SrcList *p, int flags){
919ad3cab52Sdrh   SrcList *pNew;
920ad3cab52Sdrh   int i;
921113088ecSdrh   int nByte;
922ad3cab52Sdrh   if( p==0 ) return 0;
923113088ecSdrh   nByte = sizeof(*p) + (p->nSrc>0 ? sizeof(p->a[0]) * (p->nSrc-1) : 0);
92417435752Sdrh   pNew = sqlite3DbMallocRaw(db, nByte );
925ad3cab52Sdrh   if( pNew==0 ) return 0;
9264305d103Sdrh   pNew->nSrc = pNew->nAlloc = p->nSrc;
927ad3cab52Sdrh   for(i=0; i<p->nSrc; i++){
9284efc4754Sdrh     struct SrcList_item *pNewItem = &pNew->a[i];
9294efc4754Sdrh     struct SrcList_item *pOldItem = &p->a[i];
930ed8a3bb1Sdrh     Table *pTab;
93141fb5cd1Sdan     pNewItem->pSchema = pOldItem->pSchema;
93217435752Sdrh     pNewItem->zDatabase = sqlite3DbStrDup(db, pOldItem->zDatabase);
93317435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
93417435752Sdrh     pNewItem->zAlias = sqlite3DbStrDup(db, pOldItem->zAlias);
9354efc4754Sdrh     pNewItem->jointype = pOldItem->jointype;
9364efc4754Sdrh     pNewItem->iCursor = pOldItem->iCursor;
9375b6a9ed4Sdrh     pNewItem->addrFillSub = pOldItem->addrFillSub;
9385b6a9ed4Sdrh     pNewItem->regReturn = pOldItem->regReturn;
939da79cf0cSdan     pNewItem->isCorrelated = pOldItem->isCorrelated;
94021172c4cSdrh     pNewItem->viaCoroutine = pOldItem->viaCoroutine;
94185574e31Sdanielk1977     pNewItem->zIndex = sqlite3DbStrDup(db, pOldItem->zIndex);
94285574e31Sdanielk1977     pNewItem->notIndexed = pOldItem->notIndexed;
94385574e31Sdanielk1977     pNewItem->pIndex = pOldItem->pIndex;
944ed8a3bb1Sdrh     pTab = pNewItem->pTab = pOldItem->pTab;
945ed8a3bb1Sdrh     if( pTab ){
946ed8a3bb1Sdrh       pTab->nRef++;
947a1cb183dSdanielk1977     }
9486ab3a2ecSdanielk1977     pNewItem->pSelect = sqlite3SelectDup(db, pOldItem->pSelect, flags);
9496ab3a2ecSdanielk1977     pNewItem->pOn = sqlite3ExprDup(db, pOldItem->pOn, flags);
95017435752Sdrh     pNewItem->pUsing = sqlite3IdListDup(db, pOldItem->pUsing);
9516c18b6e0Sdanielk1977     pNewItem->colUsed = pOldItem->colUsed;
952ad3cab52Sdrh   }
953ad3cab52Sdrh   return pNew;
954ad3cab52Sdrh }
95517435752Sdrh IdList *sqlite3IdListDup(sqlite3 *db, IdList *p){
956ff78bd2fSdrh   IdList *pNew;
957ff78bd2fSdrh   int i;
958ff78bd2fSdrh   if( p==0 ) return 0;
95917435752Sdrh   pNew = sqlite3DbMallocRaw(db, sizeof(*pNew) );
960ff78bd2fSdrh   if( pNew==0 ) return 0;
9616c535158Sdrh   pNew->nId = p->nId;
96217435752Sdrh   pNew->a = sqlite3DbMallocRaw(db, p->nId*sizeof(p->a[0]) );
963d5d56523Sdanielk1977   if( pNew->a==0 ){
964633e6d57Sdrh     sqlite3DbFree(db, pNew);
965d5d56523Sdanielk1977     return 0;
966d5d56523Sdanielk1977   }
9676c535158Sdrh   /* Note that because the size of the allocation for p->a[] is not
9686c535158Sdrh   ** necessarily a power of two, sqlite3IdListAppend() may not be called
9696c535158Sdrh   ** on the duplicate created by this function. */
970ff78bd2fSdrh   for(i=0; i<p->nId; i++){
9714efc4754Sdrh     struct IdList_item *pNewItem = &pNew->a[i];
9724efc4754Sdrh     struct IdList_item *pOldItem = &p->a[i];
97317435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
9744efc4754Sdrh     pNewItem->idx = pOldItem->idx;
975ff78bd2fSdrh   }
976ff78bd2fSdrh   return pNew;
977ff78bd2fSdrh }
9786ab3a2ecSdanielk1977 Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
97923b1b372Sdrh   Select *pNew, *pPrior;
980ff78bd2fSdrh   if( p==0 ) return 0;
98117435752Sdrh   pNew = sqlite3DbMallocRaw(db, sizeof(*p) );
982ff78bd2fSdrh   if( pNew==0 ) return 0;
983b7916a78Sdrh   pNew->pEList = sqlite3ExprListDup(db, p->pEList, flags);
9846ab3a2ecSdanielk1977   pNew->pSrc = sqlite3SrcListDup(db, p->pSrc, flags);
9856ab3a2ecSdanielk1977   pNew->pWhere = sqlite3ExprDup(db, p->pWhere, flags);
9866ab3a2ecSdanielk1977   pNew->pGroupBy = sqlite3ExprListDup(db, p->pGroupBy, flags);
9876ab3a2ecSdanielk1977   pNew->pHaving = sqlite3ExprDup(db, p->pHaving, flags);
9886ab3a2ecSdanielk1977   pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, flags);
989ff78bd2fSdrh   pNew->op = p->op;
99023b1b372Sdrh   pNew->pPrior = pPrior = sqlite3SelectDup(db, p->pPrior, flags);
99123b1b372Sdrh   if( pPrior ) pPrior->pNext = pNew;
99223b1b372Sdrh   pNew->pNext = 0;
9936ab3a2ecSdanielk1977   pNew->pLimit = sqlite3ExprDup(db, p->pLimit, flags);
9946ab3a2ecSdanielk1977   pNew->pOffset = sqlite3ExprDup(db, p->pOffset, flags);
99592b01d53Sdrh   pNew->iLimit = 0;
99692b01d53Sdrh   pNew->iOffset = 0;
9977d10d5a6Sdrh   pNew->selFlags = p->selFlags & ~SF_UsesEphemeral;
9980342b1f5Sdrh   pNew->pRightmost = 0;
999b9bb7c18Sdrh   pNew->addrOpenEphm[0] = -1;
1000b9bb7c18Sdrh   pNew->addrOpenEphm[1] = -1;
1001b9bb7c18Sdrh   pNew->addrOpenEphm[2] = -1;
1002ff78bd2fSdrh   return pNew;
1003ff78bd2fSdrh }
100493758c8dSdanielk1977 #else
10056ab3a2ecSdanielk1977 Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
100693758c8dSdanielk1977   assert( p==0 );
100793758c8dSdanielk1977   return 0;
100893758c8dSdanielk1977 }
100993758c8dSdanielk1977 #endif
1010ff78bd2fSdrh 
1011ff78bd2fSdrh 
1012ff78bd2fSdrh /*
1013a76b5dfcSdrh ** Add a new element to the end of an expression list.  If pList is
1014a76b5dfcSdrh ** initially NULL, then create a new expression list.
1015b7916a78Sdrh **
1016b7916a78Sdrh ** If a memory allocation error occurs, the entire list is freed and
1017b7916a78Sdrh ** NULL is returned.  If non-NULL is returned, then it is guaranteed
1018b7916a78Sdrh ** that the new entry was successfully appended.
1019a76b5dfcSdrh */
102017435752Sdrh ExprList *sqlite3ExprListAppend(
102117435752Sdrh   Parse *pParse,          /* Parsing context */
102217435752Sdrh   ExprList *pList,        /* List to which to append. Might be NULL */
1023b7916a78Sdrh   Expr *pExpr             /* Expression to be appended. Might be NULL */
102417435752Sdrh ){
102517435752Sdrh   sqlite3 *db = pParse->db;
1026a76b5dfcSdrh   if( pList==0 ){
102717435752Sdrh     pList = sqlite3DbMallocZero(db, sizeof(ExprList) );
1028a76b5dfcSdrh     if( pList==0 ){
1029d5d56523Sdanielk1977       goto no_mem;
1030a76b5dfcSdrh     }
1031d872bb18Sdrh     pList->a = sqlite3DbMallocRaw(db, sizeof(pList->a[0]));
1032d872bb18Sdrh     if( pList->a==0 ) goto no_mem;
1033d872bb18Sdrh   }else if( (pList->nExpr & (pList->nExpr-1))==0 ){
1034d5d56523Sdanielk1977     struct ExprList_item *a;
1035d872bb18Sdrh     assert( pList->nExpr>0 );
1036d872bb18Sdrh     a = sqlite3DbRealloc(db, pList->a, pList->nExpr*2*sizeof(pList->a[0]));
1037d5d56523Sdanielk1977     if( a==0 ){
1038d5d56523Sdanielk1977       goto no_mem;
1039a76b5dfcSdrh     }
1040d5d56523Sdanielk1977     pList->a = a;
1041a76b5dfcSdrh   }
10424efc4754Sdrh   assert( pList->a!=0 );
1043b7916a78Sdrh   if( 1 ){
10444efc4754Sdrh     struct ExprList_item *pItem = &pList->a[pList->nExpr++];
10454efc4754Sdrh     memset(pItem, 0, sizeof(*pItem));
1046e94ddc9eSdanielk1977     pItem->pExpr = pExpr;
1047a76b5dfcSdrh   }
1048a76b5dfcSdrh   return pList;
1049d5d56523Sdanielk1977 
1050d5d56523Sdanielk1977 no_mem:
1051d5d56523Sdanielk1977   /* Avoid leaking memory if malloc has failed. */
1052633e6d57Sdrh   sqlite3ExprDelete(db, pExpr);
1053633e6d57Sdrh   sqlite3ExprListDelete(db, pList);
1054d5d56523Sdanielk1977   return 0;
1055a76b5dfcSdrh }
1056a76b5dfcSdrh 
1057a76b5dfcSdrh /*
1058b7916a78Sdrh ** Set the ExprList.a[].zName element of the most recently added item
1059b7916a78Sdrh ** on the expression list.
1060b7916a78Sdrh **
1061b7916a78Sdrh ** pList might be NULL following an OOM error.  But pName should never be
1062b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1063b7916a78Sdrh ** is set.
1064b7916a78Sdrh */
1065b7916a78Sdrh void sqlite3ExprListSetName(
1066b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1067b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
1068b7916a78Sdrh   Token *pName,           /* Name to be added */
1069b7916a78Sdrh   int dequote             /* True to cause the name to be dequoted */
1070b7916a78Sdrh ){
1071b7916a78Sdrh   assert( pList!=0 || pParse->db->mallocFailed!=0 );
1072b7916a78Sdrh   if( pList ){
1073b7916a78Sdrh     struct ExprList_item *pItem;
1074b7916a78Sdrh     assert( pList->nExpr>0 );
1075b7916a78Sdrh     pItem = &pList->a[pList->nExpr-1];
1076b7916a78Sdrh     assert( pItem->zName==0 );
1077b7916a78Sdrh     pItem->zName = sqlite3DbStrNDup(pParse->db, pName->z, pName->n);
1078b7916a78Sdrh     if( dequote && pItem->zName ) sqlite3Dequote(pItem->zName);
1079b7916a78Sdrh   }
1080b7916a78Sdrh }
1081b7916a78Sdrh 
1082b7916a78Sdrh /*
1083b7916a78Sdrh ** Set the ExprList.a[].zSpan element of the most recently added item
1084b7916a78Sdrh ** on the expression list.
1085b7916a78Sdrh **
1086b7916a78Sdrh ** pList might be NULL following an OOM error.  But pSpan should never be
1087b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1088b7916a78Sdrh ** is set.
1089b7916a78Sdrh */
1090b7916a78Sdrh void sqlite3ExprListSetSpan(
1091b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1092b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
1093b7916a78Sdrh   ExprSpan *pSpan         /* The span to be added */
1094b7916a78Sdrh ){
1095b7916a78Sdrh   sqlite3 *db = pParse->db;
1096b7916a78Sdrh   assert( pList!=0 || db->mallocFailed!=0 );
1097b7916a78Sdrh   if( pList ){
1098b7916a78Sdrh     struct ExprList_item *pItem = &pList->a[pList->nExpr-1];
1099b7916a78Sdrh     assert( pList->nExpr>0 );
1100b7916a78Sdrh     assert( db->mallocFailed || pItem->pExpr==pSpan->pExpr );
1101b7916a78Sdrh     sqlite3DbFree(db, pItem->zSpan);
1102b7916a78Sdrh     pItem->zSpan = sqlite3DbStrNDup(db, (char*)pSpan->zStart,
1103cf697396Sshane                                     (int)(pSpan->zEnd - pSpan->zStart));
1104b7916a78Sdrh   }
1105b7916a78Sdrh }
1106b7916a78Sdrh 
1107b7916a78Sdrh /*
11087a15a4beSdanielk1977 ** If the expression list pEList contains more than iLimit elements,
11097a15a4beSdanielk1977 ** leave an error message in pParse.
11107a15a4beSdanielk1977 */
11117a15a4beSdanielk1977 void sqlite3ExprListCheckLength(
11127a15a4beSdanielk1977   Parse *pParse,
11137a15a4beSdanielk1977   ExprList *pEList,
11147a15a4beSdanielk1977   const char *zObject
11157a15a4beSdanielk1977 ){
1116b1a6c3c1Sdrh   int mx = pParse->db->aLimit[SQLITE_LIMIT_COLUMN];
1117c5499befSdrh   testcase( pEList && pEList->nExpr==mx );
1118c5499befSdrh   testcase( pEList && pEList->nExpr==mx+1 );
1119b1a6c3c1Sdrh   if( pEList && pEList->nExpr>mx ){
11207a15a4beSdanielk1977     sqlite3ErrorMsg(pParse, "too many columns in %s", zObject);
11217a15a4beSdanielk1977   }
11227a15a4beSdanielk1977 }
11237a15a4beSdanielk1977 
11247a15a4beSdanielk1977 /*
1125a76b5dfcSdrh ** Delete an entire expression list.
1126a76b5dfcSdrh */
1127633e6d57Sdrh void sqlite3ExprListDelete(sqlite3 *db, ExprList *pList){
1128a76b5dfcSdrh   int i;
1129be5c89acSdrh   struct ExprList_item *pItem;
1130a76b5dfcSdrh   if( pList==0 ) return;
1131d872bb18Sdrh   assert( pList->a!=0 || pList->nExpr==0 );
1132be5c89acSdrh   for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
1133633e6d57Sdrh     sqlite3ExprDelete(db, pItem->pExpr);
1134633e6d57Sdrh     sqlite3DbFree(db, pItem->zName);
1135b7916a78Sdrh     sqlite3DbFree(db, pItem->zSpan);
1136a76b5dfcSdrh   }
1137633e6d57Sdrh   sqlite3DbFree(db, pList->a);
1138633e6d57Sdrh   sqlite3DbFree(db, pList);
1139a76b5dfcSdrh }
1140a76b5dfcSdrh 
1141a76b5dfcSdrh /*
11427d10d5a6Sdrh ** These routines are Walker callbacks.  Walker.u.pi is a pointer
11437d10d5a6Sdrh ** to an integer.  These routines are checking an expression to see
11447d10d5a6Sdrh ** if it is a constant.  Set *Walker.u.pi to 0 if the expression is
11457d10d5a6Sdrh ** not constant.
114673b211abSdrh **
11477d10d5a6Sdrh ** These callback routines are used to implement the following:
1148626a879aSdrh **
11497d10d5a6Sdrh **     sqlite3ExprIsConstant()
11507d10d5a6Sdrh **     sqlite3ExprIsConstantNotJoin()
11517d10d5a6Sdrh **     sqlite3ExprIsConstantOrFunction()
115287abf5c0Sdrh **
1153626a879aSdrh */
11547d10d5a6Sdrh static int exprNodeIsConstant(Walker *pWalker, Expr *pExpr){
1155626a879aSdrh 
11567d10d5a6Sdrh   /* If pWalker->u.i is 3 then any term of the expression that comes from
11570a168377Sdrh   ** the ON or USING clauses of a join disqualifies the expression
11580a168377Sdrh   ** from being considered constant. */
11597d10d5a6Sdrh   if( pWalker->u.i==3 && ExprHasAnyProperty(pExpr, EP_FromJoin) ){
11607d10d5a6Sdrh     pWalker->u.i = 0;
11617d10d5a6Sdrh     return WRC_Abort;
11620a168377Sdrh   }
11630a168377Sdrh 
1164626a879aSdrh   switch( pExpr->op ){
1165eb55bd2fSdrh     /* Consider functions to be constant if all their arguments are constant
11667d10d5a6Sdrh     ** and pWalker->u.i==2 */
1167eb55bd2fSdrh     case TK_FUNCTION:
11687d10d5a6Sdrh       if( pWalker->u.i==2 ) return 0;
1169eb55bd2fSdrh       /* Fall through */
1170626a879aSdrh     case TK_ID:
1171626a879aSdrh     case TK_COLUMN:
1172626a879aSdrh     case TK_AGG_FUNCTION:
117313449892Sdrh     case TK_AGG_COLUMN:
1174c5499befSdrh       testcase( pExpr->op==TK_ID );
1175c5499befSdrh       testcase( pExpr->op==TK_COLUMN );
1176c5499befSdrh       testcase( pExpr->op==TK_AGG_FUNCTION );
1177c5499befSdrh       testcase( pExpr->op==TK_AGG_COLUMN );
11787d10d5a6Sdrh       pWalker->u.i = 0;
11797d10d5a6Sdrh       return WRC_Abort;
1180626a879aSdrh     default:
1181b74b1017Sdrh       testcase( pExpr->op==TK_SELECT ); /* selectNodeIsConstant will disallow */
1182b74b1017Sdrh       testcase( pExpr->op==TK_EXISTS ); /* selectNodeIsConstant will disallow */
11837d10d5a6Sdrh       return WRC_Continue;
1184626a879aSdrh   }
1185626a879aSdrh }
118662c14b34Sdanielk1977 static int selectNodeIsConstant(Walker *pWalker, Select *NotUsed){
118762c14b34Sdanielk1977   UNUSED_PARAMETER(NotUsed);
11887d10d5a6Sdrh   pWalker->u.i = 0;
11897d10d5a6Sdrh   return WRC_Abort;
11907d10d5a6Sdrh }
11917d10d5a6Sdrh static int exprIsConst(Expr *p, int initFlag){
11927d10d5a6Sdrh   Walker w;
11937d10d5a6Sdrh   w.u.i = initFlag;
11947d10d5a6Sdrh   w.xExprCallback = exprNodeIsConstant;
11957d10d5a6Sdrh   w.xSelectCallback = selectNodeIsConstant;
11967d10d5a6Sdrh   sqlite3WalkExpr(&w, p);
11977d10d5a6Sdrh   return w.u.i;
11987d10d5a6Sdrh }
1199626a879aSdrh 
1200626a879aSdrh /*
1201fef5208cSdrh ** Walk an expression tree.  Return 1 if the expression is constant
1202eb55bd2fSdrh ** and 0 if it involves variables or function calls.
12032398937bSdrh **
12042398937bSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
12052398937bSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
12062398937bSdrh ** a constant.
1207fef5208cSdrh */
12084adee20fSdanielk1977 int sqlite3ExprIsConstant(Expr *p){
12097d10d5a6Sdrh   return exprIsConst(p, 1);
1210fef5208cSdrh }
1211fef5208cSdrh 
1212fef5208cSdrh /*
1213eb55bd2fSdrh ** Walk an expression tree.  Return 1 if the expression is constant
12140a168377Sdrh ** that does no originate from the ON or USING clauses of a join.
12150a168377Sdrh ** Return 0 if it involves variables or function calls or terms from
12160a168377Sdrh ** an ON or USING clause.
12170a168377Sdrh */
12180a168377Sdrh int sqlite3ExprIsConstantNotJoin(Expr *p){
12197d10d5a6Sdrh   return exprIsConst(p, 3);
12200a168377Sdrh }
12210a168377Sdrh 
12220a168377Sdrh /*
12230a168377Sdrh ** Walk an expression tree.  Return 1 if the expression is constant
1224eb55bd2fSdrh ** or a function call with constant arguments.  Return and 0 if there
1225eb55bd2fSdrh ** are any variables.
1226eb55bd2fSdrh **
1227eb55bd2fSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
1228eb55bd2fSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
1229eb55bd2fSdrh ** a constant.
1230eb55bd2fSdrh */
1231eb55bd2fSdrh int sqlite3ExprIsConstantOrFunction(Expr *p){
12327d10d5a6Sdrh   return exprIsConst(p, 2);
1233eb55bd2fSdrh }
1234eb55bd2fSdrh 
1235eb55bd2fSdrh /*
123673b211abSdrh ** If the expression p codes a constant integer that is small enough
1237202b2df7Sdrh ** to fit in a 32-bit integer, return 1 and put the value of the integer
1238202b2df7Sdrh ** in *pValue.  If the expression is not an integer or if it is too big
1239202b2df7Sdrh ** to fit in a signed 32-bit integer, return 0 and leave *pValue unchanged.
1240e4de1febSdrh */
12414adee20fSdanielk1977 int sqlite3ExprIsInteger(Expr *p, int *pValue){
124292b01d53Sdrh   int rc = 0;
1243cd92e84dSdrh 
1244cd92e84dSdrh   /* If an expression is an integer literal that fits in a signed 32-bit
1245cd92e84dSdrh   ** integer, then the EP_IntValue flag will have already been set */
1246cd92e84dSdrh   assert( p->op!=TK_INTEGER || (p->flags & EP_IntValue)!=0
1247cd92e84dSdrh            || sqlite3GetInt32(p->u.zToken, &rc)==0 );
1248cd92e84dSdrh 
124992b01d53Sdrh   if( p->flags & EP_IntValue ){
125033e619fcSdrh     *pValue = p->u.iValue;
1251e4de1febSdrh     return 1;
1252e4de1febSdrh   }
125392b01d53Sdrh   switch( p->op ){
12544b59ab5eSdrh     case TK_UPLUS: {
125592b01d53Sdrh       rc = sqlite3ExprIsInteger(p->pLeft, pValue);
1256f6e369a1Sdrh       break;
12574b59ab5eSdrh     }
1258e4de1febSdrh     case TK_UMINUS: {
1259e4de1febSdrh       int v;
12604adee20fSdanielk1977       if( sqlite3ExprIsInteger(p->pLeft, &v) ){
1261e4de1febSdrh         *pValue = -v;
126292b01d53Sdrh         rc = 1;
1263e4de1febSdrh       }
1264e4de1febSdrh       break;
1265e4de1febSdrh     }
1266e4de1febSdrh     default: break;
1267e4de1febSdrh   }
126892b01d53Sdrh   return rc;
1269e4de1febSdrh }
1270e4de1febSdrh 
1271e4de1febSdrh /*
1272039fc32eSdrh ** Return FALSE if there is no chance that the expression can be NULL.
1273039fc32eSdrh **
1274039fc32eSdrh ** If the expression might be NULL or if the expression is too complex
1275039fc32eSdrh ** to tell return TRUE.
1276039fc32eSdrh **
1277039fc32eSdrh ** This routine is used as an optimization, to skip OP_IsNull opcodes
1278039fc32eSdrh ** when we know that a value cannot be NULL.  Hence, a false positive
1279039fc32eSdrh ** (returning TRUE when in fact the expression can never be NULL) might
1280039fc32eSdrh ** be a small performance hit but is otherwise harmless.  On the other
1281039fc32eSdrh ** hand, a false negative (returning FALSE when the result could be NULL)
1282039fc32eSdrh ** will likely result in an incorrect answer.  So when in doubt, return
1283039fc32eSdrh ** TRUE.
1284039fc32eSdrh */
1285039fc32eSdrh int sqlite3ExprCanBeNull(const Expr *p){
1286039fc32eSdrh   u8 op;
1287cd7f457eSdrh   while( p->op==TK_UPLUS || p->op==TK_UMINUS ){ p = p->pLeft; }
1288039fc32eSdrh   op = p->op;
1289039fc32eSdrh   if( op==TK_REGISTER ) op = p->op2;
1290039fc32eSdrh   switch( op ){
1291039fc32eSdrh     case TK_INTEGER:
1292039fc32eSdrh     case TK_STRING:
1293039fc32eSdrh     case TK_FLOAT:
1294039fc32eSdrh     case TK_BLOB:
1295039fc32eSdrh       return 0;
1296039fc32eSdrh     default:
1297039fc32eSdrh       return 1;
1298039fc32eSdrh   }
1299039fc32eSdrh }
1300039fc32eSdrh 
1301039fc32eSdrh /*
13022f2855b6Sdrh ** Generate an OP_IsNull instruction that tests register iReg and jumps
13032f2855b6Sdrh ** to location iDest if the value in iReg is NULL.  The value in iReg
13042f2855b6Sdrh ** was computed by pExpr.  If we can look at pExpr at compile-time and
13052f2855b6Sdrh ** determine that it can never generate a NULL, then the OP_IsNull operation
13062f2855b6Sdrh ** can be omitted.
13072f2855b6Sdrh */
13082f2855b6Sdrh void sqlite3ExprCodeIsNullJump(
13092f2855b6Sdrh   Vdbe *v,            /* The VDBE under construction */
13102f2855b6Sdrh   const Expr *pExpr,  /* Only generate OP_IsNull if this expr can be NULL */
13112f2855b6Sdrh   int iReg,           /* Test the value in this register for NULL */
13122f2855b6Sdrh   int iDest           /* Jump here if the value is null */
13132f2855b6Sdrh ){
13142f2855b6Sdrh   if( sqlite3ExprCanBeNull(pExpr) ){
13152f2855b6Sdrh     sqlite3VdbeAddOp2(v, OP_IsNull, iReg, iDest);
13162f2855b6Sdrh   }
13172f2855b6Sdrh }
13182f2855b6Sdrh 
13192f2855b6Sdrh /*
1320039fc32eSdrh ** Return TRUE if the given expression is a constant which would be
1321039fc32eSdrh ** unchanged by OP_Affinity with the affinity given in the second
1322039fc32eSdrh ** argument.
1323039fc32eSdrh **
1324039fc32eSdrh ** This routine is used to determine if the OP_Affinity operation
1325039fc32eSdrh ** can be omitted.  When in doubt return FALSE.  A false negative
1326039fc32eSdrh ** is harmless.  A false positive, however, can result in the wrong
1327039fc32eSdrh ** answer.
1328039fc32eSdrh */
1329039fc32eSdrh int sqlite3ExprNeedsNoAffinityChange(const Expr *p, char aff){
1330039fc32eSdrh   u8 op;
1331039fc32eSdrh   if( aff==SQLITE_AFF_NONE ) return 1;
1332cd7f457eSdrh   while( p->op==TK_UPLUS || p->op==TK_UMINUS ){ p = p->pLeft; }
1333039fc32eSdrh   op = p->op;
1334039fc32eSdrh   if( op==TK_REGISTER ) op = p->op2;
1335039fc32eSdrh   switch( op ){
1336039fc32eSdrh     case TK_INTEGER: {
1337039fc32eSdrh       return aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC;
1338039fc32eSdrh     }
1339039fc32eSdrh     case TK_FLOAT: {
1340039fc32eSdrh       return aff==SQLITE_AFF_REAL || aff==SQLITE_AFF_NUMERIC;
1341039fc32eSdrh     }
1342039fc32eSdrh     case TK_STRING: {
1343039fc32eSdrh       return aff==SQLITE_AFF_TEXT;
1344039fc32eSdrh     }
1345039fc32eSdrh     case TK_BLOB: {
1346039fc32eSdrh       return 1;
1347039fc32eSdrh     }
13482f2855b6Sdrh     case TK_COLUMN: {
134988376ca7Sdrh       assert( p->iTable>=0 );  /* p cannot be part of a CHECK constraint */
135088376ca7Sdrh       return p->iColumn<0
13512f2855b6Sdrh           && (aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC);
13522f2855b6Sdrh     }
1353039fc32eSdrh     default: {
1354039fc32eSdrh       return 0;
1355039fc32eSdrh     }
1356039fc32eSdrh   }
1357039fc32eSdrh }
1358039fc32eSdrh 
1359039fc32eSdrh /*
1360c4a3c779Sdrh ** Return TRUE if the given string is a row-id column name.
1361c4a3c779Sdrh */
13624adee20fSdanielk1977 int sqlite3IsRowid(const char *z){
13634adee20fSdanielk1977   if( sqlite3StrICmp(z, "_ROWID_")==0 ) return 1;
13644adee20fSdanielk1977   if( sqlite3StrICmp(z, "ROWID")==0 ) return 1;
13654adee20fSdanielk1977   if( sqlite3StrICmp(z, "OID")==0 ) return 1;
1366c4a3c779Sdrh   return 0;
1367c4a3c779Sdrh }
1368c4a3c779Sdrh 
13699a96b668Sdanielk1977 /*
1370b74b1017Sdrh ** Return true if we are able to the IN operator optimization on a
1371b74b1017Sdrh ** query of the form
1372b287f4b6Sdrh **
1373b74b1017Sdrh **       x IN (SELECT ...)
1374b287f4b6Sdrh **
1375b74b1017Sdrh ** Where the SELECT... clause is as specified by the parameter to this
1376b74b1017Sdrh ** routine.
1377b74b1017Sdrh **
1378b74b1017Sdrh ** The Select object passed in has already been preprocessed and no
1379b74b1017Sdrh ** errors have been found.
1380b287f4b6Sdrh */
1381b287f4b6Sdrh #ifndef SQLITE_OMIT_SUBQUERY
1382b287f4b6Sdrh static int isCandidateForInOpt(Select *p){
1383b287f4b6Sdrh   SrcList *pSrc;
1384b287f4b6Sdrh   ExprList *pEList;
1385b287f4b6Sdrh   Table *pTab;
1386b287f4b6Sdrh   if( p==0 ) return 0;                   /* right-hand side of IN is SELECT */
1387b287f4b6Sdrh   if( p->pPrior ) return 0;              /* Not a compound SELECT */
13887d10d5a6Sdrh   if( p->selFlags & (SF_Distinct|SF_Aggregate) ){
1389b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
1390b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
13917d10d5a6Sdrh     return 0; /* No DISTINCT keyword and no aggregate functions */
13927d10d5a6Sdrh   }
1393b74b1017Sdrh   assert( p->pGroupBy==0 );              /* Has no GROUP BY clause */
1394b287f4b6Sdrh   if( p->pLimit ) return 0;              /* Has no LIMIT clause */
1395b74b1017Sdrh   assert( p->pOffset==0 );               /* No LIMIT means no OFFSET */
1396b287f4b6Sdrh   if( p->pWhere ) return 0;              /* Has no WHERE clause */
1397b287f4b6Sdrh   pSrc = p->pSrc;
1398d1fa7bcaSdrh   assert( pSrc!=0 );
1399d1fa7bcaSdrh   if( pSrc->nSrc!=1 ) return 0;          /* Single term in FROM clause */
1400b74b1017Sdrh   if( pSrc->a[0].pSelect ) return 0;     /* FROM is not a subquery or view */
1401b287f4b6Sdrh   pTab = pSrc->a[0].pTab;
1402b74b1017Sdrh   if( NEVER(pTab==0) ) return 0;
1403b74b1017Sdrh   assert( pTab->pSelect==0 );            /* FROM clause is not a view */
1404b287f4b6Sdrh   if( IsVirtual(pTab) ) return 0;        /* FROM clause not a virtual table */
1405b287f4b6Sdrh   pEList = p->pEList;
1406b287f4b6Sdrh   if( pEList->nExpr!=1 ) return 0;       /* One column in the result set */
1407b287f4b6Sdrh   if( pEList->a[0].pExpr->op!=TK_COLUMN ) return 0; /* Result is a column */
1408b287f4b6Sdrh   return 1;
1409b287f4b6Sdrh }
1410b287f4b6Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
1411b287f4b6Sdrh 
1412b287f4b6Sdrh /*
14131d8cb21fSdan ** Code an OP_Once instruction and allocate space for its flag. Return the
14141d8cb21fSdan ** address of the new instruction.
14151d8cb21fSdan */
14161d8cb21fSdan int sqlite3CodeOnce(Parse *pParse){
14171d8cb21fSdan   Vdbe *v = sqlite3GetVdbe(pParse);      /* Virtual machine being coded */
14181d8cb21fSdan   return sqlite3VdbeAddOp1(v, OP_Once, pParse->nOnce++);
14191d8cb21fSdan }
14201d8cb21fSdan 
14211d8cb21fSdan /*
14229a96b668Sdanielk1977 ** This function is used by the implementation of the IN (...) operator.
1423d4305ca6Sdrh ** The pX parameter is the expression on the RHS of the IN operator, which
1424d4305ca6Sdrh ** might be either a list of expressions or a subquery.
14259a96b668Sdanielk1977 **
1426d4305ca6Sdrh ** The job of this routine is to find or create a b-tree object that can
1427d4305ca6Sdrh ** be used either to test for membership in the RHS set or to iterate through
1428d4305ca6Sdrh ** all members of the RHS set, skipping duplicates.
1429d4305ca6Sdrh **
1430d4305ca6Sdrh ** A cursor is opened on the b-tree object that the RHS of the IN operator
1431d4305ca6Sdrh ** and pX->iTable is set to the index of that cursor.
1432d4305ca6Sdrh **
1433b74b1017Sdrh ** The returned value of this function indicates the b-tree type, as follows:
14349a96b668Sdanielk1977 **
14359a96b668Sdanielk1977 **   IN_INDEX_ROWID - The cursor was opened on a database table.
14362d401ab8Sdrh **   IN_INDEX_INDEX - The cursor was opened on a database index.
14379a96b668Sdanielk1977 **   IN_INDEX_EPH -   The cursor was opened on a specially created and
14389a96b668Sdanielk1977 **                    populated epheremal table.
14399a96b668Sdanielk1977 **
1440d4305ca6Sdrh ** An existing b-tree might be used if the RHS expression pX is a simple
1441d4305ca6Sdrh ** subquery such as:
14429a96b668Sdanielk1977 **
14439a96b668Sdanielk1977 **     SELECT <column> FROM <table>
14449a96b668Sdanielk1977 **
1445d4305ca6Sdrh ** If the RHS of the IN operator is a list or a more complex subquery, then
1446d4305ca6Sdrh ** an ephemeral table might need to be generated from the RHS and then
1447d4305ca6Sdrh ** pX->iTable made to point to the ephermeral table instead of an
1448d4305ca6Sdrh ** existing table.
1449d4305ca6Sdrh **
1450b74b1017Sdrh ** If the prNotFound parameter is 0, then the b-tree will be used to iterate
14519a96b668Sdanielk1977 ** through the set members, skipping any duplicates. In this case an
14529a96b668Sdanielk1977 ** epheremal table must be used unless the selected <column> is guaranteed
14539a96b668Sdanielk1977 ** to be unique - either because it is an INTEGER PRIMARY KEY or it
1454b74b1017Sdrh ** has a UNIQUE constraint or UNIQUE index.
14550cdc022eSdanielk1977 **
1456b74b1017Sdrh ** If the prNotFound parameter is not 0, then the b-tree will be used
14570cdc022eSdanielk1977 ** for fast set membership tests. In this case an epheremal table must
14580cdc022eSdanielk1977 ** be used unless <column> is an INTEGER PRIMARY KEY or an index can
14590cdc022eSdanielk1977 ** be found with <column> as its left-most column.
14600cdc022eSdanielk1977 **
1461b74b1017Sdrh ** When the b-tree is being used for membership tests, the calling function
14620cdc022eSdanielk1977 ** needs to know whether or not the structure contains an SQL NULL
14630cdc022eSdanielk1977 ** value in order to correctly evaluate expressions like "X IN (Y, Z)".
1464e3365e6cSdrh ** If there is any chance that the (...) might contain a NULL value at
14650cdc022eSdanielk1977 ** runtime, then a register is allocated and the register number written
1466e3365e6cSdrh ** to *prNotFound. If there is no chance that the (...) contains a
14670cdc022eSdanielk1977 ** NULL value, then *prNotFound is left unchanged.
14680cdc022eSdanielk1977 **
14690cdc022eSdanielk1977 ** If a register is allocated and its location stored in *prNotFound, then
1470e3365e6cSdrh ** its initial value is NULL.  If the (...) does not remain constant
1471e3365e6cSdrh ** for the duration of the query (i.e. the SELECT within the (...)
1472b74b1017Sdrh ** is a correlated subquery) then the value of the allocated register is
1473e3365e6cSdrh ** reset to NULL each time the subquery is rerun. This allows the
1474b74b1017Sdrh ** caller to use vdbe code equivalent to the following:
14750cdc022eSdanielk1977 **
14760cdc022eSdanielk1977 **   if( register==NULL ){
14770cdc022eSdanielk1977 **     has_null = <test if data structure contains null>
14780cdc022eSdanielk1977 **     register = 1
14790cdc022eSdanielk1977 **   }
14800cdc022eSdanielk1977 **
14810cdc022eSdanielk1977 ** in order to avoid running the <test if data structure contains null>
14820cdc022eSdanielk1977 ** test more often than is necessary.
14839a96b668Sdanielk1977 */
1484284f4acaSdanielk1977 #ifndef SQLITE_OMIT_SUBQUERY
14850cdc022eSdanielk1977 int sqlite3FindInIndex(Parse *pParse, Expr *pX, int *prNotFound){
1486b74b1017Sdrh   Select *p;                            /* SELECT to the right of IN operator */
1487b74b1017Sdrh   int eType = 0;                        /* Type of RHS table. IN_INDEX_* */
1488b74b1017Sdrh   int iTab = pParse->nTab++;            /* Cursor of the RHS table */
1489b74b1017Sdrh   int mustBeUnique = (prNotFound==0);   /* True if RHS must be unique */
1490b8475df8Sdrh   Vdbe *v = sqlite3GetVdbe(pParse);     /* Virtual machine being coded */
14919a96b668Sdanielk1977 
14921450bc6eSdrh   assert( pX->op==TK_IN );
14931450bc6eSdrh 
1494b74b1017Sdrh   /* Check to see if an existing table or index can be used to
1495b74b1017Sdrh   ** satisfy the query.  This is preferable to generating a new
1496b74b1017Sdrh   ** ephemeral table.
14979a96b668Sdanielk1977   */
14986ab3a2ecSdanielk1977   p = (ExprHasProperty(pX, EP_xIsSelect) ? pX->x.pSelect : 0);
1499fd773cf9Sdrh   if( ALWAYS(pParse->nErr==0) && isCandidateForInOpt(p) ){
1500e1fb65a0Sdanielk1977     sqlite3 *db = pParse->db;              /* Database connection */
1501b07028f7Sdrh     Table *pTab;                           /* Table <table>. */
1502b07028f7Sdrh     Expr *pExpr;                           /* Expression <column> */
1503b07028f7Sdrh     int iCol;                              /* Index of column <column> */
1504e1fb65a0Sdanielk1977     int iDb;                               /* Database idx for pTab */
1505e1fb65a0Sdanielk1977 
1506b07028f7Sdrh     assert( p );                        /* Because of isCandidateForInOpt(p) */
1507b07028f7Sdrh     assert( p->pEList!=0 );             /* Because of isCandidateForInOpt(p) */
1508b07028f7Sdrh     assert( p->pEList->a[0].pExpr!=0 ); /* Because of isCandidateForInOpt(p) */
1509b07028f7Sdrh     assert( p->pSrc!=0 );               /* Because of isCandidateForInOpt(p) */
1510b07028f7Sdrh     pTab = p->pSrc->a[0].pTab;
1511b07028f7Sdrh     pExpr = p->pEList->a[0].pExpr;
1512b07028f7Sdrh     iCol = pExpr->iColumn;
1513b07028f7Sdrh 
1514e1fb65a0Sdanielk1977     /* Code an OP_VerifyCookie and OP_TableLock for <table>. */
1515e1fb65a0Sdanielk1977     iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
1516e1fb65a0Sdanielk1977     sqlite3CodeVerifySchema(pParse, iDb);
1517e1fb65a0Sdanielk1977     sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
15189a96b668Sdanielk1977 
15199a96b668Sdanielk1977     /* This function is only called from two places. In both cases the vdbe
15209a96b668Sdanielk1977     ** has already been allocated. So assume sqlite3GetVdbe() is always
15219a96b668Sdanielk1977     ** successful here.
15229a96b668Sdanielk1977     */
15239a96b668Sdanielk1977     assert(v);
15249a96b668Sdanielk1977     if( iCol<0 ){
15259a96b668Sdanielk1977       int iAddr;
15269a96b668Sdanielk1977 
15271d8cb21fSdan       iAddr = sqlite3CodeOnce(pParse);
15289a96b668Sdanielk1977 
15299a96b668Sdanielk1977       sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
15309a96b668Sdanielk1977       eType = IN_INDEX_ROWID;
15319a96b668Sdanielk1977 
15329a96b668Sdanielk1977       sqlite3VdbeJumpHere(v, iAddr);
15339a96b668Sdanielk1977     }else{
1534e1fb65a0Sdanielk1977       Index *pIdx;                         /* Iterator variable */
1535e1fb65a0Sdanielk1977 
15369a96b668Sdanielk1977       /* The collation sequence used by the comparison. If an index is to
15379a96b668Sdanielk1977       ** be used in place of a temp-table, it must be ordered according
1538e1fb65a0Sdanielk1977       ** to this collation sequence.  */
15399a96b668Sdanielk1977       CollSeq *pReq = sqlite3BinaryCompareCollSeq(pParse, pX->pLeft, pExpr);
15409a96b668Sdanielk1977 
15419a96b668Sdanielk1977       /* Check that the affinity that will be used to perform the
15429a96b668Sdanielk1977       ** comparison is the same as the affinity of the column. If
15439a96b668Sdanielk1977       ** it is not, it is not possible to use any index.
15449a96b668Sdanielk1977       */
1545dbaee5e3Sdrh       int affinity_ok = sqlite3IndexAffinityOk(pX, pTab->aCol[iCol].affinity);
15469a96b668Sdanielk1977 
15479a96b668Sdanielk1977       for(pIdx=pTab->pIndex; pIdx && eType==0 && affinity_ok; pIdx=pIdx->pNext){
15489a96b668Sdanielk1977         if( (pIdx->aiColumn[0]==iCol)
1549b74b1017Sdrh          && sqlite3FindCollSeq(db, ENC(db), pIdx->azColl[0], 0)==pReq
15509a96b668Sdanielk1977          && (!mustBeUnique || (pIdx->nColumn==1 && pIdx->onError!=OE_None))
15519a96b668Sdanielk1977         ){
15529a96b668Sdanielk1977           int iAddr;
15539a96b668Sdanielk1977           char *pKey;
15549a96b668Sdanielk1977 
15559a96b668Sdanielk1977           pKey = (char *)sqlite3IndexKeyinfo(pParse, pIdx);
15561d8cb21fSdan           iAddr = sqlite3CodeOnce(pParse);
15579a96b668Sdanielk1977 
1558207872a4Sdanielk1977           sqlite3VdbeAddOp4(v, OP_OpenRead, iTab, pIdx->tnum, iDb,
155966a5167bSdrh                                pKey,P4_KEYINFO_HANDOFF);
1560207872a4Sdanielk1977           VdbeComment((v, "%s", pIdx->zName));
15619a96b668Sdanielk1977           eType = IN_INDEX_INDEX;
15629a96b668Sdanielk1977 
15639a96b668Sdanielk1977           sqlite3VdbeJumpHere(v, iAddr);
15640cdc022eSdanielk1977           if( prNotFound && !pTab->aCol[iCol].notNull ){
15650cdc022eSdanielk1977             *prNotFound = ++pParse->nMem;
1566b8475df8Sdrh             sqlite3VdbeAddOp2(v, OP_Null, 0, *prNotFound);
15670cdc022eSdanielk1977           }
15689a96b668Sdanielk1977         }
15699a96b668Sdanielk1977       }
15709a96b668Sdanielk1977     }
15719a96b668Sdanielk1977   }
15729a96b668Sdanielk1977 
15739a96b668Sdanielk1977   if( eType==0 ){
15741450bc6eSdrh     /* Could not found an existing table or index to use as the RHS b-tree.
1575b74b1017Sdrh     ** We will have to generate an ephemeral table to do the job.
1576b74b1017Sdrh     */
1577cf4d38aaSdrh     double savedNQueryLoop = pParse->nQueryLoop;
15780cdc022eSdanielk1977     int rMayHaveNull = 0;
157941a05b7bSdanielk1977     eType = IN_INDEX_EPH;
15800cdc022eSdanielk1977     if( prNotFound ){
15810cdc022eSdanielk1977       *prNotFound = rMayHaveNull = ++pParse->nMem;
1582b8475df8Sdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, *prNotFound);
1583cf4d38aaSdrh     }else{
1584cf4d38aaSdrh       testcase( pParse->nQueryLoop>(double)1 );
1585cf4d38aaSdrh       pParse->nQueryLoop = (double)1;
1586cf4d38aaSdrh       if( pX->pLeft->iColumn<0 && !ExprHasAnyProperty(pX, EP_xIsSelect) ){
158741a05b7bSdanielk1977         eType = IN_INDEX_ROWID;
15880cdc022eSdanielk1977       }
1589cf4d38aaSdrh     }
159041a05b7bSdanielk1977     sqlite3CodeSubselect(pParse, pX, rMayHaveNull, eType==IN_INDEX_ROWID);
1591cf4d38aaSdrh     pParse->nQueryLoop = savedNQueryLoop;
15929a96b668Sdanielk1977   }else{
15939a96b668Sdanielk1977     pX->iTable = iTab;
15949a96b668Sdanielk1977   }
15959a96b668Sdanielk1977   return eType;
15969a96b668Sdanielk1977 }
1597284f4acaSdanielk1977 #endif
1598626a879aSdrh 
1599626a879aSdrh /*
1600d4187c71Sdrh ** Generate code for scalar subqueries used as a subquery expression, EXISTS,
1601d4187c71Sdrh ** or IN operators.  Examples:
1602626a879aSdrh **
16039cbe6352Sdrh **     (SELECT a FROM b)          -- subquery
16049cbe6352Sdrh **     EXISTS (SELECT a FROM b)   -- EXISTS subquery
16059cbe6352Sdrh **     x IN (4,5,11)              -- IN operator with list on right-hand side
16069cbe6352Sdrh **     x IN (SELECT a FROM b)     -- IN operator with subquery on the right
1607fef5208cSdrh **
16089cbe6352Sdrh ** The pExpr parameter describes the expression that contains the IN
16099cbe6352Sdrh ** operator or subquery.
161041a05b7bSdanielk1977 **
161141a05b7bSdanielk1977 ** If parameter isRowid is non-zero, then expression pExpr is guaranteed
161241a05b7bSdanielk1977 ** to be of the form "<rowid> IN (?, ?, ?)", where <rowid> is a reference
161341a05b7bSdanielk1977 ** to some integer key column of a table B-Tree. In this case, use an
161441a05b7bSdanielk1977 ** intkey B-Tree to store the set of IN(...) values instead of the usual
161541a05b7bSdanielk1977 ** (slower) variable length keys B-Tree.
1616fd773cf9Sdrh **
1617fd773cf9Sdrh ** If rMayHaveNull is non-zero, that means that the operation is an IN
1618fd773cf9Sdrh ** (not a SELECT or EXISTS) and that the RHS might contains NULLs.
1619fd773cf9Sdrh ** Furthermore, the IN is in a WHERE clause and that we really want
1620fd773cf9Sdrh ** to iterate over the RHS of the IN operator in order to quickly locate
1621fd773cf9Sdrh ** all corresponding LHS elements.  All this routine does is initialize
1622fd773cf9Sdrh ** the register given by rMayHaveNull to NULL.  Calling routines will take
1623fd773cf9Sdrh ** care of changing this register value to non-NULL if the RHS is NULL-free.
1624fd773cf9Sdrh **
1625fd773cf9Sdrh ** If rMayHaveNull is zero, that means that the subquery is being used
1626fd773cf9Sdrh ** for membership testing only.  There is no need to initialize any
1627fd773cf9Sdrh ** registers to indicate the presense or absence of NULLs on the RHS.
16281450bc6eSdrh **
16291450bc6eSdrh ** For a SELECT or EXISTS operator, return the register that holds the
16301450bc6eSdrh ** result.  For IN operators or if an error occurs, the return value is 0.
1631cce7d176Sdrh */
163251522cd3Sdrh #ifndef SQLITE_OMIT_SUBQUERY
16331450bc6eSdrh int sqlite3CodeSubselect(
1634fd773cf9Sdrh   Parse *pParse,          /* Parsing context */
1635fd773cf9Sdrh   Expr *pExpr,            /* The IN, SELECT, or EXISTS operator */
1636fd773cf9Sdrh   int rMayHaveNull,       /* Register that records whether NULLs exist in RHS */
1637fd773cf9Sdrh   int isRowid             /* If true, LHS of IN operator is a rowid */
163841a05b7bSdanielk1977 ){
1639dfd2d9f6Sdrh   int testAddr = -1;                      /* One-time test address */
16401450bc6eSdrh   int rReg = 0;                           /* Register storing resulting */
1641b3bce662Sdanielk1977   Vdbe *v = sqlite3GetVdbe(pParse);
16421450bc6eSdrh   if( NEVER(v==0) ) return 0;
1643ceea3321Sdrh   sqlite3ExprCachePush(pParse);
1644fc976065Sdanielk1977 
164557dbd7b3Sdrh   /* This code must be run in its entirety every time it is encountered
164657dbd7b3Sdrh   ** if any of the following is true:
164757dbd7b3Sdrh   **
164857dbd7b3Sdrh   **    *  The right-hand side is a correlated subquery
164957dbd7b3Sdrh   **    *  The right-hand side is an expression list containing variables
165057dbd7b3Sdrh   **    *  We are inside a trigger
165157dbd7b3Sdrh   **
165257dbd7b3Sdrh   ** If all of the above are false, then we can run this code just once
165357dbd7b3Sdrh   ** save the results, and reuse the same result on subsequent invocations.
1654b3bce662Sdanielk1977   */
16551d8cb21fSdan   if( !ExprHasAnyProperty(pExpr, EP_VarSelect) ){
16561d8cb21fSdan     testAddr = sqlite3CodeOnce(pParse);
1657b3bce662Sdanielk1977   }
1658b3bce662Sdanielk1977 
16594a07e3dbSdan #ifndef SQLITE_OMIT_EXPLAIN
16604a07e3dbSdan   if( pParse->explain==2 ){
16614a07e3dbSdan     char *zMsg = sqlite3MPrintf(
1662dfd2d9f6Sdrh         pParse->db, "EXECUTE %s%s SUBQUERY %d", testAddr>=0?"":"CORRELATED ",
16634a07e3dbSdan         pExpr->op==TK_IN?"LIST":"SCALAR", pParse->iNextSelectId
16644a07e3dbSdan     );
16654a07e3dbSdan     sqlite3VdbeAddOp4(v, OP_Explain, pParse->iSelectId, 0, 0, zMsg, P4_DYNAMIC);
16664a07e3dbSdan   }
16674a07e3dbSdan #endif
16684a07e3dbSdan 
1669cce7d176Sdrh   switch( pExpr->op ){
1670fef5208cSdrh     case TK_IN: {
1671d4187c71Sdrh       char affinity;              /* Affinity of the LHS of the IN */
1672d4187c71Sdrh       KeyInfo keyInfo;            /* Keyinfo for the generated table */
1673e1a022e4Sdrh       static u8 sortOrder = 0;    /* Fake aSortOrder for keyInfo */
1674b9bb7c18Sdrh       int addr;                   /* Address of OP_OpenEphemeral instruction */
1675d4187c71Sdrh       Expr *pLeft = pExpr->pLeft; /* the LHS of the IN operator */
1676d3d39e93Sdrh 
16770cdc022eSdanielk1977       if( rMayHaveNull ){
16780cdc022eSdanielk1977         sqlite3VdbeAddOp2(v, OP_Null, 0, rMayHaveNull);
16790cdc022eSdanielk1977       }
16800cdc022eSdanielk1977 
168141a05b7bSdanielk1977       affinity = sqlite3ExprAffinity(pLeft);
1682e014a838Sdanielk1977 
1683e014a838Sdanielk1977       /* Whether this is an 'x IN(SELECT...)' or an 'x IN(<exprlist>)'
16848cff69dfSdrh       ** expression it is handled the same way.  An ephemeral table is
1685e014a838Sdanielk1977       ** filled with single-field index keys representing the results
1686e014a838Sdanielk1977       ** from the SELECT or the <exprlist>.
1687fef5208cSdrh       **
1688e014a838Sdanielk1977       ** If the 'x' expression is a column value, or the SELECT...
1689e014a838Sdanielk1977       ** statement returns a column value, then the affinity of that
1690e014a838Sdanielk1977       ** column is used to build the index keys. If both 'x' and the
1691e014a838Sdanielk1977       ** SELECT... statement are columns, then numeric affinity is used
1692e014a838Sdanielk1977       ** if either column has NUMERIC or INTEGER affinity. If neither
1693e014a838Sdanielk1977       ** 'x' nor the SELECT... statement are columns, then numeric affinity
1694e014a838Sdanielk1977       ** is used.
1695fef5208cSdrh       */
1696832508b7Sdrh       pExpr->iTable = pParse->nTab++;
169741a05b7bSdanielk1977       addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, pExpr->iTable, !isRowid);
1698d4187c71Sdrh       if( rMayHaveNull==0 ) sqlite3VdbeChangeP5(v, BTREE_UNORDERED);
1699d3d39e93Sdrh       memset(&keyInfo, 0, sizeof(keyInfo));
1700d3d39e93Sdrh       keyInfo.nField = 1;
1701e1a022e4Sdrh       keyInfo.aSortOrder = &sortOrder;
1702e014a838Sdanielk1977 
17036ab3a2ecSdanielk1977       if( ExprHasProperty(pExpr, EP_xIsSelect) ){
1704e014a838Sdanielk1977         /* Case 1:     expr IN (SELECT ...)
1705e014a838Sdanielk1977         **
1706e014a838Sdanielk1977         ** Generate code to write the results of the select into the temporary
1707e014a838Sdanielk1977         ** table allocated and opened above.
1708e014a838Sdanielk1977         */
17091013c932Sdrh         SelectDest dest;
1710be5c89acSdrh         ExprList *pEList;
17111013c932Sdrh 
171241a05b7bSdanielk1977         assert( !isRowid );
17131013c932Sdrh         sqlite3SelectDestInit(&dest, SRT_Set, pExpr->iTable);
17142b596da8Sdrh         dest.affSdst = (u8)affinity;
1715e014a838Sdanielk1977         assert( (pExpr->iTable&0x0000FFFF)==pExpr->iTable );
171648b5b041Sdrh         pExpr->x.pSelect->iLimit = 0;
17176ab3a2ecSdanielk1977         if( sqlite3Select(pParse, pExpr->x.pSelect, &dest) ){
17181450bc6eSdrh           return 0;
171994ccde58Sdrh         }
17206ab3a2ecSdanielk1977         pEList = pExpr->x.pSelect->pEList;
1721fd773cf9Sdrh         if( ALWAYS(pEList!=0 && pEList->nExpr>0) ){
1722bcbb04e5Sdanielk1977           keyInfo.aColl[0] = sqlite3BinaryCompareCollSeq(pParse, pExpr->pLeft,
1723be5c89acSdrh               pEList->a[0].pExpr);
17240202b29eSdanielk1977         }
1725a7d2db17Sdrh       }else if( ALWAYS(pExpr->x.pList!=0) ){
1726fef5208cSdrh         /* Case 2:     expr IN (exprlist)
1727fef5208cSdrh         **
1728e014a838Sdanielk1977         ** For each expression, build an index key from the evaluation and
1729e014a838Sdanielk1977         ** store it in the temporary table. If <expr> is a column, then use
1730e014a838Sdanielk1977         ** that columns affinity when building index keys. If <expr> is not
1731e014a838Sdanielk1977         ** a column, use numeric affinity.
1732fef5208cSdrh         */
1733e014a838Sdanielk1977         int i;
17346ab3a2ecSdanielk1977         ExprList *pList = pExpr->x.pList;
173557dbd7b3Sdrh         struct ExprList_item *pItem;
1736ecc31805Sdrh         int r1, r2, r3;
173757dbd7b3Sdrh 
1738e014a838Sdanielk1977         if( !affinity ){
17398159a35fSdrh           affinity = SQLITE_AFF_NONE;
1740e014a838Sdanielk1977         }
17417d10d5a6Sdrh         keyInfo.aColl[0] = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
1742e1a022e4Sdrh         keyInfo.aSortOrder = &sortOrder;
1743e014a838Sdanielk1977 
1744e014a838Sdanielk1977         /* Loop through each expression in <exprlist>. */
17452d401ab8Sdrh         r1 = sqlite3GetTempReg(pParse);
17462d401ab8Sdrh         r2 = sqlite3GetTempReg(pParse);
17474e7f36a2Sdanielk1977         sqlite3VdbeAddOp2(v, OP_Null, 0, r2);
174857dbd7b3Sdrh         for(i=pList->nExpr, pItem=pList->a; i>0; i--, pItem++){
174957dbd7b3Sdrh           Expr *pE2 = pItem->pExpr;
1750e05c929bSdrh           int iValToIns;
1751e014a838Sdanielk1977 
175257dbd7b3Sdrh           /* If the expression is not constant then we will need to
175357dbd7b3Sdrh           ** disable the test that was generated above that makes sure
175457dbd7b3Sdrh           ** this code only executes once.  Because for a non-constant
175557dbd7b3Sdrh           ** expression we need to rerun this code each time.
175657dbd7b3Sdrh           */
1757dfd2d9f6Sdrh           if( testAddr>=0 && !sqlite3ExprIsConstant(pE2) ){
175848f2d3b1Sdrh             sqlite3VdbeChangeToNoop(v, testAddr);
1759dfd2d9f6Sdrh             testAddr = -1;
17604794b980Sdrh           }
1761e014a838Sdanielk1977 
1762e014a838Sdanielk1977           /* Evaluate the expression and insert it into the temp table */
1763e05c929bSdrh           if( isRowid && sqlite3ExprIsInteger(pE2, &iValToIns) ){
1764e05c929bSdrh             sqlite3VdbeAddOp3(v, OP_InsertInt, pExpr->iTable, r2, iValToIns);
1765e05c929bSdrh           }else{
1766ecc31805Sdrh             r3 = sqlite3ExprCodeTarget(pParse, pE2, r1);
176741a05b7bSdanielk1977             if( isRowid ){
1768e05c929bSdrh               sqlite3VdbeAddOp2(v, OP_MustBeInt, r3,
1769e05c929bSdrh                                 sqlite3VdbeCurrentAddr(v)+2);
177041a05b7bSdanielk1977               sqlite3VdbeAddOp3(v, OP_Insert, pExpr->iTable, r2, r3);
177141a05b7bSdanielk1977             }else{
1772ecc31805Sdrh               sqlite3VdbeAddOp4(v, OP_MakeRecord, r3, 1, r2, &affinity, 1);
17733c31fc23Sdrh               sqlite3ExprCacheAffinityChange(pParse, r3, 1);
17742d401ab8Sdrh               sqlite3VdbeAddOp2(v, OP_IdxInsert, pExpr->iTable, r2);
1775fef5208cSdrh             }
177641a05b7bSdanielk1977           }
1777e05c929bSdrh         }
17782d401ab8Sdrh         sqlite3ReleaseTempReg(pParse, r1);
17792d401ab8Sdrh         sqlite3ReleaseTempReg(pParse, r2);
1780fef5208cSdrh       }
178141a05b7bSdanielk1977       if( !isRowid ){
178266a5167bSdrh         sqlite3VdbeChangeP4(v, addr, (void *)&keyInfo, P4_KEYINFO);
178341a05b7bSdanielk1977       }
1784b3bce662Sdanielk1977       break;
1785fef5208cSdrh     }
1786fef5208cSdrh 
178751522cd3Sdrh     case TK_EXISTS:
1788fd773cf9Sdrh     case TK_SELECT:
1789fd773cf9Sdrh     default: {
1790fd773cf9Sdrh       /* If this has to be a scalar SELECT.  Generate code to put the
1791fef5208cSdrh       ** value of this select in a memory cell and record the number
1792fd773cf9Sdrh       ** of the memory cell in iColumn.  If this is an EXISTS, write
1793fd773cf9Sdrh       ** an integer 0 (not exists) or 1 (exists) into a memory cell
1794fd773cf9Sdrh       ** and record that memory cell in iColumn.
1795fef5208cSdrh       */
1796fd773cf9Sdrh       Select *pSel;                         /* SELECT statement to encode */
1797fd773cf9Sdrh       SelectDest dest;                      /* How to deal with SELECt result */
17981398ad36Sdrh 
1799cf697396Sshane       testcase( pExpr->op==TK_EXISTS );
1800cf697396Sshane       testcase( pExpr->op==TK_SELECT );
1801cf697396Sshane       assert( pExpr->op==TK_EXISTS || pExpr->op==TK_SELECT );
1802cf697396Sshane 
18036ab3a2ecSdanielk1977       assert( ExprHasProperty(pExpr, EP_xIsSelect) );
18046ab3a2ecSdanielk1977       pSel = pExpr->x.pSelect;
18051013c932Sdrh       sqlite3SelectDestInit(&dest, 0, ++pParse->nMem);
180651522cd3Sdrh       if( pExpr->op==TK_SELECT ){
18076c8c8ce0Sdanielk1977         dest.eDest = SRT_Mem;
18082b596da8Sdrh         sqlite3VdbeAddOp2(v, OP_Null, 0, dest.iSDParm);
1809d4e70ebdSdrh         VdbeComment((v, "Init subquery result"));
181051522cd3Sdrh       }else{
18116c8c8ce0Sdanielk1977         dest.eDest = SRT_Exists;
18122b596da8Sdrh         sqlite3VdbeAddOp2(v, OP_Integer, 0, dest.iSDParm);
1813d4e70ebdSdrh         VdbeComment((v, "Init EXISTS result"));
181451522cd3Sdrh       }
1815633e6d57Sdrh       sqlite3ExprDelete(pParse->db, pSel->pLimit);
1816094430ebSdrh       pSel->pLimit = sqlite3PExpr(pParse, TK_INTEGER, 0, 0,
1817094430ebSdrh                                   &sqlite3IntTokens[1]);
181848b5b041Sdrh       pSel->iLimit = 0;
18197d10d5a6Sdrh       if( sqlite3Select(pParse, pSel, &dest) ){
18201450bc6eSdrh         return 0;
182194ccde58Sdrh       }
18222b596da8Sdrh       rReg = dest.iSDParm;
182333e619fcSdrh       ExprSetIrreducible(pExpr);
1824b3bce662Sdanielk1977       break;
182519a775c2Sdrh     }
1826cce7d176Sdrh   }
1827b3bce662Sdanielk1977 
1828dfd2d9f6Sdrh   if( testAddr>=0 ){
182948f2d3b1Sdrh     sqlite3VdbeJumpHere(v, testAddr);
1830b3bce662Sdanielk1977   }
1831ceea3321Sdrh   sqlite3ExprCachePop(pParse, 1);
1832fc976065Sdanielk1977 
18331450bc6eSdrh   return rReg;
1834cce7d176Sdrh }
183551522cd3Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
1836cce7d176Sdrh 
1837e3365e6cSdrh #ifndef SQLITE_OMIT_SUBQUERY
1838e3365e6cSdrh /*
1839e3365e6cSdrh ** Generate code for an IN expression.
1840e3365e6cSdrh **
1841e3365e6cSdrh **      x IN (SELECT ...)
1842e3365e6cSdrh **      x IN (value, value, ...)
1843e3365e6cSdrh **
1844e3365e6cSdrh ** The left-hand side (LHS) is a scalar expression.  The right-hand side (RHS)
1845e3365e6cSdrh ** is an array of zero or more values.  The expression is true if the LHS is
1846e3365e6cSdrh ** contained within the RHS.  The value of the expression is unknown (NULL)
1847e3365e6cSdrh ** if the LHS is NULL or if the LHS is not contained within the RHS and the
1848e3365e6cSdrh ** RHS contains one or more NULL values.
1849e3365e6cSdrh **
1850e3365e6cSdrh ** This routine generates code will jump to destIfFalse if the LHS is not
1851e3365e6cSdrh ** contained within the RHS.  If due to NULLs we cannot determine if the LHS
1852e3365e6cSdrh ** is contained in the RHS then jump to destIfNull.  If the LHS is contained
1853e3365e6cSdrh ** within the RHS then fall through.
1854e3365e6cSdrh */
1855e3365e6cSdrh static void sqlite3ExprCodeIN(
1856e3365e6cSdrh   Parse *pParse,        /* Parsing and code generating context */
1857e3365e6cSdrh   Expr *pExpr,          /* The IN expression */
1858e3365e6cSdrh   int destIfFalse,      /* Jump here if LHS is not contained in the RHS */
1859e3365e6cSdrh   int destIfNull        /* Jump here if the results are unknown due to NULLs */
1860e3365e6cSdrh ){
1861e3365e6cSdrh   int rRhsHasNull = 0;  /* Register that is true if RHS contains NULL values */
1862e3365e6cSdrh   char affinity;        /* Comparison affinity to use */
1863e3365e6cSdrh   int eType;            /* Type of the RHS */
1864e3365e6cSdrh   int r1;               /* Temporary use register */
1865e3365e6cSdrh   Vdbe *v;              /* Statement under construction */
1866e3365e6cSdrh 
1867e3365e6cSdrh   /* Compute the RHS.   After this step, the table with cursor
1868e3365e6cSdrh   ** pExpr->iTable will contains the values that make up the RHS.
1869e3365e6cSdrh   */
1870e3365e6cSdrh   v = pParse->pVdbe;
1871e3365e6cSdrh   assert( v!=0 );       /* OOM detected prior to this routine */
1872e3365e6cSdrh   VdbeNoopComment((v, "begin IN expr"));
1873e3365e6cSdrh   eType = sqlite3FindInIndex(pParse, pExpr, &rRhsHasNull);
1874e3365e6cSdrh 
1875e3365e6cSdrh   /* Figure out the affinity to use to create a key from the results
1876e3365e6cSdrh   ** of the expression. affinityStr stores a static string suitable for
1877e3365e6cSdrh   ** P4 of OP_MakeRecord.
1878e3365e6cSdrh   */
1879e3365e6cSdrh   affinity = comparisonAffinity(pExpr);
1880e3365e6cSdrh 
1881e3365e6cSdrh   /* Code the LHS, the <expr> from "<expr> IN (...)".
1882e3365e6cSdrh   */
1883e3365e6cSdrh   sqlite3ExprCachePush(pParse);
1884e3365e6cSdrh   r1 = sqlite3GetTempReg(pParse);
1885e3365e6cSdrh   sqlite3ExprCode(pParse, pExpr->pLeft, r1);
1886e3365e6cSdrh 
1887094430ebSdrh   /* If the LHS is NULL, then the result is either false or NULL depending
1888094430ebSdrh   ** on whether the RHS is empty or not, respectively.
1889094430ebSdrh   */
1890094430ebSdrh   if( destIfNull==destIfFalse ){
1891094430ebSdrh     /* Shortcut for the common case where the false and NULL outcomes are
1892094430ebSdrh     ** the same. */
1893094430ebSdrh     sqlite3VdbeAddOp2(v, OP_IsNull, r1, destIfNull);
1894094430ebSdrh   }else{
1895094430ebSdrh     int addr1 = sqlite3VdbeAddOp1(v, OP_NotNull, r1);
1896094430ebSdrh     sqlite3VdbeAddOp2(v, OP_Rewind, pExpr->iTable, destIfFalse);
1897094430ebSdrh     sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfNull);
1898094430ebSdrh     sqlite3VdbeJumpHere(v, addr1);
1899094430ebSdrh   }
1900e3365e6cSdrh 
1901e3365e6cSdrh   if( eType==IN_INDEX_ROWID ){
1902e3365e6cSdrh     /* In this case, the RHS is the ROWID of table b-tree
1903e3365e6cSdrh     */
1904e3365e6cSdrh     sqlite3VdbeAddOp2(v, OP_MustBeInt, r1, destIfFalse);
1905e3365e6cSdrh     sqlite3VdbeAddOp3(v, OP_NotExists, pExpr->iTable, destIfFalse, r1);
1906e3365e6cSdrh   }else{
1907e3365e6cSdrh     /* In this case, the RHS is an index b-tree.
1908e3365e6cSdrh     */
19098cff69dfSdrh     sqlite3VdbeAddOp4(v, OP_Affinity, r1, 1, 0, &affinity, 1);
1910e3365e6cSdrh 
1911e3365e6cSdrh     /* If the set membership test fails, then the result of the
1912e3365e6cSdrh     ** "x IN (...)" expression must be either 0 or NULL. If the set
1913e3365e6cSdrh     ** contains no NULL values, then the result is 0. If the set
1914e3365e6cSdrh     ** contains one or more NULL values, then the result of the
1915e3365e6cSdrh     ** expression is also NULL.
1916e3365e6cSdrh     */
1917e3365e6cSdrh     if( rRhsHasNull==0 || destIfFalse==destIfNull ){
1918e3365e6cSdrh       /* This branch runs if it is known at compile time that the RHS
1919e3365e6cSdrh       ** cannot contain NULL values. This happens as the result
1920e3365e6cSdrh       ** of a "NOT NULL" constraint in the database schema.
1921e3365e6cSdrh       **
1922e3365e6cSdrh       ** Also run this branch if NULL is equivalent to FALSE
1923e3365e6cSdrh       ** for this particular IN operator.
1924e3365e6cSdrh       */
19258cff69dfSdrh       sqlite3VdbeAddOp4Int(v, OP_NotFound, pExpr->iTable, destIfFalse, r1, 1);
1926e3365e6cSdrh 
1927e3365e6cSdrh     }else{
1928e3365e6cSdrh       /* In this branch, the RHS of the IN might contain a NULL and
1929e3365e6cSdrh       ** the presence of a NULL on the RHS makes a difference in the
1930e3365e6cSdrh       ** outcome.
1931e3365e6cSdrh       */
1932e3365e6cSdrh       int j1, j2, j3;
1933e3365e6cSdrh 
1934e3365e6cSdrh       /* First check to see if the LHS is contained in the RHS.  If so,
1935e3365e6cSdrh       ** then the presence of NULLs in the RHS does not matter, so jump
1936e3365e6cSdrh       ** over all of the code that follows.
1937e3365e6cSdrh       */
19388cff69dfSdrh       j1 = sqlite3VdbeAddOp4Int(v, OP_Found, pExpr->iTable, 0, r1, 1);
1939e3365e6cSdrh 
1940e3365e6cSdrh       /* Here we begin generating code that runs if the LHS is not
1941e3365e6cSdrh       ** contained within the RHS.  Generate additional code that
1942e3365e6cSdrh       ** tests the RHS for NULLs.  If the RHS contains a NULL then
1943e3365e6cSdrh       ** jump to destIfNull.  If there are no NULLs in the RHS then
1944e3365e6cSdrh       ** jump to destIfFalse.
1945e3365e6cSdrh       */
1946e3365e6cSdrh       j2 = sqlite3VdbeAddOp1(v, OP_NotNull, rRhsHasNull);
19478cff69dfSdrh       j3 = sqlite3VdbeAddOp4Int(v, OP_Found, pExpr->iTable, 0, rRhsHasNull, 1);
1948e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_Integer, -1, rRhsHasNull);
1949e3365e6cSdrh       sqlite3VdbeJumpHere(v, j3);
1950e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_AddImm, rRhsHasNull, 1);
1951e3365e6cSdrh       sqlite3VdbeJumpHere(v, j2);
1952e3365e6cSdrh 
1953e3365e6cSdrh       /* Jump to the appropriate target depending on whether or not
1954e3365e6cSdrh       ** the RHS contains a NULL
1955e3365e6cSdrh       */
1956e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_If, rRhsHasNull, destIfNull);
1957e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfFalse);
1958e3365e6cSdrh 
1959e3365e6cSdrh       /* The OP_Found at the top of this branch jumps here when true,
1960e3365e6cSdrh       ** causing the overall IN expression evaluation to fall through.
1961e3365e6cSdrh       */
1962e3365e6cSdrh       sqlite3VdbeJumpHere(v, j1);
1963e3365e6cSdrh     }
1964e3365e6cSdrh   }
1965e3365e6cSdrh   sqlite3ReleaseTempReg(pParse, r1);
1966e3365e6cSdrh   sqlite3ExprCachePop(pParse, 1);
1967e3365e6cSdrh   VdbeComment((v, "end IN expr"));
1968e3365e6cSdrh }
1969e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
1970e3365e6cSdrh 
1971cce7d176Sdrh /*
1972598f1340Sdrh ** Duplicate an 8-byte value
1973598f1340Sdrh */
1974598f1340Sdrh static char *dup8bytes(Vdbe *v, const char *in){
1975598f1340Sdrh   char *out = sqlite3DbMallocRaw(sqlite3VdbeDb(v), 8);
1976598f1340Sdrh   if( out ){
1977598f1340Sdrh     memcpy(out, in, 8);
1978598f1340Sdrh   }
1979598f1340Sdrh   return out;
1980598f1340Sdrh }
1981598f1340Sdrh 
198213573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
1983598f1340Sdrh /*
1984598f1340Sdrh ** Generate an instruction that will put the floating point
19859cbf3425Sdrh ** value described by z[0..n-1] into register iMem.
19860cf19ed8Sdrh **
19870cf19ed8Sdrh ** The z[] string will probably not be zero-terminated.  But the
19880cf19ed8Sdrh ** z[n] character is guaranteed to be something that does not look
19890cf19ed8Sdrh ** like the continuation of the number.
1990598f1340Sdrh */
1991b7916a78Sdrh static void codeReal(Vdbe *v, const char *z, int negateFlag, int iMem){
1992fd773cf9Sdrh   if( ALWAYS(z!=0) ){
1993598f1340Sdrh     double value;
1994598f1340Sdrh     char *zV;
19959339da1fSdrh     sqlite3AtoF(z, &value, sqlite3Strlen30(z), SQLITE_UTF8);
1996d0015161Sdrh     assert( !sqlite3IsNaN(value) ); /* The new AtoF never returns NaN */
1997598f1340Sdrh     if( negateFlag ) value = -value;
1998598f1340Sdrh     zV = dup8bytes(v, (char*)&value);
19999de221dfSdrh     sqlite3VdbeAddOp4(v, OP_Real, 0, iMem, 0, zV, P4_REAL);
2000598f1340Sdrh   }
2001598f1340Sdrh }
200213573c71Sdrh #endif
2003598f1340Sdrh 
2004598f1340Sdrh 
2005598f1340Sdrh /*
2006fec19aadSdrh ** Generate an instruction that will put the integer describe by
20079cbf3425Sdrh ** text z[0..n-1] into register iMem.
20080cf19ed8Sdrh **
20095f1d6b61Sshaneh ** Expr.u.zToken is always UTF8 and zero-terminated.
2010fec19aadSdrh */
201113573c71Sdrh static void codeInteger(Parse *pParse, Expr *pExpr, int negFlag, int iMem){
201213573c71Sdrh   Vdbe *v = pParse->pVdbe;
201392b01d53Sdrh   if( pExpr->flags & EP_IntValue ){
201433e619fcSdrh     int i = pExpr->u.iValue;
2015d50ffc41Sdrh     assert( i>=0 );
201692b01d53Sdrh     if( negFlag ) i = -i;
201792b01d53Sdrh     sqlite3VdbeAddOp2(v, OP_Integer, i, iMem);
2018fd773cf9Sdrh   }else{
20195f1d6b61Sshaneh     int c;
20205f1d6b61Sshaneh     i64 value;
2021fd773cf9Sdrh     const char *z = pExpr->u.zToken;
2022fd773cf9Sdrh     assert( z!=0 );
20235f1d6b61Sshaneh     c = sqlite3Atoi64(z, &value, sqlite3Strlen30(z), SQLITE_UTF8);
20245f1d6b61Sshaneh     if( c==0 || (c==2 && negFlag) ){
2025598f1340Sdrh       char *zV;
2026158b9cb9Sdrh       if( negFlag ){ value = c==2 ? SMALLEST_INT64 : -value; }
2027598f1340Sdrh       zV = dup8bytes(v, (char*)&value);
20289de221dfSdrh       sqlite3VdbeAddOp4(v, OP_Int64, 0, iMem, 0, zV, P4_INT64);
2029fec19aadSdrh     }else{
203013573c71Sdrh #ifdef SQLITE_OMIT_FLOATING_POINT
203113573c71Sdrh       sqlite3ErrorMsg(pParse, "oversized integer: %s%s", negFlag ? "-" : "", z);
203213573c71Sdrh #else
2033b7916a78Sdrh       codeReal(v, z, negFlag, iMem);
203413573c71Sdrh #endif
2035fec19aadSdrh     }
2036fec19aadSdrh   }
2037c9cf901dSdanielk1977 }
2038fec19aadSdrh 
2039ceea3321Sdrh /*
2040ceea3321Sdrh ** Clear a cache entry.
2041ceea3321Sdrh */
2042ceea3321Sdrh static void cacheEntryClear(Parse *pParse, struct yColCache *p){
2043ceea3321Sdrh   if( p->tempReg ){
2044ceea3321Sdrh     if( pParse->nTempReg<ArraySize(pParse->aTempReg) ){
2045ceea3321Sdrh       pParse->aTempReg[pParse->nTempReg++] = p->iReg;
2046ceea3321Sdrh     }
2047ceea3321Sdrh     p->tempReg = 0;
2048ceea3321Sdrh   }
2049ceea3321Sdrh }
2050ceea3321Sdrh 
2051ceea3321Sdrh 
2052ceea3321Sdrh /*
2053ceea3321Sdrh ** Record in the column cache that a particular column from a
2054ceea3321Sdrh ** particular table is stored in a particular register.
2055ceea3321Sdrh */
2056ceea3321Sdrh void sqlite3ExprCacheStore(Parse *pParse, int iTab, int iCol, int iReg){
2057ceea3321Sdrh   int i;
2058ceea3321Sdrh   int minLru;
2059ceea3321Sdrh   int idxLru;
2060ceea3321Sdrh   struct yColCache *p;
2061ceea3321Sdrh 
206220411ea7Sdrh   assert( iReg>0 );  /* Register numbers are always positive */
206320411ea7Sdrh   assert( iCol>=-1 && iCol<32768 );  /* Finite column numbers */
206420411ea7Sdrh 
2065b6da74ebSdrh   /* The SQLITE_ColumnCache flag disables the column cache.  This is used
2066b6da74ebSdrh   ** for testing only - to verify that SQLite always gets the same answer
2067b6da74ebSdrh   ** with and without the column cache.
2068b6da74ebSdrh   */
20697e5418e4Sdrh   if( OptimizationDisabled(pParse->db, SQLITE_ColumnCache) ) return;
2070b6da74ebSdrh 
207127ee406eSdrh   /* First replace any existing entry.
207227ee406eSdrh   **
207327ee406eSdrh   ** Actually, the way the column cache is currently used, we are guaranteed
207427ee406eSdrh   ** that the object will never already be in cache.  Verify this guarantee.
207527ee406eSdrh   */
207627ee406eSdrh #ifndef NDEBUG
2077ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
207827ee406eSdrh     assert( p->iReg==0 || p->iTable!=iTab || p->iColumn!=iCol );
2079ceea3321Sdrh   }
208027ee406eSdrh #endif
2081ceea3321Sdrh 
2082ceea3321Sdrh   /* Find an empty slot and replace it */
2083ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2084ceea3321Sdrh     if( p->iReg==0 ){
2085ceea3321Sdrh       p->iLevel = pParse->iCacheLevel;
2086ceea3321Sdrh       p->iTable = iTab;
2087ceea3321Sdrh       p->iColumn = iCol;
2088ceea3321Sdrh       p->iReg = iReg;
2089ceea3321Sdrh       p->tempReg = 0;
2090ceea3321Sdrh       p->lru = pParse->iCacheCnt++;
2091ceea3321Sdrh       return;
2092ceea3321Sdrh     }
2093ceea3321Sdrh   }
2094ceea3321Sdrh 
2095ceea3321Sdrh   /* Replace the last recently used */
2096ceea3321Sdrh   minLru = 0x7fffffff;
2097ceea3321Sdrh   idxLru = -1;
2098ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2099ceea3321Sdrh     if( p->lru<minLru ){
2100ceea3321Sdrh       idxLru = i;
2101ceea3321Sdrh       minLru = p->lru;
2102ceea3321Sdrh     }
2103ceea3321Sdrh   }
210420411ea7Sdrh   if( ALWAYS(idxLru>=0) ){
2105ceea3321Sdrh     p = &pParse->aColCache[idxLru];
2106ceea3321Sdrh     p->iLevel = pParse->iCacheLevel;
2107ceea3321Sdrh     p->iTable = iTab;
2108ceea3321Sdrh     p->iColumn = iCol;
2109ceea3321Sdrh     p->iReg = iReg;
2110ceea3321Sdrh     p->tempReg = 0;
2111ceea3321Sdrh     p->lru = pParse->iCacheCnt++;
2112ceea3321Sdrh     return;
2113ceea3321Sdrh   }
2114ceea3321Sdrh }
2115ceea3321Sdrh 
2116ceea3321Sdrh /*
2117f49f3523Sdrh ** Indicate that registers between iReg..iReg+nReg-1 are being overwritten.
2118f49f3523Sdrh ** Purge the range of registers from the column cache.
2119ceea3321Sdrh */
2120f49f3523Sdrh void sqlite3ExprCacheRemove(Parse *pParse, int iReg, int nReg){
2121ceea3321Sdrh   int i;
2122f49f3523Sdrh   int iLast = iReg + nReg - 1;
2123ceea3321Sdrh   struct yColCache *p;
2124ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2125f49f3523Sdrh     int r = p->iReg;
2126f49f3523Sdrh     if( r>=iReg && r<=iLast ){
2127ceea3321Sdrh       cacheEntryClear(pParse, p);
2128ceea3321Sdrh       p->iReg = 0;
2129ceea3321Sdrh     }
2130ceea3321Sdrh   }
2131ceea3321Sdrh }
2132ceea3321Sdrh 
2133ceea3321Sdrh /*
2134ceea3321Sdrh ** Remember the current column cache context.  Any new entries added
2135ceea3321Sdrh ** added to the column cache after this call are removed when the
2136ceea3321Sdrh ** corresponding pop occurs.
2137ceea3321Sdrh */
2138ceea3321Sdrh void sqlite3ExprCachePush(Parse *pParse){
2139ceea3321Sdrh   pParse->iCacheLevel++;
2140ceea3321Sdrh }
2141ceea3321Sdrh 
2142ceea3321Sdrh /*
2143ceea3321Sdrh ** Remove from the column cache any entries that were added since the
2144ceea3321Sdrh ** the previous N Push operations.  In other words, restore the cache
2145ceea3321Sdrh ** to the state it was in N Pushes ago.
2146ceea3321Sdrh */
2147ceea3321Sdrh void sqlite3ExprCachePop(Parse *pParse, int N){
2148ceea3321Sdrh   int i;
2149ceea3321Sdrh   struct yColCache *p;
2150ceea3321Sdrh   assert( N>0 );
2151ceea3321Sdrh   assert( pParse->iCacheLevel>=N );
2152ceea3321Sdrh   pParse->iCacheLevel -= N;
2153ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2154ceea3321Sdrh     if( p->iReg && p->iLevel>pParse->iCacheLevel ){
2155ceea3321Sdrh       cacheEntryClear(pParse, p);
2156ceea3321Sdrh       p->iReg = 0;
2157ceea3321Sdrh     }
2158ceea3321Sdrh   }
2159ceea3321Sdrh }
2160945498f3Sdrh 
2161945498f3Sdrh /*
21625cd79239Sdrh ** When a cached column is reused, make sure that its register is
21635cd79239Sdrh ** no longer available as a temp register.  ticket #3879:  that same
21645cd79239Sdrh ** register might be in the cache in multiple places, so be sure to
21655cd79239Sdrh ** get them all.
21665cd79239Sdrh */
21675cd79239Sdrh static void sqlite3ExprCachePinRegister(Parse *pParse, int iReg){
21685cd79239Sdrh   int i;
21695cd79239Sdrh   struct yColCache *p;
21705cd79239Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
21715cd79239Sdrh     if( p->iReg==iReg ){
21725cd79239Sdrh       p->tempReg = 0;
21735cd79239Sdrh     }
21745cd79239Sdrh   }
21755cd79239Sdrh }
21765cd79239Sdrh 
21775cd79239Sdrh /*
21785c092e8aSdrh ** Generate code to extract the value of the iCol-th column of a table.
21795c092e8aSdrh */
21805c092e8aSdrh void sqlite3ExprCodeGetColumnOfTable(
21815c092e8aSdrh   Vdbe *v,        /* The VDBE under construction */
21825c092e8aSdrh   Table *pTab,    /* The table containing the value */
21835c092e8aSdrh   int iTabCur,    /* The cursor for this table */
21845c092e8aSdrh   int iCol,       /* Index of the column to extract */
21855c092e8aSdrh   int regOut      /* Extract the valud into this register */
21865c092e8aSdrh ){
21875c092e8aSdrh   if( iCol<0 || iCol==pTab->iPKey ){
21885c092e8aSdrh     sqlite3VdbeAddOp2(v, OP_Rowid, iTabCur, regOut);
21895c092e8aSdrh   }else{
21905c092e8aSdrh     int op = IsVirtual(pTab) ? OP_VColumn : OP_Column;
21915c092e8aSdrh     sqlite3VdbeAddOp3(v, op, iTabCur, iCol, regOut);
21925c092e8aSdrh   }
21935c092e8aSdrh   if( iCol>=0 ){
21945c092e8aSdrh     sqlite3ColumnDefault(v, pTab, iCol, regOut);
21955c092e8aSdrh   }
21965c092e8aSdrh }
21975c092e8aSdrh 
21985c092e8aSdrh /*
2199945498f3Sdrh ** Generate code that will extract the iColumn-th column from
2200e55cbd72Sdrh ** table pTab and store the column value in a register.  An effort
2201e55cbd72Sdrh ** is made to store the column value in register iReg, but this is
2202e55cbd72Sdrh ** not guaranteed.  The location of the column value is returned.
2203e55cbd72Sdrh **
2204e55cbd72Sdrh ** There must be an open cursor to pTab in iTable when this routine
2205e55cbd72Sdrh ** is called.  If iColumn<0 then code is generated that extracts the rowid.
2206945498f3Sdrh */
2207e55cbd72Sdrh int sqlite3ExprCodeGetColumn(
2208e55cbd72Sdrh   Parse *pParse,   /* Parsing and code generating context */
22092133d822Sdrh   Table *pTab,     /* Description of the table we are reading from */
22102133d822Sdrh   int iColumn,     /* Index of the table column */
22112133d822Sdrh   int iTable,      /* The cursor pointing to the table */
2212a748fdccSdrh   int iReg,        /* Store results here */
2213a748fdccSdrh   u8 p5            /* P5 value for OP_Column */
22142133d822Sdrh ){
2215e55cbd72Sdrh   Vdbe *v = pParse->pVdbe;
2216e55cbd72Sdrh   int i;
2217da250ea5Sdrh   struct yColCache *p;
2218e55cbd72Sdrh 
2219ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2220b6da74ebSdrh     if( p->iReg>0 && p->iTable==iTable && p->iColumn==iColumn ){
2221ceea3321Sdrh       p->lru = pParse->iCacheCnt++;
22225cd79239Sdrh       sqlite3ExprCachePinRegister(pParse, p->iReg);
2223da250ea5Sdrh       return p->iReg;
2224e55cbd72Sdrh     }
2225e55cbd72Sdrh   }
2226e55cbd72Sdrh   assert( v!=0 );
22275c092e8aSdrh   sqlite3ExprCodeGetColumnOfTable(v, pTab, iTable, iColumn, iReg);
2228a748fdccSdrh   if( p5 ){
2229a748fdccSdrh     sqlite3VdbeChangeP5(v, p5);
2230a748fdccSdrh   }else{
2231ceea3321Sdrh     sqlite3ExprCacheStore(pParse, iTable, iColumn, iReg);
2232a748fdccSdrh   }
2233e55cbd72Sdrh   return iReg;
2234e55cbd72Sdrh }
2235e55cbd72Sdrh 
2236e55cbd72Sdrh /*
2237ceea3321Sdrh ** Clear all column cache entries.
2238e55cbd72Sdrh */
2239ceea3321Sdrh void sqlite3ExprCacheClear(Parse *pParse){
2240e55cbd72Sdrh   int i;
2241ceea3321Sdrh   struct yColCache *p;
2242ceea3321Sdrh 
2243ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2244ceea3321Sdrh     if( p->iReg ){
2245ceea3321Sdrh       cacheEntryClear(pParse, p);
2246ceea3321Sdrh       p->iReg = 0;
2247e55cbd72Sdrh     }
2248da250ea5Sdrh   }
2249da250ea5Sdrh }
2250e55cbd72Sdrh 
2251e55cbd72Sdrh /*
2252da250ea5Sdrh ** Record the fact that an affinity change has occurred on iCount
2253da250ea5Sdrh ** registers starting with iStart.
2254e55cbd72Sdrh */
2255da250ea5Sdrh void sqlite3ExprCacheAffinityChange(Parse *pParse, int iStart, int iCount){
2256f49f3523Sdrh   sqlite3ExprCacheRemove(pParse, iStart, iCount);
2257e55cbd72Sdrh }
2258e55cbd72Sdrh 
2259e55cbd72Sdrh /*
2260b21e7c70Sdrh ** Generate code to move content from registers iFrom...iFrom+nReg-1
2261b21e7c70Sdrh ** over to iTo..iTo+nReg-1. Keep the column cache up-to-date.
2262e55cbd72Sdrh */
2263b21e7c70Sdrh void sqlite3ExprCodeMove(Parse *pParse, int iFrom, int iTo, int nReg){
2264e55cbd72Sdrh   int i;
2265ceea3321Sdrh   struct yColCache *p;
2266e8e4af76Sdrh   assert( iFrom>=iTo+nReg || iFrom+nReg<=iTo );
2267e8e4af76Sdrh   sqlite3VdbeAddOp3(pParse->pVdbe, OP_Move, iFrom, iTo, nReg-1);
2268ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2269ceea3321Sdrh     int x = p->iReg;
2270b21e7c70Sdrh     if( x>=iFrom && x<iFrom+nReg ){
2271ceea3321Sdrh       p->iReg += iTo-iFrom;
2272e55cbd72Sdrh     }
2273e55cbd72Sdrh   }
2274945498f3Sdrh }
2275945498f3Sdrh 
2276f49f3523Sdrh #if defined(SQLITE_DEBUG) || defined(SQLITE_COVERAGE_TEST)
227792b01d53Sdrh /*
2278652fbf55Sdrh ** Return true if any register in the range iFrom..iTo (inclusive)
2279652fbf55Sdrh ** is used as part of the column cache.
2280f49f3523Sdrh **
2281f49f3523Sdrh ** This routine is used within assert() and testcase() macros only
2282f49f3523Sdrh ** and does not appear in a normal build.
2283652fbf55Sdrh */
2284652fbf55Sdrh static int usedAsColumnCache(Parse *pParse, int iFrom, int iTo){
2285652fbf55Sdrh   int i;
2286ceea3321Sdrh   struct yColCache *p;
2287ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2288ceea3321Sdrh     int r = p->iReg;
2289f49f3523Sdrh     if( r>=iFrom && r<=iTo ) return 1;    /*NO_TEST*/
2290652fbf55Sdrh   }
2291652fbf55Sdrh   return 0;
2292652fbf55Sdrh }
2293f49f3523Sdrh #endif /* SQLITE_DEBUG || SQLITE_COVERAGE_TEST */
2294652fbf55Sdrh 
2295652fbf55Sdrh /*
2296cce7d176Sdrh ** Generate code into the current Vdbe to evaluate the given
22972dcef11bSdrh ** expression.  Attempt to store the results in register "target".
22982dcef11bSdrh ** Return the register where results are stored.
2299389a1adbSdrh **
23008b213899Sdrh ** With this routine, there is no guarantee that results will
23012dcef11bSdrh ** be stored in target.  The result might be stored in some other
23022dcef11bSdrh ** register if it is convenient to do so.  The calling function
23032dcef11bSdrh ** must check the return code and move the results to the desired
23042dcef11bSdrh ** register.
2305cce7d176Sdrh */
2306678ccce8Sdrh int sqlite3ExprCodeTarget(Parse *pParse, Expr *pExpr, int target){
23072dcef11bSdrh   Vdbe *v = pParse->pVdbe;  /* The VM under construction */
23082dcef11bSdrh   int op;                   /* The opcode being coded */
23092dcef11bSdrh   int inReg = target;       /* Results stored in register inReg */
23102dcef11bSdrh   int regFree1 = 0;         /* If non-zero free this temporary register */
23112dcef11bSdrh   int regFree2 = 0;         /* If non-zero free this temporary register */
2312678ccce8Sdrh   int r1, r2, r3, r4;       /* Various register numbers */
231320411ea7Sdrh   sqlite3 *db = pParse->db; /* The database connection */
2314ffe07b2dSdrh 
23159cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
231620411ea7Sdrh   if( v==0 ){
231720411ea7Sdrh     assert( pParse->db->mallocFailed );
231820411ea7Sdrh     return 0;
231920411ea7Sdrh   }
2320389a1adbSdrh 
2321389a1adbSdrh   if( pExpr==0 ){
2322389a1adbSdrh     op = TK_NULL;
2323389a1adbSdrh   }else{
2324f2bc013cSdrh     op = pExpr->op;
2325389a1adbSdrh   }
2326f2bc013cSdrh   switch( op ){
232713449892Sdrh     case TK_AGG_COLUMN: {
232813449892Sdrh       AggInfo *pAggInfo = pExpr->pAggInfo;
232913449892Sdrh       struct AggInfo_col *pCol = &pAggInfo->aCol[pExpr->iAgg];
233013449892Sdrh       if( !pAggInfo->directMode ){
23319de221dfSdrh         assert( pCol->iMem>0 );
23329de221dfSdrh         inReg = pCol->iMem;
233313449892Sdrh         break;
233413449892Sdrh       }else if( pAggInfo->useSortingIdx ){
23355134d135Sdan         sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdxPTab,
2336389a1adbSdrh                               pCol->iSorterColumn, target);
233713449892Sdrh         break;
233813449892Sdrh       }
233913449892Sdrh       /* Otherwise, fall thru into the TK_COLUMN case */
234013449892Sdrh     }
2341967e8b73Sdrh     case TK_COLUMN: {
2342ffe07b2dSdrh       if( pExpr->iTable<0 ){
2343ffe07b2dSdrh         /* This only happens when coding check constraints */
2344aa9b8963Sdrh         assert( pParse->ckBase>0 );
2345aa9b8963Sdrh         inReg = pExpr->iColumn + pParse->ckBase;
2346c4a3c779Sdrh       }else{
2347e55cbd72Sdrh         inReg = sqlite3ExprCodeGetColumn(pParse, pExpr->pTab,
2348a748fdccSdrh                                  pExpr->iColumn, pExpr->iTable, target,
2349a748fdccSdrh                                  pExpr->op2);
23502282792aSdrh       }
2351cce7d176Sdrh       break;
2352cce7d176Sdrh     }
2353cce7d176Sdrh     case TK_INTEGER: {
235413573c71Sdrh       codeInteger(pParse, pExpr, 0, target);
2355fec19aadSdrh       break;
235651e9a445Sdrh     }
235713573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
2358598f1340Sdrh     case TK_FLOAT: {
235933e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
236033e619fcSdrh       codeReal(v, pExpr->u.zToken, 0, target);
2361598f1340Sdrh       break;
2362598f1340Sdrh     }
236313573c71Sdrh #endif
2364fec19aadSdrh     case TK_STRING: {
236533e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
236633e619fcSdrh       sqlite3VdbeAddOp4(v, OP_String8, 0, target, 0, pExpr->u.zToken, 0);
2367cce7d176Sdrh       break;
2368cce7d176Sdrh     }
2369f0863fe5Sdrh     case TK_NULL: {
23709de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
2371f0863fe5Sdrh       break;
2372f0863fe5Sdrh     }
23735338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_BLOB_LITERAL
2374c572ef7fSdanielk1977     case TK_BLOB: {
23756c8c6cecSdrh       int n;
23766c8c6cecSdrh       const char *z;
2377ca48c90fSdrh       char *zBlob;
237833e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
237933e619fcSdrh       assert( pExpr->u.zToken[0]=='x' || pExpr->u.zToken[0]=='X' );
238033e619fcSdrh       assert( pExpr->u.zToken[1]=='\'' );
238133e619fcSdrh       z = &pExpr->u.zToken[2];
2382b7916a78Sdrh       n = sqlite3Strlen30(z) - 1;
2383b7916a78Sdrh       assert( z[n]=='\'' );
2384ca48c90fSdrh       zBlob = sqlite3HexToBlob(sqlite3VdbeDb(v), z, n);
2385ca48c90fSdrh       sqlite3VdbeAddOp4(v, OP_Blob, n/2, target, 0, zBlob, P4_DYNAMIC);
2386c572ef7fSdanielk1977       break;
2387c572ef7fSdanielk1977     }
23885338a5f7Sdanielk1977 #endif
238950457896Sdrh     case TK_VARIABLE: {
239033e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
239133e619fcSdrh       assert( pExpr->u.zToken!=0 );
239233e619fcSdrh       assert( pExpr->u.zToken[0]!=0 );
2393eaf52d88Sdrh       sqlite3VdbeAddOp2(v, OP_Variable, pExpr->iColumn, target);
239433e619fcSdrh       if( pExpr->u.zToken[1]!=0 ){
239504e9eeadSdrh         assert( pExpr->u.zToken[0]=='?'
239604e9eeadSdrh              || strcmp(pExpr->u.zToken, pParse->azVar[pExpr->iColumn-1])==0 );
239704e9eeadSdrh         sqlite3VdbeChangeP4(v, -1, pParse->azVar[pExpr->iColumn-1], P4_STATIC);
2398895d7472Sdrh       }
239950457896Sdrh       break;
240050457896Sdrh     }
24014e0cff60Sdrh     case TK_REGISTER: {
24029de221dfSdrh       inReg = pExpr->iTable;
24034e0cff60Sdrh       break;
24044e0cff60Sdrh     }
24058b213899Sdrh     case TK_AS: {
24067445ffe2Sdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
24078b213899Sdrh       break;
24088b213899Sdrh     }
2409487e262fSdrh #ifndef SQLITE_OMIT_CAST
2410487e262fSdrh     case TK_CAST: {
2411487e262fSdrh       /* Expressions of the form:   CAST(pLeft AS token) */
2412f0113000Sdanielk1977       int aff, to_op;
24132dcef11bSdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
241433e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
241533e619fcSdrh       aff = sqlite3AffinityType(pExpr->u.zToken);
2416f0113000Sdanielk1977       to_op = aff - SQLITE_AFF_TEXT + OP_ToText;
2417f0113000Sdanielk1977       assert( to_op==OP_ToText    || aff!=SQLITE_AFF_TEXT    );
2418f0113000Sdanielk1977       assert( to_op==OP_ToBlob    || aff!=SQLITE_AFF_NONE    );
2419f0113000Sdanielk1977       assert( to_op==OP_ToNumeric || aff!=SQLITE_AFF_NUMERIC );
2420f0113000Sdanielk1977       assert( to_op==OP_ToInt     || aff!=SQLITE_AFF_INTEGER );
2421f0113000Sdanielk1977       assert( to_op==OP_ToReal    || aff!=SQLITE_AFF_REAL    );
2422c5499befSdrh       testcase( to_op==OP_ToText );
2423c5499befSdrh       testcase( to_op==OP_ToBlob );
2424c5499befSdrh       testcase( to_op==OP_ToNumeric );
2425c5499befSdrh       testcase( to_op==OP_ToInt );
2426c5499befSdrh       testcase( to_op==OP_ToReal );
24271735fa88Sdrh       if( inReg!=target ){
24281735fa88Sdrh         sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
24291735fa88Sdrh         inReg = target;
24301735fa88Sdrh       }
24312dcef11bSdrh       sqlite3VdbeAddOp1(v, to_op, inReg);
2432c5499befSdrh       testcase( usedAsColumnCache(pParse, inReg, inReg) );
2433b3843a82Sdrh       sqlite3ExprCacheAffinityChange(pParse, inReg, 1);
2434487e262fSdrh       break;
2435487e262fSdrh     }
2436487e262fSdrh #endif /* SQLITE_OMIT_CAST */
2437c9b84a1fSdrh     case TK_LT:
2438c9b84a1fSdrh     case TK_LE:
2439c9b84a1fSdrh     case TK_GT:
2440c9b84a1fSdrh     case TK_GE:
2441c9b84a1fSdrh     case TK_NE:
2442c9b84a1fSdrh     case TK_EQ: {
2443f2bc013cSdrh       assert( TK_LT==OP_Lt );
2444f2bc013cSdrh       assert( TK_LE==OP_Le );
2445f2bc013cSdrh       assert( TK_GT==OP_Gt );
2446f2bc013cSdrh       assert( TK_GE==OP_Ge );
2447f2bc013cSdrh       assert( TK_EQ==OP_Eq );
2448f2bc013cSdrh       assert( TK_NE==OP_Ne );
2449c5499befSdrh       testcase( op==TK_LT );
2450c5499befSdrh       testcase( op==TK_LE );
2451c5499befSdrh       testcase( op==TK_GT );
2452c5499befSdrh       testcase( op==TK_GE );
2453c5499befSdrh       testcase( op==TK_EQ );
2454c5499befSdrh       testcase( op==TK_NE );
2455b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
2456b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
245735573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
245835573356Sdrh                   r1, r2, inReg, SQLITE_STOREP2);
2459c5499befSdrh       testcase( regFree1==0 );
2460c5499befSdrh       testcase( regFree2==0 );
2461a37cdde0Sdanielk1977       break;
2462c9b84a1fSdrh     }
24636a2fe093Sdrh     case TK_IS:
24646a2fe093Sdrh     case TK_ISNOT: {
24656a2fe093Sdrh       testcase( op==TK_IS );
24666a2fe093Sdrh       testcase( op==TK_ISNOT );
2467b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
2468b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
24696a2fe093Sdrh       op = (op==TK_IS) ? TK_EQ : TK_NE;
24706a2fe093Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
24716a2fe093Sdrh                   r1, r2, inReg, SQLITE_STOREP2 | SQLITE_NULLEQ);
24726a2fe093Sdrh       testcase( regFree1==0 );
24736a2fe093Sdrh       testcase( regFree2==0 );
24746a2fe093Sdrh       break;
24756a2fe093Sdrh     }
2476cce7d176Sdrh     case TK_AND:
2477cce7d176Sdrh     case TK_OR:
2478cce7d176Sdrh     case TK_PLUS:
2479cce7d176Sdrh     case TK_STAR:
2480cce7d176Sdrh     case TK_MINUS:
2481bf4133cbSdrh     case TK_REM:
2482bf4133cbSdrh     case TK_BITAND:
2483bf4133cbSdrh     case TK_BITOR:
248417c40294Sdrh     case TK_SLASH:
2485bf4133cbSdrh     case TK_LSHIFT:
2486855eb1cfSdrh     case TK_RSHIFT:
24870040077dSdrh     case TK_CONCAT: {
2488f2bc013cSdrh       assert( TK_AND==OP_And );
2489f2bc013cSdrh       assert( TK_OR==OP_Or );
2490f2bc013cSdrh       assert( TK_PLUS==OP_Add );
2491f2bc013cSdrh       assert( TK_MINUS==OP_Subtract );
2492f2bc013cSdrh       assert( TK_REM==OP_Remainder );
2493f2bc013cSdrh       assert( TK_BITAND==OP_BitAnd );
2494f2bc013cSdrh       assert( TK_BITOR==OP_BitOr );
2495f2bc013cSdrh       assert( TK_SLASH==OP_Divide );
2496f2bc013cSdrh       assert( TK_LSHIFT==OP_ShiftLeft );
2497f2bc013cSdrh       assert( TK_RSHIFT==OP_ShiftRight );
2498f2bc013cSdrh       assert( TK_CONCAT==OP_Concat );
2499c5499befSdrh       testcase( op==TK_AND );
2500c5499befSdrh       testcase( op==TK_OR );
2501c5499befSdrh       testcase( op==TK_PLUS );
2502c5499befSdrh       testcase( op==TK_MINUS );
2503c5499befSdrh       testcase( op==TK_REM );
2504c5499befSdrh       testcase( op==TK_BITAND );
2505c5499befSdrh       testcase( op==TK_BITOR );
2506c5499befSdrh       testcase( op==TK_SLASH );
2507c5499befSdrh       testcase( op==TK_LSHIFT );
2508c5499befSdrh       testcase( op==TK_RSHIFT );
2509c5499befSdrh       testcase( op==TK_CONCAT );
25102dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
25112dcef11bSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
25125b6afba9Sdrh       sqlite3VdbeAddOp3(v, op, r2, r1, target);
2513c5499befSdrh       testcase( regFree1==0 );
2514c5499befSdrh       testcase( regFree2==0 );
25150040077dSdrh       break;
25160040077dSdrh     }
2517cce7d176Sdrh     case TK_UMINUS: {
2518fec19aadSdrh       Expr *pLeft = pExpr->pLeft;
2519fec19aadSdrh       assert( pLeft );
252013573c71Sdrh       if( pLeft->op==TK_INTEGER ){
252113573c71Sdrh         codeInteger(pParse, pLeft, 1, target);
252213573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
252313573c71Sdrh       }else if( pLeft->op==TK_FLOAT ){
252433e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
252533e619fcSdrh         codeReal(v, pLeft->u.zToken, 1, target);
252613573c71Sdrh #endif
25273c84ddffSdrh       }else{
25282dcef11bSdrh         regFree1 = r1 = sqlite3GetTempReg(pParse);
25293c84ddffSdrh         sqlite3VdbeAddOp2(v, OP_Integer, 0, r1);
2530e55cbd72Sdrh         r2 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree2);
25312dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_Subtract, r2, r1, target);
2532c5499befSdrh         testcase( regFree2==0 );
25333c84ddffSdrh       }
25349de221dfSdrh       inReg = target;
25356e142f54Sdrh       break;
25366e142f54Sdrh     }
2537bf4133cbSdrh     case TK_BITNOT:
25386e142f54Sdrh     case TK_NOT: {
2539f2bc013cSdrh       assert( TK_BITNOT==OP_BitNot );
2540f2bc013cSdrh       assert( TK_NOT==OP_Not );
2541c5499befSdrh       testcase( op==TK_BITNOT );
2542c5499befSdrh       testcase( op==TK_NOT );
2543e99fa2afSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
2544e99fa2afSdrh       testcase( regFree1==0 );
2545e99fa2afSdrh       inReg = target;
2546e99fa2afSdrh       sqlite3VdbeAddOp2(v, op, r1, inReg);
2547cce7d176Sdrh       break;
2548cce7d176Sdrh     }
2549cce7d176Sdrh     case TK_ISNULL:
2550cce7d176Sdrh     case TK_NOTNULL: {
25516a288a33Sdrh       int addr;
2552f2bc013cSdrh       assert( TK_ISNULL==OP_IsNull );
2553f2bc013cSdrh       assert( TK_NOTNULL==OP_NotNull );
2554c5499befSdrh       testcase( op==TK_ISNULL );
2555c5499befSdrh       testcase( op==TK_NOTNULL );
25569de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
25572dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
2558c5499befSdrh       testcase( regFree1==0 );
25592dcef11bSdrh       addr = sqlite3VdbeAddOp1(v, op, r1);
25609de221dfSdrh       sqlite3VdbeAddOp2(v, OP_AddImm, target, -1);
25616a288a33Sdrh       sqlite3VdbeJumpHere(v, addr);
2562a37cdde0Sdanielk1977       break;
2563f2bc013cSdrh     }
25642282792aSdrh     case TK_AGG_FUNCTION: {
256513449892Sdrh       AggInfo *pInfo = pExpr->pAggInfo;
25667e56e711Sdrh       if( pInfo==0 ){
256733e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
256833e619fcSdrh         sqlite3ErrorMsg(pParse, "misuse of aggregate: %s()", pExpr->u.zToken);
25697e56e711Sdrh       }else{
25709de221dfSdrh         inReg = pInfo->aFunc[pExpr->iAgg].iMem;
25717e56e711Sdrh       }
25722282792aSdrh       break;
25732282792aSdrh     }
2574b71090fdSdrh     case TK_CONST_FUNC:
2575cce7d176Sdrh     case TK_FUNCTION: {
257612ffee8cSdrh       ExprList *pFarg;       /* List of function arguments */
257712ffee8cSdrh       int nFarg;             /* Number of function arguments */
257812ffee8cSdrh       FuncDef *pDef;         /* The function definition object */
257912ffee8cSdrh       int nId;               /* Length of the function name in bytes */
258012ffee8cSdrh       const char *zId;       /* The function name */
258112ffee8cSdrh       int constMask = 0;     /* Mask of function arguments that are constant */
258212ffee8cSdrh       int i;                 /* Loop counter */
258312ffee8cSdrh       u8 enc = ENC(db);      /* The text encoding used by this database */
258412ffee8cSdrh       CollSeq *pColl = 0;    /* A collating sequence */
258517435752Sdrh 
25866ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
2587c5499befSdrh       testcase( op==TK_CONST_FUNC );
2588c5499befSdrh       testcase( op==TK_FUNCTION );
2589b7916a78Sdrh       if( ExprHasAnyProperty(pExpr, EP_TokenOnly) ){
259012ffee8cSdrh         pFarg = 0;
259112ffee8cSdrh       }else{
259212ffee8cSdrh         pFarg = pExpr->x.pList;
259312ffee8cSdrh       }
259412ffee8cSdrh       nFarg = pFarg ? pFarg->nExpr : 0;
259533e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
259633e619fcSdrh       zId = pExpr->u.zToken;
2597b7916a78Sdrh       nId = sqlite3Strlen30(zId);
259812ffee8cSdrh       pDef = sqlite3FindFunction(db, zId, nId, nFarg, enc, 0);
2599feb306f5Sdrh       if( pDef==0 ){
2600feb306f5Sdrh         sqlite3ErrorMsg(pParse, "unknown function: %.*s()", nId, zId);
2601feb306f5Sdrh         break;
2602feb306f5Sdrh       }
2603ae6bb957Sdrh 
2604ae6bb957Sdrh       /* Attempt a direct implementation of the built-in COALESCE() and
2605ae6bb957Sdrh       ** IFNULL() functions.  This avoids unnecessary evalation of
2606ae6bb957Sdrh       ** arguments past the first non-NULL argument.
2607ae6bb957Sdrh       */
2608ae6bb957Sdrh       if( pDef->flags & SQLITE_FUNC_COALESCE ){
2609ae6bb957Sdrh         int endCoalesce = sqlite3VdbeMakeLabel(v);
2610ae6bb957Sdrh         assert( nFarg>=2 );
2611ae6bb957Sdrh         sqlite3ExprCode(pParse, pFarg->a[0].pExpr, target);
2612ae6bb957Sdrh         for(i=1; i<nFarg; i++){
2613ae6bb957Sdrh           sqlite3VdbeAddOp2(v, OP_NotNull, target, endCoalesce);
2614f49f3523Sdrh           sqlite3ExprCacheRemove(pParse, target, 1);
2615ae6bb957Sdrh           sqlite3ExprCachePush(pParse);
2616ae6bb957Sdrh           sqlite3ExprCode(pParse, pFarg->a[i].pExpr, target);
2617ae6bb957Sdrh           sqlite3ExprCachePop(pParse, 1);
2618ae6bb957Sdrh         }
2619ae6bb957Sdrh         sqlite3VdbeResolveLabel(v, endCoalesce);
2620ae6bb957Sdrh         break;
2621ae6bb957Sdrh       }
2622ae6bb957Sdrh 
2623ae6bb957Sdrh 
262412ffee8cSdrh       if( pFarg ){
262512ffee8cSdrh         r1 = sqlite3GetTempRange(pParse, nFarg);
2626a748fdccSdrh 
2627a748fdccSdrh         /* For length() and typeof() functions with a column argument,
2628a748fdccSdrh         ** set the P5 parameter to the OP_Column opcode to OPFLAG_LENGTHARG
2629a748fdccSdrh         ** or OPFLAG_TYPEOFARG respectively, to avoid unnecessary data
2630a748fdccSdrh         ** loading.
2631a748fdccSdrh         */
2632a748fdccSdrh         if( (pDef->flags & (SQLITE_FUNC_LENGTH|SQLITE_FUNC_TYPEOF))!=0 ){
26334e245a4cSdrh           u8 exprOp;
2634a748fdccSdrh           assert( nFarg==1 );
2635a748fdccSdrh           assert( pFarg->a[0].pExpr!=0 );
26364e245a4cSdrh           exprOp = pFarg->a[0].pExpr->op;
26374e245a4cSdrh           if( exprOp==TK_COLUMN || exprOp==TK_AGG_COLUMN ){
2638a748fdccSdrh             assert( SQLITE_FUNC_LENGTH==OPFLAG_LENGTHARG );
2639a748fdccSdrh             assert( SQLITE_FUNC_TYPEOF==OPFLAG_TYPEOFARG );
2640a748fdccSdrh             testcase( pDef->flags==SQLITE_FUNC_LENGTH );
2641a748fdccSdrh             pFarg->a[0].pExpr->op2 = pDef->flags;
2642a748fdccSdrh           }
2643a748fdccSdrh         }
2644a748fdccSdrh 
2645d7d385ddSdrh         sqlite3ExprCachePush(pParse);     /* Ticket 2ea2425d34be */
264612ffee8cSdrh         sqlite3ExprCodeExprList(pParse, pFarg, r1, 1);
2647d7d385ddSdrh         sqlite3ExprCachePop(pParse, 1);   /* Ticket 2ea2425d34be */
2648892d3179Sdrh       }else{
264912ffee8cSdrh         r1 = 0;
2650892d3179Sdrh       }
2651b7f6f68fSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
2652a43fa227Sdrh       /* Possibly overload the function if the first argument is
2653a43fa227Sdrh       ** a virtual table column.
2654a43fa227Sdrh       **
2655a43fa227Sdrh       ** For infix functions (LIKE, GLOB, REGEXP, and MATCH) use the
2656a43fa227Sdrh       ** second argument, not the first, as the argument to test to
2657a43fa227Sdrh       ** see if it is a column in a virtual table.  This is done because
2658a43fa227Sdrh       ** the left operand of infix functions (the operand we want to
2659a43fa227Sdrh       ** control overloading) ends up as the second argument to the
2660a43fa227Sdrh       ** function.  The expression "A glob B" is equivalent to
2661a43fa227Sdrh       ** "glob(B,A).  We want to use the A in "A glob B" to test
2662a43fa227Sdrh       ** for function overloading.  But we use the B term in "glob(B,A)".
2663a43fa227Sdrh       */
266412ffee8cSdrh       if( nFarg>=2 && (pExpr->flags & EP_InfixFunc) ){
266512ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[1].pExpr);
266612ffee8cSdrh       }else if( nFarg>0 ){
266712ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[0].pExpr);
2668b7f6f68fSdrh       }
2669b7f6f68fSdrh #endif
2670f7bca574Sdrh       for(i=0; i<nFarg; i++){
2671f7bca574Sdrh         if( i<32 && sqlite3ExprIsConstant(pFarg->a[i].pExpr) ){
267213449892Sdrh           constMask |= (1<<i);
2673d02eb1fdSdanielk1977         }
2674e82f5d04Sdrh         if( (pDef->flags & SQLITE_FUNC_NEEDCOLL)!=0 && !pColl ){
267512ffee8cSdrh           pColl = sqlite3ExprCollSeq(pParse, pFarg->a[i].pExpr);
2676dc1bdc4fSdanielk1977         }
2677dc1bdc4fSdanielk1977       }
2678e82f5d04Sdrh       if( pDef->flags & SQLITE_FUNC_NEEDCOLL ){
26798b213899Sdrh         if( !pColl ) pColl = db->pDfltColl;
268066a5167bSdrh         sqlite3VdbeAddOp4(v, OP_CollSeq, 0, 0, 0, (char *)pColl, P4_COLLSEQ);
2681682f68b0Sdanielk1977       }
26822dcef11bSdrh       sqlite3VdbeAddOp4(v, OP_Function, constMask, r1, target,
268366a5167bSdrh                         (char*)pDef, P4_FUNCDEF);
268412ffee8cSdrh       sqlite3VdbeChangeP5(v, (u8)nFarg);
268512ffee8cSdrh       if( nFarg ){
268612ffee8cSdrh         sqlite3ReleaseTempRange(pParse, r1, nFarg);
26872dcef11bSdrh       }
26886ec2733bSdrh       break;
26896ec2733bSdrh     }
2690fe2093d7Sdrh #ifndef SQLITE_OMIT_SUBQUERY
2691fe2093d7Sdrh     case TK_EXISTS:
269219a775c2Sdrh     case TK_SELECT: {
2693c5499befSdrh       testcase( op==TK_EXISTS );
2694c5499befSdrh       testcase( op==TK_SELECT );
26951450bc6eSdrh       inReg = sqlite3CodeSubselect(pParse, pExpr, 0, 0);
269619a775c2Sdrh       break;
269719a775c2Sdrh     }
2698fef5208cSdrh     case TK_IN: {
2699e3365e6cSdrh       int destIfFalse = sqlite3VdbeMakeLabel(v);
2700e3365e6cSdrh       int destIfNull = sqlite3VdbeMakeLabel(v);
2701e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
2702e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
270366ba23ceSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
2704e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
2705e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_AddImm, target, 0);
2706e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfNull);
2707fef5208cSdrh       break;
2708fef5208cSdrh     }
2709e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
2710e3365e6cSdrh 
2711e3365e6cSdrh 
27122dcef11bSdrh     /*
27132dcef11bSdrh     **    x BETWEEN y AND z
27142dcef11bSdrh     **
27152dcef11bSdrh     ** This is equivalent to
27162dcef11bSdrh     **
27172dcef11bSdrh     **    x>=y AND x<=z
27182dcef11bSdrh     **
27192dcef11bSdrh     ** X is stored in pExpr->pLeft.
27202dcef11bSdrh     ** Y is stored in pExpr->pList->a[0].pExpr.
27212dcef11bSdrh     ** Z is stored in pExpr->pList->a[1].pExpr.
27222dcef11bSdrh     */
2723fef5208cSdrh     case TK_BETWEEN: {
2724be5c89acSdrh       Expr *pLeft = pExpr->pLeft;
27256ab3a2ecSdanielk1977       struct ExprList_item *pLItem = pExpr->x.pList->a;
2726be5c89acSdrh       Expr *pRight = pLItem->pExpr;
272735573356Sdrh 
2728b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pLeft, &regFree1);
2729b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pRight, &regFree2);
2730c5499befSdrh       testcase( regFree1==0 );
2731c5499befSdrh       testcase( regFree2==0 );
27322dcef11bSdrh       r3 = sqlite3GetTempReg(pParse);
2733678ccce8Sdrh       r4 = sqlite3GetTempReg(pParse);
273435573356Sdrh       codeCompare(pParse, pLeft, pRight, OP_Ge,
273535573356Sdrh                   r1, r2, r3, SQLITE_STOREP2);
2736be5c89acSdrh       pLItem++;
2737be5c89acSdrh       pRight = pLItem->pExpr;
27382dcef11bSdrh       sqlite3ReleaseTempReg(pParse, regFree2);
27392dcef11bSdrh       r2 = sqlite3ExprCodeTemp(pParse, pRight, &regFree2);
2740c5499befSdrh       testcase( regFree2==0 );
2741678ccce8Sdrh       codeCompare(pParse, pLeft, pRight, OP_Le, r1, r2, r4, SQLITE_STOREP2);
2742678ccce8Sdrh       sqlite3VdbeAddOp3(v, OP_And, r3, r4, target);
27432dcef11bSdrh       sqlite3ReleaseTempReg(pParse, r3);
2744678ccce8Sdrh       sqlite3ReleaseTempReg(pParse, r4);
2745fef5208cSdrh       break;
2746fef5208cSdrh     }
2747*ae80ddeaSdrh     case TK_COLLATE:
27484f07e5fbSdrh     case TK_UPLUS: {
27492dcef11bSdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
2750a2e00042Sdrh       break;
2751a2e00042Sdrh     }
27522dcef11bSdrh 
2753165921a7Sdan     case TK_TRIGGER: {
275465a7cd16Sdan       /* If the opcode is TK_TRIGGER, then the expression is a reference
275565a7cd16Sdan       ** to a column in the new.* or old.* pseudo-tables available to
275665a7cd16Sdan       ** trigger programs. In this case Expr.iTable is set to 1 for the
275765a7cd16Sdan       ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
275865a7cd16Sdan       ** is set to the column of the pseudo-table to read, or to -1 to
275965a7cd16Sdan       ** read the rowid field.
276065a7cd16Sdan       **
276165a7cd16Sdan       ** The expression is implemented using an OP_Param opcode. The p1
276265a7cd16Sdan       ** parameter is set to 0 for an old.rowid reference, or to (i+1)
276365a7cd16Sdan       ** to reference another column of the old.* pseudo-table, where
276465a7cd16Sdan       ** i is the index of the column. For a new.rowid reference, p1 is
276565a7cd16Sdan       ** set to (n+1), where n is the number of columns in each pseudo-table.
276665a7cd16Sdan       ** For a reference to any other column in the new.* pseudo-table, p1
276765a7cd16Sdan       ** is set to (n+2+i), where n and i are as defined previously. For
276865a7cd16Sdan       ** example, if the table on which triggers are being fired is
276965a7cd16Sdan       ** declared as:
277065a7cd16Sdan       **
277165a7cd16Sdan       **   CREATE TABLE t1(a, b);
277265a7cd16Sdan       **
277365a7cd16Sdan       ** Then p1 is interpreted as follows:
277465a7cd16Sdan       **
277565a7cd16Sdan       **   p1==0   ->    old.rowid     p1==3   ->    new.rowid
277665a7cd16Sdan       **   p1==1   ->    old.a         p1==4   ->    new.a
277765a7cd16Sdan       **   p1==2   ->    old.b         p1==5   ->    new.b
277865a7cd16Sdan       */
27792832ad42Sdan       Table *pTab = pExpr->pTab;
278065a7cd16Sdan       int p1 = pExpr->iTable * (pTab->nCol+1) + 1 + pExpr->iColumn;
278165a7cd16Sdan 
278265a7cd16Sdan       assert( pExpr->iTable==0 || pExpr->iTable==1 );
278365a7cd16Sdan       assert( pExpr->iColumn>=-1 && pExpr->iColumn<pTab->nCol );
278465a7cd16Sdan       assert( pTab->iPKey<0 || pExpr->iColumn!=pTab->iPKey );
278565a7cd16Sdan       assert( p1>=0 && p1<(pTab->nCol*2+2) );
278665a7cd16Sdan 
278765a7cd16Sdan       sqlite3VdbeAddOp2(v, OP_Param, p1, target);
278876d462eeSdan       VdbeComment((v, "%s.%s -> $%d",
2789165921a7Sdan         (pExpr->iTable ? "new" : "old"),
279076d462eeSdan         (pExpr->iColumn<0 ? "rowid" : pExpr->pTab->aCol[pExpr->iColumn].zName),
279176d462eeSdan         target
2792165921a7Sdan       ));
279365a7cd16Sdan 
279444dbca83Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
279565a7cd16Sdan       /* If the column has REAL affinity, it may currently be stored as an
279665a7cd16Sdan       ** integer. Use OP_RealAffinity to make sure it is really real.  */
27972832ad42Sdan       if( pExpr->iColumn>=0
27982832ad42Sdan        && pTab->aCol[pExpr->iColumn].affinity==SQLITE_AFF_REAL
27992832ad42Sdan       ){
28002832ad42Sdan         sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
28012832ad42Sdan       }
280244dbca83Sdrh #endif
2803165921a7Sdan       break;
2804165921a7Sdan     }
2805165921a7Sdan 
2806165921a7Sdan 
28072dcef11bSdrh     /*
28082dcef11bSdrh     ** Form A:
28092dcef11bSdrh     **   CASE x WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
28102dcef11bSdrh     **
28112dcef11bSdrh     ** Form B:
28122dcef11bSdrh     **   CASE WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
28132dcef11bSdrh     **
28142dcef11bSdrh     ** Form A is can be transformed into the equivalent form B as follows:
28152dcef11bSdrh     **   CASE WHEN x=e1 THEN r1 WHEN x=e2 THEN r2 ...
28162dcef11bSdrh     **        WHEN x=eN THEN rN ELSE y END
28172dcef11bSdrh     **
28182dcef11bSdrh     ** X (if it exists) is in pExpr->pLeft.
28192dcef11bSdrh     ** Y is in pExpr->pRight.  The Y is also optional.  If there is no
28202dcef11bSdrh     ** ELSE clause and no other term matches, then the result of the
28212dcef11bSdrh     ** exprssion is NULL.
28222dcef11bSdrh     ** Ei is in pExpr->pList->a[i*2] and Ri is pExpr->pList->a[i*2+1].
28232dcef11bSdrh     **
28242dcef11bSdrh     ** The result of the expression is the Ri for the first matching Ei,
28252dcef11bSdrh     ** or if there is no matching Ei, the ELSE term Y, or if there is
28262dcef11bSdrh     ** no ELSE term, NULL.
28272dcef11bSdrh     */
282833cd4909Sdrh     default: assert( op==TK_CASE ); {
28292dcef11bSdrh       int endLabel;                     /* GOTO label for end of CASE stmt */
28302dcef11bSdrh       int nextCase;                     /* GOTO label for next WHEN clause */
28312dcef11bSdrh       int nExpr;                        /* 2x number of WHEN terms */
28322dcef11bSdrh       int i;                            /* Loop counter */
28332dcef11bSdrh       ExprList *pEList;                 /* List of WHEN terms */
28342dcef11bSdrh       struct ExprList_item *aListelem;  /* Array of WHEN terms */
28352dcef11bSdrh       Expr opCompare;                   /* The X==Ei expression */
28362dcef11bSdrh       Expr cacheX;                      /* Cached expression X */
28372dcef11bSdrh       Expr *pX;                         /* The X expression */
28381bd10f8aSdrh       Expr *pTest = 0;                  /* X==Ei (form A) or just Ei (form B) */
2839ceea3321Sdrh       VVA_ONLY( int iCacheLevel = pParse->iCacheLevel; )
284017a7f8ddSdrh 
28416ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) && pExpr->x.pList );
28426ab3a2ecSdanielk1977       assert((pExpr->x.pList->nExpr % 2) == 0);
28436ab3a2ecSdanielk1977       assert(pExpr->x.pList->nExpr > 0);
28446ab3a2ecSdanielk1977       pEList = pExpr->x.pList;
2845be5c89acSdrh       aListelem = pEList->a;
2846be5c89acSdrh       nExpr = pEList->nExpr;
28472dcef11bSdrh       endLabel = sqlite3VdbeMakeLabel(v);
28482dcef11bSdrh       if( (pX = pExpr->pLeft)!=0 ){
28492dcef11bSdrh         cacheX = *pX;
285033cd4909Sdrh         testcase( pX->op==TK_COLUMN );
285133cd4909Sdrh         testcase( pX->op==TK_REGISTER );
28522dcef11bSdrh         cacheX.iTable = sqlite3ExprCodeTemp(pParse, pX, &regFree1);
2853c5499befSdrh         testcase( regFree1==0 );
28542dcef11bSdrh         cacheX.op = TK_REGISTER;
28552dcef11bSdrh         opCompare.op = TK_EQ;
28562dcef11bSdrh         opCompare.pLeft = &cacheX;
28572dcef11bSdrh         pTest = &opCompare;
28588b1db07fSdrh         /* Ticket b351d95f9cd5ef17e9d9dbae18f5ca8611190001:
28598b1db07fSdrh         ** The value in regFree1 might get SCopy-ed into the file result.
28608b1db07fSdrh         ** So make sure that the regFree1 register is not reused for other
28618b1db07fSdrh         ** purposes and possibly overwritten.  */
28628b1db07fSdrh         regFree1 = 0;
2863cce7d176Sdrh       }
2864f5905aa7Sdrh       for(i=0; i<nExpr; i=i+2){
2865ceea3321Sdrh         sqlite3ExprCachePush(pParse);
28662dcef11bSdrh         if( pX ){
28671bd10f8aSdrh           assert( pTest!=0 );
28682dcef11bSdrh           opCompare.pRight = aListelem[i].pExpr;
2869f5905aa7Sdrh         }else{
28702dcef11bSdrh           pTest = aListelem[i].pExpr;
287117a7f8ddSdrh         }
28722dcef11bSdrh         nextCase = sqlite3VdbeMakeLabel(v);
287333cd4909Sdrh         testcase( pTest->op==TK_COLUMN );
28742dcef11bSdrh         sqlite3ExprIfFalse(pParse, pTest, nextCase, SQLITE_JUMPIFNULL);
2875c5499befSdrh         testcase( aListelem[i+1].pExpr->op==TK_COLUMN );
2876c5499befSdrh         testcase( aListelem[i+1].pExpr->op==TK_REGISTER );
28779de221dfSdrh         sqlite3ExprCode(pParse, aListelem[i+1].pExpr, target);
28782dcef11bSdrh         sqlite3VdbeAddOp2(v, OP_Goto, 0, endLabel);
2879ceea3321Sdrh         sqlite3ExprCachePop(pParse, 1);
28802dcef11bSdrh         sqlite3VdbeResolveLabel(v, nextCase);
2881f570f011Sdrh       }
288217a7f8ddSdrh       if( pExpr->pRight ){
2883ceea3321Sdrh         sqlite3ExprCachePush(pParse);
28849de221dfSdrh         sqlite3ExprCode(pParse, pExpr->pRight, target);
2885ceea3321Sdrh         sqlite3ExprCachePop(pParse, 1);
288617a7f8ddSdrh       }else{
28879de221dfSdrh         sqlite3VdbeAddOp2(v, OP_Null, 0, target);
288817a7f8ddSdrh       }
2889c1f4a19bSdanielk1977       assert( db->mallocFailed || pParse->nErr>0
2890c1f4a19bSdanielk1977            || pParse->iCacheLevel==iCacheLevel );
28912dcef11bSdrh       sqlite3VdbeResolveLabel(v, endLabel);
28926f34903eSdanielk1977       break;
28936f34903eSdanielk1977     }
28945338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_TRIGGER
28956f34903eSdanielk1977     case TK_RAISE: {
2896165921a7Sdan       assert( pExpr->affinity==OE_Rollback
2897165921a7Sdan            || pExpr->affinity==OE_Abort
2898165921a7Sdan            || pExpr->affinity==OE_Fail
2899165921a7Sdan            || pExpr->affinity==OE_Ignore
2900165921a7Sdan       );
2901e0af83acSdan       if( !pParse->pTriggerTab ){
2902e0af83acSdan         sqlite3ErrorMsg(pParse,
2903e0af83acSdan                        "RAISE() may only be used within a trigger-program");
2904e0af83acSdan         return 0;
2905e0af83acSdan       }
2906e0af83acSdan       if( pExpr->affinity==OE_Abort ){
2907e0af83acSdan         sqlite3MayAbort(pParse);
2908e0af83acSdan       }
290933e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
2910e0af83acSdan       if( pExpr->affinity==OE_Ignore ){
2911e0af83acSdan         sqlite3VdbeAddOp4(
2912e0af83acSdan             v, OP_Halt, SQLITE_OK, OE_Ignore, 0, pExpr->u.zToken,0);
2913e0af83acSdan       }else{
2914e0af83acSdan         sqlite3HaltConstraint(pParse, pExpr->affinity, pExpr->u.zToken, 0);
2915e0af83acSdan       }
2916e0af83acSdan 
2917ffe07b2dSdrh       break;
291817a7f8ddSdrh     }
29195338a5f7Sdanielk1977 #endif
2920ffe07b2dSdrh   }
29212dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
29222dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
29232dcef11bSdrh   return inReg;
29245b6afba9Sdrh }
29252dcef11bSdrh 
29262dcef11bSdrh /*
29272dcef11bSdrh ** Generate code to evaluate an expression and store the results
29282dcef11bSdrh ** into a register.  Return the register number where the results
29292dcef11bSdrh ** are stored.
29302dcef11bSdrh **
29312dcef11bSdrh ** If the register is a temporary register that can be deallocated,
2932678ccce8Sdrh ** then write its number into *pReg.  If the result register is not
29332dcef11bSdrh ** a temporary, then set *pReg to zero.
29342dcef11bSdrh */
29352dcef11bSdrh int sqlite3ExprCodeTemp(Parse *pParse, Expr *pExpr, int *pReg){
29362dcef11bSdrh   int r1 = sqlite3GetTempReg(pParse);
29372dcef11bSdrh   int r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
29382dcef11bSdrh   if( r2==r1 ){
29392dcef11bSdrh     *pReg = r1;
29402dcef11bSdrh   }else{
29412dcef11bSdrh     sqlite3ReleaseTempReg(pParse, r1);
29422dcef11bSdrh     *pReg = 0;
29432dcef11bSdrh   }
29442dcef11bSdrh   return r2;
29452dcef11bSdrh }
29462dcef11bSdrh 
29472dcef11bSdrh /*
29482dcef11bSdrh ** Generate code that will evaluate expression pExpr and store the
29492dcef11bSdrh ** results in register target.  The results are guaranteed to appear
29502dcef11bSdrh ** in register target.
29512dcef11bSdrh */
29522dcef11bSdrh int sqlite3ExprCode(Parse *pParse, Expr *pExpr, int target){
29539cbf3425Sdrh   int inReg;
29549cbf3425Sdrh 
29559cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
2956ebc16717Sdrh   if( pExpr && pExpr->op==TK_REGISTER ){
2957ebc16717Sdrh     sqlite3VdbeAddOp2(pParse->pVdbe, OP_Copy, pExpr->iTable, target);
2958ebc16717Sdrh   }else{
29599cbf3425Sdrh     inReg = sqlite3ExprCodeTarget(pParse, pExpr, target);
29600e359b30Sdrh     assert( pParse->pVdbe || pParse->db->mallocFailed );
29610e359b30Sdrh     if( inReg!=target && pParse->pVdbe ){
29629cbf3425Sdrh       sqlite3VdbeAddOp2(pParse->pVdbe, OP_SCopy, inReg, target);
296317a7f8ddSdrh     }
2964ebc16717Sdrh   }
2965389a1adbSdrh   return target;
2966cce7d176Sdrh }
2967cce7d176Sdrh 
2968cce7d176Sdrh /*
29692dcef11bSdrh ** Generate code that evalutes the given expression and puts the result
2970de4fcfddSdrh ** in register target.
297125303780Sdrh **
29722dcef11bSdrh ** Also make a copy of the expression results into another "cache" register
29732dcef11bSdrh ** and modify the expression so that the next time it is evaluated,
29742dcef11bSdrh ** the result is a copy of the cache register.
29752dcef11bSdrh **
29762dcef11bSdrh ** This routine is used for expressions that are used multiple
29772dcef11bSdrh ** times.  They are evaluated once and the results of the expression
29782dcef11bSdrh ** are reused.
297925303780Sdrh */
29802dcef11bSdrh int sqlite3ExprCodeAndCache(Parse *pParse, Expr *pExpr, int target){
298125303780Sdrh   Vdbe *v = pParse->pVdbe;
29822dcef11bSdrh   int inReg;
29832dcef11bSdrh   inReg = sqlite3ExprCode(pParse, pExpr, target);
2984de4fcfddSdrh   assert( target>0 );
298520bc393cSdrh   /* This routine is called for terms to INSERT or UPDATE.  And the only
298620bc393cSdrh   ** other place where expressions can be converted into TK_REGISTER is
298720bc393cSdrh   ** in WHERE clause processing.  So as currently implemented, there is
298820bc393cSdrh   ** no way for a TK_REGISTER to exist here.  But it seems prudent to
298920bc393cSdrh   ** keep the ALWAYS() in case the conditions above change with future
299020bc393cSdrh   ** modifications or enhancements. */
299120bc393cSdrh   if( ALWAYS(pExpr->op!=TK_REGISTER) ){
299225303780Sdrh     int iMem;
29932dcef11bSdrh     iMem = ++pParse->nMem;
29942dcef11bSdrh     sqlite3VdbeAddOp2(v, OP_Copy, inReg, iMem);
29952dcef11bSdrh     pExpr->iTable = iMem;
2996937d0deaSdan     pExpr->op2 = pExpr->op;
299725303780Sdrh     pExpr->op = TK_REGISTER;
299825303780Sdrh   }
29992dcef11bSdrh   return inReg;
300025303780Sdrh }
30012dcef11bSdrh 
3002678a9aa7Sdrh #if defined(SQLITE_ENABLE_TREE_EXPLAIN)
30037e02e5e6Sdrh /*
30047e02e5e6Sdrh ** Generate a human-readable explanation of an expression tree.
30057e02e5e6Sdrh */
3006a84203a0Sdrh void sqlite3ExplainExpr(Vdbe *pOut, Expr *pExpr){
3007a84203a0Sdrh   int op;                   /* The opcode being coded */
3008a84203a0Sdrh   const char *zBinOp = 0;   /* Binary operator */
3009a84203a0Sdrh   const char *zUniOp = 0;   /* Unary operator */
3010a84203a0Sdrh   if( pExpr==0 ){
3011a84203a0Sdrh     op = TK_NULL;
30127e02e5e6Sdrh   }else{
3013a84203a0Sdrh     op = pExpr->op;
30147e02e5e6Sdrh   }
3015a84203a0Sdrh   switch( op ){
3016a84203a0Sdrh     case TK_AGG_COLUMN: {
301704b8342bSdrh       sqlite3ExplainPrintf(pOut, "AGG{%d:%d}",
301804b8342bSdrh             pExpr->iTable, pExpr->iColumn);
3019a84203a0Sdrh       break;
30207e02e5e6Sdrh     }
3021a84203a0Sdrh     case TK_COLUMN: {
3022a84203a0Sdrh       if( pExpr->iTable<0 ){
3023a84203a0Sdrh         /* This only happens when coding check constraints */
3024a84203a0Sdrh         sqlite3ExplainPrintf(pOut, "COLUMN(%d)", pExpr->iColumn);
3025a84203a0Sdrh       }else{
302604b8342bSdrh         sqlite3ExplainPrintf(pOut, "{%d:%d}",
302704b8342bSdrh                              pExpr->iTable, pExpr->iColumn);
3028a84203a0Sdrh       }
3029a84203a0Sdrh       break;
3030a84203a0Sdrh     }
3031a84203a0Sdrh     case TK_INTEGER: {
3032a84203a0Sdrh       if( pExpr->flags & EP_IntValue ){
303304b8342bSdrh         sqlite3ExplainPrintf(pOut, "%d", pExpr->u.iValue);
3034a84203a0Sdrh       }else{
303504b8342bSdrh         sqlite3ExplainPrintf(pOut, "%s", pExpr->u.zToken);
3036a84203a0Sdrh       }
3037a84203a0Sdrh       break;
3038a84203a0Sdrh     }
3039a84203a0Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
3040a84203a0Sdrh     case TK_FLOAT: {
304104b8342bSdrh       sqlite3ExplainPrintf(pOut,"%s", pExpr->u.zToken);
3042a84203a0Sdrh       break;
3043a84203a0Sdrh     }
3044a84203a0Sdrh #endif
3045a84203a0Sdrh     case TK_STRING: {
304604b8342bSdrh       sqlite3ExplainPrintf(pOut,"%Q", pExpr->u.zToken);
3047a84203a0Sdrh       break;
3048a84203a0Sdrh     }
3049a84203a0Sdrh     case TK_NULL: {
3050a84203a0Sdrh       sqlite3ExplainPrintf(pOut,"NULL");
3051a84203a0Sdrh       break;
3052a84203a0Sdrh     }
3053a84203a0Sdrh #ifndef SQLITE_OMIT_BLOB_LITERAL
3054a84203a0Sdrh     case TK_BLOB: {
305504b8342bSdrh       sqlite3ExplainPrintf(pOut,"%s", pExpr->u.zToken);
3056a84203a0Sdrh       break;
3057a84203a0Sdrh     }
3058a84203a0Sdrh #endif
3059a84203a0Sdrh     case TK_VARIABLE: {
3060a84203a0Sdrh       sqlite3ExplainPrintf(pOut,"VARIABLE(%s,%d)",
3061a84203a0Sdrh                            pExpr->u.zToken, pExpr->iColumn);
3062a84203a0Sdrh       break;
3063a84203a0Sdrh     }
3064a84203a0Sdrh     case TK_REGISTER: {
3065a84203a0Sdrh       sqlite3ExplainPrintf(pOut,"REGISTER(%d)", pExpr->iTable);
3066a84203a0Sdrh       break;
3067a84203a0Sdrh     }
3068a84203a0Sdrh     case TK_AS: {
3069a84203a0Sdrh       sqlite3ExplainExpr(pOut, pExpr->pLeft);
3070a84203a0Sdrh       break;
3071a84203a0Sdrh     }
3072a84203a0Sdrh #ifndef SQLITE_OMIT_CAST
3073a84203a0Sdrh     case TK_CAST: {
3074a84203a0Sdrh       /* Expressions of the form:   CAST(pLeft AS token) */
3075a84203a0Sdrh       const char *zAff = "unk";
3076a84203a0Sdrh       switch( sqlite3AffinityType(pExpr->u.zToken) ){
3077a84203a0Sdrh         case SQLITE_AFF_TEXT:    zAff = "TEXT";     break;
3078a84203a0Sdrh         case SQLITE_AFF_NONE:    zAff = "NONE";     break;
3079a84203a0Sdrh         case SQLITE_AFF_NUMERIC: zAff = "NUMERIC";  break;
3080a84203a0Sdrh         case SQLITE_AFF_INTEGER: zAff = "INTEGER";  break;
3081a84203a0Sdrh         case SQLITE_AFF_REAL:    zAff = "REAL";     break;
3082a84203a0Sdrh       }
3083a84203a0Sdrh       sqlite3ExplainPrintf(pOut, "CAST-%s(", zAff);
3084a84203a0Sdrh       sqlite3ExplainExpr(pOut, pExpr->pLeft);
3085a84203a0Sdrh       sqlite3ExplainPrintf(pOut, ")");
3086a84203a0Sdrh       break;
3087a84203a0Sdrh     }
3088a84203a0Sdrh #endif /* SQLITE_OMIT_CAST */
3089a84203a0Sdrh     case TK_LT:      zBinOp = "LT";     break;
3090a84203a0Sdrh     case TK_LE:      zBinOp = "LE";     break;
3091a84203a0Sdrh     case TK_GT:      zBinOp = "GT";     break;
3092a84203a0Sdrh     case TK_GE:      zBinOp = "GE";     break;
3093a84203a0Sdrh     case TK_NE:      zBinOp = "NE";     break;
3094a84203a0Sdrh     case TK_EQ:      zBinOp = "EQ";     break;
3095a84203a0Sdrh     case TK_IS:      zBinOp = "IS";     break;
3096a84203a0Sdrh     case TK_ISNOT:   zBinOp = "ISNOT";  break;
3097a84203a0Sdrh     case TK_AND:     zBinOp = "AND";    break;
3098a84203a0Sdrh     case TK_OR:      zBinOp = "OR";     break;
3099a84203a0Sdrh     case TK_PLUS:    zBinOp = "ADD";    break;
3100a84203a0Sdrh     case TK_STAR:    zBinOp = "MUL";    break;
3101a84203a0Sdrh     case TK_MINUS:   zBinOp = "SUB";    break;
3102a84203a0Sdrh     case TK_REM:     zBinOp = "REM";    break;
3103a84203a0Sdrh     case TK_BITAND:  zBinOp = "BITAND"; break;
3104a84203a0Sdrh     case TK_BITOR:   zBinOp = "BITOR";  break;
3105a84203a0Sdrh     case TK_SLASH:   zBinOp = "DIV";    break;
3106a84203a0Sdrh     case TK_LSHIFT:  zBinOp = "LSHIFT"; break;
3107a84203a0Sdrh     case TK_RSHIFT:  zBinOp = "RSHIFT"; break;
3108a84203a0Sdrh     case TK_CONCAT:  zBinOp = "CONCAT"; break;
3109a84203a0Sdrh 
3110a84203a0Sdrh     case TK_UMINUS:  zUniOp = "UMINUS"; break;
3111a84203a0Sdrh     case TK_UPLUS:   zUniOp = "UPLUS";  break;
3112a84203a0Sdrh     case TK_BITNOT:  zUniOp = "BITNOT"; break;
3113a84203a0Sdrh     case TK_NOT:     zUniOp = "NOT";    break;
3114a84203a0Sdrh     case TK_ISNULL:  zUniOp = "ISNULL"; break;
3115a84203a0Sdrh     case TK_NOTNULL: zUniOp = "NOTNULL"; break;
3116a84203a0Sdrh 
3117a84203a0Sdrh     case TK_AGG_FUNCTION:
3118a84203a0Sdrh     case TK_CONST_FUNC:
3119a84203a0Sdrh     case TK_FUNCTION: {
3120a84203a0Sdrh       ExprList *pFarg;       /* List of function arguments */
3121a84203a0Sdrh       if( ExprHasAnyProperty(pExpr, EP_TokenOnly) ){
3122a84203a0Sdrh         pFarg = 0;
3123a84203a0Sdrh       }else{
3124a84203a0Sdrh         pFarg = pExpr->x.pList;
3125a84203a0Sdrh       }
3126ed551b95Sdrh       if( op==TK_AGG_FUNCTION ){
3127ed551b95Sdrh         sqlite3ExplainPrintf(pOut, "AGG_FUNCTION%d:%s(",
3128ed551b95Sdrh                              pExpr->op2, pExpr->u.zToken);
3129ed551b95Sdrh       }else{
3130ed551b95Sdrh         sqlite3ExplainPrintf(pOut, "FUNCTION:%s(", pExpr->u.zToken);
3131ed551b95Sdrh       }
3132a84203a0Sdrh       if( pFarg ){
3133a84203a0Sdrh         sqlite3ExplainExprList(pOut, pFarg);
31347e02e5e6Sdrh       }
31357e02e5e6Sdrh       sqlite3ExplainPrintf(pOut, ")");
3136a84203a0Sdrh       break;
3137a84203a0Sdrh     }
3138a84203a0Sdrh #ifndef SQLITE_OMIT_SUBQUERY
3139a84203a0Sdrh     case TK_EXISTS: {
3140a84203a0Sdrh       sqlite3ExplainPrintf(pOut, "EXISTS(");
3141a84203a0Sdrh       sqlite3ExplainSelect(pOut, pExpr->x.pSelect);
3142a84203a0Sdrh       sqlite3ExplainPrintf(pOut,")");
3143a84203a0Sdrh       break;
3144a84203a0Sdrh     }
3145a84203a0Sdrh     case TK_SELECT: {
3146a84203a0Sdrh       sqlite3ExplainPrintf(pOut, "(");
3147a84203a0Sdrh       sqlite3ExplainSelect(pOut, pExpr->x.pSelect);
3148a84203a0Sdrh       sqlite3ExplainPrintf(pOut, ")");
3149a84203a0Sdrh       break;
3150a84203a0Sdrh     }
3151a84203a0Sdrh     case TK_IN: {
3152a84203a0Sdrh       sqlite3ExplainPrintf(pOut, "IN(");
3153a84203a0Sdrh       sqlite3ExplainExpr(pOut, pExpr->pLeft);
3154a84203a0Sdrh       sqlite3ExplainPrintf(pOut, ",");
3155a84203a0Sdrh       if( ExprHasProperty(pExpr, EP_xIsSelect) ){
3156a84203a0Sdrh         sqlite3ExplainSelect(pOut, pExpr->x.pSelect);
3157a84203a0Sdrh       }else{
3158a84203a0Sdrh         sqlite3ExplainExprList(pOut, pExpr->x.pList);
3159a84203a0Sdrh       }
3160a84203a0Sdrh       sqlite3ExplainPrintf(pOut, ")");
3161a84203a0Sdrh       break;
3162a84203a0Sdrh     }
3163a84203a0Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
3164a84203a0Sdrh 
3165a84203a0Sdrh     /*
3166a84203a0Sdrh     **    x BETWEEN y AND z
3167a84203a0Sdrh     **
3168a84203a0Sdrh     ** This is equivalent to
3169a84203a0Sdrh     **
3170a84203a0Sdrh     **    x>=y AND x<=z
3171a84203a0Sdrh     **
3172a84203a0Sdrh     ** X is stored in pExpr->pLeft.
3173a84203a0Sdrh     ** Y is stored in pExpr->pList->a[0].pExpr.
3174a84203a0Sdrh     ** Z is stored in pExpr->pList->a[1].pExpr.
3175a84203a0Sdrh     */
3176a84203a0Sdrh     case TK_BETWEEN: {
3177a84203a0Sdrh       Expr *pX = pExpr->pLeft;
3178a84203a0Sdrh       Expr *pY = pExpr->x.pList->a[0].pExpr;
3179a84203a0Sdrh       Expr *pZ = pExpr->x.pList->a[1].pExpr;
3180a84203a0Sdrh       sqlite3ExplainPrintf(pOut, "BETWEEN(");
3181a84203a0Sdrh       sqlite3ExplainExpr(pOut, pX);
3182a84203a0Sdrh       sqlite3ExplainPrintf(pOut, ",");
3183a84203a0Sdrh       sqlite3ExplainExpr(pOut, pY);
3184a84203a0Sdrh       sqlite3ExplainPrintf(pOut, ",");
3185a84203a0Sdrh       sqlite3ExplainExpr(pOut, pZ);
3186a84203a0Sdrh       sqlite3ExplainPrintf(pOut, ")");
3187a84203a0Sdrh       break;
3188a84203a0Sdrh     }
3189a84203a0Sdrh     case TK_TRIGGER: {
3190a84203a0Sdrh       /* If the opcode is TK_TRIGGER, then the expression is a reference
3191a84203a0Sdrh       ** to a column in the new.* or old.* pseudo-tables available to
3192a84203a0Sdrh       ** trigger programs. In this case Expr.iTable is set to 1 for the
3193a84203a0Sdrh       ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
3194a84203a0Sdrh       ** is set to the column of the pseudo-table to read, or to -1 to
3195a84203a0Sdrh       ** read the rowid field.
3196a84203a0Sdrh       */
3197a84203a0Sdrh       sqlite3ExplainPrintf(pOut, "%s(%d)",
3198a84203a0Sdrh           pExpr->iTable ? "NEW" : "OLD", pExpr->iColumn);
3199a84203a0Sdrh       break;
3200a84203a0Sdrh     }
3201a84203a0Sdrh     case TK_CASE: {
3202a84203a0Sdrh       sqlite3ExplainPrintf(pOut, "CASE(");
3203a84203a0Sdrh       sqlite3ExplainExpr(pOut, pExpr->pLeft);
3204a84203a0Sdrh       sqlite3ExplainPrintf(pOut, ",");
3205a84203a0Sdrh       sqlite3ExplainExprList(pOut, pExpr->x.pList);
3206a84203a0Sdrh       break;
3207a84203a0Sdrh     }
3208a84203a0Sdrh #ifndef SQLITE_OMIT_TRIGGER
3209a84203a0Sdrh     case TK_RAISE: {
3210a84203a0Sdrh       const char *zType = "unk";
3211a84203a0Sdrh       switch( pExpr->affinity ){
3212a84203a0Sdrh         case OE_Rollback:   zType = "rollback";  break;
3213a84203a0Sdrh         case OE_Abort:      zType = "abort";     break;
3214a84203a0Sdrh         case OE_Fail:       zType = "fail";      break;
3215a84203a0Sdrh         case OE_Ignore:     zType = "ignore";    break;
3216a84203a0Sdrh       }
3217a84203a0Sdrh       sqlite3ExplainPrintf(pOut, "RAISE-%s(%s)", zType, pExpr->u.zToken);
3218a84203a0Sdrh       break;
3219a84203a0Sdrh     }
3220a84203a0Sdrh #endif
3221a84203a0Sdrh   }
3222a84203a0Sdrh   if( zBinOp ){
3223a84203a0Sdrh     sqlite3ExplainPrintf(pOut,"%s(", zBinOp);
3224a84203a0Sdrh     sqlite3ExplainExpr(pOut, pExpr->pLeft);
3225a84203a0Sdrh     sqlite3ExplainPrintf(pOut,",");
3226a84203a0Sdrh     sqlite3ExplainExpr(pOut, pExpr->pRight);
3227a84203a0Sdrh     sqlite3ExplainPrintf(pOut,")");
3228a84203a0Sdrh   }else if( zUniOp ){
3229a84203a0Sdrh     sqlite3ExplainPrintf(pOut,"%s(", zUniOp);
3230a84203a0Sdrh     sqlite3ExplainExpr(pOut, pExpr->pLeft);
3231a84203a0Sdrh     sqlite3ExplainPrintf(pOut,")");
3232a84203a0Sdrh   }
32337e02e5e6Sdrh }
3234678a9aa7Sdrh #endif /* defined(SQLITE_ENABLE_TREE_EXPLAIN) */
32357e02e5e6Sdrh 
3236678a9aa7Sdrh #if defined(SQLITE_ENABLE_TREE_EXPLAIN)
32377e02e5e6Sdrh /*
32387e02e5e6Sdrh ** Generate a human-readable explanation of an expression list.
32397e02e5e6Sdrh */
32407e02e5e6Sdrh void sqlite3ExplainExprList(Vdbe *pOut, ExprList *pList){
32417e02e5e6Sdrh   int i;
3242a84203a0Sdrh   if( pList==0 || pList->nExpr==0 ){
32437e02e5e6Sdrh     sqlite3ExplainPrintf(pOut, "(empty-list)");
32447e02e5e6Sdrh     return;
3245a84203a0Sdrh   }else if( pList->nExpr==1 ){
3246a84203a0Sdrh     sqlite3ExplainExpr(pOut, pList->a[0].pExpr);
3247a84203a0Sdrh   }else{
32487e02e5e6Sdrh     sqlite3ExplainPush(pOut);
32497e02e5e6Sdrh     for(i=0; i<pList->nExpr; i++){
3250a84203a0Sdrh       sqlite3ExplainPrintf(pOut, "item[%d] = ", i);
32517e02e5e6Sdrh       sqlite3ExplainPush(pOut);
32527e02e5e6Sdrh       sqlite3ExplainExpr(pOut, pList->a[i].pExpr);
32537e02e5e6Sdrh       sqlite3ExplainPop(pOut);
32547e02e5e6Sdrh       if( i<pList->nExpr-1 ){
32557e02e5e6Sdrh         sqlite3ExplainNL(pOut);
32567e02e5e6Sdrh       }
32577e02e5e6Sdrh     }
32587e02e5e6Sdrh     sqlite3ExplainPop(pOut);
32597e02e5e6Sdrh   }
3260a84203a0Sdrh }
32617e02e5e6Sdrh #endif /* SQLITE_DEBUG */
32627e02e5e6Sdrh 
3263678ccce8Sdrh /*
326447de955eSdrh ** Return TRUE if pExpr is an constant expression that is appropriate
326547de955eSdrh ** for factoring out of a loop.  Appropriate expressions are:
326647de955eSdrh **
326747de955eSdrh **    *  Any expression that evaluates to two or more opcodes.
326847de955eSdrh **
326947de955eSdrh **    *  Any OP_Integer, OP_Real, OP_String, OP_Blob, OP_Null,
327047de955eSdrh **       or OP_Variable that does not need to be placed in a
327147de955eSdrh **       specific register.
327247de955eSdrh **
327347de955eSdrh ** There is no point in factoring out single-instruction constant
327447de955eSdrh ** expressions that need to be placed in a particular register.
327547de955eSdrh ** We could factor them out, but then we would end up adding an
327647de955eSdrh ** OP_SCopy instruction to move the value into the correct register
327747de955eSdrh ** later.  We might as well just use the original instruction and
327847de955eSdrh ** avoid the OP_SCopy.
327947de955eSdrh */
328047de955eSdrh static int isAppropriateForFactoring(Expr *p){
328147de955eSdrh   if( !sqlite3ExprIsConstantNotJoin(p) ){
328247de955eSdrh     return 0;  /* Only constant expressions are appropriate for factoring */
328347de955eSdrh   }
328447de955eSdrh   if( (p->flags & EP_FixedDest)==0 ){
328547de955eSdrh     return 1;  /* Any constant without a fixed destination is appropriate */
328647de955eSdrh   }
328747de955eSdrh   while( p->op==TK_UPLUS ) p = p->pLeft;
328847de955eSdrh   switch( p->op ){
328947de955eSdrh #ifndef SQLITE_OMIT_BLOB_LITERAL
329047de955eSdrh     case TK_BLOB:
329147de955eSdrh #endif
329247de955eSdrh     case TK_VARIABLE:
329347de955eSdrh     case TK_INTEGER:
329447de955eSdrh     case TK_FLOAT:
329547de955eSdrh     case TK_NULL:
329647de955eSdrh     case TK_STRING: {
329747de955eSdrh       testcase( p->op==TK_BLOB );
329847de955eSdrh       testcase( p->op==TK_VARIABLE );
329947de955eSdrh       testcase( p->op==TK_INTEGER );
330047de955eSdrh       testcase( p->op==TK_FLOAT );
330147de955eSdrh       testcase( p->op==TK_NULL );
330247de955eSdrh       testcase( p->op==TK_STRING );
330347de955eSdrh       /* Single-instruction constants with a fixed destination are
330447de955eSdrh       ** better done in-line.  If we factor them, they will just end
330547de955eSdrh       ** up generating an OP_SCopy to move the value to the destination
330647de955eSdrh       ** register. */
330747de955eSdrh       return 0;
330847de955eSdrh     }
330947de955eSdrh     case TK_UMINUS: {
331047de955eSdrh       if( p->pLeft->op==TK_FLOAT || p->pLeft->op==TK_INTEGER ){
331147de955eSdrh         return 0;
331247de955eSdrh       }
331347de955eSdrh       break;
331447de955eSdrh     }
331547de955eSdrh     default: {
331647de955eSdrh       break;
331747de955eSdrh     }
331847de955eSdrh   }
331947de955eSdrh   return 1;
332047de955eSdrh }
332147de955eSdrh 
332247de955eSdrh /*
332347de955eSdrh ** If pExpr is a constant expression that is appropriate for
332447de955eSdrh ** factoring out of a loop, then evaluate the expression
3325678ccce8Sdrh ** into a register and convert the expression into a TK_REGISTER
3326678ccce8Sdrh ** expression.
3327678ccce8Sdrh */
33287d10d5a6Sdrh static int evalConstExpr(Walker *pWalker, Expr *pExpr){
33297d10d5a6Sdrh   Parse *pParse = pWalker->pParse;
333047de955eSdrh   switch( pExpr->op ){
3331e05c929bSdrh     case TK_IN:
333247de955eSdrh     case TK_REGISTER: {
333333cd4909Sdrh       return WRC_Prune;
3334678ccce8Sdrh     }
333547de955eSdrh     case TK_FUNCTION:
333647de955eSdrh     case TK_AGG_FUNCTION:
333747de955eSdrh     case TK_CONST_FUNC: {
333847de955eSdrh       /* The arguments to a function have a fixed destination.
333947de955eSdrh       ** Mark them this way to avoid generated unneeded OP_SCopy
334047de955eSdrh       ** instructions.
334147de955eSdrh       */
33426ab3a2ecSdanielk1977       ExprList *pList = pExpr->x.pList;
33436ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
334447de955eSdrh       if( pList ){
334547de955eSdrh         int i = pList->nExpr;
334647de955eSdrh         struct ExprList_item *pItem = pList->a;
334747de955eSdrh         for(; i>0; i--, pItem++){
334833cd4909Sdrh           if( ALWAYS(pItem->pExpr) ) pItem->pExpr->flags |= EP_FixedDest;
334947de955eSdrh         }
335047de955eSdrh       }
335147de955eSdrh       break;
335247de955eSdrh     }
335347de955eSdrh   }
335447de955eSdrh   if( isAppropriateForFactoring(pExpr) ){
3355678ccce8Sdrh     int r1 = ++pParse->nMem;
3356678ccce8Sdrh     int r2;
3357678ccce8Sdrh     r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
335833cd4909Sdrh     if( NEVER(r1!=r2) ) sqlite3ReleaseTempReg(pParse, r1);
3359fcd4a150Sdan     pExpr->op2 = pExpr->op;
3360678ccce8Sdrh     pExpr->op = TK_REGISTER;
3361678ccce8Sdrh     pExpr->iTable = r2;
33627d10d5a6Sdrh     return WRC_Prune;
3363678ccce8Sdrh   }
33647d10d5a6Sdrh   return WRC_Continue;
3365678ccce8Sdrh }
3366678ccce8Sdrh 
3367678ccce8Sdrh /*
3368678ccce8Sdrh ** Preevaluate constant subexpressions within pExpr and store the
3369678ccce8Sdrh ** results in registers.  Modify pExpr so that the constant subexpresions
3370678ccce8Sdrh ** are TK_REGISTER opcodes that refer to the precomputed values.
3371f58ee7f1Sdrh **
3372f58ee7f1Sdrh ** This routine is a no-op if the jump to the cookie-check code has
3373f58ee7f1Sdrh ** already occur.  Since the cookie-check jump is generated prior to
3374f58ee7f1Sdrh ** any other serious processing, this check ensures that there is no
3375f58ee7f1Sdrh ** way to accidently bypass the constant initializations.
3376f58ee7f1Sdrh **
3377f58ee7f1Sdrh ** This routine is also a no-op if the SQLITE_FactorOutConst optimization
3378f58ee7f1Sdrh ** is disabled via the sqlite3_test_control(SQLITE_TESTCTRL_OPTIMIZATIONS)
3379f58ee7f1Sdrh ** interface.  This allows test logic to verify that the same answer is
3380f58ee7f1Sdrh ** obtained for queries regardless of whether or not constants are
3381f58ee7f1Sdrh ** precomputed into registers or if they are inserted in-line.
3382678ccce8Sdrh */
3383678ccce8Sdrh void sqlite3ExprCodeConstants(Parse *pParse, Expr *pExpr){
33847d10d5a6Sdrh   Walker w;
338548b5b041Sdrh   if( pParse->cookieGoto ) return;
33867e5418e4Sdrh   if( OptimizationDisabled(pParse->db, SQLITE_FactorOutConst) ) return;
33877d10d5a6Sdrh   w.xExprCallback = evalConstExpr;
3388ef4c0598Sdrh   w.xSelectCallback = 0;
33897d10d5a6Sdrh   w.pParse = pParse;
33907d10d5a6Sdrh   sqlite3WalkExpr(&w, pExpr);
3391678ccce8Sdrh }
3392678ccce8Sdrh 
339325303780Sdrh 
339425303780Sdrh /*
3395268380caSdrh ** Generate code that pushes the value of every element of the given
33969cbf3425Sdrh ** expression list into a sequence of registers beginning at target.
3397268380caSdrh **
3398892d3179Sdrh ** Return the number of elements evaluated.
3399268380caSdrh */
34004adee20fSdanielk1977 int sqlite3ExprCodeExprList(
3401268380caSdrh   Parse *pParse,     /* Parsing context */
3402389a1adbSdrh   ExprList *pList,   /* The expression list to be coded */
3403191b54cbSdrh   int target,        /* Where to write results */
3404d176611bSdrh   int doHardCopy     /* Make a hard copy of every element */
3405268380caSdrh ){
3406268380caSdrh   struct ExprList_item *pItem;
34079cbf3425Sdrh   int i, n;
34089d8b3072Sdrh   assert( pList!=0 );
34099cbf3425Sdrh   assert( target>0 );
3410d81a142bSdrh   assert( pParse->pVdbe!=0 );  /* Never gets this far otherwise */
3411268380caSdrh   n = pList->nExpr;
3412191b54cbSdrh   for(pItem=pList->a, i=0; i<n; i++, pItem++){
34137445ffe2Sdrh     Expr *pExpr = pItem->pExpr;
34147445ffe2Sdrh     int inReg = sqlite3ExprCodeTarget(pParse, pExpr, target+i);
3415746fd9ccSdrh     if( inReg!=target+i ){
34167445ffe2Sdrh       sqlite3VdbeAddOp2(pParse->pVdbe, doHardCopy ? OP_Copy : OP_SCopy,
34177445ffe2Sdrh                         inReg, target+i);
3418d176611bSdrh     }
3419268380caSdrh   }
3420f9b596ebSdrh   return n;
3421268380caSdrh }
3422268380caSdrh 
3423268380caSdrh /*
342436c563a2Sdrh ** Generate code for a BETWEEN operator.
342536c563a2Sdrh **
342636c563a2Sdrh **    x BETWEEN y AND z
342736c563a2Sdrh **
342836c563a2Sdrh ** The above is equivalent to
342936c563a2Sdrh **
343036c563a2Sdrh **    x>=y AND x<=z
343136c563a2Sdrh **
343236c563a2Sdrh ** Code it as such, taking care to do the common subexpression
343336c563a2Sdrh ** elementation of x.
343436c563a2Sdrh */
343536c563a2Sdrh static void exprCodeBetween(
343636c563a2Sdrh   Parse *pParse,    /* Parsing and code generating context */
343736c563a2Sdrh   Expr *pExpr,      /* The BETWEEN expression */
343836c563a2Sdrh   int dest,         /* Jump here if the jump is taken */
343936c563a2Sdrh   int jumpIfTrue,   /* Take the jump if the BETWEEN is true */
344036c563a2Sdrh   int jumpIfNull    /* Take the jump if the BETWEEN is NULL */
344136c563a2Sdrh ){
344236c563a2Sdrh   Expr exprAnd;     /* The AND operator in  x>=y AND x<=z  */
344336c563a2Sdrh   Expr compLeft;    /* The  x>=y  term */
344436c563a2Sdrh   Expr compRight;   /* The  x<=z  term */
344536c563a2Sdrh   Expr exprX;       /* The  x  subexpression */
344636c563a2Sdrh   int regFree1 = 0; /* Temporary use register */
344736c563a2Sdrh 
344836c563a2Sdrh   assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
344936c563a2Sdrh   exprX = *pExpr->pLeft;
345036c563a2Sdrh   exprAnd.op = TK_AND;
345136c563a2Sdrh   exprAnd.pLeft = &compLeft;
345236c563a2Sdrh   exprAnd.pRight = &compRight;
345336c563a2Sdrh   compLeft.op = TK_GE;
345436c563a2Sdrh   compLeft.pLeft = &exprX;
345536c563a2Sdrh   compLeft.pRight = pExpr->x.pList->a[0].pExpr;
345636c563a2Sdrh   compRight.op = TK_LE;
345736c563a2Sdrh   compRight.pLeft = &exprX;
345836c563a2Sdrh   compRight.pRight = pExpr->x.pList->a[1].pExpr;
345936c563a2Sdrh   exprX.iTable = sqlite3ExprCodeTemp(pParse, &exprX, &regFree1);
346036c563a2Sdrh   exprX.op = TK_REGISTER;
346136c563a2Sdrh   if( jumpIfTrue ){
346236c563a2Sdrh     sqlite3ExprIfTrue(pParse, &exprAnd, dest, jumpIfNull);
346336c563a2Sdrh   }else{
346436c563a2Sdrh     sqlite3ExprIfFalse(pParse, &exprAnd, dest, jumpIfNull);
346536c563a2Sdrh   }
346636c563a2Sdrh   sqlite3ReleaseTempReg(pParse, regFree1);
346736c563a2Sdrh 
346836c563a2Sdrh   /* Ensure adequate test coverage */
346936c563a2Sdrh   testcase( jumpIfTrue==0 && jumpIfNull==0 && regFree1==0 );
347036c563a2Sdrh   testcase( jumpIfTrue==0 && jumpIfNull==0 && regFree1!=0 );
347136c563a2Sdrh   testcase( jumpIfTrue==0 && jumpIfNull!=0 && regFree1==0 );
347236c563a2Sdrh   testcase( jumpIfTrue==0 && jumpIfNull!=0 && regFree1!=0 );
347336c563a2Sdrh   testcase( jumpIfTrue!=0 && jumpIfNull==0 && regFree1==0 );
347436c563a2Sdrh   testcase( jumpIfTrue!=0 && jumpIfNull==0 && regFree1!=0 );
347536c563a2Sdrh   testcase( jumpIfTrue!=0 && jumpIfNull!=0 && regFree1==0 );
347636c563a2Sdrh   testcase( jumpIfTrue!=0 && jumpIfNull!=0 && regFree1!=0 );
347736c563a2Sdrh }
347836c563a2Sdrh 
347936c563a2Sdrh /*
3480cce7d176Sdrh ** Generate code for a boolean expression such that a jump is made
3481cce7d176Sdrh ** to the label "dest" if the expression is true but execution
3482cce7d176Sdrh ** continues straight thru if the expression is false.
3483f5905aa7Sdrh **
3484f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false), then
348535573356Sdrh ** take the jump if the jumpIfNull flag is SQLITE_JUMPIFNULL.
3486f2bc013cSdrh **
3487f2bc013cSdrh ** This code depends on the fact that certain token values (ex: TK_EQ)
3488f2bc013cSdrh ** are the same as opcode values (ex: OP_Eq) that implement the corresponding
3489f2bc013cSdrh ** operation.  Special comments in vdbe.c and the mkopcodeh.awk script in
3490f2bc013cSdrh ** the make process cause these values to align.  Assert()s in the code
3491f2bc013cSdrh ** below verify that the numbers are aligned correctly.
3492cce7d176Sdrh */
34934adee20fSdanielk1977 void sqlite3ExprIfTrue(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
3494cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
3495cce7d176Sdrh   int op = 0;
34962dcef11bSdrh   int regFree1 = 0;
34972dcef11bSdrh   int regFree2 = 0;
34982dcef11bSdrh   int r1, r2;
34992dcef11bSdrh 
350035573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
350133cd4909Sdrh   if( NEVER(v==0) )     return;  /* Existance of VDBE checked by caller */
350233cd4909Sdrh   if( NEVER(pExpr==0) ) return;  /* No way this can happen */
3503f2bc013cSdrh   op = pExpr->op;
3504f2bc013cSdrh   switch( op ){
3505cce7d176Sdrh     case TK_AND: {
35064adee20fSdanielk1977       int d2 = sqlite3VdbeMakeLabel(v);
3507c5499befSdrh       testcase( jumpIfNull==0 );
3508ceea3321Sdrh       sqlite3ExprCachePush(pParse);
350935573356Sdrh       sqlite3ExprIfFalse(pParse, pExpr->pLeft, d2,jumpIfNull^SQLITE_JUMPIFNULL);
35104adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
35114adee20fSdanielk1977       sqlite3VdbeResolveLabel(v, d2);
3512ceea3321Sdrh       sqlite3ExprCachePop(pParse, 1);
3513cce7d176Sdrh       break;
3514cce7d176Sdrh     }
3515cce7d176Sdrh     case TK_OR: {
3516c5499befSdrh       testcase( jumpIfNull==0 );
35174adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
35184adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
3519cce7d176Sdrh       break;
3520cce7d176Sdrh     }
3521cce7d176Sdrh     case TK_NOT: {
3522c5499befSdrh       testcase( jumpIfNull==0 );
35234adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
3524cce7d176Sdrh       break;
3525cce7d176Sdrh     }
3526cce7d176Sdrh     case TK_LT:
3527cce7d176Sdrh     case TK_LE:
3528cce7d176Sdrh     case TK_GT:
3529cce7d176Sdrh     case TK_GE:
3530cce7d176Sdrh     case TK_NE:
35310ac65892Sdrh     case TK_EQ: {
3532f2bc013cSdrh       assert( TK_LT==OP_Lt );
3533f2bc013cSdrh       assert( TK_LE==OP_Le );
3534f2bc013cSdrh       assert( TK_GT==OP_Gt );
3535f2bc013cSdrh       assert( TK_GE==OP_Ge );
3536f2bc013cSdrh       assert( TK_EQ==OP_Eq );
3537f2bc013cSdrh       assert( TK_NE==OP_Ne );
3538c5499befSdrh       testcase( op==TK_LT );
3539c5499befSdrh       testcase( op==TK_LE );
3540c5499befSdrh       testcase( op==TK_GT );
3541c5499befSdrh       testcase( op==TK_GE );
3542c5499befSdrh       testcase( op==TK_EQ );
3543c5499befSdrh       testcase( op==TK_NE );
3544c5499befSdrh       testcase( jumpIfNull==0 );
3545b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3546b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
354735573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
35482dcef11bSdrh                   r1, r2, dest, jumpIfNull);
3549c5499befSdrh       testcase( regFree1==0 );
3550c5499befSdrh       testcase( regFree2==0 );
3551cce7d176Sdrh       break;
3552cce7d176Sdrh     }
35536a2fe093Sdrh     case TK_IS:
35546a2fe093Sdrh     case TK_ISNOT: {
35556a2fe093Sdrh       testcase( op==TK_IS );
35566a2fe093Sdrh       testcase( op==TK_ISNOT );
3557b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3558b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
35596a2fe093Sdrh       op = (op==TK_IS) ? TK_EQ : TK_NE;
35606a2fe093Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
35616a2fe093Sdrh                   r1, r2, dest, SQLITE_NULLEQ);
35626a2fe093Sdrh       testcase( regFree1==0 );
35636a2fe093Sdrh       testcase( regFree2==0 );
35646a2fe093Sdrh       break;
35656a2fe093Sdrh     }
3566cce7d176Sdrh     case TK_ISNULL:
3567cce7d176Sdrh     case TK_NOTNULL: {
3568f2bc013cSdrh       assert( TK_ISNULL==OP_IsNull );
3569f2bc013cSdrh       assert( TK_NOTNULL==OP_NotNull );
3570c5499befSdrh       testcase( op==TK_ISNULL );
3571c5499befSdrh       testcase( op==TK_NOTNULL );
35722dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
35732dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
3574c5499befSdrh       testcase( regFree1==0 );
3575cce7d176Sdrh       break;
3576cce7d176Sdrh     }
3577fef5208cSdrh     case TK_BETWEEN: {
35785c03f30aSdrh       testcase( jumpIfNull==0 );
357936c563a2Sdrh       exprCodeBetween(pParse, pExpr, dest, 1, jumpIfNull);
3580fef5208cSdrh       break;
3581fef5208cSdrh     }
3582bb201344Sshaneh #ifndef SQLITE_OMIT_SUBQUERY
3583e3365e6cSdrh     case TK_IN: {
3584e3365e6cSdrh       int destIfFalse = sqlite3VdbeMakeLabel(v);
3585e3365e6cSdrh       int destIfNull = jumpIfNull ? dest : destIfFalse;
3586e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
3587e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_Goto, 0, dest);
3588e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
3589e3365e6cSdrh       break;
3590e3365e6cSdrh     }
3591bb201344Sshaneh #endif
3592cce7d176Sdrh     default: {
35932dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
35942dcef11bSdrh       sqlite3VdbeAddOp3(v, OP_If, r1, dest, jumpIfNull!=0);
3595c5499befSdrh       testcase( regFree1==0 );
3596c5499befSdrh       testcase( jumpIfNull==0 );
3597cce7d176Sdrh       break;
3598cce7d176Sdrh     }
3599cce7d176Sdrh   }
36002dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
36012dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
3602cce7d176Sdrh }
3603cce7d176Sdrh 
3604cce7d176Sdrh /*
360566b89c8fSdrh ** Generate code for a boolean expression such that a jump is made
3606cce7d176Sdrh ** to the label "dest" if the expression is false but execution
3607cce7d176Sdrh ** continues straight thru if the expression is true.
3608f5905aa7Sdrh **
3609f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false) then
361035573356Sdrh ** jump if jumpIfNull is SQLITE_JUMPIFNULL or fall through if jumpIfNull
361135573356Sdrh ** is 0.
3612cce7d176Sdrh */
36134adee20fSdanielk1977 void sqlite3ExprIfFalse(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
3614cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
3615cce7d176Sdrh   int op = 0;
36162dcef11bSdrh   int regFree1 = 0;
36172dcef11bSdrh   int regFree2 = 0;
36182dcef11bSdrh   int r1, r2;
36192dcef11bSdrh 
362035573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
362133cd4909Sdrh   if( NEVER(v==0) ) return; /* Existance of VDBE checked by caller */
362233cd4909Sdrh   if( pExpr==0 )    return;
3623f2bc013cSdrh 
3624f2bc013cSdrh   /* The value of pExpr->op and op are related as follows:
3625f2bc013cSdrh   **
3626f2bc013cSdrh   **       pExpr->op            op
3627f2bc013cSdrh   **       ---------          ----------
3628f2bc013cSdrh   **       TK_ISNULL          OP_NotNull
3629f2bc013cSdrh   **       TK_NOTNULL         OP_IsNull
3630f2bc013cSdrh   **       TK_NE              OP_Eq
3631f2bc013cSdrh   **       TK_EQ              OP_Ne
3632f2bc013cSdrh   **       TK_GT              OP_Le
3633f2bc013cSdrh   **       TK_LE              OP_Gt
3634f2bc013cSdrh   **       TK_GE              OP_Lt
3635f2bc013cSdrh   **       TK_LT              OP_Ge
3636f2bc013cSdrh   **
3637f2bc013cSdrh   ** For other values of pExpr->op, op is undefined and unused.
3638f2bc013cSdrh   ** The value of TK_ and OP_ constants are arranged such that we
3639f2bc013cSdrh   ** can compute the mapping above using the following expression.
3640f2bc013cSdrh   ** Assert()s verify that the computation is correct.
3641f2bc013cSdrh   */
3642f2bc013cSdrh   op = ((pExpr->op+(TK_ISNULL&1))^1)-(TK_ISNULL&1);
3643f2bc013cSdrh 
3644f2bc013cSdrh   /* Verify correct alignment of TK_ and OP_ constants
3645f2bc013cSdrh   */
3646f2bc013cSdrh   assert( pExpr->op!=TK_ISNULL || op==OP_NotNull );
3647f2bc013cSdrh   assert( pExpr->op!=TK_NOTNULL || op==OP_IsNull );
3648f2bc013cSdrh   assert( pExpr->op!=TK_NE || op==OP_Eq );
3649f2bc013cSdrh   assert( pExpr->op!=TK_EQ || op==OP_Ne );
3650f2bc013cSdrh   assert( pExpr->op!=TK_LT || op==OP_Ge );
3651f2bc013cSdrh   assert( pExpr->op!=TK_LE || op==OP_Gt );
3652f2bc013cSdrh   assert( pExpr->op!=TK_GT || op==OP_Le );
3653f2bc013cSdrh   assert( pExpr->op!=TK_GE || op==OP_Lt );
3654f2bc013cSdrh 
3655cce7d176Sdrh   switch( pExpr->op ){
3656cce7d176Sdrh     case TK_AND: {
3657c5499befSdrh       testcase( jumpIfNull==0 );
36584adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
36594adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
3660cce7d176Sdrh       break;
3661cce7d176Sdrh     }
3662cce7d176Sdrh     case TK_OR: {
36634adee20fSdanielk1977       int d2 = sqlite3VdbeMakeLabel(v);
3664c5499befSdrh       testcase( jumpIfNull==0 );
3665ceea3321Sdrh       sqlite3ExprCachePush(pParse);
366635573356Sdrh       sqlite3ExprIfTrue(pParse, pExpr->pLeft, d2, jumpIfNull^SQLITE_JUMPIFNULL);
36674adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
36684adee20fSdanielk1977       sqlite3VdbeResolveLabel(v, d2);
3669ceea3321Sdrh       sqlite3ExprCachePop(pParse, 1);
3670cce7d176Sdrh       break;
3671cce7d176Sdrh     }
3672cce7d176Sdrh     case TK_NOT: {
36735c03f30aSdrh       testcase( jumpIfNull==0 );
36744adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
3675cce7d176Sdrh       break;
3676cce7d176Sdrh     }
3677cce7d176Sdrh     case TK_LT:
3678cce7d176Sdrh     case TK_LE:
3679cce7d176Sdrh     case TK_GT:
3680cce7d176Sdrh     case TK_GE:
3681cce7d176Sdrh     case TK_NE:
3682cce7d176Sdrh     case TK_EQ: {
3683c5499befSdrh       testcase( op==TK_LT );
3684c5499befSdrh       testcase( op==TK_LE );
3685c5499befSdrh       testcase( op==TK_GT );
3686c5499befSdrh       testcase( op==TK_GE );
3687c5499befSdrh       testcase( op==TK_EQ );
3688c5499befSdrh       testcase( op==TK_NE );
3689c5499befSdrh       testcase( jumpIfNull==0 );
3690b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3691b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
369235573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
36932dcef11bSdrh                   r1, r2, dest, jumpIfNull);
3694c5499befSdrh       testcase( regFree1==0 );
3695c5499befSdrh       testcase( regFree2==0 );
3696cce7d176Sdrh       break;
3697cce7d176Sdrh     }
36986a2fe093Sdrh     case TK_IS:
36996a2fe093Sdrh     case TK_ISNOT: {
37006d4486aeSdrh       testcase( pExpr->op==TK_IS );
37016d4486aeSdrh       testcase( pExpr->op==TK_ISNOT );
3702b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3703b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
37046a2fe093Sdrh       op = (pExpr->op==TK_IS) ? TK_NE : TK_EQ;
37056a2fe093Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
37066a2fe093Sdrh                   r1, r2, dest, SQLITE_NULLEQ);
37076a2fe093Sdrh       testcase( regFree1==0 );
37086a2fe093Sdrh       testcase( regFree2==0 );
37096a2fe093Sdrh       break;
37106a2fe093Sdrh     }
3711cce7d176Sdrh     case TK_ISNULL:
3712cce7d176Sdrh     case TK_NOTNULL: {
3713c5499befSdrh       testcase( op==TK_ISNULL );
3714c5499befSdrh       testcase( op==TK_NOTNULL );
37152dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
37162dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
3717c5499befSdrh       testcase( regFree1==0 );
3718cce7d176Sdrh       break;
3719cce7d176Sdrh     }
3720fef5208cSdrh     case TK_BETWEEN: {
37215c03f30aSdrh       testcase( jumpIfNull==0 );
372236c563a2Sdrh       exprCodeBetween(pParse, pExpr, dest, 0, jumpIfNull);
3723fef5208cSdrh       break;
3724fef5208cSdrh     }
3725bb201344Sshaneh #ifndef SQLITE_OMIT_SUBQUERY
3726e3365e6cSdrh     case TK_IN: {
3727e3365e6cSdrh       if( jumpIfNull ){
3728e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, dest);
3729e3365e6cSdrh       }else{
3730e3365e6cSdrh         int destIfNull = sqlite3VdbeMakeLabel(v);
3731e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, destIfNull);
3732e3365e6cSdrh         sqlite3VdbeResolveLabel(v, destIfNull);
3733e3365e6cSdrh       }
3734e3365e6cSdrh       break;
3735e3365e6cSdrh     }
3736bb201344Sshaneh #endif
3737cce7d176Sdrh     default: {
37382dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
37392dcef11bSdrh       sqlite3VdbeAddOp3(v, OP_IfNot, r1, dest, jumpIfNull!=0);
3740c5499befSdrh       testcase( regFree1==0 );
3741c5499befSdrh       testcase( jumpIfNull==0 );
3742cce7d176Sdrh       break;
3743cce7d176Sdrh     }
3744cce7d176Sdrh   }
37452dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
37462dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
3747cce7d176Sdrh }
37482282792aSdrh 
37492282792aSdrh /*
37501d9da70aSdrh ** Do a deep comparison of two expression trees.  Return 0 if the two
37511d9da70aSdrh ** expressions are completely identical.  Return 1 if they differ only
37521d9da70aSdrh ** by a COLLATE operator at the top level.  Return 2 if there are differences
37531d9da70aSdrh ** other than the top-level COLLATE operator.
3754d40aab0eSdrh **
37551d9da70aSdrh ** Sometimes this routine will return 2 even if the two expressions
3756d40aab0eSdrh ** really are equivalent.  If we cannot prove that the expressions are
37571d9da70aSdrh ** identical, we return 2 just to be safe.  So if this routine
37581d9da70aSdrh ** returns 2, then you do not really know for certain if the two
37591d9da70aSdrh ** expressions are the same.  But if you get a 0 or 1 return, then you
3760d40aab0eSdrh ** can be sure the expressions are the same.  In the places where
37611d9da70aSdrh ** this routine is used, it does not hurt to get an extra 2 - that
3762d40aab0eSdrh ** just might result in some slightly slower code.  But returning
37631d9da70aSdrh ** an incorrect 0 or 1 could lead to a malfunction.
37642282792aSdrh */
37654adee20fSdanielk1977 int sqlite3ExprCompare(Expr *pA, Expr *pB){
37664b202ae2Sdanielk1977   if( pA==0||pB==0 ){
37671d9da70aSdrh     return pB==pA ? 0 : 2;
37682282792aSdrh   }
376933e619fcSdrh   assert( !ExprHasAnyProperty(pA, EP_TokenOnly|EP_Reduced) );
377033e619fcSdrh   assert( !ExprHasAnyProperty(pB, EP_TokenOnly|EP_Reduced) );
37716ab3a2ecSdanielk1977   if( ExprHasProperty(pA, EP_xIsSelect) || ExprHasProperty(pB, EP_xIsSelect) ){
37721d9da70aSdrh     return 2;
37736ab3a2ecSdanielk1977   }
37741d9da70aSdrh   if( (pA->flags & EP_Distinct)!=(pB->flags & EP_Distinct) ) return 2;
3775*ae80ddeaSdrh   if( pA->op!=pB->op ){
3776*ae80ddeaSdrh     if( pA->op==TK_COLLATE && sqlite3ExprCompare(pA->pLeft, pB)<2 ){
3777*ae80ddeaSdrh       return 1;
3778*ae80ddeaSdrh     }
3779*ae80ddeaSdrh     if( pB->op==TK_COLLATE && sqlite3ExprCompare(pA, pB->pLeft)<2 ){
3780*ae80ddeaSdrh       return 1;
3781*ae80ddeaSdrh     }
3782*ae80ddeaSdrh     return 2;
3783*ae80ddeaSdrh   }
37841d9da70aSdrh   if( sqlite3ExprCompare(pA->pLeft, pB->pLeft) ) return 2;
37851d9da70aSdrh   if( sqlite3ExprCompare(pA->pRight, pB->pRight) ) return 2;
37868c6f666bSdrh   if( sqlite3ExprListCompare(pA->x.pList, pB->x.pList) ) return 2;
37871d9da70aSdrh   if( pA->iTable!=pB->iTable || pA->iColumn!=pB->iColumn ) return 2;
378833e619fcSdrh   if( ExprHasProperty(pA, EP_IntValue) ){
378933e619fcSdrh     if( !ExprHasProperty(pB, EP_IntValue) || pA->u.iValue!=pB->u.iValue ){
37901d9da70aSdrh       return 2;
379133e619fcSdrh     }
3792bbabe197Sdrh   }else if( pA->op!=TK_COLUMN && ALWAYS(pA->op!=TK_AGG_COLUMN) && pA->u.zToken){
37931d9da70aSdrh     if( ExprHasProperty(pB, EP_IntValue) || NEVER(pB->u.zToken==0) ) return 2;
37946b93c9aeSdrh     if( strcmp(pA->u.zToken,pB->u.zToken)!=0 ){
3795*ae80ddeaSdrh       return pA->op==TK_COLLATE ? 1 : 2;
37961d9da70aSdrh     }
37971d9da70aSdrh   }
37982646da7eSdrh   return 0;
37992646da7eSdrh }
38002282792aSdrh 
38018c6f666bSdrh /*
38028c6f666bSdrh ** Compare two ExprList objects.  Return 0 if they are identical and
38038c6f666bSdrh ** non-zero if they differ in any way.
38048c6f666bSdrh **
38058c6f666bSdrh ** This routine might return non-zero for equivalent ExprLists.  The
38068c6f666bSdrh ** only consequence will be disabled optimizations.  But this routine
38078c6f666bSdrh ** must never return 0 if the two ExprList objects are different, or
38088c6f666bSdrh ** a malfunction will result.
38098c6f666bSdrh **
38108c6f666bSdrh ** Two NULL pointers are considered to be the same.  But a NULL pointer
38118c6f666bSdrh ** always differs from a non-NULL pointer.
38128c6f666bSdrh */
38138c6f666bSdrh int sqlite3ExprListCompare(ExprList *pA, ExprList *pB){
38148c6f666bSdrh   int i;
38158c6f666bSdrh   if( pA==0 && pB==0 ) return 0;
38168c6f666bSdrh   if( pA==0 || pB==0 ) return 1;
38178c6f666bSdrh   if( pA->nExpr!=pB->nExpr ) return 1;
38188c6f666bSdrh   for(i=0; i<pA->nExpr; i++){
38198c6f666bSdrh     Expr *pExprA = pA->a[i].pExpr;
38208c6f666bSdrh     Expr *pExprB = pB->a[i].pExpr;
38218c6f666bSdrh     if( pA->a[i].sortOrder!=pB->a[i].sortOrder ) return 1;
38228c6f666bSdrh     if( sqlite3ExprCompare(pExprA, pExprB) ) return 1;
38238c6f666bSdrh   }
38248c6f666bSdrh   return 0;
38258c6f666bSdrh }
382613449892Sdrh 
38272282792aSdrh /*
3828030796dfSdrh ** An instance of the following structure is used by the tree walker
3829030796dfSdrh ** to count references to table columns in the arguments of an
3830ed551b95Sdrh ** aggregate function, in order to implement the
3831ed551b95Sdrh ** sqlite3FunctionThisSrc() routine.
3832374fdce4Sdrh */
3833030796dfSdrh struct SrcCount {
3834030796dfSdrh   SrcList *pSrc;   /* One particular FROM clause in a nested query */
3835030796dfSdrh   int nThis;       /* Number of references to columns in pSrcList */
3836030796dfSdrh   int nOther;      /* Number of references to columns in other FROM clauses */
3837030796dfSdrh };
3838030796dfSdrh 
3839030796dfSdrh /*
3840030796dfSdrh ** Count the number of references to columns.
3841030796dfSdrh */
3842030796dfSdrh static int exprSrcCount(Walker *pWalker, Expr *pExpr){
3843fb0a6081Sdrh   /* The NEVER() on the second term is because sqlite3FunctionUsesThisSrc()
3844fb0a6081Sdrh   ** is always called before sqlite3ExprAnalyzeAggregates() and so the
3845fb0a6081Sdrh   ** TK_COLUMNs have not yet been converted into TK_AGG_COLUMN.  If
3846fb0a6081Sdrh   ** sqlite3FunctionUsesThisSrc() is used differently in the future, the
3847fb0a6081Sdrh   ** NEVER() will need to be removed. */
3848fb0a6081Sdrh   if( pExpr->op==TK_COLUMN || NEVER(pExpr->op==TK_AGG_COLUMN) ){
3849374fdce4Sdrh     int i;
3850030796dfSdrh     struct SrcCount *p = pWalker->u.pSrcCount;
3851030796dfSdrh     SrcList *pSrc = p->pSrc;
3852374fdce4Sdrh     for(i=0; i<pSrc->nSrc; i++){
3853030796dfSdrh       if( pExpr->iTable==pSrc->a[i].iCursor ) break;
3854374fdce4Sdrh     }
3855030796dfSdrh     if( i<pSrc->nSrc ){
3856030796dfSdrh       p->nThis++;
3857374fdce4Sdrh     }else{
3858030796dfSdrh       p->nOther++;
3859374fdce4Sdrh     }
3860374fdce4Sdrh   }
3861030796dfSdrh   return WRC_Continue;
3862030796dfSdrh }
3863374fdce4Sdrh 
3864374fdce4Sdrh /*
3865030796dfSdrh ** Determine if any of the arguments to the pExpr Function reference
3866030796dfSdrh ** pSrcList.  Return true if they do.  Also return true if the function
3867030796dfSdrh ** has no arguments or has only constant arguments.  Return false if pExpr
3868030796dfSdrh ** references columns but not columns of tables found in pSrcList.
3869374fdce4Sdrh */
3870030796dfSdrh int sqlite3FunctionUsesThisSrc(Expr *pExpr, SrcList *pSrcList){
3871374fdce4Sdrh   Walker w;
3872030796dfSdrh   struct SrcCount cnt;
3873374fdce4Sdrh   assert( pExpr->op==TK_AGG_FUNCTION );
3874374fdce4Sdrh   memset(&w, 0, sizeof(w));
3875030796dfSdrh   w.xExprCallback = exprSrcCount;
3876030796dfSdrh   w.u.pSrcCount = &cnt;
3877030796dfSdrh   cnt.pSrc = pSrcList;
3878030796dfSdrh   cnt.nThis = 0;
3879030796dfSdrh   cnt.nOther = 0;
3880030796dfSdrh   sqlite3WalkExprList(&w, pExpr->x.pList);
3881030796dfSdrh   return cnt.nThis>0 || cnt.nOther==0;
3882374fdce4Sdrh }
3883374fdce4Sdrh 
3884374fdce4Sdrh /*
388513449892Sdrh ** Add a new element to the pAggInfo->aCol[] array.  Return the index of
388613449892Sdrh ** the new element.  Return a negative number if malloc fails.
38872282792aSdrh */
388817435752Sdrh static int addAggInfoColumn(sqlite3 *db, AggInfo *pInfo){
388913449892Sdrh   int i;
3890cf643729Sdrh   pInfo->aCol = sqlite3ArrayAllocate(
389117435752Sdrh        db,
3892cf643729Sdrh        pInfo->aCol,
3893cf643729Sdrh        sizeof(pInfo->aCol[0]),
3894cf643729Sdrh        &pInfo->nColumn,
3895cf643729Sdrh        &i
3896cf643729Sdrh   );
389713449892Sdrh   return i;
38982282792aSdrh }
389913449892Sdrh 
390013449892Sdrh /*
390113449892Sdrh ** Add a new element to the pAggInfo->aFunc[] array.  Return the index of
390213449892Sdrh ** the new element.  Return a negative number if malloc fails.
390313449892Sdrh */
390417435752Sdrh static int addAggInfoFunc(sqlite3 *db, AggInfo *pInfo){
390513449892Sdrh   int i;
3906cf643729Sdrh   pInfo->aFunc = sqlite3ArrayAllocate(
390717435752Sdrh        db,
3908cf643729Sdrh        pInfo->aFunc,
3909cf643729Sdrh        sizeof(pInfo->aFunc[0]),
3910cf643729Sdrh        &pInfo->nFunc,
3911cf643729Sdrh        &i
3912cf643729Sdrh   );
391313449892Sdrh   return i;
39142282792aSdrh }
39152282792aSdrh 
39162282792aSdrh /*
39177d10d5a6Sdrh ** This is the xExprCallback for a tree walker.  It is used to
39187d10d5a6Sdrh ** implement sqlite3ExprAnalyzeAggregates().  See sqlite3ExprAnalyzeAggregates
3919626a879aSdrh ** for additional information.
39202282792aSdrh */
39217d10d5a6Sdrh static int analyzeAggregate(Walker *pWalker, Expr *pExpr){
39222282792aSdrh   int i;
39237d10d5a6Sdrh   NameContext *pNC = pWalker->u.pNC;
3924a58fdfb1Sdanielk1977   Parse *pParse = pNC->pParse;
3925a58fdfb1Sdanielk1977   SrcList *pSrcList = pNC->pSrcList;
392613449892Sdrh   AggInfo *pAggInfo = pNC->pAggInfo;
392713449892Sdrh 
39282282792aSdrh   switch( pExpr->op ){
392989c69d00Sdrh     case TK_AGG_COLUMN:
3930967e8b73Sdrh     case TK_COLUMN: {
39318b213899Sdrh       testcase( pExpr->op==TK_AGG_COLUMN );
39328b213899Sdrh       testcase( pExpr->op==TK_COLUMN );
393313449892Sdrh       /* Check to see if the column is in one of the tables in the FROM
393413449892Sdrh       ** clause of the aggregate query */
393520bc393cSdrh       if( ALWAYS(pSrcList!=0) ){
393613449892Sdrh         struct SrcList_item *pItem = pSrcList->a;
393713449892Sdrh         for(i=0; i<pSrcList->nSrc; i++, pItem++){
393813449892Sdrh           struct AggInfo_col *pCol;
393933e619fcSdrh           assert( !ExprHasAnyProperty(pExpr, EP_TokenOnly|EP_Reduced) );
394013449892Sdrh           if( pExpr->iTable==pItem->iCursor ){
394113449892Sdrh             /* If we reach this point, it means that pExpr refers to a table
394213449892Sdrh             ** that is in the FROM clause of the aggregate query.
394313449892Sdrh             **
394413449892Sdrh             ** Make an entry for the column in pAggInfo->aCol[] if there
394513449892Sdrh             ** is not an entry there already.
394613449892Sdrh             */
39477f906d63Sdrh             int k;
394813449892Sdrh             pCol = pAggInfo->aCol;
39497f906d63Sdrh             for(k=0; k<pAggInfo->nColumn; k++, pCol++){
395013449892Sdrh               if( pCol->iTable==pExpr->iTable &&
395113449892Sdrh                   pCol->iColumn==pExpr->iColumn ){
39522282792aSdrh                 break;
39532282792aSdrh               }
39542282792aSdrh             }
39551e536953Sdanielk1977             if( (k>=pAggInfo->nColumn)
39561e536953Sdanielk1977              && (k = addAggInfoColumn(pParse->db, pAggInfo))>=0
39571e536953Sdanielk1977             ){
39587f906d63Sdrh               pCol = &pAggInfo->aCol[k];
39590817d0dfSdanielk1977               pCol->pTab = pExpr->pTab;
396013449892Sdrh               pCol->iTable = pExpr->iTable;
396113449892Sdrh               pCol->iColumn = pExpr->iColumn;
39620a07c107Sdrh               pCol->iMem = ++pParse->nMem;
396313449892Sdrh               pCol->iSorterColumn = -1;
39645774b806Sdrh               pCol->pExpr = pExpr;
396513449892Sdrh               if( pAggInfo->pGroupBy ){
396613449892Sdrh                 int j, n;
396713449892Sdrh                 ExprList *pGB = pAggInfo->pGroupBy;
396813449892Sdrh                 struct ExprList_item *pTerm = pGB->a;
396913449892Sdrh                 n = pGB->nExpr;
397013449892Sdrh                 for(j=0; j<n; j++, pTerm++){
397113449892Sdrh                   Expr *pE = pTerm->pExpr;
397213449892Sdrh                   if( pE->op==TK_COLUMN && pE->iTable==pExpr->iTable &&
397313449892Sdrh                       pE->iColumn==pExpr->iColumn ){
397413449892Sdrh                     pCol->iSorterColumn = j;
397513449892Sdrh                     break;
39762282792aSdrh                   }
397713449892Sdrh                 }
397813449892Sdrh               }
397913449892Sdrh               if( pCol->iSorterColumn<0 ){
398013449892Sdrh                 pCol->iSorterColumn = pAggInfo->nSortingColumn++;
398113449892Sdrh               }
398213449892Sdrh             }
398313449892Sdrh             /* There is now an entry for pExpr in pAggInfo->aCol[] (either
398413449892Sdrh             ** because it was there before or because we just created it).
398513449892Sdrh             ** Convert the pExpr to be a TK_AGG_COLUMN referring to that
398613449892Sdrh             ** pAggInfo->aCol[] entry.
398713449892Sdrh             */
398833e619fcSdrh             ExprSetIrreducible(pExpr);
398913449892Sdrh             pExpr->pAggInfo = pAggInfo;
399013449892Sdrh             pExpr->op = TK_AGG_COLUMN;
3991cf697396Sshane             pExpr->iAgg = (i16)k;
399213449892Sdrh             break;
399313449892Sdrh           } /* endif pExpr->iTable==pItem->iCursor */
399413449892Sdrh         } /* end loop over pSrcList */
3995a58fdfb1Sdanielk1977       }
39967d10d5a6Sdrh       return WRC_Prune;
39972282792aSdrh     }
39982282792aSdrh     case TK_AGG_FUNCTION: {
39993a8c4be7Sdrh       if( (pNC->ncFlags & NC_InAggFunc)==0
4000ed551b95Sdrh        && pWalker->walkerDepth==pExpr->op2
40013a8c4be7Sdrh       ){
400213449892Sdrh         /* Check to see if pExpr is a duplicate of another aggregate
400313449892Sdrh         ** function that is already in the pAggInfo structure
400413449892Sdrh         */
400513449892Sdrh         struct AggInfo_func *pItem = pAggInfo->aFunc;
400613449892Sdrh         for(i=0; i<pAggInfo->nFunc; i++, pItem++){
40071d9da70aSdrh           if( sqlite3ExprCompare(pItem->pExpr, pExpr)==0 ){
40082282792aSdrh             break;
40092282792aSdrh           }
40102282792aSdrh         }
401113449892Sdrh         if( i>=pAggInfo->nFunc ){
401213449892Sdrh           /* pExpr is original.  Make a new entry in pAggInfo->aFunc[]
401313449892Sdrh           */
401414db2665Sdanielk1977           u8 enc = ENC(pParse->db);
40151e536953Sdanielk1977           i = addAggInfoFunc(pParse->db, pAggInfo);
401613449892Sdrh           if( i>=0 ){
40176ab3a2ecSdanielk1977             assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
401813449892Sdrh             pItem = &pAggInfo->aFunc[i];
401913449892Sdrh             pItem->pExpr = pExpr;
40200a07c107Sdrh             pItem->iMem = ++pParse->nMem;
402133e619fcSdrh             assert( !ExprHasProperty(pExpr, EP_IntValue) );
402213449892Sdrh             pItem->pFunc = sqlite3FindFunction(pParse->db,
402333e619fcSdrh                    pExpr->u.zToken, sqlite3Strlen30(pExpr->u.zToken),
40246ab3a2ecSdanielk1977                    pExpr->x.pList ? pExpr->x.pList->nExpr : 0, enc, 0);
4025fd357974Sdrh             if( pExpr->flags & EP_Distinct ){
4026fd357974Sdrh               pItem->iDistinct = pParse->nTab++;
4027fd357974Sdrh             }else{
4028fd357974Sdrh               pItem->iDistinct = -1;
4029fd357974Sdrh             }
40302282792aSdrh           }
403113449892Sdrh         }
403213449892Sdrh         /* Make pExpr point to the appropriate pAggInfo->aFunc[] entry
403313449892Sdrh         */
403433e619fcSdrh         assert( !ExprHasAnyProperty(pExpr, EP_TokenOnly|EP_Reduced) );
403533e619fcSdrh         ExprSetIrreducible(pExpr);
4036cf697396Sshane         pExpr->iAgg = (i16)i;
403713449892Sdrh         pExpr->pAggInfo = pAggInfo;
40383a8c4be7Sdrh         return WRC_Prune;
40396e83a57fSdrh       }else{
40406e83a57fSdrh         return WRC_Continue;
40416e83a57fSdrh       }
40422282792aSdrh     }
4043a58fdfb1Sdanielk1977   }
40447d10d5a6Sdrh   return WRC_Continue;
40457d10d5a6Sdrh }
40467d10d5a6Sdrh static int analyzeAggregatesInSelect(Walker *pWalker, Select *pSelect){
4047d5a336efSdrh   UNUSED_PARAMETER(pWalker);
4048d5a336efSdrh   UNUSED_PARAMETER(pSelect);
40497d10d5a6Sdrh   return WRC_Continue;
4050a58fdfb1Sdanielk1977 }
4051626a879aSdrh 
4052626a879aSdrh /*
4053e8abb4caSdrh ** Analyze the pExpr expression looking for aggregate functions and
4054e8abb4caSdrh ** for variables that need to be added to AggInfo object that pNC->pAggInfo
4055e8abb4caSdrh ** points to.  Additional entries are made on the AggInfo object as
4056e8abb4caSdrh ** necessary.
4057626a879aSdrh **
4058626a879aSdrh ** This routine should only be called after the expression has been
40597d10d5a6Sdrh ** analyzed by sqlite3ResolveExprNames().
4060626a879aSdrh */
4061d2b3e23bSdrh void sqlite3ExprAnalyzeAggregates(NameContext *pNC, Expr *pExpr){
40627d10d5a6Sdrh   Walker w;
4063374fdce4Sdrh   memset(&w, 0, sizeof(w));
40647d10d5a6Sdrh   w.xExprCallback = analyzeAggregate;
40657d10d5a6Sdrh   w.xSelectCallback = analyzeAggregatesInSelect;
40667d10d5a6Sdrh   w.u.pNC = pNC;
406720bc393cSdrh   assert( pNC->pSrcList!=0 );
40687d10d5a6Sdrh   sqlite3WalkExpr(&w, pExpr);
40692282792aSdrh }
40705d9a4af9Sdrh 
40715d9a4af9Sdrh /*
40725d9a4af9Sdrh ** Call sqlite3ExprAnalyzeAggregates() for every expression in an
40735d9a4af9Sdrh ** expression list.  Return the number of errors.
40745d9a4af9Sdrh **
40755d9a4af9Sdrh ** If an error is found, the analysis is cut short.
40765d9a4af9Sdrh */
4077d2b3e23bSdrh void sqlite3ExprAnalyzeAggList(NameContext *pNC, ExprList *pList){
40785d9a4af9Sdrh   struct ExprList_item *pItem;
40795d9a4af9Sdrh   int i;
40805d9a4af9Sdrh   if( pList ){
4081d2b3e23bSdrh     for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
4082d2b3e23bSdrh       sqlite3ExprAnalyzeAggregates(pNC, pItem->pExpr);
40835d9a4af9Sdrh     }
40845d9a4af9Sdrh   }
40855d9a4af9Sdrh }
4086892d3179Sdrh 
4087892d3179Sdrh /*
4088ceea3321Sdrh ** Allocate a single new register for use to hold some intermediate result.
4089892d3179Sdrh */
4090892d3179Sdrh int sqlite3GetTempReg(Parse *pParse){
4091e55cbd72Sdrh   if( pParse->nTempReg==0 ){
4092892d3179Sdrh     return ++pParse->nMem;
4093892d3179Sdrh   }
40942f425f6bSdanielk1977   return pParse->aTempReg[--pParse->nTempReg];
4095892d3179Sdrh }
4096ceea3321Sdrh 
4097ceea3321Sdrh /*
4098ceea3321Sdrh ** Deallocate a register, making available for reuse for some other
4099ceea3321Sdrh ** purpose.
4100ceea3321Sdrh **
4101ceea3321Sdrh ** If a register is currently being used by the column cache, then
4102ceea3321Sdrh ** the dallocation is deferred until the column cache line that uses
4103ceea3321Sdrh ** the register becomes stale.
4104ceea3321Sdrh */
4105892d3179Sdrh void sqlite3ReleaseTempReg(Parse *pParse, int iReg){
41062dcef11bSdrh   if( iReg && pParse->nTempReg<ArraySize(pParse->aTempReg) ){
4107ceea3321Sdrh     int i;
4108ceea3321Sdrh     struct yColCache *p;
4109ceea3321Sdrh     for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
4110ceea3321Sdrh       if( p->iReg==iReg ){
4111ceea3321Sdrh         p->tempReg = 1;
4112ceea3321Sdrh         return;
4113ceea3321Sdrh       }
4114ceea3321Sdrh     }
4115892d3179Sdrh     pParse->aTempReg[pParse->nTempReg++] = iReg;
4116892d3179Sdrh   }
4117892d3179Sdrh }
4118892d3179Sdrh 
4119892d3179Sdrh /*
4120892d3179Sdrh ** Allocate or deallocate a block of nReg consecutive registers
4121892d3179Sdrh */
4122892d3179Sdrh int sqlite3GetTempRange(Parse *pParse, int nReg){
4123e55cbd72Sdrh   int i, n;
4124892d3179Sdrh   i = pParse->iRangeReg;
4125e55cbd72Sdrh   n = pParse->nRangeReg;
4126f49f3523Sdrh   if( nReg<=n ){
4127f49f3523Sdrh     assert( !usedAsColumnCache(pParse, i, i+n-1) );
4128892d3179Sdrh     pParse->iRangeReg += nReg;
4129892d3179Sdrh     pParse->nRangeReg -= nReg;
4130892d3179Sdrh   }else{
4131892d3179Sdrh     i = pParse->nMem+1;
4132892d3179Sdrh     pParse->nMem += nReg;
4133892d3179Sdrh   }
4134892d3179Sdrh   return i;
4135892d3179Sdrh }
4136892d3179Sdrh void sqlite3ReleaseTempRange(Parse *pParse, int iReg, int nReg){
4137f49f3523Sdrh   sqlite3ExprCacheRemove(pParse, iReg, nReg);
4138892d3179Sdrh   if( nReg>pParse->nRangeReg ){
4139892d3179Sdrh     pParse->nRangeReg = nReg;
4140892d3179Sdrh     pParse->iRangeReg = iReg;
4141892d3179Sdrh   }
4142892d3179Sdrh }
4143cdc69557Sdrh 
4144cdc69557Sdrh /*
4145cdc69557Sdrh ** Mark all temporary registers as being unavailable for reuse.
4146cdc69557Sdrh */
4147cdc69557Sdrh void sqlite3ClearTempRegCache(Parse *pParse){
4148cdc69557Sdrh   pParse->nTempReg = 0;
4149cdc69557Sdrh   pParse->nRangeReg = 0;
4150cdc69557Sdrh }
4151