xref: /sqlite-3.40.0/src/expr.c (revision 9bb612f2)
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 */
240dfa4f6fSdrh char sqlite3TableColumnAffinity(Table *pTab, int iCol){
250dfa4f6fSdrh   assert( iCol<pTab->nCol );
260dfa4f6fSdrh   return iCol>=0 ? pTab->aCol[iCol].affinity : SQLITE_AFF_INTEGER;
270dfa4f6fSdrh }
2812abf408Sdrh 
29e014a838Sdanielk1977 /*
30e014a838Sdanielk1977 ** Return the 'affinity' of the expression pExpr if any.
31e014a838Sdanielk1977 **
32e014a838Sdanielk1977 ** If pExpr is a column, a reference to a column via an 'AS' alias,
33e014a838Sdanielk1977 ** or a sub-select with a column as the return value, then the
34e014a838Sdanielk1977 ** affinity of that column is returned. Otherwise, 0x00 is returned,
35e014a838Sdanielk1977 ** indicating no affinity for the expression.
36e014a838Sdanielk1977 **
3760ec914cSpeter.d.reid ** i.e. the WHERE clause expressions in the following statements all
38e014a838Sdanielk1977 ** have an affinity:
39e014a838Sdanielk1977 **
40e014a838Sdanielk1977 ** CREATE TABLE t1(a);
41e014a838Sdanielk1977 ** SELECT * FROM t1 WHERE a;
42e014a838Sdanielk1977 ** SELECT a AS b FROM t1 WHERE b;
43e014a838Sdanielk1977 ** SELECT * FROM t1 WHERE (select a from t1);
44e014a838Sdanielk1977 */
45e7375bfaSdrh char sqlite3ExprAffinity(const Expr *pExpr){
46580c8c18Sdrh   int op;
4746fe138dSdrh   while( ExprHasProperty(pExpr, EP_Skip|EP_IfNullRow) ){
48*9bb612f2Sdrh     assert( pExpr->op==TK_COLLATE
49*9bb612f2Sdrh          || pExpr->op==TK_IF_NULL_ROW
50*9bb612f2Sdrh          || (pExpr->op==TK_REGISTER && pExpr->op2==TK_IF_NULL_ROW) );
51a7d6db6aSdrh     pExpr = pExpr->pLeft;
52a7d6db6aSdrh     assert( pExpr!=0 );
53a7d6db6aSdrh   }
54580c8c18Sdrh   op = pExpr->op;
55487e262fSdrh   if( op==TK_SELECT ){
566ab3a2ecSdanielk1977     assert( pExpr->flags&EP_xIsSelect );
576af305deSdrh     assert( pExpr->x.pSelect!=0 );
586af305deSdrh     assert( pExpr->x.pSelect->pEList!=0 );
596af305deSdrh     assert( pExpr->x.pSelect->pEList->a[0].pExpr!=0 );
606ab3a2ecSdanielk1977     return sqlite3ExprAffinity(pExpr->x.pSelect->pEList->a[0].pExpr);
61a37cdde0Sdanielk1977   }
62db45bd5eSdrh   if( op==TK_REGISTER ) op = pExpr->op2;
63487e262fSdrh #ifndef SQLITE_OMIT_CAST
64487e262fSdrh   if( op==TK_CAST ){
6533e619fcSdrh     assert( !ExprHasProperty(pExpr, EP_IntValue) );
66fdaac671Sdrh     return sqlite3AffinityType(pExpr->u.zToken, 0);
67487e262fSdrh   }
68487e262fSdrh #endif
69eda079cdSdrh   if( (op==TK_AGG_COLUMN || op==TK_COLUMN) && pExpr->y.pTab ){
70eda079cdSdrh     return sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
717d10d5a6Sdrh   }
7280aa5453Sdan   if( op==TK_SELECT_COLUMN ){
7380aa5453Sdan     assert( pExpr->pLeft->flags&EP_xIsSelect );
7480aa5453Sdan     return sqlite3ExprAffinity(
7580aa5453Sdan         pExpr->pLeft->x.pSelect->pEList->a[pExpr->iColumn].pExpr
7680aa5453Sdan     );
7780aa5453Sdan   }
78db36e255Sdrh   if( op==TK_VECTOR ){
79db36e255Sdrh     return sqlite3ExprAffinity(pExpr->x.pList->a[0].pExpr);
80db36e255Sdrh   }
811194904bSdrh   return pExpr->affExpr;
82a37cdde0Sdanielk1977 }
83a37cdde0Sdanielk1977 
8453db1458Sdrh /*
858b4c40d8Sdrh ** Set the collating sequence for expression pExpr to be the collating
86ae80ddeaSdrh ** sequence named by pToken.   Return a pointer to a new Expr node that
87ae80ddeaSdrh ** implements the COLLATE operator.
880a8a406eSdrh **
890a8a406eSdrh ** If a memory allocation error occurs, that fact is recorded in pParse->db
900a8a406eSdrh ** and the pExpr parameter is returned unchanged.
918b4c40d8Sdrh */
924ef7efadSdrh Expr *sqlite3ExprAddCollateToken(
934ef7efadSdrh   Parse *pParse,           /* Parsing context */
944ef7efadSdrh   Expr *pExpr,             /* Add the "COLLATE" clause to this expression */
9580103fc6Sdan   const Token *pCollName,  /* Name of collating sequence */
9680103fc6Sdan   int dequote              /* True to dequote pCollName */
974ef7efadSdrh ){
980a8a406eSdrh   if( pCollName->n>0 ){
9980103fc6Sdan     Expr *pNew = sqlite3ExprAlloc(pParse->db, TK_COLLATE, pCollName, dequote);
100ae80ddeaSdrh     if( pNew ){
101ae80ddeaSdrh       pNew->pLeft = pExpr;
102a4c3c87eSdrh       pNew->flags |= EP_Collate|EP_Skip;
1030a8a406eSdrh       pExpr = pNew;
104ae80ddeaSdrh     }
1050a8a406eSdrh   }
1060a8a406eSdrh   return pExpr;
1070a8a406eSdrh }
1080a8a406eSdrh Expr *sqlite3ExprAddCollateString(Parse *pParse, Expr *pExpr, const char *zC){
1090a8a406eSdrh   Token s;
110261d8a51Sdrh   assert( zC!=0 );
11140aced5cSdrh   sqlite3TokenInit(&s, (char*)zC);
11280103fc6Sdan   return sqlite3ExprAddCollateToken(pParse, pExpr, &s, 0);
1130a8a406eSdrh }
1140a8a406eSdrh 
1150a8a406eSdrh /*
1160d950af3Sdrh ** Skip over any TK_COLLATE operators.
1170a8a406eSdrh */
1180a8a406eSdrh Expr *sqlite3ExprSkipCollate(Expr *pExpr){
1190d950af3Sdrh   while( pExpr && ExprHasProperty(pExpr, EP_Skip) ){
12046fe138dSdrh     assert( pExpr->op==TK_COLLATE );
1210d950af3Sdrh     pExpr = pExpr->pLeft;
1220d950af3Sdrh   }
1230d950af3Sdrh   return pExpr;
1240d950af3Sdrh }
1250d950af3Sdrh 
1260d950af3Sdrh /*
1270d950af3Sdrh ** Skip over any TK_COLLATE operators and/or any unlikely()
1280d950af3Sdrh ** or likelihood() or likely() functions at the root of an
1290d950af3Sdrh ** expression.
1300d950af3Sdrh */
1310d950af3Sdrh Expr *sqlite3ExprSkipCollateAndLikely(Expr *pExpr){
132a7d6db6aSdrh   while( pExpr && ExprHasProperty(pExpr, EP_Skip|EP_Unlikely) ){
133a4c3c87eSdrh     if( ExprHasProperty(pExpr, EP_Unlikely) ){
134cca9f3d2Sdrh       assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
135cca9f3d2Sdrh       assert( pExpr->x.pList->nExpr>0 );
136a4c3c87eSdrh       assert( pExpr->op==TK_FUNCTION );
137cca9f3d2Sdrh       pExpr = pExpr->x.pList->a[0].pExpr;
138cca9f3d2Sdrh     }else{
13946fe138dSdrh       assert( pExpr->op==TK_COLLATE );
140d91eba96Sdrh       pExpr = pExpr->pLeft;
141cca9f3d2Sdrh     }
142d91eba96Sdrh   }
1430a8a406eSdrh   return pExpr;
1448b4c40d8Sdrh }
1458b4c40d8Sdrh 
1468b4c40d8Sdrh /*
147ae80ddeaSdrh ** Return the collation sequence for the expression pExpr. If
148ae80ddeaSdrh ** there is no defined collating sequence, return NULL.
149ae80ddeaSdrh **
15070efa84dSdrh ** See also: sqlite3ExprNNCollSeq()
15170efa84dSdrh **
15270efa84dSdrh ** The sqlite3ExprNNCollSeq() works the same exact that it returns the
15370efa84dSdrh ** default collation if pExpr has no defined collation.
15470efa84dSdrh **
155ae80ddeaSdrh ** The collating sequence might be determined by a COLLATE operator
156ae80ddeaSdrh ** or by the presence of a column with a defined collating sequence.
157ae80ddeaSdrh ** COLLATE operators take first precedence.  Left operands take
158ae80ddeaSdrh ** precedence over right operands.
1590202b29eSdanielk1977 */
160e7375bfaSdrh CollSeq *sqlite3ExprCollSeq(Parse *pParse, const Expr *pExpr){
161ae80ddeaSdrh   sqlite3 *db = pParse->db;
1627cedc8d4Sdanielk1977   CollSeq *pColl = 0;
163e7375bfaSdrh   const Expr *p = pExpr;
164261d8a51Sdrh   while( p ){
165ae80ddeaSdrh     int op = p->op;
166cb0e04f9Sdrh     if( op==TK_REGISTER ) op = p->op2;
167cb0e04f9Sdrh     if( (op==TK_AGG_COLUMN || op==TK_COLUMN || op==TK_TRIGGER)
168eda079cdSdrh      && p->y.pTab!=0
169ae80ddeaSdrh     ){
170eda079cdSdrh       /* op==TK_REGISTER && p->y.pTab!=0 happens when pExpr was originally
1717d10d5a6Sdrh       ** a TK_COLUMN but was previously evaluated and cached in a register */
1727d10d5a6Sdrh       int j = p->iColumn;
1737d10d5a6Sdrh       if( j>=0 ){
174eda079cdSdrh         const char *zColl = p->y.pTab->aCol[j].zColl;
175c4a64facSdrh         pColl = sqlite3FindCollSeq(db, ENC(db), zColl, 0);
1760202b29eSdanielk1977       }
1777d10d5a6Sdrh       break;
1787d10d5a6Sdrh     }
179e081d73cSdrh     if( op==TK_CAST || op==TK_UPLUS ){
180e081d73cSdrh       p = p->pLeft;
181e081d73cSdrh       continue;
182e081d73cSdrh     }
183269d322dSdrh     if( op==TK_VECTOR ){
184269d322dSdrh       p = p->x.pList->a[0].pExpr;
185269d322dSdrh       continue;
186269d322dSdrh     }
187cb0e04f9Sdrh     if( op==TK_COLLATE ){
188e081d73cSdrh       pColl = sqlite3GetCollSeq(pParse, ENC(db), 0, p->u.zToken);
189e081d73cSdrh       break;
190e081d73cSdrh     }
191ae80ddeaSdrh     if( p->flags & EP_Collate ){
1922308ed38Sdrh       if( p->pLeft && (p->pLeft->flags & EP_Collate)!=0 ){
1937d10d5a6Sdrh         p = p->pLeft;
194ae80ddeaSdrh       }else{
1952308ed38Sdrh         Expr *pNext  = p->pRight;
1966728cd91Sdrh         /* The Expr.x union is never used at the same time as Expr.pRight */
1976728cd91Sdrh         assert( p->x.pList==0 || p->pRight==0 );
19892a2824cSdrh         if( p->x.pList!=0
19992a2824cSdrh          && !db->mallocFailed
20092a2824cSdrh          && ALWAYS(!ExprHasProperty(p, EP_xIsSelect))
20192a2824cSdrh         ){
2022308ed38Sdrh           int i;
2035b107654Sdrh           for(i=0; ALWAYS(i<p->x.pList->nExpr); i++){
2042308ed38Sdrh             if( ExprHasProperty(p->x.pList->a[i].pExpr, EP_Collate) ){
2052308ed38Sdrh               pNext = p->x.pList->a[i].pExpr;
2062308ed38Sdrh               break;
2072308ed38Sdrh             }
2082308ed38Sdrh           }
2092308ed38Sdrh         }
2102308ed38Sdrh         p = pNext;
211ae80ddeaSdrh       }
212ae80ddeaSdrh     }else{
213ae80ddeaSdrh       break;
214ae80ddeaSdrh     }
2150202b29eSdanielk1977   }
2167cedc8d4Sdanielk1977   if( sqlite3CheckCollSeq(pParse, pColl) ){
2177cedc8d4Sdanielk1977     pColl = 0;
2187cedc8d4Sdanielk1977   }
2197cedc8d4Sdanielk1977   return pColl;
2200202b29eSdanielk1977 }
2210202b29eSdanielk1977 
2220202b29eSdanielk1977 /*
22370efa84dSdrh ** Return the collation sequence for the expression pExpr. If
22470efa84dSdrh ** there is no defined collating sequence, return a pointer to the
22570efa84dSdrh ** defautl collation sequence.
22670efa84dSdrh **
22770efa84dSdrh ** See also: sqlite3ExprCollSeq()
22870efa84dSdrh **
22970efa84dSdrh ** The sqlite3ExprCollSeq() routine works the same except that it
23070efa84dSdrh ** returns NULL if there is no defined collation.
23170efa84dSdrh */
232e7375bfaSdrh CollSeq *sqlite3ExprNNCollSeq(Parse *pParse, const Expr *pExpr){
23370efa84dSdrh   CollSeq *p = sqlite3ExprCollSeq(pParse, pExpr);
23470efa84dSdrh   if( p==0 ) p = pParse->db->pDfltColl;
23570efa84dSdrh   assert( p!=0 );
23670efa84dSdrh   return p;
23770efa84dSdrh }
23870efa84dSdrh 
23970efa84dSdrh /*
24070efa84dSdrh ** Return TRUE if the two expressions have equivalent collating sequences.
24170efa84dSdrh */
242e7375bfaSdrh int sqlite3ExprCollSeqMatch(Parse *pParse, const Expr *pE1, const Expr *pE2){
24370efa84dSdrh   CollSeq *pColl1 = sqlite3ExprNNCollSeq(pParse, pE1);
24470efa84dSdrh   CollSeq *pColl2 = sqlite3ExprNNCollSeq(pParse, pE2);
24570efa84dSdrh   return sqlite3StrICmp(pColl1->zName, pColl2->zName)==0;
24670efa84dSdrh }
24770efa84dSdrh 
24870efa84dSdrh /*
249626a879aSdrh ** pExpr is an operand of a comparison operator.  aff2 is the
250626a879aSdrh ** type affinity of the other operand.  This routine returns the
25153db1458Sdrh ** type affinity that should be used for the comparison operator.
25253db1458Sdrh */
253e7375bfaSdrh char sqlite3CompareAffinity(const Expr *pExpr, char aff2){
254bf3b721fSdanielk1977   char aff1 = sqlite3ExprAffinity(pExpr);
25596fb16eeSdrh   if( aff1>SQLITE_AFF_NONE && aff2>SQLITE_AFF_NONE ){
2568df447f0Sdrh     /* Both sides of the comparison are columns. If one has numeric
2578df447f0Sdrh     ** affinity, use that. Otherwise use no affinity.
258e014a838Sdanielk1977     */
2598a51256cSdrh     if( sqlite3IsNumericAffinity(aff1) || sqlite3IsNumericAffinity(aff2) ){
260e014a838Sdanielk1977       return SQLITE_AFF_NUMERIC;
261e014a838Sdanielk1977     }else{
26205883a34Sdrh       return SQLITE_AFF_BLOB;
263e014a838Sdanielk1977     }
264e014a838Sdanielk1977   }else{
265e014a838Sdanielk1977     /* One side is a column, the other is not. Use the columns affinity. */
26696fb16eeSdrh     assert( aff1<=SQLITE_AFF_NONE || aff2<=SQLITE_AFF_NONE );
26796fb16eeSdrh     return (aff1<=SQLITE_AFF_NONE ? aff2 : aff1) | SQLITE_AFF_NONE;
268e014a838Sdanielk1977   }
269e014a838Sdanielk1977 }
270e014a838Sdanielk1977 
27153db1458Sdrh /*
27253db1458Sdrh ** pExpr is a comparison operator.  Return the type affinity that should
27353db1458Sdrh ** be applied to both operands prior to doing the comparison.
27453db1458Sdrh */
275e7375bfaSdrh static char comparisonAffinity(const Expr *pExpr){
276e014a838Sdanielk1977   char aff;
277e014a838Sdanielk1977   assert( pExpr->op==TK_EQ || pExpr->op==TK_IN || pExpr->op==TK_LT ||
278e014a838Sdanielk1977           pExpr->op==TK_GT || pExpr->op==TK_GE || pExpr->op==TK_LE ||
2796a2fe093Sdrh           pExpr->op==TK_NE || pExpr->op==TK_IS || pExpr->op==TK_ISNOT );
280e014a838Sdanielk1977   assert( pExpr->pLeft );
281bf3b721fSdanielk1977   aff = sqlite3ExprAffinity(pExpr->pLeft);
282e014a838Sdanielk1977   if( pExpr->pRight ){
283e014a838Sdanielk1977     aff = sqlite3CompareAffinity(pExpr->pRight, aff);
2846ab3a2ecSdanielk1977   }else if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2856ab3a2ecSdanielk1977     aff = sqlite3CompareAffinity(pExpr->x.pSelect->pEList->a[0].pExpr, aff);
28613ac46eeSdrh   }else if( aff==0 ){
28705883a34Sdrh     aff = SQLITE_AFF_BLOB;
288e014a838Sdanielk1977   }
289e014a838Sdanielk1977   return aff;
290e014a838Sdanielk1977 }
291e014a838Sdanielk1977 
292e014a838Sdanielk1977 /*
293e014a838Sdanielk1977 ** pExpr is a comparison expression, eg. '=', '<', IN(...) etc.
294e014a838Sdanielk1977 ** idx_affinity is the affinity of an indexed column. Return true
295e014a838Sdanielk1977 ** if the index with affinity idx_affinity may be used to implement
296e014a838Sdanielk1977 ** the comparison in pExpr.
297e014a838Sdanielk1977 */
298e7375bfaSdrh int sqlite3IndexAffinityOk(const Expr *pExpr, char idx_affinity){
299e014a838Sdanielk1977   char aff = comparisonAffinity(pExpr);
300915e434cSdrh   if( aff<SQLITE_AFF_TEXT ){
3018a51256cSdrh     return 1;
3028a51256cSdrh   }
303915e434cSdrh   if( aff==SQLITE_AFF_TEXT ){
304915e434cSdrh     return idx_affinity==SQLITE_AFF_TEXT;
305915e434cSdrh   }
306915e434cSdrh   return sqlite3IsNumericAffinity(idx_affinity);
307e014a838Sdanielk1977 }
308e014a838Sdanielk1977 
309a37cdde0Sdanielk1977 /*
31035573356Sdrh ** Return the P5 value that should be used for a binary comparison
311a37cdde0Sdanielk1977 ** opcode (OP_Eq, OP_Ge etc.) used to compare pExpr1 and pExpr2.
312a37cdde0Sdanielk1977 */
313e7375bfaSdrh static u8 binaryCompareP5(
314e7375bfaSdrh   const Expr *pExpr1,   /* Left operand */
315e7375bfaSdrh   const Expr *pExpr2,   /* Right operand */
316e7375bfaSdrh   int jumpIfNull        /* Extra flags added to P5 */
317e7375bfaSdrh ){
31835573356Sdrh   u8 aff = (char)sqlite3ExprAffinity(pExpr2);
3191bd10f8aSdrh   aff = (u8)sqlite3CompareAffinity(pExpr1, aff) | (u8)jumpIfNull;
32035573356Sdrh   return aff;
321a37cdde0Sdanielk1977 }
322a37cdde0Sdanielk1977 
323a2e00042Sdrh /*
3240202b29eSdanielk1977 ** Return a pointer to the collation sequence that should be used by
3250202b29eSdanielk1977 ** a binary comparison operator comparing pLeft and pRight.
3260202b29eSdanielk1977 **
3270202b29eSdanielk1977 ** If the left hand expression has a collating sequence type, then it is
3280202b29eSdanielk1977 ** used. Otherwise the collation sequence for the right hand expression
3290202b29eSdanielk1977 ** is used, or the default (BINARY) if neither expression has a collating
3300202b29eSdanielk1977 ** type.
331bcbb04e5Sdanielk1977 **
332bcbb04e5Sdanielk1977 ** Argument pRight (but not pLeft) may be a null pointer. In this case,
333bcbb04e5Sdanielk1977 ** it is not considered.
3340202b29eSdanielk1977 */
335bcbb04e5Sdanielk1977 CollSeq *sqlite3BinaryCompareCollSeq(
336bcbb04e5Sdanielk1977   Parse *pParse,
337e7375bfaSdrh   const Expr *pLeft,
338e7375bfaSdrh   const Expr *pRight
339bcbb04e5Sdanielk1977 ){
340ec41ddacSdrh   CollSeq *pColl;
341ec41ddacSdrh   assert( pLeft );
342ae80ddeaSdrh   if( pLeft->flags & EP_Collate ){
343ae80ddeaSdrh     pColl = sqlite3ExprCollSeq(pParse, pLeft);
344ae80ddeaSdrh   }else if( pRight && (pRight->flags & EP_Collate)!=0 ){
345ae80ddeaSdrh     pColl = sqlite3ExprCollSeq(pParse, pRight);
346ec41ddacSdrh   }else{
347ec41ddacSdrh     pColl = sqlite3ExprCollSeq(pParse, pLeft);
3480202b29eSdanielk1977     if( !pColl ){
3497cedc8d4Sdanielk1977       pColl = sqlite3ExprCollSeq(pParse, pRight);
3500202b29eSdanielk1977     }
351ec41ddacSdrh   }
3520202b29eSdanielk1977   return pColl;
3530202b29eSdanielk1977 }
3540202b29eSdanielk1977 
355898c527eSdrh /* Expresssion p is a comparison operator.  Return a collation sequence
356898c527eSdrh ** appropriate for the comparison operator.
357898c527eSdrh **
358898c527eSdrh ** This is normally just a wrapper around sqlite3BinaryCompareCollSeq().
359898c527eSdrh ** However, if the OP_Commuted flag is set, then the order of the operands
360898c527eSdrh ** is reversed in the sqlite3BinaryCompareCollSeq() call so that the
361898c527eSdrh ** correct collating sequence is found.
362898c527eSdrh */
363e7375bfaSdrh CollSeq *sqlite3ExprCompareCollSeq(Parse *pParse, const Expr *p){
364898c527eSdrh   if( ExprHasProperty(p, EP_Commuted) ){
365898c527eSdrh     return sqlite3BinaryCompareCollSeq(pParse, p->pRight, p->pLeft);
366898c527eSdrh   }else{
367898c527eSdrh     return sqlite3BinaryCompareCollSeq(pParse, p->pLeft, p->pRight);
368898c527eSdrh   }
369898c527eSdrh }
370898c527eSdrh 
3710202b29eSdanielk1977 /*
372be5c89acSdrh ** Generate code for a comparison operator.
373be5c89acSdrh */
374be5c89acSdrh static int codeCompare(
375be5c89acSdrh   Parse *pParse,    /* The parsing (and code generating) context */
376be5c89acSdrh   Expr *pLeft,      /* The left operand */
377be5c89acSdrh   Expr *pRight,     /* The right operand */
378be5c89acSdrh   int opcode,       /* The comparison opcode */
37935573356Sdrh   int in1, int in2, /* Register holding operands */
380be5c89acSdrh   int dest,         /* Jump here if true.  */
381898c527eSdrh   int jumpIfNull,   /* If true, jump if either operand is NULL */
382898c527eSdrh   int isCommuted    /* The comparison has been commuted */
383be5c89acSdrh ){
38435573356Sdrh   int p5;
38535573356Sdrh   int addr;
38635573356Sdrh   CollSeq *p4;
38735573356Sdrh 
3888654186bSdrh   if( pParse->nErr ) return 0;
389898c527eSdrh   if( isCommuted ){
390898c527eSdrh     p4 = sqlite3BinaryCompareCollSeq(pParse, pRight, pLeft);
391898c527eSdrh   }else{
39235573356Sdrh     p4 = sqlite3BinaryCompareCollSeq(pParse, pLeft, pRight);
393898c527eSdrh   }
39435573356Sdrh   p5 = binaryCompareP5(pLeft, pRight, jumpIfNull);
39535573356Sdrh   addr = sqlite3VdbeAddOp4(pParse->pVdbe, opcode, in2, dest, in1,
39635573356Sdrh                            (void*)p4, P4_COLLSEQ);
3971bd10f8aSdrh   sqlite3VdbeChangeP5(pParse->pVdbe, (u8)p5);
39835573356Sdrh   return addr;
399be5c89acSdrh }
400be5c89acSdrh 
401cfbb5e82Sdan /*
402870a0705Sdan ** Return true if expression pExpr is a vector, or false otherwise.
403d832da7fSdrh **
404d832da7fSdrh ** A vector is defined as any expression that results in two or more
405d832da7fSdrh ** columns of result.  Every TK_VECTOR node is an vector because the
406d832da7fSdrh ** parser will not generate a TK_VECTOR with fewer than two entries.
407d832da7fSdrh ** But a TK_SELECT might be either a vector or a scalar. It is only
408d832da7fSdrh ** considered a vector if it has two or more result columns.
409870a0705Sdan */
410870a0705Sdan int sqlite3ExprIsVector(Expr *pExpr){
41176dbe7a8Sdrh   return sqlite3ExprVectorSize(pExpr)>1;
412870a0705Sdan }
413870a0705Sdan 
414870a0705Sdan /*
415cfbb5e82Sdan ** If the expression passed as the only argument is of type TK_VECTOR
416cfbb5e82Sdan ** return the number of expressions in the vector. Or, if the expression
417cfbb5e82Sdan ** is a sub-select, return the number of columns in the sub-select. For
418cfbb5e82Sdan ** any other type of expression, return 1.
419cfbb5e82Sdan */
42071c57db0Sdan int sqlite3ExprVectorSize(Expr *pExpr){
42112abf408Sdrh   u8 op = pExpr->op;
42212abf408Sdrh   if( op==TK_REGISTER ) op = pExpr->op2;
42312abf408Sdrh   if( op==TK_VECTOR ){
42471c57db0Sdan     return pExpr->x.pList->nExpr;
42512abf408Sdrh   }else if( op==TK_SELECT ){
42676dbe7a8Sdrh     return pExpr->x.pSelect->pEList->nExpr;
42776dbe7a8Sdrh   }else{
42876dbe7a8Sdrh     return 1;
42976dbe7a8Sdrh   }
43071c57db0Sdan }
43171c57db0Sdan 
432ba00e30aSdan /*
433fc7f27b9Sdrh ** Return a pointer to a subexpression of pVector that is the i-th
434fc7f27b9Sdrh ** column of the vector (numbered starting with 0).  The caller must
435fc7f27b9Sdrh ** ensure that i is within range.
436fc7f27b9Sdrh **
43776dbe7a8Sdrh ** If pVector is really a scalar (and "scalar" here includes subqueries
43876dbe7a8Sdrh ** that return a single column!) then return pVector unmodified.
43976dbe7a8Sdrh **
440fc7f27b9Sdrh ** pVector retains ownership of the returned subexpression.
441fc7f27b9Sdrh **
442fc7f27b9Sdrh ** If the vector is a (SELECT ...) then the expression returned is
44376dbe7a8Sdrh ** just the expression for the i-th term of the result set, and may
44476dbe7a8Sdrh ** not be ready for evaluation because the table cursor has not yet
44576dbe7a8Sdrh ** been positioned.
446ba00e30aSdan */
447fc7f27b9Sdrh Expr *sqlite3VectorFieldSubexpr(Expr *pVector, int i){
448870a0705Sdan   assert( i<sqlite3ExprVectorSize(pVector) );
449870a0705Sdan   if( sqlite3ExprIsVector(pVector) ){
4509f24b53dSdrh     assert( pVector->op2==0 || pVector->op==TK_REGISTER );
4519f24b53dSdrh     if( pVector->op==TK_SELECT || pVector->op2==TK_SELECT ){
45271c57db0Sdan       return pVector->x.pSelect->pEList->a[i].pExpr;
453870a0705Sdan     }else{
45471c57db0Sdan       return pVector->x.pList->a[i].pExpr;
45571c57db0Sdan     }
456870a0705Sdan   }
457870a0705Sdan   return pVector;
458870a0705Sdan }
459fc7f27b9Sdrh 
460fc7f27b9Sdrh /*
461fc7f27b9Sdrh ** Compute and return a new Expr object which when passed to
462fc7f27b9Sdrh ** sqlite3ExprCode() will generate all necessary code to compute
463fc7f27b9Sdrh ** the iField-th column of the vector expression pVector.
464fc7f27b9Sdrh **
4658762ec19Sdrh ** It is ok for pVector to be a scalar (as long as iField==0).
4668762ec19Sdrh ** In that case, this routine works like sqlite3ExprDup().
4678762ec19Sdrh **
468fc7f27b9Sdrh ** The caller owns the returned Expr object and is responsible for
469fc7f27b9Sdrh ** ensuring that the returned value eventually gets freed.
470fc7f27b9Sdrh **
4718762ec19Sdrh ** The caller retains ownership of pVector.  If pVector is a TK_SELECT,
472fad0e70cSdan ** then the returned object will reference pVector and so pVector must remain
4738762ec19Sdrh ** valid for the life of the returned object.  If pVector is a TK_VECTOR
4748762ec19Sdrh ** or a scalar expression, then it can be deleted as soon as this routine
47576dbe7a8Sdrh ** returns.
4768762ec19Sdrh **
4778762ec19Sdrh ** A trick to cause a TK_SELECT pVector to be deleted together with
4788762ec19Sdrh ** the returned Expr object is to attach the pVector to the pRight field
4798762ec19Sdrh ** of the returned TK_SELECT_COLUMN Expr object.
480fc7f27b9Sdrh */
481fc7f27b9Sdrh Expr *sqlite3ExprForVectorField(
482fc7f27b9Sdrh   Parse *pParse,       /* Parsing context */
483fc7f27b9Sdrh   Expr *pVector,       /* The vector.  List of expressions or a sub-SELECT */
484a1251bc4Sdrh   int iField           /* Which column of the vector to return */
485fc7f27b9Sdrh ){
486fc7f27b9Sdrh   Expr *pRet;
487a1251bc4Sdrh   if( pVector->op==TK_SELECT ){
488a1251bc4Sdrh     assert( pVector->flags & EP_xIsSelect );
489fc7f27b9Sdrh     /* The TK_SELECT_COLUMN Expr node:
490fc7f27b9Sdrh     **
491966e2911Sdrh     ** pLeft:           pVector containing TK_SELECT.  Not deleted.
4928762ec19Sdrh     ** pRight:          not used.  But recursively deleted.
493fc7f27b9Sdrh     ** iColumn:         Index of a column in pVector
494966e2911Sdrh     ** iTable:          0 or the number of columns on the LHS of an assignment
495fc7f27b9Sdrh     ** pLeft->iTable:   First in an array of register holding result, or 0
496fc7f27b9Sdrh     **                  if the result is not yet computed.
497fc7f27b9Sdrh     **
498fc7f27b9Sdrh     ** sqlite3ExprDelete() specifically skips the recursive delete of
499fc7f27b9Sdrh     ** pLeft on TK_SELECT_COLUMN nodes.  But pRight is followed, so pVector
5008762ec19Sdrh     ** can be attached to pRight to cause this node to take ownership of
5018762ec19Sdrh     ** pVector.  Typically there will be multiple TK_SELECT_COLUMN nodes
5028762ec19Sdrh     ** with the same pLeft pointer to the pVector, but only one of them
5038762ec19Sdrh     ** will own the pVector.
504fc7f27b9Sdrh     */
505abfd35eaSdrh     pRet = sqlite3PExpr(pParse, TK_SELECT_COLUMN, 0, 0);
5068bd0d58eSdrh     if( pRet ){
5078bd0d58eSdrh       pRet->iColumn = iField;
5088bd0d58eSdrh       pRet->pLeft = pVector;
5098bd0d58eSdrh     }
510fc7f27b9Sdrh     assert( pRet==0 || pRet->iTable==0 );
511fc7f27b9Sdrh   }else{
512a1251bc4Sdrh     if( pVector->op==TK_VECTOR ) pVector = pVector->x.pList->a[iField].pExpr;
513a1251bc4Sdrh     pRet = sqlite3ExprDup(pParse->db, pVector, 0);
514dfb5c963Sdan     sqlite3RenameTokenRemap(pParse, pRet, pVector);
515fc7f27b9Sdrh   }
516fc7f27b9Sdrh   return pRet;
517fc7f27b9Sdrh }
51871c57db0Sdan 
5195c288b92Sdan /*
5205c288b92Sdan ** If expression pExpr is of type TK_SELECT, generate code to evaluate
5215c288b92Sdan ** it. Return the register in which the result is stored (or, if the
5225c288b92Sdan ** sub-select returns more than one column, the first in an array
5235c288b92Sdan ** of registers in which the result is stored).
5245c288b92Sdan **
5255c288b92Sdan ** If pExpr is not a TK_SELECT expression, return 0.
5265c288b92Sdan */
5275c288b92Sdan static int exprCodeSubselect(Parse *pParse, Expr *pExpr){
5288da209b1Sdan   int reg = 0;
529f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
5305c288b92Sdan   if( pExpr->op==TK_SELECT ){
53185bcdce2Sdrh     reg = sqlite3CodeSubselect(pParse, pExpr);
5328da209b1Sdan   }
533f9b2e05cSdan #endif
5348da209b1Sdan   return reg;
5358da209b1Sdan }
5368da209b1Sdan 
5375c288b92Sdan /*
5385c288b92Sdan ** Argument pVector points to a vector expression - either a TK_VECTOR
539870a0705Sdan ** or TK_SELECT that returns more than one column. This function returns
540870a0705Sdan ** the register number of a register that contains the value of
541870a0705Sdan ** element iField of the vector.
542870a0705Sdan **
543870a0705Sdan ** If pVector is a TK_SELECT expression, then code for it must have
544870a0705Sdan ** already been generated using the exprCodeSubselect() routine. In this
545870a0705Sdan ** case parameter regSelect should be the first in an array of registers
546870a0705Sdan ** containing the results of the sub-select.
547870a0705Sdan **
548870a0705Sdan ** If pVector is of type TK_VECTOR, then code for the requested field
549870a0705Sdan ** is generated. In this case (*pRegFree) may be set to the number of
550870a0705Sdan ** a temporary register to be freed by the caller before returning.
5515c288b92Sdan **
5525c288b92Sdan ** Before returning, output parameter (*ppExpr) is set to point to the
5535c288b92Sdan ** Expr object corresponding to element iElem of the vector.
5545c288b92Sdan */
5555c288b92Sdan static int exprVectorRegister(
5565c288b92Sdan   Parse *pParse,                  /* Parse context */
5575c288b92Sdan   Expr *pVector,                  /* Vector to extract element from */
558870a0705Sdan   int iField,                     /* Field to extract from pVector */
5595c288b92Sdan   int regSelect,                  /* First in array of registers */
5605c288b92Sdan   Expr **ppExpr,                  /* OUT: Expression element */
5615c288b92Sdan   int *pRegFree                   /* OUT: Temp register to free */
5625c288b92Sdan ){
56312abf408Sdrh   u8 op = pVector->op;
564c1bcd9ccSdrh   assert( op==TK_VECTOR || op==TK_REGISTER || op==TK_SELECT );
56512abf408Sdrh   if( op==TK_REGISTER ){
56612abf408Sdrh     *ppExpr = sqlite3VectorFieldSubexpr(pVector, iField);
56712abf408Sdrh     return pVector->iTable+iField;
56812abf408Sdrh   }
56912abf408Sdrh   if( op==TK_SELECT ){
570870a0705Sdan     *ppExpr = pVector->x.pSelect->pEList->a[iField].pExpr;
571870a0705Sdan      return regSelect+iField;
5725c288b92Sdan   }
573870a0705Sdan   *ppExpr = pVector->x.pList->a[iField].pExpr;
5745c288b92Sdan   return sqlite3ExprCodeTemp(pParse, *ppExpr, pRegFree);
5755c288b92Sdan }
5765c288b92Sdan 
5775c288b92Sdan /*
5785c288b92Sdan ** Expression pExpr is a comparison between two vector values. Compute
57979752b6eSdrh ** the result of the comparison (1, 0, or NULL) and write that
58079752b6eSdrh ** result into register dest.
58179752b6eSdrh **
58279752b6eSdrh ** The caller must satisfy the following preconditions:
58379752b6eSdrh **
58479752b6eSdrh **    if pExpr->op==TK_IS:      op==TK_EQ and p5==SQLITE_NULLEQ
58579752b6eSdrh **    if pExpr->op==TK_ISNOT:   op==TK_NE and p5==SQLITE_NULLEQ
58679752b6eSdrh **    otherwise:                op==pExpr->op and p5==0
5875c288b92Sdan */
58879752b6eSdrh static void codeVectorCompare(
58979752b6eSdrh   Parse *pParse,        /* Code generator context */
59079752b6eSdrh   Expr *pExpr,          /* The comparison operation */
59179752b6eSdrh   int dest,             /* Write results into this register */
59279752b6eSdrh   u8 op,                /* Comparison operator */
59379752b6eSdrh   u8 p5                 /* SQLITE_NULLEQ or zero */
59479752b6eSdrh ){
59571c57db0Sdan   Vdbe *v = pParse->pVdbe;
59671c57db0Sdan   Expr *pLeft = pExpr->pLeft;
59771c57db0Sdan   Expr *pRight = pExpr->pRight;
59871c57db0Sdan   int nLeft = sqlite3ExprVectorSize(pLeft);
59971c57db0Sdan   int i;
60071c57db0Sdan   int regLeft = 0;
60171c57db0Sdan   int regRight = 0;
60279752b6eSdrh   u8 opx = op;
603ec4ccdbcSdrh   int addrDone = sqlite3VdbeMakeLabel(pParse);
604898c527eSdrh   int isCommuted = ExprHasProperty(pExpr,EP_Commuted);
60571c57db0Sdan 
606e7375bfaSdrh   assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
60770d6b832Sdrh   if( pParse->nErr ) return;
608245ce62eSdrh   if( nLeft!=sqlite3ExprVectorSize(pRight) ){
609245ce62eSdrh     sqlite3ErrorMsg(pParse, "row value misused");
610245ce62eSdrh     return;
611245ce62eSdrh   }
61271c57db0Sdan   assert( pExpr->op==TK_EQ || pExpr->op==TK_NE
61371c57db0Sdan        || pExpr->op==TK_IS || pExpr->op==TK_ISNOT
61471c57db0Sdan        || pExpr->op==TK_LT || pExpr->op==TK_GT
61571c57db0Sdan        || pExpr->op==TK_LE || pExpr->op==TK_GE
61671c57db0Sdan   );
61779752b6eSdrh   assert( pExpr->op==op || (pExpr->op==TK_IS && op==TK_EQ)
61879752b6eSdrh             || (pExpr->op==TK_ISNOT && op==TK_NE) );
61979752b6eSdrh   assert( p5==0 || pExpr->op!=op );
62079752b6eSdrh   assert( p5==SQLITE_NULLEQ || pExpr->op==op );
62171c57db0Sdan 
62279752b6eSdrh   p5 |= SQLITE_STOREP2;
62379752b6eSdrh   if( opx==TK_LE ) opx = TK_LT;
62479752b6eSdrh   if( opx==TK_GE ) opx = TK_GT;
6255c288b92Sdan 
6265c288b92Sdan   regLeft = exprCodeSubselect(pParse, pLeft);
6275c288b92Sdan   regRight = exprCodeSubselect(pParse, pRight);
6285c288b92Sdan 
629321e828dSdrh   for(i=0; 1 /*Loop exits by "break"*/; i++){
6305c288b92Sdan     int regFree1 = 0, regFree2 = 0;
6315c288b92Sdan     Expr *pL, *pR;
6325c288b92Sdan     int r1, r2;
633321e828dSdrh     assert( i>=0 && i<nLeft );
6345c288b92Sdan     r1 = exprVectorRegister(pParse, pLeft, i, regLeft, &pL, &regFree1);
6355c288b92Sdan     r2 = exprVectorRegister(pParse, pRight, i, regRight, &pR, &regFree2);
636898c527eSdrh     codeCompare(pParse, pL, pR, opx, r1, r2, dest, p5, isCommuted);
63779752b6eSdrh     testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
63879752b6eSdrh     testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
63979752b6eSdrh     testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
64079752b6eSdrh     testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
64179752b6eSdrh     testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
64279752b6eSdrh     testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
64371c57db0Sdan     sqlite3ReleaseTempReg(pParse, regFree1);
64471c57db0Sdan     sqlite3ReleaseTempReg(pParse, regFree2);
64579752b6eSdrh     if( i==nLeft-1 ){
64679752b6eSdrh       break;
64771c57db0Sdan     }
64879752b6eSdrh     if( opx==TK_EQ ){
64979752b6eSdrh       sqlite3VdbeAddOp2(v, OP_IfNot, dest, addrDone); VdbeCoverage(v);
65079752b6eSdrh       p5 |= SQLITE_KEEPNULL;
65179752b6eSdrh     }else if( opx==TK_NE ){
65279752b6eSdrh       sqlite3VdbeAddOp2(v, OP_If, dest, addrDone); VdbeCoverage(v);
65379752b6eSdrh       p5 |= SQLITE_KEEPNULL;
654a2f62925Sdrh     }else{
655a2f62925Sdrh       assert( op==TK_LT || op==TK_GT || op==TK_LE || op==TK_GE );
656a2f62925Sdrh       sqlite3VdbeAddOp2(v, OP_ElseNotEq, 0, addrDone);
65779752b6eSdrh       VdbeCoverageIf(v, op==TK_LT);
65879752b6eSdrh       VdbeCoverageIf(v, op==TK_GT);
65979752b6eSdrh       VdbeCoverageIf(v, op==TK_LE);
66079752b6eSdrh       VdbeCoverageIf(v, op==TK_GE);
66179752b6eSdrh       if( i==nLeft-2 ) opx = op;
66271c57db0Sdan     }
66379752b6eSdrh   }
66479752b6eSdrh   sqlite3VdbeResolveLabel(v, addrDone);
66579752b6eSdrh }
66671c57db0Sdan 
6674b5255acSdanielk1977 #if SQLITE_MAX_EXPR_DEPTH>0
6684b5255acSdanielk1977 /*
6694b5255acSdanielk1977 ** Check that argument nHeight is less than or equal to the maximum
6704b5255acSdanielk1977 ** expression depth allowed. If it is not, leave an error message in
6714b5255acSdanielk1977 ** pParse.
6724b5255acSdanielk1977 */
6737d10d5a6Sdrh int sqlite3ExprCheckHeight(Parse *pParse, int nHeight){
6744b5255acSdanielk1977   int rc = SQLITE_OK;
6754b5255acSdanielk1977   int mxHeight = pParse->db->aLimit[SQLITE_LIMIT_EXPR_DEPTH];
6764b5255acSdanielk1977   if( nHeight>mxHeight ){
6774b5255acSdanielk1977     sqlite3ErrorMsg(pParse,
6784b5255acSdanielk1977        "Expression tree is too large (maximum depth %d)", mxHeight
6794b5255acSdanielk1977     );
6804b5255acSdanielk1977     rc = SQLITE_ERROR;
6814b5255acSdanielk1977   }
6824b5255acSdanielk1977   return rc;
6834b5255acSdanielk1977 }
6844b5255acSdanielk1977 
6854b5255acSdanielk1977 /* The following three functions, heightOfExpr(), heightOfExprList()
6864b5255acSdanielk1977 ** and heightOfSelect(), are used to determine the maximum height
6874b5255acSdanielk1977 ** of any expression tree referenced by the structure passed as the
6884b5255acSdanielk1977 ** first argument.
6894b5255acSdanielk1977 **
6904b5255acSdanielk1977 ** If this maximum height is greater than the current value pointed
6914b5255acSdanielk1977 ** to by pnHeight, the second parameter, then set *pnHeight to that
6924b5255acSdanielk1977 ** value.
6934b5255acSdanielk1977 */
6944b5255acSdanielk1977 static void heightOfExpr(Expr *p, int *pnHeight){
6954b5255acSdanielk1977   if( p ){
6964b5255acSdanielk1977     if( p->nHeight>*pnHeight ){
6974b5255acSdanielk1977       *pnHeight = p->nHeight;
6984b5255acSdanielk1977     }
6994b5255acSdanielk1977   }
7004b5255acSdanielk1977 }
7014b5255acSdanielk1977 static void heightOfExprList(ExprList *p, int *pnHeight){
7024b5255acSdanielk1977   if( p ){
7034b5255acSdanielk1977     int i;
7044b5255acSdanielk1977     for(i=0; i<p->nExpr; i++){
7054b5255acSdanielk1977       heightOfExpr(p->a[i].pExpr, pnHeight);
7064b5255acSdanielk1977     }
7074b5255acSdanielk1977   }
7084b5255acSdanielk1977 }
7091a3a3086Sdan static void heightOfSelect(Select *pSelect, int *pnHeight){
7101a3a3086Sdan   Select *p;
7111a3a3086Sdan   for(p=pSelect; p; p=p->pPrior){
7124b5255acSdanielk1977     heightOfExpr(p->pWhere, pnHeight);
7134b5255acSdanielk1977     heightOfExpr(p->pHaving, pnHeight);
7144b5255acSdanielk1977     heightOfExpr(p->pLimit, pnHeight);
7154b5255acSdanielk1977     heightOfExprList(p->pEList, pnHeight);
7164b5255acSdanielk1977     heightOfExprList(p->pGroupBy, pnHeight);
7174b5255acSdanielk1977     heightOfExprList(p->pOrderBy, pnHeight);
7184b5255acSdanielk1977   }
7194b5255acSdanielk1977 }
7204b5255acSdanielk1977 
7214b5255acSdanielk1977 /*
7224b5255acSdanielk1977 ** Set the Expr.nHeight variable in the structure passed as an
7234b5255acSdanielk1977 ** argument. An expression with no children, Expr.pList or
7244b5255acSdanielk1977 ** Expr.pSelect member has a height of 1. Any other expression
7254b5255acSdanielk1977 ** has a height equal to the maximum height of any other
7264b5255acSdanielk1977 ** referenced Expr plus one.
7272308ed38Sdrh **
7282308ed38Sdrh ** Also propagate EP_Propagate flags up from Expr.x.pList to Expr.flags,
7292308ed38Sdrh ** if appropriate.
7304b5255acSdanielk1977 */
7314b5255acSdanielk1977 static void exprSetHeight(Expr *p){
7324b5255acSdanielk1977   int nHeight = 0;
7334b5255acSdanielk1977   heightOfExpr(p->pLeft, &nHeight);
7344b5255acSdanielk1977   heightOfExpr(p->pRight, &nHeight);
7356ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_xIsSelect) ){
7366ab3a2ecSdanielk1977     heightOfSelect(p->x.pSelect, &nHeight);
7372308ed38Sdrh   }else if( p->x.pList ){
7386ab3a2ecSdanielk1977     heightOfExprList(p->x.pList, &nHeight);
7392308ed38Sdrh     p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
7406ab3a2ecSdanielk1977   }
7414b5255acSdanielk1977   p->nHeight = nHeight + 1;
7424b5255acSdanielk1977 }
7434b5255acSdanielk1977 
7444b5255acSdanielk1977 /*
7454b5255acSdanielk1977 ** Set the Expr.nHeight variable using the exprSetHeight() function. If
7464b5255acSdanielk1977 ** the height is greater than the maximum allowed expression depth,
7474b5255acSdanielk1977 ** leave an error in pParse.
7482308ed38Sdrh **
7492308ed38Sdrh ** Also propagate all EP_Propagate flags from the Expr.x.pList into
7502308ed38Sdrh ** Expr.flags.
7514b5255acSdanielk1977 */
7522308ed38Sdrh void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
75374893a4cSdrh   if( pParse->nErr ) return;
7544b5255acSdanielk1977   exprSetHeight(p);
7557d10d5a6Sdrh   sqlite3ExprCheckHeight(pParse, p->nHeight);
7564b5255acSdanielk1977 }
7574b5255acSdanielk1977 
7584b5255acSdanielk1977 /*
7594b5255acSdanielk1977 ** Return the maximum height of any expression tree referenced
7604b5255acSdanielk1977 ** by the select statement passed as an argument.
7614b5255acSdanielk1977 */
7624b5255acSdanielk1977 int sqlite3SelectExprHeight(Select *p){
7634b5255acSdanielk1977   int nHeight = 0;
7644b5255acSdanielk1977   heightOfSelect(p, &nHeight);
7654b5255acSdanielk1977   return nHeight;
7664b5255acSdanielk1977 }
7672308ed38Sdrh #else /* ABOVE:  Height enforcement enabled.  BELOW: Height enforcement off */
7682308ed38Sdrh /*
7692308ed38Sdrh ** Propagate all EP_Propagate flags from the Expr.x.pList into
7702308ed38Sdrh ** Expr.flags.
7712308ed38Sdrh */
7722308ed38Sdrh void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
7736c3b4b07Sdan   if( pParse->nErr ) return;
7742308ed38Sdrh   if( p && p->x.pList && !ExprHasProperty(p, EP_xIsSelect) ){
7752308ed38Sdrh     p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
7762308ed38Sdrh   }
7772308ed38Sdrh }
7784b5255acSdanielk1977 #define exprSetHeight(y)
7794b5255acSdanielk1977 #endif /* SQLITE_MAX_EXPR_DEPTH>0 */
7804b5255acSdanielk1977 
781be5c89acSdrh /*
782b7916a78Sdrh ** This routine is the core allocator for Expr nodes.
783b7916a78Sdrh **
784a76b5dfcSdrh ** Construct a new expression node and return a pointer to it.  Memory
785b7916a78Sdrh ** for this node and for the pToken argument is a single allocation
786b7916a78Sdrh ** obtained from sqlite3DbMalloc().  The calling function
787a76b5dfcSdrh ** is responsible for making sure the node eventually gets freed.
788b7916a78Sdrh **
789b7916a78Sdrh ** If dequote is true, then the token (if it exists) is dequoted.
790e792b5b4Sdrh ** If dequote is false, no dequoting is performed.  The deQuote
791b7916a78Sdrh ** parameter is ignored if pToken is NULL or if the token does not
792b7916a78Sdrh ** appear to be quoted.  If the quotes were of the form "..." (double-quotes)
793b7916a78Sdrh ** then the EP_DblQuoted flag is set on the expression node.
79433e619fcSdrh **
79533e619fcSdrh ** Special case:  If op==TK_INTEGER and pToken points to a string that
79633e619fcSdrh ** can be translated into a 32-bit integer, then the token is not
79733e619fcSdrh ** stored in u.zToken.  Instead, the integer values is written
79833e619fcSdrh ** into u.iValue and the EP_IntValue flag is set.  No extra storage
79933e619fcSdrh ** is allocated to hold the integer text and the dequote flag is ignored.
800a76b5dfcSdrh */
801b7916a78Sdrh Expr *sqlite3ExprAlloc(
802cca8a4adSdrh   sqlite3 *db,            /* Handle for sqlite3DbMallocRawNN() */
80317435752Sdrh   int op,                 /* Expression opcode */
804b7916a78Sdrh   const Token *pToken,    /* Token argument.  Might be NULL */
805b7916a78Sdrh   int dequote             /* True to dequote */
80617435752Sdrh ){
807a76b5dfcSdrh   Expr *pNew;
80833e619fcSdrh   int nExtra = 0;
809cf697396Sshane   int iValue = 0;
810b7916a78Sdrh 
811575fad65Sdrh   assert( db!=0 );
812b7916a78Sdrh   if( pToken ){
81333e619fcSdrh     if( op!=TK_INTEGER || pToken->z==0
81433e619fcSdrh           || sqlite3GetInt32(pToken->z, &iValue)==0 ){
815b7916a78Sdrh       nExtra = pToken->n+1;
816d50ffc41Sdrh       assert( iValue>=0 );
81733e619fcSdrh     }
818a76b5dfcSdrh   }
819575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, sizeof(Expr)+nExtra);
820b7916a78Sdrh   if( pNew ){
821ca3862dcSdrh     memset(pNew, 0, sizeof(Expr));
8221bd10f8aSdrh     pNew->op = (u8)op;
823a58fdfb1Sdanielk1977     pNew->iAgg = -1;
824a76b5dfcSdrh     if( pToken ){
82533e619fcSdrh       if( nExtra==0 ){
826ad31727fSdrh         pNew->flags |= EP_IntValue|EP_Leaf|(iValue?EP_IsTrue:EP_IsFalse);
82733e619fcSdrh         pNew->u.iValue = iValue;
82833e619fcSdrh       }else{
82933e619fcSdrh         pNew->u.zToken = (char*)&pNew[1];
830b07028f7Sdrh         assert( pToken->z!=0 || pToken->n==0 );
831b07028f7Sdrh         if( pToken->n ) memcpy(pNew->u.zToken, pToken->z, pToken->n);
83233e619fcSdrh         pNew->u.zToken[pToken->n] = 0;
833244b9d6eSdrh         if( dequote && sqlite3Isquote(pNew->u.zToken[0]) ){
83451d35b0fSdrh           sqlite3DequoteExpr(pNew);
835a34001c9Sdrh         }
836a34001c9Sdrh       }
83733e619fcSdrh     }
838b7916a78Sdrh #if SQLITE_MAX_EXPR_DEPTH>0
839b7916a78Sdrh     pNew->nHeight = 1;
840b7916a78Sdrh #endif
841a34001c9Sdrh   }
842a76b5dfcSdrh   return pNew;
843a76b5dfcSdrh }
844a76b5dfcSdrh 
845a76b5dfcSdrh /*
846b7916a78Sdrh ** Allocate a new expression node from a zero-terminated token that has
847b7916a78Sdrh ** already been dequoted.
848b7916a78Sdrh */
849b7916a78Sdrh Expr *sqlite3Expr(
850b7916a78Sdrh   sqlite3 *db,            /* Handle for sqlite3DbMallocZero() (may be null) */
851b7916a78Sdrh   int op,                 /* Expression opcode */
852b7916a78Sdrh   const char *zToken      /* Token argument.  Might be NULL */
853b7916a78Sdrh ){
854b7916a78Sdrh   Token x;
855b7916a78Sdrh   x.z = zToken;
856b40f06c6Sdrh   x.n = sqlite3Strlen30(zToken);
857b7916a78Sdrh   return sqlite3ExprAlloc(db, op, &x, 0);
858b7916a78Sdrh }
859b7916a78Sdrh 
860b7916a78Sdrh /*
861b7916a78Sdrh ** Attach subtrees pLeft and pRight to the Expr node pRoot.
862b7916a78Sdrh **
863b7916a78Sdrh ** If pRoot==NULL that means that a memory allocation error has occurred.
864b7916a78Sdrh ** In that case, delete the subtrees pLeft and pRight.
865b7916a78Sdrh */
866b7916a78Sdrh void sqlite3ExprAttachSubtrees(
867b7916a78Sdrh   sqlite3 *db,
868b7916a78Sdrh   Expr *pRoot,
869b7916a78Sdrh   Expr *pLeft,
870b7916a78Sdrh   Expr *pRight
871b7916a78Sdrh ){
872b7916a78Sdrh   if( pRoot==0 ){
873b7916a78Sdrh     assert( db->mallocFailed );
874b7916a78Sdrh     sqlite3ExprDelete(db, pLeft);
875b7916a78Sdrh     sqlite3ExprDelete(db, pRight);
876b7916a78Sdrh   }else{
877b7916a78Sdrh     if( pRight ){
878b7916a78Sdrh       pRoot->pRight = pRight;
879885a5b03Sdrh       pRoot->flags |= EP_Propagate & pRight->flags;
880b7916a78Sdrh     }
881b7916a78Sdrh     if( pLeft ){
882b7916a78Sdrh       pRoot->pLeft = pLeft;
883885a5b03Sdrh       pRoot->flags |= EP_Propagate & pLeft->flags;
884b7916a78Sdrh     }
885b7916a78Sdrh     exprSetHeight(pRoot);
886b7916a78Sdrh   }
887b7916a78Sdrh }
888b7916a78Sdrh 
889b7916a78Sdrh /*
89060ec914cSpeter.d.reid ** Allocate an Expr node which joins as many as two subtrees.
891b7916a78Sdrh **
892bf664469Sdrh ** One or both of the subtrees can be NULL.  Return a pointer to the new
893bf664469Sdrh ** Expr node.  Or, if an OOM error occurs, set pParse->db->mallocFailed,
894bf664469Sdrh ** free the subtrees and return NULL.
895206f3d96Sdrh */
89617435752Sdrh Expr *sqlite3PExpr(
89717435752Sdrh   Parse *pParse,          /* Parsing context */
89817435752Sdrh   int op,                 /* Expression opcode */
89917435752Sdrh   Expr *pLeft,            /* Left operand */
900abfd35eaSdrh   Expr *pRight            /* Right operand */
90117435752Sdrh ){
9025fb52caaSdrh   Expr *p;
903abfd35eaSdrh   p = sqlite3DbMallocRawNN(pParse->db, sizeof(Expr));
904abfd35eaSdrh   if( p ){
905abfd35eaSdrh     memset(p, 0, sizeof(Expr));
906f1722baaSdrh     p->op = op & 0xff;
907abfd35eaSdrh     p->iAgg = -1;
908b7916a78Sdrh     sqlite3ExprAttachSubtrees(pParse->db, p, pLeft, pRight);
9092b359bdbSdan     sqlite3ExprCheckHeight(pParse, p->nHeight);
910d5c851c1Sdrh   }else{
911d5c851c1Sdrh     sqlite3ExprDelete(pParse->db, pLeft);
912d5c851c1Sdrh     sqlite3ExprDelete(pParse->db, pRight);
9132b359bdbSdan   }
9144e0cff60Sdrh   return p;
9154e0cff60Sdrh }
9164e0cff60Sdrh 
9174e0cff60Sdrh /*
91808de4f79Sdrh ** Add pSelect to the Expr.x.pSelect field.  Or, if pExpr is NULL (due
91908de4f79Sdrh ** do a memory allocation failure) then delete the pSelect object.
92008de4f79Sdrh */
92108de4f79Sdrh void sqlite3PExprAddSelect(Parse *pParse, Expr *pExpr, Select *pSelect){
92208de4f79Sdrh   if( pExpr ){
92308de4f79Sdrh     pExpr->x.pSelect = pSelect;
92408de4f79Sdrh     ExprSetProperty(pExpr, EP_xIsSelect|EP_Subquery);
92508de4f79Sdrh     sqlite3ExprSetHeightAndFlags(pParse, pExpr);
92608de4f79Sdrh   }else{
92708de4f79Sdrh     assert( pParse->db->mallocFailed );
92808de4f79Sdrh     sqlite3SelectDelete(pParse->db, pSelect);
92908de4f79Sdrh   }
93008de4f79Sdrh }
93108de4f79Sdrh 
93208de4f79Sdrh 
93308de4f79Sdrh /*
93491bb0eedSdrh ** Join two expressions using an AND operator.  If either expression is
93591bb0eedSdrh ** NULL, then just return the other expression.
9365fb52caaSdrh **
9375fb52caaSdrh ** If one side or the other of the AND is known to be false, then instead
9385fb52caaSdrh ** of returning an AND expression, just return a constant expression with
9395fb52caaSdrh ** a value of false.
94091bb0eedSdrh */
941d5c851c1Sdrh Expr *sqlite3ExprAnd(Parse *pParse, Expr *pLeft, Expr *pRight){
942d5c851c1Sdrh   sqlite3 *db = pParse->db;
94391bb0eedSdrh   if( pLeft==0  ){
94491bb0eedSdrh     return pRight;
94591bb0eedSdrh   }else if( pRight==0 ){
94691bb0eedSdrh     return pLeft;
9472b6e670fSdan   }else if( (ExprAlwaysFalse(pLeft) || ExprAlwaysFalse(pRight))
9482b6e670fSdan          && !IN_RENAME_OBJECT
9492b6e670fSdan   ){
9502b6e670fSdan     sqlite3ExprDelete(db, pLeft);
9512b6e670fSdan     sqlite3ExprDelete(db, pRight);
9525776ee5cSdrh     return sqlite3Expr(db, TK_INTEGER, "0");
95391bb0eedSdrh   }else{
954d5c851c1Sdrh     return sqlite3PExpr(pParse, TK_AND, pLeft, pRight);
955a76b5dfcSdrh   }
956a76b5dfcSdrh }
957a76b5dfcSdrh 
958a76b5dfcSdrh /*
959a76b5dfcSdrh ** Construct a new expression node for a function with multiple
960a76b5dfcSdrh ** arguments.
961a76b5dfcSdrh */
962954733b3Sdrh Expr *sqlite3ExprFunction(
963954733b3Sdrh   Parse *pParse,        /* Parsing context */
964954733b3Sdrh   ExprList *pList,      /* Argument list */
965954733b3Sdrh   Token *pToken,        /* Name of the function */
966954733b3Sdrh   int eDistinct         /* SF_Distinct or SF_ALL or 0 */
967954733b3Sdrh ){
968a76b5dfcSdrh   Expr *pNew;
969633e6d57Sdrh   sqlite3 *db = pParse->db;
9704b202ae2Sdanielk1977   assert( pToken );
971b7916a78Sdrh   pNew = sqlite3ExprAlloc(db, TK_FUNCTION, pToken, 1);
972a76b5dfcSdrh   if( pNew==0 ){
973d9da78a2Sdrh     sqlite3ExprListDelete(db, pList); /* Avoid memory leak when malloc fails */
974a76b5dfcSdrh     return 0;
975a76b5dfcSdrh   }
976954733b3Sdrh   if( pList && pList->nExpr > pParse->db->aLimit[SQLITE_LIMIT_FUNCTION_ARG] ){
977954733b3Sdrh     sqlite3ErrorMsg(pParse, "too many arguments on function %T", pToken);
978954733b3Sdrh   }
9796ab3a2ecSdanielk1977   pNew->x.pList = pList;
980fca23557Sdrh   ExprSetProperty(pNew, EP_HasFunc);
9816ab3a2ecSdanielk1977   assert( !ExprHasProperty(pNew, EP_xIsSelect) );
9822308ed38Sdrh   sqlite3ExprSetHeightAndFlags(pParse, pNew);
983954733b3Sdrh   if( eDistinct==SF_Distinct ) ExprSetProperty(pNew, EP_Distinct);
984a76b5dfcSdrh   return pNew;
985a76b5dfcSdrh }
986a76b5dfcSdrh 
987a76b5dfcSdrh /*
9880dfa5255Sdrh ** Check to see if a function is usable according to current access
9890dfa5255Sdrh ** rules:
9900dfa5255Sdrh **
9910dfa5255Sdrh **    SQLITE_FUNC_DIRECT    -     Only usable from top-level SQL
9920dfa5255Sdrh **
9930dfa5255Sdrh **    SQLITE_FUNC_UNSAFE    -     Usable if TRUSTED_SCHEMA or from
9940dfa5255Sdrh **                                top-level SQL
9950dfa5255Sdrh **
9960dfa5255Sdrh ** If the function is not usable, create an error.
9970dfa5255Sdrh */
9980dfa5255Sdrh void sqlite3ExprFunctionUsable(
9990dfa5255Sdrh   Parse *pParse,         /* Parsing and code generating context */
10000dfa5255Sdrh   Expr *pExpr,           /* The function invocation */
10010dfa5255Sdrh   FuncDef *pDef          /* The function being invoked */
10020dfa5255Sdrh ){
10030dfa5255Sdrh   assert( !IN_RENAME_OBJECT );
10042eeca204Sdrh   assert( (pDef->funcFlags & (SQLITE_FUNC_DIRECT|SQLITE_FUNC_UNSAFE))!=0 );
10052eeca204Sdrh   if( ExprHasProperty(pExpr, EP_FromDDL) ){
10060dfa5255Sdrh     if( (pDef->funcFlags & SQLITE_FUNC_DIRECT)!=0
10070dfa5255Sdrh      || (pParse->db->flags & SQLITE_TrustedSchema)==0
10080dfa5255Sdrh     ){
10090dfa5255Sdrh       /* Functions prohibited in triggers and views if:
10100dfa5255Sdrh       **     (1) tagged with SQLITE_DIRECTONLY
10110dfa5255Sdrh       **     (2) not tagged with SQLITE_INNOCUOUS (which means it
10120dfa5255Sdrh       **         is tagged with SQLITE_FUNC_UNSAFE) and
10130dfa5255Sdrh       **         SQLITE_DBCONFIG_TRUSTED_SCHEMA is off (meaning
10140dfa5255Sdrh       **         that the schema is possibly tainted).
10150dfa5255Sdrh       */
10160dfa5255Sdrh       sqlite3ErrorMsg(pParse, "unsafe use of %s()", pDef->zName);
10170dfa5255Sdrh     }
10180dfa5255Sdrh   }
10190dfa5255Sdrh }
10200dfa5255Sdrh 
10210dfa5255Sdrh /*
1022fa6bc000Sdrh ** Assign a variable number to an expression that encodes a wildcard
1023fa6bc000Sdrh ** in the original SQL statement.
1024fa6bc000Sdrh **
1025fa6bc000Sdrh ** Wildcards consisting of a single "?" are assigned the next sequential
1026fa6bc000Sdrh ** variable number.
1027fa6bc000Sdrh **
1028fa6bc000Sdrh ** Wildcards of the form "?nnn" are assigned the number "nnn".  We make
10299bf755ccSdrh ** sure "nnn" is not too big to avoid a denial of service attack when
1030fa6bc000Sdrh ** the SQL statement comes from an external source.
1031fa6bc000Sdrh **
103251f49f17Sdrh ** Wildcards of the form ":aaa", "@aaa", or "$aaa" are assigned the same number
1033fa6bc000Sdrh ** as the previous instance of the same wildcard.  Or if this is the first
103460ec914cSpeter.d.reid ** instance of the wildcard, the next sequential variable number is
1035fa6bc000Sdrh ** assigned.
1036fa6bc000Sdrh */
1037de25a88cSdrh void sqlite3ExprAssignVarNumber(Parse *pParse, Expr *pExpr, u32 n){
103817435752Sdrh   sqlite3 *db = pParse->db;
1039b7916a78Sdrh   const char *z;
1040f326d66dSdrh   ynVar x;
104117435752Sdrh 
1042fa6bc000Sdrh   if( pExpr==0 ) return;
1043c5cd1249Sdrh   assert( !ExprHasProperty(pExpr, EP_IntValue|EP_Reduced|EP_TokenOnly) );
104433e619fcSdrh   z = pExpr->u.zToken;
1045b7916a78Sdrh   assert( z!=0 );
1046b7916a78Sdrh   assert( z[0]!=0 );
1047b1ed717fSmistachkin   assert( n==(u32)sqlite3Strlen30(z) );
1048b7916a78Sdrh   if( z[1]==0 ){
1049fa6bc000Sdrh     /* Wildcard of the form "?".  Assign the next variable number */
1050b7916a78Sdrh     assert( z[0]=='?' );
1051f326d66dSdrh     x = (ynVar)(++pParse->nVar);
1052124c0b49Sdrh   }else{
1053f326d66dSdrh     int doAdd = 0;
1054124c0b49Sdrh     if( z[0]=='?' ){
1055fa6bc000Sdrh       /* Wildcard of the form "?nnn".  Convert "nnn" to an integer and
1056fa6bc000Sdrh       ** use it as the variable number */
1057c8d735aeSdan       i64 i;
105818814dfbSdrh       int bOk;
105918814dfbSdrh       if( n==2 ){ /*OPTIMIZATION-IF-TRUE*/
106018814dfbSdrh         i = z[1]-'0';  /* The common case of ?N for a single digit N */
106118814dfbSdrh         bOk = 1;
106218814dfbSdrh       }else{
106318814dfbSdrh         bOk = 0==sqlite3Atoi64(&z[1], &i, n-1, SQLITE_UTF8);
106418814dfbSdrh       }
1065c5499befSdrh       testcase( i==0 );
1066c5499befSdrh       testcase( i==1 );
1067c5499befSdrh       testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]-1 );
1068c5499befSdrh       testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] );
1069c8d735aeSdan       if( bOk==0 || i<1 || i>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
1070fa6bc000Sdrh         sqlite3ErrorMsg(pParse, "variable number must be between ?1 and ?%d",
1071bb4957f8Sdrh             db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]);
1072c9b39288Sdrh         return;
1073fa6bc000Sdrh       }
10748e74e7baSdrh       x = (ynVar)i;
1075f326d66dSdrh       if( x>pParse->nVar ){
1076f326d66dSdrh         pParse->nVar = (int)x;
1077f326d66dSdrh         doAdd = 1;
1078f326d66dSdrh       }else if( sqlite3VListNumToName(pParse->pVList, x)==0 ){
1079f326d66dSdrh         doAdd = 1;
1080fa6bc000Sdrh       }
1081fa6bc000Sdrh     }else{
108251f49f17Sdrh       /* Wildcards like ":aaa", "$aaa" or "@aaa".  Reuse the same variable
1083fa6bc000Sdrh       ** number as the prior appearance of the same name, or if the name
1084fa6bc000Sdrh       ** has never appeared before, reuse the same variable number
1085fa6bc000Sdrh       */
10869bf755ccSdrh       x = (ynVar)sqlite3VListNameToNum(pParse->pVList, z, n);
10879bf755ccSdrh       if( x==0 ){
10889bf755ccSdrh         x = (ynVar)(++pParse->nVar);
1089f326d66dSdrh         doAdd = 1;
1090f326d66dSdrh       }
1091f326d66dSdrh     }
1092f326d66dSdrh     if( doAdd ){
10939bf755ccSdrh       pParse->pVList = sqlite3VListAdd(db, pParse->pVList, z, n, x);
1094fa6bc000Sdrh     }
1095fa6bc000Sdrh   }
1096c9b39288Sdrh   pExpr->iColumn = x;
1097f326d66dSdrh   if( x>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
1098832b2664Sdanielk1977     sqlite3ErrorMsg(pParse, "too many SQL variables");
1099832b2664Sdanielk1977   }
1100fa6bc000Sdrh }
1101fa6bc000Sdrh 
1102fa6bc000Sdrh /*
1103f6963f99Sdan ** Recursively delete an expression tree.
1104a2e00042Sdrh */
11054f0010b1Sdrh static SQLITE_NOINLINE void sqlite3ExprDeleteNN(sqlite3 *db, Expr *p){
11064f0010b1Sdrh   assert( p!=0 );
1107d50ffc41Sdrh   /* Sanity check: Assert that the IntValue is non-negative if it exists */
1108d50ffc41Sdrh   assert( !ExprHasProperty(p, EP_IntValue) || p->u.iValue>=0 );
1109eda079cdSdrh 
1110eda079cdSdrh   assert( !ExprHasProperty(p, EP_WinFunc) || p->y.pWin!=0 || db->mallocFailed );
1111eda079cdSdrh   assert( p->op!=TK_FUNCTION || ExprHasProperty(p, EP_TokenOnly|EP_Reduced)
11124f9adee2Sdan           || p->y.pWin==0 || ExprHasProperty(p, EP_WinFunc) );
1113209bc522Sdrh #ifdef SQLITE_DEBUG
1114209bc522Sdrh   if( ExprHasProperty(p, EP_Leaf) && !ExprHasProperty(p, EP_TokenOnly) ){
1115209bc522Sdrh     assert( p->pLeft==0 );
1116209bc522Sdrh     assert( p->pRight==0 );
1117209bc522Sdrh     assert( p->x.pSelect==0 );
1118209bc522Sdrh   }
1119209bc522Sdrh #endif
1120209bc522Sdrh   if( !ExprHasProperty(p, (EP_TokenOnly|EP_Leaf)) ){
1121c5cd1249Sdrh     /* The Expr.x union is never used at the same time as Expr.pRight */
1122c5cd1249Sdrh     assert( p->x.pList==0 || p->pRight==0 );
11234910a76dSdrh     if( p->pLeft && p->op!=TK_SELECT_COLUMN ) sqlite3ExprDeleteNN(db, p->pLeft);
1124d1086679Sdrh     if( p->pRight ){
11254f9adee2Sdan       assert( !ExprHasProperty(p, EP_WinFunc) );
1126d1086679Sdrh       sqlite3ExprDeleteNN(db, p->pRight);
1127d1086679Sdrh     }else if( ExprHasProperty(p, EP_xIsSelect) ){
11284f9adee2Sdan       assert( !ExprHasProperty(p, EP_WinFunc) );
11296ab3a2ecSdanielk1977       sqlite3SelectDelete(db, p->x.pSelect);
11306ab3a2ecSdanielk1977     }else{
11316ab3a2ecSdanielk1977       sqlite3ExprListDelete(db, p->x.pList);
11326ba7ab0dSdan #ifndef SQLITE_OMIT_WINDOWFUNC
1133eda079cdSdrh       if( ExprHasProperty(p, EP_WinFunc) ){
1134eda079cdSdrh         sqlite3WindowDelete(db, p->y.pWin);
113586fb6e17Sdan       }
11366ba7ab0dSdan #endif
11376ab3a2ecSdanielk1977     }
11388117f113Sdan   }
1139209bc522Sdrh   if( ExprHasProperty(p, EP_MemToken) ) sqlite3DbFree(db, p->u.zToken);
114033e619fcSdrh   if( !ExprHasProperty(p, EP_Static) ){
1141dbd6a7dcSdrh     sqlite3DbFreeNN(db, p);
1142a2e00042Sdrh   }
114333e619fcSdrh }
11444f0010b1Sdrh void sqlite3ExprDelete(sqlite3 *db, Expr *p){
11454f0010b1Sdrh   if( p ) sqlite3ExprDeleteNN(db, p);
11464f0010b1Sdrh }
1147a2e00042Sdrh 
11488e34e406Sdrh /* Invoke sqlite3RenameExprUnmap() and sqlite3ExprDelete() on the
11498e34e406Sdrh ** expression.
11508e34e406Sdrh */
11518e34e406Sdrh void sqlite3ExprUnmapAndDelete(Parse *pParse, Expr *p){
11528e34e406Sdrh   if( p ){
11538e34e406Sdrh     if( IN_RENAME_OBJECT ){
11548e34e406Sdrh       sqlite3RenameExprUnmap(pParse, p);
11558e34e406Sdrh     }
11568e34e406Sdrh     sqlite3ExprDeleteNN(pParse->db, p);
11578e34e406Sdrh   }
11588e34e406Sdrh }
11598e34e406Sdrh 
1160d2687b77Sdrh /*
11616ab3a2ecSdanielk1977 ** Return the number of bytes allocated for the expression structure
11626ab3a2ecSdanielk1977 ** passed as the first argument. This is always one of EXPR_FULLSIZE,
11636ab3a2ecSdanielk1977 ** EXPR_REDUCEDSIZE or EXPR_TOKENONLYSIZE.
11646ab3a2ecSdanielk1977 */
11656ab3a2ecSdanielk1977 static int exprStructSize(Expr *p){
11666ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_TokenOnly) ) return EXPR_TOKENONLYSIZE;
11676ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_Reduced) ) return EXPR_REDUCEDSIZE;
11686ab3a2ecSdanielk1977   return EXPR_FULLSIZE;
11696ab3a2ecSdanielk1977 }
11706ab3a2ecSdanielk1977 
11716ab3a2ecSdanielk1977 /*
117233e619fcSdrh ** The dupedExpr*Size() routines each return the number of bytes required
117333e619fcSdrh ** to store a copy of an expression or expression tree.  They differ in
117433e619fcSdrh ** how much of the tree is measured.
117533e619fcSdrh **
117633e619fcSdrh **     dupedExprStructSize()     Size of only the Expr structure
117733e619fcSdrh **     dupedExprNodeSize()       Size of Expr + space for token
117833e619fcSdrh **     dupedExprSize()           Expr + token + subtree components
117933e619fcSdrh **
118033e619fcSdrh ***************************************************************************
118133e619fcSdrh **
118233e619fcSdrh ** The dupedExprStructSize() function returns two values OR-ed together:
118333e619fcSdrh ** (1) the space required for a copy of the Expr structure only and
118433e619fcSdrh ** (2) the EP_xxx flags that indicate what the structure size should be.
118533e619fcSdrh ** The return values is always one of:
118633e619fcSdrh **
118733e619fcSdrh **      EXPR_FULLSIZE
118833e619fcSdrh **      EXPR_REDUCEDSIZE   | EP_Reduced
118933e619fcSdrh **      EXPR_TOKENONLYSIZE | EP_TokenOnly
119033e619fcSdrh **
119133e619fcSdrh ** The size of the structure can be found by masking the return value
119233e619fcSdrh ** of this routine with 0xfff.  The flags can be found by masking the
119333e619fcSdrh ** return value with EP_Reduced|EP_TokenOnly.
119433e619fcSdrh **
119533e619fcSdrh ** Note that with flags==EXPRDUP_REDUCE, this routines works on full-size
119633e619fcSdrh ** (unreduced) Expr objects as they or originally constructed by the parser.
119733e619fcSdrh ** During expression analysis, extra information is computed and moved into
1198c95f38d4Sdan ** later parts of the Expr object and that extra information might get chopped
119933e619fcSdrh ** off if the expression is reduced.  Note also that it does not work to
120060ec914cSpeter.d.reid ** make an EXPRDUP_REDUCE copy of a reduced expression.  It is only legal
120133e619fcSdrh ** to reduce a pristine expression tree from the parser.  The implementation
120233e619fcSdrh ** of dupedExprStructSize() contain multiple assert() statements that attempt
120333e619fcSdrh ** to enforce this constraint.
12046ab3a2ecSdanielk1977 */
12056ab3a2ecSdanielk1977 static int dupedExprStructSize(Expr *p, int flags){
12066ab3a2ecSdanielk1977   int nSize;
120733e619fcSdrh   assert( flags==EXPRDUP_REDUCE || flags==0 ); /* Only one flag value allowed */
1208aecd8021Sdrh   assert( EXPR_FULLSIZE<=0xfff );
1209aecd8021Sdrh   assert( (0xfff & (EP_Reduced|EP_TokenOnly))==0 );
121067a9b8edSdan   if( 0==flags || p->op==TK_SELECT_COLUMN
121167a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
1212eda079cdSdrh    || ExprHasProperty(p, EP_WinFunc)
121367a9b8edSdan #endif
121467a9b8edSdan   ){
12156ab3a2ecSdanielk1977     nSize = EXPR_FULLSIZE;
12166ab3a2ecSdanielk1977   }else{
1217c5cd1249Sdrh     assert( !ExprHasProperty(p, EP_TokenOnly|EP_Reduced) );
121833e619fcSdrh     assert( !ExprHasProperty(p, EP_FromJoin) );
1219c5cd1249Sdrh     assert( !ExprHasProperty(p, EP_MemToken) );
1220e7375bfaSdrh     assert( !ExprHasVVAProperty(p, EP_NoReduce) );
1221aecd8021Sdrh     if( p->pLeft || p->x.pList ){
122233e619fcSdrh       nSize = EXPR_REDUCEDSIZE | EP_Reduced;
122333e619fcSdrh     }else{
1224aecd8021Sdrh       assert( p->pRight==0 );
122533e619fcSdrh       nSize = EXPR_TOKENONLYSIZE | EP_TokenOnly;
122633e619fcSdrh     }
12276ab3a2ecSdanielk1977   }
12286ab3a2ecSdanielk1977   return nSize;
12296ab3a2ecSdanielk1977 }
12306ab3a2ecSdanielk1977 
12316ab3a2ecSdanielk1977 /*
123233e619fcSdrh ** This function returns the space in bytes required to store the copy
123333e619fcSdrh ** of the Expr structure and a copy of the Expr.u.zToken string (if that
123433e619fcSdrh ** string is defined.)
12356ab3a2ecSdanielk1977 */
12366ab3a2ecSdanielk1977 static int dupedExprNodeSize(Expr *p, int flags){
123733e619fcSdrh   int nByte = dupedExprStructSize(p, flags) & 0xfff;
123833e619fcSdrh   if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
12397301e774Sdrh     nByte += sqlite3Strlen30NN(p->u.zToken)+1;
12406ab3a2ecSdanielk1977   }
1241bc73971dSdanielk1977   return ROUND8(nByte);
12426ab3a2ecSdanielk1977 }
12436ab3a2ecSdanielk1977 
12446ab3a2ecSdanielk1977 /*
12456ab3a2ecSdanielk1977 ** Return the number of bytes required to create a duplicate of the
12466ab3a2ecSdanielk1977 ** expression passed as the first argument. The second argument is a
12476ab3a2ecSdanielk1977 ** mask containing EXPRDUP_XXX flags.
12486ab3a2ecSdanielk1977 **
12496ab3a2ecSdanielk1977 ** The value returned includes space to create a copy of the Expr struct
125033e619fcSdrh ** itself and the buffer referred to by Expr.u.zToken, if any.
12516ab3a2ecSdanielk1977 **
12526ab3a2ecSdanielk1977 ** If the EXPRDUP_REDUCE flag is set, then the return value includes
12536ab3a2ecSdanielk1977 ** space to duplicate all Expr nodes in the tree formed by Expr.pLeft
12546ab3a2ecSdanielk1977 ** and Expr.pRight variables (but not for any structures pointed to or
12556ab3a2ecSdanielk1977 ** descended from the Expr.x.pList or Expr.x.pSelect variables).
12566ab3a2ecSdanielk1977 */
12576ab3a2ecSdanielk1977 static int dupedExprSize(Expr *p, int flags){
12586ab3a2ecSdanielk1977   int nByte = 0;
12596ab3a2ecSdanielk1977   if( p ){
12606ab3a2ecSdanielk1977     nByte = dupedExprNodeSize(p, flags);
12616ab3a2ecSdanielk1977     if( flags&EXPRDUP_REDUCE ){
1262b7916a78Sdrh       nByte += dupedExprSize(p->pLeft, flags) + dupedExprSize(p->pRight, flags);
12636ab3a2ecSdanielk1977     }
12646ab3a2ecSdanielk1977   }
12656ab3a2ecSdanielk1977   return nByte;
12666ab3a2ecSdanielk1977 }
12676ab3a2ecSdanielk1977 
12686ab3a2ecSdanielk1977 /*
12696ab3a2ecSdanielk1977 ** This function is similar to sqlite3ExprDup(), except that if pzBuffer
12706ab3a2ecSdanielk1977 ** is not NULL then *pzBuffer is assumed to point to a buffer large enough
127133e619fcSdrh ** to store the copy of expression p, the copies of p->u.zToken
12726ab3a2ecSdanielk1977 ** (if applicable), and the copies of the p->pLeft and p->pRight expressions,
127360ec914cSpeter.d.reid ** if any. Before returning, *pzBuffer is set to the first byte past the
12746ab3a2ecSdanielk1977 ** portion of the buffer copied into by this function.
12756ab3a2ecSdanielk1977 */
12763c19469cSdrh static Expr *exprDup(sqlite3 *db, Expr *p, int dupFlags, u8 **pzBuffer){
12773c19469cSdrh   Expr *pNew;           /* Value to return */
12783c19469cSdrh   u8 *zAlloc;           /* Memory space from which to build Expr object */
12793c19469cSdrh   u32 staticFlag;       /* EP_Static if space not obtained from malloc */
12806ab3a2ecSdanielk1977 
12813c19469cSdrh   assert( db!=0 );
12823c19469cSdrh   assert( p );
12833c19469cSdrh   assert( dupFlags==0 || dupFlags==EXPRDUP_REDUCE );
12843c19469cSdrh   assert( pzBuffer==0 || dupFlags==EXPRDUP_REDUCE );
12856ab3a2ecSdanielk1977 
12866ab3a2ecSdanielk1977   /* Figure out where to write the new Expr structure. */
12876ab3a2ecSdanielk1977   if( pzBuffer ){
12886ab3a2ecSdanielk1977     zAlloc = *pzBuffer;
128933e619fcSdrh     staticFlag = EP_Static;
12906ab3a2ecSdanielk1977   }else{
12913c19469cSdrh     zAlloc = sqlite3DbMallocRawNN(db, dupedExprSize(p, dupFlags));
12923c19469cSdrh     staticFlag = 0;
12936ab3a2ecSdanielk1977   }
12946ab3a2ecSdanielk1977   pNew = (Expr *)zAlloc;
12956ab3a2ecSdanielk1977 
12966ab3a2ecSdanielk1977   if( pNew ){
12976ab3a2ecSdanielk1977     /* Set nNewSize to the size allocated for the structure pointed to
12986ab3a2ecSdanielk1977     ** by pNew. This is either EXPR_FULLSIZE, EXPR_REDUCEDSIZE or
12996ab3a2ecSdanielk1977     ** EXPR_TOKENONLYSIZE. nToken is set to the number of bytes consumed
130033e619fcSdrh     ** by the copy of the p->u.zToken string (if any).
13016ab3a2ecSdanielk1977     */
13023c19469cSdrh     const unsigned nStructSize = dupedExprStructSize(p, dupFlags);
130333e619fcSdrh     const int nNewSize = nStructSize & 0xfff;
130433e619fcSdrh     int nToken;
130533e619fcSdrh     if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
130633e619fcSdrh       nToken = sqlite3Strlen30(p->u.zToken) + 1;
130733e619fcSdrh     }else{
130833e619fcSdrh       nToken = 0;
130933e619fcSdrh     }
13103c19469cSdrh     if( dupFlags ){
13116ab3a2ecSdanielk1977       assert( ExprHasProperty(p, EP_Reduced)==0 );
13126ab3a2ecSdanielk1977       memcpy(zAlloc, p, nNewSize);
13136ab3a2ecSdanielk1977     }else{
13143e6a1411Sdan       u32 nSize = (u32)exprStructSize(p);
13156ab3a2ecSdanielk1977       memcpy(zAlloc, p, nSize);
131672ea29d7Sdrh       if( nSize<EXPR_FULLSIZE ){
13176ab3a2ecSdanielk1977         memset(&zAlloc[nSize], 0, EXPR_FULLSIZE-nSize);
13186ab3a2ecSdanielk1977       }
131972ea29d7Sdrh     }
13206ab3a2ecSdanielk1977 
132133e619fcSdrh     /* Set the EP_Reduced, EP_TokenOnly, and EP_Static flags appropriately. */
1322c5cd1249Sdrh     pNew->flags &= ~(EP_Reduced|EP_TokenOnly|EP_Static|EP_MemToken);
132333e619fcSdrh     pNew->flags |= nStructSize & (EP_Reduced|EP_TokenOnly);
132433e619fcSdrh     pNew->flags |= staticFlag;
1325e7375bfaSdrh     ExprClearVVAProperties(pNew);
1326e7375bfaSdrh     if( dupFlags ){
1327e7375bfaSdrh       ExprSetVVAProperty(pNew, EP_Immutable);
1328e7375bfaSdrh     }
13296ab3a2ecSdanielk1977 
133033e619fcSdrh     /* Copy the p->u.zToken string, if any. */
13316ab3a2ecSdanielk1977     if( nToken ){
133233e619fcSdrh       char *zToken = pNew->u.zToken = (char*)&zAlloc[nNewSize];
133333e619fcSdrh       memcpy(zToken, p->u.zToken, nToken);
13346ab3a2ecSdanielk1977     }
13356ab3a2ecSdanielk1977 
1336209bc522Sdrh     if( 0==((p->flags|pNew->flags) & (EP_TokenOnly|EP_Leaf)) ){
13376ab3a2ecSdanielk1977       /* Fill in the pNew->x.pSelect or pNew->x.pList member. */
13386ab3a2ecSdanielk1977       if( ExprHasProperty(p, EP_xIsSelect) ){
13393c19469cSdrh         pNew->x.pSelect = sqlite3SelectDup(db, p->x.pSelect, dupFlags);
13406ab3a2ecSdanielk1977       }else{
13413c19469cSdrh         pNew->x.pList = sqlite3ExprListDup(db, p->x.pList, dupFlags);
13426ab3a2ecSdanielk1977       }
13436ab3a2ecSdanielk1977     }
13446ab3a2ecSdanielk1977 
13456ab3a2ecSdanielk1977     /* Fill in pNew->pLeft and pNew->pRight. */
13464f9adee2Sdan     if( ExprHasProperty(pNew, EP_Reduced|EP_TokenOnly|EP_WinFunc) ){
13473c19469cSdrh       zAlloc += dupedExprNodeSize(p, dupFlags);
1348209bc522Sdrh       if( !ExprHasProperty(pNew, EP_TokenOnly|EP_Leaf) ){
13493c19469cSdrh         pNew->pLeft = p->pLeft ?
13503c19469cSdrh                       exprDup(db, p->pLeft, EXPRDUP_REDUCE, &zAlloc) : 0;
13513c19469cSdrh         pNew->pRight = p->pRight ?
13523c19469cSdrh                        exprDup(db, p->pRight, EXPRDUP_REDUCE, &zAlloc) : 0;
13536ab3a2ecSdanielk1977       }
135467a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
1355eda079cdSdrh       if( ExprHasProperty(p, EP_WinFunc) ){
1356eda079cdSdrh         pNew->y.pWin = sqlite3WindowDup(db, pNew, p->y.pWin);
1357eda079cdSdrh         assert( ExprHasProperty(pNew, EP_WinFunc) );
1358e2f781b9Sdan       }
135967a9b8edSdan #endif /* SQLITE_OMIT_WINDOWFUNC */
136053988068Sdrh       if( pzBuffer ){
136153988068Sdrh         *pzBuffer = zAlloc;
136253988068Sdrh       }
136353988068Sdrh     }else{
1364209bc522Sdrh       if( !ExprHasProperty(p, EP_TokenOnly|EP_Leaf) ){
13659854260bSdrh         if( pNew->op==TK_SELECT_COLUMN ){
13669854260bSdrh           pNew->pLeft = p->pLeft;
136747073f62Sdrh           assert( p->iColumn==0 || p->pRight==0 );
136847073f62Sdrh           assert( p->pRight==0  || p->pRight==p->pLeft );
13699854260bSdrh         }else{
13706ab3a2ecSdanielk1977           pNew->pLeft = sqlite3ExprDup(db, p->pLeft, 0);
13719854260bSdrh         }
13726ab3a2ecSdanielk1977         pNew->pRight = sqlite3ExprDup(db, p->pRight, 0);
13736ab3a2ecSdanielk1977       }
13746ab3a2ecSdanielk1977     }
13756ab3a2ecSdanielk1977   }
13766ab3a2ecSdanielk1977   return pNew;
13776ab3a2ecSdanielk1977 }
13786ab3a2ecSdanielk1977 
13796ab3a2ecSdanielk1977 /*
1380bfe31e7fSdan ** Create and return a deep copy of the object passed as the second
1381bfe31e7fSdan ** argument. If an OOM condition is encountered, NULL is returned
1382bfe31e7fSdan ** and the db->mallocFailed flag set.
1383bfe31e7fSdan */
1384eede6a53Sdan #ifndef SQLITE_OMIT_CTE
1385bfe31e7fSdan static With *withDup(sqlite3 *db, With *p){
13864e9119d9Sdan   With *pRet = 0;
13874e9119d9Sdan   if( p ){
1388d4de9f7bSdrh     sqlite3_int64 nByte = sizeof(*p) + sizeof(p->a[0]) * (p->nCte-1);
13894e9119d9Sdan     pRet = sqlite3DbMallocZero(db, nByte);
13904e9119d9Sdan     if( pRet ){
13914e9119d9Sdan       int i;
13924e9119d9Sdan       pRet->nCte = p->nCte;
13934e9119d9Sdan       for(i=0; i<p->nCte; i++){
13944e9119d9Sdan         pRet->a[i].pSelect = sqlite3SelectDup(db, p->a[i].pSelect, 0);
13954e9119d9Sdan         pRet->a[i].pCols = sqlite3ExprListDup(db, p->a[i].pCols, 0);
13964e9119d9Sdan         pRet->a[i].zName = sqlite3DbStrDup(db, p->a[i].zName);
13974e9119d9Sdan       }
13984e9119d9Sdan     }
13994e9119d9Sdan   }
14004e9119d9Sdan   return pRet;
14014e9119d9Sdan }
1402eede6a53Sdan #else
1403eede6a53Sdan # define withDup(x,y) 0
1404eede6a53Sdan #endif
14054e9119d9Sdan 
1406a8389975Sdrh #ifndef SQLITE_OMIT_WINDOWFUNC
1407a8389975Sdrh /*
1408a8389975Sdrh ** The gatherSelectWindows() procedure and its helper routine
1409a8389975Sdrh ** gatherSelectWindowsCallback() are used to scan all the expressions
1410a8389975Sdrh ** an a newly duplicated SELECT statement and gather all of the Window
1411a8389975Sdrh ** objects found there, assembling them onto the linked list at Select->pWin.
1412a8389975Sdrh */
1413a8389975Sdrh static int gatherSelectWindowsCallback(Walker *pWalker, Expr *pExpr){
14146ba7ab0dSdan   if( pExpr->op==TK_FUNCTION && ExprHasProperty(pExpr, EP_WinFunc) ){
141575b0821eSdan     Select *pSelect = pWalker->u.pSelect;
141675b0821eSdan     Window *pWin = pExpr->y.pWin;
141775b0821eSdan     assert( pWin );
14184f9adee2Sdan     assert( IsWindowFunc(pExpr) );
1419e0ae3f69Sdan     assert( pWin->ppThis==0 );
1420a3fcc000Sdan     sqlite3WindowLink(pSelect, pWin);
1421a8389975Sdrh   }
1422a8389975Sdrh   return WRC_Continue;
1423a8389975Sdrh }
1424a37b6a5eSdrh static int gatherSelectWindowsSelectCallback(Walker *pWalker, Select *p){
1425a37b6a5eSdrh   return p==pWalker->u.pSelect ? WRC_Continue : WRC_Prune;
1426a37b6a5eSdrh }
1427a8389975Sdrh static void gatherSelectWindows(Select *p){
1428a8389975Sdrh   Walker w;
1429a8389975Sdrh   w.xExprCallback = gatherSelectWindowsCallback;
1430a37b6a5eSdrh   w.xSelectCallback = gatherSelectWindowsSelectCallback;
1431a37b6a5eSdrh   w.xSelectCallback2 = 0;
14329c46c66cSdrh   w.pParse = 0;
1433a8389975Sdrh   w.u.pSelect = p;
1434a37b6a5eSdrh   sqlite3WalkSelect(&w, p);
1435a8389975Sdrh }
1436a8389975Sdrh #endif
1437a8389975Sdrh 
1438a8389975Sdrh 
1439a76b5dfcSdrh /*
1440ff78bd2fSdrh ** The following group of routines make deep copies of expressions,
1441ff78bd2fSdrh ** expression lists, ID lists, and select statements.  The copies can
1442ff78bd2fSdrh ** be deleted (by being passed to their respective ...Delete() routines)
1443ff78bd2fSdrh ** without effecting the originals.
1444ff78bd2fSdrh **
14454adee20fSdanielk1977 ** The expression list, ID, and source lists return by sqlite3ExprListDup(),
14464adee20fSdanielk1977 ** sqlite3IdListDup(), and sqlite3SrcListDup() can not be further expanded
1447ad3cab52Sdrh ** by subsequent calls to sqlite*ListAppend() routines.
1448ff78bd2fSdrh **
1449ad3cab52Sdrh ** Any tables that the SrcList might point to are not duplicated.
14506ab3a2ecSdanielk1977 **
1451b7916a78Sdrh ** The flags parameter contains a combination of the EXPRDUP_XXX flags.
14526ab3a2ecSdanielk1977 ** If the EXPRDUP_REDUCE flag is set, then the structure returned is a
14536ab3a2ecSdanielk1977 ** truncated version of the usual Expr structure that will be stored as
14546ab3a2ecSdanielk1977 ** part of the in-memory representation of the database schema.
1455ff78bd2fSdrh */
14566ab3a2ecSdanielk1977 Expr *sqlite3ExprDup(sqlite3 *db, Expr *p, int flags){
145772ea29d7Sdrh   assert( flags==0 || flags==EXPRDUP_REDUCE );
14583c19469cSdrh   return p ? exprDup(db, p, flags, 0) : 0;
1459ff78bd2fSdrh }
14606ab3a2ecSdanielk1977 ExprList *sqlite3ExprListDup(sqlite3 *db, ExprList *p, int flags){
1461ff78bd2fSdrh   ExprList *pNew;
1462145716b3Sdrh   struct ExprList_item *pItem, *pOldItem;
1463ff78bd2fSdrh   int i;
1464b163748eSdrh   Expr *pPriorSelectCol = 0;
1465575fad65Sdrh   assert( db!=0 );
1466ff78bd2fSdrh   if( p==0 ) return 0;
146797258194Sdrh   pNew = sqlite3DbMallocRawNN(db, sqlite3DbMallocSize(db, p));
1468ff78bd2fSdrh   if( pNew==0 ) return 0;
1469a19543feSdrh   pNew->nExpr = p->nExpr;
147043606175Sdrh   pItem = pNew->a;
1471145716b3Sdrh   pOldItem = p->a;
1472145716b3Sdrh   for(i=0; i<p->nExpr; i++, pItem++, pOldItem++){
14736ab3a2ecSdanielk1977     Expr *pOldExpr = pOldItem->pExpr;
147447073f62Sdrh     Expr *pNewExpr;
1475b5526ea6Sdrh     pItem->pExpr = sqlite3ExprDup(db, pOldExpr, flags);
147647073f62Sdrh     if( pOldExpr
147747073f62Sdrh      && pOldExpr->op==TK_SELECT_COLUMN
147847073f62Sdrh      && (pNewExpr = pItem->pExpr)!=0
147947073f62Sdrh     ){
148047073f62Sdrh       assert( pNewExpr->iColumn==0 || i>0 );
148147073f62Sdrh       if( pNewExpr->iColumn==0 ){
148247073f62Sdrh         assert( pOldExpr->pLeft==pOldExpr->pRight );
1483b163748eSdrh         pPriorSelectCol = pNewExpr->pLeft = pNewExpr->pRight;
1484b163748eSdrh       }else{
1485b163748eSdrh         assert( i>0 );
1486b163748eSdrh         assert( pItem[-1].pExpr!=0 );
1487b163748eSdrh         assert( pNewExpr->iColumn==pItem[-1].pExpr->iColumn+1 );
1488b163748eSdrh         assert( pPriorSelectCol==pItem[-1].pExpr->pLeft );
1489b163748eSdrh         pNewExpr->pLeft = pPriorSelectCol;
149047073f62Sdrh       }
149147073f62Sdrh     }
149241cee668Sdrh     pItem->zEName = sqlite3DbStrDup(db, pOldItem->zEName);
14936e11892dSdan     pItem->sortFlags = pOldItem->sortFlags;
1494cbb9da33Sdrh     pItem->eEName = pOldItem->eEName;
14953e7bc9caSdrh     pItem->done = 0;
1496ae8e45cbSdan     pItem->bNulls = pOldItem->bNulls;
149724e25d32Sdan     pItem->bSorterRef = pOldItem->bSorterRef;
1498c2acc4e4Sdrh     pItem->u = pOldItem->u;
1499ff78bd2fSdrh   }
1500ff78bd2fSdrh   return pNew;
1501ff78bd2fSdrh }
150293758c8dSdanielk1977 
150393758c8dSdanielk1977 /*
150493758c8dSdanielk1977 ** If cursors, triggers, views and subqueries are all omitted from
150593758c8dSdanielk1977 ** the build, then none of the following routines, except for
150693758c8dSdanielk1977 ** sqlite3SelectDup(), can be called. sqlite3SelectDup() is sometimes
150793758c8dSdanielk1977 ** called with a NULL argument.
150893758c8dSdanielk1977 */
15096a67fe8eSdanielk1977 #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_TRIGGER) \
15106a67fe8eSdanielk1977  || !defined(SQLITE_OMIT_SUBQUERY)
15116ab3a2ecSdanielk1977 SrcList *sqlite3SrcListDup(sqlite3 *db, SrcList *p, int flags){
1512ad3cab52Sdrh   SrcList *pNew;
1513ad3cab52Sdrh   int i;
1514113088ecSdrh   int nByte;
1515575fad65Sdrh   assert( db!=0 );
1516ad3cab52Sdrh   if( p==0 ) return 0;
1517113088ecSdrh   nByte = sizeof(*p) + (p->nSrc>0 ? sizeof(p->a[0]) * (p->nSrc-1) : 0);
1518575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, nByte );
1519ad3cab52Sdrh   if( pNew==0 ) return 0;
15204305d103Sdrh   pNew->nSrc = pNew->nAlloc = p->nSrc;
1521ad3cab52Sdrh   for(i=0; i<p->nSrc; i++){
15224efc4754Sdrh     struct SrcList_item *pNewItem = &pNew->a[i];
15234efc4754Sdrh     struct SrcList_item *pOldItem = &p->a[i];
1524ed8a3bb1Sdrh     Table *pTab;
152541fb5cd1Sdan     pNewItem->pSchema = pOldItem->pSchema;
152617435752Sdrh     pNewItem->zDatabase = sqlite3DbStrDup(db, pOldItem->zDatabase);
152717435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
152817435752Sdrh     pNewItem->zAlias = sqlite3DbStrDup(db, pOldItem->zAlias);
15298a48b9c0Sdrh     pNewItem->fg = pOldItem->fg;
15304efc4754Sdrh     pNewItem->iCursor = pOldItem->iCursor;
15315b6a9ed4Sdrh     pNewItem->addrFillSub = pOldItem->addrFillSub;
15325b6a9ed4Sdrh     pNewItem->regReturn = pOldItem->regReturn;
15338a48b9c0Sdrh     if( pNewItem->fg.isIndexedBy ){
15348a48b9c0Sdrh       pNewItem->u1.zIndexedBy = sqlite3DbStrDup(db, pOldItem->u1.zIndexedBy);
15358a48b9c0Sdrh     }
15368a48b9c0Sdrh     pNewItem->pIBIndex = pOldItem->pIBIndex;
15378a48b9c0Sdrh     if( pNewItem->fg.isTabFunc ){
15388a48b9c0Sdrh       pNewItem->u1.pFuncArg =
15398a48b9c0Sdrh           sqlite3ExprListDup(db, pOldItem->u1.pFuncArg, flags);
15408a48b9c0Sdrh     }
1541ed8a3bb1Sdrh     pTab = pNewItem->pTab = pOldItem->pTab;
1542ed8a3bb1Sdrh     if( pTab ){
154379df7782Sdrh       pTab->nTabRef++;
1544a1cb183dSdanielk1977     }
15456ab3a2ecSdanielk1977     pNewItem->pSelect = sqlite3SelectDup(db, pOldItem->pSelect, flags);
15466ab3a2ecSdanielk1977     pNewItem->pOn = sqlite3ExprDup(db, pOldItem->pOn, flags);
154717435752Sdrh     pNewItem->pUsing = sqlite3IdListDup(db, pOldItem->pUsing);
15486c18b6e0Sdanielk1977     pNewItem->colUsed = pOldItem->colUsed;
1549ad3cab52Sdrh   }
1550ad3cab52Sdrh   return pNew;
1551ad3cab52Sdrh }
155217435752Sdrh IdList *sqlite3IdListDup(sqlite3 *db, IdList *p){
1553ff78bd2fSdrh   IdList *pNew;
1554ff78bd2fSdrh   int i;
1555575fad65Sdrh   assert( db!=0 );
1556ff78bd2fSdrh   if( p==0 ) return 0;
1557575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, sizeof(*pNew) );
1558ff78bd2fSdrh   if( pNew==0 ) return 0;
15596c535158Sdrh   pNew->nId = p->nId;
1560575fad65Sdrh   pNew->a = sqlite3DbMallocRawNN(db, p->nId*sizeof(p->a[0]) );
1561d5d56523Sdanielk1977   if( pNew->a==0 ){
1562dbd6a7dcSdrh     sqlite3DbFreeNN(db, pNew);
1563d5d56523Sdanielk1977     return 0;
1564d5d56523Sdanielk1977   }
15656c535158Sdrh   /* Note that because the size of the allocation for p->a[] is not
15666c535158Sdrh   ** necessarily a power of two, sqlite3IdListAppend() may not be called
15676c535158Sdrh   ** on the duplicate created by this function. */
1568ff78bd2fSdrh   for(i=0; i<p->nId; i++){
15694efc4754Sdrh     struct IdList_item *pNewItem = &pNew->a[i];
15704efc4754Sdrh     struct IdList_item *pOldItem = &p->a[i];
157117435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
15724efc4754Sdrh     pNewItem->idx = pOldItem->idx;
1573ff78bd2fSdrh   }
1574ff78bd2fSdrh   return pNew;
1575ff78bd2fSdrh }
1576a7466205Sdan Select *sqlite3SelectDup(sqlite3 *db, Select *pDup, int flags){
1577a7466205Sdan   Select *pRet = 0;
1578a7466205Sdan   Select *pNext = 0;
1579a7466205Sdan   Select **pp = &pRet;
1580a7466205Sdan   Select *p;
1581a7466205Sdan 
1582575fad65Sdrh   assert( db!=0 );
1583a7466205Sdan   for(p=pDup; p; p=p->pPrior){
1584a7466205Sdan     Select *pNew = sqlite3DbMallocRawNN(db, sizeof(*p) );
1585a7466205Sdan     if( pNew==0 ) break;
1586b7916a78Sdrh     pNew->pEList = sqlite3ExprListDup(db, p->pEList, flags);
15876ab3a2ecSdanielk1977     pNew->pSrc = sqlite3SrcListDup(db, p->pSrc, flags);
15886ab3a2ecSdanielk1977     pNew->pWhere = sqlite3ExprDup(db, p->pWhere, flags);
15896ab3a2ecSdanielk1977     pNew->pGroupBy = sqlite3ExprListDup(db, p->pGroupBy, flags);
15906ab3a2ecSdanielk1977     pNew->pHaving = sqlite3ExprDup(db, p->pHaving, flags);
15916ab3a2ecSdanielk1977     pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, flags);
1592ff78bd2fSdrh     pNew->op = p->op;
1593a7466205Sdan     pNew->pNext = pNext;
1594a7466205Sdan     pNew->pPrior = 0;
15956ab3a2ecSdanielk1977     pNew->pLimit = sqlite3ExprDup(db, p->pLimit, flags);
159692b01d53Sdrh     pNew->iLimit = 0;
159792b01d53Sdrh     pNew->iOffset = 0;
15987d10d5a6Sdrh     pNew->selFlags = p->selFlags & ~SF_UsesEphemeral;
1599b9bb7c18Sdrh     pNew->addrOpenEphm[0] = -1;
1600b9bb7c18Sdrh     pNew->addrOpenEphm[1] = -1;
1601ec2da854Sdrh     pNew->nSelectRow = p->nSelectRow;
16024e9119d9Sdan     pNew->pWith = withDup(db, p->pWith);
160367a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
16042e362f97Sdan     pNew->pWin = 0;
1605c95f38d4Sdan     pNew->pWinDefn = sqlite3WindowListDup(db, p->pWinDefn);
16064780b9adSdan     if( p->pWin && db->mallocFailed==0 ) gatherSelectWindows(pNew);
160767a9b8edSdan #endif
1608fef37760Sdrh     pNew->selId = p->selId;
1609a7466205Sdan     *pp = pNew;
1610a7466205Sdan     pp = &pNew->pPrior;
1611a7466205Sdan     pNext = pNew;
1612a7466205Sdan   }
1613a7466205Sdan 
1614a7466205Sdan   return pRet;
1615ff78bd2fSdrh }
161693758c8dSdanielk1977 #else
16176ab3a2ecSdanielk1977 Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
161893758c8dSdanielk1977   assert( p==0 );
161993758c8dSdanielk1977   return 0;
162093758c8dSdanielk1977 }
162193758c8dSdanielk1977 #endif
1622ff78bd2fSdrh 
1623ff78bd2fSdrh 
1624ff78bd2fSdrh /*
1625a76b5dfcSdrh ** Add a new element to the end of an expression list.  If pList is
1626a76b5dfcSdrh ** initially NULL, then create a new expression list.
1627b7916a78Sdrh **
1628a19543feSdrh ** The pList argument must be either NULL or a pointer to an ExprList
1629a19543feSdrh ** obtained from a prior call to sqlite3ExprListAppend().  This routine
1630a19543feSdrh ** may not be used with an ExprList obtained from sqlite3ExprListDup().
1631a19543feSdrh ** Reason:  This routine assumes that the number of slots in pList->a[]
1632a19543feSdrh ** is a power of two.  That is true for sqlite3ExprListAppend() returns
1633a19543feSdrh ** but is not necessarily true from the return value of sqlite3ExprListDup().
1634a19543feSdrh **
1635b7916a78Sdrh ** If a memory allocation error occurs, the entire list is freed and
1636b7916a78Sdrh ** NULL is returned.  If non-NULL is returned, then it is guaranteed
1637b7916a78Sdrh ** that the new entry was successfully appended.
1638a76b5dfcSdrh */
163917435752Sdrh ExprList *sqlite3ExprListAppend(
164017435752Sdrh   Parse *pParse,          /* Parsing context */
164117435752Sdrh   ExprList *pList,        /* List to which to append. Might be NULL */
1642b7916a78Sdrh   Expr *pExpr             /* Expression to be appended. Might be NULL */
164317435752Sdrh ){
164443606175Sdrh   struct ExprList_item *pItem;
164517435752Sdrh   sqlite3 *db = pParse->db;
1646575fad65Sdrh   assert( db!=0 );
1647a76b5dfcSdrh   if( pList==0 ){
1648575fad65Sdrh     pList = sqlite3DbMallocRawNN(db, sizeof(ExprList) );
1649a76b5dfcSdrh     if( pList==0 ){
1650d5d56523Sdanielk1977       goto no_mem;
1651a76b5dfcSdrh     }
1652c263f7c4Sdrh     pList->nExpr = 0;
1653a19543feSdrh   }else if( (pList->nExpr & (pList->nExpr-1))==0 ){
165443606175Sdrh     ExprList *pNew;
165543606175Sdrh     pNew = sqlite3DbRealloc(db, pList,
16560aa3231fSdrh          sizeof(*pList)+(2*(sqlite3_int64)pList->nExpr-1)*sizeof(pList->a[0]));
165743606175Sdrh     if( pNew==0 ){
1658d5d56523Sdanielk1977       goto no_mem;
1659a76b5dfcSdrh     }
166043606175Sdrh     pList = pNew;
1661a76b5dfcSdrh   }
166243606175Sdrh   pItem = &pList->a[pList->nExpr++];
166341cee668Sdrh   assert( offsetof(struct ExprList_item,zEName)==sizeof(pItem->pExpr) );
1664a8b9793cSdrh   assert( offsetof(struct ExprList_item,pExpr)==0 );
166541cee668Sdrh   memset(&pItem->zEName,0,sizeof(*pItem)-offsetof(struct ExprList_item,zEName));
1666e94ddc9eSdanielk1977   pItem->pExpr = pExpr;
1667a76b5dfcSdrh   return pList;
1668d5d56523Sdanielk1977 
1669d5d56523Sdanielk1977 no_mem:
1670d5d56523Sdanielk1977   /* Avoid leaking memory if malloc has failed. */
1671633e6d57Sdrh   sqlite3ExprDelete(db, pExpr);
1672633e6d57Sdrh   sqlite3ExprListDelete(db, pList);
1673d5d56523Sdanielk1977   return 0;
1674a76b5dfcSdrh }
1675a76b5dfcSdrh 
1676a76b5dfcSdrh /*
16778762ec19Sdrh ** pColumns and pExpr form a vector assignment which is part of the SET
16788762ec19Sdrh ** clause of an UPDATE statement.  Like this:
1679a1251bc4Sdrh **
1680a1251bc4Sdrh **        (a,b,c) = (expr1,expr2,expr3)
1681a1251bc4Sdrh ** Or:    (a,b,c) = (SELECT x,y,z FROM ....)
1682a1251bc4Sdrh **
1683a1251bc4Sdrh ** For each term of the vector assignment, append new entries to the
1684b67343d0Sdrh ** expression list pList.  In the case of a subquery on the RHS, append
1685a1251bc4Sdrh ** TK_SELECT_COLUMN expressions.
1686a1251bc4Sdrh */
1687a1251bc4Sdrh ExprList *sqlite3ExprListAppendVector(
1688a1251bc4Sdrh   Parse *pParse,         /* Parsing context */
1689a1251bc4Sdrh   ExprList *pList,       /* List to which to append. Might be NULL */
1690a1251bc4Sdrh   IdList *pColumns,      /* List of names of LHS of the assignment */
1691a1251bc4Sdrh   Expr *pExpr            /* Vector expression to be appended. Might be NULL */
1692a1251bc4Sdrh ){
1693a1251bc4Sdrh   sqlite3 *db = pParse->db;
1694a1251bc4Sdrh   int n;
1695a1251bc4Sdrh   int i;
169666860af3Sdrh   int iFirst = pList ? pList->nExpr : 0;
1697321e828dSdrh   /* pColumns can only be NULL due to an OOM but an OOM will cause an
1698321e828dSdrh   ** exit prior to this routine being invoked */
1699321e828dSdrh   if( NEVER(pColumns==0) ) goto vector_append_error;
1700a1251bc4Sdrh   if( pExpr==0 ) goto vector_append_error;
1701966e2911Sdrh 
1702966e2911Sdrh   /* If the RHS is a vector, then we can immediately check to see that
1703966e2911Sdrh   ** the size of the RHS and LHS match.  But if the RHS is a SELECT,
1704966e2911Sdrh   ** wildcards ("*") in the result set of the SELECT must be expanded before
1705966e2911Sdrh   ** we can do the size check, so defer the size check until code generation.
1706966e2911Sdrh   */
1707966e2911Sdrh   if( pExpr->op!=TK_SELECT && pColumns->nId!=(n=sqlite3ExprVectorSize(pExpr)) ){
1708a1251bc4Sdrh     sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
1709a1251bc4Sdrh                     pColumns->nId, n);
1710a1251bc4Sdrh     goto vector_append_error;
1711a1251bc4Sdrh   }
1712966e2911Sdrh 
1713966e2911Sdrh   for(i=0; i<pColumns->nId; i++){
1714a1251bc4Sdrh     Expr *pSubExpr = sqlite3ExprForVectorField(pParse, pExpr, i);
1715554a9dc7Sdrh     assert( pSubExpr!=0 || db->mallocFailed );
1716554a9dc7Sdrh     assert( pSubExpr==0 || pSubExpr->iTable==0 );
1717554a9dc7Sdrh     if( pSubExpr==0 ) continue;
1718554a9dc7Sdrh     pSubExpr->iTable = pColumns->nId;
1719a1251bc4Sdrh     pList = sqlite3ExprListAppend(pParse, pList, pSubExpr);
1720a1251bc4Sdrh     if( pList ){
172166860af3Sdrh       assert( pList->nExpr==iFirst+i+1 );
172241cee668Sdrh       pList->a[pList->nExpr-1].zEName = pColumns->a[i].zName;
1723a1251bc4Sdrh       pColumns->a[i].zName = 0;
1724a1251bc4Sdrh     }
1725a1251bc4Sdrh   }
1726966e2911Sdrh 
1727ffe28059Sdrh   if( !db->mallocFailed && pExpr->op==TK_SELECT && ALWAYS(pList!=0) ){
1728966e2911Sdrh     Expr *pFirst = pList->a[iFirst].pExpr;
1729f4dd26c5Sdrh     assert( pFirst!=0 );
1730966e2911Sdrh     assert( pFirst->op==TK_SELECT_COLUMN );
1731966e2911Sdrh 
1732966e2911Sdrh     /* Store the SELECT statement in pRight so it will be deleted when
1733966e2911Sdrh     ** sqlite3ExprListDelete() is called */
1734966e2911Sdrh     pFirst->pRight = pExpr;
1735a1251bc4Sdrh     pExpr = 0;
1736966e2911Sdrh 
1737966e2911Sdrh     /* Remember the size of the LHS in iTable so that we can check that
1738966e2911Sdrh     ** the RHS and LHS sizes match during code generation. */
1739966e2911Sdrh     pFirst->iTable = pColumns->nId;
1740a1251bc4Sdrh   }
1741a1251bc4Sdrh 
1742a1251bc4Sdrh vector_append_error:
17438e34e406Sdrh   sqlite3ExprUnmapAndDelete(pParse, pExpr);
1744a1251bc4Sdrh   sqlite3IdListDelete(db, pColumns);
1745a1251bc4Sdrh   return pList;
1746a1251bc4Sdrh }
1747a1251bc4Sdrh 
1748a1251bc4Sdrh /*
1749bc622bc0Sdrh ** Set the sort order for the last element on the given ExprList.
1750bc622bc0Sdrh */
17516e11892dSdan void sqlite3ExprListSetSortOrder(ExprList *p, int iSortOrder, int eNulls){
17529105fd51Sdan   struct ExprList_item *pItem;
1753bc622bc0Sdrh   if( p==0 ) return;
1754bc622bc0Sdrh   assert( p->nExpr>0 );
17556e11892dSdan 
17566e11892dSdan   assert( SQLITE_SO_UNDEFINED<0 && SQLITE_SO_ASC==0 && SQLITE_SO_DESC>0 );
17576e11892dSdan   assert( iSortOrder==SQLITE_SO_UNDEFINED
17586e11892dSdan        || iSortOrder==SQLITE_SO_ASC
17596e11892dSdan        || iSortOrder==SQLITE_SO_DESC
17606e11892dSdan   );
17616e11892dSdan   assert( eNulls==SQLITE_SO_UNDEFINED
17626e11892dSdan        || eNulls==SQLITE_SO_ASC
17636e11892dSdan        || eNulls==SQLITE_SO_DESC
17646e11892dSdan   );
17656e11892dSdan 
17669105fd51Sdan   pItem = &p->a[p->nExpr-1];
17679105fd51Sdan   assert( pItem->bNulls==0 );
17689105fd51Sdan   if( iSortOrder==SQLITE_SO_UNDEFINED ){
17699105fd51Sdan     iSortOrder = SQLITE_SO_ASC;
1770bc622bc0Sdrh   }
17719105fd51Sdan   pItem->sortFlags = (u8)iSortOrder;
17729105fd51Sdan 
17739105fd51Sdan   if( eNulls!=SQLITE_SO_UNDEFINED ){
17749105fd51Sdan     pItem->bNulls = 1;
17759105fd51Sdan     if( iSortOrder!=eNulls ){
17769105fd51Sdan       pItem->sortFlags |= KEYINFO_ORDER_BIGNULL;
17779105fd51Sdan     }
1778bc622bc0Sdrh   }
1779bc622bc0Sdrh }
1780bc622bc0Sdrh 
1781bc622bc0Sdrh /*
178241cee668Sdrh ** Set the ExprList.a[].zEName element of the most recently added item
1783b7916a78Sdrh ** on the expression list.
1784b7916a78Sdrh **
1785b7916a78Sdrh ** pList might be NULL following an OOM error.  But pName should never be
1786b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1787b7916a78Sdrh ** is set.
1788b7916a78Sdrh */
1789b7916a78Sdrh void sqlite3ExprListSetName(
1790b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1791b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
1792b7916a78Sdrh   Token *pName,           /* Name to be added */
1793b7916a78Sdrh   int dequote             /* True to cause the name to be dequoted */
1794b7916a78Sdrh ){
1795b7916a78Sdrh   assert( pList!=0 || pParse->db->mallocFailed!=0 );
17962d99f957Sdrh   assert( pParse->eParseMode!=PARSE_MODE_UNMAP || dequote==0 );
1797b7916a78Sdrh   if( pList ){
1798b7916a78Sdrh     struct ExprList_item *pItem;
1799b7916a78Sdrh     assert( pList->nExpr>0 );
1800b7916a78Sdrh     pItem = &pList->a[pList->nExpr-1];
180141cee668Sdrh     assert( pItem->zEName==0 );
1802c4938ea2Sdrh     assert( pItem->eEName==ENAME_NAME );
180341cee668Sdrh     pItem->zEName = sqlite3DbStrNDup(pParse->db, pName->z, pName->n);
180485f2c76cSdan     if( dequote ){
180585f2c76cSdan       /* If dequote==0, then pName->z does not point to part of a DDL
180685f2c76cSdan       ** statement handled by the parser. And so no token need be added
180785f2c76cSdan       ** to the token-map.  */
180885f2c76cSdan       sqlite3Dequote(pItem->zEName);
1809c9461eccSdan       if( IN_RENAME_OBJECT ){
181041cee668Sdrh         sqlite3RenameTokenMap(pParse, (void*)pItem->zEName, pName);
18115be60c55Sdan       }
1812b7916a78Sdrh     }
1813b7916a78Sdrh   }
181485f2c76cSdan }
1815b7916a78Sdrh 
1816b7916a78Sdrh /*
1817b7916a78Sdrh ** Set the ExprList.a[].zSpan element of the most recently added item
1818b7916a78Sdrh ** on the expression list.
1819b7916a78Sdrh **
1820b7916a78Sdrh ** pList might be NULL following an OOM error.  But pSpan should never be
1821b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1822b7916a78Sdrh ** is set.
1823b7916a78Sdrh */
1824b7916a78Sdrh void sqlite3ExprListSetSpan(
1825b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1826b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
18271be266baSdrh   const char *zStart,     /* Start of the span */
18281be266baSdrh   const char *zEnd        /* End of the span */
1829b7916a78Sdrh ){
1830b7916a78Sdrh   sqlite3 *db = pParse->db;
1831b7916a78Sdrh   assert( pList!=0 || db->mallocFailed!=0 );
1832b7916a78Sdrh   if( pList ){
1833b7916a78Sdrh     struct ExprList_item *pItem = &pList->a[pList->nExpr-1];
1834b7916a78Sdrh     assert( pList->nExpr>0 );
1835cbb9da33Sdrh     if( pItem->zEName==0 ){
1836cbb9da33Sdrh       pItem->zEName = sqlite3DbSpanDup(db, zStart, zEnd);
1837cbb9da33Sdrh       pItem->eEName = ENAME_SPAN;
1838cbb9da33Sdrh     }
1839b7916a78Sdrh   }
1840b7916a78Sdrh }
1841b7916a78Sdrh 
1842b7916a78Sdrh /*
18437a15a4beSdanielk1977 ** If the expression list pEList contains more than iLimit elements,
18447a15a4beSdanielk1977 ** leave an error message in pParse.
18457a15a4beSdanielk1977 */
18467a15a4beSdanielk1977 void sqlite3ExprListCheckLength(
18477a15a4beSdanielk1977   Parse *pParse,
18487a15a4beSdanielk1977   ExprList *pEList,
18497a15a4beSdanielk1977   const char *zObject
18507a15a4beSdanielk1977 ){
1851b1a6c3c1Sdrh   int mx = pParse->db->aLimit[SQLITE_LIMIT_COLUMN];
1852c5499befSdrh   testcase( pEList && pEList->nExpr==mx );
1853c5499befSdrh   testcase( pEList && pEList->nExpr==mx+1 );
1854b1a6c3c1Sdrh   if( pEList && pEList->nExpr>mx ){
18557a15a4beSdanielk1977     sqlite3ErrorMsg(pParse, "too many columns in %s", zObject);
18567a15a4beSdanielk1977   }
18577a15a4beSdanielk1977 }
18587a15a4beSdanielk1977 
18597a15a4beSdanielk1977 /*
1860a76b5dfcSdrh ** Delete an entire expression list.
1861a76b5dfcSdrh */
1862affa855cSdrh static SQLITE_NOINLINE void exprListDeleteNN(sqlite3 *db, ExprList *pList){
1863ac48b751Sdrh   int i = pList->nExpr;
1864ac48b751Sdrh   struct ExprList_item *pItem =  pList->a;
1865ac48b751Sdrh   assert( pList->nExpr>0 );
1866ac48b751Sdrh   do{
1867633e6d57Sdrh     sqlite3ExprDelete(db, pItem->pExpr);
186841cee668Sdrh     sqlite3DbFree(db, pItem->zEName);
1869ac48b751Sdrh     pItem++;
1870ac48b751Sdrh   }while( --i>0 );
1871dbd6a7dcSdrh   sqlite3DbFreeNN(db, pList);
1872a76b5dfcSdrh }
1873affa855cSdrh void sqlite3ExprListDelete(sqlite3 *db, ExprList *pList){
1874affa855cSdrh   if( pList ) exprListDeleteNN(db, pList);
1875affa855cSdrh }
1876a76b5dfcSdrh 
1877a76b5dfcSdrh /*
18782308ed38Sdrh ** Return the bitwise-OR of all Expr.flags fields in the given
18792308ed38Sdrh ** ExprList.
1880885a5b03Sdrh */
18812308ed38Sdrh u32 sqlite3ExprListFlags(const ExprList *pList){
1882885a5b03Sdrh   int i;
18832308ed38Sdrh   u32 m = 0;
1884508e2d00Sdrh   assert( pList!=0 );
1885885a5b03Sdrh   for(i=0; i<pList->nExpr; i++){
1886d0c73053Sdrh      Expr *pExpr = pList->a[i].pExpr;
1887de845c2fSdrh      assert( pExpr!=0 );
1888de845c2fSdrh      m |= pExpr->flags;
1889885a5b03Sdrh   }
18902308ed38Sdrh   return m;
1891885a5b03Sdrh }
1892885a5b03Sdrh 
1893885a5b03Sdrh /*
18947e6f980bSdrh ** This is a SELECT-node callback for the expression walker that
18957e6f980bSdrh ** always "fails".  By "fail" in this case, we mean set
18967e6f980bSdrh ** pWalker->eCode to zero and abort.
18977e6f980bSdrh **
18987e6f980bSdrh ** This callback is used by multiple expression walkers.
18997e6f980bSdrh */
19007e6f980bSdrh int sqlite3SelectWalkFail(Walker *pWalker, Select *NotUsed){
19017e6f980bSdrh   UNUSED_PARAMETER(NotUsed);
19027e6f980bSdrh   pWalker->eCode = 0;
19037e6f980bSdrh   return WRC_Abort;
19047e6f980bSdrh }
19057e6f980bSdrh 
19067e6f980bSdrh /*
19070cbec59cSdrh ** Check the input string to see if it is "true" or "false" (in any case).
19080cbec59cSdrh **
19090cbec59cSdrh **       If the string is....           Return
19100cbec59cSdrh **         "true"                         EP_IsTrue
19110cbec59cSdrh **         "false"                        EP_IsFalse
19120cbec59cSdrh **         anything else                  0
19130cbec59cSdrh */
19140cbec59cSdrh u32 sqlite3IsTrueOrFalse(const char *zIn){
19150cbec59cSdrh   if( sqlite3StrICmp(zIn, "true")==0  ) return EP_IsTrue;
19160cbec59cSdrh   if( sqlite3StrICmp(zIn, "false")==0 ) return EP_IsFalse;
19170cbec59cSdrh   return 0;
19180cbec59cSdrh }
19190cbec59cSdrh 
19200cbec59cSdrh 
19210cbec59cSdrh /*
1922171d16bbSdrh ** If the input expression is an ID with the name "true" or "false"
192396acafbeSdrh ** then convert it into an TK_TRUEFALSE term.  Return non-zero if
192496acafbeSdrh ** the conversion happened, and zero if the expression is unaltered.
1925171d16bbSdrh */
1926171d16bbSdrh int sqlite3ExprIdToTrueFalse(Expr *pExpr){
19270cbec59cSdrh   u32 v;
1928171d16bbSdrh   assert( pExpr->op==TK_ID || pExpr->op==TK_STRING );
192951d35b0fSdrh   if( !ExprHasProperty(pExpr, EP_Quoted)
19300cbec59cSdrh    && (v = sqlite3IsTrueOrFalse(pExpr->u.zToken))!=0
1931171d16bbSdrh   ){
1932171d16bbSdrh     pExpr->op = TK_TRUEFALSE;
19330cbec59cSdrh     ExprSetProperty(pExpr, v);
1934171d16bbSdrh     return 1;
1935171d16bbSdrh   }
1936171d16bbSdrh   return 0;
1937171d16bbSdrh }
1938171d16bbSdrh 
193943c4ac8bSdrh /*
194096acafbeSdrh ** The argument must be a TK_TRUEFALSE Expr node.  Return 1 if it is TRUE
194143c4ac8bSdrh ** and 0 if it is FALSE.
194243c4ac8bSdrh */
194396acafbeSdrh int sqlite3ExprTruthValue(const Expr *pExpr){
19446ece353fSdan   pExpr = sqlite3ExprSkipCollate((Expr*)pExpr);
194543c4ac8bSdrh   assert( pExpr->op==TK_TRUEFALSE );
194643c4ac8bSdrh   assert( sqlite3StrICmp(pExpr->u.zToken,"true")==0
194743c4ac8bSdrh        || sqlite3StrICmp(pExpr->u.zToken,"false")==0 );
194843c4ac8bSdrh   return pExpr->u.zToken[4]==0;
194943c4ac8bSdrh }
195043c4ac8bSdrh 
195117180fcaSdrh /*
195217180fcaSdrh ** If pExpr is an AND or OR expression, try to simplify it by eliminating
195317180fcaSdrh ** terms that are always true or false.  Return the simplified expression.
195417180fcaSdrh ** Or return the original expression if no simplification is possible.
195517180fcaSdrh **
195617180fcaSdrh ** Examples:
195717180fcaSdrh **
195817180fcaSdrh **     (x<10) AND true                =>   (x<10)
195917180fcaSdrh **     (x<10) AND false               =>   false
196017180fcaSdrh **     (x<10) AND (y=22 OR false)     =>   (x<10) AND (y=22)
196117180fcaSdrh **     (x<10) AND (y=22 OR true)      =>   (x<10)
196217180fcaSdrh **     (y=22) OR true                 =>   true
196317180fcaSdrh */
196417180fcaSdrh Expr *sqlite3ExprSimplifiedAndOr(Expr *pExpr){
196517180fcaSdrh   assert( pExpr!=0 );
196617180fcaSdrh   if( pExpr->op==TK_AND || pExpr->op==TK_OR ){
196717180fcaSdrh     Expr *pRight = sqlite3ExprSimplifiedAndOr(pExpr->pRight);
196817180fcaSdrh     Expr *pLeft = sqlite3ExprSimplifiedAndOr(pExpr->pLeft);
196917180fcaSdrh     if( ExprAlwaysTrue(pLeft) || ExprAlwaysFalse(pRight) ){
197017180fcaSdrh       pExpr = pExpr->op==TK_AND ? pRight : pLeft;
197117180fcaSdrh     }else if( ExprAlwaysTrue(pRight) || ExprAlwaysFalse(pLeft) ){
197217180fcaSdrh       pExpr = pExpr->op==TK_AND ? pLeft : pRight;
197317180fcaSdrh     }
197417180fcaSdrh   }
197517180fcaSdrh   return pExpr;
197617180fcaSdrh }
197717180fcaSdrh 
1978171d16bbSdrh 
1979171d16bbSdrh /*
1980059b2d50Sdrh ** These routines are Walker callbacks used to check expressions to
1981059b2d50Sdrh ** see if they are "constant" for some definition of constant.  The
1982059b2d50Sdrh ** Walker.eCode value determines the type of "constant" we are looking
1983059b2d50Sdrh ** for.
198473b211abSdrh **
19857d10d5a6Sdrh ** These callback routines are used to implement the following:
1986626a879aSdrh **
1987059b2d50Sdrh **     sqlite3ExprIsConstant()                  pWalker->eCode==1
1988059b2d50Sdrh **     sqlite3ExprIsConstantNotJoin()           pWalker->eCode==2
1989fcb9f4f3Sdrh **     sqlite3ExprIsTableConstant()             pWalker->eCode==3
1990059b2d50Sdrh **     sqlite3ExprIsConstantOrFunction()        pWalker->eCode==4 or 5
199187abf5c0Sdrh **
1992059b2d50Sdrh ** In all cases, the callbacks set Walker.eCode=0 and abort if the expression
1993059b2d50Sdrh ** is found to not be a constant.
199487abf5c0Sdrh **
1995014fff20Sdrh ** The sqlite3ExprIsConstantOrFunction() is used for evaluating DEFAULT
1996014fff20Sdrh ** expressions in a CREATE TABLE statement.  The Walker.eCode value is 5
19971e32bed3Sdrh ** when parsing an existing schema out of the sqlite_schema table and 4
1998014fff20Sdrh ** when processing a new CREATE TABLE statement.  A bound parameter raises
1999014fff20Sdrh ** an error for new statements, but is silently converted
20001e32bed3Sdrh ** to NULL for existing schemas.  This allows sqlite_schema tables that
2001feada2dfSdrh ** contain a bound parameter because they were generated by older versions
2002feada2dfSdrh ** of SQLite to be parsed by newer versions of SQLite without raising a
2003feada2dfSdrh ** malformed schema error.
2004626a879aSdrh */
20057d10d5a6Sdrh static int exprNodeIsConstant(Walker *pWalker, Expr *pExpr){
2006626a879aSdrh 
2007059b2d50Sdrh   /* If pWalker->eCode is 2 then any term of the expression that comes from
2008059b2d50Sdrh   ** the ON or USING clauses of a left join disqualifies the expression
20090a168377Sdrh   ** from being considered constant. */
2010059b2d50Sdrh   if( pWalker->eCode==2 && ExprHasProperty(pExpr, EP_FromJoin) ){
2011059b2d50Sdrh     pWalker->eCode = 0;
20127d10d5a6Sdrh     return WRC_Abort;
20130a168377Sdrh   }
20140a168377Sdrh 
2015626a879aSdrh   switch( pExpr->op ){
2016eb55bd2fSdrh     /* Consider functions to be constant if all their arguments are constant
2017059b2d50Sdrh     ** and either pWalker->eCode==4 or 5 or the function has the
2018059b2d50Sdrh     ** SQLITE_FUNC_CONST flag. */
2019eb55bd2fSdrh     case TK_FUNCTION:
2020a634c9e6Sdrh       if( (pWalker->eCode>=4 || ExprHasProperty(pExpr,EP_ConstFunc))
2021a634c9e6Sdrh        && !ExprHasProperty(pExpr, EP_WinFunc)
2022a634c9e6Sdrh       ){
2023014fff20Sdrh         if( pWalker->eCode==5 ) ExprSetProperty(pExpr, EP_FromDDL);
2024b1fba286Sdrh         return WRC_Continue;
2025059b2d50Sdrh       }else{
2026059b2d50Sdrh         pWalker->eCode = 0;
2027059b2d50Sdrh         return WRC_Abort;
2028b1fba286Sdrh       }
2029626a879aSdrh     case TK_ID:
2030171d16bbSdrh       /* Convert "true" or "false" in a DEFAULT clause into the
2031171d16bbSdrh       ** appropriate TK_TRUEFALSE operator */
2032e39ef31cSdrh       if( sqlite3ExprIdToTrueFalse(pExpr) ){
2033171d16bbSdrh         return WRC_Prune;
2034171d16bbSdrh       }
203508b92086Sdrh       /* no break */ deliberate_fall_through
2036626a879aSdrh     case TK_COLUMN:
2037626a879aSdrh     case TK_AGG_FUNCTION:
203813449892Sdrh     case TK_AGG_COLUMN:
2039c5499befSdrh       testcase( pExpr->op==TK_ID );
2040c5499befSdrh       testcase( pExpr->op==TK_COLUMN );
2041c5499befSdrh       testcase( pExpr->op==TK_AGG_FUNCTION );
2042c5499befSdrh       testcase( pExpr->op==TK_AGG_COLUMN );
204307aded63Sdrh       if( ExprHasProperty(pExpr, EP_FixedCol) && pWalker->eCode!=2 ){
2044efad2e23Sdrh         return WRC_Continue;
2045efad2e23Sdrh       }
2046059b2d50Sdrh       if( pWalker->eCode==3 && pExpr->iTable==pWalker->u.iCur ){
2047059b2d50Sdrh         return WRC_Continue;
2048f43ce0b4Sdrh       }
204908b92086Sdrh       /* no break */ deliberate_fall_through
2050f43ce0b4Sdrh     case TK_IF_NULL_ROW:
20516e341b93Sdrh     case TK_REGISTER:
205274e0d966Sdrh     case TK_DOT:
20539916048bSdrh       testcase( pExpr->op==TK_REGISTER );
2054f43ce0b4Sdrh       testcase( pExpr->op==TK_IF_NULL_ROW );
205574e0d966Sdrh       testcase( pExpr->op==TK_DOT );
2056059b2d50Sdrh       pWalker->eCode = 0;
20577d10d5a6Sdrh       return WRC_Abort;
2058feada2dfSdrh     case TK_VARIABLE:
2059059b2d50Sdrh       if( pWalker->eCode==5 ){
2060feada2dfSdrh         /* Silently convert bound parameters that appear inside of CREATE
2061feada2dfSdrh         ** statements into a NULL when parsing the CREATE statement text out
20621e32bed3Sdrh         ** of the sqlite_schema table */
2063feada2dfSdrh         pExpr->op = TK_NULL;
2064059b2d50Sdrh       }else if( pWalker->eCode==4 ){
2065feada2dfSdrh         /* A bound parameter in a CREATE statement that originates from
2066feada2dfSdrh         ** sqlite3_prepare() causes an error */
2067059b2d50Sdrh         pWalker->eCode = 0;
2068feada2dfSdrh         return WRC_Abort;
2069feada2dfSdrh       }
207008b92086Sdrh       /* no break */ deliberate_fall_through
2071626a879aSdrh     default:
20726e341b93Sdrh       testcase( pExpr->op==TK_SELECT ); /* sqlite3SelectWalkFail() disallows */
20736e341b93Sdrh       testcase( pExpr->op==TK_EXISTS ); /* sqlite3SelectWalkFail() disallows */
20747d10d5a6Sdrh       return WRC_Continue;
2075626a879aSdrh   }
2076626a879aSdrh }
2077059b2d50Sdrh static int exprIsConst(Expr *p, int initFlag, int iCur){
20787d10d5a6Sdrh   Walker w;
2079059b2d50Sdrh   w.eCode = initFlag;
20807d10d5a6Sdrh   w.xExprCallback = exprNodeIsConstant;
20817e6f980bSdrh   w.xSelectCallback = sqlite3SelectWalkFail;
2082979dd1beSdrh #ifdef SQLITE_DEBUG
2083979dd1beSdrh   w.xSelectCallback2 = sqlite3SelectWalkAssert2;
2084979dd1beSdrh #endif
2085059b2d50Sdrh   w.u.iCur = iCur;
20867d10d5a6Sdrh   sqlite3WalkExpr(&w, p);
2087059b2d50Sdrh   return w.eCode;
20887d10d5a6Sdrh }
2089626a879aSdrh 
2090626a879aSdrh /*
2091059b2d50Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
2092eb55bd2fSdrh ** and 0 if it involves variables or function calls.
20932398937bSdrh **
20942398937bSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
20952398937bSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
20962398937bSdrh ** a constant.
2097fef5208cSdrh */
20984adee20fSdanielk1977 int sqlite3ExprIsConstant(Expr *p){
2099059b2d50Sdrh   return exprIsConst(p, 1, 0);
2100fef5208cSdrh }
2101fef5208cSdrh 
2102fef5208cSdrh /*
210307aded63Sdrh ** Walk an expression tree.  Return non-zero if
210407aded63Sdrh **
210507aded63Sdrh **   (1) the expression is constant, and
210607aded63Sdrh **   (2) the expression does originate in the ON or USING clause
210707aded63Sdrh **       of a LEFT JOIN, and
210807aded63Sdrh **   (3) the expression does not contain any EP_FixedCol TK_COLUMN
210907aded63Sdrh **       operands created by the constant propagation optimization.
211007aded63Sdrh **
211107aded63Sdrh ** When this routine returns true, it indicates that the expression
211207aded63Sdrh ** can be added to the pParse->pConstExpr list and evaluated once when
21139b258c54Sdrh ** the prepared statement starts up.  See sqlite3ExprCodeRunJustOnce().
21140a168377Sdrh */
21150a168377Sdrh int sqlite3ExprIsConstantNotJoin(Expr *p){
2116059b2d50Sdrh   return exprIsConst(p, 2, 0);
21170a168377Sdrh }
21180a168377Sdrh 
21190a168377Sdrh /*
2120fcb9f4f3Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
2121059b2d50Sdrh ** for any single row of the table with cursor iCur.  In other words, the
2122059b2d50Sdrh ** expression must not refer to any non-deterministic function nor any
2123059b2d50Sdrh ** table other than iCur.
2124059b2d50Sdrh */
2125059b2d50Sdrh int sqlite3ExprIsTableConstant(Expr *p, int iCur){
2126059b2d50Sdrh   return exprIsConst(p, 3, iCur);
2127059b2d50Sdrh }
2128059b2d50Sdrh 
2129ab31a845Sdan 
2130ab31a845Sdan /*
2131ab31a845Sdan ** sqlite3WalkExpr() callback used by sqlite3ExprIsConstantOrGroupBy().
2132ab31a845Sdan */
2133ab31a845Sdan static int exprNodeIsConstantOrGroupBy(Walker *pWalker, Expr *pExpr){
2134ab31a845Sdan   ExprList *pGroupBy = pWalker->u.pGroupBy;
2135ab31a845Sdan   int i;
2136ab31a845Sdan 
2137ab31a845Sdan   /* Check if pExpr is identical to any GROUP BY term. If so, consider
2138ab31a845Sdan   ** it constant.  */
2139ab31a845Sdan   for(i=0; i<pGroupBy->nExpr; i++){
2140ab31a845Sdan     Expr *p = pGroupBy->a[i].pExpr;
21415aa550cfSdan     if( sqlite3ExprCompare(0, pExpr, p, -1)<2 ){
214270efa84dSdrh       CollSeq *pColl = sqlite3ExprNNCollSeq(pWalker->pParse, p);
2143efad2e23Sdrh       if( sqlite3IsBinary(pColl) ){
2144ab31a845Sdan         return WRC_Prune;
2145ab31a845Sdan       }
2146ab31a845Sdan     }
2147ab31a845Sdan   }
2148ab31a845Sdan 
2149ab31a845Sdan   /* Check if pExpr is a sub-select. If so, consider it variable. */
2150ab31a845Sdan   if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2151ab31a845Sdan     pWalker->eCode = 0;
2152ab31a845Sdan     return WRC_Abort;
2153ab31a845Sdan   }
2154ab31a845Sdan 
2155ab31a845Sdan   return exprNodeIsConstant(pWalker, pExpr);
2156ab31a845Sdan }
2157ab31a845Sdan 
2158ab31a845Sdan /*
2159ab31a845Sdan ** Walk the expression tree passed as the first argument. Return non-zero
2160ab31a845Sdan ** if the expression consists entirely of constants or copies of terms
2161ab31a845Sdan ** in pGroupBy that sort with the BINARY collation sequence.
2162ab314001Sdrh **
2163ab314001Sdrh ** This routine is used to determine if a term of the HAVING clause can
2164ab314001Sdrh ** be promoted into the WHERE clause.  In order for such a promotion to work,
2165ab314001Sdrh ** the value of the HAVING clause term must be the same for all members of
2166ab314001Sdrh ** a "group".  The requirement that the GROUP BY term must be BINARY
2167ab314001Sdrh ** assumes that no other collating sequence will have a finer-grained
2168ab314001Sdrh ** grouping than binary.  In other words (A=B COLLATE binary) implies
2169ab314001Sdrh ** A=B in every other collating sequence.  The requirement that the
2170ab314001Sdrh ** GROUP BY be BINARY is stricter than necessary.  It would also work
2171ab314001Sdrh ** to promote HAVING clauses that use the same alternative collating
2172ab314001Sdrh ** sequence as the GROUP BY term, but that is much harder to check,
2173ab314001Sdrh ** alternative collating sequences are uncommon, and this is only an
2174ab314001Sdrh ** optimization, so we take the easy way out and simply require the
2175ab314001Sdrh ** GROUP BY to use the BINARY collating sequence.
2176ab31a845Sdan */
2177ab31a845Sdan int sqlite3ExprIsConstantOrGroupBy(Parse *pParse, Expr *p, ExprList *pGroupBy){
2178ab31a845Sdan   Walker w;
2179ab31a845Sdan   w.eCode = 1;
2180ab31a845Sdan   w.xExprCallback = exprNodeIsConstantOrGroupBy;
2181979dd1beSdrh   w.xSelectCallback = 0;
2182ab31a845Sdan   w.u.pGroupBy = pGroupBy;
2183ab31a845Sdan   w.pParse = pParse;
2184ab31a845Sdan   sqlite3WalkExpr(&w, p);
2185ab31a845Sdan   return w.eCode;
2186ab31a845Sdan }
2187ab31a845Sdan 
2188059b2d50Sdrh /*
2189014fff20Sdrh ** Walk an expression tree for the DEFAULT field of a column definition
2190014fff20Sdrh ** in a CREATE TABLE statement.  Return non-zero if the expression is
2191014fff20Sdrh ** acceptable for use as a DEFAULT.  That is to say, return non-zero if
2192014fff20Sdrh ** the expression is constant or a function call with constant arguments.
2193014fff20Sdrh ** Return and 0 if there are any variables.
2194014fff20Sdrh **
21951e32bed3Sdrh ** isInit is true when parsing from sqlite_schema.  isInit is false when
2196014fff20Sdrh ** processing a new CREATE TABLE statement.  When isInit is true, parameters
2197014fff20Sdrh ** (such as ? or $abc) in the expression are converted into NULL.  When
2198014fff20Sdrh ** isInit is false, parameters raise an error.  Parameters should not be
2199014fff20Sdrh ** allowed in a CREATE TABLE statement, but some legacy versions of SQLite
22001e32bed3Sdrh ** allowed it, so we need to support it when reading sqlite_schema for
2201014fff20Sdrh ** backwards compatibility.
2202014fff20Sdrh **
2203014fff20Sdrh ** If isInit is true, set EP_FromDDL on every TK_FUNCTION node.
2204eb55bd2fSdrh **
2205eb55bd2fSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
2206eb55bd2fSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
2207eb55bd2fSdrh ** a constant.
2208eb55bd2fSdrh */
2209feada2dfSdrh int sqlite3ExprIsConstantOrFunction(Expr *p, u8 isInit){
2210feada2dfSdrh   assert( isInit==0 || isInit==1 );
2211059b2d50Sdrh   return exprIsConst(p, 4+isInit, 0);
2212eb55bd2fSdrh }
2213eb55bd2fSdrh 
22145b88bc4bSdrh #ifdef SQLITE_ENABLE_CURSOR_HINTS
22155b88bc4bSdrh /*
22165b88bc4bSdrh ** Walk an expression tree.  Return 1 if the expression contains a
22175b88bc4bSdrh ** subquery of some kind.  Return 0 if there are no subqueries.
22185b88bc4bSdrh */
22195b88bc4bSdrh int sqlite3ExprContainsSubquery(Expr *p){
22205b88bc4bSdrh   Walker w;
2221bec2476aSdrh   w.eCode = 1;
22225b88bc4bSdrh   w.xExprCallback = sqlite3ExprWalkNoop;
22237e6f980bSdrh   w.xSelectCallback = sqlite3SelectWalkFail;
2224979dd1beSdrh #ifdef SQLITE_DEBUG
2225979dd1beSdrh   w.xSelectCallback2 = sqlite3SelectWalkAssert2;
2226979dd1beSdrh #endif
22275b88bc4bSdrh   sqlite3WalkExpr(&w, p);
222807194bffSdrh   return w.eCode==0;
22295b88bc4bSdrh }
22305b88bc4bSdrh #endif
22315b88bc4bSdrh 
2232eb55bd2fSdrh /*
223373b211abSdrh ** If the expression p codes a constant integer that is small enough
2234202b2df7Sdrh ** to fit in a 32-bit integer, return 1 and put the value of the integer
2235202b2df7Sdrh ** in *pValue.  If the expression is not an integer or if it is too big
2236202b2df7Sdrh ** to fit in a signed 32-bit integer, return 0 and leave *pValue unchanged.
2237e4de1febSdrh */
22384adee20fSdanielk1977 int sqlite3ExprIsInteger(Expr *p, int *pValue){
223992b01d53Sdrh   int rc = 0;
22401d2d71a0Sdrh   if( NEVER(p==0) ) return 0;  /* Used to only happen following on OOM */
2241cd92e84dSdrh 
2242cd92e84dSdrh   /* If an expression is an integer literal that fits in a signed 32-bit
2243cd92e84dSdrh   ** integer, then the EP_IntValue flag will have already been set */
2244cd92e84dSdrh   assert( p->op!=TK_INTEGER || (p->flags & EP_IntValue)!=0
2245cd92e84dSdrh            || sqlite3GetInt32(p->u.zToken, &rc)==0 );
2246cd92e84dSdrh 
224792b01d53Sdrh   if( p->flags & EP_IntValue ){
224833e619fcSdrh     *pValue = p->u.iValue;
2249e4de1febSdrh     return 1;
2250e4de1febSdrh   }
225192b01d53Sdrh   switch( p->op ){
22524b59ab5eSdrh     case TK_UPLUS: {
225392b01d53Sdrh       rc = sqlite3ExprIsInteger(p->pLeft, pValue);
2254f6e369a1Sdrh       break;
22554b59ab5eSdrh     }
2256e4de1febSdrh     case TK_UMINUS: {
2257e4de1febSdrh       int v;
22584adee20fSdanielk1977       if( sqlite3ExprIsInteger(p->pLeft, &v) ){
2259f6418891Smistachkin         assert( v!=(-2147483647-1) );
2260e4de1febSdrh         *pValue = -v;
226192b01d53Sdrh         rc = 1;
2262e4de1febSdrh       }
2263e4de1febSdrh       break;
2264e4de1febSdrh     }
2265e4de1febSdrh     default: break;
2266e4de1febSdrh   }
226792b01d53Sdrh   return rc;
2268e4de1febSdrh }
2269e4de1febSdrh 
2270e4de1febSdrh /*
2271039fc32eSdrh ** Return FALSE if there is no chance that the expression can be NULL.
2272039fc32eSdrh **
2273039fc32eSdrh ** If the expression might be NULL or if the expression is too complex
2274039fc32eSdrh ** to tell return TRUE.
2275039fc32eSdrh **
2276039fc32eSdrh ** This routine is used as an optimization, to skip OP_IsNull opcodes
2277039fc32eSdrh ** when we know that a value cannot be NULL.  Hence, a false positive
2278039fc32eSdrh ** (returning TRUE when in fact the expression can never be NULL) might
2279039fc32eSdrh ** be a small performance hit but is otherwise harmless.  On the other
2280039fc32eSdrh ** hand, a false negative (returning FALSE when the result could be NULL)
2281039fc32eSdrh ** will likely result in an incorrect answer.  So when in doubt, return
2282039fc32eSdrh ** TRUE.
2283039fc32eSdrh */
2284039fc32eSdrh int sqlite3ExprCanBeNull(const Expr *p){
2285039fc32eSdrh   u8 op;
22869bfb0794Sdrh   while( p->op==TK_UPLUS || p->op==TK_UMINUS ){
22879bfb0794Sdrh     p = p->pLeft;
22889bfb0794Sdrh   }
2289039fc32eSdrh   op = p->op;
2290039fc32eSdrh   if( op==TK_REGISTER ) op = p->op2;
2291039fc32eSdrh   switch( op ){
2292039fc32eSdrh     case TK_INTEGER:
2293039fc32eSdrh     case TK_STRING:
2294039fc32eSdrh     case TK_FLOAT:
2295039fc32eSdrh     case TK_BLOB:
2296039fc32eSdrh       return 0;
22977248a8b2Sdrh     case TK_COLUMN:
229872673a24Sdrh       return ExprHasProperty(p, EP_CanBeNull) ||
2299eda079cdSdrh              p->y.pTab==0 ||  /* Reference to column of index on expression */
23004eac5f04Sdrh              (p->iColumn>=0
23014eac5f04Sdrh               && ALWAYS(p->y.pTab->aCol!=0) /* Defense against OOM problems */
23024eac5f04Sdrh               && p->y.pTab->aCol[p->iColumn].notNull==0);
2303039fc32eSdrh     default:
2304039fc32eSdrh       return 1;
2305039fc32eSdrh   }
2306039fc32eSdrh }
2307039fc32eSdrh 
2308039fc32eSdrh /*
2309039fc32eSdrh ** Return TRUE if the given expression is a constant which would be
2310039fc32eSdrh ** unchanged by OP_Affinity with the affinity given in the second
2311039fc32eSdrh ** argument.
2312039fc32eSdrh **
2313039fc32eSdrh ** This routine is used to determine if the OP_Affinity operation
2314039fc32eSdrh ** can be omitted.  When in doubt return FALSE.  A false negative
2315039fc32eSdrh ** is harmless.  A false positive, however, can result in the wrong
2316039fc32eSdrh ** answer.
2317039fc32eSdrh */
2318039fc32eSdrh int sqlite3ExprNeedsNoAffinityChange(const Expr *p, char aff){
2319039fc32eSdrh   u8 op;
2320af866402Sdrh   int unaryMinus = 0;
232105883a34Sdrh   if( aff==SQLITE_AFF_BLOB ) return 1;
2322af866402Sdrh   while( p->op==TK_UPLUS || p->op==TK_UMINUS ){
2323af866402Sdrh     if( p->op==TK_UMINUS ) unaryMinus = 1;
2324af866402Sdrh     p = p->pLeft;
2325af866402Sdrh   }
2326039fc32eSdrh   op = p->op;
2327039fc32eSdrh   if( op==TK_REGISTER ) op = p->op2;
2328039fc32eSdrh   switch( op ){
2329039fc32eSdrh     case TK_INTEGER: {
23306a19865fSdrh       return aff>=SQLITE_AFF_NUMERIC;
2331039fc32eSdrh     }
2332039fc32eSdrh     case TK_FLOAT: {
23336a19865fSdrh       return aff>=SQLITE_AFF_NUMERIC;
2334039fc32eSdrh     }
2335039fc32eSdrh     case TK_STRING: {
2336af866402Sdrh       return !unaryMinus && aff==SQLITE_AFF_TEXT;
2337039fc32eSdrh     }
2338039fc32eSdrh     case TK_BLOB: {
2339af866402Sdrh       return !unaryMinus;
2340039fc32eSdrh     }
23412f2855b6Sdrh     case TK_COLUMN: {
234288376ca7Sdrh       assert( p->iTable>=0 );  /* p cannot be part of a CHECK constraint */
23436a19865fSdrh       return aff>=SQLITE_AFF_NUMERIC && p->iColumn<0;
23442f2855b6Sdrh     }
2345039fc32eSdrh     default: {
2346039fc32eSdrh       return 0;
2347039fc32eSdrh     }
2348039fc32eSdrh   }
2349039fc32eSdrh }
2350039fc32eSdrh 
2351039fc32eSdrh /*
2352c4a3c779Sdrh ** Return TRUE if the given string is a row-id column name.
2353c4a3c779Sdrh */
23544adee20fSdanielk1977 int sqlite3IsRowid(const char *z){
23554adee20fSdanielk1977   if( sqlite3StrICmp(z, "_ROWID_")==0 ) return 1;
23564adee20fSdanielk1977   if( sqlite3StrICmp(z, "ROWID")==0 ) return 1;
23574adee20fSdanielk1977   if( sqlite3StrICmp(z, "OID")==0 ) return 1;
2358c4a3c779Sdrh   return 0;
2359c4a3c779Sdrh }
2360c4a3c779Sdrh 
23619a96b668Sdanielk1977 /*
236269c355bdSdrh ** pX is the RHS of an IN operator.  If pX is a SELECT statement
236369c355bdSdrh ** that can be simplified to a direct table access, then return
236469c355bdSdrh ** a pointer to the SELECT statement.  If pX is not a SELECT statement,
236569c355bdSdrh ** or if the SELECT statement needs to be manifested into a transient
236669c355bdSdrh ** table, then return NULL.
2367b287f4b6Sdrh */
2368b287f4b6Sdrh #ifndef SQLITE_OMIT_SUBQUERY
23697b35a77bSdan static Select *isCandidateForInOpt(Expr *pX){
237069c355bdSdrh   Select *p;
2371b287f4b6Sdrh   SrcList *pSrc;
2372b287f4b6Sdrh   ExprList *pEList;
2373b287f4b6Sdrh   Table *pTab;
2374cfbb5e82Sdan   int i;
237569c355bdSdrh   if( !ExprHasProperty(pX, EP_xIsSelect) ) return 0;  /* Not a subquery */
237669c355bdSdrh   if( ExprHasProperty(pX, EP_VarSelect)  ) return 0;  /* Correlated subq */
237769c355bdSdrh   p = pX->x.pSelect;
2378b287f4b6Sdrh   if( p->pPrior ) return 0;              /* Not a compound SELECT */
23797d10d5a6Sdrh   if( p->selFlags & (SF_Distinct|SF_Aggregate) ){
2380b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
2381b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
23827d10d5a6Sdrh     return 0; /* No DISTINCT keyword and no aggregate functions */
23837d10d5a6Sdrh   }
23842e26a602Sdrh   assert( p->pGroupBy==0 );              /* Has no GROUP BY clause */
2385b287f4b6Sdrh   if( p->pLimit ) return 0;              /* Has no LIMIT clause */
2386b287f4b6Sdrh   if( p->pWhere ) return 0;              /* Has no WHERE clause */
2387b287f4b6Sdrh   pSrc = p->pSrc;
2388d1fa7bcaSdrh   assert( pSrc!=0 );
2389d1fa7bcaSdrh   if( pSrc->nSrc!=1 ) return 0;          /* Single term in FROM clause */
2390b74b1017Sdrh   if( pSrc->a[0].pSelect ) return 0;     /* FROM is not a subquery or view */
2391b287f4b6Sdrh   pTab = pSrc->a[0].pTab;
239269c355bdSdrh   assert( pTab!=0 );
2393b74b1017Sdrh   assert( pTab->pSelect==0 );            /* FROM clause is not a view */
2394b287f4b6Sdrh   if( IsVirtual(pTab) ) return 0;        /* FROM clause not a virtual table */
2395b287f4b6Sdrh   pEList = p->pEList;
2396ac6b47d1Sdrh   assert( pEList!=0 );
23977b35a77bSdan   /* All SELECT results must be columns. */
2398cfbb5e82Sdan   for(i=0; i<pEList->nExpr; i++){
2399cfbb5e82Sdan     Expr *pRes = pEList->a[i].pExpr;
2400cfbb5e82Sdan     if( pRes->op!=TK_COLUMN ) return 0;
240169c355bdSdrh     assert( pRes->iTable==pSrc->a[0].iCursor );  /* Not a correlated subquery */
2402cfbb5e82Sdan   }
240369c355bdSdrh   return p;
2404b287f4b6Sdrh }
2405b287f4b6Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
2406b287f4b6Sdrh 
2407f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
24081d8cb21fSdan /*
24094c259e9fSdrh ** Generate code that checks the left-most column of index table iCur to see if
24104c259e9fSdrh ** it contains any NULL entries.  Cause the register at regHasNull to be set
24116be515ebSdrh ** to a non-NULL value if iCur contains no NULLs.  Cause register regHasNull
24126be515ebSdrh ** to be set to NULL if iCur contains one or more NULL values.
24136be515ebSdrh */
24146be515ebSdrh static void sqlite3SetHasNullFlag(Vdbe *v, int iCur, int regHasNull){
2415728e0f91Sdrh   int addr1;
24166be515ebSdrh   sqlite3VdbeAddOp2(v, OP_Integer, 0, regHasNull);
2417728e0f91Sdrh   addr1 = sqlite3VdbeAddOp1(v, OP_Rewind, iCur); VdbeCoverage(v);
24186be515ebSdrh   sqlite3VdbeAddOp3(v, OP_Column, iCur, 0, regHasNull);
24196be515ebSdrh   sqlite3VdbeChangeP5(v, OPFLAG_TYPEOFARG);
24204c259e9fSdrh   VdbeComment((v, "first_entry_in(%d)", iCur));
2421728e0f91Sdrh   sqlite3VdbeJumpHere(v, addr1);
24226be515ebSdrh }
2423f9b2e05cSdan #endif
24246be515ebSdrh 
2425bb53ecb1Sdrh 
2426bb53ecb1Sdrh #ifndef SQLITE_OMIT_SUBQUERY
2427bb53ecb1Sdrh /*
2428bb53ecb1Sdrh ** The argument is an IN operator with a list (not a subquery) on the
2429bb53ecb1Sdrh ** right-hand side.  Return TRUE if that list is constant.
2430bb53ecb1Sdrh */
2431bb53ecb1Sdrh static int sqlite3InRhsIsConstant(Expr *pIn){
2432bb53ecb1Sdrh   Expr *pLHS;
2433bb53ecb1Sdrh   int res;
2434bb53ecb1Sdrh   assert( !ExprHasProperty(pIn, EP_xIsSelect) );
2435bb53ecb1Sdrh   pLHS = pIn->pLeft;
2436bb53ecb1Sdrh   pIn->pLeft = 0;
2437bb53ecb1Sdrh   res = sqlite3ExprIsConstant(pIn);
2438bb53ecb1Sdrh   pIn->pLeft = pLHS;
2439bb53ecb1Sdrh   return res;
2440bb53ecb1Sdrh }
2441bb53ecb1Sdrh #endif
2442bb53ecb1Sdrh 
24436be515ebSdrh /*
24449a96b668Sdanielk1977 ** This function is used by the implementation of the IN (...) operator.
2445d4305ca6Sdrh ** The pX parameter is the expression on the RHS of the IN operator, which
2446d4305ca6Sdrh ** might be either a list of expressions or a subquery.
24479a96b668Sdanielk1977 **
2448d4305ca6Sdrh ** The job of this routine is to find or create a b-tree object that can
2449d4305ca6Sdrh ** be used either to test for membership in the RHS set or to iterate through
2450d4305ca6Sdrh ** all members of the RHS set, skipping duplicates.
2451d4305ca6Sdrh **
24523a85625dSdrh ** A cursor is opened on the b-tree object that is the RHS of the IN operator
2453d4305ca6Sdrh ** and pX->iTable is set to the index of that cursor.
2454d4305ca6Sdrh **
2455b74b1017Sdrh ** The returned value of this function indicates the b-tree type, as follows:
24569a96b668Sdanielk1977 **
24579a96b668Sdanielk1977 **   IN_INDEX_ROWID      - The cursor was opened on a database table.
24581ccce449Sdrh **   IN_INDEX_INDEX_ASC  - The cursor was opened on an ascending index.
24591ccce449Sdrh **   IN_INDEX_INDEX_DESC - The cursor was opened on a descending index.
24609a96b668Sdanielk1977 **   IN_INDEX_EPH        - The cursor was opened on a specially created and
24619a96b668Sdanielk1977 **                         populated epheremal table.
2462bb53ecb1Sdrh **   IN_INDEX_NOOP       - No cursor was allocated.  The IN operator must be
2463bb53ecb1Sdrh **                         implemented as a sequence of comparisons.
24649a96b668Sdanielk1977 **
2465d4305ca6Sdrh ** An existing b-tree might be used if the RHS expression pX is a simple
2466d4305ca6Sdrh ** subquery such as:
24679a96b668Sdanielk1977 **
2468553168c7Sdan **     SELECT <column1>, <column2>... FROM <table>
24699a96b668Sdanielk1977 **
2470d4305ca6Sdrh ** If the RHS of the IN operator is a list or a more complex subquery, then
2471d4305ca6Sdrh ** an ephemeral table might need to be generated from the RHS and then
247260ec914cSpeter.d.reid ** pX->iTable made to point to the ephemeral table instead of an
2473d4305ca6Sdrh ** existing table.
2474d4305ca6Sdrh **
24757fc0ba0fSdrh ** The inFlags parameter must contain, at a minimum, one of the bits
24767fc0ba0fSdrh ** IN_INDEX_MEMBERSHIP or IN_INDEX_LOOP but not both.  If inFlags contains
24777fc0ba0fSdrh ** IN_INDEX_MEMBERSHIP, then the generated table will be used for a fast
24787fc0ba0fSdrh ** membership test.  When the IN_INDEX_LOOP bit is set, the IN index will
24797fc0ba0fSdrh ** be used to loop over all values of the RHS of the IN operator.
24803a85625dSdrh **
24813a85625dSdrh ** When IN_INDEX_LOOP is used (and the b-tree will be used to iterate
24823a85625dSdrh ** through the set members) then the b-tree must not contain duplicates.
24837fc0ba0fSdrh ** An epheremal table will be created unless the selected columns are guaranteed
2484553168c7Sdan ** to be unique - either because it is an INTEGER PRIMARY KEY or due to
2485553168c7Sdan ** a UNIQUE constraint or index.
24860cdc022eSdanielk1977 **
24873a85625dSdrh ** When IN_INDEX_MEMBERSHIP is used (and the b-tree will be used
24883a85625dSdrh ** for fast set membership tests) then an epheremal table must
2489553168c7Sdan ** be used unless <columns> is a single INTEGER PRIMARY KEY column or an
2490553168c7Sdan ** index can be found with the specified <columns> as its left-most.
24910cdc022eSdanielk1977 **
2492bb53ecb1Sdrh ** If the IN_INDEX_NOOP_OK and IN_INDEX_MEMBERSHIP are both set and
2493bb53ecb1Sdrh ** if the RHS of the IN operator is a list (not a subquery) then this
2494bb53ecb1Sdrh ** routine might decide that creating an ephemeral b-tree for membership
2495bb53ecb1Sdrh ** testing is too expensive and return IN_INDEX_NOOP.  In that case, the
2496bb53ecb1Sdrh ** calling routine should implement the IN operator using a sequence
2497bb53ecb1Sdrh ** of Eq or Ne comparison operations.
2498bb53ecb1Sdrh **
2499b74b1017Sdrh ** When the b-tree is being used for membership tests, the calling function
25003a85625dSdrh ** might need to know whether or not the RHS side of the IN operator
2501e21a6e1dSdrh ** contains a NULL.  If prRhsHasNull is not a NULL pointer and
25023a85625dSdrh ** if there is any chance that the (...) might contain a NULL value at
25030cdc022eSdanielk1977 ** runtime, then a register is allocated and the register number written
2504e21a6e1dSdrh ** to *prRhsHasNull. If there is no chance that the (...) contains a
2505e21a6e1dSdrh ** NULL value, then *prRhsHasNull is left unchanged.
25060cdc022eSdanielk1977 **
2507e21a6e1dSdrh ** If a register is allocated and its location stored in *prRhsHasNull, then
25086be515ebSdrh ** the value in that register will be NULL if the b-tree contains one or more
25096be515ebSdrh ** NULL values, and it will be some non-NULL value if the b-tree contains no
25106be515ebSdrh ** NULL values.
2511553168c7Sdan **
2512553168c7Sdan ** If the aiMap parameter is not NULL, it must point to an array containing
2513553168c7Sdan ** one element for each column returned by the SELECT statement on the RHS
2514553168c7Sdan ** of the IN(...) operator. The i'th entry of the array is populated with the
2515553168c7Sdan ** offset of the index column that matches the i'th column returned by the
2516553168c7Sdan ** SELECT. For example, if the expression and selected index are:
2517553168c7Sdan **
2518553168c7Sdan **   (?,?,?) IN (SELECT a, b, c FROM t1)
2519553168c7Sdan **   CREATE INDEX i1 ON t1(b, c, a);
2520553168c7Sdan **
2521553168c7Sdan ** then aiMap[] is populated with {2, 0, 1}.
25229a96b668Sdanielk1977 */
2523284f4acaSdanielk1977 #ifndef SQLITE_OMIT_SUBQUERY
2524ba00e30aSdan int sqlite3FindInIndex(
25256fc8f364Sdrh   Parse *pParse,             /* Parsing context */
25260167ef20Sdrh   Expr *pX,                  /* The IN expression */
25276fc8f364Sdrh   u32 inFlags,               /* IN_INDEX_LOOP, _MEMBERSHIP, and/or _NOOP_OK */
25286fc8f364Sdrh   int *prRhsHasNull,         /* Register holding NULL status.  See notes */
25292c04131cSdrh   int *aiMap,                /* Mapping from Index fields to RHS fields */
25302c04131cSdrh   int *piTab                 /* OUT: index to use */
2531ba00e30aSdan ){
2532b74b1017Sdrh   Select *p;                            /* SELECT to the right of IN operator */
2533b74b1017Sdrh   int eType = 0;                        /* Type of RHS table. IN_INDEX_* */
2534b74b1017Sdrh   int iTab = pParse->nTab++;            /* Cursor of the RHS table */
25353a85625dSdrh   int mustBeUnique;                     /* True if RHS must be unique */
2536b8475df8Sdrh   Vdbe *v = sqlite3GetVdbe(pParse);     /* Virtual machine being coded */
25379a96b668Sdanielk1977 
25381450bc6eSdrh   assert( pX->op==TK_IN );
25393a85625dSdrh   mustBeUnique = (inFlags & IN_INDEX_LOOP)!=0;
25401450bc6eSdrh 
25417b35a77bSdan   /* If the RHS of this IN(...) operator is a SELECT, and if it matters
25427b35a77bSdan   ** whether or not the SELECT result contains NULL values, check whether
2543870a0705Sdan   ** or not NULL is actually possible (it may not be, for example, due
25447b35a77bSdan   ** to NOT NULL constraints in the schema). If no NULL values are possible,
2545870a0705Sdan   ** set prRhsHasNull to 0 before continuing.  */
25467b35a77bSdan   if( prRhsHasNull && (pX->flags & EP_xIsSelect) ){
25477b35a77bSdan     int i;
25487b35a77bSdan     ExprList *pEList = pX->x.pSelect->pEList;
25497b35a77bSdan     for(i=0; i<pEList->nExpr; i++){
25507b35a77bSdan       if( sqlite3ExprCanBeNull(pEList->a[i].pExpr) ) break;
25517b35a77bSdan     }
25527b35a77bSdan     if( i==pEList->nExpr ){
25537b35a77bSdan       prRhsHasNull = 0;
25547b35a77bSdan     }
25557b35a77bSdan   }
25567b35a77bSdan 
2557b74b1017Sdrh   /* Check to see if an existing table or index can be used to
2558b74b1017Sdrh   ** satisfy the query.  This is preferable to generating a new
25597b35a77bSdan   ** ephemeral table.  */
25607b35a77bSdan   if( pParse->nErr==0 && (p = isCandidateForInOpt(pX))!=0 ){
2561e1fb65a0Sdanielk1977     sqlite3 *db = pParse->db;              /* Database connection */
2562b07028f7Sdrh     Table *pTab;                           /* Table <table>. */
2563399062ccSdrh     int iDb;                               /* Database idx for pTab */
2564cfbb5e82Sdan     ExprList *pEList = p->pEList;
2565cfbb5e82Sdan     int nExpr = pEList->nExpr;
2566e1fb65a0Sdanielk1977 
2567b07028f7Sdrh     assert( p->pEList!=0 );             /* Because of isCandidateForInOpt(p) */
2568b07028f7Sdrh     assert( p->pEList->a[0].pExpr!=0 ); /* Because of isCandidateForInOpt(p) */
2569b07028f7Sdrh     assert( p->pSrc!=0 );               /* Because of isCandidateForInOpt(p) */
2570b07028f7Sdrh     pTab = p->pSrc->a[0].pTab;
2571b07028f7Sdrh 
2572b22f7c83Sdrh     /* Code an OP_Transaction and OP_TableLock for <table>. */
2573e1fb65a0Sdanielk1977     iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
2574bdd4f7d9Sdrh     assert( iDb>=0 && iDb<SQLITE_MAX_ATTACHED );
2575e1fb65a0Sdanielk1977     sqlite3CodeVerifySchema(pParse, iDb);
2576e1fb65a0Sdanielk1977     sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
25779a96b668Sdanielk1977 
2578a84a283dSdrh     assert(v);  /* sqlite3GetVdbe() has always been previously called */
2579cfbb5e82Sdan     if( nExpr==1 && pEList->a[0].pExpr->iColumn<0 ){
258062659b2aSdrh       /* The "x IN (SELECT rowid FROM table)" case */
2581511f9e8dSdrh       int iAddr = sqlite3VdbeAddOp0(v, OP_Once);
25827d176105Sdrh       VdbeCoverage(v);
25839a96b668Sdanielk1977 
25849a96b668Sdanielk1977       sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
25859a96b668Sdanielk1977       eType = IN_INDEX_ROWID;
2586d8852095Sdrh       ExplainQueryPlan((pParse, 0,
2587d8852095Sdrh             "USING ROWID SEARCH ON TABLE %s FOR IN-OPERATOR",pTab->zName));
25889a96b668Sdanielk1977       sqlite3VdbeJumpHere(v, iAddr);
25899a96b668Sdanielk1977     }else{
2590e1fb65a0Sdanielk1977       Index *pIdx;                         /* Iterator variable */
2591cfbb5e82Sdan       int affinity_ok = 1;
2592cfbb5e82Sdan       int i;
2593cfbb5e82Sdan 
2594cfbb5e82Sdan       /* Check that the affinity that will be used to perform each
259562659b2aSdrh       ** comparison is the same as the affinity of each column in table
259662659b2aSdrh       ** on the RHS of the IN operator.  If it not, it is not possible to
259762659b2aSdrh       ** use any index of the RHS table.  */
2598cfbb5e82Sdan       for(i=0; i<nExpr && affinity_ok; i++){
2599fc7f27b9Sdrh         Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2600cfbb5e82Sdan         int iCol = pEList->a[i].pExpr->iColumn;
26010dfa4f6fSdrh         char idxaff = sqlite3TableColumnAffinity(pTab,iCol); /* RHS table */
2602cfbb5e82Sdan         char cmpaff = sqlite3CompareAffinity(pLhs, idxaff);
260362659b2aSdrh         testcase( cmpaff==SQLITE_AFF_BLOB );
260462659b2aSdrh         testcase( cmpaff==SQLITE_AFF_TEXT );
2605cfbb5e82Sdan         switch( cmpaff ){
2606cfbb5e82Sdan           case SQLITE_AFF_BLOB:
2607cfbb5e82Sdan             break;
2608cfbb5e82Sdan           case SQLITE_AFF_TEXT:
260962659b2aSdrh             /* sqlite3CompareAffinity() only returns TEXT if one side or the
261062659b2aSdrh             ** other has no affinity and the other side is TEXT.  Hence,
261162659b2aSdrh             ** the only way for cmpaff to be TEXT is for idxaff to be TEXT
261262659b2aSdrh             ** and for the term on the LHS of the IN to have no affinity. */
261362659b2aSdrh             assert( idxaff==SQLITE_AFF_TEXT );
2614cfbb5e82Sdan             break;
2615cfbb5e82Sdan           default:
2616cfbb5e82Sdan             affinity_ok = sqlite3IsNumericAffinity(idxaff);
2617cfbb5e82Sdan         }
2618cfbb5e82Sdan       }
2619e1fb65a0Sdanielk1977 
2620a84a283dSdrh       if( affinity_ok ){
2621a84a283dSdrh         /* Search for an existing index that will work for this IN operator */
2622a84a283dSdrh         for(pIdx=pTab->pIndex; pIdx && eType==0; pIdx=pIdx->pNext){
2623a84a283dSdrh           Bitmask colUsed;      /* Columns of the index used */
2624a84a283dSdrh           Bitmask mCol;         /* Mask for the current column */
26256fc8f364Sdrh           if( pIdx->nColumn<nExpr ) continue;
2626d4a4a361Sdrh           if( pIdx->pPartIdxWhere!=0 ) continue;
2627a84a283dSdrh           /* Maximum nColumn is BMS-2, not BMS-1, so that we can compute
2628a84a283dSdrh           ** BITMASK(nExpr) without overflowing */
2629a84a283dSdrh           testcase( pIdx->nColumn==BMS-2 );
2630a84a283dSdrh           testcase( pIdx->nColumn==BMS-1 );
2631a84a283dSdrh           if( pIdx->nColumn>=BMS-1 ) continue;
26326fc8f364Sdrh           if( mustBeUnique ){
26336fc8f364Sdrh             if( pIdx->nKeyCol>nExpr
26346fc8f364Sdrh              ||(pIdx->nColumn>nExpr && !IsUniqueIndex(pIdx))
26356fc8f364Sdrh             ){
2636a84a283dSdrh               continue;  /* This index is not unique over the IN RHS columns */
2637cfbb5e82Sdan             }
26386fc8f364Sdrh           }
2639cfbb5e82Sdan 
2640a84a283dSdrh           colUsed = 0;   /* Columns of index used so far */
2641cfbb5e82Sdan           for(i=0; i<nExpr; i++){
2642fc7f27b9Sdrh             Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2643cfbb5e82Sdan             Expr *pRhs = pEList->a[i].pExpr;
2644cfbb5e82Sdan             CollSeq *pReq = sqlite3BinaryCompareCollSeq(pParse, pLhs, pRhs);
2645cfbb5e82Sdan             int j;
2646cfbb5e82Sdan 
26476fc8f364Sdrh             assert( pReq!=0 || pRhs->iColumn==XN_ROWID || pParse->nErr );
2648cfbb5e82Sdan             for(j=0; j<nExpr; j++){
2649cfbb5e82Sdan               if( pIdx->aiColumn[j]!=pRhs->iColumn ) continue;
2650cfbb5e82Sdan               assert( pIdx->azColl[j] );
2651106526e1Sdrh               if( pReq!=0 && sqlite3StrICmp(pReq->zName, pIdx->azColl[j])!=0 ){
2652106526e1Sdrh                 continue;
2653106526e1Sdrh               }
2654cfbb5e82Sdan               break;
2655cfbb5e82Sdan             }
2656cfbb5e82Sdan             if( j==nExpr ) break;
2657a84a283dSdrh             mCol = MASKBIT(j);
2658a84a283dSdrh             if( mCol & colUsed ) break; /* Each column used only once */
2659a84a283dSdrh             colUsed |= mCol;
2660ba00e30aSdan             if( aiMap ) aiMap[i] = j;
2661cfbb5e82Sdan           }
2662cfbb5e82Sdan 
2663a84a283dSdrh           assert( i==nExpr || colUsed!=(MASKBIT(nExpr)-1) );
2664a84a283dSdrh           if( colUsed==(MASKBIT(nExpr)-1) ){
2665a84a283dSdrh             /* If we reach this point, that means the index pIdx is usable */
2666511f9e8dSdrh             int iAddr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
2667e2ca99c9Sdrh             ExplainQueryPlan((pParse, 0,
2668e2ca99c9Sdrh                               "USING INDEX %s FOR IN-OPERATOR",pIdx->zName));
26692ec2fb22Sdrh             sqlite3VdbeAddOp3(v, OP_OpenRead, iTab, pIdx->tnum, iDb);
26702ec2fb22Sdrh             sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
2671207872a4Sdanielk1977             VdbeComment((v, "%s", pIdx->zName));
26721ccce449Sdrh             assert( IN_INDEX_INDEX_DESC == IN_INDEX_INDEX_ASC+1 );
26731ccce449Sdrh             eType = IN_INDEX_INDEX_ASC + pIdx->aSortOrder[0];
26749a96b668Sdanielk1977 
26757b35a77bSdan             if( prRhsHasNull ){
26763480bfdaSdan #ifdef SQLITE_ENABLE_COLUMN_USED_MASK
2677cfbb5e82Sdan               i64 mask = (1<<nExpr)-1;
26783480bfdaSdan               sqlite3VdbeAddOp4Dup8(v, OP_ColumnsUsed,
2679cfbb5e82Sdan                   iTab, 0, 0, (u8*)&mask, P4_INT64);
26803480bfdaSdan #endif
2681b80dbdc2Sdrh               *prRhsHasNull = ++pParse->nMem;
26827b35a77bSdan               if( nExpr==1 ){
26836be515ebSdrh                 sqlite3SetHasNullFlag(v, iTab, *prRhsHasNull);
26840cdc022eSdanielk1977               }
26857b35a77bSdan             }
2686552fd454Sdrh             sqlite3VdbeJumpHere(v, iAddr);
26879a96b668Sdanielk1977           }
2688a84a283dSdrh         } /* End loop over indexes */
2689a84a283dSdrh       } /* End if( affinity_ok ) */
2690a84a283dSdrh     } /* End if not an rowid index */
2691a84a283dSdrh   } /* End attempt to optimize using an index */
26929a96b668Sdanielk1977 
2693bb53ecb1Sdrh   /* If no preexisting index is available for the IN clause
2694bb53ecb1Sdrh   ** and IN_INDEX_NOOP is an allowed reply
2695bb53ecb1Sdrh   ** and the RHS of the IN operator is a list, not a subquery
269671c57db0Sdan   ** and the RHS is not constant or has two or fewer terms,
269760ec914cSpeter.d.reid   ** then it is not worth creating an ephemeral table to evaluate
2698bb53ecb1Sdrh   ** the IN operator so return IN_INDEX_NOOP.
2699bb53ecb1Sdrh   */
2700bb53ecb1Sdrh   if( eType==0
2701bb53ecb1Sdrh    && (inFlags & IN_INDEX_NOOP_OK)
2702bb53ecb1Sdrh    && !ExprHasProperty(pX, EP_xIsSelect)
2703bb53ecb1Sdrh    && (!sqlite3InRhsIsConstant(pX) || pX->x.pList->nExpr<=2)
2704bb53ecb1Sdrh   ){
2705bb53ecb1Sdrh     eType = IN_INDEX_NOOP;
2706bb53ecb1Sdrh   }
2707bb53ecb1Sdrh 
27089a96b668Sdanielk1977   if( eType==0 ){
27094387006cSdrh     /* Could not find an existing table or index to use as the RHS b-tree.
2710b74b1017Sdrh     ** We will have to generate an ephemeral table to do the job.
2711b74b1017Sdrh     */
27128e23daf3Sdrh     u32 savedNQueryLoop = pParse->nQueryLoop;
27130cdc022eSdanielk1977     int rMayHaveNull = 0;
271441a05b7bSdanielk1977     eType = IN_INDEX_EPH;
27153a85625dSdrh     if( inFlags & IN_INDEX_LOOP ){
27164a5acf8eSdrh       pParse->nQueryLoop = 0;
2717e21a6e1dSdrh     }else if( prRhsHasNull ){
2718e21a6e1dSdrh       *prRhsHasNull = rMayHaveNull = ++pParse->nMem;
2719cf4d38aaSdrh     }
272085bcdce2Sdrh     assert( pX->op==TK_IN );
272150ef6716Sdrh     sqlite3CodeRhsOfIN(pParse, pX, iTab);
272285bcdce2Sdrh     if( rMayHaveNull ){
27232c04131cSdrh       sqlite3SetHasNullFlag(v, iTab, rMayHaveNull);
272485bcdce2Sdrh     }
2725cf4d38aaSdrh     pParse->nQueryLoop = savedNQueryLoop;
27269a96b668Sdanielk1977   }
2727ba00e30aSdan 
2728ba00e30aSdan   if( aiMap && eType!=IN_INDEX_INDEX_ASC && eType!=IN_INDEX_INDEX_DESC ){
2729ba00e30aSdan     int i, n;
2730ba00e30aSdan     n = sqlite3ExprVectorSize(pX->pLeft);
2731ba00e30aSdan     for(i=0; i<n; i++) aiMap[i] = i;
2732ba00e30aSdan   }
27332c04131cSdrh   *piTab = iTab;
27349a96b668Sdanielk1977   return eType;
27359a96b668Sdanielk1977 }
2736284f4acaSdanielk1977 #endif
2737626a879aSdrh 
2738f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
2739553168c7Sdan /*
2740553168c7Sdan ** Argument pExpr is an (?, ?...) IN(...) expression. This
2741553168c7Sdan ** function allocates and returns a nul-terminated string containing
2742553168c7Sdan ** the affinities to be used for each column of the comparison.
2743553168c7Sdan **
2744553168c7Sdan ** It is the responsibility of the caller to ensure that the returned
2745553168c7Sdan ** string is eventually freed using sqlite3DbFree().
2746553168c7Sdan */
274771c57db0Sdan static char *exprINAffinity(Parse *pParse, Expr *pExpr){
274871c57db0Sdan   Expr *pLeft = pExpr->pLeft;
274971c57db0Sdan   int nVal = sqlite3ExprVectorSize(pLeft);
2750553168c7Sdan   Select *pSelect = (pExpr->flags & EP_xIsSelect) ? pExpr->x.pSelect : 0;
275171c57db0Sdan   char *zRet;
275271c57db0Sdan 
2753553168c7Sdan   assert( pExpr->op==TK_IN );
27545c258dc1Sdrh   zRet = sqlite3DbMallocRaw(pParse->db, nVal+1);
275571c57db0Sdan   if( zRet ){
275671c57db0Sdan     int i;
275771c57db0Sdan     for(i=0; i<nVal; i++){
2758fc7f27b9Sdrh       Expr *pA = sqlite3VectorFieldSubexpr(pLeft, i);
2759553168c7Sdan       char a = sqlite3ExprAffinity(pA);
2760553168c7Sdan       if( pSelect ){
2761553168c7Sdan         zRet[i] = sqlite3CompareAffinity(pSelect->pEList->a[i].pExpr, a);
276271c57db0Sdan       }else{
2763553168c7Sdan         zRet[i] = a;
276471c57db0Sdan       }
276571c57db0Sdan     }
276671c57db0Sdan     zRet[nVal] = '\0';
276771c57db0Sdan   }
276871c57db0Sdan   return zRet;
276971c57db0Sdan }
2770f9b2e05cSdan #endif
277171c57db0Sdan 
27728da209b1Sdan #ifndef SQLITE_OMIT_SUBQUERY
27738da209b1Sdan /*
27748da209b1Sdan ** Load the Parse object passed as the first argument with an error
27758da209b1Sdan ** message of the form:
27768da209b1Sdan **
27778da209b1Sdan **   "sub-select returns N columns - expected M"
27788da209b1Sdan */
27798da209b1Sdan void sqlite3SubselectError(Parse *pParse, int nActual, int nExpect){
2780a9ebfe20Sdrh   if( pParse->nErr==0 ){
27818da209b1Sdan     const char *zFmt = "sub-select returns %d columns - expected %d";
27828da209b1Sdan     sqlite3ErrorMsg(pParse, zFmt, nActual, nExpect);
27838da209b1Sdan   }
2784a9ebfe20Sdrh }
27858da209b1Sdan #endif
27868da209b1Sdan 
2787626a879aSdrh /*
278844c5604cSdan ** Expression pExpr is a vector that has been used in a context where
278944c5604cSdan ** it is not permitted. If pExpr is a sub-select vector, this routine
279044c5604cSdan ** loads the Parse object with a message of the form:
279144c5604cSdan **
279244c5604cSdan **   "sub-select returns N columns - expected 1"
279344c5604cSdan **
279444c5604cSdan ** Or, if it is a regular scalar vector:
279544c5604cSdan **
279644c5604cSdan **   "row value misused"
279744c5604cSdan */
279844c5604cSdan void sqlite3VectorErrorMsg(Parse *pParse, Expr *pExpr){
279944c5604cSdan #ifndef SQLITE_OMIT_SUBQUERY
280044c5604cSdan   if( pExpr->flags & EP_xIsSelect ){
280144c5604cSdan     sqlite3SubselectError(pParse, pExpr->x.pSelect->pEList->nExpr, 1);
280244c5604cSdan   }else
280344c5604cSdan #endif
280444c5604cSdan   {
280544c5604cSdan     sqlite3ErrorMsg(pParse, "row value misused");
280644c5604cSdan   }
280744c5604cSdan }
280844c5604cSdan 
280985bcdce2Sdrh #ifndef SQLITE_OMIT_SUBQUERY
281044c5604cSdan /*
281185bcdce2Sdrh ** Generate code that will construct an ephemeral table containing all terms
281285bcdce2Sdrh ** in the RHS of an IN operator.  The IN operator can be in either of two
281385bcdce2Sdrh ** forms:
2814626a879aSdrh **
28159cbe6352Sdrh **     x IN (4,5,11)              -- IN operator with list on right-hand side
28169cbe6352Sdrh **     x IN (SELECT a FROM b)     -- IN operator with subquery on the right
2817fef5208cSdrh **
28182c04131cSdrh ** The pExpr parameter is the IN operator.  The cursor number for the
28192c04131cSdrh ** constructed ephermeral table is returned.  The first time the ephemeral
28202c04131cSdrh ** table is computed, the cursor number is also stored in pExpr->iTable,
28212c04131cSdrh ** however the cursor number returned might not be the same, as it might
28222c04131cSdrh ** have been duplicated using OP_OpenDup.
282341a05b7bSdanielk1977 **
282485bcdce2Sdrh ** If the LHS expression ("x" in the examples) is a column value, or
282585bcdce2Sdrh ** the SELECT statement returns a column value, then the affinity of that
282685bcdce2Sdrh ** column is used to build the index keys. If both 'x' and the
282785bcdce2Sdrh ** SELECT... statement are columns, then numeric affinity is used
282885bcdce2Sdrh ** if either column has NUMERIC or INTEGER affinity. If neither
282985bcdce2Sdrh ** 'x' nor the SELECT... statement are columns, then numeric affinity
283085bcdce2Sdrh ** is used.
2831cce7d176Sdrh */
283285bcdce2Sdrh void sqlite3CodeRhsOfIN(
2833fd773cf9Sdrh   Parse *pParse,          /* Parsing context */
283485bcdce2Sdrh   Expr *pExpr,            /* The IN operator */
283550ef6716Sdrh   int iTab                /* Use this cursor number */
283641a05b7bSdanielk1977 ){
28372c04131cSdrh   int addrOnce = 0;           /* Address of the OP_Once instruction at top */
283885bcdce2Sdrh   int addr;                   /* Address of OP_OpenEphemeral instruction */
283985bcdce2Sdrh   Expr *pLeft;                /* the LHS of the IN operator */
284085bcdce2Sdrh   KeyInfo *pKeyInfo = 0;      /* Key information */
284185bcdce2Sdrh   int nVal;                   /* Size of vector pLeft */
284285bcdce2Sdrh   Vdbe *v;                    /* The prepared statement under construction */
2843fc976065Sdanielk1977 
28442c04131cSdrh   v = pParse->pVdbe;
284585bcdce2Sdrh   assert( v!=0 );
284685bcdce2Sdrh 
28472c04131cSdrh   /* The evaluation of the IN must be repeated every time it
284839a11819Sdrh   ** is encountered if any of the following is true:
284957dbd7b3Sdrh   **
285057dbd7b3Sdrh   **    *  The right-hand side is a correlated subquery
285157dbd7b3Sdrh   **    *  The right-hand side is an expression list containing variables
285257dbd7b3Sdrh   **    *  We are inside a trigger
285357dbd7b3Sdrh   **
28542c04131cSdrh   ** If all of the above are false, then we can compute the RHS just once
28552c04131cSdrh   ** and reuse it many names.
2856b3bce662Sdanielk1977   */
2857efb699fcSdrh   if( !ExprHasProperty(pExpr, EP_VarSelect) && pParse->iSelfTab==0 ){
28582c04131cSdrh     /* Reuse of the RHS is allowed */
28592c04131cSdrh     /* If this routine has already been coded, but the previous code
28602c04131cSdrh     ** might not have been invoked yet, so invoke it now as a subroutine.
28612c04131cSdrh     */
28622c04131cSdrh     if( ExprHasProperty(pExpr, EP_Subrtn) ){
2863f9231c34Sdrh       addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
2864bd462bccSdrh       if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2865bd462bccSdrh         ExplainQueryPlan((pParse, 0, "REUSE LIST SUBQUERY %d",
2866bd462bccSdrh               pExpr->x.pSelect->selId));
2867bd462bccSdrh       }
28682c04131cSdrh       sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
28692c04131cSdrh                         pExpr->y.sub.iAddr);
28702c04131cSdrh       sqlite3VdbeAddOp2(v, OP_OpenDup, iTab, pExpr->iTable);
2871f9231c34Sdrh       sqlite3VdbeJumpHere(v, addrOnce);
28722c04131cSdrh       return;
28732c04131cSdrh     }
28742c04131cSdrh 
28752c04131cSdrh     /* Begin coding the subroutine */
28762c04131cSdrh     ExprSetProperty(pExpr, EP_Subrtn);
2877088489e8Sdrh     assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
28782c04131cSdrh     pExpr->y.sub.regReturn = ++pParse->nMem;
28792c04131cSdrh     pExpr->y.sub.iAddr =
28802c04131cSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 0, pExpr->y.sub.regReturn) + 1;
28812c04131cSdrh     VdbeComment((v, "return address"));
28822c04131cSdrh 
28832c04131cSdrh     addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
2884b3bce662Sdanielk1977   }
2885b3bce662Sdanielk1977 
288685bcdce2Sdrh   /* Check to see if this is a vector IN operator */
288785bcdce2Sdrh   pLeft = pExpr->pLeft;
288871c57db0Sdan   nVal = sqlite3ExprVectorSize(pLeft);
2889e014a838Sdanielk1977 
289085bcdce2Sdrh   /* Construct the ephemeral table that will contain the content of
289185bcdce2Sdrh   ** RHS of the IN operator.
2892fef5208cSdrh   */
28932c04131cSdrh   pExpr->iTable = iTab;
289450ef6716Sdrh   addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, pExpr->iTable, nVal);
28952c04131cSdrh #ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
28962c04131cSdrh   if( ExprHasProperty(pExpr, EP_xIsSelect) ){
28972c04131cSdrh     VdbeComment((v, "Result of SELECT %u", pExpr->x.pSelect->selId));
28982c04131cSdrh   }else{
28992c04131cSdrh     VdbeComment((v, "RHS of IN operator"));
29002c04131cSdrh   }
29012c04131cSdrh #endif
290250ef6716Sdrh   pKeyInfo = sqlite3KeyInfoAlloc(pParse->db, nVal, 1);
2903e014a838Sdanielk1977 
29046ab3a2ecSdanielk1977   if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2905e014a838Sdanielk1977     /* Case 1:     expr IN (SELECT ...)
2906e014a838Sdanielk1977     **
2907e014a838Sdanielk1977     ** Generate code to write the results of the select into the temporary
2908e014a838Sdanielk1977     ** table allocated and opened above.
2909e014a838Sdanielk1977     */
29104387006cSdrh     Select *pSelect = pExpr->x.pSelect;
291171c57db0Sdan     ExprList *pEList = pSelect->pEList;
29121013c932Sdrh 
29132c04131cSdrh     ExplainQueryPlan((pParse, 1, "%sLIST SUBQUERY %d",
29142c04131cSdrh         addrOnce?"":"CORRELATED ", pSelect->selId
2915e2ca99c9Sdrh     ));
291664bcb8cfSdrh     /* If the LHS and RHS of the IN operator do not match, that
291764bcb8cfSdrh     ** error will have been caught long before we reach this point. */
291864bcb8cfSdrh     if( ALWAYS(pEList->nExpr==nVal) ){
291971c57db0Sdan       SelectDest dest;
292071c57db0Sdan       int i;
2921bd462bccSdrh       sqlite3SelectDestInit(&dest, SRT_Set, iTab);
292271c57db0Sdan       dest.zAffSdst = exprINAffinity(pParse, pExpr);
29234387006cSdrh       pSelect->iLimit = 0;
29244387006cSdrh       testcase( pSelect->selFlags & SF_Distinct );
2925812ea833Sdrh       testcase( pKeyInfo==0 ); /* Caused by OOM in sqlite3KeyInfoAlloc() */
29264387006cSdrh       if( sqlite3Select(pParse, pSelect, &dest) ){
292771c57db0Sdan         sqlite3DbFree(pParse->db, dest.zAffSdst);
29282ec2fb22Sdrh         sqlite3KeyInfoUnref(pKeyInfo);
292985bcdce2Sdrh         return;
293094ccde58Sdrh       }
293171c57db0Sdan       sqlite3DbFree(pParse->db, dest.zAffSdst);
2932812ea833Sdrh       assert( pKeyInfo!=0 ); /* OOM will cause exit after sqlite3Select() */
29333535ec3eSdrh       assert( pEList!=0 );
29343535ec3eSdrh       assert( pEList->nExpr>0 );
29352ec2fb22Sdrh       assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
293671c57db0Sdan       for(i=0; i<nVal; i++){
2937773d3afaSdan         Expr *p = sqlite3VectorFieldSubexpr(pLeft, i);
293871c57db0Sdan         pKeyInfo->aColl[i] = sqlite3BinaryCompareCollSeq(
293971c57db0Sdan             pParse, p, pEList->a[i].pExpr
294071c57db0Sdan         );
294171c57db0Sdan       }
294271c57db0Sdan     }
2943a7d2db17Sdrh   }else if( ALWAYS(pExpr->x.pList!=0) ){
2944fef5208cSdrh     /* Case 2:     expr IN (exprlist)
2945fef5208cSdrh     **
2946e014a838Sdanielk1977     ** For each expression, build an index key from the evaluation and
2947e014a838Sdanielk1977     ** store it in the temporary table. If <expr> is a column, then use
2948e014a838Sdanielk1977     ** that columns affinity when building index keys. If <expr> is not
2949e014a838Sdanielk1977     ** a column, use numeric affinity.
2950fef5208cSdrh     */
295171c57db0Sdan     char affinity;            /* Affinity of the LHS of the IN */
2952e014a838Sdanielk1977     int i;
29536ab3a2ecSdanielk1977     ExprList *pList = pExpr->x.pList;
295457dbd7b3Sdrh     struct ExprList_item *pItem;
2955c324d446Sdan     int r1, r2;
295671c57db0Sdan     affinity = sqlite3ExprAffinity(pLeft);
295796fb16eeSdrh     if( affinity<=SQLITE_AFF_NONE ){
295805883a34Sdrh       affinity = SQLITE_AFF_BLOB;
295995b39590Sdrh     }else if( affinity==SQLITE_AFF_REAL ){
296095b39590Sdrh       affinity = SQLITE_AFF_NUMERIC;
2961e014a838Sdanielk1977     }
2962323df790Sdrh     if( pKeyInfo ){
29632ec2fb22Sdrh       assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
2964323df790Sdrh       pKeyInfo->aColl[0] = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
2965323df790Sdrh     }
2966e014a838Sdanielk1977 
2967e014a838Sdanielk1977     /* Loop through each expression in <exprlist>. */
29682d401ab8Sdrh     r1 = sqlite3GetTempReg(pParse);
29692d401ab8Sdrh     r2 = sqlite3GetTempReg(pParse);
297057dbd7b3Sdrh     for(i=pList->nExpr, pItem=pList->a; i>0; i--, pItem++){
297157dbd7b3Sdrh       Expr *pE2 = pItem->pExpr;
2972e014a838Sdanielk1977 
297357dbd7b3Sdrh       /* If the expression is not constant then we will need to
297457dbd7b3Sdrh       ** disable the test that was generated above that makes sure
297557dbd7b3Sdrh       ** this code only executes once.  Because for a non-constant
297657dbd7b3Sdrh       ** expression we need to rerun this code each time.
297757dbd7b3Sdrh       */
29782c04131cSdrh       if( addrOnce && !sqlite3ExprIsConstant(pE2) ){
29792c04131cSdrh         sqlite3VdbeChangeToNoop(v, addrOnce);
29807ac0e562Sdan         ExprClearProperty(pExpr, EP_Subrtn);
29812c04131cSdrh         addrOnce = 0;
29824794b980Sdrh       }
2983e014a838Sdanielk1977 
2984e014a838Sdanielk1977       /* Evaluate the expression and insert it into the temp table */
2985c324d446Sdan       sqlite3ExprCode(pParse, pE2, r1);
2986c324d446Sdan       sqlite3VdbeAddOp4(v, OP_MakeRecord, r1, 1, r2, &affinity, 1);
2987c324d446Sdan       sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iTab, r2, r1, 1);
2988fef5208cSdrh     }
29892d401ab8Sdrh     sqlite3ReleaseTempReg(pParse, r1);
29902d401ab8Sdrh     sqlite3ReleaseTempReg(pParse, r2);
2991fef5208cSdrh   }
2992323df790Sdrh   if( pKeyInfo ){
29932ec2fb22Sdrh     sqlite3VdbeChangeP4(v, addr, (void *)pKeyInfo, P4_KEYINFO);
299441a05b7bSdanielk1977   }
29952c04131cSdrh   if( addrOnce ){
29962c04131cSdrh     sqlite3VdbeJumpHere(v, addrOnce);
29972c04131cSdrh     /* Subroutine return */
29982c04131cSdrh     sqlite3VdbeAddOp1(v, OP_Return, pExpr->y.sub.regReturn);
29992c04131cSdrh     sqlite3VdbeChangeP1(v, pExpr->y.sub.iAddr-1, sqlite3VdbeCurrentAddr(v)-1);
30006d2566dfSdrh     sqlite3ClearTempRegCache(pParse);
300185bcdce2Sdrh   }
300285bcdce2Sdrh }
300385bcdce2Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
300485bcdce2Sdrh 
300585bcdce2Sdrh /*
300685bcdce2Sdrh ** Generate code for scalar subqueries used as a subquery expression
300785bcdce2Sdrh ** or EXISTS operator:
300885bcdce2Sdrh **
300985bcdce2Sdrh **     (SELECT a FROM b)          -- subquery
301085bcdce2Sdrh **     EXISTS (SELECT a FROM b)   -- EXISTS subquery
301185bcdce2Sdrh **
301285bcdce2Sdrh ** The pExpr parameter is the SELECT or EXISTS operator to be coded.
301385bcdce2Sdrh **
3014d86fe44aSdrh ** Return the register that holds the result.  For a multi-column SELECT,
301585bcdce2Sdrh ** the result is stored in a contiguous array of registers and the
301685bcdce2Sdrh ** return value is the register of the left-most result column.
301785bcdce2Sdrh ** Return 0 if an error occurs.
301885bcdce2Sdrh */
301985bcdce2Sdrh #ifndef SQLITE_OMIT_SUBQUERY
302085bcdce2Sdrh int sqlite3CodeSubselect(Parse *pParse, Expr *pExpr){
30212c04131cSdrh   int addrOnce = 0;           /* Address of OP_Once at top of subroutine */
302285bcdce2Sdrh   int rReg = 0;               /* Register storing resulting */
302385bcdce2Sdrh   Select *pSel;               /* SELECT statement to encode */
302485bcdce2Sdrh   SelectDest dest;            /* How to deal with SELECT result */
302585bcdce2Sdrh   int nReg;                   /* Registers to allocate */
302685bcdce2Sdrh   Expr *pLimit;               /* New limit expression */
30272c04131cSdrh 
30282c04131cSdrh   Vdbe *v = pParse->pVdbe;
302985bcdce2Sdrh   assert( v!=0 );
3030bd462bccSdrh   testcase( pExpr->op==TK_EXISTS );
3031bd462bccSdrh   testcase( pExpr->op==TK_SELECT );
3032bd462bccSdrh   assert( pExpr->op==TK_EXISTS || pExpr->op==TK_SELECT );
3033bd462bccSdrh   assert( ExprHasProperty(pExpr, EP_xIsSelect) );
3034bd462bccSdrh   pSel = pExpr->x.pSelect;
303585bcdce2Sdrh 
30365198ff57Sdrh   /* The evaluation of the EXISTS/SELECT must be repeated every time it
303785bcdce2Sdrh   ** is encountered if any of the following is true:
303885bcdce2Sdrh   **
303985bcdce2Sdrh   **    *  The right-hand side is a correlated subquery
304085bcdce2Sdrh   **    *  The right-hand side is an expression list containing variables
304185bcdce2Sdrh   **    *  We are inside a trigger
304285bcdce2Sdrh   **
304385bcdce2Sdrh   ** If all of the above are false, then we can run this code just once
304485bcdce2Sdrh   ** save the results, and reuse the same result on subsequent invocations.
304585bcdce2Sdrh   */
304685bcdce2Sdrh   if( !ExprHasProperty(pExpr, EP_VarSelect) ){
30475198ff57Sdrh     /* If this routine has already been coded, then invoke it as a
30485198ff57Sdrh     ** subroutine. */
30495198ff57Sdrh     if( ExprHasProperty(pExpr, EP_Subrtn) ){
3050bd462bccSdrh       ExplainQueryPlan((pParse, 0, "REUSE SUBQUERY %d", pSel->selId));
30515198ff57Sdrh       sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
30525198ff57Sdrh                         pExpr->y.sub.iAddr);
30535198ff57Sdrh       return pExpr->iTable;
30545198ff57Sdrh     }
30555198ff57Sdrh 
30565198ff57Sdrh     /* Begin coding the subroutine */
30575198ff57Sdrh     ExprSetProperty(pExpr, EP_Subrtn);
30585198ff57Sdrh     pExpr->y.sub.regReturn = ++pParse->nMem;
30595198ff57Sdrh     pExpr->y.sub.iAddr =
30605198ff57Sdrh       sqlite3VdbeAddOp2(v, OP_Integer, 0, pExpr->y.sub.regReturn) + 1;
30615198ff57Sdrh     VdbeComment((v, "return address"));
30625198ff57Sdrh 
30632c04131cSdrh     addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
3064fef5208cSdrh   }
3065fef5208cSdrh 
306685bcdce2Sdrh   /* For a SELECT, generate code to put the values for all columns of
306739a11819Sdrh   ** the first row into an array of registers and return the index of
306839a11819Sdrh   ** the first register.
306939a11819Sdrh   **
307039a11819Sdrh   ** If this is an EXISTS, write an integer 0 (not exists) or 1 (exists)
307139a11819Sdrh   ** into a register and return that register number.
307239a11819Sdrh   **
307339a11819Sdrh   ** In both cases, the query is augmented with "LIMIT 1".  Any
307439a11819Sdrh   ** preexisting limit is discarded in place of the new LIMIT 1.
3075fef5208cSdrh   */
3076bd462bccSdrh   ExplainQueryPlan((pParse, 1, "%sSCALAR SUBQUERY %d",
3077bd462bccSdrh         addrOnce?"":"CORRELATED ", pSel->selId));
307871c57db0Sdan   nReg = pExpr->op==TK_SELECT ? pSel->pEList->nExpr : 1;
307971c57db0Sdan   sqlite3SelectDestInit(&dest, 0, pParse->nMem+1);
308071c57db0Sdan   pParse->nMem += nReg;
308151522cd3Sdrh   if( pExpr->op==TK_SELECT ){
30826c8c8ce0Sdanielk1977     dest.eDest = SRT_Mem;
308353932ce8Sdrh     dest.iSdst = dest.iSDParm;
308471c57db0Sdan     dest.nSdst = nReg;
308571c57db0Sdan     sqlite3VdbeAddOp3(v, OP_Null, 0, dest.iSDParm, dest.iSDParm+nReg-1);
3086d4e70ebdSdrh     VdbeComment((v, "Init subquery result"));
308751522cd3Sdrh   }else{
30886c8c8ce0Sdanielk1977     dest.eDest = SRT_Exists;
30892b596da8Sdrh     sqlite3VdbeAddOp2(v, OP_Integer, 0, dest.iSDParm);
3090d4e70ebdSdrh     VdbeComment((v, "Init EXISTS result"));
309151522cd3Sdrh   }
30928c0833fbSdrh   if( pSel->pLimit ){
30937ca1347fSdrh     /* The subquery already has a limit.  If the pre-existing limit is X
30947ca1347fSdrh     ** then make the new limit X<>0 so that the new limit is either 1 or 0 */
30957ca1347fSdrh     sqlite3 *db = pParse->db;
30965776ee5cSdrh     pLimit = sqlite3Expr(db, TK_INTEGER, "0");
30977ca1347fSdrh     if( pLimit ){
30987ca1347fSdrh       pLimit->affExpr = SQLITE_AFF_NUMERIC;
30997ca1347fSdrh       pLimit = sqlite3PExpr(pParse, TK_NE,
31007ca1347fSdrh                             sqlite3ExprDup(db, pSel->pLimit->pLeft, 0), pLimit);
31017ca1347fSdrh     }
31027ca1347fSdrh     sqlite3ExprDelete(db, pSel->pLimit->pLeft);
31038c0833fbSdrh     pSel->pLimit->pLeft = pLimit;
31048c0833fbSdrh   }else{
31057ca1347fSdrh     /* If there is no pre-existing limit add a limit of 1 */
31065776ee5cSdrh     pLimit = sqlite3Expr(pParse->db, TK_INTEGER, "1");
31078c0833fbSdrh     pSel->pLimit = sqlite3PExpr(pParse, TK_LIMIT, pLimit, 0);
31088c0833fbSdrh   }
310948b5b041Sdrh   pSel->iLimit = 0;
31107d10d5a6Sdrh   if( sqlite3Select(pParse, pSel, &dest) ){
31111450bc6eSdrh     return 0;
311294ccde58Sdrh   }
31132c04131cSdrh   pExpr->iTable = rReg = dest.iSDParm;
3114ebb6a65dSdrh   ExprSetVVAProperty(pExpr, EP_NoReduce);
31152c04131cSdrh   if( addrOnce ){
31162c04131cSdrh     sqlite3VdbeJumpHere(v, addrOnce);
3117fc976065Sdanielk1977 
31182c04131cSdrh     /* Subroutine return */
31192c04131cSdrh     sqlite3VdbeAddOp1(v, OP_Return, pExpr->y.sub.regReturn);
31202c04131cSdrh     sqlite3VdbeChangeP1(v, pExpr->y.sub.iAddr-1, sqlite3VdbeCurrentAddr(v)-1);
31216d2566dfSdrh     sqlite3ClearTempRegCache(pParse);
31225198ff57Sdrh   }
31232c04131cSdrh 
31241450bc6eSdrh   return rReg;
3125cce7d176Sdrh }
312651522cd3Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
3127cce7d176Sdrh 
3128e3365e6cSdrh #ifndef SQLITE_OMIT_SUBQUERY
3129e3365e6cSdrh /*
31307b35a77bSdan ** Expr pIn is an IN(...) expression. This function checks that the
31317b35a77bSdan ** sub-select on the RHS of the IN() operator has the same number of
31327b35a77bSdan ** columns as the vector on the LHS. Or, if the RHS of the IN() is not
31337b35a77bSdan ** a sub-query, that the LHS is a vector of size 1.
31347b35a77bSdan */
31357b35a77bSdan int sqlite3ExprCheckIN(Parse *pParse, Expr *pIn){
31367b35a77bSdan   int nVector = sqlite3ExprVectorSize(pIn->pLeft);
31377b35a77bSdan   if( (pIn->flags & EP_xIsSelect) ){
31387b35a77bSdan     if( nVector!=pIn->x.pSelect->pEList->nExpr ){
31397b35a77bSdan       sqlite3SubselectError(pParse, pIn->x.pSelect->pEList->nExpr, nVector);
31407b35a77bSdan       return 1;
31417b35a77bSdan     }
31427b35a77bSdan   }else if( nVector!=1 ){
314344c5604cSdan     sqlite3VectorErrorMsg(pParse, pIn->pLeft);
31447b35a77bSdan     return 1;
31457b35a77bSdan   }
31467b35a77bSdan   return 0;
31477b35a77bSdan }
31487b35a77bSdan #endif
31497b35a77bSdan 
31507b35a77bSdan #ifndef SQLITE_OMIT_SUBQUERY
31517b35a77bSdan /*
3152e3365e6cSdrh ** Generate code for an IN expression.
3153e3365e6cSdrh **
3154e3365e6cSdrh **      x IN (SELECT ...)
3155e3365e6cSdrh **      x IN (value, value, ...)
3156e3365e6cSdrh **
3157ecb87ac8Sdrh ** The left-hand side (LHS) is a scalar or vector expression.  The
3158e347d3e8Sdrh ** right-hand side (RHS) is an array of zero or more scalar values, or a
3159e347d3e8Sdrh ** subquery.  If the RHS is a subquery, the number of result columns must
3160e347d3e8Sdrh ** match the number of columns in the vector on the LHS.  If the RHS is
3161e347d3e8Sdrh ** a list of values, the LHS must be a scalar.
3162e347d3e8Sdrh **
3163e347d3e8Sdrh ** The IN operator is true if the LHS value is contained within the RHS.
3164e347d3e8Sdrh ** The result is false if the LHS is definitely not in the RHS.  The
3165e347d3e8Sdrh ** result is NULL if the presence of the LHS in the RHS cannot be
3166e347d3e8Sdrh ** determined due to NULLs.
3167e3365e6cSdrh **
31686be515ebSdrh ** This routine generates code that jumps to destIfFalse if the LHS is not
3169e3365e6cSdrh ** contained within the RHS.  If due to NULLs we cannot determine if the LHS
3170e3365e6cSdrh ** is contained in the RHS then jump to destIfNull.  If the LHS is contained
3171e3365e6cSdrh ** within the RHS then fall through.
3172ecb87ac8Sdrh **
3173ecb87ac8Sdrh ** See the separate in-operator.md documentation file in the canonical
3174ecb87ac8Sdrh ** SQLite source tree for additional information.
3175e3365e6cSdrh */
3176e3365e6cSdrh static void sqlite3ExprCodeIN(
3177e3365e6cSdrh   Parse *pParse,        /* Parsing and code generating context */
3178e3365e6cSdrh   Expr *pExpr,          /* The IN expression */
3179e3365e6cSdrh   int destIfFalse,      /* Jump here if LHS is not contained in the RHS */
3180e3365e6cSdrh   int destIfNull        /* Jump here if the results are unknown due to NULLs */
3181e3365e6cSdrh ){
3182e3365e6cSdrh   int rRhsHasNull = 0;  /* Register that is true if RHS contains NULL values */
3183e3365e6cSdrh   int eType;            /* Type of the RHS */
3184e347d3e8Sdrh   int rLhs;             /* Register(s) holding the LHS values */
3185e347d3e8Sdrh   int rLhsOrig;         /* LHS values prior to reordering by aiMap[] */
3186e3365e6cSdrh   Vdbe *v;              /* Statement under construction */
3187ba00e30aSdan   int *aiMap = 0;       /* Map from vector field to index column */
3188ba00e30aSdan   char *zAff = 0;       /* Affinity string for comparisons */
3189ecb87ac8Sdrh   int nVector;          /* Size of vectors for this IN operator */
319012abf408Sdrh   int iDummy;           /* Dummy parameter to exprCodeVector() */
3191e347d3e8Sdrh   Expr *pLeft;          /* The LHS of the IN operator */
3192ecb87ac8Sdrh   int i;                /* loop counter */
3193e347d3e8Sdrh   int destStep2;        /* Where to jump when NULLs seen in step 2 */
3194e347d3e8Sdrh   int destStep6 = 0;    /* Start of code for Step 6 */
3195e347d3e8Sdrh   int addrTruthOp;      /* Address of opcode that determines the IN is true */
3196e347d3e8Sdrh   int destNotNull;      /* Jump here if a comparison is not true in step 6 */
3197e347d3e8Sdrh   int addrTop;          /* Top of the step-6 loop */
31982c04131cSdrh   int iTab = 0;         /* Index to use */
3199c59b4acfSdan   u8 okConstFactor = pParse->okConstFactor;
3200e3365e6cSdrh 
3201e7375bfaSdrh   assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
3202e347d3e8Sdrh   pLeft = pExpr->pLeft;
32037b35a77bSdan   if( sqlite3ExprCheckIN(pParse, pExpr) ) return;
3204553168c7Sdan   zAff = exprINAffinity(pParse, pExpr);
3205ba00e30aSdan   nVector = sqlite3ExprVectorSize(pExpr->pLeft);
3206ba00e30aSdan   aiMap = (int*)sqlite3DbMallocZero(
3207ba00e30aSdan       pParse->db, nVector*(sizeof(int) + sizeof(char)) + 1
3208ba00e30aSdan   );
3209e347d3e8Sdrh   if( pParse->db->mallocFailed ) goto sqlite3ExprCodeIN_oom_error;
32107b35a77bSdan 
3211ba00e30aSdan   /* Attempt to compute the RHS. After this step, if anything other than
32122c04131cSdrh   ** IN_INDEX_NOOP is returned, the table opened with cursor iTab
3213ba00e30aSdan   ** contains the values that make up the RHS. If IN_INDEX_NOOP is returned,
3214ba00e30aSdan   ** the RHS has not yet been coded.  */
3215e3365e6cSdrh   v = pParse->pVdbe;
3216e3365e6cSdrh   assert( v!=0 );       /* OOM detected prior to this routine */
3217e3365e6cSdrh   VdbeNoopComment((v, "begin IN expr"));
3218bb53ecb1Sdrh   eType = sqlite3FindInIndex(pParse, pExpr,
3219bb53ecb1Sdrh                              IN_INDEX_MEMBERSHIP | IN_INDEX_NOOP_OK,
32202c04131cSdrh                              destIfFalse==destIfNull ? 0 : &rRhsHasNull,
32212c04131cSdrh                              aiMap, &iTab);
3222e3365e6cSdrh 
3223ba00e30aSdan   assert( pParse->nErr || nVector==1 || eType==IN_INDEX_EPH
3224ba00e30aSdan        || eType==IN_INDEX_INDEX_ASC || eType==IN_INDEX_INDEX_DESC
3225ba00e30aSdan   );
3226ecb87ac8Sdrh #ifdef SQLITE_DEBUG
3227ecb87ac8Sdrh   /* Confirm that aiMap[] contains nVector integer values between 0 and
3228ecb87ac8Sdrh   ** nVector-1. */
3229ecb87ac8Sdrh   for(i=0; i<nVector; i++){
3230ecb87ac8Sdrh     int j, cnt;
3231ecb87ac8Sdrh     for(cnt=j=0; j<nVector; j++) if( aiMap[j]==i ) cnt++;
3232ecb87ac8Sdrh     assert( cnt==1 );
3233ecb87ac8Sdrh   }
3234ecb87ac8Sdrh #endif
3235e3365e6cSdrh 
3236ba00e30aSdan   /* Code the LHS, the <expr> from "<expr> IN (...)". If the LHS is a
3237ba00e30aSdan   ** vector, then it is stored in an array of nVector registers starting
3238ba00e30aSdan   ** at r1.
3239e347d3e8Sdrh   **
3240e347d3e8Sdrh   ** sqlite3FindInIndex() might have reordered the fields of the LHS vector
3241e347d3e8Sdrh   ** so that the fields are in the same order as an existing index.   The
3242e347d3e8Sdrh   ** aiMap[] array contains a mapping from the original LHS field order to
3243e347d3e8Sdrh   ** the field order that matches the RHS index.
3244c59b4acfSdan   **
3245c59b4acfSdan   ** Avoid factoring the LHS of the IN(...) expression out of the loop,
3246c59b4acfSdan   ** even if it is constant, as OP_Affinity may be used on the register
3247c59b4acfSdan   ** by code generated below.  */
3248c59b4acfSdan   assert( pParse->okConstFactor==okConstFactor );
3249c59b4acfSdan   pParse->okConstFactor = 0;
3250e347d3e8Sdrh   rLhsOrig = exprCodeVector(pParse, pLeft, &iDummy);
3251c59b4acfSdan   pParse->okConstFactor = okConstFactor;
3252e347d3e8Sdrh   for(i=0; i<nVector && aiMap[i]==i; i++){} /* Are LHS fields reordered? */
3253ecb87ac8Sdrh   if( i==nVector ){
3254e347d3e8Sdrh     /* LHS fields are not reordered */
3255e347d3e8Sdrh     rLhs = rLhsOrig;
3256ecb87ac8Sdrh   }else{
3257ecb87ac8Sdrh     /* Need to reorder the LHS fields according to aiMap */
3258e347d3e8Sdrh     rLhs = sqlite3GetTempRange(pParse, nVector);
3259ba00e30aSdan     for(i=0; i<nVector; i++){
3260e347d3e8Sdrh       sqlite3VdbeAddOp3(v, OP_Copy, rLhsOrig+i, rLhs+aiMap[i], 0);
3261ba00e30aSdan     }
3262ecb87ac8Sdrh   }
3263e3365e6cSdrh 
3264bb53ecb1Sdrh   /* If sqlite3FindInIndex() did not find or create an index that is
3265bb53ecb1Sdrh   ** suitable for evaluating the IN operator, then evaluate using a
3266bb53ecb1Sdrh   ** sequence of comparisons.
3267e347d3e8Sdrh   **
3268e347d3e8Sdrh   ** This is step (1) in the in-operator.md optimized algorithm.
3269bb53ecb1Sdrh   */
3270bb53ecb1Sdrh   if( eType==IN_INDEX_NOOP ){
3271bb53ecb1Sdrh     ExprList *pList = pExpr->x.pList;
3272bb53ecb1Sdrh     CollSeq *pColl = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
3273ec4ccdbcSdrh     int labelOk = sqlite3VdbeMakeLabel(pParse);
3274bb53ecb1Sdrh     int r2, regToFree;
3275bb53ecb1Sdrh     int regCkNull = 0;
3276bb53ecb1Sdrh     int ii;
3277bb53ecb1Sdrh     assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
3278bb53ecb1Sdrh     if( destIfNull!=destIfFalse ){
3279bb53ecb1Sdrh       regCkNull = sqlite3GetTempReg(pParse);
3280e347d3e8Sdrh       sqlite3VdbeAddOp3(v, OP_BitAnd, rLhs, rLhs, regCkNull);
3281bb53ecb1Sdrh     }
3282bb53ecb1Sdrh     for(ii=0; ii<pList->nExpr; ii++){
32834fc83654Sdrh       r2 = sqlite3ExprCodeTemp(pParse, pList->a[ii].pExpr, &regToFree);
3284a976979bSdrh       if( regCkNull && sqlite3ExprCanBeNull(pList->a[ii].pExpr) ){
3285bb53ecb1Sdrh         sqlite3VdbeAddOp3(v, OP_BitAnd, regCkNull, r2, regCkNull);
3286bb53ecb1Sdrh       }
3287f6ea97eaSdrh       sqlite3ReleaseTempReg(pParse, regToFree);
3288bb53ecb1Sdrh       if( ii<pList->nExpr-1 || destIfNull!=destIfFalse ){
32894799488eSdrh         int op = rLhs!=r2 ? OP_Eq : OP_NotNull;
32904799488eSdrh         sqlite3VdbeAddOp4(v, op, rLhs, labelOk, r2,
32914336b0e6Sdrh                           (void*)pColl, P4_COLLSEQ);
32924799488eSdrh         VdbeCoverageIf(v, ii<pList->nExpr-1 && op==OP_Eq);
32934799488eSdrh         VdbeCoverageIf(v, ii==pList->nExpr-1 && op==OP_Eq);
32944799488eSdrh         VdbeCoverageIf(v, ii<pList->nExpr-1 && op==OP_NotNull);
32954799488eSdrh         VdbeCoverageIf(v, ii==pList->nExpr-1 && op==OP_NotNull);
3296ba00e30aSdan         sqlite3VdbeChangeP5(v, zAff[0]);
3297bb53ecb1Sdrh       }else{
32984799488eSdrh         int op = rLhs!=r2 ? OP_Ne : OP_IsNull;
3299bb53ecb1Sdrh         assert( destIfNull==destIfFalse );
33004799488eSdrh         sqlite3VdbeAddOp4(v, op, rLhs, destIfFalse, r2,
33014799488eSdrh                           (void*)pColl, P4_COLLSEQ);
33024799488eSdrh         VdbeCoverageIf(v, op==OP_Ne);
33034799488eSdrh         VdbeCoverageIf(v, op==OP_IsNull);
3304ba00e30aSdan         sqlite3VdbeChangeP5(v, zAff[0] | SQLITE_JUMPIFNULL);
3305bb53ecb1Sdrh       }
3306bb53ecb1Sdrh     }
3307bb53ecb1Sdrh     if( regCkNull ){
3308bb53ecb1Sdrh       sqlite3VdbeAddOp2(v, OP_IsNull, regCkNull, destIfNull); VdbeCoverage(v);
3309076e85f5Sdrh       sqlite3VdbeGoto(v, destIfFalse);
3310bb53ecb1Sdrh     }
3311bb53ecb1Sdrh     sqlite3VdbeResolveLabel(v, labelOk);
3312bb53ecb1Sdrh     sqlite3ReleaseTempReg(pParse, regCkNull);
3313e347d3e8Sdrh     goto sqlite3ExprCodeIN_finished;
3314e347d3e8Sdrh   }
3315bb53ecb1Sdrh 
3316e347d3e8Sdrh   /* Step 2: Check to see if the LHS contains any NULL columns.  If the
3317e347d3e8Sdrh   ** LHS does contain NULLs then the result must be either FALSE or NULL.
3318e347d3e8Sdrh   ** We will then skip the binary search of the RHS.
3319e347d3e8Sdrh   */
3320094430ebSdrh   if( destIfNull==destIfFalse ){
3321e347d3e8Sdrh     destStep2 = destIfFalse;
3322e347d3e8Sdrh   }else{
3323ec4ccdbcSdrh     destStep2 = destStep6 = sqlite3VdbeMakeLabel(pParse);
3324e347d3e8Sdrh   }
33254eac5f04Sdrh   if( pParse->nErr ) goto sqlite3ExprCodeIN_finished;
3326d49fd4e8Sdan   for(i=0; i<nVector; i++){
3327fc7f27b9Sdrh     Expr *p = sqlite3VectorFieldSubexpr(pExpr->pLeft, i);
3328d49fd4e8Sdan     if( sqlite3ExprCanBeNull(p) ){
3329e347d3e8Sdrh       sqlite3VdbeAddOp2(v, OP_IsNull, rLhs+i, destStep2);
3330471b4b92Sdrh       VdbeCoverage(v);
3331d49fd4e8Sdan     }
3332d49fd4e8Sdan   }
3333e3365e6cSdrh 
3334e347d3e8Sdrh   /* Step 3.  The LHS is now known to be non-NULL.  Do the binary search
3335e347d3e8Sdrh   ** of the RHS using the LHS as a probe.  If found, the result is
3336e347d3e8Sdrh   ** true.
3337e347d3e8Sdrh   */
3338e3365e6cSdrh   if( eType==IN_INDEX_ROWID ){
3339e347d3e8Sdrh     /* In this case, the RHS is the ROWID of table b-tree and so we also
3340e347d3e8Sdrh     ** know that the RHS is non-NULL.  Hence, we combine steps 3 and 4
3341e347d3e8Sdrh     ** into a single opcode. */
33422c04131cSdrh     sqlite3VdbeAddOp3(v, OP_SeekRowid, iTab, destIfFalse, rLhs);
3343688852abSdrh     VdbeCoverage(v);
3344e347d3e8Sdrh     addrTruthOp = sqlite3VdbeAddOp0(v, OP_Goto);  /* Return True */
33457b35a77bSdan   }else{
3346e347d3e8Sdrh     sqlite3VdbeAddOp4(v, OP_Affinity, rLhs, nVector, 0, zAff, nVector);
3347e347d3e8Sdrh     if( destIfFalse==destIfNull ){
3348e347d3e8Sdrh       /* Combine Step 3 and Step 5 into a single opcode */
33492c04131cSdrh       sqlite3VdbeAddOp4Int(v, OP_NotFound, iTab, destIfFalse,
3350e347d3e8Sdrh                            rLhs, nVector); VdbeCoverage(v);
3351e347d3e8Sdrh       goto sqlite3ExprCodeIN_finished;
3352e347d3e8Sdrh     }
3353e347d3e8Sdrh     /* Ordinary Step 3, for the case where FALSE and NULL are distinct */
33542c04131cSdrh     addrTruthOp = sqlite3VdbeAddOp4Int(v, OP_Found, iTab, 0,
3355e347d3e8Sdrh                                       rLhs, nVector); VdbeCoverage(v);
3356e347d3e8Sdrh   }
3357ba00e30aSdan 
3358e347d3e8Sdrh   /* Step 4.  If the RHS is known to be non-NULL and we did not find
3359e347d3e8Sdrh   ** an match on the search above, then the result must be FALSE.
3360e347d3e8Sdrh   */
3361e347d3e8Sdrh   if( rRhsHasNull && nVector==1 ){
3362e347d3e8Sdrh     sqlite3VdbeAddOp2(v, OP_NotNull, rRhsHasNull, destIfFalse);
3363471b4b92Sdrh     VdbeCoverage(v);
3364e347d3e8Sdrh   }
33657b35a77bSdan 
3366e347d3e8Sdrh   /* Step 5.  If we do not care about the difference between NULL and
3367e347d3e8Sdrh   ** FALSE, then just return false.
3368e347d3e8Sdrh   */
3369e347d3e8Sdrh   if( destIfFalse==destIfNull ) sqlite3VdbeGoto(v, destIfFalse);
3370e347d3e8Sdrh 
3371e347d3e8Sdrh   /* Step 6: Loop through rows of the RHS.  Compare each row to the LHS.
3372e347d3e8Sdrh   ** If any comparison is NULL, then the result is NULL.  If all
3373e347d3e8Sdrh   ** comparisons are FALSE then the final result is FALSE.
3374e347d3e8Sdrh   **
3375e347d3e8Sdrh   ** For a scalar LHS, it is sufficient to check just the first row
3376e347d3e8Sdrh   ** of the RHS.
3377e347d3e8Sdrh   */
3378e347d3e8Sdrh   if( destStep6 ) sqlite3VdbeResolveLabel(v, destStep6);
33792c04131cSdrh   addrTop = sqlite3VdbeAddOp2(v, OP_Rewind, iTab, destIfFalse);
3380471b4b92Sdrh   VdbeCoverage(v);
3381e347d3e8Sdrh   if( nVector>1 ){
3382ec4ccdbcSdrh     destNotNull = sqlite3VdbeMakeLabel(pParse);
3383e347d3e8Sdrh   }else{
3384e347d3e8Sdrh     /* For nVector==1, combine steps 6 and 7 by immediately returning
3385e347d3e8Sdrh     ** FALSE if the first comparison is not NULL */
3386e347d3e8Sdrh     destNotNull = destIfFalse;
3387e347d3e8Sdrh   }
3388ba00e30aSdan   for(i=0; i<nVector; i++){
3389ba00e30aSdan     Expr *p;
3390ba00e30aSdan     CollSeq *pColl;
3391e347d3e8Sdrh     int r3 = sqlite3GetTempReg(pParse);
3392fc7f27b9Sdrh     p = sqlite3VectorFieldSubexpr(pLeft, i);
3393ba00e30aSdan     pColl = sqlite3ExprCollSeq(pParse, p);
33942c04131cSdrh     sqlite3VdbeAddOp3(v, OP_Column, iTab, i, r3);
3395e347d3e8Sdrh     sqlite3VdbeAddOp4(v, OP_Ne, rLhs+i, destNotNull, r3,
339618016ad2Sdrh                       (void*)pColl, P4_COLLSEQ);
3397471b4b92Sdrh     VdbeCoverage(v);
3398e347d3e8Sdrh     sqlite3ReleaseTempReg(pParse, r3);
33997b35a77bSdan   }
34007b35a77bSdan   sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfNull);
3401e347d3e8Sdrh   if( nVector>1 ){
3402e347d3e8Sdrh     sqlite3VdbeResolveLabel(v, destNotNull);
34032c04131cSdrh     sqlite3VdbeAddOp2(v, OP_Next, iTab, addrTop+1);
340418016ad2Sdrh     VdbeCoverage(v);
3405e347d3e8Sdrh 
3406e347d3e8Sdrh     /* Step 7:  If we reach this point, we know that the result must
3407e347d3e8Sdrh     ** be false. */
340818016ad2Sdrh     sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfFalse);
34097b35a77bSdan   }
34107b35a77bSdan 
3411e347d3e8Sdrh   /* Jumps here in order to return true. */
3412e347d3e8Sdrh   sqlite3VdbeJumpHere(v, addrTruthOp);
3413e3365e6cSdrh 
3414e347d3e8Sdrh sqlite3ExprCodeIN_finished:
3415e347d3e8Sdrh   if( rLhs!=rLhsOrig ) sqlite3ReleaseTempReg(pParse, rLhs);
3416ecb87ac8Sdrh   VdbeComment((v, "end IN expr"));
3417e347d3e8Sdrh sqlite3ExprCodeIN_oom_error:
3418ba00e30aSdan   sqlite3DbFree(pParse->db, aiMap);
3419553168c7Sdan   sqlite3DbFree(pParse->db, zAff);
3420e3365e6cSdrh }
3421e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
3422e3365e6cSdrh 
342313573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
3424598f1340Sdrh /*
3425598f1340Sdrh ** Generate an instruction that will put the floating point
34269cbf3425Sdrh ** value described by z[0..n-1] into register iMem.
34270cf19ed8Sdrh **
34280cf19ed8Sdrh ** The z[] string will probably not be zero-terminated.  But the
34290cf19ed8Sdrh ** z[n] character is guaranteed to be something that does not look
34300cf19ed8Sdrh ** like the continuation of the number.
3431598f1340Sdrh */
3432b7916a78Sdrh static void codeReal(Vdbe *v, const char *z, int negateFlag, int iMem){
3433fd773cf9Sdrh   if( ALWAYS(z!=0) ){
3434598f1340Sdrh     double value;
34359339da1fSdrh     sqlite3AtoF(z, &value, sqlite3Strlen30(z), SQLITE_UTF8);
3436d0015161Sdrh     assert( !sqlite3IsNaN(value) ); /* The new AtoF never returns NaN */
3437598f1340Sdrh     if( negateFlag ) value = -value;
343897bae794Sdrh     sqlite3VdbeAddOp4Dup8(v, OP_Real, 0, iMem, 0, (u8*)&value, P4_REAL);
3439598f1340Sdrh   }
3440598f1340Sdrh }
344113573c71Sdrh #endif
3442598f1340Sdrh 
3443598f1340Sdrh 
3444598f1340Sdrh /*
3445fec19aadSdrh ** Generate an instruction that will put the integer describe by
34469cbf3425Sdrh ** text z[0..n-1] into register iMem.
34470cf19ed8Sdrh **
34485f1d6b61Sshaneh ** Expr.u.zToken is always UTF8 and zero-terminated.
3449fec19aadSdrh */
345013573c71Sdrh static void codeInteger(Parse *pParse, Expr *pExpr, int negFlag, int iMem){
345113573c71Sdrh   Vdbe *v = pParse->pVdbe;
345292b01d53Sdrh   if( pExpr->flags & EP_IntValue ){
345333e619fcSdrh     int i = pExpr->u.iValue;
3454d50ffc41Sdrh     assert( i>=0 );
345592b01d53Sdrh     if( negFlag ) i = -i;
345692b01d53Sdrh     sqlite3VdbeAddOp2(v, OP_Integer, i, iMem);
3457fd773cf9Sdrh   }else{
34585f1d6b61Sshaneh     int c;
34595f1d6b61Sshaneh     i64 value;
3460fd773cf9Sdrh     const char *z = pExpr->u.zToken;
3461fd773cf9Sdrh     assert( z!=0 );
34629296c18aSdrh     c = sqlite3DecOrHexToI64(z, &value);
346384d4f1a3Sdrh     if( (c==3 && !negFlag) || (c==2) || (negFlag && value==SMALLEST_INT64)){
346413573c71Sdrh #ifdef SQLITE_OMIT_FLOATING_POINT
346513573c71Sdrh       sqlite3ErrorMsg(pParse, "oversized integer: %s%s", negFlag ? "-" : "", z);
346613573c71Sdrh #else
34671b7ddc59Sdrh #ifndef SQLITE_OMIT_HEX_INTEGER
34689296c18aSdrh       if( sqlite3_strnicmp(z,"0x",2)==0 ){
346977320ea4Sdrh         sqlite3ErrorMsg(pParse, "hex literal too big: %s%s", negFlag?"-":"",z);
34701b7ddc59Sdrh       }else
34711b7ddc59Sdrh #endif
34721b7ddc59Sdrh       {
3473b7916a78Sdrh         codeReal(v, z, negFlag, iMem);
34749296c18aSdrh       }
347513573c71Sdrh #endif
347677320ea4Sdrh     }else{
347784d4f1a3Sdrh       if( negFlag ){ value = c==3 ? SMALLEST_INT64 : -value; }
347877320ea4Sdrh       sqlite3VdbeAddOp4Dup8(v, OP_Int64, 0, iMem, 0, (u8*)&value, P4_INT64);
3479fec19aadSdrh     }
3480fec19aadSdrh   }
3481c9cf901dSdanielk1977 }
3482fec19aadSdrh 
34835cd79239Sdrh 
34841f9ca2c8Sdrh /* Generate code that will load into register regOut a value that is
34851f9ca2c8Sdrh ** appropriate for the iIdxCol-th column of index pIdx.
34861f9ca2c8Sdrh */
34871f9ca2c8Sdrh void sqlite3ExprCodeLoadIndexColumn(
34881f9ca2c8Sdrh   Parse *pParse,  /* The parsing context */
34891f9ca2c8Sdrh   Index *pIdx,    /* The index whose column is to be loaded */
34901f9ca2c8Sdrh   int iTabCur,    /* Cursor pointing to a table row */
34911f9ca2c8Sdrh   int iIdxCol,    /* The column of the index to be loaded */
34921f9ca2c8Sdrh   int regOut      /* Store the index column value in this register */
34931f9ca2c8Sdrh ){
34941f9ca2c8Sdrh   i16 iTabCol = pIdx->aiColumn[iIdxCol];
34954b92f98cSdrh   if( iTabCol==XN_EXPR ){
34961f9ca2c8Sdrh     assert( pIdx->aColExpr );
34971f9ca2c8Sdrh     assert( pIdx->aColExpr->nExpr>iIdxCol );
34983e34eabcSdrh     pParse->iSelfTab = iTabCur + 1;
34991c75c9d7Sdrh     sqlite3ExprCodeCopy(pParse, pIdx->aColExpr->a[iIdxCol].pExpr, regOut);
35003e34eabcSdrh     pParse->iSelfTab = 0;
35014b92f98cSdrh   }else{
35026df9c4b9Sdrh     sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pIdx->pTable, iTabCur,
35034b92f98cSdrh                                     iTabCol, regOut);
35044b92f98cSdrh   }
35051f9ca2c8Sdrh }
35061f9ca2c8Sdrh 
3507e70fa7feSdrh #ifndef SQLITE_OMIT_GENERATED_COLUMNS
3508e70fa7feSdrh /*
3509e70fa7feSdrh ** Generate code that will compute the value of generated column pCol
3510e70fa7feSdrh ** and store the result in register regOut
3511e70fa7feSdrh */
3512e70fa7feSdrh void sqlite3ExprCodeGeneratedColumn(
3513e70fa7feSdrh   Parse *pParse,
3514e70fa7feSdrh   Column *pCol,
3515e70fa7feSdrh   int regOut
3516e70fa7feSdrh ){
35174dad7ed5Sdrh   int iAddr;
35184dad7ed5Sdrh   Vdbe *v = pParse->pVdbe;
35194dad7ed5Sdrh   assert( v!=0 );
35204dad7ed5Sdrh   assert( pParse->iSelfTab!=0 );
35214dad7ed5Sdrh   if( pParse->iSelfTab>0 ){
35224dad7ed5Sdrh     iAddr = sqlite3VdbeAddOp3(v, OP_IfNullRow, pParse->iSelfTab-1, 0, regOut);
35234dad7ed5Sdrh   }else{
35244dad7ed5Sdrh     iAddr = 0;
35254dad7ed5Sdrh   }
352624e39903Sdrh   sqlite3ExprCodeCopy(pParse, pCol->pDflt, regOut);
3527e70fa7feSdrh   if( pCol->affinity>=SQLITE_AFF_TEXT ){
35284dad7ed5Sdrh     sqlite3VdbeAddOp4(v, OP_Affinity, regOut, 1, 0, &pCol->affinity, 1);
3529e70fa7feSdrh   }
35304dad7ed5Sdrh   if( iAddr ) sqlite3VdbeJumpHere(v, iAddr);
3531e70fa7feSdrh }
3532e70fa7feSdrh #endif /* SQLITE_OMIT_GENERATED_COLUMNS */
3533e70fa7feSdrh 
35345cd79239Sdrh /*
35355c092e8aSdrh ** Generate code to extract the value of the iCol-th column of a table.
35365c092e8aSdrh */
35375c092e8aSdrh void sqlite3ExprCodeGetColumnOfTable(
35386df9c4b9Sdrh   Vdbe *v,        /* Parsing context */
35395c092e8aSdrh   Table *pTab,    /* The table containing the value */
3540313619f5Sdrh   int iTabCur,    /* The table cursor.  Or the PK cursor for WITHOUT ROWID */
35415c092e8aSdrh   int iCol,       /* Index of the column to extract */
3542313619f5Sdrh   int regOut      /* Extract the value into this register */
35435c092e8aSdrh ){
3544ab45fc04Sdrh   Column *pCol;
354581f7b372Sdrh   assert( v!=0 );
3546aca19e19Sdrh   if( pTab==0 ){
3547aca19e19Sdrh     sqlite3VdbeAddOp3(v, OP_Column, iTabCur, iCol, regOut);
3548aca19e19Sdrh     return;
3549aca19e19Sdrh   }
35505c092e8aSdrh   if( iCol<0 || iCol==pTab->iPKey ){
35515c092e8aSdrh     sqlite3VdbeAddOp2(v, OP_Rowid, iTabCur, regOut);
35525c092e8aSdrh   }else{
355381f7b372Sdrh     int op;
355481f7b372Sdrh     int x;
355581f7b372Sdrh     if( IsVirtual(pTab) ){
355681f7b372Sdrh       op = OP_VColumn;
355781f7b372Sdrh       x = iCol;
355881f7b372Sdrh #ifndef SQLITE_OMIT_GENERATED_COLUMNS
3559ab45fc04Sdrh     }else if( (pCol = &pTab->aCol[iCol])->colFlags & COLFLAG_VIRTUAL ){
35606df9c4b9Sdrh       Parse *pParse = sqlite3VdbeParser(v);
3561ab45fc04Sdrh       if( pCol->colFlags & COLFLAG_BUSY ){
3562ab45fc04Sdrh         sqlite3ErrorMsg(pParse, "generated column loop on \"%s\"", pCol->zName);
3563ab45fc04Sdrh       }else{
356481f7b372Sdrh         int savedSelfTab = pParse->iSelfTab;
3565ab45fc04Sdrh         pCol->colFlags |= COLFLAG_BUSY;
356681f7b372Sdrh         pParse->iSelfTab = iTabCur+1;
3567e70fa7feSdrh         sqlite3ExprCodeGeneratedColumn(pParse, pCol, regOut);
356881f7b372Sdrh         pParse->iSelfTab = savedSelfTab;
3569ab45fc04Sdrh         pCol->colFlags &= ~COLFLAG_BUSY;
3570ab45fc04Sdrh       }
357181f7b372Sdrh       return;
357281f7b372Sdrh #endif
357381f7b372Sdrh     }else if( !HasRowid(pTab) ){
3574c5f808d8Sdrh       testcase( iCol!=sqlite3TableColumnToStorage(pTab, iCol) );
3575b9bcf7caSdrh       x = sqlite3TableColumnToIndex(sqlite3PrimaryKeyIndex(pTab), iCol);
357681f7b372Sdrh       op = OP_Column;
357781f7b372Sdrh     }else{
3578b9bcf7caSdrh       x = sqlite3TableColumnToStorage(pTab,iCol);
3579c5f808d8Sdrh       testcase( x!=iCol );
358081f7b372Sdrh       op = OP_Column;
3581ee0ec8e1Sdrh     }
3582ee0ec8e1Sdrh     sqlite3VdbeAddOp3(v, op, iTabCur, x, regOut);
35835c092e8aSdrh     sqlite3ColumnDefault(v, pTab, iCol, regOut);
35845c092e8aSdrh   }
35855c092e8aSdrh }
35865c092e8aSdrh 
35875c092e8aSdrh /*
3588945498f3Sdrh ** Generate code that will extract the iColumn-th column from
35898c607191Sdrh ** table pTab and store the column value in register iReg.
3590e55cbd72Sdrh **
3591e55cbd72Sdrh ** There must be an open cursor to pTab in iTable when this routine
3592e55cbd72Sdrh ** is called.  If iColumn<0 then code is generated that extracts the rowid.
3593945498f3Sdrh */
3594e55cbd72Sdrh int sqlite3ExprCodeGetColumn(
3595e55cbd72Sdrh   Parse *pParse,   /* Parsing and code generating context */
35962133d822Sdrh   Table *pTab,     /* Description of the table we are reading from */
35972133d822Sdrh   int iColumn,     /* Index of the table column */
35982133d822Sdrh   int iTable,      /* The cursor pointing to the table */
3599a748fdccSdrh   int iReg,        /* Store results here */
3600ce78bc6eSdrh   u8 p5            /* P5 value for OP_Column + FLAGS */
36012133d822Sdrh ){
360281f7b372Sdrh   assert( pParse->pVdbe!=0 );
36036df9c4b9Sdrh   sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pTab, iTable, iColumn, iReg);
3604a748fdccSdrh   if( p5 ){
360599670abbSdrh     VdbeOp *pOp = sqlite3VdbeGetOp(pParse->pVdbe,-1);
360699670abbSdrh     if( pOp->opcode==OP_Column ) pOp->p5 = p5;
3607a748fdccSdrh   }
3608e55cbd72Sdrh   return iReg;
3609e55cbd72Sdrh }
3610e55cbd72Sdrh 
3611e55cbd72Sdrh /*
3612b21e7c70Sdrh ** Generate code to move content from registers iFrom...iFrom+nReg-1
361336a5d88dSdrh ** over to iTo..iTo+nReg-1.
3614e55cbd72Sdrh */
3615b21e7c70Sdrh void sqlite3ExprCodeMove(Parse *pParse, int iFrom, int iTo, int nReg){
3616079a3072Sdrh   sqlite3VdbeAddOp3(pParse->pVdbe, OP_Move, iFrom, iTo, nReg);
3617945498f3Sdrh }
3618945498f3Sdrh 
3619652fbf55Sdrh /*
362012abf408Sdrh ** Convert a scalar expression node to a TK_REGISTER referencing
362112abf408Sdrh ** register iReg.  The caller must ensure that iReg already contains
362212abf408Sdrh ** the correct value for the expression.
3623a4c3c87eSdrh */
3624069d1b1fSdan static void exprToRegister(Expr *pExpr, int iReg){
36250d950af3Sdrh   Expr *p = sqlite3ExprSkipCollateAndLikely(pExpr);
3626a4c3c87eSdrh   p->op2 = p->op;
3627a4c3c87eSdrh   p->op = TK_REGISTER;
3628a4c3c87eSdrh   p->iTable = iReg;
3629a4c3c87eSdrh   ExprClearProperty(p, EP_Skip);
3630a4c3c87eSdrh }
3631a4c3c87eSdrh 
363212abf408Sdrh /*
363312abf408Sdrh ** Evaluate an expression (either a vector or a scalar expression) and store
363412abf408Sdrh ** the result in continguous temporary registers.  Return the index of
363512abf408Sdrh ** the first register used to store the result.
363612abf408Sdrh **
363712abf408Sdrh ** If the returned result register is a temporary scalar, then also write
363812abf408Sdrh ** that register number into *piFreeable.  If the returned result register
363912abf408Sdrh ** is not a temporary or if the expression is a vector set *piFreeable
364012abf408Sdrh ** to 0.
364112abf408Sdrh */
364212abf408Sdrh static int exprCodeVector(Parse *pParse, Expr *p, int *piFreeable){
364312abf408Sdrh   int iResult;
364412abf408Sdrh   int nResult = sqlite3ExprVectorSize(p);
364512abf408Sdrh   if( nResult==1 ){
364612abf408Sdrh     iResult = sqlite3ExprCodeTemp(pParse, p, piFreeable);
364712abf408Sdrh   }else{
364812abf408Sdrh     *piFreeable = 0;
364912abf408Sdrh     if( p->op==TK_SELECT ){
3650dd1bb43aSdrh #if SQLITE_OMIT_SUBQUERY
3651dd1bb43aSdrh       iResult = 0;
3652dd1bb43aSdrh #else
365385bcdce2Sdrh       iResult = sqlite3CodeSubselect(pParse, p);
3654dd1bb43aSdrh #endif
365512abf408Sdrh     }else{
365612abf408Sdrh       int i;
365712abf408Sdrh       iResult = pParse->nMem+1;
365812abf408Sdrh       pParse->nMem += nResult;
365912abf408Sdrh       for(i=0; i<nResult; i++){
36604b725240Sdan         sqlite3ExprCodeFactorable(pParse, p->x.pList->a[i].pExpr, i+iResult);
366112abf408Sdrh       }
366212abf408Sdrh     }
366312abf408Sdrh   }
366412abf408Sdrh   return iResult;
366512abf408Sdrh }
366612abf408Sdrh 
366725c4296bSdrh /*
366892a27f7bSdrh ** If the last opcode is a OP_Copy, then set the do-not-merge flag (p5)
366992a27f7bSdrh ** so that a subsequent copy will not be merged into this one.
367092a27f7bSdrh */
367192a27f7bSdrh static void setDoNotMergeFlagOnCopy(Vdbe *v){
367292a27f7bSdrh   if( sqlite3VdbeGetOp(v, -1)->opcode==OP_Copy ){
367392a27f7bSdrh     sqlite3VdbeChangeP5(v, 1);  /* Tag trailing OP_Copy as not mergable */
367492a27f7bSdrh   }
367592a27f7bSdrh }
367692a27f7bSdrh 
367792a27f7bSdrh /*
367825c4296bSdrh ** Generate code to implement special SQL functions that are implemented
367925c4296bSdrh ** in-line rather than by using the usual callbacks.
368025c4296bSdrh */
368125c4296bSdrh static int exprCodeInlineFunction(
368225c4296bSdrh   Parse *pParse,        /* Parsing context */
368325c4296bSdrh   ExprList *pFarg,      /* List of function arguments */
368425c4296bSdrh   int iFuncId,          /* Function ID.  One of the INTFUNC_... values */
368525c4296bSdrh   int target            /* Store function result in this register */
368625c4296bSdrh ){
368725c4296bSdrh   int nFarg;
368825c4296bSdrh   Vdbe *v = pParse->pVdbe;
368925c4296bSdrh   assert( v!=0 );
369025c4296bSdrh   assert( pFarg!=0 );
369125c4296bSdrh   nFarg = pFarg->nExpr;
369225c4296bSdrh   assert( nFarg>0 );  /* All in-line functions have at least one argument */
369325c4296bSdrh   switch( iFuncId ){
369425c4296bSdrh     case INLINEFUNC_coalesce: {
369525c4296bSdrh       /* Attempt a direct implementation of the built-in COALESCE() and
369625c4296bSdrh       ** IFNULL() functions.  This avoids unnecessary evaluation of
369725c4296bSdrh       ** arguments past the first non-NULL argument.
369825c4296bSdrh       */
369925c4296bSdrh       int endCoalesce = sqlite3VdbeMakeLabel(pParse);
370025c4296bSdrh       int i;
370125c4296bSdrh       assert( nFarg>=2 );
370225c4296bSdrh       sqlite3ExprCode(pParse, pFarg->a[0].pExpr, target);
370325c4296bSdrh       for(i=1; i<nFarg; i++){
370425c4296bSdrh         sqlite3VdbeAddOp2(v, OP_NotNull, target, endCoalesce);
370525c4296bSdrh         VdbeCoverage(v);
370625c4296bSdrh         sqlite3ExprCode(pParse, pFarg->a[i].pExpr, target);
370725c4296bSdrh       }
370892a27f7bSdrh       setDoNotMergeFlagOnCopy(v);
370925c4296bSdrh       sqlite3VdbeResolveLabel(v, endCoalesce);
371025c4296bSdrh       break;
371125c4296bSdrh     }
37123c0e606bSdrh     case INLINEFUNC_iif: {
37133c0e606bSdrh       Expr caseExpr;
37143c0e606bSdrh       memset(&caseExpr, 0, sizeof(caseExpr));
37153c0e606bSdrh       caseExpr.op = TK_CASE;
37163c0e606bSdrh       caseExpr.x.pList = pFarg;
37173c0e606bSdrh       return sqlite3ExprCodeTarget(pParse, &caseExpr, target);
37183c0e606bSdrh     }
371925c4296bSdrh 
3720171c50ecSdrh     default: {
372125c4296bSdrh       /* The UNLIKELY() function is a no-op.  The result is the value
372225c4296bSdrh       ** of the first argument.
372325c4296bSdrh       */
3724171c50ecSdrh       assert( nFarg==1 || nFarg==2 );
372525c4296bSdrh       target = sqlite3ExprCodeTarget(pParse, pFarg->a[0].pExpr, target);
372625c4296bSdrh       break;
372725c4296bSdrh     }
372825c4296bSdrh 
3729171c50ecSdrh   /***********************************************************************
3730171c50ecSdrh   ** Test-only SQL functions that are only usable if enabled
3731171c50ecSdrh   ** via SQLITE_TESTCTRL_INTERNAL_FUNCTIONS
3732171c50ecSdrh   */
3733171c50ecSdrh     case INLINEFUNC_expr_compare: {
3734171c50ecSdrh       /* Compare two expressions using sqlite3ExprCompare() */
3735171c50ecSdrh       assert( nFarg==2 );
3736171c50ecSdrh       sqlite3VdbeAddOp2(v, OP_Integer,
3737171c50ecSdrh          sqlite3ExprCompare(0,pFarg->a[0].pExpr, pFarg->a[1].pExpr,-1),
3738171c50ecSdrh          target);
3739171c50ecSdrh       break;
3740171c50ecSdrh     }
3741171c50ecSdrh 
3742171c50ecSdrh     case INLINEFUNC_expr_implies_expr: {
3743171c50ecSdrh       /* Compare two expressions using sqlite3ExprImpliesExpr() */
3744171c50ecSdrh       assert( nFarg==2 );
3745171c50ecSdrh       sqlite3VdbeAddOp2(v, OP_Integer,
3746171c50ecSdrh          sqlite3ExprImpliesExpr(pParse,pFarg->a[0].pExpr, pFarg->a[1].pExpr,-1),
3747171c50ecSdrh          target);
3748171c50ecSdrh       break;
3749171c50ecSdrh     }
3750171c50ecSdrh 
3751171c50ecSdrh     case INLINEFUNC_implies_nonnull_row: {
3752171c50ecSdrh       /* REsult of sqlite3ExprImpliesNonNullRow() */
3753171c50ecSdrh       Expr *pA1;
3754171c50ecSdrh       assert( nFarg==2 );
3755171c50ecSdrh       pA1 = pFarg->a[1].pExpr;
3756171c50ecSdrh       if( pA1->op==TK_COLUMN ){
3757171c50ecSdrh         sqlite3VdbeAddOp2(v, OP_Integer,
3758171c50ecSdrh            sqlite3ExprImpliesNonNullRow(pFarg->a[0].pExpr,pA1->iTable),
3759171c50ecSdrh            target);
3760171c50ecSdrh       }else{
3761171c50ecSdrh         sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3762171c50ecSdrh       }
3763171c50ecSdrh       break;
3764171c50ecSdrh     }
3765171c50ecSdrh 
376625c4296bSdrh #ifdef SQLITE_DEBUG
376725c4296bSdrh     case INLINEFUNC_affinity: {
376825c4296bSdrh       /* The AFFINITY() function evaluates to a string that describes
376925c4296bSdrh       ** the type affinity of the argument.  This is used for testing of
377025c4296bSdrh       ** the SQLite type logic.
377125c4296bSdrh       */
377225c4296bSdrh       const char *azAff[] = { "blob", "text", "numeric", "integer", "real" };
377325c4296bSdrh       char aff;
377425c4296bSdrh       assert( nFarg==1 );
377525c4296bSdrh       aff = sqlite3ExprAffinity(pFarg->a[0].pExpr);
377625c4296bSdrh       sqlite3VdbeLoadString(v, target,
377725c4296bSdrh               (aff<=SQLITE_AFF_NONE) ? "none" : azAff[aff-SQLITE_AFF_BLOB]);
377825c4296bSdrh       break;
377925c4296bSdrh     }
378025c4296bSdrh #endif
378125c4296bSdrh   }
378225c4296bSdrh   return target;
378325c4296bSdrh }
378425c4296bSdrh 
378571c57db0Sdan 
3786a4c3c87eSdrh /*
3787cce7d176Sdrh ** Generate code into the current Vdbe to evaluate the given
37882dcef11bSdrh ** expression.  Attempt to store the results in register "target".
37892dcef11bSdrh ** Return the register where results are stored.
3790389a1adbSdrh **
37918b213899Sdrh ** With this routine, there is no guarantee that results will
37922dcef11bSdrh ** be stored in target.  The result might be stored in some other
37932dcef11bSdrh ** register if it is convenient to do so.  The calling function
37942dcef11bSdrh ** must check the return code and move the results to the desired
37952dcef11bSdrh ** register.
3796cce7d176Sdrh */
3797678ccce8Sdrh int sqlite3ExprCodeTarget(Parse *pParse, Expr *pExpr, int target){
37982dcef11bSdrh   Vdbe *v = pParse->pVdbe;  /* The VM under construction */
37992dcef11bSdrh   int op;                   /* The opcode being coded */
38002dcef11bSdrh   int inReg = target;       /* Results stored in register inReg */
38012dcef11bSdrh   int regFree1 = 0;         /* If non-zero free this temporary register */
38022dcef11bSdrh   int regFree2 = 0;         /* If non-zero free this temporary register */
38037b35a77bSdan   int r1, r2;               /* Various register numbers */
380410d1edf0Sdrh   Expr tempX;               /* Temporary expression node */
380571c57db0Sdan   int p5 = 0;
3806ffe07b2dSdrh 
38079cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
3808b639a209Sdrh   assert( v!=0 );
3809389a1adbSdrh 
38101efa8023Sdrh expr_code_doover:
3811389a1adbSdrh   if( pExpr==0 ){
3812389a1adbSdrh     op = TK_NULL;
3813389a1adbSdrh   }else{
3814e7375bfaSdrh     assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
3815f2bc013cSdrh     op = pExpr->op;
3816389a1adbSdrh   }
3817f2bc013cSdrh   switch( op ){
381813449892Sdrh     case TK_AGG_COLUMN: {
381913449892Sdrh       AggInfo *pAggInfo = pExpr->pAggInfo;
38200934d640Sdrh       struct AggInfo_col *pCol;
38210934d640Sdrh       assert( pAggInfo!=0 );
38220934d640Sdrh       assert( pExpr->iAgg>=0 && pExpr->iAgg<pAggInfo->nColumn );
38230934d640Sdrh       pCol = &pAggInfo->aCol[pExpr->iAgg];
382413449892Sdrh       if( !pAggInfo->directMode ){
38259de221dfSdrh         assert( pCol->iMem>0 );
3826c332cc30Sdrh         return pCol->iMem;
382713449892Sdrh       }else if( pAggInfo->useSortingIdx ){
38280c76e892Sdrh         Table *pTab = pCol->pTab;
38295134d135Sdan         sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdxPTab,
3830389a1adbSdrh                               pCol->iSorterColumn, target);
38318d5cea6bSdrh         if( pCol->iColumn<0 ){
38328d5cea6bSdrh           VdbeComment((v,"%s.rowid",pTab->zName));
38338d5cea6bSdrh         }else{
38348d5cea6bSdrh           VdbeComment((v,"%s.%s",pTab->zName,pTab->aCol[pCol->iColumn].zName));
38358d5cea6bSdrh           if( pTab->aCol[pCol->iColumn].affinity==SQLITE_AFF_REAL ){
38368d5cea6bSdrh             sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
38378d5cea6bSdrh           }
38380c76e892Sdrh         }
3839c332cc30Sdrh         return target;
384013449892Sdrh       }
384113449892Sdrh       /* Otherwise, fall thru into the TK_COLUMN case */
384208b92086Sdrh       /* no break */ deliberate_fall_through
384313449892Sdrh     }
3844967e8b73Sdrh     case TK_COLUMN: {
3845b2b9d3d7Sdrh       int iTab = pExpr->iTable;
384667b9ba17Sdrh       int iReg;
3847efad2e23Sdrh       if( ExprHasProperty(pExpr, EP_FixedCol) ){
3848d98f5324Sdrh         /* This COLUMN expression is really a constant due to WHERE clause
3849d98f5324Sdrh         ** constraints, and that constant is coded by the pExpr->pLeft
3850d98f5324Sdrh         ** expresssion.  However, make sure the constant has the correct
3851d98f5324Sdrh         ** datatype by applying the Affinity of the table column to the
3852d98f5324Sdrh         ** constant.
3853d98f5324Sdrh         */
385457f7ece7Sdrh         int aff;
385567b9ba17Sdrh         iReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft,target);
385657f7ece7Sdrh         if( pExpr->y.pTab ){
385757f7ece7Sdrh           aff = sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
385857f7ece7Sdrh         }else{
385957f7ece7Sdrh           aff = pExpr->affExpr;
386057f7ece7Sdrh         }
386196fb16eeSdrh         if( aff>SQLITE_AFF_BLOB ){
3862d98f5324Sdrh           static const char zAff[] = "B\000C\000D\000E";
3863d98f5324Sdrh           assert( SQLITE_AFF_BLOB=='A' );
3864d98f5324Sdrh           assert( SQLITE_AFF_TEXT=='B' );
3865d98f5324Sdrh           sqlite3VdbeAddOp4(v, OP_Affinity, iReg, 1, 0,
3866d98f5324Sdrh                             &zAff[(aff-'B')*2], P4_STATIC);
3867d98f5324Sdrh         }
3868d98f5324Sdrh         return iReg;
3869efad2e23Sdrh       }
3870b2b9d3d7Sdrh       if( iTab<0 ){
38716e97f8ecSdrh         if( pParse->iSelfTab<0 ){
38729942ef0dSdrh           /* Other columns in the same row for CHECK constraints or
38739942ef0dSdrh           ** generated columns or for inserting into partial index.
38749942ef0dSdrh           ** The row is unpacked into registers beginning at
38759942ef0dSdrh           ** 0-(pParse->iSelfTab).  The rowid (if any) is in a register
38769942ef0dSdrh           ** immediately prior to the first column.
38779942ef0dSdrh           */
38789942ef0dSdrh           Column *pCol;
38799942ef0dSdrh           Table *pTab = pExpr->y.pTab;
38809942ef0dSdrh           int iSrc;
3881c5f808d8Sdrh           int iCol = pExpr->iColumn;
38829942ef0dSdrh           assert( pTab!=0 );
3883c5f808d8Sdrh           assert( iCol>=XN_ROWID );
3884b0cbcd0eSdrh           assert( iCol<pTab->nCol );
3885c5f808d8Sdrh           if( iCol<0 ){
38869942ef0dSdrh             return -1-pParse->iSelfTab;
38879942ef0dSdrh           }
3888c5f808d8Sdrh           pCol = pTab->aCol + iCol;
3889c5f808d8Sdrh           testcase( iCol!=sqlite3TableColumnToStorage(pTab,iCol) );
3890c5f808d8Sdrh           iSrc = sqlite3TableColumnToStorage(pTab, iCol) - pParse->iSelfTab;
38919942ef0dSdrh #ifndef SQLITE_OMIT_GENERATED_COLUMNS
38929942ef0dSdrh           if( pCol->colFlags & COLFLAG_GENERATED ){
38934e8e533bSdrh             if( pCol->colFlags & COLFLAG_BUSY ){
38944e8e533bSdrh               sqlite3ErrorMsg(pParse, "generated column loop on \"%s\"",
38954e8e533bSdrh                               pCol->zName);
38964e8e533bSdrh               return 0;
38974e8e533bSdrh             }
38984e8e533bSdrh             pCol->colFlags |= COLFLAG_BUSY;
38994e8e533bSdrh             if( pCol->colFlags & COLFLAG_NOTAVAIL ){
3900e70fa7feSdrh               sqlite3ExprCodeGeneratedColumn(pParse, pCol, iSrc);
39014e8e533bSdrh             }
39024e8e533bSdrh             pCol->colFlags &= ~(COLFLAG_BUSY|COLFLAG_NOTAVAIL);
3903dd6cc9b5Sdrh             return iSrc;
39049942ef0dSdrh           }else
39059942ef0dSdrh #endif /* SQLITE_OMIT_GENERATED_COLUMNS */
39069942ef0dSdrh           if( pCol->affinity==SQLITE_AFF_REAL ){
39079942ef0dSdrh             sqlite3VdbeAddOp2(v, OP_SCopy, iSrc, target);
3908bffdd636Sdrh             sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
3909bffdd636Sdrh             return target;
3910bffdd636Sdrh           }else{
39119942ef0dSdrh             return iSrc;
3912bffdd636Sdrh           }
3913c4a3c779Sdrh         }else{
39141f9ca2c8Sdrh           /* Coding an expression that is part of an index where column names
39151f9ca2c8Sdrh           ** in the index refer to the table to which the index belongs */
39163e34eabcSdrh           iTab = pParse->iSelfTab - 1;
39172282792aSdrh         }
3918b2b9d3d7Sdrh       }
391967b9ba17Sdrh       iReg = sqlite3ExprCodeGetColumn(pParse, pExpr->y.pTab,
3920b2b9d3d7Sdrh                                pExpr->iColumn, iTab, target,
3921b2b9d3d7Sdrh                                pExpr->op2);
392267b9ba17Sdrh       if( pExpr->y.pTab==0 && pExpr->affExpr==SQLITE_AFF_REAL ){
392367b9ba17Sdrh         sqlite3VdbeAddOp1(v, OP_RealAffinity, iReg);
392467b9ba17Sdrh       }
392567b9ba17Sdrh       return iReg;
3926cce7d176Sdrh     }
3927cce7d176Sdrh     case TK_INTEGER: {
392813573c71Sdrh       codeInteger(pParse, pExpr, 0, target);
3929c332cc30Sdrh       return target;
393051e9a445Sdrh     }
39318abed7b9Sdrh     case TK_TRUEFALSE: {
393296acafbeSdrh       sqlite3VdbeAddOp2(v, OP_Integer, sqlite3ExprTruthValue(pExpr), target);
3933007c843bSdrh       return target;
3934007c843bSdrh     }
393513573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
3936598f1340Sdrh     case TK_FLOAT: {
393733e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
393833e619fcSdrh       codeReal(v, pExpr->u.zToken, 0, target);
3939c332cc30Sdrh       return target;
3940598f1340Sdrh     }
394113573c71Sdrh #endif
3942fec19aadSdrh     case TK_STRING: {
394333e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
3944076e85f5Sdrh       sqlite3VdbeLoadString(v, target, pExpr->u.zToken);
3945c332cc30Sdrh       return target;
3946cce7d176Sdrh     }
3947aac30f9bSdrh     default: {
3948c29af653Sdrh       /* Make NULL the default case so that if a bug causes an illegal
3949c29af653Sdrh       ** Expr node to be passed into this function, it will be handled
39509524a7eaSdrh       ** sanely and not crash.  But keep the assert() to bring the problem
39519524a7eaSdrh       ** to the attention of the developers. */
39529524a7eaSdrh       assert( op==TK_NULL );
39539de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3954c332cc30Sdrh       return target;
3955f0863fe5Sdrh     }
39565338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_BLOB_LITERAL
3957c572ef7fSdanielk1977     case TK_BLOB: {
39586c8c6cecSdrh       int n;
39596c8c6cecSdrh       const char *z;
3960ca48c90fSdrh       char *zBlob;
396133e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
396233e619fcSdrh       assert( pExpr->u.zToken[0]=='x' || pExpr->u.zToken[0]=='X' );
396333e619fcSdrh       assert( pExpr->u.zToken[1]=='\'' );
396433e619fcSdrh       z = &pExpr->u.zToken[2];
3965b7916a78Sdrh       n = sqlite3Strlen30(z) - 1;
3966b7916a78Sdrh       assert( z[n]=='\'' );
3967ca48c90fSdrh       zBlob = sqlite3HexToBlob(sqlite3VdbeDb(v), z, n);
3968ca48c90fSdrh       sqlite3VdbeAddOp4(v, OP_Blob, n/2, target, 0, zBlob, P4_DYNAMIC);
3969c332cc30Sdrh       return target;
3970c572ef7fSdanielk1977     }
39715338a5f7Sdanielk1977 #endif
397250457896Sdrh     case TK_VARIABLE: {
397333e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
397433e619fcSdrh       assert( pExpr->u.zToken!=0 );
397533e619fcSdrh       assert( pExpr->u.zToken[0]!=0 );
3976eaf52d88Sdrh       sqlite3VdbeAddOp2(v, OP_Variable, pExpr->iColumn, target);
397733e619fcSdrh       if( pExpr->u.zToken[1]!=0 ){
39789bf755ccSdrh         const char *z = sqlite3VListNumToName(pParse->pVList, pExpr->iColumn);
39799524a7eaSdrh         assert( pExpr->u.zToken[0]=='?' || (z && !strcmp(pExpr->u.zToken, z)) );
3980ce1bbe51Sdrh         pParse->pVList[0] = 0; /* Indicate VList may no longer be enlarged */
39819bf755ccSdrh         sqlite3VdbeAppendP4(v, (char*)z, P4_STATIC);
39829bf755ccSdrh       }
3983c332cc30Sdrh       return target;
398450457896Sdrh     }
39854e0cff60Sdrh     case TK_REGISTER: {
3986c332cc30Sdrh       return pExpr->iTable;
39874e0cff60Sdrh     }
3988487e262fSdrh #ifndef SQLITE_OMIT_CAST
3989487e262fSdrh     case TK_CAST: {
3990487e262fSdrh       /* Expressions of the form:   CAST(pLeft AS token) */
39912dcef11bSdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
39921735fa88Sdrh       if( inReg!=target ){
39931735fa88Sdrh         sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
39941735fa88Sdrh         inReg = target;
39951735fa88Sdrh       }
39964169e430Sdrh       sqlite3VdbeAddOp2(v, OP_Cast, target,
39974169e430Sdrh                         sqlite3AffinityType(pExpr->u.zToken, 0));
3998c332cc30Sdrh       return inReg;
3999487e262fSdrh     }
4000487e262fSdrh #endif /* SQLITE_OMIT_CAST */
400171c57db0Sdan     case TK_IS:
400271c57db0Sdan     case TK_ISNOT:
400371c57db0Sdan       op = (op==TK_IS) ? TK_EQ : TK_NE;
400471c57db0Sdan       p5 = SQLITE_NULLEQ;
400571c57db0Sdan       /* fall-through */
4006c9b84a1fSdrh     case TK_LT:
4007c9b84a1fSdrh     case TK_LE:
4008c9b84a1fSdrh     case TK_GT:
4009c9b84a1fSdrh     case TK_GE:
4010c9b84a1fSdrh     case TK_NE:
4011c9b84a1fSdrh     case TK_EQ: {
401271c57db0Sdan       Expr *pLeft = pExpr->pLeft;
4013625015e0Sdan       if( sqlite3ExprIsVector(pLeft) ){
401479752b6eSdrh         codeVectorCompare(pParse, pExpr, target, op, p5);
401571c57db0Sdan       }else{
401671c57db0Sdan         r1 = sqlite3ExprCodeTemp(pParse, pLeft, &regFree1);
4017b6da74ebSdrh         r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
401871c57db0Sdan         codeCompare(pParse, pLeft, pExpr->pRight, op,
4019898c527eSdrh             r1, r2, inReg, SQLITE_STOREP2 | p5,
4020898c527eSdrh             ExprHasProperty(pExpr,EP_Commuted));
40217d176105Sdrh         assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
40227d176105Sdrh         assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
40237d176105Sdrh         assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
40247d176105Sdrh         assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
40257d176105Sdrh         assert(TK_EQ==OP_Eq); testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
40267d176105Sdrh         assert(TK_NE==OP_Ne); testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
4027c5499befSdrh         testcase( regFree1==0 );
4028c5499befSdrh         testcase( regFree2==0 );
4029c9b84a1fSdrh       }
40306a2fe093Sdrh       break;
40316a2fe093Sdrh     }
4032cce7d176Sdrh     case TK_AND:
4033cce7d176Sdrh     case TK_OR:
4034cce7d176Sdrh     case TK_PLUS:
4035cce7d176Sdrh     case TK_STAR:
4036cce7d176Sdrh     case TK_MINUS:
4037bf4133cbSdrh     case TK_REM:
4038bf4133cbSdrh     case TK_BITAND:
4039bf4133cbSdrh     case TK_BITOR:
404017c40294Sdrh     case TK_SLASH:
4041bf4133cbSdrh     case TK_LSHIFT:
4042855eb1cfSdrh     case TK_RSHIFT:
40430040077dSdrh     case TK_CONCAT: {
40447d176105Sdrh       assert( TK_AND==OP_And );            testcase( op==TK_AND );
40457d176105Sdrh       assert( TK_OR==OP_Or );              testcase( op==TK_OR );
40467d176105Sdrh       assert( TK_PLUS==OP_Add );           testcase( op==TK_PLUS );
40477d176105Sdrh       assert( TK_MINUS==OP_Subtract );     testcase( op==TK_MINUS );
40487d176105Sdrh       assert( TK_REM==OP_Remainder );      testcase( op==TK_REM );
40497d176105Sdrh       assert( TK_BITAND==OP_BitAnd );      testcase( op==TK_BITAND );
40507d176105Sdrh       assert( TK_BITOR==OP_BitOr );        testcase( op==TK_BITOR );
40517d176105Sdrh       assert( TK_SLASH==OP_Divide );       testcase( op==TK_SLASH );
40527d176105Sdrh       assert( TK_LSHIFT==OP_ShiftLeft );   testcase( op==TK_LSHIFT );
40537d176105Sdrh       assert( TK_RSHIFT==OP_ShiftRight );  testcase( op==TK_RSHIFT );
40547d176105Sdrh       assert( TK_CONCAT==OP_Concat );      testcase( op==TK_CONCAT );
40552dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
40562dcef11bSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
40575b6afba9Sdrh       sqlite3VdbeAddOp3(v, op, r2, r1, target);
4058c5499befSdrh       testcase( regFree1==0 );
4059c5499befSdrh       testcase( regFree2==0 );
40600040077dSdrh       break;
40610040077dSdrh     }
4062cce7d176Sdrh     case TK_UMINUS: {
4063fec19aadSdrh       Expr *pLeft = pExpr->pLeft;
4064fec19aadSdrh       assert( pLeft );
406513573c71Sdrh       if( pLeft->op==TK_INTEGER ){
406613573c71Sdrh         codeInteger(pParse, pLeft, 1, target);
4067c332cc30Sdrh         return target;
406813573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
406913573c71Sdrh       }else if( pLeft->op==TK_FLOAT ){
407033e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
407133e619fcSdrh         codeReal(v, pLeft->u.zToken, 1, target);
4072c332cc30Sdrh         return target;
407313573c71Sdrh #endif
40743c84ddffSdrh       }else{
407510d1edf0Sdrh         tempX.op = TK_INTEGER;
407610d1edf0Sdrh         tempX.flags = EP_IntValue|EP_TokenOnly;
407710d1edf0Sdrh         tempX.u.iValue = 0;
4078e7375bfaSdrh         ExprClearVVAProperties(&tempX);
407910d1edf0Sdrh         r1 = sqlite3ExprCodeTemp(pParse, &tempX, &regFree1);
4080e55cbd72Sdrh         r2 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree2);
40812dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_Subtract, r2, r1, target);
4082c5499befSdrh         testcase( regFree2==0 );
40833c84ddffSdrh       }
40846e142f54Sdrh       break;
40856e142f54Sdrh     }
4086bf4133cbSdrh     case TK_BITNOT:
40876e142f54Sdrh     case TK_NOT: {
40887d176105Sdrh       assert( TK_BITNOT==OP_BitNot );   testcase( op==TK_BITNOT );
40897d176105Sdrh       assert( TK_NOT==OP_Not );         testcase( op==TK_NOT );
4090e99fa2afSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4091e99fa2afSdrh       testcase( regFree1==0 );
4092e99fa2afSdrh       sqlite3VdbeAddOp2(v, op, r1, inReg);
4093cce7d176Sdrh       break;
4094cce7d176Sdrh     }
40958abed7b9Sdrh     case TK_TRUTH: {
409696acafbeSdrh       int isTrue;    /* IS TRUE or IS NOT TRUE */
409796acafbeSdrh       int bNormal;   /* IS TRUE or IS FALSE */
4098007c843bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4099007c843bSdrh       testcase( regFree1==0 );
410096acafbeSdrh       isTrue = sqlite3ExprTruthValue(pExpr->pRight);
410196acafbeSdrh       bNormal = pExpr->op2==TK_IS;
410296acafbeSdrh       testcase( isTrue && bNormal);
410396acafbeSdrh       testcase( !isTrue && bNormal);
410496acafbeSdrh       sqlite3VdbeAddOp4Int(v, OP_IsTrue, r1, inReg, !isTrue, isTrue ^ bNormal);
4105007c843bSdrh       break;
4106007c843bSdrh     }
4107cce7d176Sdrh     case TK_ISNULL:
4108cce7d176Sdrh     case TK_NOTNULL: {
41096a288a33Sdrh       int addr;
41107d176105Sdrh       assert( TK_ISNULL==OP_IsNull );   testcase( op==TK_ISNULL );
41117d176105Sdrh       assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
41129de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
41132dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4114c5499befSdrh       testcase( regFree1==0 );
41152dcef11bSdrh       addr = sqlite3VdbeAddOp1(v, op, r1);
41167d176105Sdrh       VdbeCoverageIf(v, op==TK_ISNULL);
41177d176105Sdrh       VdbeCoverageIf(v, op==TK_NOTNULL);
4118a976979bSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 0, target);
41196a288a33Sdrh       sqlite3VdbeJumpHere(v, addr);
4120a37cdde0Sdanielk1977       break;
4121f2bc013cSdrh     }
41222282792aSdrh     case TK_AGG_FUNCTION: {
412313449892Sdrh       AggInfo *pInfo = pExpr->pAggInfo;
41240934d640Sdrh       if( pInfo==0
41250934d640Sdrh        || NEVER(pExpr->iAgg<0)
41260934d640Sdrh        || NEVER(pExpr->iAgg>=pInfo->nFunc)
41270934d640Sdrh       ){
412833e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
412933e619fcSdrh         sqlite3ErrorMsg(pParse, "misuse of aggregate: %s()", pExpr->u.zToken);
41307e56e711Sdrh       }else{
4131c332cc30Sdrh         return pInfo->aFunc[pExpr->iAgg].iMem;
41327e56e711Sdrh       }
41332282792aSdrh       break;
41342282792aSdrh     }
4135cce7d176Sdrh     case TK_FUNCTION: {
413612ffee8cSdrh       ExprList *pFarg;       /* List of function arguments */
413712ffee8cSdrh       int nFarg;             /* Number of function arguments */
413812ffee8cSdrh       FuncDef *pDef;         /* The function definition object */
413912ffee8cSdrh       const char *zId;       /* The function name */
4140693e6719Sdrh       u32 constMask = 0;     /* Mask of function arguments that are constant */
414112ffee8cSdrh       int i;                 /* Loop counter */
4142c332cc30Sdrh       sqlite3 *db = pParse->db;  /* The database connection */
414312ffee8cSdrh       u8 enc = ENC(db);      /* The text encoding used by this database */
414412ffee8cSdrh       CollSeq *pColl = 0;    /* A collating sequence */
414517435752Sdrh 
414667a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
4147eda079cdSdrh       if( ExprHasProperty(pExpr, EP_WinFunc) ){
4148eda079cdSdrh         return pExpr->y.pWin->regResult;
414986fb6e17Sdan       }
415067a9b8edSdan #endif
415186fb6e17Sdan 
41521e9b53f9Sdrh       if( ConstFactorOk(pParse) && sqlite3ExprIsConstantNotJoin(pExpr) ){
41539b258c54Sdrh         /* SQL functions can be expensive. So try to avoid running them
41549b258c54Sdrh         ** multiple times if we know they always give the same result */
41559b258c54Sdrh         return sqlite3ExprCodeRunJustOnce(pParse, pExpr, -1);
41561e9b53f9Sdrh       }
41576ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
4158e7375bfaSdrh       assert( !ExprHasProperty(pExpr, EP_TokenOnly) );
415912ffee8cSdrh       pFarg = pExpr->x.pList;
416012ffee8cSdrh       nFarg = pFarg ? pFarg->nExpr : 0;
416133e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
416233e619fcSdrh       zId = pExpr->u.zToken;
416380738d9cSdrh       pDef = sqlite3FindFunction(db, zId, nFarg, enc, 0);
4164cc15313cSdrh #ifdef SQLITE_ENABLE_UNKNOWN_SQL_FUNCTION
4165cc15313cSdrh       if( pDef==0 && pParse->explain ){
4166cc15313cSdrh         pDef = sqlite3FindFunction(db, "unknown", nFarg, enc, 0);
4167cc15313cSdrh       }
4168cc15313cSdrh #endif
4169b6e9f7a4Sdan       if( pDef==0 || pDef->xFinalize!=0 ){
417080738d9cSdrh         sqlite3ErrorMsg(pParse, "unknown function: %s()", zId);
4171feb306f5Sdrh         break;
4172feb306f5Sdrh       }
417325c4296bSdrh       if( pDef->funcFlags & SQLITE_FUNC_INLINE ){
41740dfa5255Sdrh         assert( (pDef->funcFlags & SQLITE_FUNC_UNSAFE)==0 );
41750dfa5255Sdrh         assert( (pDef->funcFlags & SQLITE_FUNC_DIRECT)==0 );
417625c4296bSdrh         return exprCodeInlineFunction(pParse, pFarg,
417725c4296bSdrh              SQLITE_PTR_TO_INT(pDef->pUserData), target);
41782eeca204Sdrh       }else if( pDef->funcFlags & (SQLITE_FUNC_DIRECT|SQLITE_FUNC_UNSAFE) ){
41790dfa5255Sdrh         sqlite3ExprFunctionUsable(pParse, pExpr, pDef);
4180ae6bb957Sdrh       }
4181a1a523a5Sdrh 
4182d1a01edaSdrh       for(i=0; i<nFarg; i++){
4183d1a01edaSdrh         if( i<32 && sqlite3ExprIsConstant(pFarg->a[i].pExpr) ){
4184693e6719Sdrh           testcase( i==31 );
4185693e6719Sdrh           constMask |= MASKBIT32(i);
4186d1a01edaSdrh         }
4187d1a01edaSdrh         if( (pDef->funcFlags & SQLITE_FUNC_NEEDCOLL)!=0 && !pColl ){
4188d1a01edaSdrh           pColl = sqlite3ExprCollSeq(pParse, pFarg->a[i].pExpr);
4189d1a01edaSdrh         }
4190d1a01edaSdrh       }
419112ffee8cSdrh       if( pFarg ){
4192d1a01edaSdrh         if( constMask ){
4193d1a01edaSdrh           r1 = pParse->nMem+1;
4194d1a01edaSdrh           pParse->nMem += nFarg;
4195d1a01edaSdrh         }else{
419612ffee8cSdrh           r1 = sqlite3GetTempRange(pParse, nFarg);
4197d1a01edaSdrh         }
4198a748fdccSdrh 
4199a748fdccSdrh         /* For length() and typeof() functions with a column argument,
4200a748fdccSdrh         ** set the P5 parameter to the OP_Column opcode to OPFLAG_LENGTHARG
4201a748fdccSdrh         ** or OPFLAG_TYPEOFARG respectively, to avoid unnecessary data
4202a748fdccSdrh         ** loading.
4203a748fdccSdrh         */
4204d36e1041Sdrh         if( (pDef->funcFlags & (SQLITE_FUNC_LENGTH|SQLITE_FUNC_TYPEOF))!=0 ){
42054e245a4cSdrh           u8 exprOp;
4206a748fdccSdrh           assert( nFarg==1 );
4207a748fdccSdrh           assert( pFarg->a[0].pExpr!=0 );
42084e245a4cSdrh           exprOp = pFarg->a[0].pExpr->op;
42094e245a4cSdrh           if( exprOp==TK_COLUMN || exprOp==TK_AGG_COLUMN ){
4210a748fdccSdrh             assert( SQLITE_FUNC_LENGTH==OPFLAG_LENGTHARG );
4211a748fdccSdrh             assert( SQLITE_FUNC_TYPEOF==OPFLAG_TYPEOFARG );
4212b1fba286Sdrh             testcase( pDef->funcFlags & OPFLAG_LENGTHARG );
4213b1fba286Sdrh             pFarg->a[0].pExpr->op2 =
4214b1fba286Sdrh                   pDef->funcFlags & (OPFLAG_LENGTHARG|OPFLAG_TYPEOFARG);
4215a748fdccSdrh           }
4216a748fdccSdrh         }
4217a748fdccSdrh 
42185579d59fSdrh         sqlite3ExprCodeExprList(pParse, pFarg, r1, 0,
4219d1a01edaSdrh                                 SQLITE_ECEL_DUP|SQLITE_ECEL_FACTOR);
4220892d3179Sdrh       }else{
422112ffee8cSdrh         r1 = 0;
4222892d3179Sdrh       }
4223b7f6f68fSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
4224a43fa227Sdrh       /* Possibly overload the function if the first argument is
4225a43fa227Sdrh       ** a virtual table column.
4226a43fa227Sdrh       **
4227a43fa227Sdrh       ** For infix functions (LIKE, GLOB, REGEXP, and MATCH) use the
4228a43fa227Sdrh       ** second argument, not the first, as the argument to test to
4229a43fa227Sdrh       ** see if it is a column in a virtual table.  This is done because
4230a43fa227Sdrh       ** the left operand of infix functions (the operand we want to
4231a43fa227Sdrh       ** control overloading) ends up as the second argument to the
4232a43fa227Sdrh       ** function.  The expression "A glob B" is equivalent to
4233a43fa227Sdrh       ** "glob(B,A).  We want to use the A in "A glob B" to test
4234a43fa227Sdrh       ** for function overloading.  But we use the B term in "glob(B,A)".
4235a43fa227Sdrh       */
423659155065Sdrh       if( nFarg>=2 && ExprHasProperty(pExpr, EP_InfixFunc) ){
423712ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[1].pExpr);
423812ffee8cSdrh       }else if( nFarg>0 ){
423912ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[0].pExpr);
4240b7f6f68fSdrh       }
4241b7f6f68fSdrh #endif
4242d36e1041Sdrh       if( pDef->funcFlags & SQLITE_FUNC_NEEDCOLL ){
42438b213899Sdrh         if( !pColl ) pColl = db->pDfltColl;
424466a5167bSdrh         sqlite3VdbeAddOp4(v, OP_CollSeq, 0, 0, 0, (char *)pColl, P4_COLLSEQ);
4245682f68b0Sdanielk1977       }
4246092457b1Sdrh #ifdef SQLITE_ENABLE_OFFSET_SQL_FUNC
4247092457b1Sdrh       if( pDef->funcFlags & SQLITE_FUNC_OFFSET ){
42482fc865c1Sdrh         Expr *pArg = pFarg->a[0].pExpr;
42492fc865c1Sdrh         if( pArg->op==TK_COLUMN ){
4250092457b1Sdrh           sqlite3VdbeAddOp3(v, OP_Offset, pArg->iTable, pArg->iColumn, target);
42512fc865c1Sdrh         }else{
42522fc865c1Sdrh           sqlite3VdbeAddOp2(v, OP_Null, 0, target);
42532fc865c1Sdrh         }
4254092457b1Sdrh       }else
4255092457b1Sdrh #endif
4256092457b1Sdrh       {
4257920cf596Sdrh         sqlite3VdbeAddFunctionCall(pParse, constMask, r1, target, nFarg,
425820cee7d0Sdrh                                    pDef, pExpr->op2);
42592fc865c1Sdrh       }
426013d79502Sdrh       if( nFarg ){
426113d79502Sdrh         if( constMask==0 ){
426212ffee8cSdrh           sqlite3ReleaseTempRange(pParse, r1, nFarg);
426313d79502Sdrh         }else{
42643aef2fb1Sdrh           sqlite3VdbeReleaseRegisters(pParse, r1, nFarg, constMask, 1);
426513d79502Sdrh         }
42662dcef11bSdrh       }
4267c332cc30Sdrh       return target;
42686ec2733bSdrh     }
4269fe2093d7Sdrh #ifndef SQLITE_OMIT_SUBQUERY
4270fe2093d7Sdrh     case TK_EXISTS:
427119a775c2Sdrh     case TK_SELECT: {
42728da209b1Sdan       int nCol;
4273c5499befSdrh       testcase( op==TK_EXISTS );
4274c5499befSdrh       testcase( op==TK_SELECT );
4275d8d335d7Sdrh       if( pParse->db->mallocFailed ){
4276d8d335d7Sdrh         return 0;
4277d8d335d7Sdrh       }else if( op==TK_SELECT && (nCol = pExpr->x.pSelect->pEList->nExpr)!=1 ){
42788da209b1Sdan         sqlite3SubselectError(pParse, nCol, 1);
42798da209b1Sdan       }else{
428085bcdce2Sdrh         return sqlite3CodeSubselect(pParse, pExpr);
42818da209b1Sdan       }
428219a775c2Sdrh       break;
428319a775c2Sdrh     }
4284fc7f27b9Sdrh     case TK_SELECT_COLUMN: {
4285966e2911Sdrh       int n;
4286fc7f27b9Sdrh       if( pExpr->pLeft->iTable==0 ){
428785bcdce2Sdrh         pExpr->pLeft->iTable = sqlite3CodeSubselect(pParse, pExpr->pLeft);
4288fc7f27b9Sdrh       }
4289966e2911Sdrh       assert( pExpr->iTable==0 || pExpr->pLeft->op==TK_SELECT );
4290554a9dc7Sdrh       if( pExpr->iTable!=0
4291966e2911Sdrh        && pExpr->iTable!=(n = sqlite3ExprVectorSize(pExpr->pLeft))
4292966e2911Sdrh       ){
4293966e2911Sdrh         sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
4294966e2911Sdrh                                 pExpr->iTable, n);
4295966e2911Sdrh       }
4296c332cc30Sdrh       return pExpr->pLeft->iTable + pExpr->iColumn;
4297fc7f27b9Sdrh     }
4298fef5208cSdrh     case TK_IN: {
4299ec4ccdbcSdrh       int destIfFalse = sqlite3VdbeMakeLabel(pParse);
4300ec4ccdbcSdrh       int destIfNull = sqlite3VdbeMakeLabel(pParse);
4301e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
4302e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
430366ba23ceSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
4304e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
4305e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_AddImm, target, 0);
4306e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfNull);
4307c332cc30Sdrh       return target;
4308fef5208cSdrh     }
4309e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
4310e3365e6cSdrh 
4311e3365e6cSdrh 
43122dcef11bSdrh     /*
43132dcef11bSdrh     **    x BETWEEN y AND z
43142dcef11bSdrh     **
43152dcef11bSdrh     ** This is equivalent to
43162dcef11bSdrh     **
43172dcef11bSdrh     **    x>=y AND x<=z
43182dcef11bSdrh     **
43192dcef11bSdrh     ** X is stored in pExpr->pLeft.
43202dcef11bSdrh     ** Y is stored in pExpr->pList->a[0].pExpr.
43212dcef11bSdrh     ** Z is stored in pExpr->pList->a[1].pExpr.
43222dcef11bSdrh     */
4323fef5208cSdrh     case TK_BETWEEN: {
432471c57db0Sdan       exprCodeBetween(pParse, pExpr, target, 0, 0);
4325c332cc30Sdrh       return target;
4326fef5208cSdrh     }
432794fa9c41Sdrh     case TK_SPAN:
4328ae80ddeaSdrh     case TK_COLLATE:
43294f07e5fbSdrh     case TK_UPLUS: {
43301efa8023Sdrh       pExpr = pExpr->pLeft;
433159ee43a7Sdrh       goto expr_code_doover; /* 2018-04-28: Prevent deep recursion. OSSFuzz. */
4332a2e00042Sdrh     }
43332dcef11bSdrh 
4334165921a7Sdan     case TK_TRIGGER: {
433565a7cd16Sdan       /* If the opcode is TK_TRIGGER, then the expression is a reference
433665a7cd16Sdan       ** to a column in the new.* or old.* pseudo-tables available to
433765a7cd16Sdan       ** trigger programs. In this case Expr.iTable is set to 1 for the
433865a7cd16Sdan       ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
433965a7cd16Sdan       ** is set to the column of the pseudo-table to read, or to -1 to
434065a7cd16Sdan       ** read the rowid field.
434165a7cd16Sdan       **
434265a7cd16Sdan       ** The expression is implemented using an OP_Param opcode. The p1
434365a7cd16Sdan       ** parameter is set to 0 for an old.rowid reference, or to (i+1)
434465a7cd16Sdan       ** to reference another column of the old.* pseudo-table, where
434565a7cd16Sdan       ** i is the index of the column. For a new.rowid reference, p1 is
434665a7cd16Sdan       ** set to (n+1), where n is the number of columns in each pseudo-table.
434765a7cd16Sdan       ** For a reference to any other column in the new.* pseudo-table, p1
434865a7cd16Sdan       ** is set to (n+2+i), where n and i are as defined previously. For
434965a7cd16Sdan       ** example, if the table on which triggers are being fired is
435065a7cd16Sdan       ** declared as:
435165a7cd16Sdan       **
435265a7cd16Sdan       **   CREATE TABLE t1(a, b);
435365a7cd16Sdan       **
435465a7cd16Sdan       ** Then p1 is interpreted as follows:
435565a7cd16Sdan       **
435665a7cd16Sdan       **   p1==0   ->    old.rowid     p1==3   ->    new.rowid
435765a7cd16Sdan       **   p1==1   ->    old.a         p1==4   ->    new.a
435865a7cd16Sdan       **   p1==2   ->    old.b         p1==5   ->    new.b
435965a7cd16Sdan       */
4360eda079cdSdrh       Table *pTab = pExpr->y.pTab;
4361dd6cc9b5Sdrh       int iCol = pExpr->iColumn;
4362dd6cc9b5Sdrh       int p1 = pExpr->iTable * (pTab->nCol+1) + 1
43637fe2fc0dSdrh                      + sqlite3TableColumnToStorage(pTab, iCol);
436465a7cd16Sdan 
436565a7cd16Sdan       assert( pExpr->iTable==0 || pExpr->iTable==1 );
4366dd6cc9b5Sdrh       assert( iCol>=-1 && iCol<pTab->nCol );
4367dd6cc9b5Sdrh       assert( pTab->iPKey<0 || iCol!=pTab->iPKey );
436865a7cd16Sdan       assert( p1>=0 && p1<(pTab->nCol*2+2) );
436965a7cd16Sdan 
437065a7cd16Sdan       sqlite3VdbeAddOp2(v, OP_Param, p1, target);
4371896494e8Sdrh       VdbeComment((v, "r[%d]=%s.%s", target,
4372165921a7Sdan         (pExpr->iTable ? "new" : "old"),
4373dd6cc9b5Sdrh         (pExpr->iColumn<0 ? "rowid" : pExpr->y.pTab->aCol[iCol].zName)
4374165921a7Sdan       ));
437565a7cd16Sdan 
437644dbca83Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
437765a7cd16Sdan       /* If the column has REAL affinity, it may currently be stored as an
4378113762a2Sdrh       ** integer. Use OP_RealAffinity to make sure it is really real.
4379113762a2Sdrh       **
4380113762a2Sdrh       ** EVIDENCE-OF: R-60985-57662 SQLite will convert the value back to
4381113762a2Sdrh       ** floating point when extracting it from the record.  */
4382dd6cc9b5Sdrh       if( iCol>=0 && pTab->aCol[iCol].affinity==SQLITE_AFF_REAL ){
43832832ad42Sdan         sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
43842832ad42Sdan       }
438544dbca83Sdrh #endif
4386165921a7Sdan       break;
4387165921a7Sdan     }
4388165921a7Sdan 
438971c57db0Sdan     case TK_VECTOR: {
4390e835bc12Sdrh       sqlite3ErrorMsg(pParse, "row value misused");
439171c57db0Sdan       break;
439271c57db0Sdan     }
439371c57db0Sdan 
43949e9a67adSdrh     /* TK_IF_NULL_ROW Expr nodes are inserted ahead of expressions
43959e9a67adSdrh     ** that derive from the right-hand table of a LEFT JOIN.  The
43969e9a67adSdrh     ** Expr.iTable value is the table number for the right-hand table.
43979e9a67adSdrh     ** The expression is only evaluated if that table is not currently
43989e9a67adSdrh     ** on a LEFT JOIN NULL row.
43999e9a67adSdrh     */
440031d6fd55Sdrh     case TK_IF_NULL_ROW: {
440131d6fd55Sdrh       int addrINR;
44029e9a67adSdrh       u8 okConstFactor = pParse->okConstFactor;
440331d6fd55Sdrh       addrINR = sqlite3VdbeAddOp1(v, OP_IfNullRow, pExpr->iTable);
44049e9a67adSdrh       /* Temporarily disable factoring of constant expressions, since
44059e9a67adSdrh       ** even though expressions may appear to be constant, they are not
44069e9a67adSdrh       ** really constant because they originate from the right-hand side
44079e9a67adSdrh       ** of a LEFT JOIN. */
44089e9a67adSdrh       pParse->okConstFactor = 0;
440931d6fd55Sdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
44109e9a67adSdrh       pParse->okConstFactor = okConstFactor;
441131d6fd55Sdrh       sqlite3VdbeJumpHere(v, addrINR);
441231d6fd55Sdrh       sqlite3VdbeChangeP3(v, addrINR, inReg);
441331d6fd55Sdrh       break;
441431d6fd55Sdrh     }
441531d6fd55Sdrh 
44162dcef11bSdrh     /*
44172dcef11bSdrh     ** Form A:
44182dcef11bSdrh     **   CASE x WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
44192dcef11bSdrh     **
44202dcef11bSdrh     ** Form B:
44212dcef11bSdrh     **   CASE WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
44222dcef11bSdrh     **
44232dcef11bSdrh     ** Form A is can be transformed into the equivalent form B as follows:
44242dcef11bSdrh     **   CASE WHEN x=e1 THEN r1 WHEN x=e2 THEN r2 ...
44252dcef11bSdrh     **        WHEN x=eN THEN rN ELSE y END
44262dcef11bSdrh     **
44272dcef11bSdrh     ** X (if it exists) is in pExpr->pLeft.
4428c5cd1249Sdrh     ** Y is in the last element of pExpr->x.pList if pExpr->x.pList->nExpr is
4429c5cd1249Sdrh     ** odd.  The Y is also optional.  If the number of elements in x.pList
4430c5cd1249Sdrh     ** is even, then Y is omitted and the "otherwise" result is NULL.
44312dcef11bSdrh     ** Ei is in pExpr->pList->a[i*2] and Ri is pExpr->pList->a[i*2+1].
44322dcef11bSdrh     **
44332dcef11bSdrh     ** The result of the expression is the Ri for the first matching Ei,
44342dcef11bSdrh     ** or if there is no matching Ei, the ELSE term Y, or if there is
44352dcef11bSdrh     ** no ELSE term, NULL.
44362dcef11bSdrh     */
4437aac30f9bSdrh     case TK_CASE: {
44382dcef11bSdrh       int endLabel;                     /* GOTO label for end of CASE stmt */
44392dcef11bSdrh       int nextCase;                     /* GOTO label for next WHEN clause */
44402dcef11bSdrh       int nExpr;                        /* 2x number of WHEN terms */
44412dcef11bSdrh       int i;                            /* Loop counter */
44422dcef11bSdrh       ExprList *pEList;                 /* List of WHEN terms */
44432dcef11bSdrh       struct ExprList_item *aListelem;  /* Array of WHEN terms */
44442dcef11bSdrh       Expr opCompare;                   /* The X==Ei expression */
44452dcef11bSdrh       Expr *pX;                         /* The X expression */
44461bd10f8aSdrh       Expr *pTest = 0;                  /* X==Ei (form A) or just Ei (form B) */
44478b65e591Sdan       Expr *pDel = 0;
44488b65e591Sdan       sqlite3 *db = pParse->db;
444917a7f8ddSdrh 
44506ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) && pExpr->x.pList );
44516ab3a2ecSdanielk1977       assert(pExpr->x.pList->nExpr > 0);
44526ab3a2ecSdanielk1977       pEList = pExpr->x.pList;
4453be5c89acSdrh       aListelem = pEList->a;
4454be5c89acSdrh       nExpr = pEList->nExpr;
4455ec4ccdbcSdrh       endLabel = sqlite3VdbeMakeLabel(pParse);
44562dcef11bSdrh       if( (pX = pExpr->pLeft)!=0 ){
44578b65e591Sdan         pDel = sqlite3ExprDup(db, pX, 0);
44588b65e591Sdan         if( db->mallocFailed ){
44598b65e591Sdan           sqlite3ExprDelete(db, pDel);
44608b65e591Sdan           break;
44618b65e591Sdan         }
446233cd4909Sdrh         testcase( pX->op==TK_COLUMN );
44638b65e591Sdan         exprToRegister(pDel, exprCodeVector(pParse, pDel, &regFree1));
4464c5499befSdrh         testcase( regFree1==0 );
4465abb9d5f1Sdrh         memset(&opCompare, 0, sizeof(opCompare));
44662dcef11bSdrh         opCompare.op = TK_EQ;
44678b65e591Sdan         opCompare.pLeft = pDel;
44682dcef11bSdrh         pTest = &opCompare;
44698b1db07fSdrh         /* Ticket b351d95f9cd5ef17e9d9dbae18f5ca8611190001:
44708b1db07fSdrh         ** The value in regFree1 might get SCopy-ed into the file result.
44718b1db07fSdrh         ** So make sure that the regFree1 register is not reused for other
44728b1db07fSdrh         ** purposes and possibly overwritten.  */
44738b1db07fSdrh         regFree1 = 0;
4474cce7d176Sdrh       }
4475c5cd1249Sdrh       for(i=0; i<nExpr-1; i=i+2){
44762dcef11bSdrh         if( pX ){
44771bd10f8aSdrh           assert( pTest!=0 );
44782dcef11bSdrh           opCompare.pRight = aListelem[i].pExpr;
4479f5905aa7Sdrh         }else{
44802dcef11bSdrh           pTest = aListelem[i].pExpr;
448117a7f8ddSdrh         }
4482ec4ccdbcSdrh         nextCase = sqlite3VdbeMakeLabel(pParse);
448333cd4909Sdrh         testcase( pTest->op==TK_COLUMN );
44842dcef11bSdrh         sqlite3ExprIfFalse(pParse, pTest, nextCase, SQLITE_JUMPIFNULL);
4485c5499befSdrh         testcase( aListelem[i+1].pExpr->op==TK_COLUMN );
44869de221dfSdrh         sqlite3ExprCode(pParse, aListelem[i+1].pExpr, target);
4487076e85f5Sdrh         sqlite3VdbeGoto(v, endLabel);
44882dcef11bSdrh         sqlite3VdbeResolveLabel(v, nextCase);
4489f570f011Sdrh       }
4490c5cd1249Sdrh       if( (nExpr&1)!=0 ){
4491c5cd1249Sdrh         sqlite3ExprCode(pParse, pEList->a[nExpr-1].pExpr, target);
449217a7f8ddSdrh       }else{
44939de221dfSdrh         sqlite3VdbeAddOp2(v, OP_Null, 0, target);
449417a7f8ddSdrh       }
44958b65e591Sdan       sqlite3ExprDelete(db, pDel);
449692a27f7bSdrh       setDoNotMergeFlagOnCopy(v);
44972dcef11bSdrh       sqlite3VdbeResolveLabel(v, endLabel);
44986f34903eSdanielk1977       break;
44996f34903eSdanielk1977     }
45005338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_TRIGGER
45016f34903eSdanielk1977     case TK_RAISE: {
45021194904bSdrh       assert( pExpr->affExpr==OE_Rollback
45031194904bSdrh            || pExpr->affExpr==OE_Abort
45041194904bSdrh            || pExpr->affExpr==OE_Fail
45051194904bSdrh            || pExpr->affExpr==OE_Ignore
4506165921a7Sdan       );
45079e5fdc41Sdrh       if( !pParse->pTriggerTab && !pParse->nested ){
4508e0af83acSdan         sqlite3ErrorMsg(pParse,
4509e0af83acSdan                        "RAISE() may only be used within a trigger-program");
4510e0af83acSdan         return 0;
4511e0af83acSdan       }
45121194904bSdrh       if( pExpr->affExpr==OE_Abort ){
4513e0af83acSdan         sqlite3MayAbort(pParse);
4514e0af83acSdan       }
451533e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
45161194904bSdrh       if( pExpr->affExpr==OE_Ignore ){
4517e0af83acSdan         sqlite3VdbeAddOp4(
4518e0af83acSdan             v, OP_Halt, SQLITE_OK, OE_Ignore, 0, pExpr->u.zToken,0);
4519688852abSdrh         VdbeCoverage(v);
4520e0af83acSdan       }else{
45219e5fdc41Sdrh         sqlite3HaltConstraint(pParse,
45229e5fdc41Sdrh              pParse->pTriggerTab ? SQLITE_CONSTRAINT_TRIGGER : SQLITE_ERROR,
45231194904bSdrh              pExpr->affExpr, pExpr->u.zToken, 0, 0);
4524e0af83acSdan       }
4525e0af83acSdan 
4526ffe07b2dSdrh       break;
452717a7f8ddSdrh     }
45285338a5f7Sdanielk1977 #endif
4529ffe07b2dSdrh   }
45302dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
45312dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
45322dcef11bSdrh   return inReg;
45335b6afba9Sdrh }
45342dcef11bSdrh 
45352dcef11bSdrh /*
45369b258c54Sdrh ** Generate code that will evaluate expression pExpr just one time
45379b258c54Sdrh ** per prepared statement execution.
45389b258c54Sdrh **
45399b258c54Sdrh ** If the expression uses functions (that might throw an exception) then
45409b258c54Sdrh ** guard them with an OP_Once opcode to ensure that the code is only executed
45419b258c54Sdrh ** once. If no functions are involved, then factor the code out and put it at
45429b258c54Sdrh ** the end of the prepared statement in the initialization section.
45431e9b53f9Sdrh **
4544ad879ffdSdrh ** If regDest>=0 then the result is always stored in that register and the
4545ad879ffdSdrh ** result is not reusable.  If regDest<0 then this routine is free to
4546ad879ffdSdrh ** store the value whereever it wants.  The register where the expression
45479b258c54Sdrh ** is stored is returned.  When regDest<0, two identical expressions might
45489b258c54Sdrh ** code to the same register, if they do not contain function calls and hence
45499b258c54Sdrh ** are factored out into the initialization section at the end of the
45509b258c54Sdrh ** prepared statement.
4551d1a01edaSdrh */
45529b258c54Sdrh int sqlite3ExprCodeRunJustOnce(
4553d673cddaSdrh   Parse *pParse,    /* Parsing context */
4554d673cddaSdrh   Expr *pExpr,      /* The expression to code when the VDBE initializes */
4555ad879ffdSdrh   int regDest       /* Store the value in this register */
4556d673cddaSdrh ){
4557d1a01edaSdrh   ExprList *p;
4558d9f158e7Sdrh   assert( ConstFactorOk(pParse) );
4559d1a01edaSdrh   p = pParse->pConstExpr;
4560ad879ffdSdrh   if( regDest<0 && p ){
45611e9b53f9Sdrh     struct ExprList_item *pItem;
45621e9b53f9Sdrh     int i;
45631e9b53f9Sdrh     for(pItem=p->a, i=p->nExpr; i>0; pItem++, i--){
45645aa550cfSdan       if( pItem->reusable && sqlite3ExprCompare(0,pItem->pExpr,pExpr,-1)==0 ){
45651e9b53f9Sdrh         return pItem->u.iConstExprReg;
45661e9b53f9Sdrh       }
45671e9b53f9Sdrh     }
45681e9b53f9Sdrh   }
4569d1a01edaSdrh   pExpr = sqlite3ExprDup(pParse->db, pExpr, 0);
457038dfbdaeSdrh   if( pExpr!=0 && ExprHasProperty(pExpr, EP_HasFunc) ){
457138dfbdaeSdrh     Vdbe *v = pParse->pVdbe;
457238dfbdaeSdrh     int addr;
457338dfbdaeSdrh     assert( v );
457438dfbdaeSdrh     addr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
457538dfbdaeSdrh     pParse->okConstFactor = 0;
457638dfbdaeSdrh     if( !pParse->db->mallocFailed ){
45779b258c54Sdrh       if( regDest<0 ) regDest = ++pParse->nMem;
457838dfbdaeSdrh       sqlite3ExprCode(pParse, pExpr, regDest);
457938dfbdaeSdrh     }
458038dfbdaeSdrh     pParse->okConstFactor = 1;
458138dfbdaeSdrh     sqlite3ExprDelete(pParse->db, pExpr);
458238dfbdaeSdrh     sqlite3VdbeJumpHere(v, addr);
458338dfbdaeSdrh   }else{
4584d1a01edaSdrh     p = sqlite3ExprListAppend(pParse, p, pExpr);
4585d673cddaSdrh     if( p ){
4586d673cddaSdrh        struct ExprList_item *pItem = &p->a[p->nExpr-1];
4587ad879ffdSdrh        pItem->reusable = regDest<0;
45889b258c54Sdrh        if( regDest<0 ) regDest = ++pParse->nMem;
4589d673cddaSdrh        pItem->u.iConstExprReg = regDest;
4590d673cddaSdrh     }
4591d1a01edaSdrh     pParse->pConstExpr = p;
459238dfbdaeSdrh   }
45931e9b53f9Sdrh   return regDest;
4594d1a01edaSdrh }
4595d1a01edaSdrh 
4596d1a01edaSdrh /*
45972dcef11bSdrh ** Generate code to evaluate an expression and store the results
45982dcef11bSdrh ** into a register.  Return the register number where the results
45992dcef11bSdrh ** are stored.
46002dcef11bSdrh **
46012dcef11bSdrh ** If the register is a temporary register that can be deallocated,
4602678ccce8Sdrh ** then write its number into *pReg.  If the result register is not
46032dcef11bSdrh ** a temporary, then set *pReg to zero.
4604f30a969bSdrh **
4605f30a969bSdrh ** If pExpr is a constant, then this routine might generate this
4606f30a969bSdrh ** code to fill the register in the initialization section of the
4607f30a969bSdrh ** VDBE program, in order to factor it out of the evaluation loop.
46082dcef11bSdrh */
46092dcef11bSdrh int sqlite3ExprCodeTemp(Parse *pParse, Expr *pExpr, int *pReg){
4610f30a969bSdrh   int r2;
46110d950af3Sdrh   pExpr = sqlite3ExprSkipCollateAndLikely(pExpr);
4612d9f158e7Sdrh   if( ConstFactorOk(pParse)
4613f30a969bSdrh    && pExpr->op!=TK_REGISTER
4614f30a969bSdrh    && sqlite3ExprIsConstantNotJoin(pExpr)
4615f30a969bSdrh   ){
4616f30a969bSdrh     *pReg  = 0;
46179b258c54Sdrh     r2 = sqlite3ExprCodeRunJustOnce(pParse, pExpr, -1);
4618f30a969bSdrh   }else{
46192dcef11bSdrh     int r1 = sqlite3GetTempReg(pParse);
4620f30a969bSdrh     r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
46212dcef11bSdrh     if( r2==r1 ){
46222dcef11bSdrh       *pReg = r1;
46232dcef11bSdrh     }else{
46242dcef11bSdrh       sqlite3ReleaseTempReg(pParse, r1);
46252dcef11bSdrh       *pReg = 0;
46262dcef11bSdrh     }
4627f30a969bSdrh   }
46282dcef11bSdrh   return r2;
46292dcef11bSdrh }
46302dcef11bSdrh 
46312dcef11bSdrh /*
46322dcef11bSdrh ** Generate code that will evaluate expression pExpr and store the
46332dcef11bSdrh ** results in register target.  The results are guaranteed to appear
46342dcef11bSdrh ** in register target.
46352dcef11bSdrh */
463605a86c5cSdrh void sqlite3ExprCode(Parse *pParse, Expr *pExpr, int target){
46379cbf3425Sdrh   int inReg;
46389cbf3425Sdrh 
4639e7375bfaSdrh   assert( pExpr==0 || !ExprHasVVAProperty(pExpr,EP_Immutable) );
46409cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
46411c75c9d7Sdrh   assert( pParse->pVdbe!=0 || pParse->db->mallocFailed );
4642b639a209Sdrh   if( pParse->pVdbe==0 ) return;
4643b639a209Sdrh   inReg = sqlite3ExprCodeTarget(pParse, pExpr, target);
4644b639a209Sdrh   if( inReg!=target ){
4645629b88c6Sdrh     u8 op;
4646629b88c6Sdrh     if( ExprHasProperty(pExpr,EP_Subquery) ){
4647629b88c6Sdrh       op = OP_Copy;
4648629b88c6Sdrh     }else{
4649629b88c6Sdrh       op = OP_SCopy;
4650629b88c6Sdrh     }
4651629b88c6Sdrh     sqlite3VdbeAddOp2(pParse->pVdbe, op, inReg, target);
465217a7f8ddSdrh   }
4653ebc16717Sdrh }
4654cce7d176Sdrh 
4655cce7d176Sdrh /*
46561c75c9d7Sdrh ** Make a transient copy of expression pExpr and then code it using
46571c75c9d7Sdrh ** sqlite3ExprCode().  This routine works just like sqlite3ExprCode()
46581c75c9d7Sdrh ** except that the input expression is guaranteed to be unchanged.
46591c75c9d7Sdrh */
46601c75c9d7Sdrh void sqlite3ExprCodeCopy(Parse *pParse, Expr *pExpr, int target){
46611c75c9d7Sdrh   sqlite3 *db = pParse->db;
46621c75c9d7Sdrh   pExpr = sqlite3ExprDup(db, pExpr, 0);
46631c75c9d7Sdrh   if( !db->mallocFailed ) sqlite3ExprCode(pParse, pExpr, target);
46641c75c9d7Sdrh   sqlite3ExprDelete(db, pExpr);
46651c75c9d7Sdrh }
46661c75c9d7Sdrh 
46671c75c9d7Sdrh /*
466805a86c5cSdrh ** Generate code that will evaluate expression pExpr and store the
466905a86c5cSdrh ** results in register target.  The results are guaranteed to appear
467005a86c5cSdrh ** in register target.  If the expression is constant, then this routine
467105a86c5cSdrh ** might choose to code the expression at initialization time.
467205a86c5cSdrh */
467305a86c5cSdrh void sqlite3ExprCodeFactorable(Parse *pParse, Expr *pExpr, int target){
4674b8b06690Sdrh   if( pParse->okConstFactor && sqlite3ExprIsConstantNotJoin(pExpr) ){
46759b258c54Sdrh     sqlite3ExprCodeRunJustOnce(pParse, pExpr, target);
467605a86c5cSdrh   }else{
4677088489e8Sdrh     sqlite3ExprCodeCopy(pParse, pExpr, target);
467805a86c5cSdrh   }
4679cce7d176Sdrh }
4680cce7d176Sdrh 
4681cce7d176Sdrh /*
4682268380caSdrh ** Generate code that pushes the value of every element of the given
46839cbf3425Sdrh ** expression list into a sequence of registers beginning at target.
4684268380caSdrh **
46853df6c3b1Sdrh ** Return the number of elements evaluated.  The number returned will
46863df6c3b1Sdrh ** usually be pList->nExpr but might be reduced if SQLITE_ECEL_OMITREF
46873df6c3b1Sdrh ** is defined.
4688d1a01edaSdrh **
4689d1a01edaSdrh ** The SQLITE_ECEL_DUP flag prevents the arguments from being
4690d1a01edaSdrh ** filled using OP_SCopy.  OP_Copy must be used instead.
4691d1a01edaSdrh **
4692d1a01edaSdrh ** The SQLITE_ECEL_FACTOR argument allows constant arguments to be
4693d1a01edaSdrh ** factored out into initialization code.
4694b0df9634Sdrh **
4695b0df9634Sdrh ** The SQLITE_ECEL_REF flag means that expressions in the list with
4696b0df9634Sdrh ** ExprList.a[].u.x.iOrderByCol>0 have already been evaluated and stored
4697b0df9634Sdrh ** in registers at srcReg, and so the value can be copied from there.
46983df6c3b1Sdrh ** If SQLITE_ECEL_OMITREF is also set, then the values with u.x.iOrderByCol>0
46993df6c3b1Sdrh ** are simply omitted rather than being copied from srcReg.
4700268380caSdrh */
47014adee20fSdanielk1977 int sqlite3ExprCodeExprList(
4702268380caSdrh   Parse *pParse,     /* Parsing context */
4703389a1adbSdrh   ExprList *pList,   /* The expression list to be coded */
4704191b54cbSdrh   int target,        /* Where to write results */
47055579d59fSdrh   int srcReg,        /* Source registers if SQLITE_ECEL_REF */
4706d1a01edaSdrh   u8 flags           /* SQLITE_ECEL_* flags */
4707268380caSdrh ){
4708268380caSdrh   struct ExprList_item *pItem;
47095579d59fSdrh   int i, j, n;
4710d1a01edaSdrh   u8 copyOp = (flags & SQLITE_ECEL_DUP) ? OP_Copy : OP_SCopy;
47115579d59fSdrh   Vdbe *v = pParse->pVdbe;
47129d8b3072Sdrh   assert( pList!=0 );
47139cbf3425Sdrh   assert( target>0 );
4714d81a142bSdrh   assert( pParse->pVdbe!=0 );  /* Never gets this far otherwise */
4715268380caSdrh   n = pList->nExpr;
4716d9f158e7Sdrh   if( !ConstFactorOk(pParse) ) flags &= ~SQLITE_ECEL_FACTOR;
4717191b54cbSdrh   for(pItem=pList->a, i=0; i<n; i++, pItem++){
47187445ffe2Sdrh     Expr *pExpr = pItem->pExpr;
471924e25d32Sdan #ifdef SQLITE_ENABLE_SORTER_REFERENCES
472024e25d32Sdan     if( pItem->bSorterRef ){
472124e25d32Sdan       i--;
472224e25d32Sdan       n--;
472324e25d32Sdan     }else
472424e25d32Sdan #endif
4725257c13faSdan     if( (flags & SQLITE_ECEL_REF)!=0 && (j = pItem->u.x.iOrderByCol)>0 ){
4726257c13faSdan       if( flags & SQLITE_ECEL_OMITREF ){
4727257c13faSdan         i--;
4728257c13faSdan         n--;
4729257c13faSdan       }else{
47305579d59fSdrh         sqlite3VdbeAddOp2(v, copyOp, j+srcReg-1, target+i);
4731257c13faSdan       }
4732b8b06690Sdrh     }else if( (flags & SQLITE_ECEL_FACTOR)!=0
4733b8b06690Sdrh            && sqlite3ExprIsConstantNotJoin(pExpr)
4734b8b06690Sdrh     ){
47359b258c54Sdrh       sqlite3ExprCodeRunJustOnce(pParse, pExpr, target+i);
4736d1a01edaSdrh     }else{
47377445ffe2Sdrh       int inReg = sqlite3ExprCodeTarget(pParse, pExpr, target+i);
4738746fd9ccSdrh       if( inReg!=target+i ){
47394eded604Sdrh         VdbeOp *pOp;
47404eded604Sdrh         if( copyOp==OP_Copy
47414eded604Sdrh          && (pOp=sqlite3VdbeGetOp(v, -1))->opcode==OP_Copy
47424eded604Sdrh          && pOp->p1+pOp->p3+1==inReg
47434eded604Sdrh          && pOp->p2+pOp->p3+1==target+i
474490996885Sdrh          && pOp->p5==0  /* The do-not-merge flag must be clear */
47454eded604Sdrh         ){
47464eded604Sdrh           pOp->p3++;
47474eded604Sdrh         }else{
47484eded604Sdrh           sqlite3VdbeAddOp2(v, copyOp, inReg, target+i);
47494eded604Sdrh         }
4750d1a01edaSdrh       }
4751d176611bSdrh     }
4752268380caSdrh   }
4753f9b596ebSdrh   return n;
4754268380caSdrh }
4755268380caSdrh 
4756268380caSdrh /*
475736c563a2Sdrh ** Generate code for a BETWEEN operator.
475836c563a2Sdrh **
475936c563a2Sdrh **    x BETWEEN y AND z
476036c563a2Sdrh **
476136c563a2Sdrh ** The above is equivalent to
476236c563a2Sdrh **
476336c563a2Sdrh **    x>=y AND x<=z
476436c563a2Sdrh **
476536c563a2Sdrh ** Code it as such, taking care to do the common subexpression
476660ec914cSpeter.d.reid ** elimination of x.
476784b19a3dSdrh **
476884b19a3dSdrh ** The xJumpIf parameter determines details:
476984b19a3dSdrh **
477084b19a3dSdrh **    NULL:                   Store the boolean result in reg[dest]
477184b19a3dSdrh **    sqlite3ExprIfTrue:      Jump to dest if true
477284b19a3dSdrh **    sqlite3ExprIfFalse:     Jump to dest if false
477384b19a3dSdrh **
477484b19a3dSdrh ** The jumpIfNull parameter is ignored if xJumpIf is NULL.
477536c563a2Sdrh */
477636c563a2Sdrh static void exprCodeBetween(
477736c563a2Sdrh   Parse *pParse,    /* Parsing and code generating context */
477836c563a2Sdrh   Expr *pExpr,      /* The BETWEEN expression */
477984b19a3dSdrh   int dest,         /* Jump destination or storage location */
478084b19a3dSdrh   void (*xJump)(Parse*,Expr*,int,int), /* Action to take */
478136c563a2Sdrh   int jumpIfNull    /* Take the jump if the BETWEEN is NULL */
478236c563a2Sdrh ){
478336c563a2Sdrh   Expr exprAnd;     /* The AND operator in  x>=y AND x<=z  */
478436c563a2Sdrh   Expr compLeft;    /* The  x>=y  term */
478536c563a2Sdrh   Expr compRight;   /* The  x<=z  term */
4786db45bd5eSdrh   int regFree1 = 0; /* Temporary use register */
47878b65e591Sdan   Expr *pDel = 0;
47888b65e591Sdan   sqlite3 *db = pParse->db;
478984b19a3dSdrh 
479071c57db0Sdan   memset(&compLeft, 0, sizeof(Expr));
479171c57db0Sdan   memset(&compRight, 0, sizeof(Expr));
479271c57db0Sdan   memset(&exprAnd, 0, sizeof(Expr));
4793db45bd5eSdrh 
4794db45bd5eSdrh   assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
47958b65e591Sdan   pDel = sqlite3ExprDup(db, pExpr->pLeft, 0);
47968b65e591Sdan   if( db->mallocFailed==0 ){
479736c563a2Sdrh     exprAnd.op = TK_AND;
479836c563a2Sdrh     exprAnd.pLeft = &compLeft;
479936c563a2Sdrh     exprAnd.pRight = &compRight;
480036c563a2Sdrh     compLeft.op = TK_GE;
48018b65e591Sdan     compLeft.pLeft = pDel;
480236c563a2Sdrh     compLeft.pRight = pExpr->x.pList->a[0].pExpr;
480336c563a2Sdrh     compRight.op = TK_LE;
48048b65e591Sdan     compRight.pLeft = pDel;
480536c563a2Sdrh     compRight.pRight = pExpr->x.pList->a[1].pExpr;
48068b65e591Sdan     exprToRegister(pDel, exprCodeVector(pParse, pDel, &regFree1));
480784b19a3dSdrh     if( xJump ){
480884b19a3dSdrh       xJump(pParse, &exprAnd, dest, jumpIfNull);
480936c563a2Sdrh     }else{
481036fd41e5Sdrh       /* Mark the expression is being from the ON or USING clause of a join
481136fd41e5Sdrh       ** so that the sqlite3ExprCodeTarget() routine will not attempt to move
481236fd41e5Sdrh       ** it into the Parse.pConstExpr list.  We should use a new bit for this,
481336fd41e5Sdrh       ** for clarity, but we are out of bits in the Expr.flags field so we
481436fd41e5Sdrh       ** have to reuse the EP_FromJoin bit.  Bummer. */
48158b65e591Sdan       pDel->flags |= EP_FromJoin;
481671c57db0Sdan       sqlite3ExprCodeTarget(pParse, &exprAnd, dest);
481736c563a2Sdrh     }
4818db45bd5eSdrh     sqlite3ReleaseTempReg(pParse, regFree1);
48198b65e591Sdan   }
48208b65e591Sdan   sqlite3ExprDelete(db, pDel);
482136c563a2Sdrh 
482236c563a2Sdrh   /* Ensure adequate test coverage */
4823db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull==0 && regFree1==0 );
4824db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull==0 && regFree1!=0 );
4825db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull!=0 && regFree1==0 );
4826db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull!=0 && regFree1!=0 );
4827db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1==0 );
4828db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1!=0 );
4829db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1==0 );
4830db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1!=0 );
483184b19a3dSdrh   testcase( xJump==0 );
483236c563a2Sdrh }
483336c563a2Sdrh 
483436c563a2Sdrh /*
4835cce7d176Sdrh ** Generate code for a boolean expression such that a jump is made
4836cce7d176Sdrh ** to the label "dest" if the expression is true but execution
4837cce7d176Sdrh ** continues straight thru if the expression is false.
4838f5905aa7Sdrh **
4839f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false), then
484035573356Sdrh ** take the jump if the jumpIfNull flag is SQLITE_JUMPIFNULL.
4841f2bc013cSdrh **
4842f2bc013cSdrh ** This code depends on the fact that certain token values (ex: TK_EQ)
4843f2bc013cSdrh ** are the same as opcode values (ex: OP_Eq) that implement the corresponding
4844f2bc013cSdrh ** operation.  Special comments in vdbe.c and the mkopcodeh.awk script in
4845f2bc013cSdrh ** the make process cause these values to align.  Assert()s in the code
4846f2bc013cSdrh ** below verify that the numbers are aligned correctly.
4847cce7d176Sdrh */
48484adee20fSdanielk1977 void sqlite3ExprIfTrue(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
4849cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
4850cce7d176Sdrh   int op = 0;
48512dcef11bSdrh   int regFree1 = 0;
48522dcef11bSdrh   int regFree2 = 0;
48532dcef11bSdrh   int r1, r2;
48542dcef11bSdrh 
485535573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
485648864df9Smistachkin   if( NEVER(v==0) )     return;  /* Existence of VDBE checked by caller */
485733cd4909Sdrh   if( NEVER(pExpr==0) ) return;  /* No way this can happen */
4858e7375bfaSdrh   assert( !ExprHasVVAProperty(pExpr, EP_Immutable) );
4859f2bc013cSdrh   op = pExpr->op;
48607b35a77bSdan   switch( op ){
486117180fcaSdrh     case TK_AND:
486217180fcaSdrh     case TK_OR: {
486317180fcaSdrh       Expr *pAlt = sqlite3ExprSimplifiedAndOr(pExpr);
486417180fcaSdrh       if( pAlt!=pExpr ){
486517180fcaSdrh         sqlite3ExprIfTrue(pParse, pAlt, dest, jumpIfNull);
486617180fcaSdrh       }else if( op==TK_AND ){
4867ec4ccdbcSdrh         int d2 = sqlite3VdbeMakeLabel(pParse);
4868c5499befSdrh         testcase( jumpIfNull==0 );
486917180fcaSdrh         sqlite3ExprIfFalse(pParse, pExpr->pLeft, d2,
487017180fcaSdrh                            jumpIfNull^SQLITE_JUMPIFNULL);
48714adee20fSdanielk1977         sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
48724adee20fSdanielk1977         sqlite3VdbeResolveLabel(v, d2);
487317180fcaSdrh       }else{
4874c5499befSdrh         testcase( jumpIfNull==0 );
48754adee20fSdanielk1977         sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
48764adee20fSdanielk1977         sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
487717180fcaSdrh       }
4878cce7d176Sdrh       break;
4879cce7d176Sdrh     }
4880cce7d176Sdrh     case TK_NOT: {
4881c5499befSdrh       testcase( jumpIfNull==0 );
48824adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
4883cce7d176Sdrh       break;
4884cce7d176Sdrh     }
48858abed7b9Sdrh     case TK_TRUTH: {
488696acafbeSdrh       int isNot;      /* IS NOT TRUE or IS NOT FALSE */
488796acafbeSdrh       int isTrue;     /* IS TRUE or IS NOT TRUE */
4888007c843bSdrh       testcase( jumpIfNull==0 );
48898abed7b9Sdrh       isNot = pExpr->op2==TK_ISNOT;
489096acafbeSdrh       isTrue = sqlite3ExprTruthValue(pExpr->pRight);
489143c4ac8bSdrh       testcase( isTrue && isNot );
489296acafbeSdrh       testcase( !isTrue && isNot );
489343c4ac8bSdrh       if( isTrue ^ isNot ){
48948abed7b9Sdrh         sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
48958abed7b9Sdrh                           isNot ? SQLITE_JUMPIFNULL : 0);
48968abed7b9Sdrh       }else{
48978abed7b9Sdrh         sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
48988abed7b9Sdrh                            isNot ? SQLITE_JUMPIFNULL : 0);
48998abed7b9Sdrh       }
4900007c843bSdrh       break;
4901007c843bSdrh     }
4902de845c2fSdrh     case TK_IS:
4903de845c2fSdrh     case TK_ISNOT:
4904de845c2fSdrh       testcase( op==TK_IS );
4905de845c2fSdrh       testcase( op==TK_ISNOT );
4906de845c2fSdrh       op = (op==TK_IS) ? TK_EQ : TK_NE;
4907de845c2fSdrh       jumpIfNull = SQLITE_NULLEQ;
490808b92086Sdrh       /* no break */ deliberate_fall_through
4909cce7d176Sdrh     case TK_LT:
4910cce7d176Sdrh     case TK_LE:
4911cce7d176Sdrh     case TK_GT:
4912cce7d176Sdrh     case TK_GE:
4913cce7d176Sdrh     case TK_NE:
49140ac65892Sdrh     case TK_EQ: {
4915625015e0Sdan       if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
4916c5499befSdrh       testcase( jumpIfNull==0 );
4917b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4918b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
491935573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
4920898c527eSdrh                   r1, r2, dest, jumpIfNull, ExprHasProperty(pExpr,EP_Commuted));
49217d176105Sdrh       assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
49227d176105Sdrh       assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
49237d176105Sdrh       assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
49247d176105Sdrh       assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
4925de845c2fSdrh       assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4926de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4927de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4928de845c2fSdrh       assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4929de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
4930de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
49316a2fe093Sdrh       testcase( regFree1==0 );
49326a2fe093Sdrh       testcase( regFree2==0 );
49336a2fe093Sdrh       break;
49346a2fe093Sdrh     }
4935cce7d176Sdrh     case TK_ISNULL:
4936cce7d176Sdrh     case TK_NOTNULL: {
49377d176105Sdrh       assert( TK_ISNULL==OP_IsNull );   testcase( op==TK_ISNULL );
49387d176105Sdrh       assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
49392dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
49402dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
49417d176105Sdrh       VdbeCoverageIf(v, op==TK_ISNULL);
49427d176105Sdrh       VdbeCoverageIf(v, op==TK_NOTNULL);
4943c5499befSdrh       testcase( regFree1==0 );
4944cce7d176Sdrh       break;
4945cce7d176Sdrh     }
4946fef5208cSdrh     case TK_BETWEEN: {
49475c03f30aSdrh       testcase( jumpIfNull==0 );
494871c57db0Sdan       exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfTrue, jumpIfNull);
4949fef5208cSdrh       break;
4950fef5208cSdrh     }
4951bb201344Sshaneh #ifndef SQLITE_OMIT_SUBQUERY
4952e3365e6cSdrh     case TK_IN: {
4953ec4ccdbcSdrh       int destIfFalse = sqlite3VdbeMakeLabel(pParse);
4954e3365e6cSdrh       int destIfNull = jumpIfNull ? dest : destIfFalse;
4955e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
4956076e85f5Sdrh       sqlite3VdbeGoto(v, dest);
4957e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
4958e3365e6cSdrh       break;
4959e3365e6cSdrh     }
4960bb201344Sshaneh #endif
4961cce7d176Sdrh     default: {
49627b35a77bSdan     default_expr:
4963ad31727fSdrh       if( ExprAlwaysTrue(pExpr) ){
4964076e85f5Sdrh         sqlite3VdbeGoto(v, dest);
4965ad31727fSdrh       }else if( ExprAlwaysFalse(pExpr) ){
4966991a1985Sdrh         /* No-op */
4967991a1985Sdrh       }else{
49682dcef11bSdrh         r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
49692dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_If, r1, dest, jumpIfNull!=0);
4970688852abSdrh         VdbeCoverage(v);
4971c5499befSdrh         testcase( regFree1==0 );
4972c5499befSdrh         testcase( jumpIfNull==0 );
4973991a1985Sdrh       }
4974cce7d176Sdrh       break;
4975cce7d176Sdrh     }
4976cce7d176Sdrh   }
49772dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
49782dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
4979cce7d176Sdrh }
4980cce7d176Sdrh 
4981cce7d176Sdrh /*
498266b89c8fSdrh ** Generate code for a boolean expression such that a jump is made
4983cce7d176Sdrh ** to the label "dest" if the expression is false but execution
4984cce7d176Sdrh ** continues straight thru if the expression is true.
4985f5905aa7Sdrh **
4986f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false) then
498735573356Sdrh ** jump if jumpIfNull is SQLITE_JUMPIFNULL or fall through if jumpIfNull
498835573356Sdrh ** is 0.
4989cce7d176Sdrh */
49904adee20fSdanielk1977 void sqlite3ExprIfFalse(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
4991cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
4992cce7d176Sdrh   int op = 0;
49932dcef11bSdrh   int regFree1 = 0;
49942dcef11bSdrh   int regFree2 = 0;
49952dcef11bSdrh   int r1, r2;
49962dcef11bSdrh 
499735573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
499848864df9Smistachkin   if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
499933cd4909Sdrh   if( pExpr==0 )    return;
5000e7375bfaSdrh   assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
5001f2bc013cSdrh 
5002f2bc013cSdrh   /* The value of pExpr->op and op are related as follows:
5003f2bc013cSdrh   **
5004f2bc013cSdrh   **       pExpr->op            op
5005f2bc013cSdrh   **       ---------          ----------
5006f2bc013cSdrh   **       TK_ISNULL          OP_NotNull
5007f2bc013cSdrh   **       TK_NOTNULL         OP_IsNull
5008f2bc013cSdrh   **       TK_NE              OP_Eq
5009f2bc013cSdrh   **       TK_EQ              OP_Ne
5010f2bc013cSdrh   **       TK_GT              OP_Le
5011f2bc013cSdrh   **       TK_LE              OP_Gt
5012f2bc013cSdrh   **       TK_GE              OP_Lt
5013f2bc013cSdrh   **       TK_LT              OP_Ge
5014f2bc013cSdrh   **
5015f2bc013cSdrh   ** For other values of pExpr->op, op is undefined and unused.
5016f2bc013cSdrh   ** The value of TK_ and OP_ constants are arranged such that we
5017f2bc013cSdrh   ** can compute the mapping above using the following expression.
5018f2bc013cSdrh   ** Assert()s verify that the computation is correct.
5019f2bc013cSdrh   */
5020f2bc013cSdrh   op = ((pExpr->op+(TK_ISNULL&1))^1)-(TK_ISNULL&1);
5021f2bc013cSdrh 
5022f2bc013cSdrh   /* Verify correct alignment of TK_ and OP_ constants
5023f2bc013cSdrh   */
5024f2bc013cSdrh   assert( pExpr->op!=TK_ISNULL || op==OP_NotNull );
5025f2bc013cSdrh   assert( pExpr->op!=TK_NOTNULL || op==OP_IsNull );
5026f2bc013cSdrh   assert( pExpr->op!=TK_NE || op==OP_Eq );
5027f2bc013cSdrh   assert( pExpr->op!=TK_EQ || op==OP_Ne );
5028f2bc013cSdrh   assert( pExpr->op!=TK_LT || op==OP_Ge );
5029f2bc013cSdrh   assert( pExpr->op!=TK_LE || op==OP_Gt );
5030f2bc013cSdrh   assert( pExpr->op!=TK_GT || op==OP_Le );
5031f2bc013cSdrh   assert( pExpr->op!=TK_GE || op==OP_Lt );
5032f2bc013cSdrh 
5033ba00e30aSdan   switch( pExpr->op ){
503417180fcaSdrh     case TK_AND:
503517180fcaSdrh     case TK_OR: {
503617180fcaSdrh       Expr *pAlt = sqlite3ExprSimplifiedAndOr(pExpr);
503717180fcaSdrh       if( pAlt!=pExpr ){
503817180fcaSdrh         sqlite3ExprIfFalse(pParse, pAlt, dest, jumpIfNull);
503917180fcaSdrh       }else if( pExpr->op==TK_AND ){
5040c5499befSdrh         testcase( jumpIfNull==0 );
50414adee20fSdanielk1977         sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
50424adee20fSdanielk1977         sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
504317180fcaSdrh       }else{
5044ec4ccdbcSdrh         int d2 = sqlite3VdbeMakeLabel(pParse);
5045c5499befSdrh         testcase( jumpIfNull==0 );
504617180fcaSdrh         sqlite3ExprIfTrue(pParse, pExpr->pLeft, d2,
504717180fcaSdrh                           jumpIfNull^SQLITE_JUMPIFNULL);
50484adee20fSdanielk1977         sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
50494adee20fSdanielk1977         sqlite3VdbeResolveLabel(v, d2);
505017180fcaSdrh       }
5051cce7d176Sdrh       break;
5052cce7d176Sdrh     }
5053cce7d176Sdrh     case TK_NOT: {
50545c03f30aSdrh       testcase( jumpIfNull==0 );
50554adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
5056cce7d176Sdrh       break;
5057cce7d176Sdrh     }
50588abed7b9Sdrh     case TK_TRUTH: {
505996acafbeSdrh       int isNot;   /* IS NOT TRUE or IS NOT FALSE */
506096acafbeSdrh       int isTrue;  /* IS TRUE or IS NOT TRUE */
50618abed7b9Sdrh       testcase( jumpIfNull==0 );
50628abed7b9Sdrh       isNot = pExpr->op2==TK_ISNOT;
506396acafbeSdrh       isTrue = sqlite3ExprTruthValue(pExpr->pRight);
506443c4ac8bSdrh       testcase( isTrue && isNot );
506596acafbeSdrh       testcase( !isTrue && isNot );
506643c4ac8bSdrh       if( isTrue ^ isNot ){
50678abed7b9Sdrh         /* IS TRUE and IS NOT FALSE */
50688abed7b9Sdrh         sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
50698abed7b9Sdrh                            isNot ? 0 : SQLITE_JUMPIFNULL);
50708abed7b9Sdrh 
50718abed7b9Sdrh       }else{
50728abed7b9Sdrh         /* IS FALSE and IS NOT TRUE */
50738abed7b9Sdrh         sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
50748abed7b9Sdrh                           isNot ? 0 : SQLITE_JUMPIFNULL);
50758abed7b9Sdrh       }
5076007c843bSdrh       break;
5077007c843bSdrh     }
5078de845c2fSdrh     case TK_IS:
5079de845c2fSdrh     case TK_ISNOT:
5080de845c2fSdrh       testcase( pExpr->op==TK_IS );
5081de845c2fSdrh       testcase( pExpr->op==TK_ISNOT );
5082de845c2fSdrh       op = (pExpr->op==TK_IS) ? TK_NE : TK_EQ;
5083de845c2fSdrh       jumpIfNull = SQLITE_NULLEQ;
508408b92086Sdrh       /* no break */ deliberate_fall_through
5085cce7d176Sdrh     case TK_LT:
5086cce7d176Sdrh     case TK_LE:
5087cce7d176Sdrh     case TK_GT:
5088cce7d176Sdrh     case TK_GE:
5089cce7d176Sdrh     case TK_NE:
5090cce7d176Sdrh     case TK_EQ: {
5091625015e0Sdan       if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
5092c5499befSdrh       testcase( jumpIfNull==0 );
5093b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
5094b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
509535573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
5096898c527eSdrh                   r1, r2, dest, jumpIfNull,ExprHasProperty(pExpr,EP_Commuted));
50977d176105Sdrh       assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
50987d176105Sdrh       assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
50997d176105Sdrh       assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
51007d176105Sdrh       assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
5101de845c2fSdrh       assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
5102de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
5103de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
5104de845c2fSdrh       assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
5105de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
5106de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
51076a2fe093Sdrh       testcase( regFree1==0 );
51086a2fe093Sdrh       testcase( regFree2==0 );
51096a2fe093Sdrh       break;
51106a2fe093Sdrh     }
5111cce7d176Sdrh     case TK_ISNULL:
5112cce7d176Sdrh     case TK_NOTNULL: {
51132dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
51142dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
51157d176105Sdrh       testcase( op==TK_ISNULL );   VdbeCoverageIf(v, op==TK_ISNULL);
51167d176105Sdrh       testcase( op==TK_NOTNULL );  VdbeCoverageIf(v, op==TK_NOTNULL);
5117c5499befSdrh       testcase( regFree1==0 );
5118cce7d176Sdrh       break;
5119cce7d176Sdrh     }
5120fef5208cSdrh     case TK_BETWEEN: {
51215c03f30aSdrh       testcase( jumpIfNull==0 );
512271c57db0Sdan       exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfFalse, jumpIfNull);
5123fef5208cSdrh       break;
5124fef5208cSdrh     }
5125bb201344Sshaneh #ifndef SQLITE_OMIT_SUBQUERY
5126e3365e6cSdrh     case TK_IN: {
5127e3365e6cSdrh       if( jumpIfNull ){
5128e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, dest);
5129e3365e6cSdrh       }else{
5130ec4ccdbcSdrh         int destIfNull = sqlite3VdbeMakeLabel(pParse);
5131e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, destIfNull);
5132e3365e6cSdrh         sqlite3VdbeResolveLabel(v, destIfNull);
5133e3365e6cSdrh       }
5134e3365e6cSdrh       break;
5135e3365e6cSdrh     }
5136bb201344Sshaneh #endif
5137cce7d176Sdrh     default: {
5138ba00e30aSdan     default_expr:
5139ad31727fSdrh       if( ExprAlwaysFalse(pExpr) ){
5140076e85f5Sdrh         sqlite3VdbeGoto(v, dest);
5141ad31727fSdrh       }else if( ExprAlwaysTrue(pExpr) ){
5142991a1985Sdrh         /* no-op */
5143991a1985Sdrh       }else{
51442dcef11bSdrh         r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
51452dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_IfNot, r1, dest, jumpIfNull!=0);
5146688852abSdrh         VdbeCoverage(v);
5147c5499befSdrh         testcase( regFree1==0 );
5148c5499befSdrh         testcase( jumpIfNull==0 );
5149991a1985Sdrh       }
5150cce7d176Sdrh       break;
5151cce7d176Sdrh     }
5152cce7d176Sdrh   }
51532dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
51542dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
5155cce7d176Sdrh }
51562282792aSdrh 
51572282792aSdrh /*
515872bc8208Sdrh ** Like sqlite3ExprIfFalse() except that a copy is made of pExpr before
515972bc8208Sdrh ** code generation, and that copy is deleted after code generation. This
516072bc8208Sdrh ** ensures that the original pExpr is unchanged.
516172bc8208Sdrh */
516272bc8208Sdrh void sqlite3ExprIfFalseDup(Parse *pParse, Expr *pExpr, int dest,int jumpIfNull){
516372bc8208Sdrh   sqlite3 *db = pParse->db;
516472bc8208Sdrh   Expr *pCopy = sqlite3ExprDup(db, pExpr, 0);
516572bc8208Sdrh   if( db->mallocFailed==0 ){
516672bc8208Sdrh     sqlite3ExprIfFalse(pParse, pCopy, dest, jumpIfNull);
516772bc8208Sdrh   }
516872bc8208Sdrh   sqlite3ExprDelete(db, pCopy);
516972bc8208Sdrh }
517072bc8208Sdrh 
51715aa550cfSdan /*
51725aa550cfSdan ** Expression pVar is guaranteed to be an SQL variable. pExpr may be any
51735aa550cfSdan ** type of expression.
51745aa550cfSdan **
51755aa550cfSdan ** If pExpr is a simple SQL value - an integer, real, string, blob
51765aa550cfSdan ** or NULL value - then the VDBE currently being prepared is configured
51775aa550cfSdan ** to re-prepare each time a new value is bound to variable pVar.
51785aa550cfSdan **
51795aa550cfSdan ** Additionally, if pExpr is a simple SQL value and the value is the
51805aa550cfSdan ** same as that currently bound to variable pVar, non-zero is returned.
51815aa550cfSdan ** Otherwise, if the values are not the same or if pExpr is not a simple
51825aa550cfSdan ** SQL value, zero is returned.
51835aa550cfSdan */
51845aa550cfSdan static int exprCompareVariable(Parse *pParse, Expr *pVar, Expr *pExpr){
51855aa550cfSdan   int res = 0;
5186c0804226Sdrh   int iVar;
5187c0804226Sdrh   sqlite3_value *pL, *pR = 0;
51885aa550cfSdan 
51895aa550cfSdan   sqlite3ValueFromExpr(pParse->db, pExpr, SQLITE_UTF8, SQLITE_AFF_BLOB, &pR);
5190c0804226Sdrh   if( pR ){
5191c0804226Sdrh     iVar = pVar->iColumn;
5192c0804226Sdrh     sqlite3VdbeSetVarmask(pParse->pVdbe, iVar);
5193c0804226Sdrh     pL = sqlite3VdbeGetBoundValue(pParse->pReprepare, iVar, SQLITE_AFF_BLOB);
51945aa307e2Sdrh     if( pL ){
51955aa307e2Sdrh       if( sqlite3_value_type(pL)==SQLITE_TEXT ){
51965aa307e2Sdrh         sqlite3_value_text(pL); /* Make sure the encoding is UTF-8 */
51975aa307e2Sdrh       }
51985aa307e2Sdrh       res =  0==sqlite3MemCompare(pL, pR, 0);
51995aa550cfSdan     }
52005aa550cfSdan     sqlite3ValueFree(pR);
52015aa550cfSdan     sqlite3ValueFree(pL);
52025aa550cfSdan   }
52035aa550cfSdan 
52045aa550cfSdan   return res;
52055aa550cfSdan }
520672bc8208Sdrh 
520772bc8208Sdrh /*
52081d9da70aSdrh ** Do a deep comparison of two expression trees.  Return 0 if the two
52091d9da70aSdrh ** expressions are completely identical.  Return 1 if they differ only
52101d9da70aSdrh ** by a COLLATE operator at the top level.  Return 2 if there are differences
52111d9da70aSdrh ** other than the top-level COLLATE operator.
5212d40aab0eSdrh **
5213619a1305Sdrh ** If any subelement of pB has Expr.iTable==(-1) then it is allowed
5214619a1305Sdrh ** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
5215619a1305Sdrh **
521666518ca7Sdrh ** The pA side might be using TK_REGISTER.  If that is the case and pB is
521766518ca7Sdrh ** not using TK_REGISTER but is otherwise equivalent, then still return 0.
521866518ca7Sdrh **
52191d9da70aSdrh ** Sometimes this routine will return 2 even if the two expressions
5220d40aab0eSdrh ** really are equivalent.  If we cannot prove that the expressions are
52211d9da70aSdrh ** identical, we return 2 just to be safe.  So if this routine
52221d9da70aSdrh ** returns 2, then you do not really know for certain if the two
52231d9da70aSdrh ** expressions are the same.  But if you get a 0 or 1 return, then you
5224d40aab0eSdrh ** can be sure the expressions are the same.  In the places where
52251d9da70aSdrh ** this routine is used, it does not hurt to get an extra 2 - that
5226d40aab0eSdrh ** just might result in some slightly slower code.  But returning
52271d9da70aSdrh ** an incorrect 0 or 1 could lead to a malfunction.
52285aa550cfSdan **
5229c0804226Sdrh ** If pParse is not NULL then TK_VARIABLE terms in pA with bindings in
5230c0804226Sdrh ** pParse->pReprepare can be matched against literals in pB.  The
5231c0804226Sdrh ** pParse->pVdbe->expmask bitmask is updated for each variable referenced.
5232c0804226Sdrh ** If pParse is NULL (the normal case) then any TK_VARIABLE term in
5233c0804226Sdrh ** Argument pParse should normally be NULL. If it is not NULL and pA or
5234c0804226Sdrh ** pB causes a return value of 2.
52352282792aSdrh */
52365aa550cfSdan int sqlite3ExprCompare(Parse *pParse, Expr *pA, Expr *pB, int iTab){
523710d1edf0Sdrh   u32 combinedFlags;
52384b202ae2Sdanielk1977   if( pA==0 || pB==0 ){
52391d9da70aSdrh     return pB==pA ? 0 : 2;
52402282792aSdrh   }
52415aa550cfSdan   if( pParse && pA->op==TK_VARIABLE && exprCompareVariable(pParse, pA, pB) ){
52425aa550cfSdan     return 0;
52435aa550cfSdan   }
524410d1edf0Sdrh   combinedFlags = pA->flags | pB->flags;
524510d1edf0Sdrh   if( combinedFlags & EP_IntValue ){
524610d1edf0Sdrh     if( (pA->flags&pB->flags&EP_IntValue)!=0 && pA->u.iValue==pB->u.iValue ){
524710d1edf0Sdrh       return 0;
524810d1edf0Sdrh     }
52491d9da70aSdrh     return 2;
52506ab3a2ecSdanielk1977   }
525116dd3985Sdan   if( pA->op!=pB->op || pA->op==TK_RAISE ){
52525aa550cfSdan     if( pA->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA->pLeft,pB,iTab)<2 ){
5253ae80ddeaSdrh       return 1;
5254ae80ddeaSdrh     }
52555aa550cfSdan     if( pB->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA,pB->pLeft,iTab)<2 ){
5256ae80ddeaSdrh       return 1;
5257ae80ddeaSdrh     }
5258ae80ddeaSdrh     return 2;
5259ae80ddeaSdrh   }
52602edc5fd7Sdrh   if( pA->op!=TK_COLUMN && pA->op!=TK_AGG_COLUMN && pA->u.zToken ){
52614f9adee2Sdan     if( pA->op==TK_FUNCTION || pA->op==TK_AGG_FUNCTION ){
5262390b88a4Sdrh       if( sqlite3StrICmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
5263eda079cdSdrh #ifndef SQLITE_OMIT_WINDOWFUNC
52644f9adee2Sdan       assert( pA->op==pB->op );
52654f9adee2Sdan       if( ExprHasProperty(pA,EP_WinFunc)!=ExprHasProperty(pB,EP_WinFunc) ){
52664f9adee2Sdan         return 2;
52674f9adee2Sdan       }
5268eda079cdSdrh       if( ExprHasProperty(pA,EP_WinFunc) ){
52694f9adee2Sdan         if( sqlite3WindowCompare(pParse, pA->y.pWin, pB->y.pWin, 1)!=0 ){
52704f9adee2Sdan           return 2;
52714f9adee2Sdan         }
5272eda079cdSdrh       }
5273eda079cdSdrh #endif
5274f20bbc5fSdrh     }else if( pA->op==TK_NULL ){
5275f20bbc5fSdrh       return 0;
5276d5af5420Sdrh     }else if( pA->op==TK_COLLATE ){
5277e79f6299Sdrh       if( sqlite3_stricmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
5278f20bbc5fSdrh     }else if( ALWAYS(pB->u.zToken!=0) && strcmp(pA->u.zToken,pB->u.zToken)!=0 ){
5279d5af5420Sdrh       return 2;
528010d1edf0Sdrh     }
528110d1edf0Sdrh   }
5282898c527eSdrh   if( (pA->flags & (EP_Distinct|EP_Commuted))
5283898c527eSdrh      != (pB->flags & (EP_Distinct|EP_Commuted)) ) return 2;
5284e7375bfaSdrh   if( ALWAYS((combinedFlags & EP_TokenOnly)==0) ){
528510d1edf0Sdrh     if( combinedFlags & EP_xIsSelect ) return 2;
5286efad2e23Sdrh     if( (combinedFlags & EP_FixedCol)==0
5287efad2e23Sdrh      && sqlite3ExprCompare(pParse, pA->pLeft, pB->pLeft, iTab) ) return 2;
52885aa550cfSdan     if( sqlite3ExprCompare(pParse, pA->pRight, pB->pRight, iTab) ) return 2;
5289619a1305Sdrh     if( sqlite3ExprListCompare(pA->x.pList, pB->x.pList, iTab) ) return 2;
529003c5c213Sdrh     if( pA->op!=TK_STRING
529103c5c213Sdrh      && pA->op!=TK_TRUEFALSE
5292e7375bfaSdrh      && ALWAYS((combinedFlags & EP_Reduced)==0)
529303c5c213Sdrh     ){
5294619a1305Sdrh       if( pA->iColumn!=pB->iColumn ) return 2;
52959b258c54Sdrh       if( pA->op2!=pB->op2 && pA->op==TK_TRUTH ) return 2;
52960f28e1bdSdrh       if( pA->op!=TK_IN && pA->iTable!=pB->iTable && pA->iTable!=iTab ){
52970f28e1bdSdrh         return 2;
52980f28e1bdSdrh       }
52991d9da70aSdrh     }
53001d9da70aSdrh   }
53012646da7eSdrh   return 0;
53022646da7eSdrh }
53032282792aSdrh 
53048c6f666bSdrh /*
5305fbb6e9ffSdan ** Compare two ExprList objects.  Return 0 if they are identical, 1
5306fbb6e9ffSdan ** if they are certainly different, or 2 if it is not possible to
5307fbb6e9ffSdan ** determine if they are identical or not.
53088c6f666bSdrh **
5309619a1305Sdrh ** If any subelement of pB has Expr.iTable==(-1) then it is allowed
5310619a1305Sdrh ** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
5311619a1305Sdrh **
53128c6f666bSdrh ** This routine might return non-zero for equivalent ExprLists.  The
53138c6f666bSdrh ** only consequence will be disabled optimizations.  But this routine
53148c6f666bSdrh ** must never return 0 if the two ExprList objects are different, or
53158c6f666bSdrh ** a malfunction will result.
53168c6f666bSdrh **
53178c6f666bSdrh ** Two NULL pointers are considered to be the same.  But a NULL pointer
53188c6f666bSdrh ** always differs from a non-NULL pointer.
53198c6f666bSdrh */
5320619a1305Sdrh int sqlite3ExprListCompare(ExprList *pA, ExprList *pB, int iTab){
53218c6f666bSdrh   int i;
53228c6f666bSdrh   if( pA==0 && pB==0 ) return 0;
53238c6f666bSdrh   if( pA==0 || pB==0 ) return 1;
53248c6f666bSdrh   if( pA->nExpr!=pB->nExpr ) return 1;
53258c6f666bSdrh   for(i=0; i<pA->nExpr; i++){
5326fbb6e9ffSdan     int res;
53278c6f666bSdrh     Expr *pExprA = pA->a[i].pExpr;
53288c6f666bSdrh     Expr *pExprB = pB->a[i].pExpr;
53296e11892dSdan     if( pA->a[i].sortFlags!=pB->a[i].sortFlags ) return 1;
5330fbb6e9ffSdan     if( (res = sqlite3ExprCompare(0, pExprA, pExprB, iTab)) ) return res;
53318c6f666bSdrh   }
53328c6f666bSdrh   return 0;
53338c6f666bSdrh }
533413449892Sdrh 
53352282792aSdrh /*
5336f9463dfbSdrh ** Like sqlite3ExprCompare() except COLLATE operators at the top-level
5337f9463dfbSdrh ** are ignored.
5338f9463dfbSdrh */
5339f9463dfbSdrh int sqlite3ExprCompareSkip(Expr *pA, Expr *pB, int iTab){
53405aa550cfSdan   return sqlite3ExprCompare(0,
53410d950af3Sdrh              sqlite3ExprSkipCollateAndLikely(pA),
53420d950af3Sdrh              sqlite3ExprSkipCollateAndLikely(pB),
5343f9463dfbSdrh              iTab);
5344f9463dfbSdrh }
5345f9463dfbSdrh 
5346f9463dfbSdrh /*
5347c51cf864Sdrh ** Return non-zero if Expr p can only be true if pNN is not NULL.
53487a231b49Sdrh **
53497a231b49Sdrh ** Or if seenNot is true, return non-zero if Expr p can only be
53507a231b49Sdrh ** non-NULL if pNN is not NULL
5351c51cf864Sdrh */
5352c51cf864Sdrh static int exprImpliesNotNull(
5353c51cf864Sdrh   Parse *pParse,      /* Parsing context */
5354c51cf864Sdrh   Expr *p,            /* The expression to be checked */
5355c51cf864Sdrh   Expr *pNN,          /* The expression that is NOT NULL */
5356c51cf864Sdrh   int iTab,           /* Table being evaluated */
53577a231b49Sdrh   int seenNot         /* Return true only if p can be any non-NULL value */
5358c51cf864Sdrh ){
5359c51cf864Sdrh   assert( p );
5360c51cf864Sdrh   assert( pNN );
536114c865e8Sdrh   if( sqlite3ExprCompare(pParse, p, pNN, iTab)==0 ){
536214c865e8Sdrh     return pNN->op!=TK_NULL;
536314c865e8Sdrh   }
5364c51cf864Sdrh   switch( p->op ){
5365c51cf864Sdrh     case TK_IN: {
5366c51cf864Sdrh       if( seenNot && ExprHasProperty(p, EP_xIsSelect) ) return 0;
5367c51cf864Sdrh       assert( ExprHasProperty(p,EP_xIsSelect)
5368c51cf864Sdrh            || (p->x.pList!=0 && p->x.pList->nExpr>0) );
5369ae144a1cSdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
5370c51cf864Sdrh     }
5371c51cf864Sdrh     case TK_BETWEEN: {
5372c51cf864Sdrh       ExprList *pList = p->x.pList;
5373c51cf864Sdrh       assert( pList!=0 );
5374c51cf864Sdrh       assert( pList->nExpr==2 );
5375c51cf864Sdrh       if( seenNot ) return 0;
53767a231b49Sdrh       if( exprImpliesNotNull(pParse, pList->a[0].pExpr, pNN, iTab, 1)
53777a231b49Sdrh        || exprImpliesNotNull(pParse, pList->a[1].pExpr, pNN, iTab, 1)
5378c51cf864Sdrh       ){
5379c51cf864Sdrh         return 1;
5380c51cf864Sdrh       }
53817a231b49Sdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
5382c51cf864Sdrh     }
5383c51cf864Sdrh     case TK_EQ:
5384c51cf864Sdrh     case TK_NE:
5385c51cf864Sdrh     case TK_LT:
5386c51cf864Sdrh     case TK_LE:
5387c51cf864Sdrh     case TK_GT:
5388c51cf864Sdrh     case TK_GE:
5389c51cf864Sdrh     case TK_PLUS:
5390c51cf864Sdrh     case TK_MINUS:
53919d23ea74Sdan     case TK_BITOR:
53929d23ea74Sdan     case TK_LSHIFT:
53939d23ea74Sdan     case TK_RSHIFT:
53949d23ea74Sdan     case TK_CONCAT:
53959d23ea74Sdan       seenNot = 1;
539608b92086Sdrh       /* no break */ deliberate_fall_through
5397c51cf864Sdrh     case TK_STAR:
5398c51cf864Sdrh     case TK_REM:
5399c51cf864Sdrh     case TK_BITAND:
54009d23ea74Sdan     case TK_SLASH: {
5401c51cf864Sdrh       if( exprImpliesNotNull(pParse, p->pRight, pNN, iTab, seenNot) ) return 1;
540208b92086Sdrh       /* no break */ deliberate_fall_through
5403c51cf864Sdrh     }
5404c51cf864Sdrh     case TK_SPAN:
5405c51cf864Sdrh     case TK_COLLATE:
5406c51cf864Sdrh     case TK_UPLUS:
5407c51cf864Sdrh     case TK_UMINUS: {
5408c51cf864Sdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, seenNot);
5409c51cf864Sdrh     }
5410c51cf864Sdrh     case TK_TRUTH: {
5411c51cf864Sdrh       if( seenNot ) return 0;
5412c51cf864Sdrh       if( p->op2!=TK_IS ) return 0;
541338cefc83Sdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
5414c51cf864Sdrh     }
54151cd382e3Sdan     case TK_BITNOT:
5416c51cf864Sdrh     case TK_NOT: {
5417c51cf864Sdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
5418c51cf864Sdrh     }
5419c51cf864Sdrh   }
5420c51cf864Sdrh   return 0;
5421c51cf864Sdrh }
5422c51cf864Sdrh 
5423c51cf864Sdrh /*
54244bd5f73fSdrh ** Return true if we can prove the pE2 will always be true if pE1 is
54254bd5f73fSdrh ** true.  Return false if we cannot complete the proof or if pE2 might
54264bd5f73fSdrh ** be false.  Examples:
54274bd5f73fSdrh **
5428619a1305Sdrh **     pE1: x==5       pE2: x==5             Result: true
54294bd5f73fSdrh **     pE1: x>0        pE2: x==5             Result: false
5430619a1305Sdrh **     pE1: x=21       pE2: x=21 OR y=43     Result: true
54314bd5f73fSdrh **     pE1: x!=123     pE2: x IS NOT NULL    Result: true
5432619a1305Sdrh **     pE1: x!=?1      pE2: x IS NOT NULL    Result: true
5433619a1305Sdrh **     pE1: x IS NULL  pE2: x IS NOT NULL    Result: false
5434619a1305Sdrh **     pE1: x IS ?2    pE2: x IS NOT NULL    Reuslt: false
54354bd5f73fSdrh **
54364bd5f73fSdrh ** When comparing TK_COLUMN nodes between pE1 and pE2, if pE2 has
54374bd5f73fSdrh ** Expr.iTable<0 then assume a table number given by iTab.
54384bd5f73fSdrh **
5439c0804226Sdrh ** If pParse is not NULL, then the values of bound variables in pE1 are
5440c0804226Sdrh ** compared against literal values in pE2 and pParse->pVdbe->expmask is
5441c0804226Sdrh ** modified to record which bound variables are referenced.  If pParse
5442c0804226Sdrh ** is NULL, then false will be returned if pE1 contains any bound variables.
5443c0804226Sdrh **
54444bd5f73fSdrh ** When in doubt, return false.  Returning true might give a performance
54454bd5f73fSdrh ** improvement.  Returning false might cause a performance reduction, but
54464bd5f73fSdrh ** it will always give the correct answer and is hence always safe.
54474bd5f73fSdrh */
54485aa550cfSdan int sqlite3ExprImpliesExpr(Parse *pParse, Expr *pE1, Expr *pE2, int iTab){
54495aa550cfSdan   if( sqlite3ExprCompare(pParse, pE1, pE2, iTab)==0 ){
5450619a1305Sdrh     return 1;
5451619a1305Sdrh   }
5452619a1305Sdrh   if( pE2->op==TK_OR
54535aa550cfSdan    && (sqlite3ExprImpliesExpr(pParse, pE1, pE2->pLeft, iTab)
54545aa550cfSdan              || sqlite3ExprImpliesExpr(pParse, pE1, pE2->pRight, iTab) )
5455619a1305Sdrh   ){
5456619a1305Sdrh     return 1;
5457619a1305Sdrh   }
5458664d6d13Sdrh   if( pE2->op==TK_NOTNULL
5459c51cf864Sdrh    && exprImpliesNotNull(pParse, pE1, pE2->pLeft, iTab, 0)
5460664d6d13Sdrh   ){
5461c51cf864Sdrh     return 1;
5462619a1305Sdrh   }
5463619a1305Sdrh   return 0;
54644bd5f73fSdrh }
54654bd5f73fSdrh 
54664bd5f73fSdrh /*
54676c68d759Sdrh ** This is the Expr node callback for sqlite3ExprImpliesNonNullRow().
54682589787cSdrh ** If the expression node requires that the table at pWalker->iCur
5469f8937f90Sdrh ** have one or more non-NULL column, then set pWalker->eCode to 1 and abort.
5470f8937f90Sdrh **
5471f8937f90Sdrh ** This routine controls an optimization.  False positives (setting
5472f8937f90Sdrh ** pWalker->eCode to 1 when it should not be) are deadly, but false-negatives
5473f8937f90Sdrh ** (never setting pWalker->eCode) is a harmless missed optimization.
54742589787cSdrh */
54752589787cSdrh static int impliesNotNullRow(Walker *pWalker, Expr *pExpr){
5476f8937f90Sdrh   testcase( pExpr->op==TK_AGG_COLUMN );
5477821b610bSdrh   testcase( pExpr->op==TK_AGG_FUNCTION );
54782589787cSdrh   if( ExprHasProperty(pExpr, EP_FromJoin) ) return WRC_Prune;
54792589787cSdrh   switch( pExpr->op ){
54800493222fSdan     case TK_ISNOT:
54812589787cSdrh     case TK_ISNULL:
5482d5793672Sdrh     case TK_NOTNULL:
54832589787cSdrh     case TK_IS:
54842589787cSdrh     case TK_OR:
54856c68d759Sdrh     case TK_VECTOR:
54862c492061Sdrh     case TK_CASE:
5487e3eff266Sdrh     case TK_IN:
54882589787cSdrh     case TK_FUNCTION:
5489da03c1e6Sdan     case TK_TRUTH:
54900493222fSdan       testcase( pExpr->op==TK_ISNOT );
5491821b610bSdrh       testcase( pExpr->op==TK_ISNULL );
5492d5793672Sdrh       testcase( pExpr->op==TK_NOTNULL );
5493821b610bSdrh       testcase( pExpr->op==TK_IS );
5494821b610bSdrh       testcase( pExpr->op==TK_OR );
54956c68d759Sdrh       testcase( pExpr->op==TK_VECTOR );
5496821b610bSdrh       testcase( pExpr->op==TK_CASE );
5497821b610bSdrh       testcase( pExpr->op==TK_IN );
5498821b610bSdrh       testcase( pExpr->op==TK_FUNCTION );
5499da03c1e6Sdan       testcase( pExpr->op==TK_TRUTH );
55002589787cSdrh       return WRC_Prune;
55012589787cSdrh     case TK_COLUMN:
55022589787cSdrh       if( pWalker->u.iCur==pExpr->iTable ){
55032589787cSdrh         pWalker->eCode = 1;
55042589787cSdrh         return WRC_Abort;
55052589787cSdrh       }
55062589787cSdrh       return WRC_Prune;
55079881155dSdrh 
55089d23ea74Sdan     case TK_AND:
5509aef81674Sdrh       if( pWalker->eCode==0 ){
55100287c951Sdan         sqlite3WalkExpr(pWalker, pExpr->pLeft);
55110287c951Sdan         if( pWalker->eCode ){
55120287c951Sdan           pWalker->eCode = 0;
55130287c951Sdan           sqlite3WalkExpr(pWalker, pExpr->pRight);
55149d23ea74Sdan         }
5515aef81674Sdrh       }
55169d23ea74Sdan       return WRC_Prune;
55179d23ea74Sdan 
55189d23ea74Sdan     case TK_BETWEEN:
55191d24a531Sdan       if( sqlite3WalkExpr(pWalker, pExpr->pLeft)==WRC_Abort ){
55201d24a531Sdan         assert( pWalker->eCode );
55211d24a531Sdan         return WRC_Abort;
55221d24a531Sdan       }
55239d23ea74Sdan       return WRC_Prune;
55249d23ea74Sdan 
55259881155dSdrh     /* Virtual tables are allowed to use constraints like x=NULL.  So
55269881155dSdrh     ** a term of the form x=y does not prove that y is not null if x
55279881155dSdrh     ** is the column of a virtual table */
55289881155dSdrh     case TK_EQ:
55299881155dSdrh     case TK_NE:
55309881155dSdrh     case TK_LT:
55319881155dSdrh     case TK_LE:
55329881155dSdrh     case TK_GT:
553378d1d225Sdrh     case TK_GE: {
553478d1d225Sdrh       Expr *pLeft = pExpr->pLeft;
553578d1d225Sdrh       Expr *pRight = pExpr->pRight;
55369881155dSdrh       testcase( pExpr->op==TK_EQ );
55379881155dSdrh       testcase( pExpr->op==TK_NE );
55389881155dSdrh       testcase( pExpr->op==TK_LT );
55399881155dSdrh       testcase( pExpr->op==TK_LE );
55409881155dSdrh       testcase( pExpr->op==TK_GT );
55419881155dSdrh       testcase( pExpr->op==TK_GE );
554278d1d225Sdrh       /* The y.pTab=0 assignment in wherecode.c always happens after the
554378d1d225Sdrh       ** impliesNotNullRow() test */
554478d1d225Sdrh       if( (pLeft->op==TK_COLUMN && ALWAYS(pLeft->y.pTab!=0)
554578d1d225Sdrh                                && IsVirtual(pLeft->y.pTab))
554678d1d225Sdrh        || (pRight->op==TK_COLUMN && ALWAYS(pRight->y.pTab!=0)
554778d1d225Sdrh                                && IsVirtual(pRight->y.pTab))
55489881155dSdrh       ){
55499881155dSdrh         return WRC_Prune;
55509881155dSdrh       }
555108b92086Sdrh       /* no break */ deliberate_fall_through
555278d1d225Sdrh     }
55532589787cSdrh     default:
55542589787cSdrh       return WRC_Continue;
55552589787cSdrh   }
55562589787cSdrh }
55572589787cSdrh 
55582589787cSdrh /*
55592589787cSdrh ** Return true (non-zero) if expression p can only be true if at least
55602589787cSdrh ** one column of table iTab is non-null.  In other words, return true
55612589787cSdrh ** if expression p will always be NULL or false if every column of iTab
55622589787cSdrh ** is NULL.
55632589787cSdrh **
5564821b610bSdrh ** False negatives are acceptable.  In other words, it is ok to return
5565821b610bSdrh ** zero even if expression p will never be true of every column of iTab
5566821b610bSdrh ** is NULL.  A false negative is merely a missed optimization opportunity.
5567821b610bSdrh **
5568821b610bSdrh ** False positives are not allowed, however.  A false positive may result
5569821b610bSdrh ** in an incorrect answer.
5570821b610bSdrh **
55712589787cSdrh ** Terms of p that are marked with EP_FromJoin (and hence that come from
55722589787cSdrh ** the ON or USING clauses of LEFT JOINS) are excluded from the analysis.
55732589787cSdrh **
55742589787cSdrh ** This routine is used to check if a LEFT JOIN can be converted into
55752589787cSdrh ** an ordinary JOIN.  The p argument is the WHERE clause.  If the WHERE
55762589787cSdrh ** clause requires that some column of the right table of the LEFT JOIN
55772589787cSdrh ** be non-NULL, then the LEFT JOIN can be safely converted into an
55782589787cSdrh ** ordinary join.
55792589787cSdrh */
55802589787cSdrh int sqlite3ExprImpliesNonNullRow(Expr *p, int iTab){
55812589787cSdrh   Walker w;
55820d950af3Sdrh   p = sqlite3ExprSkipCollateAndLikely(p);
55834a254f98Sdrh   if( p==0 ) return 0;
55844a254f98Sdrh   if( p->op==TK_NOTNULL ){
5585d6db6598Sdrh     p = p->pLeft;
5586a1698993Sdrh   }else{
5587a1698993Sdrh     while( p->op==TK_AND ){
55884a254f98Sdrh       if( sqlite3ExprImpliesNonNullRow(p->pLeft, iTab) ) return 1;
55894a254f98Sdrh       p = p->pRight;
5590d6db6598Sdrh     }
5591a1698993Sdrh   }
55922589787cSdrh   w.xExprCallback = impliesNotNullRow;
55932589787cSdrh   w.xSelectCallback = 0;
55942589787cSdrh   w.xSelectCallback2 = 0;
55952589787cSdrh   w.eCode = 0;
55962589787cSdrh   w.u.iCur = iTab;
55972589787cSdrh   sqlite3WalkExpr(&w, p);
55982589787cSdrh   return w.eCode;
55992589787cSdrh }
56002589787cSdrh 
56012589787cSdrh /*
5602030796dfSdrh ** An instance of the following structure is used by the tree walker
56032409f8a1Sdrh ** to determine if an expression can be evaluated by reference to the
56042409f8a1Sdrh ** index only, without having to do a search for the corresponding
56052409f8a1Sdrh ** table entry.  The IdxCover.pIdx field is the index.  IdxCover.iCur
56062409f8a1Sdrh ** is the cursor for the table.
56072409f8a1Sdrh */
56082409f8a1Sdrh struct IdxCover {
56092409f8a1Sdrh   Index *pIdx;     /* The index to be tested for coverage */
56102409f8a1Sdrh   int iCur;        /* Cursor number for the table corresponding to the index */
56112409f8a1Sdrh };
56122409f8a1Sdrh 
56132409f8a1Sdrh /*
56142409f8a1Sdrh ** Check to see if there are references to columns in table
56152409f8a1Sdrh ** pWalker->u.pIdxCover->iCur can be satisfied using the index
56162409f8a1Sdrh ** pWalker->u.pIdxCover->pIdx.
56172409f8a1Sdrh */
56182409f8a1Sdrh static int exprIdxCover(Walker *pWalker, Expr *pExpr){
56192409f8a1Sdrh   if( pExpr->op==TK_COLUMN
56202409f8a1Sdrh    && pExpr->iTable==pWalker->u.pIdxCover->iCur
5621b9bcf7caSdrh    && sqlite3TableColumnToIndex(pWalker->u.pIdxCover->pIdx, pExpr->iColumn)<0
56222409f8a1Sdrh   ){
56232409f8a1Sdrh     pWalker->eCode = 1;
56242409f8a1Sdrh     return WRC_Abort;
56252409f8a1Sdrh   }
56262409f8a1Sdrh   return WRC_Continue;
56272409f8a1Sdrh }
56282409f8a1Sdrh 
56292409f8a1Sdrh /*
5630e604ec0bSdrh ** Determine if an index pIdx on table with cursor iCur contains will
5631e604ec0bSdrh ** the expression pExpr.  Return true if the index does cover the
5632e604ec0bSdrh ** expression and false if the pExpr expression references table columns
5633e604ec0bSdrh ** that are not found in the index pIdx.
56342409f8a1Sdrh **
56352409f8a1Sdrh ** An index covering an expression means that the expression can be
56362409f8a1Sdrh ** evaluated using only the index and without having to lookup the
56372409f8a1Sdrh ** corresponding table entry.
56382409f8a1Sdrh */
56392409f8a1Sdrh int sqlite3ExprCoveredByIndex(
56402409f8a1Sdrh   Expr *pExpr,        /* The index to be tested */
56412409f8a1Sdrh   int iCur,           /* The cursor number for the corresponding table */
56422409f8a1Sdrh   Index *pIdx         /* The index that might be used for coverage */
56432409f8a1Sdrh ){
56442409f8a1Sdrh   Walker w;
56452409f8a1Sdrh   struct IdxCover xcov;
56462409f8a1Sdrh   memset(&w, 0, sizeof(w));
56472409f8a1Sdrh   xcov.iCur = iCur;
56482409f8a1Sdrh   xcov.pIdx = pIdx;
56492409f8a1Sdrh   w.xExprCallback = exprIdxCover;
56502409f8a1Sdrh   w.u.pIdxCover = &xcov;
56512409f8a1Sdrh   sqlite3WalkExpr(&w, pExpr);
56522409f8a1Sdrh   return !w.eCode;
56532409f8a1Sdrh }
56542409f8a1Sdrh 
56552409f8a1Sdrh 
56562409f8a1Sdrh /*
56572409f8a1Sdrh ** An instance of the following structure is used by the tree walker
5658030796dfSdrh ** to count references to table columns in the arguments of an
5659ed551b95Sdrh ** aggregate function, in order to implement the
5660ed551b95Sdrh ** sqlite3FunctionThisSrc() routine.
5661374fdce4Sdrh */
5662030796dfSdrh struct SrcCount {
5663030796dfSdrh   SrcList *pSrc;   /* One particular FROM clause in a nested query */
5664ed41a96bSdan   int iSrcInner;   /* Smallest cursor number in this context */
5665030796dfSdrh   int nThis;       /* Number of references to columns in pSrcList */
5666030796dfSdrh   int nOther;      /* Number of references to columns in other FROM clauses */
5667030796dfSdrh };
5668030796dfSdrh 
5669030796dfSdrh /*
5670ed41a96bSdan ** xSelect callback for sqlite3FunctionUsesThisSrc(). If this is the first
5671ed41a96bSdan ** SELECT with a FROM clause encountered during this iteration, set
5672ed41a96bSdan ** SrcCount.iSrcInner to the cursor number of the leftmost object in
5673ed41a96bSdan ** the FROM cause.
5674ed41a96bSdan */
5675ed41a96bSdan static int selectSrcCount(Walker *pWalker, Select *pSel){
5676ed41a96bSdan   struct SrcCount *p = pWalker->u.pSrcCount;
5677bc050b8fSdrh   if( p->iSrcInner==0x7FFFFFFF && ALWAYS(pSel->pSrc) && pSel->pSrc->nSrc ){
5678ed41a96bSdan     pWalker->u.pSrcCount->iSrcInner = pSel->pSrc->a[0].iCursor;
5679ed41a96bSdan   }
5680ed41a96bSdan   return WRC_Continue;
5681ed41a96bSdan }
5682ed41a96bSdan 
5683ed41a96bSdan /*
5684030796dfSdrh ** Count the number of references to columns.
5685030796dfSdrh */
5686030796dfSdrh static int exprSrcCount(Walker *pWalker, Expr *pExpr){
5687b4b36306Sdan   /* There was once a NEVER() on the second term on the grounds that
5688b4b36306Sdan   ** sqlite3FunctionUsesThisSrc() was always called before
5689b4b36306Sdan   ** sqlite3ExprAnalyzeAggregates() and so the TK_COLUMNs have not yet
5690b4b36306Sdan   ** been converted into TK_AGG_COLUMN. But this is no longer true due
5691b4b36306Sdan   ** to window functions - sqlite3WindowRewrite() may now indirectly call
5692b4b36306Sdan   ** FunctionUsesThisSrc() when creating a new sub-select. */
5693b4b36306Sdan   if( pExpr->op==TK_COLUMN || pExpr->op==TK_AGG_COLUMN ){
5694374fdce4Sdrh     int i;
5695030796dfSdrh     struct SrcCount *p = pWalker->u.pSrcCount;
5696030796dfSdrh     SrcList *pSrc = p->pSrc;
5697655814d2Sdrh     int nSrc = pSrc ? pSrc->nSrc : 0;
5698655814d2Sdrh     for(i=0; i<nSrc; i++){
5699030796dfSdrh       if( pExpr->iTable==pSrc->a[i].iCursor ) break;
5700374fdce4Sdrh     }
5701655814d2Sdrh     if( i<nSrc ){
5702030796dfSdrh       p->nThis++;
5703ed41a96bSdan     }else if( pExpr->iTable<p->iSrcInner ){
570480f6bfc0Sdrh       /* In a well-formed parse tree (no name resolution errors),
570535a38e08Sdrh       ** TK_COLUMN nodes with smaller Expr.iTable values are in an
570680f6bfc0Sdrh       ** outer context.  Those are the only ones to count as "other" */
5707030796dfSdrh       p->nOther++;
5708374fdce4Sdrh     }
5709374fdce4Sdrh   }
5710030796dfSdrh   return WRC_Continue;
5711030796dfSdrh }
5712374fdce4Sdrh 
5713374fdce4Sdrh /*
5714030796dfSdrh ** Determine if any of the arguments to the pExpr Function reference
5715030796dfSdrh ** pSrcList.  Return true if they do.  Also return true if the function
5716030796dfSdrh ** has no arguments or has only constant arguments.  Return false if pExpr
5717030796dfSdrh ** references columns but not columns of tables found in pSrcList.
5718374fdce4Sdrh */
5719030796dfSdrh int sqlite3FunctionUsesThisSrc(Expr *pExpr, SrcList *pSrcList){
5720374fdce4Sdrh   Walker w;
5721030796dfSdrh   struct SrcCount cnt;
5722374fdce4Sdrh   assert( pExpr->op==TK_AGG_FUNCTION );
572380f6bfc0Sdrh   memset(&w, 0, sizeof(w));
5724030796dfSdrh   w.xExprCallback = exprSrcCount;
5725ed41a96bSdan   w.xSelectCallback = selectSrcCount;
5726030796dfSdrh   w.u.pSrcCount = &cnt;
5727030796dfSdrh   cnt.pSrc = pSrcList;
5728ed41a96bSdan   cnt.iSrcInner = (pSrcList&&pSrcList->nSrc)?pSrcList->a[0].iCursor:0x7FFFFFFF;
5729030796dfSdrh   cnt.nThis = 0;
5730030796dfSdrh   cnt.nOther = 0;
5731030796dfSdrh   sqlite3WalkExprList(&w, pExpr->x.pList);
57325e484cb3Sdan #ifndef SQLITE_OMIT_WINDOWFUNC
57335e484cb3Sdan   if( ExprHasProperty(pExpr, EP_WinFunc) ){
57345e484cb3Sdan     sqlite3WalkExpr(&w, pExpr->y.pWin->pFilter);
57355e484cb3Sdan   }
57365e484cb3Sdan #endif
5737030796dfSdrh   return cnt.nThis>0 || cnt.nOther==0;
5738374fdce4Sdrh }
5739374fdce4Sdrh 
5740374fdce4Sdrh /*
574189636628Sdrh ** This is a Walker expression node callback.
574289636628Sdrh **
574389636628Sdrh ** For Expr nodes that contain pAggInfo pointers, make sure the AggInfo
574489636628Sdrh ** object that is referenced does not refer directly to the Expr.  If
574589636628Sdrh ** it does, make a copy.  This is done because the pExpr argument is
574689636628Sdrh ** subject to change.
574789636628Sdrh **
574889636628Sdrh ** The copy is stored on pParse->pConstExpr with a register number of 0.
574989636628Sdrh ** This will cause the expression to be deleted automatically when the
575089636628Sdrh ** Parse object is destroyed, but the zero register number means that it
575189636628Sdrh ** will not generate any code in the preamble.
575289636628Sdrh */
575389636628Sdrh static int agginfoPersistExprCb(Walker *pWalker, Expr *pExpr){
57542f82acc0Sdrh   if( ALWAYS(!ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced))
575589636628Sdrh    && pExpr->pAggInfo!=0
575689636628Sdrh   ){
575789636628Sdrh     AggInfo *pAggInfo = pExpr->pAggInfo;
575889636628Sdrh     int iAgg = pExpr->iAgg;
575989636628Sdrh     Parse *pParse = pWalker->pParse;
576089636628Sdrh     sqlite3 *db = pParse->db;
57612f82acc0Sdrh     assert( pExpr->op==TK_AGG_COLUMN || pExpr->op==TK_AGG_FUNCTION );
57622f82acc0Sdrh     if( pExpr->op==TK_AGG_COLUMN ){
576389636628Sdrh       assert( iAgg>=0 && iAgg<pAggInfo->nColumn );
576481185a51Sdrh       if( pAggInfo->aCol[iAgg].pCExpr==pExpr ){
576589636628Sdrh         pExpr = sqlite3ExprDup(db, pExpr, 0);
576689636628Sdrh         if( pExpr ){
576781185a51Sdrh           pAggInfo->aCol[iAgg].pCExpr = pExpr;
576889636628Sdrh           pParse->pConstExpr =
576989636628Sdrh              sqlite3ExprListAppend(pParse, pParse->pConstExpr, pExpr);
577089636628Sdrh         }
577189636628Sdrh       }
577289636628Sdrh     }else{
577389636628Sdrh       assert( iAgg>=0 && iAgg<pAggInfo->nFunc );
577481185a51Sdrh       if( pAggInfo->aFunc[iAgg].pFExpr==pExpr ){
577589636628Sdrh         pExpr = sqlite3ExprDup(db, pExpr, 0);
577689636628Sdrh         if( pExpr ){
577781185a51Sdrh           pAggInfo->aFunc[iAgg].pFExpr = pExpr;
577889636628Sdrh           pParse->pConstExpr =
577989636628Sdrh              sqlite3ExprListAppend(pParse, pParse->pConstExpr, pExpr);
578089636628Sdrh         }
578189636628Sdrh       }
578289636628Sdrh     }
578389636628Sdrh   }
578489636628Sdrh   return WRC_Continue;
578589636628Sdrh }
578689636628Sdrh 
578789636628Sdrh /*
578889636628Sdrh ** Initialize a Walker object so that will persist AggInfo entries referenced
578989636628Sdrh ** by the tree that is walked.
579089636628Sdrh */
579189636628Sdrh void sqlite3AggInfoPersistWalkerInit(Walker *pWalker, Parse *pParse){
579289636628Sdrh   memset(pWalker, 0, sizeof(*pWalker));
579389636628Sdrh   pWalker->pParse = pParse;
579489636628Sdrh   pWalker->xExprCallback = agginfoPersistExprCb;
579589636628Sdrh   pWalker->xSelectCallback = sqlite3SelectWalkNoop;
579689636628Sdrh }
579789636628Sdrh 
579889636628Sdrh /*
579913449892Sdrh ** Add a new element to the pAggInfo->aCol[] array.  Return the index of
580013449892Sdrh ** the new element.  Return a negative number if malloc fails.
58012282792aSdrh */
580217435752Sdrh static int addAggInfoColumn(sqlite3 *db, AggInfo *pInfo){
580313449892Sdrh   int i;
5804cf643729Sdrh   pInfo->aCol = sqlite3ArrayAllocate(
580517435752Sdrh        db,
5806cf643729Sdrh        pInfo->aCol,
5807cf643729Sdrh        sizeof(pInfo->aCol[0]),
5808cf643729Sdrh        &pInfo->nColumn,
5809cf643729Sdrh        &i
5810cf643729Sdrh   );
581113449892Sdrh   return i;
58122282792aSdrh }
581313449892Sdrh 
581413449892Sdrh /*
581513449892Sdrh ** Add a new element to the pAggInfo->aFunc[] array.  Return the index of
581613449892Sdrh ** the new element.  Return a negative number if malloc fails.
581713449892Sdrh */
581817435752Sdrh static int addAggInfoFunc(sqlite3 *db, AggInfo *pInfo){
581913449892Sdrh   int i;
5820cf643729Sdrh   pInfo->aFunc = sqlite3ArrayAllocate(
582117435752Sdrh        db,
5822cf643729Sdrh        pInfo->aFunc,
5823cf643729Sdrh        sizeof(pInfo->aFunc[0]),
5824cf643729Sdrh        &pInfo->nFunc,
5825cf643729Sdrh        &i
5826cf643729Sdrh   );
582713449892Sdrh   return i;
58282282792aSdrh }
58292282792aSdrh 
58302282792aSdrh /*
58317d10d5a6Sdrh ** This is the xExprCallback for a tree walker.  It is used to
58327d10d5a6Sdrh ** implement sqlite3ExprAnalyzeAggregates().  See sqlite3ExprAnalyzeAggregates
5833626a879aSdrh ** for additional information.
58342282792aSdrh */
58357d10d5a6Sdrh static int analyzeAggregate(Walker *pWalker, Expr *pExpr){
58362282792aSdrh   int i;
58377d10d5a6Sdrh   NameContext *pNC = pWalker->u.pNC;
5838a58fdfb1Sdanielk1977   Parse *pParse = pNC->pParse;
5839a58fdfb1Sdanielk1977   SrcList *pSrcList = pNC->pSrcList;
584025c3b8caSdrh   AggInfo *pAggInfo = pNC->uNC.pAggInfo;
584113449892Sdrh 
584225c3b8caSdrh   assert( pNC->ncFlags & NC_UAggInfo );
58432282792aSdrh   switch( pExpr->op ){
584489c69d00Sdrh     case TK_AGG_COLUMN:
5845967e8b73Sdrh     case TK_COLUMN: {
58468b213899Sdrh       testcase( pExpr->op==TK_AGG_COLUMN );
58478b213899Sdrh       testcase( pExpr->op==TK_COLUMN );
584813449892Sdrh       /* Check to see if the column is in one of the tables in the FROM
584913449892Sdrh       ** clause of the aggregate query */
585020bc393cSdrh       if( ALWAYS(pSrcList!=0) ){
585113449892Sdrh         struct SrcList_item *pItem = pSrcList->a;
585213449892Sdrh         for(i=0; i<pSrcList->nSrc; i++, pItem++){
585313449892Sdrh           struct AggInfo_col *pCol;
5854c5cd1249Sdrh           assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
585513449892Sdrh           if( pExpr->iTable==pItem->iCursor ){
585613449892Sdrh             /* If we reach this point, it means that pExpr refers to a table
585713449892Sdrh             ** that is in the FROM clause of the aggregate query.
585813449892Sdrh             **
585913449892Sdrh             ** Make an entry for the column in pAggInfo->aCol[] if there
586013449892Sdrh             ** is not an entry there already.
586113449892Sdrh             */
58627f906d63Sdrh             int k;
586313449892Sdrh             pCol = pAggInfo->aCol;
58647f906d63Sdrh             for(k=0; k<pAggInfo->nColumn; k++, pCol++){
586513449892Sdrh               if( pCol->iTable==pExpr->iTable &&
586613449892Sdrh                   pCol->iColumn==pExpr->iColumn ){
58672282792aSdrh                 break;
58682282792aSdrh               }
58692282792aSdrh             }
58701e536953Sdanielk1977             if( (k>=pAggInfo->nColumn)
58711e536953Sdanielk1977              && (k = addAggInfoColumn(pParse->db, pAggInfo))>=0
58721e536953Sdanielk1977             ){
58737f906d63Sdrh               pCol = &pAggInfo->aCol[k];
5874eda079cdSdrh               pCol->pTab = pExpr->y.pTab;
587513449892Sdrh               pCol->iTable = pExpr->iTable;
587613449892Sdrh               pCol->iColumn = pExpr->iColumn;
58770a07c107Sdrh               pCol->iMem = ++pParse->nMem;
587813449892Sdrh               pCol->iSorterColumn = -1;
587981185a51Sdrh               pCol->pCExpr = pExpr;
588013449892Sdrh               if( pAggInfo->pGroupBy ){
588113449892Sdrh                 int j, n;
588213449892Sdrh                 ExprList *pGB = pAggInfo->pGroupBy;
588313449892Sdrh                 struct ExprList_item *pTerm = pGB->a;
588413449892Sdrh                 n = pGB->nExpr;
588513449892Sdrh                 for(j=0; j<n; j++, pTerm++){
588613449892Sdrh                   Expr *pE = pTerm->pExpr;
588713449892Sdrh                   if( pE->op==TK_COLUMN && pE->iTable==pExpr->iTable &&
588813449892Sdrh                       pE->iColumn==pExpr->iColumn ){
588913449892Sdrh                     pCol->iSorterColumn = j;
589013449892Sdrh                     break;
58912282792aSdrh                   }
589213449892Sdrh                 }
589313449892Sdrh               }
589413449892Sdrh               if( pCol->iSorterColumn<0 ){
589513449892Sdrh                 pCol->iSorterColumn = pAggInfo->nSortingColumn++;
589613449892Sdrh               }
589713449892Sdrh             }
589813449892Sdrh             /* There is now an entry for pExpr in pAggInfo->aCol[] (either
589913449892Sdrh             ** because it was there before or because we just created it).
590013449892Sdrh             ** Convert the pExpr to be a TK_AGG_COLUMN referring to that
590113449892Sdrh             ** pAggInfo->aCol[] entry.
590213449892Sdrh             */
5903ebb6a65dSdrh             ExprSetVVAProperty(pExpr, EP_NoReduce);
590413449892Sdrh             pExpr->pAggInfo = pAggInfo;
590513449892Sdrh             pExpr->op = TK_AGG_COLUMN;
5906cf697396Sshane             pExpr->iAgg = (i16)k;
590713449892Sdrh             break;
590813449892Sdrh           } /* endif pExpr->iTable==pItem->iCursor */
590913449892Sdrh         } /* end loop over pSrcList */
5910a58fdfb1Sdanielk1977       }
59117d10d5a6Sdrh       return WRC_Prune;
59122282792aSdrh     }
59132282792aSdrh     case TK_AGG_FUNCTION: {
59143a8c4be7Sdrh       if( (pNC->ncFlags & NC_InAggFunc)==0
5915ed551b95Sdrh        && pWalker->walkerDepth==pExpr->op2
59163a8c4be7Sdrh       ){
591713449892Sdrh         /* Check to see if pExpr is a duplicate of another aggregate
591813449892Sdrh         ** function that is already in the pAggInfo structure
591913449892Sdrh         */
592013449892Sdrh         struct AggInfo_func *pItem = pAggInfo->aFunc;
592113449892Sdrh         for(i=0; i<pAggInfo->nFunc; i++, pItem++){
592281185a51Sdrh           if( sqlite3ExprCompare(0, pItem->pFExpr, pExpr, -1)==0 ){
59232282792aSdrh             break;
59242282792aSdrh           }
59252282792aSdrh         }
592613449892Sdrh         if( i>=pAggInfo->nFunc ){
592713449892Sdrh           /* pExpr is original.  Make a new entry in pAggInfo->aFunc[]
592813449892Sdrh           */
592914db2665Sdanielk1977           u8 enc = ENC(pParse->db);
59301e536953Sdanielk1977           i = addAggInfoFunc(pParse->db, pAggInfo);
593113449892Sdrh           if( i>=0 ){
59326ab3a2ecSdanielk1977             assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
593313449892Sdrh             pItem = &pAggInfo->aFunc[i];
593481185a51Sdrh             pItem->pFExpr = pExpr;
59350a07c107Sdrh             pItem->iMem = ++pParse->nMem;
593633e619fcSdrh             assert( !ExprHasProperty(pExpr, EP_IntValue) );
593713449892Sdrh             pItem->pFunc = sqlite3FindFunction(pParse->db,
593880738d9cSdrh                    pExpr->u.zToken,
59396ab3a2ecSdanielk1977                    pExpr->x.pList ? pExpr->x.pList->nExpr : 0, enc, 0);
5940fd357974Sdrh             if( pExpr->flags & EP_Distinct ){
5941fd357974Sdrh               pItem->iDistinct = pParse->nTab++;
5942fd357974Sdrh             }else{
5943fd357974Sdrh               pItem->iDistinct = -1;
5944fd357974Sdrh             }
59452282792aSdrh           }
594613449892Sdrh         }
594713449892Sdrh         /* Make pExpr point to the appropriate pAggInfo->aFunc[] entry
594813449892Sdrh         */
5949c5cd1249Sdrh         assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
5950ebb6a65dSdrh         ExprSetVVAProperty(pExpr, EP_NoReduce);
5951cf697396Sshane         pExpr->iAgg = (i16)i;
595213449892Sdrh         pExpr->pAggInfo = pAggInfo;
59533a8c4be7Sdrh         return WRC_Prune;
59546e83a57fSdrh       }else{
59556e83a57fSdrh         return WRC_Continue;
59566e83a57fSdrh       }
59572282792aSdrh     }
5958a58fdfb1Sdanielk1977   }
59597d10d5a6Sdrh   return WRC_Continue;
59607d10d5a6Sdrh }
5961626a879aSdrh 
5962626a879aSdrh /*
5963e8abb4caSdrh ** Analyze the pExpr expression looking for aggregate functions and
5964e8abb4caSdrh ** for variables that need to be added to AggInfo object that pNC->pAggInfo
5965e8abb4caSdrh ** points to.  Additional entries are made on the AggInfo object as
5966e8abb4caSdrh ** necessary.
5967626a879aSdrh **
5968626a879aSdrh ** This routine should only be called after the expression has been
59697d10d5a6Sdrh ** analyzed by sqlite3ResolveExprNames().
5970626a879aSdrh */
5971d2b3e23bSdrh void sqlite3ExprAnalyzeAggregates(NameContext *pNC, Expr *pExpr){
59727d10d5a6Sdrh   Walker w;
59737d10d5a6Sdrh   w.xExprCallback = analyzeAggregate;
5974e40cc16bSdrh   w.xSelectCallback = sqlite3WalkerDepthIncrease;
5975e40cc16bSdrh   w.xSelectCallback2 = sqlite3WalkerDepthDecrease;
5976979dd1beSdrh   w.walkerDepth = 0;
59777d10d5a6Sdrh   w.u.pNC = pNC;
5978d9995031Sdan   w.pParse = 0;
597920bc393cSdrh   assert( pNC->pSrcList!=0 );
59807d10d5a6Sdrh   sqlite3WalkExpr(&w, pExpr);
59812282792aSdrh }
59825d9a4af9Sdrh 
59835d9a4af9Sdrh /*
59845d9a4af9Sdrh ** Call sqlite3ExprAnalyzeAggregates() for every expression in an
59855d9a4af9Sdrh ** expression list.  Return the number of errors.
59865d9a4af9Sdrh **
59875d9a4af9Sdrh ** If an error is found, the analysis is cut short.
59885d9a4af9Sdrh */
5989d2b3e23bSdrh void sqlite3ExprAnalyzeAggList(NameContext *pNC, ExprList *pList){
59905d9a4af9Sdrh   struct ExprList_item *pItem;
59915d9a4af9Sdrh   int i;
59925d9a4af9Sdrh   if( pList ){
5993d2b3e23bSdrh     for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
5994d2b3e23bSdrh       sqlite3ExprAnalyzeAggregates(pNC, pItem->pExpr);
59955d9a4af9Sdrh     }
59965d9a4af9Sdrh   }
59975d9a4af9Sdrh }
5998892d3179Sdrh 
5999892d3179Sdrh /*
6000ceea3321Sdrh ** Allocate a single new register for use to hold some intermediate result.
6001892d3179Sdrh */
6002892d3179Sdrh int sqlite3GetTempReg(Parse *pParse){
6003e55cbd72Sdrh   if( pParse->nTempReg==0 ){
6004892d3179Sdrh     return ++pParse->nMem;
6005892d3179Sdrh   }
60062f425f6bSdanielk1977   return pParse->aTempReg[--pParse->nTempReg];
6007892d3179Sdrh }
6008ceea3321Sdrh 
6009ceea3321Sdrh /*
6010ceea3321Sdrh ** Deallocate a register, making available for reuse for some other
6011ceea3321Sdrh ** purpose.
6012ceea3321Sdrh */
6013892d3179Sdrh void sqlite3ReleaseTempReg(Parse *pParse, int iReg){
601413d79502Sdrh   if( iReg ){
60153aef2fb1Sdrh     sqlite3VdbeReleaseRegisters(pParse, iReg, 1, 0, 0);
601613d79502Sdrh     if( pParse->nTempReg<ArraySize(pParse->aTempReg) ){
6017892d3179Sdrh       pParse->aTempReg[pParse->nTempReg++] = iReg;
6018892d3179Sdrh     }
6019892d3179Sdrh   }
602013d79502Sdrh }
6021892d3179Sdrh 
6022892d3179Sdrh /*
6023ed24da4bSdrh ** Allocate or deallocate a block of nReg consecutive registers.
6024892d3179Sdrh */
6025892d3179Sdrh int sqlite3GetTempRange(Parse *pParse, int nReg){
6026e55cbd72Sdrh   int i, n;
6027ed24da4bSdrh   if( nReg==1 ) return sqlite3GetTempReg(pParse);
6028892d3179Sdrh   i = pParse->iRangeReg;
6029e55cbd72Sdrh   n = pParse->nRangeReg;
6030f49f3523Sdrh   if( nReg<=n ){
6031892d3179Sdrh     pParse->iRangeReg += nReg;
6032892d3179Sdrh     pParse->nRangeReg -= nReg;
6033892d3179Sdrh   }else{
6034892d3179Sdrh     i = pParse->nMem+1;
6035892d3179Sdrh     pParse->nMem += nReg;
6036892d3179Sdrh   }
6037892d3179Sdrh   return i;
6038892d3179Sdrh }
6039892d3179Sdrh void sqlite3ReleaseTempRange(Parse *pParse, int iReg, int nReg){
6040ed24da4bSdrh   if( nReg==1 ){
6041ed24da4bSdrh     sqlite3ReleaseTempReg(pParse, iReg);
6042ed24da4bSdrh     return;
6043ed24da4bSdrh   }
60443aef2fb1Sdrh   sqlite3VdbeReleaseRegisters(pParse, iReg, nReg, 0, 0);
6045892d3179Sdrh   if( nReg>pParse->nRangeReg ){
6046892d3179Sdrh     pParse->nRangeReg = nReg;
6047892d3179Sdrh     pParse->iRangeReg = iReg;
6048892d3179Sdrh   }
6049892d3179Sdrh }
6050cdc69557Sdrh 
6051cdc69557Sdrh /*
6052cdc69557Sdrh ** Mark all temporary registers as being unavailable for reuse.
60536d2566dfSdrh **
60546d2566dfSdrh ** Always invoke this procedure after coding a subroutine or co-routine
60556d2566dfSdrh ** that might be invoked from other parts of the code, to ensure that
60566d2566dfSdrh ** the sub/co-routine does not use registers in common with the code that
60576d2566dfSdrh ** invokes the sub/co-routine.
6058cdc69557Sdrh */
6059cdc69557Sdrh void sqlite3ClearTempRegCache(Parse *pParse){
6060cdc69557Sdrh   pParse->nTempReg = 0;
6061cdc69557Sdrh   pParse->nRangeReg = 0;
6062cdc69557Sdrh }
6063bb9b5f26Sdrh 
6064bb9b5f26Sdrh /*
6065bb9b5f26Sdrh ** Validate that no temporary register falls within the range of
6066bb9b5f26Sdrh ** iFirst..iLast, inclusive.  This routine is only call from within assert()
6067bb9b5f26Sdrh ** statements.
6068bb9b5f26Sdrh */
6069bb9b5f26Sdrh #ifdef SQLITE_DEBUG
6070bb9b5f26Sdrh int sqlite3NoTempsInRange(Parse *pParse, int iFirst, int iLast){
6071bb9b5f26Sdrh   int i;
6072bb9b5f26Sdrh   if( pParse->nRangeReg>0
60733963e584Sdrh    && pParse->iRangeReg+pParse->nRangeReg > iFirst
60743963e584Sdrh    && pParse->iRangeReg <= iLast
6075bb9b5f26Sdrh   ){
6076bb9b5f26Sdrh      return 0;
6077bb9b5f26Sdrh   }
6078bb9b5f26Sdrh   for(i=0; i<pParse->nTempReg; i++){
6079bb9b5f26Sdrh     if( pParse->aTempReg[i]>=iFirst && pParse->aTempReg[i]<=iLast ){
6080bb9b5f26Sdrh       return 0;
6081bb9b5f26Sdrh     }
6082bb9b5f26Sdrh   }
6083bb9b5f26Sdrh   return 1;
6084bb9b5f26Sdrh }
6085bb9b5f26Sdrh #endif /* SQLITE_DEBUG */
6086