xref: /sqlite-3.40.0/src/expr.c (revision 33e619fc)
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 **
15*33e619fcSdrh ** $Id: expr.c,v 1.438 2009/05/28 01:00:55 drh Exp $
16cce7d176Sdrh */
17cce7d176Sdrh #include "sqliteInt.h"
18a2e00042Sdrh 
19e014a838Sdanielk1977 /*
20e014a838Sdanielk1977 ** Return the 'affinity' of the expression pExpr if any.
21e014a838Sdanielk1977 **
22e014a838Sdanielk1977 ** If pExpr is a column, a reference to a column via an 'AS' alias,
23e014a838Sdanielk1977 ** or a sub-select with a column as the return value, then the
24e014a838Sdanielk1977 ** affinity of that column is returned. Otherwise, 0x00 is returned,
25e014a838Sdanielk1977 ** indicating no affinity for the expression.
26e014a838Sdanielk1977 **
27e014a838Sdanielk1977 ** i.e. the WHERE clause expresssions in the following statements all
28e014a838Sdanielk1977 ** have an affinity:
29e014a838Sdanielk1977 **
30e014a838Sdanielk1977 ** CREATE TABLE t1(a);
31e014a838Sdanielk1977 ** SELECT * FROM t1 WHERE a;
32e014a838Sdanielk1977 ** SELECT a AS b FROM t1 WHERE b;
33e014a838Sdanielk1977 ** SELECT * FROM t1 WHERE (select a from t1);
34e014a838Sdanielk1977 */
35bf3b721fSdanielk1977 char sqlite3ExprAffinity(Expr *pExpr){
36487e262fSdrh   int 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 ){
43*33e619fcSdrh     assert( !ExprHasProperty(pExpr, EP_IntValue) );
44*33e619fcSdrh     return sqlite3AffinityType(pExpr->u.zToken);
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
628b4c40d8Sdrh ** sequence named by pToken.   Return a pointer to the revised expression.
63a34001c9Sdrh ** The collating sequence is marked as "explicit" using the EP_ExpCollate
64a34001c9Sdrh ** flag.  An explicit collating sequence will override implicit
65a34001c9Sdrh ** collating sequences.
668b4c40d8Sdrh */
677d10d5a6Sdrh Expr *sqlite3ExprSetColl(Parse *pParse, Expr *pExpr, Token *pCollName){
6839002505Sdanielk1977   char *zColl = 0;            /* Dequoted name of collation sequence */
698b4c40d8Sdrh   CollSeq *pColl;
70633e6d57Sdrh   sqlite3 *db = pParse->db;
717d10d5a6Sdrh   zColl = sqlite3NameFromToken(db, pCollName);
7239002505Sdanielk1977   if( pExpr && zColl ){
73c4a64facSdrh     pColl = sqlite3LocateCollSeq(pParse, zColl);
748b4c40d8Sdrh     if( pColl ){
758b4c40d8Sdrh       pExpr->pColl = pColl;
768b4c40d8Sdrh       pExpr->flags |= EP_ExpCollate;
778b4c40d8Sdrh     }
7839002505Sdanielk1977   }
79633e6d57Sdrh   sqlite3DbFree(db, zColl);
808b4c40d8Sdrh   return pExpr;
818b4c40d8Sdrh }
828b4c40d8Sdrh 
838b4c40d8Sdrh /*
840202b29eSdanielk1977 ** Return the default collation sequence for the expression pExpr. If
850202b29eSdanielk1977 ** there is no default collation type, return 0.
860202b29eSdanielk1977 */
877cedc8d4Sdanielk1977 CollSeq *sqlite3ExprCollSeq(Parse *pParse, Expr *pExpr){
887cedc8d4Sdanielk1977   CollSeq *pColl = 0;
897d10d5a6Sdrh   Expr *p = pExpr;
9051f49f17Sdrh   while( ALWAYS(p) ){
917e09fe0bSdrh     int op;
927d10d5a6Sdrh     pColl = p->pColl;
937d10d5a6Sdrh     if( pColl ) break;
947d10d5a6Sdrh     op = p->op;
95259a455fSdanielk1977     if( (op==TK_AGG_COLUMN || op==TK_COLUMN || op==TK_REGISTER) && p->pTab!=0 ){
967d10d5a6Sdrh       /* op==TK_REGISTER && p->pTab!=0 happens when pExpr was originally
977d10d5a6Sdrh       ** a TK_COLUMN but was previously evaluated and cached in a register */
987d10d5a6Sdrh       const char *zColl;
997d10d5a6Sdrh       int j = p->iColumn;
1007d10d5a6Sdrh       if( j>=0 ){
1017d10d5a6Sdrh         sqlite3 *db = pParse->db;
1027d10d5a6Sdrh         zColl = p->pTab->aCol[j].zColl;
103c4a64facSdrh         pColl = sqlite3FindCollSeq(db, ENC(db), zColl, 0);
1047d10d5a6Sdrh         pExpr->pColl = pColl;
1050202b29eSdanielk1977       }
1067d10d5a6Sdrh       break;
1077d10d5a6Sdrh     }
1087d10d5a6Sdrh     if( op!=TK_CAST && op!=TK_UPLUS ){
1097d10d5a6Sdrh       break;
1107d10d5a6Sdrh     }
1117d10d5a6Sdrh     p = p->pLeft;
1120202b29eSdanielk1977   }
1137cedc8d4Sdanielk1977   if( sqlite3CheckCollSeq(pParse, pColl) ){
1147cedc8d4Sdanielk1977     pColl = 0;
1157cedc8d4Sdanielk1977   }
1167cedc8d4Sdanielk1977   return pColl;
1170202b29eSdanielk1977 }
1180202b29eSdanielk1977 
1190202b29eSdanielk1977 /*
120626a879aSdrh ** pExpr is an operand of a comparison operator.  aff2 is the
121626a879aSdrh ** type affinity of the other operand.  This routine returns the
12253db1458Sdrh ** type affinity that should be used for the comparison operator.
12353db1458Sdrh */
124e014a838Sdanielk1977 char sqlite3CompareAffinity(Expr *pExpr, char aff2){
125bf3b721fSdanielk1977   char aff1 = sqlite3ExprAffinity(pExpr);
126e014a838Sdanielk1977   if( aff1 && aff2 ){
1278df447f0Sdrh     /* Both sides of the comparison are columns. If one has numeric
1288df447f0Sdrh     ** affinity, use that. Otherwise use no affinity.
129e014a838Sdanielk1977     */
1308a51256cSdrh     if( sqlite3IsNumericAffinity(aff1) || sqlite3IsNumericAffinity(aff2) ){
131e014a838Sdanielk1977       return SQLITE_AFF_NUMERIC;
132e014a838Sdanielk1977     }else{
133e014a838Sdanielk1977       return SQLITE_AFF_NONE;
134e014a838Sdanielk1977     }
135e014a838Sdanielk1977   }else if( !aff1 && !aff2 ){
1365f6a87b3Sdrh     /* Neither side of the comparison is a column.  Compare the
1375f6a87b3Sdrh     ** results directly.
138e014a838Sdanielk1977     */
1395f6a87b3Sdrh     return SQLITE_AFF_NONE;
140e014a838Sdanielk1977   }else{
141e014a838Sdanielk1977     /* One side is a column, the other is not. Use the columns affinity. */
142fe05af87Sdrh     assert( aff1==0 || aff2==0 );
143e014a838Sdanielk1977     return (aff1 + aff2);
144e014a838Sdanielk1977   }
145e014a838Sdanielk1977 }
146e014a838Sdanielk1977 
14753db1458Sdrh /*
14853db1458Sdrh ** pExpr is a comparison operator.  Return the type affinity that should
14953db1458Sdrh ** be applied to both operands prior to doing the comparison.
15053db1458Sdrh */
151e014a838Sdanielk1977 static char comparisonAffinity(Expr *pExpr){
152e014a838Sdanielk1977   char aff;
153e014a838Sdanielk1977   assert( pExpr->op==TK_EQ || pExpr->op==TK_IN || pExpr->op==TK_LT ||
154e014a838Sdanielk1977           pExpr->op==TK_GT || pExpr->op==TK_GE || pExpr->op==TK_LE ||
155e014a838Sdanielk1977           pExpr->op==TK_NE );
156e014a838Sdanielk1977   assert( pExpr->pLeft );
157bf3b721fSdanielk1977   aff = sqlite3ExprAffinity(pExpr->pLeft);
158e014a838Sdanielk1977   if( pExpr->pRight ){
159e014a838Sdanielk1977     aff = sqlite3CompareAffinity(pExpr->pRight, aff);
1606ab3a2ecSdanielk1977   }else if( ExprHasProperty(pExpr, EP_xIsSelect) ){
1616ab3a2ecSdanielk1977     aff = sqlite3CompareAffinity(pExpr->x.pSelect->pEList->a[0].pExpr, aff);
1626ab3a2ecSdanielk1977   }else if( !aff ){
163de087bd5Sdrh     aff = SQLITE_AFF_NONE;
164e014a838Sdanielk1977   }
165e014a838Sdanielk1977   return aff;
166e014a838Sdanielk1977 }
167e014a838Sdanielk1977 
168e014a838Sdanielk1977 /*
169e014a838Sdanielk1977 ** pExpr is a comparison expression, eg. '=', '<', IN(...) etc.
170e014a838Sdanielk1977 ** idx_affinity is the affinity of an indexed column. Return true
171e014a838Sdanielk1977 ** if the index with affinity idx_affinity may be used to implement
172e014a838Sdanielk1977 ** the comparison in pExpr.
173e014a838Sdanielk1977 */
174e014a838Sdanielk1977 int sqlite3IndexAffinityOk(Expr *pExpr, char idx_affinity){
175e014a838Sdanielk1977   char aff = comparisonAffinity(pExpr);
1768a51256cSdrh   switch( aff ){
1778a51256cSdrh     case SQLITE_AFF_NONE:
1788a51256cSdrh       return 1;
1798a51256cSdrh     case SQLITE_AFF_TEXT:
1808a51256cSdrh       return idx_affinity==SQLITE_AFF_TEXT;
1818a51256cSdrh     default:
1828a51256cSdrh       return sqlite3IsNumericAffinity(idx_affinity);
1838a51256cSdrh   }
184e014a838Sdanielk1977 }
185e014a838Sdanielk1977 
186a37cdde0Sdanielk1977 /*
18735573356Sdrh ** Return the P5 value that should be used for a binary comparison
188a37cdde0Sdanielk1977 ** opcode (OP_Eq, OP_Ge etc.) used to compare pExpr1 and pExpr2.
189a37cdde0Sdanielk1977 */
19035573356Sdrh static u8 binaryCompareP5(Expr *pExpr1, Expr *pExpr2, int jumpIfNull){
19135573356Sdrh   u8 aff = (char)sqlite3ExprAffinity(pExpr2);
1921bd10f8aSdrh   aff = (u8)sqlite3CompareAffinity(pExpr1, aff) | (u8)jumpIfNull;
19335573356Sdrh   return aff;
194a37cdde0Sdanielk1977 }
195a37cdde0Sdanielk1977 
196a2e00042Sdrh /*
1970202b29eSdanielk1977 ** Return a pointer to the collation sequence that should be used by
1980202b29eSdanielk1977 ** a binary comparison operator comparing pLeft and pRight.
1990202b29eSdanielk1977 **
2000202b29eSdanielk1977 ** If the left hand expression has a collating sequence type, then it is
2010202b29eSdanielk1977 ** used. Otherwise the collation sequence for the right hand expression
2020202b29eSdanielk1977 ** is used, or the default (BINARY) if neither expression has a collating
2030202b29eSdanielk1977 ** type.
204bcbb04e5Sdanielk1977 **
205bcbb04e5Sdanielk1977 ** Argument pRight (but not pLeft) may be a null pointer. In this case,
206bcbb04e5Sdanielk1977 ** it is not considered.
2070202b29eSdanielk1977 */
208bcbb04e5Sdanielk1977 CollSeq *sqlite3BinaryCompareCollSeq(
209bcbb04e5Sdanielk1977   Parse *pParse,
210bcbb04e5Sdanielk1977   Expr *pLeft,
211bcbb04e5Sdanielk1977   Expr *pRight
212bcbb04e5Sdanielk1977 ){
213ec41ddacSdrh   CollSeq *pColl;
214ec41ddacSdrh   assert( pLeft );
215ec41ddacSdrh   if( pLeft->flags & EP_ExpCollate ){
216ec41ddacSdrh     assert( pLeft->pColl );
217ec41ddacSdrh     pColl = pLeft->pColl;
218bcbb04e5Sdanielk1977   }else if( pRight && pRight->flags & EP_ExpCollate ){
219ec41ddacSdrh     assert( pRight->pColl );
220ec41ddacSdrh     pColl = pRight->pColl;
221ec41ddacSdrh   }else{
222ec41ddacSdrh     pColl = sqlite3ExprCollSeq(pParse, pLeft);
2230202b29eSdanielk1977     if( !pColl ){
2247cedc8d4Sdanielk1977       pColl = sqlite3ExprCollSeq(pParse, pRight);
2250202b29eSdanielk1977     }
226ec41ddacSdrh   }
2270202b29eSdanielk1977   return pColl;
2280202b29eSdanielk1977 }
2290202b29eSdanielk1977 
2300202b29eSdanielk1977 /*
231da250ea5Sdrh ** Generate the operands for a comparison operation.  Before
232da250ea5Sdrh ** generating the code for each operand, set the EP_AnyAff
233da250ea5Sdrh ** flag on the expression so that it will be able to used a
234da250ea5Sdrh ** cached column value that has previously undergone an
235da250ea5Sdrh ** affinity change.
236da250ea5Sdrh */
237da250ea5Sdrh static void codeCompareOperands(
238da250ea5Sdrh   Parse *pParse,    /* Parsing and code generating context */
239da250ea5Sdrh   Expr *pLeft,      /* The left operand */
240da250ea5Sdrh   int *pRegLeft,    /* Register where left operand is stored */
241da250ea5Sdrh   int *pFreeLeft,   /* Free this register when done */
242da250ea5Sdrh   Expr *pRight,     /* The right operand */
243da250ea5Sdrh   int *pRegRight,   /* Register where right operand is stored */
244da250ea5Sdrh   int *pFreeRight   /* Write temp register for right operand there */
245da250ea5Sdrh ){
246da250ea5Sdrh   while( pLeft->op==TK_UPLUS ) pLeft = pLeft->pLeft;
247da250ea5Sdrh   pLeft->flags |= EP_AnyAff;
248da250ea5Sdrh   *pRegLeft = sqlite3ExprCodeTemp(pParse, pLeft, pFreeLeft);
249da250ea5Sdrh   while( pRight->op==TK_UPLUS ) pRight = pRight->pLeft;
250da250ea5Sdrh   pRight->flags |= EP_AnyAff;
251da250ea5Sdrh   *pRegRight = sqlite3ExprCodeTemp(pParse, pRight, pFreeRight);
252da250ea5Sdrh }
253da250ea5Sdrh 
254da250ea5Sdrh /*
255be5c89acSdrh ** Generate code for a comparison operator.
256be5c89acSdrh */
257be5c89acSdrh static int codeCompare(
258be5c89acSdrh   Parse *pParse,    /* The parsing (and code generating) context */
259be5c89acSdrh   Expr *pLeft,      /* The left operand */
260be5c89acSdrh   Expr *pRight,     /* The right operand */
261be5c89acSdrh   int opcode,       /* The comparison opcode */
26235573356Sdrh   int in1, int in2, /* Register holding operands */
263be5c89acSdrh   int dest,         /* Jump here if true.  */
264be5c89acSdrh   int jumpIfNull    /* If true, jump if either operand is NULL */
265be5c89acSdrh ){
26635573356Sdrh   int p5;
26735573356Sdrh   int addr;
26835573356Sdrh   CollSeq *p4;
26935573356Sdrh 
27035573356Sdrh   p4 = sqlite3BinaryCompareCollSeq(pParse, pLeft, pRight);
27135573356Sdrh   p5 = binaryCompareP5(pLeft, pRight, jumpIfNull);
27235573356Sdrh   addr = sqlite3VdbeAddOp4(pParse->pVdbe, opcode, in2, dest, in1,
27335573356Sdrh                            (void*)p4, P4_COLLSEQ);
2741bd10f8aSdrh   sqlite3VdbeChangeP5(pParse->pVdbe, (u8)p5);
275e49b146fSdrh   if( (p5 & SQLITE_AFF_MASK)!=SQLITE_AFF_NONE ){
276da250ea5Sdrh     sqlite3ExprCacheAffinityChange(pParse, in1, 1);
277da250ea5Sdrh     sqlite3ExprCacheAffinityChange(pParse, in2, 1);
2782f7794c1Sdrh   }
27935573356Sdrh   return addr;
280be5c89acSdrh }
281be5c89acSdrh 
2824b5255acSdanielk1977 #if SQLITE_MAX_EXPR_DEPTH>0
2834b5255acSdanielk1977 /*
2844b5255acSdanielk1977 ** Check that argument nHeight is less than or equal to the maximum
2854b5255acSdanielk1977 ** expression depth allowed. If it is not, leave an error message in
2864b5255acSdanielk1977 ** pParse.
2874b5255acSdanielk1977 */
2887d10d5a6Sdrh int sqlite3ExprCheckHeight(Parse *pParse, int nHeight){
2894b5255acSdanielk1977   int rc = SQLITE_OK;
2904b5255acSdanielk1977   int mxHeight = pParse->db->aLimit[SQLITE_LIMIT_EXPR_DEPTH];
2914b5255acSdanielk1977   if( nHeight>mxHeight ){
2924b5255acSdanielk1977     sqlite3ErrorMsg(pParse,
2934b5255acSdanielk1977        "Expression tree is too large (maximum depth %d)", mxHeight
2944b5255acSdanielk1977     );
2954b5255acSdanielk1977     rc = SQLITE_ERROR;
2964b5255acSdanielk1977   }
2974b5255acSdanielk1977   return rc;
2984b5255acSdanielk1977 }
2994b5255acSdanielk1977 
3004b5255acSdanielk1977 /* The following three functions, heightOfExpr(), heightOfExprList()
3014b5255acSdanielk1977 ** and heightOfSelect(), are used to determine the maximum height
3024b5255acSdanielk1977 ** of any expression tree referenced by the structure passed as the
3034b5255acSdanielk1977 ** first argument.
3044b5255acSdanielk1977 **
3054b5255acSdanielk1977 ** If this maximum height is greater than the current value pointed
3064b5255acSdanielk1977 ** to by pnHeight, the second parameter, then set *pnHeight to that
3074b5255acSdanielk1977 ** value.
3084b5255acSdanielk1977 */
3094b5255acSdanielk1977 static void heightOfExpr(Expr *p, int *pnHeight){
3104b5255acSdanielk1977   if( p ){
3114b5255acSdanielk1977     if( p->nHeight>*pnHeight ){
3124b5255acSdanielk1977       *pnHeight = p->nHeight;
3134b5255acSdanielk1977     }
3144b5255acSdanielk1977   }
3154b5255acSdanielk1977 }
3164b5255acSdanielk1977 static void heightOfExprList(ExprList *p, int *pnHeight){
3174b5255acSdanielk1977   if( p ){
3184b5255acSdanielk1977     int i;
3194b5255acSdanielk1977     for(i=0; i<p->nExpr; i++){
3204b5255acSdanielk1977       heightOfExpr(p->a[i].pExpr, pnHeight);
3214b5255acSdanielk1977     }
3224b5255acSdanielk1977   }
3234b5255acSdanielk1977 }
3244b5255acSdanielk1977 static void heightOfSelect(Select *p, int *pnHeight){
3254b5255acSdanielk1977   if( p ){
3264b5255acSdanielk1977     heightOfExpr(p->pWhere, pnHeight);
3274b5255acSdanielk1977     heightOfExpr(p->pHaving, pnHeight);
3284b5255acSdanielk1977     heightOfExpr(p->pLimit, pnHeight);
3294b5255acSdanielk1977     heightOfExpr(p->pOffset, pnHeight);
3304b5255acSdanielk1977     heightOfExprList(p->pEList, pnHeight);
3314b5255acSdanielk1977     heightOfExprList(p->pGroupBy, pnHeight);
3324b5255acSdanielk1977     heightOfExprList(p->pOrderBy, pnHeight);
3334b5255acSdanielk1977     heightOfSelect(p->pPrior, pnHeight);
3344b5255acSdanielk1977   }
3354b5255acSdanielk1977 }
3364b5255acSdanielk1977 
3374b5255acSdanielk1977 /*
3384b5255acSdanielk1977 ** Set the Expr.nHeight variable in the structure passed as an
3394b5255acSdanielk1977 ** argument. An expression with no children, Expr.pList or
3404b5255acSdanielk1977 ** Expr.pSelect member has a height of 1. Any other expression
3414b5255acSdanielk1977 ** has a height equal to the maximum height of any other
3424b5255acSdanielk1977 ** referenced Expr plus one.
3434b5255acSdanielk1977 */
3444b5255acSdanielk1977 static void exprSetHeight(Expr *p){
3454b5255acSdanielk1977   int nHeight = 0;
3464b5255acSdanielk1977   heightOfExpr(p->pLeft, &nHeight);
3474b5255acSdanielk1977   heightOfExpr(p->pRight, &nHeight);
3486ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_xIsSelect) ){
3496ab3a2ecSdanielk1977     heightOfSelect(p->x.pSelect, &nHeight);
3506ab3a2ecSdanielk1977   }else{
3516ab3a2ecSdanielk1977     heightOfExprList(p->x.pList, &nHeight);
3526ab3a2ecSdanielk1977   }
3534b5255acSdanielk1977   p->nHeight = nHeight + 1;
3544b5255acSdanielk1977 }
3554b5255acSdanielk1977 
3564b5255acSdanielk1977 /*
3574b5255acSdanielk1977 ** Set the Expr.nHeight variable using the exprSetHeight() function. If
3584b5255acSdanielk1977 ** the height is greater than the maximum allowed expression depth,
3594b5255acSdanielk1977 ** leave an error in pParse.
3604b5255acSdanielk1977 */
3614b5255acSdanielk1977 void sqlite3ExprSetHeight(Parse *pParse, Expr *p){
3624b5255acSdanielk1977   exprSetHeight(p);
3637d10d5a6Sdrh   sqlite3ExprCheckHeight(pParse, p->nHeight);
3644b5255acSdanielk1977 }
3654b5255acSdanielk1977 
3664b5255acSdanielk1977 /*
3674b5255acSdanielk1977 ** Return the maximum height of any expression tree referenced
3684b5255acSdanielk1977 ** by the select statement passed as an argument.
3694b5255acSdanielk1977 */
3704b5255acSdanielk1977 int sqlite3SelectExprHeight(Select *p){
3714b5255acSdanielk1977   int nHeight = 0;
3724b5255acSdanielk1977   heightOfSelect(p, &nHeight);
3734b5255acSdanielk1977   return nHeight;
3744b5255acSdanielk1977 }
3754b5255acSdanielk1977 #else
3764b5255acSdanielk1977   #define exprSetHeight(y)
3774b5255acSdanielk1977 #endif /* SQLITE_MAX_EXPR_DEPTH>0 */
3784b5255acSdanielk1977 
379be5c89acSdrh /*
380b7916a78Sdrh ** This routine is the core allocator for Expr nodes.
381b7916a78Sdrh **
382a76b5dfcSdrh ** Construct a new expression node and return a pointer to it.  Memory
383b7916a78Sdrh ** for this node and for the pToken argument is a single allocation
384b7916a78Sdrh ** obtained from sqlite3DbMalloc().  The calling function
385a76b5dfcSdrh ** is responsible for making sure the node eventually gets freed.
386b7916a78Sdrh **
387b7916a78Sdrh ** If dequote is true, then the token (if it exists) is dequoted.
388b7916a78Sdrh ** If dequote is false, no dequoting is performance.  The deQuote
389b7916a78Sdrh ** parameter is ignored if pToken is NULL or if the token does not
390b7916a78Sdrh ** appear to be quoted.  If the quotes were of the form "..." (double-quotes)
391b7916a78Sdrh ** then the EP_DblQuoted flag is set on the expression node.
392*33e619fcSdrh **
393*33e619fcSdrh ** Special case:  If op==TK_INTEGER and pToken points to a string that
394*33e619fcSdrh ** can be translated into a 32-bit integer, then the token is not
395*33e619fcSdrh ** stored in u.zToken.  Instead, the integer values is written
396*33e619fcSdrh ** into u.iValue and the EP_IntValue flag is set.  No extra storage
397*33e619fcSdrh ** is allocated to hold the integer text and the dequote flag is ignored.
398a76b5dfcSdrh */
399b7916a78Sdrh Expr *sqlite3ExprAlloc(
400a1644fd8Sdanielk1977   sqlite3 *db,            /* Handle for sqlite3DbMallocZero() (may be null) */
40117435752Sdrh   int op,                 /* Expression opcode */
402b7916a78Sdrh   const Token *pToken,    /* Token argument.  Might be NULL */
403b7916a78Sdrh   int dequote             /* True to dequote */
40417435752Sdrh ){
405a76b5dfcSdrh   Expr *pNew;
406*33e619fcSdrh   int nExtra = 0;
407*33e619fcSdrh   int iValue;
408b7916a78Sdrh 
409b7916a78Sdrh   if( pToken ){
410*33e619fcSdrh     if( op!=TK_INTEGER || pToken->z==0
411*33e619fcSdrh           || sqlite3GetInt32(pToken->z, &iValue)==0 ){
412b7916a78Sdrh       nExtra = pToken->n+1;
413*33e619fcSdrh     }
414a76b5dfcSdrh   }
415b7916a78Sdrh   pNew = sqlite3DbMallocZero(db, sizeof(Expr)+nExtra);
416b7916a78Sdrh   if( pNew ){
4171bd10f8aSdrh     pNew->op = (u8)op;
418a58fdfb1Sdanielk1977     pNew->iAgg = -1;
419a76b5dfcSdrh     if( pToken ){
420*33e619fcSdrh       if( nExtra==0 ){
421*33e619fcSdrh         pNew->flags |= EP_IntValue;
422*33e619fcSdrh         pNew->u.iValue = iValue;
423*33e619fcSdrh       }else{
424d9da78a2Sdrh         int c;
425*33e619fcSdrh         pNew->u.zToken = (char*)&pNew[1];
426*33e619fcSdrh         memcpy(pNew->u.zToken, pToken->z, pToken->n);
427*33e619fcSdrh         pNew->u.zToken[pToken->n] = 0;
428b7916a78Sdrh         if( dequote && nExtra>=3
429d9da78a2Sdrh              && ((c = pToken->z[0])=='\'' || c=='"' || c=='[' || c=='`') ){
430*33e619fcSdrh           sqlite3Dequote(pNew->u.zToken);
43124fb627aSdrh           if( c=='"' ) pNew->flags |= EP_DblQuoted;
432a34001c9Sdrh         }
433a34001c9Sdrh       }
434*33e619fcSdrh     }
435b7916a78Sdrh #if SQLITE_MAX_EXPR_DEPTH>0
436b7916a78Sdrh     pNew->nHeight = 1;
437b7916a78Sdrh #endif
438a34001c9Sdrh   }
439a76b5dfcSdrh   return pNew;
440a76b5dfcSdrh }
441a76b5dfcSdrh 
442a76b5dfcSdrh /*
443b7916a78Sdrh ** Allocate a new expression node from a zero-terminated token that has
444b7916a78Sdrh ** already been dequoted.
445b7916a78Sdrh */
446b7916a78Sdrh Expr *sqlite3Expr(
447b7916a78Sdrh   sqlite3 *db,            /* Handle for sqlite3DbMallocZero() (may be null) */
448b7916a78Sdrh   int op,                 /* Expression opcode */
449b7916a78Sdrh   const char *zToken      /* Token argument.  Might be NULL */
450b7916a78Sdrh ){
451b7916a78Sdrh   Token x;
452b7916a78Sdrh   x.z = zToken;
453b7916a78Sdrh   x.n = zToken ? sqlite3Strlen30(zToken) : 0;
454b7916a78Sdrh   return sqlite3ExprAlloc(db, op, &x, 0);
455b7916a78Sdrh }
456b7916a78Sdrh 
457b7916a78Sdrh /*
458b7916a78Sdrh ** Attach subtrees pLeft and pRight to the Expr node pRoot.
459b7916a78Sdrh **
460b7916a78Sdrh ** If pRoot==NULL that means that a memory allocation error has occurred.
461b7916a78Sdrh ** In that case, delete the subtrees pLeft and pRight.
462b7916a78Sdrh */
463b7916a78Sdrh void sqlite3ExprAttachSubtrees(
464b7916a78Sdrh   sqlite3 *db,
465b7916a78Sdrh   Expr *pRoot,
466b7916a78Sdrh   Expr *pLeft,
467b7916a78Sdrh   Expr *pRight
468b7916a78Sdrh ){
469b7916a78Sdrh   if( pRoot==0 ){
470b7916a78Sdrh     assert( db->mallocFailed );
471b7916a78Sdrh     sqlite3ExprDelete(db, pLeft);
472b7916a78Sdrh     sqlite3ExprDelete(db, pRight);
473b7916a78Sdrh   }else{
474b7916a78Sdrh     if( pRight ){
475b7916a78Sdrh       pRoot->pRight = pRight;
476b7916a78Sdrh       if( pRight->flags & EP_ExpCollate ){
477b7916a78Sdrh         pRoot->flags |= EP_ExpCollate;
478b7916a78Sdrh         pRoot->pColl = pRight->pColl;
479b7916a78Sdrh       }
480b7916a78Sdrh     }
481b7916a78Sdrh     if( pLeft ){
482b7916a78Sdrh       pRoot->pLeft = pLeft;
483b7916a78Sdrh       if( pLeft->flags & EP_ExpCollate ){
484b7916a78Sdrh         pRoot->flags |= EP_ExpCollate;
485b7916a78Sdrh         pRoot->pColl = pLeft->pColl;
486b7916a78Sdrh       }
487b7916a78Sdrh     }
488b7916a78Sdrh     exprSetHeight(pRoot);
489b7916a78Sdrh   }
490b7916a78Sdrh }
491b7916a78Sdrh 
492b7916a78Sdrh /*
493b7916a78Sdrh ** Allocate a Expr node which joins up to two subtrees.
494b7916a78Sdrh **
495b7916a78Sdrh ** The
49617435752Sdrh ** Works like sqlite3Expr() except that it takes an extra Parse*
49717435752Sdrh ** argument and notifies the associated connection object if malloc fails.
498206f3d96Sdrh */
49917435752Sdrh Expr *sqlite3PExpr(
50017435752Sdrh   Parse *pParse,          /* Parsing context */
50117435752Sdrh   int op,                 /* Expression opcode */
50217435752Sdrh   Expr *pLeft,            /* Left operand */
50317435752Sdrh   Expr *pRight,           /* Right operand */
50417435752Sdrh   const Token *pToken     /* Argument token */
50517435752Sdrh ){
506b7916a78Sdrh   Expr *p = sqlite3ExprAlloc(pParse->db, op, pToken, 1);
507b7916a78Sdrh   sqlite3ExprAttachSubtrees(pParse->db, p, pLeft, pRight);
5084e0cff60Sdrh   return p;
5094e0cff60Sdrh }
5104e0cff60Sdrh 
5114e0cff60Sdrh /*
51291bb0eedSdrh ** Join two expressions using an AND operator.  If either expression is
51391bb0eedSdrh ** NULL, then just return the other expression.
51491bb0eedSdrh */
5151e536953Sdanielk1977 Expr *sqlite3ExprAnd(sqlite3 *db, Expr *pLeft, Expr *pRight){
51691bb0eedSdrh   if( pLeft==0 ){
51791bb0eedSdrh     return pRight;
51891bb0eedSdrh   }else if( pRight==0 ){
51991bb0eedSdrh     return pLeft;
52091bb0eedSdrh   }else{
521b7916a78Sdrh     Expr *pNew = sqlite3ExprAlloc(db, TK_AND, 0, 0);
522b7916a78Sdrh     sqlite3ExprAttachSubtrees(db, pNew, pLeft, pRight);
523b7916a78Sdrh     return pNew;
524a76b5dfcSdrh   }
525a76b5dfcSdrh }
526a76b5dfcSdrh 
527a76b5dfcSdrh /*
528a76b5dfcSdrh ** Construct a new expression node for a function with multiple
529a76b5dfcSdrh ** arguments.
530a76b5dfcSdrh */
53117435752Sdrh Expr *sqlite3ExprFunction(Parse *pParse, ExprList *pList, Token *pToken){
532a76b5dfcSdrh   Expr *pNew;
533633e6d57Sdrh   sqlite3 *db = pParse->db;
5344b202ae2Sdanielk1977   assert( pToken );
535b7916a78Sdrh   pNew = sqlite3ExprAlloc(db, TK_FUNCTION, pToken, 1);
536a76b5dfcSdrh   if( pNew==0 ){
537d9da78a2Sdrh     sqlite3ExprListDelete(db, pList); /* Avoid memory leak when malloc fails */
538a76b5dfcSdrh     return 0;
539a76b5dfcSdrh   }
5406ab3a2ecSdanielk1977   pNew->x.pList = pList;
5416ab3a2ecSdanielk1977   assert( !ExprHasProperty(pNew, EP_xIsSelect) );
5424b5255acSdanielk1977   sqlite3ExprSetHeight(pParse, pNew);
543a76b5dfcSdrh   return pNew;
544a76b5dfcSdrh }
545a76b5dfcSdrh 
546a76b5dfcSdrh /*
547fa6bc000Sdrh ** Assign a variable number to an expression that encodes a wildcard
548fa6bc000Sdrh ** in the original SQL statement.
549fa6bc000Sdrh **
550fa6bc000Sdrh ** Wildcards consisting of a single "?" are assigned the next sequential
551fa6bc000Sdrh ** variable number.
552fa6bc000Sdrh **
553fa6bc000Sdrh ** Wildcards of the form "?nnn" are assigned the number "nnn".  We make
554fa6bc000Sdrh ** sure "nnn" is not too be to avoid a denial of service attack when
555fa6bc000Sdrh ** the SQL statement comes from an external source.
556fa6bc000Sdrh **
55751f49f17Sdrh ** Wildcards of the form ":aaa", "@aaa", or "$aaa" are assigned the same number
558fa6bc000Sdrh ** as the previous instance of the same wildcard.  Or if this is the first
559fa6bc000Sdrh ** instance of the wildcard, the next sequenial variable number is
560fa6bc000Sdrh ** assigned.
561fa6bc000Sdrh */
562fa6bc000Sdrh void sqlite3ExprAssignVarNumber(Parse *pParse, Expr *pExpr){
56317435752Sdrh   sqlite3 *db = pParse->db;
564b7916a78Sdrh   const char *z;
56517435752Sdrh 
566fa6bc000Sdrh   if( pExpr==0 ) return;
567*33e619fcSdrh   assert( !ExprHasAnyProperty(pExpr, EP_IntValue|EP_Reduced|EP_TokenOnly) );
568*33e619fcSdrh   z = pExpr->u.zToken;
569b7916a78Sdrh   assert( z!=0 );
570b7916a78Sdrh   assert( z[0]!=0 );
571b7916a78Sdrh   if( z[1]==0 ){
572fa6bc000Sdrh     /* Wildcard of the form "?".  Assign the next variable number */
573b7916a78Sdrh     assert( z[0]=='?' );
574fa6bc000Sdrh     pExpr->iTable = ++pParse->nVar;
575b7916a78Sdrh   }else if( z[0]=='?' ){
576fa6bc000Sdrh     /* Wildcard of the form "?nnn".  Convert "nnn" to an integer and
577fa6bc000Sdrh     ** use it as the variable number */
578fa6bc000Sdrh     int i;
579b7916a78Sdrh     pExpr->iTable = i = atoi((char*)&z[1]);
580c5499befSdrh     testcase( i==0 );
581c5499befSdrh     testcase( i==1 );
582c5499befSdrh     testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]-1 );
583c5499befSdrh     testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] );
584bb4957f8Sdrh     if( i<1 || i>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
585fa6bc000Sdrh       sqlite3ErrorMsg(pParse, "variable number must be between ?1 and ?%d",
586bb4957f8Sdrh           db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]);
587fa6bc000Sdrh     }
588fa6bc000Sdrh     if( i>pParse->nVar ){
589fa6bc000Sdrh       pParse->nVar = i;
590fa6bc000Sdrh     }
591fa6bc000Sdrh   }else{
59251f49f17Sdrh     /* Wildcards like ":aaa", "$aaa" or "@aaa".  Reuse the same variable
593fa6bc000Sdrh     ** number as the prior appearance of the same name, or if the name
594fa6bc000Sdrh     ** has never appeared before, reuse the same variable number
595fa6bc000Sdrh     */
5961bd10f8aSdrh     int i;
5971bd10f8aSdrh     u32 n;
598b7916a78Sdrh     n = sqlite3Strlen30(z);
599fa6bc000Sdrh     for(i=0; i<pParse->nVarExpr; i++){
60051f49f17Sdrh       Expr *pE = pParse->apVarExpr[i];
60151f49f17Sdrh       assert( pE!=0 );
602*33e619fcSdrh       if( memcmp(pE->u.zToken, z, n)==0 && pE->u.zToken[n]==0 ){
603fa6bc000Sdrh         pExpr->iTable = pE->iTable;
604fa6bc000Sdrh         break;
605fa6bc000Sdrh       }
606fa6bc000Sdrh     }
607fa6bc000Sdrh     if( i>=pParse->nVarExpr ){
608fa6bc000Sdrh       pExpr->iTable = ++pParse->nVar;
609fa6bc000Sdrh       if( pParse->nVarExpr>=pParse->nVarExprAlloc-1 ){
610fa6bc000Sdrh         pParse->nVarExprAlloc += pParse->nVarExprAlloc + 10;
61117435752Sdrh         pParse->apVarExpr =
61217435752Sdrh             sqlite3DbReallocOrFree(
61317435752Sdrh               db,
61417435752Sdrh               pParse->apVarExpr,
61517435752Sdrh               pParse->nVarExprAlloc*sizeof(pParse->apVarExpr[0])
61617435752Sdrh             );
617fa6bc000Sdrh       }
61817435752Sdrh       if( !db->mallocFailed ){
619fa6bc000Sdrh         assert( pParse->apVarExpr!=0 );
620fa6bc000Sdrh         pParse->apVarExpr[pParse->nVarExpr++] = pExpr;
621fa6bc000Sdrh       }
622fa6bc000Sdrh     }
623fa6bc000Sdrh   }
624bb4957f8Sdrh   if( !pParse->nErr && pParse->nVar>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
625832b2664Sdanielk1977     sqlite3ErrorMsg(pParse, "too many SQL variables");
626832b2664Sdanielk1977   }
627fa6bc000Sdrh }
628fa6bc000Sdrh 
629fa6bc000Sdrh /*
63010fe840eSdrh ** Clear an expression structure without deleting the structure itself.
63110fe840eSdrh ** Substructure is deleted.
632a2e00042Sdrh */
63310fe840eSdrh void sqlite3ExprClear(sqlite3 *db, Expr *p){
634*33e619fcSdrh   assert( p!=0 );
635b7916a78Sdrh   if( !ExprHasAnyProperty(p, EP_TokenOnly) ){
636633e6d57Sdrh     sqlite3ExprDelete(db, p->pLeft);
637633e6d57Sdrh     sqlite3ExprDelete(db, p->pRight);
638*33e619fcSdrh     if( !ExprHasProperty(p, EP_Reduced) && (p->flags2 & EP2_MallocedToken)!=0 ){
639*33e619fcSdrh       sqlite3DbFree(db, p->u.zToken);
6406ab3a2ecSdanielk1977     }
6416ab3a2ecSdanielk1977     if( ExprHasProperty(p, EP_xIsSelect) ){
6426ab3a2ecSdanielk1977       sqlite3SelectDelete(db, p->x.pSelect);
6436ab3a2ecSdanielk1977     }else{
6446ab3a2ecSdanielk1977       sqlite3ExprListDelete(db, p->x.pList);
6456ab3a2ecSdanielk1977     }
6466ab3a2ecSdanielk1977   }
64710fe840eSdrh }
64810fe840eSdrh 
64910fe840eSdrh /*
65010fe840eSdrh ** Recursively delete an expression tree.
65110fe840eSdrh */
65210fe840eSdrh void sqlite3ExprDelete(sqlite3 *db, Expr *p){
65310fe840eSdrh   if( p==0 ) return;
65410fe840eSdrh   sqlite3ExprClear(db, p);
655*33e619fcSdrh   if( !ExprHasProperty(p, EP_Static) ){
656633e6d57Sdrh     sqlite3DbFree(db, p);
657a2e00042Sdrh   }
658*33e619fcSdrh }
659a2e00042Sdrh 
660d2687b77Sdrh /*
6616ab3a2ecSdanielk1977 ** Return the number of bytes allocated for the expression structure
6626ab3a2ecSdanielk1977 ** passed as the first argument. This is always one of EXPR_FULLSIZE,
6636ab3a2ecSdanielk1977 ** EXPR_REDUCEDSIZE or EXPR_TOKENONLYSIZE.
6646ab3a2ecSdanielk1977 */
6656ab3a2ecSdanielk1977 static int exprStructSize(Expr *p){
6666ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_TokenOnly) ) return EXPR_TOKENONLYSIZE;
6676ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_Reduced) ) return EXPR_REDUCEDSIZE;
6686ab3a2ecSdanielk1977   return EXPR_FULLSIZE;
6696ab3a2ecSdanielk1977 }
6706ab3a2ecSdanielk1977 
6716ab3a2ecSdanielk1977 /*
672*33e619fcSdrh ** The dupedExpr*Size() routines each return the number of bytes required
673*33e619fcSdrh ** to store a copy of an expression or expression tree.  They differ in
674*33e619fcSdrh ** how much of the tree is measured.
675*33e619fcSdrh **
676*33e619fcSdrh **     dupedExprStructSize()     Size of only the Expr structure
677*33e619fcSdrh **     dupedExprNodeSize()       Size of Expr + space for token
678*33e619fcSdrh **     dupedExprSize()           Expr + token + subtree components
679*33e619fcSdrh **
680*33e619fcSdrh ***************************************************************************
681*33e619fcSdrh **
682*33e619fcSdrh ** The dupedExprStructSize() function returns two values OR-ed together:
683*33e619fcSdrh ** (1) the space required for a copy of the Expr structure only and
684*33e619fcSdrh ** (2) the EP_xxx flags that indicate what the structure size should be.
685*33e619fcSdrh ** The return values is always one of:
686*33e619fcSdrh **
687*33e619fcSdrh **      EXPR_FULLSIZE
688*33e619fcSdrh **      EXPR_REDUCEDSIZE   | EP_Reduced
689*33e619fcSdrh **      EXPR_TOKENONLYSIZE | EP_TokenOnly
690*33e619fcSdrh **
691*33e619fcSdrh ** The size of the structure can be found by masking the return value
692*33e619fcSdrh ** of this routine with 0xfff.  The flags can be found by masking the
693*33e619fcSdrh ** return value with EP_Reduced|EP_TokenOnly.
694*33e619fcSdrh **
695*33e619fcSdrh ** Note that with flags==EXPRDUP_REDUCE, this routines works on full-size
696*33e619fcSdrh ** (unreduced) Expr objects as they or originally constructed by the parser.
697*33e619fcSdrh ** During expression analysis, extra information is computed and moved into
698*33e619fcSdrh ** later parts of teh Expr object and that extra information might get chopped
699*33e619fcSdrh ** off if the expression is reduced.  Note also that it does not work to
700*33e619fcSdrh ** make a EXPRDUP_REDUCE copy of a reduced expression.  It is only legal
701*33e619fcSdrh ** to reduce a pristine expression tree from the parser.  The implementation
702*33e619fcSdrh ** of dupedExprStructSize() contain multiple assert() statements that attempt
703*33e619fcSdrh ** to enforce this constraint.
7046ab3a2ecSdanielk1977 */
7056ab3a2ecSdanielk1977 static int dupedExprStructSize(Expr *p, int flags){
7066ab3a2ecSdanielk1977   int nSize;
707*33e619fcSdrh   assert( flags==EXPRDUP_REDUCE || flags==0 ); /* Only one flag value allowed */
7086ab3a2ecSdanielk1977   if( 0==(flags&EXPRDUP_REDUCE) ){
7096ab3a2ecSdanielk1977     nSize = EXPR_FULLSIZE;
7106ab3a2ecSdanielk1977   }else{
711*33e619fcSdrh     assert( !ExprHasAnyProperty(p, EP_TokenOnly|EP_Reduced) );
712*33e619fcSdrh     assert( !ExprHasProperty(p, EP_FromJoin) );
713*33e619fcSdrh     assert( (p->flags2 & EP2_MallocedToken)==0 );
714*33e619fcSdrh     assert( (p->flags2 & EP2_Irreducible)==0 );
715*33e619fcSdrh     if( p->pLeft || p->pRight || p->pColl || p->x.pList ){
716*33e619fcSdrh       nSize = EXPR_REDUCEDSIZE | EP_Reduced;
717*33e619fcSdrh     }else{
718*33e619fcSdrh       nSize = EXPR_TOKENONLYSIZE | EP_TokenOnly;
719*33e619fcSdrh     }
7206ab3a2ecSdanielk1977   }
7216ab3a2ecSdanielk1977   return nSize;
7226ab3a2ecSdanielk1977 }
7236ab3a2ecSdanielk1977 
7246ab3a2ecSdanielk1977 /*
725*33e619fcSdrh ** This function returns the space in bytes required to store the copy
726*33e619fcSdrh ** of the Expr structure and a copy of the Expr.u.zToken string (if that
727*33e619fcSdrh ** string is defined.)
7286ab3a2ecSdanielk1977 */
7296ab3a2ecSdanielk1977 static int dupedExprNodeSize(Expr *p, int flags){
730*33e619fcSdrh   int nByte = dupedExprStructSize(p, flags) & 0xfff;
731*33e619fcSdrh   if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
732*33e619fcSdrh     nByte += sqlite3Strlen30(p->u.zToken)+1;
7336ab3a2ecSdanielk1977   }
734bc73971dSdanielk1977   return ROUND8(nByte);
7356ab3a2ecSdanielk1977 }
7366ab3a2ecSdanielk1977 
7376ab3a2ecSdanielk1977 /*
7386ab3a2ecSdanielk1977 ** Return the number of bytes required to create a duplicate of the
7396ab3a2ecSdanielk1977 ** expression passed as the first argument. The second argument is a
7406ab3a2ecSdanielk1977 ** mask containing EXPRDUP_XXX flags.
7416ab3a2ecSdanielk1977 **
7426ab3a2ecSdanielk1977 ** The value returned includes space to create a copy of the Expr struct
743*33e619fcSdrh ** itself and the buffer referred to by Expr.u.zToken, if any.
7446ab3a2ecSdanielk1977 **
7456ab3a2ecSdanielk1977 ** If the EXPRDUP_REDUCE flag is set, then the return value includes
7466ab3a2ecSdanielk1977 ** space to duplicate all Expr nodes in the tree formed by Expr.pLeft
7476ab3a2ecSdanielk1977 ** and Expr.pRight variables (but not for any structures pointed to or
7486ab3a2ecSdanielk1977 ** descended from the Expr.x.pList or Expr.x.pSelect variables).
7496ab3a2ecSdanielk1977 */
7506ab3a2ecSdanielk1977 static int dupedExprSize(Expr *p, int flags){
7516ab3a2ecSdanielk1977   int nByte = 0;
7526ab3a2ecSdanielk1977   if( p ){
7536ab3a2ecSdanielk1977     nByte = dupedExprNodeSize(p, flags);
7546ab3a2ecSdanielk1977     if( flags&EXPRDUP_REDUCE ){
755b7916a78Sdrh       nByte += dupedExprSize(p->pLeft, flags) + dupedExprSize(p->pRight, flags);
7566ab3a2ecSdanielk1977     }
7576ab3a2ecSdanielk1977   }
7586ab3a2ecSdanielk1977   return nByte;
7596ab3a2ecSdanielk1977 }
7606ab3a2ecSdanielk1977 
7616ab3a2ecSdanielk1977 /*
7626ab3a2ecSdanielk1977 ** This function is similar to sqlite3ExprDup(), except that if pzBuffer
7636ab3a2ecSdanielk1977 ** is not NULL then *pzBuffer is assumed to point to a buffer large enough
764*33e619fcSdrh ** to store the copy of expression p, the copies of p->u.zToken
7656ab3a2ecSdanielk1977 ** (if applicable), and the copies of the p->pLeft and p->pRight expressions,
7666ab3a2ecSdanielk1977 ** if any. Before returning, *pzBuffer is set to the first byte passed the
7676ab3a2ecSdanielk1977 ** portion of the buffer copied into by this function.
7686ab3a2ecSdanielk1977 */
7696ab3a2ecSdanielk1977 static Expr *exprDup(sqlite3 *db, Expr *p, int flags, u8 **pzBuffer){
7706ab3a2ecSdanielk1977   Expr *pNew = 0;                      /* Value to return */
7716ab3a2ecSdanielk1977   if( p ){
7726ab3a2ecSdanielk1977     const int isReduced = (flags&EXPRDUP_REDUCE);
7736ab3a2ecSdanielk1977     u8 *zAlloc;
774*33e619fcSdrh     u32 staticFlag = 0;
7756ab3a2ecSdanielk1977 
7766ab3a2ecSdanielk1977     assert( pzBuffer==0 || isReduced );
7776ab3a2ecSdanielk1977 
7786ab3a2ecSdanielk1977     /* Figure out where to write the new Expr structure. */
7796ab3a2ecSdanielk1977     if( pzBuffer ){
7806ab3a2ecSdanielk1977       zAlloc = *pzBuffer;
781*33e619fcSdrh       staticFlag = EP_Static;
7826ab3a2ecSdanielk1977     }else{
7836ab3a2ecSdanielk1977       zAlloc = sqlite3DbMallocRaw(db, dupedExprSize(p, flags));
7846ab3a2ecSdanielk1977     }
7856ab3a2ecSdanielk1977     pNew = (Expr *)zAlloc;
7866ab3a2ecSdanielk1977 
7876ab3a2ecSdanielk1977     if( pNew ){
7886ab3a2ecSdanielk1977       /* Set nNewSize to the size allocated for the structure pointed to
7896ab3a2ecSdanielk1977       ** by pNew. This is either EXPR_FULLSIZE, EXPR_REDUCEDSIZE or
7906ab3a2ecSdanielk1977       ** EXPR_TOKENONLYSIZE. nToken is set to the number of bytes consumed
791*33e619fcSdrh       ** by the copy of the p->u.zToken string (if any).
7926ab3a2ecSdanielk1977       */
793*33e619fcSdrh       const unsigned nStructSize = dupedExprStructSize(p, flags);
794*33e619fcSdrh       const int nNewSize = nStructSize & 0xfff;
795*33e619fcSdrh       int nToken;
796*33e619fcSdrh       if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
797*33e619fcSdrh         nToken = sqlite3Strlen30(p->u.zToken) + 1;
798*33e619fcSdrh       }else{
799*33e619fcSdrh         nToken = 0;
800*33e619fcSdrh       }
8016ab3a2ecSdanielk1977       if( isReduced ){
8026ab3a2ecSdanielk1977         assert( ExprHasProperty(p, EP_Reduced)==0 );
8036ab3a2ecSdanielk1977         memcpy(zAlloc, p, nNewSize);
8046ab3a2ecSdanielk1977       }else{
8056ab3a2ecSdanielk1977         int nSize = exprStructSize(p);
8066ab3a2ecSdanielk1977         memcpy(zAlloc, p, nSize);
8076ab3a2ecSdanielk1977         memset(&zAlloc[nSize], 0, EXPR_FULLSIZE-nSize);
8086ab3a2ecSdanielk1977       }
8096ab3a2ecSdanielk1977 
810*33e619fcSdrh       /* Set the EP_Reduced, EP_TokenOnly, and EP_Static flags appropriately. */
811*33e619fcSdrh       pNew->flags &= ~(EP_Reduced|EP_TokenOnly|EP_Static);
812*33e619fcSdrh       pNew->flags |= nStructSize & (EP_Reduced|EP_TokenOnly);
813*33e619fcSdrh       pNew->flags |= staticFlag;
8146ab3a2ecSdanielk1977 
815*33e619fcSdrh       /* Copy the p->u.zToken string, if any. */
8166ab3a2ecSdanielk1977       if( nToken ){
817*33e619fcSdrh         char *zToken = pNew->u.zToken = (char*)&zAlloc[nNewSize];
818*33e619fcSdrh         memcpy(zToken, p->u.zToken, nToken);
8196ab3a2ecSdanielk1977       }
8206ab3a2ecSdanielk1977 
8216ab3a2ecSdanielk1977       if( 0==((p->flags|pNew->flags) & EP_TokenOnly) ){
8226ab3a2ecSdanielk1977         /* Fill in the pNew->x.pSelect or pNew->x.pList member. */
8236ab3a2ecSdanielk1977         if( ExprHasProperty(p, EP_xIsSelect) ){
8246ab3a2ecSdanielk1977           pNew->x.pSelect = sqlite3SelectDup(db, p->x.pSelect, isReduced);
8256ab3a2ecSdanielk1977         }else{
8266ab3a2ecSdanielk1977           pNew->x.pList = sqlite3ExprListDup(db, p->x.pList, isReduced);
8276ab3a2ecSdanielk1977         }
8286ab3a2ecSdanielk1977       }
8296ab3a2ecSdanielk1977 
8306ab3a2ecSdanielk1977       /* Fill in pNew->pLeft and pNew->pRight. */
831b7916a78Sdrh       if( ExprHasAnyProperty(pNew, EP_Reduced|EP_TokenOnly) ){
8326ab3a2ecSdanielk1977         zAlloc += dupedExprNodeSize(p, flags);
8336ab3a2ecSdanielk1977         if( ExprHasProperty(pNew, EP_Reduced) ){
8346ab3a2ecSdanielk1977           pNew->pLeft = exprDup(db, p->pLeft, EXPRDUP_REDUCE, &zAlloc);
8356ab3a2ecSdanielk1977           pNew->pRight = exprDup(db, p->pRight, EXPRDUP_REDUCE, &zAlloc);
8366ab3a2ecSdanielk1977         }
8376ab3a2ecSdanielk1977         if( pzBuffer ){
8386ab3a2ecSdanielk1977           *pzBuffer = zAlloc;
8396ab3a2ecSdanielk1977         }
840b7916a78Sdrh       }else{
841b7916a78Sdrh         pNew->flags2 = 0;
842b7916a78Sdrh         if( !ExprHasAnyProperty(p, EP_TokenOnly) ){
8436ab3a2ecSdanielk1977           pNew->pLeft = sqlite3ExprDup(db, p->pLeft, 0);
8446ab3a2ecSdanielk1977           pNew->pRight = sqlite3ExprDup(db, p->pRight, 0);
8456ab3a2ecSdanielk1977         }
8466ab3a2ecSdanielk1977       }
847b7916a78Sdrh 
848b7916a78Sdrh     }
8496ab3a2ecSdanielk1977   }
8506ab3a2ecSdanielk1977   return pNew;
8516ab3a2ecSdanielk1977 }
8526ab3a2ecSdanielk1977 
8536ab3a2ecSdanielk1977 /*
854ff78bd2fSdrh ** The following group of routines make deep copies of expressions,
855ff78bd2fSdrh ** expression lists, ID lists, and select statements.  The copies can
856ff78bd2fSdrh ** be deleted (by being passed to their respective ...Delete() routines)
857ff78bd2fSdrh ** without effecting the originals.
858ff78bd2fSdrh **
8594adee20fSdanielk1977 ** The expression list, ID, and source lists return by sqlite3ExprListDup(),
8604adee20fSdanielk1977 ** sqlite3IdListDup(), and sqlite3SrcListDup() can not be further expanded
861ad3cab52Sdrh ** by subsequent calls to sqlite*ListAppend() routines.
862ff78bd2fSdrh **
863ad3cab52Sdrh ** Any tables that the SrcList might point to are not duplicated.
8646ab3a2ecSdanielk1977 **
865b7916a78Sdrh ** The flags parameter contains a combination of the EXPRDUP_XXX flags.
8666ab3a2ecSdanielk1977 ** If the EXPRDUP_REDUCE flag is set, then the structure returned is a
8676ab3a2ecSdanielk1977 ** truncated version of the usual Expr structure that will be stored as
8686ab3a2ecSdanielk1977 ** part of the in-memory representation of the database schema.
869ff78bd2fSdrh */
8706ab3a2ecSdanielk1977 Expr *sqlite3ExprDup(sqlite3 *db, Expr *p, int flags){
8716ab3a2ecSdanielk1977   return exprDup(db, p, flags, 0);
872ff78bd2fSdrh }
8736ab3a2ecSdanielk1977 ExprList *sqlite3ExprListDup(sqlite3 *db, ExprList *p, int flags){
874ff78bd2fSdrh   ExprList *pNew;
875145716b3Sdrh   struct ExprList_item *pItem, *pOldItem;
876ff78bd2fSdrh   int i;
877ff78bd2fSdrh   if( p==0 ) return 0;
87817435752Sdrh   pNew = sqlite3DbMallocRaw(db, sizeof(*pNew) );
879ff78bd2fSdrh   if( pNew==0 ) return 0;
88031dad9daSdanielk1977   pNew->iECursor = 0;
8814305d103Sdrh   pNew->nExpr = pNew->nAlloc = p->nExpr;
88217435752Sdrh   pNew->a = pItem = sqlite3DbMallocRaw(db,  p->nExpr*sizeof(p->a[0]) );
883e0048400Sdanielk1977   if( pItem==0 ){
884633e6d57Sdrh     sqlite3DbFree(db, pNew);
885e0048400Sdanielk1977     return 0;
886e0048400Sdanielk1977   }
887145716b3Sdrh   pOldItem = p->a;
888145716b3Sdrh   for(i=0; i<p->nExpr; i++, pItem++, pOldItem++){
8896ab3a2ecSdanielk1977     Expr *pNewExpr;
8906ab3a2ecSdanielk1977     Expr *pOldExpr = pOldItem->pExpr;
8916ab3a2ecSdanielk1977     pItem->pExpr = pNewExpr = sqlite3ExprDup(db, pOldExpr, flags);
89217435752Sdrh     pItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
893b7916a78Sdrh     pItem->zSpan = sqlite3DbStrDup(db, pOldItem->zSpan);
894145716b3Sdrh     pItem->sortOrder = pOldItem->sortOrder;
8953e7bc9caSdrh     pItem->done = 0;
8967d10d5a6Sdrh     pItem->iCol = pOldItem->iCol;
8978b213899Sdrh     pItem->iAlias = pOldItem->iAlias;
898ff78bd2fSdrh   }
899ff78bd2fSdrh   return pNew;
900ff78bd2fSdrh }
90193758c8dSdanielk1977 
90293758c8dSdanielk1977 /*
90393758c8dSdanielk1977 ** If cursors, triggers, views and subqueries are all omitted from
90493758c8dSdanielk1977 ** the build, then none of the following routines, except for
90593758c8dSdanielk1977 ** sqlite3SelectDup(), can be called. sqlite3SelectDup() is sometimes
90693758c8dSdanielk1977 ** called with a NULL argument.
90793758c8dSdanielk1977 */
9086a67fe8eSdanielk1977 #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_TRIGGER) \
9096a67fe8eSdanielk1977  || !defined(SQLITE_OMIT_SUBQUERY)
9106ab3a2ecSdanielk1977 SrcList *sqlite3SrcListDup(sqlite3 *db, SrcList *p, int flags){
911ad3cab52Sdrh   SrcList *pNew;
912ad3cab52Sdrh   int i;
913113088ecSdrh   int nByte;
914ad3cab52Sdrh   if( p==0 ) return 0;
915113088ecSdrh   nByte = sizeof(*p) + (p->nSrc>0 ? sizeof(p->a[0]) * (p->nSrc-1) : 0);
91617435752Sdrh   pNew = sqlite3DbMallocRaw(db, nByte );
917ad3cab52Sdrh   if( pNew==0 ) return 0;
9184305d103Sdrh   pNew->nSrc = pNew->nAlloc = p->nSrc;
919ad3cab52Sdrh   for(i=0; i<p->nSrc; i++){
9204efc4754Sdrh     struct SrcList_item *pNewItem = &pNew->a[i];
9214efc4754Sdrh     struct SrcList_item *pOldItem = &p->a[i];
922ed8a3bb1Sdrh     Table *pTab;
92317435752Sdrh     pNewItem->zDatabase = sqlite3DbStrDup(db, pOldItem->zDatabase);
92417435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
92517435752Sdrh     pNewItem->zAlias = sqlite3DbStrDup(db, pOldItem->zAlias);
9264efc4754Sdrh     pNewItem->jointype = pOldItem->jointype;
9274efc4754Sdrh     pNewItem->iCursor = pOldItem->iCursor;
9281787ccabSdanielk1977     pNewItem->isPopulated = pOldItem->isPopulated;
92985574e31Sdanielk1977     pNewItem->zIndex = sqlite3DbStrDup(db, pOldItem->zIndex);
93085574e31Sdanielk1977     pNewItem->notIndexed = pOldItem->notIndexed;
93185574e31Sdanielk1977     pNewItem->pIndex = pOldItem->pIndex;
932ed8a3bb1Sdrh     pTab = pNewItem->pTab = pOldItem->pTab;
933ed8a3bb1Sdrh     if( pTab ){
934ed8a3bb1Sdrh       pTab->nRef++;
935a1cb183dSdanielk1977     }
9366ab3a2ecSdanielk1977     pNewItem->pSelect = sqlite3SelectDup(db, pOldItem->pSelect, flags);
9376ab3a2ecSdanielk1977     pNewItem->pOn = sqlite3ExprDup(db, pOldItem->pOn, flags);
93817435752Sdrh     pNewItem->pUsing = sqlite3IdListDup(db, pOldItem->pUsing);
9396c18b6e0Sdanielk1977     pNewItem->colUsed = pOldItem->colUsed;
940ad3cab52Sdrh   }
941ad3cab52Sdrh   return pNew;
942ad3cab52Sdrh }
94317435752Sdrh IdList *sqlite3IdListDup(sqlite3 *db, IdList *p){
944ff78bd2fSdrh   IdList *pNew;
945ff78bd2fSdrh   int i;
946ff78bd2fSdrh   if( p==0 ) return 0;
94717435752Sdrh   pNew = sqlite3DbMallocRaw(db, sizeof(*pNew) );
948ff78bd2fSdrh   if( pNew==0 ) return 0;
9494305d103Sdrh   pNew->nId = pNew->nAlloc = p->nId;
95017435752Sdrh   pNew->a = sqlite3DbMallocRaw(db, p->nId*sizeof(p->a[0]) );
951d5d56523Sdanielk1977   if( pNew->a==0 ){
952633e6d57Sdrh     sqlite3DbFree(db, pNew);
953d5d56523Sdanielk1977     return 0;
954d5d56523Sdanielk1977   }
955ff78bd2fSdrh   for(i=0; i<p->nId; i++){
9564efc4754Sdrh     struct IdList_item *pNewItem = &pNew->a[i];
9574efc4754Sdrh     struct IdList_item *pOldItem = &p->a[i];
95817435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
9594efc4754Sdrh     pNewItem->idx = pOldItem->idx;
960ff78bd2fSdrh   }
961ff78bd2fSdrh   return pNew;
962ff78bd2fSdrh }
9636ab3a2ecSdanielk1977 Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
964ff78bd2fSdrh   Select *pNew;
965ff78bd2fSdrh   if( p==0 ) return 0;
96617435752Sdrh   pNew = sqlite3DbMallocRaw(db, sizeof(*p) );
967ff78bd2fSdrh   if( pNew==0 ) return 0;
968b7916a78Sdrh   pNew->pEList = sqlite3ExprListDup(db, p->pEList, flags);
9696ab3a2ecSdanielk1977   pNew->pSrc = sqlite3SrcListDup(db, p->pSrc, flags);
9706ab3a2ecSdanielk1977   pNew->pWhere = sqlite3ExprDup(db, p->pWhere, flags);
9716ab3a2ecSdanielk1977   pNew->pGroupBy = sqlite3ExprListDup(db, p->pGroupBy, flags);
9726ab3a2ecSdanielk1977   pNew->pHaving = sqlite3ExprDup(db, p->pHaving, flags);
9736ab3a2ecSdanielk1977   pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, flags);
974ff78bd2fSdrh   pNew->op = p->op;
9756ab3a2ecSdanielk1977   pNew->pPrior = sqlite3SelectDup(db, p->pPrior, flags);
9766ab3a2ecSdanielk1977   pNew->pLimit = sqlite3ExprDup(db, p->pLimit, flags);
9776ab3a2ecSdanielk1977   pNew->pOffset = sqlite3ExprDup(db, p->pOffset, flags);
97892b01d53Sdrh   pNew->iLimit = 0;
97992b01d53Sdrh   pNew->iOffset = 0;
9807d10d5a6Sdrh   pNew->selFlags = p->selFlags & ~SF_UsesEphemeral;
9810342b1f5Sdrh   pNew->pRightmost = 0;
982b9bb7c18Sdrh   pNew->addrOpenEphm[0] = -1;
983b9bb7c18Sdrh   pNew->addrOpenEphm[1] = -1;
984b9bb7c18Sdrh   pNew->addrOpenEphm[2] = -1;
985ff78bd2fSdrh   return pNew;
986ff78bd2fSdrh }
98793758c8dSdanielk1977 #else
9886ab3a2ecSdanielk1977 Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
98993758c8dSdanielk1977   assert( p==0 );
99093758c8dSdanielk1977   return 0;
99193758c8dSdanielk1977 }
99293758c8dSdanielk1977 #endif
993ff78bd2fSdrh 
994ff78bd2fSdrh 
995ff78bd2fSdrh /*
996a76b5dfcSdrh ** Add a new element to the end of an expression list.  If pList is
997a76b5dfcSdrh ** initially NULL, then create a new expression list.
998b7916a78Sdrh **
999b7916a78Sdrh ** If a memory allocation error occurs, the entire list is freed and
1000b7916a78Sdrh ** NULL is returned.  If non-NULL is returned, then it is guaranteed
1001b7916a78Sdrh ** that the new entry was successfully appended.
1002a76b5dfcSdrh */
100317435752Sdrh ExprList *sqlite3ExprListAppend(
100417435752Sdrh   Parse *pParse,          /* Parsing context */
100517435752Sdrh   ExprList *pList,        /* List to which to append. Might be NULL */
1006b7916a78Sdrh   Expr *pExpr             /* Expression to be appended. Might be NULL */
100717435752Sdrh ){
100817435752Sdrh   sqlite3 *db = pParse->db;
1009a76b5dfcSdrh   if( pList==0 ){
101017435752Sdrh     pList = sqlite3DbMallocZero(db, sizeof(ExprList) );
1011a76b5dfcSdrh     if( pList==0 ){
1012d5d56523Sdanielk1977       goto no_mem;
1013a76b5dfcSdrh     }
10144efc4754Sdrh     assert( pList->nAlloc==0 );
1015a76b5dfcSdrh   }
10164305d103Sdrh   if( pList->nAlloc<=pList->nExpr ){
1017d5d56523Sdanielk1977     struct ExprList_item *a;
1018d5d56523Sdanielk1977     int n = pList->nAlloc*2 + 4;
101926783a58Sdanielk1977     a = sqlite3DbRealloc(db, pList->a, n*sizeof(pList->a[0]));
1020d5d56523Sdanielk1977     if( a==0 ){
1021d5d56523Sdanielk1977       goto no_mem;
1022a76b5dfcSdrh     }
1023d5d56523Sdanielk1977     pList->a = a;
10246a1e071fSdrh     pList->nAlloc = sqlite3DbMallocSize(db, a)/sizeof(a[0]);
1025a76b5dfcSdrh   }
10264efc4754Sdrh   assert( pList->a!=0 );
1027b7916a78Sdrh   if( 1 ){
10284efc4754Sdrh     struct ExprList_item *pItem = &pList->a[pList->nExpr++];
10294efc4754Sdrh     memset(pItem, 0, sizeof(*pItem));
1030e94ddc9eSdanielk1977     pItem->pExpr = pExpr;
1031a76b5dfcSdrh   }
1032a76b5dfcSdrh   return pList;
1033d5d56523Sdanielk1977 
1034d5d56523Sdanielk1977 no_mem:
1035d5d56523Sdanielk1977   /* Avoid leaking memory if malloc has failed. */
1036633e6d57Sdrh   sqlite3ExprDelete(db, pExpr);
1037633e6d57Sdrh   sqlite3ExprListDelete(db, pList);
1038d5d56523Sdanielk1977   return 0;
1039a76b5dfcSdrh }
1040a76b5dfcSdrh 
1041a76b5dfcSdrh /*
1042b7916a78Sdrh ** Set the ExprList.a[].zName element of the most recently added item
1043b7916a78Sdrh ** on the expression list.
1044b7916a78Sdrh **
1045b7916a78Sdrh ** pList might be NULL following an OOM error.  But pName should never be
1046b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1047b7916a78Sdrh ** is set.
1048b7916a78Sdrh */
1049b7916a78Sdrh void sqlite3ExprListSetName(
1050b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1051b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
1052b7916a78Sdrh   Token *pName,           /* Name to be added */
1053b7916a78Sdrh   int dequote             /* True to cause the name to be dequoted */
1054b7916a78Sdrh ){
1055b7916a78Sdrh   assert( pList!=0 || pParse->db->mallocFailed!=0 );
1056b7916a78Sdrh   if( pList ){
1057b7916a78Sdrh     struct ExprList_item *pItem;
1058b7916a78Sdrh     assert( pList->nExpr>0 );
1059b7916a78Sdrh     pItem = &pList->a[pList->nExpr-1];
1060b7916a78Sdrh     assert( pItem->zName==0 );
1061b7916a78Sdrh     pItem->zName = sqlite3DbStrNDup(pParse->db, pName->z, pName->n);
1062b7916a78Sdrh     if( dequote && pItem->zName ) sqlite3Dequote(pItem->zName);
1063b7916a78Sdrh   }
1064b7916a78Sdrh }
1065b7916a78Sdrh 
1066b7916a78Sdrh /*
1067b7916a78Sdrh ** Set the ExprList.a[].zSpan element of the most recently added item
1068b7916a78Sdrh ** on the expression list.
1069b7916a78Sdrh **
1070b7916a78Sdrh ** pList might be NULL following an OOM error.  But pSpan should never be
1071b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1072b7916a78Sdrh ** is set.
1073b7916a78Sdrh */
1074b7916a78Sdrh void sqlite3ExprListSetSpan(
1075b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1076b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
1077b7916a78Sdrh   ExprSpan *pSpan         /* The span to be added */
1078b7916a78Sdrh ){
1079b7916a78Sdrh   sqlite3 *db = pParse->db;
1080b7916a78Sdrh   assert( pList!=0 || db->mallocFailed!=0 );
1081b7916a78Sdrh   if( pList ){
1082b7916a78Sdrh     struct ExprList_item *pItem = &pList->a[pList->nExpr-1];
1083b7916a78Sdrh     assert( pList->nExpr>0 );
1084b7916a78Sdrh     assert( db->mallocFailed || pItem->pExpr==pSpan->pExpr );
1085b7916a78Sdrh     sqlite3DbFree(db, pItem->zSpan);
1086b7916a78Sdrh     pItem->zSpan = sqlite3DbStrNDup(db, (char*)pSpan->zStart,
1087b7916a78Sdrh                                     pSpan->zEnd - pSpan->zStart);
1088b7916a78Sdrh   }
1089b7916a78Sdrh }
1090b7916a78Sdrh 
1091b7916a78Sdrh /*
10927a15a4beSdanielk1977 ** If the expression list pEList contains more than iLimit elements,
10937a15a4beSdanielk1977 ** leave an error message in pParse.
10947a15a4beSdanielk1977 */
10957a15a4beSdanielk1977 void sqlite3ExprListCheckLength(
10967a15a4beSdanielk1977   Parse *pParse,
10977a15a4beSdanielk1977   ExprList *pEList,
10987a15a4beSdanielk1977   const char *zObject
10997a15a4beSdanielk1977 ){
1100b1a6c3c1Sdrh   int mx = pParse->db->aLimit[SQLITE_LIMIT_COLUMN];
1101c5499befSdrh   testcase( pEList && pEList->nExpr==mx );
1102c5499befSdrh   testcase( pEList && pEList->nExpr==mx+1 );
1103b1a6c3c1Sdrh   if( pEList && pEList->nExpr>mx ){
11047a15a4beSdanielk1977     sqlite3ErrorMsg(pParse, "too many columns in %s", zObject);
11057a15a4beSdanielk1977   }
11067a15a4beSdanielk1977 }
11077a15a4beSdanielk1977 
11087a15a4beSdanielk1977 /*
1109a76b5dfcSdrh ** Delete an entire expression list.
1110a76b5dfcSdrh */
1111633e6d57Sdrh void sqlite3ExprListDelete(sqlite3 *db, ExprList *pList){
1112a76b5dfcSdrh   int i;
1113be5c89acSdrh   struct ExprList_item *pItem;
1114a76b5dfcSdrh   if( pList==0 ) return;
11151bdd9b57Sdrh   assert( pList->a!=0 || (pList->nExpr==0 && pList->nAlloc==0) );
11161bdd9b57Sdrh   assert( pList->nExpr<=pList->nAlloc );
1117be5c89acSdrh   for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
1118633e6d57Sdrh     sqlite3ExprDelete(db, pItem->pExpr);
1119633e6d57Sdrh     sqlite3DbFree(db, pItem->zName);
1120b7916a78Sdrh     sqlite3DbFree(db, pItem->zSpan);
1121a76b5dfcSdrh   }
1122633e6d57Sdrh   sqlite3DbFree(db, pList->a);
1123633e6d57Sdrh   sqlite3DbFree(db, pList);
1124a76b5dfcSdrh }
1125a76b5dfcSdrh 
1126a76b5dfcSdrh /*
11277d10d5a6Sdrh ** These routines are Walker callbacks.  Walker.u.pi is a pointer
11287d10d5a6Sdrh ** to an integer.  These routines are checking an expression to see
11297d10d5a6Sdrh ** if it is a constant.  Set *Walker.u.pi to 0 if the expression is
11307d10d5a6Sdrh ** not constant.
113173b211abSdrh **
11327d10d5a6Sdrh ** These callback routines are used to implement the following:
1133626a879aSdrh **
11347d10d5a6Sdrh **     sqlite3ExprIsConstant()
11357d10d5a6Sdrh **     sqlite3ExprIsConstantNotJoin()
11367d10d5a6Sdrh **     sqlite3ExprIsConstantOrFunction()
113787abf5c0Sdrh **
1138626a879aSdrh */
11397d10d5a6Sdrh static int exprNodeIsConstant(Walker *pWalker, Expr *pExpr){
1140626a879aSdrh 
11417d10d5a6Sdrh   /* If pWalker->u.i is 3 then any term of the expression that comes from
11420a168377Sdrh   ** the ON or USING clauses of a join disqualifies the expression
11430a168377Sdrh   ** from being considered constant. */
11447d10d5a6Sdrh   if( pWalker->u.i==3 && ExprHasAnyProperty(pExpr, EP_FromJoin) ){
11457d10d5a6Sdrh     pWalker->u.i = 0;
11467d10d5a6Sdrh     return WRC_Abort;
11470a168377Sdrh   }
11480a168377Sdrh 
1149626a879aSdrh   switch( pExpr->op ){
1150eb55bd2fSdrh     /* Consider functions to be constant if all their arguments are constant
11517d10d5a6Sdrh     ** and pWalker->u.i==2 */
1152eb55bd2fSdrh     case TK_FUNCTION:
11537d10d5a6Sdrh       if( pWalker->u.i==2 ) return 0;
1154eb55bd2fSdrh       /* Fall through */
1155626a879aSdrh     case TK_ID:
1156626a879aSdrh     case TK_COLUMN:
1157626a879aSdrh     case TK_AGG_FUNCTION:
115813449892Sdrh     case TK_AGG_COLUMN:
1159fe2093d7Sdrh #ifndef SQLITE_OMIT_SUBQUERY
1160fe2093d7Sdrh     case TK_SELECT:
1161fe2093d7Sdrh     case TK_EXISTS:
1162c5499befSdrh       testcase( pExpr->op==TK_SELECT );
1163c5499befSdrh       testcase( pExpr->op==TK_EXISTS );
1164fe2093d7Sdrh #endif
1165c5499befSdrh       testcase( pExpr->op==TK_ID );
1166c5499befSdrh       testcase( pExpr->op==TK_COLUMN );
1167c5499befSdrh       testcase( pExpr->op==TK_AGG_FUNCTION );
1168c5499befSdrh       testcase( pExpr->op==TK_AGG_COLUMN );
11697d10d5a6Sdrh       pWalker->u.i = 0;
11707d10d5a6Sdrh       return WRC_Abort;
1171626a879aSdrh     default:
11727d10d5a6Sdrh       return WRC_Continue;
1173626a879aSdrh   }
1174626a879aSdrh }
117562c14b34Sdanielk1977 static int selectNodeIsConstant(Walker *pWalker, Select *NotUsed){
117662c14b34Sdanielk1977   UNUSED_PARAMETER(NotUsed);
11777d10d5a6Sdrh   pWalker->u.i = 0;
11787d10d5a6Sdrh   return WRC_Abort;
11797d10d5a6Sdrh }
11807d10d5a6Sdrh static int exprIsConst(Expr *p, int initFlag){
11817d10d5a6Sdrh   Walker w;
11827d10d5a6Sdrh   w.u.i = initFlag;
11837d10d5a6Sdrh   w.xExprCallback = exprNodeIsConstant;
11847d10d5a6Sdrh   w.xSelectCallback = selectNodeIsConstant;
11857d10d5a6Sdrh   sqlite3WalkExpr(&w, p);
11867d10d5a6Sdrh   return w.u.i;
11877d10d5a6Sdrh }
1188626a879aSdrh 
1189626a879aSdrh /*
1190fef5208cSdrh ** Walk an expression tree.  Return 1 if the expression is constant
1191eb55bd2fSdrh ** and 0 if it involves variables or function calls.
11922398937bSdrh **
11932398937bSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
11942398937bSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
11952398937bSdrh ** a constant.
1196fef5208cSdrh */
11974adee20fSdanielk1977 int sqlite3ExprIsConstant(Expr *p){
11987d10d5a6Sdrh   return exprIsConst(p, 1);
1199fef5208cSdrh }
1200fef5208cSdrh 
1201fef5208cSdrh /*
1202eb55bd2fSdrh ** Walk an expression tree.  Return 1 if the expression is constant
12030a168377Sdrh ** that does no originate from the ON or USING clauses of a join.
12040a168377Sdrh ** Return 0 if it involves variables or function calls or terms from
12050a168377Sdrh ** an ON or USING clause.
12060a168377Sdrh */
12070a168377Sdrh int sqlite3ExprIsConstantNotJoin(Expr *p){
12087d10d5a6Sdrh   return exprIsConst(p, 3);
12090a168377Sdrh }
12100a168377Sdrh 
12110a168377Sdrh /*
12120a168377Sdrh ** Walk an expression tree.  Return 1 if the expression is constant
1213eb55bd2fSdrh ** or a function call with constant arguments.  Return and 0 if there
1214eb55bd2fSdrh ** are any variables.
1215eb55bd2fSdrh **
1216eb55bd2fSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
1217eb55bd2fSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
1218eb55bd2fSdrh ** a constant.
1219eb55bd2fSdrh */
1220eb55bd2fSdrh int sqlite3ExprIsConstantOrFunction(Expr *p){
12217d10d5a6Sdrh   return exprIsConst(p, 2);
1222eb55bd2fSdrh }
1223eb55bd2fSdrh 
1224eb55bd2fSdrh /*
122573b211abSdrh ** If the expression p codes a constant integer that is small enough
1226202b2df7Sdrh ** to fit in a 32-bit integer, return 1 and put the value of the integer
1227202b2df7Sdrh ** in *pValue.  If the expression is not an integer or if it is too big
1228202b2df7Sdrh ** to fit in a signed 32-bit integer, return 0 and leave *pValue unchanged.
1229e4de1febSdrh */
12304adee20fSdanielk1977 int sqlite3ExprIsInteger(Expr *p, int *pValue){
123192b01d53Sdrh   int rc = 0;
123292b01d53Sdrh   if( p->flags & EP_IntValue ){
1233*33e619fcSdrh     *pValue = p->u.iValue;
1234e4de1febSdrh     return 1;
1235e4de1febSdrh   }
123692b01d53Sdrh   switch( p->op ){
123792b01d53Sdrh     case TK_INTEGER: {
1238*33e619fcSdrh       rc = sqlite3GetInt32(p->u.zToken, pValue);
1239*33e619fcSdrh       assert( rc==0 );
1240202b2df7Sdrh       break;
1241202b2df7Sdrh     }
12424b59ab5eSdrh     case TK_UPLUS: {
124392b01d53Sdrh       rc = sqlite3ExprIsInteger(p->pLeft, pValue);
1244f6e369a1Sdrh       break;
12454b59ab5eSdrh     }
1246e4de1febSdrh     case TK_UMINUS: {
1247e4de1febSdrh       int v;
12484adee20fSdanielk1977       if( sqlite3ExprIsInteger(p->pLeft, &v) ){
1249e4de1febSdrh         *pValue = -v;
125092b01d53Sdrh         rc = 1;
1251e4de1febSdrh       }
1252e4de1febSdrh       break;
1253e4de1febSdrh     }
1254e4de1febSdrh     default: break;
1255e4de1febSdrh   }
125692b01d53Sdrh   if( rc ){
1257*33e619fcSdrh     assert( ExprHasAnyProperty(p, EP_Reduced|EP_TokenOnly)
1258*33e619fcSdrh                || (p->flags2 & EP2_MallocedToken)==0 );
125992b01d53Sdrh     p->op = TK_INTEGER;
126092b01d53Sdrh     p->flags |= EP_IntValue;
1261*33e619fcSdrh     p->u.iValue = *pValue;
126292b01d53Sdrh   }
126392b01d53Sdrh   return rc;
1264e4de1febSdrh }
1265e4de1febSdrh 
1266e4de1febSdrh /*
1267c4a3c779Sdrh ** Return TRUE if the given string is a row-id column name.
1268c4a3c779Sdrh */
12694adee20fSdanielk1977 int sqlite3IsRowid(const char *z){
12704adee20fSdanielk1977   if( sqlite3StrICmp(z, "_ROWID_")==0 ) return 1;
12714adee20fSdanielk1977   if( sqlite3StrICmp(z, "ROWID")==0 ) return 1;
12724adee20fSdanielk1977   if( sqlite3StrICmp(z, "OID")==0 ) return 1;
1273c4a3c779Sdrh   return 0;
1274c4a3c779Sdrh }
1275c4a3c779Sdrh 
12769a96b668Sdanielk1977 /*
1277b287f4b6Sdrh ** Return true if the IN operator optimization is enabled and
1278b287f4b6Sdrh ** the SELECT statement p exists and is of the
1279b287f4b6Sdrh ** simple form:
1280b287f4b6Sdrh **
1281b287f4b6Sdrh **     SELECT <column> FROM <table>
1282b287f4b6Sdrh **
1283b287f4b6Sdrh ** If this is the case, it may be possible to use an existing table
1284b287f4b6Sdrh ** or index instead of generating an epheremal table.
1285b287f4b6Sdrh */
1286b287f4b6Sdrh #ifndef SQLITE_OMIT_SUBQUERY
1287b287f4b6Sdrh static int isCandidateForInOpt(Select *p){
1288b287f4b6Sdrh   SrcList *pSrc;
1289b287f4b6Sdrh   ExprList *pEList;
1290b287f4b6Sdrh   Table *pTab;
1291b287f4b6Sdrh   if( p==0 ) return 0;                   /* right-hand side of IN is SELECT */
1292b287f4b6Sdrh   if( p->pPrior ) return 0;              /* Not a compound SELECT */
12937d10d5a6Sdrh   if( p->selFlags & (SF_Distinct|SF_Aggregate) ){
12947d10d5a6Sdrh       return 0; /* No DISTINCT keyword and no aggregate functions */
12957d10d5a6Sdrh   }
1296b287f4b6Sdrh   if( p->pGroupBy ) return 0;            /* Has no GROUP BY clause */
1297b287f4b6Sdrh   if( p->pLimit ) return 0;              /* Has no LIMIT clause */
1298b287f4b6Sdrh   if( p->pOffset ) return 0;
1299b287f4b6Sdrh   if( p->pWhere ) return 0;              /* Has no WHERE clause */
1300b287f4b6Sdrh   pSrc = p->pSrc;
1301d1fa7bcaSdrh   assert( pSrc!=0 );
1302d1fa7bcaSdrh   if( pSrc->nSrc!=1 ) return 0;          /* Single term in FROM clause */
1303b287f4b6Sdrh   if( pSrc->a[0].pSelect ) return 0;     /* FROM clause is not a subquery */
1304b287f4b6Sdrh   pTab = pSrc->a[0].pTab;
1305b287f4b6Sdrh   if( pTab==0 ) return 0;
1306b287f4b6Sdrh   if( pTab->pSelect ) return 0;          /* FROM clause is not a view */
1307b287f4b6Sdrh   if( IsVirtual(pTab) ) return 0;        /* FROM clause not a virtual table */
1308b287f4b6Sdrh   pEList = p->pEList;
1309b287f4b6Sdrh   if( pEList->nExpr!=1 ) return 0;       /* One column in the result set */
1310b287f4b6Sdrh   if( pEList->a[0].pExpr->op!=TK_COLUMN ) return 0; /* Result is a column */
1311b287f4b6Sdrh   return 1;
1312b287f4b6Sdrh }
1313b287f4b6Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
1314b287f4b6Sdrh 
1315b287f4b6Sdrh /*
13169a96b668Sdanielk1977 ** This function is used by the implementation of the IN (...) operator.
13179a96b668Sdanielk1977 ** It's job is to find or create a b-tree structure that may be used
13189a96b668Sdanielk1977 ** either to test for membership of the (...) set or to iterate through
131985b623f2Sdrh ** its members, skipping duplicates.
13209a96b668Sdanielk1977 **
13219a96b668Sdanielk1977 ** The cursor opened on the structure (database table, database index
13229a96b668Sdanielk1977 ** or ephermal table) is stored in pX->iTable before this function returns.
13239a96b668Sdanielk1977 ** The returned value indicates the structure type, as follows:
13249a96b668Sdanielk1977 **
13259a96b668Sdanielk1977 **   IN_INDEX_ROWID - The cursor was opened on a database table.
13262d401ab8Sdrh **   IN_INDEX_INDEX - The cursor was opened on a database index.
13279a96b668Sdanielk1977 **   IN_INDEX_EPH -   The cursor was opened on a specially created and
13289a96b668Sdanielk1977 **                    populated epheremal table.
13299a96b668Sdanielk1977 **
13309a96b668Sdanielk1977 ** An existing structure may only be used if the SELECT is of the simple
13319a96b668Sdanielk1977 ** form:
13329a96b668Sdanielk1977 **
13339a96b668Sdanielk1977 **     SELECT <column> FROM <table>
13349a96b668Sdanielk1977 **
13350cdc022eSdanielk1977 ** If prNotFound parameter is 0, then the structure will be used to iterate
13369a96b668Sdanielk1977 ** through the set members, skipping any duplicates. In this case an
13379a96b668Sdanielk1977 ** epheremal table must be used unless the selected <column> is guaranteed
13389a96b668Sdanielk1977 ** to be unique - either because it is an INTEGER PRIMARY KEY or it
13399a96b668Sdanielk1977 ** is unique by virtue of a constraint or implicit index.
13400cdc022eSdanielk1977 **
13410cdc022eSdanielk1977 ** If the prNotFound parameter is not 0, then the structure will be used
13420cdc022eSdanielk1977 ** for fast set membership tests. In this case an epheremal table must
13430cdc022eSdanielk1977 ** be used unless <column> is an INTEGER PRIMARY KEY or an index can
13440cdc022eSdanielk1977 ** be found with <column> as its left-most column.
13450cdc022eSdanielk1977 **
13460cdc022eSdanielk1977 ** When the structure is being used for set membership tests, the user
13470cdc022eSdanielk1977 ** needs to know whether or not the structure contains an SQL NULL
13480cdc022eSdanielk1977 ** value in order to correctly evaluate expressions like "X IN (Y, Z)".
13490cdc022eSdanielk1977 ** If there is a chance that the structure may contain a NULL value at
13500cdc022eSdanielk1977 ** runtime, then a register is allocated and the register number written
13510cdc022eSdanielk1977 ** to *prNotFound. If there is no chance that the structure contains a
13520cdc022eSdanielk1977 ** NULL value, then *prNotFound is left unchanged.
13530cdc022eSdanielk1977 **
13540cdc022eSdanielk1977 ** If a register is allocated and its location stored in *prNotFound, then
13550cdc022eSdanielk1977 ** its initial value is NULL. If the structure does not remain constant
13560cdc022eSdanielk1977 ** for the duration of the query (i.e. the set is a correlated sub-select),
13570cdc022eSdanielk1977 ** the value of the allocated register is reset to NULL each time the
13580cdc022eSdanielk1977 ** structure is repopulated. This allows the caller to use vdbe code
13590cdc022eSdanielk1977 ** equivalent to the following:
13600cdc022eSdanielk1977 **
13610cdc022eSdanielk1977 **   if( register==NULL ){
13620cdc022eSdanielk1977 **     has_null = <test if data structure contains null>
13630cdc022eSdanielk1977 **     register = 1
13640cdc022eSdanielk1977 **   }
13650cdc022eSdanielk1977 **
13660cdc022eSdanielk1977 ** in order to avoid running the <test if data structure contains null>
13670cdc022eSdanielk1977 ** test more often than is necessary.
13689a96b668Sdanielk1977 */
1369284f4acaSdanielk1977 #ifndef SQLITE_OMIT_SUBQUERY
13700cdc022eSdanielk1977 int sqlite3FindInIndex(Parse *pParse, Expr *pX, int *prNotFound){
13719a96b668Sdanielk1977   Select *p;
13729a96b668Sdanielk1977   int eType = 0;
13739a96b668Sdanielk1977   int iTab = pParse->nTab++;
13740cdc022eSdanielk1977   int mustBeUnique = !prNotFound;
13759a96b668Sdanielk1977 
13769a96b668Sdanielk1977   /* The follwing if(...) expression is true if the SELECT is of the
13779a96b668Sdanielk1977   ** simple form:
13789a96b668Sdanielk1977   **
13799a96b668Sdanielk1977   **     SELECT <column> FROM <table>
13809a96b668Sdanielk1977   **
13819a96b668Sdanielk1977   ** If this is the case, it may be possible to use an existing table
13829a96b668Sdanielk1977   ** or index instead of generating an epheremal table.
13839a96b668Sdanielk1977   */
13846ab3a2ecSdanielk1977   p = (ExprHasProperty(pX, EP_xIsSelect) ? pX->x.pSelect : 0);
1385b287f4b6Sdrh   if( isCandidateForInOpt(p) ){
1386e1fb65a0Sdanielk1977     sqlite3 *db = pParse->db;              /* Database connection */
1387e1fb65a0Sdanielk1977     Expr *pExpr = p->pEList->a[0].pExpr;   /* Expression <column> */
1388e1fb65a0Sdanielk1977     int iCol = pExpr->iColumn;             /* Index of column <column> */
1389e1fb65a0Sdanielk1977     Vdbe *v = sqlite3GetVdbe(pParse);      /* Virtual machine being coded */
1390e1fb65a0Sdanielk1977     Table *pTab = p->pSrc->a[0].pTab;      /* Table <table>. */
1391e1fb65a0Sdanielk1977     int iDb;                               /* Database idx for pTab */
1392e1fb65a0Sdanielk1977 
1393e1fb65a0Sdanielk1977     /* Code an OP_VerifyCookie and OP_TableLock for <table>. */
1394e1fb65a0Sdanielk1977     iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
1395e1fb65a0Sdanielk1977     sqlite3CodeVerifySchema(pParse, iDb);
1396e1fb65a0Sdanielk1977     sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
13979a96b668Sdanielk1977 
13989a96b668Sdanielk1977     /* This function is only called from two places. In both cases the vdbe
13999a96b668Sdanielk1977     ** has already been allocated. So assume sqlite3GetVdbe() is always
14009a96b668Sdanielk1977     ** successful here.
14019a96b668Sdanielk1977     */
14029a96b668Sdanielk1977     assert(v);
14039a96b668Sdanielk1977     if( iCol<0 ){
14040a07c107Sdrh       int iMem = ++pParse->nMem;
14059a96b668Sdanielk1977       int iAddr;
14069a96b668Sdanielk1977       sqlite3VdbeUsesBtree(v, iDb);
14079a96b668Sdanielk1977 
1408892d3179Sdrh       iAddr = sqlite3VdbeAddOp1(v, OP_If, iMem);
14094c583128Sdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, iMem);
14109a96b668Sdanielk1977 
14119a96b668Sdanielk1977       sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
14129a96b668Sdanielk1977       eType = IN_INDEX_ROWID;
14139a96b668Sdanielk1977 
14149a96b668Sdanielk1977       sqlite3VdbeJumpHere(v, iAddr);
14159a96b668Sdanielk1977     }else{
1416e1fb65a0Sdanielk1977       Index *pIdx;                         /* Iterator variable */
1417e1fb65a0Sdanielk1977 
14189a96b668Sdanielk1977       /* The collation sequence used by the comparison. If an index is to
14199a96b668Sdanielk1977       ** be used in place of a temp-table, it must be ordered according
1420e1fb65a0Sdanielk1977       ** to this collation sequence.  */
14219a96b668Sdanielk1977       CollSeq *pReq = sqlite3BinaryCompareCollSeq(pParse, pX->pLeft, pExpr);
14229a96b668Sdanielk1977 
14239a96b668Sdanielk1977       /* Check that the affinity that will be used to perform the
14249a96b668Sdanielk1977       ** comparison is the same as the affinity of the column. If
14259a96b668Sdanielk1977       ** it is not, it is not possible to use any index.
14269a96b668Sdanielk1977       */
14279a96b668Sdanielk1977       char aff = comparisonAffinity(pX);
14289a96b668Sdanielk1977       int affinity_ok = (pTab->aCol[iCol].affinity==aff||aff==SQLITE_AFF_NONE);
14299a96b668Sdanielk1977 
14309a96b668Sdanielk1977       for(pIdx=pTab->pIndex; pIdx && eType==0 && affinity_ok; pIdx=pIdx->pNext){
14319a96b668Sdanielk1977         if( (pIdx->aiColumn[0]==iCol)
1432c4a64facSdrh          && (pReq==sqlite3FindCollSeq(db, ENC(db), pIdx->azColl[0], 0))
14339a96b668Sdanielk1977          && (!mustBeUnique || (pIdx->nColumn==1 && pIdx->onError!=OE_None))
14349a96b668Sdanielk1977         ){
14350a07c107Sdrh           int iMem = ++pParse->nMem;
14369a96b668Sdanielk1977           int iAddr;
14379a96b668Sdanielk1977           char *pKey;
14389a96b668Sdanielk1977 
14399a96b668Sdanielk1977           pKey = (char *)sqlite3IndexKeyinfo(pParse, pIdx);
14409a96b668Sdanielk1977           iDb = sqlite3SchemaToIndex(db, pIdx->pSchema);
14419a96b668Sdanielk1977           sqlite3VdbeUsesBtree(v, iDb);
14429a96b668Sdanielk1977 
1443892d3179Sdrh           iAddr = sqlite3VdbeAddOp1(v, OP_If, iMem);
14444c583128Sdrh           sqlite3VdbeAddOp2(v, OP_Integer, 1, iMem);
14459a96b668Sdanielk1977 
1446207872a4Sdanielk1977           sqlite3VdbeAddOp4(v, OP_OpenRead, iTab, pIdx->tnum, iDb,
144766a5167bSdrh                                pKey,P4_KEYINFO_HANDOFF);
1448207872a4Sdanielk1977           VdbeComment((v, "%s", pIdx->zName));
14499a96b668Sdanielk1977           eType = IN_INDEX_INDEX;
14509a96b668Sdanielk1977 
14519a96b668Sdanielk1977           sqlite3VdbeJumpHere(v, iAddr);
14520cdc022eSdanielk1977           if( prNotFound && !pTab->aCol[iCol].notNull ){
14530cdc022eSdanielk1977             *prNotFound = ++pParse->nMem;
14540cdc022eSdanielk1977           }
14559a96b668Sdanielk1977         }
14569a96b668Sdanielk1977       }
14579a96b668Sdanielk1977     }
14589a96b668Sdanielk1977   }
14599a96b668Sdanielk1977 
14609a96b668Sdanielk1977   if( eType==0 ){
14610cdc022eSdanielk1977     int rMayHaveNull = 0;
146241a05b7bSdanielk1977     eType = IN_INDEX_EPH;
14630cdc022eSdanielk1977     if( prNotFound ){
14640cdc022eSdanielk1977       *prNotFound = rMayHaveNull = ++pParse->nMem;
14656ab3a2ecSdanielk1977     }else if( pX->pLeft->iColumn<0 && !ExprHasAnyProperty(pX, EP_xIsSelect) ){
146641a05b7bSdanielk1977       eType = IN_INDEX_ROWID;
14670cdc022eSdanielk1977     }
146841a05b7bSdanielk1977     sqlite3CodeSubselect(pParse, pX, rMayHaveNull, eType==IN_INDEX_ROWID);
14699a96b668Sdanielk1977   }else{
14709a96b668Sdanielk1977     pX->iTable = iTab;
14719a96b668Sdanielk1977   }
14729a96b668Sdanielk1977   return eType;
14739a96b668Sdanielk1977 }
1474284f4acaSdanielk1977 #endif
1475626a879aSdrh 
1476626a879aSdrh /*
14779cbe6352Sdrh ** Generate code for scalar subqueries used as an expression
14789cbe6352Sdrh ** and IN operators.  Examples:
1479626a879aSdrh **
14809cbe6352Sdrh **     (SELECT a FROM b)          -- subquery
14819cbe6352Sdrh **     EXISTS (SELECT a FROM b)   -- EXISTS subquery
14829cbe6352Sdrh **     x IN (4,5,11)              -- IN operator with list on right-hand side
14839cbe6352Sdrh **     x IN (SELECT a FROM b)     -- IN operator with subquery on the right
1484fef5208cSdrh **
14859cbe6352Sdrh ** The pExpr parameter describes the expression that contains the IN
14869cbe6352Sdrh ** operator or subquery.
148741a05b7bSdanielk1977 **
148841a05b7bSdanielk1977 ** If parameter isRowid is non-zero, then expression pExpr is guaranteed
148941a05b7bSdanielk1977 ** to be of the form "<rowid> IN (?, ?, ?)", where <rowid> is a reference
149041a05b7bSdanielk1977 ** to some integer key column of a table B-Tree. In this case, use an
149141a05b7bSdanielk1977 ** intkey B-Tree to store the set of IN(...) values instead of the usual
149241a05b7bSdanielk1977 ** (slower) variable length keys B-Tree.
1493cce7d176Sdrh */
149451522cd3Sdrh #ifndef SQLITE_OMIT_SUBQUERY
149541a05b7bSdanielk1977 void sqlite3CodeSubselect(
149641a05b7bSdanielk1977   Parse *pParse,
149741a05b7bSdanielk1977   Expr *pExpr,
149841a05b7bSdanielk1977   int rMayHaveNull,
149941a05b7bSdanielk1977   int isRowid
150041a05b7bSdanielk1977 ){
150157dbd7b3Sdrh   int testAddr = 0;                       /* One-time test address */
1502b3bce662Sdanielk1977   Vdbe *v = sqlite3GetVdbe(pParse);
1503b3bce662Sdanielk1977   if( v==0 ) return;
1504ceea3321Sdrh   sqlite3ExprCachePush(pParse);
1505fc976065Sdanielk1977 
150657dbd7b3Sdrh   /* This code must be run in its entirety every time it is encountered
150757dbd7b3Sdrh   ** if any of the following is true:
150857dbd7b3Sdrh   **
150957dbd7b3Sdrh   **    *  The right-hand side is a correlated subquery
151057dbd7b3Sdrh   **    *  The right-hand side is an expression list containing variables
151157dbd7b3Sdrh   **    *  We are inside a trigger
151257dbd7b3Sdrh   **
151357dbd7b3Sdrh   ** If all of the above are false, then we can run this code just once
151457dbd7b3Sdrh   ** save the results, and reuse the same result on subsequent invocations.
1515b3bce662Sdanielk1977   */
1516b3bce662Sdanielk1977   if( !ExprHasAnyProperty(pExpr, EP_VarSelect) && !pParse->trigStack ){
15170a07c107Sdrh     int mem = ++pParse->nMem;
1518892d3179Sdrh     sqlite3VdbeAddOp1(v, OP_If, mem);
1519892d3179Sdrh     testAddr = sqlite3VdbeAddOp2(v, OP_Integer, 1, mem);
152017435752Sdrh     assert( testAddr>0 || pParse->db->mallocFailed );
1521b3bce662Sdanielk1977   }
1522b3bce662Sdanielk1977 
1523cce7d176Sdrh   switch( pExpr->op ){
1524fef5208cSdrh     case TK_IN: {
1525e014a838Sdanielk1977       char affinity;
1526d3d39e93Sdrh       KeyInfo keyInfo;
1527b9bb7c18Sdrh       int addr;        /* Address of OP_OpenEphemeral instruction */
152841a05b7bSdanielk1977       Expr *pLeft = pExpr->pLeft;
1529d3d39e93Sdrh 
15300cdc022eSdanielk1977       if( rMayHaveNull ){
15310cdc022eSdanielk1977         sqlite3VdbeAddOp2(v, OP_Null, 0, rMayHaveNull);
15320cdc022eSdanielk1977       }
15330cdc022eSdanielk1977 
153441a05b7bSdanielk1977       affinity = sqlite3ExprAffinity(pLeft);
1535e014a838Sdanielk1977 
1536e014a838Sdanielk1977       /* Whether this is an 'x IN(SELECT...)' or an 'x IN(<exprlist>)'
153757dbd7b3Sdrh       ** expression it is handled the same way. A virtual table is
1538e014a838Sdanielk1977       ** filled with single-field index keys representing the results
1539e014a838Sdanielk1977       ** from the SELECT or the <exprlist>.
1540fef5208cSdrh       **
1541e014a838Sdanielk1977       ** If the 'x' expression is a column value, or the SELECT...
1542e014a838Sdanielk1977       ** statement returns a column value, then the affinity of that
1543e014a838Sdanielk1977       ** column is used to build the index keys. If both 'x' and the
1544e014a838Sdanielk1977       ** SELECT... statement are columns, then numeric affinity is used
1545e014a838Sdanielk1977       ** if either column has NUMERIC or INTEGER affinity. If neither
1546e014a838Sdanielk1977       ** 'x' nor the SELECT... statement are columns, then numeric affinity
1547e014a838Sdanielk1977       ** is used.
1548fef5208cSdrh       */
1549832508b7Sdrh       pExpr->iTable = pParse->nTab++;
155041a05b7bSdanielk1977       addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, pExpr->iTable, !isRowid);
1551d3d39e93Sdrh       memset(&keyInfo, 0, sizeof(keyInfo));
1552d3d39e93Sdrh       keyInfo.nField = 1;
1553e014a838Sdanielk1977 
15546ab3a2ecSdanielk1977       if( ExprHasProperty(pExpr, EP_xIsSelect) ){
1555e014a838Sdanielk1977         /* Case 1:     expr IN (SELECT ...)
1556e014a838Sdanielk1977         **
1557e014a838Sdanielk1977         ** Generate code to write the results of the select into the temporary
1558e014a838Sdanielk1977         ** table allocated and opened above.
1559e014a838Sdanielk1977         */
15601013c932Sdrh         SelectDest dest;
1561be5c89acSdrh         ExprList *pEList;
15621013c932Sdrh 
156341a05b7bSdanielk1977         assert( !isRowid );
15641013c932Sdrh         sqlite3SelectDestInit(&dest, SRT_Set, pExpr->iTable);
15651bd10f8aSdrh         dest.affinity = (u8)affinity;
1566e014a838Sdanielk1977         assert( (pExpr->iTable&0x0000FFFF)==pExpr->iTable );
15676ab3a2ecSdanielk1977         if( sqlite3Select(pParse, pExpr->x.pSelect, &dest) ){
156894ccde58Sdrh           return;
156994ccde58Sdrh         }
15706ab3a2ecSdanielk1977         pEList = pExpr->x.pSelect->pEList;
1571be5c89acSdrh         if( pEList && pEList->nExpr>0 ){
1572bcbb04e5Sdanielk1977           keyInfo.aColl[0] = sqlite3BinaryCompareCollSeq(pParse, pExpr->pLeft,
1573be5c89acSdrh               pEList->a[0].pExpr);
15740202b29eSdanielk1977         }
15756ab3a2ecSdanielk1977       }else if( pExpr->x.pList ){
1576fef5208cSdrh         /* Case 2:     expr IN (exprlist)
1577fef5208cSdrh         **
1578e014a838Sdanielk1977         ** For each expression, build an index key from the evaluation and
1579e014a838Sdanielk1977         ** store it in the temporary table. If <expr> is a column, then use
1580e014a838Sdanielk1977         ** that columns affinity when building index keys. If <expr> is not
1581e014a838Sdanielk1977         ** a column, use numeric affinity.
1582fef5208cSdrh         */
1583e014a838Sdanielk1977         int i;
15846ab3a2ecSdanielk1977         ExprList *pList = pExpr->x.pList;
158557dbd7b3Sdrh         struct ExprList_item *pItem;
1586ecc31805Sdrh         int r1, r2, r3;
158757dbd7b3Sdrh 
1588e014a838Sdanielk1977         if( !affinity ){
15898159a35fSdrh           affinity = SQLITE_AFF_NONE;
1590e014a838Sdanielk1977         }
15917d10d5a6Sdrh         keyInfo.aColl[0] = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
1592e014a838Sdanielk1977 
1593e014a838Sdanielk1977         /* Loop through each expression in <exprlist>. */
15942d401ab8Sdrh         r1 = sqlite3GetTempReg(pParse);
15952d401ab8Sdrh         r2 = sqlite3GetTempReg(pParse);
15964e7f36a2Sdanielk1977         sqlite3VdbeAddOp2(v, OP_Null, 0, r2);
159757dbd7b3Sdrh         for(i=pList->nExpr, pItem=pList->a; i>0; i--, pItem++){
159857dbd7b3Sdrh           Expr *pE2 = pItem->pExpr;
1599e014a838Sdanielk1977 
160057dbd7b3Sdrh           /* If the expression is not constant then we will need to
160157dbd7b3Sdrh           ** disable the test that was generated above that makes sure
160257dbd7b3Sdrh           ** this code only executes once.  Because for a non-constant
160357dbd7b3Sdrh           ** expression we need to rerun this code each time.
160457dbd7b3Sdrh           */
1605892d3179Sdrh           if( testAddr && !sqlite3ExprIsConstant(pE2) ){
1606892d3179Sdrh             sqlite3VdbeChangeToNoop(v, testAddr-1, 2);
160757dbd7b3Sdrh             testAddr = 0;
16084794b980Sdrh           }
1609e014a838Sdanielk1977 
1610e014a838Sdanielk1977           /* Evaluate the expression and insert it into the temp table */
1611ecc31805Sdrh           r3 = sqlite3ExprCodeTarget(pParse, pE2, r1);
161241a05b7bSdanielk1977           if( isRowid ){
161341a05b7bSdanielk1977             sqlite3VdbeAddOp2(v, OP_MustBeInt, r3, sqlite3VdbeCurrentAddr(v)+2);
161441a05b7bSdanielk1977             sqlite3VdbeAddOp3(v, OP_Insert, pExpr->iTable, r2, r3);
161541a05b7bSdanielk1977           }else{
1616ecc31805Sdrh             sqlite3VdbeAddOp4(v, OP_MakeRecord, r3, 1, r2, &affinity, 1);
16173c31fc23Sdrh             sqlite3ExprCacheAffinityChange(pParse, r3, 1);
16182d401ab8Sdrh             sqlite3VdbeAddOp2(v, OP_IdxInsert, pExpr->iTable, r2);
1619fef5208cSdrh           }
162041a05b7bSdanielk1977         }
16212d401ab8Sdrh         sqlite3ReleaseTempReg(pParse, r1);
16222d401ab8Sdrh         sqlite3ReleaseTempReg(pParse, r2);
1623fef5208cSdrh       }
162441a05b7bSdanielk1977       if( !isRowid ){
162566a5167bSdrh         sqlite3VdbeChangeP4(v, addr, (void *)&keyInfo, P4_KEYINFO);
162641a05b7bSdanielk1977       }
1627b3bce662Sdanielk1977       break;
1628fef5208cSdrh     }
1629fef5208cSdrh 
163051522cd3Sdrh     case TK_EXISTS:
163119a775c2Sdrh     case TK_SELECT: {
1632fef5208cSdrh       /* This has to be a scalar SELECT.  Generate code to put the
1633fef5208cSdrh       ** value of this select in a memory cell and record the number
1634967e8b73Sdrh       ** of the memory cell in iColumn.
1635fef5208cSdrh       */
1636b7916a78Sdrh       static const Token one = { "1", 1 };
163751522cd3Sdrh       Select *pSel;
16386c8c8ce0Sdanielk1977       SelectDest dest;
16391398ad36Sdrh 
16406ab3a2ecSdanielk1977       assert( ExprHasProperty(pExpr, EP_xIsSelect) );
16416ab3a2ecSdanielk1977       pSel = pExpr->x.pSelect;
16421013c932Sdrh       sqlite3SelectDestInit(&dest, 0, ++pParse->nMem);
164351522cd3Sdrh       if( pExpr->op==TK_SELECT ){
16446c8c8ce0Sdanielk1977         dest.eDest = SRT_Mem;
16454c583128Sdrh         sqlite3VdbeAddOp2(v, OP_Null, 0, dest.iParm);
1646d4e70ebdSdrh         VdbeComment((v, "Init subquery result"));
164751522cd3Sdrh       }else{
16486c8c8ce0Sdanielk1977         dest.eDest = SRT_Exists;
16494c583128Sdrh         sqlite3VdbeAddOp2(v, OP_Integer, 0, dest.iParm);
1650d4e70ebdSdrh         VdbeComment((v, "Init EXISTS result"));
165151522cd3Sdrh       }
1652633e6d57Sdrh       sqlite3ExprDelete(pParse->db, pSel->pLimit);
1653a1644fd8Sdanielk1977       pSel->pLimit = sqlite3PExpr(pParse, TK_INTEGER, 0, 0, &one);
16547d10d5a6Sdrh       if( sqlite3Select(pParse, pSel, &dest) ){
165594ccde58Sdrh         return;
165694ccde58Sdrh       }
16576c8c8ce0Sdanielk1977       pExpr->iColumn = dest.iParm;
1658*33e619fcSdrh       ExprSetIrreducible(pExpr);
1659b3bce662Sdanielk1977       break;
166019a775c2Sdrh     }
1661cce7d176Sdrh   }
1662b3bce662Sdanielk1977 
166357dbd7b3Sdrh   if( testAddr ){
1664892d3179Sdrh     sqlite3VdbeJumpHere(v, testAddr-1);
1665b3bce662Sdanielk1977   }
1666ceea3321Sdrh   sqlite3ExprCachePop(pParse, 1);
1667fc976065Sdanielk1977 
1668b3bce662Sdanielk1977   return;
1669cce7d176Sdrh }
167051522cd3Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
1671cce7d176Sdrh 
1672cce7d176Sdrh /*
1673598f1340Sdrh ** Duplicate an 8-byte value
1674598f1340Sdrh */
1675598f1340Sdrh static char *dup8bytes(Vdbe *v, const char *in){
1676598f1340Sdrh   char *out = sqlite3DbMallocRaw(sqlite3VdbeDb(v), 8);
1677598f1340Sdrh   if( out ){
1678598f1340Sdrh     memcpy(out, in, 8);
1679598f1340Sdrh   }
1680598f1340Sdrh   return out;
1681598f1340Sdrh }
1682598f1340Sdrh 
1683598f1340Sdrh /*
1684598f1340Sdrh ** Generate an instruction that will put the floating point
16859cbf3425Sdrh ** value described by z[0..n-1] into register iMem.
16860cf19ed8Sdrh **
16870cf19ed8Sdrh ** The z[] string will probably not be zero-terminated.  But the
16880cf19ed8Sdrh ** z[n] character is guaranteed to be something that does not look
16890cf19ed8Sdrh ** like the continuation of the number.
1690598f1340Sdrh */
1691b7916a78Sdrh static void codeReal(Vdbe *v, const char *z, int negateFlag, int iMem){
1692598f1340Sdrh   assert( z || v==0 || sqlite3VdbeDb(v)->mallocFailed );
1693598f1340Sdrh   if( z ){
1694598f1340Sdrh     double value;
1695598f1340Sdrh     char *zV;
1696598f1340Sdrh     sqlite3AtoF(z, &value);
16972eaf93d3Sdrh     if( sqlite3IsNaN(value) ){
16982eaf93d3Sdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, iMem);
16992eaf93d3Sdrh     }else{
1700598f1340Sdrh       if( negateFlag ) value = -value;
1701598f1340Sdrh       zV = dup8bytes(v, (char*)&value);
17029de221dfSdrh       sqlite3VdbeAddOp4(v, OP_Real, 0, iMem, 0, zV, P4_REAL);
1703598f1340Sdrh     }
1704598f1340Sdrh   }
17052eaf93d3Sdrh }
1706598f1340Sdrh 
1707598f1340Sdrh 
1708598f1340Sdrh /*
1709fec19aadSdrh ** Generate an instruction that will put the integer describe by
17109cbf3425Sdrh ** text z[0..n-1] into register iMem.
17110cf19ed8Sdrh **
17120cf19ed8Sdrh ** The z[] string will probably not be zero-terminated.  But the
17130cf19ed8Sdrh ** z[n] character is guaranteed to be something that does not look
17140cf19ed8Sdrh ** like the continuation of the number.
1715fec19aadSdrh */
171692b01d53Sdrh static void codeInteger(Vdbe *v, Expr *pExpr, int negFlag, int iMem){
171792b01d53Sdrh   const char *z;
171892b01d53Sdrh   if( pExpr->flags & EP_IntValue ){
1719*33e619fcSdrh     int i = pExpr->u.iValue;
172092b01d53Sdrh     if( negFlag ) i = -i;
172192b01d53Sdrh     sqlite3VdbeAddOp2(v, OP_Integer, i, iMem);
1722*33e619fcSdrh   }else if( (z = pExpr->u.zToken)!=0 ){
1723fec19aadSdrh     int i;
1724*33e619fcSdrh     int n = sqlite3Strlen30(pExpr->u.zToken);
172578ca0e7eSdanielk1977     assert( !sqlite3Isdigit(z[n]) );
17266fec0762Sdrh     if( sqlite3GetInt32(z, &i) ){
17279de221dfSdrh       if( negFlag ) i = -i;
17289de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Integer, i, iMem);
17299de221dfSdrh     }else if( sqlite3FitsIn64Bits(z, negFlag) ){
1730598f1340Sdrh       i64 value;
1731598f1340Sdrh       char *zV;
1732598f1340Sdrh       sqlite3Atoi64(z, &value);
17339de221dfSdrh       if( negFlag ) value = -value;
1734598f1340Sdrh       zV = dup8bytes(v, (char*)&value);
17359de221dfSdrh       sqlite3VdbeAddOp4(v, OP_Int64, 0, iMem, 0, zV, P4_INT64);
1736fec19aadSdrh     }else{
1737b7916a78Sdrh       codeReal(v, z, negFlag, iMem);
1738fec19aadSdrh     }
1739fec19aadSdrh   }
1740c9cf901dSdanielk1977 }
1741fec19aadSdrh 
1742ceea3321Sdrh /*
1743ceea3321Sdrh ** Clear a cache entry.
1744ceea3321Sdrh */
1745ceea3321Sdrh static void cacheEntryClear(Parse *pParse, struct yColCache *p){
1746ceea3321Sdrh   if( p->tempReg ){
1747ceea3321Sdrh     if( pParse->nTempReg<ArraySize(pParse->aTempReg) ){
1748ceea3321Sdrh       pParse->aTempReg[pParse->nTempReg++] = p->iReg;
1749ceea3321Sdrh     }
1750ceea3321Sdrh     p->tempReg = 0;
1751ceea3321Sdrh   }
1752ceea3321Sdrh }
1753ceea3321Sdrh 
1754ceea3321Sdrh 
1755ceea3321Sdrh /*
1756ceea3321Sdrh ** Record in the column cache that a particular column from a
1757ceea3321Sdrh ** particular table is stored in a particular register.
1758ceea3321Sdrh */
1759ceea3321Sdrh void sqlite3ExprCacheStore(Parse *pParse, int iTab, int iCol, int iReg){
1760ceea3321Sdrh   int i;
1761ceea3321Sdrh   int minLru;
1762ceea3321Sdrh   int idxLru;
1763ceea3321Sdrh   struct yColCache *p;
1764ceea3321Sdrh 
1765ceea3321Sdrh   /* First replace any existing entry */
1766ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
1767ceea3321Sdrh     if( p->iReg && p->iTable==iTab && p->iColumn==iCol ){
1768ceea3321Sdrh       cacheEntryClear(pParse, p);
1769ceea3321Sdrh       p->iLevel = pParse->iCacheLevel;
1770ceea3321Sdrh       p->iReg = iReg;
1771ceea3321Sdrh       p->affChange = 0;
1772ceea3321Sdrh       p->lru = pParse->iCacheCnt++;
1773ceea3321Sdrh       return;
1774ceea3321Sdrh     }
1775ceea3321Sdrh   }
1776ceea3321Sdrh   if( iReg<=0 ) return;
1777ceea3321Sdrh 
1778ceea3321Sdrh   /* Find an empty slot and replace it */
1779ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
1780ceea3321Sdrh     if( p->iReg==0 ){
1781ceea3321Sdrh       p->iLevel = pParse->iCacheLevel;
1782ceea3321Sdrh       p->iTable = iTab;
1783ceea3321Sdrh       p->iColumn = iCol;
1784ceea3321Sdrh       p->iReg = iReg;
1785ceea3321Sdrh       p->affChange = 0;
1786ceea3321Sdrh       p->tempReg = 0;
1787ceea3321Sdrh       p->lru = pParse->iCacheCnt++;
1788ceea3321Sdrh       return;
1789ceea3321Sdrh     }
1790ceea3321Sdrh   }
1791ceea3321Sdrh 
1792ceea3321Sdrh   /* Replace the last recently used */
1793ceea3321Sdrh   minLru = 0x7fffffff;
1794ceea3321Sdrh   idxLru = -1;
1795ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
1796ceea3321Sdrh     if( p->lru<minLru ){
1797ceea3321Sdrh       idxLru = i;
1798ceea3321Sdrh       minLru = p->lru;
1799ceea3321Sdrh     }
1800ceea3321Sdrh   }
1801ceea3321Sdrh   if( idxLru>=0 ){
1802ceea3321Sdrh     p = &pParse->aColCache[idxLru];
1803ceea3321Sdrh     p->iLevel = pParse->iCacheLevel;
1804ceea3321Sdrh     p->iTable = iTab;
1805ceea3321Sdrh     p->iColumn = iCol;
1806ceea3321Sdrh     p->iReg = iReg;
1807ceea3321Sdrh     p->affChange = 0;
1808ceea3321Sdrh     p->tempReg = 0;
1809ceea3321Sdrh     p->lru = pParse->iCacheCnt++;
1810ceea3321Sdrh     return;
1811ceea3321Sdrh   }
1812ceea3321Sdrh }
1813ceea3321Sdrh 
1814ceea3321Sdrh /*
1815ceea3321Sdrh ** Indicate that a register is being overwritten.  Purge the register
1816ceea3321Sdrh ** from the column cache.
1817ceea3321Sdrh */
1818ceea3321Sdrh void sqlite3ExprCacheRemove(Parse *pParse, int iReg){
1819ceea3321Sdrh   int i;
1820ceea3321Sdrh   struct yColCache *p;
1821ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
1822ceea3321Sdrh     if( p->iReg==iReg ){
1823ceea3321Sdrh       cacheEntryClear(pParse, p);
1824ceea3321Sdrh       p->iReg = 0;
1825ceea3321Sdrh     }
1826ceea3321Sdrh   }
1827ceea3321Sdrh }
1828ceea3321Sdrh 
1829ceea3321Sdrh /*
1830ceea3321Sdrh ** Remember the current column cache context.  Any new entries added
1831ceea3321Sdrh ** added to the column cache after this call are removed when the
1832ceea3321Sdrh ** corresponding pop occurs.
1833ceea3321Sdrh */
1834ceea3321Sdrh void sqlite3ExprCachePush(Parse *pParse){
1835ceea3321Sdrh   pParse->iCacheLevel++;
1836ceea3321Sdrh }
1837ceea3321Sdrh 
1838ceea3321Sdrh /*
1839ceea3321Sdrh ** Remove from the column cache any entries that were added since the
1840ceea3321Sdrh ** the previous N Push operations.  In other words, restore the cache
1841ceea3321Sdrh ** to the state it was in N Pushes ago.
1842ceea3321Sdrh */
1843ceea3321Sdrh void sqlite3ExprCachePop(Parse *pParse, int N){
1844ceea3321Sdrh   int i;
1845ceea3321Sdrh   struct yColCache *p;
1846ceea3321Sdrh   assert( N>0 );
1847ceea3321Sdrh   assert( pParse->iCacheLevel>=N );
1848ceea3321Sdrh   pParse->iCacheLevel -= N;
1849ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
1850ceea3321Sdrh     if( p->iReg && p->iLevel>pParse->iCacheLevel ){
1851ceea3321Sdrh       cacheEntryClear(pParse, p);
1852ceea3321Sdrh       p->iReg = 0;
1853ceea3321Sdrh     }
1854ceea3321Sdrh   }
1855ceea3321Sdrh }
1856945498f3Sdrh 
1857945498f3Sdrh /*
18585cd79239Sdrh ** When a cached column is reused, make sure that its register is
18595cd79239Sdrh ** no longer available as a temp register.  ticket #3879:  that same
18605cd79239Sdrh ** register might be in the cache in multiple places, so be sure to
18615cd79239Sdrh ** get them all.
18625cd79239Sdrh */
18635cd79239Sdrh static void sqlite3ExprCachePinRegister(Parse *pParse, int iReg){
18645cd79239Sdrh   int i;
18655cd79239Sdrh   struct yColCache *p;
18665cd79239Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
18675cd79239Sdrh     if( p->iReg==iReg ){
18685cd79239Sdrh       p->tempReg = 0;
18695cd79239Sdrh     }
18705cd79239Sdrh   }
18715cd79239Sdrh }
18725cd79239Sdrh 
18735cd79239Sdrh /*
1874945498f3Sdrh ** Generate code that will extract the iColumn-th column from
1875e55cbd72Sdrh ** table pTab and store the column value in a register.  An effort
1876e55cbd72Sdrh ** is made to store the column value in register iReg, but this is
1877e55cbd72Sdrh ** not guaranteed.  The location of the column value is returned.
1878e55cbd72Sdrh **
1879e55cbd72Sdrh ** There must be an open cursor to pTab in iTable when this routine
1880e55cbd72Sdrh ** is called.  If iColumn<0 then code is generated that extracts the rowid.
1881da250ea5Sdrh **
1882da250ea5Sdrh ** This routine might attempt to reuse the value of the column that
1883da250ea5Sdrh ** has already been loaded into a register.  The value will always
1884da250ea5Sdrh ** be used if it has not undergone any affinity changes.  But if
1885da250ea5Sdrh ** an affinity change has occurred, then the cached value will only be
1886da250ea5Sdrh ** used if allowAffChng is true.
1887945498f3Sdrh */
1888e55cbd72Sdrh int sqlite3ExprCodeGetColumn(
1889e55cbd72Sdrh   Parse *pParse,   /* Parsing and code generating context */
18902133d822Sdrh   Table *pTab,     /* Description of the table we are reading from */
18912133d822Sdrh   int iColumn,     /* Index of the table column */
18922133d822Sdrh   int iTable,      /* The cursor pointing to the table */
1893da250ea5Sdrh   int iReg,        /* Store results here */
1894da250ea5Sdrh   int allowAffChng /* True if prior affinity changes are OK */
18952133d822Sdrh ){
1896e55cbd72Sdrh   Vdbe *v = pParse->pVdbe;
1897e55cbd72Sdrh   int i;
1898da250ea5Sdrh   struct yColCache *p;
1899e55cbd72Sdrh 
1900ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
1901ceea3321Sdrh     if( p->iReg>0 && p->iTable==iTable && p->iColumn==iColumn
1902da250ea5Sdrh            && (!p->affChange || allowAffChng) ){
1903e55cbd72Sdrh #if 0
1904e55cbd72Sdrh       sqlite3VdbeAddOp0(v, OP_Noop);
1905da250ea5Sdrh       VdbeComment((v, "OPT: tab%d.col%d -> r%d", iTable, iColumn, p->iReg));
1906e55cbd72Sdrh #endif
1907ceea3321Sdrh       p->lru = pParse->iCacheCnt++;
19085cd79239Sdrh       sqlite3ExprCachePinRegister(pParse, p->iReg);
1909da250ea5Sdrh       return p->iReg;
1910e55cbd72Sdrh     }
1911e55cbd72Sdrh   }
1912e55cbd72Sdrh   assert( v!=0 );
1913945498f3Sdrh   if( iColumn<0 ){
1914044925beSdrh     sqlite3VdbeAddOp2(v, OP_Rowid, iTable, iReg);
1915945498f3Sdrh   }else if( pTab==0 ){
19162133d822Sdrh     sqlite3VdbeAddOp3(v, OP_Column, iTable, iColumn, iReg);
1917945498f3Sdrh   }else{
1918945498f3Sdrh     int op = IsVirtual(pTab) ? OP_VColumn : OP_Column;
19192133d822Sdrh     sqlite3VdbeAddOp3(v, op, iTable, iColumn, iReg);
1920945498f3Sdrh     sqlite3ColumnDefault(v, pTab, iColumn);
1921945498f3Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
1922945498f3Sdrh     if( pTab->aCol[iColumn].affinity==SQLITE_AFF_REAL ){
19232133d822Sdrh       sqlite3VdbeAddOp1(v, OP_RealAffinity, iReg);
1924945498f3Sdrh     }
1925945498f3Sdrh #endif
1926945498f3Sdrh   }
1927ceea3321Sdrh   sqlite3ExprCacheStore(pParse, iTable, iColumn, iReg);
1928e55cbd72Sdrh   return iReg;
1929e55cbd72Sdrh }
1930e55cbd72Sdrh 
1931e55cbd72Sdrh /*
1932ceea3321Sdrh ** Clear all column cache entries.
1933e55cbd72Sdrh */
1934ceea3321Sdrh void sqlite3ExprCacheClear(Parse *pParse){
1935e55cbd72Sdrh   int i;
1936ceea3321Sdrh   struct yColCache *p;
1937ceea3321Sdrh 
1938ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
1939ceea3321Sdrh     if( p->iReg ){
1940ceea3321Sdrh       cacheEntryClear(pParse, p);
1941ceea3321Sdrh       p->iReg = 0;
1942e55cbd72Sdrh     }
1943da250ea5Sdrh   }
1944da250ea5Sdrh }
1945e55cbd72Sdrh 
1946e55cbd72Sdrh /*
1947da250ea5Sdrh ** Record the fact that an affinity change has occurred on iCount
1948da250ea5Sdrh ** registers starting with iStart.
1949e55cbd72Sdrh */
1950da250ea5Sdrh void sqlite3ExprCacheAffinityChange(Parse *pParse, int iStart, int iCount){
1951da250ea5Sdrh   int iEnd = iStart + iCount - 1;
1952e55cbd72Sdrh   int i;
1953ceea3321Sdrh   struct yColCache *p;
1954ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
1955ceea3321Sdrh     int r = p->iReg;
1956da250ea5Sdrh     if( r>=iStart && r<=iEnd ){
1957ceea3321Sdrh       p->affChange = 1;
1958e55cbd72Sdrh     }
1959e55cbd72Sdrh   }
1960e55cbd72Sdrh }
1961e55cbd72Sdrh 
1962e55cbd72Sdrh /*
1963b21e7c70Sdrh ** Generate code to move content from registers iFrom...iFrom+nReg-1
1964b21e7c70Sdrh ** over to iTo..iTo+nReg-1. Keep the column cache up-to-date.
1965e55cbd72Sdrh */
1966b21e7c70Sdrh void sqlite3ExprCodeMove(Parse *pParse, int iFrom, int iTo, int nReg){
1967e55cbd72Sdrh   int i;
1968ceea3321Sdrh   struct yColCache *p;
1969e55cbd72Sdrh   if( iFrom==iTo ) return;
1970b21e7c70Sdrh   sqlite3VdbeAddOp3(pParse->pVdbe, OP_Move, iFrom, iTo, nReg);
1971ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
1972ceea3321Sdrh     int x = p->iReg;
1973b21e7c70Sdrh     if( x>=iFrom && x<iFrom+nReg ){
1974ceea3321Sdrh       p->iReg += iTo-iFrom;
1975e55cbd72Sdrh     }
1976e55cbd72Sdrh   }
1977945498f3Sdrh }
1978945498f3Sdrh 
1979fec19aadSdrh /*
198092b01d53Sdrh ** Generate code to copy content from registers iFrom...iFrom+nReg-1
198192b01d53Sdrh ** over to iTo..iTo+nReg-1.
198292b01d53Sdrh */
198392b01d53Sdrh void sqlite3ExprCodeCopy(Parse *pParse, int iFrom, int iTo, int nReg){
198492b01d53Sdrh   int i;
198592b01d53Sdrh   if( iFrom==iTo ) return;
198692b01d53Sdrh   for(i=0; i<nReg; i++){
198792b01d53Sdrh     sqlite3VdbeAddOp2(pParse->pVdbe, OP_Copy, iFrom+i, iTo+i);
198892b01d53Sdrh   }
198992b01d53Sdrh }
199092b01d53Sdrh 
199192b01d53Sdrh /*
1992652fbf55Sdrh ** Return true if any register in the range iFrom..iTo (inclusive)
1993652fbf55Sdrh ** is used as part of the column cache.
1994652fbf55Sdrh */
1995652fbf55Sdrh static int usedAsColumnCache(Parse *pParse, int iFrom, int iTo){
1996652fbf55Sdrh   int i;
1997ceea3321Sdrh   struct yColCache *p;
1998ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
1999ceea3321Sdrh     int r = p->iReg;
2000652fbf55Sdrh     if( r>=iFrom && r<=iTo ) return 1;
2001652fbf55Sdrh   }
2002652fbf55Sdrh   return 0;
2003652fbf55Sdrh }
2004652fbf55Sdrh 
2005652fbf55Sdrh /*
2006191b54cbSdrh ** If the last instruction coded is an ephemeral copy of any of
2007191b54cbSdrh ** the registers in the nReg registers beginning with iReg, then
2008191b54cbSdrh ** convert the last instruction from OP_SCopy to OP_Copy.
2009191b54cbSdrh */
2010191b54cbSdrh void sqlite3ExprHardCopy(Parse *pParse, int iReg, int nReg){
2011191b54cbSdrh   int addr;
2012191b54cbSdrh   VdbeOp *pOp;
2013191b54cbSdrh   Vdbe *v;
2014191b54cbSdrh 
2015191b54cbSdrh   v = pParse->pVdbe;
2016191b54cbSdrh   addr = sqlite3VdbeCurrentAddr(v);
2017191b54cbSdrh   pOp = sqlite3VdbeGetOp(v, addr-1);
2018d7eb2ed5Sdanielk1977   assert( pOp || pParse->db->mallocFailed );
2019d7eb2ed5Sdanielk1977   if( pOp && pOp->opcode==OP_SCopy && pOp->p1>=iReg && pOp->p1<iReg+nReg ){
2020191b54cbSdrh     pOp->opcode = OP_Copy;
2021191b54cbSdrh   }
2022191b54cbSdrh }
2023191b54cbSdrh 
2024191b54cbSdrh /*
20258b213899Sdrh ** Generate code to store the value of the iAlias-th alias in register
20268b213899Sdrh ** target.  The first time this is called, pExpr is evaluated to compute
20278b213899Sdrh ** the value of the alias.  The value is stored in an auxiliary register
20288b213899Sdrh ** and the number of that register is returned.  On subsequent calls,
20298b213899Sdrh ** the register number is returned without generating any code.
20308b213899Sdrh **
20318b213899Sdrh ** Note that in order for this to work, code must be generated in the
20328b213899Sdrh ** same order that it is executed.
20338b213899Sdrh **
20348b213899Sdrh ** Aliases are numbered starting with 1.  So iAlias is in the range
20358b213899Sdrh ** of 1 to pParse->nAlias inclusive.
20368b213899Sdrh **
20378b213899Sdrh ** pParse->aAlias[iAlias-1] records the register number where the value
20388b213899Sdrh ** of the iAlias-th alias is stored.  If zero, that means that the
20398b213899Sdrh ** alias has not yet been computed.
20408b213899Sdrh */
204131daa63fSdrh static int codeAlias(Parse *pParse, int iAlias, Expr *pExpr, int target){
2042ceea3321Sdrh #if 0
20438b213899Sdrh   sqlite3 *db = pParse->db;
20448b213899Sdrh   int iReg;
2045555f8de7Sdrh   if( pParse->nAliasAlloc<pParse->nAlias ){
2046555f8de7Sdrh     pParse->aAlias = sqlite3DbReallocOrFree(db, pParse->aAlias,
20478b213899Sdrh                                  sizeof(pParse->aAlias[0])*pParse->nAlias );
2048555f8de7Sdrh     testcase( db->mallocFailed && pParse->nAliasAlloc>0 );
20498b213899Sdrh     if( db->mallocFailed ) return 0;
2050555f8de7Sdrh     memset(&pParse->aAlias[pParse->nAliasAlloc], 0,
2051555f8de7Sdrh            (pParse->nAlias-pParse->nAliasAlloc)*sizeof(pParse->aAlias[0]));
2052555f8de7Sdrh     pParse->nAliasAlloc = pParse->nAlias;
20538b213899Sdrh   }
20548b213899Sdrh   assert( iAlias>0 && iAlias<=pParse->nAlias );
20558b213899Sdrh   iReg = pParse->aAlias[iAlias-1];
20568b213899Sdrh   if( iReg==0 ){
2057ceea3321Sdrh     if( pParse->iCacheLevel>0 ){
205831daa63fSdrh       iReg = sqlite3ExprCodeTarget(pParse, pExpr, target);
205931daa63fSdrh     }else{
20608b213899Sdrh       iReg = ++pParse->nMem;
20618b213899Sdrh       sqlite3ExprCode(pParse, pExpr, iReg);
20628b213899Sdrh       pParse->aAlias[iAlias-1] = iReg;
20638b213899Sdrh     }
206431daa63fSdrh   }
20658b213899Sdrh   return iReg;
2066ceea3321Sdrh #else
206760a4b538Sshane   UNUSED_PARAMETER(iAlias);
2068ceea3321Sdrh   return sqlite3ExprCodeTarget(pParse, pExpr, target);
2069ceea3321Sdrh #endif
20708b213899Sdrh }
20718b213899Sdrh 
20728b213899Sdrh /*
2073cce7d176Sdrh ** Generate code into the current Vdbe to evaluate the given
20742dcef11bSdrh ** expression.  Attempt to store the results in register "target".
20752dcef11bSdrh ** Return the register where results are stored.
2076389a1adbSdrh **
20778b213899Sdrh ** With this routine, there is no guarantee that results will
20782dcef11bSdrh ** be stored in target.  The result might be stored in some other
20792dcef11bSdrh ** register if it is convenient to do so.  The calling function
20802dcef11bSdrh ** must check the return code and move the results to the desired
20812dcef11bSdrh ** register.
2082cce7d176Sdrh */
2083678ccce8Sdrh int sqlite3ExprCodeTarget(Parse *pParse, Expr *pExpr, int target){
20842dcef11bSdrh   Vdbe *v = pParse->pVdbe;  /* The VM under construction */
20852dcef11bSdrh   int op;                   /* The opcode being coded */
20862dcef11bSdrh   int inReg = target;       /* Results stored in register inReg */
20872dcef11bSdrh   int regFree1 = 0;         /* If non-zero free this temporary register */
20882dcef11bSdrh   int regFree2 = 0;         /* If non-zero free this temporary register */
2089678ccce8Sdrh   int r1, r2, r3, r4;       /* Various register numbers */
20908b213899Sdrh   sqlite3 *db;
2091ffe07b2dSdrh 
20928b213899Sdrh   db = pParse->db;
20938b213899Sdrh   assert( v!=0 || db->mallocFailed );
20949cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
2095389a1adbSdrh   if( v==0 ) return 0;
2096389a1adbSdrh 
2097389a1adbSdrh   if( pExpr==0 ){
2098389a1adbSdrh     op = TK_NULL;
2099389a1adbSdrh   }else{
2100f2bc013cSdrh     op = pExpr->op;
2101389a1adbSdrh   }
2102f2bc013cSdrh   switch( op ){
210313449892Sdrh     case TK_AGG_COLUMN: {
210413449892Sdrh       AggInfo *pAggInfo = pExpr->pAggInfo;
210513449892Sdrh       struct AggInfo_col *pCol = &pAggInfo->aCol[pExpr->iAgg];
210613449892Sdrh       if( !pAggInfo->directMode ){
21079de221dfSdrh         assert( pCol->iMem>0 );
21089de221dfSdrh         inReg = pCol->iMem;
210913449892Sdrh         break;
211013449892Sdrh       }else if( pAggInfo->useSortingIdx ){
2111389a1adbSdrh         sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdx,
2112389a1adbSdrh                               pCol->iSorterColumn, target);
211313449892Sdrh         break;
211413449892Sdrh       }
211513449892Sdrh       /* Otherwise, fall thru into the TK_COLUMN case */
211613449892Sdrh     }
2117967e8b73Sdrh     case TK_COLUMN: {
2118ffe07b2dSdrh       if( pExpr->iTable<0 ){
2119ffe07b2dSdrh         /* This only happens when coding check constraints */
2120aa9b8963Sdrh         assert( pParse->ckBase>0 );
2121aa9b8963Sdrh         inReg = pExpr->iColumn + pParse->ckBase;
2122c4a3c779Sdrh       }else{
2123c5499befSdrh         testcase( (pExpr->flags & EP_AnyAff)!=0 );
2124e55cbd72Sdrh         inReg = sqlite3ExprCodeGetColumn(pParse, pExpr->pTab,
2125da250ea5Sdrh                                  pExpr->iColumn, pExpr->iTable, target,
2126da250ea5Sdrh                                  pExpr->flags & EP_AnyAff);
21272282792aSdrh       }
2128cce7d176Sdrh       break;
2129cce7d176Sdrh     }
2130cce7d176Sdrh     case TK_INTEGER: {
213192b01d53Sdrh       codeInteger(v, pExpr, 0, target);
2132fec19aadSdrh       break;
213351e9a445Sdrh     }
2134598f1340Sdrh     case TK_FLOAT: {
2135*33e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
2136*33e619fcSdrh       codeReal(v, pExpr->u.zToken, 0, target);
2137598f1340Sdrh       break;
2138598f1340Sdrh     }
2139fec19aadSdrh     case TK_STRING: {
2140*33e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
2141*33e619fcSdrh       sqlite3VdbeAddOp4(v, OP_String8, 0, target, 0, pExpr->u.zToken, 0);
2142cce7d176Sdrh       break;
2143cce7d176Sdrh     }
2144f0863fe5Sdrh     case TK_NULL: {
21459de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
2146f0863fe5Sdrh       break;
2147f0863fe5Sdrh     }
21485338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_BLOB_LITERAL
2149c572ef7fSdanielk1977     case TK_BLOB: {
21506c8c6cecSdrh       int n;
21516c8c6cecSdrh       const char *z;
2152ca48c90fSdrh       char *zBlob;
2153*33e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
2154*33e619fcSdrh       assert( pExpr->u.zToken[0]=='x' || pExpr->u.zToken[0]=='X' );
2155*33e619fcSdrh       assert( pExpr->u.zToken[1]=='\'' );
2156*33e619fcSdrh       z = &pExpr->u.zToken[2];
2157b7916a78Sdrh       n = sqlite3Strlen30(z) - 1;
2158b7916a78Sdrh       assert( z[n]=='\'' );
2159ca48c90fSdrh       zBlob = sqlite3HexToBlob(sqlite3VdbeDb(v), z, n);
2160ca48c90fSdrh       sqlite3VdbeAddOp4(v, OP_Blob, n/2, target, 0, zBlob, P4_DYNAMIC);
2161c572ef7fSdanielk1977       break;
2162c572ef7fSdanielk1977     }
21635338a5f7Sdanielk1977 #endif
216450457896Sdrh     case TK_VARIABLE: {
216508de1490Sdrh       int iPrior;
216608de1490Sdrh       VdbeOp *pOp;
2167*33e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
2168*33e619fcSdrh       assert( pExpr->u.zToken!=0 );
2169*33e619fcSdrh       assert( pExpr->u.zToken[0]!=0 );
2170*33e619fcSdrh       if( pExpr->u.zToken[1]==0
217108de1490Sdrh          && (iPrior = sqlite3VdbeCurrentAddr(v)-1)>=0
217208de1490Sdrh          && (pOp = sqlite3VdbeGetOp(v, iPrior))->opcode==OP_Variable
217308de1490Sdrh          && pOp->p1+pOp->p3==pExpr->iTable
217408de1490Sdrh          && pOp->p2+pOp->p3==target
217508de1490Sdrh          && pOp->p4.z==0
217608de1490Sdrh       ){
217708de1490Sdrh         /* If the previous instruction was a copy of the previous unnamed
217808de1490Sdrh         ** parameter into the previous register, then simply increment the
217908de1490Sdrh         ** repeat count on the prior instruction rather than making a new
218008de1490Sdrh         ** instruction.
218108de1490Sdrh         */
218208de1490Sdrh         pOp->p3++;
218308de1490Sdrh       }else{
218408de1490Sdrh         sqlite3VdbeAddOp3(v, OP_Variable, pExpr->iTable, target, 1);
2185*33e619fcSdrh         if( pExpr->u.zToken[1]!=0 ){
2186*33e619fcSdrh           sqlite3VdbeChangeP4(v, -1, pExpr->u.zToken, 0);
2187895d7472Sdrh         }
218808de1490Sdrh       }
218950457896Sdrh       break;
219050457896Sdrh     }
21914e0cff60Sdrh     case TK_REGISTER: {
21929de221dfSdrh       inReg = pExpr->iTable;
21934e0cff60Sdrh       break;
21944e0cff60Sdrh     }
21958b213899Sdrh     case TK_AS: {
219631daa63fSdrh       inReg = codeAlias(pParse, pExpr->iTable, pExpr->pLeft, target);
21978b213899Sdrh       break;
21988b213899Sdrh     }
2199487e262fSdrh #ifndef SQLITE_OMIT_CAST
2200487e262fSdrh     case TK_CAST: {
2201487e262fSdrh       /* Expressions of the form:   CAST(pLeft AS token) */
2202f0113000Sdanielk1977       int aff, to_op;
22032dcef11bSdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
2204*33e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
2205*33e619fcSdrh       aff = sqlite3AffinityType(pExpr->u.zToken);
2206f0113000Sdanielk1977       to_op = aff - SQLITE_AFF_TEXT + OP_ToText;
2207f0113000Sdanielk1977       assert( to_op==OP_ToText    || aff!=SQLITE_AFF_TEXT    );
2208f0113000Sdanielk1977       assert( to_op==OP_ToBlob    || aff!=SQLITE_AFF_NONE    );
2209f0113000Sdanielk1977       assert( to_op==OP_ToNumeric || aff!=SQLITE_AFF_NUMERIC );
2210f0113000Sdanielk1977       assert( to_op==OP_ToInt     || aff!=SQLITE_AFF_INTEGER );
2211f0113000Sdanielk1977       assert( to_op==OP_ToReal    || aff!=SQLITE_AFF_REAL    );
2212c5499befSdrh       testcase( to_op==OP_ToText );
2213c5499befSdrh       testcase( to_op==OP_ToBlob );
2214c5499befSdrh       testcase( to_op==OP_ToNumeric );
2215c5499befSdrh       testcase( to_op==OP_ToInt );
2216c5499befSdrh       testcase( to_op==OP_ToReal );
22171735fa88Sdrh       if( inReg!=target ){
22181735fa88Sdrh         sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
22191735fa88Sdrh         inReg = target;
22201735fa88Sdrh       }
22212dcef11bSdrh       sqlite3VdbeAddOp1(v, to_op, inReg);
2222c5499befSdrh       testcase( usedAsColumnCache(pParse, inReg, inReg) );
2223b3843a82Sdrh       sqlite3ExprCacheAffinityChange(pParse, inReg, 1);
2224487e262fSdrh       break;
2225487e262fSdrh     }
2226487e262fSdrh #endif /* SQLITE_OMIT_CAST */
2227c9b84a1fSdrh     case TK_LT:
2228c9b84a1fSdrh     case TK_LE:
2229c9b84a1fSdrh     case TK_GT:
2230c9b84a1fSdrh     case TK_GE:
2231c9b84a1fSdrh     case TK_NE:
2232c9b84a1fSdrh     case TK_EQ: {
2233f2bc013cSdrh       assert( TK_LT==OP_Lt );
2234f2bc013cSdrh       assert( TK_LE==OP_Le );
2235f2bc013cSdrh       assert( TK_GT==OP_Gt );
2236f2bc013cSdrh       assert( TK_GE==OP_Ge );
2237f2bc013cSdrh       assert( TK_EQ==OP_Eq );
2238f2bc013cSdrh       assert( TK_NE==OP_Ne );
2239c5499befSdrh       testcase( op==TK_LT );
2240c5499befSdrh       testcase( op==TK_LE );
2241c5499befSdrh       testcase( op==TK_GT );
2242c5499befSdrh       testcase( op==TK_GE );
2243c5499befSdrh       testcase( op==TK_EQ );
2244c5499befSdrh       testcase( op==TK_NE );
2245da250ea5Sdrh       codeCompareOperands(pParse, pExpr->pLeft, &r1, &regFree1,
2246da250ea5Sdrh                                   pExpr->pRight, &r2, &regFree2);
224735573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
224835573356Sdrh                   r1, r2, inReg, SQLITE_STOREP2);
2249c5499befSdrh       testcase( regFree1==0 );
2250c5499befSdrh       testcase( regFree2==0 );
2251a37cdde0Sdanielk1977       break;
2252c9b84a1fSdrh     }
2253cce7d176Sdrh     case TK_AND:
2254cce7d176Sdrh     case TK_OR:
2255cce7d176Sdrh     case TK_PLUS:
2256cce7d176Sdrh     case TK_STAR:
2257cce7d176Sdrh     case TK_MINUS:
2258bf4133cbSdrh     case TK_REM:
2259bf4133cbSdrh     case TK_BITAND:
2260bf4133cbSdrh     case TK_BITOR:
226117c40294Sdrh     case TK_SLASH:
2262bf4133cbSdrh     case TK_LSHIFT:
2263855eb1cfSdrh     case TK_RSHIFT:
22640040077dSdrh     case TK_CONCAT: {
2265f2bc013cSdrh       assert( TK_AND==OP_And );
2266f2bc013cSdrh       assert( TK_OR==OP_Or );
2267f2bc013cSdrh       assert( TK_PLUS==OP_Add );
2268f2bc013cSdrh       assert( TK_MINUS==OP_Subtract );
2269f2bc013cSdrh       assert( TK_REM==OP_Remainder );
2270f2bc013cSdrh       assert( TK_BITAND==OP_BitAnd );
2271f2bc013cSdrh       assert( TK_BITOR==OP_BitOr );
2272f2bc013cSdrh       assert( TK_SLASH==OP_Divide );
2273f2bc013cSdrh       assert( TK_LSHIFT==OP_ShiftLeft );
2274f2bc013cSdrh       assert( TK_RSHIFT==OP_ShiftRight );
2275f2bc013cSdrh       assert( TK_CONCAT==OP_Concat );
2276c5499befSdrh       testcase( op==TK_AND );
2277c5499befSdrh       testcase( op==TK_OR );
2278c5499befSdrh       testcase( op==TK_PLUS );
2279c5499befSdrh       testcase( op==TK_MINUS );
2280c5499befSdrh       testcase( op==TK_REM );
2281c5499befSdrh       testcase( op==TK_BITAND );
2282c5499befSdrh       testcase( op==TK_BITOR );
2283c5499befSdrh       testcase( op==TK_SLASH );
2284c5499befSdrh       testcase( op==TK_LSHIFT );
2285c5499befSdrh       testcase( op==TK_RSHIFT );
2286c5499befSdrh       testcase( op==TK_CONCAT );
22872dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
22882dcef11bSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
22895b6afba9Sdrh       sqlite3VdbeAddOp3(v, op, r2, r1, target);
2290c5499befSdrh       testcase( regFree1==0 );
2291c5499befSdrh       testcase( regFree2==0 );
22920040077dSdrh       break;
22930040077dSdrh     }
2294cce7d176Sdrh     case TK_UMINUS: {
2295fec19aadSdrh       Expr *pLeft = pExpr->pLeft;
2296fec19aadSdrh       assert( pLeft );
2297fec19aadSdrh       if( pLeft->op==TK_FLOAT ){
2298*33e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
2299*33e619fcSdrh         codeReal(v, pLeft->u.zToken, 1, target);
2300fbd60f82Sshane       }else if( pLeft->op==TK_INTEGER ){
230192b01d53Sdrh         codeInteger(v, pLeft, 1, target);
23023c84ddffSdrh       }else{
23032dcef11bSdrh         regFree1 = r1 = sqlite3GetTempReg(pParse);
23043c84ddffSdrh         sqlite3VdbeAddOp2(v, OP_Integer, 0, r1);
2305e55cbd72Sdrh         r2 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree2);
23062dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_Subtract, r2, r1, target);
2307c5499befSdrh         testcase( regFree2==0 );
23083c84ddffSdrh       }
23099de221dfSdrh       inReg = target;
23106e142f54Sdrh       break;
23116e142f54Sdrh     }
2312bf4133cbSdrh     case TK_BITNOT:
23136e142f54Sdrh     case TK_NOT: {
2314f2bc013cSdrh       assert( TK_BITNOT==OP_BitNot );
2315f2bc013cSdrh       assert( TK_NOT==OP_Not );
2316c5499befSdrh       testcase( op==TK_BITNOT );
2317c5499befSdrh       testcase( op==TK_NOT );
2318e99fa2afSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
2319e99fa2afSdrh       testcase( regFree1==0 );
2320e99fa2afSdrh       inReg = target;
2321e99fa2afSdrh       sqlite3VdbeAddOp2(v, op, r1, inReg);
2322cce7d176Sdrh       break;
2323cce7d176Sdrh     }
2324cce7d176Sdrh     case TK_ISNULL:
2325cce7d176Sdrh     case TK_NOTNULL: {
23266a288a33Sdrh       int addr;
2327f2bc013cSdrh       assert( TK_ISNULL==OP_IsNull );
2328f2bc013cSdrh       assert( TK_NOTNULL==OP_NotNull );
2329c5499befSdrh       testcase( op==TK_ISNULL );
2330c5499befSdrh       testcase( op==TK_NOTNULL );
23319de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
23322dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
2333c5499befSdrh       testcase( regFree1==0 );
23342dcef11bSdrh       addr = sqlite3VdbeAddOp1(v, op, r1);
23359de221dfSdrh       sqlite3VdbeAddOp2(v, OP_AddImm, target, -1);
23366a288a33Sdrh       sqlite3VdbeJumpHere(v, addr);
2337a37cdde0Sdanielk1977       break;
2338f2bc013cSdrh     }
23392282792aSdrh     case TK_AGG_FUNCTION: {
234013449892Sdrh       AggInfo *pInfo = pExpr->pAggInfo;
23417e56e711Sdrh       if( pInfo==0 ){
2342*33e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
2343*33e619fcSdrh         sqlite3ErrorMsg(pParse, "misuse of aggregate: %s()", pExpr->u.zToken);
23447e56e711Sdrh       }else{
23459de221dfSdrh         inReg = pInfo->aFunc[pExpr->iAgg].iMem;
23467e56e711Sdrh       }
23472282792aSdrh       break;
23482282792aSdrh     }
2349b71090fdSdrh     case TK_CONST_FUNC:
2350cce7d176Sdrh     case TK_FUNCTION: {
235112ffee8cSdrh       ExprList *pFarg;       /* List of function arguments */
235212ffee8cSdrh       int nFarg;             /* Number of function arguments */
235312ffee8cSdrh       FuncDef *pDef;         /* The function definition object */
235412ffee8cSdrh       int nId;               /* Length of the function name in bytes */
235512ffee8cSdrh       const char *zId;       /* The function name */
235612ffee8cSdrh       int constMask = 0;     /* Mask of function arguments that are constant */
235712ffee8cSdrh       int i;                 /* Loop counter */
235812ffee8cSdrh       u8 enc = ENC(db);      /* The text encoding used by this database */
235912ffee8cSdrh       CollSeq *pColl = 0;    /* A collating sequence */
236017435752Sdrh 
23616ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
2362c5499befSdrh       testcase( op==TK_CONST_FUNC );
2363c5499befSdrh       testcase( op==TK_FUNCTION );
2364b7916a78Sdrh       if( ExprHasAnyProperty(pExpr, EP_TokenOnly) ){
236512ffee8cSdrh         pFarg = 0;
236612ffee8cSdrh       }else{
236712ffee8cSdrh         pFarg = pExpr->x.pList;
236812ffee8cSdrh       }
236912ffee8cSdrh       nFarg = pFarg ? pFarg->nExpr : 0;
2370*33e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
2371*33e619fcSdrh       zId = pExpr->u.zToken;
2372b7916a78Sdrh       nId = sqlite3Strlen30(zId);
237312ffee8cSdrh       pDef = sqlite3FindFunction(db, zId, nId, nFarg, enc, 0);
23740bce8354Sdrh       assert( pDef!=0 );
237512ffee8cSdrh       if( pFarg ){
237612ffee8cSdrh         r1 = sqlite3GetTempRange(pParse, nFarg);
237712ffee8cSdrh         sqlite3ExprCodeExprList(pParse, pFarg, r1, 1);
2378892d3179Sdrh       }else{
237912ffee8cSdrh         r1 = 0;
2380892d3179Sdrh       }
2381b7f6f68fSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
2382a43fa227Sdrh       /* Possibly overload the function if the first argument is
2383a43fa227Sdrh       ** a virtual table column.
2384a43fa227Sdrh       **
2385a43fa227Sdrh       ** For infix functions (LIKE, GLOB, REGEXP, and MATCH) use the
2386a43fa227Sdrh       ** second argument, not the first, as the argument to test to
2387a43fa227Sdrh       ** see if it is a column in a virtual table.  This is done because
2388a43fa227Sdrh       ** the left operand of infix functions (the operand we want to
2389a43fa227Sdrh       ** control overloading) ends up as the second argument to the
2390a43fa227Sdrh       ** function.  The expression "A glob B" is equivalent to
2391a43fa227Sdrh       ** "glob(B,A).  We want to use the A in "A glob B" to test
2392a43fa227Sdrh       ** for function overloading.  But we use the B term in "glob(B,A)".
2393a43fa227Sdrh       */
239412ffee8cSdrh       if( nFarg>=2 && (pExpr->flags & EP_InfixFunc) ){
239512ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[1].pExpr);
239612ffee8cSdrh       }else if( nFarg>0 ){
239712ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[0].pExpr);
2398b7f6f68fSdrh       }
2399b7f6f68fSdrh #endif
240012ffee8cSdrh       for(i=0; i<nFarg && i<32; i++){
240112ffee8cSdrh         if( sqlite3ExprIsConstant(pFarg->a[i].pExpr) ){
240213449892Sdrh           constMask |= (1<<i);
2403d02eb1fdSdanielk1977         }
2404e82f5d04Sdrh         if( (pDef->flags & SQLITE_FUNC_NEEDCOLL)!=0 && !pColl ){
240512ffee8cSdrh           pColl = sqlite3ExprCollSeq(pParse, pFarg->a[i].pExpr);
2406dc1bdc4fSdanielk1977         }
2407dc1bdc4fSdanielk1977       }
2408e82f5d04Sdrh       if( pDef->flags & SQLITE_FUNC_NEEDCOLL ){
24098b213899Sdrh         if( !pColl ) pColl = db->pDfltColl;
241066a5167bSdrh         sqlite3VdbeAddOp4(v, OP_CollSeq, 0, 0, 0, (char *)pColl, P4_COLLSEQ);
2411682f68b0Sdanielk1977       }
24122dcef11bSdrh       sqlite3VdbeAddOp4(v, OP_Function, constMask, r1, target,
241366a5167bSdrh                         (char*)pDef, P4_FUNCDEF);
241412ffee8cSdrh       sqlite3VdbeChangeP5(v, (u8)nFarg);
241512ffee8cSdrh       if( nFarg ){
241612ffee8cSdrh         sqlite3ReleaseTempRange(pParse, r1, nFarg);
24172dcef11bSdrh       }
241812ffee8cSdrh       sqlite3ExprCacheAffinityChange(pParse, r1, nFarg);
24196ec2733bSdrh       break;
24206ec2733bSdrh     }
2421fe2093d7Sdrh #ifndef SQLITE_OMIT_SUBQUERY
2422fe2093d7Sdrh     case TK_EXISTS:
242319a775c2Sdrh     case TK_SELECT: {
2424c5499befSdrh       testcase( op==TK_EXISTS );
2425c5499befSdrh       testcase( op==TK_SELECT );
242641714d6fSdrh       if( pExpr->iColumn==0 ){
242741a05b7bSdanielk1977         sqlite3CodeSubselect(pParse, pExpr, 0, 0);
242841714d6fSdrh       }
24299de221dfSdrh       inReg = pExpr->iColumn;
243019a775c2Sdrh       break;
243119a775c2Sdrh     }
2432fef5208cSdrh     case TK_IN: {
24330cdc022eSdanielk1977       int rNotFound = 0;
24340cdc022eSdanielk1977       int rMayHaveNull = 0;
24356fccc35aSdrh       int j2, j3, j4, j5;
243694a11211Sdrh       char affinity;
24379a96b668Sdanielk1977       int eType;
24389a96b668Sdanielk1977 
24393c31fc23Sdrh       VdbeNoopComment((v, "begin IN expr r%d", target));
24400cdc022eSdanielk1977       eType = sqlite3FindInIndex(pParse, pExpr, &rMayHaveNull);
24410cdc022eSdanielk1977       if( rMayHaveNull ){
24420cdc022eSdanielk1977         rNotFound = ++pParse->nMem;
24430cdc022eSdanielk1977       }
2444e014a838Sdanielk1977 
2445e014a838Sdanielk1977       /* Figure out the affinity to use to create a key from the results
2446e014a838Sdanielk1977       ** of the expression. affinityStr stores a static string suitable for
244766a5167bSdrh       ** P4 of OP_MakeRecord.
2448e014a838Sdanielk1977       */
244994a11211Sdrh       affinity = comparisonAffinity(pExpr);
2450e014a838Sdanielk1977 
2451e014a838Sdanielk1977 
2452e014a838Sdanielk1977       /* Code the <expr> from "<expr> IN (...)". The temporary table
2453e014a838Sdanielk1977       ** pExpr->iTable contains the values that make up the (...) set.
2454e014a838Sdanielk1977       */
2455ceea3321Sdrh       sqlite3ExprCachePush(pParse);
245666ba23ceSdrh       sqlite3ExprCode(pParse, pExpr->pLeft, target);
245766ba23ceSdrh       j2 = sqlite3VdbeAddOp1(v, OP_IsNull, target);
24589a96b668Sdanielk1977       if( eType==IN_INDEX_ROWID ){
245966ba23ceSdrh         j3 = sqlite3VdbeAddOp1(v, OP_MustBeInt, target);
246066ba23ceSdrh         j4 = sqlite3VdbeAddOp3(v, OP_NotExists, pExpr->iTable, 0, target);
246166ba23ceSdrh         sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
24626a288a33Sdrh         j5 = sqlite3VdbeAddOp0(v, OP_Goto);
24636a288a33Sdrh         sqlite3VdbeJumpHere(v, j3);
24646a288a33Sdrh         sqlite3VdbeJumpHere(v, j4);
24650cdc022eSdanielk1977         sqlite3VdbeAddOp2(v, OP_Integer, 0, target);
24669a96b668Sdanielk1977       }else{
24672dcef11bSdrh         r2 = regFree2 = sqlite3GetTempReg(pParse);
24680cdc022eSdanielk1977 
24690cdc022eSdanielk1977         /* Create a record and test for set membership. If the set contains
24700cdc022eSdanielk1977         ** the value, then jump to the end of the test code. The target
24710cdc022eSdanielk1977         ** register still contains the true (1) value written to it earlier.
24720cdc022eSdanielk1977         */
247366ba23ceSdrh         sqlite3VdbeAddOp4(v, OP_MakeRecord, target, 1, r2, &affinity, 1);
247466ba23ceSdrh         sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
24752dcef11bSdrh         j5 = sqlite3VdbeAddOp3(v, OP_Found, pExpr->iTable, 0, r2);
24760cdc022eSdanielk1977 
24770cdc022eSdanielk1977         /* If the set membership test fails, then the result of the
24780cdc022eSdanielk1977         ** "x IN (...)" expression must be either 0 or NULL. If the set
24790cdc022eSdanielk1977         ** contains no NULL values, then the result is 0. If the set
24800cdc022eSdanielk1977         ** contains one or more NULL values, then the result of the
24810cdc022eSdanielk1977         ** expression is also NULL.
24820cdc022eSdanielk1977         */
24830cdc022eSdanielk1977         if( rNotFound==0 ){
24840cdc022eSdanielk1977           /* This branch runs if it is known at compile time (now) that
24850cdc022eSdanielk1977           ** the set contains no NULL values. This happens as the result
24860cdc022eSdanielk1977           ** of a "NOT NULL" constraint in the database schema. No need
24870cdc022eSdanielk1977           ** to test the data structure at runtime in this case.
24880cdc022eSdanielk1977           */
24890cdc022eSdanielk1977           sqlite3VdbeAddOp2(v, OP_Integer, 0, target);
24900cdc022eSdanielk1977         }else{
24910cdc022eSdanielk1977           /* This block populates the rNotFound register with either NULL
24920cdc022eSdanielk1977           ** or 0 (an integer value). If the data structure contains one
24930cdc022eSdanielk1977           ** or more NULLs, then set rNotFound to NULL. Otherwise, set it
24940cdc022eSdanielk1977           ** to 0. If register rMayHaveNull is already set to some value
24950cdc022eSdanielk1977           ** other than NULL, then the test has already been run and
24960cdc022eSdanielk1977           ** rNotFound is already populated.
24970cdc022eSdanielk1977           */
249866ba23ceSdrh           static const char nullRecord[] = { 0x02, 0x00 };
24990cdc022eSdanielk1977           j3 = sqlite3VdbeAddOp1(v, OP_NotNull, rMayHaveNull);
25000cdc022eSdanielk1977           sqlite3VdbeAddOp2(v, OP_Null, 0, rNotFound);
250166ba23ceSdrh           sqlite3VdbeAddOp4(v, OP_Blob, 2, rMayHaveNull, 0,
250266ba23ceSdrh                              nullRecord, P4_STATIC);
250366ba23ceSdrh           j4 = sqlite3VdbeAddOp3(v, OP_Found, pExpr->iTable, 0, rMayHaveNull);
25040cdc022eSdanielk1977           sqlite3VdbeAddOp2(v, OP_Integer, 0, rNotFound);
25050cdc022eSdanielk1977           sqlite3VdbeJumpHere(v, j4);
25060cdc022eSdanielk1977           sqlite3VdbeJumpHere(v, j3);
25070cdc022eSdanielk1977 
25080cdc022eSdanielk1977           /* Copy the value of register rNotFound (which is either NULL or 0)
25090cdc022eSdanielk1977           ** into the target register. This will be the result of the
25100cdc022eSdanielk1977           ** expression.
25110cdc022eSdanielk1977           */
25120cdc022eSdanielk1977           sqlite3VdbeAddOp2(v, OP_Copy, rNotFound, target);
25139a96b668Sdanielk1977         }
25140cdc022eSdanielk1977       }
25156a288a33Sdrh       sqlite3VdbeJumpHere(v, j2);
25166a288a33Sdrh       sqlite3VdbeJumpHere(v, j5);
2517ceea3321Sdrh       sqlite3ExprCachePop(pParse, 1);
25183c31fc23Sdrh       VdbeComment((v, "end IN expr r%d", target));
2519fef5208cSdrh       break;
2520fef5208cSdrh     }
252193758c8dSdanielk1977 #endif
25222dcef11bSdrh     /*
25232dcef11bSdrh     **    x BETWEEN y AND z
25242dcef11bSdrh     **
25252dcef11bSdrh     ** This is equivalent to
25262dcef11bSdrh     **
25272dcef11bSdrh     **    x>=y AND x<=z
25282dcef11bSdrh     **
25292dcef11bSdrh     ** X is stored in pExpr->pLeft.
25302dcef11bSdrh     ** Y is stored in pExpr->pList->a[0].pExpr.
25312dcef11bSdrh     ** Z is stored in pExpr->pList->a[1].pExpr.
25322dcef11bSdrh     */
2533fef5208cSdrh     case TK_BETWEEN: {
2534be5c89acSdrh       Expr *pLeft = pExpr->pLeft;
25356ab3a2ecSdanielk1977       struct ExprList_item *pLItem = pExpr->x.pList->a;
2536be5c89acSdrh       Expr *pRight = pLItem->pExpr;
253735573356Sdrh 
2538da250ea5Sdrh       codeCompareOperands(pParse, pLeft, &r1, &regFree1,
2539da250ea5Sdrh                                   pRight, &r2, &regFree2);
2540c5499befSdrh       testcase( regFree1==0 );
2541c5499befSdrh       testcase( regFree2==0 );
25422dcef11bSdrh       r3 = sqlite3GetTempReg(pParse);
2543678ccce8Sdrh       r4 = sqlite3GetTempReg(pParse);
254435573356Sdrh       codeCompare(pParse, pLeft, pRight, OP_Ge,
254535573356Sdrh                   r1, r2, r3, SQLITE_STOREP2);
2546be5c89acSdrh       pLItem++;
2547be5c89acSdrh       pRight = pLItem->pExpr;
25482dcef11bSdrh       sqlite3ReleaseTempReg(pParse, regFree2);
25492dcef11bSdrh       r2 = sqlite3ExprCodeTemp(pParse, pRight, &regFree2);
2550c5499befSdrh       testcase( regFree2==0 );
2551678ccce8Sdrh       codeCompare(pParse, pLeft, pRight, OP_Le, r1, r2, r4, SQLITE_STOREP2);
2552678ccce8Sdrh       sqlite3VdbeAddOp3(v, OP_And, r3, r4, target);
25532dcef11bSdrh       sqlite3ReleaseTempReg(pParse, r3);
2554678ccce8Sdrh       sqlite3ReleaseTempReg(pParse, r4);
2555fef5208cSdrh       break;
2556fef5208cSdrh     }
25574f07e5fbSdrh     case TK_UPLUS: {
25582dcef11bSdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
2559a2e00042Sdrh       break;
2560a2e00042Sdrh     }
25612dcef11bSdrh 
25622dcef11bSdrh     /*
25632dcef11bSdrh     ** Form A:
25642dcef11bSdrh     **   CASE x WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
25652dcef11bSdrh     **
25662dcef11bSdrh     ** Form B:
25672dcef11bSdrh     **   CASE WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
25682dcef11bSdrh     **
25692dcef11bSdrh     ** Form A is can be transformed into the equivalent form B as follows:
25702dcef11bSdrh     **   CASE WHEN x=e1 THEN r1 WHEN x=e2 THEN r2 ...
25712dcef11bSdrh     **        WHEN x=eN THEN rN ELSE y END
25722dcef11bSdrh     **
25732dcef11bSdrh     ** X (if it exists) is in pExpr->pLeft.
25742dcef11bSdrh     ** Y is in pExpr->pRight.  The Y is also optional.  If there is no
25752dcef11bSdrh     ** ELSE clause and no other term matches, then the result of the
25762dcef11bSdrh     ** exprssion is NULL.
25772dcef11bSdrh     ** Ei is in pExpr->pList->a[i*2] and Ri is pExpr->pList->a[i*2+1].
25782dcef11bSdrh     **
25792dcef11bSdrh     ** The result of the expression is the Ri for the first matching Ei,
25802dcef11bSdrh     ** or if there is no matching Ei, the ELSE term Y, or if there is
25812dcef11bSdrh     ** no ELSE term, NULL.
25822dcef11bSdrh     */
258317a7f8ddSdrh     case TK_CASE: {
25842dcef11bSdrh       int endLabel;                     /* GOTO label for end of CASE stmt */
25852dcef11bSdrh       int nextCase;                     /* GOTO label for next WHEN clause */
25862dcef11bSdrh       int nExpr;                        /* 2x number of WHEN terms */
25872dcef11bSdrh       int i;                            /* Loop counter */
25882dcef11bSdrh       ExprList *pEList;                 /* List of WHEN terms */
25892dcef11bSdrh       struct ExprList_item *aListelem;  /* Array of WHEN terms */
25902dcef11bSdrh       Expr opCompare;                   /* The X==Ei expression */
25912dcef11bSdrh       Expr cacheX;                      /* Cached expression X */
25922dcef11bSdrh       Expr *pX;                         /* The X expression */
25931bd10f8aSdrh       Expr *pTest = 0;                  /* X==Ei (form A) or just Ei (form B) */
2594ceea3321Sdrh       VVA_ONLY( int iCacheLevel = pParse->iCacheLevel; )
259517a7f8ddSdrh 
25966ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) && pExpr->x.pList );
25976ab3a2ecSdanielk1977       assert((pExpr->x.pList->nExpr % 2) == 0);
25986ab3a2ecSdanielk1977       assert(pExpr->x.pList->nExpr > 0);
25996ab3a2ecSdanielk1977       pEList = pExpr->x.pList;
2600be5c89acSdrh       aListelem = pEList->a;
2601be5c89acSdrh       nExpr = pEList->nExpr;
26022dcef11bSdrh       endLabel = sqlite3VdbeMakeLabel(v);
26032dcef11bSdrh       if( (pX = pExpr->pLeft)!=0 ){
26042dcef11bSdrh         cacheX = *pX;
2605c5499befSdrh         testcase( pX->op==TK_COLUMN || pX->op==TK_REGISTER );
26062dcef11bSdrh         cacheX.iTable = sqlite3ExprCodeTemp(pParse, pX, &regFree1);
2607c5499befSdrh         testcase( regFree1==0 );
26082dcef11bSdrh         cacheX.op = TK_REGISTER;
26092dcef11bSdrh         opCompare.op = TK_EQ;
26102dcef11bSdrh         opCompare.pLeft = &cacheX;
26112dcef11bSdrh         pTest = &opCompare;
2612cce7d176Sdrh       }
2613f5905aa7Sdrh       for(i=0; i<nExpr; i=i+2){
2614ceea3321Sdrh         sqlite3ExprCachePush(pParse);
26152dcef11bSdrh         if( pX ){
26161bd10f8aSdrh           assert( pTest!=0 );
26172dcef11bSdrh           opCompare.pRight = aListelem[i].pExpr;
2618f5905aa7Sdrh         }else{
26192dcef11bSdrh           pTest = aListelem[i].pExpr;
262017a7f8ddSdrh         }
26212dcef11bSdrh         nextCase = sqlite3VdbeMakeLabel(v);
2622c5499befSdrh         testcase( pTest->op==TK_COLUMN || pTest->op==TK_REGISTER );
26232dcef11bSdrh         sqlite3ExprIfFalse(pParse, pTest, nextCase, SQLITE_JUMPIFNULL);
2624c5499befSdrh         testcase( aListelem[i+1].pExpr->op==TK_COLUMN );
2625c5499befSdrh         testcase( aListelem[i+1].pExpr->op==TK_REGISTER );
26269de221dfSdrh         sqlite3ExprCode(pParse, aListelem[i+1].pExpr, target);
26272dcef11bSdrh         sqlite3VdbeAddOp2(v, OP_Goto, 0, endLabel);
2628ceea3321Sdrh         sqlite3ExprCachePop(pParse, 1);
26292dcef11bSdrh         sqlite3VdbeResolveLabel(v, nextCase);
2630f570f011Sdrh       }
263117a7f8ddSdrh       if( pExpr->pRight ){
2632ceea3321Sdrh         sqlite3ExprCachePush(pParse);
26339de221dfSdrh         sqlite3ExprCode(pParse, pExpr->pRight, target);
2634ceea3321Sdrh         sqlite3ExprCachePop(pParse, 1);
263517a7f8ddSdrh       }else{
26369de221dfSdrh         sqlite3VdbeAddOp2(v, OP_Null, 0, target);
263717a7f8ddSdrh       }
2638c1f4a19bSdanielk1977       assert( db->mallocFailed || pParse->nErr>0
2639c1f4a19bSdanielk1977            || pParse->iCacheLevel==iCacheLevel );
26402dcef11bSdrh       sqlite3VdbeResolveLabel(v, endLabel);
26416f34903eSdanielk1977       break;
26426f34903eSdanielk1977     }
26435338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_TRIGGER
26446f34903eSdanielk1977     case TK_RAISE: {
26456f34903eSdanielk1977       if( !pParse->trigStack ){
26464adee20fSdanielk1977         sqlite3ErrorMsg(pParse,
2647da93d238Sdrh                        "RAISE() may only be used within a trigger-program");
2648389a1adbSdrh         return 0;
26496f34903eSdanielk1977       }
26506ab3a2ecSdanielk1977       if( pExpr->affinity!=OE_Ignore ){
26516ab3a2ecSdanielk1977          assert( pExpr->affinity==OE_Rollback ||
26526ab3a2ecSdanielk1977                  pExpr->affinity == OE_Abort ||
26536ab3a2ecSdanielk1977                  pExpr->affinity == OE_Fail );
2654*33e619fcSdrh          assert( !ExprHasProperty(pExpr, EP_IntValue) );
26556ab3a2ecSdanielk1977          sqlite3VdbeAddOp4(v, OP_Halt, SQLITE_CONSTRAINT, pExpr->affinity, 0,
2656*33e619fcSdrh                            pExpr->u.zToken, 0);
26576f34903eSdanielk1977       } else {
26586ab3a2ecSdanielk1977          assert( pExpr->affinity == OE_Ignore );
265966a5167bSdrh          sqlite3VdbeAddOp2(v, OP_ContextPop, 0, 0);
266066a5167bSdrh          sqlite3VdbeAddOp2(v, OP_Goto, 0, pParse->trigStack->ignoreJump);
2661d4e70ebdSdrh          VdbeComment((v, "raise(IGNORE)"));
26626f34903eSdanielk1977       }
2663ffe07b2dSdrh       break;
266417a7f8ddSdrh     }
26655338a5f7Sdanielk1977 #endif
2666ffe07b2dSdrh   }
26672dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
26682dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
26692dcef11bSdrh   return inReg;
26705b6afba9Sdrh }
26712dcef11bSdrh 
26722dcef11bSdrh /*
26732dcef11bSdrh ** Generate code to evaluate an expression and store the results
26742dcef11bSdrh ** into a register.  Return the register number where the results
26752dcef11bSdrh ** are stored.
26762dcef11bSdrh **
26772dcef11bSdrh ** If the register is a temporary register that can be deallocated,
2678678ccce8Sdrh ** then write its number into *pReg.  If the result register is not
26792dcef11bSdrh ** a temporary, then set *pReg to zero.
26802dcef11bSdrh */
26812dcef11bSdrh int sqlite3ExprCodeTemp(Parse *pParse, Expr *pExpr, int *pReg){
26822dcef11bSdrh   int r1 = sqlite3GetTempReg(pParse);
26832dcef11bSdrh   int r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
26842dcef11bSdrh   if( r2==r1 ){
26852dcef11bSdrh     *pReg = r1;
26862dcef11bSdrh   }else{
26872dcef11bSdrh     sqlite3ReleaseTempReg(pParse, r1);
26882dcef11bSdrh     *pReg = 0;
26892dcef11bSdrh   }
26902dcef11bSdrh   return r2;
26912dcef11bSdrh }
26922dcef11bSdrh 
26932dcef11bSdrh /*
26942dcef11bSdrh ** Generate code that will evaluate expression pExpr and store the
26952dcef11bSdrh ** results in register target.  The results are guaranteed to appear
26962dcef11bSdrh ** in register target.
26972dcef11bSdrh */
26982dcef11bSdrh int sqlite3ExprCode(Parse *pParse, Expr *pExpr, int target){
26999cbf3425Sdrh   int inReg;
27009cbf3425Sdrh 
27019cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
27029cbf3425Sdrh   inReg = sqlite3ExprCodeTarget(pParse, pExpr, target);
27030e359b30Sdrh   assert( pParse->pVdbe || pParse->db->mallocFailed );
27040e359b30Sdrh   if( inReg!=target && pParse->pVdbe ){
27059cbf3425Sdrh     sqlite3VdbeAddOp2(pParse->pVdbe, OP_SCopy, inReg, target);
270617a7f8ddSdrh   }
2707389a1adbSdrh   return target;
2708cce7d176Sdrh }
2709cce7d176Sdrh 
2710cce7d176Sdrh /*
27112dcef11bSdrh ** Generate code that evalutes the given expression and puts the result
2712de4fcfddSdrh ** in register target.
271325303780Sdrh **
27142dcef11bSdrh ** Also make a copy of the expression results into another "cache" register
27152dcef11bSdrh ** and modify the expression so that the next time it is evaluated,
27162dcef11bSdrh ** the result is a copy of the cache register.
27172dcef11bSdrh **
27182dcef11bSdrh ** This routine is used for expressions that are used multiple
27192dcef11bSdrh ** times.  They are evaluated once and the results of the expression
27202dcef11bSdrh ** are reused.
272125303780Sdrh */
27222dcef11bSdrh int sqlite3ExprCodeAndCache(Parse *pParse, Expr *pExpr, int target){
272325303780Sdrh   Vdbe *v = pParse->pVdbe;
27242dcef11bSdrh   int inReg;
27252dcef11bSdrh   inReg = sqlite3ExprCode(pParse, pExpr, target);
2726de4fcfddSdrh   assert( target>0 );
27272dcef11bSdrh   if( pExpr->op!=TK_REGISTER ){
272825303780Sdrh     int iMem;
27292dcef11bSdrh     iMem = ++pParse->nMem;
27302dcef11bSdrh     sqlite3VdbeAddOp2(v, OP_Copy, inReg, iMem);
27312dcef11bSdrh     pExpr->iTable = iMem;
273225303780Sdrh     pExpr->op = TK_REGISTER;
273325303780Sdrh   }
27342dcef11bSdrh   return inReg;
273525303780Sdrh }
27362dcef11bSdrh 
2737678ccce8Sdrh /*
273847de955eSdrh ** Return TRUE if pExpr is an constant expression that is appropriate
273947de955eSdrh ** for factoring out of a loop.  Appropriate expressions are:
274047de955eSdrh **
274147de955eSdrh **    *  Any expression that evaluates to two or more opcodes.
274247de955eSdrh **
274347de955eSdrh **    *  Any OP_Integer, OP_Real, OP_String, OP_Blob, OP_Null,
274447de955eSdrh **       or OP_Variable that does not need to be placed in a
274547de955eSdrh **       specific register.
274647de955eSdrh **
274747de955eSdrh ** There is no point in factoring out single-instruction constant
274847de955eSdrh ** expressions that need to be placed in a particular register.
274947de955eSdrh ** We could factor them out, but then we would end up adding an
275047de955eSdrh ** OP_SCopy instruction to move the value into the correct register
275147de955eSdrh ** later.  We might as well just use the original instruction and
275247de955eSdrh ** avoid the OP_SCopy.
275347de955eSdrh */
275447de955eSdrh static int isAppropriateForFactoring(Expr *p){
275547de955eSdrh   if( !sqlite3ExprIsConstantNotJoin(p) ){
275647de955eSdrh     return 0;  /* Only constant expressions are appropriate for factoring */
275747de955eSdrh   }
275847de955eSdrh   if( (p->flags & EP_FixedDest)==0 ){
275947de955eSdrh     return 1;  /* Any constant without a fixed destination is appropriate */
276047de955eSdrh   }
276147de955eSdrh   while( p->op==TK_UPLUS ) p = p->pLeft;
276247de955eSdrh   switch( p->op ){
276347de955eSdrh #ifndef SQLITE_OMIT_BLOB_LITERAL
276447de955eSdrh     case TK_BLOB:
276547de955eSdrh #endif
276647de955eSdrh     case TK_VARIABLE:
276747de955eSdrh     case TK_INTEGER:
276847de955eSdrh     case TK_FLOAT:
276947de955eSdrh     case TK_NULL:
277047de955eSdrh     case TK_STRING: {
277147de955eSdrh       testcase( p->op==TK_BLOB );
277247de955eSdrh       testcase( p->op==TK_VARIABLE );
277347de955eSdrh       testcase( p->op==TK_INTEGER );
277447de955eSdrh       testcase( p->op==TK_FLOAT );
277547de955eSdrh       testcase( p->op==TK_NULL );
277647de955eSdrh       testcase( p->op==TK_STRING );
277747de955eSdrh       /* Single-instruction constants with a fixed destination are
277847de955eSdrh       ** better done in-line.  If we factor them, they will just end
277947de955eSdrh       ** up generating an OP_SCopy to move the value to the destination
278047de955eSdrh       ** register. */
278147de955eSdrh       return 0;
278247de955eSdrh     }
278347de955eSdrh     case TK_UMINUS: {
278447de955eSdrh        if( p->pLeft->op==TK_FLOAT || p->pLeft->op==TK_INTEGER ){
278547de955eSdrh          return 0;
278647de955eSdrh        }
278747de955eSdrh        break;
278847de955eSdrh     }
278947de955eSdrh     default: {
279047de955eSdrh       break;
279147de955eSdrh     }
279247de955eSdrh   }
279347de955eSdrh   return 1;
279447de955eSdrh }
279547de955eSdrh 
279647de955eSdrh /*
279747de955eSdrh ** If pExpr is a constant expression that is appropriate for
279847de955eSdrh ** factoring out of a loop, then evaluate the expression
2799678ccce8Sdrh ** into a register and convert the expression into a TK_REGISTER
2800678ccce8Sdrh ** expression.
2801678ccce8Sdrh */
28027d10d5a6Sdrh static int evalConstExpr(Walker *pWalker, Expr *pExpr){
28037d10d5a6Sdrh   Parse *pParse = pWalker->pParse;
280447de955eSdrh   switch( pExpr->op ){
280547de955eSdrh     case TK_REGISTER: {
2806678ccce8Sdrh       return 1;
2807678ccce8Sdrh     }
280847de955eSdrh     case TK_FUNCTION:
280947de955eSdrh     case TK_AGG_FUNCTION:
281047de955eSdrh     case TK_CONST_FUNC: {
281147de955eSdrh       /* The arguments to a function have a fixed destination.
281247de955eSdrh       ** Mark them this way to avoid generated unneeded OP_SCopy
281347de955eSdrh       ** instructions.
281447de955eSdrh       */
28156ab3a2ecSdanielk1977       ExprList *pList = pExpr->x.pList;
28166ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
281747de955eSdrh       if( pList ){
281847de955eSdrh         int i = pList->nExpr;
281947de955eSdrh         struct ExprList_item *pItem = pList->a;
282047de955eSdrh         for(; i>0; i--, pItem++){
282147de955eSdrh           if( pItem->pExpr ) pItem->pExpr->flags |= EP_FixedDest;
282247de955eSdrh         }
282347de955eSdrh       }
282447de955eSdrh       break;
282547de955eSdrh     }
282647de955eSdrh   }
282747de955eSdrh   if( isAppropriateForFactoring(pExpr) ){
2828678ccce8Sdrh     int r1 = ++pParse->nMem;
2829678ccce8Sdrh     int r2;
2830678ccce8Sdrh     r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
2831c5499befSdrh     if( r1!=r2 ) sqlite3ReleaseTempReg(pParse, r1);
2832678ccce8Sdrh     pExpr->op = TK_REGISTER;
2833678ccce8Sdrh     pExpr->iTable = r2;
28347d10d5a6Sdrh     return WRC_Prune;
2835678ccce8Sdrh   }
28367d10d5a6Sdrh   return WRC_Continue;
2837678ccce8Sdrh }
2838678ccce8Sdrh 
2839678ccce8Sdrh /*
2840678ccce8Sdrh ** Preevaluate constant subexpressions within pExpr and store the
2841678ccce8Sdrh ** results in registers.  Modify pExpr so that the constant subexpresions
2842678ccce8Sdrh ** are TK_REGISTER opcodes that refer to the precomputed values.
2843678ccce8Sdrh */
2844678ccce8Sdrh void sqlite3ExprCodeConstants(Parse *pParse, Expr *pExpr){
28457d10d5a6Sdrh   Walker w;
28467d10d5a6Sdrh   w.xExprCallback = evalConstExpr;
28477d10d5a6Sdrh   w.xSelectCallback = 0;
28487d10d5a6Sdrh   w.pParse = pParse;
28497d10d5a6Sdrh   sqlite3WalkExpr(&w, pExpr);
2850678ccce8Sdrh }
2851678ccce8Sdrh 
285225303780Sdrh 
285325303780Sdrh /*
2854268380caSdrh ** Generate code that pushes the value of every element of the given
28559cbf3425Sdrh ** expression list into a sequence of registers beginning at target.
2856268380caSdrh **
2857892d3179Sdrh ** Return the number of elements evaluated.
2858268380caSdrh */
28594adee20fSdanielk1977 int sqlite3ExprCodeExprList(
2860268380caSdrh   Parse *pParse,     /* Parsing context */
2861389a1adbSdrh   ExprList *pList,   /* The expression list to be coded */
2862191b54cbSdrh   int target,        /* Where to write results */
2863d176611bSdrh   int doHardCopy     /* Make a hard copy of every element */
2864268380caSdrh ){
2865268380caSdrh   struct ExprList_item *pItem;
28669cbf3425Sdrh   int i, n;
28679d8b3072Sdrh   assert( pList!=0 );
28689cbf3425Sdrh   assert( target>0 );
2869268380caSdrh   n = pList->nExpr;
2870191b54cbSdrh   for(pItem=pList->a, i=0; i<n; i++, pItem++){
28718b213899Sdrh     if( pItem->iAlias ){
287231daa63fSdrh       int iReg = codeAlias(pParse, pItem->iAlias, pItem->pExpr, target+i);
28738b213899Sdrh       Vdbe *v = sqlite3GetVdbe(pParse);
287431daa63fSdrh       if( iReg!=target+i ){
28758b213899Sdrh         sqlite3VdbeAddOp2(v, OP_SCopy, iReg, target+i);
287631daa63fSdrh       }
2877d176611bSdrh     }else{
2878191b54cbSdrh       sqlite3ExprCode(pParse, pItem->pExpr, target+i);
28798b213899Sdrh     }
2880d176611bSdrh     if( doHardCopy ){
2881d176611bSdrh       sqlite3ExprHardCopy(pParse, target, n);
2882d176611bSdrh     }
2883268380caSdrh   }
2884f9b596ebSdrh   return n;
2885268380caSdrh }
2886268380caSdrh 
2887268380caSdrh /*
2888cce7d176Sdrh ** Generate code for a boolean expression such that a jump is made
2889cce7d176Sdrh ** to the label "dest" if the expression is true but execution
2890cce7d176Sdrh ** continues straight thru if the expression is false.
2891f5905aa7Sdrh **
2892f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false), then
289335573356Sdrh ** take the jump if the jumpIfNull flag is SQLITE_JUMPIFNULL.
2894f2bc013cSdrh **
2895f2bc013cSdrh ** This code depends on the fact that certain token values (ex: TK_EQ)
2896f2bc013cSdrh ** are the same as opcode values (ex: OP_Eq) that implement the corresponding
2897f2bc013cSdrh ** operation.  Special comments in vdbe.c and the mkopcodeh.awk script in
2898f2bc013cSdrh ** the make process cause these values to align.  Assert()s in the code
2899f2bc013cSdrh ** below verify that the numbers are aligned correctly.
2900cce7d176Sdrh */
29014adee20fSdanielk1977 void sqlite3ExprIfTrue(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
2902cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
2903cce7d176Sdrh   int op = 0;
29042dcef11bSdrh   int regFree1 = 0;
29052dcef11bSdrh   int regFree2 = 0;
29062dcef11bSdrh   int r1, r2;
29072dcef11bSdrh 
290835573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
2909daffd0e5Sdrh   if( v==0 || pExpr==0 ) return;
2910f2bc013cSdrh   op = pExpr->op;
2911f2bc013cSdrh   switch( op ){
2912cce7d176Sdrh     case TK_AND: {
29134adee20fSdanielk1977       int d2 = sqlite3VdbeMakeLabel(v);
2914c5499befSdrh       testcase( jumpIfNull==0 );
2915ceea3321Sdrh       sqlite3ExprCachePush(pParse);
291635573356Sdrh       sqlite3ExprIfFalse(pParse, pExpr->pLeft, d2,jumpIfNull^SQLITE_JUMPIFNULL);
29174adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
29184adee20fSdanielk1977       sqlite3VdbeResolveLabel(v, d2);
2919ceea3321Sdrh       sqlite3ExprCachePop(pParse, 1);
2920cce7d176Sdrh       break;
2921cce7d176Sdrh     }
2922cce7d176Sdrh     case TK_OR: {
2923c5499befSdrh       testcase( jumpIfNull==0 );
29244adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
29254adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
2926cce7d176Sdrh       break;
2927cce7d176Sdrh     }
2928cce7d176Sdrh     case TK_NOT: {
2929c5499befSdrh       testcase( jumpIfNull==0 );
29304adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
2931cce7d176Sdrh       break;
2932cce7d176Sdrh     }
2933cce7d176Sdrh     case TK_LT:
2934cce7d176Sdrh     case TK_LE:
2935cce7d176Sdrh     case TK_GT:
2936cce7d176Sdrh     case TK_GE:
2937cce7d176Sdrh     case TK_NE:
29380ac65892Sdrh     case TK_EQ: {
2939f2bc013cSdrh       assert( TK_LT==OP_Lt );
2940f2bc013cSdrh       assert( TK_LE==OP_Le );
2941f2bc013cSdrh       assert( TK_GT==OP_Gt );
2942f2bc013cSdrh       assert( TK_GE==OP_Ge );
2943f2bc013cSdrh       assert( TK_EQ==OP_Eq );
2944f2bc013cSdrh       assert( TK_NE==OP_Ne );
2945c5499befSdrh       testcase( op==TK_LT );
2946c5499befSdrh       testcase( op==TK_LE );
2947c5499befSdrh       testcase( op==TK_GT );
2948c5499befSdrh       testcase( op==TK_GE );
2949c5499befSdrh       testcase( op==TK_EQ );
2950c5499befSdrh       testcase( op==TK_NE );
2951c5499befSdrh       testcase( jumpIfNull==0 );
2952da250ea5Sdrh       codeCompareOperands(pParse, pExpr->pLeft, &r1, &regFree1,
2953da250ea5Sdrh                                   pExpr->pRight, &r2, &regFree2);
295435573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
29552dcef11bSdrh                   r1, r2, dest, jumpIfNull);
2956c5499befSdrh       testcase( regFree1==0 );
2957c5499befSdrh       testcase( regFree2==0 );
2958cce7d176Sdrh       break;
2959cce7d176Sdrh     }
2960cce7d176Sdrh     case TK_ISNULL:
2961cce7d176Sdrh     case TK_NOTNULL: {
2962f2bc013cSdrh       assert( TK_ISNULL==OP_IsNull );
2963f2bc013cSdrh       assert( TK_NOTNULL==OP_NotNull );
2964c5499befSdrh       testcase( op==TK_ISNULL );
2965c5499befSdrh       testcase( op==TK_NOTNULL );
29662dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
29672dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
2968c5499befSdrh       testcase( regFree1==0 );
2969cce7d176Sdrh       break;
2970cce7d176Sdrh     }
2971fef5208cSdrh     case TK_BETWEEN: {
29722dcef11bSdrh       /*    x BETWEEN y AND z
29730202b29eSdanielk1977       **
29742dcef11bSdrh       ** Is equivalent to
29752dcef11bSdrh       **
29762dcef11bSdrh       **    x>=y AND x<=z
29772dcef11bSdrh       **
29782dcef11bSdrh       ** Code it as such, taking care to do the common subexpression
29792dcef11bSdrh       ** elementation of x.
29800202b29eSdanielk1977       */
29812dcef11bSdrh       Expr exprAnd;
29822dcef11bSdrh       Expr compLeft;
29832dcef11bSdrh       Expr compRight;
29842dcef11bSdrh       Expr exprX;
29850202b29eSdanielk1977 
29866ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
29872dcef11bSdrh       exprX = *pExpr->pLeft;
29882dcef11bSdrh       exprAnd.op = TK_AND;
29892dcef11bSdrh       exprAnd.pLeft = &compLeft;
29902dcef11bSdrh       exprAnd.pRight = &compRight;
29912dcef11bSdrh       compLeft.op = TK_GE;
29922dcef11bSdrh       compLeft.pLeft = &exprX;
29936ab3a2ecSdanielk1977       compLeft.pRight = pExpr->x.pList->a[0].pExpr;
29942dcef11bSdrh       compRight.op = TK_LE;
29952dcef11bSdrh       compRight.pLeft = &exprX;
29966ab3a2ecSdanielk1977       compRight.pRight = pExpr->x.pList->a[1].pExpr;
29972dcef11bSdrh       exprX.iTable = sqlite3ExprCodeTemp(pParse, &exprX, &regFree1);
2998c5499befSdrh       testcase( regFree1==0 );
29992dcef11bSdrh       exprX.op = TK_REGISTER;
3000c5499befSdrh       testcase( jumpIfNull==0 );
30012dcef11bSdrh       sqlite3ExprIfTrue(pParse, &exprAnd, dest, jumpIfNull);
3002fef5208cSdrh       break;
3003fef5208cSdrh     }
3004cce7d176Sdrh     default: {
30052dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
30062dcef11bSdrh       sqlite3VdbeAddOp3(v, OP_If, r1, dest, jumpIfNull!=0);
3007c5499befSdrh       testcase( regFree1==0 );
3008c5499befSdrh       testcase( jumpIfNull==0 );
3009cce7d176Sdrh       break;
3010cce7d176Sdrh     }
3011cce7d176Sdrh   }
30122dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
30132dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
3014cce7d176Sdrh }
3015cce7d176Sdrh 
3016cce7d176Sdrh /*
301766b89c8fSdrh ** Generate code for a boolean expression such that a jump is made
3018cce7d176Sdrh ** to the label "dest" if the expression is false but execution
3019cce7d176Sdrh ** continues straight thru if the expression is true.
3020f5905aa7Sdrh **
3021f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false) then
302235573356Sdrh ** jump if jumpIfNull is SQLITE_JUMPIFNULL or fall through if jumpIfNull
302335573356Sdrh ** is 0.
3024cce7d176Sdrh */
30254adee20fSdanielk1977 void sqlite3ExprIfFalse(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
3026cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
3027cce7d176Sdrh   int op = 0;
30282dcef11bSdrh   int regFree1 = 0;
30292dcef11bSdrh   int regFree2 = 0;
30302dcef11bSdrh   int r1, r2;
30312dcef11bSdrh 
303235573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
3033daffd0e5Sdrh   if( v==0 || pExpr==0 ) return;
3034f2bc013cSdrh 
3035f2bc013cSdrh   /* The value of pExpr->op and op are related as follows:
3036f2bc013cSdrh   **
3037f2bc013cSdrh   **       pExpr->op            op
3038f2bc013cSdrh   **       ---------          ----------
3039f2bc013cSdrh   **       TK_ISNULL          OP_NotNull
3040f2bc013cSdrh   **       TK_NOTNULL         OP_IsNull
3041f2bc013cSdrh   **       TK_NE              OP_Eq
3042f2bc013cSdrh   **       TK_EQ              OP_Ne
3043f2bc013cSdrh   **       TK_GT              OP_Le
3044f2bc013cSdrh   **       TK_LE              OP_Gt
3045f2bc013cSdrh   **       TK_GE              OP_Lt
3046f2bc013cSdrh   **       TK_LT              OP_Ge
3047f2bc013cSdrh   **
3048f2bc013cSdrh   ** For other values of pExpr->op, op is undefined and unused.
3049f2bc013cSdrh   ** The value of TK_ and OP_ constants are arranged such that we
3050f2bc013cSdrh   ** can compute the mapping above using the following expression.
3051f2bc013cSdrh   ** Assert()s verify that the computation is correct.
3052f2bc013cSdrh   */
3053f2bc013cSdrh   op = ((pExpr->op+(TK_ISNULL&1))^1)-(TK_ISNULL&1);
3054f2bc013cSdrh 
3055f2bc013cSdrh   /* Verify correct alignment of TK_ and OP_ constants
3056f2bc013cSdrh   */
3057f2bc013cSdrh   assert( pExpr->op!=TK_ISNULL || op==OP_NotNull );
3058f2bc013cSdrh   assert( pExpr->op!=TK_NOTNULL || op==OP_IsNull );
3059f2bc013cSdrh   assert( pExpr->op!=TK_NE || op==OP_Eq );
3060f2bc013cSdrh   assert( pExpr->op!=TK_EQ || op==OP_Ne );
3061f2bc013cSdrh   assert( pExpr->op!=TK_LT || op==OP_Ge );
3062f2bc013cSdrh   assert( pExpr->op!=TK_LE || op==OP_Gt );
3063f2bc013cSdrh   assert( pExpr->op!=TK_GT || op==OP_Le );
3064f2bc013cSdrh   assert( pExpr->op!=TK_GE || op==OP_Lt );
3065f2bc013cSdrh 
3066cce7d176Sdrh   switch( pExpr->op ){
3067cce7d176Sdrh     case TK_AND: {
3068c5499befSdrh       testcase( jumpIfNull==0 );
30694adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
30704adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
3071cce7d176Sdrh       break;
3072cce7d176Sdrh     }
3073cce7d176Sdrh     case TK_OR: {
30744adee20fSdanielk1977       int d2 = sqlite3VdbeMakeLabel(v);
3075c5499befSdrh       testcase( jumpIfNull==0 );
3076ceea3321Sdrh       sqlite3ExprCachePush(pParse);
307735573356Sdrh       sqlite3ExprIfTrue(pParse, pExpr->pLeft, d2, jumpIfNull^SQLITE_JUMPIFNULL);
30784adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
30794adee20fSdanielk1977       sqlite3VdbeResolveLabel(v, d2);
3080ceea3321Sdrh       sqlite3ExprCachePop(pParse, 1);
3081cce7d176Sdrh       break;
3082cce7d176Sdrh     }
3083cce7d176Sdrh     case TK_NOT: {
30844adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
3085cce7d176Sdrh       break;
3086cce7d176Sdrh     }
3087cce7d176Sdrh     case TK_LT:
3088cce7d176Sdrh     case TK_LE:
3089cce7d176Sdrh     case TK_GT:
3090cce7d176Sdrh     case TK_GE:
3091cce7d176Sdrh     case TK_NE:
3092cce7d176Sdrh     case TK_EQ: {
3093c5499befSdrh       testcase( op==TK_LT );
3094c5499befSdrh       testcase( op==TK_LE );
3095c5499befSdrh       testcase( op==TK_GT );
3096c5499befSdrh       testcase( op==TK_GE );
3097c5499befSdrh       testcase( op==TK_EQ );
3098c5499befSdrh       testcase( op==TK_NE );
3099c5499befSdrh       testcase( jumpIfNull==0 );
3100da250ea5Sdrh       codeCompareOperands(pParse, pExpr->pLeft, &r1, &regFree1,
3101da250ea5Sdrh                                   pExpr->pRight, &r2, &regFree2);
310235573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
31032dcef11bSdrh                   r1, r2, dest, jumpIfNull);
3104c5499befSdrh       testcase( regFree1==0 );
3105c5499befSdrh       testcase( regFree2==0 );
3106cce7d176Sdrh       break;
3107cce7d176Sdrh     }
3108cce7d176Sdrh     case TK_ISNULL:
3109cce7d176Sdrh     case TK_NOTNULL: {
3110c5499befSdrh       testcase( op==TK_ISNULL );
3111c5499befSdrh       testcase( op==TK_NOTNULL );
31122dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
31132dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
3114c5499befSdrh       testcase( regFree1==0 );
3115cce7d176Sdrh       break;
3116cce7d176Sdrh     }
3117fef5208cSdrh     case TK_BETWEEN: {
31182dcef11bSdrh       /*    x BETWEEN y AND z
31190202b29eSdanielk1977       **
31202dcef11bSdrh       ** Is equivalent to
31212dcef11bSdrh       **
31222dcef11bSdrh       **    x>=y AND x<=z
31232dcef11bSdrh       **
31242dcef11bSdrh       ** Code it as such, taking care to do the common subexpression
31252dcef11bSdrh       ** elementation of x.
31260202b29eSdanielk1977       */
31272dcef11bSdrh       Expr exprAnd;
31282dcef11bSdrh       Expr compLeft;
31292dcef11bSdrh       Expr compRight;
31302dcef11bSdrh       Expr exprX;
3131be5c89acSdrh 
31326ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
31332dcef11bSdrh       exprX = *pExpr->pLeft;
31342dcef11bSdrh       exprAnd.op = TK_AND;
31352dcef11bSdrh       exprAnd.pLeft = &compLeft;
31362dcef11bSdrh       exprAnd.pRight = &compRight;
31372dcef11bSdrh       compLeft.op = TK_GE;
31382dcef11bSdrh       compLeft.pLeft = &exprX;
31396ab3a2ecSdanielk1977       compLeft.pRight = pExpr->x.pList->a[0].pExpr;
31402dcef11bSdrh       compRight.op = TK_LE;
31412dcef11bSdrh       compRight.pLeft = &exprX;
31426ab3a2ecSdanielk1977       compRight.pRight = pExpr->x.pList->a[1].pExpr;
31432dcef11bSdrh       exprX.iTable = sqlite3ExprCodeTemp(pParse, &exprX, &regFree1);
3144c5499befSdrh       testcase( regFree1==0 );
31452dcef11bSdrh       exprX.op = TK_REGISTER;
3146c5499befSdrh       testcase( jumpIfNull==0 );
31472dcef11bSdrh       sqlite3ExprIfFalse(pParse, &exprAnd, dest, jumpIfNull);
3148fef5208cSdrh       break;
3149fef5208cSdrh     }
3150cce7d176Sdrh     default: {
31512dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
31522dcef11bSdrh       sqlite3VdbeAddOp3(v, OP_IfNot, r1, dest, jumpIfNull!=0);
3153c5499befSdrh       testcase( regFree1==0 );
3154c5499befSdrh       testcase( jumpIfNull==0 );
3155cce7d176Sdrh       break;
3156cce7d176Sdrh     }
3157cce7d176Sdrh   }
31582dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
31592dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
3160cce7d176Sdrh }
31612282792aSdrh 
31622282792aSdrh /*
31632282792aSdrh ** Do a deep comparison of two expression trees.  Return TRUE (non-zero)
31642282792aSdrh ** if they are identical and return FALSE if they differ in any way.
3165d40aab0eSdrh **
3166d40aab0eSdrh ** Sometimes this routine will return FALSE even if the two expressions
3167d40aab0eSdrh ** really are equivalent.  If we cannot prove that the expressions are
3168d40aab0eSdrh ** identical, we return FALSE just to be safe.  So if this routine
3169d40aab0eSdrh ** returns false, then you do not really know for certain if the two
3170d40aab0eSdrh ** expressions are the same.  But if you get a TRUE return, then you
3171d40aab0eSdrh ** can be sure the expressions are the same.  In the places where
3172d40aab0eSdrh ** this routine is used, it does not hurt to get an extra FALSE - that
3173d40aab0eSdrh ** just might result in some slightly slower code.  But returning
3174d40aab0eSdrh ** an incorrect TRUE could lead to a malfunction.
31752282792aSdrh */
31764adee20fSdanielk1977 int sqlite3ExprCompare(Expr *pA, Expr *pB){
31772282792aSdrh   int i;
31784b202ae2Sdanielk1977   if( pA==0||pB==0 ){
31794b202ae2Sdanielk1977     return pB==pA;
31802282792aSdrh   }
3181*33e619fcSdrh   assert( !ExprHasAnyProperty(pA, EP_TokenOnly|EP_Reduced) );
3182*33e619fcSdrh   assert( !ExprHasAnyProperty(pB, EP_TokenOnly|EP_Reduced) );
31836ab3a2ecSdanielk1977   if( ExprHasProperty(pA, EP_xIsSelect) || ExprHasProperty(pB, EP_xIsSelect) ){
31846ab3a2ecSdanielk1977     return 0;
31856ab3a2ecSdanielk1977   }
3186fd357974Sdrh   if( (pA->flags & EP_Distinct)!=(pB->flags & EP_Distinct) ) return 0;
31876ab3a2ecSdanielk1977   if( pA->op!=pB->op ) return 0;
31884adee20fSdanielk1977   if( !sqlite3ExprCompare(pA->pLeft, pB->pLeft) ) return 0;
31894adee20fSdanielk1977   if( !sqlite3ExprCompare(pA->pRight, pB->pRight) ) return 0;
31906ab3a2ecSdanielk1977 
31916ab3a2ecSdanielk1977   if( pA->x.pList && pB->x.pList ){
31926ab3a2ecSdanielk1977     if( pA->x.pList->nExpr!=pB->x.pList->nExpr ) return 0;
31936ab3a2ecSdanielk1977     for(i=0; i<pA->x.pList->nExpr; i++){
31946ab3a2ecSdanielk1977       Expr *pExprA = pA->x.pList->a[i].pExpr;
31956ab3a2ecSdanielk1977       Expr *pExprB = pB->x.pList->a[i].pExpr;
31966ab3a2ecSdanielk1977       if( !sqlite3ExprCompare(pExprA, pExprB) ) return 0;
31976ab3a2ecSdanielk1977     }
31986ab3a2ecSdanielk1977   }else if( pA->x.pList || pB->x.pList ){
31992282792aSdrh     return 0;
32002282792aSdrh   }
32016ab3a2ecSdanielk1977 
32022f2c01e5Sdrh   if( pA->iTable!=pB->iTable || pA->iColumn!=pB->iColumn ) return 0;
3203*33e619fcSdrh   if( ExprHasProperty(pA, EP_IntValue) ){
3204*33e619fcSdrh     if( !ExprHasProperty(pB, EP_IntValue) || pA->u.iValue!=pB->u.iValue ){
3205*33e619fcSdrh       return 0;
3206*33e619fcSdrh     }
3207*33e619fcSdrh   }else if( pA->op!=TK_COLUMN && pA->u.zToken ){
3208*33e619fcSdrh     if( ExprHasProperty(pB, EP_IntValue) || pB->u.zToken==0 ) return 0;
3209*33e619fcSdrh     if( sqlite3StrICmp(pA->u.zToken,pB->u.zToken)!=0 ){
32102646da7eSdrh       return 0;
32112646da7eSdrh     }
32122282792aSdrh   }
32132282792aSdrh   return 1;
32142282792aSdrh }
32152282792aSdrh 
321613449892Sdrh 
32172282792aSdrh /*
321813449892Sdrh ** Add a new element to the pAggInfo->aCol[] array.  Return the index of
321913449892Sdrh ** the new element.  Return a negative number if malloc fails.
32202282792aSdrh */
322117435752Sdrh static int addAggInfoColumn(sqlite3 *db, AggInfo *pInfo){
322213449892Sdrh   int i;
3223cf643729Sdrh   pInfo->aCol = sqlite3ArrayAllocate(
322417435752Sdrh        db,
3225cf643729Sdrh        pInfo->aCol,
3226cf643729Sdrh        sizeof(pInfo->aCol[0]),
3227cf643729Sdrh        3,
3228cf643729Sdrh        &pInfo->nColumn,
3229cf643729Sdrh        &pInfo->nColumnAlloc,
3230cf643729Sdrh        &i
3231cf643729Sdrh   );
323213449892Sdrh   return i;
32332282792aSdrh }
323413449892Sdrh 
323513449892Sdrh /*
323613449892Sdrh ** Add a new element to the pAggInfo->aFunc[] array.  Return the index of
323713449892Sdrh ** the new element.  Return a negative number if malloc fails.
323813449892Sdrh */
323917435752Sdrh static int addAggInfoFunc(sqlite3 *db, AggInfo *pInfo){
324013449892Sdrh   int i;
3241cf643729Sdrh   pInfo->aFunc = sqlite3ArrayAllocate(
324217435752Sdrh        db,
3243cf643729Sdrh        pInfo->aFunc,
3244cf643729Sdrh        sizeof(pInfo->aFunc[0]),
3245cf643729Sdrh        3,
3246cf643729Sdrh        &pInfo->nFunc,
3247cf643729Sdrh        &pInfo->nFuncAlloc,
3248cf643729Sdrh        &i
3249cf643729Sdrh   );
325013449892Sdrh   return i;
32512282792aSdrh }
32522282792aSdrh 
32532282792aSdrh /*
32547d10d5a6Sdrh ** This is the xExprCallback for a tree walker.  It is used to
32557d10d5a6Sdrh ** implement sqlite3ExprAnalyzeAggregates().  See sqlite3ExprAnalyzeAggregates
3256626a879aSdrh ** for additional information.
32572282792aSdrh */
32587d10d5a6Sdrh static int analyzeAggregate(Walker *pWalker, Expr *pExpr){
32592282792aSdrh   int i;
32607d10d5a6Sdrh   NameContext *pNC = pWalker->u.pNC;
3261a58fdfb1Sdanielk1977   Parse *pParse = pNC->pParse;
3262a58fdfb1Sdanielk1977   SrcList *pSrcList = pNC->pSrcList;
326313449892Sdrh   AggInfo *pAggInfo = pNC->pAggInfo;
326413449892Sdrh 
32652282792aSdrh   switch( pExpr->op ){
326689c69d00Sdrh     case TK_AGG_COLUMN:
3267967e8b73Sdrh     case TK_COLUMN: {
32688b213899Sdrh       testcase( pExpr->op==TK_AGG_COLUMN );
32698b213899Sdrh       testcase( pExpr->op==TK_COLUMN );
327013449892Sdrh       /* Check to see if the column is in one of the tables in the FROM
327113449892Sdrh       ** clause of the aggregate query */
327213449892Sdrh       if( pSrcList ){
327313449892Sdrh         struct SrcList_item *pItem = pSrcList->a;
327413449892Sdrh         for(i=0; i<pSrcList->nSrc; i++, pItem++){
327513449892Sdrh           struct AggInfo_col *pCol;
3276*33e619fcSdrh           assert( !ExprHasAnyProperty(pExpr, EP_TokenOnly|EP_Reduced) );
327713449892Sdrh           if( pExpr->iTable==pItem->iCursor ){
327813449892Sdrh             /* If we reach this point, it means that pExpr refers to a table
327913449892Sdrh             ** that is in the FROM clause of the aggregate query.
328013449892Sdrh             **
328113449892Sdrh             ** Make an entry for the column in pAggInfo->aCol[] if there
328213449892Sdrh             ** is not an entry there already.
328313449892Sdrh             */
32847f906d63Sdrh             int k;
328513449892Sdrh             pCol = pAggInfo->aCol;
32867f906d63Sdrh             for(k=0; k<pAggInfo->nColumn; k++, pCol++){
328713449892Sdrh               if( pCol->iTable==pExpr->iTable &&
328813449892Sdrh                   pCol->iColumn==pExpr->iColumn ){
32892282792aSdrh                 break;
32902282792aSdrh               }
32912282792aSdrh             }
32921e536953Sdanielk1977             if( (k>=pAggInfo->nColumn)
32931e536953Sdanielk1977              && (k = addAggInfoColumn(pParse->db, pAggInfo))>=0
32941e536953Sdanielk1977             ){
32957f906d63Sdrh               pCol = &pAggInfo->aCol[k];
32960817d0dfSdanielk1977               pCol->pTab = pExpr->pTab;
329713449892Sdrh               pCol->iTable = pExpr->iTable;
329813449892Sdrh               pCol->iColumn = pExpr->iColumn;
32990a07c107Sdrh               pCol->iMem = ++pParse->nMem;
330013449892Sdrh               pCol->iSorterColumn = -1;
33015774b806Sdrh               pCol->pExpr = pExpr;
330213449892Sdrh               if( pAggInfo->pGroupBy ){
330313449892Sdrh                 int j, n;
330413449892Sdrh                 ExprList *pGB = pAggInfo->pGroupBy;
330513449892Sdrh                 struct ExprList_item *pTerm = pGB->a;
330613449892Sdrh                 n = pGB->nExpr;
330713449892Sdrh                 for(j=0; j<n; j++, pTerm++){
330813449892Sdrh                   Expr *pE = pTerm->pExpr;
330913449892Sdrh                   if( pE->op==TK_COLUMN && pE->iTable==pExpr->iTable &&
331013449892Sdrh                       pE->iColumn==pExpr->iColumn ){
331113449892Sdrh                     pCol->iSorterColumn = j;
331213449892Sdrh                     break;
33132282792aSdrh                   }
331413449892Sdrh                 }
331513449892Sdrh               }
331613449892Sdrh               if( pCol->iSorterColumn<0 ){
331713449892Sdrh                 pCol->iSorterColumn = pAggInfo->nSortingColumn++;
331813449892Sdrh               }
331913449892Sdrh             }
332013449892Sdrh             /* There is now an entry for pExpr in pAggInfo->aCol[] (either
332113449892Sdrh             ** because it was there before or because we just created it).
332213449892Sdrh             ** Convert the pExpr to be a TK_AGG_COLUMN referring to that
332313449892Sdrh             ** pAggInfo->aCol[] entry.
332413449892Sdrh             */
3325*33e619fcSdrh             ExprSetIrreducible(pExpr);
332613449892Sdrh             pExpr->pAggInfo = pAggInfo;
332713449892Sdrh             pExpr->op = TK_AGG_COLUMN;
33287f906d63Sdrh             pExpr->iAgg = k;
332913449892Sdrh             break;
333013449892Sdrh           } /* endif pExpr->iTable==pItem->iCursor */
333113449892Sdrh         } /* end loop over pSrcList */
3332a58fdfb1Sdanielk1977       }
33337d10d5a6Sdrh       return WRC_Prune;
33342282792aSdrh     }
33352282792aSdrh     case TK_AGG_FUNCTION: {
333613449892Sdrh       /* The pNC->nDepth==0 test causes aggregate functions in subqueries
333713449892Sdrh       ** to be ignored */
3338a58fdfb1Sdanielk1977       if( pNC->nDepth==0 ){
333913449892Sdrh         /* Check to see if pExpr is a duplicate of another aggregate
334013449892Sdrh         ** function that is already in the pAggInfo structure
334113449892Sdrh         */
334213449892Sdrh         struct AggInfo_func *pItem = pAggInfo->aFunc;
334313449892Sdrh         for(i=0; i<pAggInfo->nFunc; i++, pItem++){
334413449892Sdrh           if( sqlite3ExprCompare(pItem->pExpr, pExpr) ){
33452282792aSdrh             break;
33462282792aSdrh           }
33472282792aSdrh         }
334813449892Sdrh         if( i>=pAggInfo->nFunc ){
334913449892Sdrh           /* pExpr is original.  Make a new entry in pAggInfo->aFunc[]
335013449892Sdrh           */
335114db2665Sdanielk1977           u8 enc = ENC(pParse->db);
33521e536953Sdanielk1977           i = addAggInfoFunc(pParse->db, pAggInfo);
335313449892Sdrh           if( i>=0 ){
33546ab3a2ecSdanielk1977             assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
335513449892Sdrh             pItem = &pAggInfo->aFunc[i];
335613449892Sdrh             pItem->pExpr = pExpr;
33570a07c107Sdrh             pItem->iMem = ++pParse->nMem;
3358*33e619fcSdrh             assert( !ExprHasProperty(pExpr, EP_IntValue) );
335913449892Sdrh             pItem->pFunc = sqlite3FindFunction(pParse->db,
3360*33e619fcSdrh                    pExpr->u.zToken, sqlite3Strlen30(pExpr->u.zToken),
33616ab3a2ecSdanielk1977                    pExpr->x.pList ? pExpr->x.pList->nExpr : 0, enc, 0);
3362fd357974Sdrh             if( pExpr->flags & EP_Distinct ){
3363fd357974Sdrh               pItem->iDistinct = pParse->nTab++;
3364fd357974Sdrh             }else{
3365fd357974Sdrh               pItem->iDistinct = -1;
3366fd357974Sdrh             }
33672282792aSdrh           }
336813449892Sdrh         }
336913449892Sdrh         /* Make pExpr point to the appropriate pAggInfo->aFunc[] entry
337013449892Sdrh         */
3371*33e619fcSdrh         assert( !ExprHasAnyProperty(pExpr, EP_TokenOnly|EP_Reduced) );
3372*33e619fcSdrh         ExprSetIrreducible(pExpr);
33732282792aSdrh         pExpr->iAgg = i;
337413449892Sdrh         pExpr->pAggInfo = pAggInfo;
33757d10d5a6Sdrh         return WRC_Prune;
33762282792aSdrh       }
33772282792aSdrh     }
3378a58fdfb1Sdanielk1977   }
33797d10d5a6Sdrh   return WRC_Continue;
33807d10d5a6Sdrh }
33817d10d5a6Sdrh static int analyzeAggregatesInSelect(Walker *pWalker, Select *pSelect){
33827d10d5a6Sdrh   NameContext *pNC = pWalker->u.pNC;
33837d10d5a6Sdrh   if( pNC->nDepth==0 ){
3384a58fdfb1Sdanielk1977     pNC->nDepth++;
33857d10d5a6Sdrh     sqlite3WalkSelect(pWalker, pSelect);
3386a58fdfb1Sdanielk1977     pNC->nDepth--;
33877d10d5a6Sdrh     return WRC_Prune;
33887d10d5a6Sdrh   }else{
33897d10d5a6Sdrh     return WRC_Continue;
3390a58fdfb1Sdanielk1977   }
33912282792aSdrh }
3392626a879aSdrh 
3393626a879aSdrh /*
3394626a879aSdrh ** Analyze the given expression looking for aggregate functions and
3395626a879aSdrh ** for variables that need to be added to the pParse->aAgg[] array.
3396626a879aSdrh ** Make additional entries to the pParse->aAgg[] array as necessary.
3397626a879aSdrh **
3398626a879aSdrh ** This routine should only be called after the expression has been
33997d10d5a6Sdrh ** analyzed by sqlite3ResolveExprNames().
3400626a879aSdrh */
3401d2b3e23bSdrh void sqlite3ExprAnalyzeAggregates(NameContext *pNC, Expr *pExpr){
34027d10d5a6Sdrh   Walker w;
34037d10d5a6Sdrh   w.xExprCallback = analyzeAggregate;
34047d10d5a6Sdrh   w.xSelectCallback = analyzeAggregatesInSelect;
34057d10d5a6Sdrh   w.u.pNC = pNC;
34067d10d5a6Sdrh   sqlite3WalkExpr(&w, pExpr);
34072282792aSdrh }
34085d9a4af9Sdrh 
34095d9a4af9Sdrh /*
34105d9a4af9Sdrh ** Call sqlite3ExprAnalyzeAggregates() for every expression in an
34115d9a4af9Sdrh ** expression list.  Return the number of errors.
34125d9a4af9Sdrh **
34135d9a4af9Sdrh ** If an error is found, the analysis is cut short.
34145d9a4af9Sdrh */
3415d2b3e23bSdrh void sqlite3ExprAnalyzeAggList(NameContext *pNC, ExprList *pList){
34165d9a4af9Sdrh   struct ExprList_item *pItem;
34175d9a4af9Sdrh   int i;
34185d9a4af9Sdrh   if( pList ){
3419d2b3e23bSdrh     for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
3420d2b3e23bSdrh       sqlite3ExprAnalyzeAggregates(pNC, pItem->pExpr);
34215d9a4af9Sdrh     }
34225d9a4af9Sdrh   }
34235d9a4af9Sdrh }
3424892d3179Sdrh 
3425892d3179Sdrh /*
3426ceea3321Sdrh ** Allocate a single new register for use to hold some intermediate result.
3427892d3179Sdrh */
3428892d3179Sdrh int sqlite3GetTempReg(Parse *pParse){
3429e55cbd72Sdrh   if( pParse->nTempReg==0 ){
3430892d3179Sdrh     return ++pParse->nMem;
3431892d3179Sdrh   }
34322f425f6bSdanielk1977   return pParse->aTempReg[--pParse->nTempReg];
3433892d3179Sdrh }
3434ceea3321Sdrh 
3435ceea3321Sdrh /*
3436ceea3321Sdrh ** Deallocate a register, making available for reuse for some other
3437ceea3321Sdrh ** purpose.
3438ceea3321Sdrh **
3439ceea3321Sdrh ** If a register is currently being used by the column cache, then
3440ceea3321Sdrh ** the dallocation is deferred until the column cache line that uses
3441ceea3321Sdrh ** the register becomes stale.
3442ceea3321Sdrh */
3443892d3179Sdrh void sqlite3ReleaseTempReg(Parse *pParse, int iReg){
34442dcef11bSdrh   if( iReg && pParse->nTempReg<ArraySize(pParse->aTempReg) ){
3445ceea3321Sdrh     int i;
3446ceea3321Sdrh     struct yColCache *p;
3447ceea3321Sdrh     for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
3448ceea3321Sdrh       if( p->iReg==iReg ){
3449ceea3321Sdrh         p->tempReg = 1;
3450ceea3321Sdrh         return;
3451ceea3321Sdrh       }
3452ceea3321Sdrh     }
3453892d3179Sdrh     pParse->aTempReg[pParse->nTempReg++] = iReg;
3454892d3179Sdrh   }
3455892d3179Sdrh }
3456892d3179Sdrh 
3457892d3179Sdrh /*
3458892d3179Sdrh ** Allocate or deallocate a block of nReg consecutive registers
3459892d3179Sdrh */
3460892d3179Sdrh int sqlite3GetTempRange(Parse *pParse, int nReg){
3461e55cbd72Sdrh   int i, n;
3462892d3179Sdrh   i = pParse->iRangeReg;
3463e55cbd72Sdrh   n = pParse->nRangeReg;
3464e55cbd72Sdrh   if( nReg<=n && !usedAsColumnCache(pParse, i, i+n-1) ){
3465892d3179Sdrh     pParse->iRangeReg += nReg;
3466892d3179Sdrh     pParse->nRangeReg -= nReg;
3467892d3179Sdrh   }else{
3468892d3179Sdrh     i = pParse->nMem+1;
3469892d3179Sdrh     pParse->nMem += nReg;
3470892d3179Sdrh   }
3471892d3179Sdrh   return i;
3472892d3179Sdrh }
3473892d3179Sdrh void sqlite3ReleaseTempRange(Parse *pParse, int iReg, int nReg){
3474892d3179Sdrh   if( nReg>pParse->nRangeReg ){
3475892d3179Sdrh     pParse->nRangeReg = nReg;
3476892d3179Sdrh     pParse->iRangeReg = iReg;
3477892d3179Sdrh   }
3478892d3179Sdrh }
3479