xref: /sqlite-3.40.0/src/expr.c (revision 19e4eefb)
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) ){
489bb612f2Sdrh     assert( pExpr->op==TK_COLLATE
499bb612f2Sdrh          || pExpr->op==TK_IF_NULL_ROW
509bb612f2Sdrh          || (pExpr->op==TK_REGISTER && pExpr->op2==TK_IF_NULL_ROW) );
51a7d6db6aSdrh     pExpr = pExpr->pLeft;
52a7d6db6aSdrh     assert( pExpr!=0 );
53a7d6db6aSdrh   }
54580c8c18Sdrh   op = pExpr->op;
55de0e1b15Sdrh   if( op==TK_REGISTER ) op = pExpr->op2;
56de0e1b15Sdrh   if( (op==TK_COLUMN || op==TK_AGG_COLUMN) && pExpr->y.pTab ){
57de0e1b15Sdrh     return sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
58de0e1b15Sdrh   }
59487e262fSdrh   if( op==TK_SELECT ){
606ab3a2ecSdanielk1977     assert( pExpr->flags&EP_xIsSelect );
616af305deSdrh     assert( pExpr->x.pSelect!=0 );
626af305deSdrh     assert( pExpr->x.pSelect->pEList!=0 );
636af305deSdrh     assert( pExpr->x.pSelect->pEList->a[0].pExpr!=0 );
646ab3a2ecSdanielk1977     return sqlite3ExprAffinity(pExpr->x.pSelect->pEList->a[0].pExpr);
65a37cdde0Sdanielk1977   }
66487e262fSdrh #ifndef SQLITE_OMIT_CAST
67487e262fSdrh   if( op==TK_CAST ){
6833e619fcSdrh     assert( !ExprHasProperty(pExpr, EP_IntValue) );
69fdaac671Sdrh     return sqlite3AffinityType(pExpr->u.zToken, 0);
70487e262fSdrh   }
71487e262fSdrh #endif
7280aa5453Sdan   if( op==TK_SELECT_COLUMN ){
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 ){
98433a3e93Sdrh   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){
448bf7f3a00Sdrh   assert( i<sqlite3ExprVectorSize(pVector) || pVector->op==TK_ERROR );
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;
56405428127Sdrh   assert( op==TK_VECTOR || op==TK_REGISTER || op==TK_SELECT || op==TK_ERROR );
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   }
57305428127Sdrh   if( op==TK_VECTOR ){
574870a0705Sdan     *ppExpr = pVector->x.pList->a[iField].pExpr;
5755c288b92Sdan     return sqlite3ExprCodeTemp(pParse, *ppExpr, pRegFree);
5765c288b92Sdan   }
57705428127Sdrh   return 0;
57805428127Sdrh }
5795c288b92Sdan 
5805c288b92Sdan /*
5815c288b92Sdan ** Expression pExpr is a comparison between two vector values. Compute
58279752b6eSdrh ** the result of the comparison (1, 0, or NULL) and write that
58379752b6eSdrh ** result into register dest.
58479752b6eSdrh **
58579752b6eSdrh ** The caller must satisfy the following preconditions:
58679752b6eSdrh **
58779752b6eSdrh **    if pExpr->op==TK_IS:      op==TK_EQ and p5==SQLITE_NULLEQ
58879752b6eSdrh **    if pExpr->op==TK_ISNOT:   op==TK_NE and p5==SQLITE_NULLEQ
58979752b6eSdrh **    otherwise:                op==pExpr->op and p5==0
5905c288b92Sdan */
59179752b6eSdrh static void codeVectorCompare(
59279752b6eSdrh   Parse *pParse,        /* Code generator context */
59379752b6eSdrh   Expr *pExpr,          /* The comparison operation */
59479752b6eSdrh   int dest,             /* Write results into this register */
59579752b6eSdrh   u8 op,                /* Comparison operator */
59679752b6eSdrh   u8 p5                 /* SQLITE_NULLEQ or zero */
59779752b6eSdrh ){
59871c57db0Sdan   Vdbe *v = pParse->pVdbe;
59971c57db0Sdan   Expr *pLeft = pExpr->pLeft;
60071c57db0Sdan   Expr *pRight = pExpr->pRight;
60171c57db0Sdan   int nLeft = sqlite3ExprVectorSize(pLeft);
60271c57db0Sdan   int i;
60371c57db0Sdan   int regLeft = 0;
60471c57db0Sdan   int regRight = 0;
60579752b6eSdrh   u8 opx = op;
6064bc20452Sdrh   int addrCmp = 0;
607ec4ccdbcSdrh   int addrDone = sqlite3VdbeMakeLabel(pParse);
608898c527eSdrh   int isCommuted = ExprHasProperty(pExpr,EP_Commuted);
60971c57db0Sdan 
610e7375bfaSdrh   assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
611340fd0bcSdrh   if( pParse->nErr ) return;
612245ce62eSdrh   if( nLeft!=sqlite3ExprVectorSize(pRight) ){
613245ce62eSdrh     sqlite3ErrorMsg(pParse, "row value misused");
614245ce62eSdrh     return;
615245ce62eSdrh   }
61671c57db0Sdan   assert( pExpr->op==TK_EQ || pExpr->op==TK_NE
61771c57db0Sdan        || pExpr->op==TK_IS || pExpr->op==TK_ISNOT
61871c57db0Sdan        || pExpr->op==TK_LT || pExpr->op==TK_GT
61971c57db0Sdan        || pExpr->op==TK_LE || pExpr->op==TK_GE
62071c57db0Sdan   );
62179752b6eSdrh   assert( pExpr->op==op || (pExpr->op==TK_IS && op==TK_EQ)
62279752b6eSdrh             || (pExpr->op==TK_ISNOT && op==TK_NE) );
62379752b6eSdrh   assert( p5==0 || pExpr->op!=op );
62479752b6eSdrh   assert( p5==SQLITE_NULLEQ || pExpr->op==op );
62571c57db0Sdan 
6264bc20452Sdrh   if( op==TK_LE ) opx = TK_LT;
6274bc20452Sdrh   if( op==TK_GE ) opx = TK_GT;
6284bc20452Sdrh   if( op==TK_NE ) opx = TK_EQ;
6295c288b92Sdan 
6305c288b92Sdan   regLeft = exprCodeSubselect(pParse, pLeft);
6315c288b92Sdan   regRight = exprCodeSubselect(pParse, pRight);
6325c288b92Sdan 
6334bc20452Sdrh   sqlite3VdbeAddOp2(v, OP_Integer, 1, dest);
634321e828dSdrh   for(i=0; 1 /*Loop exits by "break"*/; i++){
6355c288b92Sdan     int regFree1 = 0, regFree2 = 0;
6365c288b92Sdan     Expr *pL, *pR;
6375c288b92Sdan     int r1, r2;
638321e828dSdrh     assert( i>=0 && i<nLeft );
6394bc20452Sdrh     if( addrCmp ) sqlite3VdbeJumpHere(v, addrCmp);
6405c288b92Sdan     r1 = exprVectorRegister(pParse, pLeft, i, regLeft, &pL, &regFree1);
6415c288b92Sdan     r2 = exprVectorRegister(pParse, pRight, i, regRight, &pR, &regFree2);
6424bc20452Sdrh     addrCmp = sqlite3VdbeCurrentAddr(v);
6434bc20452Sdrh     codeCompare(pParse, pL, pR, opx, r1, r2, addrDone, p5, isCommuted);
64479752b6eSdrh     testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
64579752b6eSdrh     testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
64679752b6eSdrh     testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
64779752b6eSdrh     testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
64879752b6eSdrh     testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
64979752b6eSdrh     testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
65071c57db0Sdan     sqlite3ReleaseTempReg(pParse, regFree1);
65171c57db0Sdan     sqlite3ReleaseTempReg(pParse, regFree2);
6524bc20452Sdrh     if( (opx==TK_LT || opx==TK_GT) && i<nLeft-1 ){
6534bc20452Sdrh       addrCmp = sqlite3VdbeAddOp0(v, OP_ElseEq);
6544bc20452Sdrh       testcase(opx==TK_LT); VdbeCoverageIf(v,opx==TK_LT);
6554bc20452Sdrh       testcase(opx==TK_GT); VdbeCoverageIf(v,opx==TK_GT);
6564bc20452Sdrh     }
6574bc20452Sdrh     if( p5==SQLITE_NULLEQ ){
6584bc20452Sdrh       sqlite3VdbeAddOp2(v, OP_Integer, 0, dest);
6594bc20452Sdrh     }else{
6604bc20452Sdrh       sqlite3VdbeAddOp3(v, OP_ZeroOrNull, r1, dest, r2);
6614bc20452Sdrh     }
66279752b6eSdrh     if( i==nLeft-1 ){
66379752b6eSdrh       break;
66471c57db0Sdan     }
66579752b6eSdrh     if( opx==TK_EQ ){
6664bc20452Sdrh       sqlite3VdbeAddOp2(v, OP_NotNull, dest, addrDone); VdbeCoverage(v);
667a2f62925Sdrh     }else{
668a2f62925Sdrh       assert( op==TK_LT || op==TK_GT || op==TK_LE || op==TK_GE );
6694bc20452Sdrh       sqlite3VdbeAddOp2(v, OP_Goto, 0, addrDone);
67079752b6eSdrh       if( i==nLeft-2 ) opx = op;
67171c57db0Sdan     }
67279752b6eSdrh   }
6734bc20452Sdrh   sqlite3VdbeJumpHere(v, addrCmp);
67479752b6eSdrh   sqlite3VdbeResolveLabel(v, addrDone);
6754bc20452Sdrh   if( op==TK_NE ){
6764bc20452Sdrh     sqlite3VdbeAddOp2(v, OP_Not, dest, dest);
6774bc20452Sdrh   }
67879752b6eSdrh }
67971c57db0Sdan 
6804b5255acSdanielk1977 #if SQLITE_MAX_EXPR_DEPTH>0
6814b5255acSdanielk1977 /*
6824b5255acSdanielk1977 ** Check that argument nHeight is less than or equal to the maximum
6834b5255acSdanielk1977 ** expression depth allowed. If it is not, leave an error message in
6844b5255acSdanielk1977 ** pParse.
6854b5255acSdanielk1977 */
6867d10d5a6Sdrh int sqlite3ExprCheckHeight(Parse *pParse, int nHeight){
6874b5255acSdanielk1977   int rc = SQLITE_OK;
6884b5255acSdanielk1977   int mxHeight = pParse->db->aLimit[SQLITE_LIMIT_EXPR_DEPTH];
6894b5255acSdanielk1977   if( nHeight>mxHeight ){
6904b5255acSdanielk1977     sqlite3ErrorMsg(pParse,
6914b5255acSdanielk1977        "Expression tree is too large (maximum depth %d)", mxHeight
6924b5255acSdanielk1977     );
6934b5255acSdanielk1977     rc = SQLITE_ERROR;
6944b5255acSdanielk1977   }
6954b5255acSdanielk1977   return rc;
6964b5255acSdanielk1977 }
6974b5255acSdanielk1977 
6984b5255acSdanielk1977 /* The following three functions, heightOfExpr(), heightOfExprList()
6994b5255acSdanielk1977 ** and heightOfSelect(), are used to determine the maximum height
7004b5255acSdanielk1977 ** of any expression tree referenced by the structure passed as the
7014b5255acSdanielk1977 ** first argument.
7024b5255acSdanielk1977 **
7034b5255acSdanielk1977 ** If this maximum height is greater than the current value pointed
7044b5255acSdanielk1977 ** to by pnHeight, the second parameter, then set *pnHeight to that
7054b5255acSdanielk1977 ** value.
7064b5255acSdanielk1977 */
7074b5255acSdanielk1977 static void heightOfExpr(Expr *p, int *pnHeight){
7084b5255acSdanielk1977   if( p ){
7094b5255acSdanielk1977     if( p->nHeight>*pnHeight ){
7104b5255acSdanielk1977       *pnHeight = p->nHeight;
7114b5255acSdanielk1977     }
7124b5255acSdanielk1977   }
7134b5255acSdanielk1977 }
7144b5255acSdanielk1977 static void heightOfExprList(ExprList *p, int *pnHeight){
7154b5255acSdanielk1977   if( p ){
7164b5255acSdanielk1977     int i;
7174b5255acSdanielk1977     for(i=0; i<p->nExpr; i++){
7184b5255acSdanielk1977       heightOfExpr(p->a[i].pExpr, pnHeight);
7194b5255acSdanielk1977     }
7204b5255acSdanielk1977   }
7214b5255acSdanielk1977 }
7221a3a3086Sdan static void heightOfSelect(Select *pSelect, int *pnHeight){
7231a3a3086Sdan   Select *p;
7241a3a3086Sdan   for(p=pSelect; p; p=p->pPrior){
7254b5255acSdanielk1977     heightOfExpr(p->pWhere, pnHeight);
7264b5255acSdanielk1977     heightOfExpr(p->pHaving, pnHeight);
7274b5255acSdanielk1977     heightOfExpr(p->pLimit, pnHeight);
7284b5255acSdanielk1977     heightOfExprList(p->pEList, pnHeight);
7294b5255acSdanielk1977     heightOfExprList(p->pGroupBy, pnHeight);
7304b5255acSdanielk1977     heightOfExprList(p->pOrderBy, pnHeight);
7314b5255acSdanielk1977   }
7324b5255acSdanielk1977 }
7334b5255acSdanielk1977 
7344b5255acSdanielk1977 /*
7354b5255acSdanielk1977 ** Set the Expr.nHeight variable in the structure passed as an
7364b5255acSdanielk1977 ** argument. An expression with no children, Expr.pList or
7374b5255acSdanielk1977 ** Expr.pSelect member has a height of 1. Any other expression
7384b5255acSdanielk1977 ** has a height equal to the maximum height of any other
7394b5255acSdanielk1977 ** referenced Expr plus one.
7402308ed38Sdrh **
7412308ed38Sdrh ** Also propagate EP_Propagate flags up from Expr.x.pList to Expr.flags,
7422308ed38Sdrh ** if appropriate.
7434b5255acSdanielk1977 */
7444b5255acSdanielk1977 static void exprSetHeight(Expr *p){
7454b5255acSdanielk1977   int nHeight = 0;
7464b5255acSdanielk1977   heightOfExpr(p->pLeft, &nHeight);
7474b5255acSdanielk1977   heightOfExpr(p->pRight, &nHeight);
7486ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_xIsSelect) ){
7496ab3a2ecSdanielk1977     heightOfSelect(p->x.pSelect, &nHeight);
7502308ed38Sdrh   }else if( p->x.pList ){
7516ab3a2ecSdanielk1977     heightOfExprList(p->x.pList, &nHeight);
7522308ed38Sdrh     p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
7536ab3a2ecSdanielk1977   }
7544b5255acSdanielk1977   p->nHeight = nHeight + 1;
7554b5255acSdanielk1977 }
7564b5255acSdanielk1977 
7574b5255acSdanielk1977 /*
7584b5255acSdanielk1977 ** Set the Expr.nHeight variable using the exprSetHeight() function. If
7594b5255acSdanielk1977 ** the height is greater than the maximum allowed expression depth,
7604b5255acSdanielk1977 ** leave an error in pParse.
7612308ed38Sdrh **
7622308ed38Sdrh ** Also propagate all EP_Propagate flags from the Expr.x.pList into
7632308ed38Sdrh ** Expr.flags.
7644b5255acSdanielk1977 */
7652308ed38Sdrh void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
76674893a4cSdrh   if( pParse->nErr ) return;
7674b5255acSdanielk1977   exprSetHeight(p);
7687d10d5a6Sdrh   sqlite3ExprCheckHeight(pParse, p->nHeight);
7694b5255acSdanielk1977 }
7704b5255acSdanielk1977 
7714b5255acSdanielk1977 /*
7724b5255acSdanielk1977 ** Return the maximum height of any expression tree referenced
7734b5255acSdanielk1977 ** by the select statement passed as an argument.
7744b5255acSdanielk1977 */
7754b5255acSdanielk1977 int sqlite3SelectExprHeight(Select *p){
7764b5255acSdanielk1977   int nHeight = 0;
7774b5255acSdanielk1977   heightOfSelect(p, &nHeight);
7784b5255acSdanielk1977   return nHeight;
7794b5255acSdanielk1977 }
7802308ed38Sdrh #else /* ABOVE:  Height enforcement enabled.  BELOW: Height enforcement off */
7812308ed38Sdrh /*
7822308ed38Sdrh ** Propagate all EP_Propagate flags from the Expr.x.pList into
7832308ed38Sdrh ** Expr.flags.
7842308ed38Sdrh */
7852308ed38Sdrh void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
7866c3b4b07Sdan   if( pParse->nErr ) return;
7872308ed38Sdrh   if( p && p->x.pList && !ExprHasProperty(p, EP_xIsSelect) ){
7882308ed38Sdrh     p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
7892308ed38Sdrh   }
7902308ed38Sdrh }
7914b5255acSdanielk1977 #define exprSetHeight(y)
7924b5255acSdanielk1977 #endif /* SQLITE_MAX_EXPR_DEPTH>0 */
7934b5255acSdanielk1977 
794be5c89acSdrh /*
795b7916a78Sdrh ** This routine is the core allocator for Expr nodes.
796b7916a78Sdrh **
797a76b5dfcSdrh ** Construct a new expression node and return a pointer to it.  Memory
798b7916a78Sdrh ** for this node and for the pToken argument is a single allocation
799b7916a78Sdrh ** obtained from sqlite3DbMalloc().  The calling function
800a76b5dfcSdrh ** is responsible for making sure the node eventually gets freed.
801b7916a78Sdrh **
802b7916a78Sdrh ** If dequote is true, then the token (if it exists) is dequoted.
803e792b5b4Sdrh ** If dequote is false, no dequoting is performed.  The deQuote
804b7916a78Sdrh ** parameter is ignored if pToken is NULL or if the token does not
805b7916a78Sdrh ** appear to be quoted.  If the quotes were of the form "..." (double-quotes)
806b7916a78Sdrh ** then the EP_DblQuoted flag is set on the expression node.
80733e619fcSdrh **
80833e619fcSdrh ** Special case:  If op==TK_INTEGER and pToken points to a string that
80933e619fcSdrh ** can be translated into a 32-bit integer, then the token is not
81033e619fcSdrh ** stored in u.zToken.  Instead, the integer values is written
81133e619fcSdrh ** into u.iValue and the EP_IntValue flag is set.  No extra storage
81233e619fcSdrh ** is allocated to hold the integer text and the dequote flag is ignored.
813a76b5dfcSdrh */
814b7916a78Sdrh Expr *sqlite3ExprAlloc(
815cca8a4adSdrh   sqlite3 *db,            /* Handle for sqlite3DbMallocRawNN() */
81617435752Sdrh   int op,                 /* Expression opcode */
817b7916a78Sdrh   const Token *pToken,    /* Token argument.  Might be NULL */
818b7916a78Sdrh   int dequote             /* True to dequote */
81917435752Sdrh ){
820a76b5dfcSdrh   Expr *pNew;
82133e619fcSdrh   int nExtra = 0;
822cf697396Sshane   int iValue = 0;
823b7916a78Sdrh 
824575fad65Sdrh   assert( db!=0 );
825b7916a78Sdrh   if( pToken ){
82633e619fcSdrh     if( op!=TK_INTEGER || pToken->z==0
82733e619fcSdrh           || sqlite3GetInt32(pToken->z, &iValue)==0 ){
828b7916a78Sdrh       nExtra = pToken->n+1;
829d50ffc41Sdrh       assert( iValue>=0 );
83033e619fcSdrh     }
831a76b5dfcSdrh   }
832575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, sizeof(Expr)+nExtra);
833b7916a78Sdrh   if( pNew ){
834ca3862dcSdrh     memset(pNew, 0, sizeof(Expr));
8351bd10f8aSdrh     pNew->op = (u8)op;
836a58fdfb1Sdanielk1977     pNew->iAgg = -1;
837a76b5dfcSdrh     if( pToken ){
83833e619fcSdrh       if( nExtra==0 ){
839ad31727fSdrh         pNew->flags |= EP_IntValue|EP_Leaf|(iValue?EP_IsTrue:EP_IsFalse);
84033e619fcSdrh         pNew->u.iValue = iValue;
84133e619fcSdrh       }else{
84233e619fcSdrh         pNew->u.zToken = (char*)&pNew[1];
843b07028f7Sdrh         assert( pToken->z!=0 || pToken->n==0 );
844b07028f7Sdrh         if( pToken->n ) memcpy(pNew->u.zToken, pToken->z, pToken->n);
84533e619fcSdrh         pNew->u.zToken[pToken->n] = 0;
846244b9d6eSdrh         if( dequote && sqlite3Isquote(pNew->u.zToken[0]) ){
84751d35b0fSdrh           sqlite3DequoteExpr(pNew);
848a34001c9Sdrh         }
849a34001c9Sdrh       }
85033e619fcSdrh     }
851b7916a78Sdrh #if SQLITE_MAX_EXPR_DEPTH>0
852b7916a78Sdrh     pNew->nHeight = 1;
853b7916a78Sdrh #endif
854a34001c9Sdrh   }
855a76b5dfcSdrh   return pNew;
856a76b5dfcSdrh }
857a76b5dfcSdrh 
858a76b5dfcSdrh /*
859b7916a78Sdrh ** Allocate a new expression node from a zero-terminated token that has
860b7916a78Sdrh ** already been dequoted.
861b7916a78Sdrh */
862b7916a78Sdrh Expr *sqlite3Expr(
863b7916a78Sdrh   sqlite3 *db,            /* Handle for sqlite3DbMallocZero() (may be null) */
864b7916a78Sdrh   int op,                 /* Expression opcode */
865b7916a78Sdrh   const char *zToken      /* Token argument.  Might be NULL */
866b7916a78Sdrh ){
867b7916a78Sdrh   Token x;
868b7916a78Sdrh   x.z = zToken;
869b40f06c6Sdrh   x.n = sqlite3Strlen30(zToken);
870b7916a78Sdrh   return sqlite3ExprAlloc(db, op, &x, 0);
871b7916a78Sdrh }
872b7916a78Sdrh 
873b7916a78Sdrh /*
874b7916a78Sdrh ** Attach subtrees pLeft and pRight to the Expr node pRoot.
875b7916a78Sdrh **
876b7916a78Sdrh ** If pRoot==NULL that means that a memory allocation error has occurred.
877b7916a78Sdrh ** In that case, delete the subtrees pLeft and pRight.
878b7916a78Sdrh */
879b7916a78Sdrh void sqlite3ExprAttachSubtrees(
880b7916a78Sdrh   sqlite3 *db,
881b7916a78Sdrh   Expr *pRoot,
882b7916a78Sdrh   Expr *pLeft,
883b7916a78Sdrh   Expr *pRight
884b7916a78Sdrh ){
885b7916a78Sdrh   if( pRoot==0 ){
886b7916a78Sdrh     assert( db->mallocFailed );
887b7916a78Sdrh     sqlite3ExprDelete(db, pLeft);
888b7916a78Sdrh     sqlite3ExprDelete(db, pRight);
889b7916a78Sdrh   }else{
890b7916a78Sdrh     if( pRight ){
891b7916a78Sdrh       pRoot->pRight = pRight;
892885a5b03Sdrh       pRoot->flags |= EP_Propagate & pRight->flags;
893b7916a78Sdrh     }
894b7916a78Sdrh     if( pLeft ){
895b7916a78Sdrh       pRoot->pLeft = pLeft;
896885a5b03Sdrh       pRoot->flags |= EP_Propagate & pLeft->flags;
897b7916a78Sdrh     }
898b7916a78Sdrh     exprSetHeight(pRoot);
899b7916a78Sdrh   }
900b7916a78Sdrh }
901b7916a78Sdrh 
902b7916a78Sdrh /*
90360ec914cSpeter.d.reid ** Allocate an Expr node which joins as many as two subtrees.
904b7916a78Sdrh **
905bf664469Sdrh ** One or both of the subtrees can be NULL.  Return a pointer to the new
906bf664469Sdrh ** Expr node.  Or, if an OOM error occurs, set pParse->db->mallocFailed,
907bf664469Sdrh ** free the subtrees and return NULL.
908206f3d96Sdrh */
90917435752Sdrh Expr *sqlite3PExpr(
91017435752Sdrh   Parse *pParse,          /* Parsing context */
91117435752Sdrh   int op,                 /* Expression opcode */
91217435752Sdrh   Expr *pLeft,            /* Left operand */
913abfd35eaSdrh   Expr *pRight            /* Right operand */
91417435752Sdrh ){
9155fb52caaSdrh   Expr *p;
916abfd35eaSdrh   p = sqlite3DbMallocRawNN(pParse->db, sizeof(Expr));
917abfd35eaSdrh   if( p ){
918abfd35eaSdrh     memset(p, 0, sizeof(Expr));
919f1722baaSdrh     p->op = op & 0xff;
920abfd35eaSdrh     p->iAgg = -1;
921b7916a78Sdrh     sqlite3ExprAttachSubtrees(pParse->db, p, pLeft, pRight);
9222b359bdbSdan     sqlite3ExprCheckHeight(pParse, p->nHeight);
923d5c851c1Sdrh   }else{
924d5c851c1Sdrh     sqlite3ExprDelete(pParse->db, pLeft);
925d5c851c1Sdrh     sqlite3ExprDelete(pParse->db, pRight);
9262b359bdbSdan   }
9274e0cff60Sdrh   return p;
9284e0cff60Sdrh }
9294e0cff60Sdrh 
9304e0cff60Sdrh /*
93108de4f79Sdrh ** Add pSelect to the Expr.x.pSelect field.  Or, if pExpr is NULL (due
93208de4f79Sdrh ** do a memory allocation failure) then delete the pSelect object.
93308de4f79Sdrh */
93408de4f79Sdrh void sqlite3PExprAddSelect(Parse *pParse, Expr *pExpr, Select *pSelect){
93508de4f79Sdrh   if( pExpr ){
93608de4f79Sdrh     pExpr->x.pSelect = pSelect;
93708de4f79Sdrh     ExprSetProperty(pExpr, EP_xIsSelect|EP_Subquery);
93808de4f79Sdrh     sqlite3ExprSetHeightAndFlags(pParse, pExpr);
93908de4f79Sdrh   }else{
94008de4f79Sdrh     assert( pParse->db->mallocFailed );
94108de4f79Sdrh     sqlite3SelectDelete(pParse->db, pSelect);
94208de4f79Sdrh   }
94308de4f79Sdrh }
94408de4f79Sdrh 
94508de4f79Sdrh 
94608de4f79Sdrh /*
94791bb0eedSdrh ** Join two expressions using an AND operator.  If either expression is
94891bb0eedSdrh ** NULL, then just return the other expression.
9495fb52caaSdrh **
9505fb52caaSdrh ** If one side or the other of the AND is known to be false, then instead
9515fb52caaSdrh ** of returning an AND expression, just return a constant expression with
9525fb52caaSdrh ** a value of false.
95391bb0eedSdrh */
954d5c851c1Sdrh Expr *sqlite3ExprAnd(Parse *pParse, Expr *pLeft, Expr *pRight){
955d5c851c1Sdrh   sqlite3 *db = pParse->db;
95691bb0eedSdrh   if( pLeft==0  ){
95791bb0eedSdrh     return pRight;
95891bb0eedSdrh   }else if( pRight==0 ){
95991bb0eedSdrh     return pLeft;
9602b6e670fSdan   }else if( (ExprAlwaysFalse(pLeft) || ExprAlwaysFalse(pRight))
9612b6e670fSdan          && !IN_RENAME_OBJECT
9622b6e670fSdan   ){
963b3ad4e61Sdrh     sqlite3ExprDeferredDelete(pParse, pLeft);
964b3ad4e61Sdrh     sqlite3ExprDeferredDelete(pParse, pRight);
9655776ee5cSdrh     return sqlite3Expr(db, TK_INTEGER, "0");
96691bb0eedSdrh   }else{
967d5c851c1Sdrh     return sqlite3PExpr(pParse, TK_AND, pLeft, pRight);
968a76b5dfcSdrh   }
969a76b5dfcSdrh }
970a76b5dfcSdrh 
971a76b5dfcSdrh /*
972a76b5dfcSdrh ** Construct a new expression node for a function with multiple
973a76b5dfcSdrh ** arguments.
974a76b5dfcSdrh */
975954733b3Sdrh Expr *sqlite3ExprFunction(
976954733b3Sdrh   Parse *pParse,        /* Parsing context */
977954733b3Sdrh   ExprList *pList,      /* Argument list */
978954733b3Sdrh   Token *pToken,        /* Name of the function */
979954733b3Sdrh   int eDistinct         /* SF_Distinct or SF_ALL or 0 */
980954733b3Sdrh ){
981a76b5dfcSdrh   Expr *pNew;
982633e6d57Sdrh   sqlite3 *db = pParse->db;
9834b202ae2Sdanielk1977   assert( pToken );
984b7916a78Sdrh   pNew = sqlite3ExprAlloc(db, TK_FUNCTION, pToken, 1);
985a76b5dfcSdrh   if( pNew==0 ){
986d9da78a2Sdrh     sqlite3ExprListDelete(db, pList); /* Avoid memory leak when malloc fails */
987a76b5dfcSdrh     return 0;
988a76b5dfcSdrh   }
989954733b3Sdrh   if( pList && pList->nExpr > pParse->db->aLimit[SQLITE_LIMIT_FUNCTION_ARG] ){
990954733b3Sdrh     sqlite3ErrorMsg(pParse, "too many arguments on function %T", pToken);
991954733b3Sdrh   }
9926ab3a2ecSdanielk1977   pNew->x.pList = pList;
993fca23557Sdrh   ExprSetProperty(pNew, EP_HasFunc);
9946ab3a2ecSdanielk1977   assert( !ExprHasProperty(pNew, EP_xIsSelect) );
9952308ed38Sdrh   sqlite3ExprSetHeightAndFlags(pParse, pNew);
996954733b3Sdrh   if( eDistinct==SF_Distinct ) ExprSetProperty(pNew, EP_Distinct);
997a76b5dfcSdrh   return pNew;
998a76b5dfcSdrh }
999a76b5dfcSdrh 
1000a76b5dfcSdrh /*
10010dfa5255Sdrh ** Check to see if a function is usable according to current access
10020dfa5255Sdrh ** rules:
10030dfa5255Sdrh **
10040dfa5255Sdrh **    SQLITE_FUNC_DIRECT    -     Only usable from top-level SQL
10050dfa5255Sdrh **
10060dfa5255Sdrh **    SQLITE_FUNC_UNSAFE    -     Usable if TRUSTED_SCHEMA or from
10070dfa5255Sdrh **                                top-level SQL
10080dfa5255Sdrh **
10090dfa5255Sdrh ** If the function is not usable, create an error.
10100dfa5255Sdrh */
10110dfa5255Sdrh void sqlite3ExprFunctionUsable(
10120dfa5255Sdrh   Parse *pParse,         /* Parsing and code generating context */
10130dfa5255Sdrh   Expr *pExpr,           /* The function invocation */
10140dfa5255Sdrh   FuncDef *pDef          /* The function being invoked */
10150dfa5255Sdrh ){
10160dfa5255Sdrh   assert( !IN_RENAME_OBJECT );
10172eeca204Sdrh   assert( (pDef->funcFlags & (SQLITE_FUNC_DIRECT|SQLITE_FUNC_UNSAFE))!=0 );
10182eeca204Sdrh   if( ExprHasProperty(pExpr, EP_FromDDL) ){
10190dfa5255Sdrh     if( (pDef->funcFlags & SQLITE_FUNC_DIRECT)!=0
10200dfa5255Sdrh      || (pParse->db->flags & SQLITE_TrustedSchema)==0
10210dfa5255Sdrh     ){
10220dfa5255Sdrh       /* Functions prohibited in triggers and views if:
10230dfa5255Sdrh       **     (1) tagged with SQLITE_DIRECTONLY
10240dfa5255Sdrh       **     (2) not tagged with SQLITE_INNOCUOUS (which means it
10250dfa5255Sdrh       **         is tagged with SQLITE_FUNC_UNSAFE) and
10260dfa5255Sdrh       **         SQLITE_DBCONFIG_TRUSTED_SCHEMA is off (meaning
10270dfa5255Sdrh       **         that the schema is possibly tainted).
10280dfa5255Sdrh       */
10290dfa5255Sdrh       sqlite3ErrorMsg(pParse, "unsafe use of %s()", pDef->zName);
10300dfa5255Sdrh     }
10310dfa5255Sdrh   }
10320dfa5255Sdrh }
10330dfa5255Sdrh 
10340dfa5255Sdrh /*
1035fa6bc000Sdrh ** Assign a variable number to an expression that encodes a wildcard
1036fa6bc000Sdrh ** in the original SQL statement.
1037fa6bc000Sdrh **
1038fa6bc000Sdrh ** Wildcards consisting of a single "?" are assigned the next sequential
1039fa6bc000Sdrh ** variable number.
1040fa6bc000Sdrh **
1041fa6bc000Sdrh ** Wildcards of the form "?nnn" are assigned the number "nnn".  We make
10429bf755ccSdrh ** sure "nnn" is not too big to avoid a denial of service attack when
1043fa6bc000Sdrh ** the SQL statement comes from an external source.
1044fa6bc000Sdrh **
104551f49f17Sdrh ** Wildcards of the form ":aaa", "@aaa", or "$aaa" are assigned the same number
1046fa6bc000Sdrh ** as the previous instance of the same wildcard.  Or if this is the first
104760ec914cSpeter.d.reid ** instance of the wildcard, the next sequential variable number is
1048fa6bc000Sdrh ** assigned.
1049fa6bc000Sdrh */
1050de25a88cSdrh void sqlite3ExprAssignVarNumber(Parse *pParse, Expr *pExpr, u32 n){
105117435752Sdrh   sqlite3 *db = pParse->db;
1052b7916a78Sdrh   const char *z;
1053f326d66dSdrh   ynVar x;
105417435752Sdrh 
1055fa6bc000Sdrh   if( pExpr==0 ) return;
1056c5cd1249Sdrh   assert( !ExprHasProperty(pExpr, EP_IntValue|EP_Reduced|EP_TokenOnly) );
105733e619fcSdrh   z = pExpr->u.zToken;
1058b7916a78Sdrh   assert( z!=0 );
1059b7916a78Sdrh   assert( z[0]!=0 );
1060b1ed717fSmistachkin   assert( n==(u32)sqlite3Strlen30(z) );
1061b7916a78Sdrh   if( z[1]==0 ){
1062fa6bc000Sdrh     /* Wildcard of the form "?".  Assign the next variable number */
1063b7916a78Sdrh     assert( z[0]=='?' );
1064f326d66dSdrh     x = (ynVar)(++pParse->nVar);
1065124c0b49Sdrh   }else{
1066f326d66dSdrh     int doAdd = 0;
1067124c0b49Sdrh     if( z[0]=='?' ){
1068fa6bc000Sdrh       /* Wildcard of the form "?nnn".  Convert "nnn" to an integer and
1069fa6bc000Sdrh       ** use it as the variable number */
1070c8d735aeSdan       i64 i;
107118814dfbSdrh       int bOk;
107218814dfbSdrh       if( n==2 ){ /*OPTIMIZATION-IF-TRUE*/
107318814dfbSdrh         i = z[1]-'0';  /* The common case of ?N for a single digit N */
107418814dfbSdrh         bOk = 1;
107518814dfbSdrh       }else{
107618814dfbSdrh         bOk = 0==sqlite3Atoi64(&z[1], &i, n-1, SQLITE_UTF8);
107718814dfbSdrh       }
1078c5499befSdrh       testcase( i==0 );
1079c5499befSdrh       testcase( i==1 );
1080c5499befSdrh       testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]-1 );
1081c5499befSdrh       testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] );
1082c8d735aeSdan       if( bOk==0 || i<1 || i>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
1083fa6bc000Sdrh         sqlite3ErrorMsg(pParse, "variable number must be between ?1 and ?%d",
1084bb4957f8Sdrh             db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]);
1085c9b39288Sdrh         return;
1086fa6bc000Sdrh       }
10878e74e7baSdrh       x = (ynVar)i;
1088f326d66dSdrh       if( x>pParse->nVar ){
1089f326d66dSdrh         pParse->nVar = (int)x;
1090f326d66dSdrh         doAdd = 1;
1091f326d66dSdrh       }else if( sqlite3VListNumToName(pParse->pVList, x)==0 ){
1092f326d66dSdrh         doAdd = 1;
1093fa6bc000Sdrh       }
1094fa6bc000Sdrh     }else{
109551f49f17Sdrh       /* Wildcards like ":aaa", "$aaa" or "@aaa".  Reuse the same variable
1096fa6bc000Sdrh       ** number as the prior appearance of the same name, or if the name
1097fa6bc000Sdrh       ** has never appeared before, reuse the same variable number
1098fa6bc000Sdrh       */
10999bf755ccSdrh       x = (ynVar)sqlite3VListNameToNum(pParse->pVList, z, n);
11009bf755ccSdrh       if( x==0 ){
11019bf755ccSdrh         x = (ynVar)(++pParse->nVar);
1102f326d66dSdrh         doAdd = 1;
1103f326d66dSdrh       }
1104f326d66dSdrh     }
1105f326d66dSdrh     if( doAdd ){
11069bf755ccSdrh       pParse->pVList = sqlite3VListAdd(db, pParse->pVList, z, n, x);
1107fa6bc000Sdrh     }
1108fa6bc000Sdrh   }
1109c9b39288Sdrh   pExpr->iColumn = x;
1110f326d66dSdrh   if( x>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
1111832b2664Sdanielk1977     sqlite3ErrorMsg(pParse, "too many SQL variables");
1112832b2664Sdanielk1977   }
1113fa6bc000Sdrh }
1114fa6bc000Sdrh 
1115fa6bc000Sdrh /*
1116f6963f99Sdan ** Recursively delete an expression tree.
1117a2e00042Sdrh */
11184f0010b1Sdrh static SQLITE_NOINLINE void sqlite3ExprDeleteNN(sqlite3 *db, Expr *p){
11194f0010b1Sdrh   assert( p!=0 );
1120d50ffc41Sdrh   /* Sanity check: Assert that the IntValue is non-negative if it exists */
1121d50ffc41Sdrh   assert( !ExprHasProperty(p, EP_IntValue) || p->u.iValue>=0 );
1122eda079cdSdrh 
1123eda079cdSdrh   assert( !ExprHasProperty(p, EP_WinFunc) || p->y.pWin!=0 || db->mallocFailed );
1124eda079cdSdrh   assert( p->op!=TK_FUNCTION || ExprHasProperty(p, EP_TokenOnly|EP_Reduced)
11254f9adee2Sdan           || p->y.pWin==0 || ExprHasProperty(p, EP_WinFunc) );
1126209bc522Sdrh #ifdef SQLITE_DEBUG
1127209bc522Sdrh   if( ExprHasProperty(p, EP_Leaf) && !ExprHasProperty(p, EP_TokenOnly) ){
1128209bc522Sdrh     assert( p->pLeft==0 );
1129209bc522Sdrh     assert( p->pRight==0 );
1130209bc522Sdrh     assert( p->x.pSelect==0 );
1131209bc522Sdrh   }
1132209bc522Sdrh #endif
1133209bc522Sdrh   if( !ExprHasProperty(p, (EP_TokenOnly|EP_Leaf)) ){
1134c5cd1249Sdrh     /* The Expr.x union is never used at the same time as Expr.pRight */
1135c5cd1249Sdrh     assert( p->x.pList==0 || p->pRight==0 );
11364910a76dSdrh     if( p->pLeft && p->op!=TK_SELECT_COLUMN ) sqlite3ExprDeleteNN(db, p->pLeft);
1137d1086679Sdrh     if( p->pRight ){
11384f9adee2Sdan       assert( !ExprHasProperty(p, EP_WinFunc) );
1139d1086679Sdrh       sqlite3ExprDeleteNN(db, p->pRight);
1140d1086679Sdrh     }else if( ExprHasProperty(p, EP_xIsSelect) ){
11414f9adee2Sdan       assert( !ExprHasProperty(p, EP_WinFunc) );
11426ab3a2ecSdanielk1977       sqlite3SelectDelete(db, p->x.pSelect);
11436ab3a2ecSdanielk1977     }else{
11446ab3a2ecSdanielk1977       sqlite3ExprListDelete(db, p->x.pList);
11456ba7ab0dSdan #ifndef SQLITE_OMIT_WINDOWFUNC
1146eda079cdSdrh       if( ExprHasProperty(p, EP_WinFunc) ){
1147eda079cdSdrh         sqlite3WindowDelete(db, p->y.pWin);
114886fb6e17Sdan       }
11496ba7ab0dSdan #endif
11506ab3a2ecSdanielk1977     }
11518117f113Sdan   }
1152209bc522Sdrh   if( ExprHasProperty(p, EP_MemToken) ) sqlite3DbFree(db, p->u.zToken);
115333e619fcSdrh   if( !ExprHasProperty(p, EP_Static) ){
1154dbd6a7dcSdrh     sqlite3DbFreeNN(db, p);
1155a2e00042Sdrh   }
115633e619fcSdrh }
11574f0010b1Sdrh void sqlite3ExprDelete(sqlite3 *db, Expr *p){
11584f0010b1Sdrh   if( p ) sqlite3ExprDeleteNN(db, p);
11594f0010b1Sdrh }
1160a2e00042Sdrh 
1161b3ad4e61Sdrh 
1162b3ad4e61Sdrh /*
1163b3ad4e61Sdrh ** Arrange to cause pExpr to be deleted when the pParse is deleted.
1164b3ad4e61Sdrh ** This is similar to sqlite3ExprDelete() except that the delete is
1165b3ad4e61Sdrh ** deferred untilthe pParse is deleted.
1166b3ad4e61Sdrh **
1167b3ad4e61Sdrh ** The pExpr might be deleted immediately on an OOM error.
1168b3ad4e61Sdrh **
1169b3ad4e61Sdrh ** The deferred delete is (currently) implemented by adding the
1170b3ad4e61Sdrh ** pExpr to the pParse->pConstExpr list with a register number of 0.
1171b3ad4e61Sdrh */
1172b3ad4e61Sdrh void sqlite3ExprDeferredDelete(Parse *pParse, Expr *pExpr){
1173b3ad4e61Sdrh   pParse->pConstExpr =
1174b3ad4e61Sdrh       sqlite3ExprListAppend(pParse, pParse->pConstExpr, pExpr);
1175b3ad4e61Sdrh }
1176b3ad4e61Sdrh 
11778e34e406Sdrh /* Invoke sqlite3RenameExprUnmap() and sqlite3ExprDelete() on the
11788e34e406Sdrh ** expression.
11798e34e406Sdrh */
11808e34e406Sdrh void sqlite3ExprUnmapAndDelete(Parse *pParse, Expr *p){
11818e34e406Sdrh   if( p ){
11828e34e406Sdrh     if( IN_RENAME_OBJECT ){
11838e34e406Sdrh       sqlite3RenameExprUnmap(pParse, p);
11848e34e406Sdrh     }
11858e34e406Sdrh     sqlite3ExprDeleteNN(pParse->db, p);
11868e34e406Sdrh   }
11878e34e406Sdrh }
11888e34e406Sdrh 
1189d2687b77Sdrh /*
11906ab3a2ecSdanielk1977 ** Return the number of bytes allocated for the expression structure
11916ab3a2ecSdanielk1977 ** passed as the first argument. This is always one of EXPR_FULLSIZE,
11926ab3a2ecSdanielk1977 ** EXPR_REDUCEDSIZE or EXPR_TOKENONLYSIZE.
11936ab3a2ecSdanielk1977 */
11946ab3a2ecSdanielk1977 static int exprStructSize(Expr *p){
11956ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_TokenOnly) ) return EXPR_TOKENONLYSIZE;
11966ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_Reduced) ) return EXPR_REDUCEDSIZE;
11976ab3a2ecSdanielk1977   return EXPR_FULLSIZE;
11986ab3a2ecSdanielk1977 }
11996ab3a2ecSdanielk1977 
12006ab3a2ecSdanielk1977 /*
120133e619fcSdrh ** The dupedExpr*Size() routines each return the number of bytes required
120233e619fcSdrh ** to store a copy of an expression or expression tree.  They differ in
120333e619fcSdrh ** how much of the tree is measured.
120433e619fcSdrh **
120533e619fcSdrh **     dupedExprStructSize()     Size of only the Expr structure
120633e619fcSdrh **     dupedExprNodeSize()       Size of Expr + space for token
120733e619fcSdrh **     dupedExprSize()           Expr + token + subtree components
120833e619fcSdrh **
120933e619fcSdrh ***************************************************************************
121033e619fcSdrh **
121133e619fcSdrh ** The dupedExprStructSize() function returns two values OR-ed together:
121233e619fcSdrh ** (1) the space required for a copy of the Expr structure only and
121333e619fcSdrh ** (2) the EP_xxx flags that indicate what the structure size should be.
121433e619fcSdrh ** The return values is always one of:
121533e619fcSdrh **
121633e619fcSdrh **      EXPR_FULLSIZE
121733e619fcSdrh **      EXPR_REDUCEDSIZE   | EP_Reduced
121833e619fcSdrh **      EXPR_TOKENONLYSIZE | EP_TokenOnly
121933e619fcSdrh **
122033e619fcSdrh ** The size of the structure can be found by masking the return value
122133e619fcSdrh ** of this routine with 0xfff.  The flags can be found by masking the
122233e619fcSdrh ** return value with EP_Reduced|EP_TokenOnly.
122333e619fcSdrh **
122433e619fcSdrh ** Note that with flags==EXPRDUP_REDUCE, this routines works on full-size
122533e619fcSdrh ** (unreduced) Expr objects as they or originally constructed by the parser.
122633e619fcSdrh ** During expression analysis, extra information is computed and moved into
1227c95f38d4Sdan ** later parts of the Expr object and that extra information might get chopped
122833e619fcSdrh ** off if the expression is reduced.  Note also that it does not work to
122960ec914cSpeter.d.reid ** make an EXPRDUP_REDUCE copy of a reduced expression.  It is only legal
123033e619fcSdrh ** to reduce a pristine expression tree from the parser.  The implementation
123133e619fcSdrh ** of dupedExprStructSize() contain multiple assert() statements that attempt
123233e619fcSdrh ** to enforce this constraint.
12336ab3a2ecSdanielk1977 */
12346ab3a2ecSdanielk1977 static int dupedExprStructSize(Expr *p, int flags){
12356ab3a2ecSdanielk1977   int nSize;
123633e619fcSdrh   assert( flags==EXPRDUP_REDUCE || flags==0 ); /* Only one flag value allowed */
1237aecd8021Sdrh   assert( EXPR_FULLSIZE<=0xfff );
1238aecd8021Sdrh   assert( (0xfff & (EP_Reduced|EP_TokenOnly))==0 );
123967a9b8edSdan   if( 0==flags || p->op==TK_SELECT_COLUMN
124067a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
1241eda079cdSdrh    || ExprHasProperty(p, EP_WinFunc)
124267a9b8edSdan #endif
124367a9b8edSdan   ){
12446ab3a2ecSdanielk1977     nSize = EXPR_FULLSIZE;
12456ab3a2ecSdanielk1977   }else{
1246c5cd1249Sdrh     assert( !ExprHasProperty(p, EP_TokenOnly|EP_Reduced) );
124733e619fcSdrh     assert( !ExprHasProperty(p, EP_FromJoin) );
1248c5cd1249Sdrh     assert( !ExprHasProperty(p, EP_MemToken) );
1249e7375bfaSdrh     assert( !ExprHasVVAProperty(p, EP_NoReduce) );
1250aecd8021Sdrh     if( p->pLeft || p->x.pList ){
125133e619fcSdrh       nSize = EXPR_REDUCEDSIZE | EP_Reduced;
125233e619fcSdrh     }else{
1253aecd8021Sdrh       assert( p->pRight==0 );
125433e619fcSdrh       nSize = EXPR_TOKENONLYSIZE | EP_TokenOnly;
125533e619fcSdrh     }
12566ab3a2ecSdanielk1977   }
12576ab3a2ecSdanielk1977   return nSize;
12586ab3a2ecSdanielk1977 }
12596ab3a2ecSdanielk1977 
12606ab3a2ecSdanielk1977 /*
126133e619fcSdrh ** This function returns the space in bytes required to store the copy
126233e619fcSdrh ** of the Expr structure and a copy of the Expr.u.zToken string (if that
126333e619fcSdrh ** string is defined.)
12646ab3a2ecSdanielk1977 */
12656ab3a2ecSdanielk1977 static int dupedExprNodeSize(Expr *p, int flags){
126633e619fcSdrh   int nByte = dupedExprStructSize(p, flags) & 0xfff;
126733e619fcSdrh   if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
12687301e774Sdrh     nByte += sqlite3Strlen30NN(p->u.zToken)+1;
12696ab3a2ecSdanielk1977   }
1270bc73971dSdanielk1977   return ROUND8(nByte);
12716ab3a2ecSdanielk1977 }
12726ab3a2ecSdanielk1977 
12736ab3a2ecSdanielk1977 /*
12746ab3a2ecSdanielk1977 ** Return the number of bytes required to create a duplicate of the
12756ab3a2ecSdanielk1977 ** expression passed as the first argument. The second argument is a
12766ab3a2ecSdanielk1977 ** mask containing EXPRDUP_XXX flags.
12776ab3a2ecSdanielk1977 **
12786ab3a2ecSdanielk1977 ** The value returned includes space to create a copy of the Expr struct
127933e619fcSdrh ** itself and the buffer referred to by Expr.u.zToken, if any.
12806ab3a2ecSdanielk1977 **
12816ab3a2ecSdanielk1977 ** If the EXPRDUP_REDUCE flag is set, then the return value includes
12826ab3a2ecSdanielk1977 ** space to duplicate all Expr nodes in the tree formed by Expr.pLeft
12836ab3a2ecSdanielk1977 ** and Expr.pRight variables (but not for any structures pointed to or
12846ab3a2ecSdanielk1977 ** descended from the Expr.x.pList or Expr.x.pSelect variables).
12856ab3a2ecSdanielk1977 */
12866ab3a2ecSdanielk1977 static int dupedExprSize(Expr *p, int flags){
12876ab3a2ecSdanielk1977   int nByte = 0;
12886ab3a2ecSdanielk1977   if( p ){
12896ab3a2ecSdanielk1977     nByte = dupedExprNodeSize(p, flags);
12906ab3a2ecSdanielk1977     if( flags&EXPRDUP_REDUCE ){
1291b7916a78Sdrh       nByte += dupedExprSize(p->pLeft, flags) + dupedExprSize(p->pRight, flags);
12926ab3a2ecSdanielk1977     }
12936ab3a2ecSdanielk1977   }
12946ab3a2ecSdanielk1977   return nByte;
12956ab3a2ecSdanielk1977 }
12966ab3a2ecSdanielk1977 
12976ab3a2ecSdanielk1977 /*
12986ab3a2ecSdanielk1977 ** This function is similar to sqlite3ExprDup(), except that if pzBuffer
12996ab3a2ecSdanielk1977 ** is not NULL then *pzBuffer is assumed to point to a buffer large enough
130033e619fcSdrh ** to store the copy of expression p, the copies of p->u.zToken
13016ab3a2ecSdanielk1977 ** (if applicable), and the copies of the p->pLeft and p->pRight expressions,
130260ec914cSpeter.d.reid ** if any. Before returning, *pzBuffer is set to the first byte past the
13036ab3a2ecSdanielk1977 ** portion of the buffer copied into by this function.
13046ab3a2ecSdanielk1977 */
13053c19469cSdrh static Expr *exprDup(sqlite3 *db, Expr *p, int dupFlags, u8 **pzBuffer){
13063c19469cSdrh   Expr *pNew;           /* Value to return */
13073c19469cSdrh   u8 *zAlloc;           /* Memory space from which to build Expr object */
13083c19469cSdrh   u32 staticFlag;       /* EP_Static if space not obtained from malloc */
13096ab3a2ecSdanielk1977 
13103c19469cSdrh   assert( db!=0 );
13113c19469cSdrh   assert( p );
13123c19469cSdrh   assert( dupFlags==0 || dupFlags==EXPRDUP_REDUCE );
13133c19469cSdrh   assert( pzBuffer==0 || dupFlags==EXPRDUP_REDUCE );
13146ab3a2ecSdanielk1977 
13156ab3a2ecSdanielk1977   /* Figure out where to write the new Expr structure. */
13166ab3a2ecSdanielk1977   if( pzBuffer ){
13176ab3a2ecSdanielk1977     zAlloc = *pzBuffer;
131833e619fcSdrh     staticFlag = EP_Static;
13193c6edc8aSdrh     assert( zAlloc!=0 );
13206ab3a2ecSdanielk1977   }else{
13213c19469cSdrh     zAlloc = sqlite3DbMallocRawNN(db, dupedExprSize(p, dupFlags));
13223c19469cSdrh     staticFlag = 0;
13236ab3a2ecSdanielk1977   }
13246ab3a2ecSdanielk1977   pNew = (Expr *)zAlloc;
13256ab3a2ecSdanielk1977 
13266ab3a2ecSdanielk1977   if( pNew ){
13276ab3a2ecSdanielk1977     /* Set nNewSize to the size allocated for the structure pointed to
13286ab3a2ecSdanielk1977     ** by pNew. This is either EXPR_FULLSIZE, EXPR_REDUCEDSIZE or
13296ab3a2ecSdanielk1977     ** EXPR_TOKENONLYSIZE. nToken is set to the number of bytes consumed
133033e619fcSdrh     ** by the copy of the p->u.zToken string (if any).
13316ab3a2ecSdanielk1977     */
13323c19469cSdrh     const unsigned nStructSize = dupedExprStructSize(p, dupFlags);
133333e619fcSdrh     const int nNewSize = nStructSize & 0xfff;
133433e619fcSdrh     int nToken;
133533e619fcSdrh     if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
133633e619fcSdrh       nToken = sqlite3Strlen30(p->u.zToken) + 1;
133733e619fcSdrh     }else{
133833e619fcSdrh       nToken = 0;
133933e619fcSdrh     }
13403c19469cSdrh     if( dupFlags ){
13416ab3a2ecSdanielk1977       assert( ExprHasProperty(p, EP_Reduced)==0 );
13426ab3a2ecSdanielk1977       memcpy(zAlloc, p, nNewSize);
13436ab3a2ecSdanielk1977     }else{
13443e6a1411Sdan       u32 nSize = (u32)exprStructSize(p);
13456ab3a2ecSdanielk1977       memcpy(zAlloc, p, nSize);
134672ea29d7Sdrh       if( nSize<EXPR_FULLSIZE ){
13476ab3a2ecSdanielk1977         memset(&zAlloc[nSize], 0, EXPR_FULLSIZE-nSize);
13486ab3a2ecSdanielk1977       }
134972ea29d7Sdrh     }
13506ab3a2ecSdanielk1977 
135133e619fcSdrh     /* Set the EP_Reduced, EP_TokenOnly, and EP_Static flags appropriately. */
1352c5cd1249Sdrh     pNew->flags &= ~(EP_Reduced|EP_TokenOnly|EP_Static|EP_MemToken);
135333e619fcSdrh     pNew->flags |= nStructSize & (EP_Reduced|EP_TokenOnly);
135433e619fcSdrh     pNew->flags |= staticFlag;
1355e7375bfaSdrh     ExprClearVVAProperties(pNew);
1356e7375bfaSdrh     if( dupFlags ){
1357e7375bfaSdrh       ExprSetVVAProperty(pNew, EP_Immutable);
1358e7375bfaSdrh     }
13596ab3a2ecSdanielk1977 
136033e619fcSdrh     /* Copy the p->u.zToken string, if any. */
13616ab3a2ecSdanielk1977     if( nToken ){
136233e619fcSdrh       char *zToken = pNew->u.zToken = (char*)&zAlloc[nNewSize];
136333e619fcSdrh       memcpy(zToken, p->u.zToken, nToken);
13646ab3a2ecSdanielk1977     }
13656ab3a2ecSdanielk1977 
1366209bc522Sdrh     if( 0==((p->flags|pNew->flags) & (EP_TokenOnly|EP_Leaf)) ){
13676ab3a2ecSdanielk1977       /* Fill in the pNew->x.pSelect or pNew->x.pList member. */
13686ab3a2ecSdanielk1977       if( ExprHasProperty(p, EP_xIsSelect) ){
13693c19469cSdrh         pNew->x.pSelect = sqlite3SelectDup(db, p->x.pSelect, dupFlags);
13706ab3a2ecSdanielk1977       }else{
13713c19469cSdrh         pNew->x.pList = sqlite3ExprListDup(db, p->x.pList, dupFlags);
13726ab3a2ecSdanielk1977       }
13736ab3a2ecSdanielk1977     }
13746ab3a2ecSdanielk1977 
13756ab3a2ecSdanielk1977     /* Fill in pNew->pLeft and pNew->pRight. */
13764f9adee2Sdan     if( ExprHasProperty(pNew, EP_Reduced|EP_TokenOnly|EP_WinFunc) ){
13773c19469cSdrh       zAlloc += dupedExprNodeSize(p, dupFlags);
1378209bc522Sdrh       if( !ExprHasProperty(pNew, EP_TokenOnly|EP_Leaf) ){
13793c19469cSdrh         pNew->pLeft = p->pLeft ?
13803c19469cSdrh                       exprDup(db, p->pLeft, EXPRDUP_REDUCE, &zAlloc) : 0;
13813c19469cSdrh         pNew->pRight = p->pRight ?
13823c19469cSdrh                        exprDup(db, p->pRight, EXPRDUP_REDUCE, &zAlloc) : 0;
13836ab3a2ecSdanielk1977       }
138467a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
1385eda079cdSdrh       if( ExprHasProperty(p, EP_WinFunc) ){
1386eda079cdSdrh         pNew->y.pWin = sqlite3WindowDup(db, pNew, p->y.pWin);
1387eda079cdSdrh         assert( ExprHasProperty(pNew, EP_WinFunc) );
1388e2f781b9Sdan       }
138967a9b8edSdan #endif /* SQLITE_OMIT_WINDOWFUNC */
139053988068Sdrh       if( pzBuffer ){
139153988068Sdrh         *pzBuffer = zAlloc;
139253988068Sdrh       }
139353988068Sdrh     }else{
1394209bc522Sdrh       if( !ExprHasProperty(p, EP_TokenOnly|EP_Leaf) ){
13959854260bSdrh         if( pNew->op==TK_SELECT_COLUMN ){
13969854260bSdrh           pNew->pLeft = p->pLeft;
139747073f62Sdrh           assert( p->iColumn==0 || p->pRight==0 );
13985cc9daf8Sdrh           assert( p->pRight==0  || p->pRight==p->pLeft
13995cc9daf8Sdrh                                 || ExprHasProperty(p->pLeft, EP_Subquery) );
14009854260bSdrh         }else{
14016ab3a2ecSdanielk1977           pNew->pLeft = sqlite3ExprDup(db, p->pLeft, 0);
14029854260bSdrh         }
14036ab3a2ecSdanielk1977         pNew->pRight = sqlite3ExprDup(db, p->pRight, 0);
14046ab3a2ecSdanielk1977       }
14056ab3a2ecSdanielk1977     }
14066ab3a2ecSdanielk1977   }
14076ab3a2ecSdanielk1977   return pNew;
14086ab3a2ecSdanielk1977 }
14096ab3a2ecSdanielk1977 
14106ab3a2ecSdanielk1977 /*
1411bfe31e7fSdan ** Create and return a deep copy of the object passed as the second
1412bfe31e7fSdan ** argument. If an OOM condition is encountered, NULL is returned
1413bfe31e7fSdan ** and the db->mallocFailed flag set.
1414bfe31e7fSdan */
1415eede6a53Sdan #ifndef SQLITE_OMIT_CTE
1416bfe31e7fSdan static With *withDup(sqlite3 *db, With *p){
14174e9119d9Sdan   With *pRet = 0;
14184e9119d9Sdan   if( p ){
1419d4de9f7bSdrh     sqlite3_int64 nByte = sizeof(*p) + sizeof(p->a[0]) * (p->nCte-1);
14204e9119d9Sdan     pRet = sqlite3DbMallocZero(db, nByte);
14214e9119d9Sdan     if( pRet ){
14224e9119d9Sdan       int i;
14234e9119d9Sdan       pRet->nCte = p->nCte;
14244e9119d9Sdan       for(i=0; i<p->nCte; i++){
14254e9119d9Sdan         pRet->a[i].pSelect = sqlite3SelectDup(db, p->a[i].pSelect, 0);
14264e9119d9Sdan         pRet->a[i].pCols = sqlite3ExprListDup(db, p->a[i].pCols, 0);
14274e9119d9Sdan         pRet->a[i].zName = sqlite3DbStrDup(db, p->a[i].zName);
14284e9119d9Sdan       }
14294e9119d9Sdan     }
14304e9119d9Sdan   }
14314e9119d9Sdan   return pRet;
14324e9119d9Sdan }
1433eede6a53Sdan #else
1434eede6a53Sdan # define withDup(x,y) 0
1435eede6a53Sdan #endif
14364e9119d9Sdan 
1437a8389975Sdrh #ifndef SQLITE_OMIT_WINDOWFUNC
1438a8389975Sdrh /*
1439a8389975Sdrh ** The gatherSelectWindows() procedure and its helper routine
1440a8389975Sdrh ** gatherSelectWindowsCallback() are used to scan all the expressions
1441a8389975Sdrh ** an a newly duplicated SELECT statement and gather all of the Window
1442a8389975Sdrh ** objects found there, assembling them onto the linked list at Select->pWin.
1443a8389975Sdrh */
1444a8389975Sdrh static int gatherSelectWindowsCallback(Walker *pWalker, Expr *pExpr){
14456ba7ab0dSdan   if( pExpr->op==TK_FUNCTION && ExprHasProperty(pExpr, EP_WinFunc) ){
144675b0821eSdan     Select *pSelect = pWalker->u.pSelect;
144775b0821eSdan     Window *pWin = pExpr->y.pWin;
144875b0821eSdan     assert( pWin );
14494f9adee2Sdan     assert( IsWindowFunc(pExpr) );
1450e0ae3f69Sdan     assert( pWin->ppThis==0 );
1451a3fcc000Sdan     sqlite3WindowLink(pSelect, pWin);
1452a8389975Sdrh   }
1453a8389975Sdrh   return WRC_Continue;
1454a8389975Sdrh }
1455a37b6a5eSdrh static int gatherSelectWindowsSelectCallback(Walker *pWalker, Select *p){
1456a37b6a5eSdrh   return p==pWalker->u.pSelect ? WRC_Continue : WRC_Prune;
1457a37b6a5eSdrh }
1458a8389975Sdrh static void gatherSelectWindows(Select *p){
1459a8389975Sdrh   Walker w;
1460a8389975Sdrh   w.xExprCallback = gatherSelectWindowsCallback;
1461a37b6a5eSdrh   w.xSelectCallback = gatherSelectWindowsSelectCallback;
1462a37b6a5eSdrh   w.xSelectCallback2 = 0;
14639c46c66cSdrh   w.pParse = 0;
1464a8389975Sdrh   w.u.pSelect = p;
1465a37b6a5eSdrh   sqlite3WalkSelect(&w, p);
1466a8389975Sdrh }
1467a8389975Sdrh #endif
1468a8389975Sdrh 
1469a8389975Sdrh 
1470a76b5dfcSdrh /*
1471ff78bd2fSdrh ** The following group of routines make deep copies of expressions,
1472ff78bd2fSdrh ** expression lists, ID lists, and select statements.  The copies can
1473ff78bd2fSdrh ** be deleted (by being passed to their respective ...Delete() routines)
1474ff78bd2fSdrh ** without effecting the originals.
1475ff78bd2fSdrh **
14764adee20fSdanielk1977 ** The expression list, ID, and source lists return by sqlite3ExprListDup(),
14774adee20fSdanielk1977 ** sqlite3IdListDup(), and sqlite3SrcListDup() can not be further expanded
1478ad3cab52Sdrh ** by subsequent calls to sqlite*ListAppend() routines.
1479ff78bd2fSdrh **
1480ad3cab52Sdrh ** Any tables that the SrcList might point to are not duplicated.
14816ab3a2ecSdanielk1977 **
1482b7916a78Sdrh ** The flags parameter contains a combination of the EXPRDUP_XXX flags.
14836ab3a2ecSdanielk1977 ** If the EXPRDUP_REDUCE flag is set, then the structure returned is a
14846ab3a2ecSdanielk1977 ** truncated version of the usual Expr structure that will be stored as
14856ab3a2ecSdanielk1977 ** part of the in-memory representation of the database schema.
1486ff78bd2fSdrh */
14876ab3a2ecSdanielk1977 Expr *sqlite3ExprDup(sqlite3 *db, Expr *p, int flags){
148872ea29d7Sdrh   assert( flags==0 || flags==EXPRDUP_REDUCE );
14893c19469cSdrh   return p ? exprDup(db, p, flags, 0) : 0;
1490ff78bd2fSdrh }
14916ab3a2ecSdanielk1977 ExprList *sqlite3ExprListDup(sqlite3 *db, ExprList *p, int flags){
1492ff78bd2fSdrh   ExprList *pNew;
1493145716b3Sdrh   struct ExprList_item *pItem, *pOldItem;
1494ff78bd2fSdrh   int i;
1495b163748eSdrh   Expr *pPriorSelectCol = 0;
1496575fad65Sdrh   assert( db!=0 );
1497ff78bd2fSdrh   if( p==0 ) return 0;
149897258194Sdrh   pNew = sqlite3DbMallocRawNN(db, sqlite3DbMallocSize(db, p));
1499ff78bd2fSdrh   if( pNew==0 ) return 0;
1500a19543feSdrh   pNew->nExpr = p->nExpr;
150150e43c50Sdrh   pNew->nAlloc = p->nAlloc;
150243606175Sdrh   pItem = pNew->a;
1503145716b3Sdrh   pOldItem = p->a;
1504145716b3Sdrh   for(i=0; i<p->nExpr; i++, pItem++, pOldItem++){
15056ab3a2ecSdanielk1977     Expr *pOldExpr = pOldItem->pExpr;
150647073f62Sdrh     Expr *pNewExpr;
1507b5526ea6Sdrh     pItem->pExpr = sqlite3ExprDup(db, pOldExpr, flags);
150847073f62Sdrh     if( pOldExpr
150947073f62Sdrh      && pOldExpr->op==TK_SELECT_COLUMN
151047073f62Sdrh      && (pNewExpr = pItem->pExpr)!=0
151147073f62Sdrh     ){
151247073f62Sdrh       assert( pNewExpr->iColumn==0 || i>0 );
151347073f62Sdrh       if( pNewExpr->iColumn==0 ){
1514ec2f689bSdrh         assert( pOldExpr->pLeft==pOldExpr->pRight
1515ec2f689bSdrh              || ExprHasProperty(pOldExpr->pLeft, EP_Subquery) );
1516b163748eSdrh         pPriorSelectCol = pNewExpr->pLeft = pNewExpr->pRight;
1517b163748eSdrh       }else{
1518b163748eSdrh         assert( i>0 );
1519b163748eSdrh         assert( pItem[-1].pExpr!=0 );
1520b163748eSdrh         assert( pNewExpr->iColumn==pItem[-1].pExpr->iColumn+1 );
1521b163748eSdrh         assert( pPriorSelectCol==pItem[-1].pExpr->pLeft );
1522b163748eSdrh         pNewExpr->pLeft = pPriorSelectCol;
152347073f62Sdrh       }
152447073f62Sdrh     }
152541cee668Sdrh     pItem->zEName = sqlite3DbStrDup(db, pOldItem->zEName);
15266e11892dSdan     pItem->sortFlags = pOldItem->sortFlags;
1527cbb9da33Sdrh     pItem->eEName = pOldItem->eEName;
15283e7bc9caSdrh     pItem->done = 0;
1529ae8e45cbSdan     pItem->bNulls = pOldItem->bNulls;
153024e25d32Sdan     pItem->bSorterRef = pOldItem->bSorterRef;
1531c2acc4e4Sdrh     pItem->u = pOldItem->u;
1532ff78bd2fSdrh   }
1533ff78bd2fSdrh   return pNew;
1534ff78bd2fSdrh }
153593758c8dSdanielk1977 
153693758c8dSdanielk1977 /*
153793758c8dSdanielk1977 ** If cursors, triggers, views and subqueries are all omitted from
153893758c8dSdanielk1977 ** the build, then none of the following routines, except for
153993758c8dSdanielk1977 ** sqlite3SelectDup(), can be called. sqlite3SelectDup() is sometimes
154093758c8dSdanielk1977 ** called with a NULL argument.
154193758c8dSdanielk1977 */
15426a67fe8eSdanielk1977 #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_TRIGGER) \
15436a67fe8eSdanielk1977  || !defined(SQLITE_OMIT_SUBQUERY)
15446ab3a2ecSdanielk1977 SrcList *sqlite3SrcListDup(sqlite3 *db, SrcList *p, int flags){
1545ad3cab52Sdrh   SrcList *pNew;
1546ad3cab52Sdrh   int i;
1547113088ecSdrh   int nByte;
1548575fad65Sdrh   assert( db!=0 );
1549ad3cab52Sdrh   if( p==0 ) return 0;
1550113088ecSdrh   nByte = sizeof(*p) + (p->nSrc>0 ? sizeof(p->a[0]) * (p->nSrc-1) : 0);
1551575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, nByte );
1552ad3cab52Sdrh   if( pNew==0 ) return 0;
15534305d103Sdrh   pNew->nSrc = pNew->nAlloc = p->nSrc;
1554ad3cab52Sdrh   for(i=0; i<p->nSrc; i++){
15557601294aSdrh     SrcItem *pNewItem = &pNew->a[i];
15567601294aSdrh     SrcItem *pOldItem = &p->a[i];
1557ed8a3bb1Sdrh     Table *pTab;
155841fb5cd1Sdan     pNewItem->pSchema = pOldItem->pSchema;
155917435752Sdrh     pNewItem->zDatabase = sqlite3DbStrDup(db, pOldItem->zDatabase);
156017435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
156117435752Sdrh     pNewItem->zAlias = sqlite3DbStrDup(db, pOldItem->zAlias);
15628a48b9c0Sdrh     pNewItem->fg = pOldItem->fg;
15634efc4754Sdrh     pNewItem->iCursor = pOldItem->iCursor;
15645b6a9ed4Sdrh     pNewItem->addrFillSub = pOldItem->addrFillSub;
15655b6a9ed4Sdrh     pNewItem->regReturn = pOldItem->regReturn;
15668a48b9c0Sdrh     if( pNewItem->fg.isIndexedBy ){
15678a48b9c0Sdrh       pNewItem->u1.zIndexedBy = sqlite3DbStrDup(db, pOldItem->u1.zIndexedBy);
15688a48b9c0Sdrh     }
1569a79e2a2dSdrh     pNewItem->u2 = pOldItem->u2;
1570a79e2a2dSdrh     if( pNewItem->fg.isCte ){
1571a79e2a2dSdrh       pNewItem->u2.pCteUse->nUse++;
1572a79e2a2dSdrh     }
15738a48b9c0Sdrh     if( pNewItem->fg.isTabFunc ){
15748a48b9c0Sdrh       pNewItem->u1.pFuncArg =
15758a48b9c0Sdrh           sqlite3ExprListDup(db, pOldItem->u1.pFuncArg, flags);
15768a48b9c0Sdrh     }
1577ed8a3bb1Sdrh     pTab = pNewItem->pTab = pOldItem->pTab;
1578ed8a3bb1Sdrh     if( pTab ){
157979df7782Sdrh       pTab->nTabRef++;
1580a1cb183dSdanielk1977     }
15816ab3a2ecSdanielk1977     pNewItem->pSelect = sqlite3SelectDup(db, pOldItem->pSelect, flags);
15826ab3a2ecSdanielk1977     pNewItem->pOn = sqlite3ExprDup(db, pOldItem->pOn, flags);
158317435752Sdrh     pNewItem->pUsing = sqlite3IdListDup(db, pOldItem->pUsing);
15846c18b6e0Sdanielk1977     pNewItem->colUsed = pOldItem->colUsed;
1585ad3cab52Sdrh   }
1586ad3cab52Sdrh   return pNew;
1587ad3cab52Sdrh }
158817435752Sdrh IdList *sqlite3IdListDup(sqlite3 *db, IdList *p){
1589ff78bd2fSdrh   IdList *pNew;
1590ff78bd2fSdrh   int i;
1591575fad65Sdrh   assert( db!=0 );
1592ff78bd2fSdrh   if( p==0 ) return 0;
1593575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, sizeof(*pNew) );
1594ff78bd2fSdrh   if( pNew==0 ) return 0;
15956c535158Sdrh   pNew->nId = p->nId;
1596575fad65Sdrh   pNew->a = sqlite3DbMallocRawNN(db, p->nId*sizeof(p->a[0]) );
1597d5d56523Sdanielk1977   if( pNew->a==0 ){
1598dbd6a7dcSdrh     sqlite3DbFreeNN(db, pNew);
1599d5d56523Sdanielk1977     return 0;
1600d5d56523Sdanielk1977   }
16016c535158Sdrh   /* Note that because the size of the allocation for p->a[] is not
16026c535158Sdrh   ** necessarily a power of two, sqlite3IdListAppend() may not be called
16036c535158Sdrh   ** on the duplicate created by this function. */
1604ff78bd2fSdrh   for(i=0; i<p->nId; i++){
16054efc4754Sdrh     struct IdList_item *pNewItem = &pNew->a[i];
16064efc4754Sdrh     struct IdList_item *pOldItem = &p->a[i];
160717435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
16084efc4754Sdrh     pNewItem->idx = pOldItem->idx;
1609ff78bd2fSdrh   }
1610ff78bd2fSdrh   return pNew;
1611ff78bd2fSdrh }
1612a7466205Sdan Select *sqlite3SelectDup(sqlite3 *db, Select *pDup, int flags){
1613a7466205Sdan   Select *pRet = 0;
1614a7466205Sdan   Select *pNext = 0;
1615a7466205Sdan   Select **pp = &pRet;
1616a7466205Sdan   Select *p;
1617a7466205Sdan 
1618575fad65Sdrh   assert( db!=0 );
1619a7466205Sdan   for(p=pDup; p; p=p->pPrior){
1620a7466205Sdan     Select *pNew = sqlite3DbMallocRawNN(db, sizeof(*p) );
1621a7466205Sdan     if( pNew==0 ) break;
1622b7916a78Sdrh     pNew->pEList = sqlite3ExprListDup(db, p->pEList, flags);
16236ab3a2ecSdanielk1977     pNew->pSrc = sqlite3SrcListDup(db, p->pSrc, flags);
16246ab3a2ecSdanielk1977     pNew->pWhere = sqlite3ExprDup(db, p->pWhere, flags);
16256ab3a2ecSdanielk1977     pNew->pGroupBy = sqlite3ExprListDup(db, p->pGroupBy, flags);
16266ab3a2ecSdanielk1977     pNew->pHaving = sqlite3ExprDup(db, p->pHaving, flags);
16276ab3a2ecSdanielk1977     pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, flags);
1628ff78bd2fSdrh     pNew->op = p->op;
1629a7466205Sdan     pNew->pNext = pNext;
1630a7466205Sdan     pNew->pPrior = 0;
16316ab3a2ecSdanielk1977     pNew->pLimit = sqlite3ExprDup(db, p->pLimit, flags);
163292b01d53Sdrh     pNew->iLimit = 0;
163392b01d53Sdrh     pNew->iOffset = 0;
16347d10d5a6Sdrh     pNew->selFlags = p->selFlags & ~SF_UsesEphemeral;
1635b9bb7c18Sdrh     pNew->addrOpenEphm[0] = -1;
1636b9bb7c18Sdrh     pNew->addrOpenEphm[1] = -1;
1637ec2da854Sdrh     pNew->nSelectRow = p->nSelectRow;
16384e9119d9Sdan     pNew->pWith = withDup(db, p->pWith);
163967a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
16402e362f97Sdan     pNew->pWin = 0;
1641c95f38d4Sdan     pNew->pWinDefn = sqlite3WindowListDup(db, p->pWinDefn);
16424780b9adSdan     if( p->pWin && db->mallocFailed==0 ) gatherSelectWindows(pNew);
164367a9b8edSdan #endif
1644fef37760Sdrh     pNew->selId = p->selId;
16459da977f1Sdrh     if( db->mallocFailed ){
16469da977f1Sdrh       /* Any prior OOM might have left the Select object incomplete.
16479da977f1Sdrh       ** Delete the whole thing rather than allow an incomplete Select
16489da977f1Sdrh       ** to be used by the code generator. */
16499da977f1Sdrh       pNew->pNext = 0;
16509da977f1Sdrh       sqlite3SelectDelete(db, pNew);
16519da977f1Sdrh       break;
16529da977f1Sdrh     }
1653a7466205Sdan     *pp = pNew;
1654a7466205Sdan     pp = &pNew->pPrior;
1655a7466205Sdan     pNext = pNew;
1656a7466205Sdan   }
1657a7466205Sdan 
1658a7466205Sdan   return pRet;
1659ff78bd2fSdrh }
166093758c8dSdanielk1977 #else
16616ab3a2ecSdanielk1977 Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
166293758c8dSdanielk1977   assert( p==0 );
166393758c8dSdanielk1977   return 0;
166493758c8dSdanielk1977 }
166593758c8dSdanielk1977 #endif
1666ff78bd2fSdrh 
1667ff78bd2fSdrh 
1668ff78bd2fSdrh /*
1669a76b5dfcSdrh ** Add a new element to the end of an expression list.  If pList is
1670a76b5dfcSdrh ** initially NULL, then create a new expression list.
1671b7916a78Sdrh **
1672a19543feSdrh ** The pList argument must be either NULL or a pointer to an ExprList
1673a19543feSdrh ** obtained from a prior call to sqlite3ExprListAppend().  This routine
1674a19543feSdrh ** may not be used with an ExprList obtained from sqlite3ExprListDup().
1675a19543feSdrh ** Reason:  This routine assumes that the number of slots in pList->a[]
1676a19543feSdrh ** is a power of two.  That is true for sqlite3ExprListAppend() returns
1677a19543feSdrh ** but is not necessarily true from the return value of sqlite3ExprListDup().
1678a19543feSdrh **
1679b7916a78Sdrh ** If a memory allocation error occurs, the entire list is freed and
1680b7916a78Sdrh ** NULL is returned.  If non-NULL is returned, then it is guaranteed
1681b7916a78Sdrh ** that the new entry was successfully appended.
1682a76b5dfcSdrh */
1683dabada60Slarrybr static const struct ExprList_item zeroItem = {0};
168450e43c50Sdrh SQLITE_NOINLINE ExprList *sqlite3ExprListAppendNew(
168550e43c50Sdrh   sqlite3 *db,            /* Database handle.  Used for memory allocation */
168650e43c50Sdrh   Expr *pExpr             /* Expression to be appended. Might be NULL */
168750e43c50Sdrh ){
168850e43c50Sdrh   struct ExprList_item *pItem;
168950e43c50Sdrh   ExprList *pList;
169050e43c50Sdrh 
169150e43c50Sdrh   pList = sqlite3DbMallocRawNN(db, sizeof(ExprList)+sizeof(pList->a[0])*4 );
169250e43c50Sdrh   if( pList==0 ){
169350e43c50Sdrh     sqlite3ExprDelete(db, pExpr);
169450e43c50Sdrh     return 0;
169550e43c50Sdrh   }
169650e43c50Sdrh   pList->nAlloc = 4;
169750e43c50Sdrh   pList->nExpr = 1;
169850e43c50Sdrh   pItem = &pList->a[0];
169950e43c50Sdrh   *pItem = zeroItem;
170050e43c50Sdrh   pItem->pExpr = pExpr;
170150e43c50Sdrh   return pList;
170250e43c50Sdrh }
170350e43c50Sdrh SQLITE_NOINLINE ExprList *sqlite3ExprListAppendGrow(
170450e43c50Sdrh   sqlite3 *db,            /* Database handle.  Used for memory allocation */
170550e43c50Sdrh   ExprList *pList,        /* List to which to append. Might be NULL */
170650e43c50Sdrh   Expr *pExpr             /* Expression to be appended. Might be NULL */
170750e43c50Sdrh ){
170850e43c50Sdrh   struct ExprList_item *pItem;
170950e43c50Sdrh   ExprList *pNew;
171050e43c50Sdrh   pList->nAlloc *= 2;
171150e43c50Sdrh   pNew = sqlite3DbRealloc(db, pList,
171250e43c50Sdrh        sizeof(*pList)+(pList->nAlloc-1)*sizeof(pList->a[0]));
171350e43c50Sdrh   if( pNew==0 ){
171450e43c50Sdrh     sqlite3ExprListDelete(db, pList);
171550e43c50Sdrh     sqlite3ExprDelete(db, pExpr);
171650e43c50Sdrh     return 0;
171750e43c50Sdrh   }else{
171850e43c50Sdrh     pList = pNew;
171950e43c50Sdrh   }
172050e43c50Sdrh   pItem = &pList->a[pList->nExpr++];
172150e43c50Sdrh   *pItem = zeroItem;
172250e43c50Sdrh   pItem->pExpr = pExpr;
172350e43c50Sdrh   return pList;
172450e43c50Sdrh }
172517435752Sdrh ExprList *sqlite3ExprListAppend(
172617435752Sdrh   Parse *pParse,          /* Parsing context */
172717435752Sdrh   ExprList *pList,        /* List to which to append. Might be NULL */
1728b7916a78Sdrh   Expr *pExpr             /* Expression to be appended. Might be NULL */
172917435752Sdrh ){
173043606175Sdrh   struct ExprList_item *pItem;
1731a76b5dfcSdrh   if( pList==0 ){
173250e43c50Sdrh     return sqlite3ExprListAppendNew(pParse->db,pExpr);
1733a76b5dfcSdrh   }
173450e43c50Sdrh   if( pList->nAlloc<pList->nExpr+1 ){
173550e43c50Sdrh     return sqlite3ExprListAppendGrow(pParse->db,pList,pExpr);
1736a76b5dfcSdrh   }
173743606175Sdrh   pItem = &pList->a[pList->nExpr++];
173850e43c50Sdrh   *pItem = zeroItem;
1739e94ddc9eSdanielk1977   pItem->pExpr = pExpr;
1740a76b5dfcSdrh   return pList;
1741a76b5dfcSdrh }
1742a76b5dfcSdrh 
1743a76b5dfcSdrh /*
17448762ec19Sdrh ** pColumns and pExpr form a vector assignment which is part of the SET
17458762ec19Sdrh ** clause of an UPDATE statement.  Like this:
1746a1251bc4Sdrh **
1747a1251bc4Sdrh **        (a,b,c) = (expr1,expr2,expr3)
1748a1251bc4Sdrh ** Or:    (a,b,c) = (SELECT x,y,z FROM ....)
1749a1251bc4Sdrh **
1750a1251bc4Sdrh ** For each term of the vector assignment, append new entries to the
1751b67343d0Sdrh ** expression list pList.  In the case of a subquery on the RHS, append
1752a1251bc4Sdrh ** TK_SELECT_COLUMN expressions.
1753a1251bc4Sdrh */
1754a1251bc4Sdrh ExprList *sqlite3ExprListAppendVector(
1755a1251bc4Sdrh   Parse *pParse,         /* Parsing context */
1756a1251bc4Sdrh   ExprList *pList,       /* List to which to append. Might be NULL */
1757a1251bc4Sdrh   IdList *pColumns,      /* List of names of LHS of the assignment */
1758a1251bc4Sdrh   Expr *pExpr            /* Vector expression to be appended. Might be NULL */
1759a1251bc4Sdrh ){
1760a1251bc4Sdrh   sqlite3 *db = pParse->db;
1761a1251bc4Sdrh   int n;
1762a1251bc4Sdrh   int i;
176366860af3Sdrh   int iFirst = pList ? pList->nExpr : 0;
1764321e828dSdrh   /* pColumns can only be NULL due to an OOM but an OOM will cause an
1765321e828dSdrh   ** exit prior to this routine being invoked */
1766321e828dSdrh   if( NEVER(pColumns==0) ) goto vector_append_error;
1767a1251bc4Sdrh   if( pExpr==0 ) goto vector_append_error;
1768966e2911Sdrh 
1769966e2911Sdrh   /* If the RHS is a vector, then we can immediately check to see that
1770966e2911Sdrh   ** the size of the RHS and LHS match.  But if the RHS is a SELECT,
1771966e2911Sdrh   ** wildcards ("*") in the result set of the SELECT must be expanded before
1772966e2911Sdrh   ** we can do the size check, so defer the size check until code generation.
1773966e2911Sdrh   */
1774966e2911Sdrh   if( pExpr->op!=TK_SELECT && pColumns->nId!=(n=sqlite3ExprVectorSize(pExpr)) ){
1775a1251bc4Sdrh     sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
1776a1251bc4Sdrh                     pColumns->nId, n);
1777a1251bc4Sdrh     goto vector_append_error;
1778a1251bc4Sdrh   }
1779966e2911Sdrh 
1780966e2911Sdrh   for(i=0; i<pColumns->nId; i++){
1781a1251bc4Sdrh     Expr *pSubExpr = sqlite3ExprForVectorField(pParse, pExpr, i);
1782554a9dc7Sdrh     assert( pSubExpr!=0 || db->mallocFailed );
1783554a9dc7Sdrh     assert( pSubExpr==0 || pSubExpr->iTable==0 );
1784554a9dc7Sdrh     if( pSubExpr==0 ) continue;
1785554a9dc7Sdrh     pSubExpr->iTable = pColumns->nId;
1786a1251bc4Sdrh     pList = sqlite3ExprListAppend(pParse, pList, pSubExpr);
1787a1251bc4Sdrh     if( pList ){
178866860af3Sdrh       assert( pList->nExpr==iFirst+i+1 );
178941cee668Sdrh       pList->a[pList->nExpr-1].zEName = pColumns->a[i].zName;
1790a1251bc4Sdrh       pColumns->a[i].zName = 0;
1791a1251bc4Sdrh     }
1792a1251bc4Sdrh   }
1793966e2911Sdrh 
1794ffe28059Sdrh   if( !db->mallocFailed && pExpr->op==TK_SELECT && ALWAYS(pList!=0) ){
1795966e2911Sdrh     Expr *pFirst = pList->a[iFirst].pExpr;
1796f4dd26c5Sdrh     assert( pFirst!=0 );
1797966e2911Sdrh     assert( pFirst->op==TK_SELECT_COLUMN );
1798966e2911Sdrh 
1799966e2911Sdrh     /* Store the SELECT statement in pRight so it will be deleted when
1800966e2911Sdrh     ** sqlite3ExprListDelete() is called */
1801966e2911Sdrh     pFirst->pRight = pExpr;
1802a1251bc4Sdrh     pExpr = 0;
1803966e2911Sdrh 
1804966e2911Sdrh     /* Remember the size of the LHS in iTable so that we can check that
1805966e2911Sdrh     ** the RHS and LHS sizes match during code generation. */
1806966e2911Sdrh     pFirst->iTable = pColumns->nId;
1807a1251bc4Sdrh   }
1808a1251bc4Sdrh 
1809a1251bc4Sdrh vector_append_error:
18108e34e406Sdrh   sqlite3ExprUnmapAndDelete(pParse, pExpr);
1811a1251bc4Sdrh   sqlite3IdListDelete(db, pColumns);
1812a1251bc4Sdrh   return pList;
1813a1251bc4Sdrh }
1814a1251bc4Sdrh 
1815a1251bc4Sdrh /*
1816bc622bc0Sdrh ** Set the sort order for the last element on the given ExprList.
1817bc622bc0Sdrh */
18186e11892dSdan void sqlite3ExprListSetSortOrder(ExprList *p, int iSortOrder, int eNulls){
18199105fd51Sdan   struct ExprList_item *pItem;
1820bc622bc0Sdrh   if( p==0 ) return;
1821bc622bc0Sdrh   assert( p->nExpr>0 );
18226e11892dSdan 
18236e11892dSdan   assert( SQLITE_SO_UNDEFINED<0 && SQLITE_SO_ASC==0 && SQLITE_SO_DESC>0 );
18246e11892dSdan   assert( iSortOrder==SQLITE_SO_UNDEFINED
18256e11892dSdan        || iSortOrder==SQLITE_SO_ASC
18266e11892dSdan        || iSortOrder==SQLITE_SO_DESC
18276e11892dSdan   );
18286e11892dSdan   assert( eNulls==SQLITE_SO_UNDEFINED
18296e11892dSdan        || eNulls==SQLITE_SO_ASC
18306e11892dSdan        || eNulls==SQLITE_SO_DESC
18316e11892dSdan   );
18326e11892dSdan 
18339105fd51Sdan   pItem = &p->a[p->nExpr-1];
18349105fd51Sdan   assert( pItem->bNulls==0 );
18359105fd51Sdan   if( iSortOrder==SQLITE_SO_UNDEFINED ){
18369105fd51Sdan     iSortOrder = SQLITE_SO_ASC;
1837bc622bc0Sdrh   }
18389105fd51Sdan   pItem->sortFlags = (u8)iSortOrder;
18399105fd51Sdan 
18409105fd51Sdan   if( eNulls!=SQLITE_SO_UNDEFINED ){
18419105fd51Sdan     pItem->bNulls = 1;
18429105fd51Sdan     if( iSortOrder!=eNulls ){
18439105fd51Sdan       pItem->sortFlags |= KEYINFO_ORDER_BIGNULL;
18449105fd51Sdan     }
1845bc622bc0Sdrh   }
1846bc622bc0Sdrh }
1847bc622bc0Sdrh 
1848bc622bc0Sdrh /*
184941cee668Sdrh ** Set the ExprList.a[].zEName element of the most recently added item
1850b7916a78Sdrh ** on the expression list.
1851b7916a78Sdrh **
1852b7916a78Sdrh ** pList might be NULL following an OOM error.  But pName should never be
1853b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1854b7916a78Sdrh ** is set.
1855b7916a78Sdrh */
1856b7916a78Sdrh void sqlite3ExprListSetName(
1857b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1858b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
1859b7916a78Sdrh   Token *pName,           /* Name to be added */
1860b7916a78Sdrh   int dequote             /* True to cause the name to be dequoted */
1861b7916a78Sdrh ){
1862b7916a78Sdrh   assert( pList!=0 || pParse->db->mallocFailed!=0 );
18632d99f957Sdrh   assert( pParse->eParseMode!=PARSE_MODE_UNMAP || dequote==0 );
1864b7916a78Sdrh   if( pList ){
1865b7916a78Sdrh     struct ExprList_item *pItem;
1866b7916a78Sdrh     assert( pList->nExpr>0 );
1867b7916a78Sdrh     pItem = &pList->a[pList->nExpr-1];
186841cee668Sdrh     assert( pItem->zEName==0 );
1869c4938ea2Sdrh     assert( pItem->eEName==ENAME_NAME );
187041cee668Sdrh     pItem->zEName = sqlite3DbStrNDup(pParse->db, pName->z, pName->n);
187185f2c76cSdan     if( dequote ){
187285f2c76cSdan       /* If dequote==0, then pName->z does not point to part of a DDL
187385f2c76cSdan       ** statement handled by the parser. And so no token need be added
187485f2c76cSdan       ** to the token-map.  */
187585f2c76cSdan       sqlite3Dequote(pItem->zEName);
1876c9461eccSdan       if( IN_RENAME_OBJECT ){
187741cee668Sdrh         sqlite3RenameTokenMap(pParse, (void*)pItem->zEName, pName);
18785be60c55Sdan       }
1879b7916a78Sdrh     }
1880b7916a78Sdrh   }
188185f2c76cSdan }
1882b7916a78Sdrh 
1883b7916a78Sdrh /*
1884b7916a78Sdrh ** Set the ExprList.a[].zSpan element of the most recently added item
1885b7916a78Sdrh ** on the expression list.
1886b7916a78Sdrh **
1887b7916a78Sdrh ** pList might be NULL following an OOM error.  But pSpan should never be
1888b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1889b7916a78Sdrh ** is set.
1890b7916a78Sdrh */
1891b7916a78Sdrh void sqlite3ExprListSetSpan(
1892b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1893b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
18941be266baSdrh   const char *zStart,     /* Start of the span */
18951be266baSdrh   const char *zEnd        /* End of the span */
1896b7916a78Sdrh ){
1897b7916a78Sdrh   sqlite3 *db = pParse->db;
1898b7916a78Sdrh   assert( pList!=0 || db->mallocFailed!=0 );
1899b7916a78Sdrh   if( pList ){
1900b7916a78Sdrh     struct ExprList_item *pItem = &pList->a[pList->nExpr-1];
1901b7916a78Sdrh     assert( pList->nExpr>0 );
1902cbb9da33Sdrh     if( pItem->zEName==0 ){
1903cbb9da33Sdrh       pItem->zEName = sqlite3DbSpanDup(db, zStart, zEnd);
1904cbb9da33Sdrh       pItem->eEName = ENAME_SPAN;
1905cbb9da33Sdrh     }
1906b7916a78Sdrh   }
1907b7916a78Sdrh }
1908b7916a78Sdrh 
1909b7916a78Sdrh /*
19107a15a4beSdanielk1977 ** If the expression list pEList contains more than iLimit elements,
19117a15a4beSdanielk1977 ** leave an error message in pParse.
19127a15a4beSdanielk1977 */
19137a15a4beSdanielk1977 void sqlite3ExprListCheckLength(
19147a15a4beSdanielk1977   Parse *pParse,
19157a15a4beSdanielk1977   ExprList *pEList,
19167a15a4beSdanielk1977   const char *zObject
19177a15a4beSdanielk1977 ){
1918b1a6c3c1Sdrh   int mx = pParse->db->aLimit[SQLITE_LIMIT_COLUMN];
1919c5499befSdrh   testcase( pEList && pEList->nExpr==mx );
1920c5499befSdrh   testcase( pEList && pEList->nExpr==mx+1 );
1921b1a6c3c1Sdrh   if( pEList && pEList->nExpr>mx ){
19227a15a4beSdanielk1977     sqlite3ErrorMsg(pParse, "too many columns in %s", zObject);
19237a15a4beSdanielk1977   }
19247a15a4beSdanielk1977 }
19257a15a4beSdanielk1977 
19267a15a4beSdanielk1977 /*
1927a76b5dfcSdrh ** Delete an entire expression list.
1928a76b5dfcSdrh */
1929affa855cSdrh static SQLITE_NOINLINE void exprListDeleteNN(sqlite3 *db, ExprList *pList){
1930ac48b751Sdrh   int i = pList->nExpr;
1931ac48b751Sdrh   struct ExprList_item *pItem =  pList->a;
1932ac48b751Sdrh   assert( pList->nExpr>0 );
1933ac48b751Sdrh   do{
1934633e6d57Sdrh     sqlite3ExprDelete(db, pItem->pExpr);
193541cee668Sdrh     sqlite3DbFree(db, pItem->zEName);
1936ac48b751Sdrh     pItem++;
1937ac48b751Sdrh   }while( --i>0 );
1938dbd6a7dcSdrh   sqlite3DbFreeNN(db, pList);
1939a76b5dfcSdrh }
1940affa855cSdrh void sqlite3ExprListDelete(sqlite3 *db, ExprList *pList){
1941affa855cSdrh   if( pList ) exprListDeleteNN(db, pList);
1942affa855cSdrh }
1943a76b5dfcSdrh 
1944a76b5dfcSdrh /*
19452308ed38Sdrh ** Return the bitwise-OR of all Expr.flags fields in the given
19462308ed38Sdrh ** ExprList.
1947885a5b03Sdrh */
19482308ed38Sdrh u32 sqlite3ExprListFlags(const ExprList *pList){
1949885a5b03Sdrh   int i;
19502308ed38Sdrh   u32 m = 0;
1951508e2d00Sdrh   assert( pList!=0 );
1952885a5b03Sdrh   for(i=0; i<pList->nExpr; i++){
1953d0c73053Sdrh      Expr *pExpr = pList->a[i].pExpr;
1954de845c2fSdrh      assert( pExpr!=0 );
1955de845c2fSdrh      m |= pExpr->flags;
1956885a5b03Sdrh   }
19572308ed38Sdrh   return m;
1958885a5b03Sdrh }
1959885a5b03Sdrh 
1960885a5b03Sdrh /*
19617e6f980bSdrh ** This is a SELECT-node callback for the expression walker that
19627e6f980bSdrh ** always "fails".  By "fail" in this case, we mean set
19637e6f980bSdrh ** pWalker->eCode to zero and abort.
19647e6f980bSdrh **
19657e6f980bSdrh ** This callback is used by multiple expression walkers.
19667e6f980bSdrh */
19677e6f980bSdrh int sqlite3SelectWalkFail(Walker *pWalker, Select *NotUsed){
19687e6f980bSdrh   UNUSED_PARAMETER(NotUsed);
19697e6f980bSdrh   pWalker->eCode = 0;
19707e6f980bSdrh   return WRC_Abort;
19717e6f980bSdrh }
19727e6f980bSdrh 
19737e6f980bSdrh /*
19740cbec59cSdrh ** Check the input string to see if it is "true" or "false" (in any case).
19750cbec59cSdrh **
19760cbec59cSdrh **       If the string is....           Return
19770cbec59cSdrh **         "true"                         EP_IsTrue
19780cbec59cSdrh **         "false"                        EP_IsFalse
19790cbec59cSdrh **         anything else                  0
19800cbec59cSdrh */
19810cbec59cSdrh u32 sqlite3IsTrueOrFalse(const char *zIn){
19820cbec59cSdrh   if( sqlite3StrICmp(zIn, "true")==0  ) return EP_IsTrue;
19830cbec59cSdrh   if( sqlite3StrICmp(zIn, "false")==0 ) return EP_IsFalse;
19840cbec59cSdrh   return 0;
19850cbec59cSdrh }
19860cbec59cSdrh 
19870cbec59cSdrh 
19880cbec59cSdrh /*
1989171d16bbSdrh ** If the input expression is an ID with the name "true" or "false"
199096acafbeSdrh ** then convert it into an TK_TRUEFALSE term.  Return non-zero if
199196acafbeSdrh ** the conversion happened, and zero if the expression is unaltered.
1992171d16bbSdrh */
1993171d16bbSdrh int sqlite3ExprIdToTrueFalse(Expr *pExpr){
19940cbec59cSdrh   u32 v;
1995171d16bbSdrh   assert( pExpr->op==TK_ID || pExpr->op==TK_STRING );
199651d35b0fSdrh   if( !ExprHasProperty(pExpr, EP_Quoted)
19970cbec59cSdrh    && (v = sqlite3IsTrueOrFalse(pExpr->u.zToken))!=0
1998171d16bbSdrh   ){
1999171d16bbSdrh     pExpr->op = TK_TRUEFALSE;
20000cbec59cSdrh     ExprSetProperty(pExpr, v);
2001171d16bbSdrh     return 1;
2002171d16bbSdrh   }
2003171d16bbSdrh   return 0;
2004171d16bbSdrh }
2005171d16bbSdrh 
200643c4ac8bSdrh /*
200796acafbeSdrh ** The argument must be a TK_TRUEFALSE Expr node.  Return 1 if it is TRUE
200843c4ac8bSdrh ** and 0 if it is FALSE.
200943c4ac8bSdrh */
201096acafbeSdrh int sqlite3ExprTruthValue(const Expr *pExpr){
20116ece353fSdan   pExpr = sqlite3ExprSkipCollate((Expr*)pExpr);
201243c4ac8bSdrh   assert( pExpr->op==TK_TRUEFALSE );
201343c4ac8bSdrh   assert( sqlite3StrICmp(pExpr->u.zToken,"true")==0
201443c4ac8bSdrh        || sqlite3StrICmp(pExpr->u.zToken,"false")==0 );
201543c4ac8bSdrh   return pExpr->u.zToken[4]==0;
201643c4ac8bSdrh }
201743c4ac8bSdrh 
201817180fcaSdrh /*
201917180fcaSdrh ** If pExpr is an AND or OR expression, try to simplify it by eliminating
202017180fcaSdrh ** terms that are always true or false.  Return the simplified expression.
202117180fcaSdrh ** Or return the original expression if no simplification is possible.
202217180fcaSdrh **
202317180fcaSdrh ** Examples:
202417180fcaSdrh **
202517180fcaSdrh **     (x<10) AND true                =>   (x<10)
202617180fcaSdrh **     (x<10) AND false               =>   false
202717180fcaSdrh **     (x<10) AND (y=22 OR false)     =>   (x<10) AND (y=22)
202817180fcaSdrh **     (x<10) AND (y=22 OR true)      =>   (x<10)
202917180fcaSdrh **     (y=22) OR true                 =>   true
203017180fcaSdrh */
203117180fcaSdrh Expr *sqlite3ExprSimplifiedAndOr(Expr *pExpr){
203217180fcaSdrh   assert( pExpr!=0 );
203317180fcaSdrh   if( pExpr->op==TK_AND || pExpr->op==TK_OR ){
203417180fcaSdrh     Expr *pRight = sqlite3ExprSimplifiedAndOr(pExpr->pRight);
203517180fcaSdrh     Expr *pLeft = sqlite3ExprSimplifiedAndOr(pExpr->pLeft);
203617180fcaSdrh     if( ExprAlwaysTrue(pLeft) || ExprAlwaysFalse(pRight) ){
203717180fcaSdrh       pExpr = pExpr->op==TK_AND ? pRight : pLeft;
203817180fcaSdrh     }else if( ExprAlwaysTrue(pRight) || ExprAlwaysFalse(pLeft) ){
203917180fcaSdrh       pExpr = pExpr->op==TK_AND ? pLeft : pRight;
204017180fcaSdrh     }
204117180fcaSdrh   }
204217180fcaSdrh   return pExpr;
204317180fcaSdrh }
204417180fcaSdrh 
2045171d16bbSdrh 
2046171d16bbSdrh /*
2047059b2d50Sdrh ** These routines are Walker callbacks used to check expressions to
2048059b2d50Sdrh ** see if they are "constant" for some definition of constant.  The
2049059b2d50Sdrh ** Walker.eCode value determines the type of "constant" we are looking
2050059b2d50Sdrh ** for.
205173b211abSdrh **
20527d10d5a6Sdrh ** These callback routines are used to implement the following:
2053626a879aSdrh **
2054059b2d50Sdrh **     sqlite3ExprIsConstant()                  pWalker->eCode==1
2055059b2d50Sdrh **     sqlite3ExprIsConstantNotJoin()           pWalker->eCode==2
2056fcb9f4f3Sdrh **     sqlite3ExprIsTableConstant()             pWalker->eCode==3
2057059b2d50Sdrh **     sqlite3ExprIsConstantOrFunction()        pWalker->eCode==4 or 5
205887abf5c0Sdrh **
2059059b2d50Sdrh ** In all cases, the callbacks set Walker.eCode=0 and abort if the expression
2060059b2d50Sdrh ** is found to not be a constant.
206187abf5c0Sdrh **
2062014fff20Sdrh ** The sqlite3ExprIsConstantOrFunction() is used for evaluating DEFAULT
2063014fff20Sdrh ** expressions in a CREATE TABLE statement.  The Walker.eCode value is 5
20641e32bed3Sdrh ** when parsing an existing schema out of the sqlite_schema table and 4
2065014fff20Sdrh ** when processing a new CREATE TABLE statement.  A bound parameter raises
2066014fff20Sdrh ** an error for new statements, but is silently converted
20671e32bed3Sdrh ** to NULL for existing schemas.  This allows sqlite_schema tables that
2068feada2dfSdrh ** contain a bound parameter because they were generated by older versions
2069feada2dfSdrh ** of SQLite to be parsed by newer versions of SQLite without raising a
2070feada2dfSdrh ** malformed schema error.
2071626a879aSdrh */
20727d10d5a6Sdrh static int exprNodeIsConstant(Walker *pWalker, Expr *pExpr){
2073626a879aSdrh 
2074059b2d50Sdrh   /* If pWalker->eCode is 2 then any term of the expression that comes from
2075059b2d50Sdrh   ** the ON or USING clauses of a left join disqualifies the expression
20760a168377Sdrh   ** from being considered constant. */
2077059b2d50Sdrh   if( pWalker->eCode==2 && ExprHasProperty(pExpr, EP_FromJoin) ){
2078059b2d50Sdrh     pWalker->eCode = 0;
20797d10d5a6Sdrh     return WRC_Abort;
20800a168377Sdrh   }
20810a168377Sdrh 
2082626a879aSdrh   switch( pExpr->op ){
2083eb55bd2fSdrh     /* Consider functions to be constant if all their arguments are constant
2084059b2d50Sdrh     ** and either pWalker->eCode==4 or 5 or the function has the
2085059b2d50Sdrh     ** SQLITE_FUNC_CONST flag. */
2086eb55bd2fSdrh     case TK_FUNCTION:
2087a634c9e6Sdrh       if( (pWalker->eCode>=4 || ExprHasProperty(pExpr,EP_ConstFunc))
2088a634c9e6Sdrh        && !ExprHasProperty(pExpr, EP_WinFunc)
2089a634c9e6Sdrh       ){
2090014fff20Sdrh         if( pWalker->eCode==5 ) ExprSetProperty(pExpr, EP_FromDDL);
2091b1fba286Sdrh         return WRC_Continue;
2092059b2d50Sdrh       }else{
2093059b2d50Sdrh         pWalker->eCode = 0;
2094059b2d50Sdrh         return WRC_Abort;
2095b1fba286Sdrh       }
2096626a879aSdrh     case TK_ID:
2097171d16bbSdrh       /* Convert "true" or "false" in a DEFAULT clause into the
2098171d16bbSdrh       ** appropriate TK_TRUEFALSE operator */
2099e39ef31cSdrh       if( sqlite3ExprIdToTrueFalse(pExpr) ){
2100171d16bbSdrh         return WRC_Prune;
2101171d16bbSdrh       }
210208b92086Sdrh       /* no break */ deliberate_fall_through
2103626a879aSdrh     case TK_COLUMN:
2104626a879aSdrh     case TK_AGG_FUNCTION:
210513449892Sdrh     case TK_AGG_COLUMN:
2106c5499befSdrh       testcase( pExpr->op==TK_ID );
2107c5499befSdrh       testcase( pExpr->op==TK_COLUMN );
2108c5499befSdrh       testcase( pExpr->op==TK_AGG_FUNCTION );
2109c5499befSdrh       testcase( pExpr->op==TK_AGG_COLUMN );
211007aded63Sdrh       if( ExprHasProperty(pExpr, EP_FixedCol) && pWalker->eCode!=2 ){
2111efad2e23Sdrh         return WRC_Continue;
2112efad2e23Sdrh       }
2113059b2d50Sdrh       if( pWalker->eCode==3 && pExpr->iTable==pWalker->u.iCur ){
2114059b2d50Sdrh         return WRC_Continue;
2115f43ce0b4Sdrh       }
211608b92086Sdrh       /* no break */ deliberate_fall_through
2117f43ce0b4Sdrh     case TK_IF_NULL_ROW:
21186e341b93Sdrh     case TK_REGISTER:
211974e0d966Sdrh     case TK_DOT:
21209916048bSdrh       testcase( pExpr->op==TK_REGISTER );
2121f43ce0b4Sdrh       testcase( pExpr->op==TK_IF_NULL_ROW );
212274e0d966Sdrh       testcase( pExpr->op==TK_DOT );
2123059b2d50Sdrh       pWalker->eCode = 0;
21247d10d5a6Sdrh       return WRC_Abort;
2125feada2dfSdrh     case TK_VARIABLE:
2126059b2d50Sdrh       if( pWalker->eCode==5 ){
2127feada2dfSdrh         /* Silently convert bound parameters that appear inside of CREATE
2128feada2dfSdrh         ** statements into a NULL when parsing the CREATE statement text out
21291e32bed3Sdrh         ** of the sqlite_schema table */
2130feada2dfSdrh         pExpr->op = TK_NULL;
2131059b2d50Sdrh       }else if( pWalker->eCode==4 ){
2132feada2dfSdrh         /* A bound parameter in a CREATE statement that originates from
2133feada2dfSdrh         ** sqlite3_prepare() causes an error */
2134059b2d50Sdrh         pWalker->eCode = 0;
2135feada2dfSdrh         return WRC_Abort;
2136feada2dfSdrh       }
213708b92086Sdrh       /* no break */ deliberate_fall_through
2138626a879aSdrh     default:
21396e341b93Sdrh       testcase( pExpr->op==TK_SELECT ); /* sqlite3SelectWalkFail() disallows */
21406e341b93Sdrh       testcase( pExpr->op==TK_EXISTS ); /* sqlite3SelectWalkFail() disallows */
21417d10d5a6Sdrh       return WRC_Continue;
2142626a879aSdrh   }
2143626a879aSdrh }
2144059b2d50Sdrh static int exprIsConst(Expr *p, int initFlag, int iCur){
21457d10d5a6Sdrh   Walker w;
2146059b2d50Sdrh   w.eCode = initFlag;
21477d10d5a6Sdrh   w.xExprCallback = exprNodeIsConstant;
21487e6f980bSdrh   w.xSelectCallback = sqlite3SelectWalkFail;
2149979dd1beSdrh #ifdef SQLITE_DEBUG
2150979dd1beSdrh   w.xSelectCallback2 = sqlite3SelectWalkAssert2;
2151979dd1beSdrh #endif
2152059b2d50Sdrh   w.u.iCur = iCur;
21537d10d5a6Sdrh   sqlite3WalkExpr(&w, p);
2154059b2d50Sdrh   return w.eCode;
21557d10d5a6Sdrh }
2156626a879aSdrh 
2157626a879aSdrh /*
2158059b2d50Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
2159eb55bd2fSdrh ** and 0 if it involves variables or function calls.
21602398937bSdrh **
21612398937bSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
21622398937bSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
21632398937bSdrh ** a constant.
2164fef5208cSdrh */
21654adee20fSdanielk1977 int sqlite3ExprIsConstant(Expr *p){
2166059b2d50Sdrh   return exprIsConst(p, 1, 0);
2167fef5208cSdrh }
2168fef5208cSdrh 
2169fef5208cSdrh /*
217007aded63Sdrh ** Walk an expression tree.  Return non-zero if
217107aded63Sdrh **
217207aded63Sdrh **   (1) the expression is constant, and
217307aded63Sdrh **   (2) the expression does originate in the ON or USING clause
217407aded63Sdrh **       of a LEFT JOIN, and
217507aded63Sdrh **   (3) the expression does not contain any EP_FixedCol TK_COLUMN
217607aded63Sdrh **       operands created by the constant propagation optimization.
217707aded63Sdrh **
217807aded63Sdrh ** When this routine returns true, it indicates that the expression
217907aded63Sdrh ** can be added to the pParse->pConstExpr list and evaluated once when
21809b258c54Sdrh ** the prepared statement starts up.  See sqlite3ExprCodeRunJustOnce().
21810a168377Sdrh */
21820a168377Sdrh int sqlite3ExprIsConstantNotJoin(Expr *p){
2183059b2d50Sdrh   return exprIsConst(p, 2, 0);
21840a168377Sdrh }
21850a168377Sdrh 
21860a168377Sdrh /*
2187fcb9f4f3Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
2188059b2d50Sdrh ** for any single row of the table with cursor iCur.  In other words, the
2189059b2d50Sdrh ** expression must not refer to any non-deterministic function nor any
2190059b2d50Sdrh ** table other than iCur.
2191059b2d50Sdrh */
2192059b2d50Sdrh int sqlite3ExprIsTableConstant(Expr *p, int iCur){
2193059b2d50Sdrh   return exprIsConst(p, 3, iCur);
2194059b2d50Sdrh }
2195059b2d50Sdrh 
2196ab31a845Sdan 
2197ab31a845Sdan /*
2198ab31a845Sdan ** sqlite3WalkExpr() callback used by sqlite3ExprIsConstantOrGroupBy().
2199ab31a845Sdan */
2200ab31a845Sdan static int exprNodeIsConstantOrGroupBy(Walker *pWalker, Expr *pExpr){
2201ab31a845Sdan   ExprList *pGroupBy = pWalker->u.pGroupBy;
2202ab31a845Sdan   int i;
2203ab31a845Sdan 
2204ab31a845Sdan   /* Check if pExpr is identical to any GROUP BY term. If so, consider
2205ab31a845Sdan   ** it constant.  */
2206ab31a845Sdan   for(i=0; i<pGroupBy->nExpr; i++){
2207ab31a845Sdan     Expr *p = pGroupBy->a[i].pExpr;
22085aa550cfSdan     if( sqlite3ExprCompare(0, pExpr, p, -1)<2 ){
220970efa84dSdrh       CollSeq *pColl = sqlite3ExprNNCollSeq(pWalker->pParse, p);
2210efad2e23Sdrh       if( sqlite3IsBinary(pColl) ){
2211ab31a845Sdan         return WRC_Prune;
2212ab31a845Sdan       }
2213ab31a845Sdan     }
2214ab31a845Sdan   }
2215ab31a845Sdan 
2216ab31a845Sdan   /* Check if pExpr is a sub-select. If so, consider it variable. */
2217ab31a845Sdan   if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2218ab31a845Sdan     pWalker->eCode = 0;
2219ab31a845Sdan     return WRC_Abort;
2220ab31a845Sdan   }
2221ab31a845Sdan 
2222ab31a845Sdan   return exprNodeIsConstant(pWalker, pExpr);
2223ab31a845Sdan }
2224ab31a845Sdan 
2225ab31a845Sdan /*
2226ab31a845Sdan ** Walk the expression tree passed as the first argument. Return non-zero
2227ab31a845Sdan ** if the expression consists entirely of constants or copies of terms
2228ab31a845Sdan ** in pGroupBy that sort with the BINARY collation sequence.
2229ab314001Sdrh **
2230ab314001Sdrh ** This routine is used to determine if a term of the HAVING clause can
2231ab314001Sdrh ** be promoted into the WHERE clause.  In order for such a promotion to work,
2232ab314001Sdrh ** the value of the HAVING clause term must be the same for all members of
2233ab314001Sdrh ** a "group".  The requirement that the GROUP BY term must be BINARY
2234ab314001Sdrh ** assumes that no other collating sequence will have a finer-grained
2235ab314001Sdrh ** grouping than binary.  In other words (A=B COLLATE binary) implies
2236ab314001Sdrh ** A=B in every other collating sequence.  The requirement that the
2237ab314001Sdrh ** GROUP BY be BINARY is stricter than necessary.  It would also work
2238ab314001Sdrh ** to promote HAVING clauses that use the same alternative collating
2239ab314001Sdrh ** sequence as the GROUP BY term, but that is much harder to check,
2240ab314001Sdrh ** alternative collating sequences are uncommon, and this is only an
2241ab314001Sdrh ** optimization, so we take the easy way out and simply require the
2242ab314001Sdrh ** GROUP BY to use the BINARY collating sequence.
2243ab31a845Sdan */
2244ab31a845Sdan int sqlite3ExprIsConstantOrGroupBy(Parse *pParse, Expr *p, ExprList *pGroupBy){
2245ab31a845Sdan   Walker w;
2246ab31a845Sdan   w.eCode = 1;
2247ab31a845Sdan   w.xExprCallback = exprNodeIsConstantOrGroupBy;
2248979dd1beSdrh   w.xSelectCallback = 0;
2249ab31a845Sdan   w.u.pGroupBy = pGroupBy;
2250ab31a845Sdan   w.pParse = pParse;
2251ab31a845Sdan   sqlite3WalkExpr(&w, p);
2252ab31a845Sdan   return w.eCode;
2253ab31a845Sdan }
2254ab31a845Sdan 
2255059b2d50Sdrh /*
2256014fff20Sdrh ** Walk an expression tree for the DEFAULT field of a column definition
2257014fff20Sdrh ** in a CREATE TABLE statement.  Return non-zero if the expression is
2258014fff20Sdrh ** acceptable for use as a DEFAULT.  That is to say, return non-zero if
2259014fff20Sdrh ** the expression is constant or a function call with constant arguments.
2260014fff20Sdrh ** Return and 0 if there are any variables.
2261014fff20Sdrh **
22621e32bed3Sdrh ** isInit is true when parsing from sqlite_schema.  isInit is false when
2263014fff20Sdrh ** processing a new CREATE TABLE statement.  When isInit is true, parameters
2264014fff20Sdrh ** (such as ? or $abc) in the expression are converted into NULL.  When
2265014fff20Sdrh ** isInit is false, parameters raise an error.  Parameters should not be
2266014fff20Sdrh ** allowed in a CREATE TABLE statement, but some legacy versions of SQLite
22671e32bed3Sdrh ** allowed it, so we need to support it when reading sqlite_schema for
2268014fff20Sdrh ** backwards compatibility.
2269014fff20Sdrh **
2270014fff20Sdrh ** If isInit is true, set EP_FromDDL on every TK_FUNCTION node.
2271eb55bd2fSdrh **
2272eb55bd2fSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
2273eb55bd2fSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
2274eb55bd2fSdrh ** a constant.
2275eb55bd2fSdrh */
2276feada2dfSdrh int sqlite3ExprIsConstantOrFunction(Expr *p, u8 isInit){
2277feada2dfSdrh   assert( isInit==0 || isInit==1 );
2278059b2d50Sdrh   return exprIsConst(p, 4+isInit, 0);
2279eb55bd2fSdrh }
2280eb55bd2fSdrh 
22815b88bc4bSdrh #ifdef SQLITE_ENABLE_CURSOR_HINTS
22825b88bc4bSdrh /*
22835b88bc4bSdrh ** Walk an expression tree.  Return 1 if the expression contains a
22845b88bc4bSdrh ** subquery of some kind.  Return 0 if there are no subqueries.
22855b88bc4bSdrh */
22865b88bc4bSdrh int sqlite3ExprContainsSubquery(Expr *p){
22875b88bc4bSdrh   Walker w;
2288bec2476aSdrh   w.eCode = 1;
22895b88bc4bSdrh   w.xExprCallback = sqlite3ExprWalkNoop;
22907e6f980bSdrh   w.xSelectCallback = sqlite3SelectWalkFail;
2291979dd1beSdrh #ifdef SQLITE_DEBUG
2292979dd1beSdrh   w.xSelectCallback2 = sqlite3SelectWalkAssert2;
2293979dd1beSdrh #endif
22945b88bc4bSdrh   sqlite3WalkExpr(&w, p);
229507194bffSdrh   return w.eCode==0;
22965b88bc4bSdrh }
22975b88bc4bSdrh #endif
22985b88bc4bSdrh 
2299eb55bd2fSdrh /*
230073b211abSdrh ** If the expression p codes a constant integer that is small enough
2301202b2df7Sdrh ** to fit in a 32-bit integer, return 1 and put the value of the integer
2302202b2df7Sdrh ** in *pValue.  If the expression is not an integer or if it is too big
2303202b2df7Sdrh ** to fit in a signed 32-bit integer, return 0 and leave *pValue unchanged.
2304e4de1febSdrh */
23054adee20fSdanielk1977 int sqlite3ExprIsInteger(Expr *p, int *pValue){
230692b01d53Sdrh   int rc = 0;
23071d2d71a0Sdrh   if( NEVER(p==0) ) return 0;  /* Used to only happen following on OOM */
2308cd92e84dSdrh 
2309cd92e84dSdrh   /* If an expression is an integer literal that fits in a signed 32-bit
2310cd92e84dSdrh   ** integer, then the EP_IntValue flag will have already been set */
2311cd92e84dSdrh   assert( p->op!=TK_INTEGER || (p->flags & EP_IntValue)!=0
2312cd92e84dSdrh            || sqlite3GetInt32(p->u.zToken, &rc)==0 );
2313cd92e84dSdrh 
231492b01d53Sdrh   if( p->flags & EP_IntValue ){
231533e619fcSdrh     *pValue = p->u.iValue;
2316e4de1febSdrh     return 1;
2317e4de1febSdrh   }
231892b01d53Sdrh   switch( p->op ){
23194b59ab5eSdrh     case TK_UPLUS: {
232092b01d53Sdrh       rc = sqlite3ExprIsInteger(p->pLeft, pValue);
2321f6e369a1Sdrh       break;
23224b59ab5eSdrh     }
2323e4de1febSdrh     case TK_UMINUS: {
2324e4de1febSdrh       int v;
23254adee20fSdanielk1977       if( sqlite3ExprIsInteger(p->pLeft, &v) ){
2326f6418891Smistachkin         assert( v!=(-2147483647-1) );
2327e4de1febSdrh         *pValue = -v;
232892b01d53Sdrh         rc = 1;
2329e4de1febSdrh       }
2330e4de1febSdrh       break;
2331e4de1febSdrh     }
2332e4de1febSdrh     default: break;
2333e4de1febSdrh   }
233492b01d53Sdrh   return rc;
2335e4de1febSdrh }
2336e4de1febSdrh 
2337e4de1febSdrh /*
2338039fc32eSdrh ** Return FALSE if there is no chance that the expression can be NULL.
2339039fc32eSdrh **
2340039fc32eSdrh ** If the expression might be NULL or if the expression is too complex
2341039fc32eSdrh ** to tell return TRUE.
2342039fc32eSdrh **
2343039fc32eSdrh ** This routine is used as an optimization, to skip OP_IsNull opcodes
2344039fc32eSdrh ** when we know that a value cannot be NULL.  Hence, a false positive
2345039fc32eSdrh ** (returning TRUE when in fact the expression can never be NULL) might
2346039fc32eSdrh ** be a small performance hit but is otherwise harmless.  On the other
2347039fc32eSdrh ** hand, a false negative (returning FALSE when the result could be NULL)
2348039fc32eSdrh ** will likely result in an incorrect answer.  So when in doubt, return
2349039fc32eSdrh ** TRUE.
2350039fc32eSdrh */
2351039fc32eSdrh int sqlite3ExprCanBeNull(const Expr *p){
2352039fc32eSdrh   u8 op;
23533c6edc8aSdrh   assert( p!=0 );
23549bfb0794Sdrh   while( p->op==TK_UPLUS || p->op==TK_UMINUS ){
23559bfb0794Sdrh     p = p->pLeft;
23563c6edc8aSdrh     assert( p!=0 );
23579bfb0794Sdrh   }
2358039fc32eSdrh   op = p->op;
2359039fc32eSdrh   if( op==TK_REGISTER ) op = p->op2;
2360039fc32eSdrh   switch( op ){
2361039fc32eSdrh     case TK_INTEGER:
2362039fc32eSdrh     case TK_STRING:
2363039fc32eSdrh     case TK_FLOAT:
2364039fc32eSdrh     case TK_BLOB:
2365039fc32eSdrh       return 0;
23667248a8b2Sdrh     case TK_COLUMN:
236772673a24Sdrh       return ExprHasProperty(p, EP_CanBeNull) ||
2368eda079cdSdrh              p->y.pTab==0 ||  /* Reference to column of index on expression */
23694eac5f04Sdrh              (p->iColumn>=0
23704eac5f04Sdrh               && ALWAYS(p->y.pTab->aCol!=0) /* Defense against OOM problems */
23714eac5f04Sdrh               && p->y.pTab->aCol[p->iColumn].notNull==0);
2372039fc32eSdrh     default:
2373039fc32eSdrh       return 1;
2374039fc32eSdrh   }
2375039fc32eSdrh }
2376039fc32eSdrh 
2377039fc32eSdrh /*
2378039fc32eSdrh ** Return TRUE if the given expression is a constant which would be
2379039fc32eSdrh ** unchanged by OP_Affinity with the affinity given in the second
2380039fc32eSdrh ** argument.
2381039fc32eSdrh **
2382039fc32eSdrh ** This routine is used to determine if the OP_Affinity operation
2383039fc32eSdrh ** can be omitted.  When in doubt return FALSE.  A false negative
2384039fc32eSdrh ** is harmless.  A false positive, however, can result in the wrong
2385039fc32eSdrh ** answer.
2386039fc32eSdrh */
2387039fc32eSdrh int sqlite3ExprNeedsNoAffinityChange(const Expr *p, char aff){
2388039fc32eSdrh   u8 op;
2389af866402Sdrh   int unaryMinus = 0;
239005883a34Sdrh   if( aff==SQLITE_AFF_BLOB ) return 1;
2391af866402Sdrh   while( p->op==TK_UPLUS || p->op==TK_UMINUS ){
2392af866402Sdrh     if( p->op==TK_UMINUS ) unaryMinus = 1;
2393af866402Sdrh     p = p->pLeft;
2394af866402Sdrh   }
2395039fc32eSdrh   op = p->op;
2396039fc32eSdrh   if( op==TK_REGISTER ) op = p->op2;
2397039fc32eSdrh   switch( op ){
2398039fc32eSdrh     case TK_INTEGER: {
23996a19865fSdrh       return aff>=SQLITE_AFF_NUMERIC;
2400039fc32eSdrh     }
2401039fc32eSdrh     case TK_FLOAT: {
24026a19865fSdrh       return aff>=SQLITE_AFF_NUMERIC;
2403039fc32eSdrh     }
2404039fc32eSdrh     case TK_STRING: {
2405af866402Sdrh       return !unaryMinus && aff==SQLITE_AFF_TEXT;
2406039fc32eSdrh     }
2407039fc32eSdrh     case TK_BLOB: {
2408af866402Sdrh       return !unaryMinus;
2409039fc32eSdrh     }
24102f2855b6Sdrh     case TK_COLUMN: {
241188376ca7Sdrh       assert( p->iTable>=0 );  /* p cannot be part of a CHECK constraint */
24126a19865fSdrh       return aff>=SQLITE_AFF_NUMERIC && p->iColumn<0;
24132f2855b6Sdrh     }
2414039fc32eSdrh     default: {
2415039fc32eSdrh       return 0;
2416039fc32eSdrh     }
2417039fc32eSdrh   }
2418039fc32eSdrh }
2419039fc32eSdrh 
2420039fc32eSdrh /*
2421c4a3c779Sdrh ** Return TRUE if the given string is a row-id column name.
2422c4a3c779Sdrh */
24234adee20fSdanielk1977 int sqlite3IsRowid(const char *z){
24244adee20fSdanielk1977   if( sqlite3StrICmp(z, "_ROWID_")==0 ) return 1;
24254adee20fSdanielk1977   if( sqlite3StrICmp(z, "ROWID")==0 ) return 1;
24264adee20fSdanielk1977   if( sqlite3StrICmp(z, "OID")==0 ) return 1;
2427c4a3c779Sdrh   return 0;
2428c4a3c779Sdrh }
2429c4a3c779Sdrh 
24309a96b668Sdanielk1977 /*
243169c355bdSdrh ** pX is the RHS of an IN operator.  If pX is a SELECT statement
243269c355bdSdrh ** that can be simplified to a direct table access, then return
243369c355bdSdrh ** a pointer to the SELECT statement.  If pX is not a SELECT statement,
243469c355bdSdrh ** or if the SELECT statement needs to be manifested into a transient
243569c355bdSdrh ** table, then return NULL.
2436b287f4b6Sdrh */
2437b287f4b6Sdrh #ifndef SQLITE_OMIT_SUBQUERY
24387b35a77bSdan static Select *isCandidateForInOpt(Expr *pX){
243969c355bdSdrh   Select *p;
2440b287f4b6Sdrh   SrcList *pSrc;
2441b287f4b6Sdrh   ExprList *pEList;
2442b287f4b6Sdrh   Table *pTab;
2443cfbb5e82Sdan   int i;
244469c355bdSdrh   if( !ExprHasProperty(pX, EP_xIsSelect) ) return 0;  /* Not a subquery */
244569c355bdSdrh   if( ExprHasProperty(pX, EP_VarSelect)  ) return 0;  /* Correlated subq */
244669c355bdSdrh   p = pX->x.pSelect;
2447b287f4b6Sdrh   if( p->pPrior ) return 0;              /* Not a compound SELECT */
24487d10d5a6Sdrh   if( p->selFlags & (SF_Distinct|SF_Aggregate) ){
2449b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
2450b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
24517d10d5a6Sdrh     return 0; /* No DISTINCT keyword and no aggregate functions */
24527d10d5a6Sdrh   }
24532e26a602Sdrh   assert( p->pGroupBy==0 );              /* Has no GROUP BY clause */
2454b287f4b6Sdrh   if( p->pLimit ) return 0;              /* Has no LIMIT clause */
2455b287f4b6Sdrh   if( p->pWhere ) return 0;              /* Has no WHERE clause */
2456b287f4b6Sdrh   pSrc = p->pSrc;
2457d1fa7bcaSdrh   assert( pSrc!=0 );
2458d1fa7bcaSdrh   if( pSrc->nSrc!=1 ) return 0;          /* Single term in FROM clause */
2459b74b1017Sdrh   if( pSrc->a[0].pSelect ) return 0;     /* FROM is not a subquery or view */
2460b287f4b6Sdrh   pTab = pSrc->a[0].pTab;
246169c355bdSdrh   assert( pTab!=0 );
2462b74b1017Sdrh   assert( pTab->pSelect==0 );            /* FROM clause is not a view */
2463b287f4b6Sdrh   if( IsVirtual(pTab) ) return 0;        /* FROM clause not a virtual table */
2464b287f4b6Sdrh   pEList = p->pEList;
2465ac6b47d1Sdrh   assert( pEList!=0 );
24667b35a77bSdan   /* All SELECT results must be columns. */
2467cfbb5e82Sdan   for(i=0; i<pEList->nExpr; i++){
2468cfbb5e82Sdan     Expr *pRes = pEList->a[i].pExpr;
2469cfbb5e82Sdan     if( pRes->op!=TK_COLUMN ) return 0;
247069c355bdSdrh     assert( pRes->iTable==pSrc->a[0].iCursor );  /* Not a correlated subquery */
2471cfbb5e82Sdan   }
247269c355bdSdrh   return p;
2473b287f4b6Sdrh }
2474b287f4b6Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
2475b287f4b6Sdrh 
2476f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
24771d8cb21fSdan /*
24784c259e9fSdrh ** Generate code that checks the left-most column of index table iCur to see if
24794c259e9fSdrh ** it contains any NULL entries.  Cause the register at regHasNull to be set
24806be515ebSdrh ** to a non-NULL value if iCur contains no NULLs.  Cause register regHasNull
24816be515ebSdrh ** to be set to NULL if iCur contains one or more NULL values.
24826be515ebSdrh */
24836be515ebSdrh static void sqlite3SetHasNullFlag(Vdbe *v, int iCur, int regHasNull){
2484728e0f91Sdrh   int addr1;
24856be515ebSdrh   sqlite3VdbeAddOp2(v, OP_Integer, 0, regHasNull);
2486728e0f91Sdrh   addr1 = sqlite3VdbeAddOp1(v, OP_Rewind, iCur); VdbeCoverage(v);
24876be515ebSdrh   sqlite3VdbeAddOp3(v, OP_Column, iCur, 0, regHasNull);
24886be515ebSdrh   sqlite3VdbeChangeP5(v, OPFLAG_TYPEOFARG);
24894c259e9fSdrh   VdbeComment((v, "first_entry_in(%d)", iCur));
2490728e0f91Sdrh   sqlite3VdbeJumpHere(v, addr1);
24916be515ebSdrh }
2492f9b2e05cSdan #endif
24936be515ebSdrh 
2494bb53ecb1Sdrh 
2495bb53ecb1Sdrh #ifndef SQLITE_OMIT_SUBQUERY
2496bb53ecb1Sdrh /*
2497bb53ecb1Sdrh ** The argument is an IN operator with a list (not a subquery) on the
2498bb53ecb1Sdrh ** right-hand side.  Return TRUE if that list is constant.
2499bb53ecb1Sdrh */
2500bb53ecb1Sdrh static int sqlite3InRhsIsConstant(Expr *pIn){
2501bb53ecb1Sdrh   Expr *pLHS;
2502bb53ecb1Sdrh   int res;
2503bb53ecb1Sdrh   assert( !ExprHasProperty(pIn, EP_xIsSelect) );
2504bb53ecb1Sdrh   pLHS = pIn->pLeft;
2505bb53ecb1Sdrh   pIn->pLeft = 0;
2506bb53ecb1Sdrh   res = sqlite3ExprIsConstant(pIn);
2507bb53ecb1Sdrh   pIn->pLeft = pLHS;
2508bb53ecb1Sdrh   return res;
2509bb53ecb1Sdrh }
2510bb53ecb1Sdrh #endif
2511bb53ecb1Sdrh 
25126be515ebSdrh /*
25139a96b668Sdanielk1977 ** This function is used by the implementation of the IN (...) operator.
2514d4305ca6Sdrh ** The pX parameter is the expression on the RHS of the IN operator, which
2515d4305ca6Sdrh ** might be either a list of expressions or a subquery.
25169a96b668Sdanielk1977 **
2517d4305ca6Sdrh ** The job of this routine is to find or create a b-tree object that can
2518d4305ca6Sdrh ** be used either to test for membership in the RHS set or to iterate through
2519d4305ca6Sdrh ** all members of the RHS set, skipping duplicates.
2520d4305ca6Sdrh **
25213a85625dSdrh ** A cursor is opened on the b-tree object that is the RHS of the IN operator
2522d4305ca6Sdrh ** and pX->iTable is set to the index of that cursor.
2523d4305ca6Sdrh **
2524b74b1017Sdrh ** The returned value of this function indicates the b-tree type, as follows:
25259a96b668Sdanielk1977 **
25269a96b668Sdanielk1977 **   IN_INDEX_ROWID      - The cursor was opened on a database table.
25271ccce449Sdrh **   IN_INDEX_INDEX_ASC  - The cursor was opened on an ascending index.
25281ccce449Sdrh **   IN_INDEX_INDEX_DESC - The cursor was opened on a descending index.
25299a96b668Sdanielk1977 **   IN_INDEX_EPH        - The cursor was opened on a specially created and
25309a96b668Sdanielk1977 **                         populated epheremal table.
2531bb53ecb1Sdrh **   IN_INDEX_NOOP       - No cursor was allocated.  The IN operator must be
2532bb53ecb1Sdrh **                         implemented as a sequence of comparisons.
25339a96b668Sdanielk1977 **
2534d4305ca6Sdrh ** An existing b-tree might be used if the RHS expression pX is a simple
2535d4305ca6Sdrh ** subquery such as:
25369a96b668Sdanielk1977 **
2537553168c7Sdan **     SELECT <column1>, <column2>... FROM <table>
25389a96b668Sdanielk1977 **
2539d4305ca6Sdrh ** If the RHS of the IN operator is a list or a more complex subquery, then
2540d4305ca6Sdrh ** an ephemeral table might need to be generated from the RHS and then
254160ec914cSpeter.d.reid ** pX->iTable made to point to the ephemeral table instead of an
2542d4305ca6Sdrh ** existing table.
2543d4305ca6Sdrh **
25447fc0ba0fSdrh ** The inFlags parameter must contain, at a minimum, one of the bits
25457fc0ba0fSdrh ** IN_INDEX_MEMBERSHIP or IN_INDEX_LOOP but not both.  If inFlags contains
25467fc0ba0fSdrh ** IN_INDEX_MEMBERSHIP, then the generated table will be used for a fast
25477fc0ba0fSdrh ** membership test.  When the IN_INDEX_LOOP bit is set, the IN index will
25487fc0ba0fSdrh ** be used to loop over all values of the RHS of the IN operator.
25493a85625dSdrh **
25503a85625dSdrh ** When IN_INDEX_LOOP is used (and the b-tree will be used to iterate
25513a85625dSdrh ** through the set members) then the b-tree must not contain duplicates.
25527fc0ba0fSdrh ** An epheremal table will be created unless the selected columns are guaranteed
2553553168c7Sdan ** to be unique - either because it is an INTEGER PRIMARY KEY or due to
2554553168c7Sdan ** a UNIQUE constraint or index.
25550cdc022eSdanielk1977 **
25563a85625dSdrh ** When IN_INDEX_MEMBERSHIP is used (and the b-tree will be used
25573a85625dSdrh ** for fast set membership tests) then an epheremal table must
2558553168c7Sdan ** be used unless <columns> is a single INTEGER PRIMARY KEY column or an
2559553168c7Sdan ** index can be found with the specified <columns> as its left-most.
25600cdc022eSdanielk1977 **
2561bb53ecb1Sdrh ** If the IN_INDEX_NOOP_OK and IN_INDEX_MEMBERSHIP are both set and
2562bb53ecb1Sdrh ** if the RHS of the IN operator is a list (not a subquery) then this
2563bb53ecb1Sdrh ** routine might decide that creating an ephemeral b-tree for membership
2564bb53ecb1Sdrh ** testing is too expensive and return IN_INDEX_NOOP.  In that case, the
2565bb53ecb1Sdrh ** calling routine should implement the IN operator using a sequence
2566bb53ecb1Sdrh ** of Eq or Ne comparison operations.
2567bb53ecb1Sdrh **
2568b74b1017Sdrh ** When the b-tree is being used for membership tests, the calling function
25693a85625dSdrh ** might need to know whether or not the RHS side of the IN operator
2570e21a6e1dSdrh ** contains a NULL.  If prRhsHasNull is not a NULL pointer and
25713a85625dSdrh ** if there is any chance that the (...) might contain a NULL value at
25720cdc022eSdanielk1977 ** runtime, then a register is allocated and the register number written
2573e21a6e1dSdrh ** to *prRhsHasNull. If there is no chance that the (...) contains a
2574e21a6e1dSdrh ** NULL value, then *prRhsHasNull is left unchanged.
25750cdc022eSdanielk1977 **
2576e21a6e1dSdrh ** If a register is allocated and its location stored in *prRhsHasNull, then
25776be515ebSdrh ** the value in that register will be NULL if the b-tree contains one or more
25786be515ebSdrh ** NULL values, and it will be some non-NULL value if the b-tree contains no
25796be515ebSdrh ** NULL values.
2580553168c7Sdan **
2581553168c7Sdan ** If the aiMap parameter is not NULL, it must point to an array containing
2582553168c7Sdan ** one element for each column returned by the SELECT statement on the RHS
2583553168c7Sdan ** of the IN(...) operator. The i'th entry of the array is populated with the
2584553168c7Sdan ** offset of the index column that matches the i'th column returned by the
2585553168c7Sdan ** SELECT. For example, if the expression and selected index are:
2586553168c7Sdan **
2587553168c7Sdan **   (?,?,?) IN (SELECT a, b, c FROM t1)
2588553168c7Sdan **   CREATE INDEX i1 ON t1(b, c, a);
2589553168c7Sdan **
2590553168c7Sdan ** then aiMap[] is populated with {2, 0, 1}.
25919a96b668Sdanielk1977 */
2592284f4acaSdanielk1977 #ifndef SQLITE_OMIT_SUBQUERY
2593ba00e30aSdan int sqlite3FindInIndex(
25946fc8f364Sdrh   Parse *pParse,             /* Parsing context */
25950167ef20Sdrh   Expr *pX,                  /* The IN expression */
25966fc8f364Sdrh   u32 inFlags,               /* IN_INDEX_LOOP, _MEMBERSHIP, and/or _NOOP_OK */
25976fc8f364Sdrh   int *prRhsHasNull,         /* Register holding NULL status.  See notes */
25982c04131cSdrh   int *aiMap,                /* Mapping from Index fields to RHS fields */
25992c04131cSdrh   int *piTab                 /* OUT: index to use */
2600ba00e30aSdan ){
2601b74b1017Sdrh   Select *p;                            /* SELECT to the right of IN operator */
2602b74b1017Sdrh   int eType = 0;                        /* Type of RHS table. IN_INDEX_* */
2603b74b1017Sdrh   int iTab = pParse->nTab++;            /* Cursor of the RHS table */
26043a85625dSdrh   int mustBeUnique;                     /* True if RHS must be unique */
2605b8475df8Sdrh   Vdbe *v = sqlite3GetVdbe(pParse);     /* Virtual machine being coded */
26069a96b668Sdanielk1977 
26071450bc6eSdrh   assert( pX->op==TK_IN );
26083a85625dSdrh   mustBeUnique = (inFlags & IN_INDEX_LOOP)!=0;
26091450bc6eSdrh 
26107b35a77bSdan   /* If the RHS of this IN(...) operator is a SELECT, and if it matters
26117b35a77bSdan   ** whether or not the SELECT result contains NULL values, check whether
2612870a0705Sdan   ** or not NULL is actually possible (it may not be, for example, due
26137b35a77bSdan   ** to NOT NULL constraints in the schema). If no NULL values are possible,
2614870a0705Sdan   ** set prRhsHasNull to 0 before continuing.  */
26157b35a77bSdan   if( prRhsHasNull && (pX->flags & EP_xIsSelect) ){
26167b35a77bSdan     int i;
26177b35a77bSdan     ExprList *pEList = pX->x.pSelect->pEList;
26187b35a77bSdan     for(i=0; i<pEList->nExpr; i++){
26197b35a77bSdan       if( sqlite3ExprCanBeNull(pEList->a[i].pExpr) ) break;
26207b35a77bSdan     }
26217b35a77bSdan     if( i==pEList->nExpr ){
26227b35a77bSdan       prRhsHasNull = 0;
26237b35a77bSdan     }
26247b35a77bSdan   }
26257b35a77bSdan 
2626b74b1017Sdrh   /* Check to see if an existing table or index can be used to
2627b74b1017Sdrh   ** satisfy the query.  This is preferable to generating a new
26287b35a77bSdan   ** ephemeral table.  */
26297b35a77bSdan   if( pParse->nErr==0 && (p = isCandidateForInOpt(pX))!=0 ){
2630e1fb65a0Sdanielk1977     sqlite3 *db = pParse->db;              /* Database connection */
2631b07028f7Sdrh     Table *pTab;                           /* Table <table>. */
2632399062ccSdrh     int iDb;                               /* Database idx for pTab */
2633cfbb5e82Sdan     ExprList *pEList = p->pEList;
2634cfbb5e82Sdan     int nExpr = pEList->nExpr;
2635e1fb65a0Sdanielk1977 
2636b07028f7Sdrh     assert( p->pEList!=0 );             /* Because of isCandidateForInOpt(p) */
2637b07028f7Sdrh     assert( p->pEList->a[0].pExpr!=0 ); /* Because of isCandidateForInOpt(p) */
2638b07028f7Sdrh     assert( p->pSrc!=0 );               /* Because of isCandidateForInOpt(p) */
2639b07028f7Sdrh     pTab = p->pSrc->a[0].pTab;
2640b07028f7Sdrh 
2641b22f7c83Sdrh     /* Code an OP_Transaction and OP_TableLock for <table>. */
2642e1fb65a0Sdanielk1977     iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
2643099b385dSdrh     assert( iDb>=0 && iDb<SQLITE_MAX_DB );
2644e1fb65a0Sdanielk1977     sqlite3CodeVerifySchema(pParse, iDb);
2645e1fb65a0Sdanielk1977     sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
26469a96b668Sdanielk1977 
2647a84a283dSdrh     assert(v);  /* sqlite3GetVdbe() has always been previously called */
2648cfbb5e82Sdan     if( nExpr==1 && pEList->a[0].pExpr->iColumn<0 ){
264962659b2aSdrh       /* The "x IN (SELECT rowid FROM table)" case */
2650511f9e8dSdrh       int iAddr = sqlite3VdbeAddOp0(v, OP_Once);
26517d176105Sdrh       VdbeCoverage(v);
26529a96b668Sdanielk1977 
26539a96b668Sdanielk1977       sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
26549a96b668Sdanielk1977       eType = IN_INDEX_ROWID;
2655d8852095Sdrh       ExplainQueryPlan((pParse, 0,
2656d8852095Sdrh             "USING ROWID SEARCH ON TABLE %s FOR IN-OPERATOR",pTab->zName));
26579a96b668Sdanielk1977       sqlite3VdbeJumpHere(v, iAddr);
26589a96b668Sdanielk1977     }else{
2659e1fb65a0Sdanielk1977       Index *pIdx;                         /* Iterator variable */
2660cfbb5e82Sdan       int affinity_ok = 1;
2661cfbb5e82Sdan       int i;
2662cfbb5e82Sdan 
2663cfbb5e82Sdan       /* Check that the affinity that will be used to perform each
266462659b2aSdrh       ** comparison is the same as the affinity of each column in table
266562659b2aSdrh       ** on the RHS of the IN operator.  If it not, it is not possible to
266662659b2aSdrh       ** use any index of the RHS table.  */
2667cfbb5e82Sdan       for(i=0; i<nExpr && affinity_ok; i++){
2668fc7f27b9Sdrh         Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2669cfbb5e82Sdan         int iCol = pEList->a[i].pExpr->iColumn;
26700dfa4f6fSdrh         char idxaff = sqlite3TableColumnAffinity(pTab,iCol); /* RHS table */
2671cfbb5e82Sdan         char cmpaff = sqlite3CompareAffinity(pLhs, idxaff);
267262659b2aSdrh         testcase( cmpaff==SQLITE_AFF_BLOB );
267362659b2aSdrh         testcase( cmpaff==SQLITE_AFF_TEXT );
2674cfbb5e82Sdan         switch( cmpaff ){
2675cfbb5e82Sdan           case SQLITE_AFF_BLOB:
2676cfbb5e82Sdan             break;
2677cfbb5e82Sdan           case SQLITE_AFF_TEXT:
267862659b2aSdrh             /* sqlite3CompareAffinity() only returns TEXT if one side or the
267962659b2aSdrh             ** other has no affinity and the other side is TEXT.  Hence,
268062659b2aSdrh             ** the only way for cmpaff to be TEXT is for idxaff to be TEXT
268162659b2aSdrh             ** and for the term on the LHS of the IN to have no affinity. */
268262659b2aSdrh             assert( idxaff==SQLITE_AFF_TEXT );
2683cfbb5e82Sdan             break;
2684cfbb5e82Sdan           default:
2685cfbb5e82Sdan             affinity_ok = sqlite3IsNumericAffinity(idxaff);
2686cfbb5e82Sdan         }
2687cfbb5e82Sdan       }
2688e1fb65a0Sdanielk1977 
2689a84a283dSdrh       if( affinity_ok ){
2690a84a283dSdrh         /* Search for an existing index that will work for this IN operator */
2691a84a283dSdrh         for(pIdx=pTab->pIndex; pIdx && eType==0; pIdx=pIdx->pNext){
2692a84a283dSdrh           Bitmask colUsed;      /* Columns of the index used */
2693a84a283dSdrh           Bitmask mCol;         /* Mask for the current column */
26946fc8f364Sdrh           if( pIdx->nColumn<nExpr ) continue;
2695d4a4a361Sdrh           if( pIdx->pPartIdxWhere!=0 ) continue;
2696a84a283dSdrh           /* Maximum nColumn is BMS-2, not BMS-1, so that we can compute
2697a84a283dSdrh           ** BITMASK(nExpr) without overflowing */
2698a84a283dSdrh           testcase( pIdx->nColumn==BMS-2 );
2699a84a283dSdrh           testcase( pIdx->nColumn==BMS-1 );
2700a84a283dSdrh           if( pIdx->nColumn>=BMS-1 ) continue;
27016fc8f364Sdrh           if( mustBeUnique ){
27026fc8f364Sdrh             if( pIdx->nKeyCol>nExpr
27036fc8f364Sdrh              ||(pIdx->nColumn>nExpr && !IsUniqueIndex(pIdx))
27046fc8f364Sdrh             ){
2705a84a283dSdrh               continue;  /* This index is not unique over the IN RHS columns */
2706cfbb5e82Sdan             }
27076fc8f364Sdrh           }
2708cfbb5e82Sdan 
2709a84a283dSdrh           colUsed = 0;   /* Columns of index used so far */
2710cfbb5e82Sdan           for(i=0; i<nExpr; i++){
2711fc7f27b9Sdrh             Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2712cfbb5e82Sdan             Expr *pRhs = pEList->a[i].pExpr;
2713cfbb5e82Sdan             CollSeq *pReq = sqlite3BinaryCompareCollSeq(pParse, pLhs, pRhs);
2714cfbb5e82Sdan             int j;
2715cfbb5e82Sdan 
27166fc8f364Sdrh             assert( pReq!=0 || pRhs->iColumn==XN_ROWID || pParse->nErr );
2717cfbb5e82Sdan             for(j=0; j<nExpr; j++){
2718cfbb5e82Sdan               if( pIdx->aiColumn[j]!=pRhs->iColumn ) continue;
2719cfbb5e82Sdan               assert( pIdx->azColl[j] );
2720106526e1Sdrh               if( pReq!=0 && sqlite3StrICmp(pReq->zName, pIdx->azColl[j])!=0 ){
2721106526e1Sdrh                 continue;
2722106526e1Sdrh               }
2723cfbb5e82Sdan               break;
2724cfbb5e82Sdan             }
2725cfbb5e82Sdan             if( j==nExpr ) break;
2726a84a283dSdrh             mCol = MASKBIT(j);
2727a84a283dSdrh             if( mCol & colUsed ) break; /* Each column used only once */
2728a84a283dSdrh             colUsed |= mCol;
2729ba00e30aSdan             if( aiMap ) aiMap[i] = j;
2730cfbb5e82Sdan           }
2731cfbb5e82Sdan 
2732a84a283dSdrh           assert( i==nExpr || colUsed!=(MASKBIT(nExpr)-1) );
2733a84a283dSdrh           if( colUsed==(MASKBIT(nExpr)-1) ){
2734a84a283dSdrh             /* If we reach this point, that means the index pIdx is usable */
2735511f9e8dSdrh             int iAddr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
2736e2ca99c9Sdrh             ExplainQueryPlan((pParse, 0,
2737e2ca99c9Sdrh                               "USING INDEX %s FOR IN-OPERATOR",pIdx->zName));
27382ec2fb22Sdrh             sqlite3VdbeAddOp3(v, OP_OpenRead, iTab, pIdx->tnum, iDb);
27392ec2fb22Sdrh             sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
2740207872a4Sdanielk1977             VdbeComment((v, "%s", pIdx->zName));
27411ccce449Sdrh             assert( IN_INDEX_INDEX_DESC == IN_INDEX_INDEX_ASC+1 );
27421ccce449Sdrh             eType = IN_INDEX_INDEX_ASC + pIdx->aSortOrder[0];
27439a96b668Sdanielk1977 
27447b35a77bSdan             if( prRhsHasNull ){
27453480bfdaSdan #ifdef SQLITE_ENABLE_COLUMN_USED_MASK
2746cfbb5e82Sdan               i64 mask = (1<<nExpr)-1;
27473480bfdaSdan               sqlite3VdbeAddOp4Dup8(v, OP_ColumnsUsed,
2748cfbb5e82Sdan                   iTab, 0, 0, (u8*)&mask, P4_INT64);
27493480bfdaSdan #endif
2750b80dbdc2Sdrh               *prRhsHasNull = ++pParse->nMem;
27517b35a77bSdan               if( nExpr==1 ){
27526be515ebSdrh                 sqlite3SetHasNullFlag(v, iTab, *prRhsHasNull);
27530cdc022eSdanielk1977               }
27547b35a77bSdan             }
2755552fd454Sdrh             sqlite3VdbeJumpHere(v, iAddr);
27569a96b668Sdanielk1977           }
2757a84a283dSdrh         } /* End loop over indexes */
2758a84a283dSdrh       } /* End if( affinity_ok ) */
2759a84a283dSdrh     } /* End if not an rowid index */
2760a84a283dSdrh   } /* End attempt to optimize using an index */
27619a96b668Sdanielk1977 
2762bb53ecb1Sdrh   /* If no preexisting index is available for the IN clause
2763bb53ecb1Sdrh   ** and IN_INDEX_NOOP is an allowed reply
2764bb53ecb1Sdrh   ** and the RHS of the IN operator is a list, not a subquery
276571c57db0Sdan   ** and the RHS is not constant or has two or fewer terms,
276660ec914cSpeter.d.reid   ** then it is not worth creating an ephemeral table to evaluate
2767bb53ecb1Sdrh   ** the IN operator so return IN_INDEX_NOOP.
2768bb53ecb1Sdrh   */
2769bb53ecb1Sdrh   if( eType==0
2770bb53ecb1Sdrh    && (inFlags & IN_INDEX_NOOP_OK)
2771bb53ecb1Sdrh    && !ExprHasProperty(pX, EP_xIsSelect)
2772bb53ecb1Sdrh    && (!sqlite3InRhsIsConstant(pX) || pX->x.pList->nExpr<=2)
2773bb53ecb1Sdrh   ){
2774bb53ecb1Sdrh     eType = IN_INDEX_NOOP;
2775bb53ecb1Sdrh   }
2776bb53ecb1Sdrh 
27779a96b668Sdanielk1977   if( eType==0 ){
27784387006cSdrh     /* Could not find an existing table or index to use as the RHS b-tree.
2779b74b1017Sdrh     ** We will have to generate an ephemeral table to do the job.
2780b74b1017Sdrh     */
27818e23daf3Sdrh     u32 savedNQueryLoop = pParse->nQueryLoop;
27820cdc022eSdanielk1977     int rMayHaveNull = 0;
278341a05b7bSdanielk1977     eType = IN_INDEX_EPH;
27843a85625dSdrh     if( inFlags & IN_INDEX_LOOP ){
27854a5acf8eSdrh       pParse->nQueryLoop = 0;
2786e21a6e1dSdrh     }else if( prRhsHasNull ){
2787e21a6e1dSdrh       *prRhsHasNull = rMayHaveNull = ++pParse->nMem;
2788cf4d38aaSdrh     }
278985bcdce2Sdrh     assert( pX->op==TK_IN );
279050ef6716Sdrh     sqlite3CodeRhsOfIN(pParse, pX, iTab);
279185bcdce2Sdrh     if( rMayHaveNull ){
27922c04131cSdrh       sqlite3SetHasNullFlag(v, iTab, rMayHaveNull);
279385bcdce2Sdrh     }
2794cf4d38aaSdrh     pParse->nQueryLoop = savedNQueryLoop;
27959a96b668Sdanielk1977   }
2796ba00e30aSdan 
2797ba00e30aSdan   if( aiMap && eType!=IN_INDEX_INDEX_ASC && eType!=IN_INDEX_INDEX_DESC ){
2798ba00e30aSdan     int i, n;
2799ba00e30aSdan     n = sqlite3ExprVectorSize(pX->pLeft);
2800ba00e30aSdan     for(i=0; i<n; i++) aiMap[i] = i;
2801ba00e30aSdan   }
28022c04131cSdrh   *piTab = iTab;
28039a96b668Sdanielk1977   return eType;
28049a96b668Sdanielk1977 }
2805284f4acaSdanielk1977 #endif
2806626a879aSdrh 
2807f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
2808553168c7Sdan /*
2809553168c7Sdan ** Argument pExpr is an (?, ?...) IN(...) expression. This
2810553168c7Sdan ** function allocates and returns a nul-terminated string containing
2811553168c7Sdan ** the affinities to be used for each column of the comparison.
2812553168c7Sdan **
2813553168c7Sdan ** It is the responsibility of the caller to ensure that the returned
2814553168c7Sdan ** string is eventually freed using sqlite3DbFree().
2815553168c7Sdan */
281671c57db0Sdan static char *exprINAffinity(Parse *pParse, Expr *pExpr){
281771c57db0Sdan   Expr *pLeft = pExpr->pLeft;
281871c57db0Sdan   int nVal = sqlite3ExprVectorSize(pLeft);
2819553168c7Sdan   Select *pSelect = (pExpr->flags & EP_xIsSelect) ? pExpr->x.pSelect : 0;
282071c57db0Sdan   char *zRet;
282171c57db0Sdan 
2822553168c7Sdan   assert( pExpr->op==TK_IN );
28235c258dc1Sdrh   zRet = sqlite3DbMallocRaw(pParse->db, nVal+1);
282471c57db0Sdan   if( zRet ){
282571c57db0Sdan     int i;
282671c57db0Sdan     for(i=0; i<nVal; i++){
2827fc7f27b9Sdrh       Expr *pA = sqlite3VectorFieldSubexpr(pLeft, i);
2828553168c7Sdan       char a = sqlite3ExprAffinity(pA);
2829553168c7Sdan       if( pSelect ){
2830553168c7Sdan         zRet[i] = sqlite3CompareAffinity(pSelect->pEList->a[i].pExpr, a);
283171c57db0Sdan       }else{
2832553168c7Sdan         zRet[i] = a;
283371c57db0Sdan       }
283471c57db0Sdan     }
283571c57db0Sdan     zRet[nVal] = '\0';
283671c57db0Sdan   }
283771c57db0Sdan   return zRet;
283871c57db0Sdan }
2839f9b2e05cSdan #endif
284071c57db0Sdan 
28418da209b1Sdan #ifndef SQLITE_OMIT_SUBQUERY
28428da209b1Sdan /*
28438da209b1Sdan ** Load the Parse object passed as the first argument with an error
28448da209b1Sdan ** message of the form:
28458da209b1Sdan **
28468da209b1Sdan **   "sub-select returns N columns - expected M"
28478da209b1Sdan */
28488da209b1Sdan void sqlite3SubselectError(Parse *pParse, int nActual, int nExpect){
2849a9ebfe20Sdrh   if( pParse->nErr==0 ){
28508da209b1Sdan     const char *zFmt = "sub-select returns %d columns - expected %d";
28518da209b1Sdan     sqlite3ErrorMsg(pParse, zFmt, nActual, nExpect);
28528da209b1Sdan   }
2853a9ebfe20Sdrh }
28548da209b1Sdan #endif
28558da209b1Sdan 
2856626a879aSdrh /*
285744c5604cSdan ** Expression pExpr is a vector that has been used in a context where
285844c5604cSdan ** it is not permitted. If pExpr is a sub-select vector, this routine
285944c5604cSdan ** loads the Parse object with a message of the form:
286044c5604cSdan **
286144c5604cSdan **   "sub-select returns N columns - expected 1"
286244c5604cSdan **
286344c5604cSdan ** Or, if it is a regular scalar vector:
286444c5604cSdan **
286544c5604cSdan **   "row value misused"
286644c5604cSdan */
286744c5604cSdan void sqlite3VectorErrorMsg(Parse *pParse, Expr *pExpr){
286844c5604cSdan #ifndef SQLITE_OMIT_SUBQUERY
286944c5604cSdan   if( pExpr->flags & EP_xIsSelect ){
287044c5604cSdan     sqlite3SubselectError(pParse, pExpr->x.pSelect->pEList->nExpr, 1);
287144c5604cSdan   }else
287244c5604cSdan #endif
287344c5604cSdan   {
287444c5604cSdan     sqlite3ErrorMsg(pParse, "row value misused");
287544c5604cSdan   }
287644c5604cSdan }
287744c5604cSdan 
287885bcdce2Sdrh #ifndef SQLITE_OMIT_SUBQUERY
287944c5604cSdan /*
288085bcdce2Sdrh ** Generate code that will construct an ephemeral table containing all terms
288185bcdce2Sdrh ** in the RHS of an IN operator.  The IN operator can be in either of two
288285bcdce2Sdrh ** forms:
2883626a879aSdrh **
28849cbe6352Sdrh **     x IN (4,5,11)              -- IN operator with list on right-hand side
28859cbe6352Sdrh **     x IN (SELECT a FROM b)     -- IN operator with subquery on the right
2886fef5208cSdrh **
28872c04131cSdrh ** The pExpr parameter is the IN operator.  The cursor number for the
28882c04131cSdrh ** constructed ephermeral table is returned.  The first time the ephemeral
28892c04131cSdrh ** table is computed, the cursor number is also stored in pExpr->iTable,
28902c04131cSdrh ** however the cursor number returned might not be the same, as it might
28912c04131cSdrh ** have been duplicated using OP_OpenDup.
289241a05b7bSdanielk1977 **
289385bcdce2Sdrh ** If the LHS expression ("x" in the examples) is a column value, or
289485bcdce2Sdrh ** the SELECT statement returns a column value, then the affinity of that
289585bcdce2Sdrh ** column is used to build the index keys. If both 'x' and the
289685bcdce2Sdrh ** SELECT... statement are columns, then numeric affinity is used
289785bcdce2Sdrh ** if either column has NUMERIC or INTEGER affinity. If neither
289885bcdce2Sdrh ** 'x' nor the SELECT... statement are columns, then numeric affinity
289985bcdce2Sdrh ** is used.
2900cce7d176Sdrh */
290185bcdce2Sdrh void sqlite3CodeRhsOfIN(
2902fd773cf9Sdrh   Parse *pParse,          /* Parsing context */
290385bcdce2Sdrh   Expr *pExpr,            /* The IN operator */
290450ef6716Sdrh   int iTab                /* Use this cursor number */
290541a05b7bSdanielk1977 ){
29062c04131cSdrh   int addrOnce = 0;           /* Address of the OP_Once instruction at top */
290785bcdce2Sdrh   int addr;                   /* Address of OP_OpenEphemeral instruction */
290885bcdce2Sdrh   Expr *pLeft;                /* the LHS of the IN operator */
290985bcdce2Sdrh   KeyInfo *pKeyInfo = 0;      /* Key information */
291085bcdce2Sdrh   int nVal;                   /* Size of vector pLeft */
291185bcdce2Sdrh   Vdbe *v;                    /* The prepared statement under construction */
2912fc976065Sdanielk1977 
29132c04131cSdrh   v = pParse->pVdbe;
291485bcdce2Sdrh   assert( v!=0 );
291585bcdce2Sdrh 
29162c04131cSdrh   /* The evaluation of the IN must be repeated every time it
291739a11819Sdrh   ** is encountered if any of the following is true:
291857dbd7b3Sdrh   **
291957dbd7b3Sdrh   **    *  The right-hand side is a correlated subquery
292057dbd7b3Sdrh   **    *  The right-hand side is an expression list containing variables
292157dbd7b3Sdrh   **    *  We are inside a trigger
292257dbd7b3Sdrh   **
29232c04131cSdrh   ** If all of the above are false, then we can compute the RHS just once
29242c04131cSdrh   ** and reuse it many names.
2925b3bce662Sdanielk1977   */
2926efb699fcSdrh   if( !ExprHasProperty(pExpr, EP_VarSelect) && pParse->iSelfTab==0 ){
29272c04131cSdrh     /* Reuse of the RHS is allowed */
29282c04131cSdrh     /* If this routine has already been coded, but the previous code
29292c04131cSdrh     ** might not have been invoked yet, so invoke it now as a subroutine.
29302c04131cSdrh     */
29312c04131cSdrh     if( ExprHasProperty(pExpr, EP_Subrtn) ){
2932f9231c34Sdrh       addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
2933bd462bccSdrh       if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2934bd462bccSdrh         ExplainQueryPlan((pParse, 0, "REUSE LIST SUBQUERY %d",
2935bd462bccSdrh               pExpr->x.pSelect->selId));
2936bd462bccSdrh       }
29372c04131cSdrh       sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
29382c04131cSdrh                         pExpr->y.sub.iAddr);
29392c04131cSdrh       sqlite3VdbeAddOp2(v, OP_OpenDup, iTab, pExpr->iTable);
2940f9231c34Sdrh       sqlite3VdbeJumpHere(v, addrOnce);
29412c04131cSdrh       return;
29422c04131cSdrh     }
29432c04131cSdrh 
29442c04131cSdrh     /* Begin coding the subroutine */
29452c04131cSdrh     ExprSetProperty(pExpr, EP_Subrtn);
2946088489e8Sdrh     assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
29472c04131cSdrh     pExpr->y.sub.regReturn = ++pParse->nMem;
29482c04131cSdrh     pExpr->y.sub.iAddr =
29492c04131cSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 0, pExpr->y.sub.regReturn) + 1;
29502c04131cSdrh     VdbeComment((v, "return address"));
29512c04131cSdrh 
29522c04131cSdrh     addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
2953b3bce662Sdanielk1977   }
2954b3bce662Sdanielk1977 
295585bcdce2Sdrh   /* Check to see if this is a vector IN operator */
295685bcdce2Sdrh   pLeft = pExpr->pLeft;
295771c57db0Sdan   nVal = sqlite3ExprVectorSize(pLeft);
2958e014a838Sdanielk1977 
295985bcdce2Sdrh   /* Construct the ephemeral table that will contain the content of
296085bcdce2Sdrh   ** RHS of the IN operator.
2961fef5208cSdrh   */
29622c04131cSdrh   pExpr->iTable = iTab;
296350ef6716Sdrh   addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, pExpr->iTable, nVal);
29642c04131cSdrh #ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
29652c04131cSdrh   if( ExprHasProperty(pExpr, EP_xIsSelect) ){
29662c04131cSdrh     VdbeComment((v, "Result of SELECT %u", pExpr->x.pSelect->selId));
29672c04131cSdrh   }else{
29682c04131cSdrh     VdbeComment((v, "RHS of IN operator"));
29692c04131cSdrh   }
29702c04131cSdrh #endif
297150ef6716Sdrh   pKeyInfo = sqlite3KeyInfoAlloc(pParse->db, nVal, 1);
2972e014a838Sdanielk1977 
29736ab3a2ecSdanielk1977   if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2974e014a838Sdanielk1977     /* Case 1:     expr IN (SELECT ...)
2975e014a838Sdanielk1977     **
2976e014a838Sdanielk1977     ** Generate code to write the results of the select into the temporary
2977e014a838Sdanielk1977     ** table allocated and opened above.
2978e014a838Sdanielk1977     */
29794387006cSdrh     Select *pSelect = pExpr->x.pSelect;
298071c57db0Sdan     ExprList *pEList = pSelect->pEList;
29811013c932Sdrh 
29822c04131cSdrh     ExplainQueryPlan((pParse, 1, "%sLIST SUBQUERY %d",
29832c04131cSdrh         addrOnce?"":"CORRELATED ", pSelect->selId
2984e2ca99c9Sdrh     ));
298564bcb8cfSdrh     /* If the LHS and RHS of the IN operator do not match, that
298664bcb8cfSdrh     ** error will have been caught long before we reach this point. */
298764bcb8cfSdrh     if( ALWAYS(pEList->nExpr==nVal) ){
298814c4d428Sdrh       Select *pCopy;
298971c57db0Sdan       SelectDest dest;
299071c57db0Sdan       int i;
299114c4d428Sdrh       int rc;
2992bd462bccSdrh       sqlite3SelectDestInit(&dest, SRT_Set, iTab);
299371c57db0Sdan       dest.zAffSdst = exprINAffinity(pParse, pExpr);
29944387006cSdrh       pSelect->iLimit = 0;
29954387006cSdrh       testcase( pSelect->selFlags & SF_Distinct );
2996812ea833Sdrh       testcase( pKeyInfo==0 ); /* Caused by OOM in sqlite3KeyInfoAlloc() */
299714c4d428Sdrh       pCopy = sqlite3SelectDup(pParse->db, pSelect, 0);
299814c4d428Sdrh       rc = pParse->db->mallocFailed ? 1 :sqlite3Select(pParse, pCopy, &dest);
299914c4d428Sdrh       sqlite3SelectDelete(pParse->db, pCopy);
300071c57db0Sdan       sqlite3DbFree(pParse->db, dest.zAffSdst);
300114c4d428Sdrh       if( rc ){
30022ec2fb22Sdrh         sqlite3KeyInfoUnref(pKeyInfo);
300385bcdce2Sdrh         return;
300494ccde58Sdrh       }
3005812ea833Sdrh       assert( pKeyInfo!=0 ); /* OOM will cause exit after sqlite3Select() */
30063535ec3eSdrh       assert( pEList!=0 );
30073535ec3eSdrh       assert( pEList->nExpr>0 );
30082ec2fb22Sdrh       assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
300971c57db0Sdan       for(i=0; i<nVal; i++){
3010773d3afaSdan         Expr *p = sqlite3VectorFieldSubexpr(pLeft, i);
301171c57db0Sdan         pKeyInfo->aColl[i] = sqlite3BinaryCompareCollSeq(
301271c57db0Sdan             pParse, p, pEList->a[i].pExpr
301371c57db0Sdan         );
301471c57db0Sdan       }
301571c57db0Sdan     }
3016a7d2db17Sdrh   }else if( ALWAYS(pExpr->x.pList!=0) ){
3017fef5208cSdrh     /* Case 2:     expr IN (exprlist)
3018fef5208cSdrh     **
3019e014a838Sdanielk1977     ** For each expression, build an index key from the evaluation and
3020e014a838Sdanielk1977     ** store it in the temporary table. If <expr> is a column, then use
3021e014a838Sdanielk1977     ** that columns affinity when building index keys. If <expr> is not
3022e014a838Sdanielk1977     ** a column, use numeric affinity.
3023fef5208cSdrh     */
302471c57db0Sdan     char affinity;            /* Affinity of the LHS of the IN */
3025e014a838Sdanielk1977     int i;
30266ab3a2ecSdanielk1977     ExprList *pList = pExpr->x.pList;
302757dbd7b3Sdrh     struct ExprList_item *pItem;
3028c324d446Sdan     int r1, r2;
302971c57db0Sdan     affinity = sqlite3ExprAffinity(pLeft);
303096fb16eeSdrh     if( affinity<=SQLITE_AFF_NONE ){
303105883a34Sdrh       affinity = SQLITE_AFF_BLOB;
303295b39590Sdrh     }else if( affinity==SQLITE_AFF_REAL ){
303395b39590Sdrh       affinity = SQLITE_AFF_NUMERIC;
3034e014a838Sdanielk1977     }
3035323df790Sdrh     if( pKeyInfo ){
30362ec2fb22Sdrh       assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
3037323df790Sdrh       pKeyInfo->aColl[0] = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
3038323df790Sdrh     }
3039e014a838Sdanielk1977 
3040e014a838Sdanielk1977     /* Loop through each expression in <exprlist>. */
30412d401ab8Sdrh     r1 = sqlite3GetTempReg(pParse);
30422d401ab8Sdrh     r2 = sqlite3GetTempReg(pParse);
304357dbd7b3Sdrh     for(i=pList->nExpr, pItem=pList->a; i>0; i--, pItem++){
304457dbd7b3Sdrh       Expr *pE2 = pItem->pExpr;
3045e014a838Sdanielk1977 
304657dbd7b3Sdrh       /* If the expression is not constant then we will need to
304757dbd7b3Sdrh       ** disable the test that was generated above that makes sure
304857dbd7b3Sdrh       ** this code only executes once.  Because for a non-constant
304957dbd7b3Sdrh       ** expression we need to rerun this code each time.
305057dbd7b3Sdrh       */
30512c04131cSdrh       if( addrOnce && !sqlite3ExprIsConstant(pE2) ){
30522c04131cSdrh         sqlite3VdbeChangeToNoop(v, addrOnce);
30537ac0e562Sdan         ExprClearProperty(pExpr, EP_Subrtn);
30542c04131cSdrh         addrOnce = 0;
30554794b980Sdrh       }
3056e014a838Sdanielk1977 
3057e014a838Sdanielk1977       /* Evaluate the expression and insert it into the temp table */
3058c324d446Sdan       sqlite3ExprCode(pParse, pE2, r1);
3059c324d446Sdan       sqlite3VdbeAddOp4(v, OP_MakeRecord, r1, 1, r2, &affinity, 1);
3060c324d446Sdan       sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iTab, r2, r1, 1);
3061fef5208cSdrh     }
30622d401ab8Sdrh     sqlite3ReleaseTempReg(pParse, r1);
30632d401ab8Sdrh     sqlite3ReleaseTempReg(pParse, r2);
3064fef5208cSdrh   }
3065323df790Sdrh   if( pKeyInfo ){
30662ec2fb22Sdrh     sqlite3VdbeChangeP4(v, addr, (void *)pKeyInfo, P4_KEYINFO);
306741a05b7bSdanielk1977   }
30682c04131cSdrh   if( addrOnce ){
30692c04131cSdrh     sqlite3VdbeJumpHere(v, addrOnce);
30702c04131cSdrh     /* Subroutine return */
30712c04131cSdrh     sqlite3VdbeAddOp1(v, OP_Return, pExpr->y.sub.regReturn);
30722c04131cSdrh     sqlite3VdbeChangeP1(v, pExpr->y.sub.iAddr-1, sqlite3VdbeCurrentAddr(v)-1);
30736d2566dfSdrh     sqlite3ClearTempRegCache(pParse);
307485bcdce2Sdrh   }
307585bcdce2Sdrh }
307685bcdce2Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
307785bcdce2Sdrh 
307885bcdce2Sdrh /*
307985bcdce2Sdrh ** Generate code for scalar subqueries used as a subquery expression
308085bcdce2Sdrh ** or EXISTS operator:
308185bcdce2Sdrh **
308285bcdce2Sdrh **     (SELECT a FROM b)          -- subquery
308385bcdce2Sdrh **     EXISTS (SELECT a FROM b)   -- EXISTS subquery
308485bcdce2Sdrh **
308585bcdce2Sdrh ** The pExpr parameter is the SELECT or EXISTS operator to be coded.
308685bcdce2Sdrh **
3087d86fe44aSdrh ** Return the register that holds the result.  For a multi-column SELECT,
308885bcdce2Sdrh ** the result is stored in a contiguous array of registers and the
308985bcdce2Sdrh ** return value is the register of the left-most result column.
309085bcdce2Sdrh ** Return 0 if an error occurs.
309185bcdce2Sdrh */
309285bcdce2Sdrh #ifndef SQLITE_OMIT_SUBQUERY
309385bcdce2Sdrh int sqlite3CodeSubselect(Parse *pParse, Expr *pExpr){
30942c04131cSdrh   int addrOnce = 0;           /* Address of OP_Once at top of subroutine */
309585bcdce2Sdrh   int rReg = 0;               /* Register storing resulting */
309685bcdce2Sdrh   Select *pSel;               /* SELECT statement to encode */
309785bcdce2Sdrh   SelectDest dest;            /* How to deal with SELECT result */
309885bcdce2Sdrh   int nReg;                   /* Registers to allocate */
309985bcdce2Sdrh   Expr *pLimit;               /* New limit expression */
31002c04131cSdrh 
31012c04131cSdrh   Vdbe *v = pParse->pVdbe;
310285bcdce2Sdrh   assert( v!=0 );
310305428127Sdrh   if( pParse->nErr ) return 0;
3104bd462bccSdrh   testcase( pExpr->op==TK_EXISTS );
3105bd462bccSdrh   testcase( pExpr->op==TK_SELECT );
3106bd462bccSdrh   assert( pExpr->op==TK_EXISTS || pExpr->op==TK_SELECT );
3107bd462bccSdrh   assert( ExprHasProperty(pExpr, EP_xIsSelect) );
3108bd462bccSdrh   pSel = pExpr->x.pSelect;
310985bcdce2Sdrh 
31105198ff57Sdrh   /* If this routine has already been coded, then invoke it as a
31115198ff57Sdrh   ** subroutine. */
31125198ff57Sdrh   if( ExprHasProperty(pExpr, EP_Subrtn) ){
3113bd462bccSdrh     ExplainQueryPlan((pParse, 0, "REUSE SUBQUERY %d", pSel->selId));
31145198ff57Sdrh     sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
31155198ff57Sdrh                       pExpr->y.sub.iAddr);
31165198ff57Sdrh     return pExpr->iTable;
31175198ff57Sdrh   }
31185198ff57Sdrh 
31195198ff57Sdrh   /* Begin coding the subroutine */
31205198ff57Sdrh   ExprSetProperty(pExpr, EP_Subrtn);
31215198ff57Sdrh   pExpr->y.sub.regReturn = ++pParse->nMem;
31225198ff57Sdrh   pExpr->y.sub.iAddr =
31235198ff57Sdrh     sqlite3VdbeAddOp2(v, OP_Integer, 0, pExpr->y.sub.regReturn) + 1;
31245198ff57Sdrh   VdbeComment((v, "return address"));
31255198ff57Sdrh 
312614c4d428Sdrh 
312714c4d428Sdrh   /* The evaluation of the EXISTS/SELECT must be repeated every time it
312814c4d428Sdrh   ** is encountered if any of the following is true:
312914c4d428Sdrh   **
313014c4d428Sdrh   **    *  The right-hand side is a correlated subquery
313114c4d428Sdrh   **    *  The right-hand side is an expression list containing variables
313214c4d428Sdrh   **    *  We are inside a trigger
313314c4d428Sdrh   **
313414c4d428Sdrh   ** If all of the above are false, then we can run this code just once
313514c4d428Sdrh   ** save the results, and reuse the same result on subsequent invocations.
313614c4d428Sdrh   */
313714c4d428Sdrh   if( !ExprHasProperty(pExpr, EP_VarSelect) ){
31382c04131cSdrh     addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
3139fef5208cSdrh   }
3140fef5208cSdrh 
314185bcdce2Sdrh   /* For a SELECT, generate code to put the values for all columns of
314239a11819Sdrh   ** the first row into an array of registers and return the index of
314339a11819Sdrh   ** the first register.
314439a11819Sdrh   **
314539a11819Sdrh   ** If this is an EXISTS, write an integer 0 (not exists) or 1 (exists)
314639a11819Sdrh   ** into a register and return that register number.
314739a11819Sdrh   **
314839a11819Sdrh   ** In both cases, the query is augmented with "LIMIT 1".  Any
314939a11819Sdrh   ** preexisting limit is discarded in place of the new LIMIT 1.
3150fef5208cSdrh   */
3151bd462bccSdrh   ExplainQueryPlan((pParse, 1, "%sSCALAR SUBQUERY %d",
3152bd462bccSdrh         addrOnce?"":"CORRELATED ", pSel->selId));
315371c57db0Sdan   nReg = pExpr->op==TK_SELECT ? pSel->pEList->nExpr : 1;
315471c57db0Sdan   sqlite3SelectDestInit(&dest, 0, pParse->nMem+1);
315571c57db0Sdan   pParse->nMem += nReg;
315651522cd3Sdrh   if( pExpr->op==TK_SELECT ){
31576c8c8ce0Sdanielk1977     dest.eDest = SRT_Mem;
315853932ce8Sdrh     dest.iSdst = dest.iSDParm;
315971c57db0Sdan     dest.nSdst = nReg;
316071c57db0Sdan     sqlite3VdbeAddOp3(v, OP_Null, 0, dest.iSDParm, dest.iSDParm+nReg-1);
3161d4e70ebdSdrh     VdbeComment((v, "Init subquery result"));
316251522cd3Sdrh   }else{
31636c8c8ce0Sdanielk1977     dest.eDest = SRT_Exists;
31642b596da8Sdrh     sqlite3VdbeAddOp2(v, OP_Integer, 0, dest.iSDParm);
3165d4e70ebdSdrh     VdbeComment((v, "Init EXISTS result"));
316651522cd3Sdrh   }
31678c0833fbSdrh   if( pSel->pLimit ){
31687ca1347fSdrh     /* The subquery already has a limit.  If the pre-existing limit is X
31697ca1347fSdrh     ** then make the new limit X<>0 so that the new limit is either 1 or 0 */
31707ca1347fSdrh     sqlite3 *db = pParse->db;
31715776ee5cSdrh     pLimit = sqlite3Expr(db, TK_INTEGER, "0");
31727ca1347fSdrh     if( pLimit ){
31737ca1347fSdrh       pLimit->affExpr = SQLITE_AFF_NUMERIC;
31747ca1347fSdrh       pLimit = sqlite3PExpr(pParse, TK_NE,
31757ca1347fSdrh                             sqlite3ExprDup(db, pSel->pLimit->pLeft, 0), pLimit);
31767ca1347fSdrh     }
31777ca1347fSdrh     sqlite3ExprDelete(db, pSel->pLimit->pLeft);
31788c0833fbSdrh     pSel->pLimit->pLeft = pLimit;
31798c0833fbSdrh   }else{
31807ca1347fSdrh     /* If there is no pre-existing limit add a limit of 1 */
31815776ee5cSdrh     pLimit = sqlite3Expr(pParse->db, TK_INTEGER, "1");
31828c0833fbSdrh     pSel->pLimit = sqlite3PExpr(pParse, TK_LIMIT, pLimit, 0);
31838c0833fbSdrh   }
318448b5b041Sdrh   pSel->iLimit = 0;
31857d10d5a6Sdrh   if( sqlite3Select(pParse, pSel, &dest) ){
3186bf7f3a00Sdrh     if( pParse->nErr ){
3187bf7f3a00Sdrh       pExpr->op2 = pExpr->op;
3188bf7f3a00Sdrh       pExpr->op = TK_ERROR;
3189bf7f3a00Sdrh     }
31901450bc6eSdrh     return 0;
319194ccde58Sdrh   }
31922c04131cSdrh   pExpr->iTable = rReg = dest.iSDParm;
3193ebb6a65dSdrh   ExprSetVVAProperty(pExpr, EP_NoReduce);
31942c04131cSdrh   if( addrOnce ){
31952c04131cSdrh     sqlite3VdbeJumpHere(v, addrOnce);
319614c4d428Sdrh   }
3197fc976065Sdanielk1977 
31982c04131cSdrh   /* Subroutine return */
31992c04131cSdrh   sqlite3VdbeAddOp1(v, OP_Return, pExpr->y.sub.regReturn);
32002c04131cSdrh   sqlite3VdbeChangeP1(v, pExpr->y.sub.iAddr-1, sqlite3VdbeCurrentAddr(v)-1);
32016d2566dfSdrh   sqlite3ClearTempRegCache(pParse);
32021450bc6eSdrh   return rReg;
3203cce7d176Sdrh }
320451522cd3Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
3205cce7d176Sdrh 
3206e3365e6cSdrh #ifndef SQLITE_OMIT_SUBQUERY
3207e3365e6cSdrh /*
32087b35a77bSdan ** Expr pIn is an IN(...) expression. This function checks that the
32097b35a77bSdan ** sub-select on the RHS of the IN() operator has the same number of
32107b35a77bSdan ** columns as the vector on the LHS. Or, if the RHS of the IN() is not
32117b35a77bSdan ** a sub-query, that the LHS is a vector of size 1.
32127b35a77bSdan */
32137b35a77bSdan int sqlite3ExprCheckIN(Parse *pParse, Expr *pIn){
32147b35a77bSdan   int nVector = sqlite3ExprVectorSize(pIn->pLeft);
32157a04e296Sdrh   if( (pIn->flags & EP_xIsSelect)!=0 && !pParse->db->mallocFailed ){
32167b35a77bSdan     if( nVector!=pIn->x.pSelect->pEList->nExpr ){
32177b35a77bSdan       sqlite3SubselectError(pParse, pIn->x.pSelect->pEList->nExpr, nVector);
32187b35a77bSdan       return 1;
32197b35a77bSdan     }
32207b35a77bSdan   }else if( nVector!=1 ){
322144c5604cSdan     sqlite3VectorErrorMsg(pParse, pIn->pLeft);
32227b35a77bSdan     return 1;
32237b35a77bSdan   }
32247b35a77bSdan   return 0;
32257b35a77bSdan }
32267b35a77bSdan #endif
32277b35a77bSdan 
32287b35a77bSdan #ifndef SQLITE_OMIT_SUBQUERY
32297b35a77bSdan /*
3230e3365e6cSdrh ** Generate code for an IN expression.
3231e3365e6cSdrh **
3232e3365e6cSdrh **      x IN (SELECT ...)
3233e3365e6cSdrh **      x IN (value, value, ...)
3234e3365e6cSdrh **
3235ecb87ac8Sdrh ** The left-hand side (LHS) is a scalar or vector expression.  The
3236e347d3e8Sdrh ** right-hand side (RHS) is an array of zero or more scalar values, or a
3237e347d3e8Sdrh ** subquery.  If the RHS is a subquery, the number of result columns must
3238e347d3e8Sdrh ** match the number of columns in the vector on the LHS.  If the RHS is
3239e347d3e8Sdrh ** a list of values, the LHS must be a scalar.
3240e347d3e8Sdrh **
3241e347d3e8Sdrh ** The IN operator is true if the LHS value is contained within the RHS.
3242e347d3e8Sdrh ** The result is false if the LHS is definitely not in the RHS.  The
3243e347d3e8Sdrh ** result is NULL if the presence of the LHS in the RHS cannot be
3244e347d3e8Sdrh ** determined due to NULLs.
3245e3365e6cSdrh **
32466be515ebSdrh ** This routine generates code that jumps to destIfFalse if the LHS is not
3247e3365e6cSdrh ** contained within the RHS.  If due to NULLs we cannot determine if the LHS
3248e3365e6cSdrh ** is contained in the RHS then jump to destIfNull.  If the LHS is contained
3249e3365e6cSdrh ** within the RHS then fall through.
3250ecb87ac8Sdrh **
3251ecb87ac8Sdrh ** See the separate in-operator.md documentation file in the canonical
3252ecb87ac8Sdrh ** SQLite source tree for additional information.
3253e3365e6cSdrh */
3254e3365e6cSdrh static void sqlite3ExprCodeIN(
3255e3365e6cSdrh   Parse *pParse,        /* Parsing and code generating context */
3256e3365e6cSdrh   Expr *pExpr,          /* The IN expression */
3257e3365e6cSdrh   int destIfFalse,      /* Jump here if LHS is not contained in the RHS */
3258e3365e6cSdrh   int destIfNull        /* Jump here if the results are unknown due to NULLs */
3259e3365e6cSdrh ){
3260e3365e6cSdrh   int rRhsHasNull = 0;  /* Register that is true if RHS contains NULL values */
3261e3365e6cSdrh   int eType;            /* Type of the RHS */
3262e347d3e8Sdrh   int rLhs;             /* Register(s) holding the LHS values */
3263e347d3e8Sdrh   int rLhsOrig;         /* LHS values prior to reordering by aiMap[] */
3264e3365e6cSdrh   Vdbe *v;              /* Statement under construction */
3265ba00e30aSdan   int *aiMap = 0;       /* Map from vector field to index column */
3266ba00e30aSdan   char *zAff = 0;       /* Affinity string for comparisons */
3267ecb87ac8Sdrh   int nVector;          /* Size of vectors for this IN operator */
326812abf408Sdrh   int iDummy;           /* Dummy parameter to exprCodeVector() */
3269e347d3e8Sdrh   Expr *pLeft;          /* The LHS of the IN operator */
3270ecb87ac8Sdrh   int i;                /* loop counter */
3271e347d3e8Sdrh   int destStep2;        /* Where to jump when NULLs seen in step 2 */
3272e347d3e8Sdrh   int destStep6 = 0;    /* Start of code for Step 6 */
3273e347d3e8Sdrh   int addrTruthOp;      /* Address of opcode that determines the IN is true */
3274e347d3e8Sdrh   int destNotNull;      /* Jump here if a comparison is not true in step 6 */
3275e347d3e8Sdrh   int addrTop;          /* Top of the step-6 loop */
32762c04131cSdrh   int iTab = 0;         /* Index to use */
3277c59b4acfSdan   u8 okConstFactor = pParse->okConstFactor;
3278e3365e6cSdrh 
3279e7375bfaSdrh   assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
3280e347d3e8Sdrh   pLeft = pExpr->pLeft;
32817b35a77bSdan   if( sqlite3ExprCheckIN(pParse, pExpr) ) return;
3282553168c7Sdan   zAff = exprINAffinity(pParse, pExpr);
3283ba00e30aSdan   nVector = sqlite3ExprVectorSize(pExpr->pLeft);
3284ba00e30aSdan   aiMap = (int*)sqlite3DbMallocZero(
3285ba00e30aSdan       pParse->db, nVector*(sizeof(int) + sizeof(char)) + 1
3286ba00e30aSdan   );
3287e347d3e8Sdrh   if( pParse->db->mallocFailed ) goto sqlite3ExprCodeIN_oom_error;
32887b35a77bSdan 
3289ba00e30aSdan   /* Attempt to compute the RHS. After this step, if anything other than
32902c04131cSdrh   ** IN_INDEX_NOOP is returned, the table opened with cursor iTab
3291ba00e30aSdan   ** contains the values that make up the RHS. If IN_INDEX_NOOP is returned,
3292ba00e30aSdan   ** the RHS has not yet been coded.  */
3293e3365e6cSdrh   v = pParse->pVdbe;
3294e3365e6cSdrh   assert( v!=0 );       /* OOM detected prior to this routine */
3295e3365e6cSdrh   VdbeNoopComment((v, "begin IN expr"));
3296bb53ecb1Sdrh   eType = sqlite3FindInIndex(pParse, pExpr,
3297bb53ecb1Sdrh                              IN_INDEX_MEMBERSHIP | IN_INDEX_NOOP_OK,
32982c04131cSdrh                              destIfFalse==destIfNull ? 0 : &rRhsHasNull,
32992c04131cSdrh                              aiMap, &iTab);
3300e3365e6cSdrh 
3301ba00e30aSdan   assert( pParse->nErr || nVector==1 || eType==IN_INDEX_EPH
3302ba00e30aSdan        || eType==IN_INDEX_INDEX_ASC || eType==IN_INDEX_INDEX_DESC
3303ba00e30aSdan   );
3304ecb87ac8Sdrh #ifdef SQLITE_DEBUG
3305ecb87ac8Sdrh   /* Confirm that aiMap[] contains nVector integer values between 0 and
3306ecb87ac8Sdrh   ** nVector-1. */
3307ecb87ac8Sdrh   for(i=0; i<nVector; i++){
3308ecb87ac8Sdrh     int j, cnt;
3309ecb87ac8Sdrh     for(cnt=j=0; j<nVector; j++) if( aiMap[j]==i ) cnt++;
3310ecb87ac8Sdrh     assert( cnt==1 );
3311ecb87ac8Sdrh   }
3312ecb87ac8Sdrh #endif
3313e3365e6cSdrh 
3314ba00e30aSdan   /* Code the LHS, the <expr> from "<expr> IN (...)". If the LHS is a
3315ba00e30aSdan   ** vector, then it is stored in an array of nVector registers starting
3316ba00e30aSdan   ** at r1.
3317e347d3e8Sdrh   **
3318e347d3e8Sdrh   ** sqlite3FindInIndex() might have reordered the fields of the LHS vector
3319e347d3e8Sdrh   ** so that the fields are in the same order as an existing index.   The
3320e347d3e8Sdrh   ** aiMap[] array contains a mapping from the original LHS field order to
3321e347d3e8Sdrh   ** the field order that matches the RHS index.
3322c59b4acfSdan   **
3323c59b4acfSdan   ** Avoid factoring the LHS of the IN(...) expression out of the loop,
3324c59b4acfSdan   ** even if it is constant, as OP_Affinity may be used on the register
3325c59b4acfSdan   ** by code generated below.  */
3326c59b4acfSdan   assert( pParse->okConstFactor==okConstFactor );
3327c59b4acfSdan   pParse->okConstFactor = 0;
3328e347d3e8Sdrh   rLhsOrig = exprCodeVector(pParse, pLeft, &iDummy);
3329c59b4acfSdan   pParse->okConstFactor = okConstFactor;
3330e347d3e8Sdrh   for(i=0; i<nVector && aiMap[i]==i; i++){} /* Are LHS fields reordered? */
3331ecb87ac8Sdrh   if( i==nVector ){
3332e347d3e8Sdrh     /* LHS fields are not reordered */
3333e347d3e8Sdrh     rLhs = rLhsOrig;
3334ecb87ac8Sdrh   }else{
3335ecb87ac8Sdrh     /* Need to reorder the LHS fields according to aiMap */
3336e347d3e8Sdrh     rLhs = sqlite3GetTempRange(pParse, nVector);
3337ba00e30aSdan     for(i=0; i<nVector; i++){
3338e347d3e8Sdrh       sqlite3VdbeAddOp3(v, OP_Copy, rLhsOrig+i, rLhs+aiMap[i], 0);
3339ba00e30aSdan     }
3340ecb87ac8Sdrh   }
3341e3365e6cSdrh 
3342bb53ecb1Sdrh   /* If sqlite3FindInIndex() did not find or create an index that is
3343bb53ecb1Sdrh   ** suitable for evaluating the IN operator, then evaluate using a
3344bb53ecb1Sdrh   ** sequence of comparisons.
3345e347d3e8Sdrh   **
3346e347d3e8Sdrh   ** This is step (1) in the in-operator.md optimized algorithm.
3347bb53ecb1Sdrh   */
3348bb53ecb1Sdrh   if( eType==IN_INDEX_NOOP ){
3349bb53ecb1Sdrh     ExprList *pList = pExpr->x.pList;
3350bb53ecb1Sdrh     CollSeq *pColl = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
3351ec4ccdbcSdrh     int labelOk = sqlite3VdbeMakeLabel(pParse);
3352bb53ecb1Sdrh     int r2, regToFree;
3353bb53ecb1Sdrh     int regCkNull = 0;
3354bb53ecb1Sdrh     int ii;
3355bb53ecb1Sdrh     assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
3356bb53ecb1Sdrh     if( destIfNull!=destIfFalse ){
3357bb53ecb1Sdrh       regCkNull = sqlite3GetTempReg(pParse);
3358e347d3e8Sdrh       sqlite3VdbeAddOp3(v, OP_BitAnd, rLhs, rLhs, regCkNull);
3359bb53ecb1Sdrh     }
3360bb53ecb1Sdrh     for(ii=0; ii<pList->nExpr; ii++){
33614fc83654Sdrh       r2 = sqlite3ExprCodeTemp(pParse, pList->a[ii].pExpr, &regToFree);
3362a976979bSdrh       if( regCkNull && sqlite3ExprCanBeNull(pList->a[ii].pExpr) ){
3363bb53ecb1Sdrh         sqlite3VdbeAddOp3(v, OP_BitAnd, regCkNull, r2, regCkNull);
3364bb53ecb1Sdrh       }
3365f6ea97eaSdrh       sqlite3ReleaseTempReg(pParse, regToFree);
3366bb53ecb1Sdrh       if( ii<pList->nExpr-1 || destIfNull!=destIfFalse ){
33674799488eSdrh         int op = rLhs!=r2 ? OP_Eq : OP_NotNull;
33684799488eSdrh         sqlite3VdbeAddOp4(v, op, rLhs, labelOk, r2,
33694336b0e6Sdrh                           (void*)pColl, P4_COLLSEQ);
33704799488eSdrh         VdbeCoverageIf(v, ii<pList->nExpr-1 && op==OP_Eq);
33714799488eSdrh         VdbeCoverageIf(v, ii==pList->nExpr-1 && op==OP_Eq);
33724799488eSdrh         VdbeCoverageIf(v, ii<pList->nExpr-1 && op==OP_NotNull);
33734799488eSdrh         VdbeCoverageIf(v, ii==pList->nExpr-1 && op==OP_NotNull);
3374ba00e30aSdan         sqlite3VdbeChangeP5(v, zAff[0]);
3375bb53ecb1Sdrh       }else{
33764799488eSdrh         int op = rLhs!=r2 ? OP_Ne : OP_IsNull;
3377bb53ecb1Sdrh         assert( destIfNull==destIfFalse );
33784799488eSdrh         sqlite3VdbeAddOp4(v, op, rLhs, destIfFalse, r2,
33794799488eSdrh                           (void*)pColl, P4_COLLSEQ);
33804799488eSdrh         VdbeCoverageIf(v, op==OP_Ne);
33814799488eSdrh         VdbeCoverageIf(v, op==OP_IsNull);
3382ba00e30aSdan         sqlite3VdbeChangeP5(v, zAff[0] | SQLITE_JUMPIFNULL);
3383bb53ecb1Sdrh       }
3384bb53ecb1Sdrh     }
3385bb53ecb1Sdrh     if( regCkNull ){
3386bb53ecb1Sdrh       sqlite3VdbeAddOp2(v, OP_IsNull, regCkNull, destIfNull); VdbeCoverage(v);
3387076e85f5Sdrh       sqlite3VdbeGoto(v, destIfFalse);
3388bb53ecb1Sdrh     }
3389bb53ecb1Sdrh     sqlite3VdbeResolveLabel(v, labelOk);
3390bb53ecb1Sdrh     sqlite3ReleaseTempReg(pParse, regCkNull);
3391e347d3e8Sdrh     goto sqlite3ExprCodeIN_finished;
3392e347d3e8Sdrh   }
3393bb53ecb1Sdrh 
3394e347d3e8Sdrh   /* Step 2: Check to see if the LHS contains any NULL columns.  If the
3395e347d3e8Sdrh   ** LHS does contain NULLs then the result must be either FALSE or NULL.
3396e347d3e8Sdrh   ** We will then skip the binary search of the RHS.
3397e347d3e8Sdrh   */
3398094430ebSdrh   if( destIfNull==destIfFalse ){
3399e347d3e8Sdrh     destStep2 = destIfFalse;
3400e347d3e8Sdrh   }else{
3401ec4ccdbcSdrh     destStep2 = destStep6 = sqlite3VdbeMakeLabel(pParse);
3402e347d3e8Sdrh   }
34034eac5f04Sdrh   if( pParse->nErr ) goto sqlite3ExprCodeIN_finished;
3404d49fd4e8Sdan   for(i=0; i<nVector; i++){
3405fc7f27b9Sdrh     Expr *p = sqlite3VectorFieldSubexpr(pExpr->pLeft, i);
34064c4a2572Sdrh     if( pParse->db->mallocFailed ) goto sqlite3ExprCodeIN_oom_error;
3407d49fd4e8Sdan     if( sqlite3ExprCanBeNull(p) ){
3408e347d3e8Sdrh       sqlite3VdbeAddOp2(v, OP_IsNull, rLhs+i, destStep2);
3409471b4b92Sdrh       VdbeCoverage(v);
3410d49fd4e8Sdan     }
3411d49fd4e8Sdan   }
3412e3365e6cSdrh 
3413e347d3e8Sdrh   /* Step 3.  The LHS is now known to be non-NULL.  Do the binary search
3414e347d3e8Sdrh   ** of the RHS using the LHS as a probe.  If found, the result is
3415e347d3e8Sdrh   ** true.
3416e347d3e8Sdrh   */
3417e3365e6cSdrh   if( eType==IN_INDEX_ROWID ){
3418e347d3e8Sdrh     /* In this case, the RHS is the ROWID of table b-tree and so we also
3419e347d3e8Sdrh     ** know that the RHS is non-NULL.  Hence, we combine steps 3 and 4
3420e347d3e8Sdrh     ** into a single opcode. */
34212c04131cSdrh     sqlite3VdbeAddOp3(v, OP_SeekRowid, iTab, destIfFalse, rLhs);
3422688852abSdrh     VdbeCoverage(v);
3423e347d3e8Sdrh     addrTruthOp = sqlite3VdbeAddOp0(v, OP_Goto);  /* Return True */
34247b35a77bSdan   }else{
3425e347d3e8Sdrh     sqlite3VdbeAddOp4(v, OP_Affinity, rLhs, nVector, 0, zAff, nVector);
3426e347d3e8Sdrh     if( destIfFalse==destIfNull ){
3427e347d3e8Sdrh       /* Combine Step 3 and Step 5 into a single opcode */
34282c04131cSdrh       sqlite3VdbeAddOp4Int(v, OP_NotFound, iTab, destIfFalse,
3429e347d3e8Sdrh                            rLhs, nVector); VdbeCoverage(v);
3430e347d3e8Sdrh       goto sqlite3ExprCodeIN_finished;
3431e347d3e8Sdrh     }
3432e347d3e8Sdrh     /* Ordinary Step 3, for the case where FALSE and NULL are distinct */
34332c04131cSdrh     addrTruthOp = sqlite3VdbeAddOp4Int(v, OP_Found, iTab, 0,
3434e347d3e8Sdrh                                       rLhs, nVector); VdbeCoverage(v);
3435e347d3e8Sdrh   }
3436ba00e30aSdan 
3437e347d3e8Sdrh   /* Step 4.  If the RHS is known to be non-NULL and we did not find
3438e347d3e8Sdrh   ** an match on the search above, then the result must be FALSE.
3439e347d3e8Sdrh   */
3440e347d3e8Sdrh   if( rRhsHasNull && nVector==1 ){
3441e347d3e8Sdrh     sqlite3VdbeAddOp2(v, OP_NotNull, rRhsHasNull, destIfFalse);
3442471b4b92Sdrh     VdbeCoverage(v);
3443e347d3e8Sdrh   }
34447b35a77bSdan 
3445e347d3e8Sdrh   /* Step 5.  If we do not care about the difference between NULL and
3446e347d3e8Sdrh   ** FALSE, then just return false.
3447e347d3e8Sdrh   */
3448e347d3e8Sdrh   if( destIfFalse==destIfNull ) sqlite3VdbeGoto(v, destIfFalse);
3449e347d3e8Sdrh 
3450e347d3e8Sdrh   /* Step 6: Loop through rows of the RHS.  Compare each row to the LHS.
3451e347d3e8Sdrh   ** If any comparison is NULL, then the result is NULL.  If all
3452e347d3e8Sdrh   ** comparisons are FALSE then the final result is FALSE.
3453e347d3e8Sdrh   **
3454e347d3e8Sdrh   ** For a scalar LHS, it is sufficient to check just the first row
3455e347d3e8Sdrh   ** of the RHS.
3456e347d3e8Sdrh   */
3457e347d3e8Sdrh   if( destStep6 ) sqlite3VdbeResolveLabel(v, destStep6);
34582c04131cSdrh   addrTop = sqlite3VdbeAddOp2(v, OP_Rewind, iTab, destIfFalse);
3459471b4b92Sdrh   VdbeCoverage(v);
3460e347d3e8Sdrh   if( nVector>1 ){
3461ec4ccdbcSdrh     destNotNull = sqlite3VdbeMakeLabel(pParse);
3462e347d3e8Sdrh   }else{
3463e347d3e8Sdrh     /* For nVector==1, combine steps 6 and 7 by immediately returning
3464e347d3e8Sdrh     ** FALSE if the first comparison is not NULL */
3465e347d3e8Sdrh     destNotNull = destIfFalse;
3466e347d3e8Sdrh   }
3467ba00e30aSdan   for(i=0; i<nVector; i++){
3468ba00e30aSdan     Expr *p;
3469ba00e30aSdan     CollSeq *pColl;
3470e347d3e8Sdrh     int r3 = sqlite3GetTempReg(pParse);
3471fc7f27b9Sdrh     p = sqlite3VectorFieldSubexpr(pLeft, i);
3472ba00e30aSdan     pColl = sqlite3ExprCollSeq(pParse, p);
34732c04131cSdrh     sqlite3VdbeAddOp3(v, OP_Column, iTab, i, r3);
3474e347d3e8Sdrh     sqlite3VdbeAddOp4(v, OP_Ne, rLhs+i, destNotNull, r3,
347518016ad2Sdrh                       (void*)pColl, P4_COLLSEQ);
3476471b4b92Sdrh     VdbeCoverage(v);
3477e347d3e8Sdrh     sqlite3ReleaseTempReg(pParse, r3);
34787b35a77bSdan   }
34797b35a77bSdan   sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfNull);
3480e347d3e8Sdrh   if( nVector>1 ){
3481e347d3e8Sdrh     sqlite3VdbeResolveLabel(v, destNotNull);
34822c04131cSdrh     sqlite3VdbeAddOp2(v, OP_Next, iTab, addrTop+1);
348318016ad2Sdrh     VdbeCoverage(v);
3484e347d3e8Sdrh 
3485e347d3e8Sdrh     /* Step 7:  If we reach this point, we know that the result must
3486e347d3e8Sdrh     ** be false. */
348718016ad2Sdrh     sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfFalse);
34887b35a77bSdan   }
34897b35a77bSdan 
3490e347d3e8Sdrh   /* Jumps here in order to return true. */
3491e347d3e8Sdrh   sqlite3VdbeJumpHere(v, addrTruthOp);
3492e3365e6cSdrh 
3493e347d3e8Sdrh sqlite3ExprCodeIN_finished:
3494e347d3e8Sdrh   if( rLhs!=rLhsOrig ) sqlite3ReleaseTempReg(pParse, rLhs);
3495ecb87ac8Sdrh   VdbeComment((v, "end IN expr"));
3496e347d3e8Sdrh sqlite3ExprCodeIN_oom_error:
3497ba00e30aSdan   sqlite3DbFree(pParse->db, aiMap);
3498553168c7Sdan   sqlite3DbFree(pParse->db, zAff);
3499e3365e6cSdrh }
3500e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
3501e3365e6cSdrh 
350213573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
3503598f1340Sdrh /*
3504598f1340Sdrh ** Generate an instruction that will put the floating point
35059cbf3425Sdrh ** value described by z[0..n-1] into register iMem.
35060cf19ed8Sdrh **
35070cf19ed8Sdrh ** The z[] string will probably not be zero-terminated.  But the
35080cf19ed8Sdrh ** z[n] character is guaranteed to be something that does not look
35090cf19ed8Sdrh ** like the continuation of the number.
3510598f1340Sdrh */
3511b7916a78Sdrh static void codeReal(Vdbe *v, const char *z, int negateFlag, int iMem){
3512fd773cf9Sdrh   if( ALWAYS(z!=0) ){
3513598f1340Sdrh     double value;
35149339da1fSdrh     sqlite3AtoF(z, &value, sqlite3Strlen30(z), SQLITE_UTF8);
3515d0015161Sdrh     assert( !sqlite3IsNaN(value) ); /* The new AtoF never returns NaN */
3516598f1340Sdrh     if( negateFlag ) value = -value;
351797bae794Sdrh     sqlite3VdbeAddOp4Dup8(v, OP_Real, 0, iMem, 0, (u8*)&value, P4_REAL);
3518598f1340Sdrh   }
3519598f1340Sdrh }
352013573c71Sdrh #endif
3521598f1340Sdrh 
3522598f1340Sdrh 
3523598f1340Sdrh /*
3524fec19aadSdrh ** Generate an instruction that will put the integer describe by
35259cbf3425Sdrh ** text z[0..n-1] into register iMem.
35260cf19ed8Sdrh **
35275f1d6b61Sshaneh ** Expr.u.zToken is always UTF8 and zero-terminated.
3528fec19aadSdrh */
352913573c71Sdrh static void codeInteger(Parse *pParse, Expr *pExpr, int negFlag, int iMem){
353013573c71Sdrh   Vdbe *v = pParse->pVdbe;
353192b01d53Sdrh   if( pExpr->flags & EP_IntValue ){
353233e619fcSdrh     int i = pExpr->u.iValue;
3533d50ffc41Sdrh     assert( i>=0 );
353492b01d53Sdrh     if( negFlag ) i = -i;
353592b01d53Sdrh     sqlite3VdbeAddOp2(v, OP_Integer, i, iMem);
3536fd773cf9Sdrh   }else{
35375f1d6b61Sshaneh     int c;
35385f1d6b61Sshaneh     i64 value;
3539fd773cf9Sdrh     const char *z = pExpr->u.zToken;
3540fd773cf9Sdrh     assert( z!=0 );
35419296c18aSdrh     c = sqlite3DecOrHexToI64(z, &value);
354284d4f1a3Sdrh     if( (c==3 && !negFlag) || (c==2) || (negFlag && value==SMALLEST_INT64)){
354313573c71Sdrh #ifdef SQLITE_OMIT_FLOATING_POINT
354413573c71Sdrh       sqlite3ErrorMsg(pParse, "oversized integer: %s%s", negFlag ? "-" : "", z);
354513573c71Sdrh #else
35461b7ddc59Sdrh #ifndef SQLITE_OMIT_HEX_INTEGER
35479296c18aSdrh       if( sqlite3_strnicmp(z,"0x",2)==0 ){
354877320ea4Sdrh         sqlite3ErrorMsg(pParse, "hex literal too big: %s%s", negFlag?"-":"",z);
35491b7ddc59Sdrh       }else
35501b7ddc59Sdrh #endif
35511b7ddc59Sdrh       {
3552b7916a78Sdrh         codeReal(v, z, negFlag, iMem);
35539296c18aSdrh       }
355413573c71Sdrh #endif
355577320ea4Sdrh     }else{
355684d4f1a3Sdrh       if( negFlag ){ value = c==3 ? SMALLEST_INT64 : -value; }
355777320ea4Sdrh       sqlite3VdbeAddOp4Dup8(v, OP_Int64, 0, iMem, 0, (u8*)&value, P4_INT64);
3558fec19aadSdrh     }
3559fec19aadSdrh   }
3560c9cf901dSdanielk1977 }
3561fec19aadSdrh 
35625cd79239Sdrh 
35631f9ca2c8Sdrh /* Generate code that will load into register regOut a value that is
35641f9ca2c8Sdrh ** appropriate for the iIdxCol-th column of index pIdx.
35651f9ca2c8Sdrh */
35661f9ca2c8Sdrh void sqlite3ExprCodeLoadIndexColumn(
35671f9ca2c8Sdrh   Parse *pParse,  /* The parsing context */
35681f9ca2c8Sdrh   Index *pIdx,    /* The index whose column is to be loaded */
35691f9ca2c8Sdrh   int iTabCur,    /* Cursor pointing to a table row */
35701f9ca2c8Sdrh   int iIdxCol,    /* The column of the index to be loaded */
35711f9ca2c8Sdrh   int regOut      /* Store the index column value in this register */
35721f9ca2c8Sdrh ){
35731f9ca2c8Sdrh   i16 iTabCol = pIdx->aiColumn[iIdxCol];
35744b92f98cSdrh   if( iTabCol==XN_EXPR ){
35751f9ca2c8Sdrh     assert( pIdx->aColExpr );
35761f9ca2c8Sdrh     assert( pIdx->aColExpr->nExpr>iIdxCol );
35773e34eabcSdrh     pParse->iSelfTab = iTabCur + 1;
35781c75c9d7Sdrh     sqlite3ExprCodeCopy(pParse, pIdx->aColExpr->a[iIdxCol].pExpr, regOut);
35793e34eabcSdrh     pParse->iSelfTab = 0;
35804b92f98cSdrh   }else{
35816df9c4b9Sdrh     sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pIdx->pTable, iTabCur,
35824b92f98cSdrh                                     iTabCol, regOut);
35834b92f98cSdrh   }
35841f9ca2c8Sdrh }
35851f9ca2c8Sdrh 
3586e70fa7feSdrh #ifndef SQLITE_OMIT_GENERATED_COLUMNS
3587e70fa7feSdrh /*
3588e70fa7feSdrh ** Generate code that will compute the value of generated column pCol
3589e70fa7feSdrh ** and store the result in register regOut
3590e70fa7feSdrh */
3591e70fa7feSdrh void sqlite3ExprCodeGeneratedColumn(
3592e70fa7feSdrh   Parse *pParse,
3593e70fa7feSdrh   Column *pCol,
3594e70fa7feSdrh   int regOut
3595e70fa7feSdrh ){
35964dad7ed5Sdrh   int iAddr;
35974dad7ed5Sdrh   Vdbe *v = pParse->pVdbe;
35984dad7ed5Sdrh   assert( v!=0 );
35994dad7ed5Sdrh   assert( pParse->iSelfTab!=0 );
36004dad7ed5Sdrh   if( pParse->iSelfTab>0 ){
36014dad7ed5Sdrh     iAddr = sqlite3VdbeAddOp3(v, OP_IfNullRow, pParse->iSelfTab-1, 0, regOut);
36024dad7ed5Sdrh   }else{
36034dad7ed5Sdrh     iAddr = 0;
36044dad7ed5Sdrh   }
360524e39903Sdrh   sqlite3ExprCodeCopy(pParse, pCol->pDflt, regOut);
3606e70fa7feSdrh   if( pCol->affinity>=SQLITE_AFF_TEXT ){
36074dad7ed5Sdrh     sqlite3VdbeAddOp4(v, OP_Affinity, regOut, 1, 0, &pCol->affinity, 1);
3608e70fa7feSdrh   }
36094dad7ed5Sdrh   if( iAddr ) sqlite3VdbeJumpHere(v, iAddr);
3610e70fa7feSdrh }
3611e70fa7feSdrh #endif /* SQLITE_OMIT_GENERATED_COLUMNS */
3612e70fa7feSdrh 
36135cd79239Sdrh /*
36145c092e8aSdrh ** Generate code to extract the value of the iCol-th column of a table.
36155c092e8aSdrh */
36165c092e8aSdrh void sqlite3ExprCodeGetColumnOfTable(
36176df9c4b9Sdrh   Vdbe *v,        /* Parsing context */
36185c092e8aSdrh   Table *pTab,    /* The table containing the value */
3619313619f5Sdrh   int iTabCur,    /* The table cursor.  Or the PK cursor for WITHOUT ROWID */
36205c092e8aSdrh   int iCol,       /* Index of the column to extract */
3621313619f5Sdrh   int regOut      /* Extract the value into this register */
36225c092e8aSdrh ){
3623ab45fc04Sdrh   Column *pCol;
362481f7b372Sdrh   assert( v!=0 );
3625aca19e19Sdrh   if( pTab==0 ){
3626aca19e19Sdrh     sqlite3VdbeAddOp3(v, OP_Column, iTabCur, iCol, regOut);
3627aca19e19Sdrh     return;
3628aca19e19Sdrh   }
36295c092e8aSdrh   if( iCol<0 || iCol==pTab->iPKey ){
36305c092e8aSdrh     sqlite3VdbeAddOp2(v, OP_Rowid, iTabCur, regOut);
36315c092e8aSdrh   }else{
363281f7b372Sdrh     int op;
363381f7b372Sdrh     int x;
363481f7b372Sdrh     if( IsVirtual(pTab) ){
363581f7b372Sdrh       op = OP_VColumn;
363681f7b372Sdrh       x = iCol;
363781f7b372Sdrh #ifndef SQLITE_OMIT_GENERATED_COLUMNS
3638ab45fc04Sdrh     }else if( (pCol = &pTab->aCol[iCol])->colFlags & COLFLAG_VIRTUAL ){
36396df9c4b9Sdrh       Parse *pParse = sqlite3VdbeParser(v);
3640ab45fc04Sdrh       if( pCol->colFlags & COLFLAG_BUSY ){
3641ab45fc04Sdrh         sqlite3ErrorMsg(pParse, "generated column loop on \"%s\"", pCol->zName);
3642ab45fc04Sdrh       }else{
364381f7b372Sdrh         int savedSelfTab = pParse->iSelfTab;
3644ab45fc04Sdrh         pCol->colFlags |= COLFLAG_BUSY;
364581f7b372Sdrh         pParse->iSelfTab = iTabCur+1;
3646e70fa7feSdrh         sqlite3ExprCodeGeneratedColumn(pParse, pCol, regOut);
364781f7b372Sdrh         pParse->iSelfTab = savedSelfTab;
3648ab45fc04Sdrh         pCol->colFlags &= ~COLFLAG_BUSY;
3649ab45fc04Sdrh       }
365081f7b372Sdrh       return;
365181f7b372Sdrh #endif
365281f7b372Sdrh     }else if( !HasRowid(pTab) ){
3653c5f808d8Sdrh       testcase( iCol!=sqlite3TableColumnToStorage(pTab, iCol) );
3654b9bcf7caSdrh       x = sqlite3TableColumnToIndex(sqlite3PrimaryKeyIndex(pTab), iCol);
365581f7b372Sdrh       op = OP_Column;
365681f7b372Sdrh     }else{
3657b9bcf7caSdrh       x = sqlite3TableColumnToStorage(pTab,iCol);
3658c5f808d8Sdrh       testcase( x!=iCol );
365981f7b372Sdrh       op = OP_Column;
3660ee0ec8e1Sdrh     }
3661ee0ec8e1Sdrh     sqlite3VdbeAddOp3(v, op, iTabCur, x, regOut);
36625c092e8aSdrh     sqlite3ColumnDefault(v, pTab, iCol, regOut);
36635c092e8aSdrh   }
36645c092e8aSdrh }
36655c092e8aSdrh 
36665c092e8aSdrh /*
3667945498f3Sdrh ** Generate code that will extract the iColumn-th column from
36688c607191Sdrh ** table pTab and store the column value in register iReg.
3669e55cbd72Sdrh **
3670e55cbd72Sdrh ** There must be an open cursor to pTab in iTable when this routine
3671e55cbd72Sdrh ** is called.  If iColumn<0 then code is generated that extracts the rowid.
3672945498f3Sdrh */
3673e55cbd72Sdrh int sqlite3ExprCodeGetColumn(
3674e55cbd72Sdrh   Parse *pParse,   /* Parsing and code generating context */
36752133d822Sdrh   Table *pTab,     /* Description of the table we are reading from */
36762133d822Sdrh   int iColumn,     /* Index of the table column */
36772133d822Sdrh   int iTable,      /* The cursor pointing to the table */
3678a748fdccSdrh   int iReg,        /* Store results here */
3679ce78bc6eSdrh   u8 p5            /* P5 value for OP_Column + FLAGS */
36802133d822Sdrh ){
368181f7b372Sdrh   assert( pParse->pVdbe!=0 );
36826df9c4b9Sdrh   sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pTab, iTable, iColumn, iReg);
3683a748fdccSdrh   if( p5 ){
368499670abbSdrh     VdbeOp *pOp = sqlite3VdbeGetOp(pParse->pVdbe,-1);
368599670abbSdrh     if( pOp->opcode==OP_Column ) pOp->p5 = p5;
3686a748fdccSdrh   }
3687e55cbd72Sdrh   return iReg;
3688e55cbd72Sdrh }
3689e55cbd72Sdrh 
3690e55cbd72Sdrh /*
3691b21e7c70Sdrh ** Generate code to move content from registers iFrom...iFrom+nReg-1
369236a5d88dSdrh ** over to iTo..iTo+nReg-1.
3693e55cbd72Sdrh */
3694b21e7c70Sdrh void sqlite3ExprCodeMove(Parse *pParse, int iFrom, int iTo, int nReg){
3695079a3072Sdrh   sqlite3VdbeAddOp3(pParse->pVdbe, OP_Move, iFrom, iTo, nReg);
3696945498f3Sdrh }
3697945498f3Sdrh 
3698652fbf55Sdrh /*
369912abf408Sdrh ** Convert a scalar expression node to a TK_REGISTER referencing
370012abf408Sdrh ** register iReg.  The caller must ensure that iReg already contains
370112abf408Sdrh ** the correct value for the expression.
3702a4c3c87eSdrh */
3703069d1b1fSdan static void exprToRegister(Expr *pExpr, int iReg){
37040d950af3Sdrh   Expr *p = sqlite3ExprSkipCollateAndLikely(pExpr);
3705235667a8Sdrh   if( NEVER(p==0) ) return;
3706a4c3c87eSdrh   p->op2 = p->op;
3707a4c3c87eSdrh   p->op = TK_REGISTER;
3708a4c3c87eSdrh   p->iTable = iReg;
3709a4c3c87eSdrh   ExprClearProperty(p, EP_Skip);
3710a4c3c87eSdrh }
3711a4c3c87eSdrh 
371212abf408Sdrh /*
371312abf408Sdrh ** Evaluate an expression (either a vector or a scalar expression) and store
371412abf408Sdrh ** the result in continguous temporary registers.  Return the index of
371512abf408Sdrh ** the first register used to store the result.
371612abf408Sdrh **
371712abf408Sdrh ** If the returned result register is a temporary scalar, then also write
371812abf408Sdrh ** that register number into *piFreeable.  If the returned result register
371912abf408Sdrh ** is not a temporary or if the expression is a vector set *piFreeable
372012abf408Sdrh ** to 0.
372112abf408Sdrh */
372212abf408Sdrh static int exprCodeVector(Parse *pParse, Expr *p, int *piFreeable){
372312abf408Sdrh   int iResult;
372412abf408Sdrh   int nResult = sqlite3ExprVectorSize(p);
372512abf408Sdrh   if( nResult==1 ){
372612abf408Sdrh     iResult = sqlite3ExprCodeTemp(pParse, p, piFreeable);
372712abf408Sdrh   }else{
372812abf408Sdrh     *piFreeable = 0;
372912abf408Sdrh     if( p->op==TK_SELECT ){
3730dd1bb43aSdrh #if SQLITE_OMIT_SUBQUERY
3731dd1bb43aSdrh       iResult = 0;
3732dd1bb43aSdrh #else
373385bcdce2Sdrh       iResult = sqlite3CodeSubselect(pParse, p);
3734dd1bb43aSdrh #endif
373512abf408Sdrh     }else{
373612abf408Sdrh       int i;
373712abf408Sdrh       iResult = pParse->nMem+1;
373812abf408Sdrh       pParse->nMem += nResult;
373912abf408Sdrh       for(i=0; i<nResult; i++){
37404b725240Sdan         sqlite3ExprCodeFactorable(pParse, p->x.pList->a[i].pExpr, i+iResult);
374112abf408Sdrh       }
374212abf408Sdrh     }
374312abf408Sdrh   }
374412abf408Sdrh   return iResult;
374512abf408Sdrh }
374612abf408Sdrh 
374725c4296bSdrh /*
374892a27f7bSdrh ** If the last opcode is a OP_Copy, then set the do-not-merge flag (p5)
374992a27f7bSdrh ** so that a subsequent copy will not be merged into this one.
375092a27f7bSdrh */
375192a27f7bSdrh static void setDoNotMergeFlagOnCopy(Vdbe *v){
375292a27f7bSdrh   if( sqlite3VdbeGetOp(v, -1)->opcode==OP_Copy ){
375392a27f7bSdrh     sqlite3VdbeChangeP5(v, 1);  /* Tag trailing OP_Copy as not mergable */
375492a27f7bSdrh   }
375592a27f7bSdrh }
375692a27f7bSdrh 
375792a27f7bSdrh /*
375825c4296bSdrh ** Generate code to implement special SQL functions that are implemented
375925c4296bSdrh ** in-line rather than by using the usual callbacks.
376025c4296bSdrh */
376125c4296bSdrh static int exprCodeInlineFunction(
376225c4296bSdrh   Parse *pParse,        /* Parsing context */
376325c4296bSdrh   ExprList *pFarg,      /* List of function arguments */
376425c4296bSdrh   int iFuncId,          /* Function ID.  One of the INTFUNC_... values */
376525c4296bSdrh   int target            /* Store function result in this register */
376625c4296bSdrh ){
376725c4296bSdrh   int nFarg;
376825c4296bSdrh   Vdbe *v = pParse->pVdbe;
376925c4296bSdrh   assert( v!=0 );
377025c4296bSdrh   assert( pFarg!=0 );
377125c4296bSdrh   nFarg = pFarg->nExpr;
377225c4296bSdrh   assert( nFarg>0 );  /* All in-line functions have at least one argument */
377325c4296bSdrh   switch( iFuncId ){
377425c4296bSdrh     case INLINEFUNC_coalesce: {
377525c4296bSdrh       /* Attempt a direct implementation of the built-in COALESCE() and
377625c4296bSdrh       ** IFNULL() functions.  This avoids unnecessary evaluation of
377725c4296bSdrh       ** arguments past the first non-NULL argument.
377825c4296bSdrh       */
377925c4296bSdrh       int endCoalesce = sqlite3VdbeMakeLabel(pParse);
378025c4296bSdrh       int i;
378125c4296bSdrh       assert( nFarg>=2 );
378225c4296bSdrh       sqlite3ExprCode(pParse, pFarg->a[0].pExpr, target);
378325c4296bSdrh       for(i=1; i<nFarg; i++){
378425c4296bSdrh         sqlite3VdbeAddOp2(v, OP_NotNull, target, endCoalesce);
378525c4296bSdrh         VdbeCoverage(v);
378625c4296bSdrh         sqlite3ExprCode(pParse, pFarg->a[i].pExpr, target);
378725c4296bSdrh       }
378892a27f7bSdrh       setDoNotMergeFlagOnCopy(v);
378925c4296bSdrh       sqlite3VdbeResolveLabel(v, endCoalesce);
379025c4296bSdrh       break;
379125c4296bSdrh     }
37923c0e606bSdrh     case INLINEFUNC_iif: {
37933c0e606bSdrh       Expr caseExpr;
37943c0e606bSdrh       memset(&caseExpr, 0, sizeof(caseExpr));
37953c0e606bSdrh       caseExpr.op = TK_CASE;
37963c0e606bSdrh       caseExpr.x.pList = pFarg;
37973c0e606bSdrh       return sqlite3ExprCodeTarget(pParse, &caseExpr, target);
37983c0e606bSdrh     }
379925c4296bSdrh 
3800171c50ecSdrh     default: {
380125c4296bSdrh       /* The UNLIKELY() function is a no-op.  The result is the value
380225c4296bSdrh       ** of the first argument.
380325c4296bSdrh       */
3804171c50ecSdrh       assert( nFarg==1 || nFarg==2 );
380525c4296bSdrh       target = sqlite3ExprCodeTarget(pParse, pFarg->a[0].pExpr, target);
380625c4296bSdrh       break;
380725c4296bSdrh     }
380825c4296bSdrh 
3809171c50ecSdrh   /***********************************************************************
3810171c50ecSdrh   ** Test-only SQL functions that are only usable if enabled
3811171c50ecSdrh   ** via SQLITE_TESTCTRL_INTERNAL_FUNCTIONS
3812171c50ecSdrh   */
3813171c50ecSdrh     case INLINEFUNC_expr_compare: {
3814171c50ecSdrh       /* Compare two expressions using sqlite3ExprCompare() */
3815171c50ecSdrh       assert( nFarg==2 );
3816171c50ecSdrh       sqlite3VdbeAddOp2(v, OP_Integer,
3817171c50ecSdrh          sqlite3ExprCompare(0,pFarg->a[0].pExpr, pFarg->a[1].pExpr,-1),
3818171c50ecSdrh          target);
3819171c50ecSdrh       break;
3820171c50ecSdrh     }
3821171c50ecSdrh 
3822171c50ecSdrh     case INLINEFUNC_expr_implies_expr: {
3823171c50ecSdrh       /* Compare two expressions using sqlite3ExprImpliesExpr() */
3824171c50ecSdrh       assert( nFarg==2 );
3825171c50ecSdrh       sqlite3VdbeAddOp2(v, OP_Integer,
3826171c50ecSdrh          sqlite3ExprImpliesExpr(pParse,pFarg->a[0].pExpr, pFarg->a[1].pExpr,-1),
3827171c50ecSdrh          target);
3828171c50ecSdrh       break;
3829171c50ecSdrh     }
3830171c50ecSdrh 
3831171c50ecSdrh     case INLINEFUNC_implies_nonnull_row: {
3832171c50ecSdrh       /* REsult of sqlite3ExprImpliesNonNullRow() */
3833171c50ecSdrh       Expr *pA1;
3834171c50ecSdrh       assert( nFarg==2 );
3835171c50ecSdrh       pA1 = pFarg->a[1].pExpr;
3836171c50ecSdrh       if( pA1->op==TK_COLUMN ){
3837171c50ecSdrh         sqlite3VdbeAddOp2(v, OP_Integer,
3838171c50ecSdrh            sqlite3ExprImpliesNonNullRow(pFarg->a[0].pExpr,pA1->iTable),
3839171c50ecSdrh            target);
3840171c50ecSdrh       }else{
3841171c50ecSdrh         sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3842171c50ecSdrh       }
3843171c50ecSdrh       break;
3844171c50ecSdrh     }
3845171c50ecSdrh 
384625c4296bSdrh #ifdef SQLITE_DEBUG
384725c4296bSdrh     case INLINEFUNC_affinity: {
384825c4296bSdrh       /* The AFFINITY() function evaluates to a string that describes
384925c4296bSdrh       ** the type affinity of the argument.  This is used for testing of
385025c4296bSdrh       ** the SQLite type logic.
385125c4296bSdrh       */
385225c4296bSdrh       const char *azAff[] = { "blob", "text", "numeric", "integer", "real" };
385325c4296bSdrh       char aff;
385425c4296bSdrh       assert( nFarg==1 );
385525c4296bSdrh       aff = sqlite3ExprAffinity(pFarg->a[0].pExpr);
385625c4296bSdrh       sqlite3VdbeLoadString(v, target,
385725c4296bSdrh               (aff<=SQLITE_AFF_NONE) ? "none" : azAff[aff-SQLITE_AFF_BLOB]);
385825c4296bSdrh       break;
385925c4296bSdrh     }
386025c4296bSdrh #endif
386125c4296bSdrh   }
386225c4296bSdrh   return target;
386325c4296bSdrh }
386425c4296bSdrh 
386571c57db0Sdan 
3866a4c3c87eSdrh /*
3867cce7d176Sdrh ** Generate code into the current Vdbe to evaluate the given
38682dcef11bSdrh ** expression.  Attempt to store the results in register "target".
38692dcef11bSdrh ** Return the register where results are stored.
3870389a1adbSdrh **
38718b213899Sdrh ** With this routine, there is no guarantee that results will
38722dcef11bSdrh ** be stored in target.  The result might be stored in some other
38732dcef11bSdrh ** register if it is convenient to do so.  The calling function
38742dcef11bSdrh ** must check the return code and move the results to the desired
38752dcef11bSdrh ** register.
3876cce7d176Sdrh */
3877678ccce8Sdrh int sqlite3ExprCodeTarget(Parse *pParse, Expr *pExpr, int target){
38782dcef11bSdrh   Vdbe *v = pParse->pVdbe;  /* The VM under construction */
38792dcef11bSdrh   int op;                   /* The opcode being coded */
38802dcef11bSdrh   int inReg = target;       /* Results stored in register inReg */
38812dcef11bSdrh   int regFree1 = 0;         /* If non-zero free this temporary register */
38822dcef11bSdrh   int regFree2 = 0;         /* If non-zero free this temporary register */
38837b35a77bSdan   int r1, r2;               /* Various register numbers */
388410d1edf0Sdrh   Expr tempX;               /* Temporary expression node */
388571c57db0Sdan   int p5 = 0;
3886ffe07b2dSdrh 
38879cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
3888b639a209Sdrh   assert( v!=0 );
3889389a1adbSdrh 
38901efa8023Sdrh expr_code_doover:
3891389a1adbSdrh   if( pExpr==0 ){
3892389a1adbSdrh     op = TK_NULL;
3893389a1adbSdrh   }else{
3894e7375bfaSdrh     assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
3895f2bc013cSdrh     op = pExpr->op;
3896389a1adbSdrh   }
3897f2bc013cSdrh   switch( op ){
389813449892Sdrh     case TK_AGG_COLUMN: {
389913449892Sdrh       AggInfo *pAggInfo = pExpr->pAggInfo;
39000934d640Sdrh       struct AggInfo_col *pCol;
39010934d640Sdrh       assert( pAggInfo!=0 );
39020934d640Sdrh       assert( pExpr->iAgg>=0 && pExpr->iAgg<pAggInfo->nColumn );
39030934d640Sdrh       pCol = &pAggInfo->aCol[pExpr->iAgg];
390413449892Sdrh       if( !pAggInfo->directMode ){
39059de221dfSdrh         assert( pCol->iMem>0 );
3906c332cc30Sdrh         return pCol->iMem;
390713449892Sdrh       }else if( pAggInfo->useSortingIdx ){
39080c76e892Sdrh         Table *pTab = pCol->pTab;
39095134d135Sdan         sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdxPTab,
3910389a1adbSdrh                               pCol->iSorterColumn, target);
39118d5cea6bSdrh         if( pCol->iColumn<0 ){
39128d5cea6bSdrh           VdbeComment((v,"%s.rowid",pTab->zName));
39138d5cea6bSdrh         }else{
39148d5cea6bSdrh           VdbeComment((v,"%s.%s",pTab->zName,pTab->aCol[pCol->iColumn].zName));
39158d5cea6bSdrh           if( pTab->aCol[pCol->iColumn].affinity==SQLITE_AFF_REAL ){
39168d5cea6bSdrh             sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
39178d5cea6bSdrh           }
39180c76e892Sdrh         }
3919c332cc30Sdrh         return target;
392013449892Sdrh       }
392113449892Sdrh       /* Otherwise, fall thru into the TK_COLUMN case */
392208b92086Sdrh       /* no break */ deliberate_fall_through
392313449892Sdrh     }
3924967e8b73Sdrh     case TK_COLUMN: {
3925b2b9d3d7Sdrh       int iTab = pExpr->iTable;
392667b9ba17Sdrh       int iReg;
3927efad2e23Sdrh       if( ExprHasProperty(pExpr, EP_FixedCol) ){
3928d98f5324Sdrh         /* This COLUMN expression is really a constant due to WHERE clause
3929d98f5324Sdrh         ** constraints, and that constant is coded by the pExpr->pLeft
3930d98f5324Sdrh         ** expresssion.  However, make sure the constant has the correct
3931d98f5324Sdrh         ** datatype by applying the Affinity of the table column to the
3932d98f5324Sdrh         ** constant.
3933d98f5324Sdrh         */
393457f7ece7Sdrh         int aff;
393567b9ba17Sdrh         iReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft,target);
393657f7ece7Sdrh         if( pExpr->y.pTab ){
393757f7ece7Sdrh           aff = sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
393857f7ece7Sdrh         }else{
393957f7ece7Sdrh           aff = pExpr->affExpr;
394057f7ece7Sdrh         }
394196fb16eeSdrh         if( aff>SQLITE_AFF_BLOB ){
3942d98f5324Sdrh           static const char zAff[] = "B\000C\000D\000E";
3943d98f5324Sdrh           assert( SQLITE_AFF_BLOB=='A' );
3944d98f5324Sdrh           assert( SQLITE_AFF_TEXT=='B' );
3945d98f5324Sdrh           sqlite3VdbeAddOp4(v, OP_Affinity, iReg, 1, 0,
3946d98f5324Sdrh                             &zAff[(aff-'B')*2], P4_STATIC);
3947d98f5324Sdrh         }
3948d98f5324Sdrh         return iReg;
3949efad2e23Sdrh       }
3950b2b9d3d7Sdrh       if( iTab<0 ){
39516e97f8ecSdrh         if( pParse->iSelfTab<0 ){
39529942ef0dSdrh           /* Other columns in the same row for CHECK constraints or
39539942ef0dSdrh           ** generated columns or for inserting into partial index.
39549942ef0dSdrh           ** The row is unpacked into registers beginning at
39559942ef0dSdrh           ** 0-(pParse->iSelfTab).  The rowid (if any) is in a register
39569942ef0dSdrh           ** immediately prior to the first column.
39579942ef0dSdrh           */
39589942ef0dSdrh           Column *pCol;
39599942ef0dSdrh           Table *pTab = pExpr->y.pTab;
39609942ef0dSdrh           int iSrc;
3961c5f808d8Sdrh           int iCol = pExpr->iColumn;
39629942ef0dSdrh           assert( pTab!=0 );
3963c5f808d8Sdrh           assert( iCol>=XN_ROWID );
3964b0cbcd0eSdrh           assert( iCol<pTab->nCol );
3965c5f808d8Sdrh           if( iCol<0 ){
39669942ef0dSdrh             return -1-pParse->iSelfTab;
39679942ef0dSdrh           }
3968c5f808d8Sdrh           pCol = pTab->aCol + iCol;
3969c5f808d8Sdrh           testcase( iCol!=sqlite3TableColumnToStorage(pTab,iCol) );
3970c5f808d8Sdrh           iSrc = sqlite3TableColumnToStorage(pTab, iCol) - pParse->iSelfTab;
39719942ef0dSdrh #ifndef SQLITE_OMIT_GENERATED_COLUMNS
39729942ef0dSdrh           if( pCol->colFlags & COLFLAG_GENERATED ){
39734e8e533bSdrh             if( pCol->colFlags & COLFLAG_BUSY ){
39744e8e533bSdrh               sqlite3ErrorMsg(pParse, "generated column loop on \"%s\"",
39754e8e533bSdrh                               pCol->zName);
39764e8e533bSdrh               return 0;
39774e8e533bSdrh             }
39784e8e533bSdrh             pCol->colFlags |= COLFLAG_BUSY;
39794e8e533bSdrh             if( pCol->colFlags & COLFLAG_NOTAVAIL ){
3980e70fa7feSdrh               sqlite3ExprCodeGeneratedColumn(pParse, pCol, iSrc);
39814e8e533bSdrh             }
39824e8e533bSdrh             pCol->colFlags &= ~(COLFLAG_BUSY|COLFLAG_NOTAVAIL);
3983dd6cc9b5Sdrh             return iSrc;
39849942ef0dSdrh           }else
39859942ef0dSdrh #endif /* SQLITE_OMIT_GENERATED_COLUMNS */
39869942ef0dSdrh           if( pCol->affinity==SQLITE_AFF_REAL ){
39879942ef0dSdrh             sqlite3VdbeAddOp2(v, OP_SCopy, iSrc, target);
3988bffdd636Sdrh             sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
3989bffdd636Sdrh             return target;
3990bffdd636Sdrh           }else{
39919942ef0dSdrh             return iSrc;
3992bffdd636Sdrh           }
3993c4a3c779Sdrh         }else{
39941f9ca2c8Sdrh           /* Coding an expression that is part of an index where column names
39951f9ca2c8Sdrh           ** in the index refer to the table to which the index belongs */
39963e34eabcSdrh           iTab = pParse->iSelfTab - 1;
39972282792aSdrh         }
3998b2b9d3d7Sdrh       }
399967b9ba17Sdrh       iReg = sqlite3ExprCodeGetColumn(pParse, pExpr->y.pTab,
4000b2b9d3d7Sdrh                                pExpr->iColumn, iTab, target,
4001b2b9d3d7Sdrh                                pExpr->op2);
400267b9ba17Sdrh       if( pExpr->y.pTab==0 && pExpr->affExpr==SQLITE_AFF_REAL ){
400367b9ba17Sdrh         sqlite3VdbeAddOp1(v, OP_RealAffinity, iReg);
400467b9ba17Sdrh       }
400567b9ba17Sdrh       return iReg;
4006cce7d176Sdrh     }
4007cce7d176Sdrh     case TK_INTEGER: {
400813573c71Sdrh       codeInteger(pParse, pExpr, 0, target);
4009c332cc30Sdrh       return target;
401051e9a445Sdrh     }
40118abed7b9Sdrh     case TK_TRUEFALSE: {
401296acafbeSdrh       sqlite3VdbeAddOp2(v, OP_Integer, sqlite3ExprTruthValue(pExpr), target);
4013007c843bSdrh       return target;
4014007c843bSdrh     }
401513573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
4016598f1340Sdrh     case TK_FLOAT: {
401733e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
401833e619fcSdrh       codeReal(v, pExpr->u.zToken, 0, target);
4019c332cc30Sdrh       return target;
4020598f1340Sdrh     }
402113573c71Sdrh #endif
4022fec19aadSdrh     case TK_STRING: {
402333e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
4024076e85f5Sdrh       sqlite3VdbeLoadString(v, target, pExpr->u.zToken);
4025c332cc30Sdrh       return target;
4026cce7d176Sdrh     }
4027aac30f9bSdrh     default: {
4028c29af653Sdrh       /* Make NULL the default case so that if a bug causes an illegal
4029c29af653Sdrh       ** Expr node to be passed into this function, it will be handled
40309524a7eaSdrh       ** sanely and not crash.  But keep the assert() to bring the problem
40319524a7eaSdrh       ** to the attention of the developers. */
403205428127Sdrh       assert( op==TK_NULL || op==TK_ERROR || pParse->db->mallocFailed );
40339de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
4034c332cc30Sdrh       return target;
4035f0863fe5Sdrh     }
40365338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_BLOB_LITERAL
4037c572ef7fSdanielk1977     case TK_BLOB: {
40386c8c6cecSdrh       int n;
40396c8c6cecSdrh       const char *z;
4040ca48c90fSdrh       char *zBlob;
404133e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
404233e619fcSdrh       assert( pExpr->u.zToken[0]=='x' || pExpr->u.zToken[0]=='X' );
404333e619fcSdrh       assert( pExpr->u.zToken[1]=='\'' );
404433e619fcSdrh       z = &pExpr->u.zToken[2];
4045b7916a78Sdrh       n = sqlite3Strlen30(z) - 1;
4046b7916a78Sdrh       assert( z[n]=='\'' );
4047ca48c90fSdrh       zBlob = sqlite3HexToBlob(sqlite3VdbeDb(v), z, n);
4048ca48c90fSdrh       sqlite3VdbeAddOp4(v, OP_Blob, n/2, target, 0, zBlob, P4_DYNAMIC);
4049c332cc30Sdrh       return target;
4050c572ef7fSdanielk1977     }
40515338a5f7Sdanielk1977 #endif
405250457896Sdrh     case TK_VARIABLE: {
405333e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
405433e619fcSdrh       assert( pExpr->u.zToken!=0 );
405533e619fcSdrh       assert( pExpr->u.zToken[0]!=0 );
4056eaf52d88Sdrh       sqlite3VdbeAddOp2(v, OP_Variable, pExpr->iColumn, target);
405733e619fcSdrh       if( pExpr->u.zToken[1]!=0 ){
40589bf755ccSdrh         const char *z = sqlite3VListNumToName(pParse->pVList, pExpr->iColumn);
40599524a7eaSdrh         assert( pExpr->u.zToken[0]=='?' || (z && !strcmp(pExpr->u.zToken, z)) );
4060ce1bbe51Sdrh         pParse->pVList[0] = 0; /* Indicate VList may no longer be enlarged */
40619bf755ccSdrh         sqlite3VdbeAppendP4(v, (char*)z, P4_STATIC);
40629bf755ccSdrh       }
4063c332cc30Sdrh       return target;
406450457896Sdrh     }
40654e0cff60Sdrh     case TK_REGISTER: {
4066c332cc30Sdrh       return pExpr->iTable;
40674e0cff60Sdrh     }
4068487e262fSdrh #ifndef SQLITE_OMIT_CAST
4069487e262fSdrh     case TK_CAST: {
4070487e262fSdrh       /* Expressions of the form:   CAST(pLeft AS token) */
40712dcef11bSdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
40721735fa88Sdrh       if( inReg!=target ){
40731735fa88Sdrh         sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
40741735fa88Sdrh         inReg = target;
40751735fa88Sdrh       }
40764169e430Sdrh       sqlite3VdbeAddOp2(v, OP_Cast, target,
40774169e430Sdrh                         sqlite3AffinityType(pExpr->u.zToken, 0));
4078c332cc30Sdrh       return inReg;
4079487e262fSdrh     }
4080487e262fSdrh #endif /* SQLITE_OMIT_CAST */
408171c57db0Sdan     case TK_IS:
408271c57db0Sdan     case TK_ISNOT:
408371c57db0Sdan       op = (op==TK_IS) ? TK_EQ : TK_NE;
408471c57db0Sdan       p5 = SQLITE_NULLEQ;
408571c57db0Sdan       /* fall-through */
4086c9b84a1fSdrh     case TK_LT:
4087c9b84a1fSdrh     case TK_LE:
4088c9b84a1fSdrh     case TK_GT:
4089c9b84a1fSdrh     case TK_GE:
4090c9b84a1fSdrh     case TK_NE:
4091c9b84a1fSdrh     case TK_EQ: {
409271c57db0Sdan       Expr *pLeft = pExpr->pLeft;
4093625015e0Sdan       if( sqlite3ExprIsVector(pLeft) ){
409479752b6eSdrh         codeVectorCompare(pParse, pExpr, target, op, p5);
409571c57db0Sdan       }else{
409671c57db0Sdan         r1 = sqlite3ExprCodeTemp(pParse, pLeft, &regFree1);
4097b6da74ebSdrh         r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
4098871e7ff4Sdrh         sqlite3VdbeAddOp2(v, OP_Integer, 1, inReg);
4099871e7ff4Sdrh         codeCompare(pParse, pLeft, pExpr->pRight, op, r1, r2,
4100871e7ff4Sdrh             sqlite3VdbeCurrentAddr(v)+2, p5,
4101898c527eSdrh             ExprHasProperty(pExpr,EP_Commuted));
41027d176105Sdrh         assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
41037d176105Sdrh         assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
41047d176105Sdrh         assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
41057d176105Sdrh         assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
41067d176105Sdrh         assert(TK_EQ==OP_Eq); testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
41077d176105Sdrh         assert(TK_NE==OP_Ne); testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
4108529df929Sdrh         if( p5==SQLITE_NULLEQ ){
4109529df929Sdrh           sqlite3VdbeAddOp2(v, OP_Integer, 0, inReg);
4110529df929Sdrh         }else{
4111529df929Sdrh           sqlite3VdbeAddOp3(v, OP_ZeroOrNull, r1, inReg, r2);
4112529df929Sdrh         }
4113c5499befSdrh         testcase( regFree1==0 );
4114c5499befSdrh         testcase( regFree2==0 );
4115c9b84a1fSdrh       }
41166a2fe093Sdrh       break;
41176a2fe093Sdrh     }
4118cce7d176Sdrh     case TK_AND:
4119cce7d176Sdrh     case TK_OR:
4120cce7d176Sdrh     case TK_PLUS:
4121cce7d176Sdrh     case TK_STAR:
4122cce7d176Sdrh     case TK_MINUS:
4123bf4133cbSdrh     case TK_REM:
4124bf4133cbSdrh     case TK_BITAND:
4125bf4133cbSdrh     case TK_BITOR:
412617c40294Sdrh     case TK_SLASH:
4127bf4133cbSdrh     case TK_LSHIFT:
4128855eb1cfSdrh     case TK_RSHIFT:
41290040077dSdrh     case TK_CONCAT: {
41307d176105Sdrh       assert( TK_AND==OP_And );            testcase( op==TK_AND );
41317d176105Sdrh       assert( TK_OR==OP_Or );              testcase( op==TK_OR );
41327d176105Sdrh       assert( TK_PLUS==OP_Add );           testcase( op==TK_PLUS );
41337d176105Sdrh       assert( TK_MINUS==OP_Subtract );     testcase( op==TK_MINUS );
41347d176105Sdrh       assert( TK_REM==OP_Remainder );      testcase( op==TK_REM );
41357d176105Sdrh       assert( TK_BITAND==OP_BitAnd );      testcase( op==TK_BITAND );
41367d176105Sdrh       assert( TK_BITOR==OP_BitOr );        testcase( op==TK_BITOR );
41377d176105Sdrh       assert( TK_SLASH==OP_Divide );       testcase( op==TK_SLASH );
41387d176105Sdrh       assert( TK_LSHIFT==OP_ShiftLeft );   testcase( op==TK_LSHIFT );
41397d176105Sdrh       assert( TK_RSHIFT==OP_ShiftRight );  testcase( op==TK_RSHIFT );
41407d176105Sdrh       assert( TK_CONCAT==OP_Concat );      testcase( op==TK_CONCAT );
41412dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
41422dcef11bSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
41435b6afba9Sdrh       sqlite3VdbeAddOp3(v, op, r2, r1, target);
4144c5499befSdrh       testcase( regFree1==0 );
4145c5499befSdrh       testcase( regFree2==0 );
41460040077dSdrh       break;
41470040077dSdrh     }
4148cce7d176Sdrh     case TK_UMINUS: {
4149fec19aadSdrh       Expr *pLeft = pExpr->pLeft;
4150fec19aadSdrh       assert( pLeft );
415113573c71Sdrh       if( pLeft->op==TK_INTEGER ){
415213573c71Sdrh         codeInteger(pParse, pLeft, 1, target);
4153c332cc30Sdrh         return target;
415413573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
415513573c71Sdrh       }else if( pLeft->op==TK_FLOAT ){
415633e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
415733e619fcSdrh         codeReal(v, pLeft->u.zToken, 1, target);
4158c332cc30Sdrh         return target;
415913573c71Sdrh #endif
41603c84ddffSdrh       }else{
416110d1edf0Sdrh         tempX.op = TK_INTEGER;
416210d1edf0Sdrh         tempX.flags = EP_IntValue|EP_TokenOnly;
416310d1edf0Sdrh         tempX.u.iValue = 0;
4164e7375bfaSdrh         ExprClearVVAProperties(&tempX);
416510d1edf0Sdrh         r1 = sqlite3ExprCodeTemp(pParse, &tempX, &regFree1);
4166e55cbd72Sdrh         r2 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree2);
41672dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_Subtract, r2, r1, target);
4168c5499befSdrh         testcase( regFree2==0 );
41693c84ddffSdrh       }
41706e142f54Sdrh       break;
41716e142f54Sdrh     }
4172bf4133cbSdrh     case TK_BITNOT:
41736e142f54Sdrh     case TK_NOT: {
41747d176105Sdrh       assert( TK_BITNOT==OP_BitNot );   testcase( op==TK_BITNOT );
41757d176105Sdrh       assert( TK_NOT==OP_Not );         testcase( op==TK_NOT );
4176e99fa2afSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4177e99fa2afSdrh       testcase( regFree1==0 );
4178e99fa2afSdrh       sqlite3VdbeAddOp2(v, op, r1, inReg);
4179cce7d176Sdrh       break;
4180cce7d176Sdrh     }
41818abed7b9Sdrh     case TK_TRUTH: {
418296acafbeSdrh       int isTrue;    /* IS TRUE or IS NOT TRUE */
418396acafbeSdrh       int bNormal;   /* IS TRUE or IS FALSE */
4184007c843bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4185007c843bSdrh       testcase( regFree1==0 );
418696acafbeSdrh       isTrue = sqlite3ExprTruthValue(pExpr->pRight);
418796acafbeSdrh       bNormal = pExpr->op2==TK_IS;
418896acafbeSdrh       testcase( isTrue && bNormal);
418996acafbeSdrh       testcase( !isTrue && bNormal);
419096acafbeSdrh       sqlite3VdbeAddOp4Int(v, OP_IsTrue, r1, inReg, !isTrue, isTrue ^ bNormal);
4191007c843bSdrh       break;
4192007c843bSdrh     }
4193cce7d176Sdrh     case TK_ISNULL:
4194cce7d176Sdrh     case TK_NOTNULL: {
41956a288a33Sdrh       int addr;
41967d176105Sdrh       assert( TK_ISNULL==OP_IsNull );   testcase( op==TK_ISNULL );
41977d176105Sdrh       assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
41989de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
41992dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4200c5499befSdrh       testcase( regFree1==0 );
42012dcef11bSdrh       addr = sqlite3VdbeAddOp1(v, op, r1);
42027d176105Sdrh       VdbeCoverageIf(v, op==TK_ISNULL);
42037d176105Sdrh       VdbeCoverageIf(v, op==TK_NOTNULL);
4204a976979bSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 0, target);
42056a288a33Sdrh       sqlite3VdbeJumpHere(v, addr);
4206a37cdde0Sdanielk1977       break;
4207f2bc013cSdrh     }
42082282792aSdrh     case TK_AGG_FUNCTION: {
420913449892Sdrh       AggInfo *pInfo = pExpr->pAggInfo;
42100934d640Sdrh       if( pInfo==0
42110934d640Sdrh        || NEVER(pExpr->iAgg<0)
42120934d640Sdrh        || NEVER(pExpr->iAgg>=pInfo->nFunc)
42130934d640Sdrh       ){
421433e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
421533e619fcSdrh         sqlite3ErrorMsg(pParse, "misuse of aggregate: %s()", pExpr->u.zToken);
42167e56e711Sdrh       }else{
4217c332cc30Sdrh         return pInfo->aFunc[pExpr->iAgg].iMem;
42187e56e711Sdrh       }
42192282792aSdrh       break;
42202282792aSdrh     }
4221cce7d176Sdrh     case TK_FUNCTION: {
422212ffee8cSdrh       ExprList *pFarg;       /* List of function arguments */
422312ffee8cSdrh       int nFarg;             /* Number of function arguments */
422412ffee8cSdrh       FuncDef *pDef;         /* The function definition object */
422512ffee8cSdrh       const char *zId;       /* The function name */
4226693e6719Sdrh       u32 constMask = 0;     /* Mask of function arguments that are constant */
422712ffee8cSdrh       int i;                 /* Loop counter */
4228c332cc30Sdrh       sqlite3 *db = pParse->db;  /* The database connection */
422912ffee8cSdrh       u8 enc = ENC(db);      /* The text encoding used by this database */
423012ffee8cSdrh       CollSeq *pColl = 0;    /* A collating sequence */
423117435752Sdrh 
423267a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
4233eda079cdSdrh       if( ExprHasProperty(pExpr, EP_WinFunc) ){
4234eda079cdSdrh         return pExpr->y.pWin->regResult;
423586fb6e17Sdan       }
423667a9b8edSdan #endif
423786fb6e17Sdan 
42381e9b53f9Sdrh       if( ConstFactorOk(pParse) && sqlite3ExprIsConstantNotJoin(pExpr) ){
42399b258c54Sdrh         /* SQL functions can be expensive. So try to avoid running them
42409b258c54Sdrh         ** multiple times if we know they always give the same result */
42419b258c54Sdrh         return sqlite3ExprCodeRunJustOnce(pParse, pExpr, -1);
42421e9b53f9Sdrh       }
42436ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
4244e7375bfaSdrh       assert( !ExprHasProperty(pExpr, EP_TokenOnly) );
424512ffee8cSdrh       pFarg = pExpr->x.pList;
424612ffee8cSdrh       nFarg = pFarg ? pFarg->nExpr : 0;
424733e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
424833e619fcSdrh       zId = pExpr->u.zToken;
424980738d9cSdrh       pDef = sqlite3FindFunction(db, zId, nFarg, enc, 0);
4250cc15313cSdrh #ifdef SQLITE_ENABLE_UNKNOWN_SQL_FUNCTION
4251cc15313cSdrh       if( pDef==0 && pParse->explain ){
4252cc15313cSdrh         pDef = sqlite3FindFunction(db, "unknown", nFarg, enc, 0);
4253cc15313cSdrh       }
4254cc15313cSdrh #endif
4255b6e9f7a4Sdan       if( pDef==0 || pDef->xFinalize!=0 ){
425680738d9cSdrh         sqlite3ErrorMsg(pParse, "unknown function: %s()", zId);
4257feb306f5Sdrh         break;
4258feb306f5Sdrh       }
425925c4296bSdrh       if( pDef->funcFlags & SQLITE_FUNC_INLINE ){
42600dfa5255Sdrh         assert( (pDef->funcFlags & SQLITE_FUNC_UNSAFE)==0 );
42610dfa5255Sdrh         assert( (pDef->funcFlags & SQLITE_FUNC_DIRECT)==0 );
426225c4296bSdrh         return exprCodeInlineFunction(pParse, pFarg,
426325c4296bSdrh              SQLITE_PTR_TO_INT(pDef->pUserData), target);
42642eeca204Sdrh       }else if( pDef->funcFlags & (SQLITE_FUNC_DIRECT|SQLITE_FUNC_UNSAFE) ){
42650dfa5255Sdrh         sqlite3ExprFunctionUsable(pParse, pExpr, pDef);
4266ae6bb957Sdrh       }
4267a1a523a5Sdrh 
4268d1a01edaSdrh       for(i=0; i<nFarg; i++){
4269d1a01edaSdrh         if( i<32 && sqlite3ExprIsConstant(pFarg->a[i].pExpr) ){
4270693e6719Sdrh           testcase( i==31 );
4271693e6719Sdrh           constMask |= MASKBIT32(i);
4272d1a01edaSdrh         }
4273d1a01edaSdrh         if( (pDef->funcFlags & SQLITE_FUNC_NEEDCOLL)!=0 && !pColl ){
4274d1a01edaSdrh           pColl = sqlite3ExprCollSeq(pParse, pFarg->a[i].pExpr);
4275d1a01edaSdrh         }
4276d1a01edaSdrh       }
427712ffee8cSdrh       if( pFarg ){
4278d1a01edaSdrh         if( constMask ){
4279d1a01edaSdrh           r1 = pParse->nMem+1;
4280d1a01edaSdrh           pParse->nMem += nFarg;
4281d1a01edaSdrh         }else{
428212ffee8cSdrh           r1 = sqlite3GetTempRange(pParse, nFarg);
4283d1a01edaSdrh         }
4284a748fdccSdrh 
4285a748fdccSdrh         /* For length() and typeof() functions with a column argument,
4286a748fdccSdrh         ** set the P5 parameter to the OP_Column opcode to OPFLAG_LENGTHARG
4287a748fdccSdrh         ** or OPFLAG_TYPEOFARG respectively, to avoid unnecessary data
4288a748fdccSdrh         ** loading.
4289a748fdccSdrh         */
4290d36e1041Sdrh         if( (pDef->funcFlags & (SQLITE_FUNC_LENGTH|SQLITE_FUNC_TYPEOF))!=0 ){
42914e245a4cSdrh           u8 exprOp;
4292a748fdccSdrh           assert( nFarg==1 );
4293a748fdccSdrh           assert( pFarg->a[0].pExpr!=0 );
42944e245a4cSdrh           exprOp = pFarg->a[0].pExpr->op;
42954e245a4cSdrh           if( exprOp==TK_COLUMN || exprOp==TK_AGG_COLUMN ){
4296a748fdccSdrh             assert( SQLITE_FUNC_LENGTH==OPFLAG_LENGTHARG );
4297a748fdccSdrh             assert( SQLITE_FUNC_TYPEOF==OPFLAG_TYPEOFARG );
4298b1fba286Sdrh             testcase( pDef->funcFlags & OPFLAG_LENGTHARG );
4299b1fba286Sdrh             pFarg->a[0].pExpr->op2 =
4300b1fba286Sdrh                   pDef->funcFlags & (OPFLAG_LENGTHARG|OPFLAG_TYPEOFARG);
4301a748fdccSdrh           }
4302a748fdccSdrh         }
4303a748fdccSdrh 
43045579d59fSdrh         sqlite3ExprCodeExprList(pParse, pFarg, r1, 0,
4305d1a01edaSdrh                                 SQLITE_ECEL_DUP|SQLITE_ECEL_FACTOR);
4306892d3179Sdrh       }else{
430712ffee8cSdrh         r1 = 0;
4308892d3179Sdrh       }
4309b7f6f68fSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
4310a43fa227Sdrh       /* Possibly overload the function if the first argument is
4311a43fa227Sdrh       ** a virtual table column.
4312a43fa227Sdrh       **
4313a43fa227Sdrh       ** For infix functions (LIKE, GLOB, REGEXP, and MATCH) use the
4314a43fa227Sdrh       ** second argument, not the first, as the argument to test to
4315a43fa227Sdrh       ** see if it is a column in a virtual table.  This is done because
4316a43fa227Sdrh       ** the left operand of infix functions (the operand we want to
4317a43fa227Sdrh       ** control overloading) ends up as the second argument to the
4318a43fa227Sdrh       ** function.  The expression "A glob B" is equivalent to
4319a43fa227Sdrh       ** "glob(B,A).  We want to use the A in "A glob B" to test
4320a43fa227Sdrh       ** for function overloading.  But we use the B term in "glob(B,A)".
4321a43fa227Sdrh       */
432259155065Sdrh       if( nFarg>=2 && ExprHasProperty(pExpr, EP_InfixFunc) ){
432312ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[1].pExpr);
432412ffee8cSdrh       }else if( nFarg>0 ){
432512ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[0].pExpr);
4326b7f6f68fSdrh       }
4327b7f6f68fSdrh #endif
4328d36e1041Sdrh       if( pDef->funcFlags & SQLITE_FUNC_NEEDCOLL ){
43298b213899Sdrh         if( !pColl ) pColl = db->pDfltColl;
433066a5167bSdrh         sqlite3VdbeAddOp4(v, OP_CollSeq, 0, 0, 0, (char *)pColl, P4_COLLSEQ);
4331682f68b0Sdanielk1977       }
4332092457b1Sdrh #ifdef SQLITE_ENABLE_OFFSET_SQL_FUNC
4333092457b1Sdrh       if( pDef->funcFlags & SQLITE_FUNC_OFFSET ){
43342fc865c1Sdrh         Expr *pArg = pFarg->a[0].pExpr;
43352fc865c1Sdrh         if( pArg->op==TK_COLUMN ){
4336092457b1Sdrh           sqlite3VdbeAddOp3(v, OP_Offset, pArg->iTable, pArg->iColumn, target);
43372fc865c1Sdrh         }else{
43382fc865c1Sdrh           sqlite3VdbeAddOp2(v, OP_Null, 0, target);
43392fc865c1Sdrh         }
4340092457b1Sdrh       }else
4341092457b1Sdrh #endif
4342092457b1Sdrh       {
4343920cf596Sdrh         sqlite3VdbeAddFunctionCall(pParse, constMask, r1, target, nFarg,
434420cee7d0Sdrh                                    pDef, pExpr->op2);
43452fc865c1Sdrh       }
434613d79502Sdrh       if( nFarg ){
434713d79502Sdrh         if( constMask==0 ){
434812ffee8cSdrh           sqlite3ReleaseTempRange(pParse, r1, nFarg);
434913d79502Sdrh         }else{
43503aef2fb1Sdrh           sqlite3VdbeReleaseRegisters(pParse, r1, nFarg, constMask, 1);
435113d79502Sdrh         }
43522dcef11bSdrh       }
4353c332cc30Sdrh       return target;
43546ec2733bSdrh     }
4355fe2093d7Sdrh #ifndef SQLITE_OMIT_SUBQUERY
4356fe2093d7Sdrh     case TK_EXISTS:
435719a775c2Sdrh     case TK_SELECT: {
43588da209b1Sdan       int nCol;
4359c5499befSdrh       testcase( op==TK_EXISTS );
4360c5499befSdrh       testcase( op==TK_SELECT );
4361d8d335d7Sdrh       if( pParse->db->mallocFailed ){
4362d8d335d7Sdrh         return 0;
4363d8d335d7Sdrh       }else if( op==TK_SELECT && (nCol = pExpr->x.pSelect->pEList->nExpr)!=1 ){
43648da209b1Sdan         sqlite3SubselectError(pParse, nCol, 1);
43658da209b1Sdan       }else{
436685bcdce2Sdrh         return sqlite3CodeSubselect(pParse, pExpr);
43678da209b1Sdan       }
436819a775c2Sdrh       break;
436919a775c2Sdrh     }
4370fc7f27b9Sdrh     case TK_SELECT_COLUMN: {
4371966e2911Sdrh       int n;
4372fc7f27b9Sdrh       if( pExpr->pLeft->iTable==0 ){
437385bcdce2Sdrh         pExpr->pLeft->iTable = sqlite3CodeSubselect(pParse, pExpr->pLeft);
4374fc7f27b9Sdrh       }
437505428127Sdrh       assert( pExpr->iTable==0 || pExpr->pLeft->op==TK_SELECT
437605428127Sdrh                || pExpr->pLeft->op==TK_ERROR );
4377554a9dc7Sdrh       if( pExpr->iTable!=0
4378966e2911Sdrh        && pExpr->iTable!=(n = sqlite3ExprVectorSize(pExpr->pLeft))
4379966e2911Sdrh       ){
4380966e2911Sdrh         sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
4381966e2911Sdrh                                 pExpr->iTable, n);
4382966e2911Sdrh       }
4383c332cc30Sdrh       return pExpr->pLeft->iTable + pExpr->iColumn;
4384fc7f27b9Sdrh     }
4385fef5208cSdrh     case TK_IN: {
4386ec4ccdbcSdrh       int destIfFalse = sqlite3VdbeMakeLabel(pParse);
4387ec4ccdbcSdrh       int destIfNull = sqlite3VdbeMakeLabel(pParse);
4388e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
4389e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
439066ba23ceSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
4391e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
4392e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_AddImm, target, 0);
4393e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfNull);
4394c332cc30Sdrh       return target;
4395fef5208cSdrh     }
4396e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
4397e3365e6cSdrh 
4398e3365e6cSdrh 
43992dcef11bSdrh     /*
44002dcef11bSdrh     **    x BETWEEN y AND z
44012dcef11bSdrh     **
44022dcef11bSdrh     ** This is equivalent to
44032dcef11bSdrh     **
44042dcef11bSdrh     **    x>=y AND x<=z
44052dcef11bSdrh     **
44062dcef11bSdrh     ** X is stored in pExpr->pLeft.
44072dcef11bSdrh     ** Y is stored in pExpr->pList->a[0].pExpr.
44082dcef11bSdrh     ** Z is stored in pExpr->pList->a[1].pExpr.
44092dcef11bSdrh     */
4410fef5208cSdrh     case TK_BETWEEN: {
441171c57db0Sdan       exprCodeBetween(pParse, pExpr, target, 0, 0);
4412c332cc30Sdrh       return target;
4413fef5208cSdrh     }
441494fa9c41Sdrh     case TK_SPAN:
4415ae80ddeaSdrh     case TK_COLLATE:
44164f07e5fbSdrh     case TK_UPLUS: {
44171efa8023Sdrh       pExpr = pExpr->pLeft;
441859ee43a7Sdrh       goto expr_code_doover; /* 2018-04-28: Prevent deep recursion. OSSFuzz. */
4419a2e00042Sdrh     }
44202dcef11bSdrh 
4421165921a7Sdan     case TK_TRIGGER: {
442265a7cd16Sdan       /* If the opcode is TK_TRIGGER, then the expression is a reference
442365a7cd16Sdan       ** to a column in the new.* or old.* pseudo-tables available to
442465a7cd16Sdan       ** trigger programs. In this case Expr.iTable is set to 1 for the
442565a7cd16Sdan       ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
442665a7cd16Sdan       ** is set to the column of the pseudo-table to read, or to -1 to
442765a7cd16Sdan       ** read the rowid field.
442865a7cd16Sdan       **
442965a7cd16Sdan       ** The expression is implemented using an OP_Param opcode. The p1
443065a7cd16Sdan       ** parameter is set to 0 for an old.rowid reference, or to (i+1)
443165a7cd16Sdan       ** to reference another column of the old.* pseudo-table, where
443265a7cd16Sdan       ** i is the index of the column. For a new.rowid reference, p1 is
443365a7cd16Sdan       ** set to (n+1), where n is the number of columns in each pseudo-table.
443465a7cd16Sdan       ** For a reference to any other column in the new.* pseudo-table, p1
443565a7cd16Sdan       ** is set to (n+2+i), where n and i are as defined previously. For
443665a7cd16Sdan       ** example, if the table on which triggers are being fired is
443765a7cd16Sdan       ** declared as:
443865a7cd16Sdan       **
443965a7cd16Sdan       **   CREATE TABLE t1(a, b);
444065a7cd16Sdan       **
444165a7cd16Sdan       ** Then p1 is interpreted as follows:
444265a7cd16Sdan       **
444365a7cd16Sdan       **   p1==0   ->    old.rowid     p1==3   ->    new.rowid
444465a7cd16Sdan       **   p1==1   ->    old.a         p1==4   ->    new.a
444565a7cd16Sdan       **   p1==2   ->    old.b         p1==5   ->    new.b
444665a7cd16Sdan       */
4447eda079cdSdrh       Table *pTab = pExpr->y.pTab;
4448dd6cc9b5Sdrh       int iCol = pExpr->iColumn;
4449dd6cc9b5Sdrh       int p1 = pExpr->iTable * (pTab->nCol+1) + 1
44507fe2fc0dSdrh                      + sqlite3TableColumnToStorage(pTab, iCol);
445165a7cd16Sdan 
445265a7cd16Sdan       assert( pExpr->iTable==0 || pExpr->iTable==1 );
4453dd6cc9b5Sdrh       assert( iCol>=-1 && iCol<pTab->nCol );
4454dd6cc9b5Sdrh       assert( pTab->iPKey<0 || iCol!=pTab->iPKey );
445565a7cd16Sdan       assert( p1>=0 && p1<(pTab->nCol*2+2) );
445665a7cd16Sdan 
445765a7cd16Sdan       sqlite3VdbeAddOp2(v, OP_Param, p1, target);
4458896494e8Sdrh       VdbeComment((v, "r[%d]=%s.%s", target,
4459165921a7Sdan         (pExpr->iTable ? "new" : "old"),
4460dd6cc9b5Sdrh         (pExpr->iColumn<0 ? "rowid" : pExpr->y.pTab->aCol[iCol].zName)
4461165921a7Sdan       ));
446265a7cd16Sdan 
446344dbca83Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
446465a7cd16Sdan       /* If the column has REAL affinity, it may currently be stored as an
4465113762a2Sdrh       ** integer. Use OP_RealAffinity to make sure it is really real.
4466113762a2Sdrh       **
4467113762a2Sdrh       ** EVIDENCE-OF: R-60985-57662 SQLite will convert the value back to
4468113762a2Sdrh       ** floating point when extracting it from the record.  */
4469dd6cc9b5Sdrh       if( iCol>=0 && pTab->aCol[iCol].affinity==SQLITE_AFF_REAL ){
44702832ad42Sdan         sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
44712832ad42Sdan       }
447244dbca83Sdrh #endif
4473165921a7Sdan       break;
4474165921a7Sdan     }
4475165921a7Sdan 
447671c57db0Sdan     case TK_VECTOR: {
4477e835bc12Sdrh       sqlite3ErrorMsg(pParse, "row value misused");
447871c57db0Sdan       break;
447971c57db0Sdan     }
448071c57db0Sdan 
44819e9a67adSdrh     /* TK_IF_NULL_ROW Expr nodes are inserted ahead of expressions
44829e9a67adSdrh     ** that derive from the right-hand table of a LEFT JOIN.  The
44839e9a67adSdrh     ** Expr.iTable value is the table number for the right-hand table.
44849e9a67adSdrh     ** The expression is only evaluated if that table is not currently
44859e9a67adSdrh     ** on a LEFT JOIN NULL row.
44869e9a67adSdrh     */
448731d6fd55Sdrh     case TK_IF_NULL_ROW: {
448831d6fd55Sdrh       int addrINR;
44899e9a67adSdrh       u8 okConstFactor = pParse->okConstFactor;
449031d6fd55Sdrh       addrINR = sqlite3VdbeAddOp1(v, OP_IfNullRow, pExpr->iTable);
44919e9a67adSdrh       /* Temporarily disable factoring of constant expressions, since
44929e9a67adSdrh       ** even though expressions may appear to be constant, they are not
44939e9a67adSdrh       ** really constant because they originate from the right-hand side
44949e9a67adSdrh       ** of a LEFT JOIN. */
44959e9a67adSdrh       pParse->okConstFactor = 0;
449631d6fd55Sdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
44979e9a67adSdrh       pParse->okConstFactor = okConstFactor;
449831d6fd55Sdrh       sqlite3VdbeJumpHere(v, addrINR);
449931d6fd55Sdrh       sqlite3VdbeChangeP3(v, addrINR, inReg);
450031d6fd55Sdrh       break;
450131d6fd55Sdrh     }
450231d6fd55Sdrh 
45032dcef11bSdrh     /*
45042dcef11bSdrh     ** Form A:
45052dcef11bSdrh     **   CASE x WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
45062dcef11bSdrh     **
45072dcef11bSdrh     ** Form B:
45082dcef11bSdrh     **   CASE WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
45092dcef11bSdrh     **
45102dcef11bSdrh     ** Form A is can be transformed into the equivalent form B as follows:
45112dcef11bSdrh     **   CASE WHEN x=e1 THEN r1 WHEN x=e2 THEN r2 ...
45122dcef11bSdrh     **        WHEN x=eN THEN rN ELSE y END
45132dcef11bSdrh     **
45142dcef11bSdrh     ** X (if it exists) is in pExpr->pLeft.
4515c5cd1249Sdrh     ** Y is in the last element of pExpr->x.pList if pExpr->x.pList->nExpr is
4516c5cd1249Sdrh     ** odd.  The Y is also optional.  If the number of elements in x.pList
4517c5cd1249Sdrh     ** is even, then Y is omitted and the "otherwise" result is NULL.
45182dcef11bSdrh     ** Ei is in pExpr->pList->a[i*2] and Ri is pExpr->pList->a[i*2+1].
45192dcef11bSdrh     **
45202dcef11bSdrh     ** The result of the expression is the Ri for the first matching Ei,
45212dcef11bSdrh     ** or if there is no matching Ei, the ELSE term Y, or if there is
45222dcef11bSdrh     ** no ELSE term, NULL.
45232dcef11bSdrh     */
4524aac30f9bSdrh     case TK_CASE: {
45252dcef11bSdrh       int endLabel;                     /* GOTO label for end of CASE stmt */
45262dcef11bSdrh       int nextCase;                     /* GOTO label for next WHEN clause */
45272dcef11bSdrh       int nExpr;                        /* 2x number of WHEN terms */
45282dcef11bSdrh       int i;                            /* Loop counter */
45292dcef11bSdrh       ExprList *pEList;                 /* List of WHEN terms */
45302dcef11bSdrh       struct ExprList_item *aListelem;  /* Array of WHEN terms */
45312dcef11bSdrh       Expr opCompare;                   /* The X==Ei expression */
45322dcef11bSdrh       Expr *pX;                         /* The X expression */
45331bd10f8aSdrh       Expr *pTest = 0;                  /* X==Ei (form A) or just Ei (form B) */
45348b65e591Sdan       Expr *pDel = 0;
45358b65e591Sdan       sqlite3 *db = pParse->db;
453617a7f8ddSdrh 
45376ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) && pExpr->x.pList );
45386ab3a2ecSdanielk1977       assert(pExpr->x.pList->nExpr > 0);
45396ab3a2ecSdanielk1977       pEList = pExpr->x.pList;
4540be5c89acSdrh       aListelem = pEList->a;
4541be5c89acSdrh       nExpr = pEList->nExpr;
4542ec4ccdbcSdrh       endLabel = sqlite3VdbeMakeLabel(pParse);
45432dcef11bSdrh       if( (pX = pExpr->pLeft)!=0 ){
45448b65e591Sdan         pDel = sqlite3ExprDup(db, pX, 0);
45458b65e591Sdan         if( db->mallocFailed ){
45468b65e591Sdan           sqlite3ExprDelete(db, pDel);
45478b65e591Sdan           break;
45488b65e591Sdan         }
454933cd4909Sdrh         testcase( pX->op==TK_COLUMN );
45508b65e591Sdan         exprToRegister(pDel, exprCodeVector(pParse, pDel, &regFree1));
4551c5499befSdrh         testcase( regFree1==0 );
4552abb9d5f1Sdrh         memset(&opCompare, 0, sizeof(opCompare));
45532dcef11bSdrh         opCompare.op = TK_EQ;
45548b65e591Sdan         opCompare.pLeft = pDel;
45552dcef11bSdrh         pTest = &opCompare;
45568b1db07fSdrh         /* Ticket b351d95f9cd5ef17e9d9dbae18f5ca8611190001:
45578b1db07fSdrh         ** The value in regFree1 might get SCopy-ed into the file result.
45588b1db07fSdrh         ** So make sure that the regFree1 register is not reused for other
45598b1db07fSdrh         ** purposes and possibly overwritten.  */
45608b1db07fSdrh         regFree1 = 0;
4561cce7d176Sdrh       }
4562c5cd1249Sdrh       for(i=0; i<nExpr-1; i=i+2){
45632dcef11bSdrh         if( pX ){
45641bd10f8aSdrh           assert( pTest!=0 );
45652dcef11bSdrh           opCompare.pRight = aListelem[i].pExpr;
4566f5905aa7Sdrh         }else{
45672dcef11bSdrh           pTest = aListelem[i].pExpr;
456817a7f8ddSdrh         }
4569ec4ccdbcSdrh         nextCase = sqlite3VdbeMakeLabel(pParse);
457033cd4909Sdrh         testcase( pTest->op==TK_COLUMN );
45712dcef11bSdrh         sqlite3ExprIfFalse(pParse, pTest, nextCase, SQLITE_JUMPIFNULL);
4572c5499befSdrh         testcase( aListelem[i+1].pExpr->op==TK_COLUMN );
45739de221dfSdrh         sqlite3ExprCode(pParse, aListelem[i+1].pExpr, target);
4574076e85f5Sdrh         sqlite3VdbeGoto(v, endLabel);
45752dcef11bSdrh         sqlite3VdbeResolveLabel(v, nextCase);
4576f570f011Sdrh       }
4577c5cd1249Sdrh       if( (nExpr&1)!=0 ){
4578c5cd1249Sdrh         sqlite3ExprCode(pParse, pEList->a[nExpr-1].pExpr, target);
457917a7f8ddSdrh       }else{
45809de221dfSdrh         sqlite3VdbeAddOp2(v, OP_Null, 0, target);
458117a7f8ddSdrh       }
45828b65e591Sdan       sqlite3ExprDelete(db, pDel);
458392a27f7bSdrh       setDoNotMergeFlagOnCopy(v);
45842dcef11bSdrh       sqlite3VdbeResolveLabel(v, endLabel);
45856f34903eSdanielk1977       break;
45866f34903eSdanielk1977     }
45875338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_TRIGGER
45886f34903eSdanielk1977     case TK_RAISE: {
45891194904bSdrh       assert( pExpr->affExpr==OE_Rollback
45901194904bSdrh            || pExpr->affExpr==OE_Abort
45911194904bSdrh            || pExpr->affExpr==OE_Fail
45921194904bSdrh            || pExpr->affExpr==OE_Ignore
4593165921a7Sdan       );
45949e5fdc41Sdrh       if( !pParse->pTriggerTab && !pParse->nested ){
4595e0af83acSdan         sqlite3ErrorMsg(pParse,
4596e0af83acSdan                        "RAISE() may only be used within a trigger-program");
4597e0af83acSdan         return 0;
4598e0af83acSdan       }
45991194904bSdrh       if( pExpr->affExpr==OE_Abort ){
4600e0af83acSdan         sqlite3MayAbort(pParse);
4601e0af83acSdan       }
460233e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
46031194904bSdrh       if( pExpr->affExpr==OE_Ignore ){
4604e0af83acSdan         sqlite3VdbeAddOp4(
4605e0af83acSdan             v, OP_Halt, SQLITE_OK, OE_Ignore, 0, pExpr->u.zToken,0);
4606688852abSdrh         VdbeCoverage(v);
4607e0af83acSdan       }else{
46089e5fdc41Sdrh         sqlite3HaltConstraint(pParse,
46099e5fdc41Sdrh              pParse->pTriggerTab ? SQLITE_CONSTRAINT_TRIGGER : SQLITE_ERROR,
46101194904bSdrh              pExpr->affExpr, pExpr->u.zToken, 0, 0);
4611e0af83acSdan       }
4612e0af83acSdan 
4613ffe07b2dSdrh       break;
461417a7f8ddSdrh     }
46155338a5f7Sdanielk1977 #endif
4616ffe07b2dSdrh   }
46172dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
46182dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
46192dcef11bSdrh   return inReg;
46205b6afba9Sdrh }
46212dcef11bSdrh 
46222dcef11bSdrh /*
46239b258c54Sdrh ** Generate code that will evaluate expression pExpr just one time
46249b258c54Sdrh ** per prepared statement execution.
46259b258c54Sdrh **
46269b258c54Sdrh ** If the expression uses functions (that might throw an exception) then
46279b258c54Sdrh ** guard them with an OP_Once opcode to ensure that the code is only executed
46289b258c54Sdrh ** once. If no functions are involved, then factor the code out and put it at
46299b258c54Sdrh ** the end of the prepared statement in the initialization section.
46301e9b53f9Sdrh **
4631ad879ffdSdrh ** If regDest>=0 then the result is always stored in that register and the
4632ad879ffdSdrh ** result is not reusable.  If regDest<0 then this routine is free to
4633ad879ffdSdrh ** store the value whereever it wants.  The register where the expression
46349b258c54Sdrh ** is stored is returned.  When regDest<0, two identical expressions might
46359b258c54Sdrh ** code to the same register, if they do not contain function calls and hence
46369b258c54Sdrh ** are factored out into the initialization section at the end of the
46379b258c54Sdrh ** prepared statement.
4638d1a01edaSdrh */
46399b258c54Sdrh int sqlite3ExprCodeRunJustOnce(
4640d673cddaSdrh   Parse *pParse,    /* Parsing context */
4641d673cddaSdrh   Expr *pExpr,      /* The expression to code when the VDBE initializes */
4642ad879ffdSdrh   int regDest       /* Store the value in this register */
4643d673cddaSdrh ){
4644d1a01edaSdrh   ExprList *p;
4645d9f158e7Sdrh   assert( ConstFactorOk(pParse) );
4646d1a01edaSdrh   p = pParse->pConstExpr;
4647ad879ffdSdrh   if( regDest<0 && p ){
46481e9b53f9Sdrh     struct ExprList_item *pItem;
46491e9b53f9Sdrh     int i;
46501e9b53f9Sdrh     for(pItem=p->a, i=p->nExpr; i>0; pItem++, i--){
46515aa550cfSdan       if( pItem->reusable && sqlite3ExprCompare(0,pItem->pExpr,pExpr,-1)==0 ){
46521e9b53f9Sdrh         return pItem->u.iConstExprReg;
46531e9b53f9Sdrh       }
46541e9b53f9Sdrh     }
46551e9b53f9Sdrh   }
4656d1a01edaSdrh   pExpr = sqlite3ExprDup(pParse->db, pExpr, 0);
465738dfbdaeSdrh   if( pExpr!=0 && ExprHasProperty(pExpr, EP_HasFunc) ){
465838dfbdaeSdrh     Vdbe *v = pParse->pVdbe;
465938dfbdaeSdrh     int addr;
466038dfbdaeSdrh     assert( v );
466138dfbdaeSdrh     addr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
466238dfbdaeSdrh     pParse->okConstFactor = 0;
466338dfbdaeSdrh     if( !pParse->db->mallocFailed ){
46649b258c54Sdrh       if( regDest<0 ) regDest = ++pParse->nMem;
466538dfbdaeSdrh       sqlite3ExprCode(pParse, pExpr, regDest);
466638dfbdaeSdrh     }
466738dfbdaeSdrh     pParse->okConstFactor = 1;
466838dfbdaeSdrh     sqlite3ExprDelete(pParse->db, pExpr);
466938dfbdaeSdrh     sqlite3VdbeJumpHere(v, addr);
467038dfbdaeSdrh   }else{
4671d1a01edaSdrh     p = sqlite3ExprListAppend(pParse, p, pExpr);
4672d673cddaSdrh     if( p ){
4673d673cddaSdrh        struct ExprList_item *pItem = &p->a[p->nExpr-1];
4674ad879ffdSdrh        pItem->reusable = regDest<0;
46759b258c54Sdrh        if( regDest<0 ) regDest = ++pParse->nMem;
4676d673cddaSdrh        pItem->u.iConstExprReg = regDest;
4677d673cddaSdrh     }
4678d1a01edaSdrh     pParse->pConstExpr = p;
467938dfbdaeSdrh   }
46801e9b53f9Sdrh   return regDest;
4681d1a01edaSdrh }
4682d1a01edaSdrh 
4683d1a01edaSdrh /*
46842dcef11bSdrh ** Generate code to evaluate an expression and store the results
46852dcef11bSdrh ** into a register.  Return the register number where the results
46862dcef11bSdrh ** are stored.
46872dcef11bSdrh **
46882dcef11bSdrh ** If the register is a temporary register that can be deallocated,
4689678ccce8Sdrh ** then write its number into *pReg.  If the result register is not
46902dcef11bSdrh ** a temporary, then set *pReg to zero.
4691f30a969bSdrh **
4692f30a969bSdrh ** If pExpr is a constant, then this routine might generate this
4693f30a969bSdrh ** code to fill the register in the initialization section of the
4694f30a969bSdrh ** VDBE program, in order to factor it out of the evaluation loop.
46952dcef11bSdrh */
46962dcef11bSdrh int sqlite3ExprCodeTemp(Parse *pParse, Expr *pExpr, int *pReg){
4697f30a969bSdrh   int r2;
46980d950af3Sdrh   pExpr = sqlite3ExprSkipCollateAndLikely(pExpr);
4699d9f158e7Sdrh   if( ConstFactorOk(pParse)
4700235667a8Sdrh    && ALWAYS(pExpr!=0)
4701f30a969bSdrh    && pExpr->op!=TK_REGISTER
4702f30a969bSdrh    && sqlite3ExprIsConstantNotJoin(pExpr)
4703f30a969bSdrh   ){
4704f30a969bSdrh     *pReg  = 0;
47059b258c54Sdrh     r2 = sqlite3ExprCodeRunJustOnce(pParse, pExpr, -1);
4706f30a969bSdrh   }else{
47072dcef11bSdrh     int r1 = sqlite3GetTempReg(pParse);
4708f30a969bSdrh     r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
47092dcef11bSdrh     if( r2==r1 ){
47102dcef11bSdrh       *pReg = r1;
47112dcef11bSdrh     }else{
47122dcef11bSdrh       sqlite3ReleaseTempReg(pParse, r1);
47132dcef11bSdrh       *pReg = 0;
47142dcef11bSdrh     }
4715f30a969bSdrh   }
47162dcef11bSdrh   return r2;
47172dcef11bSdrh }
47182dcef11bSdrh 
47192dcef11bSdrh /*
47202dcef11bSdrh ** Generate code that will evaluate expression pExpr and store the
47212dcef11bSdrh ** results in register target.  The results are guaranteed to appear
47222dcef11bSdrh ** in register target.
47232dcef11bSdrh */
472405a86c5cSdrh void sqlite3ExprCode(Parse *pParse, Expr *pExpr, int target){
47259cbf3425Sdrh   int inReg;
47269cbf3425Sdrh 
4727e7375bfaSdrh   assert( pExpr==0 || !ExprHasVVAProperty(pExpr,EP_Immutable) );
47289cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
47291c75c9d7Sdrh   assert( pParse->pVdbe!=0 || pParse->db->mallocFailed );
4730b639a209Sdrh   if( pParse->pVdbe==0 ) return;
4731b639a209Sdrh   inReg = sqlite3ExprCodeTarget(pParse, pExpr, target);
4732b639a209Sdrh   if( inReg!=target ){
4733629b88c6Sdrh     u8 op;
4734629b88c6Sdrh     if( ExprHasProperty(pExpr,EP_Subquery) ){
4735629b88c6Sdrh       op = OP_Copy;
4736629b88c6Sdrh     }else{
4737629b88c6Sdrh       op = OP_SCopy;
4738629b88c6Sdrh     }
4739629b88c6Sdrh     sqlite3VdbeAddOp2(pParse->pVdbe, op, inReg, target);
474017a7f8ddSdrh   }
4741ebc16717Sdrh }
4742cce7d176Sdrh 
4743cce7d176Sdrh /*
47441c75c9d7Sdrh ** Make a transient copy of expression pExpr and then code it using
47451c75c9d7Sdrh ** sqlite3ExprCode().  This routine works just like sqlite3ExprCode()
47461c75c9d7Sdrh ** except that the input expression is guaranteed to be unchanged.
47471c75c9d7Sdrh */
47481c75c9d7Sdrh void sqlite3ExprCodeCopy(Parse *pParse, Expr *pExpr, int target){
47491c75c9d7Sdrh   sqlite3 *db = pParse->db;
47501c75c9d7Sdrh   pExpr = sqlite3ExprDup(db, pExpr, 0);
47511c75c9d7Sdrh   if( !db->mallocFailed ) sqlite3ExprCode(pParse, pExpr, target);
47521c75c9d7Sdrh   sqlite3ExprDelete(db, pExpr);
47531c75c9d7Sdrh }
47541c75c9d7Sdrh 
47551c75c9d7Sdrh /*
475605a86c5cSdrh ** Generate code that will evaluate expression pExpr and store the
475705a86c5cSdrh ** results in register target.  The results are guaranteed to appear
475805a86c5cSdrh ** in register target.  If the expression is constant, then this routine
475905a86c5cSdrh ** might choose to code the expression at initialization time.
476005a86c5cSdrh */
476105a86c5cSdrh void sqlite3ExprCodeFactorable(Parse *pParse, Expr *pExpr, int target){
4762b8b06690Sdrh   if( pParse->okConstFactor && sqlite3ExprIsConstantNotJoin(pExpr) ){
47639b258c54Sdrh     sqlite3ExprCodeRunJustOnce(pParse, pExpr, target);
476405a86c5cSdrh   }else{
4765088489e8Sdrh     sqlite3ExprCodeCopy(pParse, pExpr, target);
476605a86c5cSdrh   }
4767cce7d176Sdrh }
4768cce7d176Sdrh 
4769cce7d176Sdrh /*
4770268380caSdrh ** Generate code that pushes the value of every element of the given
47719cbf3425Sdrh ** expression list into a sequence of registers beginning at target.
4772268380caSdrh **
47733df6c3b1Sdrh ** Return the number of elements evaluated.  The number returned will
47743df6c3b1Sdrh ** usually be pList->nExpr but might be reduced if SQLITE_ECEL_OMITREF
47753df6c3b1Sdrh ** is defined.
4776d1a01edaSdrh **
4777d1a01edaSdrh ** The SQLITE_ECEL_DUP flag prevents the arguments from being
4778d1a01edaSdrh ** filled using OP_SCopy.  OP_Copy must be used instead.
4779d1a01edaSdrh **
4780d1a01edaSdrh ** The SQLITE_ECEL_FACTOR argument allows constant arguments to be
4781d1a01edaSdrh ** factored out into initialization code.
4782b0df9634Sdrh **
4783b0df9634Sdrh ** The SQLITE_ECEL_REF flag means that expressions in the list with
4784b0df9634Sdrh ** ExprList.a[].u.x.iOrderByCol>0 have already been evaluated and stored
4785b0df9634Sdrh ** in registers at srcReg, and so the value can be copied from there.
47863df6c3b1Sdrh ** If SQLITE_ECEL_OMITREF is also set, then the values with u.x.iOrderByCol>0
47873df6c3b1Sdrh ** are simply omitted rather than being copied from srcReg.
4788268380caSdrh */
47894adee20fSdanielk1977 int sqlite3ExprCodeExprList(
4790268380caSdrh   Parse *pParse,     /* Parsing context */
4791389a1adbSdrh   ExprList *pList,   /* The expression list to be coded */
4792191b54cbSdrh   int target,        /* Where to write results */
47935579d59fSdrh   int srcReg,        /* Source registers if SQLITE_ECEL_REF */
4794d1a01edaSdrh   u8 flags           /* SQLITE_ECEL_* flags */
4795268380caSdrh ){
4796268380caSdrh   struct ExprList_item *pItem;
47975579d59fSdrh   int i, j, n;
4798d1a01edaSdrh   u8 copyOp = (flags & SQLITE_ECEL_DUP) ? OP_Copy : OP_SCopy;
47995579d59fSdrh   Vdbe *v = pParse->pVdbe;
48009d8b3072Sdrh   assert( pList!=0 );
48019cbf3425Sdrh   assert( target>0 );
4802d81a142bSdrh   assert( pParse->pVdbe!=0 );  /* Never gets this far otherwise */
4803268380caSdrh   n = pList->nExpr;
4804d9f158e7Sdrh   if( !ConstFactorOk(pParse) ) flags &= ~SQLITE_ECEL_FACTOR;
4805191b54cbSdrh   for(pItem=pList->a, i=0; i<n; i++, pItem++){
48067445ffe2Sdrh     Expr *pExpr = pItem->pExpr;
480724e25d32Sdan #ifdef SQLITE_ENABLE_SORTER_REFERENCES
480824e25d32Sdan     if( pItem->bSorterRef ){
480924e25d32Sdan       i--;
481024e25d32Sdan       n--;
481124e25d32Sdan     }else
481224e25d32Sdan #endif
4813257c13faSdan     if( (flags & SQLITE_ECEL_REF)!=0 && (j = pItem->u.x.iOrderByCol)>0 ){
4814257c13faSdan       if( flags & SQLITE_ECEL_OMITREF ){
4815257c13faSdan         i--;
4816257c13faSdan         n--;
4817257c13faSdan       }else{
48185579d59fSdrh         sqlite3VdbeAddOp2(v, copyOp, j+srcReg-1, target+i);
4819257c13faSdan       }
4820b8b06690Sdrh     }else if( (flags & SQLITE_ECEL_FACTOR)!=0
4821b8b06690Sdrh            && sqlite3ExprIsConstantNotJoin(pExpr)
4822b8b06690Sdrh     ){
48239b258c54Sdrh       sqlite3ExprCodeRunJustOnce(pParse, pExpr, target+i);
4824d1a01edaSdrh     }else{
48257445ffe2Sdrh       int inReg = sqlite3ExprCodeTarget(pParse, pExpr, target+i);
4826746fd9ccSdrh       if( inReg!=target+i ){
48274eded604Sdrh         VdbeOp *pOp;
48284eded604Sdrh         if( copyOp==OP_Copy
48294eded604Sdrh          && (pOp=sqlite3VdbeGetOp(v, -1))->opcode==OP_Copy
48304eded604Sdrh          && pOp->p1+pOp->p3+1==inReg
48314eded604Sdrh          && pOp->p2+pOp->p3+1==target+i
483290996885Sdrh          && pOp->p5==0  /* The do-not-merge flag must be clear */
48334eded604Sdrh         ){
48344eded604Sdrh           pOp->p3++;
48354eded604Sdrh         }else{
48364eded604Sdrh           sqlite3VdbeAddOp2(v, copyOp, inReg, target+i);
48374eded604Sdrh         }
4838d1a01edaSdrh       }
4839d176611bSdrh     }
4840268380caSdrh   }
4841f9b596ebSdrh   return n;
4842268380caSdrh }
4843268380caSdrh 
4844268380caSdrh /*
484536c563a2Sdrh ** Generate code for a BETWEEN operator.
484636c563a2Sdrh **
484736c563a2Sdrh **    x BETWEEN y AND z
484836c563a2Sdrh **
484936c563a2Sdrh ** The above is equivalent to
485036c563a2Sdrh **
485136c563a2Sdrh **    x>=y AND x<=z
485236c563a2Sdrh **
485336c563a2Sdrh ** Code it as such, taking care to do the common subexpression
485460ec914cSpeter.d.reid ** elimination of x.
485584b19a3dSdrh **
485684b19a3dSdrh ** The xJumpIf parameter determines details:
485784b19a3dSdrh **
485884b19a3dSdrh **    NULL:                   Store the boolean result in reg[dest]
485984b19a3dSdrh **    sqlite3ExprIfTrue:      Jump to dest if true
486084b19a3dSdrh **    sqlite3ExprIfFalse:     Jump to dest if false
486184b19a3dSdrh **
486284b19a3dSdrh ** The jumpIfNull parameter is ignored if xJumpIf is NULL.
486336c563a2Sdrh */
486436c563a2Sdrh static void exprCodeBetween(
486536c563a2Sdrh   Parse *pParse,    /* Parsing and code generating context */
486636c563a2Sdrh   Expr *pExpr,      /* The BETWEEN expression */
486784b19a3dSdrh   int dest,         /* Jump destination or storage location */
486884b19a3dSdrh   void (*xJump)(Parse*,Expr*,int,int), /* Action to take */
486936c563a2Sdrh   int jumpIfNull    /* Take the jump if the BETWEEN is NULL */
487036c563a2Sdrh ){
487136c563a2Sdrh   Expr exprAnd;     /* The AND operator in  x>=y AND x<=z  */
487236c563a2Sdrh   Expr compLeft;    /* The  x>=y  term */
487336c563a2Sdrh   Expr compRight;   /* The  x<=z  term */
4874db45bd5eSdrh   int regFree1 = 0; /* Temporary use register */
48758b65e591Sdan   Expr *pDel = 0;
48768b65e591Sdan   sqlite3 *db = pParse->db;
487784b19a3dSdrh 
487871c57db0Sdan   memset(&compLeft, 0, sizeof(Expr));
487971c57db0Sdan   memset(&compRight, 0, sizeof(Expr));
488071c57db0Sdan   memset(&exprAnd, 0, sizeof(Expr));
4881db45bd5eSdrh 
4882db45bd5eSdrh   assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
48838b65e591Sdan   pDel = sqlite3ExprDup(db, pExpr->pLeft, 0);
48848b65e591Sdan   if( db->mallocFailed==0 ){
488536c563a2Sdrh     exprAnd.op = TK_AND;
488636c563a2Sdrh     exprAnd.pLeft = &compLeft;
488736c563a2Sdrh     exprAnd.pRight = &compRight;
488836c563a2Sdrh     compLeft.op = TK_GE;
48898b65e591Sdan     compLeft.pLeft = pDel;
489036c563a2Sdrh     compLeft.pRight = pExpr->x.pList->a[0].pExpr;
489136c563a2Sdrh     compRight.op = TK_LE;
48928b65e591Sdan     compRight.pLeft = pDel;
489336c563a2Sdrh     compRight.pRight = pExpr->x.pList->a[1].pExpr;
48948b65e591Sdan     exprToRegister(pDel, exprCodeVector(pParse, pDel, &regFree1));
489584b19a3dSdrh     if( xJump ){
489684b19a3dSdrh       xJump(pParse, &exprAnd, dest, jumpIfNull);
489736c563a2Sdrh     }else{
489836fd41e5Sdrh       /* Mark the expression is being from the ON or USING clause of a join
489936fd41e5Sdrh       ** so that the sqlite3ExprCodeTarget() routine will not attempt to move
490036fd41e5Sdrh       ** it into the Parse.pConstExpr list.  We should use a new bit for this,
490136fd41e5Sdrh       ** for clarity, but we are out of bits in the Expr.flags field so we
490236fd41e5Sdrh       ** have to reuse the EP_FromJoin bit.  Bummer. */
49038b65e591Sdan       pDel->flags |= EP_FromJoin;
490471c57db0Sdan       sqlite3ExprCodeTarget(pParse, &exprAnd, dest);
490536c563a2Sdrh     }
4906db45bd5eSdrh     sqlite3ReleaseTempReg(pParse, regFree1);
49078b65e591Sdan   }
49088b65e591Sdan   sqlite3ExprDelete(db, pDel);
490936c563a2Sdrh 
491036c563a2Sdrh   /* Ensure adequate test coverage */
4911db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull==0 && regFree1==0 );
4912db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull==0 && regFree1!=0 );
4913db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull!=0 && regFree1==0 );
4914db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull!=0 && regFree1!=0 );
4915db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1==0 );
4916db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1!=0 );
4917db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1==0 );
4918db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1!=0 );
491984b19a3dSdrh   testcase( xJump==0 );
492036c563a2Sdrh }
492136c563a2Sdrh 
492236c563a2Sdrh /*
4923cce7d176Sdrh ** Generate code for a boolean expression such that a jump is made
4924cce7d176Sdrh ** to the label "dest" if the expression is true but execution
4925cce7d176Sdrh ** continues straight thru if the expression is false.
4926f5905aa7Sdrh **
4927f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false), then
492835573356Sdrh ** take the jump if the jumpIfNull flag is SQLITE_JUMPIFNULL.
4929f2bc013cSdrh **
4930f2bc013cSdrh ** This code depends on the fact that certain token values (ex: TK_EQ)
4931f2bc013cSdrh ** are the same as opcode values (ex: OP_Eq) that implement the corresponding
4932f2bc013cSdrh ** operation.  Special comments in vdbe.c and the mkopcodeh.awk script in
4933f2bc013cSdrh ** the make process cause these values to align.  Assert()s in the code
4934f2bc013cSdrh ** below verify that the numbers are aligned correctly.
4935cce7d176Sdrh */
49364adee20fSdanielk1977 void sqlite3ExprIfTrue(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
4937cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
4938cce7d176Sdrh   int op = 0;
49392dcef11bSdrh   int regFree1 = 0;
49402dcef11bSdrh   int regFree2 = 0;
49412dcef11bSdrh   int r1, r2;
49422dcef11bSdrh 
494335573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
494448864df9Smistachkin   if( NEVER(v==0) )     return;  /* Existence of VDBE checked by caller */
494533cd4909Sdrh   if( NEVER(pExpr==0) ) return;  /* No way this can happen */
4946e7375bfaSdrh   assert( !ExprHasVVAProperty(pExpr, EP_Immutable) );
4947f2bc013cSdrh   op = pExpr->op;
49487b35a77bSdan   switch( op ){
494917180fcaSdrh     case TK_AND:
495017180fcaSdrh     case TK_OR: {
495117180fcaSdrh       Expr *pAlt = sqlite3ExprSimplifiedAndOr(pExpr);
495217180fcaSdrh       if( pAlt!=pExpr ){
495317180fcaSdrh         sqlite3ExprIfTrue(pParse, pAlt, dest, jumpIfNull);
495417180fcaSdrh       }else if( op==TK_AND ){
4955ec4ccdbcSdrh         int d2 = sqlite3VdbeMakeLabel(pParse);
4956c5499befSdrh         testcase( jumpIfNull==0 );
495717180fcaSdrh         sqlite3ExprIfFalse(pParse, pExpr->pLeft, d2,
495817180fcaSdrh                            jumpIfNull^SQLITE_JUMPIFNULL);
49594adee20fSdanielk1977         sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
49604adee20fSdanielk1977         sqlite3VdbeResolveLabel(v, d2);
496117180fcaSdrh       }else{
4962c5499befSdrh         testcase( jumpIfNull==0 );
49634adee20fSdanielk1977         sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
49644adee20fSdanielk1977         sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
496517180fcaSdrh       }
4966cce7d176Sdrh       break;
4967cce7d176Sdrh     }
4968cce7d176Sdrh     case TK_NOT: {
4969c5499befSdrh       testcase( jumpIfNull==0 );
49704adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
4971cce7d176Sdrh       break;
4972cce7d176Sdrh     }
49738abed7b9Sdrh     case TK_TRUTH: {
497496acafbeSdrh       int isNot;      /* IS NOT TRUE or IS NOT FALSE */
497596acafbeSdrh       int isTrue;     /* IS TRUE or IS NOT TRUE */
4976007c843bSdrh       testcase( jumpIfNull==0 );
49778abed7b9Sdrh       isNot = pExpr->op2==TK_ISNOT;
497896acafbeSdrh       isTrue = sqlite3ExprTruthValue(pExpr->pRight);
497943c4ac8bSdrh       testcase( isTrue && isNot );
498096acafbeSdrh       testcase( !isTrue && isNot );
498143c4ac8bSdrh       if( isTrue ^ isNot ){
49828abed7b9Sdrh         sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
49838abed7b9Sdrh                           isNot ? SQLITE_JUMPIFNULL : 0);
49848abed7b9Sdrh       }else{
49858abed7b9Sdrh         sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
49868abed7b9Sdrh                            isNot ? SQLITE_JUMPIFNULL : 0);
49878abed7b9Sdrh       }
4988007c843bSdrh       break;
4989007c843bSdrh     }
4990de845c2fSdrh     case TK_IS:
4991de845c2fSdrh     case TK_ISNOT:
4992de845c2fSdrh       testcase( op==TK_IS );
4993de845c2fSdrh       testcase( op==TK_ISNOT );
4994de845c2fSdrh       op = (op==TK_IS) ? TK_EQ : TK_NE;
4995de845c2fSdrh       jumpIfNull = SQLITE_NULLEQ;
499608b92086Sdrh       /* no break */ deliberate_fall_through
4997cce7d176Sdrh     case TK_LT:
4998cce7d176Sdrh     case TK_LE:
4999cce7d176Sdrh     case TK_GT:
5000cce7d176Sdrh     case TK_GE:
5001cce7d176Sdrh     case TK_NE:
50020ac65892Sdrh     case TK_EQ: {
5003625015e0Sdan       if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
5004c5499befSdrh       testcase( jumpIfNull==0 );
5005b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
5006b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
500735573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
5008898c527eSdrh                   r1, r2, dest, jumpIfNull, ExprHasProperty(pExpr,EP_Commuted));
50097d176105Sdrh       assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
50107d176105Sdrh       assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
50117d176105Sdrh       assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
50127d176105Sdrh       assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
5013de845c2fSdrh       assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
5014de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
5015de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
5016de845c2fSdrh       assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
5017de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
5018de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
50196a2fe093Sdrh       testcase( regFree1==0 );
50206a2fe093Sdrh       testcase( regFree2==0 );
50216a2fe093Sdrh       break;
50226a2fe093Sdrh     }
5023cce7d176Sdrh     case TK_ISNULL:
5024cce7d176Sdrh     case TK_NOTNULL: {
50257d176105Sdrh       assert( TK_ISNULL==OP_IsNull );   testcase( op==TK_ISNULL );
50267d176105Sdrh       assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
50272dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
50282dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
50297d176105Sdrh       VdbeCoverageIf(v, op==TK_ISNULL);
50307d176105Sdrh       VdbeCoverageIf(v, op==TK_NOTNULL);
5031c5499befSdrh       testcase( regFree1==0 );
5032cce7d176Sdrh       break;
5033cce7d176Sdrh     }
5034fef5208cSdrh     case TK_BETWEEN: {
50355c03f30aSdrh       testcase( jumpIfNull==0 );
503671c57db0Sdan       exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfTrue, jumpIfNull);
5037fef5208cSdrh       break;
5038fef5208cSdrh     }
5039bb201344Sshaneh #ifndef SQLITE_OMIT_SUBQUERY
5040e3365e6cSdrh     case TK_IN: {
5041ec4ccdbcSdrh       int destIfFalse = sqlite3VdbeMakeLabel(pParse);
5042e3365e6cSdrh       int destIfNull = jumpIfNull ? dest : destIfFalse;
5043e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
5044076e85f5Sdrh       sqlite3VdbeGoto(v, dest);
5045e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
5046e3365e6cSdrh       break;
5047e3365e6cSdrh     }
5048bb201344Sshaneh #endif
5049cce7d176Sdrh     default: {
50507b35a77bSdan     default_expr:
5051ad31727fSdrh       if( ExprAlwaysTrue(pExpr) ){
5052076e85f5Sdrh         sqlite3VdbeGoto(v, dest);
5053ad31727fSdrh       }else if( ExprAlwaysFalse(pExpr) ){
5054991a1985Sdrh         /* No-op */
5055991a1985Sdrh       }else{
50562dcef11bSdrh         r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
50572dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_If, r1, dest, jumpIfNull!=0);
5058688852abSdrh         VdbeCoverage(v);
5059c5499befSdrh         testcase( regFree1==0 );
5060c5499befSdrh         testcase( jumpIfNull==0 );
5061991a1985Sdrh       }
5062cce7d176Sdrh       break;
5063cce7d176Sdrh     }
5064cce7d176Sdrh   }
50652dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
50662dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
5067cce7d176Sdrh }
5068cce7d176Sdrh 
5069cce7d176Sdrh /*
507066b89c8fSdrh ** Generate code for a boolean expression such that a jump is made
5071cce7d176Sdrh ** to the label "dest" if the expression is false but execution
5072cce7d176Sdrh ** continues straight thru if the expression is true.
5073f5905aa7Sdrh **
5074f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false) then
507535573356Sdrh ** jump if jumpIfNull is SQLITE_JUMPIFNULL or fall through if jumpIfNull
507635573356Sdrh ** is 0.
5077cce7d176Sdrh */
50784adee20fSdanielk1977 void sqlite3ExprIfFalse(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
5079cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
5080cce7d176Sdrh   int op = 0;
50812dcef11bSdrh   int regFree1 = 0;
50822dcef11bSdrh   int regFree2 = 0;
50832dcef11bSdrh   int r1, r2;
50842dcef11bSdrh 
508535573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
508648864df9Smistachkin   if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
508733cd4909Sdrh   if( pExpr==0 )    return;
5088e7375bfaSdrh   assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
5089f2bc013cSdrh 
5090f2bc013cSdrh   /* The value of pExpr->op and op are related as follows:
5091f2bc013cSdrh   **
5092f2bc013cSdrh   **       pExpr->op            op
5093f2bc013cSdrh   **       ---------          ----------
5094f2bc013cSdrh   **       TK_ISNULL          OP_NotNull
5095f2bc013cSdrh   **       TK_NOTNULL         OP_IsNull
5096f2bc013cSdrh   **       TK_NE              OP_Eq
5097f2bc013cSdrh   **       TK_EQ              OP_Ne
5098f2bc013cSdrh   **       TK_GT              OP_Le
5099f2bc013cSdrh   **       TK_LE              OP_Gt
5100f2bc013cSdrh   **       TK_GE              OP_Lt
5101f2bc013cSdrh   **       TK_LT              OP_Ge
5102f2bc013cSdrh   **
5103f2bc013cSdrh   ** For other values of pExpr->op, op is undefined and unused.
5104f2bc013cSdrh   ** The value of TK_ and OP_ constants are arranged such that we
5105f2bc013cSdrh   ** can compute the mapping above using the following expression.
5106f2bc013cSdrh   ** Assert()s verify that the computation is correct.
5107f2bc013cSdrh   */
5108f2bc013cSdrh   op = ((pExpr->op+(TK_ISNULL&1))^1)-(TK_ISNULL&1);
5109f2bc013cSdrh 
5110f2bc013cSdrh   /* Verify correct alignment of TK_ and OP_ constants
5111f2bc013cSdrh   */
5112f2bc013cSdrh   assert( pExpr->op!=TK_ISNULL || op==OP_NotNull );
5113f2bc013cSdrh   assert( pExpr->op!=TK_NOTNULL || op==OP_IsNull );
5114f2bc013cSdrh   assert( pExpr->op!=TK_NE || op==OP_Eq );
5115f2bc013cSdrh   assert( pExpr->op!=TK_EQ || op==OP_Ne );
5116f2bc013cSdrh   assert( pExpr->op!=TK_LT || op==OP_Ge );
5117f2bc013cSdrh   assert( pExpr->op!=TK_LE || op==OP_Gt );
5118f2bc013cSdrh   assert( pExpr->op!=TK_GT || op==OP_Le );
5119f2bc013cSdrh   assert( pExpr->op!=TK_GE || op==OP_Lt );
5120f2bc013cSdrh 
5121ba00e30aSdan   switch( pExpr->op ){
512217180fcaSdrh     case TK_AND:
512317180fcaSdrh     case TK_OR: {
512417180fcaSdrh       Expr *pAlt = sqlite3ExprSimplifiedAndOr(pExpr);
512517180fcaSdrh       if( pAlt!=pExpr ){
512617180fcaSdrh         sqlite3ExprIfFalse(pParse, pAlt, dest, jumpIfNull);
512717180fcaSdrh       }else if( pExpr->op==TK_AND ){
5128c5499befSdrh         testcase( jumpIfNull==0 );
51294adee20fSdanielk1977         sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
51304adee20fSdanielk1977         sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
513117180fcaSdrh       }else{
5132ec4ccdbcSdrh         int d2 = sqlite3VdbeMakeLabel(pParse);
5133c5499befSdrh         testcase( jumpIfNull==0 );
513417180fcaSdrh         sqlite3ExprIfTrue(pParse, pExpr->pLeft, d2,
513517180fcaSdrh                           jumpIfNull^SQLITE_JUMPIFNULL);
51364adee20fSdanielk1977         sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
51374adee20fSdanielk1977         sqlite3VdbeResolveLabel(v, d2);
513817180fcaSdrh       }
5139cce7d176Sdrh       break;
5140cce7d176Sdrh     }
5141cce7d176Sdrh     case TK_NOT: {
51425c03f30aSdrh       testcase( jumpIfNull==0 );
51434adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
5144cce7d176Sdrh       break;
5145cce7d176Sdrh     }
51468abed7b9Sdrh     case TK_TRUTH: {
514796acafbeSdrh       int isNot;   /* IS NOT TRUE or IS NOT FALSE */
514896acafbeSdrh       int isTrue;  /* IS TRUE or IS NOT TRUE */
51498abed7b9Sdrh       testcase( jumpIfNull==0 );
51508abed7b9Sdrh       isNot = pExpr->op2==TK_ISNOT;
515196acafbeSdrh       isTrue = sqlite3ExprTruthValue(pExpr->pRight);
515243c4ac8bSdrh       testcase( isTrue && isNot );
515396acafbeSdrh       testcase( !isTrue && isNot );
515443c4ac8bSdrh       if( isTrue ^ isNot ){
51558abed7b9Sdrh         /* IS TRUE and IS NOT FALSE */
51568abed7b9Sdrh         sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
51578abed7b9Sdrh                            isNot ? 0 : SQLITE_JUMPIFNULL);
51588abed7b9Sdrh 
51598abed7b9Sdrh       }else{
51608abed7b9Sdrh         /* IS FALSE and IS NOT TRUE */
51618abed7b9Sdrh         sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
51628abed7b9Sdrh                           isNot ? 0 : SQLITE_JUMPIFNULL);
51638abed7b9Sdrh       }
5164007c843bSdrh       break;
5165007c843bSdrh     }
5166de845c2fSdrh     case TK_IS:
5167de845c2fSdrh     case TK_ISNOT:
5168de845c2fSdrh       testcase( pExpr->op==TK_IS );
5169de845c2fSdrh       testcase( pExpr->op==TK_ISNOT );
5170de845c2fSdrh       op = (pExpr->op==TK_IS) ? TK_NE : TK_EQ;
5171de845c2fSdrh       jumpIfNull = SQLITE_NULLEQ;
517208b92086Sdrh       /* no break */ deliberate_fall_through
5173cce7d176Sdrh     case TK_LT:
5174cce7d176Sdrh     case TK_LE:
5175cce7d176Sdrh     case TK_GT:
5176cce7d176Sdrh     case TK_GE:
5177cce7d176Sdrh     case TK_NE:
5178cce7d176Sdrh     case TK_EQ: {
5179625015e0Sdan       if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
5180c5499befSdrh       testcase( jumpIfNull==0 );
5181b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
5182b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
518335573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
5184898c527eSdrh                   r1, r2, dest, jumpIfNull,ExprHasProperty(pExpr,EP_Commuted));
51857d176105Sdrh       assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
51867d176105Sdrh       assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
51877d176105Sdrh       assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
51887d176105Sdrh       assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
5189de845c2fSdrh       assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
5190de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
5191de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
5192de845c2fSdrh       assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
5193de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
5194de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
51956a2fe093Sdrh       testcase( regFree1==0 );
51966a2fe093Sdrh       testcase( regFree2==0 );
51976a2fe093Sdrh       break;
51986a2fe093Sdrh     }
5199cce7d176Sdrh     case TK_ISNULL:
5200cce7d176Sdrh     case TK_NOTNULL: {
52012dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
52022dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
52037d176105Sdrh       testcase( op==TK_ISNULL );   VdbeCoverageIf(v, op==TK_ISNULL);
52047d176105Sdrh       testcase( op==TK_NOTNULL );  VdbeCoverageIf(v, op==TK_NOTNULL);
5205c5499befSdrh       testcase( regFree1==0 );
5206cce7d176Sdrh       break;
5207cce7d176Sdrh     }
5208fef5208cSdrh     case TK_BETWEEN: {
52095c03f30aSdrh       testcase( jumpIfNull==0 );
521071c57db0Sdan       exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfFalse, jumpIfNull);
5211fef5208cSdrh       break;
5212fef5208cSdrh     }
5213bb201344Sshaneh #ifndef SQLITE_OMIT_SUBQUERY
5214e3365e6cSdrh     case TK_IN: {
5215e3365e6cSdrh       if( jumpIfNull ){
5216e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, dest);
5217e3365e6cSdrh       }else{
5218ec4ccdbcSdrh         int destIfNull = sqlite3VdbeMakeLabel(pParse);
5219e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, destIfNull);
5220e3365e6cSdrh         sqlite3VdbeResolveLabel(v, destIfNull);
5221e3365e6cSdrh       }
5222e3365e6cSdrh       break;
5223e3365e6cSdrh     }
5224bb201344Sshaneh #endif
5225cce7d176Sdrh     default: {
5226ba00e30aSdan     default_expr:
5227ad31727fSdrh       if( ExprAlwaysFalse(pExpr) ){
5228076e85f5Sdrh         sqlite3VdbeGoto(v, dest);
5229ad31727fSdrh       }else if( ExprAlwaysTrue(pExpr) ){
5230991a1985Sdrh         /* no-op */
5231991a1985Sdrh       }else{
52322dcef11bSdrh         r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
52332dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_IfNot, r1, dest, jumpIfNull!=0);
5234688852abSdrh         VdbeCoverage(v);
5235c5499befSdrh         testcase( regFree1==0 );
5236c5499befSdrh         testcase( jumpIfNull==0 );
5237991a1985Sdrh       }
5238cce7d176Sdrh       break;
5239cce7d176Sdrh     }
5240cce7d176Sdrh   }
52412dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
52422dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
5243cce7d176Sdrh }
52442282792aSdrh 
52452282792aSdrh /*
524672bc8208Sdrh ** Like sqlite3ExprIfFalse() except that a copy is made of pExpr before
524772bc8208Sdrh ** code generation, and that copy is deleted after code generation. This
524872bc8208Sdrh ** ensures that the original pExpr is unchanged.
524972bc8208Sdrh */
525072bc8208Sdrh void sqlite3ExprIfFalseDup(Parse *pParse, Expr *pExpr, int dest,int jumpIfNull){
525172bc8208Sdrh   sqlite3 *db = pParse->db;
525272bc8208Sdrh   Expr *pCopy = sqlite3ExprDup(db, pExpr, 0);
525372bc8208Sdrh   if( db->mallocFailed==0 ){
525472bc8208Sdrh     sqlite3ExprIfFalse(pParse, pCopy, dest, jumpIfNull);
525572bc8208Sdrh   }
525672bc8208Sdrh   sqlite3ExprDelete(db, pCopy);
525772bc8208Sdrh }
525872bc8208Sdrh 
52595aa550cfSdan /*
52605aa550cfSdan ** Expression pVar is guaranteed to be an SQL variable. pExpr may be any
52615aa550cfSdan ** type of expression.
52625aa550cfSdan **
52635aa550cfSdan ** If pExpr is a simple SQL value - an integer, real, string, blob
52645aa550cfSdan ** or NULL value - then the VDBE currently being prepared is configured
52655aa550cfSdan ** to re-prepare each time a new value is bound to variable pVar.
52665aa550cfSdan **
52675aa550cfSdan ** Additionally, if pExpr is a simple SQL value and the value is the
52685aa550cfSdan ** same as that currently bound to variable pVar, non-zero is returned.
52695aa550cfSdan ** Otherwise, if the values are not the same or if pExpr is not a simple
52705aa550cfSdan ** SQL value, zero is returned.
52715aa550cfSdan */
52725aa550cfSdan static int exprCompareVariable(Parse *pParse, Expr *pVar, Expr *pExpr){
52735aa550cfSdan   int res = 0;
5274c0804226Sdrh   int iVar;
5275c0804226Sdrh   sqlite3_value *pL, *pR = 0;
52765aa550cfSdan 
52775aa550cfSdan   sqlite3ValueFromExpr(pParse->db, pExpr, SQLITE_UTF8, SQLITE_AFF_BLOB, &pR);
5278c0804226Sdrh   if( pR ){
5279c0804226Sdrh     iVar = pVar->iColumn;
5280c0804226Sdrh     sqlite3VdbeSetVarmask(pParse->pVdbe, iVar);
5281c0804226Sdrh     pL = sqlite3VdbeGetBoundValue(pParse->pReprepare, iVar, SQLITE_AFF_BLOB);
52825aa307e2Sdrh     if( pL ){
52835aa307e2Sdrh       if( sqlite3_value_type(pL)==SQLITE_TEXT ){
52845aa307e2Sdrh         sqlite3_value_text(pL); /* Make sure the encoding is UTF-8 */
52855aa307e2Sdrh       }
52865aa307e2Sdrh       res =  0==sqlite3MemCompare(pL, pR, 0);
52875aa550cfSdan     }
52885aa550cfSdan     sqlite3ValueFree(pR);
52895aa550cfSdan     sqlite3ValueFree(pL);
52905aa550cfSdan   }
52915aa550cfSdan 
52925aa550cfSdan   return res;
52935aa550cfSdan }
529472bc8208Sdrh 
529572bc8208Sdrh /*
52961d9da70aSdrh ** Do a deep comparison of two expression trees.  Return 0 if the two
52971d9da70aSdrh ** expressions are completely identical.  Return 1 if they differ only
52981d9da70aSdrh ** by a COLLATE operator at the top level.  Return 2 if there are differences
52991d9da70aSdrh ** other than the top-level COLLATE operator.
5300d40aab0eSdrh **
5301619a1305Sdrh ** If any subelement of pB has Expr.iTable==(-1) then it is allowed
5302619a1305Sdrh ** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
5303619a1305Sdrh **
530466518ca7Sdrh ** The pA side might be using TK_REGISTER.  If that is the case and pB is
530566518ca7Sdrh ** not using TK_REGISTER but is otherwise equivalent, then still return 0.
530666518ca7Sdrh **
53071d9da70aSdrh ** Sometimes this routine will return 2 even if the two expressions
5308d40aab0eSdrh ** really are equivalent.  If we cannot prove that the expressions are
53091d9da70aSdrh ** identical, we return 2 just to be safe.  So if this routine
53101d9da70aSdrh ** returns 2, then you do not really know for certain if the two
53111d9da70aSdrh ** expressions are the same.  But if you get a 0 or 1 return, then you
5312d40aab0eSdrh ** can be sure the expressions are the same.  In the places where
53131d9da70aSdrh ** this routine is used, it does not hurt to get an extra 2 - that
5314d40aab0eSdrh ** just might result in some slightly slower code.  But returning
53151d9da70aSdrh ** an incorrect 0 or 1 could lead to a malfunction.
53165aa550cfSdan **
5317c0804226Sdrh ** If pParse is not NULL then TK_VARIABLE terms in pA with bindings in
5318c0804226Sdrh ** pParse->pReprepare can be matched against literals in pB.  The
5319c0804226Sdrh ** pParse->pVdbe->expmask bitmask is updated for each variable referenced.
5320c0804226Sdrh ** If pParse is NULL (the normal case) then any TK_VARIABLE term in
5321c0804226Sdrh ** Argument pParse should normally be NULL. If it is not NULL and pA or
5322c0804226Sdrh ** pB causes a return value of 2.
53232282792aSdrh */
53245aa550cfSdan int sqlite3ExprCompare(Parse *pParse, Expr *pA, Expr *pB, int iTab){
532510d1edf0Sdrh   u32 combinedFlags;
53264b202ae2Sdanielk1977   if( pA==0 || pB==0 ){
53271d9da70aSdrh     return pB==pA ? 0 : 2;
53282282792aSdrh   }
53295aa550cfSdan   if( pParse && pA->op==TK_VARIABLE && exprCompareVariable(pParse, pA, pB) ){
53305aa550cfSdan     return 0;
53315aa550cfSdan   }
533210d1edf0Sdrh   combinedFlags = pA->flags | pB->flags;
533310d1edf0Sdrh   if( combinedFlags & EP_IntValue ){
533410d1edf0Sdrh     if( (pA->flags&pB->flags&EP_IntValue)!=0 && pA->u.iValue==pB->u.iValue ){
533510d1edf0Sdrh       return 0;
533610d1edf0Sdrh     }
53371d9da70aSdrh     return 2;
53386ab3a2ecSdanielk1977   }
533916dd3985Sdan   if( pA->op!=pB->op || pA->op==TK_RAISE ){
53405aa550cfSdan     if( pA->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA->pLeft,pB,iTab)<2 ){
5341ae80ddeaSdrh       return 1;
5342ae80ddeaSdrh     }
53435aa550cfSdan     if( pB->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA,pB->pLeft,iTab)<2 ){
5344ae80ddeaSdrh       return 1;
5345ae80ddeaSdrh     }
5346ae80ddeaSdrh     return 2;
5347ae80ddeaSdrh   }
53482edc5fd7Sdrh   if( pA->op!=TK_COLUMN && pA->op!=TK_AGG_COLUMN && pA->u.zToken ){
53494f9adee2Sdan     if( pA->op==TK_FUNCTION || pA->op==TK_AGG_FUNCTION ){
5350390b88a4Sdrh       if( sqlite3StrICmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
5351eda079cdSdrh #ifndef SQLITE_OMIT_WINDOWFUNC
53524f9adee2Sdan       assert( pA->op==pB->op );
53534f9adee2Sdan       if( ExprHasProperty(pA,EP_WinFunc)!=ExprHasProperty(pB,EP_WinFunc) ){
53544f9adee2Sdan         return 2;
53554f9adee2Sdan       }
5356eda079cdSdrh       if( ExprHasProperty(pA,EP_WinFunc) ){
53574f9adee2Sdan         if( sqlite3WindowCompare(pParse, pA->y.pWin, pB->y.pWin, 1)!=0 ){
53584f9adee2Sdan           return 2;
53594f9adee2Sdan         }
5360eda079cdSdrh       }
5361eda079cdSdrh #endif
5362f20bbc5fSdrh     }else if( pA->op==TK_NULL ){
5363f20bbc5fSdrh       return 0;
5364d5af5420Sdrh     }else if( pA->op==TK_COLLATE ){
5365e79f6299Sdrh       if( sqlite3_stricmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
5366f20bbc5fSdrh     }else if( ALWAYS(pB->u.zToken!=0) && strcmp(pA->u.zToken,pB->u.zToken)!=0 ){
5367d5af5420Sdrh       return 2;
536810d1edf0Sdrh     }
536910d1edf0Sdrh   }
5370898c527eSdrh   if( (pA->flags & (EP_Distinct|EP_Commuted))
5371898c527eSdrh      != (pB->flags & (EP_Distinct|EP_Commuted)) ) return 2;
5372e7375bfaSdrh   if( ALWAYS((combinedFlags & EP_TokenOnly)==0) ){
537310d1edf0Sdrh     if( combinedFlags & EP_xIsSelect ) return 2;
5374efad2e23Sdrh     if( (combinedFlags & EP_FixedCol)==0
5375efad2e23Sdrh      && sqlite3ExprCompare(pParse, pA->pLeft, pB->pLeft, iTab) ) return 2;
53765aa550cfSdan     if( sqlite3ExprCompare(pParse, pA->pRight, pB->pRight, iTab) ) return 2;
5377619a1305Sdrh     if( sqlite3ExprListCompare(pA->x.pList, pB->x.pList, iTab) ) return 2;
537803c5c213Sdrh     if( pA->op!=TK_STRING
537903c5c213Sdrh      && pA->op!=TK_TRUEFALSE
5380e7375bfaSdrh      && ALWAYS((combinedFlags & EP_Reduced)==0)
538103c5c213Sdrh     ){
5382619a1305Sdrh       if( pA->iColumn!=pB->iColumn ) return 2;
53839b258c54Sdrh       if( pA->op2!=pB->op2 && pA->op==TK_TRUTH ) return 2;
53840f28e1bdSdrh       if( pA->op!=TK_IN && pA->iTable!=pB->iTable && pA->iTable!=iTab ){
53850f28e1bdSdrh         return 2;
53860f28e1bdSdrh       }
53871d9da70aSdrh     }
53881d9da70aSdrh   }
53892646da7eSdrh   return 0;
53902646da7eSdrh }
53912282792aSdrh 
53928c6f666bSdrh /*
5393fbb6e9ffSdan ** Compare two ExprList objects.  Return 0 if they are identical, 1
5394fbb6e9ffSdan ** if they are certainly different, or 2 if it is not possible to
5395fbb6e9ffSdan ** determine if they are identical or not.
53968c6f666bSdrh **
5397619a1305Sdrh ** If any subelement of pB has Expr.iTable==(-1) then it is allowed
5398619a1305Sdrh ** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
5399619a1305Sdrh **
54008c6f666bSdrh ** This routine might return non-zero for equivalent ExprLists.  The
54018c6f666bSdrh ** only consequence will be disabled optimizations.  But this routine
54028c6f666bSdrh ** must never return 0 if the two ExprList objects are different, or
54038c6f666bSdrh ** a malfunction will result.
54048c6f666bSdrh **
54058c6f666bSdrh ** Two NULL pointers are considered to be the same.  But a NULL pointer
54068c6f666bSdrh ** always differs from a non-NULL pointer.
54078c6f666bSdrh */
5408619a1305Sdrh int sqlite3ExprListCompare(ExprList *pA, ExprList *pB, int iTab){
54098c6f666bSdrh   int i;
54108c6f666bSdrh   if( pA==0 && pB==0 ) return 0;
54118c6f666bSdrh   if( pA==0 || pB==0 ) return 1;
54128c6f666bSdrh   if( pA->nExpr!=pB->nExpr ) return 1;
54138c6f666bSdrh   for(i=0; i<pA->nExpr; i++){
5414fbb6e9ffSdan     int res;
54158c6f666bSdrh     Expr *pExprA = pA->a[i].pExpr;
54168c6f666bSdrh     Expr *pExprB = pB->a[i].pExpr;
54176e11892dSdan     if( pA->a[i].sortFlags!=pB->a[i].sortFlags ) return 1;
5418fbb6e9ffSdan     if( (res = sqlite3ExprCompare(0, pExprA, pExprB, iTab)) ) return res;
54198c6f666bSdrh   }
54208c6f666bSdrh   return 0;
54218c6f666bSdrh }
542213449892Sdrh 
54232282792aSdrh /*
5424f9463dfbSdrh ** Like sqlite3ExprCompare() except COLLATE operators at the top-level
5425f9463dfbSdrh ** are ignored.
5426f9463dfbSdrh */
5427f9463dfbSdrh int sqlite3ExprCompareSkip(Expr *pA, Expr *pB, int iTab){
54285aa550cfSdan   return sqlite3ExprCompare(0,
54290d950af3Sdrh              sqlite3ExprSkipCollateAndLikely(pA),
54300d950af3Sdrh              sqlite3ExprSkipCollateAndLikely(pB),
5431f9463dfbSdrh              iTab);
5432f9463dfbSdrh }
5433f9463dfbSdrh 
5434f9463dfbSdrh /*
5435c51cf864Sdrh ** Return non-zero if Expr p can only be true if pNN is not NULL.
54367a231b49Sdrh **
54377a231b49Sdrh ** Or if seenNot is true, return non-zero if Expr p can only be
54387a231b49Sdrh ** non-NULL if pNN is not NULL
5439c51cf864Sdrh */
5440c51cf864Sdrh static int exprImpliesNotNull(
5441c51cf864Sdrh   Parse *pParse,      /* Parsing context */
5442c51cf864Sdrh   Expr *p,            /* The expression to be checked */
5443c51cf864Sdrh   Expr *pNN,          /* The expression that is NOT NULL */
5444c51cf864Sdrh   int iTab,           /* Table being evaluated */
54457a231b49Sdrh   int seenNot         /* Return true only if p can be any non-NULL value */
5446c51cf864Sdrh ){
5447c51cf864Sdrh   assert( p );
5448c51cf864Sdrh   assert( pNN );
544914c865e8Sdrh   if( sqlite3ExprCompare(pParse, p, pNN, iTab)==0 ){
545014c865e8Sdrh     return pNN->op!=TK_NULL;
545114c865e8Sdrh   }
5452c51cf864Sdrh   switch( p->op ){
5453c51cf864Sdrh     case TK_IN: {
5454c51cf864Sdrh       if( seenNot && ExprHasProperty(p, EP_xIsSelect) ) return 0;
5455c51cf864Sdrh       assert( ExprHasProperty(p,EP_xIsSelect)
5456c51cf864Sdrh            || (p->x.pList!=0 && p->x.pList->nExpr>0) );
5457ae144a1cSdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
5458c51cf864Sdrh     }
5459c51cf864Sdrh     case TK_BETWEEN: {
5460c51cf864Sdrh       ExprList *pList = p->x.pList;
5461c51cf864Sdrh       assert( pList!=0 );
5462c51cf864Sdrh       assert( pList->nExpr==2 );
5463c51cf864Sdrh       if( seenNot ) return 0;
54647a231b49Sdrh       if( exprImpliesNotNull(pParse, pList->a[0].pExpr, pNN, iTab, 1)
54657a231b49Sdrh        || exprImpliesNotNull(pParse, pList->a[1].pExpr, pNN, iTab, 1)
5466c51cf864Sdrh       ){
5467c51cf864Sdrh         return 1;
5468c51cf864Sdrh       }
54697a231b49Sdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
5470c51cf864Sdrh     }
5471c51cf864Sdrh     case TK_EQ:
5472c51cf864Sdrh     case TK_NE:
5473c51cf864Sdrh     case TK_LT:
5474c51cf864Sdrh     case TK_LE:
5475c51cf864Sdrh     case TK_GT:
5476c51cf864Sdrh     case TK_GE:
5477c51cf864Sdrh     case TK_PLUS:
5478c51cf864Sdrh     case TK_MINUS:
54799d23ea74Sdan     case TK_BITOR:
54809d23ea74Sdan     case TK_LSHIFT:
54819d23ea74Sdan     case TK_RSHIFT:
54829d23ea74Sdan     case TK_CONCAT:
54839d23ea74Sdan       seenNot = 1;
548408b92086Sdrh       /* no break */ deliberate_fall_through
5485c51cf864Sdrh     case TK_STAR:
5486c51cf864Sdrh     case TK_REM:
5487c51cf864Sdrh     case TK_BITAND:
54889d23ea74Sdan     case TK_SLASH: {
5489c51cf864Sdrh       if( exprImpliesNotNull(pParse, p->pRight, pNN, iTab, seenNot) ) return 1;
549008b92086Sdrh       /* no break */ deliberate_fall_through
5491c51cf864Sdrh     }
5492c51cf864Sdrh     case TK_SPAN:
5493c51cf864Sdrh     case TK_COLLATE:
5494c51cf864Sdrh     case TK_UPLUS:
5495c51cf864Sdrh     case TK_UMINUS: {
5496c51cf864Sdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, seenNot);
5497c51cf864Sdrh     }
5498c51cf864Sdrh     case TK_TRUTH: {
5499c51cf864Sdrh       if( seenNot ) return 0;
5500c51cf864Sdrh       if( p->op2!=TK_IS ) return 0;
550138cefc83Sdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
5502c51cf864Sdrh     }
55031cd382e3Sdan     case TK_BITNOT:
5504c51cf864Sdrh     case TK_NOT: {
5505c51cf864Sdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
5506c51cf864Sdrh     }
5507c51cf864Sdrh   }
5508c51cf864Sdrh   return 0;
5509c51cf864Sdrh }
5510c51cf864Sdrh 
5511c51cf864Sdrh /*
55124bd5f73fSdrh ** Return true if we can prove the pE2 will always be true if pE1 is
55134bd5f73fSdrh ** true.  Return false if we cannot complete the proof or if pE2 might
55144bd5f73fSdrh ** be false.  Examples:
55154bd5f73fSdrh **
5516619a1305Sdrh **     pE1: x==5       pE2: x==5             Result: true
55174bd5f73fSdrh **     pE1: x>0        pE2: x==5             Result: false
5518619a1305Sdrh **     pE1: x=21       pE2: x=21 OR y=43     Result: true
55194bd5f73fSdrh **     pE1: x!=123     pE2: x IS NOT NULL    Result: true
5520619a1305Sdrh **     pE1: x!=?1      pE2: x IS NOT NULL    Result: true
5521619a1305Sdrh **     pE1: x IS NULL  pE2: x IS NOT NULL    Result: false
5522619a1305Sdrh **     pE1: x IS ?2    pE2: x IS NOT NULL    Reuslt: false
55234bd5f73fSdrh **
55244bd5f73fSdrh ** When comparing TK_COLUMN nodes between pE1 and pE2, if pE2 has
55254bd5f73fSdrh ** Expr.iTable<0 then assume a table number given by iTab.
55264bd5f73fSdrh **
5527c0804226Sdrh ** If pParse is not NULL, then the values of bound variables in pE1 are
5528c0804226Sdrh ** compared against literal values in pE2 and pParse->pVdbe->expmask is
5529c0804226Sdrh ** modified to record which bound variables are referenced.  If pParse
5530c0804226Sdrh ** is NULL, then false will be returned if pE1 contains any bound variables.
5531c0804226Sdrh **
55324bd5f73fSdrh ** When in doubt, return false.  Returning true might give a performance
55334bd5f73fSdrh ** improvement.  Returning false might cause a performance reduction, but
55344bd5f73fSdrh ** it will always give the correct answer and is hence always safe.
55354bd5f73fSdrh */
55365aa550cfSdan int sqlite3ExprImpliesExpr(Parse *pParse, Expr *pE1, Expr *pE2, int iTab){
55375aa550cfSdan   if( sqlite3ExprCompare(pParse, pE1, pE2, iTab)==0 ){
5538619a1305Sdrh     return 1;
5539619a1305Sdrh   }
5540619a1305Sdrh   if( pE2->op==TK_OR
55415aa550cfSdan    && (sqlite3ExprImpliesExpr(pParse, pE1, pE2->pLeft, iTab)
55425aa550cfSdan              || sqlite3ExprImpliesExpr(pParse, pE1, pE2->pRight, iTab) )
5543619a1305Sdrh   ){
5544619a1305Sdrh     return 1;
5545619a1305Sdrh   }
5546664d6d13Sdrh   if( pE2->op==TK_NOTNULL
5547c51cf864Sdrh    && exprImpliesNotNull(pParse, pE1, pE2->pLeft, iTab, 0)
5548664d6d13Sdrh   ){
5549c51cf864Sdrh     return 1;
5550619a1305Sdrh   }
5551619a1305Sdrh   return 0;
55524bd5f73fSdrh }
55534bd5f73fSdrh 
55544bd5f73fSdrh /*
55556c68d759Sdrh ** This is the Expr node callback for sqlite3ExprImpliesNonNullRow().
55562589787cSdrh ** If the expression node requires that the table at pWalker->iCur
5557f8937f90Sdrh ** have one or more non-NULL column, then set pWalker->eCode to 1 and abort.
5558f8937f90Sdrh **
5559f8937f90Sdrh ** This routine controls an optimization.  False positives (setting
5560f8937f90Sdrh ** pWalker->eCode to 1 when it should not be) are deadly, but false-negatives
5561f8937f90Sdrh ** (never setting pWalker->eCode) is a harmless missed optimization.
55622589787cSdrh */
55632589787cSdrh static int impliesNotNullRow(Walker *pWalker, Expr *pExpr){
5564f8937f90Sdrh   testcase( pExpr->op==TK_AGG_COLUMN );
5565821b610bSdrh   testcase( pExpr->op==TK_AGG_FUNCTION );
55662589787cSdrh   if( ExprHasProperty(pExpr, EP_FromJoin) ) return WRC_Prune;
55672589787cSdrh   switch( pExpr->op ){
55680493222fSdan     case TK_ISNOT:
55692589787cSdrh     case TK_ISNULL:
5570d5793672Sdrh     case TK_NOTNULL:
55712589787cSdrh     case TK_IS:
55722589787cSdrh     case TK_OR:
55736c68d759Sdrh     case TK_VECTOR:
55742c492061Sdrh     case TK_CASE:
5575e3eff266Sdrh     case TK_IN:
55762589787cSdrh     case TK_FUNCTION:
5577da03c1e6Sdan     case TK_TRUTH:
55780493222fSdan       testcase( pExpr->op==TK_ISNOT );
5579821b610bSdrh       testcase( pExpr->op==TK_ISNULL );
5580d5793672Sdrh       testcase( pExpr->op==TK_NOTNULL );
5581821b610bSdrh       testcase( pExpr->op==TK_IS );
5582821b610bSdrh       testcase( pExpr->op==TK_OR );
55836c68d759Sdrh       testcase( pExpr->op==TK_VECTOR );
5584821b610bSdrh       testcase( pExpr->op==TK_CASE );
5585821b610bSdrh       testcase( pExpr->op==TK_IN );
5586821b610bSdrh       testcase( pExpr->op==TK_FUNCTION );
5587da03c1e6Sdan       testcase( pExpr->op==TK_TRUTH );
55882589787cSdrh       return WRC_Prune;
55892589787cSdrh     case TK_COLUMN:
55902589787cSdrh       if( pWalker->u.iCur==pExpr->iTable ){
55912589787cSdrh         pWalker->eCode = 1;
55922589787cSdrh         return WRC_Abort;
55932589787cSdrh       }
55942589787cSdrh       return WRC_Prune;
55959881155dSdrh 
55969d23ea74Sdan     case TK_AND:
5597aef81674Sdrh       if( pWalker->eCode==0 ){
55980287c951Sdan         sqlite3WalkExpr(pWalker, pExpr->pLeft);
55990287c951Sdan         if( pWalker->eCode ){
56000287c951Sdan           pWalker->eCode = 0;
56010287c951Sdan           sqlite3WalkExpr(pWalker, pExpr->pRight);
56029d23ea74Sdan         }
5603aef81674Sdrh       }
56049d23ea74Sdan       return WRC_Prune;
56059d23ea74Sdan 
56069d23ea74Sdan     case TK_BETWEEN:
56071d24a531Sdan       if( sqlite3WalkExpr(pWalker, pExpr->pLeft)==WRC_Abort ){
56081d24a531Sdan         assert( pWalker->eCode );
56091d24a531Sdan         return WRC_Abort;
56101d24a531Sdan       }
56119d23ea74Sdan       return WRC_Prune;
56129d23ea74Sdan 
56139881155dSdrh     /* Virtual tables are allowed to use constraints like x=NULL.  So
56149881155dSdrh     ** a term of the form x=y does not prove that y is not null if x
56159881155dSdrh     ** is the column of a virtual table */
56169881155dSdrh     case TK_EQ:
56179881155dSdrh     case TK_NE:
56189881155dSdrh     case TK_LT:
56199881155dSdrh     case TK_LE:
56209881155dSdrh     case TK_GT:
562178d1d225Sdrh     case TK_GE: {
562278d1d225Sdrh       Expr *pLeft = pExpr->pLeft;
562378d1d225Sdrh       Expr *pRight = pExpr->pRight;
56249881155dSdrh       testcase( pExpr->op==TK_EQ );
56259881155dSdrh       testcase( pExpr->op==TK_NE );
56269881155dSdrh       testcase( pExpr->op==TK_LT );
56279881155dSdrh       testcase( pExpr->op==TK_LE );
56289881155dSdrh       testcase( pExpr->op==TK_GT );
56299881155dSdrh       testcase( pExpr->op==TK_GE );
563078d1d225Sdrh       /* The y.pTab=0 assignment in wherecode.c always happens after the
563178d1d225Sdrh       ** impliesNotNullRow() test */
563278d1d225Sdrh       if( (pLeft->op==TK_COLUMN && ALWAYS(pLeft->y.pTab!=0)
563378d1d225Sdrh                                && IsVirtual(pLeft->y.pTab))
563478d1d225Sdrh        || (pRight->op==TK_COLUMN && ALWAYS(pRight->y.pTab!=0)
563578d1d225Sdrh                                && IsVirtual(pRight->y.pTab))
56369881155dSdrh       ){
56379881155dSdrh         return WRC_Prune;
56389881155dSdrh       }
563908b92086Sdrh       /* no break */ deliberate_fall_through
564078d1d225Sdrh     }
56412589787cSdrh     default:
56422589787cSdrh       return WRC_Continue;
56432589787cSdrh   }
56442589787cSdrh }
56452589787cSdrh 
56462589787cSdrh /*
56472589787cSdrh ** Return true (non-zero) if expression p can only be true if at least
56482589787cSdrh ** one column of table iTab is non-null.  In other words, return true
56492589787cSdrh ** if expression p will always be NULL or false if every column of iTab
56502589787cSdrh ** is NULL.
56512589787cSdrh **
5652821b610bSdrh ** False negatives are acceptable.  In other words, it is ok to return
5653821b610bSdrh ** zero even if expression p will never be true of every column of iTab
5654821b610bSdrh ** is NULL.  A false negative is merely a missed optimization opportunity.
5655821b610bSdrh **
5656821b610bSdrh ** False positives are not allowed, however.  A false positive may result
5657821b610bSdrh ** in an incorrect answer.
5658821b610bSdrh **
56592589787cSdrh ** Terms of p that are marked with EP_FromJoin (and hence that come from
56602589787cSdrh ** the ON or USING clauses of LEFT JOINS) are excluded from the analysis.
56612589787cSdrh **
56622589787cSdrh ** This routine is used to check if a LEFT JOIN can be converted into
56632589787cSdrh ** an ordinary JOIN.  The p argument is the WHERE clause.  If the WHERE
56642589787cSdrh ** clause requires that some column of the right table of the LEFT JOIN
56652589787cSdrh ** be non-NULL, then the LEFT JOIN can be safely converted into an
56662589787cSdrh ** ordinary join.
56672589787cSdrh */
56682589787cSdrh int sqlite3ExprImpliesNonNullRow(Expr *p, int iTab){
56692589787cSdrh   Walker w;
56700d950af3Sdrh   p = sqlite3ExprSkipCollateAndLikely(p);
56714a254f98Sdrh   if( p==0 ) return 0;
56724a254f98Sdrh   if( p->op==TK_NOTNULL ){
5673d6db6598Sdrh     p = p->pLeft;
5674a1698993Sdrh   }else{
5675a1698993Sdrh     while( p->op==TK_AND ){
56764a254f98Sdrh       if( sqlite3ExprImpliesNonNullRow(p->pLeft, iTab) ) return 1;
56774a254f98Sdrh       p = p->pRight;
5678d6db6598Sdrh     }
5679a1698993Sdrh   }
56802589787cSdrh   w.xExprCallback = impliesNotNullRow;
56812589787cSdrh   w.xSelectCallback = 0;
56822589787cSdrh   w.xSelectCallback2 = 0;
56832589787cSdrh   w.eCode = 0;
56842589787cSdrh   w.u.iCur = iTab;
56852589787cSdrh   sqlite3WalkExpr(&w, p);
56862589787cSdrh   return w.eCode;
56872589787cSdrh }
56882589787cSdrh 
56892589787cSdrh /*
5690030796dfSdrh ** An instance of the following structure is used by the tree walker
56912409f8a1Sdrh ** to determine if an expression can be evaluated by reference to the
56922409f8a1Sdrh ** index only, without having to do a search for the corresponding
56932409f8a1Sdrh ** table entry.  The IdxCover.pIdx field is the index.  IdxCover.iCur
56942409f8a1Sdrh ** is the cursor for the table.
56952409f8a1Sdrh */
56962409f8a1Sdrh struct IdxCover {
56972409f8a1Sdrh   Index *pIdx;     /* The index to be tested for coverage */
56982409f8a1Sdrh   int iCur;        /* Cursor number for the table corresponding to the index */
56992409f8a1Sdrh };
57002409f8a1Sdrh 
57012409f8a1Sdrh /*
57022409f8a1Sdrh ** Check to see if there are references to columns in table
57032409f8a1Sdrh ** pWalker->u.pIdxCover->iCur can be satisfied using the index
57042409f8a1Sdrh ** pWalker->u.pIdxCover->pIdx.
57052409f8a1Sdrh */
57062409f8a1Sdrh static int exprIdxCover(Walker *pWalker, Expr *pExpr){
57072409f8a1Sdrh   if( pExpr->op==TK_COLUMN
57082409f8a1Sdrh    && pExpr->iTable==pWalker->u.pIdxCover->iCur
5709b9bcf7caSdrh    && sqlite3TableColumnToIndex(pWalker->u.pIdxCover->pIdx, pExpr->iColumn)<0
57102409f8a1Sdrh   ){
57112409f8a1Sdrh     pWalker->eCode = 1;
57122409f8a1Sdrh     return WRC_Abort;
57132409f8a1Sdrh   }
57142409f8a1Sdrh   return WRC_Continue;
57152409f8a1Sdrh }
57162409f8a1Sdrh 
57172409f8a1Sdrh /*
5718e604ec0bSdrh ** Determine if an index pIdx on table with cursor iCur contains will
5719e604ec0bSdrh ** the expression pExpr.  Return true if the index does cover the
5720e604ec0bSdrh ** expression and false if the pExpr expression references table columns
5721e604ec0bSdrh ** that are not found in the index pIdx.
57222409f8a1Sdrh **
57232409f8a1Sdrh ** An index covering an expression means that the expression can be
57242409f8a1Sdrh ** evaluated using only the index and without having to lookup the
57252409f8a1Sdrh ** corresponding table entry.
57262409f8a1Sdrh */
57272409f8a1Sdrh int sqlite3ExprCoveredByIndex(
57282409f8a1Sdrh   Expr *pExpr,        /* The index to be tested */
57292409f8a1Sdrh   int iCur,           /* The cursor number for the corresponding table */
57302409f8a1Sdrh   Index *pIdx         /* The index that might be used for coverage */
57312409f8a1Sdrh ){
57322409f8a1Sdrh   Walker w;
57332409f8a1Sdrh   struct IdxCover xcov;
57342409f8a1Sdrh   memset(&w, 0, sizeof(w));
57352409f8a1Sdrh   xcov.iCur = iCur;
57362409f8a1Sdrh   xcov.pIdx = pIdx;
57372409f8a1Sdrh   w.xExprCallback = exprIdxCover;
57382409f8a1Sdrh   w.u.pIdxCover = &xcov;
57392409f8a1Sdrh   sqlite3WalkExpr(&w, pExpr);
57402409f8a1Sdrh   return !w.eCode;
57412409f8a1Sdrh }
57422409f8a1Sdrh 
57432409f8a1Sdrh 
57442409f8a1Sdrh /*
57452409f8a1Sdrh ** An instance of the following structure is used by the tree walker
5746030796dfSdrh ** to count references to table columns in the arguments of an
5747ed551b95Sdrh ** aggregate function, in order to implement the
5748ed551b95Sdrh ** sqlite3FunctionThisSrc() routine.
5749374fdce4Sdrh */
5750030796dfSdrh struct SrcCount {
5751030796dfSdrh   SrcList *pSrc;   /* One particular FROM clause in a nested query */
5752ed41a96bSdan   int iSrcInner;   /* Smallest cursor number in this context */
5753030796dfSdrh   int nThis;       /* Number of references to columns in pSrcList */
5754030796dfSdrh   int nOther;      /* Number of references to columns in other FROM clauses */
5755030796dfSdrh };
5756030796dfSdrh 
5757030796dfSdrh /*
5758ed41a96bSdan ** xSelect callback for sqlite3FunctionUsesThisSrc(). If this is the first
5759ed41a96bSdan ** SELECT with a FROM clause encountered during this iteration, set
5760ed41a96bSdan ** SrcCount.iSrcInner to the cursor number of the leftmost object in
5761ed41a96bSdan ** the FROM cause.
5762ed41a96bSdan */
5763ed41a96bSdan static int selectSrcCount(Walker *pWalker, Select *pSel){
5764ed41a96bSdan   struct SrcCount *p = pWalker->u.pSrcCount;
5765bc050b8fSdrh   if( p->iSrcInner==0x7FFFFFFF && ALWAYS(pSel->pSrc) && pSel->pSrc->nSrc ){
5766ed41a96bSdan     pWalker->u.pSrcCount->iSrcInner = pSel->pSrc->a[0].iCursor;
5767ed41a96bSdan   }
5768ed41a96bSdan   return WRC_Continue;
5769ed41a96bSdan }
5770ed41a96bSdan 
5771ed41a96bSdan /*
5772030796dfSdrh ** Count the number of references to columns.
5773030796dfSdrh */
5774030796dfSdrh static int exprSrcCount(Walker *pWalker, Expr *pExpr){
5775b4b36306Sdan   /* There was once a NEVER() on the second term on the grounds that
5776b4b36306Sdan   ** sqlite3FunctionUsesThisSrc() was always called before
5777b4b36306Sdan   ** sqlite3ExprAnalyzeAggregates() and so the TK_COLUMNs have not yet
5778b4b36306Sdan   ** been converted into TK_AGG_COLUMN. But this is no longer true due
5779b4b36306Sdan   ** to window functions - sqlite3WindowRewrite() may now indirectly call
5780b4b36306Sdan   ** FunctionUsesThisSrc() when creating a new sub-select. */
5781b4b36306Sdan   if( pExpr->op==TK_COLUMN || pExpr->op==TK_AGG_COLUMN ){
5782374fdce4Sdrh     int i;
5783030796dfSdrh     struct SrcCount *p = pWalker->u.pSrcCount;
5784030796dfSdrh     SrcList *pSrc = p->pSrc;
5785655814d2Sdrh     int nSrc = pSrc ? pSrc->nSrc : 0;
5786655814d2Sdrh     for(i=0; i<nSrc; i++){
5787030796dfSdrh       if( pExpr->iTable==pSrc->a[i].iCursor ) break;
5788374fdce4Sdrh     }
5789655814d2Sdrh     if( i<nSrc ){
5790030796dfSdrh       p->nThis++;
5791ed41a96bSdan     }else if( pExpr->iTable<p->iSrcInner ){
579280f6bfc0Sdrh       /* In a well-formed parse tree (no name resolution errors),
579335a38e08Sdrh       ** TK_COLUMN nodes with smaller Expr.iTable values are in an
579480f6bfc0Sdrh       ** outer context.  Those are the only ones to count as "other" */
5795030796dfSdrh       p->nOther++;
5796374fdce4Sdrh     }
5797374fdce4Sdrh   }
5798030796dfSdrh   return WRC_Continue;
5799030796dfSdrh }
5800374fdce4Sdrh 
5801374fdce4Sdrh /*
5802030796dfSdrh ** Determine if any of the arguments to the pExpr Function reference
5803030796dfSdrh ** pSrcList.  Return true if they do.  Also return true if the function
5804030796dfSdrh ** has no arguments or has only constant arguments.  Return false if pExpr
5805030796dfSdrh ** references columns but not columns of tables found in pSrcList.
5806374fdce4Sdrh */
5807030796dfSdrh int sqlite3FunctionUsesThisSrc(Expr *pExpr, SrcList *pSrcList){
5808374fdce4Sdrh   Walker w;
5809030796dfSdrh   struct SrcCount cnt;
5810374fdce4Sdrh   assert( pExpr->op==TK_AGG_FUNCTION );
581180f6bfc0Sdrh   memset(&w, 0, sizeof(w));
5812030796dfSdrh   w.xExprCallback = exprSrcCount;
5813ed41a96bSdan   w.xSelectCallback = selectSrcCount;
5814030796dfSdrh   w.u.pSrcCount = &cnt;
5815030796dfSdrh   cnt.pSrc = pSrcList;
5816ed41a96bSdan   cnt.iSrcInner = (pSrcList&&pSrcList->nSrc)?pSrcList->a[0].iCursor:0x7FFFFFFF;
5817030796dfSdrh   cnt.nThis = 0;
5818030796dfSdrh   cnt.nOther = 0;
5819030796dfSdrh   sqlite3WalkExprList(&w, pExpr->x.pList);
58205e484cb3Sdan #ifndef SQLITE_OMIT_WINDOWFUNC
58215e484cb3Sdan   if( ExprHasProperty(pExpr, EP_WinFunc) ){
58225e484cb3Sdan     sqlite3WalkExpr(&w, pExpr->y.pWin->pFilter);
58235e484cb3Sdan   }
58245e484cb3Sdan #endif
5825030796dfSdrh   return cnt.nThis>0 || cnt.nOther==0;
5826374fdce4Sdrh }
5827374fdce4Sdrh 
5828374fdce4Sdrh /*
582989636628Sdrh ** This is a Walker expression node callback.
583089636628Sdrh **
583189636628Sdrh ** For Expr nodes that contain pAggInfo pointers, make sure the AggInfo
583289636628Sdrh ** object that is referenced does not refer directly to the Expr.  If
583389636628Sdrh ** it does, make a copy.  This is done because the pExpr argument is
583489636628Sdrh ** subject to change.
583589636628Sdrh **
583689636628Sdrh ** The copy is stored on pParse->pConstExpr with a register number of 0.
583789636628Sdrh ** This will cause the expression to be deleted automatically when the
583889636628Sdrh ** Parse object is destroyed, but the zero register number means that it
583989636628Sdrh ** will not generate any code in the preamble.
584089636628Sdrh */
584189636628Sdrh static int agginfoPersistExprCb(Walker *pWalker, Expr *pExpr){
58422f82acc0Sdrh   if( ALWAYS(!ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced))
584389636628Sdrh    && pExpr->pAggInfo!=0
584489636628Sdrh   ){
584589636628Sdrh     AggInfo *pAggInfo = pExpr->pAggInfo;
584689636628Sdrh     int iAgg = pExpr->iAgg;
584789636628Sdrh     Parse *pParse = pWalker->pParse;
584889636628Sdrh     sqlite3 *db = pParse->db;
58492f82acc0Sdrh     assert( pExpr->op==TK_AGG_COLUMN || pExpr->op==TK_AGG_FUNCTION );
58502f82acc0Sdrh     if( pExpr->op==TK_AGG_COLUMN ){
585189636628Sdrh       assert( iAgg>=0 && iAgg<pAggInfo->nColumn );
585281185a51Sdrh       if( pAggInfo->aCol[iAgg].pCExpr==pExpr ){
585389636628Sdrh         pExpr = sqlite3ExprDup(db, pExpr, 0);
585489636628Sdrh         if( pExpr ){
585581185a51Sdrh           pAggInfo->aCol[iAgg].pCExpr = pExpr;
5856b3ad4e61Sdrh           sqlite3ExprDeferredDelete(pParse, pExpr);
585789636628Sdrh         }
585889636628Sdrh       }
585989636628Sdrh     }else{
586089636628Sdrh       assert( iAgg>=0 && iAgg<pAggInfo->nFunc );
586181185a51Sdrh       if( pAggInfo->aFunc[iAgg].pFExpr==pExpr ){
586289636628Sdrh         pExpr = sqlite3ExprDup(db, pExpr, 0);
586389636628Sdrh         if( pExpr ){
586481185a51Sdrh           pAggInfo->aFunc[iAgg].pFExpr = pExpr;
5865b3ad4e61Sdrh           sqlite3ExprDeferredDelete(pParse, pExpr);
586689636628Sdrh         }
586789636628Sdrh       }
586889636628Sdrh     }
586989636628Sdrh   }
587089636628Sdrh   return WRC_Continue;
587189636628Sdrh }
587289636628Sdrh 
587389636628Sdrh /*
587489636628Sdrh ** Initialize a Walker object so that will persist AggInfo entries referenced
587589636628Sdrh ** by the tree that is walked.
587689636628Sdrh */
587789636628Sdrh void sqlite3AggInfoPersistWalkerInit(Walker *pWalker, Parse *pParse){
587889636628Sdrh   memset(pWalker, 0, sizeof(*pWalker));
587989636628Sdrh   pWalker->pParse = pParse;
588089636628Sdrh   pWalker->xExprCallback = agginfoPersistExprCb;
588189636628Sdrh   pWalker->xSelectCallback = sqlite3SelectWalkNoop;
588289636628Sdrh }
588389636628Sdrh 
588489636628Sdrh /*
588513449892Sdrh ** Add a new element to the pAggInfo->aCol[] array.  Return the index of
588613449892Sdrh ** the new element.  Return a negative number if malloc fails.
58872282792aSdrh */
588817435752Sdrh static int addAggInfoColumn(sqlite3 *db, AggInfo *pInfo){
588913449892Sdrh   int i;
5890cf643729Sdrh   pInfo->aCol = sqlite3ArrayAllocate(
589117435752Sdrh        db,
5892cf643729Sdrh        pInfo->aCol,
5893cf643729Sdrh        sizeof(pInfo->aCol[0]),
5894cf643729Sdrh        &pInfo->nColumn,
5895cf643729Sdrh        &i
5896cf643729Sdrh   );
589713449892Sdrh   return i;
58982282792aSdrh }
589913449892Sdrh 
590013449892Sdrh /*
590113449892Sdrh ** Add a new element to the pAggInfo->aFunc[] array.  Return the index of
590213449892Sdrh ** the new element.  Return a negative number if malloc fails.
590313449892Sdrh */
590417435752Sdrh static int addAggInfoFunc(sqlite3 *db, AggInfo *pInfo){
590513449892Sdrh   int i;
5906cf643729Sdrh   pInfo->aFunc = sqlite3ArrayAllocate(
590717435752Sdrh        db,
5908cf643729Sdrh        pInfo->aFunc,
5909cf643729Sdrh        sizeof(pInfo->aFunc[0]),
5910cf643729Sdrh        &pInfo->nFunc,
5911cf643729Sdrh        &i
5912cf643729Sdrh   );
591313449892Sdrh   return i;
59142282792aSdrh }
59152282792aSdrh 
59162282792aSdrh /*
59177d10d5a6Sdrh ** This is the xExprCallback for a tree walker.  It is used to
59187d10d5a6Sdrh ** implement sqlite3ExprAnalyzeAggregates().  See sqlite3ExprAnalyzeAggregates
5919626a879aSdrh ** for additional information.
59202282792aSdrh */
59217d10d5a6Sdrh static int analyzeAggregate(Walker *pWalker, Expr *pExpr){
59222282792aSdrh   int i;
59237d10d5a6Sdrh   NameContext *pNC = pWalker->u.pNC;
5924a58fdfb1Sdanielk1977   Parse *pParse = pNC->pParse;
5925a58fdfb1Sdanielk1977   SrcList *pSrcList = pNC->pSrcList;
592625c3b8caSdrh   AggInfo *pAggInfo = pNC->uNC.pAggInfo;
592713449892Sdrh 
592825c3b8caSdrh   assert( pNC->ncFlags & NC_UAggInfo );
59292282792aSdrh   switch( pExpr->op ){
593089c69d00Sdrh     case TK_AGG_COLUMN:
5931967e8b73Sdrh     case TK_COLUMN: {
59328b213899Sdrh       testcase( pExpr->op==TK_AGG_COLUMN );
59338b213899Sdrh       testcase( pExpr->op==TK_COLUMN );
593413449892Sdrh       /* Check to see if the column is in one of the tables in the FROM
593513449892Sdrh       ** clause of the aggregate query */
593620bc393cSdrh       if( ALWAYS(pSrcList!=0) ){
59377601294aSdrh         SrcItem *pItem = pSrcList->a;
593813449892Sdrh         for(i=0; i<pSrcList->nSrc; i++, pItem++){
593913449892Sdrh           struct AggInfo_col *pCol;
5940c5cd1249Sdrh           assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
594113449892Sdrh           if( pExpr->iTable==pItem->iCursor ){
594213449892Sdrh             /* If we reach this point, it means that pExpr refers to a table
594313449892Sdrh             ** that is in the FROM clause of the aggregate query.
594413449892Sdrh             **
594513449892Sdrh             ** Make an entry for the column in pAggInfo->aCol[] if there
594613449892Sdrh             ** is not an entry there already.
594713449892Sdrh             */
59487f906d63Sdrh             int k;
594913449892Sdrh             pCol = pAggInfo->aCol;
59507f906d63Sdrh             for(k=0; k<pAggInfo->nColumn; k++, pCol++){
595113449892Sdrh               if( pCol->iTable==pExpr->iTable &&
595213449892Sdrh                   pCol->iColumn==pExpr->iColumn ){
59532282792aSdrh                 break;
59542282792aSdrh               }
59552282792aSdrh             }
59561e536953Sdanielk1977             if( (k>=pAggInfo->nColumn)
59571e536953Sdanielk1977              && (k = addAggInfoColumn(pParse->db, pAggInfo))>=0
59581e536953Sdanielk1977             ){
59597f906d63Sdrh               pCol = &pAggInfo->aCol[k];
5960eda079cdSdrh               pCol->pTab = pExpr->y.pTab;
596113449892Sdrh               pCol->iTable = pExpr->iTable;
596213449892Sdrh               pCol->iColumn = pExpr->iColumn;
59630a07c107Sdrh               pCol->iMem = ++pParse->nMem;
596413449892Sdrh               pCol->iSorterColumn = -1;
596581185a51Sdrh               pCol->pCExpr = pExpr;
596613449892Sdrh               if( pAggInfo->pGroupBy ){
596713449892Sdrh                 int j, n;
596813449892Sdrh                 ExprList *pGB = pAggInfo->pGroupBy;
596913449892Sdrh                 struct ExprList_item *pTerm = pGB->a;
597013449892Sdrh                 n = pGB->nExpr;
597113449892Sdrh                 for(j=0; j<n; j++, pTerm++){
597213449892Sdrh                   Expr *pE = pTerm->pExpr;
597313449892Sdrh                   if( pE->op==TK_COLUMN && pE->iTable==pExpr->iTable &&
597413449892Sdrh                       pE->iColumn==pExpr->iColumn ){
597513449892Sdrh                     pCol->iSorterColumn = j;
597613449892Sdrh                     break;
59772282792aSdrh                   }
597813449892Sdrh                 }
597913449892Sdrh               }
598013449892Sdrh               if( pCol->iSorterColumn<0 ){
598113449892Sdrh                 pCol->iSorterColumn = pAggInfo->nSortingColumn++;
598213449892Sdrh               }
598313449892Sdrh             }
598413449892Sdrh             /* There is now an entry for pExpr in pAggInfo->aCol[] (either
598513449892Sdrh             ** because it was there before or because we just created it).
598613449892Sdrh             ** Convert the pExpr to be a TK_AGG_COLUMN referring to that
598713449892Sdrh             ** pAggInfo->aCol[] entry.
598813449892Sdrh             */
5989ebb6a65dSdrh             ExprSetVVAProperty(pExpr, EP_NoReduce);
599013449892Sdrh             pExpr->pAggInfo = pAggInfo;
599113449892Sdrh             pExpr->op = TK_AGG_COLUMN;
5992cf697396Sshane             pExpr->iAgg = (i16)k;
599313449892Sdrh             break;
599413449892Sdrh           } /* endif pExpr->iTable==pItem->iCursor */
599513449892Sdrh         } /* end loop over pSrcList */
5996a58fdfb1Sdanielk1977       }
59977d10d5a6Sdrh       return WRC_Prune;
59982282792aSdrh     }
59992282792aSdrh     case TK_AGG_FUNCTION: {
60003a8c4be7Sdrh       if( (pNC->ncFlags & NC_InAggFunc)==0
6001ed551b95Sdrh        && pWalker->walkerDepth==pExpr->op2
60023a8c4be7Sdrh       ){
600313449892Sdrh         /* Check to see if pExpr is a duplicate of another aggregate
600413449892Sdrh         ** function that is already in the pAggInfo structure
600513449892Sdrh         */
600613449892Sdrh         struct AggInfo_func *pItem = pAggInfo->aFunc;
600713449892Sdrh         for(i=0; i<pAggInfo->nFunc; i++, pItem++){
6008*19e4eefbSdan           if( pItem->pFExpr==pExpr ) break;
600981185a51Sdrh           if( sqlite3ExprCompare(0, pItem->pFExpr, pExpr, -1)==0 ){
60102282792aSdrh             break;
60112282792aSdrh           }
60122282792aSdrh         }
601313449892Sdrh         if( i>=pAggInfo->nFunc ){
601413449892Sdrh           /* pExpr is original.  Make a new entry in pAggInfo->aFunc[]
601513449892Sdrh           */
601614db2665Sdanielk1977           u8 enc = ENC(pParse->db);
60171e536953Sdanielk1977           i = addAggInfoFunc(pParse->db, pAggInfo);
601813449892Sdrh           if( i>=0 ){
60196ab3a2ecSdanielk1977             assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
602013449892Sdrh             pItem = &pAggInfo->aFunc[i];
602181185a51Sdrh             pItem->pFExpr = pExpr;
60220a07c107Sdrh             pItem->iMem = ++pParse->nMem;
602333e619fcSdrh             assert( !ExprHasProperty(pExpr, EP_IntValue) );
602413449892Sdrh             pItem->pFunc = sqlite3FindFunction(pParse->db,
602580738d9cSdrh                    pExpr->u.zToken,
60266ab3a2ecSdanielk1977                    pExpr->x.pList ? pExpr->x.pList->nExpr : 0, enc, 0);
6027fd357974Sdrh             if( pExpr->flags & EP_Distinct ){
6028fd357974Sdrh               pItem->iDistinct = pParse->nTab++;
6029fd357974Sdrh             }else{
6030fd357974Sdrh               pItem->iDistinct = -1;
6031fd357974Sdrh             }
60322282792aSdrh           }
603313449892Sdrh         }
603413449892Sdrh         /* Make pExpr point to the appropriate pAggInfo->aFunc[] entry
603513449892Sdrh         */
6036c5cd1249Sdrh         assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
6037ebb6a65dSdrh         ExprSetVVAProperty(pExpr, EP_NoReduce);
6038cf697396Sshane         pExpr->iAgg = (i16)i;
603913449892Sdrh         pExpr->pAggInfo = pAggInfo;
60403a8c4be7Sdrh         return WRC_Prune;
60416e83a57fSdrh       }else{
60426e83a57fSdrh         return WRC_Continue;
60436e83a57fSdrh       }
60442282792aSdrh     }
6045a58fdfb1Sdanielk1977   }
60467d10d5a6Sdrh   return WRC_Continue;
60477d10d5a6Sdrh }
6048626a879aSdrh 
6049626a879aSdrh /*
6050e8abb4caSdrh ** Analyze the pExpr expression looking for aggregate functions and
6051e8abb4caSdrh ** for variables that need to be added to AggInfo object that pNC->pAggInfo
6052e8abb4caSdrh ** points to.  Additional entries are made on the AggInfo object as
6053e8abb4caSdrh ** necessary.
6054626a879aSdrh **
6055626a879aSdrh ** This routine should only be called after the expression has been
60567d10d5a6Sdrh ** analyzed by sqlite3ResolveExprNames().
6057626a879aSdrh */
6058d2b3e23bSdrh void sqlite3ExprAnalyzeAggregates(NameContext *pNC, Expr *pExpr){
60597d10d5a6Sdrh   Walker w;
60607d10d5a6Sdrh   w.xExprCallback = analyzeAggregate;
6061e40cc16bSdrh   w.xSelectCallback = sqlite3WalkerDepthIncrease;
6062e40cc16bSdrh   w.xSelectCallback2 = sqlite3WalkerDepthDecrease;
6063979dd1beSdrh   w.walkerDepth = 0;
60647d10d5a6Sdrh   w.u.pNC = pNC;
6065d9995031Sdan   w.pParse = 0;
606620bc393cSdrh   assert( pNC->pSrcList!=0 );
60677d10d5a6Sdrh   sqlite3WalkExpr(&w, pExpr);
60682282792aSdrh }
60695d9a4af9Sdrh 
60705d9a4af9Sdrh /*
60715d9a4af9Sdrh ** Call sqlite3ExprAnalyzeAggregates() for every expression in an
60725d9a4af9Sdrh ** expression list.  Return the number of errors.
60735d9a4af9Sdrh **
60745d9a4af9Sdrh ** If an error is found, the analysis is cut short.
60755d9a4af9Sdrh */
6076d2b3e23bSdrh void sqlite3ExprAnalyzeAggList(NameContext *pNC, ExprList *pList){
60775d9a4af9Sdrh   struct ExprList_item *pItem;
60785d9a4af9Sdrh   int i;
60795d9a4af9Sdrh   if( pList ){
6080d2b3e23bSdrh     for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
6081d2b3e23bSdrh       sqlite3ExprAnalyzeAggregates(pNC, pItem->pExpr);
60825d9a4af9Sdrh     }
60835d9a4af9Sdrh   }
60845d9a4af9Sdrh }
6085892d3179Sdrh 
6086892d3179Sdrh /*
6087ceea3321Sdrh ** Allocate a single new register for use to hold some intermediate result.
6088892d3179Sdrh */
6089892d3179Sdrh int sqlite3GetTempReg(Parse *pParse){
6090e55cbd72Sdrh   if( pParse->nTempReg==0 ){
6091892d3179Sdrh     return ++pParse->nMem;
6092892d3179Sdrh   }
60932f425f6bSdanielk1977   return pParse->aTempReg[--pParse->nTempReg];
6094892d3179Sdrh }
6095ceea3321Sdrh 
6096ceea3321Sdrh /*
6097ceea3321Sdrh ** Deallocate a register, making available for reuse for some other
6098ceea3321Sdrh ** purpose.
6099ceea3321Sdrh */
6100892d3179Sdrh void sqlite3ReleaseTempReg(Parse *pParse, int iReg){
610113d79502Sdrh   if( iReg ){
61023aef2fb1Sdrh     sqlite3VdbeReleaseRegisters(pParse, iReg, 1, 0, 0);
610313d79502Sdrh     if( pParse->nTempReg<ArraySize(pParse->aTempReg) ){
6104892d3179Sdrh       pParse->aTempReg[pParse->nTempReg++] = iReg;
6105892d3179Sdrh     }
6106892d3179Sdrh   }
610713d79502Sdrh }
6108892d3179Sdrh 
6109892d3179Sdrh /*
6110ed24da4bSdrh ** Allocate or deallocate a block of nReg consecutive registers.
6111892d3179Sdrh */
6112892d3179Sdrh int sqlite3GetTempRange(Parse *pParse, int nReg){
6113e55cbd72Sdrh   int i, n;
6114ed24da4bSdrh   if( nReg==1 ) return sqlite3GetTempReg(pParse);
6115892d3179Sdrh   i = pParse->iRangeReg;
6116e55cbd72Sdrh   n = pParse->nRangeReg;
6117f49f3523Sdrh   if( nReg<=n ){
6118892d3179Sdrh     pParse->iRangeReg += nReg;
6119892d3179Sdrh     pParse->nRangeReg -= nReg;
6120892d3179Sdrh   }else{
6121892d3179Sdrh     i = pParse->nMem+1;
6122892d3179Sdrh     pParse->nMem += nReg;
6123892d3179Sdrh   }
6124892d3179Sdrh   return i;
6125892d3179Sdrh }
6126892d3179Sdrh void sqlite3ReleaseTempRange(Parse *pParse, int iReg, int nReg){
6127ed24da4bSdrh   if( nReg==1 ){
6128ed24da4bSdrh     sqlite3ReleaseTempReg(pParse, iReg);
6129ed24da4bSdrh     return;
6130ed24da4bSdrh   }
61313aef2fb1Sdrh   sqlite3VdbeReleaseRegisters(pParse, iReg, nReg, 0, 0);
6132892d3179Sdrh   if( nReg>pParse->nRangeReg ){
6133892d3179Sdrh     pParse->nRangeReg = nReg;
6134892d3179Sdrh     pParse->iRangeReg = iReg;
6135892d3179Sdrh   }
6136892d3179Sdrh }
6137cdc69557Sdrh 
6138cdc69557Sdrh /*
6139cdc69557Sdrh ** Mark all temporary registers as being unavailable for reuse.
61406d2566dfSdrh **
61416d2566dfSdrh ** Always invoke this procedure after coding a subroutine or co-routine
61426d2566dfSdrh ** that might be invoked from other parts of the code, to ensure that
61436d2566dfSdrh ** the sub/co-routine does not use registers in common with the code that
61446d2566dfSdrh ** invokes the sub/co-routine.
6145cdc69557Sdrh */
6146cdc69557Sdrh void sqlite3ClearTempRegCache(Parse *pParse){
6147cdc69557Sdrh   pParse->nTempReg = 0;
6148cdc69557Sdrh   pParse->nRangeReg = 0;
6149cdc69557Sdrh }
6150bb9b5f26Sdrh 
6151bb9b5f26Sdrh /*
6152bb9b5f26Sdrh ** Validate that no temporary register falls within the range of
6153bb9b5f26Sdrh ** iFirst..iLast, inclusive.  This routine is only call from within assert()
6154bb9b5f26Sdrh ** statements.
6155bb9b5f26Sdrh */
6156bb9b5f26Sdrh #ifdef SQLITE_DEBUG
6157bb9b5f26Sdrh int sqlite3NoTempsInRange(Parse *pParse, int iFirst, int iLast){
6158bb9b5f26Sdrh   int i;
6159bb9b5f26Sdrh   if( pParse->nRangeReg>0
61603963e584Sdrh    && pParse->iRangeReg+pParse->nRangeReg > iFirst
61613963e584Sdrh    && pParse->iRangeReg <= iLast
6162bb9b5f26Sdrh   ){
6163bb9b5f26Sdrh      return 0;
6164bb9b5f26Sdrh   }
6165bb9b5f26Sdrh   for(i=0; i<pParse->nTempReg; i++){
6166bb9b5f26Sdrh     if( pParse->aTempReg[i]>=iFirst && pParse->aTempReg[i]<=iLast ){
6167bb9b5f26Sdrh       return 0;
6168bb9b5f26Sdrh     }
6169bb9b5f26Sdrh   }
6170bb9b5f26Sdrh   return 1;
6171bb9b5f26Sdrh }
6172bb9b5f26Sdrh #endif /* SQLITE_DEBUG */
6173