xref: /sqlite-3.40.0/src/expr.c (revision e3365e6c)
1cce7d176Sdrh /*
2b19a2bc6Sdrh ** 2001 September 15
3cce7d176Sdrh **
4b19a2bc6Sdrh ** The author disclaims copyright to this source code.  In place of
5b19a2bc6Sdrh ** a legal notice, here is a blessing:
6cce7d176Sdrh **
7b19a2bc6Sdrh **    May you do good and not evil.
8b19a2bc6Sdrh **    May you find forgiveness for yourself and forgive others.
9b19a2bc6Sdrh **    May you share freely, never taking more than you give.
10cce7d176Sdrh **
11cce7d176Sdrh *************************************************************************
121ccde15dSdrh ** This file contains routines used for analyzing expressions and
13b19a2bc6Sdrh ** for generating VDBE code that evaluates expressions in SQLite.
14cce7d176Sdrh */
15cce7d176Sdrh #include "sqliteInt.h"
16a2e00042Sdrh 
17e014a838Sdanielk1977 /*
18e014a838Sdanielk1977 ** Return the 'affinity' of the expression pExpr if any.
19e014a838Sdanielk1977 **
20e014a838Sdanielk1977 ** If pExpr is a column, a reference to a column via an 'AS' alias,
21e014a838Sdanielk1977 ** or a sub-select with a column as the return value, then the
22e014a838Sdanielk1977 ** affinity of that column is returned. Otherwise, 0x00 is returned,
23e014a838Sdanielk1977 ** indicating no affinity for the expression.
24e014a838Sdanielk1977 **
25e014a838Sdanielk1977 ** i.e. the WHERE clause expresssions in the following statements all
26e014a838Sdanielk1977 ** have an affinity:
27e014a838Sdanielk1977 **
28e014a838Sdanielk1977 ** CREATE TABLE t1(a);
29e014a838Sdanielk1977 ** SELECT * FROM t1 WHERE a;
30e014a838Sdanielk1977 ** SELECT a AS b FROM t1 WHERE b;
31e014a838Sdanielk1977 ** SELECT * FROM t1 WHERE (select a from t1);
32e014a838Sdanielk1977 */
33bf3b721fSdanielk1977 char sqlite3ExprAffinity(Expr *pExpr){
34487e262fSdrh   int op = pExpr->op;
35487e262fSdrh   if( op==TK_SELECT ){
366ab3a2ecSdanielk1977     assert( pExpr->flags&EP_xIsSelect );
376ab3a2ecSdanielk1977     return sqlite3ExprAffinity(pExpr->x.pSelect->pEList->a[0].pExpr);
38a37cdde0Sdanielk1977   }
39487e262fSdrh #ifndef SQLITE_OMIT_CAST
40487e262fSdrh   if( op==TK_CAST ){
4133e619fcSdrh     assert( !ExprHasProperty(pExpr, EP_IntValue) );
4233e619fcSdrh     return sqlite3AffinityType(pExpr->u.zToken);
43487e262fSdrh   }
44487e262fSdrh #endif
45259a455fSdanielk1977   if( (op==TK_AGG_COLUMN || op==TK_COLUMN || op==TK_REGISTER)
46259a455fSdanielk1977    && pExpr->pTab!=0
47259a455fSdanielk1977   ){
487d10d5a6Sdrh     /* op==TK_REGISTER && pExpr->pTab!=0 happens when pExpr was originally
497d10d5a6Sdrh     ** a TK_COLUMN but was previously evaluated and cached in a register */
507d10d5a6Sdrh     int j = pExpr->iColumn;
517d10d5a6Sdrh     if( j<0 ) return SQLITE_AFF_INTEGER;
527d10d5a6Sdrh     assert( pExpr->pTab && j<pExpr->pTab->nCol );
537d10d5a6Sdrh     return pExpr->pTab->aCol[j].affinity;
547d10d5a6Sdrh   }
55a37cdde0Sdanielk1977   return pExpr->affinity;
56a37cdde0Sdanielk1977 }
57a37cdde0Sdanielk1977 
5853db1458Sdrh /*
598b4c40d8Sdrh ** Set the collating sequence for expression pExpr to be the collating
608b4c40d8Sdrh ** sequence named by pToken.   Return a pointer to the revised expression.
61a34001c9Sdrh ** The collating sequence is marked as "explicit" using the EP_ExpCollate
62a34001c9Sdrh ** flag.  An explicit collating sequence will override implicit
63a34001c9Sdrh ** collating sequences.
648b4c40d8Sdrh */
657d10d5a6Sdrh Expr *sqlite3ExprSetColl(Parse *pParse, Expr *pExpr, Token *pCollName){
6639002505Sdanielk1977   char *zColl = 0;            /* Dequoted name of collation sequence */
678b4c40d8Sdrh   CollSeq *pColl;
68633e6d57Sdrh   sqlite3 *db = pParse->db;
697d10d5a6Sdrh   zColl = sqlite3NameFromToken(db, pCollName);
7039002505Sdanielk1977   if( pExpr && zColl ){
71c4a64facSdrh     pColl = sqlite3LocateCollSeq(pParse, zColl);
728b4c40d8Sdrh     if( pColl ){
738b4c40d8Sdrh       pExpr->pColl = pColl;
748b4c40d8Sdrh       pExpr->flags |= EP_ExpCollate;
758b4c40d8Sdrh     }
7639002505Sdanielk1977   }
77633e6d57Sdrh   sqlite3DbFree(db, zColl);
788b4c40d8Sdrh   return pExpr;
798b4c40d8Sdrh }
808b4c40d8Sdrh 
818b4c40d8Sdrh /*
820202b29eSdanielk1977 ** Return the default collation sequence for the expression pExpr. If
830202b29eSdanielk1977 ** there is no default collation type, return 0.
840202b29eSdanielk1977 */
857cedc8d4Sdanielk1977 CollSeq *sqlite3ExprCollSeq(Parse *pParse, Expr *pExpr){
867cedc8d4Sdanielk1977   CollSeq *pColl = 0;
877d10d5a6Sdrh   Expr *p = pExpr;
8851f49f17Sdrh   while( ALWAYS(p) ){
897e09fe0bSdrh     int op;
907d10d5a6Sdrh     pColl = p->pColl;
917d10d5a6Sdrh     if( pColl ) break;
927d10d5a6Sdrh     op = p->op;
9376d462eeSdan     if( p->pTab!=0 && (
9476d462eeSdan         op==TK_AGG_COLUMN || op==TK_COLUMN || op==TK_REGISTER || op==TK_TRIGGER
9576d462eeSdan     )){
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 ||
1556a2fe093Sdrh           pExpr->op==TK_NE || pExpr->op==TK_IS || pExpr->op==TK_ISNOT );
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.
39233e619fcSdrh **
39333e619fcSdrh ** Special case:  If op==TK_INTEGER and pToken points to a string that
39433e619fcSdrh ** can be translated into a 32-bit integer, then the token is not
39533e619fcSdrh ** stored in u.zToken.  Instead, the integer values is written
39633e619fcSdrh ** into u.iValue and the EP_IntValue flag is set.  No extra storage
39733e619fcSdrh ** 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;
40633e619fcSdrh   int nExtra = 0;
407cf697396Sshane   int iValue = 0;
408b7916a78Sdrh 
409b7916a78Sdrh   if( pToken ){
41033e619fcSdrh     if( op!=TK_INTEGER || pToken->z==0
41133e619fcSdrh           || sqlite3GetInt32(pToken->z, &iValue)==0 ){
412b7916a78Sdrh       nExtra = pToken->n+1;
41333e619fcSdrh     }
414a76b5dfcSdrh   }
415b7916a78Sdrh   pNew = sqlite3DbMallocZero(db, sizeof(Expr)+nExtra);
416b7916a78Sdrh   if( pNew ){
4171bd10f8aSdrh     pNew->op = (u8)op;
418a58fdfb1Sdanielk1977     pNew->iAgg = -1;
419a76b5dfcSdrh     if( pToken ){
42033e619fcSdrh       if( nExtra==0 ){
42133e619fcSdrh         pNew->flags |= EP_IntValue;
42233e619fcSdrh         pNew->u.iValue = iValue;
42333e619fcSdrh       }else{
424d9da78a2Sdrh         int c;
42533e619fcSdrh         pNew->u.zToken = (char*)&pNew[1];
42633e619fcSdrh         memcpy(pNew->u.zToken, pToken->z, pToken->n);
42733e619fcSdrh         pNew->u.zToken[pToken->n] = 0;
428b7916a78Sdrh         if( dequote && nExtra>=3
429d9da78a2Sdrh              && ((c = pToken->z[0])=='\'' || c=='"' || c=='[' || c=='`') ){
43033e619fcSdrh           sqlite3Dequote(pNew->u.zToken);
43124fb627aSdrh           if( c=='"' ) pNew->flags |= EP_DblQuoted;
432a34001c9Sdrh         }
433a34001c9Sdrh       }
43433e619fcSdrh     }
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 /*
493bf664469Sdrh ** Allocate a Expr node which joins as many as two subtrees.
494b7916a78Sdrh **
495bf664469Sdrh ** One or both of the subtrees can be NULL.  Return a pointer to the new
496bf664469Sdrh ** Expr node.  Or, if an OOM error occurs, set pParse->db->mallocFailed,
497bf664469Sdrh ** free the subtrees and return NULL.
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;
56733e619fcSdrh   assert( !ExprHasAnyProperty(pExpr, EP_IntValue|EP_Reduced|EP_TokenOnly) );
56833e619fcSdrh   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]=='?' );
5748677d308Sdrh     pExpr->iColumn = (ynVar)(++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 */
578f639c40fSshane     int i = atoi((char*)&z[1]);
5798677d308Sdrh     pExpr->iColumn = (ynVar)i;
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 );
60233e619fcSdrh       if( memcmp(pE->u.zToken, z, n)==0 && pE->u.zToken[n]==0 ){
603937d0deaSdan         pExpr->iColumn = pE->iColumn;
604fa6bc000Sdrh         break;
605fa6bc000Sdrh       }
606fa6bc000Sdrh     }
607fa6bc000Sdrh     if( i>=pParse->nVarExpr ){
6088677d308Sdrh       pExpr->iColumn = (ynVar)(++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){
63433e619fcSdrh   assert( p!=0 );
635b7916a78Sdrh   if( !ExprHasAnyProperty(p, EP_TokenOnly) ){
636633e6d57Sdrh     sqlite3ExprDelete(db, p->pLeft);
637633e6d57Sdrh     sqlite3ExprDelete(db, p->pRight);
63833e619fcSdrh     if( !ExprHasProperty(p, EP_Reduced) && (p->flags2 & EP2_MallocedToken)!=0 ){
63933e619fcSdrh       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);
65533e619fcSdrh   if( !ExprHasProperty(p, EP_Static) ){
656633e6d57Sdrh     sqlite3DbFree(db, p);
657a2e00042Sdrh   }
65833e619fcSdrh }
659a2e00042Sdrh 
660d2687b77Sdrh /*
6616ab3a2ecSdanielk1977 ** Return the number of bytes allocated for the expression structure
6626ab3a2ecSdanielk1977 ** passed as the first argument. This is always one of EXPR_FULLSIZE,
6636ab3a2ecSdanielk1977 ** EXPR_REDUCEDSIZE or EXPR_TOKENONLYSIZE.
6646ab3a2ecSdanielk1977 */
6656ab3a2ecSdanielk1977 static int exprStructSize(Expr *p){
6666ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_TokenOnly) ) return EXPR_TOKENONLYSIZE;
6676ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_Reduced) ) return EXPR_REDUCEDSIZE;
6686ab3a2ecSdanielk1977   return EXPR_FULLSIZE;
6696ab3a2ecSdanielk1977 }
6706ab3a2ecSdanielk1977 
6716ab3a2ecSdanielk1977 /*
67233e619fcSdrh ** The dupedExpr*Size() routines each return the number of bytes required
67333e619fcSdrh ** to store a copy of an expression or expression tree.  They differ in
67433e619fcSdrh ** how much of the tree is measured.
67533e619fcSdrh **
67633e619fcSdrh **     dupedExprStructSize()     Size of only the Expr structure
67733e619fcSdrh **     dupedExprNodeSize()       Size of Expr + space for token
67833e619fcSdrh **     dupedExprSize()           Expr + token + subtree components
67933e619fcSdrh **
68033e619fcSdrh ***************************************************************************
68133e619fcSdrh **
68233e619fcSdrh ** The dupedExprStructSize() function returns two values OR-ed together:
68333e619fcSdrh ** (1) the space required for a copy of the Expr structure only and
68433e619fcSdrh ** (2) the EP_xxx flags that indicate what the structure size should be.
68533e619fcSdrh ** The return values is always one of:
68633e619fcSdrh **
68733e619fcSdrh **      EXPR_FULLSIZE
68833e619fcSdrh **      EXPR_REDUCEDSIZE   | EP_Reduced
68933e619fcSdrh **      EXPR_TOKENONLYSIZE | EP_TokenOnly
69033e619fcSdrh **
69133e619fcSdrh ** The size of the structure can be found by masking the return value
69233e619fcSdrh ** of this routine with 0xfff.  The flags can be found by masking the
69333e619fcSdrh ** return value with EP_Reduced|EP_TokenOnly.
69433e619fcSdrh **
69533e619fcSdrh ** Note that with flags==EXPRDUP_REDUCE, this routines works on full-size
69633e619fcSdrh ** (unreduced) Expr objects as they or originally constructed by the parser.
69733e619fcSdrh ** During expression analysis, extra information is computed and moved into
69833e619fcSdrh ** later parts of teh Expr object and that extra information might get chopped
69933e619fcSdrh ** off if the expression is reduced.  Note also that it does not work to
70033e619fcSdrh ** make a EXPRDUP_REDUCE copy of a reduced expression.  It is only legal
70133e619fcSdrh ** to reduce a pristine expression tree from the parser.  The implementation
70233e619fcSdrh ** of dupedExprStructSize() contain multiple assert() statements that attempt
70333e619fcSdrh ** to enforce this constraint.
7046ab3a2ecSdanielk1977 */
7056ab3a2ecSdanielk1977 static int dupedExprStructSize(Expr *p, int flags){
7066ab3a2ecSdanielk1977   int nSize;
70733e619fcSdrh   assert( flags==EXPRDUP_REDUCE || flags==0 ); /* Only one flag value allowed */
7086ab3a2ecSdanielk1977   if( 0==(flags&EXPRDUP_REDUCE) ){
7096ab3a2ecSdanielk1977     nSize = EXPR_FULLSIZE;
7106ab3a2ecSdanielk1977   }else{
71133e619fcSdrh     assert( !ExprHasAnyProperty(p, EP_TokenOnly|EP_Reduced) );
71233e619fcSdrh     assert( !ExprHasProperty(p, EP_FromJoin) );
71333e619fcSdrh     assert( (p->flags2 & EP2_MallocedToken)==0 );
71433e619fcSdrh     assert( (p->flags2 & EP2_Irreducible)==0 );
71533e619fcSdrh     if( p->pLeft || p->pRight || p->pColl || p->x.pList ){
71633e619fcSdrh       nSize = EXPR_REDUCEDSIZE | EP_Reduced;
71733e619fcSdrh     }else{
71833e619fcSdrh       nSize = EXPR_TOKENONLYSIZE | EP_TokenOnly;
71933e619fcSdrh     }
7206ab3a2ecSdanielk1977   }
7216ab3a2ecSdanielk1977   return nSize;
7226ab3a2ecSdanielk1977 }
7236ab3a2ecSdanielk1977 
7246ab3a2ecSdanielk1977 /*
72533e619fcSdrh ** This function returns the space in bytes required to store the copy
72633e619fcSdrh ** of the Expr structure and a copy of the Expr.u.zToken string (if that
72733e619fcSdrh ** string is defined.)
7286ab3a2ecSdanielk1977 */
7296ab3a2ecSdanielk1977 static int dupedExprNodeSize(Expr *p, int flags){
73033e619fcSdrh   int nByte = dupedExprStructSize(p, flags) & 0xfff;
73133e619fcSdrh   if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
73233e619fcSdrh     nByte += sqlite3Strlen30(p->u.zToken)+1;
7336ab3a2ecSdanielk1977   }
734bc73971dSdanielk1977   return ROUND8(nByte);
7356ab3a2ecSdanielk1977 }
7366ab3a2ecSdanielk1977 
7376ab3a2ecSdanielk1977 /*
7386ab3a2ecSdanielk1977 ** Return the number of bytes required to create a duplicate of the
7396ab3a2ecSdanielk1977 ** expression passed as the first argument. The second argument is a
7406ab3a2ecSdanielk1977 ** mask containing EXPRDUP_XXX flags.
7416ab3a2ecSdanielk1977 **
7426ab3a2ecSdanielk1977 ** The value returned includes space to create a copy of the Expr struct
74333e619fcSdrh ** itself and the buffer referred to by Expr.u.zToken, if any.
7446ab3a2ecSdanielk1977 **
7456ab3a2ecSdanielk1977 ** If the EXPRDUP_REDUCE flag is set, then the return value includes
7466ab3a2ecSdanielk1977 ** space to duplicate all Expr nodes in the tree formed by Expr.pLeft
7476ab3a2ecSdanielk1977 ** and Expr.pRight variables (but not for any structures pointed to or
7486ab3a2ecSdanielk1977 ** descended from the Expr.x.pList or Expr.x.pSelect variables).
7496ab3a2ecSdanielk1977 */
7506ab3a2ecSdanielk1977 static int dupedExprSize(Expr *p, int flags){
7516ab3a2ecSdanielk1977   int nByte = 0;
7526ab3a2ecSdanielk1977   if( p ){
7536ab3a2ecSdanielk1977     nByte = dupedExprNodeSize(p, flags);
7546ab3a2ecSdanielk1977     if( flags&EXPRDUP_REDUCE ){
755b7916a78Sdrh       nByte += dupedExprSize(p->pLeft, flags) + dupedExprSize(p->pRight, flags);
7566ab3a2ecSdanielk1977     }
7576ab3a2ecSdanielk1977   }
7586ab3a2ecSdanielk1977   return nByte;
7596ab3a2ecSdanielk1977 }
7606ab3a2ecSdanielk1977 
7616ab3a2ecSdanielk1977 /*
7626ab3a2ecSdanielk1977 ** This function is similar to sqlite3ExprDup(), except that if pzBuffer
7636ab3a2ecSdanielk1977 ** is not NULL then *pzBuffer is assumed to point to a buffer large enough
76433e619fcSdrh ** to store the copy of expression p, the copies of p->u.zToken
7656ab3a2ecSdanielk1977 ** (if applicable), and the copies of the p->pLeft and p->pRight expressions,
7666ab3a2ecSdanielk1977 ** if any. Before returning, *pzBuffer is set to the first byte passed the
7676ab3a2ecSdanielk1977 ** portion of the buffer copied into by this function.
7686ab3a2ecSdanielk1977 */
7696ab3a2ecSdanielk1977 static Expr *exprDup(sqlite3 *db, Expr *p, int flags, u8 **pzBuffer){
7706ab3a2ecSdanielk1977   Expr *pNew = 0;                      /* Value to return */
7716ab3a2ecSdanielk1977   if( p ){
7726ab3a2ecSdanielk1977     const int isReduced = (flags&EXPRDUP_REDUCE);
7736ab3a2ecSdanielk1977     u8 *zAlloc;
77433e619fcSdrh     u32 staticFlag = 0;
7756ab3a2ecSdanielk1977 
7766ab3a2ecSdanielk1977     assert( pzBuffer==0 || isReduced );
7776ab3a2ecSdanielk1977 
7786ab3a2ecSdanielk1977     /* Figure out where to write the new Expr structure. */
7796ab3a2ecSdanielk1977     if( pzBuffer ){
7806ab3a2ecSdanielk1977       zAlloc = *pzBuffer;
78133e619fcSdrh       staticFlag = EP_Static;
7826ab3a2ecSdanielk1977     }else{
7836ab3a2ecSdanielk1977       zAlloc = sqlite3DbMallocRaw(db, dupedExprSize(p, flags));
7846ab3a2ecSdanielk1977     }
7856ab3a2ecSdanielk1977     pNew = (Expr *)zAlloc;
7866ab3a2ecSdanielk1977 
7876ab3a2ecSdanielk1977     if( pNew ){
7886ab3a2ecSdanielk1977       /* Set nNewSize to the size allocated for the structure pointed to
7896ab3a2ecSdanielk1977       ** by pNew. This is either EXPR_FULLSIZE, EXPR_REDUCEDSIZE or
7906ab3a2ecSdanielk1977       ** EXPR_TOKENONLYSIZE. nToken is set to the number of bytes consumed
79133e619fcSdrh       ** by the copy of the p->u.zToken string (if any).
7926ab3a2ecSdanielk1977       */
79333e619fcSdrh       const unsigned nStructSize = dupedExprStructSize(p, flags);
79433e619fcSdrh       const int nNewSize = nStructSize & 0xfff;
79533e619fcSdrh       int nToken;
79633e619fcSdrh       if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
79733e619fcSdrh         nToken = sqlite3Strlen30(p->u.zToken) + 1;
79833e619fcSdrh       }else{
79933e619fcSdrh         nToken = 0;
80033e619fcSdrh       }
8016ab3a2ecSdanielk1977       if( isReduced ){
8026ab3a2ecSdanielk1977         assert( ExprHasProperty(p, EP_Reduced)==0 );
8036ab3a2ecSdanielk1977         memcpy(zAlloc, p, nNewSize);
8046ab3a2ecSdanielk1977       }else{
8056ab3a2ecSdanielk1977         int nSize = exprStructSize(p);
8066ab3a2ecSdanielk1977         memcpy(zAlloc, p, nSize);
8076ab3a2ecSdanielk1977         memset(&zAlloc[nSize], 0, EXPR_FULLSIZE-nSize);
8086ab3a2ecSdanielk1977       }
8096ab3a2ecSdanielk1977 
81033e619fcSdrh       /* Set the EP_Reduced, EP_TokenOnly, and EP_Static flags appropriately. */
81133e619fcSdrh       pNew->flags &= ~(EP_Reduced|EP_TokenOnly|EP_Static);
81233e619fcSdrh       pNew->flags |= nStructSize & (EP_Reduced|EP_TokenOnly);
81333e619fcSdrh       pNew->flags |= staticFlag;
8146ab3a2ecSdanielk1977 
81533e619fcSdrh       /* Copy the p->u.zToken string, if any. */
8166ab3a2ecSdanielk1977       if( nToken ){
81733e619fcSdrh         char *zToken = pNew->u.zToken = (char*)&zAlloc[nNewSize];
81833e619fcSdrh         memcpy(zToken, p->u.zToken, nToken);
8196ab3a2ecSdanielk1977       }
8206ab3a2ecSdanielk1977 
8216ab3a2ecSdanielk1977       if( 0==((p->flags|pNew->flags) & EP_TokenOnly) ){
8226ab3a2ecSdanielk1977         /* Fill in the pNew->x.pSelect or pNew->x.pList member. */
8236ab3a2ecSdanielk1977         if( ExprHasProperty(p, EP_xIsSelect) ){
8246ab3a2ecSdanielk1977           pNew->x.pSelect = sqlite3SelectDup(db, p->x.pSelect, isReduced);
8256ab3a2ecSdanielk1977         }else{
8266ab3a2ecSdanielk1977           pNew->x.pList = sqlite3ExprListDup(db, p->x.pList, isReduced);
8276ab3a2ecSdanielk1977         }
8286ab3a2ecSdanielk1977       }
8296ab3a2ecSdanielk1977 
8306ab3a2ecSdanielk1977       /* Fill in pNew->pLeft and pNew->pRight. */
831b7916a78Sdrh       if( ExprHasAnyProperty(pNew, EP_Reduced|EP_TokenOnly) ){
8326ab3a2ecSdanielk1977         zAlloc += dupedExprNodeSize(p, flags);
8336ab3a2ecSdanielk1977         if( ExprHasProperty(pNew, EP_Reduced) ){
8346ab3a2ecSdanielk1977           pNew->pLeft = exprDup(db, p->pLeft, EXPRDUP_REDUCE, &zAlloc);
8356ab3a2ecSdanielk1977           pNew->pRight = exprDup(db, p->pRight, EXPRDUP_REDUCE, &zAlloc);
8366ab3a2ecSdanielk1977         }
8376ab3a2ecSdanielk1977         if( pzBuffer ){
8386ab3a2ecSdanielk1977           *pzBuffer = zAlloc;
8396ab3a2ecSdanielk1977         }
840b7916a78Sdrh       }else{
841b7916a78Sdrh         pNew->flags2 = 0;
842b7916a78Sdrh         if( !ExprHasAnyProperty(p, EP_TokenOnly) ){
8436ab3a2ecSdanielk1977           pNew->pLeft = sqlite3ExprDup(db, p->pLeft, 0);
8446ab3a2ecSdanielk1977           pNew->pRight = sqlite3ExprDup(db, p->pRight, 0);
8456ab3a2ecSdanielk1977         }
8466ab3a2ecSdanielk1977       }
847b7916a78Sdrh 
848b7916a78Sdrh     }
8496ab3a2ecSdanielk1977   }
8506ab3a2ecSdanielk1977   return pNew;
8516ab3a2ecSdanielk1977 }
8526ab3a2ecSdanielk1977 
8536ab3a2ecSdanielk1977 /*
854ff78bd2fSdrh ** The following group of routines make deep copies of expressions,
855ff78bd2fSdrh ** expression lists, ID lists, and select statements.  The copies can
856ff78bd2fSdrh ** be deleted (by being passed to their respective ...Delete() routines)
857ff78bd2fSdrh ** without effecting the originals.
858ff78bd2fSdrh **
8594adee20fSdanielk1977 ** The expression list, ID, and source lists return by sqlite3ExprListDup(),
8604adee20fSdanielk1977 ** sqlite3IdListDup(), and sqlite3SrcListDup() can not be further expanded
861ad3cab52Sdrh ** by subsequent calls to sqlite*ListAppend() routines.
862ff78bd2fSdrh **
863ad3cab52Sdrh ** Any tables that the SrcList might point to are not duplicated.
8646ab3a2ecSdanielk1977 **
865b7916a78Sdrh ** The flags parameter contains a combination of the EXPRDUP_XXX flags.
8666ab3a2ecSdanielk1977 ** If the EXPRDUP_REDUCE flag is set, then the structure returned is a
8676ab3a2ecSdanielk1977 ** truncated version of the usual Expr structure that will be stored as
8686ab3a2ecSdanielk1977 ** part of the in-memory representation of the database schema.
869ff78bd2fSdrh */
8706ab3a2ecSdanielk1977 Expr *sqlite3ExprDup(sqlite3 *db, Expr *p, int flags){
8716ab3a2ecSdanielk1977   return exprDup(db, p, flags, 0);
872ff78bd2fSdrh }
8736ab3a2ecSdanielk1977 ExprList *sqlite3ExprListDup(sqlite3 *db, ExprList *p, int flags){
874ff78bd2fSdrh   ExprList *pNew;
875145716b3Sdrh   struct ExprList_item *pItem, *pOldItem;
876ff78bd2fSdrh   int i;
877ff78bd2fSdrh   if( p==0 ) return 0;
87817435752Sdrh   pNew = sqlite3DbMallocRaw(db, sizeof(*pNew) );
879ff78bd2fSdrh   if( pNew==0 ) return 0;
88031dad9daSdanielk1977   pNew->iECursor = 0;
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 *pOldExpr = pOldItem->pExpr;
890b5526ea6Sdrh     pItem->pExpr = sqlite3ExprDup(db, pOldExpr, flags);
89117435752Sdrh     pItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
892b7916a78Sdrh     pItem->zSpan = sqlite3DbStrDup(db, pOldItem->zSpan);
893145716b3Sdrh     pItem->sortOrder = pOldItem->sortOrder;
8943e7bc9caSdrh     pItem->done = 0;
8957d10d5a6Sdrh     pItem->iCol = pOldItem->iCol;
8968b213899Sdrh     pItem->iAlias = pOldItem->iAlias;
897ff78bd2fSdrh   }
898ff78bd2fSdrh   return pNew;
899ff78bd2fSdrh }
90093758c8dSdanielk1977 
90193758c8dSdanielk1977 /*
90293758c8dSdanielk1977 ** If cursors, triggers, views and subqueries are all omitted from
90393758c8dSdanielk1977 ** the build, then none of the following routines, except for
90493758c8dSdanielk1977 ** sqlite3SelectDup(), can be called. sqlite3SelectDup() is sometimes
90593758c8dSdanielk1977 ** called with a NULL argument.
90693758c8dSdanielk1977 */
9076a67fe8eSdanielk1977 #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_TRIGGER) \
9086a67fe8eSdanielk1977  || !defined(SQLITE_OMIT_SUBQUERY)
9096ab3a2ecSdanielk1977 SrcList *sqlite3SrcListDup(sqlite3 *db, SrcList *p, int flags){
910ad3cab52Sdrh   SrcList *pNew;
911ad3cab52Sdrh   int i;
912113088ecSdrh   int nByte;
913ad3cab52Sdrh   if( p==0 ) return 0;
914113088ecSdrh   nByte = sizeof(*p) + (p->nSrc>0 ? sizeof(p->a[0]) * (p->nSrc-1) : 0);
91517435752Sdrh   pNew = sqlite3DbMallocRaw(db, nByte );
916ad3cab52Sdrh   if( pNew==0 ) return 0;
9174305d103Sdrh   pNew->nSrc = pNew->nAlloc = p->nSrc;
918ad3cab52Sdrh   for(i=0; i<p->nSrc; i++){
9194efc4754Sdrh     struct SrcList_item *pNewItem = &pNew->a[i];
9204efc4754Sdrh     struct SrcList_item *pOldItem = &p->a[i];
921ed8a3bb1Sdrh     Table *pTab;
92217435752Sdrh     pNewItem->zDatabase = sqlite3DbStrDup(db, pOldItem->zDatabase);
92317435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
92417435752Sdrh     pNewItem->zAlias = sqlite3DbStrDup(db, pOldItem->zAlias);
9254efc4754Sdrh     pNewItem->jointype = pOldItem->jointype;
9264efc4754Sdrh     pNewItem->iCursor = pOldItem->iCursor;
9271787ccabSdanielk1977     pNewItem->isPopulated = pOldItem->isPopulated;
92885574e31Sdanielk1977     pNewItem->zIndex = sqlite3DbStrDup(db, pOldItem->zIndex);
92985574e31Sdanielk1977     pNewItem->notIndexed = pOldItem->notIndexed;
93085574e31Sdanielk1977     pNewItem->pIndex = pOldItem->pIndex;
931ed8a3bb1Sdrh     pTab = pNewItem->pTab = pOldItem->pTab;
932ed8a3bb1Sdrh     if( pTab ){
933ed8a3bb1Sdrh       pTab->nRef++;
934a1cb183dSdanielk1977     }
9356ab3a2ecSdanielk1977     pNewItem->pSelect = sqlite3SelectDup(db, pOldItem->pSelect, flags);
9366ab3a2ecSdanielk1977     pNewItem->pOn = sqlite3ExprDup(db, pOldItem->pOn, flags);
93717435752Sdrh     pNewItem->pUsing = sqlite3IdListDup(db, pOldItem->pUsing);
9386c18b6e0Sdanielk1977     pNewItem->colUsed = pOldItem->colUsed;
939ad3cab52Sdrh   }
940ad3cab52Sdrh   return pNew;
941ad3cab52Sdrh }
94217435752Sdrh IdList *sqlite3IdListDup(sqlite3 *db, IdList *p){
943ff78bd2fSdrh   IdList *pNew;
944ff78bd2fSdrh   int i;
945ff78bd2fSdrh   if( p==0 ) return 0;
94617435752Sdrh   pNew = sqlite3DbMallocRaw(db, sizeof(*pNew) );
947ff78bd2fSdrh   if( pNew==0 ) return 0;
9484305d103Sdrh   pNew->nId = pNew->nAlloc = p->nId;
94917435752Sdrh   pNew->a = sqlite3DbMallocRaw(db, p->nId*sizeof(p->a[0]) );
950d5d56523Sdanielk1977   if( pNew->a==0 ){
951633e6d57Sdrh     sqlite3DbFree(db, pNew);
952d5d56523Sdanielk1977     return 0;
953d5d56523Sdanielk1977   }
954ff78bd2fSdrh   for(i=0; i<p->nId; i++){
9554efc4754Sdrh     struct IdList_item *pNewItem = &pNew->a[i];
9564efc4754Sdrh     struct IdList_item *pOldItem = &p->a[i];
95717435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
9584efc4754Sdrh     pNewItem->idx = pOldItem->idx;
959ff78bd2fSdrh   }
960ff78bd2fSdrh   return pNew;
961ff78bd2fSdrh }
9626ab3a2ecSdanielk1977 Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
963ff78bd2fSdrh   Select *pNew;
964ff78bd2fSdrh   if( p==0 ) return 0;
96517435752Sdrh   pNew = sqlite3DbMallocRaw(db, sizeof(*p) );
966ff78bd2fSdrh   if( pNew==0 ) return 0;
967b7916a78Sdrh   pNew->pEList = sqlite3ExprListDup(db, p->pEList, flags);
9686ab3a2ecSdanielk1977   pNew->pSrc = sqlite3SrcListDup(db, p->pSrc, flags);
9696ab3a2ecSdanielk1977   pNew->pWhere = sqlite3ExprDup(db, p->pWhere, flags);
9706ab3a2ecSdanielk1977   pNew->pGroupBy = sqlite3ExprListDup(db, p->pGroupBy, flags);
9716ab3a2ecSdanielk1977   pNew->pHaving = sqlite3ExprDup(db, p->pHaving, flags);
9726ab3a2ecSdanielk1977   pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, flags);
973ff78bd2fSdrh   pNew->op = p->op;
9746ab3a2ecSdanielk1977   pNew->pPrior = sqlite3SelectDup(db, p->pPrior, flags);
9756ab3a2ecSdanielk1977   pNew->pLimit = sqlite3ExprDup(db, p->pLimit, flags);
9766ab3a2ecSdanielk1977   pNew->pOffset = sqlite3ExprDup(db, p->pOffset, flags);
97792b01d53Sdrh   pNew->iLimit = 0;
97892b01d53Sdrh   pNew->iOffset = 0;
9797d10d5a6Sdrh   pNew->selFlags = p->selFlags & ~SF_UsesEphemeral;
9800342b1f5Sdrh   pNew->pRightmost = 0;
981b9bb7c18Sdrh   pNew->addrOpenEphm[0] = -1;
982b9bb7c18Sdrh   pNew->addrOpenEphm[1] = -1;
983b9bb7c18Sdrh   pNew->addrOpenEphm[2] = -1;
984ff78bd2fSdrh   return pNew;
985ff78bd2fSdrh }
98693758c8dSdanielk1977 #else
9876ab3a2ecSdanielk1977 Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
98893758c8dSdanielk1977   assert( p==0 );
98993758c8dSdanielk1977   return 0;
99093758c8dSdanielk1977 }
99193758c8dSdanielk1977 #endif
992ff78bd2fSdrh 
993ff78bd2fSdrh 
994ff78bd2fSdrh /*
995a76b5dfcSdrh ** Add a new element to the end of an expression list.  If pList is
996a76b5dfcSdrh ** initially NULL, then create a new expression list.
997b7916a78Sdrh **
998b7916a78Sdrh ** If a memory allocation error occurs, the entire list is freed and
999b7916a78Sdrh ** NULL is returned.  If non-NULL is returned, then it is guaranteed
1000b7916a78Sdrh ** that the new entry was successfully appended.
1001a76b5dfcSdrh */
100217435752Sdrh ExprList *sqlite3ExprListAppend(
100317435752Sdrh   Parse *pParse,          /* Parsing context */
100417435752Sdrh   ExprList *pList,        /* List to which to append. Might be NULL */
1005b7916a78Sdrh   Expr *pExpr             /* Expression to be appended. Might be NULL */
100617435752Sdrh ){
100717435752Sdrh   sqlite3 *db = pParse->db;
1008a76b5dfcSdrh   if( pList==0 ){
100917435752Sdrh     pList = sqlite3DbMallocZero(db, sizeof(ExprList) );
1010a76b5dfcSdrh     if( pList==0 ){
1011d5d56523Sdanielk1977       goto no_mem;
1012a76b5dfcSdrh     }
10134efc4754Sdrh     assert( pList->nAlloc==0 );
1014a76b5dfcSdrh   }
10154305d103Sdrh   if( pList->nAlloc<=pList->nExpr ){
1016d5d56523Sdanielk1977     struct ExprList_item *a;
1017d5d56523Sdanielk1977     int n = pList->nAlloc*2 + 4;
101826783a58Sdanielk1977     a = sqlite3DbRealloc(db, pList->a, n*sizeof(pList->a[0]));
1019d5d56523Sdanielk1977     if( a==0 ){
1020d5d56523Sdanielk1977       goto no_mem;
1021a76b5dfcSdrh     }
1022d5d56523Sdanielk1977     pList->a = a;
10236a1e071fSdrh     pList->nAlloc = sqlite3DbMallocSize(db, a)/sizeof(a[0]);
1024a76b5dfcSdrh   }
10254efc4754Sdrh   assert( pList->a!=0 );
1026b7916a78Sdrh   if( 1 ){
10274efc4754Sdrh     struct ExprList_item *pItem = &pList->a[pList->nExpr++];
10284efc4754Sdrh     memset(pItem, 0, sizeof(*pItem));
1029e94ddc9eSdanielk1977     pItem->pExpr = pExpr;
1030a76b5dfcSdrh   }
1031a76b5dfcSdrh   return pList;
1032d5d56523Sdanielk1977 
1033d5d56523Sdanielk1977 no_mem:
1034d5d56523Sdanielk1977   /* Avoid leaking memory if malloc has failed. */
1035633e6d57Sdrh   sqlite3ExprDelete(db, pExpr);
1036633e6d57Sdrh   sqlite3ExprListDelete(db, pList);
1037d5d56523Sdanielk1977   return 0;
1038a76b5dfcSdrh }
1039a76b5dfcSdrh 
1040a76b5dfcSdrh /*
1041b7916a78Sdrh ** Set the ExprList.a[].zName element of the most recently added item
1042b7916a78Sdrh ** on the expression list.
1043b7916a78Sdrh **
1044b7916a78Sdrh ** pList might be NULL following an OOM error.  But pName should never be
1045b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1046b7916a78Sdrh ** is set.
1047b7916a78Sdrh */
1048b7916a78Sdrh void sqlite3ExprListSetName(
1049b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1050b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
1051b7916a78Sdrh   Token *pName,           /* Name to be added */
1052b7916a78Sdrh   int dequote             /* True to cause the name to be dequoted */
1053b7916a78Sdrh ){
1054b7916a78Sdrh   assert( pList!=0 || pParse->db->mallocFailed!=0 );
1055b7916a78Sdrh   if( pList ){
1056b7916a78Sdrh     struct ExprList_item *pItem;
1057b7916a78Sdrh     assert( pList->nExpr>0 );
1058b7916a78Sdrh     pItem = &pList->a[pList->nExpr-1];
1059b7916a78Sdrh     assert( pItem->zName==0 );
1060b7916a78Sdrh     pItem->zName = sqlite3DbStrNDup(pParse->db, pName->z, pName->n);
1061b7916a78Sdrh     if( dequote && pItem->zName ) sqlite3Dequote(pItem->zName);
1062b7916a78Sdrh   }
1063b7916a78Sdrh }
1064b7916a78Sdrh 
1065b7916a78Sdrh /*
1066b7916a78Sdrh ** Set the ExprList.a[].zSpan element of the most recently added item
1067b7916a78Sdrh ** on the expression list.
1068b7916a78Sdrh **
1069b7916a78Sdrh ** pList might be NULL following an OOM error.  But pSpan should never be
1070b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1071b7916a78Sdrh ** is set.
1072b7916a78Sdrh */
1073b7916a78Sdrh void sqlite3ExprListSetSpan(
1074b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1075b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
1076b7916a78Sdrh   ExprSpan *pSpan         /* The span to be added */
1077b7916a78Sdrh ){
1078b7916a78Sdrh   sqlite3 *db = pParse->db;
1079b7916a78Sdrh   assert( pList!=0 || db->mallocFailed!=0 );
1080b7916a78Sdrh   if( pList ){
1081b7916a78Sdrh     struct ExprList_item *pItem = &pList->a[pList->nExpr-1];
1082b7916a78Sdrh     assert( pList->nExpr>0 );
1083b7916a78Sdrh     assert( db->mallocFailed || pItem->pExpr==pSpan->pExpr );
1084b7916a78Sdrh     sqlite3DbFree(db, pItem->zSpan);
1085b7916a78Sdrh     pItem->zSpan = sqlite3DbStrNDup(db, (char*)pSpan->zStart,
1086cf697396Sshane                                     (int)(pSpan->zEnd - pSpan->zStart));
1087b7916a78Sdrh   }
1088b7916a78Sdrh }
1089b7916a78Sdrh 
1090b7916a78Sdrh /*
10917a15a4beSdanielk1977 ** If the expression list pEList contains more than iLimit elements,
10927a15a4beSdanielk1977 ** leave an error message in pParse.
10937a15a4beSdanielk1977 */
10947a15a4beSdanielk1977 void sqlite3ExprListCheckLength(
10957a15a4beSdanielk1977   Parse *pParse,
10967a15a4beSdanielk1977   ExprList *pEList,
10977a15a4beSdanielk1977   const char *zObject
10987a15a4beSdanielk1977 ){
1099b1a6c3c1Sdrh   int mx = pParse->db->aLimit[SQLITE_LIMIT_COLUMN];
1100c5499befSdrh   testcase( pEList && pEList->nExpr==mx );
1101c5499befSdrh   testcase( pEList && pEList->nExpr==mx+1 );
1102b1a6c3c1Sdrh   if( pEList && pEList->nExpr>mx ){
11037a15a4beSdanielk1977     sqlite3ErrorMsg(pParse, "too many columns in %s", zObject);
11047a15a4beSdanielk1977   }
11057a15a4beSdanielk1977 }
11067a15a4beSdanielk1977 
11077a15a4beSdanielk1977 /*
1108a76b5dfcSdrh ** Delete an entire expression list.
1109a76b5dfcSdrh */
1110633e6d57Sdrh void sqlite3ExprListDelete(sqlite3 *db, ExprList *pList){
1111a76b5dfcSdrh   int i;
1112be5c89acSdrh   struct ExprList_item *pItem;
1113a76b5dfcSdrh   if( pList==0 ) return;
11141bdd9b57Sdrh   assert( pList->a!=0 || (pList->nExpr==0 && pList->nAlloc==0) );
11151bdd9b57Sdrh   assert( pList->nExpr<=pList->nAlloc );
1116be5c89acSdrh   for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
1117633e6d57Sdrh     sqlite3ExprDelete(db, pItem->pExpr);
1118633e6d57Sdrh     sqlite3DbFree(db, pItem->zName);
1119b7916a78Sdrh     sqlite3DbFree(db, pItem->zSpan);
1120a76b5dfcSdrh   }
1121633e6d57Sdrh   sqlite3DbFree(db, pList->a);
1122633e6d57Sdrh   sqlite3DbFree(db, pList);
1123a76b5dfcSdrh }
1124a76b5dfcSdrh 
1125a76b5dfcSdrh /*
11267d10d5a6Sdrh ** These routines are Walker callbacks.  Walker.u.pi is a pointer
11277d10d5a6Sdrh ** to an integer.  These routines are checking an expression to see
11287d10d5a6Sdrh ** if it is a constant.  Set *Walker.u.pi to 0 if the expression is
11297d10d5a6Sdrh ** not constant.
113073b211abSdrh **
11317d10d5a6Sdrh ** These callback routines are used to implement the following:
1132626a879aSdrh **
11337d10d5a6Sdrh **     sqlite3ExprIsConstant()
11347d10d5a6Sdrh **     sqlite3ExprIsConstantNotJoin()
11357d10d5a6Sdrh **     sqlite3ExprIsConstantOrFunction()
113687abf5c0Sdrh **
1137626a879aSdrh */
11387d10d5a6Sdrh static int exprNodeIsConstant(Walker *pWalker, Expr *pExpr){
1139626a879aSdrh 
11407d10d5a6Sdrh   /* If pWalker->u.i is 3 then any term of the expression that comes from
11410a168377Sdrh   ** the ON or USING clauses of a join disqualifies the expression
11420a168377Sdrh   ** from being considered constant. */
11437d10d5a6Sdrh   if( pWalker->u.i==3 && ExprHasAnyProperty(pExpr, EP_FromJoin) ){
11447d10d5a6Sdrh     pWalker->u.i = 0;
11457d10d5a6Sdrh     return WRC_Abort;
11460a168377Sdrh   }
11470a168377Sdrh 
1148626a879aSdrh   switch( pExpr->op ){
1149eb55bd2fSdrh     /* Consider functions to be constant if all their arguments are constant
11507d10d5a6Sdrh     ** and pWalker->u.i==2 */
1151eb55bd2fSdrh     case TK_FUNCTION:
11527d10d5a6Sdrh       if( pWalker->u.i==2 ) return 0;
1153eb55bd2fSdrh       /* Fall through */
1154626a879aSdrh     case TK_ID:
1155626a879aSdrh     case TK_COLUMN:
1156626a879aSdrh     case TK_AGG_FUNCTION:
115713449892Sdrh     case TK_AGG_COLUMN:
1158c5499befSdrh       testcase( pExpr->op==TK_ID );
1159c5499befSdrh       testcase( pExpr->op==TK_COLUMN );
1160c5499befSdrh       testcase( pExpr->op==TK_AGG_FUNCTION );
1161c5499befSdrh       testcase( pExpr->op==TK_AGG_COLUMN );
11627d10d5a6Sdrh       pWalker->u.i = 0;
11637d10d5a6Sdrh       return WRC_Abort;
1164626a879aSdrh     default:
1165b74b1017Sdrh       testcase( pExpr->op==TK_SELECT ); /* selectNodeIsConstant will disallow */
1166b74b1017Sdrh       testcase( pExpr->op==TK_EXISTS ); /* selectNodeIsConstant will disallow */
11677d10d5a6Sdrh       return WRC_Continue;
1168626a879aSdrh   }
1169626a879aSdrh }
117062c14b34Sdanielk1977 static int selectNodeIsConstant(Walker *pWalker, Select *NotUsed){
117162c14b34Sdanielk1977   UNUSED_PARAMETER(NotUsed);
11727d10d5a6Sdrh   pWalker->u.i = 0;
11737d10d5a6Sdrh   return WRC_Abort;
11747d10d5a6Sdrh }
11757d10d5a6Sdrh static int exprIsConst(Expr *p, int initFlag){
11767d10d5a6Sdrh   Walker w;
11777d10d5a6Sdrh   w.u.i = initFlag;
11787d10d5a6Sdrh   w.xExprCallback = exprNodeIsConstant;
11797d10d5a6Sdrh   w.xSelectCallback = selectNodeIsConstant;
11807d10d5a6Sdrh   sqlite3WalkExpr(&w, p);
11817d10d5a6Sdrh   return w.u.i;
11827d10d5a6Sdrh }
1183626a879aSdrh 
1184626a879aSdrh /*
1185fef5208cSdrh ** Walk an expression tree.  Return 1 if the expression is constant
1186eb55bd2fSdrh ** and 0 if it involves variables or function calls.
11872398937bSdrh **
11882398937bSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
11892398937bSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
11902398937bSdrh ** a constant.
1191fef5208cSdrh */
11924adee20fSdanielk1977 int sqlite3ExprIsConstant(Expr *p){
11937d10d5a6Sdrh   return exprIsConst(p, 1);
1194fef5208cSdrh }
1195fef5208cSdrh 
1196fef5208cSdrh /*
1197eb55bd2fSdrh ** Walk an expression tree.  Return 1 if the expression is constant
11980a168377Sdrh ** that does no originate from the ON or USING clauses of a join.
11990a168377Sdrh ** Return 0 if it involves variables or function calls or terms from
12000a168377Sdrh ** an ON or USING clause.
12010a168377Sdrh */
12020a168377Sdrh int sqlite3ExprIsConstantNotJoin(Expr *p){
12037d10d5a6Sdrh   return exprIsConst(p, 3);
12040a168377Sdrh }
12050a168377Sdrh 
12060a168377Sdrh /*
12070a168377Sdrh ** Walk an expression tree.  Return 1 if the expression is constant
1208eb55bd2fSdrh ** or a function call with constant arguments.  Return and 0 if there
1209eb55bd2fSdrh ** are any variables.
1210eb55bd2fSdrh **
1211eb55bd2fSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
1212eb55bd2fSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
1213eb55bd2fSdrh ** a constant.
1214eb55bd2fSdrh */
1215eb55bd2fSdrh int sqlite3ExprIsConstantOrFunction(Expr *p){
12167d10d5a6Sdrh   return exprIsConst(p, 2);
1217eb55bd2fSdrh }
1218eb55bd2fSdrh 
1219eb55bd2fSdrh /*
122073b211abSdrh ** If the expression p codes a constant integer that is small enough
1221202b2df7Sdrh ** to fit in a 32-bit integer, return 1 and put the value of the integer
1222202b2df7Sdrh ** in *pValue.  If the expression is not an integer or if it is too big
1223202b2df7Sdrh ** to fit in a signed 32-bit integer, return 0 and leave *pValue unchanged.
1224e4de1febSdrh */
12254adee20fSdanielk1977 int sqlite3ExprIsInteger(Expr *p, int *pValue){
122692b01d53Sdrh   int rc = 0;
122792b01d53Sdrh   if( p->flags & EP_IntValue ){
122833e619fcSdrh     *pValue = p->u.iValue;
1229e4de1febSdrh     return 1;
1230e4de1febSdrh   }
123192b01d53Sdrh   switch( p->op ){
123292b01d53Sdrh     case TK_INTEGER: {
123333e619fcSdrh       rc = sqlite3GetInt32(p->u.zToken, pValue);
123433e619fcSdrh       assert( rc==0 );
1235202b2df7Sdrh       break;
1236202b2df7Sdrh     }
12374b59ab5eSdrh     case TK_UPLUS: {
123892b01d53Sdrh       rc = sqlite3ExprIsInteger(p->pLeft, pValue);
1239f6e369a1Sdrh       break;
12404b59ab5eSdrh     }
1241e4de1febSdrh     case TK_UMINUS: {
1242e4de1febSdrh       int v;
12434adee20fSdanielk1977       if( sqlite3ExprIsInteger(p->pLeft, &v) ){
1244e4de1febSdrh         *pValue = -v;
124592b01d53Sdrh         rc = 1;
1246e4de1febSdrh       }
1247e4de1febSdrh       break;
1248e4de1febSdrh     }
1249e4de1febSdrh     default: break;
1250e4de1febSdrh   }
125192b01d53Sdrh   if( rc ){
125233e619fcSdrh     assert( ExprHasAnyProperty(p, EP_Reduced|EP_TokenOnly)
125333e619fcSdrh                || (p->flags2 & EP2_MallocedToken)==0 );
125492b01d53Sdrh     p->op = TK_INTEGER;
125592b01d53Sdrh     p->flags |= EP_IntValue;
125633e619fcSdrh     p->u.iValue = *pValue;
125792b01d53Sdrh   }
125892b01d53Sdrh   return rc;
1259e4de1febSdrh }
1260e4de1febSdrh 
1261e4de1febSdrh /*
1262c4a3c779Sdrh ** Return TRUE if the given string is a row-id column name.
1263c4a3c779Sdrh */
12644adee20fSdanielk1977 int sqlite3IsRowid(const char *z){
12654adee20fSdanielk1977   if( sqlite3StrICmp(z, "_ROWID_")==0 ) return 1;
12664adee20fSdanielk1977   if( sqlite3StrICmp(z, "ROWID")==0 ) return 1;
12674adee20fSdanielk1977   if( sqlite3StrICmp(z, "OID")==0 ) return 1;
1268c4a3c779Sdrh   return 0;
1269c4a3c779Sdrh }
1270c4a3c779Sdrh 
12719a96b668Sdanielk1977 /*
1272b74b1017Sdrh ** Return true if we are able to the IN operator optimization on a
1273b74b1017Sdrh ** query of the form
1274b287f4b6Sdrh **
1275b74b1017Sdrh **       x IN (SELECT ...)
1276b287f4b6Sdrh **
1277b74b1017Sdrh ** Where the SELECT... clause is as specified by the parameter to this
1278b74b1017Sdrh ** routine.
1279b74b1017Sdrh **
1280b74b1017Sdrh ** The Select object passed in has already been preprocessed and no
1281b74b1017Sdrh ** errors have been found.
1282b287f4b6Sdrh */
1283b287f4b6Sdrh #ifndef SQLITE_OMIT_SUBQUERY
1284b287f4b6Sdrh static int isCandidateForInOpt(Select *p){
1285b287f4b6Sdrh   SrcList *pSrc;
1286b287f4b6Sdrh   ExprList *pEList;
1287b287f4b6Sdrh   Table *pTab;
1288b287f4b6Sdrh   if( p==0 ) return 0;                   /* right-hand side of IN is SELECT */
1289b287f4b6Sdrh   if( p->pPrior ) return 0;              /* Not a compound SELECT */
12907d10d5a6Sdrh   if( p->selFlags & (SF_Distinct|SF_Aggregate) ){
1291b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
1292b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
12937d10d5a6Sdrh     return 0; /* No DISTINCT keyword and no aggregate functions */
12947d10d5a6Sdrh   }
1295b74b1017Sdrh   assert( p->pGroupBy==0 );              /* Has no GROUP BY clause */
1296b287f4b6Sdrh   if( p->pLimit ) return 0;              /* Has no LIMIT clause */
1297b74b1017Sdrh   assert( p->pOffset==0 );               /* No LIMIT means no OFFSET */
1298b287f4b6Sdrh   if( p->pWhere ) return 0;              /* Has no WHERE clause */
1299b287f4b6Sdrh   pSrc = p->pSrc;
1300d1fa7bcaSdrh   assert( pSrc!=0 );
1301d1fa7bcaSdrh   if( pSrc->nSrc!=1 ) return 0;          /* Single term in FROM clause */
1302b74b1017Sdrh   if( pSrc->a[0].pSelect ) return 0;     /* FROM is not a subquery or view */
1303b287f4b6Sdrh   pTab = pSrc->a[0].pTab;
1304b74b1017Sdrh   if( NEVER(pTab==0) ) return 0;
1305b74b1017Sdrh   assert( pTab->pSelect==0 );            /* FROM clause is not a view */
1306b287f4b6Sdrh   if( IsVirtual(pTab) ) return 0;        /* FROM clause not a virtual table */
1307b287f4b6Sdrh   pEList = p->pEList;
1308b287f4b6Sdrh   if( pEList->nExpr!=1 ) return 0;       /* One column in the result set */
1309b287f4b6Sdrh   if( pEList->a[0].pExpr->op!=TK_COLUMN ) return 0; /* Result is a column */
1310b287f4b6Sdrh   return 1;
1311b287f4b6Sdrh }
1312b287f4b6Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
1313b287f4b6Sdrh 
1314b287f4b6Sdrh /*
13159a96b668Sdanielk1977 ** This function is used by the implementation of the IN (...) operator.
13169a96b668Sdanielk1977 ** It's job is to find or create a b-tree structure that may be used
13179a96b668Sdanielk1977 ** either to test for membership of the (...) set or to iterate through
131885b623f2Sdrh ** its members, skipping duplicates.
13199a96b668Sdanielk1977 **
1320b74b1017Sdrh ** The index of the cursor opened on the b-tree (database table, database index
13219a96b668Sdanielk1977 ** or ephermal table) is stored in pX->iTable before this function returns.
1322b74b1017Sdrh ** The returned value of this function indicates the b-tree type, as follows:
13239a96b668Sdanielk1977 **
13249a96b668Sdanielk1977 **   IN_INDEX_ROWID - The cursor was opened on a database table.
13252d401ab8Sdrh **   IN_INDEX_INDEX - The cursor was opened on a database index.
13269a96b668Sdanielk1977 **   IN_INDEX_EPH -   The cursor was opened on a specially created and
13279a96b668Sdanielk1977 **                    populated epheremal table.
13289a96b668Sdanielk1977 **
1329b74b1017Sdrh ** An existing b-tree may only be used if the SELECT is of the simple
13309a96b668Sdanielk1977 ** form:
13319a96b668Sdanielk1977 **
13329a96b668Sdanielk1977 **     SELECT <column> FROM <table>
13339a96b668Sdanielk1977 **
1334b74b1017Sdrh ** If the prNotFound parameter is 0, then the b-tree will be used to iterate
13359a96b668Sdanielk1977 ** through the set members, skipping any duplicates. In this case an
13369a96b668Sdanielk1977 ** epheremal table must be used unless the selected <column> is guaranteed
13379a96b668Sdanielk1977 ** to be unique - either because it is an INTEGER PRIMARY KEY or it
1338b74b1017Sdrh ** has a UNIQUE constraint or UNIQUE index.
13390cdc022eSdanielk1977 **
1340b74b1017Sdrh ** If the prNotFound parameter is not 0, then the b-tree will be used
13410cdc022eSdanielk1977 ** for fast set membership tests. In this case an epheremal table must
13420cdc022eSdanielk1977 ** be used unless <column> is an INTEGER PRIMARY KEY or an index can
13430cdc022eSdanielk1977 ** be found with <column> as its left-most column.
13440cdc022eSdanielk1977 **
1345b74b1017Sdrh ** When the b-tree is being used for membership tests, the calling function
13460cdc022eSdanielk1977 ** needs to know whether or not the structure contains an SQL NULL
13470cdc022eSdanielk1977 ** value in order to correctly evaluate expressions like "X IN (Y, Z)".
1348*e3365e6cSdrh ** If there is any chance that the (...) might contain a NULL value at
13490cdc022eSdanielk1977 ** runtime, then a register is allocated and the register number written
1350*e3365e6cSdrh ** to *prNotFound. If there is no chance that the (...) contains a
13510cdc022eSdanielk1977 ** NULL value, then *prNotFound is left unchanged.
13520cdc022eSdanielk1977 **
13530cdc022eSdanielk1977 ** If a register is allocated and its location stored in *prNotFound, then
1354*e3365e6cSdrh ** its initial value is NULL.  If the (...) does not remain constant
1355*e3365e6cSdrh ** for the duration of the query (i.e. the SELECT within the (...)
1356b74b1017Sdrh ** is a correlated subquery) then the value of the allocated register is
1357*e3365e6cSdrh ** reset to NULL each time the subquery is rerun. This allows the
1358b74b1017Sdrh ** caller to use vdbe code equivalent to the following:
13590cdc022eSdanielk1977 **
13600cdc022eSdanielk1977 **   if( register==NULL ){
13610cdc022eSdanielk1977 **     has_null = <test if data structure contains null>
13620cdc022eSdanielk1977 **     register = 1
13630cdc022eSdanielk1977 **   }
13640cdc022eSdanielk1977 **
13650cdc022eSdanielk1977 ** in order to avoid running the <test if data structure contains null>
13660cdc022eSdanielk1977 ** test more often than is necessary.
13679a96b668Sdanielk1977 */
1368284f4acaSdanielk1977 #ifndef SQLITE_OMIT_SUBQUERY
13690cdc022eSdanielk1977 int sqlite3FindInIndex(Parse *pParse, Expr *pX, int *prNotFound){
1370b74b1017Sdrh   Select *p;                            /* SELECT to the right of IN operator */
1371b74b1017Sdrh   int eType = 0;                        /* Type of RHS table. IN_INDEX_* */
1372b74b1017Sdrh   int iTab = pParse->nTab++;            /* Cursor of the RHS table */
1373b74b1017Sdrh   int mustBeUnique = (prNotFound==0);   /* True if RHS must be unique */
13749a96b668Sdanielk1977 
13751450bc6eSdrh   assert( pX->op==TK_IN );
13761450bc6eSdrh 
1377b74b1017Sdrh   /* Check to see if an existing table or index can be used to
1378b74b1017Sdrh   ** satisfy the query.  This is preferable to generating a new
1379b74b1017Sdrh   ** ephemeral table.
13809a96b668Sdanielk1977   */
13816ab3a2ecSdanielk1977   p = (ExprHasProperty(pX, EP_xIsSelect) ? pX->x.pSelect : 0);
1382fd773cf9Sdrh   if( ALWAYS(pParse->nErr==0) && isCandidateForInOpt(p) ){
1383e1fb65a0Sdanielk1977     sqlite3 *db = pParse->db;              /* Database connection */
1384e1fb65a0Sdanielk1977     Expr *pExpr = p->pEList->a[0].pExpr;   /* Expression <column> */
1385e1fb65a0Sdanielk1977     int iCol = pExpr->iColumn;             /* Index of column <column> */
1386e1fb65a0Sdanielk1977     Vdbe *v = sqlite3GetVdbe(pParse);      /* Virtual machine being coded */
1387e1fb65a0Sdanielk1977     Table *pTab = p->pSrc->a[0].pTab;      /* Table <table>. */
1388e1fb65a0Sdanielk1977     int iDb;                               /* Database idx for pTab */
1389e1fb65a0Sdanielk1977 
1390e1fb65a0Sdanielk1977     /* Code an OP_VerifyCookie and OP_TableLock for <table>. */
1391e1fb65a0Sdanielk1977     iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
1392e1fb65a0Sdanielk1977     sqlite3CodeVerifySchema(pParse, iDb);
1393e1fb65a0Sdanielk1977     sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
13949a96b668Sdanielk1977 
13959a96b668Sdanielk1977     /* This function is only called from two places. In both cases the vdbe
13969a96b668Sdanielk1977     ** has already been allocated. So assume sqlite3GetVdbe() is always
13979a96b668Sdanielk1977     ** successful here.
13989a96b668Sdanielk1977     */
13999a96b668Sdanielk1977     assert(v);
14009a96b668Sdanielk1977     if( iCol<0 ){
14010a07c107Sdrh       int iMem = ++pParse->nMem;
14029a96b668Sdanielk1977       int iAddr;
14039a96b668Sdanielk1977 
1404892d3179Sdrh       iAddr = sqlite3VdbeAddOp1(v, OP_If, iMem);
14054c583128Sdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, iMem);
14069a96b668Sdanielk1977 
14079a96b668Sdanielk1977       sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
14089a96b668Sdanielk1977       eType = IN_INDEX_ROWID;
14099a96b668Sdanielk1977 
14109a96b668Sdanielk1977       sqlite3VdbeJumpHere(v, iAddr);
14119a96b668Sdanielk1977     }else{
1412e1fb65a0Sdanielk1977       Index *pIdx;                         /* Iterator variable */
1413e1fb65a0Sdanielk1977 
14149a96b668Sdanielk1977       /* The collation sequence used by the comparison. If an index is to
14159a96b668Sdanielk1977       ** be used in place of a temp-table, it must be ordered according
1416e1fb65a0Sdanielk1977       ** to this collation sequence.  */
14179a96b668Sdanielk1977       CollSeq *pReq = sqlite3BinaryCompareCollSeq(pParse, pX->pLeft, pExpr);
14189a96b668Sdanielk1977 
14199a96b668Sdanielk1977       /* Check that the affinity that will be used to perform the
14209a96b668Sdanielk1977       ** comparison is the same as the affinity of the column. If
14219a96b668Sdanielk1977       ** it is not, it is not possible to use any index.
14229a96b668Sdanielk1977       */
14239a96b668Sdanielk1977       char aff = comparisonAffinity(pX);
14249a96b668Sdanielk1977       int affinity_ok = (pTab->aCol[iCol].affinity==aff||aff==SQLITE_AFF_NONE);
14259a96b668Sdanielk1977 
14269a96b668Sdanielk1977       for(pIdx=pTab->pIndex; pIdx && eType==0 && affinity_ok; pIdx=pIdx->pNext){
14279a96b668Sdanielk1977         if( (pIdx->aiColumn[0]==iCol)
1428b74b1017Sdrh          && sqlite3FindCollSeq(db, ENC(db), pIdx->azColl[0], 0)==pReq
14299a96b668Sdanielk1977          && (!mustBeUnique || (pIdx->nColumn==1 && pIdx->onError!=OE_None))
14309a96b668Sdanielk1977         ){
14310a07c107Sdrh           int iMem = ++pParse->nMem;
14329a96b668Sdanielk1977           int iAddr;
14339a96b668Sdanielk1977           char *pKey;
14349a96b668Sdanielk1977 
14359a96b668Sdanielk1977           pKey = (char *)sqlite3IndexKeyinfo(pParse, pIdx);
1436892d3179Sdrh           iAddr = sqlite3VdbeAddOp1(v, OP_If, iMem);
14374c583128Sdrh           sqlite3VdbeAddOp2(v, OP_Integer, 1, iMem);
14389a96b668Sdanielk1977 
1439207872a4Sdanielk1977           sqlite3VdbeAddOp4(v, OP_OpenRead, iTab, pIdx->tnum, iDb,
144066a5167bSdrh                                pKey,P4_KEYINFO_HANDOFF);
1441207872a4Sdanielk1977           VdbeComment((v, "%s", pIdx->zName));
14429a96b668Sdanielk1977           eType = IN_INDEX_INDEX;
14439a96b668Sdanielk1977 
14449a96b668Sdanielk1977           sqlite3VdbeJumpHere(v, iAddr);
14450cdc022eSdanielk1977           if( prNotFound && !pTab->aCol[iCol].notNull ){
14460cdc022eSdanielk1977             *prNotFound = ++pParse->nMem;
14470cdc022eSdanielk1977           }
14489a96b668Sdanielk1977         }
14499a96b668Sdanielk1977       }
14509a96b668Sdanielk1977     }
14519a96b668Sdanielk1977   }
14529a96b668Sdanielk1977 
14539a96b668Sdanielk1977   if( eType==0 ){
14541450bc6eSdrh     /* Could not found an existing table or index to use as the RHS b-tree.
1455b74b1017Sdrh     ** We will have to generate an ephemeral table to do the job.
1456b74b1017Sdrh     */
14570cdc022eSdanielk1977     int rMayHaveNull = 0;
145841a05b7bSdanielk1977     eType = IN_INDEX_EPH;
14590cdc022eSdanielk1977     if( prNotFound ){
14600cdc022eSdanielk1977       *prNotFound = rMayHaveNull = ++pParse->nMem;
14616ab3a2ecSdanielk1977     }else if( pX->pLeft->iColumn<0 && !ExprHasAnyProperty(pX, EP_xIsSelect) ){
146241a05b7bSdanielk1977       eType = IN_INDEX_ROWID;
14630cdc022eSdanielk1977     }
146441a05b7bSdanielk1977     sqlite3CodeSubselect(pParse, pX, rMayHaveNull, eType==IN_INDEX_ROWID);
14659a96b668Sdanielk1977   }else{
14669a96b668Sdanielk1977     pX->iTable = iTab;
14679a96b668Sdanielk1977   }
14689a96b668Sdanielk1977   return eType;
14699a96b668Sdanielk1977 }
1470284f4acaSdanielk1977 #endif
1471626a879aSdrh 
1472626a879aSdrh /*
14739cbe6352Sdrh ** Generate code for scalar subqueries used as an expression
14749cbe6352Sdrh ** and IN operators.  Examples:
1475626a879aSdrh **
14769cbe6352Sdrh **     (SELECT a FROM b)          -- subquery
14779cbe6352Sdrh **     EXISTS (SELECT a FROM b)   -- EXISTS subquery
14789cbe6352Sdrh **     x IN (4,5,11)              -- IN operator with list on right-hand side
14799cbe6352Sdrh **     x IN (SELECT a FROM b)     -- IN operator with subquery on the right
1480fef5208cSdrh **
14819cbe6352Sdrh ** The pExpr parameter describes the expression that contains the IN
14829cbe6352Sdrh ** operator or subquery.
148341a05b7bSdanielk1977 **
148441a05b7bSdanielk1977 ** If parameter isRowid is non-zero, then expression pExpr is guaranteed
148541a05b7bSdanielk1977 ** to be of the form "<rowid> IN (?, ?, ?)", where <rowid> is a reference
148641a05b7bSdanielk1977 ** to some integer key column of a table B-Tree. In this case, use an
148741a05b7bSdanielk1977 ** intkey B-Tree to store the set of IN(...) values instead of the usual
148841a05b7bSdanielk1977 ** (slower) variable length keys B-Tree.
1489fd773cf9Sdrh **
1490fd773cf9Sdrh ** If rMayHaveNull is non-zero, that means that the operation is an IN
1491fd773cf9Sdrh ** (not a SELECT or EXISTS) and that the RHS might contains NULLs.
1492fd773cf9Sdrh ** Furthermore, the IN is in a WHERE clause and that we really want
1493fd773cf9Sdrh ** to iterate over the RHS of the IN operator in order to quickly locate
1494fd773cf9Sdrh ** all corresponding LHS elements.  All this routine does is initialize
1495fd773cf9Sdrh ** the register given by rMayHaveNull to NULL.  Calling routines will take
1496fd773cf9Sdrh ** care of changing this register value to non-NULL if the RHS is NULL-free.
1497fd773cf9Sdrh **
1498fd773cf9Sdrh ** If rMayHaveNull is zero, that means that the subquery is being used
1499fd773cf9Sdrh ** for membership testing only.  There is no need to initialize any
1500fd773cf9Sdrh ** registers to indicate the presense or absence of NULLs on the RHS.
15011450bc6eSdrh **
15021450bc6eSdrh ** For a SELECT or EXISTS operator, return the register that holds the
15031450bc6eSdrh ** result.  For IN operators or if an error occurs, the return value is 0.
1504cce7d176Sdrh */
150551522cd3Sdrh #ifndef SQLITE_OMIT_SUBQUERY
15061450bc6eSdrh int sqlite3CodeSubselect(
1507fd773cf9Sdrh   Parse *pParse,          /* Parsing context */
1508fd773cf9Sdrh   Expr *pExpr,            /* The IN, SELECT, or EXISTS operator */
1509fd773cf9Sdrh   int rMayHaveNull,       /* Register that records whether NULLs exist in RHS */
1510fd773cf9Sdrh   int isRowid             /* If true, LHS of IN operator is a rowid */
151141a05b7bSdanielk1977 ){
151257dbd7b3Sdrh   int testAddr = 0;                       /* One-time test address */
15131450bc6eSdrh   int rReg = 0;                           /* Register storing resulting */
1514b3bce662Sdanielk1977   Vdbe *v = sqlite3GetVdbe(pParse);
15151450bc6eSdrh   if( NEVER(v==0) ) return 0;
1516ceea3321Sdrh   sqlite3ExprCachePush(pParse);
1517fc976065Sdanielk1977 
151857dbd7b3Sdrh   /* This code must be run in its entirety every time it is encountered
151957dbd7b3Sdrh   ** if any of the following is true:
152057dbd7b3Sdrh   **
152157dbd7b3Sdrh   **    *  The right-hand side is a correlated subquery
152257dbd7b3Sdrh   **    *  The right-hand side is an expression list containing variables
152357dbd7b3Sdrh   **    *  We are inside a trigger
152457dbd7b3Sdrh   **
152557dbd7b3Sdrh   ** If all of the above are false, then we can run this code just once
152657dbd7b3Sdrh   ** save the results, and reuse the same result on subsequent invocations.
1527b3bce662Sdanielk1977   */
1528165921a7Sdan   if( !ExprHasAnyProperty(pExpr, EP_VarSelect) && !pParse->pTriggerTab ){
15290a07c107Sdrh     int mem = ++pParse->nMem;
1530892d3179Sdrh     sqlite3VdbeAddOp1(v, OP_If, mem);
1531892d3179Sdrh     testAddr = sqlite3VdbeAddOp2(v, OP_Integer, 1, mem);
153217435752Sdrh     assert( testAddr>0 || pParse->db->mallocFailed );
1533b3bce662Sdanielk1977   }
1534b3bce662Sdanielk1977 
1535cce7d176Sdrh   switch( pExpr->op ){
1536fef5208cSdrh     case TK_IN: {
1537e014a838Sdanielk1977       char affinity;
1538d3d39e93Sdrh       KeyInfo keyInfo;
1539b9bb7c18Sdrh       int addr;        /* Address of OP_OpenEphemeral instruction */
154041a05b7bSdanielk1977       Expr *pLeft = pExpr->pLeft;
1541d3d39e93Sdrh 
15420cdc022eSdanielk1977       if( rMayHaveNull ){
15430cdc022eSdanielk1977         sqlite3VdbeAddOp2(v, OP_Null, 0, rMayHaveNull);
15440cdc022eSdanielk1977       }
15450cdc022eSdanielk1977 
154641a05b7bSdanielk1977       affinity = sqlite3ExprAffinity(pLeft);
1547e014a838Sdanielk1977 
1548e014a838Sdanielk1977       /* Whether this is an 'x IN(SELECT...)' or an 'x IN(<exprlist>)'
154957dbd7b3Sdrh       ** expression it is handled the same way. A virtual table is
1550e014a838Sdanielk1977       ** filled with single-field index keys representing the results
1551e014a838Sdanielk1977       ** from the SELECT or the <exprlist>.
1552fef5208cSdrh       **
1553e014a838Sdanielk1977       ** If the 'x' expression is a column value, or the SELECT...
1554e014a838Sdanielk1977       ** statement returns a column value, then the affinity of that
1555e014a838Sdanielk1977       ** column is used to build the index keys. If both 'x' and the
1556e014a838Sdanielk1977       ** SELECT... statement are columns, then numeric affinity is used
1557e014a838Sdanielk1977       ** if either column has NUMERIC or INTEGER affinity. If neither
1558e014a838Sdanielk1977       ** 'x' nor the SELECT... statement are columns, then numeric affinity
1559e014a838Sdanielk1977       ** is used.
1560fef5208cSdrh       */
1561832508b7Sdrh       pExpr->iTable = pParse->nTab++;
156241a05b7bSdanielk1977       addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, pExpr->iTable, !isRowid);
1563d3d39e93Sdrh       memset(&keyInfo, 0, sizeof(keyInfo));
1564d3d39e93Sdrh       keyInfo.nField = 1;
1565e014a838Sdanielk1977 
15666ab3a2ecSdanielk1977       if( ExprHasProperty(pExpr, EP_xIsSelect) ){
1567e014a838Sdanielk1977         /* Case 1:     expr IN (SELECT ...)
1568e014a838Sdanielk1977         **
1569e014a838Sdanielk1977         ** Generate code to write the results of the select into the temporary
1570e014a838Sdanielk1977         ** table allocated and opened above.
1571e014a838Sdanielk1977         */
15721013c932Sdrh         SelectDest dest;
1573be5c89acSdrh         ExprList *pEList;
15741013c932Sdrh 
157541a05b7bSdanielk1977         assert( !isRowid );
15761013c932Sdrh         sqlite3SelectDestInit(&dest, SRT_Set, pExpr->iTable);
15771bd10f8aSdrh         dest.affinity = (u8)affinity;
1578e014a838Sdanielk1977         assert( (pExpr->iTable&0x0000FFFF)==pExpr->iTable );
15796ab3a2ecSdanielk1977         if( sqlite3Select(pParse, pExpr->x.pSelect, &dest) ){
15801450bc6eSdrh           return 0;
158194ccde58Sdrh         }
15826ab3a2ecSdanielk1977         pEList = pExpr->x.pSelect->pEList;
1583fd773cf9Sdrh         if( ALWAYS(pEList!=0 && pEList->nExpr>0) ){
1584bcbb04e5Sdanielk1977           keyInfo.aColl[0] = sqlite3BinaryCompareCollSeq(pParse, pExpr->pLeft,
1585be5c89acSdrh               pEList->a[0].pExpr);
15860202b29eSdanielk1977         }
1587fd773cf9Sdrh       }else if( pExpr->x.pList!=0 ){
1588fef5208cSdrh         /* Case 2:     expr IN (exprlist)
1589fef5208cSdrh         **
1590e014a838Sdanielk1977         ** For each expression, build an index key from the evaluation and
1591e014a838Sdanielk1977         ** store it in the temporary table. If <expr> is a column, then use
1592e014a838Sdanielk1977         ** that columns affinity when building index keys. If <expr> is not
1593e014a838Sdanielk1977         ** a column, use numeric affinity.
1594fef5208cSdrh         */
1595e014a838Sdanielk1977         int i;
15966ab3a2ecSdanielk1977         ExprList *pList = pExpr->x.pList;
159757dbd7b3Sdrh         struct ExprList_item *pItem;
1598ecc31805Sdrh         int r1, r2, r3;
159957dbd7b3Sdrh 
1600e014a838Sdanielk1977         if( !affinity ){
16018159a35fSdrh           affinity = SQLITE_AFF_NONE;
1602e014a838Sdanielk1977         }
16037d10d5a6Sdrh         keyInfo.aColl[0] = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
1604e014a838Sdanielk1977 
1605e014a838Sdanielk1977         /* Loop through each expression in <exprlist>. */
16062d401ab8Sdrh         r1 = sqlite3GetTempReg(pParse);
16072d401ab8Sdrh         r2 = sqlite3GetTempReg(pParse);
16084e7f36a2Sdanielk1977         sqlite3VdbeAddOp2(v, OP_Null, 0, r2);
160957dbd7b3Sdrh         for(i=pList->nExpr, pItem=pList->a; i>0; i--, pItem++){
161057dbd7b3Sdrh           Expr *pE2 = pItem->pExpr;
1611e05c929bSdrh           int iValToIns;
1612e014a838Sdanielk1977 
161357dbd7b3Sdrh           /* If the expression is not constant then we will need to
161457dbd7b3Sdrh           ** disable the test that was generated above that makes sure
161557dbd7b3Sdrh           ** this code only executes once.  Because for a non-constant
161657dbd7b3Sdrh           ** expression we need to rerun this code each time.
161757dbd7b3Sdrh           */
1618892d3179Sdrh           if( testAddr && !sqlite3ExprIsConstant(pE2) ){
1619892d3179Sdrh             sqlite3VdbeChangeToNoop(v, testAddr-1, 2);
162057dbd7b3Sdrh             testAddr = 0;
16214794b980Sdrh           }
1622e014a838Sdanielk1977 
1623e014a838Sdanielk1977           /* Evaluate the expression and insert it into the temp table */
1624e05c929bSdrh           if( isRowid && sqlite3ExprIsInteger(pE2, &iValToIns) ){
1625e05c929bSdrh             sqlite3VdbeAddOp3(v, OP_InsertInt, pExpr->iTable, r2, iValToIns);
1626e05c929bSdrh           }else{
1627ecc31805Sdrh             r3 = sqlite3ExprCodeTarget(pParse, pE2, r1);
162841a05b7bSdanielk1977             if( isRowid ){
1629e05c929bSdrh               sqlite3VdbeAddOp2(v, OP_MustBeInt, r3,
1630e05c929bSdrh                                 sqlite3VdbeCurrentAddr(v)+2);
163141a05b7bSdanielk1977               sqlite3VdbeAddOp3(v, OP_Insert, pExpr->iTable, r2, r3);
163241a05b7bSdanielk1977             }else{
1633ecc31805Sdrh               sqlite3VdbeAddOp4(v, OP_MakeRecord, r3, 1, r2, &affinity, 1);
16343c31fc23Sdrh               sqlite3ExprCacheAffinityChange(pParse, r3, 1);
16352d401ab8Sdrh               sqlite3VdbeAddOp2(v, OP_IdxInsert, pExpr->iTable, r2);
1636fef5208cSdrh             }
163741a05b7bSdanielk1977           }
1638e05c929bSdrh         }
16392d401ab8Sdrh         sqlite3ReleaseTempReg(pParse, r1);
16402d401ab8Sdrh         sqlite3ReleaseTempReg(pParse, r2);
1641fef5208cSdrh       }
164241a05b7bSdanielk1977       if( !isRowid ){
164366a5167bSdrh         sqlite3VdbeChangeP4(v, addr, (void *)&keyInfo, P4_KEYINFO);
164441a05b7bSdanielk1977       }
1645b3bce662Sdanielk1977       break;
1646fef5208cSdrh     }
1647fef5208cSdrh 
164851522cd3Sdrh     case TK_EXISTS:
1649fd773cf9Sdrh     case TK_SELECT:
1650fd773cf9Sdrh     default: {
1651fd773cf9Sdrh       /* If this has to be a scalar SELECT.  Generate code to put the
1652fef5208cSdrh       ** value of this select in a memory cell and record the number
1653fd773cf9Sdrh       ** of the memory cell in iColumn.  If this is an EXISTS, write
1654fd773cf9Sdrh       ** an integer 0 (not exists) or 1 (exists) into a memory cell
1655fd773cf9Sdrh       ** and record that memory cell in iColumn.
1656fef5208cSdrh       */
1657fd773cf9Sdrh       static const Token one = { "1", 1 };  /* Token for literal value 1 */
1658fd773cf9Sdrh       Select *pSel;                         /* SELECT statement to encode */
1659fd773cf9Sdrh       SelectDest dest;                      /* How to deal with SELECt result */
16601398ad36Sdrh 
1661cf697396Sshane       testcase( pExpr->op==TK_EXISTS );
1662cf697396Sshane       testcase( pExpr->op==TK_SELECT );
1663cf697396Sshane       assert( pExpr->op==TK_EXISTS || pExpr->op==TK_SELECT );
1664cf697396Sshane 
16656ab3a2ecSdanielk1977       assert( ExprHasProperty(pExpr, EP_xIsSelect) );
16666ab3a2ecSdanielk1977       pSel = pExpr->x.pSelect;
16671013c932Sdrh       sqlite3SelectDestInit(&dest, 0, ++pParse->nMem);
166851522cd3Sdrh       if( pExpr->op==TK_SELECT ){
16696c8c8ce0Sdanielk1977         dest.eDest = SRT_Mem;
16704c583128Sdrh         sqlite3VdbeAddOp2(v, OP_Null, 0, dest.iParm);
1671d4e70ebdSdrh         VdbeComment((v, "Init subquery result"));
167251522cd3Sdrh       }else{
16736c8c8ce0Sdanielk1977         dest.eDest = SRT_Exists;
16744c583128Sdrh         sqlite3VdbeAddOp2(v, OP_Integer, 0, dest.iParm);
1675d4e70ebdSdrh         VdbeComment((v, "Init EXISTS result"));
167651522cd3Sdrh       }
1677633e6d57Sdrh       sqlite3ExprDelete(pParse->db, pSel->pLimit);
1678a1644fd8Sdanielk1977       pSel->pLimit = sqlite3PExpr(pParse, TK_INTEGER, 0, 0, &one);
16797d10d5a6Sdrh       if( sqlite3Select(pParse, pSel, &dest) ){
16801450bc6eSdrh         return 0;
168194ccde58Sdrh       }
16821450bc6eSdrh       rReg = dest.iParm;
168333e619fcSdrh       ExprSetIrreducible(pExpr);
1684b3bce662Sdanielk1977       break;
168519a775c2Sdrh     }
1686cce7d176Sdrh   }
1687b3bce662Sdanielk1977 
168857dbd7b3Sdrh   if( testAddr ){
1689892d3179Sdrh     sqlite3VdbeJumpHere(v, testAddr-1);
1690b3bce662Sdanielk1977   }
1691ceea3321Sdrh   sqlite3ExprCachePop(pParse, 1);
1692fc976065Sdanielk1977 
16931450bc6eSdrh   return rReg;
1694cce7d176Sdrh }
169551522cd3Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
1696cce7d176Sdrh 
1697*e3365e6cSdrh #ifndef SQLITE_OMIT_SUBQUERY
1698*e3365e6cSdrh /*
1699*e3365e6cSdrh ** Generate code for an IN expression.
1700*e3365e6cSdrh **
1701*e3365e6cSdrh **      x IN (SELECT ...)
1702*e3365e6cSdrh **      x IN (value, value, ...)
1703*e3365e6cSdrh **
1704*e3365e6cSdrh ** The left-hand side (LHS) is a scalar expression.  The right-hand side (RHS)
1705*e3365e6cSdrh ** is an array of zero or more values.  The expression is true if the LHS is
1706*e3365e6cSdrh ** contained within the RHS.  The value of the expression is unknown (NULL)
1707*e3365e6cSdrh ** if the LHS is NULL or if the LHS is not contained within the RHS and the
1708*e3365e6cSdrh ** RHS contains one or more NULL values.
1709*e3365e6cSdrh **
1710*e3365e6cSdrh ** This routine generates code will jump to destIfFalse if the LHS is not
1711*e3365e6cSdrh ** contained within the RHS.  If due to NULLs we cannot determine if the LHS
1712*e3365e6cSdrh ** is contained in the RHS then jump to destIfNull.  If the LHS is contained
1713*e3365e6cSdrh ** within the RHS then fall through.
1714*e3365e6cSdrh */
1715*e3365e6cSdrh static void sqlite3ExprCodeIN(
1716*e3365e6cSdrh   Parse *pParse,        /* Parsing and code generating context */
1717*e3365e6cSdrh   Expr *pExpr,          /* The IN expression */
1718*e3365e6cSdrh   int destIfFalse,      /* Jump here if LHS is not contained in the RHS */
1719*e3365e6cSdrh   int destIfNull        /* Jump here if the results are unknown due to NULLs */
1720*e3365e6cSdrh ){
1721*e3365e6cSdrh   int rRhsHasNull = 0;  /* Register that is true if RHS contains NULL values */
1722*e3365e6cSdrh   char affinity;        /* Comparison affinity to use */
1723*e3365e6cSdrh   int eType;            /* Type of the RHS */
1724*e3365e6cSdrh   int r1;               /* Temporary use register */
1725*e3365e6cSdrh   Vdbe *v;              /* Statement under construction */
1726*e3365e6cSdrh 
1727*e3365e6cSdrh   /* Compute the RHS.   After this step, the table with cursor
1728*e3365e6cSdrh   ** pExpr->iTable will contains the values that make up the RHS.
1729*e3365e6cSdrh   */
1730*e3365e6cSdrh   v = pParse->pVdbe;
1731*e3365e6cSdrh   assert( v!=0 );       /* OOM detected prior to this routine */
1732*e3365e6cSdrh   VdbeNoopComment((v, "begin IN expr"));
1733*e3365e6cSdrh   eType = sqlite3FindInIndex(pParse, pExpr, &rRhsHasNull);
1734*e3365e6cSdrh 
1735*e3365e6cSdrh   /* Figure out the affinity to use to create a key from the results
1736*e3365e6cSdrh   ** of the expression. affinityStr stores a static string suitable for
1737*e3365e6cSdrh   ** P4 of OP_MakeRecord.
1738*e3365e6cSdrh   */
1739*e3365e6cSdrh   affinity = comparisonAffinity(pExpr);
1740*e3365e6cSdrh 
1741*e3365e6cSdrh   /* Code the LHS, the <expr> from "<expr> IN (...)".
1742*e3365e6cSdrh   */
1743*e3365e6cSdrh   sqlite3ExprCachePush(pParse);
1744*e3365e6cSdrh   r1 = sqlite3GetTempReg(pParse);
1745*e3365e6cSdrh   sqlite3ExprCode(pParse, pExpr->pLeft, r1);
1746*e3365e6cSdrh   sqlite3VdbeAddOp2(v, OP_IsNull, r1, destIfNull);
1747*e3365e6cSdrh 
1748*e3365e6cSdrh 
1749*e3365e6cSdrh   if( eType==IN_INDEX_ROWID ){
1750*e3365e6cSdrh     /* In this case, the RHS is the ROWID of table b-tree
1751*e3365e6cSdrh     */
1752*e3365e6cSdrh     sqlite3VdbeAddOp2(v, OP_MustBeInt, r1, destIfFalse);
1753*e3365e6cSdrh     sqlite3VdbeAddOp3(v, OP_NotExists, pExpr->iTable, destIfFalse, r1);
1754*e3365e6cSdrh   }else{
1755*e3365e6cSdrh     /* In this case, the RHS is an index b-tree.
1756*e3365e6cSdrh     */
1757*e3365e6cSdrh     int r2;   /* Register holding LHS value as a Record */
1758*e3365e6cSdrh 
1759*e3365e6cSdrh     /* Create a record that can be used for membership testing.
1760*e3365e6cSdrh     */
1761*e3365e6cSdrh     r2 = sqlite3GetTempReg(pParse);
1762*e3365e6cSdrh     sqlite3VdbeAddOp4(v, OP_MakeRecord, r1, 1, r2, &affinity, 1);
1763*e3365e6cSdrh 
1764*e3365e6cSdrh     /* If the set membership test fails, then the result of the
1765*e3365e6cSdrh     ** "x IN (...)" expression must be either 0 or NULL. If the set
1766*e3365e6cSdrh     ** contains no NULL values, then the result is 0. If the set
1767*e3365e6cSdrh     ** contains one or more NULL values, then the result of the
1768*e3365e6cSdrh     ** expression is also NULL.
1769*e3365e6cSdrh     */
1770*e3365e6cSdrh     if( rRhsHasNull==0 || destIfFalse==destIfNull ){
1771*e3365e6cSdrh       /* This branch runs if it is known at compile time that the RHS
1772*e3365e6cSdrh       ** cannot contain NULL values. This happens as the result
1773*e3365e6cSdrh       ** of a "NOT NULL" constraint in the database schema.
1774*e3365e6cSdrh       **
1775*e3365e6cSdrh       ** Also run this branch if NULL is equivalent to FALSE
1776*e3365e6cSdrh       ** for this particular IN operator.
1777*e3365e6cSdrh       */
1778*e3365e6cSdrh       sqlite3VdbeAddOp3(v, OP_NotFound, pExpr->iTable, destIfFalse, r2);
1779*e3365e6cSdrh 
1780*e3365e6cSdrh     }else{
1781*e3365e6cSdrh       /* In this branch, the RHS of the IN might contain a NULL and
1782*e3365e6cSdrh       ** the presence of a NULL on the RHS makes a difference in the
1783*e3365e6cSdrh       ** outcome.
1784*e3365e6cSdrh       */
1785*e3365e6cSdrh       static const char nullRecord[] = { 0x02, 0x00 };
1786*e3365e6cSdrh       int j1, j2, j3;
1787*e3365e6cSdrh 
1788*e3365e6cSdrh       /* First check to see if the LHS is contained in the RHS.  If so,
1789*e3365e6cSdrh       ** then the presence of NULLs in the RHS does not matter, so jump
1790*e3365e6cSdrh       ** over all of the code that follows.
1791*e3365e6cSdrh       */
1792*e3365e6cSdrh       j1 = sqlite3VdbeAddOp3(v, OP_Found, pExpr->iTable, 0, r2);
1793*e3365e6cSdrh 
1794*e3365e6cSdrh       /* Here we begin generating code that runs if the LHS is not
1795*e3365e6cSdrh       ** contained within the RHS.  Generate additional code that
1796*e3365e6cSdrh       ** tests the RHS for NULLs.  If the RHS contains a NULL then
1797*e3365e6cSdrh       ** jump to destIfNull.  If there are no NULLs in the RHS then
1798*e3365e6cSdrh       ** jump to destIfFalse.
1799*e3365e6cSdrh       */
1800*e3365e6cSdrh       j2 = sqlite3VdbeAddOp1(v, OP_NotNull, rRhsHasNull);
1801*e3365e6cSdrh       sqlite3VdbeAddOp4(v, OP_Blob, 2, r2, 0, nullRecord, P4_STATIC);
1802*e3365e6cSdrh       j3 = sqlite3VdbeAddOp3(v, OP_Found, pExpr->iTable, 0, r2);
1803*e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_Integer, -1, rRhsHasNull);
1804*e3365e6cSdrh       sqlite3VdbeJumpHere(v, j3);
1805*e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_AddImm, rRhsHasNull, 1);
1806*e3365e6cSdrh       sqlite3VdbeJumpHere(v, j2);
1807*e3365e6cSdrh 
1808*e3365e6cSdrh       /* Jump to the appropriate target depending on whether or not
1809*e3365e6cSdrh       ** the RHS contains a NULL
1810*e3365e6cSdrh       */
1811*e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_If, rRhsHasNull, destIfNull);
1812*e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfFalse);
1813*e3365e6cSdrh 
1814*e3365e6cSdrh       /* The OP_Found at the top of this branch jumps here when true,
1815*e3365e6cSdrh       ** causing the overall IN expression evaluation to fall through.
1816*e3365e6cSdrh       */
1817*e3365e6cSdrh       sqlite3VdbeJumpHere(v, j1);
1818*e3365e6cSdrh     }
1819*e3365e6cSdrh     sqlite3ReleaseTempReg(pParse, r2);
1820*e3365e6cSdrh   }
1821*e3365e6cSdrh   sqlite3ReleaseTempReg(pParse, r1);
1822*e3365e6cSdrh   sqlite3ExprCachePop(pParse, 1);
1823*e3365e6cSdrh   VdbeComment((v, "end IN expr"));
1824*e3365e6cSdrh }
1825*e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
1826*e3365e6cSdrh 
1827cce7d176Sdrh /*
1828598f1340Sdrh ** Duplicate an 8-byte value
1829598f1340Sdrh */
1830598f1340Sdrh static char *dup8bytes(Vdbe *v, const char *in){
1831598f1340Sdrh   char *out = sqlite3DbMallocRaw(sqlite3VdbeDb(v), 8);
1832598f1340Sdrh   if( out ){
1833598f1340Sdrh     memcpy(out, in, 8);
1834598f1340Sdrh   }
1835598f1340Sdrh   return out;
1836598f1340Sdrh }
1837598f1340Sdrh 
1838598f1340Sdrh /*
1839598f1340Sdrh ** Generate an instruction that will put the floating point
18409cbf3425Sdrh ** value described by z[0..n-1] into register iMem.
18410cf19ed8Sdrh **
18420cf19ed8Sdrh ** The z[] string will probably not be zero-terminated.  But the
18430cf19ed8Sdrh ** z[n] character is guaranteed to be something that does not look
18440cf19ed8Sdrh ** like the continuation of the number.
1845598f1340Sdrh */
1846b7916a78Sdrh static void codeReal(Vdbe *v, const char *z, int negateFlag, int iMem){
1847fd773cf9Sdrh   if( ALWAYS(z!=0) ){
1848598f1340Sdrh     double value;
1849598f1340Sdrh     char *zV;
1850598f1340Sdrh     sqlite3AtoF(z, &value);
1851d0015161Sdrh     assert( !sqlite3IsNaN(value) ); /* The new AtoF never returns NaN */
1852598f1340Sdrh     if( negateFlag ) value = -value;
1853598f1340Sdrh     zV = dup8bytes(v, (char*)&value);
18549de221dfSdrh     sqlite3VdbeAddOp4(v, OP_Real, 0, iMem, 0, zV, P4_REAL);
1855598f1340Sdrh   }
1856598f1340Sdrh }
1857598f1340Sdrh 
1858598f1340Sdrh 
1859598f1340Sdrh /*
1860fec19aadSdrh ** Generate an instruction that will put the integer describe by
18619cbf3425Sdrh ** text z[0..n-1] into register iMem.
18620cf19ed8Sdrh **
18630cf19ed8Sdrh ** The z[] string will probably not be zero-terminated.  But the
18640cf19ed8Sdrh ** z[n] character is guaranteed to be something that does not look
18650cf19ed8Sdrh ** like the continuation of the number.
1866fec19aadSdrh */
186792b01d53Sdrh static void codeInteger(Vdbe *v, Expr *pExpr, int negFlag, int iMem){
186892b01d53Sdrh   if( pExpr->flags & EP_IntValue ){
186933e619fcSdrh     int i = pExpr->u.iValue;
187092b01d53Sdrh     if( negFlag ) i = -i;
187192b01d53Sdrh     sqlite3VdbeAddOp2(v, OP_Integer, i, iMem);
1872fd773cf9Sdrh   }else{
1873fd773cf9Sdrh     const char *z = pExpr->u.zToken;
1874fd773cf9Sdrh     assert( z!=0 );
1875fd773cf9Sdrh     if( sqlite3FitsIn64Bits(z, negFlag) ){
1876598f1340Sdrh       i64 value;
1877598f1340Sdrh       char *zV;
1878598f1340Sdrh       sqlite3Atoi64(z, &value);
18799de221dfSdrh       if( negFlag ) value = -value;
1880598f1340Sdrh       zV = dup8bytes(v, (char*)&value);
18819de221dfSdrh       sqlite3VdbeAddOp4(v, OP_Int64, 0, iMem, 0, zV, P4_INT64);
1882fec19aadSdrh     }else{
1883b7916a78Sdrh       codeReal(v, z, negFlag, iMem);
1884fec19aadSdrh     }
1885fec19aadSdrh   }
1886c9cf901dSdanielk1977 }
1887fec19aadSdrh 
1888ceea3321Sdrh /*
1889ceea3321Sdrh ** Clear a cache entry.
1890ceea3321Sdrh */
1891ceea3321Sdrh static void cacheEntryClear(Parse *pParse, struct yColCache *p){
1892ceea3321Sdrh   if( p->tempReg ){
1893ceea3321Sdrh     if( pParse->nTempReg<ArraySize(pParse->aTempReg) ){
1894ceea3321Sdrh       pParse->aTempReg[pParse->nTempReg++] = p->iReg;
1895ceea3321Sdrh     }
1896ceea3321Sdrh     p->tempReg = 0;
1897ceea3321Sdrh   }
1898ceea3321Sdrh }
1899ceea3321Sdrh 
1900ceea3321Sdrh 
1901ceea3321Sdrh /*
1902ceea3321Sdrh ** Record in the column cache that a particular column from a
1903ceea3321Sdrh ** particular table is stored in a particular register.
1904ceea3321Sdrh */
1905ceea3321Sdrh void sqlite3ExprCacheStore(Parse *pParse, int iTab, int iCol, int iReg){
1906ceea3321Sdrh   int i;
1907ceea3321Sdrh   int minLru;
1908ceea3321Sdrh   int idxLru;
1909ceea3321Sdrh   struct yColCache *p;
1910ceea3321Sdrh 
191120411ea7Sdrh   assert( iReg>0 );  /* Register numbers are always positive */
191220411ea7Sdrh   assert( iCol>=-1 && iCol<32768 );  /* Finite column numbers */
191320411ea7Sdrh 
1914ceea3321Sdrh   /* First replace any existing entry */
1915ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
1916ceea3321Sdrh     if( p->iReg && p->iTable==iTab && p->iColumn==iCol ){
1917ceea3321Sdrh       cacheEntryClear(pParse, p);
1918ceea3321Sdrh       p->iLevel = pParse->iCacheLevel;
1919ceea3321Sdrh       p->iReg = iReg;
1920ceea3321Sdrh       p->affChange = 0;
1921ceea3321Sdrh       p->lru = pParse->iCacheCnt++;
1922ceea3321Sdrh       return;
1923ceea3321Sdrh     }
1924ceea3321Sdrh   }
1925ceea3321Sdrh 
1926ceea3321Sdrh   /* Find an empty slot and replace it */
1927ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
1928ceea3321Sdrh     if( p->iReg==0 ){
1929ceea3321Sdrh       p->iLevel = pParse->iCacheLevel;
1930ceea3321Sdrh       p->iTable = iTab;
1931ceea3321Sdrh       p->iColumn = iCol;
1932ceea3321Sdrh       p->iReg = iReg;
1933ceea3321Sdrh       p->affChange = 0;
1934ceea3321Sdrh       p->tempReg = 0;
1935ceea3321Sdrh       p->lru = pParse->iCacheCnt++;
1936ceea3321Sdrh       return;
1937ceea3321Sdrh     }
1938ceea3321Sdrh   }
1939ceea3321Sdrh 
1940ceea3321Sdrh   /* Replace the last recently used */
1941ceea3321Sdrh   minLru = 0x7fffffff;
1942ceea3321Sdrh   idxLru = -1;
1943ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
1944ceea3321Sdrh     if( p->lru<minLru ){
1945ceea3321Sdrh       idxLru = i;
1946ceea3321Sdrh       minLru = p->lru;
1947ceea3321Sdrh     }
1948ceea3321Sdrh   }
194920411ea7Sdrh   if( ALWAYS(idxLru>=0) ){
1950ceea3321Sdrh     p = &pParse->aColCache[idxLru];
1951ceea3321Sdrh     p->iLevel = pParse->iCacheLevel;
1952ceea3321Sdrh     p->iTable = iTab;
1953ceea3321Sdrh     p->iColumn = iCol;
1954ceea3321Sdrh     p->iReg = iReg;
1955ceea3321Sdrh     p->affChange = 0;
1956ceea3321Sdrh     p->tempReg = 0;
1957ceea3321Sdrh     p->lru = pParse->iCacheCnt++;
1958ceea3321Sdrh     return;
1959ceea3321Sdrh   }
1960ceea3321Sdrh }
1961ceea3321Sdrh 
1962ceea3321Sdrh /*
1963ceea3321Sdrh ** Indicate that a register is being overwritten.  Purge the register
1964ceea3321Sdrh ** from the column cache.
1965ceea3321Sdrh */
1966ceea3321Sdrh void sqlite3ExprCacheRemove(Parse *pParse, int iReg){
1967ceea3321Sdrh   int i;
1968ceea3321Sdrh   struct yColCache *p;
1969ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
1970ceea3321Sdrh     if( p->iReg==iReg ){
1971ceea3321Sdrh       cacheEntryClear(pParse, p);
1972ceea3321Sdrh       p->iReg = 0;
1973ceea3321Sdrh     }
1974ceea3321Sdrh   }
1975ceea3321Sdrh }
1976ceea3321Sdrh 
1977ceea3321Sdrh /*
1978ceea3321Sdrh ** Remember the current column cache context.  Any new entries added
1979ceea3321Sdrh ** added to the column cache after this call are removed when the
1980ceea3321Sdrh ** corresponding pop occurs.
1981ceea3321Sdrh */
1982ceea3321Sdrh void sqlite3ExprCachePush(Parse *pParse){
1983ceea3321Sdrh   pParse->iCacheLevel++;
1984ceea3321Sdrh }
1985ceea3321Sdrh 
1986ceea3321Sdrh /*
1987ceea3321Sdrh ** Remove from the column cache any entries that were added since the
1988ceea3321Sdrh ** the previous N Push operations.  In other words, restore the cache
1989ceea3321Sdrh ** to the state it was in N Pushes ago.
1990ceea3321Sdrh */
1991ceea3321Sdrh void sqlite3ExprCachePop(Parse *pParse, int N){
1992ceea3321Sdrh   int i;
1993ceea3321Sdrh   struct yColCache *p;
1994ceea3321Sdrh   assert( N>0 );
1995ceea3321Sdrh   assert( pParse->iCacheLevel>=N );
1996ceea3321Sdrh   pParse->iCacheLevel -= N;
1997ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
1998ceea3321Sdrh     if( p->iReg && p->iLevel>pParse->iCacheLevel ){
1999ceea3321Sdrh       cacheEntryClear(pParse, p);
2000ceea3321Sdrh       p->iReg = 0;
2001ceea3321Sdrh     }
2002ceea3321Sdrh   }
2003ceea3321Sdrh }
2004945498f3Sdrh 
2005945498f3Sdrh /*
20065cd79239Sdrh ** When a cached column is reused, make sure that its register is
20075cd79239Sdrh ** no longer available as a temp register.  ticket #3879:  that same
20085cd79239Sdrh ** register might be in the cache in multiple places, so be sure to
20095cd79239Sdrh ** get them all.
20105cd79239Sdrh */
20115cd79239Sdrh static void sqlite3ExprCachePinRegister(Parse *pParse, int iReg){
20125cd79239Sdrh   int i;
20135cd79239Sdrh   struct yColCache *p;
20145cd79239Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
20155cd79239Sdrh     if( p->iReg==iReg ){
20165cd79239Sdrh       p->tempReg = 0;
20175cd79239Sdrh     }
20185cd79239Sdrh   }
20195cd79239Sdrh }
20205cd79239Sdrh 
20215cd79239Sdrh /*
2022945498f3Sdrh ** Generate code that will extract the iColumn-th column from
2023e55cbd72Sdrh ** table pTab and store the column value in a register.  An effort
2024e55cbd72Sdrh ** is made to store the column value in register iReg, but this is
2025e55cbd72Sdrh ** not guaranteed.  The location of the column value is returned.
2026e55cbd72Sdrh **
2027e55cbd72Sdrh ** There must be an open cursor to pTab in iTable when this routine
2028e55cbd72Sdrh ** is called.  If iColumn<0 then code is generated that extracts the rowid.
2029da250ea5Sdrh **
2030da250ea5Sdrh ** This routine might attempt to reuse the value of the column that
2031da250ea5Sdrh ** has already been loaded into a register.  The value will always
2032da250ea5Sdrh ** be used if it has not undergone any affinity changes.  But if
2033da250ea5Sdrh ** an affinity change has occurred, then the cached value will only be
2034da250ea5Sdrh ** used if allowAffChng is true.
2035945498f3Sdrh */
2036e55cbd72Sdrh int sqlite3ExprCodeGetColumn(
2037e55cbd72Sdrh   Parse *pParse,   /* Parsing and code generating context */
20382133d822Sdrh   Table *pTab,     /* Description of the table we are reading from */
20392133d822Sdrh   int iColumn,     /* Index of the table column */
20402133d822Sdrh   int iTable,      /* The cursor pointing to the table */
2041da250ea5Sdrh   int iReg,        /* Store results here */
2042da250ea5Sdrh   int allowAffChng /* True if prior affinity changes are OK */
20432133d822Sdrh ){
2044e55cbd72Sdrh   Vdbe *v = pParse->pVdbe;
2045e55cbd72Sdrh   int i;
2046da250ea5Sdrh   struct yColCache *p;
2047e55cbd72Sdrh 
2048ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2049ceea3321Sdrh     if( p->iReg>0 && p->iTable==iTable && p->iColumn==iColumn
2050da250ea5Sdrh            && (!p->affChange || allowAffChng) ){
2051ceea3321Sdrh       p->lru = pParse->iCacheCnt++;
20525cd79239Sdrh       sqlite3ExprCachePinRegister(pParse, p->iReg);
2053da250ea5Sdrh       return p->iReg;
2054e55cbd72Sdrh     }
2055e55cbd72Sdrh   }
2056e55cbd72Sdrh   assert( v!=0 );
2057945498f3Sdrh   if( iColumn<0 ){
2058044925beSdrh     sqlite3VdbeAddOp2(v, OP_Rowid, iTable, iReg);
205920411ea7Sdrh   }else if( ALWAYS(pTab!=0) ){
2060945498f3Sdrh     int op = IsVirtual(pTab) ? OP_VColumn : OP_Column;
20612133d822Sdrh     sqlite3VdbeAddOp3(v, op, iTable, iColumn, iReg);
2062c7538b5fSdanielk1977     sqlite3ColumnDefault(v, pTab, iColumn, iReg);
2063945498f3Sdrh   }
2064ceea3321Sdrh   sqlite3ExprCacheStore(pParse, iTable, iColumn, iReg);
2065e55cbd72Sdrh   return iReg;
2066e55cbd72Sdrh }
2067e55cbd72Sdrh 
2068e55cbd72Sdrh /*
2069ceea3321Sdrh ** Clear all column cache entries.
2070e55cbd72Sdrh */
2071ceea3321Sdrh void sqlite3ExprCacheClear(Parse *pParse){
2072e55cbd72Sdrh   int i;
2073ceea3321Sdrh   struct yColCache *p;
2074ceea3321Sdrh 
2075ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2076ceea3321Sdrh     if( p->iReg ){
2077ceea3321Sdrh       cacheEntryClear(pParse, p);
2078ceea3321Sdrh       p->iReg = 0;
2079e55cbd72Sdrh     }
2080da250ea5Sdrh   }
2081da250ea5Sdrh }
2082e55cbd72Sdrh 
2083e55cbd72Sdrh /*
2084da250ea5Sdrh ** Record the fact that an affinity change has occurred on iCount
2085da250ea5Sdrh ** registers starting with iStart.
2086e55cbd72Sdrh */
2087da250ea5Sdrh void sqlite3ExprCacheAffinityChange(Parse *pParse, int iStart, int iCount){
2088da250ea5Sdrh   int iEnd = iStart + iCount - 1;
2089e55cbd72Sdrh   int i;
2090ceea3321Sdrh   struct yColCache *p;
2091ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2092ceea3321Sdrh     int r = p->iReg;
2093da250ea5Sdrh     if( r>=iStart && r<=iEnd ){
2094ceea3321Sdrh       p->affChange = 1;
2095e55cbd72Sdrh     }
2096e55cbd72Sdrh   }
2097e55cbd72Sdrh }
2098e55cbd72Sdrh 
2099e55cbd72Sdrh /*
2100b21e7c70Sdrh ** Generate code to move content from registers iFrom...iFrom+nReg-1
2101b21e7c70Sdrh ** over to iTo..iTo+nReg-1. Keep the column cache up-to-date.
2102e55cbd72Sdrh */
2103b21e7c70Sdrh void sqlite3ExprCodeMove(Parse *pParse, int iFrom, int iTo, int nReg){
2104e55cbd72Sdrh   int i;
2105ceea3321Sdrh   struct yColCache *p;
210620411ea7Sdrh   if( NEVER(iFrom==iTo) ) return;
2107b21e7c70Sdrh   sqlite3VdbeAddOp3(pParse->pVdbe, OP_Move, iFrom, iTo, nReg);
2108ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2109ceea3321Sdrh     int x = p->iReg;
2110b21e7c70Sdrh     if( x>=iFrom && x<iFrom+nReg ){
2111ceea3321Sdrh       p->iReg += iTo-iFrom;
2112e55cbd72Sdrh     }
2113e55cbd72Sdrh   }
2114945498f3Sdrh }
2115945498f3Sdrh 
2116fec19aadSdrh /*
211792b01d53Sdrh ** Generate code to copy content from registers iFrom...iFrom+nReg-1
211892b01d53Sdrh ** over to iTo..iTo+nReg-1.
211992b01d53Sdrh */
212092b01d53Sdrh void sqlite3ExprCodeCopy(Parse *pParse, int iFrom, int iTo, int nReg){
212192b01d53Sdrh   int i;
212220411ea7Sdrh   if( NEVER(iFrom==iTo) ) return;
212392b01d53Sdrh   for(i=0; i<nReg; i++){
212492b01d53Sdrh     sqlite3VdbeAddOp2(pParse->pVdbe, OP_Copy, iFrom+i, iTo+i);
212592b01d53Sdrh   }
212692b01d53Sdrh }
212792b01d53Sdrh 
212892b01d53Sdrh /*
2129652fbf55Sdrh ** Return true if any register in the range iFrom..iTo (inclusive)
2130652fbf55Sdrh ** is used as part of the column cache.
2131652fbf55Sdrh */
2132652fbf55Sdrh static int usedAsColumnCache(Parse *pParse, int iFrom, int iTo){
2133652fbf55Sdrh   int i;
2134ceea3321Sdrh   struct yColCache *p;
2135ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2136ceea3321Sdrh     int r = p->iReg;
2137652fbf55Sdrh     if( r>=iFrom && r<=iTo ) return 1;
2138652fbf55Sdrh   }
2139652fbf55Sdrh   return 0;
2140652fbf55Sdrh }
2141652fbf55Sdrh 
2142652fbf55Sdrh /*
2143191b54cbSdrh ** If the last instruction coded is an ephemeral copy of any of
2144191b54cbSdrh ** the registers in the nReg registers beginning with iReg, then
2145191b54cbSdrh ** convert the last instruction from OP_SCopy to OP_Copy.
2146191b54cbSdrh */
2147191b54cbSdrh void sqlite3ExprHardCopy(Parse *pParse, int iReg, int nReg){
2148191b54cbSdrh   VdbeOp *pOp;
2149191b54cbSdrh   Vdbe *v;
2150191b54cbSdrh 
215120411ea7Sdrh   assert( pParse->db->mallocFailed==0 );
2152191b54cbSdrh   v = pParse->pVdbe;
215320411ea7Sdrh   assert( v!=0 );
215420411ea7Sdrh   pOp = sqlite3VdbeGetOp(v, -1);
215520411ea7Sdrh   assert( pOp!=0 );
215620411ea7Sdrh   if( pOp->opcode==OP_SCopy && pOp->p1>=iReg && pOp->p1<iReg+nReg ){
2157191b54cbSdrh     pOp->opcode = OP_Copy;
2158191b54cbSdrh   }
2159191b54cbSdrh }
2160191b54cbSdrh 
2161191b54cbSdrh /*
21628b213899Sdrh ** Generate code to store the value of the iAlias-th alias in register
21638b213899Sdrh ** target.  The first time this is called, pExpr is evaluated to compute
21648b213899Sdrh ** the value of the alias.  The value is stored in an auxiliary register
21658b213899Sdrh ** and the number of that register is returned.  On subsequent calls,
21668b213899Sdrh ** the register number is returned without generating any code.
21678b213899Sdrh **
21688b213899Sdrh ** Note that in order for this to work, code must be generated in the
21698b213899Sdrh ** same order that it is executed.
21708b213899Sdrh **
21718b213899Sdrh ** Aliases are numbered starting with 1.  So iAlias is in the range
21728b213899Sdrh ** of 1 to pParse->nAlias inclusive.
21738b213899Sdrh **
21748b213899Sdrh ** pParse->aAlias[iAlias-1] records the register number where the value
21758b213899Sdrh ** of the iAlias-th alias is stored.  If zero, that means that the
21768b213899Sdrh ** alias has not yet been computed.
21778b213899Sdrh */
217831daa63fSdrh static int codeAlias(Parse *pParse, int iAlias, Expr *pExpr, int target){
2179ceea3321Sdrh #if 0
21808b213899Sdrh   sqlite3 *db = pParse->db;
21818b213899Sdrh   int iReg;
2182555f8de7Sdrh   if( pParse->nAliasAlloc<pParse->nAlias ){
2183555f8de7Sdrh     pParse->aAlias = sqlite3DbReallocOrFree(db, pParse->aAlias,
21848b213899Sdrh                                  sizeof(pParse->aAlias[0])*pParse->nAlias );
2185555f8de7Sdrh     testcase( db->mallocFailed && pParse->nAliasAlloc>0 );
21868b213899Sdrh     if( db->mallocFailed ) return 0;
2187555f8de7Sdrh     memset(&pParse->aAlias[pParse->nAliasAlloc], 0,
2188555f8de7Sdrh            (pParse->nAlias-pParse->nAliasAlloc)*sizeof(pParse->aAlias[0]));
2189555f8de7Sdrh     pParse->nAliasAlloc = pParse->nAlias;
21908b213899Sdrh   }
21918b213899Sdrh   assert( iAlias>0 && iAlias<=pParse->nAlias );
21928b213899Sdrh   iReg = pParse->aAlias[iAlias-1];
21938b213899Sdrh   if( iReg==0 ){
2194ceea3321Sdrh     if( pParse->iCacheLevel>0 ){
219531daa63fSdrh       iReg = sqlite3ExprCodeTarget(pParse, pExpr, target);
219631daa63fSdrh     }else{
21978b213899Sdrh       iReg = ++pParse->nMem;
21988b213899Sdrh       sqlite3ExprCode(pParse, pExpr, iReg);
21998b213899Sdrh       pParse->aAlias[iAlias-1] = iReg;
22008b213899Sdrh     }
220131daa63fSdrh   }
22028b213899Sdrh   return iReg;
2203ceea3321Sdrh #else
220460a4b538Sshane   UNUSED_PARAMETER(iAlias);
2205ceea3321Sdrh   return sqlite3ExprCodeTarget(pParse, pExpr, target);
2206ceea3321Sdrh #endif
22078b213899Sdrh }
22088b213899Sdrh 
22098b213899Sdrh /*
2210cce7d176Sdrh ** Generate code into the current Vdbe to evaluate the given
22112dcef11bSdrh ** expression.  Attempt to store the results in register "target".
22122dcef11bSdrh ** Return the register where results are stored.
2213389a1adbSdrh **
22148b213899Sdrh ** With this routine, there is no guarantee that results will
22152dcef11bSdrh ** be stored in target.  The result might be stored in some other
22162dcef11bSdrh ** register if it is convenient to do so.  The calling function
22172dcef11bSdrh ** must check the return code and move the results to the desired
22182dcef11bSdrh ** register.
2219cce7d176Sdrh */
2220678ccce8Sdrh int sqlite3ExprCodeTarget(Parse *pParse, Expr *pExpr, int target){
22212dcef11bSdrh   Vdbe *v = pParse->pVdbe;  /* The VM under construction */
22222dcef11bSdrh   int op;                   /* The opcode being coded */
22232dcef11bSdrh   int inReg = target;       /* Results stored in register inReg */
22242dcef11bSdrh   int regFree1 = 0;         /* If non-zero free this temporary register */
22252dcef11bSdrh   int regFree2 = 0;         /* If non-zero free this temporary register */
2226678ccce8Sdrh   int r1, r2, r3, r4;       /* Various register numbers */
222720411ea7Sdrh   sqlite3 *db = pParse->db; /* The database connection */
2228ffe07b2dSdrh 
22299cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
223020411ea7Sdrh   if( v==0 ){
223120411ea7Sdrh     assert( pParse->db->mallocFailed );
223220411ea7Sdrh     return 0;
223320411ea7Sdrh   }
2234389a1adbSdrh 
2235389a1adbSdrh   if( pExpr==0 ){
2236389a1adbSdrh     op = TK_NULL;
2237389a1adbSdrh   }else{
2238f2bc013cSdrh     op = pExpr->op;
2239389a1adbSdrh   }
2240f2bc013cSdrh   switch( op ){
224113449892Sdrh     case TK_AGG_COLUMN: {
224213449892Sdrh       AggInfo *pAggInfo = pExpr->pAggInfo;
224313449892Sdrh       struct AggInfo_col *pCol = &pAggInfo->aCol[pExpr->iAgg];
224413449892Sdrh       if( !pAggInfo->directMode ){
22459de221dfSdrh         assert( pCol->iMem>0 );
22469de221dfSdrh         inReg = pCol->iMem;
224713449892Sdrh         break;
224813449892Sdrh       }else if( pAggInfo->useSortingIdx ){
2249389a1adbSdrh         sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdx,
2250389a1adbSdrh                               pCol->iSorterColumn, target);
225113449892Sdrh         break;
225213449892Sdrh       }
225313449892Sdrh       /* Otherwise, fall thru into the TK_COLUMN case */
225413449892Sdrh     }
2255967e8b73Sdrh     case TK_COLUMN: {
2256ffe07b2dSdrh       if( pExpr->iTable<0 ){
2257ffe07b2dSdrh         /* This only happens when coding check constraints */
2258aa9b8963Sdrh         assert( pParse->ckBase>0 );
2259aa9b8963Sdrh         inReg = pExpr->iColumn + pParse->ckBase;
2260c4a3c779Sdrh       }else{
2261c5499befSdrh         testcase( (pExpr->flags & EP_AnyAff)!=0 );
2262e55cbd72Sdrh         inReg = sqlite3ExprCodeGetColumn(pParse, pExpr->pTab,
2263da250ea5Sdrh                                  pExpr->iColumn, pExpr->iTable, target,
2264da250ea5Sdrh                                  pExpr->flags & EP_AnyAff);
22652282792aSdrh       }
2266cce7d176Sdrh       break;
2267cce7d176Sdrh     }
2268cce7d176Sdrh     case TK_INTEGER: {
226992b01d53Sdrh       codeInteger(v, pExpr, 0, target);
2270fec19aadSdrh       break;
227151e9a445Sdrh     }
2272598f1340Sdrh     case TK_FLOAT: {
227333e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
227433e619fcSdrh       codeReal(v, pExpr->u.zToken, 0, target);
2275598f1340Sdrh       break;
2276598f1340Sdrh     }
2277fec19aadSdrh     case TK_STRING: {
227833e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
227933e619fcSdrh       sqlite3VdbeAddOp4(v, OP_String8, 0, target, 0, pExpr->u.zToken, 0);
2280cce7d176Sdrh       break;
2281cce7d176Sdrh     }
2282f0863fe5Sdrh     case TK_NULL: {
22839de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
2284f0863fe5Sdrh       break;
2285f0863fe5Sdrh     }
22865338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_BLOB_LITERAL
2287c572ef7fSdanielk1977     case TK_BLOB: {
22886c8c6cecSdrh       int n;
22896c8c6cecSdrh       const char *z;
2290ca48c90fSdrh       char *zBlob;
229133e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
229233e619fcSdrh       assert( pExpr->u.zToken[0]=='x' || pExpr->u.zToken[0]=='X' );
229333e619fcSdrh       assert( pExpr->u.zToken[1]=='\'' );
229433e619fcSdrh       z = &pExpr->u.zToken[2];
2295b7916a78Sdrh       n = sqlite3Strlen30(z) - 1;
2296b7916a78Sdrh       assert( z[n]=='\'' );
2297ca48c90fSdrh       zBlob = sqlite3HexToBlob(sqlite3VdbeDb(v), z, n);
2298ca48c90fSdrh       sqlite3VdbeAddOp4(v, OP_Blob, n/2, target, 0, zBlob, P4_DYNAMIC);
2299c572ef7fSdanielk1977       break;
2300c572ef7fSdanielk1977     }
23015338a5f7Sdanielk1977 #endif
230250457896Sdrh     case TK_VARIABLE: {
230308de1490Sdrh       VdbeOp *pOp;
230433e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
230533e619fcSdrh       assert( pExpr->u.zToken!=0 );
230633e619fcSdrh       assert( pExpr->u.zToken[0]!=0 );
230733e619fcSdrh       if( pExpr->u.zToken[1]==0
230820411ea7Sdrh          && (pOp = sqlite3VdbeGetOp(v, -1))->opcode==OP_Variable
2309937d0deaSdan          && pOp->p1+pOp->p3==pExpr->iColumn
231008de1490Sdrh          && pOp->p2+pOp->p3==target
231108de1490Sdrh          && pOp->p4.z==0
231208de1490Sdrh       ){
231308de1490Sdrh         /* If the previous instruction was a copy of the previous unnamed
231408de1490Sdrh         ** parameter into the previous register, then simply increment the
231508de1490Sdrh         ** repeat count on the prior instruction rather than making a new
231608de1490Sdrh         ** instruction.
231708de1490Sdrh         */
231808de1490Sdrh         pOp->p3++;
231908de1490Sdrh       }else{
2320937d0deaSdan         sqlite3VdbeAddOp3(v, OP_Variable, pExpr->iColumn, target, 1);
232133e619fcSdrh         if( pExpr->u.zToken[1]!=0 ){
232233e619fcSdrh           sqlite3VdbeChangeP4(v, -1, pExpr->u.zToken, 0);
2323895d7472Sdrh         }
232408de1490Sdrh       }
232550457896Sdrh       break;
232650457896Sdrh     }
23274e0cff60Sdrh     case TK_REGISTER: {
23289de221dfSdrh       inReg = pExpr->iTable;
23294e0cff60Sdrh       break;
23304e0cff60Sdrh     }
23318b213899Sdrh     case TK_AS: {
233231daa63fSdrh       inReg = codeAlias(pParse, pExpr->iTable, pExpr->pLeft, target);
23338b213899Sdrh       break;
23348b213899Sdrh     }
2335487e262fSdrh #ifndef SQLITE_OMIT_CAST
2336487e262fSdrh     case TK_CAST: {
2337487e262fSdrh       /* Expressions of the form:   CAST(pLeft AS token) */
2338f0113000Sdanielk1977       int aff, to_op;
23392dcef11bSdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
234033e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
234133e619fcSdrh       aff = sqlite3AffinityType(pExpr->u.zToken);
2342f0113000Sdanielk1977       to_op = aff - SQLITE_AFF_TEXT + OP_ToText;
2343f0113000Sdanielk1977       assert( to_op==OP_ToText    || aff!=SQLITE_AFF_TEXT    );
2344f0113000Sdanielk1977       assert( to_op==OP_ToBlob    || aff!=SQLITE_AFF_NONE    );
2345f0113000Sdanielk1977       assert( to_op==OP_ToNumeric || aff!=SQLITE_AFF_NUMERIC );
2346f0113000Sdanielk1977       assert( to_op==OP_ToInt     || aff!=SQLITE_AFF_INTEGER );
2347f0113000Sdanielk1977       assert( to_op==OP_ToReal    || aff!=SQLITE_AFF_REAL    );
2348c5499befSdrh       testcase( to_op==OP_ToText );
2349c5499befSdrh       testcase( to_op==OP_ToBlob );
2350c5499befSdrh       testcase( to_op==OP_ToNumeric );
2351c5499befSdrh       testcase( to_op==OP_ToInt );
2352c5499befSdrh       testcase( to_op==OP_ToReal );
23531735fa88Sdrh       if( inReg!=target ){
23541735fa88Sdrh         sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
23551735fa88Sdrh         inReg = target;
23561735fa88Sdrh       }
23572dcef11bSdrh       sqlite3VdbeAddOp1(v, to_op, inReg);
2358c5499befSdrh       testcase( usedAsColumnCache(pParse, inReg, inReg) );
2359b3843a82Sdrh       sqlite3ExprCacheAffinityChange(pParse, inReg, 1);
2360487e262fSdrh       break;
2361487e262fSdrh     }
2362487e262fSdrh #endif /* SQLITE_OMIT_CAST */
2363c9b84a1fSdrh     case TK_LT:
2364c9b84a1fSdrh     case TK_LE:
2365c9b84a1fSdrh     case TK_GT:
2366c9b84a1fSdrh     case TK_GE:
2367c9b84a1fSdrh     case TK_NE:
2368c9b84a1fSdrh     case TK_EQ: {
2369f2bc013cSdrh       assert( TK_LT==OP_Lt );
2370f2bc013cSdrh       assert( TK_LE==OP_Le );
2371f2bc013cSdrh       assert( TK_GT==OP_Gt );
2372f2bc013cSdrh       assert( TK_GE==OP_Ge );
2373f2bc013cSdrh       assert( TK_EQ==OP_Eq );
2374f2bc013cSdrh       assert( TK_NE==OP_Ne );
2375c5499befSdrh       testcase( op==TK_LT );
2376c5499befSdrh       testcase( op==TK_LE );
2377c5499befSdrh       testcase( op==TK_GT );
2378c5499befSdrh       testcase( op==TK_GE );
2379c5499befSdrh       testcase( op==TK_EQ );
2380c5499befSdrh       testcase( op==TK_NE );
2381da250ea5Sdrh       codeCompareOperands(pParse, pExpr->pLeft, &r1, &regFree1,
2382da250ea5Sdrh                                   pExpr->pRight, &r2, &regFree2);
238335573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
238435573356Sdrh                   r1, r2, inReg, SQLITE_STOREP2);
2385c5499befSdrh       testcase( regFree1==0 );
2386c5499befSdrh       testcase( regFree2==0 );
2387a37cdde0Sdanielk1977       break;
2388c9b84a1fSdrh     }
23896a2fe093Sdrh     case TK_IS:
23906a2fe093Sdrh     case TK_ISNOT: {
23916a2fe093Sdrh       testcase( op==TK_IS );
23926a2fe093Sdrh       testcase( op==TK_ISNOT );
23936a2fe093Sdrh       codeCompareOperands(pParse, pExpr->pLeft, &r1, &regFree1,
23946a2fe093Sdrh                                   pExpr->pRight, &r2, &regFree2);
23956a2fe093Sdrh       op = (op==TK_IS) ? TK_EQ : TK_NE;
23966a2fe093Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
23976a2fe093Sdrh                   r1, r2, inReg, SQLITE_STOREP2 | SQLITE_NULLEQ);
23986a2fe093Sdrh       testcase( regFree1==0 );
23996a2fe093Sdrh       testcase( regFree2==0 );
24006a2fe093Sdrh       break;
24016a2fe093Sdrh     }
2402cce7d176Sdrh     case TK_AND:
2403cce7d176Sdrh     case TK_OR:
2404cce7d176Sdrh     case TK_PLUS:
2405cce7d176Sdrh     case TK_STAR:
2406cce7d176Sdrh     case TK_MINUS:
2407bf4133cbSdrh     case TK_REM:
2408bf4133cbSdrh     case TK_BITAND:
2409bf4133cbSdrh     case TK_BITOR:
241017c40294Sdrh     case TK_SLASH:
2411bf4133cbSdrh     case TK_LSHIFT:
2412855eb1cfSdrh     case TK_RSHIFT:
24130040077dSdrh     case TK_CONCAT: {
2414f2bc013cSdrh       assert( TK_AND==OP_And );
2415f2bc013cSdrh       assert( TK_OR==OP_Or );
2416f2bc013cSdrh       assert( TK_PLUS==OP_Add );
2417f2bc013cSdrh       assert( TK_MINUS==OP_Subtract );
2418f2bc013cSdrh       assert( TK_REM==OP_Remainder );
2419f2bc013cSdrh       assert( TK_BITAND==OP_BitAnd );
2420f2bc013cSdrh       assert( TK_BITOR==OP_BitOr );
2421f2bc013cSdrh       assert( TK_SLASH==OP_Divide );
2422f2bc013cSdrh       assert( TK_LSHIFT==OP_ShiftLeft );
2423f2bc013cSdrh       assert( TK_RSHIFT==OP_ShiftRight );
2424f2bc013cSdrh       assert( TK_CONCAT==OP_Concat );
2425c5499befSdrh       testcase( op==TK_AND );
2426c5499befSdrh       testcase( op==TK_OR );
2427c5499befSdrh       testcase( op==TK_PLUS );
2428c5499befSdrh       testcase( op==TK_MINUS );
2429c5499befSdrh       testcase( op==TK_REM );
2430c5499befSdrh       testcase( op==TK_BITAND );
2431c5499befSdrh       testcase( op==TK_BITOR );
2432c5499befSdrh       testcase( op==TK_SLASH );
2433c5499befSdrh       testcase( op==TK_LSHIFT );
2434c5499befSdrh       testcase( op==TK_RSHIFT );
2435c5499befSdrh       testcase( op==TK_CONCAT );
24362dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
24372dcef11bSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
24385b6afba9Sdrh       sqlite3VdbeAddOp3(v, op, r2, r1, target);
2439c5499befSdrh       testcase( regFree1==0 );
2440c5499befSdrh       testcase( regFree2==0 );
24410040077dSdrh       break;
24420040077dSdrh     }
2443cce7d176Sdrh     case TK_UMINUS: {
2444fec19aadSdrh       Expr *pLeft = pExpr->pLeft;
2445fec19aadSdrh       assert( pLeft );
2446fec19aadSdrh       if( pLeft->op==TK_FLOAT ){
244733e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
244833e619fcSdrh         codeReal(v, pLeft->u.zToken, 1, target);
2449fbd60f82Sshane       }else if( pLeft->op==TK_INTEGER ){
245092b01d53Sdrh         codeInteger(v, pLeft, 1, target);
24513c84ddffSdrh       }else{
24522dcef11bSdrh         regFree1 = r1 = sqlite3GetTempReg(pParse);
24533c84ddffSdrh         sqlite3VdbeAddOp2(v, OP_Integer, 0, r1);
2454e55cbd72Sdrh         r2 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree2);
24552dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_Subtract, r2, r1, target);
2456c5499befSdrh         testcase( regFree2==0 );
24573c84ddffSdrh       }
24589de221dfSdrh       inReg = target;
24596e142f54Sdrh       break;
24606e142f54Sdrh     }
2461bf4133cbSdrh     case TK_BITNOT:
24626e142f54Sdrh     case TK_NOT: {
2463f2bc013cSdrh       assert( TK_BITNOT==OP_BitNot );
2464f2bc013cSdrh       assert( TK_NOT==OP_Not );
2465c5499befSdrh       testcase( op==TK_BITNOT );
2466c5499befSdrh       testcase( op==TK_NOT );
2467e99fa2afSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
2468e99fa2afSdrh       testcase( regFree1==0 );
2469e99fa2afSdrh       inReg = target;
2470e99fa2afSdrh       sqlite3VdbeAddOp2(v, op, r1, inReg);
2471cce7d176Sdrh       break;
2472cce7d176Sdrh     }
2473cce7d176Sdrh     case TK_ISNULL:
2474cce7d176Sdrh     case TK_NOTNULL: {
24756a288a33Sdrh       int addr;
2476f2bc013cSdrh       assert( TK_ISNULL==OP_IsNull );
2477f2bc013cSdrh       assert( TK_NOTNULL==OP_NotNull );
2478c5499befSdrh       testcase( op==TK_ISNULL );
2479c5499befSdrh       testcase( op==TK_NOTNULL );
24809de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
24812dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
2482c5499befSdrh       testcase( regFree1==0 );
24832dcef11bSdrh       addr = sqlite3VdbeAddOp1(v, op, r1);
24849de221dfSdrh       sqlite3VdbeAddOp2(v, OP_AddImm, target, -1);
24856a288a33Sdrh       sqlite3VdbeJumpHere(v, addr);
2486a37cdde0Sdanielk1977       break;
2487f2bc013cSdrh     }
24882282792aSdrh     case TK_AGG_FUNCTION: {
248913449892Sdrh       AggInfo *pInfo = pExpr->pAggInfo;
24907e56e711Sdrh       if( pInfo==0 ){
249133e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
249233e619fcSdrh         sqlite3ErrorMsg(pParse, "misuse of aggregate: %s()", pExpr->u.zToken);
24937e56e711Sdrh       }else{
24949de221dfSdrh         inReg = pInfo->aFunc[pExpr->iAgg].iMem;
24957e56e711Sdrh       }
24962282792aSdrh       break;
24972282792aSdrh     }
2498b71090fdSdrh     case TK_CONST_FUNC:
2499cce7d176Sdrh     case TK_FUNCTION: {
250012ffee8cSdrh       ExprList *pFarg;       /* List of function arguments */
250112ffee8cSdrh       int nFarg;             /* Number of function arguments */
250212ffee8cSdrh       FuncDef *pDef;         /* The function definition object */
250312ffee8cSdrh       int nId;               /* Length of the function name in bytes */
250412ffee8cSdrh       const char *zId;       /* The function name */
250512ffee8cSdrh       int constMask = 0;     /* Mask of function arguments that are constant */
250612ffee8cSdrh       int i;                 /* Loop counter */
250712ffee8cSdrh       u8 enc = ENC(db);      /* The text encoding used by this database */
250812ffee8cSdrh       CollSeq *pColl = 0;    /* A collating sequence */
250917435752Sdrh 
25106ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
2511c5499befSdrh       testcase( op==TK_CONST_FUNC );
2512c5499befSdrh       testcase( op==TK_FUNCTION );
2513b7916a78Sdrh       if( ExprHasAnyProperty(pExpr, EP_TokenOnly) ){
251412ffee8cSdrh         pFarg = 0;
251512ffee8cSdrh       }else{
251612ffee8cSdrh         pFarg = pExpr->x.pList;
251712ffee8cSdrh       }
251812ffee8cSdrh       nFarg = pFarg ? pFarg->nExpr : 0;
251933e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
252033e619fcSdrh       zId = pExpr->u.zToken;
2521b7916a78Sdrh       nId = sqlite3Strlen30(zId);
252212ffee8cSdrh       pDef = sqlite3FindFunction(db, zId, nId, nFarg, enc, 0);
2523feb306f5Sdrh       if( pDef==0 ){
2524feb306f5Sdrh         sqlite3ErrorMsg(pParse, "unknown function: %.*s()", nId, zId);
2525feb306f5Sdrh         break;
2526feb306f5Sdrh       }
2527ae6bb957Sdrh 
2528ae6bb957Sdrh       /* Attempt a direct implementation of the built-in COALESCE() and
2529ae6bb957Sdrh       ** IFNULL() functions.  This avoids unnecessary evalation of
2530ae6bb957Sdrh       ** arguments past the first non-NULL argument.
2531ae6bb957Sdrh       */
2532ae6bb957Sdrh       if( pDef->flags & SQLITE_FUNC_COALESCE ){
2533ae6bb957Sdrh         int endCoalesce = sqlite3VdbeMakeLabel(v);
2534ae6bb957Sdrh         assert( nFarg>=2 );
2535ae6bb957Sdrh         sqlite3ExprCode(pParse, pFarg->a[0].pExpr, target);
2536ae6bb957Sdrh         for(i=1; i<nFarg; i++){
2537ae6bb957Sdrh           sqlite3VdbeAddOp2(v, OP_NotNull, target, endCoalesce);
2538ae6bb957Sdrh           sqlite3ExprCacheRemove(pParse, target);
2539ae6bb957Sdrh           sqlite3ExprCachePush(pParse);
2540ae6bb957Sdrh           sqlite3ExprCode(pParse, pFarg->a[i].pExpr, target);
2541ae6bb957Sdrh           sqlite3ExprCachePop(pParse, 1);
2542ae6bb957Sdrh         }
2543ae6bb957Sdrh         sqlite3VdbeResolveLabel(v, endCoalesce);
2544ae6bb957Sdrh         break;
2545ae6bb957Sdrh       }
2546ae6bb957Sdrh 
2547ae6bb957Sdrh 
254812ffee8cSdrh       if( pFarg ){
254912ffee8cSdrh         r1 = sqlite3GetTempRange(pParse, nFarg);
2550d7d385ddSdrh         sqlite3ExprCachePush(pParse);     /* Ticket 2ea2425d34be */
255112ffee8cSdrh         sqlite3ExprCodeExprList(pParse, pFarg, r1, 1);
2552d7d385ddSdrh         sqlite3ExprCachePop(pParse, 1);   /* Ticket 2ea2425d34be */
2553892d3179Sdrh       }else{
255412ffee8cSdrh         r1 = 0;
2555892d3179Sdrh       }
2556b7f6f68fSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
2557a43fa227Sdrh       /* Possibly overload the function if the first argument is
2558a43fa227Sdrh       ** a virtual table column.
2559a43fa227Sdrh       **
2560a43fa227Sdrh       ** For infix functions (LIKE, GLOB, REGEXP, and MATCH) use the
2561a43fa227Sdrh       ** second argument, not the first, as the argument to test to
2562a43fa227Sdrh       ** see if it is a column in a virtual table.  This is done because
2563a43fa227Sdrh       ** the left operand of infix functions (the operand we want to
2564a43fa227Sdrh       ** control overloading) ends up as the second argument to the
2565a43fa227Sdrh       ** function.  The expression "A glob B" is equivalent to
2566a43fa227Sdrh       ** "glob(B,A).  We want to use the A in "A glob B" to test
2567a43fa227Sdrh       ** for function overloading.  But we use the B term in "glob(B,A)".
2568a43fa227Sdrh       */
256912ffee8cSdrh       if( nFarg>=2 && (pExpr->flags & EP_InfixFunc) ){
257012ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[1].pExpr);
257112ffee8cSdrh       }else if( nFarg>0 ){
257212ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[0].pExpr);
2573b7f6f68fSdrh       }
2574b7f6f68fSdrh #endif
2575f7bca574Sdrh       for(i=0; i<nFarg; i++){
2576f7bca574Sdrh         if( i<32 && sqlite3ExprIsConstant(pFarg->a[i].pExpr) ){
257713449892Sdrh           constMask |= (1<<i);
2578d02eb1fdSdanielk1977         }
2579e82f5d04Sdrh         if( (pDef->flags & SQLITE_FUNC_NEEDCOLL)!=0 && !pColl ){
258012ffee8cSdrh           pColl = sqlite3ExprCollSeq(pParse, pFarg->a[i].pExpr);
2581dc1bdc4fSdanielk1977         }
2582dc1bdc4fSdanielk1977       }
2583e82f5d04Sdrh       if( pDef->flags & SQLITE_FUNC_NEEDCOLL ){
25848b213899Sdrh         if( !pColl ) pColl = db->pDfltColl;
258566a5167bSdrh         sqlite3VdbeAddOp4(v, OP_CollSeq, 0, 0, 0, (char *)pColl, P4_COLLSEQ);
2586682f68b0Sdanielk1977       }
25872dcef11bSdrh       sqlite3VdbeAddOp4(v, OP_Function, constMask, r1, target,
258866a5167bSdrh                         (char*)pDef, P4_FUNCDEF);
258912ffee8cSdrh       sqlite3VdbeChangeP5(v, (u8)nFarg);
259012ffee8cSdrh       if( nFarg ){
259112ffee8cSdrh         sqlite3ReleaseTempRange(pParse, r1, nFarg);
25922dcef11bSdrh       }
259312ffee8cSdrh       sqlite3ExprCacheAffinityChange(pParse, r1, nFarg);
25946ec2733bSdrh       break;
25956ec2733bSdrh     }
2596fe2093d7Sdrh #ifndef SQLITE_OMIT_SUBQUERY
2597fe2093d7Sdrh     case TK_EXISTS:
259819a775c2Sdrh     case TK_SELECT: {
2599c5499befSdrh       testcase( op==TK_EXISTS );
2600c5499befSdrh       testcase( op==TK_SELECT );
26011450bc6eSdrh       inReg = sqlite3CodeSubselect(pParse, pExpr, 0, 0);
260219a775c2Sdrh       break;
260319a775c2Sdrh     }
2604fef5208cSdrh     case TK_IN: {
2605*e3365e6cSdrh       int destIfFalse = sqlite3VdbeMakeLabel(v);
2606*e3365e6cSdrh       int destIfNull = sqlite3VdbeMakeLabel(v);
2607*e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
2608*e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
260966ba23ceSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
2610*e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
2611*e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_AddImm, target, 0);
2612*e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfNull);
2613fef5208cSdrh       break;
2614fef5208cSdrh     }
2615*e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
2616*e3365e6cSdrh 
2617*e3365e6cSdrh 
26182dcef11bSdrh     /*
26192dcef11bSdrh     **    x BETWEEN y AND z
26202dcef11bSdrh     **
26212dcef11bSdrh     ** This is equivalent to
26222dcef11bSdrh     **
26232dcef11bSdrh     **    x>=y AND x<=z
26242dcef11bSdrh     **
26252dcef11bSdrh     ** X is stored in pExpr->pLeft.
26262dcef11bSdrh     ** Y is stored in pExpr->pList->a[0].pExpr.
26272dcef11bSdrh     ** Z is stored in pExpr->pList->a[1].pExpr.
26282dcef11bSdrh     */
2629fef5208cSdrh     case TK_BETWEEN: {
2630be5c89acSdrh       Expr *pLeft = pExpr->pLeft;
26316ab3a2ecSdanielk1977       struct ExprList_item *pLItem = pExpr->x.pList->a;
2632be5c89acSdrh       Expr *pRight = pLItem->pExpr;
263335573356Sdrh 
2634da250ea5Sdrh       codeCompareOperands(pParse, pLeft, &r1, &regFree1,
2635da250ea5Sdrh                                   pRight, &r2, &regFree2);
2636c5499befSdrh       testcase( regFree1==0 );
2637c5499befSdrh       testcase( regFree2==0 );
26382dcef11bSdrh       r3 = sqlite3GetTempReg(pParse);
2639678ccce8Sdrh       r4 = sqlite3GetTempReg(pParse);
264035573356Sdrh       codeCompare(pParse, pLeft, pRight, OP_Ge,
264135573356Sdrh                   r1, r2, r3, SQLITE_STOREP2);
2642be5c89acSdrh       pLItem++;
2643be5c89acSdrh       pRight = pLItem->pExpr;
26442dcef11bSdrh       sqlite3ReleaseTempReg(pParse, regFree2);
26452dcef11bSdrh       r2 = sqlite3ExprCodeTemp(pParse, pRight, &regFree2);
2646c5499befSdrh       testcase( regFree2==0 );
2647678ccce8Sdrh       codeCompare(pParse, pLeft, pRight, OP_Le, r1, r2, r4, SQLITE_STOREP2);
2648678ccce8Sdrh       sqlite3VdbeAddOp3(v, OP_And, r3, r4, target);
26492dcef11bSdrh       sqlite3ReleaseTempReg(pParse, r3);
2650678ccce8Sdrh       sqlite3ReleaseTempReg(pParse, r4);
2651fef5208cSdrh       break;
2652fef5208cSdrh     }
26534f07e5fbSdrh     case TK_UPLUS: {
26542dcef11bSdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
2655a2e00042Sdrh       break;
2656a2e00042Sdrh     }
26572dcef11bSdrh 
2658165921a7Sdan     case TK_TRIGGER: {
265965a7cd16Sdan       /* If the opcode is TK_TRIGGER, then the expression is a reference
266065a7cd16Sdan       ** to a column in the new.* or old.* pseudo-tables available to
266165a7cd16Sdan       ** trigger programs. In this case Expr.iTable is set to 1 for the
266265a7cd16Sdan       ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
266365a7cd16Sdan       ** is set to the column of the pseudo-table to read, or to -1 to
266465a7cd16Sdan       ** read the rowid field.
266565a7cd16Sdan       **
266665a7cd16Sdan       ** The expression is implemented using an OP_Param opcode. The p1
266765a7cd16Sdan       ** parameter is set to 0 for an old.rowid reference, or to (i+1)
266865a7cd16Sdan       ** to reference another column of the old.* pseudo-table, where
266965a7cd16Sdan       ** i is the index of the column. For a new.rowid reference, p1 is
267065a7cd16Sdan       ** set to (n+1), where n is the number of columns in each pseudo-table.
267165a7cd16Sdan       ** For a reference to any other column in the new.* pseudo-table, p1
267265a7cd16Sdan       ** is set to (n+2+i), where n and i are as defined previously. For
267365a7cd16Sdan       ** example, if the table on which triggers are being fired is
267465a7cd16Sdan       ** declared as:
267565a7cd16Sdan       **
267665a7cd16Sdan       **   CREATE TABLE t1(a, b);
267765a7cd16Sdan       **
267865a7cd16Sdan       ** Then p1 is interpreted as follows:
267965a7cd16Sdan       **
268065a7cd16Sdan       **   p1==0   ->    old.rowid     p1==3   ->    new.rowid
268165a7cd16Sdan       **   p1==1   ->    old.a         p1==4   ->    new.a
268265a7cd16Sdan       **   p1==2   ->    old.b         p1==5   ->    new.b
268365a7cd16Sdan       */
26842832ad42Sdan       Table *pTab = pExpr->pTab;
268565a7cd16Sdan       int p1 = pExpr->iTable * (pTab->nCol+1) + 1 + pExpr->iColumn;
268665a7cd16Sdan 
268765a7cd16Sdan       assert( pExpr->iTable==0 || pExpr->iTable==1 );
268865a7cd16Sdan       assert( pExpr->iColumn>=-1 && pExpr->iColumn<pTab->nCol );
268965a7cd16Sdan       assert( pTab->iPKey<0 || pExpr->iColumn!=pTab->iPKey );
269065a7cd16Sdan       assert( p1>=0 && p1<(pTab->nCol*2+2) );
269165a7cd16Sdan 
269265a7cd16Sdan       sqlite3VdbeAddOp2(v, OP_Param, p1, target);
269376d462eeSdan       VdbeComment((v, "%s.%s -> $%d",
2694165921a7Sdan         (pExpr->iTable ? "new" : "old"),
269576d462eeSdan         (pExpr->iColumn<0 ? "rowid" : pExpr->pTab->aCol[pExpr->iColumn].zName),
269676d462eeSdan         target
2697165921a7Sdan       ));
269865a7cd16Sdan 
269965a7cd16Sdan       /* If the column has REAL affinity, it may currently be stored as an
270065a7cd16Sdan       ** integer. Use OP_RealAffinity to make sure it is really real.  */
27012832ad42Sdan       if( pExpr->iColumn>=0
27022832ad42Sdan        && pTab->aCol[pExpr->iColumn].affinity==SQLITE_AFF_REAL
27032832ad42Sdan       ){
27042832ad42Sdan         sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
27052832ad42Sdan       }
2706165921a7Sdan       break;
2707165921a7Sdan     }
2708165921a7Sdan 
2709165921a7Sdan 
27102dcef11bSdrh     /*
27112dcef11bSdrh     ** Form A:
27122dcef11bSdrh     **   CASE x WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
27132dcef11bSdrh     **
27142dcef11bSdrh     ** Form B:
27152dcef11bSdrh     **   CASE WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
27162dcef11bSdrh     **
27172dcef11bSdrh     ** Form A is can be transformed into the equivalent form B as follows:
27182dcef11bSdrh     **   CASE WHEN x=e1 THEN r1 WHEN x=e2 THEN r2 ...
27192dcef11bSdrh     **        WHEN x=eN THEN rN ELSE y END
27202dcef11bSdrh     **
27212dcef11bSdrh     ** X (if it exists) is in pExpr->pLeft.
27222dcef11bSdrh     ** Y is in pExpr->pRight.  The Y is also optional.  If there is no
27232dcef11bSdrh     ** ELSE clause and no other term matches, then the result of the
27242dcef11bSdrh     ** exprssion is NULL.
27252dcef11bSdrh     ** Ei is in pExpr->pList->a[i*2] and Ri is pExpr->pList->a[i*2+1].
27262dcef11bSdrh     **
27272dcef11bSdrh     ** The result of the expression is the Ri for the first matching Ei,
27282dcef11bSdrh     ** or if there is no matching Ei, the ELSE term Y, or if there is
27292dcef11bSdrh     ** no ELSE term, NULL.
27302dcef11bSdrh     */
273133cd4909Sdrh     default: assert( op==TK_CASE ); {
27322dcef11bSdrh       int endLabel;                     /* GOTO label for end of CASE stmt */
27332dcef11bSdrh       int nextCase;                     /* GOTO label for next WHEN clause */
27342dcef11bSdrh       int nExpr;                        /* 2x number of WHEN terms */
27352dcef11bSdrh       int i;                            /* Loop counter */
27362dcef11bSdrh       ExprList *pEList;                 /* List of WHEN terms */
27372dcef11bSdrh       struct ExprList_item *aListelem;  /* Array of WHEN terms */
27382dcef11bSdrh       Expr opCompare;                   /* The X==Ei expression */
27392dcef11bSdrh       Expr cacheX;                      /* Cached expression X */
27402dcef11bSdrh       Expr *pX;                         /* The X expression */
27411bd10f8aSdrh       Expr *pTest = 0;                  /* X==Ei (form A) or just Ei (form B) */
2742ceea3321Sdrh       VVA_ONLY( int iCacheLevel = pParse->iCacheLevel; )
274317a7f8ddSdrh 
27446ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) && pExpr->x.pList );
27456ab3a2ecSdanielk1977       assert((pExpr->x.pList->nExpr % 2) == 0);
27466ab3a2ecSdanielk1977       assert(pExpr->x.pList->nExpr > 0);
27476ab3a2ecSdanielk1977       pEList = pExpr->x.pList;
2748be5c89acSdrh       aListelem = pEList->a;
2749be5c89acSdrh       nExpr = pEList->nExpr;
27502dcef11bSdrh       endLabel = sqlite3VdbeMakeLabel(v);
27512dcef11bSdrh       if( (pX = pExpr->pLeft)!=0 ){
27522dcef11bSdrh         cacheX = *pX;
275333cd4909Sdrh         testcase( pX->op==TK_COLUMN );
275433cd4909Sdrh         testcase( pX->op==TK_REGISTER );
27552dcef11bSdrh         cacheX.iTable = sqlite3ExprCodeTemp(pParse, pX, &regFree1);
2756c5499befSdrh         testcase( regFree1==0 );
27572dcef11bSdrh         cacheX.op = TK_REGISTER;
27582dcef11bSdrh         opCompare.op = TK_EQ;
27592dcef11bSdrh         opCompare.pLeft = &cacheX;
27602dcef11bSdrh         pTest = &opCompare;
2761cce7d176Sdrh       }
2762f5905aa7Sdrh       for(i=0; i<nExpr; i=i+2){
2763ceea3321Sdrh         sqlite3ExprCachePush(pParse);
27642dcef11bSdrh         if( pX ){
27651bd10f8aSdrh           assert( pTest!=0 );
27662dcef11bSdrh           opCompare.pRight = aListelem[i].pExpr;
2767f5905aa7Sdrh         }else{
27682dcef11bSdrh           pTest = aListelem[i].pExpr;
276917a7f8ddSdrh         }
27702dcef11bSdrh         nextCase = sqlite3VdbeMakeLabel(v);
277133cd4909Sdrh         testcase( pTest->op==TK_COLUMN );
27722dcef11bSdrh         sqlite3ExprIfFalse(pParse, pTest, nextCase, SQLITE_JUMPIFNULL);
2773c5499befSdrh         testcase( aListelem[i+1].pExpr->op==TK_COLUMN );
2774c5499befSdrh         testcase( aListelem[i+1].pExpr->op==TK_REGISTER );
27759de221dfSdrh         sqlite3ExprCode(pParse, aListelem[i+1].pExpr, target);
27762dcef11bSdrh         sqlite3VdbeAddOp2(v, OP_Goto, 0, endLabel);
2777ceea3321Sdrh         sqlite3ExprCachePop(pParse, 1);
27782dcef11bSdrh         sqlite3VdbeResolveLabel(v, nextCase);
2779f570f011Sdrh       }
278017a7f8ddSdrh       if( pExpr->pRight ){
2781ceea3321Sdrh         sqlite3ExprCachePush(pParse);
27829de221dfSdrh         sqlite3ExprCode(pParse, pExpr->pRight, target);
2783ceea3321Sdrh         sqlite3ExprCachePop(pParse, 1);
278417a7f8ddSdrh       }else{
27859de221dfSdrh         sqlite3VdbeAddOp2(v, OP_Null, 0, target);
278617a7f8ddSdrh       }
2787c1f4a19bSdanielk1977       assert( db->mallocFailed || pParse->nErr>0
2788c1f4a19bSdanielk1977            || pParse->iCacheLevel==iCacheLevel );
27892dcef11bSdrh       sqlite3VdbeResolveLabel(v, endLabel);
27906f34903eSdanielk1977       break;
27916f34903eSdanielk1977     }
27925338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_TRIGGER
27936f34903eSdanielk1977     case TK_RAISE: {
2794165921a7Sdan       assert( pExpr->affinity==OE_Rollback
2795165921a7Sdan            || pExpr->affinity==OE_Abort
2796165921a7Sdan            || pExpr->affinity==OE_Fail
2797165921a7Sdan            || pExpr->affinity==OE_Ignore
2798165921a7Sdan       );
2799e0af83acSdan       if( !pParse->pTriggerTab ){
2800e0af83acSdan         sqlite3ErrorMsg(pParse,
2801e0af83acSdan                        "RAISE() may only be used within a trigger-program");
2802e0af83acSdan         return 0;
2803e0af83acSdan       }
2804e0af83acSdan       if( pExpr->affinity==OE_Abort ){
2805e0af83acSdan         sqlite3MayAbort(pParse);
2806e0af83acSdan       }
280733e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
2808e0af83acSdan       if( pExpr->affinity==OE_Ignore ){
2809e0af83acSdan         sqlite3VdbeAddOp4(
2810e0af83acSdan             v, OP_Halt, SQLITE_OK, OE_Ignore, 0, pExpr->u.zToken,0);
2811e0af83acSdan       }else{
2812e0af83acSdan         sqlite3HaltConstraint(pParse, pExpr->affinity, pExpr->u.zToken, 0);
2813e0af83acSdan       }
2814e0af83acSdan 
2815ffe07b2dSdrh       break;
281617a7f8ddSdrh     }
28175338a5f7Sdanielk1977 #endif
2818ffe07b2dSdrh   }
28192dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
28202dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
28212dcef11bSdrh   return inReg;
28225b6afba9Sdrh }
28232dcef11bSdrh 
28242dcef11bSdrh /*
28252dcef11bSdrh ** Generate code to evaluate an expression and store the results
28262dcef11bSdrh ** into a register.  Return the register number where the results
28272dcef11bSdrh ** are stored.
28282dcef11bSdrh **
28292dcef11bSdrh ** If the register is a temporary register that can be deallocated,
2830678ccce8Sdrh ** then write its number into *pReg.  If the result register is not
28312dcef11bSdrh ** a temporary, then set *pReg to zero.
28322dcef11bSdrh */
28332dcef11bSdrh int sqlite3ExprCodeTemp(Parse *pParse, Expr *pExpr, int *pReg){
28342dcef11bSdrh   int r1 = sqlite3GetTempReg(pParse);
28352dcef11bSdrh   int r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
28362dcef11bSdrh   if( r2==r1 ){
28372dcef11bSdrh     *pReg = r1;
28382dcef11bSdrh   }else{
28392dcef11bSdrh     sqlite3ReleaseTempReg(pParse, r1);
28402dcef11bSdrh     *pReg = 0;
28412dcef11bSdrh   }
28422dcef11bSdrh   return r2;
28432dcef11bSdrh }
28442dcef11bSdrh 
28452dcef11bSdrh /*
28462dcef11bSdrh ** Generate code that will evaluate expression pExpr and store the
28472dcef11bSdrh ** results in register target.  The results are guaranteed to appear
28482dcef11bSdrh ** in register target.
28492dcef11bSdrh */
28502dcef11bSdrh int sqlite3ExprCode(Parse *pParse, Expr *pExpr, int target){
28519cbf3425Sdrh   int inReg;
28529cbf3425Sdrh 
28539cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
28549cbf3425Sdrh   inReg = sqlite3ExprCodeTarget(pParse, pExpr, target);
28550e359b30Sdrh   assert( pParse->pVdbe || pParse->db->mallocFailed );
28560e359b30Sdrh   if( inReg!=target && pParse->pVdbe ){
28579cbf3425Sdrh     sqlite3VdbeAddOp2(pParse->pVdbe, OP_SCopy, inReg, target);
285817a7f8ddSdrh   }
2859389a1adbSdrh   return target;
2860cce7d176Sdrh }
2861cce7d176Sdrh 
2862cce7d176Sdrh /*
28632dcef11bSdrh ** Generate code that evalutes the given expression and puts the result
2864de4fcfddSdrh ** in register target.
286525303780Sdrh **
28662dcef11bSdrh ** Also make a copy of the expression results into another "cache" register
28672dcef11bSdrh ** and modify the expression so that the next time it is evaluated,
28682dcef11bSdrh ** the result is a copy of the cache register.
28692dcef11bSdrh **
28702dcef11bSdrh ** This routine is used for expressions that are used multiple
28712dcef11bSdrh ** times.  They are evaluated once and the results of the expression
28722dcef11bSdrh ** are reused.
287325303780Sdrh */
28742dcef11bSdrh int sqlite3ExprCodeAndCache(Parse *pParse, Expr *pExpr, int target){
287525303780Sdrh   Vdbe *v = pParse->pVdbe;
28762dcef11bSdrh   int inReg;
28772dcef11bSdrh   inReg = sqlite3ExprCode(pParse, pExpr, target);
2878de4fcfddSdrh   assert( target>0 );
287920bc393cSdrh   /* This routine is called for terms to INSERT or UPDATE.  And the only
288020bc393cSdrh   ** other place where expressions can be converted into TK_REGISTER is
288120bc393cSdrh   ** in WHERE clause processing.  So as currently implemented, there is
288220bc393cSdrh   ** no way for a TK_REGISTER to exist here.  But it seems prudent to
288320bc393cSdrh   ** keep the ALWAYS() in case the conditions above change with future
288420bc393cSdrh   ** modifications or enhancements. */
288520bc393cSdrh   if( ALWAYS(pExpr->op!=TK_REGISTER) ){
288625303780Sdrh     int iMem;
28872dcef11bSdrh     iMem = ++pParse->nMem;
28882dcef11bSdrh     sqlite3VdbeAddOp2(v, OP_Copy, inReg, iMem);
28892dcef11bSdrh     pExpr->iTable = iMem;
2890937d0deaSdan     pExpr->op2 = pExpr->op;
289125303780Sdrh     pExpr->op = TK_REGISTER;
289225303780Sdrh   }
28932dcef11bSdrh   return inReg;
289425303780Sdrh }
28952dcef11bSdrh 
2896678ccce8Sdrh /*
289747de955eSdrh ** Return TRUE if pExpr is an constant expression that is appropriate
289847de955eSdrh ** for factoring out of a loop.  Appropriate expressions are:
289947de955eSdrh **
290047de955eSdrh **    *  Any expression that evaluates to two or more opcodes.
290147de955eSdrh **
290247de955eSdrh **    *  Any OP_Integer, OP_Real, OP_String, OP_Blob, OP_Null,
290347de955eSdrh **       or OP_Variable that does not need to be placed in a
290447de955eSdrh **       specific register.
290547de955eSdrh **
290647de955eSdrh ** There is no point in factoring out single-instruction constant
290747de955eSdrh ** expressions that need to be placed in a particular register.
290847de955eSdrh ** We could factor them out, but then we would end up adding an
290947de955eSdrh ** OP_SCopy instruction to move the value into the correct register
291047de955eSdrh ** later.  We might as well just use the original instruction and
291147de955eSdrh ** avoid the OP_SCopy.
291247de955eSdrh */
291347de955eSdrh static int isAppropriateForFactoring(Expr *p){
291447de955eSdrh   if( !sqlite3ExprIsConstantNotJoin(p) ){
291547de955eSdrh     return 0;  /* Only constant expressions are appropriate for factoring */
291647de955eSdrh   }
291747de955eSdrh   if( (p->flags & EP_FixedDest)==0 ){
291847de955eSdrh     return 1;  /* Any constant without a fixed destination is appropriate */
291947de955eSdrh   }
292047de955eSdrh   while( p->op==TK_UPLUS ) p = p->pLeft;
292147de955eSdrh   switch( p->op ){
292247de955eSdrh #ifndef SQLITE_OMIT_BLOB_LITERAL
292347de955eSdrh     case TK_BLOB:
292447de955eSdrh #endif
292547de955eSdrh     case TK_VARIABLE:
292647de955eSdrh     case TK_INTEGER:
292747de955eSdrh     case TK_FLOAT:
292847de955eSdrh     case TK_NULL:
292947de955eSdrh     case TK_STRING: {
293047de955eSdrh       testcase( p->op==TK_BLOB );
293147de955eSdrh       testcase( p->op==TK_VARIABLE );
293247de955eSdrh       testcase( p->op==TK_INTEGER );
293347de955eSdrh       testcase( p->op==TK_FLOAT );
293447de955eSdrh       testcase( p->op==TK_NULL );
293547de955eSdrh       testcase( p->op==TK_STRING );
293647de955eSdrh       /* Single-instruction constants with a fixed destination are
293747de955eSdrh       ** better done in-line.  If we factor them, they will just end
293847de955eSdrh       ** up generating an OP_SCopy to move the value to the destination
293947de955eSdrh       ** register. */
294047de955eSdrh       return 0;
294147de955eSdrh     }
294247de955eSdrh     case TK_UMINUS: {
294347de955eSdrh       if( p->pLeft->op==TK_FLOAT || p->pLeft->op==TK_INTEGER ){
294447de955eSdrh         return 0;
294547de955eSdrh       }
294647de955eSdrh       break;
294747de955eSdrh     }
294847de955eSdrh     default: {
294947de955eSdrh       break;
295047de955eSdrh     }
295147de955eSdrh   }
295247de955eSdrh   return 1;
295347de955eSdrh }
295447de955eSdrh 
295547de955eSdrh /*
295647de955eSdrh ** If pExpr is a constant expression that is appropriate for
295747de955eSdrh ** factoring out of a loop, then evaluate the expression
2958678ccce8Sdrh ** into a register and convert the expression into a TK_REGISTER
2959678ccce8Sdrh ** expression.
2960678ccce8Sdrh */
29617d10d5a6Sdrh static int evalConstExpr(Walker *pWalker, Expr *pExpr){
29627d10d5a6Sdrh   Parse *pParse = pWalker->pParse;
296347de955eSdrh   switch( pExpr->op ){
2964e05c929bSdrh     case TK_IN:
296547de955eSdrh     case TK_REGISTER: {
296633cd4909Sdrh       return WRC_Prune;
2967678ccce8Sdrh     }
296847de955eSdrh     case TK_FUNCTION:
296947de955eSdrh     case TK_AGG_FUNCTION:
297047de955eSdrh     case TK_CONST_FUNC: {
297147de955eSdrh       /* The arguments to a function have a fixed destination.
297247de955eSdrh       ** Mark them this way to avoid generated unneeded OP_SCopy
297347de955eSdrh       ** instructions.
297447de955eSdrh       */
29756ab3a2ecSdanielk1977       ExprList *pList = pExpr->x.pList;
29766ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
297747de955eSdrh       if( pList ){
297847de955eSdrh         int i = pList->nExpr;
297947de955eSdrh         struct ExprList_item *pItem = pList->a;
298047de955eSdrh         for(; i>0; i--, pItem++){
298133cd4909Sdrh           if( ALWAYS(pItem->pExpr) ) pItem->pExpr->flags |= EP_FixedDest;
298247de955eSdrh         }
298347de955eSdrh       }
298447de955eSdrh       break;
298547de955eSdrh     }
298647de955eSdrh   }
298747de955eSdrh   if( isAppropriateForFactoring(pExpr) ){
2988678ccce8Sdrh     int r1 = ++pParse->nMem;
2989678ccce8Sdrh     int r2;
2990678ccce8Sdrh     r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
299133cd4909Sdrh     if( NEVER(r1!=r2) ) sqlite3ReleaseTempReg(pParse, r1);
2992fcd4a150Sdan     pExpr->op2 = pExpr->op;
2993678ccce8Sdrh     pExpr->op = TK_REGISTER;
2994678ccce8Sdrh     pExpr->iTable = r2;
29957d10d5a6Sdrh     return WRC_Prune;
2996678ccce8Sdrh   }
29977d10d5a6Sdrh   return WRC_Continue;
2998678ccce8Sdrh }
2999678ccce8Sdrh 
3000678ccce8Sdrh /*
3001678ccce8Sdrh ** Preevaluate constant subexpressions within pExpr and store the
3002678ccce8Sdrh ** results in registers.  Modify pExpr so that the constant subexpresions
3003678ccce8Sdrh ** are TK_REGISTER opcodes that refer to the precomputed values.
3004678ccce8Sdrh */
3005678ccce8Sdrh void sqlite3ExprCodeConstants(Parse *pParse, Expr *pExpr){
30067d10d5a6Sdrh   Walker w;
30077d10d5a6Sdrh   w.xExprCallback = evalConstExpr;
30087d10d5a6Sdrh   w.xSelectCallback = 0;
30097d10d5a6Sdrh   w.pParse = pParse;
30107d10d5a6Sdrh   sqlite3WalkExpr(&w, pExpr);
3011678ccce8Sdrh }
3012678ccce8Sdrh 
301325303780Sdrh 
301425303780Sdrh /*
3015268380caSdrh ** Generate code that pushes the value of every element of the given
30169cbf3425Sdrh ** expression list into a sequence of registers beginning at target.
3017268380caSdrh **
3018892d3179Sdrh ** Return the number of elements evaluated.
3019268380caSdrh */
30204adee20fSdanielk1977 int sqlite3ExprCodeExprList(
3021268380caSdrh   Parse *pParse,     /* Parsing context */
3022389a1adbSdrh   ExprList *pList,   /* The expression list to be coded */
3023191b54cbSdrh   int target,        /* Where to write results */
3024d176611bSdrh   int doHardCopy     /* Make a hard copy of every element */
3025268380caSdrh ){
3026268380caSdrh   struct ExprList_item *pItem;
30279cbf3425Sdrh   int i, n;
30289d8b3072Sdrh   assert( pList!=0 );
30299cbf3425Sdrh   assert( target>0 );
3030268380caSdrh   n = pList->nExpr;
3031191b54cbSdrh   for(pItem=pList->a, i=0; i<n; i++, pItem++){
30328b213899Sdrh     if( pItem->iAlias ){
303331daa63fSdrh       int iReg = codeAlias(pParse, pItem->iAlias, pItem->pExpr, target+i);
30348b213899Sdrh       Vdbe *v = sqlite3GetVdbe(pParse);
303531daa63fSdrh       if( iReg!=target+i ){
30368b213899Sdrh         sqlite3VdbeAddOp2(v, OP_SCopy, iReg, target+i);
303731daa63fSdrh       }
3038d176611bSdrh     }else{
3039191b54cbSdrh       sqlite3ExprCode(pParse, pItem->pExpr, target+i);
30408b213899Sdrh     }
304120411ea7Sdrh     if( doHardCopy && !pParse->db->mallocFailed ){
3042d176611bSdrh       sqlite3ExprHardCopy(pParse, target, n);
3043d176611bSdrh     }
3044268380caSdrh   }
3045f9b596ebSdrh   return n;
3046268380caSdrh }
3047268380caSdrh 
3048268380caSdrh /*
304936c563a2Sdrh ** Generate code for a BETWEEN operator.
305036c563a2Sdrh **
305136c563a2Sdrh **    x BETWEEN y AND z
305236c563a2Sdrh **
305336c563a2Sdrh ** The above is equivalent to
305436c563a2Sdrh **
305536c563a2Sdrh **    x>=y AND x<=z
305636c563a2Sdrh **
305736c563a2Sdrh ** Code it as such, taking care to do the common subexpression
305836c563a2Sdrh ** elementation of x.
305936c563a2Sdrh */
306036c563a2Sdrh static void exprCodeBetween(
306136c563a2Sdrh   Parse *pParse,    /* Parsing and code generating context */
306236c563a2Sdrh   Expr *pExpr,      /* The BETWEEN expression */
306336c563a2Sdrh   int dest,         /* Jump here if the jump is taken */
306436c563a2Sdrh   int jumpIfTrue,   /* Take the jump if the BETWEEN is true */
306536c563a2Sdrh   int jumpIfNull    /* Take the jump if the BETWEEN is NULL */
306636c563a2Sdrh ){
306736c563a2Sdrh   Expr exprAnd;     /* The AND operator in  x>=y AND x<=z  */
306836c563a2Sdrh   Expr compLeft;    /* The  x>=y  term */
306936c563a2Sdrh   Expr compRight;   /* The  x<=z  term */
307036c563a2Sdrh   Expr exprX;       /* The  x  subexpression */
307136c563a2Sdrh   int regFree1 = 0; /* Temporary use register */
307236c563a2Sdrh 
307336c563a2Sdrh   assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
307436c563a2Sdrh   exprX = *pExpr->pLeft;
307536c563a2Sdrh   exprAnd.op = TK_AND;
307636c563a2Sdrh   exprAnd.pLeft = &compLeft;
307736c563a2Sdrh   exprAnd.pRight = &compRight;
307836c563a2Sdrh   compLeft.op = TK_GE;
307936c563a2Sdrh   compLeft.pLeft = &exprX;
308036c563a2Sdrh   compLeft.pRight = pExpr->x.pList->a[0].pExpr;
308136c563a2Sdrh   compRight.op = TK_LE;
308236c563a2Sdrh   compRight.pLeft = &exprX;
308336c563a2Sdrh   compRight.pRight = pExpr->x.pList->a[1].pExpr;
308436c563a2Sdrh   exprX.iTable = sqlite3ExprCodeTemp(pParse, &exprX, &regFree1);
308536c563a2Sdrh   exprX.op = TK_REGISTER;
308636c563a2Sdrh   if( jumpIfTrue ){
308736c563a2Sdrh     sqlite3ExprIfTrue(pParse, &exprAnd, dest, jumpIfNull);
308836c563a2Sdrh   }else{
308936c563a2Sdrh     sqlite3ExprIfFalse(pParse, &exprAnd, dest, jumpIfNull);
309036c563a2Sdrh   }
309136c563a2Sdrh   sqlite3ReleaseTempReg(pParse, regFree1);
309236c563a2Sdrh 
309336c563a2Sdrh   /* Ensure adequate test coverage */
309436c563a2Sdrh   testcase( jumpIfTrue==0 && jumpIfNull==0 && regFree1==0 );
309536c563a2Sdrh   testcase( jumpIfTrue==0 && jumpIfNull==0 && regFree1!=0 );
309636c563a2Sdrh   testcase( jumpIfTrue==0 && jumpIfNull!=0 && regFree1==0 );
309736c563a2Sdrh   testcase( jumpIfTrue==0 && jumpIfNull!=0 && regFree1!=0 );
309836c563a2Sdrh   testcase( jumpIfTrue!=0 && jumpIfNull==0 && regFree1==0 );
309936c563a2Sdrh   testcase( jumpIfTrue!=0 && jumpIfNull==0 && regFree1!=0 );
310036c563a2Sdrh   testcase( jumpIfTrue!=0 && jumpIfNull!=0 && regFree1==0 );
310136c563a2Sdrh   testcase( jumpIfTrue!=0 && jumpIfNull!=0 && regFree1!=0 );
310236c563a2Sdrh }
310336c563a2Sdrh 
310436c563a2Sdrh /*
3105cce7d176Sdrh ** Generate code for a boolean expression such that a jump is made
3106cce7d176Sdrh ** to the label "dest" if the expression is true but execution
3107cce7d176Sdrh ** continues straight thru if the expression is false.
3108f5905aa7Sdrh **
3109f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false), then
311035573356Sdrh ** take the jump if the jumpIfNull flag is SQLITE_JUMPIFNULL.
3111f2bc013cSdrh **
3112f2bc013cSdrh ** This code depends on the fact that certain token values (ex: TK_EQ)
3113f2bc013cSdrh ** are the same as opcode values (ex: OP_Eq) that implement the corresponding
3114f2bc013cSdrh ** operation.  Special comments in vdbe.c and the mkopcodeh.awk script in
3115f2bc013cSdrh ** the make process cause these values to align.  Assert()s in the code
3116f2bc013cSdrh ** below verify that the numbers are aligned correctly.
3117cce7d176Sdrh */
31184adee20fSdanielk1977 void sqlite3ExprIfTrue(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
3119cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
3120cce7d176Sdrh   int op = 0;
31212dcef11bSdrh   int regFree1 = 0;
31222dcef11bSdrh   int regFree2 = 0;
31232dcef11bSdrh   int r1, r2;
31242dcef11bSdrh 
312535573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
312633cd4909Sdrh   if( NEVER(v==0) )     return;  /* Existance of VDBE checked by caller */
312733cd4909Sdrh   if( NEVER(pExpr==0) ) return;  /* No way this can happen */
3128f2bc013cSdrh   op = pExpr->op;
3129f2bc013cSdrh   switch( op ){
3130cce7d176Sdrh     case TK_AND: {
31314adee20fSdanielk1977       int d2 = sqlite3VdbeMakeLabel(v);
3132c5499befSdrh       testcase( jumpIfNull==0 );
3133ceea3321Sdrh       sqlite3ExprCachePush(pParse);
313435573356Sdrh       sqlite3ExprIfFalse(pParse, pExpr->pLeft, d2,jumpIfNull^SQLITE_JUMPIFNULL);
31354adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
31364adee20fSdanielk1977       sqlite3VdbeResolveLabel(v, d2);
3137ceea3321Sdrh       sqlite3ExprCachePop(pParse, 1);
3138cce7d176Sdrh       break;
3139cce7d176Sdrh     }
3140cce7d176Sdrh     case TK_OR: {
3141c5499befSdrh       testcase( jumpIfNull==0 );
31424adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
31434adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
3144cce7d176Sdrh       break;
3145cce7d176Sdrh     }
3146cce7d176Sdrh     case TK_NOT: {
3147c5499befSdrh       testcase( jumpIfNull==0 );
31484adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
3149cce7d176Sdrh       break;
3150cce7d176Sdrh     }
3151cce7d176Sdrh     case TK_LT:
3152cce7d176Sdrh     case TK_LE:
3153cce7d176Sdrh     case TK_GT:
3154cce7d176Sdrh     case TK_GE:
3155cce7d176Sdrh     case TK_NE:
31560ac65892Sdrh     case TK_EQ: {
3157f2bc013cSdrh       assert( TK_LT==OP_Lt );
3158f2bc013cSdrh       assert( TK_LE==OP_Le );
3159f2bc013cSdrh       assert( TK_GT==OP_Gt );
3160f2bc013cSdrh       assert( TK_GE==OP_Ge );
3161f2bc013cSdrh       assert( TK_EQ==OP_Eq );
3162f2bc013cSdrh       assert( TK_NE==OP_Ne );
3163c5499befSdrh       testcase( op==TK_LT );
3164c5499befSdrh       testcase( op==TK_LE );
3165c5499befSdrh       testcase( op==TK_GT );
3166c5499befSdrh       testcase( op==TK_GE );
3167c5499befSdrh       testcase( op==TK_EQ );
3168c5499befSdrh       testcase( op==TK_NE );
3169c5499befSdrh       testcase( jumpIfNull==0 );
3170da250ea5Sdrh       codeCompareOperands(pParse, pExpr->pLeft, &r1, &regFree1,
3171da250ea5Sdrh                                   pExpr->pRight, &r2, &regFree2);
317235573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
31732dcef11bSdrh                   r1, r2, dest, jumpIfNull);
3174c5499befSdrh       testcase( regFree1==0 );
3175c5499befSdrh       testcase( regFree2==0 );
3176cce7d176Sdrh       break;
3177cce7d176Sdrh     }
31786a2fe093Sdrh     case TK_IS:
31796a2fe093Sdrh     case TK_ISNOT: {
31806a2fe093Sdrh       testcase( op==TK_IS );
31816a2fe093Sdrh       testcase( op==TK_ISNOT );
31826a2fe093Sdrh       codeCompareOperands(pParse, pExpr->pLeft, &r1, &regFree1,
31836a2fe093Sdrh                                   pExpr->pRight, &r2, &regFree2);
31846a2fe093Sdrh       op = (op==TK_IS) ? TK_EQ : TK_NE;
31856a2fe093Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
31866a2fe093Sdrh                   r1, r2, dest, SQLITE_NULLEQ);
31876a2fe093Sdrh       testcase( regFree1==0 );
31886a2fe093Sdrh       testcase( regFree2==0 );
31896a2fe093Sdrh       break;
31906a2fe093Sdrh     }
3191cce7d176Sdrh     case TK_ISNULL:
3192cce7d176Sdrh     case TK_NOTNULL: {
3193f2bc013cSdrh       assert( TK_ISNULL==OP_IsNull );
3194f2bc013cSdrh       assert( TK_NOTNULL==OP_NotNull );
3195c5499befSdrh       testcase( op==TK_ISNULL );
3196c5499befSdrh       testcase( op==TK_NOTNULL );
31972dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
31982dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
3199c5499befSdrh       testcase( regFree1==0 );
3200cce7d176Sdrh       break;
3201cce7d176Sdrh     }
3202fef5208cSdrh     case TK_BETWEEN: {
320336c563a2Sdrh       exprCodeBetween(pParse, pExpr, dest, 1, jumpIfNull);
3204fef5208cSdrh       break;
3205fef5208cSdrh     }
3206*e3365e6cSdrh     case TK_IN: {
3207*e3365e6cSdrh       int destIfFalse = sqlite3VdbeMakeLabel(v);
3208*e3365e6cSdrh       int destIfNull = jumpIfNull ? dest : destIfFalse;
3209*e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
3210*e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_Goto, 0, dest);
3211*e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
3212*e3365e6cSdrh       break;
3213*e3365e6cSdrh     }
3214cce7d176Sdrh     default: {
32152dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
32162dcef11bSdrh       sqlite3VdbeAddOp3(v, OP_If, r1, dest, jumpIfNull!=0);
3217c5499befSdrh       testcase( regFree1==0 );
3218c5499befSdrh       testcase( jumpIfNull==0 );
3219cce7d176Sdrh       break;
3220cce7d176Sdrh     }
3221cce7d176Sdrh   }
32222dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
32232dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
3224cce7d176Sdrh }
3225cce7d176Sdrh 
3226cce7d176Sdrh /*
322766b89c8fSdrh ** Generate code for a boolean expression such that a jump is made
3228cce7d176Sdrh ** to the label "dest" if the expression is false but execution
3229cce7d176Sdrh ** continues straight thru if the expression is true.
3230f5905aa7Sdrh **
3231f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false) then
323235573356Sdrh ** jump if jumpIfNull is SQLITE_JUMPIFNULL or fall through if jumpIfNull
323335573356Sdrh ** is 0.
3234cce7d176Sdrh */
32354adee20fSdanielk1977 void sqlite3ExprIfFalse(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
3236cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
3237cce7d176Sdrh   int op = 0;
32382dcef11bSdrh   int regFree1 = 0;
32392dcef11bSdrh   int regFree2 = 0;
32402dcef11bSdrh   int r1, r2;
32412dcef11bSdrh 
324235573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
324333cd4909Sdrh   if( NEVER(v==0) ) return; /* Existance of VDBE checked by caller */
324433cd4909Sdrh   if( pExpr==0 )    return;
3245f2bc013cSdrh 
3246f2bc013cSdrh   /* The value of pExpr->op and op are related as follows:
3247f2bc013cSdrh   **
3248f2bc013cSdrh   **       pExpr->op            op
3249f2bc013cSdrh   **       ---------          ----------
3250f2bc013cSdrh   **       TK_ISNULL          OP_NotNull
3251f2bc013cSdrh   **       TK_NOTNULL         OP_IsNull
3252f2bc013cSdrh   **       TK_NE              OP_Eq
3253f2bc013cSdrh   **       TK_EQ              OP_Ne
3254f2bc013cSdrh   **       TK_GT              OP_Le
3255f2bc013cSdrh   **       TK_LE              OP_Gt
3256f2bc013cSdrh   **       TK_GE              OP_Lt
3257f2bc013cSdrh   **       TK_LT              OP_Ge
3258f2bc013cSdrh   **
3259f2bc013cSdrh   ** For other values of pExpr->op, op is undefined and unused.
3260f2bc013cSdrh   ** The value of TK_ and OP_ constants are arranged such that we
3261f2bc013cSdrh   ** can compute the mapping above using the following expression.
3262f2bc013cSdrh   ** Assert()s verify that the computation is correct.
3263f2bc013cSdrh   */
3264f2bc013cSdrh   op = ((pExpr->op+(TK_ISNULL&1))^1)-(TK_ISNULL&1);
3265f2bc013cSdrh 
3266f2bc013cSdrh   /* Verify correct alignment of TK_ and OP_ constants
3267f2bc013cSdrh   */
3268f2bc013cSdrh   assert( pExpr->op!=TK_ISNULL || op==OP_NotNull );
3269f2bc013cSdrh   assert( pExpr->op!=TK_NOTNULL || op==OP_IsNull );
3270f2bc013cSdrh   assert( pExpr->op!=TK_NE || op==OP_Eq );
3271f2bc013cSdrh   assert( pExpr->op!=TK_EQ || op==OP_Ne );
3272f2bc013cSdrh   assert( pExpr->op!=TK_LT || op==OP_Ge );
3273f2bc013cSdrh   assert( pExpr->op!=TK_LE || op==OP_Gt );
3274f2bc013cSdrh   assert( pExpr->op!=TK_GT || op==OP_Le );
3275f2bc013cSdrh   assert( pExpr->op!=TK_GE || op==OP_Lt );
3276f2bc013cSdrh 
3277cce7d176Sdrh   switch( pExpr->op ){
3278cce7d176Sdrh     case TK_AND: {
3279c5499befSdrh       testcase( jumpIfNull==0 );
32804adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
32814adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
3282cce7d176Sdrh       break;
3283cce7d176Sdrh     }
3284cce7d176Sdrh     case TK_OR: {
32854adee20fSdanielk1977       int d2 = sqlite3VdbeMakeLabel(v);
3286c5499befSdrh       testcase( jumpIfNull==0 );
3287ceea3321Sdrh       sqlite3ExprCachePush(pParse);
328835573356Sdrh       sqlite3ExprIfTrue(pParse, pExpr->pLeft, d2, jumpIfNull^SQLITE_JUMPIFNULL);
32894adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
32904adee20fSdanielk1977       sqlite3VdbeResolveLabel(v, d2);
3291ceea3321Sdrh       sqlite3ExprCachePop(pParse, 1);
3292cce7d176Sdrh       break;
3293cce7d176Sdrh     }
3294cce7d176Sdrh     case TK_NOT: {
32954adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
3296cce7d176Sdrh       break;
3297cce7d176Sdrh     }
3298cce7d176Sdrh     case TK_LT:
3299cce7d176Sdrh     case TK_LE:
3300cce7d176Sdrh     case TK_GT:
3301cce7d176Sdrh     case TK_GE:
3302cce7d176Sdrh     case TK_NE:
3303cce7d176Sdrh     case TK_EQ: {
3304c5499befSdrh       testcase( op==TK_LT );
3305c5499befSdrh       testcase( op==TK_LE );
3306c5499befSdrh       testcase( op==TK_GT );
3307c5499befSdrh       testcase( op==TK_GE );
3308c5499befSdrh       testcase( op==TK_EQ );
3309c5499befSdrh       testcase( op==TK_NE );
3310c5499befSdrh       testcase( jumpIfNull==0 );
3311da250ea5Sdrh       codeCompareOperands(pParse, pExpr->pLeft, &r1, &regFree1,
3312da250ea5Sdrh                                   pExpr->pRight, &r2, &regFree2);
331335573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
33142dcef11bSdrh                   r1, r2, dest, jumpIfNull);
3315c5499befSdrh       testcase( regFree1==0 );
3316c5499befSdrh       testcase( regFree2==0 );
3317cce7d176Sdrh       break;
3318cce7d176Sdrh     }
33196a2fe093Sdrh     case TK_IS:
33206a2fe093Sdrh     case TK_ISNOT: {
33216d4486aeSdrh       testcase( pExpr->op==TK_IS );
33226d4486aeSdrh       testcase( pExpr->op==TK_ISNOT );
33236a2fe093Sdrh       codeCompareOperands(pParse, pExpr->pLeft, &r1, &regFree1,
33246a2fe093Sdrh                                   pExpr->pRight, &r2, &regFree2);
33256a2fe093Sdrh       op = (pExpr->op==TK_IS) ? TK_NE : TK_EQ;
33266a2fe093Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
33276a2fe093Sdrh                   r1, r2, dest, SQLITE_NULLEQ);
33286a2fe093Sdrh       testcase( regFree1==0 );
33296a2fe093Sdrh       testcase( regFree2==0 );
33306a2fe093Sdrh       break;
33316a2fe093Sdrh     }
3332cce7d176Sdrh     case TK_ISNULL:
3333cce7d176Sdrh     case TK_NOTNULL: {
3334c5499befSdrh       testcase( op==TK_ISNULL );
3335c5499befSdrh       testcase( op==TK_NOTNULL );
33362dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
33372dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
3338c5499befSdrh       testcase( regFree1==0 );
3339cce7d176Sdrh       break;
3340cce7d176Sdrh     }
3341fef5208cSdrh     case TK_BETWEEN: {
334236c563a2Sdrh       exprCodeBetween(pParse, pExpr, dest, 0, jumpIfNull);
3343fef5208cSdrh       break;
3344fef5208cSdrh     }
3345*e3365e6cSdrh     case TK_IN: {
3346*e3365e6cSdrh       if( jumpIfNull ){
3347*e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, dest);
3348*e3365e6cSdrh       }else{
3349*e3365e6cSdrh         int destIfNull = sqlite3VdbeMakeLabel(v);
3350*e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, destIfNull);
3351*e3365e6cSdrh         sqlite3VdbeResolveLabel(v, destIfNull);
3352*e3365e6cSdrh       }
3353*e3365e6cSdrh       break;
3354*e3365e6cSdrh     }
3355cce7d176Sdrh     default: {
33562dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
33572dcef11bSdrh       sqlite3VdbeAddOp3(v, OP_IfNot, r1, dest, jumpIfNull!=0);
3358c5499befSdrh       testcase( regFree1==0 );
3359c5499befSdrh       testcase( jumpIfNull==0 );
3360cce7d176Sdrh       break;
3361cce7d176Sdrh     }
3362cce7d176Sdrh   }
33632dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
33642dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
3365cce7d176Sdrh }
33662282792aSdrh 
33672282792aSdrh /*
33682282792aSdrh ** Do a deep comparison of two expression trees.  Return TRUE (non-zero)
33692282792aSdrh ** if they are identical and return FALSE if they differ in any way.
3370d40aab0eSdrh **
3371d40aab0eSdrh ** Sometimes this routine will return FALSE even if the two expressions
3372d40aab0eSdrh ** really are equivalent.  If we cannot prove that the expressions are
3373d40aab0eSdrh ** identical, we return FALSE just to be safe.  So if this routine
3374d40aab0eSdrh ** returns false, then you do not really know for certain if the two
3375d40aab0eSdrh ** expressions are the same.  But if you get a TRUE return, then you
3376d40aab0eSdrh ** can be sure the expressions are the same.  In the places where
3377d40aab0eSdrh ** this routine is used, it does not hurt to get an extra FALSE - that
3378d40aab0eSdrh ** just might result in some slightly slower code.  But returning
3379d40aab0eSdrh ** an incorrect TRUE could lead to a malfunction.
33802282792aSdrh */
33814adee20fSdanielk1977 int sqlite3ExprCompare(Expr *pA, Expr *pB){
33822282792aSdrh   int i;
33834b202ae2Sdanielk1977   if( pA==0||pB==0 ){
33844b202ae2Sdanielk1977     return pB==pA;
33852282792aSdrh   }
338633e619fcSdrh   assert( !ExprHasAnyProperty(pA, EP_TokenOnly|EP_Reduced) );
338733e619fcSdrh   assert( !ExprHasAnyProperty(pB, EP_TokenOnly|EP_Reduced) );
33886ab3a2ecSdanielk1977   if( ExprHasProperty(pA, EP_xIsSelect) || ExprHasProperty(pB, EP_xIsSelect) ){
33896ab3a2ecSdanielk1977     return 0;
33906ab3a2ecSdanielk1977   }
3391fd357974Sdrh   if( (pA->flags & EP_Distinct)!=(pB->flags & EP_Distinct) ) return 0;
33926ab3a2ecSdanielk1977   if( pA->op!=pB->op ) return 0;
33934adee20fSdanielk1977   if( !sqlite3ExprCompare(pA->pLeft, pB->pLeft) ) return 0;
33944adee20fSdanielk1977   if( !sqlite3ExprCompare(pA->pRight, pB->pRight) ) return 0;
33956ab3a2ecSdanielk1977 
33966ab3a2ecSdanielk1977   if( pA->x.pList && pB->x.pList ){
33976ab3a2ecSdanielk1977     if( pA->x.pList->nExpr!=pB->x.pList->nExpr ) return 0;
33986ab3a2ecSdanielk1977     for(i=0; i<pA->x.pList->nExpr; i++){
33996ab3a2ecSdanielk1977       Expr *pExprA = pA->x.pList->a[i].pExpr;
34006ab3a2ecSdanielk1977       Expr *pExprB = pB->x.pList->a[i].pExpr;
34016ab3a2ecSdanielk1977       if( !sqlite3ExprCompare(pExprA, pExprB) ) return 0;
34026ab3a2ecSdanielk1977     }
34036ab3a2ecSdanielk1977   }else if( pA->x.pList || pB->x.pList ){
34042282792aSdrh     return 0;
34052282792aSdrh   }
34066ab3a2ecSdanielk1977 
34072f2c01e5Sdrh   if( pA->iTable!=pB->iTable || pA->iColumn!=pB->iColumn ) return 0;
340833e619fcSdrh   if( ExprHasProperty(pA, EP_IntValue) ){
340933e619fcSdrh     if( !ExprHasProperty(pB, EP_IntValue) || pA->u.iValue!=pB->u.iValue ){
341033e619fcSdrh       return 0;
341133e619fcSdrh     }
341233e619fcSdrh   }else if( pA->op!=TK_COLUMN && pA->u.zToken ){
341320bc393cSdrh     if( ExprHasProperty(pB, EP_IntValue) || NEVER(pB->u.zToken==0) ) return 0;
341433e619fcSdrh     if( sqlite3StrICmp(pA->u.zToken,pB->u.zToken)!=0 ){
34152646da7eSdrh       return 0;
34162646da7eSdrh     }
34172282792aSdrh   }
34182282792aSdrh   return 1;
34192282792aSdrh }
34202282792aSdrh 
342113449892Sdrh 
34222282792aSdrh /*
342313449892Sdrh ** Add a new element to the pAggInfo->aCol[] array.  Return the index of
342413449892Sdrh ** the new element.  Return a negative number if malloc fails.
34252282792aSdrh */
342617435752Sdrh static int addAggInfoColumn(sqlite3 *db, AggInfo *pInfo){
342713449892Sdrh   int i;
3428cf643729Sdrh   pInfo->aCol = sqlite3ArrayAllocate(
342917435752Sdrh        db,
3430cf643729Sdrh        pInfo->aCol,
3431cf643729Sdrh        sizeof(pInfo->aCol[0]),
3432cf643729Sdrh        3,
3433cf643729Sdrh        &pInfo->nColumn,
3434cf643729Sdrh        &pInfo->nColumnAlloc,
3435cf643729Sdrh        &i
3436cf643729Sdrh   );
343713449892Sdrh   return i;
34382282792aSdrh }
343913449892Sdrh 
344013449892Sdrh /*
344113449892Sdrh ** Add a new element to the pAggInfo->aFunc[] array.  Return the index of
344213449892Sdrh ** the new element.  Return a negative number if malloc fails.
344313449892Sdrh */
344417435752Sdrh static int addAggInfoFunc(sqlite3 *db, AggInfo *pInfo){
344513449892Sdrh   int i;
3446cf643729Sdrh   pInfo->aFunc = sqlite3ArrayAllocate(
344717435752Sdrh        db,
3448cf643729Sdrh        pInfo->aFunc,
3449cf643729Sdrh        sizeof(pInfo->aFunc[0]),
3450cf643729Sdrh        3,
3451cf643729Sdrh        &pInfo->nFunc,
3452cf643729Sdrh        &pInfo->nFuncAlloc,
3453cf643729Sdrh        &i
3454cf643729Sdrh   );
345513449892Sdrh   return i;
34562282792aSdrh }
34572282792aSdrh 
34582282792aSdrh /*
34597d10d5a6Sdrh ** This is the xExprCallback for a tree walker.  It is used to
34607d10d5a6Sdrh ** implement sqlite3ExprAnalyzeAggregates().  See sqlite3ExprAnalyzeAggregates
3461626a879aSdrh ** for additional information.
34622282792aSdrh */
34637d10d5a6Sdrh static int analyzeAggregate(Walker *pWalker, Expr *pExpr){
34642282792aSdrh   int i;
34657d10d5a6Sdrh   NameContext *pNC = pWalker->u.pNC;
3466a58fdfb1Sdanielk1977   Parse *pParse = pNC->pParse;
3467a58fdfb1Sdanielk1977   SrcList *pSrcList = pNC->pSrcList;
346813449892Sdrh   AggInfo *pAggInfo = pNC->pAggInfo;
346913449892Sdrh 
34702282792aSdrh   switch( pExpr->op ){
347189c69d00Sdrh     case TK_AGG_COLUMN:
3472967e8b73Sdrh     case TK_COLUMN: {
34738b213899Sdrh       testcase( pExpr->op==TK_AGG_COLUMN );
34748b213899Sdrh       testcase( pExpr->op==TK_COLUMN );
347513449892Sdrh       /* Check to see if the column is in one of the tables in the FROM
347613449892Sdrh       ** clause of the aggregate query */
347720bc393cSdrh       if( ALWAYS(pSrcList!=0) ){
347813449892Sdrh         struct SrcList_item *pItem = pSrcList->a;
347913449892Sdrh         for(i=0; i<pSrcList->nSrc; i++, pItem++){
348013449892Sdrh           struct AggInfo_col *pCol;
348133e619fcSdrh           assert( !ExprHasAnyProperty(pExpr, EP_TokenOnly|EP_Reduced) );
348213449892Sdrh           if( pExpr->iTable==pItem->iCursor ){
348313449892Sdrh             /* If we reach this point, it means that pExpr refers to a table
348413449892Sdrh             ** that is in the FROM clause of the aggregate query.
348513449892Sdrh             **
348613449892Sdrh             ** Make an entry for the column in pAggInfo->aCol[] if there
348713449892Sdrh             ** is not an entry there already.
348813449892Sdrh             */
34897f906d63Sdrh             int k;
349013449892Sdrh             pCol = pAggInfo->aCol;
34917f906d63Sdrh             for(k=0; k<pAggInfo->nColumn; k++, pCol++){
349213449892Sdrh               if( pCol->iTable==pExpr->iTable &&
349313449892Sdrh                   pCol->iColumn==pExpr->iColumn ){
34942282792aSdrh                 break;
34952282792aSdrh               }
34962282792aSdrh             }
34971e536953Sdanielk1977             if( (k>=pAggInfo->nColumn)
34981e536953Sdanielk1977              && (k = addAggInfoColumn(pParse->db, pAggInfo))>=0
34991e536953Sdanielk1977             ){
35007f906d63Sdrh               pCol = &pAggInfo->aCol[k];
35010817d0dfSdanielk1977               pCol->pTab = pExpr->pTab;
350213449892Sdrh               pCol->iTable = pExpr->iTable;
350313449892Sdrh               pCol->iColumn = pExpr->iColumn;
35040a07c107Sdrh               pCol->iMem = ++pParse->nMem;
350513449892Sdrh               pCol->iSorterColumn = -1;
35065774b806Sdrh               pCol->pExpr = pExpr;
350713449892Sdrh               if( pAggInfo->pGroupBy ){
350813449892Sdrh                 int j, n;
350913449892Sdrh                 ExprList *pGB = pAggInfo->pGroupBy;
351013449892Sdrh                 struct ExprList_item *pTerm = pGB->a;
351113449892Sdrh                 n = pGB->nExpr;
351213449892Sdrh                 for(j=0; j<n; j++, pTerm++){
351313449892Sdrh                   Expr *pE = pTerm->pExpr;
351413449892Sdrh                   if( pE->op==TK_COLUMN && pE->iTable==pExpr->iTable &&
351513449892Sdrh                       pE->iColumn==pExpr->iColumn ){
351613449892Sdrh                     pCol->iSorterColumn = j;
351713449892Sdrh                     break;
35182282792aSdrh                   }
351913449892Sdrh                 }
352013449892Sdrh               }
352113449892Sdrh               if( pCol->iSorterColumn<0 ){
352213449892Sdrh                 pCol->iSorterColumn = pAggInfo->nSortingColumn++;
352313449892Sdrh               }
352413449892Sdrh             }
352513449892Sdrh             /* There is now an entry for pExpr in pAggInfo->aCol[] (either
352613449892Sdrh             ** because it was there before or because we just created it).
352713449892Sdrh             ** Convert the pExpr to be a TK_AGG_COLUMN referring to that
352813449892Sdrh             ** pAggInfo->aCol[] entry.
352913449892Sdrh             */
353033e619fcSdrh             ExprSetIrreducible(pExpr);
353113449892Sdrh             pExpr->pAggInfo = pAggInfo;
353213449892Sdrh             pExpr->op = TK_AGG_COLUMN;
3533cf697396Sshane             pExpr->iAgg = (i16)k;
353413449892Sdrh             break;
353513449892Sdrh           } /* endif pExpr->iTable==pItem->iCursor */
353613449892Sdrh         } /* end loop over pSrcList */
3537a58fdfb1Sdanielk1977       }
35387d10d5a6Sdrh       return WRC_Prune;
35392282792aSdrh     }
35402282792aSdrh     case TK_AGG_FUNCTION: {
354113449892Sdrh       /* The pNC->nDepth==0 test causes aggregate functions in subqueries
354213449892Sdrh       ** to be ignored */
3543a58fdfb1Sdanielk1977       if( pNC->nDepth==0 ){
354413449892Sdrh         /* Check to see if pExpr is a duplicate of another aggregate
354513449892Sdrh         ** function that is already in the pAggInfo structure
354613449892Sdrh         */
354713449892Sdrh         struct AggInfo_func *pItem = pAggInfo->aFunc;
354813449892Sdrh         for(i=0; i<pAggInfo->nFunc; i++, pItem++){
354913449892Sdrh           if( sqlite3ExprCompare(pItem->pExpr, pExpr) ){
35502282792aSdrh             break;
35512282792aSdrh           }
35522282792aSdrh         }
355313449892Sdrh         if( i>=pAggInfo->nFunc ){
355413449892Sdrh           /* pExpr is original.  Make a new entry in pAggInfo->aFunc[]
355513449892Sdrh           */
355614db2665Sdanielk1977           u8 enc = ENC(pParse->db);
35571e536953Sdanielk1977           i = addAggInfoFunc(pParse->db, pAggInfo);
355813449892Sdrh           if( i>=0 ){
35596ab3a2ecSdanielk1977             assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
356013449892Sdrh             pItem = &pAggInfo->aFunc[i];
356113449892Sdrh             pItem->pExpr = pExpr;
35620a07c107Sdrh             pItem->iMem = ++pParse->nMem;
356333e619fcSdrh             assert( !ExprHasProperty(pExpr, EP_IntValue) );
356413449892Sdrh             pItem->pFunc = sqlite3FindFunction(pParse->db,
356533e619fcSdrh                    pExpr->u.zToken, sqlite3Strlen30(pExpr->u.zToken),
35666ab3a2ecSdanielk1977                    pExpr->x.pList ? pExpr->x.pList->nExpr : 0, enc, 0);
3567fd357974Sdrh             if( pExpr->flags & EP_Distinct ){
3568fd357974Sdrh               pItem->iDistinct = pParse->nTab++;
3569fd357974Sdrh             }else{
3570fd357974Sdrh               pItem->iDistinct = -1;
3571fd357974Sdrh             }
35722282792aSdrh           }
357313449892Sdrh         }
357413449892Sdrh         /* Make pExpr point to the appropriate pAggInfo->aFunc[] entry
357513449892Sdrh         */
357633e619fcSdrh         assert( !ExprHasAnyProperty(pExpr, EP_TokenOnly|EP_Reduced) );
357733e619fcSdrh         ExprSetIrreducible(pExpr);
3578cf697396Sshane         pExpr->iAgg = (i16)i;
357913449892Sdrh         pExpr->pAggInfo = pAggInfo;
35807d10d5a6Sdrh         return WRC_Prune;
35812282792aSdrh       }
35822282792aSdrh     }
3583a58fdfb1Sdanielk1977   }
35847d10d5a6Sdrh   return WRC_Continue;
35857d10d5a6Sdrh }
35867d10d5a6Sdrh static int analyzeAggregatesInSelect(Walker *pWalker, Select *pSelect){
35877d10d5a6Sdrh   NameContext *pNC = pWalker->u.pNC;
35887d10d5a6Sdrh   if( pNC->nDepth==0 ){
3589a58fdfb1Sdanielk1977     pNC->nDepth++;
35907d10d5a6Sdrh     sqlite3WalkSelect(pWalker, pSelect);
3591a58fdfb1Sdanielk1977     pNC->nDepth--;
35927d10d5a6Sdrh     return WRC_Prune;
35937d10d5a6Sdrh   }else{
35947d10d5a6Sdrh     return WRC_Continue;
3595a58fdfb1Sdanielk1977   }
35962282792aSdrh }
3597626a879aSdrh 
3598626a879aSdrh /*
3599626a879aSdrh ** Analyze the given expression looking for aggregate functions and
3600626a879aSdrh ** for variables that need to be added to the pParse->aAgg[] array.
3601626a879aSdrh ** Make additional entries to the pParse->aAgg[] array as necessary.
3602626a879aSdrh **
3603626a879aSdrh ** This routine should only be called after the expression has been
36047d10d5a6Sdrh ** analyzed by sqlite3ResolveExprNames().
3605626a879aSdrh */
3606d2b3e23bSdrh void sqlite3ExprAnalyzeAggregates(NameContext *pNC, Expr *pExpr){
36077d10d5a6Sdrh   Walker w;
36087d10d5a6Sdrh   w.xExprCallback = analyzeAggregate;
36097d10d5a6Sdrh   w.xSelectCallback = analyzeAggregatesInSelect;
36107d10d5a6Sdrh   w.u.pNC = pNC;
361120bc393cSdrh   assert( pNC->pSrcList!=0 );
36127d10d5a6Sdrh   sqlite3WalkExpr(&w, pExpr);
36132282792aSdrh }
36145d9a4af9Sdrh 
36155d9a4af9Sdrh /*
36165d9a4af9Sdrh ** Call sqlite3ExprAnalyzeAggregates() for every expression in an
36175d9a4af9Sdrh ** expression list.  Return the number of errors.
36185d9a4af9Sdrh **
36195d9a4af9Sdrh ** If an error is found, the analysis is cut short.
36205d9a4af9Sdrh */
3621d2b3e23bSdrh void sqlite3ExprAnalyzeAggList(NameContext *pNC, ExprList *pList){
36225d9a4af9Sdrh   struct ExprList_item *pItem;
36235d9a4af9Sdrh   int i;
36245d9a4af9Sdrh   if( pList ){
3625d2b3e23bSdrh     for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
3626d2b3e23bSdrh       sqlite3ExprAnalyzeAggregates(pNC, pItem->pExpr);
36275d9a4af9Sdrh     }
36285d9a4af9Sdrh   }
36295d9a4af9Sdrh }
3630892d3179Sdrh 
3631892d3179Sdrh /*
3632ceea3321Sdrh ** Allocate a single new register for use to hold some intermediate result.
3633892d3179Sdrh */
3634892d3179Sdrh int sqlite3GetTempReg(Parse *pParse){
3635e55cbd72Sdrh   if( pParse->nTempReg==0 ){
3636892d3179Sdrh     return ++pParse->nMem;
3637892d3179Sdrh   }
36382f425f6bSdanielk1977   return pParse->aTempReg[--pParse->nTempReg];
3639892d3179Sdrh }
3640ceea3321Sdrh 
3641ceea3321Sdrh /*
3642ceea3321Sdrh ** Deallocate a register, making available for reuse for some other
3643ceea3321Sdrh ** purpose.
3644ceea3321Sdrh **
3645ceea3321Sdrh ** If a register is currently being used by the column cache, then
3646ceea3321Sdrh ** the dallocation is deferred until the column cache line that uses
3647ceea3321Sdrh ** the register becomes stale.
3648ceea3321Sdrh */
3649892d3179Sdrh void sqlite3ReleaseTempReg(Parse *pParse, int iReg){
36502dcef11bSdrh   if( iReg && pParse->nTempReg<ArraySize(pParse->aTempReg) ){
3651ceea3321Sdrh     int i;
3652ceea3321Sdrh     struct yColCache *p;
3653ceea3321Sdrh     for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
3654ceea3321Sdrh       if( p->iReg==iReg ){
3655ceea3321Sdrh         p->tempReg = 1;
3656ceea3321Sdrh         return;
3657ceea3321Sdrh       }
3658ceea3321Sdrh     }
3659892d3179Sdrh     pParse->aTempReg[pParse->nTempReg++] = iReg;
3660892d3179Sdrh   }
3661892d3179Sdrh }
3662892d3179Sdrh 
3663892d3179Sdrh /*
3664892d3179Sdrh ** Allocate or deallocate a block of nReg consecutive registers
3665892d3179Sdrh */
3666892d3179Sdrh int sqlite3GetTempRange(Parse *pParse, int nReg){
3667e55cbd72Sdrh   int i, n;
3668892d3179Sdrh   i = pParse->iRangeReg;
3669e55cbd72Sdrh   n = pParse->nRangeReg;
3670e55cbd72Sdrh   if( nReg<=n && !usedAsColumnCache(pParse, i, i+n-1) ){
3671892d3179Sdrh     pParse->iRangeReg += nReg;
3672892d3179Sdrh     pParse->nRangeReg -= nReg;
3673892d3179Sdrh   }else{
3674892d3179Sdrh     i = pParse->nMem+1;
3675892d3179Sdrh     pParse->nMem += nReg;
3676892d3179Sdrh   }
3677892d3179Sdrh   return i;
3678892d3179Sdrh }
3679892d3179Sdrh void sqlite3ReleaseTempRange(Parse *pParse, int iReg, int nReg){
3680892d3179Sdrh   if( nReg>pParse->nRangeReg ){
3681892d3179Sdrh     pParse->nRangeReg = nReg;
3682892d3179Sdrh     pParse->iRangeReg = iReg;
3683892d3179Sdrh   }
3684892d3179Sdrh }
3685