xref: /sqlite-3.40.0/src/expr.c (revision 3c6edc8a)
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 ){
989ffa258aSdrh   assert( pExpr!=0 || pParse->db->mallocFailed );
999ffa258aSdrh   if( pExpr==0 ) return 0;
1009ffa258aSdrh   if( pExpr->op==TK_VECTOR ){
1019ffa258aSdrh     ExprList *pList = pExpr->x.pList;
102197561cdSdrh     if( pList!=0 ){
1039ffa258aSdrh       int i;
1049ffa258aSdrh       for(i=0; i<pList->nExpr; i++){
1059ffa258aSdrh         pList->a[i].pExpr = sqlite3ExprAddCollateToken(pParse,pList->a[i].pExpr,
1069ffa258aSdrh                                                        pCollName, dequote);
1079ffa258aSdrh       }
1089ffa258aSdrh     }
1099ffa258aSdrh   }else if( pCollName->n>0 ){
11080103fc6Sdan     Expr *pNew = sqlite3ExprAlloc(pParse->db, TK_COLLATE, pCollName, dequote);
111ae80ddeaSdrh     if( pNew ){
112ae80ddeaSdrh       pNew->pLeft = pExpr;
113a4c3c87eSdrh       pNew->flags |= EP_Collate|EP_Skip;
1140a8a406eSdrh       pExpr = pNew;
115ae80ddeaSdrh     }
1160a8a406eSdrh   }
1170a8a406eSdrh   return pExpr;
1180a8a406eSdrh }
1190a8a406eSdrh Expr *sqlite3ExprAddCollateString(Parse *pParse, Expr *pExpr, const char *zC){
1200a8a406eSdrh   Token s;
121261d8a51Sdrh   assert( zC!=0 );
12240aced5cSdrh   sqlite3TokenInit(&s, (char*)zC);
12380103fc6Sdan   return sqlite3ExprAddCollateToken(pParse, pExpr, &s, 0);
1240a8a406eSdrh }
1250a8a406eSdrh 
1260a8a406eSdrh /*
1270d950af3Sdrh ** Skip over any TK_COLLATE operators.
1280a8a406eSdrh */
1290a8a406eSdrh Expr *sqlite3ExprSkipCollate(Expr *pExpr){
1300d950af3Sdrh   while( pExpr && ExprHasProperty(pExpr, EP_Skip) ){
13146fe138dSdrh     assert( pExpr->op==TK_COLLATE );
1320d950af3Sdrh     pExpr = pExpr->pLeft;
1330d950af3Sdrh   }
1340d950af3Sdrh   return pExpr;
1350d950af3Sdrh }
1360d950af3Sdrh 
1370d950af3Sdrh /*
1380d950af3Sdrh ** Skip over any TK_COLLATE operators and/or any unlikely()
1390d950af3Sdrh ** or likelihood() or likely() functions at the root of an
1400d950af3Sdrh ** expression.
1410d950af3Sdrh */
1420d950af3Sdrh Expr *sqlite3ExprSkipCollateAndLikely(Expr *pExpr){
143a7d6db6aSdrh   while( pExpr && ExprHasProperty(pExpr, EP_Skip|EP_Unlikely) ){
144a4c3c87eSdrh     if( ExprHasProperty(pExpr, EP_Unlikely) ){
145cca9f3d2Sdrh       assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
146cca9f3d2Sdrh       assert( pExpr->x.pList->nExpr>0 );
147a4c3c87eSdrh       assert( pExpr->op==TK_FUNCTION );
148cca9f3d2Sdrh       pExpr = pExpr->x.pList->a[0].pExpr;
149cca9f3d2Sdrh     }else{
15046fe138dSdrh       assert( pExpr->op==TK_COLLATE );
151d91eba96Sdrh       pExpr = pExpr->pLeft;
152cca9f3d2Sdrh     }
153d91eba96Sdrh   }
1540a8a406eSdrh   return pExpr;
1558b4c40d8Sdrh }
1568b4c40d8Sdrh 
1578b4c40d8Sdrh /*
158ae80ddeaSdrh ** Return the collation sequence for the expression pExpr. If
159ae80ddeaSdrh ** there is no defined collating sequence, return NULL.
160ae80ddeaSdrh **
16170efa84dSdrh ** See also: sqlite3ExprNNCollSeq()
16270efa84dSdrh **
16370efa84dSdrh ** The sqlite3ExprNNCollSeq() works the same exact that it returns the
16470efa84dSdrh ** default collation if pExpr has no defined collation.
16570efa84dSdrh **
166ae80ddeaSdrh ** The collating sequence might be determined by a COLLATE operator
167ae80ddeaSdrh ** or by the presence of a column with a defined collating sequence.
168ae80ddeaSdrh ** COLLATE operators take first precedence.  Left operands take
169ae80ddeaSdrh ** precedence over right operands.
1700202b29eSdanielk1977 */
171e7375bfaSdrh CollSeq *sqlite3ExprCollSeq(Parse *pParse, const Expr *pExpr){
172ae80ddeaSdrh   sqlite3 *db = pParse->db;
1737cedc8d4Sdanielk1977   CollSeq *pColl = 0;
174e7375bfaSdrh   const Expr *p = pExpr;
175261d8a51Sdrh   while( p ){
176ae80ddeaSdrh     int op = p->op;
177cb0e04f9Sdrh     if( op==TK_REGISTER ) op = p->op2;
178cb0e04f9Sdrh     if( (op==TK_AGG_COLUMN || op==TK_COLUMN || op==TK_TRIGGER)
179eda079cdSdrh      && p->y.pTab!=0
180ae80ddeaSdrh     ){
181eda079cdSdrh       /* op==TK_REGISTER && p->y.pTab!=0 happens when pExpr was originally
1827d10d5a6Sdrh       ** a TK_COLUMN but was previously evaluated and cached in a register */
1837d10d5a6Sdrh       int j = p->iColumn;
1847d10d5a6Sdrh       if( j>=0 ){
185eda079cdSdrh         const char *zColl = p->y.pTab->aCol[j].zColl;
186c4a64facSdrh         pColl = sqlite3FindCollSeq(db, ENC(db), zColl, 0);
1870202b29eSdanielk1977       }
1887d10d5a6Sdrh       break;
1897d10d5a6Sdrh     }
190e081d73cSdrh     if( op==TK_CAST || op==TK_UPLUS ){
191e081d73cSdrh       p = p->pLeft;
192e081d73cSdrh       continue;
193e081d73cSdrh     }
194269d322dSdrh     if( op==TK_VECTOR ){
195269d322dSdrh       p = p->x.pList->a[0].pExpr;
196269d322dSdrh       continue;
197269d322dSdrh     }
198cb0e04f9Sdrh     if( op==TK_COLLATE ){
199e081d73cSdrh       pColl = sqlite3GetCollSeq(pParse, ENC(db), 0, p->u.zToken);
200e081d73cSdrh       break;
201e081d73cSdrh     }
202ae80ddeaSdrh     if( p->flags & EP_Collate ){
2032308ed38Sdrh       if( p->pLeft && (p->pLeft->flags & EP_Collate)!=0 ){
2047d10d5a6Sdrh         p = p->pLeft;
205ae80ddeaSdrh       }else{
2062308ed38Sdrh         Expr *pNext  = p->pRight;
2076728cd91Sdrh         /* The Expr.x union is never used at the same time as Expr.pRight */
2086728cd91Sdrh         assert( p->x.pList==0 || p->pRight==0 );
20992a2824cSdrh         if( p->x.pList!=0
21092a2824cSdrh          && !db->mallocFailed
21192a2824cSdrh          && ALWAYS(!ExprHasProperty(p, EP_xIsSelect))
21292a2824cSdrh         ){
2132308ed38Sdrh           int i;
2145b107654Sdrh           for(i=0; ALWAYS(i<p->x.pList->nExpr); i++){
2152308ed38Sdrh             if( ExprHasProperty(p->x.pList->a[i].pExpr, EP_Collate) ){
2162308ed38Sdrh               pNext = p->x.pList->a[i].pExpr;
2172308ed38Sdrh               break;
2182308ed38Sdrh             }
2192308ed38Sdrh           }
2202308ed38Sdrh         }
2212308ed38Sdrh         p = pNext;
222ae80ddeaSdrh       }
223ae80ddeaSdrh     }else{
224ae80ddeaSdrh       break;
225ae80ddeaSdrh     }
2260202b29eSdanielk1977   }
2277cedc8d4Sdanielk1977   if( sqlite3CheckCollSeq(pParse, pColl) ){
2287cedc8d4Sdanielk1977     pColl = 0;
2297cedc8d4Sdanielk1977   }
2307cedc8d4Sdanielk1977   return pColl;
2310202b29eSdanielk1977 }
2320202b29eSdanielk1977 
2330202b29eSdanielk1977 /*
23470efa84dSdrh ** Return the collation sequence for the expression pExpr. If
23570efa84dSdrh ** there is no defined collating sequence, return a pointer to the
23670efa84dSdrh ** defautl collation sequence.
23770efa84dSdrh **
23870efa84dSdrh ** See also: sqlite3ExprCollSeq()
23970efa84dSdrh **
24070efa84dSdrh ** The sqlite3ExprCollSeq() routine works the same except that it
24170efa84dSdrh ** returns NULL if there is no defined collation.
24270efa84dSdrh */
243e7375bfaSdrh CollSeq *sqlite3ExprNNCollSeq(Parse *pParse, const Expr *pExpr){
24470efa84dSdrh   CollSeq *p = sqlite3ExprCollSeq(pParse, pExpr);
24570efa84dSdrh   if( p==0 ) p = pParse->db->pDfltColl;
24670efa84dSdrh   assert( p!=0 );
24770efa84dSdrh   return p;
24870efa84dSdrh }
24970efa84dSdrh 
25070efa84dSdrh /*
25170efa84dSdrh ** Return TRUE if the two expressions have equivalent collating sequences.
25270efa84dSdrh */
253e7375bfaSdrh int sqlite3ExprCollSeqMatch(Parse *pParse, const Expr *pE1, const Expr *pE2){
25470efa84dSdrh   CollSeq *pColl1 = sqlite3ExprNNCollSeq(pParse, pE1);
25570efa84dSdrh   CollSeq *pColl2 = sqlite3ExprNNCollSeq(pParse, pE2);
25670efa84dSdrh   return sqlite3StrICmp(pColl1->zName, pColl2->zName)==0;
25770efa84dSdrh }
25870efa84dSdrh 
25970efa84dSdrh /*
260626a879aSdrh ** pExpr is an operand of a comparison operator.  aff2 is the
261626a879aSdrh ** type affinity of the other operand.  This routine returns the
26253db1458Sdrh ** type affinity that should be used for the comparison operator.
26353db1458Sdrh */
264e7375bfaSdrh char sqlite3CompareAffinity(const Expr *pExpr, char aff2){
265bf3b721fSdanielk1977   char aff1 = sqlite3ExprAffinity(pExpr);
26696fb16eeSdrh   if( aff1>SQLITE_AFF_NONE && aff2>SQLITE_AFF_NONE ){
2678df447f0Sdrh     /* Both sides of the comparison are columns. If one has numeric
2688df447f0Sdrh     ** affinity, use that. Otherwise use no affinity.
269e014a838Sdanielk1977     */
2708a51256cSdrh     if( sqlite3IsNumericAffinity(aff1) || sqlite3IsNumericAffinity(aff2) ){
271e014a838Sdanielk1977       return SQLITE_AFF_NUMERIC;
272e014a838Sdanielk1977     }else{
27305883a34Sdrh       return SQLITE_AFF_BLOB;
274e014a838Sdanielk1977     }
275e014a838Sdanielk1977   }else{
276e014a838Sdanielk1977     /* One side is a column, the other is not. Use the columns affinity. */
27796fb16eeSdrh     assert( aff1<=SQLITE_AFF_NONE || aff2<=SQLITE_AFF_NONE );
27896fb16eeSdrh     return (aff1<=SQLITE_AFF_NONE ? aff2 : aff1) | SQLITE_AFF_NONE;
279e014a838Sdanielk1977   }
280e014a838Sdanielk1977 }
281e014a838Sdanielk1977 
28253db1458Sdrh /*
28353db1458Sdrh ** pExpr is a comparison operator.  Return the type affinity that should
28453db1458Sdrh ** be applied to both operands prior to doing the comparison.
28553db1458Sdrh */
286e7375bfaSdrh static char comparisonAffinity(const Expr *pExpr){
287e014a838Sdanielk1977   char aff;
288e014a838Sdanielk1977   assert( pExpr->op==TK_EQ || pExpr->op==TK_IN || pExpr->op==TK_LT ||
289e014a838Sdanielk1977           pExpr->op==TK_GT || pExpr->op==TK_GE || pExpr->op==TK_LE ||
2906a2fe093Sdrh           pExpr->op==TK_NE || pExpr->op==TK_IS || pExpr->op==TK_ISNOT );
291e014a838Sdanielk1977   assert( pExpr->pLeft );
292bf3b721fSdanielk1977   aff = sqlite3ExprAffinity(pExpr->pLeft);
293e014a838Sdanielk1977   if( pExpr->pRight ){
294e014a838Sdanielk1977     aff = sqlite3CompareAffinity(pExpr->pRight, aff);
2956ab3a2ecSdanielk1977   }else if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2966ab3a2ecSdanielk1977     aff = sqlite3CompareAffinity(pExpr->x.pSelect->pEList->a[0].pExpr, aff);
29713ac46eeSdrh   }else if( aff==0 ){
29805883a34Sdrh     aff = SQLITE_AFF_BLOB;
299e014a838Sdanielk1977   }
300e014a838Sdanielk1977   return aff;
301e014a838Sdanielk1977 }
302e014a838Sdanielk1977 
303e014a838Sdanielk1977 /*
304e014a838Sdanielk1977 ** pExpr is a comparison expression, eg. '=', '<', IN(...) etc.
305e014a838Sdanielk1977 ** idx_affinity is the affinity of an indexed column. Return true
306e014a838Sdanielk1977 ** if the index with affinity idx_affinity may be used to implement
307e014a838Sdanielk1977 ** the comparison in pExpr.
308e014a838Sdanielk1977 */
309e7375bfaSdrh int sqlite3IndexAffinityOk(const Expr *pExpr, char idx_affinity){
310e014a838Sdanielk1977   char aff = comparisonAffinity(pExpr);
311915e434cSdrh   if( aff<SQLITE_AFF_TEXT ){
3128a51256cSdrh     return 1;
3138a51256cSdrh   }
314915e434cSdrh   if( aff==SQLITE_AFF_TEXT ){
315915e434cSdrh     return idx_affinity==SQLITE_AFF_TEXT;
316915e434cSdrh   }
317915e434cSdrh   return sqlite3IsNumericAffinity(idx_affinity);
318e014a838Sdanielk1977 }
319e014a838Sdanielk1977 
320a37cdde0Sdanielk1977 /*
32135573356Sdrh ** Return the P5 value that should be used for a binary comparison
322a37cdde0Sdanielk1977 ** opcode (OP_Eq, OP_Ge etc.) used to compare pExpr1 and pExpr2.
323a37cdde0Sdanielk1977 */
324e7375bfaSdrh static u8 binaryCompareP5(
325e7375bfaSdrh   const Expr *pExpr1,   /* Left operand */
326e7375bfaSdrh   const Expr *pExpr2,   /* Right operand */
327e7375bfaSdrh   int jumpIfNull        /* Extra flags added to P5 */
328e7375bfaSdrh ){
32935573356Sdrh   u8 aff = (char)sqlite3ExprAffinity(pExpr2);
3301bd10f8aSdrh   aff = (u8)sqlite3CompareAffinity(pExpr1, aff) | (u8)jumpIfNull;
33135573356Sdrh   return aff;
332a37cdde0Sdanielk1977 }
333a37cdde0Sdanielk1977 
334a2e00042Sdrh /*
3350202b29eSdanielk1977 ** Return a pointer to the collation sequence that should be used by
3360202b29eSdanielk1977 ** a binary comparison operator comparing pLeft and pRight.
3370202b29eSdanielk1977 **
3380202b29eSdanielk1977 ** If the left hand expression has a collating sequence type, then it is
3390202b29eSdanielk1977 ** used. Otherwise the collation sequence for the right hand expression
3400202b29eSdanielk1977 ** is used, or the default (BINARY) if neither expression has a collating
3410202b29eSdanielk1977 ** type.
342bcbb04e5Sdanielk1977 **
343bcbb04e5Sdanielk1977 ** Argument pRight (but not pLeft) may be a null pointer. In this case,
344bcbb04e5Sdanielk1977 ** it is not considered.
3450202b29eSdanielk1977 */
346bcbb04e5Sdanielk1977 CollSeq *sqlite3BinaryCompareCollSeq(
347bcbb04e5Sdanielk1977   Parse *pParse,
348e7375bfaSdrh   const Expr *pLeft,
349e7375bfaSdrh   const Expr *pRight
350bcbb04e5Sdanielk1977 ){
351ec41ddacSdrh   CollSeq *pColl;
352ec41ddacSdrh   assert( pLeft );
353ae80ddeaSdrh   if( pLeft->flags & EP_Collate ){
354ae80ddeaSdrh     pColl = sqlite3ExprCollSeq(pParse, pLeft);
355ae80ddeaSdrh   }else if( pRight && (pRight->flags & EP_Collate)!=0 ){
356ae80ddeaSdrh     pColl = sqlite3ExprCollSeq(pParse, pRight);
357ec41ddacSdrh   }else{
358ec41ddacSdrh     pColl = sqlite3ExprCollSeq(pParse, pLeft);
3590202b29eSdanielk1977     if( !pColl ){
3607cedc8d4Sdanielk1977       pColl = sqlite3ExprCollSeq(pParse, pRight);
3610202b29eSdanielk1977     }
362ec41ddacSdrh   }
3630202b29eSdanielk1977   return pColl;
3640202b29eSdanielk1977 }
3650202b29eSdanielk1977 
366898c527eSdrh /* Expresssion p is a comparison operator.  Return a collation sequence
367898c527eSdrh ** appropriate for the comparison operator.
368898c527eSdrh **
369898c527eSdrh ** This is normally just a wrapper around sqlite3BinaryCompareCollSeq().
370898c527eSdrh ** However, if the OP_Commuted flag is set, then the order of the operands
371898c527eSdrh ** is reversed in the sqlite3BinaryCompareCollSeq() call so that the
372898c527eSdrh ** correct collating sequence is found.
373898c527eSdrh */
374e7375bfaSdrh CollSeq *sqlite3ExprCompareCollSeq(Parse *pParse, const Expr *p){
375898c527eSdrh   if( ExprHasProperty(p, EP_Commuted) ){
376898c527eSdrh     return sqlite3BinaryCompareCollSeq(pParse, p->pRight, p->pLeft);
377898c527eSdrh   }else{
378898c527eSdrh     return sqlite3BinaryCompareCollSeq(pParse, p->pLeft, p->pRight);
379898c527eSdrh   }
380898c527eSdrh }
381898c527eSdrh 
3820202b29eSdanielk1977 /*
383be5c89acSdrh ** Generate code for a comparison operator.
384be5c89acSdrh */
385be5c89acSdrh static int codeCompare(
386be5c89acSdrh   Parse *pParse,    /* The parsing (and code generating) context */
387be5c89acSdrh   Expr *pLeft,      /* The left operand */
388be5c89acSdrh   Expr *pRight,     /* The right operand */
389be5c89acSdrh   int opcode,       /* The comparison opcode */
39035573356Sdrh   int in1, int in2, /* Register holding operands */
391be5c89acSdrh   int dest,         /* Jump here if true.  */
392898c527eSdrh   int jumpIfNull,   /* If true, jump if either operand is NULL */
393898c527eSdrh   int isCommuted    /* The comparison has been commuted */
394be5c89acSdrh ){
39535573356Sdrh   int p5;
39635573356Sdrh   int addr;
39735573356Sdrh   CollSeq *p4;
39835573356Sdrh 
3998654186bSdrh   if( pParse->nErr ) return 0;
400898c527eSdrh   if( isCommuted ){
401898c527eSdrh     p4 = sqlite3BinaryCompareCollSeq(pParse, pRight, pLeft);
402898c527eSdrh   }else{
40335573356Sdrh     p4 = sqlite3BinaryCompareCollSeq(pParse, pLeft, pRight);
404898c527eSdrh   }
40535573356Sdrh   p5 = binaryCompareP5(pLeft, pRight, jumpIfNull);
40635573356Sdrh   addr = sqlite3VdbeAddOp4(pParse->pVdbe, opcode, in2, dest, in1,
40735573356Sdrh                            (void*)p4, P4_COLLSEQ);
4081bd10f8aSdrh   sqlite3VdbeChangeP5(pParse->pVdbe, (u8)p5);
40935573356Sdrh   return addr;
410be5c89acSdrh }
411be5c89acSdrh 
412cfbb5e82Sdan /*
413870a0705Sdan ** Return true if expression pExpr is a vector, or false otherwise.
414d832da7fSdrh **
415d832da7fSdrh ** A vector is defined as any expression that results in two or more
416d832da7fSdrh ** columns of result.  Every TK_VECTOR node is an vector because the
417d832da7fSdrh ** parser will not generate a TK_VECTOR with fewer than two entries.
418d832da7fSdrh ** But a TK_SELECT might be either a vector or a scalar. It is only
419d832da7fSdrh ** considered a vector if it has two or more result columns.
420870a0705Sdan */
421870a0705Sdan int sqlite3ExprIsVector(Expr *pExpr){
42276dbe7a8Sdrh   return sqlite3ExprVectorSize(pExpr)>1;
423870a0705Sdan }
424870a0705Sdan 
425870a0705Sdan /*
426cfbb5e82Sdan ** If the expression passed as the only argument is of type TK_VECTOR
427cfbb5e82Sdan ** return the number of expressions in the vector. Or, if the expression
428cfbb5e82Sdan ** is a sub-select, return the number of columns in the sub-select. For
429cfbb5e82Sdan ** any other type of expression, return 1.
430cfbb5e82Sdan */
43171c57db0Sdan int sqlite3ExprVectorSize(Expr *pExpr){
43212abf408Sdrh   u8 op = pExpr->op;
43312abf408Sdrh   if( op==TK_REGISTER ) op = pExpr->op2;
43412abf408Sdrh   if( op==TK_VECTOR ){
43571c57db0Sdan     return pExpr->x.pList->nExpr;
43612abf408Sdrh   }else if( op==TK_SELECT ){
43776dbe7a8Sdrh     return pExpr->x.pSelect->pEList->nExpr;
43876dbe7a8Sdrh   }else{
43976dbe7a8Sdrh     return 1;
44076dbe7a8Sdrh   }
44171c57db0Sdan }
44271c57db0Sdan 
443ba00e30aSdan /*
444fc7f27b9Sdrh ** Return a pointer to a subexpression of pVector that is the i-th
445fc7f27b9Sdrh ** column of the vector (numbered starting with 0).  The caller must
446fc7f27b9Sdrh ** ensure that i is within range.
447fc7f27b9Sdrh **
44876dbe7a8Sdrh ** If pVector is really a scalar (and "scalar" here includes subqueries
44976dbe7a8Sdrh ** that return a single column!) then return pVector unmodified.
45076dbe7a8Sdrh **
451fc7f27b9Sdrh ** pVector retains ownership of the returned subexpression.
452fc7f27b9Sdrh **
453fc7f27b9Sdrh ** If the vector is a (SELECT ...) then the expression returned is
45476dbe7a8Sdrh ** just the expression for the i-th term of the result set, and may
45576dbe7a8Sdrh ** not be ready for evaluation because the table cursor has not yet
45676dbe7a8Sdrh ** been positioned.
457ba00e30aSdan */
458fc7f27b9Sdrh Expr *sqlite3VectorFieldSubexpr(Expr *pVector, int i){
459870a0705Sdan   assert( i<sqlite3ExprVectorSize(pVector) );
460870a0705Sdan   if( sqlite3ExprIsVector(pVector) ){
4619f24b53dSdrh     assert( pVector->op2==0 || pVector->op==TK_REGISTER );
4629f24b53dSdrh     if( pVector->op==TK_SELECT || pVector->op2==TK_SELECT ){
46371c57db0Sdan       return pVector->x.pSelect->pEList->a[i].pExpr;
464870a0705Sdan     }else{
46571c57db0Sdan       return pVector->x.pList->a[i].pExpr;
46671c57db0Sdan     }
467870a0705Sdan   }
468870a0705Sdan   return pVector;
469870a0705Sdan }
470fc7f27b9Sdrh 
471fc7f27b9Sdrh /*
472fc7f27b9Sdrh ** Compute and return a new Expr object which when passed to
473fc7f27b9Sdrh ** sqlite3ExprCode() will generate all necessary code to compute
474fc7f27b9Sdrh ** the iField-th column of the vector expression pVector.
475fc7f27b9Sdrh **
4768762ec19Sdrh ** It is ok for pVector to be a scalar (as long as iField==0).
4778762ec19Sdrh ** In that case, this routine works like sqlite3ExprDup().
4788762ec19Sdrh **
479fc7f27b9Sdrh ** The caller owns the returned Expr object and is responsible for
480fc7f27b9Sdrh ** ensuring that the returned value eventually gets freed.
481fc7f27b9Sdrh **
4828762ec19Sdrh ** The caller retains ownership of pVector.  If pVector is a TK_SELECT,
483fad0e70cSdan ** then the returned object will reference pVector and so pVector must remain
4848762ec19Sdrh ** valid for the life of the returned object.  If pVector is a TK_VECTOR
4858762ec19Sdrh ** or a scalar expression, then it can be deleted as soon as this routine
48676dbe7a8Sdrh ** returns.
4878762ec19Sdrh **
4888762ec19Sdrh ** A trick to cause a TK_SELECT pVector to be deleted together with
4898762ec19Sdrh ** the returned Expr object is to attach the pVector to the pRight field
4908762ec19Sdrh ** of the returned TK_SELECT_COLUMN Expr object.
491fc7f27b9Sdrh */
492fc7f27b9Sdrh Expr *sqlite3ExprForVectorField(
493fc7f27b9Sdrh   Parse *pParse,       /* Parsing context */
494fc7f27b9Sdrh   Expr *pVector,       /* The vector.  List of expressions or a sub-SELECT */
495a1251bc4Sdrh   int iField           /* Which column of the vector to return */
496fc7f27b9Sdrh ){
497fc7f27b9Sdrh   Expr *pRet;
498a1251bc4Sdrh   if( pVector->op==TK_SELECT ){
499a1251bc4Sdrh     assert( pVector->flags & EP_xIsSelect );
500fc7f27b9Sdrh     /* The TK_SELECT_COLUMN Expr node:
501fc7f27b9Sdrh     **
502966e2911Sdrh     ** pLeft:           pVector containing TK_SELECT.  Not deleted.
5038762ec19Sdrh     ** pRight:          not used.  But recursively deleted.
504fc7f27b9Sdrh     ** iColumn:         Index of a column in pVector
505966e2911Sdrh     ** iTable:          0 or the number of columns on the LHS of an assignment
506fc7f27b9Sdrh     ** pLeft->iTable:   First in an array of register holding result, or 0
507fc7f27b9Sdrh     **                  if the result is not yet computed.
508fc7f27b9Sdrh     **
509fc7f27b9Sdrh     ** sqlite3ExprDelete() specifically skips the recursive delete of
510fc7f27b9Sdrh     ** pLeft on TK_SELECT_COLUMN nodes.  But pRight is followed, so pVector
5118762ec19Sdrh     ** can be attached to pRight to cause this node to take ownership of
5128762ec19Sdrh     ** pVector.  Typically there will be multiple TK_SELECT_COLUMN nodes
5138762ec19Sdrh     ** with the same pLeft pointer to the pVector, but only one of them
5148762ec19Sdrh     ** will own the pVector.
515fc7f27b9Sdrh     */
516abfd35eaSdrh     pRet = sqlite3PExpr(pParse, TK_SELECT_COLUMN, 0, 0);
5178bd0d58eSdrh     if( pRet ){
5188bd0d58eSdrh       pRet->iColumn = iField;
5198bd0d58eSdrh       pRet->pLeft = pVector;
5208bd0d58eSdrh     }
521fc7f27b9Sdrh     assert( pRet==0 || pRet->iTable==0 );
522fc7f27b9Sdrh   }else{
523a1251bc4Sdrh     if( pVector->op==TK_VECTOR ) pVector = pVector->x.pList->a[iField].pExpr;
524a1251bc4Sdrh     pRet = sqlite3ExprDup(pParse->db, pVector, 0);
525dfb5c963Sdan     sqlite3RenameTokenRemap(pParse, pRet, pVector);
526fc7f27b9Sdrh   }
527fc7f27b9Sdrh   return pRet;
528fc7f27b9Sdrh }
52971c57db0Sdan 
5305c288b92Sdan /*
5315c288b92Sdan ** If expression pExpr is of type TK_SELECT, generate code to evaluate
5325c288b92Sdan ** it. Return the register in which the result is stored (or, if the
5335c288b92Sdan ** sub-select returns more than one column, the first in an array
5345c288b92Sdan ** of registers in which the result is stored).
5355c288b92Sdan **
5365c288b92Sdan ** If pExpr is not a TK_SELECT expression, return 0.
5375c288b92Sdan */
5385c288b92Sdan static int exprCodeSubselect(Parse *pParse, Expr *pExpr){
5398da209b1Sdan   int reg = 0;
540f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
5415c288b92Sdan   if( pExpr->op==TK_SELECT ){
54285bcdce2Sdrh     reg = sqlite3CodeSubselect(pParse, pExpr);
5438da209b1Sdan   }
544f9b2e05cSdan #endif
5458da209b1Sdan   return reg;
5468da209b1Sdan }
5478da209b1Sdan 
5485c288b92Sdan /*
5495c288b92Sdan ** Argument pVector points to a vector expression - either a TK_VECTOR
550870a0705Sdan ** or TK_SELECT that returns more than one column. This function returns
551870a0705Sdan ** the register number of a register that contains the value of
552870a0705Sdan ** element iField of the vector.
553870a0705Sdan **
554870a0705Sdan ** If pVector is a TK_SELECT expression, then code for it must have
555870a0705Sdan ** already been generated using the exprCodeSubselect() routine. In this
556870a0705Sdan ** case parameter regSelect should be the first in an array of registers
557870a0705Sdan ** containing the results of the sub-select.
558870a0705Sdan **
559870a0705Sdan ** If pVector is of type TK_VECTOR, then code for the requested field
560870a0705Sdan ** is generated. In this case (*pRegFree) may be set to the number of
561870a0705Sdan ** a temporary register to be freed by the caller before returning.
5625c288b92Sdan **
5635c288b92Sdan ** Before returning, output parameter (*ppExpr) is set to point to the
5645c288b92Sdan ** Expr object corresponding to element iElem of the vector.
5655c288b92Sdan */
5665c288b92Sdan static int exprVectorRegister(
5675c288b92Sdan   Parse *pParse,                  /* Parse context */
5685c288b92Sdan   Expr *pVector,                  /* Vector to extract element from */
569870a0705Sdan   int iField,                     /* Field to extract from pVector */
5705c288b92Sdan   int regSelect,                  /* First in array of registers */
5715c288b92Sdan   Expr **ppExpr,                  /* OUT: Expression element */
5725c288b92Sdan   int *pRegFree                   /* OUT: Temp register to free */
5735c288b92Sdan ){
57412abf408Sdrh   u8 op = pVector->op;
575c1bcd9ccSdrh   assert( op==TK_VECTOR || op==TK_REGISTER || op==TK_SELECT );
57612abf408Sdrh   if( op==TK_REGISTER ){
57712abf408Sdrh     *ppExpr = sqlite3VectorFieldSubexpr(pVector, iField);
57812abf408Sdrh     return pVector->iTable+iField;
57912abf408Sdrh   }
58012abf408Sdrh   if( op==TK_SELECT ){
581870a0705Sdan     *ppExpr = pVector->x.pSelect->pEList->a[iField].pExpr;
582870a0705Sdan      return regSelect+iField;
5835c288b92Sdan   }
584870a0705Sdan   *ppExpr = pVector->x.pList->a[iField].pExpr;
5855c288b92Sdan   return sqlite3ExprCodeTemp(pParse, *ppExpr, pRegFree);
5865c288b92Sdan }
5875c288b92Sdan 
5885c288b92Sdan /*
5895c288b92Sdan ** Expression pExpr is a comparison between two vector values. Compute
59079752b6eSdrh ** the result of the comparison (1, 0, or NULL) and write that
59179752b6eSdrh ** result into register dest.
59279752b6eSdrh **
59379752b6eSdrh ** The caller must satisfy the following preconditions:
59479752b6eSdrh **
59579752b6eSdrh **    if pExpr->op==TK_IS:      op==TK_EQ and p5==SQLITE_NULLEQ
59679752b6eSdrh **    if pExpr->op==TK_ISNOT:   op==TK_NE and p5==SQLITE_NULLEQ
59779752b6eSdrh **    otherwise:                op==pExpr->op and p5==0
5985c288b92Sdan */
59979752b6eSdrh static void codeVectorCompare(
60079752b6eSdrh   Parse *pParse,        /* Code generator context */
60179752b6eSdrh   Expr *pExpr,          /* The comparison operation */
60279752b6eSdrh   int dest,             /* Write results into this register */
60379752b6eSdrh   u8 op,                /* Comparison operator */
60479752b6eSdrh   u8 p5                 /* SQLITE_NULLEQ or zero */
60579752b6eSdrh ){
60671c57db0Sdan   Vdbe *v = pParse->pVdbe;
60771c57db0Sdan   Expr *pLeft = pExpr->pLeft;
60871c57db0Sdan   Expr *pRight = pExpr->pRight;
60971c57db0Sdan   int nLeft = sqlite3ExprVectorSize(pLeft);
61071c57db0Sdan   int i;
61171c57db0Sdan   int regLeft = 0;
61271c57db0Sdan   int regRight = 0;
61379752b6eSdrh   u8 opx = op;
6144bc20452Sdrh   int addrCmp = 0;
615ec4ccdbcSdrh   int addrDone = sqlite3VdbeMakeLabel(pParse);
616898c527eSdrh   int isCommuted = ExprHasProperty(pExpr,EP_Commuted);
61771c57db0Sdan 
618e7375bfaSdrh   assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
619340fd0bcSdrh   if( pParse->nErr ) return;
620245ce62eSdrh   if( nLeft!=sqlite3ExprVectorSize(pRight) ){
621245ce62eSdrh     sqlite3ErrorMsg(pParse, "row value misused");
622245ce62eSdrh     return;
623245ce62eSdrh   }
62471c57db0Sdan   assert( pExpr->op==TK_EQ || pExpr->op==TK_NE
62571c57db0Sdan        || pExpr->op==TK_IS || pExpr->op==TK_ISNOT
62671c57db0Sdan        || pExpr->op==TK_LT || pExpr->op==TK_GT
62771c57db0Sdan        || pExpr->op==TK_LE || pExpr->op==TK_GE
62871c57db0Sdan   );
62979752b6eSdrh   assert( pExpr->op==op || (pExpr->op==TK_IS && op==TK_EQ)
63079752b6eSdrh             || (pExpr->op==TK_ISNOT && op==TK_NE) );
63179752b6eSdrh   assert( p5==0 || pExpr->op!=op );
63279752b6eSdrh   assert( p5==SQLITE_NULLEQ || pExpr->op==op );
63371c57db0Sdan 
6344bc20452Sdrh   if( op==TK_LE ) opx = TK_LT;
6354bc20452Sdrh   if( op==TK_GE ) opx = TK_GT;
6364bc20452Sdrh   if( op==TK_NE ) opx = TK_EQ;
6375c288b92Sdan 
6385c288b92Sdan   regLeft = exprCodeSubselect(pParse, pLeft);
6395c288b92Sdan   regRight = exprCodeSubselect(pParse, pRight);
6405c288b92Sdan 
6414bc20452Sdrh   sqlite3VdbeAddOp2(v, OP_Integer, 1, dest);
642321e828dSdrh   for(i=0; 1 /*Loop exits by "break"*/; i++){
6435c288b92Sdan     int regFree1 = 0, regFree2 = 0;
6445c288b92Sdan     Expr *pL, *pR;
6455c288b92Sdan     int r1, r2;
646321e828dSdrh     assert( i>=0 && i<nLeft );
6474bc20452Sdrh     if( addrCmp ) sqlite3VdbeJumpHere(v, addrCmp);
6485c288b92Sdan     r1 = exprVectorRegister(pParse, pLeft, i, regLeft, &pL, &regFree1);
6495c288b92Sdan     r2 = exprVectorRegister(pParse, pRight, i, regRight, &pR, &regFree2);
6504bc20452Sdrh     addrCmp = sqlite3VdbeCurrentAddr(v);
6514bc20452Sdrh     codeCompare(pParse, pL, pR, opx, r1, r2, addrDone, p5, isCommuted);
65279752b6eSdrh     testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
65379752b6eSdrh     testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
65479752b6eSdrh     testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
65579752b6eSdrh     testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
65679752b6eSdrh     testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
65779752b6eSdrh     testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
65871c57db0Sdan     sqlite3ReleaseTempReg(pParse, regFree1);
65971c57db0Sdan     sqlite3ReleaseTempReg(pParse, regFree2);
6604bc20452Sdrh     if( (opx==TK_LT || opx==TK_GT) && i<nLeft-1 ){
6614bc20452Sdrh       addrCmp = sqlite3VdbeAddOp0(v, OP_ElseEq);
6624bc20452Sdrh       testcase(opx==TK_LT); VdbeCoverageIf(v,opx==TK_LT);
6634bc20452Sdrh       testcase(opx==TK_GT); VdbeCoverageIf(v,opx==TK_GT);
6644bc20452Sdrh     }
6654bc20452Sdrh     if( p5==SQLITE_NULLEQ ){
6664bc20452Sdrh       sqlite3VdbeAddOp2(v, OP_Integer, 0, dest);
6674bc20452Sdrh     }else{
6684bc20452Sdrh       sqlite3VdbeAddOp3(v, OP_ZeroOrNull, r1, dest, r2);
6694bc20452Sdrh     }
67079752b6eSdrh     if( i==nLeft-1 ){
67179752b6eSdrh       break;
67271c57db0Sdan     }
67379752b6eSdrh     if( opx==TK_EQ ){
6744bc20452Sdrh       sqlite3VdbeAddOp2(v, OP_NotNull, dest, addrDone); VdbeCoverage(v);
675a2f62925Sdrh     }else{
676a2f62925Sdrh       assert( op==TK_LT || op==TK_GT || op==TK_LE || op==TK_GE );
6774bc20452Sdrh       sqlite3VdbeAddOp2(v, OP_Goto, 0, addrDone);
67879752b6eSdrh       if( i==nLeft-2 ) opx = op;
67971c57db0Sdan     }
68079752b6eSdrh   }
6814bc20452Sdrh   sqlite3VdbeJumpHere(v, addrCmp);
68279752b6eSdrh   sqlite3VdbeResolveLabel(v, addrDone);
6834bc20452Sdrh   if( op==TK_NE ){
6844bc20452Sdrh     sqlite3VdbeAddOp2(v, OP_Not, dest, dest);
6854bc20452Sdrh   }
68679752b6eSdrh }
68771c57db0Sdan 
6884b5255acSdanielk1977 #if SQLITE_MAX_EXPR_DEPTH>0
6894b5255acSdanielk1977 /*
6904b5255acSdanielk1977 ** Check that argument nHeight is less than or equal to the maximum
6914b5255acSdanielk1977 ** expression depth allowed. If it is not, leave an error message in
6924b5255acSdanielk1977 ** pParse.
6934b5255acSdanielk1977 */
6947d10d5a6Sdrh int sqlite3ExprCheckHeight(Parse *pParse, int nHeight){
6954b5255acSdanielk1977   int rc = SQLITE_OK;
6964b5255acSdanielk1977   int mxHeight = pParse->db->aLimit[SQLITE_LIMIT_EXPR_DEPTH];
6974b5255acSdanielk1977   if( nHeight>mxHeight ){
6984b5255acSdanielk1977     sqlite3ErrorMsg(pParse,
6994b5255acSdanielk1977        "Expression tree is too large (maximum depth %d)", mxHeight
7004b5255acSdanielk1977     );
7014b5255acSdanielk1977     rc = SQLITE_ERROR;
7024b5255acSdanielk1977   }
7034b5255acSdanielk1977   return rc;
7044b5255acSdanielk1977 }
7054b5255acSdanielk1977 
7064b5255acSdanielk1977 /* The following three functions, heightOfExpr(), heightOfExprList()
7074b5255acSdanielk1977 ** and heightOfSelect(), are used to determine the maximum height
7084b5255acSdanielk1977 ** of any expression tree referenced by the structure passed as the
7094b5255acSdanielk1977 ** first argument.
7104b5255acSdanielk1977 **
7114b5255acSdanielk1977 ** If this maximum height is greater than the current value pointed
7124b5255acSdanielk1977 ** to by pnHeight, the second parameter, then set *pnHeight to that
7134b5255acSdanielk1977 ** value.
7144b5255acSdanielk1977 */
7154b5255acSdanielk1977 static void heightOfExpr(Expr *p, int *pnHeight){
7164b5255acSdanielk1977   if( p ){
7174b5255acSdanielk1977     if( p->nHeight>*pnHeight ){
7184b5255acSdanielk1977       *pnHeight = p->nHeight;
7194b5255acSdanielk1977     }
7204b5255acSdanielk1977   }
7214b5255acSdanielk1977 }
7224b5255acSdanielk1977 static void heightOfExprList(ExprList *p, int *pnHeight){
7234b5255acSdanielk1977   if( p ){
7244b5255acSdanielk1977     int i;
7254b5255acSdanielk1977     for(i=0; i<p->nExpr; i++){
7264b5255acSdanielk1977       heightOfExpr(p->a[i].pExpr, pnHeight);
7274b5255acSdanielk1977     }
7284b5255acSdanielk1977   }
7294b5255acSdanielk1977 }
7301a3a3086Sdan static void heightOfSelect(Select *pSelect, int *pnHeight){
7311a3a3086Sdan   Select *p;
7321a3a3086Sdan   for(p=pSelect; p; p=p->pPrior){
7334b5255acSdanielk1977     heightOfExpr(p->pWhere, pnHeight);
7344b5255acSdanielk1977     heightOfExpr(p->pHaving, pnHeight);
7354b5255acSdanielk1977     heightOfExpr(p->pLimit, pnHeight);
7364b5255acSdanielk1977     heightOfExprList(p->pEList, pnHeight);
7374b5255acSdanielk1977     heightOfExprList(p->pGroupBy, pnHeight);
7384b5255acSdanielk1977     heightOfExprList(p->pOrderBy, pnHeight);
7394b5255acSdanielk1977   }
7404b5255acSdanielk1977 }
7414b5255acSdanielk1977 
7424b5255acSdanielk1977 /*
7434b5255acSdanielk1977 ** Set the Expr.nHeight variable in the structure passed as an
7444b5255acSdanielk1977 ** argument. An expression with no children, Expr.pList or
7454b5255acSdanielk1977 ** Expr.pSelect member has a height of 1. Any other expression
7464b5255acSdanielk1977 ** has a height equal to the maximum height of any other
7474b5255acSdanielk1977 ** referenced Expr plus one.
7482308ed38Sdrh **
7492308ed38Sdrh ** Also propagate EP_Propagate flags up from Expr.x.pList to Expr.flags,
7502308ed38Sdrh ** if appropriate.
7514b5255acSdanielk1977 */
7524b5255acSdanielk1977 static void exprSetHeight(Expr *p){
7534b5255acSdanielk1977   int nHeight = 0;
7544b5255acSdanielk1977   heightOfExpr(p->pLeft, &nHeight);
7554b5255acSdanielk1977   heightOfExpr(p->pRight, &nHeight);
7566ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_xIsSelect) ){
7576ab3a2ecSdanielk1977     heightOfSelect(p->x.pSelect, &nHeight);
7582308ed38Sdrh   }else if( p->x.pList ){
7596ab3a2ecSdanielk1977     heightOfExprList(p->x.pList, &nHeight);
7602308ed38Sdrh     p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
7616ab3a2ecSdanielk1977   }
7624b5255acSdanielk1977   p->nHeight = nHeight + 1;
7634b5255acSdanielk1977 }
7644b5255acSdanielk1977 
7654b5255acSdanielk1977 /*
7664b5255acSdanielk1977 ** Set the Expr.nHeight variable using the exprSetHeight() function. If
7674b5255acSdanielk1977 ** the height is greater than the maximum allowed expression depth,
7684b5255acSdanielk1977 ** leave an error in pParse.
7692308ed38Sdrh **
7702308ed38Sdrh ** Also propagate all EP_Propagate flags from the Expr.x.pList into
7712308ed38Sdrh ** Expr.flags.
7724b5255acSdanielk1977 */
7732308ed38Sdrh void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
77474893a4cSdrh   if( pParse->nErr ) return;
7754b5255acSdanielk1977   exprSetHeight(p);
7767d10d5a6Sdrh   sqlite3ExprCheckHeight(pParse, p->nHeight);
7774b5255acSdanielk1977 }
7784b5255acSdanielk1977 
7794b5255acSdanielk1977 /*
7804b5255acSdanielk1977 ** Return the maximum height of any expression tree referenced
7814b5255acSdanielk1977 ** by the select statement passed as an argument.
7824b5255acSdanielk1977 */
7834b5255acSdanielk1977 int sqlite3SelectExprHeight(Select *p){
7844b5255acSdanielk1977   int nHeight = 0;
7854b5255acSdanielk1977   heightOfSelect(p, &nHeight);
7864b5255acSdanielk1977   return nHeight;
7874b5255acSdanielk1977 }
7882308ed38Sdrh #else /* ABOVE:  Height enforcement enabled.  BELOW: Height enforcement off */
7892308ed38Sdrh /*
7902308ed38Sdrh ** Propagate all EP_Propagate flags from the Expr.x.pList into
7912308ed38Sdrh ** Expr.flags.
7922308ed38Sdrh */
7932308ed38Sdrh void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
7946c3b4b07Sdan   if( pParse->nErr ) return;
7952308ed38Sdrh   if( p && p->x.pList && !ExprHasProperty(p, EP_xIsSelect) ){
7962308ed38Sdrh     p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
7972308ed38Sdrh   }
7982308ed38Sdrh }
7994b5255acSdanielk1977 #define exprSetHeight(y)
8004b5255acSdanielk1977 #endif /* SQLITE_MAX_EXPR_DEPTH>0 */
8014b5255acSdanielk1977 
802be5c89acSdrh /*
803b7916a78Sdrh ** This routine is the core allocator for Expr nodes.
804b7916a78Sdrh **
805a76b5dfcSdrh ** Construct a new expression node and return a pointer to it.  Memory
806b7916a78Sdrh ** for this node and for the pToken argument is a single allocation
807b7916a78Sdrh ** obtained from sqlite3DbMalloc().  The calling function
808a76b5dfcSdrh ** is responsible for making sure the node eventually gets freed.
809b7916a78Sdrh **
810b7916a78Sdrh ** If dequote is true, then the token (if it exists) is dequoted.
811e792b5b4Sdrh ** If dequote is false, no dequoting is performed.  The deQuote
812b7916a78Sdrh ** parameter is ignored if pToken is NULL or if the token does not
813b7916a78Sdrh ** appear to be quoted.  If the quotes were of the form "..." (double-quotes)
814b7916a78Sdrh ** then the EP_DblQuoted flag is set on the expression node.
81533e619fcSdrh **
81633e619fcSdrh ** Special case:  If op==TK_INTEGER and pToken points to a string that
81733e619fcSdrh ** can be translated into a 32-bit integer, then the token is not
81833e619fcSdrh ** stored in u.zToken.  Instead, the integer values is written
81933e619fcSdrh ** into u.iValue and the EP_IntValue flag is set.  No extra storage
82033e619fcSdrh ** is allocated to hold the integer text and the dequote flag is ignored.
821a76b5dfcSdrh */
822b7916a78Sdrh Expr *sqlite3ExprAlloc(
823cca8a4adSdrh   sqlite3 *db,            /* Handle for sqlite3DbMallocRawNN() */
82417435752Sdrh   int op,                 /* Expression opcode */
825b7916a78Sdrh   const Token *pToken,    /* Token argument.  Might be NULL */
826b7916a78Sdrh   int dequote             /* True to dequote */
82717435752Sdrh ){
828a76b5dfcSdrh   Expr *pNew;
82933e619fcSdrh   int nExtra = 0;
830cf697396Sshane   int iValue = 0;
831b7916a78Sdrh 
832575fad65Sdrh   assert( db!=0 );
833b7916a78Sdrh   if( pToken ){
83433e619fcSdrh     if( op!=TK_INTEGER || pToken->z==0
83533e619fcSdrh           || sqlite3GetInt32(pToken->z, &iValue)==0 ){
836b7916a78Sdrh       nExtra = pToken->n+1;
837d50ffc41Sdrh       assert( iValue>=0 );
83833e619fcSdrh     }
839a76b5dfcSdrh   }
840575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, sizeof(Expr)+nExtra);
841b7916a78Sdrh   if( pNew ){
842ca3862dcSdrh     memset(pNew, 0, sizeof(Expr));
8431bd10f8aSdrh     pNew->op = (u8)op;
844a58fdfb1Sdanielk1977     pNew->iAgg = -1;
845a76b5dfcSdrh     if( pToken ){
84633e619fcSdrh       if( nExtra==0 ){
847ad31727fSdrh         pNew->flags |= EP_IntValue|EP_Leaf|(iValue?EP_IsTrue:EP_IsFalse);
84833e619fcSdrh         pNew->u.iValue = iValue;
84933e619fcSdrh       }else{
85033e619fcSdrh         pNew->u.zToken = (char*)&pNew[1];
851b07028f7Sdrh         assert( pToken->z!=0 || pToken->n==0 );
852b07028f7Sdrh         if( pToken->n ) memcpy(pNew->u.zToken, pToken->z, pToken->n);
85333e619fcSdrh         pNew->u.zToken[pToken->n] = 0;
854244b9d6eSdrh         if( dequote && sqlite3Isquote(pNew->u.zToken[0]) ){
85551d35b0fSdrh           sqlite3DequoteExpr(pNew);
856a34001c9Sdrh         }
857a34001c9Sdrh       }
85833e619fcSdrh     }
859b7916a78Sdrh #if SQLITE_MAX_EXPR_DEPTH>0
860b7916a78Sdrh     pNew->nHeight = 1;
861b7916a78Sdrh #endif
862a34001c9Sdrh   }
863a76b5dfcSdrh   return pNew;
864a76b5dfcSdrh }
865a76b5dfcSdrh 
866a76b5dfcSdrh /*
867b7916a78Sdrh ** Allocate a new expression node from a zero-terminated token that has
868b7916a78Sdrh ** already been dequoted.
869b7916a78Sdrh */
870b7916a78Sdrh Expr *sqlite3Expr(
871b7916a78Sdrh   sqlite3 *db,            /* Handle for sqlite3DbMallocZero() (may be null) */
872b7916a78Sdrh   int op,                 /* Expression opcode */
873b7916a78Sdrh   const char *zToken      /* Token argument.  Might be NULL */
874b7916a78Sdrh ){
875b7916a78Sdrh   Token x;
876b7916a78Sdrh   x.z = zToken;
877b40f06c6Sdrh   x.n = sqlite3Strlen30(zToken);
878b7916a78Sdrh   return sqlite3ExprAlloc(db, op, &x, 0);
879b7916a78Sdrh }
880b7916a78Sdrh 
881b7916a78Sdrh /*
882b7916a78Sdrh ** Attach subtrees pLeft and pRight to the Expr node pRoot.
883b7916a78Sdrh **
884b7916a78Sdrh ** If pRoot==NULL that means that a memory allocation error has occurred.
885b7916a78Sdrh ** In that case, delete the subtrees pLeft and pRight.
886b7916a78Sdrh */
887b7916a78Sdrh void sqlite3ExprAttachSubtrees(
888b7916a78Sdrh   sqlite3 *db,
889b7916a78Sdrh   Expr *pRoot,
890b7916a78Sdrh   Expr *pLeft,
891b7916a78Sdrh   Expr *pRight
892b7916a78Sdrh ){
893b7916a78Sdrh   if( pRoot==0 ){
894b7916a78Sdrh     assert( db->mallocFailed );
895b7916a78Sdrh     sqlite3ExprDelete(db, pLeft);
896b7916a78Sdrh     sqlite3ExprDelete(db, pRight);
897b7916a78Sdrh   }else{
898b7916a78Sdrh     if( pRight ){
899b7916a78Sdrh       pRoot->pRight = pRight;
900885a5b03Sdrh       pRoot->flags |= EP_Propagate & pRight->flags;
901b7916a78Sdrh     }
902b7916a78Sdrh     if( pLeft ){
903b7916a78Sdrh       pRoot->pLeft = pLeft;
904885a5b03Sdrh       pRoot->flags |= EP_Propagate & pLeft->flags;
905b7916a78Sdrh     }
906b7916a78Sdrh     exprSetHeight(pRoot);
907b7916a78Sdrh   }
908b7916a78Sdrh }
909b7916a78Sdrh 
910b7916a78Sdrh /*
91160ec914cSpeter.d.reid ** Allocate an Expr node which joins as many as two subtrees.
912b7916a78Sdrh **
913bf664469Sdrh ** One or both of the subtrees can be NULL.  Return a pointer to the new
914bf664469Sdrh ** Expr node.  Or, if an OOM error occurs, set pParse->db->mallocFailed,
915bf664469Sdrh ** free the subtrees and return NULL.
916206f3d96Sdrh */
91717435752Sdrh Expr *sqlite3PExpr(
91817435752Sdrh   Parse *pParse,          /* Parsing context */
91917435752Sdrh   int op,                 /* Expression opcode */
92017435752Sdrh   Expr *pLeft,            /* Left operand */
921abfd35eaSdrh   Expr *pRight            /* Right operand */
92217435752Sdrh ){
9235fb52caaSdrh   Expr *p;
924abfd35eaSdrh   p = sqlite3DbMallocRawNN(pParse->db, sizeof(Expr));
925abfd35eaSdrh   if( p ){
926abfd35eaSdrh     memset(p, 0, sizeof(Expr));
927f1722baaSdrh     p->op = op & 0xff;
928abfd35eaSdrh     p->iAgg = -1;
929b7916a78Sdrh     sqlite3ExprAttachSubtrees(pParse->db, p, pLeft, pRight);
9302b359bdbSdan     sqlite3ExprCheckHeight(pParse, p->nHeight);
931d5c851c1Sdrh   }else{
932d5c851c1Sdrh     sqlite3ExprDelete(pParse->db, pLeft);
933d5c851c1Sdrh     sqlite3ExprDelete(pParse->db, pRight);
9342b359bdbSdan   }
9354e0cff60Sdrh   return p;
9364e0cff60Sdrh }
9374e0cff60Sdrh 
9384e0cff60Sdrh /*
93908de4f79Sdrh ** Add pSelect to the Expr.x.pSelect field.  Or, if pExpr is NULL (due
94008de4f79Sdrh ** do a memory allocation failure) then delete the pSelect object.
94108de4f79Sdrh */
94208de4f79Sdrh void sqlite3PExprAddSelect(Parse *pParse, Expr *pExpr, Select *pSelect){
94308de4f79Sdrh   if( pExpr ){
94408de4f79Sdrh     pExpr->x.pSelect = pSelect;
94508de4f79Sdrh     ExprSetProperty(pExpr, EP_xIsSelect|EP_Subquery);
94608de4f79Sdrh     sqlite3ExprSetHeightAndFlags(pParse, pExpr);
94708de4f79Sdrh   }else{
94808de4f79Sdrh     assert( pParse->db->mallocFailed );
94908de4f79Sdrh     sqlite3SelectDelete(pParse->db, pSelect);
95008de4f79Sdrh   }
95108de4f79Sdrh }
95208de4f79Sdrh 
95308de4f79Sdrh 
95408de4f79Sdrh /*
95591bb0eedSdrh ** Join two expressions using an AND operator.  If either expression is
95691bb0eedSdrh ** NULL, then just return the other expression.
9575fb52caaSdrh **
9585fb52caaSdrh ** If one side or the other of the AND is known to be false, then instead
9595fb52caaSdrh ** of returning an AND expression, just return a constant expression with
9605fb52caaSdrh ** a value of false.
96191bb0eedSdrh */
962d5c851c1Sdrh Expr *sqlite3ExprAnd(Parse *pParse, Expr *pLeft, Expr *pRight){
963d5c851c1Sdrh   sqlite3 *db = pParse->db;
96491bb0eedSdrh   if( pLeft==0  ){
96591bb0eedSdrh     return pRight;
96691bb0eedSdrh   }else if( pRight==0 ){
96791bb0eedSdrh     return pLeft;
9682b6e670fSdan   }else if( (ExprAlwaysFalse(pLeft) || ExprAlwaysFalse(pRight))
9692b6e670fSdan          && !IN_RENAME_OBJECT
9702b6e670fSdan   ){
971b3ad4e61Sdrh     sqlite3ExprDeferredDelete(pParse, pLeft);
972b3ad4e61Sdrh     sqlite3ExprDeferredDelete(pParse, pRight);
9735776ee5cSdrh     return sqlite3Expr(db, TK_INTEGER, "0");
97491bb0eedSdrh   }else{
975d5c851c1Sdrh     return sqlite3PExpr(pParse, TK_AND, pLeft, pRight);
976a76b5dfcSdrh   }
977a76b5dfcSdrh }
978a76b5dfcSdrh 
979a76b5dfcSdrh /*
980a76b5dfcSdrh ** Construct a new expression node for a function with multiple
981a76b5dfcSdrh ** arguments.
982a76b5dfcSdrh */
983954733b3Sdrh Expr *sqlite3ExprFunction(
984954733b3Sdrh   Parse *pParse,        /* Parsing context */
985954733b3Sdrh   ExprList *pList,      /* Argument list */
986954733b3Sdrh   Token *pToken,        /* Name of the function */
987954733b3Sdrh   int eDistinct         /* SF_Distinct or SF_ALL or 0 */
988954733b3Sdrh ){
989a76b5dfcSdrh   Expr *pNew;
990633e6d57Sdrh   sqlite3 *db = pParse->db;
9914b202ae2Sdanielk1977   assert( pToken );
992b7916a78Sdrh   pNew = sqlite3ExprAlloc(db, TK_FUNCTION, pToken, 1);
993a76b5dfcSdrh   if( pNew==0 ){
994d9da78a2Sdrh     sqlite3ExprListDelete(db, pList); /* Avoid memory leak when malloc fails */
995a76b5dfcSdrh     return 0;
996a76b5dfcSdrh   }
997954733b3Sdrh   if( pList && pList->nExpr > pParse->db->aLimit[SQLITE_LIMIT_FUNCTION_ARG] ){
998954733b3Sdrh     sqlite3ErrorMsg(pParse, "too many arguments on function %T", pToken);
999954733b3Sdrh   }
10006ab3a2ecSdanielk1977   pNew->x.pList = pList;
1001fca23557Sdrh   ExprSetProperty(pNew, EP_HasFunc);
10026ab3a2ecSdanielk1977   assert( !ExprHasProperty(pNew, EP_xIsSelect) );
10032308ed38Sdrh   sqlite3ExprSetHeightAndFlags(pParse, pNew);
1004954733b3Sdrh   if( eDistinct==SF_Distinct ) ExprSetProperty(pNew, EP_Distinct);
1005a76b5dfcSdrh   return pNew;
1006a76b5dfcSdrh }
1007a76b5dfcSdrh 
1008a76b5dfcSdrh /*
10090dfa5255Sdrh ** Check to see if a function is usable according to current access
10100dfa5255Sdrh ** rules:
10110dfa5255Sdrh **
10120dfa5255Sdrh **    SQLITE_FUNC_DIRECT    -     Only usable from top-level SQL
10130dfa5255Sdrh **
10140dfa5255Sdrh **    SQLITE_FUNC_UNSAFE    -     Usable if TRUSTED_SCHEMA or from
10150dfa5255Sdrh **                                top-level SQL
10160dfa5255Sdrh **
10170dfa5255Sdrh ** If the function is not usable, create an error.
10180dfa5255Sdrh */
10190dfa5255Sdrh void sqlite3ExprFunctionUsable(
10200dfa5255Sdrh   Parse *pParse,         /* Parsing and code generating context */
10210dfa5255Sdrh   Expr *pExpr,           /* The function invocation */
10220dfa5255Sdrh   FuncDef *pDef          /* The function being invoked */
10230dfa5255Sdrh ){
10240dfa5255Sdrh   assert( !IN_RENAME_OBJECT );
10252eeca204Sdrh   assert( (pDef->funcFlags & (SQLITE_FUNC_DIRECT|SQLITE_FUNC_UNSAFE))!=0 );
10262eeca204Sdrh   if( ExprHasProperty(pExpr, EP_FromDDL) ){
10270dfa5255Sdrh     if( (pDef->funcFlags & SQLITE_FUNC_DIRECT)!=0
10280dfa5255Sdrh      || (pParse->db->flags & SQLITE_TrustedSchema)==0
10290dfa5255Sdrh     ){
10300dfa5255Sdrh       /* Functions prohibited in triggers and views if:
10310dfa5255Sdrh       **     (1) tagged with SQLITE_DIRECTONLY
10320dfa5255Sdrh       **     (2) not tagged with SQLITE_INNOCUOUS (which means it
10330dfa5255Sdrh       **         is tagged with SQLITE_FUNC_UNSAFE) and
10340dfa5255Sdrh       **         SQLITE_DBCONFIG_TRUSTED_SCHEMA is off (meaning
10350dfa5255Sdrh       **         that the schema is possibly tainted).
10360dfa5255Sdrh       */
10370dfa5255Sdrh       sqlite3ErrorMsg(pParse, "unsafe use of %s()", pDef->zName);
10380dfa5255Sdrh     }
10390dfa5255Sdrh   }
10400dfa5255Sdrh }
10410dfa5255Sdrh 
10420dfa5255Sdrh /*
1043fa6bc000Sdrh ** Assign a variable number to an expression that encodes a wildcard
1044fa6bc000Sdrh ** in the original SQL statement.
1045fa6bc000Sdrh **
1046fa6bc000Sdrh ** Wildcards consisting of a single "?" are assigned the next sequential
1047fa6bc000Sdrh ** variable number.
1048fa6bc000Sdrh **
1049fa6bc000Sdrh ** Wildcards of the form "?nnn" are assigned the number "nnn".  We make
10509bf755ccSdrh ** sure "nnn" is not too big to avoid a denial of service attack when
1051fa6bc000Sdrh ** the SQL statement comes from an external source.
1052fa6bc000Sdrh **
105351f49f17Sdrh ** Wildcards of the form ":aaa", "@aaa", or "$aaa" are assigned the same number
1054fa6bc000Sdrh ** as the previous instance of the same wildcard.  Or if this is the first
105560ec914cSpeter.d.reid ** instance of the wildcard, the next sequential variable number is
1056fa6bc000Sdrh ** assigned.
1057fa6bc000Sdrh */
1058de25a88cSdrh void sqlite3ExprAssignVarNumber(Parse *pParse, Expr *pExpr, u32 n){
105917435752Sdrh   sqlite3 *db = pParse->db;
1060b7916a78Sdrh   const char *z;
1061f326d66dSdrh   ynVar x;
106217435752Sdrh 
1063fa6bc000Sdrh   if( pExpr==0 ) return;
1064c5cd1249Sdrh   assert( !ExprHasProperty(pExpr, EP_IntValue|EP_Reduced|EP_TokenOnly) );
106533e619fcSdrh   z = pExpr->u.zToken;
1066b7916a78Sdrh   assert( z!=0 );
1067b7916a78Sdrh   assert( z[0]!=0 );
1068b1ed717fSmistachkin   assert( n==(u32)sqlite3Strlen30(z) );
1069b7916a78Sdrh   if( z[1]==0 ){
1070fa6bc000Sdrh     /* Wildcard of the form "?".  Assign the next variable number */
1071b7916a78Sdrh     assert( z[0]=='?' );
1072f326d66dSdrh     x = (ynVar)(++pParse->nVar);
1073124c0b49Sdrh   }else{
1074f326d66dSdrh     int doAdd = 0;
1075124c0b49Sdrh     if( z[0]=='?' ){
1076fa6bc000Sdrh       /* Wildcard of the form "?nnn".  Convert "nnn" to an integer and
1077fa6bc000Sdrh       ** use it as the variable number */
1078c8d735aeSdan       i64 i;
107918814dfbSdrh       int bOk;
108018814dfbSdrh       if( n==2 ){ /*OPTIMIZATION-IF-TRUE*/
108118814dfbSdrh         i = z[1]-'0';  /* The common case of ?N for a single digit N */
108218814dfbSdrh         bOk = 1;
108318814dfbSdrh       }else{
108418814dfbSdrh         bOk = 0==sqlite3Atoi64(&z[1], &i, n-1, SQLITE_UTF8);
108518814dfbSdrh       }
1086c5499befSdrh       testcase( i==0 );
1087c5499befSdrh       testcase( i==1 );
1088c5499befSdrh       testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]-1 );
1089c5499befSdrh       testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] );
1090c8d735aeSdan       if( bOk==0 || i<1 || i>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
1091fa6bc000Sdrh         sqlite3ErrorMsg(pParse, "variable number must be between ?1 and ?%d",
1092bb4957f8Sdrh             db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]);
1093c9b39288Sdrh         return;
1094fa6bc000Sdrh       }
10958e74e7baSdrh       x = (ynVar)i;
1096f326d66dSdrh       if( x>pParse->nVar ){
1097f326d66dSdrh         pParse->nVar = (int)x;
1098f326d66dSdrh         doAdd = 1;
1099f326d66dSdrh       }else if( sqlite3VListNumToName(pParse->pVList, x)==0 ){
1100f326d66dSdrh         doAdd = 1;
1101fa6bc000Sdrh       }
1102fa6bc000Sdrh     }else{
110351f49f17Sdrh       /* Wildcards like ":aaa", "$aaa" or "@aaa".  Reuse the same variable
1104fa6bc000Sdrh       ** number as the prior appearance of the same name, or if the name
1105fa6bc000Sdrh       ** has never appeared before, reuse the same variable number
1106fa6bc000Sdrh       */
11079bf755ccSdrh       x = (ynVar)sqlite3VListNameToNum(pParse->pVList, z, n);
11089bf755ccSdrh       if( x==0 ){
11099bf755ccSdrh         x = (ynVar)(++pParse->nVar);
1110f326d66dSdrh         doAdd = 1;
1111f326d66dSdrh       }
1112f326d66dSdrh     }
1113f326d66dSdrh     if( doAdd ){
11149bf755ccSdrh       pParse->pVList = sqlite3VListAdd(db, pParse->pVList, z, n, x);
1115fa6bc000Sdrh     }
1116fa6bc000Sdrh   }
1117c9b39288Sdrh   pExpr->iColumn = x;
1118f326d66dSdrh   if( x>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
1119832b2664Sdanielk1977     sqlite3ErrorMsg(pParse, "too many SQL variables");
1120832b2664Sdanielk1977   }
1121fa6bc000Sdrh }
1122fa6bc000Sdrh 
1123fa6bc000Sdrh /*
1124f6963f99Sdan ** Recursively delete an expression tree.
1125a2e00042Sdrh */
11264f0010b1Sdrh static SQLITE_NOINLINE void sqlite3ExprDeleteNN(sqlite3 *db, Expr *p){
11274f0010b1Sdrh   assert( p!=0 );
1128d50ffc41Sdrh   /* Sanity check: Assert that the IntValue is non-negative if it exists */
1129d50ffc41Sdrh   assert( !ExprHasProperty(p, EP_IntValue) || p->u.iValue>=0 );
1130eda079cdSdrh 
1131eda079cdSdrh   assert( !ExprHasProperty(p, EP_WinFunc) || p->y.pWin!=0 || db->mallocFailed );
1132eda079cdSdrh   assert( p->op!=TK_FUNCTION || ExprHasProperty(p, EP_TokenOnly|EP_Reduced)
11334f9adee2Sdan           || p->y.pWin==0 || ExprHasProperty(p, EP_WinFunc) );
1134209bc522Sdrh #ifdef SQLITE_DEBUG
1135209bc522Sdrh   if( ExprHasProperty(p, EP_Leaf) && !ExprHasProperty(p, EP_TokenOnly) ){
1136209bc522Sdrh     assert( p->pLeft==0 );
1137209bc522Sdrh     assert( p->pRight==0 );
1138209bc522Sdrh     assert( p->x.pSelect==0 );
1139209bc522Sdrh   }
1140209bc522Sdrh #endif
1141209bc522Sdrh   if( !ExprHasProperty(p, (EP_TokenOnly|EP_Leaf)) ){
1142c5cd1249Sdrh     /* The Expr.x union is never used at the same time as Expr.pRight */
1143c5cd1249Sdrh     assert( p->x.pList==0 || p->pRight==0 );
11444910a76dSdrh     if( p->pLeft && p->op!=TK_SELECT_COLUMN ) sqlite3ExprDeleteNN(db, p->pLeft);
1145d1086679Sdrh     if( p->pRight ){
11464f9adee2Sdan       assert( !ExprHasProperty(p, EP_WinFunc) );
1147d1086679Sdrh       sqlite3ExprDeleteNN(db, p->pRight);
1148d1086679Sdrh     }else if( ExprHasProperty(p, EP_xIsSelect) ){
11494f9adee2Sdan       assert( !ExprHasProperty(p, EP_WinFunc) );
11506ab3a2ecSdanielk1977       sqlite3SelectDelete(db, p->x.pSelect);
11516ab3a2ecSdanielk1977     }else{
11526ab3a2ecSdanielk1977       sqlite3ExprListDelete(db, p->x.pList);
11536ba7ab0dSdan #ifndef SQLITE_OMIT_WINDOWFUNC
1154eda079cdSdrh       if( ExprHasProperty(p, EP_WinFunc) ){
1155eda079cdSdrh         sqlite3WindowDelete(db, p->y.pWin);
115686fb6e17Sdan       }
11576ba7ab0dSdan #endif
11586ab3a2ecSdanielk1977     }
11598117f113Sdan   }
1160209bc522Sdrh   if( ExprHasProperty(p, EP_MemToken) ) sqlite3DbFree(db, p->u.zToken);
116133e619fcSdrh   if( !ExprHasProperty(p, EP_Static) ){
1162dbd6a7dcSdrh     sqlite3DbFreeNN(db, p);
1163a2e00042Sdrh   }
116433e619fcSdrh }
11654f0010b1Sdrh void sqlite3ExprDelete(sqlite3 *db, Expr *p){
11664f0010b1Sdrh   if( p ) sqlite3ExprDeleteNN(db, p);
11674f0010b1Sdrh }
1168a2e00042Sdrh 
1169b3ad4e61Sdrh 
1170b3ad4e61Sdrh /*
1171b3ad4e61Sdrh ** Arrange to cause pExpr to be deleted when the pParse is deleted.
1172b3ad4e61Sdrh ** This is similar to sqlite3ExprDelete() except that the delete is
1173b3ad4e61Sdrh ** deferred untilthe pParse is deleted.
1174b3ad4e61Sdrh **
1175b3ad4e61Sdrh ** The pExpr might be deleted immediately on an OOM error.
1176b3ad4e61Sdrh **
1177b3ad4e61Sdrh ** The deferred delete is (currently) implemented by adding the
1178b3ad4e61Sdrh ** pExpr to the pParse->pConstExpr list with a register number of 0.
1179b3ad4e61Sdrh */
1180b3ad4e61Sdrh void sqlite3ExprDeferredDelete(Parse *pParse, Expr *pExpr){
1181b3ad4e61Sdrh   pParse->pConstExpr =
1182b3ad4e61Sdrh       sqlite3ExprListAppend(pParse, pParse->pConstExpr, pExpr);
1183b3ad4e61Sdrh }
1184b3ad4e61Sdrh 
11858e34e406Sdrh /* Invoke sqlite3RenameExprUnmap() and sqlite3ExprDelete() on the
11868e34e406Sdrh ** expression.
11878e34e406Sdrh */
11888e34e406Sdrh void sqlite3ExprUnmapAndDelete(Parse *pParse, Expr *p){
11898e34e406Sdrh   if( p ){
11908e34e406Sdrh     if( IN_RENAME_OBJECT ){
11918e34e406Sdrh       sqlite3RenameExprUnmap(pParse, p);
11928e34e406Sdrh     }
11938e34e406Sdrh     sqlite3ExprDeleteNN(pParse->db, p);
11948e34e406Sdrh   }
11958e34e406Sdrh }
11968e34e406Sdrh 
1197d2687b77Sdrh /*
11986ab3a2ecSdanielk1977 ** Return the number of bytes allocated for the expression structure
11996ab3a2ecSdanielk1977 ** passed as the first argument. This is always one of EXPR_FULLSIZE,
12006ab3a2ecSdanielk1977 ** EXPR_REDUCEDSIZE or EXPR_TOKENONLYSIZE.
12016ab3a2ecSdanielk1977 */
12026ab3a2ecSdanielk1977 static int exprStructSize(Expr *p){
12036ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_TokenOnly) ) return EXPR_TOKENONLYSIZE;
12046ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_Reduced) ) return EXPR_REDUCEDSIZE;
12056ab3a2ecSdanielk1977   return EXPR_FULLSIZE;
12066ab3a2ecSdanielk1977 }
12076ab3a2ecSdanielk1977 
12086ab3a2ecSdanielk1977 /*
120933e619fcSdrh ** The dupedExpr*Size() routines each return the number of bytes required
121033e619fcSdrh ** to store a copy of an expression or expression tree.  They differ in
121133e619fcSdrh ** how much of the tree is measured.
121233e619fcSdrh **
121333e619fcSdrh **     dupedExprStructSize()     Size of only the Expr structure
121433e619fcSdrh **     dupedExprNodeSize()       Size of Expr + space for token
121533e619fcSdrh **     dupedExprSize()           Expr + token + subtree components
121633e619fcSdrh **
121733e619fcSdrh ***************************************************************************
121833e619fcSdrh **
121933e619fcSdrh ** The dupedExprStructSize() function returns two values OR-ed together:
122033e619fcSdrh ** (1) the space required for a copy of the Expr structure only and
122133e619fcSdrh ** (2) the EP_xxx flags that indicate what the structure size should be.
122233e619fcSdrh ** The return values is always one of:
122333e619fcSdrh **
122433e619fcSdrh **      EXPR_FULLSIZE
122533e619fcSdrh **      EXPR_REDUCEDSIZE   | EP_Reduced
122633e619fcSdrh **      EXPR_TOKENONLYSIZE | EP_TokenOnly
122733e619fcSdrh **
122833e619fcSdrh ** The size of the structure can be found by masking the return value
122933e619fcSdrh ** of this routine with 0xfff.  The flags can be found by masking the
123033e619fcSdrh ** return value with EP_Reduced|EP_TokenOnly.
123133e619fcSdrh **
123233e619fcSdrh ** Note that with flags==EXPRDUP_REDUCE, this routines works on full-size
123333e619fcSdrh ** (unreduced) Expr objects as they or originally constructed by the parser.
123433e619fcSdrh ** During expression analysis, extra information is computed and moved into
1235c95f38d4Sdan ** later parts of the Expr object and that extra information might get chopped
123633e619fcSdrh ** off if the expression is reduced.  Note also that it does not work to
123760ec914cSpeter.d.reid ** make an EXPRDUP_REDUCE copy of a reduced expression.  It is only legal
123833e619fcSdrh ** to reduce a pristine expression tree from the parser.  The implementation
123933e619fcSdrh ** of dupedExprStructSize() contain multiple assert() statements that attempt
124033e619fcSdrh ** to enforce this constraint.
12416ab3a2ecSdanielk1977 */
12426ab3a2ecSdanielk1977 static int dupedExprStructSize(Expr *p, int flags){
12436ab3a2ecSdanielk1977   int nSize;
124433e619fcSdrh   assert( flags==EXPRDUP_REDUCE || flags==0 ); /* Only one flag value allowed */
1245aecd8021Sdrh   assert( EXPR_FULLSIZE<=0xfff );
1246aecd8021Sdrh   assert( (0xfff & (EP_Reduced|EP_TokenOnly))==0 );
124767a9b8edSdan   if( 0==flags || p->op==TK_SELECT_COLUMN
124867a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
1249eda079cdSdrh    || ExprHasProperty(p, EP_WinFunc)
125067a9b8edSdan #endif
125167a9b8edSdan   ){
12526ab3a2ecSdanielk1977     nSize = EXPR_FULLSIZE;
12536ab3a2ecSdanielk1977   }else{
1254c5cd1249Sdrh     assert( !ExprHasProperty(p, EP_TokenOnly|EP_Reduced) );
125533e619fcSdrh     assert( !ExprHasProperty(p, EP_FromJoin) );
1256c5cd1249Sdrh     assert( !ExprHasProperty(p, EP_MemToken) );
1257e7375bfaSdrh     assert( !ExprHasVVAProperty(p, EP_NoReduce) );
1258aecd8021Sdrh     if( p->pLeft || p->x.pList ){
125933e619fcSdrh       nSize = EXPR_REDUCEDSIZE | EP_Reduced;
126033e619fcSdrh     }else{
1261aecd8021Sdrh       assert( p->pRight==0 );
126233e619fcSdrh       nSize = EXPR_TOKENONLYSIZE | EP_TokenOnly;
126333e619fcSdrh     }
12646ab3a2ecSdanielk1977   }
12656ab3a2ecSdanielk1977   return nSize;
12666ab3a2ecSdanielk1977 }
12676ab3a2ecSdanielk1977 
12686ab3a2ecSdanielk1977 /*
126933e619fcSdrh ** This function returns the space in bytes required to store the copy
127033e619fcSdrh ** of the Expr structure and a copy of the Expr.u.zToken string (if that
127133e619fcSdrh ** string is defined.)
12726ab3a2ecSdanielk1977 */
12736ab3a2ecSdanielk1977 static int dupedExprNodeSize(Expr *p, int flags){
127433e619fcSdrh   int nByte = dupedExprStructSize(p, flags) & 0xfff;
127533e619fcSdrh   if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
12767301e774Sdrh     nByte += sqlite3Strlen30NN(p->u.zToken)+1;
12776ab3a2ecSdanielk1977   }
1278bc73971dSdanielk1977   return ROUND8(nByte);
12796ab3a2ecSdanielk1977 }
12806ab3a2ecSdanielk1977 
12816ab3a2ecSdanielk1977 /*
12826ab3a2ecSdanielk1977 ** Return the number of bytes required to create a duplicate of the
12836ab3a2ecSdanielk1977 ** expression passed as the first argument. The second argument is a
12846ab3a2ecSdanielk1977 ** mask containing EXPRDUP_XXX flags.
12856ab3a2ecSdanielk1977 **
12866ab3a2ecSdanielk1977 ** The value returned includes space to create a copy of the Expr struct
128733e619fcSdrh ** itself and the buffer referred to by Expr.u.zToken, if any.
12886ab3a2ecSdanielk1977 **
12896ab3a2ecSdanielk1977 ** If the EXPRDUP_REDUCE flag is set, then the return value includes
12906ab3a2ecSdanielk1977 ** space to duplicate all Expr nodes in the tree formed by Expr.pLeft
12916ab3a2ecSdanielk1977 ** and Expr.pRight variables (but not for any structures pointed to or
12926ab3a2ecSdanielk1977 ** descended from the Expr.x.pList or Expr.x.pSelect variables).
12936ab3a2ecSdanielk1977 */
12946ab3a2ecSdanielk1977 static int dupedExprSize(Expr *p, int flags){
12956ab3a2ecSdanielk1977   int nByte = 0;
12966ab3a2ecSdanielk1977   if( p ){
12976ab3a2ecSdanielk1977     nByte = dupedExprNodeSize(p, flags);
12986ab3a2ecSdanielk1977     if( flags&EXPRDUP_REDUCE ){
1299b7916a78Sdrh       nByte += dupedExprSize(p->pLeft, flags) + dupedExprSize(p->pRight, flags);
13006ab3a2ecSdanielk1977     }
13016ab3a2ecSdanielk1977   }
13026ab3a2ecSdanielk1977   return nByte;
13036ab3a2ecSdanielk1977 }
13046ab3a2ecSdanielk1977 
13056ab3a2ecSdanielk1977 /*
13066ab3a2ecSdanielk1977 ** This function is similar to sqlite3ExprDup(), except that if pzBuffer
13076ab3a2ecSdanielk1977 ** is not NULL then *pzBuffer is assumed to point to a buffer large enough
130833e619fcSdrh ** to store the copy of expression p, the copies of p->u.zToken
13096ab3a2ecSdanielk1977 ** (if applicable), and the copies of the p->pLeft and p->pRight expressions,
131060ec914cSpeter.d.reid ** if any. Before returning, *pzBuffer is set to the first byte past the
13116ab3a2ecSdanielk1977 ** portion of the buffer copied into by this function.
13126ab3a2ecSdanielk1977 */
13133c19469cSdrh static Expr *exprDup(sqlite3 *db, Expr *p, int dupFlags, u8 **pzBuffer){
13143c19469cSdrh   Expr *pNew;           /* Value to return */
13153c19469cSdrh   u8 *zAlloc;           /* Memory space from which to build Expr object */
13163c19469cSdrh   u32 staticFlag;       /* EP_Static if space not obtained from malloc */
13176ab3a2ecSdanielk1977 
13183c19469cSdrh   assert( db!=0 );
13193c19469cSdrh   assert( p );
13203c19469cSdrh   assert( dupFlags==0 || dupFlags==EXPRDUP_REDUCE );
13213c19469cSdrh   assert( pzBuffer==0 || dupFlags==EXPRDUP_REDUCE );
13226ab3a2ecSdanielk1977 
13236ab3a2ecSdanielk1977   /* Figure out where to write the new Expr structure. */
13246ab3a2ecSdanielk1977   if( pzBuffer ){
13256ab3a2ecSdanielk1977     zAlloc = *pzBuffer;
132633e619fcSdrh     staticFlag = EP_Static;
1327*3c6edc8aSdrh     assert( zAlloc!=0 );
13286ab3a2ecSdanielk1977   }else{
13293c19469cSdrh     zAlloc = sqlite3DbMallocRawNN(db, dupedExprSize(p, dupFlags));
13303c19469cSdrh     staticFlag = 0;
13316ab3a2ecSdanielk1977   }
13326ab3a2ecSdanielk1977   pNew = (Expr *)zAlloc;
13336ab3a2ecSdanielk1977 
13346ab3a2ecSdanielk1977   if( pNew ){
13356ab3a2ecSdanielk1977     /* Set nNewSize to the size allocated for the structure pointed to
13366ab3a2ecSdanielk1977     ** by pNew. This is either EXPR_FULLSIZE, EXPR_REDUCEDSIZE or
13376ab3a2ecSdanielk1977     ** EXPR_TOKENONLYSIZE. nToken is set to the number of bytes consumed
133833e619fcSdrh     ** by the copy of the p->u.zToken string (if any).
13396ab3a2ecSdanielk1977     */
13403c19469cSdrh     const unsigned nStructSize = dupedExprStructSize(p, dupFlags);
134133e619fcSdrh     const int nNewSize = nStructSize & 0xfff;
134233e619fcSdrh     int nToken;
134333e619fcSdrh     if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
134433e619fcSdrh       nToken = sqlite3Strlen30(p->u.zToken) + 1;
134533e619fcSdrh     }else{
134633e619fcSdrh       nToken = 0;
134733e619fcSdrh     }
13483c19469cSdrh     if( dupFlags ){
13496ab3a2ecSdanielk1977       assert( ExprHasProperty(p, EP_Reduced)==0 );
13506ab3a2ecSdanielk1977       memcpy(zAlloc, p, nNewSize);
13516ab3a2ecSdanielk1977     }else{
13523e6a1411Sdan       u32 nSize = (u32)exprStructSize(p);
13536ab3a2ecSdanielk1977       memcpy(zAlloc, p, nSize);
135472ea29d7Sdrh       if( nSize<EXPR_FULLSIZE ){
13556ab3a2ecSdanielk1977         memset(&zAlloc[nSize], 0, EXPR_FULLSIZE-nSize);
13566ab3a2ecSdanielk1977       }
135772ea29d7Sdrh     }
13586ab3a2ecSdanielk1977 
135933e619fcSdrh     /* Set the EP_Reduced, EP_TokenOnly, and EP_Static flags appropriately. */
1360c5cd1249Sdrh     pNew->flags &= ~(EP_Reduced|EP_TokenOnly|EP_Static|EP_MemToken);
136133e619fcSdrh     pNew->flags |= nStructSize & (EP_Reduced|EP_TokenOnly);
136233e619fcSdrh     pNew->flags |= staticFlag;
1363e7375bfaSdrh     ExprClearVVAProperties(pNew);
1364e7375bfaSdrh     if( dupFlags ){
1365e7375bfaSdrh       ExprSetVVAProperty(pNew, EP_Immutable);
1366e7375bfaSdrh     }
13676ab3a2ecSdanielk1977 
136833e619fcSdrh     /* Copy the p->u.zToken string, if any. */
13696ab3a2ecSdanielk1977     if( nToken ){
137033e619fcSdrh       char *zToken = pNew->u.zToken = (char*)&zAlloc[nNewSize];
137133e619fcSdrh       memcpy(zToken, p->u.zToken, nToken);
13726ab3a2ecSdanielk1977     }
13736ab3a2ecSdanielk1977 
1374209bc522Sdrh     if( 0==((p->flags|pNew->flags) & (EP_TokenOnly|EP_Leaf)) ){
13756ab3a2ecSdanielk1977       /* Fill in the pNew->x.pSelect or pNew->x.pList member. */
13766ab3a2ecSdanielk1977       if( ExprHasProperty(p, EP_xIsSelect) ){
13773c19469cSdrh         pNew->x.pSelect = sqlite3SelectDup(db, p->x.pSelect, dupFlags);
13786ab3a2ecSdanielk1977       }else{
13793c19469cSdrh         pNew->x.pList = sqlite3ExprListDup(db, p->x.pList, dupFlags);
13806ab3a2ecSdanielk1977       }
13816ab3a2ecSdanielk1977     }
13826ab3a2ecSdanielk1977 
13836ab3a2ecSdanielk1977     /* Fill in pNew->pLeft and pNew->pRight. */
13844f9adee2Sdan     if( ExprHasProperty(pNew, EP_Reduced|EP_TokenOnly|EP_WinFunc) ){
13853c19469cSdrh       zAlloc += dupedExprNodeSize(p, dupFlags);
1386209bc522Sdrh       if( !ExprHasProperty(pNew, EP_TokenOnly|EP_Leaf) ){
13873c19469cSdrh         pNew->pLeft = p->pLeft ?
13883c19469cSdrh                       exprDup(db, p->pLeft, EXPRDUP_REDUCE, &zAlloc) : 0;
13893c19469cSdrh         pNew->pRight = p->pRight ?
13903c19469cSdrh                        exprDup(db, p->pRight, EXPRDUP_REDUCE, &zAlloc) : 0;
13916ab3a2ecSdanielk1977       }
139267a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
1393eda079cdSdrh       if( ExprHasProperty(p, EP_WinFunc) ){
1394eda079cdSdrh         pNew->y.pWin = sqlite3WindowDup(db, pNew, p->y.pWin);
1395eda079cdSdrh         assert( ExprHasProperty(pNew, EP_WinFunc) );
1396e2f781b9Sdan       }
139767a9b8edSdan #endif /* SQLITE_OMIT_WINDOWFUNC */
139853988068Sdrh       if( pzBuffer ){
139953988068Sdrh         *pzBuffer = zAlloc;
140053988068Sdrh       }
140153988068Sdrh     }else{
1402209bc522Sdrh       if( !ExprHasProperty(p, EP_TokenOnly|EP_Leaf) ){
14039854260bSdrh         if( pNew->op==TK_SELECT_COLUMN ){
14049854260bSdrh           pNew->pLeft = p->pLeft;
140547073f62Sdrh           assert( p->iColumn==0 || p->pRight==0 );
14065cc9daf8Sdrh           assert( p->pRight==0  || p->pRight==p->pLeft
14075cc9daf8Sdrh                                 || ExprHasProperty(p->pLeft, EP_Subquery) );
14089854260bSdrh         }else{
14096ab3a2ecSdanielk1977           pNew->pLeft = sqlite3ExprDup(db, p->pLeft, 0);
14109854260bSdrh         }
14116ab3a2ecSdanielk1977         pNew->pRight = sqlite3ExprDup(db, p->pRight, 0);
14126ab3a2ecSdanielk1977       }
14136ab3a2ecSdanielk1977     }
14146ab3a2ecSdanielk1977   }
14156ab3a2ecSdanielk1977   return pNew;
14166ab3a2ecSdanielk1977 }
14176ab3a2ecSdanielk1977 
14186ab3a2ecSdanielk1977 /*
1419bfe31e7fSdan ** Create and return a deep copy of the object passed as the second
1420bfe31e7fSdan ** argument. If an OOM condition is encountered, NULL is returned
1421bfe31e7fSdan ** and the db->mallocFailed flag set.
1422bfe31e7fSdan */
1423eede6a53Sdan #ifndef SQLITE_OMIT_CTE
1424bfe31e7fSdan static With *withDup(sqlite3 *db, With *p){
14254e9119d9Sdan   With *pRet = 0;
14264e9119d9Sdan   if( p ){
1427d4de9f7bSdrh     sqlite3_int64 nByte = sizeof(*p) + sizeof(p->a[0]) * (p->nCte-1);
14284e9119d9Sdan     pRet = sqlite3DbMallocZero(db, nByte);
14294e9119d9Sdan     if( pRet ){
14304e9119d9Sdan       int i;
14314e9119d9Sdan       pRet->nCte = p->nCte;
14324e9119d9Sdan       for(i=0; i<p->nCte; i++){
14334e9119d9Sdan         pRet->a[i].pSelect = sqlite3SelectDup(db, p->a[i].pSelect, 0);
14344e9119d9Sdan         pRet->a[i].pCols = sqlite3ExprListDup(db, p->a[i].pCols, 0);
14354e9119d9Sdan         pRet->a[i].zName = sqlite3DbStrDup(db, p->a[i].zName);
14364e9119d9Sdan       }
14374e9119d9Sdan     }
14384e9119d9Sdan   }
14394e9119d9Sdan   return pRet;
14404e9119d9Sdan }
1441eede6a53Sdan #else
1442eede6a53Sdan # define withDup(x,y) 0
1443eede6a53Sdan #endif
14444e9119d9Sdan 
1445a8389975Sdrh #ifndef SQLITE_OMIT_WINDOWFUNC
1446a8389975Sdrh /*
1447a8389975Sdrh ** The gatherSelectWindows() procedure and its helper routine
1448a8389975Sdrh ** gatherSelectWindowsCallback() are used to scan all the expressions
1449a8389975Sdrh ** an a newly duplicated SELECT statement and gather all of the Window
1450a8389975Sdrh ** objects found there, assembling them onto the linked list at Select->pWin.
1451a8389975Sdrh */
1452a8389975Sdrh static int gatherSelectWindowsCallback(Walker *pWalker, Expr *pExpr){
14536ba7ab0dSdan   if( pExpr->op==TK_FUNCTION && ExprHasProperty(pExpr, EP_WinFunc) ){
145475b0821eSdan     Select *pSelect = pWalker->u.pSelect;
145575b0821eSdan     Window *pWin = pExpr->y.pWin;
145675b0821eSdan     assert( pWin );
14574f9adee2Sdan     assert( IsWindowFunc(pExpr) );
1458e0ae3f69Sdan     assert( pWin->ppThis==0 );
1459a3fcc000Sdan     sqlite3WindowLink(pSelect, pWin);
1460a8389975Sdrh   }
1461a8389975Sdrh   return WRC_Continue;
1462a8389975Sdrh }
1463a37b6a5eSdrh static int gatherSelectWindowsSelectCallback(Walker *pWalker, Select *p){
1464a37b6a5eSdrh   return p==pWalker->u.pSelect ? WRC_Continue : WRC_Prune;
1465a37b6a5eSdrh }
1466a8389975Sdrh static void gatherSelectWindows(Select *p){
1467a8389975Sdrh   Walker w;
1468a8389975Sdrh   w.xExprCallback = gatherSelectWindowsCallback;
1469a37b6a5eSdrh   w.xSelectCallback = gatherSelectWindowsSelectCallback;
1470a37b6a5eSdrh   w.xSelectCallback2 = 0;
14719c46c66cSdrh   w.pParse = 0;
1472a8389975Sdrh   w.u.pSelect = p;
1473a37b6a5eSdrh   sqlite3WalkSelect(&w, p);
1474a8389975Sdrh }
1475a8389975Sdrh #endif
1476a8389975Sdrh 
1477a8389975Sdrh 
1478a76b5dfcSdrh /*
1479ff78bd2fSdrh ** The following group of routines make deep copies of expressions,
1480ff78bd2fSdrh ** expression lists, ID lists, and select statements.  The copies can
1481ff78bd2fSdrh ** be deleted (by being passed to their respective ...Delete() routines)
1482ff78bd2fSdrh ** without effecting the originals.
1483ff78bd2fSdrh **
14844adee20fSdanielk1977 ** The expression list, ID, and source lists return by sqlite3ExprListDup(),
14854adee20fSdanielk1977 ** sqlite3IdListDup(), and sqlite3SrcListDup() can not be further expanded
1486ad3cab52Sdrh ** by subsequent calls to sqlite*ListAppend() routines.
1487ff78bd2fSdrh **
1488ad3cab52Sdrh ** Any tables that the SrcList might point to are not duplicated.
14896ab3a2ecSdanielk1977 **
1490b7916a78Sdrh ** The flags parameter contains a combination of the EXPRDUP_XXX flags.
14916ab3a2ecSdanielk1977 ** If the EXPRDUP_REDUCE flag is set, then the structure returned is a
14926ab3a2ecSdanielk1977 ** truncated version of the usual Expr structure that will be stored as
14936ab3a2ecSdanielk1977 ** part of the in-memory representation of the database schema.
1494ff78bd2fSdrh */
14956ab3a2ecSdanielk1977 Expr *sqlite3ExprDup(sqlite3 *db, Expr *p, int flags){
149672ea29d7Sdrh   assert( flags==0 || flags==EXPRDUP_REDUCE );
14973c19469cSdrh   return p ? exprDup(db, p, flags, 0) : 0;
1498ff78bd2fSdrh }
14996ab3a2ecSdanielk1977 ExprList *sqlite3ExprListDup(sqlite3 *db, ExprList *p, int flags){
1500ff78bd2fSdrh   ExprList *pNew;
1501145716b3Sdrh   struct ExprList_item *pItem, *pOldItem;
1502ff78bd2fSdrh   int i;
1503b163748eSdrh   Expr *pPriorSelectCol = 0;
1504575fad65Sdrh   assert( db!=0 );
1505ff78bd2fSdrh   if( p==0 ) return 0;
150697258194Sdrh   pNew = sqlite3DbMallocRawNN(db, sqlite3DbMallocSize(db, p));
1507ff78bd2fSdrh   if( pNew==0 ) return 0;
1508a19543feSdrh   pNew->nExpr = p->nExpr;
150950e43c50Sdrh   pNew->nAlloc = p->nAlloc;
151043606175Sdrh   pItem = pNew->a;
1511145716b3Sdrh   pOldItem = p->a;
1512145716b3Sdrh   for(i=0; i<p->nExpr; i++, pItem++, pOldItem++){
15136ab3a2ecSdanielk1977     Expr *pOldExpr = pOldItem->pExpr;
151447073f62Sdrh     Expr *pNewExpr;
1515b5526ea6Sdrh     pItem->pExpr = sqlite3ExprDup(db, pOldExpr, flags);
151647073f62Sdrh     if( pOldExpr
151747073f62Sdrh      && pOldExpr->op==TK_SELECT_COLUMN
151847073f62Sdrh      && (pNewExpr = pItem->pExpr)!=0
151947073f62Sdrh     ){
152047073f62Sdrh       assert( pNewExpr->iColumn==0 || i>0 );
152147073f62Sdrh       if( pNewExpr->iColumn==0 ){
152247073f62Sdrh         assert( pOldExpr->pLeft==pOldExpr->pRight );
1523b163748eSdrh         pPriorSelectCol = pNewExpr->pLeft = pNewExpr->pRight;
1524b163748eSdrh       }else{
1525b163748eSdrh         assert( i>0 );
1526b163748eSdrh         assert( pItem[-1].pExpr!=0 );
1527b163748eSdrh         assert( pNewExpr->iColumn==pItem[-1].pExpr->iColumn+1 );
1528b163748eSdrh         assert( pPriorSelectCol==pItem[-1].pExpr->pLeft );
1529b163748eSdrh         pNewExpr->pLeft = pPriorSelectCol;
153047073f62Sdrh       }
153147073f62Sdrh     }
153241cee668Sdrh     pItem->zEName = sqlite3DbStrDup(db, pOldItem->zEName);
15336e11892dSdan     pItem->sortFlags = pOldItem->sortFlags;
1534cbb9da33Sdrh     pItem->eEName = pOldItem->eEName;
15353e7bc9caSdrh     pItem->done = 0;
1536ae8e45cbSdan     pItem->bNulls = pOldItem->bNulls;
153724e25d32Sdan     pItem->bSorterRef = pOldItem->bSorterRef;
1538c2acc4e4Sdrh     pItem->u = pOldItem->u;
1539ff78bd2fSdrh   }
1540ff78bd2fSdrh   return pNew;
1541ff78bd2fSdrh }
154293758c8dSdanielk1977 
154393758c8dSdanielk1977 /*
154493758c8dSdanielk1977 ** If cursors, triggers, views and subqueries are all omitted from
154593758c8dSdanielk1977 ** the build, then none of the following routines, except for
154693758c8dSdanielk1977 ** sqlite3SelectDup(), can be called. sqlite3SelectDup() is sometimes
154793758c8dSdanielk1977 ** called with a NULL argument.
154893758c8dSdanielk1977 */
15496a67fe8eSdanielk1977 #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_TRIGGER) \
15506a67fe8eSdanielk1977  || !defined(SQLITE_OMIT_SUBQUERY)
15516ab3a2ecSdanielk1977 SrcList *sqlite3SrcListDup(sqlite3 *db, SrcList *p, int flags){
1552ad3cab52Sdrh   SrcList *pNew;
1553ad3cab52Sdrh   int i;
1554113088ecSdrh   int nByte;
1555575fad65Sdrh   assert( db!=0 );
1556ad3cab52Sdrh   if( p==0 ) return 0;
1557113088ecSdrh   nByte = sizeof(*p) + (p->nSrc>0 ? sizeof(p->a[0]) * (p->nSrc-1) : 0);
1558575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, nByte );
1559ad3cab52Sdrh   if( pNew==0 ) return 0;
15604305d103Sdrh   pNew->nSrc = pNew->nAlloc = p->nSrc;
1561ad3cab52Sdrh   for(i=0; i<p->nSrc; i++){
15627601294aSdrh     SrcItem *pNewItem = &pNew->a[i];
15637601294aSdrh     SrcItem *pOldItem = &p->a[i];
1564ed8a3bb1Sdrh     Table *pTab;
156541fb5cd1Sdan     pNewItem->pSchema = pOldItem->pSchema;
156617435752Sdrh     pNewItem->zDatabase = sqlite3DbStrDup(db, pOldItem->zDatabase);
156717435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
156817435752Sdrh     pNewItem->zAlias = sqlite3DbStrDup(db, pOldItem->zAlias);
15698a48b9c0Sdrh     pNewItem->fg = pOldItem->fg;
15704efc4754Sdrh     pNewItem->iCursor = pOldItem->iCursor;
15715b6a9ed4Sdrh     pNewItem->addrFillSub = pOldItem->addrFillSub;
15725b6a9ed4Sdrh     pNewItem->regReturn = pOldItem->regReturn;
15738a48b9c0Sdrh     if( pNewItem->fg.isIndexedBy ){
15748a48b9c0Sdrh       pNewItem->u1.zIndexedBy = sqlite3DbStrDup(db, pOldItem->u1.zIndexedBy);
15758a48b9c0Sdrh     }
1576a79e2a2dSdrh     pNewItem->u2 = pOldItem->u2;
1577a79e2a2dSdrh     if( pNewItem->fg.isCte ){
1578a79e2a2dSdrh       pNewItem->u2.pCteUse->nUse++;
1579a79e2a2dSdrh     }
15808a48b9c0Sdrh     if( pNewItem->fg.isTabFunc ){
15818a48b9c0Sdrh       pNewItem->u1.pFuncArg =
15828a48b9c0Sdrh           sqlite3ExprListDup(db, pOldItem->u1.pFuncArg, flags);
15838a48b9c0Sdrh     }
1584ed8a3bb1Sdrh     pTab = pNewItem->pTab = pOldItem->pTab;
1585ed8a3bb1Sdrh     if( pTab ){
158679df7782Sdrh       pTab->nTabRef++;
1587a1cb183dSdanielk1977     }
15886ab3a2ecSdanielk1977     pNewItem->pSelect = sqlite3SelectDup(db, pOldItem->pSelect, flags);
15896ab3a2ecSdanielk1977     pNewItem->pOn = sqlite3ExprDup(db, pOldItem->pOn, flags);
159017435752Sdrh     pNewItem->pUsing = sqlite3IdListDup(db, pOldItem->pUsing);
15916c18b6e0Sdanielk1977     pNewItem->colUsed = pOldItem->colUsed;
1592ad3cab52Sdrh   }
1593ad3cab52Sdrh   return pNew;
1594ad3cab52Sdrh }
159517435752Sdrh IdList *sqlite3IdListDup(sqlite3 *db, IdList *p){
1596ff78bd2fSdrh   IdList *pNew;
1597ff78bd2fSdrh   int i;
1598575fad65Sdrh   assert( db!=0 );
1599ff78bd2fSdrh   if( p==0 ) return 0;
1600575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, sizeof(*pNew) );
1601ff78bd2fSdrh   if( pNew==0 ) return 0;
16026c535158Sdrh   pNew->nId = p->nId;
1603575fad65Sdrh   pNew->a = sqlite3DbMallocRawNN(db, p->nId*sizeof(p->a[0]) );
1604d5d56523Sdanielk1977   if( pNew->a==0 ){
1605dbd6a7dcSdrh     sqlite3DbFreeNN(db, pNew);
1606d5d56523Sdanielk1977     return 0;
1607d5d56523Sdanielk1977   }
16086c535158Sdrh   /* Note that because the size of the allocation for p->a[] is not
16096c535158Sdrh   ** necessarily a power of two, sqlite3IdListAppend() may not be called
16106c535158Sdrh   ** on the duplicate created by this function. */
1611ff78bd2fSdrh   for(i=0; i<p->nId; i++){
16124efc4754Sdrh     struct IdList_item *pNewItem = &pNew->a[i];
16134efc4754Sdrh     struct IdList_item *pOldItem = &p->a[i];
161417435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
16154efc4754Sdrh     pNewItem->idx = pOldItem->idx;
1616ff78bd2fSdrh   }
1617ff78bd2fSdrh   return pNew;
1618ff78bd2fSdrh }
1619a7466205Sdan Select *sqlite3SelectDup(sqlite3 *db, Select *pDup, int flags){
1620a7466205Sdan   Select *pRet = 0;
1621a7466205Sdan   Select *pNext = 0;
1622a7466205Sdan   Select **pp = &pRet;
1623a7466205Sdan   Select *p;
1624a7466205Sdan 
1625575fad65Sdrh   assert( db!=0 );
1626a7466205Sdan   for(p=pDup; p; p=p->pPrior){
1627a7466205Sdan     Select *pNew = sqlite3DbMallocRawNN(db, sizeof(*p) );
1628a7466205Sdan     if( pNew==0 ) break;
1629b7916a78Sdrh     pNew->pEList = sqlite3ExprListDup(db, p->pEList, flags);
16306ab3a2ecSdanielk1977     pNew->pSrc = sqlite3SrcListDup(db, p->pSrc, flags);
16316ab3a2ecSdanielk1977     pNew->pWhere = sqlite3ExprDup(db, p->pWhere, flags);
16326ab3a2ecSdanielk1977     pNew->pGroupBy = sqlite3ExprListDup(db, p->pGroupBy, flags);
16336ab3a2ecSdanielk1977     pNew->pHaving = sqlite3ExprDup(db, p->pHaving, flags);
16346ab3a2ecSdanielk1977     pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, flags);
1635ff78bd2fSdrh     pNew->op = p->op;
1636a7466205Sdan     pNew->pNext = pNext;
1637a7466205Sdan     pNew->pPrior = 0;
16386ab3a2ecSdanielk1977     pNew->pLimit = sqlite3ExprDup(db, p->pLimit, flags);
163992b01d53Sdrh     pNew->iLimit = 0;
164092b01d53Sdrh     pNew->iOffset = 0;
16417d10d5a6Sdrh     pNew->selFlags = p->selFlags & ~SF_UsesEphemeral;
1642b9bb7c18Sdrh     pNew->addrOpenEphm[0] = -1;
1643b9bb7c18Sdrh     pNew->addrOpenEphm[1] = -1;
1644ec2da854Sdrh     pNew->nSelectRow = p->nSelectRow;
16454e9119d9Sdan     pNew->pWith = withDup(db, p->pWith);
164667a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
16472e362f97Sdan     pNew->pWin = 0;
1648c95f38d4Sdan     pNew->pWinDefn = sqlite3WindowListDup(db, p->pWinDefn);
16494780b9adSdan     if( p->pWin && db->mallocFailed==0 ) gatherSelectWindows(pNew);
165067a9b8edSdan #endif
1651fef37760Sdrh     pNew->selId = p->selId;
16529da977f1Sdrh     if( db->mallocFailed ){
16539da977f1Sdrh       /* Any prior OOM might have left the Select object incomplete.
16549da977f1Sdrh       ** Delete the whole thing rather than allow an incomplete Select
16559da977f1Sdrh       ** to be used by the code generator. */
16569da977f1Sdrh       pNew->pNext = 0;
16579da977f1Sdrh       sqlite3SelectDelete(db, pNew);
16589da977f1Sdrh       break;
16599da977f1Sdrh     }
1660a7466205Sdan     *pp = pNew;
1661a7466205Sdan     pp = &pNew->pPrior;
1662a7466205Sdan     pNext = pNew;
1663a7466205Sdan   }
1664a7466205Sdan 
1665a7466205Sdan   return pRet;
1666ff78bd2fSdrh }
166793758c8dSdanielk1977 #else
16686ab3a2ecSdanielk1977 Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
166993758c8dSdanielk1977   assert( p==0 );
167093758c8dSdanielk1977   return 0;
167193758c8dSdanielk1977 }
167293758c8dSdanielk1977 #endif
1673ff78bd2fSdrh 
1674ff78bd2fSdrh 
1675ff78bd2fSdrh /*
1676a76b5dfcSdrh ** Add a new element to the end of an expression list.  If pList is
1677a76b5dfcSdrh ** initially NULL, then create a new expression list.
1678b7916a78Sdrh **
1679a19543feSdrh ** The pList argument must be either NULL or a pointer to an ExprList
1680a19543feSdrh ** obtained from a prior call to sqlite3ExprListAppend().  This routine
1681a19543feSdrh ** may not be used with an ExprList obtained from sqlite3ExprListDup().
1682a19543feSdrh ** Reason:  This routine assumes that the number of slots in pList->a[]
1683a19543feSdrh ** is a power of two.  That is true for sqlite3ExprListAppend() returns
1684a19543feSdrh ** but is not necessarily true from the return value of sqlite3ExprListDup().
1685a19543feSdrh **
1686b7916a78Sdrh ** If a memory allocation error occurs, the entire list is freed and
1687b7916a78Sdrh ** NULL is returned.  If non-NULL is returned, then it is guaranteed
1688b7916a78Sdrh ** that the new entry was successfully appended.
1689a76b5dfcSdrh */
1690dabada60Slarrybr static const struct ExprList_item zeroItem = {0};
169150e43c50Sdrh SQLITE_NOINLINE ExprList *sqlite3ExprListAppendNew(
169250e43c50Sdrh   sqlite3 *db,            /* Database handle.  Used for memory allocation */
169350e43c50Sdrh   Expr *pExpr             /* Expression to be appended. Might be NULL */
169450e43c50Sdrh ){
169550e43c50Sdrh   struct ExprList_item *pItem;
169650e43c50Sdrh   ExprList *pList;
169750e43c50Sdrh 
169850e43c50Sdrh   pList = sqlite3DbMallocRawNN(db, sizeof(ExprList)+sizeof(pList->a[0])*4 );
169950e43c50Sdrh   if( pList==0 ){
170050e43c50Sdrh     sqlite3ExprDelete(db, pExpr);
170150e43c50Sdrh     return 0;
170250e43c50Sdrh   }
170350e43c50Sdrh   pList->nAlloc = 4;
170450e43c50Sdrh   pList->nExpr = 1;
170550e43c50Sdrh   pItem = &pList->a[0];
170650e43c50Sdrh   *pItem = zeroItem;
170750e43c50Sdrh   pItem->pExpr = pExpr;
170850e43c50Sdrh   return pList;
170950e43c50Sdrh }
171050e43c50Sdrh SQLITE_NOINLINE ExprList *sqlite3ExprListAppendGrow(
171150e43c50Sdrh   sqlite3 *db,            /* Database handle.  Used for memory allocation */
171250e43c50Sdrh   ExprList *pList,        /* List to which to append. Might be NULL */
171350e43c50Sdrh   Expr *pExpr             /* Expression to be appended. Might be NULL */
171450e43c50Sdrh ){
171550e43c50Sdrh   struct ExprList_item *pItem;
171650e43c50Sdrh   ExprList *pNew;
171750e43c50Sdrh   pList->nAlloc *= 2;
171850e43c50Sdrh   pNew = sqlite3DbRealloc(db, pList,
171950e43c50Sdrh        sizeof(*pList)+(pList->nAlloc-1)*sizeof(pList->a[0]));
172050e43c50Sdrh   if( pNew==0 ){
172150e43c50Sdrh     sqlite3ExprListDelete(db, pList);
172250e43c50Sdrh     sqlite3ExprDelete(db, pExpr);
172350e43c50Sdrh     return 0;
172450e43c50Sdrh   }else{
172550e43c50Sdrh     pList = pNew;
172650e43c50Sdrh   }
172750e43c50Sdrh   pItem = &pList->a[pList->nExpr++];
172850e43c50Sdrh   *pItem = zeroItem;
172950e43c50Sdrh   pItem->pExpr = pExpr;
173050e43c50Sdrh   return pList;
173150e43c50Sdrh }
173217435752Sdrh ExprList *sqlite3ExprListAppend(
173317435752Sdrh   Parse *pParse,          /* Parsing context */
173417435752Sdrh   ExprList *pList,        /* List to which to append. Might be NULL */
1735b7916a78Sdrh   Expr *pExpr             /* Expression to be appended. Might be NULL */
173617435752Sdrh ){
173743606175Sdrh   struct ExprList_item *pItem;
1738a76b5dfcSdrh   if( pList==0 ){
173950e43c50Sdrh     return sqlite3ExprListAppendNew(pParse->db,pExpr);
1740a76b5dfcSdrh   }
174150e43c50Sdrh   if( pList->nAlloc<pList->nExpr+1 ){
174250e43c50Sdrh     return sqlite3ExprListAppendGrow(pParse->db,pList,pExpr);
1743a76b5dfcSdrh   }
174443606175Sdrh   pItem = &pList->a[pList->nExpr++];
174550e43c50Sdrh   *pItem = zeroItem;
1746e94ddc9eSdanielk1977   pItem->pExpr = pExpr;
1747a76b5dfcSdrh   return pList;
1748a76b5dfcSdrh }
1749a76b5dfcSdrh 
1750a76b5dfcSdrh /*
17518762ec19Sdrh ** pColumns and pExpr form a vector assignment which is part of the SET
17528762ec19Sdrh ** clause of an UPDATE statement.  Like this:
1753a1251bc4Sdrh **
1754a1251bc4Sdrh **        (a,b,c) = (expr1,expr2,expr3)
1755a1251bc4Sdrh ** Or:    (a,b,c) = (SELECT x,y,z FROM ....)
1756a1251bc4Sdrh **
1757a1251bc4Sdrh ** For each term of the vector assignment, append new entries to the
1758b67343d0Sdrh ** expression list pList.  In the case of a subquery on the RHS, append
1759a1251bc4Sdrh ** TK_SELECT_COLUMN expressions.
1760a1251bc4Sdrh */
1761a1251bc4Sdrh ExprList *sqlite3ExprListAppendVector(
1762a1251bc4Sdrh   Parse *pParse,         /* Parsing context */
1763a1251bc4Sdrh   ExprList *pList,       /* List to which to append. Might be NULL */
1764a1251bc4Sdrh   IdList *pColumns,      /* List of names of LHS of the assignment */
1765a1251bc4Sdrh   Expr *pExpr            /* Vector expression to be appended. Might be NULL */
1766a1251bc4Sdrh ){
1767a1251bc4Sdrh   sqlite3 *db = pParse->db;
1768a1251bc4Sdrh   int n;
1769a1251bc4Sdrh   int i;
177066860af3Sdrh   int iFirst = pList ? pList->nExpr : 0;
1771321e828dSdrh   /* pColumns can only be NULL due to an OOM but an OOM will cause an
1772321e828dSdrh   ** exit prior to this routine being invoked */
1773321e828dSdrh   if( NEVER(pColumns==0) ) goto vector_append_error;
1774a1251bc4Sdrh   if( pExpr==0 ) goto vector_append_error;
1775966e2911Sdrh 
1776966e2911Sdrh   /* If the RHS is a vector, then we can immediately check to see that
1777966e2911Sdrh   ** the size of the RHS and LHS match.  But if the RHS is a SELECT,
1778966e2911Sdrh   ** wildcards ("*") in the result set of the SELECT must be expanded before
1779966e2911Sdrh   ** we can do the size check, so defer the size check until code generation.
1780966e2911Sdrh   */
1781966e2911Sdrh   if( pExpr->op!=TK_SELECT && pColumns->nId!=(n=sqlite3ExprVectorSize(pExpr)) ){
1782a1251bc4Sdrh     sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
1783a1251bc4Sdrh                     pColumns->nId, n);
1784a1251bc4Sdrh     goto vector_append_error;
1785a1251bc4Sdrh   }
1786966e2911Sdrh 
1787966e2911Sdrh   for(i=0; i<pColumns->nId; i++){
1788a1251bc4Sdrh     Expr *pSubExpr = sqlite3ExprForVectorField(pParse, pExpr, i);
1789554a9dc7Sdrh     assert( pSubExpr!=0 || db->mallocFailed );
1790554a9dc7Sdrh     assert( pSubExpr==0 || pSubExpr->iTable==0 );
1791554a9dc7Sdrh     if( pSubExpr==0 ) continue;
1792554a9dc7Sdrh     pSubExpr->iTable = pColumns->nId;
1793a1251bc4Sdrh     pList = sqlite3ExprListAppend(pParse, pList, pSubExpr);
1794a1251bc4Sdrh     if( pList ){
179566860af3Sdrh       assert( pList->nExpr==iFirst+i+1 );
179641cee668Sdrh       pList->a[pList->nExpr-1].zEName = pColumns->a[i].zName;
1797a1251bc4Sdrh       pColumns->a[i].zName = 0;
1798a1251bc4Sdrh     }
1799a1251bc4Sdrh   }
1800966e2911Sdrh 
1801ffe28059Sdrh   if( !db->mallocFailed && pExpr->op==TK_SELECT && ALWAYS(pList!=0) ){
1802966e2911Sdrh     Expr *pFirst = pList->a[iFirst].pExpr;
1803f4dd26c5Sdrh     assert( pFirst!=0 );
1804966e2911Sdrh     assert( pFirst->op==TK_SELECT_COLUMN );
1805966e2911Sdrh 
1806966e2911Sdrh     /* Store the SELECT statement in pRight so it will be deleted when
1807966e2911Sdrh     ** sqlite3ExprListDelete() is called */
1808966e2911Sdrh     pFirst->pRight = pExpr;
1809a1251bc4Sdrh     pExpr = 0;
1810966e2911Sdrh 
1811966e2911Sdrh     /* Remember the size of the LHS in iTable so that we can check that
1812966e2911Sdrh     ** the RHS and LHS sizes match during code generation. */
1813966e2911Sdrh     pFirst->iTable = pColumns->nId;
1814a1251bc4Sdrh   }
1815a1251bc4Sdrh 
1816a1251bc4Sdrh vector_append_error:
18178e34e406Sdrh   sqlite3ExprUnmapAndDelete(pParse, pExpr);
1818a1251bc4Sdrh   sqlite3IdListDelete(db, pColumns);
1819a1251bc4Sdrh   return pList;
1820a1251bc4Sdrh }
1821a1251bc4Sdrh 
1822a1251bc4Sdrh /*
1823bc622bc0Sdrh ** Set the sort order for the last element on the given ExprList.
1824bc622bc0Sdrh */
18256e11892dSdan void sqlite3ExprListSetSortOrder(ExprList *p, int iSortOrder, int eNulls){
18269105fd51Sdan   struct ExprList_item *pItem;
1827bc622bc0Sdrh   if( p==0 ) return;
1828bc622bc0Sdrh   assert( p->nExpr>0 );
18296e11892dSdan 
18306e11892dSdan   assert( SQLITE_SO_UNDEFINED<0 && SQLITE_SO_ASC==0 && SQLITE_SO_DESC>0 );
18316e11892dSdan   assert( iSortOrder==SQLITE_SO_UNDEFINED
18326e11892dSdan        || iSortOrder==SQLITE_SO_ASC
18336e11892dSdan        || iSortOrder==SQLITE_SO_DESC
18346e11892dSdan   );
18356e11892dSdan   assert( eNulls==SQLITE_SO_UNDEFINED
18366e11892dSdan        || eNulls==SQLITE_SO_ASC
18376e11892dSdan        || eNulls==SQLITE_SO_DESC
18386e11892dSdan   );
18396e11892dSdan 
18409105fd51Sdan   pItem = &p->a[p->nExpr-1];
18419105fd51Sdan   assert( pItem->bNulls==0 );
18429105fd51Sdan   if( iSortOrder==SQLITE_SO_UNDEFINED ){
18439105fd51Sdan     iSortOrder = SQLITE_SO_ASC;
1844bc622bc0Sdrh   }
18459105fd51Sdan   pItem->sortFlags = (u8)iSortOrder;
18469105fd51Sdan 
18479105fd51Sdan   if( eNulls!=SQLITE_SO_UNDEFINED ){
18489105fd51Sdan     pItem->bNulls = 1;
18499105fd51Sdan     if( iSortOrder!=eNulls ){
18509105fd51Sdan       pItem->sortFlags |= KEYINFO_ORDER_BIGNULL;
18519105fd51Sdan     }
1852bc622bc0Sdrh   }
1853bc622bc0Sdrh }
1854bc622bc0Sdrh 
1855bc622bc0Sdrh /*
185641cee668Sdrh ** Set the ExprList.a[].zEName element of the most recently added item
1857b7916a78Sdrh ** on the expression list.
1858b7916a78Sdrh **
1859b7916a78Sdrh ** pList might be NULL following an OOM error.  But pName should never be
1860b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1861b7916a78Sdrh ** is set.
1862b7916a78Sdrh */
1863b7916a78Sdrh void sqlite3ExprListSetName(
1864b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1865b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
1866b7916a78Sdrh   Token *pName,           /* Name to be added */
1867b7916a78Sdrh   int dequote             /* True to cause the name to be dequoted */
1868b7916a78Sdrh ){
1869b7916a78Sdrh   assert( pList!=0 || pParse->db->mallocFailed!=0 );
18702d99f957Sdrh   assert( pParse->eParseMode!=PARSE_MODE_UNMAP || dequote==0 );
1871b7916a78Sdrh   if( pList ){
1872b7916a78Sdrh     struct ExprList_item *pItem;
1873b7916a78Sdrh     assert( pList->nExpr>0 );
1874b7916a78Sdrh     pItem = &pList->a[pList->nExpr-1];
187541cee668Sdrh     assert( pItem->zEName==0 );
1876c4938ea2Sdrh     assert( pItem->eEName==ENAME_NAME );
187741cee668Sdrh     pItem->zEName = sqlite3DbStrNDup(pParse->db, pName->z, pName->n);
187885f2c76cSdan     if( dequote ){
187985f2c76cSdan       /* If dequote==0, then pName->z does not point to part of a DDL
188085f2c76cSdan       ** statement handled by the parser. And so no token need be added
188185f2c76cSdan       ** to the token-map.  */
188285f2c76cSdan       sqlite3Dequote(pItem->zEName);
1883c9461eccSdan       if( IN_RENAME_OBJECT ){
188441cee668Sdrh         sqlite3RenameTokenMap(pParse, (void*)pItem->zEName, pName);
18855be60c55Sdan       }
1886b7916a78Sdrh     }
1887b7916a78Sdrh   }
188885f2c76cSdan }
1889b7916a78Sdrh 
1890b7916a78Sdrh /*
1891b7916a78Sdrh ** Set the ExprList.a[].zSpan element of the most recently added item
1892b7916a78Sdrh ** on the expression list.
1893b7916a78Sdrh **
1894b7916a78Sdrh ** pList might be NULL following an OOM error.  But pSpan should never be
1895b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1896b7916a78Sdrh ** is set.
1897b7916a78Sdrh */
1898b7916a78Sdrh void sqlite3ExprListSetSpan(
1899b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1900b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
19011be266baSdrh   const char *zStart,     /* Start of the span */
19021be266baSdrh   const char *zEnd        /* End of the span */
1903b7916a78Sdrh ){
1904b7916a78Sdrh   sqlite3 *db = pParse->db;
1905b7916a78Sdrh   assert( pList!=0 || db->mallocFailed!=0 );
1906b7916a78Sdrh   if( pList ){
1907b7916a78Sdrh     struct ExprList_item *pItem = &pList->a[pList->nExpr-1];
1908b7916a78Sdrh     assert( pList->nExpr>0 );
1909cbb9da33Sdrh     if( pItem->zEName==0 ){
1910cbb9da33Sdrh       pItem->zEName = sqlite3DbSpanDup(db, zStart, zEnd);
1911cbb9da33Sdrh       pItem->eEName = ENAME_SPAN;
1912cbb9da33Sdrh     }
1913b7916a78Sdrh   }
1914b7916a78Sdrh }
1915b7916a78Sdrh 
1916b7916a78Sdrh /*
19177a15a4beSdanielk1977 ** If the expression list pEList contains more than iLimit elements,
19187a15a4beSdanielk1977 ** leave an error message in pParse.
19197a15a4beSdanielk1977 */
19207a15a4beSdanielk1977 void sqlite3ExprListCheckLength(
19217a15a4beSdanielk1977   Parse *pParse,
19227a15a4beSdanielk1977   ExprList *pEList,
19237a15a4beSdanielk1977   const char *zObject
19247a15a4beSdanielk1977 ){
1925b1a6c3c1Sdrh   int mx = pParse->db->aLimit[SQLITE_LIMIT_COLUMN];
1926c5499befSdrh   testcase( pEList && pEList->nExpr==mx );
1927c5499befSdrh   testcase( pEList && pEList->nExpr==mx+1 );
1928b1a6c3c1Sdrh   if( pEList && pEList->nExpr>mx ){
19297a15a4beSdanielk1977     sqlite3ErrorMsg(pParse, "too many columns in %s", zObject);
19307a15a4beSdanielk1977   }
19317a15a4beSdanielk1977 }
19327a15a4beSdanielk1977 
19337a15a4beSdanielk1977 /*
1934a76b5dfcSdrh ** Delete an entire expression list.
1935a76b5dfcSdrh */
1936affa855cSdrh static SQLITE_NOINLINE void exprListDeleteNN(sqlite3 *db, ExprList *pList){
1937ac48b751Sdrh   int i = pList->nExpr;
1938ac48b751Sdrh   struct ExprList_item *pItem =  pList->a;
1939ac48b751Sdrh   assert( pList->nExpr>0 );
1940ac48b751Sdrh   do{
1941633e6d57Sdrh     sqlite3ExprDelete(db, pItem->pExpr);
194241cee668Sdrh     sqlite3DbFree(db, pItem->zEName);
1943ac48b751Sdrh     pItem++;
1944ac48b751Sdrh   }while( --i>0 );
1945dbd6a7dcSdrh   sqlite3DbFreeNN(db, pList);
1946a76b5dfcSdrh }
1947affa855cSdrh void sqlite3ExprListDelete(sqlite3 *db, ExprList *pList){
1948affa855cSdrh   if( pList ) exprListDeleteNN(db, pList);
1949affa855cSdrh }
1950a76b5dfcSdrh 
1951a76b5dfcSdrh /*
19522308ed38Sdrh ** Return the bitwise-OR of all Expr.flags fields in the given
19532308ed38Sdrh ** ExprList.
1954885a5b03Sdrh */
19552308ed38Sdrh u32 sqlite3ExprListFlags(const ExprList *pList){
1956885a5b03Sdrh   int i;
19572308ed38Sdrh   u32 m = 0;
1958508e2d00Sdrh   assert( pList!=0 );
1959885a5b03Sdrh   for(i=0; i<pList->nExpr; i++){
1960d0c73053Sdrh      Expr *pExpr = pList->a[i].pExpr;
1961de845c2fSdrh      assert( pExpr!=0 );
1962de845c2fSdrh      m |= pExpr->flags;
1963885a5b03Sdrh   }
19642308ed38Sdrh   return m;
1965885a5b03Sdrh }
1966885a5b03Sdrh 
1967885a5b03Sdrh /*
19687e6f980bSdrh ** This is a SELECT-node callback for the expression walker that
19697e6f980bSdrh ** always "fails".  By "fail" in this case, we mean set
19707e6f980bSdrh ** pWalker->eCode to zero and abort.
19717e6f980bSdrh **
19727e6f980bSdrh ** This callback is used by multiple expression walkers.
19737e6f980bSdrh */
19747e6f980bSdrh int sqlite3SelectWalkFail(Walker *pWalker, Select *NotUsed){
19757e6f980bSdrh   UNUSED_PARAMETER(NotUsed);
19767e6f980bSdrh   pWalker->eCode = 0;
19777e6f980bSdrh   return WRC_Abort;
19787e6f980bSdrh }
19797e6f980bSdrh 
19807e6f980bSdrh /*
19810cbec59cSdrh ** Check the input string to see if it is "true" or "false" (in any case).
19820cbec59cSdrh **
19830cbec59cSdrh **       If the string is....           Return
19840cbec59cSdrh **         "true"                         EP_IsTrue
19850cbec59cSdrh **         "false"                        EP_IsFalse
19860cbec59cSdrh **         anything else                  0
19870cbec59cSdrh */
19880cbec59cSdrh u32 sqlite3IsTrueOrFalse(const char *zIn){
19890cbec59cSdrh   if( sqlite3StrICmp(zIn, "true")==0  ) return EP_IsTrue;
19900cbec59cSdrh   if( sqlite3StrICmp(zIn, "false")==0 ) return EP_IsFalse;
19910cbec59cSdrh   return 0;
19920cbec59cSdrh }
19930cbec59cSdrh 
19940cbec59cSdrh 
19950cbec59cSdrh /*
1996171d16bbSdrh ** If the input expression is an ID with the name "true" or "false"
199796acafbeSdrh ** then convert it into an TK_TRUEFALSE term.  Return non-zero if
199896acafbeSdrh ** the conversion happened, and zero if the expression is unaltered.
1999171d16bbSdrh */
2000171d16bbSdrh int sqlite3ExprIdToTrueFalse(Expr *pExpr){
20010cbec59cSdrh   u32 v;
2002171d16bbSdrh   assert( pExpr->op==TK_ID || pExpr->op==TK_STRING );
200351d35b0fSdrh   if( !ExprHasProperty(pExpr, EP_Quoted)
20040cbec59cSdrh    && (v = sqlite3IsTrueOrFalse(pExpr->u.zToken))!=0
2005171d16bbSdrh   ){
2006171d16bbSdrh     pExpr->op = TK_TRUEFALSE;
20070cbec59cSdrh     ExprSetProperty(pExpr, v);
2008171d16bbSdrh     return 1;
2009171d16bbSdrh   }
2010171d16bbSdrh   return 0;
2011171d16bbSdrh }
2012171d16bbSdrh 
201343c4ac8bSdrh /*
201496acafbeSdrh ** The argument must be a TK_TRUEFALSE Expr node.  Return 1 if it is TRUE
201543c4ac8bSdrh ** and 0 if it is FALSE.
201643c4ac8bSdrh */
201796acafbeSdrh int sqlite3ExprTruthValue(const Expr *pExpr){
20186ece353fSdan   pExpr = sqlite3ExprSkipCollate((Expr*)pExpr);
201943c4ac8bSdrh   assert( pExpr->op==TK_TRUEFALSE );
202043c4ac8bSdrh   assert( sqlite3StrICmp(pExpr->u.zToken,"true")==0
202143c4ac8bSdrh        || sqlite3StrICmp(pExpr->u.zToken,"false")==0 );
202243c4ac8bSdrh   return pExpr->u.zToken[4]==0;
202343c4ac8bSdrh }
202443c4ac8bSdrh 
202517180fcaSdrh /*
202617180fcaSdrh ** If pExpr is an AND or OR expression, try to simplify it by eliminating
202717180fcaSdrh ** terms that are always true or false.  Return the simplified expression.
202817180fcaSdrh ** Or return the original expression if no simplification is possible.
202917180fcaSdrh **
203017180fcaSdrh ** Examples:
203117180fcaSdrh **
203217180fcaSdrh **     (x<10) AND true                =>   (x<10)
203317180fcaSdrh **     (x<10) AND false               =>   false
203417180fcaSdrh **     (x<10) AND (y=22 OR false)     =>   (x<10) AND (y=22)
203517180fcaSdrh **     (x<10) AND (y=22 OR true)      =>   (x<10)
203617180fcaSdrh **     (y=22) OR true                 =>   true
203717180fcaSdrh */
203817180fcaSdrh Expr *sqlite3ExprSimplifiedAndOr(Expr *pExpr){
203917180fcaSdrh   assert( pExpr!=0 );
204017180fcaSdrh   if( pExpr->op==TK_AND || pExpr->op==TK_OR ){
204117180fcaSdrh     Expr *pRight = sqlite3ExprSimplifiedAndOr(pExpr->pRight);
204217180fcaSdrh     Expr *pLeft = sqlite3ExprSimplifiedAndOr(pExpr->pLeft);
204317180fcaSdrh     if( ExprAlwaysTrue(pLeft) || ExprAlwaysFalse(pRight) ){
204417180fcaSdrh       pExpr = pExpr->op==TK_AND ? pRight : pLeft;
204517180fcaSdrh     }else if( ExprAlwaysTrue(pRight) || ExprAlwaysFalse(pLeft) ){
204617180fcaSdrh       pExpr = pExpr->op==TK_AND ? pLeft : pRight;
204717180fcaSdrh     }
204817180fcaSdrh   }
204917180fcaSdrh   return pExpr;
205017180fcaSdrh }
205117180fcaSdrh 
2052171d16bbSdrh 
2053171d16bbSdrh /*
2054059b2d50Sdrh ** These routines are Walker callbacks used to check expressions to
2055059b2d50Sdrh ** see if they are "constant" for some definition of constant.  The
2056059b2d50Sdrh ** Walker.eCode value determines the type of "constant" we are looking
2057059b2d50Sdrh ** for.
205873b211abSdrh **
20597d10d5a6Sdrh ** These callback routines are used to implement the following:
2060626a879aSdrh **
2061059b2d50Sdrh **     sqlite3ExprIsConstant()                  pWalker->eCode==1
2062059b2d50Sdrh **     sqlite3ExprIsConstantNotJoin()           pWalker->eCode==2
2063fcb9f4f3Sdrh **     sqlite3ExprIsTableConstant()             pWalker->eCode==3
2064059b2d50Sdrh **     sqlite3ExprIsConstantOrFunction()        pWalker->eCode==4 or 5
206587abf5c0Sdrh **
2066059b2d50Sdrh ** In all cases, the callbacks set Walker.eCode=0 and abort if the expression
2067059b2d50Sdrh ** is found to not be a constant.
206887abf5c0Sdrh **
2069014fff20Sdrh ** The sqlite3ExprIsConstantOrFunction() is used for evaluating DEFAULT
2070014fff20Sdrh ** expressions in a CREATE TABLE statement.  The Walker.eCode value is 5
20711e32bed3Sdrh ** when parsing an existing schema out of the sqlite_schema table and 4
2072014fff20Sdrh ** when processing a new CREATE TABLE statement.  A bound parameter raises
2073014fff20Sdrh ** an error for new statements, but is silently converted
20741e32bed3Sdrh ** to NULL for existing schemas.  This allows sqlite_schema tables that
2075feada2dfSdrh ** contain a bound parameter because they were generated by older versions
2076feada2dfSdrh ** of SQLite to be parsed by newer versions of SQLite without raising a
2077feada2dfSdrh ** malformed schema error.
2078626a879aSdrh */
20797d10d5a6Sdrh static int exprNodeIsConstant(Walker *pWalker, Expr *pExpr){
2080626a879aSdrh 
2081059b2d50Sdrh   /* If pWalker->eCode is 2 then any term of the expression that comes from
2082059b2d50Sdrh   ** the ON or USING clauses of a left join disqualifies the expression
20830a168377Sdrh   ** from being considered constant. */
2084059b2d50Sdrh   if( pWalker->eCode==2 && ExprHasProperty(pExpr, EP_FromJoin) ){
2085059b2d50Sdrh     pWalker->eCode = 0;
20867d10d5a6Sdrh     return WRC_Abort;
20870a168377Sdrh   }
20880a168377Sdrh 
2089626a879aSdrh   switch( pExpr->op ){
2090eb55bd2fSdrh     /* Consider functions to be constant if all their arguments are constant
2091059b2d50Sdrh     ** and either pWalker->eCode==4 or 5 or the function has the
2092059b2d50Sdrh     ** SQLITE_FUNC_CONST flag. */
2093eb55bd2fSdrh     case TK_FUNCTION:
2094a634c9e6Sdrh       if( (pWalker->eCode>=4 || ExprHasProperty(pExpr,EP_ConstFunc))
2095a634c9e6Sdrh        && !ExprHasProperty(pExpr, EP_WinFunc)
2096a634c9e6Sdrh       ){
2097014fff20Sdrh         if( pWalker->eCode==5 ) ExprSetProperty(pExpr, EP_FromDDL);
2098b1fba286Sdrh         return WRC_Continue;
2099059b2d50Sdrh       }else{
2100059b2d50Sdrh         pWalker->eCode = 0;
2101059b2d50Sdrh         return WRC_Abort;
2102b1fba286Sdrh       }
2103626a879aSdrh     case TK_ID:
2104171d16bbSdrh       /* Convert "true" or "false" in a DEFAULT clause into the
2105171d16bbSdrh       ** appropriate TK_TRUEFALSE operator */
2106e39ef31cSdrh       if( sqlite3ExprIdToTrueFalse(pExpr) ){
2107171d16bbSdrh         return WRC_Prune;
2108171d16bbSdrh       }
210908b92086Sdrh       /* no break */ deliberate_fall_through
2110626a879aSdrh     case TK_COLUMN:
2111626a879aSdrh     case TK_AGG_FUNCTION:
211213449892Sdrh     case TK_AGG_COLUMN:
2113c5499befSdrh       testcase( pExpr->op==TK_ID );
2114c5499befSdrh       testcase( pExpr->op==TK_COLUMN );
2115c5499befSdrh       testcase( pExpr->op==TK_AGG_FUNCTION );
2116c5499befSdrh       testcase( pExpr->op==TK_AGG_COLUMN );
211707aded63Sdrh       if( ExprHasProperty(pExpr, EP_FixedCol) && pWalker->eCode!=2 ){
2118efad2e23Sdrh         return WRC_Continue;
2119efad2e23Sdrh       }
2120059b2d50Sdrh       if( pWalker->eCode==3 && pExpr->iTable==pWalker->u.iCur ){
2121059b2d50Sdrh         return WRC_Continue;
2122f43ce0b4Sdrh       }
212308b92086Sdrh       /* no break */ deliberate_fall_through
2124f43ce0b4Sdrh     case TK_IF_NULL_ROW:
21256e341b93Sdrh     case TK_REGISTER:
212674e0d966Sdrh     case TK_DOT:
21279916048bSdrh       testcase( pExpr->op==TK_REGISTER );
2128f43ce0b4Sdrh       testcase( pExpr->op==TK_IF_NULL_ROW );
212974e0d966Sdrh       testcase( pExpr->op==TK_DOT );
2130059b2d50Sdrh       pWalker->eCode = 0;
21317d10d5a6Sdrh       return WRC_Abort;
2132feada2dfSdrh     case TK_VARIABLE:
2133059b2d50Sdrh       if( pWalker->eCode==5 ){
2134feada2dfSdrh         /* Silently convert bound parameters that appear inside of CREATE
2135feada2dfSdrh         ** statements into a NULL when parsing the CREATE statement text out
21361e32bed3Sdrh         ** of the sqlite_schema table */
2137feada2dfSdrh         pExpr->op = TK_NULL;
2138059b2d50Sdrh       }else if( pWalker->eCode==4 ){
2139feada2dfSdrh         /* A bound parameter in a CREATE statement that originates from
2140feada2dfSdrh         ** sqlite3_prepare() causes an error */
2141059b2d50Sdrh         pWalker->eCode = 0;
2142feada2dfSdrh         return WRC_Abort;
2143feada2dfSdrh       }
214408b92086Sdrh       /* no break */ deliberate_fall_through
2145626a879aSdrh     default:
21466e341b93Sdrh       testcase( pExpr->op==TK_SELECT ); /* sqlite3SelectWalkFail() disallows */
21476e341b93Sdrh       testcase( pExpr->op==TK_EXISTS ); /* sqlite3SelectWalkFail() disallows */
21487d10d5a6Sdrh       return WRC_Continue;
2149626a879aSdrh   }
2150626a879aSdrh }
2151059b2d50Sdrh static int exprIsConst(Expr *p, int initFlag, int iCur){
21527d10d5a6Sdrh   Walker w;
2153059b2d50Sdrh   w.eCode = initFlag;
21547d10d5a6Sdrh   w.xExprCallback = exprNodeIsConstant;
21557e6f980bSdrh   w.xSelectCallback = sqlite3SelectWalkFail;
2156979dd1beSdrh #ifdef SQLITE_DEBUG
2157979dd1beSdrh   w.xSelectCallback2 = sqlite3SelectWalkAssert2;
2158979dd1beSdrh #endif
2159059b2d50Sdrh   w.u.iCur = iCur;
21607d10d5a6Sdrh   sqlite3WalkExpr(&w, p);
2161059b2d50Sdrh   return w.eCode;
21627d10d5a6Sdrh }
2163626a879aSdrh 
2164626a879aSdrh /*
2165059b2d50Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
2166eb55bd2fSdrh ** and 0 if it involves variables or function calls.
21672398937bSdrh **
21682398937bSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
21692398937bSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
21702398937bSdrh ** a constant.
2171fef5208cSdrh */
21724adee20fSdanielk1977 int sqlite3ExprIsConstant(Expr *p){
2173059b2d50Sdrh   return exprIsConst(p, 1, 0);
2174fef5208cSdrh }
2175fef5208cSdrh 
2176fef5208cSdrh /*
217707aded63Sdrh ** Walk an expression tree.  Return non-zero if
217807aded63Sdrh **
217907aded63Sdrh **   (1) the expression is constant, and
218007aded63Sdrh **   (2) the expression does originate in the ON or USING clause
218107aded63Sdrh **       of a LEFT JOIN, and
218207aded63Sdrh **   (3) the expression does not contain any EP_FixedCol TK_COLUMN
218307aded63Sdrh **       operands created by the constant propagation optimization.
218407aded63Sdrh **
218507aded63Sdrh ** When this routine returns true, it indicates that the expression
218607aded63Sdrh ** can be added to the pParse->pConstExpr list and evaluated once when
21879b258c54Sdrh ** the prepared statement starts up.  See sqlite3ExprCodeRunJustOnce().
21880a168377Sdrh */
21890a168377Sdrh int sqlite3ExprIsConstantNotJoin(Expr *p){
2190059b2d50Sdrh   return exprIsConst(p, 2, 0);
21910a168377Sdrh }
21920a168377Sdrh 
21930a168377Sdrh /*
2194fcb9f4f3Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
2195059b2d50Sdrh ** for any single row of the table with cursor iCur.  In other words, the
2196059b2d50Sdrh ** expression must not refer to any non-deterministic function nor any
2197059b2d50Sdrh ** table other than iCur.
2198059b2d50Sdrh */
2199059b2d50Sdrh int sqlite3ExprIsTableConstant(Expr *p, int iCur){
2200059b2d50Sdrh   return exprIsConst(p, 3, iCur);
2201059b2d50Sdrh }
2202059b2d50Sdrh 
2203ab31a845Sdan 
2204ab31a845Sdan /*
2205ab31a845Sdan ** sqlite3WalkExpr() callback used by sqlite3ExprIsConstantOrGroupBy().
2206ab31a845Sdan */
2207ab31a845Sdan static int exprNodeIsConstantOrGroupBy(Walker *pWalker, Expr *pExpr){
2208ab31a845Sdan   ExprList *pGroupBy = pWalker->u.pGroupBy;
2209ab31a845Sdan   int i;
2210ab31a845Sdan 
2211ab31a845Sdan   /* Check if pExpr is identical to any GROUP BY term. If so, consider
2212ab31a845Sdan   ** it constant.  */
2213ab31a845Sdan   for(i=0; i<pGroupBy->nExpr; i++){
2214ab31a845Sdan     Expr *p = pGroupBy->a[i].pExpr;
22155aa550cfSdan     if( sqlite3ExprCompare(0, pExpr, p, -1)<2 ){
221670efa84dSdrh       CollSeq *pColl = sqlite3ExprNNCollSeq(pWalker->pParse, p);
2217efad2e23Sdrh       if( sqlite3IsBinary(pColl) ){
2218ab31a845Sdan         return WRC_Prune;
2219ab31a845Sdan       }
2220ab31a845Sdan     }
2221ab31a845Sdan   }
2222ab31a845Sdan 
2223ab31a845Sdan   /* Check if pExpr is a sub-select. If so, consider it variable. */
2224ab31a845Sdan   if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2225ab31a845Sdan     pWalker->eCode = 0;
2226ab31a845Sdan     return WRC_Abort;
2227ab31a845Sdan   }
2228ab31a845Sdan 
2229ab31a845Sdan   return exprNodeIsConstant(pWalker, pExpr);
2230ab31a845Sdan }
2231ab31a845Sdan 
2232ab31a845Sdan /*
2233ab31a845Sdan ** Walk the expression tree passed as the first argument. Return non-zero
2234ab31a845Sdan ** if the expression consists entirely of constants or copies of terms
2235ab31a845Sdan ** in pGroupBy that sort with the BINARY collation sequence.
2236ab314001Sdrh **
2237ab314001Sdrh ** This routine is used to determine if a term of the HAVING clause can
2238ab314001Sdrh ** be promoted into the WHERE clause.  In order for such a promotion to work,
2239ab314001Sdrh ** the value of the HAVING clause term must be the same for all members of
2240ab314001Sdrh ** a "group".  The requirement that the GROUP BY term must be BINARY
2241ab314001Sdrh ** assumes that no other collating sequence will have a finer-grained
2242ab314001Sdrh ** grouping than binary.  In other words (A=B COLLATE binary) implies
2243ab314001Sdrh ** A=B in every other collating sequence.  The requirement that the
2244ab314001Sdrh ** GROUP BY be BINARY is stricter than necessary.  It would also work
2245ab314001Sdrh ** to promote HAVING clauses that use the same alternative collating
2246ab314001Sdrh ** sequence as the GROUP BY term, but that is much harder to check,
2247ab314001Sdrh ** alternative collating sequences are uncommon, and this is only an
2248ab314001Sdrh ** optimization, so we take the easy way out and simply require the
2249ab314001Sdrh ** GROUP BY to use the BINARY collating sequence.
2250ab31a845Sdan */
2251ab31a845Sdan int sqlite3ExprIsConstantOrGroupBy(Parse *pParse, Expr *p, ExprList *pGroupBy){
2252ab31a845Sdan   Walker w;
2253ab31a845Sdan   w.eCode = 1;
2254ab31a845Sdan   w.xExprCallback = exprNodeIsConstantOrGroupBy;
2255979dd1beSdrh   w.xSelectCallback = 0;
2256ab31a845Sdan   w.u.pGroupBy = pGroupBy;
2257ab31a845Sdan   w.pParse = pParse;
2258ab31a845Sdan   sqlite3WalkExpr(&w, p);
2259ab31a845Sdan   return w.eCode;
2260ab31a845Sdan }
2261ab31a845Sdan 
2262059b2d50Sdrh /*
2263014fff20Sdrh ** Walk an expression tree for the DEFAULT field of a column definition
2264014fff20Sdrh ** in a CREATE TABLE statement.  Return non-zero if the expression is
2265014fff20Sdrh ** acceptable for use as a DEFAULT.  That is to say, return non-zero if
2266014fff20Sdrh ** the expression is constant or a function call with constant arguments.
2267014fff20Sdrh ** Return and 0 if there are any variables.
2268014fff20Sdrh **
22691e32bed3Sdrh ** isInit is true when parsing from sqlite_schema.  isInit is false when
2270014fff20Sdrh ** processing a new CREATE TABLE statement.  When isInit is true, parameters
2271014fff20Sdrh ** (such as ? or $abc) in the expression are converted into NULL.  When
2272014fff20Sdrh ** isInit is false, parameters raise an error.  Parameters should not be
2273014fff20Sdrh ** allowed in a CREATE TABLE statement, but some legacy versions of SQLite
22741e32bed3Sdrh ** allowed it, so we need to support it when reading sqlite_schema for
2275014fff20Sdrh ** backwards compatibility.
2276014fff20Sdrh **
2277014fff20Sdrh ** If isInit is true, set EP_FromDDL on every TK_FUNCTION node.
2278eb55bd2fSdrh **
2279eb55bd2fSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
2280eb55bd2fSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
2281eb55bd2fSdrh ** a constant.
2282eb55bd2fSdrh */
2283feada2dfSdrh int sqlite3ExprIsConstantOrFunction(Expr *p, u8 isInit){
2284feada2dfSdrh   assert( isInit==0 || isInit==1 );
2285059b2d50Sdrh   return exprIsConst(p, 4+isInit, 0);
2286eb55bd2fSdrh }
2287eb55bd2fSdrh 
22885b88bc4bSdrh #ifdef SQLITE_ENABLE_CURSOR_HINTS
22895b88bc4bSdrh /*
22905b88bc4bSdrh ** Walk an expression tree.  Return 1 if the expression contains a
22915b88bc4bSdrh ** subquery of some kind.  Return 0 if there are no subqueries.
22925b88bc4bSdrh */
22935b88bc4bSdrh int sqlite3ExprContainsSubquery(Expr *p){
22945b88bc4bSdrh   Walker w;
2295bec2476aSdrh   w.eCode = 1;
22965b88bc4bSdrh   w.xExprCallback = sqlite3ExprWalkNoop;
22977e6f980bSdrh   w.xSelectCallback = sqlite3SelectWalkFail;
2298979dd1beSdrh #ifdef SQLITE_DEBUG
2299979dd1beSdrh   w.xSelectCallback2 = sqlite3SelectWalkAssert2;
2300979dd1beSdrh #endif
23015b88bc4bSdrh   sqlite3WalkExpr(&w, p);
230207194bffSdrh   return w.eCode==0;
23035b88bc4bSdrh }
23045b88bc4bSdrh #endif
23055b88bc4bSdrh 
2306eb55bd2fSdrh /*
230773b211abSdrh ** If the expression p codes a constant integer that is small enough
2308202b2df7Sdrh ** to fit in a 32-bit integer, return 1 and put the value of the integer
2309202b2df7Sdrh ** in *pValue.  If the expression is not an integer or if it is too big
2310202b2df7Sdrh ** to fit in a signed 32-bit integer, return 0 and leave *pValue unchanged.
2311e4de1febSdrh */
23124adee20fSdanielk1977 int sqlite3ExprIsInteger(Expr *p, int *pValue){
231392b01d53Sdrh   int rc = 0;
23141d2d71a0Sdrh   if( NEVER(p==0) ) return 0;  /* Used to only happen following on OOM */
2315cd92e84dSdrh 
2316cd92e84dSdrh   /* If an expression is an integer literal that fits in a signed 32-bit
2317cd92e84dSdrh   ** integer, then the EP_IntValue flag will have already been set */
2318cd92e84dSdrh   assert( p->op!=TK_INTEGER || (p->flags & EP_IntValue)!=0
2319cd92e84dSdrh            || sqlite3GetInt32(p->u.zToken, &rc)==0 );
2320cd92e84dSdrh 
232192b01d53Sdrh   if( p->flags & EP_IntValue ){
232233e619fcSdrh     *pValue = p->u.iValue;
2323e4de1febSdrh     return 1;
2324e4de1febSdrh   }
232592b01d53Sdrh   switch( p->op ){
23264b59ab5eSdrh     case TK_UPLUS: {
232792b01d53Sdrh       rc = sqlite3ExprIsInteger(p->pLeft, pValue);
2328f6e369a1Sdrh       break;
23294b59ab5eSdrh     }
2330e4de1febSdrh     case TK_UMINUS: {
2331e4de1febSdrh       int v;
23324adee20fSdanielk1977       if( sqlite3ExprIsInteger(p->pLeft, &v) ){
2333f6418891Smistachkin         assert( v!=(-2147483647-1) );
2334e4de1febSdrh         *pValue = -v;
233592b01d53Sdrh         rc = 1;
2336e4de1febSdrh       }
2337e4de1febSdrh       break;
2338e4de1febSdrh     }
2339e4de1febSdrh     default: break;
2340e4de1febSdrh   }
234192b01d53Sdrh   return rc;
2342e4de1febSdrh }
2343e4de1febSdrh 
2344e4de1febSdrh /*
2345039fc32eSdrh ** Return FALSE if there is no chance that the expression can be NULL.
2346039fc32eSdrh **
2347039fc32eSdrh ** If the expression might be NULL or if the expression is too complex
2348039fc32eSdrh ** to tell return TRUE.
2349039fc32eSdrh **
2350039fc32eSdrh ** This routine is used as an optimization, to skip OP_IsNull opcodes
2351039fc32eSdrh ** when we know that a value cannot be NULL.  Hence, a false positive
2352039fc32eSdrh ** (returning TRUE when in fact the expression can never be NULL) might
2353039fc32eSdrh ** be a small performance hit but is otherwise harmless.  On the other
2354039fc32eSdrh ** hand, a false negative (returning FALSE when the result could be NULL)
2355039fc32eSdrh ** will likely result in an incorrect answer.  So when in doubt, return
2356039fc32eSdrh ** TRUE.
2357039fc32eSdrh */
2358039fc32eSdrh int sqlite3ExprCanBeNull(const Expr *p){
2359039fc32eSdrh   u8 op;
2360*3c6edc8aSdrh   assert( p!=0 );
23619bfb0794Sdrh   while( p->op==TK_UPLUS || p->op==TK_UMINUS ){
23629bfb0794Sdrh     p = p->pLeft;
2363*3c6edc8aSdrh     assert( p!=0 );
23649bfb0794Sdrh   }
2365039fc32eSdrh   op = p->op;
2366039fc32eSdrh   if( op==TK_REGISTER ) op = p->op2;
2367039fc32eSdrh   switch( op ){
2368039fc32eSdrh     case TK_INTEGER:
2369039fc32eSdrh     case TK_STRING:
2370039fc32eSdrh     case TK_FLOAT:
2371039fc32eSdrh     case TK_BLOB:
2372039fc32eSdrh       return 0;
23737248a8b2Sdrh     case TK_COLUMN:
237472673a24Sdrh       return ExprHasProperty(p, EP_CanBeNull) ||
2375eda079cdSdrh              p->y.pTab==0 ||  /* Reference to column of index on expression */
23764eac5f04Sdrh              (p->iColumn>=0
23774eac5f04Sdrh               && ALWAYS(p->y.pTab->aCol!=0) /* Defense against OOM problems */
23784eac5f04Sdrh               && p->y.pTab->aCol[p->iColumn].notNull==0);
2379039fc32eSdrh     default:
2380039fc32eSdrh       return 1;
2381039fc32eSdrh   }
2382039fc32eSdrh }
2383039fc32eSdrh 
2384039fc32eSdrh /*
2385039fc32eSdrh ** Return TRUE if the given expression is a constant which would be
2386039fc32eSdrh ** unchanged by OP_Affinity with the affinity given in the second
2387039fc32eSdrh ** argument.
2388039fc32eSdrh **
2389039fc32eSdrh ** This routine is used to determine if the OP_Affinity operation
2390039fc32eSdrh ** can be omitted.  When in doubt return FALSE.  A false negative
2391039fc32eSdrh ** is harmless.  A false positive, however, can result in the wrong
2392039fc32eSdrh ** answer.
2393039fc32eSdrh */
2394039fc32eSdrh int sqlite3ExprNeedsNoAffinityChange(const Expr *p, char aff){
2395039fc32eSdrh   u8 op;
2396af866402Sdrh   int unaryMinus = 0;
239705883a34Sdrh   if( aff==SQLITE_AFF_BLOB ) return 1;
2398af866402Sdrh   while( p->op==TK_UPLUS || p->op==TK_UMINUS ){
2399af866402Sdrh     if( p->op==TK_UMINUS ) unaryMinus = 1;
2400af866402Sdrh     p = p->pLeft;
2401af866402Sdrh   }
2402039fc32eSdrh   op = p->op;
2403039fc32eSdrh   if( op==TK_REGISTER ) op = p->op2;
2404039fc32eSdrh   switch( op ){
2405039fc32eSdrh     case TK_INTEGER: {
24066a19865fSdrh       return aff>=SQLITE_AFF_NUMERIC;
2407039fc32eSdrh     }
2408039fc32eSdrh     case TK_FLOAT: {
24096a19865fSdrh       return aff>=SQLITE_AFF_NUMERIC;
2410039fc32eSdrh     }
2411039fc32eSdrh     case TK_STRING: {
2412af866402Sdrh       return !unaryMinus && aff==SQLITE_AFF_TEXT;
2413039fc32eSdrh     }
2414039fc32eSdrh     case TK_BLOB: {
2415af866402Sdrh       return !unaryMinus;
2416039fc32eSdrh     }
24172f2855b6Sdrh     case TK_COLUMN: {
241888376ca7Sdrh       assert( p->iTable>=0 );  /* p cannot be part of a CHECK constraint */
24196a19865fSdrh       return aff>=SQLITE_AFF_NUMERIC && p->iColumn<0;
24202f2855b6Sdrh     }
2421039fc32eSdrh     default: {
2422039fc32eSdrh       return 0;
2423039fc32eSdrh     }
2424039fc32eSdrh   }
2425039fc32eSdrh }
2426039fc32eSdrh 
2427039fc32eSdrh /*
2428c4a3c779Sdrh ** Return TRUE if the given string is a row-id column name.
2429c4a3c779Sdrh */
24304adee20fSdanielk1977 int sqlite3IsRowid(const char *z){
24314adee20fSdanielk1977   if( sqlite3StrICmp(z, "_ROWID_")==0 ) return 1;
24324adee20fSdanielk1977   if( sqlite3StrICmp(z, "ROWID")==0 ) return 1;
24334adee20fSdanielk1977   if( sqlite3StrICmp(z, "OID")==0 ) return 1;
2434c4a3c779Sdrh   return 0;
2435c4a3c779Sdrh }
2436c4a3c779Sdrh 
24379a96b668Sdanielk1977 /*
243869c355bdSdrh ** pX is the RHS of an IN operator.  If pX is a SELECT statement
243969c355bdSdrh ** that can be simplified to a direct table access, then return
244069c355bdSdrh ** a pointer to the SELECT statement.  If pX is not a SELECT statement,
244169c355bdSdrh ** or if the SELECT statement needs to be manifested into a transient
244269c355bdSdrh ** table, then return NULL.
2443b287f4b6Sdrh */
2444b287f4b6Sdrh #ifndef SQLITE_OMIT_SUBQUERY
24457b35a77bSdan static Select *isCandidateForInOpt(Expr *pX){
244669c355bdSdrh   Select *p;
2447b287f4b6Sdrh   SrcList *pSrc;
2448b287f4b6Sdrh   ExprList *pEList;
2449b287f4b6Sdrh   Table *pTab;
2450cfbb5e82Sdan   int i;
245169c355bdSdrh   if( !ExprHasProperty(pX, EP_xIsSelect) ) return 0;  /* Not a subquery */
245269c355bdSdrh   if( ExprHasProperty(pX, EP_VarSelect)  ) return 0;  /* Correlated subq */
245369c355bdSdrh   p = pX->x.pSelect;
2454b287f4b6Sdrh   if( p->pPrior ) return 0;              /* Not a compound SELECT */
24557d10d5a6Sdrh   if( p->selFlags & (SF_Distinct|SF_Aggregate) ){
2456b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
2457b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
24587d10d5a6Sdrh     return 0; /* No DISTINCT keyword and no aggregate functions */
24597d10d5a6Sdrh   }
24602e26a602Sdrh   assert( p->pGroupBy==0 );              /* Has no GROUP BY clause */
2461b287f4b6Sdrh   if( p->pLimit ) return 0;              /* Has no LIMIT clause */
2462b287f4b6Sdrh   if( p->pWhere ) return 0;              /* Has no WHERE clause */
2463b287f4b6Sdrh   pSrc = p->pSrc;
2464d1fa7bcaSdrh   assert( pSrc!=0 );
2465d1fa7bcaSdrh   if( pSrc->nSrc!=1 ) return 0;          /* Single term in FROM clause */
2466b74b1017Sdrh   if( pSrc->a[0].pSelect ) return 0;     /* FROM is not a subquery or view */
2467b287f4b6Sdrh   pTab = pSrc->a[0].pTab;
246869c355bdSdrh   assert( pTab!=0 );
2469b74b1017Sdrh   assert( pTab->pSelect==0 );            /* FROM clause is not a view */
2470b287f4b6Sdrh   if( IsVirtual(pTab) ) return 0;        /* FROM clause not a virtual table */
2471b287f4b6Sdrh   pEList = p->pEList;
2472ac6b47d1Sdrh   assert( pEList!=0 );
24737b35a77bSdan   /* All SELECT results must be columns. */
2474cfbb5e82Sdan   for(i=0; i<pEList->nExpr; i++){
2475cfbb5e82Sdan     Expr *pRes = pEList->a[i].pExpr;
2476cfbb5e82Sdan     if( pRes->op!=TK_COLUMN ) return 0;
247769c355bdSdrh     assert( pRes->iTable==pSrc->a[0].iCursor );  /* Not a correlated subquery */
2478cfbb5e82Sdan   }
247969c355bdSdrh   return p;
2480b287f4b6Sdrh }
2481b287f4b6Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
2482b287f4b6Sdrh 
2483f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
24841d8cb21fSdan /*
24854c259e9fSdrh ** Generate code that checks the left-most column of index table iCur to see if
24864c259e9fSdrh ** it contains any NULL entries.  Cause the register at regHasNull to be set
24876be515ebSdrh ** to a non-NULL value if iCur contains no NULLs.  Cause register regHasNull
24886be515ebSdrh ** to be set to NULL if iCur contains one or more NULL values.
24896be515ebSdrh */
24906be515ebSdrh static void sqlite3SetHasNullFlag(Vdbe *v, int iCur, int regHasNull){
2491728e0f91Sdrh   int addr1;
24926be515ebSdrh   sqlite3VdbeAddOp2(v, OP_Integer, 0, regHasNull);
2493728e0f91Sdrh   addr1 = sqlite3VdbeAddOp1(v, OP_Rewind, iCur); VdbeCoverage(v);
24946be515ebSdrh   sqlite3VdbeAddOp3(v, OP_Column, iCur, 0, regHasNull);
24956be515ebSdrh   sqlite3VdbeChangeP5(v, OPFLAG_TYPEOFARG);
24964c259e9fSdrh   VdbeComment((v, "first_entry_in(%d)", iCur));
2497728e0f91Sdrh   sqlite3VdbeJumpHere(v, addr1);
24986be515ebSdrh }
2499f9b2e05cSdan #endif
25006be515ebSdrh 
2501bb53ecb1Sdrh 
2502bb53ecb1Sdrh #ifndef SQLITE_OMIT_SUBQUERY
2503bb53ecb1Sdrh /*
2504bb53ecb1Sdrh ** The argument is an IN operator with a list (not a subquery) on the
2505bb53ecb1Sdrh ** right-hand side.  Return TRUE if that list is constant.
2506bb53ecb1Sdrh */
2507bb53ecb1Sdrh static int sqlite3InRhsIsConstant(Expr *pIn){
2508bb53ecb1Sdrh   Expr *pLHS;
2509bb53ecb1Sdrh   int res;
2510bb53ecb1Sdrh   assert( !ExprHasProperty(pIn, EP_xIsSelect) );
2511bb53ecb1Sdrh   pLHS = pIn->pLeft;
2512bb53ecb1Sdrh   pIn->pLeft = 0;
2513bb53ecb1Sdrh   res = sqlite3ExprIsConstant(pIn);
2514bb53ecb1Sdrh   pIn->pLeft = pLHS;
2515bb53ecb1Sdrh   return res;
2516bb53ecb1Sdrh }
2517bb53ecb1Sdrh #endif
2518bb53ecb1Sdrh 
25196be515ebSdrh /*
25209a96b668Sdanielk1977 ** This function is used by the implementation of the IN (...) operator.
2521d4305ca6Sdrh ** The pX parameter is the expression on the RHS of the IN operator, which
2522d4305ca6Sdrh ** might be either a list of expressions or a subquery.
25239a96b668Sdanielk1977 **
2524d4305ca6Sdrh ** The job of this routine is to find or create a b-tree object that can
2525d4305ca6Sdrh ** be used either to test for membership in the RHS set or to iterate through
2526d4305ca6Sdrh ** all members of the RHS set, skipping duplicates.
2527d4305ca6Sdrh **
25283a85625dSdrh ** A cursor is opened on the b-tree object that is the RHS of the IN operator
2529d4305ca6Sdrh ** and pX->iTable is set to the index of that cursor.
2530d4305ca6Sdrh **
2531b74b1017Sdrh ** The returned value of this function indicates the b-tree type, as follows:
25329a96b668Sdanielk1977 **
25339a96b668Sdanielk1977 **   IN_INDEX_ROWID      - The cursor was opened on a database table.
25341ccce449Sdrh **   IN_INDEX_INDEX_ASC  - The cursor was opened on an ascending index.
25351ccce449Sdrh **   IN_INDEX_INDEX_DESC - The cursor was opened on a descending index.
25369a96b668Sdanielk1977 **   IN_INDEX_EPH        - The cursor was opened on a specially created and
25379a96b668Sdanielk1977 **                         populated epheremal table.
2538bb53ecb1Sdrh **   IN_INDEX_NOOP       - No cursor was allocated.  The IN operator must be
2539bb53ecb1Sdrh **                         implemented as a sequence of comparisons.
25409a96b668Sdanielk1977 **
2541d4305ca6Sdrh ** An existing b-tree might be used if the RHS expression pX is a simple
2542d4305ca6Sdrh ** subquery such as:
25439a96b668Sdanielk1977 **
2544553168c7Sdan **     SELECT <column1>, <column2>... FROM <table>
25459a96b668Sdanielk1977 **
2546d4305ca6Sdrh ** If the RHS of the IN operator is a list or a more complex subquery, then
2547d4305ca6Sdrh ** an ephemeral table might need to be generated from the RHS and then
254860ec914cSpeter.d.reid ** pX->iTable made to point to the ephemeral table instead of an
2549d4305ca6Sdrh ** existing table.
2550d4305ca6Sdrh **
25517fc0ba0fSdrh ** The inFlags parameter must contain, at a minimum, one of the bits
25527fc0ba0fSdrh ** IN_INDEX_MEMBERSHIP or IN_INDEX_LOOP but not both.  If inFlags contains
25537fc0ba0fSdrh ** IN_INDEX_MEMBERSHIP, then the generated table will be used for a fast
25547fc0ba0fSdrh ** membership test.  When the IN_INDEX_LOOP bit is set, the IN index will
25557fc0ba0fSdrh ** be used to loop over all values of the RHS of the IN operator.
25563a85625dSdrh **
25573a85625dSdrh ** When IN_INDEX_LOOP is used (and the b-tree will be used to iterate
25583a85625dSdrh ** through the set members) then the b-tree must not contain duplicates.
25597fc0ba0fSdrh ** An epheremal table will be created unless the selected columns are guaranteed
2560553168c7Sdan ** to be unique - either because it is an INTEGER PRIMARY KEY or due to
2561553168c7Sdan ** a UNIQUE constraint or index.
25620cdc022eSdanielk1977 **
25633a85625dSdrh ** When IN_INDEX_MEMBERSHIP is used (and the b-tree will be used
25643a85625dSdrh ** for fast set membership tests) then an epheremal table must
2565553168c7Sdan ** be used unless <columns> is a single INTEGER PRIMARY KEY column or an
2566553168c7Sdan ** index can be found with the specified <columns> as its left-most.
25670cdc022eSdanielk1977 **
2568bb53ecb1Sdrh ** If the IN_INDEX_NOOP_OK and IN_INDEX_MEMBERSHIP are both set and
2569bb53ecb1Sdrh ** if the RHS of the IN operator is a list (not a subquery) then this
2570bb53ecb1Sdrh ** routine might decide that creating an ephemeral b-tree for membership
2571bb53ecb1Sdrh ** testing is too expensive and return IN_INDEX_NOOP.  In that case, the
2572bb53ecb1Sdrh ** calling routine should implement the IN operator using a sequence
2573bb53ecb1Sdrh ** of Eq or Ne comparison operations.
2574bb53ecb1Sdrh **
2575b74b1017Sdrh ** When the b-tree is being used for membership tests, the calling function
25763a85625dSdrh ** might need to know whether or not the RHS side of the IN operator
2577e21a6e1dSdrh ** contains a NULL.  If prRhsHasNull is not a NULL pointer and
25783a85625dSdrh ** if there is any chance that the (...) might contain a NULL value at
25790cdc022eSdanielk1977 ** runtime, then a register is allocated and the register number written
2580e21a6e1dSdrh ** to *prRhsHasNull. If there is no chance that the (...) contains a
2581e21a6e1dSdrh ** NULL value, then *prRhsHasNull is left unchanged.
25820cdc022eSdanielk1977 **
2583e21a6e1dSdrh ** If a register is allocated and its location stored in *prRhsHasNull, then
25846be515ebSdrh ** the value in that register will be NULL if the b-tree contains one or more
25856be515ebSdrh ** NULL values, and it will be some non-NULL value if the b-tree contains no
25866be515ebSdrh ** NULL values.
2587553168c7Sdan **
2588553168c7Sdan ** If the aiMap parameter is not NULL, it must point to an array containing
2589553168c7Sdan ** one element for each column returned by the SELECT statement on the RHS
2590553168c7Sdan ** of the IN(...) operator. The i'th entry of the array is populated with the
2591553168c7Sdan ** offset of the index column that matches the i'th column returned by the
2592553168c7Sdan ** SELECT. For example, if the expression and selected index are:
2593553168c7Sdan **
2594553168c7Sdan **   (?,?,?) IN (SELECT a, b, c FROM t1)
2595553168c7Sdan **   CREATE INDEX i1 ON t1(b, c, a);
2596553168c7Sdan **
2597553168c7Sdan ** then aiMap[] is populated with {2, 0, 1}.
25989a96b668Sdanielk1977 */
2599284f4acaSdanielk1977 #ifndef SQLITE_OMIT_SUBQUERY
2600ba00e30aSdan int sqlite3FindInIndex(
26016fc8f364Sdrh   Parse *pParse,             /* Parsing context */
26020167ef20Sdrh   Expr *pX,                  /* The IN expression */
26036fc8f364Sdrh   u32 inFlags,               /* IN_INDEX_LOOP, _MEMBERSHIP, and/or _NOOP_OK */
26046fc8f364Sdrh   int *prRhsHasNull,         /* Register holding NULL status.  See notes */
26052c04131cSdrh   int *aiMap,                /* Mapping from Index fields to RHS fields */
26062c04131cSdrh   int *piTab                 /* OUT: index to use */
2607ba00e30aSdan ){
2608b74b1017Sdrh   Select *p;                            /* SELECT to the right of IN operator */
2609b74b1017Sdrh   int eType = 0;                        /* Type of RHS table. IN_INDEX_* */
2610b74b1017Sdrh   int iTab = pParse->nTab++;            /* Cursor of the RHS table */
26113a85625dSdrh   int mustBeUnique;                     /* True if RHS must be unique */
2612b8475df8Sdrh   Vdbe *v = sqlite3GetVdbe(pParse);     /* Virtual machine being coded */
26139a96b668Sdanielk1977 
26141450bc6eSdrh   assert( pX->op==TK_IN );
26153a85625dSdrh   mustBeUnique = (inFlags & IN_INDEX_LOOP)!=0;
26161450bc6eSdrh 
26177b35a77bSdan   /* If the RHS of this IN(...) operator is a SELECT, and if it matters
26187b35a77bSdan   ** whether or not the SELECT result contains NULL values, check whether
2619870a0705Sdan   ** or not NULL is actually possible (it may not be, for example, due
26207b35a77bSdan   ** to NOT NULL constraints in the schema). If no NULL values are possible,
2621870a0705Sdan   ** set prRhsHasNull to 0 before continuing.  */
26227b35a77bSdan   if( prRhsHasNull && (pX->flags & EP_xIsSelect) ){
26237b35a77bSdan     int i;
26247b35a77bSdan     ExprList *pEList = pX->x.pSelect->pEList;
26257b35a77bSdan     for(i=0; i<pEList->nExpr; i++){
26267b35a77bSdan       if( sqlite3ExprCanBeNull(pEList->a[i].pExpr) ) break;
26277b35a77bSdan     }
26287b35a77bSdan     if( i==pEList->nExpr ){
26297b35a77bSdan       prRhsHasNull = 0;
26307b35a77bSdan     }
26317b35a77bSdan   }
26327b35a77bSdan 
2633b74b1017Sdrh   /* Check to see if an existing table or index can be used to
2634b74b1017Sdrh   ** satisfy the query.  This is preferable to generating a new
26357b35a77bSdan   ** ephemeral table.  */
26367b35a77bSdan   if( pParse->nErr==0 && (p = isCandidateForInOpt(pX))!=0 ){
2637e1fb65a0Sdanielk1977     sqlite3 *db = pParse->db;              /* Database connection */
2638b07028f7Sdrh     Table *pTab;                           /* Table <table>. */
2639399062ccSdrh     int iDb;                               /* Database idx for pTab */
2640cfbb5e82Sdan     ExprList *pEList = p->pEList;
2641cfbb5e82Sdan     int nExpr = pEList->nExpr;
2642e1fb65a0Sdanielk1977 
2643b07028f7Sdrh     assert( p->pEList!=0 );             /* Because of isCandidateForInOpt(p) */
2644b07028f7Sdrh     assert( p->pEList->a[0].pExpr!=0 ); /* Because of isCandidateForInOpt(p) */
2645b07028f7Sdrh     assert( p->pSrc!=0 );               /* Because of isCandidateForInOpt(p) */
2646b07028f7Sdrh     pTab = p->pSrc->a[0].pTab;
2647b07028f7Sdrh 
2648b22f7c83Sdrh     /* Code an OP_Transaction and OP_TableLock for <table>. */
2649e1fb65a0Sdanielk1977     iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
2650099b385dSdrh     assert( iDb>=0 && iDb<SQLITE_MAX_DB );
2651e1fb65a0Sdanielk1977     sqlite3CodeVerifySchema(pParse, iDb);
2652e1fb65a0Sdanielk1977     sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
26539a96b668Sdanielk1977 
2654a84a283dSdrh     assert(v);  /* sqlite3GetVdbe() has always been previously called */
2655cfbb5e82Sdan     if( nExpr==1 && pEList->a[0].pExpr->iColumn<0 ){
265662659b2aSdrh       /* The "x IN (SELECT rowid FROM table)" case */
2657511f9e8dSdrh       int iAddr = sqlite3VdbeAddOp0(v, OP_Once);
26587d176105Sdrh       VdbeCoverage(v);
26599a96b668Sdanielk1977 
26609a96b668Sdanielk1977       sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
26619a96b668Sdanielk1977       eType = IN_INDEX_ROWID;
2662d8852095Sdrh       ExplainQueryPlan((pParse, 0,
2663d8852095Sdrh             "USING ROWID SEARCH ON TABLE %s FOR IN-OPERATOR",pTab->zName));
26649a96b668Sdanielk1977       sqlite3VdbeJumpHere(v, iAddr);
26659a96b668Sdanielk1977     }else{
2666e1fb65a0Sdanielk1977       Index *pIdx;                         /* Iterator variable */
2667cfbb5e82Sdan       int affinity_ok = 1;
2668cfbb5e82Sdan       int i;
2669cfbb5e82Sdan 
2670cfbb5e82Sdan       /* Check that the affinity that will be used to perform each
267162659b2aSdrh       ** comparison is the same as the affinity of each column in table
267262659b2aSdrh       ** on the RHS of the IN operator.  If it not, it is not possible to
267362659b2aSdrh       ** use any index of the RHS table.  */
2674cfbb5e82Sdan       for(i=0; i<nExpr && affinity_ok; i++){
2675fc7f27b9Sdrh         Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2676cfbb5e82Sdan         int iCol = pEList->a[i].pExpr->iColumn;
26770dfa4f6fSdrh         char idxaff = sqlite3TableColumnAffinity(pTab,iCol); /* RHS table */
2678cfbb5e82Sdan         char cmpaff = sqlite3CompareAffinity(pLhs, idxaff);
267962659b2aSdrh         testcase( cmpaff==SQLITE_AFF_BLOB );
268062659b2aSdrh         testcase( cmpaff==SQLITE_AFF_TEXT );
2681cfbb5e82Sdan         switch( cmpaff ){
2682cfbb5e82Sdan           case SQLITE_AFF_BLOB:
2683cfbb5e82Sdan             break;
2684cfbb5e82Sdan           case SQLITE_AFF_TEXT:
268562659b2aSdrh             /* sqlite3CompareAffinity() only returns TEXT if one side or the
268662659b2aSdrh             ** other has no affinity and the other side is TEXT.  Hence,
268762659b2aSdrh             ** the only way for cmpaff to be TEXT is for idxaff to be TEXT
268862659b2aSdrh             ** and for the term on the LHS of the IN to have no affinity. */
268962659b2aSdrh             assert( idxaff==SQLITE_AFF_TEXT );
2690cfbb5e82Sdan             break;
2691cfbb5e82Sdan           default:
2692cfbb5e82Sdan             affinity_ok = sqlite3IsNumericAffinity(idxaff);
2693cfbb5e82Sdan         }
2694cfbb5e82Sdan       }
2695e1fb65a0Sdanielk1977 
2696a84a283dSdrh       if( affinity_ok ){
2697a84a283dSdrh         /* Search for an existing index that will work for this IN operator */
2698a84a283dSdrh         for(pIdx=pTab->pIndex; pIdx && eType==0; pIdx=pIdx->pNext){
2699a84a283dSdrh           Bitmask colUsed;      /* Columns of the index used */
2700a84a283dSdrh           Bitmask mCol;         /* Mask for the current column */
27016fc8f364Sdrh           if( pIdx->nColumn<nExpr ) continue;
2702d4a4a361Sdrh           if( pIdx->pPartIdxWhere!=0 ) continue;
2703a84a283dSdrh           /* Maximum nColumn is BMS-2, not BMS-1, so that we can compute
2704a84a283dSdrh           ** BITMASK(nExpr) without overflowing */
2705a84a283dSdrh           testcase( pIdx->nColumn==BMS-2 );
2706a84a283dSdrh           testcase( pIdx->nColumn==BMS-1 );
2707a84a283dSdrh           if( pIdx->nColumn>=BMS-1 ) continue;
27086fc8f364Sdrh           if( mustBeUnique ){
27096fc8f364Sdrh             if( pIdx->nKeyCol>nExpr
27106fc8f364Sdrh              ||(pIdx->nColumn>nExpr && !IsUniqueIndex(pIdx))
27116fc8f364Sdrh             ){
2712a84a283dSdrh               continue;  /* This index is not unique over the IN RHS columns */
2713cfbb5e82Sdan             }
27146fc8f364Sdrh           }
2715cfbb5e82Sdan 
2716a84a283dSdrh           colUsed = 0;   /* Columns of index used so far */
2717cfbb5e82Sdan           for(i=0; i<nExpr; i++){
2718fc7f27b9Sdrh             Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2719cfbb5e82Sdan             Expr *pRhs = pEList->a[i].pExpr;
2720cfbb5e82Sdan             CollSeq *pReq = sqlite3BinaryCompareCollSeq(pParse, pLhs, pRhs);
2721cfbb5e82Sdan             int j;
2722cfbb5e82Sdan 
27236fc8f364Sdrh             assert( pReq!=0 || pRhs->iColumn==XN_ROWID || pParse->nErr );
2724cfbb5e82Sdan             for(j=0; j<nExpr; j++){
2725cfbb5e82Sdan               if( pIdx->aiColumn[j]!=pRhs->iColumn ) continue;
2726cfbb5e82Sdan               assert( pIdx->azColl[j] );
2727106526e1Sdrh               if( pReq!=0 && sqlite3StrICmp(pReq->zName, pIdx->azColl[j])!=0 ){
2728106526e1Sdrh                 continue;
2729106526e1Sdrh               }
2730cfbb5e82Sdan               break;
2731cfbb5e82Sdan             }
2732cfbb5e82Sdan             if( j==nExpr ) break;
2733a84a283dSdrh             mCol = MASKBIT(j);
2734a84a283dSdrh             if( mCol & colUsed ) break; /* Each column used only once */
2735a84a283dSdrh             colUsed |= mCol;
2736ba00e30aSdan             if( aiMap ) aiMap[i] = j;
2737cfbb5e82Sdan           }
2738cfbb5e82Sdan 
2739a84a283dSdrh           assert( i==nExpr || colUsed!=(MASKBIT(nExpr)-1) );
2740a84a283dSdrh           if( colUsed==(MASKBIT(nExpr)-1) ){
2741a84a283dSdrh             /* If we reach this point, that means the index pIdx is usable */
2742511f9e8dSdrh             int iAddr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
2743e2ca99c9Sdrh             ExplainQueryPlan((pParse, 0,
2744e2ca99c9Sdrh                               "USING INDEX %s FOR IN-OPERATOR",pIdx->zName));
27452ec2fb22Sdrh             sqlite3VdbeAddOp3(v, OP_OpenRead, iTab, pIdx->tnum, iDb);
27462ec2fb22Sdrh             sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
2747207872a4Sdanielk1977             VdbeComment((v, "%s", pIdx->zName));
27481ccce449Sdrh             assert( IN_INDEX_INDEX_DESC == IN_INDEX_INDEX_ASC+1 );
27491ccce449Sdrh             eType = IN_INDEX_INDEX_ASC + pIdx->aSortOrder[0];
27509a96b668Sdanielk1977 
27517b35a77bSdan             if( prRhsHasNull ){
27523480bfdaSdan #ifdef SQLITE_ENABLE_COLUMN_USED_MASK
2753cfbb5e82Sdan               i64 mask = (1<<nExpr)-1;
27543480bfdaSdan               sqlite3VdbeAddOp4Dup8(v, OP_ColumnsUsed,
2755cfbb5e82Sdan                   iTab, 0, 0, (u8*)&mask, P4_INT64);
27563480bfdaSdan #endif
2757b80dbdc2Sdrh               *prRhsHasNull = ++pParse->nMem;
27587b35a77bSdan               if( nExpr==1 ){
27596be515ebSdrh                 sqlite3SetHasNullFlag(v, iTab, *prRhsHasNull);
27600cdc022eSdanielk1977               }
27617b35a77bSdan             }
2762552fd454Sdrh             sqlite3VdbeJumpHere(v, iAddr);
27639a96b668Sdanielk1977           }
2764a84a283dSdrh         } /* End loop over indexes */
2765a84a283dSdrh       } /* End if( affinity_ok ) */
2766a84a283dSdrh     } /* End if not an rowid index */
2767a84a283dSdrh   } /* End attempt to optimize using an index */
27689a96b668Sdanielk1977 
2769bb53ecb1Sdrh   /* If no preexisting index is available for the IN clause
2770bb53ecb1Sdrh   ** and IN_INDEX_NOOP is an allowed reply
2771bb53ecb1Sdrh   ** and the RHS of the IN operator is a list, not a subquery
277271c57db0Sdan   ** and the RHS is not constant or has two or fewer terms,
277360ec914cSpeter.d.reid   ** then it is not worth creating an ephemeral table to evaluate
2774bb53ecb1Sdrh   ** the IN operator so return IN_INDEX_NOOP.
2775bb53ecb1Sdrh   */
2776bb53ecb1Sdrh   if( eType==0
2777bb53ecb1Sdrh    && (inFlags & IN_INDEX_NOOP_OK)
2778bb53ecb1Sdrh    && !ExprHasProperty(pX, EP_xIsSelect)
2779bb53ecb1Sdrh    && (!sqlite3InRhsIsConstant(pX) || pX->x.pList->nExpr<=2)
2780bb53ecb1Sdrh   ){
2781bb53ecb1Sdrh     eType = IN_INDEX_NOOP;
2782bb53ecb1Sdrh   }
2783bb53ecb1Sdrh 
27849a96b668Sdanielk1977   if( eType==0 ){
27854387006cSdrh     /* Could not find an existing table or index to use as the RHS b-tree.
2786b74b1017Sdrh     ** We will have to generate an ephemeral table to do the job.
2787b74b1017Sdrh     */
27888e23daf3Sdrh     u32 savedNQueryLoop = pParse->nQueryLoop;
27890cdc022eSdanielk1977     int rMayHaveNull = 0;
279041a05b7bSdanielk1977     eType = IN_INDEX_EPH;
27913a85625dSdrh     if( inFlags & IN_INDEX_LOOP ){
27924a5acf8eSdrh       pParse->nQueryLoop = 0;
2793e21a6e1dSdrh     }else if( prRhsHasNull ){
2794e21a6e1dSdrh       *prRhsHasNull = rMayHaveNull = ++pParse->nMem;
2795cf4d38aaSdrh     }
279685bcdce2Sdrh     assert( pX->op==TK_IN );
279750ef6716Sdrh     sqlite3CodeRhsOfIN(pParse, pX, iTab);
279885bcdce2Sdrh     if( rMayHaveNull ){
27992c04131cSdrh       sqlite3SetHasNullFlag(v, iTab, rMayHaveNull);
280085bcdce2Sdrh     }
2801cf4d38aaSdrh     pParse->nQueryLoop = savedNQueryLoop;
28029a96b668Sdanielk1977   }
2803ba00e30aSdan 
2804ba00e30aSdan   if( aiMap && eType!=IN_INDEX_INDEX_ASC && eType!=IN_INDEX_INDEX_DESC ){
2805ba00e30aSdan     int i, n;
2806ba00e30aSdan     n = sqlite3ExprVectorSize(pX->pLeft);
2807ba00e30aSdan     for(i=0; i<n; i++) aiMap[i] = i;
2808ba00e30aSdan   }
28092c04131cSdrh   *piTab = iTab;
28109a96b668Sdanielk1977   return eType;
28119a96b668Sdanielk1977 }
2812284f4acaSdanielk1977 #endif
2813626a879aSdrh 
2814f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
2815553168c7Sdan /*
2816553168c7Sdan ** Argument pExpr is an (?, ?...) IN(...) expression. This
2817553168c7Sdan ** function allocates and returns a nul-terminated string containing
2818553168c7Sdan ** the affinities to be used for each column of the comparison.
2819553168c7Sdan **
2820553168c7Sdan ** It is the responsibility of the caller to ensure that the returned
2821553168c7Sdan ** string is eventually freed using sqlite3DbFree().
2822553168c7Sdan */
282371c57db0Sdan static char *exprINAffinity(Parse *pParse, Expr *pExpr){
282471c57db0Sdan   Expr *pLeft = pExpr->pLeft;
282571c57db0Sdan   int nVal = sqlite3ExprVectorSize(pLeft);
2826553168c7Sdan   Select *pSelect = (pExpr->flags & EP_xIsSelect) ? pExpr->x.pSelect : 0;
282771c57db0Sdan   char *zRet;
282871c57db0Sdan 
2829553168c7Sdan   assert( pExpr->op==TK_IN );
28305c258dc1Sdrh   zRet = sqlite3DbMallocRaw(pParse->db, nVal+1);
283171c57db0Sdan   if( zRet ){
283271c57db0Sdan     int i;
283371c57db0Sdan     for(i=0; i<nVal; i++){
2834fc7f27b9Sdrh       Expr *pA = sqlite3VectorFieldSubexpr(pLeft, i);
2835553168c7Sdan       char a = sqlite3ExprAffinity(pA);
2836553168c7Sdan       if( pSelect ){
2837553168c7Sdan         zRet[i] = sqlite3CompareAffinity(pSelect->pEList->a[i].pExpr, a);
283871c57db0Sdan       }else{
2839553168c7Sdan         zRet[i] = a;
284071c57db0Sdan       }
284171c57db0Sdan     }
284271c57db0Sdan     zRet[nVal] = '\0';
284371c57db0Sdan   }
284471c57db0Sdan   return zRet;
284571c57db0Sdan }
2846f9b2e05cSdan #endif
284771c57db0Sdan 
28488da209b1Sdan #ifndef SQLITE_OMIT_SUBQUERY
28498da209b1Sdan /*
28508da209b1Sdan ** Load the Parse object passed as the first argument with an error
28518da209b1Sdan ** message of the form:
28528da209b1Sdan **
28538da209b1Sdan **   "sub-select returns N columns - expected M"
28548da209b1Sdan */
28558da209b1Sdan void sqlite3SubselectError(Parse *pParse, int nActual, int nExpect){
2856a9ebfe20Sdrh   if( pParse->nErr==0 ){
28578da209b1Sdan     const char *zFmt = "sub-select returns %d columns - expected %d";
28588da209b1Sdan     sqlite3ErrorMsg(pParse, zFmt, nActual, nExpect);
28598da209b1Sdan   }
2860a9ebfe20Sdrh }
28618da209b1Sdan #endif
28628da209b1Sdan 
2863626a879aSdrh /*
286444c5604cSdan ** Expression pExpr is a vector that has been used in a context where
286544c5604cSdan ** it is not permitted. If pExpr is a sub-select vector, this routine
286644c5604cSdan ** loads the Parse object with a message of the form:
286744c5604cSdan **
286844c5604cSdan **   "sub-select returns N columns - expected 1"
286944c5604cSdan **
287044c5604cSdan ** Or, if it is a regular scalar vector:
287144c5604cSdan **
287244c5604cSdan **   "row value misused"
287344c5604cSdan */
287444c5604cSdan void sqlite3VectorErrorMsg(Parse *pParse, Expr *pExpr){
287544c5604cSdan #ifndef SQLITE_OMIT_SUBQUERY
287644c5604cSdan   if( pExpr->flags & EP_xIsSelect ){
287744c5604cSdan     sqlite3SubselectError(pParse, pExpr->x.pSelect->pEList->nExpr, 1);
287844c5604cSdan   }else
287944c5604cSdan #endif
288044c5604cSdan   {
288144c5604cSdan     sqlite3ErrorMsg(pParse, "row value misused");
288244c5604cSdan   }
288344c5604cSdan }
288444c5604cSdan 
288585bcdce2Sdrh #ifndef SQLITE_OMIT_SUBQUERY
288644c5604cSdan /*
288785bcdce2Sdrh ** Generate code that will construct an ephemeral table containing all terms
288885bcdce2Sdrh ** in the RHS of an IN operator.  The IN operator can be in either of two
288985bcdce2Sdrh ** forms:
2890626a879aSdrh **
28919cbe6352Sdrh **     x IN (4,5,11)              -- IN operator with list on right-hand side
28929cbe6352Sdrh **     x IN (SELECT a FROM b)     -- IN operator with subquery on the right
2893fef5208cSdrh **
28942c04131cSdrh ** The pExpr parameter is the IN operator.  The cursor number for the
28952c04131cSdrh ** constructed ephermeral table is returned.  The first time the ephemeral
28962c04131cSdrh ** table is computed, the cursor number is also stored in pExpr->iTable,
28972c04131cSdrh ** however the cursor number returned might not be the same, as it might
28982c04131cSdrh ** have been duplicated using OP_OpenDup.
289941a05b7bSdanielk1977 **
290085bcdce2Sdrh ** If the LHS expression ("x" in the examples) is a column value, or
290185bcdce2Sdrh ** the SELECT statement returns a column value, then the affinity of that
290285bcdce2Sdrh ** column is used to build the index keys. If both 'x' and the
290385bcdce2Sdrh ** SELECT... statement are columns, then numeric affinity is used
290485bcdce2Sdrh ** if either column has NUMERIC or INTEGER affinity. If neither
290585bcdce2Sdrh ** 'x' nor the SELECT... statement are columns, then numeric affinity
290685bcdce2Sdrh ** is used.
2907cce7d176Sdrh */
290885bcdce2Sdrh void sqlite3CodeRhsOfIN(
2909fd773cf9Sdrh   Parse *pParse,          /* Parsing context */
291085bcdce2Sdrh   Expr *pExpr,            /* The IN operator */
291150ef6716Sdrh   int iTab                /* Use this cursor number */
291241a05b7bSdanielk1977 ){
29132c04131cSdrh   int addrOnce = 0;           /* Address of the OP_Once instruction at top */
291485bcdce2Sdrh   int addr;                   /* Address of OP_OpenEphemeral instruction */
291585bcdce2Sdrh   Expr *pLeft;                /* the LHS of the IN operator */
291685bcdce2Sdrh   KeyInfo *pKeyInfo = 0;      /* Key information */
291785bcdce2Sdrh   int nVal;                   /* Size of vector pLeft */
291885bcdce2Sdrh   Vdbe *v;                    /* The prepared statement under construction */
2919fc976065Sdanielk1977 
29202c04131cSdrh   v = pParse->pVdbe;
292185bcdce2Sdrh   assert( v!=0 );
292285bcdce2Sdrh 
29232c04131cSdrh   /* The evaluation of the IN must be repeated every time it
292439a11819Sdrh   ** is encountered if any of the following is true:
292557dbd7b3Sdrh   **
292657dbd7b3Sdrh   **    *  The right-hand side is a correlated subquery
292757dbd7b3Sdrh   **    *  The right-hand side is an expression list containing variables
292857dbd7b3Sdrh   **    *  We are inside a trigger
292957dbd7b3Sdrh   **
29302c04131cSdrh   ** If all of the above are false, then we can compute the RHS just once
29312c04131cSdrh   ** and reuse it many names.
2932b3bce662Sdanielk1977   */
2933efb699fcSdrh   if( !ExprHasProperty(pExpr, EP_VarSelect) && pParse->iSelfTab==0 ){
29342c04131cSdrh     /* Reuse of the RHS is allowed */
29352c04131cSdrh     /* If this routine has already been coded, but the previous code
29362c04131cSdrh     ** might not have been invoked yet, so invoke it now as a subroutine.
29372c04131cSdrh     */
29382c04131cSdrh     if( ExprHasProperty(pExpr, EP_Subrtn) ){
2939f9231c34Sdrh       addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
2940bd462bccSdrh       if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2941bd462bccSdrh         ExplainQueryPlan((pParse, 0, "REUSE LIST SUBQUERY %d",
2942bd462bccSdrh               pExpr->x.pSelect->selId));
2943bd462bccSdrh       }
29442c04131cSdrh       sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
29452c04131cSdrh                         pExpr->y.sub.iAddr);
29462c04131cSdrh       sqlite3VdbeAddOp2(v, OP_OpenDup, iTab, pExpr->iTable);
2947f9231c34Sdrh       sqlite3VdbeJumpHere(v, addrOnce);
29482c04131cSdrh       return;
29492c04131cSdrh     }
29502c04131cSdrh 
29512c04131cSdrh     /* Begin coding the subroutine */
29522c04131cSdrh     ExprSetProperty(pExpr, EP_Subrtn);
2953088489e8Sdrh     assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
29542c04131cSdrh     pExpr->y.sub.regReturn = ++pParse->nMem;
29552c04131cSdrh     pExpr->y.sub.iAddr =
29562c04131cSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 0, pExpr->y.sub.regReturn) + 1;
29572c04131cSdrh     VdbeComment((v, "return address"));
29582c04131cSdrh 
29592c04131cSdrh     addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
2960b3bce662Sdanielk1977   }
2961b3bce662Sdanielk1977 
296285bcdce2Sdrh   /* Check to see if this is a vector IN operator */
296385bcdce2Sdrh   pLeft = pExpr->pLeft;
296471c57db0Sdan   nVal = sqlite3ExprVectorSize(pLeft);
2965e014a838Sdanielk1977 
296685bcdce2Sdrh   /* Construct the ephemeral table that will contain the content of
296785bcdce2Sdrh   ** RHS of the IN operator.
2968fef5208cSdrh   */
29692c04131cSdrh   pExpr->iTable = iTab;
297050ef6716Sdrh   addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, pExpr->iTable, nVal);
29712c04131cSdrh #ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
29722c04131cSdrh   if( ExprHasProperty(pExpr, EP_xIsSelect) ){
29732c04131cSdrh     VdbeComment((v, "Result of SELECT %u", pExpr->x.pSelect->selId));
29742c04131cSdrh   }else{
29752c04131cSdrh     VdbeComment((v, "RHS of IN operator"));
29762c04131cSdrh   }
29772c04131cSdrh #endif
297850ef6716Sdrh   pKeyInfo = sqlite3KeyInfoAlloc(pParse->db, nVal, 1);
2979e014a838Sdanielk1977 
29806ab3a2ecSdanielk1977   if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2981e014a838Sdanielk1977     /* Case 1:     expr IN (SELECT ...)
2982e014a838Sdanielk1977     **
2983e014a838Sdanielk1977     ** Generate code to write the results of the select into the temporary
2984e014a838Sdanielk1977     ** table allocated and opened above.
2985e014a838Sdanielk1977     */
29864387006cSdrh     Select *pSelect = pExpr->x.pSelect;
298771c57db0Sdan     ExprList *pEList = pSelect->pEList;
29881013c932Sdrh 
29892c04131cSdrh     ExplainQueryPlan((pParse, 1, "%sLIST SUBQUERY %d",
29902c04131cSdrh         addrOnce?"":"CORRELATED ", pSelect->selId
2991e2ca99c9Sdrh     ));
299264bcb8cfSdrh     /* If the LHS and RHS of the IN operator do not match, that
299364bcb8cfSdrh     ** error will have been caught long before we reach this point. */
299464bcb8cfSdrh     if( ALWAYS(pEList->nExpr==nVal) ){
299571c57db0Sdan       SelectDest dest;
299671c57db0Sdan       int i;
2997bd462bccSdrh       sqlite3SelectDestInit(&dest, SRT_Set, iTab);
299871c57db0Sdan       dest.zAffSdst = exprINAffinity(pParse, pExpr);
29994387006cSdrh       pSelect->iLimit = 0;
30004387006cSdrh       testcase( pSelect->selFlags & SF_Distinct );
3001812ea833Sdrh       testcase( pKeyInfo==0 ); /* Caused by OOM in sqlite3KeyInfoAlloc() */
30024387006cSdrh       if( sqlite3Select(pParse, pSelect, &dest) ){
300371c57db0Sdan         sqlite3DbFree(pParse->db, dest.zAffSdst);
30042ec2fb22Sdrh         sqlite3KeyInfoUnref(pKeyInfo);
300585bcdce2Sdrh         return;
300694ccde58Sdrh       }
300771c57db0Sdan       sqlite3DbFree(pParse->db, dest.zAffSdst);
3008812ea833Sdrh       assert( pKeyInfo!=0 ); /* OOM will cause exit after sqlite3Select() */
30093535ec3eSdrh       assert( pEList!=0 );
30103535ec3eSdrh       assert( pEList->nExpr>0 );
30112ec2fb22Sdrh       assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
301271c57db0Sdan       for(i=0; i<nVal; i++){
3013773d3afaSdan         Expr *p = sqlite3VectorFieldSubexpr(pLeft, i);
301471c57db0Sdan         pKeyInfo->aColl[i] = sqlite3BinaryCompareCollSeq(
301571c57db0Sdan             pParse, p, pEList->a[i].pExpr
301671c57db0Sdan         );
301771c57db0Sdan       }
301871c57db0Sdan     }
3019a7d2db17Sdrh   }else if( ALWAYS(pExpr->x.pList!=0) ){
3020fef5208cSdrh     /* Case 2:     expr IN (exprlist)
3021fef5208cSdrh     **
3022e014a838Sdanielk1977     ** For each expression, build an index key from the evaluation and
3023e014a838Sdanielk1977     ** store it in the temporary table. If <expr> is a column, then use
3024e014a838Sdanielk1977     ** that columns affinity when building index keys. If <expr> is not
3025e014a838Sdanielk1977     ** a column, use numeric affinity.
3026fef5208cSdrh     */
302771c57db0Sdan     char affinity;            /* Affinity of the LHS of the IN */
3028e014a838Sdanielk1977     int i;
30296ab3a2ecSdanielk1977     ExprList *pList = pExpr->x.pList;
303057dbd7b3Sdrh     struct ExprList_item *pItem;
3031c324d446Sdan     int r1, r2;
303271c57db0Sdan     affinity = sqlite3ExprAffinity(pLeft);
303396fb16eeSdrh     if( affinity<=SQLITE_AFF_NONE ){
303405883a34Sdrh       affinity = SQLITE_AFF_BLOB;
303595b39590Sdrh     }else if( affinity==SQLITE_AFF_REAL ){
303695b39590Sdrh       affinity = SQLITE_AFF_NUMERIC;
3037e014a838Sdanielk1977     }
3038323df790Sdrh     if( pKeyInfo ){
30392ec2fb22Sdrh       assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
3040323df790Sdrh       pKeyInfo->aColl[0] = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
3041323df790Sdrh     }
3042e014a838Sdanielk1977 
3043e014a838Sdanielk1977     /* Loop through each expression in <exprlist>. */
30442d401ab8Sdrh     r1 = sqlite3GetTempReg(pParse);
30452d401ab8Sdrh     r2 = sqlite3GetTempReg(pParse);
304657dbd7b3Sdrh     for(i=pList->nExpr, pItem=pList->a; i>0; i--, pItem++){
304757dbd7b3Sdrh       Expr *pE2 = pItem->pExpr;
3048e014a838Sdanielk1977 
304957dbd7b3Sdrh       /* If the expression is not constant then we will need to
305057dbd7b3Sdrh       ** disable the test that was generated above that makes sure
305157dbd7b3Sdrh       ** this code only executes once.  Because for a non-constant
305257dbd7b3Sdrh       ** expression we need to rerun this code each time.
305357dbd7b3Sdrh       */
30542c04131cSdrh       if( addrOnce && !sqlite3ExprIsConstant(pE2) ){
30552c04131cSdrh         sqlite3VdbeChangeToNoop(v, addrOnce);
30567ac0e562Sdan         ExprClearProperty(pExpr, EP_Subrtn);
30572c04131cSdrh         addrOnce = 0;
30584794b980Sdrh       }
3059e014a838Sdanielk1977 
3060e014a838Sdanielk1977       /* Evaluate the expression and insert it into the temp table */
3061c324d446Sdan       sqlite3ExprCode(pParse, pE2, r1);
3062c324d446Sdan       sqlite3VdbeAddOp4(v, OP_MakeRecord, r1, 1, r2, &affinity, 1);
3063c324d446Sdan       sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iTab, r2, r1, 1);
3064fef5208cSdrh     }
30652d401ab8Sdrh     sqlite3ReleaseTempReg(pParse, r1);
30662d401ab8Sdrh     sqlite3ReleaseTempReg(pParse, r2);
3067fef5208cSdrh   }
3068323df790Sdrh   if( pKeyInfo ){
30692ec2fb22Sdrh     sqlite3VdbeChangeP4(v, addr, (void *)pKeyInfo, P4_KEYINFO);
307041a05b7bSdanielk1977   }
30712c04131cSdrh   if( addrOnce ){
30722c04131cSdrh     sqlite3VdbeJumpHere(v, addrOnce);
30732c04131cSdrh     /* Subroutine return */
30742c04131cSdrh     sqlite3VdbeAddOp1(v, OP_Return, pExpr->y.sub.regReturn);
30752c04131cSdrh     sqlite3VdbeChangeP1(v, pExpr->y.sub.iAddr-1, sqlite3VdbeCurrentAddr(v)-1);
30766d2566dfSdrh     sqlite3ClearTempRegCache(pParse);
307785bcdce2Sdrh   }
307885bcdce2Sdrh }
307985bcdce2Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
308085bcdce2Sdrh 
308185bcdce2Sdrh /*
308285bcdce2Sdrh ** Generate code for scalar subqueries used as a subquery expression
308385bcdce2Sdrh ** or EXISTS operator:
308485bcdce2Sdrh **
308585bcdce2Sdrh **     (SELECT a FROM b)          -- subquery
308685bcdce2Sdrh **     EXISTS (SELECT a FROM b)   -- EXISTS subquery
308785bcdce2Sdrh **
308885bcdce2Sdrh ** The pExpr parameter is the SELECT or EXISTS operator to be coded.
308985bcdce2Sdrh **
3090d86fe44aSdrh ** Return the register that holds the result.  For a multi-column SELECT,
309185bcdce2Sdrh ** the result is stored in a contiguous array of registers and the
309285bcdce2Sdrh ** return value is the register of the left-most result column.
309385bcdce2Sdrh ** Return 0 if an error occurs.
309485bcdce2Sdrh */
309585bcdce2Sdrh #ifndef SQLITE_OMIT_SUBQUERY
309685bcdce2Sdrh int sqlite3CodeSubselect(Parse *pParse, Expr *pExpr){
30972c04131cSdrh   int addrOnce = 0;           /* Address of OP_Once at top of subroutine */
309885bcdce2Sdrh   int rReg = 0;               /* Register storing resulting */
309985bcdce2Sdrh   Select *pSel;               /* SELECT statement to encode */
310085bcdce2Sdrh   SelectDest dest;            /* How to deal with SELECT result */
310185bcdce2Sdrh   int nReg;                   /* Registers to allocate */
310285bcdce2Sdrh   Expr *pLimit;               /* New limit expression */
31032c04131cSdrh 
31042c04131cSdrh   Vdbe *v = pParse->pVdbe;
310585bcdce2Sdrh   assert( v!=0 );
3106bd462bccSdrh   testcase( pExpr->op==TK_EXISTS );
3107bd462bccSdrh   testcase( pExpr->op==TK_SELECT );
3108bd462bccSdrh   assert( pExpr->op==TK_EXISTS || pExpr->op==TK_SELECT );
3109bd462bccSdrh   assert( ExprHasProperty(pExpr, EP_xIsSelect) );
3110bd462bccSdrh   pSel = pExpr->x.pSelect;
311185bcdce2Sdrh 
31125198ff57Sdrh   /* The evaluation of the EXISTS/SELECT must be repeated every time it
311385bcdce2Sdrh   ** is encountered if any of the following is true:
311485bcdce2Sdrh   **
311585bcdce2Sdrh   **    *  The right-hand side is a correlated subquery
311685bcdce2Sdrh   **    *  The right-hand side is an expression list containing variables
311785bcdce2Sdrh   **    *  We are inside a trigger
311885bcdce2Sdrh   **
311985bcdce2Sdrh   ** If all of the above are false, then we can run this code just once
312085bcdce2Sdrh   ** save the results, and reuse the same result on subsequent invocations.
312185bcdce2Sdrh   */
312285bcdce2Sdrh   if( !ExprHasProperty(pExpr, EP_VarSelect) ){
31235198ff57Sdrh     /* If this routine has already been coded, then invoke it as a
31245198ff57Sdrh     ** subroutine. */
31255198ff57Sdrh     if( ExprHasProperty(pExpr, EP_Subrtn) ){
3126bd462bccSdrh       ExplainQueryPlan((pParse, 0, "REUSE SUBQUERY %d", pSel->selId));
31275198ff57Sdrh       sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
31285198ff57Sdrh                         pExpr->y.sub.iAddr);
31295198ff57Sdrh       return pExpr->iTable;
31305198ff57Sdrh     }
31315198ff57Sdrh 
31325198ff57Sdrh     /* Begin coding the subroutine */
31335198ff57Sdrh     ExprSetProperty(pExpr, EP_Subrtn);
31345198ff57Sdrh     pExpr->y.sub.regReturn = ++pParse->nMem;
31355198ff57Sdrh     pExpr->y.sub.iAddr =
31365198ff57Sdrh       sqlite3VdbeAddOp2(v, OP_Integer, 0, pExpr->y.sub.regReturn) + 1;
31375198ff57Sdrh     VdbeComment((v, "return address"));
31385198ff57Sdrh 
31392c04131cSdrh     addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
3140fef5208cSdrh   }
3141fef5208cSdrh 
314285bcdce2Sdrh   /* For a SELECT, generate code to put the values for all columns of
314339a11819Sdrh   ** the first row into an array of registers and return the index of
314439a11819Sdrh   ** the first register.
314539a11819Sdrh   **
314639a11819Sdrh   ** If this is an EXISTS, write an integer 0 (not exists) or 1 (exists)
314739a11819Sdrh   ** into a register and return that register number.
314839a11819Sdrh   **
314939a11819Sdrh   ** In both cases, the query is augmented with "LIMIT 1".  Any
315039a11819Sdrh   ** preexisting limit is discarded in place of the new LIMIT 1.
3151fef5208cSdrh   */
3152bd462bccSdrh   ExplainQueryPlan((pParse, 1, "%sSCALAR SUBQUERY %d",
3153bd462bccSdrh         addrOnce?"":"CORRELATED ", pSel->selId));
315471c57db0Sdan   nReg = pExpr->op==TK_SELECT ? pSel->pEList->nExpr : 1;
315571c57db0Sdan   sqlite3SelectDestInit(&dest, 0, pParse->nMem+1);
315671c57db0Sdan   pParse->nMem += nReg;
315751522cd3Sdrh   if( pExpr->op==TK_SELECT ){
31586c8c8ce0Sdanielk1977     dest.eDest = SRT_Mem;
315953932ce8Sdrh     dest.iSdst = dest.iSDParm;
316071c57db0Sdan     dest.nSdst = nReg;
316171c57db0Sdan     sqlite3VdbeAddOp3(v, OP_Null, 0, dest.iSDParm, dest.iSDParm+nReg-1);
3162d4e70ebdSdrh     VdbeComment((v, "Init subquery result"));
316351522cd3Sdrh   }else{
31646c8c8ce0Sdanielk1977     dest.eDest = SRT_Exists;
31652b596da8Sdrh     sqlite3VdbeAddOp2(v, OP_Integer, 0, dest.iSDParm);
3166d4e70ebdSdrh     VdbeComment((v, "Init EXISTS result"));
316751522cd3Sdrh   }
31688c0833fbSdrh   if( pSel->pLimit ){
31697ca1347fSdrh     /* The subquery already has a limit.  If the pre-existing limit is X
31707ca1347fSdrh     ** then make the new limit X<>0 so that the new limit is either 1 or 0 */
31717ca1347fSdrh     sqlite3 *db = pParse->db;
31725776ee5cSdrh     pLimit = sqlite3Expr(db, TK_INTEGER, "0");
31737ca1347fSdrh     if( pLimit ){
31747ca1347fSdrh       pLimit->affExpr = SQLITE_AFF_NUMERIC;
31757ca1347fSdrh       pLimit = sqlite3PExpr(pParse, TK_NE,
31767ca1347fSdrh                             sqlite3ExprDup(db, pSel->pLimit->pLeft, 0), pLimit);
31777ca1347fSdrh     }
31787ca1347fSdrh     sqlite3ExprDelete(db, pSel->pLimit->pLeft);
31798c0833fbSdrh     pSel->pLimit->pLeft = pLimit;
31808c0833fbSdrh   }else{
31817ca1347fSdrh     /* If there is no pre-existing limit add a limit of 1 */
31825776ee5cSdrh     pLimit = sqlite3Expr(pParse->db, TK_INTEGER, "1");
31838c0833fbSdrh     pSel->pLimit = sqlite3PExpr(pParse, TK_LIMIT, pLimit, 0);
31848c0833fbSdrh   }
318548b5b041Sdrh   pSel->iLimit = 0;
31867d10d5a6Sdrh   if( sqlite3Select(pParse, pSel, &dest) ){
31871450bc6eSdrh     return 0;
318894ccde58Sdrh   }
31892c04131cSdrh   pExpr->iTable = rReg = dest.iSDParm;
3190ebb6a65dSdrh   ExprSetVVAProperty(pExpr, EP_NoReduce);
31912c04131cSdrh   if( addrOnce ){
31922c04131cSdrh     sqlite3VdbeJumpHere(v, addrOnce);
3193fc976065Sdanielk1977 
31942c04131cSdrh     /* Subroutine return */
31952c04131cSdrh     sqlite3VdbeAddOp1(v, OP_Return, pExpr->y.sub.regReturn);
31962c04131cSdrh     sqlite3VdbeChangeP1(v, pExpr->y.sub.iAddr-1, sqlite3VdbeCurrentAddr(v)-1);
31976d2566dfSdrh     sqlite3ClearTempRegCache(pParse);
31985198ff57Sdrh   }
31992c04131cSdrh 
32001450bc6eSdrh   return rReg;
3201cce7d176Sdrh }
320251522cd3Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
3203cce7d176Sdrh 
3204e3365e6cSdrh #ifndef SQLITE_OMIT_SUBQUERY
3205e3365e6cSdrh /*
32067b35a77bSdan ** Expr pIn is an IN(...) expression. This function checks that the
32077b35a77bSdan ** sub-select on the RHS of the IN() operator has the same number of
32087b35a77bSdan ** columns as the vector on the LHS. Or, if the RHS of the IN() is not
32097b35a77bSdan ** a sub-query, that the LHS is a vector of size 1.
32107b35a77bSdan */
32117b35a77bSdan int sqlite3ExprCheckIN(Parse *pParse, Expr *pIn){
32127b35a77bSdan   int nVector = sqlite3ExprVectorSize(pIn->pLeft);
32137a04e296Sdrh   if( (pIn->flags & EP_xIsSelect)!=0 && !pParse->db->mallocFailed ){
32147b35a77bSdan     if( nVector!=pIn->x.pSelect->pEList->nExpr ){
32157b35a77bSdan       sqlite3SubselectError(pParse, pIn->x.pSelect->pEList->nExpr, nVector);
32167b35a77bSdan       return 1;
32177b35a77bSdan     }
32187b35a77bSdan   }else if( nVector!=1 ){
321944c5604cSdan     sqlite3VectorErrorMsg(pParse, pIn->pLeft);
32207b35a77bSdan     return 1;
32217b35a77bSdan   }
32227b35a77bSdan   return 0;
32237b35a77bSdan }
32247b35a77bSdan #endif
32257b35a77bSdan 
32267b35a77bSdan #ifndef SQLITE_OMIT_SUBQUERY
32277b35a77bSdan /*
3228e3365e6cSdrh ** Generate code for an IN expression.
3229e3365e6cSdrh **
3230e3365e6cSdrh **      x IN (SELECT ...)
3231e3365e6cSdrh **      x IN (value, value, ...)
3232e3365e6cSdrh **
3233ecb87ac8Sdrh ** The left-hand side (LHS) is a scalar or vector expression.  The
3234e347d3e8Sdrh ** right-hand side (RHS) is an array of zero or more scalar values, or a
3235e347d3e8Sdrh ** subquery.  If the RHS is a subquery, the number of result columns must
3236e347d3e8Sdrh ** match the number of columns in the vector on the LHS.  If the RHS is
3237e347d3e8Sdrh ** a list of values, the LHS must be a scalar.
3238e347d3e8Sdrh **
3239e347d3e8Sdrh ** The IN operator is true if the LHS value is contained within the RHS.
3240e347d3e8Sdrh ** The result is false if the LHS is definitely not in the RHS.  The
3241e347d3e8Sdrh ** result is NULL if the presence of the LHS in the RHS cannot be
3242e347d3e8Sdrh ** determined due to NULLs.
3243e3365e6cSdrh **
32446be515ebSdrh ** This routine generates code that jumps to destIfFalse if the LHS is not
3245e3365e6cSdrh ** contained within the RHS.  If due to NULLs we cannot determine if the LHS
3246e3365e6cSdrh ** is contained in the RHS then jump to destIfNull.  If the LHS is contained
3247e3365e6cSdrh ** within the RHS then fall through.
3248ecb87ac8Sdrh **
3249ecb87ac8Sdrh ** See the separate in-operator.md documentation file in the canonical
3250ecb87ac8Sdrh ** SQLite source tree for additional information.
3251e3365e6cSdrh */
3252e3365e6cSdrh static void sqlite3ExprCodeIN(
3253e3365e6cSdrh   Parse *pParse,        /* Parsing and code generating context */
3254e3365e6cSdrh   Expr *pExpr,          /* The IN expression */
3255e3365e6cSdrh   int destIfFalse,      /* Jump here if LHS is not contained in the RHS */
3256e3365e6cSdrh   int destIfNull        /* Jump here if the results are unknown due to NULLs */
3257e3365e6cSdrh ){
3258e3365e6cSdrh   int rRhsHasNull = 0;  /* Register that is true if RHS contains NULL values */
3259e3365e6cSdrh   int eType;            /* Type of the RHS */
3260e347d3e8Sdrh   int rLhs;             /* Register(s) holding the LHS values */
3261e347d3e8Sdrh   int rLhsOrig;         /* LHS values prior to reordering by aiMap[] */
3262e3365e6cSdrh   Vdbe *v;              /* Statement under construction */
3263ba00e30aSdan   int *aiMap = 0;       /* Map from vector field to index column */
3264ba00e30aSdan   char *zAff = 0;       /* Affinity string for comparisons */
3265ecb87ac8Sdrh   int nVector;          /* Size of vectors for this IN operator */
326612abf408Sdrh   int iDummy;           /* Dummy parameter to exprCodeVector() */
3267e347d3e8Sdrh   Expr *pLeft;          /* The LHS of the IN operator */
3268ecb87ac8Sdrh   int i;                /* loop counter */
3269e347d3e8Sdrh   int destStep2;        /* Where to jump when NULLs seen in step 2 */
3270e347d3e8Sdrh   int destStep6 = 0;    /* Start of code for Step 6 */
3271e347d3e8Sdrh   int addrTruthOp;      /* Address of opcode that determines the IN is true */
3272e347d3e8Sdrh   int destNotNull;      /* Jump here if a comparison is not true in step 6 */
3273e347d3e8Sdrh   int addrTop;          /* Top of the step-6 loop */
32742c04131cSdrh   int iTab = 0;         /* Index to use */
3275c59b4acfSdan   u8 okConstFactor = pParse->okConstFactor;
3276e3365e6cSdrh 
3277e7375bfaSdrh   assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
3278e347d3e8Sdrh   pLeft = pExpr->pLeft;
32797b35a77bSdan   if( sqlite3ExprCheckIN(pParse, pExpr) ) return;
3280553168c7Sdan   zAff = exprINAffinity(pParse, pExpr);
3281ba00e30aSdan   nVector = sqlite3ExprVectorSize(pExpr->pLeft);
3282ba00e30aSdan   aiMap = (int*)sqlite3DbMallocZero(
3283ba00e30aSdan       pParse->db, nVector*(sizeof(int) + sizeof(char)) + 1
3284ba00e30aSdan   );
3285e347d3e8Sdrh   if( pParse->db->mallocFailed ) goto sqlite3ExprCodeIN_oom_error;
32867b35a77bSdan 
3287ba00e30aSdan   /* Attempt to compute the RHS. After this step, if anything other than
32882c04131cSdrh   ** IN_INDEX_NOOP is returned, the table opened with cursor iTab
3289ba00e30aSdan   ** contains the values that make up the RHS. If IN_INDEX_NOOP is returned,
3290ba00e30aSdan   ** the RHS has not yet been coded.  */
3291e3365e6cSdrh   v = pParse->pVdbe;
3292e3365e6cSdrh   assert( v!=0 );       /* OOM detected prior to this routine */
3293e3365e6cSdrh   VdbeNoopComment((v, "begin IN expr"));
3294bb53ecb1Sdrh   eType = sqlite3FindInIndex(pParse, pExpr,
3295bb53ecb1Sdrh                              IN_INDEX_MEMBERSHIP | IN_INDEX_NOOP_OK,
32962c04131cSdrh                              destIfFalse==destIfNull ? 0 : &rRhsHasNull,
32972c04131cSdrh                              aiMap, &iTab);
3298e3365e6cSdrh 
3299ba00e30aSdan   assert( pParse->nErr || nVector==1 || eType==IN_INDEX_EPH
3300ba00e30aSdan        || eType==IN_INDEX_INDEX_ASC || eType==IN_INDEX_INDEX_DESC
3301ba00e30aSdan   );
3302ecb87ac8Sdrh #ifdef SQLITE_DEBUG
3303ecb87ac8Sdrh   /* Confirm that aiMap[] contains nVector integer values between 0 and
3304ecb87ac8Sdrh   ** nVector-1. */
3305ecb87ac8Sdrh   for(i=0; i<nVector; i++){
3306ecb87ac8Sdrh     int j, cnt;
3307ecb87ac8Sdrh     for(cnt=j=0; j<nVector; j++) if( aiMap[j]==i ) cnt++;
3308ecb87ac8Sdrh     assert( cnt==1 );
3309ecb87ac8Sdrh   }
3310ecb87ac8Sdrh #endif
3311e3365e6cSdrh 
3312ba00e30aSdan   /* Code the LHS, the <expr> from "<expr> IN (...)". If the LHS is a
3313ba00e30aSdan   ** vector, then it is stored in an array of nVector registers starting
3314ba00e30aSdan   ** at r1.
3315e347d3e8Sdrh   **
3316e347d3e8Sdrh   ** sqlite3FindInIndex() might have reordered the fields of the LHS vector
3317e347d3e8Sdrh   ** so that the fields are in the same order as an existing index.   The
3318e347d3e8Sdrh   ** aiMap[] array contains a mapping from the original LHS field order to
3319e347d3e8Sdrh   ** the field order that matches the RHS index.
3320c59b4acfSdan   **
3321c59b4acfSdan   ** Avoid factoring the LHS of the IN(...) expression out of the loop,
3322c59b4acfSdan   ** even if it is constant, as OP_Affinity may be used on the register
3323c59b4acfSdan   ** by code generated below.  */
3324c59b4acfSdan   assert( pParse->okConstFactor==okConstFactor );
3325c59b4acfSdan   pParse->okConstFactor = 0;
3326e347d3e8Sdrh   rLhsOrig = exprCodeVector(pParse, pLeft, &iDummy);
3327c59b4acfSdan   pParse->okConstFactor = okConstFactor;
3328e347d3e8Sdrh   for(i=0; i<nVector && aiMap[i]==i; i++){} /* Are LHS fields reordered? */
3329ecb87ac8Sdrh   if( i==nVector ){
3330e347d3e8Sdrh     /* LHS fields are not reordered */
3331e347d3e8Sdrh     rLhs = rLhsOrig;
3332ecb87ac8Sdrh   }else{
3333ecb87ac8Sdrh     /* Need to reorder the LHS fields according to aiMap */
3334e347d3e8Sdrh     rLhs = sqlite3GetTempRange(pParse, nVector);
3335ba00e30aSdan     for(i=0; i<nVector; i++){
3336e347d3e8Sdrh       sqlite3VdbeAddOp3(v, OP_Copy, rLhsOrig+i, rLhs+aiMap[i], 0);
3337ba00e30aSdan     }
3338ecb87ac8Sdrh   }
3339e3365e6cSdrh 
3340bb53ecb1Sdrh   /* If sqlite3FindInIndex() did not find or create an index that is
3341bb53ecb1Sdrh   ** suitable for evaluating the IN operator, then evaluate using a
3342bb53ecb1Sdrh   ** sequence of comparisons.
3343e347d3e8Sdrh   **
3344e347d3e8Sdrh   ** This is step (1) in the in-operator.md optimized algorithm.
3345bb53ecb1Sdrh   */
3346bb53ecb1Sdrh   if( eType==IN_INDEX_NOOP ){
3347bb53ecb1Sdrh     ExprList *pList = pExpr->x.pList;
3348bb53ecb1Sdrh     CollSeq *pColl = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
3349ec4ccdbcSdrh     int labelOk = sqlite3VdbeMakeLabel(pParse);
3350bb53ecb1Sdrh     int r2, regToFree;
3351bb53ecb1Sdrh     int regCkNull = 0;
3352bb53ecb1Sdrh     int ii;
3353bb53ecb1Sdrh     assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
3354bb53ecb1Sdrh     if( destIfNull!=destIfFalse ){
3355bb53ecb1Sdrh       regCkNull = sqlite3GetTempReg(pParse);
3356e347d3e8Sdrh       sqlite3VdbeAddOp3(v, OP_BitAnd, rLhs, rLhs, regCkNull);
3357bb53ecb1Sdrh     }
3358bb53ecb1Sdrh     for(ii=0; ii<pList->nExpr; ii++){
33594fc83654Sdrh       r2 = sqlite3ExprCodeTemp(pParse, pList->a[ii].pExpr, &regToFree);
3360a976979bSdrh       if( regCkNull && sqlite3ExprCanBeNull(pList->a[ii].pExpr) ){
3361bb53ecb1Sdrh         sqlite3VdbeAddOp3(v, OP_BitAnd, regCkNull, r2, regCkNull);
3362bb53ecb1Sdrh       }
3363f6ea97eaSdrh       sqlite3ReleaseTempReg(pParse, regToFree);
3364bb53ecb1Sdrh       if( ii<pList->nExpr-1 || destIfNull!=destIfFalse ){
33654799488eSdrh         int op = rLhs!=r2 ? OP_Eq : OP_NotNull;
33664799488eSdrh         sqlite3VdbeAddOp4(v, op, rLhs, labelOk, r2,
33674336b0e6Sdrh                           (void*)pColl, P4_COLLSEQ);
33684799488eSdrh         VdbeCoverageIf(v, ii<pList->nExpr-1 && op==OP_Eq);
33694799488eSdrh         VdbeCoverageIf(v, ii==pList->nExpr-1 && op==OP_Eq);
33704799488eSdrh         VdbeCoverageIf(v, ii<pList->nExpr-1 && op==OP_NotNull);
33714799488eSdrh         VdbeCoverageIf(v, ii==pList->nExpr-1 && op==OP_NotNull);
3372ba00e30aSdan         sqlite3VdbeChangeP5(v, zAff[0]);
3373bb53ecb1Sdrh       }else{
33744799488eSdrh         int op = rLhs!=r2 ? OP_Ne : OP_IsNull;
3375bb53ecb1Sdrh         assert( destIfNull==destIfFalse );
33764799488eSdrh         sqlite3VdbeAddOp4(v, op, rLhs, destIfFalse, r2,
33774799488eSdrh                           (void*)pColl, P4_COLLSEQ);
33784799488eSdrh         VdbeCoverageIf(v, op==OP_Ne);
33794799488eSdrh         VdbeCoverageIf(v, op==OP_IsNull);
3380ba00e30aSdan         sqlite3VdbeChangeP5(v, zAff[0] | SQLITE_JUMPIFNULL);
3381bb53ecb1Sdrh       }
3382bb53ecb1Sdrh     }
3383bb53ecb1Sdrh     if( regCkNull ){
3384bb53ecb1Sdrh       sqlite3VdbeAddOp2(v, OP_IsNull, regCkNull, destIfNull); VdbeCoverage(v);
3385076e85f5Sdrh       sqlite3VdbeGoto(v, destIfFalse);
3386bb53ecb1Sdrh     }
3387bb53ecb1Sdrh     sqlite3VdbeResolveLabel(v, labelOk);
3388bb53ecb1Sdrh     sqlite3ReleaseTempReg(pParse, regCkNull);
3389e347d3e8Sdrh     goto sqlite3ExprCodeIN_finished;
3390e347d3e8Sdrh   }
3391bb53ecb1Sdrh 
3392e347d3e8Sdrh   /* Step 2: Check to see if the LHS contains any NULL columns.  If the
3393e347d3e8Sdrh   ** LHS does contain NULLs then the result must be either FALSE or NULL.
3394e347d3e8Sdrh   ** We will then skip the binary search of the RHS.
3395e347d3e8Sdrh   */
3396094430ebSdrh   if( destIfNull==destIfFalse ){
3397e347d3e8Sdrh     destStep2 = destIfFalse;
3398e347d3e8Sdrh   }else{
3399ec4ccdbcSdrh     destStep2 = destStep6 = sqlite3VdbeMakeLabel(pParse);
3400e347d3e8Sdrh   }
34014eac5f04Sdrh   if( pParse->nErr ) goto sqlite3ExprCodeIN_finished;
3402d49fd4e8Sdan   for(i=0; i<nVector; i++){
3403fc7f27b9Sdrh     Expr *p = sqlite3VectorFieldSubexpr(pExpr->pLeft, i);
34044c4a2572Sdrh     if( pParse->db->mallocFailed ) goto sqlite3ExprCodeIN_oom_error;
3405d49fd4e8Sdan     if( sqlite3ExprCanBeNull(p) ){
3406e347d3e8Sdrh       sqlite3VdbeAddOp2(v, OP_IsNull, rLhs+i, destStep2);
3407471b4b92Sdrh       VdbeCoverage(v);
3408d49fd4e8Sdan     }
3409d49fd4e8Sdan   }
3410e3365e6cSdrh 
3411e347d3e8Sdrh   /* Step 3.  The LHS is now known to be non-NULL.  Do the binary search
3412e347d3e8Sdrh   ** of the RHS using the LHS as a probe.  If found, the result is
3413e347d3e8Sdrh   ** true.
3414e347d3e8Sdrh   */
3415e3365e6cSdrh   if( eType==IN_INDEX_ROWID ){
3416e347d3e8Sdrh     /* In this case, the RHS is the ROWID of table b-tree and so we also
3417e347d3e8Sdrh     ** know that the RHS is non-NULL.  Hence, we combine steps 3 and 4
3418e347d3e8Sdrh     ** into a single opcode. */
34192c04131cSdrh     sqlite3VdbeAddOp3(v, OP_SeekRowid, iTab, destIfFalse, rLhs);
3420688852abSdrh     VdbeCoverage(v);
3421e347d3e8Sdrh     addrTruthOp = sqlite3VdbeAddOp0(v, OP_Goto);  /* Return True */
34227b35a77bSdan   }else{
3423e347d3e8Sdrh     sqlite3VdbeAddOp4(v, OP_Affinity, rLhs, nVector, 0, zAff, nVector);
3424e347d3e8Sdrh     if( destIfFalse==destIfNull ){
3425e347d3e8Sdrh       /* Combine Step 3 and Step 5 into a single opcode */
34262c04131cSdrh       sqlite3VdbeAddOp4Int(v, OP_NotFound, iTab, destIfFalse,
3427e347d3e8Sdrh                            rLhs, nVector); VdbeCoverage(v);
3428e347d3e8Sdrh       goto sqlite3ExprCodeIN_finished;
3429e347d3e8Sdrh     }
3430e347d3e8Sdrh     /* Ordinary Step 3, for the case where FALSE and NULL are distinct */
34312c04131cSdrh     addrTruthOp = sqlite3VdbeAddOp4Int(v, OP_Found, iTab, 0,
3432e347d3e8Sdrh                                       rLhs, nVector); VdbeCoverage(v);
3433e347d3e8Sdrh   }
3434ba00e30aSdan 
3435e347d3e8Sdrh   /* Step 4.  If the RHS is known to be non-NULL and we did not find
3436e347d3e8Sdrh   ** an match on the search above, then the result must be FALSE.
3437e347d3e8Sdrh   */
3438e347d3e8Sdrh   if( rRhsHasNull && nVector==1 ){
3439e347d3e8Sdrh     sqlite3VdbeAddOp2(v, OP_NotNull, rRhsHasNull, destIfFalse);
3440471b4b92Sdrh     VdbeCoverage(v);
3441e347d3e8Sdrh   }
34427b35a77bSdan 
3443e347d3e8Sdrh   /* Step 5.  If we do not care about the difference between NULL and
3444e347d3e8Sdrh   ** FALSE, then just return false.
3445e347d3e8Sdrh   */
3446e347d3e8Sdrh   if( destIfFalse==destIfNull ) sqlite3VdbeGoto(v, destIfFalse);
3447e347d3e8Sdrh 
3448e347d3e8Sdrh   /* Step 6: Loop through rows of the RHS.  Compare each row to the LHS.
3449e347d3e8Sdrh   ** If any comparison is NULL, then the result is NULL.  If all
3450e347d3e8Sdrh   ** comparisons are FALSE then the final result is FALSE.
3451e347d3e8Sdrh   **
3452e347d3e8Sdrh   ** For a scalar LHS, it is sufficient to check just the first row
3453e347d3e8Sdrh   ** of the RHS.
3454e347d3e8Sdrh   */
3455e347d3e8Sdrh   if( destStep6 ) sqlite3VdbeResolveLabel(v, destStep6);
34562c04131cSdrh   addrTop = sqlite3VdbeAddOp2(v, OP_Rewind, iTab, destIfFalse);
3457471b4b92Sdrh   VdbeCoverage(v);
3458e347d3e8Sdrh   if( nVector>1 ){
3459ec4ccdbcSdrh     destNotNull = sqlite3VdbeMakeLabel(pParse);
3460e347d3e8Sdrh   }else{
3461e347d3e8Sdrh     /* For nVector==1, combine steps 6 and 7 by immediately returning
3462e347d3e8Sdrh     ** FALSE if the first comparison is not NULL */
3463e347d3e8Sdrh     destNotNull = destIfFalse;
3464e347d3e8Sdrh   }
3465ba00e30aSdan   for(i=0; i<nVector; i++){
3466ba00e30aSdan     Expr *p;
3467ba00e30aSdan     CollSeq *pColl;
3468e347d3e8Sdrh     int r3 = sqlite3GetTempReg(pParse);
3469fc7f27b9Sdrh     p = sqlite3VectorFieldSubexpr(pLeft, i);
3470ba00e30aSdan     pColl = sqlite3ExprCollSeq(pParse, p);
34712c04131cSdrh     sqlite3VdbeAddOp3(v, OP_Column, iTab, i, r3);
3472e347d3e8Sdrh     sqlite3VdbeAddOp4(v, OP_Ne, rLhs+i, destNotNull, r3,
347318016ad2Sdrh                       (void*)pColl, P4_COLLSEQ);
3474471b4b92Sdrh     VdbeCoverage(v);
3475e347d3e8Sdrh     sqlite3ReleaseTempReg(pParse, r3);
34767b35a77bSdan   }
34777b35a77bSdan   sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfNull);
3478e347d3e8Sdrh   if( nVector>1 ){
3479e347d3e8Sdrh     sqlite3VdbeResolveLabel(v, destNotNull);
34802c04131cSdrh     sqlite3VdbeAddOp2(v, OP_Next, iTab, addrTop+1);
348118016ad2Sdrh     VdbeCoverage(v);
3482e347d3e8Sdrh 
3483e347d3e8Sdrh     /* Step 7:  If we reach this point, we know that the result must
3484e347d3e8Sdrh     ** be false. */
348518016ad2Sdrh     sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfFalse);
34867b35a77bSdan   }
34877b35a77bSdan 
3488e347d3e8Sdrh   /* Jumps here in order to return true. */
3489e347d3e8Sdrh   sqlite3VdbeJumpHere(v, addrTruthOp);
3490e3365e6cSdrh 
3491e347d3e8Sdrh sqlite3ExprCodeIN_finished:
3492e347d3e8Sdrh   if( rLhs!=rLhsOrig ) sqlite3ReleaseTempReg(pParse, rLhs);
3493ecb87ac8Sdrh   VdbeComment((v, "end IN expr"));
3494e347d3e8Sdrh sqlite3ExprCodeIN_oom_error:
3495ba00e30aSdan   sqlite3DbFree(pParse->db, aiMap);
3496553168c7Sdan   sqlite3DbFree(pParse->db, zAff);
3497e3365e6cSdrh }
3498e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
3499e3365e6cSdrh 
350013573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
3501598f1340Sdrh /*
3502598f1340Sdrh ** Generate an instruction that will put the floating point
35039cbf3425Sdrh ** value described by z[0..n-1] into register iMem.
35040cf19ed8Sdrh **
35050cf19ed8Sdrh ** The z[] string will probably not be zero-terminated.  But the
35060cf19ed8Sdrh ** z[n] character is guaranteed to be something that does not look
35070cf19ed8Sdrh ** like the continuation of the number.
3508598f1340Sdrh */
3509b7916a78Sdrh static void codeReal(Vdbe *v, const char *z, int negateFlag, int iMem){
3510fd773cf9Sdrh   if( ALWAYS(z!=0) ){
3511598f1340Sdrh     double value;
35129339da1fSdrh     sqlite3AtoF(z, &value, sqlite3Strlen30(z), SQLITE_UTF8);
3513d0015161Sdrh     assert( !sqlite3IsNaN(value) ); /* The new AtoF never returns NaN */
3514598f1340Sdrh     if( negateFlag ) value = -value;
351597bae794Sdrh     sqlite3VdbeAddOp4Dup8(v, OP_Real, 0, iMem, 0, (u8*)&value, P4_REAL);
3516598f1340Sdrh   }
3517598f1340Sdrh }
351813573c71Sdrh #endif
3519598f1340Sdrh 
3520598f1340Sdrh 
3521598f1340Sdrh /*
3522fec19aadSdrh ** Generate an instruction that will put the integer describe by
35239cbf3425Sdrh ** text z[0..n-1] into register iMem.
35240cf19ed8Sdrh **
35255f1d6b61Sshaneh ** Expr.u.zToken is always UTF8 and zero-terminated.
3526fec19aadSdrh */
352713573c71Sdrh static void codeInteger(Parse *pParse, Expr *pExpr, int negFlag, int iMem){
352813573c71Sdrh   Vdbe *v = pParse->pVdbe;
352992b01d53Sdrh   if( pExpr->flags & EP_IntValue ){
353033e619fcSdrh     int i = pExpr->u.iValue;
3531d50ffc41Sdrh     assert( i>=0 );
353292b01d53Sdrh     if( negFlag ) i = -i;
353392b01d53Sdrh     sqlite3VdbeAddOp2(v, OP_Integer, i, iMem);
3534fd773cf9Sdrh   }else{
35355f1d6b61Sshaneh     int c;
35365f1d6b61Sshaneh     i64 value;
3537fd773cf9Sdrh     const char *z = pExpr->u.zToken;
3538fd773cf9Sdrh     assert( z!=0 );
35399296c18aSdrh     c = sqlite3DecOrHexToI64(z, &value);
354084d4f1a3Sdrh     if( (c==3 && !negFlag) || (c==2) || (negFlag && value==SMALLEST_INT64)){
354113573c71Sdrh #ifdef SQLITE_OMIT_FLOATING_POINT
354213573c71Sdrh       sqlite3ErrorMsg(pParse, "oversized integer: %s%s", negFlag ? "-" : "", z);
354313573c71Sdrh #else
35441b7ddc59Sdrh #ifndef SQLITE_OMIT_HEX_INTEGER
35459296c18aSdrh       if( sqlite3_strnicmp(z,"0x",2)==0 ){
354677320ea4Sdrh         sqlite3ErrorMsg(pParse, "hex literal too big: %s%s", negFlag?"-":"",z);
35471b7ddc59Sdrh       }else
35481b7ddc59Sdrh #endif
35491b7ddc59Sdrh       {
3550b7916a78Sdrh         codeReal(v, z, negFlag, iMem);
35519296c18aSdrh       }
355213573c71Sdrh #endif
355377320ea4Sdrh     }else{
355484d4f1a3Sdrh       if( negFlag ){ value = c==3 ? SMALLEST_INT64 : -value; }
355577320ea4Sdrh       sqlite3VdbeAddOp4Dup8(v, OP_Int64, 0, iMem, 0, (u8*)&value, P4_INT64);
3556fec19aadSdrh     }
3557fec19aadSdrh   }
3558c9cf901dSdanielk1977 }
3559fec19aadSdrh 
35605cd79239Sdrh 
35611f9ca2c8Sdrh /* Generate code that will load into register regOut a value that is
35621f9ca2c8Sdrh ** appropriate for the iIdxCol-th column of index pIdx.
35631f9ca2c8Sdrh */
35641f9ca2c8Sdrh void sqlite3ExprCodeLoadIndexColumn(
35651f9ca2c8Sdrh   Parse *pParse,  /* The parsing context */
35661f9ca2c8Sdrh   Index *pIdx,    /* The index whose column is to be loaded */
35671f9ca2c8Sdrh   int iTabCur,    /* Cursor pointing to a table row */
35681f9ca2c8Sdrh   int iIdxCol,    /* The column of the index to be loaded */
35691f9ca2c8Sdrh   int regOut      /* Store the index column value in this register */
35701f9ca2c8Sdrh ){
35711f9ca2c8Sdrh   i16 iTabCol = pIdx->aiColumn[iIdxCol];
35724b92f98cSdrh   if( iTabCol==XN_EXPR ){
35731f9ca2c8Sdrh     assert( pIdx->aColExpr );
35741f9ca2c8Sdrh     assert( pIdx->aColExpr->nExpr>iIdxCol );
35753e34eabcSdrh     pParse->iSelfTab = iTabCur + 1;
35761c75c9d7Sdrh     sqlite3ExprCodeCopy(pParse, pIdx->aColExpr->a[iIdxCol].pExpr, regOut);
35773e34eabcSdrh     pParse->iSelfTab = 0;
35784b92f98cSdrh   }else{
35796df9c4b9Sdrh     sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pIdx->pTable, iTabCur,
35804b92f98cSdrh                                     iTabCol, regOut);
35814b92f98cSdrh   }
35821f9ca2c8Sdrh }
35831f9ca2c8Sdrh 
3584e70fa7feSdrh #ifndef SQLITE_OMIT_GENERATED_COLUMNS
3585e70fa7feSdrh /*
3586e70fa7feSdrh ** Generate code that will compute the value of generated column pCol
3587e70fa7feSdrh ** and store the result in register regOut
3588e70fa7feSdrh */
3589e70fa7feSdrh void sqlite3ExprCodeGeneratedColumn(
3590e70fa7feSdrh   Parse *pParse,
3591e70fa7feSdrh   Column *pCol,
3592e70fa7feSdrh   int regOut
3593e70fa7feSdrh ){
35944dad7ed5Sdrh   int iAddr;
35954dad7ed5Sdrh   Vdbe *v = pParse->pVdbe;
35964dad7ed5Sdrh   assert( v!=0 );
35974dad7ed5Sdrh   assert( pParse->iSelfTab!=0 );
35984dad7ed5Sdrh   if( pParse->iSelfTab>0 ){
35994dad7ed5Sdrh     iAddr = sqlite3VdbeAddOp3(v, OP_IfNullRow, pParse->iSelfTab-1, 0, regOut);
36004dad7ed5Sdrh   }else{
36014dad7ed5Sdrh     iAddr = 0;
36024dad7ed5Sdrh   }
360324e39903Sdrh   sqlite3ExprCodeCopy(pParse, pCol->pDflt, regOut);
3604e70fa7feSdrh   if( pCol->affinity>=SQLITE_AFF_TEXT ){
36054dad7ed5Sdrh     sqlite3VdbeAddOp4(v, OP_Affinity, regOut, 1, 0, &pCol->affinity, 1);
3606e70fa7feSdrh   }
36074dad7ed5Sdrh   if( iAddr ) sqlite3VdbeJumpHere(v, iAddr);
3608e70fa7feSdrh }
3609e70fa7feSdrh #endif /* SQLITE_OMIT_GENERATED_COLUMNS */
3610e70fa7feSdrh 
36115cd79239Sdrh /*
36125c092e8aSdrh ** Generate code to extract the value of the iCol-th column of a table.
36135c092e8aSdrh */
36145c092e8aSdrh void sqlite3ExprCodeGetColumnOfTable(
36156df9c4b9Sdrh   Vdbe *v,        /* Parsing context */
36165c092e8aSdrh   Table *pTab,    /* The table containing the value */
3617313619f5Sdrh   int iTabCur,    /* The table cursor.  Or the PK cursor for WITHOUT ROWID */
36185c092e8aSdrh   int iCol,       /* Index of the column to extract */
3619313619f5Sdrh   int regOut      /* Extract the value into this register */
36205c092e8aSdrh ){
3621ab45fc04Sdrh   Column *pCol;
362281f7b372Sdrh   assert( v!=0 );
3623aca19e19Sdrh   if( pTab==0 ){
3624aca19e19Sdrh     sqlite3VdbeAddOp3(v, OP_Column, iTabCur, iCol, regOut);
3625aca19e19Sdrh     return;
3626aca19e19Sdrh   }
36275c092e8aSdrh   if( iCol<0 || iCol==pTab->iPKey ){
36285c092e8aSdrh     sqlite3VdbeAddOp2(v, OP_Rowid, iTabCur, regOut);
36295c092e8aSdrh   }else{
363081f7b372Sdrh     int op;
363181f7b372Sdrh     int x;
363281f7b372Sdrh     if( IsVirtual(pTab) ){
363381f7b372Sdrh       op = OP_VColumn;
363481f7b372Sdrh       x = iCol;
363581f7b372Sdrh #ifndef SQLITE_OMIT_GENERATED_COLUMNS
3636ab45fc04Sdrh     }else if( (pCol = &pTab->aCol[iCol])->colFlags & COLFLAG_VIRTUAL ){
36376df9c4b9Sdrh       Parse *pParse = sqlite3VdbeParser(v);
3638ab45fc04Sdrh       if( pCol->colFlags & COLFLAG_BUSY ){
3639ab45fc04Sdrh         sqlite3ErrorMsg(pParse, "generated column loop on \"%s\"", pCol->zName);
3640ab45fc04Sdrh       }else{
364181f7b372Sdrh         int savedSelfTab = pParse->iSelfTab;
3642ab45fc04Sdrh         pCol->colFlags |= COLFLAG_BUSY;
364381f7b372Sdrh         pParse->iSelfTab = iTabCur+1;
3644e70fa7feSdrh         sqlite3ExprCodeGeneratedColumn(pParse, pCol, regOut);
364581f7b372Sdrh         pParse->iSelfTab = savedSelfTab;
3646ab45fc04Sdrh         pCol->colFlags &= ~COLFLAG_BUSY;
3647ab45fc04Sdrh       }
364881f7b372Sdrh       return;
364981f7b372Sdrh #endif
365081f7b372Sdrh     }else if( !HasRowid(pTab) ){
3651c5f808d8Sdrh       testcase( iCol!=sqlite3TableColumnToStorage(pTab, iCol) );
3652b9bcf7caSdrh       x = sqlite3TableColumnToIndex(sqlite3PrimaryKeyIndex(pTab), iCol);
365381f7b372Sdrh       op = OP_Column;
365481f7b372Sdrh     }else{
3655b9bcf7caSdrh       x = sqlite3TableColumnToStorage(pTab,iCol);
3656c5f808d8Sdrh       testcase( x!=iCol );
365781f7b372Sdrh       op = OP_Column;
3658ee0ec8e1Sdrh     }
3659ee0ec8e1Sdrh     sqlite3VdbeAddOp3(v, op, iTabCur, x, regOut);
36605c092e8aSdrh     sqlite3ColumnDefault(v, pTab, iCol, regOut);
36615c092e8aSdrh   }
36625c092e8aSdrh }
36635c092e8aSdrh 
36645c092e8aSdrh /*
3665945498f3Sdrh ** Generate code that will extract the iColumn-th column from
36668c607191Sdrh ** table pTab and store the column value in register iReg.
3667e55cbd72Sdrh **
3668e55cbd72Sdrh ** There must be an open cursor to pTab in iTable when this routine
3669e55cbd72Sdrh ** is called.  If iColumn<0 then code is generated that extracts the rowid.
3670945498f3Sdrh */
3671e55cbd72Sdrh int sqlite3ExprCodeGetColumn(
3672e55cbd72Sdrh   Parse *pParse,   /* Parsing and code generating context */
36732133d822Sdrh   Table *pTab,     /* Description of the table we are reading from */
36742133d822Sdrh   int iColumn,     /* Index of the table column */
36752133d822Sdrh   int iTable,      /* The cursor pointing to the table */
3676a748fdccSdrh   int iReg,        /* Store results here */
3677ce78bc6eSdrh   u8 p5            /* P5 value for OP_Column + FLAGS */
36782133d822Sdrh ){
367981f7b372Sdrh   assert( pParse->pVdbe!=0 );
36806df9c4b9Sdrh   sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pTab, iTable, iColumn, iReg);
3681a748fdccSdrh   if( p5 ){
368299670abbSdrh     VdbeOp *pOp = sqlite3VdbeGetOp(pParse->pVdbe,-1);
368399670abbSdrh     if( pOp->opcode==OP_Column ) pOp->p5 = p5;
3684a748fdccSdrh   }
3685e55cbd72Sdrh   return iReg;
3686e55cbd72Sdrh }
3687e55cbd72Sdrh 
3688e55cbd72Sdrh /*
3689b21e7c70Sdrh ** Generate code to move content from registers iFrom...iFrom+nReg-1
369036a5d88dSdrh ** over to iTo..iTo+nReg-1.
3691e55cbd72Sdrh */
3692b21e7c70Sdrh void sqlite3ExprCodeMove(Parse *pParse, int iFrom, int iTo, int nReg){
3693079a3072Sdrh   sqlite3VdbeAddOp3(pParse->pVdbe, OP_Move, iFrom, iTo, nReg);
3694945498f3Sdrh }
3695945498f3Sdrh 
3696652fbf55Sdrh /*
369712abf408Sdrh ** Convert a scalar expression node to a TK_REGISTER referencing
369812abf408Sdrh ** register iReg.  The caller must ensure that iReg already contains
369912abf408Sdrh ** the correct value for the expression.
3700a4c3c87eSdrh */
3701069d1b1fSdan static void exprToRegister(Expr *pExpr, int iReg){
37020d950af3Sdrh   Expr *p = sqlite3ExprSkipCollateAndLikely(pExpr);
3703235667a8Sdrh   if( NEVER(p==0) ) return;
3704a4c3c87eSdrh   p->op2 = p->op;
3705a4c3c87eSdrh   p->op = TK_REGISTER;
3706a4c3c87eSdrh   p->iTable = iReg;
3707a4c3c87eSdrh   ExprClearProperty(p, EP_Skip);
3708a4c3c87eSdrh }
3709a4c3c87eSdrh 
371012abf408Sdrh /*
371112abf408Sdrh ** Evaluate an expression (either a vector or a scalar expression) and store
371212abf408Sdrh ** the result in continguous temporary registers.  Return the index of
371312abf408Sdrh ** the first register used to store the result.
371412abf408Sdrh **
371512abf408Sdrh ** If the returned result register is a temporary scalar, then also write
371612abf408Sdrh ** that register number into *piFreeable.  If the returned result register
371712abf408Sdrh ** is not a temporary or if the expression is a vector set *piFreeable
371812abf408Sdrh ** to 0.
371912abf408Sdrh */
372012abf408Sdrh static int exprCodeVector(Parse *pParse, Expr *p, int *piFreeable){
372112abf408Sdrh   int iResult;
372212abf408Sdrh   int nResult = sqlite3ExprVectorSize(p);
372312abf408Sdrh   if( nResult==1 ){
372412abf408Sdrh     iResult = sqlite3ExprCodeTemp(pParse, p, piFreeable);
372512abf408Sdrh   }else{
372612abf408Sdrh     *piFreeable = 0;
372712abf408Sdrh     if( p->op==TK_SELECT ){
3728dd1bb43aSdrh #if SQLITE_OMIT_SUBQUERY
3729dd1bb43aSdrh       iResult = 0;
3730dd1bb43aSdrh #else
373185bcdce2Sdrh       iResult = sqlite3CodeSubselect(pParse, p);
3732dd1bb43aSdrh #endif
373312abf408Sdrh     }else{
373412abf408Sdrh       int i;
373512abf408Sdrh       iResult = pParse->nMem+1;
373612abf408Sdrh       pParse->nMem += nResult;
373712abf408Sdrh       for(i=0; i<nResult; i++){
37384b725240Sdan         sqlite3ExprCodeFactorable(pParse, p->x.pList->a[i].pExpr, i+iResult);
373912abf408Sdrh       }
374012abf408Sdrh     }
374112abf408Sdrh   }
374212abf408Sdrh   return iResult;
374312abf408Sdrh }
374412abf408Sdrh 
374525c4296bSdrh /*
374692a27f7bSdrh ** If the last opcode is a OP_Copy, then set the do-not-merge flag (p5)
374792a27f7bSdrh ** so that a subsequent copy will not be merged into this one.
374892a27f7bSdrh */
374992a27f7bSdrh static void setDoNotMergeFlagOnCopy(Vdbe *v){
375092a27f7bSdrh   if( sqlite3VdbeGetOp(v, -1)->opcode==OP_Copy ){
375192a27f7bSdrh     sqlite3VdbeChangeP5(v, 1);  /* Tag trailing OP_Copy as not mergable */
375292a27f7bSdrh   }
375392a27f7bSdrh }
375492a27f7bSdrh 
375592a27f7bSdrh /*
375625c4296bSdrh ** Generate code to implement special SQL functions that are implemented
375725c4296bSdrh ** in-line rather than by using the usual callbacks.
375825c4296bSdrh */
375925c4296bSdrh static int exprCodeInlineFunction(
376025c4296bSdrh   Parse *pParse,        /* Parsing context */
376125c4296bSdrh   ExprList *pFarg,      /* List of function arguments */
376225c4296bSdrh   int iFuncId,          /* Function ID.  One of the INTFUNC_... values */
376325c4296bSdrh   int target            /* Store function result in this register */
376425c4296bSdrh ){
376525c4296bSdrh   int nFarg;
376625c4296bSdrh   Vdbe *v = pParse->pVdbe;
376725c4296bSdrh   assert( v!=0 );
376825c4296bSdrh   assert( pFarg!=0 );
376925c4296bSdrh   nFarg = pFarg->nExpr;
377025c4296bSdrh   assert( nFarg>0 );  /* All in-line functions have at least one argument */
377125c4296bSdrh   switch( iFuncId ){
377225c4296bSdrh     case INLINEFUNC_coalesce: {
377325c4296bSdrh       /* Attempt a direct implementation of the built-in COALESCE() and
377425c4296bSdrh       ** IFNULL() functions.  This avoids unnecessary evaluation of
377525c4296bSdrh       ** arguments past the first non-NULL argument.
377625c4296bSdrh       */
377725c4296bSdrh       int endCoalesce = sqlite3VdbeMakeLabel(pParse);
377825c4296bSdrh       int i;
377925c4296bSdrh       assert( nFarg>=2 );
378025c4296bSdrh       sqlite3ExprCode(pParse, pFarg->a[0].pExpr, target);
378125c4296bSdrh       for(i=1; i<nFarg; i++){
378225c4296bSdrh         sqlite3VdbeAddOp2(v, OP_NotNull, target, endCoalesce);
378325c4296bSdrh         VdbeCoverage(v);
378425c4296bSdrh         sqlite3ExprCode(pParse, pFarg->a[i].pExpr, target);
378525c4296bSdrh       }
378692a27f7bSdrh       setDoNotMergeFlagOnCopy(v);
378725c4296bSdrh       sqlite3VdbeResolveLabel(v, endCoalesce);
378825c4296bSdrh       break;
378925c4296bSdrh     }
37903c0e606bSdrh     case INLINEFUNC_iif: {
37913c0e606bSdrh       Expr caseExpr;
37923c0e606bSdrh       memset(&caseExpr, 0, sizeof(caseExpr));
37933c0e606bSdrh       caseExpr.op = TK_CASE;
37943c0e606bSdrh       caseExpr.x.pList = pFarg;
37953c0e606bSdrh       return sqlite3ExprCodeTarget(pParse, &caseExpr, target);
37963c0e606bSdrh     }
379725c4296bSdrh 
3798171c50ecSdrh     default: {
379925c4296bSdrh       /* The UNLIKELY() function is a no-op.  The result is the value
380025c4296bSdrh       ** of the first argument.
380125c4296bSdrh       */
3802171c50ecSdrh       assert( nFarg==1 || nFarg==2 );
380325c4296bSdrh       target = sqlite3ExprCodeTarget(pParse, pFarg->a[0].pExpr, target);
380425c4296bSdrh       break;
380525c4296bSdrh     }
380625c4296bSdrh 
3807171c50ecSdrh   /***********************************************************************
3808171c50ecSdrh   ** Test-only SQL functions that are only usable if enabled
3809171c50ecSdrh   ** via SQLITE_TESTCTRL_INTERNAL_FUNCTIONS
3810171c50ecSdrh   */
3811171c50ecSdrh     case INLINEFUNC_expr_compare: {
3812171c50ecSdrh       /* Compare two expressions using sqlite3ExprCompare() */
3813171c50ecSdrh       assert( nFarg==2 );
3814171c50ecSdrh       sqlite3VdbeAddOp2(v, OP_Integer,
3815171c50ecSdrh          sqlite3ExprCompare(0,pFarg->a[0].pExpr, pFarg->a[1].pExpr,-1),
3816171c50ecSdrh          target);
3817171c50ecSdrh       break;
3818171c50ecSdrh     }
3819171c50ecSdrh 
3820171c50ecSdrh     case INLINEFUNC_expr_implies_expr: {
3821171c50ecSdrh       /* Compare two expressions using sqlite3ExprImpliesExpr() */
3822171c50ecSdrh       assert( nFarg==2 );
3823171c50ecSdrh       sqlite3VdbeAddOp2(v, OP_Integer,
3824171c50ecSdrh          sqlite3ExprImpliesExpr(pParse,pFarg->a[0].pExpr, pFarg->a[1].pExpr,-1),
3825171c50ecSdrh          target);
3826171c50ecSdrh       break;
3827171c50ecSdrh     }
3828171c50ecSdrh 
3829171c50ecSdrh     case INLINEFUNC_implies_nonnull_row: {
3830171c50ecSdrh       /* REsult of sqlite3ExprImpliesNonNullRow() */
3831171c50ecSdrh       Expr *pA1;
3832171c50ecSdrh       assert( nFarg==2 );
3833171c50ecSdrh       pA1 = pFarg->a[1].pExpr;
3834171c50ecSdrh       if( pA1->op==TK_COLUMN ){
3835171c50ecSdrh         sqlite3VdbeAddOp2(v, OP_Integer,
3836171c50ecSdrh            sqlite3ExprImpliesNonNullRow(pFarg->a[0].pExpr,pA1->iTable),
3837171c50ecSdrh            target);
3838171c50ecSdrh       }else{
3839171c50ecSdrh         sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3840171c50ecSdrh       }
3841171c50ecSdrh       break;
3842171c50ecSdrh     }
3843171c50ecSdrh 
384425c4296bSdrh #ifdef SQLITE_DEBUG
384525c4296bSdrh     case INLINEFUNC_affinity: {
384625c4296bSdrh       /* The AFFINITY() function evaluates to a string that describes
384725c4296bSdrh       ** the type affinity of the argument.  This is used for testing of
384825c4296bSdrh       ** the SQLite type logic.
384925c4296bSdrh       */
385025c4296bSdrh       const char *azAff[] = { "blob", "text", "numeric", "integer", "real" };
385125c4296bSdrh       char aff;
385225c4296bSdrh       assert( nFarg==1 );
385325c4296bSdrh       aff = sqlite3ExprAffinity(pFarg->a[0].pExpr);
385425c4296bSdrh       sqlite3VdbeLoadString(v, target,
385525c4296bSdrh               (aff<=SQLITE_AFF_NONE) ? "none" : azAff[aff-SQLITE_AFF_BLOB]);
385625c4296bSdrh       break;
385725c4296bSdrh     }
385825c4296bSdrh #endif
385925c4296bSdrh   }
386025c4296bSdrh   return target;
386125c4296bSdrh }
386225c4296bSdrh 
386371c57db0Sdan 
3864a4c3c87eSdrh /*
3865cce7d176Sdrh ** Generate code into the current Vdbe to evaluate the given
38662dcef11bSdrh ** expression.  Attempt to store the results in register "target".
38672dcef11bSdrh ** Return the register where results are stored.
3868389a1adbSdrh **
38698b213899Sdrh ** With this routine, there is no guarantee that results will
38702dcef11bSdrh ** be stored in target.  The result might be stored in some other
38712dcef11bSdrh ** register if it is convenient to do so.  The calling function
38722dcef11bSdrh ** must check the return code and move the results to the desired
38732dcef11bSdrh ** register.
3874cce7d176Sdrh */
3875678ccce8Sdrh int sqlite3ExprCodeTarget(Parse *pParse, Expr *pExpr, int target){
38762dcef11bSdrh   Vdbe *v = pParse->pVdbe;  /* The VM under construction */
38772dcef11bSdrh   int op;                   /* The opcode being coded */
38782dcef11bSdrh   int inReg = target;       /* Results stored in register inReg */
38792dcef11bSdrh   int regFree1 = 0;         /* If non-zero free this temporary register */
38802dcef11bSdrh   int regFree2 = 0;         /* If non-zero free this temporary register */
38817b35a77bSdan   int r1, r2;               /* Various register numbers */
388210d1edf0Sdrh   Expr tempX;               /* Temporary expression node */
388371c57db0Sdan   int p5 = 0;
3884ffe07b2dSdrh 
38859cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
3886b639a209Sdrh   assert( v!=0 );
3887389a1adbSdrh 
38881efa8023Sdrh expr_code_doover:
3889389a1adbSdrh   if( pExpr==0 ){
3890389a1adbSdrh     op = TK_NULL;
3891389a1adbSdrh   }else{
3892e7375bfaSdrh     assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
3893f2bc013cSdrh     op = pExpr->op;
3894389a1adbSdrh   }
3895f2bc013cSdrh   switch( op ){
389613449892Sdrh     case TK_AGG_COLUMN: {
389713449892Sdrh       AggInfo *pAggInfo = pExpr->pAggInfo;
38980934d640Sdrh       struct AggInfo_col *pCol;
38990934d640Sdrh       assert( pAggInfo!=0 );
39000934d640Sdrh       assert( pExpr->iAgg>=0 && pExpr->iAgg<pAggInfo->nColumn );
39010934d640Sdrh       pCol = &pAggInfo->aCol[pExpr->iAgg];
390213449892Sdrh       if( !pAggInfo->directMode ){
39039de221dfSdrh         assert( pCol->iMem>0 );
3904c332cc30Sdrh         return pCol->iMem;
390513449892Sdrh       }else if( pAggInfo->useSortingIdx ){
39060c76e892Sdrh         Table *pTab = pCol->pTab;
39075134d135Sdan         sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdxPTab,
3908389a1adbSdrh                               pCol->iSorterColumn, target);
39098d5cea6bSdrh         if( pCol->iColumn<0 ){
39108d5cea6bSdrh           VdbeComment((v,"%s.rowid",pTab->zName));
39118d5cea6bSdrh         }else{
39128d5cea6bSdrh           VdbeComment((v,"%s.%s",pTab->zName,pTab->aCol[pCol->iColumn].zName));
39138d5cea6bSdrh           if( pTab->aCol[pCol->iColumn].affinity==SQLITE_AFF_REAL ){
39148d5cea6bSdrh             sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
39158d5cea6bSdrh           }
39160c76e892Sdrh         }
3917c332cc30Sdrh         return target;
391813449892Sdrh       }
391913449892Sdrh       /* Otherwise, fall thru into the TK_COLUMN case */
392008b92086Sdrh       /* no break */ deliberate_fall_through
392113449892Sdrh     }
3922967e8b73Sdrh     case TK_COLUMN: {
3923b2b9d3d7Sdrh       int iTab = pExpr->iTable;
392467b9ba17Sdrh       int iReg;
3925efad2e23Sdrh       if( ExprHasProperty(pExpr, EP_FixedCol) ){
3926d98f5324Sdrh         /* This COLUMN expression is really a constant due to WHERE clause
3927d98f5324Sdrh         ** constraints, and that constant is coded by the pExpr->pLeft
3928d98f5324Sdrh         ** expresssion.  However, make sure the constant has the correct
3929d98f5324Sdrh         ** datatype by applying the Affinity of the table column to the
3930d98f5324Sdrh         ** constant.
3931d98f5324Sdrh         */
393257f7ece7Sdrh         int aff;
393367b9ba17Sdrh         iReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft,target);
393457f7ece7Sdrh         if( pExpr->y.pTab ){
393557f7ece7Sdrh           aff = sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
393657f7ece7Sdrh         }else{
393757f7ece7Sdrh           aff = pExpr->affExpr;
393857f7ece7Sdrh         }
393996fb16eeSdrh         if( aff>SQLITE_AFF_BLOB ){
3940d98f5324Sdrh           static const char zAff[] = "B\000C\000D\000E";
3941d98f5324Sdrh           assert( SQLITE_AFF_BLOB=='A' );
3942d98f5324Sdrh           assert( SQLITE_AFF_TEXT=='B' );
3943d98f5324Sdrh           sqlite3VdbeAddOp4(v, OP_Affinity, iReg, 1, 0,
3944d98f5324Sdrh                             &zAff[(aff-'B')*2], P4_STATIC);
3945d98f5324Sdrh         }
3946d98f5324Sdrh         return iReg;
3947efad2e23Sdrh       }
3948b2b9d3d7Sdrh       if( iTab<0 ){
39496e97f8ecSdrh         if( pParse->iSelfTab<0 ){
39509942ef0dSdrh           /* Other columns in the same row for CHECK constraints or
39519942ef0dSdrh           ** generated columns or for inserting into partial index.
39529942ef0dSdrh           ** The row is unpacked into registers beginning at
39539942ef0dSdrh           ** 0-(pParse->iSelfTab).  The rowid (if any) is in a register
39549942ef0dSdrh           ** immediately prior to the first column.
39559942ef0dSdrh           */
39569942ef0dSdrh           Column *pCol;
39579942ef0dSdrh           Table *pTab = pExpr->y.pTab;
39589942ef0dSdrh           int iSrc;
3959c5f808d8Sdrh           int iCol = pExpr->iColumn;
39609942ef0dSdrh           assert( pTab!=0 );
3961c5f808d8Sdrh           assert( iCol>=XN_ROWID );
3962b0cbcd0eSdrh           assert( iCol<pTab->nCol );
3963c5f808d8Sdrh           if( iCol<0 ){
39649942ef0dSdrh             return -1-pParse->iSelfTab;
39659942ef0dSdrh           }
3966c5f808d8Sdrh           pCol = pTab->aCol + iCol;
3967c5f808d8Sdrh           testcase( iCol!=sqlite3TableColumnToStorage(pTab,iCol) );
3968c5f808d8Sdrh           iSrc = sqlite3TableColumnToStorage(pTab, iCol) - pParse->iSelfTab;
39699942ef0dSdrh #ifndef SQLITE_OMIT_GENERATED_COLUMNS
39709942ef0dSdrh           if( pCol->colFlags & COLFLAG_GENERATED ){
39714e8e533bSdrh             if( pCol->colFlags & COLFLAG_BUSY ){
39724e8e533bSdrh               sqlite3ErrorMsg(pParse, "generated column loop on \"%s\"",
39734e8e533bSdrh                               pCol->zName);
39744e8e533bSdrh               return 0;
39754e8e533bSdrh             }
39764e8e533bSdrh             pCol->colFlags |= COLFLAG_BUSY;
39774e8e533bSdrh             if( pCol->colFlags & COLFLAG_NOTAVAIL ){
3978e70fa7feSdrh               sqlite3ExprCodeGeneratedColumn(pParse, pCol, iSrc);
39794e8e533bSdrh             }
39804e8e533bSdrh             pCol->colFlags &= ~(COLFLAG_BUSY|COLFLAG_NOTAVAIL);
3981dd6cc9b5Sdrh             return iSrc;
39829942ef0dSdrh           }else
39839942ef0dSdrh #endif /* SQLITE_OMIT_GENERATED_COLUMNS */
39849942ef0dSdrh           if( pCol->affinity==SQLITE_AFF_REAL ){
39859942ef0dSdrh             sqlite3VdbeAddOp2(v, OP_SCopy, iSrc, target);
3986bffdd636Sdrh             sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
3987bffdd636Sdrh             return target;
3988bffdd636Sdrh           }else{
39899942ef0dSdrh             return iSrc;
3990bffdd636Sdrh           }
3991c4a3c779Sdrh         }else{
39921f9ca2c8Sdrh           /* Coding an expression that is part of an index where column names
39931f9ca2c8Sdrh           ** in the index refer to the table to which the index belongs */
39943e34eabcSdrh           iTab = pParse->iSelfTab - 1;
39952282792aSdrh         }
3996b2b9d3d7Sdrh       }
399767b9ba17Sdrh       iReg = sqlite3ExprCodeGetColumn(pParse, pExpr->y.pTab,
3998b2b9d3d7Sdrh                                pExpr->iColumn, iTab, target,
3999b2b9d3d7Sdrh                                pExpr->op2);
400067b9ba17Sdrh       if( pExpr->y.pTab==0 && pExpr->affExpr==SQLITE_AFF_REAL ){
400167b9ba17Sdrh         sqlite3VdbeAddOp1(v, OP_RealAffinity, iReg);
400267b9ba17Sdrh       }
400367b9ba17Sdrh       return iReg;
4004cce7d176Sdrh     }
4005cce7d176Sdrh     case TK_INTEGER: {
400613573c71Sdrh       codeInteger(pParse, pExpr, 0, target);
4007c332cc30Sdrh       return target;
400851e9a445Sdrh     }
40098abed7b9Sdrh     case TK_TRUEFALSE: {
401096acafbeSdrh       sqlite3VdbeAddOp2(v, OP_Integer, sqlite3ExprTruthValue(pExpr), target);
4011007c843bSdrh       return target;
4012007c843bSdrh     }
401313573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
4014598f1340Sdrh     case TK_FLOAT: {
401533e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
401633e619fcSdrh       codeReal(v, pExpr->u.zToken, 0, target);
4017c332cc30Sdrh       return target;
4018598f1340Sdrh     }
401913573c71Sdrh #endif
4020fec19aadSdrh     case TK_STRING: {
402133e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
4022076e85f5Sdrh       sqlite3VdbeLoadString(v, target, pExpr->u.zToken);
4023c332cc30Sdrh       return target;
4024cce7d176Sdrh     }
4025aac30f9bSdrh     default: {
4026c29af653Sdrh       /* Make NULL the default case so that if a bug causes an illegal
4027c29af653Sdrh       ** Expr node to be passed into this function, it will be handled
40289524a7eaSdrh       ** sanely and not crash.  But keep the assert() to bring the problem
40299524a7eaSdrh       ** to the attention of the developers. */
4030f817189eSdrh       assert( op==TK_NULL || pParse->db->mallocFailed );
40319de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
4032c332cc30Sdrh       return target;
4033f0863fe5Sdrh     }
40345338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_BLOB_LITERAL
4035c572ef7fSdanielk1977     case TK_BLOB: {
40366c8c6cecSdrh       int n;
40376c8c6cecSdrh       const char *z;
4038ca48c90fSdrh       char *zBlob;
403933e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
404033e619fcSdrh       assert( pExpr->u.zToken[0]=='x' || pExpr->u.zToken[0]=='X' );
404133e619fcSdrh       assert( pExpr->u.zToken[1]=='\'' );
404233e619fcSdrh       z = &pExpr->u.zToken[2];
4043b7916a78Sdrh       n = sqlite3Strlen30(z) - 1;
4044b7916a78Sdrh       assert( z[n]=='\'' );
4045ca48c90fSdrh       zBlob = sqlite3HexToBlob(sqlite3VdbeDb(v), z, n);
4046ca48c90fSdrh       sqlite3VdbeAddOp4(v, OP_Blob, n/2, target, 0, zBlob, P4_DYNAMIC);
4047c332cc30Sdrh       return target;
4048c572ef7fSdanielk1977     }
40495338a5f7Sdanielk1977 #endif
405050457896Sdrh     case TK_VARIABLE: {
405133e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
405233e619fcSdrh       assert( pExpr->u.zToken!=0 );
405333e619fcSdrh       assert( pExpr->u.zToken[0]!=0 );
4054eaf52d88Sdrh       sqlite3VdbeAddOp2(v, OP_Variable, pExpr->iColumn, target);
405533e619fcSdrh       if( pExpr->u.zToken[1]!=0 ){
40569bf755ccSdrh         const char *z = sqlite3VListNumToName(pParse->pVList, pExpr->iColumn);
40579524a7eaSdrh         assert( pExpr->u.zToken[0]=='?' || (z && !strcmp(pExpr->u.zToken, z)) );
4058ce1bbe51Sdrh         pParse->pVList[0] = 0; /* Indicate VList may no longer be enlarged */
40599bf755ccSdrh         sqlite3VdbeAppendP4(v, (char*)z, P4_STATIC);
40609bf755ccSdrh       }
4061c332cc30Sdrh       return target;
406250457896Sdrh     }
40634e0cff60Sdrh     case TK_REGISTER: {
4064c332cc30Sdrh       return pExpr->iTable;
40654e0cff60Sdrh     }
4066487e262fSdrh #ifndef SQLITE_OMIT_CAST
4067487e262fSdrh     case TK_CAST: {
4068487e262fSdrh       /* Expressions of the form:   CAST(pLeft AS token) */
40692dcef11bSdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
40701735fa88Sdrh       if( inReg!=target ){
40711735fa88Sdrh         sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
40721735fa88Sdrh         inReg = target;
40731735fa88Sdrh       }
40744169e430Sdrh       sqlite3VdbeAddOp2(v, OP_Cast, target,
40754169e430Sdrh                         sqlite3AffinityType(pExpr->u.zToken, 0));
4076c332cc30Sdrh       return inReg;
4077487e262fSdrh     }
4078487e262fSdrh #endif /* SQLITE_OMIT_CAST */
407971c57db0Sdan     case TK_IS:
408071c57db0Sdan     case TK_ISNOT:
408171c57db0Sdan       op = (op==TK_IS) ? TK_EQ : TK_NE;
408271c57db0Sdan       p5 = SQLITE_NULLEQ;
408371c57db0Sdan       /* fall-through */
4084c9b84a1fSdrh     case TK_LT:
4085c9b84a1fSdrh     case TK_LE:
4086c9b84a1fSdrh     case TK_GT:
4087c9b84a1fSdrh     case TK_GE:
4088c9b84a1fSdrh     case TK_NE:
4089c9b84a1fSdrh     case TK_EQ: {
409071c57db0Sdan       Expr *pLeft = pExpr->pLeft;
4091625015e0Sdan       if( sqlite3ExprIsVector(pLeft) ){
409279752b6eSdrh         codeVectorCompare(pParse, pExpr, target, op, p5);
409371c57db0Sdan       }else{
409471c57db0Sdan         r1 = sqlite3ExprCodeTemp(pParse, pLeft, &regFree1);
4095b6da74ebSdrh         r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
4096871e7ff4Sdrh         sqlite3VdbeAddOp2(v, OP_Integer, 1, inReg);
4097871e7ff4Sdrh         codeCompare(pParse, pLeft, pExpr->pRight, op, r1, r2,
4098871e7ff4Sdrh             sqlite3VdbeCurrentAddr(v)+2, p5,
4099898c527eSdrh             ExprHasProperty(pExpr,EP_Commuted));
41007d176105Sdrh         assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
41017d176105Sdrh         assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
41027d176105Sdrh         assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
41037d176105Sdrh         assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
41047d176105Sdrh         assert(TK_EQ==OP_Eq); testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
41057d176105Sdrh         assert(TK_NE==OP_Ne); testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
4106529df929Sdrh         if( p5==SQLITE_NULLEQ ){
4107529df929Sdrh           sqlite3VdbeAddOp2(v, OP_Integer, 0, inReg);
4108529df929Sdrh         }else{
4109529df929Sdrh           sqlite3VdbeAddOp3(v, OP_ZeroOrNull, r1, inReg, r2);
4110529df929Sdrh         }
4111c5499befSdrh         testcase( regFree1==0 );
4112c5499befSdrh         testcase( regFree2==0 );
4113c9b84a1fSdrh       }
41146a2fe093Sdrh       break;
41156a2fe093Sdrh     }
4116cce7d176Sdrh     case TK_AND:
4117cce7d176Sdrh     case TK_OR:
4118cce7d176Sdrh     case TK_PLUS:
4119cce7d176Sdrh     case TK_STAR:
4120cce7d176Sdrh     case TK_MINUS:
4121bf4133cbSdrh     case TK_REM:
4122bf4133cbSdrh     case TK_BITAND:
4123bf4133cbSdrh     case TK_BITOR:
412417c40294Sdrh     case TK_SLASH:
4125bf4133cbSdrh     case TK_LSHIFT:
4126855eb1cfSdrh     case TK_RSHIFT:
41270040077dSdrh     case TK_CONCAT: {
41287d176105Sdrh       assert( TK_AND==OP_And );            testcase( op==TK_AND );
41297d176105Sdrh       assert( TK_OR==OP_Or );              testcase( op==TK_OR );
41307d176105Sdrh       assert( TK_PLUS==OP_Add );           testcase( op==TK_PLUS );
41317d176105Sdrh       assert( TK_MINUS==OP_Subtract );     testcase( op==TK_MINUS );
41327d176105Sdrh       assert( TK_REM==OP_Remainder );      testcase( op==TK_REM );
41337d176105Sdrh       assert( TK_BITAND==OP_BitAnd );      testcase( op==TK_BITAND );
41347d176105Sdrh       assert( TK_BITOR==OP_BitOr );        testcase( op==TK_BITOR );
41357d176105Sdrh       assert( TK_SLASH==OP_Divide );       testcase( op==TK_SLASH );
41367d176105Sdrh       assert( TK_LSHIFT==OP_ShiftLeft );   testcase( op==TK_LSHIFT );
41377d176105Sdrh       assert( TK_RSHIFT==OP_ShiftRight );  testcase( op==TK_RSHIFT );
41387d176105Sdrh       assert( TK_CONCAT==OP_Concat );      testcase( op==TK_CONCAT );
41392dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
41402dcef11bSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
41415b6afba9Sdrh       sqlite3VdbeAddOp3(v, op, r2, r1, target);
4142c5499befSdrh       testcase( regFree1==0 );
4143c5499befSdrh       testcase( regFree2==0 );
41440040077dSdrh       break;
41450040077dSdrh     }
4146cce7d176Sdrh     case TK_UMINUS: {
4147fec19aadSdrh       Expr *pLeft = pExpr->pLeft;
4148fec19aadSdrh       assert( pLeft );
414913573c71Sdrh       if( pLeft->op==TK_INTEGER ){
415013573c71Sdrh         codeInteger(pParse, pLeft, 1, target);
4151c332cc30Sdrh         return target;
415213573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
415313573c71Sdrh       }else if( pLeft->op==TK_FLOAT ){
415433e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
415533e619fcSdrh         codeReal(v, pLeft->u.zToken, 1, target);
4156c332cc30Sdrh         return target;
415713573c71Sdrh #endif
41583c84ddffSdrh       }else{
415910d1edf0Sdrh         tempX.op = TK_INTEGER;
416010d1edf0Sdrh         tempX.flags = EP_IntValue|EP_TokenOnly;
416110d1edf0Sdrh         tempX.u.iValue = 0;
4162e7375bfaSdrh         ExprClearVVAProperties(&tempX);
416310d1edf0Sdrh         r1 = sqlite3ExprCodeTemp(pParse, &tempX, &regFree1);
4164e55cbd72Sdrh         r2 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree2);
41652dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_Subtract, r2, r1, target);
4166c5499befSdrh         testcase( regFree2==0 );
41673c84ddffSdrh       }
41686e142f54Sdrh       break;
41696e142f54Sdrh     }
4170bf4133cbSdrh     case TK_BITNOT:
41716e142f54Sdrh     case TK_NOT: {
41727d176105Sdrh       assert( TK_BITNOT==OP_BitNot );   testcase( op==TK_BITNOT );
41737d176105Sdrh       assert( TK_NOT==OP_Not );         testcase( op==TK_NOT );
4174e99fa2afSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4175e99fa2afSdrh       testcase( regFree1==0 );
4176e99fa2afSdrh       sqlite3VdbeAddOp2(v, op, r1, inReg);
4177cce7d176Sdrh       break;
4178cce7d176Sdrh     }
41798abed7b9Sdrh     case TK_TRUTH: {
418096acafbeSdrh       int isTrue;    /* IS TRUE or IS NOT TRUE */
418196acafbeSdrh       int bNormal;   /* IS TRUE or IS FALSE */
4182007c843bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4183007c843bSdrh       testcase( regFree1==0 );
418496acafbeSdrh       isTrue = sqlite3ExprTruthValue(pExpr->pRight);
418596acafbeSdrh       bNormal = pExpr->op2==TK_IS;
418696acafbeSdrh       testcase( isTrue && bNormal);
418796acafbeSdrh       testcase( !isTrue && bNormal);
418896acafbeSdrh       sqlite3VdbeAddOp4Int(v, OP_IsTrue, r1, inReg, !isTrue, isTrue ^ bNormal);
4189007c843bSdrh       break;
4190007c843bSdrh     }
4191cce7d176Sdrh     case TK_ISNULL:
4192cce7d176Sdrh     case TK_NOTNULL: {
41936a288a33Sdrh       int addr;
41947d176105Sdrh       assert( TK_ISNULL==OP_IsNull );   testcase( op==TK_ISNULL );
41957d176105Sdrh       assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
41969de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
41972dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4198c5499befSdrh       testcase( regFree1==0 );
41992dcef11bSdrh       addr = sqlite3VdbeAddOp1(v, op, r1);
42007d176105Sdrh       VdbeCoverageIf(v, op==TK_ISNULL);
42017d176105Sdrh       VdbeCoverageIf(v, op==TK_NOTNULL);
4202a976979bSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 0, target);
42036a288a33Sdrh       sqlite3VdbeJumpHere(v, addr);
4204a37cdde0Sdanielk1977       break;
4205f2bc013cSdrh     }
42062282792aSdrh     case TK_AGG_FUNCTION: {
420713449892Sdrh       AggInfo *pInfo = pExpr->pAggInfo;
42080934d640Sdrh       if( pInfo==0
42090934d640Sdrh        || NEVER(pExpr->iAgg<0)
42100934d640Sdrh        || NEVER(pExpr->iAgg>=pInfo->nFunc)
42110934d640Sdrh       ){
421233e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
421333e619fcSdrh         sqlite3ErrorMsg(pParse, "misuse of aggregate: %s()", pExpr->u.zToken);
42147e56e711Sdrh       }else{
4215c332cc30Sdrh         return pInfo->aFunc[pExpr->iAgg].iMem;
42167e56e711Sdrh       }
42172282792aSdrh       break;
42182282792aSdrh     }
4219cce7d176Sdrh     case TK_FUNCTION: {
422012ffee8cSdrh       ExprList *pFarg;       /* List of function arguments */
422112ffee8cSdrh       int nFarg;             /* Number of function arguments */
422212ffee8cSdrh       FuncDef *pDef;         /* The function definition object */
422312ffee8cSdrh       const char *zId;       /* The function name */
4224693e6719Sdrh       u32 constMask = 0;     /* Mask of function arguments that are constant */
422512ffee8cSdrh       int i;                 /* Loop counter */
4226c332cc30Sdrh       sqlite3 *db = pParse->db;  /* The database connection */
422712ffee8cSdrh       u8 enc = ENC(db);      /* The text encoding used by this database */
422812ffee8cSdrh       CollSeq *pColl = 0;    /* A collating sequence */
422917435752Sdrh 
423067a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
4231eda079cdSdrh       if( ExprHasProperty(pExpr, EP_WinFunc) ){
4232eda079cdSdrh         return pExpr->y.pWin->regResult;
423386fb6e17Sdan       }
423467a9b8edSdan #endif
423586fb6e17Sdan 
42361e9b53f9Sdrh       if( ConstFactorOk(pParse) && sqlite3ExprIsConstantNotJoin(pExpr) ){
42379b258c54Sdrh         /* SQL functions can be expensive. So try to avoid running them
42389b258c54Sdrh         ** multiple times if we know they always give the same result */
42399b258c54Sdrh         return sqlite3ExprCodeRunJustOnce(pParse, pExpr, -1);
42401e9b53f9Sdrh       }
42416ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
4242e7375bfaSdrh       assert( !ExprHasProperty(pExpr, EP_TokenOnly) );
424312ffee8cSdrh       pFarg = pExpr->x.pList;
424412ffee8cSdrh       nFarg = pFarg ? pFarg->nExpr : 0;
424533e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
424633e619fcSdrh       zId = pExpr->u.zToken;
424780738d9cSdrh       pDef = sqlite3FindFunction(db, zId, nFarg, enc, 0);
4248cc15313cSdrh #ifdef SQLITE_ENABLE_UNKNOWN_SQL_FUNCTION
4249cc15313cSdrh       if( pDef==0 && pParse->explain ){
4250cc15313cSdrh         pDef = sqlite3FindFunction(db, "unknown", nFarg, enc, 0);
4251cc15313cSdrh       }
4252cc15313cSdrh #endif
4253b6e9f7a4Sdan       if( pDef==0 || pDef->xFinalize!=0 ){
425480738d9cSdrh         sqlite3ErrorMsg(pParse, "unknown function: %s()", zId);
4255feb306f5Sdrh         break;
4256feb306f5Sdrh       }
425725c4296bSdrh       if( pDef->funcFlags & SQLITE_FUNC_INLINE ){
42580dfa5255Sdrh         assert( (pDef->funcFlags & SQLITE_FUNC_UNSAFE)==0 );
42590dfa5255Sdrh         assert( (pDef->funcFlags & SQLITE_FUNC_DIRECT)==0 );
426025c4296bSdrh         return exprCodeInlineFunction(pParse, pFarg,
426125c4296bSdrh              SQLITE_PTR_TO_INT(pDef->pUserData), target);
42622eeca204Sdrh       }else if( pDef->funcFlags & (SQLITE_FUNC_DIRECT|SQLITE_FUNC_UNSAFE) ){
42630dfa5255Sdrh         sqlite3ExprFunctionUsable(pParse, pExpr, pDef);
4264ae6bb957Sdrh       }
4265a1a523a5Sdrh 
4266d1a01edaSdrh       for(i=0; i<nFarg; i++){
4267d1a01edaSdrh         if( i<32 && sqlite3ExprIsConstant(pFarg->a[i].pExpr) ){
4268693e6719Sdrh           testcase( i==31 );
4269693e6719Sdrh           constMask |= MASKBIT32(i);
4270d1a01edaSdrh         }
4271d1a01edaSdrh         if( (pDef->funcFlags & SQLITE_FUNC_NEEDCOLL)!=0 && !pColl ){
4272d1a01edaSdrh           pColl = sqlite3ExprCollSeq(pParse, pFarg->a[i].pExpr);
4273d1a01edaSdrh         }
4274d1a01edaSdrh       }
427512ffee8cSdrh       if( pFarg ){
4276d1a01edaSdrh         if( constMask ){
4277d1a01edaSdrh           r1 = pParse->nMem+1;
4278d1a01edaSdrh           pParse->nMem += nFarg;
4279d1a01edaSdrh         }else{
428012ffee8cSdrh           r1 = sqlite3GetTempRange(pParse, nFarg);
4281d1a01edaSdrh         }
4282a748fdccSdrh 
4283a748fdccSdrh         /* For length() and typeof() functions with a column argument,
4284a748fdccSdrh         ** set the P5 parameter to the OP_Column opcode to OPFLAG_LENGTHARG
4285a748fdccSdrh         ** or OPFLAG_TYPEOFARG respectively, to avoid unnecessary data
4286a748fdccSdrh         ** loading.
4287a748fdccSdrh         */
4288d36e1041Sdrh         if( (pDef->funcFlags & (SQLITE_FUNC_LENGTH|SQLITE_FUNC_TYPEOF))!=0 ){
42894e245a4cSdrh           u8 exprOp;
4290a748fdccSdrh           assert( nFarg==1 );
4291a748fdccSdrh           assert( pFarg->a[0].pExpr!=0 );
42924e245a4cSdrh           exprOp = pFarg->a[0].pExpr->op;
42934e245a4cSdrh           if( exprOp==TK_COLUMN || exprOp==TK_AGG_COLUMN ){
4294a748fdccSdrh             assert( SQLITE_FUNC_LENGTH==OPFLAG_LENGTHARG );
4295a748fdccSdrh             assert( SQLITE_FUNC_TYPEOF==OPFLAG_TYPEOFARG );
4296b1fba286Sdrh             testcase( pDef->funcFlags & OPFLAG_LENGTHARG );
4297b1fba286Sdrh             pFarg->a[0].pExpr->op2 =
4298b1fba286Sdrh                   pDef->funcFlags & (OPFLAG_LENGTHARG|OPFLAG_TYPEOFARG);
4299a748fdccSdrh           }
4300a748fdccSdrh         }
4301a748fdccSdrh 
43025579d59fSdrh         sqlite3ExprCodeExprList(pParse, pFarg, r1, 0,
4303d1a01edaSdrh                                 SQLITE_ECEL_DUP|SQLITE_ECEL_FACTOR);
4304892d3179Sdrh       }else{
430512ffee8cSdrh         r1 = 0;
4306892d3179Sdrh       }
4307b7f6f68fSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
4308a43fa227Sdrh       /* Possibly overload the function if the first argument is
4309a43fa227Sdrh       ** a virtual table column.
4310a43fa227Sdrh       **
4311a43fa227Sdrh       ** For infix functions (LIKE, GLOB, REGEXP, and MATCH) use the
4312a43fa227Sdrh       ** second argument, not the first, as the argument to test to
4313a43fa227Sdrh       ** see if it is a column in a virtual table.  This is done because
4314a43fa227Sdrh       ** the left operand of infix functions (the operand we want to
4315a43fa227Sdrh       ** control overloading) ends up as the second argument to the
4316a43fa227Sdrh       ** function.  The expression "A glob B" is equivalent to
4317a43fa227Sdrh       ** "glob(B,A).  We want to use the A in "A glob B" to test
4318a43fa227Sdrh       ** for function overloading.  But we use the B term in "glob(B,A)".
4319a43fa227Sdrh       */
432059155065Sdrh       if( nFarg>=2 && ExprHasProperty(pExpr, EP_InfixFunc) ){
432112ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[1].pExpr);
432212ffee8cSdrh       }else if( nFarg>0 ){
432312ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[0].pExpr);
4324b7f6f68fSdrh       }
4325b7f6f68fSdrh #endif
4326d36e1041Sdrh       if( pDef->funcFlags & SQLITE_FUNC_NEEDCOLL ){
43278b213899Sdrh         if( !pColl ) pColl = db->pDfltColl;
432866a5167bSdrh         sqlite3VdbeAddOp4(v, OP_CollSeq, 0, 0, 0, (char *)pColl, P4_COLLSEQ);
4329682f68b0Sdanielk1977       }
4330092457b1Sdrh #ifdef SQLITE_ENABLE_OFFSET_SQL_FUNC
4331092457b1Sdrh       if( pDef->funcFlags & SQLITE_FUNC_OFFSET ){
43322fc865c1Sdrh         Expr *pArg = pFarg->a[0].pExpr;
43332fc865c1Sdrh         if( pArg->op==TK_COLUMN ){
4334092457b1Sdrh           sqlite3VdbeAddOp3(v, OP_Offset, pArg->iTable, pArg->iColumn, target);
43352fc865c1Sdrh         }else{
43362fc865c1Sdrh           sqlite3VdbeAddOp2(v, OP_Null, 0, target);
43372fc865c1Sdrh         }
4338092457b1Sdrh       }else
4339092457b1Sdrh #endif
4340092457b1Sdrh       {
4341920cf596Sdrh         sqlite3VdbeAddFunctionCall(pParse, constMask, r1, target, nFarg,
434220cee7d0Sdrh                                    pDef, pExpr->op2);
43432fc865c1Sdrh       }
434413d79502Sdrh       if( nFarg ){
434513d79502Sdrh         if( constMask==0 ){
434612ffee8cSdrh           sqlite3ReleaseTempRange(pParse, r1, nFarg);
434713d79502Sdrh         }else{
43483aef2fb1Sdrh           sqlite3VdbeReleaseRegisters(pParse, r1, nFarg, constMask, 1);
434913d79502Sdrh         }
43502dcef11bSdrh       }
4351c332cc30Sdrh       return target;
43526ec2733bSdrh     }
4353fe2093d7Sdrh #ifndef SQLITE_OMIT_SUBQUERY
4354fe2093d7Sdrh     case TK_EXISTS:
435519a775c2Sdrh     case TK_SELECT: {
43568da209b1Sdan       int nCol;
4357c5499befSdrh       testcase( op==TK_EXISTS );
4358c5499befSdrh       testcase( op==TK_SELECT );
4359d8d335d7Sdrh       if( pParse->db->mallocFailed ){
4360d8d335d7Sdrh         return 0;
4361d8d335d7Sdrh       }else if( op==TK_SELECT && (nCol = pExpr->x.pSelect->pEList->nExpr)!=1 ){
43628da209b1Sdan         sqlite3SubselectError(pParse, nCol, 1);
43638da209b1Sdan       }else{
436485bcdce2Sdrh         return sqlite3CodeSubselect(pParse, pExpr);
43658da209b1Sdan       }
436619a775c2Sdrh       break;
436719a775c2Sdrh     }
4368fc7f27b9Sdrh     case TK_SELECT_COLUMN: {
4369966e2911Sdrh       int n;
4370fc7f27b9Sdrh       if( pExpr->pLeft->iTable==0 ){
437185bcdce2Sdrh         pExpr->pLeft->iTable = sqlite3CodeSubselect(pParse, pExpr->pLeft);
4372fc7f27b9Sdrh       }
4373966e2911Sdrh       assert( pExpr->iTable==0 || pExpr->pLeft->op==TK_SELECT );
4374554a9dc7Sdrh       if( pExpr->iTable!=0
4375966e2911Sdrh        && pExpr->iTable!=(n = sqlite3ExprVectorSize(pExpr->pLeft))
4376966e2911Sdrh       ){
4377966e2911Sdrh         sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
4378966e2911Sdrh                                 pExpr->iTable, n);
4379966e2911Sdrh       }
4380c332cc30Sdrh       return pExpr->pLeft->iTable + pExpr->iColumn;
4381fc7f27b9Sdrh     }
4382fef5208cSdrh     case TK_IN: {
4383ec4ccdbcSdrh       int destIfFalse = sqlite3VdbeMakeLabel(pParse);
4384ec4ccdbcSdrh       int destIfNull = sqlite3VdbeMakeLabel(pParse);
4385e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
4386e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
438766ba23ceSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
4388e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
4389e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_AddImm, target, 0);
4390e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfNull);
4391c332cc30Sdrh       return target;
4392fef5208cSdrh     }
4393e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
4394e3365e6cSdrh 
4395e3365e6cSdrh 
43962dcef11bSdrh     /*
43972dcef11bSdrh     **    x BETWEEN y AND z
43982dcef11bSdrh     **
43992dcef11bSdrh     ** This is equivalent to
44002dcef11bSdrh     **
44012dcef11bSdrh     **    x>=y AND x<=z
44022dcef11bSdrh     **
44032dcef11bSdrh     ** X is stored in pExpr->pLeft.
44042dcef11bSdrh     ** Y is stored in pExpr->pList->a[0].pExpr.
44052dcef11bSdrh     ** Z is stored in pExpr->pList->a[1].pExpr.
44062dcef11bSdrh     */
4407fef5208cSdrh     case TK_BETWEEN: {
440871c57db0Sdan       exprCodeBetween(pParse, pExpr, target, 0, 0);
4409c332cc30Sdrh       return target;
4410fef5208cSdrh     }
441194fa9c41Sdrh     case TK_SPAN:
4412ae80ddeaSdrh     case TK_COLLATE:
44134f07e5fbSdrh     case TK_UPLUS: {
44141efa8023Sdrh       pExpr = pExpr->pLeft;
441559ee43a7Sdrh       goto expr_code_doover; /* 2018-04-28: Prevent deep recursion. OSSFuzz. */
4416a2e00042Sdrh     }
44172dcef11bSdrh 
4418165921a7Sdan     case TK_TRIGGER: {
441965a7cd16Sdan       /* If the opcode is TK_TRIGGER, then the expression is a reference
442065a7cd16Sdan       ** to a column in the new.* or old.* pseudo-tables available to
442165a7cd16Sdan       ** trigger programs. In this case Expr.iTable is set to 1 for the
442265a7cd16Sdan       ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
442365a7cd16Sdan       ** is set to the column of the pseudo-table to read, or to -1 to
442465a7cd16Sdan       ** read the rowid field.
442565a7cd16Sdan       **
442665a7cd16Sdan       ** The expression is implemented using an OP_Param opcode. The p1
442765a7cd16Sdan       ** parameter is set to 0 for an old.rowid reference, or to (i+1)
442865a7cd16Sdan       ** to reference another column of the old.* pseudo-table, where
442965a7cd16Sdan       ** i is the index of the column. For a new.rowid reference, p1 is
443065a7cd16Sdan       ** set to (n+1), where n is the number of columns in each pseudo-table.
443165a7cd16Sdan       ** For a reference to any other column in the new.* pseudo-table, p1
443265a7cd16Sdan       ** is set to (n+2+i), where n and i are as defined previously. For
443365a7cd16Sdan       ** example, if the table on which triggers are being fired is
443465a7cd16Sdan       ** declared as:
443565a7cd16Sdan       **
443665a7cd16Sdan       **   CREATE TABLE t1(a, b);
443765a7cd16Sdan       **
443865a7cd16Sdan       ** Then p1 is interpreted as follows:
443965a7cd16Sdan       **
444065a7cd16Sdan       **   p1==0   ->    old.rowid     p1==3   ->    new.rowid
444165a7cd16Sdan       **   p1==1   ->    old.a         p1==4   ->    new.a
444265a7cd16Sdan       **   p1==2   ->    old.b         p1==5   ->    new.b
444365a7cd16Sdan       */
4444eda079cdSdrh       Table *pTab = pExpr->y.pTab;
4445dd6cc9b5Sdrh       int iCol = pExpr->iColumn;
4446dd6cc9b5Sdrh       int p1 = pExpr->iTable * (pTab->nCol+1) + 1
44477fe2fc0dSdrh                      + sqlite3TableColumnToStorage(pTab, iCol);
444865a7cd16Sdan 
444965a7cd16Sdan       assert( pExpr->iTable==0 || pExpr->iTable==1 );
4450dd6cc9b5Sdrh       assert( iCol>=-1 && iCol<pTab->nCol );
4451dd6cc9b5Sdrh       assert( pTab->iPKey<0 || iCol!=pTab->iPKey );
445265a7cd16Sdan       assert( p1>=0 && p1<(pTab->nCol*2+2) );
445365a7cd16Sdan 
445465a7cd16Sdan       sqlite3VdbeAddOp2(v, OP_Param, p1, target);
4455896494e8Sdrh       VdbeComment((v, "r[%d]=%s.%s", target,
4456165921a7Sdan         (pExpr->iTable ? "new" : "old"),
4457dd6cc9b5Sdrh         (pExpr->iColumn<0 ? "rowid" : pExpr->y.pTab->aCol[iCol].zName)
4458165921a7Sdan       ));
445965a7cd16Sdan 
446044dbca83Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
446165a7cd16Sdan       /* If the column has REAL affinity, it may currently be stored as an
4462113762a2Sdrh       ** integer. Use OP_RealAffinity to make sure it is really real.
4463113762a2Sdrh       **
4464113762a2Sdrh       ** EVIDENCE-OF: R-60985-57662 SQLite will convert the value back to
4465113762a2Sdrh       ** floating point when extracting it from the record.  */
4466dd6cc9b5Sdrh       if( iCol>=0 && pTab->aCol[iCol].affinity==SQLITE_AFF_REAL ){
44672832ad42Sdan         sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
44682832ad42Sdan       }
446944dbca83Sdrh #endif
4470165921a7Sdan       break;
4471165921a7Sdan     }
4472165921a7Sdan 
447371c57db0Sdan     case TK_VECTOR: {
4474e835bc12Sdrh       sqlite3ErrorMsg(pParse, "row value misused");
447571c57db0Sdan       break;
447671c57db0Sdan     }
447771c57db0Sdan 
44789e9a67adSdrh     /* TK_IF_NULL_ROW Expr nodes are inserted ahead of expressions
44799e9a67adSdrh     ** that derive from the right-hand table of a LEFT JOIN.  The
44809e9a67adSdrh     ** Expr.iTable value is the table number for the right-hand table.
44819e9a67adSdrh     ** The expression is only evaluated if that table is not currently
44829e9a67adSdrh     ** on a LEFT JOIN NULL row.
44839e9a67adSdrh     */
448431d6fd55Sdrh     case TK_IF_NULL_ROW: {
448531d6fd55Sdrh       int addrINR;
44869e9a67adSdrh       u8 okConstFactor = pParse->okConstFactor;
448731d6fd55Sdrh       addrINR = sqlite3VdbeAddOp1(v, OP_IfNullRow, pExpr->iTable);
44889e9a67adSdrh       /* Temporarily disable factoring of constant expressions, since
44899e9a67adSdrh       ** even though expressions may appear to be constant, they are not
44909e9a67adSdrh       ** really constant because they originate from the right-hand side
44919e9a67adSdrh       ** of a LEFT JOIN. */
44929e9a67adSdrh       pParse->okConstFactor = 0;
449331d6fd55Sdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
44949e9a67adSdrh       pParse->okConstFactor = okConstFactor;
449531d6fd55Sdrh       sqlite3VdbeJumpHere(v, addrINR);
449631d6fd55Sdrh       sqlite3VdbeChangeP3(v, addrINR, inReg);
449731d6fd55Sdrh       break;
449831d6fd55Sdrh     }
449931d6fd55Sdrh 
45002dcef11bSdrh     /*
45012dcef11bSdrh     ** Form A:
45022dcef11bSdrh     **   CASE x WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
45032dcef11bSdrh     **
45042dcef11bSdrh     ** Form B:
45052dcef11bSdrh     **   CASE WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
45062dcef11bSdrh     **
45072dcef11bSdrh     ** Form A is can be transformed into the equivalent form B as follows:
45082dcef11bSdrh     **   CASE WHEN x=e1 THEN r1 WHEN x=e2 THEN r2 ...
45092dcef11bSdrh     **        WHEN x=eN THEN rN ELSE y END
45102dcef11bSdrh     **
45112dcef11bSdrh     ** X (if it exists) is in pExpr->pLeft.
4512c5cd1249Sdrh     ** Y is in the last element of pExpr->x.pList if pExpr->x.pList->nExpr is
4513c5cd1249Sdrh     ** odd.  The Y is also optional.  If the number of elements in x.pList
4514c5cd1249Sdrh     ** is even, then Y is omitted and the "otherwise" result is NULL.
45152dcef11bSdrh     ** Ei is in pExpr->pList->a[i*2] and Ri is pExpr->pList->a[i*2+1].
45162dcef11bSdrh     **
45172dcef11bSdrh     ** The result of the expression is the Ri for the first matching Ei,
45182dcef11bSdrh     ** or if there is no matching Ei, the ELSE term Y, or if there is
45192dcef11bSdrh     ** no ELSE term, NULL.
45202dcef11bSdrh     */
4521aac30f9bSdrh     case TK_CASE: {
45222dcef11bSdrh       int endLabel;                     /* GOTO label for end of CASE stmt */
45232dcef11bSdrh       int nextCase;                     /* GOTO label for next WHEN clause */
45242dcef11bSdrh       int nExpr;                        /* 2x number of WHEN terms */
45252dcef11bSdrh       int i;                            /* Loop counter */
45262dcef11bSdrh       ExprList *pEList;                 /* List of WHEN terms */
45272dcef11bSdrh       struct ExprList_item *aListelem;  /* Array of WHEN terms */
45282dcef11bSdrh       Expr opCompare;                   /* The X==Ei expression */
45292dcef11bSdrh       Expr *pX;                         /* The X expression */
45301bd10f8aSdrh       Expr *pTest = 0;                  /* X==Ei (form A) or just Ei (form B) */
45318b65e591Sdan       Expr *pDel = 0;
45328b65e591Sdan       sqlite3 *db = pParse->db;
453317a7f8ddSdrh 
45346ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) && pExpr->x.pList );
45356ab3a2ecSdanielk1977       assert(pExpr->x.pList->nExpr > 0);
45366ab3a2ecSdanielk1977       pEList = pExpr->x.pList;
4537be5c89acSdrh       aListelem = pEList->a;
4538be5c89acSdrh       nExpr = pEList->nExpr;
4539ec4ccdbcSdrh       endLabel = sqlite3VdbeMakeLabel(pParse);
45402dcef11bSdrh       if( (pX = pExpr->pLeft)!=0 ){
45418b65e591Sdan         pDel = sqlite3ExprDup(db, pX, 0);
45428b65e591Sdan         if( db->mallocFailed ){
45438b65e591Sdan           sqlite3ExprDelete(db, pDel);
45448b65e591Sdan           break;
45458b65e591Sdan         }
454633cd4909Sdrh         testcase( pX->op==TK_COLUMN );
45478b65e591Sdan         exprToRegister(pDel, exprCodeVector(pParse, pDel, &regFree1));
4548c5499befSdrh         testcase( regFree1==0 );
4549abb9d5f1Sdrh         memset(&opCompare, 0, sizeof(opCompare));
45502dcef11bSdrh         opCompare.op = TK_EQ;
45518b65e591Sdan         opCompare.pLeft = pDel;
45522dcef11bSdrh         pTest = &opCompare;
45538b1db07fSdrh         /* Ticket b351d95f9cd5ef17e9d9dbae18f5ca8611190001:
45548b1db07fSdrh         ** The value in regFree1 might get SCopy-ed into the file result.
45558b1db07fSdrh         ** So make sure that the regFree1 register is not reused for other
45568b1db07fSdrh         ** purposes and possibly overwritten.  */
45578b1db07fSdrh         regFree1 = 0;
4558cce7d176Sdrh       }
4559c5cd1249Sdrh       for(i=0; i<nExpr-1; i=i+2){
45602dcef11bSdrh         if( pX ){
45611bd10f8aSdrh           assert( pTest!=0 );
45622dcef11bSdrh           opCompare.pRight = aListelem[i].pExpr;
4563f5905aa7Sdrh         }else{
45642dcef11bSdrh           pTest = aListelem[i].pExpr;
456517a7f8ddSdrh         }
4566ec4ccdbcSdrh         nextCase = sqlite3VdbeMakeLabel(pParse);
456733cd4909Sdrh         testcase( pTest->op==TK_COLUMN );
45682dcef11bSdrh         sqlite3ExprIfFalse(pParse, pTest, nextCase, SQLITE_JUMPIFNULL);
4569c5499befSdrh         testcase( aListelem[i+1].pExpr->op==TK_COLUMN );
45709de221dfSdrh         sqlite3ExprCode(pParse, aListelem[i+1].pExpr, target);
4571076e85f5Sdrh         sqlite3VdbeGoto(v, endLabel);
45722dcef11bSdrh         sqlite3VdbeResolveLabel(v, nextCase);
4573f570f011Sdrh       }
4574c5cd1249Sdrh       if( (nExpr&1)!=0 ){
4575c5cd1249Sdrh         sqlite3ExprCode(pParse, pEList->a[nExpr-1].pExpr, target);
457617a7f8ddSdrh       }else{
45779de221dfSdrh         sqlite3VdbeAddOp2(v, OP_Null, 0, target);
457817a7f8ddSdrh       }
45798b65e591Sdan       sqlite3ExprDelete(db, pDel);
458092a27f7bSdrh       setDoNotMergeFlagOnCopy(v);
45812dcef11bSdrh       sqlite3VdbeResolveLabel(v, endLabel);
45826f34903eSdanielk1977       break;
45836f34903eSdanielk1977     }
45845338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_TRIGGER
45856f34903eSdanielk1977     case TK_RAISE: {
45861194904bSdrh       assert( pExpr->affExpr==OE_Rollback
45871194904bSdrh            || pExpr->affExpr==OE_Abort
45881194904bSdrh            || pExpr->affExpr==OE_Fail
45891194904bSdrh            || pExpr->affExpr==OE_Ignore
4590165921a7Sdan       );
45919e5fdc41Sdrh       if( !pParse->pTriggerTab && !pParse->nested ){
4592e0af83acSdan         sqlite3ErrorMsg(pParse,
4593e0af83acSdan                        "RAISE() may only be used within a trigger-program");
4594e0af83acSdan         return 0;
4595e0af83acSdan       }
45961194904bSdrh       if( pExpr->affExpr==OE_Abort ){
4597e0af83acSdan         sqlite3MayAbort(pParse);
4598e0af83acSdan       }
459933e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
46001194904bSdrh       if( pExpr->affExpr==OE_Ignore ){
4601e0af83acSdan         sqlite3VdbeAddOp4(
4602e0af83acSdan             v, OP_Halt, SQLITE_OK, OE_Ignore, 0, pExpr->u.zToken,0);
4603688852abSdrh         VdbeCoverage(v);
4604e0af83acSdan       }else{
46059e5fdc41Sdrh         sqlite3HaltConstraint(pParse,
46069e5fdc41Sdrh              pParse->pTriggerTab ? SQLITE_CONSTRAINT_TRIGGER : SQLITE_ERROR,
46071194904bSdrh              pExpr->affExpr, pExpr->u.zToken, 0, 0);
4608e0af83acSdan       }
4609e0af83acSdan 
4610ffe07b2dSdrh       break;
461117a7f8ddSdrh     }
46125338a5f7Sdanielk1977 #endif
4613ffe07b2dSdrh   }
46142dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
46152dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
46162dcef11bSdrh   return inReg;
46175b6afba9Sdrh }
46182dcef11bSdrh 
46192dcef11bSdrh /*
46209b258c54Sdrh ** Generate code that will evaluate expression pExpr just one time
46219b258c54Sdrh ** per prepared statement execution.
46229b258c54Sdrh **
46239b258c54Sdrh ** If the expression uses functions (that might throw an exception) then
46249b258c54Sdrh ** guard them with an OP_Once opcode to ensure that the code is only executed
46259b258c54Sdrh ** once. If no functions are involved, then factor the code out and put it at
46269b258c54Sdrh ** the end of the prepared statement in the initialization section.
46271e9b53f9Sdrh **
4628ad879ffdSdrh ** If regDest>=0 then the result is always stored in that register and the
4629ad879ffdSdrh ** result is not reusable.  If regDest<0 then this routine is free to
4630ad879ffdSdrh ** store the value whereever it wants.  The register where the expression
46319b258c54Sdrh ** is stored is returned.  When regDest<0, two identical expressions might
46329b258c54Sdrh ** code to the same register, if they do not contain function calls and hence
46339b258c54Sdrh ** are factored out into the initialization section at the end of the
46349b258c54Sdrh ** prepared statement.
4635d1a01edaSdrh */
46369b258c54Sdrh int sqlite3ExprCodeRunJustOnce(
4637d673cddaSdrh   Parse *pParse,    /* Parsing context */
4638d673cddaSdrh   Expr *pExpr,      /* The expression to code when the VDBE initializes */
4639ad879ffdSdrh   int regDest       /* Store the value in this register */
4640d673cddaSdrh ){
4641d1a01edaSdrh   ExprList *p;
4642d9f158e7Sdrh   assert( ConstFactorOk(pParse) );
4643d1a01edaSdrh   p = pParse->pConstExpr;
4644ad879ffdSdrh   if( regDest<0 && p ){
46451e9b53f9Sdrh     struct ExprList_item *pItem;
46461e9b53f9Sdrh     int i;
46471e9b53f9Sdrh     for(pItem=p->a, i=p->nExpr; i>0; pItem++, i--){
46485aa550cfSdan       if( pItem->reusable && sqlite3ExprCompare(0,pItem->pExpr,pExpr,-1)==0 ){
46491e9b53f9Sdrh         return pItem->u.iConstExprReg;
46501e9b53f9Sdrh       }
46511e9b53f9Sdrh     }
46521e9b53f9Sdrh   }
4653d1a01edaSdrh   pExpr = sqlite3ExprDup(pParse->db, pExpr, 0);
465438dfbdaeSdrh   if( pExpr!=0 && ExprHasProperty(pExpr, EP_HasFunc) ){
465538dfbdaeSdrh     Vdbe *v = pParse->pVdbe;
465638dfbdaeSdrh     int addr;
465738dfbdaeSdrh     assert( v );
465838dfbdaeSdrh     addr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
465938dfbdaeSdrh     pParse->okConstFactor = 0;
466038dfbdaeSdrh     if( !pParse->db->mallocFailed ){
46619b258c54Sdrh       if( regDest<0 ) regDest = ++pParse->nMem;
466238dfbdaeSdrh       sqlite3ExprCode(pParse, pExpr, regDest);
466338dfbdaeSdrh     }
466438dfbdaeSdrh     pParse->okConstFactor = 1;
466538dfbdaeSdrh     sqlite3ExprDelete(pParse->db, pExpr);
466638dfbdaeSdrh     sqlite3VdbeJumpHere(v, addr);
466738dfbdaeSdrh   }else{
4668d1a01edaSdrh     p = sqlite3ExprListAppend(pParse, p, pExpr);
4669d673cddaSdrh     if( p ){
4670d673cddaSdrh        struct ExprList_item *pItem = &p->a[p->nExpr-1];
4671ad879ffdSdrh        pItem->reusable = regDest<0;
46729b258c54Sdrh        if( regDest<0 ) regDest = ++pParse->nMem;
4673d673cddaSdrh        pItem->u.iConstExprReg = regDest;
4674d673cddaSdrh     }
4675d1a01edaSdrh     pParse->pConstExpr = p;
467638dfbdaeSdrh   }
46771e9b53f9Sdrh   return regDest;
4678d1a01edaSdrh }
4679d1a01edaSdrh 
4680d1a01edaSdrh /*
46812dcef11bSdrh ** Generate code to evaluate an expression and store the results
46822dcef11bSdrh ** into a register.  Return the register number where the results
46832dcef11bSdrh ** are stored.
46842dcef11bSdrh **
46852dcef11bSdrh ** If the register is a temporary register that can be deallocated,
4686678ccce8Sdrh ** then write its number into *pReg.  If the result register is not
46872dcef11bSdrh ** a temporary, then set *pReg to zero.
4688f30a969bSdrh **
4689f30a969bSdrh ** If pExpr is a constant, then this routine might generate this
4690f30a969bSdrh ** code to fill the register in the initialization section of the
4691f30a969bSdrh ** VDBE program, in order to factor it out of the evaluation loop.
46922dcef11bSdrh */
46932dcef11bSdrh int sqlite3ExprCodeTemp(Parse *pParse, Expr *pExpr, int *pReg){
4694f30a969bSdrh   int r2;
46950d950af3Sdrh   pExpr = sqlite3ExprSkipCollateAndLikely(pExpr);
4696d9f158e7Sdrh   if( ConstFactorOk(pParse)
4697235667a8Sdrh    && ALWAYS(pExpr!=0)
4698f30a969bSdrh    && pExpr->op!=TK_REGISTER
4699f30a969bSdrh    && sqlite3ExprIsConstantNotJoin(pExpr)
4700f30a969bSdrh   ){
4701f30a969bSdrh     *pReg  = 0;
47029b258c54Sdrh     r2 = sqlite3ExprCodeRunJustOnce(pParse, pExpr, -1);
4703f30a969bSdrh   }else{
47042dcef11bSdrh     int r1 = sqlite3GetTempReg(pParse);
4705f30a969bSdrh     r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
47062dcef11bSdrh     if( r2==r1 ){
47072dcef11bSdrh       *pReg = r1;
47082dcef11bSdrh     }else{
47092dcef11bSdrh       sqlite3ReleaseTempReg(pParse, r1);
47102dcef11bSdrh       *pReg = 0;
47112dcef11bSdrh     }
4712f30a969bSdrh   }
47132dcef11bSdrh   return r2;
47142dcef11bSdrh }
47152dcef11bSdrh 
47162dcef11bSdrh /*
47172dcef11bSdrh ** Generate code that will evaluate expression pExpr and store the
47182dcef11bSdrh ** results in register target.  The results are guaranteed to appear
47192dcef11bSdrh ** in register target.
47202dcef11bSdrh */
472105a86c5cSdrh void sqlite3ExprCode(Parse *pParse, Expr *pExpr, int target){
47229cbf3425Sdrh   int inReg;
47239cbf3425Sdrh 
4724e7375bfaSdrh   assert( pExpr==0 || !ExprHasVVAProperty(pExpr,EP_Immutable) );
47259cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
47261c75c9d7Sdrh   assert( pParse->pVdbe!=0 || pParse->db->mallocFailed );
4727b639a209Sdrh   if( pParse->pVdbe==0 ) return;
4728b639a209Sdrh   inReg = sqlite3ExprCodeTarget(pParse, pExpr, target);
4729b639a209Sdrh   if( inReg!=target ){
4730629b88c6Sdrh     u8 op;
4731629b88c6Sdrh     if( ExprHasProperty(pExpr,EP_Subquery) ){
4732629b88c6Sdrh       op = OP_Copy;
4733629b88c6Sdrh     }else{
4734629b88c6Sdrh       op = OP_SCopy;
4735629b88c6Sdrh     }
4736629b88c6Sdrh     sqlite3VdbeAddOp2(pParse->pVdbe, op, inReg, target);
473717a7f8ddSdrh   }
4738ebc16717Sdrh }
4739cce7d176Sdrh 
4740cce7d176Sdrh /*
47411c75c9d7Sdrh ** Make a transient copy of expression pExpr and then code it using
47421c75c9d7Sdrh ** sqlite3ExprCode().  This routine works just like sqlite3ExprCode()
47431c75c9d7Sdrh ** except that the input expression is guaranteed to be unchanged.
47441c75c9d7Sdrh */
47451c75c9d7Sdrh void sqlite3ExprCodeCopy(Parse *pParse, Expr *pExpr, int target){
47461c75c9d7Sdrh   sqlite3 *db = pParse->db;
47471c75c9d7Sdrh   pExpr = sqlite3ExprDup(db, pExpr, 0);
47481c75c9d7Sdrh   if( !db->mallocFailed ) sqlite3ExprCode(pParse, pExpr, target);
47491c75c9d7Sdrh   sqlite3ExprDelete(db, pExpr);
47501c75c9d7Sdrh }
47511c75c9d7Sdrh 
47521c75c9d7Sdrh /*
475305a86c5cSdrh ** Generate code that will evaluate expression pExpr and store the
475405a86c5cSdrh ** results in register target.  The results are guaranteed to appear
475505a86c5cSdrh ** in register target.  If the expression is constant, then this routine
475605a86c5cSdrh ** might choose to code the expression at initialization time.
475705a86c5cSdrh */
475805a86c5cSdrh void sqlite3ExprCodeFactorable(Parse *pParse, Expr *pExpr, int target){
4759b8b06690Sdrh   if( pParse->okConstFactor && sqlite3ExprIsConstantNotJoin(pExpr) ){
47609b258c54Sdrh     sqlite3ExprCodeRunJustOnce(pParse, pExpr, target);
476105a86c5cSdrh   }else{
4762088489e8Sdrh     sqlite3ExprCodeCopy(pParse, pExpr, target);
476305a86c5cSdrh   }
4764cce7d176Sdrh }
4765cce7d176Sdrh 
4766cce7d176Sdrh /*
4767268380caSdrh ** Generate code that pushes the value of every element of the given
47689cbf3425Sdrh ** expression list into a sequence of registers beginning at target.
4769268380caSdrh **
47703df6c3b1Sdrh ** Return the number of elements evaluated.  The number returned will
47713df6c3b1Sdrh ** usually be pList->nExpr but might be reduced if SQLITE_ECEL_OMITREF
47723df6c3b1Sdrh ** is defined.
4773d1a01edaSdrh **
4774d1a01edaSdrh ** The SQLITE_ECEL_DUP flag prevents the arguments from being
4775d1a01edaSdrh ** filled using OP_SCopy.  OP_Copy must be used instead.
4776d1a01edaSdrh **
4777d1a01edaSdrh ** The SQLITE_ECEL_FACTOR argument allows constant arguments to be
4778d1a01edaSdrh ** factored out into initialization code.
4779b0df9634Sdrh **
4780b0df9634Sdrh ** The SQLITE_ECEL_REF flag means that expressions in the list with
4781b0df9634Sdrh ** ExprList.a[].u.x.iOrderByCol>0 have already been evaluated and stored
4782b0df9634Sdrh ** in registers at srcReg, and so the value can be copied from there.
47833df6c3b1Sdrh ** If SQLITE_ECEL_OMITREF is also set, then the values with u.x.iOrderByCol>0
47843df6c3b1Sdrh ** are simply omitted rather than being copied from srcReg.
4785268380caSdrh */
47864adee20fSdanielk1977 int sqlite3ExprCodeExprList(
4787268380caSdrh   Parse *pParse,     /* Parsing context */
4788389a1adbSdrh   ExprList *pList,   /* The expression list to be coded */
4789191b54cbSdrh   int target,        /* Where to write results */
47905579d59fSdrh   int srcReg,        /* Source registers if SQLITE_ECEL_REF */
4791d1a01edaSdrh   u8 flags           /* SQLITE_ECEL_* flags */
4792268380caSdrh ){
4793268380caSdrh   struct ExprList_item *pItem;
47945579d59fSdrh   int i, j, n;
4795d1a01edaSdrh   u8 copyOp = (flags & SQLITE_ECEL_DUP) ? OP_Copy : OP_SCopy;
47965579d59fSdrh   Vdbe *v = pParse->pVdbe;
47979d8b3072Sdrh   assert( pList!=0 );
47989cbf3425Sdrh   assert( target>0 );
4799d81a142bSdrh   assert( pParse->pVdbe!=0 );  /* Never gets this far otherwise */
4800268380caSdrh   n = pList->nExpr;
4801d9f158e7Sdrh   if( !ConstFactorOk(pParse) ) flags &= ~SQLITE_ECEL_FACTOR;
4802191b54cbSdrh   for(pItem=pList->a, i=0; i<n; i++, pItem++){
48037445ffe2Sdrh     Expr *pExpr = pItem->pExpr;
480424e25d32Sdan #ifdef SQLITE_ENABLE_SORTER_REFERENCES
480524e25d32Sdan     if( pItem->bSorterRef ){
480624e25d32Sdan       i--;
480724e25d32Sdan       n--;
480824e25d32Sdan     }else
480924e25d32Sdan #endif
4810257c13faSdan     if( (flags & SQLITE_ECEL_REF)!=0 && (j = pItem->u.x.iOrderByCol)>0 ){
4811257c13faSdan       if( flags & SQLITE_ECEL_OMITREF ){
4812257c13faSdan         i--;
4813257c13faSdan         n--;
4814257c13faSdan       }else{
48155579d59fSdrh         sqlite3VdbeAddOp2(v, copyOp, j+srcReg-1, target+i);
4816257c13faSdan       }
4817b8b06690Sdrh     }else if( (flags & SQLITE_ECEL_FACTOR)!=0
4818b8b06690Sdrh            && sqlite3ExprIsConstantNotJoin(pExpr)
4819b8b06690Sdrh     ){
48209b258c54Sdrh       sqlite3ExprCodeRunJustOnce(pParse, pExpr, target+i);
4821d1a01edaSdrh     }else{
48227445ffe2Sdrh       int inReg = sqlite3ExprCodeTarget(pParse, pExpr, target+i);
4823746fd9ccSdrh       if( inReg!=target+i ){
48244eded604Sdrh         VdbeOp *pOp;
48254eded604Sdrh         if( copyOp==OP_Copy
48264eded604Sdrh          && (pOp=sqlite3VdbeGetOp(v, -1))->opcode==OP_Copy
48274eded604Sdrh          && pOp->p1+pOp->p3+1==inReg
48284eded604Sdrh          && pOp->p2+pOp->p3+1==target+i
482990996885Sdrh          && pOp->p5==0  /* The do-not-merge flag must be clear */
48304eded604Sdrh         ){
48314eded604Sdrh           pOp->p3++;
48324eded604Sdrh         }else{
48334eded604Sdrh           sqlite3VdbeAddOp2(v, copyOp, inReg, target+i);
48344eded604Sdrh         }
4835d1a01edaSdrh       }
4836d176611bSdrh     }
4837268380caSdrh   }
4838f9b596ebSdrh   return n;
4839268380caSdrh }
4840268380caSdrh 
4841268380caSdrh /*
484236c563a2Sdrh ** Generate code for a BETWEEN operator.
484336c563a2Sdrh **
484436c563a2Sdrh **    x BETWEEN y AND z
484536c563a2Sdrh **
484636c563a2Sdrh ** The above is equivalent to
484736c563a2Sdrh **
484836c563a2Sdrh **    x>=y AND x<=z
484936c563a2Sdrh **
485036c563a2Sdrh ** Code it as such, taking care to do the common subexpression
485160ec914cSpeter.d.reid ** elimination of x.
485284b19a3dSdrh **
485384b19a3dSdrh ** The xJumpIf parameter determines details:
485484b19a3dSdrh **
485584b19a3dSdrh **    NULL:                   Store the boolean result in reg[dest]
485684b19a3dSdrh **    sqlite3ExprIfTrue:      Jump to dest if true
485784b19a3dSdrh **    sqlite3ExprIfFalse:     Jump to dest if false
485884b19a3dSdrh **
485984b19a3dSdrh ** The jumpIfNull parameter is ignored if xJumpIf is NULL.
486036c563a2Sdrh */
486136c563a2Sdrh static void exprCodeBetween(
486236c563a2Sdrh   Parse *pParse,    /* Parsing and code generating context */
486336c563a2Sdrh   Expr *pExpr,      /* The BETWEEN expression */
486484b19a3dSdrh   int dest,         /* Jump destination or storage location */
486584b19a3dSdrh   void (*xJump)(Parse*,Expr*,int,int), /* Action to take */
486636c563a2Sdrh   int jumpIfNull    /* Take the jump if the BETWEEN is NULL */
486736c563a2Sdrh ){
486836c563a2Sdrh   Expr exprAnd;     /* The AND operator in  x>=y AND x<=z  */
486936c563a2Sdrh   Expr compLeft;    /* The  x>=y  term */
487036c563a2Sdrh   Expr compRight;   /* The  x<=z  term */
4871db45bd5eSdrh   int regFree1 = 0; /* Temporary use register */
48728b65e591Sdan   Expr *pDel = 0;
48738b65e591Sdan   sqlite3 *db = pParse->db;
487484b19a3dSdrh 
487571c57db0Sdan   memset(&compLeft, 0, sizeof(Expr));
487671c57db0Sdan   memset(&compRight, 0, sizeof(Expr));
487771c57db0Sdan   memset(&exprAnd, 0, sizeof(Expr));
4878db45bd5eSdrh 
4879db45bd5eSdrh   assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
48808b65e591Sdan   pDel = sqlite3ExprDup(db, pExpr->pLeft, 0);
48818b65e591Sdan   if( db->mallocFailed==0 ){
488236c563a2Sdrh     exprAnd.op = TK_AND;
488336c563a2Sdrh     exprAnd.pLeft = &compLeft;
488436c563a2Sdrh     exprAnd.pRight = &compRight;
488536c563a2Sdrh     compLeft.op = TK_GE;
48868b65e591Sdan     compLeft.pLeft = pDel;
488736c563a2Sdrh     compLeft.pRight = pExpr->x.pList->a[0].pExpr;
488836c563a2Sdrh     compRight.op = TK_LE;
48898b65e591Sdan     compRight.pLeft = pDel;
489036c563a2Sdrh     compRight.pRight = pExpr->x.pList->a[1].pExpr;
48918b65e591Sdan     exprToRegister(pDel, exprCodeVector(pParse, pDel, &regFree1));
489284b19a3dSdrh     if( xJump ){
489384b19a3dSdrh       xJump(pParse, &exprAnd, dest, jumpIfNull);
489436c563a2Sdrh     }else{
489536fd41e5Sdrh       /* Mark the expression is being from the ON or USING clause of a join
489636fd41e5Sdrh       ** so that the sqlite3ExprCodeTarget() routine will not attempt to move
489736fd41e5Sdrh       ** it into the Parse.pConstExpr list.  We should use a new bit for this,
489836fd41e5Sdrh       ** for clarity, but we are out of bits in the Expr.flags field so we
489936fd41e5Sdrh       ** have to reuse the EP_FromJoin bit.  Bummer. */
49008b65e591Sdan       pDel->flags |= EP_FromJoin;
490171c57db0Sdan       sqlite3ExprCodeTarget(pParse, &exprAnd, dest);
490236c563a2Sdrh     }
4903db45bd5eSdrh     sqlite3ReleaseTempReg(pParse, regFree1);
49048b65e591Sdan   }
49058b65e591Sdan   sqlite3ExprDelete(db, pDel);
490636c563a2Sdrh 
490736c563a2Sdrh   /* Ensure adequate test coverage */
4908db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull==0 && regFree1==0 );
4909db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull==0 && regFree1!=0 );
4910db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull!=0 && regFree1==0 );
4911db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull!=0 && regFree1!=0 );
4912db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1==0 );
4913db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1!=0 );
4914db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1==0 );
4915db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1!=0 );
491684b19a3dSdrh   testcase( xJump==0 );
491736c563a2Sdrh }
491836c563a2Sdrh 
491936c563a2Sdrh /*
4920cce7d176Sdrh ** Generate code for a boolean expression such that a jump is made
4921cce7d176Sdrh ** to the label "dest" if the expression is true but execution
4922cce7d176Sdrh ** continues straight thru if the expression is false.
4923f5905aa7Sdrh **
4924f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false), then
492535573356Sdrh ** take the jump if the jumpIfNull flag is SQLITE_JUMPIFNULL.
4926f2bc013cSdrh **
4927f2bc013cSdrh ** This code depends on the fact that certain token values (ex: TK_EQ)
4928f2bc013cSdrh ** are the same as opcode values (ex: OP_Eq) that implement the corresponding
4929f2bc013cSdrh ** operation.  Special comments in vdbe.c and the mkopcodeh.awk script in
4930f2bc013cSdrh ** the make process cause these values to align.  Assert()s in the code
4931f2bc013cSdrh ** below verify that the numbers are aligned correctly.
4932cce7d176Sdrh */
49334adee20fSdanielk1977 void sqlite3ExprIfTrue(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
4934cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
4935cce7d176Sdrh   int op = 0;
49362dcef11bSdrh   int regFree1 = 0;
49372dcef11bSdrh   int regFree2 = 0;
49382dcef11bSdrh   int r1, r2;
49392dcef11bSdrh 
494035573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
494148864df9Smistachkin   if( NEVER(v==0) )     return;  /* Existence of VDBE checked by caller */
494233cd4909Sdrh   if( NEVER(pExpr==0) ) return;  /* No way this can happen */
4943e7375bfaSdrh   assert( !ExprHasVVAProperty(pExpr, EP_Immutable) );
4944f2bc013cSdrh   op = pExpr->op;
49457b35a77bSdan   switch( op ){
494617180fcaSdrh     case TK_AND:
494717180fcaSdrh     case TK_OR: {
494817180fcaSdrh       Expr *pAlt = sqlite3ExprSimplifiedAndOr(pExpr);
494917180fcaSdrh       if( pAlt!=pExpr ){
495017180fcaSdrh         sqlite3ExprIfTrue(pParse, pAlt, dest, jumpIfNull);
495117180fcaSdrh       }else if( op==TK_AND ){
4952ec4ccdbcSdrh         int d2 = sqlite3VdbeMakeLabel(pParse);
4953c5499befSdrh         testcase( jumpIfNull==0 );
495417180fcaSdrh         sqlite3ExprIfFalse(pParse, pExpr->pLeft, d2,
495517180fcaSdrh                            jumpIfNull^SQLITE_JUMPIFNULL);
49564adee20fSdanielk1977         sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
49574adee20fSdanielk1977         sqlite3VdbeResolveLabel(v, d2);
495817180fcaSdrh       }else{
4959c5499befSdrh         testcase( jumpIfNull==0 );
49604adee20fSdanielk1977         sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
49614adee20fSdanielk1977         sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
496217180fcaSdrh       }
4963cce7d176Sdrh       break;
4964cce7d176Sdrh     }
4965cce7d176Sdrh     case TK_NOT: {
4966c5499befSdrh       testcase( jumpIfNull==0 );
49674adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
4968cce7d176Sdrh       break;
4969cce7d176Sdrh     }
49708abed7b9Sdrh     case TK_TRUTH: {
497196acafbeSdrh       int isNot;      /* IS NOT TRUE or IS NOT FALSE */
497296acafbeSdrh       int isTrue;     /* IS TRUE or IS NOT TRUE */
4973007c843bSdrh       testcase( jumpIfNull==0 );
49748abed7b9Sdrh       isNot = pExpr->op2==TK_ISNOT;
497596acafbeSdrh       isTrue = sqlite3ExprTruthValue(pExpr->pRight);
497643c4ac8bSdrh       testcase( isTrue && isNot );
497796acafbeSdrh       testcase( !isTrue && isNot );
497843c4ac8bSdrh       if( isTrue ^ isNot ){
49798abed7b9Sdrh         sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
49808abed7b9Sdrh                           isNot ? SQLITE_JUMPIFNULL : 0);
49818abed7b9Sdrh       }else{
49828abed7b9Sdrh         sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
49838abed7b9Sdrh                            isNot ? SQLITE_JUMPIFNULL : 0);
49848abed7b9Sdrh       }
4985007c843bSdrh       break;
4986007c843bSdrh     }
4987de845c2fSdrh     case TK_IS:
4988de845c2fSdrh     case TK_ISNOT:
4989de845c2fSdrh       testcase( op==TK_IS );
4990de845c2fSdrh       testcase( op==TK_ISNOT );
4991de845c2fSdrh       op = (op==TK_IS) ? TK_EQ : TK_NE;
4992de845c2fSdrh       jumpIfNull = SQLITE_NULLEQ;
499308b92086Sdrh       /* no break */ deliberate_fall_through
4994cce7d176Sdrh     case TK_LT:
4995cce7d176Sdrh     case TK_LE:
4996cce7d176Sdrh     case TK_GT:
4997cce7d176Sdrh     case TK_GE:
4998cce7d176Sdrh     case TK_NE:
49990ac65892Sdrh     case TK_EQ: {
5000625015e0Sdan       if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
5001c5499befSdrh       testcase( jumpIfNull==0 );
5002b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
5003b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
500435573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
5005898c527eSdrh                   r1, r2, dest, jumpIfNull, ExprHasProperty(pExpr,EP_Commuted));
50067d176105Sdrh       assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
50077d176105Sdrh       assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
50087d176105Sdrh       assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
50097d176105Sdrh       assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
5010de845c2fSdrh       assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
5011de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
5012de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
5013de845c2fSdrh       assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
5014de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
5015de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
50166a2fe093Sdrh       testcase( regFree1==0 );
50176a2fe093Sdrh       testcase( regFree2==0 );
50186a2fe093Sdrh       break;
50196a2fe093Sdrh     }
5020cce7d176Sdrh     case TK_ISNULL:
5021cce7d176Sdrh     case TK_NOTNULL: {
50227d176105Sdrh       assert( TK_ISNULL==OP_IsNull );   testcase( op==TK_ISNULL );
50237d176105Sdrh       assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
50242dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
50252dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
50267d176105Sdrh       VdbeCoverageIf(v, op==TK_ISNULL);
50277d176105Sdrh       VdbeCoverageIf(v, op==TK_NOTNULL);
5028c5499befSdrh       testcase( regFree1==0 );
5029cce7d176Sdrh       break;
5030cce7d176Sdrh     }
5031fef5208cSdrh     case TK_BETWEEN: {
50325c03f30aSdrh       testcase( jumpIfNull==0 );
503371c57db0Sdan       exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfTrue, jumpIfNull);
5034fef5208cSdrh       break;
5035fef5208cSdrh     }
5036bb201344Sshaneh #ifndef SQLITE_OMIT_SUBQUERY
5037e3365e6cSdrh     case TK_IN: {
5038ec4ccdbcSdrh       int destIfFalse = sqlite3VdbeMakeLabel(pParse);
5039e3365e6cSdrh       int destIfNull = jumpIfNull ? dest : destIfFalse;
5040e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
5041076e85f5Sdrh       sqlite3VdbeGoto(v, dest);
5042e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
5043e3365e6cSdrh       break;
5044e3365e6cSdrh     }
5045bb201344Sshaneh #endif
5046cce7d176Sdrh     default: {
50477b35a77bSdan     default_expr:
5048ad31727fSdrh       if( ExprAlwaysTrue(pExpr) ){
5049076e85f5Sdrh         sqlite3VdbeGoto(v, dest);
5050ad31727fSdrh       }else if( ExprAlwaysFalse(pExpr) ){
5051991a1985Sdrh         /* No-op */
5052991a1985Sdrh       }else{
50532dcef11bSdrh         r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
50542dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_If, r1, dest, jumpIfNull!=0);
5055688852abSdrh         VdbeCoverage(v);
5056c5499befSdrh         testcase( regFree1==0 );
5057c5499befSdrh         testcase( jumpIfNull==0 );
5058991a1985Sdrh       }
5059cce7d176Sdrh       break;
5060cce7d176Sdrh     }
5061cce7d176Sdrh   }
50622dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
50632dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
5064cce7d176Sdrh }
5065cce7d176Sdrh 
5066cce7d176Sdrh /*
506766b89c8fSdrh ** Generate code for a boolean expression such that a jump is made
5068cce7d176Sdrh ** to the label "dest" if the expression is false but execution
5069cce7d176Sdrh ** continues straight thru if the expression is true.
5070f5905aa7Sdrh **
5071f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false) then
507235573356Sdrh ** jump if jumpIfNull is SQLITE_JUMPIFNULL or fall through if jumpIfNull
507335573356Sdrh ** is 0.
5074cce7d176Sdrh */
50754adee20fSdanielk1977 void sqlite3ExprIfFalse(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
5076cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
5077cce7d176Sdrh   int op = 0;
50782dcef11bSdrh   int regFree1 = 0;
50792dcef11bSdrh   int regFree2 = 0;
50802dcef11bSdrh   int r1, r2;
50812dcef11bSdrh 
508235573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
508348864df9Smistachkin   if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
508433cd4909Sdrh   if( pExpr==0 )    return;
5085e7375bfaSdrh   assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
5086f2bc013cSdrh 
5087f2bc013cSdrh   /* The value of pExpr->op and op are related as follows:
5088f2bc013cSdrh   **
5089f2bc013cSdrh   **       pExpr->op            op
5090f2bc013cSdrh   **       ---------          ----------
5091f2bc013cSdrh   **       TK_ISNULL          OP_NotNull
5092f2bc013cSdrh   **       TK_NOTNULL         OP_IsNull
5093f2bc013cSdrh   **       TK_NE              OP_Eq
5094f2bc013cSdrh   **       TK_EQ              OP_Ne
5095f2bc013cSdrh   **       TK_GT              OP_Le
5096f2bc013cSdrh   **       TK_LE              OP_Gt
5097f2bc013cSdrh   **       TK_GE              OP_Lt
5098f2bc013cSdrh   **       TK_LT              OP_Ge
5099f2bc013cSdrh   **
5100f2bc013cSdrh   ** For other values of pExpr->op, op is undefined and unused.
5101f2bc013cSdrh   ** The value of TK_ and OP_ constants are arranged such that we
5102f2bc013cSdrh   ** can compute the mapping above using the following expression.
5103f2bc013cSdrh   ** Assert()s verify that the computation is correct.
5104f2bc013cSdrh   */
5105f2bc013cSdrh   op = ((pExpr->op+(TK_ISNULL&1))^1)-(TK_ISNULL&1);
5106f2bc013cSdrh 
5107f2bc013cSdrh   /* Verify correct alignment of TK_ and OP_ constants
5108f2bc013cSdrh   */
5109f2bc013cSdrh   assert( pExpr->op!=TK_ISNULL || op==OP_NotNull );
5110f2bc013cSdrh   assert( pExpr->op!=TK_NOTNULL || op==OP_IsNull );
5111f2bc013cSdrh   assert( pExpr->op!=TK_NE || op==OP_Eq );
5112f2bc013cSdrh   assert( pExpr->op!=TK_EQ || op==OP_Ne );
5113f2bc013cSdrh   assert( pExpr->op!=TK_LT || op==OP_Ge );
5114f2bc013cSdrh   assert( pExpr->op!=TK_LE || op==OP_Gt );
5115f2bc013cSdrh   assert( pExpr->op!=TK_GT || op==OP_Le );
5116f2bc013cSdrh   assert( pExpr->op!=TK_GE || op==OP_Lt );
5117f2bc013cSdrh 
5118ba00e30aSdan   switch( pExpr->op ){
511917180fcaSdrh     case TK_AND:
512017180fcaSdrh     case TK_OR: {
512117180fcaSdrh       Expr *pAlt = sqlite3ExprSimplifiedAndOr(pExpr);
512217180fcaSdrh       if( pAlt!=pExpr ){
512317180fcaSdrh         sqlite3ExprIfFalse(pParse, pAlt, dest, jumpIfNull);
512417180fcaSdrh       }else if( pExpr->op==TK_AND ){
5125c5499befSdrh         testcase( jumpIfNull==0 );
51264adee20fSdanielk1977         sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
51274adee20fSdanielk1977         sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
512817180fcaSdrh       }else{
5129ec4ccdbcSdrh         int d2 = sqlite3VdbeMakeLabel(pParse);
5130c5499befSdrh         testcase( jumpIfNull==0 );
513117180fcaSdrh         sqlite3ExprIfTrue(pParse, pExpr->pLeft, d2,
513217180fcaSdrh                           jumpIfNull^SQLITE_JUMPIFNULL);
51334adee20fSdanielk1977         sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
51344adee20fSdanielk1977         sqlite3VdbeResolveLabel(v, d2);
513517180fcaSdrh       }
5136cce7d176Sdrh       break;
5137cce7d176Sdrh     }
5138cce7d176Sdrh     case TK_NOT: {
51395c03f30aSdrh       testcase( jumpIfNull==0 );
51404adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
5141cce7d176Sdrh       break;
5142cce7d176Sdrh     }
51438abed7b9Sdrh     case TK_TRUTH: {
514496acafbeSdrh       int isNot;   /* IS NOT TRUE or IS NOT FALSE */
514596acafbeSdrh       int isTrue;  /* IS TRUE or IS NOT TRUE */
51468abed7b9Sdrh       testcase( jumpIfNull==0 );
51478abed7b9Sdrh       isNot = pExpr->op2==TK_ISNOT;
514896acafbeSdrh       isTrue = sqlite3ExprTruthValue(pExpr->pRight);
514943c4ac8bSdrh       testcase( isTrue && isNot );
515096acafbeSdrh       testcase( !isTrue && isNot );
515143c4ac8bSdrh       if( isTrue ^ isNot ){
51528abed7b9Sdrh         /* IS TRUE and IS NOT FALSE */
51538abed7b9Sdrh         sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
51548abed7b9Sdrh                            isNot ? 0 : SQLITE_JUMPIFNULL);
51558abed7b9Sdrh 
51568abed7b9Sdrh       }else{
51578abed7b9Sdrh         /* IS FALSE and IS NOT TRUE */
51588abed7b9Sdrh         sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
51598abed7b9Sdrh                           isNot ? 0 : SQLITE_JUMPIFNULL);
51608abed7b9Sdrh       }
5161007c843bSdrh       break;
5162007c843bSdrh     }
5163de845c2fSdrh     case TK_IS:
5164de845c2fSdrh     case TK_ISNOT:
5165de845c2fSdrh       testcase( pExpr->op==TK_IS );
5166de845c2fSdrh       testcase( pExpr->op==TK_ISNOT );
5167de845c2fSdrh       op = (pExpr->op==TK_IS) ? TK_NE : TK_EQ;
5168de845c2fSdrh       jumpIfNull = SQLITE_NULLEQ;
516908b92086Sdrh       /* no break */ deliberate_fall_through
5170cce7d176Sdrh     case TK_LT:
5171cce7d176Sdrh     case TK_LE:
5172cce7d176Sdrh     case TK_GT:
5173cce7d176Sdrh     case TK_GE:
5174cce7d176Sdrh     case TK_NE:
5175cce7d176Sdrh     case TK_EQ: {
5176625015e0Sdan       if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
5177c5499befSdrh       testcase( jumpIfNull==0 );
5178b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
5179b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
518035573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
5181898c527eSdrh                   r1, r2, dest, jumpIfNull,ExprHasProperty(pExpr,EP_Commuted));
51827d176105Sdrh       assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
51837d176105Sdrh       assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
51847d176105Sdrh       assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
51857d176105Sdrh       assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
5186de845c2fSdrh       assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
5187de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
5188de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
5189de845c2fSdrh       assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
5190de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
5191de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
51926a2fe093Sdrh       testcase( regFree1==0 );
51936a2fe093Sdrh       testcase( regFree2==0 );
51946a2fe093Sdrh       break;
51956a2fe093Sdrh     }
5196cce7d176Sdrh     case TK_ISNULL:
5197cce7d176Sdrh     case TK_NOTNULL: {
51982dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
51992dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
52007d176105Sdrh       testcase( op==TK_ISNULL );   VdbeCoverageIf(v, op==TK_ISNULL);
52017d176105Sdrh       testcase( op==TK_NOTNULL );  VdbeCoverageIf(v, op==TK_NOTNULL);
5202c5499befSdrh       testcase( regFree1==0 );
5203cce7d176Sdrh       break;
5204cce7d176Sdrh     }
5205fef5208cSdrh     case TK_BETWEEN: {
52065c03f30aSdrh       testcase( jumpIfNull==0 );
520771c57db0Sdan       exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfFalse, jumpIfNull);
5208fef5208cSdrh       break;
5209fef5208cSdrh     }
5210bb201344Sshaneh #ifndef SQLITE_OMIT_SUBQUERY
5211e3365e6cSdrh     case TK_IN: {
5212e3365e6cSdrh       if( jumpIfNull ){
5213e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, dest);
5214e3365e6cSdrh       }else{
5215ec4ccdbcSdrh         int destIfNull = sqlite3VdbeMakeLabel(pParse);
5216e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, destIfNull);
5217e3365e6cSdrh         sqlite3VdbeResolveLabel(v, destIfNull);
5218e3365e6cSdrh       }
5219e3365e6cSdrh       break;
5220e3365e6cSdrh     }
5221bb201344Sshaneh #endif
5222cce7d176Sdrh     default: {
5223ba00e30aSdan     default_expr:
5224ad31727fSdrh       if( ExprAlwaysFalse(pExpr) ){
5225076e85f5Sdrh         sqlite3VdbeGoto(v, dest);
5226ad31727fSdrh       }else if( ExprAlwaysTrue(pExpr) ){
5227991a1985Sdrh         /* no-op */
5228991a1985Sdrh       }else{
52292dcef11bSdrh         r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
52302dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_IfNot, r1, dest, jumpIfNull!=0);
5231688852abSdrh         VdbeCoverage(v);
5232c5499befSdrh         testcase( regFree1==0 );
5233c5499befSdrh         testcase( jumpIfNull==0 );
5234991a1985Sdrh       }
5235cce7d176Sdrh       break;
5236cce7d176Sdrh     }
5237cce7d176Sdrh   }
52382dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
52392dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
5240cce7d176Sdrh }
52412282792aSdrh 
52422282792aSdrh /*
524372bc8208Sdrh ** Like sqlite3ExprIfFalse() except that a copy is made of pExpr before
524472bc8208Sdrh ** code generation, and that copy is deleted after code generation. This
524572bc8208Sdrh ** ensures that the original pExpr is unchanged.
524672bc8208Sdrh */
524772bc8208Sdrh void sqlite3ExprIfFalseDup(Parse *pParse, Expr *pExpr, int dest,int jumpIfNull){
524872bc8208Sdrh   sqlite3 *db = pParse->db;
524972bc8208Sdrh   Expr *pCopy = sqlite3ExprDup(db, pExpr, 0);
525072bc8208Sdrh   if( db->mallocFailed==0 ){
525172bc8208Sdrh     sqlite3ExprIfFalse(pParse, pCopy, dest, jumpIfNull);
525272bc8208Sdrh   }
525372bc8208Sdrh   sqlite3ExprDelete(db, pCopy);
525472bc8208Sdrh }
525572bc8208Sdrh 
52565aa550cfSdan /*
52575aa550cfSdan ** Expression pVar is guaranteed to be an SQL variable. pExpr may be any
52585aa550cfSdan ** type of expression.
52595aa550cfSdan **
52605aa550cfSdan ** If pExpr is a simple SQL value - an integer, real, string, blob
52615aa550cfSdan ** or NULL value - then the VDBE currently being prepared is configured
52625aa550cfSdan ** to re-prepare each time a new value is bound to variable pVar.
52635aa550cfSdan **
52645aa550cfSdan ** Additionally, if pExpr is a simple SQL value and the value is the
52655aa550cfSdan ** same as that currently bound to variable pVar, non-zero is returned.
52665aa550cfSdan ** Otherwise, if the values are not the same or if pExpr is not a simple
52675aa550cfSdan ** SQL value, zero is returned.
52685aa550cfSdan */
52695aa550cfSdan static int exprCompareVariable(Parse *pParse, Expr *pVar, Expr *pExpr){
52705aa550cfSdan   int res = 0;
5271c0804226Sdrh   int iVar;
5272c0804226Sdrh   sqlite3_value *pL, *pR = 0;
52735aa550cfSdan 
52745aa550cfSdan   sqlite3ValueFromExpr(pParse->db, pExpr, SQLITE_UTF8, SQLITE_AFF_BLOB, &pR);
5275c0804226Sdrh   if( pR ){
5276c0804226Sdrh     iVar = pVar->iColumn;
5277c0804226Sdrh     sqlite3VdbeSetVarmask(pParse->pVdbe, iVar);
5278c0804226Sdrh     pL = sqlite3VdbeGetBoundValue(pParse->pReprepare, iVar, SQLITE_AFF_BLOB);
52795aa307e2Sdrh     if( pL ){
52805aa307e2Sdrh       if( sqlite3_value_type(pL)==SQLITE_TEXT ){
52815aa307e2Sdrh         sqlite3_value_text(pL); /* Make sure the encoding is UTF-8 */
52825aa307e2Sdrh       }
52835aa307e2Sdrh       res =  0==sqlite3MemCompare(pL, pR, 0);
52845aa550cfSdan     }
52855aa550cfSdan     sqlite3ValueFree(pR);
52865aa550cfSdan     sqlite3ValueFree(pL);
52875aa550cfSdan   }
52885aa550cfSdan 
52895aa550cfSdan   return res;
52905aa550cfSdan }
529172bc8208Sdrh 
529272bc8208Sdrh /*
52931d9da70aSdrh ** Do a deep comparison of two expression trees.  Return 0 if the two
52941d9da70aSdrh ** expressions are completely identical.  Return 1 if they differ only
52951d9da70aSdrh ** by a COLLATE operator at the top level.  Return 2 if there are differences
52961d9da70aSdrh ** other than the top-level COLLATE operator.
5297d40aab0eSdrh **
5298619a1305Sdrh ** If any subelement of pB has Expr.iTable==(-1) then it is allowed
5299619a1305Sdrh ** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
5300619a1305Sdrh **
530166518ca7Sdrh ** The pA side might be using TK_REGISTER.  If that is the case and pB is
530266518ca7Sdrh ** not using TK_REGISTER but is otherwise equivalent, then still return 0.
530366518ca7Sdrh **
53041d9da70aSdrh ** Sometimes this routine will return 2 even if the two expressions
5305d40aab0eSdrh ** really are equivalent.  If we cannot prove that the expressions are
53061d9da70aSdrh ** identical, we return 2 just to be safe.  So if this routine
53071d9da70aSdrh ** returns 2, then you do not really know for certain if the two
53081d9da70aSdrh ** expressions are the same.  But if you get a 0 or 1 return, then you
5309d40aab0eSdrh ** can be sure the expressions are the same.  In the places where
53101d9da70aSdrh ** this routine is used, it does not hurt to get an extra 2 - that
5311d40aab0eSdrh ** just might result in some slightly slower code.  But returning
53121d9da70aSdrh ** an incorrect 0 or 1 could lead to a malfunction.
53135aa550cfSdan **
5314c0804226Sdrh ** If pParse is not NULL then TK_VARIABLE terms in pA with bindings in
5315c0804226Sdrh ** pParse->pReprepare can be matched against literals in pB.  The
5316c0804226Sdrh ** pParse->pVdbe->expmask bitmask is updated for each variable referenced.
5317c0804226Sdrh ** If pParse is NULL (the normal case) then any TK_VARIABLE term in
5318c0804226Sdrh ** Argument pParse should normally be NULL. If it is not NULL and pA or
5319c0804226Sdrh ** pB causes a return value of 2.
53202282792aSdrh */
53215aa550cfSdan int sqlite3ExprCompare(Parse *pParse, Expr *pA, Expr *pB, int iTab){
532210d1edf0Sdrh   u32 combinedFlags;
53234b202ae2Sdanielk1977   if( pA==0 || pB==0 ){
53241d9da70aSdrh     return pB==pA ? 0 : 2;
53252282792aSdrh   }
53265aa550cfSdan   if( pParse && pA->op==TK_VARIABLE && exprCompareVariable(pParse, pA, pB) ){
53275aa550cfSdan     return 0;
53285aa550cfSdan   }
532910d1edf0Sdrh   combinedFlags = pA->flags | pB->flags;
533010d1edf0Sdrh   if( combinedFlags & EP_IntValue ){
533110d1edf0Sdrh     if( (pA->flags&pB->flags&EP_IntValue)!=0 && pA->u.iValue==pB->u.iValue ){
533210d1edf0Sdrh       return 0;
533310d1edf0Sdrh     }
53341d9da70aSdrh     return 2;
53356ab3a2ecSdanielk1977   }
533616dd3985Sdan   if( pA->op!=pB->op || pA->op==TK_RAISE ){
53375aa550cfSdan     if( pA->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA->pLeft,pB,iTab)<2 ){
5338ae80ddeaSdrh       return 1;
5339ae80ddeaSdrh     }
53405aa550cfSdan     if( pB->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA,pB->pLeft,iTab)<2 ){
5341ae80ddeaSdrh       return 1;
5342ae80ddeaSdrh     }
5343ae80ddeaSdrh     return 2;
5344ae80ddeaSdrh   }
53452edc5fd7Sdrh   if( pA->op!=TK_COLUMN && pA->op!=TK_AGG_COLUMN && pA->u.zToken ){
53464f9adee2Sdan     if( pA->op==TK_FUNCTION || pA->op==TK_AGG_FUNCTION ){
5347390b88a4Sdrh       if( sqlite3StrICmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
5348eda079cdSdrh #ifndef SQLITE_OMIT_WINDOWFUNC
53494f9adee2Sdan       assert( pA->op==pB->op );
53504f9adee2Sdan       if( ExprHasProperty(pA,EP_WinFunc)!=ExprHasProperty(pB,EP_WinFunc) ){
53514f9adee2Sdan         return 2;
53524f9adee2Sdan       }
5353eda079cdSdrh       if( ExprHasProperty(pA,EP_WinFunc) ){
53544f9adee2Sdan         if( sqlite3WindowCompare(pParse, pA->y.pWin, pB->y.pWin, 1)!=0 ){
53554f9adee2Sdan           return 2;
53564f9adee2Sdan         }
5357eda079cdSdrh       }
5358eda079cdSdrh #endif
5359f20bbc5fSdrh     }else if( pA->op==TK_NULL ){
5360f20bbc5fSdrh       return 0;
5361d5af5420Sdrh     }else if( pA->op==TK_COLLATE ){
5362e79f6299Sdrh       if( sqlite3_stricmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
5363f20bbc5fSdrh     }else if( ALWAYS(pB->u.zToken!=0) && strcmp(pA->u.zToken,pB->u.zToken)!=0 ){
5364d5af5420Sdrh       return 2;
536510d1edf0Sdrh     }
536610d1edf0Sdrh   }
5367898c527eSdrh   if( (pA->flags & (EP_Distinct|EP_Commuted))
5368898c527eSdrh      != (pB->flags & (EP_Distinct|EP_Commuted)) ) return 2;
5369e7375bfaSdrh   if( ALWAYS((combinedFlags & EP_TokenOnly)==0) ){
537010d1edf0Sdrh     if( combinedFlags & EP_xIsSelect ) return 2;
5371efad2e23Sdrh     if( (combinedFlags & EP_FixedCol)==0
5372efad2e23Sdrh      && sqlite3ExprCompare(pParse, pA->pLeft, pB->pLeft, iTab) ) return 2;
53735aa550cfSdan     if( sqlite3ExprCompare(pParse, pA->pRight, pB->pRight, iTab) ) return 2;
5374619a1305Sdrh     if( sqlite3ExprListCompare(pA->x.pList, pB->x.pList, iTab) ) return 2;
537503c5c213Sdrh     if( pA->op!=TK_STRING
537603c5c213Sdrh      && pA->op!=TK_TRUEFALSE
5377e7375bfaSdrh      && ALWAYS((combinedFlags & EP_Reduced)==0)
537803c5c213Sdrh     ){
5379619a1305Sdrh       if( pA->iColumn!=pB->iColumn ) return 2;
53809b258c54Sdrh       if( pA->op2!=pB->op2 && pA->op==TK_TRUTH ) return 2;
53810f28e1bdSdrh       if( pA->op!=TK_IN && pA->iTable!=pB->iTable && pA->iTable!=iTab ){
53820f28e1bdSdrh         return 2;
53830f28e1bdSdrh       }
53841d9da70aSdrh     }
53851d9da70aSdrh   }
53862646da7eSdrh   return 0;
53872646da7eSdrh }
53882282792aSdrh 
53898c6f666bSdrh /*
5390fbb6e9ffSdan ** Compare two ExprList objects.  Return 0 if they are identical, 1
5391fbb6e9ffSdan ** if they are certainly different, or 2 if it is not possible to
5392fbb6e9ffSdan ** determine if they are identical or not.
53938c6f666bSdrh **
5394619a1305Sdrh ** If any subelement of pB has Expr.iTable==(-1) then it is allowed
5395619a1305Sdrh ** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
5396619a1305Sdrh **
53978c6f666bSdrh ** This routine might return non-zero for equivalent ExprLists.  The
53988c6f666bSdrh ** only consequence will be disabled optimizations.  But this routine
53998c6f666bSdrh ** must never return 0 if the two ExprList objects are different, or
54008c6f666bSdrh ** a malfunction will result.
54018c6f666bSdrh **
54028c6f666bSdrh ** Two NULL pointers are considered to be the same.  But a NULL pointer
54038c6f666bSdrh ** always differs from a non-NULL pointer.
54048c6f666bSdrh */
5405619a1305Sdrh int sqlite3ExprListCompare(ExprList *pA, ExprList *pB, int iTab){
54068c6f666bSdrh   int i;
54078c6f666bSdrh   if( pA==0 && pB==0 ) return 0;
54088c6f666bSdrh   if( pA==0 || pB==0 ) return 1;
54098c6f666bSdrh   if( pA->nExpr!=pB->nExpr ) return 1;
54108c6f666bSdrh   for(i=0; i<pA->nExpr; i++){
5411fbb6e9ffSdan     int res;
54128c6f666bSdrh     Expr *pExprA = pA->a[i].pExpr;
54138c6f666bSdrh     Expr *pExprB = pB->a[i].pExpr;
54146e11892dSdan     if( pA->a[i].sortFlags!=pB->a[i].sortFlags ) return 1;
5415fbb6e9ffSdan     if( (res = sqlite3ExprCompare(0, pExprA, pExprB, iTab)) ) return res;
54168c6f666bSdrh   }
54178c6f666bSdrh   return 0;
54188c6f666bSdrh }
541913449892Sdrh 
54202282792aSdrh /*
5421f9463dfbSdrh ** Like sqlite3ExprCompare() except COLLATE operators at the top-level
5422f9463dfbSdrh ** are ignored.
5423f9463dfbSdrh */
5424f9463dfbSdrh int sqlite3ExprCompareSkip(Expr *pA, Expr *pB, int iTab){
54255aa550cfSdan   return sqlite3ExprCompare(0,
54260d950af3Sdrh              sqlite3ExprSkipCollateAndLikely(pA),
54270d950af3Sdrh              sqlite3ExprSkipCollateAndLikely(pB),
5428f9463dfbSdrh              iTab);
5429f9463dfbSdrh }
5430f9463dfbSdrh 
5431f9463dfbSdrh /*
5432c51cf864Sdrh ** Return non-zero if Expr p can only be true if pNN is not NULL.
54337a231b49Sdrh **
54347a231b49Sdrh ** Or if seenNot is true, return non-zero if Expr p can only be
54357a231b49Sdrh ** non-NULL if pNN is not NULL
5436c51cf864Sdrh */
5437c51cf864Sdrh static int exprImpliesNotNull(
5438c51cf864Sdrh   Parse *pParse,      /* Parsing context */
5439c51cf864Sdrh   Expr *p,            /* The expression to be checked */
5440c51cf864Sdrh   Expr *pNN,          /* The expression that is NOT NULL */
5441c51cf864Sdrh   int iTab,           /* Table being evaluated */
54427a231b49Sdrh   int seenNot         /* Return true only if p can be any non-NULL value */
5443c51cf864Sdrh ){
5444c51cf864Sdrh   assert( p );
5445c51cf864Sdrh   assert( pNN );
544614c865e8Sdrh   if( sqlite3ExprCompare(pParse, p, pNN, iTab)==0 ){
544714c865e8Sdrh     return pNN->op!=TK_NULL;
544814c865e8Sdrh   }
5449c51cf864Sdrh   switch( p->op ){
5450c51cf864Sdrh     case TK_IN: {
5451c51cf864Sdrh       if( seenNot && ExprHasProperty(p, EP_xIsSelect) ) return 0;
5452c51cf864Sdrh       assert( ExprHasProperty(p,EP_xIsSelect)
5453c51cf864Sdrh            || (p->x.pList!=0 && p->x.pList->nExpr>0) );
5454ae144a1cSdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
5455c51cf864Sdrh     }
5456c51cf864Sdrh     case TK_BETWEEN: {
5457c51cf864Sdrh       ExprList *pList = p->x.pList;
5458c51cf864Sdrh       assert( pList!=0 );
5459c51cf864Sdrh       assert( pList->nExpr==2 );
5460c51cf864Sdrh       if( seenNot ) return 0;
54617a231b49Sdrh       if( exprImpliesNotNull(pParse, pList->a[0].pExpr, pNN, iTab, 1)
54627a231b49Sdrh        || exprImpliesNotNull(pParse, pList->a[1].pExpr, pNN, iTab, 1)
5463c51cf864Sdrh       ){
5464c51cf864Sdrh         return 1;
5465c51cf864Sdrh       }
54667a231b49Sdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
5467c51cf864Sdrh     }
5468c51cf864Sdrh     case TK_EQ:
5469c51cf864Sdrh     case TK_NE:
5470c51cf864Sdrh     case TK_LT:
5471c51cf864Sdrh     case TK_LE:
5472c51cf864Sdrh     case TK_GT:
5473c51cf864Sdrh     case TK_GE:
5474c51cf864Sdrh     case TK_PLUS:
5475c51cf864Sdrh     case TK_MINUS:
54769d23ea74Sdan     case TK_BITOR:
54779d23ea74Sdan     case TK_LSHIFT:
54789d23ea74Sdan     case TK_RSHIFT:
54799d23ea74Sdan     case TK_CONCAT:
54809d23ea74Sdan       seenNot = 1;
548108b92086Sdrh       /* no break */ deliberate_fall_through
5482c51cf864Sdrh     case TK_STAR:
5483c51cf864Sdrh     case TK_REM:
5484c51cf864Sdrh     case TK_BITAND:
54859d23ea74Sdan     case TK_SLASH: {
5486c51cf864Sdrh       if( exprImpliesNotNull(pParse, p->pRight, pNN, iTab, seenNot) ) return 1;
548708b92086Sdrh       /* no break */ deliberate_fall_through
5488c51cf864Sdrh     }
5489c51cf864Sdrh     case TK_SPAN:
5490c51cf864Sdrh     case TK_COLLATE:
5491c51cf864Sdrh     case TK_UPLUS:
5492c51cf864Sdrh     case TK_UMINUS: {
5493c51cf864Sdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, seenNot);
5494c51cf864Sdrh     }
5495c51cf864Sdrh     case TK_TRUTH: {
5496c51cf864Sdrh       if( seenNot ) return 0;
5497c51cf864Sdrh       if( p->op2!=TK_IS ) return 0;
549838cefc83Sdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
5499c51cf864Sdrh     }
55001cd382e3Sdan     case TK_BITNOT:
5501c51cf864Sdrh     case TK_NOT: {
5502c51cf864Sdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
5503c51cf864Sdrh     }
5504c51cf864Sdrh   }
5505c51cf864Sdrh   return 0;
5506c51cf864Sdrh }
5507c51cf864Sdrh 
5508c51cf864Sdrh /*
55094bd5f73fSdrh ** Return true if we can prove the pE2 will always be true if pE1 is
55104bd5f73fSdrh ** true.  Return false if we cannot complete the proof or if pE2 might
55114bd5f73fSdrh ** be false.  Examples:
55124bd5f73fSdrh **
5513619a1305Sdrh **     pE1: x==5       pE2: x==5             Result: true
55144bd5f73fSdrh **     pE1: x>0        pE2: x==5             Result: false
5515619a1305Sdrh **     pE1: x=21       pE2: x=21 OR y=43     Result: true
55164bd5f73fSdrh **     pE1: x!=123     pE2: x IS NOT NULL    Result: true
5517619a1305Sdrh **     pE1: x!=?1      pE2: x IS NOT NULL    Result: true
5518619a1305Sdrh **     pE1: x IS NULL  pE2: x IS NOT NULL    Result: false
5519619a1305Sdrh **     pE1: x IS ?2    pE2: x IS NOT NULL    Reuslt: false
55204bd5f73fSdrh **
55214bd5f73fSdrh ** When comparing TK_COLUMN nodes between pE1 and pE2, if pE2 has
55224bd5f73fSdrh ** Expr.iTable<0 then assume a table number given by iTab.
55234bd5f73fSdrh **
5524c0804226Sdrh ** If pParse is not NULL, then the values of bound variables in pE1 are
5525c0804226Sdrh ** compared against literal values in pE2 and pParse->pVdbe->expmask is
5526c0804226Sdrh ** modified to record which bound variables are referenced.  If pParse
5527c0804226Sdrh ** is NULL, then false will be returned if pE1 contains any bound variables.
5528c0804226Sdrh **
55294bd5f73fSdrh ** When in doubt, return false.  Returning true might give a performance
55304bd5f73fSdrh ** improvement.  Returning false might cause a performance reduction, but
55314bd5f73fSdrh ** it will always give the correct answer and is hence always safe.
55324bd5f73fSdrh */
55335aa550cfSdan int sqlite3ExprImpliesExpr(Parse *pParse, Expr *pE1, Expr *pE2, int iTab){
55345aa550cfSdan   if( sqlite3ExprCompare(pParse, pE1, pE2, iTab)==0 ){
5535619a1305Sdrh     return 1;
5536619a1305Sdrh   }
5537619a1305Sdrh   if( pE2->op==TK_OR
55385aa550cfSdan    && (sqlite3ExprImpliesExpr(pParse, pE1, pE2->pLeft, iTab)
55395aa550cfSdan              || sqlite3ExprImpliesExpr(pParse, pE1, pE2->pRight, iTab) )
5540619a1305Sdrh   ){
5541619a1305Sdrh     return 1;
5542619a1305Sdrh   }
5543664d6d13Sdrh   if( pE2->op==TK_NOTNULL
5544c51cf864Sdrh    && exprImpliesNotNull(pParse, pE1, pE2->pLeft, iTab, 0)
5545664d6d13Sdrh   ){
5546c51cf864Sdrh     return 1;
5547619a1305Sdrh   }
5548619a1305Sdrh   return 0;
55494bd5f73fSdrh }
55504bd5f73fSdrh 
55514bd5f73fSdrh /*
55526c68d759Sdrh ** This is the Expr node callback for sqlite3ExprImpliesNonNullRow().
55532589787cSdrh ** If the expression node requires that the table at pWalker->iCur
5554f8937f90Sdrh ** have one or more non-NULL column, then set pWalker->eCode to 1 and abort.
5555f8937f90Sdrh **
5556f8937f90Sdrh ** This routine controls an optimization.  False positives (setting
5557f8937f90Sdrh ** pWalker->eCode to 1 when it should not be) are deadly, but false-negatives
5558f8937f90Sdrh ** (never setting pWalker->eCode) is a harmless missed optimization.
55592589787cSdrh */
55602589787cSdrh static int impliesNotNullRow(Walker *pWalker, Expr *pExpr){
5561f8937f90Sdrh   testcase( pExpr->op==TK_AGG_COLUMN );
5562821b610bSdrh   testcase( pExpr->op==TK_AGG_FUNCTION );
55632589787cSdrh   if( ExprHasProperty(pExpr, EP_FromJoin) ) return WRC_Prune;
55642589787cSdrh   switch( pExpr->op ){
55650493222fSdan     case TK_ISNOT:
55662589787cSdrh     case TK_ISNULL:
5567d5793672Sdrh     case TK_NOTNULL:
55682589787cSdrh     case TK_IS:
55692589787cSdrh     case TK_OR:
55706c68d759Sdrh     case TK_VECTOR:
55712c492061Sdrh     case TK_CASE:
5572e3eff266Sdrh     case TK_IN:
55732589787cSdrh     case TK_FUNCTION:
5574da03c1e6Sdan     case TK_TRUTH:
55750493222fSdan       testcase( pExpr->op==TK_ISNOT );
5576821b610bSdrh       testcase( pExpr->op==TK_ISNULL );
5577d5793672Sdrh       testcase( pExpr->op==TK_NOTNULL );
5578821b610bSdrh       testcase( pExpr->op==TK_IS );
5579821b610bSdrh       testcase( pExpr->op==TK_OR );
55806c68d759Sdrh       testcase( pExpr->op==TK_VECTOR );
5581821b610bSdrh       testcase( pExpr->op==TK_CASE );
5582821b610bSdrh       testcase( pExpr->op==TK_IN );
5583821b610bSdrh       testcase( pExpr->op==TK_FUNCTION );
5584da03c1e6Sdan       testcase( pExpr->op==TK_TRUTH );
55852589787cSdrh       return WRC_Prune;
55862589787cSdrh     case TK_COLUMN:
55872589787cSdrh       if( pWalker->u.iCur==pExpr->iTable ){
55882589787cSdrh         pWalker->eCode = 1;
55892589787cSdrh         return WRC_Abort;
55902589787cSdrh       }
55912589787cSdrh       return WRC_Prune;
55929881155dSdrh 
55939d23ea74Sdan     case TK_AND:
5594aef81674Sdrh       if( pWalker->eCode==0 ){
55950287c951Sdan         sqlite3WalkExpr(pWalker, pExpr->pLeft);
55960287c951Sdan         if( pWalker->eCode ){
55970287c951Sdan           pWalker->eCode = 0;
55980287c951Sdan           sqlite3WalkExpr(pWalker, pExpr->pRight);
55999d23ea74Sdan         }
5600aef81674Sdrh       }
56019d23ea74Sdan       return WRC_Prune;
56029d23ea74Sdan 
56039d23ea74Sdan     case TK_BETWEEN:
56041d24a531Sdan       if( sqlite3WalkExpr(pWalker, pExpr->pLeft)==WRC_Abort ){
56051d24a531Sdan         assert( pWalker->eCode );
56061d24a531Sdan         return WRC_Abort;
56071d24a531Sdan       }
56089d23ea74Sdan       return WRC_Prune;
56099d23ea74Sdan 
56109881155dSdrh     /* Virtual tables are allowed to use constraints like x=NULL.  So
56119881155dSdrh     ** a term of the form x=y does not prove that y is not null if x
56129881155dSdrh     ** is the column of a virtual table */
56139881155dSdrh     case TK_EQ:
56149881155dSdrh     case TK_NE:
56159881155dSdrh     case TK_LT:
56169881155dSdrh     case TK_LE:
56179881155dSdrh     case TK_GT:
561878d1d225Sdrh     case TK_GE: {
561978d1d225Sdrh       Expr *pLeft = pExpr->pLeft;
562078d1d225Sdrh       Expr *pRight = pExpr->pRight;
56219881155dSdrh       testcase( pExpr->op==TK_EQ );
56229881155dSdrh       testcase( pExpr->op==TK_NE );
56239881155dSdrh       testcase( pExpr->op==TK_LT );
56249881155dSdrh       testcase( pExpr->op==TK_LE );
56259881155dSdrh       testcase( pExpr->op==TK_GT );
56269881155dSdrh       testcase( pExpr->op==TK_GE );
562778d1d225Sdrh       /* The y.pTab=0 assignment in wherecode.c always happens after the
562878d1d225Sdrh       ** impliesNotNullRow() test */
562978d1d225Sdrh       if( (pLeft->op==TK_COLUMN && ALWAYS(pLeft->y.pTab!=0)
563078d1d225Sdrh                                && IsVirtual(pLeft->y.pTab))
563178d1d225Sdrh        || (pRight->op==TK_COLUMN && ALWAYS(pRight->y.pTab!=0)
563278d1d225Sdrh                                && IsVirtual(pRight->y.pTab))
56339881155dSdrh       ){
56349881155dSdrh         return WRC_Prune;
56359881155dSdrh       }
563608b92086Sdrh       /* no break */ deliberate_fall_through
563778d1d225Sdrh     }
56382589787cSdrh     default:
56392589787cSdrh       return WRC_Continue;
56402589787cSdrh   }
56412589787cSdrh }
56422589787cSdrh 
56432589787cSdrh /*
56442589787cSdrh ** Return true (non-zero) if expression p can only be true if at least
56452589787cSdrh ** one column of table iTab is non-null.  In other words, return true
56462589787cSdrh ** if expression p will always be NULL or false if every column of iTab
56472589787cSdrh ** is NULL.
56482589787cSdrh **
5649821b610bSdrh ** False negatives are acceptable.  In other words, it is ok to return
5650821b610bSdrh ** zero even if expression p will never be true of every column of iTab
5651821b610bSdrh ** is NULL.  A false negative is merely a missed optimization opportunity.
5652821b610bSdrh **
5653821b610bSdrh ** False positives are not allowed, however.  A false positive may result
5654821b610bSdrh ** in an incorrect answer.
5655821b610bSdrh **
56562589787cSdrh ** Terms of p that are marked with EP_FromJoin (and hence that come from
56572589787cSdrh ** the ON or USING clauses of LEFT JOINS) are excluded from the analysis.
56582589787cSdrh **
56592589787cSdrh ** This routine is used to check if a LEFT JOIN can be converted into
56602589787cSdrh ** an ordinary JOIN.  The p argument is the WHERE clause.  If the WHERE
56612589787cSdrh ** clause requires that some column of the right table of the LEFT JOIN
56622589787cSdrh ** be non-NULL, then the LEFT JOIN can be safely converted into an
56632589787cSdrh ** ordinary join.
56642589787cSdrh */
56652589787cSdrh int sqlite3ExprImpliesNonNullRow(Expr *p, int iTab){
56662589787cSdrh   Walker w;
56670d950af3Sdrh   p = sqlite3ExprSkipCollateAndLikely(p);
56684a254f98Sdrh   if( p==0 ) return 0;
56694a254f98Sdrh   if( p->op==TK_NOTNULL ){
5670d6db6598Sdrh     p = p->pLeft;
5671a1698993Sdrh   }else{
5672a1698993Sdrh     while( p->op==TK_AND ){
56734a254f98Sdrh       if( sqlite3ExprImpliesNonNullRow(p->pLeft, iTab) ) return 1;
56744a254f98Sdrh       p = p->pRight;
5675d6db6598Sdrh     }
5676a1698993Sdrh   }
56772589787cSdrh   w.xExprCallback = impliesNotNullRow;
56782589787cSdrh   w.xSelectCallback = 0;
56792589787cSdrh   w.xSelectCallback2 = 0;
56802589787cSdrh   w.eCode = 0;
56812589787cSdrh   w.u.iCur = iTab;
56822589787cSdrh   sqlite3WalkExpr(&w, p);
56832589787cSdrh   return w.eCode;
56842589787cSdrh }
56852589787cSdrh 
56862589787cSdrh /*
5687030796dfSdrh ** An instance of the following structure is used by the tree walker
56882409f8a1Sdrh ** to determine if an expression can be evaluated by reference to the
56892409f8a1Sdrh ** index only, without having to do a search for the corresponding
56902409f8a1Sdrh ** table entry.  The IdxCover.pIdx field is the index.  IdxCover.iCur
56912409f8a1Sdrh ** is the cursor for the table.
56922409f8a1Sdrh */
56932409f8a1Sdrh struct IdxCover {
56942409f8a1Sdrh   Index *pIdx;     /* The index to be tested for coverage */
56952409f8a1Sdrh   int iCur;        /* Cursor number for the table corresponding to the index */
56962409f8a1Sdrh };
56972409f8a1Sdrh 
56982409f8a1Sdrh /*
56992409f8a1Sdrh ** Check to see if there are references to columns in table
57002409f8a1Sdrh ** pWalker->u.pIdxCover->iCur can be satisfied using the index
57012409f8a1Sdrh ** pWalker->u.pIdxCover->pIdx.
57022409f8a1Sdrh */
57032409f8a1Sdrh static int exprIdxCover(Walker *pWalker, Expr *pExpr){
57042409f8a1Sdrh   if( pExpr->op==TK_COLUMN
57052409f8a1Sdrh    && pExpr->iTable==pWalker->u.pIdxCover->iCur
5706b9bcf7caSdrh    && sqlite3TableColumnToIndex(pWalker->u.pIdxCover->pIdx, pExpr->iColumn)<0
57072409f8a1Sdrh   ){
57082409f8a1Sdrh     pWalker->eCode = 1;
57092409f8a1Sdrh     return WRC_Abort;
57102409f8a1Sdrh   }
57112409f8a1Sdrh   return WRC_Continue;
57122409f8a1Sdrh }
57132409f8a1Sdrh 
57142409f8a1Sdrh /*
5715e604ec0bSdrh ** Determine if an index pIdx on table with cursor iCur contains will
5716e604ec0bSdrh ** the expression pExpr.  Return true if the index does cover the
5717e604ec0bSdrh ** expression and false if the pExpr expression references table columns
5718e604ec0bSdrh ** that are not found in the index pIdx.
57192409f8a1Sdrh **
57202409f8a1Sdrh ** An index covering an expression means that the expression can be
57212409f8a1Sdrh ** evaluated using only the index and without having to lookup the
57222409f8a1Sdrh ** corresponding table entry.
57232409f8a1Sdrh */
57242409f8a1Sdrh int sqlite3ExprCoveredByIndex(
57252409f8a1Sdrh   Expr *pExpr,        /* The index to be tested */
57262409f8a1Sdrh   int iCur,           /* The cursor number for the corresponding table */
57272409f8a1Sdrh   Index *pIdx         /* The index that might be used for coverage */
57282409f8a1Sdrh ){
57292409f8a1Sdrh   Walker w;
57302409f8a1Sdrh   struct IdxCover xcov;
57312409f8a1Sdrh   memset(&w, 0, sizeof(w));
57322409f8a1Sdrh   xcov.iCur = iCur;
57332409f8a1Sdrh   xcov.pIdx = pIdx;
57342409f8a1Sdrh   w.xExprCallback = exprIdxCover;
57352409f8a1Sdrh   w.u.pIdxCover = &xcov;
57362409f8a1Sdrh   sqlite3WalkExpr(&w, pExpr);
57372409f8a1Sdrh   return !w.eCode;
57382409f8a1Sdrh }
57392409f8a1Sdrh 
57402409f8a1Sdrh 
57412409f8a1Sdrh /*
57422409f8a1Sdrh ** An instance of the following structure is used by the tree walker
5743030796dfSdrh ** to count references to table columns in the arguments of an
5744ed551b95Sdrh ** aggregate function, in order to implement the
5745ed551b95Sdrh ** sqlite3FunctionThisSrc() routine.
5746374fdce4Sdrh */
5747030796dfSdrh struct SrcCount {
5748030796dfSdrh   SrcList *pSrc;   /* One particular FROM clause in a nested query */
5749ed41a96bSdan   int iSrcInner;   /* Smallest cursor number in this context */
5750030796dfSdrh   int nThis;       /* Number of references to columns in pSrcList */
5751030796dfSdrh   int nOther;      /* Number of references to columns in other FROM clauses */
5752030796dfSdrh };
5753030796dfSdrh 
5754030796dfSdrh /*
5755ed41a96bSdan ** xSelect callback for sqlite3FunctionUsesThisSrc(). If this is the first
5756ed41a96bSdan ** SELECT with a FROM clause encountered during this iteration, set
5757ed41a96bSdan ** SrcCount.iSrcInner to the cursor number of the leftmost object in
5758ed41a96bSdan ** the FROM cause.
5759ed41a96bSdan */
5760ed41a96bSdan static int selectSrcCount(Walker *pWalker, Select *pSel){
5761ed41a96bSdan   struct SrcCount *p = pWalker->u.pSrcCount;
5762bc050b8fSdrh   if( p->iSrcInner==0x7FFFFFFF && ALWAYS(pSel->pSrc) && pSel->pSrc->nSrc ){
5763ed41a96bSdan     pWalker->u.pSrcCount->iSrcInner = pSel->pSrc->a[0].iCursor;
5764ed41a96bSdan   }
5765ed41a96bSdan   return WRC_Continue;
5766ed41a96bSdan }
5767ed41a96bSdan 
5768ed41a96bSdan /*
5769030796dfSdrh ** Count the number of references to columns.
5770030796dfSdrh */
5771030796dfSdrh static int exprSrcCount(Walker *pWalker, Expr *pExpr){
5772b4b36306Sdan   /* There was once a NEVER() on the second term on the grounds that
5773b4b36306Sdan   ** sqlite3FunctionUsesThisSrc() was always called before
5774b4b36306Sdan   ** sqlite3ExprAnalyzeAggregates() and so the TK_COLUMNs have not yet
5775b4b36306Sdan   ** been converted into TK_AGG_COLUMN. But this is no longer true due
5776b4b36306Sdan   ** to window functions - sqlite3WindowRewrite() may now indirectly call
5777b4b36306Sdan   ** FunctionUsesThisSrc() when creating a new sub-select. */
5778b4b36306Sdan   if( pExpr->op==TK_COLUMN || pExpr->op==TK_AGG_COLUMN ){
5779374fdce4Sdrh     int i;
5780030796dfSdrh     struct SrcCount *p = pWalker->u.pSrcCount;
5781030796dfSdrh     SrcList *pSrc = p->pSrc;
5782655814d2Sdrh     int nSrc = pSrc ? pSrc->nSrc : 0;
5783655814d2Sdrh     for(i=0; i<nSrc; i++){
5784030796dfSdrh       if( pExpr->iTable==pSrc->a[i].iCursor ) break;
5785374fdce4Sdrh     }
5786655814d2Sdrh     if( i<nSrc ){
5787030796dfSdrh       p->nThis++;
5788ed41a96bSdan     }else if( pExpr->iTable<p->iSrcInner ){
578980f6bfc0Sdrh       /* In a well-formed parse tree (no name resolution errors),
579035a38e08Sdrh       ** TK_COLUMN nodes with smaller Expr.iTable values are in an
579180f6bfc0Sdrh       ** outer context.  Those are the only ones to count as "other" */
5792030796dfSdrh       p->nOther++;
5793374fdce4Sdrh     }
5794374fdce4Sdrh   }
5795030796dfSdrh   return WRC_Continue;
5796030796dfSdrh }
5797374fdce4Sdrh 
5798374fdce4Sdrh /*
5799030796dfSdrh ** Determine if any of the arguments to the pExpr Function reference
5800030796dfSdrh ** pSrcList.  Return true if they do.  Also return true if the function
5801030796dfSdrh ** has no arguments or has only constant arguments.  Return false if pExpr
5802030796dfSdrh ** references columns but not columns of tables found in pSrcList.
5803374fdce4Sdrh */
5804030796dfSdrh int sqlite3FunctionUsesThisSrc(Expr *pExpr, SrcList *pSrcList){
5805374fdce4Sdrh   Walker w;
5806030796dfSdrh   struct SrcCount cnt;
5807374fdce4Sdrh   assert( pExpr->op==TK_AGG_FUNCTION );
580880f6bfc0Sdrh   memset(&w, 0, sizeof(w));
5809030796dfSdrh   w.xExprCallback = exprSrcCount;
5810ed41a96bSdan   w.xSelectCallback = selectSrcCount;
5811030796dfSdrh   w.u.pSrcCount = &cnt;
5812030796dfSdrh   cnt.pSrc = pSrcList;
5813ed41a96bSdan   cnt.iSrcInner = (pSrcList&&pSrcList->nSrc)?pSrcList->a[0].iCursor:0x7FFFFFFF;
5814030796dfSdrh   cnt.nThis = 0;
5815030796dfSdrh   cnt.nOther = 0;
5816030796dfSdrh   sqlite3WalkExprList(&w, pExpr->x.pList);
58175e484cb3Sdan #ifndef SQLITE_OMIT_WINDOWFUNC
58185e484cb3Sdan   if( ExprHasProperty(pExpr, EP_WinFunc) ){
58195e484cb3Sdan     sqlite3WalkExpr(&w, pExpr->y.pWin->pFilter);
58205e484cb3Sdan   }
58215e484cb3Sdan #endif
5822030796dfSdrh   return cnt.nThis>0 || cnt.nOther==0;
5823374fdce4Sdrh }
5824374fdce4Sdrh 
5825374fdce4Sdrh /*
582689636628Sdrh ** This is a Walker expression node callback.
582789636628Sdrh **
582889636628Sdrh ** For Expr nodes that contain pAggInfo pointers, make sure the AggInfo
582989636628Sdrh ** object that is referenced does not refer directly to the Expr.  If
583089636628Sdrh ** it does, make a copy.  This is done because the pExpr argument is
583189636628Sdrh ** subject to change.
583289636628Sdrh **
583389636628Sdrh ** The copy is stored on pParse->pConstExpr with a register number of 0.
583489636628Sdrh ** This will cause the expression to be deleted automatically when the
583589636628Sdrh ** Parse object is destroyed, but the zero register number means that it
583689636628Sdrh ** will not generate any code in the preamble.
583789636628Sdrh */
583889636628Sdrh static int agginfoPersistExprCb(Walker *pWalker, Expr *pExpr){
58392f82acc0Sdrh   if( ALWAYS(!ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced))
584089636628Sdrh    && pExpr->pAggInfo!=0
584189636628Sdrh   ){
584289636628Sdrh     AggInfo *pAggInfo = pExpr->pAggInfo;
584389636628Sdrh     int iAgg = pExpr->iAgg;
584489636628Sdrh     Parse *pParse = pWalker->pParse;
584589636628Sdrh     sqlite3 *db = pParse->db;
58462f82acc0Sdrh     assert( pExpr->op==TK_AGG_COLUMN || pExpr->op==TK_AGG_FUNCTION );
58472f82acc0Sdrh     if( pExpr->op==TK_AGG_COLUMN ){
584889636628Sdrh       assert( iAgg>=0 && iAgg<pAggInfo->nColumn );
584981185a51Sdrh       if( pAggInfo->aCol[iAgg].pCExpr==pExpr ){
585089636628Sdrh         pExpr = sqlite3ExprDup(db, pExpr, 0);
585189636628Sdrh         if( pExpr ){
585281185a51Sdrh           pAggInfo->aCol[iAgg].pCExpr = pExpr;
5853b3ad4e61Sdrh           sqlite3ExprDeferredDelete(pParse, pExpr);
585489636628Sdrh         }
585589636628Sdrh       }
585689636628Sdrh     }else{
585789636628Sdrh       assert( iAgg>=0 && iAgg<pAggInfo->nFunc );
585881185a51Sdrh       if( pAggInfo->aFunc[iAgg].pFExpr==pExpr ){
585989636628Sdrh         pExpr = sqlite3ExprDup(db, pExpr, 0);
586089636628Sdrh         if( pExpr ){
586181185a51Sdrh           pAggInfo->aFunc[iAgg].pFExpr = pExpr;
5862b3ad4e61Sdrh           sqlite3ExprDeferredDelete(pParse, pExpr);
586389636628Sdrh         }
586489636628Sdrh       }
586589636628Sdrh     }
586689636628Sdrh   }
586789636628Sdrh   return WRC_Continue;
586889636628Sdrh }
586989636628Sdrh 
587089636628Sdrh /*
587189636628Sdrh ** Initialize a Walker object so that will persist AggInfo entries referenced
587289636628Sdrh ** by the tree that is walked.
587389636628Sdrh */
587489636628Sdrh void sqlite3AggInfoPersistWalkerInit(Walker *pWalker, Parse *pParse){
587589636628Sdrh   memset(pWalker, 0, sizeof(*pWalker));
587689636628Sdrh   pWalker->pParse = pParse;
587789636628Sdrh   pWalker->xExprCallback = agginfoPersistExprCb;
587889636628Sdrh   pWalker->xSelectCallback = sqlite3SelectWalkNoop;
587989636628Sdrh }
588089636628Sdrh 
588189636628Sdrh /*
588213449892Sdrh ** Add a new element to the pAggInfo->aCol[] array.  Return the index of
588313449892Sdrh ** the new element.  Return a negative number if malloc fails.
58842282792aSdrh */
588517435752Sdrh static int addAggInfoColumn(sqlite3 *db, AggInfo *pInfo){
588613449892Sdrh   int i;
5887cf643729Sdrh   pInfo->aCol = sqlite3ArrayAllocate(
588817435752Sdrh        db,
5889cf643729Sdrh        pInfo->aCol,
5890cf643729Sdrh        sizeof(pInfo->aCol[0]),
5891cf643729Sdrh        &pInfo->nColumn,
5892cf643729Sdrh        &i
5893cf643729Sdrh   );
589413449892Sdrh   return i;
58952282792aSdrh }
589613449892Sdrh 
589713449892Sdrh /*
589813449892Sdrh ** Add a new element to the pAggInfo->aFunc[] array.  Return the index of
589913449892Sdrh ** the new element.  Return a negative number if malloc fails.
590013449892Sdrh */
590117435752Sdrh static int addAggInfoFunc(sqlite3 *db, AggInfo *pInfo){
590213449892Sdrh   int i;
5903cf643729Sdrh   pInfo->aFunc = sqlite3ArrayAllocate(
590417435752Sdrh        db,
5905cf643729Sdrh        pInfo->aFunc,
5906cf643729Sdrh        sizeof(pInfo->aFunc[0]),
5907cf643729Sdrh        &pInfo->nFunc,
5908cf643729Sdrh        &i
5909cf643729Sdrh   );
591013449892Sdrh   return i;
59112282792aSdrh }
59122282792aSdrh 
59132282792aSdrh /*
59147d10d5a6Sdrh ** This is the xExprCallback for a tree walker.  It is used to
59157d10d5a6Sdrh ** implement sqlite3ExprAnalyzeAggregates().  See sqlite3ExprAnalyzeAggregates
5916626a879aSdrh ** for additional information.
59172282792aSdrh */
59187d10d5a6Sdrh static int analyzeAggregate(Walker *pWalker, Expr *pExpr){
59192282792aSdrh   int i;
59207d10d5a6Sdrh   NameContext *pNC = pWalker->u.pNC;
5921a58fdfb1Sdanielk1977   Parse *pParse = pNC->pParse;
5922a58fdfb1Sdanielk1977   SrcList *pSrcList = pNC->pSrcList;
592325c3b8caSdrh   AggInfo *pAggInfo = pNC->uNC.pAggInfo;
592413449892Sdrh 
592525c3b8caSdrh   assert( pNC->ncFlags & NC_UAggInfo );
59262282792aSdrh   switch( pExpr->op ){
592789c69d00Sdrh     case TK_AGG_COLUMN:
5928967e8b73Sdrh     case TK_COLUMN: {
59298b213899Sdrh       testcase( pExpr->op==TK_AGG_COLUMN );
59308b213899Sdrh       testcase( pExpr->op==TK_COLUMN );
593113449892Sdrh       /* Check to see if the column is in one of the tables in the FROM
593213449892Sdrh       ** clause of the aggregate query */
593320bc393cSdrh       if( ALWAYS(pSrcList!=0) ){
59347601294aSdrh         SrcItem *pItem = pSrcList->a;
593513449892Sdrh         for(i=0; i<pSrcList->nSrc; i++, pItem++){
593613449892Sdrh           struct AggInfo_col *pCol;
5937c5cd1249Sdrh           assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
593813449892Sdrh           if( pExpr->iTable==pItem->iCursor ){
593913449892Sdrh             /* If we reach this point, it means that pExpr refers to a table
594013449892Sdrh             ** that is in the FROM clause of the aggregate query.
594113449892Sdrh             **
594213449892Sdrh             ** Make an entry for the column in pAggInfo->aCol[] if there
594313449892Sdrh             ** is not an entry there already.
594413449892Sdrh             */
59457f906d63Sdrh             int k;
594613449892Sdrh             pCol = pAggInfo->aCol;
59477f906d63Sdrh             for(k=0; k<pAggInfo->nColumn; k++, pCol++){
594813449892Sdrh               if( pCol->iTable==pExpr->iTable &&
594913449892Sdrh                   pCol->iColumn==pExpr->iColumn ){
59502282792aSdrh                 break;
59512282792aSdrh               }
59522282792aSdrh             }
59531e536953Sdanielk1977             if( (k>=pAggInfo->nColumn)
59541e536953Sdanielk1977              && (k = addAggInfoColumn(pParse->db, pAggInfo))>=0
59551e536953Sdanielk1977             ){
59567f906d63Sdrh               pCol = &pAggInfo->aCol[k];
5957eda079cdSdrh               pCol->pTab = pExpr->y.pTab;
595813449892Sdrh               pCol->iTable = pExpr->iTable;
595913449892Sdrh               pCol->iColumn = pExpr->iColumn;
59600a07c107Sdrh               pCol->iMem = ++pParse->nMem;
596113449892Sdrh               pCol->iSorterColumn = -1;
596281185a51Sdrh               pCol->pCExpr = pExpr;
596313449892Sdrh               if( pAggInfo->pGroupBy ){
596413449892Sdrh                 int j, n;
596513449892Sdrh                 ExprList *pGB = pAggInfo->pGroupBy;
596613449892Sdrh                 struct ExprList_item *pTerm = pGB->a;
596713449892Sdrh                 n = pGB->nExpr;
596813449892Sdrh                 for(j=0; j<n; j++, pTerm++){
596913449892Sdrh                   Expr *pE = pTerm->pExpr;
597013449892Sdrh                   if( pE->op==TK_COLUMN && pE->iTable==pExpr->iTable &&
597113449892Sdrh                       pE->iColumn==pExpr->iColumn ){
597213449892Sdrh                     pCol->iSorterColumn = j;
597313449892Sdrh                     break;
59742282792aSdrh                   }
597513449892Sdrh                 }
597613449892Sdrh               }
597713449892Sdrh               if( pCol->iSorterColumn<0 ){
597813449892Sdrh                 pCol->iSorterColumn = pAggInfo->nSortingColumn++;
597913449892Sdrh               }
598013449892Sdrh             }
598113449892Sdrh             /* There is now an entry for pExpr in pAggInfo->aCol[] (either
598213449892Sdrh             ** because it was there before or because we just created it).
598313449892Sdrh             ** Convert the pExpr to be a TK_AGG_COLUMN referring to that
598413449892Sdrh             ** pAggInfo->aCol[] entry.
598513449892Sdrh             */
5986ebb6a65dSdrh             ExprSetVVAProperty(pExpr, EP_NoReduce);
598713449892Sdrh             pExpr->pAggInfo = pAggInfo;
598813449892Sdrh             pExpr->op = TK_AGG_COLUMN;
5989cf697396Sshane             pExpr->iAgg = (i16)k;
599013449892Sdrh             break;
599113449892Sdrh           } /* endif pExpr->iTable==pItem->iCursor */
599213449892Sdrh         } /* end loop over pSrcList */
5993a58fdfb1Sdanielk1977       }
59947d10d5a6Sdrh       return WRC_Prune;
59952282792aSdrh     }
59962282792aSdrh     case TK_AGG_FUNCTION: {
59973a8c4be7Sdrh       if( (pNC->ncFlags & NC_InAggFunc)==0
5998ed551b95Sdrh        && pWalker->walkerDepth==pExpr->op2
59993a8c4be7Sdrh       ){
600013449892Sdrh         /* Check to see if pExpr is a duplicate of another aggregate
600113449892Sdrh         ** function that is already in the pAggInfo structure
600213449892Sdrh         */
600313449892Sdrh         struct AggInfo_func *pItem = pAggInfo->aFunc;
600413449892Sdrh         for(i=0; i<pAggInfo->nFunc; i++, pItem++){
600581185a51Sdrh           if( sqlite3ExprCompare(0, pItem->pFExpr, pExpr, -1)==0 ){
60062282792aSdrh             break;
60072282792aSdrh           }
60082282792aSdrh         }
600913449892Sdrh         if( i>=pAggInfo->nFunc ){
601013449892Sdrh           /* pExpr is original.  Make a new entry in pAggInfo->aFunc[]
601113449892Sdrh           */
601214db2665Sdanielk1977           u8 enc = ENC(pParse->db);
60131e536953Sdanielk1977           i = addAggInfoFunc(pParse->db, pAggInfo);
601413449892Sdrh           if( i>=0 ){
60156ab3a2ecSdanielk1977             assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
601613449892Sdrh             pItem = &pAggInfo->aFunc[i];
601781185a51Sdrh             pItem->pFExpr = pExpr;
60180a07c107Sdrh             pItem->iMem = ++pParse->nMem;
601933e619fcSdrh             assert( !ExprHasProperty(pExpr, EP_IntValue) );
602013449892Sdrh             pItem->pFunc = sqlite3FindFunction(pParse->db,
602180738d9cSdrh                    pExpr->u.zToken,
60226ab3a2ecSdanielk1977                    pExpr->x.pList ? pExpr->x.pList->nExpr : 0, enc, 0);
6023fd357974Sdrh             if( pExpr->flags & EP_Distinct ){
6024fd357974Sdrh               pItem->iDistinct = pParse->nTab++;
6025fd357974Sdrh             }else{
6026fd357974Sdrh               pItem->iDistinct = -1;
6027fd357974Sdrh             }
60282282792aSdrh           }
602913449892Sdrh         }
603013449892Sdrh         /* Make pExpr point to the appropriate pAggInfo->aFunc[] entry
603113449892Sdrh         */
6032c5cd1249Sdrh         assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
6033ebb6a65dSdrh         ExprSetVVAProperty(pExpr, EP_NoReduce);
6034cf697396Sshane         pExpr->iAgg = (i16)i;
603513449892Sdrh         pExpr->pAggInfo = pAggInfo;
60363a8c4be7Sdrh         return WRC_Prune;
60376e83a57fSdrh       }else{
60386e83a57fSdrh         return WRC_Continue;
60396e83a57fSdrh       }
60402282792aSdrh     }
6041a58fdfb1Sdanielk1977   }
60427d10d5a6Sdrh   return WRC_Continue;
60437d10d5a6Sdrh }
6044626a879aSdrh 
6045626a879aSdrh /*
6046e8abb4caSdrh ** Analyze the pExpr expression looking for aggregate functions and
6047e8abb4caSdrh ** for variables that need to be added to AggInfo object that pNC->pAggInfo
6048e8abb4caSdrh ** points to.  Additional entries are made on the AggInfo object as
6049e8abb4caSdrh ** necessary.
6050626a879aSdrh **
6051626a879aSdrh ** This routine should only be called after the expression has been
60527d10d5a6Sdrh ** analyzed by sqlite3ResolveExprNames().
6053626a879aSdrh */
6054d2b3e23bSdrh void sqlite3ExprAnalyzeAggregates(NameContext *pNC, Expr *pExpr){
60557d10d5a6Sdrh   Walker w;
60567d10d5a6Sdrh   w.xExprCallback = analyzeAggregate;
6057e40cc16bSdrh   w.xSelectCallback = sqlite3WalkerDepthIncrease;
6058e40cc16bSdrh   w.xSelectCallback2 = sqlite3WalkerDepthDecrease;
6059979dd1beSdrh   w.walkerDepth = 0;
60607d10d5a6Sdrh   w.u.pNC = pNC;
6061d9995031Sdan   w.pParse = 0;
606220bc393cSdrh   assert( pNC->pSrcList!=0 );
60637d10d5a6Sdrh   sqlite3WalkExpr(&w, pExpr);
60642282792aSdrh }
60655d9a4af9Sdrh 
60665d9a4af9Sdrh /*
60675d9a4af9Sdrh ** Call sqlite3ExprAnalyzeAggregates() for every expression in an
60685d9a4af9Sdrh ** expression list.  Return the number of errors.
60695d9a4af9Sdrh **
60705d9a4af9Sdrh ** If an error is found, the analysis is cut short.
60715d9a4af9Sdrh */
6072d2b3e23bSdrh void sqlite3ExprAnalyzeAggList(NameContext *pNC, ExprList *pList){
60735d9a4af9Sdrh   struct ExprList_item *pItem;
60745d9a4af9Sdrh   int i;
60755d9a4af9Sdrh   if( pList ){
6076d2b3e23bSdrh     for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
6077d2b3e23bSdrh       sqlite3ExprAnalyzeAggregates(pNC, pItem->pExpr);
60785d9a4af9Sdrh     }
60795d9a4af9Sdrh   }
60805d9a4af9Sdrh }
6081892d3179Sdrh 
6082892d3179Sdrh /*
6083ceea3321Sdrh ** Allocate a single new register for use to hold some intermediate result.
6084892d3179Sdrh */
6085892d3179Sdrh int sqlite3GetTempReg(Parse *pParse){
6086e55cbd72Sdrh   if( pParse->nTempReg==0 ){
6087892d3179Sdrh     return ++pParse->nMem;
6088892d3179Sdrh   }
60892f425f6bSdanielk1977   return pParse->aTempReg[--pParse->nTempReg];
6090892d3179Sdrh }
6091ceea3321Sdrh 
6092ceea3321Sdrh /*
6093ceea3321Sdrh ** Deallocate a register, making available for reuse for some other
6094ceea3321Sdrh ** purpose.
6095ceea3321Sdrh */
6096892d3179Sdrh void sqlite3ReleaseTempReg(Parse *pParse, int iReg){
609713d79502Sdrh   if( iReg ){
60983aef2fb1Sdrh     sqlite3VdbeReleaseRegisters(pParse, iReg, 1, 0, 0);
609913d79502Sdrh     if( pParse->nTempReg<ArraySize(pParse->aTempReg) ){
6100892d3179Sdrh       pParse->aTempReg[pParse->nTempReg++] = iReg;
6101892d3179Sdrh     }
6102892d3179Sdrh   }
610313d79502Sdrh }
6104892d3179Sdrh 
6105892d3179Sdrh /*
6106ed24da4bSdrh ** Allocate or deallocate a block of nReg consecutive registers.
6107892d3179Sdrh */
6108892d3179Sdrh int sqlite3GetTempRange(Parse *pParse, int nReg){
6109e55cbd72Sdrh   int i, n;
6110ed24da4bSdrh   if( nReg==1 ) return sqlite3GetTempReg(pParse);
6111892d3179Sdrh   i = pParse->iRangeReg;
6112e55cbd72Sdrh   n = pParse->nRangeReg;
6113f49f3523Sdrh   if( nReg<=n ){
6114892d3179Sdrh     pParse->iRangeReg += nReg;
6115892d3179Sdrh     pParse->nRangeReg -= nReg;
6116892d3179Sdrh   }else{
6117892d3179Sdrh     i = pParse->nMem+1;
6118892d3179Sdrh     pParse->nMem += nReg;
6119892d3179Sdrh   }
6120892d3179Sdrh   return i;
6121892d3179Sdrh }
6122892d3179Sdrh void sqlite3ReleaseTempRange(Parse *pParse, int iReg, int nReg){
6123ed24da4bSdrh   if( nReg==1 ){
6124ed24da4bSdrh     sqlite3ReleaseTempReg(pParse, iReg);
6125ed24da4bSdrh     return;
6126ed24da4bSdrh   }
61273aef2fb1Sdrh   sqlite3VdbeReleaseRegisters(pParse, iReg, nReg, 0, 0);
6128892d3179Sdrh   if( nReg>pParse->nRangeReg ){
6129892d3179Sdrh     pParse->nRangeReg = nReg;
6130892d3179Sdrh     pParse->iRangeReg = iReg;
6131892d3179Sdrh   }
6132892d3179Sdrh }
6133cdc69557Sdrh 
6134cdc69557Sdrh /*
6135cdc69557Sdrh ** Mark all temporary registers as being unavailable for reuse.
61366d2566dfSdrh **
61376d2566dfSdrh ** Always invoke this procedure after coding a subroutine or co-routine
61386d2566dfSdrh ** that might be invoked from other parts of the code, to ensure that
61396d2566dfSdrh ** the sub/co-routine does not use registers in common with the code that
61406d2566dfSdrh ** invokes the sub/co-routine.
6141cdc69557Sdrh */
6142cdc69557Sdrh void sqlite3ClearTempRegCache(Parse *pParse){
6143cdc69557Sdrh   pParse->nTempReg = 0;
6144cdc69557Sdrh   pParse->nRangeReg = 0;
6145cdc69557Sdrh }
6146bb9b5f26Sdrh 
6147bb9b5f26Sdrh /*
6148bb9b5f26Sdrh ** Validate that no temporary register falls within the range of
6149bb9b5f26Sdrh ** iFirst..iLast, inclusive.  This routine is only call from within assert()
6150bb9b5f26Sdrh ** statements.
6151bb9b5f26Sdrh */
6152bb9b5f26Sdrh #ifdef SQLITE_DEBUG
6153bb9b5f26Sdrh int sqlite3NoTempsInRange(Parse *pParse, int iFirst, int iLast){
6154bb9b5f26Sdrh   int i;
6155bb9b5f26Sdrh   if( pParse->nRangeReg>0
61563963e584Sdrh    && pParse->iRangeReg+pParse->nRangeReg > iFirst
61573963e584Sdrh    && pParse->iRangeReg <= iLast
6158bb9b5f26Sdrh   ){
6159bb9b5f26Sdrh      return 0;
6160bb9b5f26Sdrh   }
6161bb9b5f26Sdrh   for(i=0; i<pParse->nTempReg; i++){
6162bb9b5f26Sdrh     if( pParse->aTempReg[i]>=iFirst && pParse->aTempReg[i]<=iLast ){
6163bb9b5f26Sdrh       return 0;
6164bb9b5f26Sdrh     }
6165bb9b5f26Sdrh   }
6166bb9b5f26Sdrh   return 1;
6167bb9b5f26Sdrh }
6168bb9b5f26Sdrh #endif /* SQLITE_DEBUG */
6169