xref: /sqlite-3.40.0/src/expr.c (revision 90cf38be)
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 );
212a4eeccdfSdrh         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){
7724b5255acSdanielk1977   int nHeight = 0;
7734b5255acSdanielk1977   heightOfExpr(p->pLeft, &nHeight);
7744b5255acSdanielk1977   heightOfExpr(p->pRight, &nHeight);
775a4eeccdfSdrh   if( ExprUseXSelect(p) ){
7766ab3a2ecSdanielk1977     heightOfSelect(p->x.pSelect, &nHeight);
7772308ed38Sdrh   }else if( p->x.pList ){
7786ab3a2ecSdanielk1977     heightOfExprList(p->x.pList, &nHeight);
7792308ed38Sdrh     p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
7806ab3a2ecSdanielk1977   }
7814b5255acSdanielk1977   p->nHeight = nHeight + 1;
7824b5255acSdanielk1977 }
7834b5255acSdanielk1977 
7844b5255acSdanielk1977 /*
7854b5255acSdanielk1977 ** Set the Expr.nHeight variable using the exprSetHeight() function. If
7864b5255acSdanielk1977 ** the height is greater than the maximum allowed expression depth,
7874b5255acSdanielk1977 ** leave an error in pParse.
7882308ed38Sdrh **
7892308ed38Sdrh ** Also propagate all EP_Propagate flags from the Expr.x.pList into
7902308ed38Sdrh ** Expr.flags.
7914b5255acSdanielk1977 */
7922308ed38Sdrh void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
79374893a4cSdrh   if( pParse->nErr ) return;
7944b5255acSdanielk1977   exprSetHeight(p);
7957d10d5a6Sdrh   sqlite3ExprCheckHeight(pParse, p->nHeight);
7964b5255acSdanielk1977 }
7974b5255acSdanielk1977 
7984b5255acSdanielk1977 /*
7994b5255acSdanielk1977 ** Return the maximum height of any expression tree referenced
8004b5255acSdanielk1977 ** by the select statement passed as an argument.
8014b5255acSdanielk1977 */
802b6dad520Sdrh int sqlite3SelectExprHeight(const Select *p){
8034b5255acSdanielk1977   int nHeight = 0;
8044b5255acSdanielk1977   heightOfSelect(p, &nHeight);
8054b5255acSdanielk1977   return nHeight;
8064b5255acSdanielk1977 }
8072308ed38Sdrh #else /* ABOVE:  Height enforcement enabled.  BELOW: Height enforcement off */
8082308ed38Sdrh /*
8092308ed38Sdrh ** Propagate all EP_Propagate flags from the Expr.x.pList into
8102308ed38Sdrh ** Expr.flags.
8112308ed38Sdrh */
8122308ed38Sdrh void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
8136c3b4b07Sdan   if( pParse->nErr ) return;
814a4eeccdfSdrh   if( p && ExprUseXList(p) && p->x.pList ){
8152308ed38Sdrh     p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
8162308ed38Sdrh   }
8172308ed38Sdrh }
8184b5255acSdanielk1977 #define exprSetHeight(y)
8194b5255acSdanielk1977 #endif /* SQLITE_MAX_EXPR_DEPTH>0 */
8204b5255acSdanielk1977 
821be5c89acSdrh /*
822b7916a78Sdrh ** This routine is the core allocator for Expr nodes.
823b7916a78Sdrh **
824a76b5dfcSdrh ** Construct a new expression node and return a pointer to it.  Memory
825b7916a78Sdrh ** for this node and for the pToken argument is a single allocation
826b7916a78Sdrh ** obtained from sqlite3DbMalloc().  The calling function
827a76b5dfcSdrh ** is responsible for making sure the node eventually gets freed.
828b7916a78Sdrh **
829b7916a78Sdrh ** If dequote is true, then the token (if it exists) is dequoted.
830e792b5b4Sdrh ** If dequote is false, no dequoting is performed.  The deQuote
831b7916a78Sdrh ** parameter is ignored if pToken is NULL or if the token does not
832b7916a78Sdrh ** appear to be quoted.  If the quotes were of the form "..." (double-quotes)
833b7916a78Sdrh ** then the EP_DblQuoted flag is set on the expression node.
83433e619fcSdrh **
83533e619fcSdrh ** Special case:  If op==TK_INTEGER and pToken points to a string that
83633e619fcSdrh ** can be translated into a 32-bit integer, then the token is not
83733e619fcSdrh ** stored in u.zToken.  Instead, the integer values is written
83833e619fcSdrh ** into u.iValue and the EP_IntValue flag is set.  No extra storage
83933e619fcSdrh ** is allocated to hold the integer text and the dequote flag is ignored.
840a76b5dfcSdrh */
841b7916a78Sdrh Expr *sqlite3ExprAlloc(
842cca8a4adSdrh   sqlite3 *db,            /* Handle for sqlite3DbMallocRawNN() */
84317435752Sdrh   int op,                 /* Expression opcode */
844b7916a78Sdrh   const Token *pToken,    /* Token argument.  Might be NULL */
845b7916a78Sdrh   int dequote             /* True to dequote */
84617435752Sdrh ){
847a76b5dfcSdrh   Expr *pNew;
84833e619fcSdrh   int nExtra = 0;
849cf697396Sshane   int iValue = 0;
850b7916a78Sdrh 
851575fad65Sdrh   assert( db!=0 );
852b7916a78Sdrh   if( pToken ){
85333e619fcSdrh     if( op!=TK_INTEGER || pToken->z==0
85433e619fcSdrh           || sqlite3GetInt32(pToken->z, &iValue)==0 ){
855b7916a78Sdrh       nExtra = pToken->n+1;
856d50ffc41Sdrh       assert( iValue>=0 );
85733e619fcSdrh     }
858a76b5dfcSdrh   }
859575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, sizeof(Expr)+nExtra);
860b7916a78Sdrh   if( pNew ){
861ca3862dcSdrh     memset(pNew, 0, sizeof(Expr));
8621bd10f8aSdrh     pNew->op = (u8)op;
863a58fdfb1Sdanielk1977     pNew->iAgg = -1;
864a76b5dfcSdrh     if( pToken ){
86533e619fcSdrh       if( nExtra==0 ){
866ad31727fSdrh         pNew->flags |= EP_IntValue|EP_Leaf|(iValue?EP_IsTrue:EP_IsFalse);
86733e619fcSdrh         pNew->u.iValue = iValue;
86833e619fcSdrh       }else{
86933e619fcSdrh         pNew->u.zToken = (char*)&pNew[1];
870b07028f7Sdrh         assert( pToken->z!=0 || pToken->n==0 );
871b07028f7Sdrh         if( pToken->n ) memcpy(pNew->u.zToken, pToken->z, pToken->n);
87233e619fcSdrh         pNew->u.zToken[pToken->n] = 0;
873244b9d6eSdrh         if( dequote && sqlite3Isquote(pNew->u.zToken[0]) ){
87451d35b0fSdrh           sqlite3DequoteExpr(pNew);
875a34001c9Sdrh         }
876a34001c9Sdrh       }
87733e619fcSdrh     }
878b7916a78Sdrh #if SQLITE_MAX_EXPR_DEPTH>0
879b7916a78Sdrh     pNew->nHeight = 1;
880b7916a78Sdrh #endif
881a34001c9Sdrh   }
882a76b5dfcSdrh   return pNew;
883a76b5dfcSdrh }
884a76b5dfcSdrh 
885a76b5dfcSdrh /*
886b7916a78Sdrh ** Allocate a new expression node from a zero-terminated token that has
887b7916a78Sdrh ** already been dequoted.
888b7916a78Sdrh */
889b7916a78Sdrh Expr *sqlite3Expr(
890b7916a78Sdrh   sqlite3 *db,            /* Handle for sqlite3DbMallocZero() (may be null) */
891b7916a78Sdrh   int op,                 /* Expression opcode */
892b7916a78Sdrh   const char *zToken      /* Token argument.  Might be NULL */
893b7916a78Sdrh ){
894b7916a78Sdrh   Token x;
895b7916a78Sdrh   x.z = zToken;
896b40f06c6Sdrh   x.n = sqlite3Strlen30(zToken);
897b7916a78Sdrh   return sqlite3ExprAlloc(db, op, &x, 0);
898b7916a78Sdrh }
899b7916a78Sdrh 
900b7916a78Sdrh /*
901b7916a78Sdrh ** Attach subtrees pLeft and pRight to the Expr node pRoot.
902b7916a78Sdrh **
903b7916a78Sdrh ** If pRoot==NULL that means that a memory allocation error has occurred.
904b7916a78Sdrh ** In that case, delete the subtrees pLeft and pRight.
905b7916a78Sdrh */
906b7916a78Sdrh void sqlite3ExprAttachSubtrees(
907b7916a78Sdrh   sqlite3 *db,
908b7916a78Sdrh   Expr *pRoot,
909b7916a78Sdrh   Expr *pLeft,
910b7916a78Sdrh   Expr *pRight
911b7916a78Sdrh ){
912b7916a78Sdrh   if( pRoot==0 ){
913b7916a78Sdrh     assert( db->mallocFailed );
914b7916a78Sdrh     sqlite3ExprDelete(db, pLeft);
915b7916a78Sdrh     sqlite3ExprDelete(db, pRight);
916b7916a78Sdrh   }else{
917b7916a78Sdrh     if( pRight ){
918b7916a78Sdrh       pRoot->pRight = pRight;
919885a5b03Sdrh       pRoot->flags |= EP_Propagate & pRight->flags;
920b7916a78Sdrh     }
921b7916a78Sdrh     if( pLeft ){
922b7916a78Sdrh       pRoot->pLeft = pLeft;
923885a5b03Sdrh       pRoot->flags |= EP_Propagate & pLeft->flags;
924b7916a78Sdrh     }
925b7916a78Sdrh     exprSetHeight(pRoot);
926b7916a78Sdrh   }
927b7916a78Sdrh }
928b7916a78Sdrh 
929b7916a78Sdrh /*
93060ec914cSpeter.d.reid ** Allocate an Expr node which joins as many as two subtrees.
931b7916a78Sdrh **
932bf664469Sdrh ** One or both of the subtrees can be NULL.  Return a pointer to the new
933bf664469Sdrh ** Expr node.  Or, if an OOM error occurs, set pParse->db->mallocFailed,
934bf664469Sdrh ** free the subtrees and return NULL.
935206f3d96Sdrh */
93617435752Sdrh Expr *sqlite3PExpr(
93717435752Sdrh   Parse *pParse,          /* Parsing context */
93817435752Sdrh   int op,                 /* Expression opcode */
93917435752Sdrh   Expr *pLeft,            /* Left operand */
940abfd35eaSdrh   Expr *pRight            /* Right operand */
94117435752Sdrh ){
9425fb52caaSdrh   Expr *p;
943abfd35eaSdrh   p = sqlite3DbMallocRawNN(pParse->db, sizeof(Expr));
944abfd35eaSdrh   if( p ){
945abfd35eaSdrh     memset(p, 0, sizeof(Expr));
946f1722baaSdrh     p->op = op & 0xff;
947abfd35eaSdrh     p->iAgg = -1;
948b7916a78Sdrh     sqlite3ExprAttachSubtrees(pParse->db, p, pLeft, pRight);
9492b359bdbSdan     sqlite3ExprCheckHeight(pParse, p->nHeight);
950d5c851c1Sdrh   }else{
951d5c851c1Sdrh     sqlite3ExprDelete(pParse->db, pLeft);
952d5c851c1Sdrh     sqlite3ExprDelete(pParse->db, pRight);
9532b359bdbSdan   }
9544e0cff60Sdrh   return p;
9554e0cff60Sdrh }
9564e0cff60Sdrh 
9574e0cff60Sdrh /*
95808de4f79Sdrh ** Add pSelect to the Expr.x.pSelect field.  Or, if pExpr is NULL (due
95908de4f79Sdrh ** do a memory allocation failure) then delete the pSelect object.
96008de4f79Sdrh */
96108de4f79Sdrh void sqlite3PExprAddSelect(Parse *pParse, Expr *pExpr, Select *pSelect){
96208de4f79Sdrh   if( pExpr ){
96308de4f79Sdrh     pExpr->x.pSelect = pSelect;
96408de4f79Sdrh     ExprSetProperty(pExpr, EP_xIsSelect|EP_Subquery);
96508de4f79Sdrh     sqlite3ExprSetHeightAndFlags(pParse, pExpr);
96608de4f79Sdrh   }else{
96708de4f79Sdrh     assert( pParse->db->mallocFailed );
96808de4f79Sdrh     sqlite3SelectDelete(pParse->db, pSelect);
96908de4f79Sdrh   }
97008de4f79Sdrh }
97108de4f79Sdrh 
9729289f510Sdan /*
9739289f510Sdan ** Expression list pEList is a list of vector values. This function
9749289f510Sdan ** converts the contents of pEList to a VALUES(...) Select statement
97574777f99Sdan ** returning 1 row for each element of the list. For example, the
97674777f99Sdan ** expression list:
9779289f510Sdan **
97874777f99Sdan **   ( (1,2), (3,4) (5,6) )
9799289f510Sdan **
98074777f99Sdan ** is translated to the equivalent of:
9819289f510Sdan **
98274777f99Sdan **   VALUES(1,2), (3,4), (5,6)
9839289f510Sdan **
98474777f99Sdan ** Each of the vector values in pEList must contain exactly nElem terms.
98574777f99Sdan ** If a list element that is not a vector or does not contain nElem terms,
98674777f99Sdan ** an error message is left in pParse.
9879289f510Sdan **
9889289f510Sdan ** This is used as part of processing IN(...) expressions with a list
9899289f510Sdan ** of vectors on the RHS. e.g. "... IN ((1,2), (3,4), (5,6))".
9909289f510Sdan */
99174777f99Sdan Select *sqlite3ExprListToValues(Parse *pParse, int nElem, ExprList *pEList){
9929289f510Sdan   int ii;
9939289f510Sdan   Select *pRet = 0;
9942931a66eSdan   assert( nElem>1 );
9959289f510Sdan   for(ii=0; ii<pEList->nExpr; ii++){
9969289f510Sdan     Select *pSel;
9979289f510Sdan     Expr *pExpr = pEList->a[ii].pExpr;
998a4eeccdfSdrh     int nExprElem;
999a4eeccdfSdrh     if( pExpr->op==TK_VECTOR ){
1000a4eeccdfSdrh       assert( ExprUseXList(pExpr) );
1001a4eeccdfSdrh       nExprElem = pExpr->x.pList->nExpr;
1002a4eeccdfSdrh     }else{
1003a4eeccdfSdrh       nExprElem = 1;
1004a4eeccdfSdrh     }
100574777f99Sdan     if( nExprElem!=nElem ){
100674777f99Sdan       sqlite3ErrorMsg(pParse, "IN(...) element has %d term%s - expected %d",
100774777f99Sdan           nExprElem, nExprElem>1?"s":"", nElem
100874777f99Sdan       );
100974777f99Sdan       break;
10109289f510Sdan     }
1011a4eeccdfSdrh     assert( ExprUseXList(pExpr) );
101274777f99Sdan     pSel = sqlite3SelectNew(pParse, pExpr->x.pList, 0, 0, 0, 0, 0, SF_Values,0);
101374777f99Sdan     pExpr->x.pList = 0;
10149289f510Sdan     if( pSel ){
10159289f510Sdan       if( pRet ){
10169289f510Sdan         pSel->op = TK_ALL;
10179289f510Sdan         pSel->pPrior = pRet;
10189289f510Sdan       }
10199289f510Sdan       pRet = pSel;
10209289f510Sdan     }
10219289f510Sdan   }
10229289f510Sdan 
10239289f510Sdan   if( pRet && pRet->pPrior ){
10249289f510Sdan     pRet->selFlags |= SF_MultiValue;
10259289f510Sdan   }
10269289f510Sdan   sqlite3ExprListDelete(pParse->db, pEList);
10279289f510Sdan   return pRet;
10289289f510Sdan }
102908de4f79Sdrh 
103008de4f79Sdrh /*
103191bb0eedSdrh ** Join two expressions using an AND operator.  If either expression is
103291bb0eedSdrh ** NULL, then just return the other expression.
10335fb52caaSdrh **
10345fb52caaSdrh ** If one side or the other of the AND is known to be false, then instead
10355fb52caaSdrh ** of returning an AND expression, just return a constant expression with
10365fb52caaSdrh ** a value of false.
103791bb0eedSdrh */
1038d5c851c1Sdrh Expr *sqlite3ExprAnd(Parse *pParse, Expr *pLeft, Expr *pRight){
1039d5c851c1Sdrh   sqlite3 *db = pParse->db;
104091bb0eedSdrh   if( pLeft==0  ){
104191bb0eedSdrh     return pRight;
104291bb0eedSdrh   }else if( pRight==0 ){
104391bb0eedSdrh     return pLeft;
10442b6e670fSdan   }else if( (ExprAlwaysFalse(pLeft) || ExprAlwaysFalse(pRight))
10452b6e670fSdan          && !IN_RENAME_OBJECT
10462b6e670fSdan   ){
1047b3ad4e61Sdrh     sqlite3ExprDeferredDelete(pParse, pLeft);
1048b3ad4e61Sdrh     sqlite3ExprDeferredDelete(pParse, pRight);
10495776ee5cSdrh     return sqlite3Expr(db, TK_INTEGER, "0");
105091bb0eedSdrh   }else{
1051d5c851c1Sdrh     return sqlite3PExpr(pParse, TK_AND, pLeft, pRight);
1052a76b5dfcSdrh   }
1053a76b5dfcSdrh }
1054a76b5dfcSdrh 
1055a76b5dfcSdrh /*
1056a76b5dfcSdrh ** Construct a new expression node for a function with multiple
1057a76b5dfcSdrh ** arguments.
1058a76b5dfcSdrh */
1059954733b3Sdrh Expr *sqlite3ExprFunction(
1060954733b3Sdrh   Parse *pParse,        /* Parsing context */
1061954733b3Sdrh   ExprList *pList,      /* Argument list */
1062b6dad520Sdrh   const Token *pToken,  /* Name of the function */
1063954733b3Sdrh   int eDistinct         /* SF_Distinct or SF_ALL or 0 */
1064954733b3Sdrh ){
1065a76b5dfcSdrh   Expr *pNew;
1066633e6d57Sdrh   sqlite3 *db = pParse->db;
10674b202ae2Sdanielk1977   assert( pToken );
1068b7916a78Sdrh   pNew = sqlite3ExprAlloc(db, TK_FUNCTION, pToken, 1);
1069a76b5dfcSdrh   if( pNew==0 ){
1070d9da78a2Sdrh     sqlite3ExprListDelete(db, pList); /* Avoid memory leak when malloc fails */
1071a76b5dfcSdrh     return 0;
1072a76b5dfcSdrh   }
107314a1b1c1Sdrh   if( pList
107414a1b1c1Sdrh    && pList->nExpr > pParse->db->aLimit[SQLITE_LIMIT_FUNCTION_ARG]
107514a1b1c1Sdrh    && !pParse->nested
107614a1b1c1Sdrh   ){
1077954733b3Sdrh     sqlite3ErrorMsg(pParse, "too many arguments on function %T", pToken);
1078954733b3Sdrh   }
10796ab3a2ecSdanielk1977   pNew->x.pList = pList;
1080fca23557Sdrh   ExprSetProperty(pNew, EP_HasFunc);
1081a4eeccdfSdrh   assert( ExprUseXList(pNew) );
10822308ed38Sdrh   sqlite3ExprSetHeightAndFlags(pParse, pNew);
1083954733b3Sdrh   if( eDistinct==SF_Distinct ) ExprSetProperty(pNew, EP_Distinct);
1084a76b5dfcSdrh   return pNew;
1085a76b5dfcSdrh }
1086a76b5dfcSdrh 
1087a76b5dfcSdrh /*
10880dfa5255Sdrh ** Check to see if a function is usable according to current access
10890dfa5255Sdrh ** rules:
10900dfa5255Sdrh **
10910dfa5255Sdrh **    SQLITE_FUNC_DIRECT    -     Only usable from top-level SQL
10920dfa5255Sdrh **
10930dfa5255Sdrh **    SQLITE_FUNC_UNSAFE    -     Usable if TRUSTED_SCHEMA or from
10940dfa5255Sdrh **                                top-level SQL
10950dfa5255Sdrh **
10960dfa5255Sdrh ** If the function is not usable, create an error.
10970dfa5255Sdrh */
10980dfa5255Sdrh void sqlite3ExprFunctionUsable(
10990dfa5255Sdrh   Parse *pParse,         /* Parsing and code generating context */
1100b6dad520Sdrh   const Expr *pExpr,     /* The function invocation */
1101b6dad520Sdrh   const FuncDef *pDef    /* The function being invoked */
11020dfa5255Sdrh ){
11030dfa5255Sdrh   assert( !IN_RENAME_OBJECT );
11042eeca204Sdrh   assert( (pDef->funcFlags & (SQLITE_FUNC_DIRECT|SQLITE_FUNC_UNSAFE))!=0 );
11052eeca204Sdrh   if( ExprHasProperty(pExpr, EP_FromDDL) ){
11060dfa5255Sdrh     if( (pDef->funcFlags & SQLITE_FUNC_DIRECT)!=0
11070dfa5255Sdrh      || (pParse->db->flags & SQLITE_TrustedSchema)==0
11080dfa5255Sdrh     ){
11090dfa5255Sdrh       /* Functions prohibited in triggers and views if:
11100dfa5255Sdrh       **     (1) tagged with SQLITE_DIRECTONLY
11110dfa5255Sdrh       **     (2) not tagged with SQLITE_INNOCUOUS (which means it
11120dfa5255Sdrh       **         is tagged with SQLITE_FUNC_UNSAFE) and
11130dfa5255Sdrh       **         SQLITE_DBCONFIG_TRUSTED_SCHEMA is off (meaning
11140dfa5255Sdrh       **         that the schema is possibly tainted).
11150dfa5255Sdrh       */
11160dfa5255Sdrh       sqlite3ErrorMsg(pParse, "unsafe use of %s()", pDef->zName);
11170dfa5255Sdrh     }
11180dfa5255Sdrh   }
11190dfa5255Sdrh }
11200dfa5255Sdrh 
11210dfa5255Sdrh /*
1122fa6bc000Sdrh ** Assign a variable number to an expression that encodes a wildcard
1123fa6bc000Sdrh ** in the original SQL statement.
1124fa6bc000Sdrh **
1125fa6bc000Sdrh ** Wildcards consisting of a single "?" are assigned the next sequential
1126fa6bc000Sdrh ** variable number.
1127fa6bc000Sdrh **
1128fa6bc000Sdrh ** Wildcards of the form "?nnn" are assigned the number "nnn".  We make
11299bf755ccSdrh ** sure "nnn" is not too big to avoid a denial of service attack when
1130fa6bc000Sdrh ** the SQL statement comes from an external source.
1131fa6bc000Sdrh **
113251f49f17Sdrh ** Wildcards of the form ":aaa", "@aaa", or "$aaa" are assigned the same number
1133fa6bc000Sdrh ** as the previous instance of the same wildcard.  Or if this is the first
113460ec914cSpeter.d.reid ** instance of the wildcard, the next sequential variable number is
1135fa6bc000Sdrh ** assigned.
1136fa6bc000Sdrh */
1137de25a88cSdrh void sqlite3ExprAssignVarNumber(Parse *pParse, Expr *pExpr, u32 n){
113817435752Sdrh   sqlite3 *db = pParse->db;
1139b7916a78Sdrh   const char *z;
1140f326d66dSdrh   ynVar x;
114117435752Sdrh 
1142fa6bc000Sdrh   if( pExpr==0 ) return;
1143c5cd1249Sdrh   assert( !ExprHasProperty(pExpr, EP_IntValue|EP_Reduced|EP_TokenOnly) );
114433e619fcSdrh   z = pExpr->u.zToken;
1145b7916a78Sdrh   assert( z!=0 );
1146b7916a78Sdrh   assert( z[0]!=0 );
1147b1ed717fSmistachkin   assert( n==(u32)sqlite3Strlen30(z) );
1148b7916a78Sdrh   if( z[1]==0 ){
1149fa6bc000Sdrh     /* Wildcard of the form "?".  Assign the next variable number */
1150b7916a78Sdrh     assert( z[0]=='?' );
1151f326d66dSdrh     x = (ynVar)(++pParse->nVar);
1152124c0b49Sdrh   }else{
1153f326d66dSdrh     int doAdd = 0;
1154124c0b49Sdrh     if( z[0]=='?' ){
1155fa6bc000Sdrh       /* Wildcard of the form "?nnn".  Convert "nnn" to an integer and
1156fa6bc000Sdrh       ** use it as the variable number */
1157c8d735aeSdan       i64 i;
115818814dfbSdrh       int bOk;
115918814dfbSdrh       if( n==2 ){ /*OPTIMIZATION-IF-TRUE*/
116018814dfbSdrh         i = z[1]-'0';  /* The common case of ?N for a single digit N */
116118814dfbSdrh         bOk = 1;
116218814dfbSdrh       }else{
116318814dfbSdrh         bOk = 0==sqlite3Atoi64(&z[1], &i, n-1, SQLITE_UTF8);
116418814dfbSdrh       }
1165c5499befSdrh       testcase( i==0 );
1166c5499befSdrh       testcase( i==1 );
1167c5499befSdrh       testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]-1 );
1168c5499befSdrh       testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] );
1169c8d735aeSdan       if( bOk==0 || i<1 || i>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
1170fa6bc000Sdrh         sqlite3ErrorMsg(pParse, "variable number must be between ?1 and ?%d",
1171bb4957f8Sdrh             db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]);
1172c9b39288Sdrh         return;
1173fa6bc000Sdrh       }
11748e74e7baSdrh       x = (ynVar)i;
1175f326d66dSdrh       if( x>pParse->nVar ){
1176f326d66dSdrh         pParse->nVar = (int)x;
1177f326d66dSdrh         doAdd = 1;
1178f326d66dSdrh       }else if( sqlite3VListNumToName(pParse->pVList, x)==0 ){
1179f326d66dSdrh         doAdd = 1;
1180fa6bc000Sdrh       }
1181fa6bc000Sdrh     }else{
118251f49f17Sdrh       /* Wildcards like ":aaa", "$aaa" or "@aaa".  Reuse the same variable
1183fa6bc000Sdrh       ** number as the prior appearance of the same name, or if the name
1184fa6bc000Sdrh       ** has never appeared before, reuse the same variable number
1185fa6bc000Sdrh       */
11869bf755ccSdrh       x = (ynVar)sqlite3VListNameToNum(pParse->pVList, z, n);
11879bf755ccSdrh       if( x==0 ){
11889bf755ccSdrh         x = (ynVar)(++pParse->nVar);
1189f326d66dSdrh         doAdd = 1;
1190f326d66dSdrh       }
1191f326d66dSdrh     }
1192f326d66dSdrh     if( doAdd ){
11939bf755ccSdrh       pParse->pVList = sqlite3VListAdd(db, pParse->pVList, z, n, x);
1194fa6bc000Sdrh     }
1195fa6bc000Sdrh   }
1196c9b39288Sdrh   pExpr->iColumn = x;
1197f326d66dSdrh   if( x>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
1198832b2664Sdanielk1977     sqlite3ErrorMsg(pParse, "too many SQL variables");
1199832b2664Sdanielk1977   }
1200fa6bc000Sdrh }
1201fa6bc000Sdrh 
1202fa6bc000Sdrh /*
1203f6963f99Sdan ** Recursively delete an expression tree.
1204a2e00042Sdrh */
12054f0010b1Sdrh static SQLITE_NOINLINE void sqlite3ExprDeleteNN(sqlite3 *db, Expr *p){
12064f0010b1Sdrh   assert( p!=0 );
1207477572b9Sdrh   assert( !ExprUseUValue(p) || p->u.iValue>=0 );
1208477572b9Sdrh   assert( !ExprUseYWin(p) || !ExprUseYSub(p) );
1209477572b9Sdrh   assert( !ExprUseYWin(p) || p->y.pWin!=0 || db->mallocFailed );
1210477572b9Sdrh   assert( p->op!=TK_FUNCTION || !ExprUseYSub(p) );
1211209bc522Sdrh #ifdef SQLITE_DEBUG
1212209bc522Sdrh   if( ExprHasProperty(p, EP_Leaf) && !ExprHasProperty(p, EP_TokenOnly) ){
1213209bc522Sdrh     assert( p->pLeft==0 );
1214209bc522Sdrh     assert( p->pRight==0 );
1215a4eeccdfSdrh     assert( !ExprUseXSelect(p) || p->x.pSelect==0 );
1216a4eeccdfSdrh     assert( !ExprUseXList(p) || p->x.pList==0 );
1217209bc522Sdrh   }
1218209bc522Sdrh #endif
1219209bc522Sdrh   if( !ExprHasProperty(p, (EP_TokenOnly|EP_Leaf)) ){
1220c5cd1249Sdrh     /* The Expr.x union is never used at the same time as Expr.pRight */
1221a4eeccdfSdrh     assert( (ExprUseXList(p) && p->x.pList==0) || p->pRight==0 );
12224910a76dSdrh     if( p->pLeft && p->op!=TK_SELECT_COLUMN ) sqlite3ExprDeleteNN(db, p->pLeft);
1223d1086679Sdrh     if( p->pRight ){
12244f9adee2Sdan       assert( !ExprHasProperty(p, EP_WinFunc) );
1225d1086679Sdrh       sqlite3ExprDeleteNN(db, p->pRight);
1226a4eeccdfSdrh     }else if( ExprUseXSelect(p) ){
12274f9adee2Sdan       assert( !ExprHasProperty(p, EP_WinFunc) );
12286ab3a2ecSdanielk1977       sqlite3SelectDelete(db, p->x.pSelect);
12296ab3a2ecSdanielk1977     }else{
12306ab3a2ecSdanielk1977       sqlite3ExprListDelete(db, p->x.pList);
12316ba7ab0dSdan #ifndef SQLITE_OMIT_WINDOWFUNC
1232eda079cdSdrh       if( ExprHasProperty(p, EP_WinFunc) ){
1233eda079cdSdrh         sqlite3WindowDelete(db, p->y.pWin);
123486fb6e17Sdan       }
12356ba7ab0dSdan #endif
12366ab3a2ecSdanielk1977     }
12378117f113Sdan   }
1238f9751074Sdrh   if( ExprHasProperty(p, EP_MemToken) ){
1239f9751074Sdrh     assert( !ExprHasProperty(p, EP_IntValue) );
1240f9751074Sdrh     sqlite3DbFree(db, p->u.zToken);
1241f9751074Sdrh   }
124233e619fcSdrh   if( !ExprHasProperty(p, EP_Static) ){
1243dbd6a7dcSdrh     sqlite3DbFreeNN(db, p);
1244a2e00042Sdrh   }
124533e619fcSdrh }
12464f0010b1Sdrh void sqlite3ExprDelete(sqlite3 *db, Expr *p){
12474f0010b1Sdrh   if( p ) sqlite3ExprDeleteNN(db, p);
12484f0010b1Sdrh }
1249a2e00042Sdrh 
1250b3ad4e61Sdrh 
1251b3ad4e61Sdrh /*
1252b3ad4e61Sdrh ** Arrange to cause pExpr to be deleted when the pParse is deleted.
1253b3ad4e61Sdrh ** This is similar to sqlite3ExprDelete() except that the delete is
1254b3ad4e61Sdrh ** deferred untilthe pParse is deleted.
1255b3ad4e61Sdrh **
1256b3ad4e61Sdrh ** The pExpr might be deleted immediately on an OOM error.
1257b3ad4e61Sdrh **
1258b3ad4e61Sdrh ** The deferred delete is (currently) implemented by adding the
1259b3ad4e61Sdrh ** pExpr to the pParse->pConstExpr list with a register number of 0.
1260b3ad4e61Sdrh */
1261b3ad4e61Sdrh void sqlite3ExprDeferredDelete(Parse *pParse, Expr *pExpr){
1262b3ad4e61Sdrh   pParse->pConstExpr =
1263b3ad4e61Sdrh       sqlite3ExprListAppend(pParse, pParse->pConstExpr, pExpr);
1264b3ad4e61Sdrh }
1265b3ad4e61Sdrh 
12668e34e406Sdrh /* Invoke sqlite3RenameExprUnmap() and sqlite3ExprDelete() on the
12678e34e406Sdrh ** expression.
12688e34e406Sdrh */
12698e34e406Sdrh void sqlite3ExprUnmapAndDelete(Parse *pParse, Expr *p){
12708e34e406Sdrh   if( p ){
12718e34e406Sdrh     if( IN_RENAME_OBJECT ){
12728e34e406Sdrh       sqlite3RenameExprUnmap(pParse, p);
12738e34e406Sdrh     }
12748e34e406Sdrh     sqlite3ExprDeleteNN(pParse->db, p);
12758e34e406Sdrh   }
12768e34e406Sdrh }
12778e34e406Sdrh 
1278d2687b77Sdrh /*
12796ab3a2ecSdanielk1977 ** Return the number of bytes allocated for the expression structure
12806ab3a2ecSdanielk1977 ** passed as the first argument. This is always one of EXPR_FULLSIZE,
12816ab3a2ecSdanielk1977 ** EXPR_REDUCEDSIZE or EXPR_TOKENONLYSIZE.
12826ab3a2ecSdanielk1977 */
1283b6dad520Sdrh static int exprStructSize(const Expr *p){
12846ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_TokenOnly) ) return EXPR_TOKENONLYSIZE;
12856ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_Reduced) ) return EXPR_REDUCEDSIZE;
12866ab3a2ecSdanielk1977   return EXPR_FULLSIZE;
12876ab3a2ecSdanielk1977 }
12886ab3a2ecSdanielk1977 
12896ab3a2ecSdanielk1977 /*
129033e619fcSdrh ** The dupedExpr*Size() routines each return the number of bytes required
129133e619fcSdrh ** to store a copy of an expression or expression tree.  They differ in
129233e619fcSdrh ** how much of the tree is measured.
129333e619fcSdrh **
129433e619fcSdrh **     dupedExprStructSize()     Size of only the Expr structure
129533e619fcSdrh **     dupedExprNodeSize()       Size of Expr + space for token
129633e619fcSdrh **     dupedExprSize()           Expr + token + subtree components
129733e619fcSdrh **
129833e619fcSdrh ***************************************************************************
129933e619fcSdrh **
130033e619fcSdrh ** The dupedExprStructSize() function returns two values OR-ed together:
130133e619fcSdrh ** (1) the space required for a copy of the Expr structure only and
130233e619fcSdrh ** (2) the EP_xxx flags that indicate what the structure size should be.
130333e619fcSdrh ** The return values is always one of:
130433e619fcSdrh **
130533e619fcSdrh **      EXPR_FULLSIZE
130633e619fcSdrh **      EXPR_REDUCEDSIZE   | EP_Reduced
130733e619fcSdrh **      EXPR_TOKENONLYSIZE | EP_TokenOnly
130833e619fcSdrh **
130933e619fcSdrh ** The size of the structure can be found by masking the return value
131033e619fcSdrh ** of this routine with 0xfff.  The flags can be found by masking the
131133e619fcSdrh ** return value with EP_Reduced|EP_TokenOnly.
131233e619fcSdrh **
131333e619fcSdrh ** Note that with flags==EXPRDUP_REDUCE, this routines works on full-size
131433e619fcSdrh ** (unreduced) Expr objects as they or originally constructed by the parser.
131533e619fcSdrh ** During expression analysis, extra information is computed and moved into
1316c95f38d4Sdan ** later parts of the Expr object and that extra information might get chopped
131733e619fcSdrh ** off if the expression is reduced.  Note also that it does not work to
131860ec914cSpeter.d.reid ** make an EXPRDUP_REDUCE copy of a reduced expression.  It is only legal
131933e619fcSdrh ** to reduce a pristine expression tree from the parser.  The implementation
132033e619fcSdrh ** of dupedExprStructSize() contain multiple assert() statements that attempt
132133e619fcSdrh ** to enforce this constraint.
13226ab3a2ecSdanielk1977 */
1323b6dad520Sdrh static int dupedExprStructSize(const Expr *p, int flags){
13246ab3a2ecSdanielk1977   int nSize;
132533e619fcSdrh   assert( flags==EXPRDUP_REDUCE || flags==0 ); /* Only one flag value allowed */
1326aecd8021Sdrh   assert( EXPR_FULLSIZE<=0xfff );
1327aecd8021Sdrh   assert( (0xfff & (EP_Reduced|EP_TokenOnly))==0 );
132867a9b8edSdan   if( 0==flags || p->op==TK_SELECT_COLUMN
132967a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
1330eda079cdSdrh    || ExprHasProperty(p, EP_WinFunc)
133167a9b8edSdan #endif
133267a9b8edSdan   ){
13336ab3a2ecSdanielk1977     nSize = EXPR_FULLSIZE;
13346ab3a2ecSdanielk1977   }else{
1335c5cd1249Sdrh     assert( !ExprHasProperty(p, EP_TokenOnly|EP_Reduced) );
133633e619fcSdrh     assert( !ExprHasProperty(p, EP_FromJoin) );
1337c5cd1249Sdrh     assert( !ExprHasProperty(p, EP_MemToken) );
1338e7375bfaSdrh     assert( !ExprHasVVAProperty(p, EP_NoReduce) );
1339aecd8021Sdrh     if( p->pLeft || p->x.pList ){
134033e619fcSdrh       nSize = EXPR_REDUCEDSIZE | EP_Reduced;
134133e619fcSdrh     }else{
1342aecd8021Sdrh       assert( p->pRight==0 );
134333e619fcSdrh       nSize = EXPR_TOKENONLYSIZE | EP_TokenOnly;
134433e619fcSdrh     }
13456ab3a2ecSdanielk1977   }
13466ab3a2ecSdanielk1977   return nSize;
13476ab3a2ecSdanielk1977 }
13486ab3a2ecSdanielk1977 
13496ab3a2ecSdanielk1977 /*
135033e619fcSdrh ** This function returns the space in bytes required to store the copy
135133e619fcSdrh ** of the Expr structure and a copy of the Expr.u.zToken string (if that
135233e619fcSdrh ** string is defined.)
13536ab3a2ecSdanielk1977 */
1354b6dad520Sdrh static int dupedExprNodeSize(const Expr *p, int flags){
135533e619fcSdrh   int nByte = dupedExprStructSize(p, flags) & 0xfff;
135633e619fcSdrh   if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
13577301e774Sdrh     nByte += sqlite3Strlen30NN(p->u.zToken)+1;
13586ab3a2ecSdanielk1977   }
1359bc73971dSdanielk1977   return ROUND8(nByte);
13606ab3a2ecSdanielk1977 }
13616ab3a2ecSdanielk1977 
13626ab3a2ecSdanielk1977 /*
13636ab3a2ecSdanielk1977 ** Return the number of bytes required to create a duplicate of the
13646ab3a2ecSdanielk1977 ** expression passed as the first argument. The second argument is a
13656ab3a2ecSdanielk1977 ** mask containing EXPRDUP_XXX flags.
13666ab3a2ecSdanielk1977 **
13676ab3a2ecSdanielk1977 ** The value returned includes space to create a copy of the Expr struct
136833e619fcSdrh ** itself and the buffer referred to by Expr.u.zToken, if any.
13696ab3a2ecSdanielk1977 **
13706ab3a2ecSdanielk1977 ** If the EXPRDUP_REDUCE flag is set, then the return value includes
13716ab3a2ecSdanielk1977 ** space to duplicate all Expr nodes in the tree formed by Expr.pLeft
13726ab3a2ecSdanielk1977 ** and Expr.pRight variables (but not for any structures pointed to or
13736ab3a2ecSdanielk1977 ** descended from the Expr.x.pList or Expr.x.pSelect variables).
13746ab3a2ecSdanielk1977 */
1375b6dad520Sdrh static int dupedExprSize(const Expr *p, int flags){
13766ab3a2ecSdanielk1977   int nByte = 0;
13776ab3a2ecSdanielk1977   if( p ){
13786ab3a2ecSdanielk1977     nByte = dupedExprNodeSize(p, flags);
13796ab3a2ecSdanielk1977     if( flags&EXPRDUP_REDUCE ){
1380b7916a78Sdrh       nByte += dupedExprSize(p->pLeft, flags) + dupedExprSize(p->pRight, flags);
13816ab3a2ecSdanielk1977     }
13826ab3a2ecSdanielk1977   }
13836ab3a2ecSdanielk1977   return nByte;
13846ab3a2ecSdanielk1977 }
13856ab3a2ecSdanielk1977 
13866ab3a2ecSdanielk1977 /*
13876ab3a2ecSdanielk1977 ** This function is similar to sqlite3ExprDup(), except that if pzBuffer
13886ab3a2ecSdanielk1977 ** is not NULL then *pzBuffer is assumed to point to a buffer large enough
138933e619fcSdrh ** to store the copy of expression p, the copies of p->u.zToken
13906ab3a2ecSdanielk1977 ** (if applicable), and the copies of the p->pLeft and p->pRight expressions,
139160ec914cSpeter.d.reid ** if any. Before returning, *pzBuffer is set to the first byte past the
13926ab3a2ecSdanielk1977 ** portion of the buffer copied into by this function.
13936ab3a2ecSdanielk1977 */
1394b6dad520Sdrh static Expr *exprDup(sqlite3 *db, const Expr *p, int dupFlags, u8 **pzBuffer){
13953c19469cSdrh   Expr *pNew;           /* Value to return */
13963c19469cSdrh   u8 *zAlloc;           /* Memory space from which to build Expr object */
13973c19469cSdrh   u32 staticFlag;       /* EP_Static if space not obtained from malloc */
13986ab3a2ecSdanielk1977 
13993c19469cSdrh   assert( db!=0 );
14003c19469cSdrh   assert( p );
14013c19469cSdrh   assert( dupFlags==0 || dupFlags==EXPRDUP_REDUCE );
14023c19469cSdrh   assert( pzBuffer==0 || dupFlags==EXPRDUP_REDUCE );
14036ab3a2ecSdanielk1977 
14046ab3a2ecSdanielk1977   /* Figure out where to write the new Expr structure. */
14056ab3a2ecSdanielk1977   if( pzBuffer ){
14066ab3a2ecSdanielk1977     zAlloc = *pzBuffer;
140733e619fcSdrh     staticFlag = EP_Static;
14083c6edc8aSdrh     assert( zAlloc!=0 );
14096ab3a2ecSdanielk1977   }else{
14103c19469cSdrh     zAlloc = sqlite3DbMallocRawNN(db, dupedExprSize(p, dupFlags));
14113c19469cSdrh     staticFlag = 0;
14126ab3a2ecSdanielk1977   }
14136ab3a2ecSdanielk1977   pNew = (Expr *)zAlloc;
14146ab3a2ecSdanielk1977 
14156ab3a2ecSdanielk1977   if( pNew ){
14166ab3a2ecSdanielk1977     /* Set nNewSize to the size allocated for the structure pointed to
14176ab3a2ecSdanielk1977     ** by pNew. This is either EXPR_FULLSIZE, EXPR_REDUCEDSIZE or
14186ab3a2ecSdanielk1977     ** EXPR_TOKENONLYSIZE. nToken is set to the number of bytes consumed
141933e619fcSdrh     ** by the copy of the p->u.zToken string (if any).
14206ab3a2ecSdanielk1977     */
14213c19469cSdrh     const unsigned nStructSize = dupedExprStructSize(p, dupFlags);
142233e619fcSdrh     const int nNewSize = nStructSize & 0xfff;
142333e619fcSdrh     int nToken;
142433e619fcSdrh     if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
142533e619fcSdrh       nToken = sqlite3Strlen30(p->u.zToken) + 1;
142633e619fcSdrh     }else{
142733e619fcSdrh       nToken = 0;
142833e619fcSdrh     }
14293c19469cSdrh     if( dupFlags ){
14306ab3a2ecSdanielk1977       assert( ExprHasProperty(p, EP_Reduced)==0 );
14316ab3a2ecSdanielk1977       memcpy(zAlloc, p, nNewSize);
14326ab3a2ecSdanielk1977     }else{
14333e6a1411Sdan       u32 nSize = (u32)exprStructSize(p);
14346ab3a2ecSdanielk1977       memcpy(zAlloc, p, nSize);
143572ea29d7Sdrh       if( nSize<EXPR_FULLSIZE ){
14366ab3a2ecSdanielk1977         memset(&zAlloc[nSize], 0, EXPR_FULLSIZE-nSize);
14376ab3a2ecSdanielk1977       }
143872ea29d7Sdrh     }
14396ab3a2ecSdanielk1977 
144033e619fcSdrh     /* Set the EP_Reduced, EP_TokenOnly, and EP_Static flags appropriately. */
1441c5cd1249Sdrh     pNew->flags &= ~(EP_Reduced|EP_TokenOnly|EP_Static|EP_MemToken);
144233e619fcSdrh     pNew->flags |= nStructSize & (EP_Reduced|EP_TokenOnly);
144333e619fcSdrh     pNew->flags |= staticFlag;
1444e7375bfaSdrh     ExprClearVVAProperties(pNew);
1445e7375bfaSdrh     if( dupFlags ){
1446e7375bfaSdrh       ExprSetVVAProperty(pNew, EP_Immutable);
1447e7375bfaSdrh     }
14486ab3a2ecSdanielk1977 
144933e619fcSdrh     /* Copy the p->u.zToken string, if any. */
14506ab3a2ecSdanielk1977     if( nToken ){
145133e619fcSdrh       char *zToken = pNew->u.zToken = (char*)&zAlloc[nNewSize];
145233e619fcSdrh       memcpy(zToken, p->u.zToken, nToken);
14536ab3a2ecSdanielk1977     }
14546ab3a2ecSdanielk1977 
1455209bc522Sdrh     if( 0==((p->flags|pNew->flags) & (EP_TokenOnly|EP_Leaf)) ){
14566ab3a2ecSdanielk1977       /* Fill in the pNew->x.pSelect or pNew->x.pList member. */
1457a4eeccdfSdrh       if( ExprUseXSelect(p) ){
14583c19469cSdrh         pNew->x.pSelect = sqlite3SelectDup(db, p->x.pSelect, dupFlags);
14596ab3a2ecSdanielk1977       }else{
14603c19469cSdrh         pNew->x.pList = sqlite3ExprListDup(db, p->x.pList, dupFlags);
14616ab3a2ecSdanielk1977       }
14626ab3a2ecSdanielk1977     }
14636ab3a2ecSdanielk1977 
14646ab3a2ecSdanielk1977     /* Fill in pNew->pLeft and pNew->pRight. */
14654f9adee2Sdan     if( ExprHasProperty(pNew, EP_Reduced|EP_TokenOnly|EP_WinFunc) ){
14663c19469cSdrh       zAlloc += dupedExprNodeSize(p, dupFlags);
1467209bc522Sdrh       if( !ExprHasProperty(pNew, EP_TokenOnly|EP_Leaf) ){
14683c19469cSdrh         pNew->pLeft = p->pLeft ?
14693c19469cSdrh                       exprDup(db, p->pLeft, EXPRDUP_REDUCE, &zAlloc) : 0;
14703c19469cSdrh         pNew->pRight = p->pRight ?
14713c19469cSdrh                        exprDup(db, p->pRight, EXPRDUP_REDUCE, &zAlloc) : 0;
14726ab3a2ecSdanielk1977       }
147367a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
1474eda079cdSdrh       if( ExprHasProperty(p, EP_WinFunc) ){
1475eda079cdSdrh         pNew->y.pWin = sqlite3WindowDup(db, pNew, p->y.pWin);
1476eda079cdSdrh         assert( ExprHasProperty(pNew, EP_WinFunc) );
1477e2f781b9Sdan       }
147867a9b8edSdan #endif /* SQLITE_OMIT_WINDOWFUNC */
147953988068Sdrh       if( pzBuffer ){
148053988068Sdrh         *pzBuffer = zAlloc;
148153988068Sdrh       }
148253988068Sdrh     }else{
1483209bc522Sdrh       if( !ExprHasProperty(p, EP_TokenOnly|EP_Leaf) ){
14849854260bSdrh         if( pNew->op==TK_SELECT_COLUMN ){
14859854260bSdrh           pNew->pLeft = p->pLeft;
14865cc9daf8Sdrh           assert( p->pRight==0  || p->pRight==p->pLeft
14875cc9daf8Sdrh                                 || ExprHasProperty(p->pLeft, EP_Subquery) );
14889854260bSdrh         }else{
14896ab3a2ecSdanielk1977           pNew->pLeft = sqlite3ExprDup(db, p->pLeft, 0);
14909854260bSdrh         }
14916ab3a2ecSdanielk1977         pNew->pRight = sqlite3ExprDup(db, p->pRight, 0);
14926ab3a2ecSdanielk1977       }
14936ab3a2ecSdanielk1977     }
14946ab3a2ecSdanielk1977   }
14956ab3a2ecSdanielk1977   return pNew;
14966ab3a2ecSdanielk1977 }
14976ab3a2ecSdanielk1977 
14986ab3a2ecSdanielk1977 /*
1499bfe31e7fSdan ** Create and return a deep copy of the object passed as the second
1500bfe31e7fSdan ** argument. If an OOM condition is encountered, NULL is returned
1501bfe31e7fSdan ** and the db->mallocFailed flag set.
1502bfe31e7fSdan */
1503eede6a53Sdan #ifndef SQLITE_OMIT_CTE
150426d61e5aSdan With *sqlite3WithDup(sqlite3 *db, With *p){
15054e9119d9Sdan   With *pRet = 0;
15064e9119d9Sdan   if( p ){
1507d4de9f7bSdrh     sqlite3_int64 nByte = sizeof(*p) + sizeof(p->a[0]) * (p->nCte-1);
15084e9119d9Sdan     pRet = sqlite3DbMallocZero(db, nByte);
15094e9119d9Sdan     if( pRet ){
15104e9119d9Sdan       int i;
15114e9119d9Sdan       pRet->nCte = p->nCte;
15124e9119d9Sdan       for(i=0; i<p->nCte; i++){
15134e9119d9Sdan         pRet->a[i].pSelect = sqlite3SelectDup(db, p->a[i].pSelect, 0);
15144e9119d9Sdan         pRet->a[i].pCols = sqlite3ExprListDup(db, p->a[i].pCols, 0);
15154e9119d9Sdan         pRet->a[i].zName = sqlite3DbStrDup(db, p->a[i].zName);
15164e9119d9Sdan       }
15174e9119d9Sdan     }
15184e9119d9Sdan   }
15194e9119d9Sdan   return pRet;
15204e9119d9Sdan }
1521eede6a53Sdan #else
152226d61e5aSdan # define sqlite3WithDup(x,y) 0
1523eede6a53Sdan #endif
15244e9119d9Sdan 
1525a8389975Sdrh #ifndef SQLITE_OMIT_WINDOWFUNC
1526a8389975Sdrh /*
1527a8389975Sdrh ** The gatherSelectWindows() procedure and its helper routine
1528a8389975Sdrh ** gatherSelectWindowsCallback() are used to scan all the expressions
1529a8389975Sdrh ** an a newly duplicated SELECT statement and gather all of the Window
1530a8389975Sdrh ** objects found there, assembling them onto the linked list at Select->pWin.
1531a8389975Sdrh */
1532a8389975Sdrh static int gatherSelectWindowsCallback(Walker *pWalker, Expr *pExpr){
15336ba7ab0dSdan   if( pExpr->op==TK_FUNCTION && ExprHasProperty(pExpr, EP_WinFunc) ){
153475b0821eSdan     Select *pSelect = pWalker->u.pSelect;
153575b0821eSdan     Window *pWin = pExpr->y.pWin;
153675b0821eSdan     assert( pWin );
15374f9adee2Sdan     assert( IsWindowFunc(pExpr) );
1538e0ae3f69Sdan     assert( pWin->ppThis==0 );
1539a3fcc000Sdan     sqlite3WindowLink(pSelect, pWin);
1540a8389975Sdrh   }
1541a8389975Sdrh   return WRC_Continue;
1542a8389975Sdrh }
1543a37b6a5eSdrh static int gatherSelectWindowsSelectCallback(Walker *pWalker, Select *p){
1544a37b6a5eSdrh   return p==pWalker->u.pSelect ? WRC_Continue : WRC_Prune;
1545a37b6a5eSdrh }
1546a8389975Sdrh static void gatherSelectWindows(Select *p){
1547a8389975Sdrh   Walker w;
1548a8389975Sdrh   w.xExprCallback = gatherSelectWindowsCallback;
1549a37b6a5eSdrh   w.xSelectCallback = gatherSelectWindowsSelectCallback;
1550a37b6a5eSdrh   w.xSelectCallback2 = 0;
15519c46c66cSdrh   w.pParse = 0;
1552a8389975Sdrh   w.u.pSelect = p;
1553a37b6a5eSdrh   sqlite3WalkSelect(&w, p);
1554a8389975Sdrh }
1555a8389975Sdrh #endif
1556a8389975Sdrh 
1557a8389975Sdrh 
1558a76b5dfcSdrh /*
1559ff78bd2fSdrh ** The following group of routines make deep copies of expressions,
1560ff78bd2fSdrh ** expression lists, ID lists, and select statements.  The copies can
1561ff78bd2fSdrh ** be deleted (by being passed to their respective ...Delete() routines)
1562ff78bd2fSdrh ** without effecting the originals.
1563ff78bd2fSdrh **
15644adee20fSdanielk1977 ** The expression list, ID, and source lists return by sqlite3ExprListDup(),
15654adee20fSdanielk1977 ** sqlite3IdListDup(), and sqlite3SrcListDup() can not be further expanded
1566ad3cab52Sdrh ** by subsequent calls to sqlite*ListAppend() routines.
1567ff78bd2fSdrh **
1568ad3cab52Sdrh ** Any tables that the SrcList might point to are not duplicated.
15696ab3a2ecSdanielk1977 **
1570b7916a78Sdrh ** The flags parameter contains a combination of the EXPRDUP_XXX flags.
15716ab3a2ecSdanielk1977 ** If the EXPRDUP_REDUCE flag is set, then the structure returned is a
15726ab3a2ecSdanielk1977 ** truncated version of the usual Expr structure that will be stored as
15736ab3a2ecSdanielk1977 ** part of the in-memory representation of the database schema.
1574ff78bd2fSdrh */
1575b6dad520Sdrh Expr *sqlite3ExprDup(sqlite3 *db, const Expr *p, int flags){
157672ea29d7Sdrh   assert( flags==0 || flags==EXPRDUP_REDUCE );
15773c19469cSdrh   return p ? exprDup(db, p, flags, 0) : 0;
1578ff78bd2fSdrh }
1579b6dad520Sdrh ExprList *sqlite3ExprListDup(sqlite3 *db, const ExprList *p, int flags){
1580ff78bd2fSdrh   ExprList *pNew;
1581b6dad520Sdrh   struct ExprList_item *pItem;
1582b6dad520Sdrh   const struct ExprList_item *pOldItem;
1583ff78bd2fSdrh   int i;
1584e46292a9Sdrh   Expr *pPriorSelectColOld = 0;
1585e46292a9Sdrh   Expr *pPriorSelectColNew = 0;
1586575fad65Sdrh   assert( db!=0 );
1587ff78bd2fSdrh   if( p==0 ) return 0;
158897258194Sdrh   pNew = sqlite3DbMallocRawNN(db, sqlite3DbMallocSize(db, p));
1589ff78bd2fSdrh   if( pNew==0 ) return 0;
1590a19543feSdrh   pNew->nExpr = p->nExpr;
159150e43c50Sdrh   pNew->nAlloc = p->nAlloc;
159243606175Sdrh   pItem = pNew->a;
1593145716b3Sdrh   pOldItem = p->a;
1594145716b3Sdrh   for(i=0; i<p->nExpr; i++, pItem++, pOldItem++){
15956ab3a2ecSdanielk1977     Expr *pOldExpr = pOldItem->pExpr;
159647073f62Sdrh     Expr *pNewExpr;
1597b5526ea6Sdrh     pItem->pExpr = sqlite3ExprDup(db, pOldExpr, flags);
159847073f62Sdrh     if( pOldExpr
159947073f62Sdrh      && pOldExpr->op==TK_SELECT_COLUMN
160047073f62Sdrh      && (pNewExpr = pItem->pExpr)!=0
160147073f62Sdrh     ){
1602e46292a9Sdrh       if( pNewExpr->pRight ){
1603e46292a9Sdrh         pPriorSelectColOld = pOldExpr->pRight;
1604e46292a9Sdrh         pPriorSelectColNew = pNewExpr->pRight;
1605e46292a9Sdrh         pNewExpr->pLeft = pNewExpr->pRight;
1606b163748eSdrh       }else{
1607e46292a9Sdrh         if( pOldExpr->pLeft!=pPriorSelectColOld ){
1608e46292a9Sdrh           pPriorSelectColOld = pOldExpr->pLeft;
1609e46292a9Sdrh           pPriorSelectColNew = sqlite3ExprDup(db, pPriorSelectColOld, flags);
1610e46292a9Sdrh           pNewExpr->pRight = pPriorSelectColNew;
1611e46292a9Sdrh         }
1612e46292a9Sdrh         pNewExpr->pLeft = pPriorSelectColNew;
161347073f62Sdrh       }
161447073f62Sdrh     }
161541cee668Sdrh     pItem->zEName = sqlite3DbStrDup(db, pOldItem->zEName);
16166e11892dSdan     pItem->sortFlags = pOldItem->sortFlags;
1617cbb9da33Sdrh     pItem->eEName = pOldItem->eEName;
16183e7bc9caSdrh     pItem->done = 0;
1619ae8e45cbSdan     pItem->bNulls = pOldItem->bNulls;
162024e25d32Sdan     pItem->bSorterRef = pOldItem->bSorterRef;
1621c2acc4e4Sdrh     pItem->u = pOldItem->u;
1622ff78bd2fSdrh   }
1623ff78bd2fSdrh   return pNew;
1624ff78bd2fSdrh }
162593758c8dSdanielk1977 
162693758c8dSdanielk1977 /*
162793758c8dSdanielk1977 ** If cursors, triggers, views and subqueries are all omitted from
162893758c8dSdanielk1977 ** the build, then none of the following routines, except for
162993758c8dSdanielk1977 ** sqlite3SelectDup(), can be called. sqlite3SelectDup() is sometimes
163093758c8dSdanielk1977 ** called with a NULL argument.
163193758c8dSdanielk1977 */
16326a67fe8eSdanielk1977 #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_TRIGGER) \
16336a67fe8eSdanielk1977  || !defined(SQLITE_OMIT_SUBQUERY)
1634b6dad520Sdrh SrcList *sqlite3SrcListDup(sqlite3 *db, const SrcList *p, int flags){
1635ad3cab52Sdrh   SrcList *pNew;
1636ad3cab52Sdrh   int i;
1637113088ecSdrh   int nByte;
1638575fad65Sdrh   assert( db!=0 );
1639ad3cab52Sdrh   if( p==0 ) return 0;
1640113088ecSdrh   nByte = sizeof(*p) + (p->nSrc>0 ? sizeof(p->a[0]) * (p->nSrc-1) : 0);
1641575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, nByte );
1642ad3cab52Sdrh   if( pNew==0 ) return 0;
16434305d103Sdrh   pNew->nSrc = pNew->nAlloc = p->nSrc;
1644ad3cab52Sdrh   for(i=0; i<p->nSrc; i++){
16457601294aSdrh     SrcItem *pNewItem = &pNew->a[i];
1646b6dad520Sdrh     const SrcItem *pOldItem = &p->a[i];
1647ed8a3bb1Sdrh     Table *pTab;
164841fb5cd1Sdan     pNewItem->pSchema = pOldItem->pSchema;
164917435752Sdrh     pNewItem->zDatabase = sqlite3DbStrDup(db, pOldItem->zDatabase);
165017435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
165117435752Sdrh     pNewItem->zAlias = sqlite3DbStrDup(db, pOldItem->zAlias);
16528a48b9c0Sdrh     pNewItem->fg = pOldItem->fg;
16534efc4754Sdrh     pNewItem->iCursor = pOldItem->iCursor;
16545b6a9ed4Sdrh     pNewItem->addrFillSub = pOldItem->addrFillSub;
16555b6a9ed4Sdrh     pNewItem->regReturn = pOldItem->regReturn;
16568a48b9c0Sdrh     if( pNewItem->fg.isIndexedBy ){
16578a48b9c0Sdrh       pNewItem->u1.zIndexedBy = sqlite3DbStrDup(db, pOldItem->u1.zIndexedBy);
16588a48b9c0Sdrh     }
1659a79e2a2dSdrh     pNewItem->u2 = pOldItem->u2;
1660a79e2a2dSdrh     if( pNewItem->fg.isCte ){
1661a79e2a2dSdrh       pNewItem->u2.pCteUse->nUse++;
1662a79e2a2dSdrh     }
16638a48b9c0Sdrh     if( pNewItem->fg.isTabFunc ){
16648a48b9c0Sdrh       pNewItem->u1.pFuncArg =
16658a48b9c0Sdrh           sqlite3ExprListDup(db, pOldItem->u1.pFuncArg, flags);
16668a48b9c0Sdrh     }
1667ed8a3bb1Sdrh     pTab = pNewItem->pTab = pOldItem->pTab;
1668ed8a3bb1Sdrh     if( pTab ){
166979df7782Sdrh       pTab->nTabRef++;
1670a1cb183dSdanielk1977     }
16716ab3a2ecSdanielk1977     pNewItem->pSelect = sqlite3SelectDup(db, pOldItem->pSelect, flags);
16726ab3a2ecSdanielk1977     pNewItem->pOn = sqlite3ExprDup(db, pOldItem->pOn, flags);
167317435752Sdrh     pNewItem->pUsing = sqlite3IdListDup(db, pOldItem->pUsing);
16746c18b6e0Sdanielk1977     pNewItem->colUsed = pOldItem->colUsed;
1675ad3cab52Sdrh   }
1676ad3cab52Sdrh   return pNew;
1677ad3cab52Sdrh }
1678b6dad520Sdrh IdList *sqlite3IdListDup(sqlite3 *db, const IdList *p){
1679ff78bd2fSdrh   IdList *pNew;
1680ff78bd2fSdrh   int i;
1681575fad65Sdrh   assert( db!=0 );
1682ff78bd2fSdrh   if( p==0 ) return 0;
1683575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, sizeof(*pNew) );
1684ff78bd2fSdrh   if( pNew==0 ) return 0;
16856c535158Sdrh   pNew->nId = p->nId;
1686575fad65Sdrh   pNew->a = sqlite3DbMallocRawNN(db, p->nId*sizeof(p->a[0]) );
1687d5d56523Sdanielk1977   if( pNew->a==0 ){
1688dbd6a7dcSdrh     sqlite3DbFreeNN(db, pNew);
1689d5d56523Sdanielk1977     return 0;
1690d5d56523Sdanielk1977   }
16916c535158Sdrh   /* Note that because the size of the allocation for p->a[] is not
16926c535158Sdrh   ** necessarily a power of two, sqlite3IdListAppend() may not be called
16936c535158Sdrh   ** on the duplicate created by this function. */
1694ff78bd2fSdrh   for(i=0; i<p->nId; i++){
16954efc4754Sdrh     struct IdList_item *pNewItem = &pNew->a[i];
16964efc4754Sdrh     struct IdList_item *pOldItem = &p->a[i];
169717435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
16984efc4754Sdrh     pNewItem->idx = pOldItem->idx;
1699ff78bd2fSdrh   }
1700ff78bd2fSdrh   return pNew;
1701ff78bd2fSdrh }
1702b6dad520Sdrh Select *sqlite3SelectDup(sqlite3 *db, const Select *pDup, int flags){
1703a7466205Sdan   Select *pRet = 0;
1704a7466205Sdan   Select *pNext = 0;
1705a7466205Sdan   Select **pp = &pRet;
1706b6dad520Sdrh   const Select *p;
1707a7466205Sdan 
1708575fad65Sdrh   assert( db!=0 );
1709a7466205Sdan   for(p=pDup; p; p=p->pPrior){
1710a7466205Sdan     Select *pNew = sqlite3DbMallocRawNN(db, sizeof(*p) );
1711a7466205Sdan     if( pNew==0 ) break;
1712b7916a78Sdrh     pNew->pEList = sqlite3ExprListDup(db, p->pEList, flags);
17136ab3a2ecSdanielk1977     pNew->pSrc = sqlite3SrcListDup(db, p->pSrc, flags);
17146ab3a2ecSdanielk1977     pNew->pWhere = sqlite3ExprDup(db, p->pWhere, flags);
17156ab3a2ecSdanielk1977     pNew->pGroupBy = sqlite3ExprListDup(db, p->pGroupBy, flags);
17166ab3a2ecSdanielk1977     pNew->pHaving = sqlite3ExprDup(db, p->pHaving, flags);
17176ab3a2ecSdanielk1977     pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, flags);
1718ff78bd2fSdrh     pNew->op = p->op;
1719a7466205Sdan     pNew->pNext = pNext;
1720a7466205Sdan     pNew->pPrior = 0;
17216ab3a2ecSdanielk1977     pNew->pLimit = sqlite3ExprDup(db, p->pLimit, flags);
172292b01d53Sdrh     pNew->iLimit = 0;
172392b01d53Sdrh     pNew->iOffset = 0;
17247d10d5a6Sdrh     pNew->selFlags = p->selFlags & ~SF_UsesEphemeral;
1725b9bb7c18Sdrh     pNew->addrOpenEphm[0] = -1;
1726b9bb7c18Sdrh     pNew->addrOpenEphm[1] = -1;
1727ec2da854Sdrh     pNew->nSelectRow = p->nSelectRow;
172826d61e5aSdan     pNew->pWith = sqlite3WithDup(db, p->pWith);
172967a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
17302e362f97Sdan     pNew->pWin = 0;
1731c95f38d4Sdan     pNew->pWinDefn = sqlite3WindowListDup(db, p->pWinDefn);
17324780b9adSdan     if( p->pWin && db->mallocFailed==0 ) gatherSelectWindows(pNew);
173367a9b8edSdan #endif
1734fef37760Sdrh     pNew->selId = p->selId;
17359da977f1Sdrh     if( db->mallocFailed ){
17369da977f1Sdrh       /* Any prior OOM might have left the Select object incomplete.
17379da977f1Sdrh       ** Delete the whole thing rather than allow an incomplete Select
17389da977f1Sdrh       ** to be used by the code generator. */
17399da977f1Sdrh       pNew->pNext = 0;
17409da977f1Sdrh       sqlite3SelectDelete(db, pNew);
17419da977f1Sdrh       break;
17429da977f1Sdrh     }
1743a7466205Sdan     *pp = pNew;
1744a7466205Sdan     pp = &pNew->pPrior;
1745a7466205Sdan     pNext = pNew;
1746a7466205Sdan   }
1747a7466205Sdan 
1748a7466205Sdan   return pRet;
1749ff78bd2fSdrh }
175093758c8dSdanielk1977 #else
1751f76d2877Sdrh Select *sqlite3SelectDup(sqlite3 *db, const Select *p, int flags){
175293758c8dSdanielk1977   assert( p==0 );
175393758c8dSdanielk1977   return 0;
175493758c8dSdanielk1977 }
175593758c8dSdanielk1977 #endif
1756ff78bd2fSdrh 
1757ff78bd2fSdrh 
1758ff78bd2fSdrh /*
1759a76b5dfcSdrh ** Add a new element to the end of an expression list.  If pList is
1760a76b5dfcSdrh ** initially NULL, then create a new expression list.
1761b7916a78Sdrh **
1762a19543feSdrh ** The pList argument must be either NULL or a pointer to an ExprList
1763a19543feSdrh ** obtained from a prior call to sqlite3ExprListAppend().  This routine
1764a19543feSdrh ** may not be used with an ExprList obtained from sqlite3ExprListDup().
1765a19543feSdrh ** Reason:  This routine assumes that the number of slots in pList->a[]
1766a19543feSdrh ** is a power of two.  That is true for sqlite3ExprListAppend() returns
1767a19543feSdrh ** but is not necessarily true from the return value of sqlite3ExprListDup().
1768a19543feSdrh **
1769b7916a78Sdrh ** If a memory allocation error occurs, the entire list is freed and
1770b7916a78Sdrh ** NULL is returned.  If non-NULL is returned, then it is guaranteed
1771b7916a78Sdrh ** that the new entry was successfully appended.
1772a76b5dfcSdrh */
1773dabada60Slarrybr static const struct ExprList_item zeroItem = {0};
177450e43c50Sdrh SQLITE_NOINLINE ExprList *sqlite3ExprListAppendNew(
177550e43c50Sdrh   sqlite3 *db,            /* Database handle.  Used for memory allocation */
177650e43c50Sdrh   Expr *pExpr             /* Expression to be appended. Might be NULL */
177750e43c50Sdrh ){
177850e43c50Sdrh   struct ExprList_item *pItem;
177950e43c50Sdrh   ExprList *pList;
178050e43c50Sdrh 
178150e43c50Sdrh   pList = sqlite3DbMallocRawNN(db, sizeof(ExprList)+sizeof(pList->a[0])*4 );
178250e43c50Sdrh   if( pList==0 ){
178350e43c50Sdrh     sqlite3ExprDelete(db, pExpr);
178450e43c50Sdrh     return 0;
178550e43c50Sdrh   }
178650e43c50Sdrh   pList->nAlloc = 4;
178750e43c50Sdrh   pList->nExpr = 1;
178850e43c50Sdrh   pItem = &pList->a[0];
178950e43c50Sdrh   *pItem = zeroItem;
179050e43c50Sdrh   pItem->pExpr = pExpr;
179150e43c50Sdrh   return pList;
179250e43c50Sdrh }
179350e43c50Sdrh SQLITE_NOINLINE ExprList *sqlite3ExprListAppendGrow(
179450e43c50Sdrh   sqlite3 *db,            /* Database handle.  Used for memory allocation */
179550e43c50Sdrh   ExprList *pList,        /* List to which to append. Might be NULL */
179650e43c50Sdrh   Expr *pExpr             /* Expression to be appended. Might be NULL */
179750e43c50Sdrh ){
179850e43c50Sdrh   struct ExprList_item *pItem;
179950e43c50Sdrh   ExprList *pNew;
180050e43c50Sdrh   pList->nAlloc *= 2;
180150e43c50Sdrh   pNew = sqlite3DbRealloc(db, pList,
180250e43c50Sdrh        sizeof(*pList)+(pList->nAlloc-1)*sizeof(pList->a[0]));
180350e43c50Sdrh   if( pNew==0 ){
180450e43c50Sdrh     sqlite3ExprListDelete(db, pList);
180550e43c50Sdrh     sqlite3ExprDelete(db, pExpr);
180650e43c50Sdrh     return 0;
180750e43c50Sdrh   }else{
180850e43c50Sdrh     pList = pNew;
180950e43c50Sdrh   }
181050e43c50Sdrh   pItem = &pList->a[pList->nExpr++];
181150e43c50Sdrh   *pItem = zeroItem;
181250e43c50Sdrh   pItem->pExpr = pExpr;
181350e43c50Sdrh   return pList;
181450e43c50Sdrh }
181517435752Sdrh ExprList *sqlite3ExprListAppend(
181617435752Sdrh   Parse *pParse,          /* Parsing context */
181717435752Sdrh   ExprList *pList,        /* List to which to append. Might be NULL */
1818b7916a78Sdrh   Expr *pExpr             /* Expression to be appended. Might be NULL */
181917435752Sdrh ){
182043606175Sdrh   struct ExprList_item *pItem;
1821a76b5dfcSdrh   if( pList==0 ){
182250e43c50Sdrh     return sqlite3ExprListAppendNew(pParse->db,pExpr);
1823a76b5dfcSdrh   }
182450e43c50Sdrh   if( pList->nAlloc<pList->nExpr+1 ){
182550e43c50Sdrh     return sqlite3ExprListAppendGrow(pParse->db,pList,pExpr);
1826a76b5dfcSdrh   }
182743606175Sdrh   pItem = &pList->a[pList->nExpr++];
182850e43c50Sdrh   *pItem = zeroItem;
1829e94ddc9eSdanielk1977   pItem->pExpr = pExpr;
1830a76b5dfcSdrh   return pList;
1831a76b5dfcSdrh }
1832a76b5dfcSdrh 
1833a76b5dfcSdrh /*
18348762ec19Sdrh ** pColumns and pExpr form a vector assignment which is part of the SET
18358762ec19Sdrh ** clause of an UPDATE statement.  Like this:
1836a1251bc4Sdrh **
1837a1251bc4Sdrh **        (a,b,c) = (expr1,expr2,expr3)
1838a1251bc4Sdrh ** Or:    (a,b,c) = (SELECT x,y,z FROM ....)
1839a1251bc4Sdrh **
1840a1251bc4Sdrh ** For each term of the vector assignment, append new entries to the
1841b67343d0Sdrh ** expression list pList.  In the case of a subquery on the RHS, append
1842a1251bc4Sdrh ** TK_SELECT_COLUMN expressions.
1843a1251bc4Sdrh */
1844a1251bc4Sdrh ExprList *sqlite3ExprListAppendVector(
1845a1251bc4Sdrh   Parse *pParse,         /* Parsing context */
1846a1251bc4Sdrh   ExprList *pList,       /* List to which to append. Might be NULL */
1847a1251bc4Sdrh   IdList *pColumns,      /* List of names of LHS of the assignment */
1848a1251bc4Sdrh   Expr *pExpr            /* Vector expression to be appended. Might be NULL */
1849a1251bc4Sdrh ){
1850a1251bc4Sdrh   sqlite3 *db = pParse->db;
1851a1251bc4Sdrh   int n;
1852a1251bc4Sdrh   int i;
185366860af3Sdrh   int iFirst = pList ? pList->nExpr : 0;
1854321e828dSdrh   /* pColumns can only be NULL due to an OOM but an OOM will cause an
1855321e828dSdrh   ** exit prior to this routine being invoked */
1856321e828dSdrh   if( NEVER(pColumns==0) ) goto vector_append_error;
1857a1251bc4Sdrh   if( pExpr==0 ) goto vector_append_error;
1858966e2911Sdrh 
1859966e2911Sdrh   /* If the RHS is a vector, then we can immediately check to see that
1860966e2911Sdrh   ** the size of the RHS and LHS match.  But if the RHS is a SELECT,
1861966e2911Sdrh   ** wildcards ("*") in the result set of the SELECT must be expanded before
1862966e2911Sdrh   ** we can do the size check, so defer the size check until code generation.
1863966e2911Sdrh   */
1864966e2911Sdrh   if( pExpr->op!=TK_SELECT && pColumns->nId!=(n=sqlite3ExprVectorSize(pExpr)) ){
1865a1251bc4Sdrh     sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
1866a1251bc4Sdrh                     pColumns->nId, n);
1867a1251bc4Sdrh     goto vector_append_error;
1868a1251bc4Sdrh   }
1869966e2911Sdrh 
1870966e2911Sdrh   for(i=0; i<pColumns->nId; i++){
187110f08270Sdrh     Expr *pSubExpr = sqlite3ExprForVectorField(pParse, pExpr, i, pColumns->nId);
1872554a9dc7Sdrh     assert( pSubExpr!=0 || db->mallocFailed );
1873554a9dc7Sdrh     if( pSubExpr==0 ) continue;
1874a1251bc4Sdrh     pList = sqlite3ExprListAppend(pParse, pList, pSubExpr);
1875a1251bc4Sdrh     if( pList ){
187666860af3Sdrh       assert( pList->nExpr==iFirst+i+1 );
187741cee668Sdrh       pList->a[pList->nExpr-1].zEName = pColumns->a[i].zName;
1878a1251bc4Sdrh       pColumns->a[i].zName = 0;
1879a1251bc4Sdrh     }
1880a1251bc4Sdrh   }
1881966e2911Sdrh 
1882ffe28059Sdrh   if( !db->mallocFailed && pExpr->op==TK_SELECT && ALWAYS(pList!=0) ){
1883966e2911Sdrh     Expr *pFirst = pList->a[iFirst].pExpr;
1884f4dd26c5Sdrh     assert( pFirst!=0 );
1885966e2911Sdrh     assert( pFirst->op==TK_SELECT_COLUMN );
1886966e2911Sdrh 
1887966e2911Sdrh     /* Store the SELECT statement in pRight so it will be deleted when
1888966e2911Sdrh     ** sqlite3ExprListDelete() is called */
1889966e2911Sdrh     pFirst->pRight = pExpr;
1890a1251bc4Sdrh     pExpr = 0;
1891966e2911Sdrh 
1892966e2911Sdrh     /* Remember the size of the LHS in iTable so that we can check that
1893966e2911Sdrh     ** the RHS and LHS sizes match during code generation. */
1894966e2911Sdrh     pFirst->iTable = pColumns->nId;
1895a1251bc4Sdrh   }
1896a1251bc4Sdrh 
1897a1251bc4Sdrh vector_append_error:
18988e34e406Sdrh   sqlite3ExprUnmapAndDelete(pParse, pExpr);
1899a1251bc4Sdrh   sqlite3IdListDelete(db, pColumns);
1900a1251bc4Sdrh   return pList;
1901a1251bc4Sdrh }
1902a1251bc4Sdrh 
1903a1251bc4Sdrh /*
1904bc622bc0Sdrh ** Set the sort order for the last element on the given ExprList.
1905bc622bc0Sdrh */
19066e11892dSdan void sqlite3ExprListSetSortOrder(ExprList *p, int iSortOrder, int eNulls){
19079105fd51Sdan   struct ExprList_item *pItem;
1908bc622bc0Sdrh   if( p==0 ) return;
1909bc622bc0Sdrh   assert( p->nExpr>0 );
19106e11892dSdan 
19116e11892dSdan   assert( SQLITE_SO_UNDEFINED<0 && SQLITE_SO_ASC==0 && SQLITE_SO_DESC>0 );
19126e11892dSdan   assert( iSortOrder==SQLITE_SO_UNDEFINED
19136e11892dSdan        || iSortOrder==SQLITE_SO_ASC
19146e11892dSdan        || iSortOrder==SQLITE_SO_DESC
19156e11892dSdan   );
19166e11892dSdan   assert( eNulls==SQLITE_SO_UNDEFINED
19176e11892dSdan        || eNulls==SQLITE_SO_ASC
19186e11892dSdan        || eNulls==SQLITE_SO_DESC
19196e11892dSdan   );
19206e11892dSdan 
19219105fd51Sdan   pItem = &p->a[p->nExpr-1];
19229105fd51Sdan   assert( pItem->bNulls==0 );
19239105fd51Sdan   if( iSortOrder==SQLITE_SO_UNDEFINED ){
19249105fd51Sdan     iSortOrder = SQLITE_SO_ASC;
1925bc622bc0Sdrh   }
19269105fd51Sdan   pItem->sortFlags = (u8)iSortOrder;
19279105fd51Sdan 
19289105fd51Sdan   if( eNulls!=SQLITE_SO_UNDEFINED ){
19299105fd51Sdan     pItem->bNulls = 1;
19309105fd51Sdan     if( iSortOrder!=eNulls ){
19319105fd51Sdan       pItem->sortFlags |= KEYINFO_ORDER_BIGNULL;
19329105fd51Sdan     }
1933bc622bc0Sdrh   }
1934bc622bc0Sdrh }
1935bc622bc0Sdrh 
1936bc622bc0Sdrh /*
193741cee668Sdrh ** Set the ExprList.a[].zEName element of the most recently added item
1938b7916a78Sdrh ** on the expression list.
1939b7916a78Sdrh **
1940b7916a78Sdrh ** pList might be NULL following an OOM error.  But pName should never be
1941b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1942b7916a78Sdrh ** is set.
1943b7916a78Sdrh */
1944b7916a78Sdrh void sqlite3ExprListSetName(
1945b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1946b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
1947b6dad520Sdrh   const Token *pName,     /* Name to be added */
1948b7916a78Sdrh   int dequote             /* True to cause the name to be dequoted */
1949b7916a78Sdrh ){
1950b7916a78Sdrh   assert( pList!=0 || pParse->db->mallocFailed!=0 );
19512d99f957Sdrh   assert( pParse->eParseMode!=PARSE_MODE_UNMAP || dequote==0 );
1952b7916a78Sdrh   if( pList ){
1953b7916a78Sdrh     struct ExprList_item *pItem;
1954b7916a78Sdrh     assert( pList->nExpr>0 );
1955b7916a78Sdrh     pItem = &pList->a[pList->nExpr-1];
195641cee668Sdrh     assert( pItem->zEName==0 );
1957c4938ea2Sdrh     assert( pItem->eEName==ENAME_NAME );
195841cee668Sdrh     pItem->zEName = sqlite3DbStrNDup(pParse->db, pName->z, pName->n);
195985f2c76cSdan     if( dequote ){
196085f2c76cSdan       /* If dequote==0, then pName->z does not point to part of a DDL
196185f2c76cSdan       ** statement handled by the parser. And so no token need be added
196285f2c76cSdan       ** to the token-map.  */
196385f2c76cSdan       sqlite3Dequote(pItem->zEName);
1964c9461eccSdan       if( IN_RENAME_OBJECT ){
1965b6dad520Sdrh         sqlite3RenameTokenMap(pParse, (const void*)pItem->zEName, pName);
19665be60c55Sdan       }
1967b7916a78Sdrh     }
1968b7916a78Sdrh   }
196985f2c76cSdan }
1970b7916a78Sdrh 
1971b7916a78Sdrh /*
1972b7916a78Sdrh ** Set the ExprList.a[].zSpan element of the most recently added item
1973b7916a78Sdrh ** on the expression list.
1974b7916a78Sdrh **
1975b7916a78Sdrh ** pList might be NULL following an OOM error.  But pSpan should never be
1976b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1977b7916a78Sdrh ** is set.
1978b7916a78Sdrh */
1979b7916a78Sdrh void sqlite3ExprListSetSpan(
1980b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1981b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
19821be266baSdrh   const char *zStart,     /* Start of the span */
19831be266baSdrh   const char *zEnd        /* End of the span */
1984b7916a78Sdrh ){
1985b7916a78Sdrh   sqlite3 *db = pParse->db;
1986b7916a78Sdrh   assert( pList!=0 || db->mallocFailed!=0 );
1987b7916a78Sdrh   if( pList ){
1988b7916a78Sdrh     struct ExprList_item *pItem = &pList->a[pList->nExpr-1];
1989b7916a78Sdrh     assert( pList->nExpr>0 );
1990cbb9da33Sdrh     if( pItem->zEName==0 ){
1991cbb9da33Sdrh       pItem->zEName = sqlite3DbSpanDup(db, zStart, zEnd);
1992cbb9da33Sdrh       pItem->eEName = ENAME_SPAN;
1993cbb9da33Sdrh     }
1994b7916a78Sdrh   }
1995b7916a78Sdrh }
1996b7916a78Sdrh 
1997b7916a78Sdrh /*
19987a15a4beSdanielk1977 ** If the expression list pEList contains more than iLimit elements,
19997a15a4beSdanielk1977 ** leave an error message in pParse.
20007a15a4beSdanielk1977 */
20017a15a4beSdanielk1977 void sqlite3ExprListCheckLength(
20027a15a4beSdanielk1977   Parse *pParse,
20037a15a4beSdanielk1977   ExprList *pEList,
20047a15a4beSdanielk1977   const char *zObject
20057a15a4beSdanielk1977 ){
2006b1a6c3c1Sdrh   int mx = pParse->db->aLimit[SQLITE_LIMIT_COLUMN];
2007c5499befSdrh   testcase( pEList && pEList->nExpr==mx );
2008c5499befSdrh   testcase( pEList && pEList->nExpr==mx+1 );
2009b1a6c3c1Sdrh   if( pEList && pEList->nExpr>mx ){
20107a15a4beSdanielk1977     sqlite3ErrorMsg(pParse, "too many columns in %s", zObject);
20117a15a4beSdanielk1977   }
20127a15a4beSdanielk1977 }
20137a15a4beSdanielk1977 
20147a15a4beSdanielk1977 /*
2015a76b5dfcSdrh ** Delete an entire expression list.
2016a76b5dfcSdrh */
2017affa855cSdrh static SQLITE_NOINLINE void exprListDeleteNN(sqlite3 *db, ExprList *pList){
2018ac48b751Sdrh   int i = pList->nExpr;
2019ac48b751Sdrh   struct ExprList_item *pItem =  pList->a;
2020ac48b751Sdrh   assert( pList->nExpr>0 );
2021ac48b751Sdrh   do{
2022633e6d57Sdrh     sqlite3ExprDelete(db, pItem->pExpr);
202341cee668Sdrh     sqlite3DbFree(db, pItem->zEName);
2024ac48b751Sdrh     pItem++;
2025ac48b751Sdrh   }while( --i>0 );
2026dbd6a7dcSdrh   sqlite3DbFreeNN(db, pList);
2027a76b5dfcSdrh }
2028affa855cSdrh void sqlite3ExprListDelete(sqlite3 *db, ExprList *pList){
2029affa855cSdrh   if( pList ) exprListDeleteNN(db, pList);
2030affa855cSdrh }
2031a76b5dfcSdrh 
2032a76b5dfcSdrh /*
20332308ed38Sdrh ** Return the bitwise-OR of all Expr.flags fields in the given
20342308ed38Sdrh ** ExprList.
2035885a5b03Sdrh */
20362308ed38Sdrh u32 sqlite3ExprListFlags(const ExprList *pList){
2037885a5b03Sdrh   int i;
20382308ed38Sdrh   u32 m = 0;
2039508e2d00Sdrh   assert( pList!=0 );
2040885a5b03Sdrh   for(i=0; i<pList->nExpr; i++){
2041d0c73053Sdrh      Expr *pExpr = pList->a[i].pExpr;
2042de845c2fSdrh      assert( pExpr!=0 );
2043de845c2fSdrh      m |= pExpr->flags;
2044885a5b03Sdrh   }
20452308ed38Sdrh   return m;
2046885a5b03Sdrh }
2047885a5b03Sdrh 
2048885a5b03Sdrh /*
20497e6f980bSdrh ** This is a SELECT-node callback for the expression walker that
20507e6f980bSdrh ** always "fails".  By "fail" in this case, we mean set
20517e6f980bSdrh ** pWalker->eCode to zero and abort.
20527e6f980bSdrh **
20537e6f980bSdrh ** This callback is used by multiple expression walkers.
20547e6f980bSdrh */
20557e6f980bSdrh int sqlite3SelectWalkFail(Walker *pWalker, Select *NotUsed){
20567e6f980bSdrh   UNUSED_PARAMETER(NotUsed);
20577e6f980bSdrh   pWalker->eCode = 0;
20587e6f980bSdrh   return WRC_Abort;
20597e6f980bSdrh }
20607e6f980bSdrh 
20617e6f980bSdrh /*
20620cbec59cSdrh ** Check the input string to see if it is "true" or "false" (in any case).
20630cbec59cSdrh **
20640cbec59cSdrh **       If the string is....           Return
20650cbec59cSdrh **         "true"                         EP_IsTrue
20660cbec59cSdrh **         "false"                        EP_IsFalse
20670cbec59cSdrh **         anything else                  0
20680cbec59cSdrh */
20690cbec59cSdrh u32 sqlite3IsTrueOrFalse(const char *zIn){
20700cbec59cSdrh   if( sqlite3StrICmp(zIn, "true")==0  ) return EP_IsTrue;
20710cbec59cSdrh   if( sqlite3StrICmp(zIn, "false")==0 ) return EP_IsFalse;
20720cbec59cSdrh   return 0;
20730cbec59cSdrh }
20740cbec59cSdrh 
20750cbec59cSdrh 
20760cbec59cSdrh /*
2077171d16bbSdrh ** If the input expression is an ID with the name "true" or "false"
207896acafbeSdrh ** then convert it into an TK_TRUEFALSE term.  Return non-zero if
207996acafbeSdrh ** the conversion happened, and zero if the expression is unaltered.
2080171d16bbSdrh */
2081171d16bbSdrh int sqlite3ExprIdToTrueFalse(Expr *pExpr){
20820cbec59cSdrh   u32 v;
2083171d16bbSdrh   assert( pExpr->op==TK_ID || pExpr->op==TK_STRING );
2084f9751074Sdrh   if( !ExprHasProperty(pExpr, EP_Quoted|EP_IntValue)
20850cbec59cSdrh    && (v = sqlite3IsTrueOrFalse(pExpr->u.zToken))!=0
2086171d16bbSdrh   ){
2087171d16bbSdrh     pExpr->op = TK_TRUEFALSE;
20880cbec59cSdrh     ExprSetProperty(pExpr, v);
2089171d16bbSdrh     return 1;
2090171d16bbSdrh   }
2091171d16bbSdrh   return 0;
2092171d16bbSdrh }
2093171d16bbSdrh 
209443c4ac8bSdrh /*
209596acafbeSdrh ** The argument must be a TK_TRUEFALSE Expr node.  Return 1 if it is TRUE
209643c4ac8bSdrh ** and 0 if it is FALSE.
209743c4ac8bSdrh */
209896acafbeSdrh int sqlite3ExprTruthValue(const Expr *pExpr){
20996ece353fSdan   pExpr = sqlite3ExprSkipCollate((Expr*)pExpr);
210043c4ac8bSdrh   assert( pExpr->op==TK_TRUEFALSE );
2101f9751074Sdrh   assert( !ExprHasProperty(pExpr, EP_IntValue) );
210243c4ac8bSdrh   assert( sqlite3StrICmp(pExpr->u.zToken,"true")==0
210343c4ac8bSdrh        || sqlite3StrICmp(pExpr->u.zToken,"false")==0 );
210443c4ac8bSdrh   return pExpr->u.zToken[4]==0;
210543c4ac8bSdrh }
210643c4ac8bSdrh 
210717180fcaSdrh /*
210817180fcaSdrh ** If pExpr is an AND or OR expression, try to simplify it by eliminating
210917180fcaSdrh ** terms that are always true or false.  Return the simplified expression.
211017180fcaSdrh ** Or return the original expression if no simplification is possible.
211117180fcaSdrh **
211217180fcaSdrh ** Examples:
211317180fcaSdrh **
211417180fcaSdrh **     (x<10) AND true                =>   (x<10)
211517180fcaSdrh **     (x<10) AND false               =>   false
211617180fcaSdrh **     (x<10) AND (y=22 OR false)     =>   (x<10) AND (y=22)
211717180fcaSdrh **     (x<10) AND (y=22 OR true)      =>   (x<10)
211817180fcaSdrh **     (y=22) OR true                 =>   true
211917180fcaSdrh */
212017180fcaSdrh Expr *sqlite3ExprSimplifiedAndOr(Expr *pExpr){
212117180fcaSdrh   assert( pExpr!=0 );
212217180fcaSdrh   if( pExpr->op==TK_AND || pExpr->op==TK_OR ){
212317180fcaSdrh     Expr *pRight = sqlite3ExprSimplifiedAndOr(pExpr->pRight);
212417180fcaSdrh     Expr *pLeft = sqlite3ExprSimplifiedAndOr(pExpr->pLeft);
212517180fcaSdrh     if( ExprAlwaysTrue(pLeft) || ExprAlwaysFalse(pRight) ){
212617180fcaSdrh       pExpr = pExpr->op==TK_AND ? pRight : pLeft;
212717180fcaSdrh     }else if( ExprAlwaysTrue(pRight) || ExprAlwaysFalse(pLeft) ){
212817180fcaSdrh       pExpr = pExpr->op==TK_AND ? pLeft : pRight;
212917180fcaSdrh     }
213017180fcaSdrh   }
213117180fcaSdrh   return pExpr;
213217180fcaSdrh }
213317180fcaSdrh 
2134171d16bbSdrh 
2135171d16bbSdrh /*
2136059b2d50Sdrh ** These routines are Walker callbacks used to check expressions to
2137059b2d50Sdrh ** see if they are "constant" for some definition of constant.  The
2138059b2d50Sdrh ** Walker.eCode value determines the type of "constant" we are looking
2139059b2d50Sdrh ** for.
214073b211abSdrh **
21417d10d5a6Sdrh ** These callback routines are used to implement the following:
2142626a879aSdrh **
2143059b2d50Sdrh **     sqlite3ExprIsConstant()                  pWalker->eCode==1
2144059b2d50Sdrh **     sqlite3ExprIsConstantNotJoin()           pWalker->eCode==2
2145fcb9f4f3Sdrh **     sqlite3ExprIsTableConstant()             pWalker->eCode==3
2146059b2d50Sdrh **     sqlite3ExprIsConstantOrFunction()        pWalker->eCode==4 or 5
214787abf5c0Sdrh **
2148059b2d50Sdrh ** In all cases, the callbacks set Walker.eCode=0 and abort if the expression
2149059b2d50Sdrh ** is found to not be a constant.
215087abf5c0Sdrh **
2151014fff20Sdrh ** The sqlite3ExprIsConstantOrFunction() is used for evaluating DEFAULT
2152014fff20Sdrh ** expressions in a CREATE TABLE statement.  The Walker.eCode value is 5
21531e32bed3Sdrh ** when parsing an existing schema out of the sqlite_schema table and 4
2154014fff20Sdrh ** when processing a new CREATE TABLE statement.  A bound parameter raises
2155014fff20Sdrh ** an error for new statements, but is silently converted
21561e32bed3Sdrh ** to NULL for existing schemas.  This allows sqlite_schema tables that
2157feada2dfSdrh ** contain a bound parameter because they were generated by older versions
2158feada2dfSdrh ** of SQLite to be parsed by newer versions of SQLite without raising a
2159feada2dfSdrh ** malformed schema error.
2160626a879aSdrh */
21617d10d5a6Sdrh static int exprNodeIsConstant(Walker *pWalker, Expr *pExpr){
2162626a879aSdrh 
2163059b2d50Sdrh   /* If pWalker->eCode is 2 then any term of the expression that comes from
2164059b2d50Sdrh   ** the ON or USING clauses of a left join disqualifies the expression
21650a168377Sdrh   ** from being considered constant. */
2166059b2d50Sdrh   if( pWalker->eCode==2 && ExprHasProperty(pExpr, EP_FromJoin) ){
2167059b2d50Sdrh     pWalker->eCode = 0;
21687d10d5a6Sdrh     return WRC_Abort;
21690a168377Sdrh   }
21700a168377Sdrh 
2171626a879aSdrh   switch( pExpr->op ){
2172eb55bd2fSdrh     /* Consider functions to be constant if all their arguments are constant
2173059b2d50Sdrh     ** and either pWalker->eCode==4 or 5 or the function has the
2174059b2d50Sdrh     ** SQLITE_FUNC_CONST flag. */
2175eb55bd2fSdrh     case TK_FUNCTION:
2176a634c9e6Sdrh       if( (pWalker->eCode>=4 || ExprHasProperty(pExpr,EP_ConstFunc))
2177a634c9e6Sdrh        && !ExprHasProperty(pExpr, EP_WinFunc)
2178a634c9e6Sdrh       ){
2179014fff20Sdrh         if( pWalker->eCode==5 ) ExprSetProperty(pExpr, EP_FromDDL);
2180b1fba286Sdrh         return WRC_Continue;
2181059b2d50Sdrh       }else{
2182059b2d50Sdrh         pWalker->eCode = 0;
2183059b2d50Sdrh         return WRC_Abort;
2184b1fba286Sdrh       }
2185626a879aSdrh     case TK_ID:
2186171d16bbSdrh       /* Convert "true" or "false" in a DEFAULT clause into the
2187171d16bbSdrh       ** appropriate TK_TRUEFALSE operator */
2188e39ef31cSdrh       if( sqlite3ExprIdToTrueFalse(pExpr) ){
2189171d16bbSdrh         return WRC_Prune;
2190171d16bbSdrh       }
219108b92086Sdrh       /* no break */ deliberate_fall_through
2192626a879aSdrh     case TK_COLUMN:
2193626a879aSdrh     case TK_AGG_FUNCTION:
219413449892Sdrh     case TK_AGG_COLUMN:
2195c5499befSdrh       testcase( pExpr->op==TK_ID );
2196c5499befSdrh       testcase( pExpr->op==TK_COLUMN );
2197c5499befSdrh       testcase( pExpr->op==TK_AGG_FUNCTION );
2198c5499befSdrh       testcase( pExpr->op==TK_AGG_COLUMN );
219907aded63Sdrh       if( ExprHasProperty(pExpr, EP_FixedCol) && pWalker->eCode!=2 ){
2200efad2e23Sdrh         return WRC_Continue;
2201efad2e23Sdrh       }
2202059b2d50Sdrh       if( pWalker->eCode==3 && pExpr->iTable==pWalker->u.iCur ){
2203059b2d50Sdrh         return WRC_Continue;
2204f43ce0b4Sdrh       }
220508b92086Sdrh       /* no break */ deliberate_fall_through
2206f43ce0b4Sdrh     case TK_IF_NULL_ROW:
22076e341b93Sdrh     case TK_REGISTER:
220874e0d966Sdrh     case TK_DOT:
22099916048bSdrh       testcase( pExpr->op==TK_REGISTER );
2210f43ce0b4Sdrh       testcase( pExpr->op==TK_IF_NULL_ROW );
221174e0d966Sdrh       testcase( pExpr->op==TK_DOT );
2212059b2d50Sdrh       pWalker->eCode = 0;
22137d10d5a6Sdrh       return WRC_Abort;
2214feada2dfSdrh     case TK_VARIABLE:
2215059b2d50Sdrh       if( pWalker->eCode==5 ){
2216feada2dfSdrh         /* Silently convert bound parameters that appear inside of CREATE
2217feada2dfSdrh         ** statements into a NULL when parsing the CREATE statement text out
22181e32bed3Sdrh         ** of the sqlite_schema table */
2219feada2dfSdrh         pExpr->op = TK_NULL;
2220059b2d50Sdrh       }else if( pWalker->eCode==4 ){
2221feada2dfSdrh         /* A bound parameter in a CREATE statement that originates from
2222feada2dfSdrh         ** sqlite3_prepare() causes an error */
2223059b2d50Sdrh         pWalker->eCode = 0;
2224feada2dfSdrh         return WRC_Abort;
2225feada2dfSdrh       }
222608b92086Sdrh       /* no break */ deliberate_fall_through
2227626a879aSdrh     default:
22286e341b93Sdrh       testcase( pExpr->op==TK_SELECT ); /* sqlite3SelectWalkFail() disallows */
22296e341b93Sdrh       testcase( pExpr->op==TK_EXISTS ); /* sqlite3SelectWalkFail() disallows */
22307d10d5a6Sdrh       return WRC_Continue;
2231626a879aSdrh   }
2232626a879aSdrh }
2233059b2d50Sdrh static int exprIsConst(Expr *p, int initFlag, int iCur){
22347d10d5a6Sdrh   Walker w;
2235059b2d50Sdrh   w.eCode = initFlag;
22367d10d5a6Sdrh   w.xExprCallback = exprNodeIsConstant;
22377e6f980bSdrh   w.xSelectCallback = sqlite3SelectWalkFail;
2238979dd1beSdrh #ifdef SQLITE_DEBUG
2239979dd1beSdrh   w.xSelectCallback2 = sqlite3SelectWalkAssert2;
2240979dd1beSdrh #endif
2241059b2d50Sdrh   w.u.iCur = iCur;
22427d10d5a6Sdrh   sqlite3WalkExpr(&w, p);
2243059b2d50Sdrh   return w.eCode;
22447d10d5a6Sdrh }
2245626a879aSdrh 
2246626a879aSdrh /*
2247059b2d50Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
2248eb55bd2fSdrh ** and 0 if it involves variables or function calls.
22492398937bSdrh **
22502398937bSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
22512398937bSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
22522398937bSdrh ** a constant.
2253fef5208cSdrh */
22544adee20fSdanielk1977 int sqlite3ExprIsConstant(Expr *p){
2255059b2d50Sdrh   return exprIsConst(p, 1, 0);
2256fef5208cSdrh }
2257fef5208cSdrh 
2258fef5208cSdrh /*
225907aded63Sdrh ** Walk an expression tree.  Return non-zero if
226007aded63Sdrh **
226107aded63Sdrh **   (1) the expression is constant, and
226207aded63Sdrh **   (2) the expression does originate in the ON or USING clause
226307aded63Sdrh **       of a LEFT JOIN, and
226407aded63Sdrh **   (3) the expression does not contain any EP_FixedCol TK_COLUMN
226507aded63Sdrh **       operands created by the constant propagation optimization.
226607aded63Sdrh **
226707aded63Sdrh ** When this routine returns true, it indicates that the expression
226807aded63Sdrh ** can be added to the pParse->pConstExpr list and evaluated once when
22699b258c54Sdrh ** the prepared statement starts up.  See sqlite3ExprCodeRunJustOnce().
22700a168377Sdrh */
22710a168377Sdrh int sqlite3ExprIsConstantNotJoin(Expr *p){
2272059b2d50Sdrh   return exprIsConst(p, 2, 0);
22730a168377Sdrh }
22740a168377Sdrh 
22750a168377Sdrh /*
2276fcb9f4f3Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
2277059b2d50Sdrh ** for any single row of the table with cursor iCur.  In other words, the
2278059b2d50Sdrh ** expression must not refer to any non-deterministic function nor any
2279059b2d50Sdrh ** table other than iCur.
2280059b2d50Sdrh */
2281059b2d50Sdrh int sqlite3ExprIsTableConstant(Expr *p, int iCur){
2282059b2d50Sdrh   return exprIsConst(p, 3, iCur);
2283059b2d50Sdrh }
2284059b2d50Sdrh 
2285ab31a845Sdan 
2286ab31a845Sdan /*
2287ab31a845Sdan ** sqlite3WalkExpr() callback used by sqlite3ExprIsConstantOrGroupBy().
2288ab31a845Sdan */
2289ab31a845Sdan static int exprNodeIsConstantOrGroupBy(Walker *pWalker, Expr *pExpr){
2290ab31a845Sdan   ExprList *pGroupBy = pWalker->u.pGroupBy;
2291ab31a845Sdan   int i;
2292ab31a845Sdan 
2293ab31a845Sdan   /* Check if pExpr is identical to any GROUP BY term. If so, consider
2294ab31a845Sdan   ** it constant.  */
2295ab31a845Sdan   for(i=0; i<pGroupBy->nExpr; i++){
2296ab31a845Sdan     Expr *p = pGroupBy->a[i].pExpr;
22975aa550cfSdan     if( sqlite3ExprCompare(0, pExpr, p, -1)<2 ){
229870efa84dSdrh       CollSeq *pColl = sqlite3ExprNNCollSeq(pWalker->pParse, p);
2299efad2e23Sdrh       if( sqlite3IsBinary(pColl) ){
2300ab31a845Sdan         return WRC_Prune;
2301ab31a845Sdan       }
2302ab31a845Sdan     }
2303ab31a845Sdan   }
2304ab31a845Sdan 
2305ab31a845Sdan   /* Check if pExpr is a sub-select. If so, consider it variable. */
2306a4eeccdfSdrh   if( ExprUseXSelect(pExpr) ){
2307ab31a845Sdan     pWalker->eCode = 0;
2308ab31a845Sdan     return WRC_Abort;
2309ab31a845Sdan   }
2310ab31a845Sdan 
2311ab31a845Sdan   return exprNodeIsConstant(pWalker, pExpr);
2312ab31a845Sdan }
2313ab31a845Sdan 
2314ab31a845Sdan /*
2315ab31a845Sdan ** Walk the expression tree passed as the first argument. Return non-zero
2316ab31a845Sdan ** if the expression consists entirely of constants or copies of terms
2317ab31a845Sdan ** in pGroupBy that sort with the BINARY collation sequence.
2318ab314001Sdrh **
2319ab314001Sdrh ** This routine is used to determine if a term of the HAVING clause can
2320ab314001Sdrh ** be promoted into the WHERE clause.  In order for such a promotion to work,
2321ab314001Sdrh ** the value of the HAVING clause term must be the same for all members of
2322ab314001Sdrh ** a "group".  The requirement that the GROUP BY term must be BINARY
2323ab314001Sdrh ** assumes that no other collating sequence will have a finer-grained
2324ab314001Sdrh ** grouping than binary.  In other words (A=B COLLATE binary) implies
2325ab314001Sdrh ** A=B in every other collating sequence.  The requirement that the
2326ab314001Sdrh ** GROUP BY be BINARY is stricter than necessary.  It would also work
2327ab314001Sdrh ** to promote HAVING clauses that use the same alternative collating
2328ab314001Sdrh ** sequence as the GROUP BY term, but that is much harder to check,
2329ab314001Sdrh ** alternative collating sequences are uncommon, and this is only an
2330ab314001Sdrh ** optimization, so we take the easy way out and simply require the
2331ab314001Sdrh ** GROUP BY to use the BINARY collating sequence.
2332ab31a845Sdan */
2333ab31a845Sdan int sqlite3ExprIsConstantOrGroupBy(Parse *pParse, Expr *p, ExprList *pGroupBy){
2334ab31a845Sdan   Walker w;
2335ab31a845Sdan   w.eCode = 1;
2336ab31a845Sdan   w.xExprCallback = exprNodeIsConstantOrGroupBy;
2337979dd1beSdrh   w.xSelectCallback = 0;
2338ab31a845Sdan   w.u.pGroupBy = pGroupBy;
2339ab31a845Sdan   w.pParse = pParse;
2340ab31a845Sdan   sqlite3WalkExpr(&w, p);
2341ab31a845Sdan   return w.eCode;
2342ab31a845Sdan }
2343ab31a845Sdan 
2344059b2d50Sdrh /*
2345014fff20Sdrh ** Walk an expression tree for the DEFAULT field of a column definition
2346014fff20Sdrh ** in a CREATE TABLE statement.  Return non-zero if the expression is
2347014fff20Sdrh ** acceptable for use as a DEFAULT.  That is to say, return non-zero if
2348014fff20Sdrh ** the expression is constant or a function call with constant arguments.
2349014fff20Sdrh ** Return and 0 if there are any variables.
2350014fff20Sdrh **
23511e32bed3Sdrh ** isInit is true when parsing from sqlite_schema.  isInit is false when
2352014fff20Sdrh ** processing a new CREATE TABLE statement.  When isInit is true, parameters
2353014fff20Sdrh ** (such as ? or $abc) in the expression are converted into NULL.  When
2354014fff20Sdrh ** isInit is false, parameters raise an error.  Parameters should not be
2355014fff20Sdrh ** allowed in a CREATE TABLE statement, but some legacy versions of SQLite
23561e32bed3Sdrh ** allowed it, so we need to support it when reading sqlite_schema for
2357014fff20Sdrh ** backwards compatibility.
2358014fff20Sdrh **
2359014fff20Sdrh ** If isInit is true, set EP_FromDDL on every TK_FUNCTION node.
2360eb55bd2fSdrh **
2361eb55bd2fSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
2362eb55bd2fSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
2363eb55bd2fSdrh ** a constant.
2364eb55bd2fSdrh */
2365feada2dfSdrh int sqlite3ExprIsConstantOrFunction(Expr *p, u8 isInit){
2366feada2dfSdrh   assert( isInit==0 || isInit==1 );
2367059b2d50Sdrh   return exprIsConst(p, 4+isInit, 0);
2368eb55bd2fSdrh }
2369eb55bd2fSdrh 
23705b88bc4bSdrh #ifdef SQLITE_ENABLE_CURSOR_HINTS
23715b88bc4bSdrh /*
23725b88bc4bSdrh ** Walk an expression tree.  Return 1 if the expression contains a
23735b88bc4bSdrh ** subquery of some kind.  Return 0 if there are no subqueries.
23745b88bc4bSdrh */
23755b88bc4bSdrh int sqlite3ExprContainsSubquery(Expr *p){
23765b88bc4bSdrh   Walker w;
2377bec2476aSdrh   w.eCode = 1;
23785b88bc4bSdrh   w.xExprCallback = sqlite3ExprWalkNoop;
23797e6f980bSdrh   w.xSelectCallback = sqlite3SelectWalkFail;
2380979dd1beSdrh #ifdef SQLITE_DEBUG
2381979dd1beSdrh   w.xSelectCallback2 = sqlite3SelectWalkAssert2;
2382979dd1beSdrh #endif
23835b88bc4bSdrh   sqlite3WalkExpr(&w, p);
238407194bffSdrh   return w.eCode==0;
23855b88bc4bSdrh }
23865b88bc4bSdrh #endif
23875b88bc4bSdrh 
2388eb55bd2fSdrh /*
238973b211abSdrh ** If the expression p codes a constant integer that is small enough
2390202b2df7Sdrh ** to fit in a 32-bit integer, return 1 and put the value of the integer
2391202b2df7Sdrh ** in *pValue.  If the expression is not an integer or if it is too big
2392202b2df7Sdrh ** to fit in a signed 32-bit integer, return 0 and leave *pValue unchanged.
2393e4de1febSdrh */
2394b6dad520Sdrh int sqlite3ExprIsInteger(const Expr *p, int *pValue){
239592b01d53Sdrh   int rc = 0;
23961d2d71a0Sdrh   if( NEVER(p==0) ) return 0;  /* Used to only happen following on OOM */
2397cd92e84dSdrh 
2398cd92e84dSdrh   /* If an expression is an integer literal that fits in a signed 32-bit
2399cd92e84dSdrh   ** integer, then the EP_IntValue flag will have already been set */
2400cd92e84dSdrh   assert( p->op!=TK_INTEGER || (p->flags & EP_IntValue)!=0
2401cd92e84dSdrh            || sqlite3GetInt32(p->u.zToken, &rc)==0 );
2402cd92e84dSdrh 
240392b01d53Sdrh   if( p->flags & EP_IntValue ){
240433e619fcSdrh     *pValue = p->u.iValue;
2405e4de1febSdrh     return 1;
2406e4de1febSdrh   }
240792b01d53Sdrh   switch( p->op ){
24084b59ab5eSdrh     case TK_UPLUS: {
240992b01d53Sdrh       rc = sqlite3ExprIsInteger(p->pLeft, pValue);
2410f6e369a1Sdrh       break;
24114b59ab5eSdrh     }
2412e4de1febSdrh     case TK_UMINUS: {
2413c59ffa8cSdrh       int v = 0;
24144adee20fSdanielk1977       if( sqlite3ExprIsInteger(p->pLeft, &v) ){
2415c59ffa8cSdrh         assert( ((unsigned int)v)!=0x80000000 );
2416e4de1febSdrh         *pValue = -v;
241792b01d53Sdrh         rc = 1;
2418e4de1febSdrh       }
2419e4de1febSdrh       break;
2420e4de1febSdrh     }
2421e4de1febSdrh     default: break;
2422e4de1febSdrh   }
242392b01d53Sdrh   return rc;
2424e4de1febSdrh }
2425e4de1febSdrh 
2426e4de1febSdrh /*
2427039fc32eSdrh ** Return FALSE if there is no chance that the expression can be NULL.
2428039fc32eSdrh **
2429039fc32eSdrh ** If the expression might be NULL or if the expression is too complex
2430039fc32eSdrh ** to tell return TRUE.
2431039fc32eSdrh **
2432039fc32eSdrh ** This routine is used as an optimization, to skip OP_IsNull opcodes
2433039fc32eSdrh ** when we know that a value cannot be NULL.  Hence, a false positive
2434039fc32eSdrh ** (returning TRUE when in fact the expression can never be NULL) might
2435039fc32eSdrh ** be a small performance hit but is otherwise harmless.  On the other
2436039fc32eSdrh ** hand, a false negative (returning FALSE when the result could be NULL)
2437039fc32eSdrh ** will likely result in an incorrect answer.  So when in doubt, return
2438039fc32eSdrh ** TRUE.
2439039fc32eSdrh */
2440039fc32eSdrh int sqlite3ExprCanBeNull(const Expr *p){
2441039fc32eSdrh   u8 op;
24423c6edc8aSdrh   assert( p!=0 );
24439bfb0794Sdrh   while( p->op==TK_UPLUS || p->op==TK_UMINUS ){
24449bfb0794Sdrh     p = p->pLeft;
24453c6edc8aSdrh     assert( p!=0 );
24469bfb0794Sdrh   }
2447039fc32eSdrh   op = p->op;
2448039fc32eSdrh   if( op==TK_REGISTER ) op = p->op2;
2449039fc32eSdrh   switch( op ){
2450039fc32eSdrh     case TK_INTEGER:
2451039fc32eSdrh     case TK_STRING:
2452039fc32eSdrh     case TK_FLOAT:
2453039fc32eSdrh     case TK_BLOB:
2454039fc32eSdrh       return 0;
24557248a8b2Sdrh     case TK_COLUMN:
2456477572b9Sdrh       assert( ExprUseYTab(p) );
245772673a24Sdrh       return ExprHasProperty(p, EP_CanBeNull) ||
2458eda079cdSdrh              p->y.pTab==0 ||  /* Reference to column of index on expression */
24594eac5f04Sdrh              (p->iColumn>=0
24604eac5f04Sdrh               && ALWAYS(p->y.pTab->aCol!=0) /* Defense against OOM problems */
24614eac5f04Sdrh               && p->y.pTab->aCol[p->iColumn].notNull==0);
2462039fc32eSdrh     default:
2463039fc32eSdrh       return 1;
2464039fc32eSdrh   }
2465039fc32eSdrh }
2466039fc32eSdrh 
2467039fc32eSdrh /*
2468039fc32eSdrh ** Return TRUE if the given expression is a constant which would be
2469039fc32eSdrh ** unchanged by OP_Affinity with the affinity given in the second
2470039fc32eSdrh ** argument.
2471039fc32eSdrh **
2472039fc32eSdrh ** This routine is used to determine if the OP_Affinity operation
2473039fc32eSdrh ** can be omitted.  When in doubt return FALSE.  A false negative
2474039fc32eSdrh ** is harmless.  A false positive, however, can result in the wrong
2475039fc32eSdrh ** answer.
2476039fc32eSdrh */
2477039fc32eSdrh int sqlite3ExprNeedsNoAffinityChange(const Expr *p, char aff){
2478039fc32eSdrh   u8 op;
2479af866402Sdrh   int unaryMinus = 0;
248005883a34Sdrh   if( aff==SQLITE_AFF_BLOB ) return 1;
2481af866402Sdrh   while( p->op==TK_UPLUS || p->op==TK_UMINUS ){
2482af866402Sdrh     if( p->op==TK_UMINUS ) unaryMinus = 1;
2483af866402Sdrh     p = p->pLeft;
2484af866402Sdrh   }
2485039fc32eSdrh   op = p->op;
2486039fc32eSdrh   if( op==TK_REGISTER ) op = p->op2;
2487039fc32eSdrh   switch( op ){
2488039fc32eSdrh     case TK_INTEGER: {
24896a19865fSdrh       return aff>=SQLITE_AFF_NUMERIC;
2490039fc32eSdrh     }
2491039fc32eSdrh     case TK_FLOAT: {
24926a19865fSdrh       return aff>=SQLITE_AFF_NUMERIC;
2493039fc32eSdrh     }
2494039fc32eSdrh     case TK_STRING: {
2495af866402Sdrh       return !unaryMinus && aff==SQLITE_AFF_TEXT;
2496039fc32eSdrh     }
2497039fc32eSdrh     case TK_BLOB: {
2498af866402Sdrh       return !unaryMinus;
2499039fc32eSdrh     }
25002f2855b6Sdrh     case TK_COLUMN: {
250188376ca7Sdrh       assert( p->iTable>=0 );  /* p cannot be part of a CHECK constraint */
25026a19865fSdrh       return aff>=SQLITE_AFF_NUMERIC && p->iColumn<0;
25032f2855b6Sdrh     }
2504039fc32eSdrh     default: {
2505039fc32eSdrh       return 0;
2506039fc32eSdrh     }
2507039fc32eSdrh   }
2508039fc32eSdrh }
2509039fc32eSdrh 
2510039fc32eSdrh /*
2511c4a3c779Sdrh ** Return TRUE if the given string is a row-id column name.
2512c4a3c779Sdrh */
25134adee20fSdanielk1977 int sqlite3IsRowid(const char *z){
25144adee20fSdanielk1977   if( sqlite3StrICmp(z, "_ROWID_")==0 ) return 1;
25154adee20fSdanielk1977   if( sqlite3StrICmp(z, "ROWID")==0 ) return 1;
25164adee20fSdanielk1977   if( sqlite3StrICmp(z, "OID")==0 ) return 1;
2517c4a3c779Sdrh   return 0;
2518c4a3c779Sdrh }
2519c4a3c779Sdrh 
25209a96b668Sdanielk1977 /*
252169c355bdSdrh ** pX is the RHS of an IN operator.  If pX is a SELECT statement
252269c355bdSdrh ** that can be simplified to a direct table access, then return
252369c355bdSdrh ** a pointer to the SELECT statement.  If pX is not a SELECT statement,
252469c355bdSdrh ** or if the SELECT statement needs to be manifested into a transient
252569c355bdSdrh ** table, then return NULL.
2526b287f4b6Sdrh */
2527b287f4b6Sdrh #ifndef SQLITE_OMIT_SUBQUERY
2528b6dad520Sdrh static Select *isCandidateForInOpt(const Expr *pX){
252969c355bdSdrh   Select *p;
2530b287f4b6Sdrh   SrcList *pSrc;
2531b287f4b6Sdrh   ExprList *pEList;
2532b287f4b6Sdrh   Table *pTab;
2533cfbb5e82Sdan   int i;
2534a4eeccdfSdrh   if( !ExprUseXSelect(pX) ) return 0;                 /* Not a subquery */
253569c355bdSdrh   if( ExprHasProperty(pX, EP_VarSelect)  ) return 0;  /* Correlated subq */
253669c355bdSdrh   p = pX->x.pSelect;
2537b287f4b6Sdrh   if( p->pPrior ) return 0;              /* Not a compound SELECT */
25387d10d5a6Sdrh   if( p->selFlags & (SF_Distinct|SF_Aggregate) ){
2539b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
2540b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
25417d10d5a6Sdrh     return 0; /* No DISTINCT keyword and no aggregate functions */
25427d10d5a6Sdrh   }
25432e26a602Sdrh   assert( p->pGroupBy==0 );              /* Has no GROUP BY clause */
2544b287f4b6Sdrh   if( p->pLimit ) return 0;              /* Has no LIMIT clause */
2545b287f4b6Sdrh   if( p->pWhere ) return 0;              /* Has no WHERE clause */
2546b287f4b6Sdrh   pSrc = p->pSrc;
2547d1fa7bcaSdrh   assert( pSrc!=0 );
2548d1fa7bcaSdrh   if( pSrc->nSrc!=1 ) return 0;          /* Single term in FROM clause */
2549b74b1017Sdrh   if( pSrc->a[0].pSelect ) return 0;     /* FROM is not a subquery or view */
2550b287f4b6Sdrh   pTab = pSrc->a[0].pTab;
255169c355bdSdrh   assert( pTab!=0 );
2552f38524d2Sdrh   assert( !IsView(pTab)  );              /* FROM clause is not a view */
2553b287f4b6Sdrh   if( IsVirtual(pTab) ) return 0;        /* FROM clause not a virtual table */
2554b287f4b6Sdrh   pEList = p->pEList;
2555ac6b47d1Sdrh   assert( pEList!=0 );
25567b35a77bSdan   /* All SELECT results must be columns. */
2557cfbb5e82Sdan   for(i=0; i<pEList->nExpr; i++){
2558cfbb5e82Sdan     Expr *pRes = pEList->a[i].pExpr;
2559cfbb5e82Sdan     if( pRes->op!=TK_COLUMN ) return 0;
256069c355bdSdrh     assert( pRes->iTable==pSrc->a[0].iCursor );  /* Not a correlated subquery */
2561cfbb5e82Sdan   }
256269c355bdSdrh   return p;
2563b287f4b6Sdrh }
2564b287f4b6Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
2565b287f4b6Sdrh 
2566f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
25671d8cb21fSdan /*
25684c259e9fSdrh ** Generate code that checks the left-most column of index table iCur to see if
25694c259e9fSdrh ** it contains any NULL entries.  Cause the register at regHasNull to be set
25706be515ebSdrh ** to a non-NULL value if iCur contains no NULLs.  Cause register regHasNull
25716be515ebSdrh ** to be set to NULL if iCur contains one or more NULL values.
25726be515ebSdrh */
25736be515ebSdrh static void sqlite3SetHasNullFlag(Vdbe *v, int iCur, int regHasNull){
2574728e0f91Sdrh   int addr1;
25756be515ebSdrh   sqlite3VdbeAddOp2(v, OP_Integer, 0, regHasNull);
2576728e0f91Sdrh   addr1 = sqlite3VdbeAddOp1(v, OP_Rewind, iCur); VdbeCoverage(v);
25776be515ebSdrh   sqlite3VdbeAddOp3(v, OP_Column, iCur, 0, regHasNull);
25786be515ebSdrh   sqlite3VdbeChangeP5(v, OPFLAG_TYPEOFARG);
25794c259e9fSdrh   VdbeComment((v, "first_entry_in(%d)", iCur));
2580728e0f91Sdrh   sqlite3VdbeJumpHere(v, addr1);
25816be515ebSdrh }
2582f9b2e05cSdan #endif
25836be515ebSdrh 
2584bb53ecb1Sdrh 
2585bb53ecb1Sdrh #ifndef SQLITE_OMIT_SUBQUERY
2586bb53ecb1Sdrh /*
2587bb53ecb1Sdrh ** The argument is an IN operator with a list (not a subquery) on the
2588bb53ecb1Sdrh ** right-hand side.  Return TRUE if that list is constant.
2589bb53ecb1Sdrh */
2590bb53ecb1Sdrh static int sqlite3InRhsIsConstant(Expr *pIn){
2591bb53ecb1Sdrh   Expr *pLHS;
2592bb53ecb1Sdrh   int res;
2593bb53ecb1Sdrh   assert( !ExprHasProperty(pIn, EP_xIsSelect) );
2594bb53ecb1Sdrh   pLHS = pIn->pLeft;
2595bb53ecb1Sdrh   pIn->pLeft = 0;
2596bb53ecb1Sdrh   res = sqlite3ExprIsConstant(pIn);
2597bb53ecb1Sdrh   pIn->pLeft = pLHS;
2598bb53ecb1Sdrh   return res;
2599bb53ecb1Sdrh }
2600bb53ecb1Sdrh #endif
2601bb53ecb1Sdrh 
26026be515ebSdrh /*
26039a96b668Sdanielk1977 ** This function is used by the implementation of the IN (...) operator.
2604d4305ca6Sdrh ** The pX parameter is the expression on the RHS of the IN operator, which
2605d4305ca6Sdrh ** might be either a list of expressions or a subquery.
26069a96b668Sdanielk1977 **
2607d4305ca6Sdrh ** The job of this routine is to find or create a b-tree object that can
2608d4305ca6Sdrh ** be used either to test for membership in the RHS set or to iterate through
2609d4305ca6Sdrh ** all members of the RHS set, skipping duplicates.
2610d4305ca6Sdrh **
26113a85625dSdrh ** A cursor is opened on the b-tree object that is the RHS of the IN operator
2612d4305ca6Sdrh ** and pX->iTable is set to the index of that cursor.
2613d4305ca6Sdrh **
2614b74b1017Sdrh ** The returned value of this function indicates the b-tree type, as follows:
26159a96b668Sdanielk1977 **
26169a96b668Sdanielk1977 **   IN_INDEX_ROWID      - The cursor was opened on a database table.
26171ccce449Sdrh **   IN_INDEX_INDEX_ASC  - The cursor was opened on an ascending index.
26181ccce449Sdrh **   IN_INDEX_INDEX_DESC - The cursor was opened on a descending index.
26199a96b668Sdanielk1977 **   IN_INDEX_EPH        - The cursor was opened on a specially created and
26209a96b668Sdanielk1977 **                         populated epheremal table.
2621bb53ecb1Sdrh **   IN_INDEX_NOOP       - No cursor was allocated.  The IN operator must be
2622bb53ecb1Sdrh **                         implemented as a sequence of comparisons.
26239a96b668Sdanielk1977 **
2624d4305ca6Sdrh ** An existing b-tree might be used if the RHS expression pX is a simple
2625d4305ca6Sdrh ** subquery such as:
26269a96b668Sdanielk1977 **
2627553168c7Sdan **     SELECT <column1>, <column2>... FROM <table>
26289a96b668Sdanielk1977 **
2629d4305ca6Sdrh ** If the RHS of the IN operator is a list or a more complex subquery, then
2630d4305ca6Sdrh ** an ephemeral table might need to be generated from the RHS and then
263160ec914cSpeter.d.reid ** pX->iTable made to point to the ephemeral table instead of an
2632d4305ca6Sdrh ** existing table.
2633d4305ca6Sdrh **
26347fc0ba0fSdrh ** The inFlags parameter must contain, at a minimum, one of the bits
26357fc0ba0fSdrh ** IN_INDEX_MEMBERSHIP or IN_INDEX_LOOP but not both.  If inFlags contains
26367fc0ba0fSdrh ** IN_INDEX_MEMBERSHIP, then the generated table will be used for a fast
26377fc0ba0fSdrh ** membership test.  When the IN_INDEX_LOOP bit is set, the IN index will
26387fc0ba0fSdrh ** be used to loop over all values of the RHS of the IN operator.
26393a85625dSdrh **
26403a85625dSdrh ** When IN_INDEX_LOOP is used (and the b-tree will be used to iterate
26413a85625dSdrh ** through the set members) then the b-tree must not contain duplicates.
26427fc0ba0fSdrh ** An epheremal table will be created unless the selected columns are guaranteed
2643553168c7Sdan ** to be unique - either because it is an INTEGER PRIMARY KEY or due to
2644553168c7Sdan ** a UNIQUE constraint or index.
26450cdc022eSdanielk1977 **
26463a85625dSdrh ** When IN_INDEX_MEMBERSHIP is used (and the b-tree will be used
26473a85625dSdrh ** for fast set membership tests) then an epheremal table must
2648553168c7Sdan ** be used unless <columns> is a single INTEGER PRIMARY KEY column or an
2649553168c7Sdan ** index can be found with the specified <columns> as its left-most.
26500cdc022eSdanielk1977 **
2651bb53ecb1Sdrh ** If the IN_INDEX_NOOP_OK and IN_INDEX_MEMBERSHIP are both set and
2652bb53ecb1Sdrh ** if the RHS of the IN operator is a list (not a subquery) then this
2653bb53ecb1Sdrh ** routine might decide that creating an ephemeral b-tree for membership
2654bb53ecb1Sdrh ** testing is too expensive and return IN_INDEX_NOOP.  In that case, the
2655bb53ecb1Sdrh ** calling routine should implement the IN operator using a sequence
2656bb53ecb1Sdrh ** of Eq or Ne comparison operations.
2657bb53ecb1Sdrh **
2658b74b1017Sdrh ** When the b-tree is being used for membership tests, the calling function
26593a85625dSdrh ** might need to know whether or not the RHS side of the IN operator
2660e21a6e1dSdrh ** contains a NULL.  If prRhsHasNull is not a NULL pointer and
26613a85625dSdrh ** if there is any chance that the (...) might contain a NULL value at
26620cdc022eSdanielk1977 ** runtime, then a register is allocated and the register number written
2663e21a6e1dSdrh ** to *prRhsHasNull. If there is no chance that the (...) contains a
2664e21a6e1dSdrh ** NULL value, then *prRhsHasNull is left unchanged.
26650cdc022eSdanielk1977 **
2666e21a6e1dSdrh ** If a register is allocated and its location stored in *prRhsHasNull, then
26676be515ebSdrh ** the value in that register will be NULL if the b-tree contains one or more
26686be515ebSdrh ** NULL values, and it will be some non-NULL value if the b-tree contains no
26696be515ebSdrh ** NULL values.
2670553168c7Sdan **
2671553168c7Sdan ** If the aiMap parameter is not NULL, it must point to an array containing
2672553168c7Sdan ** one element for each column returned by the SELECT statement on the RHS
2673553168c7Sdan ** of the IN(...) operator. The i'th entry of the array is populated with the
2674553168c7Sdan ** offset of the index column that matches the i'th column returned by the
2675553168c7Sdan ** SELECT. For example, if the expression and selected index are:
2676553168c7Sdan **
2677553168c7Sdan **   (?,?,?) IN (SELECT a, b, c FROM t1)
2678553168c7Sdan **   CREATE INDEX i1 ON t1(b, c, a);
2679553168c7Sdan **
2680553168c7Sdan ** then aiMap[] is populated with {2, 0, 1}.
26819a96b668Sdanielk1977 */
2682284f4acaSdanielk1977 #ifndef SQLITE_OMIT_SUBQUERY
2683ba00e30aSdan int sqlite3FindInIndex(
26846fc8f364Sdrh   Parse *pParse,             /* Parsing context */
26850167ef20Sdrh   Expr *pX,                  /* The IN expression */
26866fc8f364Sdrh   u32 inFlags,               /* IN_INDEX_LOOP, _MEMBERSHIP, and/or _NOOP_OK */
26876fc8f364Sdrh   int *prRhsHasNull,         /* Register holding NULL status.  See notes */
26882c04131cSdrh   int *aiMap,                /* Mapping from Index fields to RHS fields */
26892c04131cSdrh   int *piTab                 /* OUT: index to use */
2690ba00e30aSdan ){
2691b74b1017Sdrh   Select *p;                            /* SELECT to the right of IN operator */
2692b74b1017Sdrh   int eType = 0;                        /* Type of RHS table. IN_INDEX_* */
2693b74b1017Sdrh   int iTab = pParse->nTab++;            /* Cursor of the RHS table */
26943a85625dSdrh   int mustBeUnique;                     /* True if RHS must be unique */
2695b8475df8Sdrh   Vdbe *v = sqlite3GetVdbe(pParse);     /* Virtual machine being coded */
26969a96b668Sdanielk1977 
26971450bc6eSdrh   assert( pX->op==TK_IN );
26983a85625dSdrh   mustBeUnique = (inFlags & IN_INDEX_LOOP)!=0;
26991450bc6eSdrh 
27007b35a77bSdan   /* If the RHS of this IN(...) operator is a SELECT, and if it matters
27017b35a77bSdan   ** whether or not the SELECT result contains NULL values, check whether
2702870a0705Sdan   ** or not NULL is actually possible (it may not be, for example, due
27037b35a77bSdan   ** to NOT NULL constraints in the schema). If no NULL values are possible,
2704870a0705Sdan   ** set prRhsHasNull to 0 before continuing.  */
2705a4eeccdfSdrh   if( prRhsHasNull && ExprUseXSelect(pX) ){
27067b35a77bSdan     int i;
27077b35a77bSdan     ExprList *pEList = pX->x.pSelect->pEList;
27087b35a77bSdan     for(i=0; i<pEList->nExpr; i++){
27097b35a77bSdan       if( sqlite3ExprCanBeNull(pEList->a[i].pExpr) ) break;
27107b35a77bSdan     }
27117b35a77bSdan     if( i==pEList->nExpr ){
27127b35a77bSdan       prRhsHasNull = 0;
27137b35a77bSdan     }
27147b35a77bSdan   }
27157b35a77bSdan 
2716b74b1017Sdrh   /* Check to see if an existing table or index can be used to
2717b74b1017Sdrh   ** satisfy the query.  This is preferable to generating a new
27187b35a77bSdan   ** ephemeral table.  */
27197b35a77bSdan   if( pParse->nErr==0 && (p = isCandidateForInOpt(pX))!=0 ){
2720e1fb65a0Sdanielk1977     sqlite3 *db = pParse->db;              /* Database connection */
2721b07028f7Sdrh     Table *pTab;                           /* Table <table>. */
2722399062ccSdrh     int iDb;                               /* Database idx for pTab */
2723cfbb5e82Sdan     ExprList *pEList = p->pEList;
2724cfbb5e82Sdan     int nExpr = pEList->nExpr;
2725e1fb65a0Sdanielk1977 
2726b07028f7Sdrh     assert( p->pEList!=0 );             /* Because of isCandidateForInOpt(p) */
2727b07028f7Sdrh     assert( p->pEList->a[0].pExpr!=0 ); /* Because of isCandidateForInOpt(p) */
2728b07028f7Sdrh     assert( p->pSrc!=0 );               /* Because of isCandidateForInOpt(p) */
2729b07028f7Sdrh     pTab = p->pSrc->a[0].pTab;
2730b07028f7Sdrh 
2731b22f7c83Sdrh     /* Code an OP_Transaction and OP_TableLock for <table>. */
2732e1fb65a0Sdanielk1977     iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
2733099b385dSdrh     assert( iDb>=0 && iDb<SQLITE_MAX_DB );
2734e1fb65a0Sdanielk1977     sqlite3CodeVerifySchema(pParse, iDb);
2735e1fb65a0Sdanielk1977     sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
27369a96b668Sdanielk1977 
2737a84a283dSdrh     assert(v);  /* sqlite3GetVdbe() has always been previously called */
2738cfbb5e82Sdan     if( nExpr==1 && pEList->a[0].pExpr->iColumn<0 ){
273962659b2aSdrh       /* The "x IN (SELECT rowid FROM table)" case */
2740511f9e8dSdrh       int iAddr = sqlite3VdbeAddOp0(v, OP_Once);
27417d176105Sdrh       VdbeCoverage(v);
27429a96b668Sdanielk1977 
27439a96b668Sdanielk1977       sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
27449a96b668Sdanielk1977       eType = IN_INDEX_ROWID;
2745d8852095Sdrh       ExplainQueryPlan((pParse, 0,
2746d8852095Sdrh             "USING ROWID SEARCH ON TABLE %s FOR IN-OPERATOR",pTab->zName));
27479a96b668Sdanielk1977       sqlite3VdbeJumpHere(v, iAddr);
27489a96b668Sdanielk1977     }else{
2749e1fb65a0Sdanielk1977       Index *pIdx;                         /* Iterator variable */
2750cfbb5e82Sdan       int affinity_ok = 1;
2751cfbb5e82Sdan       int i;
2752cfbb5e82Sdan 
2753cfbb5e82Sdan       /* Check that the affinity that will be used to perform each
275462659b2aSdrh       ** comparison is the same as the affinity of each column in table
275562659b2aSdrh       ** on the RHS of the IN operator.  If it not, it is not possible to
275662659b2aSdrh       ** use any index of the RHS table.  */
2757cfbb5e82Sdan       for(i=0; i<nExpr && affinity_ok; i++){
2758fc7f27b9Sdrh         Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2759cfbb5e82Sdan         int iCol = pEList->a[i].pExpr->iColumn;
27600dfa4f6fSdrh         char idxaff = sqlite3TableColumnAffinity(pTab,iCol); /* RHS table */
2761cfbb5e82Sdan         char cmpaff = sqlite3CompareAffinity(pLhs, idxaff);
276262659b2aSdrh         testcase( cmpaff==SQLITE_AFF_BLOB );
276362659b2aSdrh         testcase( cmpaff==SQLITE_AFF_TEXT );
2764cfbb5e82Sdan         switch( cmpaff ){
2765cfbb5e82Sdan           case SQLITE_AFF_BLOB:
2766cfbb5e82Sdan             break;
2767cfbb5e82Sdan           case SQLITE_AFF_TEXT:
276862659b2aSdrh             /* sqlite3CompareAffinity() only returns TEXT if one side or the
276962659b2aSdrh             ** other has no affinity and the other side is TEXT.  Hence,
277062659b2aSdrh             ** the only way for cmpaff to be TEXT is for idxaff to be TEXT
277162659b2aSdrh             ** and for the term on the LHS of the IN to have no affinity. */
277262659b2aSdrh             assert( idxaff==SQLITE_AFF_TEXT );
2773cfbb5e82Sdan             break;
2774cfbb5e82Sdan           default:
2775cfbb5e82Sdan             affinity_ok = sqlite3IsNumericAffinity(idxaff);
2776cfbb5e82Sdan         }
2777cfbb5e82Sdan       }
2778e1fb65a0Sdanielk1977 
2779a84a283dSdrh       if( affinity_ok ){
2780a84a283dSdrh         /* Search for an existing index that will work for this IN operator */
2781a84a283dSdrh         for(pIdx=pTab->pIndex; pIdx && eType==0; pIdx=pIdx->pNext){
2782a84a283dSdrh           Bitmask colUsed;      /* Columns of the index used */
2783a84a283dSdrh           Bitmask mCol;         /* Mask for the current column */
27846fc8f364Sdrh           if( pIdx->nColumn<nExpr ) continue;
2785d4a4a361Sdrh           if( pIdx->pPartIdxWhere!=0 ) continue;
2786a84a283dSdrh           /* Maximum nColumn is BMS-2, not BMS-1, so that we can compute
2787a84a283dSdrh           ** BITMASK(nExpr) without overflowing */
2788a84a283dSdrh           testcase( pIdx->nColumn==BMS-2 );
2789a84a283dSdrh           testcase( pIdx->nColumn==BMS-1 );
2790a84a283dSdrh           if( pIdx->nColumn>=BMS-1 ) continue;
27916fc8f364Sdrh           if( mustBeUnique ){
27926fc8f364Sdrh             if( pIdx->nKeyCol>nExpr
27936fc8f364Sdrh              ||(pIdx->nColumn>nExpr && !IsUniqueIndex(pIdx))
27946fc8f364Sdrh             ){
2795a84a283dSdrh               continue;  /* This index is not unique over the IN RHS columns */
2796cfbb5e82Sdan             }
27976fc8f364Sdrh           }
2798cfbb5e82Sdan 
2799a84a283dSdrh           colUsed = 0;   /* Columns of index used so far */
2800cfbb5e82Sdan           for(i=0; i<nExpr; i++){
2801fc7f27b9Sdrh             Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2802cfbb5e82Sdan             Expr *pRhs = pEList->a[i].pExpr;
2803cfbb5e82Sdan             CollSeq *pReq = sqlite3BinaryCompareCollSeq(pParse, pLhs, pRhs);
2804cfbb5e82Sdan             int j;
2805cfbb5e82Sdan 
28066fc8f364Sdrh             assert( pReq!=0 || pRhs->iColumn==XN_ROWID || pParse->nErr );
2807cfbb5e82Sdan             for(j=0; j<nExpr; j++){
2808cfbb5e82Sdan               if( pIdx->aiColumn[j]!=pRhs->iColumn ) continue;
2809cfbb5e82Sdan               assert( pIdx->azColl[j] );
2810106526e1Sdrh               if( pReq!=0 && sqlite3StrICmp(pReq->zName, pIdx->azColl[j])!=0 ){
2811106526e1Sdrh                 continue;
2812106526e1Sdrh               }
2813cfbb5e82Sdan               break;
2814cfbb5e82Sdan             }
2815cfbb5e82Sdan             if( j==nExpr ) break;
2816a84a283dSdrh             mCol = MASKBIT(j);
2817a84a283dSdrh             if( mCol & colUsed ) break; /* Each column used only once */
2818a84a283dSdrh             colUsed |= mCol;
2819ba00e30aSdan             if( aiMap ) aiMap[i] = j;
2820cfbb5e82Sdan           }
2821cfbb5e82Sdan 
2822a84a283dSdrh           assert( i==nExpr || colUsed!=(MASKBIT(nExpr)-1) );
2823a84a283dSdrh           if( colUsed==(MASKBIT(nExpr)-1) ){
2824a84a283dSdrh             /* If we reach this point, that means the index pIdx is usable */
2825511f9e8dSdrh             int iAddr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
2826e2ca99c9Sdrh             ExplainQueryPlan((pParse, 0,
2827e2ca99c9Sdrh                               "USING INDEX %s FOR IN-OPERATOR",pIdx->zName));
28282ec2fb22Sdrh             sqlite3VdbeAddOp3(v, OP_OpenRead, iTab, pIdx->tnum, iDb);
28292ec2fb22Sdrh             sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
2830207872a4Sdanielk1977             VdbeComment((v, "%s", pIdx->zName));
28311ccce449Sdrh             assert( IN_INDEX_INDEX_DESC == IN_INDEX_INDEX_ASC+1 );
28321ccce449Sdrh             eType = IN_INDEX_INDEX_ASC + pIdx->aSortOrder[0];
28339a96b668Sdanielk1977 
28347b35a77bSdan             if( prRhsHasNull ){
28353480bfdaSdan #ifdef SQLITE_ENABLE_COLUMN_USED_MASK
2836cfbb5e82Sdan               i64 mask = (1<<nExpr)-1;
28373480bfdaSdan               sqlite3VdbeAddOp4Dup8(v, OP_ColumnsUsed,
2838cfbb5e82Sdan                   iTab, 0, 0, (u8*)&mask, P4_INT64);
28393480bfdaSdan #endif
2840b80dbdc2Sdrh               *prRhsHasNull = ++pParse->nMem;
28417b35a77bSdan               if( nExpr==1 ){
28426be515ebSdrh                 sqlite3SetHasNullFlag(v, iTab, *prRhsHasNull);
28430cdc022eSdanielk1977               }
28447b35a77bSdan             }
2845552fd454Sdrh             sqlite3VdbeJumpHere(v, iAddr);
28469a96b668Sdanielk1977           }
2847a84a283dSdrh         } /* End loop over indexes */
2848a84a283dSdrh       } /* End if( affinity_ok ) */
2849a84a283dSdrh     } /* End if not an rowid index */
2850a84a283dSdrh   } /* End attempt to optimize using an index */
28519a96b668Sdanielk1977 
2852bb53ecb1Sdrh   /* If no preexisting index is available for the IN clause
2853bb53ecb1Sdrh   ** and IN_INDEX_NOOP is an allowed reply
2854bb53ecb1Sdrh   ** and the RHS of the IN operator is a list, not a subquery
285571c57db0Sdan   ** and the RHS is not constant or has two or fewer terms,
285660ec914cSpeter.d.reid   ** then it is not worth creating an ephemeral table to evaluate
2857bb53ecb1Sdrh   ** the IN operator so return IN_INDEX_NOOP.
2858bb53ecb1Sdrh   */
2859bb53ecb1Sdrh   if( eType==0
2860bb53ecb1Sdrh    && (inFlags & IN_INDEX_NOOP_OK)
2861a4eeccdfSdrh    && ExprUseXList(pX)
2862bb53ecb1Sdrh    && (!sqlite3InRhsIsConstant(pX) || pX->x.pList->nExpr<=2)
2863bb53ecb1Sdrh   ){
2864bb53ecb1Sdrh     eType = IN_INDEX_NOOP;
2865bb53ecb1Sdrh   }
2866bb53ecb1Sdrh 
28679a96b668Sdanielk1977   if( eType==0 ){
28684387006cSdrh     /* Could not find an existing table or index to use as the RHS b-tree.
2869b74b1017Sdrh     ** We will have to generate an ephemeral table to do the job.
2870b74b1017Sdrh     */
28718e23daf3Sdrh     u32 savedNQueryLoop = pParse->nQueryLoop;
28720cdc022eSdanielk1977     int rMayHaveNull = 0;
287341a05b7bSdanielk1977     eType = IN_INDEX_EPH;
28743a85625dSdrh     if( inFlags & IN_INDEX_LOOP ){
28754a5acf8eSdrh       pParse->nQueryLoop = 0;
2876e21a6e1dSdrh     }else if( prRhsHasNull ){
2877e21a6e1dSdrh       *prRhsHasNull = rMayHaveNull = ++pParse->nMem;
2878cf4d38aaSdrh     }
287985bcdce2Sdrh     assert( pX->op==TK_IN );
288050ef6716Sdrh     sqlite3CodeRhsOfIN(pParse, pX, iTab);
288185bcdce2Sdrh     if( rMayHaveNull ){
28822c04131cSdrh       sqlite3SetHasNullFlag(v, iTab, rMayHaveNull);
288385bcdce2Sdrh     }
2884cf4d38aaSdrh     pParse->nQueryLoop = savedNQueryLoop;
28859a96b668Sdanielk1977   }
2886ba00e30aSdan 
2887ba00e30aSdan   if( aiMap && eType!=IN_INDEX_INDEX_ASC && eType!=IN_INDEX_INDEX_DESC ){
2888ba00e30aSdan     int i, n;
2889ba00e30aSdan     n = sqlite3ExprVectorSize(pX->pLeft);
2890ba00e30aSdan     for(i=0; i<n; i++) aiMap[i] = i;
2891ba00e30aSdan   }
28922c04131cSdrh   *piTab = iTab;
28939a96b668Sdanielk1977   return eType;
28949a96b668Sdanielk1977 }
2895284f4acaSdanielk1977 #endif
2896626a879aSdrh 
2897f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
2898553168c7Sdan /*
2899553168c7Sdan ** Argument pExpr is an (?, ?...) IN(...) expression. This
2900553168c7Sdan ** function allocates and returns a nul-terminated string containing
2901553168c7Sdan ** the affinities to be used for each column of the comparison.
2902553168c7Sdan **
2903553168c7Sdan ** It is the responsibility of the caller to ensure that the returned
2904553168c7Sdan ** string is eventually freed using sqlite3DbFree().
2905553168c7Sdan */
2906b6dad520Sdrh static char *exprINAffinity(Parse *pParse, const Expr *pExpr){
290771c57db0Sdan   Expr *pLeft = pExpr->pLeft;
290871c57db0Sdan   int nVal = sqlite3ExprVectorSize(pLeft);
2909a4eeccdfSdrh   Select *pSelect = ExprUseXSelect(pExpr) ? pExpr->x.pSelect : 0;
291071c57db0Sdan   char *zRet;
291171c57db0Sdan 
2912553168c7Sdan   assert( pExpr->op==TK_IN );
29135c258dc1Sdrh   zRet = sqlite3DbMallocRaw(pParse->db, nVal+1);
291471c57db0Sdan   if( zRet ){
291571c57db0Sdan     int i;
291671c57db0Sdan     for(i=0; i<nVal; i++){
2917fc7f27b9Sdrh       Expr *pA = sqlite3VectorFieldSubexpr(pLeft, i);
2918553168c7Sdan       char a = sqlite3ExprAffinity(pA);
2919553168c7Sdan       if( pSelect ){
2920553168c7Sdan         zRet[i] = sqlite3CompareAffinity(pSelect->pEList->a[i].pExpr, a);
292171c57db0Sdan       }else{
2922553168c7Sdan         zRet[i] = a;
292371c57db0Sdan       }
292471c57db0Sdan     }
292571c57db0Sdan     zRet[nVal] = '\0';
292671c57db0Sdan   }
292771c57db0Sdan   return zRet;
292871c57db0Sdan }
2929f9b2e05cSdan #endif
293071c57db0Sdan 
29318da209b1Sdan #ifndef SQLITE_OMIT_SUBQUERY
29328da209b1Sdan /*
29338da209b1Sdan ** Load the Parse object passed as the first argument with an error
29348da209b1Sdan ** message of the form:
29358da209b1Sdan **
29368da209b1Sdan **   "sub-select returns N columns - expected M"
29378da209b1Sdan */
29388da209b1Sdan void sqlite3SubselectError(Parse *pParse, int nActual, int nExpect){
2939a9ebfe20Sdrh   if( pParse->nErr==0 ){
29408da209b1Sdan     const char *zFmt = "sub-select returns %d columns - expected %d";
29418da209b1Sdan     sqlite3ErrorMsg(pParse, zFmt, nActual, nExpect);
29428da209b1Sdan   }
2943a9ebfe20Sdrh }
29448da209b1Sdan #endif
29458da209b1Sdan 
2946626a879aSdrh /*
294744c5604cSdan ** Expression pExpr is a vector that has been used in a context where
294844c5604cSdan ** it is not permitted. If pExpr is a sub-select vector, this routine
294944c5604cSdan ** loads the Parse object with a message of the form:
295044c5604cSdan **
295144c5604cSdan **   "sub-select returns N columns - expected 1"
295244c5604cSdan **
295344c5604cSdan ** Or, if it is a regular scalar vector:
295444c5604cSdan **
295544c5604cSdan **   "row value misused"
295644c5604cSdan */
295744c5604cSdan void sqlite3VectorErrorMsg(Parse *pParse, Expr *pExpr){
295844c5604cSdan #ifndef SQLITE_OMIT_SUBQUERY
2959a4eeccdfSdrh   if( ExprUseXSelect(pExpr) ){
296044c5604cSdan     sqlite3SubselectError(pParse, pExpr->x.pSelect->pEList->nExpr, 1);
296144c5604cSdan   }else
296244c5604cSdan #endif
296344c5604cSdan   {
296444c5604cSdan     sqlite3ErrorMsg(pParse, "row value misused");
296544c5604cSdan   }
296644c5604cSdan }
296744c5604cSdan 
296885bcdce2Sdrh #ifndef SQLITE_OMIT_SUBQUERY
296944c5604cSdan /*
297085bcdce2Sdrh ** Generate code that will construct an ephemeral table containing all terms
297185bcdce2Sdrh ** in the RHS of an IN operator.  The IN operator can be in either of two
297285bcdce2Sdrh ** forms:
2973626a879aSdrh **
29749cbe6352Sdrh **     x IN (4,5,11)              -- IN operator with list on right-hand side
29759cbe6352Sdrh **     x IN (SELECT a FROM b)     -- IN operator with subquery on the right
2976fef5208cSdrh **
29772c04131cSdrh ** The pExpr parameter is the IN operator.  The cursor number for the
29782c04131cSdrh ** constructed ephermeral table is returned.  The first time the ephemeral
29792c04131cSdrh ** table is computed, the cursor number is also stored in pExpr->iTable,
29802c04131cSdrh ** however the cursor number returned might not be the same, as it might
29812c04131cSdrh ** have been duplicated using OP_OpenDup.
298241a05b7bSdanielk1977 **
298385bcdce2Sdrh ** If the LHS expression ("x" in the examples) is a column value, or
298485bcdce2Sdrh ** the SELECT statement returns a column value, then the affinity of that
298585bcdce2Sdrh ** column is used to build the index keys. If both 'x' and the
298685bcdce2Sdrh ** SELECT... statement are columns, then numeric affinity is used
298785bcdce2Sdrh ** if either column has NUMERIC or INTEGER affinity. If neither
298885bcdce2Sdrh ** 'x' nor the SELECT... statement are columns, then numeric affinity
298985bcdce2Sdrh ** is used.
2990cce7d176Sdrh */
299185bcdce2Sdrh void sqlite3CodeRhsOfIN(
2992fd773cf9Sdrh   Parse *pParse,          /* Parsing context */
299385bcdce2Sdrh   Expr *pExpr,            /* The IN operator */
299450ef6716Sdrh   int iTab                /* Use this cursor number */
299541a05b7bSdanielk1977 ){
29962c04131cSdrh   int addrOnce = 0;           /* Address of the OP_Once instruction at top */
299785bcdce2Sdrh   int addr;                   /* Address of OP_OpenEphemeral instruction */
299885bcdce2Sdrh   Expr *pLeft;                /* the LHS of the IN operator */
299985bcdce2Sdrh   KeyInfo *pKeyInfo = 0;      /* Key information */
300085bcdce2Sdrh   int nVal;                   /* Size of vector pLeft */
300185bcdce2Sdrh   Vdbe *v;                    /* The prepared statement under construction */
3002fc976065Sdanielk1977 
30032c04131cSdrh   v = pParse->pVdbe;
300485bcdce2Sdrh   assert( v!=0 );
300585bcdce2Sdrh 
30062c04131cSdrh   /* The evaluation of the IN must be repeated every time it
300739a11819Sdrh   ** is encountered if any of the following is true:
300857dbd7b3Sdrh   **
300957dbd7b3Sdrh   **    *  The right-hand side is a correlated subquery
301057dbd7b3Sdrh   **    *  The right-hand side is an expression list containing variables
301157dbd7b3Sdrh   **    *  We are inside a trigger
301257dbd7b3Sdrh   **
30132c04131cSdrh   ** If all of the above are false, then we can compute the RHS just once
30142c04131cSdrh   ** and reuse it many names.
3015b3bce662Sdanielk1977   */
3016efb699fcSdrh   if( !ExprHasProperty(pExpr, EP_VarSelect) && pParse->iSelfTab==0 ){
30172c04131cSdrh     /* Reuse of the RHS is allowed */
30182c04131cSdrh     /* If this routine has already been coded, but the previous code
30192c04131cSdrh     ** might not have been invoked yet, so invoke it now as a subroutine.
30202c04131cSdrh     */
30212c04131cSdrh     if( ExprHasProperty(pExpr, EP_Subrtn) ){
3022f9231c34Sdrh       addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
3023a4eeccdfSdrh       if( ExprUseXSelect(pExpr) ){
3024bd462bccSdrh         ExplainQueryPlan((pParse, 0, "REUSE LIST SUBQUERY %d",
3025bd462bccSdrh               pExpr->x.pSelect->selId));
3026bd462bccSdrh       }
3027477572b9Sdrh       assert( ExprUseYSub(pExpr) );
30282c04131cSdrh       sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
30292c04131cSdrh                         pExpr->y.sub.iAddr);
30302c04131cSdrh       sqlite3VdbeAddOp2(v, OP_OpenDup, iTab, pExpr->iTable);
3031f9231c34Sdrh       sqlite3VdbeJumpHere(v, addrOnce);
30322c04131cSdrh       return;
30332c04131cSdrh     }
30342c04131cSdrh 
30352c04131cSdrh     /* Begin coding the subroutine */
3036477572b9Sdrh     assert( !ExprUseYWin(pExpr) );
30372c04131cSdrh     ExprSetProperty(pExpr, EP_Subrtn);
3038088489e8Sdrh     assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
30392c04131cSdrh     pExpr->y.sub.regReturn = ++pParse->nMem;
30402c04131cSdrh     pExpr->y.sub.iAddr =
30412c04131cSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 0, pExpr->y.sub.regReturn) + 1;
30422c04131cSdrh     VdbeComment((v, "return address"));
30432c04131cSdrh 
30442c04131cSdrh     addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
3045b3bce662Sdanielk1977   }
3046b3bce662Sdanielk1977 
304785bcdce2Sdrh   /* Check to see if this is a vector IN operator */
304885bcdce2Sdrh   pLeft = pExpr->pLeft;
304971c57db0Sdan   nVal = sqlite3ExprVectorSize(pLeft);
3050e014a838Sdanielk1977 
305185bcdce2Sdrh   /* Construct the ephemeral table that will contain the content of
305285bcdce2Sdrh   ** RHS of the IN operator.
3053fef5208cSdrh   */
30542c04131cSdrh   pExpr->iTable = iTab;
305550ef6716Sdrh   addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, pExpr->iTable, nVal);
30562c04131cSdrh #ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
3057a4eeccdfSdrh   if( ExprUseXSelect(pExpr) ){
30582c04131cSdrh     VdbeComment((v, "Result of SELECT %u", pExpr->x.pSelect->selId));
30592c04131cSdrh   }else{
30602c04131cSdrh     VdbeComment((v, "RHS of IN operator"));
30612c04131cSdrh   }
30622c04131cSdrh #endif
306350ef6716Sdrh   pKeyInfo = sqlite3KeyInfoAlloc(pParse->db, nVal, 1);
3064e014a838Sdanielk1977 
3065a4eeccdfSdrh   if( ExprUseXSelect(pExpr) ){
3066e014a838Sdanielk1977     /* Case 1:     expr IN (SELECT ...)
3067e014a838Sdanielk1977     **
3068e014a838Sdanielk1977     ** Generate code to write the results of the select into the temporary
3069e014a838Sdanielk1977     ** table allocated and opened above.
3070e014a838Sdanielk1977     */
30714387006cSdrh     Select *pSelect = pExpr->x.pSelect;
307271c57db0Sdan     ExprList *pEList = pSelect->pEList;
30731013c932Sdrh 
30742c04131cSdrh     ExplainQueryPlan((pParse, 1, "%sLIST SUBQUERY %d",
30752c04131cSdrh         addrOnce?"":"CORRELATED ", pSelect->selId
3076e2ca99c9Sdrh     ));
307764bcb8cfSdrh     /* If the LHS and RHS of the IN operator do not match, that
307864bcb8cfSdrh     ** error will have been caught long before we reach this point. */
307964bcb8cfSdrh     if( ALWAYS(pEList->nExpr==nVal) ){
308014c4d428Sdrh       Select *pCopy;
308171c57db0Sdan       SelectDest dest;
308271c57db0Sdan       int i;
308314c4d428Sdrh       int rc;
3084bd462bccSdrh       sqlite3SelectDestInit(&dest, SRT_Set, iTab);
308571c57db0Sdan       dest.zAffSdst = exprINAffinity(pParse, pExpr);
30864387006cSdrh       pSelect->iLimit = 0;
30874387006cSdrh       testcase( pSelect->selFlags & SF_Distinct );
3088812ea833Sdrh       testcase( pKeyInfo==0 ); /* Caused by OOM in sqlite3KeyInfoAlloc() */
308914c4d428Sdrh       pCopy = sqlite3SelectDup(pParse->db, pSelect, 0);
309014c4d428Sdrh       rc = pParse->db->mallocFailed ? 1 :sqlite3Select(pParse, pCopy, &dest);
309114c4d428Sdrh       sqlite3SelectDelete(pParse->db, pCopy);
309271c57db0Sdan       sqlite3DbFree(pParse->db, dest.zAffSdst);
309314c4d428Sdrh       if( rc ){
30942ec2fb22Sdrh         sqlite3KeyInfoUnref(pKeyInfo);
309585bcdce2Sdrh         return;
309694ccde58Sdrh       }
3097812ea833Sdrh       assert( pKeyInfo!=0 ); /* OOM will cause exit after sqlite3Select() */
30983535ec3eSdrh       assert( pEList!=0 );
30993535ec3eSdrh       assert( pEList->nExpr>0 );
31002ec2fb22Sdrh       assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
310171c57db0Sdan       for(i=0; i<nVal; i++){
3102773d3afaSdan         Expr *p = sqlite3VectorFieldSubexpr(pLeft, i);
310371c57db0Sdan         pKeyInfo->aColl[i] = sqlite3BinaryCompareCollSeq(
310471c57db0Sdan             pParse, p, pEList->a[i].pExpr
310571c57db0Sdan         );
310671c57db0Sdan       }
310771c57db0Sdan     }
3108a7d2db17Sdrh   }else if( ALWAYS(pExpr->x.pList!=0) ){
3109fef5208cSdrh     /* Case 2:     expr IN (exprlist)
3110fef5208cSdrh     **
3111e014a838Sdanielk1977     ** For each expression, build an index key from the evaluation and
3112e014a838Sdanielk1977     ** store it in the temporary table. If <expr> is a column, then use
3113e014a838Sdanielk1977     ** that columns affinity when building index keys. If <expr> is not
3114e014a838Sdanielk1977     ** a column, use numeric affinity.
3115fef5208cSdrh     */
311671c57db0Sdan     char affinity;            /* Affinity of the LHS of the IN */
3117e014a838Sdanielk1977     int i;
31186ab3a2ecSdanielk1977     ExprList *pList = pExpr->x.pList;
311957dbd7b3Sdrh     struct ExprList_item *pItem;
3120c324d446Sdan     int r1, r2;
312171c57db0Sdan     affinity = sqlite3ExprAffinity(pLeft);
312296fb16eeSdrh     if( affinity<=SQLITE_AFF_NONE ){
312305883a34Sdrh       affinity = SQLITE_AFF_BLOB;
312495b39590Sdrh     }else if( affinity==SQLITE_AFF_REAL ){
312595b39590Sdrh       affinity = SQLITE_AFF_NUMERIC;
3126e014a838Sdanielk1977     }
3127323df790Sdrh     if( pKeyInfo ){
31282ec2fb22Sdrh       assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
3129323df790Sdrh       pKeyInfo->aColl[0] = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
3130323df790Sdrh     }
3131e014a838Sdanielk1977 
3132e014a838Sdanielk1977     /* Loop through each expression in <exprlist>. */
31332d401ab8Sdrh     r1 = sqlite3GetTempReg(pParse);
31342d401ab8Sdrh     r2 = sqlite3GetTempReg(pParse);
313557dbd7b3Sdrh     for(i=pList->nExpr, pItem=pList->a; i>0; i--, pItem++){
313657dbd7b3Sdrh       Expr *pE2 = pItem->pExpr;
3137e014a838Sdanielk1977 
313857dbd7b3Sdrh       /* If the expression is not constant then we will need to
313957dbd7b3Sdrh       ** disable the test that was generated above that makes sure
314057dbd7b3Sdrh       ** this code only executes once.  Because for a non-constant
314157dbd7b3Sdrh       ** expression we need to rerun this code each time.
314257dbd7b3Sdrh       */
31432c04131cSdrh       if( addrOnce && !sqlite3ExprIsConstant(pE2) ){
31442c04131cSdrh         sqlite3VdbeChangeToNoop(v, addrOnce);
31457ac0e562Sdan         ExprClearProperty(pExpr, EP_Subrtn);
31462c04131cSdrh         addrOnce = 0;
31474794b980Sdrh       }
3148e014a838Sdanielk1977 
3149e014a838Sdanielk1977       /* Evaluate the expression and insert it into the temp table */
3150c324d446Sdan       sqlite3ExprCode(pParse, pE2, r1);
3151c324d446Sdan       sqlite3VdbeAddOp4(v, OP_MakeRecord, r1, 1, r2, &affinity, 1);
3152c324d446Sdan       sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iTab, r2, r1, 1);
3153fef5208cSdrh     }
31542d401ab8Sdrh     sqlite3ReleaseTempReg(pParse, r1);
31552d401ab8Sdrh     sqlite3ReleaseTempReg(pParse, r2);
3156fef5208cSdrh   }
3157323df790Sdrh   if( pKeyInfo ){
31582ec2fb22Sdrh     sqlite3VdbeChangeP4(v, addr, (void *)pKeyInfo, P4_KEYINFO);
315941a05b7bSdanielk1977   }
31602c04131cSdrh   if( addrOnce ){
31612c04131cSdrh     sqlite3VdbeJumpHere(v, addrOnce);
31622c04131cSdrh     /* Subroutine return */
3163477572b9Sdrh     assert( ExprUseYSub(pExpr) );
31642c04131cSdrh     sqlite3VdbeAddOp1(v, OP_Return, pExpr->y.sub.regReturn);
31652c04131cSdrh     sqlite3VdbeChangeP1(v, pExpr->y.sub.iAddr-1, sqlite3VdbeCurrentAddr(v)-1);
31666d2566dfSdrh     sqlite3ClearTempRegCache(pParse);
316785bcdce2Sdrh   }
316885bcdce2Sdrh }
316985bcdce2Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
317085bcdce2Sdrh 
317185bcdce2Sdrh /*
317285bcdce2Sdrh ** Generate code for scalar subqueries used as a subquery expression
317385bcdce2Sdrh ** or EXISTS operator:
317485bcdce2Sdrh **
317585bcdce2Sdrh **     (SELECT a FROM b)          -- subquery
317685bcdce2Sdrh **     EXISTS (SELECT a FROM b)   -- EXISTS subquery
317785bcdce2Sdrh **
317885bcdce2Sdrh ** The pExpr parameter is the SELECT or EXISTS operator to be coded.
317985bcdce2Sdrh **
3180d86fe44aSdrh ** Return the register that holds the result.  For a multi-column SELECT,
318185bcdce2Sdrh ** the result is stored in a contiguous array of registers and the
318285bcdce2Sdrh ** return value is the register of the left-most result column.
318385bcdce2Sdrh ** Return 0 if an error occurs.
318485bcdce2Sdrh */
318585bcdce2Sdrh #ifndef SQLITE_OMIT_SUBQUERY
318685bcdce2Sdrh int sqlite3CodeSubselect(Parse *pParse, Expr *pExpr){
31872c04131cSdrh   int addrOnce = 0;           /* Address of OP_Once at top of subroutine */
318885bcdce2Sdrh   int rReg = 0;               /* Register storing resulting */
318985bcdce2Sdrh   Select *pSel;               /* SELECT statement to encode */
319085bcdce2Sdrh   SelectDest dest;            /* How to deal with SELECT result */
319185bcdce2Sdrh   int nReg;                   /* Registers to allocate */
319285bcdce2Sdrh   Expr *pLimit;               /* New limit expression */
31932c04131cSdrh 
31942c04131cSdrh   Vdbe *v = pParse->pVdbe;
319585bcdce2Sdrh   assert( v!=0 );
319605428127Sdrh   if( pParse->nErr ) return 0;
3197bd462bccSdrh   testcase( pExpr->op==TK_EXISTS );
3198bd462bccSdrh   testcase( pExpr->op==TK_SELECT );
3199bd462bccSdrh   assert( pExpr->op==TK_EXISTS || pExpr->op==TK_SELECT );
3200a4eeccdfSdrh   assert( ExprUseXSelect(pExpr) );
3201bd462bccSdrh   pSel = pExpr->x.pSelect;
320285bcdce2Sdrh 
32035198ff57Sdrh   /* If this routine has already been coded, then invoke it as a
32045198ff57Sdrh   ** subroutine. */
32055198ff57Sdrh   if( ExprHasProperty(pExpr, EP_Subrtn) ){
3206bd462bccSdrh     ExplainQueryPlan((pParse, 0, "REUSE SUBQUERY %d", pSel->selId));
3207477572b9Sdrh     assert( ExprUseYSub(pExpr) );
32085198ff57Sdrh     sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
32095198ff57Sdrh                       pExpr->y.sub.iAddr);
32105198ff57Sdrh     return pExpr->iTable;
32115198ff57Sdrh   }
32125198ff57Sdrh 
32135198ff57Sdrh   /* Begin coding the subroutine */
3214477572b9Sdrh   assert( !ExprUseYWin(pExpr) );
3215477572b9Sdrh   assert( !ExprHasProperty(pExpr, EP_Reduced|EP_TokenOnly) );
32165198ff57Sdrh   ExprSetProperty(pExpr, EP_Subrtn);
32175198ff57Sdrh   pExpr->y.sub.regReturn = ++pParse->nMem;
32185198ff57Sdrh   pExpr->y.sub.iAddr =
32195198ff57Sdrh     sqlite3VdbeAddOp2(v, OP_Integer, 0, pExpr->y.sub.regReturn) + 1;
32205198ff57Sdrh   VdbeComment((v, "return address"));
32215198ff57Sdrh 
322214c4d428Sdrh 
322314c4d428Sdrh   /* The evaluation of the EXISTS/SELECT must be repeated every time it
322414c4d428Sdrh   ** is encountered if any of the following is true:
322514c4d428Sdrh   **
322614c4d428Sdrh   **    *  The right-hand side is a correlated subquery
322714c4d428Sdrh   **    *  The right-hand side is an expression list containing variables
322814c4d428Sdrh   **    *  We are inside a trigger
322914c4d428Sdrh   **
323014c4d428Sdrh   ** If all of the above are false, then we can run this code just once
323114c4d428Sdrh   ** save the results, and reuse the same result on subsequent invocations.
323214c4d428Sdrh   */
323314c4d428Sdrh   if( !ExprHasProperty(pExpr, EP_VarSelect) ){
32342c04131cSdrh     addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
3235fef5208cSdrh   }
3236fef5208cSdrh 
323785bcdce2Sdrh   /* For a SELECT, generate code to put the values for all columns of
323839a11819Sdrh   ** the first row into an array of registers and return the index of
323939a11819Sdrh   ** the first register.
324039a11819Sdrh   **
324139a11819Sdrh   ** If this is an EXISTS, write an integer 0 (not exists) or 1 (exists)
324239a11819Sdrh   ** into a register and return that register number.
324339a11819Sdrh   **
324439a11819Sdrh   ** In both cases, the query is augmented with "LIMIT 1".  Any
324539a11819Sdrh   ** preexisting limit is discarded in place of the new LIMIT 1.
3246fef5208cSdrh   */
3247bd462bccSdrh   ExplainQueryPlan((pParse, 1, "%sSCALAR SUBQUERY %d",
3248bd462bccSdrh         addrOnce?"":"CORRELATED ", pSel->selId));
324971c57db0Sdan   nReg = pExpr->op==TK_SELECT ? pSel->pEList->nExpr : 1;
325071c57db0Sdan   sqlite3SelectDestInit(&dest, 0, pParse->nMem+1);
325171c57db0Sdan   pParse->nMem += nReg;
325251522cd3Sdrh   if( pExpr->op==TK_SELECT ){
32536c8c8ce0Sdanielk1977     dest.eDest = SRT_Mem;
325453932ce8Sdrh     dest.iSdst = dest.iSDParm;
325571c57db0Sdan     dest.nSdst = nReg;
325671c57db0Sdan     sqlite3VdbeAddOp3(v, OP_Null, 0, dest.iSDParm, dest.iSDParm+nReg-1);
3257d4e70ebdSdrh     VdbeComment((v, "Init subquery result"));
325851522cd3Sdrh   }else{
32596c8c8ce0Sdanielk1977     dest.eDest = SRT_Exists;
32602b596da8Sdrh     sqlite3VdbeAddOp2(v, OP_Integer, 0, dest.iSDParm);
3261d4e70ebdSdrh     VdbeComment((v, "Init EXISTS result"));
326251522cd3Sdrh   }
32638c0833fbSdrh   if( pSel->pLimit ){
32647ca1347fSdrh     /* The subquery already has a limit.  If the pre-existing limit is X
32657ca1347fSdrh     ** then make the new limit X<>0 so that the new limit is either 1 or 0 */
32667ca1347fSdrh     sqlite3 *db = pParse->db;
32675776ee5cSdrh     pLimit = sqlite3Expr(db, TK_INTEGER, "0");
32687ca1347fSdrh     if( pLimit ){
32697ca1347fSdrh       pLimit->affExpr = SQLITE_AFF_NUMERIC;
32707ca1347fSdrh       pLimit = sqlite3PExpr(pParse, TK_NE,
32717ca1347fSdrh                             sqlite3ExprDup(db, pSel->pLimit->pLeft, 0), pLimit);
32727ca1347fSdrh     }
32737ca1347fSdrh     sqlite3ExprDelete(db, pSel->pLimit->pLeft);
32748c0833fbSdrh     pSel->pLimit->pLeft = pLimit;
32758c0833fbSdrh   }else{
32767ca1347fSdrh     /* If there is no pre-existing limit add a limit of 1 */
32775776ee5cSdrh     pLimit = sqlite3Expr(pParse->db, TK_INTEGER, "1");
32788c0833fbSdrh     pSel->pLimit = sqlite3PExpr(pParse, TK_LIMIT, pLimit, 0);
32798c0833fbSdrh   }
328048b5b041Sdrh   pSel->iLimit = 0;
32817d10d5a6Sdrh   if( sqlite3Select(pParse, pSel, &dest) ){
3282bf7f3a00Sdrh     if( pParse->nErr ){
3283bf7f3a00Sdrh       pExpr->op2 = pExpr->op;
3284bf7f3a00Sdrh       pExpr->op = TK_ERROR;
3285bf7f3a00Sdrh     }
32861450bc6eSdrh     return 0;
328794ccde58Sdrh   }
32882c04131cSdrh   pExpr->iTable = rReg = dest.iSDParm;
3289ebb6a65dSdrh   ExprSetVVAProperty(pExpr, EP_NoReduce);
32902c04131cSdrh   if( addrOnce ){
32912c04131cSdrh     sqlite3VdbeJumpHere(v, addrOnce);
329214c4d428Sdrh   }
3293fc976065Sdanielk1977 
32942c04131cSdrh   /* Subroutine return */
3295477572b9Sdrh   assert( ExprUseYSub(pExpr) );
32962c04131cSdrh   sqlite3VdbeAddOp1(v, OP_Return, pExpr->y.sub.regReturn);
32972c04131cSdrh   sqlite3VdbeChangeP1(v, pExpr->y.sub.iAddr-1, sqlite3VdbeCurrentAddr(v)-1);
32986d2566dfSdrh   sqlite3ClearTempRegCache(pParse);
32991450bc6eSdrh   return rReg;
3300cce7d176Sdrh }
330151522cd3Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
3302cce7d176Sdrh 
3303e3365e6cSdrh #ifndef SQLITE_OMIT_SUBQUERY
3304e3365e6cSdrh /*
33057b35a77bSdan ** Expr pIn is an IN(...) expression. This function checks that the
33067b35a77bSdan ** sub-select on the RHS of the IN() operator has the same number of
33077b35a77bSdan ** columns as the vector on the LHS. Or, if the RHS of the IN() is not
33087b35a77bSdan ** a sub-query, that the LHS is a vector of size 1.
33097b35a77bSdan */
33107b35a77bSdan int sqlite3ExprCheckIN(Parse *pParse, Expr *pIn){
33117b35a77bSdan   int nVector = sqlite3ExprVectorSize(pIn->pLeft);
3312a4eeccdfSdrh   if( ExprUseXSelect(pIn) && !pParse->db->mallocFailed ){
33137b35a77bSdan     if( nVector!=pIn->x.pSelect->pEList->nExpr ){
33147b35a77bSdan       sqlite3SubselectError(pParse, pIn->x.pSelect->pEList->nExpr, nVector);
33157b35a77bSdan       return 1;
33167b35a77bSdan     }
33177b35a77bSdan   }else if( nVector!=1 ){
331844c5604cSdan     sqlite3VectorErrorMsg(pParse, pIn->pLeft);
33197b35a77bSdan     return 1;
33207b35a77bSdan   }
33217b35a77bSdan   return 0;
33227b35a77bSdan }
33237b35a77bSdan #endif
33247b35a77bSdan 
33257b35a77bSdan #ifndef SQLITE_OMIT_SUBQUERY
33267b35a77bSdan /*
3327e3365e6cSdrh ** Generate code for an IN expression.
3328e3365e6cSdrh **
3329e3365e6cSdrh **      x IN (SELECT ...)
3330e3365e6cSdrh **      x IN (value, value, ...)
3331e3365e6cSdrh **
3332ecb87ac8Sdrh ** The left-hand side (LHS) is a scalar or vector expression.  The
3333e347d3e8Sdrh ** right-hand side (RHS) is an array of zero or more scalar values, or a
3334e347d3e8Sdrh ** subquery.  If the RHS is a subquery, the number of result columns must
3335e347d3e8Sdrh ** match the number of columns in the vector on the LHS.  If the RHS is
3336e347d3e8Sdrh ** a list of values, the LHS must be a scalar.
3337e347d3e8Sdrh **
3338e347d3e8Sdrh ** The IN operator is true if the LHS value is contained within the RHS.
3339e347d3e8Sdrh ** The result is false if the LHS is definitely not in the RHS.  The
3340e347d3e8Sdrh ** result is NULL if the presence of the LHS in the RHS cannot be
3341e347d3e8Sdrh ** determined due to NULLs.
3342e3365e6cSdrh **
33436be515ebSdrh ** This routine generates code that jumps to destIfFalse if the LHS is not
3344e3365e6cSdrh ** contained within the RHS.  If due to NULLs we cannot determine if the LHS
3345e3365e6cSdrh ** is contained in the RHS then jump to destIfNull.  If the LHS is contained
3346e3365e6cSdrh ** within the RHS then fall through.
3347ecb87ac8Sdrh **
3348ecb87ac8Sdrh ** See the separate in-operator.md documentation file in the canonical
3349ecb87ac8Sdrh ** SQLite source tree for additional information.
3350e3365e6cSdrh */
3351e3365e6cSdrh static void sqlite3ExprCodeIN(
3352e3365e6cSdrh   Parse *pParse,        /* Parsing and code generating context */
3353e3365e6cSdrh   Expr *pExpr,          /* The IN expression */
3354e3365e6cSdrh   int destIfFalse,      /* Jump here if LHS is not contained in the RHS */
3355e3365e6cSdrh   int destIfNull        /* Jump here if the results are unknown due to NULLs */
3356e3365e6cSdrh ){
3357e3365e6cSdrh   int rRhsHasNull = 0;  /* Register that is true if RHS contains NULL values */
3358e3365e6cSdrh   int eType;            /* Type of the RHS */
3359e347d3e8Sdrh   int rLhs;             /* Register(s) holding the LHS values */
3360e347d3e8Sdrh   int rLhsOrig;         /* LHS values prior to reordering by aiMap[] */
3361e3365e6cSdrh   Vdbe *v;              /* Statement under construction */
3362ba00e30aSdan   int *aiMap = 0;       /* Map from vector field to index column */
3363ba00e30aSdan   char *zAff = 0;       /* Affinity string for comparisons */
3364ecb87ac8Sdrh   int nVector;          /* Size of vectors for this IN operator */
336512abf408Sdrh   int iDummy;           /* Dummy parameter to exprCodeVector() */
3366e347d3e8Sdrh   Expr *pLeft;          /* The LHS of the IN operator */
3367ecb87ac8Sdrh   int i;                /* loop counter */
3368e347d3e8Sdrh   int destStep2;        /* Where to jump when NULLs seen in step 2 */
3369e347d3e8Sdrh   int destStep6 = 0;    /* Start of code for Step 6 */
3370e347d3e8Sdrh   int addrTruthOp;      /* Address of opcode that determines the IN is true */
3371e347d3e8Sdrh   int destNotNull;      /* Jump here if a comparison is not true in step 6 */
3372e347d3e8Sdrh   int addrTop;          /* Top of the step-6 loop */
33732c04131cSdrh   int iTab = 0;         /* Index to use */
3374c59b4acfSdan   u8 okConstFactor = pParse->okConstFactor;
3375e3365e6cSdrh 
3376e7375bfaSdrh   assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
3377e347d3e8Sdrh   pLeft = pExpr->pLeft;
33787b35a77bSdan   if( sqlite3ExprCheckIN(pParse, pExpr) ) return;
3379553168c7Sdan   zAff = exprINAffinity(pParse, pExpr);
3380ba00e30aSdan   nVector = sqlite3ExprVectorSize(pExpr->pLeft);
3381ba00e30aSdan   aiMap = (int*)sqlite3DbMallocZero(
3382ba00e30aSdan       pParse->db, nVector*(sizeof(int) + sizeof(char)) + 1
3383ba00e30aSdan   );
3384e347d3e8Sdrh   if( pParse->db->mallocFailed ) goto sqlite3ExprCodeIN_oom_error;
33857b35a77bSdan 
3386ba00e30aSdan   /* Attempt to compute the RHS. After this step, if anything other than
33872c04131cSdrh   ** IN_INDEX_NOOP is returned, the table opened with cursor iTab
3388ba00e30aSdan   ** contains the values that make up the RHS. If IN_INDEX_NOOP is returned,
3389ba00e30aSdan   ** the RHS has not yet been coded.  */
3390e3365e6cSdrh   v = pParse->pVdbe;
3391e3365e6cSdrh   assert( v!=0 );       /* OOM detected prior to this routine */
3392e3365e6cSdrh   VdbeNoopComment((v, "begin IN expr"));
3393bb53ecb1Sdrh   eType = sqlite3FindInIndex(pParse, pExpr,
3394bb53ecb1Sdrh                              IN_INDEX_MEMBERSHIP | IN_INDEX_NOOP_OK,
33952c04131cSdrh                              destIfFalse==destIfNull ? 0 : &rRhsHasNull,
33962c04131cSdrh                              aiMap, &iTab);
3397e3365e6cSdrh 
3398ba00e30aSdan   assert( pParse->nErr || nVector==1 || eType==IN_INDEX_EPH
3399ba00e30aSdan        || eType==IN_INDEX_INDEX_ASC || eType==IN_INDEX_INDEX_DESC
3400ba00e30aSdan   );
3401ecb87ac8Sdrh #ifdef SQLITE_DEBUG
3402ecb87ac8Sdrh   /* Confirm that aiMap[] contains nVector integer values between 0 and
3403ecb87ac8Sdrh   ** nVector-1. */
3404ecb87ac8Sdrh   for(i=0; i<nVector; i++){
3405ecb87ac8Sdrh     int j, cnt;
3406ecb87ac8Sdrh     for(cnt=j=0; j<nVector; j++) if( aiMap[j]==i ) cnt++;
3407ecb87ac8Sdrh     assert( cnt==1 );
3408ecb87ac8Sdrh   }
3409ecb87ac8Sdrh #endif
3410e3365e6cSdrh 
3411ba00e30aSdan   /* Code the LHS, the <expr> from "<expr> IN (...)". If the LHS is a
3412ba00e30aSdan   ** vector, then it is stored in an array of nVector registers starting
3413ba00e30aSdan   ** at r1.
3414e347d3e8Sdrh   **
3415e347d3e8Sdrh   ** sqlite3FindInIndex() might have reordered the fields of the LHS vector
3416e347d3e8Sdrh   ** so that the fields are in the same order as an existing index.   The
3417e347d3e8Sdrh   ** aiMap[] array contains a mapping from the original LHS field order to
3418e347d3e8Sdrh   ** the field order that matches the RHS index.
3419c59b4acfSdan   **
3420c59b4acfSdan   ** Avoid factoring the LHS of the IN(...) expression out of the loop,
3421c59b4acfSdan   ** even if it is constant, as OP_Affinity may be used on the register
3422c59b4acfSdan   ** by code generated below.  */
3423c59b4acfSdan   assert( pParse->okConstFactor==okConstFactor );
3424c59b4acfSdan   pParse->okConstFactor = 0;
3425e347d3e8Sdrh   rLhsOrig = exprCodeVector(pParse, pLeft, &iDummy);
3426c59b4acfSdan   pParse->okConstFactor = okConstFactor;
3427e347d3e8Sdrh   for(i=0; i<nVector && aiMap[i]==i; i++){} /* Are LHS fields reordered? */
3428ecb87ac8Sdrh   if( i==nVector ){
3429e347d3e8Sdrh     /* LHS fields are not reordered */
3430e347d3e8Sdrh     rLhs = rLhsOrig;
3431ecb87ac8Sdrh   }else{
3432ecb87ac8Sdrh     /* Need to reorder the LHS fields according to aiMap */
3433e347d3e8Sdrh     rLhs = sqlite3GetTempRange(pParse, nVector);
3434ba00e30aSdan     for(i=0; i<nVector; i++){
3435e347d3e8Sdrh       sqlite3VdbeAddOp3(v, OP_Copy, rLhsOrig+i, rLhs+aiMap[i], 0);
3436ba00e30aSdan     }
3437ecb87ac8Sdrh   }
3438e3365e6cSdrh 
3439bb53ecb1Sdrh   /* If sqlite3FindInIndex() did not find or create an index that is
3440bb53ecb1Sdrh   ** suitable for evaluating the IN operator, then evaluate using a
3441bb53ecb1Sdrh   ** sequence of comparisons.
3442e347d3e8Sdrh   **
3443e347d3e8Sdrh   ** This is step (1) in the in-operator.md optimized algorithm.
3444bb53ecb1Sdrh   */
3445bb53ecb1Sdrh   if( eType==IN_INDEX_NOOP ){
3446a4eeccdfSdrh     ExprList *pList;
3447a4eeccdfSdrh     CollSeq *pColl;
3448ec4ccdbcSdrh     int labelOk = sqlite3VdbeMakeLabel(pParse);
3449bb53ecb1Sdrh     int r2, regToFree;
3450bb53ecb1Sdrh     int regCkNull = 0;
3451bb53ecb1Sdrh     int ii;
3452a4eeccdfSdrh     assert( ExprUseXList(pExpr) );
3453a4eeccdfSdrh     pList = pExpr->x.pList;
3454a4eeccdfSdrh     pColl = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
3455bb53ecb1Sdrh     if( destIfNull!=destIfFalse ){
3456bb53ecb1Sdrh       regCkNull = sqlite3GetTempReg(pParse);
3457e347d3e8Sdrh       sqlite3VdbeAddOp3(v, OP_BitAnd, rLhs, rLhs, regCkNull);
3458bb53ecb1Sdrh     }
3459bb53ecb1Sdrh     for(ii=0; ii<pList->nExpr; ii++){
34604fc83654Sdrh       r2 = sqlite3ExprCodeTemp(pParse, pList->a[ii].pExpr, &regToFree);
3461a976979bSdrh       if( regCkNull && sqlite3ExprCanBeNull(pList->a[ii].pExpr) ){
3462bb53ecb1Sdrh         sqlite3VdbeAddOp3(v, OP_BitAnd, regCkNull, r2, regCkNull);
3463bb53ecb1Sdrh       }
3464f6ea97eaSdrh       sqlite3ReleaseTempReg(pParse, regToFree);
3465bb53ecb1Sdrh       if( ii<pList->nExpr-1 || destIfNull!=destIfFalse ){
34664799488eSdrh         int op = rLhs!=r2 ? OP_Eq : OP_NotNull;
34674799488eSdrh         sqlite3VdbeAddOp4(v, op, rLhs, labelOk, r2,
34684336b0e6Sdrh                           (void*)pColl, P4_COLLSEQ);
34694799488eSdrh         VdbeCoverageIf(v, ii<pList->nExpr-1 && op==OP_Eq);
34704799488eSdrh         VdbeCoverageIf(v, ii==pList->nExpr-1 && op==OP_Eq);
34714799488eSdrh         VdbeCoverageIf(v, ii<pList->nExpr-1 && op==OP_NotNull);
34724799488eSdrh         VdbeCoverageIf(v, ii==pList->nExpr-1 && op==OP_NotNull);
3473ba00e30aSdan         sqlite3VdbeChangeP5(v, zAff[0]);
3474bb53ecb1Sdrh       }else{
34754799488eSdrh         int op = rLhs!=r2 ? OP_Ne : OP_IsNull;
3476bb53ecb1Sdrh         assert( destIfNull==destIfFalse );
34774799488eSdrh         sqlite3VdbeAddOp4(v, op, rLhs, destIfFalse, r2,
34784799488eSdrh                           (void*)pColl, P4_COLLSEQ);
34794799488eSdrh         VdbeCoverageIf(v, op==OP_Ne);
34804799488eSdrh         VdbeCoverageIf(v, op==OP_IsNull);
3481ba00e30aSdan         sqlite3VdbeChangeP5(v, zAff[0] | SQLITE_JUMPIFNULL);
3482bb53ecb1Sdrh       }
3483bb53ecb1Sdrh     }
3484bb53ecb1Sdrh     if( regCkNull ){
3485bb53ecb1Sdrh       sqlite3VdbeAddOp2(v, OP_IsNull, regCkNull, destIfNull); VdbeCoverage(v);
3486076e85f5Sdrh       sqlite3VdbeGoto(v, destIfFalse);
3487bb53ecb1Sdrh     }
3488bb53ecb1Sdrh     sqlite3VdbeResolveLabel(v, labelOk);
3489bb53ecb1Sdrh     sqlite3ReleaseTempReg(pParse, regCkNull);
3490e347d3e8Sdrh     goto sqlite3ExprCodeIN_finished;
3491e347d3e8Sdrh   }
3492bb53ecb1Sdrh 
3493e347d3e8Sdrh   /* Step 2: Check to see if the LHS contains any NULL columns.  If the
3494e347d3e8Sdrh   ** LHS does contain NULLs then the result must be either FALSE or NULL.
3495e347d3e8Sdrh   ** We will then skip the binary search of the RHS.
3496e347d3e8Sdrh   */
3497094430ebSdrh   if( destIfNull==destIfFalse ){
3498e347d3e8Sdrh     destStep2 = destIfFalse;
3499e347d3e8Sdrh   }else{
3500ec4ccdbcSdrh     destStep2 = destStep6 = sqlite3VdbeMakeLabel(pParse);
3501e347d3e8Sdrh   }
35024eac5f04Sdrh   if( pParse->nErr ) goto sqlite3ExprCodeIN_finished;
3503d49fd4e8Sdan   for(i=0; i<nVector; i++){
3504fc7f27b9Sdrh     Expr *p = sqlite3VectorFieldSubexpr(pExpr->pLeft, i);
35054c4a2572Sdrh     if( pParse->db->mallocFailed ) goto sqlite3ExprCodeIN_oom_error;
3506d49fd4e8Sdan     if( sqlite3ExprCanBeNull(p) ){
3507e347d3e8Sdrh       sqlite3VdbeAddOp2(v, OP_IsNull, rLhs+i, destStep2);
3508471b4b92Sdrh       VdbeCoverage(v);
3509d49fd4e8Sdan     }
3510d49fd4e8Sdan   }
3511e3365e6cSdrh 
3512e347d3e8Sdrh   /* Step 3.  The LHS is now known to be non-NULL.  Do the binary search
3513e347d3e8Sdrh   ** of the RHS using the LHS as a probe.  If found, the result is
3514e347d3e8Sdrh   ** true.
3515e347d3e8Sdrh   */
3516e3365e6cSdrh   if( eType==IN_INDEX_ROWID ){
3517e347d3e8Sdrh     /* In this case, the RHS is the ROWID of table b-tree and so we also
3518e347d3e8Sdrh     ** know that the RHS is non-NULL.  Hence, we combine steps 3 and 4
3519e347d3e8Sdrh     ** into a single opcode. */
35202c04131cSdrh     sqlite3VdbeAddOp3(v, OP_SeekRowid, iTab, destIfFalse, rLhs);
3521688852abSdrh     VdbeCoverage(v);
3522e347d3e8Sdrh     addrTruthOp = sqlite3VdbeAddOp0(v, OP_Goto);  /* Return True */
35237b35a77bSdan   }else{
3524e347d3e8Sdrh     sqlite3VdbeAddOp4(v, OP_Affinity, rLhs, nVector, 0, zAff, nVector);
3525e347d3e8Sdrh     if( destIfFalse==destIfNull ){
3526e347d3e8Sdrh       /* Combine Step 3 and Step 5 into a single opcode */
35272c04131cSdrh       sqlite3VdbeAddOp4Int(v, OP_NotFound, iTab, destIfFalse,
3528e347d3e8Sdrh                            rLhs, nVector); VdbeCoverage(v);
3529e347d3e8Sdrh       goto sqlite3ExprCodeIN_finished;
3530e347d3e8Sdrh     }
3531e347d3e8Sdrh     /* Ordinary Step 3, for the case where FALSE and NULL are distinct */
35322c04131cSdrh     addrTruthOp = sqlite3VdbeAddOp4Int(v, OP_Found, iTab, 0,
3533e347d3e8Sdrh                                       rLhs, nVector); VdbeCoverage(v);
3534e347d3e8Sdrh   }
3535ba00e30aSdan 
3536e347d3e8Sdrh   /* Step 4.  If the RHS is known to be non-NULL and we did not find
3537e347d3e8Sdrh   ** an match on the search above, then the result must be FALSE.
3538e347d3e8Sdrh   */
3539e347d3e8Sdrh   if( rRhsHasNull && nVector==1 ){
3540e347d3e8Sdrh     sqlite3VdbeAddOp2(v, OP_NotNull, rRhsHasNull, destIfFalse);
3541471b4b92Sdrh     VdbeCoverage(v);
3542e347d3e8Sdrh   }
35437b35a77bSdan 
3544e347d3e8Sdrh   /* Step 5.  If we do not care about the difference between NULL and
3545e347d3e8Sdrh   ** FALSE, then just return false.
3546e347d3e8Sdrh   */
3547e347d3e8Sdrh   if( destIfFalse==destIfNull ) sqlite3VdbeGoto(v, destIfFalse);
3548e347d3e8Sdrh 
3549e347d3e8Sdrh   /* Step 6: Loop through rows of the RHS.  Compare each row to the LHS.
3550e347d3e8Sdrh   ** If any comparison is NULL, then the result is NULL.  If all
3551e347d3e8Sdrh   ** comparisons are FALSE then the final result is FALSE.
3552e347d3e8Sdrh   **
3553e347d3e8Sdrh   ** For a scalar LHS, it is sufficient to check just the first row
3554e347d3e8Sdrh   ** of the RHS.
3555e347d3e8Sdrh   */
3556e347d3e8Sdrh   if( destStep6 ) sqlite3VdbeResolveLabel(v, destStep6);
35572c04131cSdrh   addrTop = sqlite3VdbeAddOp2(v, OP_Rewind, iTab, destIfFalse);
3558471b4b92Sdrh   VdbeCoverage(v);
3559e347d3e8Sdrh   if( nVector>1 ){
3560ec4ccdbcSdrh     destNotNull = sqlite3VdbeMakeLabel(pParse);
3561e347d3e8Sdrh   }else{
3562e347d3e8Sdrh     /* For nVector==1, combine steps 6 and 7 by immediately returning
3563e347d3e8Sdrh     ** FALSE if the first comparison is not NULL */
3564e347d3e8Sdrh     destNotNull = destIfFalse;
3565e347d3e8Sdrh   }
3566ba00e30aSdan   for(i=0; i<nVector; i++){
3567ba00e30aSdan     Expr *p;
3568ba00e30aSdan     CollSeq *pColl;
3569e347d3e8Sdrh     int r3 = sqlite3GetTempReg(pParse);
3570fc7f27b9Sdrh     p = sqlite3VectorFieldSubexpr(pLeft, i);
3571ba00e30aSdan     pColl = sqlite3ExprCollSeq(pParse, p);
35722c04131cSdrh     sqlite3VdbeAddOp3(v, OP_Column, iTab, i, r3);
3573e347d3e8Sdrh     sqlite3VdbeAddOp4(v, OP_Ne, rLhs+i, destNotNull, r3,
357418016ad2Sdrh                       (void*)pColl, P4_COLLSEQ);
3575471b4b92Sdrh     VdbeCoverage(v);
3576e347d3e8Sdrh     sqlite3ReleaseTempReg(pParse, r3);
35777b35a77bSdan   }
35787b35a77bSdan   sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfNull);
3579e347d3e8Sdrh   if( nVector>1 ){
3580e347d3e8Sdrh     sqlite3VdbeResolveLabel(v, destNotNull);
35812c04131cSdrh     sqlite3VdbeAddOp2(v, OP_Next, iTab, addrTop+1);
358218016ad2Sdrh     VdbeCoverage(v);
3583e347d3e8Sdrh 
3584e347d3e8Sdrh     /* Step 7:  If we reach this point, we know that the result must
3585e347d3e8Sdrh     ** be false. */
358618016ad2Sdrh     sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfFalse);
35877b35a77bSdan   }
35887b35a77bSdan 
3589e347d3e8Sdrh   /* Jumps here in order to return true. */
3590e347d3e8Sdrh   sqlite3VdbeJumpHere(v, addrTruthOp);
3591e3365e6cSdrh 
3592e347d3e8Sdrh sqlite3ExprCodeIN_finished:
3593e347d3e8Sdrh   if( rLhs!=rLhsOrig ) sqlite3ReleaseTempReg(pParse, rLhs);
3594ecb87ac8Sdrh   VdbeComment((v, "end IN expr"));
3595e347d3e8Sdrh sqlite3ExprCodeIN_oom_error:
3596ba00e30aSdan   sqlite3DbFree(pParse->db, aiMap);
3597553168c7Sdan   sqlite3DbFree(pParse->db, zAff);
3598e3365e6cSdrh }
3599e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
3600e3365e6cSdrh 
360113573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
3602598f1340Sdrh /*
3603598f1340Sdrh ** Generate an instruction that will put the floating point
36049cbf3425Sdrh ** value described by z[0..n-1] into register iMem.
36050cf19ed8Sdrh **
36060cf19ed8Sdrh ** The z[] string will probably not be zero-terminated.  But the
36070cf19ed8Sdrh ** z[n] character is guaranteed to be something that does not look
36080cf19ed8Sdrh ** like the continuation of the number.
3609598f1340Sdrh */
3610b7916a78Sdrh static void codeReal(Vdbe *v, const char *z, int negateFlag, int iMem){
3611fd773cf9Sdrh   if( ALWAYS(z!=0) ){
3612598f1340Sdrh     double value;
36139339da1fSdrh     sqlite3AtoF(z, &value, sqlite3Strlen30(z), SQLITE_UTF8);
3614d0015161Sdrh     assert( !sqlite3IsNaN(value) ); /* The new AtoF never returns NaN */
3615598f1340Sdrh     if( negateFlag ) value = -value;
361697bae794Sdrh     sqlite3VdbeAddOp4Dup8(v, OP_Real, 0, iMem, 0, (u8*)&value, P4_REAL);
3617598f1340Sdrh   }
3618598f1340Sdrh }
361913573c71Sdrh #endif
3620598f1340Sdrh 
3621598f1340Sdrh 
3622598f1340Sdrh /*
3623fec19aadSdrh ** Generate an instruction that will put the integer describe by
36249cbf3425Sdrh ** text z[0..n-1] into register iMem.
36250cf19ed8Sdrh **
36265f1d6b61Sshaneh ** Expr.u.zToken is always UTF8 and zero-terminated.
3627fec19aadSdrh */
362813573c71Sdrh static void codeInteger(Parse *pParse, Expr *pExpr, int negFlag, int iMem){
362913573c71Sdrh   Vdbe *v = pParse->pVdbe;
363092b01d53Sdrh   if( pExpr->flags & EP_IntValue ){
363133e619fcSdrh     int i = pExpr->u.iValue;
3632d50ffc41Sdrh     assert( i>=0 );
363392b01d53Sdrh     if( negFlag ) i = -i;
363492b01d53Sdrh     sqlite3VdbeAddOp2(v, OP_Integer, i, iMem);
3635fd773cf9Sdrh   }else{
36365f1d6b61Sshaneh     int c;
36375f1d6b61Sshaneh     i64 value;
3638fd773cf9Sdrh     const char *z = pExpr->u.zToken;
3639fd773cf9Sdrh     assert( z!=0 );
36409296c18aSdrh     c = sqlite3DecOrHexToI64(z, &value);
364184d4f1a3Sdrh     if( (c==3 && !negFlag) || (c==2) || (negFlag && value==SMALLEST_INT64)){
364213573c71Sdrh #ifdef SQLITE_OMIT_FLOATING_POINT
364313573c71Sdrh       sqlite3ErrorMsg(pParse, "oversized integer: %s%s", negFlag ? "-" : "", z);
364413573c71Sdrh #else
36451b7ddc59Sdrh #ifndef SQLITE_OMIT_HEX_INTEGER
36469296c18aSdrh       if( sqlite3_strnicmp(z,"0x",2)==0 ){
364777320ea4Sdrh         sqlite3ErrorMsg(pParse, "hex literal too big: %s%s", negFlag?"-":"",z);
36481b7ddc59Sdrh       }else
36491b7ddc59Sdrh #endif
36501b7ddc59Sdrh       {
3651b7916a78Sdrh         codeReal(v, z, negFlag, iMem);
36529296c18aSdrh       }
365313573c71Sdrh #endif
365477320ea4Sdrh     }else{
365584d4f1a3Sdrh       if( negFlag ){ value = c==3 ? SMALLEST_INT64 : -value; }
365677320ea4Sdrh       sqlite3VdbeAddOp4Dup8(v, OP_Int64, 0, iMem, 0, (u8*)&value, P4_INT64);
3657fec19aadSdrh     }
3658fec19aadSdrh   }
3659c9cf901dSdanielk1977 }
3660fec19aadSdrh 
36615cd79239Sdrh 
36621f9ca2c8Sdrh /* Generate code that will load into register regOut a value that is
36631f9ca2c8Sdrh ** appropriate for the iIdxCol-th column of index pIdx.
36641f9ca2c8Sdrh */
36651f9ca2c8Sdrh void sqlite3ExprCodeLoadIndexColumn(
36661f9ca2c8Sdrh   Parse *pParse,  /* The parsing context */
36671f9ca2c8Sdrh   Index *pIdx,    /* The index whose column is to be loaded */
36681f9ca2c8Sdrh   int iTabCur,    /* Cursor pointing to a table row */
36691f9ca2c8Sdrh   int iIdxCol,    /* The column of the index to be loaded */
36701f9ca2c8Sdrh   int regOut      /* Store the index column value in this register */
36711f9ca2c8Sdrh ){
36721f9ca2c8Sdrh   i16 iTabCol = pIdx->aiColumn[iIdxCol];
36734b92f98cSdrh   if( iTabCol==XN_EXPR ){
36741f9ca2c8Sdrh     assert( pIdx->aColExpr );
36751f9ca2c8Sdrh     assert( pIdx->aColExpr->nExpr>iIdxCol );
36763e34eabcSdrh     pParse->iSelfTab = iTabCur + 1;
36771c75c9d7Sdrh     sqlite3ExprCodeCopy(pParse, pIdx->aColExpr->a[iIdxCol].pExpr, regOut);
36783e34eabcSdrh     pParse->iSelfTab = 0;
36794b92f98cSdrh   }else{
36806df9c4b9Sdrh     sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pIdx->pTable, iTabCur,
36814b92f98cSdrh                                     iTabCol, regOut);
36824b92f98cSdrh   }
36831f9ca2c8Sdrh }
36841f9ca2c8Sdrh 
3685e70fa7feSdrh #ifndef SQLITE_OMIT_GENERATED_COLUMNS
3686e70fa7feSdrh /*
3687e70fa7feSdrh ** Generate code that will compute the value of generated column pCol
3688e70fa7feSdrh ** and store the result in register regOut
3689e70fa7feSdrh */
3690e70fa7feSdrh void sqlite3ExprCodeGeneratedColumn(
369179cf2b71Sdrh   Parse *pParse,     /* Parsing context */
369279cf2b71Sdrh   Table *pTab,       /* Table containing the generated column */
369379cf2b71Sdrh   Column *pCol,      /* The generated column */
369479cf2b71Sdrh   int regOut         /* Put the result in this register */
3695e70fa7feSdrh ){
36964dad7ed5Sdrh   int iAddr;
36974dad7ed5Sdrh   Vdbe *v = pParse->pVdbe;
36984dad7ed5Sdrh   assert( v!=0 );
36994dad7ed5Sdrh   assert( pParse->iSelfTab!=0 );
37004dad7ed5Sdrh   if( pParse->iSelfTab>0 ){
37014dad7ed5Sdrh     iAddr = sqlite3VdbeAddOp3(v, OP_IfNullRow, pParse->iSelfTab-1, 0, regOut);
37024dad7ed5Sdrh   }else{
37034dad7ed5Sdrh     iAddr = 0;
37044dad7ed5Sdrh   }
370579cf2b71Sdrh   sqlite3ExprCodeCopy(pParse, sqlite3ColumnExpr(pTab,pCol), regOut);
3706e70fa7feSdrh   if( pCol->affinity>=SQLITE_AFF_TEXT ){
37074dad7ed5Sdrh     sqlite3VdbeAddOp4(v, OP_Affinity, regOut, 1, 0, &pCol->affinity, 1);
3708e70fa7feSdrh   }
37094dad7ed5Sdrh   if( iAddr ) sqlite3VdbeJumpHere(v, iAddr);
3710e70fa7feSdrh }
3711e70fa7feSdrh #endif /* SQLITE_OMIT_GENERATED_COLUMNS */
3712e70fa7feSdrh 
37135cd79239Sdrh /*
37145c092e8aSdrh ** Generate code to extract the value of the iCol-th column of a table.
37155c092e8aSdrh */
37165c092e8aSdrh void sqlite3ExprCodeGetColumnOfTable(
37176df9c4b9Sdrh   Vdbe *v,        /* Parsing context */
37185c092e8aSdrh   Table *pTab,    /* The table containing the value */
3719313619f5Sdrh   int iTabCur,    /* The table cursor.  Or the PK cursor for WITHOUT ROWID */
37205c092e8aSdrh   int iCol,       /* Index of the column to extract */
3721313619f5Sdrh   int regOut      /* Extract the value into this register */
37225c092e8aSdrh ){
3723ab45fc04Sdrh   Column *pCol;
372481f7b372Sdrh   assert( v!=0 );
3725aca19e19Sdrh   if( pTab==0 ){
3726aca19e19Sdrh     sqlite3VdbeAddOp3(v, OP_Column, iTabCur, iCol, regOut);
3727aca19e19Sdrh     return;
3728aca19e19Sdrh   }
37295c092e8aSdrh   if( iCol<0 || iCol==pTab->iPKey ){
37305c092e8aSdrh     sqlite3VdbeAddOp2(v, OP_Rowid, iTabCur, regOut);
37315c092e8aSdrh   }else{
373281f7b372Sdrh     int op;
373381f7b372Sdrh     int x;
373481f7b372Sdrh     if( IsVirtual(pTab) ){
373581f7b372Sdrh       op = OP_VColumn;
373681f7b372Sdrh       x = iCol;
373781f7b372Sdrh #ifndef SQLITE_OMIT_GENERATED_COLUMNS
3738ab45fc04Sdrh     }else if( (pCol = &pTab->aCol[iCol])->colFlags & COLFLAG_VIRTUAL ){
37396df9c4b9Sdrh       Parse *pParse = sqlite3VdbeParser(v);
3740ab45fc04Sdrh       if( pCol->colFlags & COLFLAG_BUSY ){
3741cf9d36d1Sdrh         sqlite3ErrorMsg(pParse, "generated column loop on \"%s\"",
3742cf9d36d1Sdrh                         pCol->zCnName);
3743ab45fc04Sdrh       }else{
374481f7b372Sdrh         int savedSelfTab = pParse->iSelfTab;
3745ab45fc04Sdrh         pCol->colFlags |= COLFLAG_BUSY;
374681f7b372Sdrh         pParse->iSelfTab = iTabCur+1;
374779cf2b71Sdrh         sqlite3ExprCodeGeneratedColumn(pParse, pTab, pCol, regOut);
374881f7b372Sdrh         pParse->iSelfTab = savedSelfTab;
3749ab45fc04Sdrh         pCol->colFlags &= ~COLFLAG_BUSY;
3750ab45fc04Sdrh       }
375181f7b372Sdrh       return;
375281f7b372Sdrh #endif
375381f7b372Sdrh     }else if( !HasRowid(pTab) ){
3754c5f808d8Sdrh       testcase( iCol!=sqlite3TableColumnToStorage(pTab, iCol) );
3755b9bcf7caSdrh       x = sqlite3TableColumnToIndex(sqlite3PrimaryKeyIndex(pTab), iCol);
375681f7b372Sdrh       op = OP_Column;
375781f7b372Sdrh     }else{
3758b9bcf7caSdrh       x = sqlite3TableColumnToStorage(pTab,iCol);
3759c5f808d8Sdrh       testcase( x!=iCol );
376081f7b372Sdrh       op = OP_Column;
3761ee0ec8e1Sdrh     }
3762ee0ec8e1Sdrh     sqlite3VdbeAddOp3(v, op, iTabCur, x, regOut);
37635c092e8aSdrh     sqlite3ColumnDefault(v, pTab, iCol, regOut);
37645c092e8aSdrh   }
37655c092e8aSdrh }
37665c092e8aSdrh 
37675c092e8aSdrh /*
3768945498f3Sdrh ** Generate code that will extract the iColumn-th column from
37698c607191Sdrh ** table pTab and store the column value in register iReg.
3770e55cbd72Sdrh **
3771e55cbd72Sdrh ** There must be an open cursor to pTab in iTable when this routine
3772e55cbd72Sdrh ** is called.  If iColumn<0 then code is generated that extracts the rowid.
3773945498f3Sdrh */
3774e55cbd72Sdrh int sqlite3ExprCodeGetColumn(
3775e55cbd72Sdrh   Parse *pParse,   /* Parsing and code generating context */
37762133d822Sdrh   Table *pTab,     /* Description of the table we are reading from */
37772133d822Sdrh   int iColumn,     /* Index of the table column */
37782133d822Sdrh   int iTable,      /* The cursor pointing to the table */
3779a748fdccSdrh   int iReg,        /* Store results here */
3780ce78bc6eSdrh   u8 p5            /* P5 value for OP_Column + FLAGS */
37812133d822Sdrh ){
378281f7b372Sdrh   assert( pParse->pVdbe!=0 );
37836df9c4b9Sdrh   sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pTab, iTable, iColumn, iReg);
3784a748fdccSdrh   if( p5 ){
378599670abbSdrh     VdbeOp *pOp = sqlite3VdbeGetOp(pParse->pVdbe,-1);
378699670abbSdrh     if( pOp->opcode==OP_Column ) pOp->p5 = p5;
3787a748fdccSdrh   }
3788e55cbd72Sdrh   return iReg;
3789e55cbd72Sdrh }
3790e55cbd72Sdrh 
3791e55cbd72Sdrh /*
3792b21e7c70Sdrh ** Generate code to move content from registers iFrom...iFrom+nReg-1
379336a5d88dSdrh ** over to iTo..iTo+nReg-1.
3794e55cbd72Sdrh */
3795b21e7c70Sdrh void sqlite3ExprCodeMove(Parse *pParse, int iFrom, int iTo, int nReg){
3796079a3072Sdrh   sqlite3VdbeAddOp3(pParse->pVdbe, OP_Move, iFrom, iTo, nReg);
3797945498f3Sdrh }
3798945498f3Sdrh 
3799652fbf55Sdrh /*
380012abf408Sdrh ** Convert a scalar expression node to a TK_REGISTER referencing
380112abf408Sdrh ** register iReg.  The caller must ensure that iReg already contains
380212abf408Sdrh ** the correct value for the expression.
3803a4c3c87eSdrh */
3804069d1b1fSdan static void exprToRegister(Expr *pExpr, int iReg){
38050d950af3Sdrh   Expr *p = sqlite3ExprSkipCollateAndLikely(pExpr);
3806235667a8Sdrh   if( NEVER(p==0) ) return;
3807a4c3c87eSdrh   p->op2 = p->op;
3808a4c3c87eSdrh   p->op = TK_REGISTER;
3809a4c3c87eSdrh   p->iTable = iReg;
3810a4c3c87eSdrh   ExprClearProperty(p, EP_Skip);
3811a4c3c87eSdrh }
3812a4c3c87eSdrh 
381312abf408Sdrh /*
381412abf408Sdrh ** Evaluate an expression (either a vector or a scalar expression) and store
381512abf408Sdrh ** the result in continguous temporary registers.  Return the index of
381612abf408Sdrh ** the first register used to store the result.
381712abf408Sdrh **
381812abf408Sdrh ** If the returned result register is a temporary scalar, then also write
381912abf408Sdrh ** that register number into *piFreeable.  If the returned result register
382012abf408Sdrh ** is not a temporary or if the expression is a vector set *piFreeable
382112abf408Sdrh ** to 0.
382212abf408Sdrh */
382312abf408Sdrh static int exprCodeVector(Parse *pParse, Expr *p, int *piFreeable){
382412abf408Sdrh   int iResult;
382512abf408Sdrh   int nResult = sqlite3ExprVectorSize(p);
382612abf408Sdrh   if( nResult==1 ){
382712abf408Sdrh     iResult = sqlite3ExprCodeTemp(pParse, p, piFreeable);
382812abf408Sdrh   }else{
382912abf408Sdrh     *piFreeable = 0;
383012abf408Sdrh     if( p->op==TK_SELECT ){
3831dd1bb43aSdrh #if SQLITE_OMIT_SUBQUERY
3832dd1bb43aSdrh       iResult = 0;
3833dd1bb43aSdrh #else
383485bcdce2Sdrh       iResult = sqlite3CodeSubselect(pParse, p);
3835dd1bb43aSdrh #endif
383612abf408Sdrh     }else{
383712abf408Sdrh       int i;
383812abf408Sdrh       iResult = pParse->nMem+1;
383912abf408Sdrh       pParse->nMem += nResult;
3840a4eeccdfSdrh       assert( ExprUseXList(p) );
384112abf408Sdrh       for(i=0; i<nResult; i++){
38424b725240Sdan         sqlite3ExprCodeFactorable(pParse, p->x.pList->a[i].pExpr, i+iResult);
384312abf408Sdrh       }
384412abf408Sdrh     }
384512abf408Sdrh   }
384612abf408Sdrh   return iResult;
384712abf408Sdrh }
384812abf408Sdrh 
384925c4296bSdrh /*
385092a27f7bSdrh ** If the last opcode is a OP_Copy, then set the do-not-merge flag (p5)
385192a27f7bSdrh ** so that a subsequent copy will not be merged into this one.
385292a27f7bSdrh */
385392a27f7bSdrh static void setDoNotMergeFlagOnCopy(Vdbe *v){
385492a27f7bSdrh   if( sqlite3VdbeGetOp(v, -1)->opcode==OP_Copy ){
385592a27f7bSdrh     sqlite3VdbeChangeP5(v, 1);  /* Tag trailing OP_Copy as not mergable */
385692a27f7bSdrh   }
385792a27f7bSdrh }
385892a27f7bSdrh 
385992a27f7bSdrh /*
386025c4296bSdrh ** Generate code to implement special SQL functions that are implemented
386125c4296bSdrh ** in-line rather than by using the usual callbacks.
386225c4296bSdrh */
386325c4296bSdrh static int exprCodeInlineFunction(
386425c4296bSdrh   Parse *pParse,        /* Parsing context */
386525c4296bSdrh   ExprList *pFarg,      /* List of function arguments */
386625c4296bSdrh   int iFuncId,          /* Function ID.  One of the INTFUNC_... values */
386725c4296bSdrh   int target            /* Store function result in this register */
386825c4296bSdrh ){
386925c4296bSdrh   int nFarg;
387025c4296bSdrh   Vdbe *v = pParse->pVdbe;
387125c4296bSdrh   assert( v!=0 );
387225c4296bSdrh   assert( pFarg!=0 );
387325c4296bSdrh   nFarg = pFarg->nExpr;
387425c4296bSdrh   assert( nFarg>0 );  /* All in-line functions have at least one argument */
387525c4296bSdrh   switch( iFuncId ){
387625c4296bSdrh     case INLINEFUNC_coalesce: {
387725c4296bSdrh       /* Attempt a direct implementation of the built-in COALESCE() and
387825c4296bSdrh       ** IFNULL() functions.  This avoids unnecessary evaluation of
387925c4296bSdrh       ** arguments past the first non-NULL argument.
388025c4296bSdrh       */
388125c4296bSdrh       int endCoalesce = sqlite3VdbeMakeLabel(pParse);
388225c4296bSdrh       int i;
388325c4296bSdrh       assert( nFarg>=2 );
388425c4296bSdrh       sqlite3ExprCode(pParse, pFarg->a[0].pExpr, target);
388525c4296bSdrh       for(i=1; i<nFarg; i++){
388625c4296bSdrh         sqlite3VdbeAddOp2(v, OP_NotNull, target, endCoalesce);
388725c4296bSdrh         VdbeCoverage(v);
388825c4296bSdrh         sqlite3ExprCode(pParse, pFarg->a[i].pExpr, target);
388925c4296bSdrh       }
389092a27f7bSdrh       setDoNotMergeFlagOnCopy(v);
389125c4296bSdrh       sqlite3VdbeResolveLabel(v, endCoalesce);
389225c4296bSdrh       break;
389325c4296bSdrh     }
38943c0e606bSdrh     case INLINEFUNC_iif: {
38953c0e606bSdrh       Expr caseExpr;
38963c0e606bSdrh       memset(&caseExpr, 0, sizeof(caseExpr));
38973c0e606bSdrh       caseExpr.op = TK_CASE;
38983c0e606bSdrh       caseExpr.x.pList = pFarg;
38993c0e606bSdrh       return sqlite3ExprCodeTarget(pParse, &caseExpr, target);
39003c0e606bSdrh     }
390125c4296bSdrh 
3902171c50ecSdrh     default: {
390325c4296bSdrh       /* The UNLIKELY() function is a no-op.  The result is the value
390425c4296bSdrh       ** of the first argument.
390525c4296bSdrh       */
3906171c50ecSdrh       assert( nFarg==1 || nFarg==2 );
390725c4296bSdrh       target = sqlite3ExprCodeTarget(pParse, pFarg->a[0].pExpr, target);
390825c4296bSdrh       break;
390925c4296bSdrh     }
391025c4296bSdrh 
3911171c50ecSdrh   /***********************************************************************
3912171c50ecSdrh   ** Test-only SQL functions that are only usable if enabled
3913171c50ecSdrh   ** via SQLITE_TESTCTRL_INTERNAL_FUNCTIONS
3914171c50ecSdrh   */
39153780f9a4Sdrh #if !defined(SQLITE_UNTESTABLE)
3916171c50ecSdrh     case INLINEFUNC_expr_compare: {
3917171c50ecSdrh       /* Compare two expressions using sqlite3ExprCompare() */
3918171c50ecSdrh       assert( nFarg==2 );
3919171c50ecSdrh       sqlite3VdbeAddOp2(v, OP_Integer,
3920171c50ecSdrh          sqlite3ExprCompare(0,pFarg->a[0].pExpr, pFarg->a[1].pExpr,-1),
3921171c50ecSdrh          target);
3922171c50ecSdrh       break;
3923171c50ecSdrh     }
3924171c50ecSdrh 
3925171c50ecSdrh     case INLINEFUNC_expr_implies_expr: {
3926171c50ecSdrh       /* Compare two expressions using sqlite3ExprImpliesExpr() */
3927171c50ecSdrh       assert( nFarg==2 );
3928171c50ecSdrh       sqlite3VdbeAddOp2(v, OP_Integer,
3929171c50ecSdrh          sqlite3ExprImpliesExpr(pParse,pFarg->a[0].pExpr, pFarg->a[1].pExpr,-1),
3930171c50ecSdrh          target);
3931171c50ecSdrh       break;
3932171c50ecSdrh     }
3933171c50ecSdrh 
3934171c50ecSdrh     case INLINEFUNC_implies_nonnull_row: {
3935171c50ecSdrh       /* REsult of sqlite3ExprImpliesNonNullRow() */
3936171c50ecSdrh       Expr *pA1;
3937171c50ecSdrh       assert( nFarg==2 );
3938171c50ecSdrh       pA1 = pFarg->a[1].pExpr;
3939171c50ecSdrh       if( pA1->op==TK_COLUMN ){
3940171c50ecSdrh         sqlite3VdbeAddOp2(v, OP_Integer,
3941171c50ecSdrh            sqlite3ExprImpliesNonNullRow(pFarg->a[0].pExpr,pA1->iTable),
3942171c50ecSdrh            target);
3943171c50ecSdrh       }else{
3944171c50ecSdrh         sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3945171c50ecSdrh       }
3946171c50ecSdrh       break;
3947171c50ecSdrh     }
3948171c50ecSdrh 
394925c4296bSdrh     case INLINEFUNC_affinity: {
395025c4296bSdrh       /* The AFFINITY() function evaluates to a string that describes
395125c4296bSdrh       ** the type affinity of the argument.  This is used for testing of
395225c4296bSdrh       ** the SQLite type logic.
395325c4296bSdrh       */
395425c4296bSdrh       const char *azAff[] = { "blob", "text", "numeric", "integer", "real" };
395525c4296bSdrh       char aff;
395625c4296bSdrh       assert( nFarg==1 );
395725c4296bSdrh       aff = sqlite3ExprAffinity(pFarg->a[0].pExpr);
395825c4296bSdrh       sqlite3VdbeLoadString(v, target,
395925c4296bSdrh               (aff<=SQLITE_AFF_NONE) ? "none" : azAff[aff-SQLITE_AFF_BLOB]);
396025c4296bSdrh       break;
396125c4296bSdrh     }
39623780f9a4Sdrh #endif /* !defined(SQLITE_UNTESTABLE) */
396325c4296bSdrh   }
396425c4296bSdrh   return target;
396525c4296bSdrh }
396625c4296bSdrh 
396771c57db0Sdan 
3968a4c3c87eSdrh /*
3969cce7d176Sdrh ** Generate code into the current Vdbe to evaluate the given
39702dcef11bSdrh ** expression.  Attempt to store the results in register "target".
39712dcef11bSdrh ** Return the register where results are stored.
3972389a1adbSdrh **
39738b213899Sdrh ** With this routine, there is no guarantee that results will
39742dcef11bSdrh ** be stored in target.  The result might be stored in some other
39752dcef11bSdrh ** register if it is convenient to do so.  The calling function
39762dcef11bSdrh ** must check the return code and move the results to the desired
39772dcef11bSdrh ** register.
3978cce7d176Sdrh */
3979678ccce8Sdrh int sqlite3ExprCodeTarget(Parse *pParse, Expr *pExpr, int target){
39802dcef11bSdrh   Vdbe *v = pParse->pVdbe;  /* The VM under construction */
39812dcef11bSdrh   int op;                   /* The opcode being coded */
39822dcef11bSdrh   int inReg = target;       /* Results stored in register inReg */
39832dcef11bSdrh   int regFree1 = 0;         /* If non-zero free this temporary register */
39842dcef11bSdrh   int regFree2 = 0;         /* If non-zero free this temporary register */
39857b35a77bSdan   int r1, r2;               /* Various register numbers */
398610d1edf0Sdrh   Expr tempX;               /* Temporary expression node */
398771c57db0Sdan   int p5 = 0;
3988ffe07b2dSdrh 
39899cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
3990b639a209Sdrh   assert( v!=0 );
3991389a1adbSdrh 
39921efa8023Sdrh expr_code_doover:
3993389a1adbSdrh   if( pExpr==0 ){
3994389a1adbSdrh     op = TK_NULL;
3995389a1adbSdrh   }else{
3996e7375bfaSdrh     assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
3997f2bc013cSdrh     op = pExpr->op;
3998389a1adbSdrh   }
3999f2bc013cSdrh   switch( op ){
400013449892Sdrh     case TK_AGG_COLUMN: {
400113449892Sdrh       AggInfo *pAggInfo = pExpr->pAggInfo;
40020934d640Sdrh       struct AggInfo_col *pCol;
40030934d640Sdrh       assert( pAggInfo!=0 );
40040934d640Sdrh       assert( pExpr->iAgg>=0 && pExpr->iAgg<pAggInfo->nColumn );
40050934d640Sdrh       pCol = &pAggInfo->aCol[pExpr->iAgg];
400613449892Sdrh       if( !pAggInfo->directMode ){
40079de221dfSdrh         assert( pCol->iMem>0 );
4008c332cc30Sdrh         return pCol->iMem;
400913449892Sdrh       }else if( pAggInfo->useSortingIdx ){
40100c76e892Sdrh         Table *pTab = pCol->pTab;
40115134d135Sdan         sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdxPTab,
4012389a1adbSdrh                               pCol->iSorterColumn, target);
40138d5cea6bSdrh         if( pCol->iColumn<0 ){
40148d5cea6bSdrh           VdbeComment((v,"%s.rowid",pTab->zName));
40158d5cea6bSdrh         }else{
4016cf9d36d1Sdrh           VdbeComment((v,"%s.%s",
4017cf9d36d1Sdrh               pTab->zName, pTab->aCol[pCol->iColumn].zCnName));
40188d5cea6bSdrh           if( pTab->aCol[pCol->iColumn].affinity==SQLITE_AFF_REAL ){
40198d5cea6bSdrh             sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
40208d5cea6bSdrh           }
40210c76e892Sdrh         }
4022c332cc30Sdrh         return target;
402313449892Sdrh       }
402413449892Sdrh       /* Otherwise, fall thru into the TK_COLUMN case */
402508b92086Sdrh       /* no break */ deliberate_fall_through
402613449892Sdrh     }
4027967e8b73Sdrh     case TK_COLUMN: {
4028b2b9d3d7Sdrh       int iTab = pExpr->iTable;
402967b9ba17Sdrh       int iReg;
4030efad2e23Sdrh       if( ExprHasProperty(pExpr, EP_FixedCol) ){
4031d98f5324Sdrh         /* This COLUMN expression is really a constant due to WHERE clause
4032d98f5324Sdrh         ** constraints, and that constant is coded by the pExpr->pLeft
4033d98f5324Sdrh         ** expresssion.  However, make sure the constant has the correct
4034d98f5324Sdrh         ** datatype by applying the Affinity of the table column to the
4035d98f5324Sdrh         ** constant.
4036d98f5324Sdrh         */
403757f7ece7Sdrh         int aff;
403867b9ba17Sdrh         iReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft,target);
4039477572b9Sdrh         assert( ExprUseYTab(pExpr) );
404057f7ece7Sdrh         if( pExpr->y.pTab ){
404157f7ece7Sdrh           aff = sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
404257f7ece7Sdrh         }else{
404357f7ece7Sdrh           aff = pExpr->affExpr;
404457f7ece7Sdrh         }
404596fb16eeSdrh         if( aff>SQLITE_AFF_BLOB ){
4046d98f5324Sdrh           static const char zAff[] = "B\000C\000D\000E";
4047d98f5324Sdrh           assert( SQLITE_AFF_BLOB=='A' );
4048d98f5324Sdrh           assert( SQLITE_AFF_TEXT=='B' );
4049d98f5324Sdrh           sqlite3VdbeAddOp4(v, OP_Affinity, iReg, 1, 0,
4050d98f5324Sdrh                             &zAff[(aff-'B')*2], P4_STATIC);
4051d98f5324Sdrh         }
4052d98f5324Sdrh         return iReg;
4053efad2e23Sdrh       }
4054b2b9d3d7Sdrh       if( iTab<0 ){
40556e97f8ecSdrh         if( pParse->iSelfTab<0 ){
40569942ef0dSdrh           /* Other columns in the same row for CHECK constraints or
40579942ef0dSdrh           ** generated columns or for inserting into partial index.
40589942ef0dSdrh           ** The row is unpacked into registers beginning at
40599942ef0dSdrh           ** 0-(pParse->iSelfTab).  The rowid (if any) is in a register
40609942ef0dSdrh           ** immediately prior to the first column.
40619942ef0dSdrh           */
40629942ef0dSdrh           Column *pCol;
4063477572b9Sdrh           Table *pTab;
40649942ef0dSdrh           int iSrc;
4065c5f808d8Sdrh           int iCol = pExpr->iColumn;
4066477572b9Sdrh           assert( ExprUseYTab(pExpr) );
4067477572b9Sdrh           pTab = pExpr->y.pTab;
40689942ef0dSdrh           assert( pTab!=0 );
4069c5f808d8Sdrh           assert( iCol>=XN_ROWID );
4070b0cbcd0eSdrh           assert( iCol<pTab->nCol );
4071c5f808d8Sdrh           if( iCol<0 ){
40729942ef0dSdrh             return -1-pParse->iSelfTab;
40739942ef0dSdrh           }
4074c5f808d8Sdrh           pCol = pTab->aCol + iCol;
4075c5f808d8Sdrh           testcase( iCol!=sqlite3TableColumnToStorage(pTab,iCol) );
4076c5f808d8Sdrh           iSrc = sqlite3TableColumnToStorage(pTab, iCol) - pParse->iSelfTab;
40779942ef0dSdrh #ifndef SQLITE_OMIT_GENERATED_COLUMNS
40789942ef0dSdrh           if( pCol->colFlags & COLFLAG_GENERATED ){
40794e8e533bSdrh             if( pCol->colFlags & COLFLAG_BUSY ){
40804e8e533bSdrh               sqlite3ErrorMsg(pParse, "generated column loop on \"%s\"",
4081cf9d36d1Sdrh                               pCol->zCnName);
40824e8e533bSdrh               return 0;
40834e8e533bSdrh             }
40844e8e533bSdrh             pCol->colFlags |= COLFLAG_BUSY;
40854e8e533bSdrh             if( pCol->colFlags & COLFLAG_NOTAVAIL ){
408679cf2b71Sdrh               sqlite3ExprCodeGeneratedColumn(pParse, pTab, pCol, iSrc);
40874e8e533bSdrh             }
40884e8e533bSdrh             pCol->colFlags &= ~(COLFLAG_BUSY|COLFLAG_NOTAVAIL);
4089dd6cc9b5Sdrh             return iSrc;
40909942ef0dSdrh           }else
40919942ef0dSdrh #endif /* SQLITE_OMIT_GENERATED_COLUMNS */
40929942ef0dSdrh           if( pCol->affinity==SQLITE_AFF_REAL ){
40939942ef0dSdrh             sqlite3VdbeAddOp2(v, OP_SCopy, iSrc, target);
4094bffdd636Sdrh             sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
4095bffdd636Sdrh             return target;
4096bffdd636Sdrh           }else{
40979942ef0dSdrh             return iSrc;
4098bffdd636Sdrh           }
4099c4a3c779Sdrh         }else{
41001f9ca2c8Sdrh           /* Coding an expression that is part of an index where column names
41011f9ca2c8Sdrh           ** in the index refer to the table to which the index belongs */
41023e34eabcSdrh           iTab = pParse->iSelfTab - 1;
41032282792aSdrh         }
4104b2b9d3d7Sdrh       }
4105477572b9Sdrh       assert( ExprUseYTab(pExpr) );
410667b9ba17Sdrh       iReg = sqlite3ExprCodeGetColumn(pParse, pExpr->y.pTab,
4107b2b9d3d7Sdrh                                pExpr->iColumn, iTab, target,
4108b2b9d3d7Sdrh                                pExpr->op2);
410967b9ba17Sdrh       if( pExpr->y.pTab==0 && pExpr->affExpr==SQLITE_AFF_REAL ){
411067b9ba17Sdrh         sqlite3VdbeAddOp1(v, OP_RealAffinity, iReg);
411167b9ba17Sdrh       }
411267b9ba17Sdrh       return iReg;
4113cce7d176Sdrh     }
4114cce7d176Sdrh     case TK_INTEGER: {
411513573c71Sdrh       codeInteger(pParse, pExpr, 0, target);
4116c332cc30Sdrh       return target;
411751e9a445Sdrh     }
41188abed7b9Sdrh     case TK_TRUEFALSE: {
411996acafbeSdrh       sqlite3VdbeAddOp2(v, OP_Integer, sqlite3ExprTruthValue(pExpr), target);
4120007c843bSdrh       return target;
4121007c843bSdrh     }
412213573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
4123598f1340Sdrh     case TK_FLOAT: {
412433e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
412533e619fcSdrh       codeReal(v, pExpr->u.zToken, 0, target);
4126c332cc30Sdrh       return target;
4127598f1340Sdrh     }
412813573c71Sdrh #endif
4129fec19aadSdrh     case TK_STRING: {
413033e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
4131076e85f5Sdrh       sqlite3VdbeLoadString(v, target, pExpr->u.zToken);
4132c332cc30Sdrh       return target;
4133cce7d176Sdrh     }
4134aac30f9bSdrh     default: {
4135c29af653Sdrh       /* Make NULL the default case so that if a bug causes an illegal
4136c29af653Sdrh       ** Expr node to be passed into this function, it will be handled
41379524a7eaSdrh       ** sanely and not crash.  But keep the assert() to bring the problem
41389524a7eaSdrh       ** to the attention of the developers. */
413905428127Sdrh       assert( op==TK_NULL || op==TK_ERROR || pParse->db->mallocFailed );
41409de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
4141c332cc30Sdrh       return target;
4142f0863fe5Sdrh     }
41435338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_BLOB_LITERAL
4144c572ef7fSdanielk1977     case TK_BLOB: {
41456c8c6cecSdrh       int n;
41466c8c6cecSdrh       const char *z;
4147ca48c90fSdrh       char *zBlob;
414833e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
414933e619fcSdrh       assert( pExpr->u.zToken[0]=='x' || pExpr->u.zToken[0]=='X' );
415033e619fcSdrh       assert( pExpr->u.zToken[1]=='\'' );
415133e619fcSdrh       z = &pExpr->u.zToken[2];
4152b7916a78Sdrh       n = sqlite3Strlen30(z) - 1;
4153b7916a78Sdrh       assert( z[n]=='\'' );
4154ca48c90fSdrh       zBlob = sqlite3HexToBlob(sqlite3VdbeDb(v), z, n);
4155ca48c90fSdrh       sqlite3VdbeAddOp4(v, OP_Blob, n/2, target, 0, zBlob, P4_DYNAMIC);
4156c332cc30Sdrh       return target;
4157c572ef7fSdanielk1977     }
41585338a5f7Sdanielk1977 #endif
415950457896Sdrh     case TK_VARIABLE: {
416033e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
416133e619fcSdrh       assert( pExpr->u.zToken!=0 );
416233e619fcSdrh       assert( pExpr->u.zToken[0]!=0 );
4163eaf52d88Sdrh       sqlite3VdbeAddOp2(v, OP_Variable, pExpr->iColumn, target);
416433e619fcSdrh       if( pExpr->u.zToken[1]!=0 ){
41659bf755ccSdrh         const char *z = sqlite3VListNumToName(pParse->pVList, pExpr->iColumn);
41669524a7eaSdrh         assert( pExpr->u.zToken[0]=='?' || (z && !strcmp(pExpr->u.zToken, z)) );
4167ce1bbe51Sdrh         pParse->pVList[0] = 0; /* Indicate VList may no longer be enlarged */
41689bf755ccSdrh         sqlite3VdbeAppendP4(v, (char*)z, P4_STATIC);
41699bf755ccSdrh       }
4170c332cc30Sdrh       return target;
417150457896Sdrh     }
41724e0cff60Sdrh     case TK_REGISTER: {
4173c332cc30Sdrh       return pExpr->iTable;
41744e0cff60Sdrh     }
4175487e262fSdrh #ifndef SQLITE_OMIT_CAST
4176487e262fSdrh     case TK_CAST: {
4177487e262fSdrh       /* Expressions of the form:   CAST(pLeft AS token) */
41782dcef11bSdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
41791735fa88Sdrh       if( inReg!=target ){
41801735fa88Sdrh         sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
41811735fa88Sdrh         inReg = target;
41821735fa88Sdrh       }
4183f9751074Sdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
41844169e430Sdrh       sqlite3VdbeAddOp2(v, OP_Cast, target,
41854169e430Sdrh                         sqlite3AffinityType(pExpr->u.zToken, 0));
4186c332cc30Sdrh       return inReg;
4187487e262fSdrh     }
4188487e262fSdrh #endif /* SQLITE_OMIT_CAST */
418971c57db0Sdan     case TK_IS:
419071c57db0Sdan     case TK_ISNOT:
419171c57db0Sdan       op = (op==TK_IS) ? TK_EQ : TK_NE;
419271c57db0Sdan       p5 = SQLITE_NULLEQ;
419371c57db0Sdan       /* fall-through */
4194c9b84a1fSdrh     case TK_LT:
4195c9b84a1fSdrh     case TK_LE:
4196c9b84a1fSdrh     case TK_GT:
4197c9b84a1fSdrh     case TK_GE:
4198c9b84a1fSdrh     case TK_NE:
4199c9b84a1fSdrh     case TK_EQ: {
420071c57db0Sdan       Expr *pLeft = pExpr->pLeft;
4201625015e0Sdan       if( sqlite3ExprIsVector(pLeft) ){
420279752b6eSdrh         codeVectorCompare(pParse, pExpr, target, op, p5);
420371c57db0Sdan       }else{
420471c57db0Sdan         r1 = sqlite3ExprCodeTemp(pParse, pLeft, &regFree1);
4205b6da74ebSdrh         r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
4206871e7ff4Sdrh         sqlite3VdbeAddOp2(v, OP_Integer, 1, inReg);
4207871e7ff4Sdrh         codeCompare(pParse, pLeft, pExpr->pRight, op, r1, r2,
4208871e7ff4Sdrh             sqlite3VdbeCurrentAddr(v)+2, p5,
4209898c527eSdrh             ExprHasProperty(pExpr,EP_Commuted));
42107d176105Sdrh         assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
42117d176105Sdrh         assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
42127d176105Sdrh         assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
42137d176105Sdrh         assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
42147d176105Sdrh         assert(TK_EQ==OP_Eq); testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
42157d176105Sdrh         assert(TK_NE==OP_Ne); testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
4216529df929Sdrh         if( p5==SQLITE_NULLEQ ){
4217529df929Sdrh           sqlite3VdbeAddOp2(v, OP_Integer, 0, inReg);
4218529df929Sdrh         }else{
4219529df929Sdrh           sqlite3VdbeAddOp3(v, OP_ZeroOrNull, r1, inReg, r2);
4220529df929Sdrh         }
4221c5499befSdrh         testcase( regFree1==0 );
4222c5499befSdrh         testcase( regFree2==0 );
4223c9b84a1fSdrh       }
42246a2fe093Sdrh       break;
42256a2fe093Sdrh     }
4226cce7d176Sdrh     case TK_AND:
4227cce7d176Sdrh     case TK_OR:
4228cce7d176Sdrh     case TK_PLUS:
4229cce7d176Sdrh     case TK_STAR:
4230cce7d176Sdrh     case TK_MINUS:
4231bf4133cbSdrh     case TK_REM:
4232bf4133cbSdrh     case TK_BITAND:
4233bf4133cbSdrh     case TK_BITOR:
423417c40294Sdrh     case TK_SLASH:
4235bf4133cbSdrh     case TK_LSHIFT:
4236855eb1cfSdrh     case TK_RSHIFT:
42370040077dSdrh     case TK_CONCAT: {
42387d176105Sdrh       assert( TK_AND==OP_And );            testcase( op==TK_AND );
42397d176105Sdrh       assert( TK_OR==OP_Or );              testcase( op==TK_OR );
42407d176105Sdrh       assert( TK_PLUS==OP_Add );           testcase( op==TK_PLUS );
42417d176105Sdrh       assert( TK_MINUS==OP_Subtract );     testcase( op==TK_MINUS );
42427d176105Sdrh       assert( TK_REM==OP_Remainder );      testcase( op==TK_REM );
42437d176105Sdrh       assert( TK_BITAND==OP_BitAnd );      testcase( op==TK_BITAND );
42447d176105Sdrh       assert( TK_BITOR==OP_BitOr );        testcase( op==TK_BITOR );
42457d176105Sdrh       assert( TK_SLASH==OP_Divide );       testcase( op==TK_SLASH );
42467d176105Sdrh       assert( TK_LSHIFT==OP_ShiftLeft );   testcase( op==TK_LSHIFT );
42477d176105Sdrh       assert( TK_RSHIFT==OP_ShiftRight );  testcase( op==TK_RSHIFT );
42487d176105Sdrh       assert( TK_CONCAT==OP_Concat );      testcase( op==TK_CONCAT );
42492dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
42502dcef11bSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
42515b6afba9Sdrh       sqlite3VdbeAddOp3(v, op, r2, r1, target);
4252c5499befSdrh       testcase( regFree1==0 );
4253c5499befSdrh       testcase( regFree2==0 );
42540040077dSdrh       break;
42550040077dSdrh     }
4256cce7d176Sdrh     case TK_UMINUS: {
4257fec19aadSdrh       Expr *pLeft = pExpr->pLeft;
4258fec19aadSdrh       assert( pLeft );
425913573c71Sdrh       if( pLeft->op==TK_INTEGER ){
426013573c71Sdrh         codeInteger(pParse, pLeft, 1, target);
4261c332cc30Sdrh         return target;
426213573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
426313573c71Sdrh       }else if( pLeft->op==TK_FLOAT ){
426433e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
426533e619fcSdrh         codeReal(v, pLeft->u.zToken, 1, target);
4266c332cc30Sdrh         return target;
426713573c71Sdrh #endif
42683c84ddffSdrh       }else{
426910d1edf0Sdrh         tempX.op = TK_INTEGER;
427010d1edf0Sdrh         tempX.flags = EP_IntValue|EP_TokenOnly;
427110d1edf0Sdrh         tempX.u.iValue = 0;
4272e7375bfaSdrh         ExprClearVVAProperties(&tempX);
427310d1edf0Sdrh         r1 = sqlite3ExprCodeTemp(pParse, &tempX, &regFree1);
4274e55cbd72Sdrh         r2 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree2);
42752dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_Subtract, r2, r1, target);
4276c5499befSdrh         testcase( regFree2==0 );
42773c84ddffSdrh       }
42786e142f54Sdrh       break;
42796e142f54Sdrh     }
4280bf4133cbSdrh     case TK_BITNOT:
42816e142f54Sdrh     case TK_NOT: {
42827d176105Sdrh       assert( TK_BITNOT==OP_BitNot );   testcase( op==TK_BITNOT );
42837d176105Sdrh       assert( TK_NOT==OP_Not );         testcase( op==TK_NOT );
4284e99fa2afSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4285e99fa2afSdrh       testcase( regFree1==0 );
4286e99fa2afSdrh       sqlite3VdbeAddOp2(v, op, r1, inReg);
4287cce7d176Sdrh       break;
4288cce7d176Sdrh     }
42898abed7b9Sdrh     case TK_TRUTH: {
429096acafbeSdrh       int isTrue;    /* IS TRUE or IS NOT TRUE */
429196acafbeSdrh       int bNormal;   /* IS TRUE or IS FALSE */
4292007c843bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4293007c843bSdrh       testcase( regFree1==0 );
429496acafbeSdrh       isTrue = sqlite3ExprTruthValue(pExpr->pRight);
429596acafbeSdrh       bNormal = pExpr->op2==TK_IS;
429696acafbeSdrh       testcase( isTrue && bNormal);
429796acafbeSdrh       testcase( !isTrue && bNormal);
429896acafbeSdrh       sqlite3VdbeAddOp4Int(v, OP_IsTrue, r1, inReg, !isTrue, isTrue ^ bNormal);
4299007c843bSdrh       break;
4300007c843bSdrh     }
4301cce7d176Sdrh     case TK_ISNULL:
4302cce7d176Sdrh     case TK_NOTNULL: {
43036a288a33Sdrh       int addr;
43047d176105Sdrh       assert( TK_ISNULL==OP_IsNull );   testcase( op==TK_ISNULL );
43057d176105Sdrh       assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
43069de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
43072dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4308c5499befSdrh       testcase( regFree1==0 );
43092dcef11bSdrh       addr = sqlite3VdbeAddOp1(v, op, r1);
43107d176105Sdrh       VdbeCoverageIf(v, op==TK_ISNULL);
43117d176105Sdrh       VdbeCoverageIf(v, op==TK_NOTNULL);
4312a976979bSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 0, target);
43136a288a33Sdrh       sqlite3VdbeJumpHere(v, addr);
4314a37cdde0Sdanielk1977       break;
4315f2bc013cSdrh     }
43162282792aSdrh     case TK_AGG_FUNCTION: {
431713449892Sdrh       AggInfo *pInfo = pExpr->pAggInfo;
43180934d640Sdrh       if( pInfo==0
43190934d640Sdrh        || NEVER(pExpr->iAgg<0)
43200934d640Sdrh        || NEVER(pExpr->iAgg>=pInfo->nFunc)
43210934d640Sdrh       ){
432233e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
432333e619fcSdrh         sqlite3ErrorMsg(pParse, "misuse of aggregate: %s()", pExpr->u.zToken);
43247e56e711Sdrh       }else{
4325c332cc30Sdrh         return pInfo->aFunc[pExpr->iAgg].iMem;
43267e56e711Sdrh       }
43272282792aSdrh       break;
43282282792aSdrh     }
4329cce7d176Sdrh     case TK_FUNCTION: {
433012ffee8cSdrh       ExprList *pFarg;       /* List of function arguments */
433112ffee8cSdrh       int nFarg;             /* Number of function arguments */
433212ffee8cSdrh       FuncDef *pDef;         /* The function definition object */
433312ffee8cSdrh       const char *zId;       /* The function name */
4334693e6719Sdrh       u32 constMask = 0;     /* Mask of function arguments that are constant */
433512ffee8cSdrh       int i;                 /* Loop counter */
4336c332cc30Sdrh       sqlite3 *db = pParse->db;  /* The database connection */
433712ffee8cSdrh       u8 enc = ENC(db);      /* The text encoding used by this database */
433812ffee8cSdrh       CollSeq *pColl = 0;    /* A collating sequence */
433917435752Sdrh 
434067a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
4341eda079cdSdrh       if( ExprHasProperty(pExpr, EP_WinFunc) ){
4342eda079cdSdrh         return pExpr->y.pWin->regResult;
434386fb6e17Sdan       }
434467a9b8edSdan #endif
434586fb6e17Sdan 
43461e9b53f9Sdrh       if( ConstFactorOk(pParse) && sqlite3ExprIsConstantNotJoin(pExpr) ){
43479b258c54Sdrh         /* SQL functions can be expensive. So try to avoid running them
43489b258c54Sdrh         ** multiple times if we know they always give the same result */
43499b258c54Sdrh         return sqlite3ExprCodeRunJustOnce(pParse, pExpr, -1);
43501e9b53f9Sdrh       }
4351e7375bfaSdrh       assert( !ExprHasProperty(pExpr, EP_TokenOnly) );
4352a4eeccdfSdrh       assert( ExprUseXList(pExpr) );
435312ffee8cSdrh       pFarg = pExpr->x.pList;
435412ffee8cSdrh       nFarg = pFarg ? pFarg->nExpr : 0;
435533e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
435633e619fcSdrh       zId = pExpr->u.zToken;
435780738d9cSdrh       pDef = sqlite3FindFunction(db, zId, nFarg, enc, 0);
4358cc15313cSdrh #ifdef SQLITE_ENABLE_UNKNOWN_SQL_FUNCTION
4359cc15313cSdrh       if( pDef==0 && pParse->explain ){
4360cc15313cSdrh         pDef = sqlite3FindFunction(db, "unknown", nFarg, enc, 0);
4361cc15313cSdrh       }
4362cc15313cSdrh #endif
4363b6e9f7a4Sdan       if( pDef==0 || pDef->xFinalize!=0 ){
436480738d9cSdrh         sqlite3ErrorMsg(pParse, "unknown function: %s()", zId);
4365feb306f5Sdrh         break;
4366feb306f5Sdrh       }
436725c4296bSdrh       if( pDef->funcFlags & SQLITE_FUNC_INLINE ){
43680dfa5255Sdrh         assert( (pDef->funcFlags & SQLITE_FUNC_UNSAFE)==0 );
43690dfa5255Sdrh         assert( (pDef->funcFlags & SQLITE_FUNC_DIRECT)==0 );
437025c4296bSdrh         return exprCodeInlineFunction(pParse, pFarg,
437125c4296bSdrh              SQLITE_PTR_TO_INT(pDef->pUserData), target);
43722eeca204Sdrh       }else if( pDef->funcFlags & (SQLITE_FUNC_DIRECT|SQLITE_FUNC_UNSAFE) ){
43730dfa5255Sdrh         sqlite3ExprFunctionUsable(pParse, pExpr, pDef);
4374ae6bb957Sdrh       }
4375a1a523a5Sdrh 
4376d1a01edaSdrh       for(i=0; i<nFarg; i++){
4377d1a01edaSdrh         if( i<32 && sqlite3ExprIsConstant(pFarg->a[i].pExpr) ){
4378693e6719Sdrh           testcase( i==31 );
4379693e6719Sdrh           constMask |= MASKBIT32(i);
4380d1a01edaSdrh         }
4381d1a01edaSdrh         if( (pDef->funcFlags & SQLITE_FUNC_NEEDCOLL)!=0 && !pColl ){
4382d1a01edaSdrh           pColl = sqlite3ExprCollSeq(pParse, pFarg->a[i].pExpr);
4383d1a01edaSdrh         }
4384d1a01edaSdrh       }
438512ffee8cSdrh       if( pFarg ){
4386d1a01edaSdrh         if( constMask ){
4387d1a01edaSdrh           r1 = pParse->nMem+1;
4388d1a01edaSdrh           pParse->nMem += nFarg;
4389d1a01edaSdrh         }else{
439012ffee8cSdrh           r1 = sqlite3GetTempRange(pParse, nFarg);
4391d1a01edaSdrh         }
4392a748fdccSdrh 
4393a748fdccSdrh         /* For length() and typeof() functions with a column argument,
4394a748fdccSdrh         ** set the P5 parameter to the OP_Column opcode to OPFLAG_LENGTHARG
4395a748fdccSdrh         ** or OPFLAG_TYPEOFARG respectively, to avoid unnecessary data
4396a748fdccSdrh         ** loading.
4397a748fdccSdrh         */
4398d36e1041Sdrh         if( (pDef->funcFlags & (SQLITE_FUNC_LENGTH|SQLITE_FUNC_TYPEOF))!=0 ){
43994e245a4cSdrh           u8 exprOp;
4400a748fdccSdrh           assert( nFarg==1 );
4401a748fdccSdrh           assert( pFarg->a[0].pExpr!=0 );
44024e245a4cSdrh           exprOp = pFarg->a[0].pExpr->op;
44034e245a4cSdrh           if( exprOp==TK_COLUMN || exprOp==TK_AGG_COLUMN ){
4404a748fdccSdrh             assert( SQLITE_FUNC_LENGTH==OPFLAG_LENGTHARG );
4405a748fdccSdrh             assert( SQLITE_FUNC_TYPEOF==OPFLAG_TYPEOFARG );
4406b1fba286Sdrh             testcase( pDef->funcFlags & OPFLAG_LENGTHARG );
4407b1fba286Sdrh             pFarg->a[0].pExpr->op2 =
4408b1fba286Sdrh                   pDef->funcFlags & (OPFLAG_LENGTHARG|OPFLAG_TYPEOFARG);
4409a748fdccSdrh           }
4410a748fdccSdrh         }
4411a748fdccSdrh 
44125579d59fSdrh         sqlite3ExprCodeExprList(pParse, pFarg, r1, 0,
4413d1a01edaSdrh                                 SQLITE_ECEL_DUP|SQLITE_ECEL_FACTOR);
4414892d3179Sdrh       }else{
441512ffee8cSdrh         r1 = 0;
4416892d3179Sdrh       }
4417b7f6f68fSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
4418a43fa227Sdrh       /* Possibly overload the function if the first argument is
4419a43fa227Sdrh       ** a virtual table column.
4420a43fa227Sdrh       **
4421a43fa227Sdrh       ** For infix functions (LIKE, GLOB, REGEXP, and MATCH) use the
4422a43fa227Sdrh       ** second argument, not the first, as the argument to test to
4423a43fa227Sdrh       ** see if it is a column in a virtual table.  This is done because
4424a43fa227Sdrh       ** the left operand of infix functions (the operand we want to
4425a43fa227Sdrh       ** control overloading) ends up as the second argument to the
4426a43fa227Sdrh       ** function.  The expression "A glob B" is equivalent to
4427a43fa227Sdrh       ** "glob(B,A).  We want to use the A in "A glob B" to test
4428a43fa227Sdrh       ** for function overloading.  But we use the B term in "glob(B,A)".
4429a43fa227Sdrh       */
443059155065Sdrh       if( nFarg>=2 && ExprHasProperty(pExpr, EP_InfixFunc) ){
443112ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[1].pExpr);
443212ffee8cSdrh       }else if( nFarg>0 ){
443312ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[0].pExpr);
4434b7f6f68fSdrh       }
4435b7f6f68fSdrh #endif
4436d36e1041Sdrh       if( pDef->funcFlags & SQLITE_FUNC_NEEDCOLL ){
44378b213899Sdrh         if( !pColl ) pColl = db->pDfltColl;
443866a5167bSdrh         sqlite3VdbeAddOp4(v, OP_CollSeq, 0, 0, 0, (char *)pColl, P4_COLLSEQ);
4439682f68b0Sdanielk1977       }
4440092457b1Sdrh #ifdef SQLITE_ENABLE_OFFSET_SQL_FUNC
44417d4c94bcSdrh       if( (pDef->funcFlags & SQLITE_FUNC_OFFSET)!=0 && ALWAYS(pFarg!=0) ){
44422fc865c1Sdrh         Expr *pArg = pFarg->a[0].pExpr;
44432fc865c1Sdrh         if( pArg->op==TK_COLUMN ){
4444092457b1Sdrh           sqlite3VdbeAddOp3(v, OP_Offset, pArg->iTable, pArg->iColumn, target);
44452fc865c1Sdrh         }else{
44462fc865c1Sdrh           sqlite3VdbeAddOp2(v, OP_Null, 0, target);
44472fc865c1Sdrh         }
4448092457b1Sdrh       }else
4449092457b1Sdrh #endif
4450092457b1Sdrh       {
4451920cf596Sdrh         sqlite3VdbeAddFunctionCall(pParse, constMask, r1, target, nFarg,
445220cee7d0Sdrh                                    pDef, pExpr->op2);
44532fc865c1Sdrh       }
445413d79502Sdrh       if( nFarg ){
445513d79502Sdrh         if( constMask==0 ){
445612ffee8cSdrh           sqlite3ReleaseTempRange(pParse, r1, nFarg);
445713d79502Sdrh         }else{
44583aef2fb1Sdrh           sqlite3VdbeReleaseRegisters(pParse, r1, nFarg, constMask, 1);
445913d79502Sdrh         }
44602dcef11bSdrh       }
4461c332cc30Sdrh       return target;
44626ec2733bSdrh     }
4463fe2093d7Sdrh #ifndef SQLITE_OMIT_SUBQUERY
4464fe2093d7Sdrh     case TK_EXISTS:
446519a775c2Sdrh     case TK_SELECT: {
44668da209b1Sdan       int nCol;
4467c5499befSdrh       testcase( op==TK_EXISTS );
4468c5499befSdrh       testcase( op==TK_SELECT );
4469d8d335d7Sdrh       if( pParse->db->mallocFailed ){
4470d8d335d7Sdrh         return 0;
4471a4eeccdfSdrh       }else if( op==TK_SELECT
4472a4eeccdfSdrh              && ALWAYS( ExprUseXSelect(pExpr) )
4473a4eeccdfSdrh              && (nCol = pExpr->x.pSelect->pEList->nExpr)!=1
4474a4eeccdfSdrh       ){
44758da209b1Sdan         sqlite3SubselectError(pParse, nCol, 1);
44768da209b1Sdan       }else{
447785bcdce2Sdrh         return sqlite3CodeSubselect(pParse, pExpr);
44788da209b1Sdan       }
447919a775c2Sdrh       break;
448019a775c2Sdrh     }
4481fc7f27b9Sdrh     case TK_SELECT_COLUMN: {
4482966e2911Sdrh       int n;
4483fc7f27b9Sdrh       if( pExpr->pLeft->iTable==0 ){
448485bcdce2Sdrh         pExpr->pLeft->iTable = sqlite3CodeSubselect(pParse, pExpr->pLeft);
4485fc7f27b9Sdrh       }
448610f08270Sdrh       assert( pExpr->pLeft->op==TK_SELECT || pExpr->pLeft->op==TK_ERROR );
448710f08270Sdrh       n = sqlite3ExprVectorSize(pExpr->pLeft);
448810f08270Sdrh       if( pExpr->iTable!=n ){
4489966e2911Sdrh         sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
4490966e2911Sdrh                                 pExpr->iTable, n);
4491966e2911Sdrh       }
4492c332cc30Sdrh       return pExpr->pLeft->iTable + pExpr->iColumn;
4493fc7f27b9Sdrh     }
4494fef5208cSdrh     case TK_IN: {
4495ec4ccdbcSdrh       int destIfFalse = sqlite3VdbeMakeLabel(pParse);
4496ec4ccdbcSdrh       int destIfNull = sqlite3VdbeMakeLabel(pParse);
4497e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
4498e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
449966ba23ceSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
4500e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
4501e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_AddImm, target, 0);
4502e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfNull);
4503c332cc30Sdrh       return target;
4504fef5208cSdrh     }
4505e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
4506e3365e6cSdrh 
4507e3365e6cSdrh 
45082dcef11bSdrh     /*
45092dcef11bSdrh     **    x BETWEEN y AND z
45102dcef11bSdrh     **
45112dcef11bSdrh     ** This is equivalent to
45122dcef11bSdrh     **
45132dcef11bSdrh     **    x>=y AND x<=z
45142dcef11bSdrh     **
45152dcef11bSdrh     ** X is stored in pExpr->pLeft.
45162dcef11bSdrh     ** Y is stored in pExpr->pList->a[0].pExpr.
45172dcef11bSdrh     ** Z is stored in pExpr->pList->a[1].pExpr.
45182dcef11bSdrh     */
4519fef5208cSdrh     case TK_BETWEEN: {
452071c57db0Sdan       exprCodeBetween(pParse, pExpr, target, 0, 0);
4521c332cc30Sdrh       return target;
4522fef5208cSdrh     }
452394fa9c41Sdrh     case TK_SPAN:
4524ae80ddeaSdrh     case TK_COLLATE:
45254f07e5fbSdrh     case TK_UPLUS: {
45261efa8023Sdrh       pExpr = pExpr->pLeft;
452759ee43a7Sdrh       goto expr_code_doover; /* 2018-04-28: Prevent deep recursion. OSSFuzz. */
4528a2e00042Sdrh     }
45292dcef11bSdrh 
4530165921a7Sdan     case TK_TRIGGER: {
453165a7cd16Sdan       /* If the opcode is TK_TRIGGER, then the expression is a reference
453265a7cd16Sdan       ** to a column in the new.* or old.* pseudo-tables available to
453365a7cd16Sdan       ** trigger programs. In this case Expr.iTable is set to 1 for the
453465a7cd16Sdan       ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
453565a7cd16Sdan       ** is set to the column of the pseudo-table to read, or to -1 to
453665a7cd16Sdan       ** read the rowid field.
453765a7cd16Sdan       **
453865a7cd16Sdan       ** The expression is implemented using an OP_Param opcode. The p1
453965a7cd16Sdan       ** parameter is set to 0 for an old.rowid reference, or to (i+1)
454065a7cd16Sdan       ** to reference another column of the old.* pseudo-table, where
454165a7cd16Sdan       ** i is the index of the column. For a new.rowid reference, p1 is
454265a7cd16Sdan       ** set to (n+1), where n is the number of columns in each pseudo-table.
454365a7cd16Sdan       ** For a reference to any other column in the new.* pseudo-table, p1
454465a7cd16Sdan       ** is set to (n+2+i), where n and i are as defined previously. For
454565a7cd16Sdan       ** example, if the table on which triggers are being fired is
454665a7cd16Sdan       ** declared as:
454765a7cd16Sdan       **
454865a7cd16Sdan       **   CREATE TABLE t1(a, b);
454965a7cd16Sdan       **
455065a7cd16Sdan       ** Then p1 is interpreted as follows:
455165a7cd16Sdan       **
455265a7cd16Sdan       **   p1==0   ->    old.rowid     p1==3   ->    new.rowid
455365a7cd16Sdan       **   p1==1   ->    old.a         p1==4   ->    new.a
455465a7cd16Sdan       **   p1==2   ->    old.b         p1==5   ->    new.b
455565a7cd16Sdan       */
4556477572b9Sdrh       Table *pTab;
4557477572b9Sdrh       int iCol;
4558477572b9Sdrh       int p1;
4559477572b9Sdrh 
4560477572b9Sdrh       assert( ExprUseYTab(pExpr) );
4561477572b9Sdrh       pTab = pExpr->y.pTab;
4562477572b9Sdrh       iCol = pExpr->iColumn;
4563477572b9Sdrh       p1 = pExpr->iTable * (pTab->nCol+1) + 1
45647fe2fc0dSdrh                      + sqlite3TableColumnToStorage(pTab, iCol);
456565a7cd16Sdan 
456665a7cd16Sdan       assert( pExpr->iTable==0 || pExpr->iTable==1 );
4567dd6cc9b5Sdrh       assert( iCol>=-1 && iCol<pTab->nCol );
4568dd6cc9b5Sdrh       assert( pTab->iPKey<0 || iCol!=pTab->iPKey );
456965a7cd16Sdan       assert( p1>=0 && p1<(pTab->nCol*2+2) );
457065a7cd16Sdan 
457165a7cd16Sdan       sqlite3VdbeAddOp2(v, OP_Param, p1, target);
4572896494e8Sdrh       VdbeComment((v, "r[%d]=%s.%s", target,
4573165921a7Sdan         (pExpr->iTable ? "new" : "old"),
4574cf9d36d1Sdrh         (pExpr->iColumn<0 ? "rowid" : pExpr->y.pTab->aCol[iCol].zCnName)
4575165921a7Sdan       ));
457665a7cd16Sdan 
457744dbca83Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
457865a7cd16Sdan       /* If the column has REAL affinity, it may currently be stored as an
4579113762a2Sdrh       ** integer. Use OP_RealAffinity to make sure it is really real.
4580113762a2Sdrh       **
4581113762a2Sdrh       ** EVIDENCE-OF: R-60985-57662 SQLite will convert the value back to
4582113762a2Sdrh       ** floating point when extracting it from the record.  */
4583dd6cc9b5Sdrh       if( iCol>=0 && pTab->aCol[iCol].affinity==SQLITE_AFF_REAL ){
45842832ad42Sdan         sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
45852832ad42Sdan       }
458644dbca83Sdrh #endif
4587165921a7Sdan       break;
4588165921a7Sdan     }
4589165921a7Sdan 
459071c57db0Sdan     case TK_VECTOR: {
4591e835bc12Sdrh       sqlite3ErrorMsg(pParse, "row value misused");
459271c57db0Sdan       break;
459371c57db0Sdan     }
459471c57db0Sdan 
45959e9a67adSdrh     /* TK_IF_NULL_ROW Expr nodes are inserted ahead of expressions
45969e9a67adSdrh     ** that derive from the right-hand table of a LEFT JOIN.  The
45979e9a67adSdrh     ** Expr.iTable value is the table number for the right-hand table.
45989e9a67adSdrh     ** The expression is only evaluated if that table is not currently
45999e9a67adSdrh     ** on a LEFT JOIN NULL row.
46009e9a67adSdrh     */
460131d6fd55Sdrh     case TK_IF_NULL_ROW: {
460231d6fd55Sdrh       int addrINR;
46039e9a67adSdrh       u8 okConstFactor = pParse->okConstFactor;
460431d6fd55Sdrh       addrINR = sqlite3VdbeAddOp1(v, OP_IfNullRow, pExpr->iTable);
46059e9a67adSdrh       /* Temporarily disable factoring of constant expressions, since
46069e9a67adSdrh       ** even though expressions may appear to be constant, they are not
46079e9a67adSdrh       ** really constant because they originate from the right-hand side
46089e9a67adSdrh       ** of a LEFT JOIN. */
46099e9a67adSdrh       pParse->okConstFactor = 0;
461031d6fd55Sdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
46119e9a67adSdrh       pParse->okConstFactor = okConstFactor;
461231d6fd55Sdrh       sqlite3VdbeJumpHere(v, addrINR);
461331d6fd55Sdrh       sqlite3VdbeChangeP3(v, addrINR, inReg);
461431d6fd55Sdrh       break;
461531d6fd55Sdrh     }
461631d6fd55Sdrh 
46172dcef11bSdrh     /*
46182dcef11bSdrh     ** Form A:
46192dcef11bSdrh     **   CASE x WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
46202dcef11bSdrh     **
46212dcef11bSdrh     ** Form B:
46222dcef11bSdrh     **   CASE WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
46232dcef11bSdrh     **
46242dcef11bSdrh     ** Form A is can be transformed into the equivalent form B as follows:
46252dcef11bSdrh     **   CASE WHEN x=e1 THEN r1 WHEN x=e2 THEN r2 ...
46262dcef11bSdrh     **        WHEN x=eN THEN rN ELSE y END
46272dcef11bSdrh     **
46282dcef11bSdrh     ** X (if it exists) is in pExpr->pLeft.
4629c5cd1249Sdrh     ** Y is in the last element of pExpr->x.pList if pExpr->x.pList->nExpr is
4630c5cd1249Sdrh     ** odd.  The Y is also optional.  If the number of elements in x.pList
4631c5cd1249Sdrh     ** is even, then Y is omitted and the "otherwise" result is NULL.
46322dcef11bSdrh     ** Ei is in pExpr->pList->a[i*2] and Ri is pExpr->pList->a[i*2+1].
46332dcef11bSdrh     **
46342dcef11bSdrh     ** The result of the expression is the Ri for the first matching Ei,
46352dcef11bSdrh     ** or if there is no matching Ei, the ELSE term Y, or if there is
46362dcef11bSdrh     ** no ELSE term, NULL.
46372dcef11bSdrh     */
4638aac30f9bSdrh     case TK_CASE: {
46392dcef11bSdrh       int endLabel;                     /* GOTO label for end of CASE stmt */
46402dcef11bSdrh       int nextCase;                     /* GOTO label for next WHEN clause */
46412dcef11bSdrh       int nExpr;                        /* 2x number of WHEN terms */
46422dcef11bSdrh       int i;                            /* Loop counter */
46432dcef11bSdrh       ExprList *pEList;                 /* List of WHEN terms */
46442dcef11bSdrh       struct ExprList_item *aListelem;  /* Array of WHEN terms */
46452dcef11bSdrh       Expr opCompare;                   /* The X==Ei expression */
46462dcef11bSdrh       Expr *pX;                         /* The X expression */
46471bd10f8aSdrh       Expr *pTest = 0;                  /* X==Ei (form A) or just Ei (form B) */
46488b65e591Sdan       Expr *pDel = 0;
46498b65e591Sdan       sqlite3 *db = pParse->db;
465017a7f8ddSdrh 
4651a4eeccdfSdrh       assert( ExprUseXList(pExpr) && pExpr->x.pList!=0 );
46526ab3a2ecSdanielk1977       assert(pExpr->x.pList->nExpr > 0);
46536ab3a2ecSdanielk1977       pEList = pExpr->x.pList;
4654be5c89acSdrh       aListelem = pEList->a;
4655be5c89acSdrh       nExpr = pEList->nExpr;
4656ec4ccdbcSdrh       endLabel = sqlite3VdbeMakeLabel(pParse);
46572dcef11bSdrh       if( (pX = pExpr->pLeft)!=0 ){
46588b65e591Sdan         pDel = sqlite3ExprDup(db, pX, 0);
46598b65e591Sdan         if( db->mallocFailed ){
46608b65e591Sdan           sqlite3ExprDelete(db, pDel);
46618b65e591Sdan           break;
46628b65e591Sdan         }
466333cd4909Sdrh         testcase( pX->op==TK_COLUMN );
46648b65e591Sdan         exprToRegister(pDel, exprCodeVector(pParse, pDel, &regFree1));
4665c5499befSdrh         testcase( regFree1==0 );
4666abb9d5f1Sdrh         memset(&opCompare, 0, sizeof(opCompare));
46672dcef11bSdrh         opCompare.op = TK_EQ;
46688b65e591Sdan         opCompare.pLeft = pDel;
46692dcef11bSdrh         pTest = &opCompare;
46708b1db07fSdrh         /* Ticket b351d95f9cd5ef17e9d9dbae18f5ca8611190001:
46718b1db07fSdrh         ** The value in regFree1 might get SCopy-ed into the file result.
46728b1db07fSdrh         ** So make sure that the regFree1 register is not reused for other
46738b1db07fSdrh         ** purposes and possibly overwritten.  */
46748b1db07fSdrh         regFree1 = 0;
4675cce7d176Sdrh       }
4676c5cd1249Sdrh       for(i=0; i<nExpr-1; i=i+2){
46772dcef11bSdrh         if( pX ){
46781bd10f8aSdrh           assert( pTest!=0 );
46792dcef11bSdrh           opCompare.pRight = aListelem[i].pExpr;
4680f5905aa7Sdrh         }else{
46812dcef11bSdrh           pTest = aListelem[i].pExpr;
468217a7f8ddSdrh         }
4683ec4ccdbcSdrh         nextCase = sqlite3VdbeMakeLabel(pParse);
468433cd4909Sdrh         testcase( pTest->op==TK_COLUMN );
46852dcef11bSdrh         sqlite3ExprIfFalse(pParse, pTest, nextCase, SQLITE_JUMPIFNULL);
4686c5499befSdrh         testcase( aListelem[i+1].pExpr->op==TK_COLUMN );
46879de221dfSdrh         sqlite3ExprCode(pParse, aListelem[i+1].pExpr, target);
4688076e85f5Sdrh         sqlite3VdbeGoto(v, endLabel);
46892dcef11bSdrh         sqlite3VdbeResolveLabel(v, nextCase);
4690f570f011Sdrh       }
4691c5cd1249Sdrh       if( (nExpr&1)!=0 ){
4692c5cd1249Sdrh         sqlite3ExprCode(pParse, pEList->a[nExpr-1].pExpr, target);
469317a7f8ddSdrh       }else{
46949de221dfSdrh         sqlite3VdbeAddOp2(v, OP_Null, 0, target);
469517a7f8ddSdrh       }
46968b65e591Sdan       sqlite3ExprDelete(db, pDel);
469792a27f7bSdrh       setDoNotMergeFlagOnCopy(v);
46982dcef11bSdrh       sqlite3VdbeResolveLabel(v, endLabel);
46996f34903eSdanielk1977       break;
47006f34903eSdanielk1977     }
47015338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_TRIGGER
47026f34903eSdanielk1977     case TK_RAISE: {
47031194904bSdrh       assert( pExpr->affExpr==OE_Rollback
47041194904bSdrh            || pExpr->affExpr==OE_Abort
47051194904bSdrh            || pExpr->affExpr==OE_Fail
47061194904bSdrh            || pExpr->affExpr==OE_Ignore
4707165921a7Sdan       );
47089e5fdc41Sdrh       if( !pParse->pTriggerTab && !pParse->nested ){
4709e0af83acSdan         sqlite3ErrorMsg(pParse,
4710e0af83acSdan                        "RAISE() may only be used within a trigger-program");
4711e0af83acSdan         return 0;
4712e0af83acSdan       }
47131194904bSdrh       if( pExpr->affExpr==OE_Abort ){
4714e0af83acSdan         sqlite3MayAbort(pParse);
4715e0af83acSdan       }
471633e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
47171194904bSdrh       if( pExpr->affExpr==OE_Ignore ){
4718e0af83acSdan         sqlite3VdbeAddOp4(
4719e0af83acSdan             v, OP_Halt, SQLITE_OK, OE_Ignore, 0, pExpr->u.zToken,0);
4720688852abSdrh         VdbeCoverage(v);
4721e0af83acSdan       }else{
47229e5fdc41Sdrh         sqlite3HaltConstraint(pParse,
47239e5fdc41Sdrh              pParse->pTriggerTab ? SQLITE_CONSTRAINT_TRIGGER : SQLITE_ERROR,
47241194904bSdrh              pExpr->affExpr, pExpr->u.zToken, 0, 0);
4725e0af83acSdan       }
4726e0af83acSdan 
4727ffe07b2dSdrh       break;
472817a7f8ddSdrh     }
47295338a5f7Sdanielk1977 #endif
4730ffe07b2dSdrh   }
47312dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
47322dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
47332dcef11bSdrh   return inReg;
47345b6afba9Sdrh }
47352dcef11bSdrh 
47362dcef11bSdrh /*
47379b258c54Sdrh ** Generate code that will evaluate expression pExpr just one time
47389b258c54Sdrh ** per prepared statement execution.
47399b258c54Sdrh **
47409b258c54Sdrh ** If the expression uses functions (that might throw an exception) then
47419b258c54Sdrh ** guard them with an OP_Once opcode to ensure that the code is only executed
47429b258c54Sdrh ** once. If no functions are involved, then factor the code out and put it at
47439b258c54Sdrh ** the end of the prepared statement in the initialization section.
47441e9b53f9Sdrh **
4745ad879ffdSdrh ** If regDest>=0 then the result is always stored in that register and the
4746ad879ffdSdrh ** result is not reusable.  If regDest<0 then this routine is free to
4747ad879ffdSdrh ** store the value whereever it wants.  The register where the expression
47489b258c54Sdrh ** is stored is returned.  When regDest<0, two identical expressions might
47499b258c54Sdrh ** code to the same register, if they do not contain function calls and hence
47509b258c54Sdrh ** are factored out into the initialization section at the end of the
47519b258c54Sdrh ** prepared statement.
4752d1a01edaSdrh */
47539b258c54Sdrh int sqlite3ExprCodeRunJustOnce(
4754d673cddaSdrh   Parse *pParse,    /* Parsing context */
4755d673cddaSdrh   Expr *pExpr,      /* The expression to code when the VDBE initializes */
4756ad879ffdSdrh   int regDest       /* Store the value in this register */
4757d673cddaSdrh ){
4758d1a01edaSdrh   ExprList *p;
4759d9f158e7Sdrh   assert( ConstFactorOk(pParse) );
4760d1a01edaSdrh   p = pParse->pConstExpr;
4761ad879ffdSdrh   if( regDest<0 && p ){
47621e9b53f9Sdrh     struct ExprList_item *pItem;
47631e9b53f9Sdrh     int i;
47641e9b53f9Sdrh     for(pItem=p->a, i=p->nExpr; i>0; pItem++, i--){
47655aa550cfSdan       if( pItem->reusable && sqlite3ExprCompare(0,pItem->pExpr,pExpr,-1)==0 ){
47661e9b53f9Sdrh         return pItem->u.iConstExprReg;
47671e9b53f9Sdrh       }
47681e9b53f9Sdrh     }
47691e9b53f9Sdrh   }
4770d1a01edaSdrh   pExpr = sqlite3ExprDup(pParse->db, pExpr, 0);
477138dfbdaeSdrh   if( pExpr!=0 && ExprHasProperty(pExpr, EP_HasFunc) ){
477238dfbdaeSdrh     Vdbe *v = pParse->pVdbe;
477338dfbdaeSdrh     int addr;
477438dfbdaeSdrh     assert( v );
477538dfbdaeSdrh     addr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
477638dfbdaeSdrh     pParse->okConstFactor = 0;
477738dfbdaeSdrh     if( !pParse->db->mallocFailed ){
47789b258c54Sdrh       if( regDest<0 ) regDest = ++pParse->nMem;
477938dfbdaeSdrh       sqlite3ExprCode(pParse, pExpr, regDest);
478038dfbdaeSdrh     }
478138dfbdaeSdrh     pParse->okConstFactor = 1;
478238dfbdaeSdrh     sqlite3ExprDelete(pParse->db, pExpr);
478338dfbdaeSdrh     sqlite3VdbeJumpHere(v, addr);
478438dfbdaeSdrh   }else{
4785d1a01edaSdrh     p = sqlite3ExprListAppend(pParse, p, pExpr);
4786d673cddaSdrh     if( p ){
4787d673cddaSdrh        struct ExprList_item *pItem = &p->a[p->nExpr-1];
4788ad879ffdSdrh        pItem->reusable = regDest<0;
47899b258c54Sdrh        if( regDest<0 ) regDest = ++pParse->nMem;
4790d673cddaSdrh        pItem->u.iConstExprReg = regDest;
4791d673cddaSdrh     }
4792d1a01edaSdrh     pParse->pConstExpr = p;
479338dfbdaeSdrh   }
47941e9b53f9Sdrh   return regDest;
4795d1a01edaSdrh }
4796d1a01edaSdrh 
4797d1a01edaSdrh /*
47982dcef11bSdrh ** Generate code to evaluate an expression and store the results
47992dcef11bSdrh ** into a register.  Return the register number where the results
48002dcef11bSdrh ** are stored.
48012dcef11bSdrh **
48022dcef11bSdrh ** If the register is a temporary register that can be deallocated,
4803678ccce8Sdrh ** then write its number into *pReg.  If the result register is not
48042dcef11bSdrh ** a temporary, then set *pReg to zero.
4805f30a969bSdrh **
4806f30a969bSdrh ** If pExpr is a constant, then this routine might generate this
4807f30a969bSdrh ** code to fill the register in the initialization section of the
4808f30a969bSdrh ** VDBE program, in order to factor it out of the evaluation loop.
48092dcef11bSdrh */
48102dcef11bSdrh int sqlite3ExprCodeTemp(Parse *pParse, Expr *pExpr, int *pReg){
4811f30a969bSdrh   int r2;
48120d950af3Sdrh   pExpr = sqlite3ExprSkipCollateAndLikely(pExpr);
4813d9f158e7Sdrh   if( ConstFactorOk(pParse)
4814235667a8Sdrh    && ALWAYS(pExpr!=0)
4815f30a969bSdrh    && pExpr->op!=TK_REGISTER
4816f30a969bSdrh    && sqlite3ExprIsConstantNotJoin(pExpr)
4817f30a969bSdrh   ){
4818f30a969bSdrh     *pReg  = 0;
48199b258c54Sdrh     r2 = sqlite3ExprCodeRunJustOnce(pParse, pExpr, -1);
4820f30a969bSdrh   }else{
48212dcef11bSdrh     int r1 = sqlite3GetTempReg(pParse);
4822f30a969bSdrh     r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
48232dcef11bSdrh     if( r2==r1 ){
48242dcef11bSdrh       *pReg = r1;
48252dcef11bSdrh     }else{
48262dcef11bSdrh       sqlite3ReleaseTempReg(pParse, r1);
48272dcef11bSdrh       *pReg = 0;
48282dcef11bSdrh     }
4829f30a969bSdrh   }
48302dcef11bSdrh   return r2;
48312dcef11bSdrh }
48322dcef11bSdrh 
48332dcef11bSdrh /*
48342dcef11bSdrh ** Generate code that will evaluate expression pExpr and store the
48352dcef11bSdrh ** results in register target.  The results are guaranteed to appear
48362dcef11bSdrh ** in register target.
48372dcef11bSdrh */
483805a86c5cSdrh void sqlite3ExprCode(Parse *pParse, Expr *pExpr, int target){
48399cbf3425Sdrh   int inReg;
48409cbf3425Sdrh 
4841e7375bfaSdrh   assert( pExpr==0 || !ExprHasVVAProperty(pExpr,EP_Immutable) );
48429cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
48431c75c9d7Sdrh   assert( pParse->pVdbe!=0 || pParse->db->mallocFailed );
4844b639a209Sdrh   if( pParse->pVdbe==0 ) return;
4845b639a209Sdrh   inReg = sqlite3ExprCodeTarget(pParse, pExpr, target);
4846b639a209Sdrh   if( inReg!=target ){
4847629b88c6Sdrh     u8 op;
4848952f35b2Sdrh     if( ALWAYS(pExpr) && ExprHasProperty(pExpr,EP_Subquery) ){
4849629b88c6Sdrh       op = OP_Copy;
4850629b88c6Sdrh     }else{
4851629b88c6Sdrh       op = OP_SCopy;
4852629b88c6Sdrh     }
4853629b88c6Sdrh     sqlite3VdbeAddOp2(pParse->pVdbe, op, inReg, target);
485417a7f8ddSdrh   }
4855ebc16717Sdrh }
4856cce7d176Sdrh 
4857cce7d176Sdrh /*
48581c75c9d7Sdrh ** Make a transient copy of expression pExpr and then code it using
48591c75c9d7Sdrh ** sqlite3ExprCode().  This routine works just like sqlite3ExprCode()
48601c75c9d7Sdrh ** except that the input expression is guaranteed to be unchanged.
48611c75c9d7Sdrh */
48621c75c9d7Sdrh void sqlite3ExprCodeCopy(Parse *pParse, Expr *pExpr, int target){
48631c75c9d7Sdrh   sqlite3 *db = pParse->db;
48641c75c9d7Sdrh   pExpr = sqlite3ExprDup(db, pExpr, 0);
48651c75c9d7Sdrh   if( !db->mallocFailed ) sqlite3ExprCode(pParse, pExpr, target);
48661c75c9d7Sdrh   sqlite3ExprDelete(db, pExpr);
48671c75c9d7Sdrh }
48681c75c9d7Sdrh 
48691c75c9d7Sdrh /*
487005a86c5cSdrh ** Generate code that will evaluate expression pExpr and store the
487105a86c5cSdrh ** results in register target.  The results are guaranteed to appear
487205a86c5cSdrh ** in register target.  If the expression is constant, then this routine
487305a86c5cSdrh ** might choose to code the expression at initialization time.
487405a86c5cSdrh */
487505a86c5cSdrh void sqlite3ExprCodeFactorable(Parse *pParse, Expr *pExpr, int target){
4876b8b06690Sdrh   if( pParse->okConstFactor && sqlite3ExprIsConstantNotJoin(pExpr) ){
48779b258c54Sdrh     sqlite3ExprCodeRunJustOnce(pParse, pExpr, target);
487805a86c5cSdrh   }else{
4879088489e8Sdrh     sqlite3ExprCodeCopy(pParse, pExpr, target);
488005a86c5cSdrh   }
4881cce7d176Sdrh }
4882cce7d176Sdrh 
4883cce7d176Sdrh /*
4884268380caSdrh ** Generate code that pushes the value of every element of the given
48859cbf3425Sdrh ** expression list into a sequence of registers beginning at target.
4886268380caSdrh **
48873df6c3b1Sdrh ** Return the number of elements evaluated.  The number returned will
48883df6c3b1Sdrh ** usually be pList->nExpr but might be reduced if SQLITE_ECEL_OMITREF
48893df6c3b1Sdrh ** is defined.
4890d1a01edaSdrh **
4891d1a01edaSdrh ** The SQLITE_ECEL_DUP flag prevents the arguments from being
4892d1a01edaSdrh ** filled using OP_SCopy.  OP_Copy must be used instead.
4893d1a01edaSdrh **
4894d1a01edaSdrh ** The SQLITE_ECEL_FACTOR argument allows constant arguments to be
4895d1a01edaSdrh ** factored out into initialization code.
4896b0df9634Sdrh **
4897b0df9634Sdrh ** The SQLITE_ECEL_REF flag means that expressions in the list with
4898b0df9634Sdrh ** ExprList.a[].u.x.iOrderByCol>0 have already been evaluated and stored
4899b0df9634Sdrh ** in registers at srcReg, and so the value can be copied from there.
49003df6c3b1Sdrh ** If SQLITE_ECEL_OMITREF is also set, then the values with u.x.iOrderByCol>0
49013df6c3b1Sdrh ** are simply omitted rather than being copied from srcReg.
4902268380caSdrh */
49034adee20fSdanielk1977 int sqlite3ExprCodeExprList(
4904268380caSdrh   Parse *pParse,     /* Parsing context */
4905389a1adbSdrh   ExprList *pList,   /* The expression list to be coded */
4906191b54cbSdrh   int target,        /* Where to write results */
49075579d59fSdrh   int srcReg,        /* Source registers if SQLITE_ECEL_REF */
4908d1a01edaSdrh   u8 flags           /* SQLITE_ECEL_* flags */
4909268380caSdrh ){
4910268380caSdrh   struct ExprList_item *pItem;
49115579d59fSdrh   int i, j, n;
4912d1a01edaSdrh   u8 copyOp = (flags & SQLITE_ECEL_DUP) ? OP_Copy : OP_SCopy;
49135579d59fSdrh   Vdbe *v = pParse->pVdbe;
49149d8b3072Sdrh   assert( pList!=0 );
49159cbf3425Sdrh   assert( target>0 );
4916d81a142bSdrh   assert( pParse->pVdbe!=0 );  /* Never gets this far otherwise */
4917268380caSdrh   n = pList->nExpr;
4918d9f158e7Sdrh   if( !ConstFactorOk(pParse) ) flags &= ~SQLITE_ECEL_FACTOR;
4919191b54cbSdrh   for(pItem=pList->a, i=0; i<n; i++, pItem++){
49207445ffe2Sdrh     Expr *pExpr = pItem->pExpr;
492124e25d32Sdan #ifdef SQLITE_ENABLE_SORTER_REFERENCES
492224e25d32Sdan     if( pItem->bSorterRef ){
492324e25d32Sdan       i--;
492424e25d32Sdan       n--;
492524e25d32Sdan     }else
492624e25d32Sdan #endif
4927257c13faSdan     if( (flags & SQLITE_ECEL_REF)!=0 && (j = pItem->u.x.iOrderByCol)>0 ){
4928257c13faSdan       if( flags & SQLITE_ECEL_OMITREF ){
4929257c13faSdan         i--;
4930257c13faSdan         n--;
4931257c13faSdan       }else{
49325579d59fSdrh         sqlite3VdbeAddOp2(v, copyOp, j+srcReg-1, target+i);
4933257c13faSdan       }
4934b8b06690Sdrh     }else if( (flags & SQLITE_ECEL_FACTOR)!=0
4935b8b06690Sdrh            && sqlite3ExprIsConstantNotJoin(pExpr)
4936b8b06690Sdrh     ){
49379b258c54Sdrh       sqlite3ExprCodeRunJustOnce(pParse, pExpr, target+i);
4938d1a01edaSdrh     }else{
49397445ffe2Sdrh       int inReg = sqlite3ExprCodeTarget(pParse, pExpr, target+i);
4940746fd9ccSdrh       if( inReg!=target+i ){
49414eded604Sdrh         VdbeOp *pOp;
49424eded604Sdrh         if( copyOp==OP_Copy
49434eded604Sdrh          && (pOp=sqlite3VdbeGetOp(v, -1))->opcode==OP_Copy
49444eded604Sdrh          && pOp->p1+pOp->p3+1==inReg
49454eded604Sdrh          && pOp->p2+pOp->p3+1==target+i
494690996885Sdrh          && pOp->p5==0  /* The do-not-merge flag must be clear */
49474eded604Sdrh         ){
49484eded604Sdrh           pOp->p3++;
49494eded604Sdrh         }else{
49504eded604Sdrh           sqlite3VdbeAddOp2(v, copyOp, inReg, target+i);
49514eded604Sdrh         }
4952d1a01edaSdrh       }
4953d176611bSdrh     }
4954268380caSdrh   }
4955f9b596ebSdrh   return n;
4956268380caSdrh }
4957268380caSdrh 
4958268380caSdrh /*
495936c563a2Sdrh ** Generate code for a BETWEEN operator.
496036c563a2Sdrh **
496136c563a2Sdrh **    x BETWEEN y AND z
496236c563a2Sdrh **
496336c563a2Sdrh ** The above is equivalent to
496436c563a2Sdrh **
496536c563a2Sdrh **    x>=y AND x<=z
496636c563a2Sdrh **
496736c563a2Sdrh ** Code it as such, taking care to do the common subexpression
496860ec914cSpeter.d.reid ** elimination of x.
496984b19a3dSdrh **
497084b19a3dSdrh ** The xJumpIf parameter determines details:
497184b19a3dSdrh **
497284b19a3dSdrh **    NULL:                   Store the boolean result in reg[dest]
497384b19a3dSdrh **    sqlite3ExprIfTrue:      Jump to dest if true
497484b19a3dSdrh **    sqlite3ExprIfFalse:     Jump to dest if false
497584b19a3dSdrh **
497684b19a3dSdrh ** The jumpIfNull parameter is ignored if xJumpIf is NULL.
497736c563a2Sdrh */
497836c563a2Sdrh static void exprCodeBetween(
497936c563a2Sdrh   Parse *pParse,    /* Parsing and code generating context */
498036c563a2Sdrh   Expr *pExpr,      /* The BETWEEN expression */
498184b19a3dSdrh   int dest,         /* Jump destination or storage location */
498284b19a3dSdrh   void (*xJump)(Parse*,Expr*,int,int), /* Action to take */
498336c563a2Sdrh   int jumpIfNull    /* Take the jump if the BETWEEN is NULL */
498436c563a2Sdrh ){
498536c563a2Sdrh   Expr exprAnd;     /* The AND operator in  x>=y AND x<=z  */
498636c563a2Sdrh   Expr compLeft;    /* The  x>=y  term */
498736c563a2Sdrh   Expr compRight;   /* The  x<=z  term */
4988db45bd5eSdrh   int regFree1 = 0; /* Temporary use register */
49898b65e591Sdan   Expr *pDel = 0;
49908b65e591Sdan   sqlite3 *db = pParse->db;
499184b19a3dSdrh 
499271c57db0Sdan   memset(&compLeft, 0, sizeof(Expr));
499371c57db0Sdan   memset(&compRight, 0, sizeof(Expr));
499471c57db0Sdan   memset(&exprAnd, 0, sizeof(Expr));
4995db45bd5eSdrh 
4996a4eeccdfSdrh   assert( ExprUseXList(pExpr) );
49978b65e591Sdan   pDel = sqlite3ExprDup(db, pExpr->pLeft, 0);
49988b65e591Sdan   if( db->mallocFailed==0 ){
499936c563a2Sdrh     exprAnd.op = TK_AND;
500036c563a2Sdrh     exprAnd.pLeft = &compLeft;
500136c563a2Sdrh     exprAnd.pRight = &compRight;
500236c563a2Sdrh     compLeft.op = TK_GE;
50038b65e591Sdan     compLeft.pLeft = pDel;
500436c563a2Sdrh     compLeft.pRight = pExpr->x.pList->a[0].pExpr;
500536c563a2Sdrh     compRight.op = TK_LE;
50068b65e591Sdan     compRight.pLeft = pDel;
500736c563a2Sdrh     compRight.pRight = pExpr->x.pList->a[1].pExpr;
50088b65e591Sdan     exprToRegister(pDel, exprCodeVector(pParse, pDel, &regFree1));
500984b19a3dSdrh     if( xJump ){
501084b19a3dSdrh       xJump(pParse, &exprAnd, dest, jumpIfNull);
501136c563a2Sdrh     }else{
501236fd41e5Sdrh       /* Mark the expression is being from the ON or USING clause of a join
501336fd41e5Sdrh       ** so that the sqlite3ExprCodeTarget() routine will not attempt to move
501436fd41e5Sdrh       ** it into the Parse.pConstExpr list.  We should use a new bit for this,
501536fd41e5Sdrh       ** for clarity, but we are out of bits in the Expr.flags field so we
501636fd41e5Sdrh       ** have to reuse the EP_FromJoin bit.  Bummer. */
50178b65e591Sdan       pDel->flags |= EP_FromJoin;
501871c57db0Sdan       sqlite3ExprCodeTarget(pParse, &exprAnd, dest);
501936c563a2Sdrh     }
5020db45bd5eSdrh     sqlite3ReleaseTempReg(pParse, regFree1);
50218b65e591Sdan   }
50228b65e591Sdan   sqlite3ExprDelete(db, pDel);
502336c563a2Sdrh 
502436c563a2Sdrh   /* Ensure adequate test coverage */
5025db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull==0 && regFree1==0 );
5026db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull==0 && regFree1!=0 );
5027db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull!=0 && regFree1==0 );
5028db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull!=0 && regFree1!=0 );
5029db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1==0 );
5030db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1!=0 );
5031db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1==0 );
5032db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1!=0 );
503384b19a3dSdrh   testcase( xJump==0 );
503436c563a2Sdrh }
503536c563a2Sdrh 
503636c563a2Sdrh /*
5037cce7d176Sdrh ** Generate code for a boolean expression such that a jump is made
5038cce7d176Sdrh ** to the label "dest" if the expression is true but execution
5039cce7d176Sdrh ** continues straight thru if the expression is false.
5040f5905aa7Sdrh **
5041f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false), then
504235573356Sdrh ** take the jump if the jumpIfNull flag is SQLITE_JUMPIFNULL.
5043f2bc013cSdrh **
5044f2bc013cSdrh ** This code depends on the fact that certain token values (ex: TK_EQ)
5045f2bc013cSdrh ** are the same as opcode values (ex: OP_Eq) that implement the corresponding
5046f2bc013cSdrh ** operation.  Special comments in vdbe.c and the mkopcodeh.awk script in
5047f2bc013cSdrh ** the make process cause these values to align.  Assert()s in the code
5048f2bc013cSdrh ** below verify that the numbers are aligned correctly.
5049cce7d176Sdrh */
50504adee20fSdanielk1977 void sqlite3ExprIfTrue(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
5051cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
5052cce7d176Sdrh   int op = 0;
50532dcef11bSdrh   int regFree1 = 0;
50542dcef11bSdrh   int regFree2 = 0;
50552dcef11bSdrh   int r1, r2;
50562dcef11bSdrh 
505735573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
505848864df9Smistachkin   if( NEVER(v==0) )     return;  /* Existence of VDBE checked by caller */
505933cd4909Sdrh   if( NEVER(pExpr==0) ) return;  /* No way this can happen */
5060e7375bfaSdrh   assert( !ExprHasVVAProperty(pExpr, EP_Immutable) );
5061f2bc013cSdrh   op = pExpr->op;
50627b35a77bSdan   switch( op ){
506317180fcaSdrh     case TK_AND:
506417180fcaSdrh     case TK_OR: {
506517180fcaSdrh       Expr *pAlt = sqlite3ExprSimplifiedAndOr(pExpr);
506617180fcaSdrh       if( pAlt!=pExpr ){
506717180fcaSdrh         sqlite3ExprIfTrue(pParse, pAlt, dest, jumpIfNull);
506817180fcaSdrh       }else if( op==TK_AND ){
5069ec4ccdbcSdrh         int d2 = sqlite3VdbeMakeLabel(pParse);
5070c5499befSdrh         testcase( jumpIfNull==0 );
507117180fcaSdrh         sqlite3ExprIfFalse(pParse, pExpr->pLeft, d2,
507217180fcaSdrh                            jumpIfNull^SQLITE_JUMPIFNULL);
50734adee20fSdanielk1977         sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
50744adee20fSdanielk1977         sqlite3VdbeResolveLabel(v, d2);
507517180fcaSdrh       }else{
5076c5499befSdrh         testcase( jumpIfNull==0 );
50774adee20fSdanielk1977         sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
50784adee20fSdanielk1977         sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
507917180fcaSdrh       }
5080cce7d176Sdrh       break;
5081cce7d176Sdrh     }
5082cce7d176Sdrh     case TK_NOT: {
5083c5499befSdrh       testcase( jumpIfNull==0 );
50844adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
5085cce7d176Sdrh       break;
5086cce7d176Sdrh     }
50878abed7b9Sdrh     case TK_TRUTH: {
508896acafbeSdrh       int isNot;      /* IS NOT TRUE or IS NOT FALSE */
508996acafbeSdrh       int isTrue;     /* IS TRUE or IS NOT TRUE */
5090007c843bSdrh       testcase( jumpIfNull==0 );
50918abed7b9Sdrh       isNot = pExpr->op2==TK_ISNOT;
509296acafbeSdrh       isTrue = sqlite3ExprTruthValue(pExpr->pRight);
509343c4ac8bSdrh       testcase( isTrue && isNot );
509496acafbeSdrh       testcase( !isTrue && isNot );
509543c4ac8bSdrh       if( isTrue ^ isNot ){
50968abed7b9Sdrh         sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
50978abed7b9Sdrh                           isNot ? SQLITE_JUMPIFNULL : 0);
50988abed7b9Sdrh       }else{
50998abed7b9Sdrh         sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
51008abed7b9Sdrh                            isNot ? SQLITE_JUMPIFNULL : 0);
51018abed7b9Sdrh       }
5102007c843bSdrh       break;
5103007c843bSdrh     }
5104de845c2fSdrh     case TK_IS:
5105de845c2fSdrh     case TK_ISNOT:
5106de845c2fSdrh       testcase( op==TK_IS );
5107de845c2fSdrh       testcase( op==TK_ISNOT );
5108de845c2fSdrh       op = (op==TK_IS) ? TK_EQ : TK_NE;
5109de845c2fSdrh       jumpIfNull = SQLITE_NULLEQ;
511008b92086Sdrh       /* no break */ deliberate_fall_through
5111cce7d176Sdrh     case TK_LT:
5112cce7d176Sdrh     case TK_LE:
5113cce7d176Sdrh     case TK_GT:
5114cce7d176Sdrh     case TK_GE:
5115cce7d176Sdrh     case TK_NE:
51160ac65892Sdrh     case TK_EQ: {
5117625015e0Sdan       if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
5118c5499befSdrh       testcase( jumpIfNull==0 );
5119b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
5120b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
512135573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
5122898c527eSdrh                   r1, r2, dest, jumpIfNull, ExprHasProperty(pExpr,EP_Commuted));
51237d176105Sdrh       assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
51247d176105Sdrh       assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
51257d176105Sdrh       assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
51267d176105Sdrh       assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
5127de845c2fSdrh       assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
5128de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
5129de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
5130de845c2fSdrh       assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
5131de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
5132de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
51336a2fe093Sdrh       testcase( regFree1==0 );
51346a2fe093Sdrh       testcase( regFree2==0 );
51356a2fe093Sdrh       break;
51366a2fe093Sdrh     }
5137cce7d176Sdrh     case TK_ISNULL:
5138cce7d176Sdrh     case TK_NOTNULL: {
51397d176105Sdrh       assert( TK_ISNULL==OP_IsNull );   testcase( op==TK_ISNULL );
51407d176105Sdrh       assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
51412dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
51422dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
51437d176105Sdrh       VdbeCoverageIf(v, op==TK_ISNULL);
51447d176105Sdrh       VdbeCoverageIf(v, op==TK_NOTNULL);
5145c5499befSdrh       testcase( regFree1==0 );
5146cce7d176Sdrh       break;
5147cce7d176Sdrh     }
5148fef5208cSdrh     case TK_BETWEEN: {
51495c03f30aSdrh       testcase( jumpIfNull==0 );
515071c57db0Sdan       exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfTrue, jumpIfNull);
5151fef5208cSdrh       break;
5152fef5208cSdrh     }
5153bb201344Sshaneh #ifndef SQLITE_OMIT_SUBQUERY
5154e3365e6cSdrh     case TK_IN: {
5155ec4ccdbcSdrh       int destIfFalse = sqlite3VdbeMakeLabel(pParse);
5156e3365e6cSdrh       int destIfNull = jumpIfNull ? dest : destIfFalse;
5157e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
5158076e85f5Sdrh       sqlite3VdbeGoto(v, dest);
5159e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
5160e3365e6cSdrh       break;
5161e3365e6cSdrh     }
5162bb201344Sshaneh #endif
5163cce7d176Sdrh     default: {
51647b35a77bSdan     default_expr:
5165ad31727fSdrh       if( ExprAlwaysTrue(pExpr) ){
5166076e85f5Sdrh         sqlite3VdbeGoto(v, dest);
5167ad31727fSdrh       }else if( ExprAlwaysFalse(pExpr) ){
5168991a1985Sdrh         /* No-op */
5169991a1985Sdrh       }else{
51702dcef11bSdrh         r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
51712dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_If, r1, dest, jumpIfNull!=0);
5172688852abSdrh         VdbeCoverage(v);
5173c5499befSdrh         testcase( regFree1==0 );
5174c5499befSdrh         testcase( jumpIfNull==0 );
5175991a1985Sdrh       }
5176cce7d176Sdrh       break;
5177cce7d176Sdrh     }
5178cce7d176Sdrh   }
51792dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
51802dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
5181cce7d176Sdrh }
5182cce7d176Sdrh 
5183cce7d176Sdrh /*
518466b89c8fSdrh ** Generate code for a boolean expression such that a jump is made
5185cce7d176Sdrh ** to the label "dest" if the expression is false but execution
5186cce7d176Sdrh ** continues straight thru if the expression is true.
5187f5905aa7Sdrh **
5188f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false) then
518935573356Sdrh ** jump if jumpIfNull is SQLITE_JUMPIFNULL or fall through if jumpIfNull
519035573356Sdrh ** is 0.
5191cce7d176Sdrh */
51924adee20fSdanielk1977 void sqlite3ExprIfFalse(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
5193cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
5194cce7d176Sdrh   int op = 0;
51952dcef11bSdrh   int regFree1 = 0;
51962dcef11bSdrh   int regFree2 = 0;
51972dcef11bSdrh   int r1, r2;
51982dcef11bSdrh 
519935573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
520048864df9Smistachkin   if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
520133cd4909Sdrh   if( pExpr==0 )    return;
5202e7375bfaSdrh   assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
5203f2bc013cSdrh 
5204f2bc013cSdrh   /* The value of pExpr->op and op are related as follows:
5205f2bc013cSdrh   **
5206f2bc013cSdrh   **       pExpr->op            op
5207f2bc013cSdrh   **       ---------          ----------
5208f2bc013cSdrh   **       TK_ISNULL          OP_NotNull
5209f2bc013cSdrh   **       TK_NOTNULL         OP_IsNull
5210f2bc013cSdrh   **       TK_NE              OP_Eq
5211f2bc013cSdrh   **       TK_EQ              OP_Ne
5212f2bc013cSdrh   **       TK_GT              OP_Le
5213f2bc013cSdrh   **       TK_LE              OP_Gt
5214f2bc013cSdrh   **       TK_GE              OP_Lt
5215f2bc013cSdrh   **       TK_LT              OP_Ge
5216f2bc013cSdrh   **
5217f2bc013cSdrh   ** For other values of pExpr->op, op is undefined and unused.
5218f2bc013cSdrh   ** The value of TK_ and OP_ constants are arranged such that we
5219f2bc013cSdrh   ** can compute the mapping above using the following expression.
5220f2bc013cSdrh   ** Assert()s verify that the computation is correct.
5221f2bc013cSdrh   */
5222f2bc013cSdrh   op = ((pExpr->op+(TK_ISNULL&1))^1)-(TK_ISNULL&1);
5223f2bc013cSdrh 
5224f2bc013cSdrh   /* Verify correct alignment of TK_ and OP_ constants
5225f2bc013cSdrh   */
5226f2bc013cSdrh   assert( pExpr->op!=TK_ISNULL || op==OP_NotNull );
5227f2bc013cSdrh   assert( pExpr->op!=TK_NOTNULL || op==OP_IsNull );
5228f2bc013cSdrh   assert( pExpr->op!=TK_NE || op==OP_Eq );
5229f2bc013cSdrh   assert( pExpr->op!=TK_EQ || op==OP_Ne );
5230f2bc013cSdrh   assert( pExpr->op!=TK_LT || op==OP_Ge );
5231f2bc013cSdrh   assert( pExpr->op!=TK_LE || op==OP_Gt );
5232f2bc013cSdrh   assert( pExpr->op!=TK_GT || op==OP_Le );
5233f2bc013cSdrh   assert( pExpr->op!=TK_GE || op==OP_Lt );
5234f2bc013cSdrh 
5235ba00e30aSdan   switch( pExpr->op ){
523617180fcaSdrh     case TK_AND:
523717180fcaSdrh     case TK_OR: {
523817180fcaSdrh       Expr *pAlt = sqlite3ExprSimplifiedAndOr(pExpr);
523917180fcaSdrh       if( pAlt!=pExpr ){
524017180fcaSdrh         sqlite3ExprIfFalse(pParse, pAlt, dest, jumpIfNull);
524117180fcaSdrh       }else if( pExpr->op==TK_AND ){
5242c5499befSdrh         testcase( jumpIfNull==0 );
52434adee20fSdanielk1977         sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
52444adee20fSdanielk1977         sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
524517180fcaSdrh       }else{
5246ec4ccdbcSdrh         int d2 = sqlite3VdbeMakeLabel(pParse);
5247c5499befSdrh         testcase( jumpIfNull==0 );
524817180fcaSdrh         sqlite3ExprIfTrue(pParse, pExpr->pLeft, d2,
524917180fcaSdrh                           jumpIfNull^SQLITE_JUMPIFNULL);
52504adee20fSdanielk1977         sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
52514adee20fSdanielk1977         sqlite3VdbeResolveLabel(v, d2);
525217180fcaSdrh       }
5253cce7d176Sdrh       break;
5254cce7d176Sdrh     }
5255cce7d176Sdrh     case TK_NOT: {
52565c03f30aSdrh       testcase( jumpIfNull==0 );
52574adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
5258cce7d176Sdrh       break;
5259cce7d176Sdrh     }
52608abed7b9Sdrh     case TK_TRUTH: {
526196acafbeSdrh       int isNot;   /* IS NOT TRUE or IS NOT FALSE */
526296acafbeSdrh       int isTrue;  /* IS TRUE or IS NOT TRUE */
52638abed7b9Sdrh       testcase( jumpIfNull==0 );
52648abed7b9Sdrh       isNot = pExpr->op2==TK_ISNOT;
526596acafbeSdrh       isTrue = sqlite3ExprTruthValue(pExpr->pRight);
526643c4ac8bSdrh       testcase( isTrue && isNot );
526796acafbeSdrh       testcase( !isTrue && isNot );
526843c4ac8bSdrh       if( isTrue ^ isNot ){
52698abed7b9Sdrh         /* IS TRUE and IS NOT FALSE */
52708abed7b9Sdrh         sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
52718abed7b9Sdrh                            isNot ? 0 : SQLITE_JUMPIFNULL);
52728abed7b9Sdrh 
52738abed7b9Sdrh       }else{
52748abed7b9Sdrh         /* IS FALSE and IS NOT TRUE */
52758abed7b9Sdrh         sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
52768abed7b9Sdrh                           isNot ? 0 : SQLITE_JUMPIFNULL);
52778abed7b9Sdrh       }
5278007c843bSdrh       break;
5279007c843bSdrh     }
5280de845c2fSdrh     case TK_IS:
5281de845c2fSdrh     case TK_ISNOT:
5282de845c2fSdrh       testcase( pExpr->op==TK_IS );
5283de845c2fSdrh       testcase( pExpr->op==TK_ISNOT );
5284de845c2fSdrh       op = (pExpr->op==TK_IS) ? TK_NE : TK_EQ;
5285de845c2fSdrh       jumpIfNull = SQLITE_NULLEQ;
528608b92086Sdrh       /* no break */ deliberate_fall_through
5287cce7d176Sdrh     case TK_LT:
5288cce7d176Sdrh     case TK_LE:
5289cce7d176Sdrh     case TK_GT:
5290cce7d176Sdrh     case TK_GE:
5291cce7d176Sdrh     case TK_NE:
5292cce7d176Sdrh     case TK_EQ: {
5293625015e0Sdan       if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
5294c5499befSdrh       testcase( jumpIfNull==0 );
5295b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
5296b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
529735573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
5298898c527eSdrh                   r1, r2, dest, jumpIfNull,ExprHasProperty(pExpr,EP_Commuted));
52997d176105Sdrh       assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
53007d176105Sdrh       assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
53017d176105Sdrh       assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
53027d176105Sdrh       assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
5303de845c2fSdrh       assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
5304de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
5305de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
5306de845c2fSdrh       assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
5307de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
5308de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
53096a2fe093Sdrh       testcase( regFree1==0 );
53106a2fe093Sdrh       testcase( regFree2==0 );
53116a2fe093Sdrh       break;
53126a2fe093Sdrh     }
5313cce7d176Sdrh     case TK_ISNULL:
5314cce7d176Sdrh     case TK_NOTNULL: {
53152dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
53162dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
53177d176105Sdrh       testcase( op==TK_ISNULL );   VdbeCoverageIf(v, op==TK_ISNULL);
53187d176105Sdrh       testcase( op==TK_NOTNULL );  VdbeCoverageIf(v, op==TK_NOTNULL);
5319c5499befSdrh       testcase( regFree1==0 );
5320cce7d176Sdrh       break;
5321cce7d176Sdrh     }
5322fef5208cSdrh     case TK_BETWEEN: {
53235c03f30aSdrh       testcase( jumpIfNull==0 );
532471c57db0Sdan       exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfFalse, jumpIfNull);
5325fef5208cSdrh       break;
5326fef5208cSdrh     }
5327bb201344Sshaneh #ifndef SQLITE_OMIT_SUBQUERY
5328e3365e6cSdrh     case TK_IN: {
5329e3365e6cSdrh       if( jumpIfNull ){
5330e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, dest);
5331e3365e6cSdrh       }else{
5332ec4ccdbcSdrh         int destIfNull = sqlite3VdbeMakeLabel(pParse);
5333e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, destIfNull);
5334e3365e6cSdrh         sqlite3VdbeResolveLabel(v, destIfNull);
5335e3365e6cSdrh       }
5336e3365e6cSdrh       break;
5337e3365e6cSdrh     }
5338bb201344Sshaneh #endif
5339cce7d176Sdrh     default: {
5340ba00e30aSdan     default_expr:
5341ad31727fSdrh       if( ExprAlwaysFalse(pExpr) ){
5342076e85f5Sdrh         sqlite3VdbeGoto(v, dest);
5343ad31727fSdrh       }else if( ExprAlwaysTrue(pExpr) ){
5344991a1985Sdrh         /* no-op */
5345991a1985Sdrh       }else{
53462dcef11bSdrh         r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
53472dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_IfNot, r1, dest, jumpIfNull!=0);
5348688852abSdrh         VdbeCoverage(v);
5349c5499befSdrh         testcase( regFree1==0 );
5350c5499befSdrh         testcase( jumpIfNull==0 );
5351991a1985Sdrh       }
5352cce7d176Sdrh       break;
5353cce7d176Sdrh     }
5354cce7d176Sdrh   }
53552dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
53562dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
5357cce7d176Sdrh }
53582282792aSdrh 
53592282792aSdrh /*
536072bc8208Sdrh ** Like sqlite3ExprIfFalse() except that a copy is made of pExpr before
536172bc8208Sdrh ** code generation, and that copy is deleted after code generation. This
536272bc8208Sdrh ** ensures that the original pExpr is unchanged.
536372bc8208Sdrh */
536472bc8208Sdrh void sqlite3ExprIfFalseDup(Parse *pParse, Expr *pExpr, int dest,int jumpIfNull){
536572bc8208Sdrh   sqlite3 *db = pParse->db;
536672bc8208Sdrh   Expr *pCopy = sqlite3ExprDup(db, pExpr, 0);
536772bc8208Sdrh   if( db->mallocFailed==0 ){
536872bc8208Sdrh     sqlite3ExprIfFalse(pParse, pCopy, dest, jumpIfNull);
536972bc8208Sdrh   }
537072bc8208Sdrh   sqlite3ExprDelete(db, pCopy);
537172bc8208Sdrh }
537272bc8208Sdrh 
53735aa550cfSdan /*
53745aa550cfSdan ** Expression pVar is guaranteed to be an SQL variable. pExpr may be any
53755aa550cfSdan ** type of expression.
53765aa550cfSdan **
53775aa550cfSdan ** If pExpr is a simple SQL value - an integer, real, string, blob
53785aa550cfSdan ** or NULL value - then the VDBE currently being prepared is configured
53795aa550cfSdan ** to re-prepare each time a new value is bound to variable pVar.
53805aa550cfSdan **
53815aa550cfSdan ** Additionally, if pExpr is a simple SQL value and the value is the
53825aa550cfSdan ** same as that currently bound to variable pVar, non-zero is returned.
53835aa550cfSdan ** Otherwise, if the values are not the same or if pExpr is not a simple
53845aa550cfSdan ** SQL value, zero is returned.
53855aa550cfSdan */
53861580d50bSdrh static int exprCompareVariable(
53871580d50bSdrh   const Parse *pParse,
53881580d50bSdrh   const Expr *pVar,
53891580d50bSdrh   const Expr *pExpr
53901580d50bSdrh ){
53915aa550cfSdan   int res = 0;
5392c0804226Sdrh   int iVar;
5393c0804226Sdrh   sqlite3_value *pL, *pR = 0;
53945aa550cfSdan 
53955aa550cfSdan   sqlite3ValueFromExpr(pParse->db, pExpr, SQLITE_UTF8, SQLITE_AFF_BLOB, &pR);
5396c0804226Sdrh   if( pR ){
5397c0804226Sdrh     iVar = pVar->iColumn;
5398c0804226Sdrh     sqlite3VdbeSetVarmask(pParse->pVdbe, iVar);
5399c0804226Sdrh     pL = sqlite3VdbeGetBoundValue(pParse->pReprepare, iVar, SQLITE_AFF_BLOB);
54005aa307e2Sdrh     if( pL ){
54015aa307e2Sdrh       if( sqlite3_value_type(pL)==SQLITE_TEXT ){
54025aa307e2Sdrh         sqlite3_value_text(pL); /* Make sure the encoding is UTF-8 */
54035aa307e2Sdrh       }
54045aa307e2Sdrh       res =  0==sqlite3MemCompare(pL, pR, 0);
54055aa550cfSdan     }
54065aa550cfSdan     sqlite3ValueFree(pR);
54075aa550cfSdan     sqlite3ValueFree(pL);
54085aa550cfSdan   }
54095aa550cfSdan 
54105aa550cfSdan   return res;
54115aa550cfSdan }
541272bc8208Sdrh 
541372bc8208Sdrh /*
54141d9da70aSdrh ** Do a deep comparison of two expression trees.  Return 0 if the two
54151d9da70aSdrh ** expressions are completely identical.  Return 1 if they differ only
54161d9da70aSdrh ** by a COLLATE operator at the top level.  Return 2 if there are differences
54171d9da70aSdrh ** other than the top-level COLLATE operator.
5418d40aab0eSdrh **
5419619a1305Sdrh ** If any subelement of pB has Expr.iTable==(-1) then it is allowed
5420619a1305Sdrh ** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
5421619a1305Sdrh **
542266518ca7Sdrh ** The pA side might be using TK_REGISTER.  If that is the case and pB is
542366518ca7Sdrh ** not using TK_REGISTER but is otherwise equivalent, then still return 0.
542466518ca7Sdrh **
54251d9da70aSdrh ** Sometimes this routine will return 2 even if the two expressions
5426d40aab0eSdrh ** really are equivalent.  If we cannot prove that the expressions are
54271d9da70aSdrh ** identical, we return 2 just to be safe.  So if this routine
54281d9da70aSdrh ** returns 2, then you do not really know for certain if the two
54291d9da70aSdrh ** expressions are the same.  But if you get a 0 or 1 return, then you
5430d40aab0eSdrh ** can be sure the expressions are the same.  In the places where
54311d9da70aSdrh ** this routine is used, it does not hurt to get an extra 2 - that
5432d40aab0eSdrh ** just might result in some slightly slower code.  But returning
54331d9da70aSdrh ** an incorrect 0 or 1 could lead to a malfunction.
54345aa550cfSdan **
5435c0804226Sdrh ** If pParse is not NULL then TK_VARIABLE terms in pA with bindings in
5436c0804226Sdrh ** pParse->pReprepare can be matched against literals in pB.  The
5437c0804226Sdrh ** pParse->pVdbe->expmask bitmask is updated for each variable referenced.
5438c0804226Sdrh ** If pParse is NULL (the normal case) then any TK_VARIABLE term in
5439c0804226Sdrh ** Argument pParse should normally be NULL. If it is not NULL and pA or
5440c0804226Sdrh ** pB causes a return value of 2.
54412282792aSdrh */
54421580d50bSdrh int sqlite3ExprCompare(
54431580d50bSdrh   const Parse *pParse,
54441580d50bSdrh   const Expr *pA,
54451580d50bSdrh   const Expr *pB,
54461580d50bSdrh   int iTab
54471580d50bSdrh ){
544810d1edf0Sdrh   u32 combinedFlags;
54494b202ae2Sdanielk1977   if( pA==0 || pB==0 ){
54501d9da70aSdrh     return pB==pA ? 0 : 2;
54512282792aSdrh   }
54525aa550cfSdan   if( pParse && pA->op==TK_VARIABLE && exprCompareVariable(pParse, pA, pB) ){
54535aa550cfSdan     return 0;
54545aa550cfSdan   }
545510d1edf0Sdrh   combinedFlags = pA->flags | pB->flags;
545610d1edf0Sdrh   if( combinedFlags & EP_IntValue ){
545710d1edf0Sdrh     if( (pA->flags&pB->flags&EP_IntValue)!=0 && pA->u.iValue==pB->u.iValue ){
545810d1edf0Sdrh       return 0;
545910d1edf0Sdrh     }
54601d9da70aSdrh     return 2;
54616ab3a2ecSdanielk1977   }
546216dd3985Sdan   if( pA->op!=pB->op || pA->op==TK_RAISE ){
54635aa550cfSdan     if( pA->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA->pLeft,pB,iTab)<2 ){
5464ae80ddeaSdrh       return 1;
5465ae80ddeaSdrh     }
54665aa550cfSdan     if( pB->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA,pB->pLeft,iTab)<2 ){
5467ae80ddeaSdrh       return 1;
5468ae80ddeaSdrh     }
5469ae80ddeaSdrh     return 2;
5470ae80ddeaSdrh   }
5471f9751074Sdrh   if( pA->op!=TK_COLUMN
5472f9751074Sdrh    && pA->op!=TK_AGG_COLUMN
5473f9751074Sdrh    && ALWAYS(!ExprHasProperty(pA, EP_IntValue))
5474f9751074Sdrh    && pA->u.zToken
5475f9751074Sdrh   ){
5476f9751074Sdrh     assert( !ExprHasProperty(pB, EP_IntValue) );
54774f9adee2Sdan     if( pA->op==TK_FUNCTION || pA->op==TK_AGG_FUNCTION ){
5478390b88a4Sdrh       if( sqlite3StrICmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
5479eda079cdSdrh #ifndef SQLITE_OMIT_WINDOWFUNC
54804f9adee2Sdan       assert( pA->op==pB->op );
54814f9adee2Sdan       if( ExprHasProperty(pA,EP_WinFunc)!=ExprHasProperty(pB,EP_WinFunc) ){
54824f9adee2Sdan         return 2;
54834f9adee2Sdan       }
5484eda079cdSdrh       if( ExprHasProperty(pA,EP_WinFunc) ){
54854f9adee2Sdan         if( sqlite3WindowCompare(pParse, pA->y.pWin, pB->y.pWin, 1)!=0 ){
54864f9adee2Sdan           return 2;
54874f9adee2Sdan         }
5488eda079cdSdrh       }
5489eda079cdSdrh #endif
5490f20bbc5fSdrh     }else if( pA->op==TK_NULL ){
5491f20bbc5fSdrh       return 0;
5492d5af5420Sdrh     }else if( pA->op==TK_COLLATE ){
5493e79f6299Sdrh       if( sqlite3_stricmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
5494f20bbc5fSdrh     }else if( ALWAYS(pB->u.zToken!=0) && strcmp(pA->u.zToken,pB->u.zToken)!=0 ){
5495d5af5420Sdrh       return 2;
549610d1edf0Sdrh     }
549710d1edf0Sdrh   }
5498898c527eSdrh   if( (pA->flags & (EP_Distinct|EP_Commuted))
5499898c527eSdrh      != (pB->flags & (EP_Distinct|EP_Commuted)) ) return 2;
5500e7375bfaSdrh   if( ALWAYS((combinedFlags & EP_TokenOnly)==0) ){
550110d1edf0Sdrh     if( combinedFlags & EP_xIsSelect ) return 2;
5502efad2e23Sdrh     if( (combinedFlags & EP_FixedCol)==0
5503efad2e23Sdrh      && sqlite3ExprCompare(pParse, pA->pLeft, pB->pLeft, iTab) ) return 2;
55045aa550cfSdan     if( sqlite3ExprCompare(pParse, pA->pRight, pB->pRight, iTab) ) return 2;
5505619a1305Sdrh     if( sqlite3ExprListCompare(pA->x.pList, pB->x.pList, iTab) ) return 2;
550603c5c213Sdrh     if( pA->op!=TK_STRING
550703c5c213Sdrh      && pA->op!=TK_TRUEFALSE
5508e7375bfaSdrh      && ALWAYS((combinedFlags & EP_Reduced)==0)
550903c5c213Sdrh     ){
5510619a1305Sdrh       if( pA->iColumn!=pB->iColumn ) return 2;
55119b258c54Sdrh       if( pA->op2!=pB->op2 && pA->op==TK_TRUTH ) return 2;
55120f28e1bdSdrh       if( pA->op!=TK_IN && pA->iTable!=pB->iTable && pA->iTable!=iTab ){
55130f28e1bdSdrh         return 2;
55140f28e1bdSdrh       }
55151d9da70aSdrh     }
55161d9da70aSdrh   }
55172646da7eSdrh   return 0;
55182646da7eSdrh }
55192282792aSdrh 
55208c6f666bSdrh /*
5521fbb6e9ffSdan ** Compare two ExprList objects.  Return 0 if they are identical, 1
5522fbb6e9ffSdan ** if they are certainly different, or 2 if it is not possible to
5523fbb6e9ffSdan ** determine if they are identical or not.
55248c6f666bSdrh **
5525619a1305Sdrh ** If any subelement of pB has Expr.iTable==(-1) then it is allowed
5526619a1305Sdrh ** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
5527619a1305Sdrh **
55288c6f666bSdrh ** This routine might return non-zero for equivalent ExprLists.  The
55298c6f666bSdrh ** only consequence will be disabled optimizations.  But this routine
55308c6f666bSdrh ** must never return 0 if the two ExprList objects are different, or
55318c6f666bSdrh ** a malfunction will result.
55328c6f666bSdrh **
55338c6f666bSdrh ** Two NULL pointers are considered to be the same.  But a NULL pointer
55348c6f666bSdrh ** always differs from a non-NULL pointer.
55358c6f666bSdrh */
55361580d50bSdrh int sqlite3ExprListCompare(const ExprList *pA, const ExprList *pB, int iTab){
55378c6f666bSdrh   int i;
55388c6f666bSdrh   if( pA==0 && pB==0 ) return 0;
55398c6f666bSdrh   if( pA==0 || pB==0 ) return 1;
55408c6f666bSdrh   if( pA->nExpr!=pB->nExpr ) return 1;
55418c6f666bSdrh   for(i=0; i<pA->nExpr; i++){
5542fbb6e9ffSdan     int res;
55438c6f666bSdrh     Expr *pExprA = pA->a[i].pExpr;
55448c6f666bSdrh     Expr *pExprB = pB->a[i].pExpr;
55456e11892dSdan     if( pA->a[i].sortFlags!=pB->a[i].sortFlags ) return 1;
5546fbb6e9ffSdan     if( (res = sqlite3ExprCompare(0, pExprA, pExprB, iTab)) ) return res;
55478c6f666bSdrh   }
55488c6f666bSdrh   return 0;
55498c6f666bSdrh }
555013449892Sdrh 
55512282792aSdrh /*
5552f9463dfbSdrh ** Like sqlite3ExprCompare() except COLLATE operators at the top-level
5553f9463dfbSdrh ** are ignored.
5554f9463dfbSdrh */
5555f9463dfbSdrh int sqlite3ExprCompareSkip(Expr *pA,Expr *pB, int iTab){
55565aa550cfSdan   return sqlite3ExprCompare(0,
55570d950af3Sdrh              sqlite3ExprSkipCollateAndLikely(pA),
55580d950af3Sdrh              sqlite3ExprSkipCollateAndLikely(pB),
5559f9463dfbSdrh              iTab);
5560f9463dfbSdrh }
5561f9463dfbSdrh 
5562f9463dfbSdrh /*
5563c51cf864Sdrh ** Return non-zero if Expr p can only be true if pNN is not NULL.
55647a231b49Sdrh **
55657a231b49Sdrh ** Or if seenNot is true, return non-zero if Expr p can only be
55667a231b49Sdrh ** non-NULL if pNN is not NULL
5567c51cf864Sdrh */
5568c51cf864Sdrh static int exprImpliesNotNull(
55691580d50bSdrh   const Parse *pParse,/* Parsing context */
55701580d50bSdrh   const Expr *p,      /* The expression to be checked */
55711580d50bSdrh   const Expr *pNN,    /* The expression that is NOT NULL */
5572c51cf864Sdrh   int iTab,           /* Table being evaluated */
55737a231b49Sdrh   int seenNot         /* Return true only if p can be any non-NULL value */
5574c51cf864Sdrh ){
5575c51cf864Sdrh   assert( p );
5576c51cf864Sdrh   assert( pNN );
557714c865e8Sdrh   if( sqlite3ExprCompare(pParse, p, pNN, iTab)==0 ){
557814c865e8Sdrh     return pNN->op!=TK_NULL;
557914c865e8Sdrh   }
5580c51cf864Sdrh   switch( p->op ){
5581c51cf864Sdrh     case TK_IN: {
5582c51cf864Sdrh       if( seenNot && ExprHasProperty(p, EP_xIsSelect) ) return 0;
5583a4eeccdfSdrh       assert( ExprUseXSelect(p) || (p->x.pList!=0 && p->x.pList->nExpr>0) );
5584ae144a1cSdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
5585c51cf864Sdrh     }
5586c51cf864Sdrh     case TK_BETWEEN: {
5587a4eeccdfSdrh       ExprList *pList;
5588a4eeccdfSdrh       assert( ExprUseXList(p) );
5589a4eeccdfSdrh       pList = p->x.pList;
5590c51cf864Sdrh       assert( pList!=0 );
5591c51cf864Sdrh       assert( pList->nExpr==2 );
5592c51cf864Sdrh       if( seenNot ) return 0;
55937a231b49Sdrh       if( exprImpliesNotNull(pParse, pList->a[0].pExpr, pNN, iTab, 1)
55947a231b49Sdrh        || exprImpliesNotNull(pParse, pList->a[1].pExpr, pNN, iTab, 1)
5595c51cf864Sdrh       ){
5596c51cf864Sdrh         return 1;
5597c51cf864Sdrh       }
55987a231b49Sdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
5599c51cf864Sdrh     }
5600c51cf864Sdrh     case TK_EQ:
5601c51cf864Sdrh     case TK_NE:
5602c51cf864Sdrh     case TK_LT:
5603c51cf864Sdrh     case TK_LE:
5604c51cf864Sdrh     case TK_GT:
5605c51cf864Sdrh     case TK_GE:
5606c51cf864Sdrh     case TK_PLUS:
5607c51cf864Sdrh     case TK_MINUS:
56089d23ea74Sdan     case TK_BITOR:
56099d23ea74Sdan     case TK_LSHIFT:
56109d23ea74Sdan     case TK_RSHIFT:
56119d23ea74Sdan     case TK_CONCAT:
56129d23ea74Sdan       seenNot = 1;
561308b92086Sdrh       /* no break */ deliberate_fall_through
5614c51cf864Sdrh     case TK_STAR:
5615c51cf864Sdrh     case TK_REM:
5616c51cf864Sdrh     case TK_BITAND:
56179d23ea74Sdan     case TK_SLASH: {
5618c51cf864Sdrh       if( exprImpliesNotNull(pParse, p->pRight, pNN, iTab, seenNot) ) return 1;
561908b92086Sdrh       /* no break */ deliberate_fall_through
5620c51cf864Sdrh     }
5621c51cf864Sdrh     case TK_SPAN:
5622c51cf864Sdrh     case TK_COLLATE:
5623c51cf864Sdrh     case TK_UPLUS:
5624c51cf864Sdrh     case TK_UMINUS: {
5625c51cf864Sdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, seenNot);
5626c51cf864Sdrh     }
5627c51cf864Sdrh     case TK_TRUTH: {
5628c51cf864Sdrh       if( seenNot ) return 0;
5629c51cf864Sdrh       if( p->op2!=TK_IS ) return 0;
563038cefc83Sdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
5631c51cf864Sdrh     }
56321cd382e3Sdan     case TK_BITNOT:
5633c51cf864Sdrh     case TK_NOT: {
5634c51cf864Sdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
5635c51cf864Sdrh     }
5636c51cf864Sdrh   }
5637c51cf864Sdrh   return 0;
5638c51cf864Sdrh }
5639c51cf864Sdrh 
5640c51cf864Sdrh /*
56414bd5f73fSdrh ** Return true if we can prove the pE2 will always be true if pE1 is
56424bd5f73fSdrh ** true.  Return false if we cannot complete the proof or if pE2 might
56434bd5f73fSdrh ** be false.  Examples:
56444bd5f73fSdrh **
5645619a1305Sdrh **     pE1: x==5       pE2: x==5             Result: true
56464bd5f73fSdrh **     pE1: x>0        pE2: x==5             Result: false
5647619a1305Sdrh **     pE1: x=21       pE2: x=21 OR y=43     Result: true
56484bd5f73fSdrh **     pE1: x!=123     pE2: x IS NOT NULL    Result: true
5649619a1305Sdrh **     pE1: x!=?1      pE2: x IS NOT NULL    Result: true
5650619a1305Sdrh **     pE1: x IS NULL  pE2: x IS NOT NULL    Result: false
5651619a1305Sdrh **     pE1: x IS ?2    pE2: x IS NOT NULL    Reuslt: false
56524bd5f73fSdrh **
56534bd5f73fSdrh ** When comparing TK_COLUMN nodes between pE1 and pE2, if pE2 has
56544bd5f73fSdrh ** Expr.iTable<0 then assume a table number given by iTab.
56554bd5f73fSdrh **
5656c0804226Sdrh ** If pParse is not NULL, then the values of bound variables in pE1 are
5657c0804226Sdrh ** compared against literal values in pE2 and pParse->pVdbe->expmask is
5658c0804226Sdrh ** modified to record which bound variables are referenced.  If pParse
5659c0804226Sdrh ** is NULL, then false will be returned if pE1 contains any bound variables.
5660c0804226Sdrh **
56614bd5f73fSdrh ** When in doubt, return false.  Returning true might give a performance
56624bd5f73fSdrh ** improvement.  Returning false might cause a performance reduction, but
56634bd5f73fSdrh ** it will always give the correct answer and is hence always safe.
56644bd5f73fSdrh */
56651580d50bSdrh int sqlite3ExprImpliesExpr(
56661580d50bSdrh   const Parse *pParse,
56671580d50bSdrh   const Expr *pE1,
56681580d50bSdrh   const Expr *pE2,
56691580d50bSdrh   int iTab
56701580d50bSdrh ){
56715aa550cfSdan   if( sqlite3ExprCompare(pParse, pE1, pE2, iTab)==0 ){
5672619a1305Sdrh     return 1;
5673619a1305Sdrh   }
5674619a1305Sdrh   if( pE2->op==TK_OR
56755aa550cfSdan    && (sqlite3ExprImpliesExpr(pParse, pE1, pE2->pLeft, iTab)
56765aa550cfSdan              || sqlite3ExprImpliesExpr(pParse, pE1, pE2->pRight, iTab) )
5677619a1305Sdrh   ){
5678619a1305Sdrh     return 1;
5679619a1305Sdrh   }
5680664d6d13Sdrh   if( pE2->op==TK_NOTNULL
5681c51cf864Sdrh    && exprImpliesNotNull(pParse, pE1, pE2->pLeft, iTab, 0)
5682664d6d13Sdrh   ){
5683c51cf864Sdrh     return 1;
5684619a1305Sdrh   }
5685619a1305Sdrh   return 0;
56864bd5f73fSdrh }
56874bd5f73fSdrh 
56884bd5f73fSdrh /*
56896c68d759Sdrh ** This is the Expr node callback for sqlite3ExprImpliesNonNullRow().
56902589787cSdrh ** If the expression node requires that the table at pWalker->iCur
5691f8937f90Sdrh ** have one or more non-NULL column, then set pWalker->eCode to 1 and abort.
5692f8937f90Sdrh **
5693f8937f90Sdrh ** This routine controls an optimization.  False positives (setting
5694f8937f90Sdrh ** pWalker->eCode to 1 when it should not be) are deadly, but false-negatives
5695f8937f90Sdrh ** (never setting pWalker->eCode) is a harmless missed optimization.
56962589787cSdrh */
56972589787cSdrh static int impliesNotNullRow(Walker *pWalker, Expr *pExpr){
5698f8937f90Sdrh   testcase( pExpr->op==TK_AGG_COLUMN );
5699821b610bSdrh   testcase( pExpr->op==TK_AGG_FUNCTION );
57002589787cSdrh   if( ExprHasProperty(pExpr, EP_FromJoin) ) return WRC_Prune;
57012589787cSdrh   switch( pExpr->op ){
57020493222fSdan     case TK_ISNOT:
57032589787cSdrh     case TK_ISNULL:
5704d5793672Sdrh     case TK_NOTNULL:
57052589787cSdrh     case TK_IS:
57062589787cSdrh     case TK_OR:
57076c68d759Sdrh     case TK_VECTOR:
57082c492061Sdrh     case TK_CASE:
5709e3eff266Sdrh     case TK_IN:
57102589787cSdrh     case TK_FUNCTION:
5711da03c1e6Sdan     case TK_TRUTH:
57120493222fSdan       testcase( pExpr->op==TK_ISNOT );
5713821b610bSdrh       testcase( pExpr->op==TK_ISNULL );
5714d5793672Sdrh       testcase( pExpr->op==TK_NOTNULL );
5715821b610bSdrh       testcase( pExpr->op==TK_IS );
5716821b610bSdrh       testcase( pExpr->op==TK_OR );
57176c68d759Sdrh       testcase( pExpr->op==TK_VECTOR );
5718821b610bSdrh       testcase( pExpr->op==TK_CASE );
5719821b610bSdrh       testcase( pExpr->op==TK_IN );
5720821b610bSdrh       testcase( pExpr->op==TK_FUNCTION );
5721da03c1e6Sdan       testcase( pExpr->op==TK_TRUTH );
57222589787cSdrh       return WRC_Prune;
57232589787cSdrh     case TK_COLUMN:
57242589787cSdrh       if( pWalker->u.iCur==pExpr->iTable ){
57252589787cSdrh         pWalker->eCode = 1;
57262589787cSdrh         return WRC_Abort;
57272589787cSdrh       }
57282589787cSdrh       return WRC_Prune;
57299881155dSdrh 
57309d23ea74Sdan     case TK_AND:
5731aef81674Sdrh       if( pWalker->eCode==0 ){
57320287c951Sdan         sqlite3WalkExpr(pWalker, pExpr->pLeft);
57330287c951Sdan         if( pWalker->eCode ){
57340287c951Sdan           pWalker->eCode = 0;
57350287c951Sdan           sqlite3WalkExpr(pWalker, pExpr->pRight);
57369d23ea74Sdan         }
5737aef81674Sdrh       }
57389d23ea74Sdan       return WRC_Prune;
57399d23ea74Sdan 
57409d23ea74Sdan     case TK_BETWEEN:
57411d24a531Sdan       if( sqlite3WalkExpr(pWalker, pExpr->pLeft)==WRC_Abort ){
57421d24a531Sdan         assert( pWalker->eCode );
57431d24a531Sdan         return WRC_Abort;
57441d24a531Sdan       }
57459d23ea74Sdan       return WRC_Prune;
57469d23ea74Sdan 
57479881155dSdrh     /* Virtual tables are allowed to use constraints like x=NULL.  So
57489881155dSdrh     ** a term of the form x=y does not prove that y is not null if x
57499881155dSdrh     ** is the column of a virtual table */
57509881155dSdrh     case TK_EQ:
57519881155dSdrh     case TK_NE:
57529881155dSdrh     case TK_LT:
57539881155dSdrh     case TK_LE:
57549881155dSdrh     case TK_GT:
575578d1d225Sdrh     case TK_GE: {
575678d1d225Sdrh       Expr *pLeft = pExpr->pLeft;
575778d1d225Sdrh       Expr *pRight = pExpr->pRight;
57589881155dSdrh       testcase( pExpr->op==TK_EQ );
57599881155dSdrh       testcase( pExpr->op==TK_NE );
57609881155dSdrh       testcase( pExpr->op==TK_LT );
57619881155dSdrh       testcase( pExpr->op==TK_LE );
57629881155dSdrh       testcase( pExpr->op==TK_GT );
57639881155dSdrh       testcase( pExpr->op==TK_GE );
576478d1d225Sdrh       /* The y.pTab=0 assignment in wherecode.c always happens after the
576578d1d225Sdrh       ** impliesNotNullRow() test */
5766477572b9Sdrh       assert( pLeft->op!=TK_COLUMN || ExprUseYTab(pLeft) );
5767477572b9Sdrh       assert( pRight->op!=TK_COLUMN || ExprUseYTab(pRight) );
5768477572b9Sdrh       if( (pLeft->op==TK_COLUMN
5769477572b9Sdrh            && pLeft->y.pTab!=0
577078d1d225Sdrh            && IsVirtual(pLeft->y.pTab))
5771477572b9Sdrh        || (pRight->op==TK_COLUMN
5772477572b9Sdrh            && pRight->y.pTab!=0
577378d1d225Sdrh            && IsVirtual(pRight->y.pTab))
57749881155dSdrh       ){
57759881155dSdrh         return WRC_Prune;
57769881155dSdrh       }
577708b92086Sdrh       /* no break */ deliberate_fall_through
577878d1d225Sdrh     }
57792589787cSdrh     default:
57802589787cSdrh       return WRC_Continue;
57812589787cSdrh   }
57822589787cSdrh }
57832589787cSdrh 
57842589787cSdrh /*
57852589787cSdrh ** Return true (non-zero) if expression p can only be true if at least
57862589787cSdrh ** one column of table iTab is non-null.  In other words, return true
57872589787cSdrh ** if expression p will always be NULL or false if every column of iTab
57882589787cSdrh ** is NULL.
57892589787cSdrh **
5790821b610bSdrh ** False negatives are acceptable.  In other words, it is ok to return
5791821b610bSdrh ** zero even if expression p will never be true of every column of iTab
5792821b610bSdrh ** is NULL.  A false negative is merely a missed optimization opportunity.
5793821b610bSdrh **
5794821b610bSdrh ** False positives are not allowed, however.  A false positive may result
5795821b610bSdrh ** in an incorrect answer.
5796821b610bSdrh **
57972589787cSdrh ** Terms of p that are marked with EP_FromJoin (and hence that come from
57982589787cSdrh ** the ON or USING clauses of LEFT JOINS) are excluded from the analysis.
57992589787cSdrh **
58002589787cSdrh ** This routine is used to check if a LEFT JOIN can be converted into
58012589787cSdrh ** an ordinary JOIN.  The p argument is the WHERE clause.  If the WHERE
58022589787cSdrh ** clause requires that some column of the right table of the LEFT JOIN
58032589787cSdrh ** be non-NULL, then the LEFT JOIN can be safely converted into an
58042589787cSdrh ** ordinary join.
58052589787cSdrh */
58062589787cSdrh int sqlite3ExprImpliesNonNullRow(Expr *p, int iTab){
58072589787cSdrh   Walker w;
58080d950af3Sdrh   p = sqlite3ExprSkipCollateAndLikely(p);
58094a254f98Sdrh   if( p==0 ) return 0;
58104a254f98Sdrh   if( p->op==TK_NOTNULL ){
5811d6db6598Sdrh     p = p->pLeft;
5812a1698993Sdrh   }else{
5813a1698993Sdrh     while( p->op==TK_AND ){
58144a254f98Sdrh       if( sqlite3ExprImpliesNonNullRow(p->pLeft, iTab) ) return 1;
58154a254f98Sdrh       p = p->pRight;
5816d6db6598Sdrh     }
5817a1698993Sdrh   }
58182589787cSdrh   w.xExprCallback = impliesNotNullRow;
58192589787cSdrh   w.xSelectCallback = 0;
58202589787cSdrh   w.xSelectCallback2 = 0;
58212589787cSdrh   w.eCode = 0;
58222589787cSdrh   w.u.iCur = iTab;
58232589787cSdrh   sqlite3WalkExpr(&w, p);
58242589787cSdrh   return w.eCode;
58252589787cSdrh }
58262589787cSdrh 
58272589787cSdrh /*
5828030796dfSdrh ** An instance of the following structure is used by the tree walker
58292409f8a1Sdrh ** to determine if an expression can be evaluated by reference to the
58302409f8a1Sdrh ** index only, without having to do a search for the corresponding
58312409f8a1Sdrh ** table entry.  The IdxCover.pIdx field is the index.  IdxCover.iCur
58322409f8a1Sdrh ** is the cursor for the table.
58332409f8a1Sdrh */
58342409f8a1Sdrh struct IdxCover {
58352409f8a1Sdrh   Index *pIdx;     /* The index to be tested for coverage */
58362409f8a1Sdrh   int iCur;        /* Cursor number for the table corresponding to the index */
58372409f8a1Sdrh };
58382409f8a1Sdrh 
58392409f8a1Sdrh /*
58402409f8a1Sdrh ** Check to see if there are references to columns in table
58412409f8a1Sdrh ** pWalker->u.pIdxCover->iCur can be satisfied using the index
58422409f8a1Sdrh ** pWalker->u.pIdxCover->pIdx.
58432409f8a1Sdrh */
58442409f8a1Sdrh static int exprIdxCover(Walker *pWalker, Expr *pExpr){
58452409f8a1Sdrh   if( pExpr->op==TK_COLUMN
58462409f8a1Sdrh    && pExpr->iTable==pWalker->u.pIdxCover->iCur
5847b9bcf7caSdrh    && sqlite3TableColumnToIndex(pWalker->u.pIdxCover->pIdx, pExpr->iColumn)<0
58482409f8a1Sdrh   ){
58492409f8a1Sdrh     pWalker->eCode = 1;
58502409f8a1Sdrh     return WRC_Abort;
58512409f8a1Sdrh   }
58522409f8a1Sdrh   return WRC_Continue;
58532409f8a1Sdrh }
58542409f8a1Sdrh 
58552409f8a1Sdrh /*
5856e604ec0bSdrh ** Determine if an index pIdx on table with cursor iCur contains will
5857e604ec0bSdrh ** the expression pExpr.  Return true if the index does cover the
5858e604ec0bSdrh ** expression and false if the pExpr expression references table columns
5859e604ec0bSdrh ** that are not found in the index pIdx.
58602409f8a1Sdrh **
58612409f8a1Sdrh ** An index covering an expression means that the expression can be
58622409f8a1Sdrh ** evaluated using only the index and without having to lookup the
58632409f8a1Sdrh ** corresponding table entry.
58642409f8a1Sdrh */
58652409f8a1Sdrh int sqlite3ExprCoveredByIndex(
58662409f8a1Sdrh   Expr *pExpr,        /* The index to be tested */
58672409f8a1Sdrh   int iCur,           /* The cursor number for the corresponding table */
58682409f8a1Sdrh   Index *pIdx         /* The index that might be used for coverage */
58692409f8a1Sdrh ){
58702409f8a1Sdrh   Walker w;
58712409f8a1Sdrh   struct IdxCover xcov;
58722409f8a1Sdrh   memset(&w, 0, sizeof(w));
58732409f8a1Sdrh   xcov.iCur = iCur;
58742409f8a1Sdrh   xcov.pIdx = pIdx;
58752409f8a1Sdrh   w.xExprCallback = exprIdxCover;
58762409f8a1Sdrh   w.u.pIdxCover = &xcov;
58772409f8a1Sdrh   sqlite3WalkExpr(&w, pExpr);
58782409f8a1Sdrh   return !w.eCode;
58792409f8a1Sdrh }
58802409f8a1Sdrh 
58812409f8a1Sdrh 
5882*90cf38beSdrh /* Structure used to pass information throught the Walker in order to
5883*90cf38beSdrh ** implement sqlite3ReferencesSrcList().
5884374fdce4Sdrh */
5885*90cf38beSdrh struct RefSrcList {
5886*90cf38beSdrh   sqlite3 *db;         /* Database connection used for sqlite3DbRealloc() */
5887*90cf38beSdrh   SrcList *pRef;       /* Looking for references to these tables */
5888*90cf38beSdrh   int nExclude;        /* Number of tables to exclude from the search */
5889*90cf38beSdrh   int *aiExclude;      /* Cursor IDs for tables to exclude from the search */
5890030796dfSdrh };
5891030796dfSdrh 
5892030796dfSdrh /*
5893*90cf38beSdrh ** Walker SELECT callbacks for sqlite3ReferencesSrcList().
5894*90cf38beSdrh **
5895*90cf38beSdrh ** When entering a new subquery on the pExpr argument, add all FROM clause
5896*90cf38beSdrh ** entries for that subquery to the exclude list.
5897*90cf38beSdrh **
5898*90cf38beSdrh ** When leaving the subquery, remove those entries from the exclude list.
5899ed41a96bSdan */
5900*90cf38beSdrh static int selectRefEnter(Walker *pWalker, Select *pSelect){
5901*90cf38beSdrh   struct RefSrcList *p = pWalker->u.pRefSrcList;
5902*90cf38beSdrh   SrcList *pSrc = pSelect->pSrc;
5903*90cf38beSdrh   int i, j, *piNew;
5904*90cf38beSdrh   if( pSrc->nSrc==0 ) return WRC_Continue;
5905*90cf38beSdrh   j = p->nExclude;
5906*90cf38beSdrh   p->nExclude += pSrc->nSrc;
5907*90cf38beSdrh   piNew = sqlite3DbRealloc(p->db, p->aiExclude, p->nExclude*sizeof(int));
5908*90cf38beSdrh   if( piNew==0 ){
5909*90cf38beSdrh     p->nExclude = 0;
5910*90cf38beSdrh     return WRC_Abort;
5911*90cf38beSdrh   }else{
5912*90cf38beSdrh     p->aiExclude = piNew;
5913*90cf38beSdrh   }
5914*90cf38beSdrh   for(i=0; i<pSrc->nSrc; i++, j++){
5915*90cf38beSdrh      p->aiExclude[j] = pSrc->a[i].iCursor;
5916ed41a96bSdan   }
5917ed41a96bSdan   return WRC_Continue;
5918ed41a96bSdan }
5919*90cf38beSdrh static void selectRefLeave(Walker *pWalker, Select *pSelect){
5920*90cf38beSdrh   struct RefSrcList *p = pWalker->u.pRefSrcList;
5921*90cf38beSdrh   SrcList *pSrc = pSelect->pSrc;
5922*90cf38beSdrh   if( p->nExclude ){
5923*90cf38beSdrh     assert( p->nExclude>=pSrc->nSrc );
5924*90cf38beSdrh     p->nExclude -= pSrc->nSrc;
5925*90cf38beSdrh   }
5926*90cf38beSdrh }
5927ed41a96bSdan 
5928*90cf38beSdrh /* This is the Walker EXPR callback for sqlite3ReferencesSrcList().
5929*90cf38beSdrh **
5930*90cf38beSdrh ** Set the 0x01 bit of pWalker->eCode if there is a reference to any
5931*90cf38beSdrh ** of the tables shown in RefSrcList.pRef.
5932*90cf38beSdrh **
5933*90cf38beSdrh ** Set the 0x02 bit of pWalker->eCode if there is a reference to a
5934*90cf38beSdrh ** table is in neither RefSrcList.pRef nor RefSrcList.aiExclude.
5935030796dfSdrh */
5936*90cf38beSdrh static int exprRefToSrcList(Walker *pWalker, Expr *pExpr){
5937*90cf38beSdrh   if( pExpr->op==TK_COLUMN
5938*90cf38beSdrh    || pExpr->op==TK_AGG_COLUMN
5939*90cf38beSdrh   ){
5940374fdce4Sdrh     int i;
5941*90cf38beSdrh     struct RefSrcList *p = pWalker->u.pRefSrcList;
5942*90cf38beSdrh     SrcList *pSrc = p->pRef;
5943655814d2Sdrh     int nSrc = pSrc ? pSrc->nSrc : 0;
5944655814d2Sdrh     for(i=0; i<nSrc; i++){
5945*90cf38beSdrh       if( pExpr->iTable==pSrc->a[i].iCursor ){
5946*90cf38beSdrh         pWalker->eCode |= 1;
5947*90cf38beSdrh         return WRC_Continue;
5948374fdce4Sdrh       }
5949*90cf38beSdrh     }
5950*90cf38beSdrh     for(i=0; i<p->nExclude && p->aiExclude[i]!=pExpr->iTable; i++){}
5951*90cf38beSdrh     if( i>=p->nExclude ){
5952*90cf38beSdrh       pWalker->eCode |= 2;
5953374fdce4Sdrh     }
5954374fdce4Sdrh   }
5955030796dfSdrh   return WRC_Continue;
5956030796dfSdrh }
5957374fdce4Sdrh 
5958374fdce4Sdrh /*
5959*90cf38beSdrh ** Check to see if pExpr references any tables in pSrcList.
5960*90cf38beSdrh ** Possible return values:
5961*90cf38beSdrh **
5962*90cf38beSdrh **    1         pExpr does references a table in pSrcList.
5963*90cf38beSdrh **
5964*90cf38beSdrh **    0         pExpr references some table that is not defined in either
5965*90cf38beSdrh **              pSrcList or in subqueries of pExpr itself.
5966*90cf38beSdrh **
5967*90cf38beSdrh **   -1         pExpr only references no tables at all, or it only
5968*90cf38beSdrh **              references tables defined in subqueries of pExpr itself.
5969*90cf38beSdrh **
5970*90cf38beSdrh ** As currently used, pExpr is always an aggregate function call.  That
5971*90cf38beSdrh ** fact is exploited for efficiency.
5972374fdce4Sdrh */
5973*90cf38beSdrh int sqlite3ReferencesSrcList(Parse *pParse, Expr *pExpr, SrcList *pSrcList){
5974374fdce4Sdrh   Walker w;
5975*90cf38beSdrh   struct RefSrcList x;
597680f6bfc0Sdrh   memset(&w, 0, sizeof(w));
5977*90cf38beSdrh   memset(&x, 0, sizeof(x));
5978*90cf38beSdrh   w.xExprCallback = exprRefToSrcList;
5979*90cf38beSdrh   w.xSelectCallback = selectRefEnter;
5980*90cf38beSdrh   w.xSelectCallback2 = selectRefLeave;
5981*90cf38beSdrh   w.u.pRefSrcList = &x;
5982*90cf38beSdrh   x.db = pParse->db;
5983*90cf38beSdrh   x.pRef = pSrcList;
5984*90cf38beSdrh   assert( pExpr->op==TK_AGG_FUNCTION );
5985a4eeccdfSdrh   assert( ExprUseXList(pExpr) );
5986030796dfSdrh   sqlite3WalkExprList(&w, pExpr->x.pList);
59875e484cb3Sdan #ifndef SQLITE_OMIT_WINDOWFUNC
59885e484cb3Sdan   if( ExprHasProperty(pExpr, EP_WinFunc) ){
59895e484cb3Sdan     sqlite3WalkExpr(&w, pExpr->y.pWin->pFilter);
59905e484cb3Sdan   }
59915e484cb3Sdan #endif
5992*90cf38beSdrh   sqlite3DbFree(pParse->db, x.aiExclude);
5993*90cf38beSdrh   if( w.eCode & 0x01 ){
5994*90cf38beSdrh     return 1;
5995*90cf38beSdrh   }else if( w.eCode ){
5996*90cf38beSdrh     return 0;
5997*90cf38beSdrh   }else{
5998*90cf38beSdrh     return -1;
5999*90cf38beSdrh   }
6000374fdce4Sdrh }
6001374fdce4Sdrh 
6002374fdce4Sdrh /*
600389636628Sdrh ** This is a Walker expression node callback.
600489636628Sdrh **
600589636628Sdrh ** For Expr nodes that contain pAggInfo pointers, make sure the AggInfo
600689636628Sdrh ** object that is referenced does not refer directly to the Expr.  If
600789636628Sdrh ** it does, make a copy.  This is done because the pExpr argument is
600889636628Sdrh ** subject to change.
600989636628Sdrh **
601089636628Sdrh ** The copy is stored on pParse->pConstExpr with a register number of 0.
601189636628Sdrh ** This will cause the expression to be deleted automatically when the
601289636628Sdrh ** Parse object is destroyed, but the zero register number means that it
601389636628Sdrh ** will not generate any code in the preamble.
601489636628Sdrh */
601589636628Sdrh static int agginfoPersistExprCb(Walker *pWalker, Expr *pExpr){
60162f82acc0Sdrh   if( ALWAYS(!ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced))
601789636628Sdrh    && pExpr->pAggInfo!=0
601889636628Sdrh   ){
601989636628Sdrh     AggInfo *pAggInfo = pExpr->pAggInfo;
602089636628Sdrh     int iAgg = pExpr->iAgg;
602189636628Sdrh     Parse *pParse = pWalker->pParse;
602289636628Sdrh     sqlite3 *db = pParse->db;
60232f82acc0Sdrh     assert( pExpr->op==TK_AGG_COLUMN || pExpr->op==TK_AGG_FUNCTION );
60242f82acc0Sdrh     if( pExpr->op==TK_AGG_COLUMN ){
602589636628Sdrh       assert( iAgg>=0 && iAgg<pAggInfo->nColumn );
602681185a51Sdrh       if( pAggInfo->aCol[iAgg].pCExpr==pExpr ){
602789636628Sdrh         pExpr = sqlite3ExprDup(db, pExpr, 0);
602889636628Sdrh         if( pExpr ){
602981185a51Sdrh           pAggInfo->aCol[iAgg].pCExpr = pExpr;
6030b3ad4e61Sdrh           sqlite3ExprDeferredDelete(pParse, pExpr);
603189636628Sdrh         }
603289636628Sdrh       }
603389636628Sdrh     }else{
603489636628Sdrh       assert( iAgg>=0 && iAgg<pAggInfo->nFunc );
603581185a51Sdrh       if( pAggInfo->aFunc[iAgg].pFExpr==pExpr ){
603689636628Sdrh         pExpr = sqlite3ExprDup(db, pExpr, 0);
603789636628Sdrh         if( pExpr ){
603881185a51Sdrh           pAggInfo->aFunc[iAgg].pFExpr = pExpr;
6039b3ad4e61Sdrh           sqlite3ExprDeferredDelete(pParse, pExpr);
604089636628Sdrh         }
604189636628Sdrh       }
604289636628Sdrh     }
604389636628Sdrh   }
604489636628Sdrh   return WRC_Continue;
604589636628Sdrh }
604689636628Sdrh 
604789636628Sdrh /*
604889636628Sdrh ** Initialize a Walker object so that will persist AggInfo entries referenced
604989636628Sdrh ** by the tree that is walked.
605089636628Sdrh */
605189636628Sdrh void sqlite3AggInfoPersistWalkerInit(Walker *pWalker, Parse *pParse){
605289636628Sdrh   memset(pWalker, 0, sizeof(*pWalker));
605389636628Sdrh   pWalker->pParse = pParse;
605489636628Sdrh   pWalker->xExprCallback = agginfoPersistExprCb;
605589636628Sdrh   pWalker->xSelectCallback = sqlite3SelectWalkNoop;
605689636628Sdrh }
605789636628Sdrh 
605889636628Sdrh /*
605913449892Sdrh ** Add a new element to the pAggInfo->aCol[] array.  Return the index of
606013449892Sdrh ** the new element.  Return a negative number if malloc fails.
60612282792aSdrh */
606217435752Sdrh static int addAggInfoColumn(sqlite3 *db, AggInfo *pInfo){
606313449892Sdrh   int i;
6064cf643729Sdrh   pInfo->aCol = sqlite3ArrayAllocate(
606517435752Sdrh        db,
6066cf643729Sdrh        pInfo->aCol,
6067cf643729Sdrh        sizeof(pInfo->aCol[0]),
6068cf643729Sdrh        &pInfo->nColumn,
6069cf643729Sdrh        &i
6070cf643729Sdrh   );
607113449892Sdrh   return i;
60722282792aSdrh }
607313449892Sdrh 
607413449892Sdrh /*
607513449892Sdrh ** Add a new element to the pAggInfo->aFunc[] array.  Return the index of
607613449892Sdrh ** the new element.  Return a negative number if malloc fails.
607713449892Sdrh */
607817435752Sdrh static int addAggInfoFunc(sqlite3 *db, AggInfo *pInfo){
607913449892Sdrh   int i;
6080cf643729Sdrh   pInfo->aFunc = sqlite3ArrayAllocate(
608117435752Sdrh        db,
6082cf643729Sdrh        pInfo->aFunc,
6083cf643729Sdrh        sizeof(pInfo->aFunc[0]),
6084cf643729Sdrh        &pInfo->nFunc,
6085cf643729Sdrh        &i
6086cf643729Sdrh   );
608713449892Sdrh   return i;
60882282792aSdrh }
60892282792aSdrh 
60902282792aSdrh /*
60917d10d5a6Sdrh ** This is the xExprCallback for a tree walker.  It is used to
60927d10d5a6Sdrh ** implement sqlite3ExprAnalyzeAggregates().  See sqlite3ExprAnalyzeAggregates
6093626a879aSdrh ** for additional information.
60942282792aSdrh */
60957d10d5a6Sdrh static int analyzeAggregate(Walker *pWalker, Expr *pExpr){
60962282792aSdrh   int i;
60977d10d5a6Sdrh   NameContext *pNC = pWalker->u.pNC;
6098a58fdfb1Sdanielk1977   Parse *pParse = pNC->pParse;
6099a58fdfb1Sdanielk1977   SrcList *pSrcList = pNC->pSrcList;
610025c3b8caSdrh   AggInfo *pAggInfo = pNC->uNC.pAggInfo;
610113449892Sdrh 
610225c3b8caSdrh   assert( pNC->ncFlags & NC_UAggInfo );
61032282792aSdrh   switch( pExpr->op ){
610489c69d00Sdrh     case TK_AGG_COLUMN:
6105967e8b73Sdrh     case TK_COLUMN: {
61068b213899Sdrh       testcase( pExpr->op==TK_AGG_COLUMN );
61078b213899Sdrh       testcase( pExpr->op==TK_COLUMN );
610813449892Sdrh       /* Check to see if the column is in one of the tables in the FROM
610913449892Sdrh       ** clause of the aggregate query */
611020bc393cSdrh       if( ALWAYS(pSrcList!=0) ){
61117601294aSdrh         SrcItem *pItem = pSrcList->a;
611213449892Sdrh         for(i=0; i<pSrcList->nSrc; i++, pItem++){
611313449892Sdrh           struct AggInfo_col *pCol;
6114c5cd1249Sdrh           assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
611513449892Sdrh           if( pExpr->iTable==pItem->iCursor ){
611613449892Sdrh             /* If we reach this point, it means that pExpr refers to a table
611713449892Sdrh             ** that is in the FROM clause of the aggregate query.
611813449892Sdrh             **
611913449892Sdrh             ** Make an entry for the column in pAggInfo->aCol[] if there
612013449892Sdrh             ** is not an entry there already.
612113449892Sdrh             */
61227f906d63Sdrh             int k;
612313449892Sdrh             pCol = pAggInfo->aCol;
61247f906d63Sdrh             for(k=0; k<pAggInfo->nColumn; k++, pCol++){
612513449892Sdrh               if( pCol->iTable==pExpr->iTable &&
612613449892Sdrh                   pCol->iColumn==pExpr->iColumn ){
61272282792aSdrh                 break;
61282282792aSdrh               }
61292282792aSdrh             }
61301e536953Sdanielk1977             if( (k>=pAggInfo->nColumn)
61311e536953Sdanielk1977              && (k = addAggInfoColumn(pParse->db, pAggInfo))>=0
61321e536953Sdanielk1977             ){
61337f906d63Sdrh               pCol = &pAggInfo->aCol[k];
6134477572b9Sdrh               assert( ExprUseYTab(pExpr) );
6135eda079cdSdrh               pCol->pTab = pExpr->y.pTab;
613613449892Sdrh               pCol->iTable = pExpr->iTable;
613713449892Sdrh               pCol->iColumn = pExpr->iColumn;
61380a07c107Sdrh               pCol->iMem = ++pParse->nMem;
613913449892Sdrh               pCol->iSorterColumn = -1;
614081185a51Sdrh               pCol->pCExpr = pExpr;
614113449892Sdrh               if( pAggInfo->pGroupBy ){
614213449892Sdrh                 int j, n;
614313449892Sdrh                 ExprList *pGB = pAggInfo->pGroupBy;
614413449892Sdrh                 struct ExprList_item *pTerm = pGB->a;
614513449892Sdrh                 n = pGB->nExpr;
614613449892Sdrh                 for(j=0; j<n; j++, pTerm++){
614713449892Sdrh                   Expr *pE = pTerm->pExpr;
614813449892Sdrh                   if( pE->op==TK_COLUMN && pE->iTable==pExpr->iTable &&
614913449892Sdrh                       pE->iColumn==pExpr->iColumn ){
615013449892Sdrh                     pCol->iSorterColumn = j;
615113449892Sdrh                     break;
61522282792aSdrh                   }
615313449892Sdrh                 }
615413449892Sdrh               }
615513449892Sdrh               if( pCol->iSorterColumn<0 ){
615613449892Sdrh                 pCol->iSorterColumn = pAggInfo->nSortingColumn++;
615713449892Sdrh               }
615813449892Sdrh             }
615913449892Sdrh             /* There is now an entry for pExpr in pAggInfo->aCol[] (either
616013449892Sdrh             ** because it was there before or because we just created it).
616113449892Sdrh             ** Convert the pExpr to be a TK_AGG_COLUMN referring to that
616213449892Sdrh             ** pAggInfo->aCol[] entry.
616313449892Sdrh             */
6164ebb6a65dSdrh             ExprSetVVAProperty(pExpr, EP_NoReduce);
616513449892Sdrh             pExpr->pAggInfo = pAggInfo;
616613449892Sdrh             pExpr->op = TK_AGG_COLUMN;
6167cf697396Sshane             pExpr->iAgg = (i16)k;
616813449892Sdrh             break;
616913449892Sdrh           } /* endif pExpr->iTable==pItem->iCursor */
617013449892Sdrh         } /* end loop over pSrcList */
6171a58fdfb1Sdanielk1977       }
61727d10d5a6Sdrh       return WRC_Prune;
61732282792aSdrh     }
61742282792aSdrh     case TK_AGG_FUNCTION: {
61753a8c4be7Sdrh       if( (pNC->ncFlags & NC_InAggFunc)==0
6176ed551b95Sdrh        && pWalker->walkerDepth==pExpr->op2
61773a8c4be7Sdrh       ){
617813449892Sdrh         /* Check to see if pExpr is a duplicate of another aggregate
617913449892Sdrh         ** function that is already in the pAggInfo structure
618013449892Sdrh         */
618113449892Sdrh         struct AggInfo_func *pItem = pAggInfo->aFunc;
618213449892Sdrh         for(i=0; i<pAggInfo->nFunc; i++, pItem++){
618319e4eefbSdan           if( pItem->pFExpr==pExpr ) break;
618481185a51Sdrh           if( sqlite3ExprCompare(0, pItem->pFExpr, pExpr, -1)==0 ){
61852282792aSdrh             break;
61862282792aSdrh           }
61872282792aSdrh         }
618813449892Sdrh         if( i>=pAggInfo->nFunc ){
618913449892Sdrh           /* pExpr is original.  Make a new entry in pAggInfo->aFunc[]
619013449892Sdrh           */
619114db2665Sdanielk1977           u8 enc = ENC(pParse->db);
61921e536953Sdanielk1977           i = addAggInfoFunc(pParse->db, pAggInfo);
619313449892Sdrh           if( i>=0 ){
61946ab3a2ecSdanielk1977             assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
619513449892Sdrh             pItem = &pAggInfo->aFunc[i];
619681185a51Sdrh             pItem->pFExpr = pExpr;
61970a07c107Sdrh             pItem->iMem = ++pParse->nMem;
6198a4eeccdfSdrh             assert( ExprUseUToken(pExpr) );
619913449892Sdrh             pItem->pFunc = sqlite3FindFunction(pParse->db,
620080738d9cSdrh                    pExpr->u.zToken,
62016ab3a2ecSdanielk1977                    pExpr->x.pList ? pExpr->x.pList->nExpr : 0, enc, 0);
6202fd357974Sdrh             if( pExpr->flags & EP_Distinct ){
6203fd357974Sdrh               pItem->iDistinct = pParse->nTab++;
6204fd357974Sdrh             }else{
6205fd357974Sdrh               pItem->iDistinct = -1;
6206fd357974Sdrh             }
62072282792aSdrh           }
620813449892Sdrh         }
620913449892Sdrh         /* Make pExpr point to the appropriate pAggInfo->aFunc[] entry
621013449892Sdrh         */
6211c5cd1249Sdrh         assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
6212ebb6a65dSdrh         ExprSetVVAProperty(pExpr, EP_NoReduce);
6213cf697396Sshane         pExpr->iAgg = (i16)i;
621413449892Sdrh         pExpr->pAggInfo = pAggInfo;
62153a8c4be7Sdrh         return WRC_Prune;
62166e83a57fSdrh       }else{
62176e83a57fSdrh         return WRC_Continue;
62186e83a57fSdrh       }
62192282792aSdrh     }
6220a58fdfb1Sdanielk1977   }
62217d10d5a6Sdrh   return WRC_Continue;
62227d10d5a6Sdrh }
6223626a879aSdrh 
6224626a879aSdrh /*
6225e8abb4caSdrh ** Analyze the pExpr expression looking for aggregate functions and
6226e8abb4caSdrh ** for variables that need to be added to AggInfo object that pNC->pAggInfo
6227e8abb4caSdrh ** points to.  Additional entries are made on the AggInfo object as
6228e8abb4caSdrh ** necessary.
6229626a879aSdrh **
6230626a879aSdrh ** This routine should only be called after the expression has been
62317d10d5a6Sdrh ** analyzed by sqlite3ResolveExprNames().
6232626a879aSdrh */
6233d2b3e23bSdrh void sqlite3ExprAnalyzeAggregates(NameContext *pNC, Expr *pExpr){
62347d10d5a6Sdrh   Walker w;
62357d10d5a6Sdrh   w.xExprCallback = analyzeAggregate;
6236e40cc16bSdrh   w.xSelectCallback = sqlite3WalkerDepthIncrease;
6237e40cc16bSdrh   w.xSelectCallback2 = sqlite3WalkerDepthDecrease;
6238979dd1beSdrh   w.walkerDepth = 0;
62397d10d5a6Sdrh   w.u.pNC = pNC;
6240d9995031Sdan   w.pParse = 0;
624120bc393cSdrh   assert( pNC->pSrcList!=0 );
62427d10d5a6Sdrh   sqlite3WalkExpr(&w, pExpr);
62432282792aSdrh }
62445d9a4af9Sdrh 
62455d9a4af9Sdrh /*
62465d9a4af9Sdrh ** Call sqlite3ExprAnalyzeAggregates() for every expression in an
62475d9a4af9Sdrh ** expression list.  Return the number of errors.
62485d9a4af9Sdrh **
62495d9a4af9Sdrh ** If an error is found, the analysis is cut short.
62505d9a4af9Sdrh */
6251d2b3e23bSdrh void sqlite3ExprAnalyzeAggList(NameContext *pNC, ExprList *pList){
62525d9a4af9Sdrh   struct ExprList_item *pItem;
62535d9a4af9Sdrh   int i;
62545d9a4af9Sdrh   if( pList ){
6255d2b3e23bSdrh     for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
6256d2b3e23bSdrh       sqlite3ExprAnalyzeAggregates(pNC, pItem->pExpr);
62575d9a4af9Sdrh     }
62585d9a4af9Sdrh   }
62595d9a4af9Sdrh }
6260892d3179Sdrh 
6261892d3179Sdrh /*
6262ceea3321Sdrh ** Allocate a single new register for use to hold some intermediate result.
6263892d3179Sdrh */
6264892d3179Sdrh int sqlite3GetTempReg(Parse *pParse){
6265e55cbd72Sdrh   if( pParse->nTempReg==0 ){
6266892d3179Sdrh     return ++pParse->nMem;
6267892d3179Sdrh   }
62682f425f6bSdanielk1977   return pParse->aTempReg[--pParse->nTempReg];
6269892d3179Sdrh }
6270ceea3321Sdrh 
6271ceea3321Sdrh /*
6272ceea3321Sdrh ** Deallocate a register, making available for reuse for some other
6273ceea3321Sdrh ** purpose.
6274ceea3321Sdrh */
6275892d3179Sdrh void sqlite3ReleaseTempReg(Parse *pParse, int iReg){
627613d79502Sdrh   if( iReg ){
62773aef2fb1Sdrh     sqlite3VdbeReleaseRegisters(pParse, iReg, 1, 0, 0);
627813d79502Sdrh     if( pParse->nTempReg<ArraySize(pParse->aTempReg) ){
6279892d3179Sdrh       pParse->aTempReg[pParse->nTempReg++] = iReg;
6280892d3179Sdrh     }
6281892d3179Sdrh   }
628213d79502Sdrh }
6283892d3179Sdrh 
6284892d3179Sdrh /*
6285ed24da4bSdrh ** Allocate or deallocate a block of nReg consecutive registers.
6286892d3179Sdrh */
6287892d3179Sdrh int sqlite3GetTempRange(Parse *pParse, int nReg){
6288e55cbd72Sdrh   int i, n;
6289ed24da4bSdrh   if( nReg==1 ) return sqlite3GetTempReg(pParse);
6290892d3179Sdrh   i = pParse->iRangeReg;
6291e55cbd72Sdrh   n = pParse->nRangeReg;
6292f49f3523Sdrh   if( nReg<=n ){
6293892d3179Sdrh     pParse->iRangeReg += nReg;
6294892d3179Sdrh     pParse->nRangeReg -= nReg;
6295892d3179Sdrh   }else{
6296892d3179Sdrh     i = pParse->nMem+1;
6297892d3179Sdrh     pParse->nMem += nReg;
6298892d3179Sdrh   }
6299892d3179Sdrh   return i;
6300892d3179Sdrh }
6301892d3179Sdrh void sqlite3ReleaseTempRange(Parse *pParse, int iReg, int nReg){
6302ed24da4bSdrh   if( nReg==1 ){
6303ed24da4bSdrh     sqlite3ReleaseTempReg(pParse, iReg);
6304ed24da4bSdrh     return;
6305ed24da4bSdrh   }
63063aef2fb1Sdrh   sqlite3VdbeReleaseRegisters(pParse, iReg, nReg, 0, 0);
6307892d3179Sdrh   if( nReg>pParse->nRangeReg ){
6308892d3179Sdrh     pParse->nRangeReg = nReg;
6309892d3179Sdrh     pParse->iRangeReg = iReg;
6310892d3179Sdrh   }
6311892d3179Sdrh }
6312cdc69557Sdrh 
6313cdc69557Sdrh /*
6314cdc69557Sdrh ** Mark all temporary registers as being unavailable for reuse.
63156d2566dfSdrh **
63166d2566dfSdrh ** Always invoke this procedure after coding a subroutine or co-routine
63176d2566dfSdrh ** that might be invoked from other parts of the code, to ensure that
63186d2566dfSdrh ** the sub/co-routine does not use registers in common with the code that
63196d2566dfSdrh ** invokes the sub/co-routine.
6320cdc69557Sdrh */
6321cdc69557Sdrh void sqlite3ClearTempRegCache(Parse *pParse){
6322cdc69557Sdrh   pParse->nTempReg = 0;
6323cdc69557Sdrh   pParse->nRangeReg = 0;
6324cdc69557Sdrh }
6325bb9b5f26Sdrh 
6326bb9b5f26Sdrh /*
6327bb9b5f26Sdrh ** Validate that no temporary register falls within the range of
6328bb9b5f26Sdrh ** iFirst..iLast, inclusive.  This routine is only call from within assert()
6329bb9b5f26Sdrh ** statements.
6330bb9b5f26Sdrh */
6331bb9b5f26Sdrh #ifdef SQLITE_DEBUG
6332bb9b5f26Sdrh int sqlite3NoTempsInRange(Parse *pParse, int iFirst, int iLast){
6333bb9b5f26Sdrh   int i;
6334bb9b5f26Sdrh   if( pParse->nRangeReg>0
63353963e584Sdrh    && pParse->iRangeReg+pParse->nRangeReg > iFirst
63363963e584Sdrh    && pParse->iRangeReg <= iLast
6337bb9b5f26Sdrh   ){
6338bb9b5f26Sdrh      return 0;
6339bb9b5f26Sdrh   }
6340bb9b5f26Sdrh   for(i=0; i<pParse->nTempReg; i++){
6341bb9b5f26Sdrh     if( pParse->aTempReg[i]>=iFirst && pParse->aTempReg[i]<=iLast ){
6342bb9b5f26Sdrh       return 0;
6343bb9b5f26Sdrh     }
6344bb9b5f26Sdrh   }
6345bb9b5f26Sdrh   return 1;
6346bb9b5f26Sdrh }
6347bb9b5f26Sdrh #endif /* SQLITE_DEBUG */
6348