xref: /sqlite-3.40.0/src/expr.c (revision bbbdc83b)
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){
34580c8c18Sdrh   int op;
35580c8c18Sdrh   pExpr = sqlite3ExprSkipCollate(pExpr);
36580c8c18Sdrh   op = pExpr->op;
37487e262fSdrh   if( op==TK_SELECT ){
386ab3a2ecSdanielk1977     assert( pExpr->flags&EP_xIsSelect );
396ab3a2ecSdanielk1977     return sqlite3ExprAffinity(pExpr->x.pSelect->pEList->a[0].pExpr);
40a37cdde0Sdanielk1977   }
41487e262fSdrh #ifndef SQLITE_OMIT_CAST
42487e262fSdrh   if( op==TK_CAST ){
4333e619fcSdrh     assert( !ExprHasProperty(pExpr, EP_IntValue) );
44fdaac671Sdrh     return sqlite3AffinityType(pExpr->u.zToken, 0);
45487e262fSdrh   }
46487e262fSdrh #endif
47259a455fSdanielk1977   if( (op==TK_AGG_COLUMN || op==TK_COLUMN || op==TK_REGISTER)
48259a455fSdanielk1977    && pExpr->pTab!=0
49259a455fSdanielk1977   ){
507d10d5a6Sdrh     /* op==TK_REGISTER && pExpr->pTab!=0 happens when pExpr was originally
517d10d5a6Sdrh     ** a TK_COLUMN but was previously evaluated and cached in a register */
527d10d5a6Sdrh     int j = pExpr->iColumn;
537d10d5a6Sdrh     if( j<0 ) return SQLITE_AFF_INTEGER;
547d10d5a6Sdrh     assert( pExpr->pTab && j<pExpr->pTab->nCol );
557d10d5a6Sdrh     return pExpr->pTab->aCol[j].affinity;
567d10d5a6Sdrh   }
57a37cdde0Sdanielk1977   return pExpr->affinity;
58a37cdde0Sdanielk1977 }
59a37cdde0Sdanielk1977 
6053db1458Sdrh /*
618b4c40d8Sdrh ** Set the collating sequence for expression pExpr to be the collating
62ae80ddeaSdrh ** sequence named by pToken.   Return a pointer to a new Expr node that
63ae80ddeaSdrh ** implements the COLLATE operator.
640a8a406eSdrh **
650a8a406eSdrh ** If a memory allocation error occurs, that fact is recorded in pParse->db
660a8a406eSdrh ** and the pExpr parameter is returned unchanged.
678b4c40d8Sdrh */
680a8a406eSdrh Expr *sqlite3ExprAddCollateToken(Parse *pParse, Expr *pExpr, Token *pCollName){
690a8a406eSdrh   if( pCollName->n>0 ){
70ae80ddeaSdrh     Expr *pNew = sqlite3ExprAlloc(pParse->db, TK_COLLATE, pCollName, 1);
71ae80ddeaSdrh     if( pNew ){
72ae80ddeaSdrh       pNew->pLeft = pExpr;
73a4c3c87eSdrh       pNew->flags |= EP_Collate|EP_Skip;
740a8a406eSdrh       pExpr = pNew;
75ae80ddeaSdrh     }
760a8a406eSdrh   }
770a8a406eSdrh   return pExpr;
780a8a406eSdrh }
790a8a406eSdrh Expr *sqlite3ExprAddCollateString(Parse *pParse, Expr *pExpr, const char *zC){
800a8a406eSdrh   Token s;
81261d8a51Sdrh   assert( zC!=0 );
820a8a406eSdrh   s.z = zC;
830a8a406eSdrh   s.n = sqlite3Strlen30(s.z);
84261d8a51Sdrh   return sqlite3ExprAddCollateToken(pParse, pExpr, &s);
850a8a406eSdrh }
860a8a406eSdrh 
870a8a406eSdrh /*
88a4c3c87eSdrh ** Skip over any TK_COLLATE or TK_AS operators and any unlikely()
89a4c3c87eSdrh ** or likelihood() function at the root of an expression.
900a8a406eSdrh */
910a8a406eSdrh Expr *sqlite3ExprSkipCollate(Expr *pExpr){
92a4c3c87eSdrh   while( pExpr && ExprHasProperty(pExpr, EP_Skip) ){
93a4c3c87eSdrh     if( ExprHasProperty(pExpr, EP_Unlikely) ){
94cca9f3d2Sdrh       assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
95cca9f3d2Sdrh       assert( pExpr->x.pList->nExpr>0 );
96a4c3c87eSdrh       assert( pExpr->op==TK_FUNCTION );
97cca9f3d2Sdrh       pExpr = pExpr->x.pList->a[0].pExpr;
98cca9f3d2Sdrh     }else{
99a4c3c87eSdrh       assert( pExpr->op==TK_COLLATE || pExpr->op==TK_AS );
100d91eba96Sdrh       pExpr = pExpr->pLeft;
101cca9f3d2Sdrh     }
102d91eba96Sdrh   }
1030a8a406eSdrh   return pExpr;
1048b4c40d8Sdrh }
1058b4c40d8Sdrh 
1068b4c40d8Sdrh /*
107ae80ddeaSdrh ** Return the collation sequence for the expression pExpr. If
108ae80ddeaSdrh ** there is no defined collating sequence, return NULL.
109ae80ddeaSdrh **
110ae80ddeaSdrh ** The collating sequence might be determined by a COLLATE operator
111ae80ddeaSdrh ** or by the presence of a column with a defined collating sequence.
112ae80ddeaSdrh ** COLLATE operators take first precedence.  Left operands take
113ae80ddeaSdrh ** precedence over right operands.
1140202b29eSdanielk1977 */
1157cedc8d4Sdanielk1977 CollSeq *sqlite3ExprCollSeq(Parse *pParse, Expr *pExpr){
116ae80ddeaSdrh   sqlite3 *db = pParse->db;
1177cedc8d4Sdanielk1977   CollSeq *pColl = 0;
1187d10d5a6Sdrh   Expr *p = pExpr;
119261d8a51Sdrh   while( p ){
120ae80ddeaSdrh     int op = p->op;
121ae80ddeaSdrh     if( op==TK_CAST || op==TK_UPLUS ){
122ae80ddeaSdrh       p = p->pLeft;
123ae80ddeaSdrh       continue;
124ae80ddeaSdrh     }
12536e78309Sdan     if( op==TK_COLLATE || (op==TK_REGISTER && p->op2==TK_COLLATE) ){
1267a66da13Sdrh       pColl = sqlite3GetCollSeq(pParse, ENC(db), 0, p->u.zToken);
127ae80ddeaSdrh       break;
128ae80ddeaSdrh     }
129ae80ddeaSdrh     if( p->pTab!=0
130ae80ddeaSdrh      && (op==TK_AGG_COLUMN || op==TK_COLUMN
131ae80ddeaSdrh           || op==TK_REGISTER || op==TK_TRIGGER)
132ae80ddeaSdrh     ){
1337d10d5a6Sdrh       /* op==TK_REGISTER && p->pTab!=0 happens when pExpr was originally
1347d10d5a6Sdrh       ** a TK_COLUMN but was previously evaluated and cached in a register */
1357d10d5a6Sdrh       int j = p->iColumn;
1367d10d5a6Sdrh       if( j>=0 ){
137ae80ddeaSdrh         const char *zColl = p->pTab->aCol[j].zColl;
138c4a64facSdrh         pColl = sqlite3FindCollSeq(db, ENC(db), zColl, 0);
1390202b29eSdanielk1977       }
1407d10d5a6Sdrh       break;
1417d10d5a6Sdrh     }
142ae80ddeaSdrh     if( p->flags & EP_Collate ){
143261d8a51Sdrh       if( ALWAYS(p->pLeft) && (p->pLeft->flags & EP_Collate)!=0 ){
1447d10d5a6Sdrh         p = p->pLeft;
145ae80ddeaSdrh       }else{
146ae80ddeaSdrh         p = p->pRight;
147ae80ddeaSdrh       }
148ae80ddeaSdrh     }else{
149ae80ddeaSdrh       break;
150ae80ddeaSdrh     }
1510202b29eSdanielk1977   }
1527cedc8d4Sdanielk1977   if( sqlite3CheckCollSeq(pParse, pColl) ){
1537cedc8d4Sdanielk1977     pColl = 0;
1547cedc8d4Sdanielk1977   }
1557cedc8d4Sdanielk1977   return pColl;
1560202b29eSdanielk1977 }
1570202b29eSdanielk1977 
1580202b29eSdanielk1977 /*
159626a879aSdrh ** pExpr is an operand of a comparison operator.  aff2 is the
160626a879aSdrh ** type affinity of the other operand.  This routine returns the
16153db1458Sdrh ** type affinity that should be used for the comparison operator.
16253db1458Sdrh */
163e014a838Sdanielk1977 char sqlite3CompareAffinity(Expr *pExpr, char aff2){
164bf3b721fSdanielk1977   char aff1 = sqlite3ExprAffinity(pExpr);
165e014a838Sdanielk1977   if( aff1 && aff2 ){
1668df447f0Sdrh     /* Both sides of the comparison are columns. If one has numeric
1678df447f0Sdrh     ** affinity, use that. Otherwise use no affinity.
168e014a838Sdanielk1977     */
1698a51256cSdrh     if( sqlite3IsNumericAffinity(aff1) || sqlite3IsNumericAffinity(aff2) ){
170e014a838Sdanielk1977       return SQLITE_AFF_NUMERIC;
171e014a838Sdanielk1977     }else{
172e014a838Sdanielk1977       return SQLITE_AFF_NONE;
173e014a838Sdanielk1977     }
174e014a838Sdanielk1977   }else if( !aff1 && !aff2 ){
1755f6a87b3Sdrh     /* Neither side of the comparison is a column.  Compare the
1765f6a87b3Sdrh     ** results directly.
177e014a838Sdanielk1977     */
1785f6a87b3Sdrh     return SQLITE_AFF_NONE;
179e014a838Sdanielk1977   }else{
180e014a838Sdanielk1977     /* One side is a column, the other is not. Use the columns affinity. */
181fe05af87Sdrh     assert( aff1==0 || aff2==0 );
182e014a838Sdanielk1977     return (aff1 + aff2);
183e014a838Sdanielk1977   }
184e014a838Sdanielk1977 }
185e014a838Sdanielk1977 
18653db1458Sdrh /*
18753db1458Sdrh ** pExpr is a comparison operator.  Return the type affinity that should
18853db1458Sdrh ** be applied to both operands prior to doing the comparison.
18953db1458Sdrh */
190e014a838Sdanielk1977 static char comparisonAffinity(Expr *pExpr){
191e014a838Sdanielk1977   char aff;
192e014a838Sdanielk1977   assert( pExpr->op==TK_EQ || pExpr->op==TK_IN || pExpr->op==TK_LT ||
193e014a838Sdanielk1977           pExpr->op==TK_GT || pExpr->op==TK_GE || pExpr->op==TK_LE ||
1946a2fe093Sdrh           pExpr->op==TK_NE || pExpr->op==TK_IS || pExpr->op==TK_ISNOT );
195e014a838Sdanielk1977   assert( pExpr->pLeft );
196bf3b721fSdanielk1977   aff = sqlite3ExprAffinity(pExpr->pLeft);
197e014a838Sdanielk1977   if( pExpr->pRight ){
198e014a838Sdanielk1977     aff = sqlite3CompareAffinity(pExpr->pRight, aff);
1996ab3a2ecSdanielk1977   }else if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2006ab3a2ecSdanielk1977     aff = sqlite3CompareAffinity(pExpr->x.pSelect->pEList->a[0].pExpr, aff);
2016ab3a2ecSdanielk1977   }else if( !aff ){
202de087bd5Sdrh     aff = SQLITE_AFF_NONE;
203e014a838Sdanielk1977   }
204e014a838Sdanielk1977   return aff;
205e014a838Sdanielk1977 }
206e014a838Sdanielk1977 
207e014a838Sdanielk1977 /*
208e014a838Sdanielk1977 ** pExpr is a comparison expression, eg. '=', '<', IN(...) etc.
209e014a838Sdanielk1977 ** idx_affinity is the affinity of an indexed column. Return true
210e014a838Sdanielk1977 ** if the index with affinity idx_affinity may be used to implement
211e014a838Sdanielk1977 ** the comparison in pExpr.
212e014a838Sdanielk1977 */
213e014a838Sdanielk1977 int sqlite3IndexAffinityOk(Expr *pExpr, char idx_affinity){
214e014a838Sdanielk1977   char aff = comparisonAffinity(pExpr);
2158a51256cSdrh   switch( aff ){
2168a51256cSdrh     case SQLITE_AFF_NONE:
2178a51256cSdrh       return 1;
2188a51256cSdrh     case SQLITE_AFF_TEXT:
2198a51256cSdrh       return idx_affinity==SQLITE_AFF_TEXT;
2208a51256cSdrh     default:
2218a51256cSdrh       return sqlite3IsNumericAffinity(idx_affinity);
2228a51256cSdrh   }
223e014a838Sdanielk1977 }
224e014a838Sdanielk1977 
225a37cdde0Sdanielk1977 /*
22635573356Sdrh ** Return the P5 value that should be used for a binary comparison
227a37cdde0Sdanielk1977 ** opcode (OP_Eq, OP_Ge etc.) used to compare pExpr1 and pExpr2.
228a37cdde0Sdanielk1977 */
22935573356Sdrh static u8 binaryCompareP5(Expr *pExpr1, Expr *pExpr2, int jumpIfNull){
23035573356Sdrh   u8 aff = (char)sqlite3ExprAffinity(pExpr2);
2311bd10f8aSdrh   aff = (u8)sqlite3CompareAffinity(pExpr1, aff) | (u8)jumpIfNull;
23235573356Sdrh   return aff;
233a37cdde0Sdanielk1977 }
234a37cdde0Sdanielk1977 
235a2e00042Sdrh /*
2360202b29eSdanielk1977 ** Return a pointer to the collation sequence that should be used by
2370202b29eSdanielk1977 ** a binary comparison operator comparing pLeft and pRight.
2380202b29eSdanielk1977 **
2390202b29eSdanielk1977 ** If the left hand expression has a collating sequence type, then it is
2400202b29eSdanielk1977 ** used. Otherwise the collation sequence for the right hand expression
2410202b29eSdanielk1977 ** is used, or the default (BINARY) if neither expression has a collating
2420202b29eSdanielk1977 ** type.
243bcbb04e5Sdanielk1977 **
244bcbb04e5Sdanielk1977 ** Argument pRight (but not pLeft) may be a null pointer. In this case,
245bcbb04e5Sdanielk1977 ** it is not considered.
2460202b29eSdanielk1977 */
247bcbb04e5Sdanielk1977 CollSeq *sqlite3BinaryCompareCollSeq(
248bcbb04e5Sdanielk1977   Parse *pParse,
249bcbb04e5Sdanielk1977   Expr *pLeft,
250bcbb04e5Sdanielk1977   Expr *pRight
251bcbb04e5Sdanielk1977 ){
252ec41ddacSdrh   CollSeq *pColl;
253ec41ddacSdrh   assert( pLeft );
254ae80ddeaSdrh   if( pLeft->flags & EP_Collate ){
255ae80ddeaSdrh     pColl = sqlite3ExprCollSeq(pParse, pLeft);
256ae80ddeaSdrh   }else if( pRight && (pRight->flags & EP_Collate)!=0 ){
257ae80ddeaSdrh     pColl = sqlite3ExprCollSeq(pParse, pRight);
258ec41ddacSdrh   }else{
259ec41ddacSdrh     pColl = sqlite3ExprCollSeq(pParse, pLeft);
2600202b29eSdanielk1977     if( !pColl ){
2617cedc8d4Sdanielk1977       pColl = sqlite3ExprCollSeq(pParse, pRight);
2620202b29eSdanielk1977     }
263ec41ddacSdrh   }
2640202b29eSdanielk1977   return pColl;
2650202b29eSdanielk1977 }
2660202b29eSdanielk1977 
2670202b29eSdanielk1977 /*
268be5c89acSdrh ** Generate code for a comparison operator.
269be5c89acSdrh */
270be5c89acSdrh static int codeCompare(
271be5c89acSdrh   Parse *pParse,    /* The parsing (and code generating) context */
272be5c89acSdrh   Expr *pLeft,      /* The left operand */
273be5c89acSdrh   Expr *pRight,     /* The right operand */
274be5c89acSdrh   int opcode,       /* The comparison opcode */
27535573356Sdrh   int in1, int in2, /* Register holding operands */
276be5c89acSdrh   int dest,         /* Jump here if true.  */
277be5c89acSdrh   int jumpIfNull    /* If true, jump if either operand is NULL */
278be5c89acSdrh ){
27935573356Sdrh   int p5;
28035573356Sdrh   int addr;
28135573356Sdrh   CollSeq *p4;
28235573356Sdrh 
28335573356Sdrh   p4 = sqlite3BinaryCompareCollSeq(pParse, pLeft, pRight);
28435573356Sdrh   p5 = binaryCompareP5(pLeft, pRight, jumpIfNull);
28535573356Sdrh   addr = sqlite3VdbeAddOp4(pParse->pVdbe, opcode, in2, dest, in1,
28635573356Sdrh                            (void*)p4, P4_COLLSEQ);
2871bd10f8aSdrh   sqlite3VdbeChangeP5(pParse->pVdbe, (u8)p5);
28835573356Sdrh   return addr;
289be5c89acSdrh }
290be5c89acSdrh 
2914b5255acSdanielk1977 #if SQLITE_MAX_EXPR_DEPTH>0
2924b5255acSdanielk1977 /*
2934b5255acSdanielk1977 ** Check that argument nHeight is less than or equal to the maximum
2944b5255acSdanielk1977 ** expression depth allowed. If it is not, leave an error message in
2954b5255acSdanielk1977 ** pParse.
2964b5255acSdanielk1977 */
2977d10d5a6Sdrh int sqlite3ExprCheckHeight(Parse *pParse, int nHeight){
2984b5255acSdanielk1977   int rc = SQLITE_OK;
2994b5255acSdanielk1977   int mxHeight = pParse->db->aLimit[SQLITE_LIMIT_EXPR_DEPTH];
3004b5255acSdanielk1977   if( nHeight>mxHeight ){
3014b5255acSdanielk1977     sqlite3ErrorMsg(pParse,
3024b5255acSdanielk1977        "Expression tree is too large (maximum depth %d)", mxHeight
3034b5255acSdanielk1977     );
3044b5255acSdanielk1977     rc = SQLITE_ERROR;
3054b5255acSdanielk1977   }
3064b5255acSdanielk1977   return rc;
3074b5255acSdanielk1977 }
3084b5255acSdanielk1977 
3094b5255acSdanielk1977 /* The following three functions, heightOfExpr(), heightOfExprList()
3104b5255acSdanielk1977 ** and heightOfSelect(), are used to determine the maximum height
3114b5255acSdanielk1977 ** of any expression tree referenced by the structure passed as the
3124b5255acSdanielk1977 ** first argument.
3134b5255acSdanielk1977 **
3144b5255acSdanielk1977 ** If this maximum height is greater than the current value pointed
3154b5255acSdanielk1977 ** to by pnHeight, the second parameter, then set *pnHeight to that
3164b5255acSdanielk1977 ** value.
3174b5255acSdanielk1977 */
3184b5255acSdanielk1977 static void heightOfExpr(Expr *p, int *pnHeight){
3194b5255acSdanielk1977   if( p ){
3204b5255acSdanielk1977     if( p->nHeight>*pnHeight ){
3214b5255acSdanielk1977       *pnHeight = p->nHeight;
3224b5255acSdanielk1977     }
3234b5255acSdanielk1977   }
3244b5255acSdanielk1977 }
3254b5255acSdanielk1977 static void heightOfExprList(ExprList *p, int *pnHeight){
3264b5255acSdanielk1977   if( p ){
3274b5255acSdanielk1977     int i;
3284b5255acSdanielk1977     for(i=0; i<p->nExpr; i++){
3294b5255acSdanielk1977       heightOfExpr(p->a[i].pExpr, pnHeight);
3304b5255acSdanielk1977     }
3314b5255acSdanielk1977   }
3324b5255acSdanielk1977 }
3334b5255acSdanielk1977 static void heightOfSelect(Select *p, int *pnHeight){
3344b5255acSdanielk1977   if( p ){
3354b5255acSdanielk1977     heightOfExpr(p->pWhere, pnHeight);
3364b5255acSdanielk1977     heightOfExpr(p->pHaving, pnHeight);
3374b5255acSdanielk1977     heightOfExpr(p->pLimit, pnHeight);
3384b5255acSdanielk1977     heightOfExpr(p->pOffset, pnHeight);
3394b5255acSdanielk1977     heightOfExprList(p->pEList, pnHeight);
3404b5255acSdanielk1977     heightOfExprList(p->pGroupBy, pnHeight);
3414b5255acSdanielk1977     heightOfExprList(p->pOrderBy, pnHeight);
3424b5255acSdanielk1977     heightOfSelect(p->pPrior, pnHeight);
3434b5255acSdanielk1977   }
3444b5255acSdanielk1977 }
3454b5255acSdanielk1977 
3464b5255acSdanielk1977 /*
3474b5255acSdanielk1977 ** Set the Expr.nHeight variable in the structure passed as an
3484b5255acSdanielk1977 ** argument. An expression with no children, Expr.pList or
3494b5255acSdanielk1977 ** Expr.pSelect member has a height of 1. Any other expression
3504b5255acSdanielk1977 ** has a height equal to the maximum height of any other
3514b5255acSdanielk1977 ** referenced Expr plus one.
3524b5255acSdanielk1977 */
3534b5255acSdanielk1977 static void exprSetHeight(Expr *p){
3544b5255acSdanielk1977   int nHeight = 0;
3554b5255acSdanielk1977   heightOfExpr(p->pLeft, &nHeight);
3564b5255acSdanielk1977   heightOfExpr(p->pRight, &nHeight);
3576ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_xIsSelect) ){
3586ab3a2ecSdanielk1977     heightOfSelect(p->x.pSelect, &nHeight);
3596ab3a2ecSdanielk1977   }else{
3606ab3a2ecSdanielk1977     heightOfExprList(p->x.pList, &nHeight);
3616ab3a2ecSdanielk1977   }
3624b5255acSdanielk1977   p->nHeight = nHeight + 1;
3634b5255acSdanielk1977 }
3644b5255acSdanielk1977 
3654b5255acSdanielk1977 /*
3664b5255acSdanielk1977 ** Set the Expr.nHeight variable using the exprSetHeight() function. If
3674b5255acSdanielk1977 ** the height is greater than the maximum allowed expression depth,
3684b5255acSdanielk1977 ** leave an error in pParse.
3694b5255acSdanielk1977 */
3704b5255acSdanielk1977 void sqlite3ExprSetHeight(Parse *pParse, Expr *p){
3714b5255acSdanielk1977   exprSetHeight(p);
3727d10d5a6Sdrh   sqlite3ExprCheckHeight(pParse, p->nHeight);
3734b5255acSdanielk1977 }
3744b5255acSdanielk1977 
3754b5255acSdanielk1977 /*
3764b5255acSdanielk1977 ** Return the maximum height of any expression tree referenced
3774b5255acSdanielk1977 ** by the select statement passed as an argument.
3784b5255acSdanielk1977 */
3794b5255acSdanielk1977 int sqlite3SelectExprHeight(Select *p){
3804b5255acSdanielk1977   int nHeight = 0;
3814b5255acSdanielk1977   heightOfSelect(p, &nHeight);
3824b5255acSdanielk1977   return nHeight;
3834b5255acSdanielk1977 }
3844b5255acSdanielk1977 #else
3854b5255acSdanielk1977   #define exprSetHeight(y)
3864b5255acSdanielk1977 #endif /* SQLITE_MAX_EXPR_DEPTH>0 */
3874b5255acSdanielk1977 
388be5c89acSdrh /*
389b7916a78Sdrh ** This routine is the core allocator for Expr nodes.
390b7916a78Sdrh **
391a76b5dfcSdrh ** Construct a new expression node and return a pointer to it.  Memory
392b7916a78Sdrh ** for this node and for the pToken argument is a single allocation
393b7916a78Sdrh ** obtained from sqlite3DbMalloc().  The calling function
394a76b5dfcSdrh ** is responsible for making sure the node eventually gets freed.
395b7916a78Sdrh **
396b7916a78Sdrh ** If dequote is true, then the token (if it exists) is dequoted.
397b7916a78Sdrh ** If dequote is false, no dequoting is performance.  The deQuote
398b7916a78Sdrh ** parameter is ignored if pToken is NULL or if the token does not
399b7916a78Sdrh ** appear to be quoted.  If the quotes were of the form "..." (double-quotes)
400b7916a78Sdrh ** then the EP_DblQuoted flag is set on the expression node.
40133e619fcSdrh **
40233e619fcSdrh ** Special case:  If op==TK_INTEGER and pToken points to a string that
40333e619fcSdrh ** can be translated into a 32-bit integer, then the token is not
40433e619fcSdrh ** stored in u.zToken.  Instead, the integer values is written
40533e619fcSdrh ** into u.iValue and the EP_IntValue flag is set.  No extra storage
40633e619fcSdrh ** is allocated to hold the integer text and the dequote flag is ignored.
407a76b5dfcSdrh */
408b7916a78Sdrh Expr *sqlite3ExprAlloc(
409a1644fd8Sdanielk1977   sqlite3 *db,            /* Handle for sqlite3DbMallocZero() (may be null) */
41017435752Sdrh   int op,                 /* Expression opcode */
411b7916a78Sdrh   const Token *pToken,    /* Token argument.  Might be NULL */
412b7916a78Sdrh   int dequote             /* True to dequote */
41317435752Sdrh ){
414a76b5dfcSdrh   Expr *pNew;
41533e619fcSdrh   int nExtra = 0;
416cf697396Sshane   int iValue = 0;
417b7916a78Sdrh 
418b7916a78Sdrh   if( pToken ){
41933e619fcSdrh     if( op!=TK_INTEGER || pToken->z==0
42033e619fcSdrh           || sqlite3GetInt32(pToken->z, &iValue)==0 ){
421b7916a78Sdrh       nExtra = pToken->n+1;
422d50ffc41Sdrh       assert( iValue>=0 );
42333e619fcSdrh     }
424a76b5dfcSdrh   }
425b7916a78Sdrh   pNew = sqlite3DbMallocZero(db, sizeof(Expr)+nExtra);
426b7916a78Sdrh   if( pNew ){
4271bd10f8aSdrh     pNew->op = (u8)op;
428a58fdfb1Sdanielk1977     pNew->iAgg = -1;
429a76b5dfcSdrh     if( pToken ){
43033e619fcSdrh       if( nExtra==0 ){
43133e619fcSdrh         pNew->flags |= EP_IntValue;
43233e619fcSdrh         pNew->u.iValue = iValue;
43333e619fcSdrh       }else{
434d9da78a2Sdrh         int c;
43533e619fcSdrh         pNew->u.zToken = (char*)&pNew[1];
436b07028f7Sdrh         assert( pToken->z!=0 || pToken->n==0 );
437b07028f7Sdrh         if( pToken->n ) memcpy(pNew->u.zToken, pToken->z, pToken->n);
43833e619fcSdrh         pNew->u.zToken[pToken->n] = 0;
439b7916a78Sdrh         if( dequote && nExtra>=3
440d9da78a2Sdrh              && ((c = pToken->z[0])=='\'' || c=='"' || c=='[' || c=='`') ){
44133e619fcSdrh           sqlite3Dequote(pNew->u.zToken);
44224fb627aSdrh           if( c=='"' ) pNew->flags |= EP_DblQuoted;
443a34001c9Sdrh         }
444a34001c9Sdrh       }
44533e619fcSdrh     }
446b7916a78Sdrh #if SQLITE_MAX_EXPR_DEPTH>0
447b7916a78Sdrh     pNew->nHeight = 1;
448b7916a78Sdrh #endif
449a34001c9Sdrh   }
450a76b5dfcSdrh   return pNew;
451a76b5dfcSdrh }
452a76b5dfcSdrh 
453a76b5dfcSdrh /*
454b7916a78Sdrh ** Allocate a new expression node from a zero-terminated token that has
455b7916a78Sdrh ** already been dequoted.
456b7916a78Sdrh */
457b7916a78Sdrh Expr *sqlite3Expr(
458b7916a78Sdrh   sqlite3 *db,            /* Handle for sqlite3DbMallocZero() (may be null) */
459b7916a78Sdrh   int op,                 /* Expression opcode */
460b7916a78Sdrh   const char *zToken      /* Token argument.  Might be NULL */
461b7916a78Sdrh ){
462b7916a78Sdrh   Token x;
463b7916a78Sdrh   x.z = zToken;
464b7916a78Sdrh   x.n = zToken ? sqlite3Strlen30(zToken) : 0;
465b7916a78Sdrh   return sqlite3ExprAlloc(db, op, &x, 0);
466b7916a78Sdrh }
467b7916a78Sdrh 
468b7916a78Sdrh /*
469b7916a78Sdrh ** Attach subtrees pLeft and pRight to the Expr node pRoot.
470b7916a78Sdrh **
471b7916a78Sdrh ** If pRoot==NULL that means that a memory allocation error has occurred.
472b7916a78Sdrh ** In that case, delete the subtrees pLeft and pRight.
473b7916a78Sdrh */
474b7916a78Sdrh void sqlite3ExprAttachSubtrees(
475b7916a78Sdrh   sqlite3 *db,
476b7916a78Sdrh   Expr *pRoot,
477b7916a78Sdrh   Expr *pLeft,
478b7916a78Sdrh   Expr *pRight
479b7916a78Sdrh ){
480b7916a78Sdrh   if( pRoot==0 ){
481b7916a78Sdrh     assert( db->mallocFailed );
482b7916a78Sdrh     sqlite3ExprDelete(db, pLeft);
483b7916a78Sdrh     sqlite3ExprDelete(db, pRight);
484b7916a78Sdrh   }else{
485b7916a78Sdrh     if( pRight ){
486b7916a78Sdrh       pRoot->pRight = pRight;
487ae80ddeaSdrh       pRoot->flags |= EP_Collate & pRight->flags;
488b7916a78Sdrh     }
489b7916a78Sdrh     if( pLeft ){
490b7916a78Sdrh       pRoot->pLeft = pLeft;
491ae80ddeaSdrh       pRoot->flags |= EP_Collate & pLeft->flags;
492b7916a78Sdrh     }
493b7916a78Sdrh     exprSetHeight(pRoot);
494b7916a78Sdrh   }
495b7916a78Sdrh }
496b7916a78Sdrh 
497b7916a78Sdrh /*
498bf664469Sdrh ** Allocate a Expr node which joins as many as two subtrees.
499b7916a78Sdrh **
500bf664469Sdrh ** One or both of the subtrees can be NULL.  Return a pointer to the new
501bf664469Sdrh ** Expr node.  Or, if an OOM error occurs, set pParse->db->mallocFailed,
502bf664469Sdrh ** free the subtrees and return NULL.
503206f3d96Sdrh */
50417435752Sdrh Expr *sqlite3PExpr(
50517435752Sdrh   Parse *pParse,          /* Parsing context */
50617435752Sdrh   int op,                 /* Expression opcode */
50717435752Sdrh   Expr *pLeft,            /* Left operand */
50817435752Sdrh   Expr *pRight,           /* Right operand */
50917435752Sdrh   const Token *pToken     /* Argument token */
51017435752Sdrh ){
5115fb52caaSdrh   Expr *p;
5125fb52caaSdrh   if( op==TK_AND && pLeft && pRight ){
5135fb52caaSdrh     /* Take advantage of short-circuit false optimization for AND */
5145fb52caaSdrh     p = sqlite3ExprAnd(pParse->db, pLeft, pRight);
5155fb52caaSdrh   }else{
5165fb52caaSdrh     p = sqlite3ExprAlloc(pParse->db, op, pToken, 1);
517b7916a78Sdrh     sqlite3ExprAttachSubtrees(pParse->db, p, pLeft, pRight);
5185fb52caaSdrh   }
5192b359bdbSdan   if( p ) {
5202b359bdbSdan     sqlite3ExprCheckHeight(pParse, p->nHeight);
5212b359bdbSdan   }
5224e0cff60Sdrh   return p;
5234e0cff60Sdrh }
5244e0cff60Sdrh 
5254e0cff60Sdrh /*
5265fb52caaSdrh ** Return 1 if an expression must be FALSE in all cases and 0 if the
5275fb52caaSdrh ** expression might be true.  This is an optimization.  If is OK to
5285fb52caaSdrh ** return 0 here even if the expression really is always false (a
5295fb52caaSdrh ** false negative).  But it is a bug to return 1 if the expression
5305fb52caaSdrh ** might be true in some rare circumstances (a false positive.)
5315fb52caaSdrh **
5325fb52caaSdrh ** Note that if the expression is part of conditional for a
5335fb52caaSdrh ** LEFT JOIN, then we cannot determine at compile-time whether or not
5345fb52caaSdrh ** is it true or false, so always return 0.
5355fb52caaSdrh */
5365fb52caaSdrh static int exprAlwaysFalse(Expr *p){
5375fb52caaSdrh   int v = 0;
5385fb52caaSdrh   if( ExprHasProperty(p, EP_FromJoin) ) return 0;
5395fb52caaSdrh   if( !sqlite3ExprIsInteger(p, &v) ) return 0;
5405fb52caaSdrh   return v==0;
5415fb52caaSdrh }
5425fb52caaSdrh 
5435fb52caaSdrh /*
54491bb0eedSdrh ** Join two expressions using an AND operator.  If either expression is
54591bb0eedSdrh ** NULL, then just return the other expression.
5465fb52caaSdrh **
5475fb52caaSdrh ** If one side or the other of the AND is known to be false, then instead
5485fb52caaSdrh ** of returning an AND expression, just return a constant expression with
5495fb52caaSdrh ** a value of false.
55091bb0eedSdrh */
5511e536953Sdanielk1977 Expr *sqlite3ExprAnd(sqlite3 *db, Expr *pLeft, Expr *pRight){
55291bb0eedSdrh   if( pLeft==0 ){
55391bb0eedSdrh     return pRight;
55491bb0eedSdrh   }else if( pRight==0 ){
55591bb0eedSdrh     return pLeft;
5565fb52caaSdrh   }else if( exprAlwaysFalse(pLeft) || exprAlwaysFalse(pRight) ){
5575fb52caaSdrh     sqlite3ExprDelete(db, pLeft);
5585fb52caaSdrh     sqlite3ExprDelete(db, pRight);
5595fb52caaSdrh     return sqlite3ExprAlloc(db, TK_INTEGER, &sqlite3IntTokens[0], 0);
56091bb0eedSdrh   }else{
561b7916a78Sdrh     Expr *pNew = sqlite3ExprAlloc(db, TK_AND, 0, 0);
562b7916a78Sdrh     sqlite3ExprAttachSubtrees(db, pNew, pLeft, pRight);
563b7916a78Sdrh     return pNew;
564a76b5dfcSdrh   }
565a76b5dfcSdrh }
566a76b5dfcSdrh 
567a76b5dfcSdrh /*
568a76b5dfcSdrh ** Construct a new expression node for a function with multiple
569a76b5dfcSdrh ** arguments.
570a76b5dfcSdrh */
57117435752Sdrh Expr *sqlite3ExprFunction(Parse *pParse, ExprList *pList, Token *pToken){
572a76b5dfcSdrh   Expr *pNew;
573633e6d57Sdrh   sqlite3 *db = pParse->db;
5744b202ae2Sdanielk1977   assert( pToken );
575b7916a78Sdrh   pNew = sqlite3ExprAlloc(db, TK_FUNCTION, pToken, 1);
576a76b5dfcSdrh   if( pNew==0 ){
577d9da78a2Sdrh     sqlite3ExprListDelete(db, pList); /* Avoid memory leak when malloc fails */
578a76b5dfcSdrh     return 0;
579a76b5dfcSdrh   }
5806ab3a2ecSdanielk1977   pNew->x.pList = pList;
5816ab3a2ecSdanielk1977   assert( !ExprHasProperty(pNew, EP_xIsSelect) );
5824b5255acSdanielk1977   sqlite3ExprSetHeight(pParse, pNew);
583a76b5dfcSdrh   return pNew;
584a76b5dfcSdrh }
585a76b5dfcSdrh 
586a76b5dfcSdrh /*
587fa6bc000Sdrh ** Assign a variable number to an expression that encodes a wildcard
588fa6bc000Sdrh ** in the original SQL statement.
589fa6bc000Sdrh **
590fa6bc000Sdrh ** Wildcards consisting of a single "?" are assigned the next sequential
591fa6bc000Sdrh ** variable number.
592fa6bc000Sdrh **
593fa6bc000Sdrh ** Wildcards of the form "?nnn" are assigned the number "nnn".  We make
594fa6bc000Sdrh ** sure "nnn" is not too be to avoid a denial of service attack when
595fa6bc000Sdrh ** the SQL statement comes from an external source.
596fa6bc000Sdrh **
59751f49f17Sdrh ** Wildcards of the form ":aaa", "@aaa", or "$aaa" are assigned the same number
598fa6bc000Sdrh ** as the previous instance of the same wildcard.  Or if this is the first
599fa6bc000Sdrh ** instance of the wildcard, the next sequenial variable number is
600fa6bc000Sdrh ** assigned.
601fa6bc000Sdrh */
602fa6bc000Sdrh void sqlite3ExprAssignVarNumber(Parse *pParse, Expr *pExpr){
60317435752Sdrh   sqlite3 *db = pParse->db;
604b7916a78Sdrh   const char *z;
60517435752Sdrh 
606fa6bc000Sdrh   if( pExpr==0 ) return;
607c5cd1249Sdrh   assert( !ExprHasProperty(pExpr, EP_IntValue|EP_Reduced|EP_TokenOnly) );
60833e619fcSdrh   z = pExpr->u.zToken;
609b7916a78Sdrh   assert( z!=0 );
610b7916a78Sdrh   assert( z[0]!=0 );
611b7916a78Sdrh   if( z[1]==0 ){
612fa6bc000Sdrh     /* Wildcard of the form "?".  Assign the next variable number */
613b7916a78Sdrh     assert( z[0]=='?' );
6148677d308Sdrh     pExpr->iColumn = (ynVar)(++pParse->nVar);
615124c0b49Sdrh   }else{
616124c0b49Sdrh     ynVar x = 0;
617124c0b49Sdrh     u32 n = sqlite3Strlen30(z);
618124c0b49Sdrh     if( z[0]=='?' ){
619fa6bc000Sdrh       /* Wildcard of the form "?nnn".  Convert "nnn" to an integer and
620fa6bc000Sdrh       ** use it as the variable number */
621c8d735aeSdan       i64 i;
622124c0b49Sdrh       int bOk = 0==sqlite3Atoi64(&z[1], &i, n-1, SQLITE_UTF8);
623124c0b49Sdrh       pExpr->iColumn = x = (ynVar)i;
624c5499befSdrh       testcase( i==0 );
625c5499befSdrh       testcase( i==1 );
626c5499befSdrh       testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]-1 );
627c5499befSdrh       testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] );
628c8d735aeSdan       if( bOk==0 || i<1 || i>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
629fa6bc000Sdrh         sqlite3ErrorMsg(pParse, "variable number must be between ?1 and ?%d",
630bb4957f8Sdrh             db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]);
631124c0b49Sdrh         x = 0;
632fa6bc000Sdrh       }
633fa6bc000Sdrh       if( i>pParse->nVar ){
6341df2db7fSshaneh         pParse->nVar = (int)i;
635fa6bc000Sdrh       }
636fa6bc000Sdrh     }else{
63751f49f17Sdrh       /* Wildcards like ":aaa", "$aaa" or "@aaa".  Reuse the same variable
638fa6bc000Sdrh       ** number as the prior appearance of the same name, or if the name
639fa6bc000Sdrh       ** has never appeared before, reuse the same variable number
640fa6bc000Sdrh       */
641124c0b49Sdrh       ynVar i;
642124c0b49Sdrh       for(i=0; i<pParse->nzVar; i++){
643503a686eSdrh         if( pParse->azVar[i] && strcmp(pParse->azVar[i],z)==0 ){
644124c0b49Sdrh           pExpr->iColumn = x = (ynVar)i+1;
645fa6bc000Sdrh           break;
646fa6bc000Sdrh         }
647fa6bc000Sdrh       }
648124c0b49Sdrh       if( x==0 ) x = pExpr->iColumn = (ynVar)(++pParse->nVar);
649fa6bc000Sdrh     }
650124c0b49Sdrh     if( x>0 ){
651124c0b49Sdrh       if( x>pParse->nzVar ){
652124c0b49Sdrh         char **a;
653124c0b49Sdrh         a = sqlite3DbRealloc(db, pParse->azVar, x*sizeof(a[0]));
654124c0b49Sdrh         if( a==0 ) return;  /* Error reported through db->mallocFailed */
655124c0b49Sdrh         pParse->azVar = a;
656124c0b49Sdrh         memset(&a[pParse->nzVar], 0, (x-pParse->nzVar)*sizeof(a[0]));
657124c0b49Sdrh         pParse->nzVar = x;
658124c0b49Sdrh       }
659124c0b49Sdrh       if( z[0]!='?' || pParse->azVar[x-1]==0 ){
660124c0b49Sdrh         sqlite3DbFree(db, pParse->azVar[x-1]);
661124c0b49Sdrh         pParse->azVar[x-1] = sqlite3DbStrNDup(db, z, n);
662fa6bc000Sdrh       }
663fa6bc000Sdrh     }
664fa6bc000Sdrh   }
665bb4957f8Sdrh   if( !pParse->nErr && pParse->nVar>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
666832b2664Sdanielk1977     sqlite3ErrorMsg(pParse, "too many SQL variables");
667832b2664Sdanielk1977   }
668fa6bc000Sdrh }
669fa6bc000Sdrh 
670fa6bc000Sdrh /*
671f6963f99Sdan ** Recursively delete an expression tree.
672a2e00042Sdrh */
673f6963f99Sdan void sqlite3ExprDelete(sqlite3 *db, Expr *p){
674f6963f99Sdan   if( p==0 ) return;
675d50ffc41Sdrh   /* Sanity check: Assert that the IntValue is non-negative if it exists */
676d50ffc41Sdrh   assert( !ExprHasProperty(p, EP_IntValue) || p->u.iValue>=0 );
677c5cd1249Sdrh   if( !ExprHasProperty(p, EP_TokenOnly) ){
678c5cd1249Sdrh     /* The Expr.x union is never used at the same time as Expr.pRight */
679c5cd1249Sdrh     assert( p->x.pList==0 || p->pRight==0 );
680633e6d57Sdrh     sqlite3ExprDelete(db, p->pLeft);
681633e6d57Sdrh     sqlite3ExprDelete(db, p->pRight);
682c5cd1249Sdrh     if( ExprHasProperty(p, EP_MemToken) ) sqlite3DbFree(db, p->u.zToken);
6836ab3a2ecSdanielk1977     if( ExprHasProperty(p, EP_xIsSelect) ){
6846ab3a2ecSdanielk1977       sqlite3SelectDelete(db, p->x.pSelect);
6856ab3a2ecSdanielk1977     }else{
6866ab3a2ecSdanielk1977       sqlite3ExprListDelete(db, p->x.pList);
6876ab3a2ecSdanielk1977     }
6886ab3a2ecSdanielk1977   }
68933e619fcSdrh   if( !ExprHasProperty(p, EP_Static) ){
690633e6d57Sdrh     sqlite3DbFree(db, p);
691a2e00042Sdrh   }
69233e619fcSdrh }
693a2e00042Sdrh 
694d2687b77Sdrh /*
6956ab3a2ecSdanielk1977 ** Return the number of bytes allocated for the expression structure
6966ab3a2ecSdanielk1977 ** passed as the first argument. This is always one of EXPR_FULLSIZE,
6976ab3a2ecSdanielk1977 ** EXPR_REDUCEDSIZE or EXPR_TOKENONLYSIZE.
6986ab3a2ecSdanielk1977 */
6996ab3a2ecSdanielk1977 static int exprStructSize(Expr *p){
7006ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_TokenOnly) ) return EXPR_TOKENONLYSIZE;
7016ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_Reduced) ) return EXPR_REDUCEDSIZE;
7026ab3a2ecSdanielk1977   return EXPR_FULLSIZE;
7036ab3a2ecSdanielk1977 }
7046ab3a2ecSdanielk1977 
7056ab3a2ecSdanielk1977 /*
70633e619fcSdrh ** The dupedExpr*Size() routines each return the number of bytes required
70733e619fcSdrh ** to store a copy of an expression or expression tree.  They differ in
70833e619fcSdrh ** how much of the tree is measured.
70933e619fcSdrh **
71033e619fcSdrh **     dupedExprStructSize()     Size of only the Expr structure
71133e619fcSdrh **     dupedExprNodeSize()       Size of Expr + space for token
71233e619fcSdrh **     dupedExprSize()           Expr + token + subtree components
71333e619fcSdrh **
71433e619fcSdrh ***************************************************************************
71533e619fcSdrh **
71633e619fcSdrh ** The dupedExprStructSize() function returns two values OR-ed together:
71733e619fcSdrh ** (1) the space required for a copy of the Expr structure only and
71833e619fcSdrh ** (2) the EP_xxx flags that indicate what the structure size should be.
71933e619fcSdrh ** The return values is always one of:
72033e619fcSdrh **
72133e619fcSdrh **      EXPR_FULLSIZE
72233e619fcSdrh **      EXPR_REDUCEDSIZE   | EP_Reduced
72333e619fcSdrh **      EXPR_TOKENONLYSIZE | EP_TokenOnly
72433e619fcSdrh **
72533e619fcSdrh ** The size of the structure can be found by masking the return value
72633e619fcSdrh ** of this routine with 0xfff.  The flags can be found by masking the
72733e619fcSdrh ** return value with EP_Reduced|EP_TokenOnly.
72833e619fcSdrh **
72933e619fcSdrh ** Note that with flags==EXPRDUP_REDUCE, this routines works on full-size
73033e619fcSdrh ** (unreduced) Expr objects as they or originally constructed by the parser.
73133e619fcSdrh ** During expression analysis, extra information is computed and moved into
73233e619fcSdrh ** later parts of teh Expr object and that extra information might get chopped
73333e619fcSdrh ** off if the expression is reduced.  Note also that it does not work to
73433e619fcSdrh ** make a EXPRDUP_REDUCE copy of a reduced expression.  It is only legal
73533e619fcSdrh ** to reduce a pristine expression tree from the parser.  The implementation
73633e619fcSdrh ** of dupedExprStructSize() contain multiple assert() statements that attempt
73733e619fcSdrh ** to enforce this constraint.
7386ab3a2ecSdanielk1977 */
7396ab3a2ecSdanielk1977 static int dupedExprStructSize(Expr *p, int flags){
7406ab3a2ecSdanielk1977   int nSize;
74133e619fcSdrh   assert( flags==EXPRDUP_REDUCE || flags==0 ); /* Only one flag value allowed */
742aecd8021Sdrh   assert( EXPR_FULLSIZE<=0xfff );
743aecd8021Sdrh   assert( (0xfff & (EP_Reduced|EP_TokenOnly))==0 );
7446ab3a2ecSdanielk1977   if( 0==(flags&EXPRDUP_REDUCE) ){
7456ab3a2ecSdanielk1977     nSize = EXPR_FULLSIZE;
7466ab3a2ecSdanielk1977   }else{
747c5cd1249Sdrh     assert( !ExprHasProperty(p, EP_TokenOnly|EP_Reduced) );
74833e619fcSdrh     assert( !ExprHasProperty(p, EP_FromJoin) );
749c5cd1249Sdrh     assert( !ExprHasProperty(p, EP_MemToken) );
750ebb6a65dSdrh     assert( !ExprHasProperty(p, EP_NoReduce) );
751aecd8021Sdrh     if( p->pLeft || p->x.pList ){
75233e619fcSdrh       nSize = EXPR_REDUCEDSIZE | EP_Reduced;
75333e619fcSdrh     }else{
754aecd8021Sdrh       assert( p->pRight==0 );
75533e619fcSdrh       nSize = EXPR_TOKENONLYSIZE | EP_TokenOnly;
75633e619fcSdrh     }
7576ab3a2ecSdanielk1977   }
7586ab3a2ecSdanielk1977   return nSize;
7596ab3a2ecSdanielk1977 }
7606ab3a2ecSdanielk1977 
7616ab3a2ecSdanielk1977 /*
76233e619fcSdrh ** This function returns the space in bytes required to store the copy
76333e619fcSdrh ** of the Expr structure and a copy of the Expr.u.zToken string (if that
76433e619fcSdrh ** string is defined.)
7656ab3a2ecSdanielk1977 */
7666ab3a2ecSdanielk1977 static int dupedExprNodeSize(Expr *p, int flags){
76733e619fcSdrh   int nByte = dupedExprStructSize(p, flags) & 0xfff;
76833e619fcSdrh   if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
76933e619fcSdrh     nByte += sqlite3Strlen30(p->u.zToken)+1;
7706ab3a2ecSdanielk1977   }
771bc73971dSdanielk1977   return ROUND8(nByte);
7726ab3a2ecSdanielk1977 }
7736ab3a2ecSdanielk1977 
7746ab3a2ecSdanielk1977 /*
7756ab3a2ecSdanielk1977 ** Return the number of bytes required to create a duplicate of the
7766ab3a2ecSdanielk1977 ** expression passed as the first argument. The second argument is a
7776ab3a2ecSdanielk1977 ** mask containing EXPRDUP_XXX flags.
7786ab3a2ecSdanielk1977 **
7796ab3a2ecSdanielk1977 ** The value returned includes space to create a copy of the Expr struct
78033e619fcSdrh ** itself and the buffer referred to by Expr.u.zToken, if any.
7816ab3a2ecSdanielk1977 **
7826ab3a2ecSdanielk1977 ** If the EXPRDUP_REDUCE flag is set, then the return value includes
7836ab3a2ecSdanielk1977 ** space to duplicate all Expr nodes in the tree formed by Expr.pLeft
7846ab3a2ecSdanielk1977 ** and Expr.pRight variables (but not for any structures pointed to or
7856ab3a2ecSdanielk1977 ** descended from the Expr.x.pList or Expr.x.pSelect variables).
7866ab3a2ecSdanielk1977 */
7876ab3a2ecSdanielk1977 static int dupedExprSize(Expr *p, int flags){
7886ab3a2ecSdanielk1977   int nByte = 0;
7896ab3a2ecSdanielk1977   if( p ){
7906ab3a2ecSdanielk1977     nByte = dupedExprNodeSize(p, flags);
7916ab3a2ecSdanielk1977     if( flags&EXPRDUP_REDUCE ){
792b7916a78Sdrh       nByte += dupedExprSize(p->pLeft, flags) + dupedExprSize(p->pRight, flags);
7936ab3a2ecSdanielk1977     }
7946ab3a2ecSdanielk1977   }
7956ab3a2ecSdanielk1977   return nByte;
7966ab3a2ecSdanielk1977 }
7976ab3a2ecSdanielk1977 
7986ab3a2ecSdanielk1977 /*
7996ab3a2ecSdanielk1977 ** This function is similar to sqlite3ExprDup(), except that if pzBuffer
8006ab3a2ecSdanielk1977 ** is not NULL then *pzBuffer is assumed to point to a buffer large enough
80133e619fcSdrh ** to store the copy of expression p, the copies of p->u.zToken
8026ab3a2ecSdanielk1977 ** (if applicable), and the copies of the p->pLeft and p->pRight expressions,
8036ab3a2ecSdanielk1977 ** if any. Before returning, *pzBuffer is set to the first byte passed the
8046ab3a2ecSdanielk1977 ** portion of the buffer copied into by this function.
8056ab3a2ecSdanielk1977 */
8066ab3a2ecSdanielk1977 static Expr *exprDup(sqlite3 *db, Expr *p, int flags, u8 **pzBuffer){
8076ab3a2ecSdanielk1977   Expr *pNew = 0;                      /* Value to return */
8086ab3a2ecSdanielk1977   if( p ){
8096ab3a2ecSdanielk1977     const int isReduced = (flags&EXPRDUP_REDUCE);
8106ab3a2ecSdanielk1977     u8 *zAlloc;
81133e619fcSdrh     u32 staticFlag = 0;
8126ab3a2ecSdanielk1977 
8136ab3a2ecSdanielk1977     assert( pzBuffer==0 || isReduced );
8146ab3a2ecSdanielk1977 
8156ab3a2ecSdanielk1977     /* Figure out where to write the new Expr structure. */
8166ab3a2ecSdanielk1977     if( pzBuffer ){
8176ab3a2ecSdanielk1977       zAlloc = *pzBuffer;
81833e619fcSdrh       staticFlag = EP_Static;
8196ab3a2ecSdanielk1977     }else{
8206ab3a2ecSdanielk1977       zAlloc = sqlite3DbMallocRaw(db, dupedExprSize(p, flags));
8216ab3a2ecSdanielk1977     }
8226ab3a2ecSdanielk1977     pNew = (Expr *)zAlloc;
8236ab3a2ecSdanielk1977 
8246ab3a2ecSdanielk1977     if( pNew ){
8256ab3a2ecSdanielk1977       /* Set nNewSize to the size allocated for the structure pointed to
8266ab3a2ecSdanielk1977       ** by pNew. This is either EXPR_FULLSIZE, EXPR_REDUCEDSIZE or
8276ab3a2ecSdanielk1977       ** EXPR_TOKENONLYSIZE. nToken is set to the number of bytes consumed
82833e619fcSdrh       ** by the copy of the p->u.zToken string (if any).
8296ab3a2ecSdanielk1977       */
83033e619fcSdrh       const unsigned nStructSize = dupedExprStructSize(p, flags);
83133e619fcSdrh       const int nNewSize = nStructSize & 0xfff;
83233e619fcSdrh       int nToken;
83333e619fcSdrh       if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
83433e619fcSdrh         nToken = sqlite3Strlen30(p->u.zToken) + 1;
83533e619fcSdrh       }else{
83633e619fcSdrh         nToken = 0;
83733e619fcSdrh       }
8386ab3a2ecSdanielk1977       if( isReduced ){
8396ab3a2ecSdanielk1977         assert( ExprHasProperty(p, EP_Reduced)==0 );
8406ab3a2ecSdanielk1977         memcpy(zAlloc, p, nNewSize);
8416ab3a2ecSdanielk1977       }else{
8426ab3a2ecSdanielk1977         int nSize = exprStructSize(p);
8436ab3a2ecSdanielk1977         memcpy(zAlloc, p, nSize);
8446ab3a2ecSdanielk1977         memset(&zAlloc[nSize], 0, EXPR_FULLSIZE-nSize);
8456ab3a2ecSdanielk1977       }
8466ab3a2ecSdanielk1977 
84733e619fcSdrh       /* Set the EP_Reduced, EP_TokenOnly, and EP_Static flags appropriately. */
848c5cd1249Sdrh       pNew->flags &= ~(EP_Reduced|EP_TokenOnly|EP_Static|EP_MemToken);
84933e619fcSdrh       pNew->flags |= nStructSize & (EP_Reduced|EP_TokenOnly);
85033e619fcSdrh       pNew->flags |= staticFlag;
8516ab3a2ecSdanielk1977 
85233e619fcSdrh       /* Copy the p->u.zToken string, if any. */
8536ab3a2ecSdanielk1977       if( nToken ){
85433e619fcSdrh         char *zToken = pNew->u.zToken = (char*)&zAlloc[nNewSize];
85533e619fcSdrh         memcpy(zToken, p->u.zToken, nToken);
8566ab3a2ecSdanielk1977       }
8576ab3a2ecSdanielk1977 
8586ab3a2ecSdanielk1977       if( 0==((p->flags|pNew->flags) & EP_TokenOnly) ){
8596ab3a2ecSdanielk1977         /* Fill in the pNew->x.pSelect or pNew->x.pList member. */
8606ab3a2ecSdanielk1977         if( ExprHasProperty(p, EP_xIsSelect) ){
8616ab3a2ecSdanielk1977           pNew->x.pSelect = sqlite3SelectDup(db, p->x.pSelect, isReduced);
8626ab3a2ecSdanielk1977         }else{
8636ab3a2ecSdanielk1977           pNew->x.pList = sqlite3ExprListDup(db, p->x.pList, isReduced);
8646ab3a2ecSdanielk1977         }
8656ab3a2ecSdanielk1977       }
8666ab3a2ecSdanielk1977 
8676ab3a2ecSdanielk1977       /* Fill in pNew->pLeft and pNew->pRight. */
868c5cd1249Sdrh       if( ExprHasProperty(pNew, EP_Reduced|EP_TokenOnly) ){
8696ab3a2ecSdanielk1977         zAlloc += dupedExprNodeSize(p, flags);
8706ab3a2ecSdanielk1977         if( ExprHasProperty(pNew, EP_Reduced) ){
8716ab3a2ecSdanielk1977           pNew->pLeft = exprDup(db, p->pLeft, EXPRDUP_REDUCE, &zAlloc);
8726ab3a2ecSdanielk1977           pNew->pRight = exprDup(db, p->pRight, EXPRDUP_REDUCE, &zAlloc);
8736ab3a2ecSdanielk1977         }
8746ab3a2ecSdanielk1977         if( pzBuffer ){
8756ab3a2ecSdanielk1977           *pzBuffer = zAlloc;
8766ab3a2ecSdanielk1977         }
877b7916a78Sdrh       }else{
878c5cd1249Sdrh         if( !ExprHasProperty(p, EP_TokenOnly) ){
8796ab3a2ecSdanielk1977           pNew->pLeft = sqlite3ExprDup(db, p->pLeft, 0);
8806ab3a2ecSdanielk1977           pNew->pRight = sqlite3ExprDup(db, p->pRight, 0);
8816ab3a2ecSdanielk1977         }
8826ab3a2ecSdanielk1977       }
883b7916a78Sdrh 
884b7916a78Sdrh     }
8856ab3a2ecSdanielk1977   }
8866ab3a2ecSdanielk1977   return pNew;
8876ab3a2ecSdanielk1977 }
8886ab3a2ecSdanielk1977 
8896ab3a2ecSdanielk1977 /*
890ff78bd2fSdrh ** The following group of routines make deep copies of expressions,
891ff78bd2fSdrh ** expression lists, ID lists, and select statements.  The copies can
892ff78bd2fSdrh ** be deleted (by being passed to their respective ...Delete() routines)
893ff78bd2fSdrh ** without effecting the originals.
894ff78bd2fSdrh **
8954adee20fSdanielk1977 ** The expression list, ID, and source lists return by sqlite3ExprListDup(),
8964adee20fSdanielk1977 ** sqlite3IdListDup(), and sqlite3SrcListDup() can not be further expanded
897ad3cab52Sdrh ** by subsequent calls to sqlite*ListAppend() routines.
898ff78bd2fSdrh **
899ad3cab52Sdrh ** Any tables that the SrcList might point to are not duplicated.
9006ab3a2ecSdanielk1977 **
901b7916a78Sdrh ** The flags parameter contains a combination of the EXPRDUP_XXX flags.
9026ab3a2ecSdanielk1977 ** If the EXPRDUP_REDUCE flag is set, then the structure returned is a
9036ab3a2ecSdanielk1977 ** truncated version of the usual Expr structure that will be stored as
9046ab3a2ecSdanielk1977 ** part of the in-memory representation of the database schema.
905ff78bd2fSdrh */
9066ab3a2ecSdanielk1977 Expr *sqlite3ExprDup(sqlite3 *db, Expr *p, int flags){
9076ab3a2ecSdanielk1977   return exprDup(db, p, flags, 0);
908ff78bd2fSdrh }
9096ab3a2ecSdanielk1977 ExprList *sqlite3ExprListDup(sqlite3 *db, ExprList *p, int flags){
910ff78bd2fSdrh   ExprList *pNew;
911145716b3Sdrh   struct ExprList_item *pItem, *pOldItem;
912ff78bd2fSdrh   int i;
913ff78bd2fSdrh   if( p==0 ) return 0;
91417435752Sdrh   pNew = sqlite3DbMallocRaw(db, sizeof(*pNew) );
915ff78bd2fSdrh   if( pNew==0 ) return 0;
91631dad9daSdanielk1977   pNew->iECursor = 0;
917d872bb18Sdrh   pNew->nExpr = i = p->nExpr;
918d872bb18Sdrh   if( (flags & EXPRDUP_REDUCE)==0 ) for(i=1; i<p->nExpr; i+=i){}
919d872bb18Sdrh   pNew->a = pItem = sqlite3DbMallocRaw(db,  i*sizeof(p->a[0]) );
920e0048400Sdanielk1977   if( pItem==0 ){
921633e6d57Sdrh     sqlite3DbFree(db, pNew);
922e0048400Sdanielk1977     return 0;
923e0048400Sdanielk1977   }
924145716b3Sdrh   pOldItem = p->a;
925145716b3Sdrh   for(i=0; i<p->nExpr; i++, pItem++, pOldItem++){
9266ab3a2ecSdanielk1977     Expr *pOldExpr = pOldItem->pExpr;
927b5526ea6Sdrh     pItem->pExpr = sqlite3ExprDup(db, pOldExpr, flags);
92817435752Sdrh     pItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
929b7916a78Sdrh     pItem->zSpan = sqlite3DbStrDup(db, pOldItem->zSpan);
930145716b3Sdrh     pItem->sortOrder = pOldItem->sortOrder;
9313e7bc9caSdrh     pItem->done = 0;
9322c036cffSdrh     pItem->bSpanIsTab = pOldItem->bSpanIsTab;
9334b3ac73cSdrh     pItem->iOrderByCol = pOldItem->iOrderByCol;
9348b213899Sdrh     pItem->iAlias = pOldItem->iAlias;
935ff78bd2fSdrh   }
936ff78bd2fSdrh   return pNew;
937ff78bd2fSdrh }
93893758c8dSdanielk1977 
93993758c8dSdanielk1977 /*
94093758c8dSdanielk1977 ** If cursors, triggers, views and subqueries are all omitted from
94193758c8dSdanielk1977 ** the build, then none of the following routines, except for
94293758c8dSdanielk1977 ** sqlite3SelectDup(), can be called. sqlite3SelectDup() is sometimes
94393758c8dSdanielk1977 ** called with a NULL argument.
94493758c8dSdanielk1977 */
9456a67fe8eSdanielk1977 #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_TRIGGER) \
9466a67fe8eSdanielk1977  || !defined(SQLITE_OMIT_SUBQUERY)
9476ab3a2ecSdanielk1977 SrcList *sqlite3SrcListDup(sqlite3 *db, SrcList *p, int flags){
948ad3cab52Sdrh   SrcList *pNew;
949ad3cab52Sdrh   int i;
950113088ecSdrh   int nByte;
951ad3cab52Sdrh   if( p==0 ) return 0;
952113088ecSdrh   nByte = sizeof(*p) + (p->nSrc>0 ? sizeof(p->a[0]) * (p->nSrc-1) : 0);
95317435752Sdrh   pNew = sqlite3DbMallocRaw(db, nByte );
954ad3cab52Sdrh   if( pNew==0 ) return 0;
9554305d103Sdrh   pNew->nSrc = pNew->nAlloc = p->nSrc;
956ad3cab52Sdrh   for(i=0; i<p->nSrc; i++){
9574efc4754Sdrh     struct SrcList_item *pNewItem = &pNew->a[i];
9584efc4754Sdrh     struct SrcList_item *pOldItem = &p->a[i];
959ed8a3bb1Sdrh     Table *pTab;
96041fb5cd1Sdan     pNewItem->pSchema = pOldItem->pSchema;
96117435752Sdrh     pNewItem->zDatabase = sqlite3DbStrDup(db, pOldItem->zDatabase);
96217435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
96317435752Sdrh     pNewItem->zAlias = sqlite3DbStrDup(db, pOldItem->zAlias);
9644efc4754Sdrh     pNewItem->jointype = pOldItem->jointype;
9654efc4754Sdrh     pNewItem->iCursor = pOldItem->iCursor;
9665b6a9ed4Sdrh     pNewItem->addrFillSub = pOldItem->addrFillSub;
9675b6a9ed4Sdrh     pNewItem->regReturn = pOldItem->regReturn;
968da79cf0cSdan     pNewItem->isCorrelated = pOldItem->isCorrelated;
96921172c4cSdrh     pNewItem->viaCoroutine = pOldItem->viaCoroutine;
97085574e31Sdanielk1977     pNewItem->zIndex = sqlite3DbStrDup(db, pOldItem->zIndex);
97185574e31Sdanielk1977     pNewItem->notIndexed = pOldItem->notIndexed;
97285574e31Sdanielk1977     pNewItem->pIndex = pOldItem->pIndex;
973ed8a3bb1Sdrh     pTab = pNewItem->pTab = pOldItem->pTab;
974ed8a3bb1Sdrh     if( pTab ){
975ed8a3bb1Sdrh       pTab->nRef++;
976a1cb183dSdanielk1977     }
9776ab3a2ecSdanielk1977     pNewItem->pSelect = sqlite3SelectDup(db, pOldItem->pSelect, flags);
9786ab3a2ecSdanielk1977     pNewItem->pOn = sqlite3ExprDup(db, pOldItem->pOn, flags);
97917435752Sdrh     pNewItem->pUsing = sqlite3IdListDup(db, pOldItem->pUsing);
9806c18b6e0Sdanielk1977     pNewItem->colUsed = pOldItem->colUsed;
981ad3cab52Sdrh   }
982ad3cab52Sdrh   return pNew;
983ad3cab52Sdrh }
98417435752Sdrh IdList *sqlite3IdListDup(sqlite3 *db, IdList *p){
985ff78bd2fSdrh   IdList *pNew;
986ff78bd2fSdrh   int i;
987ff78bd2fSdrh   if( p==0 ) return 0;
98817435752Sdrh   pNew = sqlite3DbMallocRaw(db, sizeof(*pNew) );
989ff78bd2fSdrh   if( pNew==0 ) return 0;
9906c535158Sdrh   pNew->nId = p->nId;
99117435752Sdrh   pNew->a = sqlite3DbMallocRaw(db, p->nId*sizeof(p->a[0]) );
992d5d56523Sdanielk1977   if( pNew->a==0 ){
993633e6d57Sdrh     sqlite3DbFree(db, pNew);
994d5d56523Sdanielk1977     return 0;
995d5d56523Sdanielk1977   }
9966c535158Sdrh   /* Note that because the size of the allocation for p->a[] is not
9976c535158Sdrh   ** necessarily a power of two, sqlite3IdListAppend() may not be called
9986c535158Sdrh   ** on the duplicate created by this function. */
999ff78bd2fSdrh   for(i=0; i<p->nId; i++){
10004efc4754Sdrh     struct IdList_item *pNewItem = &pNew->a[i];
10014efc4754Sdrh     struct IdList_item *pOldItem = &p->a[i];
100217435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
10034efc4754Sdrh     pNewItem->idx = pOldItem->idx;
1004ff78bd2fSdrh   }
1005ff78bd2fSdrh   return pNew;
1006ff78bd2fSdrh }
10076ab3a2ecSdanielk1977 Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
100823b1b372Sdrh   Select *pNew, *pPrior;
1009ff78bd2fSdrh   if( p==0 ) return 0;
101017435752Sdrh   pNew = sqlite3DbMallocRaw(db, sizeof(*p) );
1011ff78bd2fSdrh   if( pNew==0 ) return 0;
1012b7916a78Sdrh   pNew->pEList = sqlite3ExprListDup(db, p->pEList, flags);
10136ab3a2ecSdanielk1977   pNew->pSrc = sqlite3SrcListDup(db, p->pSrc, flags);
10146ab3a2ecSdanielk1977   pNew->pWhere = sqlite3ExprDup(db, p->pWhere, flags);
10156ab3a2ecSdanielk1977   pNew->pGroupBy = sqlite3ExprListDup(db, p->pGroupBy, flags);
10166ab3a2ecSdanielk1977   pNew->pHaving = sqlite3ExprDup(db, p->pHaving, flags);
10176ab3a2ecSdanielk1977   pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, flags);
1018ff78bd2fSdrh   pNew->op = p->op;
101923b1b372Sdrh   pNew->pPrior = pPrior = sqlite3SelectDup(db, p->pPrior, flags);
102023b1b372Sdrh   if( pPrior ) pPrior->pNext = pNew;
102123b1b372Sdrh   pNew->pNext = 0;
10226ab3a2ecSdanielk1977   pNew->pLimit = sqlite3ExprDup(db, p->pLimit, flags);
10236ab3a2ecSdanielk1977   pNew->pOffset = sqlite3ExprDup(db, p->pOffset, flags);
102492b01d53Sdrh   pNew->iLimit = 0;
102592b01d53Sdrh   pNew->iOffset = 0;
10267d10d5a6Sdrh   pNew->selFlags = p->selFlags & ~SF_UsesEphemeral;
10270342b1f5Sdrh   pNew->pRightmost = 0;
1028b9bb7c18Sdrh   pNew->addrOpenEphm[0] = -1;
1029b9bb7c18Sdrh   pNew->addrOpenEphm[1] = -1;
1030b9bb7c18Sdrh   pNew->addrOpenEphm[2] = -1;
1031ff78bd2fSdrh   return pNew;
1032ff78bd2fSdrh }
103393758c8dSdanielk1977 #else
10346ab3a2ecSdanielk1977 Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
103593758c8dSdanielk1977   assert( p==0 );
103693758c8dSdanielk1977   return 0;
103793758c8dSdanielk1977 }
103893758c8dSdanielk1977 #endif
1039ff78bd2fSdrh 
1040ff78bd2fSdrh 
1041ff78bd2fSdrh /*
1042a76b5dfcSdrh ** Add a new element to the end of an expression list.  If pList is
1043a76b5dfcSdrh ** initially NULL, then create a new expression list.
1044b7916a78Sdrh **
1045b7916a78Sdrh ** If a memory allocation error occurs, the entire list is freed and
1046b7916a78Sdrh ** NULL is returned.  If non-NULL is returned, then it is guaranteed
1047b7916a78Sdrh ** that the new entry was successfully appended.
1048a76b5dfcSdrh */
104917435752Sdrh ExprList *sqlite3ExprListAppend(
105017435752Sdrh   Parse *pParse,          /* Parsing context */
105117435752Sdrh   ExprList *pList,        /* List to which to append. Might be NULL */
1052b7916a78Sdrh   Expr *pExpr             /* Expression to be appended. Might be NULL */
105317435752Sdrh ){
105417435752Sdrh   sqlite3 *db = pParse->db;
1055a76b5dfcSdrh   if( pList==0 ){
105617435752Sdrh     pList = sqlite3DbMallocZero(db, sizeof(ExprList) );
1057a76b5dfcSdrh     if( pList==0 ){
1058d5d56523Sdanielk1977       goto no_mem;
1059a76b5dfcSdrh     }
1060d872bb18Sdrh     pList->a = sqlite3DbMallocRaw(db, sizeof(pList->a[0]));
1061d872bb18Sdrh     if( pList->a==0 ) goto no_mem;
1062d872bb18Sdrh   }else if( (pList->nExpr & (pList->nExpr-1))==0 ){
1063d5d56523Sdanielk1977     struct ExprList_item *a;
1064d872bb18Sdrh     assert( pList->nExpr>0 );
1065d872bb18Sdrh     a = sqlite3DbRealloc(db, pList->a, pList->nExpr*2*sizeof(pList->a[0]));
1066d5d56523Sdanielk1977     if( a==0 ){
1067d5d56523Sdanielk1977       goto no_mem;
1068a76b5dfcSdrh     }
1069d5d56523Sdanielk1977     pList->a = a;
1070a76b5dfcSdrh   }
10714efc4754Sdrh   assert( pList->a!=0 );
1072b7916a78Sdrh   if( 1 ){
10734efc4754Sdrh     struct ExprList_item *pItem = &pList->a[pList->nExpr++];
10744efc4754Sdrh     memset(pItem, 0, sizeof(*pItem));
1075e94ddc9eSdanielk1977     pItem->pExpr = pExpr;
1076a76b5dfcSdrh   }
1077a76b5dfcSdrh   return pList;
1078d5d56523Sdanielk1977 
1079d5d56523Sdanielk1977 no_mem:
1080d5d56523Sdanielk1977   /* Avoid leaking memory if malloc has failed. */
1081633e6d57Sdrh   sqlite3ExprDelete(db, pExpr);
1082633e6d57Sdrh   sqlite3ExprListDelete(db, pList);
1083d5d56523Sdanielk1977   return 0;
1084a76b5dfcSdrh }
1085a76b5dfcSdrh 
1086a76b5dfcSdrh /*
1087b7916a78Sdrh ** Set the ExprList.a[].zName element of the most recently added item
1088b7916a78Sdrh ** on the expression list.
1089b7916a78Sdrh **
1090b7916a78Sdrh ** pList might be NULL following an OOM error.  But pName should never be
1091b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1092b7916a78Sdrh ** is set.
1093b7916a78Sdrh */
1094b7916a78Sdrh void sqlite3ExprListSetName(
1095b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1096b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
1097b7916a78Sdrh   Token *pName,           /* Name to be added */
1098b7916a78Sdrh   int dequote             /* True to cause the name to be dequoted */
1099b7916a78Sdrh ){
1100b7916a78Sdrh   assert( pList!=0 || pParse->db->mallocFailed!=0 );
1101b7916a78Sdrh   if( pList ){
1102b7916a78Sdrh     struct ExprList_item *pItem;
1103b7916a78Sdrh     assert( pList->nExpr>0 );
1104b7916a78Sdrh     pItem = &pList->a[pList->nExpr-1];
1105b7916a78Sdrh     assert( pItem->zName==0 );
1106b7916a78Sdrh     pItem->zName = sqlite3DbStrNDup(pParse->db, pName->z, pName->n);
1107b7916a78Sdrh     if( dequote && pItem->zName ) sqlite3Dequote(pItem->zName);
1108b7916a78Sdrh   }
1109b7916a78Sdrh }
1110b7916a78Sdrh 
1111b7916a78Sdrh /*
1112b7916a78Sdrh ** Set the ExprList.a[].zSpan element of the most recently added item
1113b7916a78Sdrh ** on the expression list.
1114b7916a78Sdrh **
1115b7916a78Sdrh ** pList might be NULL following an OOM error.  But pSpan should never be
1116b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1117b7916a78Sdrh ** is set.
1118b7916a78Sdrh */
1119b7916a78Sdrh void sqlite3ExprListSetSpan(
1120b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1121b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
1122b7916a78Sdrh   ExprSpan *pSpan         /* The span to be added */
1123b7916a78Sdrh ){
1124b7916a78Sdrh   sqlite3 *db = pParse->db;
1125b7916a78Sdrh   assert( pList!=0 || db->mallocFailed!=0 );
1126b7916a78Sdrh   if( pList ){
1127b7916a78Sdrh     struct ExprList_item *pItem = &pList->a[pList->nExpr-1];
1128b7916a78Sdrh     assert( pList->nExpr>0 );
1129b7916a78Sdrh     assert( db->mallocFailed || pItem->pExpr==pSpan->pExpr );
1130b7916a78Sdrh     sqlite3DbFree(db, pItem->zSpan);
1131b7916a78Sdrh     pItem->zSpan = sqlite3DbStrNDup(db, (char*)pSpan->zStart,
1132cf697396Sshane                                     (int)(pSpan->zEnd - pSpan->zStart));
1133b7916a78Sdrh   }
1134b7916a78Sdrh }
1135b7916a78Sdrh 
1136b7916a78Sdrh /*
11377a15a4beSdanielk1977 ** If the expression list pEList contains more than iLimit elements,
11387a15a4beSdanielk1977 ** leave an error message in pParse.
11397a15a4beSdanielk1977 */
11407a15a4beSdanielk1977 void sqlite3ExprListCheckLength(
11417a15a4beSdanielk1977   Parse *pParse,
11427a15a4beSdanielk1977   ExprList *pEList,
11437a15a4beSdanielk1977   const char *zObject
11447a15a4beSdanielk1977 ){
1145b1a6c3c1Sdrh   int mx = pParse->db->aLimit[SQLITE_LIMIT_COLUMN];
1146c5499befSdrh   testcase( pEList && pEList->nExpr==mx );
1147c5499befSdrh   testcase( pEList && pEList->nExpr==mx+1 );
1148b1a6c3c1Sdrh   if( pEList && pEList->nExpr>mx ){
11497a15a4beSdanielk1977     sqlite3ErrorMsg(pParse, "too many columns in %s", zObject);
11507a15a4beSdanielk1977   }
11517a15a4beSdanielk1977 }
11527a15a4beSdanielk1977 
11537a15a4beSdanielk1977 /*
1154a76b5dfcSdrh ** Delete an entire expression list.
1155a76b5dfcSdrh */
1156633e6d57Sdrh void sqlite3ExprListDelete(sqlite3 *db, ExprList *pList){
1157a76b5dfcSdrh   int i;
1158be5c89acSdrh   struct ExprList_item *pItem;
1159a76b5dfcSdrh   if( pList==0 ) return;
1160d872bb18Sdrh   assert( pList->a!=0 || pList->nExpr==0 );
1161be5c89acSdrh   for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
1162633e6d57Sdrh     sqlite3ExprDelete(db, pItem->pExpr);
1163633e6d57Sdrh     sqlite3DbFree(db, pItem->zName);
1164b7916a78Sdrh     sqlite3DbFree(db, pItem->zSpan);
1165a76b5dfcSdrh   }
1166633e6d57Sdrh   sqlite3DbFree(db, pList->a);
1167633e6d57Sdrh   sqlite3DbFree(db, pList);
1168a76b5dfcSdrh }
1169a76b5dfcSdrh 
1170a76b5dfcSdrh /*
11717d10d5a6Sdrh ** These routines are Walker callbacks.  Walker.u.pi is a pointer
11727d10d5a6Sdrh ** to an integer.  These routines are checking an expression to see
11737d10d5a6Sdrh ** if it is a constant.  Set *Walker.u.pi to 0 if the expression is
11747d10d5a6Sdrh ** not constant.
117573b211abSdrh **
11767d10d5a6Sdrh ** These callback routines are used to implement the following:
1177626a879aSdrh **
11787d10d5a6Sdrh **     sqlite3ExprIsConstant()
11797d10d5a6Sdrh **     sqlite3ExprIsConstantNotJoin()
11807d10d5a6Sdrh **     sqlite3ExprIsConstantOrFunction()
118187abf5c0Sdrh **
1182626a879aSdrh */
11837d10d5a6Sdrh static int exprNodeIsConstant(Walker *pWalker, Expr *pExpr){
1184626a879aSdrh 
11857d10d5a6Sdrh   /* If pWalker->u.i is 3 then any term of the expression that comes from
11860a168377Sdrh   ** the ON or USING clauses of a join disqualifies the expression
11870a168377Sdrh   ** from being considered constant. */
1188c5cd1249Sdrh   if( pWalker->u.i==3 && ExprHasProperty(pExpr, EP_FromJoin) ){
11897d10d5a6Sdrh     pWalker->u.i = 0;
11907d10d5a6Sdrh     return WRC_Abort;
11910a168377Sdrh   }
11920a168377Sdrh 
1193626a879aSdrh   switch( pExpr->op ){
1194eb55bd2fSdrh     /* Consider functions to be constant if all their arguments are constant
11957d10d5a6Sdrh     ** and pWalker->u.i==2 */
1196eb55bd2fSdrh     case TK_FUNCTION:
11977d10d5a6Sdrh       if( pWalker->u.i==2 ) return 0;
1198eb55bd2fSdrh       /* Fall through */
1199626a879aSdrh     case TK_ID:
1200626a879aSdrh     case TK_COLUMN:
1201626a879aSdrh     case TK_AGG_FUNCTION:
120213449892Sdrh     case TK_AGG_COLUMN:
1203c5499befSdrh       testcase( pExpr->op==TK_ID );
1204c5499befSdrh       testcase( pExpr->op==TK_COLUMN );
1205c5499befSdrh       testcase( pExpr->op==TK_AGG_FUNCTION );
1206c5499befSdrh       testcase( pExpr->op==TK_AGG_COLUMN );
12077d10d5a6Sdrh       pWalker->u.i = 0;
12087d10d5a6Sdrh       return WRC_Abort;
1209626a879aSdrh     default:
1210b74b1017Sdrh       testcase( pExpr->op==TK_SELECT ); /* selectNodeIsConstant will disallow */
1211b74b1017Sdrh       testcase( pExpr->op==TK_EXISTS ); /* selectNodeIsConstant will disallow */
12127d10d5a6Sdrh       return WRC_Continue;
1213626a879aSdrh   }
1214626a879aSdrh }
121562c14b34Sdanielk1977 static int selectNodeIsConstant(Walker *pWalker, Select *NotUsed){
121662c14b34Sdanielk1977   UNUSED_PARAMETER(NotUsed);
12177d10d5a6Sdrh   pWalker->u.i = 0;
12187d10d5a6Sdrh   return WRC_Abort;
12197d10d5a6Sdrh }
12207d10d5a6Sdrh static int exprIsConst(Expr *p, int initFlag){
12217d10d5a6Sdrh   Walker w;
1222aa87f9a6Sdrh   memset(&w, 0, sizeof(w));
12237d10d5a6Sdrh   w.u.i = initFlag;
12247d10d5a6Sdrh   w.xExprCallback = exprNodeIsConstant;
12257d10d5a6Sdrh   w.xSelectCallback = selectNodeIsConstant;
12267d10d5a6Sdrh   sqlite3WalkExpr(&w, p);
12277d10d5a6Sdrh   return w.u.i;
12287d10d5a6Sdrh }
1229626a879aSdrh 
1230626a879aSdrh /*
1231fef5208cSdrh ** Walk an expression tree.  Return 1 if the expression is constant
1232eb55bd2fSdrh ** and 0 if it involves variables or function calls.
12332398937bSdrh **
12342398937bSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
12352398937bSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
12362398937bSdrh ** a constant.
1237fef5208cSdrh */
12384adee20fSdanielk1977 int sqlite3ExprIsConstant(Expr *p){
12397d10d5a6Sdrh   return exprIsConst(p, 1);
1240fef5208cSdrh }
1241fef5208cSdrh 
1242fef5208cSdrh /*
1243eb55bd2fSdrh ** Walk an expression tree.  Return 1 if the expression is constant
12440a168377Sdrh ** that does no originate from the ON or USING clauses of a join.
12450a168377Sdrh ** Return 0 if it involves variables or function calls or terms from
12460a168377Sdrh ** an ON or USING clause.
12470a168377Sdrh */
12480a168377Sdrh int sqlite3ExprIsConstantNotJoin(Expr *p){
12497d10d5a6Sdrh   return exprIsConst(p, 3);
12500a168377Sdrh }
12510a168377Sdrh 
12520a168377Sdrh /*
12530a168377Sdrh ** Walk an expression tree.  Return 1 if the expression is constant
1254eb55bd2fSdrh ** or a function call with constant arguments.  Return and 0 if there
1255eb55bd2fSdrh ** are any variables.
1256eb55bd2fSdrh **
1257eb55bd2fSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
1258eb55bd2fSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
1259eb55bd2fSdrh ** a constant.
1260eb55bd2fSdrh */
1261eb55bd2fSdrh int sqlite3ExprIsConstantOrFunction(Expr *p){
12627d10d5a6Sdrh   return exprIsConst(p, 2);
1263eb55bd2fSdrh }
1264eb55bd2fSdrh 
1265eb55bd2fSdrh /*
126673b211abSdrh ** If the expression p codes a constant integer that is small enough
1267202b2df7Sdrh ** to fit in a 32-bit integer, return 1 and put the value of the integer
1268202b2df7Sdrh ** in *pValue.  If the expression is not an integer or if it is too big
1269202b2df7Sdrh ** to fit in a signed 32-bit integer, return 0 and leave *pValue unchanged.
1270e4de1febSdrh */
12714adee20fSdanielk1977 int sqlite3ExprIsInteger(Expr *p, int *pValue){
127292b01d53Sdrh   int rc = 0;
1273cd92e84dSdrh 
1274cd92e84dSdrh   /* If an expression is an integer literal that fits in a signed 32-bit
1275cd92e84dSdrh   ** integer, then the EP_IntValue flag will have already been set */
1276cd92e84dSdrh   assert( p->op!=TK_INTEGER || (p->flags & EP_IntValue)!=0
1277cd92e84dSdrh            || sqlite3GetInt32(p->u.zToken, &rc)==0 );
1278cd92e84dSdrh 
127992b01d53Sdrh   if( p->flags & EP_IntValue ){
128033e619fcSdrh     *pValue = p->u.iValue;
1281e4de1febSdrh     return 1;
1282e4de1febSdrh   }
128392b01d53Sdrh   switch( p->op ){
12844b59ab5eSdrh     case TK_UPLUS: {
128592b01d53Sdrh       rc = sqlite3ExprIsInteger(p->pLeft, pValue);
1286f6e369a1Sdrh       break;
12874b59ab5eSdrh     }
1288e4de1febSdrh     case TK_UMINUS: {
1289e4de1febSdrh       int v;
12904adee20fSdanielk1977       if( sqlite3ExprIsInteger(p->pLeft, &v) ){
1291f6418891Smistachkin         assert( v!=(-2147483647-1) );
1292e4de1febSdrh         *pValue = -v;
129392b01d53Sdrh         rc = 1;
1294e4de1febSdrh       }
1295e4de1febSdrh       break;
1296e4de1febSdrh     }
1297e4de1febSdrh     default: break;
1298e4de1febSdrh   }
129992b01d53Sdrh   return rc;
1300e4de1febSdrh }
1301e4de1febSdrh 
1302e4de1febSdrh /*
1303039fc32eSdrh ** Return FALSE if there is no chance that the expression can be NULL.
1304039fc32eSdrh **
1305039fc32eSdrh ** If the expression might be NULL or if the expression is too complex
1306039fc32eSdrh ** to tell return TRUE.
1307039fc32eSdrh **
1308039fc32eSdrh ** This routine is used as an optimization, to skip OP_IsNull opcodes
1309039fc32eSdrh ** when we know that a value cannot be NULL.  Hence, a false positive
1310039fc32eSdrh ** (returning TRUE when in fact the expression can never be NULL) might
1311039fc32eSdrh ** be a small performance hit but is otherwise harmless.  On the other
1312039fc32eSdrh ** hand, a false negative (returning FALSE when the result could be NULL)
1313039fc32eSdrh ** will likely result in an incorrect answer.  So when in doubt, return
1314039fc32eSdrh ** TRUE.
1315039fc32eSdrh */
1316039fc32eSdrh int sqlite3ExprCanBeNull(const Expr *p){
1317039fc32eSdrh   u8 op;
1318cd7f457eSdrh   while( p->op==TK_UPLUS || p->op==TK_UMINUS ){ p = p->pLeft; }
1319039fc32eSdrh   op = p->op;
1320039fc32eSdrh   if( op==TK_REGISTER ) op = p->op2;
1321039fc32eSdrh   switch( op ){
1322039fc32eSdrh     case TK_INTEGER:
1323039fc32eSdrh     case TK_STRING:
1324039fc32eSdrh     case TK_FLOAT:
1325039fc32eSdrh     case TK_BLOB:
1326039fc32eSdrh       return 0;
1327039fc32eSdrh     default:
1328039fc32eSdrh       return 1;
1329039fc32eSdrh   }
1330039fc32eSdrh }
1331039fc32eSdrh 
1332039fc32eSdrh /*
13332f2855b6Sdrh ** Generate an OP_IsNull instruction that tests register iReg and jumps
13342f2855b6Sdrh ** to location iDest if the value in iReg is NULL.  The value in iReg
13352f2855b6Sdrh ** was computed by pExpr.  If we can look at pExpr at compile-time and
13362f2855b6Sdrh ** determine that it can never generate a NULL, then the OP_IsNull operation
13372f2855b6Sdrh ** can be omitted.
13382f2855b6Sdrh */
13392f2855b6Sdrh void sqlite3ExprCodeIsNullJump(
13402f2855b6Sdrh   Vdbe *v,            /* The VDBE under construction */
13412f2855b6Sdrh   const Expr *pExpr,  /* Only generate OP_IsNull if this expr can be NULL */
13422f2855b6Sdrh   int iReg,           /* Test the value in this register for NULL */
13432f2855b6Sdrh   int iDest           /* Jump here if the value is null */
13442f2855b6Sdrh ){
13452f2855b6Sdrh   if( sqlite3ExprCanBeNull(pExpr) ){
13462f2855b6Sdrh     sqlite3VdbeAddOp2(v, OP_IsNull, iReg, iDest);
13472f2855b6Sdrh   }
13482f2855b6Sdrh }
13492f2855b6Sdrh 
13502f2855b6Sdrh /*
1351039fc32eSdrh ** Return TRUE if the given expression is a constant which would be
1352039fc32eSdrh ** unchanged by OP_Affinity with the affinity given in the second
1353039fc32eSdrh ** argument.
1354039fc32eSdrh **
1355039fc32eSdrh ** This routine is used to determine if the OP_Affinity operation
1356039fc32eSdrh ** can be omitted.  When in doubt return FALSE.  A false negative
1357039fc32eSdrh ** is harmless.  A false positive, however, can result in the wrong
1358039fc32eSdrh ** answer.
1359039fc32eSdrh */
1360039fc32eSdrh int sqlite3ExprNeedsNoAffinityChange(const Expr *p, char aff){
1361039fc32eSdrh   u8 op;
1362039fc32eSdrh   if( aff==SQLITE_AFF_NONE ) return 1;
1363cd7f457eSdrh   while( p->op==TK_UPLUS || p->op==TK_UMINUS ){ p = p->pLeft; }
1364039fc32eSdrh   op = p->op;
1365039fc32eSdrh   if( op==TK_REGISTER ) op = p->op2;
1366039fc32eSdrh   switch( op ){
1367039fc32eSdrh     case TK_INTEGER: {
1368039fc32eSdrh       return aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC;
1369039fc32eSdrh     }
1370039fc32eSdrh     case TK_FLOAT: {
1371039fc32eSdrh       return aff==SQLITE_AFF_REAL || aff==SQLITE_AFF_NUMERIC;
1372039fc32eSdrh     }
1373039fc32eSdrh     case TK_STRING: {
1374039fc32eSdrh       return aff==SQLITE_AFF_TEXT;
1375039fc32eSdrh     }
1376039fc32eSdrh     case TK_BLOB: {
1377039fc32eSdrh       return 1;
1378039fc32eSdrh     }
13792f2855b6Sdrh     case TK_COLUMN: {
138088376ca7Sdrh       assert( p->iTable>=0 );  /* p cannot be part of a CHECK constraint */
138188376ca7Sdrh       return p->iColumn<0
13822f2855b6Sdrh           && (aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC);
13832f2855b6Sdrh     }
1384039fc32eSdrh     default: {
1385039fc32eSdrh       return 0;
1386039fc32eSdrh     }
1387039fc32eSdrh   }
1388039fc32eSdrh }
1389039fc32eSdrh 
1390039fc32eSdrh /*
1391c4a3c779Sdrh ** Return TRUE if the given string is a row-id column name.
1392c4a3c779Sdrh */
13934adee20fSdanielk1977 int sqlite3IsRowid(const char *z){
13944adee20fSdanielk1977   if( sqlite3StrICmp(z, "_ROWID_")==0 ) return 1;
13954adee20fSdanielk1977   if( sqlite3StrICmp(z, "ROWID")==0 ) return 1;
13964adee20fSdanielk1977   if( sqlite3StrICmp(z, "OID")==0 ) return 1;
1397c4a3c779Sdrh   return 0;
1398c4a3c779Sdrh }
1399c4a3c779Sdrh 
14009a96b668Sdanielk1977 /*
1401b74b1017Sdrh ** Return true if we are able to the IN operator optimization on a
1402b74b1017Sdrh ** query of the form
1403b287f4b6Sdrh **
1404b74b1017Sdrh **       x IN (SELECT ...)
1405b287f4b6Sdrh **
1406b74b1017Sdrh ** Where the SELECT... clause is as specified by the parameter to this
1407b74b1017Sdrh ** routine.
1408b74b1017Sdrh **
1409b74b1017Sdrh ** The Select object passed in has already been preprocessed and no
1410b74b1017Sdrh ** errors have been found.
1411b287f4b6Sdrh */
1412b287f4b6Sdrh #ifndef SQLITE_OMIT_SUBQUERY
1413b287f4b6Sdrh static int isCandidateForInOpt(Select *p){
1414b287f4b6Sdrh   SrcList *pSrc;
1415b287f4b6Sdrh   ExprList *pEList;
1416b287f4b6Sdrh   Table *pTab;
1417b287f4b6Sdrh   if( p==0 ) return 0;                   /* right-hand side of IN is SELECT */
1418b287f4b6Sdrh   if( p->pPrior ) return 0;              /* Not a compound SELECT */
14197d10d5a6Sdrh   if( p->selFlags & (SF_Distinct|SF_Aggregate) ){
1420b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
1421b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
14227d10d5a6Sdrh     return 0; /* No DISTINCT keyword and no aggregate functions */
14237d10d5a6Sdrh   }
1424b74b1017Sdrh   assert( p->pGroupBy==0 );              /* Has no GROUP BY clause */
1425b287f4b6Sdrh   if( p->pLimit ) return 0;              /* Has no LIMIT clause */
1426b74b1017Sdrh   assert( p->pOffset==0 );               /* No LIMIT means no OFFSET */
1427b287f4b6Sdrh   if( p->pWhere ) return 0;              /* Has no WHERE clause */
1428b287f4b6Sdrh   pSrc = p->pSrc;
1429d1fa7bcaSdrh   assert( pSrc!=0 );
1430d1fa7bcaSdrh   if( pSrc->nSrc!=1 ) return 0;          /* Single term in FROM clause */
1431b74b1017Sdrh   if( pSrc->a[0].pSelect ) return 0;     /* FROM is not a subquery or view */
1432b287f4b6Sdrh   pTab = pSrc->a[0].pTab;
1433b74b1017Sdrh   if( NEVER(pTab==0) ) return 0;
1434b74b1017Sdrh   assert( pTab->pSelect==0 );            /* FROM clause is not a view */
1435b287f4b6Sdrh   if( IsVirtual(pTab) ) return 0;        /* FROM clause not a virtual table */
1436b287f4b6Sdrh   pEList = p->pEList;
1437b287f4b6Sdrh   if( pEList->nExpr!=1 ) return 0;       /* One column in the result set */
1438b287f4b6Sdrh   if( pEList->a[0].pExpr->op!=TK_COLUMN ) return 0; /* Result is a column */
1439b287f4b6Sdrh   return 1;
1440b287f4b6Sdrh }
1441b287f4b6Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
1442b287f4b6Sdrh 
1443b287f4b6Sdrh /*
14441d8cb21fSdan ** Code an OP_Once instruction and allocate space for its flag. Return the
14451d8cb21fSdan ** address of the new instruction.
14461d8cb21fSdan */
14471d8cb21fSdan int sqlite3CodeOnce(Parse *pParse){
14481d8cb21fSdan   Vdbe *v = sqlite3GetVdbe(pParse);      /* Virtual machine being coded */
14491d8cb21fSdan   return sqlite3VdbeAddOp1(v, OP_Once, pParse->nOnce++);
14501d8cb21fSdan }
14511d8cb21fSdan 
14521d8cb21fSdan /*
14539a96b668Sdanielk1977 ** This function is used by the implementation of the IN (...) operator.
1454d4305ca6Sdrh ** The pX parameter is the expression on the RHS of the IN operator, which
1455d4305ca6Sdrh ** might be either a list of expressions or a subquery.
14569a96b668Sdanielk1977 **
1457d4305ca6Sdrh ** The job of this routine is to find or create a b-tree object that can
1458d4305ca6Sdrh ** be used either to test for membership in the RHS set or to iterate through
1459d4305ca6Sdrh ** all members of the RHS set, skipping duplicates.
1460d4305ca6Sdrh **
1461d4305ca6Sdrh ** A cursor is opened on the b-tree object that the RHS of the IN operator
1462d4305ca6Sdrh ** and pX->iTable is set to the index of that cursor.
1463d4305ca6Sdrh **
1464b74b1017Sdrh ** The returned value of this function indicates the b-tree type, as follows:
14659a96b668Sdanielk1977 **
14669a96b668Sdanielk1977 **   IN_INDEX_ROWID      - The cursor was opened on a database table.
14671ccce449Sdrh **   IN_INDEX_INDEX_ASC  - The cursor was opened on an ascending index.
14681ccce449Sdrh **   IN_INDEX_INDEX_DESC - The cursor was opened on a descending index.
14699a96b668Sdanielk1977 **   IN_INDEX_EPH        - The cursor was opened on a specially created and
14709a96b668Sdanielk1977 **                         populated epheremal table.
14719a96b668Sdanielk1977 **
1472d4305ca6Sdrh ** An existing b-tree might be used if the RHS expression pX is a simple
1473d4305ca6Sdrh ** subquery such as:
14749a96b668Sdanielk1977 **
14759a96b668Sdanielk1977 **     SELECT <column> FROM <table>
14769a96b668Sdanielk1977 **
1477d4305ca6Sdrh ** If the RHS of the IN operator is a list or a more complex subquery, then
1478d4305ca6Sdrh ** an ephemeral table might need to be generated from the RHS and then
1479d4305ca6Sdrh ** pX->iTable made to point to the ephermeral table instead of an
1480d4305ca6Sdrh ** existing table.
1481d4305ca6Sdrh **
1482b74b1017Sdrh ** If the prNotFound parameter is 0, then the b-tree will be used to iterate
14839a96b668Sdanielk1977 ** through the set members, skipping any duplicates. In this case an
14849a96b668Sdanielk1977 ** epheremal table must be used unless the selected <column> is guaranteed
14859a96b668Sdanielk1977 ** to be unique - either because it is an INTEGER PRIMARY KEY or it
1486b74b1017Sdrh ** has a UNIQUE constraint or UNIQUE index.
14870cdc022eSdanielk1977 **
1488b74b1017Sdrh ** If the prNotFound parameter is not 0, then the b-tree will be used
14890cdc022eSdanielk1977 ** for fast set membership tests. In this case an epheremal table must
14900cdc022eSdanielk1977 ** be used unless <column> is an INTEGER PRIMARY KEY or an index can
14910cdc022eSdanielk1977 ** be found with <column> as its left-most column.
14920cdc022eSdanielk1977 **
1493b74b1017Sdrh ** When the b-tree is being used for membership tests, the calling function
14940cdc022eSdanielk1977 ** needs to know whether or not the structure contains an SQL NULL
14950cdc022eSdanielk1977 ** value in order to correctly evaluate expressions like "X IN (Y, Z)".
1496e3365e6cSdrh ** If there is any chance that the (...) might contain a NULL value at
14970cdc022eSdanielk1977 ** runtime, then a register is allocated and the register number written
1498e3365e6cSdrh ** to *prNotFound. If there is no chance that the (...) contains a
14990cdc022eSdanielk1977 ** NULL value, then *prNotFound is left unchanged.
15000cdc022eSdanielk1977 **
15010cdc022eSdanielk1977 ** If a register is allocated and its location stored in *prNotFound, then
1502e3365e6cSdrh ** its initial value is NULL.  If the (...) does not remain constant
1503e3365e6cSdrh ** for the duration of the query (i.e. the SELECT within the (...)
1504b74b1017Sdrh ** is a correlated subquery) then the value of the allocated register is
1505e3365e6cSdrh ** reset to NULL each time the subquery is rerun. This allows the
1506b74b1017Sdrh ** caller to use vdbe code equivalent to the following:
15070cdc022eSdanielk1977 **
15080cdc022eSdanielk1977 **   if( register==NULL ){
15090cdc022eSdanielk1977 **     has_null = <test if data structure contains null>
15100cdc022eSdanielk1977 **     register = 1
15110cdc022eSdanielk1977 **   }
15120cdc022eSdanielk1977 **
15130cdc022eSdanielk1977 ** in order to avoid running the <test if data structure contains null>
15140cdc022eSdanielk1977 ** test more often than is necessary.
15159a96b668Sdanielk1977 */
1516284f4acaSdanielk1977 #ifndef SQLITE_OMIT_SUBQUERY
15170cdc022eSdanielk1977 int sqlite3FindInIndex(Parse *pParse, Expr *pX, int *prNotFound){
1518b74b1017Sdrh   Select *p;                            /* SELECT to the right of IN operator */
1519b74b1017Sdrh   int eType = 0;                        /* Type of RHS table. IN_INDEX_* */
1520b74b1017Sdrh   int iTab = pParse->nTab++;            /* Cursor of the RHS table */
1521b74b1017Sdrh   int mustBeUnique = (prNotFound==0);   /* True if RHS must be unique */
1522b8475df8Sdrh   Vdbe *v = sqlite3GetVdbe(pParse);     /* Virtual machine being coded */
15239a96b668Sdanielk1977 
15241450bc6eSdrh   assert( pX->op==TK_IN );
15251450bc6eSdrh 
1526b74b1017Sdrh   /* Check to see if an existing table or index can be used to
1527b74b1017Sdrh   ** satisfy the query.  This is preferable to generating a new
1528b74b1017Sdrh   ** ephemeral table.
15299a96b668Sdanielk1977   */
15306ab3a2ecSdanielk1977   p = (ExprHasProperty(pX, EP_xIsSelect) ? pX->x.pSelect : 0);
1531fd773cf9Sdrh   if( ALWAYS(pParse->nErr==0) && isCandidateForInOpt(p) ){
1532e1fb65a0Sdanielk1977     sqlite3 *db = pParse->db;              /* Database connection */
1533b07028f7Sdrh     Table *pTab;                           /* Table <table>. */
1534b07028f7Sdrh     Expr *pExpr;                           /* Expression <column> */
1535*bbbdc83bSdrh     i16 iCol;                              /* Index of column <column> */
1536*bbbdc83bSdrh     i16 iDb;                               /* Database idx for pTab */
1537e1fb65a0Sdanielk1977 
1538b07028f7Sdrh     assert( p );                        /* Because of isCandidateForInOpt(p) */
1539b07028f7Sdrh     assert( p->pEList!=0 );             /* Because of isCandidateForInOpt(p) */
1540b07028f7Sdrh     assert( p->pEList->a[0].pExpr!=0 ); /* Because of isCandidateForInOpt(p) */
1541b07028f7Sdrh     assert( p->pSrc!=0 );               /* Because of isCandidateForInOpt(p) */
1542b07028f7Sdrh     pTab = p->pSrc->a[0].pTab;
1543b07028f7Sdrh     pExpr = p->pEList->a[0].pExpr;
1544*bbbdc83bSdrh     iCol = (i16)pExpr->iColumn;
1545b07028f7Sdrh 
1546e1fb65a0Sdanielk1977     /* Code an OP_VerifyCookie and OP_TableLock for <table>. */
1547e1fb65a0Sdanielk1977     iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
1548e1fb65a0Sdanielk1977     sqlite3CodeVerifySchema(pParse, iDb);
1549e1fb65a0Sdanielk1977     sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
15509a96b668Sdanielk1977 
15519a96b668Sdanielk1977     /* This function is only called from two places. In both cases the vdbe
15529a96b668Sdanielk1977     ** has already been allocated. So assume sqlite3GetVdbe() is always
15539a96b668Sdanielk1977     ** successful here.
15549a96b668Sdanielk1977     */
15559a96b668Sdanielk1977     assert(v);
15569a96b668Sdanielk1977     if( iCol<0 ){
15579a96b668Sdanielk1977       int iAddr;
15589a96b668Sdanielk1977 
15591d8cb21fSdan       iAddr = sqlite3CodeOnce(pParse);
15609a96b668Sdanielk1977 
15619a96b668Sdanielk1977       sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
15629a96b668Sdanielk1977       eType = IN_INDEX_ROWID;
15639a96b668Sdanielk1977 
15649a96b668Sdanielk1977       sqlite3VdbeJumpHere(v, iAddr);
15659a96b668Sdanielk1977     }else{
1566e1fb65a0Sdanielk1977       Index *pIdx;                         /* Iterator variable */
1567e1fb65a0Sdanielk1977 
15689a96b668Sdanielk1977       /* The collation sequence used by the comparison. If an index is to
15699a96b668Sdanielk1977       ** be used in place of a temp-table, it must be ordered according
1570e1fb65a0Sdanielk1977       ** to this collation sequence.  */
15719a96b668Sdanielk1977       CollSeq *pReq = sqlite3BinaryCompareCollSeq(pParse, pX->pLeft, pExpr);
15729a96b668Sdanielk1977 
15739a96b668Sdanielk1977       /* Check that the affinity that will be used to perform the
15749a96b668Sdanielk1977       ** comparison is the same as the affinity of the column. If
15759a96b668Sdanielk1977       ** it is not, it is not possible to use any index.
15769a96b668Sdanielk1977       */
1577dbaee5e3Sdrh       int affinity_ok = sqlite3IndexAffinityOk(pX, pTab->aCol[iCol].affinity);
15789a96b668Sdanielk1977 
15799a96b668Sdanielk1977       for(pIdx=pTab->pIndex; pIdx && eType==0 && affinity_ok; pIdx=pIdx->pNext){
15809a96b668Sdanielk1977         if( (pIdx->aiColumn[0]==iCol)
1581b74b1017Sdrh          && sqlite3FindCollSeq(db, ENC(db), pIdx->azColl[0], 0)==pReq
1582*bbbdc83bSdrh          && (!mustBeUnique || (pIdx->nKeyCol==1 && pIdx->onError!=OE_None))
15839a96b668Sdanielk1977         ){
15849a96b668Sdanielk1977           int iAddr;
15859a96b668Sdanielk1977           char *pKey;
15869a96b668Sdanielk1977 
15879a96b668Sdanielk1977           pKey = (char *)sqlite3IndexKeyinfo(pParse, pIdx);
15881d8cb21fSdan           iAddr = sqlite3CodeOnce(pParse);
15899a96b668Sdanielk1977 
1590207872a4Sdanielk1977           sqlite3VdbeAddOp4(v, OP_OpenRead, iTab, pIdx->tnum, iDb,
159166a5167bSdrh                                pKey,P4_KEYINFO_HANDOFF);
1592207872a4Sdanielk1977           VdbeComment((v, "%s", pIdx->zName));
15931ccce449Sdrh           assert( IN_INDEX_INDEX_DESC == IN_INDEX_INDEX_ASC+1 );
15941ccce449Sdrh           eType = IN_INDEX_INDEX_ASC + pIdx->aSortOrder[0];
15959a96b668Sdanielk1977 
15969a96b668Sdanielk1977           sqlite3VdbeJumpHere(v, iAddr);
15970cdc022eSdanielk1977           if( prNotFound && !pTab->aCol[iCol].notNull ){
15980cdc022eSdanielk1977             *prNotFound = ++pParse->nMem;
1599b8475df8Sdrh             sqlite3VdbeAddOp2(v, OP_Null, 0, *prNotFound);
16000cdc022eSdanielk1977           }
16019a96b668Sdanielk1977         }
16029a96b668Sdanielk1977       }
16039a96b668Sdanielk1977     }
16049a96b668Sdanielk1977   }
16059a96b668Sdanielk1977 
16069a96b668Sdanielk1977   if( eType==0 ){
16071450bc6eSdrh     /* Could not found an existing table or index to use as the RHS b-tree.
1608b74b1017Sdrh     ** We will have to generate an ephemeral table to do the job.
1609b74b1017Sdrh     */
16108e23daf3Sdrh     u32 savedNQueryLoop = pParse->nQueryLoop;
16110cdc022eSdanielk1977     int rMayHaveNull = 0;
161241a05b7bSdanielk1977     eType = IN_INDEX_EPH;
16130cdc022eSdanielk1977     if( prNotFound ){
16140cdc022eSdanielk1977       *prNotFound = rMayHaveNull = ++pParse->nMem;
1615b8475df8Sdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, *prNotFound);
1616cf4d38aaSdrh     }else{
16174a5acf8eSdrh       testcase( pParse->nQueryLoop>0 );
16184a5acf8eSdrh       pParse->nQueryLoop = 0;
1619c5cd1249Sdrh       if( pX->pLeft->iColumn<0 && !ExprHasProperty(pX, EP_xIsSelect) ){
162041a05b7bSdanielk1977         eType = IN_INDEX_ROWID;
16210cdc022eSdanielk1977       }
1622cf4d38aaSdrh     }
162341a05b7bSdanielk1977     sqlite3CodeSubselect(pParse, pX, rMayHaveNull, eType==IN_INDEX_ROWID);
1624cf4d38aaSdrh     pParse->nQueryLoop = savedNQueryLoop;
16259a96b668Sdanielk1977   }else{
16269a96b668Sdanielk1977     pX->iTable = iTab;
16279a96b668Sdanielk1977   }
16289a96b668Sdanielk1977   return eType;
16299a96b668Sdanielk1977 }
1630284f4acaSdanielk1977 #endif
1631626a879aSdrh 
1632626a879aSdrh /*
1633d4187c71Sdrh ** Generate code for scalar subqueries used as a subquery expression, EXISTS,
1634d4187c71Sdrh ** or IN operators.  Examples:
1635626a879aSdrh **
16369cbe6352Sdrh **     (SELECT a FROM b)          -- subquery
16379cbe6352Sdrh **     EXISTS (SELECT a FROM b)   -- EXISTS subquery
16389cbe6352Sdrh **     x IN (4,5,11)              -- IN operator with list on right-hand side
16399cbe6352Sdrh **     x IN (SELECT a FROM b)     -- IN operator with subquery on the right
1640fef5208cSdrh **
16419cbe6352Sdrh ** The pExpr parameter describes the expression that contains the IN
16429cbe6352Sdrh ** operator or subquery.
164341a05b7bSdanielk1977 **
164441a05b7bSdanielk1977 ** If parameter isRowid is non-zero, then expression pExpr is guaranteed
164541a05b7bSdanielk1977 ** to be of the form "<rowid> IN (?, ?, ?)", where <rowid> is a reference
164641a05b7bSdanielk1977 ** to some integer key column of a table B-Tree. In this case, use an
164741a05b7bSdanielk1977 ** intkey B-Tree to store the set of IN(...) values instead of the usual
164841a05b7bSdanielk1977 ** (slower) variable length keys B-Tree.
1649fd773cf9Sdrh **
1650fd773cf9Sdrh ** If rMayHaveNull is non-zero, that means that the operation is an IN
1651fd773cf9Sdrh ** (not a SELECT or EXISTS) and that the RHS might contains NULLs.
1652fd773cf9Sdrh ** Furthermore, the IN is in a WHERE clause and that we really want
1653fd773cf9Sdrh ** to iterate over the RHS of the IN operator in order to quickly locate
1654fd773cf9Sdrh ** all corresponding LHS elements.  All this routine does is initialize
1655fd773cf9Sdrh ** the register given by rMayHaveNull to NULL.  Calling routines will take
1656fd773cf9Sdrh ** care of changing this register value to non-NULL if the RHS is NULL-free.
1657fd773cf9Sdrh **
1658fd773cf9Sdrh ** If rMayHaveNull is zero, that means that the subquery is being used
1659fd773cf9Sdrh ** for membership testing only.  There is no need to initialize any
1660f7b5496eSdrh ** registers to indicate the presence or absence of NULLs on the RHS.
16611450bc6eSdrh **
16621450bc6eSdrh ** For a SELECT or EXISTS operator, return the register that holds the
16631450bc6eSdrh ** result.  For IN operators or if an error occurs, the return value is 0.
1664cce7d176Sdrh */
166551522cd3Sdrh #ifndef SQLITE_OMIT_SUBQUERY
16661450bc6eSdrh int sqlite3CodeSubselect(
1667fd773cf9Sdrh   Parse *pParse,          /* Parsing context */
1668fd773cf9Sdrh   Expr *pExpr,            /* The IN, SELECT, or EXISTS operator */
1669fd773cf9Sdrh   int rMayHaveNull,       /* Register that records whether NULLs exist in RHS */
1670fd773cf9Sdrh   int isRowid             /* If true, LHS of IN operator is a rowid */
167141a05b7bSdanielk1977 ){
1672dfd2d9f6Sdrh   int testAddr = -1;                      /* One-time test address */
16731450bc6eSdrh   int rReg = 0;                           /* Register storing resulting */
1674b3bce662Sdanielk1977   Vdbe *v = sqlite3GetVdbe(pParse);
16751450bc6eSdrh   if( NEVER(v==0) ) return 0;
1676ceea3321Sdrh   sqlite3ExprCachePush(pParse);
1677fc976065Sdanielk1977 
167857dbd7b3Sdrh   /* This code must be run in its entirety every time it is encountered
167957dbd7b3Sdrh   ** if any of the following is true:
168057dbd7b3Sdrh   **
168157dbd7b3Sdrh   **    *  The right-hand side is a correlated subquery
168257dbd7b3Sdrh   **    *  The right-hand side is an expression list containing variables
168357dbd7b3Sdrh   **    *  We are inside a trigger
168457dbd7b3Sdrh   **
168557dbd7b3Sdrh   ** If all of the above are false, then we can run this code just once
168657dbd7b3Sdrh   ** save the results, and reuse the same result on subsequent invocations.
1687b3bce662Sdanielk1977   */
1688c5cd1249Sdrh   if( !ExprHasProperty(pExpr, EP_VarSelect) ){
16891d8cb21fSdan     testAddr = sqlite3CodeOnce(pParse);
1690b3bce662Sdanielk1977   }
1691b3bce662Sdanielk1977 
16924a07e3dbSdan #ifndef SQLITE_OMIT_EXPLAIN
16934a07e3dbSdan   if( pParse->explain==2 ){
16944a07e3dbSdan     char *zMsg = sqlite3MPrintf(
1695dfd2d9f6Sdrh         pParse->db, "EXECUTE %s%s SUBQUERY %d", testAddr>=0?"":"CORRELATED ",
16964a07e3dbSdan         pExpr->op==TK_IN?"LIST":"SCALAR", pParse->iNextSelectId
16974a07e3dbSdan     );
16984a07e3dbSdan     sqlite3VdbeAddOp4(v, OP_Explain, pParse->iSelectId, 0, 0, zMsg, P4_DYNAMIC);
16994a07e3dbSdan   }
17004a07e3dbSdan #endif
17014a07e3dbSdan 
1702cce7d176Sdrh   switch( pExpr->op ){
1703fef5208cSdrh     case TK_IN: {
1704d4187c71Sdrh       char affinity;              /* Affinity of the LHS of the IN */
1705b9bb7c18Sdrh       int addr;                   /* Address of OP_OpenEphemeral instruction */
1706d4187c71Sdrh       Expr *pLeft = pExpr->pLeft; /* the LHS of the IN operator */
1707323df790Sdrh       KeyInfo *pKeyInfo = 0;      /* Key information */
1708d3d39e93Sdrh 
17090cdc022eSdanielk1977       if( rMayHaveNull ){
17100cdc022eSdanielk1977         sqlite3VdbeAddOp2(v, OP_Null, 0, rMayHaveNull);
17110cdc022eSdanielk1977       }
17120cdc022eSdanielk1977 
171341a05b7bSdanielk1977       affinity = sqlite3ExprAffinity(pLeft);
1714e014a838Sdanielk1977 
1715e014a838Sdanielk1977       /* Whether this is an 'x IN(SELECT...)' or an 'x IN(<exprlist>)'
17168cff69dfSdrh       ** expression it is handled the same way.  An ephemeral table is
1717e014a838Sdanielk1977       ** filled with single-field index keys representing the results
1718e014a838Sdanielk1977       ** from the SELECT or the <exprlist>.
1719fef5208cSdrh       **
1720e014a838Sdanielk1977       ** If the 'x' expression is a column value, or the SELECT...
1721e014a838Sdanielk1977       ** statement returns a column value, then the affinity of that
1722e014a838Sdanielk1977       ** column is used to build the index keys. If both 'x' and the
1723e014a838Sdanielk1977       ** SELECT... statement are columns, then numeric affinity is used
1724e014a838Sdanielk1977       ** if either column has NUMERIC or INTEGER affinity. If neither
1725e014a838Sdanielk1977       ** 'x' nor the SELECT... statement are columns, then numeric affinity
1726e014a838Sdanielk1977       ** is used.
1727fef5208cSdrh       */
1728832508b7Sdrh       pExpr->iTable = pParse->nTab++;
172941a05b7bSdanielk1977       addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, pExpr->iTable, !isRowid);
1730d4187c71Sdrh       if( rMayHaveNull==0 ) sqlite3VdbeChangeP5(v, BTREE_UNORDERED);
1731323df790Sdrh       pKeyInfo = isRowid ? 0 : sqlite3KeyInfoAlloc(pParse->db, 1);
1732e014a838Sdanielk1977 
17336ab3a2ecSdanielk1977       if( ExprHasProperty(pExpr, EP_xIsSelect) ){
1734e014a838Sdanielk1977         /* Case 1:     expr IN (SELECT ...)
1735e014a838Sdanielk1977         **
1736e014a838Sdanielk1977         ** Generate code to write the results of the select into the temporary
1737e014a838Sdanielk1977         ** table allocated and opened above.
1738e014a838Sdanielk1977         */
17391013c932Sdrh         SelectDest dest;
1740be5c89acSdrh         ExprList *pEList;
17411013c932Sdrh 
174241a05b7bSdanielk1977         assert( !isRowid );
17431013c932Sdrh         sqlite3SelectDestInit(&dest, SRT_Set, pExpr->iTable);
17442b596da8Sdrh         dest.affSdst = (u8)affinity;
1745e014a838Sdanielk1977         assert( (pExpr->iTable&0x0000FFFF)==pExpr->iTable );
174648b5b041Sdrh         pExpr->x.pSelect->iLimit = 0;
1747812ea833Sdrh         testcase( pKeyInfo==0 ); /* Caused by OOM in sqlite3KeyInfoAlloc() */
17486ab3a2ecSdanielk1977         if( sqlite3Select(pParse, pExpr->x.pSelect, &dest) ){
1749323df790Sdrh           sqlite3DbFree(pParse->db, pKeyInfo);
17501450bc6eSdrh           return 0;
175194ccde58Sdrh         }
17526ab3a2ecSdanielk1977         pEList = pExpr->x.pSelect->pEList;
1753812ea833Sdrh         assert( pKeyInfo!=0 ); /* OOM will cause exit after sqlite3Select() */
17543535ec3eSdrh         assert( pEList!=0 );
17553535ec3eSdrh         assert( pEList->nExpr>0 );
1756323df790Sdrh         pKeyInfo->aColl[0] = sqlite3BinaryCompareCollSeq(pParse, pExpr->pLeft,
1757be5c89acSdrh                                                          pEList->a[0].pExpr);
1758a7d2db17Sdrh       }else if( ALWAYS(pExpr->x.pList!=0) ){
1759fef5208cSdrh         /* Case 2:     expr IN (exprlist)
1760fef5208cSdrh         **
1761e014a838Sdanielk1977         ** For each expression, build an index key from the evaluation and
1762e014a838Sdanielk1977         ** store it in the temporary table. If <expr> is a column, then use
1763e014a838Sdanielk1977         ** that columns affinity when building index keys. If <expr> is not
1764e014a838Sdanielk1977         ** a column, use numeric affinity.
1765fef5208cSdrh         */
1766e014a838Sdanielk1977         int i;
17676ab3a2ecSdanielk1977         ExprList *pList = pExpr->x.pList;
176857dbd7b3Sdrh         struct ExprList_item *pItem;
1769ecc31805Sdrh         int r1, r2, r3;
177057dbd7b3Sdrh 
1771e014a838Sdanielk1977         if( !affinity ){
17728159a35fSdrh           affinity = SQLITE_AFF_NONE;
1773e014a838Sdanielk1977         }
1774323df790Sdrh         if( pKeyInfo ){
1775323df790Sdrh           pKeyInfo->aColl[0] = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
1776323df790Sdrh         }
1777e014a838Sdanielk1977 
1778e014a838Sdanielk1977         /* Loop through each expression in <exprlist>. */
17792d401ab8Sdrh         r1 = sqlite3GetTempReg(pParse);
17802d401ab8Sdrh         r2 = sqlite3GetTempReg(pParse);
17814e7f36a2Sdanielk1977         sqlite3VdbeAddOp2(v, OP_Null, 0, r2);
178257dbd7b3Sdrh         for(i=pList->nExpr, pItem=pList->a; i>0; i--, pItem++){
178357dbd7b3Sdrh           Expr *pE2 = pItem->pExpr;
1784e05c929bSdrh           int iValToIns;
1785e014a838Sdanielk1977 
178657dbd7b3Sdrh           /* If the expression is not constant then we will need to
178757dbd7b3Sdrh           ** disable the test that was generated above that makes sure
178857dbd7b3Sdrh           ** this code only executes once.  Because for a non-constant
178957dbd7b3Sdrh           ** expression we need to rerun this code each time.
179057dbd7b3Sdrh           */
1791dfd2d9f6Sdrh           if( testAddr>=0 && !sqlite3ExprIsConstant(pE2) ){
179248f2d3b1Sdrh             sqlite3VdbeChangeToNoop(v, testAddr);
1793dfd2d9f6Sdrh             testAddr = -1;
17944794b980Sdrh           }
1795e014a838Sdanielk1977 
1796e014a838Sdanielk1977           /* Evaluate the expression and insert it into the temp table */
1797e05c929bSdrh           if( isRowid && sqlite3ExprIsInteger(pE2, &iValToIns) ){
1798e05c929bSdrh             sqlite3VdbeAddOp3(v, OP_InsertInt, pExpr->iTable, r2, iValToIns);
1799e05c929bSdrh           }else{
1800ecc31805Sdrh             r3 = sqlite3ExprCodeTarget(pParse, pE2, r1);
180141a05b7bSdanielk1977             if( isRowid ){
1802e05c929bSdrh               sqlite3VdbeAddOp2(v, OP_MustBeInt, r3,
1803e05c929bSdrh                                 sqlite3VdbeCurrentAddr(v)+2);
180441a05b7bSdanielk1977               sqlite3VdbeAddOp3(v, OP_Insert, pExpr->iTable, r2, r3);
180541a05b7bSdanielk1977             }else{
1806ecc31805Sdrh               sqlite3VdbeAddOp4(v, OP_MakeRecord, r3, 1, r2, &affinity, 1);
18073c31fc23Sdrh               sqlite3ExprCacheAffinityChange(pParse, r3, 1);
18082d401ab8Sdrh               sqlite3VdbeAddOp2(v, OP_IdxInsert, pExpr->iTable, r2);
1809fef5208cSdrh             }
181041a05b7bSdanielk1977           }
1811e05c929bSdrh         }
18122d401ab8Sdrh         sqlite3ReleaseTempReg(pParse, r1);
18132d401ab8Sdrh         sqlite3ReleaseTempReg(pParse, r2);
1814fef5208cSdrh       }
1815323df790Sdrh       if( pKeyInfo ){
1816323df790Sdrh         sqlite3VdbeChangeP4(v, addr, (void *)pKeyInfo, P4_KEYINFO_HANDOFF);
181741a05b7bSdanielk1977       }
1818b3bce662Sdanielk1977       break;
1819fef5208cSdrh     }
1820fef5208cSdrh 
182151522cd3Sdrh     case TK_EXISTS:
1822fd773cf9Sdrh     case TK_SELECT:
1823fd773cf9Sdrh     default: {
1824fd773cf9Sdrh       /* If this has to be a scalar SELECT.  Generate code to put the
1825fef5208cSdrh       ** value of this select in a memory cell and record the number
1826fd773cf9Sdrh       ** of the memory cell in iColumn.  If this is an EXISTS, write
1827fd773cf9Sdrh       ** an integer 0 (not exists) or 1 (exists) into a memory cell
1828fd773cf9Sdrh       ** and record that memory cell in iColumn.
1829fef5208cSdrh       */
1830fd773cf9Sdrh       Select *pSel;                         /* SELECT statement to encode */
1831fd773cf9Sdrh       SelectDest dest;                      /* How to deal with SELECt result */
18321398ad36Sdrh 
1833cf697396Sshane       testcase( pExpr->op==TK_EXISTS );
1834cf697396Sshane       testcase( pExpr->op==TK_SELECT );
1835cf697396Sshane       assert( pExpr->op==TK_EXISTS || pExpr->op==TK_SELECT );
1836cf697396Sshane 
18376ab3a2ecSdanielk1977       assert( ExprHasProperty(pExpr, EP_xIsSelect) );
18386ab3a2ecSdanielk1977       pSel = pExpr->x.pSelect;
18391013c932Sdrh       sqlite3SelectDestInit(&dest, 0, ++pParse->nMem);
184051522cd3Sdrh       if( pExpr->op==TK_SELECT ){
18416c8c8ce0Sdanielk1977         dest.eDest = SRT_Mem;
18422b596da8Sdrh         sqlite3VdbeAddOp2(v, OP_Null, 0, dest.iSDParm);
1843d4e70ebdSdrh         VdbeComment((v, "Init subquery result"));
184451522cd3Sdrh       }else{
18456c8c8ce0Sdanielk1977         dest.eDest = SRT_Exists;
18462b596da8Sdrh         sqlite3VdbeAddOp2(v, OP_Integer, 0, dest.iSDParm);
1847d4e70ebdSdrh         VdbeComment((v, "Init EXISTS result"));
184851522cd3Sdrh       }
1849633e6d57Sdrh       sqlite3ExprDelete(pParse->db, pSel->pLimit);
1850094430ebSdrh       pSel->pLimit = sqlite3PExpr(pParse, TK_INTEGER, 0, 0,
1851094430ebSdrh                                   &sqlite3IntTokens[1]);
185248b5b041Sdrh       pSel->iLimit = 0;
18537d10d5a6Sdrh       if( sqlite3Select(pParse, pSel, &dest) ){
18541450bc6eSdrh         return 0;
185594ccde58Sdrh       }
18562b596da8Sdrh       rReg = dest.iSDParm;
1857ebb6a65dSdrh       ExprSetVVAProperty(pExpr, EP_NoReduce);
1858b3bce662Sdanielk1977       break;
185919a775c2Sdrh     }
1860cce7d176Sdrh   }
1861b3bce662Sdanielk1977 
1862dfd2d9f6Sdrh   if( testAddr>=0 ){
186348f2d3b1Sdrh     sqlite3VdbeJumpHere(v, testAddr);
1864b3bce662Sdanielk1977   }
1865ceea3321Sdrh   sqlite3ExprCachePop(pParse, 1);
1866fc976065Sdanielk1977 
18671450bc6eSdrh   return rReg;
1868cce7d176Sdrh }
186951522cd3Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
1870cce7d176Sdrh 
1871e3365e6cSdrh #ifndef SQLITE_OMIT_SUBQUERY
1872e3365e6cSdrh /*
1873e3365e6cSdrh ** Generate code for an IN expression.
1874e3365e6cSdrh **
1875e3365e6cSdrh **      x IN (SELECT ...)
1876e3365e6cSdrh **      x IN (value, value, ...)
1877e3365e6cSdrh **
1878e3365e6cSdrh ** The left-hand side (LHS) is a scalar expression.  The right-hand side (RHS)
1879e3365e6cSdrh ** is an array of zero or more values.  The expression is true if the LHS is
1880e3365e6cSdrh ** contained within the RHS.  The value of the expression is unknown (NULL)
1881e3365e6cSdrh ** if the LHS is NULL or if the LHS is not contained within the RHS and the
1882e3365e6cSdrh ** RHS contains one or more NULL values.
1883e3365e6cSdrh **
1884e3365e6cSdrh ** This routine generates code will jump to destIfFalse if the LHS is not
1885e3365e6cSdrh ** contained within the RHS.  If due to NULLs we cannot determine if the LHS
1886e3365e6cSdrh ** is contained in the RHS then jump to destIfNull.  If the LHS is contained
1887e3365e6cSdrh ** within the RHS then fall through.
1888e3365e6cSdrh */
1889e3365e6cSdrh static void sqlite3ExprCodeIN(
1890e3365e6cSdrh   Parse *pParse,        /* Parsing and code generating context */
1891e3365e6cSdrh   Expr *pExpr,          /* The IN expression */
1892e3365e6cSdrh   int destIfFalse,      /* Jump here if LHS is not contained in the RHS */
1893e3365e6cSdrh   int destIfNull        /* Jump here if the results are unknown due to NULLs */
1894e3365e6cSdrh ){
1895e3365e6cSdrh   int rRhsHasNull = 0;  /* Register that is true if RHS contains NULL values */
1896e3365e6cSdrh   char affinity;        /* Comparison affinity to use */
1897e3365e6cSdrh   int eType;            /* Type of the RHS */
1898e3365e6cSdrh   int r1;               /* Temporary use register */
1899e3365e6cSdrh   Vdbe *v;              /* Statement under construction */
1900e3365e6cSdrh 
1901e3365e6cSdrh   /* Compute the RHS.   After this step, the table with cursor
1902e3365e6cSdrh   ** pExpr->iTable will contains the values that make up the RHS.
1903e3365e6cSdrh   */
1904e3365e6cSdrh   v = pParse->pVdbe;
1905e3365e6cSdrh   assert( v!=0 );       /* OOM detected prior to this routine */
1906e3365e6cSdrh   VdbeNoopComment((v, "begin IN expr"));
1907e3365e6cSdrh   eType = sqlite3FindInIndex(pParse, pExpr, &rRhsHasNull);
1908e3365e6cSdrh 
1909e3365e6cSdrh   /* Figure out the affinity to use to create a key from the results
1910e3365e6cSdrh   ** of the expression. affinityStr stores a static string suitable for
1911e3365e6cSdrh   ** P4 of OP_MakeRecord.
1912e3365e6cSdrh   */
1913e3365e6cSdrh   affinity = comparisonAffinity(pExpr);
1914e3365e6cSdrh 
1915e3365e6cSdrh   /* Code the LHS, the <expr> from "<expr> IN (...)".
1916e3365e6cSdrh   */
1917e3365e6cSdrh   sqlite3ExprCachePush(pParse);
1918e3365e6cSdrh   r1 = sqlite3GetTempReg(pParse);
1919e3365e6cSdrh   sqlite3ExprCode(pParse, pExpr->pLeft, r1);
1920e3365e6cSdrh 
1921094430ebSdrh   /* If the LHS is NULL, then the result is either false or NULL depending
1922094430ebSdrh   ** on whether the RHS is empty or not, respectively.
1923094430ebSdrh   */
1924094430ebSdrh   if( destIfNull==destIfFalse ){
1925094430ebSdrh     /* Shortcut for the common case where the false and NULL outcomes are
1926094430ebSdrh     ** the same. */
1927094430ebSdrh     sqlite3VdbeAddOp2(v, OP_IsNull, r1, destIfNull);
1928094430ebSdrh   }else{
1929094430ebSdrh     int addr1 = sqlite3VdbeAddOp1(v, OP_NotNull, r1);
1930094430ebSdrh     sqlite3VdbeAddOp2(v, OP_Rewind, pExpr->iTable, destIfFalse);
1931094430ebSdrh     sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfNull);
1932094430ebSdrh     sqlite3VdbeJumpHere(v, addr1);
1933094430ebSdrh   }
1934e3365e6cSdrh 
1935e3365e6cSdrh   if( eType==IN_INDEX_ROWID ){
1936e3365e6cSdrh     /* In this case, the RHS is the ROWID of table b-tree
1937e3365e6cSdrh     */
1938e3365e6cSdrh     sqlite3VdbeAddOp2(v, OP_MustBeInt, r1, destIfFalse);
1939e3365e6cSdrh     sqlite3VdbeAddOp3(v, OP_NotExists, pExpr->iTable, destIfFalse, r1);
1940e3365e6cSdrh   }else{
1941e3365e6cSdrh     /* In this case, the RHS is an index b-tree.
1942e3365e6cSdrh     */
19438cff69dfSdrh     sqlite3VdbeAddOp4(v, OP_Affinity, r1, 1, 0, &affinity, 1);
1944e3365e6cSdrh 
1945e3365e6cSdrh     /* If the set membership test fails, then the result of the
1946e3365e6cSdrh     ** "x IN (...)" expression must be either 0 or NULL. If the set
1947e3365e6cSdrh     ** contains no NULL values, then the result is 0. If the set
1948e3365e6cSdrh     ** contains one or more NULL values, then the result of the
1949e3365e6cSdrh     ** expression is also NULL.
1950e3365e6cSdrh     */
1951e3365e6cSdrh     if( rRhsHasNull==0 || destIfFalse==destIfNull ){
1952e3365e6cSdrh       /* This branch runs if it is known at compile time that the RHS
1953e3365e6cSdrh       ** cannot contain NULL values. This happens as the result
1954e3365e6cSdrh       ** of a "NOT NULL" constraint in the database schema.
1955e3365e6cSdrh       **
1956e3365e6cSdrh       ** Also run this branch if NULL is equivalent to FALSE
1957e3365e6cSdrh       ** for this particular IN operator.
1958e3365e6cSdrh       */
19598cff69dfSdrh       sqlite3VdbeAddOp4Int(v, OP_NotFound, pExpr->iTable, destIfFalse, r1, 1);
1960e3365e6cSdrh 
1961e3365e6cSdrh     }else{
1962e3365e6cSdrh       /* In this branch, the RHS of the IN might contain a NULL and
1963e3365e6cSdrh       ** the presence of a NULL on the RHS makes a difference in the
1964e3365e6cSdrh       ** outcome.
1965e3365e6cSdrh       */
1966e3365e6cSdrh       int j1, j2, j3;
1967e3365e6cSdrh 
1968e3365e6cSdrh       /* First check to see if the LHS is contained in the RHS.  If so,
1969e3365e6cSdrh       ** then the presence of NULLs in the RHS does not matter, so jump
1970e3365e6cSdrh       ** over all of the code that follows.
1971e3365e6cSdrh       */
19728cff69dfSdrh       j1 = sqlite3VdbeAddOp4Int(v, OP_Found, pExpr->iTable, 0, r1, 1);
1973e3365e6cSdrh 
1974e3365e6cSdrh       /* Here we begin generating code that runs if the LHS is not
1975e3365e6cSdrh       ** contained within the RHS.  Generate additional code that
1976e3365e6cSdrh       ** tests the RHS for NULLs.  If the RHS contains a NULL then
1977e3365e6cSdrh       ** jump to destIfNull.  If there are no NULLs in the RHS then
1978e3365e6cSdrh       ** jump to destIfFalse.
1979e3365e6cSdrh       */
1980e3365e6cSdrh       j2 = sqlite3VdbeAddOp1(v, OP_NotNull, rRhsHasNull);
19818cff69dfSdrh       j3 = sqlite3VdbeAddOp4Int(v, OP_Found, pExpr->iTable, 0, rRhsHasNull, 1);
1982e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_Integer, -1, rRhsHasNull);
1983e3365e6cSdrh       sqlite3VdbeJumpHere(v, j3);
1984e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_AddImm, rRhsHasNull, 1);
1985e3365e6cSdrh       sqlite3VdbeJumpHere(v, j2);
1986e3365e6cSdrh 
1987e3365e6cSdrh       /* Jump to the appropriate target depending on whether or not
1988e3365e6cSdrh       ** the RHS contains a NULL
1989e3365e6cSdrh       */
1990e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_If, rRhsHasNull, destIfNull);
1991e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfFalse);
1992e3365e6cSdrh 
1993e3365e6cSdrh       /* The OP_Found at the top of this branch jumps here when true,
1994e3365e6cSdrh       ** causing the overall IN expression evaluation to fall through.
1995e3365e6cSdrh       */
1996e3365e6cSdrh       sqlite3VdbeJumpHere(v, j1);
1997e3365e6cSdrh     }
1998e3365e6cSdrh   }
1999e3365e6cSdrh   sqlite3ReleaseTempReg(pParse, r1);
2000e3365e6cSdrh   sqlite3ExprCachePop(pParse, 1);
2001e3365e6cSdrh   VdbeComment((v, "end IN expr"));
2002e3365e6cSdrh }
2003e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
2004e3365e6cSdrh 
2005cce7d176Sdrh /*
2006598f1340Sdrh ** Duplicate an 8-byte value
2007598f1340Sdrh */
2008598f1340Sdrh static char *dup8bytes(Vdbe *v, const char *in){
2009598f1340Sdrh   char *out = sqlite3DbMallocRaw(sqlite3VdbeDb(v), 8);
2010598f1340Sdrh   if( out ){
2011598f1340Sdrh     memcpy(out, in, 8);
2012598f1340Sdrh   }
2013598f1340Sdrh   return out;
2014598f1340Sdrh }
2015598f1340Sdrh 
201613573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
2017598f1340Sdrh /*
2018598f1340Sdrh ** Generate an instruction that will put the floating point
20199cbf3425Sdrh ** value described by z[0..n-1] into register iMem.
20200cf19ed8Sdrh **
20210cf19ed8Sdrh ** The z[] string will probably not be zero-terminated.  But the
20220cf19ed8Sdrh ** z[n] character is guaranteed to be something that does not look
20230cf19ed8Sdrh ** like the continuation of the number.
2024598f1340Sdrh */
2025b7916a78Sdrh static void codeReal(Vdbe *v, const char *z, int negateFlag, int iMem){
2026fd773cf9Sdrh   if( ALWAYS(z!=0) ){
2027598f1340Sdrh     double value;
2028598f1340Sdrh     char *zV;
20299339da1fSdrh     sqlite3AtoF(z, &value, sqlite3Strlen30(z), SQLITE_UTF8);
2030d0015161Sdrh     assert( !sqlite3IsNaN(value) ); /* The new AtoF never returns NaN */
2031598f1340Sdrh     if( negateFlag ) value = -value;
2032598f1340Sdrh     zV = dup8bytes(v, (char*)&value);
20339de221dfSdrh     sqlite3VdbeAddOp4(v, OP_Real, 0, iMem, 0, zV, P4_REAL);
2034598f1340Sdrh   }
2035598f1340Sdrh }
203613573c71Sdrh #endif
2037598f1340Sdrh 
2038598f1340Sdrh 
2039598f1340Sdrh /*
2040fec19aadSdrh ** Generate an instruction that will put the integer describe by
20419cbf3425Sdrh ** text z[0..n-1] into register iMem.
20420cf19ed8Sdrh **
20435f1d6b61Sshaneh ** Expr.u.zToken is always UTF8 and zero-terminated.
2044fec19aadSdrh */
204513573c71Sdrh static void codeInteger(Parse *pParse, Expr *pExpr, int negFlag, int iMem){
204613573c71Sdrh   Vdbe *v = pParse->pVdbe;
204792b01d53Sdrh   if( pExpr->flags & EP_IntValue ){
204833e619fcSdrh     int i = pExpr->u.iValue;
2049d50ffc41Sdrh     assert( i>=0 );
205092b01d53Sdrh     if( negFlag ) i = -i;
205192b01d53Sdrh     sqlite3VdbeAddOp2(v, OP_Integer, i, iMem);
2052fd773cf9Sdrh   }else{
20535f1d6b61Sshaneh     int c;
20545f1d6b61Sshaneh     i64 value;
2055fd773cf9Sdrh     const char *z = pExpr->u.zToken;
2056fd773cf9Sdrh     assert( z!=0 );
20575f1d6b61Sshaneh     c = sqlite3Atoi64(z, &value, sqlite3Strlen30(z), SQLITE_UTF8);
20585f1d6b61Sshaneh     if( c==0 || (c==2 && negFlag) ){
2059598f1340Sdrh       char *zV;
2060158b9cb9Sdrh       if( negFlag ){ value = c==2 ? SMALLEST_INT64 : -value; }
2061598f1340Sdrh       zV = dup8bytes(v, (char*)&value);
20629de221dfSdrh       sqlite3VdbeAddOp4(v, OP_Int64, 0, iMem, 0, zV, P4_INT64);
2063fec19aadSdrh     }else{
206413573c71Sdrh #ifdef SQLITE_OMIT_FLOATING_POINT
206513573c71Sdrh       sqlite3ErrorMsg(pParse, "oversized integer: %s%s", negFlag ? "-" : "", z);
206613573c71Sdrh #else
2067b7916a78Sdrh       codeReal(v, z, negFlag, iMem);
206813573c71Sdrh #endif
2069fec19aadSdrh     }
2070fec19aadSdrh   }
2071c9cf901dSdanielk1977 }
2072fec19aadSdrh 
2073ceea3321Sdrh /*
2074ceea3321Sdrh ** Clear a cache entry.
2075ceea3321Sdrh */
2076ceea3321Sdrh static void cacheEntryClear(Parse *pParse, struct yColCache *p){
2077ceea3321Sdrh   if( p->tempReg ){
2078ceea3321Sdrh     if( pParse->nTempReg<ArraySize(pParse->aTempReg) ){
2079ceea3321Sdrh       pParse->aTempReg[pParse->nTempReg++] = p->iReg;
2080ceea3321Sdrh     }
2081ceea3321Sdrh     p->tempReg = 0;
2082ceea3321Sdrh   }
2083ceea3321Sdrh }
2084ceea3321Sdrh 
2085ceea3321Sdrh 
2086ceea3321Sdrh /*
2087ceea3321Sdrh ** Record in the column cache that a particular column from a
2088ceea3321Sdrh ** particular table is stored in a particular register.
2089ceea3321Sdrh */
2090ceea3321Sdrh void sqlite3ExprCacheStore(Parse *pParse, int iTab, int iCol, int iReg){
2091ceea3321Sdrh   int i;
2092ceea3321Sdrh   int minLru;
2093ceea3321Sdrh   int idxLru;
2094ceea3321Sdrh   struct yColCache *p;
2095ceea3321Sdrh 
209620411ea7Sdrh   assert( iReg>0 );  /* Register numbers are always positive */
209720411ea7Sdrh   assert( iCol>=-1 && iCol<32768 );  /* Finite column numbers */
209820411ea7Sdrh 
2099b6da74ebSdrh   /* The SQLITE_ColumnCache flag disables the column cache.  This is used
2100b6da74ebSdrh   ** for testing only - to verify that SQLite always gets the same answer
2101b6da74ebSdrh   ** with and without the column cache.
2102b6da74ebSdrh   */
21037e5418e4Sdrh   if( OptimizationDisabled(pParse->db, SQLITE_ColumnCache) ) return;
2104b6da74ebSdrh 
210527ee406eSdrh   /* First replace any existing entry.
210627ee406eSdrh   **
210727ee406eSdrh   ** Actually, the way the column cache is currently used, we are guaranteed
210827ee406eSdrh   ** that the object will never already be in cache.  Verify this guarantee.
210927ee406eSdrh   */
211027ee406eSdrh #ifndef NDEBUG
2111ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
211227ee406eSdrh     assert( p->iReg==0 || p->iTable!=iTab || p->iColumn!=iCol );
2113ceea3321Sdrh   }
211427ee406eSdrh #endif
2115ceea3321Sdrh 
2116ceea3321Sdrh   /* Find an empty slot and replace it */
2117ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2118ceea3321Sdrh     if( p->iReg==0 ){
2119ceea3321Sdrh       p->iLevel = pParse->iCacheLevel;
2120ceea3321Sdrh       p->iTable = iTab;
2121ceea3321Sdrh       p->iColumn = iCol;
2122ceea3321Sdrh       p->iReg = iReg;
2123ceea3321Sdrh       p->tempReg = 0;
2124ceea3321Sdrh       p->lru = pParse->iCacheCnt++;
2125ceea3321Sdrh       return;
2126ceea3321Sdrh     }
2127ceea3321Sdrh   }
2128ceea3321Sdrh 
2129ceea3321Sdrh   /* Replace the last recently used */
2130ceea3321Sdrh   minLru = 0x7fffffff;
2131ceea3321Sdrh   idxLru = -1;
2132ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2133ceea3321Sdrh     if( p->lru<minLru ){
2134ceea3321Sdrh       idxLru = i;
2135ceea3321Sdrh       minLru = p->lru;
2136ceea3321Sdrh     }
2137ceea3321Sdrh   }
213820411ea7Sdrh   if( ALWAYS(idxLru>=0) ){
2139ceea3321Sdrh     p = &pParse->aColCache[idxLru];
2140ceea3321Sdrh     p->iLevel = pParse->iCacheLevel;
2141ceea3321Sdrh     p->iTable = iTab;
2142ceea3321Sdrh     p->iColumn = iCol;
2143ceea3321Sdrh     p->iReg = iReg;
2144ceea3321Sdrh     p->tempReg = 0;
2145ceea3321Sdrh     p->lru = pParse->iCacheCnt++;
2146ceea3321Sdrh     return;
2147ceea3321Sdrh   }
2148ceea3321Sdrh }
2149ceea3321Sdrh 
2150ceea3321Sdrh /*
2151f49f3523Sdrh ** Indicate that registers between iReg..iReg+nReg-1 are being overwritten.
2152f49f3523Sdrh ** Purge the range of registers from the column cache.
2153ceea3321Sdrh */
2154f49f3523Sdrh void sqlite3ExprCacheRemove(Parse *pParse, int iReg, int nReg){
2155ceea3321Sdrh   int i;
2156f49f3523Sdrh   int iLast = iReg + nReg - 1;
2157ceea3321Sdrh   struct yColCache *p;
2158ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2159f49f3523Sdrh     int r = p->iReg;
2160f49f3523Sdrh     if( r>=iReg && r<=iLast ){
2161ceea3321Sdrh       cacheEntryClear(pParse, p);
2162ceea3321Sdrh       p->iReg = 0;
2163ceea3321Sdrh     }
2164ceea3321Sdrh   }
2165ceea3321Sdrh }
2166ceea3321Sdrh 
2167ceea3321Sdrh /*
2168ceea3321Sdrh ** Remember the current column cache context.  Any new entries added
2169ceea3321Sdrh ** added to the column cache after this call are removed when the
2170ceea3321Sdrh ** corresponding pop occurs.
2171ceea3321Sdrh */
2172ceea3321Sdrh void sqlite3ExprCachePush(Parse *pParse){
2173ceea3321Sdrh   pParse->iCacheLevel++;
2174ceea3321Sdrh }
2175ceea3321Sdrh 
2176ceea3321Sdrh /*
2177ceea3321Sdrh ** Remove from the column cache any entries that were added since the
2178ceea3321Sdrh ** the previous N Push operations.  In other words, restore the cache
2179ceea3321Sdrh ** to the state it was in N Pushes ago.
2180ceea3321Sdrh */
2181ceea3321Sdrh void sqlite3ExprCachePop(Parse *pParse, int N){
2182ceea3321Sdrh   int i;
2183ceea3321Sdrh   struct yColCache *p;
2184ceea3321Sdrh   assert( N>0 );
2185ceea3321Sdrh   assert( pParse->iCacheLevel>=N );
2186ceea3321Sdrh   pParse->iCacheLevel -= N;
2187ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2188ceea3321Sdrh     if( p->iReg && p->iLevel>pParse->iCacheLevel ){
2189ceea3321Sdrh       cacheEntryClear(pParse, p);
2190ceea3321Sdrh       p->iReg = 0;
2191ceea3321Sdrh     }
2192ceea3321Sdrh   }
2193ceea3321Sdrh }
2194945498f3Sdrh 
2195945498f3Sdrh /*
21965cd79239Sdrh ** When a cached column is reused, make sure that its register is
21975cd79239Sdrh ** no longer available as a temp register.  ticket #3879:  that same
21985cd79239Sdrh ** register might be in the cache in multiple places, so be sure to
21995cd79239Sdrh ** get them all.
22005cd79239Sdrh */
22015cd79239Sdrh static void sqlite3ExprCachePinRegister(Parse *pParse, int iReg){
22025cd79239Sdrh   int i;
22035cd79239Sdrh   struct yColCache *p;
22045cd79239Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
22055cd79239Sdrh     if( p->iReg==iReg ){
22065cd79239Sdrh       p->tempReg = 0;
22075cd79239Sdrh     }
22085cd79239Sdrh   }
22095cd79239Sdrh }
22105cd79239Sdrh 
22115cd79239Sdrh /*
22125c092e8aSdrh ** Generate code to extract the value of the iCol-th column of a table.
22135c092e8aSdrh */
22145c092e8aSdrh void sqlite3ExprCodeGetColumnOfTable(
22155c092e8aSdrh   Vdbe *v,        /* The VDBE under construction */
22165c092e8aSdrh   Table *pTab,    /* The table containing the value */
22175c092e8aSdrh   int iTabCur,    /* The cursor for this table */
22185c092e8aSdrh   int iCol,       /* Index of the column to extract */
22195c092e8aSdrh   int regOut      /* Extract the valud into this register */
22205c092e8aSdrh ){
22215c092e8aSdrh   if( iCol<0 || iCol==pTab->iPKey ){
22225c092e8aSdrh     sqlite3VdbeAddOp2(v, OP_Rowid, iTabCur, regOut);
22235c092e8aSdrh   }else{
22245c092e8aSdrh     int op = IsVirtual(pTab) ? OP_VColumn : OP_Column;
22255c092e8aSdrh     sqlite3VdbeAddOp3(v, op, iTabCur, iCol, regOut);
22265c092e8aSdrh   }
22275c092e8aSdrh   if( iCol>=0 ){
22285c092e8aSdrh     sqlite3ColumnDefault(v, pTab, iCol, regOut);
22295c092e8aSdrh   }
22305c092e8aSdrh }
22315c092e8aSdrh 
22325c092e8aSdrh /*
2233945498f3Sdrh ** Generate code that will extract the iColumn-th column from
2234e55cbd72Sdrh ** table pTab and store the column value in a register.  An effort
2235e55cbd72Sdrh ** is made to store the column value in register iReg, but this is
2236e55cbd72Sdrh ** not guaranteed.  The location of the column value is returned.
2237e55cbd72Sdrh **
2238e55cbd72Sdrh ** There must be an open cursor to pTab in iTable when this routine
2239e55cbd72Sdrh ** is called.  If iColumn<0 then code is generated that extracts the rowid.
2240945498f3Sdrh */
2241e55cbd72Sdrh int sqlite3ExprCodeGetColumn(
2242e55cbd72Sdrh   Parse *pParse,   /* Parsing and code generating context */
22432133d822Sdrh   Table *pTab,     /* Description of the table we are reading from */
22442133d822Sdrh   int iColumn,     /* Index of the table column */
22452133d822Sdrh   int iTable,      /* The cursor pointing to the table */
2246a748fdccSdrh   int iReg,        /* Store results here */
2247a748fdccSdrh   u8 p5            /* P5 value for OP_Column */
22482133d822Sdrh ){
2249e55cbd72Sdrh   Vdbe *v = pParse->pVdbe;
2250e55cbd72Sdrh   int i;
2251da250ea5Sdrh   struct yColCache *p;
2252e55cbd72Sdrh 
2253ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2254b6da74ebSdrh     if( p->iReg>0 && p->iTable==iTable && p->iColumn==iColumn ){
2255ceea3321Sdrh       p->lru = pParse->iCacheCnt++;
22565cd79239Sdrh       sqlite3ExprCachePinRegister(pParse, p->iReg);
2257da250ea5Sdrh       return p->iReg;
2258e55cbd72Sdrh     }
2259e55cbd72Sdrh   }
2260e55cbd72Sdrh   assert( v!=0 );
22615c092e8aSdrh   sqlite3ExprCodeGetColumnOfTable(v, pTab, iTable, iColumn, iReg);
2262a748fdccSdrh   if( p5 ){
2263a748fdccSdrh     sqlite3VdbeChangeP5(v, p5);
2264a748fdccSdrh   }else{
2265ceea3321Sdrh     sqlite3ExprCacheStore(pParse, iTable, iColumn, iReg);
2266a748fdccSdrh   }
2267e55cbd72Sdrh   return iReg;
2268e55cbd72Sdrh }
2269e55cbd72Sdrh 
2270e55cbd72Sdrh /*
2271ceea3321Sdrh ** Clear all column cache entries.
2272e55cbd72Sdrh */
2273ceea3321Sdrh void sqlite3ExprCacheClear(Parse *pParse){
2274e55cbd72Sdrh   int i;
2275ceea3321Sdrh   struct yColCache *p;
2276ceea3321Sdrh 
2277ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2278ceea3321Sdrh     if( p->iReg ){
2279ceea3321Sdrh       cacheEntryClear(pParse, p);
2280ceea3321Sdrh       p->iReg = 0;
2281e55cbd72Sdrh     }
2282da250ea5Sdrh   }
2283da250ea5Sdrh }
2284e55cbd72Sdrh 
2285e55cbd72Sdrh /*
2286da250ea5Sdrh ** Record the fact that an affinity change has occurred on iCount
2287da250ea5Sdrh ** registers starting with iStart.
2288e55cbd72Sdrh */
2289da250ea5Sdrh void sqlite3ExprCacheAffinityChange(Parse *pParse, int iStart, int iCount){
2290f49f3523Sdrh   sqlite3ExprCacheRemove(pParse, iStart, iCount);
2291e55cbd72Sdrh }
2292e55cbd72Sdrh 
2293e55cbd72Sdrh /*
2294b21e7c70Sdrh ** Generate code to move content from registers iFrom...iFrom+nReg-1
2295b21e7c70Sdrh ** over to iTo..iTo+nReg-1. Keep the column cache up-to-date.
2296e55cbd72Sdrh */
2297b21e7c70Sdrh void sqlite3ExprCodeMove(Parse *pParse, int iFrom, int iTo, int nReg){
2298e55cbd72Sdrh   int i;
2299ceea3321Sdrh   struct yColCache *p;
2300e8e4af76Sdrh   assert( iFrom>=iTo+nReg || iFrom+nReg<=iTo );
2301e8e4af76Sdrh   sqlite3VdbeAddOp3(pParse->pVdbe, OP_Move, iFrom, iTo, nReg-1);
2302ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2303ceea3321Sdrh     int x = p->iReg;
2304b21e7c70Sdrh     if( x>=iFrom && x<iFrom+nReg ){
2305ceea3321Sdrh       p->iReg += iTo-iFrom;
2306e55cbd72Sdrh     }
2307e55cbd72Sdrh   }
2308945498f3Sdrh }
2309945498f3Sdrh 
2310f49f3523Sdrh #if defined(SQLITE_DEBUG) || defined(SQLITE_COVERAGE_TEST)
231192b01d53Sdrh /*
2312652fbf55Sdrh ** Return true if any register in the range iFrom..iTo (inclusive)
2313652fbf55Sdrh ** is used as part of the column cache.
2314f49f3523Sdrh **
2315f49f3523Sdrh ** This routine is used within assert() and testcase() macros only
2316f49f3523Sdrh ** and does not appear in a normal build.
2317652fbf55Sdrh */
2318652fbf55Sdrh static int usedAsColumnCache(Parse *pParse, int iFrom, int iTo){
2319652fbf55Sdrh   int i;
2320ceea3321Sdrh   struct yColCache *p;
2321ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2322ceea3321Sdrh     int r = p->iReg;
2323f49f3523Sdrh     if( r>=iFrom && r<=iTo ) return 1;    /*NO_TEST*/
2324652fbf55Sdrh   }
2325652fbf55Sdrh   return 0;
2326652fbf55Sdrh }
2327f49f3523Sdrh #endif /* SQLITE_DEBUG || SQLITE_COVERAGE_TEST */
2328652fbf55Sdrh 
2329652fbf55Sdrh /*
2330a4c3c87eSdrh ** Convert an expression node to a TK_REGISTER
2331a4c3c87eSdrh */
2332a4c3c87eSdrh static void exprToRegister(Expr *p, int iReg){
2333a4c3c87eSdrh   p->op2 = p->op;
2334a4c3c87eSdrh   p->op = TK_REGISTER;
2335a4c3c87eSdrh   p->iTable = iReg;
2336a4c3c87eSdrh   ExprClearProperty(p, EP_Skip);
2337a4c3c87eSdrh }
2338a4c3c87eSdrh 
2339a4c3c87eSdrh /*
2340cce7d176Sdrh ** Generate code into the current Vdbe to evaluate the given
23412dcef11bSdrh ** expression.  Attempt to store the results in register "target".
23422dcef11bSdrh ** Return the register where results are stored.
2343389a1adbSdrh **
23448b213899Sdrh ** With this routine, there is no guarantee that results will
23452dcef11bSdrh ** be stored in target.  The result might be stored in some other
23462dcef11bSdrh ** register if it is convenient to do so.  The calling function
23472dcef11bSdrh ** must check the return code and move the results to the desired
23482dcef11bSdrh ** register.
2349cce7d176Sdrh */
2350678ccce8Sdrh int sqlite3ExprCodeTarget(Parse *pParse, Expr *pExpr, int target){
23512dcef11bSdrh   Vdbe *v = pParse->pVdbe;  /* The VM under construction */
23522dcef11bSdrh   int op;                   /* The opcode being coded */
23532dcef11bSdrh   int inReg = target;       /* Results stored in register inReg */
23542dcef11bSdrh   int regFree1 = 0;         /* If non-zero free this temporary register */
23552dcef11bSdrh   int regFree2 = 0;         /* If non-zero free this temporary register */
2356678ccce8Sdrh   int r1, r2, r3, r4;       /* Various register numbers */
235720411ea7Sdrh   sqlite3 *db = pParse->db; /* The database connection */
2358ffe07b2dSdrh 
23599cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
236020411ea7Sdrh   if( v==0 ){
236120411ea7Sdrh     assert( pParse->db->mallocFailed );
236220411ea7Sdrh     return 0;
236320411ea7Sdrh   }
2364389a1adbSdrh 
2365389a1adbSdrh   if( pExpr==0 ){
2366389a1adbSdrh     op = TK_NULL;
2367389a1adbSdrh   }else{
2368f2bc013cSdrh     op = pExpr->op;
2369389a1adbSdrh   }
2370f2bc013cSdrh   switch( op ){
237113449892Sdrh     case TK_AGG_COLUMN: {
237213449892Sdrh       AggInfo *pAggInfo = pExpr->pAggInfo;
237313449892Sdrh       struct AggInfo_col *pCol = &pAggInfo->aCol[pExpr->iAgg];
237413449892Sdrh       if( !pAggInfo->directMode ){
23759de221dfSdrh         assert( pCol->iMem>0 );
23769de221dfSdrh         inReg = pCol->iMem;
237713449892Sdrh         break;
237813449892Sdrh       }else if( pAggInfo->useSortingIdx ){
23795134d135Sdan         sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdxPTab,
2380389a1adbSdrh                               pCol->iSorterColumn, target);
238113449892Sdrh         break;
238213449892Sdrh       }
238313449892Sdrh       /* Otherwise, fall thru into the TK_COLUMN case */
238413449892Sdrh     }
2385967e8b73Sdrh     case TK_COLUMN: {
2386b2b9d3d7Sdrh       int iTab = pExpr->iTable;
2387b2b9d3d7Sdrh       if( iTab<0 ){
2388b2b9d3d7Sdrh         if( pParse->ckBase>0 ){
2389b2b9d3d7Sdrh           /* Generating CHECK constraints or inserting into partial index */
2390aa9b8963Sdrh           inReg = pExpr->iColumn + pParse->ckBase;
2391b2b9d3d7Sdrh           break;
2392c4a3c779Sdrh         }else{
2393b2b9d3d7Sdrh           /* Deleting from a partial index */
2394b2b9d3d7Sdrh           iTab = pParse->iPartIdxTab;
23952282792aSdrh         }
2396b2b9d3d7Sdrh       }
2397b2b9d3d7Sdrh       inReg = sqlite3ExprCodeGetColumn(pParse, pExpr->pTab,
2398b2b9d3d7Sdrh                                pExpr->iColumn, iTab, target,
2399b2b9d3d7Sdrh                                pExpr->op2);
2400cce7d176Sdrh       break;
2401cce7d176Sdrh     }
2402cce7d176Sdrh     case TK_INTEGER: {
240313573c71Sdrh       codeInteger(pParse, pExpr, 0, target);
2404fec19aadSdrh       break;
240551e9a445Sdrh     }
240613573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
2407598f1340Sdrh     case TK_FLOAT: {
240833e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
240933e619fcSdrh       codeReal(v, pExpr->u.zToken, 0, target);
2410598f1340Sdrh       break;
2411598f1340Sdrh     }
241213573c71Sdrh #endif
2413fec19aadSdrh     case TK_STRING: {
241433e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
241533e619fcSdrh       sqlite3VdbeAddOp4(v, OP_String8, 0, target, 0, pExpr->u.zToken, 0);
2416cce7d176Sdrh       break;
2417cce7d176Sdrh     }
2418f0863fe5Sdrh     case TK_NULL: {
24199de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
2420f0863fe5Sdrh       break;
2421f0863fe5Sdrh     }
24225338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_BLOB_LITERAL
2423c572ef7fSdanielk1977     case TK_BLOB: {
24246c8c6cecSdrh       int n;
24256c8c6cecSdrh       const char *z;
2426ca48c90fSdrh       char *zBlob;
242733e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
242833e619fcSdrh       assert( pExpr->u.zToken[0]=='x' || pExpr->u.zToken[0]=='X' );
242933e619fcSdrh       assert( pExpr->u.zToken[1]=='\'' );
243033e619fcSdrh       z = &pExpr->u.zToken[2];
2431b7916a78Sdrh       n = sqlite3Strlen30(z) - 1;
2432b7916a78Sdrh       assert( z[n]=='\'' );
2433ca48c90fSdrh       zBlob = sqlite3HexToBlob(sqlite3VdbeDb(v), z, n);
2434ca48c90fSdrh       sqlite3VdbeAddOp4(v, OP_Blob, n/2, target, 0, zBlob, P4_DYNAMIC);
2435c572ef7fSdanielk1977       break;
2436c572ef7fSdanielk1977     }
24375338a5f7Sdanielk1977 #endif
243850457896Sdrh     case TK_VARIABLE: {
243933e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
244033e619fcSdrh       assert( pExpr->u.zToken!=0 );
244133e619fcSdrh       assert( pExpr->u.zToken[0]!=0 );
2442eaf52d88Sdrh       sqlite3VdbeAddOp2(v, OP_Variable, pExpr->iColumn, target);
244333e619fcSdrh       if( pExpr->u.zToken[1]!=0 ){
244404e9eeadSdrh         assert( pExpr->u.zToken[0]=='?'
244504e9eeadSdrh              || strcmp(pExpr->u.zToken, pParse->azVar[pExpr->iColumn-1])==0 );
244604e9eeadSdrh         sqlite3VdbeChangeP4(v, -1, pParse->azVar[pExpr->iColumn-1], P4_STATIC);
2447895d7472Sdrh       }
244850457896Sdrh       break;
244950457896Sdrh     }
24504e0cff60Sdrh     case TK_REGISTER: {
24519de221dfSdrh       inReg = pExpr->iTable;
24524e0cff60Sdrh       break;
24534e0cff60Sdrh     }
24548b213899Sdrh     case TK_AS: {
24557445ffe2Sdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
24568b213899Sdrh       break;
24578b213899Sdrh     }
2458487e262fSdrh #ifndef SQLITE_OMIT_CAST
2459487e262fSdrh     case TK_CAST: {
2460487e262fSdrh       /* Expressions of the form:   CAST(pLeft AS token) */
2461f0113000Sdanielk1977       int aff, to_op;
24622dcef11bSdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
246333e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
2464fdaac671Sdrh       aff = sqlite3AffinityType(pExpr->u.zToken, 0);
2465f0113000Sdanielk1977       to_op = aff - SQLITE_AFF_TEXT + OP_ToText;
2466f0113000Sdanielk1977       assert( to_op==OP_ToText    || aff!=SQLITE_AFF_TEXT    );
2467f0113000Sdanielk1977       assert( to_op==OP_ToBlob    || aff!=SQLITE_AFF_NONE    );
2468f0113000Sdanielk1977       assert( to_op==OP_ToNumeric || aff!=SQLITE_AFF_NUMERIC );
2469f0113000Sdanielk1977       assert( to_op==OP_ToInt     || aff!=SQLITE_AFF_INTEGER );
2470f0113000Sdanielk1977       assert( to_op==OP_ToReal    || aff!=SQLITE_AFF_REAL    );
2471c5499befSdrh       testcase( to_op==OP_ToText );
2472c5499befSdrh       testcase( to_op==OP_ToBlob );
2473c5499befSdrh       testcase( to_op==OP_ToNumeric );
2474c5499befSdrh       testcase( to_op==OP_ToInt );
2475c5499befSdrh       testcase( to_op==OP_ToReal );
24761735fa88Sdrh       if( inReg!=target ){
24771735fa88Sdrh         sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
24781735fa88Sdrh         inReg = target;
24791735fa88Sdrh       }
24802dcef11bSdrh       sqlite3VdbeAddOp1(v, to_op, inReg);
2481c5499befSdrh       testcase( usedAsColumnCache(pParse, inReg, inReg) );
2482b3843a82Sdrh       sqlite3ExprCacheAffinityChange(pParse, inReg, 1);
2483487e262fSdrh       break;
2484487e262fSdrh     }
2485487e262fSdrh #endif /* SQLITE_OMIT_CAST */
2486c9b84a1fSdrh     case TK_LT:
2487c9b84a1fSdrh     case TK_LE:
2488c9b84a1fSdrh     case TK_GT:
2489c9b84a1fSdrh     case TK_GE:
2490c9b84a1fSdrh     case TK_NE:
2491c9b84a1fSdrh     case TK_EQ: {
2492f2bc013cSdrh       assert( TK_LT==OP_Lt );
2493f2bc013cSdrh       assert( TK_LE==OP_Le );
2494f2bc013cSdrh       assert( TK_GT==OP_Gt );
2495f2bc013cSdrh       assert( TK_GE==OP_Ge );
2496f2bc013cSdrh       assert( TK_EQ==OP_Eq );
2497f2bc013cSdrh       assert( TK_NE==OP_Ne );
2498c5499befSdrh       testcase( op==TK_LT );
2499c5499befSdrh       testcase( op==TK_LE );
2500c5499befSdrh       testcase( op==TK_GT );
2501c5499befSdrh       testcase( op==TK_GE );
2502c5499befSdrh       testcase( op==TK_EQ );
2503c5499befSdrh       testcase( op==TK_NE );
2504b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
2505b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
250635573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
250735573356Sdrh                   r1, r2, inReg, SQLITE_STOREP2);
2508c5499befSdrh       testcase( regFree1==0 );
2509c5499befSdrh       testcase( regFree2==0 );
2510a37cdde0Sdanielk1977       break;
2511c9b84a1fSdrh     }
25126a2fe093Sdrh     case TK_IS:
25136a2fe093Sdrh     case TK_ISNOT: {
25146a2fe093Sdrh       testcase( op==TK_IS );
25156a2fe093Sdrh       testcase( op==TK_ISNOT );
2516b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
2517b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
25186a2fe093Sdrh       op = (op==TK_IS) ? TK_EQ : TK_NE;
25196a2fe093Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
25206a2fe093Sdrh                   r1, r2, inReg, SQLITE_STOREP2 | SQLITE_NULLEQ);
25216a2fe093Sdrh       testcase( regFree1==0 );
25226a2fe093Sdrh       testcase( regFree2==0 );
25236a2fe093Sdrh       break;
25246a2fe093Sdrh     }
2525cce7d176Sdrh     case TK_AND:
2526cce7d176Sdrh     case TK_OR:
2527cce7d176Sdrh     case TK_PLUS:
2528cce7d176Sdrh     case TK_STAR:
2529cce7d176Sdrh     case TK_MINUS:
2530bf4133cbSdrh     case TK_REM:
2531bf4133cbSdrh     case TK_BITAND:
2532bf4133cbSdrh     case TK_BITOR:
253317c40294Sdrh     case TK_SLASH:
2534bf4133cbSdrh     case TK_LSHIFT:
2535855eb1cfSdrh     case TK_RSHIFT:
25360040077dSdrh     case TK_CONCAT: {
2537f2bc013cSdrh       assert( TK_AND==OP_And );
2538f2bc013cSdrh       assert( TK_OR==OP_Or );
2539f2bc013cSdrh       assert( TK_PLUS==OP_Add );
2540f2bc013cSdrh       assert( TK_MINUS==OP_Subtract );
2541f2bc013cSdrh       assert( TK_REM==OP_Remainder );
2542f2bc013cSdrh       assert( TK_BITAND==OP_BitAnd );
2543f2bc013cSdrh       assert( TK_BITOR==OP_BitOr );
2544f2bc013cSdrh       assert( TK_SLASH==OP_Divide );
2545f2bc013cSdrh       assert( TK_LSHIFT==OP_ShiftLeft );
2546f2bc013cSdrh       assert( TK_RSHIFT==OP_ShiftRight );
2547f2bc013cSdrh       assert( TK_CONCAT==OP_Concat );
2548c5499befSdrh       testcase( op==TK_AND );
2549c5499befSdrh       testcase( op==TK_OR );
2550c5499befSdrh       testcase( op==TK_PLUS );
2551c5499befSdrh       testcase( op==TK_MINUS );
2552c5499befSdrh       testcase( op==TK_REM );
2553c5499befSdrh       testcase( op==TK_BITAND );
2554c5499befSdrh       testcase( op==TK_BITOR );
2555c5499befSdrh       testcase( op==TK_SLASH );
2556c5499befSdrh       testcase( op==TK_LSHIFT );
2557c5499befSdrh       testcase( op==TK_RSHIFT );
2558c5499befSdrh       testcase( op==TK_CONCAT );
25592dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
25602dcef11bSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
25615b6afba9Sdrh       sqlite3VdbeAddOp3(v, op, r2, r1, target);
2562c5499befSdrh       testcase( regFree1==0 );
2563c5499befSdrh       testcase( regFree2==0 );
25640040077dSdrh       break;
25650040077dSdrh     }
2566cce7d176Sdrh     case TK_UMINUS: {
2567fec19aadSdrh       Expr *pLeft = pExpr->pLeft;
2568fec19aadSdrh       assert( pLeft );
256913573c71Sdrh       if( pLeft->op==TK_INTEGER ){
257013573c71Sdrh         codeInteger(pParse, pLeft, 1, target);
257113573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
257213573c71Sdrh       }else if( pLeft->op==TK_FLOAT ){
257333e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
257433e619fcSdrh         codeReal(v, pLeft->u.zToken, 1, target);
257513573c71Sdrh #endif
25763c84ddffSdrh       }else{
25772dcef11bSdrh         regFree1 = r1 = sqlite3GetTempReg(pParse);
25783c84ddffSdrh         sqlite3VdbeAddOp2(v, OP_Integer, 0, r1);
2579e55cbd72Sdrh         r2 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree2);
25802dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_Subtract, r2, r1, target);
2581c5499befSdrh         testcase( regFree2==0 );
25823c84ddffSdrh       }
25839de221dfSdrh       inReg = target;
25846e142f54Sdrh       break;
25856e142f54Sdrh     }
2586bf4133cbSdrh     case TK_BITNOT:
25876e142f54Sdrh     case TK_NOT: {
2588f2bc013cSdrh       assert( TK_BITNOT==OP_BitNot );
2589f2bc013cSdrh       assert( TK_NOT==OP_Not );
2590c5499befSdrh       testcase( op==TK_BITNOT );
2591c5499befSdrh       testcase( op==TK_NOT );
2592e99fa2afSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
2593e99fa2afSdrh       testcase( regFree1==0 );
2594e99fa2afSdrh       inReg = target;
2595e99fa2afSdrh       sqlite3VdbeAddOp2(v, op, r1, inReg);
2596cce7d176Sdrh       break;
2597cce7d176Sdrh     }
2598cce7d176Sdrh     case TK_ISNULL:
2599cce7d176Sdrh     case TK_NOTNULL: {
26006a288a33Sdrh       int addr;
2601f2bc013cSdrh       assert( TK_ISNULL==OP_IsNull );
2602f2bc013cSdrh       assert( TK_NOTNULL==OP_NotNull );
2603c5499befSdrh       testcase( op==TK_ISNULL );
2604c5499befSdrh       testcase( op==TK_NOTNULL );
26059de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
26062dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
2607c5499befSdrh       testcase( regFree1==0 );
26082dcef11bSdrh       addr = sqlite3VdbeAddOp1(v, op, r1);
26099de221dfSdrh       sqlite3VdbeAddOp2(v, OP_AddImm, target, -1);
26106a288a33Sdrh       sqlite3VdbeJumpHere(v, addr);
2611a37cdde0Sdanielk1977       break;
2612f2bc013cSdrh     }
26132282792aSdrh     case TK_AGG_FUNCTION: {
261413449892Sdrh       AggInfo *pInfo = pExpr->pAggInfo;
26157e56e711Sdrh       if( pInfo==0 ){
261633e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
261733e619fcSdrh         sqlite3ErrorMsg(pParse, "misuse of aggregate: %s()", pExpr->u.zToken);
26187e56e711Sdrh       }else{
26199de221dfSdrh         inReg = pInfo->aFunc[pExpr->iAgg].iMem;
26207e56e711Sdrh       }
26212282792aSdrh       break;
26222282792aSdrh     }
2623b71090fdSdrh     case TK_CONST_FUNC:
2624cce7d176Sdrh     case TK_FUNCTION: {
262512ffee8cSdrh       ExprList *pFarg;       /* List of function arguments */
262612ffee8cSdrh       int nFarg;             /* Number of function arguments */
262712ffee8cSdrh       FuncDef *pDef;         /* The function definition object */
262812ffee8cSdrh       int nId;               /* Length of the function name in bytes */
262912ffee8cSdrh       const char *zId;       /* The function name */
263012ffee8cSdrh       int constMask = 0;     /* Mask of function arguments that are constant */
263112ffee8cSdrh       int i;                 /* Loop counter */
263212ffee8cSdrh       u8 enc = ENC(db);      /* The text encoding used by this database */
263312ffee8cSdrh       CollSeq *pColl = 0;    /* A collating sequence */
263417435752Sdrh 
26356ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
2636c5499befSdrh       testcase( op==TK_CONST_FUNC );
2637c5499befSdrh       testcase( op==TK_FUNCTION );
2638c5cd1249Sdrh       if( ExprHasProperty(pExpr, EP_TokenOnly) ){
263912ffee8cSdrh         pFarg = 0;
264012ffee8cSdrh       }else{
264112ffee8cSdrh         pFarg = pExpr->x.pList;
264212ffee8cSdrh       }
264312ffee8cSdrh       nFarg = pFarg ? pFarg->nExpr : 0;
264433e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
264533e619fcSdrh       zId = pExpr->u.zToken;
2646b7916a78Sdrh       nId = sqlite3Strlen30(zId);
264712ffee8cSdrh       pDef = sqlite3FindFunction(db, zId, nId, nFarg, enc, 0);
2648feb306f5Sdrh       if( pDef==0 ){
2649feb306f5Sdrh         sqlite3ErrorMsg(pParse, "unknown function: %.*s()", nId, zId);
2650feb306f5Sdrh         break;
2651feb306f5Sdrh       }
2652ae6bb957Sdrh 
2653ae6bb957Sdrh       /* Attempt a direct implementation of the built-in COALESCE() and
2654ae6bb957Sdrh       ** IFNULL() functions.  This avoids unnecessary evalation of
2655ae6bb957Sdrh       ** arguments past the first non-NULL argument.
2656ae6bb957Sdrh       */
2657d36e1041Sdrh       if( pDef->funcFlags & SQLITE_FUNC_COALESCE ){
2658ae6bb957Sdrh         int endCoalesce = sqlite3VdbeMakeLabel(v);
2659ae6bb957Sdrh         assert( nFarg>=2 );
2660ae6bb957Sdrh         sqlite3ExprCode(pParse, pFarg->a[0].pExpr, target);
2661ae6bb957Sdrh         for(i=1; i<nFarg; i++){
2662ae6bb957Sdrh           sqlite3VdbeAddOp2(v, OP_NotNull, target, endCoalesce);
2663f49f3523Sdrh           sqlite3ExprCacheRemove(pParse, target, 1);
2664ae6bb957Sdrh           sqlite3ExprCachePush(pParse);
2665ae6bb957Sdrh           sqlite3ExprCode(pParse, pFarg->a[i].pExpr, target);
2666ae6bb957Sdrh           sqlite3ExprCachePop(pParse, 1);
2667ae6bb957Sdrh         }
2668ae6bb957Sdrh         sqlite3VdbeResolveLabel(v, endCoalesce);
2669ae6bb957Sdrh         break;
2670ae6bb957Sdrh       }
2671ae6bb957Sdrh 
2672cca9f3d2Sdrh       /* The UNLIKELY() function is a no-op.  The result is the value
2673cca9f3d2Sdrh       ** of the first argument.
2674cca9f3d2Sdrh       */
2675cca9f3d2Sdrh       if( pDef->funcFlags & SQLITE_FUNC_UNLIKELY ){
2676cca9f3d2Sdrh         assert( nFarg>=1 );
2677cca9f3d2Sdrh         sqlite3ExprCode(pParse, pFarg->a[0].pExpr, target);
2678cca9f3d2Sdrh         break;
2679cca9f3d2Sdrh       }
2680ae6bb957Sdrh 
268112ffee8cSdrh       if( pFarg ){
268212ffee8cSdrh         r1 = sqlite3GetTempRange(pParse, nFarg);
2683a748fdccSdrh 
2684a748fdccSdrh         /* For length() and typeof() functions with a column argument,
2685a748fdccSdrh         ** set the P5 parameter to the OP_Column opcode to OPFLAG_LENGTHARG
2686a748fdccSdrh         ** or OPFLAG_TYPEOFARG respectively, to avoid unnecessary data
2687a748fdccSdrh         ** loading.
2688a748fdccSdrh         */
2689d36e1041Sdrh         if( (pDef->funcFlags & (SQLITE_FUNC_LENGTH|SQLITE_FUNC_TYPEOF))!=0 ){
26904e245a4cSdrh           u8 exprOp;
2691a748fdccSdrh           assert( nFarg==1 );
2692a748fdccSdrh           assert( pFarg->a[0].pExpr!=0 );
26934e245a4cSdrh           exprOp = pFarg->a[0].pExpr->op;
26944e245a4cSdrh           if( exprOp==TK_COLUMN || exprOp==TK_AGG_COLUMN ){
2695a748fdccSdrh             assert( SQLITE_FUNC_LENGTH==OPFLAG_LENGTHARG );
2696a748fdccSdrh             assert( SQLITE_FUNC_TYPEOF==OPFLAG_TYPEOFARG );
2697d36e1041Sdrh             testcase( (pDef->funcFlags&~SQLITE_FUNC_ENCMASK)
2698d36e1041Sdrh                        ==SQLITE_FUNC_LENGTH );
2699d36e1041Sdrh             pFarg->a[0].pExpr->op2 = pDef->funcFlags&~SQLITE_FUNC_ENCMASK;
2700a748fdccSdrh           }
2701a748fdccSdrh         }
2702a748fdccSdrh 
2703d7d385ddSdrh         sqlite3ExprCachePush(pParse);     /* Ticket 2ea2425d34be */
270412ffee8cSdrh         sqlite3ExprCodeExprList(pParse, pFarg, r1, 1);
2705d7d385ddSdrh         sqlite3ExprCachePop(pParse, 1);   /* Ticket 2ea2425d34be */
2706892d3179Sdrh       }else{
270712ffee8cSdrh         r1 = 0;
2708892d3179Sdrh       }
2709b7f6f68fSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
2710a43fa227Sdrh       /* Possibly overload the function if the first argument is
2711a43fa227Sdrh       ** a virtual table column.
2712a43fa227Sdrh       **
2713a43fa227Sdrh       ** For infix functions (LIKE, GLOB, REGEXP, and MATCH) use the
2714a43fa227Sdrh       ** second argument, not the first, as the argument to test to
2715a43fa227Sdrh       ** see if it is a column in a virtual table.  This is done because
2716a43fa227Sdrh       ** the left operand of infix functions (the operand we want to
2717a43fa227Sdrh       ** control overloading) ends up as the second argument to the
2718a43fa227Sdrh       ** function.  The expression "A glob B" is equivalent to
2719a43fa227Sdrh       ** "glob(B,A).  We want to use the A in "A glob B" to test
2720a43fa227Sdrh       ** for function overloading.  But we use the B term in "glob(B,A)".
2721a43fa227Sdrh       */
272212ffee8cSdrh       if( nFarg>=2 && (pExpr->flags & EP_InfixFunc) ){
272312ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[1].pExpr);
272412ffee8cSdrh       }else if( nFarg>0 ){
272512ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[0].pExpr);
2726b7f6f68fSdrh       }
2727b7f6f68fSdrh #endif
2728f7bca574Sdrh       for(i=0; i<nFarg; i++){
2729f7bca574Sdrh         if( i<32 && sqlite3ExprIsConstant(pFarg->a[i].pExpr) ){
273013449892Sdrh           constMask |= (1<<i);
2731d02eb1fdSdanielk1977         }
2732d36e1041Sdrh         if( (pDef->funcFlags & SQLITE_FUNC_NEEDCOLL)!=0 && !pColl ){
273312ffee8cSdrh           pColl = sqlite3ExprCollSeq(pParse, pFarg->a[i].pExpr);
2734dc1bdc4fSdanielk1977         }
2735dc1bdc4fSdanielk1977       }
2736d36e1041Sdrh       if( pDef->funcFlags & SQLITE_FUNC_NEEDCOLL ){
27378b213899Sdrh         if( !pColl ) pColl = db->pDfltColl;
273866a5167bSdrh         sqlite3VdbeAddOp4(v, OP_CollSeq, 0, 0, 0, (char *)pColl, P4_COLLSEQ);
2739682f68b0Sdanielk1977       }
27402dcef11bSdrh       sqlite3VdbeAddOp4(v, OP_Function, constMask, r1, target,
274166a5167bSdrh                         (char*)pDef, P4_FUNCDEF);
274212ffee8cSdrh       sqlite3VdbeChangeP5(v, (u8)nFarg);
274312ffee8cSdrh       if( nFarg ){
274412ffee8cSdrh         sqlite3ReleaseTempRange(pParse, r1, nFarg);
27452dcef11bSdrh       }
27466ec2733bSdrh       break;
27476ec2733bSdrh     }
2748fe2093d7Sdrh #ifndef SQLITE_OMIT_SUBQUERY
2749fe2093d7Sdrh     case TK_EXISTS:
275019a775c2Sdrh     case TK_SELECT: {
2751c5499befSdrh       testcase( op==TK_EXISTS );
2752c5499befSdrh       testcase( op==TK_SELECT );
27531450bc6eSdrh       inReg = sqlite3CodeSubselect(pParse, pExpr, 0, 0);
275419a775c2Sdrh       break;
275519a775c2Sdrh     }
2756fef5208cSdrh     case TK_IN: {
2757e3365e6cSdrh       int destIfFalse = sqlite3VdbeMakeLabel(v);
2758e3365e6cSdrh       int destIfNull = sqlite3VdbeMakeLabel(v);
2759e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
2760e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
276166ba23ceSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
2762e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
2763e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_AddImm, target, 0);
2764e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfNull);
2765fef5208cSdrh       break;
2766fef5208cSdrh     }
2767e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
2768e3365e6cSdrh 
2769e3365e6cSdrh 
27702dcef11bSdrh     /*
27712dcef11bSdrh     **    x BETWEEN y AND z
27722dcef11bSdrh     **
27732dcef11bSdrh     ** This is equivalent to
27742dcef11bSdrh     **
27752dcef11bSdrh     **    x>=y AND x<=z
27762dcef11bSdrh     **
27772dcef11bSdrh     ** X is stored in pExpr->pLeft.
27782dcef11bSdrh     ** Y is stored in pExpr->pList->a[0].pExpr.
27792dcef11bSdrh     ** Z is stored in pExpr->pList->a[1].pExpr.
27802dcef11bSdrh     */
2781fef5208cSdrh     case TK_BETWEEN: {
2782be5c89acSdrh       Expr *pLeft = pExpr->pLeft;
27836ab3a2ecSdanielk1977       struct ExprList_item *pLItem = pExpr->x.pList->a;
2784be5c89acSdrh       Expr *pRight = pLItem->pExpr;
278535573356Sdrh 
2786b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pLeft, &regFree1);
2787b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pRight, &regFree2);
2788c5499befSdrh       testcase( regFree1==0 );
2789c5499befSdrh       testcase( regFree2==0 );
27902dcef11bSdrh       r3 = sqlite3GetTempReg(pParse);
2791678ccce8Sdrh       r4 = sqlite3GetTempReg(pParse);
279235573356Sdrh       codeCompare(pParse, pLeft, pRight, OP_Ge,
279335573356Sdrh                   r1, r2, r3, SQLITE_STOREP2);
2794be5c89acSdrh       pLItem++;
2795be5c89acSdrh       pRight = pLItem->pExpr;
27962dcef11bSdrh       sqlite3ReleaseTempReg(pParse, regFree2);
27972dcef11bSdrh       r2 = sqlite3ExprCodeTemp(pParse, pRight, &regFree2);
2798c5499befSdrh       testcase( regFree2==0 );
2799678ccce8Sdrh       codeCompare(pParse, pLeft, pRight, OP_Le, r1, r2, r4, SQLITE_STOREP2);
2800678ccce8Sdrh       sqlite3VdbeAddOp3(v, OP_And, r3, r4, target);
28012dcef11bSdrh       sqlite3ReleaseTempReg(pParse, r3);
2802678ccce8Sdrh       sqlite3ReleaseTempReg(pParse, r4);
2803fef5208cSdrh       break;
2804fef5208cSdrh     }
2805ae80ddeaSdrh     case TK_COLLATE:
28064f07e5fbSdrh     case TK_UPLUS: {
28072dcef11bSdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
2808a2e00042Sdrh       break;
2809a2e00042Sdrh     }
28102dcef11bSdrh 
2811165921a7Sdan     case TK_TRIGGER: {
281265a7cd16Sdan       /* If the opcode is TK_TRIGGER, then the expression is a reference
281365a7cd16Sdan       ** to a column in the new.* or old.* pseudo-tables available to
281465a7cd16Sdan       ** trigger programs. In this case Expr.iTable is set to 1 for the
281565a7cd16Sdan       ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
281665a7cd16Sdan       ** is set to the column of the pseudo-table to read, or to -1 to
281765a7cd16Sdan       ** read the rowid field.
281865a7cd16Sdan       **
281965a7cd16Sdan       ** The expression is implemented using an OP_Param opcode. The p1
282065a7cd16Sdan       ** parameter is set to 0 for an old.rowid reference, or to (i+1)
282165a7cd16Sdan       ** to reference another column of the old.* pseudo-table, where
282265a7cd16Sdan       ** i is the index of the column. For a new.rowid reference, p1 is
282365a7cd16Sdan       ** set to (n+1), where n is the number of columns in each pseudo-table.
282465a7cd16Sdan       ** For a reference to any other column in the new.* pseudo-table, p1
282565a7cd16Sdan       ** is set to (n+2+i), where n and i are as defined previously. For
282665a7cd16Sdan       ** example, if the table on which triggers are being fired is
282765a7cd16Sdan       ** declared as:
282865a7cd16Sdan       **
282965a7cd16Sdan       **   CREATE TABLE t1(a, b);
283065a7cd16Sdan       **
283165a7cd16Sdan       ** Then p1 is interpreted as follows:
283265a7cd16Sdan       **
283365a7cd16Sdan       **   p1==0   ->    old.rowid     p1==3   ->    new.rowid
283465a7cd16Sdan       **   p1==1   ->    old.a         p1==4   ->    new.a
283565a7cd16Sdan       **   p1==2   ->    old.b         p1==5   ->    new.b
283665a7cd16Sdan       */
28372832ad42Sdan       Table *pTab = pExpr->pTab;
283865a7cd16Sdan       int p1 = pExpr->iTable * (pTab->nCol+1) + 1 + pExpr->iColumn;
283965a7cd16Sdan 
284065a7cd16Sdan       assert( pExpr->iTable==0 || pExpr->iTable==1 );
284165a7cd16Sdan       assert( pExpr->iColumn>=-1 && pExpr->iColumn<pTab->nCol );
284265a7cd16Sdan       assert( pTab->iPKey<0 || pExpr->iColumn!=pTab->iPKey );
284365a7cd16Sdan       assert( p1>=0 && p1<(pTab->nCol*2+2) );
284465a7cd16Sdan 
284565a7cd16Sdan       sqlite3VdbeAddOp2(v, OP_Param, p1, target);
284676d462eeSdan       VdbeComment((v, "%s.%s -> $%d",
2847165921a7Sdan         (pExpr->iTable ? "new" : "old"),
284876d462eeSdan         (pExpr->iColumn<0 ? "rowid" : pExpr->pTab->aCol[pExpr->iColumn].zName),
284976d462eeSdan         target
2850165921a7Sdan       ));
285165a7cd16Sdan 
285244dbca83Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
285365a7cd16Sdan       /* If the column has REAL affinity, it may currently be stored as an
285465a7cd16Sdan       ** integer. Use OP_RealAffinity to make sure it is really real.  */
28552832ad42Sdan       if( pExpr->iColumn>=0
28562832ad42Sdan        && pTab->aCol[pExpr->iColumn].affinity==SQLITE_AFF_REAL
28572832ad42Sdan       ){
28582832ad42Sdan         sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
28592832ad42Sdan       }
286044dbca83Sdrh #endif
2861165921a7Sdan       break;
2862165921a7Sdan     }
2863165921a7Sdan 
2864165921a7Sdan 
28652dcef11bSdrh     /*
28662dcef11bSdrh     ** Form A:
28672dcef11bSdrh     **   CASE x WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
28682dcef11bSdrh     **
28692dcef11bSdrh     ** Form B:
28702dcef11bSdrh     **   CASE WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
28712dcef11bSdrh     **
28722dcef11bSdrh     ** Form A is can be transformed into the equivalent form B as follows:
28732dcef11bSdrh     **   CASE WHEN x=e1 THEN r1 WHEN x=e2 THEN r2 ...
28742dcef11bSdrh     **        WHEN x=eN THEN rN ELSE y END
28752dcef11bSdrh     **
28762dcef11bSdrh     ** X (if it exists) is in pExpr->pLeft.
2877c5cd1249Sdrh     ** Y is in the last element of pExpr->x.pList if pExpr->x.pList->nExpr is
2878c5cd1249Sdrh     ** odd.  The Y is also optional.  If the number of elements in x.pList
2879c5cd1249Sdrh     ** is even, then Y is omitted and the "otherwise" result is NULL.
28802dcef11bSdrh     ** Ei is in pExpr->pList->a[i*2] and Ri is pExpr->pList->a[i*2+1].
28812dcef11bSdrh     **
28822dcef11bSdrh     ** The result of the expression is the Ri for the first matching Ei,
28832dcef11bSdrh     ** or if there is no matching Ei, the ELSE term Y, or if there is
28842dcef11bSdrh     ** no ELSE term, NULL.
28852dcef11bSdrh     */
288633cd4909Sdrh     default: assert( op==TK_CASE ); {
28872dcef11bSdrh       int endLabel;                     /* GOTO label for end of CASE stmt */
28882dcef11bSdrh       int nextCase;                     /* GOTO label for next WHEN clause */
28892dcef11bSdrh       int nExpr;                        /* 2x number of WHEN terms */
28902dcef11bSdrh       int i;                            /* Loop counter */
28912dcef11bSdrh       ExprList *pEList;                 /* List of WHEN terms */
28922dcef11bSdrh       struct ExprList_item *aListelem;  /* Array of WHEN terms */
28932dcef11bSdrh       Expr opCompare;                   /* The X==Ei expression */
28942dcef11bSdrh       Expr cacheX;                      /* Cached expression X */
28952dcef11bSdrh       Expr *pX;                         /* The X expression */
28961bd10f8aSdrh       Expr *pTest = 0;                  /* X==Ei (form A) or just Ei (form B) */
2897ceea3321Sdrh       VVA_ONLY( int iCacheLevel = pParse->iCacheLevel; )
289817a7f8ddSdrh 
28996ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) && pExpr->x.pList );
29006ab3a2ecSdanielk1977       assert(pExpr->x.pList->nExpr > 0);
29016ab3a2ecSdanielk1977       pEList = pExpr->x.pList;
2902be5c89acSdrh       aListelem = pEList->a;
2903be5c89acSdrh       nExpr = pEList->nExpr;
29042dcef11bSdrh       endLabel = sqlite3VdbeMakeLabel(v);
29052dcef11bSdrh       if( (pX = pExpr->pLeft)!=0 ){
29062dcef11bSdrh         cacheX = *pX;
290733cd4909Sdrh         testcase( pX->op==TK_COLUMN );
290833cd4909Sdrh         testcase( pX->op==TK_REGISTER );
2909a4c3c87eSdrh         exprToRegister(&cacheX, sqlite3ExprCodeTemp(pParse, pX, &regFree1));
2910c5499befSdrh         testcase( regFree1==0 );
29112dcef11bSdrh         opCompare.op = TK_EQ;
29122dcef11bSdrh         opCompare.pLeft = &cacheX;
29132dcef11bSdrh         pTest = &opCompare;
29148b1db07fSdrh         /* Ticket b351d95f9cd5ef17e9d9dbae18f5ca8611190001:
29158b1db07fSdrh         ** The value in regFree1 might get SCopy-ed into the file result.
29168b1db07fSdrh         ** So make sure that the regFree1 register is not reused for other
29178b1db07fSdrh         ** purposes and possibly overwritten.  */
29188b1db07fSdrh         regFree1 = 0;
2919cce7d176Sdrh       }
2920c5cd1249Sdrh       for(i=0; i<nExpr-1; i=i+2){
2921ceea3321Sdrh         sqlite3ExprCachePush(pParse);
29222dcef11bSdrh         if( pX ){
29231bd10f8aSdrh           assert( pTest!=0 );
29242dcef11bSdrh           opCompare.pRight = aListelem[i].pExpr;
2925f5905aa7Sdrh         }else{
29262dcef11bSdrh           pTest = aListelem[i].pExpr;
292717a7f8ddSdrh         }
29282dcef11bSdrh         nextCase = sqlite3VdbeMakeLabel(v);
292933cd4909Sdrh         testcase( pTest->op==TK_COLUMN );
29302dcef11bSdrh         sqlite3ExprIfFalse(pParse, pTest, nextCase, SQLITE_JUMPIFNULL);
2931c5499befSdrh         testcase( aListelem[i+1].pExpr->op==TK_COLUMN );
2932c5499befSdrh         testcase( aListelem[i+1].pExpr->op==TK_REGISTER );
29339de221dfSdrh         sqlite3ExprCode(pParse, aListelem[i+1].pExpr, target);
29342dcef11bSdrh         sqlite3VdbeAddOp2(v, OP_Goto, 0, endLabel);
2935ceea3321Sdrh         sqlite3ExprCachePop(pParse, 1);
29362dcef11bSdrh         sqlite3VdbeResolveLabel(v, nextCase);
2937f570f011Sdrh       }
2938c5cd1249Sdrh       if( (nExpr&1)!=0 ){
2939ceea3321Sdrh         sqlite3ExprCachePush(pParse);
2940c5cd1249Sdrh         sqlite3ExprCode(pParse, pEList->a[nExpr-1].pExpr, target);
2941ceea3321Sdrh         sqlite3ExprCachePop(pParse, 1);
294217a7f8ddSdrh       }else{
29439de221dfSdrh         sqlite3VdbeAddOp2(v, OP_Null, 0, target);
294417a7f8ddSdrh       }
2945c1f4a19bSdanielk1977       assert( db->mallocFailed || pParse->nErr>0
2946c1f4a19bSdanielk1977            || pParse->iCacheLevel==iCacheLevel );
29472dcef11bSdrh       sqlite3VdbeResolveLabel(v, endLabel);
29486f34903eSdanielk1977       break;
29496f34903eSdanielk1977     }
29505338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_TRIGGER
29516f34903eSdanielk1977     case TK_RAISE: {
2952165921a7Sdan       assert( pExpr->affinity==OE_Rollback
2953165921a7Sdan            || pExpr->affinity==OE_Abort
2954165921a7Sdan            || pExpr->affinity==OE_Fail
2955165921a7Sdan            || pExpr->affinity==OE_Ignore
2956165921a7Sdan       );
2957e0af83acSdan       if( !pParse->pTriggerTab ){
2958e0af83acSdan         sqlite3ErrorMsg(pParse,
2959e0af83acSdan                        "RAISE() may only be used within a trigger-program");
2960e0af83acSdan         return 0;
2961e0af83acSdan       }
2962e0af83acSdan       if( pExpr->affinity==OE_Abort ){
2963e0af83acSdan         sqlite3MayAbort(pParse);
2964e0af83acSdan       }
296533e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
2966e0af83acSdan       if( pExpr->affinity==OE_Ignore ){
2967e0af83acSdan         sqlite3VdbeAddOp4(
2968e0af83acSdan             v, OP_Halt, SQLITE_OK, OE_Ignore, 0, pExpr->u.zToken,0);
2969e0af83acSdan       }else{
2970433dccfbSdrh         sqlite3HaltConstraint(pParse, SQLITE_CONSTRAINT_TRIGGER,
2971d91c1a17Sdrh                               pExpr->affinity, pExpr->u.zToken, 0);
2972e0af83acSdan       }
2973e0af83acSdan 
2974ffe07b2dSdrh       break;
297517a7f8ddSdrh     }
29765338a5f7Sdanielk1977 #endif
2977ffe07b2dSdrh   }
29782dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
29792dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
29802dcef11bSdrh   return inReg;
29815b6afba9Sdrh }
29822dcef11bSdrh 
29832dcef11bSdrh /*
29842dcef11bSdrh ** Generate code to evaluate an expression and store the results
29852dcef11bSdrh ** into a register.  Return the register number where the results
29862dcef11bSdrh ** are stored.
29872dcef11bSdrh **
29882dcef11bSdrh ** If the register is a temporary register that can be deallocated,
2989678ccce8Sdrh ** then write its number into *pReg.  If the result register is not
29902dcef11bSdrh ** a temporary, then set *pReg to zero.
29912dcef11bSdrh */
29922dcef11bSdrh int sqlite3ExprCodeTemp(Parse *pParse, Expr *pExpr, int *pReg){
29932dcef11bSdrh   int r1 = sqlite3GetTempReg(pParse);
29942dcef11bSdrh   int r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
29952dcef11bSdrh   if( r2==r1 ){
29962dcef11bSdrh     *pReg = r1;
29972dcef11bSdrh   }else{
29982dcef11bSdrh     sqlite3ReleaseTempReg(pParse, r1);
29992dcef11bSdrh     *pReg = 0;
30002dcef11bSdrh   }
30012dcef11bSdrh   return r2;
30022dcef11bSdrh }
30032dcef11bSdrh 
30042dcef11bSdrh /*
30052dcef11bSdrh ** Generate code that will evaluate expression pExpr and store the
30062dcef11bSdrh ** results in register target.  The results are guaranteed to appear
30072dcef11bSdrh ** in register target.
30082dcef11bSdrh */
30092dcef11bSdrh int sqlite3ExprCode(Parse *pParse, Expr *pExpr, int target){
30109cbf3425Sdrh   int inReg;
30119cbf3425Sdrh 
30129cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
3013ebc16717Sdrh   if( pExpr && pExpr->op==TK_REGISTER ){
3014ebc16717Sdrh     sqlite3VdbeAddOp2(pParse->pVdbe, OP_Copy, pExpr->iTable, target);
3015ebc16717Sdrh   }else{
30169cbf3425Sdrh     inReg = sqlite3ExprCodeTarget(pParse, pExpr, target);
30170e359b30Sdrh     assert( pParse->pVdbe || pParse->db->mallocFailed );
30180e359b30Sdrh     if( inReg!=target && pParse->pVdbe ){
30199cbf3425Sdrh       sqlite3VdbeAddOp2(pParse->pVdbe, OP_SCopy, inReg, target);
302017a7f8ddSdrh     }
3021ebc16717Sdrh   }
3022389a1adbSdrh   return target;
3023cce7d176Sdrh }
3024cce7d176Sdrh 
3025cce7d176Sdrh /*
30262dcef11bSdrh ** Generate code that evalutes the given expression and puts the result
3027de4fcfddSdrh ** in register target.
302825303780Sdrh **
30292dcef11bSdrh ** Also make a copy of the expression results into another "cache" register
30302dcef11bSdrh ** and modify the expression so that the next time it is evaluated,
30312dcef11bSdrh ** the result is a copy of the cache register.
30322dcef11bSdrh **
30332dcef11bSdrh ** This routine is used for expressions that are used multiple
30342dcef11bSdrh ** times.  They are evaluated once and the results of the expression
30352dcef11bSdrh ** are reused.
303625303780Sdrh */
30372dcef11bSdrh int sqlite3ExprCodeAndCache(Parse *pParse, Expr *pExpr, int target){
303825303780Sdrh   Vdbe *v = pParse->pVdbe;
30392dcef11bSdrh   int inReg;
30402dcef11bSdrh   inReg = sqlite3ExprCode(pParse, pExpr, target);
3041de4fcfddSdrh   assert( target>0 );
304220bc393cSdrh   /* This routine is called for terms to INSERT or UPDATE.  And the only
304320bc393cSdrh   ** other place where expressions can be converted into TK_REGISTER is
304420bc393cSdrh   ** in WHERE clause processing.  So as currently implemented, there is
304520bc393cSdrh   ** no way for a TK_REGISTER to exist here.  But it seems prudent to
304620bc393cSdrh   ** keep the ALWAYS() in case the conditions above change with future
304720bc393cSdrh   ** modifications or enhancements. */
304820bc393cSdrh   if( ALWAYS(pExpr->op!=TK_REGISTER) ){
304925303780Sdrh     int iMem;
30502dcef11bSdrh     iMem = ++pParse->nMem;
30512dcef11bSdrh     sqlite3VdbeAddOp2(v, OP_Copy, inReg, iMem);
3052a4c3c87eSdrh     exprToRegister(pExpr, iMem);
305325303780Sdrh   }
30542dcef11bSdrh   return inReg;
305525303780Sdrh }
30562dcef11bSdrh 
3057678a9aa7Sdrh #if defined(SQLITE_ENABLE_TREE_EXPLAIN)
30587e02e5e6Sdrh /*
30597e02e5e6Sdrh ** Generate a human-readable explanation of an expression tree.
30607e02e5e6Sdrh */
3061a84203a0Sdrh void sqlite3ExplainExpr(Vdbe *pOut, Expr *pExpr){
3062a84203a0Sdrh   int op;                   /* The opcode being coded */
3063a84203a0Sdrh   const char *zBinOp = 0;   /* Binary operator */
3064a84203a0Sdrh   const char *zUniOp = 0;   /* Unary operator */
3065a84203a0Sdrh   if( pExpr==0 ){
3066a84203a0Sdrh     op = TK_NULL;
30677e02e5e6Sdrh   }else{
3068a84203a0Sdrh     op = pExpr->op;
30697e02e5e6Sdrh   }
3070a84203a0Sdrh   switch( op ){
3071a84203a0Sdrh     case TK_AGG_COLUMN: {
307204b8342bSdrh       sqlite3ExplainPrintf(pOut, "AGG{%d:%d}",
307304b8342bSdrh             pExpr->iTable, pExpr->iColumn);
3074a84203a0Sdrh       break;
30757e02e5e6Sdrh     }
3076a84203a0Sdrh     case TK_COLUMN: {
3077a84203a0Sdrh       if( pExpr->iTable<0 ){
3078a84203a0Sdrh         /* This only happens when coding check constraints */
3079a84203a0Sdrh         sqlite3ExplainPrintf(pOut, "COLUMN(%d)", pExpr->iColumn);
3080a84203a0Sdrh       }else{
308104b8342bSdrh         sqlite3ExplainPrintf(pOut, "{%d:%d}",
308204b8342bSdrh                              pExpr->iTable, pExpr->iColumn);
3083a84203a0Sdrh       }
3084a84203a0Sdrh       break;
3085a84203a0Sdrh     }
3086a84203a0Sdrh     case TK_INTEGER: {
3087a84203a0Sdrh       if( pExpr->flags & EP_IntValue ){
308804b8342bSdrh         sqlite3ExplainPrintf(pOut, "%d", pExpr->u.iValue);
3089a84203a0Sdrh       }else{
309004b8342bSdrh         sqlite3ExplainPrintf(pOut, "%s", pExpr->u.zToken);
3091a84203a0Sdrh       }
3092a84203a0Sdrh       break;
3093a84203a0Sdrh     }
3094a84203a0Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
3095a84203a0Sdrh     case TK_FLOAT: {
309604b8342bSdrh       sqlite3ExplainPrintf(pOut,"%s", pExpr->u.zToken);
3097a84203a0Sdrh       break;
3098a84203a0Sdrh     }
3099a84203a0Sdrh #endif
3100a84203a0Sdrh     case TK_STRING: {
310104b8342bSdrh       sqlite3ExplainPrintf(pOut,"%Q", pExpr->u.zToken);
3102a84203a0Sdrh       break;
3103a84203a0Sdrh     }
3104a84203a0Sdrh     case TK_NULL: {
3105a84203a0Sdrh       sqlite3ExplainPrintf(pOut,"NULL");
3106a84203a0Sdrh       break;
3107a84203a0Sdrh     }
3108a84203a0Sdrh #ifndef SQLITE_OMIT_BLOB_LITERAL
3109a84203a0Sdrh     case TK_BLOB: {
311004b8342bSdrh       sqlite3ExplainPrintf(pOut,"%s", pExpr->u.zToken);
3111a84203a0Sdrh       break;
3112a84203a0Sdrh     }
3113a84203a0Sdrh #endif
3114a84203a0Sdrh     case TK_VARIABLE: {
3115a84203a0Sdrh       sqlite3ExplainPrintf(pOut,"VARIABLE(%s,%d)",
3116a84203a0Sdrh                            pExpr->u.zToken, pExpr->iColumn);
3117a84203a0Sdrh       break;
3118a84203a0Sdrh     }
3119a84203a0Sdrh     case TK_REGISTER: {
3120a84203a0Sdrh       sqlite3ExplainPrintf(pOut,"REGISTER(%d)", pExpr->iTable);
3121a84203a0Sdrh       break;
3122a84203a0Sdrh     }
3123a84203a0Sdrh     case TK_AS: {
3124a84203a0Sdrh       sqlite3ExplainExpr(pOut, pExpr->pLeft);
3125a84203a0Sdrh       break;
3126a84203a0Sdrh     }
3127a84203a0Sdrh #ifndef SQLITE_OMIT_CAST
3128a84203a0Sdrh     case TK_CAST: {
3129a84203a0Sdrh       /* Expressions of the form:   CAST(pLeft AS token) */
3130a84203a0Sdrh       const char *zAff = "unk";
3131fdaac671Sdrh       switch( sqlite3AffinityType(pExpr->u.zToken, 0) ){
3132a84203a0Sdrh         case SQLITE_AFF_TEXT:    zAff = "TEXT";     break;
3133a84203a0Sdrh         case SQLITE_AFF_NONE:    zAff = "NONE";     break;
3134a84203a0Sdrh         case SQLITE_AFF_NUMERIC: zAff = "NUMERIC";  break;
3135a84203a0Sdrh         case SQLITE_AFF_INTEGER: zAff = "INTEGER";  break;
3136a84203a0Sdrh         case SQLITE_AFF_REAL:    zAff = "REAL";     break;
3137a84203a0Sdrh       }
3138a84203a0Sdrh       sqlite3ExplainPrintf(pOut, "CAST-%s(", zAff);
3139a84203a0Sdrh       sqlite3ExplainExpr(pOut, pExpr->pLeft);
3140a84203a0Sdrh       sqlite3ExplainPrintf(pOut, ")");
3141a84203a0Sdrh       break;
3142a84203a0Sdrh     }
3143a84203a0Sdrh #endif /* SQLITE_OMIT_CAST */
3144a84203a0Sdrh     case TK_LT:      zBinOp = "LT";     break;
3145a84203a0Sdrh     case TK_LE:      zBinOp = "LE";     break;
3146a84203a0Sdrh     case TK_GT:      zBinOp = "GT";     break;
3147a84203a0Sdrh     case TK_GE:      zBinOp = "GE";     break;
3148a84203a0Sdrh     case TK_NE:      zBinOp = "NE";     break;
3149a84203a0Sdrh     case TK_EQ:      zBinOp = "EQ";     break;
3150a84203a0Sdrh     case TK_IS:      zBinOp = "IS";     break;
3151a84203a0Sdrh     case TK_ISNOT:   zBinOp = "ISNOT";  break;
3152a84203a0Sdrh     case TK_AND:     zBinOp = "AND";    break;
3153a84203a0Sdrh     case TK_OR:      zBinOp = "OR";     break;
3154a84203a0Sdrh     case TK_PLUS:    zBinOp = "ADD";    break;
3155a84203a0Sdrh     case TK_STAR:    zBinOp = "MUL";    break;
3156a84203a0Sdrh     case TK_MINUS:   zBinOp = "SUB";    break;
3157a84203a0Sdrh     case TK_REM:     zBinOp = "REM";    break;
3158a84203a0Sdrh     case TK_BITAND:  zBinOp = "BITAND"; break;
3159a84203a0Sdrh     case TK_BITOR:   zBinOp = "BITOR";  break;
3160a84203a0Sdrh     case TK_SLASH:   zBinOp = "DIV";    break;
3161a84203a0Sdrh     case TK_LSHIFT:  zBinOp = "LSHIFT"; break;
3162a84203a0Sdrh     case TK_RSHIFT:  zBinOp = "RSHIFT"; break;
3163a84203a0Sdrh     case TK_CONCAT:  zBinOp = "CONCAT"; break;
3164a84203a0Sdrh 
3165a84203a0Sdrh     case TK_UMINUS:  zUniOp = "UMINUS"; break;
3166a84203a0Sdrh     case TK_UPLUS:   zUniOp = "UPLUS";  break;
3167a84203a0Sdrh     case TK_BITNOT:  zUniOp = "BITNOT"; break;
3168a84203a0Sdrh     case TK_NOT:     zUniOp = "NOT";    break;
3169a84203a0Sdrh     case TK_ISNULL:  zUniOp = "ISNULL"; break;
3170a84203a0Sdrh     case TK_NOTNULL: zUniOp = "NOTNULL"; break;
3171a84203a0Sdrh 
31727a66da13Sdrh     case TK_COLLATE: {
31737a66da13Sdrh       sqlite3ExplainExpr(pOut, pExpr->pLeft);
31747a66da13Sdrh       sqlite3ExplainPrintf(pOut,".COLLATE(%s)",pExpr->u.zToken);
31757a66da13Sdrh       break;
31767a66da13Sdrh     }
31777a66da13Sdrh 
3178a84203a0Sdrh     case TK_AGG_FUNCTION:
3179a84203a0Sdrh     case TK_CONST_FUNC:
3180a84203a0Sdrh     case TK_FUNCTION: {
3181a84203a0Sdrh       ExprList *pFarg;       /* List of function arguments */
3182c5cd1249Sdrh       if( ExprHasProperty(pExpr, EP_TokenOnly) ){
3183a84203a0Sdrh         pFarg = 0;
3184a84203a0Sdrh       }else{
3185a84203a0Sdrh         pFarg = pExpr->x.pList;
3186a84203a0Sdrh       }
3187ed551b95Sdrh       if( op==TK_AGG_FUNCTION ){
3188ed551b95Sdrh         sqlite3ExplainPrintf(pOut, "AGG_FUNCTION%d:%s(",
3189ed551b95Sdrh                              pExpr->op2, pExpr->u.zToken);
3190ed551b95Sdrh       }else{
3191ed551b95Sdrh         sqlite3ExplainPrintf(pOut, "FUNCTION:%s(", pExpr->u.zToken);
3192ed551b95Sdrh       }
3193a84203a0Sdrh       if( pFarg ){
3194a84203a0Sdrh         sqlite3ExplainExprList(pOut, pFarg);
31957e02e5e6Sdrh       }
31967e02e5e6Sdrh       sqlite3ExplainPrintf(pOut, ")");
3197a84203a0Sdrh       break;
3198a84203a0Sdrh     }
3199a84203a0Sdrh #ifndef SQLITE_OMIT_SUBQUERY
3200a84203a0Sdrh     case TK_EXISTS: {
3201a84203a0Sdrh       sqlite3ExplainPrintf(pOut, "EXISTS(");
3202a84203a0Sdrh       sqlite3ExplainSelect(pOut, pExpr->x.pSelect);
3203a84203a0Sdrh       sqlite3ExplainPrintf(pOut,")");
3204a84203a0Sdrh       break;
3205a84203a0Sdrh     }
3206a84203a0Sdrh     case TK_SELECT: {
3207a84203a0Sdrh       sqlite3ExplainPrintf(pOut, "(");
3208a84203a0Sdrh       sqlite3ExplainSelect(pOut, pExpr->x.pSelect);
3209a84203a0Sdrh       sqlite3ExplainPrintf(pOut, ")");
3210a84203a0Sdrh       break;
3211a84203a0Sdrh     }
3212a84203a0Sdrh     case TK_IN: {
3213a84203a0Sdrh       sqlite3ExplainPrintf(pOut, "IN(");
3214a84203a0Sdrh       sqlite3ExplainExpr(pOut, pExpr->pLeft);
3215a84203a0Sdrh       sqlite3ExplainPrintf(pOut, ",");
3216a84203a0Sdrh       if( ExprHasProperty(pExpr, EP_xIsSelect) ){
3217a84203a0Sdrh         sqlite3ExplainSelect(pOut, pExpr->x.pSelect);
3218a84203a0Sdrh       }else{
3219a84203a0Sdrh         sqlite3ExplainExprList(pOut, pExpr->x.pList);
3220a84203a0Sdrh       }
3221a84203a0Sdrh       sqlite3ExplainPrintf(pOut, ")");
3222a84203a0Sdrh       break;
3223a84203a0Sdrh     }
3224a84203a0Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
3225a84203a0Sdrh 
3226a84203a0Sdrh     /*
3227a84203a0Sdrh     **    x BETWEEN y AND z
3228a84203a0Sdrh     **
3229a84203a0Sdrh     ** This is equivalent to
3230a84203a0Sdrh     **
3231a84203a0Sdrh     **    x>=y AND x<=z
3232a84203a0Sdrh     **
3233a84203a0Sdrh     ** X is stored in pExpr->pLeft.
3234a84203a0Sdrh     ** Y is stored in pExpr->pList->a[0].pExpr.
3235a84203a0Sdrh     ** Z is stored in pExpr->pList->a[1].pExpr.
3236a84203a0Sdrh     */
3237a84203a0Sdrh     case TK_BETWEEN: {
3238a84203a0Sdrh       Expr *pX = pExpr->pLeft;
3239a84203a0Sdrh       Expr *pY = pExpr->x.pList->a[0].pExpr;
3240a84203a0Sdrh       Expr *pZ = pExpr->x.pList->a[1].pExpr;
3241a84203a0Sdrh       sqlite3ExplainPrintf(pOut, "BETWEEN(");
3242a84203a0Sdrh       sqlite3ExplainExpr(pOut, pX);
3243a84203a0Sdrh       sqlite3ExplainPrintf(pOut, ",");
3244a84203a0Sdrh       sqlite3ExplainExpr(pOut, pY);
3245a84203a0Sdrh       sqlite3ExplainPrintf(pOut, ",");
3246a84203a0Sdrh       sqlite3ExplainExpr(pOut, pZ);
3247a84203a0Sdrh       sqlite3ExplainPrintf(pOut, ")");
3248a84203a0Sdrh       break;
3249a84203a0Sdrh     }
3250a84203a0Sdrh     case TK_TRIGGER: {
3251a84203a0Sdrh       /* If the opcode is TK_TRIGGER, then the expression is a reference
3252a84203a0Sdrh       ** to a column in the new.* or old.* pseudo-tables available to
3253a84203a0Sdrh       ** trigger programs. In this case Expr.iTable is set to 1 for the
3254a84203a0Sdrh       ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
3255a84203a0Sdrh       ** is set to the column of the pseudo-table to read, or to -1 to
3256a84203a0Sdrh       ** read the rowid field.
3257a84203a0Sdrh       */
3258a84203a0Sdrh       sqlite3ExplainPrintf(pOut, "%s(%d)",
3259a84203a0Sdrh           pExpr->iTable ? "NEW" : "OLD", pExpr->iColumn);
3260a84203a0Sdrh       break;
3261a84203a0Sdrh     }
3262a84203a0Sdrh     case TK_CASE: {
3263a84203a0Sdrh       sqlite3ExplainPrintf(pOut, "CASE(");
3264a84203a0Sdrh       sqlite3ExplainExpr(pOut, pExpr->pLeft);
3265a84203a0Sdrh       sqlite3ExplainPrintf(pOut, ",");
3266a84203a0Sdrh       sqlite3ExplainExprList(pOut, pExpr->x.pList);
3267a84203a0Sdrh       break;
3268a84203a0Sdrh     }
3269a84203a0Sdrh #ifndef SQLITE_OMIT_TRIGGER
3270a84203a0Sdrh     case TK_RAISE: {
3271a84203a0Sdrh       const char *zType = "unk";
3272a84203a0Sdrh       switch( pExpr->affinity ){
3273a84203a0Sdrh         case OE_Rollback:   zType = "rollback";  break;
3274a84203a0Sdrh         case OE_Abort:      zType = "abort";     break;
3275a84203a0Sdrh         case OE_Fail:       zType = "fail";      break;
3276a84203a0Sdrh         case OE_Ignore:     zType = "ignore";    break;
3277a84203a0Sdrh       }
3278a84203a0Sdrh       sqlite3ExplainPrintf(pOut, "RAISE-%s(%s)", zType, pExpr->u.zToken);
3279a84203a0Sdrh       break;
3280a84203a0Sdrh     }
3281a84203a0Sdrh #endif
3282a84203a0Sdrh   }
3283a84203a0Sdrh   if( zBinOp ){
3284a84203a0Sdrh     sqlite3ExplainPrintf(pOut,"%s(", zBinOp);
3285a84203a0Sdrh     sqlite3ExplainExpr(pOut, pExpr->pLeft);
3286a84203a0Sdrh     sqlite3ExplainPrintf(pOut,",");
3287a84203a0Sdrh     sqlite3ExplainExpr(pOut, pExpr->pRight);
3288a84203a0Sdrh     sqlite3ExplainPrintf(pOut,")");
3289a84203a0Sdrh   }else if( zUniOp ){
3290a84203a0Sdrh     sqlite3ExplainPrintf(pOut,"%s(", zUniOp);
3291a84203a0Sdrh     sqlite3ExplainExpr(pOut, pExpr->pLeft);
3292a84203a0Sdrh     sqlite3ExplainPrintf(pOut,")");
3293a84203a0Sdrh   }
32947e02e5e6Sdrh }
3295678a9aa7Sdrh #endif /* defined(SQLITE_ENABLE_TREE_EXPLAIN) */
32967e02e5e6Sdrh 
3297678a9aa7Sdrh #if defined(SQLITE_ENABLE_TREE_EXPLAIN)
32987e02e5e6Sdrh /*
32997e02e5e6Sdrh ** Generate a human-readable explanation of an expression list.
33007e02e5e6Sdrh */
33017e02e5e6Sdrh void sqlite3ExplainExprList(Vdbe *pOut, ExprList *pList){
33027e02e5e6Sdrh   int i;
3303a84203a0Sdrh   if( pList==0 || pList->nExpr==0 ){
33047e02e5e6Sdrh     sqlite3ExplainPrintf(pOut, "(empty-list)");
33057e02e5e6Sdrh     return;
3306a84203a0Sdrh   }else if( pList->nExpr==1 ){
3307a84203a0Sdrh     sqlite3ExplainExpr(pOut, pList->a[0].pExpr);
3308a84203a0Sdrh   }else{
33097e02e5e6Sdrh     sqlite3ExplainPush(pOut);
33107e02e5e6Sdrh     for(i=0; i<pList->nExpr; i++){
3311a84203a0Sdrh       sqlite3ExplainPrintf(pOut, "item[%d] = ", i);
33127e02e5e6Sdrh       sqlite3ExplainPush(pOut);
33137e02e5e6Sdrh       sqlite3ExplainExpr(pOut, pList->a[i].pExpr);
33147e02e5e6Sdrh       sqlite3ExplainPop(pOut);
33153e3f1a5bSdrh       if( pList->a[i].zName ){
33163e3f1a5bSdrh         sqlite3ExplainPrintf(pOut, " AS %s", pList->a[i].zName);
33173e3f1a5bSdrh       }
33183e3f1a5bSdrh       if( pList->a[i].bSpanIsTab ){
33193e3f1a5bSdrh         sqlite3ExplainPrintf(pOut, " (%s)", pList->a[i].zSpan);
33203e3f1a5bSdrh       }
33217e02e5e6Sdrh       if( i<pList->nExpr-1 ){
33227e02e5e6Sdrh         sqlite3ExplainNL(pOut);
33237e02e5e6Sdrh       }
33247e02e5e6Sdrh     }
33257e02e5e6Sdrh     sqlite3ExplainPop(pOut);
33267e02e5e6Sdrh   }
3327a84203a0Sdrh }
33287e02e5e6Sdrh #endif /* SQLITE_DEBUG */
33297e02e5e6Sdrh 
3330678ccce8Sdrh /*
333147de955eSdrh ** Return TRUE if pExpr is an constant expression that is appropriate
333247de955eSdrh ** for factoring out of a loop.  Appropriate expressions are:
333347de955eSdrh **
333447de955eSdrh **    *  Any expression that evaluates to two or more opcodes.
333547de955eSdrh **
333647de955eSdrh **    *  Any OP_Integer, OP_Real, OP_String, OP_Blob, OP_Null,
333747de955eSdrh **       or OP_Variable that does not need to be placed in a
333847de955eSdrh **       specific register.
333947de955eSdrh **
334047de955eSdrh ** There is no point in factoring out single-instruction constant
334147de955eSdrh ** expressions that need to be placed in a particular register.
334247de955eSdrh ** We could factor them out, but then we would end up adding an
334347de955eSdrh ** OP_SCopy instruction to move the value into the correct register
334447de955eSdrh ** later.  We might as well just use the original instruction and
334547de955eSdrh ** avoid the OP_SCopy.
334647de955eSdrh */
334747de955eSdrh static int isAppropriateForFactoring(Expr *p){
334847de955eSdrh   if( !sqlite3ExprIsConstantNotJoin(p) ){
334947de955eSdrh     return 0;  /* Only constant expressions are appropriate for factoring */
335047de955eSdrh   }
335147de955eSdrh   if( (p->flags & EP_FixedDest)==0 ){
335247de955eSdrh     return 1;  /* Any constant without a fixed destination is appropriate */
335347de955eSdrh   }
335447de955eSdrh   while( p->op==TK_UPLUS ) p = p->pLeft;
335547de955eSdrh   switch( p->op ){
335647de955eSdrh #ifndef SQLITE_OMIT_BLOB_LITERAL
335747de955eSdrh     case TK_BLOB:
335847de955eSdrh #endif
335947de955eSdrh     case TK_VARIABLE:
336047de955eSdrh     case TK_INTEGER:
336147de955eSdrh     case TK_FLOAT:
336247de955eSdrh     case TK_NULL:
336347de955eSdrh     case TK_STRING: {
336447de955eSdrh       testcase( p->op==TK_BLOB );
336547de955eSdrh       testcase( p->op==TK_VARIABLE );
336647de955eSdrh       testcase( p->op==TK_INTEGER );
336747de955eSdrh       testcase( p->op==TK_FLOAT );
336847de955eSdrh       testcase( p->op==TK_NULL );
336947de955eSdrh       testcase( p->op==TK_STRING );
337047de955eSdrh       /* Single-instruction constants with a fixed destination are
337147de955eSdrh       ** better done in-line.  If we factor them, they will just end
337247de955eSdrh       ** up generating an OP_SCopy to move the value to the destination
337347de955eSdrh       ** register. */
337447de955eSdrh       return 0;
337547de955eSdrh     }
337647de955eSdrh     case TK_UMINUS: {
337747de955eSdrh       if( p->pLeft->op==TK_FLOAT || p->pLeft->op==TK_INTEGER ){
337847de955eSdrh         return 0;
337947de955eSdrh       }
338047de955eSdrh       break;
338147de955eSdrh     }
338247de955eSdrh     default: {
338347de955eSdrh       break;
338447de955eSdrh     }
338547de955eSdrh   }
338647de955eSdrh   return 1;
338747de955eSdrh }
338847de955eSdrh 
338947de955eSdrh /*
339047de955eSdrh ** If pExpr is a constant expression that is appropriate for
339147de955eSdrh ** factoring out of a loop, then evaluate the expression
3392678ccce8Sdrh ** into a register and convert the expression into a TK_REGISTER
3393678ccce8Sdrh ** expression.
3394678ccce8Sdrh */
33957d10d5a6Sdrh static int evalConstExpr(Walker *pWalker, Expr *pExpr){
33967d10d5a6Sdrh   Parse *pParse = pWalker->pParse;
339747de955eSdrh   switch( pExpr->op ){
3398e05c929bSdrh     case TK_IN:
339947de955eSdrh     case TK_REGISTER: {
340033cd4909Sdrh       return WRC_Prune;
3401678ccce8Sdrh     }
3402261d8a51Sdrh     case TK_COLLATE: {
3403261d8a51Sdrh       return WRC_Continue;
3404261d8a51Sdrh     }
340547de955eSdrh     case TK_FUNCTION:
340647de955eSdrh     case TK_AGG_FUNCTION:
340747de955eSdrh     case TK_CONST_FUNC: {
340847de955eSdrh       /* The arguments to a function have a fixed destination.
340947de955eSdrh       ** Mark them this way to avoid generated unneeded OP_SCopy
341047de955eSdrh       ** instructions.
341147de955eSdrh       */
34126ab3a2ecSdanielk1977       ExprList *pList = pExpr->x.pList;
34136ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
341447de955eSdrh       if( pList ){
341547de955eSdrh         int i = pList->nExpr;
341647de955eSdrh         struct ExprList_item *pItem = pList->a;
341747de955eSdrh         for(; i>0; i--, pItem++){
341833cd4909Sdrh           if( ALWAYS(pItem->pExpr) ) pItem->pExpr->flags |= EP_FixedDest;
341947de955eSdrh         }
342047de955eSdrh       }
342147de955eSdrh       break;
342247de955eSdrh     }
342347de955eSdrh   }
342447de955eSdrh   if( isAppropriateForFactoring(pExpr) ){
3425678ccce8Sdrh     int r1 = ++pParse->nMem;
3426261d8a51Sdrh     int r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
3427261d8a51Sdrh     /* If r2!=r1, it means that register r1 is never used.  That is harmless
3428261d8a51Sdrh     ** but suboptimal, so we want to know about the situation to fix it.
3429261d8a51Sdrh     ** Hence the following assert: */
3430261d8a51Sdrh     assert( r2==r1 );
3431a4c3c87eSdrh     exprToRegister(pExpr, r2);
34327d10d5a6Sdrh     return WRC_Prune;
3433678ccce8Sdrh   }
34347d10d5a6Sdrh   return WRC_Continue;
3435678ccce8Sdrh }
3436678ccce8Sdrh 
3437678ccce8Sdrh /*
3438678ccce8Sdrh ** Preevaluate constant subexpressions within pExpr and store the
3439678ccce8Sdrh ** results in registers.  Modify pExpr so that the constant subexpresions
3440678ccce8Sdrh ** are TK_REGISTER opcodes that refer to the precomputed values.
3441f58ee7f1Sdrh **
3442f58ee7f1Sdrh ** This routine is a no-op if the jump to the cookie-check code has
3443f58ee7f1Sdrh ** already occur.  Since the cookie-check jump is generated prior to
3444f58ee7f1Sdrh ** any other serious processing, this check ensures that there is no
3445f58ee7f1Sdrh ** way to accidently bypass the constant initializations.
3446f58ee7f1Sdrh **
3447f58ee7f1Sdrh ** This routine is also a no-op if the SQLITE_FactorOutConst optimization
3448f58ee7f1Sdrh ** is disabled via the sqlite3_test_control(SQLITE_TESTCTRL_OPTIMIZATIONS)
3449f58ee7f1Sdrh ** interface.  This allows test logic to verify that the same answer is
3450f58ee7f1Sdrh ** obtained for queries regardless of whether or not constants are
3451f58ee7f1Sdrh ** precomputed into registers or if they are inserted in-line.
3452678ccce8Sdrh */
3453678ccce8Sdrh void sqlite3ExprCodeConstants(Parse *pParse, Expr *pExpr){
34547d10d5a6Sdrh   Walker w;
345548b5b041Sdrh   if( pParse->cookieGoto ) return;
34567e5418e4Sdrh   if( OptimizationDisabled(pParse->db, SQLITE_FactorOutConst) ) return;
3457aa87f9a6Sdrh   memset(&w, 0, sizeof(w));
34587d10d5a6Sdrh   w.xExprCallback = evalConstExpr;
34597d10d5a6Sdrh   w.pParse = pParse;
34607d10d5a6Sdrh   sqlite3WalkExpr(&w, pExpr);
3461678ccce8Sdrh }
3462678ccce8Sdrh 
346325303780Sdrh 
346425303780Sdrh /*
3465268380caSdrh ** Generate code that pushes the value of every element of the given
34669cbf3425Sdrh ** expression list into a sequence of registers beginning at target.
3467268380caSdrh **
3468892d3179Sdrh ** Return the number of elements evaluated.
3469268380caSdrh */
34704adee20fSdanielk1977 int sqlite3ExprCodeExprList(
3471268380caSdrh   Parse *pParse,     /* Parsing context */
3472389a1adbSdrh   ExprList *pList,   /* The expression list to be coded */
3473191b54cbSdrh   int target,        /* Where to write results */
3474d176611bSdrh   int doHardCopy     /* Make a hard copy of every element */
3475268380caSdrh ){
3476268380caSdrh   struct ExprList_item *pItem;
34779cbf3425Sdrh   int i, n;
34789d8b3072Sdrh   assert( pList!=0 );
34799cbf3425Sdrh   assert( target>0 );
3480d81a142bSdrh   assert( pParse->pVdbe!=0 );  /* Never gets this far otherwise */
3481268380caSdrh   n = pList->nExpr;
3482191b54cbSdrh   for(pItem=pList->a, i=0; i<n; i++, pItem++){
34837445ffe2Sdrh     Expr *pExpr = pItem->pExpr;
34847445ffe2Sdrh     int inReg = sqlite3ExprCodeTarget(pParse, pExpr, target+i);
3485746fd9ccSdrh     if( inReg!=target+i ){
34867445ffe2Sdrh       sqlite3VdbeAddOp2(pParse->pVdbe, doHardCopy ? OP_Copy : OP_SCopy,
34877445ffe2Sdrh                         inReg, target+i);
3488d176611bSdrh     }
3489268380caSdrh   }
3490f9b596ebSdrh   return n;
3491268380caSdrh }
3492268380caSdrh 
3493268380caSdrh /*
349436c563a2Sdrh ** Generate code for a BETWEEN operator.
349536c563a2Sdrh **
349636c563a2Sdrh **    x BETWEEN y AND z
349736c563a2Sdrh **
349836c563a2Sdrh ** The above is equivalent to
349936c563a2Sdrh **
350036c563a2Sdrh **    x>=y AND x<=z
350136c563a2Sdrh **
350236c563a2Sdrh ** Code it as such, taking care to do the common subexpression
350336c563a2Sdrh ** elementation of x.
350436c563a2Sdrh */
350536c563a2Sdrh static void exprCodeBetween(
350636c563a2Sdrh   Parse *pParse,    /* Parsing and code generating context */
350736c563a2Sdrh   Expr *pExpr,      /* The BETWEEN expression */
350836c563a2Sdrh   int dest,         /* Jump here if the jump is taken */
350936c563a2Sdrh   int jumpIfTrue,   /* Take the jump if the BETWEEN is true */
351036c563a2Sdrh   int jumpIfNull    /* Take the jump if the BETWEEN is NULL */
351136c563a2Sdrh ){
351236c563a2Sdrh   Expr exprAnd;     /* The AND operator in  x>=y AND x<=z  */
351336c563a2Sdrh   Expr compLeft;    /* The  x>=y  term */
351436c563a2Sdrh   Expr compRight;   /* The  x<=z  term */
351536c563a2Sdrh   Expr exprX;       /* The  x  subexpression */
351636c563a2Sdrh   int regFree1 = 0; /* Temporary use register */
351736c563a2Sdrh 
351836c563a2Sdrh   assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
351936c563a2Sdrh   exprX = *pExpr->pLeft;
352036c563a2Sdrh   exprAnd.op = TK_AND;
352136c563a2Sdrh   exprAnd.pLeft = &compLeft;
352236c563a2Sdrh   exprAnd.pRight = &compRight;
352336c563a2Sdrh   compLeft.op = TK_GE;
352436c563a2Sdrh   compLeft.pLeft = &exprX;
352536c563a2Sdrh   compLeft.pRight = pExpr->x.pList->a[0].pExpr;
352636c563a2Sdrh   compRight.op = TK_LE;
352736c563a2Sdrh   compRight.pLeft = &exprX;
352836c563a2Sdrh   compRight.pRight = pExpr->x.pList->a[1].pExpr;
3529a4c3c87eSdrh   exprToRegister(&exprX, sqlite3ExprCodeTemp(pParse, &exprX, &regFree1));
353036c563a2Sdrh   if( jumpIfTrue ){
353136c563a2Sdrh     sqlite3ExprIfTrue(pParse, &exprAnd, dest, jumpIfNull);
353236c563a2Sdrh   }else{
353336c563a2Sdrh     sqlite3ExprIfFalse(pParse, &exprAnd, dest, jumpIfNull);
353436c563a2Sdrh   }
353536c563a2Sdrh   sqlite3ReleaseTempReg(pParse, regFree1);
353636c563a2Sdrh 
353736c563a2Sdrh   /* Ensure adequate test coverage */
353836c563a2Sdrh   testcase( jumpIfTrue==0 && jumpIfNull==0 && regFree1==0 );
353936c563a2Sdrh   testcase( jumpIfTrue==0 && jumpIfNull==0 && regFree1!=0 );
354036c563a2Sdrh   testcase( jumpIfTrue==0 && jumpIfNull!=0 && regFree1==0 );
354136c563a2Sdrh   testcase( jumpIfTrue==0 && jumpIfNull!=0 && regFree1!=0 );
354236c563a2Sdrh   testcase( jumpIfTrue!=0 && jumpIfNull==0 && regFree1==0 );
354336c563a2Sdrh   testcase( jumpIfTrue!=0 && jumpIfNull==0 && regFree1!=0 );
354436c563a2Sdrh   testcase( jumpIfTrue!=0 && jumpIfNull!=0 && regFree1==0 );
354536c563a2Sdrh   testcase( jumpIfTrue!=0 && jumpIfNull!=0 && regFree1!=0 );
354636c563a2Sdrh }
354736c563a2Sdrh 
354836c563a2Sdrh /*
3549cce7d176Sdrh ** Generate code for a boolean expression such that a jump is made
3550cce7d176Sdrh ** to the label "dest" if the expression is true but execution
3551cce7d176Sdrh ** continues straight thru if the expression is false.
3552f5905aa7Sdrh **
3553f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false), then
355435573356Sdrh ** take the jump if the jumpIfNull flag is SQLITE_JUMPIFNULL.
3555f2bc013cSdrh **
3556f2bc013cSdrh ** This code depends on the fact that certain token values (ex: TK_EQ)
3557f2bc013cSdrh ** are the same as opcode values (ex: OP_Eq) that implement the corresponding
3558f2bc013cSdrh ** operation.  Special comments in vdbe.c and the mkopcodeh.awk script in
3559f2bc013cSdrh ** the make process cause these values to align.  Assert()s in the code
3560f2bc013cSdrh ** below verify that the numbers are aligned correctly.
3561cce7d176Sdrh */
35624adee20fSdanielk1977 void sqlite3ExprIfTrue(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
3563cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
3564cce7d176Sdrh   int op = 0;
35652dcef11bSdrh   int regFree1 = 0;
35662dcef11bSdrh   int regFree2 = 0;
35672dcef11bSdrh   int r1, r2;
35682dcef11bSdrh 
356935573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
357048864df9Smistachkin   if( NEVER(v==0) )     return;  /* Existence of VDBE checked by caller */
357133cd4909Sdrh   if( NEVER(pExpr==0) ) return;  /* No way this can happen */
3572f2bc013cSdrh   op = pExpr->op;
3573f2bc013cSdrh   switch( op ){
3574cce7d176Sdrh     case TK_AND: {
35754adee20fSdanielk1977       int d2 = sqlite3VdbeMakeLabel(v);
3576c5499befSdrh       testcase( jumpIfNull==0 );
3577ceea3321Sdrh       sqlite3ExprCachePush(pParse);
357835573356Sdrh       sqlite3ExprIfFalse(pParse, pExpr->pLeft, d2,jumpIfNull^SQLITE_JUMPIFNULL);
35794adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
35804adee20fSdanielk1977       sqlite3VdbeResolveLabel(v, d2);
3581ceea3321Sdrh       sqlite3ExprCachePop(pParse, 1);
3582cce7d176Sdrh       break;
3583cce7d176Sdrh     }
3584cce7d176Sdrh     case TK_OR: {
3585c5499befSdrh       testcase( jumpIfNull==0 );
35864adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
35874adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
3588cce7d176Sdrh       break;
3589cce7d176Sdrh     }
3590cce7d176Sdrh     case TK_NOT: {
3591c5499befSdrh       testcase( jumpIfNull==0 );
35924adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
3593cce7d176Sdrh       break;
3594cce7d176Sdrh     }
3595cce7d176Sdrh     case TK_LT:
3596cce7d176Sdrh     case TK_LE:
3597cce7d176Sdrh     case TK_GT:
3598cce7d176Sdrh     case TK_GE:
3599cce7d176Sdrh     case TK_NE:
36000ac65892Sdrh     case TK_EQ: {
3601f2bc013cSdrh       assert( TK_LT==OP_Lt );
3602f2bc013cSdrh       assert( TK_LE==OP_Le );
3603f2bc013cSdrh       assert( TK_GT==OP_Gt );
3604f2bc013cSdrh       assert( TK_GE==OP_Ge );
3605f2bc013cSdrh       assert( TK_EQ==OP_Eq );
3606f2bc013cSdrh       assert( TK_NE==OP_Ne );
3607c5499befSdrh       testcase( op==TK_LT );
3608c5499befSdrh       testcase( op==TK_LE );
3609c5499befSdrh       testcase( op==TK_GT );
3610c5499befSdrh       testcase( op==TK_GE );
3611c5499befSdrh       testcase( op==TK_EQ );
3612c5499befSdrh       testcase( op==TK_NE );
3613c5499befSdrh       testcase( jumpIfNull==0 );
3614b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3615b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
361635573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
36172dcef11bSdrh                   r1, r2, dest, jumpIfNull);
3618c5499befSdrh       testcase( regFree1==0 );
3619c5499befSdrh       testcase( regFree2==0 );
3620cce7d176Sdrh       break;
3621cce7d176Sdrh     }
36226a2fe093Sdrh     case TK_IS:
36236a2fe093Sdrh     case TK_ISNOT: {
36246a2fe093Sdrh       testcase( op==TK_IS );
36256a2fe093Sdrh       testcase( op==TK_ISNOT );
3626b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3627b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
36286a2fe093Sdrh       op = (op==TK_IS) ? TK_EQ : TK_NE;
36296a2fe093Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
36306a2fe093Sdrh                   r1, r2, dest, SQLITE_NULLEQ);
36316a2fe093Sdrh       testcase( regFree1==0 );
36326a2fe093Sdrh       testcase( regFree2==0 );
36336a2fe093Sdrh       break;
36346a2fe093Sdrh     }
3635cce7d176Sdrh     case TK_ISNULL:
3636cce7d176Sdrh     case TK_NOTNULL: {
3637f2bc013cSdrh       assert( TK_ISNULL==OP_IsNull );
3638f2bc013cSdrh       assert( TK_NOTNULL==OP_NotNull );
3639c5499befSdrh       testcase( op==TK_ISNULL );
3640c5499befSdrh       testcase( op==TK_NOTNULL );
36412dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
36422dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
3643c5499befSdrh       testcase( regFree1==0 );
3644cce7d176Sdrh       break;
3645cce7d176Sdrh     }
3646fef5208cSdrh     case TK_BETWEEN: {
36475c03f30aSdrh       testcase( jumpIfNull==0 );
364836c563a2Sdrh       exprCodeBetween(pParse, pExpr, dest, 1, jumpIfNull);
3649fef5208cSdrh       break;
3650fef5208cSdrh     }
3651bb201344Sshaneh #ifndef SQLITE_OMIT_SUBQUERY
3652e3365e6cSdrh     case TK_IN: {
3653e3365e6cSdrh       int destIfFalse = sqlite3VdbeMakeLabel(v);
3654e3365e6cSdrh       int destIfNull = jumpIfNull ? dest : destIfFalse;
3655e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
3656e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_Goto, 0, dest);
3657e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
3658e3365e6cSdrh       break;
3659e3365e6cSdrh     }
3660bb201344Sshaneh #endif
3661cce7d176Sdrh     default: {
36622dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
36632dcef11bSdrh       sqlite3VdbeAddOp3(v, OP_If, r1, dest, jumpIfNull!=0);
3664c5499befSdrh       testcase( regFree1==0 );
3665c5499befSdrh       testcase( jumpIfNull==0 );
3666cce7d176Sdrh       break;
3667cce7d176Sdrh     }
3668cce7d176Sdrh   }
36692dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
36702dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
3671cce7d176Sdrh }
3672cce7d176Sdrh 
3673cce7d176Sdrh /*
367466b89c8fSdrh ** Generate code for a boolean expression such that a jump is made
3675cce7d176Sdrh ** to the label "dest" if the expression is false but execution
3676cce7d176Sdrh ** continues straight thru if the expression is true.
3677f5905aa7Sdrh **
3678f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false) then
367935573356Sdrh ** jump if jumpIfNull is SQLITE_JUMPIFNULL or fall through if jumpIfNull
368035573356Sdrh ** is 0.
3681cce7d176Sdrh */
36824adee20fSdanielk1977 void sqlite3ExprIfFalse(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
3683cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
3684cce7d176Sdrh   int op = 0;
36852dcef11bSdrh   int regFree1 = 0;
36862dcef11bSdrh   int regFree2 = 0;
36872dcef11bSdrh   int r1, r2;
36882dcef11bSdrh 
368935573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
369048864df9Smistachkin   if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
369133cd4909Sdrh   if( pExpr==0 )    return;
3692f2bc013cSdrh 
3693f2bc013cSdrh   /* The value of pExpr->op and op are related as follows:
3694f2bc013cSdrh   **
3695f2bc013cSdrh   **       pExpr->op            op
3696f2bc013cSdrh   **       ---------          ----------
3697f2bc013cSdrh   **       TK_ISNULL          OP_NotNull
3698f2bc013cSdrh   **       TK_NOTNULL         OP_IsNull
3699f2bc013cSdrh   **       TK_NE              OP_Eq
3700f2bc013cSdrh   **       TK_EQ              OP_Ne
3701f2bc013cSdrh   **       TK_GT              OP_Le
3702f2bc013cSdrh   **       TK_LE              OP_Gt
3703f2bc013cSdrh   **       TK_GE              OP_Lt
3704f2bc013cSdrh   **       TK_LT              OP_Ge
3705f2bc013cSdrh   **
3706f2bc013cSdrh   ** For other values of pExpr->op, op is undefined and unused.
3707f2bc013cSdrh   ** The value of TK_ and OP_ constants are arranged such that we
3708f2bc013cSdrh   ** can compute the mapping above using the following expression.
3709f2bc013cSdrh   ** Assert()s verify that the computation is correct.
3710f2bc013cSdrh   */
3711f2bc013cSdrh   op = ((pExpr->op+(TK_ISNULL&1))^1)-(TK_ISNULL&1);
3712f2bc013cSdrh 
3713f2bc013cSdrh   /* Verify correct alignment of TK_ and OP_ constants
3714f2bc013cSdrh   */
3715f2bc013cSdrh   assert( pExpr->op!=TK_ISNULL || op==OP_NotNull );
3716f2bc013cSdrh   assert( pExpr->op!=TK_NOTNULL || op==OP_IsNull );
3717f2bc013cSdrh   assert( pExpr->op!=TK_NE || op==OP_Eq );
3718f2bc013cSdrh   assert( pExpr->op!=TK_EQ || op==OP_Ne );
3719f2bc013cSdrh   assert( pExpr->op!=TK_LT || op==OP_Ge );
3720f2bc013cSdrh   assert( pExpr->op!=TK_LE || op==OP_Gt );
3721f2bc013cSdrh   assert( pExpr->op!=TK_GT || op==OP_Le );
3722f2bc013cSdrh   assert( pExpr->op!=TK_GE || op==OP_Lt );
3723f2bc013cSdrh 
3724cce7d176Sdrh   switch( pExpr->op ){
3725cce7d176Sdrh     case TK_AND: {
3726c5499befSdrh       testcase( jumpIfNull==0 );
37274adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
37284adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
3729cce7d176Sdrh       break;
3730cce7d176Sdrh     }
3731cce7d176Sdrh     case TK_OR: {
37324adee20fSdanielk1977       int d2 = sqlite3VdbeMakeLabel(v);
3733c5499befSdrh       testcase( jumpIfNull==0 );
3734ceea3321Sdrh       sqlite3ExprCachePush(pParse);
373535573356Sdrh       sqlite3ExprIfTrue(pParse, pExpr->pLeft, d2, jumpIfNull^SQLITE_JUMPIFNULL);
37364adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
37374adee20fSdanielk1977       sqlite3VdbeResolveLabel(v, d2);
3738ceea3321Sdrh       sqlite3ExprCachePop(pParse, 1);
3739cce7d176Sdrh       break;
3740cce7d176Sdrh     }
3741cce7d176Sdrh     case TK_NOT: {
37425c03f30aSdrh       testcase( jumpIfNull==0 );
37434adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
3744cce7d176Sdrh       break;
3745cce7d176Sdrh     }
3746cce7d176Sdrh     case TK_LT:
3747cce7d176Sdrh     case TK_LE:
3748cce7d176Sdrh     case TK_GT:
3749cce7d176Sdrh     case TK_GE:
3750cce7d176Sdrh     case TK_NE:
3751cce7d176Sdrh     case TK_EQ: {
3752c5499befSdrh       testcase( op==TK_LT );
3753c5499befSdrh       testcase( op==TK_LE );
3754c5499befSdrh       testcase( op==TK_GT );
3755c5499befSdrh       testcase( op==TK_GE );
3756c5499befSdrh       testcase( op==TK_EQ );
3757c5499befSdrh       testcase( op==TK_NE );
3758c5499befSdrh       testcase( jumpIfNull==0 );
3759b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3760b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
376135573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
37622dcef11bSdrh                   r1, r2, dest, jumpIfNull);
3763c5499befSdrh       testcase( regFree1==0 );
3764c5499befSdrh       testcase( regFree2==0 );
3765cce7d176Sdrh       break;
3766cce7d176Sdrh     }
37676a2fe093Sdrh     case TK_IS:
37686a2fe093Sdrh     case TK_ISNOT: {
37696d4486aeSdrh       testcase( pExpr->op==TK_IS );
37706d4486aeSdrh       testcase( pExpr->op==TK_ISNOT );
3771b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3772b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
37736a2fe093Sdrh       op = (pExpr->op==TK_IS) ? TK_NE : TK_EQ;
37746a2fe093Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
37756a2fe093Sdrh                   r1, r2, dest, SQLITE_NULLEQ);
37766a2fe093Sdrh       testcase( regFree1==0 );
37776a2fe093Sdrh       testcase( regFree2==0 );
37786a2fe093Sdrh       break;
37796a2fe093Sdrh     }
3780cce7d176Sdrh     case TK_ISNULL:
3781cce7d176Sdrh     case TK_NOTNULL: {
3782c5499befSdrh       testcase( op==TK_ISNULL );
3783c5499befSdrh       testcase( op==TK_NOTNULL );
37842dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
37852dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
3786c5499befSdrh       testcase( regFree1==0 );
3787cce7d176Sdrh       break;
3788cce7d176Sdrh     }
3789fef5208cSdrh     case TK_BETWEEN: {
37905c03f30aSdrh       testcase( jumpIfNull==0 );
379136c563a2Sdrh       exprCodeBetween(pParse, pExpr, dest, 0, jumpIfNull);
3792fef5208cSdrh       break;
3793fef5208cSdrh     }
3794bb201344Sshaneh #ifndef SQLITE_OMIT_SUBQUERY
3795e3365e6cSdrh     case TK_IN: {
3796e3365e6cSdrh       if( jumpIfNull ){
3797e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, dest);
3798e3365e6cSdrh       }else{
3799e3365e6cSdrh         int destIfNull = sqlite3VdbeMakeLabel(v);
3800e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, destIfNull);
3801e3365e6cSdrh         sqlite3VdbeResolveLabel(v, destIfNull);
3802e3365e6cSdrh       }
3803e3365e6cSdrh       break;
3804e3365e6cSdrh     }
3805bb201344Sshaneh #endif
3806cce7d176Sdrh     default: {
38072dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
38082dcef11bSdrh       sqlite3VdbeAddOp3(v, OP_IfNot, r1, dest, jumpIfNull!=0);
3809c5499befSdrh       testcase( regFree1==0 );
3810c5499befSdrh       testcase( jumpIfNull==0 );
3811cce7d176Sdrh       break;
3812cce7d176Sdrh     }
3813cce7d176Sdrh   }
38142dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
38152dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
3816cce7d176Sdrh }
38172282792aSdrh 
38182282792aSdrh /*
38191d9da70aSdrh ** Do a deep comparison of two expression trees.  Return 0 if the two
38201d9da70aSdrh ** expressions are completely identical.  Return 1 if they differ only
38211d9da70aSdrh ** by a COLLATE operator at the top level.  Return 2 if there are differences
38221d9da70aSdrh ** other than the top-level COLLATE operator.
3823d40aab0eSdrh **
3824619a1305Sdrh ** If any subelement of pB has Expr.iTable==(-1) then it is allowed
3825619a1305Sdrh ** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
3826619a1305Sdrh **
382766518ca7Sdrh ** The pA side might be using TK_REGISTER.  If that is the case and pB is
382866518ca7Sdrh ** not using TK_REGISTER but is otherwise equivalent, then still return 0.
382966518ca7Sdrh **
38301d9da70aSdrh ** Sometimes this routine will return 2 even if the two expressions
3831d40aab0eSdrh ** really are equivalent.  If we cannot prove that the expressions are
38321d9da70aSdrh ** identical, we return 2 just to be safe.  So if this routine
38331d9da70aSdrh ** returns 2, then you do not really know for certain if the two
38341d9da70aSdrh ** expressions are the same.  But if you get a 0 or 1 return, then you
3835d40aab0eSdrh ** can be sure the expressions are the same.  In the places where
38361d9da70aSdrh ** this routine is used, it does not hurt to get an extra 2 - that
3837d40aab0eSdrh ** just might result in some slightly slower code.  But returning
38381d9da70aSdrh ** an incorrect 0 or 1 could lead to a malfunction.
38392282792aSdrh */
3840619a1305Sdrh int sqlite3ExprCompare(Expr *pA, Expr *pB, int iTab){
38414b202ae2Sdanielk1977   if( pA==0||pB==0 ){
38421d9da70aSdrh     return pB==pA ? 0 : 2;
38432282792aSdrh   }
3844c5cd1249Sdrh   assert( !ExprHasProperty(pA, EP_TokenOnly|EP_Reduced) );
3845c5cd1249Sdrh   assert( !ExprHasProperty(pB, EP_TokenOnly|EP_Reduced) );
38466ab3a2ecSdanielk1977   if( ExprHasProperty(pA, EP_xIsSelect) || ExprHasProperty(pB, EP_xIsSelect) ){
38471d9da70aSdrh     return 2;
38486ab3a2ecSdanielk1977   }
38491d9da70aSdrh   if( (pA->flags & EP_Distinct)!=(pB->flags & EP_Distinct) ) return 2;
385066518ca7Sdrh   if( pA->op!=pB->op && (pA->op!=TK_REGISTER || pA->op2!=pB->op) ){
3851619a1305Sdrh     if( pA->op==TK_COLLATE && sqlite3ExprCompare(pA->pLeft, pB, iTab)<2 ){
3852ae80ddeaSdrh       return 1;
3853ae80ddeaSdrh     }
3854619a1305Sdrh     if( pB->op==TK_COLLATE && sqlite3ExprCompare(pA, pB->pLeft, iTab)<2 ){
3855ae80ddeaSdrh       return 1;
3856ae80ddeaSdrh     }
3857ae80ddeaSdrh     return 2;
3858ae80ddeaSdrh   }
3859619a1305Sdrh   if( sqlite3ExprCompare(pA->pLeft, pB->pLeft, iTab) ) return 2;
3860619a1305Sdrh   if( sqlite3ExprCompare(pA->pRight, pB->pRight, iTab) ) return 2;
3861619a1305Sdrh   if( sqlite3ExprListCompare(pA->x.pList, pB->x.pList, iTab) ) return 2;
3862619a1305Sdrh   if( pA->iColumn!=pB->iColumn ) return 2;
386366518ca7Sdrh   if( pA->iTable!=pB->iTable
386466518ca7Sdrh    && pA->op!=TK_REGISTER
3865e0c7efd9Sdrh    && (pA->iTable!=iTab || NEVER(pB->iTable>=0)) ) return 2;
386633e619fcSdrh   if( ExprHasProperty(pA, EP_IntValue) ){
386733e619fcSdrh     if( !ExprHasProperty(pB, EP_IntValue) || pA->u.iValue!=pB->u.iValue ){
38681d9da70aSdrh       return 2;
386933e619fcSdrh     }
3870bbabe197Sdrh   }else if( pA->op!=TK_COLUMN && ALWAYS(pA->op!=TK_AGG_COLUMN) && pA->u.zToken){
38711d9da70aSdrh     if( ExprHasProperty(pB, EP_IntValue) || NEVER(pB->u.zToken==0) ) return 2;
38726b93c9aeSdrh     if( strcmp(pA->u.zToken,pB->u.zToken)!=0 ){
3873ae80ddeaSdrh       return pA->op==TK_COLLATE ? 1 : 2;
38741d9da70aSdrh     }
38751d9da70aSdrh   }
38762646da7eSdrh   return 0;
38772646da7eSdrh }
38782282792aSdrh 
38798c6f666bSdrh /*
38808c6f666bSdrh ** Compare two ExprList objects.  Return 0 if they are identical and
38818c6f666bSdrh ** non-zero if they differ in any way.
38828c6f666bSdrh **
3883619a1305Sdrh ** If any subelement of pB has Expr.iTable==(-1) then it is allowed
3884619a1305Sdrh ** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
3885619a1305Sdrh **
38868c6f666bSdrh ** This routine might return non-zero for equivalent ExprLists.  The
38878c6f666bSdrh ** only consequence will be disabled optimizations.  But this routine
38888c6f666bSdrh ** must never return 0 if the two ExprList objects are different, or
38898c6f666bSdrh ** a malfunction will result.
38908c6f666bSdrh **
38918c6f666bSdrh ** Two NULL pointers are considered to be the same.  But a NULL pointer
38928c6f666bSdrh ** always differs from a non-NULL pointer.
38938c6f666bSdrh */
3894619a1305Sdrh int sqlite3ExprListCompare(ExprList *pA, ExprList *pB, int iTab){
38958c6f666bSdrh   int i;
38968c6f666bSdrh   if( pA==0 && pB==0 ) return 0;
38978c6f666bSdrh   if( pA==0 || pB==0 ) return 1;
38988c6f666bSdrh   if( pA->nExpr!=pB->nExpr ) return 1;
38998c6f666bSdrh   for(i=0; i<pA->nExpr; i++){
39008c6f666bSdrh     Expr *pExprA = pA->a[i].pExpr;
39018c6f666bSdrh     Expr *pExprB = pB->a[i].pExpr;
39028c6f666bSdrh     if( pA->a[i].sortOrder!=pB->a[i].sortOrder ) return 1;
3903619a1305Sdrh     if( sqlite3ExprCompare(pExprA, pExprB, iTab) ) return 1;
39048c6f666bSdrh   }
39058c6f666bSdrh   return 0;
39068c6f666bSdrh }
390713449892Sdrh 
39082282792aSdrh /*
39094bd5f73fSdrh ** Return true if we can prove the pE2 will always be true if pE1 is
39104bd5f73fSdrh ** true.  Return false if we cannot complete the proof or if pE2 might
39114bd5f73fSdrh ** be false.  Examples:
39124bd5f73fSdrh **
3913619a1305Sdrh **     pE1: x==5       pE2: x==5             Result: true
39144bd5f73fSdrh **     pE1: x>0        pE2: x==5             Result: false
3915619a1305Sdrh **     pE1: x=21       pE2: x=21 OR y=43     Result: true
39164bd5f73fSdrh **     pE1: x!=123     pE2: x IS NOT NULL    Result: true
3917619a1305Sdrh **     pE1: x!=?1      pE2: x IS NOT NULL    Result: true
3918619a1305Sdrh **     pE1: x IS NULL  pE2: x IS NOT NULL    Result: false
3919619a1305Sdrh **     pE1: x IS ?2    pE2: x IS NOT NULL    Reuslt: false
39204bd5f73fSdrh **
39214bd5f73fSdrh ** When comparing TK_COLUMN nodes between pE1 and pE2, if pE2 has
39224bd5f73fSdrh ** Expr.iTable<0 then assume a table number given by iTab.
39234bd5f73fSdrh **
39244bd5f73fSdrh ** When in doubt, return false.  Returning true might give a performance
39254bd5f73fSdrh ** improvement.  Returning false might cause a performance reduction, but
39264bd5f73fSdrh ** it will always give the correct answer and is hence always safe.
39274bd5f73fSdrh */
39284bd5f73fSdrh int sqlite3ExprImpliesExpr(Expr *pE1, Expr *pE2, int iTab){
3929619a1305Sdrh   if( sqlite3ExprCompare(pE1, pE2, iTab)==0 ){
3930619a1305Sdrh     return 1;
3931619a1305Sdrh   }
3932619a1305Sdrh   if( pE2->op==TK_OR
3933619a1305Sdrh    && (sqlite3ExprImpliesExpr(pE1, pE2->pLeft, iTab)
3934619a1305Sdrh              || sqlite3ExprImpliesExpr(pE1, pE2->pRight, iTab) )
3935619a1305Sdrh   ){
3936619a1305Sdrh     return 1;
3937619a1305Sdrh   }
3938619a1305Sdrh   if( pE2->op==TK_NOTNULL
3939619a1305Sdrh    && sqlite3ExprCompare(pE1->pLeft, pE2->pLeft, iTab)==0
3940619a1305Sdrh    && (pE1->op!=TK_ISNULL && pE1->op!=TK_IS)
3941619a1305Sdrh   ){
3942619a1305Sdrh     return 1;
3943619a1305Sdrh   }
3944619a1305Sdrh   return 0;
39454bd5f73fSdrh }
39464bd5f73fSdrh 
39474bd5f73fSdrh /*
3948030796dfSdrh ** An instance of the following structure is used by the tree walker
3949030796dfSdrh ** to count references to table columns in the arguments of an
3950ed551b95Sdrh ** aggregate function, in order to implement the
3951ed551b95Sdrh ** sqlite3FunctionThisSrc() routine.
3952374fdce4Sdrh */
3953030796dfSdrh struct SrcCount {
3954030796dfSdrh   SrcList *pSrc;   /* One particular FROM clause in a nested query */
3955030796dfSdrh   int nThis;       /* Number of references to columns in pSrcList */
3956030796dfSdrh   int nOther;      /* Number of references to columns in other FROM clauses */
3957030796dfSdrh };
3958030796dfSdrh 
3959030796dfSdrh /*
3960030796dfSdrh ** Count the number of references to columns.
3961030796dfSdrh */
3962030796dfSdrh static int exprSrcCount(Walker *pWalker, Expr *pExpr){
3963fb0a6081Sdrh   /* The NEVER() on the second term is because sqlite3FunctionUsesThisSrc()
3964fb0a6081Sdrh   ** is always called before sqlite3ExprAnalyzeAggregates() and so the
3965fb0a6081Sdrh   ** TK_COLUMNs have not yet been converted into TK_AGG_COLUMN.  If
3966fb0a6081Sdrh   ** sqlite3FunctionUsesThisSrc() is used differently in the future, the
3967fb0a6081Sdrh   ** NEVER() will need to be removed. */
3968fb0a6081Sdrh   if( pExpr->op==TK_COLUMN || NEVER(pExpr->op==TK_AGG_COLUMN) ){
3969374fdce4Sdrh     int i;
3970030796dfSdrh     struct SrcCount *p = pWalker->u.pSrcCount;
3971030796dfSdrh     SrcList *pSrc = p->pSrc;
3972374fdce4Sdrh     for(i=0; i<pSrc->nSrc; i++){
3973030796dfSdrh       if( pExpr->iTable==pSrc->a[i].iCursor ) break;
3974374fdce4Sdrh     }
3975030796dfSdrh     if( i<pSrc->nSrc ){
3976030796dfSdrh       p->nThis++;
3977374fdce4Sdrh     }else{
3978030796dfSdrh       p->nOther++;
3979374fdce4Sdrh     }
3980374fdce4Sdrh   }
3981030796dfSdrh   return WRC_Continue;
3982030796dfSdrh }
3983374fdce4Sdrh 
3984374fdce4Sdrh /*
3985030796dfSdrh ** Determine if any of the arguments to the pExpr Function reference
3986030796dfSdrh ** pSrcList.  Return true if they do.  Also return true if the function
3987030796dfSdrh ** has no arguments or has only constant arguments.  Return false if pExpr
3988030796dfSdrh ** references columns but not columns of tables found in pSrcList.
3989374fdce4Sdrh */
3990030796dfSdrh int sqlite3FunctionUsesThisSrc(Expr *pExpr, SrcList *pSrcList){
3991374fdce4Sdrh   Walker w;
3992030796dfSdrh   struct SrcCount cnt;
3993374fdce4Sdrh   assert( pExpr->op==TK_AGG_FUNCTION );
3994374fdce4Sdrh   memset(&w, 0, sizeof(w));
3995030796dfSdrh   w.xExprCallback = exprSrcCount;
3996030796dfSdrh   w.u.pSrcCount = &cnt;
3997030796dfSdrh   cnt.pSrc = pSrcList;
3998030796dfSdrh   cnt.nThis = 0;
3999030796dfSdrh   cnt.nOther = 0;
4000030796dfSdrh   sqlite3WalkExprList(&w, pExpr->x.pList);
4001030796dfSdrh   return cnt.nThis>0 || cnt.nOther==0;
4002374fdce4Sdrh }
4003374fdce4Sdrh 
4004374fdce4Sdrh /*
400513449892Sdrh ** Add a new element to the pAggInfo->aCol[] array.  Return the index of
400613449892Sdrh ** the new element.  Return a negative number if malloc fails.
40072282792aSdrh */
400817435752Sdrh static int addAggInfoColumn(sqlite3 *db, AggInfo *pInfo){
400913449892Sdrh   int i;
4010cf643729Sdrh   pInfo->aCol = sqlite3ArrayAllocate(
401117435752Sdrh        db,
4012cf643729Sdrh        pInfo->aCol,
4013cf643729Sdrh        sizeof(pInfo->aCol[0]),
4014cf643729Sdrh        &pInfo->nColumn,
4015cf643729Sdrh        &i
4016cf643729Sdrh   );
401713449892Sdrh   return i;
40182282792aSdrh }
401913449892Sdrh 
402013449892Sdrh /*
402113449892Sdrh ** Add a new element to the pAggInfo->aFunc[] array.  Return the index of
402213449892Sdrh ** the new element.  Return a negative number if malloc fails.
402313449892Sdrh */
402417435752Sdrh static int addAggInfoFunc(sqlite3 *db, AggInfo *pInfo){
402513449892Sdrh   int i;
4026cf643729Sdrh   pInfo->aFunc = sqlite3ArrayAllocate(
402717435752Sdrh        db,
4028cf643729Sdrh        pInfo->aFunc,
4029cf643729Sdrh        sizeof(pInfo->aFunc[0]),
4030cf643729Sdrh        &pInfo->nFunc,
4031cf643729Sdrh        &i
4032cf643729Sdrh   );
403313449892Sdrh   return i;
40342282792aSdrh }
40352282792aSdrh 
40362282792aSdrh /*
40377d10d5a6Sdrh ** This is the xExprCallback for a tree walker.  It is used to
40387d10d5a6Sdrh ** implement sqlite3ExprAnalyzeAggregates().  See sqlite3ExprAnalyzeAggregates
4039626a879aSdrh ** for additional information.
40402282792aSdrh */
40417d10d5a6Sdrh static int analyzeAggregate(Walker *pWalker, Expr *pExpr){
40422282792aSdrh   int i;
40437d10d5a6Sdrh   NameContext *pNC = pWalker->u.pNC;
4044a58fdfb1Sdanielk1977   Parse *pParse = pNC->pParse;
4045a58fdfb1Sdanielk1977   SrcList *pSrcList = pNC->pSrcList;
404613449892Sdrh   AggInfo *pAggInfo = pNC->pAggInfo;
404713449892Sdrh 
40482282792aSdrh   switch( pExpr->op ){
404989c69d00Sdrh     case TK_AGG_COLUMN:
4050967e8b73Sdrh     case TK_COLUMN: {
40518b213899Sdrh       testcase( pExpr->op==TK_AGG_COLUMN );
40528b213899Sdrh       testcase( pExpr->op==TK_COLUMN );
405313449892Sdrh       /* Check to see if the column is in one of the tables in the FROM
405413449892Sdrh       ** clause of the aggregate query */
405520bc393cSdrh       if( ALWAYS(pSrcList!=0) ){
405613449892Sdrh         struct SrcList_item *pItem = pSrcList->a;
405713449892Sdrh         for(i=0; i<pSrcList->nSrc; i++, pItem++){
405813449892Sdrh           struct AggInfo_col *pCol;
4059c5cd1249Sdrh           assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
406013449892Sdrh           if( pExpr->iTable==pItem->iCursor ){
406113449892Sdrh             /* If we reach this point, it means that pExpr refers to a table
406213449892Sdrh             ** that is in the FROM clause of the aggregate query.
406313449892Sdrh             **
406413449892Sdrh             ** Make an entry for the column in pAggInfo->aCol[] if there
406513449892Sdrh             ** is not an entry there already.
406613449892Sdrh             */
40677f906d63Sdrh             int k;
406813449892Sdrh             pCol = pAggInfo->aCol;
40697f906d63Sdrh             for(k=0; k<pAggInfo->nColumn; k++, pCol++){
407013449892Sdrh               if( pCol->iTable==pExpr->iTable &&
407113449892Sdrh                   pCol->iColumn==pExpr->iColumn ){
40722282792aSdrh                 break;
40732282792aSdrh               }
40742282792aSdrh             }
40751e536953Sdanielk1977             if( (k>=pAggInfo->nColumn)
40761e536953Sdanielk1977              && (k = addAggInfoColumn(pParse->db, pAggInfo))>=0
40771e536953Sdanielk1977             ){
40787f906d63Sdrh               pCol = &pAggInfo->aCol[k];
40790817d0dfSdanielk1977               pCol->pTab = pExpr->pTab;
408013449892Sdrh               pCol->iTable = pExpr->iTable;
408113449892Sdrh               pCol->iColumn = pExpr->iColumn;
40820a07c107Sdrh               pCol->iMem = ++pParse->nMem;
408313449892Sdrh               pCol->iSorterColumn = -1;
40845774b806Sdrh               pCol->pExpr = pExpr;
408513449892Sdrh               if( pAggInfo->pGroupBy ){
408613449892Sdrh                 int j, n;
408713449892Sdrh                 ExprList *pGB = pAggInfo->pGroupBy;
408813449892Sdrh                 struct ExprList_item *pTerm = pGB->a;
408913449892Sdrh                 n = pGB->nExpr;
409013449892Sdrh                 for(j=0; j<n; j++, pTerm++){
409113449892Sdrh                   Expr *pE = pTerm->pExpr;
409213449892Sdrh                   if( pE->op==TK_COLUMN && pE->iTable==pExpr->iTable &&
409313449892Sdrh                       pE->iColumn==pExpr->iColumn ){
409413449892Sdrh                     pCol->iSorterColumn = j;
409513449892Sdrh                     break;
40962282792aSdrh                   }
409713449892Sdrh                 }
409813449892Sdrh               }
409913449892Sdrh               if( pCol->iSorterColumn<0 ){
410013449892Sdrh                 pCol->iSorterColumn = pAggInfo->nSortingColumn++;
410113449892Sdrh               }
410213449892Sdrh             }
410313449892Sdrh             /* There is now an entry for pExpr in pAggInfo->aCol[] (either
410413449892Sdrh             ** because it was there before or because we just created it).
410513449892Sdrh             ** Convert the pExpr to be a TK_AGG_COLUMN referring to that
410613449892Sdrh             ** pAggInfo->aCol[] entry.
410713449892Sdrh             */
4108ebb6a65dSdrh             ExprSetVVAProperty(pExpr, EP_NoReduce);
410913449892Sdrh             pExpr->pAggInfo = pAggInfo;
411013449892Sdrh             pExpr->op = TK_AGG_COLUMN;
4111cf697396Sshane             pExpr->iAgg = (i16)k;
411213449892Sdrh             break;
411313449892Sdrh           } /* endif pExpr->iTable==pItem->iCursor */
411413449892Sdrh         } /* end loop over pSrcList */
4115a58fdfb1Sdanielk1977       }
41167d10d5a6Sdrh       return WRC_Prune;
41172282792aSdrh     }
41182282792aSdrh     case TK_AGG_FUNCTION: {
41193a8c4be7Sdrh       if( (pNC->ncFlags & NC_InAggFunc)==0
4120ed551b95Sdrh        && pWalker->walkerDepth==pExpr->op2
41213a8c4be7Sdrh       ){
412213449892Sdrh         /* Check to see if pExpr is a duplicate of another aggregate
412313449892Sdrh         ** function that is already in the pAggInfo structure
412413449892Sdrh         */
412513449892Sdrh         struct AggInfo_func *pItem = pAggInfo->aFunc;
412613449892Sdrh         for(i=0; i<pAggInfo->nFunc; i++, pItem++){
4127619a1305Sdrh           if( sqlite3ExprCompare(pItem->pExpr, pExpr, -1)==0 ){
41282282792aSdrh             break;
41292282792aSdrh           }
41302282792aSdrh         }
413113449892Sdrh         if( i>=pAggInfo->nFunc ){
413213449892Sdrh           /* pExpr is original.  Make a new entry in pAggInfo->aFunc[]
413313449892Sdrh           */
413414db2665Sdanielk1977           u8 enc = ENC(pParse->db);
41351e536953Sdanielk1977           i = addAggInfoFunc(pParse->db, pAggInfo);
413613449892Sdrh           if( i>=0 ){
41376ab3a2ecSdanielk1977             assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
413813449892Sdrh             pItem = &pAggInfo->aFunc[i];
413913449892Sdrh             pItem->pExpr = pExpr;
41400a07c107Sdrh             pItem->iMem = ++pParse->nMem;
414133e619fcSdrh             assert( !ExprHasProperty(pExpr, EP_IntValue) );
414213449892Sdrh             pItem->pFunc = sqlite3FindFunction(pParse->db,
414333e619fcSdrh                    pExpr->u.zToken, sqlite3Strlen30(pExpr->u.zToken),
41446ab3a2ecSdanielk1977                    pExpr->x.pList ? pExpr->x.pList->nExpr : 0, enc, 0);
4145fd357974Sdrh             if( pExpr->flags & EP_Distinct ){
4146fd357974Sdrh               pItem->iDistinct = pParse->nTab++;
4147fd357974Sdrh             }else{
4148fd357974Sdrh               pItem->iDistinct = -1;
4149fd357974Sdrh             }
41502282792aSdrh           }
415113449892Sdrh         }
415213449892Sdrh         /* Make pExpr point to the appropriate pAggInfo->aFunc[] entry
415313449892Sdrh         */
4154c5cd1249Sdrh         assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
4155ebb6a65dSdrh         ExprSetVVAProperty(pExpr, EP_NoReduce);
4156cf697396Sshane         pExpr->iAgg = (i16)i;
415713449892Sdrh         pExpr->pAggInfo = pAggInfo;
41583a8c4be7Sdrh         return WRC_Prune;
41596e83a57fSdrh       }else{
41606e83a57fSdrh         return WRC_Continue;
41616e83a57fSdrh       }
41622282792aSdrh     }
4163a58fdfb1Sdanielk1977   }
41647d10d5a6Sdrh   return WRC_Continue;
41657d10d5a6Sdrh }
41667d10d5a6Sdrh static int analyzeAggregatesInSelect(Walker *pWalker, Select *pSelect){
4167d5a336efSdrh   UNUSED_PARAMETER(pWalker);
4168d5a336efSdrh   UNUSED_PARAMETER(pSelect);
41697d10d5a6Sdrh   return WRC_Continue;
4170a58fdfb1Sdanielk1977 }
4171626a879aSdrh 
4172626a879aSdrh /*
4173e8abb4caSdrh ** Analyze the pExpr expression looking for aggregate functions and
4174e8abb4caSdrh ** for variables that need to be added to AggInfo object that pNC->pAggInfo
4175e8abb4caSdrh ** points to.  Additional entries are made on the AggInfo object as
4176e8abb4caSdrh ** necessary.
4177626a879aSdrh **
4178626a879aSdrh ** This routine should only be called after the expression has been
41797d10d5a6Sdrh ** analyzed by sqlite3ResolveExprNames().
4180626a879aSdrh */
4181d2b3e23bSdrh void sqlite3ExprAnalyzeAggregates(NameContext *pNC, Expr *pExpr){
41827d10d5a6Sdrh   Walker w;
4183374fdce4Sdrh   memset(&w, 0, sizeof(w));
41847d10d5a6Sdrh   w.xExprCallback = analyzeAggregate;
41857d10d5a6Sdrh   w.xSelectCallback = analyzeAggregatesInSelect;
41867d10d5a6Sdrh   w.u.pNC = pNC;
418720bc393cSdrh   assert( pNC->pSrcList!=0 );
41887d10d5a6Sdrh   sqlite3WalkExpr(&w, pExpr);
41892282792aSdrh }
41905d9a4af9Sdrh 
41915d9a4af9Sdrh /*
41925d9a4af9Sdrh ** Call sqlite3ExprAnalyzeAggregates() for every expression in an
41935d9a4af9Sdrh ** expression list.  Return the number of errors.
41945d9a4af9Sdrh **
41955d9a4af9Sdrh ** If an error is found, the analysis is cut short.
41965d9a4af9Sdrh */
4197d2b3e23bSdrh void sqlite3ExprAnalyzeAggList(NameContext *pNC, ExprList *pList){
41985d9a4af9Sdrh   struct ExprList_item *pItem;
41995d9a4af9Sdrh   int i;
42005d9a4af9Sdrh   if( pList ){
4201d2b3e23bSdrh     for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
4202d2b3e23bSdrh       sqlite3ExprAnalyzeAggregates(pNC, pItem->pExpr);
42035d9a4af9Sdrh     }
42045d9a4af9Sdrh   }
42055d9a4af9Sdrh }
4206892d3179Sdrh 
4207892d3179Sdrh /*
4208ceea3321Sdrh ** Allocate a single new register for use to hold some intermediate result.
4209892d3179Sdrh */
4210892d3179Sdrh int sqlite3GetTempReg(Parse *pParse){
4211e55cbd72Sdrh   if( pParse->nTempReg==0 ){
4212892d3179Sdrh     return ++pParse->nMem;
4213892d3179Sdrh   }
42142f425f6bSdanielk1977   return pParse->aTempReg[--pParse->nTempReg];
4215892d3179Sdrh }
4216ceea3321Sdrh 
4217ceea3321Sdrh /*
4218ceea3321Sdrh ** Deallocate a register, making available for reuse for some other
4219ceea3321Sdrh ** purpose.
4220ceea3321Sdrh **
4221ceea3321Sdrh ** If a register is currently being used by the column cache, then
4222ceea3321Sdrh ** the dallocation is deferred until the column cache line that uses
4223ceea3321Sdrh ** the register becomes stale.
4224ceea3321Sdrh */
4225892d3179Sdrh void sqlite3ReleaseTempReg(Parse *pParse, int iReg){
42262dcef11bSdrh   if( iReg && pParse->nTempReg<ArraySize(pParse->aTempReg) ){
4227ceea3321Sdrh     int i;
4228ceea3321Sdrh     struct yColCache *p;
4229ceea3321Sdrh     for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
4230ceea3321Sdrh       if( p->iReg==iReg ){
4231ceea3321Sdrh         p->tempReg = 1;
4232ceea3321Sdrh         return;
4233ceea3321Sdrh       }
4234ceea3321Sdrh     }
4235892d3179Sdrh     pParse->aTempReg[pParse->nTempReg++] = iReg;
4236892d3179Sdrh   }
4237892d3179Sdrh }
4238892d3179Sdrh 
4239892d3179Sdrh /*
4240892d3179Sdrh ** Allocate or deallocate a block of nReg consecutive registers
4241892d3179Sdrh */
4242892d3179Sdrh int sqlite3GetTempRange(Parse *pParse, int nReg){
4243e55cbd72Sdrh   int i, n;
4244892d3179Sdrh   i = pParse->iRangeReg;
4245e55cbd72Sdrh   n = pParse->nRangeReg;
4246f49f3523Sdrh   if( nReg<=n ){
4247f49f3523Sdrh     assert( !usedAsColumnCache(pParse, i, i+n-1) );
4248892d3179Sdrh     pParse->iRangeReg += nReg;
4249892d3179Sdrh     pParse->nRangeReg -= nReg;
4250892d3179Sdrh   }else{
4251892d3179Sdrh     i = pParse->nMem+1;
4252892d3179Sdrh     pParse->nMem += nReg;
4253892d3179Sdrh   }
4254892d3179Sdrh   return i;
4255892d3179Sdrh }
4256892d3179Sdrh void sqlite3ReleaseTempRange(Parse *pParse, int iReg, int nReg){
4257f49f3523Sdrh   sqlite3ExprCacheRemove(pParse, iReg, nReg);
4258892d3179Sdrh   if( nReg>pParse->nRangeReg ){
4259892d3179Sdrh     pParse->nRangeReg = nReg;
4260892d3179Sdrh     pParse->iRangeReg = iReg;
4261892d3179Sdrh   }
4262892d3179Sdrh }
4263cdc69557Sdrh 
4264cdc69557Sdrh /*
4265cdc69557Sdrh ** Mark all temporary registers as being unavailable for reuse.
4266cdc69557Sdrh */
4267cdc69557Sdrh void sqlite3ClearTempRegCache(Parse *pParse){
4268cdc69557Sdrh   pParse->nTempReg = 0;
4269cdc69557Sdrh   pParse->nRangeReg = 0;
4270cdc69557Sdrh }
4271