xref: /sqlite-3.40.0/src/expr.c (revision bc622bc0)
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 **
2560ec914cSpeter.d.reid ** i.e. the WHERE clause expressions in the following statements all
26e014a838Sdanielk1977 ** have an affinity:
27e014a838Sdanielk1977 **
28e014a838Sdanielk1977 ** CREATE TABLE t1(a);
29e014a838Sdanielk1977 ** SELECT * FROM t1 WHERE a;
30e014a838Sdanielk1977 ** SELECT a AS b FROM t1 WHERE b;
31e014a838Sdanielk1977 ** SELECT * FROM t1 WHERE (select a from t1);
32e014a838Sdanielk1977 */
33bf3b721fSdanielk1977 char sqlite3ExprAffinity(Expr *pExpr){
34580c8c18Sdrh   int op;
35580c8c18Sdrh   pExpr = sqlite3ExprSkipCollate(pExpr);
369bec6fb3Smistachkin   if( pExpr->flags & EP_Generic ) return 0;
37580c8c18Sdrh   op = pExpr->op;
38487e262fSdrh   if( op==TK_SELECT ){
396ab3a2ecSdanielk1977     assert( pExpr->flags&EP_xIsSelect );
406ab3a2ecSdanielk1977     return sqlite3ExprAffinity(pExpr->x.pSelect->pEList->a[0].pExpr);
41a37cdde0Sdanielk1977   }
42487e262fSdrh #ifndef SQLITE_OMIT_CAST
43487e262fSdrh   if( op==TK_CAST ){
4433e619fcSdrh     assert( !ExprHasProperty(pExpr, EP_IntValue) );
45fdaac671Sdrh     return sqlite3AffinityType(pExpr->u.zToken, 0);
46487e262fSdrh   }
47487e262fSdrh #endif
48259a455fSdanielk1977   if( (op==TK_AGG_COLUMN || op==TK_COLUMN || op==TK_REGISTER)
49259a455fSdanielk1977    && pExpr->pTab!=0
50259a455fSdanielk1977   ){
517d10d5a6Sdrh     /* op==TK_REGISTER && pExpr->pTab!=0 happens when pExpr was originally
527d10d5a6Sdrh     ** a TK_COLUMN but was previously evaluated and cached in a register */
537d10d5a6Sdrh     int j = pExpr->iColumn;
547d10d5a6Sdrh     if( j<0 ) return SQLITE_AFF_INTEGER;
557d10d5a6Sdrh     assert( pExpr->pTab && j<pExpr->pTab->nCol );
567d10d5a6Sdrh     return pExpr->pTab->aCol[j].affinity;
577d10d5a6Sdrh   }
58a37cdde0Sdanielk1977   return pExpr->affinity;
59a37cdde0Sdanielk1977 }
60a37cdde0Sdanielk1977 
6153db1458Sdrh /*
628b4c40d8Sdrh ** Set the collating sequence for expression pExpr to be the collating
63ae80ddeaSdrh ** sequence named by pToken.   Return a pointer to a new Expr node that
64ae80ddeaSdrh ** implements the COLLATE operator.
650a8a406eSdrh **
660a8a406eSdrh ** If a memory allocation error occurs, that fact is recorded in pParse->db
670a8a406eSdrh ** and the pExpr parameter is returned unchanged.
688b4c40d8Sdrh */
694ef7efadSdrh Expr *sqlite3ExprAddCollateToken(
704ef7efadSdrh   Parse *pParse,           /* Parsing context */
714ef7efadSdrh   Expr *pExpr,             /* Add the "COLLATE" clause to this expression */
7280103fc6Sdan   const Token *pCollName,  /* Name of collating sequence */
7380103fc6Sdan   int dequote              /* True to dequote pCollName */
744ef7efadSdrh ){
750a8a406eSdrh   if( pCollName->n>0 ){
7680103fc6Sdan     Expr *pNew = sqlite3ExprAlloc(pParse->db, TK_COLLATE, pCollName, dequote);
77ae80ddeaSdrh     if( pNew ){
78ae80ddeaSdrh       pNew->pLeft = pExpr;
79a4c3c87eSdrh       pNew->flags |= EP_Collate|EP_Skip;
800a8a406eSdrh       pExpr = pNew;
81ae80ddeaSdrh     }
820a8a406eSdrh   }
830a8a406eSdrh   return pExpr;
840a8a406eSdrh }
850a8a406eSdrh Expr *sqlite3ExprAddCollateString(Parse *pParse, Expr *pExpr, const char *zC){
860a8a406eSdrh   Token s;
87261d8a51Sdrh   assert( zC!=0 );
880a8a406eSdrh   s.z = zC;
890a8a406eSdrh   s.n = sqlite3Strlen30(s.z);
9080103fc6Sdan   return sqlite3ExprAddCollateToken(pParse, pExpr, &s, 0);
910a8a406eSdrh }
920a8a406eSdrh 
930a8a406eSdrh /*
94a4c3c87eSdrh ** Skip over any TK_COLLATE or TK_AS operators and any unlikely()
95a4c3c87eSdrh ** or likelihood() function at the root of an expression.
960a8a406eSdrh */
970a8a406eSdrh Expr *sqlite3ExprSkipCollate(Expr *pExpr){
98a4c3c87eSdrh   while( pExpr && ExprHasProperty(pExpr, EP_Skip) ){
99a4c3c87eSdrh     if( ExprHasProperty(pExpr, EP_Unlikely) ){
100cca9f3d2Sdrh       assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
101cca9f3d2Sdrh       assert( pExpr->x.pList->nExpr>0 );
102a4c3c87eSdrh       assert( pExpr->op==TK_FUNCTION );
103cca9f3d2Sdrh       pExpr = pExpr->x.pList->a[0].pExpr;
104cca9f3d2Sdrh     }else{
105a4c3c87eSdrh       assert( pExpr->op==TK_COLLATE || pExpr->op==TK_AS );
106d91eba96Sdrh       pExpr = pExpr->pLeft;
107cca9f3d2Sdrh     }
108d91eba96Sdrh   }
1090a8a406eSdrh   return pExpr;
1108b4c40d8Sdrh }
1118b4c40d8Sdrh 
1128b4c40d8Sdrh /*
113ae80ddeaSdrh ** Return the collation sequence for the expression pExpr. If
114ae80ddeaSdrh ** there is no defined collating sequence, return NULL.
115ae80ddeaSdrh **
116ae80ddeaSdrh ** The collating sequence might be determined by a COLLATE operator
117ae80ddeaSdrh ** or by the presence of a column with a defined collating sequence.
118ae80ddeaSdrh ** COLLATE operators take first precedence.  Left operands take
119ae80ddeaSdrh ** precedence over right operands.
1200202b29eSdanielk1977 */
1217cedc8d4Sdanielk1977 CollSeq *sqlite3ExprCollSeq(Parse *pParse, Expr *pExpr){
122ae80ddeaSdrh   sqlite3 *db = pParse->db;
1237cedc8d4Sdanielk1977   CollSeq *pColl = 0;
1247d10d5a6Sdrh   Expr *p = pExpr;
125261d8a51Sdrh   while( p ){
126ae80ddeaSdrh     int op = p->op;
127fbb24d10Sdrh     if( p->flags & EP_Generic ) break;
128ae80ddeaSdrh     if( op==TK_CAST || op==TK_UPLUS ){
129ae80ddeaSdrh       p = p->pLeft;
130ae80ddeaSdrh       continue;
131ae80ddeaSdrh     }
13236e78309Sdan     if( op==TK_COLLATE || (op==TK_REGISTER && p->op2==TK_COLLATE) ){
1337a66da13Sdrh       pColl = sqlite3GetCollSeq(pParse, ENC(db), 0, p->u.zToken);
134ae80ddeaSdrh       break;
135ae80ddeaSdrh     }
136a58d4a96Sdrh     if( (op==TK_AGG_COLUMN || op==TK_COLUMN
137ae80ddeaSdrh           || op==TK_REGISTER || op==TK_TRIGGER)
138a58d4a96Sdrh      && p->pTab!=0
139ae80ddeaSdrh     ){
1407d10d5a6Sdrh       /* op==TK_REGISTER && p->pTab!=0 happens when pExpr was originally
1417d10d5a6Sdrh       ** a TK_COLUMN but was previously evaluated and cached in a register */
1427d10d5a6Sdrh       int j = p->iColumn;
1437d10d5a6Sdrh       if( j>=0 ){
144ae80ddeaSdrh         const char *zColl = p->pTab->aCol[j].zColl;
145c4a64facSdrh         pColl = sqlite3FindCollSeq(db, ENC(db), zColl, 0);
1460202b29eSdanielk1977       }
1477d10d5a6Sdrh       break;
1487d10d5a6Sdrh     }
149ae80ddeaSdrh     if( p->flags & EP_Collate ){
1502308ed38Sdrh       if( p->pLeft && (p->pLeft->flags & EP_Collate)!=0 ){
1517d10d5a6Sdrh         p = p->pLeft;
152ae80ddeaSdrh       }else{
1532308ed38Sdrh         Expr *pNext  = p->pRight;
1546728cd91Sdrh         /* The Expr.x union is never used at the same time as Expr.pRight */
1556728cd91Sdrh         assert( p->x.pList==0 || p->pRight==0 );
1566728cd91Sdrh         /* p->flags holds EP_Collate and p->pLeft->flags does not.  And
1576728cd91Sdrh         ** p->x.pSelect cannot.  So if p->x.pLeft exists, it must hold at
1586728cd91Sdrh         ** least one EP_Collate. Thus the following two ALWAYS. */
1596728cd91Sdrh         if( p->x.pList!=0 && ALWAYS(!ExprHasProperty(p, EP_xIsSelect)) ){
1602308ed38Sdrh           int i;
1616728cd91Sdrh           for(i=0; ALWAYS(i<p->x.pList->nExpr); i++){
1622308ed38Sdrh             if( ExprHasProperty(p->x.pList->a[i].pExpr, EP_Collate) ){
1632308ed38Sdrh               pNext = p->x.pList->a[i].pExpr;
1642308ed38Sdrh               break;
1652308ed38Sdrh             }
1662308ed38Sdrh           }
1672308ed38Sdrh         }
1682308ed38Sdrh         p = pNext;
169ae80ddeaSdrh       }
170ae80ddeaSdrh     }else{
171ae80ddeaSdrh       break;
172ae80ddeaSdrh     }
1730202b29eSdanielk1977   }
1747cedc8d4Sdanielk1977   if( sqlite3CheckCollSeq(pParse, pColl) ){
1757cedc8d4Sdanielk1977     pColl = 0;
1767cedc8d4Sdanielk1977   }
1777cedc8d4Sdanielk1977   return pColl;
1780202b29eSdanielk1977 }
1790202b29eSdanielk1977 
1800202b29eSdanielk1977 /*
181626a879aSdrh ** pExpr is an operand of a comparison operator.  aff2 is the
182626a879aSdrh ** type affinity of the other operand.  This routine returns the
18353db1458Sdrh ** type affinity that should be used for the comparison operator.
18453db1458Sdrh */
185e014a838Sdanielk1977 char sqlite3CompareAffinity(Expr *pExpr, char aff2){
186bf3b721fSdanielk1977   char aff1 = sqlite3ExprAffinity(pExpr);
187e014a838Sdanielk1977   if( aff1 && aff2 ){
1888df447f0Sdrh     /* Both sides of the comparison are columns. If one has numeric
1898df447f0Sdrh     ** affinity, use that. Otherwise use no affinity.
190e014a838Sdanielk1977     */
1918a51256cSdrh     if( sqlite3IsNumericAffinity(aff1) || sqlite3IsNumericAffinity(aff2) ){
192e014a838Sdanielk1977       return SQLITE_AFF_NUMERIC;
193e014a838Sdanielk1977     }else{
19405883a34Sdrh       return SQLITE_AFF_BLOB;
195e014a838Sdanielk1977     }
196e014a838Sdanielk1977   }else if( !aff1 && !aff2 ){
1975f6a87b3Sdrh     /* Neither side of the comparison is a column.  Compare the
1985f6a87b3Sdrh     ** results directly.
199e014a838Sdanielk1977     */
20005883a34Sdrh     return SQLITE_AFF_BLOB;
201e014a838Sdanielk1977   }else{
202e014a838Sdanielk1977     /* One side is a column, the other is not. Use the columns affinity. */
203fe05af87Sdrh     assert( aff1==0 || aff2==0 );
204e014a838Sdanielk1977     return (aff1 + aff2);
205e014a838Sdanielk1977   }
206e014a838Sdanielk1977 }
207e014a838Sdanielk1977 
20853db1458Sdrh /*
20953db1458Sdrh ** pExpr is a comparison operator.  Return the type affinity that should
21053db1458Sdrh ** be applied to both operands prior to doing the comparison.
21153db1458Sdrh */
212e014a838Sdanielk1977 static char comparisonAffinity(Expr *pExpr){
213e014a838Sdanielk1977   char aff;
214e014a838Sdanielk1977   assert( pExpr->op==TK_EQ || pExpr->op==TK_IN || pExpr->op==TK_LT ||
215e014a838Sdanielk1977           pExpr->op==TK_GT || pExpr->op==TK_GE || pExpr->op==TK_LE ||
2166a2fe093Sdrh           pExpr->op==TK_NE || pExpr->op==TK_IS || pExpr->op==TK_ISNOT );
217e014a838Sdanielk1977   assert( pExpr->pLeft );
218bf3b721fSdanielk1977   aff = sqlite3ExprAffinity(pExpr->pLeft);
219e014a838Sdanielk1977   if( pExpr->pRight ){
220e014a838Sdanielk1977     aff = sqlite3CompareAffinity(pExpr->pRight, aff);
2216ab3a2ecSdanielk1977   }else if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2226ab3a2ecSdanielk1977     aff = sqlite3CompareAffinity(pExpr->x.pSelect->pEList->a[0].pExpr, aff);
2236ab3a2ecSdanielk1977   }else if( !aff ){
22405883a34Sdrh     aff = SQLITE_AFF_BLOB;
225e014a838Sdanielk1977   }
226e014a838Sdanielk1977   return aff;
227e014a838Sdanielk1977 }
228e014a838Sdanielk1977 
229e014a838Sdanielk1977 /*
230e014a838Sdanielk1977 ** pExpr is a comparison expression, eg. '=', '<', IN(...) etc.
231e014a838Sdanielk1977 ** idx_affinity is the affinity of an indexed column. Return true
232e014a838Sdanielk1977 ** if the index with affinity idx_affinity may be used to implement
233e014a838Sdanielk1977 ** the comparison in pExpr.
234e014a838Sdanielk1977 */
235e014a838Sdanielk1977 int sqlite3IndexAffinityOk(Expr *pExpr, char idx_affinity){
236e014a838Sdanielk1977   char aff = comparisonAffinity(pExpr);
2378a51256cSdrh   switch( aff ){
23805883a34Sdrh     case SQLITE_AFF_BLOB:
2398a51256cSdrh       return 1;
2408a51256cSdrh     case SQLITE_AFF_TEXT:
2418a51256cSdrh       return idx_affinity==SQLITE_AFF_TEXT;
2428a51256cSdrh     default:
2438a51256cSdrh       return sqlite3IsNumericAffinity(idx_affinity);
2448a51256cSdrh   }
245e014a838Sdanielk1977 }
246e014a838Sdanielk1977 
247a37cdde0Sdanielk1977 /*
24835573356Sdrh ** Return the P5 value that should be used for a binary comparison
249a37cdde0Sdanielk1977 ** opcode (OP_Eq, OP_Ge etc.) used to compare pExpr1 and pExpr2.
250a37cdde0Sdanielk1977 */
25135573356Sdrh static u8 binaryCompareP5(Expr *pExpr1, Expr *pExpr2, int jumpIfNull){
25235573356Sdrh   u8 aff = (char)sqlite3ExprAffinity(pExpr2);
2531bd10f8aSdrh   aff = (u8)sqlite3CompareAffinity(pExpr1, aff) | (u8)jumpIfNull;
25435573356Sdrh   return aff;
255a37cdde0Sdanielk1977 }
256a37cdde0Sdanielk1977 
257a2e00042Sdrh /*
2580202b29eSdanielk1977 ** Return a pointer to the collation sequence that should be used by
2590202b29eSdanielk1977 ** a binary comparison operator comparing pLeft and pRight.
2600202b29eSdanielk1977 **
2610202b29eSdanielk1977 ** If the left hand expression has a collating sequence type, then it is
2620202b29eSdanielk1977 ** used. Otherwise the collation sequence for the right hand expression
2630202b29eSdanielk1977 ** is used, or the default (BINARY) if neither expression has a collating
2640202b29eSdanielk1977 ** type.
265bcbb04e5Sdanielk1977 **
266bcbb04e5Sdanielk1977 ** Argument pRight (but not pLeft) may be a null pointer. In this case,
267bcbb04e5Sdanielk1977 ** it is not considered.
2680202b29eSdanielk1977 */
269bcbb04e5Sdanielk1977 CollSeq *sqlite3BinaryCompareCollSeq(
270bcbb04e5Sdanielk1977   Parse *pParse,
271bcbb04e5Sdanielk1977   Expr *pLeft,
272bcbb04e5Sdanielk1977   Expr *pRight
273bcbb04e5Sdanielk1977 ){
274ec41ddacSdrh   CollSeq *pColl;
275ec41ddacSdrh   assert( pLeft );
276ae80ddeaSdrh   if( pLeft->flags & EP_Collate ){
277ae80ddeaSdrh     pColl = sqlite3ExprCollSeq(pParse, pLeft);
278ae80ddeaSdrh   }else if( pRight && (pRight->flags & EP_Collate)!=0 ){
279ae80ddeaSdrh     pColl = sqlite3ExprCollSeq(pParse, pRight);
280ec41ddacSdrh   }else{
281ec41ddacSdrh     pColl = sqlite3ExprCollSeq(pParse, pLeft);
2820202b29eSdanielk1977     if( !pColl ){
2837cedc8d4Sdanielk1977       pColl = sqlite3ExprCollSeq(pParse, pRight);
2840202b29eSdanielk1977     }
285ec41ddacSdrh   }
2860202b29eSdanielk1977   return pColl;
2870202b29eSdanielk1977 }
2880202b29eSdanielk1977 
2890202b29eSdanielk1977 /*
290be5c89acSdrh ** Generate code for a comparison operator.
291be5c89acSdrh */
292be5c89acSdrh static int codeCompare(
293be5c89acSdrh   Parse *pParse,    /* The parsing (and code generating) context */
294be5c89acSdrh   Expr *pLeft,      /* The left operand */
295be5c89acSdrh   Expr *pRight,     /* The right operand */
296be5c89acSdrh   int opcode,       /* The comparison opcode */
29735573356Sdrh   int in1, int in2, /* Register holding operands */
298be5c89acSdrh   int dest,         /* Jump here if true.  */
299be5c89acSdrh   int jumpIfNull    /* If true, jump if either operand is NULL */
300be5c89acSdrh ){
30135573356Sdrh   int p5;
30235573356Sdrh   int addr;
30335573356Sdrh   CollSeq *p4;
30435573356Sdrh 
30535573356Sdrh   p4 = sqlite3BinaryCompareCollSeq(pParse, pLeft, pRight);
30635573356Sdrh   p5 = binaryCompareP5(pLeft, pRight, jumpIfNull);
30735573356Sdrh   addr = sqlite3VdbeAddOp4(pParse->pVdbe, opcode, in2, dest, in1,
30835573356Sdrh                            (void*)p4, P4_COLLSEQ);
3091bd10f8aSdrh   sqlite3VdbeChangeP5(pParse->pVdbe, (u8)p5);
31035573356Sdrh   return addr;
311be5c89acSdrh }
312be5c89acSdrh 
3134b5255acSdanielk1977 #if SQLITE_MAX_EXPR_DEPTH>0
3144b5255acSdanielk1977 /*
3154b5255acSdanielk1977 ** Check that argument nHeight is less than or equal to the maximum
3164b5255acSdanielk1977 ** expression depth allowed. If it is not, leave an error message in
3174b5255acSdanielk1977 ** pParse.
3184b5255acSdanielk1977 */
3197d10d5a6Sdrh int sqlite3ExprCheckHeight(Parse *pParse, int nHeight){
3204b5255acSdanielk1977   int rc = SQLITE_OK;
3214b5255acSdanielk1977   int mxHeight = pParse->db->aLimit[SQLITE_LIMIT_EXPR_DEPTH];
3224b5255acSdanielk1977   if( nHeight>mxHeight ){
3234b5255acSdanielk1977     sqlite3ErrorMsg(pParse,
3244b5255acSdanielk1977        "Expression tree is too large (maximum depth %d)", mxHeight
3254b5255acSdanielk1977     );
3264b5255acSdanielk1977     rc = SQLITE_ERROR;
3274b5255acSdanielk1977   }
3284b5255acSdanielk1977   return rc;
3294b5255acSdanielk1977 }
3304b5255acSdanielk1977 
3314b5255acSdanielk1977 /* The following three functions, heightOfExpr(), heightOfExprList()
3324b5255acSdanielk1977 ** and heightOfSelect(), are used to determine the maximum height
3334b5255acSdanielk1977 ** of any expression tree referenced by the structure passed as the
3344b5255acSdanielk1977 ** first argument.
3354b5255acSdanielk1977 **
3364b5255acSdanielk1977 ** If this maximum height is greater than the current value pointed
3374b5255acSdanielk1977 ** to by pnHeight, the second parameter, then set *pnHeight to that
3384b5255acSdanielk1977 ** value.
3394b5255acSdanielk1977 */
3404b5255acSdanielk1977 static void heightOfExpr(Expr *p, int *pnHeight){
3414b5255acSdanielk1977   if( p ){
3424b5255acSdanielk1977     if( p->nHeight>*pnHeight ){
3434b5255acSdanielk1977       *pnHeight = p->nHeight;
3444b5255acSdanielk1977     }
3454b5255acSdanielk1977   }
3464b5255acSdanielk1977 }
3474b5255acSdanielk1977 static void heightOfExprList(ExprList *p, int *pnHeight){
3484b5255acSdanielk1977   if( p ){
3494b5255acSdanielk1977     int i;
3504b5255acSdanielk1977     for(i=0; i<p->nExpr; i++){
3514b5255acSdanielk1977       heightOfExpr(p->a[i].pExpr, pnHeight);
3524b5255acSdanielk1977     }
3534b5255acSdanielk1977   }
3544b5255acSdanielk1977 }
3554b5255acSdanielk1977 static void heightOfSelect(Select *p, int *pnHeight){
3564b5255acSdanielk1977   if( p ){
3574b5255acSdanielk1977     heightOfExpr(p->pWhere, pnHeight);
3584b5255acSdanielk1977     heightOfExpr(p->pHaving, pnHeight);
3594b5255acSdanielk1977     heightOfExpr(p->pLimit, pnHeight);
3604b5255acSdanielk1977     heightOfExpr(p->pOffset, pnHeight);
3614b5255acSdanielk1977     heightOfExprList(p->pEList, pnHeight);
3624b5255acSdanielk1977     heightOfExprList(p->pGroupBy, pnHeight);
3634b5255acSdanielk1977     heightOfExprList(p->pOrderBy, pnHeight);
3644b5255acSdanielk1977     heightOfSelect(p->pPrior, pnHeight);
3654b5255acSdanielk1977   }
3664b5255acSdanielk1977 }
3674b5255acSdanielk1977 
3684b5255acSdanielk1977 /*
3694b5255acSdanielk1977 ** Set the Expr.nHeight variable in the structure passed as an
3704b5255acSdanielk1977 ** argument. An expression with no children, Expr.pList or
3714b5255acSdanielk1977 ** Expr.pSelect member has a height of 1. Any other expression
3724b5255acSdanielk1977 ** has a height equal to the maximum height of any other
3734b5255acSdanielk1977 ** referenced Expr plus one.
3742308ed38Sdrh **
3752308ed38Sdrh ** Also propagate EP_Propagate flags up from Expr.x.pList to Expr.flags,
3762308ed38Sdrh ** if appropriate.
3774b5255acSdanielk1977 */
3784b5255acSdanielk1977 static void exprSetHeight(Expr *p){
3794b5255acSdanielk1977   int nHeight = 0;
3804b5255acSdanielk1977   heightOfExpr(p->pLeft, &nHeight);
3814b5255acSdanielk1977   heightOfExpr(p->pRight, &nHeight);
3826ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_xIsSelect) ){
3836ab3a2ecSdanielk1977     heightOfSelect(p->x.pSelect, &nHeight);
3842308ed38Sdrh   }else if( p->x.pList ){
3856ab3a2ecSdanielk1977     heightOfExprList(p->x.pList, &nHeight);
3862308ed38Sdrh     p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
3876ab3a2ecSdanielk1977   }
3884b5255acSdanielk1977   p->nHeight = nHeight + 1;
3894b5255acSdanielk1977 }
3904b5255acSdanielk1977 
3914b5255acSdanielk1977 /*
3924b5255acSdanielk1977 ** Set the Expr.nHeight variable using the exprSetHeight() function. If
3934b5255acSdanielk1977 ** the height is greater than the maximum allowed expression depth,
3944b5255acSdanielk1977 ** leave an error in pParse.
3952308ed38Sdrh **
3962308ed38Sdrh ** Also propagate all EP_Propagate flags from the Expr.x.pList into
3972308ed38Sdrh ** Expr.flags.
3984b5255acSdanielk1977 */
3992308ed38Sdrh void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
40074893a4cSdrh   if( pParse->nErr ) return;
4014b5255acSdanielk1977   exprSetHeight(p);
4027d10d5a6Sdrh   sqlite3ExprCheckHeight(pParse, p->nHeight);
4034b5255acSdanielk1977 }
4044b5255acSdanielk1977 
4054b5255acSdanielk1977 /*
4064b5255acSdanielk1977 ** Return the maximum height of any expression tree referenced
4074b5255acSdanielk1977 ** by the select statement passed as an argument.
4084b5255acSdanielk1977 */
4094b5255acSdanielk1977 int sqlite3SelectExprHeight(Select *p){
4104b5255acSdanielk1977   int nHeight = 0;
4114b5255acSdanielk1977   heightOfSelect(p, &nHeight);
4124b5255acSdanielk1977   return nHeight;
4134b5255acSdanielk1977 }
4142308ed38Sdrh #else /* ABOVE:  Height enforcement enabled.  BELOW: Height enforcement off */
4152308ed38Sdrh /*
4162308ed38Sdrh ** Propagate all EP_Propagate flags from the Expr.x.pList into
4172308ed38Sdrh ** Expr.flags.
4182308ed38Sdrh */
4192308ed38Sdrh void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
4202308ed38Sdrh   if( p && p->x.pList && !ExprHasProperty(p, EP_xIsSelect) ){
4212308ed38Sdrh     p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
4222308ed38Sdrh   }
4232308ed38Sdrh }
4244b5255acSdanielk1977 #define exprSetHeight(y)
4254b5255acSdanielk1977 #endif /* SQLITE_MAX_EXPR_DEPTH>0 */
4264b5255acSdanielk1977 
427be5c89acSdrh /*
428b7916a78Sdrh ** This routine is the core allocator for Expr nodes.
429b7916a78Sdrh **
430a76b5dfcSdrh ** Construct a new expression node and return a pointer to it.  Memory
431b7916a78Sdrh ** for this node and for the pToken argument is a single allocation
432b7916a78Sdrh ** obtained from sqlite3DbMalloc().  The calling function
433a76b5dfcSdrh ** is responsible for making sure the node eventually gets freed.
434b7916a78Sdrh **
435b7916a78Sdrh ** If dequote is true, then the token (if it exists) is dequoted.
436e792b5b4Sdrh ** If dequote is false, no dequoting is performed.  The deQuote
437b7916a78Sdrh ** parameter is ignored if pToken is NULL or if the token does not
438b7916a78Sdrh ** appear to be quoted.  If the quotes were of the form "..." (double-quotes)
439b7916a78Sdrh ** then the EP_DblQuoted flag is set on the expression node.
44033e619fcSdrh **
44133e619fcSdrh ** Special case:  If op==TK_INTEGER and pToken points to a string that
44233e619fcSdrh ** can be translated into a 32-bit integer, then the token is not
44333e619fcSdrh ** stored in u.zToken.  Instead, the integer values is written
44433e619fcSdrh ** into u.iValue and the EP_IntValue flag is set.  No extra storage
44533e619fcSdrh ** is allocated to hold the integer text and the dequote flag is ignored.
446a76b5dfcSdrh */
447b7916a78Sdrh Expr *sqlite3ExprAlloc(
448a1644fd8Sdanielk1977   sqlite3 *db,            /* Handle for sqlite3DbMallocZero() (may be null) */
44917435752Sdrh   int op,                 /* Expression opcode */
450b7916a78Sdrh   const Token *pToken,    /* Token argument.  Might be NULL */
451b7916a78Sdrh   int dequote             /* True to dequote */
45217435752Sdrh ){
453a76b5dfcSdrh   Expr *pNew;
45433e619fcSdrh   int nExtra = 0;
455cf697396Sshane   int iValue = 0;
456b7916a78Sdrh 
457b7916a78Sdrh   if( pToken ){
45833e619fcSdrh     if( op!=TK_INTEGER || pToken->z==0
45933e619fcSdrh           || sqlite3GetInt32(pToken->z, &iValue)==0 ){
460b7916a78Sdrh       nExtra = pToken->n+1;
461d50ffc41Sdrh       assert( iValue>=0 );
46233e619fcSdrh     }
463a76b5dfcSdrh   }
464b7916a78Sdrh   pNew = sqlite3DbMallocZero(db, sizeof(Expr)+nExtra);
465b7916a78Sdrh   if( pNew ){
4661bd10f8aSdrh     pNew->op = (u8)op;
467a58fdfb1Sdanielk1977     pNew->iAgg = -1;
468a76b5dfcSdrh     if( pToken ){
46933e619fcSdrh       if( nExtra==0 ){
47033e619fcSdrh         pNew->flags |= EP_IntValue;
47133e619fcSdrh         pNew->u.iValue = iValue;
47233e619fcSdrh       }else{
473d9da78a2Sdrh         int c;
47433e619fcSdrh         pNew->u.zToken = (char*)&pNew[1];
475b07028f7Sdrh         assert( pToken->z!=0 || pToken->n==0 );
476b07028f7Sdrh         if( pToken->n ) memcpy(pNew->u.zToken, pToken->z, pToken->n);
47733e619fcSdrh         pNew->u.zToken[pToken->n] = 0;
478b7916a78Sdrh         if( dequote && nExtra>=3
479d9da78a2Sdrh              && ((c = pToken->z[0])=='\'' || c=='"' || c=='[' || c=='`') ){
48033e619fcSdrh           sqlite3Dequote(pNew->u.zToken);
48124fb627aSdrh           if( c=='"' ) pNew->flags |= EP_DblQuoted;
482a34001c9Sdrh         }
483a34001c9Sdrh       }
48433e619fcSdrh     }
485b7916a78Sdrh #if SQLITE_MAX_EXPR_DEPTH>0
486b7916a78Sdrh     pNew->nHeight = 1;
487b7916a78Sdrh #endif
488a34001c9Sdrh   }
489a76b5dfcSdrh   return pNew;
490a76b5dfcSdrh }
491a76b5dfcSdrh 
492a76b5dfcSdrh /*
493b7916a78Sdrh ** Allocate a new expression node from a zero-terminated token that has
494b7916a78Sdrh ** already been dequoted.
495b7916a78Sdrh */
496b7916a78Sdrh Expr *sqlite3Expr(
497b7916a78Sdrh   sqlite3 *db,            /* Handle for sqlite3DbMallocZero() (may be null) */
498b7916a78Sdrh   int op,                 /* Expression opcode */
499b7916a78Sdrh   const char *zToken      /* Token argument.  Might be NULL */
500b7916a78Sdrh ){
501b7916a78Sdrh   Token x;
502b7916a78Sdrh   x.z = zToken;
503b7916a78Sdrh   x.n = zToken ? sqlite3Strlen30(zToken) : 0;
504b7916a78Sdrh   return sqlite3ExprAlloc(db, op, &x, 0);
505b7916a78Sdrh }
506b7916a78Sdrh 
507b7916a78Sdrh /*
508b7916a78Sdrh ** Attach subtrees pLeft and pRight to the Expr node pRoot.
509b7916a78Sdrh **
510b7916a78Sdrh ** If pRoot==NULL that means that a memory allocation error has occurred.
511b7916a78Sdrh ** In that case, delete the subtrees pLeft and pRight.
512b7916a78Sdrh */
513b7916a78Sdrh void sqlite3ExprAttachSubtrees(
514b7916a78Sdrh   sqlite3 *db,
515b7916a78Sdrh   Expr *pRoot,
516b7916a78Sdrh   Expr *pLeft,
517b7916a78Sdrh   Expr *pRight
518b7916a78Sdrh ){
519b7916a78Sdrh   if( pRoot==0 ){
520b7916a78Sdrh     assert( db->mallocFailed );
521b7916a78Sdrh     sqlite3ExprDelete(db, pLeft);
522b7916a78Sdrh     sqlite3ExprDelete(db, pRight);
523b7916a78Sdrh   }else{
524b7916a78Sdrh     if( pRight ){
525b7916a78Sdrh       pRoot->pRight = pRight;
526885a5b03Sdrh       pRoot->flags |= EP_Propagate & pRight->flags;
527b7916a78Sdrh     }
528b7916a78Sdrh     if( pLeft ){
529b7916a78Sdrh       pRoot->pLeft = pLeft;
530885a5b03Sdrh       pRoot->flags |= EP_Propagate & pLeft->flags;
531b7916a78Sdrh     }
532b7916a78Sdrh     exprSetHeight(pRoot);
533b7916a78Sdrh   }
534b7916a78Sdrh }
535b7916a78Sdrh 
536b7916a78Sdrh /*
53760ec914cSpeter.d.reid ** Allocate an Expr node which joins as many as two subtrees.
538b7916a78Sdrh **
539bf664469Sdrh ** One or both of the subtrees can be NULL.  Return a pointer to the new
540bf664469Sdrh ** Expr node.  Or, if an OOM error occurs, set pParse->db->mallocFailed,
541bf664469Sdrh ** free the subtrees and return NULL.
542206f3d96Sdrh */
54317435752Sdrh Expr *sqlite3PExpr(
54417435752Sdrh   Parse *pParse,          /* Parsing context */
54517435752Sdrh   int op,                 /* Expression opcode */
54617435752Sdrh   Expr *pLeft,            /* Left operand */
54717435752Sdrh   Expr *pRight,           /* Right operand */
54817435752Sdrh   const Token *pToken     /* Argument token */
54917435752Sdrh ){
5505fb52caaSdrh   Expr *p;
551655814d2Sdrh   if( op==TK_AND && pLeft && pRight && pParse->nErr==0 ){
5525fb52caaSdrh     /* Take advantage of short-circuit false optimization for AND */
5535fb52caaSdrh     p = sqlite3ExprAnd(pParse->db, pLeft, pRight);
5545fb52caaSdrh   }else{
5555fb52caaSdrh     p = sqlite3ExprAlloc(pParse->db, op, pToken, 1);
556b7916a78Sdrh     sqlite3ExprAttachSubtrees(pParse->db, p, pLeft, pRight);
5575fb52caaSdrh   }
5582b359bdbSdan   if( p ) {
5592b359bdbSdan     sqlite3ExprCheckHeight(pParse, p->nHeight);
5602b359bdbSdan   }
5614e0cff60Sdrh   return p;
5624e0cff60Sdrh }
5634e0cff60Sdrh 
5644e0cff60Sdrh /*
565991a1985Sdrh ** If the expression is always either TRUE or FALSE (respectively),
566991a1985Sdrh ** then return 1.  If one cannot determine the truth value of the
567991a1985Sdrh ** expression at compile-time return 0.
568991a1985Sdrh **
569991a1985Sdrh ** This is an optimization.  If is OK to return 0 here even if
570991a1985Sdrh ** the expression really is always false or false (a false negative).
571991a1985Sdrh ** But it is a bug to return 1 if the expression might have different
572991a1985Sdrh ** boolean values in different circumstances (a false positive.)
5735fb52caaSdrh **
5745fb52caaSdrh ** Note that if the expression is part of conditional for a
5755fb52caaSdrh ** LEFT JOIN, then we cannot determine at compile-time whether or not
5765fb52caaSdrh ** is it true or false, so always return 0.
5775fb52caaSdrh */
578991a1985Sdrh static int exprAlwaysTrue(Expr *p){
579991a1985Sdrh   int v = 0;
580991a1985Sdrh   if( ExprHasProperty(p, EP_FromJoin) ) return 0;
581991a1985Sdrh   if( !sqlite3ExprIsInteger(p, &v) ) return 0;
582991a1985Sdrh   return v!=0;
583991a1985Sdrh }
5845fb52caaSdrh static int exprAlwaysFalse(Expr *p){
5855fb52caaSdrh   int v = 0;
5865fb52caaSdrh   if( ExprHasProperty(p, EP_FromJoin) ) return 0;
5875fb52caaSdrh   if( !sqlite3ExprIsInteger(p, &v) ) return 0;
5885fb52caaSdrh   return v==0;
5895fb52caaSdrh }
5905fb52caaSdrh 
5915fb52caaSdrh /*
59291bb0eedSdrh ** Join two expressions using an AND operator.  If either expression is
59391bb0eedSdrh ** NULL, then just return the other expression.
5945fb52caaSdrh **
5955fb52caaSdrh ** If one side or the other of the AND is known to be false, then instead
5965fb52caaSdrh ** of returning an AND expression, just return a constant expression with
5975fb52caaSdrh ** a value of false.
59891bb0eedSdrh */
5991e536953Sdanielk1977 Expr *sqlite3ExprAnd(sqlite3 *db, Expr *pLeft, Expr *pRight){
60091bb0eedSdrh   if( pLeft==0 ){
60191bb0eedSdrh     return pRight;
60291bb0eedSdrh   }else if( pRight==0 ){
60391bb0eedSdrh     return pLeft;
6045fb52caaSdrh   }else if( exprAlwaysFalse(pLeft) || exprAlwaysFalse(pRight) ){
6055fb52caaSdrh     sqlite3ExprDelete(db, pLeft);
6065fb52caaSdrh     sqlite3ExprDelete(db, pRight);
6075fb52caaSdrh     return sqlite3ExprAlloc(db, TK_INTEGER, &sqlite3IntTokens[0], 0);
60891bb0eedSdrh   }else{
609b7916a78Sdrh     Expr *pNew = sqlite3ExprAlloc(db, TK_AND, 0, 0);
610b7916a78Sdrh     sqlite3ExprAttachSubtrees(db, pNew, pLeft, pRight);
611b7916a78Sdrh     return pNew;
612a76b5dfcSdrh   }
613a76b5dfcSdrh }
614a76b5dfcSdrh 
615a76b5dfcSdrh /*
616a76b5dfcSdrh ** Construct a new expression node for a function with multiple
617a76b5dfcSdrh ** arguments.
618a76b5dfcSdrh */
61917435752Sdrh Expr *sqlite3ExprFunction(Parse *pParse, ExprList *pList, Token *pToken){
620a76b5dfcSdrh   Expr *pNew;
621633e6d57Sdrh   sqlite3 *db = pParse->db;
6224b202ae2Sdanielk1977   assert( pToken );
623b7916a78Sdrh   pNew = sqlite3ExprAlloc(db, TK_FUNCTION, pToken, 1);
624a76b5dfcSdrh   if( pNew==0 ){
625d9da78a2Sdrh     sqlite3ExprListDelete(db, pList); /* Avoid memory leak when malloc fails */
626a76b5dfcSdrh     return 0;
627a76b5dfcSdrh   }
6286ab3a2ecSdanielk1977   pNew->x.pList = pList;
6296ab3a2ecSdanielk1977   assert( !ExprHasProperty(pNew, EP_xIsSelect) );
6302308ed38Sdrh   sqlite3ExprSetHeightAndFlags(pParse, pNew);
631a76b5dfcSdrh   return pNew;
632a76b5dfcSdrh }
633a76b5dfcSdrh 
634a76b5dfcSdrh /*
635fa6bc000Sdrh ** Assign a variable number to an expression that encodes a wildcard
636fa6bc000Sdrh ** in the original SQL statement.
637fa6bc000Sdrh **
638fa6bc000Sdrh ** Wildcards consisting of a single "?" are assigned the next sequential
639fa6bc000Sdrh ** variable number.
640fa6bc000Sdrh **
641fa6bc000Sdrh ** Wildcards of the form "?nnn" are assigned the number "nnn".  We make
642fa6bc000Sdrh ** sure "nnn" is not too be to avoid a denial of service attack when
643fa6bc000Sdrh ** the SQL statement comes from an external source.
644fa6bc000Sdrh **
64551f49f17Sdrh ** Wildcards of the form ":aaa", "@aaa", or "$aaa" are assigned the same number
646fa6bc000Sdrh ** as the previous instance of the same wildcard.  Or if this is the first
64760ec914cSpeter.d.reid ** instance of the wildcard, the next sequential variable number is
648fa6bc000Sdrh ** assigned.
649fa6bc000Sdrh */
650fa6bc000Sdrh void sqlite3ExprAssignVarNumber(Parse *pParse, Expr *pExpr){
65117435752Sdrh   sqlite3 *db = pParse->db;
652b7916a78Sdrh   const char *z;
65317435752Sdrh 
654fa6bc000Sdrh   if( pExpr==0 ) return;
655c5cd1249Sdrh   assert( !ExprHasProperty(pExpr, EP_IntValue|EP_Reduced|EP_TokenOnly) );
65633e619fcSdrh   z = pExpr->u.zToken;
657b7916a78Sdrh   assert( z!=0 );
658b7916a78Sdrh   assert( z[0]!=0 );
659b7916a78Sdrh   if( z[1]==0 ){
660fa6bc000Sdrh     /* Wildcard of the form "?".  Assign the next variable number */
661b7916a78Sdrh     assert( z[0]=='?' );
6628677d308Sdrh     pExpr->iColumn = (ynVar)(++pParse->nVar);
663124c0b49Sdrh   }else{
664124c0b49Sdrh     ynVar x = 0;
665124c0b49Sdrh     u32 n = sqlite3Strlen30(z);
666124c0b49Sdrh     if( z[0]=='?' ){
667fa6bc000Sdrh       /* Wildcard of the form "?nnn".  Convert "nnn" to an integer and
668fa6bc000Sdrh       ** use it as the variable number */
669c8d735aeSdan       i64 i;
670124c0b49Sdrh       int bOk = 0==sqlite3Atoi64(&z[1], &i, n-1, SQLITE_UTF8);
671124c0b49Sdrh       pExpr->iColumn = x = (ynVar)i;
672c5499befSdrh       testcase( i==0 );
673c5499befSdrh       testcase( i==1 );
674c5499befSdrh       testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]-1 );
675c5499befSdrh       testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] );
676c8d735aeSdan       if( bOk==0 || i<1 || i>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
677fa6bc000Sdrh         sqlite3ErrorMsg(pParse, "variable number must be between ?1 and ?%d",
678bb4957f8Sdrh             db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]);
679124c0b49Sdrh         x = 0;
680fa6bc000Sdrh       }
681fa6bc000Sdrh       if( i>pParse->nVar ){
6821df2db7fSshaneh         pParse->nVar = (int)i;
683fa6bc000Sdrh       }
684fa6bc000Sdrh     }else{
68551f49f17Sdrh       /* Wildcards like ":aaa", "$aaa" or "@aaa".  Reuse the same variable
686fa6bc000Sdrh       ** number as the prior appearance of the same name, or if the name
687fa6bc000Sdrh       ** has never appeared before, reuse the same variable number
688fa6bc000Sdrh       */
689124c0b49Sdrh       ynVar i;
690124c0b49Sdrh       for(i=0; i<pParse->nzVar; i++){
691503a686eSdrh         if( pParse->azVar[i] && strcmp(pParse->azVar[i],z)==0 ){
692124c0b49Sdrh           pExpr->iColumn = x = (ynVar)i+1;
693fa6bc000Sdrh           break;
694fa6bc000Sdrh         }
695fa6bc000Sdrh       }
696124c0b49Sdrh       if( x==0 ) x = pExpr->iColumn = (ynVar)(++pParse->nVar);
697fa6bc000Sdrh     }
698124c0b49Sdrh     if( x>0 ){
699124c0b49Sdrh       if( x>pParse->nzVar ){
700124c0b49Sdrh         char **a;
701124c0b49Sdrh         a = sqlite3DbRealloc(db, pParse->azVar, x*sizeof(a[0]));
702124c0b49Sdrh         if( a==0 ) return;  /* Error reported through db->mallocFailed */
703124c0b49Sdrh         pParse->azVar = a;
704124c0b49Sdrh         memset(&a[pParse->nzVar], 0, (x-pParse->nzVar)*sizeof(a[0]));
705124c0b49Sdrh         pParse->nzVar = x;
706124c0b49Sdrh       }
707124c0b49Sdrh       if( z[0]!='?' || pParse->azVar[x-1]==0 ){
708124c0b49Sdrh         sqlite3DbFree(db, pParse->azVar[x-1]);
709124c0b49Sdrh         pParse->azVar[x-1] = sqlite3DbStrNDup(db, z, n);
710fa6bc000Sdrh       }
711fa6bc000Sdrh     }
712fa6bc000Sdrh   }
713bb4957f8Sdrh   if( !pParse->nErr && pParse->nVar>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
714832b2664Sdanielk1977     sqlite3ErrorMsg(pParse, "too many SQL variables");
715832b2664Sdanielk1977   }
716fa6bc000Sdrh }
717fa6bc000Sdrh 
718fa6bc000Sdrh /*
719f6963f99Sdan ** Recursively delete an expression tree.
720a2e00042Sdrh */
721f6963f99Sdan void sqlite3ExprDelete(sqlite3 *db, Expr *p){
722f6963f99Sdan   if( p==0 ) return;
723d50ffc41Sdrh   /* Sanity check: Assert that the IntValue is non-negative if it exists */
724d50ffc41Sdrh   assert( !ExprHasProperty(p, EP_IntValue) || p->u.iValue>=0 );
725c5cd1249Sdrh   if( !ExprHasProperty(p, EP_TokenOnly) ){
726c5cd1249Sdrh     /* The Expr.x union is never used at the same time as Expr.pRight */
727c5cd1249Sdrh     assert( p->x.pList==0 || p->pRight==0 );
728633e6d57Sdrh     sqlite3ExprDelete(db, p->pLeft);
729633e6d57Sdrh     sqlite3ExprDelete(db, p->pRight);
730c5cd1249Sdrh     if( ExprHasProperty(p, EP_MemToken) ) sqlite3DbFree(db, p->u.zToken);
7316ab3a2ecSdanielk1977     if( ExprHasProperty(p, EP_xIsSelect) ){
7326ab3a2ecSdanielk1977       sqlite3SelectDelete(db, p->x.pSelect);
7336ab3a2ecSdanielk1977     }else{
7346ab3a2ecSdanielk1977       sqlite3ExprListDelete(db, p->x.pList);
7356ab3a2ecSdanielk1977     }
7366ab3a2ecSdanielk1977   }
73733e619fcSdrh   if( !ExprHasProperty(p, EP_Static) ){
738633e6d57Sdrh     sqlite3DbFree(db, p);
739a2e00042Sdrh   }
74033e619fcSdrh }
741a2e00042Sdrh 
742d2687b77Sdrh /*
7436ab3a2ecSdanielk1977 ** Return the number of bytes allocated for the expression structure
7446ab3a2ecSdanielk1977 ** passed as the first argument. This is always one of EXPR_FULLSIZE,
7456ab3a2ecSdanielk1977 ** EXPR_REDUCEDSIZE or EXPR_TOKENONLYSIZE.
7466ab3a2ecSdanielk1977 */
7476ab3a2ecSdanielk1977 static int exprStructSize(Expr *p){
7486ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_TokenOnly) ) return EXPR_TOKENONLYSIZE;
7496ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_Reduced) ) return EXPR_REDUCEDSIZE;
7506ab3a2ecSdanielk1977   return EXPR_FULLSIZE;
7516ab3a2ecSdanielk1977 }
7526ab3a2ecSdanielk1977 
7536ab3a2ecSdanielk1977 /*
75433e619fcSdrh ** The dupedExpr*Size() routines each return the number of bytes required
75533e619fcSdrh ** to store a copy of an expression or expression tree.  They differ in
75633e619fcSdrh ** how much of the tree is measured.
75733e619fcSdrh **
75833e619fcSdrh **     dupedExprStructSize()     Size of only the Expr structure
75933e619fcSdrh **     dupedExprNodeSize()       Size of Expr + space for token
76033e619fcSdrh **     dupedExprSize()           Expr + token + subtree components
76133e619fcSdrh **
76233e619fcSdrh ***************************************************************************
76333e619fcSdrh **
76433e619fcSdrh ** The dupedExprStructSize() function returns two values OR-ed together:
76533e619fcSdrh ** (1) the space required for a copy of the Expr structure only and
76633e619fcSdrh ** (2) the EP_xxx flags that indicate what the structure size should be.
76733e619fcSdrh ** The return values is always one of:
76833e619fcSdrh **
76933e619fcSdrh **      EXPR_FULLSIZE
77033e619fcSdrh **      EXPR_REDUCEDSIZE   | EP_Reduced
77133e619fcSdrh **      EXPR_TOKENONLYSIZE | EP_TokenOnly
77233e619fcSdrh **
77333e619fcSdrh ** The size of the structure can be found by masking the return value
77433e619fcSdrh ** of this routine with 0xfff.  The flags can be found by masking the
77533e619fcSdrh ** return value with EP_Reduced|EP_TokenOnly.
77633e619fcSdrh **
77733e619fcSdrh ** Note that with flags==EXPRDUP_REDUCE, this routines works on full-size
77833e619fcSdrh ** (unreduced) Expr objects as they or originally constructed by the parser.
77933e619fcSdrh ** During expression analysis, extra information is computed and moved into
78033e619fcSdrh ** later parts of teh Expr object and that extra information might get chopped
78133e619fcSdrh ** off if the expression is reduced.  Note also that it does not work to
78260ec914cSpeter.d.reid ** make an EXPRDUP_REDUCE copy of a reduced expression.  It is only legal
78333e619fcSdrh ** to reduce a pristine expression tree from the parser.  The implementation
78433e619fcSdrh ** of dupedExprStructSize() contain multiple assert() statements that attempt
78533e619fcSdrh ** to enforce this constraint.
7866ab3a2ecSdanielk1977 */
7876ab3a2ecSdanielk1977 static int dupedExprStructSize(Expr *p, int flags){
7886ab3a2ecSdanielk1977   int nSize;
78933e619fcSdrh   assert( flags==EXPRDUP_REDUCE || flags==0 ); /* Only one flag value allowed */
790aecd8021Sdrh   assert( EXPR_FULLSIZE<=0xfff );
791aecd8021Sdrh   assert( (0xfff & (EP_Reduced|EP_TokenOnly))==0 );
7926ab3a2ecSdanielk1977   if( 0==(flags&EXPRDUP_REDUCE) ){
7936ab3a2ecSdanielk1977     nSize = EXPR_FULLSIZE;
7946ab3a2ecSdanielk1977   }else{
795c5cd1249Sdrh     assert( !ExprHasProperty(p, EP_TokenOnly|EP_Reduced) );
79633e619fcSdrh     assert( !ExprHasProperty(p, EP_FromJoin) );
797c5cd1249Sdrh     assert( !ExprHasProperty(p, EP_MemToken) );
798ebb6a65dSdrh     assert( !ExprHasProperty(p, EP_NoReduce) );
799aecd8021Sdrh     if( p->pLeft || p->x.pList ){
80033e619fcSdrh       nSize = EXPR_REDUCEDSIZE | EP_Reduced;
80133e619fcSdrh     }else{
802aecd8021Sdrh       assert( p->pRight==0 );
80333e619fcSdrh       nSize = EXPR_TOKENONLYSIZE | EP_TokenOnly;
80433e619fcSdrh     }
8056ab3a2ecSdanielk1977   }
8066ab3a2ecSdanielk1977   return nSize;
8076ab3a2ecSdanielk1977 }
8086ab3a2ecSdanielk1977 
8096ab3a2ecSdanielk1977 /*
81033e619fcSdrh ** This function returns the space in bytes required to store the copy
81133e619fcSdrh ** of the Expr structure and a copy of the Expr.u.zToken string (if that
81233e619fcSdrh ** string is defined.)
8136ab3a2ecSdanielk1977 */
8146ab3a2ecSdanielk1977 static int dupedExprNodeSize(Expr *p, int flags){
81533e619fcSdrh   int nByte = dupedExprStructSize(p, flags) & 0xfff;
81633e619fcSdrh   if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
81733e619fcSdrh     nByte += sqlite3Strlen30(p->u.zToken)+1;
8186ab3a2ecSdanielk1977   }
819bc73971dSdanielk1977   return ROUND8(nByte);
8206ab3a2ecSdanielk1977 }
8216ab3a2ecSdanielk1977 
8226ab3a2ecSdanielk1977 /*
8236ab3a2ecSdanielk1977 ** Return the number of bytes required to create a duplicate of the
8246ab3a2ecSdanielk1977 ** expression passed as the first argument. The second argument is a
8256ab3a2ecSdanielk1977 ** mask containing EXPRDUP_XXX flags.
8266ab3a2ecSdanielk1977 **
8276ab3a2ecSdanielk1977 ** The value returned includes space to create a copy of the Expr struct
82833e619fcSdrh ** itself and the buffer referred to by Expr.u.zToken, if any.
8296ab3a2ecSdanielk1977 **
8306ab3a2ecSdanielk1977 ** If the EXPRDUP_REDUCE flag is set, then the return value includes
8316ab3a2ecSdanielk1977 ** space to duplicate all Expr nodes in the tree formed by Expr.pLeft
8326ab3a2ecSdanielk1977 ** and Expr.pRight variables (but not for any structures pointed to or
8336ab3a2ecSdanielk1977 ** descended from the Expr.x.pList or Expr.x.pSelect variables).
8346ab3a2ecSdanielk1977 */
8356ab3a2ecSdanielk1977 static int dupedExprSize(Expr *p, int flags){
8366ab3a2ecSdanielk1977   int nByte = 0;
8376ab3a2ecSdanielk1977   if( p ){
8386ab3a2ecSdanielk1977     nByte = dupedExprNodeSize(p, flags);
8396ab3a2ecSdanielk1977     if( flags&EXPRDUP_REDUCE ){
840b7916a78Sdrh       nByte += dupedExprSize(p->pLeft, flags) + dupedExprSize(p->pRight, flags);
8416ab3a2ecSdanielk1977     }
8426ab3a2ecSdanielk1977   }
8436ab3a2ecSdanielk1977   return nByte;
8446ab3a2ecSdanielk1977 }
8456ab3a2ecSdanielk1977 
8466ab3a2ecSdanielk1977 /*
8476ab3a2ecSdanielk1977 ** This function is similar to sqlite3ExprDup(), except that if pzBuffer
8486ab3a2ecSdanielk1977 ** is not NULL then *pzBuffer is assumed to point to a buffer large enough
84933e619fcSdrh ** to store the copy of expression p, the copies of p->u.zToken
8506ab3a2ecSdanielk1977 ** (if applicable), and the copies of the p->pLeft and p->pRight expressions,
85160ec914cSpeter.d.reid ** if any. Before returning, *pzBuffer is set to the first byte past the
8526ab3a2ecSdanielk1977 ** portion of the buffer copied into by this function.
8536ab3a2ecSdanielk1977 */
8546ab3a2ecSdanielk1977 static Expr *exprDup(sqlite3 *db, Expr *p, int flags, u8 **pzBuffer){
8556ab3a2ecSdanielk1977   Expr *pNew = 0;                      /* Value to return */
8566ab3a2ecSdanielk1977   if( p ){
8576ab3a2ecSdanielk1977     const int isReduced = (flags&EXPRDUP_REDUCE);
8586ab3a2ecSdanielk1977     u8 *zAlloc;
85933e619fcSdrh     u32 staticFlag = 0;
8606ab3a2ecSdanielk1977 
8616ab3a2ecSdanielk1977     assert( pzBuffer==0 || isReduced );
8626ab3a2ecSdanielk1977 
8636ab3a2ecSdanielk1977     /* Figure out where to write the new Expr structure. */
8646ab3a2ecSdanielk1977     if( pzBuffer ){
8656ab3a2ecSdanielk1977       zAlloc = *pzBuffer;
86633e619fcSdrh       staticFlag = EP_Static;
8676ab3a2ecSdanielk1977     }else{
8686ab3a2ecSdanielk1977       zAlloc = sqlite3DbMallocRaw(db, dupedExprSize(p, flags));
8696ab3a2ecSdanielk1977     }
8706ab3a2ecSdanielk1977     pNew = (Expr *)zAlloc;
8716ab3a2ecSdanielk1977 
8726ab3a2ecSdanielk1977     if( pNew ){
8736ab3a2ecSdanielk1977       /* Set nNewSize to the size allocated for the structure pointed to
8746ab3a2ecSdanielk1977       ** by pNew. This is either EXPR_FULLSIZE, EXPR_REDUCEDSIZE or
8756ab3a2ecSdanielk1977       ** EXPR_TOKENONLYSIZE. nToken is set to the number of bytes consumed
87633e619fcSdrh       ** by the copy of the p->u.zToken string (if any).
8776ab3a2ecSdanielk1977       */
87833e619fcSdrh       const unsigned nStructSize = dupedExprStructSize(p, flags);
87933e619fcSdrh       const int nNewSize = nStructSize & 0xfff;
88033e619fcSdrh       int nToken;
88133e619fcSdrh       if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
88233e619fcSdrh         nToken = sqlite3Strlen30(p->u.zToken) + 1;
88333e619fcSdrh       }else{
88433e619fcSdrh         nToken = 0;
88533e619fcSdrh       }
8866ab3a2ecSdanielk1977       if( isReduced ){
8876ab3a2ecSdanielk1977         assert( ExprHasProperty(p, EP_Reduced)==0 );
8886ab3a2ecSdanielk1977         memcpy(zAlloc, p, nNewSize);
8896ab3a2ecSdanielk1977       }else{
8906ab3a2ecSdanielk1977         int nSize = exprStructSize(p);
8916ab3a2ecSdanielk1977         memcpy(zAlloc, p, nSize);
8926ab3a2ecSdanielk1977         memset(&zAlloc[nSize], 0, EXPR_FULLSIZE-nSize);
8936ab3a2ecSdanielk1977       }
8946ab3a2ecSdanielk1977 
89533e619fcSdrh       /* Set the EP_Reduced, EP_TokenOnly, and EP_Static flags appropriately. */
896c5cd1249Sdrh       pNew->flags &= ~(EP_Reduced|EP_TokenOnly|EP_Static|EP_MemToken);
89733e619fcSdrh       pNew->flags |= nStructSize & (EP_Reduced|EP_TokenOnly);
89833e619fcSdrh       pNew->flags |= staticFlag;
8996ab3a2ecSdanielk1977 
90033e619fcSdrh       /* Copy the p->u.zToken string, if any. */
9016ab3a2ecSdanielk1977       if( nToken ){
90233e619fcSdrh         char *zToken = pNew->u.zToken = (char*)&zAlloc[nNewSize];
90333e619fcSdrh         memcpy(zToken, p->u.zToken, nToken);
9046ab3a2ecSdanielk1977       }
9056ab3a2ecSdanielk1977 
9066ab3a2ecSdanielk1977       if( 0==((p->flags|pNew->flags) & EP_TokenOnly) ){
9076ab3a2ecSdanielk1977         /* Fill in the pNew->x.pSelect or pNew->x.pList member. */
9086ab3a2ecSdanielk1977         if( ExprHasProperty(p, EP_xIsSelect) ){
9096ab3a2ecSdanielk1977           pNew->x.pSelect = sqlite3SelectDup(db, p->x.pSelect, isReduced);
9106ab3a2ecSdanielk1977         }else{
9116ab3a2ecSdanielk1977           pNew->x.pList = sqlite3ExprListDup(db, p->x.pList, isReduced);
9126ab3a2ecSdanielk1977         }
9136ab3a2ecSdanielk1977       }
9146ab3a2ecSdanielk1977 
9156ab3a2ecSdanielk1977       /* Fill in pNew->pLeft and pNew->pRight. */
916c5cd1249Sdrh       if( ExprHasProperty(pNew, EP_Reduced|EP_TokenOnly) ){
9176ab3a2ecSdanielk1977         zAlloc += dupedExprNodeSize(p, flags);
9186ab3a2ecSdanielk1977         if( ExprHasProperty(pNew, EP_Reduced) ){
9196ab3a2ecSdanielk1977           pNew->pLeft = exprDup(db, p->pLeft, EXPRDUP_REDUCE, &zAlloc);
9206ab3a2ecSdanielk1977           pNew->pRight = exprDup(db, p->pRight, EXPRDUP_REDUCE, &zAlloc);
9216ab3a2ecSdanielk1977         }
9226ab3a2ecSdanielk1977         if( pzBuffer ){
9236ab3a2ecSdanielk1977           *pzBuffer = zAlloc;
9246ab3a2ecSdanielk1977         }
925b7916a78Sdrh       }else{
926c5cd1249Sdrh         if( !ExprHasProperty(p, EP_TokenOnly) ){
9276ab3a2ecSdanielk1977           pNew->pLeft = sqlite3ExprDup(db, p->pLeft, 0);
9286ab3a2ecSdanielk1977           pNew->pRight = sqlite3ExprDup(db, p->pRight, 0);
9296ab3a2ecSdanielk1977         }
9306ab3a2ecSdanielk1977       }
931b7916a78Sdrh 
932b7916a78Sdrh     }
9336ab3a2ecSdanielk1977   }
9346ab3a2ecSdanielk1977   return pNew;
9356ab3a2ecSdanielk1977 }
9366ab3a2ecSdanielk1977 
937bfe31e7fSdan /*
938bfe31e7fSdan ** Create and return a deep copy of the object passed as the second
939bfe31e7fSdan ** argument. If an OOM condition is encountered, NULL is returned
940bfe31e7fSdan ** and the db->mallocFailed flag set.
941bfe31e7fSdan */
942eede6a53Sdan #ifndef SQLITE_OMIT_CTE
943bfe31e7fSdan static With *withDup(sqlite3 *db, With *p){
9444e9119d9Sdan   With *pRet = 0;
9454e9119d9Sdan   if( p ){
9464e9119d9Sdan     int nByte = sizeof(*p) + sizeof(p->a[0]) * (p->nCte-1);
9474e9119d9Sdan     pRet = sqlite3DbMallocZero(db, nByte);
9484e9119d9Sdan     if( pRet ){
9494e9119d9Sdan       int i;
9504e9119d9Sdan       pRet->nCte = p->nCte;
9514e9119d9Sdan       for(i=0; i<p->nCte; i++){
9524e9119d9Sdan         pRet->a[i].pSelect = sqlite3SelectDup(db, p->a[i].pSelect, 0);
9534e9119d9Sdan         pRet->a[i].pCols = sqlite3ExprListDup(db, p->a[i].pCols, 0);
9544e9119d9Sdan         pRet->a[i].zName = sqlite3DbStrDup(db, p->a[i].zName);
9554e9119d9Sdan       }
9564e9119d9Sdan     }
9574e9119d9Sdan   }
9584e9119d9Sdan   return pRet;
9594e9119d9Sdan }
960eede6a53Sdan #else
961eede6a53Sdan # define withDup(x,y) 0
962eede6a53Sdan #endif
9634e9119d9Sdan 
9646ab3a2ecSdanielk1977 /*
965ff78bd2fSdrh ** The following group of routines make deep copies of expressions,
966ff78bd2fSdrh ** expression lists, ID lists, and select statements.  The copies can
967ff78bd2fSdrh ** be deleted (by being passed to their respective ...Delete() routines)
968ff78bd2fSdrh ** without effecting the originals.
969ff78bd2fSdrh **
9704adee20fSdanielk1977 ** The expression list, ID, and source lists return by sqlite3ExprListDup(),
9714adee20fSdanielk1977 ** sqlite3IdListDup(), and sqlite3SrcListDup() can not be further expanded
972ad3cab52Sdrh ** by subsequent calls to sqlite*ListAppend() routines.
973ff78bd2fSdrh **
974ad3cab52Sdrh ** Any tables that the SrcList might point to are not duplicated.
9756ab3a2ecSdanielk1977 **
976b7916a78Sdrh ** The flags parameter contains a combination of the EXPRDUP_XXX flags.
9776ab3a2ecSdanielk1977 ** If the EXPRDUP_REDUCE flag is set, then the structure returned is a
9786ab3a2ecSdanielk1977 ** truncated version of the usual Expr structure that will be stored as
9796ab3a2ecSdanielk1977 ** part of the in-memory representation of the database schema.
980ff78bd2fSdrh */
9816ab3a2ecSdanielk1977 Expr *sqlite3ExprDup(sqlite3 *db, Expr *p, int flags){
9826ab3a2ecSdanielk1977   return exprDup(db, p, flags, 0);
983ff78bd2fSdrh }
9846ab3a2ecSdanielk1977 ExprList *sqlite3ExprListDup(sqlite3 *db, ExprList *p, int flags){
985ff78bd2fSdrh   ExprList *pNew;
986145716b3Sdrh   struct ExprList_item *pItem, *pOldItem;
987ff78bd2fSdrh   int i;
988ff78bd2fSdrh   if( p==0 ) return 0;
98917435752Sdrh   pNew = sqlite3DbMallocRaw(db, sizeof(*pNew) );
990ff78bd2fSdrh   if( pNew==0 ) return 0;
991d872bb18Sdrh   pNew->nExpr = i = p->nExpr;
992d872bb18Sdrh   if( (flags & EXPRDUP_REDUCE)==0 ) for(i=1; i<p->nExpr; i+=i){}
993d872bb18Sdrh   pNew->a = pItem = sqlite3DbMallocRaw(db,  i*sizeof(p->a[0]) );
994e0048400Sdanielk1977   if( pItem==0 ){
995633e6d57Sdrh     sqlite3DbFree(db, pNew);
996e0048400Sdanielk1977     return 0;
997e0048400Sdanielk1977   }
998145716b3Sdrh   pOldItem = p->a;
999145716b3Sdrh   for(i=0; i<p->nExpr; i++, pItem++, pOldItem++){
10006ab3a2ecSdanielk1977     Expr *pOldExpr = pOldItem->pExpr;
1001b5526ea6Sdrh     pItem->pExpr = sqlite3ExprDup(db, pOldExpr, flags);
100217435752Sdrh     pItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
1003b7916a78Sdrh     pItem->zSpan = sqlite3DbStrDup(db, pOldItem->zSpan);
1004145716b3Sdrh     pItem->sortOrder = pOldItem->sortOrder;
10053e7bc9caSdrh     pItem->done = 0;
10062c036cffSdrh     pItem->bSpanIsTab = pOldItem->bSpanIsTab;
1007c2acc4e4Sdrh     pItem->u = pOldItem->u;
1008ff78bd2fSdrh   }
1009ff78bd2fSdrh   return pNew;
1010ff78bd2fSdrh }
101193758c8dSdanielk1977 
101293758c8dSdanielk1977 /*
101393758c8dSdanielk1977 ** If cursors, triggers, views and subqueries are all omitted from
101493758c8dSdanielk1977 ** the build, then none of the following routines, except for
101593758c8dSdanielk1977 ** sqlite3SelectDup(), can be called. sqlite3SelectDup() is sometimes
101693758c8dSdanielk1977 ** called with a NULL argument.
101793758c8dSdanielk1977 */
10186a67fe8eSdanielk1977 #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_TRIGGER) \
10196a67fe8eSdanielk1977  || !defined(SQLITE_OMIT_SUBQUERY)
10206ab3a2ecSdanielk1977 SrcList *sqlite3SrcListDup(sqlite3 *db, SrcList *p, int flags){
1021ad3cab52Sdrh   SrcList *pNew;
1022ad3cab52Sdrh   int i;
1023113088ecSdrh   int nByte;
1024ad3cab52Sdrh   if( p==0 ) return 0;
1025113088ecSdrh   nByte = sizeof(*p) + (p->nSrc>0 ? sizeof(p->a[0]) * (p->nSrc-1) : 0);
102617435752Sdrh   pNew = sqlite3DbMallocRaw(db, nByte );
1027ad3cab52Sdrh   if( pNew==0 ) return 0;
10284305d103Sdrh   pNew->nSrc = pNew->nAlloc = p->nSrc;
1029ad3cab52Sdrh   for(i=0; i<p->nSrc; i++){
10304efc4754Sdrh     struct SrcList_item *pNewItem = &pNew->a[i];
10314efc4754Sdrh     struct SrcList_item *pOldItem = &p->a[i];
1032ed8a3bb1Sdrh     Table *pTab;
103341fb5cd1Sdan     pNewItem->pSchema = pOldItem->pSchema;
103417435752Sdrh     pNewItem->zDatabase = sqlite3DbStrDup(db, pOldItem->zDatabase);
103517435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
103617435752Sdrh     pNewItem->zAlias = sqlite3DbStrDup(db, pOldItem->zAlias);
10378a48b9c0Sdrh     pNewItem->fg = pOldItem->fg;
10384efc4754Sdrh     pNewItem->iCursor = pOldItem->iCursor;
10395b6a9ed4Sdrh     pNewItem->addrFillSub = pOldItem->addrFillSub;
10405b6a9ed4Sdrh     pNewItem->regReturn = pOldItem->regReturn;
10418a48b9c0Sdrh     if( pNewItem->fg.isIndexedBy ){
10428a48b9c0Sdrh       pNewItem->u1.zIndexedBy = sqlite3DbStrDup(db, pOldItem->u1.zIndexedBy);
10438a48b9c0Sdrh     }
10448a48b9c0Sdrh     pNewItem->pIBIndex = pOldItem->pIBIndex;
10458a48b9c0Sdrh     if( pNewItem->fg.isTabFunc ){
10468a48b9c0Sdrh       pNewItem->u1.pFuncArg =
10478a48b9c0Sdrh           sqlite3ExprListDup(db, pOldItem->u1.pFuncArg, flags);
10488a48b9c0Sdrh     }
1049ed8a3bb1Sdrh     pTab = pNewItem->pTab = pOldItem->pTab;
1050ed8a3bb1Sdrh     if( pTab ){
1051ed8a3bb1Sdrh       pTab->nRef++;
1052a1cb183dSdanielk1977     }
10536ab3a2ecSdanielk1977     pNewItem->pSelect = sqlite3SelectDup(db, pOldItem->pSelect, flags);
10546ab3a2ecSdanielk1977     pNewItem->pOn = sqlite3ExprDup(db, pOldItem->pOn, flags);
105517435752Sdrh     pNewItem->pUsing = sqlite3IdListDup(db, pOldItem->pUsing);
10566c18b6e0Sdanielk1977     pNewItem->colUsed = pOldItem->colUsed;
1057ad3cab52Sdrh   }
1058ad3cab52Sdrh   return pNew;
1059ad3cab52Sdrh }
106017435752Sdrh IdList *sqlite3IdListDup(sqlite3 *db, IdList *p){
1061ff78bd2fSdrh   IdList *pNew;
1062ff78bd2fSdrh   int i;
1063ff78bd2fSdrh   if( p==0 ) return 0;
106417435752Sdrh   pNew = sqlite3DbMallocRaw(db, sizeof(*pNew) );
1065ff78bd2fSdrh   if( pNew==0 ) return 0;
10666c535158Sdrh   pNew->nId = p->nId;
106717435752Sdrh   pNew->a = sqlite3DbMallocRaw(db, p->nId*sizeof(p->a[0]) );
1068d5d56523Sdanielk1977   if( pNew->a==0 ){
1069633e6d57Sdrh     sqlite3DbFree(db, pNew);
1070d5d56523Sdanielk1977     return 0;
1071d5d56523Sdanielk1977   }
10726c535158Sdrh   /* Note that because the size of the allocation for p->a[] is not
10736c535158Sdrh   ** necessarily a power of two, sqlite3IdListAppend() may not be called
10746c535158Sdrh   ** on the duplicate created by this function. */
1075ff78bd2fSdrh   for(i=0; i<p->nId; i++){
10764efc4754Sdrh     struct IdList_item *pNewItem = &pNew->a[i];
10774efc4754Sdrh     struct IdList_item *pOldItem = &p->a[i];
107817435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
10794efc4754Sdrh     pNewItem->idx = pOldItem->idx;
1080ff78bd2fSdrh   }
1081ff78bd2fSdrh   return pNew;
1082ff78bd2fSdrh }
10836ab3a2ecSdanielk1977 Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
108423b1b372Sdrh   Select *pNew, *pPrior;
1085ff78bd2fSdrh   if( p==0 ) return 0;
108617435752Sdrh   pNew = sqlite3DbMallocRaw(db, sizeof(*p) );
1087ff78bd2fSdrh   if( pNew==0 ) return 0;
1088b7916a78Sdrh   pNew->pEList = sqlite3ExprListDup(db, p->pEList, flags);
10896ab3a2ecSdanielk1977   pNew->pSrc = sqlite3SrcListDup(db, p->pSrc, flags);
10906ab3a2ecSdanielk1977   pNew->pWhere = sqlite3ExprDup(db, p->pWhere, flags);
10916ab3a2ecSdanielk1977   pNew->pGroupBy = sqlite3ExprListDup(db, p->pGroupBy, flags);
10926ab3a2ecSdanielk1977   pNew->pHaving = sqlite3ExprDup(db, p->pHaving, flags);
10936ab3a2ecSdanielk1977   pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, flags);
1094ff78bd2fSdrh   pNew->op = p->op;
109523b1b372Sdrh   pNew->pPrior = pPrior = sqlite3SelectDup(db, p->pPrior, flags);
109623b1b372Sdrh   if( pPrior ) pPrior->pNext = pNew;
109723b1b372Sdrh   pNew->pNext = 0;
10986ab3a2ecSdanielk1977   pNew->pLimit = sqlite3ExprDup(db, p->pLimit, flags);
10996ab3a2ecSdanielk1977   pNew->pOffset = sqlite3ExprDup(db, p->pOffset, flags);
110092b01d53Sdrh   pNew->iLimit = 0;
110192b01d53Sdrh   pNew->iOffset = 0;
11027d10d5a6Sdrh   pNew->selFlags = p->selFlags & ~SF_UsesEphemeral;
1103b9bb7c18Sdrh   pNew->addrOpenEphm[0] = -1;
1104b9bb7c18Sdrh   pNew->addrOpenEphm[1] = -1;
1105ec2da854Sdrh   pNew->nSelectRow = p->nSelectRow;
11064e9119d9Sdan   pNew->pWith = withDup(db, p->pWith);
1107eb9b884cSdrh   sqlite3SelectSetName(pNew, p->zSelName);
1108ff78bd2fSdrh   return pNew;
1109ff78bd2fSdrh }
111093758c8dSdanielk1977 #else
11116ab3a2ecSdanielk1977 Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
111293758c8dSdanielk1977   assert( p==0 );
111393758c8dSdanielk1977   return 0;
111493758c8dSdanielk1977 }
111593758c8dSdanielk1977 #endif
1116ff78bd2fSdrh 
1117ff78bd2fSdrh 
1118ff78bd2fSdrh /*
1119a76b5dfcSdrh ** Add a new element to the end of an expression list.  If pList is
1120a76b5dfcSdrh ** initially NULL, then create a new expression list.
1121b7916a78Sdrh **
1122b7916a78Sdrh ** If a memory allocation error occurs, the entire list is freed and
1123b7916a78Sdrh ** NULL is returned.  If non-NULL is returned, then it is guaranteed
1124b7916a78Sdrh ** that the new entry was successfully appended.
1125a76b5dfcSdrh */
112617435752Sdrh ExprList *sqlite3ExprListAppend(
112717435752Sdrh   Parse *pParse,          /* Parsing context */
112817435752Sdrh   ExprList *pList,        /* List to which to append. Might be NULL */
1129b7916a78Sdrh   Expr *pExpr             /* Expression to be appended. Might be NULL */
113017435752Sdrh ){
113117435752Sdrh   sqlite3 *db = pParse->db;
1132a76b5dfcSdrh   if( pList==0 ){
113317435752Sdrh     pList = sqlite3DbMallocZero(db, sizeof(ExprList) );
1134a76b5dfcSdrh     if( pList==0 ){
1135d5d56523Sdanielk1977       goto no_mem;
1136a76b5dfcSdrh     }
1137d872bb18Sdrh     pList->a = sqlite3DbMallocRaw(db, sizeof(pList->a[0]));
1138d872bb18Sdrh     if( pList->a==0 ) goto no_mem;
1139d872bb18Sdrh   }else if( (pList->nExpr & (pList->nExpr-1))==0 ){
1140d5d56523Sdanielk1977     struct ExprList_item *a;
1141d872bb18Sdrh     assert( pList->nExpr>0 );
1142d872bb18Sdrh     a = sqlite3DbRealloc(db, pList->a, pList->nExpr*2*sizeof(pList->a[0]));
1143d5d56523Sdanielk1977     if( a==0 ){
1144d5d56523Sdanielk1977       goto no_mem;
1145a76b5dfcSdrh     }
1146d5d56523Sdanielk1977     pList->a = a;
1147a76b5dfcSdrh   }
11484efc4754Sdrh   assert( pList->a!=0 );
1149b7916a78Sdrh   if( 1 ){
11504efc4754Sdrh     struct ExprList_item *pItem = &pList->a[pList->nExpr++];
11514efc4754Sdrh     memset(pItem, 0, sizeof(*pItem));
1152e94ddc9eSdanielk1977     pItem->pExpr = pExpr;
1153a76b5dfcSdrh   }
1154a76b5dfcSdrh   return pList;
1155d5d56523Sdanielk1977 
1156d5d56523Sdanielk1977 no_mem:
1157d5d56523Sdanielk1977   /* Avoid leaking memory if malloc has failed. */
1158633e6d57Sdrh   sqlite3ExprDelete(db, pExpr);
1159633e6d57Sdrh   sqlite3ExprListDelete(db, pList);
1160d5d56523Sdanielk1977   return 0;
1161a76b5dfcSdrh }
1162a76b5dfcSdrh 
1163a76b5dfcSdrh /*
1164*bc622bc0Sdrh ** Set the sort order for the last element on the given ExprList.
1165*bc622bc0Sdrh */
1166*bc622bc0Sdrh void sqlite3ExprListSetSortOrder(ExprList *p, int iSortOrder){
1167*bc622bc0Sdrh   if( p==0 ) return;
1168*bc622bc0Sdrh   assert( SQLITE_SO_UNDEFINED<0 && SQLITE_SO_ASC>=0 && SQLITE_SO_DESC>0 );
1169*bc622bc0Sdrh   assert( p->nExpr>0 );
1170*bc622bc0Sdrh   if( iSortOrder<0 ){
1171*bc622bc0Sdrh     assert( p->a[p->nExpr-1].sortOrder==SQLITE_SO_ASC );
1172*bc622bc0Sdrh     return;
1173*bc622bc0Sdrh   }
1174*bc622bc0Sdrh   p->a[p->nExpr-1].sortOrder = (u8)iSortOrder;
1175*bc622bc0Sdrh   p->a[p->nExpr-1].bDefinedSO = 1;
1176*bc622bc0Sdrh }
1177*bc622bc0Sdrh 
1178*bc622bc0Sdrh /*
1179b7916a78Sdrh ** Set the ExprList.a[].zName element of the most recently added item
1180b7916a78Sdrh ** on the expression list.
1181b7916a78Sdrh **
1182b7916a78Sdrh ** pList might be NULL following an OOM error.  But pName should never be
1183b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1184b7916a78Sdrh ** is set.
1185b7916a78Sdrh */
1186b7916a78Sdrh void sqlite3ExprListSetName(
1187b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1188b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
1189b7916a78Sdrh   Token *pName,           /* Name to be added */
1190b7916a78Sdrh   int dequote             /* True to cause the name to be dequoted */
1191b7916a78Sdrh ){
1192b7916a78Sdrh   assert( pList!=0 || pParse->db->mallocFailed!=0 );
1193b7916a78Sdrh   if( pList ){
1194b7916a78Sdrh     struct ExprList_item *pItem;
1195b7916a78Sdrh     assert( pList->nExpr>0 );
1196b7916a78Sdrh     pItem = &pList->a[pList->nExpr-1];
1197b7916a78Sdrh     assert( pItem->zName==0 );
1198b7916a78Sdrh     pItem->zName = sqlite3DbStrNDup(pParse->db, pName->z, pName->n);
1199b7916a78Sdrh     if( dequote && pItem->zName ) sqlite3Dequote(pItem->zName);
1200b7916a78Sdrh   }
1201b7916a78Sdrh }
1202b7916a78Sdrh 
1203b7916a78Sdrh /*
1204b7916a78Sdrh ** Set the ExprList.a[].zSpan element of the most recently added item
1205b7916a78Sdrh ** on the expression list.
1206b7916a78Sdrh **
1207b7916a78Sdrh ** pList might be NULL following an OOM error.  But pSpan should never be
1208b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1209b7916a78Sdrh ** is set.
1210b7916a78Sdrh */
1211b7916a78Sdrh void sqlite3ExprListSetSpan(
1212b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1213b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
1214b7916a78Sdrh   ExprSpan *pSpan         /* The span to be added */
1215b7916a78Sdrh ){
1216b7916a78Sdrh   sqlite3 *db = pParse->db;
1217b7916a78Sdrh   assert( pList!=0 || db->mallocFailed!=0 );
1218b7916a78Sdrh   if( pList ){
1219b7916a78Sdrh     struct ExprList_item *pItem = &pList->a[pList->nExpr-1];
1220b7916a78Sdrh     assert( pList->nExpr>0 );
1221b7916a78Sdrh     assert( db->mallocFailed || pItem->pExpr==pSpan->pExpr );
1222b7916a78Sdrh     sqlite3DbFree(db, pItem->zSpan);
1223b7916a78Sdrh     pItem->zSpan = sqlite3DbStrNDup(db, (char*)pSpan->zStart,
1224cf697396Sshane                                     (int)(pSpan->zEnd - pSpan->zStart));
1225b7916a78Sdrh   }
1226b7916a78Sdrh }
1227b7916a78Sdrh 
1228b7916a78Sdrh /*
12297a15a4beSdanielk1977 ** If the expression list pEList contains more than iLimit elements,
12307a15a4beSdanielk1977 ** leave an error message in pParse.
12317a15a4beSdanielk1977 */
12327a15a4beSdanielk1977 void sqlite3ExprListCheckLength(
12337a15a4beSdanielk1977   Parse *pParse,
12347a15a4beSdanielk1977   ExprList *pEList,
12357a15a4beSdanielk1977   const char *zObject
12367a15a4beSdanielk1977 ){
1237b1a6c3c1Sdrh   int mx = pParse->db->aLimit[SQLITE_LIMIT_COLUMN];
1238c5499befSdrh   testcase( pEList && pEList->nExpr==mx );
1239c5499befSdrh   testcase( pEList && pEList->nExpr==mx+1 );
1240b1a6c3c1Sdrh   if( pEList && pEList->nExpr>mx ){
12417a15a4beSdanielk1977     sqlite3ErrorMsg(pParse, "too many columns in %s", zObject);
12427a15a4beSdanielk1977   }
12437a15a4beSdanielk1977 }
12447a15a4beSdanielk1977 
12457a15a4beSdanielk1977 /*
1246a76b5dfcSdrh ** Delete an entire expression list.
1247a76b5dfcSdrh */
1248633e6d57Sdrh void sqlite3ExprListDelete(sqlite3 *db, ExprList *pList){
1249a76b5dfcSdrh   int i;
1250be5c89acSdrh   struct ExprList_item *pItem;
1251a76b5dfcSdrh   if( pList==0 ) return;
1252d872bb18Sdrh   assert( pList->a!=0 || pList->nExpr==0 );
1253be5c89acSdrh   for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
1254633e6d57Sdrh     sqlite3ExprDelete(db, pItem->pExpr);
1255633e6d57Sdrh     sqlite3DbFree(db, pItem->zName);
1256b7916a78Sdrh     sqlite3DbFree(db, pItem->zSpan);
1257a76b5dfcSdrh   }
1258633e6d57Sdrh   sqlite3DbFree(db, pList->a);
1259633e6d57Sdrh   sqlite3DbFree(db, pList);
1260a76b5dfcSdrh }
1261a76b5dfcSdrh 
1262a76b5dfcSdrh /*
12632308ed38Sdrh ** Return the bitwise-OR of all Expr.flags fields in the given
12642308ed38Sdrh ** ExprList.
1265885a5b03Sdrh */
12662308ed38Sdrh u32 sqlite3ExprListFlags(const ExprList *pList){
1267885a5b03Sdrh   int i;
12682308ed38Sdrh   u32 m = 0;
12692308ed38Sdrh   if( pList ){
1270885a5b03Sdrh     for(i=0; i<pList->nExpr; i++){
1271d0c73053Sdrh        Expr *pExpr = pList->a[i].pExpr;
12720a96931bSdrh        if( ALWAYS(pExpr) ) m |= pExpr->flags;
1273885a5b03Sdrh     }
12742308ed38Sdrh   }
12752308ed38Sdrh   return m;
1276885a5b03Sdrh }
1277885a5b03Sdrh 
1278885a5b03Sdrh /*
1279059b2d50Sdrh ** These routines are Walker callbacks used to check expressions to
1280059b2d50Sdrh ** see if they are "constant" for some definition of constant.  The
1281059b2d50Sdrh ** Walker.eCode value determines the type of "constant" we are looking
1282059b2d50Sdrh ** for.
128373b211abSdrh **
12847d10d5a6Sdrh ** These callback routines are used to implement the following:
1285626a879aSdrh **
1286059b2d50Sdrh **     sqlite3ExprIsConstant()                  pWalker->eCode==1
1287059b2d50Sdrh **     sqlite3ExprIsConstantNotJoin()           pWalker->eCode==2
1288fcb9f4f3Sdrh **     sqlite3ExprIsTableConstant()             pWalker->eCode==3
1289059b2d50Sdrh **     sqlite3ExprIsConstantOrFunction()        pWalker->eCode==4 or 5
1290059b2d50Sdrh **
1291059b2d50Sdrh ** In all cases, the callbacks set Walker.eCode=0 and abort if the expression
1292059b2d50Sdrh ** is found to not be a constant.
129387abf5c0Sdrh **
1294feada2dfSdrh ** The sqlite3ExprIsConstantOrFunction() is used for evaluating expressions
1295059b2d50Sdrh ** in a CREATE TABLE statement.  The Walker.eCode value is 5 when parsing
1296059b2d50Sdrh ** an existing schema and 4 when processing a new statement.  A bound
1297feada2dfSdrh ** parameter raises an error for new statements, but is silently converted
1298feada2dfSdrh ** to NULL for existing schemas.  This allows sqlite_master tables that
1299feada2dfSdrh ** contain a bound parameter because they were generated by older versions
1300feada2dfSdrh ** of SQLite to be parsed by newer versions of SQLite without raising a
1301feada2dfSdrh ** malformed schema error.
1302626a879aSdrh */
13037d10d5a6Sdrh static int exprNodeIsConstant(Walker *pWalker, Expr *pExpr){
1304626a879aSdrh 
1305059b2d50Sdrh   /* If pWalker->eCode is 2 then any term of the expression that comes from
1306059b2d50Sdrh   ** the ON or USING clauses of a left join disqualifies the expression
13070a168377Sdrh   ** from being considered constant. */
1308059b2d50Sdrh   if( pWalker->eCode==2 && ExprHasProperty(pExpr, EP_FromJoin) ){
1309059b2d50Sdrh     pWalker->eCode = 0;
13107d10d5a6Sdrh     return WRC_Abort;
13110a168377Sdrh   }
13120a168377Sdrh 
1313626a879aSdrh   switch( pExpr->op ){
1314eb55bd2fSdrh     /* Consider functions to be constant if all their arguments are constant
1315059b2d50Sdrh     ** and either pWalker->eCode==4 or 5 or the function has the
1316059b2d50Sdrh     ** SQLITE_FUNC_CONST flag. */
1317eb55bd2fSdrh     case TK_FUNCTION:
131863f84573Sdrh       if( pWalker->eCode>=4 || ExprHasProperty(pExpr,EP_ConstFunc) ){
1319b1fba286Sdrh         return WRC_Continue;
1320059b2d50Sdrh       }else{
1321059b2d50Sdrh         pWalker->eCode = 0;
1322059b2d50Sdrh         return WRC_Abort;
1323b1fba286Sdrh       }
1324626a879aSdrh     case TK_ID:
1325626a879aSdrh     case TK_COLUMN:
1326626a879aSdrh     case TK_AGG_FUNCTION:
132713449892Sdrh     case TK_AGG_COLUMN:
1328c5499befSdrh       testcase( pExpr->op==TK_ID );
1329c5499befSdrh       testcase( pExpr->op==TK_COLUMN );
1330c5499befSdrh       testcase( pExpr->op==TK_AGG_FUNCTION );
1331c5499befSdrh       testcase( pExpr->op==TK_AGG_COLUMN );
1332059b2d50Sdrh       if( pWalker->eCode==3 && pExpr->iTable==pWalker->u.iCur ){
1333059b2d50Sdrh         return WRC_Continue;
1334059b2d50Sdrh       }else{
1335059b2d50Sdrh         pWalker->eCode = 0;
13367d10d5a6Sdrh         return WRC_Abort;
1337059b2d50Sdrh       }
1338feada2dfSdrh     case TK_VARIABLE:
1339059b2d50Sdrh       if( pWalker->eCode==5 ){
1340feada2dfSdrh         /* Silently convert bound parameters that appear inside of CREATE
1341feada2dfSdrh         ** statements into a NULL when parsing the CREATE statement text out
1342feada2dfSdrh         ** of the sqlite_master table */
1343feada2dfSdrh         pExpr->op = TK_NULL;
1344059b2d50Sdrh       }else if( pWalker->eCode==4 ){
1345feada2dfSdrh         /* A bound parameter in a CREATE statement that originates from
1346feada2dfSdrh         ** sqlite3_prepare() causes an error */
1347059b2d50Sdrh         pWalker->eCode = 0;
1348feada2dfSdrh         return WRC_Abort;
1349feada2dfSdrh       }
1350feada2dfSdrh       /* Fall through */
1351626a879aSdrh     default:
1352b74b1017Sdrh       testcase( pExpr->op==TK_SELECT ); /* selectNodeIsConstant will disallow */
1353b74b1017Sdrh       testcase( pExpr->op==TK_EXISTS ); /* selectNodeIsConstant will disallow */
13547d10d5a6Sdrh       return WRC_Continue;
1355626a879aSdrh   }
1356626a879aSdrh }
135762c14b34Sdanielk1977 static int selectNodeIsConstant(Walker *pWalker, Select *NotUsed){
135862c14b34Sdanielk1977   UNUSED_PARAMETER(NotUsed);
1359059b2d50Sdrh   pWalker->eCode = 0;
13607d10d5a6Sdrh   return WRC_Abort;
13617d10d5a6Sdrh }
1362059b2d50Sdrh static int exprIsConst(Expr *p, int initFlag, int iCur){
13637d10d5a6Sdrh   Walker w;
1364aa87f9a6Sdrh   memset(&w, 0, sizeof(w));
1365059b2d50Sdrh   w.eCode = initFlag;
13667d10d5a6Sdrh   w.xExprCallback = exprNodeIsConstant;
13677d10d5a6Sdrh   w.xSelectCallback = selectNodeIsConstant;
1368059b2d50Sdrh   w.u.iCur = iCur;
13697d10d5a6Sdrh   sqlite3WalkExpr(&w, p);
1370059b2d50Sdrh   return w.eCode;
13717d10d5a6Sdrh }
1372626a879aSdrh 
1373626a879aSdrh /*
1374059b2d50Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
1375eb55bd2fSdrh ** and 0 if it involves variables or function calls.
13762398937bSdrh **
13772398937bSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
13782398937bSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
13792398937bSdrh ** a constant.
1380fef5208cSdrh */
13814adee20fSdanielk1977 int sqlite3ExprIsConstant(Expr *p){
1382059b2d50Sdrh   return exprIsConst(p, 1, 0);
1383fef5208cSdrh }
1384fef5208cSdrh 
1385fef5208cSdrh /*
1386059b2d50Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
13870a168377Sdrh ** that does no originate from the ON or USING clauses of a join.
13880a168377Sdrh ** Return 0 if it involves variables or function calls or terms from
13890a168377Sdrh ** an ON or USING clause.
13900a168377Sdrh */
13910a168377Sdrh int sqlite3ExprIsConstantNotJoin(Expr *p){
1392059b2d50Sdrh   return exprIsConst(p, 2, 0);
13930a168377Sdrh }
13940a168377Sdrh 
13950a168377Sdrh /*
1396fcb9f4f3Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
1397059b2d50Sdrh ** for any single row of the table with cursor iCur.  In other words, the
1398059b2d50Sdrh ** expression must not refer to any non-deterministic function nor any
1399059b2d50Sdrh ** table other than iCur.
1400059b2d50Sdrh */
1401059b2d50Sdrh int sqlite3ExprIsTableConstant(Expr *p, int iCur){
1402059b2d50Sdrh   return exprIsConst(p, 3, iCur);
1403059b2d50Sdrh }
1404059b2d50Sdrh 
1405059b2d50Sdrh /*
1406059b2d50Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
1407eb55bd2fSdrh ** or a function call with constant arguments.  Return and 0 if there
1408eb55bd2fSdrh ** are any variables.
1409eb55bd2fSdrh **
1410eb55bd2fSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
1411eb55bd2fSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
1412eb55bd2fSdrh ** a constant.
1413eb55bd2fSdrh */
1414feada2dfSdrh int sqlite3ExprIsConstantOrFunction(Expr *p, u8 isInit){
1415feada2dfSdrh   assert( isInit==0 || isInit==1 );
1416059b2d50Sdrh   return exprIsConst(p, 4+isInit, 0);
1417eb55bd2fSdrh }
1418eb55bd2fSdrh 
1419eb55bd2fSdrh /*
142073b211abSdrh ** If the expression p codes a constant integer that is small enough
1421202b2df7Sdrh ** to fit in a 32-bit integer, return 1 and put the value of the integer
1422202b2df7Sdrh ** in *pValue.  If the expression is not an integer or if it is too big
1423202b2df7Sdrh ** to fit in a signed 32-bit integer, return 0 and leave *pValue unchanged.
1424e4de1febSdrh */
14254adee20fSdanielk1977 int sqlite3ExprIsInteger(Expr *p, int *pValue){
142692b01d53Sdrh   int rc = 0;
1427cd92e84dSdrh 
1428cd92e84dSdrh   /* If an expression is an integer literal that fits in a signed 32-bit
1429cd92e84dSdrh   ** integer, then the EP_IntValue flag will have already been set */
1430cd92e84dSdrh   assert( p->op!=TK_INTEGER || (p->flags & EP_IntValue)!=0
1431cd92e84dSdrh            || sqlite3GetInt32(p->u.zToken, &rc)==0 );
1432cd92e84dSdrh 
143392b01d53Sdrh   if( p->flags & EP_IntValue ){
143433e619fcSdrh     *pValue = p->u.iValue;
1435e4de1febSdrh     return 1;
1436e4de1febSdrh   }
143792b01d53Sdrh   switch( p->op ){
14384b59ab5eSdrh     case TK_UPLUS: {
143992b01d53Sdrh       rc = sqlite3ExprIsInteger(p->pLeft, pValue);
1440f6e369a1Sdrh       break;
14414b59ab5eSdrh     }
1442e4de1febSdrh     case TK_UMINUS: {
1443e4de1febSdrh       int v;
14444adee20fSdanielk1977       if( sqlite3ExprIsInteger(p->pLeft, &v) ){
1445f6418891Smistachkin         assert( v!=(-2147483647-1) );
1446e4de1febSdrh         *pValue = -v;
144792b01d53Sdrh         rc = 1;
1448e4de1febSdrh       }
1449e4de1febSdrh       break;
1450e4de1febSdrh     }
1451e4de1febSdrh     default: break;
1452e4de1febSdrh   }
145392b01d53Sdrh   return rc;
1454e4de1febSdrh }
1455e4de1febSdrh 
1456e4de1febSdrh /*
1457039fc32eSdrh ** Return FALSE if there is no chance that the expression can be NULL.
1458039fc32eSdrh **
1459039fc32eSdrh ** If the expression might be NULL or if the expression is too complex
1460039fc32eSdrh ** to tell return TRUE.
1461039fc32eSdrh **
1462039fc32eSdrh ** This routine is used as an optimization, to skip OP_IsNull opcodes
1463039fc32eSdrh ** when we know that a value cannot be NULL.  Hence, a false positive
1464039fc32eSdrh ** (returning TRUE when in fact the expression can never be NULL) might
1465039fc32eSdrh ** be a small performance hit but is otherwise harmless.  On the other
1466039fc32eSdrh ** hand, a false negative (returning FALSE when the result could be NULL)
1467039fc32eSdrh ** will likely result in an incorrect answer.  So when in doubt, return
1468039fc32eSdrh ** TRUE.
1469039fc32eSdrh */
1470039fc32eSdrh int sqlite3ExprCanBeNull(const Expr *p){
1471039fc32eSdrh   u8 op;
1472cd7f457eSdrh   while( p->op==TK_UPLUS || p->op==TK_UMINUS ){ p = p->pLeft; }
1473039fc32eSdrh   op = p->op;
1474039fc32eSdrh   if( op==TK_REGISTER ) op = p->op2;
1475039fc32eSdrh   switch( op ){
1476039fc32eSdrh     case TK_INTEGER:
1477039fc32eSdrh     case TK_STRING:
1478039fc32eSdrh     case TK_FLOAT:
1479039fc32eSdrh     case TK_BLOB:
1480039fc32eSdrh       return 0;
14817248a8b2Sdrh     case TK_COLUMN:
14827248a8b2Sdrh       assert( p->pTab!=0 );
148372673a24Sdrh       return ExprHasProperty(p, EP_CanBeNull) ||
148472673a24Sdrh              (p->iColumn>=0 && p->pTab->aCol[p->iColumn].notNull==0);
1485039fc32eSdrh     default:
1486039fc32eSdrh       return 1;
1487039fc32eSdrh   }
1488039fc32eSdrh }
1489039fc32eSdrh 
1490039fc32eSdrh /*
1491039fc32eSdrh ** Return TRUE if the given expression is a constant which would be
1492039fc32eSdrh ** unchanged by OP_Affinity with the affinity given in the second
1493039fc32eSdrh ** argument.
1494039fc32eSdrh **
1495039fc32eSdrh ** This routine is used to determine if the OP_Affinity operation
1496039fc32eSdrh ** can be omitted.  When in doubt return FALSE.  A false negative
1497039fc32eSdrh ** is harmless.  A false positive, however, can result in the wrong
1498039fc32eSdrh ** answer.
1499039fc32eSdrh */
1500039fc32eSdrh int sqlite3ExprNeedsNoAffinityChange(const Expr *p, char aff){
1501039fc32eSdrh   u8 op;
150205883a34Sdrh   if( aff==SQLITE_AFF_BLOB ) return 1;
1503cd7f457eSdrh   while( p->op==TK_UPLUS || p->op==TK_UMINUS ){ p = p->pLeft; }
1504039fc32eSdrh   op = p->op;
1505039fc32eSdrh   if( op==TK_REGISTER ) op = p->op2;
1506039fc32eSdrh   switch( op ){
1507039fc32eSdrh     case TK_INTEGER: {
1508039fc32eSdrh       return aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC;
1509039fc32eSdrh     }
1510039fc32eSdrh     case TK_FLOAT: {
1511039fc32eSdrh       return aff==SQLITE_AFF_REAL || aff==SQLITE_AFF_NUMERIC;
1512039fc32eSdrh     }
1513039fc32eSdrh     case TK_STRING: {
1514039fc32eSdrh       return aff==SQLITE_AFF_TEXT;
1515039fc32eSdrh     }
1516039fc32eSdrh     case TK_BLOB: {
1517039fc32eSdrh       return 1;
1518039fc32eSdrh     }
15192f2855b6Sdrh     case TK_COLUMN: {
152088376ca7Sdrh       assert( p->iTable>=0 );  /* p cannot be part of a CHECK constraint */
152188376ca7Sdrh       return p->iColumn<0
15222f2855b6Sdrh           && (aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC);
15232f2855b6Sdrh     }
1524039fc32eSdrh     default: {
1525039fc32eSdrh       return 0;
1526039fc32eSdrh     }
1527039fc32eSdrh   }
1528039fc32eSdrh }
1529039fc32eSdrh 
1530039fc32eSdrh /*
1531c4a3c779Sdrh ** Return TRUE if the given string is a row-id column name.
1532c4a3c779Sdrh */
15334adee20fSdanielk1977 int sqlite3IsRowid(const char *z){
15344adee20fSdanielk1977   if( sqlite3StrICmp(z, "_ROWID_")==0 ) return 1;
15354adee20fSdanielk1977   if( sqlite3StrICmp(z, "ROWID")==0 ) return 1;
15364adee20fSdanielk1977   if( sqlite3StrICmp(z, "OID")==0 ) return 1;
1537c4a3c779Sdrh   return 0;
1538c4a3c779Sdrh }
1539c4a3c779Sdrh 
15409a96b668Sdanielk1977 /*
1541b74b1017Sdrh ** Return true if we are able to the IN operator optimization on a
1542b74b1017Sdrh ** query of the form
1543b287f4b6Sdrh **
1544b74b1017Sdrh **       x IN (SELECT ...)
1545b287f4b6Sdrh **
1546b74b1017Sdrh ** Where the SELECT... clause is as specified by the parameter to this
1547b74b1017Sdrh ** routine.
1548b74b1017Sdrh **
1549b74b1017Sdrh ** The Select object passed in has already been preprocessed and no
1550b74b1017Sdrh ** errors have been found.
1551b287f4b6Sdrh */
1552b287f4b6Sdrh #ifndef SQLITE_OMIT_SUBQUERY
1553b287f4b6Sdrh static int isCandidateForInOpt(Select *p){
1554b287f4b6Sdrh   SrcList *pSrc;
1555b287f4b6Sdrh   ExprList *pEList;
1556b287f4b6Sdrh   Table *pTab;
1557b287f4b6Sdrh   if( p==0 ) return 0;                   /* right-hand side of IN is SELECT */
1558b287f4b6Sdrh   if( p->pPrior ) return 0;              /* Not a compound SELECT */
15597d10d5a6Sdrh   if( p->selFlags & (SF_Distinct|SF_Aggregate) ){
1560b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
1561b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
15627d10d5a6Sdrh     return 0; /* No DISTINCT keyword and no aggregate functions */
15637d10d5a6Sdrh   }
1564b74b1017Sdrh   assert( p->pGroupBy==0 );              /* Has no GROUP BY clause */
1565b287f4b6Sdrh   if( p->pLimit ) return 0;              /* Has no LIMIT clause */
1566b74b1017Sdrh   assert( p->pOffset==0 );               /* No LIMIT means no OFFSET */
1567b287f4b6Sdrh   if( p->pWhere ) return 0;              /* Has no WHERE clause */
1568b287f4b6Sdrh   pSrc = p->pSrc;
1569d1fa7bcaSdrh   assert( pSrc!=0 );
1570d1fa7bcaSdrh   if( pSrc->nSrc!=1 ) return 0;          /* Single term in FROM clause */
1571b74b1017Sdrh   if( pSrc->a[0].pSelect ) return 0;     /* FROM is not a subquery or view */
1572b287f4b6Sdrh   pTab = pSrc->a[0].pTab;
1573b74b1017Sdrh   if( NEVER(pTab==0) ) return 0;
1574b74b1017Sdrh   assert( pTab->pSelect==0 );            /* FROM clause is not a view */
1575b287f4b6Sdrh   if( IsVirtual(pTab) ) return 0;        /* FROM clause not a virtual table */
1576b287f4b6Sdrh   pEList = p->pEList;
1577b287f4b6Sdrh   if( pEList->nExpr!=1 ) return 0;       /* One column in the result set */
1578b287f4b6Sdrh   if( pEList->a[0].pExpr->op!=TK_COLUMN ) return 0; /* Result is a column */
1579b287f4b6Sdrh   return 1;
1580b287f4b6Sdrh }
1581b287f4b6Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
1582b287f4b6Sdrh 
1583b287f4b6Sdrh /*
15841d8cb21fSdan ** Code an OP_Once instruction and allocate space for its flag. Return the
15851d8cb21fSdan ** address of the new instruction.
15861d8cb21fSdan */
15871d8cb21fSdan int sqlite3CodeOnce(Parse *pParse){
15881d8cb21fSdan   Vdbe *v = sqlite3GetVdbe(pParse);      /* Virtual machine being coded */
15897d176105Sdrh   return sqlite3VdbeAddOp1(v, OP_Once, pParse->nOnce++);
15901d8cb21fSdan }
15911d8cb21fSdan 
15921d8cb21fSdan /*
15934c259e9fSdrh ** Generate code that checks the left-most column of index table iCur to see if
15944c259e9fSdrh ** it contains any NULL entries.  Cause the register at regHasNull to be set
15956be515ebSdrh ** to a non-NULL value if iCur contains no NULLs.  Cause register regHasNull
15966be515ebSdrh ** to be set to NULL if iCur contains one or more NULL values.
15976be515ebSdrh */
15986be515ebSdrh static void sqlite3SetHasNullFlag(Vdbe *v, int iCur, int regHasNull){
15996be515ebSdrh   int j1;
16006be515ebSdrh   sqlite3VdbeAddOp2(v, OP_Integer, 0, regHasNull);
16016be515ebSdrh   j1 = sqlite3VdbeAddOp1(v, OP_Rewind, iCur); VdbeCoverage(v);
16026be515ebSdrh   sqlite3VdbeAddOp3(v, OP_Column, iCur, 0, regHasNull);
16036be515ebSdrh   sqlite3VdbeChangeP5(v, OPFLAG_TYPEOFARG);
16044c259e9fSdrh   VdbeComment((v, "first_entry_in(%d)", iCur));
16056be515ebSdrh   sqlite3VdbeJumpHere(v, j1);
16066be515ebSdrh }
16076be515ebSdrh 
1608bb53ecb1Sdrh 
1609bb53ecb1Sdrh #ifndef SQLITE_OMIT_SUBQUERY
1610bb53ecb1Sdrh /*
1611bb53ecb1Sdrh ** The argument is an IN operator with a list (not a subquery) on the
1612bb53ecb1Sdrh ** right-hand side.  Return TRUE if that list is constant.
1613bb53ecb1Sdrh */
1614bb53ecb1Sdrh static int sqlite3InRhsIsConstant(Expr *pIn){
1615bb53ecb1Sdrh   Expr *pLHS;
1616bb53ecb1Sdrh   int res;
1617bb53ecb1Sdrh   assert( !ExprHasProperty(pIn, EP_xIsSelect) );
1618bb53ecb1Sdrh   pLHS = pIn->pLeft;
1619bb53ecb1Sdrh   pIn->pLeft = 0;
1620bb53ecb1Sdrh   res = sqlite3ExprIsConstant(pIn);
1621bb53ecb1Sdrh   pIn->pLeft = pLHS;
1622bb53ecb1Sdrh   return res;
1623bb53ecb1Sdrh }
1624bb53ecb1Sdrh #endif
1625bb53ecb1Sdrh 
16266be515ebSdrh /*
16279a96b668Sdanielk1977 ** This function is used by the implementation of the IN (...) operator.
1628d4305ca6Sdrh ** The pX parameter is the expression on the RHS of the IN operator, which
1629d4305ca6Sdrh ** might be either a list of expressions or a subquery.
16309a96b668Sdanielk1977 **
1631d4305ca6Sdrh ** The job of this routine is to find or create a b-tree object that can
1632d4305ca6Sdrh ** be used either to test for membership in the RHS set or to iterate through
1633d4305ca6Sdrh ** all members of the RHS set, skipping duplicates.
1634d4305ca6Sdrh **
16353a85625dSdrh ** A cursor is opened on the b-tree object that is the RHS of the IN operator
1636d4305ca6Sdrh ** and pX->iTable is set to the index of that cursor.
1637d4305ca6Sdrh **
1638b74b1017Sdrh ** The returned value of this function indicates the b-tree type, as follows:
16399a96b668Sdanielk1977 **
16409a96b668Sdanielk1977 **   IN_INDEX_ROWID      - The cursor was opened on a database table.
16411ccce449Sdrh **   IN_INDEX_INDEX_ASC  - The cursor was opened on an ascending index.
16421ccce449Sdrh **   IN_INDEX_INDEX_DESC - The cursor was opened on a descending index.
16439a96b668Sdanielk1977 **   IN_INDEX_EPH        - The cursor was opened on a specially created and
16449a96b668Sdanielk1977 **                         populated epheremal table.
1645bb53ecb1Sdrh **   IN_INDEX_NOOP       - No cursor was allocated.  The IN operator must be
1646bb53ecb1Sdrh **                         implemented as a sequence of comparisons.
16479a96b668Sdanielk1977 **
1648d4305ca6Sdrh ** An existing b-tree might be used if the RHS expression pX is a simple
1649d4305ca6Sdrh ** subquery such as:
16509a96b668Sdanielk1977 **
16519a96b668Sdanielk1977 **     SELECT <column> FROM <table>
16529a96b668Sdanielk1977 **
1653d4305ca6Sdrh ** If the RHS of the IN operator is a list or a more complex subquery, then
1654d4305ca6Sdrh ** an ephemeral table might need to be generated from the RHS and then
165560ec914cSpeter.d.reid ** pX->iTable made to point to the ephemeral table instead of an
1656d4305ca6Sdrh ** existing table.
1657d4305ca6Sdrh **
16583a85625dSdrh ** The inFlags parameter must contain exactly one of the bits
16593a85625dSdrh ** IN_INDEX_MEMBERSHIP or IN_INDEX_LOOP.  If inFlags contains
16603a85625dSdrh ** IN_INDEX_MEMBERSHIP, then the generated table will be used for a
16613a85625dSdrh ** fast membership test.  When the IN_INDEX_LOOP bit is set, the
16623a85625dSdrh ** IN index will be used to loop over all values of the RHS of the
16633a85625dSdrh ** IN operator.
16643a85625dSdrh **
16653a85625dSdrh ** When IN_INDEX_LOOP is used (and the b-tree will be used to iterate
16663a85625dSdrh ** through the set members) then the b-tree must not contain duplicates.
16673a85625dSdrh ** An epheremal table must be used unless the selected <column> is guaranteed
16689a96b668Sdanielk1977 ** to be unique - either because it is an INTEGER PRIMARY KEY or it
1669b74b1017Sdrh ** has a UNIQUE constraint or UNIQUE index.
16700cdc022eSdanielk1977 **
16713a85625dSdrh ** When IN_INDEX_MEMBERSHIP is used (and the b-tree will be used
16723a85625dSdrh ** for fast set membership tests) then an epheremal table must
16730cdc022eSdanielk1977 ** be used unless <column> is an INTEGER PRIMARY KEY or an index can
16740cdc022eSdanielk1977 ** be found with <column> as its left-most column.
16750cdc022eSdanielk1977 **
1676bb53ecb1Sdrh ** If the IN_INDEX_NOOP_OK and IN_INDEX_MEMBERSHIP are both set and
1677bb53ecb1Sdrh ** if the RHS of the IN operator is a list (not a subquery) then this
1678bb53ecb1Sdrh ** routine might decide that creating an ephemeral b-tree for membership
1679bb53ecb1Sdrh ** testing is too expensive and return IN_INDEX_NOOP.  In that case, the
1680bb53ecb1Sdrh ** calling routine should implement the IN operator using a sequence
1681bb53ecb1Sdrh ** of Eq or Ne comparison operations.
1682bb53ecb1Sdrh **
1683b74b1017Sdrh ** When the b-tree is being used for membership tests, the calling function
16843a85625dSdrh ** might need to know whether or not the RHS side of the IN operator
1685e21a6e1dSdrh ** contains a NULL.  If prRhsHasNull is not a NULL pointer and
16863a85625dSdrh ** if there is any chance that the (...) might contain a NULL value at
16870cdc022eSdanielk1977 ** runtime, then a register is allocated and the register number written
1688e21a6e1dSdrh ** to *prRhsHasNull. If there is no chance that the (...) contains a
1689e21a6e1dSdrh ** NULL value, then *prRhsHasNull is left unchanged.
16900cdc022eSdanielk1977 **
1691e21a6e1dSdrh ** If a register is allocated and its location stored in *prRhsHasNull, then
16926be515ebSdrh ** the value in that register will be NULL if the b-tree contains one or more
16936be515ebSdrh ** NULL values, and it will be some non-NULL value if the b-tree contains no
16946be515ebSdrh ** NULL values.
16959a96b668Sdanielk1977 */
1696284f4acaSdanielk1977 #ifndef SQLITE_OMIT_SUBQUERY
1697e21a6e1dSdrh int sqlite3FindInIndex(Parse *pParse, Expr *pX, u32 inFlags, int *prRhsHasNull){
1698b74b1017Sdrh   Select *p;                            /* SELECT to the right of IN operator */
1699b74b1017Sdrh   int eType = 0;                        /* Type of RHS table. IN_INDEX_* */
1700b74b1017Sdrh   int iTab = pParse->nTab++;            /* Cursor of the RHS table */
17013a85625dSdrh   int mustBeUnique;                     /* True if RHS must be unique */
1702b8475df8Sdrh   Vdbe *v = sqlite3GetVdbe(pParse);     /* Virtual machine being coded */
17039a96b668Sdanielk1977 
17041450bc6eSdrh   assert( pX->op==TK_IN );
17053a85625dSdrh   mustBeUnique = (inFlags & IN_INDEX_LOOP)!=0;
17061450bc6eSdrh 
1707b74b1017Sdrh   /* Check to see if an existing table or index can be used to
1708b74b1017Sdrh   ** satisfy the query.  This is preferable to generating a new
1709b74b1017Sdrh   ** ephemeral table.
17109a96b668Sdanielk1977   */
17116ab3a2ecSdanielk1977   p = (ExprHasProperty(pX, EP_xIsSelect) ? pX->x.pSelect : 0);
1712311efc70Sdrh   if( pParse->nErr==0 && isCandidateForInOpt(p) ){
1713e1fb65a0Sdanielk1977     sqlite3 *db = pParse->db;              /* Database connection */
1714b07028f7Sdrh     Table *pTab;                           /* Table <table>. */
1715b07028f7Sdrh     Expr *pExpr;                           /* Expression <column> */
1716bbbdc83bSdrh     i16 iCol;                              /* Index of column <column> */
1717bbbdc83bSdrh     i16 iDb;                               /* Database idx for pTab */
1718e1fb65a0Sdanielk1977 
1719b07028f7Sdrh     assert( p );                        /* Because of isCandidateForInOpt(p) */
1720b07028f7Sdrh     assert( p->pEList!=0 );             /* Because of isCandidateForInOpt(p) */
1721b07028f7Sdrh     assert( p->pEList->a[0].pExpr!=0 ); /* Because of isCandidateForInOpt(p) */
1722b07028f7Sdrh     assert( p->pSrc!=0 );               /* Because of isCandidateForInOpt(p) */
1723b07028f7Sdrh     pTab = p->pSrc->a[0].pTab;
1724b07028f7Sdrh     pExpr = p->pEList->a[0].pExpr;
1725bbbdc83bSdrh     iCol = (i16)pExpr->iColumn;
1726b07028f7Sdrh 
1727b22f7c83Sdrh     /* Code an OP_Transaction and OP_TableLock for <table>. */
1728e1fb65a0Sdanielk1977     iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
1729e1fb65a0Sdanielk1977     sqlite3CodeVerifySchema(pParse, iDb);
1730e1fb65a0Sdanielk1977     sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
17319a96b668Sdanielk1977 
17329a96b668Sdanielk1977     /* This function is only called from two places. In both cases the vdbe
17339a96b668Sdanielk1977     ** has already been allocated. So assume sqlite3GetVdbe() is always
17349a96b668Sdanielk1977     ** successful here.
17359a96b668Sdanielk1977     */
17369a96b668Sdanielk1977     assert(v);
17379a96b668Sdanielk1977     if( iCol<0 ){
17387d176105Sdrh       int iAddr = sqlite3CodeOnce(pParse);
17397d176105Sdrh       VdbeCoverage(v);
17409a96b668Sdanielk1977 
17419a96b668Sdanielk1977       sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
17429a96b668Sdanielk1977       eType = IN_INDEX_ROWID;
17439a96b668Sdanielk1977 
17449a96b668Sdanielk1977       sqlite3VdbeJumpHere(v, iAddr);
17459a96b668Sdanielk1977     }else{
1746e1fb65a0Sdanielk1977       Index *pIdx;                         /* Iterator variable */
1747e1fb65a0Sdanielk1977 
17489a96b668Sdanielk1977       /* The collation sequence used by the comparison. If an index is to
17499a96b668Sdanielk1977       ** be used in place of a temp-table, it must be ordered according
1750e1fb65a0Sdanielk1977       ** to this collation sequence.  */
17519a96b668Sdanielk1977       CollSeq *pReq = sqlite3BinaryCompareCollSeq(pParse, pX->pLeft, pExpr);
17529a96b668Sdanielk1977 
17539a96b668Sdanielk1977       /* Check that the affinity that will be used to perform the
17549a96b668Sdanielk1977       ** comparison is the same as the affinity of the column. If
17559a96b668Sdanielk1977       ** it is not, it is not possible to use any index.
17569a96b668Sdanielk1977       */
1757dbaee5e3Sdrh       int affinity_ok = sqlite3IndexAffinityOk(pX, pTab->aCol[iCol].affinity);
17589a96b668Sdanielk1977 
17599a96b668Sdanielk1977       for(pIdx=pTab->pIndex; pIdx && eType==0 && affinity_ok; pIdx=pIdx->pNext){
17609a96b668Sdanielk1977         if( (pIdx->aiColumn[0]==iCol)
1761b74b1017Sdrh          && sqlite3FindCollSeq(db, ENC(db), pIdx->azColl[0], 0)==pReq
17625f1d1d9cSdrh          && (!mustBeUnique || (pIdx->nKeyCol==1 && IsUniqueIndex(pIdx)))
17639a96b668Sdanielk1977         ){
17647d176105Sdrh           int iAddr = sqlite3CodeOnce(pParse); VdbeCoverage(v);
17652ec2fb22Sdrh           sqlite3VdbeAddOp3(v, OP_OpenRead, iTab, pIdx->tnum, iDb);
17662ec2fb22Sdrh           sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
1767207872a4Sdanielk1977           VdbeComment((v, "%s", pIdx->zName));
17681ccce449Sdrh           assert( IN_INDEX_INDEX_DESC == IN_INDEX_INDEX_ASC+1 );
17691ccce449Sdrh           eType = IN_INDEX_INDEX_ASC + pIdx->aSortOrder[0];
17709a96b668Sdanielk1977 
1771e21a6e1dSdrh           if( prRhsHasNull && !pTab->aCol[iCol].notNull ){
1772e21a6e1dSdrh             *prRhsHasNull = ++pParse->nMem;
17736be515ebSdrh             sqlite3SetHasNullFlag(v, iTab, *prRhsHasNull);
17740cdc022eSdanielk1977           }
1775552fd454Sdrh           sqlite3VdbeJumpHere(v, iAddr);
17769a96b668Sdanielk1977         }
17779a96b668Sdanielk1977       }
17789a96b668Sdanielk1977     }
17799a96b668Sdanielk1977   }
17809a96b668Sdanielk1977 
1781bb53ecb1Sdrh   /* If no preexisting index is available for the IN clause
1782bb53ecb1Sdrh   ** and IN_INDEX_NOOP is an allowed reply
1783bb53ecb1Sdrh   ** and the RHS of the IN operator is a list, not a subquery
1784bb53ecb1Sdrh   ** and the RHS is not contant or has two or fewer terms,
178560ec914cSpeter.d.reid   ** then it is not worth creating an ephemeral table to evaluate
1786bb53ecb1Sdrh   ** the IN operator so return IN_INDEX_NOOP.
1787bb53ecb1Sdrh   */
1788bb53ecb1Sdrh   if( eType==0
1789bb53ecb1Sdrh    && (inFlags & IN_INDEX_NOOP_OK)
1790bb53ecb1Sdrh    && !ExprHasProperty(pX, EP_xIsSelect)
1791bb53ecb1Sdrh    && (!sqlite3InRhsIsConstant(pX) || pX->x.pList->nExpr<=2)
1792bb53ecb1Sdrh   ){
1793bb53ecb1Sdrh     eType = IN_INDEX_NOOP;
1794bb53ecb1Sdrh   }
1795bb53ecb1Sdrh 
1796bb53ecb1Sdrh 
17979a96b668Sdanielk1977   if( eType==0 ){
17984387006cSdrh     /* Could not find an existing table or index to use as the RHS b-tree.
1799b74b1017Sdrh     ** We will have to generate an ephemeral table to do the job.
1800b74b1017Sdrh     */
18018e23daf3Sdrh     u32 savedNQueryLoop = pParse->nQueryLoop;
18020cdc022eSdanielk1977     int rMayHaveNull = 0;
180341a05b7bSdanielk1977     eType = IN_INDEX_EPH;
18043a85625dSdrh     if( inFlags & IN_INDEX_LOOP ){
18054a5acf8eSdrh       pParse->nQueryLoop = 0;
1806c5cd1249Sdrh       if( pX->pLeft->iColumn<0 && !ExprHasProperty(pX, EP_xIsSelect) ){
180741a05b7bSdanielk1977         eType = IN_INDEX_ROWID;
18080cdc022eSdanielk1977       }
1809e21a6e1dSdrh     }else if( prRhsHasNull ){
1810e21a6e1dSdrh       *prRhsHasNull = rMayHaveNull = ++pParse->nMem;
1811cf4d38aaSdrh     }
181241a05b7bSdanielk1977     sqlite3CodeSubselect(pParse, pX, rMayHaveNull, eType==IN_INDEX_ROWID);
1813cf4d38aaSdrh     pParse->nQueryLoop = savedNQueryLoop;
18149a96b668Sdanielk1977   }else{
18159a96b668Sdanielk1977     pX->iTable = iTab;
18169a96b668Sdanielk1977   }
18179a96b668Sdanielk1977   return eType;
18189a96b668Sdanielk1977 }
1819284f4acaSdanielk1977 #endif
1820626a879aSdrh 
1821626a879aSdrh /*
1822d4187c71Sdrh ** Generate code for scalar subqueries used as a subquery expression, EXISTS,
1823d4187c71Sdrh ** or IN operators.  Examples:
1824626a879aSdrh **
18259cbe6352Sdrh **     (SELECT a FROM b)          -- subquery
18269cbe6352Sdrh **     EXISTS (SELECT a FROM b)   -- EXISTS subquery
18279cbe6352Sdrh **     x IN (4,5,11)              -- IN operator with list on right-hand side
18289cbe6352Sdrh **     x IN (SELECT a FROM b)     -- IN operator with subquery on the right
1829fef5208cSdrh **
18309cbe6352Sdrh ** The pExpr parameter describes the expression that contains the IN
18319cbe6352Sdrh ** operator or subquery.
183241a05b7bSdanielk1977 **
183341a05b7bSdanielk1977 ** If parameter isRowid is non-zero, then expression pExpr is guaranteed
183441a05b7bSdanielk1977 ** to be of the form "<rowid> IN (?, ?, ?)", where <rowid> is a reference
183541a05b7bSdanielk1977 ** to some integer key column of a table B-Tree. In this case, use an
183641a05b7bSdanielk1977 ** intkey B-Tree to store the set of IN(...) values instead of the usual
183741a05b7bSdanielk1977 ** (slower) variable length keys B-Tree.
1838fd773cf9Sdrh **
1839fd773cf9Sdrh ** If rMayHaveNull is non-zero, that means that the operation is an IN
1840fd773cf9Sdrh ** (not a SELECT or EXISTS) and that the RHS might contains NULLs.
18413a85625dSdrh ** All this routine does is initialize the register given by rMayHaveNull
18423a85625dSdrh ** to NULL.  Calling routines will take care of changing this register
18433a85625dSdrh ** value to non-NULL if the RHS is NULL-free.
18441450bc6eSdrh **
18451450bc6eSdrh ** For a SELECT or EXISTS operator, return the register that holds the
18461450bc6eSdrh ** result.  For IN operators or if an error occurs, the return value is 0.
1847cce7d176Sdrh */
184851522cd3Sdrh #ifndef SQLITE_OMIT_SUBQUERY
18491450bc6eSdrh int sqlite3CodeSubselect(
1850fd773cf9Sdrh   Parse *pParse,          /* Parsing context */
1851fd773cf9Sdrh   Expr *pExpr,            /* The IN, SELECT, or EXISTS operator */
18526be515ebSdrh   int rHasNullFlag,       /* Register that records whether NULLs exist in RHS */
1853fd773cf9Sdrh   int isRowid             /* If true, LHS of IN operator is a rowid */
185441a05b7bSdanielk1977 ){
18556be515ebSdrh   int jmpIfDynamic = -1;                      /* One-time test address */
18561450bc6eSdrh   int rReg = 0;                           /* Register storing resulting */
1857b3bce662Sdanielk1977   Vdbe *v = sqlite3GetVdbe(pParse);
18581450bc6eSdrh   if( NEVER(v==0) ) return 0;
1859ceea3321Sdrh   sqlite3ExprCachePush(pParse);
1860fc976065Sdanielk1977 
186157dbd7b3Sdrh   /* This code must be run in its entirety every time it is encountered
186257dbd7b3Sdrh   ** if any of the following is true:
186357dbd7b3Sdrh   **
186457dbd7b3Sdrh   **    *  The right-hand side is a correlated subquery
186557dbd7b3Sdrh   **    *  The right-hand side is an expression list containing variables
186657dbd7b3Sdrh   **    *  We are inside a trigger
186757dbd7b3Sdrh   **
186857dbd7b3Sdrh   ** If all of the above are false, then we can run this code just once
186957dbd7b3Sdrh   ** save the results, and reuse the same result on subsequent invocations.
1870b3bce662Sdanielk1977   */
1871c5cd1249Sdrh   if( !ExprHasProperty(pExpr, EP_VarSelect) ){
18726be515ebSdrh     jmpIfDynamic = sqlite3CodeOnce(pParse); VdbeCoverage(v);
1873b3bce662Sdanielk1977   }
1874b3bce662Sdanielk1977 
18754a07e3dbSdan #ifndef SQLITE_OMIT_EXPLAIN
18764a07e3dbSdan   if( pParse->explain==2 ){
18774a07e3dbSdan     char *zMsg = sqlite3MPrintf(
18786be515ebSdrh         pParse->db, "EXECUTE %s%s SUBQUERY %d", jmpIfDynamic>=0?"":"CORRELATED ",
18794a07e3dbSdan         pExpr->op==TK_IN?"LIST":"SCALAR", pParse->iNextSelectId
18804a07e3dbSdan     );
18814a07e3dbSdan     sqlite3VdbeAddOp4(v, OP_Explain, pParse->iSelectId, 0, 0, zMsg, P4_DYNAMIC);
18824a07e3dbSdan   }
18834a07e3dbSdan #endif
18844a07e3dbSdan 
1885cce7d176Sdrh   switch( pExpr->op ){
1886fef5208cSdrh     case TK_IN: {
1887d4187c71Sdrh       char affinity;              /* Affinity of the LHS of the IN */
1888b9bb7c18Sdrh       int addr;                   /* Address of OP_OpenEphemeral instruction */
1889d4187c71Sdrh       Expr *pLeft = pExpr->pLeft; /* the LHS of the IN operator */
1890323df790Sdrh       KeyInfo *pKeyInfo = 0;      /* Key information */
1891d3d39e93Sdrh 
189241a05b7bSdanielk1977       affinity = sqlite3ExprAffinity(pLeft);
1893e014a838Sdanielk1977 
1894e014a838Sdanielk1977       /* Whether this is an 'x IN(SELECT...)' or an 'x IN(<exprlist>)'
18958cff69dfSdrh       ** expression it is handled the same way.  An ephemeral table is
1896e014a838Sdanielk1977       ** filled with single-field index keys representing the results
1897e014a838Sdanielk1977       ** from the SELECT or the <exprlist>.
1898fef5208cSdrh       **
1899e014a838Sdanielk1977       ** If the 'x' expression is a column value, or the SELECT...
1900e014a838Sdanielk1977       ** statement returns a column value, then the affinity of that
1901e014a838Sdanielk1977       ** column is used to build the index keys. If both 'x' and the
1902e014a838Sdanielk1977       ** SELECT... statement are columns, then numeric affinity is used
1903e014a838Sdanielk1977       ** if either column has NUMERIC or INTEGER affinity. If neither
1904e014a838Sdanielk1977       ** 'x' nor the SELECT... statement are columns, then numeric affinity
1905e014a838Sdanielk1977       ** is used.
1906fef5208cSdrh       */
1907832508b7Sdrh       pExpr->iTable = pParse->nTab++;
190841a05b7bSdanielk1977       addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, pExpr->iTable, !isRowid);
1909ad124329Sdrh       pKeyInfo = isRowid ? 0 : sqlite3KeyInfoAlloc(pParse->db, 1, 1);
1910e014a838Sdanielk1977 
19116ab3a2ecSdanielk1977       if( ExprHasProperty(pExpr, EP_xIsSelect) ){
1912e014a838Sdanielk1977         /* Case 1:     expr IN (SELECT ...)
1913e014a838Sdanielk1977         **
1914e014a838Sdanielk1977         ** Generate code to write the results of the select into the temporary
1915e014a838Sdanielk1977         ** table allocated and opened above.
1916e014a838Sdanielk1977         */
19174387006cSdrh         Select *pSelect = pExpr->x.pSelect;
19181013c932Sdrh         SelectDest dest;
1919be5c89acSdrh         ExprList *pEList;
19201013c932Sdrh 
192141a05b7bSdanielk1977         assert( !isRowid );
19221013c932Sdrh         sqlite3SelectDestInit(&dest, SRT_Set, pExpr->iTable);
19232b596da8Sdrh         dest.affSdst = (u8)affinity;
1924e014a838Sdanielk1977         assert( (pExpr->iTable&0x0000FFFF)==pExpr->iTable );
19254387006cSdrh         pSelect->iLimit = 0;
19264387006cSdrh         testcase( pSelect->selFlags & SF_Distinct );
1927812ea833Sdrh         testcase( pKeyInfo==0 ); /* Caused by OOM in sqlite3KeyInfoAlloc() */
19284387006cSdrh         if( sqlite3Select(pParse, pSelect, &dest) ){
19292ec2fb22Sdrh           sqlite3KeyInfoUnref(pKeyInfo);
19301450bc6eSdrh           return 0;
193194ccde58Sdrh         }
19324387006cSdrh         pEList = pSelect->pEList;
1933812ea833Sdrh         assert( pKeyInfo!=0 ); /* OOM will cause exit after sqlite3Select() */
19343535ec3eSdrh         assert( pEList!=0 );
19353535ec3eSdrh         assert( pEList->nExpr>0 );
19362ec2fb22Sdrh         assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
1937323df790Sdrh         pKeyInfo->aColl[0] = sqlite3BinaryCompareCollSeq(pParse, pExpr->pLeft,
1938be5c89acSdrh                                                          pEList->a[0].pExpr);
1939a7d2db17Sdrh       }else if( ALWAYS(pExpr->x.pList!=0) ){
1940fef5208cSdrh         /* Case 2:     expr IN (exprlist)
1941fef5208cSdrh         **
1942e014a838Sdanielk1977         ** For each expression, build an index key from the evaluation and
1943e014a838Sdanielk1977         ** store it in the temporary table. If <expr> is a column, then use
1944e014a838Sdanielk1977         ** that columns affinity when building index keys. If <expr> is not
1945e014a838Sdanielk1977         ** a column, use numeric affinity.
1946fef5208cSdrh         */
1947e014a838Sdanielk1977         int i;
19486ab3a2ecSdanielk1977         ExprList *pList = pExpr->x.pList;
194957dbd7b3Sdrh         struct ExprList_item *pItem;
1950ecc31805Sdrh         int r1, r2, r3;
195157dbd7b3Sdrh 
1952e014a838Sdanielk1977         if( !affinity ){
195305883a34Sdrh           affinity = SQLITE_AFF_BLOB;
1954e014a838Sdanielk1977         }
1955323df790Sdrh         if( pKeyInfo ){
19562ec2fb22Sdrh           assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
1957323df790Sdrh           pKeyInfo->aColl[0] = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
1958323df790Sdrh         }
1959e014a838Sdanielk1977 
1960e014a838Sdanielk1977         /* Loop through each expression in <exprlist>. */
19612d401ab8Sdrh         r1 = sqlite3GetTempReg(pParse);
19622d401ab8Sdrh         r2 = sqlite3GetTempReg(pParse);
196337e08081Sdrh         if( isRowid ) sqlite3VdbeAddOp2(v, OP_Null, 0, r2);
196457dbd7b3Sdrh         for(i=pList->nExpr, pItem=pList->a; i>0; i--, pItem++){
196557dbd7b3Sdrh           Expr *pE2 = pItem->pExpr;
1966e05c929bSdrh           int iValToIns;
1967e014a838Sdanielk1977 
196857dbd7b3Sdrh           /* If the expression is not constant then we will need to
196957dbd7b3Sdrh           ** disable the test that was generated above that makes sure
197057dbd7b3Sdrh           ** this code only executes once.  Because for a non-constant
197157dbd7b3Sdrh           ** expression we need to rerun this code each time.
197257dbd7b3Sdrh           */
19736be515ebSdrh           if( jmpIfDynamic>=0 && !sqlite3ExprIsConstant(pE2) ){
19746be515ebSdrh             sqlite3VdbeChangeToNoop(v, jmpIfDynamic);
19756be515ebSdrh             jmpIfDynamic = -1;
19764794b980Sdrh           }
1977e014a838Sdanielk1977 
1978e014a838Sdanielk1977           /* Evaluate the expression and insert it into the temp table */
1979e05c929bSdrh           if( isRowid && sqlite3ExprIsInteger(pE2, &iValToIns) ){
1980e05c929bSdrh             sqlite3VdbeAddOp3(v, OP_InsertInt, pExpr->iTable, r2, iValToIns);
1981e05c929bSdrh           }else{
1982ecc31805Sdrh             r3 = sqlite3ExprCodeTarget(pParse, pE2, r1);
198341a05b7bSdanielk1977             if( isRowid ){
1984e05c929bSdrh               sqlite3VdbeAddOp2(v, OP_MustBeInt, r3,
1985e05c929bSdrh                                 sqlite3VdbeCurrentAddr(v)+2);
1986688852abSdrh               VdbeCoverage(v);
198741a05b7bSdanielk1977               sqlite3VdbeAddOp3(v, OP_Insert, pExpr->iTable, r2, r3);
198841a05b7bSdanielk1977             }else{
1989ecc31805Sdrh               sqlite3VdbeAddOp4(v, OP_MakeRecord, r3, 1, r2, &affinity, 1);
19903c31fc23Sdrh               sqlite3ExprCacheAffinityChange(pParse, r3, 1);
19912d401ab8Sdrh               sqlite3VdbeAddOp2(v, OP_IdxInsert, pExpr->iTable, r2);
1992fef5208cSdrh             }
199341a05b7bSdanielk1977           }
1994e05c929bSdrh         }
19952d401ab8Sdrh         sqlite3ReleaseTempReg(pParse, r1);
19962d401ab8Sdrh         sqlite3ReleaseTempReg(pParse, r2);
1997fef5208cSdrh       }
1998323df790Sdrh       if( pKeyInfo ){
19992ec2fb22Sdrh         sqlite3VdbeChangeP4(v, addr, (void *)pKeyInfo, P4_KEYINFO);
200041a05b7bSdanielk1977       }
2001b3bce662Sdanielk1977       break;
2002fef5208cSdrh     }
2003fef5208cSdrh 
200451522cd3Sdrh     case TK_EXISTS:
2005fd773cf9Sdrh     case TK_SELECT:
2006fd773cf9Sdrh     default: {
2007fd773cf9Sdrh       /* If this has to be a scalar SELECT.  Generate code to put the
2008fef5208cSdrh       ** value of this select in a memory cell and record the number
2009fd773cf9Sdrh       ** of the memory cell in iColumn.  If this is an EXISTS, write
2010fd773cf9Sdrh       ** an integer 0 (not exists) or 1 (exists) into a memory cell
2011fd773cf9Sdrh       ** and record that memory cell in iColumn.
2012fef5208cSdrh       */
2013fd773cf9Sdrh       Select *pSel;                         /* SELECT statement to encode */
2014fd773cf9Sdrh       SelectDest dest;                      /* How to deal with SELECt result */
20151398ad36Sdrh 
2016cf697396Sshane       testcase( pExpr->op==TK_EXISTS );
2017cf697396Sshane       testcase( pExpr->op==TK_SELECT );
2018cf697396Sshane       assert( pExpr->op==TK_EXISTS || pExpr->op==TK_SELECT );
2019cf697396Sshane 
20206ab3a2ecSdanielk1977       assert( ExprHasProperty(pExpr, EP_xIsSelect) );
20216ab3a2ecSdanielk1977       pSel = pExpr->x.pSelect;
20221013c932Sdrh       sqlite3SelectDestInit(&dest, 0, ++pParse->nMem);
202351522cd3Sdrh       if( pExpr->op==TK_SELECT ){
20246c8c8ce0Sdanielk1977         dest.eDest = SRT_Mem;
202553932ce8Sdrh         dest.iSdst = dest.iSDParm;
20262b596da8Sdrh         sqlite3VdbeAddOp2(v, OP_Null, 0, dest.iSDParm);
2027d4e70ebdSdrh         VdbeComment((v, "Init subquery result"));
202851522cd3Sdrh       }else{
20296c8c8ce0Sdanielk1977         dest.eDest = SRT_Exists;
20302b596da8Sdrh         sqlite3VdbeAddOp2(v, OP_Integer, 0, dest.iSDParm);
2031d4e70ebdSdrh         VdbeComment((v, "Init EXISTS result"));
203251522cd3Sdrh       }
2033633e6d57Sdrh       sqlite3ExprDelete(pParse->db, pSel->pLimit);
2034094430ebSdrh       pSel->pLimit = sqlite3PExpr(pParse, TK_INTEGER, 0, 0,
2035094430ebSdrh                                   &sqlite3IntTokens[1]);
203648b5b041Sdrh       pSel->iLimit = 0;
2037772460fdSdrh       pSel->selFlags &= ~SF_MultiValue;
20387d10d5a6Sdrh       if( sqlite3Select(pParse, pSel, &dest) ){
20391450bc6eSdrh         return 0;
204094ccde58Sdrh       }
20412b596da8Sdrh       rReg = dest.iSDParm;
2042ebb6a65dSdrh       ExprSetVVAProperty(pExpr, EP_NoReduce);
2043b3bce662Sdanielk1977       break;
204419a775c2Sdrh     }
2045cce7d176Sdrh   }
2046b3bce662Sdanielk1977 
20476be515ebSdrh   if( rHasNullFlag ){
20486be515ebSdrh     sqlite3SetHasNullFlag(v, pExpr->iTable, rHasNullFlag);
20496be515ebSdrh   }
20506be515ebSdrh 
20516be515ebSdrh   if( jmpIfDynamic>=0 ){
20526be515ebSdrh     sqlite3VdbeJumpHere(v, jmpIfDynamic);
2053b3bce662Sdanielk1977   }
2054d2490904Sdrh   sqlite3ExprCachePop(pParse);
2055fc976065Sdanielk1977 
20561450bc6eSdrh   return rReg;
2057cce7d176Sdrh }
205851522cd3Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
2059cce7d176Sdrh 
2060e3365e6cSdrh #ifndef SQLITE_OMIT_SUBQUERY
2061e3365e6cSdrh /*
2062e3365e6cSdrh ** Generate code for an IN expression.
2063e3365e6cSdrh **
2064e3365e6cSdrh **      x IN (SELECT ...)
2065e3365e6cSdrh **      x IN (value, value, ...)
2066e3365e6cSdrh **
2067e3365e6cSdrh ** The left-hand side (LHS) is a scalar expression.  The right-hand side (RHS)
2068e3365e6cSdrh ** is an array of zero or more values.  The expression is true if the LHS is
2069e3365e6cSdrh ** contained within the RHS.  The value of the expression is unknown (NULL)
2070e3365e6cSdrh ** if the LHS is NULL or if the LHS is not contained within the RHS and the
2071e3365e6cSdrh ** RHS contains one or more NULL values.
2072e3365e6cSdrh **
20736be515ebSdrh ** This routine generates code that jumps to destIfFalse if the LHS is not
2074e3365e6cSdrh ** contained within the RHS.  If due to NULLs we cannot determine if the LHS
2075e3365e6cSdrh ** is contained in the RHS then jump to destIfNull.  If the LHS is contained
2076e3365e6cSdrh ** within the RHS then fall through.
2077e3365e6cSdrh */
2078e3365e6cSdrh static void sqlite3ExprCodeIN(
2079e3365e6cSdrh   Parse *pParse,        /* Parsing and code generating context */
2080e3365e6cSdrh   Expr *pExpr,          /* The IN expression */
2081e3365e6cSdrh   int destIfFalse,      /* Jump here if LHS is not contained in the RHS */
2082e3365e6cSdrh   int destIfNull        /* Jump here if the results are unknown due to NULLs */
2083e3365e6cSdrh ){
2084e3365e6cSdrh   int rRhsHasNull = 0;  /* Register that is true if RHS contains NULL values */
2085e3365e6cSdrh   char affinity;        /* Comparison affinity to use */
2086e3365e6cSdrh   int eType;            /* Type of the RHS */
2087e3365e6cSdrh   int r1;               /* Temporary use register */
2088e3365e6cSdrh   Vdbe *v;              /* Statement under construction */
2089e3365e6cSdrh 
2090e3365e6cSdrh   /* Compute the RHS.   After this step, the table with cursor
2091e3365e6cSdrh   ** pExpr->iTable will contains the values that make up the RHS.
2092e3365e6cSdrh   */
2093e3365e6cSdrh   v = pParse->pVdbe;
2094e3365e6cSdrh   assert( v!=0 );       /* OOM detected prior to this routine */
2095e3365e6cSdrh   VdbeNoopComment((v, "begin IN expr"));
2096bb53ecb1Sdrh   eType = sqlite3FindInIndex(pParse, pExpr,
2097bb53ecb1Sdrh                              IN_INDEX_MEMBERSHIP | IN_INDEX_NOOP_OK,
20983a85625dSdrh                              destIfFalse==destIfNull ? 0 : &rRhsHasNull);
2099e3365e6cSdrh 
2100e3365e6cSdrh   /* Figure out the affinity to use to create a key from the results
2101e3365e6cSdrh   ** of the expression. affinityStr stores a static string suitable for
2102e3365e6cSdrh   ** P4 of OP_MakeRecord.
2103e3365e6cSdrh   */
2104e3365e6cSdrh   affinity = comparisonAffinity(pExpr);
2105e3365e6cSdrh 
2106e3365e6cSdrh   /* Code the LHS, the <expr> from "<expr> IN (...)".
2107e3365e6cSdrh   */
2108e3365e6cSdrh   sqlite3ExprCachePush(pParse);
2109e3365e6cSdrh   r1 = sqlite3GetTempReg(pParse);
2110e3365e6cSdrh   sqlite3ExprCode(pParse, pExpr->pLeft, r1);
2111e3365e6cSdrh 
2112bb53ecb1Sdrh   /* If sqlite3FindInIndex() did not find or create an index that is
2113bb53ecb1Sdrh   ** suitable for evaluating the IN operator, then evaluate using a
2114bb53ecb1Sdrh   ** sequence of comparisons.
2115bb53ecb1Sdrh   */
2116bb53ecb1Sdrh   if( eType==IN_INDEX_NOOP ){
2117bb53ecb1Sdrh     ExprList *pList = pExpr->x.pList;
2118bb53ecb1Sdrh     CollSeq *pColl = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
2119bb53ecb1Sdrh     int labelOk = sqlite3VdbeMakeLabel(v);
2120bb53ecb1Sdrh     int r2, regToFree;
2121bb53ecb1Sdrh     int regCkNull = 0;
2122bb53ecb1Sdrh     int ii;
2123bb53ecb1Sdrh     assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
2124bb53ecb1Sdrh     if( destIfNull!=destIfFalse ){
2125bb53ecb1Sdrh       regCkNull = sqlite3GetTempReg(pParse);
2126a976979bSdrh       sqlite3VdbeAddOp3(v, OP_BitAnd, r1, r1, regCkNull);
2127bb53ecb1Sdrh     }
2128bb53ecb1Sdrh     for(ii=0; ii<pList->nExpr; ii++){
2129bb53ecb1Sdrh       r2 = sqlite3ExprCodeTemp(pParse, pList->a[ii].pExpr, &regToFree);
2130a976979bSdrh       if( regCkNull && sqlite3ExprCanBeNull(pList->a[ii].pExpr) ){
2131bb53ecb1Sdrh         sqlite3VdbeAddOp3(v, OP_BitAnd, regCkNull, r2, regCkNull);
2132bb53ecb1Sdrh       }
2133bb53ecb1Sdrh       if( ii<pList->nExpr-1 || destIfNull!=destIfFalse ){
2134bb53ecb1Sdrh         sqlite3VdbeAddOp4(v, OP_Eq, r1, labelOk, r2,
21354336b0e6Sdrh                           (void*)pColl, P4_COLLSEQ);
21364336b0e6Sdrh         VdbeCoverageIf(v, ii<pList->nExpr-1);
21374336b0e6Sdrh         VdbeCoverageIf(v, ii==pList->nExpr-1);
2138bb53ecb1Sdrh         sqlite3VdbeChangeP5(v, affinity);
2139bb53ecb1Sdrh       }else{
2140bb53ecb1Sdrh         assert( destIfNull==destIfFalse );
2141bb53ecb1Sdrh         sqlite3VdbeAddOp4(v, OP_Ne, r1, destIfFalse, r2,
2142bb53ecb1Sdrh                           (void*)pColl, P4_COLLSEQ); VdbeCoverage(v);
2143bb53ecb1Sdrh         sqlite3VdbeChangeP5(v, affinity | SQLITE_JUMPIFNULL);
2144bb53ecb1Sdrh       }
2145bb53ecb1Sdrh       sqlite3ReleaseTempReg(pParse, regToFree);
2146bb53ecb1Sdrh     }
2147bb53ecb1Sdrh     if( regCkNull ){
2148bb53ecb1Sdrh       sqlite3VdbeAddOp2(v, OP_IsNull, regCkNull, destIfNull); VdbeCoverage(v);
2149bb53ecb1Sdrh       sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfFalse);
2150bb53ecb1Sdrh     }
2151bb53ecb1Sdrh     sqlite3VdbeResolveLabel(v, labelOk);
2152bb53ecb1Sdrh     sqlite3ReleaseTempReg(pParse, regCkNull);
2153bb53ecb1Sdrh   }else{
2154bb53ecb1Sdrh 
2155094430ebSdrh     /* If the LHS is NULL, then the result is either false or NULL depending
2156094430ebSdrh     ** on whether the RHS is empty or not, respectively.
2157094430ebSdrh     */
21587248a8b2Sdrh     if( sqlite3ExprCanBeNull(pExpr->pLeft) ){
2159094430ebSdrh       if( destIfNull==destIfFalse ){
2160094430ebSdrh         /* Shortcut for the common case where the false and NULL outcomes are
2161094430ebSdrh         ** the same. */
2162688852abSdrh         sqlite3VdbeAddOp2(v, OP_IsNull, r1, destIfNull); VdbeCoverage(v);
2163094430ebSdrh       }else{
2164688852abSdrh         int addr1 = sqlite3VdbeAddOp1(v, OP_NotNull, r1); VdbeCoverage(v);
2165094430ebSdrh         sqlite3VdbeAddOp2(v, OP_Rewind, pExpr->iTable, destIfFalse);
2166688852abSdrh         VdbeCoverage(v);
2167094430ebSdrh         sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfNull);
2168094430ebSdrh         sqlite3VdbeJumpHere(v, addr1);
2169094430ebSdrh       }
21707248a8b2Sdrh     }
2171e3365e6cSdrh 
2172e3365e6cSdrh     if( eType==IN_INDEX_ROWID ){
2173e3365e6cSdrh       /* In this case, the RHS is the ROWID of table b-tree
2174e3365e6cSdrh       */
2175688852abSdrh       sqlite3VdbeAddOp2(v, OP_MustBeInt, r1, destIfFalse); VdbeCoverage(v);
2176e3365e6cSdrh       sqlite3VdbeAddOp3(v, OP_NotExists, pExpr->iTable, destIfFalse, r1);
2177688852abSdrh       VdbeCoverage(v);
2178e3365e6cSdrh     }else{
2179e3365e6cSdrh       /* In this case, the RHS is an index b-tree.
2180e3365e6cSdrh       */
21818cff69dfSdrh       sqlite3VdbeAddOp4(v, OP_Affinity, r1, 1, 0, &affinity, 1);
2182e3365e6cSdrh 
2183e3365e6cSdrh       /* If the set membership test fails, then the result of the
2184e3365e6cSdrh       ** "x IN (...)" expression must be either 0 or NULL. If the set
2185e3365e6cSdrh       ** contains no NULL values, then the result is 0. If the set
2186e3365e6cSdrh       ** contains one or more NULL values, then the result of the
2187e3365e6cSdrh       ** expression is also NULL.
2188e3365e6cSdrh       */
2189e80c9b9aSdrh       assert( destIfFalse!=destIfNull || rRhsHasNull==0 );
2190e80c9b9aSdrh       if( rRhsHasNull==0 ){
2191e3365e6cSdrh         /* This branch runs if it is known at compile time that the RHS
2192e3365e6cSdrh         ** cannot contain NULL values. This happens as the result
2193e3365e6cSdrh         ** of a "NOT NULL" constraint in the database schema.
2194e3365e6cSdrh         **
2195e3365e6cSdrh         ** Also run this branch if NULL is equivalent to FALSE
2196e3365e6cSdrh         ** for this particular IN operator.
2197e3365e6cSdrh         */
21988cff69dfSdrh         sqlite3VdbeAddOp4Int(v, OP_NotFound, pExpr->iTable, destIfFalse, r1, 1);
2199688852abSdrh         VdbeCoverage(v);
2200e3365e6cSdrh       }else{
2201e3365e6cSdrh         /* In this branch, the RHS of the IN might contain a NULL and
2202e3365e6cSdrh         ** the presence of a NULL on the RHS makes a difference in the
2203e3365e6cSdrh         ** outcome.
2204e3365e6cSdrh         */
22056be515ebSdrh         int j1;
2206e3365e6cSdrh 
2207e3365e6cSdrh         /* First check to see if the LHS is contained in the RHS.  If so,
22086be515ebSdrh         ** then the answer is TRUE the presence of NULLs in the RHS does
22096be515ebSdrh         ** not matter.  If the LHS is not contained in the RHS, then the
22106be515ebSdrh         ** answer is NULL if the RHS contains NULLs and the answer is
22116be515ebSdrh         ** FALSE if the RHS is NULL-free.
2212e3365e6cSdrh         */
22138cff69dfSdrh         j1 = sqlite3VdbeAddOp4Int(v, OP_Found, pExpr->iTable, 0, r1, 1);
2214688852abSdrh         VdbeCoverage(v);
22156be515ebSdrh         sqlite3VdbeAddOp2(v, OP_IsNull, rRhsHasNull, destIfNull);
2216552fd454Sdrh         VdbeCoverage(v);
2217e3365e6cSdrh         sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfFalse);
2218e3365e6cSdrh         sqlite3VdbeJumpHere(v, j1);
2219e3365e6cSdrh       }
2220e3365e6cSdrh     }
2221bb53ecb1Sdrh   }
2222e3365e6cSdrh   sqlite3ReleaseTempReg(pParse, r1);
2223d2490904Sdrh   sqlite3ExprCachePop(pParse);
2224e3365e6cSdrh   VdbeComment((v, "end IN expr"));
2225e3365e6cSdrh }
2226e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
2227e3365e6cSdrh 
222813573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
2229598f1340Sdrh /*
2230598f1340Sdrh ** Generate an instruction that will put the floating point
22319cbf3425Sdrh ** value described by z[0..n-1] into register iMem.
22320cf19ed8Sdrh **
22330cf19ed8Sdrh ** The z[] string will probably not be zero-terminated.  But the
22340cf19ed8Sdrh ** z[n] character is guaranteed to be something that does not look
22350cf19ed8Sdrh ** like the continuation of the number.
2236598f1340Sdrh */
2237b7916a78Sdrh static void codeReal(Vdbe *v, const char *z, int negateFlag, int iMem){
2238fd773cf9Sdrh   if( ALWAYS(z!=0) ){
2239598f1340Sdrh     double value;
22409339da1fSdrh     sqlite3AtoF(z, &value, sqlite3Strlen30(z), SQLITE_UTF8);
2241d0015161Sdrh     assert( !sqlite3IsNaN(value) ); /* The new AtoF never returns NaN */
2242598f1340Sdrh     if( negateFlag ) value = -value;
224397bae794Sdrh     sqlite3VdbeAddOp4Dup8(v, OP_Real, 0, iMem, 0, (u8*)&value, P4_REAL);
2244598f1340Sdrh   }
2245598f1340Sdrh }
224613573c71Sdrh #endif
2247598f1340Sdrh 
2248598f1340Sdrh 
2249598f1340Sdrh /*
2250fec19aadSdrh ** Generate an instruction that will put the integer describe by
22519cbf3425Sdrh ** text z[0..n-1] into register iMem.
22520cf19ed8Sdrh **
22535f1d6b61Sshaneh ** Expr.u.zToken is always UTF8 and zero-terminated.
2254fec19aadSdrh */
225513573c71Sdrh static void codeInteger(Parse *pParse, Expr *pExpr, int negFlag, int iMem){
225613573c71Sdrh   Vdbe *v = pParse->pVdbe;
225792b01d53Sdrh   if( pExpr->flags & EP_IntValue ){
225833e619fcSdrh     int i = pExpr->u.iValue;
2259d50ffc41Sdrh     assert( i>=0 );
226092b01d53Sdrh     if( negFlag ) i = -i;
226192b01d53Sdrh     sqlite3VdbeAddOp2(v, OP_Integer, i, iMem);
2262fd773cf9Sdrh   }else{
22635f1d6b61Sshaneh     int c;
22645f1d6b61Sshaneh     i64 value;
2265fd773cf9Sdrh     const char *z = pExpr->u.zToken;
2266fd773cf9Sdrh     assert( z!=0 );
22679296c18aSdrh     c = sqlite3DecOrHexToI64(z, &value);
22685f1d6b61Sshaneh     if( c==0 || (c==2 && negFlag) ){
2269158b9cb9Sdrh       if( negFlag ){ value = c==2 ? SMALLEST_INT64 : -value; }
227097bae794Sdrh       sqlite3VdbeAddOp4Dup8(v, OP_Int64, 0, iMem, 0, (u8*)&value, P4_INT64);
2271fec19aadSdrh     }else{
227213573c71Sdrh #ifdef SQLITE_OMIT_FLOATING_POINT
227313573c71Sdrh       sqlite3ErrorMsg(pParse, "oversized integer: %s%s", negFlag ? "-" : "", z);
227413573c71Sdrh #else
22751b7ddc59Sdrh #ifndef SQLITE_OMIT_HEX_INTEGER
22769296c18aSdrh       if( sqlite3_strnicmp(z,"0x",2)==0 ){
22779296c18aSdrh         sqlite3ErrorMsg(pParse, "hex literal too big: %s", z);
22781b7ddc59Sdrh       }else
22791b7ddc59Sdrh #endif
22801b7ddc59Sdrh       {
2281b7916a78Sdrh         codeReal(v, z, negFlag, iMem);
22829296c18aSdrh       }
228313573c71Sdrh #endif
2284fec19aadSdrh     }
2285fec19aadSdrh   }
2286c9cf901dSdanielk1977 }
2287fec19aadSdrh 
2288ceea3321Sdrh /*
2289ceea3321Sdrh ** Clear a cache entry.
2290ceea3321Sdrh */
2291ceea3321Sdrh static void cacheEntryClear(Parse *pParse, struct yColCache *p){
2292ceea3321Sdrh   if( p->tempReg ){
2293ceea3321Sdrh     if( pParse->nTempReg<ArraySize(pParse->aTempReg) ){
2294ceea3321Sdrh       pParse->aTempReg[pParse->nTempReg++] = p->iReg;
2295ceea3321Sdrh     }
2296ceea3321Sdrh     p->tempReg = 0;
2297ceea3321Sdrh   }
2298ceea3321Sdrh }
2299ceea3321Sdrh 
2300ceea3321Sdrh 
2301ceea3321Sdrh /*
2302ceea3321Sdrh ** Record in the column cache that a particular column from a
2303ceea3321Sdrh ** particular table is stored in a particular register.
2304ceea3321Sdrh */
2305ceea3321Sdrh void sqlite3ExprCacheStore(Parse *pParse, int iTab, int iCol, int iReg){
2306ceea3321Sdrh   int i;
2307ceea3321Sdrh   int minLru;
2308ceea3321Sdrh   int idxLru;
2309ceea3321Sdrh   struct yColCache *p;
2310ceea3321Sdrh 
2311ce8f53d4Sdan   /* Unless an error has occurred, register numbers are always positive. */
2312ce8f53d4Sdan   assert( iReg>0 || pParse->nErr || pParse->db->mallocFailed );
231320411ea7Sdrh   assert( iCol>=-1 && iCol<32768 );  /* Finite column numbers */
231420411ea7Sdrh 
2315b6da74ebSdrh   /* The SQLITE_ColumnCache flag disables the column cache.  This is used
2316b6da74ebSdrh   ** for testing only - to verify that SQLite always gets the same answer
2317b6da74ebSdrh   ** with and without the column cache.
2318b6da74ebSdrh   */
23197e5418e4Sdrh   if( OptimizationDisabled(pParse->db, SQLITE_ColumnCache) ) return;
2320b6da74ebSdrh 
232127ee406eSdrh   /* First replace any existing entry.
232227ee406eSdrh   **
232327ee406eSdrh   ** Actually, the way the column cache is currently used, we are guaranteed
232427ee406eSdrh   ** that the object will never already be in cache.  Verify this guarantee.
232527ee406eSdrh   */
232627ee406eSdrh #ifndef NDEBUG
2327ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
232827ee406eSdrh     assert( p->iReg==0 || p->iTable!=iTab || p->iColumn!=iCol );
2329ceea3321Sdrh   }
233027ee406eSdrh #endif
2331ceea3321Sdrh 
2332ceea3321Sdrh   /* Find an empty slot and replace it */
2333ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2334ceea3321Sdrh     if( p->iReg==0 ){
2335ceea3321Sdrh       p->iLevel = pParse->iCacheLevel;
2336ceea3321Sdrh       p->iTable = iTab;
2337ceea3321Sdrh       p->iColumn = iCol;
2338ceea3321Sdrh       p->iReg = iReg;
2339ceea3321Sdrh       p->tempReg = 0;
2340ceea3321Sdrh       p->lru = pParse->iCacheCnt++;
2341ceea3321Sdrh       return;
2342ceea3321Sdrh     }
2343ceea3321Sdrh   }
2344ceea3321Sdrh 
2345ceea3321Sdrh   /* Replace the last recently used */
2346ceea3321Sdrh   minLru = 0x7fffffff;
2347ceea3321Sdrh   idxLru = -1;
2348ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2349ceea3321Sdrh     if( p->lru<minLru ){
2350ceea3321Sdrh       idxLru = i;
2351ceea3321Sdrh       minLru = p->lru;
2352ceea3321Sdrh     }
2353ceea3321Sdrh   }
235420411ea7Sdrh   if( ALWAYS(idxLru>=0) ){
2355ceea3321Sdrh     p = &pParse->aColCache[idxLru];
2356ceea3321Sdrh     p->iLevel = pParse->iCacheLevel;
2357ceea3321Sdrh     p->iTable = iTab;
2358ceea3321Sdrh     p->iColumn = iCol;
2359ceea3321Sdrh     p->iReg = iReg;
2360ceea3321Sdrh     p->tempReg = 0;
2361ceea3321Sdrh     p->lru = pParse->iCacheCnt++;
2362ceea3321Sdrh     return;
2363ceea3321Sdrh   }
2364ceea3321Sdrh }
2365ceea3321Sdrh 
2366ceea3321Sdrh /*
2367f49f3523Sdrh ** Indicate that registers between iReg..iReg+nReg-1 are being overwritten.
2368f49f3523Sdrh ** Purge the range of registers from the column cache.
2369ceea3321Sdrh */
2370f49f3523Sdrh void sqlite3ExprCacheRemove(Parse *pParse, int iReg, int nReg){
2371ceea3321Sdrh   int i;
2372f49f3523Sdrh   int iLast = iReg + nReg - 1;
2373ceea3321Sdrh   struct yColCache *p;
2374ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2375f49f3523Sdrh     int r = p->iReg;
2376f49f3523Sdrh     if( r>=iReg && r<=iLast ){
2377ceea3321Sdrh       cacheEntryClear(pParse, p);
2378ceea3321Sdrh       p->iReg = 0;
2379ceea3321Sdrh     }
2380ceea3321Sdrh   }
2381ceea3321Sdrh }
2382ceea3321Sdrh 
2383ceea3321Sdrh /*
2384ceea3321Sdrh ** Remember the current column cache context.  Any new entries added
2385ceea3321Sdrh ** added to the column cache after this call are removed when the
2386ceea3321Sdrh ** corresponding pop occurs.
2387ceea3321Sdrh */
2388ceea3321Sdrh void sqlite3ExprCachePush(Parse *pParse){
2389ceea3321Sdrh   pParse->iCacheLevel++;
23909ac7962aSdrh #ifdef SQLITE_DEBUG
23919ac7962aSdrh   if( pParse->db->flags & SQLITE_VdbeAddopTrace ){
23929ac7962aSdrh     printf("PUSH to %d\n", pParse->iCacheLevel);
23939ac7962aSdrh   }
23949ac7962aSdrh #endif
2395ceea3321Sdrh }
2396ceea3321Sdrh 
2397ceea3321Sdrh /*
2398ceea3321Sdrh ** Remove from the column cache any entries that were added since the
2399d2490904Sdrh ** the previous sqlite3ExprCachePush operation.  In other words, restore
2400d2490904Sdrh ** the cache to the state it was in prior the most recent Push.
2401ceea3321Sdrh */
2402d2490904Sdrh void sqlite3ExprCachePop(Parse *pParse){
2403ceea3321Sdrh   int i;
2404ceea3321Sdrh   struct yColCache *p;
2405d2490904Sdrh   assert( pParse->iCacheLevel>=1 );
2406d2490904Sdrh   pParse->iCacheLevel--;
24079ac7962aSdrh #ifdef SQLITE_DEBUG
24089ac7962aSdrh   if( pParse->db->flags & SQLITE_VdbeAddopTrace ){
24099ac7962aSdrh     printf("POP  to %d\n", pParse->iCacheLevel);
24109ac7962aSdrh   }
24119ac7962aSdrh #endif
2412ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2413ceea3321Sdrh     if( p->iReg && p->iLevel>pParse->iCacheLevel ){
2414ceea3321Sdrh       cacheEntryClear(pParse, p);
2415ceea3321Sdrh       p->iReg = 0;
2416ceea3321Sdrh     }
2417ceea3321Sdrh   }
2418ceea3321Sdrh }
2419945498f3Sdrh 
2420945498f3Sdrh /*
24215cd79239Sdrh ** When a cached column is reused, make sure that its register is
24225cd79239Sdrh ** no longer available as a temp register.  ticket #3879:  that same
24235cd79239Sdrh ** register might be in the cache in multiple places, so be sure to
24245cd79239Sdrh ** get them all.
24255cd79239Sdrh */
24265cd79239Sdrh static void sqlite3ExprCachePinRegister(Parse *pParse, int iReg){
24275cd79239Sdrh   int i;
24285cd79239Sdrh   struct yColCache *p;
24295cd79239Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
24305cd79239Sdrh     if( p->iReg==iReg ){
24315cd79239Sdrh       p->tempReg = 0;
24325cd79239Sdrh     }
24335cd79239Sdrh   }
24345cd79239Sdrh }
24355cd79239Sdrh 
24365cd79239Sdrh /*
24375c092e8aSdrh ** Generate code to extract the value of the iCol-th column of a table.
24385c092e8aSdrh */
24395c092e8aSdrh void sqlite3ExprCodeGetColumnOfTable(
24405c092e8aSdrh   Vdbe *v,        /* The VDBE under construction */
24415c092e8aSdrh   Table *pTab,    /* The table containing the value */
2442313619f5Sdrh   int iTabCur,    /* The table cursor.  Or the PK cursor for WITHOUT ROWID */
24435c092e8aSdrh   int iCol,       /* Index of the column to extract */
2444313619f5Sdrh   int regOut      /* Extract the value into this register */
24455c092e8aSdrh ){
24465c092e8aSdrh   if( iCol<0 || iCol==pTab->iPKey ){
24475c092e8aSdrh     sqlite3VdbeAddOp2(v, OP_Rowid, iTabCur, regOut);
24485c092e8aSdrh   }else{
24495c092e8aSdrh     int op = IsVirtual(pTab) ? OP_VColumn : OP_Column;
2450ee0ec8e1Sdrh     int x = iCol;
2451ee0ec8e1Sdrh     if( !HasRowid(pTab) ){
2452ee0ec8e1Sdrh       x = sqlite3ColumnOfIndex(sqlite3PrimaryKeyIndex(pTab), iCol);
2453ee0ec8e1Sdrh     }
2454ee0ec8e1Sdrh     sqlite3VdbeAddOp3(v, op, iTabCur, x, regOut);
24555c092e8aSdrh   }
24565c092e8aSdrh   if( iCol>=0 ){
24575c092e8aSdrh     sqlite3ColumnDefault(v, pTab, iCol, regOut);
24585c092e8aSdrh   }
24595c092e8aSdrh }
24605c092e8aSdrh 
24615c092e8aSdrh /*
2462945498f3Sdrh ** Generate code that will extract the iColumn-th column from
2463e55cbd72Sdrh ** table pTab and store the column value in a register.  An effort
2464e55cbd72Sdrh ** is made to store the column value in register iReg, but this is
2465e55cbd72Sdrh ** not guaranteed.  The location of the column value is returned.
2466e55cbd72Sdrh **
2467e55cbd72Sdrh ** There must be an open cursor to pTab in iTable when this routine
2468e55cbd72Sdrh ** is called.  If iColumn<0 then code is generated that extracts the rowid.
2469945498f3Sdrh */
2470e55cbd72Sdrh int sqlite3ExprCodeGetColumn(
2471e55cbd72Sdrh   Parse *pParse,   /* Parsing and code generating context */
24722133d822Sdrh   Table *pTab,     /* Description of the table we are reading from */
24732133d822Sdrh   int iColumn,     /* Index of the table column */
24742133d822Sdrh   int iTable,      /* The cursor pointing to the table */
2475a748fdccSdrh   int iReg,        /* Store results here */
2476a748fdccSdrh   u8 p5            /* P5 value for OP_Column */
24772133d822Sdrh ){
2478e55cbd72Sdrh   Vdbe *v = pParse->pVdbe;
2479e55cbd72Sdrh   int i;
2480da250ea5Sdrh   struct yColCache *p;
2481e55cbd72Sdrh 
2482ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2483b6da74ebSdrh     if( p->iReg>0 && p->iTable==iTable && p->iColumn==iColumn ){
2484ceea3321Sdrh       p->lru = pParse->iCacheCnt++;
24855cd79239Sdrh       sqlite3ExprCachePinRegister(pParse, p->iReg);
2486da250ea5Sdrh       return p->iReg;
2487e55cbd72Sdrh     }
2488e55cbd72Sdrh   }
2489e55cbd72Sdrh   assert( v!=0 );
24905c092e8aSdrh   sqlite3ExprCodeGetColumnOfTable(v, pTab, iTable, iColumn, iReg);
2491a748fdccSdrh   if( p5 ){
2492a748fdccSdrh     sqlite3VdbeChangeP5(v, p5);
2493a748fdccSdrh   }else{
2494ceea3321Sdrh     sqlite3ExprCacheStore(pParse, iTable, iColumn, iReg);
2495a748fdccSdrh   }
2496e55cbd72Sdrh   return iReg;
2497e55cbd72Sdrh }
2498e55cbd72Sdrh 
2499e55cbd72Sdrh /*
2500ceea3321Sdrh ** Clear all column cache entries.
2501e55cbd72Sdrh */
2502ceea3321Sdrh void sqlite3ExprCacheClear(Parse *pParse){
2503e55cbd72Sdrh   int i;
2504ceea3321Sdrh   struct yColCache *p;
2505ceea3321Sdrh 
25069ac7962aSdrh #if SQLITE_DEBUG
25079ac7962aSdrh   if( pParse->db->flags & SQLITE_VdbeAddopTrace ){
25089ac7962aSdrh     printf("CLEAR\n");
25099ac7962aSdrh   }
25109ac7962aSdrh #endif
2511ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2512ceea3321Sdrh     if( p->iReg ){
2513ceea3321Sdrh       cacheEntryClear(pParse, p);
2514ceea3321Sdrh       p->iReg = 0;
2515e55cbd72Sdrh     }
2516da250ea5Sdrh   }
2517da250ea5Sdrh }
2518e55cbd72Sdrh 
2519e55cbd72Sdrh /*
2520da250ea5Sdrh ** Record the fact that an affinity change has occurred on iCount
2521da250ea5Sdrh ** registers starting with iStart.
2522e55cbd72Sdrh */
2523da250ea5Sdrh void sqlite3ExprCacheAffinityChange(Parse *pParse, int iStart, int iCount){
2524f49f3523Sdrh   sqlite3ExprCacheRemove(pParse, iStart, iCount);
2525e55cbd72Sdrh }
2526e55cbd72Sdrh 
2527e55cbd72Sdrh /*
2528b21e7c70Sdrh ** Generate code to move content from registers iFrom...iFrom+nReg-1
2529b21e7c70Sdrh ** over to iTo..iTo+nReg-1. Keep the column cache up-to-date.
2530e55cbd72Sdrh */
2531b21e7c70Sdrh void sqlite3ExprCodeMove(Parse *pParse, int iFrom, int iTo, int nReg){
2532e8e4af76Sdrh   assert( iFrom>=iTo+nReg || iFrom+nReg<=iTo );
2533079a3072Sdrh   sqlite3VdbeAddOp3(pParse->pVdbe, OP_Move, iFrom, iTo, nReg);
2534236241aeSdrh   sqlite3ExprCacheRemove(pParse, iFrom, nReg);
2535945498f3Sdrh }
2536945498f3Sdrh 
2537f49f3523Sdrh #if defined(SQLITE_DEBUG) || defined(SQLITE_COVERAGE_TEST)
253892b01d53Sdrh /*
2539652fbf55Sdrh ** Return true if any register in the range iFrom..iTo (inclusive)
2540652fbf55Sdrh ** is used as part of the column cache.
2541f49f3523Sdrh **
2542f49f3523Sdrh ** This routine is used within assert() and testcase() macros only
2543f49f3523Sdrh ** and does not appear in a normal build.
2544652fbf55Sdrh */
2545652fbf55Sdrh static int usedAsColumnCache(Parse *pParse, int iFrom, int iTo){
2546652fbf55Sdrh   int i;
2547ceea3321Sdrh   struct yColCache *p;
2548ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2549ceea3321Sdrh     int r = p->iReg;
2550f49f3523Sdrh     if( r>=iFrom && r<=iTo ) return 1;    /*NO_TEST*/
2551652fbf55Sdrh   }
2552652fbf55Sdrh   return 0;
2553652fbf55Sdrh }
2554f49f3523Sdrh #endif /* SQLITE_DEBUG || SQLITE_COVERAGE_TEST */
2555652fbf55Sdrh 
2556652fbf55Sdrh /*
2557a4c3c87eSdrh ** Convert an expression node to a TK_REGISTER
2558a4c3c87eSdrh */
2559a4c3c87eSdrh static void exprToRegister(Expr *p, int iReg){
2560a4c3c87eSdrh   p->op2 = p->op;
2561a4c3c87eSdrh   p->op = TK_REGISTER;
2562a4c3c87eSdrh   p->iTable = iReg;
2563a4c3c87eSdrh   ExprClearProperty(p, EP_Skip);
2564a4c3c87eSdrh }
2565a4c3c87eSdrh 
2566a4c3c87eSdrh /*
2567cce7d176Sdrh ** Generate code into the current Vdbe to evaluate the given
25682dcef11bSdrh ** expression.  Attempt to store the results in register "target".
25692dcef11bSdrh ** Return the register where results are stored.
2570389a1adbSdrh **
25718b213899Sdrh ** With this routine, there is no guarantee that results will
25722dcef11bSdrh ** be stored in target.  The result might be stored in some other
25732dcef11bSdrh ** register if it is convenient to do so.  The calling function
25742dcef11bSdrh ** must check the return code and move the results to the desired
25752dcef11bSdrh ** register.
2576cce7d176Sdrh */
2577678ccce8Sdrh int sqlite3ExprCodeTarget(Parse *pParse, Expr *pExpr, int target){
25782dcef11bSdrh   Vdbe *v = pParse->pVdbe;  /* The VM under construction */
25792dcef11bSdrh   int op;                   /* The opcode being coded */
25802dcef11bSdrh   int inReg = target;       /* Results stored in register inReg */
25812dcef11bSdrh   int regFree1 = 0;         /* If non-zero free this temporary register */
25822dcef11bSdrh   int regFree2 = 0;         /* If non-zero free this temporary register */
2583678ccce8Sdrh   int r1, r2, r3, r4;       /* Various register numbers */
258420411ea7Sdrh   sqlite3 *db = pParse->db; /* The database connection */
258510d1edf0Sdrh   Expr tempX;               /* Temporary expression node */
2586ffe07b2dSdrh 
25879cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
258820411ea7Sdrh   if( v==0 ){
258920411ea7Sdrh     assert( pParse->db->mallocFailed );
259020411ea7Sdrh     return 0;
259120411ea7Sdrh   }
2592389a1adbSdrh 
2593389a1adbSdrh   if( pExpr==0 ){
2594389a1adbSdrh     op = TK_NULL;
2595389a1adbSdrh   }else{
2596f2bc013cSdrh     op = pExpr->op;
2597389a1adbSdrh   }
2598f2bc013cSdrh   switch( op ){
259913449892Sdrh     case TK_AGG_COLUMN: {
260013449892Sdrh       AggInfo *pAggInfo = pExpr->pAggInfo;
260113449892Sdrh       struct AggInfo_col *pCol = &pAggInfo->aCol[pExpr->iAgg];
260213449892Sdrh       if( !pAggInfo->directMode ){
26039de221dfSdrh         assert( pCol->iMem>0 );
26049de221dfSdrh         inReg = pCol->iMem;
260513449892Sdrh         break;
260613449892Sdrh       }else if( pAggInfo->useSortingIdx ){
26075134d135Sdan         sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdxPTab,
2608389a1adbSdrh                               pCol->iSorterColumn, target);
260913449892Sdrh         break;
261013449892Sdrh       }
261113449892Sdrh       /* Otherwise, fall thru into the TK_COLUMN case */
261213449892Sdrh     }
2613967e8b73Sdrh     case TK_COLUMN: {
2614b2b9d3d7Sdrh       int iTab = pExpr->iTable;
2615b2b9d3d7Sdrh       if( iTab<0 ){
2616b2b9d3d7Sdrh         if( pParse->ckBase>0 ){
2617b2b9d3d7Sdrh           /* Generating CHECK constraints or inserting into partial index */
2618aa9b8963Sdrh           inReg = pExpr->iColumn + pParse->ckBase;
2619b2b9d3d7Sdrh           break;
2620c4a3c779Sdrh         }else{
2621b2b9d3d7Sdrh           /* Deleting from a partial index */
2622b2b9d3d7Sdrh           iTab = pParse->iPartIdxTab;
26232282792aSdrh         }
2624b2b9d3d7Sdrh       }
2625b2b9d3d7Sdrh       inReg = sqlite3ExprCodeGetColumn(pParse, pExpr->pTab,
2626b2b9d3d7Sdrh                                pExpr->iColumn, iTab, target,
2627b2b9d3d7Sdrh                                pExpr->op2);
2628cce7d176Sdrh       break;
2629cce7d176Sdrh     }
2630cce7d176Sdrh     case TK_INTEGER: {
263113573c71Sdrh       codeInteger(pParse, pExpr, 0, target);
2632fec19aadSdrh       break;
263351e9a445Sdrh     }
263413573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
2635598f1340Sdrh     case TK_FLOAT: {
263633e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
263733e619fcSdrh       codeReal(v, pExpr->u.zToken, 0, target);
2638598f1340Sdrh       break;
2639598f1340Sdrh     }
264013573c71Sdrh #endif
2641fec19aadSdrh     case TK_STRING: {
264233e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
264333e619fcSdrh       sqlite3VdbeAddOp4(v, OP_String8, 0, target, 0, pExpr->u.zToken, 0);
2644cce7d176Sdrh       break;
2645cce7d176Sdrh     }
2646f0863fe5Sdrh     case TK_NULL: {
26479de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
2648f0863fe5Sdrh       break;
2649f0863fe5Sdrh     }
26505338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_BLOB_LITERAL
2651c572ef7fSdanielk1977     case TK_BLOB: {
26526c8c6cecSdrh       int n;
26536c8c6cecSdrh       const char *z;
2654ca48c90fSdrh       char *zBlob;
265533e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
265633e619fcSdrh       assert( pExpr->u.zToken[0]=='x' || pExpr->u.zToken[0]=='X' );
265733e619fcSdrh       assert( pExpr->u.zToken[1]=='\'' );
265833e619fcSdrh       z = &pExpr->u.zToken[2];
2659b7916a78Sdrh       n = sqlite3Strlen30(z) - 1;
2660b7916a78Sdrh       assert( z[n]=='\'' );
2661ca48c90fSdrh       zBlob = sqlite3HexToBlob(sqlite3VdbeDb(v), z, n);
2662ca48c90fSdrh       sqlite3VdbeAddOp4(v, OP_Blob, n/2, target, 0, zBlob, P4_DYNAMIC);
2663c572ef7fSdanielk1977       break;
2664c572ef7fSdanielk1977     }
26655338a5f7Sdanielk1977 #endif
266650457896Sdrh     case TK_VARIABLE: {
266733e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
266833e619fcSdrh       assert( pExpr->u.zToken!=0 );
266933e619fcSdrh       assert( pExpr->u.zToken[0]!=0 );
2670eaf52d88Sdrh       sqlite3VdbeAddOp2(v, OP_Variable, pExpr->iColumn, target);
267133e619fcSdrh       if( pExpr->u.zToken[1]!=0 ){
267204e9eeadSdrh         assert( pExpr->u.zToken[0]=='?'
267304e9eeadSdrh              || strcmp(pExpr->u.zToken, pParse->azVar[pExpr->iColumn-1])==0 );
267404e9eeadSdrh         sqlite3VdbeChangeP4(v, -1, pParse->azVar[pExpr->iColumn-1], P4_STATIC);
2675895d7472Sdrh       }
267650457896Sdrh       break;
267750457896Sdrh     }
26784e0cff60Sdrh     case TK_REGISTER: {
26799de221dfSdrh       inReg = pExpr->iTable;
26804e0cff60Sdrh       break;
26814e0cff60Sdrh     }
26828b213899Sdrh     case TK_AS: {
26837445ffe2Sdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
26848b213899Sdrh       break;
26858b213899Sdrh     }
2686487e262fSdrh #ifndef SQLITE_OMIT_CAST
2687487e262fSdrh     case TK_CAST: {
2688487e262fSdrh       /* Expressions of the form:   CAST(pLeft AS token) */
26892dcef11bSdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
26901735fa88Sdrh       if( inReg!=target ){
26911735fa88Sdrh         sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
26921735fa88Sdrh         inReg = target;
26931735fa88Sdrh       }
26944169e430Sdrh       sqlite3VdbeAddOp2(v, OP_Cast, target,
26954169e430Sdrh                         sqlite3AffinityType(pExpr->u.zToken, 0));
2696c5499befSdrh       testcase( usedAsColumnCache(pParse, inReg, inReg) );
2697b3843a82Sdrh       sqlite3ExprCacheAffinityChange(pParse, inReg, 1);
2698487e262fSdrh       break;
2699487e262fSdrh     }
2700487e262fSdrh #endif /* SQLITE_OMIT_CAST */
2701c9b84a1fSdrh     case TK_LT:
2702c9b84a1fSdrh     case TK_LE:
2703c9b84a1fSdrh     case TK_GT:
2704c9b84a1fSdrh     case TK_GE:
2705c9b84a1fSdrh     case TK_NE:
2706c9b84a1fSdrh     case TK_EQ: {
2707b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
2708b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
270935573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
27107d176105Sdrh                   r1, r2, inReg, SQLITE_STOREP2);
27117d176105Sdrh       assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
27127d176105Sdrh       assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
27137d176105Sdrh       assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
27147d176105Sdrh       assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
27157d176105Sdrh       assert(TK_EQ==OP_Eq); testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
27167d176105Sdrh       assert(TK_NE==OP_Ne); testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
2717c5499befSdrh       testcase( regFree1==0 );
2718c5499befSdrh       testcase( regFree2==0 );
2719a37cdde0Sdanielk1977       break;
2720c9b84a1fSdrh     }
27216a2fe093Sdrh     case TK_IS:
27226a2fe093Sdrh     case TK_ISNOT: {
27236a2fe093Sdrh       testcase( op==TK_IS );
27246a2fe093Sdrh       testcase( op==TK_ISNOT );
2725b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
2726b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
27276a2fe093Sdrh       op = (op==TK_IS) ? TK_EQ : TK_NE;
27286a2fe093Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
27296a2fe093Sdrh                   r1, r2, inReg, SQLITE_STOREP2 | SQLITE_NULLEQ);
27307d176105Sdrh       VdbeCoverageIf(v, op==TK_EQ);
27317d176105Sdrh       VdbeCoverageIf(v, op==TK_NE);
27326a2fe093Sdrh       testcase( regFree1==0 );
27336a2fe093Sdrh       testcase( regFree2==0 );
27346a2fe093Sdrh       break;
27356a2fe093Sdrh     }
2736cce7d176Sdrh     case TK_AND:
2737cce7d176Sdrh     case TK_OR:
2738cce7d176Sdrh     case TK_PLUS:
2739cce7d176Sdrh     case TK_STAR:
2740cce7d176Sdrh     case TK_MINUS:
2741bf4133cbSdrh     case TK_REM:
2742bf4133cbSdrh     case TK_BITAND:
2743bf4133cbSdrh     case TK_BITOR:
274417c40294Sdrh     case TK_SLASH:
2745bf4133cbSdrh     case TK_LSHIFT:
2746855eb1cfSdrh     case TK_RSHIFT:
27470040077dSdrh     case TK_CONCAT: {
27487d176105Sdrh       assert( TK_AND==OP_And );            testcase( op==TK_AND );
27497d176105Sdrh       assert( TK_OR==OP_Or );              testcase( op==TK_OR );
27507d176105Sdrh       assert( TK_PLUS==OP_Add );           testcase( op==TK_PLUS );
27517d176105Sdrh       assert( TK_MINUS==OP_Subtract );     testcase( op==TK_MINUS );
27527d176105Sdrh       assert( TK_REM==OP_Remainder );      testcase( op==TK_REM );
27537d176105Sdrh       assert( TK_BITAND==OP_BitAnd );      testcase( op==TK_BITAND );
27547d176105Sdrh       assert( TK_BITOR==OP_BitOr );        testcase( op==TK_BITOR );
27557d176105Sdrh       assert( TK_SLASH==OP_Divide );       testcase( op==TK_SLASH );
27567d176105Sdrh       assert( TK_LSHIFT==OP_ShiftLeft );   testcase( op==TK_LSHIFT );
27577d176105Sdrh       assert( TK_RSHIFT==OP_ShiftRight );  testcase( op==TK_RSHIFT );
27587d176105Sdrh       assert( TK_CONCAT==OP_Concat );      testcase( op==TK_CONCAT );
27592dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
27602dcef11bSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
27615b6afba9Sdrh       sqlite3VdbeAddOp3(v, op, r2, r1, target);
2762c5499befSdrh       testcase( regFree1==0 );
2763c5499befSdrh       testcase( regFree2==0 );
27640040077dSdrh       break;
27650040077dSdrh     }
2766cce7d176Sdrh     case TK_UMINUS: {
2767fec19aadSdrh       Expr *pLeft = pExpr->pLeft;
2768fec19aadSdrh       assert( pLeft );
276913573c71Sdrh       if( pLeft->op==TK_INTEGER ){
277013573c71Sdrh         codeInteger(pParse, pLeft, 1, target);
277113573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
277213573c71Sdrh       }else if( pLeft->op==TK_FLOAT ){
277333e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
277433e619fcSdrh         codeReal(v, pLeft->u.zToken, 1, target);
277513573c71Sdrh #endif
27763c84ddffSdrh       }else{
277710d1edf0Sdrh         tempX.op = TK_INTEGER;
277810d1edf0Sdrh         tempX.flags = EP_IntValue|EP_TokenOnly;
277910d1edf0Sdrh         tempX.u.iValue = 0;
278010d1edf0Sdrh         r1 = sqlite3ExprCodeTemp(pParse, &tempX, &regFree1);
2781e55cbd72Sdrh         r2 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree2);
27822dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_Subtract, r2, r1, target);
2783c5499befSdrh         testcase( regFree2==0 );
27843c84ddffSdrh       }
27859de221dfSdrh       inReg = target;
27866e142f54Sdrh       break;
27876e142f54Sdrh     }
2788bf4133cbSdrh     case TK_BITNOT:
27896e142f54Sdrh     case TK_NOT: {
27907d176105Sdrh       assert( TK_BITNOT==OP_BitNot );   testcase( op==TK_BITNOT );
27917d176105Sdrh       assert( TK_NOT==OP_Not );         testcase( op==TK_NOT );
2792e99fa2afSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
2793e99fa2afSdrh       testcase( regFree1==0 );
2794e99fa2afSdrh       inReg = target;
2795e99fa2afSdrh       sqlite3VdbeAddOp2(v, op, r1, inReg);
2796cce7d176Sdrh       break;
2797cce7d176Sdrh     }
2798cce7d176Sdrh     case TK_ISNULL:
2799cce7d176Sdrh     case TK_NOTNULL: {
28006a288a33Sdrh       int addr;
28017d176105Sdrh       assert( TK_ISNULL==OP_IsNull );   testcase( op==TK_ISNULL );
28027d176105Sdrh       assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
28039de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
28042dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
2805c5499befSdrh       testcase( regFree1==0 );
28067d176105Sdrh       addr = sqlite3VdbeAddOp1(v, op, r1);
28077d176105Sdrh       VdbeCoverageIf(v, op==TK_ISNULL);
28087d176105Sdrh       VdbeCoverageIf(v, op==TK_NOTNULL);
2809a976979bSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 0, target);
28106a288a33Sdrh       sqlite3VdbeJumpHere(v, addr);
2811a37cdde0Sdanielk1977       break;
2812f2bc013cSdrh     }
28132282792aSdrh     case TK_AGG_FUNCTION: {
281413449892Sdrh       AggInfo *pInfo = pExpr->pAggInfo;
28157e56e711Sdrh       if( pInfo==0 ){
281633e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
281733e619fcSdrh         sqlite3ErrorMsg(pParse, "misuse of aggregate: %s()", pExpr->u.zToken);
28187e56e711Sdrh       }else{
28199de221dfSdrh         inReg = pInfo->aFunc[pExpr->iAgg].iMem;
28207e56e711Sdrh       }
28212282792aSdrh       break;
28222282792aSdrh     }
2823cce7d176Sdrh     case TK_FUNCTION: {
282412ffee8cSdrh       ExprList *pFarg;       /* List of function arguments */
282512ffee8cSdrh       int nFarg;             /* Number of function arguments */
282612ffee8cSdrh       FuncDef *pDef;         /* The function definition object */
282712ffee8cSdrh       int nId;               /* Length of the function name in bytes */
282812ffee8cSdrh       const char *zId;       /* The function name */
2829693e6719Sdrh       u32 constMask = 0;     /* Mask of function arguments that are constant */
283012ffee8cSdrh       int i;                 /* Loop counter */
283112ffee8cSdrh       u8 enc = ENC(db);      /* The text encoding used by this database */
283212ffee8cSdrh       CollSeq *pColl = 0;    /* A collating sequence */
283317435752Sdrh 
28346ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
2835c5cd1249Sdrh       if( ExprHasProperty(pExpr, EP_TokenOnly) ){
283612ffee8cSdrh         pFarg = 0;
283712ffee8cSdrh       }else{
283812ffee8cSdrh         pFarg = pExpr->x.pList;
283912ffee8cSdrh       }
284012ffee8cSdrh       nFarg = pFarg ? pFarg->nExpr : 0;
284133e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
284233e619fcSdrh       zId = pExpr->u.zToken;
2843b7916a78Sdrh       nId = sqlite3Strlen30(zId);
284412ffee8cSdrh       pDef = sqlite3FindFunction(db, zId, nId, nFarg, enc, 0);
28450c4de2d9Sdrh       if( pDef==0 || pDef->xFunc==0 ){
2846feb306f5Sdrh         sqlite3ErrorMsg(pParse, "unknown function: %.*s()", nId, zId);
2847feb306f5Sdrh         break;
2848feb306f5Sdrh       }
2849ae6bb957Sdrh 
2850ae6bb957Sdrh       /* Attempt a direct implementation of the built-in COALESCE() and
285160ec914cSpeter.d.reid       ** IFNULL() functions.  This avoids unnecessary evaluation of
2852ae6bb957Sdrh       ** arguments past the first non-NULL argument.
2853ae6bb957Sdrh       */
2854d36e1041Sdrh       if( pDef->funcFlags & SQLITE_FUNC_COALESCE ){
2855ae6bb957Sdrh         int endCoalesce = sqlite3VdbeMakeLabel(v);
2856ae6bb957Sdrh         assert( nFarg>=2 );
2857ae6bb957Sdrh         sqlite3ExprCode(pParse, pFarg->a[0].pExpr, target);
2858ae6bb957Sdrh         for(i=1; i<nFarg; i++){
2859ae6bb957Sdrh           sqlite3VdbeAddOp2(v, OP_NotNull, target, endCoalesce);
2860688852abSdrh           VdbeCoverage(v);
2861f49f3523Sdrh           sqlite3ExprCacheRemove(pParse, target, 1);
2862ae6bb957Sdrh           sqlite3ExprCachePush(pParse);
2863ae6bb957Sdrh           sqlite3ExprCode(pParse, pFarg->a[i].pExpr, target);
2864d2490904Sdrh           sqlite3ExprCachePop(pParse);
2865ae6bb957Sdrh         }
2866ae6bb957Sdrh         sqlite3VdbeResolveLabel(v, endCoalesce);
2867ae6bb957Sdrh         break;
2868ae6bb957Sdrh       }
2869ae6bb957Sdrh 
2870cca9f3d2Sdrh       /* The UNLIKELY() function is a no-op.  The result is the value
2871cca9f3d2Sdrh       ** of the first argument.
2872cca9f3d2Sdrh       */
2873cca9f3d2Sdrh       if( pDef->funcFlags & SQLITE_FUNC_UNLIKELY ){
2874cca9f3d2Sdrh         assert( nFarg>=1 );
28755f02ab09Sdrh         inReg = sqlite3ExprCodeTarget(pParse, pFarg->a[0].pExpr, target);
2876cca9f3d2Sdrh         break;
2877cca9f3d2Sdrh       }
2878ae6bb957Sdrh 
2879d1a01edaSdrh       for(i=0; i<nFarg; i++){
2880d1a01edaSdrh         if( i<32 && sqlite3ExprIsConstant(pFarg->a[i].pExpr) ){
2881693e6719Sdrh           testcase( i==31 );
2882693e6719Sdrh           constMask |= MASKBIT32(i);
2883d1a01edaSdrh         }
2884d1a01edaSdrh         if( (pDef->funcFlags & SQLITE_FUNC_NEEDCOLL)!=0 && !pColl ){
2885d1a01edaSdrh           pColl = sqlite3ExprCollSeq(pParse, pFarg->a[i].pExpr);
2886d1a01edaSdrh         }
2887d1a01edaSdrh       }
288812ffee8cSdrh       if( pFarg ){
2889d1a01edaSdrh         if( constMask ){
2890d1a01edaSdrh           r1 = pParse->nMem+1;
2891d1a01edaSdrh           pParse->nMem += nFarg;
2892d1a01edaSdrh         }else{
289312ffee8cSdrh           r1 = sqlite3GetTempRange(pParse, nFarg);
2894d1a01edaSdrh         }
2895a748fdccSdrh 
2896a748fdccSdrh         /* For length() and typeof() functions with a column argument,
2897a748fdccSdrh         ** set the P5 parameter to the OP_Column opcode to OPFLAG_LENGTHARG
2898a748fdccSdrh         ** or OPFLAG_TYPEOFARG respectively, to avoid unnecessary data
2899a748fdccSdrh         ** loading.
2900a748fdccSdrh         */
2901d36e1041Sdrh         if( (pDef->funcFlags & (SQLITE_FUNC_LENGTH|SQLITE_FUNC_TYPEOF))!=0 ){
29024e245a4cSdrh           u8 exprOp;
2903a748fdccSdrh           assert( nFarg==1 );
2904a748fdccSdrh           assert( pFarg->a[0].pExpr!=0 );
29054e245a4cSdrh           exprOp = pFarg->a[0].pExpr->op;
29064e245a4cSdrh           if( exprOp==TK_COLUMN || exprOp==TK_AGG_COLUMN ){
2907a748fdccSdrh             assert( SQLITE_FUNC_LENGTH==OPFLAG_LENGTHARG );
2908a748fdccSdrh             assert( SQLITE_FUNC_TYPEOF==OPFLAG_TYPEOFARG );
2909b1fba286Sdrh             testcase( pDef->funcFlags & OPFLAG_LENGTHARG );
2910b1fba286Sdrh             pFarg->a[0].pExpr->op2 =
2911b1fba286Sdrh                   pDef->funcFlags & (OPFLAG_LENGTHARG|OPFLAG_TYPEOFARG);
2912a748fdccSdrh           }
2913a748fdccSdrh         }
2914a748fdccSdrh 
2915d7d385ddSdrh         sqlite3ExprCachePush(pParse);     /* Ticket 2ea2425d34be */
2916d1a01edaSdrh         sqlite3ExprCodeExprList(pParse, pFarg, r1,
2917d1a01edaSdrh                                 SQLITE_ECEL_DUP|SQLITE_ECEL_FACTOR);
2918d2490904Sdrh         sqlite3ExprCachePop(pParse);      /* Ticket 2ea2425d34be */
2919892d3179Sdrh       }else{
292012ffee8cSdrh         r1 = 0;
2921892d3179Sdrh       }
2922b7f6f68fSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
2923a43fa227Sdrh       /* Possibly overload the function if the first argument is
2924a43fa227Sdrh       ** a virtual table column.
2925a43fa227Sdrh       **
2926a43fa227Sdrh       ** For infix functions (LIKE, GLOB, REGEXP, and MATCH) use the
2927a43fa227Sdrh       ** second argument, not the first, as the argument to test to
2928a43fa227Sdrh       ** see if it is a column in a virtual table.  This is done because
2929a43fa227Sdrh       ** the left operand of infix functions (the operand we want to
2930a43fa227Sdrh       ** control overloading) ends up as the second argument to the
2931a43fa227Sdrh       ** function.  The expression "A glob B" is equivalent to
2932a43fa227Sdrh       ** "glob(B,A).  We want to use the A in "A glob B" to test
2933a43fa227Sdrh       ** for function overloading.  But we use the B term in "glob(B,A)".
2934a43fa227Sdrh       */
293512ffee8cSdrh       if( nFarg>=2 && (pExpr->flags & EP_InfixFunc) ){
293612ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[1].pExpr);
293712ffee8cSdrh       }else if( nFarg>0 ){
293812ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[0].pExpr);
2939b7f6f68fSdrh       }
2940b7f6f68fSdrh #endif
2941d36e1041Sdrh       if( pDef->funcFlags & SQLITE_FUNC_NEEDCOLL ){
29428b213899Sdrh         if( !pColl ) pColl = db->pDfltColl;
294366a5167bSdrh         sqlite3VdbeAddOp4(v, OP_CollSeq, 0, 0, 0, (char *)pColl, P4_COLLSEQ);
2944682f68b0Sdanielk1977       }
29459c7c913cSdrh       sqlite3VdbeAddOp4(v, OP_Function0, constMask, r1, target,
294666a5167bSdrh                         (char*)pDef, P4_FUNCDEF);
294712ffee8cSdrh       sqlite3VdbeChangeP5(v, (u8)nFarg);
2948d1a01edaSdrh       if( nFarg && constMask==0 ){
294912ffee8cSdrh         sqlite3ReleaseTempRange(pParse, r1, nFarg);
29502dcef11bSdrh       }
29516ec2733bSdrh       break;
29526ec2733bSdrh     }
2953fe2093d7Sdrh #ifndef SQLITE_OMIT_SUBQUERY
2954fe2093d7Sdrh     case TK_EXISTS:
295519a775c2Sdrh     case TK_SELECT: {
2956c5499befSdrh       testcase( op==TK_EXISTS );
2957c5499befSdrh       testcase( op==TK_SELECT );
29581450bc6eSdrh       inReg = sqlite3CodeSubselect(pParse, pExpr, 0, 0);
295919a775c2Sdrh       break;
296019a775c2Sdrh     }
2961fef5208cSdrh     case TK_IN: {
2962e3365e6cSdrh       int destIfFalse = sqlite3VdbeMakeLabel(v);
2963e3365e6cSdrh       int destIfNull = sqlite3VdbeMakeLabel(v);
2964e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
2965e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
296666ba23ceSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
2967e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
2968e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_AddImm, target, 0);
2969e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfNull);
2970fef5208cSdrh       break;
2971fef5208cSdrh     }
2972e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
2973e3365e6cSdrh 
2974e3365e6cSdrh 
29752dcef11bSdrh     /*
29762dcef11bSdrh     **    x BETWEEN y AND z
29772dcef11bSdrh     **
29782dcef11bSdrh     ** This is equivalent to
29792dcef11bSdrh     **
29802dcef11bSdrh     **    x>=y AND x<=z
29812dcef11bSdrh     **
29822dcef11bSdrh     ** X is stored in pExpr->pLeft.
29832dcef11bSdrh     ** Y is stored in pExpr->pList->a[0].pExpr.
29842dcef11bSdrh     ** Z is stored in pExpr->pList->a[1].pExpr.
29852dcef11bSdrh     */
2986fef5208cSdrh     case TK_BETWEEN: {
2987be5c89acSdrh       Expr *pLeft = pExpr->pLeft;
29886ab3a2ecSdanielk1977       struct ExprList_item *pLItem = pExpr->x.pList->a;
2989be5c89acSdrh       Expr *pRight = pLItem->pExpr;
299035573356Sdrh 
2991b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pLeft, &regFree1);
2992b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pRight, &regFree2);
2993c5499befSdrh       testcase( regFree1==0 );
2994c5499befSdrh       testcase( regFree2==0 );
29952dcef11bSdrh       r3 = sqlite3GetTempReg(pParse);
2996678ccce8Sdrh       r4 = sqlite3GetTempReg(pParse);
299735573356Sdrh       codeCompare(pParse, pLeft, pRight, OP_Ge,
29987d176105Sdrh                   r1, r2, r3, SQLITE_STOREP2);  VdbeCoverage(v);
2999be5c89acSdrh       pLItem++;
3000be5c89acSdrh       pRight = pLItem->pExpr;
30012dcef11bSdrh       sqlite3ReleaseTempReg(pParse, regFree2);
30022dcef11bSdrh       r2 = sqlite3ExprCodeTemp(pParse, pRight, &regFree2);
3003c5499befSdrh       testcase( regFree2==0 );
3004678ccce8Sdrh       codeCompare(pParse, pLeft, pRight, OP_Le, r1, r2, r4, SQLITE_STOREP2);
3005688852abSdrh       VdbeCoverage(v);
3006678ccce8Sdrh       sqlite3VdbeAddOp3(v, OP_And, r3, r4, target);
30072dcef11bSdrh       sqlite3ReleaseTempReg(pParse, r3);
3008678ccce8Sdrh       sqlite3ReleaseTempReg(pParse, r4);
3009fef5208cSdrh       break;
3010fef5208cSdrh     }
3011ae80ddeaSdrh     case TK_COLLATE:
30124f07e5fbSdrh     case TK_UPLUS: {
30132dcef11bSdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
3014a2e00042Sdrh       break;
3015a2e00042Sdrh     }
30162dcef11bSdrh 
3017165921a7Sdan     case TK_TRIGGER: {
301865a7cd16Sdan       /* If the opcode is TK_TRIGGER, then the expression is a reference
301965a7cd16Sdan       ** to a column in the new.* or old.* pseudo-tables available to
302065a7cd16Sdan       ** trigger programs. In this case Expr.iTable is set to 1 for the
302165a7cd16Sdan       ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
302265a7cd16Sdan       ** is set to the column of the pseudo-table to read, or to -1 to
302365a7cd16Sdan       ** read the rowid field.
302465a7cd16Sdan       **
302565a7cd16Sdan       ** The expression is implemented using an OP_Param opcode. The p1
302665a7cd16Sdan       ** parameter is set to 0 for an old.rowid reference, or to (i+1)
302765a7cd16Sdan       ** to reference another column of the old.* pseudo-table, where
302865a7cd16Sdan       ** i is the index of the column. For a new.rowid reference, p1 is
302965a7cd16Sdan       ** set to (n+1), where n is the number of columns in each pseudo-table.
303065a7cd16Sdan       ** For a reference to any other column in the new.* pseudo-table, p1
303165a7cd16Sdan       ** is set to (n+2+i), where n and i are as defined previously. For
303265a7cd16Sdan       ** example, if the table on which triggers are being fired is
303365a7cd16Sdan       ** declared as:
303465a7cd16Sdan       **
303565a7cd16Sdan       **   CREATE TABLE t1(a, b);
303665a7cd16Sdan       **
303765a7cd16Sdan       ** Then p1 is interpreted as follows:
303865a7cd16Sdan       **
303965a7cd16Sdan       **   p1==0   ->    old.rowid     p1==3   ->    new.rowid
304065a7cd16Sdan       **   p1==1   ->    old.a         p1==4   ->    new.a
304165a7cd16Sdan       **   p1==2   ->    old.b         p1==5   ->    new.b
304265a7cd16Sdan       */
30432832ad42Sdan       Table *pTab = pExpr->pTab;
304465a7cd16Sdan       int p1 = pExpr->iTable * (pTab->nCol+1) + 1 + pExpr->iColumn;
304565a7cd16Sdan 
304665a7cd16Sdan       assert( pExpr->iTable==0 || pExpr->iTable==1 );
304765a7cd16Sdan       assert( pExpr->iColumn>=-1 && pExpr->iColumn<pTab->nCol );
304865a7cd16Sdan       assert( pTab->iPKey<0 || pExpr->iColumn!=pTab->iPKey );
304965a7cd16Sdan       assert( p1>=0 && p1<(pTab->nCol*2+2) );
305065a7cd16Sdan 
305165a7cd16Sdan       sqlite3VdbeAddOp2(v, OP_Param, p1, target);
305276d462eeSdan       VdbeComment((v, "%s.%s -> $%d",
3053165921a7Sdan         (pExpr->iTable ? "new" : "old"),
305476d462eeSdan         (pExpr->iColumn<0 ? "rowid" : pExpr->pTab->aCol[pExpr->iColumn].zName),
305576d462eeSdan         target
3056165921a7Sdan       ));
305765a7cd16Sdan 
305844dbca83Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
305965a7cd16Sdan       /* If the column has REAL affinity, it may currently be stored as an
3060113762a2Sdrh       ** integer. Use OP_RealAffinity to make sure it is really real.
3061113762a2Sdrh       **
3062113762a2Sdrh       ** EVIDENCE-OF: R-60985-57662 SQLite will convert the value back to
3063113762a2Sdrh       ** floating point when extracting it from the record.  */
30642832ad42Sdan       if( pExpr->iColumn>=0
30652832ad42Sdan        && pTab->aCol[pExpr->iColumn].affinity==SQLITE_AFF_REAL
30662832ad42Sdan       ){
30672832ad42Sdan         sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
30682832ad42Sdan       }
306944dbca83Sdrh #endif
3070165921a7Sdan       break;
3071165921a7Sdan     }
3072165921a7Sdan 
3073165921a7Sdan 
30742dcef11bSdrh     /*
30752dcef11bSdrh     ** Form A:
30762dcef11bSdrh     **   CASE x WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
30772dcef11bSdrh     **
30782dcef11bSdrh     ** Form B:
30792dcef11bSdrh     **   CASE WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
30802dcef11bSdrh     **
30812dcef11bSdrh     ** Form A is can be transformed into the equivalent form B as follows:
30822dcef11bSdrh     **   CASE WHEN x=e1 THEN r1 WHEN x=e2 THEN r2 ...
30832dcef11bSdrh     **        WHEN x=eN THEN rN ELSE y END
30842dcef11bSdrh     **
30852dcef11bSdrh     ** X (if it exists) is in pExpr->pLeft.
3086c5cd1249Sdrh     ** Y is in the last element of pExpr->x.pList if pExpr->x.pList->nExpr is
3087c5cd1249Sdrh     ** odd.  The Y is also optional.  If the number of elements in x.pList
3088c5cd1249Sdrh     ** is even, then Y is omitted and the "otherwise" result is NULL.
30892dcef11bSdrh     ** Ei is in pExpr->pList->a[i*2] and Ri is pExpr->pList->a[i*2+1].
30902dcef11bSdrh     **
30912dcef11bSdrh     ** The result of the expression is the Ri for the first matching Ei,
30922dcef11bSdrh     ** or if there is no matching Ei, the ELSE term Y, or if there is
30932dcef11bSdrh     ** no ELSE term, NULL.
30942dcef11bSdrh     */
309533cd4909Sdrh     default: assert( op==TK_CASE ); {
30962dcef11bSdrh       int endLabel;                     /* GOTO label for end of CASE stmt */
30972dcef11bSdrh       int nextCase;                     /* GOTO label for next WHEN clause */
30982dcef11bSdrh       int nExpr;                        /* 2x number of WHEN terms */
30992dcef11bSdrh       int i;                            /* Loop counter */
31002dcef11bSdrh       ExprList *pEList;                 /* List of WHEN terms */
31012dcef11bSdrh       struct ExprList_item *aListelem;  /* Array of WHEN terms */
31022dcef11bSdrh       Expr opCompare;                   /* The X==Ei expression */
31032dcef11bSdrh       Expr *pX;                         /* The X expression */
31041bd10f8aSdrh       Expr *pTest = 0;                  /* X==Ei (form A) or just Ei (form B) */
3105ceea3321Sdrh       VVA_ONLY( int iCacheLevel = pParse->iCacheLevel; )
310617a7f8ddSdrh 
31076ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) && pExpr->x.pList );
31086ab3a2ecSdanielk1977       assert(pExpr->x.pList->nExpr > 0);
31096ab3a2ecSdanielk1977       pEList = pExpr->x.pList;
3110be5c89acSdrh       aListelem = pEList->a;
3111be5c89acSdrh       nExpr = pEList->nExpr;
31122dcef11bSdrh       endLabel = sqlite3VdbeMakeLabel(v);
31132dcef11bSdrh       if( (pX = pExpr->pLeft)!=0 ){
311410d1edf0Sdrh         tempX = *pX;
311533cd4909Sdrh         testcase( pX->op==TK_COLUMN );
311610d1edf0Sdrh         exprToRegister(&tempX, sqlite3ExprCodeTemp(pParse, pX, &regFree1));
3117c5499befSdrh         testcase( regFree1==0 );
31182dcef11bSdrh         opCompare.op = TK_EQ;
311910d1edf0Sdrh         opCompare.pLeft = &tempX;
31202dcef11bSdrh         pTest = &opCompare;
31218b1db07fSdrh         /* Ticket b351d95f9cd5ef17e9d9dbae18f5ca8611190001:
31228b1db07fSdrh         ** The value in regFree1 might get SCopy-ed into the file result.
31238b1db07fSdrh         ** So make sure that the regFree1 register is not reused for other
31248b1db07fSdrh         ** purposes and possibly overwritten.  */
31258b1db07fSdrh         regFree1 = 0;
3126cce7d176Sdrh       }
3127c5cd1249Sdrh       for(i=0; i<nExpr-1; i=i+2){
3128ceea3321Sdrh         sqlite3ExprCachePush(pParse);
31292dcef11bSdrh         if( pX ){
31301bd10f8aSdrh           assert( pTest!=0 );
31312dcef11bSdrh           opCompare.pRight = aListelem[i].pExpr;
3132f5905aa7Sdrh         }else{
31332dcef11bSdrh           pTest = aListelem[i].pExpr;
313417a7f8ddSdrh         }
31352dcef11bSdrh         nextCase = sqlite3VdbeMakeLabel(v);
313633cd4909Sdrh         testcase( pTest->op==TK_COLUMN );
31372dcef11bSdrh         sqlite3ExprIfFalse(pParse, pTest, nextCase, SQLITE_JUMPIFNULL);
3138c5499befSdrh         testcase( aListelem[i+1].pExpr->op==TK_COLUMN );
31399de221dfSdrh         sqlite3ExprCode(pParse, aListelem[i+1].pExpr, target);
31402dcef11bSdrh         sqlite3VdbeAddOp2(v, OP_Goto, 0, endLabel);
3141d2490904Sdrh         sqlite3ExprCachePop(pParse);
31422dcef11bSdrh         sqlite3VdbeResolveLabel(v, nextCase);
3143f570f011Sdrh       }
3144c5cd1249Sdrh       if( (nExpr&1)!=0 ){
3145ceea3321Sdrh         sqlite3ExprCachePush(pParse);
3146c5cd1249Sdrh         sqlite3ExprCode(pParse, pEList->a[nExpr-1].pExpr, target);
3147d2490904Sdrh         sqlite3ExprCachePop(pParse);
314817a7f8ddSdrh       }else{
31499de221dfSdrh         sqlite3VdbeAddOp2(v, OP_Null, 0, target);
315017a7f8ddSdrh       }
3151c1f4a19bSdanielk1977       assert( db->mallocFailed || pParse->nErr>0
3152c1f4a19bSdanielk1977            || pParse->iCacheLevel==iCacheLevel );
31532dcef11bSdrh       sqlite3VdbeResolveLabel(v, endLabel);
31546f34903eSdanielk1977       break;
31556f34903eSdanielk1977     }
31565338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_TRIGGER
31576f34903eSdanielk1977     case TK_RAISE: {
3158165921a7Sdan       assert( pExpr->affinity==OE_Rollback
3159165921a7Sdan            || pExpr->affinity==OE_Abort
3160165921a7Sdan            || pExpr->affinity==OE_Fail
3161165921a7Sdan            || pExpr->affinity==OE_Ignore
3162165921a7Sdan       );
3163e0af83acSdan       if( !pParse->pTriggerTab ){
3164e0af83acSdan         sqlite3ErrorMsg(pParse,
3165e0af83acSdan                        "RAISE() may only be used within a trigger-program");
3166e0af83acSdan         return 0;
3167e0af83acSdan       }
3168e0af83acSdan       if( pExpr->affinity==OE_Abort ){
3169e0af83acSdan         sqlite3MayAbort(pParse);
3170e0af83acSdan       }
317133e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
3172e0af83acSdan       if( pExpr->affinity==OE_Ignore ){
3173e0af83acSdan         sqlite3VdbeAddOp4(
3174e0af83acSdan             v, OP_Halt, SQLITE_OK, OE_Ignore, 0, pExpr->u.zToken,0);
3175688852abSdrh         VdbeCoverage(v);
3176e0af83acSdan       }else{
3177433dccfbSdrh         sqlite3HaltConstraint(pParse, SQLITE_CONSTRAINT_TRIGGER,
3178f9c8ce3cSdrh                               pExpr->affinity, pExpr->u.zToken, 0, 0);
3179e0af83acSdan       }
3180e0af83acSdan 
3181ffe07b2dSdrh       break;
318217a7f8ddSdrh     }
31835338a5f7Sdanielk1977 #endif
3184ffe07b2dSdrh   }
31852dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
31862dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
31872dcef11bSdrh   return inReg;
31885b6afba9Sdrh }
31892dcef11bSdrh 
31902dcef11bSdrh /*
3191d1a01edaSdrh ** Factor out the code of the given expression to initialization time.
3192d1a01edaSdrh */
3193d673cddaSdrh void sqlite3ExprCodeAtInit(
3194d673cddaSdrh   Parse *pParse,    /* Parsing context */
3195d673cddaSdrh   Expr *pExpr,      /* The expression to code when the VDBE initializes */
3196d673cddaSdrh   int regDest,      /* Store the value in this register */
3197d673cddaSdrh   u8 reusable       /* True if this expression is reusable */
3198d673cddaSdrh ){
3199d1a01edaSdrh   ExprList *p;
3200d9f158e7Sdrh   assert( ConstFactorOk(pParse) );
3201d1a01edaSdrh   p = pParse->pConstExpr;
3202d1a01edaSdrh   pExpr = sqlite3ExprDup(pParse->db, pExpr, 0);
3203d1a01edaSdrh   p = sqlite3ExprListAppend(pParse, p, pExpr);
3204d673cddaSdrh   if( p ){
3205d673cddaSdrh      struct ExprList_item *pItem = &p->a[p->nExpr-1];
3206d673cddaSdrh      pItem->u.iConstExprReg = regDest;
3207d673cddaSdrh      pItem->reusable = reusable;
3208d673cddaSdrh   }
3209d1a01edaSdrh   pParse->pConstExpr = p;
3210d1a01edaSdrh }
3211d1a01edaSdrh 
3212d1a01edaSdrh /*
32132dcef11bSdrh ** Generate code to evaluate an expression and store the results
32142dcef11bSdrh ** into a register.  Return the register number where the results
32152dcef11bSdrh ** are stored.
32162dcef11bSdrh **
32172dcef11bSdrh ** If the register is a temporary register that can be deallocated,
3218678ccce8Sdrh ** then write its number into *pReg.  If the result register is not
32192dcef11bSdrh ** a temporary, then set *pReg to zero.
3220f30a969bSdrh **
3221f30a969bSdrh ** If pExpr is a constant, then this routine might generate this
3222f30a969bSdrh ** code to fill the register in the initialization section of the
3223f30a969bSdrh ** VDBE program, in order to factor it out of the evaluation loop.
32242dcef11bSdrh */
32252dcef11bSdrh int sqlite3ExprCodeTemp(Parse *pParse, Expr *pExpr, int *pReg){
3226f30a969bSdrh   int r2;
3227f30a969bSdrh   pExpr = sqlite3ExprSkipCollate(pExpr);
3228d9f158e7Sdrh   if( ConstFactorOk(pParse)
3229f30a969bSdrh    && pExpr->op!=TK_REGISTER
3230f30a969bSdrh    && sqlite3ExprIsConstantNotJoin(pExpr)
3231f30a969bSdrh   ){
3232f30a969bSdrh     ExprList *p = pParse->pConstExpr;
3233f30a969bSdrh     int i;
3234f30a969bSdrh     *pReg  = 0;
3235f30a969bSdrh     if( p ){
3236d673cddaSdrh       struct ExprList_item *pItem;
3237d673cddaSdrh       for(pItem=p->a, i=p->nExpr; i>0; pItem++, i--){
3238d673cddaSdrh         if( pItem->reusable && sqlite3ExprCompare(pItem->pExpr,pExpr,-1)==0 ){
3239d673cddaSdrh           return pItem->u.iConstExprReg;
3240f30a969bSdrh         }
3241f30a969bSdrh       }
3242f30a969bSdrh     }
3243f30a969bSdrh     r2 = ++pParse->nMem;
3244d673cddaSdrh     sqlite3ExprCodeAtInit(pParse, pExpr, r2, 1);
3245f30a969bSdrh   }else{
32462dcef11bSdrh     int r1 = sqlite3GetTempReg(pParse);
3247f30a969bSdrh     r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
32482dcef11bSdrh     if( r2==r1 ){
32492dcef11bSdrh       *pReg = r1;
32502dcef11bSdrh     }else{
32512dcef11bSdrh       sqlite3ReleaseTempReg(pParse, r1);
32522dcef11bSdrh       *pReg = 0;
32532dcef11bSdrh     }
3254f30a969bSdrh   }
32552dcef11bSdrh   return r2;
32562dcef11bSdrh }
32572dcef11bSdrh 
32582dcef11bSdrh /*
32592dcef11bSdrh ** Generate code that will evaluate expression pExpr and store the
32602dcef11bSdrh ** results in register target.  The results are guaranteed to appear
32612dcef11bSdrh ** in register target.
32622dcef11bSdrh */
326305a86c5cSdrh void sqlite3ExprCode(Parse *pParse, Expr *pExpr, int target){
32649cbf3425Sdrh   int inReg;
32659cbf3425Sdrh 
32669cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
3267ebc16717Sdrh   if( pExpr && pExpr->op==TK_REGISTER ){
3268ebc16717Sdrh     sqlite3VdbeAddOp2(pParse->pVdbe, OP_Copy, pExpr->iTable, target);
3269ebc16717Sdrh   }else{
32709cbf3425Sdrh     inReg = sqlite3ExprCodeTarget(pParse, pExpr, target);
32710e359b30Sdrh     assert( pParse->pVdbe || pParse->db->mallocFailed );
32720e359b30Sdrh     if( inReg!=target && pParse->pVdbe ){
32739cbf3425Sdrh       sqlite3VdbeAddOp2(pParse->pVdbe, OP_SCopy, inReg, target);
327417a7f8ddSdrh     }
3275ebc16717Sdrh   }
327605a86c5cSdrh }
327705a86c5cSdrh 
327805a86c5cSdrh /*
327905a86c5cSdrh ** Generate code that will evaluate expression pExpr and store the
328005a86c5cSdrh ** results in register target.  The results are guaranteed to appear
328105a86c5cSdrh ** in register target.  If the expression is constant, then this routine
328205a86c5cSdrh ** might choose to code the expression at initialization time.
328305a86c5cSdrh */
328405a86c5cSdrh void sqlite3ExprCodeFactorable(Parse *pParse, Expr *pExpr, int target){
328505a86c5cSdrh   if( pParse->okConstFactor && sqlite3ExprIsConstant(pExpr) ){
328605a86c5cSdrh     sqlite3ExprCodeAtInit(pParse, pExpr, target, 0);
328705a86c5cSdrh   }else{
328805a86c5cSdrh     sqlite3ExprCode(pParse, pExpr, target);
328905a86c5cSdrh   }
3290cce7d176Sdrh }
3291cce7d176Sdrh 
3292cce7d176Sdrh /*
329360ec914cSpeter.d.reid ** Generate code that evaluates the given expression and puts the result
3294de4fcfddSdrh ** in register target.
329525303780Sdrh **
32962dcef11bSdrh ** Also make a copy of the expression results into another "cache" register
32972dcef11bSdrh ** and modify the expression so that the next time it is evaluated,
32982dcef11bSdrh ** the result is a copy of the cache register.
32992dcef11bSdrh **
33002dcef11bSdrh ** This routine is used for expressions that are used multiple
33012dcef11bSdrh ** times.  They are evaluated once and the results of the expression
33022dcef11bSdrh ** are reused.
330325303780Sdrh */
330405a86c5cSdrh void sqlite3ExprCodeAndCache(Parse *pParse, Expr *pExpr, int target){
330525303780Sdrh   Vdbe *v = pParse->pVdbe;
330625303780Sdrh   int iMem;
330705a86c5cSdrh 
330805a86c5cSdrh   assert( target>0 );
330905a86c5cSdrh   assert( pExpr->op!=TK_REGISTER );
331005a86c5cSdrh   sqlite3ExprCode(pParse, pExpr, target);
33112dcef11bSdrh   iMem = ++pParse->nMem;
331205a86c5cSdrh   sqlite3VdbeAddOp2(v, OP_Copy, target, iMem);
3313a4c3c87eSdrh   exprToRegister(pExpr, iMem);
331425303780Sdrh }
33152dcef11bSdrh 
3316678ccce8Sdrh /*
3317268380caSdrh ** Generate code that pushes the value of every element of the given
33189cbf3425Sdrh ** expression list into a sequence of registers beginning at target.
3319268380caSdrh **
3320892d3179Sdrh ** Return the number of elements evaluated.
3321d1a01edaSdrh **
3322d1a01edaSdrh ** The SQLITE_ECEL_DUP flag prevents the arguments from being
3323d1a01edaSdrh ** filled using OP_SCopy.  OP_Copy must be used instead.
3324d1a01edaSdrh **
3325d1a01edaSdrh ** The SQLITE_ECEL_FACTOR argument allows constant arguments to be
3326d1a01edaSdrh ** factored out into initialization code.
3327268380caSdrh */
33284adee20fSdanielk1977 int sqlite3ExprCodeExprList(
3329268380caSdrh   Parse *pParse,     /* Parsing context */
3330389a1adbSdrh   ExprList *pList,   /* The expression list to be coded */
3331191b54cbSdrh   int target,        /* Where to write results */
3332d1a01edaSdrh   u8 flags           /* SQLITE_ECEL_* flags */
3333268380caSdrh ){
3334268380caSdrh   struct ExprList_item *pItem;
33359cbf3425Sdrh   int i, n;
3336d1a01edaSdrh   u8 copyOp = (flags & SQLITE_ECEL_DUP) ? OP_Copy : OP_SCopy;
33379d8b3072Sdrh   assert( pList!=0 );
33389cbf3425Sdrh   assert( target>0 );
3339d81a142bSdrh   assert( pParse->pVdbe!=0 );  /* Never gets this far otherwise */
3340268380caSdrh   n = pList->nExpr;
3341d9f158e7Sdrh   if( !ConstFactorOk(pParse) ) flags &= ~SQLITE_ECEL_FACTOR;
3342191b54cbSdrh   for(pItem=pList->a, i=0; i<n; i++, pItem++){
33437445ffe2Sdrh     Expr *pExpr = pItem->pExpr;
3344d1a01edaSdrh     if( (flags & SQLITE_ECEL_FACTOR)!=0 && sqlite3ExprIsConstant(pExpr) ){
3345d673cddaSdrh       sqlite3ExprCodeAtInit(pParse, pExpr, target+i, 0);
3346d1a01edaSdrh     }else{
33477445ffe2Sdrh       int inReg = sqlite3ExprCodeTarget(pParse, pExpr, target+i);
3348746fd9ccSdrh       if( inReg!=target+i ){
33494eded604Sdrh         VdbeOp *pOp;
33504eded604Sdrh         Vdbe *v = pParse->pVdbe;
33514eded604Sdrh         if( copyOp==OP_Copy
33524eded604Sdrh          && (pOp=sqlite3VdbeGetOp(v, -1))->opcode==OP_Copy
33534eded604Sdrh          && pOp->p1+pOp->p3+1==inReg
33544eded604Sdrh          && pOp->p2+pOp->p3+1==target+i
33554eded604Sdrh         ){
33564eded604Sdrh           pOp->p3++;
33574eded604Sdrh         }else{
33584eded604Sdrh           sqlite3VdbeAddOp2(v, copyOp, inReg, target+i);
33594eded604Sdrh         }
3360d1a01edaSdrh       }
3361d176611bSdrh     }
3362268380caSdrh   }
3363f9b596ebSdrh   return n;
3364268380caSdrh }
3365268380caSdrh 
3366268380caSdrh /*
336736c563a2Sdrh ** Generate code for a BETWEEN operator.
336836c563a2Sdrh **
336936c563a2Sdrh **    x BETWEEN y AND z
337036c563a2Sdrh **
337136c563a2Sdrh ** The above is equivalent to
337236c563a2Sdrh **
337336c563a2Sdrh **    x>=y AND x<=z
337436c563a2Sdrh **
337536c563a2Sdrh ** Code it as such, taking care to do the common subexpression
337660ec914cSpeter.d.reid ** elimination of x.
337736c563a2Sdrh */
337836c563a2Sdrh static void exprCodeBetween(
337936c563a2Sdrh   Parse *pParse,    /* Parsing and code generating context */
338036c563a2Sdrh   Expr *pExpr,      /* The BETWEEN expression */
338136c563a2Sdrh   int dest,         /* Jump here if the jump is taken */
338236c563a2Sdrh   int jumpIfTrue,   /* Take the jump if the BETWEEN is true */
338336c563a2Sdrh   int jumpIfNull    /* Take the jump if the BETWEEN is NULL */
338436c563a2Sdrh ){
338536c563a2Sdrh   Expr exprAnd;     /* The AND operator in  x>=y AND x<=z  */
338636c563a2Sdrh   Expr compLeft;    /* The  x>=y  term */
338736c563a2Sdrh   Expr compRight;   /* The  x<=z  term */
338836c563a2Sdrh   Expr exprX;       /* The  x  subexpression */
338936c563a2Sdrh   int regFree1 = 0; /* Temporary use register */
339036c563a2Sdrh 
339136c563a2Sdrh   assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
339236c563a2Sdrh   exprX = *pExpr->pLeft;
339336c563a2Sdrh   exprAnd.op = TK_AND;
339436c563a2Sdrh   exprAnd.pLeft = &compLeft;
339536c563a2Sdrh   exprAnd.pRight = &compRight;
339636c563a2Sdrh   compLeft.op = TK_GE;
339736c563a2Sdrh   compLeft.pLeft = &exprX;
339836c563a2Sdrh   compLeft.pRight = pExpr->x.pList->a[0].pExpr;
339936c563a2Sdrh   compRight.op = TK_LE;
340036c563a2Sdrh   compRight.pLeft = &exprX;
340136c563a2Sdrh   compRight.pRight = pExpr->x.pList->a[1].pExpr;
3402a4c3c87eSdrh   exprToRegister(&exprX, sqlite3ExprCodeTemp(pParse, &exprX, &regFree1));
340336c563a2Sdrh   if( jumpIfTrue ){
340436c563a2Sdrh     sqlite3ExprIfTrue(pParse, &exprAnd, dest, jumpIfNull);
340536c563a2Sdrh   }else{
340636c563a2Sdrh     sqlite3ExprIfFalse(pParse, &exprAnd, dest, jumpIfNull);
340736c563a2Sdrh   }
340836c563a2Sdrh   sqlite3ReleaseTempReg(pParse, regFree1);
340936c563a2Sdrh 
341036c563a2Sdrh   /* Ensure adequate test coverage */
341136c563a2Sdrh   testcase( jumpIfTrue==0 && jumpIfNull==0 && regFree1==0 );
341236c563a2Sdrh   testcase( jumpIfTrue==0 && jumpIfNull==0 && regFree1!=0 );
341336c563a2Sdrh   testcase( jumpIfTrue==0 && jumpIfNull!=0 && regFree1==0 );
341436c563a2Sdrh   testcase( jumpIfTrue==0 && jumpIfNull!=0 && regFree1!=0 );
341536c563a2Sdrh   testcase( jumpIfTrue!=0 && jumpIfNull==0 && regFree1==0 );
341636c563a2Sdrh   testcase( jumpIfTrue!=0 && jumpIfNull==0 && regFree1!=0 );
341736c563a2Sdrh   testcase( jumpIfTrue!=0 && jumpIfNull!=0 && regFree1==0 );
341836c563a2Sdrh   testcase( jumpIfTrue!=0 && jumpIfNull!=0 && regFree1!=0 );
341936c563a2Sdrh }
342036c563a2Sdrh 
342136c563a2Sdrh /*
3422cce7d176Sdrh ** Generate code for a boolean expression such that a jump is made
3423cce7d176Sdrh ** to the label "dest" if the expression is true but execution
3424cce7d176Sdrh ** continues straight thru if the expression is false.
3425f5905aa7Sdrh **
3426f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false), then
342735573356Sdrh ** take the jump if the jumpIfNull flag is SQLITE_JUMPIFNULL.
3428f2bc013cSdrh **
3429f2bc013cSdrh ** This code depends on the fact that certain token values (ex: TK_EQ)
3430f2bc013cSdrh ** are the same as opcode values (ex: OP_Eq) that implement the corresponding
3431f2bc013cSdrh ** operation.  Special comments in vdbe.c and the mkopcodeh.awk script in
3432f2bc013cSdrh ** the make process cause these values to align.  Assert()s in the code
3433f2bc013cSdrh ** below verify that the numbers are aligned correctly.
3434cce7d176Sdrh */
34354adee20fSdanielk1977 void sqlite3ExprIfTrue(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
3436cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
3437cce7d176Sdrh   int op = 0;
34382dcef11bSdrh   int regFree1 = 0;
34392dcef11bSdrh   int regFree2 = 0;
34402dcef11bSdrh   int r1, r2;
34412dcef11bSdrh 
344235573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
344348864df9Smistachkin   if( NEVER(v==0) )     return;  /* Existence of VDBE checked by caller */
344433cd4909Sdrh   if( NEVER(pExpr==0) ) return;  /* No way this can happen */
3445f2bc013cSdrh   op = pExpr->op;
3446f2bc013cSdrh   switch( op ){
3447cce7d176Sdrh     case TK_AND: {
34484adee20fSdanielk1977       int d2 = sqlite3VdbeMakeLabel(v);
3449c5499befSdrh       testcase( jumpIfNull==0 );
345035573356Sdrh       sqlite3ExprIfFalse(pParse, pExpr->pLeft, d2,jumpIfNull^SQLITE_JUMPIFNULL);
345154e2adb5Sdrh       sqlite3ExprCachePush(pParse);
34524adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
34534adee20fSdanielk1977       sqlite3VdbeResolveLabel(v, d2);
3454d2490904Sdrh       sqlite3ExprCachePop(pParse);
3455cce7d176Sdrh       break;
3456cce7d176Sdrh     }
3457cce7d176Sdrh     case TK_OR: {
3458c5499befSdrh       testcase( jumpIfNull==0 );
34594adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
346054e2adb5Sdrh       sqlite3ExprCachePush(pParse);
34614adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
3462d2490904Sdrh       sqlite3ExprCachePop(pParse);
3463cce7d176Sdrh       break;
3464cce7d176Sdrh     }
3465cce7d176Sdrh     case TK_NOT: {
3466c5499befSdrh       testcase( jumpIfNull==0 );
34674adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
3468cce7d176Sdrh       break;
3469cce7d176Sdrh     }
3470cce7d176Sdrh     case TK_LT:
3471cce7d176Sdrh     case TK_LE:
3472cce7d176Sdrh     case TK_GT:
3473cce7d176Sdrh     case TK_GE:
3474cce7d176Sdrh     case TK_NE:
34750ac65892Sdrh     case TK_EQ: {
3476c5499befSdrh       testcase( jumpIfNull==0 );
3477b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3478b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
347935573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
34807d176105Sdrh                   r1, r2, dest, jumpIfNull);
34817d176105Sdrh       assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
34827d176105Sdrh       assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
34837d176105Sdrh       assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
34847d176105Sdrh       assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
34857d176105Sdrh       assert(TK_EQ==OP_Eq); testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
34867d176105Sdrh       assert(TK_NE==OP_Ne); testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
3487c5499befSdrh       testcase( regFree1==0 );
3488c5499befSdrh       testcase( regFree2==0 );
3489cce7d176Sdrh       break;
3490cce7d176Sdrh     }
34916a2fe093Sdrh     case TK_IS:
34926a2fe093Sdrh     case TK_ISNOT: {
34936a2fe093Sdrh       testcase( op==TK_IS );
34946a2fe093Sdrh       testcase( op==TK_ISNOT );
3495b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3496b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
34976a2fe093Sdrh       op = (op==TK_IS) ? TK_EQ : TK_NE;
34986a2fe093Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
34997d176105Sdrh                   r1, r2, dest, SQLITE_NULLEQ);
35007d176105Sdrh       VdbeCoverageIf(v, op==TK_EQ);
35017d176105Sdrh       VdbeCoverageIf(v, op==TK_NE);
35026a2fe093Sdrh       testcase( regFree1==0 );
35036a2fe093Sdrh       testcase( regFree2==0 );
35046a2fe093Sdrh       break;
35056a2fe093Sdrh     }
3506cce7d176Sdrh     case TK_ISNULL:
3507cce7d176Sdrh     case TK_NOTNULL: {
35087d176105Sdrh       assert( TK_ISNULL==OP_IsNull );   testcase( op==TK_ISNULL );
35097d176105Sdrh       assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
35102dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
35117d176105Sdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
35127d176105Sdrh       VdbeCoverageIf(v, op==TK_ISNULL);
35137d176105Sdrh       VdbeCoverageIf(v, op==TK_NOTNULL);
3514c5499befSdrh       testcase( regFree1==0 );
3515cce7d176Sdrh       break;
3516cce7d176Sdrh     }
3517fef5208cSdrh     case TK_BETWEEN: {
35185c03f30aSdrh       testcase( jumpIfNull==0 );
351936c563a2Sdrh       exprCodeBetween(pParse, pExpr, dest, 1, jumpIfNull);
3520fef5208cSdrh       break;
3521fef5208cSdrh     }
3522bb201344Sshaneh #ifndef SQLITE_OMIT_SUBQUERY
3523e3365e6cSdrh     case TK_IN: {
3524e3365e6cSdrh       int destIfFalse = sqlite3VdbeMakeLabel(v);
3525e3365e6cSdrh       int destIfNull = jumpIfNull ? dest : destIfFalse;
3526e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
3527e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_Goto, 0, dest);
3528e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
3529e3365e6cSdrh       break;
3530e3365e6cSdrh     }
3531bb201344Sshaneh #endif
3532cce7d176Sdrh     default: {
3533991a1985Sdrh       if( exprAlwaysTrue(pExpr) ){
3534991a1985Sdrh         sqlite3VdbeAddOp2(v, OP_Goto, 0, dest);
3535991a1985Sdrh       }else if( exprAlwaysFalse(pExpr) ){
3536991a1985Sdrh         /* No-op */
3537991a1985Sdrh       }else{
35382dcef11bSdrh         r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
35392dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_If, r1, dest, jumpIfNull!=0);
3540688852abSdrh         VdbeCoverage(v);
3541c5499befSdrh         testcase( regFree1==0 );
3542c5499befSdrh         testcase( jumpIfNull==0 );
3543991a1985Sdrh       }
3544cce7d176Sdrh       break;
3545cce7d176Sdrh     }
3546cce7d176Sdrh   }
35472dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
35482dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
3549cce7d176Sdrh }
3550cce7d176Sdrh 
3551cce7d176Sdrh /*
355266b89c8fSdrh ** Generate code for a boolean expression such that a jump is made
3553cce7d176Sdrh ** to the label "dest" if the expression is false but execution
3554cce7d176Sdrh ** continues straight thru if the expression is true.
3555f5905aa7Sdrh **
3556f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false) then
355735573356Sdrh ** jump if jumpIfNull is SQLITE_JUMPIFNULL or fall through if jumpIfNull
355835573356Sdrh ** is 0.
3559cce7d176Sdrh */
35604adee20fSdanielk1977 void sqlite3ExprIfFalse(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
3561cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
3562cce7d176Sdrh   int op = 0;
35632dcef11bSdrh   int regFree1 = 0;
35642dcef11bSdrh   int regFree2 = 0;
35652dcef11bSdrh   int r1, r2;
35662dcef11bSdrh 
356735573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
356848864df9Smistachkin   if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
356933cd4909Sdrh   if( pExpr==0 )    return;
3570f2bc013cSdrh 
3571f2bc013cSdrh   /* The value of pExpr->op and op are related as follows:
3572f2bc013cSdrh   **
3573f2bc013cSdrh   **       pExpr->op            op
3574f2bc013cSdrh   **       ---------          ----------
3575f2bc013cSdrh   **       TK_ISNULL          OP_NotNull
3576f2bc013cSdrh   **       TK_NOTNULL         OP_IsNull
3577f2bc013cSdrh   **       TK_NE              OP_Eq
3578f2bc013cSdrh   **       TK_EQ              OP_Ne
3579f2bc013cSdrh   **       TK_GT              OP_Le
3580f2bc013cSdrh   **       TK_LE              OP_Gt
3581f2bc013cSdrh   **       TK_GE              OP_Lt
3582f2bc013cSdrh   **       TK_LT              OP_Ge
3583f2bc013cSdrh   **
3584f2bc013cSdrh   ** For other values of pExpr->op, op is undefined and unused.
3585f2bc013cSdrh   ** The value of TK_ and OP_ constants are arranged such that we
3586f2bc013cSdrh   ** can compute the mapping above using the following expression.
3587f2bc013cSdrh   ** Assert()s verify that the computation is correct.
3588f2bc013cSdrh   */
3589f2bc013cSdrh   op = ((pExpr->op+(TK_ISNULL&1))^1)-(TK_ISNULL&1);
3590f2bc013cSdrh 
3591f2bc013cSdrh   /* Verify correct alignment of TK_ and OP_ constants
3592f2bc013cSdrh   */
3593f2bc013cSdrh   assert( pExpr->op!=TK_ISNULL || op==OP_NotNull );
3594f2bc013cSdrh   assert( pExpr->op!=TK_NOTNULL || op==OP_IsNull );
3595f2bc013cSdrh   assert( pExpr->op!=TK_NE || op==OP_Eq );
3596f2bc013cSdrh   assert( pExpr->op!=TK_EQ || op==OP_Ne );
3597f2bc013cSdrh   assert( pExpr->op!=TK_LT || op==OP_Ge );
3598f2bc013cSdrh   assert( pExpr->op!=TK_LE || op==OP_Gt );
3599f2bc013cSdrh   assert( pExpr->op!=TK_GT || op==OP_Le );
3600f2bc013cSdrh   assert( pExpr->op!=TK_GE || op==OP_Lt );
3601f2bc013cSdrh 
3602cce7d176Sdrh   switch( pExpr->op ){
3603cce7d176Sdrh     case TK_AND: {
3604c5499befSdrh       testcase( jumpIfNull==0 );
36054adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
360654e2adb5Sdrh       sqlite3ExprCachePush(pParse);
36074adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
3608d2490904Sdrh       sqlite3ExprCachePop(pParse);
3609cce7d176Sdrh       break;
3610cce7d176Sdrh     }
3611cce7d176Sdrh     case TK_OR: {
36124adee20fSdanielk1977       int d2 = sqlite3VdbeMakeLabel(v);
3613c5499befSdrh       testcase( jumpIfNull==0 );
361435573356Sdrh       sqlite3ExprIfTrue(pParse, pExpr->pLeft, d2, jumpIfNull^SQLITE_JUMPIFNULL);
361554e2adb5Sdrh       sqlite3ExprCachePush(pParse);
36164adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
36174adee20fSdanielk1977       sqlite3VdbeResolveLabel(v, d2);
3618d2490904Sdrh       sqlite3ExprCachePop(pParse);
3619cce7d176Sdrh       break;
3620cce7d176Sdrh     }
3621cce7d176Sdrh     case TK_NOT: {
36225c03f30aSdrh       testcase( jumpIfNull==0 );
36234adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
3624cce7d176Sdrh       break;
3625cce7d176Sdrh     }
3626cce7d176Sdrh     case TK_LT:
3627cce7d176Sdrh     case TK_LE:
3628cce7d176Sdrh     case TK_GT:
3629cce7d176Sdrh     case TK_GE:
3630cce7d176Sdrh     case TK_NE:
3631cce7d176Sdrh     case TK_EQ: {
3632c5499befSdrh       testcase( jumpIfNull==0 );
3633b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3634b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
363535573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
36367d176105Sdrh                   r1, r2, dest, jumpIfNull);
36377d176105Sdrh       assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
36387d176105Sdrh       assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
36397d176105Sdrh       assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
36407d176105Sdrh       assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
36417d176105Sdrh       assert(TK_EQ==OP_Eq); testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
36427d176105Sdrh       assert(TK_NE==OP_Ne); testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
3643c5499befSdrh       testcase( regFree1==0 );
3644c5499befSdrh       testcase( regFree2==0 );
3645cce7d176Sdrh       break;
3646cce7d176Sdrh     }
36476a2fe093Sdrh     case TK_IS:
36486a2fe093Sdrh     case TK_ISNOT: {
36496d4486aeSdrh       testcase( pExpr->op==TK_IS );
36506d4486aeSdrh       testcase( pExpr->op==TK_ISNOT );
3651b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3652b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
36536a2fe093Sdrh       op = (pExpr->op==TK_IS) ? TK_NE : TK_EQ;
36546a2fe093Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
36557d176105Sdrh                   r1, r2, dest, SQLITE_NULLEQ);
36567d176105Sdrh       VdbeCoverageIf(v, op==TK_EQ);
36577d176105Sdrh       VdbeCoverageIf(v, op==TK_NE);
36586a2fe093Sdrh       testcase( regFree1==0 );
36596a2fe093Sdrh       testcase( regFree2==0 );
36606a2fe093Sdrh       break;
36616a2fe093Sdrh     }
3662cce7d176Sdrh     case TK_ISNULL:
3663cce7d176Sdrh     case TK_NOTNULL: {
36642dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
36657d176105Sdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
36667d176105Sdrh       testcase( op==TK_ISNULL );   VdbeCoverageIf(v, op==TK_ISNULL);
36677d176105Sdrh       testcase( op==TK_NOTNULL );  VdbeCoverageIf(v, op==TK_NOTNULL);
3668c5499befSdrh       testcase( regFree1==0 );
3669cce7d176Sdrh       break;
3670cce7d176Sdrh     }
3671fef5208cSdrh     case TK_BETWEEN: {
36725c03f30aSdrh       testcase( jumpIfNull==0 );
367336c563a2Sdrh       exprCodeBetween(pParse, pExpr, dest, 0, jumpIfNull);
3674fef5208cSdrh       break;
3675fef5208cSdrh     }
3676bb201344Sshaneh #ifndef SQLITE_OMIT_SUBQUERY
3677e3365e6cSdrh     case TK_IN: {
3678e3365e6cSdrh       if( jumpIfNull ){
3679e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, dest);
3680e3365e6cSdrh       }else{
3681e3365e6cSdrh         int destIfNull = sqlite3VdbeMakeLabel(v);
3682e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, destIfNull);
3683e3365e6cSdrh         sqlite3VdbeResolveLabel(v, destIfNull);
3684e3365e6cSdrh       }
3685e3365e6cSdrh       break;
3686e3365e6cSdrh     }
3687bb201344Sshaneh #endif
3688cce7d176Sdrh     default: {
3689991a1985Sdrh       if( exprAlwaysFalse(pExpr) ){
3690991a1985Sdrh         sqlite3VdbeAddOp2(v, OP_Goto, 0, dest);
3691991a1985Sdrh       }else if( exprAlwaysTrue(pExpr) ){
3692991a1985Sdrh         /* no-op */
3693991a1985Sdrh       }else{
36942dcef11bSdrh         r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
36952dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_IfNot, r1, dest, jumpIfNull!=0);
3696688852abSdrh         VdbeCoverage(v);
3697c5499befSdrh         testcase( regFree1==0 );
3698c5499befSdrh         testcase( jumpIfNull==0 );
3699991a1985Sdrh       }
3700cce7d176Sdrh       break;
3701cce7d176Sdrh     }
3702cce7d176Sdrh   }
37032dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
37042dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
3705cce7d176Sdrh }
37062282792aSdrh 
37072282792aSdrh /*
370872bc8208Sdrh ** Like sqlite3ExprIfFalse() except that a copy is made of pExpr before
370972bc8208Sdrh ** code generation, and that copy is deleted after code generation. This
371072bc8208Sdrh ** ensures that the original pExpr is unchanged.
371172bc8208Sdrh */
371272bc8208Sdrh void sqlite3ExprIfFalseDup(Parse *pParse, Expr *pExpr, int dest,int jumpIfNull){
371372bc8208Sdrh   sqlite3 *db = pParse->db;
371472bc8208Sdrh   Expr *pCopy = sqlite3ExprDup(db, pExpr, 0);
371572bc8208Sdrh   if( db->mallocFailed==0 ){
371672bc8208Sdrh     sqlite3ExprIfFalse(pParse, pCopy, dest, jumpIfNull);
371772bc8208Sdrh   }
371872bc8208Sdrh   sqlite3ExprDelete(db, pCopy);
371972bc8208Sdrh }
372072bc8208Sdrh 
372172bc8208Sdrh 
372272bc8208Sdrh /*
37231d9da70aSdrh ** Do a deep comparison of two expression trees.  Return 0 if the two
37241d9da70aSdrh ** expressions are completely identical.  Return 1 if they differ only
37251d9da70aSdrh ** by a COLLATE operator at the top level.  Return 2 if there are differences
37261d9da70aSdrh ** other than the top-level COLLATE operator.
3727d40aab0eSdrh **
3728619a1305Sdrh ** If any subelement of pB has Expr.iTable==(-1) then it is allowed
3729619a1305Sdrh ** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
3730619a1305Sdrh **
373166518ca7Sdrh ** The pA side might be using TK_REGISTER.  If that is the case and pB is
373266518ca7Sdrh ** not using TK_REGISTER but is otherwise equivalent, then still return 0.
373366518ca7Sdrh **
37341d9da70aSdrh ** Sometimes this routine will return 2 even if the two expressions
3735d40aab0eSdrh ** really are equivalent.  If we cannot prove that the expressions are
37361d9da70aSdrh ** identical, we return 2 just to be safe.  So if this routine
37371d9da70aSdrh ** returns 2, then you do not really know for certain if the two
37381d9da70aSdrh ** expressions are the same.  But if you get a 0 or 1 return, then you
3739d40aab0eSdrh ** can be sure the expressions are the same.  In the places where
37401d9da70aSdrh ** this routine is used, it does not hurt to get an extra 2 - that
3741d40aab0eSdrh ** just might result in some slightly slower code.  But returning
37421d9da70aSdrh ** an incorrect 0 or 1 could lead to a malfunction.
37432282792aSdrh */
3744619a1305Sdrh int sqlite3ExprCompare(Expr *pA, Expr *pB, int iTab){
374510d1edf0Sdrh   u32 combinedFlags;
37464b202ae2Sdanielk1977   if( pA==0 || pB==0 ){
37471d9da70aSdrh     return pB==pA ? 0 : 2;
37482282792aSdrh   }
374910d1edf0Sdrh   combinedFlags = pA->flags | pB->flags;
375010d1edf0Sdrh   if( combinedFlags & EP_IntValue ){
375110d1edf0Sdrh     if( (pA->flags&pB->flags&EP_IntValue)!=0 && pA->u.iValue==pB->u.iValue ){
375210d1edf0Sdrh       return 0;
375310d1edf0Sdrh     }
37541d9da70aSdrh     return 2;
37556ab3a2ecSdanielk1977   }
3756c2acc4e4Sdrh   if( pA->op!=pB->op ){
3757619a1305Sdrh     if( pA->op==TK_COLLATE && sqlite3ExprCompare(pA->pLeft, pB, iTab)<2 ){
3758ae80ddeaSdrh       return 1;
3759ae80ddeaSdrh     }
3760619a1305Sdrh     if( pB->op==TK_COLLATE && sqlite3ExprCompare(pA, pB->pLeft, iTab)<2 ){
3761ae80ddeaSdrh       return 1;
3762ae80ddeaSdrh     }
3763ae80ddeaSdrh     return 2;
3764ae80ddeaSdrh   }
376510d1edf0Sdrh   if( pA->op!=TK_COLUMN && ALWAYS(pA->op!=TK_AGG_COLUMN) && pA->u.zToken ){
376610d1edf0Sdrh     if( strcmp(pA->u.zToken,pB->u.zToken)!=0 ){
376710d1edf0Sdrh       return pA->op==TK_COLLATE ? 1 : 2;
376810d1edf0Sdrh     }
376910d1edf0Sdrh   }
377010d1edf0Sdrh   if( (pA->flags & EP_Distinct)!=(pB->flags & EP_Distinct) ) return 2;
377185f8aa79Sdrh   if( ALWAYS((combinedFlags & EP_TokenOnly)==0) ){
377210d1edf0Sdrh     if( combinedFlags & EP_xIsSelect ) return 2;
3773619a1305Sdrh     if( sqlite3ExprCompare(pA->pLeft, pB->pLeft, iTab) ) return 2;
3774619a1305Sdrh     if( sqlite3ExprCompare(pA->pRight, pB->pRight, iTab) ) return 2;
3775619a1305Sdrh     if( sqlite3ExprListCompare(pA->x.pList, pB->x.pList, iTab) ) return 2;
37767693c42fSdrh     if( ALWAYS((combinedFlags & EP_Reduced)==0) && pA->op!=TK_STRING ){
3777619a1305Sdrh       if( pA->iColumn!=pB->iColumn ) return 2;
377866518ca7Sdrh       if( pA->iTable!=pB->iTable
377985f8aa79Sdrh        && (pA->iTable!=iTab || NEVER(pB->iTable>=0)) ) return 2;
37801d9da70aSdrh     }
37811d9da70aSdrh   }
37822646da7eSdrh   return 0;
37832646da7eSdrh }
37842282792aSdrh 
37858c6f666bSdrh /*
37868c6f666bSdrh ** Compare two ExprList objects.  Return 0 if they are identical and
37878c6f666bSdrh ** non-zero if they differ in any way.
37888c6f666bSdrh **
3789619a1305Sdrh ** If any subelement of pB has Expr.iTable==(-1) then it is allowed
3790619a1305Sdrh ** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
3791619a1305Sdrh **
37928c6f666bSdrh ** This routine might return non-zero for equivalent ExprLists.  The
37938c6f666bSdrh ** only consequence will be disabled optimizations.  But this routine
37948c6f666bSdrh ** must never return 0 if the two ExprList objects are different, or
37958c6f666bSdrh ** a malfunction will result.
37968c6f666bSdrh **
37978c6f666bSdrh ** Two NULL pointers are considered to be the same.  But a NULL pointer
37988c6f666bSdrh ** always differs from a non-NULL pointer.
37998c6f666bSdrh */
3800619a1305Sdrh int sqlite3ExprListCompare(ExprList *pA, ExprList *pB, int iTab){
38018c6f666bSdrh   int i;
38028c6f666bSdrh   if( pA==0 && pB==0 ) return 0;
38038c6f666bSdrh   if( pA==0 || pB==0 ) return 1;
38048c6f666bSdrh   if( pA->nExpr!=pB->nExpr ) return 1;
38058c6f666bSdrh   for(i=0; i<pA->nExpr; i++){
38068c6f666bSdrh     Expr *pExprA = pA->a[i].pExpr;
38078c6f666bSdrh     Expr *pExprB = pB->a[i].pExpr;
38088c6f666bSdrh     if( pA->a[i].sortOrder!=pB->a[i].sortOrder ) return 1;
3809619a1305Sdrh     if( sqlite3ExprCompare(pExprA, pExprB, iTab) ) return 1;
38108c6f666bSdrh   }
38118c6f666bSdrh   return 0;
38128c6f666bSdrh }
381313449892Sdrh 
38142282792aSdrh /*
38154bd5f73fSdrh ** Return true if we can prove the pE2 will always be true if pE1 is
38164bd5f73fSdrh ** true.  Return false if we cannot complete the proof or if pE2 might
38174bd5f73fSdrh ** be false.  Examples:
38184bd5f73fSdrh **
3819619a1305Sdrh **     pE1: x==5       pE2: x==5             Result: true
38204bd5f73fSdrh **     pE1: x>0        pE2: x==5             Result: false
3821619a1305Sdrh **     pE1: x=21       pE2: x=21 OR y=43     Result: true
38224bd5f73fSdrh **     pE1: x!=123     pE2: x IS NOT NULL    Result: true
3823619a1305Sdrh **     pE1: x!=?1      pE2: x IS NOT NULL    Result: true
3824619a1305Sdrh **     pE1: x IS NULL  pE2: x IS NOT NULL    Result: false
3825619a1305Sdrh **     pE1: x IS ?2    pE2: x IS NOT NULL    Reuslt: false
38264bd5f73fSdrh **
38274bd5f73fSdrh ** When comparing TK_COLUMN nodes between pE1 and pE2, if pE2 has
38284bd5f73fSdrh ** Expr.iTable<0 then assume a table number given by iTab.
38294bd5f73fSdrh **
38304bd5f73fSdrh ** When in doubt, return false.  Returning true might give a performance
38314bd5f73fSdrh ** improvement.  Returning false might cause a performance reduction, but
38324bd5f73fSdrh ** it will always give the correct answer and is hence always safe.
38334bd5f73fSdrh */
38344bd5f73fSdrh int sqlite3ExprImpliesExpr(Expr *pE1, Expr *pE2, int iTab){
3835619a1305Sdrh   if( sqlite3ExprCompare(pE1, pE2, iTab)==0 ){
3836619a1305Sdrh     return 1;
3837619a1305Sdrh   }
3838619a1305Sdrh   if( pE2->op==TK_OR
3839619a1305Sdrh    && (sqlite3ExprImpliesExpr(pE1, pE2->pLeft, iTab)
3840619a1305Sdrh              || sqlite3ExprImpliesExpr(pE1, pE2->pRight, iTab) )
3841619a1305Sdrh   ){
3842619a1305Sdrh     return 1;
3843619a1305Sdrh   }
3844619a1305Sdrh   if( pE2->op==TK_NOTNULL
3845619a1305Sdrh    && sqlite3ExprCompare(pE1->pLeft, pE2->pLeft, iTab)==0
3846619a1305Sdrh    && (pE1->op!=TK_ISNULL && pE1->op!=TK_IS)
3847619a1305Sdrh   ){
3848619a1305Sdrh     return 1;
3849619a1305Sdrh   }
3850619a1305Sdrh   return 0;
38514bd5f73fSdrh }
38524bd5f73fSdrh 
38534bd5f73fSdrh /*
3854030796dfSdrh ** An instance of the following structure is used by the tree walker
3855030796dfSdrh ** to count references to table columns in the arguments of an
3856ed551b95Sdrh ** aggregate function, in order to implement the
3857ed551b95Sdrh ** sqlite3FunctionThisSrc() routine.
3858374fdce4Sdrh */
3859030796dfSdrh struct SrcCount {
3860030796dfSdrh   SrcList *pSrc;   /* One particular FROM clause in a nested query */
3861030796dfSdrh   int nThis;       /* Number of references to columns in pSrcList */
3862030796dfSdrh   int nOther;      /* Number of references to columns in other FROM clauses */
3863030796dfSdrh };
3864030796dfSdrh 
3865030796dfSdrh /*
3866030796dfSdrh ** Count the number of references to columns.
3867030796dfSdrh */
3868030796dfSdrh static int exprSrcCount(Walker *pWalker, Expr *pExpr){
3869fb0a6081Sdrh   /* The NEVER() on the second term is because sqlite3FunctionUsesThisSrc()
3870fb0a6081Sdrh   ** is always called before sqlite3ExprAnalyzeAggregates() and so the
3871fb0a6081Sdrh   ** TK_COLUMNs have not yet been converted into TK_AGG_COLUMN.  If
3872fb0a6081Sdrh   ** sqlite3FunctionUsesThisSrc() is used differently in the future, the
3873fb0a6081Sdrh   ** NEVER() will need to be removed. */
3874fb0a6081Sdrh   if( pExpr->op==TK_COLUMN || NEVER(pExpr->op==TK_AGG_COLUMN) ){
3875374fdce4Sdrh     int i;
3876030796dfSdrh     struct SrcCount *p = pWalker->u.pSrcCount;
3877030796dfSdrh     SrcList *pSrc = p->pSrc;
3878655814d2Sdrh     int nSrc = pSrc ? pSrc->nSrc : 0;
3879655814d2Sdrh     for(i=0; i<nSrc; i++){
3880030796dfSdrh       if( pExpr->iTable==pSrc->a[i].iCursor ) break;
3881374fdce4Sdrh     }
3882655814d2Sdrh     if( i<nSrc ){
3883030796dfSdrh       p->nThis++;
3884374fdce4Sdrh     }else{
3885030796dfSdrh       p->nOther++;
3886374fdce4Sdrh     }
3887374fdce4Sdrh   }
3888030796dfSdrh   return WRC_Continue;
3889030796dfSdrh }
3890374fdce4Sdrh 
3891374fdce4Sdrh /*
3892030796dfSdrh ** Determine if any of the arguments to the pExpr Function reference
3893030796dfSdrh ** pSrcList.  Return true if they do.  Also return true if the function
3894030796dfSdrh ** has no arguments or has only constant arguments.  Return false if pExpr
3895030796dfSdrh ** references columns but not columns of tables found in pSrcList.
3896374fdce4Sdrh */
3897030796dfSdrh int sqlite3FunctionUsesThisSrc(Expr *pExpr, SrcList *pSrcList){
3898374fdce4Sdrh   Walker w;
3899030796dfSdrh   struct SrcCount cnt;
3900374fdce4Sdrh   assert( pExpr->op==TK_AGG_FUNCTION );
3901374fdce4Sdrh   memset(&w, 0, sizeof(w));
3902030796dfSdrh   w.xExprCallback = exprSrcCount;
3903030796dfSdrh   w.u.pSrcCount = &cnt;
3904030796dfSdrh   cnt.pSrc = pSrcList;
3905030796dfSdrh   cnt.nThis = 0;
3906030796dfSdrh   cnt.nOther = 0;
3907030796dfSdrh   sqlite3WalkExprList(&w, pExpr->x.pList);
3908030796dfSdrh   return cnt.nThis>0 || cnt.nOther==0;
3909374fdce4Sdrh }
3910374fdce4Sdrh 
3911374fdce4Sdrh /*
391213449892Sdrh ** Add a new element to the pAggInfo->aCol[] array.  Return the index of
391313449892Sdrh ** the new element.  Return a negative number if malloc fails.
39142282792aSdrh */
391517435752Sdrh static int addAggInfoColumn(sqlite3 *db, AggInfo *pInfo){
391613449892Sdrh   int i;
3917cf643729Sdrh   pInfo->aCol = sqlite3ArrayAllocate(
391817435752Sdrh        db,
3919cf643729Sdrh        pInfo->aCol,
3920cf643729Sdrh        sizeof(pInfo->aCol[0]),
3921cf643729Sdrh        &pInfo->nColumn,
3922cf643729Sdrh        &i
3923cf643729Sdrh   );
392413449892Sdrh   return i;
39252282792aSdrh }
392613449892Sdrh 
392713449892Sdrh /*
392813449892Sdrh ** Add a new element to the pAggInfo->aFunc[] array.  Return the index of
392913449892Sdrh ** the new element.  Return a negative number if malloc fails.
393013449892Sdrh */
393117435752Sdrh static int addAggInfoFunc(sqlite3 *db, AggInfo *pInfo){
393213449892Sdrh   int i;
3933cf643729Sdrh   pInfo->aFunc = sqlite3ArrayAllocate(
393417435752Sdrh        db,
3935cf643729Sdrh        pInfo->aFunc,
3936cf643729Sdrh        sizeof(pInfo->aFunc[0]),
3937cf643729Sdrh        &pInfo->nFunc,
3938cf643729Sdrh        &i
3939cf643729Sdrh   );
394013449892Sdrh   return i;
39412282792aSdrh }
39422282792aSdrh 
39432282792aSdrh /*
39447d10d5a6Sdrh ** This is the xExprCallback for a tree walker.  It is used to
39457d10d5a6Sdrh ** implement sqlite3ExprAnalyzeAggregates().  See sqlite3ExprAnalyzeAggregates
3946626a879aSdrh ** for additional information.
39472282792aSdrh */
39487d10d5a6Sdrh static int analyzeAggregate(Walker *pWalker, Expr *pExpr){
39492282792aSdrh   int i;
39507d10d5a6Sdrh   NameContext *pNC = pWalker->u.pNC;
3951a58fdfb1Sdanielk1977   Parse *pParse = pNC->pParse;
3952a58fdfb1Sdanielk1977   SrcList *pSrcList = pNC->pSrcList;
395313449892Sdrh   AggInfo *pAggInfo = pNC->pAggInfo;
395413449892Sdrh 
39552282792aSdrh   switch( pExpr->op ){
395689c69d00Sdrh     case TK_AGG_COLUMN:
3957967e8b73Sdrh     case TK_COLUMN: {
39588b213899Sdrh       testcase( pExpr->op==TK_AGG_COLUMN );
39598b213899Sdrh       testcase( pExpr->op==TK_COLUMN );
396013449892Sdrh       /* Check to see if the column is in one of the tables in the FROM
396113449892Sdrh       ** clause of the aggregate query */
396220bc393cSdrh       if( ALWAYS(pSrcList!=0) ){
396313449892Sdrh         struct SrcList_item *pItem = pSrcList->a;
396413449892Sdrh         for(i=0; i<pSrcList->nSrc; i++, pItem++){
396513449892Sdrh           struct AggInfo_col *pCol;
3966c5cd1249Sdrh           assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
396713449892Sdrh           if( pExpr->iTable==pItem->iCursor ){
396813449892Sdrh             /* If we reach this point, it means that pExpr refers to a table
396913449892Sdrh             ** that is in the FROM clause of the aggregate query.
397013449892Sdrh             **
397113449892Sdrh             ** Make an entry for the column in pAggInfo->aCol[] if there
397213449892Sdrh             ** is not an entry there already.
397313449892Sdrh             */
39747f906d63Sdrh             int k;
397513449892Sdrh             pCol = pAggInfo->aCol;
39767f906d63Sdrh             for(k=0; k<pAggInfo->nColumn; k++, pCol++){
397713449892Sdrh               if( pCol->iTable==pExpr->iTable &&
397813449892Sdrh                   pCol->iColumn==pExpr->iColumn ){
39792282792aSdrh                 break;
39802282792aSdrh               }
39812282792aSdrh             }
39821e536953Sdanielk1977             if( (k>=pAggInfo->nColumn)
39831e536953Sdanielk1977              && (k = addAggInfoColumn(pParse->db, pAggInfo))>=0
39841e536953Sdanielk1977             ){
39857f906d63Sdrh               pCol = &pAggInfo->aCol[k];
39860817d0dfSdanielk1977               pCol->pTab = pExpr->pTab;
398713449892Sdrh               pCol->iTable = pExpr->iTable;
398813449892Sdrh               pCol->iColumn = pExpr->iColumn;
39890a07c107Sdrh               pCol->iMem = ++pParse->nMem;
399013449892Sdrh               pCol->iSorterColumn = -1;
39915774b806Sdrh               pCol->pExpr = pExpr;
399213449892Sdrh               if( pAggInfo->pGroupBy ){
399313449892Sdrh                 int j, n;
399413449892Sdrh                 ExprList *pGB = pAggInfo->pGroupBy;
399513449892Sdrh                 struct ExprList_item *pTerm = pGB->a;
399613449892Sdrh                 n = pGB->nExpr;
399713449892Sdrh                 for(j=0; j<n; j++, pTerm++){
399813449892Sdrh                   Expr *pE = pTerm->pExpr;
399913449892Sdrh                   if( pE->op==TK_COLUMN && pE->iTable==pExpr->iTable &&
400013449892Sdrh                       pE->iColumn==pExpr->iColumn ){
400113449892Sdrh                     pCol->iSorterColumn = j;
400213449892Sdrh                     break;
40032282792aSdrh                   }
400413449892Sdrh                 }
400513449892Sdrh               }
400613449892Sdrh               if( pCol->iSorterColumn<0 ){
400713449892Sdrh                 pCol->iSorterColumn = pAggInfo->nSortingColumn++;
400813449892Sdrh               }
400913449892Sdrh             }
401013449892Sdrh             /* There is now an entry for pExpr in pAggInfo->aCol[] (either
401113449892Sdrh             ** because it was there before or because we just created it).
401213449892Sdrh             ** Convert the pExpr to be a TK_AGG_COLUMN referring to that
401313449892Sdrh             ** pAggInfo->aCol[] entry.
401413449892Sdrh             */
4015ebb6a65dSdrh             ExprSetVVAProperty(pExpr, EP_NoReduce);
401613449892Sdrh             pExpr->pAggInfo = pAggInfo;
401713449892Sdrh             pExpr->op = TK_AGG_COLUMN;
4018cf697396Sshane             pExpr->iAgg = (i16)k;
401913449892Sdrh             break;
402013449892Sdrh           } /* endif pExpr->iTable==pItem->iCursor */
402113449892Sdrh         } /* end loop over pSrcList */
4022a58fdfb1Sdanielk1977       }
40237d10d5a6Sdrh       return WRC_Prune;
40242282792aSdrh     }
40252282792aSdrh     case TK_AGG_FUNCTION: {
40263a8c4be7Sdrh       if( (pNC->ncFlags & NC_InAggFunc)==0
4027ed551b95Sdrh        && pWalker->walkerDepth==pExpr->op2
40283a8c4be7Sdrh       ){
402913449892Sdrh         /* Check to see if pExpr is a duplicate of another aggregate
403013449892Sdrh         ** function that is already in the pAggInfo structure
403113449892Sdrh         */
403213449892Sdrh         struct AggInfo_func *pItem = pAggInfo->aFunc;
403313449892Sdrh         for(i=0; i<pAggInfo->nFunc; i++, pItem++){
4034619a1305Sdrh           if( sqlite3ExprCompare(pItem->pExpr, pExpr, -1)==0 ){
40352282792aSdrh             break;
40362282792aSdrh           }
40372282792aSdrh         }
403813449892Sdrh         if( i>=pAggInfo->nFunc ){
403913449892Sdrh           /* pExpr is original.  Make a new entry in pAggInfo->aFunc[]
404013449892Sdrh           */
404114db2665Sdanielk1977           u8 enc = ENC(pParse->db);
40421e536953Sdanielk1977           i = addAggInfoFunc(pParse->db, pAggInfo);
404313449892Sdrh           if( i>=0 ){
40446ab3a2ecSdanielk1977             assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
404513449892Sdrh             pItem = &pAggInfo->aFunc[i];
404613449892Sdrh             pItem->pExpr = pExpr;
40470a07c107Sdrh             pItem->iMem = ++pParse->nMem;
404833e619fcSdrh             assert( !ExprHasProperty(pExpr, EP_IntValue) );
404913449892Sdrh             pItem->pFunc = sqlite3FindFunction(pParse->db,
405033e619fcSdrh                    pExpr->u.zToken, sqlite3Strlen30(pExpr->u.zToken),
40516ab3a2ecSdanielk1977                    pExpr->x.pList ? pExpr->x.pList->nExpr : 0, enc, 0);
4052fd357974Sdrh             if( pExpr->flags & EP_Distinct ){
4053fd357974Sdrh               pItem->iDistinct = pParse->nTab++;
4054fd357974Sdrh             }else{
4055fd357974Sdrh               pItem->iDistinct = -1;
4056fd357974Sdrh             }
40572282792aSdrh           }
405813449892Sdrh         }
405913449892Sdrh         /* Make pExpr point to the appropriate pAggInfo->aFunc[] entry
406013449892Sdrh         */
4061c5cd1249Sdrh         assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
4062ebb6a65dSdrh         ExprSetVVAProperty(pExpr, EP_NoReduce);
4063cf697396Sshane         pExpr->iAgg = (i16)i;
406413449892Sdrh         pExpr->pAggInfo = pAggInfo;
40653a8c4be7Sdrh         return WRC_Prune;
40666e83a57fSdrh       }else{
40676e83a57fSdrh         return WRC_Continue;
40686e83a57fSdrh       }
40692282792aSdrh     }
4070a58fdfb1Sdanielk1977   }
40717d10d5a6Sdrh   return WRC_Continue;
40727d10d5a6Sdrh }
40737d10d5a6Sdrh static int analyzeAggregatesInSelect(Walker *pWalker, Select *pSelect){
4074d5a336efSdrh   UNUSED_PARAMETER(pWalker);
4075d5a336efSdrh   UNUSED_PARAMETER(pSelect);
40767d10d5a6Sdrh   return WRC_Continue;
4077a58fdfb1Sdanielk1977 }
4078626a879aSdrh 
4079626a879aSdrh /*
4080e8abb4caSdrh ** Analyze the pExpr expression looking for aggregate functions and
4081e8abb4caSdrh ** for variables that need to be added to AggInfo object that pNC->pAggInfo
4082e8abb4caSdrh ** points to.  Additional entries are made on the AggInfo object as
4083e8abb4caSdrh ** necessary.
4084626a879aSdrh **
4085626a879aSdrh ** This routine should only be called after the expression has been
40867d10d5a6Sdrh ** analyzed by sqlite3ResolveExprNames().
4087626a879aSdrh */
4088d2b3e23bSdrh void sqlite3ExprAnalyzeAggregates(NameContext *pNC, Expr *pExpr){
40897d10d5a6Sdrh   Walker w;
4090374fdce4Sdrh   memset(&w, 0, sizeof(w));
40917d10d5a6Sdrh   w.xExprCallback = analyzeAggregate;
40927d10d5a6Sdrh   w.xSelectCallback = analyzeAggregatesInSelect;
40937d10d5a6Sdrh   w.u.pNC = pNC;
409420bc393cSdrh   assert( pNC->pSrcList!=0 );
40957d10d5a6Sdrh   sqlite3WalkExpr(&w, pExpr);
40962282792aSdrh }
40975d9a4af9Sdrh 
40985d9a4af9Sdrh /*
40995d9a4af9Sdrh ** Call sqlite3ExprAnalyzeAggregates() for every expression in an
41005d9a4af9Sdrh ** expression list.  Return the number of errors.
41015d9a4af9Sdrh **
41025d9a4af9Sdrh ** If an error is found, the analysis is cut short.
41035d9a4af9Sdrh */
4104d2b3e23bSdrh void sqlite3ExprAnalyzeAggList(NameContext *pNC, ExprList *pList){
41055d9a4af9Sdrh   struct ExprList_item *pItem;
41065d9a4af9Sdrh   int i;
41075d9a4af9Sdrh   if( pList ){
4108d2b3e23bSdrh     for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
4109d2b3e23bSdrh       sqlite3ExprAnalyzeAggregates(pNC, pItem->pExpr);
41105d9a4af9Sdrh     }
41115d9a4af9Sdrh   }
41125d9a4af9Sdrh }
4113892d3179Sdrh 
4114892d3179Sdrh /*
4115ceea3321Sdrh ** Allocate a single new register for use to hold some intermediate result.
4116892d3179Sdrh */
4117892d3179Sdrh int sqlite3GetTempReg(Parse *pParse){
4118e55cbd72Sdrh   if( pParse->nTempReg==0 ){
4119892d3179Sdrh     return ++pParse->nMem;
4120892d3179Sdrh   }
41212f425f6bSdanielk1977   return pParse->aTempReg[--pParse->nTempReg];
4122892d3179Sdrh }
4123ceea3321Sdrh 
4124ceea3321Sdrh /*
4125ceea3321Sdrh ** Deallocate a register, making available for reuse for some other
4126ceea3321Sdrh ** purpose.
4127ceea3321Sdrh **
4128ceea3321Sdrh ** If a register is currently being used by the column cache, then
412960ec914cSpeter.d.reid ** the deallocation is deferred until the column cache line that uses
4130ceea3321Sdrh ** the register becomes stale.
4131ceea3321Sdrh */
4132892d3179Sdrh void sqlite3ReleaseTempReg(Parse *pParse, int iReg){
41332dcef11bSdrh   if( iReg && pParse->nTempReg<ArraySize(pParse->aTempReg) ){
4134ceea3321Sdrh     int i;
4135ceea3321Sdrh     struct yColCache *p;
4136ceea3321Sdrh     for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
4137ceea3321Sdrh       if( p->iReg==iReg ){
4138ceea3321Sdrh         p->tempReg = 1;
4139ceea3321Sdrh         return;
4140ceea3321Sdrh       }
4141ceea3321Sdrh     }
4142892d3179Sdrh     pParse->aTempReg[pParse->nTempReg++] = iReg;
4143892d3179Sdrh   }
4144892d3179Sdrh }
4145892d3179Sdrh 
4146892d3179Sdrh /*
4147892d3179Sdrh ** Allocate or deallocate a block of nReg consecutive registers
4148892d3179Sdrh */
4149892d3179Sdrh int sqlite3GetTempRange(Parse *pParse, int nReg){
4150e55cbd72Sdrh   int i, n;
4151892d3179Sdrh   i = pParse->iRangeReg;
4152e55cbd72Sdrh   n = pParse->nRangeReg;
4153f49f3523Sdrh   if( nReg<=n ){
4154f49f3523Sdrh     assert( !usedAsColumnCache(pParse, i, i+n-1) );
4155892d3179Sdrh     pParse->iRangeReg += nReg;
4156892d3179Sdrh     pParse->nRangeReg -= nReg;
4157892d3179Sdrh   }else{
4158892d3179Sdrh     i = pParse->nMem+1;
4159892d3179Sdrh     pParse->nMem += nReg;
4160892d3179Sdrh   }
4161892d3179Sdrh   return i;
4162892d3179Sdrh }
4163892d3179Sdrh void sqlite3ReleaseTempRange(Parse *pParse, int iReg, int nReg){
4164f49f3523Sdrh   sqlite3ExprCacheRemove(pParse, iReg, nReg);
4165892d3179Sdrh   if( nReg>pParse->nRangeReg ){
4166892d3179Sdrh     pParse->nRangeReg = nReg;
4167892d3179Sdrh     pParse->iRangeReg = iReg;
4168892d3179Sdrh   }
4169892d3179Sdrh }
4170cdc69557Sdrh 
4171cdc69557Sdrh /*
4172cdc69557Sdrh ** Mark all temporary registers as being unavailable for reuse.
4173cdc69557Sdrh */
4174cdc69557Sdrh void sqlite3ClearTempRegCache(Parse *pParse){
4175cdc69557Sdrh   pParse->nTempReg = 0;
4176cdc69557Sdrh   pParse->nRangeReg = 0;
4177cdc69557Sdrh }
4178