xref: /sqlite-3.40.0/src/expr.c (revision a4eeccdf)
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 
1712abf408Sdrh /* Forward declarations */
1812abf408Sdrh static void exprCodeBetween(Parse*,Expr*,int,void(*)(Parse*,Expr*,int,int),int);
1912abf408Sdrh static int exprCodeVector(Parse *pParse, Expr *p, int *piToFree);
2012abf408Sdrh 
210dfa4f6fSdrh /*
220dfa4f6fSdrh ** Return the affinity character for a single column of a table.
230dfa4f6fSdrh */
24b6dad520Sdrh char sqlite3TableColumnAffinity(const Table *pTab, int iCol){
250dfa4f6fSdrh   assert( iCol<pTab->nCol );
260dfa4f6fSdrh   return iCol>=0 ? pTab->aCol[iCol].affinity : SQLITE_AFF_INTEGER;
270dfa4f6fSdrh }
2812abf408Sdrh 
29e014a838Sdanielk1977 /*
30e014a838Sdanielk1977 ** Return the 'affinity' of the expression pExpr if any.
31e014a838Sdanielk1977 **
32e014a838Sdanielk1977 ** If pExpr is a column, a reference to a column via an 'AS' alias,
33e014a838Sdanielk1977 ** or a sub-select with a column as the return value, then the
34e014a838Sdanielk1977 ** affinity of that column is returned. Otherwise, 0x00 is returned,
35e014a838Sdanielk1977 ** indicating no affinity for the expression.
36e014a838Sdanielk1977 **
3760ec914cSpeter.d.reid ** i.e. the WHERE clause expressions in the following statements all
38e014a838Sdanielk1977 ** have an affinity:
39e014a838Sdanielk1977 **
40e014a838Sdanielk1977 ** CREATE TABLE t1(a);
41e014a838Sdanielk1977 ** SELECT * FROM t1 WHERE a;
42e014a838Sdanielk1977 ** SELECT a AS b FROM t1 WHERE b;
43e014a838Sdanielk1977 ** SELECT * FROM t1 WHERE (select a from t1);
44e014a838Sdanielk1977 */
45e7375bfaSdrh char sqlite3ExprAffinity(const Expr *pExpr){
46580c8c18Sdrh   int op;
4746fe138dSdrh   while( ExprHasProperty(pExpr, EP_Skip|EP_IfNullRow) ){
489bb612f2Sdrh     assert( pExpr->op==TK_COLLATE
499bb612f2Sdrh          || pExpr->op==TK_IF_NULL_ROW
509bb612f2Sdrh          || (pExpr->op==TK_REGISTER && pExpr->op2==TK_IF_NULL_ROW) );
51a7d6db6aSdrh     pExpr = pExpr->pLeft;
52a7d6db6aSdrh     assert( pExpr!=0 );
53a7d6db6aSdrh   }
54580c8c18Sdrh   op = pExpr->op;
55de0e1b15Sdrh   if( op==TK_REGISTER ) op = pExpr->op2;
56de0e1b15Sdrh   if( (op==TK_COLUMN || op==TK_AGG_COLUMN) && pExpr->y.pTab ){
57de0e1b15Sdrh     return sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
58de0e1b15Sdrh   }
59487e262fSdrh   if( op==TK_SELECT ){
60*a4eeccdfSdrh     assert( ExprUseXSelect(pExpr) );
616af305deSdrh     assert( pExpr->x.pSelect!=0 );
626af305deSdrh     assert( pExpr->x.pSelect->pEList!=0 );
636af305deSdrh     assert( pExpr->x.pSelect->pEList->a[0].pExpr!=0 );
646ab3a2ecSdanielk1977     return sqlite3ExprAffinity(pExpr->x.pSelect->pEList->a[0].pExpr);
65a37cdde0Sdanielk1977   }
66487e262fSdrh #ifndef SQLITE_OMIT_CAST
67487e262fSdrh   if( op==TK_CAST ){
6833e619fcSdrh     assert( !ExprHasProperty(pExpr, EP_IntValue) );
69fdaac671Sdrh     return sqlite3AffinityType(pExpr->u.zToken, 0);
70487e262fSdrh   }
71487e262fSdrh #endif
7280aa5453Sdan   if( op==TK_SELECT_COLUMN ){
73*a4eeccdfSdrh     assert( pExpr->pLeft!=0 && ExprUseXSelect(pExpr->pLeft) );
7410f08270Sdrh     assert( pExpr->iColumn < pExpr->iTable );
7510f08270Sdrh     assert( pExpr->iTable==pExpr->pLeft->x.pSelect->pEList->nExpr );
7680aa5453Sdan     return sqlite3ExprAffinity(
7780aa5453Sdan         pExpr->pLeft->x.pSelect->pEList->a[pExpr->iColumn].pExpr
7880aa5453Sdan     );
7980aa5453Sdan   }
80db36e255Sdrh   if( op==TK_VECTOR ){
81*a4eeccdfSdrh     assert( ExprUseXList(pExpr) );
82db36e255Sdrh     return sqlite3ExprAffinity(pExpr->x.pList->a[0].pExpr);
83db36e255Sdrh   }
841194904bSdrh   return pExpr->affExpr;
85a37cdde0Sdanielk1977 }
86a37cdde0Sdanielk1977 
8753db1458Sdrh /*
888b4c40d8Sdrh ** Set the collating sequence for expression pExpr to be the collating
89ae80ddeaSdrh ** sequence named by pToken.   Return a pointer to a new Expr node that
90ae80ddeaSdrh ** implements the COLLATE operator.
910a8a406eSdrh **
920a8a406eSdrh ** If a memory allocation error occurs, that fact is recorded in pParse->db
930a8a406eSdrh ** and the pExpr parameter is returned unchanged.
948b4c40d8Sdrh */
954ef7efadSdrh Expr *sqlite3ExprAddCollateToken(
96b6dad520Sdrh   const Parse *pParse,     /* Parsing context */
974ef7efadSdrh   Expr *pExpr,             /* Add the "COLLATE" clause to this expression */
9880103fc6Sdan   const Token *pCollName,  /* Name of collating sequence */
9980103fc6Sdan   int dequote              /* True to dequote pCollName */
1004ef7efadSdrh ){
101433a3e93Sdrh   if( pCollName->n>0 ){
10280103fc6Sdan     Expr *pNew = sqlite3ExprAlloc(pParse->db, TK_COLLATE, pCollName, dequote);
103ae80ddeaSdrh     if( pNew ){
104ae80ddeaSdrh       pNew->pLeft = pExpr;
105a4c3c87eSdrh       pNew->flags |= EP_Collate|EP_Skip;
1060a8a406eSdrh       pExpr = pNew;
107ae80ddeaSdrh     }
1080a8a406eSdrh   }
1090a8a406eSdrh   return pExpr;
1100a8a406eSdrh }
111b6dad520Sdrh Expr *sqlite3ExprAddCollateString(
112b6dad520Sdrh   const Parse *pParse,  /* Parsing context */
113b6dad520Sdrh   Expr *pExpr,          /* Add the "COLLATE" clause to this expression */
114b6dad520Sdrh   const char *zC        /* The collating sequence name */
115b6dad520Sdrh ){
1160a8a406eSdrh   Token s;
117261d8a51Sdrh   assert( zC!=0 );
11840aced5cSdrh   sqlite3TokenInit(&s, (char*)zC);
11980103fc6Sdan   return sqlite3ExprAddCollateToken(pParse, pExpr, &s, 0);
1200a8a406eSdrh }
1210a8a406eSdrh 
1220a8a406eSdrh /*
1230d950af3Sdrh ** Skip over any TK_COLLATE operators.
1240a8a406eSdrh */
1250a8a406eSdrh Expr *sqlite3ExprSkipCollate(Expr *pExpr){
1260d950af3Sdrh   while( pExpr && ExprHasProperty(pExpr, EP_Skip) ){
12746fe138dSdrh     assert( pExpr->op==TK_COLLATE );
1280d950af3Sdrh     pExpr = pExpr->pLeft;
1290d950af3Sdrh   }
1300d950af3Sdrh   return pExpr;
1310d950af3Sdrh }
1320d950af3Sdrh 
1330d950af3Sdrh /*
1340d950af3Sdrh ** Skip over any TK_COLLATE operators and/or any unlikely()
1350d950af3Sdrh ** or likelihood() or likely() functions at the root of an
1360d950af3Sdrh ** expression.
1370d950af3Sdrh */
1380d950af3Sdrh Expr *sqlite3ExprSkipCollateAndLikely(Expr *pExpr){
139a7d6db6aSdrh   while( pExpr && ExprHasProperty(pExpr, EP_Skip|EP_Unlikely) ){
140a4c3c87eSdrh     if( ExprHasProperty(pExpr, EP_Unlikely) ){
141*a4eeccdfSdrh       assert( ExprUseXList(pExpr) );
142cca9f3d2Sdrh       assert( pExpr->x.pList->nExpr>0 );
143a4c3c87eSdrh       assert( pExpr->op==TK_FUNCTION );
144cca9f3d2Sdrh       pExpr = pExpr->x.pList->a[0].pExpr;
145cca9f3d2Sdrh     }else{
14646fe138dSdrh       assert( pExpr->op==TK_COLLATE );
147d91eba96Sdrh       pExpr = pExpr->pLeft;
148cca9f3d2Sdrh     }
149d91eba96Sdrh   }
1500a8a406eSdrh   return pExpr;
1518b4c40d8Sdrh }
1528b4c40d8Sdrh 
1538b4c40d8Sdrh /*
154ae80ddeaSdrh ** Return the collation sequence for the expression pExpr. If
155ae80ddeaSdrh ** there is no defined collating sequence, return NULL.
156ae80ddeaSdrh **
15770efa84dSdrh ** See also: sqlite3ExprNNCollSeq()
15870efa84dSdrh **
15970efa84dSdrh ** The sqlite3ExprNNCollSeq() works the same exact that it returns the
16070efa84dSdrh ** default collation if pExpr has no defined collation.
16170efa84dSdrh **
162ae80ddeaSdrh ** The collating sequence might be determined by a COLLATE operator
163ae80ddeaSdrh ** or by the presence of a column with a defined collating sequence.
164ae80ddeaSdrh ** COLLATE operators take first precedence.  Left operands take
165ae80ddeaSdrh ** precedence over right operands.
1660202b29eSdanielk1977 */
167e7375bfaSdrh CollSeq *sqlite3ExprCollSeq(Parse *pParse, const Expr *pExpr){
168ae80ddeaSdrh   sqlite3 *db = pParse->db;
1697cedc8d4Sdanielk1977   CollSeq *pColl = 0;
170e7375bfaSdrh   const Expr *p = pExpr;
171261d8a51Sdrh   while( p ){
172ae80ddeaSdrh     int op = p->op;
173cb0e04f9Sdrh     if( op==TK_REGISTER ) op = p->op2;
174cb0e04f9Sdrh     if( (op==TK_AGG_COLUMN || op==TK_COLUMN || op==TK_TRIGGER)
175eda079cdSdrh      && p->y.pTab!=0
176ae80ddeaSdrh     ){
177eda079cdSdrh       /* op==TK_REGISTER && p->y.pTab!=0 happens when pExpr was originally
1787d10d5a6Sdrh       ** a TK_COLUMN but was previously evaluated and cached in a register */
1797d10d5a6Sdrh       int j = p->iColumn;
1807d10d5a6Sdrh       if( j>=0 ){
18165b40093Sdrh         const char *zColl = sqlite3ColumnColl(&p->y.pTab->aCol[j]);
182c4a64facSdrh         pColl = sqlite3FindCollSeq(db, ENC(db), zColl, 0);
1830202b29eSdanielk1977       }
1847d10d5a6Sdrh       break;
1857d10d5a6Sdrh     }
186e081d73cSdrh     if( op==TK_CAST || op==TK_UPLUS ){
187e081d73cSdrh       p = p->pLeft;
188e081d73cSdrh       continue;
189e081d73cSdrh     }
190269d322dSdrh     if( op==TK_VECTOR ){
191*a4eeccdfSdrh       assert( ExprUseXList(p) );
192269d322dSdrh       p = p->x.pList->a[0].pExpr;
193269d322dSdrh       continue;
194269d322dSdrh     }
195cb0e04f9Sdrh     if( op==TK_COLLATE ){
196f9751074Sdrh       assert( !ExprHasProperty(p, EP_IntValue) );
197e081d73cSdrh       pColl = sqlite3GetCollSeq(pParse, ENC(db), 0, p->u.zToken);
198e081d73cSdrh       break;
199e081d73cSdrh     }
200ae80ddeaSdrh     if( p->flags & EP_Collate ){
2012308ed38Sdrh       if( p->pLeft && (p->pLeft->flags & EP_Collate)!=0 ){
2027d10d5a6Sdrh         p = p->pLeft;
203ae80ddeaSdrh       }else{
2042308ed38Sdrh         Expr *pNext  = p->pRight;
2056728cd91Sdrh         /* The Expr.x union is never used at the same time as Expr.pRight */
206*a4eeccdfSdrh         assert( ExprUseXList(p) );
2076728cd91Sdrh         assert( p->x.pList==0 || p->pRight==0 );
208*a4eeccdfSdrh         if( p->x.pList!=0 && !db->mallocFailed ){
2092308ed38Sdrh           int i;
2105b107654Sdrh           for(i=0; ALWAYS(i<p->x.pList->nExpr); i++){
2112308ed38Sdrh             if( ExprHasProperty(p->x.pList->a[i].pExpr, EP_Collate) ){
2122308ed38Sdrh               pNext = p->x.pList->a[i].pExpr;
2132308ed38Sdrh               break;
2142308ed38Sdrh             }
2152308ed38Sdrh           }
2162308ed38Sdrh         }
2172308ed38Sdrh         p = pNext;
218ae80ddeaSdrh       }
219ae80ddeaSdrh     }else{
220ae80ddeaSdrh       break;
221ae80ddeaSdrh     }
2220202b29eSdanielk1977   }
2237cedc8d4Sdanielk1977   if( sqlite3CheckCollSeq(pParse, pColl) ){
2247cedc8d4Sdanielk1977     pColl = 0;
2257cedc8d4Sdanielk1977   }
2267cedc8d4Sdanielk1977   return pColl;
2270202b29eSdanielk1977 }
2280202b29eSdanielk1977 
2290202b29eSdanielk1977 /*
23070efa84dSdrh ** Return the collation sequence for the expression pExpr. If
23170efa84dSdrh ** there is no defined collating sequence, return a pointer to the
23270efa84dSdrh ** defautl collation sequence.
23370efa84dSdrh **
23470efa84dSdrh ** See also: sqlite3ExprCollSeq()
23570efa84dSdrh **
23670efa84dSdrh ** The sqlite3ExprCollSeq() routine works the same except that it
23770efa84dSdrh ** returns NULL if there is no defined collation.
23870efa84dSdrh */
239e7375bfaSdrh CollSeq *sqlite3ExprNNCollSeq(Parse *pParse, const Expr *pExpr){
24070efa84dSdrh   CollSeq *p = sqlite3ExprCollSeq(pParse, pExpr);
24170efa84dSdrh   if( p==0 ) p = pParse->db->pDfltColl;
24270efa84dSdrh   assert( p!=0 );
24370efa84dSdrh   return p;
24470efa84dSdrh }
24570efa84dSdrh 
24670efa84dSdrh /*
24770efa84dSdrh ** Return TRUE if the two expressions have equivalent collating sequences.
24870efa84dSdrh */
249e7375bfaSdrh int sqlite3ExprCollSeqMatch(Parse *pParse, const Expr *pE1, const Expr *pE2){
25070efa84dSdrh   CollSeq *pColl1 = sqlite3ExprNNCollSeq(pParse, pE1);
25170efa84dSdrh   CollSeq *pColl2 = sqlite3ExprNNCollSeq(pParse, pE2);
25270efa84dSdrh   return sqlite3StrICmp(pColl1->zName, pColl2->zName)==0;
25370efa84dSdrh }
25470efa84dSdrh 
25570efa84dSdrh /*
256626a879aSdrh ** pExpr is an operand of a comparison operator.  aff2 is the
257626a879aSdrh ** type affinity of the other operand.  This routine returns the
25853db1458Sdrh ** type affinity that should be used for the comparison operator.
25953db1458Sdrh */
260e7375bfaSdrh char sqlite3CompareAffinity(const Expr *pExpr, char aff2){
261bf3b721fSdanielk1977   char aff1 = sqlite3ExprAffinity(pExpr);
26296fb16eeSdrh   if( aff1>SQLITE_AFF_NONE && aff2>SQLITE_AFF_NONE ){
2638df447f0Sdrh     /* Both sides of the comparison are columns. If one has numeric
2648df447f0Sdrh     ** affinity, use that. Otherwise use no affinity.
265e014a838Sdanielk1977     */
2668a51256cSdrh     if( sqlite3IsNumericAffinity(aff1) || sqlite3IsNumericAffinity(aff2) ){
267e014a838Sdanielk1977       return SQLITE_AFF_NUMERIC;
268e014a838Sdanielk1977     }else{
26905883a34Sdrh       return SQLITE_AFF_BLOB;
270e014a838Sdanielk1977     }
271e014a838Sdanielk1977   }else{
272e014a838Sdanielk1977     /* One side is a column, the other is not. Use the columns affinity. */
27396fb16eeSdrh     assert( aff1<=SQLITE_AFF_NONE || aff2<=SQLITE_AFF_NONE );
27496fb16eeSdrh     return (aff1<=SQLITE_AFF_NONE ? aff2 : aff1) | SQLITE_AFF_NONE;
275e014a838Sdanielk1977   }
276e014a838Sdanielk1977 }
277e014a838Sdanielk1977 
27853db1458Sdrh /*
27953db1458Sdrh ** pExpr is a comparison operator.  Return the type affinity that should
28053db1458Sdrh ** be applied to both operands prior to doing the comparison.
28153db1458Sdrh */
282e7375bfaSdrh static char comparisonAffinity(const Expr *pExpr){
283e014a838Sdanielk1977   char aff;
284e014a838Sdanielk1977   assert( pExpr->op==TK_EQ || pExpr->op==TK_IN || pExpr->op==TK_LT ||
285e014a838Sdanielk1977           pExpr->op==TK_GT || pExpr->op==TK_GE || pExpr->op==TK_LE ||
2866a2fe093Sdrh           pExpr->op==TK_NE || pExpr->op==TK_IS || pExpr->op==TK_ISNOT );
287e014a838Sdanielk1977   assert( pExpr->pLeft );
288bf3b721fSdanielk1977   aff = sqlite3ExprAffinity(pExpr->pLeft);
289e014a838Sdanielk1977   if( pExpr->pRight ){
290e014a838Sdanielk1977     aff = sqlite3CompareAffinity(pExpr->pRight, aff);
291*a4eeccdfSdrh   }else if( ExprUseXSelect(pExpr) ){
2926ab3a2ecSdanielk1977     aff = sqlite3CompareAffinity(pExpr->x.pSelect->pEList->a[0].pExpr, aff);
29313ac46eeSdrh   }else if( aff==0 ){
29405883a34Sdrh     aff = SQLITE_AFF_BLOB;
295e014a838Sdanielk1977   }
296e014a838Sdanielk1977   return aff;
297e014a838Sdanielk1977 }
298e014a838Sdanielk1977 
299e014a838Sdanielk1977 /*
300e014a838Sdanielk1977 ** pExpr is a comparison expression, eg. '=', '<', IN(...) etc.
301e014a838Sdanielk1977 ** idx_affinity is the affinity of an indexed column. Return true
302e014a838Sdanielk1977 ** if the index with affinity idx_affinity may be used to implement
303e014a838Sdanielk1977 ** the comparison in pExpr.
304e014a838Sdanielk1977 */
305e7375bfaSdrh int sqlite3IndexAffinityOk(const Expr *pExpr, char idx_affinity){
306e014a838Sdanielk1977   char aff = comparisonAffinity(pExpr);
307915e434cSdrh   if( aff<SQLITE_AFF_TEXT ){
3088a51256cSdrh     return 1;
3098a51256cSdrh   }
310915e434cSdrh   if( aff==SQLITE_AFF_TEXT ){
311915e434cSdrh     return idx_affinity==SQLITE_AFF_TEXT;
312915e434cSdrh   }
313915e434cSdrh   return sqlite3IsNumericAffinity(idx_affinity);
314e014a838Sdanielk1977 }
315e014a838Sdanielk1977 
316a37cdde0Sdanielk1977 /*
31735573356Sdrh ** Return the P5 value that should be used for a binary comparison
318a37cdde0Sdanielk1977 ** opcode (OP_Eq, OP_Ge etc.) used to compare pExpr1 and pExpr2.
319a37cdde0Sdanielk1977 */
320e7375bfaSdrh static u8 binaryCompareP5(
321e7375bfaSdrh   const Expr *pExpr1,   /* Left operand */
322e7375bfaSdrh   const Expr *pExpr2,   /* Right operand */
323e7375bfaSdrh   int jumpIfNull        /* Extra flags added to P5 */
324e7375bfaSdrh ){
32535573356Sdrh   u8 aff = (char)sqlite3ExprAffinity(pExpr2);
3261bd10f8aSdrh   aff = (u8)sqlite3CompareAffinity(pExpr1, aff) | (u8)jumpIfNull;
32735573356Sdrh   return aff;
328a37cdde0Sdanielk1977 }
329a37cdde0Sdanielk1977 
330a2e00042Sdrh /*
3310202b29eSdanielk1977 ** Return a pointer to the collation sequence that should be used by
3320202b29eSdanielk1977 ** a binary comparison operator comparing pLeft and pRight.
3330202b29eSdanielk1977 **
3340202b29eSdanielk1977 ** If the left hand expression has a collating sequence type, then it is
3350202b29eSdanielk1977 ** used. Otherwise the collation sequence for the right hand expression
3360202b29eSdanielk1977 ** is used, or the default (BINARY) if neither expression has a collating
3370202b29eSdanielk1977 ** type.
338bcbb04e5Sdanielk1977 **
339bcbb04e5Sdanielk1977 ** Argument pRight (but not pLeft) may be a null pointer. In this case,
340bcbb04e5Sdanielk1977 ** it is not considered.
3410202b29eSdanielk1977 */
342bcbb04e5Sdanielk1977 CollSeq *sqlite3BinaryCompareCollSeq(
343bcbb04e5Sdanielk1977   Parse *pParse,
344e7375bfaSdrh   const Expr *pLeft,
345e7375bfaSdrh   const Expr *pRight
346bcbb04e5Sdanielk1977 ){
347ec41ddacSdrh   CollSeq *pColl;
348ec41ddacSdrh   assert( pLeft );
349ae80ddeaSdrh   if( pLeft->flags & EP_Collate ){
350ae80ddeaSdrh     pColl = sqlite3ExprCollSeq(pParse, pLeft);
351ae80ddeaSdrh   }else if( pRight && (pRight->flags & EP_Collate)!=0 ){
352ae80ddeaSdrh     pColl = sqlite3ExprCollSeq(pParse, pRight);
353ec41ddacSdrh   }else{
354ec41ddacSdrh     pColl = sqlite3ExprCollSeq(pParse, pLeft);
3550202b29eSdanielk1977     if( !pColl ){
3567cedc8d4Sdanielk1977       pColl = sqlite3ExprCollSeq(pParse, pRight);
3570202b29eSdanielk1977     }
358ec41ddacSdrh   }
3590202b29eSdanielk1977   return pColl;
3600202b29eSdanielk1977 }
3610202b29eSdanielk1977 
362898c527eSdrh /* Expresssion p is a comparison operator.  Return a collation sequence
363898c527eSdrh ** appropriate for the comparison operator.
364898c527eSdrh **
365898c527eSdrh ** This is normally just a wrapper around sqlite3BinaryCompareCollSeq().
366898c527eSdrh ** However, if the OP_Commuted flag is set, then the order of the operands
367898c527eSdrh ** is reversed in the sqlite3BinaryCompareCollSeq() call so that the
368898c527eSdrh ** correct collating sequence is found.
369898c527eSdrh */
370e7375bfaSdrh CollSeq *sqlite3ExprCompareCollSeq(Parse *pParse, const Expr *p){
371898c527eSdrh   if( ExprHasProperty(p, EP_Commuted) ){
372898c527eSdrh     return sqlite3BinaryCompareCollSeq(pParse, p->pRight, p->pLeft);
373898c527eSdrh   }else{
374898c527eSdrh     return sqlite3BinaryCompareCollSeq(pParse, p->pLeft, p->pRight);
375898c527eSdrh   }
376898c527eSdrh }
377898c527eSdrh 
3780202b29eSdanielk1977 /*
379be5c89acSdrh ** Generate code for a comparison operator.
380be5c89acSdrh */
381be5c89acSdrh static int codeCompare(
382be5c89acSdrh   Parse *pParse,    /* The parsing (and code generating) context */
383be5c89acSdrh   Expr *pLeft,      /* The left operand */
384be5c89acSdrh   Expr *pRight,     /* The right operand */
385be5c89acSdrh   int opcode,       /* The comparison opcode */
38635573356Sdrh   int in1, int in2, /* Register holding operands */
387be5c89acSdrh   int dest,         /* Jump here if true.  */
388898c527eSdrh   int jumpIfNull,   /* If true, jump if either operand is NULL */
389898c527eSdrh   int isCommuted    /* The comparison has been commuted */
390be5c89acSdrh ){
39135573356Sdrh   int p5;
39235573356Sdrh   int addr;
39335573356Sdrh   CollSeq *p4;
39435573356Sdrh 
3958654186bSdrh   if( pParse->nErr ) return 0;
396898c527eSdrh   if( isCommuted ){
397898c527eSdrh     p4 = sqlite3BinaryCompareCollSeq(pParse, pRight, pLeft);
398898c527eSdrh   }else{
39935573356Sdrh     p4 = sqlite3BinaryCompareCollSeq(pParse, pLeft, pRight);
400898c527eSdrh   }
40135573356Sdrh   p5 = binaryCompareP5(pLeft, pRight, jumpIfNull);
40235573356Sdrh   addr = sqlite3VdbeAddOp4(pParse->pVdbe, opcode, in2, dest, in1,
40335573356Sdrh                            (void*)p4, P4_COLLSEQ);
4041bd10f8aSdrh   sqlite3VdbeChangeP5(pParse->pVdbe, (u8)p5);
40535573356Sdrh   return addr;
406be5c89acSdrh }
407be5c89acSdrh 
408cfbb5e82Sdan /*
409870a0705Sdan ** Return true if expression pExpr is a vector, or false otherwise.
410d832da7fSdrh **
411d832da7fSdrh ** A vector is defined as any expression that results in two or more
412d832da7fSdrh ** columns of result.  Every TK_VECTOR node is an vector because the
413d832da7fSdrh ** parser will not generate a TK_VECTOR with fewer than two entries.
414d832da7fSdrh ** But a TK_SELECT might be either a vector or a scalar. It is only
415d832da7fSdrh ** considered a vector if it has two or more result columns.
416870a0705Sdan */
417b6dad520Sdrh int sqlite3ExprIsVector(const Expr *pExpr){
41876dbe7a8Sdrh   return sqlite3ExprVectorSize(pExpr)>1;
419870a0705Sdan }
420870a0705Sdan 
421870a0705Sdan /*
422cfbb5e82Sdan ** If the expression passed as the only argument is of type TK_VECTOR
423cfbb5e82Sdan ** return the number of expressions in the vector. Or, if the expression
424cfbb5e82Sdan ** is a sub-select, return the number of columns in the sub-select. For
425cfbb5e82Sdan ** any other type of expression, return 1.
426cfbb5e82Sdan */
427b6dad520Sdrh int sqlite3ExprVectorSize(const Expr *pExpr){
42812abf408Sdrh   u8 op = pExpr->op;
42912abf408Sdrh   if( op==TK_REGISTER ) op = pExpr->op2;
43012abf408Sdrh   if( op==TK_VECTOR ){
431*a4eeccdfSdrh     assert( ExprUseXList(pExpr) );
43271c57db0Sdan     return pExpr->x.pList->nExpr;
43312abf408Sdrh   }else if( op==TK_SELECT ){
434*a4eeccdfSdrh     assert( ExprUseXSelect(pExpr) );
43576dbe7a8Sdrh     return pExpr->x.pSelect->pEList->nExpr;
43676dbe7a8Sdrh   }else{
43776dbe7a8Sdrh     return 1;
43876dbe7a8Sdrh   }
43971c57db0Sdan }
44071c57db0Sdan 
441ba00e30aSdan /*
442fc7f27b9Sdrh ** Return a pointer to a subexpression of pVector that is the i-th
443fc7f27b9Sdrh ** column of the vector (numbered starting with 0).  The caller must
444fc7f27b9Sdrh ** ensure that i is within range.
445fc7f27b9Sdrh **
44676dbe7a8Sdrh ** If pVector is really a scalar (and "scalar" here includes subqueries
44776dbe7a8Sdrh ** that return a single column!) then return pVector unmodified.
44876dbe7a8Sdrh **
449fc7f27b9Sdrh ** pVector retains ownership of the returned subexpression.
450fc7f27b9Sdrh **
451fc7f27b9Sdrh ** If the vector is a (SELECT ...) then the expression returned is
45276dbe7a8Sdrh ** just the expression for the i-th term of the result set, and may
45376dbe7a8Sdrh ** not be ready for evaluation because the table cursor has not yet
45476dbe7a8Sdrh ** been positioned.
455ba00e30aSdan */
456fc7f27b9Sdrh Expr *sqlite3VectorFieldSubexpr(Expr *pVector, int i){
457bf7f3a00Sdrh   assert( i<sqlite3ExprVectorSize(pVector) || pVector->op==TK_ERROR );
458870a0705Sdan   if( sqlite3ExprIsVector(pVector) ){
4599f24b53dSdrh     assert( pVector->op2==0 || pVector->op==TK_REGISTER );
4609f24b53dSdrh     if( pVector->op==TK_SELECT || pVector->op2==TK_SELECT ){
461*a4eeccdfSdrh       assert( ExprUseXSelect(pVector) );
46271c57db0Sdan       return pVector->x.pSelect->pEList->a[i].pExpr;
463870a0705Sdan     }else{
464*a4eeccdfSdrh       assert( ExprUseXList(pVector) );
46571c57db0Sdan       return pVector->x.pList->a[i].pExpr;
46671c57db0Sdan     }
467870a0705Sdan   }
468870a0705Sdan   return pVector;
469870a0705Sdan }
470fc7f27b9Sdrh 
471fc7f27b9Sdrh /*
472fc7f27b9Sdrh ** Compute and return a new Expr object which when passed to
473fc7f27b9Sdrh ** sqlite3ExprCode() will generate all necessary code to compute
474fc7f27b9Sdrh ** the iField-th column of the vector expression pVector.
475fc7f27b9Sdrh **
4768762ec19Sdrh ** It is ok for pVector to be a scalar (as long as iField==0).
4778762ec19Sdrh ** In that case, this routine works like sqlite3ExprDup().
4788762ec19Sdrh **
479fc7f27b9Sdrh ** The caller owns the returned Expr object and is responsible for
480fc7f27b9Sdrh ** ensuring that the returned value eventually gets freed.
481fc7f27b9Sdrh **
4828762ec19Sdrh ** The caller retains ownership of pVector.  If pVector is a TK_SELECT,
483fad0e70cSdan ** then the returned object will reference pVector and so pVector must remain
4848762ec19Sdrh ** valid for the life of the returned object.  If pVector is a TK_VECTOR
4858762ec19Sdrh ** or a scalar expression, then it can be deleted as soon as this routine
48676dbe7a8Sdrh ** returns.
4878762ec19Sdrh **
4888762ec19Sdrh ** A trick to cause a TK_SELECT pVector to be deleted together with
4898762ec19Sdrh ** the returned Expr object is to attach the pVector to the pRight field
4908762ec19Sdrh ** of the returned TK_SELECT_COLUMN Expr object.
491fc7f27b9Sdrh */
492fc7f27b9Sdrh Expr *sqlite3ExprForVectorField(
493fc7f27b9Sdrh   Parse *pParse,       /* Parsing context */
494fc7f27b9Sdrh   Expr *pVector,       /* The vector.  List of expressions or a sub-SELECT */
49510f08270Sdrh   int iField,          /* Which column of the vector to return */
49610f08270Sdrh   int nField           /* Total number of columns in the vector */
497fc7f27b9Sdrh ){
498fc7f27b9Sdrh   Expr *pRet;
499a1251bc4Sdrh   if( pVector->op==TK_SELECT ){
500*a4eeccdfSdrh     assert( ExprUseXSelect(pVector) );
501fc7f27b9Sdrh     /* The TK_SELECT_COLUMN Expr node:
502fc7f27b9Sdrh     **
503966e2911Sdrh     ** pLeft:           pVector containing TK_SELECT.  Not deleted.
5048762ec19Sdrh     ** pRight:          not used.  But recursively deleted.
505fc7f27b9Sdrh     ** iColumn:         Index of a column in pVector
506966e2911Sdrh     ** iTable:          0 or the number of columns on the LHS of an assignment
507fc7f27b9Sdrh     ** pLeft->iTable:   First in an array of register holding result, or 0
508fc7f27b9Sdrh     **                  if the result is not yet computed.
509fc7f27b9Sdrh     **
510fc7f27b9Sdrh     ** sqlite3ExprDelete() specifically skips the recursive delete of
511fc7f27b9Sdrh     ** pLeft on TK_SELECT_COLUMN nodes.  But pRight is followed, so pVector
5128762ec19Sdrh     ** can be attached to pRight to cause this node to take ownership of
5138762ec19Sdrh     ** pVector.  Typically there will be multiple TK_SELECT_COLUMN nodes
5148762ec19Sdrh     ** with the same pLeft pointer to the pVector, but only one of them
5158762ec19Sdrh     ** will own the pVector.
516fc7f27b9Sdrh     */
517abfd35eaSdrh     pRet = sqlite3PExpr(pParse, TK_SELECT_COLUMN, 0, 0);
5188bd0d58eSdrh     if( pRet ){
51910f08270Sdrh       pRet->iTable = nField;
5208bd0d58eSdrh       pRet->iColumn = iField;
5218bd0d58eSdrh       pRet->pLeft = pVector;
5228bd0d58eSdrh     }
523fc7f27b9Sdrh   }else{
524ab632bc9Sdan     if( pVector->op==TK_VECTOR ){
525*a4eeccdfSdrh       Expr **ppVector;
526*a4eeccdfSdrh       assert( ExprUseXList(pVector) );
527*a4eeccdfSdrh       ppVector = &pVector->x.pList->a[iField].pExpr;
528ab632bc9Sdan       pVector = *ppVector;
529ab632bc9Sdan       if( IN_RENAME_OBJECT ){
530ab632bc9Sdan         /* This must be a vector UPDATE inside a trigger */
531ab632bc9Sdan         *ppVector = 0;
532ab632bc9Sdan         return pVector;
533fc7f27b9Sdrh       }
5345a69d19eSdan     }
535ab632bc9Sdan     pRet = sqlite3ExprDup(pParse->db, pVector, 0);
536ab632bc9Sdan   }
537fc7f27b9Sdrh   return pRet;
538fc7f27b9Sdrh }
53971c57db0Sdan 
5405c288b92Sdan /*
5415c288b92Sdan ** If expression pExpr is of type TK_SELECT, generate code to evaluate
5425c288b92Sdan ** it. Return the register in which the result is stored (or, if the
5435c288b92Sdan ** sub-select returns more than one column, the first in an array
5445c288b92Sdan ** of registers in which the result is stored).
5455c288b92Sdan **
5465c288b92Sdan ** If pExpr is not a TK_SELECT expression, return 0.
5475c288b92Sdan */
5485c288b92Sdan static int exprCodeSubselect(Parse *pParse, Expr *pExpr){
5498da209b1Sdan   int reg = 0;
550f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
5515c288b92Sdan   if( pExpr->op==TK_SELECT ){
55285bcdce2Sdrh     reg = sqlite3CodeSubselect(pParse, pExpr);
5538da209b1Sdan   }
554f9b2e05cSdan #endif
5558da209b1Sdan   return reg;
5568da209b1Sdan }
5578da209b1Sdan 
5585c288b92Sdan /*
5595c288b92Sdan ** Argument pVector points to a vector expression - either a TK_VECTOR
560870a0705Sdan ** or TK_SELECT that returns more than one column. This function returns
561870a0705Sdan ** the register number of a register that contains the value of
562870a0705Sdan ** element iField of the vector.
563870a0705Sdan **
564870a0705Sdan ** If pVector is a TK_SELECT expression, then code for it must have
565870a0705Sdan ** already been generated using the exprCodeSubselect() routine. In this
566870a0705Sdan ** case parameter regSelect should be the first in an array of registers
567870a0705Sdan ** containing the results of the sub-select.
568870a0705Sdan **
569870a0705Sdan ** If pVector is of type TK_VECTOR, then code for the requested field
570870a0705Sdan ** is generated. In this case (*pRegFree) may be set to the number of
571870a0705Sdan ** a temporary register to be freed by the caller before returning.
5725c288b92Sdan **
5735c288b92Sdan ** Before returning, output parameter (*ppExpr) is set to point to the
5745c288b92Sdan ** Expr object corresponding to element iElem of the vector.
5755c288b92Sdan */
5765c288b92Sdan static int exprVectorRegister(
5775c288b92Sdan   Parse *pParse,                  /* Parse context */
5785c288b92Sdan   Expr *pVector,                  /* Vector to extract element from */
579870a0705Sdan   int iField,                     /* Field to extract from pVector */
5805c288b92Sdan   int regSelect,                  /* First in array of registers */
5815c288b92Sdan   Expr **ppExpr,                  /* OUT: Expression element */
5825c288b92Sdan   int *pRegFree                   /* OUT: Temp register to free */
5835c288b92Sdan ){
58412abf408Sdrh   u8 op = pVector->op;
58505428127Sdrh   assert( op==TK_VECTOR || op==TK_REGISTER || op==TK_SELECT || op==TK_ERROR );
58612abf408Sdrh   if( op==TK_REGISTER ){
58712abf408Sdrh     *ppExpr = sqlite3VectorFieldSubexpr(pVector, iField);
58812abf408Sdrh     return pVector->iTable+iField;
58912abf408Sdrh   }
59012abf408Sdrh   if( op==TK_SELECT ){
591*a4eeccdfSdrh     assert( ExprUseXSelect(pVector) );
592870a0705Sdan     *ppExpr = pVector->x.pSelect->pEList->a[iField].pExpr;
593870a0705Sdan      return regSelect+iField;
5945c288b92Sdan   }
59505428127Sdrh   if( op==TK_VECTOR ){
596*a4eeccdfSdrh     assert( ExprUseXList(pVector) );
597870a0705Sdan     *ppExpr = pVector->x.pList->a[iField].pExpr;
5985c288b92Sdan     return sqlite3ExprCodeTemp(pParse, *ppExpr, pRegFree);
5995c288b92Sdan   }
60005428127Sdrh   return 0;
60105428127Sdrh }
6025c288b92Sdan 
6035c288b92Sdan /*
6045c288b92Sdan ** Expression pExpr is a comparison between two vector values. Compute
60579752b6eSdrh ** the result of the comparison (1, 0, or NULL) and write that
60679752b6eSdrh ** result into register dest.
60779752b6eSdrh **
60879752b6eSdrh ** The caller must satisfy the following preconditions:
60979752b6eSdrh **
61079752b6eSdrh **    if pExpr->op==TK_IS:      op==TK_EQ and p5==SQLITE_NULLEQ
61179752b6eSdrh **    if pExpr->op==TK_ISNOT:   op==TK_NE and p5==SQLITE_NULLEQ
61279752b6eSdrh **    otherwise:                op==pExpr->op and p5==0
6135c288b92Sdan */
61479752b6eSdrh static void codeVectorCompare(
61579752b6eSdrh   Parse *pParse,        /* Code generator context */
61679752b6eSdrh   Expr *pExpr,          /* The comparison operation */
61779752b6eSdrh   int dest,             /* Write results into this register */
61879752b6eSdrh   u8 op,                /* Comparison operator */
61979752b6eSdrh   u8 p5                 /* SQLITE_NULLEQ or zero */
62079752b6eSdrh ){
62171c57db0Sdan   Vdbe *v = pParse->pVdbe;
62271c57db0Sdan   Expr *pLeft = pExpr->pLeft;
62371c57db0Sdan   Expr *pRight = pExpr->pRight;
62471c57db0Sdan   int nLeft = sqlite3ExprVectorSize(pLeft);
62571c57db0Sdan   int i;
62671c57db0Sdan   int regLeft = 0;
62771c57db0Sdan   int regRight = 0;
62879752b6eSdrh   u8 opx = op;
6294bc20452Sdrh   int addrCmp = 0;
630ec4ccdbcSdrh   int addrDone = sqlite3VdbeMakeLabel(pParse);
631898c527eSdrh   int isCommuted = ExprHasProperty(pExpr,EP_Commuted);
63271c57db0Sdan 
633e7375bfaSdrh   assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
634340fd0bcSdrh   if( pParse->nErr ) return;
635245ce62eSdrh   if( nLeft!=sqlite3ExprVectorSize(pRight) ){
636245ce62eSdrh     sqlite3ErrorMsg(pParse, "row value misused");
637245ce62eSdrh     return;
638245ce62eSdrh   }
63971c57db0Sdan   assert( pExpr->op==TK_EQ || pExpr->op==TK_NE
64071c57db0Sdan        || pExpr->op==TK_IS || pExpr->op==TK_ISNOT
64171c57db0Sdan        || pExpr->op==TK_LT || pExpr->op==TK_GT
64271c57db0Sdan        || pExpr->op==TK_LE || pExpr->op==TK_GE
64371c57db0Sdan   );
64479752b6eSdrh   assert( pExpr->op==op || (pExpr->op==TK_IS && op==TK_EQ)
64579752b6eSdrh             || (pExpr->op==TK_ISNOT && op==TK_NE) );
64679752b6eSdrh   assert( p5==0 || pExpr->op!=op );
64779752b6eSdrh   assert( p5==SQLITE_NULLEQ || pExpr->op==op );
64871c57db0Sdan 
6494bc20452Sdrh   if( op==TK_LE ) opx = TK_LT;
6504bc20452Sdrh   if( op==TK_GE ) opx = TK_GT;
6514bc20452Sdrh   if( op==TK_NE ) opx = TK_EQ;
6525c288b92Sdan 
6535c288b92Sdan   regLeft = exprCodeSubselect(pParse, pLeft);
6545c288b92Sdan   regRight = exprCodeSubselect(pParse, pRight);
6555c288b92Sdan 
6564bc20452Sdrh   sqlite3VdbeAddOp2(v, OP_Integer, 1, dest);
657321e828dSdrh   for(i=0; 1 /*Loop exits by "break"*/; i++){
6585c288b92Sdan     int regFree1 = 0, regFree2 = 0;
659abc15f1bSdrh     Expr *pL = 0, *pR = 0;
6605c288b92Sdan     int r1, r2;
661321e828dSdrh     assert( i>=0 && i<nLeft );
6624bc20452Sdrh     if( addrCmp ) sqlite3VdbeJumpHere(v, addrCmp);
6635c288b92Sdan     r1 = exprVectorRegister(pParse, pLeft, i, regLeft, &pL, &regFree1);
6645c288b92Sdan     r2 = exprVectorRegister(pParse, pRight, i, regRight, &pR, &regFree2);
6654bc20452Sdrh     addrCmp = sqlite3VdbeCurrentAddr(v);
6664bc20452Sdrh     codeCompare(pParse, pL, pR, opx, r1, r2, addrDone, p5, isCommuted);
66779752b6eSdrh     testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
66879752b6eSdrh     testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
66979752b6eSdrh     testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
67079752b6eSdrh     testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
67179752b6eSdrh     testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
67279752b6eSdrh     testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
67371c57db0Sdan     sqlite3ReleaseTempReg(pParse, regFree1);
67471c57db0Sdan     sqlite3ReleaseTempReg(pParse, regFree2);
6754bc20452Sdrh     if( (opx==TK_LT || opx==TK_GT) && i<nLeft-1 ){
6764bc20452Sdrh       addrCmp = sqlite3VdbeAddOp0(v, OP_ElseEq);
6774bc20452Sdrh       testcase(opx==TK_LT); VdbeCoverageIf(v,opx==TK_LT);
6784bc20452Sdrh       testcase(opx==TK_GT); VdbeCoverageIf(v,opx==TK_GT);
6794bc20452Sdrh     }
6804bc20452Sdrh     if( p5==SQLITE_NULLEQ ){
6814bc20452Sdrh       sqlite3VdbeAddOp2(v, OP_Integer, 0, dest);
6824bc20452Sdrh     }else{
6834bc20452Sdrh       sqlite3VdbeAddOp3(v, OP_ZeroOrNull, r1, dest, r2);
6844bc20452Sdrh     }
68579752b6eSdrh     if( i==nLeft-1 ){
68679752b6eSdrh       break;
68771c57db0Sdan     }
68879752b6eSdrh     if( opx==TK_EQ ){
6894bc20452Sdrh       sqlite3VdbeAddOp2(v, OP_NotNull, dest, addrDone); VdbeCoverage(v);
690a2f62925Sdrh     }else{
691a2f62925Sdrh       assert( op==TK_LT || op==TK_GT || op==TK_LE || op==TK_GE );
6924bc20452Sdrh       sqlite3VdbeAddOp2(v, OP_Goto, 0, addrDone);
69379752b6eSdrh       if( i==nLeft-2 ) opx = op;
69471c57db0Sdan     }
69579752b6eSdrh   }
6964bc20452Sdrh   sqlite3VdbeJumpHere(v, addrCmp);
69779752b6eSdrh   sqlite3VdbeResolveLabel(v, addrDone);
6984bc20452Sdrh   if( op==TK_NE ){
6994bc20452Sdrh     sqlite3VdbeAddOp2(v, OP_Not, dest, dest);
7004bc20452Sdrh   }
70179752b6eSdrh }
70271c57db0Sdan 
7034b5255acSdanielk1977 #if SQLITE_MAX_EXPR_DEPTH>0
7044b5255acSdanielk1977 /*
7054b5255acSdanielk1977 ** Check that argument nHeight is less than or equal to the maximum
7064b5255acSdanielk1977 ** expression depth allowed. If it is not, leave an error message in
7074b5255acSdanielk1977 ** pParse.
7084b5255acSdanielk1977 */
7097d10d5a6Sdrh int sqlite3ExprCheckHeight(Parse *pParse, int nHeight){
7104b5255acSdanielk1977   int rc = SQLITE_OK;
7114b5255acSdanielk1977   int mxHeight = pParse->db->aLimit[SQLITE_LIMIT_EXPR_DEPTH];
7124b5255acSdanielk1977   if( nHeight>mxHeight ){
7134b5255acSdanielk1977     sqlite3ErrorMsg(pParse,
7144b5255acSdanielk1977        "Expression tree is too large (maximum depth %d)", mxHeight
7154b5255acSdanielk1977     );
7164b5255acSdanielk1977     rc = SQLITE_ERROR;
7174b5255acSdanielk1977   }
7184b5255acSdanielk1977   return rc;
7194b5255acSdanielk1977 }
7204b5255acSdanielk1977 
7214b5255acSdanielk1977 /* The following three functions, heightOfExpr(), heightOfExprList()
7224b5255acSdanielk1977 ** and heightOfSelect(), are used to determine the maximum height
7234b5255acSdanielk1977 ** of any expression tree referenced by the structure passed as the
7244b5255acSdanielk1977 ** first argument.
7254b5255acSdanielk1977 **
7264b5255acSdanielk1977 ** If this maximum height is greater than the current value pointed
7274b5255acSdanielk1977 ** to by pnHeight, the second parameter, then set *pnHeight to that
7284b5255acSdanielk1977 ** value.
7294b5255acSdanielk1977 */
730b6dad520Sdrh static void heightOfExpr(const Expr *p, int *pnHeight){
7314b5255acSdanielk1977   if( p ){
7324b5255acSdanielk1977     if( p->nHeight>*pnHeight ){
7334b5255acSdanielk1977       *pnHeight = p->nHeight;
7344b5255acSdanielk1977     }
7354b5255acSdanielk1977   }
7364b5255acSdanielk1977 }
737b6dad520Sdrh static void heightOfExprList(const ExprList *p, int *pnHeight){
7384b5255acSdanielk1977   if( p ){
7394b5255acSdanielk1977     int i;
7404b5255acSdanielk1977     for(i=0; i<p->nExpr; i++){
7414b5255acSdanielk1977       heightOfExpr(p->a[i].pExpr, pnHeight);
7424b5255acSdanielk1977     }
7434b5255acSdanielk1977   }
7444b5255acSdanielk1977 }
745b6dad520Sdrh static void heightOfSelect(const Select *pSelect, int *pnHeight){
746b6dad520Sdrh   const Select *p;
7471a3a3086Sdan   for(p=pSelect; p; p=p->pPrior){
7484b5255acSdanielk1977     heightOfExpr(p->pWhere, pnHeight);
7494b5255acSdanielk1977     heightOfExpr(p->pHaving, pnHeight);
7504b5255acSdanielk1977     heightOfExpr(p->pLimit, pnHeight);
7514b5255acSdanielk1977     heightOfExprList(p->pEList, pnHeight);
7524b5255acSdanielk1977     heightOfExprList(p->pGroupBy, pnHeight);
7534b5255acSdanielk1977     heightOfExprList(p->pOrderBy, pnHeight);
7544b5255acSdanielk1977   }
7554b5255acSdanielk1977 }
7564b5255acSdanielk1977 
7574b5255acSdanielk1977 /*
7584b5255acSdanielk1977 ** Set the Expr.nHeight variable in the structure passed as an
7594b5255acSdanielk1977 ** argument. An expression with no children, Expr.pList or
7604b5255acSdanielk1977 ** Expr.pSelect member has a height of 1. Any other expression
7614b5255acSdanielk1977 ** has a height equal to the maximum height of any other
7624b5255acSdanielk1977 ** referenced Expr plus one.
7632308ed38Sdrh **
7642308ed38Sdrh ** Also propagate EP_Propagate flags up from Expr.x.pList to Expr.flags,
7652308ed38Sdrh ** if appropriate.
7664b5255acSdanielk1977 */
7674b5255acSdanielk1977 static void exprSetHeight(Expr *p){
7684b5255acSdanielk1977   int nHeight = 0;
7694b5255acSdanielk1977   heightOfExpr(p->pLeft, &nHeight);
7704b5255acSdanielk1977   heightOfExpr(p->pRight, &nHeight);
771*a4eeccdfSdrh   if( ExprUseXSelect(p) ){
7726ab3a2ecSdanielk1977     heightOfSelect(p->x.pSelect, &nHeight);
7732308ed38Sdrh   }else if( p->x.pList ){
7746ab3a2ecSdanielk1977     heightOfExprList(p->x.pList, &nHeight);
7752308ed38Sdrh     p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
7766ab3a2ecSdanielk1977   }
7774b5255acSdanielk1977   p->nHeight = nHeight + 1;
7784b5255acSdanielk1977 }
7794b5255acSdanielk1977 
7804b5255acSdanielk1977 /*
7814b5255acSdanielk1977 ** Set the Expr.nHeight variable using the exprSetHeight() function. If
7824b5255acSdanielk1977 ** the height is greater than the maximum allowed expression depth,
7834b5255acSdanielk1977 ** leave an error in pParse.
7842308ed38Sdrh **
7852308ed38Sdrh ** Also propagate all EP_Propagate flags from the Expr.x.pList into
7862308ed38Sdrh ** Expr.flags.
7874b5255acSdanielk1977 */
7882308ed38Sdrh void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
78974893a4cSdrh   if( pParse->nErr ) return;
7904b5255acSdanielk1977   exprSetHeight(p);
7917d10d5a6Sdrh   sqlite3ExprCheckHeight(pParse, p->nHeight);
7924b5255acSdanielk1977 }
7934b5255acSdanielk1977 
7944b5255acSdanielk1977 /*
7954b5255acSdanielk1977 ** Return the maximum height of any expression tree referenced
7964b5255acSdanielk1977 ** by the select statement passed as an argument.
7974b5255acSdanielk1977 */
798b6dad520Sdrh int sqlite3SelectExprHeight(const Select *p){
7994b5255acSdanielk1977   int nHeight = 0;
8004b5255acSdanielk1977   heightOfSelect(p, &nHeight);
8014b5255acSdanielk1977   return nHeight;
8024b5255acSdanielk1977 }
8032308ed38Sdrh #else /* ABOVE:  Height enforcement enabled.  BELOW: Height enforcement off */
8042308ed38Sdrh /*
8052308ed38Sdrh ** Propagate all EP_Propagate flags from the Expr.x.pList into
8062308ed38Sdrh ** Expr.flags.
8072308ed38Sdrh */
8082308ed38Sdrh void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
8096c3b4b07Sdan   if( pParse->nErr ) return;
810*a4eeccdfSdrh   if( p && ExprUseXList(p) && p->x.pList ){
8112308ed38Sdrh     p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
8122308ed38Sdrh   }
8132308ed38Sdrh }
8144b5255acSdanielk1977 #define exprSetHeight(y)
8154b5255acSdanielk1977 #endif /* SQLITE_MAX_EXPR_DEPTH>0 */
8164b5255acSdanielk1977 
817be5c89acSdrh /*
818b7916a78Sdrh ** This routine is the core allocator for Expr nodes.
819b7916a78Sdrh **
820a76b5dfcSdrh ** Construct a new expression node and return a pointer to it.  Memory
821b7916a78Sdrh ** for this node and for the pToken argument is a single allocation
822b7916a78Sdrh ** obtained from sqlite3DbMalloc().  The calling function
823a76b5dfcSdrh ** is responsible for making sure the node eventually gets freed.
824b7916a78Sdrh **
825b7916a78Sdrh ** If dequote is true, then the token (if it exists) is dequoted.
826e792b5b4Sdrh ** If dequote is false, no dequoting is performed.  The deQuote
827b7916a78Sdrh ** parameter is ignored if pToken is NULL or if the token does not
828b7916a78Sdrh ** appear to be quoted.  If the quotes were of the form "..." (double-quotes)
829b7916a78Sdrh ** then the EP_DblQuoted flag is set on the expression node.
83033e619fcSdrh **
83133e619fcSdrh ** Special case:  If op==TK_INTEGER and pToken points to a string that
83233e619fcSdrh ** can be translated into a 32-bit integer, then the token is not
83333e619fcSdrh ** stored in u.zToken.  Instead, the integer values is written
83433e619fcSdrh ** into u.iValue and the EP_IntValue flag is set.  No extra storage
83533e619fcSdrh ** is allocated to hold the integer text and the dequote flag is ignored.
836a76b5dfcSdrh */
837b7916a78Sdrh Expr *sqlite3ExprAlloc(
838cca8a4adSdrh   sqlite3 *db,            /* Handle for sqlite3DbMallocRawNN() */
83917435752Sdrh   int op,                 /* Expression opcode */
840b7916a78Sdrh   const Token *pToken,    /* Token argument.  Might be NULL */
841b7916a78Sdrh   int dequote             /* True to dequote */
84217435752Sdrh ){
843a76b5dfcSdrh   Expr *pNew;
84433e619fcSdrh   int nExtra = 0;
845cf697396Sshane   int iValue = 0;
846b7916a78Sdrh 
847575fad65Sdrh   assert( db!=0 );
848b7916a78Sdrh   if( pToken ){
84933e619fcSdrh     if( op!=TK_INTEGER || pToken->z==0
85033e619fcSdrh           || sqlite3GetInt32(pToken->z, &iValue)==0 ){
851b7916a78Sdrh       nExtra = pToken->n+1;
852d50ffc41Sdrh       assert( iValue>=0 );
85333e619fcSdrh     }
854a76b5dfcSdrh   }
855575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, sizeof(Expr)+nExtra);
856b7916a78Sdrh   if( pNew ){
857ca3862dcSdrh     memset(pNew, 0, sizeof(Expr));
8581bd10f8aSdrh     pNew->op = (u8)op;
859a58fdfb1Sdanielk1977     pNew->iAgg = -1;
860a76b5dfcSdrh     if( pToken ){
86133e619fcSdrh       if( nExtra==0 ){
862ad31727fSdrh         pNew->flags |= EP_IntValue|EP_Leaf|(iValue?EP_IsTrue:EP_IsFalse);
86333e619fcSdrh         pNew->u.iValue = iValue;
86433e619fcSdrh       }else{
86533e619fcSdrh         pNew->u.zToken = (char*)&pNew[1];
866b07028f7Sdrh         assert( pToken->z!=0 || pToken->n==0 );
867b07028f7Sdrh         if( pToken->n ) memcpy(pNew->u.zToken, pToken->z, pToken->n);
86833e619fcSdrh         pNew->u.zToken[pToken->n] = 0;
869244b9d6eSdrh         if( dequote && sqlite3Isquote(pNew->u.zToken[0]) ){
87051d35b0fSdrh           sqlite3DequoteExpr(pNew);
871a34001c9Sdrh         }
872a34001c9Sdrh       }
87333e619fcSdrh     }
874b7916a78Sdrh #if SQLITE_MAX_EXPR_DEPTH>0
875b7916a78Sdrh     pNew->nHeight = 1;
876b7916a78Sdrh #endif
877a34001c9Sdrh   }
878a76b5dfcSdrh   return pNew;
879a76b5dfcSdrh }
880a76b5dfcSdrh 
881a76b5dfcSdrh /*
882b7916a78Sdrh ** Allocate a new expression node from a zero-terminated token that has
883b7916a78Sdrh ** already been dequoted.
884b7916a78Sdrh */
885b7916a78Sdrh Expr *sqlite3Expr(
886b7916a78Sdrh   sqlite3 *db,            /* Handle for sqlite3DbMallocZero() (may be null) */
887b7916a78Sdrh   int op,                 /* Expression opcode */
888b7916a78Sdrh   const char *zToken      /* Token argument.  Might be NULL */
889b7916a78Sdrh ){
890b7916a78Sdrh   Token x;
891b7916a78Sdrh   x.z = zToken;
892b40f06c6Sdrh   x.n = sqlite3Strlen30(zToken);
893b7916a78Sdrh   return sqlite3ExprAlloc(db, op, &x, 0);
894b7916a78Sdrh }
895b7916a78Sdrh 
896b7916a78Sdrh /*
897b7916a78Sdrh ** Attach subtrees pLeft and pRight to the Expr node pRoot.
898b7916a78Sdrh **
899b7916a78Sdrh ** If pRoot==NULL that means that a memory allocation error has occurred.
900b7916a78Sdrh ** In that case, delete the subtrees pLeft and pRight.
901b7916a78Sdrh */
902b7916a78Sdrh void sqlite3ExprAttachSubtrees(
903b7916a78Sdrh   sqlite3 *db,
904b7916a78Sdrh   Expr *pRoot,
905b7916a78Sdrh   Expr *pLeft,
906b7916a78Sdrh   Expr *pRight
907b7916a78Sdrh ){
908b7916a78Sdrh   if( pRoot==0 ){
909b7916a78Sdrh     assert( db->mallocFailed );
910b7916a78Sdrh     sqlite3ExprDelete(db, pLeft);
911b7916a78Sdrh     sqlite3ExprDelete(db, pRight);
912b7916a78Sdrh   }else{
913b7916a78Sdrh     if( pRight ){
914b7916a78Sdrh       pRoot->pRight = pRight;
915885a5b03Sdrh       pRoot->flags |= EP_Propagate & pRight->flags;
916b7916a78Sdrh     }
917b7916a78Sdrh     if( pLeft ){
918b7916a78Sdrh       pRoot->pLeft = pLeft;
919885a5b03Sdrh       pRoot->flags |= EP_Propagate & pLeft->flags;
920b7916a78Sdrh     }
921b7916a78Sdrh     exprSetHeight(pRoot);
922b7916a78Sdrh   }
923b7916a78Sdrh }
924b7916a78Sdrh 
925b7916a78Sdrh /*
92660ec914cSpeter.d.reid ** Allocate an Expr node which joins as many as two subtrees.
927b7916a78Sdrh **
928bf664469Sdrh ** One or both of the subtrees can be NULL.  Return a pointer to the new
929bf664469Sdrh ** Expr node.  Or, if an OOM error occurs, set pParse->db->mallocFailed,
930bf664469Sdrh ** free the subtrees and return NULL.
931206f3d96Sdrh */
93217435752Sdrh Expr *sqlite3PExpr(
93317435752Sdrh   Parse *pParse,          /* Parsing context */
93417435752Sdrh   int op,                 /* Expression opcode */
93517435752Sdrh   Expr *pLeft,            /* Left operand */
936abfd35eaSdrh   Expr *pRight            /* Right operand */
93717435752Sdrh ){
9385fb52caaSdrh   Expr *p;
939abfd35eaSdrh   p = sqlite3DbMallocRawNN(pParse->db, sizeof(Expr));
940abfd35eaSdrh   if( p ){
941abfd35eaSdrh     memset(p, 0, sizeof(Expr));
942f1722baaSdrh     p->op = op & 0xff;
943abfd35eaSdrh     p->iAgg = -1;
944b7916a78Sdrh     sqlite3ExprAttachSubtrees(pParse->db, p, pLeft, pRight);
9452b359bdbSdan     sqlite3ExprCheckHeight(pParse, p->nHeight);
946d5c851c1Sdrh   }else{
947d5c851c1Sdrh     sqlite3ExprDelete(pParse->db, pLeft);
948d5c851c1Sdrh     sqlite3ExprDelete(pParse->db, pRight);
9492b359bdbSdan   }
9504e0cff60Sdrh   return p;
9514e0cff60Sdrh }
9524e0cff60Sdrh 
9534e0cff60Sdrh /*
95408de4f79Sdrh ** Add pSelect to the Expr.x.pSelect field.  Or, if pExpr is NULL (due
95508de4f79Sdrh ** do a memory allocation failure) then delete the pSelect object.
95608de4f79Sdrh */
95708de4f79Sdrh void sqlite3PExprAddSelect(Parse *pParse, Expr *pExpr, Select *pSelect){
95808de4f79Sdrh   if( pExpr ){
95908de4f79Sdrh     pExpr->x.pSelect = pSelect;
96008de4f79Sdrh     ExprSetProperty(pExpr, EP_xIsSelect|EP_Subquery);
96108de4f79Sdrh     sqlite3ExprSetHeightAndFlags(pParse, pExpr);
96208de4f79Sdrh   }else{
96308de4f79Sdrh     assert( pParse->db->mallocFailed );
96408de4f79Sdrh     sqlite3SelectDelete(pParse->db, pSelect);
96508de4f79Sdrh   }
96608de4f79Sdrh }
96708de4f79Sdrh 
9689289f510Sdan /*
9699289f510Sdan ** Expression list pEList is a list of vector values. This function
9709289f510Sdan ** converts the contents of pEList to a VALUES(...) Select statement
97174777f99Sdan ** returning 1 row for each element of the list. For example, the
97274777f99Sdan ** expression list:
9739289f510Sdan **
97474777f99Sdan **   ( (1,2), (3,4) (5,6) )
9759289f510Sdan **
97674777f99Sdan ** is translated to the equivalent of:
9779289f510Sdan **
97874777f99Sdan **   VALUES(1,2), (3,4), (5,6)
9799289f510Sdan **
98074777f99Sdan ** Each of the vector values in pEList must contain exactly nElem terms.
98174777f99Sdan ** If a list element that is not a vector or does not contain nElem terms,
98274777f99Sdan ** an error message is left in pParse.
9839289f510Sdan **
9849289f510Sdan ** This is used as part of processing IN(...) expressions with a list
9859289f510Sdan ** of vectors on the RHS. e.g. "... IN ((1,2), (3,4), (5,6))".
9869289f510Sdan */
98774777f99Sdan Select *sqlite3ExprListToValues(Parse *pParse, int nElem, ExprList *pEList){
9889289f510Sdan   int ii;
9899289f510Sdan   Select *pRet = 0;
9902931a66eSdan   assert( nElem>1 );
9919289f510Sdan   for(ii=0; ii<pEList->nExpr; ii++){
9929289f510Sdan     Select *pSel;
9939289f510Sdan     Expr *pExpr = pEList->a[ii].pExpr;
994*a4eeccdfSdrh     int nExprElem;
995*a4eeccdfSdrh     if( pExpr->op==TK_VECTOR ){
996*a4eeccdfSdrh       assert( ExprUseXList(pExpr) );
997*a4eeccdfSdrh       nExprElem = pExpr->x.pList->nExpr;
998*a4eeccdfSdrh     }else{
999*a4eeccdfSdrh       nExprElem = 1;
1000*a4eeccdfSdrh     }
100174777f99Sdan     if( nExprElem!=nElem ){
100274777f99Sdan       sqlite3ErrorMsg(pParse, "IN(...) element has %d term%s - expected %d",
100374777f99Sdan           nExprElem, nExprElem>1?"s":"", nElem
100474777f99Sdan       );
100574777f99Sdan       break;
10069289f510Sdan     }
1007*a4eeccdfSdrh     assert( ExprUseXList(pExpr) );
100874777f99Sdan     pSel = sqlite3SelectNew(pParse, pExpr->x.pList, 0, 0, 0, 0, 0, SF_Values,0);
100974777f99Sdan     pExpr->x.pList = 0;
10109289f510Sdan     if( pSel ){
10119289f510Sdan       if( pRet ){
10129289f510Sdan         pSel->op = TK_ALL;
10139289f510Sdan         pSel->pPrior = pRet;
10149289f510Sdan       }
10159289f510Sdan       pRet = pSel;
10169289f510Sdan     }
10179289f510Sdan   }
10189289f510Sdan 
10199289f510Sdan   if( pRet && pRet->pPrior ){
10209289f510Sdan     pRet->selFlags |= SF_MultiValue;
10219289f510Sdan   }
10229289f510Sdan   sqlite3ExprListDelete(pParse->db, pEList);
10239289f510Sdan   return pRet;
10249289f510Sdan }
102508de4f79Sdrh 
102608de4f79Sdrh /*
102791bb0eedSdrh ** Join two expressions using an AND operator.  If either expression is
102891bb0eedSdrh ** NULL, then just return the other expression.
10295fb52caaSdrh **
10305fb52caaSdrh ** If one side or the other of the AND is known to be false, then instead
10315fb52caaSdrh ** of returning an AND expression, just return a constant expression with
10325fb52caaSdrh ** a value of false.
103391bb0eedSdrh */
1034d5c851c1Sdrh Expr *sqlite3ExprAnd(Parse *pParse, Expr *pLeft, Expr *pRight){
1035d5c851c1Sdrh   sqlite3 *db = pParse->db;
103691bb0eedSdrh   if( pLeft==0  ){
103791bb0eedSdrh     return pRight;
103891bb0eedSdrh   }else if( pRight==0 ){
103991bb0eedSdrh     return pLeft;
10402b6e670fSdan   }else if( (ExprAlwaysFalse(pLeft) || ExprAlwaysFalse(pRight))
10412b6e670fSdan          && !IN_RENAME_OBJECT
10422b6e670fSdan   ){
1043b3ad4e61Sdrh     sqlite3ExprDeferredDelete(pParse, pLeft);
1044b3ad4e61Sdrh     sqlite3ExprDeferredDelete(pParse, pRight);
10455776ee5cSdrh     return sqlite3Expr(db, TK_INTEGER, "0");
104691bb0eedSdrh   }else{
1047d5c851c1Sdrh     return sqlite3PExpr(pParse, TK_AND, pLeft, pRight);
1048a76b5dfcSdrh   }
1049a76b5dfcSdrh }
1050a76b5dfcSdrh 
1051a76b5dfcSdrh /*
1052a76b5dfcSdrh ** Construct a new expression node for a function with multiple
1053a76b5dfcSdrh ** arguments.
1054a76b5dfcSdrh */
1055954733b3Sdrh Expr *sqlite3ExprFunction(
1056954733b3Sdrh   Parse *pParse,        /* Parsing context */
1057954733b3Sdrh   ExprList *pList,      /* Argument list */
1058b6dad520Sdrh   const Token *pToken,  /* Name of the function */
1059954733b3Sdrh   int eDistinct         /* SF_Distinct or SF_ALL or 0 */
1060954733b3Sdrh ){
1061a76b5dfcSdrh   Expr *pNew;
1062633e6d57Sdrh   sqlite3 *db = pParse->db;
10634b202ae2Sdanielk1977   assert( pToken );
1064b7916a78Sdrh   pNew = sqlite3ExprAlloc(db, TK_FUNCTION, pToken, 1);
1065a76b5dfcSdrh   if( pNew==0 ){
1066d9da78a2Sdrh     sqlite3ExprListDelete(db, pList); /* Avoid memory leak when malloc fails */
1067a76b5dfcSdrh     return 0;
1068a76b5dfcSdrh   }
106914a1b1c1Sdrh   if( pList
107014a1b1c1Sdrh    && pList->nExpr > pParse->db->aLimit[SQLITE_LIMIT_FUNCTION_ARG]
107114a1b1c1Sdrh    && !pParse->nested
107214a1b1c1Sdrh   ){
1073954733b3Sdrh     sqlite3ErrorMsg(pParse, "too many arguments on function %T", pToken);
1074954733b3Sdrh   }
10756ab3a2ecSdanielk1977   pNew->x.pList = pList;
1076fca23557Sdrh   ExprSetProperty(pNew, EP_HasFunc);
1077*a4eeccdfSdrh   assert( ExprUseXList(pNew) );
10782308ed38Sdrh   sqlite3ExprSetHeightAndFlags(pParse, pNew);
1079954733b3Sdrh   if( eDistinct==SF_Distinct ) ExprSetProperty(pNew, EP_Distinct);
1080a76b5dfcSdrh   return pNew;
1081a76b5dfcSdrh }
1082a76b5dfcSdrh 
1083a76b5dfcSdrh /*
10840dfa5255Sdrh ** Check to see if a function is usable according to current access
10850dfa5255Sdrh ** rules:
10860dfa5255Sdrh **
10870dfa5255Sdrh **    SQLITE_FUNC_DIRECT    -     Only usable from top-level SQL
10880dfa5255Sdrh **
10890dfa5255Sdrh **    SQLITE_FUNC_UNSAFE    -     Usable if TRUSTED_SCHEMA or from
10900dfa5255Sdrh **                                top-level SQL
10910dfa5255Sdrh **
10920dfa5255Sdrh ** If the function is not usable, create an error.
10930dfa5255Sdrh */
10940dfa5255Sdrh void sqlite3ExprFunctionUsable(
10950dfa5255Sdrh   Parse *pParse,         /* Parsing and code generating context */
1096b6dad520Sdrh   const Expr *pExpr,     /* The function invocation */
1097b6dad520Sdrh   const FuncDef *pDef    /* The function being invoked */
10980dfa5255Sdrh ){
10990dfa5255Sdrh   assert( !IN_RENAME_OBJECT );
11002eeca204Sdrh   assert( (pDef->funcFlags & (SQLITE_FUNC_DIRECT|SQLITE_FUNC_UNSAFE))!=0 );
11012eeca204Sdrh   if( ExprHasProperty(pExpr, EP_FromDDL) ){
11020dfa5255Sdrh     if( (pDef->funcFlags & SQLITE_FUNC_DIRECT)!=0
11030dfa5255Sdrh      || (pParse->db->flags & SQLITE_TrustedSchema)==0
11040dfa5255Sdrh     ){
11050dfa5255Sdrh       /* Functions prohibited in triggers and views if:
11060dfa5255Sdrh       **     (1) tagged with SQLITE_DIRECTONLY
11070dfa5255Sdrh       **     (2) not tagged with SQLITE_INNOCUOUS (which means it
11080dfa5255Sdrh       **         is tagged with SQLITE_FUNC_UNSAFE) and
11090dfa5255Sdrh       **         SQLITE_DBCONFIG_TRUSTED_SCHEMA is off (meaning
11100dfa5255Sdrh       **         that the schema is possibly tainted).
11110dfa5255Sdrh       */
11120dfa5255Sdrh       sqlite3ErrorMsg(pParse, "unsafe use of %s()", pDef->zName);
11130dfa5255Sdrh     }
11140dfa5255Sdrh   }
11150dfa5255Sdrh }
11160dfa5255Sdrh 
11170dfa5255Sdrh /*
1118fa6bc000Sdrh ** Assign a variable number to an expression that encodes a wildcard
1119fa6bc000Sdrh ** in the original SQL statement.
1120fa6bc000Sdrh **
1121fa6bc000Sdrh ** Wildcards consisting of a single "?" are assigned the next sequential
1122fa6bc000Sdrh ** variable number.
1123fa6bc000Sdrh **
1124fa6bc000Sdrh ** Wildcards of the form "?nnn" are assigned the number "nnn".  We make
11259bf755ccSdrh ** sure "nnn" is not too big to avoid a denial of service attack when
1126fa6bc000Sdrh ** the SQL statement comes from an external source.
1127fa6bc000Sdrh **
112851f49f17Sdrh ** Wildcards of the form ":aaa", "@aaa", or "$aaa" are assigned the same number
1129fa6bc000Sdrh ** as the previous instance of the same wildcard.  Or if this is the first
113060ec914cSpeter.d.reid ** instance of the wildcard, the next sequential variable number is
1131fa6bc000Sdrh ** assigned.
1132fa6bc000Sdrh */
1133de25a88cSdrh void sqlite3ExprAssignVarNumber(Parse *pParse, Expr *pExpr, u32 n){
113417435752Sdrh   sqlite3 *db = pParse->db;
1135b7916a78Sdrh   const char *z;
1136f326d66dSdrh   ynVar x;
113717435752Sdrh 
1138fa6bc000Sdrh   if( pExpr==0 ) return;
1139c5cd1249Sdrh   assert( !ExprHasProperty(pExpr, EP_IntValue|EP_Reduced|EP_TokenOnly) );
114033e619fcSdrh   z = pExpr->u.zToken;
1141b7916a78Sdrh   assert( z!=0 );
1142b7916a78Sdrh   assert( z[0]!=0 );
1143b1ed717fSmistachkin   assert( n==(u32)sqlite3Strlen30(z) );
1144b7916a78Sdrh   if( z[1]==0 ){
1145fa6bc000Sdrh     /* Wildcard of the form "?".  Assign the next variable number */
1146b7916a78Sdrh     assert( z[0]=='?' );
1147f326d66dSdrh     x = (ynVar)(++pParse->nVar);
1148124c0b49Sdrh   }else{
1149f326d66dSdrh     int doAdd = 0;
1150124c0b49Sdrh     if( z[0]=='?' ){
1151fa6bc000Sdrh       /* Wildcard of the form "?nnn".  Convert "nnn" to an integer and
1152fa6bc000Sdrh       ** use it as the variable number */
1153c8d735aeSdan       i64 i;
115418814dfbSdrh       int bOk;
115518814dfbSdrh       if( n==2 ){ /*OPTIMIZATION-IF-TRUE*/
115618814dfbSdrh         i = z[1]-'0';  /* The common case of ?N for a single digit N */
115718814dfbSdrh         bOk = 1;
115818814dfbSdrh       }else{
115918814dfbSdrh         bOk = 0==sqlite3Atoi64(&z[1], &i, n-1, SQLITE_UTF8);
116018814dfbSdrh       }
1161c5499befSdrh       testcase( i==0 );
1162c5499befSdrh       testcase( i==1 );
1163c5499befSdrh       testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]-1 );
1164c5499befSdrh       testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] );
1165c8d735aeSdan       if( bOk==0 || i<1 || i>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
1166fa6bc000Sdrh         sqlite3ErrorMsg(pParse, "variable number must be between ?1 and ?%d",
1167bb4957f8Sdrh             db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]);
1168c9b39288Sdrh         return;
1169fa6bc000Sdrh       }
11708e74e7baSdrh       x = (ynVar)i;
1171f326d66dSdrh       if( x>pParse->nVar ){
1172f326d66dSdrh         pParse->nVar = (int)x;
1173f326d66dSdrh         doAdd = 1;
1174f326d66dSdrh       }else if( sqlite3VListNumToName(pParse->pVList, x)==0 ){
1175f326d66dSdrh         doAdd = 1;
1176fa6bc000Sdrh       }
1177fa6bc000Sdrh     }else{
117851f49f17Sdrh       /* Wildcards like ":aaa", "$aaa" or "@aaa".  Reuse the same variable
1179fa6bc000Sdrh       ** number as the prior appearance of the same name, or if the name
1180fa6bc000Sdrh       ** has never appeared before, reuse the same variable number
1181fa6bc000Sdrh       */
11829bf755ccSdrh       x = (ynVar)sqlite3VListNameToNum(pParse->pVList, z, n);
11839bf755ccSdrh       if( x==0 ){
11849bf755ccSdrh         x = (ynVar)(++pParse->nVar);
1185f326d66dSdrh         doAdd = 1;
1186f326d66dSdrh       }
1187f326d66dSdrh     }
1188f326d66dSdrh     if( doAdd ){
11899bf755ccSdrh       pParse->pVList = sqlite3VListAdd(db, pParse->pVList, z, n, x);
1190fa6bc000Sdrh     }
1191fa6bc000Sdrh   }
1192c9b39288Sdrh   pExpr->iColumn = x;
1193f326d66dSdrh   if( x>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
1194832b2664Sdanielk1977     sqlite3ErrorMsg(pParse, "too many SQL variables");
1195832b2664Sdanielk1977   }
1196fa6bc000Sdrh }
1197fa6bc000Sdrh 
1198fa6bc000Sdrh /*
1199f6963f99Sdan ** Recursively delete an expression tree.
1200a2e00042Sdrh */
12014f0010b1Sdrh static SQLITE_NOINLINE void sqlite3ExprDeleteNN(sqlite3 *db, Expr *p){
12024f0010b1Sdrh   assert( p!=0 );
1203d50ffc41Sdrh   /* Sanity check: Assert that the IntValue is non-negative if it exists */
1204d50ffc41Sdrh   assert( !ExprHasProperty(p, EP_IntValue) || p->u.iValue>=0 );
1205eda079cdSdrh 
1206eda079cdSdrh   assert( !ExprHasProperty(p, EP_WinFunc) || p->y.pWin!=0 || db->mallocFailed );
1207eda079cdSdrh   assert( p->op!=TK_FUNCTION || ExprHasProperty(p, EP_TokenOnly|EP_Reduced)
12084f9adee2Sdan           || p->y.pWin==0 || ExprHasProperty(p, EP_WinFunc) );
1209209bc522Sdrh #ifdef SQLITE_DEBUG
1210209bc522Sdrh   if( ExprHasProperty(p, EP_Leaf) && !ExprHasProperty(p, EP_TokenOnly) ){
1211209bc522Sdrh     assert( p->pLeft==0 );
1212209bc522Sdrh     assert( p->pRight==0 );
1213*a4eeccdfSdrh     assert( !ExprUseXSelect(p) || p->x.pSelect==0 );
1214*a4eeccdfSdrh     assert( !ExprUseXList(p) || p->x.pList==0 );
1215209bc522Sdrh   }
1216209bc522Sdrh #endif
1217209bc522Sdrh   if( !ExprHasProperty(p, (EP_TokenOnly|EP_Leaf)) ){
1218c5cd1249Sdrh     /* The Expr.x union is never used at the same time as Expr.pRight */
1219*a4eeccdfSdrh     assert( (ExprUseXList(p) && p->x.pList==0) || p->pRight==0 );
12204910a76dSdrh     if( p->pLeft && p->op!=TK_SELECT_COLUMN ) sqlite3ExprDeleteNN(db, p->pLeft);
1221d1086679Sdrh     if( p->pRight ){
12224f9adee2Sdan       assert( !ExprHasProperty(p, EP_WinFunc) );
1223d1086679Sdrh       sqlite3ExprDeleteNN(db, p->pRight);
1224*a4eeccdfSdrh     }else if( ExprUseXSelect(p) ){
12254f9adee2Sdan       assert( !ExprHasProperty(p, EP_WinFunc) );
12266ab3a2ecSdanielk1977       sqlite3SelectDelete(db, p->x.pSelect);
12276ab3a2ecSdanielk1977     }else{
12286ab3a2ecSdanielk1977       sqlite3ExprListDelete(db, p->x.pList);
12296ba7ab0dSdan #ifndef SQLITE_OMIT_WINDOWFUNC
1230eda079cdSdrh       if( ExprHasProperty(p, EP_WinFunc) ){
1231eda079cdSdrh         sqlite3WindowDelete(db, p->y.pWin);
123286fb6e17Sdan       }
12336ba7ab0dSdan #endif
12346ab3a2ecSdanielk1977     }
12358117f113Sdan   }
1236f9751074Sdrh   if( ExprHasProperty(p, EP_MemToken) ){
1237f9751074Sdrh     assert( !ExprHasProperty(p, EP_IntValue) );
1238f9751074Sdrh     sqlite3DbFree(db, p->u.zToken);
1239f9751074Sdrh   }
124033e619fcSdrh   if( !ExprHasProperty(p, EP_Static) ){
1241dbd6a7dcSdrh     sqlite3DbFreeNN(db, p);
1242a2e00042Sdrh   }
124333e619fcSdrh }
12444f0010b1Sdrh void sqlite3ExprDelete(sqlite3 *db, Expr *p){
12454f0010b1Sdrh   if( p ) sqlite3ExprDeleteNN(db, p);
12464f0010b1Sdrh }
1247a2e00042Sdrh 
1248b3ad4e61Sdrh 
1249b3ad4e61Sdrh /*
1250b3ad4e61Sdrh ** Arrange to cause pExpr to be deleted when the pParse is deleted.
1251b3ad4e61Sdrh ** This is similar to sqlite3ExprDelete() except that the delete is
1252b3ad4e61Sdrh ** deferred untilthe pParse is deleted.
1253b3ad4e61Sdrh **
1254b3ad4e61Sdrh ** The pExpr might be deleted immediately on an OOM error.
1255b3ad4e61Sdrh **
1256b3ad4e61Sdrh ** The deferred delete is (currently) implemented by adding the
1257b3ad4e61Sdrh ** pExpr to the pParse->pConstExpr list with a register number of 0.
1258b3ad4e61Sdrh */
1259b3ad4e61Sdrh void sqlite3ExprDeferredDelete(Parse *pParse, Expr *pExpr){
1260b3ad4e61Sdrh   pParse->pConstExpr =
1261b3ad4e61Sdrh       sqlite3ExprListAppend(pParse, pParse->pConstExpr, pExpr);
1262b3ad4e61Sdrh }
1263b3ad4e61Sdrh 
12648e34e406Sdrh /* Invoke sqlite3RenameExprUnmap() and sqlite3ExprDelete() on the
12658e34e406Sdrh ** expression.
12668e34e406Sdrh */
12678e34e406Sdrh void sqlite3ExprUnmapAndDelete(Parse *pParse, Expr *p){
12688e34e406Sdrh   if( p ){
12698e34e406Sdrh     if( IN_RENAME_OBJECT ){
12708e34e406Sdrh       sqlite3RenameExprUnmap(pParse, p);
12718e34e406Sdrh     }
12728e34e406Sdrh     sqlite3ExprDeleteNN(pParse->db, p);
12738e34e406Sdrh   }
12748e34e406Sdrh }
12758e34e406Sdrh 
1276d2687b77Sdrh /*
12776ab3a2ecSdanielk1977 ** Return the number of bytes allocated for the expression structure
12786ab3a2ecSdanielk1977 ** passed as the first argument. This is always one of EXPR_FULLSIZE,
12796ab3a2ecSdanielk1977 ** EXPR_REDUCEDSIZE or EXPR_TOKENONLYSIZE.
12806ab3a2ecSdanielk1977 */
1281b6dad520Sdrh static int exprStructSize(const Expr *p){
12826ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_TokenOnly) ) return EXPR_TOKENONLYSIZE;
12836ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_Reduced) ) return EXPR_REDUCEDSIZE;
12846ab3a2ecSdanielk1977   return EXPR_FULLSIZE;
12856ab3a2ecSdanielk1977 }
12866ab3a2ecSdanielk1977 
12876ab3a2ecSdanielk1977 /*
128833e619fcSdrh ** The dupedExpr*Size() routines each return the number of bytes required
128933e619fcSdrh ** to store a copy of an expression or expression tree.  They differ in
129033e619fcSdrh ** how much of the tree is measured.
129133e619fcSdrh **
129233e619fcSdrh **     dupedExprStructSize()     Size of only the Expr structure
129333e619fcSdrh **     dupedExprNodeSize()       Size of Expr + space for token
129433e619fcSdrh **     dupedExprSize()           Expr + token + subtree components
129533e619fcSdrh **
129633e619fcSdrh ***************************************************************************
129733e619fcSdrh **
129833e619fcSdrh ** The dupedExprStructSize() function returns two values OR-ed together:
129933e619fcSdrh ** (1) the space required for a copy of the Expr structure only and
130033e619fcSdrh ** (2) the EP_xxx flags that indicate what the structure size should be.
130133e619fcSdrh ** The return values is always one of:
130233e619fcSdrh **
130333e619fcSdrh **      EXPR_FULLSIZE
130433e619fcSdrh **      EXPR_REDUCEDSIZE   | EP_Reduced
130533e619fcSdrh **      EXPR_TOKENONLYSIZE | EP_TokenOnly
130633e619fcSdrh **
130733e619fcSdrh ** The size of the structure can be found by masking the return value
130833e619fcSdrh ** of this routine with 0xfff.  The flags can be found by masking the
130933e619fcSdrh ** return value with EP_Reduced|EP_TokenOnly.
131033e619fcSdrh **
131133e619fcSdrh ** Note that with flags==EXPRDUP_REDUCE, this routines works on full-size
131233e619fcSdrh ** (unreduced) Expr objects as they or originally constructed by the parser.
131333e619fcSdrh ** During expression analysis, extra information is computed and moved into
1314c95f38d4Sdan ** later parts of the Expr object and that extra information might get chopped
131533e619fcSdrh ** off if the expression is reduced.  Note also that it does not work to
131660ec914cSpeter.d.reid ** make an EXPRDUP_REDUCE copy of a reduced expression.  It is only legal
131733e619fcSdrh ** to reduce a pristine expression tree from the parser.  The implementation
131833e619fcSdrh ** of dupedExprStructSize() contain multiple assert() statements that attempt
131933e619fcSdrh ** to enforce this constraint.
13206ab3a2ecSdanielk1977 */
1321b6dad520Sdrh static int dupedExprStructSize(const Expr *p, int flags){
13226ab3a2ecSdanielk1977   int nSize;
132333e619fcSdrh   assert( flags==EXPRDUP_REDUCE || flags==0 ); /* Only one flag value allowed */
1324aecd8021Sdrh   assert( EXPR_FULLSIZE<=0xfff );
1325aecd8021Sdrh   assert( (0xfff & (EP_Reduced|EP_TokenOnly))==0 );
132667a9b8edSdan   if( 0==flags || p->op==TK_SELECT_COLUMN
132767a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
1328eda079cdSdrh    || ExprHasProperty(p, EP_WinFunc)
132967a9b8edSdan #endif
133067a9b8edSdan   ){
13316ab3a2ecSdanielk1977     nSize = EXPR_FULLSIZE;
13326ab3a2ecSdanielk1977   }else{
1333c5cd1249Sdrh     assert( !ExprHasProperty(p, EP_TokenOnly|EP_Reduced) );
133433e619fcSdrh     assert( !ExprHasProperty(p, EP_FromJoin) );
1335c5cd1249Sdrh     assert( !ExprHasProperty(p, EP_MemToken) );
1336e7375bfaSdrh     assert( !ExprHasVVAProperty(p, EP_NoReduce) );
1337aecd8021Sdrh     if( p->pLeft || p->x.pList ){
133833e619fcSdrh       nSize = EXPR_REDUCEDSIZE | EP_Reduced;
133933e619fcSdrh     }else{
1340aecd8021Sdrh       assert( p->pRight==0 );
134133e619fcSdrh       nSize = EXPR_TOKENONLYSIZE | EP_TokenOnly;
134233e619fcSdrh     }
13436ab3a2ecSdanielk1977   }
13446ab3a2ecSdanielk1977   return nSize;
13456ab3a2ecSdanielk1977 }
13466ab3a2ecSdanielk1977 
13476ab3a2ecSdanielk1977 /*
134833e619fcSdrh ** This function returns the space in bytes required to store the copy
134933e619fcSdrh ** of the Expr structure and a copy of the Expr.u.zToken string (if that
135033e619fcSdrh ** string is defined.)
13516ab3a2ecSdanielk1977 */
1352b6dad520Sdrh static int dupedExprNodeSize(const Expr *p, int flags){
135333e619fcSdrh   int nByte = dupedExprStructSize(p, flags) & 0xfff;
135433e619fcSdrh   if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
13557301e774Sdrh     nByte += sqlite3Strlen30NN(p->u.zToken)+1;
13566ab3a2ecSdanielk1977   }
1357bc73971dSdanielk1977   return ROUND8(nByte);
13586ab3a2ecSdanielk1977 }
13596ab3a2ecSdanielk1977 
13606ab3a2ecSdanielk1977 /*
13616ab3a2ecSdanielk1977 ** Return the number of bytes required to create a duplicate of the
13626ab3a2ecSdanielk1977 ** expression passed as the first argument. The second argument is a
13636ab3a2ecSdanielk1977 ** mask containing EXPRDUP_XXX flags.
13646ab3a2ecSdanielk1977 **
13656ab3a2ecSdanielk1977 ** The value returned includes space to create a copy of the Expr struct
136633e619fcSdrh ** itself and the buffer referred to by Expr.u.zToken, if any.
13676ab3a2ecSdanielk1977 **
13686ab3a2ecSdanielk1977 ** If the EXPRDUP_REDUCE flag is set, then the return value includes
13696ab3a2ecSdanielk1977 ** space to duplicate all Expr nodes in the tree formed by Expr.pLeft
13706ab3a2ecSdanielk1977 ** and Expr.pRight variables (but not for any structures pointed to or
13716ab3a2ecSdanielk1977 ** descended from the Expr.x.pList or Expr.x.pSelect variables).
13726ab3a2ecSdanielk1977 */
1373b6dad520Sdrh static int dupedExprSize(const Expr *p, int flags){
13746ab3a2ecSdanielk1977   int nByte = 0;
13756ab3a2ecSdanielk1977   if( p ){
13766ab3a2ecSdanielk1977     nByte = dupedExprNodeSize(p, flags);
13776ab3a2ecSdanielk1977     if( flags&EXPRDUP_REDUCE ){
1378b7916a78Sdrh       nByte += dupedExprSize(p->pLeft, flags) + dupedExprSize(p->pRight, flags);
13796ab3a2ecSdanielk1977     }
13806ab3a2ecSdanielk1977   }
13816ab3a2ecSdanielk1977   return nByte;
13826ab3a2ecSdanielk1977 }
13836ab3a2ecSdanielk1977 
13846ab3a2ecSdanielk1977 /*
13856ab3a2ecSdanielk1977 ** This function is similar to sqlite3ExprDup(), except that if pzBuffer
13866ab3a2ecSdanielk1977 ** is not NULL then *pzBuffer is assumed to point to a buffer large enough
138733e619fcSdrh ** to store the copy of expression p, the copies of p->u.zToken
13886ab3a2ecSdanielk1977 ** (if applicable), and the copies of the p->pLeft and p->pRight expressions,
138960ec914cSpeter.d.reid ** if any. Before returning, *pzBuffer is set to the first byte past the
13906ab3a2ecSdanielk1977 ** portion of the buffer copied into by this function.
13916ab3a2ecSdanielk1977 */
1392b6dad520Sdrh static Expr *exprDup(sqlite3 *db, const Expr *p, int dupFlags, u8 **pzBuffer){
13933c19469cSdrh   Expr *pNew;           /* Value to return */
13943c19469cSdrh   u8 *zAlloc;           /* Memory space from which to build Expr object */
13953c19469cSdrh   u32 staticFlag;       /* EP_Static if space not obtained from malloc */
13966ab3a2ecSdanielk1977 
13973c19469cSdrh   assert( db!=0 );
13983c19469cSdrh   assert( p );
13993c19469cSdrh   assert( dupFlags==0 || dupFlags==EXPRDUP_REDUCE );
14003c19469cSdrh   assert( pzBuffer==0 || dupFlags==EXPRDUP_REDUCE );
14016ab3a2ecSdanielk1977 
14026ab3a2ecSdanielk1977   /* Figure out where to write the new Expr structure. */
14036ab3a2ecSdanielk1977   if( pzBuffer ){
14046ab3a2ecSdanielk1977     zAlloc = *pzBuffer;
140533e619fcSdrh     staticFlag = EP_Static;
14063c6edc8aSdrh     assert( zAlloc!=0 );
14076ab3a2ecSdanielk1977   }else{
14083c19469cSdrh     zAlloc = sqlite3DbMallocRawNN(db, dupedExprSize(p, dupFlags));
14093c19469cSdrh     staticFlag = 0;
14106ab3a2ecSdanielk1977   }
14116ab3a2ecSdanielk1977   pNew = (Expr *)zAlloc;
14126ab3a2ecSdanielk1977 
14136ab3a2ecSdanielk1977   if( pNew ){
14146ab3a2ecSdanielk1977     /* Set nNewSize to the size allocated for the structure pointed to
14156ab3a2ecSdanielk1977     ** by pNew. This is either EXPR_FULLSIZE, EXPR_REDUCEDSIZE or
14166ab3a2ecSdanielk1977     ** EXPR_TOKENONLYSIZE. nToken is set to the number of bytes consumed
141733e619fcSdrh     ** by the copy of the p->u.zToken string (if any).
14186ab3a2ecSdanielk1977     */
14193c19469cSdrh     const unsigned nStructSize = dupedExprStructSize(p, dupFlags);
142033e619fcSdrh     const int nNewSize = nStructSize & 0xfff;
142133e619fcSdrh     int nToken;
142233e619fcSdrh     if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
142333e619fcSdrh       nToken = sqlite3Strlen30(p->u.zToken) + 1;
142433e619fcSdrh     }else{
142533e619fcSdrh       nToken = 0;
142633e619fcSdrh     }
14273c19469cSdrh     if( dupFlags ){
14286ab3a2ecSdanielk1977       assert( ExprHasProperty(p, EP_Reduced)==0 );
14296ab3a2ecSdanielk1977       memcpy(zAlloc, p, nNewSize);
14306ab3a2ecSdanielk1977     }else{
14313e6a1411Sdan       u32 nSize = (u32)exprStructSize(p);
14326ab3a2ecSdanielk1977       memcpy(zAlloc, p, nSize);
143372ea29d7Sdrh       if( nSize<EXPR_FULLSIZE ){
14346ab3a2ecSdanielk1977         memset(&zAlloc[nSize], 0, EXPR_FULLSIZE-nSize);
14356ab3a2ecSdanielk1977       }
143672ea29d7Sdrh     }
14376ab3a2ecSdanielk1977 
143833e619fcSdrh     /* Set the EP_Reduced, EP_TokenOnly, and EP_Static flags appropriately. */
1439c5cd1249Sdrh     pNew->flags &= ~(EP_Reduced|EP_TokenOnly|EP_Static|EP_MemToken);
144033e619fcSdrh     pNew->flags |= nStructSize & (EP_Reduced|EP_TokenOnly);
144133e619fcSdrh     pNew->flags |= staticFlag;
1442e7375bfaSdrh     ExprClearVVAProperties(pNew);
1443e7375bfaSdrh     if( dupFlags ){
1444e7375bfaSdrh       ExprSetVVAProperty(pNew, EP_Immutable);
1445e7375bfaSdrh     }
14466ab3a2ecSdanielk1977 
144733e619fcSdrh     /* Copy the p->u.zToken string, if any. */
14486ab3a2ecSdanielk1977     if( nToken ){
144933e619fcSdrh       char *zToken = pNew->u.zToken = (char*)&zAlloc[nNewSize];
145033e619fcSdrh       memcpy(zToken, p->u.zToken, nToken);
14516ab3a2ecSdanielk1977     }
14526ab3a2ecSdanielk1977 
1453209bc522Sdrh     if( 0==((p->flags|pNew->flags) & (EP_TokenOnly|EP_Leaf)) ){
14546ab3a2ecSdanielk1977       /* Fill in the pNew->x.pSelect or pNew->x.pList member. */
1455*a4eeccdfSdrh       if( ExprUseXSelect(p) ){
14563c19469cSdrh         pNew->x.pSelect = sqlite3SelectDup(db, p->x.pSelect, dupFlags);
14576ab3a2ecSdanielk1977       }else{
14583c19469cSdrh         pNew->x.pList = sqlite3ExprListDup(db, p->x.pList, dupFlags);
14596ab3a2ecSdanielk1977       }
14606ab3a2ecSdanielk1977     }
14616ab3a2ecSdanielk1977 
14626ab3a2ecSdanielk1977     /* Fill in pNew->pLeft and pNew->pRight. */
14634f9adee2Sdan     if( ExprHasProperty(pNew, EP_Reduced|EP_TokenOnly|EP_WinFunc) ){
14643c19469cSdrh       zAlloc += dupedExprNodeSize(p, dupFlags);
1465209bc522Sdrh       if( !ExprHasProperty(pNew, EP_TokenOnly|EP_Leaf) ){
14663c19469cSdrh         pNew->pLeft = p->pLeft ?
14673c19469cSdrh                       exprDup(db, p->pLeft, EXPRDUP_REDUCE, &zAlloc) : 0;
14683c19469cSdrh         pNew->pRight = p->pRight ?
14693c19469cSdrh                        exprDup(db, p->pRight, EXPRDUP_REDUCE, &zAlloc) : 0;
14706ab3a2ecSdanielk1977       }
147167a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
1472eda079cdSdrh       if( ExprHasProperty(p, EP_WinFunc) ){
1473eda079cdSdrh         pNew->y.pWin = sqlite3WindowDup(db, pNew, p->y.pWin);
1474eda079cdSdrh         assert( ExprHasProperty(pNew, EP_WinFunc) );
1475e2f781b9Sdan       }
147667a9b8edSdan #endif /* SQLITE_OMIT_WINDOWFUNC */
147753988068Sdrh       if( pzBuffer ){
147853988068Sdrh         *pzBuffer = zAlloc;
147953988068Sdrh       }
148053988068Sdrh     }else{
1481209bc522Sdrh       if( !ExprHasProperty(p, EP_TokenOnly|EP_Leaf) ){
14829854260bSdrh         if( pNew->op==TK_SELECT_COLUMN ){
14839854260bSdrh           pNew->pLeft = p->pLeft;
14845cc9daf8Sdrh           assert( p->pRight==0  || p->pRight==p->pLeft
14855cc9daf8Sdrh                                 || ExprHasProperty(p->pLeft, EP_Subquery) );
14869854260bSdrh         }else{
14876ab3a2ecSdanielk1977           pNew->pLeft = sqlite3ExprDup(db, p->pLeft, 0);
14889854260bSdrh         }
14896ab3a2ecSdanielk1977         pNew->pRight = sqlite3ExprDup(db, p->pRight, 0);
14906ab3a2ecSdanielk1977       }
14916ab3a2ecSdanielk1977     }
14926ab3a2ecSdanielk1977   }
14936ab3a2ecSdanielk1977   return pNew;
14946ab3a2ecSdanielk1977 }
14956ab3a2ecSdanielk1977 
14966ab3a2ecSdanielk1977 /*
1497bfe31e7fSdan ** Create and return a deep copy of the object passed as the second
1498bfe31e7fSdan ** argument. If an OOM condition is encountered, NULL is returned
1499bfe31e7fSdan ** and the db->mallocFailed flag set.
1500bfe31e7fSdan */
1501eede6a53Sdan #ifndef SQLITE_OMIT_CTE
150226d61e5aSdan With *sqlite3WithDup(sqlite3 *db, With *p){
15034e9119d9Sdan   With *pRet = 0;
15044e9119d9Sdan   if( p ){
1505d4de9f7bSdrh     sqlite3_int64 nByte = sizeof(*p) + sizeof(p->a[0]) * (p->nCte-1);
15064e9119d9Sdan     pRet = sqlite3DbMallocZero(db, nByte);
15074e9119d9Sdan     if( pRet ){
15084e9119d9Sdan       int i;
15094e9119d9Sdan       pRet->nCte = p->nCte;
15104e9119d9Sdan       for(i=0; i<p->nCte; i++){
15114e9119d9Sdan         pRet->a[i].pSelect = sqlite3SelectDup(db, p->a[i].pSelect, 0);
15124e9119d9Sdan         pRet->a[i].pCols = sqlite3ExprListDup(db, p->a[i].pCols, 0);
15134e9119d9Sdan         pRet->a[i].zName = sqlite3DbStrDup(db, p->a[i].zName);
15144e9119d9Sdan       }
15154e9119d9Sdan     }
15164e9119d9Sdan   }
15174e9119d9Sdan   return pRet;
15184e9119d9Sdan }
1519eede6a53Sdan #else
152026d61e5aSdan # define sqlite3WithDup(x,y) 0
1521eede6a53Sdan #endif
15224e9119d9Sdan 
1523a8389975Sdrh #ifndef SQLITE_OMIT_WINDOWFUNC
1524a8389975Sdrh /*
1525a8389975Sdrh ** The gatherSelectWindows() procedure and its helper routine
1526a8389975Sdrh ** gatherSelectWindowsCallback() are used to scan all the expressions
1527a8389975Sdrh ** an a newly duplicated SELECT statement and gather all of the Window
1528a8389975Sdrh ** objects found there, assembling them onto the linked list at Select->pWin.
1529a8389975Sdrh */
1530a8389975Sdrh static int gatherSelectWindowsCallback(Walker *pWalker, Expr *pExpr){
15316ba7ab0dSdan   if( pExpr->op==TK_FUNCTION && ExprHasProperty(pExpr, EP_WinFunc) ){
153275b0821eSdan     Select *pSelect = pWalker->u.pSelect;
153375b0821eSdan     Window *pWin = pExpr->y.pWin;
153475b0821eSdan     assert( pWin );
15354f9adee2Sdan     assert( IsWindowFunc(pExpr) );
1536e0ae3f69Sdan     assert( pWin->ppThis==0 );
1537a3fcc000Sdan     sqlite3WindowLink(pSelect, pWin);
1538a8389975Sdrh   }
1539a8389975Sdrh   return WRC_Continue;
1540a8389975Sdrh }
1541a37b6a5eSdrh static int gatherSelectWindowsSelectCallback(Walker *pWalker, Select *p){
1542a37b6a5eSdrh   return p==pWalker->u.pSelect ? WRC_Continue : WRC_Prune;
1543a37b6a5eSdrh }
1544a8389975Sdrh static void gatherSelectWindows(Select *p){
1545a8389975Sdrh   Walker w;
1546a8389975Sdrh   w.xExprCallback = gatherSelectWindowsCallback;
1547a37b6a5eSdrh   w.xSelectCallback = gatherSelectWindowsSelectCallback;
1548a37b6a5eSdrh   w.xSelectCallback2 = 0;
15499c46c66cSdrh   w.pParse = 0;
1550a8389975Sdrh   w.u.pSelect = p;
1551a37b6a5eSdrh   sqlite3WalkSelect(&w, p);
1552a8389975Sdrh }
1553a8389975Sdrh #endif
1554a8389975Sdrh 
1555a8389975Sdrh 
1556a76b5dfcSdrh /*
1557ff78bd2fSdrh ** The following group of routines make deep copies of expressions,
1558ff78bd2fSdrh ** expression lists, ID lists, and select statements.  The copies can
1559ff78bd2fSdrh ** be deleted (by being passed to their respective ...Delete() routines)
1560ff78bd2fSdrh ** without effecting the originals.
1561ff78bd2fSdrh **
15624adee20fSdanielk1977 ** The expression list, ID, and source lists return by sqlite3ExprListDup(),
15634adee20fSdanielk1977 ** sqlite3IdListDup(), and sqlite3SrcListDup() can not be further expanded
1564ad3cab52Sdrh ** by subsequent calls to sqlite*ListAppend() routines.
1565ff78bd2fSdrh **
1566ad3cab52Sdrh ** Any tables that the SrcList might point to are not duplicated.
15676ab3a2ecSdanielk1977 **
1568b7916a78Sdrh ** The flags parameter contains a combination of the EXPRDUP_XXX flags.
15696ab3a2ecSdanielk1977 ** If the EXPRDUP_REDUCE flag is set, then the structure returned is a
15706ab3a2ecSdanielk1977 ** truncated version of the usual Expr structure that will be stored as
15716ab3a2ecSdanielk1977 ** part of the in-memory representation of the database schema.
1572ff78bd2fSdrh */
1573b6dad520Sdrh Expr *sqlite3ExprDup(sqlite3 *db, const Expr *p, int flags){
157472ea29d7Sdrh   assert( flags==0 || flags==EXPRDUP_REDUCE );
15753c19469cSdrh   return p ? exprDup(db, p, flags, 0) : 0;
1576ff78bd2fSdrh }
1577b6dad520Sdrh ExprList *sqlite3ExprListDup(sqlite3 *db, const ExprList *p, int flags){
1578ff78bd2fSdrh   ExprList *pNew;
1579b6dad520Sdrh   struct ExprList_item *pItem;
1580b6dad520Sdrh   const struct ExprList_item *pOldItem;
1581ff78bd2fSdrh   int i;
1582e46292a9Sdrh   Expr *pPriorSelectColOld = 0;
1583e46292a9Sdrh   Expr *pPriorSelectColNew = 0;
1584575fad65Sdrh   assert( db!=0 );
1585ff78bd2fSdrh   if( p==0 ) return 0;
158697258194Sdrh   pNew = sqlite3DbMallocRawNN(db, sqlite3DbMallocSize(db, p));
1587ff78bd2fSdrh   if( pNew==0 ) return 0;
1588a19543feSdrh   pNew->nExpr = p->nExpr;
158950e43c50Sdrh   pNew->nAlloc = p->nAlloc;
159043606175Sdrh   pItem = pNew->a;
1591145716b3Sdrh   pOldItem = p->a;
1592145716b3Sdrh   for(i=0; i<p->nExpr; i++, pItem++, pOldItem++){
15936ab3a2ecSdanielk1977     Expr *pOldExpr = pOldItem->pExpr;
159447073f62Sdrh     Expr *pNewExpr;
1595b5526ea6Sdrh     pItem->pExpr = sqlite3ExprDup(db, pOldExpr, flags);
159647073f62Sdrh     if( pOldExpr
159747073f62Sdrh      && pOldExpr->op==TK_SELECT_COLUMN
159847073f62Sdrh      && (pNewExpr = pItem->pExpr)!=0
159947073f62Sdrh     ){
1600e46292a9Sdrh       if( pNewExpr->pRight ){
1601e46292a9Sdrh         pPriorSelectColOld = pOldExpr->pRight;
1602e46292a9Sdrh         pPriorSelectColNew = pNewExpr->pRight;
1603e46292a9Sdrh         pNewExpr->pLeft = pNewExpr->pRight;
1604b163748eSdrh       }else{
1605e46292a9Sdrh         if( pOldExpr->pLeft!=pPriorSelectColOld ){
1606e46292a9Sdrh           pPriorSelectColOld = pOldExpr->pLeft;
1607e46292a9Sdrh           pPriorSelectColNew = sqlite3ExprDup(db, pPriorSelectColOld, flags);
1608e46292a9Sdrh           pNewExpr->pRight = pPriorSelectColNew;
1609e46292a9Sdrh         }
1610e46292a9Sdrh         pNewExpr->pLeft = pPriorSelectColNew;
161147073f62Sdrh       }
161247073f62Sdrh     }
161341cee668Sdrh     pItem->zEName = sqlite3DbStrDup(db, pOldItem->zEName);
16146e11892dSdan     pItem->sortFlags = pOldItem->sortFlags;
1615cbb9da33Sdrh     pItem->eEName = pOldItem->eEName;
16163e7bc9caSdrh     pItem->done = 0;
1617ae8e45cbSdan     pItem->bNulls = pOldItem->bNulls;
161824e25d32Sdan     pItem->bSorterRef = pOldItem->bSorterRef;
1619c2acc4e4Sdrh     pItem->u = pOldItem->u;
1620ff78bd2fSdrh   }
1621ff78bd2fSdrh   return pNew;
1622ff78bd2fSdrh }
162393758c8dSdanielk1977 
162493758c8dSdanielk1977 /*
162593758c8dSdanielk1977 ** If cursors, triggers, views and subqueries are all omitted from
162693758c8dSdanielk1977 ** the build, then none of the following routines, except for
162793758c8dSdanielk1977 ** sqlite3SelectDup(), can be called. sqlite3SelectDup() is sometimes
162893758c8dSdanielk1977 ** called with a NULL argument.
162993758c8dSdanielk1977 */
16306a67fe8eSdanielk1977 #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_TRIGGER) \
16316a67fe8eSdanielk1977  || !defined(SQLITE_OMIT_SUBQUERY)
1632b6dad520Sdrh SrcList *sqlite3SrcListDup(sqlite3 *db, const SrcList *p, int flags){
1633ad3cab52Sdrh   SrcList *pNew;
1634ad3cab52Sdrh   int i;
1635113088ecSdrh   int nByte;
1636575fad65Sdrh   assert( db!=0 );
1637ad3cab52Sdrh   if( p==0 ) return 0;
1638113088ecSdrh   nByte = sizeof(*p) + (p->nSrc>0 ? sizeof(p->a[0]) * (p->nSrc-1) : 0);
1639575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, nByte );
1640ad3cab52Sdrh   if( pNew==0 ) return 0;
16414305d103Sdrh   pNew->nSrc = pNew->nAlloc = p->nSrc;
1642ad3cab52Sdrh   for(i=0; i<p->nSrc; i++){
16437601294aSdrh     SrcItem *pNewItem = &pNew->a[i];
1644b6dad520Sdrh     const SrcItem *pOldItem = &p->a[i];
1645ed8a3bb1Sdrh     Table *pTab;
164641fb5cd1Sdan     pNewItem->pSchema = pOldItem->pSchema;
164717435752Sdrh     pNewItem->zDatabase = sqlite3DbStrDup(db, pOldItem->zDatabase);
164817435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
164917435752Sdrh     pNewItem->zAlias = sqlite3DbStrDup(db, pOldItem->zAlias);
16508a48b9c0Sdrh     pNewItem->fg = pOldItem->fg;
16514efc4754Sdrh     pNewItem->iCursor = pOldItem->iCursor;
16525b6a9ed4Sdrh     pNewItem->addrFillSub = pOldItem->addrFillSub;
16535b6a9ed4Sdrh     pNewItem->regReturn = pOldItem->regReturn;
16548a48b9c0Sdrh     if( pNewItem->fg.isIndexedBy ){
16558a48b9c0Sdrh       pNewItem->u1.zIndexedBy = sqlite3DbStrDup(db, pOldItem->u1.zIndexedBy);
16568a48b9c0Sdrh     }
1657a79e2a2dSdrh     pNewItem->u2 = pOldItem->u2;
1658a79e2a2dSdrh     if( pNewItem->fg.isCte ){
1659a79e2a2dSdrh       pNewItem->u2.pCteUse->nUse++;
1660a79e2a2dSdrh     }
16618a48b9c0Sdrh     if( pNewItem->fg.isTabFunc ){
16628a48b9c0Sdrh       pNewItem->u1.pFuncArg =
16638a48b9c0Sdrh           sqlite3ExprListDup(db, pOldItem->u1.pFuncArg, flags);
16648a48b9c0Sdrh     }
1665ed8a3bb1Sdrh     pTab = pNewItem->pTab = pOldItem->pTab;
1666ed8a3bb1Sdrh     if( pTab ){
166779df7782Sdrh       pTab->nTabRef++;
1668a1cb183dSdanielk1977     }
16696ab3a2ecSdanielk1977     pNewItem->pSelect = sqlite3SelectDup(db, pOldItem->pSelect, flags);
16706ab3a2ecSdanielk1977     pNewItem->pOn = sqlite3ExprDup(db, pOldItem->pOn, flags);
167117435752Sdrh     pNewItem->pUsing = sqlite3IdListDup(db, pOldItem->pUsing);
16726c18b6e0Sdanielk1977     pNewItem->colUsed = pOldItem->colUsed;
1673ad3cab52Sdrh   }
1674ad3cab52Sdrh   return pNew;
1675ad3cab52Sdrh }
1676b6dad520Sdrh IdList *sqlite3IdListDup(sqlite3 *db, const IdList *p){
1677ff78bd2fSdrh   IdList *pNew;
1678ff78bd2fSdrh   int i;
1679575fad65Sdrh   assert( db!=0 );
1680ff78bd2fSdrh   if( p==0 ) return 0;
1681575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, sizeof(*pNew) );
1682ff78bd2fSdrh   if( pNew==0 ) return 0;
16836c535158Sdrh   pNew->nId = p->nId;
1684575fad65Sdrh   pNew->a = sqlite3DbMallocRawNN(db, p->nId*sizeof(p->a[0]) );
1685d5d56523Sdanielk1977   if( pNew->a==0 ){
1686dbd6a7dcSdrh     sqlite3DbFreeNN(db, pNew);
1687d5d56523Sdanielk1977     return 0;
1688d5d56523Sdanielk1977   }
16896c535158Sdrh   /* Note that because the size of the allocation for p->a[] is not
16906c535158Sdrh   ** necessarily a power of two, sqlite3IdListAppend() may not be called
16916c535158Sdrh   ** on the duplicate created by this function. */
1692ff78bd2fSdrh   for(i=0; i<p->nId; i++){
16934efc4754Sdrh     struct IdList_item *pNewItem = &pNew->a[i];
16944efc4754Sdrh     struct IdList_item *pOldItem = &p->a[i];
169517435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
16964efc4754Sdrh     pNewItem->idx = pOldItem->idx;
1697ff78bd2fSdrh   }
1698ff78bd2fSdrh   return pNew;
1699ff78bd2fSdrh }
1700b6dad520Sdrh Select *sqlite3SelectDup(sqlite3 *db, const Select *pDup, int flags){
1701a7466205Sdan   Select *pRet = 0;
1702a7466205Sdan   Select *pNext = 0;
1703a7466205Sdan   Select **pp = &pRet;
1704b6dad520Sdrh   const Select *p;
1705a7466205Sdan 
1706575fad65Sdrh   assert( db!=0 );
1707a7466205Sdan   for(p=pDup; p; p=p->pPrior){
1708a7466205Sdan     Select *pNew = sqlite3DbMallocRawNN(db, sizeof(*p) );
1709a7466205Sdan     if( pNew==0 ) break;
1710b7916a78Sdrh     pNew->pEList = sqlite3ExprListDup(db, p->pEList, flags);
17116ab3a2ecSdanielk1977     pNew->pSrc = sqlite3SrcListDup(db, p->pSrc, flags);
17126ab3a2ecSdanielk1977     pNew->pWhere = sqlite3ExprDup(db, p->pWhere, flags);
17136ab3a2ecSdanielk1977     pNew->pGroupBy = sqlite3ExprListDup(db, p->pGroupBy, flags);
17146ab3a2ecSdanielk1977     pNew->pHaving = sqlite3ExprDup(db, p->pHaving, flags);
17156ab3a2ecSdanielk1977     pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, flags);
1716ff78bd2fSdrh     pNew->op = p->op;
1717a7466205Sdan     pNew->pNext = pNext;
1718a7466205Sdan     pNew->pPrior = 0;
17196ab3a2ecSdanielk1977     pNew->pLimit = sqlite3ExprDup(db, p->pLimit, flags);
172092b01d53Sdrh     pNew->iLimit = 0;
172192b01d53Sdrh     pNew->iOffset = 0;
17227d10d5a6Sdrh     pNew->selFlags = p->selFlags & ~SF_UsesEphemeral;
1723b9bb7c18Sdrh     pNew->addrOpenEphm[0] = -1;
1724b9bb7c18Sdrh     pNew->addrOpenEphm[1] = -1;
1725ec2da854Sdrh     pNew->nSelectRow = p->nSelectRow;
172626d61e5aSdan     pNew->pWith = sqlite3WithDup(db, p->pWith);
172767a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
17282e362f97Sdan     pNew->pWin = 0;
1729c95f38d4Sdan     pNew->pWinDefn = sqlite3WindowListDup(db, p->pWinDefn);
17304780b9adSdan     if( p->pWin && db->mallocFailed==0 ) gatherSelectWindows(pNew);
173167a9b8edSdan #endif
1732fef37760Sdrh     pNew->selId = p->selId;
17339da977f1Sdrh     if( db->mallocFailed ){
17349da977f1Sdrh       /* Any prior OOM might have left the Select object incomplete.
17359da977f1Sdrh       ** Delete the whole thing rather than allow an incomplete Select
17369da977f1Sdrh       ** to be used by the code generator. */
17379da977f1Sdrh       pNew->pNext = 0;
17389da977f1Sdrh       sqlite3SelectDelete(db, pNew);
17399da977f1Sdrh       break;
17409da977f1Sdrh     }
1741a7466205Sdan     *pp = pNew;
1742a7466205Sdan     pp = &pNew->pPrior;
1743a7466205Sdan     pNext = pNew;
1744a7466205Sdan   }
1745a7466205Sdan 
1746a7466205Sdan   return pRet;
1747ff78bd2fSdrh }
174893758c8dSdanielk1977 #else
17496ab3a2ecSdanielk1977 Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
175093758c8dSdanielk1977   assert( p==0 );
175193758c8dSdanielk1977   return 0;
175293758c8dSdanielk1977 }
175393758c8dSdanielk1977 #endif
1754ff78bd2fSdrh 
1755ff78bd2fSdrh 
1756ff78bd2fSdrh /*
1757a76b5dfcSdrh ** Add a new element to the end of an expression list.  If pList is
1758a76b5dfcSdrh ** initially NULL, then create a new expression list.
1759b7916a78Sdrh **
1760a19543feSdrh ** The pList argument must be either NULL or a pointer to an ExprList
1761a19543feSdrh ** obtained from a prior call to sqlite3ExprListAppend().  This routine
1762a19543feSdrh ** may not be used with an ExprList obtained from sqlite3ExprListDup().
1763a19543feSdrh ** Reason:  This routine assumes that the number of slots in pList->a[]
1764a19543feSdrh ** is a power of two.  That is true for sqlite3ExprListAppend() returns
1765a19543feSdrh ** but is not necessarily true from the return value of sqlite3ExprListDup().
1766a19543feSdrh **
1767b7916a78Sdrh ** If a memory allocation error occurs, the entire list is freed and
1768b7916a78Sdrh ** NULL is returned.  If non-NULL is returned, then it is guaranteed
1769b7916a78Sdrh ** that the new entry was successfully appended.
1770a76b5dfcSdrh */
1771dabada60Slarrybr static const struct ExprList_item zeroItem = {0};
177250e43c50Sdrh SQLITE_NOINLINE ExprList *sqlite3ExprListAppendNew(
177350e43c50Sdrh   sqlite3 *db,            /* Database handle.  Used for memory allocation */
177450e43c50Sdrh   Expr *pExpr             /* Expression to be appended. Might be NULL */
177550e43c50Sdrh ){
177650e43c50Sdrh   struct ExprList_item *pItem;
177750e43c50Sdrh   ExprList *pList;
177850e43c50Sdrh 
177950e43c50Sdrh   pList = sqlite3DbMallocRawNN(db, sizeof(ExprList)+sizeof(pList->a[0])*4 );
178050e43c50Sdrh   if( pList==0 ){
178150e43c50Sdrh     sqlite3ExprDelete(db, pExpr);
178250e43c50Sdrh     return 0;
178350e43c50Sdrh   }
178450e43c50Sdrh   pList->nAlloc = 4;
178550e43c50Sdrh   pList->nExpr = 1;
178650e43c50Sdrh   pItem = &pList->a[0];
178750e43c50Sdrh   *pItem = zeroItem;
178850e43c50Sdrh   pItem->pExpr = pExpr;
178950e43c50Sdrh   return pList;
179050e43c50Sdrh }
179150e43c50Sdrh SQLITE_NOINLINE ExprList *sqlite3ExprListAppendGrow(
179250e43c50Sdrh   sqlite3 *db,            /* Database handle.  Used for memory allocation */
179350e43c50Sdrh   ExprList *pList,        /* List to which to append. Might be NULL */
179450e43c50Sdrh   Expr *pExpr             /* Expression to be appended. Might be NULL */
179550e43c50Sdrh ){
179650e43c50Sdrh   struct ExprList_item *pItem;
179750e43c50Sdrh   ExprList *pNew;
179850e43c50Sdrh   pList->nAlloc *= 2;
179950e43c50Sdrh   pNew = sqlite3DbRealloc(db, pList,
180050e43c50Sdrh        sizeof(*pList)+(pList->nAlloc-1)*sizeof(pList->a[0]));
180150e43c50Sdrh   if( pNew==0 ){
180250e43c50Sdrh     sqlite3ExprListDelete(db, pList);
180350e43c50Sdrh     sqlite3ExprDelete(db, pExpr);
180450e43c50Sdrh     return 0;
180550e43c50Sdrh   }else{
180650e43c50Sdrh     pList = pNew;
180750e43c50Sdrh   }
180850e43c50Sdrh   pItem = &pList->a[pList->nExpr++];
180950e43c50Sdrh   *pItem = zeroItem;
181050e43c50Sdrh   pItem->pExpr = pExpr;
181150e43c50Sdrh   return pList;
181250e43c50Sdrh }
181317435752Sdrh ExprList *sqlite3ExprListAppend(
181417435752Sdrh   Parse *pParse,          /* Parsing context */
181517435752Sdrh   ExprList *pList,        /* List to which to append. Might be NULL */
1816b7916a78Sdrh   Expr *pExpr             /* Expression to be appended. Might be NULL */
181717435752Sdrh ){
181843606175Sdrh   struct ExprList_item *pItem;
1819a76b5dfcSdrh   if( pList==0 ){
182050e43c50Sdrh     return sqlite3ExprListAppendNew(pParse->db,pExpr);
1821a76b5dfcSdrh   }
182250e43c50Sdrh   if( pList->nAlloc<pList->nExpr+1 ){
182350e43c50Sdrh     return sqlite3ExprListAppendGrow(pParse->db,pList,pExpr);
1824a76b5dfcSdrh   }
182543606175Sdrh   pItem = &pList->a[pList->nExpr++];
182650e43c50Sdrh   *pItem = zeroItem;
1827e94ddc9eSdanielk1977   pItem->pExpr = pExpr;
1828a76b5dfcSdrh   return pList;
1829a76b5dfcSdrh }
1830a76b5dfcSdrh 
1831a76b5dfcSdrh /*
18328762ec19Sdrh ** pColumns and pExpr form a vector assignment which is part of the SET
18338762ec19Sdrh ** clause of an UPDATE statement.  Like this:
1834a1251bc4Sdrh **
1835a1251bc4Sdrh **        (a,b,c) = (expr1,expr2,expr3)
1836a1251bc4Sdrh ** Or:    (a,b,c) = (SELECT x,y,z FROM ....)
1837a1251bc4Sdrh **
1838a1251bc4Sdrh ** For each term of the vector assignment, append new entries to the
1839b67343d0Sdrh ** expression list pList.  In the case of a subquery on the RHS, append
1840a1251bc4Sdrh ** TK_SELECT_COLUMN expressions.
1841a1251bc4Sdrh */
1842a1251bc4Sdrh ExprList *sqlite3ExprListAppendVector(
1843a1251bc4Sdrh   Parse *pParse,         /* Parsing context */
1844a1251bc4Sdrh   ExprList *pList,       /* List to which to append. Might be NULL */
1845a1251bc4Sdrh   IdList *pColumns,      /* List of names of LHS of the assignment */
1846a1251bc4Sdrh   Expr *pExpr            /* Vector expression to be appended. Might be NULL */
1847a1251bc4Sdrh ){
1848a1251bc4Sdrh   sqlite3 *db = pParse->db;
1849a1251bc4Sdrh   int n;
1850a1251bc4Sdrh   int i;
185166860af3Sdrh   int iFirst = pList ? pList->nExpr : 0;
1852321e828dSdrh   /* pColumns can only be NULL due to an OOM but an OOM will cause an
1853321e828dSdrh   ** exit prior to this routine being invoked */
1854321e828dSdrh   if( NEVER(pColumns==0) ) goto vector_append_error;
1855a1251bc4Sdrh   if( pExpr==0 ) goto vector_append_error;
1856966e2911Sdrh 
1857966e2911Sdrh   /* If the RHS is a vector, then we can immediately check to see that
1858966e2911Sdrh   ** the size of the RHS and LHS match.  But if the RHS is a SELECT,
1859966e2911Sdrh   ** wildcards ("*") in the result set of the SELECT must be expanded before
1860966e2911Sdrh   ** we can do the size check, so defer the size check until code generation.
1861966e2911Sdrh   */
1862966e2911Sdrh   if( pExpr->op!=TK_SELECT && pColumns->nId!=(n=sqlite3ExprVectorSize(pExpr)) ){
1863a1251bc4Sdrh     sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
1864a1251bc4Sdrh                     pColumns->nId, n);
1865a1251bc4Sdrh     goto vector_append_error;
1866a1251bc4Sdrh   }
1867966e2911Sdrh 
1868966e2911Sdrh   for(i=0; i<pColumns->nId; i++){
186910f08270Sdrh     Expr *pSubExpr = sqlite3ExprForVectorField(pParse, pExpr, i, pColumns->nId);
1870554a9dc7Sdrh     assert( pSubExpr!=0 || db->mallocFailed );
1871554a9dc7Sdrh     if( pSubExpr==0 ) continue;
1872a1251bc4Sdrh     pList = sqlite3ExprListAppend(pParse, pList, pSubExpr);
1873a1251bc4Sdrh     if( pList ){
187466860af3Sdrh       assert( pList->nExpr==iFirst+i+1 );
187541cee668Sdrh       pList->a[pList->nExpr-1].zEName = pColumns->a[i].zName;
1876a1251bc4Sdrh       pColumns->a[i].zName = 0;
1877a1251bc4Sdrh     }
1878a1251bc4Sdrh   }
1879966e2911Sdrh 
1880ffe28059Sdrh   if( !db->mallocFailed && pExpr->op==TK_SELECT && ALWAYS(pList!=0) ){
1881966e2911Sdrh     Expr *pFirst = pList->a[iFirst].pExpr;
1882f4dd26c5Sdrh     assert( pFirst!=0 );
1883966e2911Sdrh     assert( pFirst->op==TK_SELECT_COLUMN );
1884966e2911Sdrh 
1885966e2911Sdrh     /* Store the SELECT statement in pRight so it will be deleted when
1886966e2911Sdrh     ** sqlite3ExprListDelete() is called */
1887966e2911Sdrh     pFirst->pRight = pExpr;
1888a1251bc4Sdrh     pExpr = 0;
1889966e2911Sdrh 
1890966e2911Sdrh     /* Remember the size of the LHS in iTable so that we can check that
1891966e2911Sdrh     ** the RHS and LHS sizes match during code generation. */
1892966e2911Sdrh     pFirst->iTable = pColumns->nId;
1893a1251bc4Sdrh   }
1894a1251bc4Sdrh 
1895a1251bc4Sdrh vector_append_error:
18968e34e406Sdrh   sqlite3ExprUnmapAndDelete(pParse, pExpr);
1897a1251bc4Sdrh   sqlite3IdListDelete(db, pColumns);
1898a1251bc4Sdrh   return pList;
1899a1251bc4Sdrh }
1900a1251bc4Sdrh 
1901a1251bc4Sdrh /*
1902bc622bc0Sdrh ** Set the sort order for the last element on the given ExprList.
1903bc622bc0Sdrh */
19046e11892dSdan void sqlite3ExprListSetSortOrder(ExprList *p, int iSortOrder, int eNulls){
19059105fd51Sdan   struct ExprList_item *pItem;
1906bc622bc0Sdrh   if( p==0 ) return;
1907bc622bc0Sdrh   assert( p->nExpr>0 );
19086e11892dSdan 
19096e11892dSdan   assert( SQLITE_SO_UNDEFINED<0 && SQLITE_SO_ASC==0 && SQLITE_SO_DESC>0 );
19106e11892dSdan   assert( iSortOrder==SQLITE_SO_UNDEFINED
19116e11892dSdan        || iSortOrder==SQLITE_SO_ASC
19126e11892dSdan        || iSortOrder==SQLITE_SO_DESC
19136e11892dSdan   );
19146e11892dSdan   assert( eNulls==SQLITE_SO_UNDEFINED
19156e11892dSdan        || eNulls==SQLITE_SO_ASC
19166e11892dSdan        || eNulls==SQLITE_SO_DESC
19176e11892dSdan   );
19186e11892dSdan 
19199105fd51Sdan   pItem = &p->a[p->nExpr-1];
19209105fd51Sdan   assert( pItem->bNulls==0 );
19219105fd51Sdan   if( iSortOrder==SQLITE_SO_UNDEFINED ){
19229105fd51Sdan     iSortOrder = SQLITE_SO_ASC;
1923bc622bc0Sdrh   }
19249105fd51Sdan   pItem->sortFlags = (u8)iSortOrder;
19259105fd51Sdan 
19269105fd51Sdan   if( eNulls!=SQLITE_SO_UNDEFINED ){
19279105fd51Sdan     pItem->bNulls = 1;
19289105fd51Sdan     if( iSortOrder!=eNulls ){
19299105fd51Sdan       pItem->sortFlags |= KEYINFO_ORDER_BIGNULL;
19309105fd51Sdan     }
1931bc622bc0Sdrh   }
1932bc622bc0Sdrh }
1933bc622bc0Sdrh 
1934bc622bc0Sdrh /*
193541cee668Sdrh ** Set the ExprList.a[].zEName element of the most recently added item
1936b7916a78Sdrh ** on the expression list.
1937b7916a78Sdrh **
1938b7916a78Sdrh ** pList might be NULL following an OOM error.  But pName should never be
1939b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1940b7916a78Sdrh ** is set.
1941b7916a78Sdrh */
1942b7916a78Sdrh void sqlite3ExprListSetName(
1943b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1944b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
1945b6dad520Sdrh   const Token *pName,     /* Name to be added */
1946b7916a78Sdrh   int dequote             /* True to cause the name to be dequoted */
1947b7916a78Sdrh ){
1948b7916a78Sdrh   assert( pList!=0 || pParse->db->mallocFailed!=0 );
19492d99f957Sdrh   assert( pParse->eParseMode!=PARSE_MODE_UNMAP || dequote==0 );
1950b7916a78Sdrh   if( pList ){
1951b7916a78Sdrh     struct ExprList_item *pItem;
1952b7916a78Sdrh     assert( pList->nExpr>0 );
1953b7916a78Sdrh     pItem = &pList->a[pList->nExpr-1];
195441cee668Sdrh     assert( pItem->zEName==0 );
1955c4938ea2Sdrh     assert( pItem->eEName==ENAME_NAME );
195641cee668Sdrh     pItem->zEName = sqlite3DbStrNDup(pParse->db, pName->z, pName->n);
195785f2c76cSdan     if( dequote ){
195885f2c76cSdan       /* If dequote==0, then pName->z does not point to part of a DDL
195985f2c76cSdan       ** statement handled by the parser. And so no token need be added
196085f2c76cSdan       ** to the token-map.  */
196185f2c76cSdan       sqlite3Dequote(pItem->zEName);
1962c9461eccSdan       if( IN_RENAME_OBJECT ){
1963b6dad520Sdrh         sqlite3RenameTokenMap(pParse, (const void*)pItem->zEName, pName);
19645be60c55Sdan       }
1965b7916a78Sdrh     }
1966b7916a78Sdrh   }
196785f2c76cSdan }
1968b7916a78Sdrh 
1969b7916a78Sdrh /*
1970b7916a78Sdrh ** Set the ExprList.a[].zSpan element of the most recently added item
1971b7916a78Sdrh ** on the expression list.
1972b7916a78Sdrh **
1973b7916a78Sdrh ** pList might be NULL following an OOM error.  But pSpan should never be
1974b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1975b7916a78Sdrh ** is set.
1976b7916a78Sdrh */
1977b7916a78Sdrh void sqlite3ExprListSetSpan(
1978b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1979b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
19801be266baSdrh   const char *zStart,     /* Start of the span */
19811be266baSdrh   const char *zEnd        /* End of the span */
1982b7916a78Sdrh ){
1983b7916a78Sdrh   sqlite3 *db = pParse->db;
1984b7916a78Sdrh   assert( pList!=0 || db->mallocFailed!=0 );
1985b7916a78Sdrh   if( pList ){
1986b7916a78Sdrh     struct ExprList_item *pItem = &pList->a[pList->nExpr-1];
1987b7916a78Sdrh     assert( pList->nExpr>0 );
1988cbb9da33Sdrh     if( pItem->zEName==0 ){
1989cbb9da33Sdrh       pItem->zEName = sqlite3DbSpanDup(db, zStart, zEnd);
1990cbb9da33Sdrh       pItem->eEName = ENAME_SPAN;
1991cbb9da33Sdrh     }
1992b7916a78Sdrh   }
1993b7916a78Sdrh }
1994b7916a78Sdrh 
1995b7916a78Sdrh /*
19967a15a4beSdanielk1977 ** If the expression list pEList contains more than iLimit elements,
19977a15a4beSdanielk1977 ** leave an error message in pParse.
19987a15a4beSdanielk1977 */
19997a15a4beSdanielk1977 void sqlite3ExprListCheckLength(
20007a15a4beSdanielk1977   Parse *pParse,
20017a15a4beSdanielk1977   ExprList *pEList,
20027a15a4beSdanielk1977   const char *zObject
20037a15a4beSdanielk1977 ){
2004b1a6c3c1Sdrh   int mx = pParse->db->aLimit[SQLITE_LIMIT_COLUMN];
2005c5499befSdrh   testcase( pEList && pEList->nExpr==mx );
2006c5499befSdrh   testcase( pEList && pEList->nExpr==mx+1 );
2007b1a6c3c1Sdrh   if( pEList && pEList->nExpr>mx ){
20087a15a4beSdanielk1977     sqlite3ErrorMsg(pParse, "too many columns in %s", zObject);
20097a15a4beSdanielk1977   }
20107a15a4beSdanielk1977 }
20117a15a4beSdanielk1977 
20127a15a4beSdanielk1977 /*
2013a76b5dfcSdrh ** Delete an entire expression list.
2014a76b5dfcSdrh */
2015affa855cSdrh static SQLITE_NOINLINE void exprListDeleteNN(sqlite3 *db, ExprList *pList){
2016ac48b751Sdrh   int i = pList->nExpr;
2017ac48b751Sdrh   struct ExprList_item *pItem =  pList->a;
2018ac48b751Sdrh   assert( pList->nExpr>0 );
2019ac48b751Sdrh   do{
2020633e6d57Sdrh     sqlite3ExprDelete(db, pItem->pExpr);
202141cee668Sdrh     sqlite3DbFree(db, pItem->zEName);
2022ac48b751Sdrh     pItem++;
2023ac48b751Sdrh   }while( --i>0 );
2024dbd6a7dcSdrh   sqlite3DbFreeNN(db, pList);
2025a76b5dfcSdrh }
2026affa855cSdrh void sqlite3ExprListDelete(sqlite3 *db, ExprList *pList){
2027affa855cSdrh   if( pList ) exprListDeleteNN(db, pList);
2028affa855cSdrh }
2029a76b5dfcSdrh 
2030a76b5dfcSdrh /*
20312308ed38Sdrh ** Return the bitwise-OR of all Expr.flags fields in the given
20322308ed38Sdrh ** ExprList.
2033885a5b03Sdrh */
20342308ed38Sdrh u32 sqlite3ExprListFlags(const ExprList *pList){
2035885a5b03Sdrh   int i;
20362308ed38Sdrh   u32 m = 0;
2037508e2d00Sdrh   assert( pList!=0 );
2038885a5b03Sdrh   for(i=0; i<pList->nExpr; i++){
2039d0c73053Sdrh      Expr *pExpr = pList->a[i].pExpr;
2040de845c2fSdrh      assert( pExpr!=0 );
2041de845c2fSdrh      m |= pExpr->flags;
2042885a5b03Sdrh   }
20432308ed38Sdrh   return m;
2044885a5b03Sdrh }
2045885a5b03Sdrh 
2046885a5b03Sdrh /*
20477e6f980bSdrh ** This is a SELECT-node callback for the expression walker that
20487e6f980bSdrh ** always "fails".  By "fail" in this case, we mean set
20497e6f980bSdrh ** pWalker->eCode to zero and abort.
20507e6f980bSdrh **
20517e6f980bSdrh ** This callback is used by multiple expression walkers.
20527e6f980bSdrh */
20537e6f980bSdrh int sqlite3SelectWalkFail(Walker *pWalker, Select *NotUsed){
20547e6f980bSdrh   UNUSED_PARAMETER(NotUsed);
20557e6f980bSdrh   pWalker->eCode = 0;
20567e6f980bSdrh   return WRC_Abort;
20577e6f980bSdrh }
20587e6f980bSdrh 
20597e6f980bSdrh /*
20600cbec59cSdrh ** Check the input string to see if it is "true" or "false" (in any case).
20610cbec59cSdrh **
20620cbec59cSdrh **       If the string is....           Return
20630cbec59cSdrh **         "true"                         EP_IsTrue
20640cbec59cSdrh **         "false"                        EP_IsFalse
20650cbec59cSdrh **         anything else                  0
20660cbec59cSdrh */
20670cbec59cSdrh u32 sqlite3IsTrueOrFalse(const char *zIn){
20680cbec59cSdrh   if( sqlite3StrICmp(zIn, "true")==0  ) return EP_IsTrue;
20690cbec59cSdrh   if( sqlite3StrICmp(zIn, "false")==0 ) return EP_IsFalse;
20700cbec59cSdrh   return 0;
20710cbec59cSdrh }
20720cbec59cSdrh 
20730cbec59cSdrh 
20740cbec59cSdrh /*
2075171d16bbSdrh ** If the input expression is an ID with the name "true" or "false"
207696acafbeSdrh ** then convert it into an TK_TRUEFALSE term.  Return non-zero if
207796acafbeSdrh ** the conversion happened, and zero if the expression is unaltered.
2078171d16bbSdrh */
2079171d16bbSdrh int sqlite3ExprIdToTrueFalse(Expr *pExpr){
20800cbec59cSdrh   u32 v;
2081171d16bbSdrh   assert( pExpr->op==TK_ID || pExpr->op==TK_STRING );
2082f9751074Sdrh   if( !ExprHasProperty(pExpr, EP_Quoted|EP_IntValue)
20830cbec59cSdrh    && (v = sqlite3IsTrueOrFalse(pExpr->u.zToken))!=0
2084171d16bbSdrh   ){
2085171d16bbSdrh     pExpr->op = TK_TRUEFALSE;
20860cbec59cSdrh     ExprSetProperty(pExpr, v);
2087171d16bbSdrh     return 1;
2088171d16bbSdrh   }
2089171d16bbSdrh   return 0;
2090171d16bbSdrh }
2091171d16bbSdrh 
209243c4ac8bSdrh /*
209396acafbeSdrh ** The argument must be a TK_TRUEFALSE Expr node.  Return 1 if it is TRUE
209443c4ac8bSdrh ** and 0 if it is FALSE.
209543c4ac8bSdrh */
209696acafbeSdrh int sqlite3ExprTruthValue(const Expr *pExpr){
20976ece353fSdan   pExpr = sqlite3ExprSkipCollate((Expr*)pExpr);
209843c4ac8bSdrh   assert( pExpr->op==TK_TRUEFALSE );
2099f9751074Sdrh   assert( !ExprHasProperty(pExpr, EP_IntValue) );
210043c4ac8bSdrh   assert( sqlite3StrICmp(pExpr->u.zToken,"true")==0
210143c4ac8bSdrh        || sqlite3StrICmp(pExpr->u.zToken,"false")==0 );
210243c4ac8bSdrh   return pExpr->u.zToken[4]==0;
210343c4ac8bSdrh }
210443c4ac8bSdrh 
210517180fcaSdrh /*
210617180fcaSdrh ** If pExpr is an AND or OR expression, try to simplify it by eliminating
210717180fcaSdrh ** terms that are always true or false.  Return the simplified expression.
210817180fcaSdrh ** Or return the original expression if no simplification is possible.
210917180fcaSdrh **
211017180fcaSdrh ** Examples:
211117180fcaSdrh **
211217180fcaSdrh **     (x<10) AND true                =>   (x<10)
211317180fcaSdrh **     (x<10) AND false               =>   false
211417180fcaSdrh **     (x<10) AND (y=22 OR false)     =>   (x<10) AND (y=22)
211517180fcaSdrh **     (x<10) AND (y=22 OR true)      =>   (x<10)
211617180fcaSdrh **     (y=22) OR true                 =>   true
211717180fcaSdrh */
211817180fcaSdrh Expr *sqlite3ExprSimplifiedAndOr(Expr *pExpr){
211917180fcaSdrh   assert( pExpr!=0 );
212017180fcaSdrh   if( pExpr->op==TK_AND || pExpr->op==TK_OR ){
212117180fcaSdrh     Expr *pRight = sqlite3ExprSimplifiedAndOr(pExpr->pRight);
212217180fcaSdrh     Expr *pLeft = sqlite3ExprSimplifiedAndOr(pExpr->pLeft);
212317180fcaSdrh     if( ExprAlwaysTrue(pLeft) || ExprAlwaysFalse(pRight) ){
212417180fcaSdrh       pExpr = pExpr->op==TK_AND ? pRight : pLeft;
212517180fcaSdrh     }else if( ExprAlwaysTrue(pRight) || ExprAlwaysFalse(pLeft) ){
212617180fcaSdrh       pExpr = pExpr->op==TK_AND ? pLeft : pRight;
212717180fcaSdrh     }
212817180fcaSdrh   }
212917180fcaSdrh   return pExpr;
213017180fcaSdrh }
213117180fcaSdrh 
2132171d16bbSdrh 
2133171d16bbSdrh /*
2134059b2d50Sdrh ** These routines are Walker callbacks used to check expressions to
2135059b2d50Sdrh ** see if they are "constant" for some definition of constant.  The
2136059b2d50Sdrh ** Walker.eCode value determines the type of "constant" we are looking
2137059b2d50Sdrh ** for.
213873b211abSdrh **
21397d10d5a6Sdrh ** These callback routines are used to implement the following:
2140626a879aSdrh **
2141059b2d50Sdrh **     sqlite3ExprIsConstant()                  pWalker->eCode==1
2142059b2d50Sdrh **     sqlite3ExprIsConstantNotJoin()           pWalker->eCode==2
2143fcb9f4f3Sdrh **     sqlite3ExprIsTableConstant()             pWalker->eCode==3
2144059b2d50Sdrh **     sqlite3ExprIsConstantOrFunction()        pWalker->eCode==4 or 5
214587abf5c0Sdrh **
2146059b2d50Sdrh ** In all cases, the callbacks set Walker.eCode=0 and abort if the expression
2147059b2d50Sdrh ** is found to not be a constant.
214887abf5c0Sdrh **
2149014fff20Sdrh ** The sqlite3ExprIsConstantOrFunction() is used for evaluating DEFAULT
2150014fff20Sdrh ** expressions in a CREATE TABLE statement.  The Walker.eCode value is 5
21511e32bed3Sdrh ** when parsing an existing schema out of the sqlite_schema table and 4
2152014fff20Sdrh ** when processing a new CREATE TABLE statement.  A bound parameter raises
2153014fff20Sdrh ** an error for new statements, but is silently converted
21541e32bed3Sdrh ** to NULL for existing schemas.  This allows sqlite_schema tables that
2155feada2dfSdrh ** contain a bound parameter because they were generated by older versions
2156feada2dfSdrh ** of SQLite to be parsed by newer versions of SQLite without raising a
2157feada2dfSdrh ** malformed schema error.
2158626a879aSdrh */
21597d10d5a6Sdrh static int exprNodeIsConstant(Walker *pWalker, Expr *pExpr){
2160626a879aSdrh 
2161059b2d50Sdrh   /* If pWalker->eCode is 2 then any term of the expression that comes from
2162059b2d50Sdrh   ** the ON or USING clauses of a left join disqualifies the expression
21630a168377Sdrh   ** from being considered constant. */
2164059b2d50Sdrh   if( pWalker->eCode==2 && ExprHasProperty(pExpr, EP_FromJoin) ){
2165059b2d50Sdrh     pWalker->eCode = 0;
21667d10d5a6Sdrh     return WRC_Abort;
21670a168377Sdrh   }
21680a168377Sdrh 
2169626a879aSdrh   switch( pExpr->op ){
2170eb55bd2fSdrh     /* Consider functions to be constant if all their arguments are constant
2171059b2d50Sdrh     ** and either pWalker->eCode==4 or 5 or the function has the
2172059b2d50Sdrh     ** SQLITE_FUNC_CONST flag. */
2173eb55bd2fSdrh     case TK_FUNCTION:
2174a634c9e6Sdrh       if( (pWalker->eCode>=4 || ExprHasProperty(pExpr,EP_ConstFunc))
2175a634c9e6Sdrh        && !ExprHasProperty(pExpr, EP_WinFunc)
2176a634c9e6Sdrh       ){
2177014fff20Sdrh         if( pWalker->eCode==5 ) ExprSetProperty(pExpr, EP_FromDDL);
2178b1fba286Sdrh         return WRC_Continue;
2179059b2d50Sdrh       }else{
2180059b2d50Sdrh         pWalker->eCode = 0;
2181059b2d50Sdrh         return WRC_Abort;
2182b1fba286Sdrh       }
2183626a879aSdrh     case TK_ID:
2184171d16bbSdrh       /* Convert "true" or "false" in a DEFAULT clause into the
2185171d16bbSdrh       ** appropriate TK_TRUEFALSE operator */
2186e39ef31cSdrh       if( sqlite3ExprIdToTrueFalse(pExpr) ){
2187171d16bbSdrh         return WRC_Prune;
2188171d16bbSdrh       }
218908b92086Sdrh       /* no break */ deliberate_fall_through
2190626a879aSdrh     case TK_COLUMN:
2191626a879aSdrh     case TK_AGG_FUNCTION:
219213449892Sdrh     case TK_AGG_COLUMN:
2193c5499befSdrh       testcase( pExpr->op==TK_ID );
2194c5499befSdrh       testcase( pExpr->op==TK_COLUMN );
2195c5499befSdrh       testcase( pExpr->op==TK_AGG_FUNCTION );
2196c5499befSdrh       testcase( pExpr->op==TK_AGG_COLUMN );
219707aded63Sdrh       if( ExprHasProperty(pExpr, EP_FixedCol) && pWalker->eCode!=2 ){
2198efad2e23Sdrh         return WRC_Continue;
2199efad2e23Sdrh       }
2200059b2d50Sdrh       if( pWalker->eCode==3 && pExpr->iTable==pWalker->u.iCur ){
2201059b2d50Sdrh         return WRC_Continue;
2202f43ce0b4Sdrh       }
220308b92086Sdrh       /* no break */ deliberate_fall_through
2204f43ce0b4Sdrh     case TK_IF_NULL_ROW:
22056e341b93Sdrh     case TK_REGISTER:
220674e0d966Sdrh     case TK_DOT:
22079916048bSdrh       testcase( pExpr->op==TK_REGISTER );
2208f43ce0b4Sdrh       testcase( pExpr->op==TK_IF_NULL_ROW );
220974e0d966Sdrh       testcase( pExpr->op==TK_DOT );
2210059b2d50Sdrh       pWalker->eCode = 0;
22117d10d5a6Sdrh       return WRC_Abort;
2212feada2dfSdrh     case TK_VARIABLE:
2213059b2d50Sdrh       if( pWalker->eCode==5 ){
2214feada2dfSdrh         /* Silently convert bound parameters that appear inside of CREATE
2215feada2dfSdrh         ** statements into a NULL when parsing the CREATE statement text out
22161e32bed3Sdrh         ** of the sqlite_schema table */
2217feada2dfSdrh         pExpr->op = TK_NULL;
2218059b2d50Sdrh       }else if( pWalker->eCode==4 ){
2219feada2dfSdrh         /* A bound parameter in a CREATE statement that originates from
2220feada2dfSdrh         ** sqlite3_prepare() causes an error */
2221059b2d50Sdrh         pWalker->eCode = 0;
2222feada2dfSdrh         return WRC_Abort;
2223feada2dfSdrh       }
222408b92086Sdrh       /* no break */ deliberate_fall_through
2225626a879aSdrh     default:
22266e341b93Sdrh       testcase( pExpr->op==TK_SELECT ); /* sqlite3SelectWalkFail() disallows */
22276e341b93Sdrh       testcase( pExpr->op==TK_EXISTS ); /* sqlite3SelectWalkFail() disallows */
22287d10d5a6Sdrh       return WRC_Continue;
2229626a879aSdrh   }
2230626a879aSdrh }
2231059b2d50Sdrh static int exprIsConst(Expr *p, int initFlag, int iCur){
22327d10d5a6Sdrh   Walker w;
2233059b2d50Sdrh   w.eCode = initFlag;
22347d10d5a6Sdrh   w.xExprCallback = exprNodeIsConstant;
22357e6f980bSdrh   w.xSelectCallback = sqlite3SelectWalkFail;
2236979dd1beSdrh #ifdef SQLITE_DEBUG
2237979dd1beSdrh   w.xSelectCallback2 = sqlite3SelectWalkAssert2;
2238979dd1beSdrh #endif
2239059b2d50Sdrh   w.u.iCur = iCur;
22407d10d5a6Sdrh   sqlite3WalkExpr(&w, p);
2241059b2d50Sdrh   return w.eCode;
22427d10d5a6Sdrh }
2243626a879aSdrh 
2244626a879aSdrh /*
2245059b2d50Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
2246eb55bd2fSdrh ** and 0 if it involves variables or function calls.
22472398937bSdrh **
22482398937bSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
22492398937bSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
22502398937bSdrh ** a constant.
2251fef5208cSdrh */
22524adee20fSdanielk1977 int sqlite3ExprIsConstant(Expr *p){
2253059b2d50Sdrh   return exprIsConst(p, 1, 0);
2254fef5208cSdrh }
2255fef5208cSdrh 
2256fef5208cSdrh /*
225707aded63Sdrh ** Walk an expression tree.  Return non-zero if
225807aded63Sdrh **
225907aded63Sdrh **   (1) the expression is constant, and
226007aded63Sdrh **   (2) the expression does originate in the ON or USING clause
226107aded63Sdrh **       of a LEFT JOIN, and
226207aded63Sdrh **   (3) the expression does not contain any EP_FixedCol TK_COLUMN
226307aded63Sdrh **       operands created by the constant propagation optimization.
226407aded63Sdrh **
226507aded63Sdrh ** When this routine returns true, it indicates that the expression
226607aded63Sdrh ** can be added to the pParse->pConstExpr list and evaluated once when
22679b258c54Sdrh ** the prepared statement starts up.  See sqlite3ExprCodeRunJustOnce().
22680a168377Sdrh */
22690a168377Sdrh int sqlite3ExprIsConstantNotJoin(Expr *p){
2270059b2d50Sdrh   return exprIsConst(p, 2, 0);
22710a168377Sdrh }
22720a168377Sdrh 
22730a168377Sdrh /*
2274fcb9f4f3Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
2275059b2d50Sdrh ** for any single row of the table with cursor iCur.  In other words, the
2276059b2d50Sdrh ** expression must not refer to any non-deterministic function nor any
2277059b2d50Sdrh ** table other than iCur.
2278059b2d50Sdrh */
2279059b2d50Sdrh int sqlite3ExprIsTableConstant(Expr *p, int iCur){
2280059b2d50Sdrh   return exprIsConst(p, 3, iCur);
2281059b2d50Sdrh }
2282059b2d50Sdrh 
2283ab31a845Sdan 
2284ab31a845Sdan /*
2285ab31a845Sdan ** sqlite3WalkExpr() callback used by sqlite3ExprIsConstantOrGroupBy().
2286ab31a845Sdan */
2287ab31a845Sdan static int exprNodeIsConstantOrGroupBy(Walker *pWalker, Expr *pExpr){
2288ab31a845Sdan   ExprList *pGroupBy = pWalker->u.pGroupBy;
2289ab31a845Sdan   int i;
2290ab31a845Sdan 
2291ab31a845Sdan   /* Check if pExpr is identical to any GROUP BY term. If so, consider
2292ab31a845Sdan   ** it constant.  */
2293ab31a845Sdan   for(i=0; i<pGroupBy->nExpr; i++){
2294ab31a845Sdan     Expr *p = pGroupBy->a[i].pExpr;
22955aa550cfSdan     if( sqlite3ExprCompare(0, pExpr, p, -1)<2 ){
229670efa84dSdrh       CollSeq *pColl = sqlite3ExprNNCollSeq(pWalker->pParse, p);
2297efad2e23Sdrh       if( sqlite3IsBinary(pColl) ){
2298ab31a845Sdan         return WRC_Prune;
2299ab31a845Sdan       }
2300ab31a845Sdan     }
2301ab31a845Sdan   }
2302ab31a845Sdan 
2303ab31a845Sdan   /* Check if pExpr is a sub-select. If so, consider it variable. */
2304*a4eeccdfSdrh   if( ExprUseXSelect(pExpr) ){
2305ab31a845Sdan     pWalker->eCode = 0;
2306ab31a845Sdan     return WRC_Abort;
2307ab31a845Sdan   }
2308ab31a845Sdan 
2309ab31a845Sdan   return exprNodeIsConstant(pWalker, pExpr);
2310ab31a845Sdan }
2311ab31a845Sdan 
2312ab31a845Sdan /*
2313ab31a845Sdan ** Walk the expression tree passed as the first argument. Return non-zero
2314ab31a845Sdan ** if the expression consists entirely of constants or copies of terms
2315ab31a845Sdan ** in pGroupBy that sort with the BINARY collation sequence.
2316ab314001Sdrh **
2317ab314001Sdrh ** This routine is used to determine if a term of the HAVING clause can
2318ab314001Sdrh ** be promoted into the WHERE clause.  In order for such a promotion to work,
2319ab314001Sdrh ** the value of the HAVING clause term must be the same for all members of
2320ab314001Sdrh ** a "group".  The requirement that the GROUP BY term must be BINARY
2321ab314001Sdrh ** assumes that no other collating sequence will have a finer-grained
2322ab314001Sdrh ** grouping than binary.  In other words (A=B COLLATE binary) implies
2323ab314001Sdrh ** A=B in every other collating sequence.  The requirement that the
2324ab314001Sdrh ** GROUP BY be BINARY is stricter than necessary.  It would also work
2325ab314001Sdrh ** to promote HAVING clauses that use the same alternative collating
2326ab314001Sdrh ** sequence as the GROUP BY term, but that is much harder to check,
2327ab314001Sdrh ** alternative collating sequences are uncommon, and this is only an
2328ab314001Sdrh ** optimization, so we take the easy way out and simply require the
2329ab314001Sdrh ** GROUP BY to use the BINARY collating sequence.
2330ab31a845Sdan */
2331ab31a845Sdan int sqlite3ExprIsConstantOrGroupBy(Parse *pParse, Expr *p, ExprList *pGroupBy){
2332ab31a845Sdan   Walker w;
2333ab31a845Sdan   w.eCode = 1;
2334ab31a845Sdan   w.xExprCallback = exprNodeIsConstantOrGroupBy;
2335979dd1beSdrh   w.xSelectCallback = 0;
2336ab31a845Sdan   w.u.pGroupBy = pGroupBy;
2337ab31a845Sdan   w.pParse = pParse;
2338ab31a845Sdan   sqlite3WalkExpr(&w, p);
2339ab31a845Sdan   return w.eCode;
2340ab31a845Sdan }
2341ab31a845Sdan 
2342059b2d50Sdrh /*
2343014fff20Sdrh ** Walk an expression tree for the DEFAULT field of a column definition
2344014fff20Sdrh ** in a CREATE TABLE statement.  Return non-zero if the expression is
2345014fff20Sdrh ** acceptable for use as a DEFAULT.  That is to say, return non-zero if
2346014fff20Sdrh ** the expression is constant or a function call with constant arguments.
2347014fff20Sdrh ** Return and 0 if there are any variables.
2348014fff20Sdrh **
23491e32bed3Sdrh ** isInit is true when parsing from sqlite_schema.  isInit is false when
2350014fff20Sdrh ** processing a new CREATE TABLE statement.  When isInit is true, parameters
2351014fff20Sdrh ** (such as ? or $abc) in the expression are converted into NULL.  When
2352014fff20Sdrh ** isInit is false, parameters raise an error.  Parameters should not be
2353014fff20Sdrh ** allowed in a CREATE TABLE statement, but some legacy versions of SQLite
23541e32bed3Sdrh ** allowed it, so we need to support it when reading sqlite_schema for
2355014fff20Sdrh ** backwards compatibility.
2356014fff20Sdrh **
2357014fff20Sdrh ** If isInit is true, set EP_FromDDL on every TK_FUNCTION node.
2358eb55bd2fSdrh **
2359eb55bd2fSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
2360eb55bd2fSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
2361eb55bd2fSdrh ** a constant.
2362eb55bd2fSdrh */
2363feada2dfSdrh int sqlite3ExprIsConstantOrFunction(Expr *p, u8 isInit){
2364feada2dfSdrh   assert( isInit==0 || isInit==1 );
2365059b2d50Sdrh   return exprIsConst(p, 4+isInit, 0);
2366eb55bd2fSdrh }
2367eb55bd2fSdrh 
23685b88bc4bSdrh #ifdef SQLITE_ENABLE_CURSOR_HINTS
23695b88bc4bSdrh /*
23705b88bc4bSdrh ** Walk an expression tree.  Return 1 if the expression contains a
23715b88bc4bSdrh ** subquery of some kind.  Return 0 if there are no subqueries.
23725b88bc4bSdrh */
23735b88bc4bSdrh int sqlite3ExprContainsSubquery(Expr *p){
23745b88bc4bSdrh   Walker w;
2375bec2476aSdrh   w.eCode = 1;
23765b88bc4bSdrh   w.xExprCallback = sqlite3ExprWalkNoop;
23777e6f980bSdrh   w.xSelectCallback = sqlite3SelectWalkFail;
2378979dd1beSdrh #ifdef SQLITE_DEBUG
2379979dd1beSdrh   w.xSelectCallback2 = sqlite3SelectWalkAssert2;
2380979dd1beSdrh #endif
23815b88bc4bSdrh   sqlite3WalkExpr(&w, p);
238207194bffSdrh   return w.eCode==0;
23835b88bc4bSdrh }
23845b88bc4bSdrh #endif
23855b88bc4bSdrh 
2386eb55bd2fSdrh /*
238773b211abSdrh ** If the expression p codes a constant integer that is small enough
2388202b2df7Sdrh ** to fit in a 32-bit integer, return 1 and put the value of the integer
2389202b2df7Sdrh ** in *pValue.  If the expression is not an integer or if it is too big
2390202b2df7Sdrh ** to fit in a signed 32-bit integer, return 0 and leave *pValue unchanged.
2391e4de1febSdrh */
2392b6dad520Sdrh int sqlite3ExprIsInteger(const Expr *p, int *pValue){
239392b01d53Sdrh   int rc = 0;
23941d2d71a0Sdrh   if( NEVER(p==0) ) return 0;  /* Used to only happen following on OOM */
2395cd92e84dSdrh 
2396cd92e84dSdrh   /* If an expression is an integer literal that fits in a signed 32-bit
2397cd92e84dSdrh   ** integer, then the EP_IntValue flag will have already been set */
2398cd92e84dSdrh   assert( p->op!=TK_INTEGER || (p->flags & EP_IntValue)!=0
2399cd92e84dSdrh            || sqlite3GetInt32(p->u.zToken, &rc)==0 );
2400cd92e84dSdrh 
240192b01d53Sdrh   if( p->flags & EP_IntValue ){
240233e619fcSdrh     *pValue = p->u.iValue;
2403e4de1febSdrh     return 1;
2404e4de1febSdrh   }
240592b01d53Sdrh   switch( p->op ){
24064b59ab5eSdrh     case TK_UPLUS: {
240792b01d53Sdrh       rc = sqlite3ExprIsInteger(p->pLeft, pValue);
2408f6e369a1Sdrh       break;
24094b59ab5eSdrh     }
2410e4de1febSdrh     case TK_UMINUS: {
2411c59ffa8cSdrh       int v = 0;
24124adee20fSdanielk1977       if( sqlite3ExprIsInteger(p->pLeft, &v) ){
2413c59ffa8cSdrh         assert( ((unsigned int)v)!=0x80000000 );
2414e4de1febSdrh         *pValue = -v;
241592b01d53Sdrh         rc = 1;
2416e4de1febSdrh       }
2417e4de1febSdrh       break;
2418e4de1febSdrh     }
2419e4de1febSdrh     default: break;
2420e4de1febSdrh   }
242192b01d53Sdrh   return rc;
2422e4de1febSdrh }
2423e4de1febSdrh 
2424e4de1febSdrh /*
2425039fc32eSdrh ** Return FALSE if there is no chance that the expression can be NULL.
2426039fc32eSdrh **
2427039fc32eSdrh ** If the expression might be NULL or if the expression is too complex
2428039fc32eSdrh ** to tell return TRUE.
2429039fc32eSdrh **
2430039fc32eSdrh ** This routine is used as an optimization, to skip OP_IsNull opcodes
2431039fc32eSdrh ** when we know that a value cannot be NULL.  Hence, a false positive
2432039fc32eSdrh ** (returning TRUE when in fact the expression can never be NULL) might
2433039fc32eSdrh ** be a small performance hit but is otherwise harmless.  On the other
2434039fc32eSdrh ** hand, a false negative (returning FALSE when the result could be NULL)
2435039fc32eSdrh ** will likely result in an incorrect answer.  So when in doubt, return
2436039fc32eSdrh ** TRUE.
2437039fc32eSdrh */
2438039fc32eSdrh int sqlite3ExprCanBeNull(const Expr *p){
2439039fc32eSdrh   u8 op;
24403c6edc8aSdrh   assert( p!=0 );
24419bfb0794Sdrh   while( p->op==TK_UPLUS || p->op==TK_UMINUS ){
24429bfb0794Sdrh     p = p->pLeft;
24433c6edc8aSdrh     assert( p!=0 );
24449bfb0794Sdrh   }
2445039fc32eSdrh   op = p->op;
2446039fc32eSdrh   if( op==TK_REGISTER ) op = p->op2;
2447039fc32eSdrh   switch( op ){
2448039fc32eSdrh     case TK_INTEGER:
2449039fc32eSdrh     case TK_STRING:
2450039fc32eSdrh     case TK_FLOAT:
2451039fc32eSdrh     case TK_BLOB:
2452039fc32eSdrh       return 0;
24537248a8b2Sdrh     case TK_COLUMN:
245472673a24Sdrh       return ExprHasProperty(p, EP_CanBeNull) ||
2455eda079cdSdrh              p->y.pTab==0 ||  /* Reference to column of index on expression */
24564eac5f04Sdrh              (p->iColumn>=0
24574eac5f04Sdrh               && ALWAYS(p->y.pTab->aCol!=0) /* Defense against OOM problems */
24584eac5f04Sdrh               && p->y.pTab->aCol[p->iColumn].notNull==0);
2459039fc32eSdrh     default:
2460039fc32eSdrh       return 1;
2461039fc32eSdrh   }
2462039fc32eSdrh }
2463039fc32eSdrh 
2464039fc32eSdrh /*
2465039fc32eSdrh ** Return TRUE if the given expression is a constant which would be
2466039fc32eSdrh ** unchanged by OP_Affinity with the affinity given in the second
2467039fc32eSdrh ** argument.
2468039fc32eSdrh **
2469039fc32eSdrh ** This routine is used to determine if the OP_Affinity operation
2470039fc32eSdrh ** can be omitted.  When in doubt return FALSE.  A false negative
2471039fc32eSdrh ** is harmless.  A false positive, however, can result in the wrong
2472039fc32eSdrh ** answer.
2473039fc32eSdrh */
2474039fc32eSdrh int sqlite3ExprNeedsNoAffinityChange(const Expr *p, char aff){
2475039fc32eSdrh   u8 op;
2476af866402Sdrh   int unaryMinus = 0;
247705883a34Sdrh   if( aff==SQLITE_AFF_BLOB ) return 1;
2478af866402Sdrh   while( p->op==TK_UPLUS || p->op==TK_UMINUS ){
2479af866402Sdrh     if( p->op==TK_UMINUS ) unaryMinus = 1;
2480af866402Sdrh     p = p->pLeft;
2481af866402Sdrh   }
2482039fc32eSdrh   op = p->op;
2483039fc32eSdrh   if( op==TK_REGISTER ) op = p->op2;
2484039fc32eSdrh   switch( op ){
2485039fc32eSdrh     case TK_INTEGER: {
24866a19865fSdrh       return aff>=SQLITE_AFF_NUMERIC;
2487039fc32eSdrh     }
2488039fc32eSdrh     case TK_FLOAT: {
24896a19865fSdrh       return aff>=SQLITE_AFF_NUMERIC;
2490039fc32eSdrh     }
2491039fc32eSdrh     case TK_STRING: {
2492af866402Sdrh       return !unaryMinus && aff==SQLITE_AFF_TEXT;
2493039fc32eSdrh     }
2494039fc32eSdrh     case TK_BLOB: {
2495af866402Sdrh       return !unaryMinus;
2496039fc32eSdrh     }
24972f2855b6Sdrh     case TK_COLUMN: {
249888376ca7Sdrh       assert( p->iTable>=0 );  /* p cannot be part of a CHECK constraint */
24996a19865fSdrh       return aff>=SQLITE_AFF_NUMERIC && p->iColumn<0;
25002f2855b6Sdrh     }
2501039fc32eSdrh     default: {
2502039fc32eSdrh       return 0;
2503039fc32eSdrh     }
2504039fc32eSdrh   }
2505039fc32eSdrh }
2506039fc32eSdrh 
2507039fc32eSdrh /*
2508c4a3c779Sdrh ** Return TRUE if the given string is a row-id column name.
2509c4a3c779Sdrh */
25104adee20fSdanielk1977 int sqlite3IsRowid(const char *z){
25114adee20fSdanielk1977   if( sqlite3StrICmp(z, "_ROWID_")==0 ) return 1;
25124adee20fSdanielk1977   if( sqlite3StrICmp(z, "ROWID")==0 ) return 1;
25134adee20fSdanielk1977   if( sqlite3StrICmp(z, "OID")==0 ) return 1;
2514c4a3c779Sdrh   return 0;
2515c4a3c779Sdrh }
2516c4a3c779Sdrh 
25179a96b668Sdanielk1977 /*
251869c355bdSdrh ** pX is the RHS of an IN operator.  If pX is a SELECT statement
251969c355bdSdrh ** that can be simplified to a direct table access, then return
252069c355bdSdrh ** a pointer to the SELECT statement.  If pX is not a SELECT statement,
252169c355bdSdrh ** or if the SELECT statement needs to be manifested into a transient
252269c355bdSdrh ** table, then return NULL.
2523b287f4b6Sdrh */
2524b287f4b6Sdrh #ifndef SQLITE_OMIT_SUBQUERY
2525b6dad520Sdrh static Select *isCandidateForInOpt(const Expr *pX){
252669c355bdSdrh   Select *p;
2527b287f4b6Sdrh   SrcList *pSrc;
2528b287f4b6Sdrh   ExprList *pEList;
2529b287f4b6Sdrh   Table *pTab;
2530cfbb5e82Sdan   int i;
2531*a4eeccdfSdrh   if( !ExprUseXSelect(pX) ) return 0;                 /* Not a subquery */
253269c355bdSdrh   if( ExprHasProperty(pX, EP_VarSelect)  ) return 0;  /* Correlated subq */
253369c355bdSdrh   p = pX->x.pSelect;
2534b287f4b6Sdrh   if( p->pPrior ) return 0;              /* Not a compound SELECT */
25357d10d5a6Sdrh   if( p->selFlags & (SF_Distinct|SF_Aggregate) ){
2536b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
2537b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
25387d10d5a6Sdrh     return 0; /* No DISTINCT keyword and no aggregate functions */
25397d10d5a6Sdrh   }
25402e26a602Sdrh   assert( p->pGroupBy==0 );              /* Has no GROUP BY clause */
2541b287f4b6Sdrh   if( p->pLimit ) return 0;              /* Has no LIMIT clause */
2542b287f4b6Sdrh   if( p->pWhere ) return 0;              /* Has no WHERE clause */
2543b287f4b6Sdrh   pSrc = p->pSrc;
2544d1fa7bcaSdrh   assert( pSrc!=0 );
2545d1fa7bcaSdrh   if( pSrc->nSrc!=1 ) return 0;          /* Single term in FROM clause */
2546b74b1017Sdrh   if( pSrc->a[0].pSelect ) return 0;     /* FROM is not a subquery or view */
2547b287f4b6Sdrh   pTab = pSrc->a[0].pTab;
254869c355bdSdrh   assert( pTab!=0 );
2549f38524d2Sdrh   assert( !IsView(pTab)  );              /* FROM clause is not a view */
2550b287f4b6Sdrh   if( IsVirtual(pTab) ) return 0;        /* FROM clause not a virtual table */
2551b287f4b6Sdrh   pEList = p->pEList;
2552ac6b47d1Sdrh   assert( pEList!=0 );
25537b35a77bSdan   /* All SELECT results must be columns. */
2554cfbb5e82Sdan   for(i=0; i<pEList->nExpr; i++){
2555cfbb5e82Sdan     Expr *pRes = pEList->a[i].pExpr;
2556cfbb5e82Sdan     if( pRes->op!=TK_COLUMN ) return 0;
255769c355bdSdrh     assert( pRes->iTable==pSrc->a[0].iCursor );  /* Not a correlated subquery */
2558cfbb5e82Sdan   }
255969c355bdSdrh   return p;
2560b287f4b6Sdrh }
2561b287f4b6Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
2562b287f4b6Sdrh 
2563f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
25641d8cb21fSdan /*
25654c259e9fSdrh ** Generate code that checks the left-most column of index table iCur to see if
25664c259e9fSdrh ** it contains any NULL entries.  Cause the register at regHasNull to be set
25676be515ebSdrh ** to a non-NULL value if iCur contains no NULLs.  Cause register regHasNull
25686be515ebSdrh ** to be set to NULL if iCur contains one or more NULL values.
25696be515ebSdrh */
25706be515ebSdrh static void sqlite3SetHasNullFlag(Vdbe *v, int iCur, int regHasNull){
2571728e0f91Sdrh   int addr1;
25726be515ebSdrh   sqlite3VdbeAddOp2(v, OP_Integer, 0, regHasNull);
2573728e0f91Sdrh   addr1 = sqlite3VdbeAddOp1(v, OP_Rewind, iCur); VdbeCoverage(v);
25746be515ebSdrh   sqlite3VdbeAddOp3(v, OP_Column, iCur, 0, regHasNull);
25756be515ebSdrh   sqlite3VdbeChangeP5(v, OPFLAG_TYPEOFARG);
25764c259e9fSdrh   VdbeComment((v, "first_entry_in(%d)", iCur));
2577728e0f91Sdrh   sqlite3VdbeJumpHere(v, addr1);
25786be515ebSdrh }
2579f9b2e05cSdan #endif
25806be515ebSdrh 
2581bb53ecb1Sdrh 
2582bb53ecb1Sdrh #ifndef SQLITE_OMIT_SUBQUERY
2583bb53ecb1Sdrh /*
2584bb53ecb1Sdrh ** The argument is an IN operator with a list (not a subquery) on the
2585bb53ecb1Sdrh ** right-hand side.  Return TRUE if that list is constant.
2586bb53ecb1Sdrh */
2587bb53ecb1Sdrh static int sqlite3InRhsIsConstant(Expr *pIn){
2588bb53ecb1Sdrh   Expr *pLHS;
2589bb53ecb1Sdrh   int res;
2590bb53ecb1Sdrh   assert( !ExprHasProperty(pIn, EP_xIsSelect) );
2591bb53ecb1Sdrh   pLHS = pIn->pLeft;
2592bb53ecb1Sdrh   pIn->pLeft = 0;
2593bb53ecb1Sdrh   res = sqlite3ExprIsConstant(pIn);
2594bb53ecb1Sdrh   pIn->pLeft = pLHS;
2595bb53ecb1Sdrh   return res;
2596bb53ecb1Sdrh }
2597bb53ecb1Sdrh #endif
2598bb53ecb1Sdrh 
25996be515ebSdrh /*
26009a96b668Sdanielk1977 ** This function is used by the implementation of the IN (...) operator.
2601d4305ca6Sdrh ** The pX parameter is the expression on the RHS of the IN operator, which
2602d4305ca6Sdrh ** might be either a list of expressions or a subquery.
26039a96b668Sdanielk1977 **
2604d4305ca6Sdrh ** The job of this routine is to find or create a b-tree object that can
2605d4305ca6Sdrh ** be used either to test for membership in the RHS set or to iterate through
2606d4305ca6Sdrh ** all members of the RHS set, skipping duplicates.
2607d4305ca6Sdrh **
26083a85625dSdrh ** A cursor is opened on the b-tree object that is the RHS of the IN operator
2609d4305ca6Sdrh ** and pX->iTable is set to the index of that cursor.
2610d4305ca6Sdrh **
2611b74b1017Sdrh ** The returned value of this function indicates the b-tree type, as follows:
26129a96b668Sdanielk1977 **
26139a96b668Sdanielk1977 **   IN_INDEX_ROWID      - The cursor was opened on a database table.
26141ccce449Sdrh **   IN_INDEX_INDEX_ASC  - The cursor was opened on an ascending index.
26151ccce449Sdrh **   IN_INDEX_INDEX_DESC - The cursor was opened on a descending index.
26169a96b668Sdanielk1977 **   IN_INDEX_EPH        - The cursor was opened on a specially created and
26179a96b668Sdanielk1977 **                         populated epheremal table.
2618bb53ecb1Sdrh **   IN_INDEX_NOOP       - No cursor was allocated.  The IN operator must be
2619bb53ecb1Sdrh **                         implemented as a sequence of comparisons.
26209a96b668Sdanielk1977 **
2621d4305ca6Sdrh ** An existing b-tree might be used if the RHS expression pX is a simple
2622d4305ca6Sdrh ** subquery such as:
26239a96b668Sdanielk1977 **
2624553168c7Sdan **     SELECT <column1>, <column2>... FROM <table>
26259a96b668Sdanielk1977 **
2626d4305ca6Sdrh ** If the RHS of the IN operator is a list or a more complex subquery, then
2627d4305ca6Sdrh ** an ephemeral table might need to be generated from the RHS and then
262860ec914cSpeter.d.reid ** pX->iTable made to point to the ephemeral table instead of an
2629d4305ca6Sdrh ** existing table.
2630d4305ca6Sdrh **
26317fc0ba0fSdrh ** The inFlags parameter must contain, at a minimum, one of the bits
26327fc0ba0fSdrh ** IN_INDEX_MEMBERSHIP or IN_INDEX_LOOP but not both.  If inFlags contains
26337fc0ba0fSdrh ** IN_INDEX_MEMBERSHIP, then the generated table will be used for a fast
26347fc0ba0fSdrh ** membership test.  When the IN_INDEX_LOOP bit is set, the IN index will
26357fc0ba0fSdrh ** be used to loop over all values of the RHS of the IN operator.
26363a85625dSdrh **
26373a85625dSdrh ** When IN_INDEX_LOOP is used (and the b-tree will be used to iterate
26383a85625dSdrh ** through the set members) then the b-tree must not contain duplicates.
26397fc0ba0fSdrh ** An epheremal table will be created unless the selected columns are guaranteed
2640553168c7Sdan ** to be unique - either because it is an INTEGER PRIMARY KEY or due to
2641553168c7Sdan ** a UNIQUE constraint or index.
26420cdc022eSdanielk1977 **
26433a85625dSdrh ** When IN_INDEX_MEMBERSHIP is used (and the b-tree will be used
26443a85625dSdrh ** for fast set membership tests) then an epheremal table must
2645553168c7Sdan ** be used unless <columns> is a single INTEGER PRIMARY KEY column or an
2646553168c7Sdan ** index can be found with the specified <columns> as its left-most.
26470cdc022eSdanielk1977 **
2648bb53ecb1Sdrh ** If the IN_INDEX_NOOP_OK and IN_INDEX_MEMBERSHIP are both set and
2649bb53ecb1Sdrh ** if the RHS of the IN operator is a list (not a subquery) then this
2650bb53ecb1Sdrh ** routine might decide that creating an ephemeral b-tree for membership
2651bb53ecb1Sdrh ** testing is too expensive and return IN_INDEX_NOOP.  In that case, the
2652bb53ecb1Sdrh ** calling routine should implement the IN operator using a sequence
2653bb53ecb1Sdrh ** of Eq or Ne comparison operations.
2654bb53ecb1Sdrh **
2655b74b1017Sdrh ** When the b-tree is being used for membership tests, the calling function
26563a85625dSdrh ** might need to know whether or not the RHS side of the IN operator
2657e21a6e1dSdrh ** contains a NULL.  If prRhsHasNull is not a NULL pointer and
26583a85625dSdrh ** if there is any chance that the (...) might contain a NULL value at
26590cdc022eSdanielk1977 ** runtime, then a register is allocated and the register number written
2660e21a6e1dSdrh ** to *prRhsHasNull. If there is no chance that the (...) contains a
2661e21a6e1dSdrh ** NULL value, then *prRhsHasNull is left unchanged.
26620cdc022eSdanielk1977 **
2663e21a6e1dSdrh ** If a register is allocated and its location stored in *prRhsHasNull, then
26646be515ebSdrh ** the value in that register will be NULL if the b-tree contains one or more
26656be515ebSdrh ** NULL values, and it will be some non-NULL value if the b-tree contains no
26666be515ebSdrh ** NULL values.
2667553168c7Sdan **
2668553168c7Sdan ** If the aiMap parameter is not NULL, it must point to an array containing
2669553168c7Sdan ** one element for each column returned by the SELECT statement on the RHS
2670553168c7Sdan ** of the IN(...) operator. The i'th entry of the array is populated with the
2671553168c7Sdan ** offset of the index column that matches the i'th column returned by the
2672553168c7Sdan ** SELECT. For example, if the expression and selected index are:
2673553168c7Sdan **
2674553168c7Sdan **   (?,?,?) IN (SELECT a, b, c FROM t1)
2675553168c7Sdan **   CREATE INDEX i1 ON t1(b, c, a);
2676553168c7Sdan **
2677553168c7Sdan ** then aiMap[] is populated with {2, 0, 1}.
26789a96b668Sdanielk1977 */
2679284f4acaSdanielk1977 #ifndef SQLITE_OMIT_SUBQUERY
2680ba00e30aSdan int sqlite3FindInIndex(
26816fc8f364Sdrh   Parse *pParse,             /* Parsing context */
26820167ef20Sdrh   Expr *pX,                  /* The IN expression */
26836fc8f364Sdrh   u32 inFlags,               /* IN_INDEX_LOOP, _MEMBERSHIP, and/or _NOOP_OK */
26846fc8f364Sdrh   int *prRhsHasNull,         /* Register holding NULL status.  See notes */
26852c04131cSdrh   int *aiMap,                /* Mapping from Index fields to RHS fields */
26862c04131cSdrh   int *piTab                 /* OUT: index to use */
2687ba00e30aSdan ){
2688b74b1017Sdrh   Select *p;                            /* SELECT to the right of IN operator */
2689b74b1017Sdrh   int eType = 0;                        /* Type of RHS table. IN_INDEX_* */
2690b74b1017Sdrh   int iTab = pParse->nTab++;            /* Cursor of the RHS table */
26913a85625dSdrh   int mustBeUnique;                     /* True if RHS must be unique */
2692b8475df8Sdrh   Vdbe *v = sqlite3GetVdbe(pParse);     /* Virtual machine being coded */
26939a96b668Sdanielk1977 
26941450bc6eSdrh   assert( pX->op==TK_IN );
26953a85625dSdrh   mustBeUnique = (inFlags & IN_INDEX_LOOP)!=0;
26961450bc6eSdrh 
26977b35a77bSdan   /* If the RHS of this IN(...) operator is a SELECT, and if it matters
26987b35a77bSdan   ** whether or not the SELECT result contains NULL values, check whether
2699870a0705Sdan   ** or not NULL is actually possible (it may not be, for example, due
27007b35a77bSdan   ** to NOT NULL constraints in the schema). If no NULL values are possible,
2701870a0705Sdan   ** set prRhsHasNull to 0 before continuing.  */
2702*a4eeccdfSdrh   if( prRhsHasNull && ExprUseXSelect(pX) ){
27037b35a77bSdan     int i;
27047b35a77bSdan     ExprList *pEList = pX->x.pSelect->pEList;
27057b35a77bSdan     for(i=0; i<pEList->nExpr; i++){
27067b35a77bSdan       if( sqlite3ExprCanBeNull(pEList->a[i].pExpr) ) break;
27077b35a77bSdan     }
27087b35a77bSdan     if( i==pEList->nExpr ){
27097b35a77bSdan       prRhsHasNull = 0;
27107b35a77bSdan     }
27117b35a77bSdan   }
27127b35a77bSdan 
2713b74b1017Sdrh   /* Check to see if an existing table or index can be used to
2714b74b1017Sdrh   ** satisfy the query.  This is preferable to generating a new
27157b35a77bSdan   ** ephemeral table.  */
27167b35a77bSdan   if( pParse->nErr==0 && (p = isCandidateForInOpt(pX))!=0 ){
2717e1fb65a0Sdanielk1977     sqlite3 *db = pParse->db;              /* Database connection */
2718b07028f7Sdrh     Table *pTab;                           /* Table <table>. */
2719399062ccSdrh     int iDb;                               /* Database idx for pTab */
2720cfbb5e82Sdan     ExprList *pEList = p->pEList;
2721cfbb5e82Sdan     int nExpr = pEList->nExpr;
2722e1fb65a0Sdanielk1977 
2723b07028f7Sdrh     assert( p->pEList!=0 );             /* Because of isCandidateForInOpt(p) */
2724b07028f7Sdrh     assert( p->pEList->a[0].pExpr!=0 ); /* Because of isCandidateForInOpt(p) */
2725b07028f7Sdrh     assert( p->pSrc!=0 );               /* Because of isCandidateForInOpt(p) */
2726b07028f7Sdrh     pTab = p->pSrc->a[0].pTab;
2727b07028f7Sdrh 
2728b22f7c83Sdrh     /* Code an OP_Transaction and OP_TableLock for <table>. */
2729e1fb65a0Sdanielk1977     iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
2730099b385dSdrh     assert( iDb>=0 && iDb<SQLITE_MAX_DB );
2731e1fb65a0Sdanielk1977     sqlite3CodeVerifySchema(pParse, iDb);
2732e1fb65a0Sdanielk1977     sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
27339a96b668Sdanielk1977 
2734a84a283dSdrh     assert(v);  /* sqlite3GetVdbe() has always been previously called */
2735cfbb5e82Sdan     if( nExpr==1 && pEList->a[0].pExpr->iColumn<0 ){
273662659b2aSdrh       /* The "x IN (SELECT rowid FROM table)" case */
2737511f9e8dSdrh       int iAddr = sqlite3VdbeAddOp0(v, OP_Once);
27387d176105Sdrh       VdbeCoverage(v);
27399a96b668Sdanielk1977 
27409a96b668Sdanielk1977       sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
27419a96b668Sdanielk1977       eType = IN_INDEX_ROWID;
2742d8852095Sdrh       ExplainQueryPlan((pParse, 0,
2743d8852095Sdrh             "USING ROWID SEARCH ON TABLE %s FOR IN-OPERATOR",pTab->zName));
27449a96b668Sdanielk1977       sqlite3VdbeJumpHere(v, iAddr);
27459a96b668Sdanielk1977     }else{
2746e1fb65a0Sdanielk1977       Index *pIdx;                         /* Iterator variable */
2747cfbb5e82Sdan       int affinity_ok = 1;
2748cfbb5e82Sdan       int i;
2749cfbb5e82Sdan 
2750cfbb5e82Sdan       /* Check that the affinity that will be used to perform each
275162659b2aSdrh       ** comparison is the same as the affinity of each column in table
275262659b2aSdrh       ** on the RHS of the IN operator.  If it not, it is not possible to
275362659b2aSdrh       ** use any index of the RHS table.  */
2754cfbb5e82Sdan       for(i=0; i<nExpr && affinity_ok; i++){
2755fc7f27b9Sdrh         Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2756cfbb5e82Sdan         int iCol = pEList->a[i].pExpr->iColumn;
27570dfa4f6fSdrh         char idxaff = sqlite3TableColumnAffinity(pTab,iCol); /* RHS table */
2758cfbb5e82Sdan         char cmpaff = sqlite3CompareAffinity(pLhs, idxaff);
275962659b2aSdrh         testcase( cmpaff==SQLITE_AFF_BLOB );
276062659b2aSdrh         testcase( cmpaff==SQLITE_AFF_TEXT );
2761cfbb5e82Sdan         switch( cmpaff ){
2762cfbb5e82Sdan           case SQLITE_AFF_BLOB:
2763cfbb5e82Sdan             break;
2764cfbb5e82Sdan           case SQLITE_AFF_TEXT:
276562659b2aSdrh             /* sqlite3CompareAffinity() only returns TEXT if one side or the
276662659b2aSdrh             ** other has no affinity and the other side is TEXT.  Hence,
276762659b2aSdrh             ** the only way for cmpaff to be TEXT is for idxaff to be TEXT
276862659b2aSdrh             ** and for the term on the LHS of the IN to have no affinity. */
276962659b2aSdrh             assert( idxaff==SQLITE_AFF_TEXT );
2770cfbb5e82Sdan             break;
2771cfbb5e82Sdan           default:
2772cfbb5e82Sdan             affinity_ok = sqlite3IsNumericAffinity(idxaff);
2773cfbb5e82Sdan         }
2774cfbb5e82Sdan       }
2775e1fb65a0Sdanielk1977 
2776a84a283dSdrh       if( affinity_ok ){
2777a84a283dSdrh         /* Search for an existing index that will work for this IN operator */
2778a84a283dSdrh         for(pIdx=pTab->pIndex; pIdx && eType==0; pIdx=pIdx->pNext){
2779a84a283dSdrh           Bitmask colUsed;      /* Columns of the index used */
2780a84a283dSdrh           Bitmask mCol;         /* Mask for the current column */
27816fc8f364Sdrh           if( pIdx->nColumn<nExpr ) continue;
2782d4a4a361Sdrh           if( pIdx->pPartIdxWhere!=0 ) continue;
2783a84a283dSdrh           /* Maximum nColumn is BMS-2, not BMS-1, so that we can compute
2784a84a283dSdrh           ** BITMASK(nExpr) without overflowing */
2785a84a283dSdrh           testcase( pIdx->nColumn==BMS-2 );
2786a84a283dSdrh           testcase( pIdx->nColumn==BMS-1 );
2787a84a283dSdrh           if( pIdx->nColumn>=BMS-1 ) continue;
27886fc8f364Sdrh           if( mustBeUnique ){
27896fc8f364Sdrh             if( pIdx->nKeyCol>nExpr
27906fc8f364Sdrh              ||(pIdx->nColumn>nExpr && !IsUniqueIndex(pIdx))
27916fc8f364Sdrh             ){
2792a84a283dSdrh               continue;  /* This index is not unique over the IN RHS columns */
2793cfbb5e82Sdan             }
27946fc8f364Sdrh           }
2795cfbb5e82Sdan 
2796a84a283dSdrh           colUsed = 0;   /* Columns of index used so far */
2797cfbb5e82Sdan           for(i=0; i<nExpr; i++){
2798fc7f27b9Sdrh             Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2799cfbb5e82Sdan             Expr *pRhs = pEList->a[i].pExpr;
2800cfbb5e82Sdan             CollSeq *pReq = sqlite3BinaryCompareCollSeq(pParse, pLhs, pRhs);
2801cfbb5e82Sdan             int j;
2802cfbb5e82Sdan 
28036fc8f364Sdrh             assert( pReq!=0 || pRhs->iColumn==XN_ROWID || pParse->nErr );
2804cfbb5e82Sdan             for(j=0; j<nExpr; j++){
2805cfbb5e82Sdan               if( pIdx->aiColumn[j]!=pRhs->iColumn ) continue;
2806cfbb5e82Sdan               assert( pIdx->azColl[j] );
2807106526e1Sdrh               if( pReq!=0 && sqlite3StrICmp(pReq->zName, pIdx->azColl[j])!=0 ){
2808106526e1Sdrh                 continue;
2809106526e1Sdrh               }
2810cfbb5e82Sdan               break;
2811cfbb5e82Sdan             }
2812cfbb5e82Sdan             if( j==nExpr ) break;
2813a84a283dSdrh             mCol = MASKBIT(j);
2814a84a283dSdrh             if( mCol & colUsed ) break; /* Each column used only once */
2815a84a283dSdrh             colUsed |= mCol;
2816ba00e30aSdan             if( aiMap ) aiMap[i] = j;
2817cfbb5e82Sdan           }
2818cfbb5e82Sdan 
2819a84a283dSdrh           assert( i==nExpr || colUsed!=(MASKBIT(nExpr)-1) );
2820a84a283dSdrh           if( colUsed==(MASKBIT(nExpr)-1) ){
2821a84a283dSdrh             /* If we reach this point, that means the index pIdx is usable */
2822511f9e8dSdrh             int iAddr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
2823e2ca99c9Sdrh             ExplainQueryPlan((pParse, 0,
2824e2ca99c9Sdrh                               "USING INDEX %s FOR IN-OPERATOR",pIdx->zName));
28252ec2fb22Sdrh             sqlite3VdbeAddOp3(v, OP_OpenRead, iTab, pIdx->tnum, iDb);
28262ec2fb22Sdrh             sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
2827207872a4Sdanielk1977             VdbeComment((v, "%s", pIdx->zName));
28281ccce449Sdrh             assert( IN_INDEX_INDEX_DESC == IN_INDEX_INDEX_ASC+1 );
28291ccce449Sdrh             eType = IN_INDEX_INDEX_ASC + pIdx->aSortOrder[0];
28309a96b668Sdanielk1977 
28317b35a77bSdan             if( prRhsHasNull ){
28323480bfdaSdan #ifdef SQLITE_ENABLE_COLUMN_USED_MASK
2833cfbb5e82Sdan               i64 mask = (1<<nExpr)-1;
28343480bfdaSdan               sqlite3VdbeAddOp4Dup8(v, OP_ColumnsUsed,
2835cfbb5e82Sdan                   iTab, 0, 0, (u8*)&mask, P4_INT64);
28363480bfdaSdan #endif
2837b80dbdc2Sdrh               *prRhsHasNull = ++pParse->nMem;
28387b35a77bSdan               if( nExpr==1 ){
28396be515ebSdrh                 sqlite3SetHasNullFlag(v, iTab, *prRhsHasNull);
28400cdc022eSdanielk1977               }
28417b35a77bSdan             }
2842552fd454Sdrh             sqlite3VdbeJumpHere(v, iAddr);
28439a96b668Sdanielk1977           }
2844a84a283dSdrh         } /* End loop over indexes */
2845a84a283dSdrh       } /* End if( affinity_ok ) */
2846a84a283dSdrh     } /* End if not an rowid index */
2847a84a283dSdrh   } /* End attempt to optimize using an index */
28489a96b668Sdanielk1977 
2849bb53ecb1Sdrh   /* If no preexisting index is available for the IN clause
2850bb53ecb1Sdrh   ** and IN_INDEX_NOOP is an allowed reply
2851bb53ecb1Sdrh   ** and the RHS of the IN operator is a list, not a subquery
285271c57db0Sdan   ** and the RHS is not constant or has two or fewer terms,
285360ec914cSpeter.d.reid   ** then it is not worth creating an ephemeral table to evaluate
2854bb53ecb1Sdrh   ** the IN operator so return IN_INDEX_NOOP.
2855bb53ecb1Sdrh   */
2856bb53ecb1Sdrh   if( eType==0
2857bb53ecb1Sdrh    && (inFlags & IN_INDEX_NOOP_OK)
2858*a4eeccdfSdrh    && ExprUseXList(pX)
2859bb53ecb1Sdrh    && (!sqlite3InRhsIsConstant(pX) || pX->x.pList->nExpr<=2)
2860bb53ecb1Sdrh   ){
2861bb53ecb1Sdrh     eType = IN_INDEX_NOOP;
2862bb53ecb1Sdrh   }
2863bb53ecb1Sdrh 
28649a96b668Sdanielk1977   if( eType==0 ){
28654387006cSdrh     /* Could not find an existing table or index to use as the RHS b-tree.
2866b74b1017Sdrh     ** We will have to generate an ephemeral table to do the job.
2867b74b1017Sdrh     */
28688e23daf3Sdrh     u32 savedNQueryLoop = pParse->nQueryLoop;
28690cdc022eSdanielk1977     int rMayHaveNull = 0;
287041a05b7bSdanielk1977     eType = IN_INDEX_EPH;
28713a85625dSdrh     if( inFlags & IN_INDEX_LOOP ){
28724a5acf8eSdrh       pParse->nQueryLoop = 0;
2873e21a6e1dSdrh     }else if( prRhsHasNull ){
2874e21a6e1dSdrh       *prRhsHasNull = rMayHaveNull = ++pParse->nMem;
2875cf4d38aaSdrh     }
287685bcdce2Sdrh     assert( pX->op==TK_IN );
287750ef6716Sdrh     sqlite3CodeRhsOfIN(pParse, pX, iTab);
287885bcdce2Sdrh     if( rMayHaveNull ){
28792c04131cSdrh       sqlite3SetHasNullFlag(v, iTab, rMayHaveNull);
288085bcdce2Sdrh     }
2881cf4d38aaSdrh     pParse->nQueryLoop = savedNQueryLoop;
28829a96b668Sdanielk1977   }
2883ba00e30aSdan 
2884ba00e30aSdan   if( aiMap && eType!=IN_INDEX_INDEX_ASC && eType!=IN_INDEX_INDEX_DESC ){
2885ba00e30aSdan     int i, n;
2886ba00e30aSdan     n = sqlite3ExprVectorSize(pX->pLeft);
2887ba00e30aSdan     for(i=0; i<n; i++) aiMap[i] = i;
2888ba00e30aSdan   }
28892c04131cSdrh   *piTab = iTab;
28909a96b668Sdanielk1977   return eType;
28919a96b668Sdanielk1977 }
2892284f4acaSdanielk1977 #endif
2893626a879aSdrh 
2894f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
2895553168c7Sdan /*
2896553168c7Sdan ** Argument pExpr is an (?, ?...) IN(...) expression. This
2897553168c7Sdan ** function allocates and returns a nul-terminated string containing
2898553168c7Sdan ** the affinities to be used for each column of the comparison.
2899553168c7Sdan **
2900553168c7Sdan ** It is the responsibility of the caller to ensure that the returned
2901553168c7Sdan ** string is eventually freed using sqlite3DbFree().
2902553168c7Sdan */
2903b6dad520Sdrh static char *exprINAffinity(Parse *pParse, const Expr *pExpr){
290471c57db0Sdan   Expr *pLeft = pExpr->pLeft;
290571c57db0Sdan   int nVal = sqlite3ExprVectorSize(pLeft);
2906*a4eeccdfSdrh   Select *pSelect = ExprUseXSelect(pExpr) ? pExpr->x.pSelect : 0;
290771c57db0Sdan   char *zRet;
290871c57db0Sdan 
2909553168c7Sdan   assert( pExpr->op==TK_IN );
29105c258dc1Sdrh   zRet = sqlite3DbMallocRaw(pParse->db, nVal+1);
291171c57db0Sdan   if( zRet ){
291271c57db0Sdan     int i;
291371c57db0Sdan     for(i=0; i<nVal; i++){
2914fc7f27b9Sdrh       Expr *pA = sqlite3VectorFieldSubexpr(pLeft, i);
2915553168c7Sdan       char a = sqlite3ExprAffinity(pA);
2916553168c7Sdan       if( pSelect ){
2917553168c7Sdan         zRet[i] = sqlite3CompareAffinity(pSelect->pEList->a[i].pExpr, a);
291871c57db0Sdan       }else{
2919553168c7Sdan         zRet[i] = a;
292071c57db0Sdan       }
292171c57db0Sdan     }
292271c57db0Sdan     zRet[nVal] = '\0';
292371c57db0Sdan   }
292471c57db0Sdan   return zRet;
292571c57db0Sdan }
2926f9b2e05cSdan #endif
292771c57db0Sdan 
29288da209b1Sdan #ifndef SQLITE_OMIT_SUBQUERY
29298da209b1Sdan /*
29308da209b1Sdan ** Load the Parse object passed as the first argument with an error
29318da209b1Sdan ** message of the form:
29328da209b1Sdan **
29338da209b1Sdan **   "sub-select returns N columns - expected M"
29348da209b1Sdan */
29358da209b1Sdan void sqlite3SubselectError(Parse *pParse, int nActual, int nExpect){
2936a9ebfe20Sdrh   if( pParse->nErr==0 ){
29378da209b1Sdan     const char *zFmt = "sub-select returns %d columns - expected %d";
29388da209b1Sdan     sqlite3ErrorMsg(pParse, zFmt, nActual, nExpect);
29398da209b1Sdan   }
2940a9ebfe20Sdrh }
29418da209b1Sdan #endif
29428da209b1Sdan 
2943626a879aSdrh /*
294444c5604cSdan ** Expression pExpr is a vector that has been used in a context where
294544c5604cSdan ** it is not permitted. If pExpr is a sub-select vector, this routine
294644c5604cSdan ** loads the Parse object with a message of the form:
294744c5604cSdan **
294844c5604cSdan **   "sub-select returns N columns - expected 1"
294944c5604cSdan **
295044c5604cSdan ** Or, if it is a regular scalar vector:
295144c5604cSdan **
295244c5604cSdan **   "row value misused"
295344c5604cSdan */
295444c5604cSdan void sqlite3VectorErrorMsg(Parse *pParse, Expr *pExpr){
295544c5604cSdan #ifndef SQLITE_OMIT_SUBQUERY
2956*a4eeccdfSdrh   if( ExprUseXSelect(pExpr) ){
295744c5604cSdan     sqlite3SubselectError(pParse, pExpr->x.pSelect->pEList->nExpr, 1);
295844c5604cSdan   }else
295944c5604cSdan #endif
296044c5604cSdan   {
296144c5604cSdan     sqlite3ErrorMsg(pParse, "row value misused");
296244c5604cSdan   }
296344c5604cSdan }
296444c5604cSdan 
296585bcdce2Sdrh #ifndef SQLITE_OMIT_SUBQUERY
296644c5604cSdan /*
296785bcdce2Sdrh ** Generate code that will construct an ephemeral table containing all terms
296885bcdce2Sdrh ** in the RHS of an IN operator.  The IN operator can be in either of two
296985bcdce2Sdrh ** forms:
2970626a879aSdrh **
29719cbe6352Sdrh **     x IN (4,5,11)              -- IN operator with list on right-hand side
29729cbe6352Sdrh **     x IN (SELECT a FROM b)     -- IN operator with subquery on the right
2973fef5208cSdrh **
29742c04131cSdrh ** The pExpr parameter is the IN operator.  The cursor number for the
29752c04131cSdrh ** constructed ephermeral table is returned.  The first time the ephemeral
29762c04131cSdrh ** table is computed, the cursor number is also stored in pExpr->iTable,
29772c04131cSdrh ** however the cursor number returned might not be the same, as it might
29782c04131cSdrh ** have been duplicated using OP_OpenDup.
297941a05b7bSdanielk1977 **
298085bcdce2Sdrh ** If the LHS expression ("x" in the examples) is a column value, or
298185bcdce2Sdrh ** the SELECT statement returns a column value, then the affinity of that
298285bcdce2Sdrh ** column is used to build the index keys. If both 'x' and the
298385bcdce2Sdrh ** SELECT... statement are columns, then numeric affinity is used
298485bcdce2Sdrh ** if either column has NUMERIC or INTEGER affinity. If neither
298585bcdce2Sdrh ** 'x' nor the SELECT... statement are columns, then numeric affinity
298685bcdce2Sdrh ** is used.
2987cce7d176Sdrh */
298885bcdce2Sdrh void sqlite3CodeRhsOfIN(
2989fd773cf9Sdrh   Parse *pParse,          /* Parsing context */
299085bcdce2Sdrh   Expr *pExpr,            /* The IN operator */
299150ef6716Sdrh   int iTab                /* Use this cursor number */
299241a05b7bSdanielk1977 ){
29932c04131cSdrh   int addrOnce = 0;           /* Address of the OP_Once instruction at top */
299485bcdce2Sdrh   int addr;                   /* Address of OP_OpenEphemeral instruction */
299585bcdce2Sdrh   Expr *pLeft;                /* the LHS of the IN operator */
299685bcdce2Sdrh   KeyInfo *pKeyInfo = 0;      /* Key information */
299785bcdce2Sdrh   int nVal;                   /* Size of vector pLeft */
299885bcdce2Sdrh   Vdbe *v;                    /* The prepared statement under construction */
2999fc976065Sdanielk1977 
30002c04131cSdrh   v = pParse->pVdbe;
300185bcdce2Sdrh   assert( v!=0 );
300285bcdce2Sdrh 
30032c04131cSdrh   /* The evaluation of the IN must be repeated every time it
300439a11819Sdrh   ** is encountered if any of the following is true:
300557dbd7b3Sdrh   **
300657dbd7b3Sdrh   **    *  The right-hand side is a correlated subquery
300757dbd7b3Sdrh   **    *  The right-hand side is an expression list containing variables
300857dbd7b3Sdrh   **    *  We are inside a trigger
300957dbd7b3Sdrh   **
30102c04131cSdrh   ** If all of the above are false, then we can compute the RHS just once
30112c04131cSdrh   ** and reuse it many names.
3012b3bce662Sdanielk1977   */
3013efb699fcSdrh   if( !ExprHasProperty(pExpr, EP_VarSelect) && pParse->iSelfTab==0 ){
30142c04131cSdrh     /* Reuse of the RHS is allowed */
30152c04131cSdrh     /* If this routine has already been coded, but the previous code
30162c04131cSdrh     ** might not have been invoked yet, so invoke it now as a subroutine.
30172c04131cSdrh     */
30182c04131cSdrh     if( ExprHasProperty(pExpr, EP_Subrtn) ){
3019f9231c34Sdrh       addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
3020*a4eeccdfSdrh       if( ExprUseXSelect(pExpr) ){
3021bd462bccSdrh         ExplainQueryPlan((pParse, 0, "REUSE LIST SUBQUERY %d",
3022bd462bccSdrh               pExpr->x.pSelect->selId));
3023bd462bccSdrh       }
30242c04131cSdrh       sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
30252c04131cSdrh                         pExpr->y.sub.iAddr);
30262c04131cSdrh       sqlite3VdbeAddOp2(v, OP_OpenDup, iTab, pExpr->iTable);
3027f9231c34Sdrh       sqlite3VdbeJumpHere(v, addrOnce);
30282c04131cSdrh       return;
30292c04131cSdrh     }
30302c04131cSdrh 
30312c04131cSdrh     /* Begin coding the subroutine */
30322c04131cSdrh     ExprSetProperty(pExpr, EP_Subrtn);
3033088489e8Sdrh     assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
30342c04131cSdrh     pExpr->y.sub.regReturn = ++pParse->nMem;
30352c04131cSdrh     pExpr->y.sub.iAddr =
30362c04131cSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 0, pExpr->y.sub.regReturn) + 1;
30372c04131cSdrh     VdbeComment((v, "return address"));
30382c04131cSdrh 
30392c04131cSdrh     addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
3040b3bce662Sdanielk1977   }
3041b3bce662Sdanielk1977 
304285bcdce2Sdrh   /* Check to see if this is a vector IN operator */
304385bcdce2Sdrh   pLeft = pExpr->pLeft;
304471c57db0Sdan   nVal = sqlite3ExprVectorSize(pLeft);
3045e014a838Sdanielk1977 
304685bcdce2Sdrh   /* Construct the ephemeral table that will contain the content of
304785bcdce2Sdrh   ** RHS of the IN operator.
3048fef5208cSdrh   */
30492c04131cSdrh   pExpr->iTable = iTab;
305050ef6716Sdrh   addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, pExpr->iTable, nVal);
30512c04131cSdrh #ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
3052*a4eeccdfSdrh   if( ExprUseXSelect(pExpr) ){
30532c04131cSdrh     VdbeComment((v, "Result of SELECT %u", pExpr->x.pSelect->selId));
30542c04131cSdrh   }else{
30552c04131cSdrh     VdbeComment((v, "RHS of IN operator"));
30562c04131cSdrh   }
30572c04131cSdrh #endif
305850ef6716Sdrh   pKeyInfo = sqlite3KeyInfoAlloc(pParse->db, nVal, 1);
3059e014a838Sdanielk1977 
3060*a4eeccdfSdrh   if( ExprUseXSelect(pExpr) ){
3061e014a838Sdanielk1977     /* Case 1:     expr IN (SELECT ...)
3062e014a838Sdanielk1977     **
3063e014a838Sdanielk1977     ** Generate code to write the results of the select into the temporary
3064e014a838Sdanielk1977     ** table allocated and opened above.
3065e014a838Sdanielk1977     */
30664387006cSdrh     Select *pSelect = pExpr->x.pSelect;
306771c57db0Sdan     ExprList *pEList = pSelect->pEList;
30681013c932Sdrh 
30692c04131cSdrh     ExplainQueryPlan((pParse, 1, "%sLIST SUBQUERY %d",
30702c04131cSdrh         addrOnce?"":"CORRELATED ", pSelect->selId
3071e2ca99c9Sdrh     ));
307264bcb8cfSdrh     /* If the LHS and RHS of the IN operator do not match, that
307364bcb8cfSdrh     ** error will have been caught long before we reach this point. */
307464bcb8cfSdrh     if( ALWAYS(pEList->nExpr==nVal) ){
307514c4d428Sdrh       Select *pCopy;
307671c57db0Sdan       SelectDest dest;
307771c57db0Sdan       int i;
307814c4d428Sdrh       int rc;
3079bd462bccSdrh       sqlite3SelectDestInit(&dest, SRT_Set, iTab);
308071c57db0Sdan       dest.zAffSdst = exprINAffinity(pParse, pExpr);
30814387006cSdrh       pSelect->iLimit = 0;
30824387006cSdrh       testcase( pSelect->selFlags & SF_Distinct );
3083812ea833Sdrh       testcase( pKeyInfo==0 ); /* Caused by OOM in sqlite3KeyInfoAlloc() */
308414c4d428Sdrh       pCopy = sqlite3SelectDup(pParse->db, pSelect, 0);
308514c4d428Sdrh       rc = pParse->db->mallocFailed ? 1 :sqlite3Select(pParse, pCopy, &dest);
308614c4d428Sdrh       sqlite3SelectDelete(pParse->db, pCopy);
308771c57db0Sdan       sqlite3DbFree(pParse->db, dest.zAffSdst);
308814c4d428Sdrh       if( rc ){
30892ec2fb22Sdrh         sqlite3KeyInfoUnref(pKeyInfo);
309085bcdce2Sdrh         return;
309194ccde58Sdrh       }
3092812ea833Sdrh       assert( pKeyInfo!=0 ); /* OOM will cause exit after sqlite3Select() */
30933535ec3eSdrh       assert( pEList!=0 );
30943535ec3eSdrh       assert( pEList->nExpr>0 );
30952ec2fb22Sdrh       assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
309671c57db0Sdan       for(i=0; i<nVal; i++){
3097773d3afaSdan         Expr *p = sqlite3VectorFieldSubexpr(pLeft, i);
309871c57db0Sdan         pKeyInfo->aColl[i] = sqlite3BinaryCompareCollSeq(
309971c57db0Sdan             pParse, p, pEList->a[i].pExpr
310071c57db0Sdan         );
310171c57db0Sdan       }
310271c57db0Sdan     }
3103a7d2db17Sdrh   }else if( ALWAYS(pExpr->x.pList!=0) ){
3104fef5208cSdrh     /* Case 2:     expr IN (exprlist)
3105fef5208cSdrh     **
3106e014a838Sdanielk1977     ** For each expression, build an index key from the evaluation and
3107e014a838Sdanielk1977     ** store it in the temporary table. If <expr> is a column, then use
3108e014a838Sdanielk1977     ** that columns affinity when building index keys. If <expr> is not
3109e014a838Sdanielk1977     ** a column, use numeric affinity.
3110fef5208cSdrh     */
311171c57db0Sdan     char affinity;            /* Affinity of the LHS of the IN */
3112e014a838Sdanielk1977     int i;
31136ab3a2ecSdanielk1977     ExprList *pList = pExpr->x.pList;
311457dbd7b3Sdrh     struct ExprList_item *pItem;
3115c324d446Sdan     int r1, r2;
311671c57db0Sdan     affinity = sqlite3ExprAffinity(pLeft);
311796fb16eeSdrh     if( affinity<=SQLITE_AFF_NONE ){
311805883a34Sdrh       affinity = SQLITE_AFF_BLOB;
311995b39590Sdrh     }else if( affinity==SQLITE_AFF_REAL ){
312095b39590Sdrh       affinity = SQLITE_AFF_NUMERIC;
3121e014a838Sdanielk1977     }
3122323df790Sdrh     if( pKeyInfo ){
31232ec2fb22Sdrh       assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
3124323df790Sdrh       pKeyInfo->aColl[0] = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
3125323df790Sdrh     }
3126e014a838Sdanielk1977 
3127e014a838Sdanielk1977     /* Loop through each expression in <exprlist>. */
31282d401ab8Sdrh     r1 = sqlite3GetTempReg(pParse);
31292d401ab8Sdrh     r2 = sqlite3GetTempReg(pParse);
313057dbd7b3Sdrh     for(i=pList->nExpr, pItem=pList->a; i>0; i--, pItem++){
313157dbd7b3Sdrh       Expr *pE2 = pItem->pExpr;
3132e014a838Sdanielk1977 
313357dbd7b3Sdrh       /* If the expression is not constant then we will need to
313457dbd7b3Sdrh       ** disable the test that was generated above that makes sure
313557dbd7b3Sdrh       ** this code only executes once.  Because for a non-constant
313657dbd7b3Sdrh       ** expression we need to rerun this code each time.
313757dbd7b3Sdrh       */
31382c04131cSdrh       if( addrOnce && !sqlite3ExprIsConstant(pE2) ){
31392c04131cSdrh         sqlite3VdbeChangeToNoop(v, addrOnce);
31407ac0e562Sdan         ExprClearProperty(pExpr, EP_Subrtn);
31412c04131cSdrh         addrOnce = 0;
31424794b980Sdrh       }
3143e014a838Sdanielk1977 
3144e014a838Sdanielk1977       /* Evaluate the expression and insert it into the temp table */
3145c324d446Sdan       sqlite3ExprCode(pParse, pE2, r1);
3146c324d446Sdan       sqlite3VdbeAddOp4(v, OP_MakeRecord, r1, 1, r2, &affinity, 1);
3147c324d446Sdan       sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iTab, r2, r1, 1);
3148fef5208cSdrh     }
31492d401ab8Sdrh     sqlite3ReleaseTempReg(pParse, r1);
31502d401ab8Sdrh     sqlite3ReleaseTempReg(pParse, r2);
3151fef5208cSdrh   }
3152323df790Sdrh   if( pKeyInfo ){
31532ec2fb22Sdrh     sqlite3VdbeChangeP4(v, addr, (void *)pKeyInfo, P4_KEYINFO);
315441a05b7bSdanielk1977   }
31552c04131cSdrh   if( addrOnce ){
31562c04131cSdrh     sqlite3VdbeJumpHere(v, addrOnce);
31572c04131cSdrh     /* Subroutine return */
31582c04131cSdrh     sqlite3VdbeAddOp1(v, OP_Return, pExpr->y.sub.regReturn);
31592c04131cSdrh     sqlite3VdbeChangeP1(v, pExpr->y.sub.iAddr-1, sqlite3VdbeCurrentAddr(v)-1);
31606d2566dfSdrh     sqlite3ClearTempRegCache(pParse);
316185bcdce2Sdrh   }
316285bcdce2Sdrh }
316385bcdce2Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
316485bcdce2Sdrh 
316585bcdce2Sdrh /*
316685bcdce2Sdrh ** Generate code for scalar subqueries used as a subquery expression
316785bcdce2Sdrh ** or EXISTS operator:
316885bcdce2Sdrh **
316985bcdce2Sdrh **     (SELECT a FROM b)          -- subquery
317085bcdce2Sdrh **     EXISTS (SELECT a FROM b)   -- EXISTS subquery
317185bcdce2Sdrh **
317285bcdce2Sdrh ** The pExpr parameter is the SELECT or EXISTS operator to be coded.
317385bcdce2Sdrh **
3174d86fe44aSdrh ** Return the register that holds the result.  For a multi-column SELECT,
317585bcdce2Sdrh ** the result is stored in a contiguous array of registers and the
317685bcdce2Sdrh ** return value is the register of the left-most result column.
317785bcdce2Sdrh ** Return 0 if an error occurs.
317885bcdce2Sdrh */
317985bcdce2Sdrh #ifndef SQLITE_OMIT_SUBQUERY
318085bcdce2Sdrh int sqlite3CodeSubselect(Parse *pParse, Expr *pExpr){
31812c04131cSdrh   int addrOnce = 0;           /* Address of OP_Once at top of subroutine */
318285bcdce2Sdrh   int rReg = 0;               /* Register storing resulting */
318385bcdce2Sdrh   Select *pSel;               /* SELECT statement to encode */
318485bcdce2Sdrh   SelectDest dest;            /* How to deal with SELECT result */
318585bcdce2Sdrh   int nReg;                   /* Registers to allocate */
318685bcdce2Sdrh   Expr *pLimit;               /* New limit expression */
31872c04131cSdrh 
31882c04131cSdrh   Vdbe *v = pParse->pVdbe;
318985bcdce2Sdrh   assert( v!=0 );
319005428127Sdrh   if( pParse->nErr ) return 0;
3191bd462bccSdrh   testcase( pExpr->op==TK_EXISTS );
3192bd462bccSdrh   testcase( pExpr->op==TK_SELECT );
3193bd462bccSdrh   assert( pExpr->op==TK_EXISTS || pExpr->op==TK_SELECT );
3194*a4eeccdfSdrh   assert( ExprUseXSelect(pExpr) );
3195bd462bccSdrh   pSel = pExpr->x.pSelect;
319685bcdce2Sdrh 
31975198ff57Sdrh   /* If this routine has already been coded, then invoke it as a
31985198ff57Sdrh   ** subroutine. */
31995198ff57Sdrh   if( ExprHasProperty(pExpr, EP_Subrtn) ){
3200bd462bccSdrh     ExplainQueryPlan((pParse, 0, "REUSE SUBQUERY %d", pSel->selId));
32015198ff57Sdrh     sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
32025198ff57Sdrh                       pExpr->y.sub.iAddr);
32035198ff57Sdrh     return pExpr->iTable;
32045198ff57Sdrh   }
32055198ff57Sdrh 
32065198ff57Sdrh   /* Begin coding the subroutine */
32075198ff57Sdrh   ExprSetProperty(pExpr, EP_Subrtn);
32085198ff57Sdrh   pExpr->y.sub.regReturn = ++pParse->nMem;
32095198ff57Sdrh   pExpr->y.sub.iAddr =
32105198ff57Sdrh     sqlite3VdbeAddOp2(v, OP_Integer, 0, pExpr->y.sub.regReturn) + 1;
32115198ff57Sdrh   VdbeComment((v, "return address"));
32125198ff57Sdrh 
321314c4d428Sdrh 
321414c4d428Sdrh   /* The evaluation of the EXISTS/SELECT must be repeated every time it
321514c4d428Sdrh   ** is encountered if any of the following is true:
321614c4d428Sdrh   **
321714c4d428Sdrh   **    *  The right-hand side is a correlated subquery
321814c4d428Sdrh   **    *  The right-hand side is an expression list containing variables
321914c4d428Sdrh   **    *  We are inside a trigger
322014c4d428Sdrh   **
322114c4d428Sdrh   ** If all of the above are false, then we can run this code just once
322214c4d428Sdrh   ** save the results, and reuse the same result on subsequent invocations.
322314c4d428Sdrh   */
322414c4d428Sdrh   if( !ExprHasProperty(pExpr, EP_VarSelect) ){
32252c04131cSdrh     addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
3226fef5208cSdrh   }
3227fef5208cSdrh 
322885bcdce2Sdrh   /* For a SELECT, generate code to put the values for all columns of
322939a11819Sdrh   ** the first row into an array of registers and return the index of
323039a11819Sdrh   ** the first register.
323139a11819Sdrh   **
323239a11819Sdrh   ** If this is an EXISTS, write an integer 0 (not exists) or 1 (exists)
323339a11819Sdrh   ** into a register and return that register number.
323439a11819Sdrh   **
323539a11819Sdrh   ** In both cases, the query is augmented with "LIMIT 1".  Any
323639a11819Sdrh   ** preexisting limit is discarded in place of the new LIMIT 1.
3237fef5208cSdrh   */
3238bd462bccSdrh   ExplainQueryPlan((pParse, 1, "%sSCALAR SUBQUERY %d",
3239bd462bccSdrh         addrOnce?"":"CORRELATED ", pSel->selId));
324071c57db0Sdan   nReg = pExpr->op==TK_SELECT ? pSel->pEList->nExpr : 1;
324171c57db0Sdan   sqlite3SelectDestInit(&dest, 0, pParse->nMem+1);
324271c57db0Sdan   pParse->nMem += nReg;
324351522cd3Sdrh   if( pExpr->op==TK_SELECT ){
32446c8c8ce0Sdanielk1977     dest.eDest = SRT_Mem;
324553932ce8Sdrh     dest.iSdst = dest.iSDParm;
324671c57db0Sdan     dest.nSdst = nReg;
324771c57db0Sdan     sqlite3VdbeAddOp3(v, OP_Null, 0, dest.iSDParm, dest.iSDParm+nReg-1);
3248d4e70ebdSdrh     VdbeComment((v, "Init subquery result"));
324951522cd3Sdrh   }else{
32506c8c8ce0Sdanielk1977     dest.eDest = SRT_Exists;
32512b596da8Sdrh     sqlite3VdbeAddOp2(v, OP_Integer, 0, dest.iSDParm);
3252d4e70ebdSdrh     VdbeComment((v, "Init EXISTS result"));
325351522cd3Sdrh   }
32548c0833fbSdrh   if( pSel->pLimit ){
32557ca1347fSdrh     /* The subquery already has a limit.  If the pre-existing limit is X
32567ca1347fSdrh     ** then make the new limit X<>0 so that the new limit is either 1 or 0 */
32577ca1347fSdrh     sqlite3 *db = pParse->db;
32585776ee5cSdrh     pLimit = sqlite3Expr(db, TK_INTEGER, "0");
32597ca1347fSdrh     if( pLimit ){
32607ca1347fSdrh       pLimit->affExpr = SQLITE_AFF_NUMERIC;
32617ca1347fSdrh       pLimit = sqlite3PExpr(pParse, TK_NE,
32627ca1347fSdrh                             sqlite3ExprDup(db, pSel->pLimit->pLeft, 0), pLimit);
32637ca1347fSdrh     }
32647ca1347fSdrh     sqlite3ExprDelete(db, pSel->pLimit->pLeft);
32658c0833fbSdrh     pSel->pLimit->pLeft = pLimit;
32668c0833fbSdrh   }else{
32677ca1347fSdrh     /* If there is no pre-existing limit add a limit of 1 */
32685776ee5cSdrh     pLimit = sqlite3Expr(pParse->db, TK_INTEGER, "1");
32698c0833fbSdrh     pSel->pLimit = sqlite3PExpr(pParse, TK_LIMIT, pLimit, 0);
32708c0833fbSdrh   }
327148b5b041Sdrh   pSel->iLimit = 0;
32727d10d5a6Sdrh   if( sqlite3Select(pParse, pSel, &dest) ){
3273bf7f3a00Sdrh     if( pParse->nErr ){
3274bf7f3a00Sdrh       pExpr->op2 = pExpr->op;
3275bf7f3a00Sdrh       pExpr->op = TK_ERROR;
3276bf7f3a00Sdrh     }
32771450bc6eSdrh     return 0;
327894ccde58Sdrh   }
32792c04131cSdrh   pExpr->iTable = rReg = dest.iSDParm;
3280ebb6a65dSdrh   ExprSetVVAProperty(pExpr, EP_NoReduce);
32812c04131cSdrh   if( addrOnce ){
32822c04131cSdrh     sqlite3VdbeJumpHere(v, addrOnce);
328314c4d428Sdrh   }
3284fc976065Sdanielk1977 
32852c04131cSdrh   /* Subroutine return */
32862c04131cSdrh   sqlite3VdbeAddOp1(v, OP_Return, pExpr->y.sub.regReturn);
32872c04131cSdrh   sqlite3VdbeChangeP1(v, pExpr->y.sub.iAddr-1, sqlite3VdbeCurrentAddr(v)-1);
32886d2566dfSdrh   sqlite3ClearTempRegCache(pParse);
32891450bc6eSdrh   return rReg;
3290cce7d176Sdrh }
329151522cd3Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
3292cce7d176Sdrh 
3293e3365e6cSdrh #ifndef SQLITE_OMIT_SUBQUERY
3294e3365e6cSdrh /*
32957b35a77bSdan ** Expr pIn is an IN(...) expression. This function checks that the
32967b35a77bSdan ** sub-select on the RHS of the IN() operator has the same number of
32977b35a77bSdan ** columns as the vector on the LHS. Or, if the RHS of the IN() is not
32987b35a77bSdan ** a sub-query, that the LHS is a vector of size 1.
32997b35a77bSdan */
33007b35a77bSdan int sqlite3ExprCheckIN(Parse *pParse, Expr *pIn){
33017b35a77bSdan   int nVector = sqlite3ExprVectorSize(pIn->pLeft);
3302*a4eeccdfSdrh   if( ExprUseXSelect(pIn) && !pParse->db->mallocFailed ){
33037b35a77bSdan     if( nVector!=pIn->x.pSelect->pEList->nExpr ){
33047b35a77bSdan       sqlite3SubselectError(pParse, pIn->x.pSelect->pEList->nExpr, nVector);
33057b35a77bSdan       return 1;
33067b35a77bSdan     }
33077b35a77bSdan   }else if( nVector!=1 ){
330844c5604cSdan     sqlite3VectorErrorMsg(pParse, pIn->pLeft);
33097b35a77bSdan     return 1;
33107b35a77bSdan   }
33117b35a77bSdan   return 0;
33127b35a77bSdan }
33137b35a77bSdan #endif
33147b35a77bSdan 
33157b35a77bSdan #ifndef SQLITE_OMIT_SUBQUERY
33167b35a77bSdan /*
3317e3365e6cSdrh ** Generate code for an IN expression.
3318e3365e6cSdrh **
3319e3365e6cSdrh **      x IN (SELECT ...)
3320e3365e6cSdrh **      x IN (value, value, ...)
3321e3365e6cSdrh **
3322ecb87ac8Sdrh ** The left-hand side (LHS) is a scalar or vector expression.  The
3323e347d3e8Sdrh ** right-hand side (RHS) is an array of zero or more scalar values, or a
3324e347d3e8Sdrh ** subquery.  If the RHS is a subquery, the number of result columns must
3325e347d3e8Sdrh ** match the number of columns in the vector on the LHS.  If the RHS is
3326e347d3e8Sdrh ** a list of values, the LHS must be a scalar.
3327e347d3e8Sdrh **
3328e347d3e8Sdrh ** The IN operator is true if the LHS value is contained within the RHS.
3329e347d3e8Sdrh ** The result is false if the LHS is definitely not in the RHS.  The
3330e347d3e8Sdrh ** result is NULL if the presence of the LHS in the RHS cannot be
3331e347d3e8Sdrh ** determined due to NULLs.
3332e3365e6cSdrh **
33336be515ebSdrh ** This routine generates code that jumps to destIfFalse if the LHS is not
3334e3365e6cSdrh ** contained within the RHS.  If due to NULLs we cannot determine if the LHS
3335e3365e6cSdrh ** is contained in the RHS then jump to destIfNull.  If the LHS is contained
3336e3365e6cSdrh ** within the RHS then fall through.
3337ecb87ac8Sdrh **
3338ecb87ac8Sdrh ** See the separate in-operator.md documentation file in the canonical
3339ecb87ac8Sdrh ** SQLite source tree for additional information.
3340e3365e6cSdrh */
3341e3365e6cSdrh static void sqlite3ExprCodeIN(
3342e3365e6cSdrh   Parse *pParse,        /* Parsing and code generating context */
3343e3365e6cSdrh   Expr *pExpr,          /* The IN expression */
3344e3365e6cSdrh   int destIfFalse,      /* Jump here if LHS is not contained in the RHS */
3345e3365e6cSdrh   int destIfNull        /* Jump here if the results are unknown due to NULLs */
3346e3365e6cSdrh ){
3347e3365e6cSdrh   int rRhsHasNull = 0;  /* Register that is true if RHS contains NULL values */
3348e3365e6cSdrh   int eType;            /* Type of the RHS */
3349e347d3e8Sdrh   int rLhs;             /* Register(s) holding the LHS values */
3350e347d3e8Sdrh   int rLhsOrig;         /* LHS values prior to reordering by aiMap[] */
3351e3365e6cSdrh   Vdbe *v;              /* Statement under construction */
3352ba00e30aSdan   int *aiMap = 0;       /* Map from vector field to index column */
3353ba00e30aSdan   char *zAff = 0;       /* Affinity string for comparisons */
3354ecb87ac8Sdrh   int nVector;          /* Size of vectors for this IN operator */
335512abf408Sdrh   int iDummy;           /* Dummy parameter to exprCodeVector() */
3356e347d3e8Sdrh   Expr *pLeft;          /* The LHS of the IN operator */
3357ecb87ac8Sdrh   int i;                /* loop counter */
3358e347d3e8Sdrh   int destStep2;        /* Where to jump when NULLs seen in step 2 */
3359e347d3e8Sdrh   int destStep6 = 0;    /* Start of code for Step 6 */
3360e347d3e8Sdrh   int addrTruthOp;      /* Address of opcode that determines the IN is true */
3361e347d3e8Sdrh   int destNotNull;      /* Jump here if a comparison is not true in step 6 */
3362e347d3e8Sdrh   int addrTop;          /* Top of the step-6 loop */
33632c04131cSdrh   int iTab = 0;         /* Index to use */
3364c59b4acfSdan   u8 okConstFactor = pParse->okConstFactor;
3365e3365e6cSdrh 
3366e7375bfaSdrh   assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
3367e347d3e8Sdrh   pLeft = pExpr->pLeft;
33687b35a77bSdan   if( sqlite3ExprCheckIN(pParse, pExpr) ) return;
3369553168c7Sdan   zAff = exprINAffinity(pParse, pExpr);
3370ba00e30aSdan   nVector = sqlite3ExprVectorSize(pExpr->pLeft);
3371ba00e30aSdan   aiMap = (int*)sqlite3DbMallocZero(
3372ba00e30aSdan       pParse->db, nVector*(sizeof(int) + sizeof(char)) + 1
3373ba00e30aSdan   );
3374e347d3e8Sdrh   if( pParse->db->mallocFailed ) goto sqlite3ExprCodeIN_oom_error;
33757b35a77bSdan 
3376ba00e30aSdan   /* Attempt to compute the RHS. After this step, if anything other than
33772c04131cSdrh   ** IN_INDEX_NOOP is returned, the table opened with cursor iTab
3378ba00e30aSdan   ** contains the values that make up the RHS. If IN_INDEX_NOOP is returned,
3379ba00e30aSdan   ** the RHS has not yet been coded.  */
3380e3365e6cSdrh   v = pParse->pVdbe;
3381e3365e6cSdrh   assert( v!=0 );       /* OOM detected prior to this routine */
3382e3365e6cSdrh   VdbeNoopComment((v, "begin IN expr"));
3383bb53ecb1Sdrh   eType = sqlite3FindInIndex(pParse, pExpr,
3384bb53ecb1Sdrh                              IN_INDEX_MEMBERSHIP | IN_INDEX_NOOP_OK,
33852c04131cSdrh                              destIfFalse==destIfNull ? 0 : &rRhsHasNull,
33862c04131cSdrh                              aiMap, &iTab);
3387e3365e6cSdrh 
3388ba00e30aSdan   assert( pParse->nErr || nVector==1 || eType==IN_INDEX_EPH
3389ba00e30aSdan        || eType==IN_INDEX_INDEX_ASC || eType==IN_INDEX_INDEX_DESC
3390ba00e30aSdan   );
3391ecb87ac8Sdrh #ifdef SQLITE_DEBUG
3392ecb87ac8Sdrh   /* Confirm that aiMap[] contains nVector integer values between 0 and
3393ecb87ac8Sdrh   ** nVector-1. */
3394ecb87ac8Sdrh   for(i=0; i<nVector; i++){
3395ecb87ac8Sdrh     int j, cnt;
3396ecb87ac8Sdrh     for(cnt=j=0; j<nVector; j++) if( aiMap[j]==i ) cnt++;
3397ecb87ac8Sdrh     assert( cnt==1 );
3398ecb87ac8Sdrh   }
3399ecb87ac8Sdrh #endif
3400e3365e6cSdrh 
3401ba00e30aSdan   /* Code the LHS, the <expr> from "<expr> IN (...)". If the LHS is a
3402ba00e30aSdan   ** vector, then it is stored in an array of nVector registers starting
3403ba00e30aSdan   ** at r1.
3404e347d3e8Sdrh   **
3405e347d3e8Sdrh   ** sqlite3FindInIndex() might have reordered the fields of the LHS vector
3406e347d3e8Sdrh   ** so that the fields are in the same order as an existing index.   The
3407e347d3e8Sdrh   ** aiMap[] array contains a mapping from the original LHS field order to
3408e347d3e8Sdrh   ** the field order that matches the RHS index.
3409c59b4acfSdan   **
3410c59b4acfSdan   ** Avoid factoring the LHS of the IN(...) expression out of the loop,
3411c59b4acfSdan   ** even if it is constant, as OP_Affinity may be used on the register
3412c59b4acfSdan   ** by code generated below.  */
3413c59b4acfSdan   assert( pParse->okConstFactor==okConstFactor );
3414c59b4acfSdan   pParse->okConstFactor = 0;
3415e347d3e8Sdrh   rLhsOrig = exprCodeVector(pParse, pLeft, &iDummy);
3416c59b4acfSdan   pParse->okConstFactor = okConstFactor;
3417e347d3e8Sdrh   for(i=0; i<nVector && aiMap[i]==i; i++){} /* Are LHS fields reordered? */
3418ecb87ac8Sdrh   if( i==nVector ){
3419e347d3e8Sdrh     /* LHS fields are not reordered */
3420e347d3e8Sdrh     rLhs = rLhsOrig;
3421ecb87ac8Sdrh   }else{
3422ecb87ac8Sdrh     /* Need to reorder the LHS fields according to aiMap */
3423e347d3e8Sdrh     rLhs = sqlite3GetTempRange(pParse, nVector);
3424ba00e30aSdan     for(i=0; i<nVector; i++){
3425e347d3e8Sdrh       sqlite3VdbeAddOp3(v, OP_Copy, rLhsOrig+i, rLhs+aiMap[i], 0);
3426ba00e30aSdan     }
3427ecb87ac8Sdrh   }
3428e3365e6cSdrh 
3429bb53ecb1Sdrh   /* If sqlite3FindInIndex() did not find or create an index that is
3430bb53ecb1Sdrh   ** suitable for evaluating the IN operator, then evaluate using a
3431bb53ecb1Sdrh   ** sequence of comparisons.
3432e347d3e8Sdrh   **
3433e347d3e8Sdrh   ** This is step (1) in the in-operator.md optimized algorithm.
3434bb53ecb1Sdrh   */
3435bb53ecb1Sdrh   if( eType==IN_INDEX_NOOP ){
3436*a4eeccdfSdrh     ExprList *pList;
3437*a4eeccdfSdrh     CollSeq *pColl;
3438ec4ccdbcSdrh     int labelOk = sqlite3VdbeMakeLabel(pParse);
3439bb53ecb1Sdrh     int r2, regToFree;
3440bb53ecb1Sdrh     int regCkNull = 0;
3441bb53ecb1Sdrh     int ii;
3442*a4eeccdfSdrh     assert( ExprUseXList(pExpr) );
3443*a4eeccdfSdrh     pList = pExpr->x.pList;
3444*a4eeccdfSdrh     pColl = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
3445bb53ecb1Sdrh     if( destIfNull!=destIfFalse ){
3446bb53ecb1Sdrh       regCkNull = sqlite3GetTempReg(pParse);
3447e347d3e8Sdrh       sqlite3VdbeAddOp3(v, OP_BitAnd, rLhs, rLhs, regCkNull);
3448bb53ecb1Sdrh     }
3449bb53ecb1Sdrh     for(ii=0; ii<pList->nExpr; ii++){
34504fc83654Sdrh       r2 = sqlite3ExprCodeTemp(pParse, pList->a[ii].pExpr, &regToFree);
3451a976979bSdrh       if( regCkNull && sqlite3ExprCanBeNull(pList->a[ii].pExpr) ){
3452bb53ecb1Sdrh         sqlite3VdbeAddOp3(v, OP_BitAnd, regCkNull, r2, regCkNull);
3453bb53ecb1Sdrh       }
3454f6ea97eaSdrh       sqlite3ReleaseTempReg(pParse, regToFree);
3455bb53ecb1Sdrh       if( ii<pList->nExpr-1 || destIfNull!=destIfFalse ){
34564799488eSdrh         int op = rLhs!=r2 ? OP_Eq : OP_NotNull;
34574799488eSdrh         sqlite3VdbeAddOp4(v, op, rLhs, labelOk, r2,
34584336b0e6Sdrh                           (void*)pColl, P4_COLLSEQ);
34594799488eSdrh         VdbeCoverageIf(v, ii<pList->nExpr-1 && op==OP_Eq);
34604799488eSdrh         VdbeCoverageIf(v, ii==pList->nExpr-1 && op==OP_Eq);
34614799488eSdrh         VdbeCoverageIf(v, ii<pList->nExpr-1 && op==OP_NotNull);
34624799488eSdrh         VdbeCoverageIf(v, ii==pList->nExpr-1 && op==OP_NotNull);
3463ba00e30aSdan         sqlite3VdbeChangeP5(v, zAff[0]);
3464bb53ecb1Sdrh       }else{
34654799488eSdrh         int op = rLhs!=r2 ? OP_Ne : OP_IsNull;
3466bb53ecb1Sdrh         assert( destIfNull==destIfFalse );
34674799488eSdrh         sqlite3VdbeAddOp4(v, op, rLhs, destIfFalse, r2,
34684799488eSdrh                           (void*)pColl, P4_COLLSEQ);
34694799488eSdrh         VdbeCoverageIf(v, op==OP_Ne);
34704799488eSdrh         VdbeCoverageIf(v, op==OP_IsNull);
3471ba00e30aSdan         sqlite3VdbeChangeP5(v, zAff[0] | SQLITE_JUMPIFNULL);
3472bb53ecb1Sdrh       }
3473bb53ecb1Sdrh     }
3474bb53ecb1Sdrh     if( regCkNull ){
3475bb53ecb1Sdrh       sqlite3VdbeAddOp2(v, OP_IsNull, regCkNull, destIfNull); VdbeCoverage(v);
3476076e85f5Sdrh       sqlite3VdbeGoto(v, destIfFalse);
3477bb53ecb1Sdrh     }
3478bb53ecb1Sdrh     sqlite3VdbeResolveLabel(v, labelOk);
3479bb53ecb1Sdrh     sqlite3ReleaseTempReg(pParse, regCkNull);
3480e347d3e8Sdrh     goto sqlite3ExprCodeIN_finished;
3481e347d3e8Sdrh   }
3482bb53ecb1Sdrh 
3483e347d3e8Sdrh   /* Step 2: Check to see if the LHS contains any NULL columns.  If the
3484e347d3e8Sdrh   ** LHS does contain NULLs then the result must be either FALSE or NULL.
3485e347d3e8Sdrh   ** We will then skip the binary search of the RHS.
3486e347d3e8Sdrh   */
3487094430ebSdrh   if( destIfNull==destIfFalse ){
3488e347d3e8Sdrh     destStep2 = destIfFalse;
3489e347d3e8Sdrh   }else{
3490ec4ccdbcSdrh     destStep2 = destStep6 = sqlite3VdbeMakeLabel(pParse);
3491e347d3e8Sdrh   }
34924eac5f04Sdrh   if( pParse->nErr ) goto sqlite3ExprCodeIN_finished;
3493d49fd4e8Sdan   for(i=0; i<nVector; i++){
3494fc7f27b9Sdrh     Expr *p = sqlite3VectorFieldSubexpr(pExpr->pLeft, i);
34954c4a2572Sdrh     if( pParse->db->mallocFailed ) goto sqlite3ExprCodeIN_oom_error;
3496d49fd4e8Sdan     if( sqlite3ExprCanBeNull(p) ){
3497e347d3e8Sdrh       sqlite3VdbeAddOp2(v, OP_IsNull, rLhs+i, destStep2);
3498471b4b92Sdrh       VdbeCoverage(v);
3499d49fd4e8Sdan     }
3500d49fd4e8Sdan   }
3501e3365e6cSdrh 
3502e347d3e8Sdrh   /* Step 3.  The LHS is now known to be non-NULL.  Do the binary search
3503e347d3e8Sdrh   ** of the RHS using the LHS as a probe.  If found, the result is
3504e347d3e8Sdrh   ** true.
3505e347d3e8Sdrh   */
3506e3365e6cSdrh   if( eType==IN_INDEX_ROWID ){
3507e347d3e8Sdrh     /* In this case, the RHS is the ROWID of table b-tree and so we also
3508e347d3e8Sdrh     ** know that the RHS is non-NULL.  Hence, we combine steps 3 and 4
3509e347d3e8Sdrh     ** into a single opcode. */
35102c04131cSdrh     sqlite3VdbeAddOp3(v, OP_SeekRowid, iTab, destIfFalse, rLhs);
3511688852abSdrh     VdbeCoverage(v);
3512e347d3e8Sdrh     addrTruthOp = sqlite3VdbeAddOp0(v, OP_Goto);  /* Return True */
35137b35a77bSdan   }else{
3514e347d3e8Sdrh     sqlite3VdbeAddOp4(v, OP_Affinity, rLhs, nVector, 0, zAff, nVector);
3515e347d3e8Sdrh     if( destIfFalse==destIfNull ){
3516e347d3e8Sdrh       /* Combine Step 3 and Step 5 into a single opcode */
35172c04131cSdrh       sqlite3VdbeAddOp4Int(v, OP_NotFound, iTab, destIfFalse,
3518e347d3e8Sdrh                            rLhs, nVector); VdbeCoverage(v);
3519e347d3e8Sdrh       goto sqlite3ExprCodeIN_finished;
3520e347d3e8Sdrh     }
3521e347d3e8Sdrh     /* Ordinary Step 3, for the case where FALSE and NULL are distinct */
35222c04131cSdrh     addrTruthOp = sqlite3VdbeAddOp4Int(v, OP_Found, iTab, 0,
3523e347d3e8Sdrh                                       rLhs, nVector); VdbeCoverage(v);
3524e347d3e8Sdrh   }
3525ba00e30aSdan 
3526e347d3e8Sdrh   /* Step 4.  If the RHS is known to be non-NULL and we did not find
3527e347d3e8Sdrh   ** an match on the search above, then the result must be FALSE.
3528e347d3e8Sdrh   */
3529e347d3e8Sdrh   if( rRhsHasNull && nVector==1 ){
3530e347d3e8Sdrh     sqlite3VdbeAddOp2(v, OP_NotNull, rRhsHasNull, destIfFalse);
3531471b4b92Sdrh     VdbeCoverage(v);
3532e347d3e8Sdrh   }
35337b35a77bSdan 
3534e347d3e8Sdrh   /* Step 5.  If we do not care about the difference between NULL and
3535e347d3e8Sdrh   ** FALSE, then just return false.
3536e347d3e8Sdrh   */
3537e347d3e8Sdrh   if( destIfFalse==destIfNull ) sqlite3VdbeGoto(v, destIfFalse);
3538e347d3e8Sdrh 
3539e347d3e8Sdrh   /* Step 6: Loop through rows of the RHS.  Compare each row to the LHS.
3540e347d3e8Sdrh   ** If any comparison is NULL, then the result is NULL.  If all
3541e347d3e8Sdrh   ** comparisons are FALSE then the final result is FALSE.
3542e347d3e8Sdrh   **
3543e347d3e8Sdrh   ** For a scalar LHS, it is sufficient to check just the first row
3544e347d3e8Sdrh   ** of the RHS.
3545e347d3e8Sdrh   */
3546e347d3e8Sdrh   if( destStep6 ) sqlite3VdbeResolveLabel(v, destStep6);
35472c04131cSdrh   addrTop = sqlite3VdbeAddOp2(v, OP_Rewind, iTab, destIfFalse);
3548471b4b92Sdrh   VdbeCoverage(v);
3549e347d3e8Sdrh   if( nVector>1 ){
3550ec4ccdbcSdrh     destNotNull = sqlite3VdbeMakeLabel(pParse);
3551e347d3e8Sdrh   }else{
3552e347d3e8Sdrh     /* For nVector==1, combine steps 6 and 7 by immediately returning
3553e347d3e8Sdrh     ** FALSE if the first comparison is not NULL */
3554e347d3e8Sdrh     destNotNull = destIfFalse;
3555e347d3e8Sdrh   }
3556ba00e30aSdan   for(i=0; i<nVector; i++){
3557ba00e30aSdan     Expr *p;
3558ba00e30aSdan     CollSeq *pColl;
3559e347d3e8Sdrh     int r3 = sqlite3GetTempReg(pParse);
3560fc7f27b9Sdrh     p = sqlite3VectorFieldSubexpr(pLeft, i);
3561ba00e30aSdan     pColl = sqlite3ExprCollSeq(pParse, p);
35622c04131cSdrh     sqlite3VdbeAddOp3(v, OP_Column, iTab, i, r3);
3563e347d3e8Sdrh     sqlite3VdbeAddOp4(v, OP_Ne, rLhs+i, destNotNull, r3,
356418016ad2Sdrh                       (void*)pColl, P4_COLLSEQ);
3565471b4b92Sdrh     VdbeCoverage(v);
3566e347d3e8Sdrh     sqlite3ReleaseTempReg(pParse, r3);
35677b35a77bSdan   }
35687b35a77bSdan   sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfNull);
3569e347d3e8Sdrh   if( nVector>1 ){
3570e347d3e8Sdrh     sqlite3VdbeResolveLabel(v, destNotNull);
35712c04131cSdrh     sqlite3VdbeAddOp2(v, OP_Next, iTab, addrTop+1);
357218016ad2Sdrh     VdbeCoverage(v);
3573e347d3e8Sdrh 
3574e347d3e8Sdrh     /* Step 7:  If we reach this point, we know that the result must
3575e347d3e8Sdrh     ** be false. */
357618016ad2Sdrh     sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfFalse);
35777b35a77bSdan   }
35787b35a77bSdan 
3579e347d3e8Sdrh   /* Jumps here in order to return true. */
3580e347d3e8Sdrh   sqlite3VdbeJumpHere(v, addrTruthOp);
3581e3365e6cSdrh 
3582e347d3e8Sdrh sqlite3ExprCodeIN_finished:
3583e347d3e8Sdrh   if( rLhs!=rLhsOrig ) sqlite3ReleaseTempReg(pParse, rLhs);
3584ecb87ac8Sdrh   VdbeComment((v, "end IN expr"));
3585e347d3e8Sdrh sqlite3ExprCodeIN_oom_error:
3586ba00e30aSdan   sqlite3DbFree(pParse->db, aiMap);
3587553168c7Sdan   sqlite3DbFree(pParse->db, zAff);
3588e3365e6cSdrh }
3589e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
3590e3365e6cSdrh 
359113573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
3592598f1340Sdrh /*
3593598f1340Sdrh ** Generate an instruction that will put the floating point
35949cbf3425Sdrh ** value described by z[0..n-1] into register iMem.
35950cf19ed8Sdrh **
35960cf19ed8Sdrh ** The z[] string will probably not be zero-terminated.  But the
35970cf19ed8Sdrh ** z[n] character is guaranteed to be something that does not look
35980cf19ed8Sdrh ** like the continuation of the number.
3599598f1340Sdrh */
3600b7916a78Sdrh static void codeReal(Vdbe *v, const char *z, int negateFlag, int iMem){
3601fd773cf9Sdrh   if( ALWAYS(z!=0) ){
3602598f1340Sdrh     double value;
36039339da1fSdrh     sqlite3AtoF(z, &value, sqlite3Strlen30(z), SQLITE_UTF8);
3604d0015161Sdrh     assert( !sqlite3IsNaN(value) ); /* The new AtoF never returns NaN */
3605598f1340Sdrh     if( negateFlag ) value = -value;
360697bae794Sdrh     sqlite3VdbeAddOp4Dup8(v, OP_Real, 0, iMem, 0, (u8*)&value, P4_REAL);
3607598f1340Sdrh   }
3608598f1340Sdrh }
360913573c71Sdrh #endif
3610598f1340Sdrh 
3611598f1340Sdrh 
3612598f1340Sdrh /*
3613fec19aadSdrh ** Generate an instruction that will put the integer describe by
36149cbf3425Sdrh ** text z[0..n-1] into register iMem.
36150cf19ed8Sdrh **
36165f1d6b61Sshaneh ** Expr.u.zToken is always UTF8 and zero-terminated.
3617fec19aadSdrh */
361813573c71Sdrh static void codeInteger(Parse *pParse, Expr *pExpr, int negFlag, int iMem){
361913573c71Sdrh   Vdbe *v = pParse->pVdbe;
362092b01d53Sdrh   if( pExpr->flags & EP_IntValue ){
362133e619fcSdrh     int i = pExpr->u.iValue;
3622d50ffc41Sdrh     assert( i>=0 );
362392b01d53Sdrh     if( negFlag ) i = -i;
362492b01d53Sdrh     sqlite3VdbeAddOp2(v, OP_Integer, i, iMem);
3625fd773cf9Sdrh   }else{
36265f1d6b61Sshaneh     int c;
36275f1d6b61Sshaneh     i64 value;
3628fd773cf9Sdrh     const char *z = pExpr->u.zToken;
3629fd773cf9Sdrh     assert( z!=0 );
36309296c18aSdrh     c = sqlite3DecOrHexToI64(z, &value);
363184d4f1a3Sdrh     if( (c==3 && !negFlag) || (c==2) || (negFlag && value==SMALLEST_INT64)){
363213573c71Sdrh #ifdef SQLITE_OMIT_FLOATING_POINT
363313573c71Sdrh       sqlite3ErrorMsg(pParse, "oversized integer: %s%s", negFlag ? "-" : "", z);
363413573c71Sdrh #else
36351b7ddc59Sdrh #ifndef SQLITE_OMIT_HEX_INTEGER
36369296c18aSdrh       if( sqlite3_strnicmp(z,"0x",2)==0 ){
363777320ea4Sdrh         sqlite3ErrorMsg(pParse, "hex literal too big: %s%s", negFlag?"-":"",z);
36381b7ddc59Sdrh       }else
36391b7ddc59Sdrh #endif
36401b7ddc59Sdrh       {
3641b7916a78Sdrh         codeReal(v, z, negFlag, iMem);
36429296c18aSdrh       }
364313573c71Sdrh #endif
364477320ea4Sdrh     }else{
364584d4f1a3Sdrh       if( negFlag ){ value = c==3 ? SMALLEST_INT64 : -value; }
364677320ea4Sdrh       sqlite3VdbeAddOp4Dup8(v, OP_Int64, 0, iMem, 0, (u8*)&value, P4_INT64);
3647fec19aadSdrh     }
3648fec19aadSdrh   }
3649c9cf901dSdanielk1977 }
3650fec19aadSdrh 
36515cd79239Sdrh 
36521f9ca2c8Sdrh /* Generate code that will load into register regOut a value that is
36531f9ca2c8Sdrh ** appropriate for the iIdxCol-th column of index pIdx.
36541f9ca2c8Sdrh */
36551f9ca2c8Sdrh void sqlite3ExprCodeLoadIndexColumn(
36561f9ca2c8Sdrh   Parse *pParse,  /* The parsing context */
36571f9ca2c8Sdrh   Index *pIdx,    /* The index whose column is to be loaded */
36581f9ca2c8Sdrh   int iTabCur,    /* Cursor pointing to a table row */
36591f9ca2c8Sdrh   int iIdxCol,    /* The column of the index to be loaded */
36601f9ca2c8Sdrh   int regOut      /* Store the index column value in this register */
36611f9ca2c8Sdrh ){
36621f9ca2c8Sdrh   i16 iTabCol = pIdx->aiColumn[iIdxCol];
36634b92f98cSdrh   if( iTabCol==XN_EXPR ){
36641f9ca2c8Sdrh     assert( pIdx->aColExpr );
36651f9ca2c8Sdrh     assert( pIdx->aColExpr->nExpr>iIdxCol );
36663e34eabcSdrh     pParse->iSelfTab = iTabCur + 1;
36671c75c9d7Sdrh     sqlite3ExprCodeCopy(pParse, pIdx->aColExpr->a[iIdxCol].pExpr, regOut);
36683e34eabcSdrh     pParse->iSelfTab = 0;
36694b92f98cSdrh   }else{
36706df9c4b9Sdrh     sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pIdx->pTable, iTabCur,
36714b92f98cSdrh                                     iTabCol, regOut);
36724b92f98cSdrh   }
36731f9ca2c8Sdrh }
36741f9ca2c8Sdrh 
3675e70fa7feSdrh #ifndef SQLITE_OMIT_GENERATED_COLUMNS
3676e70fa7feSdrh /*
3677e70fa7feSdrh ** Generate code that will compute the value of generated column pCol
3678e70fa7feSdrh ** and store the result in register regOut
3679e70fa7feSdrh */
3680e70fa7feSdrh void sqlite3ExprCodeGeneratedColumn(
368179cf2b71Sdrh   Parse *pParse,     /* Parsing context */
368279cf2b71Sdrh   Table *pTab,       /* Table containing the generated column */
368379cf2b71Sdrh   Column *pCol,      /* The generated column */
368479cf2b71Sdrh   int regOut         /* Put the result in this register */
3685e70fa7feSdrh ){
36864dad7ed5Sdrh   int iAddr;
36874dad7ed5Sdrh   Vdbe *v = pParse->pVdbe;
36884dad7ed5Sdrh   assert( v!=0 );
36894dad7ed5Sdrh   assert( pParse->iSelfTab!=0 );
36904dad7ed5Sdrh   if( pParse->iSelfTab>0 ){
36914dad7ed5Sdrh     iAddr = sqlite3VdbeAddOp3(v, OP_IfNullRow, pParse->iSelfTab-1, 0, regOut);
36924dad7ed5Sdrh   }else{
36934dad7ed5Sdrh     iAddr = 0;
36944dad7ed5Sdrh   }
369579cf2b71Sdrh   sqlite3ExprCodeCopy(pParse, sqlite3ColumnExpr(pTab,pCol), regOut);
3696e70fa7feSdrh   if( pCol->affinity>=SQLITE_AFF_TEXT ){
36974dad7ed5Sdrh     sqlite3VdbeAddOp4(v, OP_Affinity, regOut, 1, 0, &pCol->affinity, 1);
3698e70fa7feSdrh   }
36994dad7ed5Sdrh   if( iAddr ) sqlite3VdbeJumpHere(v, iAddr);
3700e70fa7feSdrh }
3701e70fa7feSdrh #endif /* SQLITE_OMIT_GENERATED_COLUMNS */
3702e70fa7feSdrh 
37035cd79239Sdrh /*
37045c092e8aSdrh ** Generate code to extract the value of the iCol-th column of a table.
37055c092e8aSdrh */
37065c092e8aSdrh void sqlite3ExprCodeGetColumnOfTable(
37076df9c4b9Sdrh   Vdbe *v,        /* Parsing context */
37085c092e8aSdrh   Table *pTab,    /* The table containing the value */
3709313619f5Sdrh   int iTabCur,    /* The table cursor.  Or the PK cursor for WITHOUT ROWID */
37105c092e8aSdrh   int iCol,       /* Index of the column to extract */
3711313619f5Sdrh   int regOut      /* Extract the value into this register */
37125c092e8aSdrh ){
3713ab45fc04Sdrh   Column *pCol;
371481f7b372Sdrh   assert( v!=0 );
3715aca19e19Sdrh   if( pTab==0 ){
3716aca19e19Sdrh     sqlite3VdbeAddOp3(v, OP_Column, iTabCur, iCol, regOut);
3717aca19e19Sdrh     return;
3718aca19e19Sdrh   }
37195c092e8aSdrh   if( iCol<0 || iCol==pTab->iPKey ){
37205c092e8aSdrh     sqlite3VdbeAddOp2(v, OP_Rowid, iTabCur, regOut);
37215c092e8aSdrh   }else{
372281f7b372Sdrh     int op;
372381f7b372Sdrh     int x;
372481f7b372Sdrh     if( IsVirtual(pTab) ){
372581f7b372Sdrh       op = OP_VColumn;
372681f7b372Sdrh       x = iCol;
372781f7b372Sdrh #ifndef SQLITE_OMIT_GENERATED_COLUMNS
3728ab45fc04Sdrh     }else if( (pCol = &pTab->aCol[iCol])->colFlags & COLFLAG_VIRTUAL ){
37296df9c4b9Sdrh       Parse *pParse = sqlite3VdbeParser(v);
3730ab45fc04Sdrh       if( pCol->colFlags & COLFLAG_BUSY ){
3731cf9d36d1Sdrh         sqlite3ErrorMsg(pParse, "generated column loop on \"%s\"",
3732cf9d36d1Sdrh                         pCol->zCnName);
3733ab45fc04Sdrh       }else{
373481f7b372Sdrh         int savedSelfTab = pParse->iSelfTab;
3735ab45fc04Sdrh         pCol->colFlags |= COLFLAG_BUSY;
373681f7b372Sdrh         pParse->iSelfTab = iTabCur+1;
373779cf2b71Sdrh         sqlite3ExprCodeGeneratedColumn(pParse, pTab, pCol, regOut);
373881f7b372Sdrh         pParse->iSelfTab = savedSelfTab;
3739ab45fc04Sdrh         pCol->colFlags &= ~COLFLAG_BUSY;
3740ab45fc04Sdrh       }
374181f7b372Sdrh       return;
374281f7b372Sdrh #endif
374381f7b372Sdrh     }else if( !HasRowid(pTab) ){
3744c5f808d8Sdrh       testcase( iCol!=sqlite3TableColumnToStorage(pTab, iCol) );
3745b9bcf7caSdrh       x = sqlite3TableColumnToIndex(sqlite3PrimaryKeyIndex(pTab), iCol);
374681f7b372Sdrh       op = OP_Column;
374781f7b372Sdrh     }else{
3748b9bcf7caSdrh       x = sqlite3TableColumnToStorage(pTab,iCol);
3749c5f808d8Sdrh       testcase( x!=iCol );
375081f7b372Sdrh       op = OP_Column;
3751ee0ec8e1Sdrh     }
3752ee0ec8e1Sdrh     sqlite3VdbeAddOp3(v, op, iTabCur, x, regOut);
37535c092e8aSdrh     sqlite3ColumnDefault(v, pTab, iCol, regOut);
37545c092e8aSdrh   }
37555c092e8aSdrh }
37565c092e8aSdrh 
37575c092e8aSdrh /*
3758945498f3Sdrh ** Generate code that will extract the iColumn-th column from
37598c607191Sdrh ** table pTab and store the column value in register iReg.
3760e55cbd72Sdrh **
3761e55cbd72Sdrh ** There must be an open cursor to pTab in iTable when this routine
3762e55cbd72Sdrh ** is called.  If iColumn<0 then code is generated that extracts the rowid.
3763945498f3Sdrh */
3764e55cbd72Sdrh int sqlite3ExprCodeGetColumn(
3765e55cbd72Sdrh   Parse *pParse,   /* Parsing and code generating context */
37662133d822Sdrh   Table *pTab,     /* Description of the table we are reading from */
37672133d822Sdrh   int iColumn,     /* Index of the table column */
37682133d822Sdrh   int iTable,      /* The cursor pointing to the table */
3769a748fdccSdrh   int iReg,        /* Store results here */
3770ce78bc6eSdrh   u8 p5            /* P5 value for OP_Column + FLAGS */
37712133d822Sdrh ){
377281f7b372Sdrh   assert( pParse->pVdbe!=0 );
37736df9c4b9Sdrh   sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pTab, iTable, iColumn, iReg);
3774a748fdccSdrh   if( p5 ){
377599670abbSdrh     VdbeOp *pOp = sqlite3VdbeGetOp(pParse->pVdbe,-1);
377699670abbSdrh     if( pOp->opcode==OP_Column ) pOp->p5 = p5;
3777a748fdccSdrh   }
3778e55cbd72Sdrh   return iReg;
3779e55cbd72Sdrh }
3780e55cbd72Sdrh 
3781e55cbd72Sdrh /*
3782b21e7c70Sdrh ** Generate code to move content from registers iFrom...iFrom+nReg-1
378336a5d88dSdrh ** over to iTo..iTo+nReg-1.
3784e55cbd72Sdrh */
3785b21e7c70Sdrh void sqlite3ExprCodeMove(Parse *pParse, int iFrom, int iTo, int nReg){
3786079a3072Sdrh   sqlite3VdbeAddOp3(pParse->pVdbe, OP_Move, iFrom, iTo, nReg);
3787945498f3Sdrh }
3788945498f3Sdrh 
3789652fbf55Sdrh /*
379012abf408Sdrh ** Convert a scalar expression node to a TK_REGISTER referencing
379112abf408Sdrh ** register iReg.  The caller must ensure that iReg already contains
379212abf408Sdrh ** the correct value for the expression.
3793a4c3c87eSdrh */
3794069d1b1fSdan static void exprToRegister(Expr *pExpr, int iReg){
37950d950af3Sdrh   Expr *p = sqlite3ExprSkipCollateAndLikely(pExpr);
3796235667a8Sdrh   if( NEVER(p==0) ) return;
3797a4c3c87eSdrh   p->op2 = p->op;
3798a4c3c87eSdrh   p->op = TK_REGISTER;
3799a4c3c87eSdrh   p->iTable = iReg;
3800a4c3c87eSdrh   ExprClearProperty(p, EP_Skip);
3801a4c3c87eSdrh }
3802a4c3c87eSdrh 
380312abf408Sdrh /*
380412abf408Sdrh ** Evaluate an expression (either a vector or a scalar expression) and store
380512abf408Sdrh ** the result in continguous temporary registers.  Return the index of
380612abf408Sdrh ** the first register used to store the result.
380712abf408Sdrh **
380812abf408Sdrh ** If the returned result register is a temporary scalar, then also write
380912abf408Sdrh ** that register number into *piFreeable.  If the returned result register
381012abf408Sdrh ** is not a temporary or if the expression is a vector set *piFreeable
381112abf408Sdrh ** to 0.
381212abf408Sdrh */
381312abf408Sdrh static int exprCodeVector(Parse *pParse, Expr *p, int *piFreeable){
381412abf408Sdrh   int iResult;
381512abf408Sdrh   int nResult = sqlite3ExprVectorSize(p);
381612abf408Sdrh   if( nResult==1 ){
381712abf408Sdrh     iResult = sqlite3ExprCodeTemp(pParse, p, piFreeable);
381812abf408Sdrh   }else{
381912abf408Sdrh     *piFreeable = 0;
382012abf408Sdrh     if( p->op==TK_SELECT ){
3821dd1bb43aSdrh #if SQLITE_OMIT_SUBQUERY
3822dd1bb43aSdrh       iResult = 0;
3823dd1bb43aSdrh #else
382485bcdce2Sdrh       iResult = sqlite3CodeSubselect(pParse, p);
3825dd1bb43aSdrh #endif
382612abf408Sdrh     }else{
382712abf408Sdrh       int i;
382812abf408Sdrh       iResult = pParse->nMem+1;
382912abf408Sdrh       pParse->nMem += nResult;
3830*a4eeccdfSdrh       assert( ExprUseXList(p) );
383112abf408Sdrh       for(i=0; i<nResult; i++){
38324b725240Sdan         sqlite3ExprCodeFactorable(pParse, p->x.pList->a[i].pExpr, i+iResult);
383312abf408Sdrh       }
383412abf408Sdrh     }
383512abf408Sdrh   }
383612abf408Sdrh   return iResult;
383712abf408Sdrh }
383812abf408Sdrh 
383925c4296bSdrh /*
384092a27f7bSdrh ** If the last opcode is a OP_Copy, then set the do-not-merge flag (p5)
384192a27f7bSdrh ** so that a subsequent copy will not be merged into this one.
384292a27f7bSdrh */
384392a27f7bSdrh static void setDoNotMergeFlagOnCopy(Vdbe *v){
384492a27f7bSdrh   if( sqlite3VdbeGetOp(v, -1)->opcode==OP_Copy ){
384592a27f7bSdrh     sqlite3VdbeChangeP5(v, 1);  /* Tag trailing OP_Copy as not mergable */
384692a27f7bSdrh   }
384792a27f7bSdrh }
384892a27f7bSdrh 
384992a27f7bSdrh /*
385025c4296bSdrh ** Generate code to implement special SQL functions that are implemented
385125c4296bSdrh ** in-line rather than by using the usual callbacks.
385225c4296bSdrh */
385325c4296bSdrh static int exprCodeInlineFunction(
385425c4296bSdrh   Parse *pParse,        /* Parsing context */
385525c4296bSdrh   ExprList *pFarg,      /* List of function arguments */
385625c4296bSdrh   int iFuncId,          /* Function ID.  One of the INTFUNC_... values */
385725c4296bSdrh   int target            /* Store function result in this register */
385825c4296bSdrh ){
385925c4296bSdrh   int nFarg;
386025c4296bSdrh   Vdbe *v = pParse->pVdbe;
386125c4296bSdrh   assert( v!=0 );
386225c4296bSdrh   assert( pFarg!=0 );
386325c4296bSdrh   nFarg = pFarg->nExpr;
386425c4296bSdrh   assert( nFarg>0 );  /* All in-line functions have at least one argument */
386525c4296bSdrh   switch( iFuncId ){
386625c4296bSdrh     case INLINEFUNC_coalesce: {
386725c4296bSdrh       /* Attempt a direct implementation of the built-in COALESCE() and
386825c4296bSdrh       ** IFNULL() functions.  This avoids unnecessary evaluation of
386925c4296bSdrh       ** arguments past the first non-NULL argument.
387025c4296bSdrh       */
387125c4296bSdrh       int endCoalesce = sqlite3VdbeMakeLabel(pParse);
387225c4296bSdrh       int i;
387325c4296bSdrh       assert( nFarg>=2 );
387425c4296bSdrh       sqlite3ExprCode(pParse, pFarg->a[0].pExpr, target);
387525c4296bSdrh       for(i=1; i<nFarg; i++){
387625c4296bSdrh         sqlite3VdbeAddOp2(v, OP_NotNull, target, endCoalesce);
387725c4296bSdrh         VdbeCoverage(v);
387825c4296bSdrh         sqlite3ExprCode(pParse, pFarg->a[i].pExpr, target);
387925c4296bSdrh       }
388092a27f7bSdrh       setDoNotMergeFlagOnCopy(v);
388125c4296bSdrh       sqlite3VdbeResolveLabel(v, endCoalesce);
388225c4296bSdrh       break;
388325c4296bSdrh     }
38843c0e606bSdrh     case INLINEFUNC_iif: {
38853c0e606bSdrh       Expr caseExpr;
38863c0e606bSdrh       memset(&caseExpr, 0, sizeof(caseExpr));
38873c0e606bSdrh       caseExpr.op = TK_CASE;
38883c0e606bSdrh       caseExpr.x.pList = pFarg;
38893c0e606bSdrh       return sqlite3ExprCodeTarget(pParse, &caseExpr, target);
38903c0e606bSdrh     }
389125c4296bSdrh 
3892171c50ecSdrh     default: {
389325c4296bSdrh       /* The UNLIKELY() function is a no-op.  The result is the value
389425c4296bSdrh       ** of the first argument.
389525c4296bSdrh       */
3896171c50ecSdrh       assert( nFarg==1 || nFarg==2 );
389725c4296bSdrh       target = sqlite3ExprCodeTarget(pParse, pFarg->a[0].pExpr, target);
389825c4296bSdrh       break;
389925c4296bSdrh     }
390025c4296bSdrh 
3901171c50ecSdrh   /***********************************************************************
3902171c50ecSdrh   ** Test-only SQL functions that are only usable if enabled
3903171c50ecSdrh   ** via SQLITE_TESTCTRL_INTERNAL_FUNCTIONS
3904171c50ecSdrh   */
39053780f9a4Sdrh #if !defined(SQLITE_UNTESTABLE)
3906171c50ecSdrh     case INLINEFUNC_expr_compare: {
3907171c50ecSdrh       /* Compare two expressions using sqlite3ExprCompare() */
3908171c50ecSdrh       assert( nFarg==2 );
3909171c50ecSdrh       sqlite3VdbeAddOp2(v, OP_Integer,
3910171c50ecSdrh          sqlite3ExprCompare(0,pFarg->a[0].pExpr, pFarg->a[1].pExpr,-1),
3911171c50ecSdrh          target);
3912171c50ecSdrh       break;
3913171c50ecSdrh     }
3914171c50ecSdrh 
3915171c50ecSdrh     case INLINEFUNC_expr_implies_expr: {
3916171c50ecSdrh       /* Compare two expressions using sqlite3ExprImpliesExpr() */
3917171c50ecSdrh       assert( nFarg==2 );
3918171c50ecSdrh       sqlite3VdbeAddOp2(v, OP_Integer,
3919171c50ecSdrh          sqlite3ExprImpliesExpr(pParse,pFarg->a[0].pExpr, pFarg->a[1].pExpr,-1),
3920171c50ecSdrh          target);
3921171c50ecSdrh       break;
3922171c50ecSdrh     }
3923171c50ecSdrh 
3924171c50ecSdrh     case INLINEFUNC_implies_nonnull_row: {
3925171c50ecSdrh       /* REsult of sqlite3ExprImpliesNonNullRow() */
3926171c50ecSdrh       Expr *pA1;
3927171c50ecSdrh       assert( nFarg==2 );
3928171c50ecSdrh       pA1 = pFarg->a[1].pExpr;
3929171c50ecSdrh       if( pA1->op==TK_COLUMN ){
3930171c50ecSdrh         sqlite3VdbeAddOp2(v, OP_Integer,
3931171c50ecSdrh            sqlite3ExprImpliesNonNullRow(pFarg->a[0].pExpr,pA1->iTable),
3932171c50ecSdrh            target);
3933171c50ecSdrh       }else{
3934171c50ecSdrh         sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3935171c50ecSdrh       }
3936171c50ecSdrh       break;
3937171c50ecSdrh     }
3938171c50ecSdrh 
393925c4296bSdrh     case INLINEFUNC_affinity: {
394025c4296bSdrh       /* The AFFINITY() function evaluates to a string that describes
394125c4296bSdrh       ** the type affinity of the argument.  This is used for testing of
394225c4296bSdrh       ** the SQLite type logic.
394325c4296bSdrh       */
394425c4296bSdrh       const char *azAff[] = { "blob", "text", "numeric", "integer", "real" };
394525c4296bSdrh       char aff;
394625c4296bSdrh       assert( nFarg==1 );
394725c4296bSdrh       aff = sqlite3ExprAffinity(pFarg->a[0].pExpr);
394825c4296bSdrh       sqlite3VdbeLoadString(v, target,
394925c4296bSdrh               (aff<=SQLITE_AFF_NONE) ? "none" : azAff[aff-SQLITE_AFF_BLOB]);
395025c4296bSdrh       break;
395125c4296bSdrh     }
39523780f9a4Sdrh #endif /* !defined(SQLITE_UNTESTABLE) */
395325c4296bSdrh   }
395425c4296bSdrh   return target;
395525c4296bSdrh }
395625c4296bSdrh 
395771c57db0Sdan 
3958a4c3c87eSdrh /*
3959cce7d176Sdrh ** Generate code into the current Vdbe to evaluate the given
39602dcef11bSdrh ** expression.  Attempt to store the results in register "target".
39612dcef11bSdrh ** Return the register where results are stored.
3962389a1adbSdrh **
39638b213899Sdrh ** With this routine, there is no guarantee that results will
39642dcef11bSdrh ** be stored in target.  The result might be stored in some other
39652dcef11bSdrh ** register if it is convenient to do so.  The calling function
39662dcef11bSdrh ** must check the return code and move the results to the desired
39672dcef11bSdrh ** register.
3968cce7d176Sdrh */
3969678ccce8Sdrh int sqlite3ExprCodeTarget(Parse *pParse, Expr *pExpr, int target){
39702dcef11bSdrh   Vdbe *v = pParse->pVdbe;  /* The VM under construction */
39712dcef11bSdrh   int op;                   /* The opcode being coded */
39722dcef11bSdrh   int inReg = target;       /* Results stored in register inReg */
39732dcef11bSdrh   int regFree1 = 0;         /* If non-zero free this temporary register */
39742dcef11bSdrh   int regFree2 = 0;         /* If non-zero free this temporary register */
39757b35a77bSdan   int r1, r2;               /* Various register numbers */
397610d1edf0Sdrh   Expr tempX;               /* Temporary expression node */
397771c57db0Sdan   int p5 = 0;
3978ffe07b2dSdrh 
39799cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
3980b639a209Sdrh   assert( v!=0 );
3981389a1adbSdrh 
39821efa8023Sdrh expr_code_doover:
3983389a1adbSdrh   if( pExpr==0 ){
3984389a1adbSdrh     op = TK_NULL;
3985389a1adbSdrh   }else{
3986e7375bfaSdrh     assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
3987f2bc013cSdrh     op = pExpr->op;
3988389a1adbSdrh   }
3989f2bc013cSdrh   switch( op ){
399013449892Sdrh     case TK_AGG_COLUMN: {
399113449892Sdrh       AggInfo *pAggInfo = pExpr->pAggInfo;
39920934d640Sdrh       struct AggInfo_col *pCol;
39930934d640Sdrh       assert( pAggInfo!=0 );
39940934d640Sdrh       assert( pExpr->iAgg>=0 && pExpr->iAgg<pAggInfo->nColumn );
39950934d640Sdrh       pCol = &pAggInfo->aCol[pExpr->iAgg];
399613449892Sdrh       if( !pAggInfo->directMode ){
39979de221dfSdrh         assert( pCol->iMem>0 );
3998c332cc30Sdrh         return pCol->iMem;
399913449892Sdrh       }else if( pAggInfo->useSortingIdx ){
40000c76e892Sdrh         Table *pTab = pCol->pTab;
40015134d135Sdan         sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdxPTab,
4002389a1adbSdrh                               pCol->iSorterColumn, target);
40038d5cea6bSdrh         if( pCol->iColumn<0 ){
40048d5cea6bSdrh           VdbeComment((v,"%s.rowid",pTab->zName));
40058d5cea6bSdrh         }else{
4006cf9d36d1Sdrh           VdbeComment((v,"%s.%s",
4007cf9d36d1Sdrh               pTab->zName, pTab->aCol[pCol->iColumn].zCnName));
40088d5cea6bSdrh           if( pTab->aCol[pCol->iColumn].affinity==SQLITE_AFF_REAL ){
40098d5cea6bSdrh             sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
40108d5cea6bSdrh           }
40110c76e892Sdrh         }
4012c332cc30Sdrh         return target;
401313449892Sdrh       }
401413449892Sdrh       /* Otherwise, fall thru into the TK_COLUMN case */
401508b92086Sdrh       /* no break */ deliberate_fall_through
401613449892Sdrh     }
4017967e8b73Sdrh     case TK_COLUMN: {
4018b2b9d3d7Sdrh       int iTab = pExpr->iTable;
401967b9ba17Sdrh       int iReg;
4020efad2e23Sdrh       if( ExprHasProperty(pExpr, EP_FixedCol) ){
4021d98f5324Sdrh         /* This COLUMN expression is really a constant due to WHERE clause
4022d98f5324Sdrh         ** constraints, and that constant is coded by the pExpr->pLeft
4023d98f5324Sdrh         ** expresssion.  However, make sure the constant has the correct
4024d98f5324Sdrh         ** datatype by applying the Affinity of the table column to the
4025d98f5324Sdrh         ** constant.
4026d98f5324Sdrh         */
402757f7ece7Sdrh         int aff;
402867b9ba17Sdrh         iReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft,target);
402957f7ece7Sdrh         if( pExpr->y.pTab ){
403057f7ece7Sdrh           aff = sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
403157f7ece7Sdrh         }else{
403257f7ece7Sdrh           aff = pExpr->affExpr;
403357f7ece7Sdrh         }
403496fb16eeSdrh         if( aff>SQLITE_AFF_BLOB ){
4035d98f5324Sdrh           static const char zAff[] = "B\000C\000D\000E";
4036d98f5324Sdrh           assert( SQLITE_AFF_BLOB=='A' );
4037d98f5324Sdrh           assert( SQLITE_AFF_TEXT=='B' );
4038d98f5324Sdrh           sqlite3VdbeAddOp4(v, OP_Affinity, iReg, 1, 0,
4039d98f5324Sdrh                             &zAff[(aff-'B')*2], P4_STATIC);
4040d98f5324Sdrh         }
4041d98f5324Sdrh         return iReg;
4042efad2e23Sdrh       }
4043b2b9d3d7Sdrh       if( iTab<0 ){
40446e97f8ecSdrh         if( pParse->iSelfTab<0 ){
40459942ef0dSdrh           /* Other columns in the same row for CHECK constraints or
40469942ef0dSdrh           ** generated columns or for inserting into partial index.
40479942ef0dSdrh           ** The row is unpacked into registers beginning at
40489942ef0dSdrh           ** 0-(pParse->iSelfTab).  The rowid (if any) is in a register
40499942ef0dSdrh           ** immediately prior to the first column.
40509942ef0dSdrh           */
40519942ef0dSdrh           Column *pCol;
40529942ef0dSdrh           Table *pTab = pExpr->y.pTab;
40539942ef0dSdrh           int iSrc;
4054c5f808d8Sdrh           int iCol = pExpr->iColumn;
40559942ef0dSdrh           assert( pTab!=0 );
4056c5f808d8Sdrh           assert( iCol>=XN_ROWID );
4057b0cbcd0eSdrh           assert( iCol<pTab->nCol );
4058c5f808d8Sdrh           if( iCol<0 ){
40599942ef0dSdrh             return -1-pParse->iSelfTab;
40609942ef0dSdrh           }
4061c5f808d8Sdrh           pCol = pTab->aCol + iCol;
4062c5f808d8Sdrh           testcase( iCol!=sqlite3TableColumnToStorage(pTab,iCol) );
4063c5f808d8Sdrh           iSrc = sqlite3TableColumnToStorage(pTab, iCol) - pParse->iSelfTab;
40649942ef0dSdrh #ifndef SQLITE_OMIT_GENERATED_COLUMNS
40659942ef0dSdrh           if( pCol->colFlags & COLFLAG_GENERATED ){
40664e8e533bSdrh             if( pCol->colFlags & COLFLAG_BUSY ){
40674e8e533bSdrh               sqlite3ErrorMsg(pParse, "generated column loop on \"%s\"",
4068cf9d36d1Sdrh                               pCol->zCnName);
40694e8e533bSdrh               return 0;
40704e8e533bSdrh             }
40714e8e533bSdrh             pCol->colFlags |= COLFLAG_BUSY;
40724e8e533bSdrh             if( pCol->colFlags & COLFLAG_NOTAVAIL ){
407379cf2b71Sdrh               sqlite3ExprCodeGeneratedColumn(pParse, pTab, pCol, iSrc);
40744e8e533bSdrh             }
40754e8e533bSdrh             pCol->colFlags &= ~(COLFLAG_BUSY|COLFLAG_NOTAVAIL);
4076dd6cc9b5Sdrh             return iSrc;
40779942ef0dSdrh           }else
40789942ef0dSdrh #endif /* SQLITE_OMIT_GENERATED_COLUMNS */
40799942ef0dSdrh           if( pCol->affinity==SQLITE_AFF_REAL ){
40809942ef0dSdrh             sqlite3VdbeAddOp2(v, OP_SCopy, iSrc, target);
4081bffdd636Sdrh             sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
4082bffdd636Sdrh             return target;
4083bffdd636Sdrh           }else{
40849942ef0dSdrh             return iSrc;
4085bffdd636Sdrh           }
4086c4a3c779Sdrh         }else{
40871f9ca2c8Sdrh           /* Coding an expression that is part of an index where column names
40881f9ca2c8Sdrh           ** in the index refer to the table to which the index belongs */
40893e34eabcSdrh           iTab = pParse->iSelfTab - 1;
40902282792aSdrh         }
4091b2b9d3d7Sdrh       }
409267b9ba17Sdrh       iReg = sqlite3ExprCodeGetColumn(pParse, pExpr->y.pTab,
4093b2b9d3d7Sdrh                                pExpr->iColumn, iTab, target,
4094b2b9d3d7Sdrh                                pExpr->op2);
409567b9ba17Sdrh       if( pExpr->y.pTab==0 && pExpr->affExpr==SQLITE_AFF_REAL ){
409667b9ba17Sdrh         sqlite3VdbeAddOp1(v, OP_RealAffinity, iReg);
409767b9ba17Sdrh       }
409867b9ba17Sdrh       return iReg;
4099cce7d176Sdrh     }
4100cce7d176Sdrh     case TK_INTEGER: {
410113573c71Sdrh       codeInteger(pParse, pExpr, 0, target);
4102c332cc30Sdrh       return target;
410351e9a445Sdrh     }
41048abed7b9Sdrh     case TK_TRUEFALSE: {
410596acafbeSdrh       sqlite3VdbeAddOp2(v, OP_Integer, sqlite3ExprTruthValue(pExpr), target);
4106007c843bSdrh       return target;
4107007c843bSdrh     }
410813573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
4109598f1340Sdrh     case TK_FLOAT: {
411033e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
411133e619fcSdrh       codeReal(v, pExpr->u.zToken, 0, target);
4112c332cc30Sdrh       return target;
4113598f1340Sdrh     }
411413573c71Sdrh #endif
4115fec19aadSdrh     case TK_STRING: {
411633e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
4117076e85f5Sdrh       sqlite3VdbeLoadString(v, target, pExpr->u.zToken);
4118c332cc30Sdrh       return target;
4119cce7d176Sdrh     }
4120aac30f9bSdrh     default: {
4121c29af653Sdrh       /* Make NULL the default case so that if a bug causes an illegal
4122c29af653Sdrh       ** Expr node to be passed into this function, it will be handled
41239524a7eaSdrh       ** sanely and not crash.  But keep the assert() to bring the problem
41249524a7eaSdrh       ** to the attention of the developers. */
412505428127Sdrh       assert( op==TK_NULL || op==TK_ERROR || pParse->db->mallocFailed );
41269de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
4127c332cc30Sdrh       return target;
4128f0863fe5Sdrh     }
41295338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_BLOB_LITERAL
4130c572ef7fSdanielk1977     case TK_BLOB: {
41316c8c6cecSdrh       int n;
41326c8c6cecSdrh       const char *z;
4133ca48c90fSdrh       char *zBlob;
413433e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
413533e619fcSdrh       assert( pExpr->u.zToken[0]=='x' || pExpr->u.zToken[0]=='X' );
413633e619fcSdrh       assert( pExpr->u.zToken[1]=='\'' );
413733e619fcSdrh       z = &pExpr->u.zToken[2];
4138b7916a78Sdrh       n = sqlite3Strlen30(z) - 1;
4139b7916a78Sdrh       assert( z[n]=='\'' );
4140ca48c90fSdrh       zBlob = sqlite3HexToBlob(sqlite3VdbeDb(v), z, n);
4141ca48c90fSdrh       sqlite3VdbeAddOp4(v, OP_Blob, n/2, target, 0, zBlob, P4_DYNAMIC);
4142c332cc30Sdrh       return target;
4143c572ef7fSdanielk1977     }
41445338a5f7Sdanielk1977 #endif
414550457896Sdrh     case TK_VARIABLE: {
414633e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
414733e619fcSdrh       assert( pExpr->u.zToken!=0 );
414833e619fcSdrh       assert( pExpr->u.zToken[0]!=0 );
4149eaf52d88Sdrh       sqlite3VdbeAddOp2(v, OP_Variable, pExpr->iColumn, target);
415033e619fcSdrh       if( pExpr->u.zToken[1]!=0 ){
41519bf755ccSdrh         const char *z = sqlite3VListNumToName(pParse->pVList, pExpr->iColumn);
41529524a7eaSdrh         assert( pExpr->u.zToken[0]=='?' || (z && !strcmp(pExpr->u.zToken, z)) );
4153ce1bbe51Sdrh         pParse->pVList[0] = 0; /* Indicate VList may no longer be enlarged */
41549bf755ccSdrh         sqlite3VdbeAppendP4(v, (char*)z, P4_STATIC);
41559bf755ccSdrh       }
4156c332cc30Sdrh       return target;
415750457896Sdrh     }
41584e0cff60Sdrh     case TK_REGISTER: {
4159c332cc30Sdrh       return pExpr->iTable;
41604e0cff60Sdrh     }
4161487e262fSdrh #ifndef SQLITE_OMIT_CAST
4162487e262fSdrh     case TK_CAST: {
4163487e262fSdrh       /* Expressions of the form:   CAST(pLeft AS token) */
41642dcef11bSdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
41651735fa88Sdrh       if( inReg!=target ){
41661735fa88Sdrh         sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
41671735fa88Sdrh         inReg = target;
41681735fa88Sdrh       }
4169f9751074Sdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
41704169e430Sdrh       sqlite3VdbeAddOp2(v, OP_Cast, target,
41714169e430Sdrh                         sqlite3AffinityType(pExpr->u.zToken, 0));
4172c332cc30Sdrh       return inReg;
4173487e262fSdrh     }
4174487e262fSdrh #endif /* SQLITE_OMIT_CAST */
417571c57db0Sdan     case TK_IS:
417671c57db0Sdan     case TK_ISNOT:
417771c57db0Sdan       op = (op==TK_IS) ? TK_EQ : TK_NE;
417871c57db0Sdan       p5 = SQLITE_NULLEQ;
417971c57db0Sdan       /* fall-through */
4180c9b84a1fSdrh     case TK_LT:
4181c9b84a1fSdrh     case TK_LE:
4182c9b84a1fSdrh     case TK_GT:
4183c9b84a1fSdrh     case TK_GE:
4184c9b84a1fSdrh     case TK_NE:
4185c9b84a1fSdrh     case TK_EQ: {
418671c57db0Sdan       Expr *pLeft = pExpr->pLeft;
4187625015e0Sdan       if( sqlite3ExprIsVector(pLeft) ){
418879752b6eSdrh         codeVectorCompare(pParse, pExpr, target, op, p5);
418971c57db0Sdan       }else{
419071c57db0Sdan         r1 = sqlite3ExprCodeTemp(pParse, pLeft, &regFree1);
4191b6da74ebSdrh         r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
4192871e7ff4Sdrh         sqlite3VdbeAddOp2(v, OP_Integer, 1, inReg);
4193871e7ff4Sdrh         codeCompare(pParse, pLeft, pExpr->pRight, op, r1, r2,
4194871e7ff4Sdrh             sqlite3VdbeCurrentAddr(v)+2, p5,
4195898c527eSdrh             ExprHasProperty(pExpr,EP_Commuted));
41967d176105Sdrh         assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
41977d176105Sdrh         assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
41987d176105Sdrh         assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
41997d176105Sdrh         assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
42007d176105Sdrh         assert(TK_EQ==OP_Eq); testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
42017d176105Sdrh         assert(TK_NE==OP_Ne); testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
4202529df929Sdrh         if( p5==SQLITE_NULLEQ ){
4203529df929Sdrh           sqlite3VdbeAddOp2(v, OP_Integer, 0, inReg);
4204529df929Sdrh         }else{
4205529df929Sdrh           sqlite3VdbeAddOp3(v, OP_ZeroOrNull, r1, inReg, r2);
4206529df929Sdrh         }
4207c5499befSdrh         testcase( regFree1==0 );
4208c5499befSdrh         testcase( regFree2==0 );
4209c9b84a1fSdrh       }
42106a2fe093Sdrh       break;
42116a2fe093Sdrh     }
4212cce7d176Sdrh     case TK_AND:
4213cce7d176Sdrh     case TK_OR:
4214cce7d176Sdrh     case TK_PLUS:
4215cce7d176Sdrh     case TK_STAR:
4216cce7d176Sdrh     case TK_MINUS:
4217bf4133cbSdrh     case TK_REM:
4218bf4133cbSdrh     case TK_BITAND:
4219bf4133cbSdrh     case TK_BITOR:
422017c40294Sdrh     case TK_SLASH:
4221bf4133cbSdrh     case TK_LSHIFT:
4222855eb1cfSdrh     case TK_RSHIFT:
42230040077dSdrh     case TK_CONCAT: {
42247d176105Sdrh       assert( TK_AND==OP_And );            testcase( op==TK_AND );
42257d176105Sdrh       assert( TK_OR==OP_Or );              testcase( op==TK_OR );
42267d176105Sdrh       assert( TK_PLUS==OP_Add );           testcase( op==TK_PLUS );
42277d176105Sdrh       assert( TK_MINUS==OP_Subtract );     testcase( op==TK_MINUS );
42287d176105Sdrh       assert( TK_REM==OP_Remainder );      testcase( op==TK_REM );
42297d176105Sdrh       assert( TK_BITAND==OP_BitAnd );      testcase( op==TK_BITAND );
42307d176105Sdrh       assert( TK_BITOR==OP_BitOr );        testcase( op==TK_BITOR );
42317d176105Sdrh       assert( TK_SLASH==OP_Divide );       testcase( op==TK_SLASH );
42327d176105Sdrh       assert( TK_LSHIFT==OP_ShiftLeft );   testcase( op==TK_LSHIFT );
42337d176105Sdrh       assert( TK_RSHIFT==OP_ShiftRight );  testcase( op==TK_RSHIFT );
42347d176105Sdrh       assert( TK_CONCAT==OP_Concat );      testcase( op==TK_CONCAT );
42352dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
42362dcef11bSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
42375b6afba9Sdrh       sqlite3VdbeAddOp3(v, op, r2, r1, target);
4238c5499befSdrh       testcase( regFree1==0 );
4239c5499befSdrh       testcase( regFree2==0 );
42400040077dSdrh       break;
42410040077dSdrh     }
4242cce7d176Sdrh     case TK_UMINUS: {
4243fec19aadSdrh       Expr *pLeft = pExpr->pLeft;
4244fec19aadSdrh       assert( pLeft );
424513573c71Sdrh       if( pLeft->op==TK_INTEGER ){
424613573c71Sdrh         codeInteger(pParse, pLeft, 1, target);
4247c332cc30Sdrh         return target;
424813573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
424913573c71Sdrh       }else if( pLeft->op==TK_FLOAT ){
425033e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
425133e619fcSdrh         codeReal(v, pLeft->u.zToken, 1, target);
4252c332cc30Sdrh         return target;
425313573c71Sdrh #endif
42543c84ddffSdrh       }else{
425510d1edf0Sdrh         tempX.op = TK_INTEGER;
425610d1edf0Sdrh         tempX.flags = EP_IntValue|EP_TokenOnly;
425710d1edf0Sdrh         tempX.u.iValue = 0;
4258e7375bfaSdrh         ExprClearVVAProperties(&tempX);
425910d1edf0Sdrh         r1 = sqlite3ExprCodeTemp(pParse, &tempX, &regFree1);
4260e55cbd72Sdrh         r2 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree2);
42612dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_Subtract, r2, r1, target);
4262c5499befSdrh         testcase( regFree2==0 );
42633c84ddffSdrh       }
42646e142f54Sdrh       break;
42656e142f54Sdrh     }
4266bf4133cbSdrh     case TK_BITNOT:
42676e142f54Sdrh     case TK_NOT: {
42687d176105Sdrh       assert( TK_BITNOT==OP_BitNot );   testcase( op==TK_BITNOT );
42697d176105Sdrh       assert( TK_NOT==OP_Not );         testcase( op==TK_NOT );
4270e99fa2afSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4271e99fa2afSdrh       testcase( regFree1==0 );
4272e99fa2afSdrh       sqlite3VdbeAddOp2(v, op, r1, inReg);
4273cce7d176Sdrh       break;
4274cce7d176Sdrh     }
42758abed7b9Sdrh     case TK_TRUTH: {
427696acafbeSdrh       int isTrue;    /* IS TRUE or IS NOT TRUE */
427796acafbeSdrh       int bNormal;   /* IS TRUE or IS FALSE */
4278007c843bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4279007c843bSdrh       testcase( regFree1==0 );
428096acafbeSdrh       isTrue = sqlite3ExprTruthValue(pExpr->pRight);
428196acafbeSdrh       bNormal = pExpr->op2==TK_IS;
428296acafbeSdrh       testcase( isTrue && bNormal);
428396acafbeSdrh       testcase( !isTrue && bNormal);
428496acafbeSdrh       sqlite3VdbeAddOp4Int(v, OP_IsTrue, r1, inReg, !isTrue, isTrue ^ bNormal);
4285007c843bSdrh       break;
4286007c843bSdrh     }
4287cce7d176Sdrh     case TK_ISNULL:
4288cce7d176Sdrh     case TK_NOTNULL: {
42896a288a33Sdrh       int addr;
42907d176105Sdrh       assert( TK_ISNULL==OP_IsNull );   testcase( op==TK_ISNULL );
42917d176105Sdrh       assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
42929de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
42932dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4294c5499befSdrh       testcase( regFree1==0 );
42952dcef11bSdrh       addr = sqlite3VdbeAddOp1(v, op, r1);
42967d176105Sdrh       VdbeCoverageIf(v, op==TK_ISNULL);
42977d176105Sdrh       VdbeCoverageIf(v, op==TK_NOTNULL);
4298a976979bSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 0, target);
42996a288a33Sdrh       sqlite3VdbeJumpHere(v, addr);
4300a37cdde0Sdanielk1977       break;
4301f2bc013cSdrh     }
43022282792aSdrh     case TK_AGG_FUNCTION: {
430313449892Sdrh       AggInfo *pInfo = pExpr->pAggInfo;
43040934d640Sdrh       if( pInfo==0
43050934d640Sdrh        || NEVER(pExpr->iAgg<0)
43060934d640Sdrh        || NEVER(pExpr->iAgg>=pInfo->nFunc)
43070934d640Sdrh       ){
430833e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
430933e619fcSdrh         sqlite3ErrorMsg(pParse, "misuse of aggregate: %s()", pExpr->u.zToken);
43107e56e711Sdrh       }else{
4311c332cc30Sdrh         return pInfo->aFunc[pExpr->iAgg].iMem;
43127e56e711Sdrh       }
43132282792aSdrh       break;
43142282792aSdrh     }
4315cce7d176Sdrh     case TK_FUNCTION: {
431612ffee8cSdrh       ExprList *pFarg;       /* List of function arguments */
431712ffee8cSdrh       int nFarg;             /* Number of function arguments */
431812ffee8cSdrh       FuncDef *pDef;         /* The function definition object */
431912ffee8cSdrh       const char *zId;       /* The function name */
4320693e6719Sdrh       u32 constMask = 0;     /* Mask of function arguments that are constant */
432112ffee8cSdrh       int i;                 /* Loop counter */
4322c332cc30Sdrh       sqlite3 *db = pParse->db;  /* The database connection */
432312ffee8cSdrh       u8 enc = ENC(db);      /* The text encoding used by this database */
432412ffee8cSdrh       CollSeq *pColl = 0;    /* A collating sequence */
432517435752Sdrh 
432667a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
4327eda079cdSdrh       if( ExprHasProperty(pExpr, EP_WinFunc) ){
4328eda079cdSdrh         return pExpr->y.pWin->regResult;
432986fb6e17Sdan       }
433067a9b8edSdan #endif
433186fb6e17Sdan 
43321e9b53f9Sdrh       if( ConstFactorOk(pParse) && sqlite3ExprIsConstantNotJoin(pExpr) ){
43339b258c54Sdrh         /* SQL functions can be expensive. So try to avoid running them
43349b258c54Sdrh         ** multiple times if we know they always give the same result */
43359b258c54Sdrh         return sqlite3ExprCodeRunJustOnce(pParse, pExpr, -1);
43361e9b53f9Sdrh       }
4337e7375bfaSdrh       assert( !ExprHasProperty(pExpr, EP_TokenOnly) );
4338*a4eeccdfSdrh       assert( ExprUseXList(pExpr) );
433912ffee8cSdrh       pFarg = pExpr->x.pList;
434012ffee8cSdrh       nFarg = pFarg ? pFarg->nExpr : 0;
434133e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
434233e619fcSdrh       zId = pExpr->u.zToken;
434380738d9cSdrh       pDef = sqlite3FindFunction(db, zId, nFarg, enc, 0);
4344cc15313cSdrh #ifdef SQLITE_ENABLE_UNKNOWN_SQL_FUNCTION
4345cc15313cSdrh       if( pDef==0 && pParse->explain ){
4346cc15313cSdrh         pDef = sqlite3FindFunction(db, "unknown", nFarg, enc, 0);
4347cc15313cSdrh       }
4348cc15313cSdrh #endif
4349b6e9f7a4Sdan       if( pDef==0 || pDef->xFinalize!=0 ){
435080738d9cSdrh         sqlite3ErrorMsg(pParse, "unknown function: %s()", zId);
4351feb306f5Sdrh         break;
4352feb306f5Sdrh       }
435325c4296bSdrh       if( pDef->funcFlags & SQLITE_FUNC_INLINE ){
43540dfa5255Sdrh         assert( (pDef->funcFlags & SQLITE_FUNC_UNSAFE)==0 );
43550dfa5255Sdrh         assert( (pDef->funcFlags & SQLITE_FUNC_DIRECT)==0 );
435625c4296bSdrh         return exprCodeInlineFunction(pParse, pFarg,
435725c4296bSdrh              SQLITE_PTR_TO_INT(pDef->pUserData), target);
43582eeca204Sdrh       }else if( pDef->funcFlags & (SQLITE_FUNC_DIRECT|SQLITE_FUNC_UNSAFE) ){
43590dfa5255Sdrh         sqlite3ExprFunctionUsable(pParse, pExpr, pDef);
4360ae6bb957Sdrh       }
4361a1a523a5Sdrh 
4362d1a01edaSdrh       for(i=0; i<nFarg; i++){
4363d1a01edaSdrh         if( i<32 && sqlite3ExprIsConstant(pFarg->a[i].pExpr) ){
4364693e6719Sdrh           testcase( i==31 );
4365693e6719Sdrh           constMask |= MASKBIT32(i);
4366d1a01edaSdrh         }
4367d1a01edaSdrh         if( (pDef->funcFlags & SQLITE_FUNC_NEEDCOLL)!=0 && !pColl ){
4368d1a01edaSdrh           pColl = sqlite3ExprCollSeq(pParse, pFarg->a[i].pExpr);
4369d1a01edaSdrh         }
4370d1a01edaSdrh       }
437112ffee8cSdrh       if( pFarg ){
4372d1a01edaSdrh         if( constMask ){
4373d1a01edaSdrh           r1 = pParse->nMem+1;
4374d1a01edaSdrh           pParse->nMem += nFarg;
4375d1a01edaSdrh         }else{
437612ffee8cSdrh           r1 = sqlite3GetTempRange(pParse, nFarg);
4377d1a01edaSdrh         }
4378a748fdccSdrh 
4379a748fdccSdrh         /* For length() and typeof() functions with a column argument,
4380a748fdccSdrh         ** set the P5 parameter to the OP_Column opcode to OPFLAG_LENGTHARG
4381a748fdccSdrh         ** or OPFLAG_TYPEOFARG respectively, to avoid unnecessary data
4382a748fdccSdrh         ** loading.
4383a748fdccSdrh         */
4384d36e1041Sdrh         if( (pDef->funcFlags & (SQLITE_FUNC_LENGTH|SQLITE_FUNC_TYPEOF))!=0 ){
43854e245a4cSdrh           u8 exprOp;
4386a748fdccSdrh           assert( nFarg==1 );
4387a748fdccSdrh           assert( pFarg->a[0].pExpr!=0 );
43884e245a4cSdrh           exprOp = pFarg->a[0].pExpr->op;
43894e245a4cSdrh           if( exprOp==TK_COLUMN || exprOp==TK_AGG_COLUMN ){
4390a748fdccSdrh             assert( SQLITE_FUNC_LENGTH==OPFLAG_LENGTHARG );
4391a748fdccSdrh             assert( SQLITE_FUNC_TYPEOF==OPFLAG_TYPEOFARG );
4392b1fba286Sdrh             testcase( pDef->funcFlags & OPFLAG_LENGTHARG );
4393b1fba286Sdrh             pFarg->a[0].pExpr->op2 =
4394b1fba286Sdrh                   pDef->funcFlags & (OPFLAG_LENGTHARG|OPFLAG_TYPEOFARG);
4395a748fdccSdrh           }
4396a748fdccSdrh         }
4397a748fdccSdrh 
43985579d59fSdrh         sqlite3ExprCodeExprList(pParse, pFarg, r1, 0,
4399d1a01edaSdrh                                 SQLITE_ECEL_DUP|SQLITE_ECEL_FACTOR);
4400892d3179Sdrh       }else{
440112ffee8cSdrh         r1 = 0;
4402892d3179Sdrh       }
4403b7f6f68fSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
4404a43fa227Sdrh       /* Possibly overload the function if the first argument is
4405a43fa227Sdrh       ** a virtual table column.
4406a43fa227Sdrh       **
4407a43fa227Sdrh       ** For infix functions (LIKE, GLOB, REGEXP, and MATCH) use the
4408a43fa227Sdrh       ** second argument, not the first, as the argument to test to
4409a43fa227Sdrh       ** see if it is a column in a virtual table.  This is done because
4410a43fa227Sdrh       ** the left operand of infix functions (the operand we want to
4411a43fa227Sdrh       ** control overloading) ends up as the second argument to the
4412a43fa227Sdrh       ** function.  The expression "A glob B" is equivalent to
4413a43fa227Sdrh       ** "glob(B,A).  We want to use the A in "A glob B" to test
4414a43fa227Sdrh       ** for function overloading.  But we use the B term in "glob(B,A)".
4415a43fa227Sdrh       */
441659155065Sdrh       if( nFarg>=2 && ExprHasProperty(pExpr, EP_InfixFunc) ){
441712ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[1].pExpr);
441812ffee8cSdrh       }else if( nFarg>0 ){
441912ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[0].pExpr);
4420b7f6f68fSdrh       }
4421b7f6f68fSdrh #endif
4422d36e1041Sdrh       if( pDef->funcFlags & SQLITE_FUNC_NEEDCOLL ){
44238b213899Sdrh         if( !pColl ) pColl = db->pDfltColl;
442466a5167bSdrh         sqlite3VdbeAddOp4(v, OP_CollSeq, 0, 0, 0, (char *)pColl, P4_COLLSEQ);
4425682f68b0Sdanielk1977       }
4426092457b1Sdrh #ifdef SQLITE_ENABLE_OFFSET_SQL_FUNC
44277d4c94bcSdrh       if( (pDef->funcFlags & SQLITE_FUNC_OFFSET)!=0 && ALWAYS(pFarg!=0) ){
44282fc865c1Sdrh         Expr *pArg = pFarg->a[0].pExpr;
44292fc865c1Sdrh         if( pArg->op==TK_COLUMN ){
4430092457b1Sdrh           sqlite3VdbeAddOp3(v, OP_Offset, pArg->iTable, pArg->iColumn, target);
44312fc865c1Sdrh         }else{
44322fc865c1Sdrh           sqlite3VdbeAddOp2(v, OP_Null, 0, target);
44332fc865c1Sdrh         }
4434092457b1Sdrh       }else
4435092457b1Sdrh #endif
4436092457b1Sdrh       {
4437920cf596Sdrh         sqlite3VdbeAddFunctionCall(pParse, constMask, r1, target, nFarg,
443820cee7d0Sdrh                                    pDef, pExpr->op2);
44392fc865c1Sdrh       }
444013d79502Sdrh       if( nFarg ){
444113d79502Sdrh         if( constMask==0 ){
444212ffee8cSdrh           sqlite3ReleaseTempRange(pParse, r1, nFarg);
444313d79502Sdrh         }else{
44443aef2fb1Sdrh           sqlite3VdbeReleaseRegisters(pParse, r1, nFarg, constMask, 1);
444513d79502Sdrh         }
44462dcef11bSdrh       }
4447c332cc30Sdrh       return target;
44486ec2733bSdrh     }
4449fe2093d7Sdrh #ifndef SQLITE_OMIT_SUBQUERY
4450fe2093d7Sdrh     case TK_EXISTS:
445119a775c2Sdrh     case TK_SELECT: {
44528da209b1Sdan       int nCol;
4453c5499befSdrh       testcase( op==TK_EXISTS );
4454c5499befSdrh       testcase( op==TK_SELECT );
4455d8d335d7Sdrh       if( pParse->db->mallocFailed ){
4456d8d335d7Sdrh         return 0;
4457*a4eeccdfSdrh       }else if( op==TK_SELECT
4458*a4eeccdfSdrh              && ALWAYS( ExprUseXSelect(pExpr) )
4459*a4eeccdfSdrh              && (nCol = pExpr->x.pSelect->pEList->nExpr)!=1
4460*a4eeccdfSdrh       ){
44618da209b1Sdan         sqlite3SubselectError(pParse, nCol, 1);
44628da209b1Sdan       }else{
446385bcdce2Sdrh         return sqlite3CodeSubselect(pParse, pExpr);
44648da209b1Sdan       }
446519a775c2Sdrh       break;
446619a775c2Sdrh     }
4467fc7f27b9Sdrh     case TK_SELECT_COLUMN: {
4468966e2911Sdrh       int n;
4469fc7f27b9Sdrh       if( pExpr->pLeft->iTable==0 ){
447085bcdce2Sdrh         pExpr->pLeft->iTable = sqlite3CodeSubselect(pParse, pExpr->pLeft);
4471fc7f27b9Sdrh       }
447210f08270Sdrh       assert( pExpr->pLeft->op==TK_SELECT || pExpr->pLeft->op==TK_ERROR );
447310f08270Sdrh       n = sqlite3ExprVectorSize(pExpr->pLeft);
447410f08270Sdrh       if( pExpr->iTable!=n ){
4475966e2911Sdrh         sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
4476966e2911Sdrh                                 pExpr->iTable, n);
4477966e2911Sdrh       }
4478c332cc30Sdrh       return pExpr->pLeft->iTable + pExpr->iColumn;
4479fc7f27b9Sdrh     }
4480fef5208cSdrh     case TK_IN: {
4481ec4ccdbcSdrh       int destIfFalse = sqlite3VdbeMakeLabel(pParse);
4482ec4ccdbcSdrh       int destIfNull = sqlite3VdbeMakeLabel(pParse);
4483e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
4484e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
448566ba23ceSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
4486e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
4487e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_AddImm, target, 0);
4488e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfNull);
4489c332cc30Sdrh       return target;
4490fef5208cSdrh     }
4491e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
4492e3365e6cSdrh 
4493e3365e6cSdrh 
44942dcef11bSdrh     /*
44952dcef11bSdrh     **    x BETWEEN y AND z
44962dcef11bSdrh     **
44972dcef11bSdrh     ** This is equivalent to
44982dcef11bSdrh     **
44992dcef11bSdrh     **    x>=y AND x<=z
45002dcef11bSdrh     **
45012dcef11bSdrh     ** X is stored in pExpr->pLeft.
45022dcef11bSdrh     ** Y is stored in pExpr->pList->a[0].pExpr.
45032dcef11bSdrh     ** Z is stored in pExpr->pList->a[1].pExpr.
45042dcef11bSdrh     */
4505fef5208cSdrh     case TK_BETWEEN: {
450671c57db0Sdan       exprCodeBetween(pParse, pExpr, target, 0, 0);
4507c332cc30Sdrh       return target;
4508fef5208cSdrh     }
450994fa9c41Sdrh     case TK_SPAN:
4510ae80ddeaSdrh     case TK_COLLATE:
45114f07e5fbSdrh     case TK_UPLUS: {
45121efa8023Sdrh       pExpr = pExpr->pLeft;
451359ee43a7Sdrh       goto expr_code_doover; /* 2018-04-28: Prevent deep recursion. OSSFuzz. */
4514a2e00042Sdrh     }
45152dcef11bSdrh 
4516165921a7Sdan     case TK_TRIGGER: {
451765a7cd16Sdan       /* If the opcode is TK_TRIGGER, then the expression is a reference
451865a7cd16Sdan       ** to a column in the new.* or old.* pseudo-tables available to
451965a7cd16Sdan       ** trigger programs. In this case Expr.iTable is set to 1 for the
452065a7cd16Sdan       ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
452165a7cd16Sdan       ** is set to the column of the pseudo-table to read, or to -1 to
452265a7cd16Sdan       ** read the rowid field.
452365a7cd16Sdan       **
452465a7cd16Sdan       ** The expression is implemented using an OP_Param opcode. The p1
452565a7cd16Sdan       ** parameter is set to 0 for an old.rowid reference, or to (i+1)
452665a7cd16Sdan       ** to reference another column of the old.* pseudo-table, where
452765a7cd16Sdan       ** i is the index of the column. For a new.rowid reference, p1 is
452865a7cd16Sdan       ** set to (n+1), where n is the number of columns in each pseudo-table.
452965a7cd16Sdan       ** For a reference to any other column in the new.* pseudo-table, p1
453065a7cd16Sdan       ** is set to (n+2+i), where n and i are as defined previously. For
453165a7cd16Sdan       ** example, if the table on which triggers are being fired is
453265a7cd16Sdan       ** declared as:
453365a7cd16Sdan       **
453465a7cd16Sdan       **   CREATE TABLE t1(a, b);
453565a7cd16Sdan       **
453665a7cd16Sdan       ** Then p1 is interpreted as follows:
453765a7cd16Sdan       **
453865a7cd16Sdan       **   p1==0   ->    old.rowid     p1==3   ->    new.rowid
453965a7cd16Sdan       **   p1==1   ->    old.a         p1==4   ->    new.a
454065a7cd16Sdan       **   p1==2   ->    old.b         p1==5   ->    new.b
454165a7cd16Sdan       */
4542eda079cdSdrh       Table *pTab = pExpr->y.pTab;
4543dd6cc9b5Sdrh       int iCol = pExpr->iColumn;
4544dd6cc9b5Sdrh       int p1 = pExpr->iTable * (pTab->nCol+1) + 1
45457fe2fc0dSdrh                      + sqlite3TableColumnToStorage(pTab, iCol);
454665a7cd16Sdan 
454765a7cd16Sdan       assert( pExpr->iTable==0 || pExpr->iTable==1 );
4548dd6cc9b5Sdrh       assert( iCol>=-1 && iCol<pTab->nCol );
4549dd6cc9b5Sdrh       assert( pTab->iPKey<0 || iCol!=pTab->iPKey );
455065a7cd16Sdan       assert( p1>=0 && p1<(pTab->nCol*2+2) );
455165a7cd16Sdan 
455265a7cd16Sdan       sqlite3VdbeAddOp2(v, OP_Param, p1, target);
4553896494e8Sdrh       VdbeComment((v, "r[%d]=%s.%s", target,
4554165921a7Sdan         (pExpr->iTable ? "new" : "old"),
4555cf9d36d1Sdrh         (pExpr->iColumn<0 ? "rowid" : pExpr->y.pTab->aCol[iCol].zCnName)
4556165921a7Sdan       ));
455765a7cd16Sdan 
455844dbca83Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
455965a7cd16Sdan       /* If the column has REAL affinity, it may currently be stored as an
4560113762a2Sdrh       ** integer. Use OP_RealAffinity to make sure it is really real.
4561113762a2Sdrh       **
4562113762a2Sdrh       ** EVIDENCE-OF: R-60985-57662 SQLite will convert the value back to
4563113762a2Sdrh       ** floating point when extracting it from the record.  */
4564dd6cc9b5Sdrh       if( iCol>=0 && pTab->aCol[iCol].affinity==SQLITE_AFF_REAL ){
45652832ad42Sdan         sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
45662832ad42Sdan       }
456744dbca83Sdrh #endif
4568165921a7Sdan       break;
4569165921a7Sdan     }
4570165921a7Sdan 
457171c57db0Sdan     case TK_VECTOR: {
4572e835bc12Sdrh       sqlite3ErrorMsg(pParse, "row value misused");
457371c57db0Sdan       break;
457471c57db0Sdan     }
457571c57db0Sdan 
45769e9a67adSdrh     /* TK_IF_NULL_ROW Expr nodes are inserted ahead of expressions
45779e9a67adSdrh     ** that derive from the right-hand table of a LEFT JOIN.  The
45789e9a67adSdrh     ** Expr.iTable value is the table number for the right-hand table.
45799e9a67adSdrh     ** The expression is only evaluated if that table is not currently
45809e9a67adSdrh     ** on a LEFT JOIN NULL row.
45819e9a67adSdrh     */
458231d6fd55Sdrh     case TK_IF_NULL_ROW: {
458331d6fd55Sdrh       int addrINR;
45849e9a67adSdrh       u8 okConstFactor = pParse->okConstFactor;
458531d6fd55Sdrh       addrINR = sqlite3VdbeAddOp1(v, OP_IfNullRow, pExpr->iTable);
45869e9a67adSdrh       /* Temporarily disable factoring of constant expressions, since
45879e9a67adSdrh       ** even though expressions may appear to be constant, they are not
45889e9a67adSdrh       ** really constant because they originate from the right-hand side
45899e9a67adSdrh       ** of a LEFT JOIN. */
45909e9a67adSdrh       pParse->okConstFactor = 0;
459131d6fd55Sdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
45929e9a67adSdrh       pParse->okConstFactor = okConstFactor;
459331d6fd55Sdrh       sqlite3VdbeJumpHere(v, addrINR);
459431d6fd55Sdrh       sqlite3VdbeChangeP3(v, addrINR, inReg);
459531d6fd55Sdrh       break;
459631d6fd55Sdrh     }
459731d6fd55Sdrh 
45982dcef11bSdrh     /*
45992dcef11bSdrh     ** Form A:
46002dcef11bSdrh     **   CASE x WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
46012dcef11bSdrh     **
46022dcef11bSdrh     ** Form B:
46032dcef11bSdrh     **   CASE WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
46042dcef11bSdrh     **
46052dcef11bSdrh     ** Form A is can be transformed into the equivalent form B as follows:
46062dcef11bSdrh     **   CASE WHEN x=e1 THEN r1 WHEN x=e2 THEN r2 ...
46072dcef11bSdrh     **        WHEN x=eN THEN rN ELSE y END
46082dcef11bSdrh     **
46092dcef11bSdrh     ** X (if it exists) is in pExpr->pLeft.
4610c5cd1249Sdrh     ** Y is in the last element of pExpr->x.pList if pExpr->x.pList->nExpr is
4611c5cd1249Sdrh     ** odd.  The Y is also optional.  If the number of elements in x.pList
4612c5cd1249Sdrh     ** is even, then Y is omitted and the "otherwise" result is NULL.
46132dcef11bSdrh     ** Ei is in pExpr->pList->a[i*2] and Ri is pExpr->pList->a[i*2+1].
46142dcef11bSdrh     **
46152dcef11bSdrh     ** The result of the expression is the Ri for the first matching Ei,
46162dcef11bSdrh     ** or if there is no matching Ei, the ELSE term Y, or if there is
46172dcef11bSdrh     ** no ELSE term, NULL.
46182dcef11bSdrh     */
4619aac30f9bSdrh     case TK_CASE: {
46202dcef11bSdrh       int endLabel;                     /* GOTO label for end of CASE stmt */
46212dcef11bSdrh       int nextCase;                     /* GOTO label for next WHEN clause */
46222dcef11bSdrh       int nExpr;                        /* 2x number of WHEN terms */
46232dcef11bSdrh       int i;                            /* Loop counter */
46242dcef11bSdrh       ExprList *pEList;                 /* List of WHEN terms */
46252dcef11bSdrh       struct ExprList_item *aListelem;  /* Array of WHEN terms */
46262dcef11bSdrh       Expr opCompare;                   /* The X==Ei expression */
46272dcef11bSdrh       Expr *pX;                         /* The X expression */
46281bd10f8aSdrh       Expr *pTest = 0;                  /* X==Ei (form A) or just Ei (form B) */
46298b65e591Sdan       Expr *pDel = 0;
46308b65e591Sdan       sqlite3 *db = pParse->db;
463117a7f8ddSdrh 
4632*a4eeccdfSdrh       assert( ExprUseXList(pExpr) && pExpr->x.pList!=0 );
46336ab3a2ecSdanielk1977       assert(pExpr->x.pList->nExpr > 0);
46346ab3a2ecSdanielk1977       pEList = pExpr->x.pList;
4635be5c89acSdrh       aListelem = pEList->a;
4636be5c89acSdrh       nExpr = pEList->nExpr;
4637ec4ccdbcSdrh       endLabel = sqlite3VdbeMakeLabel(pParse);
46382dcef11bSdrh       if( (pX = pExpr->pLeft)!=0 ){
46398b65e591Sdan         pDel = sqlite3ExprDup(db, pX, 0);
46408b65e591Sdan         if( db->mallocFailed ){
46418b65e591Sdan           sqlite3ExprDelete(db, pDel);
46428b65e591Sdan           break;
46438b65e591Sdan         }
464433cd4909Sdrh         testcase( pX->op==TK_COLUMN );
46458b65e591Sdan         exprToRegister(pDel, exprCodeVector(pParse, pDel, &regFree1));
4646c5499befSdrh         testcase( regFree1==0 );
4647abb9d5f1Sdrh         memset(&opCompare, 0, sizeof(opCompare));
46482dcef11bSdrh         opCompare.op = TK_EQ;
46498b65e591Sdan         opCompare.pLeft = pDel;
46502dcef11bSdrh         pTest = &opCompare;
46518b1db07fSdrh         /* Ticket b351d95f9cd5ef17e9d9dbae18f5ca8611190001:
46528b1db07fSdrh         ** The value in regFree1 might get SCopy-ed into the file result.
46538b1db07fSdrh         ** So make sure that the regFree1 register is not reused for other
46548b1db07fSdrh         ** purposes and possibly overwritten.  */
46558b1db07fSdrh         regFree1 = 0;
4656cce7d176Sdrh       }
4657c5cd1249Sdrh       for(i=0; i<nExpr-1; i=i+2){
46582dcef11bSdrh         if( pX ){
46591bd10f8aSdrh           assert( pTest!=0 );
46602dcef11bSdrh           opCompare.pRight = aListelem[i].pExpr;
4661f5905aa7Sdrh         }else{
46622dcef11bSdrh           pTest = aListelem[i].pExpr;
466317a7f8ddSdrh         }
4664ec4ccdbcSdrh         nextCase = sqlite3VdbeMakeLabel(pParse);
466533cd4909Sdrh         testcase( pTest->op==TK_COLUMN );
46662dcef11bSdrh         sqlite3ExprIfFalse(pParse, pTest, nextCase, SQLITE_JUMPIFNULL);
4667c5499befSdrh         testcase( aListelem[i+1].pExpr->op==TK_COLUMN );
46689de221dfSdrh         sqlite3ExprCode(pParse, aListelem[i+1].pExpr, target);
4669076e85f5Sdrh         sqlite3VdbeGoto(v, endLabel);
46702dcef11bSdrh         sqlite3VdbeResolveLabel(v, nextCase);
4671f570f011Sdrh       }
4672c5cd1249Sdrh       if( (nExpr&1)!=0 ){
4673c5cd1249Sdrh         sqlite3ExprCode(pParse, pEList->a[nExpr-1].pExpr, target);
467417a7f8ddSdrh       }else{
46759de221dfSdrh         sqlite3VdbeAddOp2(v, OP_Null, 0, target);
467617a7f8ddSdrh       }
46778b65e591Sdan       sqlite3ExprDelete(db, pDel);
467892a27f7bSdrh       setDoNotMergeFlagOnCopy(v);
46792dcef11bSdrh       sqlite3VdbeResolveLabel(v, endLabel);
46806f34903eSdanielk1977       break;
46816f34903eSdanielk1977     }
46825338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_TRIGGER
46836f34903eSdanielk1977     case TK_RAISE: {
46841194904bSdrh       assert( pExpr->affExpr==OE_Rollback
46851194904bSdrh            || pExpr->affExpr==OE_Abort
46861194904bSdrh            || pExpr->affExpr==OE_Fail
46871194904bSdrh            || pExpr->affExpr==OE_Ignore
4688165921a7Sdan       );
46899e5fdc41Sdrh       if( !pParse->pTriggerTab && !pParse->nested ){
4690e0af83acSdan         sqlite3ErrorMsg(pParse,
4691e0af83acSdan                        "RAISE() may only be used within a trigger-program");
4692e0af83acSdan         return 0;
4693e0af83acSdan       }
46941194904bSdrh       if( pExpr->affExpr==OE_Abort ){
4695e0af83acSdan         sqlite3MayAbort(pParse);
4696e0af83acSdan       }
469733e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
46981194904bSdrh       if( pExpr->affExpr==OE_Ignore ){
4699e0af83acSdan         sqlite3VdbeAddOp4(
4700e0af83acSdan             v, OP_Halt, SQLITE_OK, OE_Ignore, 0, pExpr->u.zToken,0);
4701688852abSdrh         VdbeCoverage(v);
4702e0af83acSdan       }else{
47039e5fdc41Sdrh         sqlite3HaltConstraint(pParse,
47049e5fdc41Sdrh              pParse->pTriggerTab ? SQLITE_CONSTRAINT_TRIGGER : SQLITE_ERROR,
47051194904bSdrh              pExpr->affExpr, pExpr->u.zToken, 0, 0);
4706e0af83acSdan       }
4707e0af83acSdan 
4708ffe07b2dSdrh       break;
470917a7f8ddSdrh     }
47105338a5f7Sdanielk1977 #endif
4711ffe07b2dSdrh   }
47122dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
47132dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
47142dcef11bSdrh   return inReg;
47155b6afba9Sdrh }
47162dcef11bSdrh 
47172dcef11bSdrh /*
47189b258c54Sdrh ** Generate code that will evaluate expression pExpr just one time
47199b258c54Sdrh ** per prepared statement execution.
47209b258c54Sdrh **
47219b258c54Sdrh ** If the expression uses functions (that might throw an exception) then
47229b258c54Sdrh ** guard them with an OP_Once opcode to ensure that the code is only executed
47239b258c54Sdrh ** once. If no functions are involved, then factor the code out and put it at
47249b258c54Sdrh ** the end of the prepared statement in the initialization section.
47251e9b53f9Sdrh **
4726ad879ffdSdrh ** If regDest>=0 then the result is always stored in that register and the
4727ad879ffdSdrh ** result is not reusable.  If regDest<0 then this routine is free to
4728ad879ffdSdrh ** store the value whereever it wants.  The register where the expression
47299b258c54Sdrh ** is stored is returned.  When regDest<0, two identical expressions might
47309b258c54Sdrh ** code to the same register, if they do not contain function calls and hence
47319b258c54Sdrh ** are factored out into the initialization section at the end of the
47329b258c54Sdrh ** prepared statement.
4733d1a01edaSdrh */
47349b258c54Sdrh int sqlite3ExprCodeRunJustOnce(
4735d673cddaSdrh   Parse *pParse,    /* Parsing context */
4736d673cddaSdrh   Expr *pExpr,      /* The expression to code when the VDBE initializes */
4737ad879ffdSdrh   int regDest       /* Store the value in this register */
4738d673cddaSdrh ){
4739d1a01edaSdrh   ExprList *p;
4740d9f158e7Sdrh   assert( ConstFactorOk(pParse) );
4741d1a01edaSdrh   p = pParse->pConstExpr;
4742ad879ffdSdrh   if( regDest<0 && p ){
47431e9b53f9Sdrh     struct ExprList_item *pItem;
47441e9b53f9Sdrh     int i;
47451e9b53f9Sdrh     for(pItem=p->a, i=p->nExpr; i>0; pItem++, i--){
47465aa550cfSdan       if( pItem->reusable && sqlite3ExprCompare(0,pItem->pExpr,pExpr,-1)==0 ){
47471e9b53f9Sdrh         return pItem->u.iConstExprReg;
47481e9b53f9Sdrh       }
47491e9b53f9Sdrh     }
47501e9b53f9Sdrh   }
4751d1a01edaSdrh   pExpr = sqlite3ExprDup(pParse->db, pExpr, 0);
475238dfbdaeSdrh   if( pExpr!=0 && ExprHasProperty(pExpr, EP_HasFunc) ){
475338dfbdaeSdrh     Vdbe *v = pParse->pVdbe;
475438dfbdaeSdrh     int addr;
475538dfbdaeSdrh     assert( v );
475638dfbdaeSdrh     addr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
475738dfbdaeSdrh     pParse->okConstFactor = 0;
475838dfbdaeSdrh     if( !pParse->db->mallocFailed ){
47599b258c54Sdrh       if( regDest<0 ) regDest = ++pParse->nMem;
476038dfbdaeSdrh       sqlite3ExprCode(pParse, pExpr, regDest);
476138dfbdaeSdrh     }
476238dfbdaeSdrh     pParse->okConstFactor = 1;
476338dfbdaeSdrh     sqlite3ExprDelete(pParse->db, pExpr);
476438dfbdaeSdrh     sqlite3VdbeJumpHere(v, addr);
476538dfbdaeSdrh   }else{
4766d1a01edaSdrh     p = sqlite3ExprListAppend(pParse, p, pExpr);
4767d673cddaSdrh     if( p ){
4768d673cddaSdrh        struct ExprList_item *pItem = &p->a[p->nExpr-1];
4769ad879ffdSdrh        pItem->reusable = regDest<0;
47709b258c54Sdrh        if( regDest<0 ) regDest = ++pParse->nMem;
4771d673cddaSdrh        pItem->u.iConstExprReg = regDest;
4772d673cddaSdrh     }
4773d1a01edaSdrh     pParse->pConstExpr = p;
477438dfbdaeSdrh   }
47751e9b53f9Sdrh   return regDest;
4776d1a01edaSdrh }
4777d1a01edaSdrh 
4778d1a01edaSdrh /*
47792dcef11bSdrh ** Generate code to evaluate an expression and store the results
47802dcef11bSdrh ** into a register.  Return the register number where the results
47812dcef11bSdrh ** are stored.
47822dcef11bSdrh **
47832dcef11bSdrh ** If the register is a temporary register that can be deallocated,
4784678ccce8Sdrh ** then write its number into *pReg.  If the result register is not
47852dcef11bSdrh ** a temporary, then set *pReg to zero.
4786f30a969bSdrh **
4787f30a969bSdrh ** If pExpr is a constant, then this routine might generate this
4788f30a969bSdrh ** code to fill the register in the initialization section of the
4789f30a969bSdrh ** VDBE program, in order to factor it out of the evaluation loop.
47902dcef11bSdrh */
47912dcef11bSdrh int sqlite3ExprCodeTemp(Parse *pParse, Expr *pExpr, int *pReg){
4792f30a969bSdrh   int r2;
47930d950af3Sdrh   pExpr = sqlite3ExprSkipCollateAndLikely(pExpr);
4794d9f158e7Sdrh   if( ConstFactorOk(pParse)
4795235667a8Sdrh    && ALWAYS(pExpr!=0)
4796f30a969bSdrh    && pExpr->op!=TK_REGISTER
4797f30a969bSdrh    && sqlite3ExprIsConstantNotJoin(pExpr)
4798f30a969bSdrh   ){
4799f30a969bSdrh     *pReg  = 0;
48009b258c54Sdrh     r2 = sqlite3ExprCodeRunJustOnce(pParse, pExpr, -1);
4801f30a969bSdrh   }else{
48022dcef11bSdrh     int r1 = sqlite3GetTempReg(pParse);
4803f30a969bSdrh     r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
48042dcef11bSdrh     if( r2==r1 ){
48052dcef11bSdrh       *pReg = r1;
48062dcef11bSdrh     }else{
48072dcef11bSdrh       sqlite3ReleaseTempReg(pParse, r1);
48082dcef11bSdrh       *pReg = 0;
48092dcef11bSdrh     }
4810f30a969bSdrh   }
48112dcef11bSdrh   return r2;
48122dcef11bSdrh }
48132dcef11bSdrh 
48142dcef11bSdrh /*
48152dcef11bSdrh ** Generate code that will evaluate expression pExpr and store the
48162dcef11bSdrh ** results in register target.  The results are guaranteed to appear
48172dcef11bSdrh ** in register target.
48182dcef11bSdrh */
481905a86c5cSdrh void sqlite3ExprCode(Parse *pParse, Expr *pExpr, int target){
48209cbf3425Sdrh   int inReg;
48219cbf3425Sdrh 
4822e7375bfaSdrh   assert( pExpr==0 || !ExprHasVVAProperty(pExpr,EP_Immutable) );
48239cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
48241c75c9d7Sdrh   assert( pParse->pVdbe!=0 || pParse->db->mallocFailed );
4825b639a209Sdrh   if( pParse->pVdbe==0 ) return;
4826b639a209Sdrh   inReg = sqlite3ExprCodeTarget(pParse, pExpr, target);
4827b639a209Sdrh   if( inReg!=target ){
4828629b88c6Sdrh     u8 op;
4829952f35b2Sdrh     if( ALWAYS(pExpr) && ExprHasProperty(pExpr,EP_Subquery) ){
4830629b88c6Sdrh       op = OP_Copy;
4831629b88c6Sdrh     }else{
4832629b88c6Sdrh       op = OP_SCopy;
4833629b88c6Sdrh     }
4834629b88c6Sdrh     sqlite3VdbeAddOp2(pParse->pVdbe, op, inReg, target);
483517a7f8ddSdrh   }
4836ebc16717Sdrh }
4837cce7d176Sdrh 
4838cce7d176Sdrh /*
48391c75c9d7Sdrh ** Make a transient copy of expression pExpr and then code it using
48401c75c9d7Sdrh ** sqlite3ExprCode().  This routine works just like sqlite3ExprCode()
48411c75c9d7Sdrh ** except that the input expression is guaranteed to be unchanged.
48421c75c9d7Sdrh */
48431c75c9d7Sdrh void sqlite3ExprCodeCopy(Parse *pParse, Expr *pExpr, int target){
48441c75c9d7Sdrh   sqlite3 *db = pParse->db;
48451c75c9d7Sdrh   pExpr = sqlite3ExprDup(db, pExpr, 0);
48461c75c9d7Sdrh   if( !db->mallocFailed ) sqlite3ExprCode(pParse, pExpr, target);
48471c75c9d7Sdrh   sqlite3ExprDelete(db, pExpr);
48481c75c9d7Sdrh }
48491c75c9d7Sdrh 
48501c75c9d7Sdrh /*
485105a86c5cSdrh ** Generate code that will evaluate expression pExpr and store the
485205a86c5cSdrh ** results in register target.  The results are guaranteed to appear
485305a86c5cSdrh ** in register target.  If the expression is constant, then this routine
485405a86c5cSdrh ** might choose to code the expression at initialization time.
485505a86c5cSdrh */
485605a86c5cSdrh void sqlite3ExprCodeFactorable(Parse *pParse, Expr *pExpr, int target){
4857b8b06690Sdrh   if( pParse->okConstFactor && sqlite3ExprIsConstantNotJoin(pExpr) ){
48589b258c54Sdrh     sqlite3ExprCodeRunJustOnce(pParse, pExpr, target);
485905a86c5cSdrh   }else{
4860088489e8Sdrh     sqlite3ExprCodeCopy(pParse, pExpr, target);
486105a86c5cSdrh   }
4862cce7d176Sdrh }
4863cce7d176Sdrh 
4864cce7d176Sdrh /*
4865268380caSdrh ** Generate code that pushes the value of every element of the given
48669cbf3425Sdrh ** expression list into a sequence of registers beginning at target.
4867268380caSdrh **
48683df6c3b1Sdrh ** Return the number of elements evaluated.  The number returned will
48693df6c3b1Sdrh ** usually be pList->nExpr but might be reduced if SQLITE_ECEL_OMITREF
48703df6c3b1Sdrh ** is defined.
4871d1a01edaSdrh **
4872d1a01edaSdrh ** The SQLITE_ECEL_DUP flag prevents the arguments from being
4873d1a01edaSdrh ** filled using OP_SCopy.  OP_Copy must be used instead.
4874d1a01edaSdrh **
4875d1a01edaSdrh ** The SQLITE_ECEL_FACTOR argument allows constant arguments to be
4876d1a01edaSdrh ** factored out into initialization code.
4877b0df9634Sdrh **
4878b0df9634Sdrh ** The SQLITE_ECEL_REF flag means that expressions in the list with
4879b0df9634Sdrh ** ExprList.a[].u.x.iOrderByCol>0 have already been evaluated and stored
4880b0df9634Sdrh ** in registers at srcReg, and so the value can be copied from there.
48813df6c3b1Sdrh ** If SQLITE_ECEL_OMITREF is also set, then the values with u.x.iOrderByCol>0
48823df6c3b1Sdrh ** are simply omitted rather than being copied from srcReg.
4883268380caSdrh */
48844adee20fSdanielk1977 int sqlite3ExprCodeExprList(
4885268380caSdrh   Parse *pParse,     /* Parsing context */
4886389a1adbSdrh   ExprList *pList,   /* The expression list to be coded */
4887191b54cbSdrh   int target,        /* Where to write results */
48885579d59fSdrh   int srcReg,        /* Source registers if SQLITE_ECEL_REF */
4889d1a01edaSdrh   u8 flags           /* SQLITE_ECEL_* flags */
4890268380caSdrh ){
4891268380caSdrh   struct ExprList_item *pItem;
48925579d59fSdrh   int i, j, n;
4893d1a01edaSdrh   u8 copyOp = (flags & SQLITE_ECEL_DUP) ? OP_Copy : OP_SCopy;
48945579d59fSdrh   Vdbe *v = pParse->pVdbe;
48959d8b3072Sdrh   assert( pList!=0 );
48969cbf3425Sdrh   assert( target>0 );
4897d81a142bSdrh   assert( pParse->pVdbe!=0 );  /* Never gets this far otherwise */
4898268380caSdrh   n = pList->nExpr;
4899d9f158e7Sdrh   if( !ConstFactorOk(pParse) ) flags &= ~SQLITE_ECEL_FACTOR;
4900191b54cbSdrh   for(pItem=pList->a, i=0; i<n; i++, pItem++){
49017445ffe2Sdrh     Expr *pExpr = pItem->pExpr;
490224e25d32Sdan #ifdef SQLITE_ENABLE_SORTER_REFERENCES
490324e25d32Sdan     if( pItem->bSorterRef ){
490424e25d32Sdan       i--;
490524e25d32Sdan       n--;
490624e25d32Sdan     }else
490724e25d32Sdan #endif
4908257c13faSdan     if( (flags & SQLITE_ECEL_REF)!=0 && (j = pItem->u.x.iOrderByCol)>0 ){
4909257c13faSdan       if( flags & SQLITE_ECEL_OMITREF ){
4910257c13faSdan         i--;
4911257c13faSdan         n--;
4912257c13faSdan       }else{
49135579d59fSdrh         sqlite3VdbeAddOp2(v, copyOp, j+srcReg-1, target+i);
4914257c13faSdan       }
4915b8b06690Sdrh     }else if( (flags & SQLITE_ECEL_FACTOR)!=0
4916b8b06690Sdrh            && sqlite3ExprIsConstantNotJoin(pExpr)
4917b8b06690Sdrh     ){
49189b258c54Sdrh       sqlite3ExprCodeRunJustOnce(pParse, pExpr, target+i);
4919d1a01edaSdrh     }else{
49207445ffe2Sdrh       int inReg = sqlite3ExprCodeTarget(pParse, pExpr, target+i);
4921746fd9ccSdrh       if( inReg!=target+i ){
49224eded604Sdrh         VdbeOp *pOp;
49234eded604Sdrh         if( copyOp==OP_Copy
49244eded604Sdrh          && (pOp=sqlite3VdbeGetOp(v, -1))->opcode==OP_Copy
49254eded604Sdrh          && pOp->p1+pOp->p3+1==inReg
49264eded604Sdrh          && pOp->p2+pOp->p3+1==target+i
492790996885Sdrh          && pOp->p5==0  /* The do-not-merge flag must be clear */
49284eded604Sdrh         ){
49294eded604Sdrh           pOp->p3++;
49304eded604Sdrh         }else{
49314eded604Sdrh           sqlite3VdbeAddOp2(v, copyOp, inReg, target+i);
49324eded604Sdrh         }
4933d1a01edaSdrh       }
4934d176611bSdrh     }
4935268380caSdrh   }
4936f9b596ebSdrh   return n;
4937268380caSdrh }
4938268380caSdrh 
4939268380caSdrh /*
494036c563a2Sdrh ** Generate code for a BETWEEN operator.
494136c563a2Sdrh **
494236c563a2Sdrh **    x BETWEEN y AND z
494336c563a2Sdrh **
494436c563a2Sdrh ** The above is equivalent to
494536c563a2Sdrh **
494636c563a2Sdrh **    x>=y AND x<=z
494736c563a2Sdrh **
494836c563a2Sdrh ** Code it as such, taking care to do the common subexpression
494960ec914cSpeter.d.reid ** elimination of x.
495084b19a3dSdrh **
495184b19a3dSdrh ** The xJumpIf parameter determines details:
495284b19a3dSdrh **
495384b19a3dSdrh **    NULL:                   Store the boolean result in reg[dest]
495484b19a3dSdrh **    sqlite3ExprIfTrue:      Jump to dest if true
495584b19a3dSdrh **    sqlite3ExprIfFalse:     Jump to dest if false
495684b19a3dSdrh **
495784b19a3dSdrh ** The jumpIfNull parameter is ignored if xJumpIf is NULL.
495836c563a2Sdrh */
495936c563a2Sdrh static void exprCodeBetween(
496036c563a2Sdrh   Parse *pParse,    /* Parsing and code generating context */
496136c563a2Sdrh   Expr *pExpr,      /* The BETWEEN expression */
496284b19a3dSdrh   int dest,         /* Jump destination or storage location */
496384b19a3dSdrh   void (*xJump)(Parse*,Expr*,int,int), /* Action to take */
496436c563a2Sdrh   int jumpIfNull    /* Take the jump if the BETWEEN is NULL */
496536c563a2Sdrh ){
496636c563a2Sdrh   Expr exprAnd;     /* The AND operator in  x>=y AND x<=z  */
496736c563a2Sdrh   Expr compLeft;    /* The  x>=y  term */
496836c563a2Sdrh   Expr compRight;   /* The  x<=z  term */
4969db45bd5eSdrh   int regFree1 = 0; /* Temporary use register */
49708b65e591Sdan   Expr *pDel = 0;
49718b65e591Sdan   sqlite3 *db = pParse->db;
497284b19a3dSdrh 
497371c57db0Sdan   memset(&compLeft, 0, sizeof(Expr));
497471c57db0Sdan   memset(&compRight, 0, sizeof(Expr));
497571c57db0Sdan   memset(&exprAnd, 0, sizeof(Expr));
4976db45bd5eSdrh 
4977*a4eeccdfSdrh   assert( ExprUseXList(pExpr) );
49788b65e591Sdan   pDel = sqlite3ExprDup(db, pExpr->pLeft, 0);
49798b65e591Sdan   if( db->mallocFailed==0 ){
498036c563a2Sdrh     exprAnd.op = TK_AND;
498136c563a2Sdrh     exprAnd.pLeft = &compLeft;
498236c563a2Sdrh     exprAnd.pRight = &compRight;
498336c563a2Sdrh     compLeft.op = TK_GE;
49848b65e591Sdan     compLeft.pLeft = pDel;
498536c563a2Sdrh     compLeft.pRight = pExpr->x.pList->a[0].pExpr;
498636c563a2Sdrh     compRight.op = TK_LE;
49878b65e591Sdan     compRight.pLeft = pDel;
498836c563a2Sdrh     compRight.pRight = pExpr->x.pList->a[1].pExpr;
49898b65e591Sdan     exprToRegister(pDel, exprCodeVector(pParse, pDel, &regFree1));
499084b19a3dSdrh     if( xJump ){
499184b19a3dSdrh       xJump(pParse, &exprAnd, dest, jumpIfNull);
499236c563a2Sdrh     }else{
499336fd41e5Sdrh       /* Mark the expression is being from the ON or USING clause of a join
499436fd41e5Sdrh       ** so that the sqlite3ExprCodeTarget() routine will not attempt to move
499536fd41e5Sdrh       ** it into the Parse.pConstExpr list.  We should use a new bit for this,
499636fd41e5Sdrh       ** for clarity, but we are out of bits in the Expr.flags field so we
499736fd41e5Sdrh       ** have to reuse the EP_FromJoin bit.  Bummer. */
49988b65e591Sdan       pDel->flags |= EP_FromJoin;
499971c57db0Sdan       sqlite3ExprCodeTarget(pParse, &exprAnd, dest);
500036c563a2Sdrh     }
5001db45bd5eSdrh     sqlite3ReleaseTempReg(pParse, regFree1);
50028b65e591Sdan   }
50038b65e591Sdan   sqlite3ExprDelete(db, pDel);
500436c563a2Sdrh 
500536c563a2Sdrh   /* Ensure adequate test coverage */
5006db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull==0 && regFree1==0 );
5007db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull==0 && regFree1!=0 );
5008db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull!=0 && regFree1==0 );
5009db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull!=0 && regFree1!=0 );
5010db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1==0 );
5011db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1!=0 );
5012db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1==0 );
5013db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1!=0 );
501484b19a3dSdrh   testcase( xJump==0 );
501536c563a2Sdrh }
501636c563a2Sdrh 
501736c563a2Sdrh /*
5018cce7d176Sdrh ** Generate code for a boolean expression such that a jump is made
5019cce7d176Sdrh ** to the label "dest" if the expression is true but execution
5020cce7d176Sdrh ** continues straight thru if the expression is false.
5021f5905aa7Sdrh **
5022f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false), then
502335573356Sdrh ** take the jump if the jumpIfNull flag is SQLITE_JUMPIFNULL.
5024f2bc013cSdrh **
5025f2bc013cSdrh ** This code depends on the fact that certain token values (ex: TK_EQ)
5026f2bc013cSdrh ** are the same as opcode values (ex: OP_Eq) that implement the corresponding
5027f2bc013cSdrh ** operation.  Special comments in vdbe.c and the mkopcodeh.awk script in
5028f2bc013cSdrh ** the make process cause these values to align.  Assert()s in the code
5029f2bc013cSdrh ** below verify that the numbers are aligned correctly.
5030cce7d176Sdrh */
50314adee20fSdanielk1977 void sqlite3ExprIfTrue(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
5032cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
5033cce7d176Sdrh   int op = 0;
50342dcef11bSdrh   int regFree1 = 0;
50352dcef11bSdrh   int regFree2 = 0;
50362dcef11bSdrh   int r1, r2;
50372dcef11bSdrh 
503835573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
503948864df9Smistachkin   if( NEVER(v==0) )     return;  /* Existence of VDBE checked by caller */
504033cd4909Sdrh   if( NEVER(pExpr==0) ) return;  /* No way this can happen */
5041e7375bfaSdrh   assert( !ExprHasVVAProperty(pExpr, EP_Immutable) );
5042f2bc013cSdrh   op = pExpr->op;
50437b35a77bSdan   switch( op ){
504417180fcaSdrh     case TK_AND:
504517180fcaSdrh     case TK_OR: {
504617180fcaSdrh       Expr *pAlt = sqlite3ExprSimplifiedAndOr(pExpr);
504717180fcaSdrh       if( pAlt!=pExpr ){
504817180fcaSdrh         sqlite3ExprIfTrue(pParse, pAlt, dest, jumpIfNull);
504917180fcaSdrh       }else if( op==TK_AND ){
5050ec4ccdbcSdrh         int d2 = sqlite3VdbeMakeLabel(pParse);
5051c5499befSdrh         testcase( jumpIfNull==0 );
505217180fcaSdrh         sqlite3ExprIfFalse(pParse, pExpr->pLeft, d2,
505317180fcaSdrh                            jumpIfNull^SQLITE_JUMPIFNULL);
50544adee20fSdanielk1977         sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
50554adee20fSdanielk1977         sqlite3VdbeResolveLabel(v, d2);
505617180fcaSdrh       }else{
5057c5499befSdrh         testcase( jumpIfNull==0 );
50584adee20fSdanielk1977         sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
50594adee20fSdanielk1977         sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
506017180fcaSdrh       }
5061cce7d176Sdrh       break;
5062cce7d176Sdrh     }
5063cce7d176Sdrh     case TK_NOT: {
5064c5499befSdrh       testcase( jumpIfNull==0 );
50654adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
5066cce7d176Sdrh       break;
5067cce7d176Sdrh     }
50688abed7b9Sdrh     case TK_TRUTH: {
506996acafbeSdrh       int isNot;      /* IS NOT TRUE or IS NOT FALSE */
507096acafbeSdrh       int isTrue;     /* IS TRUE or IS NOT TRUE */
5071007c843bSdrh       testcase( jumpIfNull==0 );
50728abed7b9Sdrh       isNot = pExpr->op2==TK_ISNOT;
507396acafbeSdrh       isTrue = sqlite3ExprTruthValue(pExpr->pRight);
507443c4ac8bSdrh       testcase( isTrue && isNot );
507596acafbeSdrh       testcase( !isTrue && isNot );
507643c4ac8bSdrh       if( isTrue ^ isNot ){
50778abed7b9Sdrh         sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
50788abed7b9Sdrh                           isNot ? SQLITE_JUMPIFNULL : 0);
50798abed7b9Sdrh       }else{
50808abed7b9Sdrh         sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
50818abed7b9Sdrh                            isNot ? SQLITE_JUMPIFNULL : 0);
50828abed7b9Sdrh       }
5083007c843bSdrh       break;
5084007c843bSdrh     }
5085de845c2fSdrh     case TK_IS:
5086de845c2fSdrh     case TK_ISNOT:
5087de845c2fSdrh       testcase( op==TK_IS );
5088de845c2fSdrh       testcase( op==TK_ISNOT );
5089de845c2fSdrh       op = (op==TK_IS) ? TK_EQ : TK_NE;
5090de845c2fSdrh       jumpIfNull = SQLITE_NULLEQ;
509108b92086Sdrh       /* no break */ deliberate_fall_through
5092cce7d176Sdrh     case TK_LT:
5093cce7d176Sdrh     case TK_LE:
5094cce7d176Sdrh     case TK_GT:
5095cce7d176Sdrh     case TK_GE:
5096cce7d176Sdrh     case TK_NE:
50970ac65892Sdrh     case TK_EQ: {
5098625015e0Sdan       if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
5099c5499befSdrh       testcase( jumpIfNull==0 );
5100b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
5101b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
510235573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
5103898c527eSdrh                   r1, r2, dest, jumpIfNull, ExprHasProperty(pExpr,EP_Commuted));
51047d176105Sdrh       assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
51057d176105Sdrh       assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
51067d176105Sdrh       assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
51077d176105Sdrh       assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
5108de845c2fSdrh       assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
5109de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
5110de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
5111de845c2fSdrh       assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
5112de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
5113de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
51146a2fe093Sdrh       testcase( regFree1==0 );
51156a2fe093Sdrh       testcase( regFree2==0 );
51166a2fe093Sdrh       break;
51176a2fe093Sdrh     }
5118cce7d176Sdrh     case TK_ISNULL:
5119cce7d176Sdrh     case TK_NOTNULL: {
51207d176105Sdrh       assert( TK_ISNULL==OP_IsNull );   testcase( op==TK_ISNULL );
51217d176105Sdrh       assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
51222dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
51232dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
51247d176105Sdrh       VdbeCoverageIf(v, op==TK_ISNULL);
51257d176105Sdrh       VdbeCoverageIf(v, op==TK_NOTNULL);
5126c5499befSdrh       testcase( regFree1==0 );
5127cce7d176Sdrh       break;
5128cce7d176Sdrh     }
5129fef5208cSdrh     case TK_BETWEEN: {
51305c03f30aSdrh       testcase( jumpIfNull==0 );
513171c57db0Sdan       exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfTrue, jumpIfNull);
5132fef5208cSdrh       break;
5133fef5208cSdrh     }
5134bb201344Sshaneh #ifndef SQLITE_OMIT_SUBQUERY
5135e3365e6cSdrh     case TK_IN: {
5136ec4ccdbcSdrh       int destIfFalse = sqlite3VdbeMakeLabel(pParse);
5137e3365e6cSdrh       int destIfNull = jumpIfNull ? dest : destIfFalse;
5138e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
5139076e85f5Sdrh       sqlite3VdbeGoto(v, dest);
5140e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
5141e3365e6cSdrh       break;
5142e3365e6cSdrh     }
5143bb201344Sshaneh #endif
5144cce7d176Sdrh     default: {
51457b35a77bSdan     default_expr:
5146ad31727fSdrh       if( ExprAlwaysTrue(pExpr) ){
5147076e85f5Sdrh         sqlite3VdbeGoto(v, dest);
5148ad31727fSdrh       }else if( ExprAlwaysFalse(pExpr) ){
5149991a1985Sdrh         /* No-op */
5150991a1985Sdrh       }else{
51512dcef11bSdrh         r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
51522dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_If, r1, dest, jumpIfNull!=0);
5153688852abSdrh         VdbeCoverage(v);
5154c5499befSdrh         testcase( regFree1==0 );
5155c5499befSdrh         testcase( jumpIfNull==0 );
5156991a1985Sdrh       }
5157cce7d176Sdrh       break;
5158cce7d176Sdrh     }
5159cce7d176Sdrh   }
51602dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
51612dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
5162cce7d176Sdrh }
5163cce7d176Sdrh 
5164cce7d176Sdrh /*
516566b89c8fSdrh ** Generate code for a boolean expression such that a jump is made
5166cce7d176Sdrh ** to the label "dest" if the expression is false but execution
5167cce7d176Sdrh ** continues straight thru if the expression is true.
5168f5905aa7Sdrh **
5169f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false) then
517035573356Sdrh ** jump if jumpIfNull is SQLITE_JUMPIFNULL or fall through if jumpIfNull
517135573356Sdrh ** is 0.
5172cce7d176Sdrh */
51734adee20fSdanielk1977 void sqlite3ExprIfFalse(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
5174cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
5175cce7d176Sdrh   int op = 0;
51762dcef11bSdrh   int regFree1 = 0;
51772dcef11bSdrh   int regFree2 = 0;
51782dcef11bSdrh   int r1, r2;
51792dcef11bSdrh 
518035573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
518148864df9Smistachkin   if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
518233cd4909Sdrh   if( pExpr==0 )    return;
5183e7375bfaSdrh   assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
5184f2bc013cSdrh 
5185f2bc013cSdrh   /* The value of pExpr->op and op are related as follows:
5186f2bc013cSdrh   **
5187f2bc013cSdrh   **       pExpr->op            op
5188f2bc013cSdrh   **       ---------          ----------
5189f2bc013cSdrh   **       TK_ISNULL          OP_NotNull
5190f2bc013cSdrh   **       TK_NOTNULL         OP_IsNull
5191f2bc013cSdrh   **       TK_NE              OP_Eq
5192f2bc013cSdrh   **       TK_EQ              OP_Ne
5193f2bc013cSdrh   **       TK_GT              OP_Le
5194f2bc013cSdrh   **       TK_LE              OP_Gt
5195f2bc013cSdrh   **       TK_GE              OP_Lt
5196f2bc013cSdrh   **       TK_LT              OP_Ge
5197f2bc013cSdrh   **
5198f2bc013cSdrh   ** For other values of pExpr->op, op is undefined and unused.
5199f2bc013cSdrh   ** The value of TK_ and OP_ constants are arranged such that we
5200f2bc013cSdrh   ** can compute the mapping above using the following expression.
5201f2bc013cSdrh   ** Assert()s verify that the computation is correct.
5202f2bc013cSdrh   */
5203f2bc013cSdrh   op = ((pExpr->op+(TK_ISNULL&1))^1)-(TK_ISNULL&1);
5204f2bc013cSdrh 
5205f2bc013cSdrh   /* Verify correct alignment of TK_ and OP_ constants
5206f2bc013cSdrh   */
5207f2bc013cSdrh   assert( pExpr->op!=TK_ISNULL || op==OP_NotNull );
5208f2bc013cSdrh   assert( pExpr->op!=TK_NOTNULL || op==OP_IsNull );
5209f2bc013cSdrh   assert( pExpr->op!=TK_NE || op==OP_Eq );
5210f2bc013cSdrh   assert( pExpr->op!=TK_EQ || op==OP_Ne );
5211f2bc013cSdrh   assert( pExpr->op!=TK_LT || op==OP_Ge );
5212f2bc013cSdrh   assert( pExpr->op!=TK_LE || op==OP_Gt );
5213f2bc013cSdrh   assert( pExpr->op!=TK_GT || op==OP_Le );
5214f2bc013cSdrh   assert( pExpr->op!=TK_GE || op==OP_Lt );
5215f2bc013cSdrh 
5216ba00e30aSdan   switch( pExpr->op ){
521717180fcaSdrh     case TK_AND:
521817180fcaSdrh     case TK_OR: {
521917180fcaSdrh       Expr *pAlt = sqlite3ExprSimplifiedAndOr(pExpr);
522017180fcaSdrh       if( pAlt!=pExpr ){
522117180fcaSdrh         sqlite3ExprIfFalse(pParse, pAlt, dest, jumpIfNull);
522217180fcaSdrh       }else if( pExpr->op==TK_AND ){
5223c5499befSdrh         testcase( jumpIfNull==0 );
52244adee20fSdanielk1977         sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
52254adee20fSdanielk1977         sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
522617180fcaSdrh       }else{
5227ec4ccdbcSdrh         int d2 = sqlite3VdbeMakeLabel(pParse);
5228c5499befSdrh         testcase( jumpIfNull==0 );
522917180fcaSdrh         sqlite3ExprIfTrue(pParse, pExpr->pLeft, d2,
523017180fcaSdrh                           jumpIfNull^SQLITE_JUMPIFNULL);
52314adee20fSdanielk1977         sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
52324adee20fSdanielk1977         sqlite3VdbeResolveLabel(v, d2);
523317180fcaSdrh       }
5234cce7d176Sdrh       break;
5235cce7d176Sdrh     }
5236cce7d176Sdrh     case TK_NOT: {
52375c03f30aSdrh       testcase( jumpIfNull==0 );
52384adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
5239cce7d176Sdrh       break;
5240cce7d176Sdrh     }
52418abed7b9Sdrh     case TK_TRUTH: {
524296acafbeSdrh       int isNot;   /* IS NOT TRUE or IS NOT FALSE */
524396acafbeSdrh       int isTrue;  /* IS TRUE or IS NOT TRUE */
52448abed7b9Sdrh       testcase( jumpIfNull==0 );
52458abed7b9Sdrh       isNot = pExpr->op2==TK_ISNOT;
524696acafbeSdrh       isTrue = sqlite3ExprTruthValue(pExpr->pRight);
524743c4ac8bSdrh       testcase( isTrue && isNot );
524896acafbeSdrh       testcase( !isTrue && isNot );
524943c4ac8bSdrh       if( isTrue ^ isNot ){
52508abed7b9Sdrh         /* IS TRUE and IS NOT FALSE */
52518abed7b9Sdrh         sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
52528abed7b9Sdrh                            isNot ? 0 : SQLITE_JUMPIFNULL);
52538abed7b9Sdrh 
52548abed7b9Sdrh       }else{
52558abed7b9Sdrh         /* IS FALSE and IS NOT TRUE */
52568abed7b9Sdrh         sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
52578abed7b9Sdrh                           isNot ? 0 : SQLITE_JUMPIFNULL);
52588abed7b9Sdrh       }
5259007c843bSdrh       break;
5260007c843bSdrh     }
5261de845c2fSdrh     case TK_IS:
5262de845c2fSdrh     case TK_ISNOT:
5263de845c2fSdrh       testcase( pExpr->op==TK_IS );
5264de845c2fSdrh       testcase( pExpr->op==TK_ISNOT );
5265de845c2fSdrh       op = (pExpr->op==TK_IS) ? TK_NE : TK_EQ;
5266de845c2fSdrh       jumpIfNull = SQLITE_NULLEQ;
526708b92086Sdrh       /* no break */ deliberate_fall_through
5268cce7d176Sdrh     case TK_LT:
5269cce7d176Sdrh     case TK_LE:
5270cce7d176Sdrh     case TK_GT:
5271cce7d176Sdrh     case TK_GE:
5272cce7d176Sdrh     case TK_NE:
5273cce7d176Sdrh     case TK_EQ: {
5274625015e0Sdan       if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
5275c5499befSdrh       testcase( jumpIfNull==0 );
5276b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
5277b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
527835573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
5279898c527eSdrh                   r1, r2, dest, jumpIfNull,ExprHasProperty(pExpr,EP_Commuted));
52807d176105Sdrh       assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
52817d176105Sdrh       assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
52827d176105Sdrh       assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
52837d176105Sdrh       assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
5284de845c2fSdrh       assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
5285de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
5286de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
5287de845c2fSdrh       assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
5288de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
5289de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
52906a2fe093Sdrh       testcase( regFree1==0 );
52916a2fe093Sdrh       testcase( regFree2==0 );
52926a2fe093Sdrh       break;
52936a2fe093Sdrh     }
5294cce7d176Sdrh     case TK_ISNULL:
5295cce7d176Sdrh     case TK_NOTNULL: {
52962dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
52972dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
52987d176105Sdrh       testcase( op==TK_ISNULL );   VdbeCoverageIf(v, op==TK_ISNULL);
52997d176105Sdrh       testcase( op==TK_NOTNULL );  VdbeCoverageIf(v, op==TK_NOTNULL);
5300c5499befSdrh       testcase( regFree1==0 );
5301cce7d176Sdrh       break;
5302cce7d176Sdrh     }
5303fef5208cSdrh     case TK_BETWEEN: {
53045c03f30aSdrh       testcase( jumpIfNull==0 );
530571c57db0Sdan       exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfFalse, jumpIfNull);
5306fef5208cSdrh       break;
5307fef5208cSdrh     }
5308bb201344Sshaneh #ifndef SQLITE_OMIT_SUBQUERY
5309e3365e6cSdrh     case TK_IN: {
5310e3365e6cSdrh       if( jumpIfNull ){
5311e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, dest);
5312e3365e6cSdrh       }else{
5313ec4ccdbcSdrh         int destIfNull = sqlite3VdbeMakeLabel(pParse);
5314e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, destIfNull);
5315e3365e6cSdrh         sqlite3VdbeResolveLabel(v, destIfNull);
5316e3365e6cSdrh       }
5317e3365e6cSdrh       break;
5318e3365e6cSdrh     }
5319bb201344Sshaneh #endif
5320cce7d176Sdrh     default: {
5321ba00e30aSdan     default_expr:
5322ad31727fSdrh       if( ExprAlwaysFalse(pExpr) ){
5323076e85f5Sdrh         sqlite3VdbeGoto(v, dest);
5324ad31727fSdrh       }else if( ExprAlwaysTrue(pExpr) ){
5325991a1985Sdrh         /* no-op */
5326991a1985Sdrh       }else{
53272dcef11bSdrh         r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
53282dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_IfNot, r1, dest, jumpIfNull!=0);
5329688852abSdrh         VdbeCoverage(v);
5330c5499befSdrh         testcase( regFree1==0 );
5331c5499befSdrh         testcase( jumpIfNull==0 );
5332991a1985Sdrh       }
5333cce7d176Sdrh       break;
5334cce7d176Sdrh     }
5335cce7d176Sdrh   }
53362dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
53372dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
5338cce7d176Sdrh }
53392282792aSdrh 
53402282792aSdrh /*
534172bc8208Sdrh ** Like sqlite3ExprIfFalse() except that a copy is made of pExpr before
534272bc8208Sdrh ** code generation, and that copy is deleted after code generation. This
534372bc8208Sdrh ** ensures that the original pExpr is unchanged.
534472bc8208Sdrh */
534572bc8208Sdrh void sqlite3ExprIfFalseDup(Parse *pParse, Expr *pExpr, int dest,int jumpIfNull){
534672bc8208Sdrh   sqlite3 *db = pParse->db;
534772bc8208Sdrh   Expr *pCopy = sqlite3ExprDup(db, pExpr, 0);
534872bc8208Sdrh   if( db->mallocFailed==0 ){
534972bc8208Sdrh     sqlite3ExprIfFalse(pParse, pCopy, dest, jumpIfNull);
535072bc8208Sdrh   }
535172bc8208Sdrh   sqlite3ExprDelete(db, pCopy);
535272bc8208Sdrh }
535372bc8208Sdrh 
53545aa550cfSdan /*
53555aa550cfSdan ** Expression pVar is guaranteed to be an SQL variable. pExpr may be any
53565aa550cfSdan ** type of expression.
53575aa550cfSdan **
53585aa550cfSdan ** If pExpr is a simple SQL value - an integer, real, string, blob
53595aa550cfSdan ** or NULL value - then the VDBE currently being prepared is configured
53605aa550cfSdan ** to re-prepare each time a new value is bound to variable pVar.
53615aa550cfSdan **
53625aa550cfSdan ** Additionally, if pExpr is a simple SQL value and the value is the
53635aa550cfSdan ** same as that currently bound to variable pVar, non-zero is returned.
53645aa550cfSdan ** Otherwise, if the values are not the same or if pExpr is not a simple
53655aa550cfSdan ** SQL value, zero is returned.
53665aa550cfSdan */
53671580d50bSdrh static int exprCompareVariable(
53681580d50bSdrh   const Parse *pParse,
53691580d50bSdrh   const Expr *pVar,
53701580d50bSdrh   const Expr *pExpr
53711580d50bSdrh ){
53725aa550cfSdan   int res = 0;
5373c0804226Sdrh   int iVar;
5374c0804226Sdrh   sqlite3_value *pL, *pR = 0;
53755aa550cfSdan 
53765aa550cfSdan   sqlite3ValueFromExpr(pParse->db, pExpr, SQLITE_UTF8, SQLITE_AFF_BLOB, &pR);
5377c0804226Sdrh   if( pR ){
5378c0804226Sdrh     iVar = pVar->iColumn;
5379c0804226Sdrh     sqlite3VdbeSetVarmask(pParse->pVdbe, iVar);
5380c0804226Sdrh     pL = sqlite3VdbeGetBoundValue(pParse->pReprepare, iVar, SQLITE_AFF_BLOB);
53815aa307e2Sdrh     if( pL ){
53825aa307e2Sdrh       if( sqlite3_value_type(pL)==SQLITE_TEXT ){
53835aa307e2Sdrh         sqlite3_value_text(pL); /* Make sure the encoding is UTF-8 */
53845aa307e2Sdrh       }
53855aa307e2Sdrh       res =  0==sqlite3MemCompare(pL, pR, 0);
53865aa550cfSdan     }
53875aa550cfSdan     sqlite3ValueFree(pR);
53885aa550cfSdan     sqlite3ValueFree(pL);
53895aa550cfSdan   }
53905aa550cfSdan 
53915aa550cfSdan   return res;
53925aa550cfSdan }
539372bc8208Sdrh 
539472bc8208Sdrh /*
53951d9da70aSdrh ** Do a deep comparison of two expression trees.  Return 0 if the two
53961d9da70aSdrh ** expressions are completely identical.  Return 1 if they differ only
53971d9da70aSdrh ** by a COLLATE operator at the top level.  Return 2 if there are differences
53981d9da70aSdrh ** other than the top-level COLLATE operator.
5399d40aab0eSdrh **
5400619a1305Sdrh ** If any subelement of pB has Expr.iTable==(-1) then it is allowed
5401619a1305Sdrh ** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
5402619a1305Sdrh **
540366518ca7Sdrh ** The pA side might be using TK_REGISTER.  If that is the case and pB is
540466518ca7Sdrh ** not using TK_REGISTER but is otherwise equivalent, then still return 0.
540566518ca7Sdrh **
54061d9da70aSdrh ** Sometimes this routine will return 2 even if the two expressions
5407d40aab0eSdrh ** really are equivalent.  If we cannot prove that the expressions are
54081d9da70aSdrh ** identical, we return 2 just to be safe.  So if this routine
54091d9da70aSdrh ** returns 2, then you do not really know for certain if the two
54101d9da70aSdrh ** expressions are the same.  But if you get a 0 or 1 return, then you
5411d40aab0eSdrh ** can be sure the expressions are the same.  In the places where
54121d9da70aSdrh ** this routine is used, it does not hurt to get an extra 2 - that
5413d40aab0eSdrh ** just might result in some slightly slower code.  But returning
54141d9da70aSdrh ** an incorrect 0 or 1 could lead to a malfunction.
54155aa550cfSdan **
5416c0804226Sdrh ** If pParse is not NULL then TK_VARIABLE terms in pA with bindings in
5417c0804226Sdrh ** pParse->pReprepare can be matched against literals in pB.  The
5418c0804226Sdrh ** pParse->pVdbe->expmask bitmask is updated for each variable referenced.
5419c0804226Sdrh ** If pParse is NULL (the normal case) then any TK_VARIABLE term in
5420c0804226Sdrh ** Argument pParse should normally be NULL. If it is not NULL and pA or
5421c0804226Sdrh ** pB causes a return value of 2.
54222282792aSdrh */
54231580d50bSdrh int sqlite3ExprCompare(
54241580d50bSdrh   const Parse *pParse,
54251580d50bSdrh   const Expr *pA,
54261580d50bSdrh   const Expr *pB,
54271580d50bSdrh   int iTab
54281580d50bSdrh ){
542910d1edf0Sdrh   u32 combinedFlags;
54304b202ae2Sdanielk1977   if( pA==0 || pB==0 ){
54311d9da70aSdrh     return pB==pA ? 0 : 2;
54322282792aSdrh   }
54335aa550cfSdan   if( pParse && pA->op==TK_VARIABLE && exprCompareVariable(pParse, pA, pB) ){
54345aa550cfSdan     return 0;
54355aa550cfSdan   }
543610d1edf0Sdrh   combinedFlags = pA->flags | pB->flags;
543710d1edf0Sdrh   if( combinedFlags & EP_IntValue ){
543810d1edf0Sdrh     if( (pA->flags&pB->flags&EP_IntValue)!=0 && pA->u.iValue==pB->u.iValue ){
543910d1edf0Sdrh       return 0;
544010d1edf0Sdrh     }
54411d9da70aSdrh     return 2;
54426ab3a2ecSdanielk1977   }
544316dd3985Sdan   if( pA->op!=pB->op || pA->op==TK_RAISE ){
54445aa550cfSdan     if( pA->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA->pLeft,pB,iTab)<2 ){
5445ae80ddeaSdrh       return 1;
5446ae80ddeaSdrh     }
54475aa550cfSdan     if( pB->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA,pB->pLeft,iTab)<2 ){
5448ae80ddeaSdrh       return 1;
5449ae80ddeaSdrh     }
5450ae80ddeaSdrh     return 2;
5451ae80ddeaSdrh   }
5452f9751074Sdrh   if( pA->op!=TK_COLUMN
5453f9751074Sdrh    && pA->op!=TK_AGG_COLUMN
5454f9751074Sdrh    && ALWAYS(!ExprHasProperty(pA, EP_IntValue))
5455f9751074Sdrh    && pA->u.zToken
5456f9751074Sdrh   ){
5457f9751074Sdrh     assert( !ExprHasProperty(pB, EP_IntValue) );
54584f9adee2Sdan     if( pA->op==TK_FUNCTION || pA->op==TK_AGG_FUNCTION ){
5459390b88a4Sdrh       if( sqlite3StrICmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
5460eda079cdSdrh #ifndef SQLITE_OMIT_WINDOWFUNC
54614f9adee2Sdan       assert( pA->op==pB->op );
54624f9adee2Sdan       if( ExprHasProperty(pA,EP_WinFunc)!=ExprHasProperty(pB,EP_WinFunc) ){
54634f9adee2Sdan         return 2;
54644f9adee2Sdan       }
5465eda079cdSdrh       if( ExprHasProperty(pA,EP_WinFunc) ){
54664f9adee2Sdan         if( sqlite3WindowCompare(pParse, pA->y.pWin, pB->y.pWin, 1)!=0 ){
54674f9adee2Sdan           return 2;
54684f9adee2Sdan         }
5469eda079cdSdrh       }
5470eda079cdSdrh #endif
5471f20bbc5fSdrh     }else if( pA->op==TK_NULL ){
5472f20bbc5fSdrh       return 0;
5473d5af5420Sdrh     }else if( pA->op==TK_COLLATE ){
5474e79f6299Sdrh       if( sqlite3_stricmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
5475f20bbc5fSdrh     }else if( ALWAYS(pB->u.zToken!=0) && strcmp(pA->u.zToken,pB->u.zToken)!=0 ){
5476d5af5420Sdrh       return 2;
547710d1edf0Sdrh     }
547810d1edf0Sdrh   }
5479898c527eSdrh   if( (pA->flags & (EP_Distinct|EP_Commuted))
5480898c527eSdrh      != (pB->flags & (EP_Distinct|EP_Commuted)) ) return 2;
5481e7375bfaSdrh   if( ALWAYS((combinedFlags & EP_TokenOnly)==0) ){
548210d1edf0Sdrh     if( combinedFlags & EP_xIsSelect ) return 2;
5483efad2e23Sdrh     if( (combinedFlags & EP_FixedCol)==0
5484efad2e23Sdrh      && sqlite3ExprCompare(pParse, pA->pLeft, pB->pLeft, iTab) ) return 2;
54855aa550cfSdan     if( sqlite3ExprCompare(pParse, pA->pRight, pB->pRight, iTab) ) return 2;
5486619a1305Sdrh     if( sqlite3ExprListCompare(pA->x.pList, pB->x.pList, iTab) ) return 2;
548703c5c213Sdrh     if( pA->op!=TK_STRING
548803c5c213Sdrh      && pA->op!=TK_TRUEFALSE
5489e7375bfaSdrh      && ALWAYS((combinedFlags & EP_Reduced)==0)
549003c5c213Sdrh     ){
5491619a1305Sdrh       if( pA->iColumn!=pB->iColumn ) return 2;
54929b258c54Sdrh       if( pA->op2!=pB->op2 && pA->op==TK_TRUTH ) return 2;
54930f28e1bdSdrh       if( pA->op!=TK_IN && pA->iTable!=pB->iTable && pA->iTable!=iTab ){
54940f28e1bdSdrh         return 2;
54950f28e1bdSdrh       }
54961d9da70aSdrh     }
54971d9da70aSdrh   }
54982646da7eSdrh   return 0;
54992646da7eSdrh }
55002282792aSdrh 
55018c6f666bSdrh /*
5502fbb6e9ffSdan ** Compare two ExprList objects.  Return 0 if they are identical, 1
5503fbb6e9ffSdan ** if they are certainly different, or 2 if it is not possible to
5504fbb6e9ffSdan ** determine if they are identical or not.
55058c6f666bSdrh **
5506619a1305Sdrh ** If any subelement of pB has Expr.iTable==(-1) then it is allowed
5507619a1305Sdrh ** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
5508619a1305Sdrh **
55098c6f666bSdrh ** This routine might return non-zero for equivalent ExprLists.  The
55108c6f666bSdrh ** only consequence will be disabled optimizations.  But this routine
55118c6f666bSdrh ** must never return 0 if the two ExprList objects are different, or
55128c6f666bSdrh ** a malfunction will result.
55138c6f666bSdrh **
55148c6f666bSdrh ** Two NULL pointers are considered to be the same.  But a NULL pointer
55158c6f666bSdrh ** always differs from a non-NULL pointer.
55168c6f666bSdrh */
55171580d50bSdrh int sqlite3ExprListCompare(const ExprList *pA, const ExprList *pB, int iTab){
55188c6f666bSdrh   int i;
55198c6f666bSdrh   if( pA==0 && pB==0 ) return 0;
55208c6f666bSdrh   if( pA==0 || pB==0 ) return 1;
55218c6f666bSdrh   if( pA->nExpr!=pB->nExpr ) return 1;
55228c6f666bSdrh   for(i=0; i<pA->nExpr; i++){
5523fbb6e9ffSdan     int res;
55248c6f666bSdrh     Expr *pExprA = pA->a[i].pExpr;
55258c6f666bSdrh     Expr *pExprB = pB->a[i].pExpr;
55266e11892dSdan     if( pA->a[i].sortFlags!=pB->a[i].sortFlags ) return 1;
5527fbb6e9ffSdan     if( (res = sqlite3ExprCompare(0, pExprA, pExprB, iTab)) ) return res;
55288c6f666bSdrh   }
55298c6f666bSdrh   return 0;
55308c6f666bSdrh }
553113449892Sdrh 
55322282792aSdrh /*
5533f9463dfbSdrh ** Like sqlite3ExprCompare() except COLLATE operators at the top-level
5534f9463dfbSdrh ** are ignored.
5535f9463dfbSdrh */
5536f9463dfbSdrh int sqlite3ExprCompareSkip(Expr *pA,Expr *pB, int iTab){
55375aa550cfSdan   return sqlite3ExprCompare(0,
55380d950af3Sdrh              sqlite3ExprSkipCollateAndLikely(pA),
55390d950af3Sdrh              sqlite3ExprSkipCollateAndLikely(pB),
5540f9463dfbSdrh              iTab);
5541f9463dfbSdrh }
5542f9463dfbSdrh 
5543f9463dfbSdrh /*
5544c51cf864Sdrh ** Return non-zero if Expr p can only be true if pNN is not NULL.
55457a231b49Sdrh **
55467a231b49Sdrh ** Or if seenNot is true, return non-zero if Expr p can only be
55477a231b49Sdrh ** non-NULL if pNN is not NULL
5548c51cf864Sdrh */
5549c51cf864Sdrh static int exprImpliesNotNull(
55501580d50bSdrh   const Parse *pParse,/* Parsing context */
55511580d50bSdrh   const Expr *p,      /* The expression to be checked */
55521580d50bSdrh   const Expr *pNN,    /* The expression that is NOT NULL */
5553c51cf864Sdrh   int iTab,           /* Table being evaluated */
55547a231b49Sdrh   int seenNot         /* Return true only if p can be any non-NULL value */
5555c51cf864Sdrh ){
5556c51cf864Sdrh   assert( p );
5557c51cf864Sdrh   assert( pNN );
555814c865e8Sdrh   if( sqlite3ExprCompare(pParse, p, pNN, iTab)==0 ){
555914c865e8Sdrh     return pNN->op!=TK_NULL;
556014c865e8Sdrh   }
5561c51cf864Sdrh   switch( p->op ){
5562c51cf864Sdrh     case TK_IN: {
5563c51cf864Sdrh       if( seenNot && ExprHasProperty(p, EP_xIsSelect) ) return 0;
5564*a4eeccdfSdrh       assert( ExprUseXSelect(p) || (p->x.pList!=0 && p->x.pList->nExpr>0) );
5565ae144a1cSdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
5566c51cf864Sdrh     }
5567c51cf864Sdrh     case TK_BETWEEN: {
5568*a4eeccdfSdrh       ExprList *pList;
5569*a4eeccdfSdrh       assert( ExprUseXList(p) );
5570*a4eeccdfSdrh       pList = p->x.pList;
5571c51cf864Sdrh       assert( pList!=0 );
5572c51cf864Sdrh       assert( pList->nExpr==2 );
5573c51cf864Sdrh       if( seenNot ) return 0;
55747a231b49Sdrh       if( exprImpliesNotNull(pParse, pList->a[0].pExpr, pNN, iTab, 1)
55757a231b49Sdrh        || exprImpliesNotNull(pParse, pList->a[1].pExpr, pNN, iTab, 1)
5576c51cf864Sdrh       ){
5577c51cf864Sdrh         return 1;
5578c51cf864Sdrh       }
55797a231b49Sdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
5580c51cf864Sdrh     }
5581c51cf864Sdrh     case TK_EQ:
5582c51cf864Sdrh     case TK_NE:
5583c51cf864Sdrh     case TK_LT:
5584c51cf864Sdrh     case TK_LE:
5585c51cf864Sdrh     case TK_GT:
5586c51cf864Sdrh     case TK_GE:
5587c51cf864Sdrh     case TK_PLUS:
5588c51cf864Sdrh     case TK_MINUS:
55899d23ea74Sdan     case TK_BITOR:
55909d23ea74Sdan     case TK_LSHIFT:
55919d23ea74Sdan     case TK_RSHIFT:
55929d23ea74Sdan     case TK_CONCAT:
55939d23ea74Sdan       seenNot = 1;
559408b92086Sdrh       /* no break */ deliberate_fall_through
5595c51cf864Sdrh     case TK_STAR:
5596c51cf864Sdrh     case TK_REM:
5597c51cf864Sdrh     case TK_BITAND:
55989d23ea74Sdan     case TK_SLASH: {
5599c51cf864Sdrh       if( exprImpliesNotNull(pParse, p->pRight, pNN, iTab, seenNot) ) return 1;
560008b92086Sdrh       /* no break */ deliberate_fall_through
5601c51cf864Sdrh     }
5602c51cf864Sdrh     case TK_SPAN:
5603c51cf864Sdrh     case TK_COLLATE:
5604c51cf864Sdrh     case TK_UPLUS:
5605c51cf864Sdrh     case TK_UMINUS: {
5606c51cf864Sdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, seenNot);
5607c51cf864Sdrh     }
5608c51cf864Sdrh     case TK_TRUTH: {
5609c51cf864Sdrh       if( seenNot ) return 0;
5610c51cf864Sdrh       if( p->op2!=TK_IS ) return 0;
561138cefc83Sdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
5612c51cf864Sdrh     }
56131cd382e3Sdan     case TK_BITNOT:
5614c51cf864Sdrh     case TK_NOT: {
5615c51cf864Sdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
5616c51cf864Sdrh     }
5617c51cf864Sdrh   }
5618c51cf864Sdrh   return 0;
5619c51cf864Sdrh }
5620c51cf864Sdrh 
5621c51cf864Sdrh /*
56224bd5f73fSdrh ** Return true if we can prove the pE2 will always be true if pE1 is
56234bd5f73fSdrh ** true.  Return false if we cannot complete the proof or if pE2 might
56244bd5f73fSdrh ** be false.  Examples:
56254bd5f73fSdrh **
5626619a1305Sdrh **     pE1: x==5       pE2: x==5             Result: true
56274bd5f73fSdrh **     pE1: x>0        pE2: x==5             Result: false
5628619a1305Sdrh **     pE1: x=21       pE2: x=21 OR y=43     Result: true
56294bd5f73fSdrh **     pE1: x!=123     pE2: x IS NOT NULL    Result: true
5630619a1305Sdrh **     pE1: x!=?1      pE2: x IS NOT NULL    Result: true
5631619a1305Sdrh **     pE1: x IS NULL  pE2: x IS NOT NULL    Result: false
5632619a1305Sdrh **     pE1: x IS ?2    pE2: x IS NOT NULL    Reuslt: false
56334bd5f73fSdrh **
56344bd5f73fSdrh ** When comparing TK_COLUMN nodes between pE1 and pE2, if pE2 has
56354bd5f73fSdrh ** Expr.iTable<0 then assume a table number given by iTab.
56364bd5f73fSdrh **
5637c0804226Sdrh ** If pParse is not NULL, then the values of bound variables in pE1 are
5638c0804226Sdrh ** compared against literal values in pE2 and pParse->pVdbe->expmask is
5639c0804226Sdrh ** modified to record which bound variables are referenced.  If pParse
5640c0804226Sdrh ** is NULL, then false will be returned if pE1 contains any bound variables.
5641c0804226Sdrh **
56424bd5f73fSdrh ** When in doubt, return false.  Returning true might give a performance
56434bd5f73fSdrh ** improvement.  Returning false might cause a performance reduction, but
56444bd5f73fSdrh ** it will always give the correct answer and is hence always safe.
56454bd5f73fSdrh */
56461580d50bSdrh int sqlite3ExprImpliesExpr(
56471580d50bSdrh   const Parse *pParse,
56481580d50bSdrh   const Expr *pE1,
56491580d50bSdrh   const Expr *pE2,
56501580d50bSdrh   int iTab
56511580d50bSdrh ){
56525aa550cfSdan   if( sqlite3ExprCompare(pParse, pE1, pE2, iTab)==0 ){
5653619a1305Sdrh     return 1;
5654619a1305Sdrh   }
5655619a1305Sdrh   if( pE2->op==TK_OR
56565aa550cfSdan    && (sqlite3ExprImpliesExpr(pParse, pE1, pE2->pLeft, iTab)
56575aa550cfSdan              || sqlite3ExprImpliesExpr(pParse, pE1, pE2->pRight, iTab) )
5658619a1305Sdrh   ){
5659619a1305Sdrh     return 1;
5660619a1305Sdrh   }
5661664d6d13Sdrh   if( pE2->op==TK_NOTNULL
5662c51cf864Sdrh    && exprImpliesNotNull(pParse, pE1, pE2->pLeft, iTab, 0)
5663664d6d13Sdrh   ){
5664c51cf864Sdrh     return 1;
5665619a1305Sdrh   }
5666619a1305Sdrh   return 0;
56674bd5f73fSdrh }
56684bd5f73fSdrh 
56694bd5f73fSdrh /*
56706c68d759Sdrh ** This is the Expr node callback for sqlite3ExprImpliesNonNullRow().
56712589787cSdrh ** If the expression node requires that the table at pWalker->iCur
5672f8937f90Sdrh ** have one or more non-NULL column, then set pWalker->eCode to 1 and abort.
5673f8937f90Sdrh **
5674f8937f90Sdrh ** This routine controls an optimization.  False positives (setting
5675f8937f90Sdrh ** pWalker->eCode to 1 when it should not be) are deadly, but false-negatives
5676f8937f90Sdrh ** (never setting pWalker->eCode) is a harmless missed optimization.
56772589787cSdrh */
56782589787cSdrh static int impliesNotNullRow(Walker *pWalker, Expr *pExpr){
5679f8937f90Sdrh   testcase( pExpr->op==TK_AGG_COLUMN );
5680821b610bSdrh   testcase( pExpr->op==TK_AGG_FUNCTION );
56812589787cSdrh   if( ExprHasProperty(pExpr, EP_FromJoin) ) return WRC_Prune;
56822589787cSdrh   switch( pExpr->op ){
56830493222fSdan     case TK_ISNOT:
56842589787cSdrh     case TK_ISNULL:
5685d5793672Sdrh     case TK_NOTNULL:
56862589787cSdrh     case TK_IS:
56872589787cSdrh     case TK_OR:
56886c68d759Sdrh     case TK_VECTOR:
56892c492061Sdrh     case TK_CASE:
5690e3eff266Sdrh     case TK_IN:
56912589787cSdrh     case TK_FUNCTION:
5692da03c1e6Sdan     case TK_TRUTH:
56930493222fSdan       testcase( pExpr->op==TK_ISNOT );
5694821b610bSdrh       testcase( pExpr->op==TK_ISNULL );
5695d5793672Sdrh       testcase( pExpr->op==TK_NOTNULL );
5696821b610bSdrh       testcase( pExpr->op==TK_IS );
5697821b610bSdrh       testcase( pExpr->op==TK_OR );
56986c68d759Sdrh       testcase( pExpr->op==TK_VECTOR );
5699821b610bSdrh       testcase( pExpr->op==TK_CASE );
5700821b610bSdrh       testcase( pExpr->op==TK_IN );
5701821b610bSdrh       testcase( pExpr->op==TK_FUNCTION );
5702da03c1e6Sdan       testcase( pExpr->op==TK_TRUTH );
57032589787cSdrh       return WRC_Prune;
57042589787cSdrh     case TK_COLUMN:
57052589787cSdrh       if( pWalker->u.iCur==pExpr->iTable ){
57062589787cSdrh         pWalker->eCode = 1;
57072589787cSdrh         return WRC_Abort;
57082589787cSdrh       }
57092589787cSdrh       return WRC_Prune;
57109881155dSdrh 
57119d23ea74Sdan     case TK_AND:
5712aef81674Sdrh       if( pWalker->eCode==0 ){
57130287c951Sdan         sqlite3WalkExpr(pWalker, pExpr->pLeft);
57140287c951Sdan         if( pWalker->eCode ){
57150287c951Sdan           pWalker->eCode = 0;
57160287c951Sdan           sqlite3WalkExpr(pWalker, pExpr->pRight);
57179d23ea74Sdan         }
5718aef81674Sdrh       }
57199d23ea74Sdan       return WRC_Prune;
57209d23ea74Sdan 
57219d23ea74Sdan     case TK_BETWEEN:
57221d24a531Sdan       if( sqlite3WalkExpr(pWalker, pExpr->pLeft)==WRC_Abort ){
57231d24a531Sdan         assert( pWalker->eCode );
57241d24a531Sdan         return WRC_Abort;
57251d24a531Sdan       }
57269d23ea74Sdan       return WRC_Prune;
57279d23ea74Sdan 
57289881155dSdrh     /* Virtual tables are allowed to use constraints like x=NULL.  So
57299881155dSdrh     ** a term of the form x=y does not prove that y is not null if x
57309881155dSdrh     ** is the column of a virtual table */
57319881155dSdrh     case TK_EQ:
57329881155dSdrh     case TK_NE:
57339881155dSdrh     case TK_LT:
57349881155dSdrh     case TK_LE:
57359881155dSdrh     case TK_GT:
573678d1d225Sdrh     case TK_GE: {
573778d1d225Sdrh       Expr *pLeft = pExpr->pLeft;
573878d1d225Sdrh       Expr *pRight = pExpr->pRight;
57399881155dSdrh       testcase( pExpr->op==TK_EQ );
57409881155dSdrh       testcase( pExpr->op==TK_NE );
57419881155dSdrh       testcase( pExpr->op==TK_LT );
57429881155dSdrh       testcase( pExpr->op==TK_LE );
57439881155dSdrh       testcase( pExpr->op==TK_GT );
57449881155dSdrh       testcase( pExpr->op==TK_GE );
574578d1d225Sdrh       /* The y.pTab=0 assignment in wherecode.c always happens after the
574678d1d225Sdrh       ** impliesNotNullRow() test */
574702a9996eSdrh       if( (pLeft->op==TK_COLUMN && pLeft->y.pTab!=0
574878d1d225Sdrh                                && IsVirtual(pLeft->y.pTab))
574902a9996eSdrh        || (pRight->op==TK_COLUMN && pRight->y.pTab!=0
575078d1d225Sdrh                                && IsVirtual(pRight->y.pTab))
57519881155dSdrh       ){
57529881155dSdrh         return WRC_Prune;
57539881155dSdrh       }
575408b92086Sdrh       /* no break */ deliberate_fall_through
575578d1d225Sdrh     }
57562589787cSdrh     default:
57572589787cSdrh       return WRC_Continue;
57582589787cSdrh   }
57592589787cSdrh }
57602589787cSdrh 
57612589787cSdrh /*
57622589787cSdrh ** Return true (non-zero) if expression p can only be true if at least
57632589787cSdrh ** one column of table iTab is non-null.  In other words, return true
57642589787cSdrh ** if expression p will always be NULL or false if every column of iTab
57652589787cSdrh ** is NULL.
57662589787cSdrh **
5767821b610bSdrh ** False negatives are acceptable.  In other words, it is ok to return
5768821b610bSdrh ** zero even if expression p will never be true of every column of iTab
5769821b610bSdrh ** is NULL.  A false negative is merely a missed optimization opportunity.
5770821b610bSdrh **
5771821b610bSdrh ** False positives are not allowed, however.  A false positive may result
5772821b610bSdrh ** in an incorrect answer.
5773821b610bSdrh **
57742589787cSdrh ** Terms of p that are marked with EP_FromJoin (and hence that come from
57752589787cSdrh ** the ON or USING clauses of LEFT JOINS) are excluded from the analysis.
57762589787cSdrh **
57772589787cSdrh ** This routine is used to check if a LEFT JOIN can be converted into
57782589787cSdrh ** an ordinary JOIN.  The p argument is the WHERE clause.  If the WHERE
57792589787cSdrh ** clause requires that some column of the right table of the LEFT JOIN
57802589787cSdrh ** be non-NULL, then the LEFT JOIN can be safely converted into an
57812589787cSdrh ** ordinary join.
57822589787cSdrh */
57832589787cSdrh int sqlite3ExprImpliesNonNullRow(Expr *p, int iTab){
57842589787cSdrh   Walker w;
57850d950af3Sdrh   p = sqlite3ExprSkipCollateAndLikely(p);
57864a254f98Sdrh   if( p==0 ) return 0;
57874a254f98Sdrh   if( p->op==TK_NOTNULL ){
5788d6db6598Sdrh     p = p->pLeft;
5789a1698993Sdrh   }else{
5790a1698993Sdrh     while( p->op==TK_AND ){
57914a254f98Sdrh       if( sqlite3ExprImpliesNonNullRow(p->pLeft, iTab) ) return 1;
57924a254f98Sdrh       p = p->pRight;
5793d6db6598Sdrh     }
5794a1698993Sdrh   }
57952589787cSdrh   w.xExprCallback = impliesNotNullRow;
57962589787cSdrh   w.xSelectCallback = 0;
57972589787cSdrh   w.xSelectCallback2 = 0;
57982589787cSdrh   w.eCode = 0;
57992589787cSdrh   w.u.iCur = iTab;
58002589787cSdrh   sqlite3WalkExpr(&w, p);
58012589787cSdrh   return w.eCode;
58022589787cSdrh }
58032589787cSdrh 
58042589787cSdrh /*
5805030796dfSdrh ** An instance of the following structure is used by the tree walker
58062409f8a1Sdrh ** to determine if an expression can be evaluated by reference to the
58072409f8a1Sdrh ** index only, without having to do a search for the corresponding
58082409f8a1Sdrh ** table entry.  The IdxCover.pIdx field is the index.  IdxCover.iCur
58092409f8a1Sdrh ** is the cursor for the table.
58102409f8a1Sdrh */
58112409f8a1Sdrh struct IdxCover {
58122409f8a1Sdrh   Index *pIdx;     /* The index to be tested for coverage */
58132409f8a1Sdrh   int iCur;        /* Cursor number for the table corresponding to the index */
58142409f8a1Sdrh };
58152409f8a1Sdrh 
58162409f8a1Sdrh /*
58172409f8a1Sdrh ** Check to see if there are references to columns in table
58182409f8a1Sdrh ** pWalker->u.pIdxCover->iCur can be satisfied using the index
58192409f8a1Sdrh ** pWalker->u.pIdxCover->pIdx.
58202409f8a1Sdrh */
58212409f8a1Sdrh static int exprIdxCover(Walker *pWalker, Expr *pExpr){
58222409f8a1Sdrh   if( pExpr->op==TK_COLUMN
58232409f8a1Sdrh    && pExpr->iTable==pWalker->u.pIdxCover->iCur
5824b9bcf7caSdrh    && sqlite3TableColumnToIndex(pWalker->u.pIdxCover->pIdx, pExpr->iColumn)<0
58252409f8a1Sdrh   ){
58262409f8a1Sdrh     pWalker->eCode = 1;
58272409f8a1Sdrh     return WRC_Abort;
58282409f8a1Sdrh   }
58292409f8a1Sdrh   return WRC_Continue;
58302409f8a1Sdrh }
58312409f8a1Sdrh 
58322409f8a1Sdrh /*
5833e604ec0bSdrh ** Determine if an index pIdx on table with cursor iCur contains will
5834e604ec0bSdrh ** the expression pExpr.  Return true if the index does cover the
5835e604ec0bSdrh ** expression and false if the pExpr expression references table columns
5836e604ec0bSdrh ** that are not found in the index pIdx.
58372409f8a1Sdrh **
58382409f8a1Sdrh ** An index covering an expression means that the expression can be
58392409f8a1Sdrh ** evaluated using only the index and without having to lookup the
58402409f8a1Sdrh ** corresponding table entry.
58412409f8a1Sdrh */
58422409f8a1Sdrh int sqlite3ExprCoveredByIndex(
58432409f8a1Sdrh   Expr *pExpr,        /* The index to be tested */
58442409f8a1Sdrh   int iCur,           /* The cursor number for the corresponding table */
58452409f8a1Sdrh   Index *pIdx         /* The index that might be used for coverage */
58462409f8a1Sdrh ){
58472409f8a1Sdrh   Walker w;
58482409f8a1Sdrh   struct IdxCover xcov;
58492409f8a1Sdrh   memset(&w, 0, sizeof(w));
58502409f8a1Sdrh   xcov.iCur = iCur;
58512409f8a1Sdrh   xcov.pIdx = pIdx;
58522409f8a1Sdrh   w.xExprCallback = exprIdxCover;
58532409f8a1Sdrh   w.u.pIdxCover = &xcov;
58542409f8a1Sdrh   sqlite3WalkExpr(&w, pExpr);
58552409f8a1Sdrh   return !w.eCode;
58562409f8a1Sdrh }
58572409f8a1Sdrh 
58582409f8a1Sdrh 
58592409f8a1Sdrh /*
58602409f8a1Sdrh ** An instance of the following structure is used by the tree walker
5861030796dfSdrh ** to count references to table columns in the arguments of an
5862ed551b95Sdrh ** aggregate function, in order to implement the
5863ed551b95Sdrh ** sqlite3FunctionThisSrc() routine.
5864374fdce4Sdrh */
5865030796dfSdrh struct SrcCount {
5866030796dfSdrh   SrcList *pSrc;   /* One particular FROM clause in a nested query */
5867ed41a96bSdan   int iSrcInner;   /* Smallest cursor number in this context */
5868030796dfSdrh   int nThis;       /* Number of references to columns in pSrcList */
5869030796dfSdrh   int nOther;      /* Number of references to columns in other FROM clauses */
5870030796dfSdrh };
5871030796dfSdrh 
5872030796dfSdrh /*
5873ed41a96bSdan ** xSelect callback for sqlite3FunctionUsesThisSrc(). If this is the first
5874ed41a96bSdan ** SELECT with a FROM clause encountered during this iteration, set
5875ed41a96bSdan ** SrcCount.iSrcInner to the cursor number of the leftmost object in
5876ed41a96bSdan ** the FROM cause.
5877ed41a96bSdan */
5878ed41a96bSdan static int selectSrcCount(Walker *pWalker, Select *pSel){
5879ed41a96bSdan   struct SrcCount *p = pWalker->u.pSrcCount;
5880bc050b8fSdrh   if( p->iSrcInner==0x7FFFFFFF && ALWAYS(pSel->pSrc) && pSel->pSrc->nSrc ){
5881ed41a96bSdan     pWalker->u.pSrcCount->iSrcInner = pSel->pSrc->a[0].iCursor;
5882ed41a96bSdan   }
5883ed41a96bSdan   return WRC_Continue;
5884ed41a96bSdan }
5885ed41a96bSdan 
5886ed41a96bSdan /*
5887030796dfSdrh ** Count the number of references to columns.
5888030796dfSdrh */
5889030796dfSdrh static int exprSrcCount(Walker *pWalker, Expr *pExpr){
5890b4b36306Sdan   /* There was once a NEVER() on the second term on the grounds that
5891b4b36306Sdan   ** sqlite3FunctionUsesThisSrc() was always called before
5892b4b36306Sdan   ** sqlite3ExprAnalyzeAggregates() and so the TK_COLUMNs have not yet
5893b4b36306Sdan   ** been converted into TK_AGG_COLUMN. But this is no longer true due
5894b4b36306Sdan   ** to window functions - sqlite3WindowRewrite() may now indirectly call
5895b4b36306Sdan   ** FunctionUsesThisSrc() when creating a new sub-select. */
5896b4b36306Sdan   if( pExpr->op==TK_COLUMN || pExpr->op==TK_AGG_COLUMN ){
5897374fdce4Sdrh     int i;
5898030796dfSdrh     struct SrcCount *p = pWalker->u.pSrcCount;
5899030796dfSdrh     SrcList *pSrc = p->pSrc;
5900655814d2Sdrh     int nSrc = pSrc ? pSrc->nSrc : 0;
5901655814d2Sdrh     for(i=0; i<nSrc; i++){
5902030796dfSdrh       if( pExpr->iTable==pSrc->a[i].iCursor ) break;
5903374fdce4Sdrh     }
5904655814d2Sdrh     if( i<nSrc ){
5905030796dfSdrh       p->nThis++;
5906ed41a96bSdan     }else if( pExpr->iTable<p->iSrcInner ){
590780f6bfc0Sdrh       /* In a well-formed parse tree (no name resolution errors),
590835a38e08Sdrh       ** TK_COLUMN nodes with smaller Expr.iTable values are in an
590980f6bfc0Sdrh       ** outer context.  Those are the only ones to count as "other" */
5910030796dfSdrh       p->nOther++;
5911374fdce4Sdrh     }
5912374fdce4Sdrh   }
5913030796dfSdrh   return WRC_Continue;
5914030796dfSdrh }
5915374fdce4Sdrh 
5916374fdce4Sdrh /*
5917030796dfSdrh ** Determine if any of the arguments to the pExpr Function reference
5918030796dfSdrh ** pSrcList.  Return true if they do.  Also return true if the function
5919030796dfSdrh ** has no arguments or has only constant arguments.  Return false if pExpr
5920030796dfSdrh ** references columns but not columns of tables found in pSrcList.
5921374fdce4Sdrh */
5922030796dfSdrh int sqlite3FunctionUsesThisSrc(Expr *pExpr, SrcList *pSrcList){
5923374fdce4Sdrh   Walker w;
5924030796dfSdrh   struct SrcCount cnt;
5925374fdce4Sdrh   assert( pExpr->op==TK_AGG_FUNCTION );
592680f6bfc0Sdrh   memset(&w, 0, sizeof(w));
5927030796dfSdrh   w.xExprCallback = exprSrcCount;
5928ed41a96bSdan   w.xSelectCallback = selectSrcCount;
5929030796dfSdrh   w.u.pSrcCount = &cnt;
5930030796dfSdrh   cnt.pSrc = pSrcList;
5931ed41a96bSdan   cnt.iSrcInner = (pSrcList&&pSrcList->nSrc)?pSrcList->a[0].iCursor:0x7FFFFFFF;
5932030796dfSdrh   cnt.nThis = 0;
5933030796dfSdrh   cnt.nOther = 0;
5934*a4eeccdfSdrh   assert( ExprUseXList(pExpr) );
5935030796dfSdrh   sqlite3WalkExprList(&w, pExpr->x.pList);
59365e484cb3Sdan #ifndef SQLITE_OMIT_WINDOWFUNC
59375e484cb3Sdan   if( ExprHasProperty(pExpr, EP_WinFunc) ){
59385e484cb3Sdan     sqlite3WalkExpr(&w, pExpr->y.pWin->pFilter);
59395e484cb3Sdan   }
59405e484cb3Sdan #endif
5941030796dfSdrh   return cnt.nThis>0 || cnt.nOther==0;
5942374fdce4Sdrh }
5943374fdce4Sdrh 
5944374fdce4Sdrh /*
594589636628Sdrh ** This is a Walker expression node callback.
594689636628Sdrh **
594789636628Sdrh ** For Expr nodes that contain pAggInfo pointers, make sure the AggInfo
594889636628Sdrh ** object that is referenced does not refer directly to the Expr.  If
594989636628Sdrh ** it does, make a copy.  This is done because the pExpr argument is
595089636628Sdrh ** subject to change.
595189636628Sdrh **
595289636628Sdrh ** The copy is stored on pParse->pConstExpr with a register number of 0.
595389636628Sdrh ** This will cause the expression to be deleted automatically when the
595489636628Sdrh ** Parse object is destroyed, but the zero register number means that it
595589636628Sdrh ** will not generate any code in the preamble.
595689636628Sdrh */
595789636628Sdrh static int agginfoPersistExprCb(Walker *pWalker, Expr *pExpr){
59582f82acc0Sdrh   if( ALWAYS(!ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced))
595989636628Sdrh    && pExpr->pAggInfo!=0
596089636628Sdrh   ){
596189636628Sdrh     AggInfo *pAggInfo = pExpr->pAggInfo;
596289636628Sdrh     int iAgg = pExpr->iAgg;
596389636628Sdrh     Parse *pParse = pWalker->pParse;
596489636628Sdrh     sqlite3 *db = pParse->db;
59652f82acc0Sdrh     assert( pExpr->op==TK_AGG_COLUMN || pExpr->op==TK_AGG_FUNCTION );
59662f82acc0Sdrh     if( pExpr->op==TK_AGG_COLUMN ){
596789636628Sdrh       assert( iAgg>=0 && iAgg<pAggInfo->nColumn );
596881185a51Sdrh       if( pAggInfo->aCol[iAgg].pCExpr==pExpr ){
596989636628Sdrh         pExpr = sqlite3ExprDup(db, pExpr, 0);
597089636628Sdrh         if( pExpr ){
597181185a51Sdrh           pAggInfo->aCol[iAgg].pCExpr = pExpr;
5972b3ad4e61Sdrh           sqlite3ExprDeferredDelete(pParse, pExpr);
597389636628Sdrh         }
597489636628Sdrh       }
597589636628Sdrh     }else{
597689636628Sdrh       assert( iAgg>=0 && iAgg<pAggInfo->nFunc );
597781185a51Sdrh       if( pAggInfo->aFunc[iAgg].pFExpr==pExpr ){
597889636628Sdrh         pExpr = sqlite3ExprDup(db, pExpr, 0);
597989636628Sdrh         if( pExpr ){
598081185a51Sdrh           pAggInfo->aFunc[iAgg].pFExpr = pExpr;
5981b3ad4e61Sdrh           sqlite3ExprDeferredDelete(pParse, pExpr);
598289636628Sdrh         }
598389636628Sdrh       }
598489636628Sdrh     }
598589636628Sdrh   }
598689636628Sdrh   return WRC_Continue;
598789636628Sdrh }
598889636628Sdrh 
598989636628Sdrh /*
599089636628Sdrh ** Initialize a Walker object so that will persist AggInfo entries referenced
599189636628Sdrh ** by the tree that is walked.
599289636628Sdrh */
599389636628Sdrh void sqlite3AggInfoPersistWalkerInit(Walker *pWalker, Parse *pParse){
599489636628Sdrh   memset(pWalker, 0, sizeof(*pWalker));
599589636628Sdrh   pWalker->pParse = pParse;
599689636628Sdrh   pWalker->xExprCallback = agginfoPersistExprCb;
599789636628Sdrh   pWalker->xSelectCallback = sqlite3SelectWalkNoop;
599889636628Sdrh }
599989636628Sdrh 
600089636628Sdrh /*
600113449892Sdrh ** Add a new element to the pAggInfo->aCol[] array.  Return the index of
600213449892Sdrh ** the new element.  Return a negative number if malloc fails.
60032282792aSdrh */
600417435752Sdrh static int addAggInfoColumn(sqlite3 *db, AggInfo *pInfo){
600513449892Sdrh   int i;
6006cf643729Sdrh   pInfo->aCol = sqlite3ArrayAllocate(
600717435752Sdrh        db,
6008cf643729Sdrh        pInfo->aCol,
6009cf643729Sdrh        sizeof(pInfo->aCol[0]),
6010cf643729Sdrh        &pInfo->nColumn,
6011cf643729Sdrh        &i
6012cf643729Sdrh   );
601313449892Sdrh   return i;
60142282792aSdrh }
601513449892Sdrh 
601613449892Sdrh /*
601713449892Sdrh ** Add a new element to the pAggInfo->aFunc[] array.  Return the index of
601813449892Sdrh ** the new element.  Return a negative number if malloc fails.
601913449892Sdrh */
602017435752Sdrh static int addAggInfoFunc(sqlite3 *db, AggInfo *pInfo){
602113449892Sdrh   int i;
6022cf643729Sdrh   pInfo->aFunc = sqlite3ArrayAllocate(
602317435752Sdrh        db,
6024cf643729Sdrh        pInfo->aFunc,
6025cf643729Sdrh        sizeof(pInfo->aFunc[0]),
6026cf643729Sdrh        &pInfo->nFunc,
6027cf643729Sdrh        &i
6028cf643729Sdrh   );
602913449892Sdrh   return i;
60302282792aSdrh }
60312282792aSdrh 
60322282792aSdrh /*
60337d10d5a6Sdrh ** This is the xExprCallback for a tree walker.  It is used to
60347d10d5a6Sdrh ** implement sqlite3ExprAnalyzeAggregates().  See sqlite3ExprAnalyzeAggregates
6035626a879aSdrh ** for additional information.
60362282792aSdrh */
60377d10d5a6Sdrh static int analyzeAggregate(Walker *pWalker, Expr *pExpr){
60382282792aSdrh   int i;
60397d10d5a6Sdrh   NameContext *pNC = pWalker->u.pNC;
6040a58fdfb1Sdanielk1977   Parse *pParse = pNC->pParse;
6041a58fdfb1Sdanielk1977   SrcList *pSrcList = pNC->pSrcList;
604225c3b8caSdrh   AggInfo *pAggInfo = pNC->uNC.pAggInfo;
604313449892Sdrh 
604425c3b8caSdrh   assert( pNC->ncFlags & NC_UAggInfo );
60452282792aSdrh   switch( pExpr->op ){
604689c69d00Sdrh     case TK_AGG_COLUMN:
6047967e8b73Sdrh     case TK_COLUMN: {
60488b213899Sdrh       testcase( pExpr->op==TK_AGG_COLUMN );
60498b213899Sdrh       testcase( pExpr->op==TK_COLUMN );
605013449892Sdrh       /* Check to see if the column is in one of the tables in the FROM
605113449892Sdrh       ** clause of the aggregate query */
605220bc393cSdrh       if( ALWAYS(pSrcList!=0) ){
60537601294aSdrh         SrcItem *pItem = pSrcList->a;
605413449892Sdrh         for(i=0; i<pSrcList->nSrc; i++, pItem++){
605513449892Sdrh           struct AggInfo_col *pCol;
6056c5cd1249Sdrh           assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
605713449892Sdrh           if( pExpr->iTable==pItem->iCursor ){
605813449892Sdrh             /* If we reach this point, it means that pExpr refers to a table
605913449892Sdrh             ** that is in the FROM clause of the aggregate query.
606013449892Sdrh             **
606113449892Sdrh             ** Make an entry for the column in pAggInfo->aCol[] if there
606213449892Sdrh             ** is not an entry there already.
606313449892Sdrh             */
60647f906d63Sdrh             int k;
606513449892Sdrh             pCol = pAggInfo->aCol;
60667f906d63Sdrh             for(k=0; k<pAggInfo->nColumn; k++, pCol++){
606713449892Sdrh               if( pCol->iTable==pExpr->iTable &&
606813449892Sdrh                   pCol->iColumn==pExpr->iColumn ){
60692282792aSdrh                 break;
60702282792aSdrh               }
60712282792aSdrh             }
60721e536953Sdanielk1977             if( (k>=pAggInfo->nColumn)
60731e536953Sdanielk1977              && (k = addAggInfoColumn(pParse->db, pAggInfo))>=0
60741e536953Sdanielk1977             ){
60757f906d63Sdrh               pCol = &pAggInfo->aCol[k];
6076eda079cdSdrh               pCol->pTab = pExpr->y.pTab;
607713449892Sdrh               pCol->iTable = pExpr->iTable;
607813449892Sdrh               pCol->iColumn = pExpr->iColumn;
60790a07c107Sdrh               pCol->iMem = ++pParse->nMem;
608013449892Sdrh               pCol->iSorterColumn = -1;
608181185a51Sdrh               pCol->pCExpr = pExpr;
608213449892Sdrh               if( pAggInfo->pGroupBy ){
608313449892Sdrh                 int j, n;
608413449892Sdrh                 ExprList *pGB = pAggInfo->pGroupBy;
608513449892Sdrh                 struct ExprList_item *pTerm = pGB->a;
608613449892Sdrh                 n = pGB->nExpr;
608713449892Sdrh                 for(j=0; j<n; j++, pTerm++){
608813449892Sdrh                   Expr *pE = pTerm->pExpr;
608913449892Sdrh                   if( pE->op==TK_COLUMN && pE->iTable==pExpr->iTable &&
609013449892Sdrh                       pE->iColumn==pExpr->iColumn ){
609113449892Sdrh                     pCol->iSorterColumn = j;
609213449892Sdrh                     break;
60932282792aSdrh                   }
609413449892Sdrh                 }
609513449892Sdrh               }
609613449892Sdrh               if( pCol->iSorterColumn<0 ){
609713449892Sdrh                 pCol->iSorterColumn = pAggInfo->nSortingColumn++;
609813449892Sdrh               }
609913449892Sdrh             }
610013449892Sdrh             /* There is now an entry for pExpr in pAggInfo->aCol[] (either
610113449892Sdrh             ** because it was there before or because we just created it).
610213449892Sdrh             ** Convert the pExpr to be a TK_AGG_COLUMN referring to that
610313449892Sdrh             ** pAggInfo->aCol[] entry.
610413449892Sdrh             */
6105ebb6a65dSdrh             ExprSetVVAProperty(pExpr, EP_NoReduce);
610613449892Sdrh             pExpr->pAggInfo = pAggInfo;
610713449892Sdrh             pExpr->op = TK_AGG_COLUMN;
6108cf697396Sshane             pExpr->iAgg = (i16)k;
610913449892Sdrh             break;
611013449892Sdrh           } /* endif pExpr->iTable==pItem->iCursor */
611113449892Sdrh         } /* end loop over pSrcList */
6112a58fdfb1Sdanielk1977       }
61137d10d5a6Sdrh       return WRC_Prune;
61142282792aSdrh     }
61152282792aSdrh     case TK_AGG_FUNCTION: {
61163a8c4be7Sdrh       if( (pNC->ncFlags & NC_InAggFunc)==0
6117ed551b95Sdrh        && pWalker->walkerDepth==pExpr->op2
61183a8c4be7Sdrh       ){
611913449892Sdrh         /* Check to see if pExpr is a duplicate of another aggregate
612013449892Sdrh         ** function that is already in the pAggInfo structure
612113449892Sdrh         */
612213449892Sdrh         struct AggInfo_func *pItem = pAggInfo->aFunc;
612313449892Sdrh         for(i=0; i<pAggInfo->nFunc; i++, pItem++){
612419e4eefbSdan           if( pItem->pFExpr==pExpr ) break;
612581185a51Sdrh           if( sqlite3ExprCompare(0, pItem->pFExpr, pExpr, -1)==0 ){
61262282792aSdrh             break;
61272282792aSdrh           }
61282282792aSdrh         }
612913449892Sdrh         if( i>=pAggInfo->nFunc ){
613013449892Sdrh           /* pExpr is original.  Make a new entry in pAggInfo->aFunc[]
613113449892Sdrh           */
613214db2665Sdanielk1977           u8 enc = ENC(pParse->db);
61331e536953Sdanielk1977           i = addAggInfoFunc(pParse->db, pAggInfo);
613413449892Sdrh           if( i>=0 ){
61356ab3a2ecSdanielk1977             assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
613613449892Sdrh             pItem = &pAggInfo->aFunc[i];
613781185a51Sdrh             pItem->pFExpr = pExpr;
61380a07c107Sdrh             pItem->iMem = ++pParse->nMem;
6139*a4eeccdfSdrh             assert( ExprUseUToken(pExpr) );
614013449892Sdrh             pItem->pFunc = sqlite3FindFunction(pParse->db,
614180738d9cSdrh                    pExpr->u.zToken,
61426ab3a2ecSdanielk1977                    pExpr->x.pList ? pExpr->x.pList->nExpr : 0, enc, 0);
6143fd357974Sdrh             if( pExpr->flags & EP_Distinct ){
6144fd357974Sdrh               pItem->iDistinct = pParse->nTab++;
6145fd357974Sdrh             }else{
6146fd357974Sdrh               pItem->iDistinct = -1;
6147fd357974Sdrh             }
61482282792aSdrh           }
614913449892Sdrh         }
615013449892Sdrh         /* Make pExpr point to the appropriate pAggInfo->aFunc[] entry
615113449892Sdrh         */
6152c5cd1249Sdrh         assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
6153ebb6a65dSdrh         ExprSetVVAProperty(pExpr, EP_NoReduce);
6154cf697396Sshane         pExpr->iAgg = (i16)i;
615513449892Sdrh         pExpr->pAggInfo = pAggInfo;
61563a8c4be7Sdrh         return WRC_Prune;
61576e83a57fSdrh       }else{
61586e83a57fSdrh         return WRC_Continue;
61596e83a57fSdrh       }
61602282792aSdrh     }
6161a58fdfb1Sdanielk1977   }
61627d10d5a6Sdrh   return WRC_Continue;
61637d10d5a6Sdrh }
6164626a879aSdrh 
6165626a879aSdrh /*
6166e8abb4caSdrh ** Analyze the pExpr expression looking for aggregate functions and
6167e8abb4caSdrh ** for variables that need to be added to AggInfo object that pNC->pAggInfo
6168e8abb4caSdrh ** points to.  Additional entries are made on the AggInfo object as
6169e8abb4caSdrh ** necessary.
6170626a879aSdrh **
6171626a879aSdrh ** This routine should only be called after the expression has been
61727d10d5a6Sdrh ** analyzed by sqlite3ResolveExprNames().
6173626a879aSdrh */
6174d2b3e23bSdrh void sqlite3ExprAnalyzeAggregates(NameContext *pNC, Expr *pExpr){
61757d10d5a6Sdrh   Walker w;
61767d10d5a6Sdrh   w.xExprCallback = analyzeAggregate;
6177e40cc16bSdrh   w.xSelectCallback = sqlite3WalkerDepthIncrease;
6178e40cc16bSdrh   w.xSelectCallback2 = sqlite3WalkerDepthDecrease;
6179979dd1beSdrh   w.walkerDepth = 0;
61807d10d5a6Sdrh   w.u.pNC = pNC;
6181d9995031Sdan   w.pParse = 0;
618220bc393cSdrh   assert( pNC->pSrcList!=0 );
61837d10d5a6Sdrh   sqlite3WalkExpr(&w, pExpr);
61842282792aSdrh }
61855d9a4af9Sdrh 
61865d9a4af9Sdrh /*
61875d9a4af9Sdrh ** Call sqlite3ExprAnalyzeAggregates() for every expression in an
61885d9a4af9Sdrh ** expression list.  Return the number of errors.
61895d9a4af9Sdrh **
61905d9a4af9Sdrh ** If an error is found, the analysis is cut short.
61915d9a4af9Sdrh */
6192d2b3e23bSdrh void sqlite3ExprAnalyzeAggList(NameContext *pNC, ExprList *pList){
61935d9a4af9Sdrh   struct ExprList_item *pItem;
61945d9a4af9Sdrh   int i;
61955d9a4af9Sdrh   if( pList ){
6196d2b3e23bSdrh     for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
6197d2b3e23bSdrh       sqlite3ExprAnalyzeAggregates(pNC, pItem->pExpr);
61985d9a4af9Sdrh     }
61995d9a4af9Sdrh   }
62005d9a4af9Sdrh }
6201892d3179Sdrh 
6202892d3179Sdrh /*
6203ceea3321Sdrh ** Allocate a single new register for use to hold some intermediate result.
6204892d3179Sdrh */
6205892d3179Sdrh int sqlite3GetTempReg(Parse *pParse){
6206e55cbd72Sdrh   if( pParse->nTempReg==0 ){
6207892d3179Sdrh     return ++pParse->nMem;
6208892d3179Sdrh   }
62092f425f6bSdanielk1977   return pParse->aTempReg[--pParse->nTempReg];
6210892d3179Sdrh }
6211ceea3321Sdrh 
6212ceea3321Sdrh /*
6213ceea3321Sdrh ** Deallocate a register, making available for reuse for some other
6214ceea3321Sdrh ** purpose.
6215ceea3321Sdrh */
6216892d3179Sdrh void sqlite3ReleaseTempReg(Parse *pParse, int iReg){
621713d79502Sdrh   if( iReg ){
62183aef2fb1Sdrh     sqlite3VdbeReleaseRegisters(pParse, iReg, 1, 0, 0);
621913d79502Sdrh     if( pParse->nTempReg<ArraySize(pParse->aTempReg) ){
6220892d3179Sdrh       pParse->aTempReg[pParse->nTempReg++] = iReg;
6221892d3179Sdrh     }
6222892d3179Sdrh   }
622313d79502Sdrh }
6224892d3179Sdrh 
6225892d3179Sdrh /*
6226ed24da4bSdrh ** Allocate or deallocate a block of nReg consecutive registers.
6227892d3179Sdrh */
6228892d3179Sdrh int sqlite3GetTempRange(Parse *pParse, int nReg){
6229e55cbd72Sdrh   int i, n;
6230ed24da4bSdrh   if( nReg==1 ) return sqlite3GetTempReg(pParse);
6231892d3179Sdrh   i = pParse->iRangeReg;
6232e55cbd72Sdrh   n = pParse->nRangeReg;
6233f49f3523Sdrh   if( nReg<=n ){
6234892d3179Sdrh     pParse->iRangeReg += nReg;
6235892d3179Sdrh     pParse->nRangeReg -= nReg;
6236892d3179Sdrh   }else{
6237892d3179Sdrh     i = pParse->nMem+1;
6238892d3179Sdrh     pParse->nMem += nReg;
6239892d3179Sdrh   }
6240892d3179Sdrh   return i;
6241892d3179Sdrh }
6242892d3179Sdrh void sqlite3ReleaseTempRange(Parse *pParse, int iReg, int nReg){
6243ed24da4bSdrh   if( nReg==1 ){
6244ed24da4bSdrh     sqlite3ReleaseTempReg(pParse, iReg);
6245ed24da4bSdrh     return;
6246ed24da4bSdrh   }
62473aef2fb1Sdrh   sqlite3VdbeReleaseRegisters(pParse, iReg, nReg, 0, 0);
6248892d3179Sdrh   if( nReg>pParse->nRangeReg ){
6249892d3179Sdrh     pParse->nRangeReg = nReg;
6250892d3179Sdrh     pParse->iRangeReg = iReg;
6251892d3179Sdrh   }
6252892d3179Sdrh }
6253cdc69557Sdrh 
6254cdc69557Sdrh /*
6255cdc69557Sdrh ** Mark all temporary registers as being unavailable for reuse.
62566d2566dfSdrh **
62576d2566dfSdrh ** Always invoke this procedure after coding a subroutine or co-routine
62586d2566dfSdrh ** that might be invoked from other parts of the code, to ensure that
62596d2566dfSdrh ** the sub/co-routine does not use registers in common with the code that
62606d2566dfSdrh ** invokes the sub/co-routine.
6261cdc69557Sdrh */
6262cdc69557Sdrh void sqlite3ClearTempRegCache(Parse *pParse){
6263cdc69557Sdrh   pParse->nTempReg = 0;
6264cdc69557Sdrh   pParse->nRangeReg = 0;
6265cdc69557Sdrh }
6266bb9b5f26Sdrh 
6267bb9b5f26Sdrh /*
6268bb9b5f26Sdrh ** Validate that no temporary register falls within the range of
6269bb9b5f26Sdrh ** iFirst..iLast, inclusive.  This routine is only call from within assert()
6270bb9b5f26Sdrh ** statements.
6271bb9b5f26Sdrh */
6272bb9b5f26Sdrh #ifdef SQLITE_DEBUG
6273bb9b5f26Sdrh int sqlite3NoTempsInRange(Parse *pParse, int iFirst, int iLast){
6274bb9b5f26Sdrh   int i;
6275bb9b5f26Sdrh   if( pParse->nRangeReg>0
62763963e584Sdrh    && pParse->iRangeReg+pParse->nRangeReg > iFirst
62773963e584Sdrh    && pParse->iRangeReg <= iLast
6278bb9b5f26Sdrh   ){
6279bb9b5f26Sdrh      return 0;
6280bb9b5f26Sdrh   }
6281bb9b5f26Sdrh   for(i=0; i<pParse->nTempReg; i++){
6282bb9b5f26Sdrh     if( pParse->aTempReg[i]>=iFirst && pParse->aTempReg[i]<=iLast ){
6283bb9b5f26Sdrh       return 0;
6284bb9b5f26Sdrh     }
6285bb9b5f26Sdrh   }
6286bb9b5f26Sdrh   return 1;
6287bb9b5f26Sdrh }
6288bb9b5f26Sdrh #endif /* SQLITE_DEBUG */
6289