xref: /sqlite-3.40.0/src/expr.c (revision e995d2c2)
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){
256d64b4a0Sdrh   if( iCol<0 || NEVER(iCol>=pTab->nCol) ) return SQLITE_AFF_INTEGER;
266d64b4a0Sdrh   return pTab->aCol[iCol].affinity;
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;
56477572b9Sdrh   if( op==TK_COLUMN || op==TK_AGG_COLUMN ){
57477572b9Sdrh     assert( ExprUseYTab(pExpr) );
58477572b9Sdrh     if( pExpr->y.pTab ){
59de0e1b15Sdrh       return sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
60de0e1b15Sdrh     }
61477572b9Sdrh   }
62487e262fSdrh   if( op==TK_SELECT ){
63a4eeccdfSdrh     assert( ExprUseXSelect(pExpr) );
646af305deSdrh     assert( pExpr->x.pSelect!=0 );
656af305deSdrh     assert( pExpr->x.pSelect->pEList!=0 );
666af305deSdrh     assert( pExpr->x.pSelect->pEList->a[0].pExpr!=0 );
676ab3a2ecSdanielk1977     return sqlite3ExprAffinity(pExpr->x.pSelect->pEList->a[0].pExpr);
68a37cdde0Sdanielk1977   }
69487e262fSdrh #ifndef SQLITE_OMIT_CAST
70487e262fSdrh   if( op==TK_CAST ){
7133e619fcSdrh     assert( !ExprHasProperty(pExpr, EP_IntValue) );
72fdaac671Sdrh     return sqlite3AffinityType(pExpr->u.zToken, 0);
73487e262fSdrh   }
74487e262fSdrh #endif
7580aa5453Sdan   if( op==TK_SELECT_COLUMN ){
76a4eeccdfSdrh     assert( pExpr->pLeft!=0 && ExprUseXSelect(pExpr->pLeft) );
7710f08270Sdrh     assert( pExpr->iColumn < pExpr->iTable );
7810f08270Sdrh     assert( pExpr->iTable==pExpr->pLeft->x.pSelect->pEList->nExpr );
7980aa5453Sdan     return sqlite3ExprAffinity(
8080aa5453Sdan         pExpr->pLeft->x.pSelect->pEList->a[pExpr->iColumn].pExpr
8180aa5453Sdan     );
8280aa5453Sdan   }
83db36e255Sdrh   if( op==TK_VECTOR ){
84a4eeccdfSdrh     assert( ExprUseXList(pExpr) );
85db36e255Sdrh     return sqlite3ExprAffinity(pExpr->x.pList->a[0].pExpr);
86db36e255Sdrh   }
871194904bSdrh   return pExpr->affExpr;
88a37cdde0Sdanielk1977 }
89a37cdde0Sdanielk1977 
9053db1458Sdrh /*
918b4c40d8Sdrh ** Set the collating sequence for expression pExpr to be the collating
92ae80ddeaSdrh ** sequence named by pToken.   Return a pointer to a new Expr node that
93ae80ddeaSdrh ** implements the COLLATE operator.
940a8a406eSdrh **
950a8a406eSdrh ** If a memory allocation error occurs, that fact is recorded in pParse->db
960a8a406eSdrh ** and the pExpr parameter is returned unchanged.
978b4c40d8Sdrh */
984ef7efadSdrh Expr *sqlite3ExprAddCollateToken(
99b6dad520Sdrh   const Parse *pParse,     /* Parsing context */
1004ef7efadSdrh   Expr *pExpr,             /* Add the "COLLATE" clause to this expression */
10180103fc6Sdan   const Token *pCollName,  /* Name of collating sequence */
10280103fc6Sdan   int dequote              /* True to dequote pCollName */
1034ef7efadSdrh ){
104433a3e93Sdrh   if( pCollName->n>0 ){
10580103fc6Sdan     Expr *pNew = sqlite3ExprAlloc(pParse->db, TK_COLLATE, pCollName, dequote);
106ae80ddeaSdrh     if( pNew ){
107ae80ddeaSdrh       pNew->pLeft = pExpr;
108a4c3c87eSdrh       pNew->flags |= EP_Collate|EP_Skip;
1090a8a406eSdrh       pExpr = pNew;
110ae80ddeaSdrh     }
1110a8a406eSdrh   }
1120a8a406eSdrh   return pExpr;
1130a8a406eSdrh }
114b6dad520Sdrh Expr *sqlite3ExprAddCollateString(
115b6dad520Sdrh   const Parse *pParse,  /* Parsing context */
116b6dad520Sdrh   Expr *pExpr,          /* Add the "COLLATE" clause to this expression */
117b6dad520Sdrh   const char *zC        /* The collating sequence name */
118b6dad520Sdrh ){
1190a8a406eSdrh   Token s;
120261d8a51Sdrh   assert( zC!=0 );
12140aced5cSdrh   sqlite3TokenInit(&s, (char*)zC);
12280103fc6Sdan   return sqlite3ExprAddCollateToken(pParse, pExpr, &s, 0);
1230a8a406eSdrh }
1240a8a406eSdrh 
1250a8a406eSdrh /*
1260d950af3Sdrh ** Skip over any TK_COLLATE operators.
1270a8a406eSdrh */
1280a8a406eSdrh Expr *sqlite3ExprSkipCollate(Expr *pExpr){
1290d950af3Sdrh   while( pExpr && ExprHasProperty(pExpr, EP_Skip) ){
13046fe138dSdrh     assert( pExpr->op==TK_COLLATE );
1310d950af3Sdrh     pExpr = pExpr->pLeft;
1320d950af3Sdrh   }
1330d950af3Sdrh   return pExpr;
1340d950af3Sdrh }
1350d950af3Sdrh 
1360d950af3Sdrh /*
1370d950af3Sdrh ** Skip over any TK_COLLATE operators and/or any unlikely()
1380d950af3Sdrh ** or likelihood() or likely() functions at the root of an
1390d950af3Sdrh ** expression.
1400d950af3Sdrh */
1410d950af3Sdrh Expr *sqlite3ExprSkipCollateAndLikely(Expr *pExpr){
142a7d6db6aSdrh   while( pExpr && ExprHasProperty(pExpr, EP_Skip|EP_Unlikely) ){
143a4c3c87eSdrh     if( ExprHasProperty(pExpr, EP_Unlikely) ){
144a4eeccdfSdrh       assert( ExprUseXList(pExpr) );
145cca9f3d2Sdrh       assert( pExpr->x.pList->nExpr>0 );
146a4c3c87eSdrh       assert( pExpr->op==TK_FUNCTION );
147cca9f3d2Sdrh       pExpr = pExpr->x.pList->a[0].pExpr;
148cca9f3d2Sdrh     }else{
14946fe138dSdrh       assert( pExpr->op==TK_COLLATE );
150d91eba96Sdrh       pExpr = pExpr->pLeft;
151cca9f3d2Sdrh     }
152d91eba96Sdrh   }
1530a8a406eSdrh   return pExpr;
1548b4c40d8Sdrh }
1558b4c40d8Sdrh 
1568b4c40d8Sdrh /*
157ae80ddeaSdrh ** Return the collation sequence for the expression pExpr. If
158ae80ddeaSdrh ** there is no defined collating sequence, return NULL.
159ae80ddeaSdrh **
16070efa84dSdrh ** See also: sqlite3ExprNNCollSeq()
16170efa84dSdrh **
16270efa84dSdrh ** The sqlite3ExprNNCollSeq() works the same exact that it returns the
16370efa84dSdrh ** default collation if pExpr has no defined collation.
16470efa84dSdrh **
165ae80ddeaSdrh ** The collating sequence might be determined by a COLLATE operator
166ae80ddeaSdrh ** or by the presence of a column with a defined collating sequence.
167ae80ddeaSdrh ** COLLATE operators take first precedence.  Left operands take
168ae80ddeaSdrh ** precedence over right operands.
1690202b29eSdanielk1977 */
170e7375bfaSdrh CollSeq *sqlite3ExprCollSeq(Parse *pParse, const Expr *pExpr){
171ae80ddeaSdrh   sqlite3 *db = pParse->db;
1727cedc8d4Sdanielk1977   CollSeq *pColl = 0;
173e7375bfaSdrh   const Expr *p = pExpr;
174261d8a51Sdrh   while( p ){
175ae80ddeaSdrh     int op = p->op;
176cb0e04f9Sdrh     if( op==TK_REGISTER ) op = p->op2;
177477572b9Sdrh     if( op==TK_AGG_COLUMN || op==TK_COLUMN || op==TK_TRIGGER ){
178477572b9Sdrh       assert( ExprUseYTab(p) );
179477572b9Sdrh       if( p->y.pTab!=0 ){
180eda079cdSdrh         /* op==TK_REGISTER && p->y.pTab!=0 happens when pExpr was originally
1817d10d5a6Sdrh         ** a TK_COLUMN but was previously evaluated and cached in a register */
1827d10d5a6Sdrh         int j = p->iColumn;
1837d10d5a6Sdrh         if( j>=0 ){
18465b40093Sdrh           const char *zColl = sqlite3ColumnColl(&p->y.pTab->aCol[j]);
185c4a64facSdrh           pColl = sqlite3FindCollSeq(db, ENC(db), zColl, 0);
1860202b29eSdanielk1977         }
1877d10d5a6Sdrh         break;
1887d10d5a6Sdrh       }
189477572b9Sdrh     }
190e081d73cSdrh     if( op==TK_CAST || op==TK_UPLUS ){
191e081d73cSdrh       p = p->pLeft;
192e081d73cSdrh       continue;
193e081d73cSdrh     }
194269d322dSdrh     if( op==TK_VECTOR ){
195a4eeccdfSdrh       assert( ExprUseXList(p) );
196269d322dSdrh       p = p->x.pList->a[0].pExpr;
197269d322dSdrh       continue;
198269d322dSdrh     }
199cb0e04f9Sdrh     if( op==TK_COLLATE ){
200f9751074Sdrh       assert( !ExprHasProperty(p, EP_IntValue) );
201e081d73cSdrh       pColl = sqlite3GetCollSeq(pParse, ENC(db), 0, p->u.zToken);
202e081d73cSdrh       break;
203e081d73cSdrh     }
204ae80ddeaSdrh     if( p->flags & EP_Collate ){
2052308ed38Sdrh       if( p->pLeft && (p->pLeft->flags & EP_Collate)!=0 ){
2067d10d5a6Sdrh         p = p->pLeft;
207ae80ddeaSdrh       }else{
2082308ed38Sdrh         Expr *pNext  = p->pRight;
2096728cd91Sdrh         /* The Expr.x union is never used at the same time as Expr.pRight */
210a4eeccdfSdrh         assert( ExprUseXList(p) );
2116728cd91Sdrh         assert( p->x.pList==0 || p->pRight==0 );
212b32b3093Sdrh         if( p->x.pList!=0 && !db->mallocFailed ){
2132308ed38Sdrh           int i;
2145b107654Sdrh           for(i=0; ALWAYS(i<p->x.pList->nExpr); i++){
2152308ed38Sdrh             if( ExprHasProperty(p->x.pList->a[i].pExpr, EP_Collate) ){
2162308ed38Sdrh               pNext = p->x.pList->a[i].pExpr;
2172308ed38Sdrh               break;
2182308ed38Sdrh             }
2192308ed38Sdrh           }
2202308ed38Sdrh         }
2212308ed38Sdrh         p = pNext;
222ae80ddeaSdrh       }
223ae80ddeaSdrh     }else{
224ae80ddeaSdrh       break;
225ae80ddeaSdrh     }
2260202b29eSdanielk1977   }
2277cedc8d4Sdanielk1977   if( sqlite3CheckCollSeq(pParse, pColl) ){
2287cedc8d4Sdanielk1977     pColl = 0;
2297cedc8d4Sdanielk1977   }
2307cedc8d4Sdanielk1977   return pColl;
2310202b29eSdanielk1977 }
2320202b29eSdanielk1977 
2330202b29eSdanielk1977 /*
23470efa84dSdrh ** Return the collation sequence for the expression pExpr. If
23570efa84dSdrh ** there is no defined collating sequence, return a pointer to the
23670efa84dSdrh ** defautl collation sequence.
23770efa84dSdrh **
23870efa84dSdrh ** See also: sqlite3ExprCollSeq()
23970efa84dSdrh **
24070efa84dSdrh ** The sqlite3ExprCollSeq() routine works the same except that it
24170efa84dSdrh ** returns NULL if there is no defined collation.
24270efa84dSdrh */
243e7375bfaSdrh CollSeq *sqlite3ExprNNCollSeq(Parse *pParse, const Expr *pExpr){
24470efa84dSdrh   CollSeq *p = sqlite3ExprCollSeq(pParse, pExpr);
24570efa84dSdrh   if( p==0 ) p = pParse->db->pDfltColl;
24670efa84dSdrh   assert( p!=0 );
24770efa84dSdrh   return p;
24870efa84dSdrh }
24970efa84dSdrh 
25070efa84dSdrh /*
25170efa84dSdrh ** Return TRUE if the two expressions have equivalent collating sequences.
25270efa84dSdrh */
253e7375bfaSdrh int sqlite3ExprCollSeqMatch(Parse *pParse, const Expr *pE1, const Expr *pE2){
25470efa84dSdrh   CollSeq *pColl1 = sqlite3ExprNNCollSeq(pParse, pE1);
25570efa84dSdrh   CollSeq *pColl2 = sqlite3ExprNNCollSeq(pParse, pE2);
25670efa84dSdrh   return sqlite3StrICmp(pColl1->zName, pColl2->zName)==0;
25770efa84dSdrh }
25870efa84dSdrh 
25970efa84dSdrh /*
260626a879aSdrh ** pExpr is an operand of a comparison operator.  aff2 is the
261626a879aSdrh ** type affinity of the other operand.  This routine returns the
26253db1458Sdrh ** type affinity that should be used for the comparison operator.
26353db1458Sdrh */
264e7375bfaSdrh char sqlite3CompareAffinity(const Expr *pExpr, char aff2){
265bf3b721fSdanielk1977   char aff1 = sqlite3ExprAffinity(pExpr);
26696fb16eeSdrh   if( aff1>SQLITE_AFF_NONE && aff2>SQLITE_AFF_NONE ){
2678df447f0Sdrh     /* Both sides of the comparison are columns. If one has numeric
2688df447f0Sdrh     ** affinity, use that. Otherwise use no affinity.
269e014a838Sdanielk1977     */
2708a51256cSdrh     if( sqlite3IsNumericAffinity(aff1) || sqlite3IsNumericAffinity(aff2) ){
271e014a838Sdanielk1977       return SQLITE_AFF_NUMERIC;
272e014a838Sdanielk1977     }else{
27305883a34Sdrh       return SQLITE_AFF_BLOB;
274e014a838Sdanielk1977     }
275e014a838Sdanielk1977   }else{
276e014a838Sdanielk1977     /* One side is a column, the other is not. Use the columns affinity. */
27796fb16eeSdrh     assert( aff1<=SQLITE_AFF_NONE || aff2<=SQLITE_AFF_NONE );
27896fb16eeSdrh     return (aff1<=SQLITE_AFF_NONE ? aff2 : aff1) | SQLITE_AFF_NONE;
279e014a838Sdanielk1977   }
280e014a838Sdanielk1977 }
281e014a838Sdanielk1977 
28253db1458Sdrh /*
28353db1458Sdrh ** pExpr is a comparison operator.  Return the type affinity that should
28453db1458Sdrh ** be applied to both operands prior to doing the comparison.
28553db1458Sdrh */
286e7375bfaSdrh static char comparisonAffinity(const Expr *pExpr){
287e014a838Sdanielk1977   char aff;
288e014a838Sdanielk1977   assert( pExpr->op==TK_EQ || pExpr->op==TK_IN || pExpr->op==TK_LT ||
289e014a838Sdanielk1977           pExpr->op==TK_GT || pExpr->op==TK_GE || pExpr->op==TK_LE ||
2906a2fe093Sdrh           pExpr->op==TK_NE || pExpr->op==TK_IS || pExpr->op==TK_ISNOT );
291e014a838Sdanielk1977   assert( pExpr->pLeft );
292bf3b721fSdanielk1977   aff = sqlite3ExprAffinity(pExpr->pLeft);
293e014a838Sdanielk1977   if( pExpr->pRight ){
294e014a838Sdanielk1977     aff = sqlite3CompareAffinity(pExpr->pRight, aff);
295a4eeccdfSdrh   }else if( ExprUseXSelect(pExpr) ){
2966ab3a2ecSdanielk1977     aff = sqlite3CompareAffinity(pExpr->x.pSelect->pEList->a[0].pExpr, aff);
29713ac46eeSdrh   }else if( aff==0 ){
29805883a34Sdrh     aff = SQLITE_AFF_BLOB;
299e014a838Sdanielk1977   }
300e014a838Sdanielk1977   return aff;
301e014a838Sdanielk1977 }
302e014a838Sdanielk1977 
303e014a838Sdanielk1977 /*
304e014a838Sdanielk1977 ** pExpr is a comparison expression, eg. '=', '<', IN(...) etc.
305e014a838Sdanielk1977 ** idx_affinity is the affinity of an indexed column. Return true
306e014a838Sdanielk1977 ** if the index with affinity idx_affinity may be used to implement
307e014a838Sdanielk1977 ** the comparison in pExpr.
308e014a838Sdanielk1977 */
309e7375bfaSdrh int sqlite3IndexAffinityOk(const Expr *pExpr, char idx_affinity){
310e014a838Sdanielk1977   char aff = comparisonAffinity(pExpr);
311915e434cSdrh   if( aff<SQLITE_AFF_TEXT ){
3128a51256cSdrh     return 1;
3138a51256cSdrh   }
314915e434cSdrh   if( aff==SQLITE_AFF_TEXT ){
315915e434cSdrh     return idx_affinity==SQLITE_AFF_TEXT;
316915e434cSdrh   }
317915e434cSdrh   return sqlite3IsNumericAffinity(idx_affinity);
318e014a838Sdanielk1977 }
319e014a838Sdanielk1977 
320a37cdde0Sdanielk1977 /*
32135573356Sdrh ** Return the P5 value that should be used for a binary comparison
322a37cdde0Sdanielk1977 ** opcode (OP_Eq, OP_Ge etc.) used to compare pExpr1 and pExpr2.
323a37cdde0Sdanielk1977 */
324e7375bfaSdrh static u8 binaryCompareP5(
325e7375bfaSdrh   const Expr *pExpr1,   /* Left operand */
326e7375bfaSdrh   const Expr *pExpr2,   /* Right operand */
327e7375bfaSdrh   int jumpIfNull        /* Extra flags added to P5 */
328e7375bfaSdrh ){
32935573356Sdrh   u8 aff = (char)sqlite3ExprAffinity(pExpr2);
3301bd10f8aSdrh   aff = (u8)sqlite3CompareAffinity(pExpr1, aff) | (u8)jumpIfNull;
33135573356Sdrh   return aff;
332a37cdde0Sdanielk1977 }
333a37cdde0Sdanielk1977 
334a2e00042Sdrh /*
3350202b29eSdanielk1977 ** Return a pointer to the collation sequence that should be used by
3360202b29eSdanielk1977 ** a binary comparison operator comparing pLeft and pRight.
3370202b29eSdanielk1977 **
3380202b29eSdanielk1977 ** If the left hand expression has a collating sequence type, then it is
3390202b29eSdanielk1977 ** used. Otherwise the collation sequence for the right hand expression
3400202b29eSdanielk1977 ** is used, or the default (BINARY) if neither expression has a collating
3410202b29eSdanielk1977 ** type.
342bcbb04e5Sdanielk1977 **
343bcbb04e5Sdanielk1977 ** Argument pRight (but not pLeft) may be a null pointer. In this case,
344bcbb04e5Sdanielk1977 ** it is not considered.
3450202b29eSdanielk1977 */
346bcbb04e5Sdanielk1977 CollSeq *sqlite3BinaryCompareCollSeq(
347bcbb04e5Sdanielk1977   Parse *pParse,
348e7375bfaSdrh   const Expr *pLeft,
349e7375bfaSdrh   const Expr *pRight
350bcbb04e5Sdanielk1977 ){
351ec41ddacSdrh   CollSeq *pColl;
352ec41ddacSdrh   assert( pLeft );
353ae80ddeaSdrh   if( pLeft->flags & EP_Collate ){
354ae80ddeaSdrh     pColl = sqlite3ExprCollSeq(pParse, pLeft);
355ae80ddeaSdrh   }else if( pRight && (pRight->flags & EP_Collate)!=0 ){
356ae80ddeaSdrh     pColl = sqlite3ExprCollSeq(pParse, pRight);
357ec41ddacSdrh   }else{
358ec41ddacSdrh     pColl = sqlite3ExprCollSeq(pParse, pLeft);
3590202b29eSdanielk1977     if( !pColl ){
3607cedc8d4Sdanielk1977       pColl = sqlite3ExprCollSeq(pParse, pRight);
3610202b29eSdanielk1977     }
362ec41ddacSdrh   }
3630202b29eSdanielk1977   return pColl;
3640202b29eSdanielk1977 }
3650202b29eSdanielk1977 
366898c527eSdrh /* Expresssion p is a comparison operator.  Return a collation sequence
367898c527eSdrh ** appropriate for the comparison operator.
368898c527eSdrh **
369898c527eSdrh ** This is normally just a wrapper around sqlite3BinaryCompareCollSeq().
370898c527eSdrh ** However, if the OP_Commuted flag is set, then the order of the operands
371898c527eSdrh ** is reversed in the sqlite3BinaryCompareCollSeq() call so that the
372898c527eSdrh ** correct collating sequence is found.
373898c527eSdrh */
374e7375bfaSdrh CollSeq *sqlite3ExprCompareCollSeq(Parse *pParse, const Expr *p){
375898c527eSdrh   if( ExprHasProperty(p, EP_Commuted) ){
376898c527eSdrh     return sqlite3BinaryCompareCollSeq(pParse, p->pRight, p->pLeft);
377898c527eSdrh   }else{
378898c527eSdrh     return sqlite3BinaryCompareCollSeq(pParse, p->pLeft, p->pRight);
379898c527eSdrh   }
380898c527eSdrh }
381898c527eSdrh 
3820202b29eSdanielk1977 /*
383be5c89acSdrh ** Generate code for a comparison operator.
384be5c89acSdrh */
385be5c89acSdrh static int codeCompare(
386be5c89acSdrh   Parse *pParse,    /* The parsing (and code generating) context */
387be5c89acSdrh   Expr *pLeft,      /* The left operand */
388be5c89acSdrh   Expr *pRight,     /* The right operand */
389be5c89acSdrh   int opcode,       /* The comparison opcode */
39035573356Sdrh   int in1, int in2, /* Register holding operands */
391be5c89acSdrh   int dest,         /* Jump here if true.  */
392898c527eSdrh   int jumpIfNull,   /* If true, jump if either operand is NULL */
393898c527eSdrh   int isCommuted    /* The comparison has been commuted */
394be5c89acSdrh ){
39535573356Sdrh   int p5;
39635573356Sdrh   int addr;
39735573356Sdrh   CollSeq *p4;
39835573356Sdrh 
3998654186bSdrh   if( pParse->nErr ) return 0;
400898c527eSdrh   if( isCommuted ){
401898c527eSdrh     p4 = sqlite3BinaryCompareCollSeq(pParse, pRight, pLeft);
402898c527eSdrh   }else{
40335573356Sdrh     p4 = sqlite3BinaryCompareCollSeq(pParse, pLeft, pRight);
404898c527eSdrh   }
40535573356Sdrh   p5 = binaryCompareP5(pLeft, pRight, jumpIfNull);
40635573356Sdrh   addr = sqlite3VdbeAddOp4(pParse->pVdbe, opcode, in2, dest, in1,
40735573356Sdrh                            (void*)p4, P4_COLLSEQ);
4081bd10f8aSdrh   sqlite3VdbeChangeP5(pParse->pVdbe, (u8)p5);
40935573356Sdrh   return addr;
410be5c89acSdrh }
411be5c89acSdrh 
412cfbb5e82Sdan /*
413870a0705Sdan ** Return true if expression pExpr is a vector, or false otherwise.
414d832da7fSdrh **
415d832da7fSdrh ** A vector is defined as any expression that results in two or more
416d832da7fSdrh ** columns of result.  Every TK_VECTOR node is an vector because the
417d832da7fSdrh ** parser will not generate a TK_VECTOR with fewer than two entries.
418d832da7fSdrh ** But a TK_SELECT might be either a vector or a scalar. It is only
419d832da7fSdrh ** considered a vector if it has two or more result columns.
420870a0705Sdan */
421b6dad520Sdrh int sqlite3ExprIsVector(const Expr *pExpr){
42276dbe7a8Sdrh   return sqlite3ExprVectorSize(pExpr)>1;
423870a0705Sdan }
424870a0705Sdan 
425870a0705Sdan /*
426cfbb5e82Sdan ** If the expression passed as the only argument is of type TK_VECTOR
427cfbb5e82Sdan ** return the number of expressions in the vector. Or, if the expression
428cfbb5e82Sdan ** is a sub-select, return the number of columns in the sub-select. For
429cfbb5e82Sdan ** any other type of expression, return 1.
430cfbb5e82Sdan */
431b6dad520Sdrh int sqlite3ExprVectorSize(const Expr *pExpr){
43212abf408Sdrh   u8 op = pExpr->op;
43312abf408Sdrh   if( op==TK_REGISTER ) op = pExpr->op2;
43412abf408Sdrh   if( op==TK_VECTOR ){
435a4eeccdfSdrh     assert( ExprUseXList(pExpr) );
43671c57db0Sdan     return pExpr->x.pList->nExpr;
43712abf408Sdrh   }else if( op==TK_SELECT ){
438a4eeccdfSdrh     assert( ExprUseXSelect(pExpr) );
43976dbe7a8Sdrh     return pExpr->x.pSelect->pEList->nExpr;
44076dbe7a8Sdrh   }else{
44176dbe7a8Sdrh     return 1;
44276dbe7a8Sdrh   }
44371c57db0Sdan }
44471c57db0Sdan 
445ba00e30aSdan /*
446fc7f27b9Sdrh ** Return a pointer to a subexpression of pVector that is the i-th
447fc7f27b9Sdrh ** column of the vector (numbered starting with 0).  The caller must
448fc7f27b9Sdrh ** ensure that i is within range.
449fc7f27b9Sdrh **
45076dbe7a8Sdrh ** If pVector is really a scalar (and "scalar" here includes subqueries
45176dbe7a8Sdrh ** that return a single column!) then return pVector unmodified.
45276dbe7a8Sdrh **
453fc7f27b9Sdrh ** pVector retains ownership of the returned subexpression.
454fc7f27b9Sdrh **
455fc7f27b9Sdrh ** If the vector is a (SELECT ...) then the expression returned is
45676dbe7a8Sdrh ** just the expression for the i-th term of the result set, and may
45776dbe7a8Sdrh ** not be ready for evaluation because the table cursor has not yet
45876dbe7a8Sdrh ** been positioned.
459ba00e30aSdan */
460fc7f27b9Sdrh Expr *sqlite3VectorFieldSubexpr(Expr *pVector, int i){
461bf7f3a00Sdrh   assert( i<sqlite3ExprVectorSize(pVector) || pVector->op==TK_ERROR );
462870a0705Sdan   if( sqlite3ExprIsVector(pVector) ){
4639f24b53dSdrh     assert( pVector->op2==0 || pVector->op==TK_REGISTER );
4649f24b53dSdrh     if( pVector->op==TK_SELECT || pVector->op2==TK_SELECT ){
465a4eeccdfSdrh       assert( ExprUseXSelect(pVector) );
46671c57db0Sdan       return pVector->x.pSelect->pEList->a[i].pExpr;
467870a0705Sdan     }else{
468a4eeccdfSdrh       assert( ExprUseXList(pVector) );
46971c57db0Sdan       return pVector->x.pList->a[i].pExpr;
47071c57db0Sdan     }
471870a0705Sdan   }
472870a0705Sdan   return pVector;
473870a0705Sdan }
474fc7f27b9Sdrh 
475fc7f27b9Sdrh /*
476fc7f27b9Sdrh ** Compute and return a new Expr object which when passed to
477fc7f27b9Sdrh ** sqlite3ExprCode() will generate all necessary code to compute
478fc7f27b9Sdrh ** the iField-th column of the vector expression pVector.
479fc7f27b9Sdrh **
4808762ec19Sdrh ** It is ok for pVector to be a scalar (as long as iField==0).
4818762ec19Sdrh ** In that case, this routine works like sqlite3ExprDup().
4828762ec19Sdrh **
483fc7f27b9Sdrh ** The caller owns the returned Expr object and is responsible for
484fc7f27b9Sdrh ** ensuring that the returned value eventually gets freed.
485fc7f27b9Sdrh **
4868762ec19Sdrh ** The caller retains ownership of pVector.  If pVector is a TK_SELECT,
487fad0e70cSdan ** then the returned object will reference pVector and so pVector must remain
4888762ec19Sdrh ** valid for the life of the returned object.  If pVector is a TK_VECTOR
4898762ec19Sdrh ** or a scalar expression, then it can be deleted as soon as this routine
49076dbe7a8Sdrh ** returns.
4918762ec19Sdrh **
4928762ec19Sdrh ** A trick to cause a TK_SELECT pVector to be deleted together with
4938762ec19Sdrh ** the returned Expr object is to attach the pVector to the pRight field
4948762ec19Sdrh ** of the returned TK_SELECT_COLUMN Expr object.
495fc7f27b9Sdrh */
496fc7f27b9Sdrh Expr *sqlite3ExprForVectorField(
497fc7f27b9Sdrh   Parse *pParse,       /* Parsing context */
498fc7f27b9Sdrh   Expr *pVector,       /* The vector.  List of expressions or a sub-SELECT */
49910f08270Sdrh   int iField,          /* Which column of the vector to return */
50010f08270Sdrh   int nField           /* Total number of columns in the vector */
501fc7f27b9Sdrh ){
502fc7f27b9Sdrh   Expr *pRet;
503a1251bc4Sdrh   if( pVector->op==TK_SELECT ){
504a4eeccdfSdrh     assert( ExprUseXSelect(pVector) );
505fc7f27b9Sdrh     /* The TK_SELECT_COLUMN Expr node:
506fc7f27b9Sdrh     **
507966e2911Sdrh     ** pLeft:           pVector containing TK_SELECT.  Not deleted.
5088762ec19Sdrh     ** pRight:          not used.  But recursively deleted.
509fc7f27b9Sdrh     ** iColumn:         Index of a column in pVector
510966e2911Sdrh     ** iTable:          0 or the number of columns on the LHS of an assignment
511fc7f27b9Sdrh     ** pLeft->iTable:   First in an array of register holding result, or 0
512fc7f27b9Sdrh     **                  if the result is not yet computed.
513fc7f27b9Sdrh     **
514fc7f27b9Sdrh     ** sqlite3ExprDelete() specifically skips the recursive delete of
515fc7f27b9Sdrh     ** pLeft on TK_SELECT_COLUMN nodes.  But pRight is followed, so pVector
5168762ec19Sdrh     ** can be attached to pRight to cause this node to take ownership of
5178762ec19Sdrh     ** pVector.  Typically there will be multiple TK_SELECT_COLUMN nodes
5188762ec19Sdrh     ** with the same pLeft pointer to the pVector, but only one of them
5198762ec19Sdrh     ** will own the pVector.
520fc7f27b9Sdrh     */
521abfd35eaSdrh     pRet = sqlite3PExpr(pParse, TK_SELECT_COLUMN, 0, 0);
5228bd0d58eSdrh     if( pRet ){
52310f08270Sdrh       pRet->iTable = nField;
5248bd0d58eSdrh       pRet->iColumn = iField;
5258bd0d58eSdrh       pRet->pLeft = pVector;
5268bd0d58eSdrh     }
527fc7f27b9Sdrh   }else{
528ab632bc9Sdan     if( pVector->op==TK_VECTOR ){
529a4eeccdfSdrh       Expr **ppVector;
530a4eeccdfSdrh       assert( ExprUseXList(pVector) );
531a4eeccdfSdrh       ppVector = &pVector->x.pList->a[iField].pExpr;
532ab632bc9Sdan       pVector = *ppVector;
533ab632bc9Sdan       if( IN_RENAME_OBJECT ){
534ab632bc9Sdan         /* This must be a vector UPDATE inside a trigger */
535ab632bc9Sdan         *ppVector = 0;
536ab632bc9Sdan         return pVector;
537fc7f27b9Sdrh       }
5385a69d19eSdan     }
539ab632bc9Sdan     pRet = sqlite3ExprDup(pParse->db, pVector, 0);
540ab632bc9Sdan   }
541fc7f27b9Sdrh   return pRet;
542fc7f27b9Sdrh }
54371c57db0Sdan 
5445c288b92Sdan /*
5455c288b92Sdan ** If expression pExpr is of type TK_SELECT, generate code to evaluate
5465c288b92Sdan ** it. Return the register in which the result is stored (or, if the
5475c288b92Sdan ** sub-select returns more than one column, the first in an array
5485c288b92Sdan ** of registers in which the result is stored).
5495c288b92Sdan **
5505c288b92Sdan ** If pExpr is not a TK_SELECT expression, return 0.
5515c288b92Sdan */
5525c288b92Sdan static int exprCodeSubselect(Parse *pParse, Expr *pExpr){
5538da209b1Sdan   int reg = 0;
554f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
5555c288b92Sdan   if( pExpr->op==TK_SELECT ){
55685bcdce2Sdrh     reg = sqlite3CodeSubselect(pParse, pExpr);
5578da209b1Sdan   }
558f9b2e05cSdan #endif
5598da209b1Sdan   return reg;
5608da209b1Sdan }
5618da209b1Sdan 
5625c288b92Sdan /*
5635c288b92Sdan ** Argument pVector points to a vector expression - either a TK_VECTOR
564870a0705Sdan ** or TK_SELECT that returns more than one column. This function returns
565870a0705Sdan ** the register number of a register that contains the value of
566870a0705Sdan ** element iField of the vector.
567870a0705Sdan **
568870a0705Sdan ** If pVector is a TK_SELECT expression, then code for it must have
569870a0705Sdan ** already been generated using the exprCodeSubselect() routine. In this
570870a0705Sdan ** case parameter regSelect should be the first in an array of registers
571870a0705Sdan ** containing the results of the sub-select.
572870a0705Sdan **
573870a0705Sdan ** If pVector is of type TK_VECTOR, then code for the requested field
574870a0705Sdan ** is generated. In this case (*pRegFree) may be set to the number of
575870a0705Sdan ** a temporary register to be freed by the caller before returning.
5765c288b92Sdan **
5775c288b92Sdan ** Before returning, output parameter (*ppExpr) is set to point to the
5785c288b92Sdan ** Expr object corresponding to element iElem of the vector.
5795c288b92Sdan */
5805c288b92Sdan static int exprVectorRegister(
5815c288b92Sdan   Parse *pParse,                  /* Parse context */
5825c288b92Sdan   Expr *pVector,                  /* Vector to extract element from */
583870a0705Sdan   int iField,                     /* Field to extract from pVector */
5845c288b92Sdan   int regSelect,                  /* First in array of registers */
5855c288b92Sdan   Expr **ppExpr,                  /* OUT: Expression element */
5865c288b92Sdan   int *pRegFree                   /* OUT: Temp register to free */
5875c288b92Sdan ){
58812abf408Sdrh   u8 op = pVector->op;
58905428127Sdrh   assert( op==TK_VECTOR || op==TK_REGISTER || op==TK_SELECT || op==TK_ERROR );
59012abf408Sdrh   if( op==TK_REGISTER ){
59112abf408Sdrh     *ppExpr = sqlite3VectorFieldSubexpr(pVector, iField);
59212abf408Sdrh     return pVector->iTable+iField;
59312abf408Sdrh   }
59412abf408Sdrh   if( op==TK_SELECT ){
595a4eeccdfSdrh     assert( ExprUseXSelect(pVector) );
596870a0705Sdan     *ppExpr = pVector->x.pSelect->pEList->a[iField].pExpr;
597870a0705Sdan      return regSelect+iField;
5985c288b92Sdan   }
59905428127Sdrh   if( op==TK_VECTOR ){
600a4eeccdfSdrh     assert( ExprUseXList(pVector) );
601870a0705Sdan     *ppExpr = pVector->x.pList->a[iField].pExpr;
6025c288b92Sdan     return sqlite3ExprCodeTemp(pParse, *ppExpr, pRegFree);
6035c288b92Sdan   }
60405428127Sdrh   return 0;
60505428127Sdrh }
6065c288b92Sdan 
6075c288b92Sdan /*
6085c288b92Sdan ** Expression pExpr is a comparison between two vector values. Compute
60979752b6eSdrh ** the result of the comparison (1, 0, or NULL) and write that
61079752b6eSdrh ** result into register dest.
61179752b6eSdrh **
61279752b6eSdrh ** The caller must satisfy the following preconditions:
61379752b6eSdrh **
61479752b6eSdrh **    if pExpr->op==TK_IS:      op==TK_EQ and p5==SQLITE_NULLEQ
61579752b6eSdrh **    if pExpr->op==TK_ISNOT:   op==TK_NE and p5==SQLITE_NULLEQ
61679752b6eSdrh **    otherwise:                op==pExpr->op and p5==0
6175c288b92Sdan */
61879752b6eSdrh static void codeVectorCompare(
61979752b6eSdrh   Parse *pParse,        /* Code generator context */
62079752b6eSdrh   Expr *pExpr,          /* The comparison operation */
62179752b6eSdrh   int dest,             /* Write results into this register */
62279752b6eSdrh   u8 op,                /* Comparison operator */
62379752b6eSdrh   u8 p5                 /* SQLITE_NULLEQ or zero */
62479752b6eSdrh ){
62571c57db0Sdan   Vdbe *v = pParse->pVdbe;
62671c57db0Sdan   Expr *pLeft = pExpr->pLeft;
62771c57db0Sdan   Expr *pRight = pExpr->pRight;
62871c57db0Sdan   int nLeft = sqlite3ExprVectorSize(pLeft);
62971c57db0Sdan   int i;
63071c57db0Sdan   int regLeft = 0;
63171c57db0Sdan   int regRight = 0;
63279752b6eSdrh   u8 opx = op;
6334bc20452Sdrh   int addrCmp = 0;
634ec4ccdbcSdrh   int addrDone = sqlite3VdbeMakeLabel(pParse);
635898c527eSdrh   int isCommuted = ExprHasProperty(pExpr,EP_Commuted);
63671c57db0Sdan 
637e7375bfaSdrh   assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
638340fd0bcSdrh   if( pParse->nErr ) return;
639245ce62eSdrh   if( nLeft!=sqlite3ExprVectorSize(pRight) ){
640245ce62eSdrh     sqlite3ErrorMsg(pParse, "row value misused");
641245ce62eSdrh     return;
642245ce62eSdrh   }
64371c57db0Sdan   assert( pExpr->op==TK_EQ || pExpr->op==TK_NE
64471c57db0Sdan        || pExpr->op==TK_IS || pExpr->op==TK_ISNOT
64571c57db0Sdan        || pExpr->op==TK_LT || pExpr->op==TK_GT
64671c57db0Sdan        || pExpr->op==TK_LE || pExpr->op==TK_GE
64771c57db0Sdan   );
64879752b6eSdrh   assert( pExpr->op==op || (pExpr->op==TK_IS && op==TK_EQ)
64979752b6eSdrh             || (pExpr->op==TK_ISNOT && op==TK_NE) );
65079752b6eSdrh   assert( p5==0 || pExpr->op!=op );
65179752b6eSdrh   assert( p5==SQLITE_NULLEQ || pExpr->op==op );
65271c57db0Sdan 
6534bc20452Sdrh   if( op==TK_LE ) opx = TK_LT;
6544bc20452Sdrh   if( op==TK_GE ) opx = TK_GT;
6554bc20452Sdrh   if( op==TK_NE ) opx = TK_EQ;
6565c288b92Sdan 
6575c288b92Sdan   regLeft = exprCodeSubselect(pParse, pLeft);
6585c288b92Sdan   regRight = exprCodeSubselect(pParse, pRight);
6595c288b92Sdan 
6604bc20452Sdrh   sqlite3VdbeAddOp2(v, OP_Integer, 1, dest);
661321e828dSdrh   for(i=0; 1 /*Loop exits by "break"*/; i++){
6625c288b92Sdan     int regFree1 = 0, regFree2 = 0;
663abc15f1bSdrh     Expr *pL = 0, *pR = 0;
6645c288b92Sdan     int r1, r2;
665321e828dSdrh     assert( i>=0 && i<nLeft );
6664bc20452Sdrh     if( addrCmp ) sqlite3VdbeJumpHere(v, addrCmp);
6675c288b92Sdan     r1 = exprVectorRegister(pParse, pLeft, i, regLeft, &pL, &regFree1);
6685c288b92Sdan     r2 = exprVectorRegister(pParse, pRight, i, regRight, &pR, &regFree2);
6694bc20452Sdrh     addrCmp = sqlite3VdbeCurrentAddr(v);
6704bc20452Sdrh     codeCompare(pParse, pL, pR, opx, r1, r2, addrDone, p5, isCommuted);
67179752b6eSdrh     testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
67279752b6eSdrh     testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
67379752b6eSdrh     testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
67479752b6eSdrh     testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
67579752b6eSdrh     testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
67679752b6eSdrh     testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
67771c57db0Sdan     sqlite3ReleaseTempReg(pParse, regFree1);
67871c57db0Sdan     sqlite3ReleaseTempReg(pParse, regFree2);
6794bc20452Sdrh     if( (opx==TK_LT || opx==TK_GT) && i<nLeft-1 ){
6804bc20452Sdrh       addrCmp = sqlite3VdbeAddOp0(v, OP_ElseEq);
6814bc20452Sdrh       testcase(opx==TK_LT); VdbeCoverageIf(v,opx==TK_LT);
6824bc20452Sdrh       testcase(opx==TK_GT); VdbeCoverageIf(v,opx==TK_GT);
6834bc20452Sdrh     }
6844bc20452Sdrh     if( p5==SQLITE_NULLEQ ){
6854bc20452Sdrh       sqlite3VdbeAddOp2(v, OP_Integer, 0, dest);
6864bc20452Sdrh     }else{
6874bc20452Sdrh       sqlite3VdbeAddOp3(v, OP_ZeroOrNull, r1, dest, r2);
6884bc20452Sdrh     }
68979752b6eSdrh     if( i==nLeft-1 ){
69079752b6eSdrh       break;
69171c57db0Sdan     }
69279752b6eSdrh     if( opx==TK_EQ ){
6934bc20452Sdrh       sqlite3VdbeAddOp2(v, OP_NotNull, dest, addrDone); VdbeCoverage(v);
694a2f62925Sdrh     }else{
695a2f62925Sdrh       assert( op==TK_LT || op==TK_GT || op==TK_LE || op==TK_GE );
6964bc20452Sdrh       sqlite3VdbeAddOp2(v, OP_Goto, 0, addrDone);
69779752b6eSdrh       if( i==nLeft-2 ) opx = op;
69871c57db0Sdan     }
69979752b6eSdrh   }
7004bc20452Sdrh   sqlite3VdbeJumpHere(v, addrCmp);
70179752b6eSdrh   sqlite3VdbeResolveLabel(v, addrDone);
7024bc20452Sdrh   if( op==TK_NE ){
7034bc20452Sdrh     sqlite3VdbeAddOp2(v, OP_Not, dest, dest);
7044bc20452Sdrh   }
70579752b6eSdrh }
70671c57db0Sdan 
7074b5255acSdanielk1977 #if SQLITE_MAX_EXPR_DEPTH>0
7084b5255acSdanielk1977 /*
7094b5255acSdanielk1977 ** Check that argument nHeight is less than or equal to the maximum
7104b5255acSdanielk1977 ** expression depth allowed. If it is not, leave an error message in
7114b5255acSdanielk1977 ** pParse.
7124b5255acSdanielk1977 */
7137d10d5a6Sdrh int sqlite3ExprCheckHeight(Parse *pParse, int nHeight){
7144b5255acSdanielk1977   int rc = SQLITE_OK;
7154b5255acSdanielk1977   int mxHeight = pParse->db->aLimit[SQLITE_LIMIT_EXPR_DEPTH];
7164b5255acSdanielk1977   if( nHeight>mxHeight ){
7174b5255acSdanielk1977     sqlite3ErrorMsg(pParse,
7184b5255acSdanielk1977        "Expression tree is too large (maximum depth %d)", mxHeight
7194b5255acSdanielk1977     );
7204b5255acSdanielk1977     rc = SQLITE_ERROR;
7214b5255acSdanielk1977   }
7224b5255acSdanielk1977   return rc;
7234b5255acSdanielk1977 }
7244b5255acSdanielk1977 
7254b5255acSdanielk1977 /* The following three functions, heightOfExpr(), heightOfExprList()
7264b5255acSdanielk1977 ** and heightOfSelect(), are used to determine the maximum height
7274b5255acSdanielk1977 ** of any expression tree referenced by the structure passed as the
7284b5255acSdanielk1977 ** first argument.
7294b5255acSdanielk1977 **
7304b5255acSdanielk1977 ** If this maximum height is greater than the current value pointed
7314b5255acSdanielk1977 ** to by pnHeight, the second parameter, then set *pnHeight to that
7324b5255acSdanielk1977 ** value.
7334b5255acSdanielk1977 */
734b6dad520Sdrh static void heightOfExpr(const Expr *p, int *pnHeight){
7354b5255acSdanielk1977   if( p ){
7364b5255acSdanielk1977     if( p->nHeight>*pnHeight ){
7374b5255acSdanielk1977       *pnHeight = p->nHeight;
7384b5255acSdanielk1977     }
7394b5255acSdanielk1977   }
7404b5255acSdanielk1977 }
741b6dad520Sdrh static void heightOfExprList(const ExprList *p, int *pnHeight){
7424b5255acSdanielk1977   if( p ){
7434b5255acSdanielk1977     int i;
7444b5255acSdanielk1977     for(i=0; i<p->nExpr; i++){
7454b5255acSdanielk1977       heightOfExpr(p->a[i].pExpr, pnHeight);
7464b5255acSdanielk1977     }
7474b5255acSdanielk1977   }
7484b5255acSdanielk1977 }
749b6dad520Sdrh static void heightOfSelect(const Select *pSelect, int *pnHeight){
750b6dad520Sdrh   const Select *p;
7511a3a3086Sdan   for(p=pSelect; p; p=p->pPrior){
7524b5255acSdanielk1977     heightOfExpr(p->pWhere, pnHeight);
7534b5255acSdanielk1977     heightOfExpr(p->pHaving, pnHeight);
7544b5255acSdanielk1977     heightOfExpr(p->pLimit, pnHeight);
7554b5255acSdanielk1977     heightOfExprList(p->pEList, pnHeight);
7564b5255acSdanielk1977     heightOfExprList(p->pGroupBy, pnHeight);
7574b5255acSdanielk1977     heightOfExprList(p->pOrderBy, pnHeight);
7584b5255acSdanielk1977   }
7594b5255acSdanielk1977 }
7604b5255acSdanielk1977 
7614b5255acSdanielk1977 /*
7624b5255acSdanielk1977 ** Set the Expr.nHeight variable in the structure passed as an
7634b5255acSdanielk1977 ** argument. An expression with no children, Expr.pList or
7644b5255acSdanielk1977 ** Expr.pSelect member has a height of 1. Any other expression
7654b5255acSdanielk1977 ** has a height equal to the maximum height of any other
7664b5255acSdanielk1977 ** referenced Expr plus one.
7672308ed38Sdrh **
7682308ed38Sdrh ** Also propagate EP_Propagate flags up from Expr.x.pList to Expr.flags,
7692308ed38Sdrh ** if appropriate.
7704b5255acSdanielk1977 */
7714b5255acSdanielk1977 static void exprSetHeight(Expr *p){
7722ef11116Sdrh   int nHeight = p->pLeft ? p->pLeft->nHeight : 0;
77347e2fe3cSdrh   if( NEVER(p->pRight) && p->pRight->nHeight>nHeight ){
77447e2fe3cSdrh     nHeight = p->pRight->nHeight;
77547e2fe3cSdrh   }
776a4eeccdfSdrh   if( ExprUseXSelect(p) ){
7776ab3a2ecSdanielk1977     heightOfSelect(p->x.pSelect, &nHeight);
7782308ed38Sdrh   }else if( p->x.pList ){
7796ab3a2ecSdanielk1977     heightOfExprList(p->x.pList, &nHeight);
7802308ed38Sdrh     p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
7816ab3a2ecSdanielk1977   }
7824b5255acSdanielk1977   p->nHeight = nHeight + 1;
7834b5255acSdanielk1977 }
7844b5255acSdanielk1977 
7854b5255acSdanielk1977 /*
7864b5255acSdanielk1977 ** Set the Expr.nHeight variable using the exprSetHeight() function. If
7874b5255acSdanielk1977 ** the height is greater than the maximum allowed expression depth,
7884b5255acSdanielk1977 ** leave an error in pParse.
7892308ed38Sdrh **
7902308ed38Sdrh ** Also propagate all EP_Propagate flags from the Expr.x.pList into
7912308ed38Sdrh ** Expr.flags.
7924b5255acSdanielk1977 */
7932308ed38Sdrh void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
79474893a4cSdrh   if( pParse->nErr ) return;
7954b5255acSdanielk1977   exprSetHeight(p);
7967d10d5a6Sdrh   sqlite3ExprCheckHeight(pParse, p->nHeight);
7974b5255acSdanielk1977 }
7984b5255acSdanielk1977 
7994b5255acSdanielk1977 /*
8004b5255acSdanielk1977 ** Return the maximum height of any expression tree referenced
8014b5255acSdanielk1977 ** by the select statement passed as an argument.
8024b5255acSdanielk1977 */
803b6dad520Sdrh int sqlite3SelectExprHeight(const Select *p){
8044b5255acSdanielk1977   int nHeight = 0;
8054b5255acSdanielk1977   heightOfSelect(p, &nHeight);
8064b5255acSdanielk1977   return nHeight;
8074b5255acSdanielk1977 }
8082308ed38Sdrh #else /* ABOVE:  Height enforcement enabled.  BELOW: Height enforcement off */
8092308ed38Sdrh /*
8102308ed38Sdrh ** Propagate all EP_Propagate flags from the Expr.x.pList into
8112308ed38Sdrh ** Expr.flags.
8122308ed38Sdrh */
8132308ed38Sdrh void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
8146c3b4b07Sdan   if( pParse->nErr ) return;
815a4eeccdfSdrh   if( p && ExprUseXList(p) && p->x.pList ){
8162308ed38Sdrh     p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
8172308ed38Sdrh   }
8182308ed38Sdrh }
8194b5255acSdanielk1977 #define exprSetHeight(y)
8204b5255acSdanielk1977 #endif /* SQLITE_MAX_EXPR_DEPTH>0 */
8214b5255acSdanielk1977 
822be5c89acSdrh /*
823b7916a78Sdrh ** This routine is the core allocator for Expr nodes.
824b7916a78Sdrh **
825a76b5dfcSdrh ** Construct a new expression node and return a pointer to it.  Memory
826b7916a78Sdrh ** for this node and for the pToken argument is a single allocation
827b7916a78Sdrh ** obtained from sqlite3DbMalloc().  The calling function
828a76b5dfcSdrh ** is responsible for making sure the node eventually gets freed.
829b7916a78Sdrh **
830b7916a78Sdrh ** If dequote is true, then the token (if it exists) is dequoted.
831e792b5b4Sdrh ** If dequote is false, no dequoting is performed.  The deQuote
832b7916a78Sdrh ** parameter is ignored if pToken is NULL or if the token does not
833b7916a78Sdrh ** appear to be quoted.  If the quotes were of the form "..." (double-quotes)
834b7916a78Sdrh ** then the EP_DblQuoted flag is set on the expression node.
83533e619fcSdrh **
83633e619fcSdrh ** Special case:  If op==TK_INTEGER and pToken points to a string that
83733e619fcSdrh ** can be translated into a 32-bit integer, then the token is not
83833e619fcSdrh ** stored in u.zToken.  Instead, the integer values is written
83933e619fcSdrh ** into u.iValue and the EP_IntValue flag is set.  No extra storage
84033e619fcSdrh ** is allocated to hold the integer text and the dequote flag is ignored.
841a76b5dfcSdrh */
842b7916a78Sdrh Expr *sqlite3ExprAlloc(
843cca8a4adSdrh   sqlite3 *db,            /* Handle for sqlite3DbMallocRawNN() */
84417435752Sdrh   int op,                 /* Expression opcode */
845b7916a78Sdrh   const Token *pToken,    /* Token argument.  Might be NULL */
846b7916a78Sdrh   int dequote             /* True to dequote */
84717435752Sdrh ){
848a76b5dfcSdrh   Expr *pNew;
84933e619fcSdrh   int nExtra = 0;
850cf697396Sshane   int iValue = 0;
851b7916a78Sdrh 
852575fad65Sdrh   assert( db!=0 );
853b7916a78Sdrh   if( pToken ){
85433e619fcSdrh     if( op!=TK_INTEGER || pToken->z==0
85533e619fcSdrh           || sqlite3GetInt32(pToken->z, &iValue)==0 ){
856b7916a78Sdrh       nExtra = pToken->n+1;
857d50ffc41Sdrh       assert( iValue>=0 );
85833e619fcSdrh     }
859a76b5dfcSdrh   }
860575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, sizeof(Expr)+nExtra);
861b7916a78Sdrh   if( pNew ){
862ca3862dcSdrh     memset(pNew, 0, sizeof(Expr));
8631bd10f8aSdrh     pNew->op = (u8)op;
864a58fdfb1Sdanielk1977     pNew->iAgg = -1;
865a76b5dfcSdrh     if( pToken ){
86633e619fcSdrh       if( nExtra==0 ){
867ad31727fSdrh         pNew->flags |= EP_IntValue|EP_Leaf|(iValue?EP_IsTrue:EP_IsFalse);
86833e619fcSdrh         pNew->u.iValue = iValue;
86933e619fcSdrh       }else{
87033e619fcSdrh         pNew->u.zToken = (char*)&pNew[1];
871b07028f7Sdrh         assert( pToken->z!=0 || pToken->n==0 );
872b07028f7Sdrh         if( pToken->n ) memcpy(pNew->u.zToken, pToken->z, pToken->n);
87333e619fcSdrh         pNew->u.zToken[pToken->n] = 0;
874244b9d6eSdrh         if( dequote && sqlite3Isquote(pNew->u.zToken[0]) ){
87551d35b0fSdrh           sqlite3DequoteExpr(pNew);
876a34001c9Sdrh         }
877a34001c9Sdrh       }
87833e619fcSdrh     }
879b7916a78Sdrh #if SQLITE_MAX_EXPR_DEPTH>0
880b7916a78Sdrh     pNew->nHeight = 1;
881b7916a78Sdrh #endif
882a34001c9Sdrh   }
883a76b5dfcSdrh   return pNew;
884a76b5dfcSdrh }
885a76b5dfcSdrh 
886a76b5dfcSdrh /*
887b7916a78Sdrh ** Allocate a new expression node from a zero-terminated token that has
888b7916a78Sdrh ** already been dequoted.
889b7916a78Sdrh */
890b7916a78Sdrh Expr *sqlite3Expr(
891b7916a78Sdrh   sqlite3 *db,            /* Handle for sqlite3DbMallocZero() (may be null) */
892b7916a78Sdrh   int op,                 /* Expression opcode */
893b7916a78Sdrh   const char *zToken      /* Token argument.  Might be NULL */
894b7916a78Sdrh ){
895b7916a78Sdrh   Token x;
896b7916a78Sdrh   x.z = zToken;
897b40f06c6Sdrh   x.n = sqlite3Strlen30(zToken);
898b7916a78Sdrh   return sqlite3ExprAlloc(db, op, &x, 0);
899b7916a78Sdrh }
900b7916a78Sdrh 
901b7916a78Sdrh /*
902b7916a78Sdrh ** Attach subtrees pLeft and pRight to the Expr node pRoot.
903b7916a78Sdrh **
904b7916a78Sdrh ** If pRoot==NULL that means that a memory allocation error has occurred.
905b7916a78Sdrh ** In that case, delete the subtrees pLeft and pRight.
906b7916a78Sdrh */
907b7916a78Sdrh void sqlite3ExprAttachSubtrees(
908b7916a78Sdrh   sqlite3 *db,
909b7916a78Sdrh   Expr *pRoot,
910b7916a78Sdrh   Expr *pLeft,
911b7916a78Sdrh   Expr *pRight
912b7916a78Sdrh ){
913b7916a78Sdrh   if( pRoot==0 ){
914b7916a78Sdrh     assert( db->mallocFailed );
915b7916a78Sdrh     sqlite3ExprDelete(db, pLeft);
916b7916a78Sdrh     sqlite3ExprDelete(db, pRight);
917b7916a78Sdrh   }else{
91847e2fe3cSdrh     assert( ExprUseXList(pRoot) );
91947e2fe3cSdrh     assert( pRoot->x.pSelect==0 );
920b7916a78Sdrh     if( pRight ){
921b7916a78Sdrh       pRoot->pRight = pRight;
922885a5b03Sdrh       pRoot->flags |= EP_Propagate & pRight->flags;
92347e2fe3cSdrh #if SQLITE_MAX_EXPR_DEPTH>0
92447e2fe3cSdrh       pRoot->nHeight = pRight->nHeight+1;
92547e2fe3cSdrh     }else{
92647e2fe3cSdrh       pRoot->nHeight = 1;
92747e2fe3cSdrh #endif
928b7916a78Sdrh     }
929b7916a78Sdrh     if( pLeft ){
930b7916a78Sdrh       pRoot->pLeft = pLeft;
931885a5b03Sdrh       pRoot->flags |= EP_Propagate & pLeft->flags;
93247e2fe3cSdrh #if SQLITE_MAX_EXPR_DEPTH>0
93347e2fe3cSdrh       if( pLeft->nHeight>=pRoot->nHeight ){
93447e2fe3cSdrh         pRoot->nHeight = pLeft->nHeight+1;
935b7916a78Sdrh       }
93647e2fe3cSdrh #endif
93747e2fe3cSdrh     }
938b7916a78Sdrh   }
939b7916a78Sdrh }
940b7916a78Sdrh 
941b7916a78Sdrh /*
94260ec914cSpeter.d.reid ** Allocate an Expr node which joins as many as two subtrees.
943b7916a78Sdrh **
944bf664469Sdrh ** One or both of the subtrees can be NULL.  Return a pointer to the new
945bf664469Sdrh ** Expr node.  Or, if an OOM error occurs, set pParse->db->mallocFailed,
946bf664469Sdrh ** free the subtrees and return NULL.
947206f3d96Sdrh */
94817435752Sdrh Expr *sqlite3PExpr(
94917435752Sdrh   Parse *pParse,          /* Parsing context */
95017435752Sdrh   int op,                 /* Expression opcode */
95117435752Sdrh   Expr *pLeft,            /* Left operand */
952abfd35eaSdrh   Expr *pRight            /* Right operand */
95317435752Sdrh ){
9545fb52caaSdrh   Expr *p;
955abfd35eaSdrh   p = sqlite3DbMallocRawNN(pParse->db, sizeof(Expr));
956abfd35eaSdrh   if( p ){
957abfd35eaSdrh     memset(p, 0, sizeof(Expr));
958f1722baaSdrh     p->op = op & 0xff;
959abfd35eaSdrh     p->iAgg = -1;
960b7916a78Sdrh     sqlite3ExprAttachSubtrees(pParse->db, p, pLeft, pRight);
9612b359bdbSdan     sqlite3ExprCheckHeight(pParse, p->nHeight);
962d5c851c1Sdrh   }else{
963d5c851c1Sdrh     sqlite3ExprDelete(pParse->db, pLeft);
964d5c851c1Sdrh     sqlite3ExprDelete(pParse->db, pRight);
9652b359bdbSdan   }
9664e0cff60Sdrh   return p;
9674e0cff60Sdrh }
9684e0cff60Sdrh 
9694e0cff60Sdrh /*
97008de4f79Sdrh ** Add pSelect to the Expr.x.pSelect field.  Or, if pExpr is NULL (due
97108de4f79Sdrh ** do a memory allocation failure) then delete the pSelect object.
97208de4f79Sdrh */
97308de4f79Sdrh void sqlite3PExprAddSelect(Parse *pParse, Expr *pExpr, Select *pSelect){
97408de4f79Sdrh   if( pExpr ){
97508de4f79Sdrh     pExpr->x.pSelect = pSelect;
97608de4f79Sdrh     ExprSetProperty(pExpr, EP_xIsSelect|EP_Subquery);
97708de4f79Sdrh     sqlite3ExprSetHeightAndFlags(pParse, pExpr);
97808de4f79Sdrh   }else{
97908de4f79Sdrh     assert( pParse->db->mallocFailed );
98008de4f79Sdrh     sqlite3SelectDelete(pParse->db, pSelect);
98108de4f79Sdrh   }
98208de4f79Sdrh }
98308de4f79Sdrh 
9849289f510Sdan /*
9859289f510Sdan ** Expression list pEList is a list of vector values. This function
9869289f510Sdan ** converts the contents of pEList to a VALUES(...) Select statement
98774777f99Sdan ** returning 1 row for each element of the list. For example, the
98874777f99Sdan ** expression list:
9899289f510Sdan **
99074777f99Sdan **   ( (1,2), (3,4) (5,6) )
9919289f510Sdan **
99274777f99Sdan ** is translated to the equivalent of:
9939289f510Sdan **
99474777f99Sdan **   VALUES(1,2), (3,4), (5,6)
9959289f510Sdan **
99674777f99Sdan ** Each of the vector values in pEList must contain exactly nElem terms.
99774777f99Sdan ** If a list element that is not a vector or does not contain nElem terms,
99874777f99Sdan ** an error message is left in pParse.
9999289f510Sdan **
10009289f510Sdan ** This is used as part of processing IN(...) expressions with a list
10019289f510Sdan ** of vectors on the RHS. e.g. "... IN ((1,2), (3,4), (5,6))".
10029289f510Sdan */
100374777f99Sdan Select *sqlite3ExprListToValues(Parse *pParse, int nElem, ExprList *pEList){
10049289f510Sdan   int ii;
10059289f510Sdan   Select *pRet = 0;
10062931a66eSdan   assert( nElem>1 );
10079289f510Sdan   for(ii=0; ii<pEList->nExpr; ii++){
10089289f510Sdan     Select *pSel;
10099289f510Sdan     Expr *pExpr = pEList->a[ii].pExpr;
1010a4eeccdfSdrh     int nExprElem;
1011a4eeccdfSdrh     if( pExpr->op==TK_VECTOR ){
1012a4eeccdfSdrh       assert( ExprUseXList(pExpr) );
1013a4eeccdfSdrh       nExprElem = pExpr->x.pList->nExpr;
1014a4eeccdfSdrh     }else{
1015a4eeccdfSdrh       nExprElem = 1;
1016a4eeccdfSdrh     }
101774777f99Sdan     if( nExprElem!=nElem ){
101874777f99Sdan       sqlite3ErrorMsg(pParse, "IN(...) element has %d term%s - expected %d",
101974777f99Sdan           nExprElem, nExprElem>1?"s":"", nElem
102074777f99Sdan       );
102174777f99Sdan       break;
10229289f510Sdan     }
1023a4eeccdfSdrh     assert( ExprUseXList(pExpr) );
102474777f99Sdan     pSel = sqlite3SelectNew(pParse, pExpr->x.pList, 0, 0, 0, 0, 0, SF_Values,0);
102574777f99Sdan     pExpr->x.pList = 0;
10269289f510Sdan     if( pSel ){
10279289f510Sdan       if( pRet ){
10289289f510Sdan         pSel->op = TK_ALL;
10299289f510Sdan         pSel->pPrior = pRet;
10309289f510Sdan       }
10319289f510Sdan       pRet = pSel;
10329289f510Sdan     }
10339289f510Sdan   }
10349289f510Sdan 
10359289f510Sdan   if( pRet && pRet->pPrior ){
10369289f510Sdan     pRet->selFlags |= SF_MultiValue;
10379289f510Sdan   }
10389289f510Sdan   sqlite3ExprListDelete(pParse->db, pEList);
10399289f510Sdan   return pRet;
10409289f510Sdan }
104108de4f79Sdrh 
104208de4f79Sdrh /*
104391bb0eedSdrh ** Join two expressions using an AND operator.  If either expression is
104491bb0eedSdrh ** NULL, then just return the other expression.
10455fb52caaSdrh **
10465fb52caaSdrh ** If one side or the other of the AND is known to be false, then instead
10475fb52caaSdrh ** of returning an AND expression, just return a constant expression with
10485fb52caaSdrh ** a value of false.
104991bb0eedSdrh */
1050d5c851c1Sdrh Expr *sqlite3ExprAnd(Parse *pParse, Expr *pLeft, Expr *pRight){
1051d5c851c1Sdrh   sqlite3 *db = pParse->db;
105291bb0eedSdrh   if( pLeft==0  ){
105391bb0eedSdrh     return pRight;
105491bb0eedSdrh   }else if( pRight==0 ){
105591bb0eedSdrh     return pLeft;
10562b6e670fSdan   }else if( (ExprAlwaysFalse(pLeft) || ExprAlwaysFalse(pRight))
10572b6e670fSdan          && !IN_RENAME_OBJECT
10582b6e670fSdan   ){
1059b3ad4e61Sdrh     sqlite3ExprDeferredDelete(pParse, pLeft);
1060b3ad4e61Sdrh     sqlite3ExprDeferredDelete(pParse, pRight);
10615776ee5cSdrh     return sqlite3Expr(db, TK_INTEGER, "0");
106291bb0eedSdrh   }else{
1063d5c851c1Sdrh     return sqlite3PExpr(pParse, TK_AND, pLeft, pRight);
1064a76b5dfcSdrh   }
1065a76b5dfcSdrh }
1066a76b5dfcSdrh 
1067a76b5dfcSdrh /*
1068a76b5dfcSdrh ** Construct a new expression node for a function with multiple
1069a76b5dfcSdrh ** arguments.
1070a76b5dfcSdrh */
1071954733b3Sdrh Expr *sqlite3ExprFunction(
1072954733b3Sdrh   Parse *pParse,        /* Parsing context */
1073954733b3Sdrh   ExprList *pList,      /* Argument list */
1074b6dad520Sdrh   const Token *pToken,  /* Name of the function */
1075954733b3Sdrh   int eDistinct         /* SF_Distinct or SF_ALL or 0 */
1076954733b3Sdrh ){
1077a76b5dfcSdrh   Expr *pNew;
1078633e6d57Sdrh   sqlite3 *db = pParse->db;
10794b202ae2Sdanielk1977   assert( pToken );
1080b7916a78Sdrh   pNew = sqlite3ExprAlloc(db, TK_FUNCTION, pToken, 1);
1081a76b5dfcSdrh   if( pNew==0 ){
1082d9da78a2Sdrh     sqlite3ExprListDelete(db, pList); /* Avoid memory leak when malloc fails */
1083a76b5dfcSdrh     return 0;
1084a76b5dfcSdrh   }
1085a6e8ee12Sdrh   assert( !ExprHasProperty(pNew, EP_InnerON|EP_OuterON) );
108662fc069eSdrh   pNew->w.iOfst = (int)(pToken->z - pParse->zTail);
108714a1b1c1Sdrh   if( pList
108814a1b1c1Sdrh    && pList->nExpr > pParse->db->aLimit[SQLITE_LIMIT_FUNCTION_ARG]
108914a1b1c1Sdrh    && !pParse->nested
109014a1b1c1Sdrh   ){
1091954733b3Sdrh     sqlite3ErrorMsg(pParse, "too many arguments on function %T", pToken);
1092954733b3Sdrh   }
10936ab3a2ecSdanielk1977   pNew->x.pList = pList;
1094fca23557Sdrh   ExprSetProperty(pNew, EP_HasFunc);
1095a4eeccdfSdrh   assert( ExprUseXList(pNew) );
10962308ed38Sdrh   sqlite3ExprSetHeightAndFlags(pParse, pNew);
1097954733b3Sdrh   if( eDistinct==SF_Distinct ) ExprSetProperty(pNew, EP_Distinct);
1098a76b5dfcSdrh   return pNew;
1099a76b5dfcSdrh }
1100a76b5dfcSdrh 
1101a76b5dfcSdrh /*
11020dfa5255Sdrh ** Check to see if a function is usable according to current access
11030dfa5255Sdrh ** rules:
11040dfa5255Sdrh **
11050dfa5255Sdrh **    SQLITE_FUNC_DIRECT    -     Only usable from top-level SQL
11060dfa5255Sdrh **
11070dfa5255Sdrh **    SQLITE_FUNC_UNSAFE    -     Usable if TRUSTED_SCHEMA or from
11080dfa5255Sdrh **                                top-level SQL
11090dfa5255Sdrh **
11100dfa5255Sdrh ** If the function is not usable, create an error.
11110dfa5255Sdrh */
11120dfa5255Sdrh void sqlite3ExprFunctionUsable(
11130dfa5255Sdrh   Parse *pParse,         /* Parsing and code generating context */
1114b6dad520Sdrh   const Expr *pExpr,     /* The function invocation */
1115b6dad520Sdrh   const FuncDef *pDef    /* The function being invoked */
11160dfa5255Sdrh ){
11170dfa5255Sdrh   assert( !IN_RENAME_OBJECT );
11182eeca204Sdrh   assert( (pDef->funcFlags & (SQLITE_FUNC_DIRECT|SQLITE_FUNC_UNSAFE))!=0 );
11192eeca204Sdrh   if( ExprHasProperty(pExpr, EP_FromDDL) ){
11200dfa5255Sdrh     if( (pDef->funcFlags & SQLITE_FUNC_DIRECT)!=0
11210dfa5255Sdrh      || (pParse->db->flags & SQLITE_TrustedSchema)==0
11220dfa5255Sdrh     ){
11230dfa5255Sdrh       /* Functions prohibited in triggers and views if:
11240dfa5255Sdrh       **     (1) tagged with SQLITE_DIRECTONLY
11250dfa5255Sdrh       **     (2) not tagged with SQLITE_INNOCUOUS (which means it
11260dfa5255Sdrh       **         is tagged with SQLITE_FUNC_UNSAFE) and
11270dfa5255Sdrh       **         SQLITE_DBCONFIG_TRUSTED_SCHEMA is off (meaning
11280dfa5255Sdrh       **         that the schema is possibly tainted).
11290dfa5255Sdrh       */
113062fc069eSdrh       sqlite3ErrorMsg(pParse, "unsafe use of %#T()", pExpr);
11310dfa5255Sdrh     }
11320dfa5255Sdrh   }
11330dfa5255Sdrh }
11340dfa5255Sdrh 
11350dfa5255Sdrh /*
1136fa6bc000Sdrh ** Assign a variable number to an expression that encodes a wildcard
1137fa6bc000Sdrh ** in the original SQL statement.
1138fa6bc000Sdrh **
1139fa6bc000Sdrh ** Wildcards consisting of a single "?" are assigned the next sequential
1140fa6bc000Sdrh ** variable number.
1141fa6bc000Sdrh **
1142fa6bc000Sdrh ** Wildcards of the form "?nnn" are assigned the number "nnn".  We make
11439bf755ccSdrh ** sure "nnn" is not too big to avoid a denial of service attack when
1144fa6bc000Sdrh ** the SQL statement comes from an external source.
1145fa6bc000Sdrh **
114651f49f17Sdrh ** Wildcards of the form ":aaa", "@aaa", or "$aaa" are assigned the same number
1147fa6bc000Sdrh ** as the previous instance of the same wildcard.  Or if this is the first
114860ec914cSpeter.d.reid ** instance of the wildcard, the next sequential variable number is
1149fa6bc000Sdrh ** assigned.
1150fa6bc000Sdrh */
1151de25a88cSdrh void sqlite3ExprAssignVarNumber(Parse *pParse, Expr *pExpr, u32 n){
115217435752Sdrh   sqlite3 *db = pParse->db;
1153b7916a78Sdrh   const char *z;
1154f326d66dSdrh   ynVar x;
115517435752Sdrh 
1156fa6bc000Sdrh   if( pExpr==0 ) return;
1157c5cd1249Sdrh   assert( !ExprHasProperty(pExpr, EP_IntValue|EP_Reduced|EP_TokenOnly) );
115833e619fcSdrh   z = pExpr->u.zToken;
1159b7916a78Sdrh   assert( z!=0 );
1160b7916a78Sdrh   assert( z[0]!=0 );
1161b1ed717fSmistachkin   assert( n==(u32)sqlite3Strlen30(z) );
1162b7916a78Sdrh   if( z[1]==0 ){
1163fa6bc000Sdrh     /* Wildcard of the form "?".  Assign the next variable number */
1164b7916a78Sdrh     assert( z[0]=='?' );
1165f326d66dSdrh     x = (ynVar)(++pParse->nVar);
1166124c0b49Sdrh   }else{
1167f326d66dSdrh     int doAdd = 0;
1168124c0b49Sdrh     if( z[0]=='?' ){
1169fa6bc000Sdrh       /* Wildcard of the form "?nnn".  Convert "nnn" to an integer and
1170fa6bc000Sdrh       ** use it as the variable number */
1171c8d735aeSdan       i64 i;
117218814dfbSdrh       int bOk;
117318814dfbSdrh       if( n==2 ){ /*OPTIMIZATION-IF-TRUE*/
117418814dfbSdrh         i = z[1]-'0';  /* The common case of ?N for a single digit N */
117518814dfbSdrh         bOk = 1;
117618814dfbSdrh       }else{
117718814dfbSdrh         bOk = 0==sqlite3Atoi64(&z[1], &i, n-1, SQLITE_UTF8);
117818814dfbSdrh       }
1179c5499befSdrh       testcase( i==0 );
1180c5499befSdrh       testcase( i==1 );
1181c5499befSdrh       testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]-1 );
1182c5499befSdrh       testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] );
1183c8d735aeSdan       if( bOk==0 || i<1 || i>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
1184fa6bc000Sdrh         sqlite3ErrorMsg(pParse, "variable number must be between ?1 and ?%d",
1185bb4957f8Sdrh             db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]);
118662fc069eSdrh         sqlite3RecordErrorOffsetOfExpr(pParse->db, pExpr);
1187c9b39288Sdrh         return;
1188fa6bc000Sdrh       }
11898e74e7baSdrh       x = (ynVar)i;
1190f326d66dSdrh       if( x>pParse->nVar ){
1191f326d66dSdrh         pParse->nVar = (int)x;
1192f326d66dSdrh         doAdd = 1;
1193f326d66dSdrh       }else if( sqlite3VListNumToName(pParse->pVList, x)==0 ){
1194f326d66dSdrh         doAdd = 1;
1195fa6bc000Sdrh       }
1196fa6bc000Sdrh     }else{
119751f49f17Sdrh       /* Wildcards like ":aaa", "$aaa" or "@aaa".  Reuse the same variable
1198fa6bc000Sdrh       ** number as the prior appearance of the same name, or if the name
1199fa6bc000Sdrh       ** has never appeared before, reuse the same variable number
1200fa6bc000Sdrh       */
12019bf755ccSdrh       x = (ynVar)sqlite3VListNameToNum(pParse->pVList, z, n);
12029bf755ccSdrh       if( x==0 ){
12039bf755ccSdrh         x = (ynVar)(++pParse->nVar);
1204f326d66dSdrh         doAdd = 1;
1205f326d66dSdrh       }
1206f326d66dSdrh     }
1207f326d66dSdrh     if( doAdd ){
12089bf755ccSdrh       pParse->pVList = sqlite3VListAdd(db, pParse->pVList, z, n, x);
1209fa6bc000Sdrh     }
1210fa6bc000Sdrh   }
1211c9b39288Sdrh   pExpr->iColumn = x;
1212f326d66dSdrh   if( x>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
1213832b2664Sdanielk1977     sqlite3ErrorMsg(pParse, "too many SQL variables");
121462fc069eSdrh     sqlite3RecordErrorOffsetOfExpr(pParse->db, pExpr);
1215832b2664Sdanielk1977   }
1216fa6bc000Sdrh }
1217fa6bc000Sdrh 
1218fa6bc000Sdrh /*
1219f6963f99Sdan ** Recursively delete an expression tree.
1220a2e00042Sdrh */
12214f0010b1Sdrh static SQLITE_NOINLINE void sqlite3ExprDeleteNN(sqlite3 *db, Expr *p){
12224f0010b1Sdrh   assert( p!=0 );
122341ce47c4Sdrh   assert( db!=0 );
1224477572b9Sdrh   assert( !ExprUseUValue(p) || p->u.iValue>=0 );
1225477572b9Sdrh   assert( !ExprUseYWin(p) || !ExprUseYSub(p) );
1226477572b9Sdrh   assert( !ExprUseYWin(p) || p->y.pWin!=0 || db->mallocFailed );
1227477572b9Sdrh   assert( p->op!=TK_FUNCTION || !ExprUseYSub(p) );
1228209bc522Sdrh #ifdef SQLITE_DEBUG
1229209bc522Sdrh   if( ExprHasProperty(p, EP_Leaf) && !ExprHasProperty(p, EP_TokenOnly) ){
1230209bc522Sdrh     assert( p->pLeft==0 );
1231209bc522Sdrh     assert( p->pRight==0 );
1232a4eeccdfSdrh     assert( !ExprUseXSelect(p) || p->x.pSelect==0 );
1233a4eeccdfSdrh     assert( !ExprUseXList(p) || p->x.pList==0 );
1234209bc522Sdrh   }
1235209bc522Sdrh #endif
1236209bc522Sdrh   if( !ExprHasProperty(p, (EP_TokenOnly|EP_Leaf)) ){
1237c5cd1249Sdrh     /* The Expr.x union is never used at the same time as Expr.pRight */
1238a4eeccdfSdrh     assert( (ExprUseXList(p) && p->x.pList==0) || p->pRight==0 );
12394910a76dSdrh     if( p->pLeft && p->op!=TK_SELECT_COLUMN ) sqlite3ExprDeleteNN(db, p->pLeft);
1240d1086679Sdrh     if( p->pRight ){
12414f9adee2Sdan       assert( !ExprHasProperty(p, EP_WinFunc) );
1242d1086679Sdrh       sqlite3ExprDeleteNN(db, p->pRight);
1243a4eeccdfSdrh     }else if( ExprUseXSelect(p) ){
12444f9adee2Sdan       assert( !ExprHasProperty(p, EP_WinFunc) );
12456ab3a2ecSdanielk1977       sqlite3SelectDelete(db, p->x.pSelect);
12466ab3a2ecSdanielk1977     }else{
12476ab3a2ecSdanielk1977       sqlite3ExprListDelete(db, p->x.pList);
12486ba7ab0dSdan #ifndef SQLITE_OMIT_WINDOWFUNC
1249eda079cdSdrh       if( ExprHasProperty(p, EP_WinFunc) ){
1250eda079cdSdrh         sqlite3WindowDelete(db, p->y.pWin);
125186fb6e17Sdan       }
12526ba7ab0dSdan #endif
12536ab3a2ecSdanielk1977     }
12548117f113Sdan   }
125533e619fcSdrh   if( !ExprHasProperty(p, EP_Static) ){
125641ce47c4Sdrh     sqlite3DbNNFreeNN(db, p);
1257a2e00042Sdrh   }
125833e619fcSdrh }
12594f0010b1Sdrh void sqlite3ExprDelete(sqlite3 *db, Expr *p){
12604f0010b1Sdrh   if( p ) sqlite3ExprDeleteNN(db, p);
12614f0010b1Sdrh }
1262a2e00042Sdrh 
1263d44f8b23Sdrh /*
1264d44f8b23Sdrh ** Clear both elements of an OnOrUsing object
1265d44f8b23Sdrh */
1266d44f8b23Sdrh void sqlite3ClearOnOrUsing(sqlite3 *db, OnOrUsing *p){
1267d44f8b23Sdrh   if( p==0 ){
1268d44f8b23Sdrh     /* Nothing to clear */
1269d44f8b23Sdrh   }else if( p->pOn ){
1270d44f8b23Sdrh     sqlite3ExprDeleteNN(db, p->pOn);
1271d44f8b23Sdrh   }else if( p->pUsing ){
1272d44f8b23Sdrh     sqlite3IdListDelete(db, p->pUsing);
1273d44f8b23Sdrh   }
1274d44f8b23Sdrh }
1275b3ad4e61Sdrh 
1276b3ad4e61Sdrh /*
1277b3ad4e61Sdrh ** Arrange to cause pExpr to be deleted when the pParse is deleted.
1278b3ad4e61Sdrh ** This is similar to sqlite3ExprDelete() except that the delete is
1279b3ad4e61Sdrh ** deferred untilthe pParse is deleted.
1280b3ad4e61Sdrh **
1281b3ad4e61Sdrh ** The pExpr might be deleted immediately on an OOM error.
1282b3ad4e61Sdrh **
1283b3ad4e61Sdrh ** The deferred delete is (currently) implemented by adding the
1284b3ad4e61Sdrh ** pExpr to the pParse->pConstExpr list with a register number of 0.
1285b3ad4e61Sdrh */
1286b3ad4e61Sdrh void sqlite3ExprDeferredDelete(Parse *pParse, Expr *pExpr){
1287ee6b80c3Sdrh   sqlite3ParserAddCleanup(pParse,
1288ee6b80c3Sdrh     (void(*)(sqlite3*,void*))sqlite3ExprDelete,
1289ee6b80c3Sdrh     pExpr);
1290b3ad4e61Sdrh }
1291b3ad4e61Sdrh 
12928e34e406Sdrh /* Invoke sqlite3RenameExprUnmap() and sqlite3ExprDelete() on the
12938e34e406Sdrh ** expression.
12948e34e406Sdrh */
12958e34e406Sdrh void sqlite3ExprUnmapAndDelete(Parse *pParse, Expr *p){
12968e34e406Sdrh   if( p ){
12978e34e406Sdrh     if( IN_RENAME_OBJECT ){
12988e34e406Sdrh       sqlite3RenameExprUnmap(pParse, p);
12998e34e406Sdrh     }
13008e34e406Sdrh     sqlite3ExprDeleteNN(pParse->db, p);
13018e34e406Sdrh   }
13028e34e406Sdrh }
13038e34e406Sdrh 
1304d2687b77Sdrh /*
13056ab3a2ecSdanielk1977 ** Return the number of bytes allocated for the expression structure
13066ab3a2ecSdanielk1977 ** passed as the first argument. This is always one of EXPR_FULLSIZE,
13076ab3a2ecSdanielk1977 ** EXPR_REDUCEDSIZE or EXPR_TOKENONLYSIZE.
13086ab3a2ecSdanielk1977 */
1309b6dad520Sdrh static int exprStructSize(const Expr *p){
13106ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_TokenOnly) ) return EXPR_TOKENONLYSIZE;
13116ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_Reduced) ) return EXPR_REDUCEDSIZE;
13126ab3a2ecSdanielk1977   return EXPR_FULLSIZE;
13136ab3a2ecSdanielk1977 }
13146ab3a2ecSdanielk1977 
13156ab3a2ecSdanielk1977 /*
131633e619fcSdrh ** The dupedExpr*Size() routines each return the number of bytes required
131733e619fcSdrh ** to store a copy of an expression or expression tree.  They differ in
131833e619fcSdrh ** how much of the tree is measured.
131933e619fcSdrh **
132033e619fcSdrh **     dupedExprStructSize()     Size of only the Expr structure
132133e619fcSdrh **     dupedExprNodeSize()       Size of Expr + space for token
132233e619fcSdrh **     dupedExprSize()           Expr + token + subtree components
132333e619fcSdrh **
132433e619fcSdrh ***************************************************************************
132533e619fcSdrh **
132633e619fcSdrh ** The dupedExprStructSize() function returns two values OR-ed together:
132733e619fcSdrh ** (1) the space required for a copy of the Expr structure only and
132833e619fcSdrh ** (2) the EP_xxx flags that indicate what the structure size should be.
132933e619fcSdrh ** The return values is always one of:
133033e619fcSdrh **
133133e619fcSdrh **      EXPR_FULLSIZE
133233e619fcSdrh **      EXPR_REDUCEDSIZE   | EP_Reduced
133333e619fcSdrh **      EXPR_TOKENONLYSIZE | EP_TokenOnly
133433e619fcSdrh **
133533e619fcSdrh ** The size of the structure can be found by masking the return value
133633e619fcSdrh ** of this routine with 0xfff.  The flags can be found by masking the
133733e619fcSdrh ** return value with EP_Reduced|EP_TokenOnly.
133833e619fcSdrh **
133933e619fcSdrh ** Note that with flags==EXPRDUP_REDUCE, this routines works on full-size
134033e619fcSdrh ** (unreduced) Expr objects as they or originally constructed by the parser.
134133e619fcSdrh ** During expression analysis, extra information is computed and moved into
1342c95f38d4Sdan ** later parts of the Expr object and that extra information might get chopped
134333e619fcSdrh ** off if the expression is reduced.  Note also that it does not work to
134460ec914cSpeter.d.reid ** make an EXPRDUP_REDUCE copy of a reduced expression.  It is only legal
134533e619fcSdrh ** to reduce a pristine expression tree from the parser.  The implementation
134633e619fcSdrh ** of dupedExprStructSize() contain multiple assert() statements that attempt
134733e619fcSdrh ** to enforce this constraint.
13486ab3a2ecSdanielk1977 */
1349b6dad520Sdrh static int dupedExprStructSize(const Expr *p, int flags){
13506ab3a2ecSdanielk1977   int nSize;
135133e619fcSdrh   assert( flags==EXPRDUP_REDUCE || flags==0 ); /* Only one flag value allowed */
1352aecd8021Sdrh   assert( EXPR_FULLSIZE<=0xfff );
1353aecd8021Sdrh   assert( (0xfff & (EP_Reduced|EP_TokenOnly))==0 );
135467a9b8edSdan   if( 0==flags || p->op==TK_SELECT_COLUMN
135567a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
1356eda079cdSdrh    || ExprHasProperty(p, EP_WinFunc)
135767a9b8edSdan #endif
135867a9b8edSdan   ){
13596ab3a2ecSdanielk1977     nSize = EXPR_FULLSIZE;
13606ab3a2ecSdanielk1977   }else{
1361c5cd1249Sdrh     assert( !ExprHasProperty(p, EP_TokenOnly|EP_Reduced) );
136267a99dbeSdrh     assert( !ExprHasProperty(p, EP_OuterON) );
1363e7375bfaSdrh     assert( !ExprHasVVAProperty(p, EP_NoReduce) );
1364aecd8021Sdrh     if( p->pLeft || p->x.pList ){
136533e619fcSdrh       nSize = EXPR_REDUCEDSIZE | EP_Reduced;
136633e619fcSdrh     }else{
1367aecd8021Sdrh       assert( p->pRight==0 );
136833e619fcSdrh       nSize = EXPR_TOKENONLYSIZE | EP_TokenOnly;
136933e619fcSdrh     }
13706ab3a2ecSdanielk1977   }
13716ab3a2ecSdanielk1977   return nSize;
13726ab3a2ecSdanielk1977 }
13736ab3a2ecSdanielk1977 
13746ab3a2ecSdanielk1977 /*
137533e619fcSdrh ** This function returns the space in bytes required to store the copy
137633e619fcSdrh ** of the Expr structure and a copy of the Expr.u.zToken string (if that
137733e619fcSdrh ** string is defined.)
13786ab3a2ecSdanielk1977 */
1379b6dad520Sdrh static int dupedExprNodeSize(const Expr *p, int flags){
138033e619fcSdrh   int nByte = dupedExprStructSize(p, flags) & 0xfff;
138133e619fcSdrh   if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
13827301e774Sdrh     nByte += sqlite3Strlen30NN(p->u.zToken)+1;
13836ab3a2ecSdanielk1977   }
1384bc73971dSdanielk1977   return ROUND8(nByte);
13856ab3a2ecSdanielk1977 }
13866ab3a2ecSdanielk1977 
13876ab3a2ecSdanielk1977 /*
13886ab3a2ecSdanielk1977 ** Return the number of bytes required to create a duplicate of the
13896ab3a2ecSdanielk1977 ** expression passed as the first argument. The second argument is a
13906ab3a2ecSdanielk1977 ** mask containing EXPRDUP_XXX flags.
13916ab3a2ecSdanielk1977 **
13926ab3a2ecSdanielk1977 ** The value returned includes space to create a copy of the Expr struct
139333e619fcSdrh ** itself and the buffer referred to by Expr.u.zToken, if any.
13946ab3a2ecSdanielk1977 **
13956ab3a2ecSdanielk1977 ** If the EXPRDUP_REDUCE flag is set, then the return value includes
13966ab3a2ecSdanielk1977 ** space to duplicate all Expr nodes in the tree formed by Expr.pLeft
13976ab3a2ecSdanielk1977 ** and Expr.pRight variables (but not for any structures pointed to or
13986ab3a2ecSdanielk1977 ** descended from the Expr.x.pList or Expr.x.pSelect variables).
13996ab3a2ecSdanielk1977 */
1400b6dad520Sdrh static int dupedExprSize(const Expr *p, int flags){
14016ab3a2ecSdanielk1977   int nByte = 0;
14026ab3a2ecSdanielk1977   if( p ){
14036ab3a2ecSdanielk1977     nByte = dupedExprNodeSize(p, flags);
14046ab3a2ecSdanielk1977     if( flags&EXPRDUP_REDUCE ){
1405b7916a78Sdrh       nByte += dupedExprSize(p->pLeft, flags) + dupedExprSize(p->pRight, flags);
14066ab3a2ecSdanielk1977     }
14076ab3a2ecSdanielk1977   }
14086ab3a2ecSdanielk1977   return nByte;
14096ab3a2ecSdanielk1977 }
14106ab3a2ecSdanielk1977 
14116ab3a2ecSdanielk1977 /*
14126ab3a2ecSdanielk1977 ** This function is similar to sqlite3ExprDup(), except that if pzBuffer
14136ab3a2ecSdanielk1977 ** is not NULL then *pzBuffer is assumed to point to a buffer large enough
141433e619fcSdrh ** to store the copy of expression p, the copies of p->u.zToken
14156ab3a2ecSdanielk1977 ** (if applicable), and the copies of the p->pLeft and p->pRight expressions,
141660ec914cSpeter.d.reid ** if any. Before returning, *pzBuffer is set to the first byte past the
14176ab3a2ecSdanielk1977 ** portion of the buffer copied into by this function.
14186ab3a2ecSdanielk1977 */
1419b6dad520Sdrh static Expr *exprDup(sqlite3 *db, const Expr *p, int dupFlags, u8 **pzBuffer){
14203c19469cSdrh   Expr *pNew;           /* Value to return */
14213c19469cSdrh   u8 *zAlloc;           /* Memory space from which to build Expr object */
14223c19469cSdrh   u32 staticFlag;       /* EP_Static if space not obtained from malloc */
14236ab3a2ecSdanielk1977 
14243c19469cSdrh   assert( db!=0 );
14253c19469cSdrh   assert( p );
14263c19469cSdrh   assert( dupFlags==0 || dupFlags==EXPRDUP_REDUCE );
14273c19469cSdrh   assert( pzBuffer==0 || dupFlags==EXPRDUP_REDUCE );
14286ab3a2ecSdanielk1977 
14296ab3a2ecSdanielk1977   /* Figure out where to write the new Expr structure. */
14306ab3a2ecSdanielk1977   if( pzBuffer ){
14316ab3a2ecSdanielk1977     zAlloc = *pzBuffer;
143233e619fcSdrh     staticFlag = EP_Static;
14333c6edc8aSdrh     assert( zAlloc!=0 );
14346ab3a2ecSdanielk1977   }else{
14353c19469cSdrh     zAlloc = sqlite3DbMallocRawNN(db, dupedExprSize(p, dupFlags));
14363c19469cSdrh     staticFlag = 0;
14376ab3a2ecSdanielk1977   }
14386ab3a2ecSdanielk1977   pNew = (Expr *)zAlloc;
14396ab3a2ecSdanielk1977 
14406ab3a2ecSdanielk1977   if( pNew ){
14416ab3a2ecSdanielk1977     /* Set nNewSize to the size allocated for the structure pointed to
14426ab3a2ecSdanielk1977     ** by pNew. This is either EXPR_FULLSIZE, EXPR_REDUCEDSIZE or
14436ab3a2ecSdanielk1977     ** EXPR_TOKENONLYSIZE. nToken is set to the number of bytes consumed
144433e619fcSdrh     ** by the copy of the p->u.zToken string (if any).
14456ab3a2ecSdanielk1977     */
14463c19469cSdrh     const unsigned nStructSize = dupedExprStructSize(p, dupFlags);
144733e619fcSdrh     const int nNewSize = nStructSize & 0xfff;
144833e619fcSdrh     int nToken;
144933e619fcSdrh     if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
145033e619fcSdrh       nToken = sqlite3Strlen30(p->u.zToken) + 1;
145133e619fcSdrh     }else{
145233e619fcSdrh       nToken = 0;
145333e619fcSdrh     }
14543c19469cSdrh     if( dupFlags ){
14556ab3a2ecSdanielk1977       assert( ExprHasProperty(p, EP_Reduced)==0 );
14566ab3a2ecSdanielk1977       memcpy(zAlloc, p, nNewSize);
14576ab3a2ecSdanielk1977     }else{
14583e6a1411Sdan       u32 nSize = (u32)exprStructSize(p);
14596ab3a2ecSdanielk1977       memcpy(zAlloc, p, nSize);
146072ea29d7Sdrh       if( nSize<EXPR_FULLSIZE ){
14616ab3a2ecSdanielk1977         memset(&zAlloc[nSize], 0, EXPR_FULLSIZE-nSize);
14626ab3a2ecSdanielk1977       }
146372ea29d7Sdrh     }
14646ab3a2ecSdanielk1977 
146533e619fcSdrh     /* Set the EP_Reduced, EP_TokenOnly, and EP_Static flags appropriately. */
1466825fa17bSdrh     pNew->flags &= ~(EP_Reduced|EP_TokenOnly|EP_Static);
146733e619fcSdrh     pNew->flags |= nStructSize & (EP_Reduced|EP_TokenOnly);
146833e619fcSdrh     pNew->flags |= staticFlag;
1469e7375bfaSdrh     ExprClearVVAProperties(pNew);
1470e7375bfaSdrh     if( dupFlags ){
1471e7375bfaSdrh       ExprSetVVAProperty(pNew, EP_Immutable);
1472e7375bfaSdrh     }
14736ab3a2ecSdanielk1977 
147433e619fcSdrh     /* Copy the p->u.zToken string, if any. */
14756ab3a2ecSdanielk1977     if( nToken ){
147633e619fcSdrh       char *zToken = pNew->u.zToken = (char*)&zAlloc[nNewSize];
147733e619fcSdrh       memcpy(zToken, p->u.zToken, nToken);
14786ab3a2ecSdanielk1977     }
14796ab3a2ecSdanielk1977 
1480209bc522Sdrh     if( 0==((p->flags|pNew->flags) & (EP_TokenOnly|EP_Leaf)) ){
14816ab3a2ecSdanielk1977       /* Fill in the pNew->x.pSelect or pNew->x.pList member. */
1482a4eeccdfSdrh       if( ExprUseXSelect(p) ){
14833c19469cSdrh         pNew->x.pSelect = sqlite3SelectDup(db, p->x.pSelect, dupFlags);
14846ab3a2ecSdanielk1977       }else{
14853c19469cSdrh         pNew->x.pList = sqlite3ExprListDup(db, p->x.pList, dupFlags);
14866ab3a2ecSdanielk1977       }
14876ab3a2ecSdanielk1977     }
14886ab3a2ecSdanielk1977 
14896ab3a2ecSdanielk1977     /* Fill in pNew->pLeft and pNew->pRight. */
14904f9adee2Sdan     if( ExprHasProperty(pNew, EP_Reduced|EP_TokenOnly|EP_WinFunc) ){
14913c19469cSdrh       zAlloc += dupedExprNodeSize(p, dupFlags);
1492209bc522Sdrh       if( !ExprHasProperty(pNew, EP_TokenOnly|EP_Leaf) ){
14933c19469cSdrh         pNew->pLeft = p->pLeft ?
14943c19469cSdrh                       exprDup(db, p->pLeft, EXPRDUP_REDUCE, &zAlloc) : 0;
14953c19469cSdrh         pNew->pRight = p->pRight ?
14963c19469cSdrh                        exprDup(db, p->pRight, EXPRDUP_REDUCE, &zAlloc) : 0;
14976ab3a2ecSdanielk1977       }
149867a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
1499eda079cdSdrh       if( ExprHasProperty(p, EP_WinFunc) ){
1500eda079cdSdrh         pNew->y.pWin = sqlite3WindowDup(db, pNew, p->y.pWin);
1501eda079cdSdrh         assert( ExprHasProperty(pNew, EP_WinFunc) );
1502e2f781b9Sdan       }
150367a9b8edSdan #endif /* SQLITE_OMIT_WINDOWFUNC */
150453988068Sdrh       if( pzBuffer ){
150553988068Sdrh         *pzBuffer = zAlloc;
150653988068Sdrh       }
150753988068Sdrh     }else{
1508209bc522Sdrh       if( !ExprHasProperty(p, EP_TokenOnly|EP_Leaf) ){
15099854260bSdrh         if( pNew->op==TK_SELECT_COLUMN ){
15109854260bSdrh           pNew->pLeft = p->pLeft;
15115cc9daf8Sdrh           assert( p->pRight==0  || p->pRight==p->pLeft
15125cc9daf8Sdrh                                 || ExprHasProperty(p->pLeft, EP_Subquery) );
15139854260bSdrh         }else{
15146ab3a2ecSdanielk1977           pNew->pLeft = sqlite3ExprDup(db, p->pLeft, 0);
15159854260bSdrh         }
15166ab3a2ecSdanielk1977         pNew->pRight = sqlite3ExprDup(db, p->pRight, 0);
15176ab3a2ecSdanielk1977       }
15186ab3a2ecSdanielk1977     }
15196ab3a2ecSdanielk1977   }
15206ab3a2ecSdanielk1977   return pNew;
15216ab3a2ecSdanielk1977 }
15226ab3a2ecSdanielk1977 
15236ab3a2ecSdanielk1977 /*
1524bfe31e7fSdan ** Create and return a deep copy of the object passed as the second
1525bfe31e7fSdan ** argument. If an OOM condition is encountered, NULL is returned
1526bfe31e7fSdan ** and the db->mallocFailed flag set.
1527bfe31e7fSdan */
1528eede6a53Sdan #ifndef SQLITE_OMIT_CTE
152926d61e5aSdan With *sqlite3WithDup(sqlite3 *db, With *p){
15304e9119d9Sdan   With *pRet = 0;
15314e9119d9Sdan   if( p ){
1532d4de9f7bSdrh     sqlite3_int64 nByte = sizeof(*p) + sizeof(p->a[0]) * (p->nCte-1);
15334e9119d9Sdan     pRet = sqlite3DbMallocZero(db, nByte);
15344e9119d9Sdan     if( pRet ){
15354e9119d9Sdan       int i;
15364e9119d9Sdan       pRet->nCte = p->nCte;
15374e9119d9Sdan       for(i=0; i<p->nCte; i++){
15384e9119d9Sdan         pRet->a[i].pSelect = sqlite3SelectDup(db, p->a[i].pSelect, 0);
15394e9119d9Sdan         pRet->a[i].pCols = sqlite3ExprListDup(db, p->a[i].pCols, 0);
15404e9119d9Sdan         pRet->a[i].zName = sqlite3DbStrDup(db, p->a[i].zName);
154167f70beaSdrh         pRet->a[i].eM10d = p->a[i].eM10d;
15424e9119d9Sdan       }
15434e9119d9Sdan     }
15444e9119d9Sdan   }
15454e9119d9Sdan   return pRet;
15464e9119d9Sdan }
1547eede6a53Sdan #else
154826d61e5aSdan # define sqlite3WithDup(x,y) 0
1549eede6a53Sdan #endif
15504e9119d9Sdan 
1551a8389975Sdrh #ifndef SQLITE_OMIT_WINDOWFUNC
1552a8389975Sdrh /*
1553a8389975Sdrh ** The gatherSelectWindows() procedure and its helper routine
1554a8389975Sdrh ** gatherSelectWindowsCallback() are used to scan all the expressions
1555a8389975Sdrh ** an a newly duplicated SELECT statement and gather all of the Window
1556a8389975Sdrh ** objects found there, assembling them onto the linked list at Select->pWin.
1557a8389975Sdrh */
1558a8389975Sdrh static int gatherSelectWindowsCallback(Walker *pWalker, Expr *pExpr){
15596ba7ab0dSdan   if( pExpr->op==TK_FUNCTION && ExprHasProperty(pExpr, EP_WinFunc) ){
156075b0821eSdan     Select *pSelect = pWalker->u.pSelect;
156175b0821eSdan     Window *pWin = pExpr->y.pWin;
156275b0821eSdan     assert( pWin );
15634f9adee2Sdan     assert( IsWindowFunc(pExpr) );
1564e0ae3f69Sdan     assert( pWin->ppThis==0 );
1565a3fcc000Sdan     sqlite3WindowLink(pSelect, pWin);
1566a8389975Sdrh   }
1567a8389975Sdrh   return WRC_Continue;
1568a8389975Sdrh }
1569a37b6a5eSdrh static int gatherSelectWindowsSelectCallback(Walker *pWalker, Select *p){
1570a37b6a5eSdrh   return p==pWalker->u.pSelect ? WRC_Continue : WRC_Prune;
1571a37b6a5eSdrh }
1572a8389975Sdrh static void gatherSelectWindows(Select *p){
1573a8389975Sdrh   Walker w;
1574a8389975Sdrh   w.xExprCallback = gatherSelectWindowsCallback;
1575a37b6a5eSdrh   w.xSelectCallback = gatherSelectWindowsSelectCallback;
1576a37b6a5eSdrh   w.xSelectCallback2 = 0;
15779c46c66cSdrh   w.pParse = 0;
1578a8389975Sdrh   w.u.pSelect = p;
1579a37b6a5eSdrh   sqlite3WalkSelect(&w, p);
1580a8389975Sdrh }
1581a8389975Sdrh #endif
1582a8389975Sdrh 
1583a8389975Sdrh 
1584a76b5dfcSdrh /*
1585ff78bd2fSdrh ** The following group of routines make deep copies of expressions,
1586ff78bd2fSdrh ** expression lists, ID lists, and select statements.  The copies can
1587ff78bd2fSdrh ** be deleted (by being passed to their respective ...Delete() routines)
1588ff78bd2fSdrh ** without effecting the originals.
1589ff78bd2fSdrh **
15904adee20fSdanielk1977 ** The expression list, ID, and source lists return by sqlite3ExprListDup(),
15914adee20fSdanielk1977 ** sqlite3IdListDup(), and sqlite3SrcListDup() can not be further expanded
1592ad3cab52Sdrh ** by subsequent calls to sqlite*ListAppend() routines.
1593ff78bd2fSdrh **
1594ad3cab52Sdrh ** Any tables that the SrcList might point to are not duplicated.
15956ab3a2ecSdanielk1977 **
1596b7916a78Sdrh ** The flags parameter contains a combination of the EXPRDUP_XXX flags.
15976ab3a2ecSdanielk1977 ** If the EXPRDUP_REDUCE flag is set, then the structure returned is a
15986ab3a2ecSdanielk1977 ** truncated version of the usual Expr structure that will be stored as
15996ab3a2ecSdanielk1977 ** part of the in-memory representation of the database schema.
1600ff78bd2fSdrh */
1601b6dad520Sdrh Expr *sqlite3ExprDup(sqlite3 *db, const Expr *p, int flags){
160272ea29d7Sdrh   assert( flags==0 || flags==EXPRDUP_REDUCE );
16033c19469cSdrh   return p ? exprDup(db, p, flags, 0) : 0;
1604ff78bd2fSdrh }
1605b6dad520Sdrh ExprList *sqlite3ExprListDup(sqlite3 *db, const ExprList *p, int flags){
1606ff78bd2fSdrh   ExprList *pNew;
1607b6dad520Sdrh   struct ExprList_item *pItem;
1608b6dad520Sdrh   const struct ExprList_item *pOldItem;
1609ff78bd2fSdrh   int i;
1610e46292a9Sdrh   Expr *pPriorSelectColOld = 0;
1611e46292a9Sdrh   Expr *pPriorSelectColNew = 0;
1612575fad65Sdrh   assert( db!=0 );
1613ff78bd2fSdrh   if( p==0 ) return 0;
161497258194Sdrh   pNew = sqlite3DbMallocRawNN(db, sqlite3DbMallocSize(db, p));
1615ff78bd2fSdrh   if( pNew==0 ) return 0;
1616a19543feSdrh   pNew->nExpr = p->nExpr;
161750e43c50Sdrh   pNew->nAlloc = p->nAlloc;
161843606175Sdrh   pItem = pNew->a;
1619145716b3Sdrh   pOldItem = p->a;
1620145716b3Sdrh   for(i=0; i<p->nExpr; i++, pItem++, pOldItem++){
16216ab3a2ecSdanielk1977     Expr *pOldExpr = pOldItem->pExpr;
162247073f62Sdrh     Expr *pNewExpr;
1623b5526ea6Sdrh     pItem->pExpr = sqlite3ExprDup(db, pOldExpr, flags);
162447073f62Sdrh     if( pOldExpr
162547073f62Sdrh      && pOldExpr->op==TK_SELECT_COLUMN
162647073f62Sdrh      && (pNewExpr = pItem->pExpr)!=0
162747073f62Sdrh     ){
1628e46292a9Sdrh       if( pNewExpr->pRight ){
1629e46292a9Sdrh         pPriorSelectColOld = pOldExpr->pRight;
1630e46292a9Sdrh         pPriorSelectColNew = pNewExpr->pRight;
1631e46292a9Sdrh         pNewExpr->pLeft = pNewExpr->pRight;
1632b163748eSdrh       }else{
1633e46292a9Sdrh         if( pOldExpr->pLeft!=pPriorSelectColOld ){
1634e46292a9Sdrh           pPriorSelectColOld = pOldExpr->pLeft;
1635e46292a9Sdrh           pPriorSelectColNew = sqlite3ExprDup(db, pPriorSelectColOld, flags);
1636e46292a9Sdrh           pNewExpr->pRight = pPriorSelectColNew;
1637e46292a9Sdrh         }
1638e46292a9Sdrh         pNewExpr->pLeft = pPriorSelectColNew;
163947073f62Sdrh       }
164047073f62Sdrh     }
164141cee668Sdrh     pItem->zEName = sqlite3DbStrDup(db, pOldItem->zEName);
1642d88fd539Sdrh     pItem->fg = pOldItem->fg;
1643d88fd539Sdrh     pItem->fg.done = 0;
1644c2acc4e4Sdrh     pItem->u = pOldItem->u;
1645ff78bd2fSdrh   }
1646ff78bd2fSdrh   return pNew;
1647ff78bd2fSdrh }
164893758c8dSdanielk1977 
164993758c8dSdanielk1977 /*
165093758c8dSdanielk1977 ** If cursors, triggers, views and subqueries are all omitted from
165193758c8dSdanielk1977 ** the build, then none of the following routines, except for
165293758c8dSdanielk1977 ** sqlite3SelectDup(), can be called. sqlite3SelectDup() is sometimes
165393758c8dSdanielk1977 ** called with a NULL argument.
165493758c8dSdanielk1977 */
16556a67fe8eSdanielk1977 #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_TRIGGER) \
16566a67fe8eSdanielk1977  || !defined(SQLITE_OMIT_SUBQUERY)
1657b6dad520Sdrh SrcList *sqlite3SrcListDup(sqlite3 *db, const SrcList *p, int flags){
1658ad3cab52Sdrh   SrcList *pNew;
1659ad3cab52Sdrh   int i;
1660113088ecSdrh   int nByte;
1661575fad65Sdrh   assert( db!=0 );
1662ad3cab52Sdrh   if( p==0 ) return 0;
1663113088ecSdrh   nByte = sizeof(*p) + (p->nSrc>0 ? sizeof(p->a[0]) * (p->nSrc-1) : 0);
1664575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, nByte );
1665ad3cab52Sdrh   if( pNew==0 ) return 0;
16664305d103Sdrh   pNew->nSrc = pNew->nAlloc = p->nSrc;
1667ad3cab52Sdrh   for(i=0; i<p->nSrc; i++){
16687601294aSdrh     SrcItem *pNewItem = &pNew->a[i];
1669b6dad520Sdrh     const SrcItem *pOldItem = &p->a[i];
1670ed8a3bb1Sdrh     Table *pTab;
167141fb5cd1Sdan     pNewItem->pSchema = pOldItem->pSchema;
167217435752Sdrh     pNewItem->zDatabase = sqlite3DbStrDup(db, pOldItem->zDatabase);
167317435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
167417435752Sdrh     pNewItem->zAlias = sqlite3DbStrDup(db, pOldItem->zAlias);
16758a48b9c0Sdrh     pNewItem->fg = pOldItem->fg;
16764efc4754Sdrh     pNewItem->iCursor = pOldItem->iCursor;
16775b6a9ed4Sdrh     pNewItem->addrFillSub = pOldItem->addrFillSub;
16785b6a9ed4Sdrh     pNewItem->regReturn = pOldItem->regReturn;
16798a48b9c0Sdrh     if( pNewItem->fg.isIndexedBy ){
16808a48b9c0Sdrh       pNewItem->u1.zIndexedBy = sqlite3DbStrDup(db, pOldItem->u1.zIndexedBy);
16818a48b9c0Sdrh     }
1682a79e2a2dSdrh     pNewItem->u2 = pOldItem->u2;
1683a79e2a2dSdrh     if( pNewItem->fg.isCte ){
1684a79e2a2dSdrh       pNewItem->u2.pCteUse->nUse++;
1685a79e2a2dSdrh     }
16868a48b9c0Sdrh     if( pNewItem->fg.isTabFunc ){
16878a48b9c0Sdrh       pNewItem->u1.pFuncArg =
16888a48b9c0Sdrh           sqlite3ExprListDup(db, pOldItem->u1.pFuncArg, flags);
16898a48b9c0Sdrh     }
1690ed8a3bb1Sdrh     pTab = pNewItem->pTab = pOldItem->pTab;
1691ed8a3bb1Sdrh     if( pTab ){
169279df7782Sdrh       pTab->nTabRef++;
1693a1cb183dSdanielk1977     }
16946ab3a2ecSdanielk1977     pNewItem->pSelect = sqlite3SelectDup(db, pOldItem->pSelect, flags);
1695d44f8b23Sdrh     if( pOldItem->fg.isUsing ){
1696d44f8b23Sdrh       assert( pNewItem->fg.isUsing );
1697d44f8b23Sdrh       pNewItem->u3.pUsing = sqlite3IdListDup(db, pOldItem->u3.pUsing);
1698d44f8b23Sdrh     }else{
1699d44f8b23Sdrh       pNewItem->u3.pOn = sqlite3ExprDup(db, pOldItem->u3.pOn, flags);
1700d44f8b23Sdrh     }
17016c18b6e0Sdanielk1977     pNewItem->colUsed = pOldItem->colUsed;
1702ad3cab52Sdrh   }
1703ad3cab52Sdrh   return pNew;
1704ad3cab52Sdrh }
1705b6dad520Sdrh IdList *sqlite3IdListDup(sqlite3 *db, const IdList *p){
1706ff78bd2fSdrh   IdList *pNew;
1707ff78bd2fSdrh   int i;
1708575fad65Sdrh   assert( db!=0 );
1709ff78bd2fSdrh   if( p==0 ) return 0;
1710a99e3254Sdrh   assert( p->eU4!=EU4_EXPR );
1711a99e3254Sdrh   pNew = sqlite3DbMallocRawNN(db, sizeof(*pNew)+(p->nId-1)*sizeof(p->a[0]) );
1712ff78bd2fSdrh   if( pNew==0 ) return 0;
17136c535158Sdrh   pNew->nId = p->nId;
1714a99e3254Sdrh   pNew->eU4 = p->eU4;
1715ff78bd2fSdrh   for(i=0; i<p->nId; i++){
17164efc4754Sdrh     struct IdList_item *pNewItem = &pNew->a[i];
1717a99e3254Sdrh     const struct IdList_item *pOldItem = &p->a[i];
171817435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
1719a99e3254Sdrh     pNewItem->u4 = pOldItem->u4;
1720ff78bd2fSdrh   }
1721ff78bd2fSdrh   return pNew;
1722ff78bd2fSdrh }
1723b6dad520Sdrh Select *sqlite3SelectDup(sqlite3 *db, const Select *pDup, int flags){
1724a7466205Sdan   Select *pRet = 0;
1725a7466205Sdan   Select *pNext = 0;
1726a7466205Sdan   Select **pp = &pRet;
1727b6dad520Sdrh   const Select *p;
1728a7466205Sdan 
1729575fad65Sdrh   assert( db!=0 );
1730a7466205Sdan   for(p=pDup; p; p=p->pPrior){
1731a7466205Sdan     Select *pNew = sqlite3DbMallocRawNN(db, sizeof(*p) );
1732a7466205Sdan     if( pNew==0 ) break;
1733b7916a78Sdrh     pNew->pEList = sqlite3ExprListDup(db, p->pEList, flags);
17346ab3a2ecSdanielk1977     pNew->pSrc = sqlite3SrcListDup(db, p->pSrc, flags);
17356ab3a2ecSdanielk1977     pNew->pWhere = sqlite3ExprDup(db, p->pWhere, flags);
17366ab3a2ecSdanielk1977     pNew->pGroupBy = sqlite3ExprListDup(db, p->pGroupBy, flags);
17376ab3a2ecSdanielk1977     pNew->pHaving = sqlite3ExprDup(db, p->pHaving, flags);
17386ab3a2ecSdanielk1977     pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, flags);
1739ff78bd2fSdrh     pNew->op = p->op;
1740a7466205Sdan     pNew->pNext = pNext;
1741a7466205Sdan     pNew->pPrior = 0;
17426ab3a2ecSdanielk1977     pNew->pLimit = sqlite3ExprDup(db, p->pLimit, flags);
174392b01d53Sdrh     pNew->iLimit = 0;
174492b01d53Sdrh     pNew->iOffset = 0;
17457d10d5a6Sdrh     pNew->selFlags = p->selFlags & ~SF_UsesEphemeral;
1746b9bb7c18Sdrh     pNew->addrOpenEphm[0] = -1;
1747b9bb7c18Sdrh     pNew->addrOpenEphm[1] = -1;
1748ec2da854Sdrh     pNew->nSelectRow = p->nSelectRow;
174926d61e5aSdan     pNew->pWith = sqlite3WithDup(db, p->pWith);
175067a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
17512e362f97Sdan     pNew->pWin = 0;
1752c95f38d4Sdan     pNew->pWinDefn = sqlite3WindowListDup(db, p->pWinDefn);
17534780b9adSdan     if( p->pWin && db->mallocFailed==0 ) gatherSelectWindows(pNew);
175467a9b8edSdan #endif
1755fef37760Sdrh     pNew->selId = p->selId;
17569da977f1Sdrh     if( db->mallocFailed ){
17579da977f1Sdrh       /* Any prior OOM might have left the Select object incomplete.
17589da977f1Sdrh       ** Delete the whole thing rather than allow an incomplete Select
17599da977f1Sdrh       ** to be used by the code generator. */
17609da977f1Sdrh       pNew->pNext = 0;
17619da977f1Sdrh       sqlite3SelectDelete(db, pNew);
17629da977f1Sdrh       break;
17639da977f1Sdrh     }
1764a7466205Sdan     *pp = pNew;
1765a7466205Sdan     pp = &pNew->pPrior;
1766a7466205Sdan     pNext = pNew;
1767a7466205Sdan   }
1768a7466205Sdan 
1769a7466205Sdan   return pRet;
1770ff78bd2fSdrh }
177193758c8dSdanielk1977 #else
1772f76d2877Sdrh Select *sqlite3SelectDup(sqlite3 *db, const Select *p, int flags){
177393758c8dSdanielk1977   assert( p==0 );
177493758c8dSdanielk1977   return 0;
177593758c8dSdanielk1977 }
177693758c8dSdanielk1977 #endif
1777ff78bd2fSdrh 
1778ff78bd2fSdrh 
1779ff78bd2fSdrh /*
1780a76b5dfcSdrh ** Add a new element to the end of an expression list.  If pList is
1781a76b5dfcSdrh ** initially NULL, then create a new expression list.
1782b7916a78Sdrh **
1783a19543feSdrh ** The pList argument must be either NULL or a pointer to an ExprList
1784a19543feSdrh ** obtained from a prior call to sqlite3ExprListAppend().  This routine
1785a19543feSdrh ** may not be used with an ExprList obtained from sqlite3ExprListDup().
1786a19543feSdrh ** Reason:  This routine assumes that the number of slots in pList->a[]
1787a19543feSdrh ** is a power of two.  That is true for sqlite3ExprListAppend() returns
1788a19543feSdrh ** but is not necessarily true from the return value of sqlite3ExprListDup().
1789a19543feSdrh **
1790b7916a78Sdrh ** If a memory allocation error occurs, the entire list is freed and
1791b7916a78Sdrh ** NULL is returned.  If non-NULL is returned, then it is guaranteed
1792b7916a78Sdrh ** that the new entry was successfully appended.
1793a76b5dfcSdrh */
1794dabada60Slarrybr static const struct ExprList_item zeroItem = {0};
179550e43c50Sdrh SQLITE_NOINLINE ExprList *sqlite3ExprListAppendNew(
179650e43c50Sdrh   sqlite3 *db,            /* Database handle.  Used for memory allocation */
179750e43c50Sdrh   Expr *pExpr             /* Expression to be appended. Might be NULL */
179850e43c50Sdrh ){
179950e43c50Sdrh   struct ExprList_item *pItem;
180050e43c50Sdrh   ExprList *pList;
180150e43c50Sdrh 
180250e43c50Sdrh   pList = sqlite3DbMallocRawNN(db, sizeof(ExprList)+sizeof(pList->a[0])*4 );
180350e43c50Sdrh   if( pList==0 ){
180450e43c50Sdrh     sqlite3ExprDelete(db, pExpr);
180550e43c50Sdrh     return 0;
180650e43c50Sdrh   }
180750e43c50Sdrh   pList->nAlloc = 4;
180850e43c50Sdrh   pList->nExpr = 1;
180950e43c50Sdrh   pItem = &pList->a[0];
181050e43c50Sdrh   *pItem = zeroItem;
181150e43c50Sdrh   pItem->pExpr = pExpr;
181250e43c50Sdrh   return pList;
181350e43c50Sdrh }
181450e43c50Sdrh SQLITE_NOINLINE ExprList *sqlite3ExprListAppendGrow(
181550e43c50Sdrh   sqlite3 *db,            /* Database handle.  Used for memory allocation */
181650e43c50Sdrh   ExprList *pList,        /* List to which to append. Might be NULL */
181750e43c50Sdrh   Expr *pExpr             /* Expression to be appended. Might be NULL */
181850e43c50Sdrh ){
181950e43c50Sdrh   struct ExprList_item *pItem;
182050e43c50Sdrh   ExprList *pNew;
182150e43c50Sdrh   pList->nAlloc *= 2;
182250e43c50Sdrh   pNew = sqlite3DbRealloc(db, pList,
182350e43c50Sdrh        sizeof(*pList)+(pList->nAlloc-1)*sizeof(pList->a[0]));
182450e43c50Sdrh   if( pNew==0 ){
182550e43c50Sdrh     sqlite3ExprListDelete(db, pList);
182650e43c50Sdrh     sqlite3ExprDelete(db, pExpr);
182750e43c50Sdrh     return 0;
182850e43c50Sdrh   }else{
182950e43c50Sdrh     pList = pNew;
183050e43c50Sdrh   }
183150e43c50Sdrh   pItem = &pList->a[pList->nExpr++];
183250e43c50Sdrh   *pItem = zeroItem;
183350e43c50Sdrh   pItem->pExpr = pExpr;
183450e43c50Sdrh   return pList;
183550e43c50Sdrh }
183617435752Sdrh ExprList *sqlite3ExprListAppend(
183717435752Sdrh   Parse *pParse,          /* Parsing context */
183817435752Sdrh   ExprList *pList,        /* List to which to append. Might be NULL */
1839b7916a78Sdrh   Expr *pExpr             /* Expression to be appended. Might be NULL */
184017435752Sdrh ){
184143606175Sdrh   struct ExprList_item *pItem;
1842a76b5dfcSdrh   if( pList==0 ){
184350e43c50Sdrh     return sqlite3ExprListAppendNew(pParse->db,pExpr);
1844a76b5dfcSdrh   }
184550e43c50Sdrh   if( pList->nAlloc<pList->nExpr+1 ){
184650e43c50Sdrh     return sqlite3ExprListAppendGrow(pParse->db,pList,pExpr);
1847a76b5dfcSdrh   }
184843606175Sdrh   pItem = &pList->a[pList->nExpr++];
184950e43c50Sdrh   *pItem = zeroItem;
1850e94ddc9eSdanielk1977   pItem->pExpr = pExpr;
1851a76b5dfcSdrh   return pList;
1852a76b5dfcSdrh }
1853a76b5dfcSdrh 
1854a76b5dfcSdrh /*
18558762ec19Sdrh ** pColumns and pExpr form a vector assignment which is part of the SET
18568762ec19Sdrh ** clause of an UPDATE statement.  Like this:
1857a1251bc4Sdrh **
1858a1251bc4Sdrh **        (a,b,c) = (expr1,expr2,expr3)
1859a1251bc4Sdrh ** Or:    (a,b,c) = (SELECT x,y,z FROM ....)
1860a1251bc4Sdrh **
1861a1251bc4Sdrh ** For each term of the vector assignment, append new entries to the
1862b67343d0Sdrh ** expression list pList.  In the case of a subquery on the RHS, append
1863a1251bc4Sdrh ** TK_SELECT_COLUMN expressions.
1864a1251bc4Sdrh */
1865a1251bc4Sdrh ExprList *sqlite3ExprListAppendVector(
1866a1251bc4Sdrh   Parse *pParse,         /* Parsing context */
1867a1251bc4Sdrh   ExprList *pList,       /* List to which to append. Might be NULL */
1868a1251bc4Sdrh   IdList *pColumns,      /* List of names of LHS of the assignment */
1869a1251bc4Sdrh   Expr *pExpr            /* Vector expression to be appended. Might be NULL */
1870a1251bc4Sdrh ){
1871a1251bc4Sdrh   sqlite3 *db = pParse->db;
1872a1251bc4Sdrh   int n;
1873a1251bc4Sdrh   int i;
187466860af3Sdrh   int iFirst = pList ? pList->nExpr : 0;
1875321e828dSdrh   /* pColumns can only be NULL due to an OOM but an OOM will cause an
1876321e828dSdrh   ** exit prior to this routine being invoked */
1877321e828dSdrh   if( NEVER(pColumns==0) ) goto vector_append_error;
1878a1251bc4Sdrh   if( pExpr==0 ) goto vector_append_error;
1879966e2911Sdrh 
1880966e2911Sdrh   /* If the RHS is a vector, then we can immediately check to see that
1881966e2911Sdrh   ** the size of the RHS and LHS match.  But if the RHS is a SELECT,
1882966e2911Sdrh   ** wildcards ("*") in the result set of the SELECT must be expanded before
1883966e2911Sdrh   ** we can do the size check, so defer the size check until code generation.
1884966e2911Sdrh   */
1885966e2911Sdrh   if( pExpr->op!=TK_SELECT && pColumns->nId!=(n=sqlite3ExprVectorSize(pExpr)) ){
1886a1251bc4Sdrh     sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
1887a1251bc4Sdrh                     pColumns->nId, n);
1888a1251bc4Sdrh     goto vector_append_error;
1889a1251bc4Sdrh   }
1890966e2911Sdrh 
1891966e2911Sdrh   for(i=0; i<pColumns->nId; i++){
189210f08270Sdrh     Expr *pSubExpr = sqlite3ExprForVectorField(pParse, pExpr, i, pColumns->nId);
1893554a9dc7Sdrh     assert( pSubExpr!=0 || db->mallocFailed );
1894554a9dc7Sdrh     if( pSubExpr==0 ) continue;
1895a1251bc4Sdrh     pList = sqlite3ExprListAppend(pParse, pList, pSubExpr);
1896a1251bc4Sdrh     if( pList ){
189766860af3Sdrh       assert( pList->nExpr==iFirst+i+1 );
189841cee668Sdrh       pList->a[pList->nExpr-1].zEName = pColumns->a[i].zName;
1899a1251bc4Sdrh       pColumns->a[i].zName = 0;
1900a1251bc4Sdrh     }
1901a1251bc4Sdrh   }
1902966e2911Sdrh 
1903ffe28059Sdrh   if( !db->mallocFailed && pExpr->op==TK_SELECT && ALWAYS(pList!=0) ){
1904966e2911Sdrh     Expr *pFirst = pList->a[iFirst].pExpr;
1905f4dd26c5Sdrh     assert( pFirst!=0 );
1906966e2911Sdrh     assert( pFirst->op==TK_SELECT_COLUMN );
1907966e2911Sdrh 
1908966e2911Sdrh     /* Store the SELECT statement in pRight so it will be deleted when
1909966e2911Sdrh     ** sqlite3ExprListDelete() is called */
1910966e2911Sdrh     pFirst->pRight = pExpr;
1911a1251bc4Sdrh     pExpr = 0;
1912966e2911Sdrh 
1913966e2911Sdrh     /* Remember the size of the LHS in iTable so that we can check that
1914966e2911Sdrh     ** the RHS and LHS sizes match during code generation. */
1915966e2911Sdrh     pFirst->iTable = pColumns->nId;
1916a1251bc4Sdrh   }
1917a1251bc4Sdrh 
1918a1251bc4Sdrh vector_append_error:
19198e34e406Sdrh   sqlite3ExprUnmapAndDelete(pParse, pExpr);
1920a1251bc4Sdrh   sqlite3IdListDelete(db, pColumns);
1921a1251bc4Sdrh   return pList;
1922a1251bc4Sdrh }
1923a1251bc4Sdrh 
1924a1251bc4Sdrh /*
1925bc622bc0Sdrh ** Set the sort order for the last element on the given ExprList.
1926bc622bc0Sdrh */
19276e11892dSdan void sqlite3ExprListSetSortOrder(ExprList *p, int iSortOrder, int eNulls){
19289105fd51Sdan   struct ExprList_item *pItem;
1929bc622bc0Sdrh   if( p==0 ) return;
1930bc622bc0Sdrh   assert( p->nExpr>0 );
19316e11892dSdan 
19326e11892dSdan   assert( SQLITE_SO_UNDEFINED<0 && SQLITE_SO_ASC==0 && SQLITE_SO_DESC>0 );
19336e11892dSdan   assert( iSortOrder==SQLITE_SO_UNDEFINED
19346e11892dSdan        || iSortOrder==SQLITE_SO_ASC
19356e11892dSdan        || iSortOrder==SQLITE_SO_DESC
19366e11892dSdan   );
19376e11892dSdan   assert( eNulls==SQLITE_SO_UNDEFINED
19386e11892dSdan        || eNulls==SQLITE_SO_ASC
19396e11892dSdan        || eNulls==SQLITE_SO_DESC
19406e11892dSdan   );
19416e11892dSdan 
19429105fd51Sdan   pItem = &p->a[p->nExpr-1];
1943d88fd539Sdrh   assert( pItem->fg.bNulls==0 );
19449105fd51Sdan   if( iSortOrder==SQLITE_SO_UNDEFINED ){
19459105fd51Sdan     iSortOrder = SQLITE_SO_ASC;
1946bc622bc0Sdrh   }
1947d88fd539Sdrh   pItem->fg.sortFlags = (u8)iSortOrder;
19489105fd51Sdan 
19499105fd51Sdan   if( eNulls!=SQLITE_SO_UNDEFINED ){
1950d88fd539Sdrh     pItem->fg.bNulls = 1;
19519105fd51Sdan     if( iSortOrder!=eNulls ){
1952d88fd539Sdrh       pItem->fg.sortFlags |= KEYINFO_ORDER_BIGNULL;
19539105fd51Sdan     }
1954bc622bc0Sdrh   }
1955bc622bc0Sdrh }
1956bc622bc0Sdrh 
1957bc622bc0Sdrh /*
195841cee668Sdrh ** Set the ExprList.a[].zEName element of the most recently added item
1959b7916a78Sdrh ** on the expression list.
1960b7916a78Sdrh **
1961b7916a78Sdrh ** pList might be NULL following an OOM error.  But pName should never be
1962b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1963b7916a78Sdrh ** is set.
1964b7916a78Sdrh */
1965b7916a78Sdrh void sqlite3ExprListSetName(
1966b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1967b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
1968b6dad520Sdrh   const Token *pName,     /* Name to be added */
1969b7916a78Sdrh   int dequote             /* True to cause the name to be dequoted */
1970b7916a78Sdrh ){
1971b7916a78Sdrh   assert( pList!=0 || pParse->db->mallocFailed!=0 );
19722d99f957Sdrh   assert( pParse->eParseMode!=PARSE_MODE_UNMAP || dequote==0 );
1973b7916a78Sdrh   if( pList ){
1974b7916a78Sdrh     struct ExprList_item *pItem;
1975b7916a78Sdrh     assert( pList->nExpr>0 );
1976b7916a78Sdrh     pItem = &pList->a[pList->nExpr-1];
197741cee668Sdrh     assert( pItem->zEName==0 );
1978d88fd539Sdrh     assert( pItem->fg.eEName==ENAME_NAME );
197941cee668Sdrh     pItem->zEName = sqlite3DbStrNDup(pParse->db, pName->z, pName->n);
198085f2c76cSdan     if( dequote ){
198185f2c76cSdan       /* If dequote==0, then pName->z does not point to part of a DDL
198285f2c76cSdan       ** statement handled by the parser. And so no token need be added
198385f2c76cSdan       ** to the token-map.  */
198485f2c76cSdan       sqlite3Dequote(pItem->zEName);
1985c9461eccSdan       if( IN_RENAME_OBJECT ){
1986b6dad520Sdrh         sqlite3RenameTokenMap(pParse, (const void*)pItem->zEName, pName);
19875be60c55Sdan       }
1988b7916a78Sdrh     }
1989b7916a78Sdrh   }
199085f2c76cSdan }
1991b7916a78Sdrh 
1992b7916a78Sdrh /*
1993b7916a78Sdrh ** Set the ExprList.a[].zSpan element of the most recently added item
1994b7916a78Sdrh ** on the expression list.
1995b7916a78Sdrh **
1996b7916a78Sdrh ** pList might be NULL following an OOM error.  But pSpan should never be
1997b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1998b7916a78Sdrh ** is set.
1999b7916a78Sdrh */
2000b7916a78Sdrh void sqlite3ExprListSetSpan(
2001b7916a78Sdrh   Parse *pParse,          /* Parsing context */
2002b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
20031be266baSdrh   const char *zStart,     /* Start of the span */
20041be266baSdrh   const char *zEnd        /* End of the span */
2005b7916a78Sdrh ){
2006b7916a78Sdrh   sqlite3 *db = pParse->db;
2007b7916a78Sdrh   assert( pList!=0 || db->mallocFailed!=0 );
2008b7916a78Sdrh   if( pList ){
2009b7916a78Sdrh     struct ExprList_item *pItem = &pList->a[pList->nExpr-1];
2010b7916a78Sdrh     assert( pList->nExpr>0 );
2011cbb9da33Sdrh     if( pItem->zEName==0 ){
2012cbb9da33Sdrh       pItem->zEName = sqlite3DbSpanDup(db, zStart, zEnd);
2013d88fd539Sdrh       pItem->fg.eEName = ENAME_SPAN;
2014cbb9da33Sdrh     }
2015b7916a78Sdrh   }
2016b7916a78Sdrh }
2017b7916a78Sdrh 
2018b7916a78Sdrh /*
20197a15a4beSdanielk1977 ** If the expression list pEList contains more than iLimit elements,
20207a15a4beSdanielk1977 ** leave an error message in pParse.
20217a15a4beSdanielk1977 */
20227a15a4beSdanielk1977 void sqlite3ExprListCheckLength(
20237a15a4beSdanielk1977   Parse *pParse,
20247a15a4beSdanielk1977   ExprList *pEList,
20257a15a4beSdanielk1977   const char *zObject
20267a15a4beSdanielk1977 ){
2027b1a6c3c1Sdrh   int mx = pParse->db->aLimit[SQLITE_LIMIT_COLUMN];
2028c5499befSdrh   testcase( pEList && pEList->nExpr==mx );
2029c5499befSdrh   testcase( pEList && pEList->nExpr==mx+1 );
2030b1a6c3c1Sdrh   if( pEList && pEList->nExpr>mx ){
20317a15a4beSdanielk1977     sqlite3ErrorMsg(pParse, "too many columns in %s", zObject);
20327a15a4beSdanielk1977   }
20337a15a4beSdanielk1977 }
20347a15a4beSdanielk1977 
20357a15a4beSdanielk1977 /*
2036a76b5dfcSdrh ** Delete an entire expression list.
2037a76b5dfcSdrh */
2038affa855cSdrh static SQLITE_NOINLINE void exprListDeleteNN(sqlite3 *db, ExprList *pList){
2039ac48b751Sdrh   int i = pList->nExpr;
2040ac48b751Sdrh   struct ExprList_item *pItem =  pList->a;
2041ac48b751Sdrh   assert( pList->nExpr>0 );
204241ce47c4Sdrh   assert( db!=0 );
2043ac48b751Sdrh   do{
2044633e6d57Sdrh     sqlite3ExprDelete(db, pItem->pExpr);
204541ce47c4Sdrh     if( pItem->zEName ) sqlite3DbNNFreeNN(db, pItem->zEName);
2046ac48b751Sdrh     pItem++;
2047ac48b751Sdrh   }while( --i>0 );
204841ce47c4Sdrh   sqlite3DbNNFreeNN(db, pList);
2049a76b5dfcSdrh }
2050affa855cSdrh void sqlite3ExprListDelete(sqlite3 *db, ExprList *pList){
2051affa855cSdrh   if( pList ) exprListDeleteNN(db, pList);
2052affa855cSdrh }
2053a76b5dfcSdrh 
2054a76b5dfcSdrh /*
20552308ed38Sdrh ** Return the bitwise-OR of all Expr.flags fields in the given
20562308ed38Sdrh ** ExprList.
2057885a5b03Sdrh */
20582308ed38Sdrh u32 sqlite3ExprListFlags(const ExprList *pList){
2059885a5b03Sdrh   int i;
20602308ed38Sdrh   u32 m = 0;
2061508e2d00Sdrh   assert( pList!=0 );
2062885a5b03Sdrh   for(i=0; i<pList->nExpr; i++){
2063d0c73053Sdrh      Expr *pExpr = pList->a[i].pExpr;
2064de845c2fSdrh      assert( pExpr!=0 );
2065de845c2fSdrh      m |= pExpr->flags;
2066885a5b03Sdrh   }
20672308ed38Sdrh   return m;
2068885a5b03Sdrh }
2069885a5b03Sdrh 
2070885a5b03Sdrh /*
20717e6f980bSdrh ** This is a SELECT-node callback for the expression walker that
20727e6f980bSdrh ** always "fails".  By "fail" in this case, we mean set
20737e6f980bSdrh ** pWalker->eCode to zero and abort.
20747e6f980bSdrh **
20757e6f980bSdrh ** This callback is used by multiple expression walkers.
20767e6f980bSdrh */
20777e6f980bSdrh int sqlite3SelectWalkFail(Walker *pWalker, Select *NotUsed){
20787e6f980bSdrh   UNUSED_PARAMETER(NotUsed);
20797e6f980bSdrh   pWalker->eCode = 0;
20807e6f980bSdrh   return WRC_Abort;
20817e6f980bSdrh }
20827e6f980bSdrh 
20837e6f980bSdrh /*
20840cbec59cSdrh ** Check the input string to see if it is "true" or "false" (in any case).
20850cbec59cSdrh **
20860cbec59cSdrh **       If the string is....           Return
20870cbec59cSdrh **         "true"                         EP_IsTrue
20880cbec59cSdrh **         "false"                        EP_IsFalse
20890cbec59cSdrh **         anything else                  0
20900cbec59cSdrh */
20910cbec59cSdrh u32 sqlite3IsTrueOrFalse(const char *zIn){
20920cbec59cSdrh   if( sqlite3StrICmp(zIn, "true")==0  ) return EP_IsTrue;
20930cbec59cSdrh   if( sqlite3StrICmp(zIn, "false")==0 ) return EP_IsFalse;
20940cbec59cSdrh   return 0;
20950cbec59cSdrh }
20960cbec59cSdrh 
20970cbec59cSdrh 
20980cbec59cSdrh /*
2099171d16bbSdrh ** If the input expression is an ID with the name "true" or "false"
210096acafbeSdrh ** then convert it into an TK_TRUEFALSE term.  Return non-zero if
210196acafbeSdrh ** the conversion happened, and zero if the expression is unaltered.
2102171d16bbSdrh */
2103171d16bbSdrh int sqlite3ExprIdToTrueFalse(Expr *pExpr){
21040cbec59cSdrh   u32 v;
2105171d16bbSdrh   assert( pExpr->op==TK_ID || pExpr->op==TK_STRING );
2106f9751074Sdrh   if( !ExprHasProperty(pExpr, EP_Quoted|EP_IntValue)
21070cbec59cSdrh    && (v = sqlite3IsTrueOrFalse(pExpr->u.zToken))!=0
2108171d16bbSdrh   ){
2109171d16bbSdrh     pExpr->op = TK_TRUEFALSE;
21100cbec59cSdrh     ExprSetProperty(pExpr, v);
2111171d16bbSdrh     return 1;
2112171d16bbSdrh   }
2113171d16bbSdrh   return 0;
2114171d16bbSdrh }
2115171d16bbSdrh 
211643c4ac8bSdrh /*
211796acafbeSdrh ** The argument must be a TK_TRUEFALSE Expr node.  Return 1 if it is TRUE
211843c4ac8bSdrh ** and 0 if it is FALSE.
211943c4ac8bSdrh */
212096acafbeSdrh int sqlite3ExprTruthValue(const Expr *pExpr){
21216ece353fSdan   pExpr = sqlite3ExprSkipCollate((Expr*)pExpr);
212243c4ac8bSdrh   assert( pExpr->op==TK_TRUEFALSE );
2123f9751074Sdrh   assert( !ExprHasProperty(pExpr, EP_IntValue) );
212443c4ac8bSdrh   assert( sqlite3StrICmp(pExpr->u.zToken,"true")==0
212543c4ac8bSdrh        || sqlite3StrICmp(pExpr->u.zToken,"false")==0 );
212643c4ac8bSdrh   return pExpr->u.zToken[4]==0;
212743c4ac8bSdrh }
212843c4ac8bSdrh 
212917180fcaSdrh /*
213017180fcaSdrh ** If pExpr is an AND or OR expression, try to simplify it by eliminating
213117180fcaSdrh ** terms that are always true or false.  Return the simplified expression.
213217180fcaSdrh ** Or return the original expression if no simplification is possible.
213317180fcaSdrh **
213417180fcaSdrh ** Examples:
213517180fcaSdrh **
213617180fcaSdrh **     (x<10) AND true                =>   (x<10)
213717180fcaSdrh **     (x<10) AND false               =>   false
213817180fcaSdrh **     (x<10) AND (y=22 OR false)     =>   (x<10) AND (y=22)
213917180fcaSdrh **     (x<10) AND (y=22 OR true)      =>   (x<10)
214017180fcaSdrh **     (y=22) OR true                 =>   true
214117180fcaSdrh */
214217180fcaSdrh Expr *sqlite3ExprSimplifiedAndOr(Expr *pExpr){
214317180fcaSdrh   assert( pExpr!=0 );
214417180fcaSdrh   if( pExpr->op==TK_AND || pExpr->op==TK_OR ){
214517180fcaSdrh     Expr *pRight = sqlite3ExprSimplifiedAndOr(pExpr->pRight);
214617180fcaSdrh     Expr *pLeft = sqlite3ExprSimplifiedAndOr(pExpr->pLeft);
214717180fcaSdrh     if( ExprAlwaysTrue(pLeft) || ExprAlwaysFalse(pRight) ){
214817180fcaSdrh       pExpr = pExpr->op==TK_AND ? pRight : pLeft;
214917180fcaSdrh     }else if( ExprAlwaysTrue(pRight) || ExprAlwaysFalse(pLeft) ){
215017180fcaSdrh       pExpr = pExpr->op==TK_AND ? pLeft : pRight;
215117180fcaSdrh     }
215217180fcaSdrh   }
215317180fcaSdrh   return pExpr;
215417180fcaSdrh }
215517180fcaSdrh 
2156171d16bbSdrh 
2157171d16bbSdrh /*
2158059b2d50Sdrh ** These routines are Walker callbacks used to check expressions to
2159059b2d50Sdrh ** see if they are "constant" for some definition of constant.  The
2160059b2d50Sdrh ** Walker.eCode value determines the type of "constant" we are looking
2161059b2d50Sdrh ** for.
216273b211abSdrh **
21637d10d5a6Sdrh ** These callback routines are used to implement the following:
2164626a879aSdrh **
2165059b2d50Sdrh **     sqlite3ExprIsConstant()                  pWalker->eCode==1
2166059b2d50Sdrh **     sqlite3ExprIsConstantNotJoin()           pWalker->eCode==2
2167fcb9f4f3Sdrh **     sqlite3ExprIsTableConstant()             pWalker->eCode==3
2168059b2d50Sdrh **     sqlite3ExprIsConstantOrFunction()        pWalker->eCode==4 or 5
216987abf5c0Sdrh **
2170059b2d50Sdrh ** In all cases, the callbacks set Walker.eCode=0 and abort if the expression
2171059b2d50Sdrh ** is found to not be a constant.
217287abf5c0Sdrh **
2173014fff20Sdrh ** The sqlite3ExprIsConstantOrFunction() is used for evaluating DEFAULT
2174014fff20Sdrh ** expressions in a CREATE TABLE statement.  The Walker.eCode value is 5
21751e32bed3Sdrh ** when parsing an existing schema out of the sqlite_schema table and 4
2176014fff20Sdrh ** when processing a new CREATE TABLE statement.  A bound parameter raises
2177014fff20Sdrh ** an error for new statements, but is silently converted
21781e32bed3Sdrh ** to NULL for existing schemas.  This allows sqlite_schema tables that
2179feada2dfSdrh ** contain a bound parameter because they were generated by older versions
2180feada2dfSdrh ** of SQLite to be parsed by newer versions of SQLite without raising a
2181feada2dfSdrh ** malformed schema error.
2182626a879aSdrh */
21837d10d5a6Sdrh static int exprNodeIsConstant(Walker *pWalker, Expr *pExpr){
2184626a879aSdrh 
2185059b2d50Sdrh   /* If pWalker->eCode is 2 then any term of the expression that comes from
2186b77c07a7Sdrh   ** the ON or USING clauses of an outer join disqualifies the expression
21870a168377Sdrh   ** from being considered constant. */
218867a99dbeSdrh   if( pWalker->eCode==2 && ExprHasProperty(pExpr, EP_OuterON) ){
2189059b2d50Sdrh     pWalker->eCode = 0;
21907d10d5a6Sdrh     return WRC_Abort;
21910a168377Sdrh   }
21920a168377Sdrh 
2193626a879aSdrh   switch( pExpr->op ){
2194eb55bd2fSdrh     /* Consider functions to be constant if all their arguments are constant
2195059b2d50Sdrh     ** and either pWalker->eCode==4 or 5 or the function has the
2196059b2d50Sdrh     ** SQLITE_FUNC_CONST flag. */
2197eb55bd2fSdrh     case TK_FUNCTION:
2198a634c9e6Sdrh       if( (pWalker->eCode>=4 || ExprHasProperty(pExpr,EP_ConstFunc))
2199a634c9e6Sdrh        && !ExprHasProperty(pExpr, EP_WinFunc)
2200a634c9e6Sdrh       ){
2201014fff20Sdrh         if( pWalker->eCode==5 ) ExprSetProperty(pExpr, EP_FromDDL);
2202b1fba286Sdrh         return WRC_Continue;
2203059b2d50Sdrh       }else{
2204059b2d50Sdrh         pWalker->eCode = 0;
2205059b2d50Sdrh         return WRC_Abort;
2206b1fba286Sdrh       }
2207626a879aSdrh     case TK_ID:
2208171d16bbSdrh       /* Convert "true" or "false" in a DEFAULT clause into the
2209171d16bbSdrh       ** appropriate TK_TRUEFALSE operator */
2210e39ef31cSdrh       if( sqlite3ExprIdToTrueFalse(pExpr) ){
2211171d16bbSdrh         return WRC_Prune;
2212171d16bbSdrh       }
221308b92086Sdrh       /* no break */ deliberate_fall_through
2214626a879aSdrh     case TK_COLUMN:
2215626a879aSdrh     case TK_AGG_FUNCTION:
221613449892Sdrh     case TK_AGG_COLUMN:
2217c5499befSdrh       testcase( pExpr->op==TK_ID );
2218c5499befSdrh       testcase( pExpr->op==TK_COLUMN );
2219c5499befSdrh       testcase( pExpr->op==TK_AGG_FUNCTION );
2220c5499befSdrh       testcase( pExpr->op==TK_AGG_COLUMN );
222107aded63Sdrh       if( ExprHasProperty(pExpr, EP_FixedCol) && pWalker->eCode!=2 ){
2222efad2e23Sdrh         return WRC_Continue;
2223efad2e23Sdrh       }
2224059b2d50Sdrh       if( pWalker->eCode==3 && pExpr->iTable==pWalker->u.iCur ){
2225059b2d50Sdrh         return WRC_Continue;
2226f43ce0b4Sdrh       }
222708b92086Sdrh       /* no break */ deliberate_fall_through
2228f43ce0b4Sdrh     case TK_IF_NULL_ROW:
22296e341b93Sdrh     case TK_REGISTER:
223074e0d966Sdrh     case TK_DOT:
22319916048bSdrh       testcase( pExpr->op==TK_REGISTER );
2232f43ce0b4Sdrh       testcase( pExpr->op==TK_IF_NULL_ROW );
223374e0d966Sdrh       testcase( pExpr->op==TK_DOT );
2234059b2d50Sdrh       pWalker->eCode = 0;
22357d10d5a6Sdrh       return WRC_Abort;
2236feada2dfSdrh     case TK_VARIABLE:
2237059b2d50Sdrh       if( pWalker->eCode==5 ){
2238feada2dfSdrh         /* Silently convert bound parameters that appear inside of CREATE
2239feada2dfSdrh         ** statements into a NULL when parsing the CREATE statement text out
22401e32bed3Sdrh         ** of the sqlite_schema table */
2241feada2dfSdrh         pExpr->op = TK_NULL;
2242059b2d50Sdrh       }else if( pWalker->eCode==4 ){
2243feada2dfSdrh         /* A bound parameter in a CREATE statement that originates from
2244feada2dfSdrh         ** sqlite3_prepare() causes an error */
2245059b2d50Sdrh         pWalker->eCode = 0;
2246feada2dfSdrh         return WRC_Abort;
2247feada2dfSdrh       }
224808b92086Sdrh       /* no break */ deliberate_fall_through
2249626a879aSdrh     default:
22506e341b93Sdrh       testcase( pExpr->op==TK_SELECT ); /* sqlite3SelectWalkFail() disallows */
22516e341b93Sdrh       testcase( pExpr->op==TK_EXISTS ); /* sqlite3SelectWalkFail() disallows */
22527d10d5a6Sdrh       return WRC_Continue;
2253626a879aSdrh   }
2254626a879aSdrh }
2255059b2d50Sdrh static int exprIsConst(Expr *p, int initFlag, int iCur){
22567d10d5a6Sdrh   Walker w;
2257059b2d50Sdrh   w.eCode = initFlag;
22587d10d5a6Sdrh   w.xExprCallback = exprNodeIsConstant;
22597e6f980bSdrh   w.xSelectCallback = sqlite3SelectWalkFail;
2260979dd1beSdrh #ifdef SQLITE_DEBUG
2261979dd1beSdrh   w.xSelectCallback2 = sqlite3SelectWalkAssert2;
2262979dd1beSdrh #endif
2263059b2d50Sdrh   w.u.iCur = iCur;
22647d10d5a6Sdrh   sqlite3WalkExpr(&w, p);
2265059b2d50Sdrh   return w.eCode;
22667d10d5a6Sdrh }
2267626a879aSdrh 
2268626a879aSdrh /*
2269059b2d50Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
2270eb55bd2fSdrh ** and 0 if it involves variables or function calls.
22712398937bSdrh **
22722398937bSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
22732398937bSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
22742398937bSdrh ** a constant.
2275fef5208cSdrh */
22764adee20fSdanielk1977 int sqlite3ExprIsConstant(Expr *p){
2277059b2d50Sdrh   return exprIsConst(p, 1, 0);
2278fef5208cSdrh }
2279fef5208cSdrh 
2280fef5208cSdrh /*
228107aded63Sdrh ** Walk an expression tree.  Return non-zero if
228207aded63Sdrh **
228307aded63Sdrh **   (1) the expression is constant, and
228407aded63Sdrh **   (2) the expression does originate in the ON or USING clause
228507aded63Sdrh **       of a LEFT JOIN, and
228607aded63Sdrh **   (3) the expression does not contain any EP_FixedCol TK_COLUMN
228707aded63Sdrh **       operands created by the constant propagation optimization.
228807aded63Sdrh **
228907aded63Sdrh ** When this routine returns true, it indicates that the expression
229007aded63Sdrh ** can be added to the pParse->pConstExpr list and evaluated once when
22919b258c54Sdrh ** the prepared statement starts up.  See sqlite3ExprCodeRunJustOnce().
22920a168377Sdrh */
22930a168377Sdrh int sqlite3ExprIsConstantNotJoin(Expr *p){
2294059b2d50Sdrh   return exprIsConst(p, 2, 0);
22950a168377Sdrh }
22960a168377Sdrh 
22970a168377Sdrh /*
2298fcb9f4f3Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
2299059b2d50Sdrh ** for any single row of the table with cursor iCur.  In other words, the
2300059b2d50Sdrh ** expression must not refer to any non-deterministic function nor any
2301059b2d50Sdrh ** table other than iCur.
2302059b2d50Sdrh */
2303059b2d50Sdrh int sqlite3ExprIsTableConstant(Expr *p, int iCur){
2304059b2d50Sdrh   return exprIsConst(p, 3, iCur);
2305059b2d50Sdrh }
2306059b2d50Sdrh 
2307a9cdb904Sdrh /*
2308a9cdb904Sdrh ** Check pExpr to see if it is an invariant constraint on data source pSrc.
2309a9cdb904Sdrh ** This is an optimization.  False negatives will perhaps cause slower
2310a9cdb904Sdrh ** queries, but false positives will yield incorrect answers.  So when in
231122b541b5Sdrh ** doubt, return 0.
2312a9cdb904Sdrh **
2313a9cdb904Sdrh ** To be an invariant constraint, the following must be true:
2314a9cdb904Sdrh **
2315a9cdb904Sdrh **   (1)  pExpr cannot refer to any table other than pSrc->iCursor.
2316a9cdb904Sdrh **
2317a9cdb904Sdrh **   (2)  pExpr cannot use subqueries or non-deterministic functions.
2318a9cdb904Sdrh **
2319a9cdb904Sdrh **   (3)  pSrc cannot be part of the left operand for a RIGHT JOIN.
2320a9cdb904Sdrh **        (Is there some way to relax this constraint?)
2321a9cdb904Sdrh **
2322a9cdb904Sdrh **   (4)  If pSrc is the right operand of a LEFT JOIN, then...
2323a9cdb904Sdrh **         (4a)  pExpr must come from an ON clause..
2324a9cdb904Sdrh            (4b)  and specifically the ON clause associated with the LEFT JOIN.
2325a9cdb904Sdrh **
2326a9cdb904Sdrh **   (5)  If pSrc is not the right operand of a LEFT JOIN or the left
2327a9cdb904Sdrh **        operand of a RIGHT JOIN, then pExpr must be from the WHERE
2328a9cdb904Sdrh **        clause, not an ON clause.
2329a9cdb904Sdrh */
2330a9cdb904Sdrh int sqlite3ExprIsTableConstraint(Expr *pExpr, const SrcItem *pSrc){
2331a9cdb904Sdrh   if( pSrc->fg.jointype & JT_LTORJ ){
2332a9cdb904Sdrh     return 0;  /* rule (3) */
2333a9cdb904Sdrh   }
2334a9cdb904Sdrh   if( pSrc->fg.jointype & JT_LEFT ){
233567a99dbeSdrh     if( !ExprHasProperty(pExpr, EP_OuterON) ) return 0;   /* rule (4a) */
2336a9cdb904Sdrh     if( pExpr->w.iJoin!=pSrc->iCursor ) return 0;         /* rule (4b) */
2337a9cdb904Sdrh   }else{
233867a99dbeSdrh     if( ExprHasProperty(pExpr, EP_OuterON) ) return 0;    /* rule (5) */
2339a9cdb904Sdrh   }
2340a9cdb904Sdrh   return sqlite3ExprIsTableConstant(pExpr, pSrc->iCursor); /* rules (1), (2) */
2341a9cdb904Sdrh }
2342a9cdb904Sdrh 
2343ab31a845Sdan 
2344ab31a845Sdan /*
2345ab31a845Sdan ** sqlite3WalkExpr() callback used by sqlite3ExprIsConstantOrGroupBy().
2346ab31a845Sdan */
2347ab31a845Sdan static int exprNodeIsConstantOrGroupBy(Walker *pWalker, Expr *pExpr){
2348ab31a845Sdan   ExprList *pGroupBy = pWalker->u.pGroupBy;
2349ab31a845Sdan   int i;
2350ab31a845Sdan 
2351ab31a845Sdan   /* Check if pExpr is identical to any GROUP BY term. If so, consider
2352ab31a845Sdan   ** it constant.  */
2353ab31a845Sdan   for(i=0; i<pGroupBy->nExpr; i++){
2354ab31a845Sdan     Expr *p = pGroupBy->a[i].pExpr;
23555aa550cfSdan     if( sqlite3ExprCompare(0, pExpr, p, -1)<2 ){
235670efa84dSdrh       CollSeq *pColl = sqlite3ExprNNCollSeq(pWalker->pParse, p);
2357efad2e23Sdrh       if( sqlite3IsBinary(pColl) ){
2358ab31a845Sdan         return WRC_Prune;
2359ab31a845Sdan       }
2360ab31a845Sdan     }
2361ab31a845Sdan   }
2362ab31a845Sdan 
2363ab31a845Sdan   /* Check if pExpr is a sub-select. If so, consider it variable. */
2364a4eeccdfSdrh   if( ExprUseXSelect(pExpr) ){
2365ab31a845Sdan     pWalker->eCode = 0;
2366ab31a845Sdan     return WRC_Abort;
2367ab31a845Sdan   }
2368ab31a845Sdan 
2369ab31a845Sdan   return exprNodeIsConstant(pWalker, pExpr);
2370ab31a845Sdan }
2371ab31a845Sdan 
2372ab31a845Sdan /*
2373ab31a845Sdan ** Walk the expression tree passed as the first argument. Return non-zero
2374ab31a845Sdan ** if the expression consists entirely of constants or copies of terms
2375ab31a845Sdan ** in pGroupBy that sort with the BINARY collation sequence.
2376ab314001Sdrh **
2377ab314001Sdrh ** This routine is used to determine if a term of the HAVING clause can
2378ab314001Sdrh ** be promoted into the WHERE clause.  In order for such a promotion to work,
2379ab314001Sdrh ** the value of the HAVING clause term must be the same for all members of
2380ab314001Sdrh ** a "group".  The requirement that the GROUP BY term must be BINARY
2381ab314001Sdrh ** assumes that no other collating sequence will have a finer-grained
2382ab314001Sdrh ** grouping than binary.  In other words (A=B COLLATE binary) implies
2383ab314001Sdrh ** A=B in every other collating sequence.  The requirement that the
2384ab314001Sdrh ** GROUP BY be BINARY is stricter than necessary.  It would also work
2385ab314001Sdrh ** to promote HAVING clauses that use the same alternative collating
2386ab314001Sdrh ** sequence as the GROUP BY term, but that is much harder to check,
2387ab314001Sdrh ** alternative collating sequences are uncommon, and this is only an
2388ab314001Sdrh ** optimization, so we take the easy way out and simply require the
2389ab314001Sdrh ** GROUP BY to use the BINARY collating sequence.
2390ab31a845Sdan */
2391ab31a845Sdan int sqlite3ExprIsConstantOrGroupBy(Parse *pParse, Expr *p, ExprList *pGroupBy){
2392ab31a845Sdan   Walker w;
2393ab31a845Sdan   w.eCode = 1;
2394ab31a845Sdan   w.xExprCallback = exprNodeIsConstantOrGroupBy;
2395979dd1beSdrh   w.xSelectCallback = 0;
2396ab31a845Sdan   w.u.pGroupBy = pGroupBy;
2397ab31a845Sdan   w.pParse = pParse;
2398ab31a845Sdan   sqlite3WalkExpr(&w, p);
2399ab31a845Sdan   return w.eCode;
2400ab31a845Sdan }
2401ab31a845Sdan 
2402059b2d50Sdrh /*
2403014fff20Sdrh ** Walk an expression tree for the DEFAULT field of a column definition
2404014fff20Sdrh ** in a CREATE TABLE statement.  Return non-zero if the expression is
2405014fff20Sdrh ** acceptable for use as a DEFAULT.  That is to say, return non-zero if
2406014fff20Sdrh ** the expression is constant or a function call with constant arguments.
2407014fff20Sdrh ** Return and 0 if there are any variables.
2408014fff20Sdrh **
24091e32bed3Sdrh ** isInit is true when parsing from sqlite_schema.  isInit is false when
2410014fff20Sdrh ** processing a new CREATE TABLE statement.  When isInit is true, parameters
2411014fff20Sdrh ** (such as ? or $abc) in the expression are converted into NULL.  When
2412014fff20Sdrh ** isInit is false, parameters raise an error.  Parameters should not be
2413014fff20Sdrh ** allowed in a CREATE TABLE statement, but some legacy versions of SQLite
24141e32bed3Sdrh ** allowed it, so we need to support it when reading sqlite_schema for
2415014fff20Sdrh ** backwards compatibility.
2416014fff20Sdrh **
2417014fff20Sdrh ** If isInit is true, set EP_FromDDL on every TK_FUNCTION node.
2418eb55bd2fSdrh **
2419eb55bd2fSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
2420eb55bd2fSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
2421eb55bd2fSdrh ** a constant.
2422eb55bd2fSdrh */
2423feada2dfSdrh int sqlite3ExprIsConstantOrFunction(Expr *p, u8 isInit){
2424feada2dfSdrh   assert( isInit==0 || isInit==1 );
2425059b2d50Sdrh   return exprIsConst(p, 4+isInit, 0);
2426eb55bd2fSdrh }
2427eb55bd2fSdrh 
24285b88bc4bSdrh #ifdef SQLITE_ENABLE_CURSOR_HINTS
24295b88bc4bSdrh /*
24305b88bc4bSdrh ** Walk an expression tree.  Return 1 if the expression contains a
24315b88bc4bSdrh ** subquery of some kind.  Return 0 if there are no subqueries.
24325b88bc4bSdrh */
24335b88bc4bSdrh int sqlite3ExprContainsSubquery(Expr *p){
24345b88bc4bSdrh   Walker w;
2435bec2476aSdrh   w.eCode = 1;
24365b88bc4bSdrh   w.xExprCallback = sqlite3ExprWalkNoop;
24377e6f980bSdrh   w.xSelectCallback = sqlite3SelectWalkFail;
2438979dd1beSdrh #ifdef SQLITE_DEBUG
2439979dd1beSdrh   w.xSelectCallback2 = sqlite3SelectWalkAssert2;
2440979dd1beSdrh #endif
24415b88bc4bSdrh   sqlite3WalkExpr(&w, p);
244207194bffSdrh   return w.eCode==0;
24435b88bc4bSdrh }
24445b88bc4bSdrh #endif
24455b88bc4bSdrh 
2446eb55bd2fSdrh /*
244773b211abSdrh ** If the expression p codes a constant integer that is small enough
2448202b2df7Sdrh ** to fit in a 32-bit integer, return 1 and put the value of the integer
2449202b2df7Sdrh ** in *pValue.  If the expression is not an integer or if it is too big
2450202b2df7Sdrh ** to fit in a signed 32-bit integer, return 0 and leave *pValue unchanged.
2451e4de1febSdrh */
2452b6dad520Sdrh int sqlite3ExprIsInteger(const Expr *p, int *pValue){
245392b01d53Sdrh   int rc = 0;
24541d2d71a0Sdrh   if( NEVER(p==0) ) return 0;  /* Used to only happen following on OOM */
2455cd92e84dSdrh 
2456cd92e84dSdrh   /* If an expression is an integer literal that fits in a signed 32-bit
2457cd92e84dSdrh   ** integer, then the EP_IntValue flag will have already been set */
2458cd92e84dSdrh   assert( p->op!=TK_INTEGER || (p->flags & EP_IntValue)!=0
2459cd92e84dSdrh            || sqlite3GetInt32(p->u.zToken, &rc)==0 );
2460cd92e84dSdrh 
246192b01d53Sdrh   if( p->flags & EP_IntValue ){
246233e619fcSdrh     *pValue = p->u.iValue;
2463e4de1febSdrh     return 1;
2464e4de1febSdrh   }
246592b01d53Sdrh   switch( p->op ){
24664b59ab5eSdrh     case TK_UPLUS: {
246792b01d53Sdrh       rc = sqlite3ExprIsInteger(p->pLeft, pValue);
2468f6e369a1Sdrh       break;
24694b59ab5eSdrh     }
2470e4de1febSdrh     case TK_UMINUS: {
2471c59ffa8cSdrh       int v = 0;
24724adee20fSdanielk1977       if( sqlite3ExprIsInteger(p->pLeft, &v) ){
2473c59ffa8cSdrh         assert( ((unsigned int)v)!=0x80000000 );
2474e4de1febSdrh         *pValue = -v;
247592b01d53Sdrh         rc = 1;
2476e4de1febSdrh       }
2477e4de1febSdrh       break;
2478e4de1febSdrh     }
2479e4de1febSdrh     default: break;
2480e4de1febSdrh   }
248192b01d53Sdrh   return rc;
2482e4de1febSdrh }
2483e4de1febSdrh 
2484e4de1febSdrh /*
2485039fc32eSdrh ** Return FALSE if there is no chance that the expression can be NULL.
2486039fc32eSdrh **
2487039fc32eSdrh ** If the expression might be NULL or if the expression is too complex
2488039fc32eSdrh ** to tell return TRUE.
2489039fc32eSdrh **
2490039fc32eSdrh ** This routine is used as an optimization, to skip OP_IsNull opcodes
2491039fc32eSdrh ** when we know that a value cannot be NULL.  Hence, a false positive
2492039fc32eSdrh ** (returning TRUE when in fact the expression can never be NULL) might
2493039fc32eSdrh ** be a small performance hit but is otherwise harmless.  On the other
2494039fc32eSdrh ** hand, a false negative (returning FALSE when the result could be NULL)
2495039fc32eSdrh ** will likely result in an incorrect answer.  So when in doubt, return
2496039fc32eSdrh ** TRUE.
2497039fc32eSdrh */
2498039fc32eSdrh int sqlite3ExprCanBeNull(const Expr *p){
2499039fc32eSdrh   u8 op;
25003c6edc8aSdrh   assert( p!=0 );
25019bfb0794Sdrh   while( p->op==TK_UPLUS || p->op==TK_UMINUS ){
25029bfb0794Sdrh     p = p->pLeft;
25033c6edc8aSdrh     assert( p!=0 );
25049bfb0794Sdrh   }
2505039fc32eSdrh   op = p->op;
2506039fc32eSdrh   if( op==TK_REGISTER ) op = p->op2;
2507039fc32eSdrh   switch( op ){
2508039fc32eSdrh     case TK_INTEGER:
2509039fc32eSdrh     case TK_STRING:
2510039fc32eSdrh     case TK_FLOAT:
2511039fc32eSdrh     case TK_BLOB:
2512039fc32eSdrh       return 0;
25137248a8b2Sdrh     case TK_COLUMN:
2514477572b9Sdrh       assert( ExprUseYTab(p) );
251572673a24Sdrh       return ExprHasProperty(p, EP_CanBeNull) ||
2516eda079cdSdrh              p->y.pTab==0 ||  /* Reference to column of index on expression */
25174eac5f04Sdrh              (p->iColumn>=0
25186df8c0cdSdrh               && p->y.pTab->aCol!=0 /* Possible due to prior error */
25194eac5f04Sdrh               && p->y.pTab->aCol[p->iColumn].notNull==0);
2520039fc32eSdrh     default:
2521039fc32eSdrh       return 1;
2522039fc32eSdrh   }
2523039fc32eSdrh }
2524039fc32eSdrh 
2525039fc32eSdrh /*
2526039fc32eSdrh ** Return TRUE if the given expression is a constant which would be
2527039fc32eSdrh ** unchanged by OP_Affinity with the affinity given in the second
2528039fc32eSdrh ** argument.
2529039fc32eSdrh **
2530039fc32eSdrh ** This routine is used to determine if the OP_Affinity operation
2531039fc32eSdrh ** can be omitted.  When in doubt return FALSE.  A false negative
2532039fc32eSdrh ** is harmless.  A false positive, however, can result in the wrong
2533039fc32eSdrh ** answer.
2534039fc32eSdrh */
2535039fc32eSdrh int sqlite3ExprNeedsNoAffinityChange(const Expr *p, char aff){
2536039fc32eSdrh   u8 op;
2537af866402Sdrh   int unaryMinus = 0;
253805883a34Sdrh   if( aff==SQLITE_AFF_BLOB ) return 1;
2539af866402Sdrh   while( p->op==TK_UPLUS || p->op==TK_UMINUS ){
2540af866402Sdrh     if( p->op==TK_UMINUS ) unaryMinus = 1;
2541af866402Sdrh     p = p->pLeft;
2542af866402Sdrh   }
2543039fc32eSdrh   op = p->op;
2544039fc32eSdrh   if( op==TK_REGISTER ) op = p->op2;
2545039fc32eSdrh   switch( op ){
2546039fc32eSdrh     case TK_INTEGER: {
25476a19865fSdrh       return aff>=SQLITE_AFF_NUMERIC;
2548039fc32eSdrh     }
2549039fc32eSdrh     case TK_FLOAT: {
25506a19865fSdrh       return aff>=SQLITE_AFF_NUMERIC;
2551039fc32eSdrh     }
2552039fc32eSdrh     case TK_STRING: {
2553af866402Sdrh       return !unaryMinus && aff==SQLITE_AFF_TEXT;
2554039fc32eSdrh     }
2555039fc32eSdrh     case TK_BLOB: {
2556af866402Sdrh       return !unaryMinus;
2557039fc32eSdrh     }
25582f2855b6Sdrh     case TK_COLUMN: {
255988376ca7Sdrh       assert( p->iTable>=0 );  /* p cannot be part of a CHECK constraint */
25606a19865fSdrh       return aff>=SQLITE_AFF_NUMERIC && p->iColumn<0;
25612f2855b6Sdrh     }
2562039fc32eSdrh     default: {
2563039fc32eSdrh       return 0;
2564039fc32eSdrh     }
2565039fc32eSdrh   }
2566039fc32eSdrh }
2567039fc32eSdrh 
2568039fc32eSdrh /*
2569c4a3c779Sdrh ** Return TRUE if the given string is a row-id column name.
2570c4a3c779Sdrh */
25714adee20fSdanielk1977 int sqlite3IsRowid(const char *z){
25724adee20fSdanielk1977   if( sqlite3StrICmp(z, "_ROWID_")==0 ) return 1;
25734adee20fSdanielk1977   if( sqlite3StrICmp(z, "ROWID")==0 ) return 1;
25744adee20fSdanielk1977   if( sqlite3StrICmp(z, "OID")==0 ) return 1;
2575c4a3c779Sdrh   return 0;
2576c4a3c779Sdrh }
2577c4a3c779Sdrh 
25789a96b668Sdanielk1977 /*
257969c355bdSdrh ** pX is the RHS of an IN operator.  If pX is a SELECT statement
258069c355bdSdrh ** that can be simplified to a direct table access, then return
258169c355bdSdrh ** a pointer to the SELECT statement.  If pX is not a SELECT statement,
258269c355bdSdrh ** or if the SELECT statement needs to be manifested into a transient
258369c355bdSdrh ** table, then return NULL.
2584b287f4b6Sdrh */
2585b287f4b6Sdrh #ifndef SQLITE_OMIT_SUBQUERY
2586b6dad520Sdrh static Select *isCandidateForInOpt(const Expr *pX){
258769c355bdSdrh   Select *p;
2588b287f4b6Sdrh   SrcList *pSrc;
2589b287f4b6Sdrh   ExprList *pEList;
2590b287f4b6Sdrh   Table *pTab;
2591cfbb5e82Sdan   int i;
2592a4eeccdfSdrh   if( !ExprUseXSelect(pX) ) return 0;                 /* Not a subquery */
259369c355bdSdrh   if( ExprHasProperty(pX, EP_VarSelect)  ) return 0;  /* Correlated subq */
259469c355bdSdrh   p = pX->x.pSelect;
2595b287f4b6Sdrh   if( p->pPrior ) return 0;              /* Not a compound SELECT */
25967d10d5a6Sdrh   if( p->selFlags & (SF_Distinct|SF_Aggregate) ){
2597b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
2598b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
25997d10d5a6Sdrh     return 0; /* No DISTINCT keyword and no aggregate functions */
26007d10d5a6Sdrh   }
26012e26a602Sdrh   assert( p->pGroupBy==0 );              /* Has no GROUP BY clause */
2602b287f4b6Sdrh   if( p->pLimit ) return 0;              /* Has no LIMIT clause */
2603b287f4b6Sdrh   if( p->pWhere ) return 0;              /* Has no WHERE clause */
2604b287f4b6Sdrh   pSrc = p->pSrc;
2605d1fa7bcaSdrh   assert( pSrc!=0 );
2606d1fa7bcaSdrh   if( pSrc->nSrc!=1 ) return 0;          /* Single term in FROM clause */
2607b74b1017Sdrh   if( pSrc->a[0].pSelect ) return 0;     /* FROM is not a subquery or view */
2608b287f4b6Sdrh   pTab = pSrc->a[0].pTab;
260969c355bdSdrh   assert( pTab!=0 );
2610f38524d2Sdrh   assert( !IsView(pTab)  );              /* FROM clause is not a view */
2611b287f4b6Sdrh   if( IsVirtual(pTab) ) return 0;        /* FROM clause not a virtual table */
2612b287f4b6Sdrh   pEList = p->pEList;
2613ac6b47d1Sdrh   assert( pEList!=0 );
26147b35a77bSdan   /* All SELECT results must be columns. */
2615cfbb5e82Sdan   for(i=0; i<pEList->nExpr; i++){
2616cfbb5e82Sdan     Expr *pRes = pEList->a[i].pExpr;
2617cfbb5e82Sdan     if( pRes->op!=TK_COLUMN ) return 0;
261869c355bdSdrh     assert( pRes->iTable==pSrc->a[0].iCursor );  /* Not a correlated subquery */
2619cfbb5e82Sdan   }
262069c355bdSdrh   return p;
2621b287f4b6Sdrh }
2622b287f4b6Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
2623b287f4b6Sdrh 
2624f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
26251d8cb21fSdan /*
26264c259e9fSdrh ** Generate code that checks the left-most column of index table iCur to see if
26274c259e9fSdrh ** it contains any NULL entries.  Cause the register at regHasNull to be set
26286be515ebSdrh ** to a non-NULL value if iCur contains no NULLs.  Cause register regHasNull
26296be515ebSdrh ** to be set to NULL if iCur contains one or more NULL values.
26306be515ebSdrh */
26316be515ebSdrh static void sqlite3SetHasNullFlag(Vdbe *v, int iCur, int regHasNull){
2632728e0f91Sdrh   int addr1;
26336be515ebSdrh   sqlite3VdbeAddOp2(v, OP_Integer, 0, regHasNull);
2634728e0f91Sdrh   addr1 = sqlite3VdbeAddOp1(v, OP_Rewind, iCur); VdbeCoverage(v);
26356be515ebSdrh   sqlite3VdbeAddOp3(v, OP_Column, iCur, 0, regHasNull);
26366be515ebSdrh   sqlite3VdbeChangeP5(v, OPFLAG_TYPEOFARG);
26374c259e9fSdrh   VdbeComment((v, "first_entry_in(%d)", iCur));
2638728e0f91Sdrh   sqlite3VdbeJumpHere(v, addr1);
26396be515ebSdrh }
2640f9b2e05cSdan #endif
26416be515ebSdrh 
2642bb53ecb1Sdrh 
2643bb53ecb1Sdrh #ifndef SQLITE_OMIT_SUBQUERY
2644bb53ecb1Sdrh /*
2645bb53ecb1Sdrh ** The argument is an IN operator with a list (not a subquery) on the
2646bb53ecb1Sdrh ** right-hand side.  Return TRUE if that list is constant.
2647bb53ecb1Sdrh */
2648bb53ecb1Sdrh static int sqlite3InRhsIsConstant(Expr *pIn){
2649bb53ecb1Sdrh   Expr *pLHS;
2650bb53ecb1Sdrh   int res;
2651bb53ecb1Sdrh   assert( !ExprHasProperty(pIn, EP_xIsSelect) );
2652bb53ecb1Sdrh   pLHS = pIn->pLeft;
2653bb53ecb1Sdrh   pIn->pLeft = 0;
2654bb53ecb1Sdrh   res = sqlite3ExprIsConstant(pIn);
2655bb53ecb1Sdrh   pIn->pLeft = pLHS;
2656bb53ecb1Sdrh   return res;
2657bb53ecb1Sdrh }
2658bb53ecb1Sdrh #endif
2659bb53ecb1Sdrh 
26606be515ebSdrh /*
26619a96b668Sdanielk1977 ** This function is used by the implementation of the IN (...) operator.
2662d4305ca6Sdrh ** The pX parameter is the expression on the RHS of the IN operator, which
2663d4305ca6Sdrh ** might be either a list of expressions or a subquery.
26649a96b668Sdanielk1977 **
2665d4305ca6Sdrh ** The job of this routine is to find or create a b-tree object that can
2666d4305ca6Sdrh ** be used either to test for membership in the RHS set or to iterate through
2667d4305ca6Sdrh ** all members of the RHS set, skipping duplicates.
2668d4305ca6Sdrh **
26693a85625dSdrh ** A cursor is opened on the b-tree object that is the RHS of the IN operator
2670b94182bdSdrh ** and the *piTab parameter is set to the index of that cursor.
2671d4305ca6Sdrh **
2672b74b1017Sdrh ** The returned value of this function indicates the b-tree type, as follows:
26739a96b668Sdanielk1977 **
26749a96b668Sdanielk1977 **   IN_INDEX_ROWID      - The cursor was opened on a database table.
26751ccce449Sdrh **   IN_INDEX_INDEX_ASC  - The cursor was opened on an ascending index.
26761ccce449Sdrh **   IN_INDEX_INDEX_DESC - The cursor was opened on a descending index.
26779a96b668Sdanielk1977 **   IN_INDEX_EPH        - The cursor was opened on a specially created and
26789a96b668Sdanielk1977 **                         populated epheremal table.
2679bb53ecb1Sdrh **   IN_INDEX_NOOP       - No cursor was allocated.  The IN operator must be
2680bb53ecb1Sdrh **                         implemented as a sequence of comparisons.
26819a96b668Sdanielk1977 **
2682d4305ca6Sdrh ** An existing b-tree might be used if the RHS expression pX is a simple
2683d4305ca6Sdrh ** subquery such as:
26849a96b668Sdanielk1977 **
2685553168c7Sdan **     SELECT <column1>, <column2>... FROM <table>
26869a96b668Sdanielk1977 **
2687d4305ca6Sdrh ** If the RHS of the IN operator is a list or a more complex subquery, then
2688d4305ca6Sdrh ** an ephemeral table might need to be generated from the RHS and then
268960ec914cSpeter.d.reid ** pX->iTable made to point to the ephemeral table instead of an
2690b94182bdSdrh ** existing table.  In this case, the creation and initialization of the
2691b94182bdSdrh ** ephmeral table might be put inside of a subroutine, the EP_Subrtn flag
2692b94182bdSdrh ** will be set on pX and the pX->y.sub fields will be set to show where
2693b94182bdSdrh ** the subroutine is coded.
2694d4305ca6Sdrh **
26957fc0ba0fSdrh ** The inFlags parameter must contain, at a minimum, one of the bits
26967fc0ba0fSdrh ** IN_INDEX_MEMBERSHIP or IN_INDEX_LOOP but not both.  If inFlags contains
26977fc0ba0fSdrh ** IN_INDEX_MEMBERSHIP, then the generated table will be used for a fast
26987fc0ba0fSdrh ** membership test.  When the IN_INDEX_LOOP bit is set, the IN index will
26997fc0ba0fSdrh ** be used to loop over all values of the RHS of the IN operator.
27003a85625dSdrh **
27013a85625dSdrh ** When IN_INDEX_LOOP is used (and the b-tree will be used to iterate
27023a85625dSdrh ** through the set members) then the b-tree must not contain duplicates.
27037fc0ba0fSdrh ** An epheremal table will be created unless the selected columns are guaranteed
2704553168c7Sdan ** to be unique - either because it is an INTEGER PRIMARY KEY or due to
2705553168c7Sdan ** a UNIQUE constraint or index.
27060cdc022eSdanielk1977 **
27073a85625dSdrh ** When IN_INDEX_MEMBERSHIP is used (and the b-tree will be used
27083a85625dSdrh ** for fast set membership tests) then an epheremal table must
2709553168c7Sdan ** be used unless <columns> is a single INTEGER PRIMARY KEY column or an
2710553168c7Sdan ** index can be found with the specified <columns> as its left-most.
27110cdc022eSdanielk1977 **
2712bb53ecb1Sdrh ** If the IN_INDEX_NOOP_OK and IN_INDEX_MEMBERSHIP are both set and
2713bb53ecb1Sdrh ** if the RHS of the IN operator is a list (not a subquery) then this
2714bb53ecb1Sdrh ** routine might decide that creating an ephemeral b-tree for membership
2715bb53ecb1Sdrh ** testing is too expensive and return IN_INDEX_NOOP.  In that case, the
2716bb53ecb1Sdrh ** calling routine should implement the IN operator using a sequence
2717bb53ecb1Sdrh ** of Eq or Ne comparison operations.
2718bb53ecb1Sdrh **
2719b74b1017Sdrh ** When the b-tree is being used for membership tests, the calling function
27203a85625dSdrh ** might need to know whether or not the RHS side of the IN operator
2721e21a6e1dSdrh ** contains a NULL.  If prRhsHasNull is not a NULL pointer and
27223a85625dSdrh ** if there is any chance that the (...) might contain a NULL value at
27230cdc022eSdanielk1977 ** runtime, then a register is allocated and the register number written
2724e21a6e1dSdrh ** to *prRhsHasNull. If there is no chance that the (...) contains a
2725e21a6e1dSdrh ** NULL value, then *prRhsHasNull is left unchanged.
27260cdc022eSdanielk1977 **
2727e21a6e1dSdrh ** If a register is allocated and its location stored in *prRhsHasNull, then
27286be515ebSdrh ** the value in that register will be NULL if the b-tree contains one or more
27296be515ebSdrh ** NULL values, and it will be some non-NULL value if the b-tree contains no
27306be515ebSdrh ** NULL values.
2731553168c7Sdan **
2732553168c7Sdan ** If the aiMap parameter is not NULL, it must point to an array containing
2733553168c7Sdan ** one element for each column returned by the SELECT statement on the RHS
2734553168c7Sdan ** of the IN(...) operator. The i'th entry of the array is populated with the
2735553168c7Sdan ** offset of the index column that matches the i'th column returned by the
2736553168c7Sdan ** SELECT. For example, if the expression and selected index are:
2737553168c7Sdan **
2738553168c7Sdan **   (?,?,?) IN (SELECT a, b, c FROM t1)
2739553168c7Sdan **   CREATE INDEX i1 ON t1(b, c, a);
2740553168c7Sdan **
2741553168c7Sdan ** then aiMap[] is populated with {2, 0, 1}.
27429a96b668Sdanielk1977 */
2743284f4acaSdanielk1977 #ifndef SQLITE_OMIT_SUBQUERY
2744ba00e30aSdan int sqlite3FindInIndex(
27456fc8f364Sdrh   Parse *pParse,             /* Parsing context */
27460167ef20Sdrh   Expr *pX,                  /* The IN expression */
27476fc8f364Sdrh   u32 inFlags,               /* IN_INDEX_LOOP, _MEMBERSHIP, and/or _NOOP_OK */
27486fc8f364Sdrh   int *prRhsHasNull,         /* Register holding NULL status.  See notes */
27492c04131cSdrh   int *aiMap,                /* Mapping from Index fields to RHS fields */
27502c04131cSdrh   int *piTab                 /* OUT: index to use */
2751ba00e30aSdan ){
2752b74b1017Sdrh   Select *p;                            /* SELECT to the right of IN operator */
2753b74b1017Sdrh   int eType = 0;                        /* Type of RHS table. IN_INDEX_* */
27543a45d30eSdrh   int iTab;                             /* Cursor of the RHS table */
27553a85625dSdrh   int mustBeUnique;                     /* True if RHS must be unique */
2756b8475df8Sdrh   Vdbe *v = sqlite3GetVdbe(pParse);     /* Virtual machine being coded */
27579a96b668Sdanielk1977 
27581450bc6eSdrh   assert( pX->op==TK_IN );
27593a85625dSdrh   mustBeUnique = (inFlags & IN_INDEX_LOOP)!=0;
27603a45d30eSdrh   iTab = pParse->nTab++;
27611450bc6eSdrh 
27627b35a77bSdan   /* If the RHS of this IN(...) operator is a SELECT, and if it matters
27637b35a77bSdan   ** whether or not the SELECT result contains NULL values, check whether
2764870a0705Sdan   ** or not NULL is actually possible (it may not be, for example, due
27657b35a77bSdan   ** to NOT NULL constraints in the schema). If no NULL values are possible,
2766870a0705Sdan   ** set prRhsHasNull to 0 before continuing.  */
2767a4eeccdfSdrh   if( prRhsHasNull && ExprUseXSelect(pX) ){
27687b35a77bSdan     int i;
27697b35a77bSdan     ExprList *pEList = pX->x.pSelect->pEList;
27707b35a77bSdan     for(i=0; i<pEList->nExpr; i++){
27717b35a77bSdan       if( sqlite3ExprCanBeNull(pEList->a[i].pExpr) ) break;
27727b35a77bSdan     }
27737b35a77bSdan     if( i==pEList->nExpr ){
27747b35a77bSdan       prRhsHasNull = 0;
27757b35a77bSdan     }
27767b35a77bSdan   }
27777b35a77bSdan 
2778b74b1017Sdrh   /* Check to see if an existing table or index can be used to
2779b74b1017Sdrh   ** satisfy the query.  This is preferable to generating a new
27807b35a77bSdan   ** ephemeral table.  */
27817b35a77bSdan   if( pParse->nErr==0 && (p = isCandidateForInOpt(pX))!=0 ){
2782e1fb65a0Sdanielk1977     sqlite3 *db = pParse->db;              /* Database connection */
2783b07028f7Sdrh     Table *pTab;                           /* Table <table>. */
2784399062ccSdrh     int iDb;                               /* Database idx for pTab */
2785cfbb5e82Sdan     ExprList *pEList = p->pEList;
2786cfbb5e82Sdan     int nExpr = pEList->nExpr;
2787e1fb65a0Sdanielk1977 
2788b07028f7Sdrh     assert( p->pEList!=0 );             /* Because of isCandidateForInOpt(p) */
2789b07028f7Sdrh     assert( p->pEList->a[0].pExpr!=0 ); /* Because of isCandidateForInOpt(p) */
2790b07028f7Sdrh     assert( p->pSrc!=0 );               /* Because of isCandidateForInOpt(p) */
2791b07028f7Sdrh     pTab = p->pSrc->a[0].pTab;
2792b07028f7Sdrh 
2793b22f7c83Sdrh     /* Code an OP_Transaction and OP_TableLock for <table>. */
2794e1fb65a0Sdanielk1977     iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
2795099b385dSdrh     assert( iDb>=0 && iDb<SQLITE_MAX_DB );
2796e1fb65a0Sdanielk1977     sqlite3CodeVerifySchema(pParse, iDb);
2797e1fb65a0Sdanielk1977     sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
27989a96b668Sdanielk1977 
2799a84a283dSdrh     assert(v);  /* sqlite3GetVdbe() has always been previously called */
2800cfbb5e82Sdan     if( nExpr==1 && pEList->a[0].pExpr->iColumn<0 ){
280162659b2aSdrh       /* The "x IN (SELECT rowid FROM table)" case */
2802511f9e8dSdrh       int iAddr = sqlite3VdbeAddOp0(v, OP_Once);
28037d176105Sdrh       VdbeCoverage(v);
28049a96b668Sdanielk1977 
28059a96b668Sdanielk1977       sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
28069a96b668Sdanielk1977       eType = IN_INDEX_ROWID;
2807d8852095Sdrh       ExplainQueryPlan((pParse, 0,
2808d8852095Sdrh             "USING ROWID SEARCH ON TABLE %s FOR IN-OPERATOR",pTab->zName));
28099a96b668Sdanielk1977       sqlite3VdbeJumpHere(v, iAddr);
28109a96b668Sdanielk1977     }else{
2811e1fb65a0Sdanielk1977       Index *pIdx;                         /* Iterator variable */
2812cfbb5e82Sdan       int affinity_ok = 1;
2813cfbb5e82Sdan       int i;
2814cfbb5e82Sdan 
2815cfbb5e82Sdan       /* Check that the affinity that will be used to perform each
281662659b2aSdrh       ** comparison is the same as the affinity of each column in table
281762659b2aSdrh       ** on the RHS of the IN operator.  If it not, it is not possible to
281862659b2aSdrh       ** use any index of the RHS table.  */
2819cfbb5e82Sdan       for(i=0; i<nExpr && affinity_ok; i++){
2820fc7f27b9Sdrh         Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2821cfbb5e82Sdan         int iCol = pEList->a[i].pExpr->iColumn;
28220dfa4f6fSdrh         char idxaff = sqlite3TableColumnAffinity(pTab,iCol); /* RHS table */
2823cfbb5e82Sdan         char cmpaff = sqlite3CompareAffinity(pLhs, idxaff);
282462659b2aSdrh         testcase( cmpaff==SQLITE_AFF_BLOB );
282562659b2aSdrh         testcase( cmpaff==SQLITE_AFF_TEXT );
2826cfbb5e82Sdan         switch( cmpaff ){
2827cfbb5e82Sdan           case SQLITE_AFF_BLOB:
2828cfbb5e82Sdan             break;
2829cfbb5e82Sdan           case SQLITE_AFF_TEXT:
283062659b2aSdrh             /* sqlite3CompareAffinity() only returns TEXT if one side or the
283162659b2aSdrh             ** other has no affinity and the other side is TEXT.  Hence,
283262659b2aSdrh             ** the only way for cmpaff to be TEXT is for idxaff to be TEXT
283362659b2aSdrh             ** and for the term on the LHS of the IN to have no affinity. */
283462659b2aSdrh             assert( idxaff==SQLITE_AFF_TEXT );
2835cfbb5e82Sdan             break;
2836cfbb5e82Sdan           default:
2837cfbb5e82Sdan             affinity_ok = sqlite3IsNumericAffinity(idxaff);
2838cfbb5e82Sdan         }
2839cfbb5e82Sdan       }
2840e1fb65a0Sdanielk1977 
2841a84a283dSdrh       if( affinity_ok ){
2842a84a283dSdrh         /* Search for an existing index that will work for this IN operator */
2843a84a283dSdrh         for(pIdx=pTab->pIndex; pIdx && eType==0; pIdx=pIdx->pNext){
2844a84a283dSdrh           Bitmask colUsed;      /* Columns of the index used */
2845a84a283dSdrh           Bitmask mCol;         /* Mask for the current column */
28466fc8f364Sdrh           if( pIdx->nColumn<nExpr ) continue;
2847d4a4a361Sdrh           if( pIdx->pPartIdxWhere!=0 ) continue;
2848a84a283dSdrh           /* Maximum nColumn is BMS-2, not BMS-1, so that we can compute
2849a84a283dSdrh           ** BITMASK(nExpr) without overflowing */
2850a84a283dSdrh           testcase( pIdx->nColumn==BMS-2 );
2851a84a283dSdrh           testcase( pIdx->nColumn==BMS-1 );
2852a84a283dSdrh           if( pIdx->nColumn>=BMS-1 ) continue;
28536fc8f364Sdrh           if( mustBeUnique ){
28546fc8f364Sdrh             if( pIdx->nKeyCol>nExpr
28556fc8f364Sdrh              ||(pIdx->nColumn>nExpr && !IsUniqueIndex(pIdx))
28566fc8f364Sdrh             ){
2857a84a283dSdrh               continue;  /* This index is not unique over the IN RHS columns */
2858cfbb5e82Sdan             }
28596fc8f364Sdrh           }
2860cfbb5e82Sdan 
2861a84a283dSdrh           colUsed = 0;   /* Columns of index used so far */
2862cfbb5e82Sdan           for(i=0; i<nExpr; i++){
2863fc7f27b9Sdrh             Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2864cfbb5e82Sdan             Expr *pRhs = pEList->a[i].pExpr;
2865cfbb5e82Sdan             CollSeq *pReq = sqlite3BinaryCompareCollSeq(pParse, pLhs, pRhs);
2866cfbb5e82Sdan             int j;
2867cfbb5e82Sdan 
28680c7d3d39Sdrh             assert( pReq!=0 || pRhs->iColumn==XN_ROWID || pParse->nErr );
2869cfbb5e82Sdan             for(j=0; j<nExpr; j++){
2870cfbb5e82Sdan               if( pIdx->aiColumn[j]!=pRhs->iColumn ) continue;
2871cfbb5e82Sdan               assert( pIdx->azColl[j] );
2872106526e1Sdrh               if( pReq!=0 && sqlite3StrICmp(pReq->zName, pIdx->azColl[j])!=0 ){
2873106526e1Sdrh                 continue;
2874106526e1Sdrh               }
2875cfbb5e82Sdan               break;
2876cfbb5e82Sdan             }
2877cfbb5e82Sdan             if( j==nExpr ) break;
2878a84a283dSdrh             mCol = MASKBIT(j);
2879a84a283dSdrh             if( mCol & colUsed ) break; /* Each column used only once */
2880a84a283dSdrh             colUsed |= mCol;
2881ba00e30aSdan             if( aiMap ) aiMap[i] = j;
2882cfbb5e82Sdan           }
2883cfbb5e82Sdan 
2884a84a283dSdrh           assert( i==nExpr || colUsed!=(MASKBIT(nExpr)-1) );
2885a84a283dSdrh           if( colUsed==(MASKBIT(nExpr)-1) ){
2886a84a283dSdrh             /* If we reach this point, that means the index pIdx is usable */
2887511f9e8dSdrh             int iAddr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
2888e2ca99c9Sdrh             ExplainQueryPlan((pParse, 0,
2889e2ca99c9Sdrh                               "USING INDEX %s FOR IN-OPERATOR",pIdx->zName));
28902ec2fb22Sdrh             sqlite3VdbeAddOp3(v, OP_OpenRead, iTab, pIdx->tnum, iDb);
28912ec2fb22Sdrh             sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
2892207872a4Sdanielk1977             VdbeComment((v, "%s", pIdx->zName));
28931ccce449Sdrh             assert( IN_INDEX_INDEX_DESC == IN_INDEX_INDEX_ASC+1 );
28941ccce449Sdrh             eType = IN_INDEX_INDEX_ASC + pIdx->aSortOrder[0];
28959a96b668Sdanielk1977 
28967b35a77bSdan             if( prRhsHasNull ){
28973480bfdaSdan #ifdef SQLITE_ENABLE_COLUMN_USED_MASK
2898cfbb5e82Sdan               i64 mask = (1<<nExpr)-1;
28993480bfdaSdan               sqlite3VdbeAddOp4Dup8(v, OP_ColumnsUsed,
2900cfbb5e82Sdan                   iTab, 0, 0, (u8*)&mask, P4_INT64);
29013480bfdaSdan #endif
2902b80dbdc2Sdrh               *prRhsHasNull = ++pParse->nMem;
29037b35a77bSdan               if( nExpr==1 ){
29046be515ebSdrh                 sqlite3SetHasNullFlag(v, iTab, *prRhsHasNull);
29050cdc022eSdanielk1977               }
29067b35a77bSdan             }
2907552fd454Sdrh             sqlite3VdbeJumpHere(v, iAddr);
29089a96b668Sdanielk1977           }
2909a84a283dSdrh         } /* End loop over indexes */
2910a84a283dSdrh       } /* End if( affinity_ok ) */
2911a84a283dSdrh     } /* End if not an rowid index */
2912a84a283dSdrh   } /* End attempt to optimize using an index */
29139a96b668Sdanielk1977 
2914bb53ecb1Sdrh   /* If no preexisting index is available for the IN clause
2915bb53ecb1Sdrh   ** and IN_INDEX_NOOP is an allowed reply
2916bb53ecb1Sdrh   ** and the RHS of the IN operator is a list, not a subquery
291771c57db0Sdan   ** and the RHS is not constant or has two or fewer terms,
291860ec914cSpeter.d.reid   ** then it is not worth creating an ephemeral table to evaluate
2919bb53ecb1Sdrh   ** the IN operator so return IN_INDEX_NOOP.
2920bb53ecb1Sdrh   */
2921bb53ecb1Sdrh   if( eType==0
2922bb53ecb1Sdrh    && (inFlags & IN_INDEX_NOOP_OK)
2923a4eeccdfSdrh    && ExprUseXList(pX)
2924bb53ecb1Sdrh    && (!sqlite3InRhsIsConstant(pX) || pX->x.pList->nExpr<=2)
2925bb53ecb1Sdrh   ){
2926b94182bdSdrh     pParse->nTab--;  /* Back out the allocation of the unused cursor */
2927b94182bdSdrh     iTab = -1;       /* Cursor is not allocated */
2928bb53ecb1Sdrh     eType = IN_INDEX_NOOP;
2929bb53ecb1Sdrh   }
2930bb53ecb1Sdrh 
29319a96b668Sdanielk1977   if( eType==0 ){
29324387006cSdrh     /* Could not find an existing table or index to use as the RHS b-tree.
2933b74b1017Sdrh     ** We will have to generate an ephemeral table to do the job.
2934b74b1017Sdrh     */
29358e23daf3Sdrh     u32 savedNQueryLoop = pParse->nQueryLoop;
29360cdc022eSdanielk1977     int rMayHaveNull = 0;
293741a05b7bSdanielk1977     eType = IN_INDEX_EPH;
29383a85625dSdrh     if( inFlags & IN_INDEX_LOOP ){
29394a5acf8eSdrh       pParse->nQueryLoop = 0;
2940e21a6e1dSdrh     }else if( prRhsHasNull ){
2941e21a6e1dSdrh       *prRhsHasNull = rMayHaveNull = ++pParse->nMem;
2942cf4d38aaSdrh     }
294385bcdce2Sdrh     assert( pX->op==TK_IN );
294450ef6716Sdrh     sqlite3CodeRhsOfIN(pParse, pX, iTab);
294585bcdce2Sdrh     if( rMayHaveNull ){
29462c04131cSdrh       sqlite3SetHasNullFlag(v, iTab, rMayHaveNull);
294785bcdce2Sdrh     }
2948cf4d38aaSdrh     pParse->nQueryLoop = savedNQueryLoop;
29499a96b668Sdanielk1977   }
2950ba00e30aSdan 
2951ba00e30aSdan   if( aiMap && eType!=IN_INDEX_INDEX_ASC && eType!=IN_INDEX_INDEX_DESC ){
2952ba00e30aSdan     int i, n;
2953ba00e30aSdan     n = sqlite3ExprVectorSize(pX->pLeft);
2954ba00e30aSdan     for(i=0; i<n; i++) aiMap[i] = i;
2955ba00e30aSdan   }
29562c04131cSdrh   *piTab = iTab;
29579a96b668Sdanielk1977   return eType;
29589a96b668Sdanielk1977 }
2959284f4acaSdanielk1977 #endif
2960626a879aSdrh 
2961f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
2962553168c7Sdan /*
2963553168c7Sdan ** Argument pExpr is an (?, ?...) IN(...) expression. This
2964553168c7Sdan ** function allocates and returns a nul-terminated string containing
2965553168c7Sdan ** the affinities to be used for each column of the comparison.
2966553168c7Sdan **
2967553168c7Sdan ** It is the responsibility of the caller to ensure that the returned
2968553168c7Sdan ** string is eventually freed using sqlite3DbFree().
2969553168c7Sdan */
2970b6dad520Sdrh static char *exprINAffinity(Parse *pParse, const Expr *pExpr){
297171c57db0Sdan   Expr *pLeft = pExpr->pLeft;
297271c57db0Sdan   int nVal = sqlite3ExprVectorSize(pLeft);
2973a4eeccdfSdrh   Select *pSelect = ExprUseXSelect(pExpr) ? pExpr->x.pSelect : 0;
297471c57db0Sdan   char *zRet;
297571c57db0Sdan 
2976553168c7Sdan   assert( pExpr->op==TK_IN );
29775c258dc1Sdrh   zRet = sqlite3DbMallocRaw(pParse->db, nVal+1);
297871c57db0Sdan   if( zRet ){
297971c57db0Sdan     int i;
298071c57db0Sdan     for(i=0; i<nVal; i++){
2981fc7f27b9Sdrh       Expr *pA = sqlite3VectorFieldSubexpr(pLeft, i);
2982553168c7Sdan       char a = sqlite3ExprAffinity(pA);
2983553168c7Sdan       if( pSelect ){
2984553168c7Sdan         zRet[i] = sqlite3CompareAffinity(pSelect->pEList->a[i].pExpr, a);
298571c57db0Sdan       }else{
2986553168c7Sdan         zRet[i] = a;
298771c57db0Sdan       }
298871c57db0Sdan     }
298971c57db0Sdan     zRet[nVal] = '\0';
299071c57db0Sdan   }
299171c57db0Sdan   return zRet;
299271c57db0Sdan }
2993f9b2e05cSdan #endif
299471c57db0Sdan 
29958da209b1Sdan #ifndef SQLITE_OMIT_SUBQUERY
29968da209b1Sdan /*
29978da209b1Sdan ** Load the Parse object passed as the first argument with an error
29988da209b1Sdan ** message of the form:
29998da209b1Sdan **
30008da209b1Sdan **   "sub-select returns N columns - expected M"
30018da209b1Sdan */
30028da209b1Sdan void sqlite3SubselectError(Parse *pParse, int nActual, int nExpect){
3003a9ebfe20Sdrh   if( pParse->nErr==0 ){
30048da209b1Sdan     const char *zFmt = "sub-select returns %d columns - expected %d";
30058da209b1Sdan     sqlite3ErrorMsg(pParse, zFmt, nActual, nExpect);
30068da209b1Sdan   }
3007a9ebfe20Sdrh }
30088da209b1Sdan #endif
30098da209b1Sdan 
3010626a879aSdrh /*
301144c5604cSdan ** Expression pExpr is a vector that has been used in a context where
301244c5604cSdan ** it is not permitted. If pExpr is a sub-select vector, this routine
301344c5604cSdan ** loads the Parse object with a message of the form:
301444c5604cSdan **
301544c5604cSdan **   "sub-select returns N columns - expected 1"
301644c5604cSdan **
301744c5604cSdan ** Or, if it is a regular scalar vector:
301844c5604cSdan **
301944c5604cSdan **   "row value misused"
302044c5604cSdan */
302144c5604cSdan void sqlite3VectorErrorMsg(Parse *pParse, Expr *pExpr){
302244c5604cSdan #ifndef SQLITE_OMIT_SUBQUERY
3023a4eeccdfSdrh   if( ExprUseXSelect(pExpr) ){
302444c5604cSdan     sqlite3SubselectError(pParse, pExpr->x.pSelect->pEList->nExpr, 1);
302544c5604cSdan   }else
302644c5604cSdan #endif
302744c5604cSdan   {
302844c5604cSdan     sqlite3ErrorMsg(pParse, "row value misused");
302944c5604cSdan   }
303044c5604cSdan }
303144c5604cSdan 
303285bcdce2Sdrh #ifndef SQLITE_OMIT_SUBQUERY
303344c5604cSdan /*
303485bcdce2Sdrh ** Generate code that will construct an ephemeral table containing all terms
303585bcdce2Sdrh ** in the RHS of an IN operator.  The IN operator can be in either of two
303685bcdce2Sdrh ** forms:
3037626a879aSdrh **
30389cbe6352Sdrh **     x IN (4,5,11)              -- IN operator with list on right-hand side
30399cbe6352Sdrh **     x IN (SELECT a FROM b)     -- IN operator with subquery on the right
3040fef5208cSdrh **
30412c04131cSdrh ** The pExpr parameter is the IN operator.  The cursor number for the
30422c04131cSdrh ** constructed ephermeral table is returned.  The first time the ephemeral
30432c04131cSdrh ** table is computed, the cursor number is also stored in pExpr->iTable,
30442c04131cSdrh ** however the cursor number returned might not be the same, as it might
30452c04131cSdrh ** have been duplicated using OP_OpenDup.
304641a05b7bSdanielk1977 **
304785bcdce2Sdrh ** If the LHS expression ("x" in the examples) is a column value, or
304885bcdce2Sdrh ** the SELECT statement returns a column value, then the affinity of that
304985bcdce2Sdrh ** column is used to build the index keys. If both 'x' and the
305085bcdce2Sdrh ** SELECT... statement are columns, then numeric affinity is used
305185bcdce2Sdrh ** if either column has NUMERIC or INTEGER affinity. If neither
305285bcdce2Sdrh ** 'x' nor the SELECT... statement are columns, then numeric affinity
305385bcdce2Sdrh ** is used.
3054cce7d176Sdrh */
305585bcdce2Sdrh void sqlite3CodeRhsOfIN(
3056fd773cf9Sdrh   Parse *pParse,          /* Parsing context */
305785bcdce2Sdrh   Expr *pExpr,            /* The IN operator */
305850ef6716Sdrh   int iTab                /* Use this cursor number */
305941a05b7bSdanielk1977 ){
30602c04131cSdrh   int addrOnce = 0;           /* Address of the OP_Once instruction at top */
306185bcdce2Sdrh   int addr;                   /* Address of OP_OpenEphemeral instruction */
306285bcdce2Sdrh   Expr *pLeft;                /* the LHS of the IN operator */
306385bcdce2Sdrh   KeyInfo *pKeyInfo = 0;      /* Key information */
306485bcdce2Sdrh   int nVal;                   /* Size of vector pLeft */
306585bcdce2Sdrh   Vdbe *v;                    /* The prepared statement under construction */
3066fc976065Sdanielk1977 
30672c04131cSdrh   v = pParse->pVdbe;
306885bcdce2Sdrh   assert( v!=0 );
306985bcdce2Sdrh 
30702c04131cSdrh   /* The evaluation of the IN must be repeated every time it
307139a11819Sdrh   ** is encountered if any of the following is true:
307257dbd7b3Sdrh   **
307357dbd7b3Sdrh   **    *  The right-hand side is a correlated subquery
307457dbd7b3Sdrh   **    *  The right-hand side is an expression list containing variables
307557dbd7b3Sdrh   **    *  We are inside a trigger
307657dbd7b3Sdrh   **
30772c04131cSdrh   ** If all of the above are false, then we can compute the RHS just once
30782c04131cSdrh   ** and reuse it many names.
3079b3bce662Sdanielk1977   */
3080efb699fcSdrh   if( !ExprHasProperty(pExpr, EP_VarSelect) && pParse->iSelfTab==0 ){
30812c04131cSdrh     /* Reuse of the RHS is allowed */
30822c04131cSdrh     /* If this routine has already been coded, but the previous code
30832c04131cSdrh     ** might not have been invoked yet, so invoke it now as a subroutine.
30842c04131cSdrh     */
30852c04131cSdrh     if( ExprHasProperty(pExpr, EP_Subrtn) ){
3086f9231c34Sdrh       addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
3087a4eeccdfSdrh       if( ExprUseXSelect(pExpr) ){
3088bd462bccSdrh         ExplainQueryPlan((pParse, 0, "REUSE LIST SUBQUERY %d",
3089bd462bccSdrh               pExpr->x.pSelect->selId));
3090bd462bccSdrh       }
3091477572b9Sdrh       assert( ExprUseYSub(pExpr) );
30922c04131cSdrh       sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
30932c04131cSdrh                         pExpr->y.sub.iAddr);
3094086b800fSdrh       assert( iTab!=pExpr->iTable );
30952c04131cSdrh       sqlite3VdbeAddOp2(v, OP_OpenDup, iTab, pExpr->iTable);
3096f9231c34Sdrh       sqlite3VdbeJumpHere(v, addrOnce);
30972c04131cSdrh       return;
30982c04131cSdrh     }
30992c04131cSdrh 
31002c04131cSdrh     /* Begin coding the subroutine */
3101477572b9Sdrh     assert( !ExprUseYWin(pExpr) );
31022c04131cSdrh     ExprSetProperty(pExpr, EP_Subrtn);
3103088489e8Sdrh     assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
31042c04131cSdrh     pExpr->y.sub.regReturn = ++pParse->nMem;
31052c04131cSdrh     pExpr->y.sub.iAddr =
31061902516dSdrh       sqlite3VdbeAddOp2(v, OP_BeginSubrtn, 0, pExpr->y.sub.regReturn) + 1;
31072c04131cSdrh 
31082c04131cSdrh     addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
3109b3bce662Sdanielk1977   }
3110b3bce662Sdanielk1977 
311185bcdce2Sdrh   /* Check to see if this is a vector IN operator */
311285bcdce2Sdrh   pLeft = pExpr->pLeft;
311371c57db0Sdan   nVal = sqlite3ExprVectorSize(pLeft);
3114e014a838Sdanielk1977 
311585bcdce2Sdrh   /* Construct the ephemeral table that will contain the content of
311685bcdce2Sdrh   ** RHS of the IN operator.
3117fef5208cSdrh   */
31182c04131cSdrh   pExpr->iTable = iTab;
311950ef6716Sdrh   addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, pExpr->iTable, nVal);
31202c04131cSdrh #ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
3121a4eeccdfSdrh   if( ExprUseXSelect(pExpr) ){
31222c04131cSdrh     VdbeComment((v, "Result of SELECT %u", pExpr->x.pSelect->selId));
31232c04131cSdrh   }else{
31242c04131cSdrh     VdbeComment((v, "RHS of IN operator"));
31252c04131cSdrh   }
31262c04131cSdrh #endif
312750ef6716Sdrh   pKeyInfo = sqlite3KeyInfoAlloc(pParse->db, nVal, 1);
3128e014a838Sdanielk1977 
3129a4eeccdfSdrh   if( ExprUseXSelect(pExpr) ){
3130e014a838Sdanielk1977     /* Case 1:     expr IN (SELECT ...)
3131e014a838Sdanielk1977     **
3132e014a838Sdanielk1977     ** Generate code to write the results of the select into the temporary
3133e014a838Sdanielk1977     ** table allocated and opened above.
3134e014a838Sdanielk1977     */
31354387006cSdrh     Select *pSelect = pExpr->x.pSelect;
313671c57db0Sdan     ExprList *pEList = pSelect->pEList;
31371013c932Sdrh 
31382c04131cSdrh     ExplainQueryPlan((pParse, 1, "%sLIST SUBQUERY %d",
31392c04131cSdrh         addrOnce?"":"CORRELATED ", pSelect->selId
3140e2ca99c9Sdrh     ));
314164bcb8cfSdrh     /* If the LHS and RHS of the IN operator do not match, that
314264bcb8cfSdrh     ** error will have been caught long before we reach this point. */
314364bcb8cfSdrh     if( ALWAYS(pEList->nExpr==nVal) ){
314414c4d428Sdrh       Select *pCopy;
314571c57db0Sdan       SelectDest dest;
314671c57db0Sdan       int i;
314714c4d428Sdrh       int rc;
3148bd462bccSdrh       sqlite3SelectDestInit(&dest, SRT_Set, iTab);
314971c57db0Sdan       dest.zAffSdst = exprINAffinity(pParse, pExpr);
31504387006cSdrh       pSelect->iLimit = 0;
31514387006cSdrh       testcase( pSelect->selFlags & SF_Distinct );
3152812ea833Sdrh       testcase( pKeyInfo==0 ); /* Caused by OOM in sqlite3KeyInfoAlloc() */
315314c4d428Sdrh       pCopy = sqlite3SelectDup(pParse->db, pSelect, 0);
315414c4d428Sdrh       rc = pParse->db->mallocFailed ? 1 :sqlite3Select(pParse, pCopy, &dest);
315514c4d428Sdrh       sqlite3SelectDelete(pParse->db, pCopy);
315671c57db0Sdan       sqlite3DbFree(pParse->db, dest.zAffSdst);
315714c4d428Sdrh       if( rc ){
31582ec2fb22Sdrh         sqlite3KeyInfoUnref(pKeyInfo);
315985bcdce2Sdrh         return;
316094ccde58Sdrh       }
3161812ea833Sdrh       assert( pKeyInfo!=0 ); /* OOM will cause exit after sqlite3Select() */
31623535ec3eSdrh       assert( pEList!=0 );
31633535ec3eSdrh       assert( pEList->nExpr>0 );
31642ec2fb22Sdrh       assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
316571c57db0Sdan       for(i=0; i<nVal; i++){
3166773d3afaSdan         Expr *p = sqlite3VectorFieldSubexpr(pLeft, i);
316771c57db0Sdan         pKeyInfo->aColl[i] = sqlite3BinaryCompareCollSeq(
316871c57db0Sdan             pParse, p, pEList->a[i].pExpr
316971c57db0Sdan         );
317071c57db0Sdan       }
317171c57db0Sdan     }
3172a7d2db17Sdrh   }else if( ALWAYS(pExpr->x.pList!=0) ){
3173fef5208cSdrh     /* Case 2:     expr IN (exprlist)
3174fef5208cSdrh     **
3175e014a838Sdanielk1977     ** For each expression, build an index key from the evaluation and
3176e014a838Sdanielk1977     ** store it in the temporary table. If <expr> is a column, then use
3177e014a838Sdanielk1977     ** that columns affinity when building index keys. If <expr> is not
3178e014a838Sdanielk1977     ** a column, use numeric affinity.
3179fef5208cSdrh     */
318071c57db0Sdan     char affinity;            /* Affinity of the LHS of the IN */
3181e014a838Sdanielk1977     int i;
31826ab3a2ecSdanielk1977     ExprList *pList = pExpr->x.pList;
318357dbd7b3Sdrh     struct ExprList_item *pItem;
3184c324d446Sdan     int r1, r2;
318571c57db0Sdan     affinity = sqlite3ExprAffinity(pLeft);
318696fb16eeSdrh     if( affinity<=SQLITE_AFF_NONE ){
318705883a34Sdrh       affinity = SQLITE_AFF_BLOB;
318895b39590Sdrh     }else if( affinity==SQLITE_AFF_REAL ){
318995b39590Sdrh       affinity = SQLITE_AFF_NUMERIC;
3190e014a838Sdanielk1977     }
3191323df790Sdrh     if( pKeyInfo ){
31922ec2fb22Sdrh       assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
3193323df790Sdrh       pKeyInfo->aColl[0] = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
3194323df790Sdrh     }
3195e014a838Sdanielk1977 
3196e014a838Sdanielk1977     /* Loop through each expression in <exprlist>. */
31972d401ab8Sdrh     r1 = sqlite3GetTempReg(pParse);
31982d401ab8Sdrh     r2 = sqlite3GetTempReg(pParse);
319957dbd7b3Sdrh     for(i=pList->nExpr, pItem=pList->a; i>0; i--, pItem++){
320057dbd7b3Sdrh       Expr *pE2 = pItem->pExpr;
3201e014a838Sdanielk1977 
320257dbd7b3Sdrh       /* If the expression is not constant then we will need to
320357dbd7b3Sdrh       ** disable the test that was generated above that makes sure
320457dbd7b3Sdrh       ** this code only executes once.  Because for a non-constant
320557dbd7b3Sdrh       ** expression we need to rerun this code each time.
320657dbd7b3Sdrh       */
32072c04131cSdrh       if( addrOnce && !sqlite3ExprIsConstant(pE2) ){
32081902516dSdrh         sqlite3VdbeChangeToNoop(v, addrOnce-1);
32092c04131cSdrh         sqlite3VdbeChangeToNoop(v, addrOnce);
32107ac0e562Sdan         ExprClearProperty(pExpr, EP_Subrtn);
32112c04131cSdrh         addrOnce = 0;
32124794b980Sdrh       }
3213e014a838Sdanielk1977 
3214e014a838Sdanielk1977       /* Evaluate the expression and insert it into the temp table */
3215c324d446Sdan       sqlite3ExprCode(pParse, pE2, r1);
3216c324d446Sdan       sqlite3VdbeAddOp4(v, OP_MakeRecord, r1, 1, r2, &affinity, 1);
3217c324d446Sdan       sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iTab, r2, r1, 1);
3218fef5208cSdrh     }
32192d401ab8Sdrh     sqlite3ReleaseTempReg(pParse, r1);
32202d401ab8Sdrh     sqlite3ReleaseTempReg(pParse, r2);
3221fef5208cSdrh   }
3222323df790Sdrh   if( pKeyInfo ){
32232ec2fb22Sdrh     sqlite3VdbeChangeP4(v, addr, (void *)pKeyInfo, P4_KEYINFO);
322441a05b7bSdanielk1977   }
32252c04131cSdrh   if( addrOnce ){
32268b9a3d1fSdrh     sqlite3VdbeAddOp1(v, OP_NullRow, iTab);
32272c04131cSdrh     sqlite3VdbeJumpHere(v, addrOnce);
32282c04131cSdrh     /* Subroutine return */
3229477572b9Sdrh     assert( ExprUseYSub(pExpr) );
32301902516dSdrh     assert( sqlite3VdbeGetOp(v,pExpr->y.sub.iAddr-1)->opcode==OP_BeginSubrtn
32311902516dSdrh             || pParse->nErr );
32322bd9f44aSdrh     sqlite3VdbeAddOp3(v, OP_Return, pExpr->y.sub.regReturn,
32332bd9f44aSdrh                       pExpr->y.sub.iAddr, 1);
32342bd9f44aSdrh     VdbeCoverage(v);
32356d2566dfSdrh     sqlite3ClearTempRegCache(pParse);
323685bcdce2Sdrh   }
323785bcdce2Sdrh }
323885bcdce2Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
323985bcdce2Sdrh 
324085bcdce2Sdrh /*
324185bcdce2Sdrh ** Generate code for scalar subqueries used as a subquery expression
324285bcdce2Sdrh ** or EXISTS operator:
324385bcdce2Sdrh **
324485bcdce2Sdrh **     (SELECT a FROM b)          -- subquery
324585bcdce2Sdrh **     EXISTS (SELECT a FROM b)   -- EXISTS subquery
324685bcdce2Sdrh **
324785bcdce2Sdrh ** The pExpr parameter is the SELECT or EXISTS operator to be coded.
324885bcdce2Sdrh **
3249d86fe44aSdrh ** Return the register that holds the result.  For a multi-column SELECT,
325085bcdce2Sdrh ** the result is stored in a contiguous array of registers and the
325185bcdce2Sdrh ** return value is the register of the left-most result column.
325285bcdce2Sdrh ** Return 0 if an error occurs.
325385bcdce2Sdrh */
325485bcdce2Sdrh #ifndef SQLITE_OMIT_SUBQUERY
325585bcdce2Sdrh int sqlite3CodeSubselect(Parse *pParse, Expr *pExpr){
32562c04131cSdrh   int addrOnce = 0;           /* Address of OP_Once at top of subroutine */
325785bcdce2Sdrh   int rReg = 0;               /* Register storing resulting */
325885bcdce2Sdrh   Select *pSel;               /* SELECT statement to encode */
325985bcdce2Sdrh   SelectDest dest;            /* How to deal with SELECT result */
326085bcdce2Sdrh   int nReg;                   /* Registers to allocate */
326185bcdce2Sdrh   Expr *pLimit;               /* New limit expression */
32622c04131cSdrh 
32632c04131cSdrh   Vdbe *v = pParse->pVdbe;
326485bcdce2Sdrh   assert( v!=0 );
326505428127Sdrh   if( pParse->nErr ) return 0;
3266bd462bccSdrh   testcase( pExpr->op==TK_EXISTS );
3267bd462bccSdrh   testcase( pExpr->op==TK_SELECT );
3268bd462bccSdrh   assert( pExpr->op==TK_EXISTS || pExpr->op==TK_SELECT );
3269a4eeccdfSdrh   assert( ExprUseXSelect(pExpr) );
3270bd462bccSdrh   pSel = pExpr->x.pSelect;
327185bcdce2Sdrh 
32725198ff57Sdrh   /* If this routine has already been coded, then invoke it as a
32735198ff57Sdrh   ** subroutine. */
32745198ff57Sdrh   if( ExprHasProperty(pExpr, EP_Subrtn) ){
3275bd462bccSdrh     ExplainQueryPlan((pParse, 0, "REUSE SUBQUERY %d", pSel->selId));
3276477572b9Sdrh     assert( ExprUseYSub(pExpr) );
32775198ff57Sdrh     sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
32785198ff57Sdrh                       pExpr->y.sub.iAddr);
32795198ff57Sdrh     return pExpr->iTable;
32805198ff57Sdrh   }
32815198ff57Sdrh 
32825198ff57Sdrh   /* Begin coding the subroutine */
3283477572b9Sdrh   assert( !ExprUseYWin(pExpr) );
3284477572b9Sdrh   assert( !ExprHasProperty(pExpr, EP_Reduced|EP_TokenOnly) );
32855198ff57Sdrh   ExprSetProperty(pExpr, EP_Subrtn);
32865198ff57Sdrh   pExpr->y.sub.regReturn = ++pParse->nMem;
32875198ff57Sdrh   pExpr->y.sub.iAddr =
32881902516dSdrh     sqlite3VdbeAddOp2(v, OP_BeginSubrtn, 0, pExpr->y.sub.regReturn) + 1;
328914c4d428Sdrh 
329014c4d428Sdrh   /* The evaluation of the EXISTS/SELECT must be repeated every time it
329114c4d428Sdrh   ** is encountered if any of the following is true:
329214c4d428Sdrh   **
329314c4d428Sdrh   **    *  The right-hand side is a correlated subquery
329414c4d428Sdrh   **    *  The right-hand side is an expression list containing variables
329514c4d428Sdrh   **    *  We are inside a trigger
329614c4d428Sdrh   **
329714c4d428Sdrh   ** If all of the above are false, then we can run this code just once
329814c4d428Sdrh   ** save the results, and reuse the same result on subsequent invocations.
329914c4d428Sdrh   */
330014c4d428Sdrh   if( !ExprHasProperty(pExpr, EP_VarSelect) ){
33012c04131cSdrh     addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
3302fef5208cSdrh   }
3303fef5208cSdrh 
330485bcdce2Sdrh   /* For a SELECT, generate code to put the values for all columns of
330539a11819Sdrh   ** the first row into an array of registers and return the index of
330639a11819Sdrh   ** the first register.
330739a11819Sdrh   **
330839a11819Sdrh   ** If this is an EXISTS, write an integer 0 (not exists) or 1 (exists)
330939a11819Sdrh   ** into a register and return that register number.
331039a11819Sdrh   **
331139a11819Sdrh   ** In both cases, the query is augmented with "LIMIT 1".  Any
331239a11819Sdrh   ** preexisting limit is discarded in place of the new LIMIT 1.
3313fef5208cSdrh   */
3314bd462bccSdrh   ExplainQueryPlan((pParse, 1, "%sSCALAR SUBQUERY %d",
3315bd462bccSdrh         addrOnce?"":"CORRELATED ", pSel->selId));
331671c57db0Sdan   nReg = pExpr->op==TK_SELECT ? pSel->pEList->nExpr : 1;
331771c57db0Sdan   sqlite3SelectDestInit(&dest, 0, pParse->nMem+1);
331871c57db0Sdan   pParse->nMem += nReg;
331951522cd3Sdrh   if( pExpr->op==TK_SELECT ){
33206c8c8ce0Sdanielk1977     dest.eDest = SRT_Mem;
332153932ce8Sdrh     dest.iSdst = dest.iSDParm;
332271c57db0Sdan     dest.nSdst = nReg;
332371c57db0Sdan     sqlite3VdbeAddOp3(v, OP_Null, 0, dest.iSDParm, dest.iSDParm+nReg-1);
3324d4e70ebdSdrh     VdbeComment((v, "Init subquery result"));
332551522cd3Sdrh   }else{
33266c8c8ce0Sdanielk1977     dest.eDest = SRT_Exists;
33272b596da8Sdrh     sqlite3VdbeAddOp2(v, OP_Integer, 0, dest.iSDParm);
3328d4e70ebdSdrh     VdbeComment((v, "Init EXISTS result"));
332951522cd3Sdrh   }
33308c0833fbSdrh   if( pSel->pLimit ){
33317ca1347fSdrh     /* The subquery already has a limit.  If the pre-existing limit is X
33327ca1347fSdrh     ** then make the new limit X<>0 so that the new limit is either 1 or 0 */
33337ca1347fSdrh     sqlite3 *db = pParse->db;
33345776ee5cSdrh     pLimit = sqlite3Expr(db, TK_INTEGER, "0");
33357ca1347fSdrh     if( pLimit ){
33367ca1347fSdrh       pLimit->affExpr = SQLITE_AFF_NUMERIC;
33377ca1347fSdrh       pLimit = sqlite3PExpr(pParse, TK_NE,
33387ca1347fSdrh                             sqlite3ExprDup(db, pSel->pLimit->pLeft, 0), pLimit);
33397ca1347fSdrh     }
334095530163Sdrh     sqlite3ExprDeferredDelete(pParse, pSel->pLimit->pLeft);
33418c0833fbSdrh     pSel->pLimit->pLeft = pLimit;
33428c0833fbSdrh   }else{
33437ca1347fSdrh     /* If there is no pre-existing limit add a limit of 1 */
33445776ee5cSdrh     pLimit = sqlite3Expr(pParse->db, TK_INTEGER, "1");
33458c0833fbSdrh     pSel->pLimit = sqlite3PExpr(pParse, TK_LIMIT, pLimit, 0);
33468c0833fbSdrh   }
334748b5b041Sdrh   pSel->iLimit = 0;
33487d10d5a6Sdrh   if( sqlite3Select(pParse, pSel, &dest) ){
3349bf7f3a00Sdrh     pExpr->op2 = pExpr->op;
3350bf7f3a00Sdrh     pExpr->op = TK_ERROR;
33511450bc6eSdrh     return 0;
335294ccde58Sdrh   }
33532c04131cSdrh   pExpr->iTable = rReg = dest.iSDParm;
3354ebb6a65dSdrh   ExprSetVVAProperty(pExpr, EP_NoReduce);
33552c04131cSdrh   if( addrOnce ){
33562c04131cSdrh     sqlite3VdbeJumpHere(v, addrOnce);
335714c4d428Sdrh   }
3358fc976065Sdanielk1977 
33592c04131cSdrh   /* Subroutine return */
3360477572b9Sdrh   assert( ExprUseYSub(pExpr) );
33611902516dSdrh   assert( sqlite3VdbeGetOp(v,pExpr->y.sub.iAddr-1)->opcode==OP_BeginSubrtn
33621902516dSdrh           || pParse->nErr );
33632bd9f44aSdrh   sqlite3VdbeAddOp3(v, OP_Return, pExpr->y.sub.regReturn,
33642bd9f44aSdrh                     pExpr->y.sub.iAddr, 1);
33652bd9f44aSdrh   VdbeCoverage(v);
33666d2566dfSdrh   sqlite3ClearTempRegCache(pParse);
33671450bc6eSdrh   return rReg;
3368cce7d176Sdrh }
336951522cd3Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
3370cce7d176Sdrh 
3371e3365e6cSdrh #ifndef SQLITE_OMIT_SUBQUERY
3372e3365e6cSdrh /*
33737b35a77bSdan ** Expr pIn is an IN(...) expression. This function checks that the
33747b35a77bSdan ** sub-select on the RHS of the IN() operator has the same number of
33757b35a77bSdan ** columns as the vector on the LHS. Or, if the RHS of the IN() is not
33767b35a77bSdan ** a sub-query, that the LHS is a vector of size 1.
33777b35a77bSdan */
33787b35a77bSdan int sqlite3ExprCheckIN(Parse *pParse, Expr *pIn){
33797b35a77bSdan   int nVector = sqlite3ExprVectorSize(pIn->pLeft);
3380a4eeccdfSdrh   if( ExprUseXSelect(pIn) && !pParse->db->mallocFailed ){
33817b35a77bSdan     if( nVector!=pIn->x.pSelect->pEList->nExpr ){
33827b35a77bSdan       sqlite3SubselectError(pParse, pIn->x.pSelect->pEList->nExpr, nVector);
33837b35a77bSdan       return 1;
33847b35a77bSdan     }
33857b35a77bSdan   }else if( nVector!=1 ){
338644c5604cSdan     sqlite3VectorErrorMsg(pParse, pIn->pLeft);
33877b35a77bSdan     return 1;
33887b35a77bSdan   }
33897b35a77bSdan   return 0;
33907b35a77bSdan }
33917b35a77bSdan #endif
33927b35a77bSdan 
33937b35a77bSdan #ifndef SQLITE_OMIT_SUBQUERY
33947b35a77bSdan /*
3395e3365e6cSdrh ** Generate code for an IN expression.
3396e3365e6cSdrh **
3397e3365e6cSdrh **      x IN (SELECT ...)
3398e3365e6cSdrh **      x IN (value, value, ...)
3399e3365e6cSdrh **
3400ecb87ac8Sdrh ** The left-hand side (LHS) is a scalar or vector expression.  The
3401e347d3e8Sdrh ** right-hand side (RHS) is an array of zero or more scalar values, or a
3402e347d3e8Sdrh ** subquery.  If the RHS is a subquery, the number of result columns must
3403e347d3e8Sdrh ** match the number of columns in the vector on the LHS.  If the RHS is
3404e347d3e8Sdrh ** a list of values, the LHS must be a scalar.
3405e347d3e8Sdrh **
3406e347d3e8Sdrh ** The IN operator is true if the LHS value is contained within the RHS.
3407e347d3e8Sdrh ** The result is false if the LHS is definitely not in the RHS.  The
3408e347d3e8Sdrh ** result is NULL if the presence of the LHS in the RHS cannot be
3409e347d3e8Sdrh ** determined due to NULLs.
3410e3365e6cSdrh **
34116be515ebSdrh ** This routine generates code that jumps to destIfFalse if the LHS is not
3412e3365e6cSdrh ** contained within the RHS.  If due to NULLs we cannot determine if the LHS
3413e3365e6cSdrh ** is contained in the RHS then jump to destIfNull.  If the LHS is contained
3414e3365e6cSdrh ** within the RHS then fall through.
3415ecb87ac8Sdrh **
3416ecb87ac8Sdrh ** See the separate in-operator.md documentation file in the canonical
3417ecb87ac8Sdrh ** SQLite source tree for additional information.
3418e3365e6cSdrh */
3419e3365e6cSdrh static void sqlite3ExprCodeIN(
3420e3365e6cSdrh   Parse *pParse,        /* Parsing and code generating context */
3421e3365e6cSdrh   Expr *pExpr,          /* The IN expression */
3422e3365e6cSdrh   int destIfFalse,      /* Jump here if LHS is not contained in the RHS */
3423e3365e6cSdrh   int destIfNull        /* Jump here if the results are unknown due to NULLs */
3424e3365e6cSdrh ){
3425e3365e6cSdrh   int rRhsHasNull = 0;  /* Register that is true if RHS contains NULL values */
3426e3365e6cSdrh   int eType;            /* Type of the RHS */
3427e347d3e8Sdrh   int rLhs;             /* Register(s) holding the LHS values */
3428e347d3e8Sdrh   int rLhsOrig;         /* LHS values prior to reordering by aiMap[] */
3429e3365e6cSdrh   Vdbe *v;              /* Statement under construction */
3430ba00e30aSdan   int *aiMap = 0;       /* Map from vector field to index column */
3431ba00e30aSdan   char *zAff = 0;       /* Affinity string for comparisons */
3432ecb87ac8Sdrh   int nVector;          /* Size of vectors for this IN operator */
343312abf408Sdrh   int iDummy;           /* Dummy parameter to exprCodeVector() */
3434e347d3e8Sdrh   Expr *pLeft;          /* The LHS of the IN operator */
3435ecb87ac8Sdrh   int i;                /* loop counter */
3436e347d3e8Sdrh   int destStep2;        /* Where to jump when NULLs seen in step 2 */
3437e347d3e8Sdrh   int destStep6 = 0;    /* Start of code for Step 6 */
3438e347d3e8Sdrh   int addrTruthOp;      /* Address of opcode that determines the IN is true */
3439e347d3e8Sdrh   int destNotNull;      /* Jump here if a comparison is not true in step 6 */
3440e347d3e8Sdrh   int addrTop;          /* Top of the step-6 loop */
34412c04131cSdrh   int iTab = 0;         /* Index to use */
3442c59b4acfSdan   u8 okConstFactor = pParse->okConstFactor;
3443e3365e6cSdrh 
3444e7375bfaSdrh   assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
3445e347d3e8Sdrh   pLeft = pExpr->pLeft;
34467b35a77bSdan   if( sqlite3ExprCheckIN(pParse, pExpr) ) return;
3447553168c7Sdan   zAff = exprINAffinity(pParse, pExpr);
3448ba00e30aSdan   nVector = sqlite3ExprVectorSize(pExpr->pLeft);
3449ba00e30aSdan   aiMap = (int*)sqlite3DbMallocZero(
3450ba00e30aSdan       pParse->db, nVector*(sizeof(int) + sizeof(char)) + 1
3451ba00e30aSdan   );
3452e347d3e8Sdrh   if( pParse->db->mallocFailed ) goto sqlite3ExprCodeIN_oom_error;
34537b35a77bSdan 
3454ba00e30aSdan   /* Attempt to compute the RHS. After this step, if anything other than
34552c04131cSdrh   ** IN_INDEX_NOOP is returned, the table opened with cursor iTab
3456ba00e30aSdan   ** contains the values that make up the RHS. If IN_INDEX_NOOP is returned,
3457ba00e30aSdan   ** the RHS has not yet been coded.  */
3458e3365e6cSdrh   v = pParse->pVdbe;
3459e3365e6cSdrh   assert( v!=0 );       /* OOM detected prior to this routine */
3460e3365e6cSdrh   VdbeNoopComment((v, "begin IN expr"));
3461bb53ecb1Sdrh   eType = sqlite3FindInIndex(pParse, pExpr,
3462bb53ecb1Sdrh                              IN_INDEX_MEMBERSHIP | IN_INDEX_NOOP_OK,
34632c04131cSdrh                              destIfFalse==destIfNull ? 0 : &rRhsHasNull,
34642c04131cSdrh                              aiMap, &iTab);
3465e3365e6cSdrh 
3466ba00e30aSdan   assert( pParse->nErr || nVector==1 || eType==IN_INDEX_EPH
3467ba00e30aSdan        || eType==IN_INDEX_INDEX_ASC || eType==IN_INDEX_INDEX_DESC
3468ba00e30aSdan   );
3469ecb87ac8Sdrh #ifdef SQLITE_DEBUG
3470ecb87ac8Sdrh   /* Confirm that aiMap[] contains nVector integer values between 0 and
3471ecb87ac8Sdrh   ** nVector-1. */
3472ecb87ac8Sdrh   for(i=0; i<nVector; i++){
3473ecb87ac8Sdrh     int j, cnt;
3474ecb87ac8Sdrh     for(cnt=j=0; j<nVector; j++) if( aiMap[j]==i ) cnt++;
3475ecb87ac8Sdrh     assert( cnt==1 );
3476ecb87ac8Sdrh   }
3477ecb87ac8Sdrh #endif
3478e3365e6cSdrh 
3479ba00e30aSdan   /* Code the LHS, the <expr> from "<expr> IN (...)". If the LHS is a
3480ba00e30aSdan   ** vector, then it is stored in an array of nVector registers starting
3481ba00e30aSdan   ** at r1.
3482e347d3e8Sdrh   **
3483e347d3e8Sdrh   ** sqlite3FindInIndex() might have reordered the fields of the LHS vector
3484e347d3e8Sdrh   ** so that the fields are in the same order as an existing index.   The
3485e347d3e8Sdrh   ** aiMap[] array contains a mapping from the original LHS field order to
3486e347d3e8Sdrh   ** the field order that matches the RHS index.
3487c59b4acfSdan   **
3488c59b4acfSdan   ** Avoid factoring the LHS of the IN(...) expression out of the loop,
3489c59b4acfSdan   ** even if it is constant, as OP_Affinity may be used on the register
3490c59b4acfSdan   ** by code generated below.  */
3491c59b4acfSdan   assert( pParse->okConstFactor==okConstFactor );
3492c59b4acfSdan   pParse->okConstFactor = 0;
3493e347d3e8Sdrh   rLhsOrig = exprCodeVector(pParse, pLeft, &iDummy);
3494c59b4acfSdan   pParse->okConstFactor = okConstFactor;
3495e347d3e8Sdrh   for(i=0; i<nVector && aiMap[i]==i; i++){} /* Are LHS fields reordered? */
3496ecb87ac8Sdrh   if( i==nVector ){
3497e347d3e8Sdrh     /* LHS fields are not reordered */
3498e347d3e8Sdrh     rLhs = rLhsOrig;
3499ecb87ac8Sdrh   }else{
3500ecb87ac8Sdrh     /* Need to reorder the LHS fields according to aiMap */
3501e347d3e8Sdrh     rLhs = sqlite3GetTempRange(pParse, nVector);
3502ba00e30aSdan     for(i=0; i<nVector; i++){
3503e347d3e8Sdrh       sqlite3VdbeAddOp3(v, OP_Copy, rLhsOrig+i, rLhs+aiMap[i], 0);
3504ba00e30aSdan     }
3505ecb87ac8Sdrh   }
3506e3365e6cSdrh 
3507bb53ecb1Sdrh   /* If sqlite3FindInIndex() did not find or create an index that is
3508bb53ecb1Sdrh   ** suitable for evaluating the IN operator, then evaluate using a
3509bb53ecb1Sdrh   ** sequence of comparisons.
3510e347d3e8Sdrh   **
3511e347d3e8Sdrh   ** This is step (1) in the in-operator.md optimized algorithm.
3512bb53ecb1Sdrh   */
3513bb53ecb1Sdrh   if( eType==IN_INDEX_NOOP ){
3514a4eeccdfSdrh     ExprList *pList;
3515a4eeccdfSdrh     CollSeq *pColl;
3516ec4ccdbcSdrh     int labelOk = sqlite3VdbeMakeLabel(pParse);
3517bb53ecb1Sdrh     int r2, regToFree;
3518bb53ecb1Sdrh     int regCkNull = 0;
3519bb53ecb1Sdrh     int ii;
3520a4eeccdfSdrh     assert( ExprUseXList(pExpr) );
3521a4eeccdfSdrh     pList = pExpr->x.pList;
3522a4eeccdfSdrh     pColl = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
3523bb53ecb1Sdrh     if( destIfNull!=destIfFalse ){
3524bb53ecb1Sdrh       regCkNull = sqlite3GetTempReg(pParse);
3525e347d3e8Sdrh       sqlite3VdbeAddOp3(v, OP_BitAnd, rLhs, rLhs, regCkNull);
3526bb53ecb1Sdrh     }
3527bb53ecb1Sdrh     for(ii=0; ii<pList->nExpr; ii++){
35284fc83654Sdrh       r2 = sqlite3ExprCodeTemp(pParse, pList->a[ii].pExpr, &regToFree);
3529a976979bSdrh       if( regCkNull && sqlite3ExprCanBeNull(pList->a[ii].pExpr) ){
3530bb53ecb1Sdrh         sqlite3VdbeAddOp3(v, OP_BitAnd, regCkNull, r2, regCkNull);
3531bb53ecb1Sdrh       }
3532f6ea97eaSdrh       sqlite3ReleaseTempReg(pParse, regToFree);
3533bb53ecb1Sdrh       if( ii<pList->nExpr-1 || destIfNull!=destIfFalse ){
35344799488eSdrh         int op = rLhs!=r2 ? OP_Eq : OP_NotNull;
35354799488eSdrh         sqlite3VdbeAddOp4(v, op, rLhs, labelOk, r2,
35364336b0e6Sdrh                           (void*)pColl, P4_COLLSEQ);
35374799488eSdrh         VdbeCoverageIf(v, ii<pList->nExpr-1 && op==OP_Eq);
35384799488eSdrh         VdbeCoverageIf(v, ii==pList->nExpr-1 && op==OP_Eq);
35394799488eSdrh         VdbeCoverageIf(v, ii<pList->nExpr-1 && op==OP_NotNull);
35404799488eSdrh         VdbeCoverageIf(v, ii==pList->nExpr-1 && op==OP_NotNull);
3541ba00e30aSdan         sqlite3VdbeChangeP5(v, zAff[0]);
3542bb53ecb1Sdrh       }else{
35434799488eSdrh         int op = rLhs!=r2 ? OP_Ne : OP_IsNull;
3544bb53ecb1Sdrh         assert( destIfNull==destIfFalse );
35454799488eSdrh         sqlite3VdbeAddOp4(v, op, rLhs, destIfFalse, r2,
35464799488eSdrh                           (void*)pColl, P4_COLLSEQ);
35474799488eSdrh         VdbeCoverageIf(v, op==OP_Ne);
35484799488eSdrh         VdbeCoverageIf(v, op==OP_IsNull);
3549ba00e30aSdan         sqlite3VdbeChangeP5(v, zAff[0] | SQLITE_JUMPIFNULL);
3550bb53ecb1Sdrh       }
3551bb53ecb1Sdrh     }
3552bb53ecb1Sdrh     if( regCkNull ){
3553bb53ecb1Sdrh       sqlite3VdbeAddOp2(v, OP_IsNull, regCkNull, destIfNull); VdbeCoverage(v);
3554076e85f5Sdrh       sqlite3VdbeGoto(v, destIfFalse);
3555bb53ecb1Sdrh     }
3556bb53ecb1Sdrh     sqlite3VdbeResolveLabel(v, labelOk);
3557bb53ecb1Sdrh     sqlite3ReleaseTempReg(pParse, regCkNull);
3558e347d3e8Sdrh     goto sqlite3ExprCodeIN_finished;
3559e347d3e8Sdrh   }
3560bb53ecb1Sdrh 
3561e347d3e8Sdrh   /* Step 2: Check to see if the LHS contains any NULL columns.  If the
3562e347d3e8Sdrh   ** LHS does contain NULLs then the result must be either FALSE or NULL.
3563e347d3e8Sdrh   ** We will then skip the binary search of the RHS.
3564e347d3e8Sdrh   */
3565094430ebSdrh   if( destIfNull==destIfFalse ){
3566e347d3e8Sdrh     destStep2 = destIfFalse;
3567e347d3e8Sdrh   }else{
3568ec4ccdbcSdrh     destStep2 = destStep6 = sqlite3VdbeMakeLabel(pParse);
3569e347d3e8Sdrh   }
3570d49fd4e8Sdan   for(i=0; i<nVector; i++){
3571fc7f27b9Sdrh     Expr *p = sqlite3VectorFieldSubexpr(pExpr->pLeft, i);
35721da88b5cSdrh     if( pParse->nErr ) goto sqlite3ExprCodeIN_oom_error;
3573d49fd4e8Sdan     if( sqlite3ExprCanBeNull(p) ){
3574e347d3e8Sdrh       sqlite3VdbeAddOp2(v, OP_IsNull, rLhs+i, destStep2);
3575471b4b92Sdrh       VdbeCoverage(v);
3576d49fd4e8Sdan     }
3577d49fd4e8Sdan   }
3578e3365e6cSdrh 
3579e347d3e8Sdrh   /* Step 3.  The LHS is now known to be non-NULL.  Do the binary search
3580e347d3e8Sdrh   ** of the RHS using the LHS as a probe.  If found, the result is
3581e347d3e8Sdrh   ** true.
3582e347d3e8Sdrh   */
3583e3365e6cSdrh   if( eType==IN_INDEX_ROWID ){
3584e347d3e8Sdrh     /* In this case, the RHS is the ROWID of table b-tree and so we also
3585e347d3e8Sdrh     ** know that the RHS is non-NULL.  Hence, we combine steps 3 and 4
3586e347d3e8Sdrh     ** into a single opcode. */
35872c04131cSdrh     sqlite3VdbeAddOp3(v, OP_SeekRowid, iTab, destIfFalse, rLhs);
3588688852abSdrh     VdbeCoverage(v);
3589e347d3e8Sdrh     addrTruthOp = sqlite3VdbeAddOp0(v, OP_Goto);  /* Return True */
35907b35a77bSdan   }else{
3591e347d3e8Sdrh     sqlite3VdbeAddOp4(v, OP_Affinity, rLhs, nVector, 0, zAff, nVector);
3592e347d3e8Sdrh     if( destIfFalse==destIfNull ){
3593e347d3e8Sdrh       /* Combine Step 3 and Step 5 into a single opcode */
35942c04131cSdrh       sqlite3VdbeAddOp4Int(v, OP_NotFound, iTab, destIfFalse,
3595e347d3e8Sdrh                            rLhs, nVector); VdbeCoverage(v);
3596e347d3e8Sdrh       goto sqlite3ExprCodeIN_finished;
3597e347d3e8Sdrh     }
3598e347d3e8Sdrh     /* Ordinary Step 3, for the case where FALSE and NULL are distinct */
35992c04131cSdrh     addrTruthOp = sqlite3VdbeAddOp4Int(v, OP_Found, iTab, 0,
3600e347d3e8Sdrh                                       rLhs, nVector); VdbeCoverage(v);
3601e347d3e8Sdrh   }
3602ba00e30aSdan 
3603e347d3e8Sdrh   /* Step 4.  If the RHS is known to be non-NULL and we did not find
3604e347d3e8Sdrh   ** an match on the search above, then the result must be FALSE.
3605e347d3e8Sdrh   */
3606e347d3e8Sdrh   if( rRhsHasNull && nVector==1 ){
3607e347d3e8Sdrh     sqlite3VdbeAddOp2(v, OP_NotNull, rRhsHasNull, destIfFalse);
3608471b4b92Sdrh     VdbeCoverage(v);
3609e347d3e8Sdrh   }
36107b35a77bSdan 
3611e347d3e8Sdrh   /* Step 5.  If we do not care about the difference between NULL and
3612e347d3e8Sdrh   ** FALSE, then just return false.
3613e347d3e8Sdrh   */
3614e347d3e8Sdrh   if( destIfFalse==destIfNull ) sqlite3VdbeGoto(v, destIfFalse);
3615e347d3e8Sdrh 
3616e347d3e8Sdrh   /* Step 6: Loop through rows of the RHS.  Compare each row to the LHS.
3617e347d3e8Sdrh   ** If any comparison is NULL, then the result is NULL.  If all
3618e347d3e8Sdrh   ** comparisons are FALSE then the final result is FALSE.
3619e347d3e8Sdrh   **
3620e347d3e8Sdrh   ** For a scalar LHS, it is sufficient to check just the first row
3621e347d3e8Sdrh   ** of the RHS.
3622e347d3e8Sdrh   */
3623e347d3e8Sdrh   if( destStep6 ) sqlite3VdbeResolveLabel(v, destStep6);
36242c04131cSdrh   addrTop = sqlite3VdbeAddOp2(v, OP_Rewind, iTab, destIfFalse);
3625471b4b92Sdrh   VdbeCoverage(v);
3626e347d3e8Sdrh   if( nVector>1 ){
3627ec4ccdbcSdrh     destNotNull = sqlite3VdbeMakeLabel(pParse);
3628e347d3e8Sdrh   }else{
3629e347d3e8Sdrh     /* For nVector==1, combine steps 6 and 7 by immediately returning
3630e347d3e8Sdrh     ** FALSE if the first comparison is not NULL */
3631e347d3e8Sdrh     destNotNull = destIfFalse;
3632e347d3e8Sdrh   }
3633ba00e30aSdan   for(i=0; i<nVector; i++){
3634ba00e30aSdan     Expr *p;
3635ba00e30aSdan     CollSeq *pColl;
3636e347d3e8Sdrh     int r3 = sqlite3GetTempReg(pParse);
3637fc7f27b9Sdrh     p = sqlite3VectorFieldSubexpr(pLeft, i);
3638ba00e30aSdan     pColl = sqlite3ExprCollSeq(pParse, p);
36392c04131cSdrh     sqlite3VdbeAddOp3(v, OP_Column, iTab, i, r3);
3640e347d3e8Sdrh     sqlite3VdbeAddOp4(v, OP_Ne, rLhs+i, destNotNull, r3,
364118016ad2Sdrh                       (void*)pColl, P4_COLLSEQ);
3642471b4b92Sdrh     VdbeCoverage(v);
3643e347d3e8Sdrh     sqlite3ReleaseTempReg(pParse, r3);
36447b35a77bSdan   }
36457b35a77bSdan   sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfNull);
3646e347d3e8Sdrh   if( nVector>1 ){
3647e347d3e8Sdrh     sqlite3VdbeResolveLabel(v, destNotNull);
36482c04131cSdrh     sqlite3VdbeAddOp2(v, OP_Next, iTab, addrTop+1);
364918016ad2Sdrh     VdbeCoverage(v);
3650e347d3e8Sdrh 
3651e347d3e8Sdrh     /* Step 7:  If we reach this point, we know that the result must
3652e347d3e8Sdrh     ** be false. */
365318016ad2Sdrh     sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfFalse);
36547b35a77bSdan   }
36557b35a77bSdan 
3656e347d3e8Sdrh   /* Jumps here in order to return true. */
3657e347d3e8Sdrh   sqlite3VdbeJumpHere(v, addrTruthOp);
3658e3365e6cSdrh 
3659e347d3e8Sdrh sqlite3ExprCodeIN_finished:
3660e347d3e8Sdrh   if( rLhs!=rLhsOrig ) sqlite3ReleaseTempReg(pParse, rLhs);
3661ecb87ac8Sdrh   VdbeComment((v, "end IN expr"));
3662e347d3e8Sdrh sqlite3ExprCodeIN_oom_error:
3663ba00e30aSdan   sqlite3DbFree(pParse->db, aiMap);
3664553168c7Sdan   sqlite3DbFree(pParse->db, zAff);
3665e3365e6cSdrh }
3666e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
3667e3365e6cSdrh 
366813573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
3669598f1340Sdrh /*
3670598f1340Sdrh ** Generate an instruction that will put the floating point
36719cbf3425Sdrh ** value described by z[0..n-1] into register iMem.
36720cf19ed8Sdrh **
36730cf19ed8Sdrh ** The z[] string will probably not be zero-terminated.  But the
36740cf19ed8Sdrh ** z[n] character is guaranteed to be something that does not look
36750cf19ed8Sdrh ** like the continuation of the number.
3676598f1340Sdrh */
3677b7916a78Sdrh static void codeReal(Vdbe *v, const char *z, int negateFlag, int iMem){
3678fd773cf9Sdrh   if( ALWAYS(z!=0) ){
3679598f1340Sdrh     double value;
36809339da1fSdrh     sqlite3AtoF(z, &value, sqlite3Strlen30(z), SQLITE_UTF8);
3681d0015161Sdrh     assert( !sqlite3IsNaN(value) ); /* The new AtoF never returns NaN */
3682598f1340Sdrh     if( negateFlag ) value = -value;
368397bae794Sdrh     sqlite3VdbeAddOp4Dup8(v, OP_Real, 0, iMem, 0, (u8*)&value, P4_REAL);
3684598f1340Sdrh   }
3685598f1340Sdrh }
368613573c71Sdrh #endif
3687598f1340Sdrh 
3688598f1340Sdrh 
3689598f1340Sdrh /*
3690fec19aadSdrh ** Generate an instruction that will put the integer describe by
36919cbf3425Sdrh ** text z[0..n-1] into register iMem.
36920cf19ed8Sdrh **
36935f1d6b61Sshaneh ** Expr.u.zToken is always UTF8 and zero-terminated.
3694fec19aadSdrh */
369513573c71Sdrh static void codeInteger(Parse *pParse, Expr *pExpr, int negFlag, int iMem){
369613573c71Sdrh   Vdbe *v = pParse->pVdbe;
369792b01d53Sdrh   if( pExpr->flags & EP_IntValue ){
369833e619fcSdrh     int i = pExpr->u.iValue;
3699d50ffc41Sdrh     assert( i>=0 );
370092b01d53Sdrh     if( negFlag ) i = -i;
370192b01d53Sdrh     sqlite3VdbeAddOp2(v, OP_Integer, i, iMem);
3702fd773cf9Sdrh   }else{
37035f1d6b61Sshaneh     int c;
37045f1d6b61Sshaneh     i64 value;
3705fd773cf9Sdrh     const char *z = pExpr->u.zToken;
3706fd773cf9Sdrh     assert( z!=0 );
37079296c18aSdrh     c = sqlite3DecOrHexToI64(z, &value);
370884d4f1a3Sdrh     if( (c==3 && !negFlag) || (c==2) || (negFlag && value==SMALLEST_INT64)){
370913573c71Sdrh #ifdef SQLITE_OMIT_FLOATING_POINT
371062fc069eSdrh       sqlite3ErrorMsg(pParse, "oversized integer: %s%#T", negFlag?"-":"",pExpr);
371113573c71Sdrh #else
37121b7ddc59Sdrh #ifndef SQLITE_OMIT_HEX_INTEGER
37139296c18aSdrh       if( sqlite3_strnicmp(z,"0x",2)==0 ){
371462fc069eSdrh         sqlite3ErrorMsg(pParse, "hex literal too big: %s%#T",
371562fc069eSdrh                         negFlag?"-":"",pExpr);
37161b7ddc59Sdrh       }else
37171b7ddc59Sdrh #endif
37181b7ddc59Sdrh       {
3719b7916a78Sdrh         codeReal(v, z, negFlag, iMem);
37209296c18aSdrh       }
372113573c71Sdrh #endif
372277320ea4Sdrh     }else{
372384d4f1a3Sdrh       if( negFlag ){ value = c==3 ? SMALLEST_INT64 : -value; }
372477320ea4Sdrh       sqlite3VdbeAddOp4Dup8(v, OP_Int64, 0, iMem, 0, (u8*)&value, P4_INT64);
3725fec19aadSdrh     }
3726fec19aadSdrh   }
3727c9cf901dSdanielk1977 }
3728fec19aadSdrh 
37295cd79239Sdrh 
37301f9ca2c8Sdrh /* Generate code that will load into register regOut a value that is
37311f9ca2c8Sdrh ** appropriate for the iIdxCol-th column of index pIdx.
37321f9ca2c8Sdrh */
37331f9ca2c8Sdrh void sqlite3ExprCodeLoadIndexColumn(
37341f9ca2c8Sdrh   Parse *pParse,  /* The parsing context */
37351f9ca2c8Sdrh   Index *pIdx,    /* The index whose column is to be loaded */
37361f9ca2c8Sdrh   int iTabCur,    /* Cursor pointing to a table row */
37371f9ca2c8Sdrh   int iIdxCol,    /* The column of the index to be loaded */
37381f9ca2c8Sdrh   int regOut      /* Store the index column value in this register */
37391f9ca2c8Sdrh ){
37401f9ca2c8Sdrh   i16 iTabCol = pIdx->aiColumn[iIdxCol];
37414b92f98cSdrh   if( iTabCol==XN_EXPR ){
37421f9ca2c8Sdrh     assert( pIdx->aColExpr );
37431f9ca2c8Sdrh     assert( pIdx->aColExpr->nExpr>iIdxCol );
37443e34eabcSdrh     pParse->iSelfTab = iTabCur + 1;
37451c75c9d7Sdrh     sqlite3ExprCodeCopy(pParse, pIdx->aColExpr->a[iIdxCol].pExpr, regOut);
37463e34eabcSdrh     pParse->iSelfTab = 0;
37474b92f98cSdrh   }else{
37486df9c4b9Sdrh     sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pIdx->pTable, iTabCur,
37494b92f98cSdrh                                     iTabCol, regOut);
37504b92f98cSdrh   }
37511f9ca2c8Sdrh }
37521f9ca2c8Sdrh 
3753e70fa7feSdrh #ifndef SQLITE_OMIT_GENERATED_COLUMNS
3754e70fa7feSdrh /*
3755e70fa7feSdrh ** Generate code that will compute the value of generated column pCol
3756e70fa7feSdrh ** and store the result in register regOut
3757e70fa7feSdrh */
3758e70fa7feSdrh void sqlite3ExprCodeGeneratedColumn(
375979cf2b71Sdrh   Parse *pParse,     /* Parsing context */
376079cf2b71Sdrh   Table *pTab,       /* Table containing the generated column */
376179cf2b71Sdrh   Column *pCol,      /* The generated column */
376279cf2b71Sdrh   int regOut         /* Put the result in this register */
3763e70fa7feSdrh ){
37644dad7ed5Sdrh   int iAddr;
37654dad7ed5Sdrh   Vdbe *v = pParse->pVdbe;
37664dad7ed5Sdrh   assert( v!=0 );
37674dad7ed5Sdrh   assert( pParse->iSelfTab!=0 );
37684dad7ed5Sdrh   if( pParse->iSelfTab>0 ){
37694dad7ed5Sdrh     iAddr = sqlite3VdbeAddOp3(v, OP_IfNullRow, pParse->iSelfTab-1, 0, regOut);
37704dad7ed5Sdrh   }else{
37714dad7ed5Sdrh     iAddr = 0;
37724dad7ed5Sdrh   }
377379cf2b71Sdrh   sqlite3ExprCodeCopy(pParse, sqlite3ColumnExpr(pTab,pCol), regOut);
3774e70fa7feSdrh   if( pCol->affinity>=SQLITE_AFF_TEXT ){
37754dad7ed5Sdrh     sqlite3VdbeAddOp4(v, OP_Affinity, regOut, 1, 0, &pCol->affinity, 1);
3776e70fa7feSdrh   }
37774dad7ed5Sdrh   if( iAddr ) sqlite3VdbeJumpHere(v, iAddr);
3778e70fa7feSdrh }
3779e70fa7feSdrh #endif /* SQLITE_OMIT_GENERATED_COLUMNS */
3780e70fa7feSdrh 
37815cd79239Sdrh /*
37825c092e8aSdrh ** Generate code to extract the value of the iCol-th column of a table.
37835c092e8aSdrh */
37845c092e8aSdrh void sqlite3ExprCodeGetColumnOfTable(
37856df9c4b9Sdrh   Vdbe *v,        /* Parsing context */
37865c092e8aSdrh   Table *pTab,    /* The table containing the value */
3787313619f5Sdrh   int iTabCur,    /* The table cursor.  Or the PK cursor for WITHOUT ROWID */
37885c092e8aSdrh   int iCol,       /* Index of the column to extract */
3789313619f5Sdrh   int regOut      /* Extract the value into this register */
37905c092e8aSdrh ){
3791ab45fc04Sdrh   Column *pCol;
379281f7b372Sdrh   assert( v!=0 );
3793aca19e19Sdrh   if( pTab==0 ){
3794aca19e19Sdrh     sqlite3VdbeAddOp3(v, OP_Column, iTabCur, iCol, regOut);
3795aca19e19Sdrh     return;
3796aca19e19Sdrh   }
37975c092e8aSdrh   if( iCol<0 || iCol==pTab->iPKey ){
37985c092e8aSdrh     sqlite3VdbeAddOp2(v, OP_Rowid, iTabCur, regOut);
3799088b615aSdrh     VdbeComment((v, "%s.rowid", pTab->zName));
38005c092e8aSdrh   }else{
380181f7b372Sdrh     int op;
380281f7b372Sdrh     int x;
380381f7b372Sdrh     if( IsVirtual(pTab) ){
380481f7b372Sdrh       op = OP_VColumn;
380581f7b372Sdrh       x = iCol;
380681f7b372Sdrh #ifndef SQLITE_OMIT_GENERATED_COLUMNS
3807ab45fc04Sdrh     }else if( (pCol = &pTab->aCol[iCol])->colFlags & COLFLAG_VIRTUAL ){
38086df9c4b9Sdrh       Parse *pParse = sqlite3VdbeParser(v);
3809ab45fc04Sdrh       if( pCol->colFlags & COLFLAG_BUSY ){
3810cf9d36d1Sdrh         sqlite3ErrorMsg(pParse, "generated column loop on \"%s\"",
3811cf9d36d1Sdrh                         pCol->zCnName);
3812ab45fc04Sdrh       }else{
381381f7b372Sdrh         int savedSelfTab = pParse->iSelfTab;
3814ab45fc04Sdrh         pCol->colFlags |= COLFLAG_BUSY;
381581f7b372Sdrh         pParse->iSelfTab = iTabCur+1;
381679cf2b71Sdrh         sqlite3ExprCodeGeneratedColumn(pParse, pTab, pCol, regOut);
381781f7b372Sdrh         pParse->iSelfTab = savedSelfTab;
3818ab45fc04Sdrh         pCol->colFlags &= ~COLFLAG_BUSY;
3819ab45fc04Sdrh       }
382081f7b372Sdrh       return;
382181f7b372Sdrh #endif
382281f7b372Sdrh     }else if( !HasRowid(pTab) ){
3823c5f808d8Sdrh       testcase( iCol!=sqlite3TableColumnToStorage(pTab, iCol) );
3824b9bcf7caSdrh       x = sqlite3TableColumnToIndex(sqlite3PrimaryKeyIndex(pTab), iCol);
382581f7b372Sdrh       op = OP_Column;
382681f7b372Sdrh     }else{
3827b9bcf7caSdrh       x = sqlite3TableColumnToStorage(pTab,iCol);
3828c5f808d8Sdrh       testcase( x!=iCol );
382981f7b372Sdrh       op = OP_Column;
3830ee0ec8e1Sdrh     }
3831ee0ec8e1Sdrh     sqlite3VdbeAddOp3(v, op, iTabCur, x, regOut);
38325c092e8aSdrh     sqlite3ColumnDefault(v, pTab, iCol, regOut);
38335c092e8aSdrh   }
38345c092e8aSdrh }
38355c092e8aSdrh 
38365c092e8aSdrh /*
3837945498f3Sdrh ** Generate code that will extract the iColumn-th column from
38388c607191Sdrh ** table pTab and store the column value in register iReg.
3839e55cbd72Sdrh **
3840e55cbd72Sdrh ** There must be an open cursor to pTab in iTable when this routine
3841e55cbd72Sdrh ** is called.  If iColumn<0 then code is generated that extracts the rowid.
3842945498f3Sdrh */
3843e55cbd72Sdrh int sqlite3ExprCodeGetColumn(
3844e55cbd72Sdrh   Parse *pParse,   /* Parsing and code generating context */
38452133d822Sdrh   Table *pTab,     /* Description of the table we are reading from */
38462133d822Sdrh   int iColumn,     /* Index of the table column */
38472133d822Sdrh   int iTable,      /* The cursor pointing to the table */
3848a748fdccSdrh   int iReg,        /* Store results here */
3849ce78bc6eSdrh   u8 p5            /* P5 value for OP_Column + FLAGS */
38502133d822Sdrh ){
385181f7b372Sdrh   assert( pParse->pVdbe!=0 );
38526df9c4b9Sdrh   sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pTab, iTable, iColumn, iReg);
3853a748fdccSdrh   if( p5 ){
3854058e9950Sdrh     VdbeOp *pOp = sqlite3VdbeGetLastOp(pParse->pVdbe);
385599670abbSdrh     if( pOp->opcode==OP_Column ) pOp->p5 = p5;
3856a748fdccSdrh   }
3857e55cbd72Sdrh   return iReg;
3858e55cbd72Sdrh }
3859e55cbd72Sdrh 
3860e55cbd72Sdrh /*
3861b21e7c70Sdrh ** Generate code to move content from registers iFrom...iFrom+nReg-1
386236a5d88dSdrh ** over to iTo..iTo+nReg-1.
3863e55cbd72Sdrh */
3864b21e7c70Sdrh void sqlite3ExprCodeMove(Parse *pParse, int iFrom, int iTo, int nReg){
3865079a3072Sdrh   sqlite3VdbeAddOp3(pParse->pVdbe, OP_Move, iFrom, iTo, nReg);
3866945498f3Sdrh }
3867945498f3Sdrh 
3868652fbf55Sdrh /*
386912abf408Sdrh ** Convert a scalar expression node to a TK_REGISTER referencing
387012abf408Sdrh ** register iReg.  The caller must ensure that iReg already contains
387112abf408Sdrh ** the correct value for the expression.
3872a4c3c87eSdrh */
3873069d1b1fSdan static void exprToRegister(Expr *pExpr, int iReg){
38740d950af3Sdrh   Expr *p = sqlite3ExprSkipCollateAndLikely(pExpr);
3875235667a8Sdrh   if( NEVER(p==0) ) return;
3876a4c3c87eSdrh   p->op2 = p->op;
3877a4c3c87eSdrh   p->op = TK_REGISTER;
3878a4c3c87eSdrh   p->iTable = iReg;
3879a4c3c87eSdrh   ExprClearProperty(p, EP_Skip);
3880a4c3c87eSdrh }
3881a4c3c87eSdrh 
388212abf408Sdrh /*
388312abf408Sdrh ** Evaluate an expression (either a vector or a scalar expression) and store
388412abf408Sdrh ** the result in continguous temporary registers.  Return the index of
388512abf408Sdrh ** the first register used to store the result.
388612abf408Sdrh **
388712abf408Sdrh ** If the returned result register is a temporary scalar, then also write
388812abf408Sdrh ** that register number into *piFreeable.  If the returned result register
388912abf408Sdrh ** is not a temporary or if the expression is a vector set *piFreeable
389012abf408Sdrh ** to 0.
389112abf408Sdrh */
389212abf408Sdrh static int exprCodeVector(Parse *pParse, Expr *p, int *piFreeable){
389312abf408Sdrh   int iResult;
389412abf408Sdrh   int nResult = sqlite3ExprVectorSize(p);
389512abf408Sdrh   if( nResult==1 ){
389612abf408Sdrh     iResult = sqlite3ExprCodeTemp(pParse, p, piFreeable);
389712abf408Sdrh   }else{
389812abf408Sdrh     *piFreeable = 0;
389912abf408Sdrh     if( p->op==TK_SELECT ){
3900dd1bb43aSdrh #if SQLITE_OMIT_SUBQUERY
3901dd1bb43aSdrh       iResult = 0;
3902dd1bb43aSdrh #else
390385bcdce2Sdrh       iResult = sqlite3CodeSubselect(pParse, p);
3904dd1bb43aSdrh #endif
390512abf408Sdrh     }else{
390612abf408Sdrh       int i;
390712abf408Sdrh       iResult = pParse->nMem+1;
390812abf408Sdrh       pParse->nMem += nResult;
3909a4eeccdfSdrh       assert( ExprUseXList(p) );
391012abf408Sdrh       for(i=0; i<nResult; i++){
39114b725240Sdan         sqlite3ExprCodeFactorable(pParse, p->x.pList->a[i].pExpr, i+iResult);
391212abf408Sdrh       }
391312abf408Sdrh     }
391412abf408Sdrh   }
391512abf408Sdrh   return iResult;
391612abf408Sdrh }
391712abf408Sdrh 
391825c4296bSdrh /*
391992a27f7bSdrh ** If the last opcode is a OP_Copy, then set the do-not-merge flag (p5)
392092a27f7bSdrh ** so that a subsequent copy will not be merged into this one.
392192a27f7bSdrh */
392292a27f7bSdrh static void setDoNotMergeFlagOnCopy(Vdbe *v){
3923058e9950Sdrh   if( sqlite3VdbeGetLastOp(v)->opcode==OP_Copy ){
392492a27f7bSdrh     sqlite3VdbeChangeP5(v, 1);  /* Tag trailing OP_Copy as not mergable */
392592a27f7bSdrh   }
392692a27f7bSdrh }
392792a27f7bSdrh 
392892a27f7bSdrh /*
392925c4296bSdrh ** Generate code to implement special SQL functions that are implemented
393025c4296bSdrh ** in-line rather than by using the usual callbacks.
393125c4296bSdrh */
393225c4296bSdrh static int exprCodeInlineFunction(
393325c4296bSdrh   Parse *pParse,        /* Parsing context */
393425c4296bSdrh   ExprList *pFarg,      /* List of function arguments */
393525c4296bSdrh   int iFuncId,          /* Function ID.  One of the INTFUNC_... values */
393625c4296bSdrh   int target            /* Store function result in this register */
393725c4296bSdrh ){
393825c4296bSdrh   int nFarg;
393925c4296bSdrh   Vdbe *v = pParse->pVdbe;
394025c4296bSdrh   assert( v!=0 );
394125c4296bSdrh   assert( pFarg!=0 );
394225c4296bSdrh   nFarg = pFarg->nExpr;
394325c4296bSdrh   assert( nFarg>0 );  /* All in-line functions have at least one argument */
394425c4296bSdrh   switch( iFuncId ){
394525c4296bSdrh     case INLINEFUNC_coalesce: {
394625c4296bSdrh       /* Attempt a direct implementation of the built-in COALESCE() and
394725c4296bSdrh       ** IFNULL() functions.  This avoids unnecessary evaluation of
394825c4296bSdrh       ** arguments past the first non-NULL argument.
394925c4296bSdrh       */
395025c4296bSdrh       int endCoalesce = sqlite3VdbeMakeLabel(pParse);
395125c4296bSdrh       int i;
395225c4296bSdrh       assert( nFarg>=2 );
395325c4296bSdrh       sqlite3ExprCode(pParse, pFarg->a[0].pExpr, target);
395425c4296bSdrh       for(i=1; i<nFarg; i++){
395525c4296bSdrh         sqlite3VdbeAddOp2(v, OP_NotNull, target, endCoalesce);
395625c4296bSdrh         VdbeCoverage(v);
395725c4296bSdrh         sqlite3ExprCode(pParse, pFarg->a[i].pExpr, target);
395825c4296bSdrh       }
395992a27f7bSdrh       setDoNotMergeFlagOnCopy(v);
396025c4296bSdrh       sqlite3VdbeResolveLabel(v, endCoalesce);
396125c4296bSdrh       break;
396225c4296bSdrh     }
39633c0e606bSdrh     case INLINEFUNC_iif: {
39643c0e606bSdrh       Expr caseExpr;
39653c0e606bSdrh       memset(&caseExpr, 0, sizeof(caseExpr));
39663c0e606bSdrh       caseExpr.op = TK_CASE;
39673c0e606bSdrh       caseExpr.x.pList = pFarg;
39683c0e606bSdrh       return sqlite3ExprCodeTarget(pParse, &caseExpr, target);
39693c0e606bSdrh     }
39706d013d89Sdrh #ifdef SQLITE_ENABLE_OFFSET_SQL_FUNC
3971645682a7Sdrh     case INLINEFUNC_sqlite_offset: {
3972645682a7Sdrh       Expr *pArg = pFarg->a[0].pExpr;
3973645682a7Sdrh       if( pArg->op==TK_COLUMN && pArg->iTable>=0 ){
3974645682a7Sdrh         sqlite3VdbeAddOp3(v, OP_Offset, pArg->iTable, pArg->iColumn, target);
3975645682a7Sdrh       }else{
3976645682a7Sdrh         sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3977645682a7Sdrh       }
3978645682a7Sdrh       break;
3979645682a7Sdrh     }
39806d013d89Sdrh #endif
3981171c50ecSdrh     default: {
398225c4296bSdrh       /* The UNLIKELY() function is a no-op.  The result is the value
398325c4296bSdrh       ** of the first argument.
398425c4296bSdrh       */
3985171c50ecSdrh       assert( nFarg==1 || nFarg==2 );
398625c4296bSdrh       target = sqlite3ExprCodeTarget(pParse, pFarg->a[0].pExpr, target);
398725c4296bSdrh       break;
398825c4296bSdrh     }
398925c4296bSdrh 
3990171c50ecSdrh   /***********************************************************************
3991171c50ecSdrh   ** Test-only SQL functions that are only usable if enabled
3992171c50ecSdrh   ** via SQLITE_TESTCTRL_INTERNAL_FUNCTIONS
3993171c50ecSdrh   */
39943780f9a4Sdrh #if !defined(SQLITE_UNTESTABLE)
3995171c50ecSdrh     case INLINEFUNC_expr_compare: {
3996171c50ecSdrh       /* Compare two expressions using sqlite3ExprCompare() */
3997171c50ecSdrh       assert( nFarg==2 );
3998171c50ecSdrh       sqlite3VdbeAddOp2(v, OP_Integer,
3999171c50ecSdrh          sqlite3ExprCompare(0,pFarg->a[0].pExpr, pFarg->a[1].pExpr,-1),
4000171c50ecSdrh          target);
4001171c50ecSdrh       break;
4002171c50ecSdrh     }
4003171c50ecSdrh 
4004171c50ecSdrh     case INLINEFUNC_expr_implies_expr: {
4005171c50ecSdrh       /* Compare two expressions using sqlite3ExprImpliesExpr() */
4006171c50ecSdrh       assert( nFarg==2 );
4007171c50ecSdrh       sqlite3VdbeAddOp2(v, OP_Integer,
4008171c50ecSdrh          sqlite3ExprImpliesExpr(pParse,pFarg->a[0].pExpr, pFarg->a[1].pExpr,-1),
4009171c50ecSdrh          target);
4010171c50ecSdrh       break;
4011171c50ecSdrh     }
4012171c50ecSdrh 
4013171c50ecSdrh     case INLINEFUNC_implies_nonnull_row: {
4014171c50ecSdrh       /* REsult of sqlite3ExprImpliesNonNullRow() */
4015171c50ecSdrh       Expr *pA1;
4016171c50ecSdrh       assert( nFarg==2 );
4017171c50ecSdrh       pA1 = pFarg->a[1].pExpr;
4018171c50ecSdrh       if( pA1->op==TK_COLUMN ){
4019171c50ecSdrh         sqlite3VdbeAddOp2(v, OP_Integer,
4020171c50ecSdrh            sqlite3ExprImpliesNonNullRow(pFarg->a[0].pExpr,pA1->iTable),
4021171c50ecSdrh            target);
4022171c50ecSdrh       }else{
4023171c50ecSdrh         sqlite3VdbeAddOp2(v, OP_Null, 0, target);
4024171c50ecSdrh       }
4025171c50ecSdrh       break;
4026171c50ecSdrh     }
4027171c50ecSdrh 
402825c4296bSdrh     case INLINEFUNC_affinity: {
402925c4296bSdrh       /* The AFFINITY() function evaluates to a string that describes
403025c4296bSdrh       ** the type affinity of the argument.  This is used for testing of
403125c4296bSdrh       ** the SQLite type logic.
403225c4296bSdrh       */
403325c4296bSdrh       const char *azAff[] = { "blob", "text", "numeric", "integer", "real" };
403425c4296bSdrh       char aff;
403525c4296bSdrh       assert( nFarg==1 );
403625c4296bSdrh       aff = sqlite3ExprAffinity(pFarg->a[0].pExpr);
403725c4296bSdrh       sqlite3VdbeLoadString(v, target,
403825c4296bSdrh               (aff<=SQLITE_AFF_NONE) ? "none" : azAff[aff-SQLITE_AFF_BLOB]);
403925c4296bSdrh       break;
404025c4296bSdrh     }
40413780f9a4Sdrh #endif /* !defined(SQLITE_UNTESTABLE) */
404225c4296bSdrh   }
404325c4296bSdrh   return target;
404425c4296bSdrh }
404525c4296bSdrh 
404671c57db0Sdan 
4047a4c3c87eSdrh /*
4048cce7d176Sdrh ** Generate code into the current Vdbe to evaluate the given
40492dcef11bSdrh ** expression.  Attempt to store the results in register "target".
40502dcef11bSdrh ** Return the register where results are stored.
4051389a1adbSdrh **
40528b213899Sdrh ** With this routine, there is no guarantee that results will
40532dcef11bSdrh ** be stored in target.  The result might be stored in some other
40542dcef11bSdrh ** register if it is convenient to do so.  The calling function
40552dcef11bSdrh ** must check the return code and move the results to the desired
40562dcef11bSdrh ** register.
4057cce7d176Sdrh */
4058678ccce8Sdrh int sqlite3ExprCodeTarget(Parse *pParse, Expr *pExpr, int target){
40592dcef11bSdrh   Vdbe *v = pParse->pVdbe;  /* The VM under construction */
40602dcef11bSdrh   int op;                   /* The opcode being coded */
40612dcef11bSdrh   int inReg = target;       /* Results stored in register inReg */
40622dcef11bSdrh   int regFree1 = 0;         /* If non-zero free this temporary register */
40632dcef11bSdrh   int regFree2 = 0;         /* If non-zero free this temporary register */
40647b35a77bSdan   int r1, r2;               /* Various register numbers */
406510d1edf0Sdrh   Expr tempX;               /* Temporary expression node */
406671c57db0Sdan   int p5 = 0;
4067ffe07b2dSdrh 
40689cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
4069b639a209Sdrh   assert( v!=0 );
4070389a1adbSdrh 
40711efa8023Sdrh expr_code_doover:
4072389a1adbSdrh   if( pExpr==0 ){
4073389a1adbSdrh     op = TK_NULL;
4074389a1adbSdrh   }else{
4075e7375bfaSdrh     assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
4076f2bc013cSdrh     op = pExpr->op;
4077389a1adbSdrh   }
4078f2bc013cSdrh   switch( op ){
407913449892Sdrh     case TK_AGG_COLUMN: {
408013449892Sdrh       AggInfo *pAggInfo = pExpr->pAggInfo;
40810934d640Sdrh       struct AggInfo_col *pCol;
40820934d640Sdrh       assert( pAggInfo!=0 );
40830934d640Sdrh       assert( pExpr->iAgg>=0 && pExpr->iAgg<pAggInfo->nColumn );
40840934d640Sdrh       pCol = &pAggInfo->aCol[pExpr->iAgg];
408513449892Sdrh       if( !pAggInfo->directMode ){
40869de221dfSdrh         assert( pCol->iMem>0 );
4087c332cc30Sdrh         return pCol->iMem;
408813449892Sdrh       }else if( pAggInfo->useSortingIdx ){
40890c76e892Sdrh         Table *pTab = pCol->pTab;
40905134d135Sdan         sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdxPTab,
4091389a1adbSdrh                               pCol->iSorterColumn, target);
40928d5cea6bSdrh         if( pCol->iColumn<0 ){
40938d5cea6bSdrh           VdbeComment((v,"%s.rowid",pTab->zName));
40944b1b65caSdrh         }else if( ALWAYS(pTab!=0) ){
4095cf9d36d1Sdrh           VdbeComment((v,"%s.%s",
4096cf9d36d1Sdrh               pTab->zName, pTab->aCol[pCol->iColumn].zCnName));
40978d5cea6bSdrh           if( pTab->aCol[pCol->iColumn].affinity==SQLITE_AFF_REAL ){
40988d5cea6bSdrh             sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
40998d5cea6bSdrh           }
41000c76e892Sdrh         }
4101c332cc30Sdrh         return target;
410213449892Sdrh       }
410313449892Sdrh       /* Otherwise, fall thru into the TK_COLUMN case */
410408b92086Sdrh       /* no break */ deliberate_fall_through
410513449892Sdrh     }
4106967e8b73Sdrh     case TK_COLUMN: {
4107b2b9d3d7Sdrh       int iTab = pExpr->iTable;
410867b9ba17Sdrh       int iReg;
4109efad2e23Sdrh       if( ExprHasProperty(pExpr, EP_FixedCol) ){
4110d98f5324Sdrh         /* This COLUMN expression is really a constant due to WHERE clause
4111d98f5324Sdrh         ** constraints, and that constant is coded by the pExpr->pLeft
4112d98f5324Sdrh         ** expresssion.  However, make sure the constant has the correct
4113d98f5324Sdrh         ** datatype by applying the Affinity of the table column to the
4114d98f5324Sdrh         ** constant.
4115d98f5324Sdrh         */
411657f7ece7Sdrh         int aff;
411767b9ba17Sdrh         iReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft,target);
4118477572b9Sdrh         assert( ExprUseYTab(pExpr) );
411957f7ece7Sdrh         if( pExpr->y.pTab ){
412057f7ece7Sdrh           aff = sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
412157f7ece7Sdrh         }else{
412257f7ece7Sdrh           aff = pExpr->affExpr;
412357f7ece7Sdrh         }
412496fb16eeSdrh         if( aff>SQLITE_AFF_BLOB ){
4125d98f5324Sdrh           static const char zAff[] = "B\000C\000D\000E";
4126d98f5324Sdrh           assert( SQLITE_AFF_BLOB=='A' );
4127d98f5324Sdrh           assert( SQLITE_AFF_TEXT=='B' );
4128d98f5324Sdrh           sqlite3VdbeAddOp4(v, OP_Affinity, iReg, 1, 0,
4129d98f5324Sdrh                             &zAff[(aff-'B')*2], P4_STATIC);
4130d98f5324Sdrh         }
4131d98f5324Sdrh         return iReg;
4132efad2e23Sdrh       }
4133b2b9d3d7Sdrh       if( iTab<0 ){
41346e97f8ecSdrh         if( pParse->iSelfTab<0 ){
41359942ef0dSdrh           /* Other columns in the same row for CHECK constraints or
41369942ef0dSdrh           ** generated columns or for inserting into partial index.
41379942ef0dSdrh           ** The row is unpacked into registers beginning at
41389942ef0dSdrh           ** 0-(pParse->iSelfTab).  The rowid (if any) is in a register
41399942ef0dSdrh           ** immediately prior to the first column.
41409942ef0dSdrh           */
41419942ef0dSdrh           Column *pCol;
4142477572b9Sdrh           Table *pTab;
41439942ef0dSdrh           int iSrc;
4144c5f808d8Sdrh           int iCol = pExpr->iColumn;
4145477572b9Sdrh           assert( ExprUseYTab(pExpr) );
4146477572b9Sdrh           pTab = pExpr->y.pTab;
41479942ef0dSdrh           assert( pTab!=0 );
4148c5f808d8Sdrh           assert( iCol>=XN_ROWID );
4149b0cbcd0eSdrh           assert( iCol<pTab->nCol );
4150c5f808d8Sdrh           if( iCol<0 ){
41519942ef0dSdrh             return -1-pParse->iSelfTab;
41529942ef0dSdrh           }
4153c5f808d8Sdrh           pCol = pTab->aCol + iCol;
4154c5f808d8Sdrh           testcase( iCol!=sqlite3TableColumnToStorage(pTab,iCol) );
4155c5f808d8Sdrh           iSrc = sqlite3TableColumnToStorage(pTab, iCol) - pParse->iSelfTab;
41569942ef0dSdrh #ifndef SQLITE_OMIT_GENERATED_COLUMNS
41579942ef0dSdrh           if( pCol->colFlags & COLFLAG_GENERATED ){
41584e8e533bSdrh             if( pCol->colFlags & COLFLAG_BUSY ){
41594e8e533bSdrh               sqlite3ErrorMsg(pParse, "generated column loop on \"%s\"",
4160cf9d36d1Sdrh                               pCol->zCnName);
41614e8e533bSdrh               return 0;
41624e8e533bSdrh             }
41634e8e533bSdrh             pCol->colFlags |= COLFLAG_BUSY;
41644e8e533bSdrh             if( pCol->colFlags & COLFLAG_NOTAVAIL ){
416579cf2b71Sdrh               sqlite3ExprCodeGeneratedColumn(pParse, pTab, pCol, iSrc);
41664e8e533bSdrh             }
41674e8e533bSdrh             pCol->colFlags &= ~(COLFLAG_BUSY|COLFLAG_NOTAVAIL);
4168dd6cc9b5Sdrh             return iSrc;
41699942ef0dSdrh           }else
41709942ef0dSdrh #endif /* SQLITE_OMIT_GENERATED_COLUMNS */
41719942ef0dSdrh           if( pCol->affinity==SQLITE_AFF_REAL ){
41729942ef0dSdrh             sqlite3VdbeAddOp2(v, OP_SCopy, iSrc, target);
4173bffdd636Sdrh             sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
4174bffdd636Sdrh             return target;
4175bffdd636Sdrh           }else{
41769942ef0dSdrh             return iSrc;
4177bffdd636Sdrh           }
4178c4a3c779Sdrh         }else{
41791f9ca2c8Sdrh           /* Coding an expression that is part of an index where column names
41801f9ca2c8Sdrh           ** in the index refer to the table to which the index belongs */
41813e34eabcSdrh           iTab = pParse->iSelfTab - 1;
41822282792aSdrh         }
4183b2b9d3d7Sdrh       }
4184477572b9Sdrh       assert( ExprUseYTab(pExpr) );
418567b9ba17Sdrh       iReg = sqlite3ExprCodeGetColumn(pParse, pExpr->y.pTab,
4186b2b9d3d7Sdrh                                pExpr->iColumn, iTab, target,
4187b2b9d3d7Sdrh                                pExpr->op2);
418867b9ba17Sdrh       if( pExpr->y.pTab==0 && pExpr->affExpr==SQLITE_AFF_REAL ){
418967b9ba17Sdrh         sqlite3VdbeAddOp1(v, OP_RealAffinity, iReg);
419067b9ba17Sdrh       }
419167b9ba17Sdrh       return iReg;
4192cce7d176Sdrh     }
4193cce7d176Sdrh     case TK_INTEGER: {
419413573c71Sdrh       codeInteger(pParse, pExpr, 0, target);
4195c332cc30Sdrh       return target;
419651e9a445Sdrh     }
41978abed7b9Sdrh     case TK_TRUEFALSE: {
419896acafbeSdrh       sqlite3VdbeAddOp2(v, OP_Integer, sqlite3ExprTruthValue(pExpr), target);
4199007c843bSdrh       return target;
4200007c843bSdrh     }
420113573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
4202598f1340Sdrh     case TK_FLOAT: {
420333e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
420433e619fcSdrh       codeReal(v, pExpr->u.zToken, 0, target);
4205c332cc30Sdrh       return target;
4206598f1340Sdrh     }
420713573c71Sdrh #endif
4208fec19aadSdrh     case TK_STRING: {
420933e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
4210076e85f5Sdrh       sqlite3VdbeLoadString(v, target, pExpr->u.zToken);
4211c332cc30Sdrh       return target;
4212cce7d176Sdrh     }
4213aac30f9bSdrh     default: {
4214c29af653Sdrh       /* Make NULL the default case so that if a bug causes an illegal
4215c29af653Sdrh       ** Expr node to be passed into this function, it will be handled
42169524a7eaSdrh       ** sanely and not crash.  But keep the assert() to bring the problem
42179524a7eaSdrh       ** to the attention of the developers. */
421805428127Sdrh       assert( op==TK_NULL || op==TK_ERROR || pParse->db->mallocFailed );
42199de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
4220c332cc30Sdrh       return target;
4221f0863fe5Sdrh     }
42225338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_BLOB_LITERAL
4223c572ef7fSdanielk1977     case TK_BLOB: {
42246c8c6cecSdrh       int n;
42256c8c6cecSdrh       const char *z;
4226ca48c90fSdrh       char *zBlob;
422733e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
422833e619fcSdrh       assert( pExpr->u.zToken[0]=='x' || pExpr->u.zToken[0]=='X' );
422933e619fcSdrh       assert( pExpr->u.zToken[1]=='\'' );
423033e619fcSdrh       z = &pExpr->u.zToken[2];
4231b7916a78Sdrh       n = sqlite3Strlen30(z) - 1;
4232b7916a78Sdrh       assert( z[n]=='\'' );
4233ca48c90fSdrh       zBlob = sqlite3HexToBlob(sqlite3VdbeDb(v), z, n);
4234ca48c90fSdrh       sqlite3VdbeAddOp4(v, OP_Blob, n/2, target, 0, zBlob, P4_DYNAMIC);
4235c332cc30Sdrh       return target;
4236c572ef7fSdanielk1977     }
42375338a5f7Sdanielk1977 #endif
423850457896Sdrh     case TK_VARIABLE: {
423933e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
424033e619fcSdrh       assert( pExpr->u.zToken!=0 );
424133e619fcSdrh       assert( pExpr->u.zToken[0]!=0 );
4242eaf52d88Sdrh       sqlite3VdbeAddOp2(v, OP_Variable, pExpr->iColumn, target);
424333e619fcSdrh       if( pExpr->u.zToken[1]!=0 ){
42449bf755ccSdrh         const char *z = sqlite3VListNumToName(pParse->pVList, pExpr->iColumn);
42459524a7eaSdrh         assert( pExpr->u.zToken[0]=='?' || (z && !strcmp(pExpr->u.zToken, z)) );
4246ce1bbe51Sdrh         pParse->pVList[0] = 0; /* Indicate VList may no longer be enlarged */
42479bf755ccSdrh         sqlite3VdbeAppendP4(v, (char*)z, P4_STATIC);
42489bf755ccSdrh       }
4249c332cc30Sdrh       return target;
425050457896Sdrh     }
42514e0cff60Sdrh     case TK_REGISTER: {
4252c332cc30Sdrh       return pExpr->iTable;
42534e0cff60Sdrh     }
4254487e262fSdrh #ifndef SQLITE_OMIT_CAST
4255487e262fSdrh     case TK_CAST: {
4256487e262fSdrh       /* Expressions of the form:   CAST(pLeft AS token) */
42572dcef11bSdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
42581735fa88Sdrh       if( inReg!=target ){
42591735fa88Sdrh         sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
42601735fa88Sdrh         inReg = target;
42611735fa88Sdrh       }
4262f9751074Sdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
42634169e430Sdrh       sqlite3VdbeAddOp2(v, OP_Cast, target,
42644169e430Sdrh                         sqlite3AffinityType(pExpr->u.zToken, 0));
4265c332cc30Sdrh       return inReg;
4266487e262fSdrh     }
4267487e262fSdrh #endif /* SQLITE_OMIT_CAST */
426871c57db0Sdan     case TK_IS:
426971c57db0Sdan     case TK_ISNOT:
427071c57db0Sdan       op = (op==TK_IS) ? TK_EQ : TK_NE;
427171c57db0Sdan       p5 = SQLITE_NULLEQ;
427271c57db0Sdan       /* fall-through */
4273c9b84a1fSdrh     case TK_LT:
4274c9b84a1fSdrh     case TK_LE:
4275c9b84a1fSdrh     case TK_GT:
4276c9b84a1fSdrh     case TK_GE:
4277c9b84a1fSdrh     case TK_NE:
4278c9b84a1fSdrh     case TK_EQ: {
427971c57db0Sdan       Expr *pLeft = pExpr->pLeft;
4280625015e0Sdan       if( sqlite3ExprIsVector(pLeft) ){
428179752b6eSdrh         codeVectorCompare(pParse, pExpr, target, op, p5);
428271c57db0Sdan       }else{
428371c57db0Sdan         r1 = sqlite3ExprCodeTemp(pParse, pLeft, &regFree1);
4284b6da74ebSdrh         r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
4285871e7ff4Sdrh         sqlite3VdbeAddOp2(v, OP_Integer, 1, inReg);
4286871e7ff4Sdrh         codeCompare(pParse, pLeft, pExpr->pRight, op, r1, r2,
4287871e7ff4Sdrh             sqlite3VdbeCurrentAddr(v)+2, p5,
4288898c527eSdrh             ExprHasProperty(pExpr,EP_Commuted));
42897d176105Sdrh         assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
42907d176105Sdrh         assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
42917d176105Sdrh         assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
42927d176105Sdrh         assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
42937d176105Sdrh         assert(TK_EQ==OP_Eq); testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
42947d176105Sdrh         assert(TK_NE==OP_Ne); testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
4295529df929Sdrh         if( p5==SQLITE_NULLEQ ){
4296529df929Sdrh           sqlite3VdbeAddOp2(v, OP_Integer, 0, inReg);
4297529df929Sdrh         }else{
4298529df929Sdrh           sqlite3VdbeAddOp3(v, OP_ZeroOrNull, r1, inReg, r2);
4299529df929Sdrh         }
4300c5499befSdrh         testcase( regFree1==0 );
4301c5499befSdrh         testcase( regFree2==0 );
4302c9b84a1fSdrh       }
43036a2fe093Sdrh       break;
43046a2fe093Sdrh     }
4305cce7d176Sdrh     case TK_AND:
4306cce7d176Sdrh     case TK_OR:
4307cce7d176Sdrh     case TK_PLUS:
4308cce7d176Sdrh     case TK_STAR:
4309cce7d176Sdrh     case TK_MINUS:
4310bf4133cbSdrh     case TK_REM:
4311bf4133cbSdrh     case TK_BITAND:
4312bf4133cbSdrh     case TK_BITOR:
431317c40294Sdrh     case TK_SLASH:
4314bf4133cbSdrh     case TK_LSHIFT:
4315855eb1cfSdrh     case TK_RSHIFT:
43160040077dSdrh     case TK_CONCAT: {
43177d176105Sdrh       assert( TK_AND==OP_And );            testcase( op==TK_AND );
43187d176105Sdrh       assert( TK_OR==OP_Or );              testcase( op==TK_OR );
43197d176105Sdrh       assert( TK_PLUS==OP_Add );           testcase( op==TK_PLUS );
43207d176105Sdrh       assert( TK_MINUS==OP_Subtract );     testcase( op==TK_MINUS );
43217d176105Sdrh       assert( TK_REM==OP_Remainder );      testcase( op==TK_REM );
43227d176105Sdrh       assert( TK_BITAND==OP_BitAnd );      testcase( op==TK_BITAND );
43237d176105Sdrh       assert( TK_BITOR==OP_BitOr );        testcase( op==TK_BITOR );
43247d176105Sdrh       assert( TK_SLASH==OP_Divide );       testcase( op==TK_SLASH );
43257d176105Sdrh       assert( TK_LSHIFT==OP_ShiftLeft );   testcase( op==TK_LSHIFT );
43267d176105Sdrh       assert( TK_RSHIFT==OP_ShiftRight );  testcase( op==TK_RSHIFT );
43277d176105Sdrh       assert( TK_CONCAT==OP_Concat );      testcase( op==TK_CONCAT );
43282dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
43292dcef11bSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
43305b6afba9Sdrh       sqlite3VdbeAddOp3(v, op, r2, r1, target);
4331c5499befSdrh       testcase( regFree1==0 );
4332c5499befSdrh       testcase( regFree2==0 );
43330040077dSdrh       break;
43340040077dSdrh     }
4335cce7d176Sdrh     case TK_UMINUS: {
4336fec19aadSdrh       Expr *pLeft = pExpr->pLeft;
4337fec19aadSdrh       assert( pLeft );
433813573c71Sdrh       if( pLeft->op==TK_INTEGER ){
433913573c71Sdrh         codeInteger(pParse, pLeft, 1, target);
4340c332cc30Sdrh         return target;
434113573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
434213573c71Sdrh       }else if( pLeft->op==TK_FLOAT ){
434333e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
434433e619fcSdrh         codeReal(v, pLeft->u.zToken, 1, target);
4345c332cc30Sdrh         return target;
434613573c71Sdrh #endif
43473c84ddffSdrh       }else{
434810d1edf0Sdrh         tempX.op = TK_INTEGER;
434910d1edf0Sdrh         tempX.flags = EP_IntValue|EP_TokenOnly;
435010d1edf0Sdrh         tempX.u.iValue = 0;
4351e7375bfaSdrh         ExprClearVVAProperties(&tempX);
435210d1edf0Sdrh         r1 = sqlite3ExprCodeTemp(pParse, &tempX, &regFree1);
4353e55cbd72Sdrh         r2 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree2);
43542dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_Subtract, r2, r1, target);
4355c5499befSdrh         testcase( regFree2==0 );
43563c84ddffSdrh       }
43576e142f54Sdrh       break;
43586e142f54Sdrh     }
4359bf4133cbSdrh     case TK_BITNOT:
43606e142f54Sdrh     case TK_NOT: {
43617d176105Sdrh       assert( TK_BITNOT==OP_BitNot );   testcase( op==TK_BITNOT );
43627d176105Sdrh       assert( TK_NOT==OP_Not );         testcase( op==TK_NOT );
4363e99fa2afSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4364e99fa2afSdrh       testcase( regFree1==0 );
4365e99fa2afSdrh       sqlite3VdbeAddOp2(v, op, r1, inReg);
4366cce7d176Sdrh       break;
4367cce7d176Sdrh     }
43688abed7b9Sdrh     case TK_TRUTH: {
436996acafbeSdrh       int isTrue;    /* IS TRUE or IS NOT TRUE */
437096acafbeSdrh       int bNormal;   /* IS TRUE or IS FALSE */
4371007c843bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4372007c843bSdrh       testcase( regFree1==0 );
437396acafbeSdrh       isTrue = sqlite3ExprTruthValue(pExpr->pRight);
437496acafbeSdrh       bNormal = pExpr->op2==TK_IS;
437596acafbeSdrh       testcase( isTrue && bNormal);
437696acafbeSdrh       testcase( !isTrue && bNormal);
437796acafbeSdrh       sqlite3VdbeAddOp4Int(v, OP_IsTrue, r1, inReg, !isTrue, isTrue ^ bNormal);
4378007c843bSdrh       break;
4379007c843bSdrh     }
4380cce7d176Sdrh     case TK_ISNULL:
4381cce7d176Sdrh     case TK_NOTNULL: {
43826a288a33Sdrh       int addr;
43837d176105Sdrh       assert( TK_ISNULL==OP_IsNull );   testcase( op==TK_ISNULL );
43847d176105Sdrh       assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
43859de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
43862dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4387c5499befSdrh       testcase( regFree1==0 );
43882dcef11bSdrh       addr = sqlite3VdbeAddOp1(v, op, r1);
43897d176105Sdrh       VdbeCoverageIf(v, op==TK_ISNULL);
43907d176105Sdrh       VdbeCoverageIf(v, op==TK_NOTNULL);
4391a976979bSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 0, target);
43926a288a33Sdrh       sqlite3VdbeJumpHere(v, addr);
4393a37cdde0Sdanielk1977       break;
4394f2bc013cSdrh     }
43952282792aSdrh     case TK_AGG_FUNCTION: {
439613449892Sdrh       AggInfo *pInfo = pExpr->pAggInfo;
43970934d640Sdrh       if( pInfo==0
43980934d640Sdrh        || NEVER(pExpr->iAgg<0)
43990934d640Sdrh        || NEVER(pExpr->iAgg>=pInfo->nFunc)
44000934d640Sdrh       ){
440133e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
440262fc069eSdrh         sqlite3ErrorMsg(pParse, "misuse of aggregate: %#T()", pExpr);
44037e56e711Sdrh       }else{
4404c332cc30Sdrh         return pInfo->aFunc[pExpr->iAgg].iMem;
44057e56e711Sdrh       }
44062282792aSdrh       break;
44072282792aSdrh     }
4408cce7d176Sdrh     case TK_FUNCTION: {
440912ffee8cSdrh       ExprList *pFarg;       /* List of function arguments */
441012ffee8cSdrh       int nFarg;             /* Number of function arguments */
441112ffee8cSdrh       FuncDef *pDef;         /* The function definition object */
441212ffee8cSdrh       const char *zId;       /* The function name */
4413693e6719Sdrh       u32 constMask = 0;     /* Mask of function arguments that are constant */
441412ffee8cSdrh       int i;                 /* Loop counter */
4415c332cc30Sdrh       sqlite3 *db = pParse->db;  /* The database connection */
441612ffee8cSdrh       u8 enc = ENC(db);      /* The text encoding used by this database */
441712ffee8cSdrh       CollSeq *pColl = 0;    /* A collating sequence */
441817435752Sdrh 
441967a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
4420eda079cdSdrh       if( ExprHasProperty(pExpr, EP_WinFunc) ){
4421eda079cdSdrh         return pExpr->y.pWin->regResult;
442286fb6e17Sdan       }
442367a9b8edSdan #endif
442486fb6e17Sdan 
44251e9b53f9Sdrh       if( ConstFactorOk(pParse) && sqlite3ExprIsConstantNotJoin(pExpr) ){
44269b258c54Sdrh         /* SQL functions can be expensive. So try to avoid running them
44279b258c54Sdrh         ** multiple times if we know they always give the same result */
44289b258c54Sdrh         return sqlite3ExprCodeRunJustOnce(pParse, pExpr, -1);
44291e9b53f9Sdrh       }
4430e7375bfaSdrh       assert( !ExprHasProperty(pExpr, EP_TokenOnly) );
4431a4eeccdfSdrh       assert( ExprUseXList(pExpr) );
443212ffee8cSdrh       pFarg = pExpr->x.pList;
443312ffee8cSdrh       nFarg = pFarg ? pFarg->nExpr : 0;
443433e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
443533e619fcSdrh       zId = pExpr->u.zToken;
443680738d9cSdrh       pDef = sqlite3FindFunction(db, zId, nFarg, enc, 0);
4437cc15313cSdrh #ifdef SQLITE_ENABLE_UNKNOWN_SQL_FUNCTION
4438cc15313cSdrh       if( pDef==0 && pParse->explain ){
4439cc15313cSdrh         pDef = sqlite3FindFunction(db, "unknown", nFarg, enc, 0);
4440cc15313cSdrh       }
4441cc15313cSdrh #endif
4442b6e9f7a4Sdan       if( pDef==0 || pDef->xFinalize!=0 ){
444362fc069eSdrh         sqlite3ErrorMsg(pParse, "unknown function: %#T()", pExpr);
4444feb306f5Sdrh         break;
4445feb306f5Sdrh       }
444625c4296bSdrh       if( pDef->funcFlags & SQLITE_FUNC_INLINE ){
44470dfa5255Sdrh         assert( (pDef->funcFlags & SQLITE_FUNC_UNSAFE)==0 );
44480dfa5255Sdrh         assert( (pDef->funcFlags & SQLITE_FUNC_DIRECT)==0 );
444925c4296bSdrh         return exprCodeInlineFunction(pParse, pFarg,
445025c4296bSdrh              SQLITE_PTR_TO_INT(pDef->pUserData), target);
44512eeca204Sdrh       }else if( pDef->funcFlags & (SQLITE_FUNC_DIRECT|SQLITE_FUNC_UNSAFE) ){
44520dfa5255Sdrh         sqlite3ExprFunctionUsable(pParse, pExpr, pDef);
4453ae6bb957Sdrh       }
4454a1a523a5Sdrh 
4455d1a01edaSdrh       for(i=0; i<nFarg; i++){
4456d1a01edaSdrh         if( i<32 && sqlite3ExprIsConstant(pFarg->a[i].pExpr) ){
4457693e6719Sdrh           testcase( i==31 );
4458693e6719Sdrh           constMask |= MASKBIT32(i);
4459d1a01edaSdrh         }
4460d1a01edaSdrh         if( (pDef->funcFlags & SQLITE_FUNC_NEEDCOLL)!=0 && !pColl ){
4461d1a01edaSdrh           pColl = sqlite3ExprCollSeq(pParse, pFarg->a[i].pExpr);
4462d1a01edaSdrh         }
4463d1a01edaSdrh       }
446412ffee8cSdrh       if( pFarg ){
4465d1a01edaSdrh         if( constMask ){
4466d1a01edaSdrh           r1 = pParse->nMem+1;
4467d1a01edaSdrh           pParse->nMem += nFarg;
4468d1a01edaSdrh         }else{
446912ffee8cSdrh           r1 = sqlite3GetTempRange(pParse, nFarg);
4470d1a01edaSdrh         }
4471a748fdccSdrh 
4472a748fdccSdrh         /* For length() and typeof() functions with a column argument,
4473a748fdccSdrh         ** set the P5 parameter to the OP_Column opcode to OPFLAG_LENGTHARG
4474a748fdccSdrh         ** or OPFLAG_TYPEOFARG respectively, to avoid unnecessary data
4475a748fdccSdrh         ** loading.
4476a748fdccSdrh         */
4477d36e1041Sdrh         if( (pDef->funcFlags & (SQLITE_FUNC_LENGTH|SQLITE_FUNC_TYPEOF))!=0 ){
44784e245a4cSdrh           u8 exprOp;
4479a748fdccSdrh           assert( nFarg==1 );
4480a748fdccSdrh           assert( pFarg->a[0].pExpr!=0 );
44814e245a4cSdrh           exprOp = pFarg->a[0].pExpr->op;
44824e245a4cSdrh           if( exprOp==TK_COLUMN || exprOp==TK_AGG_COLUMN ){
4483a748fdccSdrh             assert( SQLITE_FUNC_LENGTH==OPFLAG_LENGTHARG );
4484a748fdccSdrh             assert( SQLITE_FUNC_TYPEOF==OPFLAG_TYPEOFARG );
4485b1fba286Sdrh             testcase( pDef->funcFlags & OPFLAG_LENGTHARG );
4486b1fba286Sdrh             pFarg->a[0].pExpr->op2 =
4487b1fba286Sdrh                   pDef->funcFlags & (OPFLAG_LENGTHARG|OPFLAG_TYPEOFARG);
4488a748fdccSdrh           }
4489a748fdccSdrh         }
4490a748fdccSdrh 
44915579d59fSdrh         sqlite3ExprCodeExprList(pParse, pFarg, r1, 0,
4492d1a01edaSdrh                                 SQLITE_ECEL_DUP|SQLITE_ECEL_FACTOR);
4493892d3179Sdrh       }else{
449412ffee8cSdrh         r1 = 0;
4495892d3179Sdrh       }
4496b7f6f68fSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
4497a43fa227Sdrh       /* Possibly overload the function if the first argument is
4498a43fa227Sdrh       ** a virtual table column.
4499a43fa227Sdrh       **
4500a43fa227Sdrh       ** For infix functions (LIKE, GLOB, REGEXP, and MATCH) use the
4501a43fa227Sdrh       ** second argument, not the first, as the argument to test to
4502a43fa227Sdrh       ** see if it is a column in a virtual table.  This is done because
4503a43fa227Sdrh       ** the left operand of infix functions (the operand we want to
4504a43fa227Sdrh       ** control overloading) ends up as the second argument to the
4505a43fa227Sdrh       ** function.  The expression "A glob B" is equivalent to
4506a43fa227Sdrh       ** "glob(B,A).  We want to use the A in "A glob B" to test
4507a43fa227Sdrh       ** for function overloading.  But we use the B term in "glob(B,A)".
4508a43fa227Sdrh       */
450959155065Sdrh       if( nFarg>=2 && ExprHasProperty(pExpr, EP_InfixFunc) ){
451012ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[1].pExpr);
451112ffee8cSdrh       }else if( nFarg>0 ){
451212ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[0].pExpr);
4513b7f6f68fSdrh       }
4514b7f6f68fSdrh #endif
4515d36e1041Sdrh       if( pDef->funcFlags & SQLITE_FUNC_NEEDCOLL ){
45168b213899Sdrh         if( !pColl ) pColl = db->pDfltColl;
451766a5167bSdrh         sqlite3VdbeAddOp4(v, OP_CollSeq, 0, 0, 0, (char *)pColl, P4_COLLSEQ);
4518682f68b0Sdanielk1977       }
4519920cf596Sdrh       sqlite3VdbeAddFunctionCall(pParse, constMask, r1, target, nFarg,
452020cee7d0Sdrh                                  pDef, pExpr->op2);
452113d79502Sdrh       if( nFarg ){
452213d79502Sdrh         if( constMask==0 ){
452312ffee8cSdrh           sqlite3ReleaseTempRange(pParse, r1, nFarg);
452413d79502Sdrh         }else{
45253aef2fb1Sdrh           sqlite3VdbeReleaseRegisters(pParse, r1, nFarg, constMask, 1);
452613d79502Sdrh         }
45272dcef11bSdrh       }
4528c332cc30Sdrh       return target;
45296ec2733bSdrh     }
4530fe2093d7Sdrh #ifndef SQLITE_OMIT_SUBQUERY
4531fe2093d7Sdrh     case TK_EXISTS:
453219a775c2Sdrh     case TK_SELECT: {
45338da209b1Sdan       int nCol;
4534c5499befSdrh       testcase( op==TK_EXISTS );
4535c5499befSdrh       testcase( op==TK_SELECT );
4536d8d335d7Sdrh       if( pParse->db->mallocFailed ){
4537d8d335d7Sdrh         return 0;
4538a4eeccdfSdrh       }else if( op==TK_SELECT
4539a4eeccdfSdrh              && ALWAYS( ExprUseXSelect(pExpr) )
4540a4eeccdfSdrh              && (nCol = pExpr->x.pSelect->pEList->nExpr)!=1
4541a4eeccdfSdrh       ){
45428da209b1Sdan         sqlite3SubselectError(pParse, nCol, 1);
45438da209b1Sdan       }else{
454485bcdce2Sdrh         return sqlite3CodeSubselect(pParse, pExpr);
45458da209b1Sdan       }
454619a775c2Sdrh       break;
454719a775c2Sdrh     }
4548fc7f27b9Sdrh     case TK_SELECT_COLUMN: {
4549966e2911Sdrh       int n;
45502c31c00bSdrh       Expr *pLeft = pExpr->pLeft;
45512c31c00bSdrh       if( pLeft->iTable==0 || pParse->withinRJSubrtn > pLeft->op2 ){
45522c31c00bSdrh         pLeft->iTable = sqlite3CodeSubselect(pParse, pLeft);
45532c31c00bSdrh         pLeft->op2 = pParse->withinRJSubrtn;
4554fc7f27b9Sdrh       }
45552c31c00bSdrh       assert( pLeft->op==TK_SELECT || pLeft->op==TK_ERROR );
45562c31c00bSdrh       n = sqlite3ExprVectorSize(pLeft);
455710f08270Sdrh       if( pExpr->iTable!=n ){
4558966e2911Sdrh         sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
4559966e2911Sdrh                                 pExpr->iTable, n);
4560966e2911Sdrh       }
45612c31c00bSdrh       return pLeft->iTable + pExpr->iColumn;
4562fc7f27b9Sdrh     }
4563fef5208cSdrh     case TK_IN: {
4564ec4ccdbcSdrh       int destIfFalse = sqlite3VdbeMakeLabel(pParse);
4565ec4ccdbcSdrh       int destIfNull = sqlite3VdbeMakeLabel(pParse);
4566e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
4567e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
456866ba23ceSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
4569e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
4570e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_AddImm, target, 0);
4571e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfNull);
4572c332cc30Sdrh       return target;
4573fef5208cSdrh     }
4574e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
4575e3365e6cSdrh 
4576e3365e6cSdrh 
45772dcef11bSdrh     /*
45782dcef11bSdrh     **    x BETWEEN y AND z
45792dcef11bSdrh     **
45802dcef11bSdrh     ** This is equivalent to
45812dcef11bSdrh     **
45822dcef11bSdrh     **    x>=y AND x<=z
45832dcef11bSdrh     **
45842dcef11bSdrh     ** X is stored in pExpr->pLeft.
45852dcef11bSdrh     ** Y is stored in pExpr->pList->a[0].pExpr.
45862dcef11bSdrh     ** Z is stored in pExpr->pList->a[1].pExpr.
45872dcef11bSdrh     */
4588fef5208cSdrh     case TK_BETWEEN: {
458971c57db0Sdan       exprCodeBetween(pParse, pExpr, target, 0, 0);
4590c332cc30Sdrh       return target;
4591fef5208cSdrh     }
45928878f8a8Sdrh     case TK_COLLATE: {
45938878f8a8Sdrh       if( !ExprHasProperty(pExpr, EP_Collate)
45948878f8a8Sdrh        && ALWAYS(pExpr->pLeft)
45958878f8a8Sdrh        && pExpr->pLeft->op==TK_FUNCTION
45968878f8a8Sdrh       ){
45978878f8a8Sdrh         inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
45988878f8a8Sdrh         if( inReg!=target ){
45998878f8a8Sdrh           sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
46008878f8a8Sdrh           inReg = target;
46018878f8a8Sdrh         }
46028878f8a8Sdrh         sqlite3VdbeAddOp1(v, OP_ClrSubtype, inReg);
46038878f8a8Sdrh         return inReg;
46048878f8a8Sdrh       }else{
46058878f8a8Sdrh         pExpr = pExpr->pLeft;
46068878f8a8Sdrh         goto expr_code_doover; /* 2018-04-28: Prevent deep recursion. */
46078878f8a8Sdrh       }
46088878f8a8Sdrh     }
460994fa9c41Sdrh     case TK_SPAN:
46104f07e5fbSdrh     case TK_UPLUS: {
46111efa8023Sdrh       pExpr = pExpr->pLeft;
461259ee43a7Sdrh       goto expr_code_doover; /* 2018-04-28: Prevent deep recursion. OSSFuzz. */
4613a2e00042Sdrh     }
46142dcef11bSdrh 
4615165921a7Sdan     case TK_TRIGGER: {
461665a7cd16Sdan       /* If the opcode is TK_TRIGGER, then the expression is a reference
461765a7cd16Sdan       ** to a column in the new.* or old.* pseudo-tables available to
461865a7cd16Sdan       ** trigger programs. In this case Expr.iTable is set to 1 for the
461965a7cd16Sdan       ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
462065a7cd16Sdan       ** is set to the column of the pseudo-table to read, or to -1 to
462165a7cd16Sdan       ** read the rowid field.
462265a7cd16Sdan       **
462365a7cd16Sdan       ** The expression is implemented using an OP_Param opcode. The p1
462465a7cd16Sdan       ** parameter is set to 0 for an old.rowid reference, or to (i+1)
462565a7cd16Sdan       ** to reference another column of the old.* pseudo-table, where
462665a7cd16Sdan       ** i is the index of the column. For a new.rowid reference, p1 is
462765a7cd16Sdan       ** set to (n+1), where n is the number of columns in each pseudo-table.
462865a7cd16Sdan       ** For a reference to any other column in the new.* pseudo-table, p1
462965a7cd16Sdan       ** is set to (n+2+i), where n and i are as defined previously. For
463065a7cd16Sdan       ** example, if the table on which triggers are being fired is
463165a7cd16Sdan       ** declared as:
463265a7cd16Sdan       **
463365a7cd16Sdan       **   CREATE TABLE t1(a, b);
463465a7cd16Sdan       **
463565a7cd16Sdan       ** Then p1 is interpreted as follows:
463665a7cd16Sdan       **
463765a7cd16Sdan       **   p1==0   ->    old.rowid     p1==3   ->    new.rowid
463865a7cd16Sdan       **   p1==1   ->    old.a         p1==4   ->    new.a
463965a7cd16Sdan       **   p1==2   ->    old.b         p1==5   ->    new.b
464065a7cd16Sdan       */
4641477572b9Sdrh       Table *pTab;
4642477572b9Sdrh       int iCol;
4643477572b9Sdrh       int p1;
4644477572b9Sdrh 
4645477572b9Sdrh       assert( ExprUseYTab(pExpr) );
4646477572b9Sdrh       pTab = pExpr->y.pTab;
4647477572b9Sdrh       iCol = pExpr->iColumn;
4648477572b9Sdrh       p1 = pExpr->iTable * (pTab->nCol+1) + 1
46497fe2fc0dSdrh                      + sqlite3TableColumnToStorage(pTab, iCol);
465065a7cd16Sdan 
465165a7cd16Sdan       assert( pExpr->iTable==0 || pExpr->iTable==1 );
4652dd6cc9b5Sdrh       assert( iCol>=-1 && iCol<pTab->nCol );
4653dd6cc9b5Sdrh       assert( pTab->iPKey<0 || iCol!=pTab->iPKey );
465465a7cd16Sdan       assert( p1>=0 && p1<(pTab->nCol*2+2) );
465565a7cd16Sdan 
465665a7cd16Sdan       sqlite3VdbeAddOp2(v, OP_Param, p1, target);
4657896494e8Sdrh       VdbeComment((v, "r[%d]=%s.%s", target,
4658165921a7Sdan         (pExpr->iTable ? "new" : "old"),
4659cf9d36d1Sdrh         (pExpr->iColumn<0 ? "rowid" : pExpr->y.pTab->aCol[iCol].zCnName)
4660165921a7Sdan       ));
466165a7cd16Sdan 
466244dbca83Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
466365a7cd16Sdan       /* If the column has REAL affinity, it may currently be stored as an
4664113762a2Sdrh       ** integer. Use OP_RealAffinity to make sure it is really real.
4665113762a2Sdrh       **
4666113762a2Sdrh       ** EVIDENCE-OF: R-60985-57662 SQLite will convert the value back to
4667113762a2Sdrh       ** floating point when extracting it from the record.  */
4668dd6cc9b5Sdrh       if( iCol>=0 && pTab->aCol[iCol].affinity==SQLITE_AFF_REAL ){
46692832ad42Sdan         sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
46702832ad42Sdan       }
467144dbca83Sdrh #endif
4672165921a7Sdan       break;
4673165921a7Sdan     }
4674165921a7Sdan 
467571c57db0Sdan     case TK_VECTOR: {
4676e835bc12Sdrh       sqlite3ErrorMsg(pParse, "row value misused");
467771c57db0Sdan       break;
467871c57db0Sdan     }
467971c57db0Sdan 
46809e9a67adSdrh     /* TK_IF_NULL_ROW Expr nodes are inserted ahead of expressions
46819e9a67adSdrh     ** that derive from the right-hand table of a LEFT JOIN.  The
46829e9a67adSdrh     ** Expr.iTable value is the table number for the right-hand table.
46839e9a67adSdrh     ** The expression is only evaluated if that table is not currently
46849e9a67adSdrh     ** on a LEFT JOIN NULL row.
46859e9a67adSdrh     */
468631d6fd55Sdrh     case TK_IF_NULL_ROW: {
468731d6fd55Sdrh       int addrINR;
46889e9a67adSdrh       u8 okConstFactor = pParse->okConstFactor;
4689ee373020Sdrh       AggInfo *pAggInfo = pExpr->pAggInfo;
4690ee373020Sdrh       if( pAggInfo ){
4691ee373020Sdrh         assert( pExpr->iAgg>=0 && pExpr->iAgg<pAggInfo->nColumn );
4692ee373020Sdrh         if( !pAggInfo->directMode ){
4693ee373020Sdrh           inReg = pAggInfo->aCol[pExpr->iAgg].iMem;
46946b6d6c6bSdrh           break;
46956b6d6c6bSdrh         }
4696ee373020Sdrh         if( pExpr->pAggInfo->useSortingIdx ){
4697ee373020Sdrh           sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdxPTab,
4698ee373020Sdrh                             pAggInfo->aCol[pExpr->iAgg].iSorterColumn,
4699ee373020Sdrh                             target);
4700ee373020Sdrh           inReg = target;
4701ee373020Sdrh           break;
4702ee373020Sdrh         }
4703ee373020Sdrh       }
470431d6fd55Sdrh       addrINR = sqlite3VdbeAddOp1(v, OP_IfNullRow, pExpr->iTable);
47059e9a67adSdrh       /* Temporarily disable factoring of constant expressions, since
47069e9a67adSdrh       ** even though expressions may appear to be constant, they are not
47079e9a67adSdrh       ** really constant because they originate from the right-hand side
47089e9a67adSdrh       ** of a LEFT JOIN. */
47099e9a67adSdrh       pParse->okConstFactor = 0;
471031d6fd55Sdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
47119e9a67adSdrh       pParse->okConstFactor = okConstFactor;
471231d6fd55Sdrh       sqlite3VdbeJumpHere(v, addrINR);
471331d6fd55Sdrh       sqlite3VdbeChangeP3(v, addrINR, inReg);
471431d6fd55Sdrh       break;
471531d6fd55Sdrh     }
471631d6fd55Sdrh 
47172dcef11bSdrh     /*
47182dcef11bSdrh     ** Form A:
47192dcef11bSdrh     **   CASE x WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
47202dcef11bSdrh     **
47212dcef11bSdrh     ** Form B:
47222dcef11bSdrh     **   CASE WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
47232dcef11bSdrh     **
47242dcef11bSdrh     ** Form A is can be transformed into the equivalent form B as follows:
47252dcef11bSdrh     **   CASE WHEN x=e1 THEN r1 WHEN x=e2 THEN r2 ...
47262dcef11bSdrh     **        WHEN x=eN THEN rN ELSE y END
47272dcef11bSdrh     **
47282dcef11bSdrh     ** X (if it exists) is in pExpr->pLeft.
4729c5cd1249Sdrh     ** Y is in the last element of pExpr->x.pList if pExpr->x.pList->nExpr is
4730c5cd1249Sdrh     ** odd.  The Y is also optional.  If the number of elements in x.pList
4731c5cd1249Sdrh     ** is even, then Y is omitted and the "otherwise" result is NULL.
47322dcef11bSdrh     ** Ei is in pExpr->pList->a[i*2] and Ri is pExpr->pList->a[i*2+1].
47332dcef11bSdrh     **
47342dcef11bSdrh     ** The result of the expression is the Ri for the first matching Ei,
47352dcef11bSdrh     ** or if there is no matching Ei, the ELSE term Y, or if there is
47362dcef11bSdrh     ** no ELSE term, NULL.
47372dcef11bSdrh     */
4738aac30f9bSdrh     case TK_CASE: {
47392dcef11bSdrh       int endLabel;                     /* GOTO label for end of CASE stmt */
47402dcef11bSdrh       int nextCase;                     /* GOTO label for next WHEN clause */
47412dcef11bSdrh       int nExpr;                        /* 2x number of WHEN terms */
47422dcef11bSdrh       int i;                            /* Loop counter */
47432dcef11bSdrh       ExprList *pEList;                 /* List of WHEN terms */
47442dcef11bSdrh       struct ExprList_item *aListelem;  /* Array of WHEN terms */
47452dcef11bSdrh       Expr opCompare;                   /* The X==Ei expression */
47462dcef11bSdrh       Expr *pX;                         /* The X expression */
47471bd10f8aSdrh       Expr *pTest = 0;                  /* X==Ei (form A) or just Ei (form B) */
47488b65e591Sdan       Expr *pDel = 0;
47498b65e591Sdan       sqlite3 *db = pParse->db;
475017a7f8ddSdrh 
4751a4eeccdfSdrh       assert( ExprUseXList(pExpr) && pExpr->x.pList!=0 );
47526ab3a2ecSdanielk1977       assert(pExpr->x.pList->nExpr > 0);
47536ab3a2ecSdanielk1977       pEList = pExpr->x.pList;
4754be5c89acSdrh       aListelem = pEList->a;
4755be5c89acSdrh       nExpr = pEList->nExpr;
4756ec4ccdbcSdrh       endLabel = sqlite3VdbeMakeLabel(pParse);
47572dcef11bSdrh       if( (pX = pExpr->pLeft)!=0 ){
47588b65e591Sdan         pDel = sqlite3ExprDup(db, pX, 0);
47598b65e591Sdan         if( db->mallocFailed ){
47608b65e591Sdan           sqlite3ExprDelete(db, pDel);
47618b65e591Sdan           break;
47628b65e591Sdan         }
476333cd4909Sdrh         testcase( pX->op==TK_COLUMN );
47648b65e591Sdan         exprToRegister(pDel, exprCodeVector(pParse, pDel, &regFree1));
4765c5499befSdrh         testcase( regFree1==0 );
4766abb9d5f1Sdrh         memset(&opCompare, 0, sizeof(opCompare));
47672dcef11bSdrh         opCompare.op = TK_EQ;
47688b65e591Sdan         opCompare.pLeft = pDel;
47692dcef11bSdrh         pTest = &opCompare;
47708b1db07fSdrh         /* Ticket b351d95f9cd5ef17e9d9dbae18f5ca8611190001:
47718b1db07fSdrh         ** The value in regFree1 might get SCopy-ed into the file result.
47728b1db07fSdrh         ** So make sure that the regFree1 register is not reused for other
47738b1db07fSdrh         ** purposes and possibly overwritten.  */
47748b1db07fSdrh         regFree1 = 0;
4775cce7d176Sdrh       }
4776c5cd1249Sdrh       for(i=0; i<nExpr-1; i=i+2){
47772dcef11bSdrh         if( pX ){
47781bd10f8aSdrh           assert( pTest!=0 );
47792dcef11bSdrh           opCompare.pRight = aListelem[i].pExpr;
4780f5905aa7Sdrh         }else{
47812dcef11bSdrh           pTest = aListelem[i].pExpr;
478217a7f8ddSdrh         }
4783ec4ccdbcSdrh         nextCase = sqlite3VdbeMakeLabel(pParse);
478433cd4909Sdrh         testcase( pTest->op==TK_COLUMN );
47852dcef11bSdrh         sqlite3ExprIfFalse(pParse, pTest, nextCase, SQLITE_JUMPIFNULL);
4786c5499befSdrh         testcase( aListelem[i+1].pExpr->op==TK_COLUMN );
47879de221dfSdrh         sqlite3ExprCode(pParse, aListelem[i+1].pExpr, target);
4788076e85f5Sdrh         sqlite3VdbeGoto(v, endLabel);
47892dcef11bSdrh         sqlite3VdbeResolveLabel(v, nextCase);
4790f570f011Sdrh       }
4791c5cd1249Sdrh       if( (nExpr&1)!=0 ){
4792c5cd1249Sdrh         sqlite3ExprCode(pParse, pEList->a[nExpr-1].pExpr, target);
479317a7f8ddSdrh       }else{
47949de221dfSdrh         sqlite3VdbeAddOp2(v, OP_Null, 0, target);
479517a7f8ddSdrh       }
47968b65e591Sdan       sqlite3ExprDelete(db, pDel);
479792a27f7bSdrh       setDoNotMergeFlagOnCopy(v);
47982dcef11bSdrh       sqlite3VdbeResolveLabel(v, endLabel);
47996f34903eSdanielk1977       break;
48006f34903eSdanielk1977     }
48015338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_TRIGGER
48026f34903eSdanielk1977     case TK_RAISE: {
48031194904bSdrh       assert( pExpr->affExpr==OE_Rollback
48041194904bSdrh            || pExpr->affExpr==OE_Abort
48051194904bSdrh            || pExpr->affExpr==OE_Fail
48061194904bSdrh            || pExpr->affExpr==OE_Ignore
4807165921a7Sdan       );
48089e5fdc41Sdrh       if( !pParse->pTriggerTab && !pParse->nested ){
4809e0af83acSdan         sqlite3ErrorMsg(pParse,
4810e0af83acSdan                        "RAISE() may only be used within a trigger-program");
4811e0af83acSdan         return 0;
4812e0af83acSdan       }
48131194904bSdrh       if( pExpr->affExpr==OE_Abort ){
4814e0af83acSdan         sqlite3MayAbort(pParse);
4815e0af83acSdan       }
481633e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
48171194904bSdrh       if( pExpr->affExpr==OE_Ignore ){
4818e0af83acSdan         sqlite3VdbeAddOp4(
4819e0af83acSdan             v, OP_Halt, SQLITE_OK, OE_Ignore, 0, pExpr->u.zToken,0);
4820688852abSdrh         VdbeCoverage(v);
4821e0af83acSdan       }else{
48229e5fdc41Sdrh         sqlite3HaltConstraint(pParse,
48239e5fdc41Sdrh              pParse->pTriggerTab ? SQLITE_CONSTRAINT_TRIGGER : SQLITE_ERROR,
48241194904bSdrh              pExpr->affExpr, pExpr->u.zToken, 0, 0);
4825e0af83acSdan       }
4826e0af83acSdan 
4827ffe07b2dSdrh       break;
482817a7f8ddSdrh     }
48295338a5f7Sdanielk1977 #endif
4830ffe07b2dSdrh   }
48312dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
48322dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
48332dcef11bSdrh   return inReg;
48345b6afba9Sdrh }
48352dcef11bSdrh 
48362dcef11bSdrh /*
48379b258c54Sdrh ** Generate code that will evaluate expression pExpr just one time
48389b258c54Sdrh ** per prepared statement execution.
48399b258c54Sdrh **
48409b258c54Sdrh ** If the expression uses functions (that might throw an exception) then
48419b258c54Sdrh ** guard them with an OP_Once opcode to ensure that the code is only executed
48429b258c54Sdrh ** once. If no functions are involved, then factor the code out and put it at
48439b258c54Sdrh ** the end of the prepared statement in the initialization section.
48441e9b53f9Sdrh **
4845ad879ffdSdrh ** If regDest>=0 then the result is always stored in that register and the
4846ad879ffdSdrh ** result is not reusable.  If regDest<0 then this routine is free to
4847ad879ffdSdrh ** store the value whereever it wants.  The register where the expression
48489b258c54Sdrh ** is stored is returned.  When regDest<0, two identical expressions might
48499b258c54Sdrh ** code to the same register, if they do not contain function calls and hence
48509b258c54Sdrh ** are factored out into the initialization section at the end of the
48519b258c54Sdrh ** prepared statement.
4852d1a01edaSdrh */
48539b258c54Sdrh int sqlite3ExprCodeRunJustOnce(
4854d673cddaSdrh   Parse *pParse,    /* Parsing context */
4855d673cddaSdrh   Expr *pExpr,      /* The expression to code when the VDBE initializes */
4856ad879ffdSdrh   int regDest       /* Store the value in this register */
4857d673cddaSdrh ){
4858d1a01edaSdrh   ExprList *p;
4859d9f158e7Sdrh   assert( ConstFactorOk(pParse) );
4860d1a01edaSdrh   p = pParse->pConstExpr;
4861ad879ffdSdrh   if( regDest<0 && p ){
48621e9b53f9Sdrh     struct ExprList_item *pItem;
48631e9b53f9Sdrh     int i;
48641e9b53f9Sdrh     for(pItem=p->a, i=p->nExpr; i>0; pItem++, i--){
4865d88fd539Sdrh       if( pItem->fg.reusable
4866d88fd539Sdrh        && sqlite3ExprCompare(0,pItem->pExpr,pExpr,-1)==0
4867d88fd539Sdrh       ){
48681e9b53f9Sdrh         return pItem->u.iConstExprReg;
48691e9b53f9Sdrh       }
48701e9b53f9Sdrh     }
48711e9b53f9Sdrh   }
4872d1a01edaSdrh   pExpr = sqlite3ExprDup(pParse->db, pExpr, 0);
487338dfbdaeSdrh   if( pExpr!=0 && ExprHasProperty(pExpr, EP_HasFunc) ){
487438dfbdaeSdrh     Vdbe *v = pParse->pVdbe;
487538dfbdaeSdrh     int addr;
487638dfbdaeSdrh     assert( v );
487738dfbdaeSdrh     addr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
487838dfbdaeSdrh     pParse->okConstFactor = 0;
487938dfbdaeSdrh     if( !pParse->db->mallocFailed ){
48809b258c54Sdrh       if( regDest<0 ) regDest = ++pParse->nMem;
488138dfbdaeSdrh       sqlite3ExprCode(pParse, pExpr, regDest);
488238dfbdaeSdrh     }
488338dfbdaeSdrh     pParse->okConstFactor = 1;
488438dfbdaeSdrh     sqlite3ExprDelete(pParse->db, pExpr);
488538dfbdaeSdrh     sqlite3VdbeJumpHere(v, addr);
488638dfbdaeSdrh   }else{
4887d1a01edaSdrh     p = sqlite3ExprListAppend(pParse, p, pExpr);
4888d673cddaSdrh     if( p ){
4889d673cddaSdrh        struct ExprList_item *pItem = &p->a[p->nExpr-1];
4890d88fd539Sdrh        pItem->fg.reusable = regDest<0;
48919b258c54Sdrh        if( regDest<0 ) regDest = ++pParse->nMem;
4892d673cddaSdrh        pItem->u.iConstExprReg = regDest;
4893d673cddaSdrh     }
4894d1a01edaSdrh     pParse->pConstExpr = p;
489538dfbdaeSdrh   }
48961e9b53f9Sdrh   return regDest;
4897d1a01edaSdrh }
4898d1a01edaSdrh 
4899d1a01edaSdrh /*
49002dcef11bSdrh ** Generate code to evaluate an expression and store the results
49012dcef11bSdrh ** into a register.  Return the register number where the results
49022dcef11bSdrh ** are stored.
49032dcef11bSdrh **
49042dcef11bSdrh ** If the register is a temporary register that can be deallocated,
4905678ccce8Sdrh ** then write its number into *pReg.  If the result register is not
49062dcef11bSdrh ** a temporary, then set *pReg to zero.
4907f30a969bSdrh **
4908f30a969bSdrh ** If pExpr is a constant, then this routine might generate this
4909f30a969bSdrh ** code to fill the register in the initialization section of the
4910f30a969bSdrh ** VDBE program, in order to factor it out of the evaluation loop.
49112dcef11bSdrh */
49122dcef11bSdrh int sqlite3ExprCodeTemp(Parse *pParse, Expr *pExpr, int *pReg){
4913f30a969bSdrh   int r2;
49140d950af3Sdrh   pExpr = sqlite3ExprSkipCollateAndLikely(pExpr);
4915d9f158e7Sdrh   if( ConstFactorOk(pParse)
4916235667a8Sdrh    && ALWAYS(pExpr!=0)
4917f30a969bSdrh    && pExpr->op!=TK_REGISTER
4918f30a969bSdrh    && sqlite3ExprIsConstantNotJoin(pExpr)
4919f30a969bSdrh   ){
4920f30a969bSdrh     *pReg  = 0;
49219b258c54Sdrh     r2 = sqlite3ExprCodeRunJustOnce(pParse, pExpr, -1);
4922f30a969bSdrh   }else{
49232dcef11bSdrh     int r1 = sqlite3GetTempReg(pParse);
4924f30a969bSdrh     r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
49252dcef11bSdrh     if( r2==r1 ){
49262dcef11bSdrh       *pReg = r1;
49272dcef11bSdrh     }else{
49282dcef11bSdrh       sqlite3ReleaseTempReg(pParse, r1);
49292dcef11bSdrh       *pReg = 0;
49302dcef11bSdrh     }
4931f30a969bSdrh   }
49322dcef11bSdrh   return r2;
49332dcef11bSdrh }
49342dcef11bSdrh 
49352dcef11bSdrh /*
49362dcef11bSdrh ** Generate code that will evaluate expression pExpr and store the
49372dcef11bSdrh ** results in register target.  The results are guaranteed to appear
49382dcef11bSdrh ** in register target.
49392dcef11bSdrh */
494005a86c5cSdrh void sqlite3ExprCode(Parse *pParse, Expr *pExpr, int target){
49419cbf3425Sdrh   int inReg;
49429cbf3425Sdrh 
4943e7375bfaSdrh   assert( pExpr==0 || !ExprHasVVAProperty(pExpr,EP_Immutable) );
49449cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
49451c75c9d7Sdrh   assert( pParse->pVdbe!=0 || pParse->db->mallocFailed );
4946b639a209Sdrh   if( pParse->pVdbe==0 ) return;
4947b639a209Sdrh   inReg = sqlite3ExprCodeTarget(pParse, pExpr, target);
4948b639a209Sdrh   if( inReg!=target ){
4949629b88c6Sdrh     u8 op;
4950952f35b2Sdrh     if( ALWAYS(pExpr) && ExprHasProperty(pExpr,EP_Subquery) ){
4951629b88c6Sdrh       op = OP_Copy;
4952629b88c6Sdrh     }else{
4953629b88c6Sdrh       op = OP_SCopy;
4954629b88c6Sdrh     }
4955629b88c6Sdrh     sqlite3VdbeAddOp2(pParse->pVdbe, op, inReg, target);
495617a7f8ddSdrh   }
4957ebc16717Sdrh }
4958cce7d176Sdrh 
4959cce7d176Sdrh /*
49601c75c9d7Sdrh ** Make a transient copy of expression pExpr and then code it using
49611c75c9d7Sdrh ** sqlite3ExprCode().  This routine works just like sqlite3ExprCode()
49621c75c9d7Sdrh ** except that the input expression is guaranteed to be unchanged.
49631c75c9d7Sdrh */
49641c75c9d7Sdrh void sqlite3ExprCodeCopy(Parse *pParse, Expr *pExpr, int target){
49651c75c9d7Sdrh   sqlite3 *db = pParse->db;
49661c75c9d7Sdrh   pExpr = sqlite3ExprDup(db, pExpr, 0);
49671c75c9d7Sdrh   if( !db->mallocFailed ) sqlite3ExprCode(pParse, pExpr, target);
49681c75c9d7Sdrh   sqlite3ExprDelete(db, pExpr);
49691c75c9d7Sdrh }
49701c75c9d7Sdrh 
49711c75c9d7Sdrh /*
497205a86c5cSdrh ** Generate code that will evaluate expression pExpr and store the
497305a86c5cSdrh ** results in register target.  The results are guaranteed to appear
497405a86c5cSdrh ** in register target.  If the expression is constant, then this routine
497505a86c5cSdrh ** might choose to code the expression at initialization time.
497605a86c5cSdrh */
497705a86c5cSdrh void sqlite3ExprCodeFactorable(Parse *pParse, Expr *pExpr, int target){
4978b8b06690Sdrh   if( pParse->okConstFactor && sqlite3ExprIsConstantNotJoin(pExpr) ){
49799b258c54Sdrh     sqlite3ExprCodeRunJustOnce(pParse, pExpr, target);
498005a86c5cSdrh   }else{
4981088489e8Sdrh     sqlite3ExprCodeCopy(pParse, pExpr, target);
498205a86c5cSdrh   }
4983cce7d176Sdrh }
4984cce7d176Sdrh 
4985cce7d176Sdrh /*
4986268380caSdrh ** Generate code that pushes the value of every element of the given
49879cbf3425Sdrh ** expression list into a sequence of registers beginning at target.
4988268380caSdrh **
49893df6c3b1Sdrh ** Return the number of elements evaluated.  The number returned will
49903df6c3b1Sdrh ** usually be pList->nExpr but might be reduced if SQLITE_ECEL_OMITREF
49913df6c3b1Sdrh ** is defined.
4992d1a01edaSdrh **
4993d1a01edaSdrh ** The SQLITE_ECEL_DUP flag prevents the arguments from being
4994d1a01edaSdrh ** filled using OP_SCopy.  OP_Copy must be used instead.
4995d1a01edaSdrh **
4996d1a01edaSdrh ** The SQLITE_ECEL_FACTOR argument allows constant arguments to be
4997d1a01edaSdrh ** factored out into initialization code.
4998b0df9634Sdrh **
4999b0df9634Sdrh ** The SQLITE_ECEL_REF flag means that expressions in the list with
5000b0df9634Sdrh ** ExprList.a[].u.x.iOrderByCol>0 have already been evaluated and stored
5001b0df9634Sdrh ** in registers at srcReg, and so the value can be copied from there.
50023df6c3b1Sdrh ** If SQLITE_ECEL_OMITREF is also set, then the values with u.x.iOrderByCol>0
50033df6c3b1Sdrh ** are simply omitted rather than being copied from srcReg.
5004268380caSdrh */
50054adee20fSdanielk1977 int sqlite3ExprCodeExprList(
5006268380caSdrh   Parse *pParse,     /* Parsing context */
5007389a1adbSdrh   ExprList *pList,   /* The expression list to be coded */
5008191b54cbSdrh   int target,        /* Where to write results */
50095579d59fSdrh   int srcReg,        /* Source registers if SQLITE_ECEL_REF */
5010d1a01edaSdrh   u8 flags           /* SQLITE_ECEL_* flags */
5011268380caSdrh ){
5012268380caSdrh   struct ExprList_item *pItem;
50135579d59fSdrh   int i, j, n;
5014d1a01edaSdrh   u8 copyOp = (flags & SQLITE_ECEL_DUP) ? OP_Copy : OP_SCopy;
50155579d59fSdrh   Vdbe *v = pParse->pVdbe;
50169d8b3072Sdrh   assert( pList!=0 );
50179cbf3425Sdrh   assert( target>0 );
5018d81a142bSdrh   assert( pParse->pVdbe!=0 );  /* Never gets this far otherwise */
5019268380caSdrh   n = pList->nExpr;
5020d9f158e7Sdrh   if( !ConstFactorOk(pParse) ) flags &= ~SQLITE_ECEL_FACTOR;
5021191b54cbSdrh   for(pItem=pList->a, i=0; i<n; i++, pItem++){
50227445ffe2Sdrh     Expr *pExpr = pItem->pExpr;
502324e25d32Sdan #ifdef SQLITE_ENABLE_SORTER_REFERENCES
5024d88fd539Sdrh     if( pItem->fg.bSorterRef ){
502524e25d32Sdan       i--;
502624e25d32Sdan       n--;
502724e25d32Sdan     }else
502824e25d32Sdan #endif
5029257c13faSdan     if( (flags & SQLITE_ECEL_REF)!=0 && (j = pItem->u.x.iOrderByCol)>0 ){
5030257c13faSdan       if( flags & SQLITE_ECEL_OMITREF ){
5031257c13faSdan         i--;
5032257c13faSdan         n--;
5033257c13faSdan       }else{
50345579d59fSdrh         sqlite3VdbeAddOp2(v, copyOp, j+srcReg-1, target+i);
5035257c13faSdan       }
5036b8b06690Sdrh     }else if( (flags & SQLITE_ECEL_FACTOR)!=0
5037b8b06690Sdrh            && sqlite3ExprIsConstantNotJoin(pExpr)
5038b8b06690Sdrh     ){
50399b258c54Sdrh       sqlite3ExprCodeRunJustOnce(pParse, pExpr, target+i);
5040d1a01edaSdrh     }else{
50417445ffe2Sdrh       int inReg = sqlite3ExprCodeTarget(pParse, pExpr, target+i);
5042746fd9ccSdrh       if( inReg!=target+i ){
50434eded604Sdrh         VdbeOp *pOp;
50444eded604Sdrh         if( copyOp==OP_Copy
5045058e9950Sdrh          && (pOp=sqlite3VdbeGetLastOp(v))->opcode==OP_Copy
50464eded604Sdrh          && pOp->p1+pOp->p3+1==inReg
50474eded604Sdrh          && pOp->p2+pOp->p3+1==target+i
504890996885Sdrh          && pOp->p5==0  /* The do-not-merge flag must be clear */
50494eded604Sdrh         ){
50504eded604Sdrh           pOp->p3++;
50514eded604Sdrh         }else{
50524eded604Sdrh           sqlite3VdbeAddOp2(v, copyOp, inReg, target+i);
50534eded604Sdrh         }
5054d1a01edaSdrh       }
5055d176611bSdrh     }
5056268380caSdrh   }
5057f9b596ebSdrh   return n;
5058268380caSdrh }
5059268380caSdrh 
5060268380caSdrh /*
506136c563a2Sdrh ** Generate code for a BETWEEN operator.
506236c563a2Sdrh **
506336c563a2Sdrh **    x BETWEEN y AND z
506436c563a2Sdrh **
506536c563a2Sdrh ** The above is equivalent to
506636c563a2Sdrh **
506736c563a2Sdrh **    x>=y AND x<=z
506836c563a2Sdrh **
506936c563a2Sdrh ** Code it as such, taking care to do the common subexpression
507060ec914cSpeter.d.reid ** elimination of x.
507184b19a3dSdrh **
507284b19a3dSdrh ** The xJumpIf parameter determines details:
507384b19a3dSdrh **
507484b19a3dSdrh **    NULL:                   Store the boolean result in reg[dest]
507584b19a3dSdrh **    sqlite3ExprIfTrue:      Jump to dest if true
507684b19a3dSdrh **    sqlite3ExprIfFalse:     Jump to dest if false
507784b19a3dSdrh **
507884b19a3dSdrh ** The jumpIfNull parameter is ignored if xJumpIf is NULL.
507936c563a2Sdrh */
508036c563a2Sdrh static void exprCodeBetween(
508136c563a2Sdrh   Parse *pParse,    /* Parsing and code generating context */
508236c563a2Sdrh   Expr *pExpr,      /* The BETWEEN expression */
508384b19a3dSdrh   int dest,         /* Jump destination or storage location */
508484b19a3dSdrh   void (*xJump)(Parse*,Expr*,int,int), /* Action to take */
508536c563a2Sdrh   int jumpIfNull    /* Take the jump if the BETWEEN is NULL */
508636c563a2Sdrh ){
508736c563a2Sdrh   Expr exprAnd;     /* The AND operator in  x>=y AND x<=z  */
508836c563a2Sdrh   Expr compLeft;    /* The  x>=y  term */
508936c563a2Sdrh   Expr compRight;   /* The  x<=z  term */
5090db45bd5eSdrh   int regFree1 = 0; /* Temporary use register */
50918b65e591Sdan   Expr *pDel = 0;
50928b65e591Sdan   sqlite3 *db = pParse->db;
509384b19a3dSdrh 
509471c57db0Sdan   memset(&compLeft, 0, sizeof(Expr));
509571c57db0Sdan   memset(&compRight, 0, sizeof(Expr));
509671c57db0Sdan   memset(&exprAnd, 0, sizeof(Expr));
5097db45bd5eSdrh 
5098a4eeccdfSdrh   assert( ExprUseXList(pExpr) );
50998b65e591Sdan   pDel = sqlite3ExprDup(db, pExpr->pLeft, 0);
51008b65e591Sdan   if( db->mallocFailed==0 ){
510136c563a2Sdrh     exprAnd.op = TK_AND;
510236c563a2Sdrh     exprAnd.pLeft = &compLeft;
510336c563a2Sdrh     exprAnd.pRight = &compRight;
510436c563a2Sdrh     compLeft.op = TK_GE;
51058b65e591Sdan     compLeft.pLeft = pDel;
510636c563a2Sdrh     compLeft.pRight = pExpr->x.pList->a[0].pExpr;
510736c563a2Sdrh     compRight.op = TK_LE;
51088b65e591Sdan     compRight.pLeft = pDel;
510936c563a2Sdrh     compRight.pRight = pExpr->x.pList->a[1].pExpr;
51108b65e591Sdan     exprToRegister(pDel, exprCodeVector(pParse, pDel, &regFree1));
511184b19a3dSdrh     if( xJump ){
511284b19a3dSdrh       xJump(pParse, &exprAnd, dest, jumpIfNull);
511336c563a2Sdrh     }else{
511436fd41e5Sdrh       /* Mark the expression is being from the ON or USING clause of a join
511536fd41e5Sdrh       ** so that the sqlite3ExprCodeTarget() routine will not attempt to move
511636fd41e5Sdrh       ** it into the Parse.pConstExpr list.  We should use a new bit for this,
511736fd41e5Sdrh       ** for clarity, but we are out of bits in the Expr.flags field so we
511867a99dbeSdrh       ** have to reuse the EP_OuterON bit.  Bummer. */
511967a99dbeSdrh       pDel->flags |= EP_OuterON;
512071c57db0Sdan       sqlite3ExprCodeTarget(pParse, &exprAnd, dest);
512136c563a2Sdrh     }
5122db45bd5eSdrh     sqlite3ReleaseTempReg(pParse, regFree1);
51238b65e591Sdan   }
51248b65e591Sdan   sqlite3ExprDelete(db, pDel);
512536c563a2Sdrh 
512636c563a2Sdrh   /* Ensure adequate test coverage */
5127db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull==0 && regFree1==0 );
5128db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull==0 && regFree1!=0 );
5129db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull!=0 && regFree1==0 );
5130db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull!=0 && regFree1!=0 );
5131db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1==0 );
5132db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1!=0 );
5133db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1==0 );
5134db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1!=0 );
513584b19a3dSdrh   testcase( xJump==0 );
513636c563a2Sdrh }
513736c563a2Sdrh 
513836c563a2Sdrh /*
5139cce7d176Sdrh ** Generate code for a boolean expression such that a jump is made
5140cce7d176Sdrh ** to the label "dest" if the expression is true but execution
5141cce7d176Sdrh ** continues straight thru if the expression is false.
5142f5905aa7Sdrh **
5143f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false), then
514435573356Sdrh ** take the jump if the jumpIfNull flag is SQLITE_JUMPIFNULL.
5145f2bc013cSdrh **
5146f2bc013cSdrh ** This code depends on the fact that certain token values (ex: TK_EQ)
5147f2bc013cSdrh ** are the same as opcode values (ex: OP_Eq) that implement the corresponding
5148f2bc013cSdrh ** operation.  Special comments in vdbe.c and the mkopcodeh.awk script in
5149f2bc013cSdrh ** the make process cause these values to align.  Assert()s in the code
5150f2bc013cSdrh ** below verify that the numbers are aligned correctly.
5151cce7d176Sdrh */
51524adee20fSdanielk1977 void sqlite3ExprIfTrue(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
5153cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
5154cce7d176Sdrh   int op = 0;
51552dcef11bSdrh   int regFree1 = 0;
51562dcef11bSdrh   int regFree2 = 0;
51572dcef11bSdrh   int r1, r2;
51582dcef11bSdrh 
515935573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
516048864df9Smistachkin   if( NEVER(v==0) )     return;  /* Existence of VDBE checked by caller */
516133cd4909Sdrh   if( NEVER(pExpr==0) ) return;  /* No way this can happen */
5162e7375bfaSdrh   assert( !ExprHasVVAProperty(pExpr, EP_Immutable) );
5163f2bc013cSdrh   op = pExpr->op;
51647b35a77bSdan   switch( op ){
516517180fcaSdrh     case TK_AND:
516617180fcaSdrh     case TK_OR: {
516717180fcaSdrh       Expr *pAlt = sqlite3ExprSimplifiedAndOr(pExpr);
516817180fcaSdrh       if( pAlt!=pExpr ){
516917180fcaSdrh         sqlite3ExprIfTrue(pParse, pAlt, dest, jumpIfNull);
517017180fcaSdrh       }else if( op==TK_AND ){
5171ec4ccdbcSdrh         int d2 = sqlite3VdbeMakeLabel(pParse);
5172c5499befSdrh         testcase( jumpIfNull==0 );
517317180fcaSdrh         sqlite3ExprIfFalse(pParse, pExpr->pLeft, d2,
517417180fcaSdrh                            jumpIfNull^SQLITE_JUMPIFNULL);
51754adee20fSdanielk1977         sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
51764adee20fSdanielk1977         sqlite3VdbeResolveLabel(v, d2);
517717180fcaSdrh       }else{
5178c5499befSdrh         testcase( jumpIfNull==0 );
51794adee20fSdanielk1977         sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
51804adee20fSdanielk1977         sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
518117180fcaSdrh       }
5182cce7d176Sdrh       break;
5183cce7d176Sdrh     }
5184cce7d176Sdrh     case TK_NOT: {
5185c5499befSdrh       testcase( jumpIfNull==0 );
51864adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
5187cce7d176Sdrh       break;
5188cce7d176Sdrh     }
51898abed7b9Sdrh     case TK_TRUTH: {
519096acafbeSdrh       int isNot;      /* IS NOT TRUE or IS NOT FALSE */
519196acafbeSdrh       int isTrue;     /* IS TRUE or IS NOT TRUE */
5192007c843bSdrh       testcase( jumpIfNull==0 );
51938abed7b9Sdrh       isNot = pExpr->op2==TK_ISNOT;
519496acafbeSdrh       isTrue = sqlite3ExprTruthValue(pExpr->pRight);
519543c4ac8bSdrh       testcase( isTrue && isNot );
519696acafbeSdrh       testcase( !isTrue && isNot );
519743c4ac8bSdrh       if( isTrue ^ isNot ){
51988abed7b9Sdrh         sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
51998abed7b9Sdrh                           isNot ? SQLITE_JUMPIFNULL : 0);
52008abed7b9Sdrh       }else{
52018abed7b9Sdrh         sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
52028abed7b9Sdrh                            isNot ? SQLITE_JUMPIFNULL : 0);
52038abed7b9Sdrh       }
5204007c843bSdrh       break;
5205007c843bSdrh     }
5206de845c2fSdrh     case TK_IS:
5207de845c2fSdrh     case TK_ISNOT:
5208de845c2fSdrh       testcase( op==TK_IS );
5209de845c2fSdrh       testcase( op==TK_ISNOT );
5210de845c2fSdrh       op = (op==TK_IS) ? TK_EQ : TK_NE;
5211de845c2fSdrh       jumpIfNull = SQLITE_NULLEQ;
521208b92086Sdrh       /* no break */ deliberate_fall_through
5213cce7d176Sdrh     case TK_LT:
5214cce7d176Sdrh     case TK_LE:
5215cce7d176Sdrh     case TK_GT:
5216cce7d176Sdrh     case TK_GE:
5217cce7d176Sdrh     case TK_NE:
52180ac65892Sdrh     case TK_EQ: {
5219625015e0Sdan       if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
5220c5499befSdrh       testcase( jumpIfNull==0 );
5221b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
5222b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
522335573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
5224898c527eSdrh                   r1, r2, dest, jumpIfNull, ExprHasProperty(pExpr,EP_Commuted));
52257d176105Sdrh       assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
52267d176105Sdrh       assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
52277d176105Sdrh       assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
52287d176105Sdrh       assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
5229de845c2fSdrh       assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
5230de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
5231de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
5232de845c2fSdrh       assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
5233de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
5234de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
52356a2fe093Sdrh       testcase( regFree1==0 );
52366a2fe093Sdrh       testcase( regFree2==0 );
52376a2fe093Sdrh       break;
52386a2fe093Sdrh     }
5239cce7d176Sdrh     case TK_ISNULL:
5240cce7d176Sdrh     case TK_NOTNULL: {
52417d176105Sdrh       assert( TK_ISNULL==OP_IsNull );   testcase( op==TK_ISNULL );
52427d176105Sdrh       assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
52432dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
5244*e995d2c2Sdrh       sqlite3VdbeTypeofColumn(v, r1);
52452dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
52467d176105Sdrh       VdbeCoverageIf(v, op==TK_ISNULL);
52477d176105Sdrh       VdbeCoverageIf(v, op==TK_NOTNULL);
5248c5499befSdrh       testcase( regFree1==0 );
5249cce7d176Sdrh       break;
5250cce7d176Sdrh     }
5251fef5208cSdrh     case TK_BETWEEN: {
52525c03f30aSdrh       testcase( jumpIfNull==0 );
525371c57db0Sdan       exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfTrue, jumpIfNull);
5254fef5208cSdrh       break;
5255fef5208cSdrh     }
5256bb201344Sshaneh #ifndef SQLITE_OMIT_SUBQUERY
5257e3365e6cSdrh     case TK_IN: {
5258ec4ccdbcSdrh       int destIfFalse = sqlite3VdbeMakeLabel(pParse);
5259e3365e6cSdrh       int destIfNull = jumpIfNull ? dest : destIfFalse;
5260e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
5261076e85f5Sdrh       sqlite3VdbeGoto(v, dest);
5262e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
5263e3365e6cSdrh       break;
5264e3365e6cSdrh     }
5265bb201344Sshaneh #endif
5266cce7d176Sdrh     default: {
52677b35a77bSdan     default_expr:
5268ad31727fSdrh       if( ExprAlwaysTrue(pExpr) ){
5269076e85f5Sdrh         sqlite3VdbeGoto(v, dest);
5270ad31727fSdrh       }else if( ExprAlwaysFalse(pExpr) ){
5271991a1985Sdrh         /* No-op */
5272991a1985Sdrh       }else{
52732dcef11bSdrh         r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
52742dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_If, r1, dest, jumpIfNull!=0);
5275688852abSdrh         VdbeCoverage(v);
5276c5499befSdrh         testcase( regFree1==0 );
5277c5499befSdrh         testcase( jumpIfNull==0 );
5278991a1985Sdrh       }
5279cce7d176Sdrh       break;
5280cce7d176Sdrh     }
5281cce7d176Sdrh   }
52822dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
52832dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
5284cce7d176Sdrh }
5285cce7d176Sdrh 
5286cce7d176Sdrh /*
528766b89c8fSdrh ** Generate code for a boolean expression such that a jump is made
5288cce7d176Sdrh ** to the label "dest" if the expression is false but execution
5289cce7d176Sdrh ** continues straight thru if the expression is true.
5290f5905aa7Sdrh **
5291f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false) then
529235573356Sdrh ** jump if jumpIfNull is SQLITE_JUMPIFNULL or fall through if jumpIfNull
529335573356Sdrh ** is 0.
5294cce7d176Sdrh */
52954adee20fSdanielk1977 void sqlite3ExprIfFalse(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
5296cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
5297cce7d176Sdrh   int op = 0;
52982dcef11bSdrh   int regFree1 = 0;
52992dcef11bSdrh   int regFree2 = 0;
53002dcef11bSdrh   int r1, r2;
53012dcef11bSdrh 
530235573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
530348864df9Smistachkin   if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
530433cd4909Sdrh   if( pExpr==0 )    return;
5305e7375bfaSdrh   assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
5306f2bc013cSdrh 
5307f2bc013cSdrh   /* The value of pExpr->op and op are related as follows:
5308f2bc013cSdrh   **
5309f2bc013cSdrh   **       pExpr->op            op
5310f2bc013cSdrh   **       ---------          ----------
5311f2bc013cSdrh   **       TK_ISNULL          OP_NotNull
5312f2bc013cSdrh   **       TK_NOTNULL         OP_IsNull
5313f2bc013cSdrh   **       TK_NE              OP_Eq
5314f2bc013cSdrh   **       TK_EQ              OP_Ne
5315f2bc013cSdrh   **       TK_GT              OP_Le
5316f2bc013cSdrh   **       TK_LE              OP_Gt
5317f2bc013cSdrh   **       TK_GE              OP_Lt
5318f2bc013cSdrh   **       TK_LT              OP_Ge
5319f2bc013cSdrh   **
5320f2bc013cSdrh   ** For other values of pExpr->op, op is undefined and unused.
5321f2bc013cSdrh   ** The value of TK_ and OP_ constants are arranged such that we
5322f2bc013cSdrh   ** can compute the mapping above using the following expression.
5323f2bc013cSdrh   ** Assert()s verify that the computation is correct.
5324f2bc013cSdrh   */
5325f2bc013cSdrh   op = ((pExpr->op+(TK_ISNULL&1))^1)-(TK_ISNULL&1);
5326f2bc013cSdrh 
5327f2bc013cSdrh   /* Verify correct alignment of TK_ and OP_ constants
5328f2bc013cSdrh   */
5329f2bc013cSdrh   assert( pExpr->op!=TK_ISNULL || op==OP_NotNull );
5330f2bc013cSdrh   assert( pExpr->op!=TK_NOTNULL || op==OP_IsNull );
5331f2bc013cSdrh   assert( pExpr->op!=TK_NE || op==OP_Eq );
5332f2bc013cSdrh   assert( pExpr->op!=TK_EQ || op==OP_Ne );
5333f2bc013cSdrh   assert( pExpr->op!=TK_LT || op==OP_Ge );
5334f2bc013cSdrh   assert( pExpr->op!=TK_LE || op==OP_Gt );
5335f2bc013cSdrh   assert( pExpr->op!=TK_GT || op==OP_Le );
5336f2bc013cSdrh   assert( pExpr->op!=TK_GE || op==OP_Lt );
5337f2bc013cSdrh 
5338ba00e30aSdan   switch( pExpr->op ){
533917180fcaSdrh     case TK_AND:
534017180fcaSdrh     case TK_OR: {
534117180fcaSdrh       Expr *pAlt = sqlite3ExprSimplifiedAndOr(pExpr);
534217180fcaSdrh       if( pAlt!=pExpr ){
534317180fcaSdrh         sqlite3ExprIfFalse(pParse, pAlt, dest, jumpIfNull);
534417180fcaSdrh       }else if( pExpr->op==TK_AND ){
5345c5499befSdrh         testcase( jumpIfNull==0 );
53464adee20fSdanielk1977         sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
53474adee20fSdanielk1977         sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
534817180fcaSdrh       }else{
5349ec4ccdbcSdrh         int d2 = sqlite3VdbeMakeLabel(pParse);
5350c5499befSdrh         testcase( jumpIfNull==0 );
535117180fcaSdrh         sqlite3ExprIfTrue(pParse, pExpr->pLeft, d2,
535217180fcaSdrh                           jumpIfNull^SQLITE_JUMPIFNULL);
53534adee20fSdanielk1977         sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
53544adee20fSdanielk1977         sqlite3VdbeResolveLabel(v, d2);
535517180fcaSdrh       }
5356cce7d176Sdrh       break;
5357cce7d176Sdrh     }
5358cce7d176Sdrh     case TK_NOT: {
53595c03f30aSdrh       testcase( jumpIfNull==0 );
53604adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
5361cce7d176Sdrh       break;
5362cce7d176Sdrh     }
53638abed7b9Sdrh     case TK_TRUTH: {
536496acafbeSdrh       int isNot;   /* IS NOT TRUE or IS NOT FALSE */
536596acafbeSdrh       int isTrue;  /* IS TRUE or IS NOT TRUE */
53668abed7b9Sdrh       testcase( jumpIfNull==0 );
53678abed7b9Sdrh       isNot = pExpr->op2==TK_ISNOT;
536896acafbeSdrh       isTrue = sqlite3ExprTruthValue(pExpr->pRight);
536943c4ac8bSdrh       testcase( isTrue && isNot );
537096acafbeSdrh       testcase( !isTrue && isNot );
537143c4ac8bSdrh       if( isTrue ^ isNot ){
53728abed7b9Sdrh         /* IS TRUE and IS NOT FALSE */
53738abed7b9Sdrh         sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
53748abed7b9Sdrh                            isNot ? 0 : SQLITE_JUMPIFNULL);
53758abed7b9Sdrh 
53768abed7b9Sdrh       }else{
53778abed7b9Sdrh         /* IS FALSE and IS NOT TRUE */
53788abed7b9Sdrh         sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
53798abed7b9Sdrh                           isNot ? 0 : SQLITE_JUMPIFNULL);
53808abed7b9Sdrh       }
5381007c843bSdrh       break;
5382007c843bSdrh     }
5383de845c2fSdrh     case TK_IS:
5384de845c2fSdrh     case TK_ISNOT:
5385de845c2fSdrh       testcase( pExpr->op==TK_IS );
5386de845c2fSdrh       testcase( pExpr->op==TK_ISNOT );
5387de845c2fSdrh       op = (pExpr->op==TK_IS) ? TK_NE : TK_EQ;
5388de845c2fSdrh       jumpIfNull = SQLITE_NULLEQ;
538908b92086Sdrh       /* no break */ deliberate_fall_through
5390cce7d176Sdrh     case TK_LT:
5391cce7d176Sdrh     case TK_LE:
5392cce7d176Sdrh     case TK_GT:
5393cce7d176Sdrh     case TK_GE:
5394cce7d176Sdrh     case TK_NE:
5395cce7d176Sdrh     case TK_EQ: {
5396625015e0Sdan       if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
5397c5499befSdrh       testcase( jumpIfNull==0 );
5398b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
5399b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
540035573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
5401898c527eSdrh                   r1, r2, dest, jumpIfNull,ExprHasProperty(pExpr,EP_Commuted));
54027d176105Sdrh       assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
54037d176105Sdrh       assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
54047d176105Sdrh       assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
54057d176105Sdrh       assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
5406de845c2fSdrh       assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
5407de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
5408de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
5409de845c2fSdrh       assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
5410de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
5411de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
54126a2fe093Sdrh       testcase( regFree1==0 );
54136a2fe093Sdrh       testcase( regFree2==0 );
54146a2fe093Sdrh       break;
54156a2fe093Sdrh     }
5416cce7d176Sdrh     case TK_ISNULL:
5417cce7d176Sdrh     case TK_NOTNULL: {
54182dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
5419*e995d2c2Sdrh       sqlite3VdbeTypeofColumn(v, r1);
54202dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
54217d176105Sdrh       testcase( op==TK_ISNULL );   VdbeCoverageIf(v, op==TK_ISNULL);
54227d176105Sdrh       testcase( op==TK_NOTNULL );  VdbeCoverageIf(v, op==TK_NOTNULL);
5423c5499befSdrh       testcase( regFree1==0 );
5424cce7d176Sdrh       break;
5425cce7d176Sdrh     }
5426fef5208cSdrh     case TK_BETWEEN: {
54275c03f30aSdrh       testcase( jumpIfNull==0 );
542871c57db0Sdan       exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfFalse, jumpIfNull);
5429fef5208cSdrh       break;
5430fef5208cSdrh     }
5431bb201344Sshaneh #ifndef SQLITE_OMIT_SUBQUERY
5432e3365e6cSdrh     case TK_IN: {
5433e3365e6cSdrh       if( jumpIfNull ){
5434e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, dest);
5435e3365e6cSdrh       }else{
5436ec4ccdbcSdrh         int destIfNull = sqlite3VdbeMakeLabel(pParse);
5437e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, destIfNull);
5438e3365e6cSdrh         sqlite3VdbeResolveLabel(v, destIfNull);
5439e3365e6cSdrh       }
5440e3365e6cSdrh       break;
5441e3365e6cSdrh     }
5442bb201344Sshaneh #endif
5443cce7d176Sdrh     default: {
5444ba00e30aSdan     default_expr:
5445ad31727fSdrh       if( ExprAlwaysFalse(pExpr) ){
5446076e85f5Sdrh         sqlite3VdbeGoto(v, dest);
5447ad31727fSdrh       }else if( ExprAlwaysTrue(pExpr) ){
5448991a1985Sdrh         /* no-op */
5449991a1985Sdrh       }else{
54502dcef11bSdrh         r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
54512dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_IfNot, r1, dest, jumpIfNull!=0);
5452688852abSdrh         VdbeCoverage(v);
5453c5499befSdrh         testcase( regFree1==0 );
5454c5499befSdrh         testcase( jumpIfNull==0 );
5455991a1985Sdrh       }
5456cce7d176Sdrh       break;
5457cce7d176Sdrh     }
5458cce7d176Sdrh   }
54592dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
54602dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
5461cce7d176Sdrh }
54622282792aSdrh 
54632282792aSdrh /*
546472bc8208Sdrh ** Like sqlite3ExprIfFalse() except that a copy is made of pExpr before
546572bc8208Sdrh ** code generation, and that copy is deleted after code generation. This
546672bc8208Sdrh ** ensures that the original pExpr is unchanged.
546772bc8208Sdrh */
546872bc8208Sdrh void sqlite3ExprIfFalseDup(Parse *pParse, Expr *pExpr, int dest,int jumpIfNull){
546972bc8208Sdrh   sqlite3 *db = pParse->db;
547072bc8208Sdrh   Expr *pCopy = sqlite3ExprDup(db, pExpr, 0);
547172bc8208Sdrh   if( db->mallocFailed==0 ){
547272bc8208Sdrh     sqlite3ExprIfFalse(pParse, pCopy, dest, jumpIfNull);
547372bc8208Sdrh   }
547472bc8208Sdrh   sqlite3ExprDelete(db, pCopy);
547572bc8208Sdrh }
547672bc8208Sdrh 
54775aa550cfSdan /*
54785aa550cfSdan ** Expression pVar is guaranteed to be an SQL variable. pExpr may be any
54795aa550cfSdan ** type of expression.
54805aa550cfSdan **
54815aa550cfSdan ** If pExpr is a simple SQL value - an integer, real, string, blob
54825aa550cfSdan ** or NULL value - then the VDBE currently being prepared is configured
54835aa550cfSdan ** to re-prepare each time a new value is bound to variable pVar.
54845aa550cfSdan **
54855aa550cfSdan ** Additionally, if pExpr is a simple SQL value and the value is the
54865aa550cfSdan ** same as that currently bound to variable pVar, non-zero is returned.
54875aa550cfSdan ** Otherwise, if the values are not the same or if pExpr is not a simple
54885aa550cfSdan ** SQL value, zero is returned.
54895aa550cfSdan */
54901580d50bSdrh static int exprCompareVariable(
54911580d50bSdrh   const Parse *pParse,
54921580d50bSdrh   const Expr *pVar,
54931580d50bSdrh   const Expr *pExpr
54941580d50bSdrh ){
54955aa550cfSdan   int res = 0;
5496c0804226Sdrh   int iVar;
5497c0804226Sdrh   sqlite3_value *pL, *pR = 0;
54985aa550cfSdan 
54995aa550cfSdan   sqlite3ValueFromExpr(pParse->db, pExpr, SQLITE_UTF8, SQLITE_AFF_BLOB, &pR);
5500c0804226Sdrh   if( pR ){
5501c0804226Sdrh     iVar = pVar->iColumn;
5502c0804226Sdrh     sqlite3VdbeSetVarmask(pParse->pVdbe, iVar);
5503c0804226Sdrh     pL = sqlite3VdbeGetBoundValue(pParse->pReprepare, iVar, SQLITE_AFF_BLOB);
55045aa307e2Sdrh     if( pL ){
55055aa307e2Sdrh       if( sqlite3_value_type(pL)==SQLITE_TEXT ){
55065aa307e2Sdrh         sqlite3_value_text(pL); /* Make sure the encoding is UTF-8 */
55075aa307e2Sdrh       }
55085aa307e2Sdrh       res =  0==sqlite3MemCompare(pL, pR, 0);
55095aa550cfSdan     }
55105aa550cfSdan     sqlite3ValueFree(pR);
55115aa550cfSdan     sqlite3ValueFree(pL);
55125aa550cfSdan   }
55135aa550cfSdan 
55145aa550cfSdan   return res;
55155aa550cfSdan }
551672bc8208Sdrh 
551772bc8208Sdrh /*
55181d9da70aSdrh ** Do a deep comparison of two expression trees.  Return 0 if the two
55191d9da70aSdrh ** expressions are completely identical.  Return 1 if they differ only
55201d9da70aSdrh ** by a COLLATE operator at the top level.  Return 2 if there are differences
55211d9da70aSdrh ** other than the top-level COLLATE operator.
5522d40aab0eSdrh **
5523619a1305Sdrh ** If any subelement of pB has Expr.iTable==(-1) then it is allowed
5524619a1305Sdrh ** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
5525619a1305Sdrh **
552666518ca7Sdrh ** The pA side might be using TK_REGISTER.  If that is the case and pB is
552766518ca7Sdrh ** not using TK_REGISTER but is otherwise equivalent, then still return 0.
552866518ca7Sdrh **
55291d9da70aSdrh ** Sometimes this routine will return 2 even if the two expressions
5530d40aab0eSdrh ** really are equivalent.  If we cannot prove that the expressions are
55311d9da70aSdrh ** identical, we return 2 just to be safe.  So if this routine
55321d9da70aSdrh ** returns 2, then you do not really know for certain if the two
55331d9da70aSdrh ** expressions are the same.  But if you get a 0 or 1 return, then you
5534d40aab0eSdrh ** can be sure the expressions are the same.  In the places where
55351d9da70aSdrh ** this routine is used, it does not hurt to get an extra 2 - that
5536d40aab0eSdrh ** just might result in some slightly slower code.  But returning
55371d9da70aSdrh ** an incorrect 0 or 1 could lead to a malfunction.
55385aa550cfSdan **
5539c0804226Sdrh ** If pParse is not NULL then TK_VARIABLE terms in pA with bindings in
5540c0804226Sdrh ** pParse->pReprepare can be matched against literals in pB.  The
5541c0804226Sdrh ** pParse->pVdbe->expmask bitmask is updated for each variable referenced.
5542c0804226Sdrh ** If pParse is NULL (the normal case) then any TK_VARIABLE term in
5543c0804226Sdrh ** Argument pParse should normally be NULL. If it is not NULL and pA or
5544c0804226Sdrh ** pB causes a return value of 2.
55452282792aSdrh */
55461580d50bSdrh int sqlite3ExprCompare(
55471580d50bSdrh   const Parse *pParse,
55481580d50bSdrh   const Expr *pA,
55491580d50bSdrh   const Expr *pB,
55501580d50bSdrh   int iTab
55511580d50bSdrh ){
555210d1edf0Sdrh   u32 combinedFlags;
55534b202ae2Sdanielk1977   if( pA==0 || pB==0 ){
55541d9da70aSdrh     return pB==pA ? 0 : 2;
55552282792aSdrh   }
55565aa550cfSdan   if( pParse && pA->op==TK_VARIABLE && exprCompareVariable(pParse, pA, pB) ){
55575aa550cfSdan     return 0;
55585aa550cfSdan   }
555910d1edf0Sdrh   combinedFlags = pA->flags | pB->flags;
556010d1edf0Sdrh   if( combinedFlags & EP_IntValue ){
556110d1edf0Sdrh     if( (pA->flags&pB->flags&EP_IntValue)!=0 && pA->u.iValue==pB->u.iValue ){
556210d1edf0Sdrh       return 0;
556310d1edf0Sdrh     }
55641d9da70aSdrh     return 2;
55656ab3a2ecSdanielk1977   }
556616dd3985Sdan   if( pA->op!=pB->op || pA->op==TK_RAISE ){
55675aa550cfSdan     if( pA->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA->pLeft,pB,iTab)<2 ){
5568ae80ddeaSdrh       return 1;
5569ae80ddeaSdrh     }
55705aa550cfSdan     if( pB->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA,pB->pLeft,iTab)<2 ){
5571ae80ddeaSdrh       return 1;
5572ae80ddeaSdrh     }
5573ae80ddeaSdrh     return 2;
5574ae80ddeaSdrh   }
5575a51e6007Sdrh   assert( !ExprHasProperty(pA, EP_IntValue) );
5576f9751074Sdrh   assert( !ExprHasProperty(pB, EP_IntValue) );
5577a51e6007Sdrh   if( pA->u.zToken ){
55784f9adee2Sdan     if( pA->op==TK_FUNCTION || pA->op==TK_AGG_FUNCTION ){
5579390b88a4Sdrh       if( sqlite3StrICmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
5580eda079cdSdrh #ifndef SQLITE_OMIT_WINDOWFUNC
55814f9adee2Sdan       assert( pA->op==pB->op );
55824f9adee2Sdan       if( ExprHasProperty(pA,EP_WinFunc)!=ExprHasProperty(pB,EP_WinFunc) ){
55834f9adee2Sdan         return 2;
55844f9adee2Sdan       }
5585eda079cdSdrh       if( ExprHasProperty(pA,EP_WinFunc) ){
55864f9adee2Sdan         if( sqlite3WindowCompare(pParse, pA->y.pWin, pB->y.pWin, 1)!=0 ){
55874f9adee2Sdan           return 2;
55884f9adee2Sdan         }
5589eda079cdSdrh       }
5590eda079cdSdrh #endif
5591f20bbc5fSdrh     }else if( pA->op==TK_NULL ){
5592f20bbc5fSdrh       return 0;
5593d5af5420Sdrh     }else if( pA->op==TK_COLLATE ){
5594e79f6299Sdrh       if( sqlite3_stricmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
5595a51e6007Sdrh     }else
5596a51e6007Sdrh     if( pB->u.zToken!=0
5597a51e6007Sdrh      && pA->op!=TK_COLUMN
5598a51e6007Sdrh      && pA->op!=TK_AGG_COLUMN
5599a51e6007Sdrh      && strcmp(pA->u.zToken,pB->u.zToken)!=0
5600a51e6007Sdrh     ){
5601d5af5420Sdrh       return 2;
560210d1edf0Sdrh     }
560310d1edf0Sdrh   }
5604898c527eSdrh   if( (pA->flags & (EP_Distinct|EP_Commuted))
5605898c527eSdrh      != (pB->flags & (EP_Distinct|EP_Commuted)) ) return 2;
5606e7375bfaSdrh   if( ALWAYS((combinedFlags & EP_TokenOnly)==0) ){
560710d1edf0Sdrh     if( combinedFlags & EP_xIsSelect ) return 2;
5608efad2e23Sdrh     if( (combinedFlags & EP_FixedCol)==0
5609efad2e23Sdrh      && sqlite3ExprCompare(pParse, pA->pLeft, pB->pLeft, iTab) ) return 2;
56105aa550cfSdan     if( sqlite3ExprCompare(pParse, pA->pRight, pB->pRight, iTab) ) return 2;
5611619a1305Sdrh     if( sqlite3ExprListCompare(pA->x.pList, pB->x.pList, iTab) ) return 2;
561203c5c213Sdrh     if( pA->op!=TK_STRING
561303c5c213Sdrh      && pA->op!=TK_TRUEFALSE
5614e7375bfaSdrh      && ALWAYS((combinedFlags & EP_Reduced)==0)
561503c5c213Sdrh     ){
5616619a1305Sdrh       if( pA->iColumn!=pB->iColumn ) return 2;
56179b258c54Sdrh       if( pA->op2!=pB->op2 && pA->op==TK_TRUTH ) return 2;
56180f28e1bdSdrh       if( pA->op!=TK_IN && pA->iTable!=pB->iTable && pA->iTable!=iTab ){
56190f28e1bdSdrh         return 2;
56200f28e1bdSdrh       }
56211d9da70aSdrh     }
56221d9da70aSdrh   }
56232646da7eSdrh   return 0;
56242646da7eSdrh }
56252282792aSdrh 
56268c6f666bSdrh /*
5627fbb6e9ffSdan ** Compare two ExprList objects.  Return 0 if they are identical, 1
5628fbb6e9ffSdan ** if they are certainly different, or 2 if it is not possible to
5629fbb6e9ffSdan ** determine if they are identical or not.
56308c6f666bSdrh **
5631619a1305Sdrh ** If any subelement of pB has Expr.iTable==(-1) then it is allowed
5632619a1305Sdrh ** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
5633619a1305Sdrh **
56348c6f666bSdrh ** This routine might return non-zero for equivalent ExprLists.  The
56358c6f666bSdrh ** only consequence will be disabled optimizations.  But this routine
56368c6f666bSdrh ** must never return 0 if the two ExprList objects are different, or
56378c6f666bSdrh ** a malfunction will result.
56388c6f666bSdrh **
56398c6f666bSdrh ** Two NULL pointers are considered to be the same.  But a NULL pointer
56408c6f666bSdrh ** always differs from a non-NULL pointer.
56418c6f666bSdrh */
56421580d50bSdrh int sqlite3ExprListCompare(const ExprList *pA, const ExprList *pB, int iTab){
56438c6f666bSdrh   int i;
56448c6f666bSdrh   if( pA==0 && pB==0 ) return 0;
56458c6f666bSdrh   if( pA==0 || pB==0 ) return 1;
56468c6f666bSdrh   if( pA->nExpr!=pB->nExpr ) return 1;
56478c6f666bSdrh   for(i=0; i<pA->nExpr; i++){
5648fbb6e9ffSdan     int res;
56498c6f666bSdrh     Expr *pExprA = pA->a[i].pExpr;
56508c6f666bSdrh     Expr *pExprB = pB->a[i].pExpr;
5651d88fd539Sdrh     if( pA->a[i].fg.sortFlags!=pB->a[i].fg.sortFlags ) return 1;
5652fbb6e9ffSdan     if( (res = sqlite3ExprCompare(0, pExprA, pExprB, iTab)) ) return res;
56538c6f666bSdrh   }
56548c6f666bSdrh   return 0;
56558c6f666bSdrh }
565613449892Sdrh 
56572282792aSdrh /*
5658f9463dfbSdrh ** Like sqlite3ExprCompare() except COLLATE operators at the top-level
5659f9463dfbSdrh ** are ignored.
5660f9463dfbSdrh */
5661f9463dfbSdrh int sqlite3ExprCompareSkip(Expr *pA,Expr *pB, int iTab){
56625aa550cfSdan   return sqlite3ExprCompare(0,
56630d950af3Sdrh              sqlite3ExprSkipCollateAndLikely(pA),
56640d950af3Sdrh              sqlite3ExprSkipCollateAndLikely(pB),
5665f9463dfbSdrh              iTab);
5666f9463dfbSdrh }
5667f9463dfbSdrh 
5668f9463dfbSdrh /*
5669c51cf864Sdrh ** Return non-zero if Expr p can only be true if pNN is not NULL.
56707a231b49Sdrh **
56717a231b49Sdrh ** Or if seenNot is true, return non-zero if Expr p can only be
56727a231b49Sdrh ** non-NULL if pNN is not NULL
5673c51cf864Sdrh */
5674c51cf864Sdrh static int exprImpliesNotNull(
56751580d50bSdrh   const Parse *pParse,/* Parsing context */
56761580d50bSdrh   const Expr *p,      /* The expression to be checked */
56771580d50bSdrh   const Expr *pNN,    /* The expression that is NOT NULL */
5678c51cf864Sdrh   int iTab,           /* Table being evaluated */
56797a231b49Sdrh   int seenNot         /* Return true only if p can be any non-NULL value */
5680c51cf864Sdrh ){
5681c51cf864Sdrh   assert( p );
5682c51cf864Sdrh   assert( pNN );
568314c865e8Sdrh   if( sqlite3ExprCompare(pParse, p, pNN, iTab)==0 ){
568414c865e8Sdrh     return pNN->op!=TK_NULL;
568514c865e8Sdrh   }
5686c51cf864Sdrh   switch( p->op ){
5687c51cf864Sdrh     case TK_IN: {
5688c51cf864Sdrh       if( seenNot && ExprHasProperty(p, EP_xIsSelect) ) return 0;
5689a4eeccdfSdrh       assert( ExprUseXSelect(p) || (p->x.pList!=0 && p->x.pList->nExpr>0) );
5690ae144a1cSdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
5691c51cf864Sdrh     }
5692c51cf864Sdrh     case TK_BETWEEN: {
5693a4eeccdfSdrh       ExprList *pList;
5694a4eeccdfSdrh       assert( ExprUseXList(p) );
5695a4eeccdfSdrh       pList = p->x.pList;
5696c51cf864Sdrh       assert( pList!=0 );
5697c51cf864Sdrh       assert( pList->nExpr==2 );
5698c51cf864Sdrh       if( seenNot ) return 0;
56997a231b49Sdrh       if( exprImpliesNotNull(pParse, pList->a[0].pExpr, pNN, iTab, 1)
57007a231b49Sdrh        || exprImpliesNotNull(pParse, pList->a[1].pExpr, pNN, iTab, 1)
5701c51cf864Sdrh       ){
5702c51cf864Sdrh         return 1;
5703c51cf864Sdrh       }
57047a231b49Sdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
5705c51cf864Sdrh     }
5706c51cf864Sdrh     case TK_EQ:
5707c51cf864Sdrh     case TK_NE:
5708c51cf864Sdrh     case TK_LT:
5709c51cf864Sdrh     case TK_LE:
5710c51cf864Sdrh     case TK_GT:
5711c51cf864Sdrh     case TK_GE:
5712c51cf864Sdrh     case TK_PLUS:
5713c51cf864Sdrh     case TK_MINUS:
57149d23ea74Sdan     case TK_BITOR:
57159d23ea74Sdan     case TK_LSHIFT:
57169d23ea74Sdan     case TK_RSHIFT:
57179d23ea74Sdan     case TK_CONCAT:
57189d23ea74Sdan       seenNot = 1;
571908b92086Sdrh       /* no break */ deliberate_fall_through
5720c51cf864Sdrh     case TK_STAR:
5721c51cf864Sdrh     case TK_REM:
5722c51cf864Sdrh     case TK_BITAND:
57239d23ea74Sdan     case TK_SLASH: {
5724c51cf864Sdrh       if( exprImpliesNotNull(pParse, p->pRight, pNN, iTab, seenNot) ) return 1;
572508b92086Sdrh       /* no break */ deliberate_fall_through
5726c51cf864Sdrh     }
5727c51cf864Sdrh     case TK_SPAN:
5728c51cf864Sdrh     case TK_COLLATE:
5729c51cf864Sdrh     case TK_UPLUS:
5730c51cf864Sdrh     case TK_UMINUS: {
5731c51cf864Sdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, seenNot);
5732c51cf864Sdrh     }
5733c51cf864Sdrh     case TK_TRUTH: {
5734c51cf864Sdrh       if( seenNot ) return 0;
5735c51cf864Sdrh       if( p->op2!=TK_IS ) return 0;
573638cefc83Sdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
5737c51cf864Sdrh     }
57381cd382e3Sdan     case TK_BITNOT:
5739c51cf864Sdrh     case TK_NOT: {
5740c51cf864Sdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
5741c51cf864Sdrh     }
5742c51cf864Sdrh   }
5743c51cf864Sdrh   return 0;
5744c51cf864Sdrh }
5745c51cf864Sdrh 
5746c51cf864Sdrh /*
57474bd5f73fSdrh ** Return true if we can prove the pE2 will always be true if pE1 is
57484bd5f73fSdrh ** true.  Return false if we cannot complete the proof or if pE2 might
57494bd5f73fSdrh ** be false.  Examples:
57504bd5f73fSdrh **
5751619a1305Sdrh **     pE1: x==5       pE2: x==5             Result: true
57524bd5f73fSdrh **     pE1: x>0        pE2: x==5             Result: false
5753619a1305Sdrh **     pE1: x=21       pE2: x=21 OR y=43     Result: true
57544bd5f73fSdrh **     pE1: x!=123     pE2: x IS NOT NULL    Result: true
5755619a1305Sdrh **     pE1: x!=?1      pE2: x IS NOT NULL    Result: true
5756619a1305Sdrh **     pE1: x IS NULL  pE2: x IS NOT NULL    Result: false
5757619a1305Sdrh **     pE1: x IS ?2    pE2: x IS NOT NULL    Reuslt: false
57584bd5f73fSdrh **
57594bd5f73fSdrh ** When comparing TK_COLUMN nodes between pE1 and pE2, if pE2 has
57604bd5f73fSdrh ** Expr.iTable<0 then assume a table number given by iTab.
57614bd5f73fSdrh **
5762c0804226Sdrh ** If pParse is not NULL, then the values of bound variables in pE1 are
5763c0804226Sdrh ** compared against literal values in pE2 and pParse->pVdbe->expmask is
5764c0804226Sdrh ** modified to record which bound variables are referenced.  If pParse
5765c0804226Sdrh ** is NULL, then false will be returned if pE1 contains any bound variables.
5766c0804226Sdrh **
57674bd5f73fSdrh ** When in doubt, return false.  Returning true might give a performance
57684bd5f73fSdrh ** improvement.  Returning false might cause a performance reduction, but
57694bd5f73fSdrh ** it will always give the correct answer and is hence always safe.
57704bd5f73fSdrh */
57711580d50bSdrh int sqlite3ExprImpliesExpr(
57721580d50bSdrh   const Parse *pParse,
57731580d50bSdrh   const Expr *pE1,
57741580d50bSdrh   const Expr *pE2,
57751580d50bSdrh   int iTab
57761580d50bSdrh ){
57775aa550cfSdan   if( sqlite3ExprCompare(pParse, pE1, pE2, iTab)==0 ){
5778619a1305Sdrh     return 1;
5779619a1305Sdrh   }
5780619a1305Sdrh   if( pE2->op==TK_OR
57815aa550cfSdan    && (sqlite3ExprImpliesExpr(pParse, pE1, pE2->pLeft, iTab)
57825aa550cfSdan              || sqlite3ExprImpliesExpr(pParse, pE1, pE2->pRight, iTab) )
5783619a1305Sdrh   ){
5784619a1305Sdrh     return 1;
5785619a1305Sdrh   }
5786664d6d13Sdrh   if( pE2->op==TK_NOTNULL
5787c51cf864Sdrh    && exprImpliesNotNull(pParse, pE1, pE2->pLeft, iTab, 0)
5788664d6d13Sdrh   ){
5789c51cf864Sdrh     return 1;
5790619a1305Sdrh   }
5791619a1305Sdrh   return 0;
57924bd5f73fSdrh }
57934bd5f73fSdrh 
57944bd5f73fSdrh /*
57956c68d759Sdrh ** This is the Expr node callback for sqlite3ExprImpliesNonNullRow().
57962589787cSdrh ** If the expression node requires that the table at pWalker->iCur
5797f8937f90Sdrh ** have one or more non-NULL column, then set pWalker->eCode to 1 and abort.
5798f8937f90Sdrh **
5799f8937f90Sdrh ** This routine controls an optimization.  False positives (setting
5800f8937f90Sdrh ** pWalker->eCode to 1 when it should not be) are deadly, but false-negatives
5801f8937f90Sdrh ** (never setting pWalker->eCode) is a harmless missed optimization.
58022589787cSdrh */
58032589787cSdrh static int impliesNotNullRow(Walker *pWalker, Expr *pExpr){
5804f8937f90Sdrh   testcase( pExpr->op==TK_AGG_COLUMN );
5805821b610bSdrh   testcase( pExpr->op==TK_AGG_FUNCTION );
580667a99dbeSdrh   if( ExprHasProperty(pExpr, EP_OuterON) ) return WRC_Prune;
58072589787cSdrh   switch( pExpr->op ){
58080493222fSdan     case TK_ISNOT:
58092589787cSdrh     case TK_ISNULL:
5810d5793672Sdrh     case TK_NOTNULL:
58112589787cSdrh     case TK_IS:
58122589787cSdrh     case TK_OR:
58136c68d759Sdrh     case TK_VECTOR:
58142c492061Sdrh     case TK_CASE:
5815e3eff266Sdrh     case TK_IN:
58162589787cSdrh     case TK_FUNCTION:
5817da03c1e6Sdan     case TK_TRUTH:
58180493222fSdan       testcase( pExpr->op==TK_ISNOT );
5819821b610bSdrh       testcase( pExpr->op==TK_ISNULL );
5820d5793672Sdrh       testcase( pExpr->op==TK_NOTNULL );
5821821b610bSdrh       testcase( pExpr->op==TK_IS );
5822821b610bSdrh       testcase( pExpr->op==TK_OR );
58236c68d759Sdrh       testcase( pExpr->op==TK_VECTOR );
5824821b610bSdrh       testcase( pExpr->op==TK_CASE );
5825821b610bSdrh       testcase( pExpr->op==TK_IN );
5826821b610bSdrh       testcase( pExpr->op==TK_FUNCTION );
5827da03c1e6Sdan       testcase( pExpr->op==TK_TRUTH );
58282589787cSdrh       return WRC_Prune;
58292589787cSdrh     case TK_COLUMN:
58302589787cSdrh       if( pWalker->u.iCur==pExpr->iTable ){
58312589787cSdrh         pWalker->eCode = 1;
58322589787cSdrh         return WRC_Abort;
58332589787cSdrh       }
58342589787cSdrh       return WRC_Prune;
58359881155dSdrh 
58369d23ea74Sdan     case TK_AND:
5837aef81674Sdrh       if( pWalker->eCode==0 ){
58380287c951Sdan         sqlite3WalkExpr(pWalker, pExpr->pLeft);
58390287c951Sdan         if( pWalker->eCode ){
58400287c951Sdan           pWalker->eCode = 0;
58410287c951Sdan           sqlite3WalkExpr(pWalker, pExpr->pRight);
58429d23ea74Sdan         }
5843aef81674Sdrh       }
58449d23ea74Sdan       return WRC_Prune;
58459d23ea74Sdan 
58469d23ea74Sdan     case TK_BETWEEN:
58471d24a531Sdan       if( sqlite3WalkExpr(pWalker, pExpr->pLeft)==WRC_Abort ){
58481d24a531Sdan         assert( pWalker->eCode );
58491d24a531Sdan         return WRC_Abort;
58501d24a531Sdan       }
58519d23ea74Sdan       return WRC_Prune;
58529d23ea74Sdan 
58539881155dSdrh     /* Virtual tables are allowed to use constraints like x=NULL.  So
58549881155dSdrh     ** a term of the form x=y does not prove that y is not null if x
58559881155dSdrh     ** is the column of a virtual table */
58569881155dSdrh     case TK_EQ:
58579881155dSdrh     case TK_NE:
58589881155dSdrh     case TK_LT:
58599881155dSdrh     case TK_LE:
58609881155dSdrh     case TK_GT:
586178d1d225Sdrh     case TK_GE: {
586278d1d225Sdrh       Expr *pLeft = pExpr->pLeft;
586378d1d225Sdrh       Expr *pRight = pExpr->pRight;
58649881155dSdrh       testcase( pExpr->op==TK_EQ );
58659881155dSdrh       testcase( pExpr->op==TK_NE );
58669881155dSdrh       testcase( pExpr->op==TK_LT );
58679881155dSdrh       testcase( pExpr->op==TK_LE );
58689881155dSdrh       testcase( pExpr->op==TK_GT );
58699881155dSdrh       testcase( pExpr->op==TK_GE );
587078d1d225Sdrh       /* The y.pTab=0 assignment in wherecode.c always happens after the
587178d1d225Sdrh       ** impliesNotNullRow() test */
5872477572b9Sdrh       assert( pLeft->op!=TK_COLUMN || ExprUseYTab(pLeft) );
5873477572b9Sdrh       assert( pRight->op!=TK_COLUMN || ExprUseYTab(pRight) );
5874477572b9Sdrh       if( (pLeft->op==TK_COLUMN
5875477572b9Sdrh            && pLeft->y.pTab!=0
587678d1d225Sdrh            && IsVirtual(pLeft->y.pTab))
5877477572b9Sdrh        || (pRight->op==TK_COLUMN
5878477572b9Sdrh            && pRight->y.pTab!=0
587978d1d225Sdrh            && IsVirtual(pRight->y.pTab))
58809881155dSdrh       ){
58819881155dSdrh         return WRC_Prune;
58829881155dSdrh       }
588308b92086Sdrh       /* no break */ deliberate_fall_through
588478d1d225Sdrh     }
58852589787cSdrh     default:
58862589787cSdrh       return WRC_Continue;
58872589787cSdrh   }
58882589787cSdrh }
58892589787cSdrh 
58902589787cSdrh /*
58912589787cSdrh ** Return true (non-zero) if expression p can only be true if at least
58922589787cSdrh ** one column of table iTab is non-null.  In other words, return true
58932589787cSdrh ** if expression p will always be NULL or false if every column of iTab
58942589787cSdrh ** is NULL.
58952589787cSdrh **
5896821b610bSdrh ** False negatives are acceptable.  In other words, it is ok to return
5897821b610bSdrh ** zero even if expression p will never be true of every column of iTab
5898821b610bSdrh ** is NULL.  A false negative is merely a missed optimization opportunity.
5899821b610bSdrh **
5900821b610bSdrh ** False positives are not allowed, however.  A false positive may result
5901821b610bSdrh ** in an incorrect answer.
5902821b610bSdrh **
590367a99dbeSdrh ** Terms of p that are marked with EP_OuterON (and hence that come from
5904b77c07a7Sdrh ** the ON or USING clauses of OUTER JOINS) are excluded from the analysis.
59052589787cSdrh **
59062589787cSdrh ** This routine is used to check if a LEFT JOIN can be converted into
59072589787cSdrh ** an ordinary JOIN.  The p argument is the WHERE clause.  If the WHERE
59082589787cSdrh ** clause requires that some column of the right table of the LEFT JOIN
59092589787cSdrh ** be non-NULL, then the LEFT JOIN can be safely converted into an
59102589787cSdrh ** ordinary join.
59112589787cSdrh */
59122589787cSdrh int sqlite3ExprImpliesNonNullRow(Expr *p, int iTab){
59132589787cSdrh   Walker w;
59140d950af3Sdrh   p = sqlite3ExprSkipCollateAndLikely(p);
59154a254f98Sdrh   if( p==0 ) return 0;
59164a254f98Sdrh   if( p->op==TK_NOTNULL ){
5917d6db6598Sdrh     p = p->pLeft;
5918a1698993Sdrh   }else{
5919a1698993Sdrh     while( p->op==TK_AND ){
59204a254f98Sdrh       if( sqlite3ExprImpliesNonNullRow(p->pLeft, iTab) ) return 1;
59214a254f98Sdrh       p = p->pRight;
5922d6db6598Sdrh     }
5923a1698993Sdrh   }
59242589787cSdrh   w.xExprCallback = impliesNotNullRow;
59252589787cSdrh   w.xSelectCallback = 0;
59262589787cSdrh   w.xSelectCallback2 = 0;
59272589787cSdrh   w.eCode = 0;
59282589787cSdrh   w.u.iCur = iTab;
59292589787cSdrh   sqlite3WalkExpr(&w, p);
59302589787cSdrh   return w.eCode;
59312589787cSdrh }
59322589787cSdrh 
59332589787cSdrh /*
5934030796dfSdrh ** An instance of the following structure is used by the tree walker
59352409f8a1Sdrh ** to determine if an expression can be evaluated by reference to the
59362409f8a1Sdrh ** index only, without having to do a search for the corresponding
59372409f8a1Sdrh ** table entry.  The IdxCover.pIdx field is the index.  IdxCover.iCur
59382409f8a1Sdrh ** is the cursor for the table.
59392409f8a1Sdrh */
59402409f8a1Sdrh struct IdxCover {
59412409f8a1Sdrh   Index *pIdx;     /* The index to be tested for coverage */
59422409f8a1Sdrh   int iCur;        /* Cursor number for the table corresponding to the index */
59432409f8a1Sdrh };
59442409f8a1Sdrh 
59452409f8a1Sdrh /*
59462409f8a1Sdrh ** Check to see if there are references to columns in table
59472409f8a1Sdrh ** pWalker->u.pIdxCover->iCur can be satisfied using the index
59482409f8a1Sdrh ** pWalker->u.pIdxCover->pIdx.
59492409f8a1Sdrh */
59502409f8a1Sdrh static int exprIdxCover(Walker *pWalker, Expr *pExpr){
59512409f8a1Sdrh   if( pExpr->op==TK_COLUMN
59522409f8a1Sdrh    && pExpr->iTable==pWalker->u.pIdxCover->iCur
5953b9bcf7caSdrh    && sqlite3TableColumnToIndex(pWalker->u.pIdxCover->pIdx, pExpr->iColumn)<0
59542409f8a1Sdrh   ){
59552409f8a1Sdrh     pWalker->eCode = 1;
59562409f8a1Sdrh     return WRC_Abort;
59572409f8a1Sdrh   }
59582409f8a1Sdrh   return WRC_Continue;
59592409f8a1Sdrh }
59602409f8a1Sdrh 
59612409f8a1Sdrh /*
5962e604ec0bSdrh ** Determine if an index pIdx on table with cursor iCur contains will
5963e604ec0bSdrh ** the expression pExpr.  Return true if the index does cover the
5964e604ec0bSdrh ** expression and false if the pExpr expression references table columns
5965e604ec0bSdrh ** that are not found in the index pIdx.
59662409f8a1Sdrh **
59672409f8a1Sdrh ** An index covering an expression means that the expression can be
59682409f8a1Sdrh ** evaluated using only the index and without having to lookup the
59692409f8a1Sdrh ** corresponding table entry.
59702409f8a1Sdrh */
59712409f8a1Sdrh int sqlite3ExprCoveredByIndex(
59722409f8a1Sdrh   Expr *pExpr,        /* The index to be tested */
59732409f8a1Sdrh   int iCur,           /* The cursor number for the corresponding table */
59742409f8a1Sdrh   Index *pIdx         /* The index that might be used for coverage */
59752409f8a1Sdrh ){
59762409f8a1Sdrh   Walker w;
59772409f8a1Sdrh   struct IdxCover xcov;
59782409f8a1Sdrh   memset(&w, 0, sizeof(w));
59792409f8a1Sdrh   xcov.iCur = iCur;
59802409f8a1Sdrh   xcov.pIdx = pIdx;
59812409f8a1Sdrh   w.xExprCallback = exprIdxCover;
59822409f8a1Sdrh   w.u.pIdxCover = &xcov;
59832409f8a1Sdrh   sqlite3WalkExpr(&w, pExpr);
59842409f8a1Sdrh   return !w.eCode;
59852409f8a1Sdrh }
59862409f8a1Sdrh 
59872409f8a1Sdrh 
598890cf38beSdrh /* Structure used to pass information throught the Walker in order to
598990cf38beSdrh ** implement sqlite3ReferencesSrcList().
5990374fdce4Sdrh */
599190cf38beSdrh struct RefSrcList {
599290cf38beSdrh   sqlite3 *db;         /* Database connection used for sqlite3DbRealloc() */
599390cf38beSdrh   SrcList *pRef;       /* Looking for references to these tables */
5994913306a5Sdrh   i64 nExclude;        /* Number of tables to exclude from the search */
599590cf38beSdrh   int *aiExclude;      /* Cursor IDs for tables to exclude from the search */
5996030796dfSdrh };
5997030796dfSdrh 
5998030796dfSdrh /*
599990cf38beSdrh ** Walker SELECT callbacks for sqlite3ReferencesSrcList().
600090cf38beSdrh **
600190cf38beSdrh ** When entering a new subquery on the pExpr argument, add all FROM clause
600290cf38beSdrh ** entries for that subquery to the exclude list.
600390cf38beSdrh **
600490cf38beSdrh ** When leaving the subquery, remove those entries from the exclude list.
6005ed41a96bSdan */
600690cf38beSdrh static int selectRefEnter(Walker *pWalker, Select *pSelect){
600790cf38beSdrh   struct RefSrcList *p = pWalker->u.pRefSrcList;
600890cf38beSdrh   SrcList *pSrc = pSelect->pSrc;
6009913306a5Sdrh   i64 i, j;
6010913306a5Sdrh   int *piNew;
601190cf38beSdrh   if( pSrc->nSrc==0 ) return WRC_Continue;
601290cf38beSdrh   j = p->nExclude;
601390cf38beSdrh   p->nExclude += pSrc->nSrc;
601490cf38beSdrh   piNew = sqlite3DbRealloc(p->db, p->aiExclude, p->nExclude*sizeof(int));
601590cf38beSdrh   if( piNew==0 ){
601690cf38beSdrh     p->nExclude = 0;
601790cf38beSdrh     return WRC_Abort;
601890cf38beSdrh   }else{
601990cf38beSdrh     p->aiExclude = piNew;
602090cf38beSdrh   }
602190cf38beSdrh   for(i=0; i<pSrc->nSrc; i++, j++){
602290cf38beSdrh      p->aiExclude[j] = pSrc->a[i].iCursor;
6023ed41a96bSdan   }
6024ed41a96bSdan   return WRC_Continue;
6025ed41a96bSdan }
602690cf38beSdrh static void selectRefLeave(Walker *pWalker, Select *pSelect){
602790cf38beSdrh   struct RefSrcList *p = pWalker->u.pRefSrcList;
602890cf38beSdrh   SrcList *pSrc = pSelect->pSrc;
602990cf38beSdrh   if( p->nExclude ){
603090cf38beSdrh     assert( p->nExclude>=pSrc->nSrc );
603190cf38beSdrh     p->nExclude -= pSrc->nSrc;
603290cf38beSdrh   }
603390cf38beSdrh }
6034ed41a96bSdan 
603590cf38beSdrh /* This is the Walker EXPR callback for sqlite3ReferencesSrcList().
603690cf38beSdrh **
603790cf38beSdrh ** Set the 0x01 bit of pWalker->eCode if there is a reference to any
603890cf38beSdrh ** of the tables shown in RefSrcList.pRef.
603990cf38beSdrh **
604090cf38beSdrh ** Set the 0x02 bit of pWalker->eCode if there is a reference to a
604190cf38beSdrh ** table is in neither RefSrcList.pRef nor RefSrcList.aiExclude.
6042030796dfSdrh */
604390cf38beSdrh static int exprRefToSrcList(Walker *pWalker, Expr *pExpr){
604490cf38beSdrh   if( pExpr->op==TK_COLUMN
604590cf38beSdrh    || pExpr->op==TK_AGG_COLUMN
604690cf38beSdrh   ){
6047374fdce4Sdrh     int i;
604890cf38beSdrh     struct RefSrcList *p = pWalker->u.pRefSrcList;
604990cf38beSdrh     SrcList *pSrc = p->pRef;
6050655814d2Sdrh     int nSrc = pSrc ? pSrc->nSrc : 0;
6051655814d2Sdrh     for(i=0; i<nSrc; i++){
605290cf38beSdrh       if( pExpr->iTable==pSrc->a[i].iCursor ){
605390cf38beSdrh         pWalker->eCode |= 1;
605490cf38beSdrh         return WRC_Continue;
6055374fdce4Sdrh       }
605690cf38beSdrh     }
605790cf38beSdrh     for(i=0; i<p->nExclude && p->aiExclude[i]!=pExpr->iTable; i++){}
605890cf38beSdrh     if( i>=p->nExclude ){
605990cf38beSdrh       pWalker->eCode |= 2;
6060374fdce4Sdrh     }
6061374fdce4Sdrh   }
6062030796dfSdrh   return WRC_Continue;
6063030796dfSdrh }
6064374fdce4Sdrh 
6065374fdce4Sdrh /*
606690cf38beSdrh ** Check to see if pExpr references any tables in pSrcList.
606790cf38beSdrh ** Possible return values:
606890cf38beSdrh **
606990cf38beSdrh **    1         pExpr does references a table in pSrcList.
607090cf38beSdrh **
607190cf38beSdrh **    0         pExpr references some table that is not defined in either
607290cf38beSdrh **              pSrcList or in subqueries of pExpr itself.
607390cf38beSdrh **
607490cf38beSdrh **   -1         pExpr only references no tables at all, or it only
607590cf38beSdrh **              references tables defined in subqueries of pExpr itself.
607690cf38beSdrh **
607790cf38beSdrh ** As currently used, pExpr is always an aggregate function call.  That
607890cf38beSdrh ** fact is exploited for efficiency.
6079374fdce4Sdrh */
608090cf38beSdrh int sqlite3ReferencesSrcList(Parse *pParse, Expr *pExpr, SrcList *pSrcList){
6081374fdce4Sdrh   Walker w;
608290cf38beSdrh   struct RefSrcList x;
608341ce47c4Sdrh   assert( pParse->db!=0 );
608480f6bfc0Sdrh   memset(&w, 0, sizeof(w));
608590cf38beSdrh   memset(&x, 0, sizeof(x));
608690cf38beSdrh   w.xExprCallback = exprRefToSrcList;
608790cf38beSdrh   w.xSelectCallback = selectRefEnter;
608890cf38beSdrh   w.xSelectCallback2 = selectRefLeave;
608990cf38beSdrh   w.u.pRefSrcList = &x;
609090cf38beSdrh   x.db = pParse->db;
609190cf38beSdrh   x.pRef = pSrcList;
609290cf38beSdrh   assert( pExpr->op==TK_AGG_FUNCTION );
6093a4eeccdfSdrh   assert( ExprUseXList(pExpr) );
6094030796dfSdrh   sqlite3WalkExprList(&w, pExpr->x.pList);
60955e484cb3Sdan #ifndef SQLITE_OMIT_WINDOWFUNC
60965e484cb3Sdan   if( ExprHasProperty(pExpr, EP_WinFunc) ){
60975e484cb3Sdan     sqlite3WalkExpr(&w, pExpr->y.pWin->pFilter);
60985e484cb3Sdan   }
60995e484cb3Sdan #endif
610041ce47c4Sdrh   if( x.aiExclude ) sqlite3DbNNFreeNN(pParse->db, x.aiExclude);
610190cf38beSdrh   if( w.eCode & 0x01 ){
610290cf38beSdrh     return 1;
610390cf38beSdrh   }else if( w.eCode ){
610490cf38beSdrh     return 0;
610590cf38beSdrh   }else{
610690cf38beSdrh     return -1;
610790cf38beSdrh   }
6108374fdce4Sdrh }
6109374fdce4Sdrh 
6110374fdce4Sdrh /*
611189636628Sdrh ** This is a Walker expression node callback.
611289636628Sdrh **
611389636628Sdrh ** For Expr nodes that contain pAggInfo pointers, make sure the AggInfo
611489636628Sdrh ** object that is referenced does not refer directly to the Expr.  If
611589636628Sdrh ** it does, make a copy.  This is done because the pExpr argument is
611689636628Sdrh ** subject to change.
611789636628Sdrh **
611889636628Sdrh ** The copy is stored on pParse->pConstExpr with a register number of 0.
611989636628Sdrh ** This will cause the expression to be deleted automatically when the
612089636628Sdrh ** Parse object is destroyed, but the zero register number means that it
612189636628Sdrh ** will not generate any code in the preamble.
612289636628Sdrh */
612389636628Sdrh static int agginfoPersistExprCb(Walker *pWalker, Expr *pExpr){
61242f82acc0Sdrh   if( ALWAYS(!ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced))
612589636628Sdrh    && pExpr->pAggInfo!=0
612689636628Sdrh   ){
612789636628Sdrh     AggInfo *pAggInfo = pExpr->pAggInfo;
612889636628Sdrh     int iAgg = pExpr->iAgg;
612989636628Sdrh     Parse *pParse = pWalker->pParse;
613089636628Sdrh     sqlite3 *db = pParse->db;
6131fe888bcfSdrh     if( pExpr->op!=TK_AGG_FUNCTION ){
6132fe888bcfSdrh       assert( pExpr->op==TK_AGG_COLUMN || pExpr->op==TK_IF_NULL_ROW );
613389636628Sdrh       assert( iAgg>=0 && iAgg<pAggInfo->nColumn );
613481185a51Sdrh       if( pAggInfo->aCol[iAgg].pCExpr==pExpr ){
613589636628Sdrh         pExpr = sqlite3ExprDup(db, pExpr, 0);
613689636628Sdrh         if( pExpr ){
613781185a51Sdrh           pAggInfo->aCol[iAgg].pCExpr = pExpr;
6138b3ad4e61Sdrh           sqlite3ExprDeferredDelete(pParse, pExpr);
613989636628Sdrh         }
614089636628Sdrh       }
614189636628Sdrh     }else{
6142fe888bcfSdrh       assert( pExpr->op==TK_AGG_FUNCTION );
614389636628Sdrh       assert( iAgg>=0 && iAgg<pAggInfo->nFunc );
614481185a51Sdrh       if( pAggInfo->aFunc[iAgg].pFExpr==pExpr ){
614589636628Sdrh         pExpr = sqlite3ExprDup(db, pExpr, 0);
614689636628Sdrh         if( pExpr ){
614781185a51Sdrh           pAggInfo->aFunc[iAgg].pFExpr = pExpr;
6148b3ad4e61Sdrh           sqlite3ExprDeferredDelete(pParse, pExpr);
614989636628Sdrh         }
615089636628Sdrh       }
615189636628Sdrh     }
615289636628Sdrh   }
615389636628Sdrh   return WRC_Continue;
615489636628Sdrh }
615589636628Sdrh 
615689636628Sdrh /*
615789636628Sdrh ** Initialize a Walker object so that will persist AggInfo entries referenced
615889636628Sdrh ** by the tree that is walked.
615989636628Sdrh */
616089636628Sdrh void sqlite3AggInfoPersistWalkerInit(Walker *pWalker, Parse *pParse){
616189636628Sdrh   memset(pWalker, 0, sizeof(*pWalker));
616289636628Sdrh   pWalker->pParse = pParse;
616389636628Sdrh   pWalker->xExprCallback = agginfoPersistExprCb;
616489636628Sdrh   pWalker->xSelectCallback = sqlite3SelectWalkNoop;
616589636628Sdrh }
616689636628Sdrh 
616789636628Sdrh /*
616813449892Sdrh ** Add a new element to the pAggInfo->aCol[] array.  Return the index of
616913449892Sdrh ** the new element.  Return a negative number if malloc fails.
61702282792aSdrh */
617117435752Sdrh static int addAggInfoColumn(sqlite3 *db, AggInfo *pInfo){
617213449892Sdrh   int i;
6173cf643729Sdrh   pInfo->aCol = sqlite3ArrayAllocate(
617417435752Sdrh        db,
6175cf643729Sdrh        pInfo->aCol,
6176cf643729Sdrh        sizeof(pInfo->aCol[0]),
6177cf643729Sdrh        &pInfo->nColumn,
6178cf643729Sdrh        &i
6179cf643729Sdrh   );
618013449892Sdrh   return i;
61812282792aSdrh }
618213449892Sdrh 
618313449892Sdrh /*
618413449892Sdrh ** Add a new element to the pAggInfo->aFunc[] array.  Return the index of
618513449892Sdrh ** the new element.  Return a negative number if malloc fails.
618613449892Sdrh */
618717435752Sdrh static int addAggInfoFunc(sqlite3 *db, AggInfo *pInfo){
618813449892Sdrh   int i;
6189cf643729Sdrh   pInfo->aFunc = sqlite3ArrayAllocate(
619017435752Sdrh        db,
6191cf643729Sdrh        pInfo->aFunc,
6192cf643729Sdrh        sizeof(pInfo->aFunc[0]),
6193cf643729Sdrh        &pInfo->nFunc,
6194cf643729Sdrh        &i
6195cf643729Sdrh   );
619613449892Sdrh   return i;
61972282792aSdrh }
61982282792aSdrh 
61992282792aSdrh /*
62007d10d5a6Sdrh ** This is the xExprCallback for a tree walker.  It is used to
62017d10d5a6Sdrh ** implement sqlite3ExprAnalyzeAggregates().  See sqlite3ExprAnalyzeAggregates
6202626a879aSdrh ** for additional information.
62032282792aSdrh */
62047d10d5a6Sdrh static int analyzeAggregate(Walker *pWalker, Expr *pExpr){
62052282792aSdrh   int i;
62067d10d5a6Sdrh   NameContext *pNC = pWalker->u.pNC;
6207a58fdfb1Sdanielk1977   Parse *pParse = pNC->pParse;
6208a58fdfb1Sdanielk1977   SrcList *pSrcList = pNC->pSrcList;
620925c3b8caSdrh   AggInfo *pAggInfo = pNC->uNC.pAggInfo;
621013449892Sdrh 
621125c3b8caSdrh   assert( pNC->ncFlags & NC_UAggInfo );
62122282792aSdrh   switch( pExpr->op ){
62136b6d6c6bSdrh     case TK_IF_NULL_ROW:
621489c69d00Sdrh     case TK_AGG_COLUMN:
6215967e8b73Sdrh     case TK_COLUMN: {
62168b213899Sdrh       testcase( pExpr->op==TK_AGG_COLUMN );
62178b213899Sdrh       testcase( pExpr->op==TK_COLUMN );
6218ee373020Sdrh       testcase( pExpr->op==TK_IF_NULL_ROW );
621913449892Sdrh       /* Check to see if the column is in one of the tables in the FROM
622013449892Sdrh       ** clause of the aggregate query */
622120bc393cSdrh       if( ALWAYS(pSrcList!=0) ){
62227601294aSdrh         SrcItem *pItem = pSrcList->a;
622313449892Sdrh         for(i=0; i<pSrcList->nSrc; i++, pItem++){
622413449892Sdrh           struct AggInfo_col *pCol;
6225c5cd1249Sdrh           assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
622613449892Sdrh           if( pExpr->iTable==pItem->iCursor ){
622713449892Sdrh             /* If we reach this point, it means that pExpr refers to a table
622813449892Sdrh             ** that is in the FROM clause of the aggregate query.
622913449892Sdrh             **
623013449892Sdrh             ** Make an entry for the column in pAggInfo->aCol[] if there
623113449892Sdrh             ** is not an entry there already.
623213449892Sdrh             */
62337f906d63Sdrh             int k;
623413449892Sdrh             pCol = pAggInfo->aCol;
62357f906d63Sdrh             for(k=0; k<pAggInfo->nColumn; k++, pCol++){
62364b1b65caSdrh               if( pCol->iTable==pExpr->iTable
62374b1b65caSdrh                && pCol->iColumn==pExpr->iColumn
62384b1b65caSdrh                && pExpr->op!=TK_IF_NULL_ROW
62394b1b65caSdrh               ){
62402282792aSdrh                 break;
62412282792aSdrh               }
62422282792aSdrh             }
62431e536953Sdanielk1977             if( (k>=pAggInfo->nColumn)
62441e536953Sdanielk1977              && (k = addAggInfoColumn(pParse->db, pAggInfo))>=0
62451e536953Sdanielk1977             ){
62467f906d63Sdrh               pCol = &pAggInfo->aCol[k];
6247477572b9Sdrh               assert( ExprUseYTab(pExpr) );
6248eda079cdSdrh               pCol->pTab = pExpr->y.pTab;
624913449892Sdrh               pCol->iTable = pExpr->iTable;
625013449892Sdrh               pCol->iColumn = pExpr->iColumn;
62510a07c107Sdrh               pCol->iMem = ++pParse->nMem;
625213449892Sdrh               pCol->iSorterColumn = -1;
625381185a51Sdrh               pCol->pCExpr = pExpr;
62544b1b65caSdrh               if( pAggInfo->pGroupBy && pExpr->op!=TK_IF_NULL_ROW ){
625513449892Sdrh                 int j, n;
625613449892Sdrh                 ExprList *pGB = pAggInfo->pGroupBy;
625713449892Sdrh                 struct ExprList_item *pTerm = pGB->a;
625813449892Sdrh                 n = pGB->nExpr;
625913449892Sdrh                 for(j=0; j<n; j++, pTerm++){
626013449892Sdrh                   Expr *pE = pTerm->pExpr;
62614b1b65caSdrh                   if( pE->op==TK_COLUMN
62624b1b65caSdrh                    && pE->iTable==pExpr->iTable
62634b1b65caSdrh                    && pE->iColumn==pExpr->iColumn
62644b1b65caSdrh                   ){
626513449892Sdrh                     pCol->iSorterColumn = j;
626613449892Sdrh                     break;
62672282792aSdrh                   }
626813449892Sdrh                 }
626913449892Sdrh               }
627013449892Sdrh               if( pCol->iSorterColumn<0 ){
627113449892Sdrh                 pCol->iSorterColumn = pAggInfo->nSortingColumn++;
627213449892Sdrh               }
627313449892Sdrh             }
627413449892Sdrh             /* There is now an entry for pExpr in pAggInfo->aCol[] (either
627513449892Sdrh             ** because it was there before or because we just created it).
627613449892Sdrh             ** Convert the pExpr to be a TK_AGG_COLUMN referring to that
627713449892Sdrh             ** pAggInfo->aCol[] entry.
627813449892Sdrh             */
6279ebb6a65dSdrh             ExprSetVVAProperty(pExpr, EP_NoReduce);
628013449892Sdrh             pExpr->pAggInfo = pAggInfo;
6281ee373020Sdrh             if( pExpr->op==TK_COLUMN ){
6282ee373020Sdrh               pExpr->op = TK_AGG_COLUMN;
6283ee373020Sdrh             }
6284cf697396Sshane             pExpr->iAgg = (i16)k;
628513449892Sdrh             break;
628613449892Sdrh           } /* endif pExpr->iTable==pItem->iCursor */
628713449892Sdrh         } /* end loop over pSrcList */
6288a58fdfb1Sdanielk1977       }
62897d10d5a6Sdrh       return WRC_Prune;
62902282792aSdrh     }
62912282792aSdrh     case TK_AGG_FUNCTION: {
62923a8c4be7Sdrh       if( (pNC->ncFlags & NC_InAggFunc)==0
6293ed551b95Sdrh        && pWalker->walkerDepth==pExpr->op2
62943a8c4be7Sdrh       ){
629513449892Sdrh         /* Check to see if pExpr is a duplicate of another aggregate
629613449892Sdrh         ** function that is already in the pAggInfo structure
629713449892Sdrh         */
629813449892Sdrh         struct AggInfo_func *pItem = pAggInfo->aFunc;
629913449892Sdrh         for(i=0; i<pAggInfo->nFunc; i++, pItem++){
630019e4eefbSdan           if( pItem->pFExpr==pExpr ) break;
630181185a51Sdrh           if( sqlite3ExprCompare(0, pItem->pFExpr, pExpr, -1)==0 ){
63022282792aSdrh             break;
63032282792aSdrh           }
63042282792aSdrh         }
630513449892Sdrh         if( i>=pAggInfo->nFunc ){
630613449892Sdrh           /* pExpr is original.  Make a new entry in pAggInfo->aFunc[]
630713449892Sdrh           */
630814db2665Sdanielk1977           u8 enc = ENC(pParse->db);
63091e536953Sdanielk1977           i = addAggInfoFunc(pParse->db, pAggInfo);
631013449892Sdrh           if( i>=0 ){
63116ab3a2ecSdanielk1977             assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
631213449892Sdrh             pItem = &pAggInfo->aFunc[i];
631381185a51Sdrh             pItem->pFExpr = pExpr;
63140a07c107Sdrh             pItem->iMem = ++pParse->nMem;
6315a4eeccdfSdrh             assert( ExprUseUToken(pExpr) );
631613449892Sdrh             pItem->pFunc = sqlite3FindFunction(pParse->db,
631780738d9cSdrh                    pExpr->u.zToken,
63186ab3a2ecSdanielk1977                    pExpr->x.pList ? pExpr->x.pList->nExpr : 0, enc, 0);
6319fd357974Sdrh             if( pExpr->flags & EP_Distinct ){
6320fd357974Sdrh               pItem->iDistinct = pParse->nTab++;
6321fd357974Sdrh             }else{
6322fd357974Sdrh               pItem->iDistinct = -1;
6323fd357974Sdrh             }
63242282792aSdrh           }
632513449892Sdrh         }
632613449892Sdrh         /* Make pExpr point to the appropriate pAggInfo->aFunc[] entry
632713449892Sdrh         */
6328c5cd1249Sdrh         assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
6329ebb6a65dSdrh         ExprSetVVAProperty(pExpr, EP_NoReduce);
6330cf697396Sshane         pExpr->iAgg = (i16)i;
633113449892Sdrh         pExpr->pAggInfo = pAggInfo;
63323a8c4be7Sdrh         return WRC_Prune;
63336e83a57fSdrh       }else{
63346e83a57fSdrh         return WRC_Continue;
63356e83a57fSdrh       }
63362282792aSdrh     }
6337a58fdfb1Sdanielk1977   }
63387d10d5a6Sdrh   return WRC_Continue;
63397d10d5a6Sdrh }
6340626a879aSdrh 
6341626a879aSdrh /*
6342e8abb4caSdrh ** Analyze the pExpr expression looking for aggregate functions and
6343e8abb4caSdrh ** for variables that need to be added to AggInfo object that pNC->pAggInfo
6344e8abb4caSdrh ** points to.  Additional entries are made on the AggInfo object as
6345e8abb4caSdrh ** necessary.
6346626a879aSdrh **
6347626a879aSdrh ** This routine should only be called after the expression has been
63487d10d5a6Sdrh ** analyzed by sqlite3ResolveExprNames().
6349626a879aSdrh */
6350d2b3e23bSdrh void sqlite3ExprAnalyzeAggregates(NameContext *pNC, Expr *pExpr){
63517d10d5a6Sdrh   Walker w;
63527d10d5a6Sdrh   w.xExprCallback = analyzeAggregate;
6353e40cc16bSdrh   w.xSelectCallback = sqlite3WalkerDepthIncrease;
6354e40cc16bSdrh   w.xSelectCallback2 = sqlite3WalkerDepthDecrease;
6355979dd1beSdrh   w.walkerDepth = 0;
63567d10d5a6Sdrh   w.u.pNC = pNC;
6357d9995031Sdan   w.pParse = 0;
635820bc393cSdrh   assert( pNC->pSrcList!=0 );
63597d10d5a6Sdrh   sqlite3WalkExpr(&w, pExpr);
63602282792aSdrh }
63615d9a4af9Sdrh 
63625d9a4af9Sdrh /*
63635d9a4af9Sdrh ** Call sqlite3ExprAnalyzeAggregates() for every expression in an
63645d9a4af9Sdrh ** expression list.  Return the number of errors.
63655d9a4af9Sdrh **
63665d9a4af9Sdrh ** If an error is found, the analysis is cut short.
63675d9a4af9Sdrh */
6368d2b3e23bSdrh void sqlite3ExprAnalyzeAggList(NameContext *pNC, ExprList *pList){
63695d9a4af9Sdrh   struct ExprList_item *pItem;
63705d9a4af9Sdrh   int i;
63715d9a4af9Sdrh   if( pList ){
6372d2b3e23bSdrh     for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
6373d2b3e23bSdrh       sqlite3ExprAnalyzeAggregates(pNC, pItem->pExpr);
63745d9a4af9Sdrh     }
63755d9a4af9Sdrh   }
63765d9a4af9Sdrh }
6377892d3179Sdrh 
6378892d3179Sdrh /*
6379ceea3321Sdrh ** Allocate a single new register for use to hold some intermediate result.
6380892d3179Sdrh */
6381892d3179Sdrh int sqlite3GetTempReg(Parse *pParse){
6382e55cbd72Sdrh   if( pParse->nTempReg==0 ){
6383892d3179Sdrh     return ++pParse->nMem;
6384892d3179Sdrh   }
63852f425f6bSdanielk1977   return pParse->aTempReg[--pParse->nTempReg];
6386892d3179Sdrh }
6387ceea3321Sdrh 
6388ceea3321Sdrh /*
6389ceea3321Sdrh ** Deallocate a register, making available for reuse for some other
6390ceea3321Sdrh ** purpose.
6391ceea3321Sdrh */
6392892d3179Sdrh void sqlite3ReleaseTempReg(Parse *pParse, int iReg){
639313d79502Sdrh   if( iReg ){
63943aef2fb1Sdrh     sqlite3VdbeReleaseRegisters(pParse, iReg, 1, 0, 0);
639513d79502Sdrh     if( pParse->nTempReg<ArraySize(pParse->aTempReg) ){
6396892d3179Sdrh       pParse->aTempReg[pParse->nTempReg++] = iReg;
6397892d3179Sdrh     }
6398892d3179Sdrh   }
639913d79502Sdrh }
6400892d3179Sdrh 
6401892d3179Sdrh /*
6402ed24da4bSdrh ** Allocate or deallocate a block of nReg consecutive registers.
6403892d3179Sdrh */
6404892d3179Sdrh int sqlite3GetTempRange(Parse *pParse, int nReg){
6405e55cbd72Sdrh   int i, n;
6406ed24da4bSdrh   if( nReg==1 ) return sqlite3GetTempReg(pParse);
6407892d3179Sdrh   i = pParse->iRangeReg;
6408e55cbd72Sdrh   n = pParse->nRangeReg;
6409f49f3523Sdrh   if( nReg<=n ){
6410892d3179Sdrh     pParse->iRangeReg += nReg;
6411892d3179Sdrh     pParse->nRangeReg -= nReg;
6412892d3179Sdrh   }else{
6413892d3179Sdrh     i = pParse->nMem+1;
6414892d3179Sdrh     pParse->nMem += nReg;
6415892d3179Sdrh   }
6416892d3179Sdrh   return i;
6417892d3179Sdrh }
6418892d3179Sdrh void sqlite3ReleaseTempRange(Parse *pParse, int iReg, int nReg){
6419ed24da4bSdrh   if( nReg==1 ){
6420ed24da4bSdrh     sqlite3ReleaseTempReg(pParse, iReg);
6421ed24da4bSdrh     return;
6422ed24da4bSdrh   }
64233aef2fb1Sdrh   sqlite3VdbeReleaseRegisters(pParse, iReg, nReg, 0, 0);
6424892d3179Sdrh   if( nReg>pParse->nRangeReg ){
6425892d3179Sdrh     pParse->nRangeReg = nReg;
6426892d3179Sdrh     pParse->iRangeReg = iReg;
6427892d3179Sdrh   }
6428892d3179Sdrh }
6429cdc69557Sdrh 
6430cdc69557Sdrh /*
6431cdc69557Sdrh ** Mark all temporary registers as being unavailable for reuse.
64326d2566dfSdrh **
64336d2566dfSdrh ** Always invoke this procedure after coding a subroutine or co-routine
64346d2566dfSdrh ** that might be invoked from other parts of the code, to ensure that
64356d2566dfSdrh ** the sub/co-routine does not use registers in common with the code that
64366d2566dfSdrh ** invokes the sub/co-routine.
6437cdc69557Sdrh */
6438cdc69557Sdrh void sqlite3ClearTempRegCache(Parse *pParse){
6439cdc69557Sdrh   pParse->nTempReg = 0;
6440cdc69557Sdrh   pParse->nRangeReg = 0;
6441cdc69557Sdrh }
6442bb9b5f26Sdrh 
6443bb9b5f26Sdrh /*
6444bb9b5f26Sdrh ** Validate that no temporary register falls within the range of
6445bb9b5f26Sdrh ** iFirst..iLast, inclusive.  This routine is only call from within assert()
6446bb9b5f26Sdrh ** statements.
6447bb9b5f26Sdrh */
6448bb9b5f26Sdrh #ifdef SQLITE_DEBUG
6449bb9b5f26Sdrh int sqlite3NoTempsInRange(Parse *pParse, int iFirst, int iLast){
6450bb9b5f26Sdrh   int i;
6451bb9b5f26Sdrh   if( pParse->nRangeReg>0
64523963e584Sdrh    && pParse->iRangeReg+pParse->nRangeReg > iFirst
64533963e584Sdrh    && pParse->iRangeReg <= iLast
6454bb9b5f26Sdrh   ){
6455bb9b5f26Sdrh      return 0;
6456bb9b5f26Sdrh   }
6457bb9b5f26Sdrh   for(i=0; i<pParse->nTempReg; i++){
6458bb9b5f26Sdrh     if( pParse->aTempReg[i]>=iFirst && pParse->aTempReg[i]<=iLast ){
6459bb9b5f26Sdrh       return 0;
6460bb9b5f26Sdrh     }
6461bb9b5f26Sdrh   }
6462bb9b5f26Sdrh   return 1;
6463bb9b5f26Sdrh }
6464bb9b5f26Sdrh #endif /* SQLITE_DEBUG */
6465