xref: /sqlite-3.40.0/src/expr.c (revision a79e2a2d)
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;
55487e262fSdrh   if( op==TK_SELECT ){
566ab3a2ecSdanielk1977     assert( pExpr->flags&EP_xIsSelect );
576af305deSdrh     assert( pExpr->x.pSelect!=0 );
586af305deSdrh     assert( pExpr->x.pSelect->pEList!=0 );
596af305deSdrh     assert( pExpr->x.pSelect->pEList->a[0].pExpr!=0 );
606ab3a2ecSdanielk1977     return sqlite3ExprAffinity(pExpr->x.pSelect->pEList->a[0].pExpr);
61a37cdde0Sdanielk1977   }
62db45bd5eSdrh   if( op==TK_REGISTER ) op = pExpr->op2;
63487e262fSdrh #ifndef SQLITE_OMIT_CAST
64487e262fSdrh   if( op==TK_CAST ){
6533e619fcSdrh     assert( !ExprHasProperty(pExpr, EP_IntValue) );
66fdaac671Sdrh     return sqlite3AffinityType(pExpr->u.zToken, 0);
67487e262fSdrh   }
68487e262fSdrh #endif
69eda079cdSdrh   if( (op==TK_AGG_COLUMN || op==TK_COLUMN) && pExpr->y.pTab ){
70eda079cdSdrh     return sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
717d10d5a6Sdrh   }
7280aa5453Sdan   if( op==TK_SELECT_COLUMN ){
7380aa5453Sdan     assert( pExpr->pLeft->flags&EP_xIsSelect );
7480aa5453Sdan     return sqlite3ExprAffinity(
7580aa5453Sdan         pExpr->pLeft->x.pSelect->pEList->a[pExpr->iColumn].pExpr
7680aa5453Sdan     );
7780aa5453Sdan   }
78db36e255Sdrh   if( op==TK_VECTOR ){
79db36e255Sdrh     return sqlite3ExprAffinity(pExpr->x.pList->a[0].pExpr);
80db36e255Sdrh   }
811194904bSdrh   return pExpr->affExpr;
82a37cdde0Sdanielk1977 }
83a37cdde0Sdanielk1977 
8453db1458Sdrh /*
858b4c40d8Sdrh ** Set the collating sequence for expression pExpr to be the collating
86ae80ddeaSdrh ** sequence named by pToken.   Return a pointer to a new Expr node that
87ae80ddeaSdrh ** implements the COLLATE operator.
880a8a406eSdrh **
890a8a406eSdrh ** If a memory allocation error occurs, that fact is recorded in pParse->db
900a8a406eSdrh ** and the pExpr parameter is returned unchanged.
918b4c40d8Sdrh */
924ef7efadSdrh Expr *sqlite3ExprAddCollateToken(
934ef7efadSdrh   Parse *pParse,           /* Parsing context */
944ef7efadSdrh   Expr *pExpr,             /* Add the "COLLATE" clause to this expression */
9580103fc6Sdan   const Token *pCollName,  /* Name of collating sequence */
9680103fc6Sdan   int dequote              /* True to dequote pCollName */
974ef7efadSdrh ){
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;
1029ffa258aSdrh     if( ALWAYS(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;
614ec4ccdbcSdrh   int addrDone = sqlite3VdbeMakeLabel(pParse);
615898c527eSdrh   int isCommuted = ExprHasProperty(pExpr,EP_Commuted);
61671c57db0Sdan 
617e7375bfaSdrh   assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
61870d6b832Sdrh   if( pParse->nErr ) return;
619245ce62eSdrh   if( nLeft!=sqlite3ExprVectorSize(pRight) ){
620245ce62eSdrh     sqlite3ErrorMsg(pParse, "row value misused");
621245ce62eSdrh     return;
622245ce62eSdrh   }
62371c57db0Sdan   assert( pExpr->op==TK_EQ || pExpr->op==TK_NE
62471c57db0Sdan        || pExpr->op==TK_IS || pExpr->op==TK_ISNOT
62571c57db0Sdan        || pExpr->op==TK_LT || pExpr->op==TK_GT
62671c57db0Sdan        || pExpr->op==TK_LE || pExpr->op==TK_GE
62771c57db0Sdan   );
62879752b6eSdrh   assert( pExpr->op==op || (pExpr->op==TK_IS && op==TK_EQ)
62979752b6eSdrh             || (pExpr->op==TK_ISNOT && op==TK_NE) );
63079752b6eSdrh   assert( p5==0 || pExpr->op!=op );
63179752b6eSdrh   assert( p5==SQLITE_NULLEQ || pExpr->op==op );
63271c57db0Sdan 
63379752b6eSdrh   p5 |= SQLITE_STOREP2;
63479752b6eSdrh   if( opx==TK_LE ) opx = TK_LT;
63579752b6eSdrh   if( opx==TK_GE ) opx = TK_GT;
6365c288b92Sdan 
6375c288b92Sdan   regLeft = exprCodeSubselect(pParse, pLeft);
6385c288b92Sdan   regRight = exprCodeSubselect(pParse, pRight);
6395c288b92Sdan 
640321e828dSdrh   for(i=0; 1 /*Loop exits by "break"*/; i++){
6415c288b92Sdan     int regFree1 = 0, regFree2 = 0;
6425c288b92Sdan     Expr *pL, *pR;
6435c288b92Sdan     int r1, r2;
644321e828dSdrh     assert( i>=0 && i<nLeft );
6455c288b92Sdan     r1 = exprVectorRegister(pParse, pLeft, i, regLeft, &pL, &regFree1);
6465c288b92Sdan     r2 = exprVectorRegister(pParse, pRight, i, regRight, &pR, &regFree2);
647898c527eSdrh     codeCompare(pParse, pL, pR, opx, r1, r2, dest, p5, isCommuted);
64879752b6eSdrh     testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
64979752b6eSdrh     testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
65079752b6eSdrh     testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
65179752b6eSdrh     testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
65279752b6eSdrh     testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
65379752b6eSdrh     testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
65471c57db0Sdan     sqlite3ReleaseTempReg(pParse, regFree1);
65571c57db0Sdan     sqlite3ReleaseTempReg(pParse, regFree2);
65679752b6eSdrh     if( i==nLeft-1 ){
65779752b6eSdrh       break;
65871c57db0Sdan     }
65979752b6eSdrh     if( opx==TK_EQ ){
66079752b6eSdrh       sqlite3VdbeAddOp2(v, OP_IfNot, dest, addrDone); VdbeCoverage(v);
66179752b6eSdrh       p5 |= SQLITE_KEEPNULL;
66279752b6eSdrh     }else if( opx==TK_NE ){
66379752b6eSdrh       sqlite3VdbeAddOp2(v, OP_If, dest, addrDone); VdbeCoverage(v);
66479752b6eSdrh       p5 |= SQLITE_KEEPNULL;
665a2f62925Sdrh     }else{
666a2f62925Sdrh       assert( op==TK_LT || op==TK_GT || op==TK_LE || op==TK_GE );
667a2f62925Sdrh       sqlite3VdbeAddOp2(v, OP_ElseNotEq, 0, addrDone);
66879752b6eSdrh       VdbeCoverageIf(v, op==TK_LT);
66979752b6eSdrh       VdbeCoverageIf(v, op==TK_GT);
67079752b6eSdrh       VdbeCoverageIf(v, op==TK_LE);
67179752b6eSdrh       VdbeCoverageIf(v, op==TK_GE);
67279752b6eSdrh       if( i==nLeft-2 ) opx = op;
67371c57db0Sdan     }
67479752b6eSdrh   }
67579752b6eSdrh   sqlite3VdbeResolveLabel(v, addrDone);
67679752b6eSdrh }
67771c57db0Sdan 
6784b5255acSdanielk1977 #if SQLITE_MAX_EXPR_DEPTH>0
6794b5255acSdanielk1977 /*
6804b5255acSdanielk1977 ** Check that argument nHeight is less than or equal to the maximum
6814b5255acSdanielk1977 ** expression depth allowed. If it is not, leave an error message in
6824b5255acSdanielk1977 ** pParse.
6834b5255acSdanielk1977 */
6847d10d5a6Sdrh int sqlite3ExprCheckHeight(Parse *pParse, int nHeight){
6854b5255acSdanielk1977   int rc = SQLITE_OK;
6864b5255acSdanielk1977   int mxHeight = pParse->db->aLimit[SQLITE_LIMIT_EXPR_DEPTH];
6874b5255acSdanielk1977   if( nHeight>mxHeight ){
6884b5255acSdanielk1977     sqlite3ErrorMsg(pParse,
6894b5255acSdanielk1977        "Expression tree is too large (maximum depth %d)", mxHeight
6904b5255acSdanielk1977     );
6914b5255acSdanielk1977     rc = SQLITE_ERROR;
6924b5255acSdanielk1977   }
6934b5255acSdanielk1977   return rc;
6944b5255acSdanielk1977 }
6954b5255acSdanielk1977 
6964b5255acSdanielk1977 /* The following three functions, heightOfExpr(), heightOfExprList()
6974b5255acSdanielk1977 ** and heightOfSelect(), are used to determine the maximum height
6984b5255acSdanielk1977 ** of any expression tree referenced by the structure passed as the
6994b5255acSdanielk1977 ** first argument.
7004b5255acSdanielk1977 **
7014b5255acSdanielk1977 ** If this maximum height is greater than the current value pointed
7024b5255acSdanielk1977 ** to by pnHeight, the second parameter, then set *pnHeight to that
7034b5255acSdanielk1977 ** value.
7044b5255acSdanielk1977 */
7054b5255acSdanielk1977 static void heightOfExpr(Expr *p, int *pnHeight){
7064b5255acSdanielk1977   if( p ){
7074b5255acSdanielk1977     if( p->nHeight>*pnHeight ){
7084b5255acSdanielk1977       *pnHeight = p->nHeight;
7094b5255acSdanielk1977     }
7104b5255acSdanielk1977   }
7114b5255acSdanielk1977 }
7124b5255acSdanielk1977 static void heightOfExprList(ExprList *p, int *pnHeight){
7134b5255acSdanielk1977   if( p ){
7144b5255acSdanielk1977     int i;
7154b5255acSdanielk1977     for(i=0; i<p->nExpr; i++){
7164b5255acSdanielk1977       heightOfExpr(p->a[i].pExpr, pnHeight);
7174b5255acSdanielk1977     }
7184b5255acSdanielk1977   }
7194b5255acSdanielk1977 }
7201a3a3086Sdan static void heightOfSelect(Select *pSelect, int *pnHeight){
7211a3a3086Sdan   Select *p;
7221a3a3086Sdan   for(p=pSelect; p; p=p->pPrior){
7234b5255acSdanielk1977     heightOfExpr(p->pWhere, pnHeight);
7244b5255acSdanielk1977     heightOfExpr(p->pHaving, pnHeight);
7254b5255acSdanielk1977     heightOfExpr(p->pLimit, pnHeight);
7264b5255acSdanielk1977     heightOfExprList(p->pEList, pnHeight);
7274b5255acSdanielk1977     heightOfExprList(p->pGroupBy, pnHeight);
7284b5255acSdanielk1977     heightOfExprList(p->pOrderBy, pnHeight);
7294b5255acSdanielk1977   }
7304b5255acSdanielk1977 }
7314b5255acSdanielk1977 
7324b5255acSdanielk1977 /*
7334b5255acSdanielk1977 ** Set the Expr.nHeight variable in the structure passed as an
7344b5255acSdanielk1977 ** argument. An expression with no children, Expr.pList or
7354b5255acSdanielk1977 ** Expr.pSelect member has a height of 1. Any other expression
7364b5255acSdanielk1977 ** has a height equal to the maximum height of any other
7374b5255acSdanielk1977 ** referenced Expr plus one.
7382308ed38Sdrh **
7392308ed38Sdrh ** Also propagate EP_Propagate flags up from Expr.x.pList to Expr.flags,
7402308ed38Sdrh ** if appropriate.
7414b5255acSdanielk1977 */
7424b5255acSdanielk1977 static void exprSetHeight(Expr *p){
7434b5255acSdanielk1977   int nHeight = 0;
7444b5255acSdanielk1977   heightOfExpr(p->pLeft, &nHeight);
7454b5255acSdanielk1977   heightOfExpr(p->pRight, &nHeight);
7466ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_xIsSelect) ){
7476ab3a2ecSdanielk1977     heightOfSelect(p->x.pSelect, &nHeight);
7482308ed38Sdrh   }else if( p->x.pList ){
7496ab3a2ecSdanielk1977     heightOfExprList(p->x.pList, &nHeight);
7502308ed38Sdrh     p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
7516ab3a2ecSdanielk1977   }
7524b5255acSdanielk1977   p->nHeight = nHeight + 1;
7534b5255acSdanielk1977 }
7544b5255acSdanielk1977 
7554b5255acSdanielk1977 /*
7564b5255acSdanielk1977 ** Set the Expr.nHeight variable using the exprSetHeight() function. If
7574b5255acSdanielk1977 ** the height is greater than the maximum allowed expression depth,
7584b5255acSdanielk1977 ** leave an error in pParse.
7592308ed38Sdrh **
7602308ed38Sdrh ** Also propagate all EP_Propagate flags from the Expr.x.pList into
7612308ed38Sdrh ** Expr.flags.
7624b5255acSdanielk1977 */
7632308ed38Sdrh void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
76474893a4cSdrh   if( pParse->nErr ) return;
7654b5255acSdanielk1977   exprSetHeight(p);
7667d10d5a6Sdrh   sqlite3ExprCheckHeight(pParse, p->nHeight);
7674b5255acSdanielk1977 }
7684b5255acSdanielk1977 
7694b5255acSdanielk1977 /*
7704b5255acSdanielk1977 ** Return the maximum height of any expression tree referenced
7714b5255acSdanielk1977 ** by the select statement passed as an argument.
7724b5255acSdanielk1977 */
7734b5255acSdanielk1977 int sqlite3SelectExprHeight(Select *p){
7744b5255acSdanielk1977   int nHeight = 0;
7754b5255acSdanielk1977   heightOfSelect(p, &nHeight);
7764b5255acSdanielk1977   return nHeight;
7774b5255acSdanielk1977 }
7782308ed38Sdrh #else /* ABOVE:  Height enforcement enabled.  BELOW: Height enforcement off */
7792308ed38Sdrh /*
7802308ed38Sdrh ** Propagate all EP_Propagate flags from the Expr.x.pList into
7812308ed38Sdrh ** Expr.flags.
7822308ed38Sdrh */
7832308ed38Sdrh void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
7846c3b4b07Sdan   if( pParse->nErr ) return;
7852308ed38Sdrh   if( p && p->x.pList && !ExprHasProperty(p, EP_xIsSelect) ){
7862308ed38Sdrh     p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
7872308ed38Sdrh   }
7882308ed38Sdrh }
7894b5255acSdanielk1977 #define exprSetHeight(y)
7904b5255acSdanielk1977 #endif /* SQLITE_MAX_EXPR_DEPTH>0 */
7914b5255acSdanielk1977 
792be5c89acSdrh /*
793b7916a78Sdrh ** This routine is the core allocator for Expr nodes.
794b7916a78Sdrh **
795a76b5dfcSdrh ** Construct a new expression node and return a pointer to it.  Memory
796b7916a78Sdrh ** for this node and for the pToken argument is a single allocation
797b7916a78Sdrh ** obtained from sqlite3DbMalloc().  The calling function
798a76b5dfcSdrh ** is responsible for making sure the node eventually gets freed.
799b7916a78Sdrh **
800b7916a78Sdrh ** If dequote is true, then the token (if it exists) is dequoted.
801e792b5b4Sdrh ** If dequote is false, no dequoting is performed.  The deQuote
802b7916a78Sdrh ** parameter is ignored if pToken is NULL or if the token does not
803b7916a78Sdrh ** appear to be quoted.  If the quotes were of the form "..." (double-quotes)
804b7916a78Sdrh ** then the EP_DblQuoted flag is set on the expression node.
80533e619fcSdrh **
80633e619fcSdrh ** Special case:  If op==TK_INTEGER and pToken points to a string that
80733e619fcSdrh ** can be translated into a 32-bit integer, then the token is not
80833e619fcSdrh ** stored in u.zToken.  Instead, the integer values is written
80933e619fcSdrh ** into u.iValue and the EP_IntValue flag is set.  No extra storage
81033e619fcSdrh ** is allocated to hold the integer text and the dequote flag is ignored.
811a76b5dfcSdrh */
812b7916a78Sdrh Expr *sqlite3ExprAlloc(
813cca8a4adSdrh   sqlite3 *db,            /* Handle for sqlite3DbMallocRawNN() */
81417435752Sdrh   int op,                 /* Expression opcode */
815b7916a78Sdrh   const Token *pToken,    /* Token argument.  Might be NULL */
816b7916a78Sdrh   int dequote             /* True to dequote */
81717435752Sdrh ){
818a76b5dfcSdrh   Expr *pNew;
81933e619fcSdrh   int nExtra = 0;
820cf697396Sshane   int iValue = 0;
821b7916a78Sdrh 
822575fad65Sdrh   assert( db!=0 );
823b7916a78Sdrh   if( pToken ){
82433e619fcSdrh     if( op!=TK_INTEGER || pToken->z==0
82533e619fcSdrh           || sqlite3GetInt32(pToken->z, &iValue)==0 ){
826b7916a78Sdrh       nExtra = pToken->n+1;
827d50ffc41Sdrh       assert( iValue>=0 );
82833e619fcSdrh     }
829a76b5dfcSdrh   }
830575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, sizeof(Expr)+nExtra);
831b7916a78Sdrh   if( pNew ){
832ca3862dcSdrh     memset(pNew, 0, sizeof(Expr));
8331bd10f8aSdrh     pNew->op = (u8)op;
834a58fdfb1Sdanielk1977     pNew->iAgg = -1;
835a76b5dfcSdrh     if( pToken ){
83633e619fcSdrh       if( nExtra==0 ){
837ad31727fSdrh         pNew->flags |= EP_IntValue|EP_Leaf|(iValue?EP_IsTrue:EP_IsFalse);
83833e619fcSdrh         pNew->u.iValue = iValue;
83933e619fcSdrh       }else{
84033e619fcSdrh         pNew->u.zToken = (char*)&pNew[1];
841b07028f7Sdrh         assert( pToken->z!=0 || pToken->n==0 );
842b07028f7Sdrh         if( pToken->n ) memcpy(pNew->u.zToken, pToken->z, pToken->n);
84333e619fcSdrh         pNew->u.zToken[pToken->n] = 0;
844244b9d6eSdrh         if( dequote && sqlite3Isquote(pNew->u.zToken[0]) ){
84551d35b0fSdrh           sqlite3DequoteExpr(pNew);
846a34001c9Sdrh         }
847a34001c9Sdrh       }
84833e619fcSdrh     }
849b7916a78Sdrh #if SQLITE_MAX_EXPR_DEPTH>0
850b7916a78Sdrh     pNew->nHeight = 1;
851b7916a78Sdrh #endif
852a34001c9Sdrh   }
853a76b5dfcSdrh   return pNew;
854a76b5dfcSdrh }
855a76b5dfcSdrh 
856a76b5dfcSdrh /*
857b7916a78Sdrh ** Allocate a new expression node from a zero-terminated token that has
858b7916a78Sdrh ** already been dequoted.
859b7916a78Sdrh */
860b7916a78Sdrh Expr *sqlite3Expr(
861b7916a78Sdrh   sqlite3 *db,            /* Handle for sqlite3DbMallocZero() (may be null) */
862b7916a78Sdrh   int op,                 /* Expression opcode */
863b7916a78Sdrh   const char *zToken      /* Token argument.  Might be NULL */
864b7916a78Sdrh ){
865b7916a78Sdrh   Token x;
866b7916a78Sdrh   x.z = zToken;
867b40f06c6Sdrh   x.n = sqlite3Strlen30(zToken);
868b7916a78Sdrh   return sqlite3ExprAlloc(db, op, &x, 0);
869b7916a78Sdrh }
870b7916a78Sdrh 
871b7916a78Sdrh /*
872b7916a78Sdrh ** Attach subtrees pLeft and pRight to the Expr node pRoot.
873b7916a78Sdrh **
874b7916a78Sdrh ** If pRoot==NULL that means that a memory allocation error has occurred.
875b7916a78Sdrh ** In that case, delete the subtrees pLeft and pRight.
876b7916a78Sdrh */
877b7916a78Sdrh void sqlite3ExprAttachSubtrees(
878b7916a78Sdrh   sqlite3 *db,
879b7916a78Sdrh   Expr *pRoot,
880b7916a78Sdrh   Expr *pLeft,
881b7916a78Sdrh   Expr *pRight
882b7916a78Sdrh ){
883b7916a78Sdrh   if( pRoot==0 ){
884b7916a78Sdrh     assert( db->mallocFailed );
885b7916a78Sdrh     sqlite3ExprDelete(db, pLeft);
886b7916a78Sdrh     sqlite3ExprDelete(db, pRight);
887b7916a78Sdrh   }else{
888b7916a78Sdrh     if( pRight ){
889b7916a78Sdrh       pRoot->pRight = pRight;
890885a5b03Sdrh       pRoot->flags |= EP_Propagate & pRight->flags;
891b7916a78Sdrh     }
892b7916a78Sdrh     if( pLeft ){
893b7916a78Sdrh       pRoot->pLeft = pLeft;
894885a5b03Sdrh       pRoot->flags |= EP_Propagate & pLeft->flags;
895b7916a78Sdrh     }
896b7916a78Sdrh     exprSetHeight(pRoot);
897b7916a78Sdrh   }
898b7916a78Sdrh }
899b7916a78Sdrh 
900b7916a78Sdrh /*
90160ec914cSpeter.d.reid ** Allocate an Expr node which joins as many as two subtrees.
902b7916a78Sdrh **
903bf664469Sdrh ** One or both of the subtrees can be NULL.  Return a pointer to the new
904bf664469Sdrh ** Expr node.  Or, if an OOM error occurs, set pParse->db->mallocFailed,
905bf664469Sdrh ** free the subtrees and return NULL.
906206f3d96Sdrh */
90717435752Sdrh Expr *sqlite3PExpr(
90817435752Sdrh   Parse *pParse,          /* Parsing context */
90917435752Sdrh   int op,                 /* Expression opcode */
91017435752Sdrh   Expr *pLeft,            /* Left operand */
911abfd35eaSdrh   Expr *pRight            /* Right operand */
91217435752Sdrh ){
9135fb52caaSdrh   Expr *p;
914abfd35eaSdrh   p = sqlite3DbMallocRawNN(pParse->db, sizeof(Expr));
915abfd35eaSdrh   if( p ){
916abfd35eaSdrh     memset(p, 0, sizeof(Expr));
917f1722baaSdrh     p->op = op & 0xff;
918abfd35eaSdrh     p->iAgg = -1;
919b7916a78Sdrh     sqlite3ExprAttachSubtrees(pParse->db, p, pLeft, pRight);
9202b359bdbSdan     sqlite3ExprCheckHeight(pParse, p->nHeight);
921d5c851c1Sdrh   }else{
922d5c851c1Sdrh     sqlite3ExprDelete(pParse->db, pLeft);
923d5c851c1Sdrh     sqlite3ExprDelete(pParse->db, pRight);
9242b359bdbSdan   }
9254e0cff60Sdrh   return p;
9264e0cff60Sdrh }
9274e0cff60Sdrh 
9284e0cff60Sdrh /*
92908de4f79Sdrh ** Add pSelect to the Expr.x.pSelect field.  Or, if pExpr is NULL (due
93008de4f79Sdrh ** do a memory allocation failure) then delete the pSelect object.
93108de4f79Sdrh */
93208de4f79Sdrh void sqlite3PExprAddSelect(Parse *pParse, Expr *pExpr, Select *pSelect){
93308de4f79Sdrh   if( pExpr ){
93408de4f79Sdrh     pExpr->x.pSelect = pSelect;
93508de4f79Sdrh     ExprSetProperty(pExpr, EP_xIsSelect|EP_Subquery);
93608de4f79Sdrh     sqlite3ExprSetHeightAndFlags(pParse, pExpr);
93708de4f79Sdrh   }else{
93808de4f79Sdrh     assert( pParse->db->mallocFailed );
93908de4f79Sdrh     sqlite3SelectDelete(pParse->db, pSelect);
94008de4f79Sdrh   }
94108de4f79Sdrh }
94208de4f79Sdrh 
94308de4f79Sdrh 
94408de4f79Sdrh /*
94591bb0eedSdrh ** Join two expressions using an AND operator.  If either expression is
94691bb0eedSdrh ** NULL, then just return the other expression.
9475fb52caaSdrh **
9485fb52caaSdrh ** If one side or the other of the AND is known to be false, then instead
9495fb52caaSdrh ** of returning an AND expression, just return a constant expression with
9505fb52caaSdrh ** a value of false.
95191bb0eedSdrh */
952d5c851c1Sdrh Expr *sqlite3ExprAnd(Parse *pParse, Expr *pLeft, Expr *pRight){
953d5c851c1Sdrh   sqlite3 *db = pParse->db;
95491bb0eedSdrh   if( pLeft==0  ){
95591bb0eedSdrh     return pRight;
95691bb0eedSdrh   }else if( pRight==0 ){
95791bb0eedSdrh     return pLeft;
9582b6e670fSdan   }else if( (ExprAlwaysFalse(pLeft) || ExprAlwaysFalse(pRight))
9592b6e670fSdan          && !IN_RENAME_OBJECT
9602b6e670fSdan   ){
9612b6e670fSdan     sqlite3ExprDelete(db, pLeft);
9622b6e670fSdan     sqlite3ExprDelete(db, pRight);
9635776ee5cSdrh     return sqlite3Expr(db, TK_INTEGER, "0");
96491bb0eedSdrh   }else{
965d5c851c1Sdrh     return sqlite3PExpr(pParse, TK_AND, pLeft, pRight);
966a76b5dfcSdrh   }
967a76b5dfcSdrh }
968a76b5dfcSdrh 
969a76b5dfcSdrh /*
970a76b5dfcSdrh ** Construct a new expression node for a function with multiple
971a76b5dfcSdrh ** arguments.
972a76b5dfcSdrh */
973954733b3Sdrh Expr *sqlite3ExprFunction(
974954733b3Sdrh   Parse *pParse,        /* Parsing context */
975954733b3Sdrh   ExprList *pList,      /* Argument list */
976954733b3Sdrh   Token *pToken,        /* Name of the function */
977954733b3Sdrh   int eDistinct         /* SF_Distinct or SF_ALL or 0 */
978954733b3Sdrh ){
979a76b5dfcSdrh   Expr *pNew;
980633e6d57Sdrh   sqlite3 *db = pParse->db;
9814b202ae2Sdanielk1977   assert( pToken );
982b7916a78Sdrh   pNew = sqlite3ExprAlloc(db, TK_FUNCTION, pToken, 1);
983a76b5dfcSdrh   if( pNew==0 ){
984d9da78a2Sdrh     sqlite3ExprListDelete(db, pList); /* Avoid memory leak when malloc fails */
985a76b5dfcSdrh     return 0;
986a76b5dfcSdrh   }
987954733b3Sdrh   if( pList && pList->nExpr > pParse->db->aLimit[SQLITE_LIMIT_FUNCTION_ARG] ){
988954733b3Sdrh     sqlite3ErrorMsg(pParse, "too many arguments on function %T", pToken);
989954733b3Sdrh   }
9906ab3a2ecSdanielk1977   pNew->x.pList = pList;
991fca23557Sdrh   ExprSetProperty(pNew, EP_HasFunc);
9926ab3a2ecSdanielk1977   assert( !ExprHasProperty(pNew, EP_xIsSelect) );
9932308ed38Sdrh   sqlite3ExprSetHeightAndFlags(pParse, pNew);
994954733b3Sdrh   if( eDistinct==SF_Distinct ) ExprSetProperty(pNew, EP_Distinct);
995a76b5dfcSdrh   return pNew;
996a76b5dfcSdrh }
997a76b5dfcSdrh 
998a76b5dfcSdrh /*
9990dfa5255Sdrh ** Check to see if a function is usable according to current access
10000dfa5255Sdrh ** rules:
10010dfa5255Sdrh **
10020dfa5255Sdrh **    SQLITE_FUNC_DIRECT    -     Only usable from top-level SQL
10030dfa5255Sdrh **
10040dfa5255Sdrh **    SQLITE_FUNC_UNSAFE    -     Usable if TRUSTED_SCHEMA or from
10050dfa5255Sdrh **                                top-level SQL
10060dfa5255Sdrh **
10070dfa5255Sdrh ** If the function is not usable, create an error.
10080dfa5255Sdrh */
10090dfa5255Sdrh void sqlite3ExprFunctionUsable(
10100dfa5255Sdrh   Parse *pParse,         /* Parsing and code generating context */
10110dfa5255Sdrh   Expr *pExpr,           /* The function invocation */
10120dfa5255Sdrh   FuncDef *pDef          /* The function being invoked */
10130dfa5255Sdrh ){
10140dfa5255Sdrh   assert( !IN_RENAME_OBJECT );
10152eeca204Sdrh   assert( (pDef->funcFlags & (SQLITE_FUNC_DIRECT|SQLITE_FUNC_UNSAFE))!=0 );
10162eeca204Sdrh   if( ExprHasProperty(pExpr, EP_FromDDL) ){
10170dfa5255Sdrh     if( (pDef->funcFlags & SQLITE_FUNC_DIRECT)!=0
10180dfa5255Sdrh      || (pParse->db->flags & SQLITE_TrustedSchema)==0
10190dfa5255Sdrh     ){
10200dfa5255Sdrh       /* Functions prohibited in triggers and views if:
10210dfa5255Sdrh       **     (1) tagged with SQLITE_DIRECTONLY
10220dfa5255Sdrh       **     (2) not tagged with SQLITE_INNOCUOUS (which means it
10230dfa5255Sdrh       **         is tagged with SQLITE_FUNC_UNSAFE) and
10240dfa5255Sdrh       **         SQLITE_DBCONFIG_TRUSTED_SCHEMA is off (meaning
10250dfa5255Sdrh       **         that the schema is possibly tainted).
10260dfa5255Sdrh       */
10270dfa5255Sdrh       sqlite3ErrorMsg(pParse, "unsafe use of %s()", pDef->zName);
10280dfa5255Sdrh     }
10290dfa5255Sdrh   }
10300dfa5255Sdrh }
10310dfa5255Sdrh 
10320dfa5255Sdrh /*
1033fa6bc000Sdrh ** Assign a variable number to an expression that encodes a wildcard
1034fa6bc000Sdrh ** in the original SQL statement.
1035fa6bc000Sdrh **
1036fa6bc000Sdrh ** Wildcards consisting of a single "?" are assigned the next sequential
1037fa6bc000Sdrh ** variable number.
1038fa6bc000Sdrh **
1039fa6bc000Sdrh ** Wildcards of the form "?nnn" are assigned the number "nnn".  We make
10409bf755ccSdrh ** sure "nnn" is not too big to avoid a denial of service attack when
1041fa6bc000Sdrh ** the SQL statement comes from an external source.
1042fa6bc000Sdrh **
104351f49f17Sdrh ** Wildcards of the form ":aaa", "@aaa", or "$aaa" are assigned the same number
1044fa6bc000Sdrh ** as the previous instance of the same wildcard.  Or if this is the first
104560ec914cSpeter.d.reid ** instance of the wildcard, the next sequential variable number is
1046fa6bc000Sdrh ** assigned.
1047fa6bc000Sdrh */
1048de25a88cSdrh void sqlite3ExprAssignVarNumber(Parse *pParse, Expr *pExpr, u32 n){
104917435752Sdrh   sqlite3 *db = pParse->db;
1050b7916a78Sdrh   const char *z;
1051f326d66dSdrh   ynVar x;
105217435752Sdrh 
1053fa6bc000Sdrh   if( pExpr==0 ) return;
1054c5cd1249Sdrh   assert( !ExprHasProperty(pExpr, EP_IntValue|EP_Reduced|EP_TokenOnly) );
105533e619fcSdrh   z = pExpr->u.zToken;
1056b7916a78Sdrh   assert( z!=0 );
1057b7916a78Sdrh   assert( z[0]!=0 );
1058b1ed717fSmistachkin   assert( n==(u32)sqlite3Strlen30(z) );
1059b7916a78Sdrh   if( z[1]==0 ){
1060fa6bc000Sdrh     /* Wildcard of the form "?".  Assign the next variable number */
1061b7916a78Sdrh     assert( z[0]=='?' );
1062f326d66dSdrh     x = (ynVar)(++pParse->nVar);
1063124c0b49Sdrh   }else{
1064f326d66dSdrh     int doAdd = 0;
1065124c0b49Sdrh     if( z[0]=='?' ){
1066fa6bc000Sdrh       /* Wildcard of the form "?nnn".  Convert "nnn" to an integer and
1067fa6bc000Sdrh       ** use it as the variable number */
1068c8d735aeSdan       i64 i;
106918814dfbSdrh       int bOk;
107018814dfbSdrh       if( n==2 ){ /*OPTIMIZATION-IF-TRUE*/
107118814dfbSdrh         i = z[1]-'0';  /* The common case of ?N for a single digit N */
107218814dfbSdrh         bOk = 1;
107318814dfbSdrh       }else{
107418814dfbSdrh         bOk = 0==sqlite3Atoi64(&z[1], &i, n-1, SQLITE_UTF8);
107518814dfbSdrh       }
1076c5499befSdrh       testcase( i==0 );
1077c5499befSdrh       testcase( i==1 );
1078c5499befSdrh       testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]-1 );
1079c5499befSdrh       testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] );
1080c8d735aeSdan       if( bOk==0 || i<1 || i>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
1081fa6bc000Sdrh         sqlite3ErrorMsg(pParse, "variable number must be between ?1 and ?%d",
1082bb4957f8Sdrh             db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]);
1083c9b39288Sdrh         return;
1084fa6bc000Sdrh       }
10858e74e7baSdrh       x = (ynVar)i;
1086f326d66dSdrh       if( x>pParse->nVar ){
1087f326d66dSdrh         pParse->nVar = (int)x;
1088f326d66dSdrh         doAdd = 1;
1089f326d66dSdrh       }else if( sqlite3VListNumToName(pParse->pVList, x)==0 ){
1090f326d66dSdrh         doAdd = 1;
1091fa6bc000Sdrh       }
1092fa6bc000Sdrh     }else{
109351f49f17Sdrh       /* Wildcards like ":aaa", "$aaa" or "@aaa".  Reuse the same variable
1094fa6bc000Sdrh       ** number as the prior appearance of the same name, or if the name
1095fa6bc000Sdrh       ** has never appeared before, reuse the same variable number
1096fa6bc000Sdrh       */
10979bf755ccSdrh       x = (ynVar)sqlite3VListNameToNum(pParse->pVList, z, n);
10989bf755ccSdrh       if( x==0 ){
10999bf755ccSdrh         x = (ynVar)(++pParse->nVar);
1100f326d66dSdrh         doAdd = 1;
1101f326d66dSdrh       }
1102f326d66dSdrh     }
1103f326d66dSdrh     if( doAdd ){
11049bf755ccSdrh       pParse->pVList = sqlite3VListAdd(db, pParse->pVList, z, n, x);
1105fa6bc000Sdrh     }
1106fa6bc000Sdrh   }
1107c9b39288Sdrh   pExpr->iColumn = x;
1108f326d66dSdrh   if( x>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
1109832b2664Sdanielk1977     sqlite3ErrorMsg(pParse, "too many SQL variables");
1110832b2664Sdanielk1977   }
1111fa6bc000Sdrh }
1112fa6bc000Sdrh 
1113fa6bc000Sdrh /*
1114f6963f99Sdan ** Recursively delete an expression tree.
1115a2e00042Sdrh */
11164f0010b1Sdrh static SQLITE_NOINLINE void sqlite3ExprDeleteNN(sqlite3 *db, Expr *p){
11174f0010b1Sdrh   assert( p!=0 );
1118d50ffc41Sdrh   /* Sanity check: Assert that the IntValue is non-negative if it exists */
1119d50ffc41Sdrh   assert( !ExprHasProperty(p, EP_IntValue) || p->u.iValue>=0 );
1120eda079cdSdrh 
1121eda079cdSdrh   assert( !ExprHasProperty(p, EP_WinFunc) || p->y.pWin!=0 || db->mallocFailed );
1122eda079cdSdrh   assert( p->op!=TK_FUNCTION || ExprHasProperty(p, EP_TokenOnly|EP_Reduced)
11234f9adee2Sdan           || p->y.pWin==0 || ExprHasProperty(p, EP_WinFunc) );
1124209bc522Sdrh #ifdef SQLITE_DEBUG
1125209bc522Sdrh   if( ExprHasProperty(p, EP_Leaf) && !ExprHasProperty(p, EP_TokenOnly) ){
1126209bc522Sdrh     assert( p->pLeft==0 );
1127209bc522Sdrh     assert( p->pRight==0 );
1128209bc522Sdrh     assert( p->x.pSelect==0 );
1129209bc522Sdrh   }
1130209bc522Sdrh #endif
1131209bc522Sdrh   if( !ExprHasProperty(p, (EP_TokenOnly|EP_Leaf)) ){
1132c5cd1249Sdrh     /* The Expr.x union is never used at the same time as Expr.pRight */
1133c5cd1249Sdrh     assert( p->x.pList==0 || p->pRight==0 );
11344910a76dSdrh     if( p->pLeft && p->op!=TK_SELECT_COLUMN ) sqlite3ExprDeleteNN(db, p->pLeft);
1135d1086679Sdrh     if( p->pRight ){
11364f9adee2Sdan       assert( !ExprHasProperty(p, EP_WinFunc) );
1137d1086679Sdrh       sqlite3ExprDeleteNN(db, p->pRight);
1138d1086679Sdrh     }else if( ExprHasProperty(p, EP_xIsSelect) ){
11394f9adee2Sdan       assert( !ExprHasProperty(p, EP_WinFunc) );
11406ab3a2ecSdanielk1977       sqlite3SelectDelete(db, p->x.pSelect);
11416ab3a2ecSdanielk1977     }else{
11426ab3a2ecSdanielk1977       sqlite3ExprListDelete(db, p->x.pList);
11436ba7ab0dSdan #ifndef SQLITE_OMIT_WINDOWFUNC
1144eda079cdSdrh       if( ExprHasProperty(p, EP_WinFunc) ){
1145eda079cdSdrh         sqlite3WindowDelete(db, p->y.pWin);
114686fb6e17Sdan       }
11476ba7ab0dSdan #endif
11486ab3a2ecSdanielk1977     }
11498117f113Sdan   }
1150209bc522Sdrh   if( ExprHasProperty(p, EP_MemToken) ) sqlite3DbFree(db, p->u.zToken);
115133e619fcSdrh   if( !ExprHasProperty(p, EP_Static) ){
1152dbd6a7dcSdrh     sqlite3DbFreeNN(db, p);
1153a2e00042Sdrh   }
115433e619fcSdrh }
11554f0010b1Sdrh void sqlite3ExprDelete(sqlite3 *db, Expr *p){
11564f0010b1Sdrh   if( p ) sqlite3ExprDeleteNN(db, p);
11574f0010b1Sdrh }
1158a2e00042Sdrh 
11598e34e406Sdrh /* Invoke sqlite3RenameExprUnmap() and sqlite3ExprDelete() on the
11608e34e406Sdrh ** expression.
11618e34e406Sdrh */
11628e34e406Sdrh void sqlite3ExprUnmapAndDelete(Parse *pParse, Expr *p){
11638e34e406Sdrh   if( p ){
11648e34e406Sdrh     if( IN_RENAME_OBJECT ){
11658e34e406Sdrh       sqlite3RenameExprUnmap(pParse, p);
11668e34e406Sdrh     }
11678e34e406Sdrh     sqlite3ExprDeleteNN(pParse->db, p);
11688e34e406Sdrh   }
11698e34e406Sdrh }
11708e34e406Sdrh 
1171d2687b77Sdrh /*
11726ab3a2ecSdanielk1977 ** Return the number of bytes allocated for the expression structure
11736ab3a2ecSdanielk1977 ** passed as the first argument. This is always one of EXPR_FULLSIZE,
11746ab3a2ecSdanielk1977 ** EXPR_REDUCEDSIZE or EXPR_TOKENONLYSIZE.
11756ab3a2ecSdanielk1977 */
11766ab3a2ecSdanielk1977 static int exprStructSize(Expr *p){
11776ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_TokenOnly) ) return EXPR_TOKENONLYSIZE;
11786ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_Reduced) ) return EXPR_REDUCEDSIZE;
11796ab3a2ecSdanielk1977   return EXPR_FULLSIZE;
11806ab3a2ecSdanielk1977 }
11816ab3a2ecSdanielk1977 
11826ab3a2ecSdanielk1977 /*
118333e619fcSdrh ** The dupedExpr*Size() routines each return the number of bytes required
118433e619fcSdrh ** to store a copy of an expression or expression tree.  They differ in
118533e619fcSdrh ** how much of the tree is measured.
118633e619fcSdrh **
118733e619fcSdrh **     dupedExprStructSize()     Size of only the Expr structure
118833e619fcSdrh **     dupedExprNodeSize()       Size of Expr + space for token
118933e619fcSdrh **     dupedExprSize()           Expr + token + subtree components
119033e619fcSdrh **
119133e619fcSdrh ***************************************************************************
119233e619fcSdrh **
119333e619fcSdrh ** The dupedExprStructSize() function returns two values OR-ed together:
119433e619fcSdrh ** (1) the space required for a copy of the Expr structure only and
119533e619fcSdrh ** (2) the EP_xxx flags that indicate what the structure size should be.
119633e619fcSdrh ** The return values is always one of:
119733e619fcSdrh **
119833e619fcSdrh **      EXPR_FULLSIZE
119933e619fcSdrh **      EXPR_REDUCEDSIZE   | EP_Reduced
120033e619fcSdrh **      EXPR_TOKENONLYSIZE | EP_TokenOnly
120133e619fcSdrh **
120233e619fcSdrh ** The size of the structure can be found by masking the return value
120333e619fcSdrh ** of this routine with 0xfff.  The flags can be found by masking the
120433e619fcSdrh ** return value with EP_Reduced|EP_TokenOnly.
120533e619fcSdrh **
120633e619fcSdrh ** Note that with flags==EXPRDUP_REDUCE, this routines works on full-size
120733e619fcSdrh ** (unreduced) Expr objects as they or originally constructed by the parser.
120833e619fcSdrh ** During expression analysis, extra information is computed and moved into
1209c95f38d4Sdan ** later parts of the Expr object and that extra information might get chopped
121033e619fcSdrh ** off if the expression is reduced.  Note also that it does not work to
121160ec914cSpeter.d.reid ** make an EXPRDUP_REDUCE copy of a reduced expression.  It is only legal
121233e619fcSdrh ** to reduce a pristine expression tree from the parser.  The implementation
121333e619fcSdrh ** of dupedExprStructSize() contain multiple assert() statements that attempt
121433e619fcSdrh ** to enforce this constraint.
12156ab3a2ecSdanielk1977 */
12166ab3a2ecSdanielk1977 static int dupedExprStructSize(Expr *p, int flags){
12176ab3a2ecSdanielk1977   int nSize;
121833e619fcSdrh   assert( flags==EXPRDUP_REDUCE || flags==0 ); /* Only one flag value allowed */
1219aecd8021Sdrh   assert( EXPR_FULLSIZE<=0xfff );
1220aecd8021Sdrh   assert( (0xfff & (EP_Reduced|EP_TokenOnly))==0 );
122167a9b8edSdan   if( 0==flags || p->op==TK_SELECT_COLUMN
122267a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
1223eda079cdSdrh    || ExprHasProperty(p, EP_WinFunc)
122467a9b8edSdan #endif
122567a9b8edSdan   ){
12266ab3a2ecSdanielk1977     nSize = EXPR_FULLSIZE;
12276ab3a2ecSdanielk1977   }else{
1228c5cd1249Sdrh     assert( !ExprHasProperty(p, EP_TokenOnly|EP_Reduced) );
122933e619fcSdrh     assert( !ExprHasProperty(p, EP_FromJoin) );
1230c5cd1249Sdrh     assert( !ExprHasProperty(p, EP_MemToken) );
1231e7375bfaSdrh     assert( !ExprHasVVAProperty(p, EP_NoReduce) );
1232aecd8021Sdrh     if( p->pLeft || p->x.pList ){
123333e619fcSdrh       nSize = EXPR_REDUCEDSIZE | EP_Reduced;
123433e619fcSdrh     }else{
1235aecd8021Sdrh       assert( p->pRight==0 );
123633e619fcSdrh       nSize = EXPR_TOKENONLYSIZE | EP_TokenOnly;
123733e619fcSdrh     }
12386ab3a2ecSdanielk1977   }
12396ab3a2ecSdanielk1977   return nSize;
12406ab3a2ecSdanielk1977 }
12416ab3a2ecSdanielk1977 
12426ab3a2ecSdanielk1977 /*
124333e619fcSdrh ** This function returns the space in bytes required to store the copy
124433e619fcSdrh ** of the Expr structure and a copy of the Expr.u.zToken string (if that
124533e619fcSdrh ** string is defined.)
12466ab3a2ecSdanielk1977 */
12476ab3a2ecSdanielk1977 static int dupedExprNodeSize(Expr *p, int flags){
124833e619fcSdrh   int nByte = dupedExprStructSize(p, flags) & 0xfff;
124933e619fcSdrh   if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
12507301e774Sdrh     nByte += sqlite3Strlen30NN(p->u.zToken)+1;
12516ab3a2ecSdanielk1977   }
1252bc73971dSdanielk1977   return ROUND8(nByte);
12536ab3a2ecSdanielk1977 }
12546ab3a2ecSdanielk1977 
12556ab3a2ecSdanielk1977 /*
12566ab3a2ecSdanielk1977 ** Return the number of bytes required to create a duplicate of the
12576ab3a2ecSdanielk1977 ** expression passed as the first argument. The second argument is a
12586ab3a2ecSdanielk1977 ** mask containing EXPRDUP_XXX flags.
12596ab3a2ecSdanielk1977 **
12606ab3a2ecSdanielk1977 ** The value returned includes space to create a copy of the Expr struct
126133e619fcSdrh ** itself and the buffer referred to by Expr.u.zToken, if any.
12626ab3a2ecSdanielk1977 **
12636ab3a2ecSdanielk1977 ** If the EXPRDUP_REDUCE flag is set, then the return value includes
12646ab3a2ecSdanielk1977 ** space to duplicate all Expr nodes in the tree formed by Expr.pLeft
12656ab3a2ecSdanielk1977 ** and Expr.pRight variables (but not for any structures pointed to or
12666ab3a2ecSdanielk1977 ** descended from the Expr.x.pList or Expr.x.pSelect variables).
12676ab3a2ecSdanielk1977 */
12686ab3a2ecSdanielk1977 static int dupedExprSize(Expr *p, int flags){
12696ab3a2ecSdanielk1977   int nByte = 0;
12706ab3a2ecSdanielk1977   if( p ){
12716ab3a2ecSdanielk1977     nByte = dupedExprNodeSize(p, flags);
12726ab3a2ecSdanielk1977     if( flags&EXPRDUP_REDUCE ){
1273b7916a78Sdrh       nByte += dupedExprSize(p->pLeft, flags) + dupedExprSize(p->pRight, flags);
12746ab3a2ecSdanielk1977     }
12756ab3a2ecSdanielk1977   }
12766ab3a2ecSdanielk1977   return nByte;
12776ab3a2ecSdanielk1977 }
12786ab3a2ecSdanielk1977 
12796ab3a2ecSdanielk1977 /*
12806ab3a2ecSdanielk1977 ** This function is similar to sqlite3ExprDup(), except that if pzBuffer
12816ab3a2ecSdanielk1977 ** is not NULL then *pzBuffer is assumed to point to a buffer large enough
128233e619fcSdrh ** to store the copy of expression p, the copies of p->u.zToken
12836ab3a2ecSdanielk1977 ** (if applicable), and the copies of the p->pLeft and p->pRight expressions,
128460ec914cSpeter.d.reid ** if any. Before returning, *pzBuffer is set to the first byte past the
12856ab3a2ecSdanielk1977 ** portion of the buffer copied into by this function.
12866ab3a2ecSdanielk1977 */
12873c19469cSdrh static Expr *exprDup(sqlite3 *db, Expr *p, int dupFlags, u8 **pzBuffer){
12883c19469cSdrh   Expr *pNew;           /* Value to return */
12893c19469cSdrh   u8 *zAlloc;           /* Memory space from which to build Expr object */
12903c19469cSdrh   u32 staticFlag;       /* EP_Static if space not obtained from malloc */
12916ab3a2ecSdanielk1977 
12923c19469cSdrh   assert( db!=0 );
12933c19469cSdrh   assert( p );
12943c19469cSdrh   assert( dupFlags==0 || dupFlags==EXPRDUP_REDUCE );
12953c19469cSdrh   assert( pzBuffer==0 || dupFlags==EXPRDUP_REDUCE );
12966ab3a2ecSdanielk1977 
12976ab3a2ecSdanielk1977   /* Figure out where to write the new Expr structure. */
12986ab3a2ecSdanielk1977   if( pzBuffer ){
12996ab3a2ecSdanielk1977     zAlloc = *pzBuffer;
130033e619fcSdrh     staticFlag = EP_Static;
13016ab3a2ecSdanielk1977   }else{
13023c19469cSdrh     zAlloc = sqlite3DbMallocRawNN(db, dupedExprSize(p, dupFlags));
13033c19469cSdrh     staticFlag = 0;
13046ab3a2ecSdanielk1977   }
13056ab3a2ecSdanielk1977   pNew = (Expr *)zAlloc;
13066ab3a2ecSdanielk1977 
13076ab3a2ecSdanielk1977   if( pNew ){
13086ab3a2ecSdanielk1977     /* Set nNewSize to the size allocated for the structure pointed to
13096ab3a2ecSdanielk1977     ** by pNew. This is either EXPR_FULLSIZE, EXPR_REDUCEDSIZE or
13106ab3a2ecSdanielk1977     ** EXPR_TOKENONLYSIZE. nToken is set to the number of bytes consumed
131133e619fcSdrh     ** by the copy of the p->u.zToken string (if any).
13126ab3a2ecSdanielk1977     */
13133c19469cSdrh     const unsigned nStructSize = dupedExprStructSize(p, dupFlags);
131433e619fcSdrh     const int nNewSize = nStructSize & 0xfff;
131533e619fcSdrh     int nToken;
131633e619fcSdrh     if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
131733e619fcSdrh       nToken = sqlite3Strlen30(p->u.zToken) + 1;
131833e619fcSdrh     }else{
131933e619fcSdrh       nToken = 0;
132033e619fcSdrh     }
13213c19469cSdrh     if( dupFlags ){
13226ab3a2ecSdanielk1977       assert( ExprHasProperty(p, EP_Reduced)==0 );
13236ab3a2ecSdanielk1977       memcpy(zAlloc, p, nNewSize);
13246ab3a2ecSdanielk1977     }else{
13253e6a1411Sdan       u32 nSize = (u32)exprStructSize(p);
13266ab3a2ecSdanielk1977       memcpy(zAlloc, p, nSize);
132772ea29d7Sdrh       if( nSize<EXPR_FULLSIZE ){
13286ab3a2ecSdanielk1977         memset(&zAlloc[nSize], 0, EXPR_FULLSIZE-nSize);
13296ab3a2ecSdanielk1977       }
133072ea29d7Sdrh     }
13316ab3a2ecSdanielk1977 
133233e619fcSdrh     /* Set the EP_Reduced, EP_TokenOnly, and EP_Static flags appropriately. */
1333c5cd1249Sdrh     pNew->flags &= ~(EP_Reduced|EP_TokenOnly|EP_Static|EP_MemToken);
133433e619fcSdrh     pNew->flags |= nStructSize & (EP_Reduced|EP_TokenOnly);
133533e619fcSdrh     pNew->flags |= staticFlag;
1336e7375bfaSdrh     ExprClearVVAProperties(pNew);
1337e7375bfaSdrh     if( dupFlags ){
1338e7375bfaSdrh       ExprSetVVAProperty(pNew, EP_Immutable);
1339e7375bfaSdrh     }
13406ab3a2ecSdanielk1977 
134133e619fcSdrh     /* Copy the p->u.zToken string, if any. */
13426ab3a2ecSdanielk1977     if( nToken ){
134333e619fcSdrh       char *zToken = pNew->u.zToken = (char*)&zAlloc[nNewSize];
134433e619fcSdrh       memcpy(zToken, p->u.zToken, nToken);
13456ab3a2ecSdanielk1977     }
13466ab3a2ecSdanielk1977 
1347209bc522Sdrh     if( 0==((p->flags|pNew->flags) & (EP_TokenOnly|EP_Leaf)) ){
13486ab3a2ecSdanielk1977       /* Fill in the pNew->x.pSelect or pNew->x.pList member. */
13496ab3a2ecSdanielk1977       if( ExprHasProperty(p, EP_xIsSelect) ){
13503c19469cSdrh         pNew->x.pSelect = sqlite3SelectDup(db, p->x.pSelect, dupFlags);
13516ab3a2ecSdanielk1977       }else{
13523c19469cSdrh         pNew->x.pList = sqlite3ExprListDup(db, p->x.pList, dupFlags);
13536ab3a2ecSdanielk1977       }
13546ab3a2ecSdanielk1977     }
13556ab3a2ecSdanielk1977 
13566ab3a2ecSdanielk1977     /* Fill in pNew->pLeft and pNew->pRight. */
13574f9adee2Sdan     if( ExprHasProperty(pNew, EP_Reduced|EP_TokenOnly|EP_WinFunc) ){
13583c19469cSdrh       zAlloc += dupedExprNodeSize(p, dupFlags);
1359209bc522Sdrh       if( !ExprHasProperty(pNew, EP_TokenOnly|EP_Leaf) ){
13603c19469cSdrh         pNew->pLeft = p->pLeft ?
13613c19469cSdrh                       exprDup(db, p->pLeft, EXPRDUP_REDUCE, &zAlloc) : 0;
13623c19469cSdrh         pNew->pRight = p->pRight ?
13633c19469cSdrh                        exprDup(db, p->pRight, EXPRDUP_REDUCE, &zAlloc) : 0;
13646ab3a2ecSdanielk1977       }
136567a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
1366eda079cdSdrh       if( ExprHasProperty(p, EP_WinFunc) ){
1367eda079cdSdrh         pNew->y.pWin = sqlite3WindowDup(db, pNew, p->y.pWin);
1368eda079cdSdrh         assert( ExprHasProperty(pNew, EP_WinFunc) );
1369e2f781b9Sdan       }
137067a9b8edSdan #endif /* SQLITE_OMIT_WINDOWFUNC */
137153988068Sdrh       if( pzBuffer ){
137253988068Sdrh         *pzBuffer = zAlloc;
137353988068Sdrh       }
137453988068Sdrh     }else{
1375209bc522Sdrh       if( !ExprHasProperty(p, EP_TokenOnly|EP_Leaf) ){
13769854260bSdrh         if( pNew->op==TK_SELECT_COLUMN ){
13779854260bSdrh           pNew->pLeft = p->pLeft;
137847073f62Sdrh           assert( p->iColumn==0 || p->pRight==0 );
137947073f62Sdrh           assert( p->pRight==0  || p->pRight==p->pLeft );
13809854260bSdrh         }else{
13816ab3a2ecSdanielk1977           pNew->pLeft = sqlite3ExprDup(db, p->pLeft, 0);
13829854260bSdrh         }
13836ab3a2ecSdanielk1977         pNew->pRight = sqlite3ExprDup(db, p->pRight, 0);
13846ab3a2ecSdanielk1977       }
13856ab3a2ecSdanielk1977     }
13866ab3a2ecSdanielk1977   }
13876ab3a2ecSdanielk1977   return pNew;
13886ab3a2ecSdanielk1977 }
13896ab3a2ecSdanielk1977 
13906ab3a2ecSdanielk1977 /*
1391bfe31e7fSdan ** Create and return a deep copy of the object passed as the second
1392bfe31e7fSdan ** argument. If an OOM condition is encountered, NULL is returned
1393bfe31e7fSdan ** and the db->mallocFailed flag set.
1394bfe31e7fSdan */
1395eede6a53Sdan #ifndef SQLITE_OMIT_CTE
1396bfe31e7fSdan static With *withDup(sqlite3 *db, With *p){
13974e9119d9Sdan   With *pRet = 0;
13984e9119d9Sdan   if( p ){
1399d4de9f7bSdrh     sqlite3_int64 nByte = sizeof(*p) + sizeof(p->a[0]) * (p->nCte-1);
14004e9119d9Sdan     pRet = sqlite3DbMallocZero(db, nByte);
14014e9119d9Sdan     if( pRet ){
14024e9119d9Sdan       int i;
14034e9119d9Sdan       pRet->nCte = p->nCte;
14044e9119d9Sdan       for(i=0; i<p->nCte; i++){
14054e9119d9Sdan         pRet->a[i].pSelect = sqlite3SelectDup(db, p->a[i].pSelect, 0);
14064e9119d9Sdan         pRet->a[i].pCols = sqlite3ExprListDup(db, p->a[i].pCols, 0);
14074e9119d9Sdan         pRet->a[i].zName = sqlite3DbStrDup(db, p->a[i].zName);
14084e9119d9Sdan       }
14094e9119d9Sdan     }
14104e9119d9Sdan   }
14114e9119d9Sdan   return pRet;
14124e9119d9Sdan }
1413eede6a53Sdan #else
1414eede6a53Sdan # define withDup(x,y) 0
1415eede6a53Sdan #endif
14164e9119d9Sdan 
1417a8389975Sdrh #ifndef SQLITE_OMIT_WINDOWFUNC
1418a8389975Sdrh /*
1419a8389975Sdrh ** The gatherSelectWindows() procedure and its helper routine
1420a8389975Sdrh ** gatherSelectWindowsCallback() are used to scan all the expressions
1421a8389975Sdrh ** an a newly duplicated SELECT statement and gather all of the Window
1422a8389975Sdrh ** objects found there, assembling them onto the linked list at Select->pWin.
1423a8389975Sdrh */
1424a8389975Sdrh static int gatherSelectWindowsCallback(Walker *pWalker, Expr *pExpr){
14256ba7ab0dSdan   if( pExpr->op==TK_FUNCTION && ExprHasProperty(pExpr, EP_WinFunc) ){
142675b0821eSdan     Select *pSelect = pWalker->u.pSelect;
142775b0821eSdan     Window *pWin = pExpr->y.pWin;
142875b0821eSdan     assert( pWin );
14294f9adee2Sdan     assert( IsWindowFunc(pExpr) );
1430e0ae3f69Sdan     assert( pWin->ppThis==0 );
1431a3fcc000Sdan     sqlite3WindowLink(pSelect, pWin);
1432a8389975Sdrh   }
1433a8389975Sdrh   return WRC_Continue;
1434a8389975Sdrh }
1435a37b6a5eSdrh static int gatherSelectWindowsSelectCallback(Walker *pWalker, Select *p){
1436a37b6a5eSdrh   return p==pWalker->u.pSelect ? WRC_Continue : WRC_Prune;
1437a37b6a5eSdrh }
1438a8389975Sdrh static void gatherSelectWindows(Select *p){
1439a8389975Sdrh   Walker w;
1440a8389975Sdrh   w.xExprCallback = gatherSelectWindowsCallback;
1441a37b6a5eSdrh   w.xSelectCallback = gatherSelectWindowsSelectCallback;
1442a37b6a5eSdrh   w.xSelectCallback2 = 0;
14439c46c66cSdrh   w.pParse = 0;
1444a8389975Sdrh   w.u.pSelect = p;
1445a37b6a5eSdrh   sqlite3WalkSelect(&w, p);
1446a8389975Sdrh }
1447a8389975Sdrh #endif
1448a8389975Sdrh 
1449a8389975Sdrh 
1450a76b5dfcSdrh /*
1451ff78bd2fSdrh ** The following group of routines make deep copies of expressions,
1452ff78bd2fSdrh ** expression lists, ID lists, and select statements.  The copies can
1453ff78bd2fSdrh ** be deleted (by being passed to their respective ...Delete() routines)
1454ff78bd2fSdrh ** without effecting the originals.
1455ff78bd2fSdrh **
14564adee20fSdanielk1977 ** The expression list, ID, and source lists return by sqlite3ExprListDup(),
14574adee20fSdanielk1977 ** sqlite3IdListDup(), and sqlite3SrcListDup() can not be further expanded
1458ad3cab52Sdrh ** by subsequent calls to sqlite*ListAppend() routines.
1459ff78bd2fSdrh **
1460ad3cab52Sdrh ** Any tables that the SrcList might point to are not duplicated.
14616ab3a2ecSdanielk1977 **
1462b7916a78Sdrh ** The flags parameter contains a combination of the EXPRDUP_XXX flags.
14636ab3a2ecSdanielk1977 ** If the EXPRDUP_REDUCE flag is set, then the structure returned is a
14646ab3a2ecSdanielk1977 ** truncated version of the usual Expr structure that will be stored as
14656ab3a2ecSdanielk1977 ** part of the in-memory representation of the database schema.
1466ff78bd2fSdrh */
14676ab3a2ecSdanielk1977 Expr *sqlite3ExprDup(sqlite3 *db, Expr *p, int flags){
146872ea29d7Sdrh   assert( flags==0 || flags==EXPRDUP_REDUCE );
14693c19469cSdrh   return p ? exprDup(db, p, flags, 0) : 0;
1470ff78bd2fSdrh }
14716ab3a2ecSdanielk1977 ExprList *sqlite3ExprListDup(sqlite3 *db, ExprList *p, int flags){
1472ff78bd2fSdrh   ExprList *pNew;
1473145716b3Sdrh   struct ExprList_item *pItem, *pOldItem;
1474ff78bd2fSdrh   int i;
1475b163748eSdrh   Expr *pPriorSelectCol = 0;
1476575fad65Sdrh   assert( db!=0 );
1477ff78bd2fSdrh   if( p==0 ) return 0;
147897258194Sdrh   pNew = sqlite3DbMallocRawNN(db, sqlite3DbMallocSize(db, p));
1479ff78bd2fSdrh   if( pNew==0 ) return 0;
1480a19543feSdrh   pNew->nExpr = p->nExpr;
148143606175Sdrh   pItem = pNew->a;
1482145716b3Sdrh   pOldItem = p->a;
1483145716b3Sdrh   for(i=0; i<p->nExpr; i++, pItem++, pOldItem++){
14846ab3a2ecSdanielk1977     Expr *pOldExpr = pOldItem->pExpr;
148547073f62Sdrh     Expr *pNewExpr;
1486b5526ea6Sdrh     pItem->pExpr = sqlite3ExprDup(db, pOldExpr, flags);
148747073f62Sdrh     if( pOldExpr
148847073f62Sdrh      && pOldExpr->op==TK_SELECT_COLUMN
148947073f62Sdrh      && (pNewExpr = pItem->pExpr)!=0
149047073f62Sdrh     ){
149147073f62Sdrh       assert( pNewExpr->iColumn==0 || i>0 );
149247073f62Sdrh       if( pNewExpr->iColumn==0 ){
149347073f62Sdrh         assert( pOldExpr->pLeft==pOldExpr->pRight );
1494b163748eSdrh         pPriorSelectCol = pNewExpr->pLeft = pNewExpr->pRight;
1495b163748eSdrh       }else{
1496b163748eSdrh         assert( i>0 );
1497b163748eSdrh         assert( pItem[-1].pExpr!=0 );
1498b163748eSdrh         assert( pNewExpr->iColumn==pItem[-1].pExpr->iColumn+1 );
1499b163748eSdrh         assert( pPriorSelectCol==pItem[-1].pExpr->pLeft );
1500b163748eSdrh         pNewExpr->pLeft = pPriorSelectCol;
150147073f62Sdrh       }
150247073f62Sdrh     }
150341cee668Sdrh     pItem->zEName = sqlite3DbStrDup(db, pOldItem->zEName);
15046e11892dSdan     pItem->sortFlags = pOldItem->sortFlags;
1505cbb9da33Sdrh     pItem->eEName = pOldItem->eEName;
15063e7bc9caSdrh     pItem->done = 0;
1507ae8e45cbSdan     pItem->bNulls = pOldItem->bNulls;
150824e25d32Sdan     pItem->bSorterRef = pOldItem->bSorterRef;
1509c2acc4e4Sdrh     pItem->u = pOldItem->u;
1510ff78bd2fSdrh   }
1511ff78bd2fSdrh   return pNew;
1512ff78bd2fSdrh }
151393758c8dSdanielk1977 
151493758c8dSdanielk1977 /*
151593758c8dSdanielk1977 ** If cursors, triggers, views and subqueries are all omitted from
151693758c8dSdanielk1977 ** the build, then none of the following routines, except for
151793758c8dSdanielk1977 ** sqlite3SelectDup(), can be called. sqlite3SelectDup() is sometimes
151893758c8dSdanielk1977 ** called with a NULL argument.
151993758c8dSdanielk1977 */
15206a67fe8eSdanielk1977 #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_TRIGGER) \
15216a67fe8eSdanielk1977  || !defined(SQLITE_OMIT_SUBQUERY)
15226ab3a2ecSdanielk1977 SrcList *sqlite3SrcListDup(sqlite3 *db, SrcList *p, int flags){
1523ad3cab52Sdrh   SrcList *pNew;
1524ad3cab52Sdrh   int i;
1525113088ecSdrh   int nByte;
1526575fad65Sdrh   assert( db!=0 );
1527ad3cab52Sdrh   if( p==0 ) return 0;
1528113088ecSdrh   nByte = sizeof(*p) + (p->nSrc>0 ? sizeof(p->a[0]) * (p->nSrc-1) : 0);
1529575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, nByte );
1530ad3cab52Sdrh   if( pNew==0 ) return 0;
15314305d103Sdrh   pNew->nSrc = pNew->nAlloc = p->nSrc;
1532ad3cab52Sdrh   for(i=0; i<p->nSrc; i++){
15337601294aSdrh     SrcItem *pNewItem = &pNew->a[i];
15347601294aSdrh     SrcItem *pOldItem = &p->a[i];
1535ed8a3bb1Sdrh     Table *pTab;
153641fb5cd1Sdan     pNewItem->pSchema = pOldItem->pSchema;
153717435752Sdrh     pNewItem->zDatabase = sqlite3DbStrDup(db, pOldItem->zDatabase);
153817435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
153917435752Sdrh     pNewItem->zAlias = sqlite3DbStrDup(db, pOldItem->zAlias);
15408a48b9c0Sdrh     pNewItem->fg = pOldItem->fg;
15414efc4754Sdrh     pNewItem->iCursor = pOldItem->iCursor;
15425b6a9ed4Sdrh     pNewItem->addrFillSub = pOldItem->addrFillSub;
15435b6a9ed4Sdrh     pNewItem->regReturn = pOldItem->regReturn;
15448a48b9c0Sdrh     if( pNewItem->fg.isIndexedBy ){
15458a48b9c0Sdrh       pNewItem->u1.zIndexedBy = sqlite3DbStrDup(db, pOldItem->u1.zIndexedBy);
15468a48b9c0Sdrh     }
1547*a79e2a2dSdrh     pNewItem->u2 = pOldItem->u2;
1548*a79e2a2dSdrh     if( pNewItem->fg.isCte ){
1549*a79e2a2dSdrh       pNewItem->u2.pCteUse->nUse++;
1550*a79e2a2dSdrh     }
15518a48b9c0Sdrh     if( pNewItem->fg.isTabFunc ){
15528a48b9c0Sdrh       pNewItem->u1.pFuncArg =
15538a48b9c0Sdrh           sqlite3ExprListDup(db, pOldItem->u1.pFuncArg, flags);
15548a48b9c0Sdrh     }
1555ed8a3bb1Sdrh     pTab = pNewItem->pTab = pOldItem->pTab;
1556ed8a3bb1Sdrh     if( pTab ){
155779df7782Sdrh       pTab->nTabRef++;
1558a1cb183dSdanielk1977     }
15596ab3a2ecSdanielk1977     pNewItem->pSelect = sqlite3SelectDup(db, pOldItem->pSelect, flags);
15606ab3a2ecSdanielk1977     pNewItem->pOn = sqlite3ExprDup(db, pOldItem->pOn, flags);
156117435752Sdrh     pNewItem->pUsing = sqlite3IdListDup(db, pOldItem->pUsing);
15626c18b6e0Sdanielk1977     pNewItem->colUsed = pOldItem->colUsed;
1563ad3cab52Sdrh   }
1564ad3cab52Sdrh   return pNew;
1565ad3cab52Sdrh }
156617435752Sdrh IdList *sqlite3IdListDup(sqlite3 *db, IdList *p){
1567ff78bd2fSdrh   IdList *pNew;
1568ff78bd2fSdrh   int i;
1569575fad65Sdrh   assert( db!=0 );
1570ff78bd2fSdrh   if( p==0 ) return 0;
1571575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, sizeof(*pNew) );
1572ff78bd2fSdrh   if( pNew==0 ) return 0;
15736c535158Sdrh   pNew->nId = p->nId;
1574575fad65Sdrh   pNew->a = sqlite3DbMallocRawNN(db, p->nId*sizeof(p->a[0]) );
1575d5d56523Sdanielk1977   if( pNew->a==0 ){
1576dbd6a7dcSdrh     sqlite3DbFreeNN(db, pNew);
1577d5d56523Sdanielk1977     return 0;
1578d5d56523Sdanielk1977   }
15796c535158Sdrh   /* Note that because the size of the allocation for p->a[] is not
15806c535158Sdrh   ** necessarily a power of two, sqlite3IdListAppend() may not be called
15816c535158Sdrh   ** on the duplicate created by this function. */
1582ff78bd2fSdrh   for(i=0; i<p->nId; i++){
15834efc4754Sdrh     struct IdList_item *pNewItem = &pNew->a[i];
15844efc4754Sdrh     struct IdList_item *pOldItem = &p->a[i];
158517435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
15864efc4754Sdrh     pNewItem->idx = pOldItem->idx;
1587ff78bd2fSdrh   }
1588ff78bd2fSdrh   return pNew;
1589ff78bd2fSdrh }
1590a7466205Sdan Select *sqlite3SelectDup(sqlite3 *db, Select *pDup, int flags){
1591a7466205Sdan   Select *pRet = 0;
1592a7466205Sdan   Select *pNext = 0;
1593a7466205Sdan   Select **pp = &pRet;
1594a7466205Sdan   Select *p;
1595a7466205Sdan 
1596575fad65Sdrh   assert( db!=0 );
1597a7466205Sdan   for(p=pDup; p; p=p->pPrior){
1598a7466205Sdan     Select *pNew = sqlite3DbMallocRawNN(db, sizeof(*p) );
1599a7466205Sdan     if( pNew==0 ) break;
1600b7916a78Sdrh     pNew->pEList = sqlite3ExprListDup(db, p->pEList, flags);
16016ab3a2ecSdanielk1977     pNew->pSrc = sqlite3SrcListDup(db, p->pSrc, flags);
16026ab3a2ecSdanielk1977     pNew->pWhere = sqlite3ExprDup(db, p->pWhere, flags);
16036ab3a2ecSdanielk1977     pNew->pGroupBy = sqlite3ExprListDup(db, p->pGroupBy, flags);
16046ab3a2ecSdanielk1977     pNew->pHaving = sqlite3ExprDup(db, p->pHaving, flags);
16056ab3a2ecSdanielk1977     pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, flags);
1606ff78bd2fSdrh     pNew->op = p->op;
1607a7466205Sdan     pNew->pNext = pNext;
1608a7466205Sdan     pNew->pPrior = 0;
16096ab3a2ecSdanielk1977     pNew->pLimit = sqlite3ExprDup(db, p->pLimit, flags);
161092b01d53Sdrh     pNew->iLimit = 0;
161192b01d53Sdrh     pNew->iOffset = 0;
16127d10d5a6Sdrh     pNew->selFlags = p->selFlags & ~SF_UsesEphemeral;
1613b9bb7c18Sdrh     pNew->addrOpenEphm[0] = -1;
1614b9bb7c18Sdrh     pNew->addrOpenEphm[1] = -1;
1615ec2da854Sdrh     pNew->nSelectRow = p->nSelectRow;
16164e9119d9Sdan     pNew->pWith = withDup(db, p->pWith);
161767a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
16182e362f97Sdan     pNew->pWin = 0;
1619c95f38d4Sdan     pNew->pWinDefn = sqlite3WindowListDup(db, p->pWinDefn);
16204780b9adSdan     if( p->pWin && db->mallocFailed==0 ) gatherSelectWindows(pNew);
162167a9b8edSdan #endif
1622fef37760Sdrh     pNew->selId = p->selId;
1623a7466205Sdan     *pp = pNew;
1624a7466205Sdan     pp = &pNew->pPrior;
1625a7466205Sdan     pNext = pNew;
1626a7466205Sdan   }
1627a7466205Sdan 
1628a7466205Sdan   return pRet;
1629ff78bd2fSdrh }
163093758c8dSdanielk1977 #else
16316ab3a2ecSdanielk1977 Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
163293758c8dSdanielk1977   assert( p==0 );
163393758c8dSdanielk1977   return 0;
163493758c8dSdanielk1977 }
163593758c8dSdanielk1977 #endif
1636ff78bd2fSdrh 
1637ff78bd2fSdrh 
1638ff78bd2fSdrh /*
1639a76b5dfcSdrh ** Add a new element to the end of an expression list.  If pList is
1640a76b5dfcSdrh ** initially NULL, then create a new expression list.
1641b7916a78Sdrh **
1642a19543feSdrh ** The pList argument must be either NULL or a pointer to an ExprList
1643a19543feSdrh ** obtained from a prior call to sqlite3ExprListAppend().  This routine
1644a19543feSdrh ** may not be used with an ExprList obtained from sqlite3ExprListDup().
1645a19543feSdrh ** Reason:  This routine assumes that the number of slots in pList->a[]
1646a19543feSdrh ** is a power of two.  That is true for sqlite3ExprListAppend() returns
1647a19543feSdrh ** but is not necessarily true from the return value of sqlite3ExprListDup().
1648a19543feSdrh **
1649b7916a78Sdrh ** If a memory allocation error occurs, the entire list is freed and
1650b7916a78Sdrh ** NULL is returned.  If non-NULL is returned, then it is guaranteed
1651b7916a78Sdrh ** that the new entry was successfully appended.
1652a76b5dfcSdrh */
165317435752Sdrh ExprList *sqlite3ExprListAppend(
165417435752Sdrh   Parse *pParse,          /* Parsing context */
165517435752Sdrh   ExprList *pList,        /* List to which to append. Might be NULL */
1656b7916a78Sdrh   Expr *pExpr             /* Expression to be appended. Might be NULL */
165717435752Sdrh ){
165843606175Sdrh   struct ExprList_item *pItem;
165917435752Sdrh   sqlite3 *db = pParse->db;
1660575fad65Sdrh   assert( db!=0 );
1661a76b5dfcSdrh   if( pList==0 ){
1662575fad65Sdrh     pList = sqlite3DbMallocRawNN(db, sizeof(ExprList) );
1663a76b5dfcSdrh     if( pList==0 ){
1664d5d56523Sdanielk1977       goto no_mem;
1665a76b5dfcSdrh     }
1666c263f7c4Sdrh     pList->nExpr = 0;
1667a19543feSdrh   }else if( (pList->nExpr & (pList->nExpr-1))==0 ){
166843606175Sdrh     ExprList *pNew;
166943606175Sdrh     pNew = sqlite3DbRealloc(db, pList,
16700aa3231fSdrh          sizeof(*pList)+(2*(sqlite3_int64)pList->nExpr-1)*sizeof(pList->a[0]));
167143606175Sdrh     if( pNew==0 ){
1672d5d56523Sdanielk1977       goto no_mem;
1673a76b5dfcSdrh     }
167443606175Sdrh     pList = pNew;
1675a76b5dfcSdrh   }
167643606175Sdrh   pItem = &pList->a[pList->nExpr++];
167741cee668Sdrh   assert( offsetof(struct ExprList_item,zEName)==sizeof(pItem->pExpr) );
1678a8b9793cSdrh   assert( offsetof(struct ExprList_item,pExpr)==0 );
167941cee668Sdrh   memset(&pItem->zEName,0,sizeof(*pItem)-offsetof(struct ExprList_item,zEName));
1680e94ddc9eSdanielk1977   pItem->pExpr = pExpr;
1681a76b5dfcSdrh   return pList;
1682d5d56523Sdanielk1977 
1683d5d56523Sdanielk1977 no_mem:
1684d5d56523Sdanielk1977   /* Avoid leaking memory if malloc has failed. */
1685633e6d57Sdrh   sqlite3ExprDelete(db, pExpr);
1686633e6d57Sdrh   sqlite3ExprListDelete(db, pList);
1687d5d56523Sdanielk1977   return 0;
1688a76b5dfcSdrh }
1689a76b5dfcSdrh 
1690a76b5dfcSdrh /*
16918762ec19Sdrh ** pColumns and pExpr form a vector assignment which is part of the SET
16928762ec19Sdrh ** clause of an UPDATE statement.  Like this:
1693a1251bc4Sdrh **
1694a1251bc4Sdrh **        (a,b,c) = (expr1,expr2,expr3)
1695a1251bc4Sdrh ** Or:    (a,b,c) = (SELECT x,y,z FROM ....)
1696a1251bc4Sdrh **
1697a1251bc4Sdrh ** For each term of the vector assignment, append new entries to the
1698b67343d0Sdrh ** expression list pList.  In the case of a subquery on the RHS, append
1699a1251bc4Sdrh ** TK_SELECT_COLUMN expressions.
1700a1251bc4Sdrh */
1701a1251bc4Sdrh ExprList *sqlite3ExprListAppendVector(
1702a1251bc4Sdrh   Parse *pParse,         /* Parsing context */
1703a1251bc4Sdrh   ExprList *pList,       /* List to which to append. Might be NULL */
1704a1251bc4Sdrh   IdList *pColumns,      /* List of names of LHS of the assignment */
1705a1251bc4Sdrh   Expr *pExpr            /* Vector expression to be appended. Might be NULL */
1706a1251bc4Sdrh ){
1707a1251bc4Sdrh   sqlite3 *db = pParse->db;
1708a1251bc4Sdrh   int n;
1709a1251bc4Sdrh   int i;
171066860af3Sdrh   int iFirst = pList ? pList->nExpr : 0;
1711321e828dSdrh   /* pColumns can only be NULL due to an OOM but an OOM will cause an
1712321e828dSdrh   ** exit prior to this routine being invoked */
1713321e828dSdrh   if( NEVER(pColumns==0) ) goto vector_append_error;
1714a1251bc4Sdrh   if( pExpr==0 ) goto vector_append_error;
1715966e2911Sdrh 
1716966e2911Sdrh   /* If the RHS is a vector, then we can immediately check to see that
1717966e2911Sdrh   ** the size of the RHS and LHS match.  But if the RHS is a SELECT,
1718966e2911Sdrh   ** wildcards ("*") in the result set of the SELECT must be expanded before
1719966e2911Sdrh   ** we can do the size check, so defer the size check until code generation.
1720966e2911Sdrh   */
1721966e2911Sdrh   if( pExpr->op!=TK_SELECT && pColumns->nId!=(n=sqlite3ExprVectorSize(pExpr)) ){
1722a1251bc4Sdrh     sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
1723a1251bc4Sdrh                     pColumns->nId, n);
1724a1251bc4Sdrh     goto vector_append_error;
1725a1251bc4Sdrh   }
1726966e2911Sdrh 
1727966e2911Sdrh   for(i=0; i<pColumns->nId; i++){
1728a1251bc4Sdrh     Expr *pSubExpr = sqlite3ExprForVectorField(pParse, pExpr, i);
1729554a9dc7Sdrh     assert( pSubExpr!=0 || db->mallocFailed );
1730554a9dc7Sdrh     assert( pSubExpr==0 || pSubExpr->iTable==0 );
1731554a9dc7Sdrh     if( pSubExpr==0 ) continue;
1732554a9dc7Sdrh     pSubExpr->iTable = pColumns->nId;
1733a1251bc4Sdrh     pList = sqlite3ExprListAppend(pParse, pList, pSubExpr);
1734a1251bc4Sdrh     if( pList ){
173566860af3Sdrh       assert( pList->nExpr==iFirst+i+1 );
173641cee668Sdrh       pList->a[pList->nExpr-1].zEName = pColumns->a[i].zName;
1737a1251bc4Sdrh       pColumns->a[i].zName = 0;
1738a1251bc4Sdrh     }
1739a1251bc4Sdrh   }
1740966e2911Sdrh 
1741ffe28059Sdrh   if( !db->mallocFailed && pExpr->op==TK_SELECT && ALWAYS(pList!=0) ){
1742966e2911Sdrh     Expr *pFirst = pList->a[iFirst].pExpr;
1743f4dd26c5Sdrh     assert( pFirst!=0 );
1744966e2911Sdrh     assert( pFirst->op==TK_SELECT_COLUMN );
1745966e2911Sdrh 
1746966e2911Sdrh     /* Store the SELECT statement in pRight so it will be deleted when
1747966e2911Sdrh     ** sqlite3ExprListDelete() is called */
1748966e2911Sdrh     pFirst->pRight = pExpr;
1749a1251bc4Sdrh     pExpr = 0;
1750966e2911Sdrh 
1751966e2911Sdrh     /* Remember the size of the LHS in iTable so that we can check that
1752966e2911Sdrh     ** the RHS and LHS sizes match during code generation. */
1753966e2911Sdrh     pFirst->iTable = pColumns->nId;
1754a1251bc4Sdrh   }
1755a1251bc4Sdrh 
1756a1251bc4Sdrh vector_append_error:
17578e34e406Sdrh   sqlite3ExprUnmapAndDelete(pParse, pExpr);
1758a1251bc4Sdrh   sqlite3IdListDelete(db, pColumns);
1759a1251bc4Sdrh   return pList;
1760a1251bc4Sdrh }
1761a1251bc4Sdrh 
1762a1251bc4Sdrh /*
1763bc622bc0Sdrh ** Set the sort order for the last element on the given ExprList.
1764bc622bc0Sdrh */
17656e11892dSdan void sqlite3ExprListSetSortOrder(ExprList *p, int iSortOrder, int eNulls){
17669105fd51Sdan   struct ExprList_item *pItem;
1767bc622bc0Sdrh   if( p==0 ) return;
1768bc622bc0Sdrh   assert( p->nExpr>0 );
17696e11892dSdan 
17706e11892dSdan   assert( SQLITE_SO_UNDEFINED<0 && SQLITE_SO_ASC==0 && SQLITE_SO_DESC>0 );
17716e11892dSdan   assert( iSortOrder==SQLITE_SO_UNDEFINED
17726e11892dSdan        || iSortOrder==SQLITE_SO_ASC
17736e11892dSdan        || iSortOrder==SQLITE_SO_DESC
17746e11892dSdan   );
17756e11892dSdan   assert( eNulls==SQLITE_SO_UNDEFINED
17766e11892dSdan        || eNulls==SQLITE_SO_ASC
17776e11892dSdan        || eNulls==SQLITE_SO_DESC
17786e11892dSdan   );
17796e11892dSdan 
17809105fd51Sdan   pItem = &p->a[p->nExpr-1];
17819105fd51Sdan   assert( pItem->bNulls==0 );
17829105fd51Sdan   if( iSortOrder==SQLITE_SO_UNDEFINED ){
17839105fd51Sdan     iSortOrder = SQLITE_SO_ASC;
1784bc622bc0Sdrh   }
17859105fd51Sdan   pItem->sortFlags = (u8)iSortOrder;
17869105fd51Sdan 
17879105fd51Sdan   if( eNulls!=SQLITE_SO_UNDEFINED ){
17889105fd51Sdan     pItem->bNulls = 1;
17899105fd51Sdan     if( iSortOrder!=eNulls ){
17909105fd51Sdan       pItem->sortFlags |= KEYINFO_ORDER_BIGNULL;
17919105fd51Sdan     }
1792bc622bc0Sdrh   }
1793bc622bc0Sdrh }
1794bc622bc0Sdrh 
1795bc622bc0Sdrh /*
179641cee668Sdrh ** Set the ExprList.a[].zEName element of the most recently added item
1797b7916a78Sdrh ** on the expression list.
1798b7916a78Sdrh **
1799b7916a78Sdrh ** pList might be NULL following an OOM error.  But pName should never be
1800b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1801b7916a78Sdrh ** is set.
1802b7916a78Sdrh */
1803b7916a78Sdrh void sqlite3ExprListSetName(
1804b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1805b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
1806b7916a78Sdrh   Token *pName,           /* Name to be added */
1807b7916a78Sdrh   int dequote             /* True to cause the name to be dequoted */
1808b7916a78Sdrh ){
1809b7916a78Sdrh   assert( pList!=0 || pParse->db->mallocFailed!=0 );
18102d99f957Sdrh   assert( pParse->eParseMode!=PARSE_MODE_UNMAP || dequote==0 );
1811b7916a78Sdrh   if( pList ){
1812b7916a78Sdrh     struct ExprList_item *pItem;
1813b7916a78Sdrh     assert( pList->nExpr>0 );
1814b7916a78Sdrh     pItem = &pList->a[pList->nExpr-1];
181541cee668Sdrh     assert( pItem->zEName==0 );
1816c4938ea2Sdrh     assert( pItem->eEName==ENAME_NAME );
181741cee668Sdrh     pItem->zEName = sqlite3DbStrNDup(pParse->db, pName->z, pName->n);
181885f2c76cSdan     if( dequote ){
181985f2c76cSdan       /* If dequote==0, then pName->z does not point to part of a DDL
182085f2c76cSdan       ** statement handled by the parser. And so no token need be added
182185f2c76cSdan       ** to the token-map.  */
182285f2c76cSdan       sqlite3Dequote(pItem->zEName);
1823c9461eccSdan       if( IN_RENAME_OBJECT ){
182441cee668Sdrh         sqlite3RenameTokenMap(pParse, (void*)pItem->zEName, pName);
18255be60c55Sdan       }
1826b7916a78Sdrh     }
1827b7916a78Sdrh   }
182885f2c76cSdan }
1829b7916a78Sdrh 
1830b7916a78Sdrh /*
1831b7916a78Sdrh ** Set the ExprList.a[].zSpan element of the most recently added item
1832b7916a78Sdrh ** on the expression list.
1833b7916a78Sdrh **
1834b7916a78Sdrh ** pList might be NULL following an OOM error.  But pSpan should never be
1835b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1836b7916a78Sdrh ** is set.
1837b7916a78Sdrh */
1838b7916a78Sdrh void sqlite3ExprListSetSpan(
1839b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1840b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
18411be266baSdrh   const char *zStart,     /* Start of the span */
18421be266baSdrh   const char *zEnd        /* End of the span */
1843b7916a78Sdrh ){
1844b7916a78Sdrh   sqlite3 *db = pParse->db;
1845b7916a78Sdrh   assert( pList!=0 || db->mallocFailed!=0 );
1846b7916a78Sdrh   if( pList ){
1847b7916a78Sdrh     struct ExprList_item *pItem = &pList->a[pList->nExpr-1];
1848b7916a78Sdrh     assert( pList->nExpr>0 );
1849cbb9da33Sdrh     if( pItem->zEName==0 ){
1850cbb9da33Sdrh       pItem->zEName = sqlite3DbSpanDup(db, zStart, zEnd);
1851cbb9da33Sdrh       pItem->eEName = ENAME_SPAN;
1852cbb9da33Sdrh     }
1853b7916a78Sdrh   }
1854b7916a78Sdrh }
1855b7916a78Sdrh 
1856b7916a78Sdrh /*
18577a15a4beSdanielk1977 ** If the expression list pEList contains more than iLimit elements,
18587a15a4beSdanielk1977 ** leave an error message in pParse.
18597a15a4beSdanielk1977 */
18607a15a4beSdanielk1977 void sqlite3ExprListCheckLength(
18617a15a4beSdanielk1977   Parse *pParse,
18627a15a4beSdanielk1977   ExprList *pEList,
18637a15a4beSdanielk1977   const char *zObject
18647a15a4beSdanielk1977 ){
1865b1a6c3c1Sdrh   int mx = pParse->db->aLimit[SQLITE_LIMIT_COLUMN];
1866c5499befSdrh   testcase( pEList && pEList->nExpr==mx );
1867c5499befSdrh   testcase( pEList && pEList->nExpr==mx+1 );
1868b1a6c3c1Sdrh   if( pEList && pEList->nExpr>mx ){
18697a15a4beSdanielk1977     sqlite3ErrorMsg(pParse, "too many columns in %s", zObject);
18707a15a4beSdanielk1977   }
18717a15a4beSdanielk1977 }
18727a15a4beSdanielk1977 
18737a15a4beSdanielk1977 /*
1874a76b5dfcSdrh ** Delete an entire expression list.
1875a76b5dfcSdrh */
1876affa855cSdrh static SQLITE_NOINLINE void exprListDeleteNN(sqlite3 *db, ExprList *pList){
1877ac48b751Sdrh   int i = pList->nExpr;
1878ac48b751Sdrh   struct ExprList_item *pItem =  pList->a;
1879ac48b751Sdrh   assert( pList->nExpr>0 );
1880ac48b751Sdrh   do{
1881633e6d57Sdrh     sqlite3ExprDelete(db, pItem->pExpr);
188241cee668Sdrh     sqlite3DbFree(db, pItem->zEName);
1883ac48b751Sdrh     pItem++;
1884ac48b751Sdrh   }while( --i>0 );
1885dbd6a7dcSdrh   sqlite3DbFreeNN(db, pList);
1886a76b5dfcSdrh }
1887affa855cSdrh void sqlite3ExprListDelete(sqlite3 *db, ExprList *pList){
1888affa855cSdrh   if( pList ) exprListDeleteNN(db, pList);
1889affa855cSdrh }
1890a76b5dfcSdrh 
1891a76b5dfcSdrh /*
18922308ed38Sdrh ** Return the bitwise-OR of all Expr.flags fields in the given
18932308ed38Sdrh ** ExprList.
1894885a5b03Sdrh */
18952308ed38Sdrh u32 sqlite3ExprListFlags(const ExprList *pList){
1896885a5b03Sdrh   int i;
18972308ed38Sdrh   u32 m = 0;
1898508e2d00Sdrh   assert( pList!=0 );
1899885a5b03Sdrh   for(i=0; i<pList->nExpr; i++){
1900d0c73053Sdrh      Expr *pExpr = pList->a[i].pExpr;
1901de845c2fSdrh      assert( pExpr!=0 );
1902de845c2fSdrh      m |= pExpr->flags;
1903885a5b03Sdrh   }
19042308ed38Sdrh   return m;
1905885a5b03Sdrh }
1906885a5b03Sdrh 
1907885a5b03Sdrh /*
19087e6f980bSdrh ** This is a SELECT-node callback for the expression walker that
19097e6f980bSdrh ** always "fails".  By "fail" in this case, we mean set
19107e6f980bSdrh ** pWalker->eCode to zero and abort.
19117e6f980bSdrh **
19127e6f980bSdrh ** This callback is used by multiple expression walkers.
19137e6f980bSdrh */
19147e6f980bSdrh int sqlite3SelectWalkFail(Walker *pWalker, Select *NotUsed){
19157e6f980bSdrh   UNUSED_PARAMETER(NotUsed);
19167e6f980bSdrh   pWalker->eCode = 0;
19177e6f980bSdrh   return WRC_Abort;
19187e6f980bSdrh }
19197e6f980bSdrh 
19207e6f980bSdrh /*
19210cbec59cSdrh ** Check the input string to see if it is "true" or "false" (in any case).
19220cbec59cSdrh **
19230cbec59cSdrh **       If the string is....           Return
19240cbec59cSdrh **         "true"                         EP_IsTrue
19250cbec59cSdrh **         "false"                        EP_IsFalse
19260cbec59cSdrh **         anything else                  0
19270cbec59cSdrh */
19280cbec59cSdrh u32 sqlite3IsTrueOrFalse(const char *zIn){
19290cbec59cSdrh   if( sqlite3StrICmp(zIn, "true")==0  ) return EP_IsTrue;
19300cbec59cSdrh   if( sqlite3StrICmp(zIn, "false")==0 ) return EP_IsFalse;
19310cbec59cSdrh   return 0;
19320cbec59cSdrh }
19330cbec59cSdrh 
19340cbec59cSdrh 
19350cbec59cSdrh /*
1936171d16bbSdrh ** If the input expression is an ID with the name "true" or "false"
193796acafbeSdrh ** then convert it into an TK_TRUEFALSE term.  Return non-zero if
193896acafbeSdrh ** the conversion happened, and zero if the expression is unaltered.
1939171d16bbSdrh */
1940171d16bbSdrh int sqlite3ExprIdToTrueFalse(Expr *pExpr){
19410cbec59cSdrh   u32 v;
1942171d16bbSdrh   assert( pExpr->op==TK_ID || pExpr->op==TK_STRING );
194351d35b0fSdrh   if( !ExprHasProperty(pExpr, EP_Quoted)
19440cbec59cSdrh    && (v = sqlite3IsTrueOrFalse(pExpr->u.zToken))!=0
1945171d16bbSdrh   ){
1946171d16bbSdrh     pExpr->op = TK_TRUEFALSE;
19470cbec59cSdrh     ExprSetProperty(pExpr, v);
1948171d16bbSdrh     return 1;
1949171d16bbSdrh   }
1950171d16bbSdrh   return 0;
1951171d16bbSdrh }
1952171d16bbSdrh 
195343c4ac8bSdrh /*
195496acafbeSdrh ** The argument must be a TK_TRUEFALSE Expr node.  Return 1 if it is TRUE
195543c4ac8bSdrh ** and 0 if it is FALSE.
195643c4ac8bSdrh */
195796acafbeSdrh int sqlite3ExprTruthValue(const Expr *pExpr){
19586ece353fSdan   pExpr = sqlite3ExprSkipCollate((Expr*)pExpr);
195943c4ac8bSdrh   assert( pExpr->op==TK_TRUEFALSE );
196043c4ac8bSdrh   assert( sqlite3StrICmp(pExpr->u.zToken,"true")==0
196143c4ac8bSdrh        || sqlite3StrICmp(pExpr->u.zToken,"false")==0 );
196243c4ac8bSdrh   return pExpr->u.zToken[4]==0;
196343c4ac8bSdrh }
196443c4ac8bSdrh 
196517180fcaSdrh /*
196617180fcaSdrh ** If pExpr is an AND or OR expression, try to simplify it by eliminating
196717180fcaSdrh ** terms that are always true or false.  Return the simplified expression.
196817180fcaSdrh ** Or return the original expression if no simplification is possible.
196917180fcaSdrh **
197017180fcaSdrh ** Examples:
197117180fcaSdrh **
197217180fcaSdrh **     (x<10) AND true                =>   (x<10)
197317180fcaSdrh **     (x<10) AND false               =>   false
197417180fcaSdrh **     (x<10) AND (y=22 OR false)     =>   (x<10) AND (y=22)
197517180fcaSdrh **     (x<10) AND (y=22 OR true)      =>   (x<10)
197617180fcaSdrh **     (y=22) OR true                 =>   true
197717180fcaSdrh */
197817180fcaSdrh Expr *sqlite3ExprSimplifiedAndOr(Expr *pExpr){
197917180fcaSdrh   assert( pExpr!=0 );
198017180fcaSdrh   if( pExpr->op==TK_AND || pExpr->op==TK_OR ){
198117180fcaSdrh     Expr *pRight = sqlite3ExprSimplifiedAndOr(pExpr->pRight);
198217180fcaSdrh     Expr *pLeft = sqlite3ExprSimplifiedAndOr(pExpr->pLeft);
198317180fcaSdrh     if( ExprAlwaysTrue(pLeft) || ExprAlwaysFalse(pRight) ){
198417180fcaSdrh       pExpr = pExpr->op==TK_AND ? pRight : pLeft;
198517180fcaSdrh     }else if( ExprAlwaysTrue(pRight) || ExprAlwaysFalse(pLeft) ){
198617180fcaSdrh       pExpr = pExpr->op==TK_AND ? pLeft : pRight;
198717180fcaSdrh     }
198817180fcaSdrh   }
198917180fcaSdrh   return pExpr;
199017180fcaSdrh }
199117180fcaSdrh 
1992171d16bbSdrh 
1993171d16bbSdrh /*
1994059b2d50Sdrh ** These routines are Walker callbacks used to check expressions to
1995059b2d50Sdrh ** see if they are "constant" for some definition of constant.  The
1996059b2d50Sdrh ** Walker.eCode value determines the type of "constant" we are looking
1997059b2d50Sdrh ** for.
199873b211abSdrh **
19997d10d5a6Sdrh ** These callback routines are used to implement the following:
2000626a879aSdrh **
2001059b2d50Sdrh **     sqlite3ExprIsConstant()                  pWalker->eCode==1
2002059b2d50Sdrh **     sqlite3ExprIsConstantNotJoin()           pWalker->eCode==2
2003fcb9f4f3Sdrh **     sqlite3ExprIsTableConstant()             pWalker->eCode==3
2004059b2d50Sdrh **     sqlite3ExprIsConstantOrFunction()        pWalker->eCode==4 or 5
200587abf5c0Sdrh **
2006059b2d50Sdrh ** In all cases, the callbacks set Walker.eCode=0 and abort if the expression
2007059b2d50Sdrh ** is found to not be a constant.
200887abf5c0Sdrh **
2009014fff20Sdrh ** The sqlite3ExprIsConstantOrFunction() is used for evaluating DEFAULT
2010014fff20Sdrh ** expressions in a CREATE TABLE statement.  The Walker.eCode value is 5
20111e32bed3Sdrh ** when parsing an existing schema out of the sqlite_schema table and 4
2012014fff20Sdrh ** when processing a new CREATE TABLE statement.  A bound parameter raises
2013014fff20Sdrh ** an error for new statements, but is silently converted
20141e32bed3Sdrh ** to NULL for existing schemas.  This allows sqlite_schema tables that
2015feada2dfSdrh ** contain a bound parameter because they were generated by older versions
2016feada2dfSdrh ** of SQLite to be parsed by newer versions of SQLite without raising a
2017feada2dfSdrh ** malformed schema error.
2018626a879aSdrh */
20197d10d5a6Sdrh static int exprNodeIsConstant(Walker *pWalker, Expr *pExpr){
2020626a879aSdrh 
2021059b2d50Sdrh   /* If pWalker->eCode is 2 then any term of the expression that comes from
2022059b2d50Sdrh   ** the ON or USING clauses of a left join disqualifies the expression
20230a168377Sdrh   ** from being considered constant. */
2024059b2d50Sdrh   if( pWalker->eCode==2 && ExprHasProperty(pExpr, EP_FromJoin) ){
2025059b2d50Sdrh     pWalker->eCode = 0;
20267d10d5a6Sdrh     return WRC_Abort;
20270a168377Sdrh   }
20280a168377Sdrh 
2029626a879aSdrh   switch( pExpr->op ){
2030eb55bd2fSdrh     /* Consider functions to be constant if all their arguments are constant
2031059b2d50Sdrh     ** and either pWalker->eCode==4 or 5 or the function has the
2032059b2d50Sdrh     ** SQLITE_FUNC_CONST flag. */
2033eb55bd2fSdrh     case TK_FUNCTION:
2034a634c9e6Sdrh       if( (pWalker->eCode>=4 || ExprHasProperty(pExpr,EP_ConstFunc))
2035a634c9e6Sdrh        && !ExprHasProperty(pExpr, EP_WinFunc)
2036a634c9e6Sdrh       ){
2037014fff20Sdrh         if( pWalker->eCode==5 ) ExprSetProperty(pExpr, EP_FromDDL);
2038b1fba286Sdrh         return WRC_Continue;
2039059b2d50Sdrh       }else{
2040059b2d50Sdrh         pWalker->eCode = 0;
2041059b2d50Sdrh         return WRC_Abort;
2042b1fba286Sdrh       }
2043626a879aSdrh     case TK_ID:
2044171d16bbSdrh       /* Convert "true" or "false" in a DEFAULT clause into the
2045171d16bbSdrh       ** appropriate TK_TRUEFALSE operator */
2046e39ef31cSdrh       if( sqlite3ExprIdToTrueFalse(pExpr) ){
2047171d16bbSdrh         return WRC_Prune;
2048171d16bbSdrh       }
204908b92086Sdrh       /* no break */ deliberate_fall_through
2050626a879aSdrh     case TK_COLUMN:
2051626a879aSdrh     case TK_AGG_FUNCTION:
205213449892Sdrh     case TK_AGG_COLUMN:
2053c5499befSdrh       testcase( pExpr->op==TK_ID );
2054c5499befSdrh       testcase( pExpr->op==TK_COLUMN );
2055c5499befSdrh       testcase( pExpr->op==TK_AGG_FUNCTION );
2056c5499befSdrh       testcase( pExpr->op==TK_AGG_COLUMN );
205707aded63Sdrh       if( ExprHasProperty(pExpr, EP_FixedCol) && pWalker->eCode!=2 ){
2058efad2e23Sdrh         return WRC_Continue;
2059efad2e23Sdrh       }
2060059b2d50Sdrh       if( pWalker->eCode==3 && pExpr->iTable==pWalker->u.iCur ){
2061059b2d50Sdrh         return WRC_Continue;
2062f43ce0b4Sdrh       }
206308b92086Sdrh       /* no break */ deliberate_fall_through
2064f43ce0b4Sdrh     case TK_IF_NULL_ROW:
20656e341b93Sdrh     case TK_REGISTER:
206674e0d966Sdrh     case TK_DOT:
20679916048bSdrh       testcase( pExpr->op==TK_REGISTER );
2068f43ce0b4Sdrh       testcase( pExpr->op==TK_IF_NULL_ROW );
206974e0d966Sdrh       testcase( pExpr->op==TK_DOT );
2070059b2d50Sdrh       pWalker->eCode = 0;
20717d10d5a6Sdrh       return WRC_Abort;
2072feada2dfSdrh     case TK_VARIABLE:
2073059b2d50Sdrh       if( pWalker->eCode==5 ){
2074feada2dfSdrh         /* Silently convert bound parameters that appear inside of CREATE
2075feada2dfSdrh         ** statements into a NULL when parsing the CREATE statement text out
20761e32bed3Sdrh         ** of the sqlite_schema table */
2077feada2dfSdrh         pExpr->op = TK_NULL;
2078059b2d50Sdrh       }else if( pWalker->eCode==4 ){
2079feada2dfSdrh         /* A bound parameter in a CREATE statement that originates from
2080feada2dfSdrh         ** sqlite3_prepare() causes an error */
2081059b2d50Sdrh         pWalker->eCode = 0;
2082feada2dfSdrh         return WRC_Abort;
2083feada2dfSdrh       }
208408b92086Sdrh       /* no break */ deliberate_fall_through
2085626a879aSdrh     default:
20866e341b93Sdrh       testcase( pExpr->op==TK_SELECT ); /* sqlite3SelectWalkFail() disallows */
20876e341b93Sdrh       testcase( pExpr->op==TK_EXISTS ); /* sqlite3SelectWalkFail() disallows */
20887d10d5a6Sdrh       return WRC_Continue;
2089626a879aSdrh   }
2090626a879aSdrh }
2091059b2d50Sdrh static int exprIsConst(Expr *p, int initFlag, int iCur){
20927d10d5a6Sdrh   Walker w;
2093059b2d50Sdrh   w.eCode = initFlag;
20947d10d5a6Sdrh   w.xExprCallback = exprNodeIsConstant;
20957e6f980bSdrh   w.xSelectCallback = sqlite3SelectWalkFail;
2096979dd1beSdrh #ifdef SQLITE_DEBUG
2097979dd1beSdrh   w.xSelectCallback2 = sqlite3SelectWalkAssert2;
2098979dd1beSdrh #endif
2099059b2d50Sdrh   w.u.iCur = iCur;
21007d10d5a6Sdrh   sqlite3WalkExpr(&w, p);
2101059b2d50Sdrh   return w.eCode;
21027d10d5a6Sdrh }
2103626a879aSdrh 
2104626a879aSdrh /*
2105059b2d50Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
2106eb55bd2fSdrh ** and 0 if it involves variables or function calls.
21072398937bSdrh **
21082398937bSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
21092398937bSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
21102398937bSdrh ** a constant.
2111fef5208cSdrh */
21124adee20fSdanielk1977 int sqlite3ExprIsConstant(Expr *p){
2113059b2d50Sdrh   return exprIsConst(p, 1, 0);
2114fef5208cSdrh }
2115fef5208cSdrh 
2116fef5208cSdrh /*
211707aded63Sdrh ** Walk an expression tree.  Return non-zero if
211807aded63Sdrh **
211907aded63Sdrh **   (1) the expression is constant, and
212007aded63Sdrh **   (2) the expression does originate in the ON or USING clause
212107aded63Sdrh **       of a LEFT JOIN, and
212207aded63Sdrh **   (3) the expression does not contain any EP_FixedCol TK_COLUMN
212307aded63Sdrh **       operands created by the constant propagation optimization.
212407aded63Sdrh **
212507aded63Sdrh ** When this routine returns true, it indicates that the expression
212607aded63Sdrh ** can be added to the pParse->pConstExpr list and evaluated once when
21279b258c54Sdrh ** the prepared statement starts up.  See sqlite3ExprCodeRunJustOnce().
21280a168377Sdrh */
21290a168377Sdrh int sqlite3ExprIsConstantNotJoin(Expr *p){
2130059b2d50Sdrh   return exprIsConst(p, 2, 0);
21310a168377Sdrh }
21320a168377Sdrh 
21330a168377Sdrh /*
2134fcb9f4f3Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
2135059b2d50Sdrh ** for any single row of the table with cursor iCur.  In other words, the
2136059b2d50Sdrh ** expression must not refer to any non-deterministic function nor any
2137059b2d50Sdrh ** table other than iCur.
2138059b2d50Sdrh */
2139059b2d50Sdrh int sqlite3ExprIsTableConstant(Expr *p, int iCur){
2140059b2d50Sdrh   return exprIsConst(p, 3, iCur);
2141059b2d50Sdrh }
2142059b2d50Sdrh 
2143ab31a845Sdan 
2144ab31a845Sdan /*
2145ab31a845Sdan ** sqlite3WalkExpr() callback used by sqlite3ExprIsConstantOrGroupBy().
2146ab31a845Sdan */
2147ab31a845Sdan static int exprNodeIsConstantOrGroupBy(Walker *pWalker, Expr *pExpr){
2148ab31a845Sdan   ExprList *pGroupBy = pWalker->u.pGroupBy;
2149ab31a845Sdan   int i;
2150ab31a845Sdan 
2151ab31a845Sdan   /* Check if pExpr is identical to any GROUP BY term. If so, consider
2152ab31a845Sdan   ** it constant.  */
2153ab31a845Sdan   for(i=0; i<pGroupBy->nExpr; i++){
2154ab31a845Sdan     Expr *p = pGroupBy->a[i].pExpr;
21555aa550cfSdan     if( sqlite3ExprCompare(0, pExpr, p, -1)<2 ){
215670efa84dSdrh       CollSeq *pColl = sqlite3ExprNNCollSeq(pWalker->pParse, p);
2157efad2e23Sdrh       if( sqlite3IsBinary(pColl) ){
2158ab31a845Sdan         return WRC_Prune;
2159ab31a845Sdan       }
2160ab31a845Sdan     }
2161ab31a845Sdan   }
2162ab31a845Sdan 
2163ab31a845Sdan   /* Check if pExpr is a sub-select. If so, consider it variable. */
2164ab31a845Sdan   if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2165ab31a845Sdan     pWalker->eCode = 0;
2166ab31a845Sdan     return WRC_Abort;
2167ab31a845Sdan   }
2168ab31a845Sdan 
2169ab31a845Sdan   return exprNodeIsConstant(pWalker, pExpr);
2170ab31a845Sdan }
2171ab31a845Sdan 
2172ab31a845Sdan /*
2173ab31a845Sdan ** Walk the expression tree passed as the first argument. Return non-zero
2174ab31a845Sdan ** if the expression consists entirely of constants or copies of terms
2175ab31a845Sdan ** in pGroupBy that sort with the BINARY collation sequence.
2176ab314001Sdrh **
2177ab314001Sdrh ** This routine is used to determine if a term of the HAVING clause can
2178ab314001Sdrh ** be promoted into the WHERE clause.  In order for such a promotion to work,
2179ab314001Sdrh ** the value of the HAVING clause term must be the same for all members of
2180ab314001Sdrh ** a "group".  The requirement that the GROUP BY term must be BINARY
2181ab314001Sdrh ** assumes that no other collating sequence will have a finer-grained
2182ab314001Sdrh ** grouping than binary.  In other words (A=B COLLATE binary) implies
2183ab314001Sdrh ** A=B in every other collating sequence.  The requirement that the
2184ab314001Sdrh ** GROUP BY be BINARY is stricter than necessary.  It would also work
2185ab314001Sdrh ** to promote HAVING clauses that use the same alternative collating
2186ab314001Sdrh ** sequence as the GROUP BY term, but that is much harder to check,
2187ab314001Sdrh ** alternative collating sequences are uncommon, and this is only an
2188ab314001Sdrh ** optimization, so we take the easy way out and simply require the
2189ab314001Sdrh ** GROUP BY to use the BINARY collating sequence.
2190ab31a845Sdan */
2191ab31a845Sdan int sqlite3ExprIsConstantOrGroupBy(Parse *pParse, Expr *p, ExprList *pGroupBy){
2192ab31a845Sdan   Walker w;
2193ab31a845Sdan   w.eCode = 1;
2194ab31a845Sdan   w.xExprCallback = exprNodeIsConstantOrGroupBy;
2195979dd1beSdrh   w.xSelectCallback = 0;
2196ab31a845Sdan   w.u.pGroupBy = pGroupBy;
2197ab31a845Sdan   w.pParse = pParse;
2198ab31a845Sdan   sqlite3WalkExpr(&w, p);
2199ab31a845Sdan   return w.eCode;
2200ab31a845Sdan }
2201ab31a845Sdan 
2202059b2d50Sdrh /*
2203014fff20Sdrh ** Walk an expression tree for the DEFAULT field of a column definition
2204014fff20Sdrh ** in a CREATE TABLE statement.  Return non-zero if the expression is
2205014fff20Sdrh ** acceptable for use as a DEFAULT.  That is to say, return non-zero if
2206014fff20Sdrh ** the expression is constant or a function call with constant arguments.
2207014fff20Sdrh ** Return and 0 if there are any variables.
2208014fff20Sdrh **
22091e32bed3Sdrh ** isInit is true when parsing from sqlite_schema.  isInit is false when
2210014fff20Sdrh ** processing a new CREATE TABLE statement.  When isInit is true, parameters
2211014fff20Sdrh ** (such as ? or $abc) in the expression are converted into NULL.  When
2212014fff20Sdrh ** isInit is false, parameters raise an error.  Parameters should not be
2213014fff20Sdrh ** allowed in a CREATE TABLE statement, but some legacy versions of SQLite
22141e32bed3Sdrh ** allowed it, so we need to support it when reading sqlite_schema for
2215014fff20Sdrh ** backwards compatibility.
2216014fff20Sdrh **
2217014fff20Sdrh ** If isInit is true, set EP_FromDDL on every TK_FUNCTION node.
2218eb55bd2fSdrh **
2219eb55bd2fSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
2220eb55bd2fSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
2221eb55bd2fSdrh ** a constant.
2222eb55bd2fSdrh */
2223feada2dfSdrh int sqlite3ExprIsConstantOrFunction(Expr *p, u8 isInit){
2224feada2dfSdrh   assert( isInit==0 || isInit==1 );
2225059b2d50Sdrh   return exprIsConst(p, 4+isInit, 0);
2226eb55bd2fSdrh }
2227eb55bd2fSdrh 
22285b88bc4bSdrh #ifdef SQLITE_ENABLE_CURSOR_HINTS
22295b88bc4bSdrh /*
22305b88bc4bSdrh ** Walk an expression tree.  Return 1 if the expression contains a
22315b88bc4bSdrh ** subquery of some kind.  Return 0 if there are no subqueries.
22325b88bc4bSdrh */
22335b88bc4bSdrh int sqlite3ExprContainsSubquery(Expr *p){
22345b88bc4bSdrh   Walker w;
2235bec2476aSdrh   w.eCode = 1;
22365b88bc4bSdrh   w.xExprCallback = sqlite3ExprWalkNoop;
22377e6f980bSdrh   w.xSelectCallback = sqlite3SelectWalkFail;
2238979dd1beSdrh #ifdef SQLITE_DEBUG
2239979dd1beSdrh   w.xSelectCallback2 = sqlite3SelectWalkAssert2;
2240979dd1beSdrh #endif
22415b88bc4bSdrh   sqlite3WalkExpr(&w, p);
224207194bffSdrh   return w.eCode==0;
22435b88bc4bSdrh }
22445b88bc4bSdrh #endif
22455b88bc4bSdrh 
2246eb55bd2fSdrh /*
224773b211abSdrh ** If the expression p codes a constant integer that is small enough
2248202b2df7Sdrh ** to fit in a 32-bit integer, return 1 and put the value of the integer
2249202b2df7Sdrh ** in *pValue.  If the expression is not an integer or if it is too big
2250202b2df7Sdrh ** to fit in a signed 32-bit integer, return 0 and leave *pValue unchanged.
2251e4de1febSdrh */
22524adee20fSdanielk1977 int sqlite3ExprIsInteger(Expr *p, int *pValue){
225392b01d53Sdrh   int rc = 0;
22541d2d71a0Sdrh   if( NEVER(p==0) ) return 0;  /* Used to only happen following on OOM */
2255cd92e84dSdrh 
2256cd92e84dSdrh   /* If an expression is an integer literal that fits in a signed 32-bit
2257cd92e84dSdrh   ** integer, then the EP_IntValue flag will have already been set */
2258cd92e84dSdrh   assert( p->op!=TK_INTEGER || (p->flags & EP_IntValue)!=0
2259cd92e84dSdrh            || sqlite3GetInt32(p->u.zToken, &rc)==0 );
2260cd92e84dSdrh 
226192b01d53Sdrh   if( p->flags & EP_IntValue ){
226233e619fcSdrh     *pValue = p->u.iValue;
2263e4de1febSdrh     return 1;
2264e4de1febSdrh   }
226592b01d53Sdrh   switch( p->op ){
22664b59ab5eSdrh     case TK_UPLUS: {
226792b01d53Sdrh       rc = sqlite3ExprIsInteger(p->pLeft, pValue);
2268f6e369a1Sdrh       break;
22694b59ab5eSdrh     }
2270e4de1febSdrh     case TK_UMINUS: {
2271e4de1febSdrh       int v;
22724adee20fSdanielk1977       if( sqlite3ExprIsInteger(p->pLeft, &v) ){
2273f6418891Smistachkin         assert( v!=(-2147483647-1) );
2274e4de1febSdrh         *pValue = -v;
227592b01d53Sdrh         rc = 1;
2276e4de1febSdrh       }
2277e4de1febSdrh       break;
2278e4de1febSdrh     }
2279e4de1febSdrh     default: break;
2280e4de1febSdrh   }
228192b01d53Sdrh   return rc;
2282e4de1febSdrh }
2283e4de1febSdrh 
2284e4de1febSdrh /*
2285039fc32eSdrh ** Return FALSE if there is no chance that the expression can be NULL.
2286039fc32eSdrh **
2287039fc32eSdrh ** If the expression might be NULL or if the expression is too complex
2288039fc32eSdrh ** to tell return TRUE.
2289039fc32eSdrh **
2290039fc32eSdrh ** This routine is used as an optimization, to skip OP_IsNull opcodes
2291039fc32eSdrh ** when we know that a value cannot be NULL.  Hence, a false positive
2292039fc32eSdrh ** (returning TRUE when in fact the expression can never be NULL) might
2293039fc32eSdrh ** be a small performance hit but is otherwise harmless.  On the other
2294039fc32eSdrh ** hand, a false negative (returning FALSE when the result could be NULL)
2295039fc32eSdrh ** will likely result in an incorrect answer.  So when in doubt, return
2296039fc32eSdrh ** TRUE.
2297039fc32eSdrh */
2298039fc32eSdrh int sqlite3ExprCanBeNull(const Expr *p){
2299039fc32eSdrh   u8 op;
23009bfb0794Sdrh   while( p->op==TK_UPLUS || p->op==TK_UMINUS ){
23019bfb0794Sdrh     p = p->pLeft;
23029bfb0794Sdrh   }
2303039fc32eSdrh   op = p->op;
2304039fc32eSdrh   if( op==TK_REGISTER ) op = p->op2;
2305039fc32eSdrh   switch( op ){
2306039fc32eSdrh     case TK_INTEGER:
2307039fc32eSdrh     case TK_STRING:
2308039fc32eSdrh     case TK_FLOAT:
2309039fc32eSdrh     case TK_BLOB:
2310039fc32eSdrh       return 0;
23117248a8b2Sdrh     case TK_COLUMN:
231272673a24Sdrh       return ExprHasProperty(p, EP_CanBeNull) ||
2313eda079cdSdrh              p->y.pTab==0 ||  /* Reference to column of index on expression */
23144eac5f04Sdrh              (p->iColumn>=0
23154eac5f04Sdrh               && ALWAYS(p->y.pTab->aCol!=0) /* Defense against OOM problems */
23164eac5f04Sdrh               && p->y.pTab->aCol[p->iColumn].notNull==0);
2317039fc32eSdrh     default:
2318039fc32eSdrh       return 1;
2319039fc32eSdrh   }
2320039fc32eSdrh }
2321039fc32eSdrh 
2322039fc32eSdrh /*
2323039fc32eSdrh ** Return TRUE if the given expression is a constant which would be
2324039fc32eSdrh ** unchanged by OP_Affinity with the affinity given in the second
2325039fc32eSdrh ** argument.
2326039fc32eSdrh **
2327039fc32eSdrh ** This routine is used to determine if the OP_Affinity operation
2328039fc32eSdrh ** can be omitted.  When in doubt return FALSE.  A false negative
2329039fc32eSdrh ** is harmless.  A false positive, however, can result in the wrong
2330039fc32eSdrh ** answer.
2331039fc32eSdrh */
2332039fc32eSdrh int sqlite3ExprNeedsNoAffinityChange(const Expr *p, char aff){
2333039fc32eSdrh   u8 op;
2334af866402Sdrh   int unaryMinus = 0;
233505883a34Sdrh   if( aff==SQLITE_AFF_BLOB ) return 1;
2336af866402Sdrh   while( p->op==TK_UPLUS || p->op==TK_UMINUS ){
2337af866402Sdrh     if( p->op==TK_UMINUS ) unaryMinus = 1;
2338af866402Sdrh     p = p->pLeft;
2339af866402Sdrh   }
2340039fc32eSdrh   op = p->op;
2341039fc32eSdrh   if( op==TK_REGISTER ) op = p->op2;
2342039fc32eSdrh   switch( op ){
2343039fc32eSdrh     case TK_INTEGER: {
23446a19865fSdrh       return aff>=SQLITE_AFF_NUMERIC;
2345039fc32eSdrh     }
2346039fc32eSdrh     case TK_FLOAT: {
23476a19865fSdrh       return aff>=SQLITE_AFF_NUMERIC;
2348039fc32eSdrh     }
2349039fc32eSdrh     case TK_STRING: {
2350af866402Sdrh       return !unaryMinus && aff==SQLITE_AFF_TEXT;
2351039fc32eSdrh     }
2352039fc32eSdrh     case TK_BLOB: {
2353af866402Sdrh       return !unaryMinus;
2354039fc32eSdrh     }
23552f2855b6Sdrh     case TK_COLUMN: {
235688376ca7Sdrh       assert( p->iTable>=0 );  /* p cannot be part of a CHECK constraint */
23576a19865fSdrh       return aff>=SQLITE_AFF_NUMERIC && p->iColumn<0;
23582f2855b6Sdrh     }
2359039fc32eSdrh     default: {
2360039fc32eSdrh       return 0;
2361039fc32eSdrh     }
2362039fc32eSdrh   }
2363039fc32eSdrh }
2364039fc32eSdrh 
2365039fc32eSdrh /*
2366c4a3c779Sdrh ** Return TRUE if the given string is a row-id column name.
2367c4a3c779Sdrh */
23684adee20fSdanielk1977 int sqlite3IsRowid(const char *z){
23694adee20fSdanielk1977   if( sqlite3StrICmp(z, "_ROWID_")==0 ) return 1;
23704adee20fSdanielk1977   if( sqlite3StrICmp(z, "ROWID")==0 ) return 1;
23714adee20fSdanielk1977   if( sqlite3StrICmp(z, "OID")==0 ) return 1;
2372c4a3c779Sdrh   return 0;
2373c4a3c779Sdrh }
2374c4a3c779Sdrh 
23759a96b668Sdanielk1977 /*
237669c355bdSdrh ** pX is the RHS of an IN operator.  If pX is a SELECT statement
237769c355bdSdrh ** that can be simplified to a direct table access, then return
237869c355bdSdrh ** a pointer to the SELECT statement.  If pX is not a SELECT statement,
237969c355bdSdrh ** or if the SELECT statement needs to be manifested into a transient
238069c355bdSdrh ** table, then return NULL.
2381b287f4b6Sdrh */
2382b287f4b6Sdrh #ifndef SQLITE_OMIT_SUBQUERY
23837b35a77bSdan static Select *isCandidateForInOpt(Expr *pX){
238469c355bdSdrh   Select *p;
2385b287f4b6Sdrh   SrcList *pSrc;
2386b287f4b6Sdrh   ExprList *pEList;
2387b287f4b6Sdrh   Table *pTab;
2388cfbb5e82Sdan   int i;
238969c355bdSdrh   if( !ExprHasProperty(pX, EP_xIsSelect) ) return 0;  /* Not a subquery */
239069c355bdSdrh   if( ExprHasProperty(pX, EP_VarSelect)  ) return 0;  /* Correlated subq */
239169c355bdSdrh   p = pX->x.pSelect;
2392b287f4b6Sdrh   if( p->pPrior ) return 0;              /* Not a compound SELECT */
23937d10d5a6Sdrh   if( p->selFlags & (SF_Distinct|SF_Aggregate) ){
2394b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
2395b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
23967d10d5a6Sdrh     return 0; /* No DISTINCT keyword and no aggregate functions */
23977d10d5a6Sdrh   }
23982e26a602Sdrh   assert( p->pGroupBy==0 );              /* Has no GROUP BY clause */
2399b287f4b6Sdrh   if( p->pLimit ) return 0;              /* Has no LIMIT clause */
2400b287f4b6Sdrh   if( p->pWhere ) return 0;              /* Has no WHERE clause */
2401b287f4b6Sdrh   pSrc = p->pSrc;
2402d1fa7bcaSdrh   assert( pSrc!=0 );
2403d1fa7bcaSdrh   if( pSrc->nSrc!=1 ) return 0;          /* Single term in FROM clause */
2404b74b1017Sdrh   if( pSrc->a[0].pSelect ) return 0;     /* FROM is not a subquery or view */
2405b287f4b6Sdrh   pTab = pSrc->a[0].pTab;
240669c355bdSdrh   assert( pTab!=0 );
2407b74b1017Sdrh   assert( pTab->pSelect==0 );            /* FROM clause is not a view */
2408b287f4b6Sdrh   if( IsVirtual(pTab) ) return 0;        /* FROM clause not a virtual table */
2409b287f4b6Sdrh   pEList = p->pEList;
2410ac6b47d1Sdrh   assert( pEList!=0 );
24117b35a77bSdan   /* All SELECT results must be columns. */
2412cfbb5e82Sdan   for(i=0; i<pEList->nExpr; i++){
2413cfbb5e82Sdan     Expr *pRes = pEList->a[i].pExpr;
2414cfbb5e82Sdan     if( pRes->op!=TK_COLUMN ) return 0;
241569c355bdSdrh     assert( pRes->iTable==pSrc->a[0].iCursor );  /* Not a correlated subquery */
2416cfbb5e82Sdan   }
241769c355bdSdrh   return p;
2418b287f4b6Sdrh }
2419b287f4b6Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
2420b287f4b6Sdrh 
2421f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
24221d8cb21fSdan /*
24234c259e9fSdrh ** Generate code that checks the left-most column of index table iCur to see if
24244c259e9fSdrh ** it contains any NULL entries.  Cause the register at regHasNull to be set
24256be515ebSdrh ** to a non-NULL value if iCur contains no NULLs.  Cause register regHasNull
24266be515ebSdrh ** to be set to NULL if iCur contains one or more NULL values.
24276be515ebSdrh */
24286be515ebSdrh static void sqlite3SetHasNullFlag(Vdbe *v, int iCur, int regHasNull){
2429728e0f91Sdrh   int addr1;
24306be515ebSdrh   sqlite3VdbeAddOp2(v, OP_Integer, 0, regHasNull);
2431728e0f91Sdrh   addr1 = sqlite3VdbeAddOp1(v, OP_Rewind, iCur); VdbeCoverage(v);
24326be515ebSdrh   sqlite3VdbeAddOp3(v, OP_Column, iCur, 0, regHasNull);
24336be515ebSdrh   sqlite3VdbeChangeP5(v, OPFLAG_TYPEOFARG);
24344c259e9fSdrh   VdbeComment((v, "first_entry_in(%d)", iCur));
2435728e0f91Sdrh   sqlite3VdbeJumpHere(v, addr1);
24366be515ebSdrh }
2437f9b2e05cSdan #endif
24386be515ebSdrh 
2439bb53ecb1Sdrh 
2440bb53ecb1Sdrh #ifndef SQLITE_OMIT_SUBQUERY
2441bb53ecb1Sdrh /*
2442bb53ecb1Sdrh ** The argument is an IN operator with a list (not a subquery) on the
2443bb53ecb1Sdrh ** right-hand side.  Return TRUE if that list is constant.
2444bb53ecb1Sdrh */
2445bb53ecb1Sdrh static int sqlite3InRhsIsConstant(Expr *pIn){
2446bb53ecb1Sdrh   Expr *pLHS;
2447bb53ecb1Sdrh   int res;
2448bb53ecb1Sdrh   assert( !ExprHasProperty(pIn, EP_xIsSelect) );
2449bb53ecb1Sdrh   pLHS = pIn->pLeft;
2450bb53ecb1Sdrh   pIn->pLeft = 0;
2451bb53ecb1Sdrh   res = sqlite3ExprIsConstant(pIn);
2452bb53ecb1Sdrh   pIn->pLeft = pLHS;
2453bb53ecb1Sdrh   return res;
2454bb53ecb1Sdrh }
2455bb53ecb1Sdrh #endif
2456bb53ecb1Sdrh 
24576be515ebSdrh /*
24589a96b668Sdanielk1977 ** This function is used by the implementation of the IN (...) operator.
2459d4305ca6Sdrh ** The pX parameter is the expression on the RHS of the IN operator, which
2460d4305ca6Sdrh ** might be either a list of expressions or a subquery.
24619a96b668Sdanielk1977 **
2462d4305ca6Sdrh ** The job of this routine is to find or create a b-tree object that can
2463d4305ca6Sdrh ** be used either to test for membership in the RHS set or to iterate through
2464d4305ca6Sdrh ** all members of the RHS set, skipping duplicates.
2465d4305ca6Sdrh **
24663a85625dSdrh ** A cursor is opened on the b-tree object that is the RHS of the IN operator
2467d4305ca6Sdrh ** and pX->iTable is set to the index of that cursor.
2468d4305ca6Sdrh **
2469b74b1017Sdrh ** The returned value of this function indicates the b-tree type, as follows:
24709a96b668Sdanielk1977 **
24719a96b668Sdanielk1977 **   IN_INDEX_ROWID      - The cursor was opened on a database table.
24721ccce449Sdrh **   IN_INDEX_INDEX_ASC  - The cursor was opened on an ascending index.
24731ccce449Sdrh **   IN_INDEX_INDEX_DESC - The cursor was opened on a descending index.
24749a96b668Sdanielk1977 **   IN_INDEX_EPH        - The cursor was opened on a specially created and
24759a96b668Sdanielk1977 **                         populated epheremal table.
2476bb53ecb1Sdrh **   IN_INDEX_NOOP       - No cursor was allocated.  The IN operator must be
2477bb53ecb1Sdrh **                         implemented as a sequence of comparisons.
24789a96b668Sdanielk1977 **
2479d4305ca6Sdrh ** An existing b-tree might be used if the RHS expression pX is a simple
2480d4305ca6Sdrh ** subquery such as:
24819a96b668Sdanielk1977 **
2482553168c7Sdan **     SELECT <column1>, <column2>... FROM <table>
24839a96b668Sdanielk1977 **
2484d4305ca6Sdrh ** If the RHS of the IN operator is a list or a more complex subquery, then
2485d4305ca6Sdrh ** an ephemeral table might need to be generated from the RHS and then
248660ec914cSpeter.d.reid ** pX->iTable made to point to the ephemeral table instead of an
2487d4305ca6Sdrh ** existing table.
2488d4305ca6Sdrh **
24897fc0ba0fSdrh ** The inFlags parameter must contain, at a minimum, one of the bits
24907fc0ba0fSdrh ** IN_INDEX_MEMBERSHIP or IN_INDEX_LOOP but not both.  If inFlags contains
24917fc0ba0fSdrh ** IN_INDEX_MEMBERSHIP, then the generated table will be used for a fast
24927fc0ba0fSdrh ** membership test.  When the IN_INDEX_LOOP bit is set, the IN index will
24937fc0ba0fSdrh ** be used to loop over all values of the RHS of the IN operator.
24943a85625dSdrh **
24953a85625dSdrh ** When IN_INDEX_LOOP is used (and the b-tree will be used to iterate
24963a85625dSdrh ** through the set members) then the b-tree must not contain duplicates.
24977fc0ba0fSdrh ** An epheremal table will be created unless the selected columns are guaranteed
2498553168c7Sdan ** to be unique - either because it is an INTEGER PRIMARY KEY or due to
2499553168c7Sdan ** a UNIQUE constraint or index.
25000cdc022eSdanielk1977 **
25013a85625dSdrh ** When IN_INDEX_MEMBERSHIP is used (and the b-tree will be used
25023a85625dSdrh ** for fast set membership tests) then an epheremal table must
2503553168c7Sdan ** be used unless <columns> is a single INTEGER PRIMARY KEY column or an
2504553168c7Sdan ** index can be found with the specified <columns> as its left-most.
25050cdc022eSdanielk1977 **
2506bb53ecb1Sdrh ** If the IN_INDEX_NOOP_OK and IN_INDEX_MEMBERSHIP are both set and
2507bb53ecb1Sdrh ** if the RHS of the IN operator is a list (not a subquery) then this
2508bb53ecb1Sdrh ** routine might decide that creating an ephemeral b-tree for membership
2509bb53ecb1Sdrh ** testing is too expensive and return IN_INDEX_NOOP.  In that case, the
2510bb53ecb1Sdrh ** calling routine should implement the IN operator using a sequence
2511bb53ecb1Sdrh ** of Eq or Ne comparison operations.
2512bb53ecb1Sdrh **
2513b74b1017Sdrh ** When the b-tree is being used for membership tests, the calling function
25143a85625dSdrh ** might need to know whether or not the RHS side of the IN operator
2515e21a6e1dSdrh ** contains a NULL.  If prRhsHasNull is not a NULL pointer and
25163a85625dSdrh ** if there is any chance that the (...) might contain a NULL value at
25170cdc022eSdanielk1977 ** runtime, then a register is allocated and the register number written
2518e21a6e1dSdrh ** to *prRhsHasNull. If there is no chance that the (...) contains a
2519e21a6e1dSdrh ** NULL value, then *prRhsHasNull is left unchanged.
25200cdc022eSdanielk1977 **
2521e21a6e1dSdrh ** If a register is allocated and its location stored in *prRhsHasNull, then
25226be515ebSdrh ** the value in that register will be NULL if the b-tree contains one or more
25236be515ebSdrh ** NULL values, and it will be some non-NULL value if the b-tree contains no
25246be515ebSdrh ** NULL values.
2525553168c7Sdan **
2526553168c7Sdan ** If the aiMap parameter is not NULL, it must point to an array containing
2527553168c7Sdan ** one element for each column returned by the SELECT statement on the RHS
2528553168c7Sdan ** of the IN(...) operator. The i'th entry of the array is populated with the
2529553168c7Sdan ** offset of the index column that matches the i'th column returned by the
2530553168c7Sdan ** SELECT. For example, if the expression and selected index are:
2531553168c7Sdan **
2532553168c7Sdan **   (?,?,?) IN (SELECT a, b, c FROM t1)
2533553168c7Sdan **   CREATE INDEX i1 ON t1(b, c, a);
2534553168c7Sdan **
2535553168c7Sdan ** then aiMap[] is populated with {2, 0, 1}.
25369a96b668Sdanielk1977 */
2537284f4acaSdanielk1977 #ifndef SQLITE_OMIT_SUBQUERY
2538ba00e30aSdan int sqlite3FindInIndex(
25396fc8f364Sdrh   Parse *pParse,             /* Parsing context */
25400167ef20Sdrh   Expr *pX,                  /* The IN expression */
25416fc8f364Sdrh   u32 inFlags,               /* IN_INDEX_LOOP, _MEMBERSHIP, and/or _NOOP_OK */
25426fc8f364Sdrh   int *prRhsHasNull,         /* Register holding NULL status.  See notes */
25432c04131cSdrh   int *aiMap,                /* Mapping from Index fields to RHS fields */
25442c04131cSdrh   int *piTab                 /* OUT: index to use */
2545ba00e30aSdan ){
2546b74b1017Sdrh   Select *p;                            /* SELECT to the right of IN operator */
2547b74b1017Sdrh   int eType = 0;                        /* Type of RHS table. IN_INDEX_* */
2548b74b1017Sdrh   int iTab = pParse->nTab++;            /* Cursor of the RHS table */
25493a85625dSdrh   int mustBeUnique;                     /* True if RHS must be unique */
2550b8475df8Sdrh   Vdbe *v = sqlite3GetVdbe(pParse);     /* Virtual machine being coded */
25519a96b668Sdanielk1977 
25521450bc6eSdrh   assert( pX->op==TK_IN );
25533a85625dSdrh   mustBeUnique = (inFlags & IN_INDEX_LOOP)!=0;
25541450bc6eSdrh 
25557b35a77bSdan   /* If the RHS of this IN(...) operator is a SELECT, and if it matters
25567b35a77bSdan   ** whether or not the SELECT result contains NULL values, check whether
2557870a0705Sdan   ** or not NULL is actually possible (it may not be, for example, due
25587b35a77bSdan   ** to NOT NULL constraints in the schema). If no NULL values are possible,
2559870a0705Sdan   ** set prRhsHasNull to 0 before continuing.  */
25607b35a77bSdan   if( prRhsHasNull && (pX->flags & EP_xIsSelect) ){
25617b35a77bSdan     int i;
25627b35a77bSdan     ExprList *pEList = pX->x.pSelect->pEList;
25637b35a77bSdan     for(i=0; i<pEList->nExpr; i++){
25647b35a77bSdan       if( sqlite3ExprCanBeNull(pEList->a[i].pExpr) ) break;
25657b35a77bSdan     }
25667b35a77bSdan     if( i==pEList->nExpr ){
25677b35a77bSdan       prRhsHasNull = 0;
25687b35a77bSdan     }
25697b35a77bSdan   }
25707b35a77bSdan 
2571b74b1017Sdrh   /* Check to see if an existing table or index can be used to
2572b74b1017Sdrh   ** satisfy the query.  This is preferable to generating a new
25737b35a77bSdan   ** ephemeral table.  */
25747b35a77bSdan   if( pParse->nErr==0 && (p = isCandidateForInOpt(pX))!=0 ){
2575e1fb65a0Sdanielk1977     sqlite3 *db = pParse->db;              /* Database connection */
2576b07028f7Sdrh     Table *pTab;                           /* Table <table>. */
2577399062ccSdrh     int iDb;                               /* Database idx for pTab */
2578cfbb5e82Sdan     ExprList *pEList = p->pEList;
2579cfbb5e82Sdan     int nExpr = pEList->nExpr;
2580e1fb65a0Sdanielk1977 
2581b07028f7Sdrh     assert( p->pEList!=0 );             /* Because of isCandidateForInOpt(p) */
2582b07028f7Sdrh     assert( p->pEList->a[0].pExpr!=0 ); /* Because of isCandidateForInOpt(p) */
2583b07028f7Sdrh     assert( p->pSrc!=0 );               /* Because of isCandidateForInOpt(p) */
2584b07028f7Sdrh     pTab = p->pSrc->a[0].pTab;
2585b07028f7Sdrh 
2586b22f7c83Sdrh     /* Code an OP_Transaction and OP_TableLock for <table>. */
2587e1fb65a0Sdanielk1977     iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
2588bdd4f7d9Sdrh     assert( iDb>=0 && iDb<SQLITE_MAX_ATTACHED );
2589e1fb65a0Sdanielk1977     sqlite3CodeVerifySchema(pParse, iDb);
2590e1fb65a0Sdanielk1977     sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
25919a96b668Sdanielk1977 
2592a84a283dSdrh     assert(v);  /* sqlite3GetVdbe() has always been previously called */
2593cfbb5e82Sdan     if( nExpr==1 && pEList->a[0].pExpr->iColumn<0 ){
259462659b2aSdrh       /* The "x IN (SELECT rowid FROM table)" case */
2595511f9e8dSdrh       int iAddr = sqlite3VdbeAddOp0(v, OP_Once);
25967d176105Sdrh       VdbeCoverage(v);
25979a96b668Sdanielk1977 
25989a96b668Sdanielk1977       sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
25999a96b668Sdanielk1977       eType = IN_INDEX_ROWID;
2600d8852095Sdrh       ExplainQueryPlan((pParse, 0,
2601d8852095Sdrh             "USING ROWID SEARCH ON TABLE %s FOR IN-OPERATOR",pTab->zName));
26029a96b668Sdanielk1977       sqlite3VdbeJumpHere(v, iAddr);
26039a96b668Sdanielk1977     }else{
2604e1fb65a0Sdanielk1977       Index *pIdx;                         /* Iterator variable */
2605cfbb5e82Sdan       int affinity_ok = 1;
2606cfbb5e82Sdan       int i;
2607cfbb5e82Sdan 
2608cfbb5e82Sdan       /* Check that the affinity that will be used to perform each
260962659b2aSdrh       ** comparison is the same as the affinity of each column in table
261062659b2aSdrh       ** on the RHS of the IN operator.  If it not, it is not possible to
261162659b2aSdrh       ** use any index of the RHS table.  */
2612cfbb5e82Sdan       for(i=0; i<nExpr && affinity_ok; i++){
2613fc7f27b9Sdrh         Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2614cfbb5e82Sdan         int iCol = pEList->a[i].pExpr->iColumn;
26150dfa4f6fSdrh         char idxaff = sqlite3TableColumnAffinity(pTab,iCol); /* RHS table */
2616cfbb5e82Sdan         char cmpaff = sqlite3CompareAffinity(pLhs, idxaff);
261762659b2aSdrh         testcase( cmpaff==SQLITE_AFF_BLOB );
261862659b2aSdrh         testcase( cmpaff==SQLITE_AFF_TEXT );
2619cfbb5e82Sdan         switch( cmpaff ){
2620cfbb5e82Sdan           case SQLITE_AFF_BLOB:
2621cfbb5e82Sdan             break;
2622cfbb5e82Sdan           case SQLITE_AFF_TEXT:
262362659b2aSdrh             /* sqlite3CompareAffinity() only returns TEXT if one side or the
262462659b2aSdrh             ** other has no affinity and the other side is TEXT.  Hence,
262562659b2aSdrh             ** the only way for cmpaff to be TEXT is for idxaff to be TEXT
262662659b2aSdrh             ** and for the term on the LHS of the IN to have no affinity. */
262762659b2aSdrh             assert( idxaff==SQLITE_AFF_TEXT );
2628cfbb5e82Sdan             break;
2629cfbb5e82Sdan           default:
2630cfbb5e82Sdan             affinity_ok = sqlite3IsNumericAffinity(idxaff);
2631cfbb5e82Sdan         }
2632cfbb5e82Sdan       }
2633e1fb65a0Sdanielk1977 
2634a84a283dSdrh       if( affinity_ok ){
2635a84a283dSdrh         /* Search for an existing index that will work for this IN operator */
2636a84a283dSdrh         for(pIdx=pTab->pIndex; pIdx && eType==0; pIdx=pIdx->pNext){
2637a84a283dSdrh           Bitmask colUsed;      /* Columns of the index used */
2638a84a283dSdrh           Bitmask mCol;         /* Mask for the current column */
26396fc8f364Sdrh           if( pIdx->nColumn<nExpr ) continue;
2640d4a4a361Sdrh           if( pIdx->pPartIdxWhere!=0 ) continue;
2641a84a283dSdrh           /* Maximum nColumn is BMS-2, not BMS-1, so that we can compute
2642a84a283dSdrh           ** BITMASK(nExpr) without overflowing */
2643a84a283dSdrh           testcase( pIdx->nColumn==BMS-2 );
2644a84a283dSdrh           testcase( pIdx->nColumn==BMS-1 );
2645a84a283dSdrh           if( pIdx->nColumn>=BMS-1 ) continue;
26466fc8f364Sdrh           if( mustBeUnique ){
26476fc8f364Sdrh             if( pIdx->nKeyCol>nExpr
26486fc8f364Sdrh              ||(pIdx->nColumn>nExpr && !IsUniqueIndex(pIdx))
26496fc8f364Sdrh             ){
2650a84a283dSdrh               continue;  /* This index is not unique over the IN RHS columns */
2651cfbb5e82Sdan             }
26526fc8f364Sdrh           }
2653cfbb5e82Sdan 
2654a84a283dSdrh           colUsed = 0;   /* Columns of index used so far */
2655cfbb5e82Sdan           for(i=0; i<nExpr; i++){
2656fc7f27b9Sdrh             Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2657cfbb5e82Sdan             Expr *pRhs = pEList->a[i].pExpr;
2658cfbb5e82Sdan             CollSeq *pReq = sqlite3BinaryCompareCollSeq(pParse, pLhs, pRhs);
2659cfbb5e82Sdan             int j;
2660cfbb5e82Sdan 
26616fc8f364Sdrh             assert( pReq!=0 || pRhs->iColumn==XN_ROWID || pParse->nErr );
2662cfbb5e82Sdan             for(j=0; j<nExpr; j++){
2663cfbb5e82Sdan               if( pIdx->aiColumn[j]!=pRhs->iColumn ) continue;
2664cfbb5e82Sdan               assert( pIdx->azColl[j] );
2665106526e1Sdrh               if( pReq!=0 && sqlite3StrICmp(pReq->zName, pIdx->azColl[j])!=0 ){
2666106526e1Sdrh                 continue;
2667106526e1Sdrh               }
2668cfbb5e82Sdan               break;
2669cfbb5e82Sdan             }
2670cfbb5e82Sdan             if( j==nExpr ) break;
2671a84a283dSdrh             mCol = MASKBIT(j);
2672a84a283dSdrh             if( mCol & colUsed ) break; /* Each column used only once */
2673a84a283dSdrh             colUsed |= mCol;
2674ba00e30aSdan             if( aiMap ) aiMap[i] = j;
2675cfbb5e82Sdan           }
2676cfbb5e82Sdan 
2677a84a283dSdrh           assert( i==nExpr || colUsed!=(MASKBIT(nExpr)-1) );
2678a84a283dSdrh           if( colUsed==(MASKBIT(nExpr)-1) ){
2679a84a283dSdrh             /* If we reach this point, that means the index pIdx is usable */
2680511f9e8dSdrh             int iAddr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
2681e2ca99c9Sdrh             ExplainQueryPlan((pParse, 0,
2682e2ca99c9Sdrh                               "USING INDEX %s FOR IN-OPERATOR",pIdx->zName));
26832ec2fb22Sdrh             sqlite3VdbeAddOp3(v, OP_OpenRead, iTab, pIdx->tnum, iDb);
26842ec2fb22Sdrh             sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
2685207872a4Sdanielk1977             VdbeComment((v, "%s", pIdx->zName));
26861ccce449Sdrh             assert( IN_INDEX_INDEX_DESC == IN_INDEX_INDEX_ASC+1 );
26871ccce449Sdrh             eType = IN_INDEX_INDEX_ASC + pIdx->aSortOrder[0];
26889a96b668Sdanielk1977 
26897b35a77bSdan             if( prRhsHasNull ){
26903480bfdaSdan #ifdef SQLITE_ENABLE_COLUMN_USED_MASK
2691cfbb5e82Sdan               i64 mask = (1<<nExpr)-1;
26923480bfdaSdan               sqlite3VdbeAddOp4Dup8(v, OP_ColumnsUsed,
2693cfbb5e82Sdan                   iTab, 0, 0, (u8*)&mask, P4_INT64);
26943480bfdaSdan #endif
2695b80dbdc2Sdrh               *prRhsHasNull = ++pParse->nMem;
26967b35a77bSdan               if( nExpr==1 ){
26976be515ebSdrh                 sqlite3SetHasNullFlag(v, iTab, *prRhsHasNull);
26980cdc022eSdanielk1977               }
26997b35a77bSdan             }
2700552fd454Sdrh             sqlite3VdbeJumpHere(v, iAddr);
27019a96b668Sdanielk1977           }
2702a84a283dSdrh         } /* End loop over indexes */
2703a84a283dSdrh       } /* End if( affinity_ok ) */
2704a84a283dSdrh     } /* End if not an rowid index */
2705a84a283dSdrh   } /* End attempt to optimize using an index */
27069a96b668Sdanielk1977 
2707bb53ecb1Sdrh   /* If no preexisting index is available for the IN clause
2708bb53ecb1Sdrh   ** and IN_INDEX_NOOP is an allowed reply
2709bb53ecb1Sdrh   ** and the RHS of the IN operator is a list, not a subquery
271071c57db0Sdan   ** and the RHS is not constant or has two or fewer terms,
271160ec914cSpeter.d.reid   ** then it is not worth creating an ephemeral table to evaluate
2712bb53ecb1Sdrh   ** the IN operator so return IN_INDEX_NOOP.
2713bb53ecb1Sdrh   */
2714bb53ecb1Sdrh   if( eType==0
2715bb53ecb1Sdrh    && (inFlags & IN_INDEX_NOOP_OK)
2716bb53ecb1Sdrh    && !ExprHasProperty(pX, EP_xIsSelect)
2717bb53ecb1Sdrh    && (!sqlite3InRhsIsConstant(pX) || pX->x.pList->nExpr<=2)
2718bb53ecb1Sdrh   ){
2719bb53ecb1Sdrh     eType = IN_INDEX_NOOP;
2720bb53ecb1Sdrh   }
2721bb53ecb1Sdrh 
27229a96b668Sdanielk1977   if( eType==0 ){
27234387006cSdrh     /* Could not find an existing table or index to use as the RHS b-tree.
2724b74b1017Sdrh     ** We will have to generate an ephemeral table to do the job.
2725b74b1017Sdrh     */
27268e23daf3Sdrh     u32 savedNQueryLoop = pParse->nQueryLoop;
27270cdc022eSdanielk1977     int rMayHaveNull = 0;
272841a05b7bSdanielk1977     eType = IN_INDEX_EPH;
27293a85625dSdrh     if( inFlags & IN_INDEX_LOOP ){
27304a5acf8eSdrh       pParse->nQueryLoop = 0;
2731e21a6e1dSdrh     }else if( prRhsHasNull ){
2732e21a6e1dSdrh       *prRhsHasNull = rMayHaveNull = ++pParse->nMem;
2733cf4d38aaSdrh     }
273485bcdce2Sdrh     assert( pX->op==TK_IN );
273550ef6716Sdrh     sqlite3CodeRhsOfIN(pParse, pX, iTab);
273685bcdce2Sdrh     if( rMayHaveNull ){
27372c04131cSdrh       sqlite3SetHasNullFlag(v, iTab, rMayHaveNull);
273885bcdce2Sdrh     }
2739cf4d38aaSdrh     pParse->nQueryLoop = savedNQueryLoop;
27409a96b668Sdanielk1977   }
2741ba00e30aSdan 
2742ba00e30aSdan   if( aiMap && eType!=IN_INDEX_INDEX_ASC && eType!=IN_INDEX_INDEX_DESC ){
2743ba00e30aSdan     int i, n;
2744ba00e30aSdan     n = sqlite3ExprVectorSize(pX->pLeft);
2745ba00e30aSdan     for(i=0; i<n; i++) aiMap[i] = i;
2746ba00e30aSdan   }
27472c04131cSdrh   *piTab = iTab;
27489a96b668Sdanielk1977   return eType;
27499a96b668Sdanielk1977 }
2750284f4acaSdanielk1977 #endif
2751626a879aSdrh 
2752f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
2753553168c7Sdan /*
2754553168c7Sdan ** Argument pExpr is an (?, ?...) IN(...) expression. This
2755553168c7Sdan ** function allocates and returns a nul-terminated string containing
2756553168c7Sdan ** the affinities to be used for each column of the comparison.
2757553168c7Sdan **
2758553168c7Sdan ** It is the responsibility of the caller to ensure that the returned
2759553168c7Sdan ** string is eventually freed using sqlite3DbFree().
2760553168c7Sdan */
276171c57db0Sdan static char *exprINAffinity(Parse *pParse, Expr *pExpr){
276271c57db0Sdan   Expr *pLeft = pExpr->pLeft;
276371c57db0Sdan   int nVal = sqlite3ExprVectorSize(pLeft);
2764553168c7Sdan   Select *pSelect = (pExpr->flags & EP_xIsSelect) ? pExpr->x.pSelect : 0;
276571c57db0Sdan   char *zRet;
276671c57db0Sdan 
2767553168c7Sdan   assert( pExpr->op==TK_IN );
27685c258dc1Sdrh   zRet = sqlite3DbMallocRaw(pParse->db, nVal+1);
276971c57db0Sdan   if( zRet ){
277071c57db0Sdan     int i;
277171c57db0Sdan     for(i=0; i<nVal; i++){
2772fc7f27b9Sdrh       Expr *pA = sqlite3VectorFieldSubexpr(pLeft, i);
2773553168c7Sdan       char a = sqlite3ExprAffinity(pA);
2774553168c7Sdan       if( pSelect ){
2775553168c7Sdan         zRet[i] = sqlite3CompareAffinity(pSelect->pEList->a[i].pExpr, a);
277671c57db0Sdan       }else{
2777553168c7Sdan         zRet[i] = a;
277871c57db0Sdan       }
277971c57db0Sdan     }
278071c57db0Sdan     zRet[nVal] = '\0';
278171c57db0Sdan   }
278271c57db0Sdan   return zRet;
278371c57db0Sdan }
2784f9b2e05cSdan #endif
278571c57db0Sdan 
27868da209b1Sdan #ifndef SQLITE_OMIT_SUBQUERY
27878da209b1Sdan /*
27888da209b1Sdan ** Load the Parse object passed as the first argument with an error
27898da209b1Sdan ** message of the form:
27908da209b1Sdan **
27918da209b1Sdan **   "sub-select returns N columns - expected M"
27928da209b1Sdan */
27938da209b1Sdan void sqlite3SubselectError(Parse *pParse, int nActual, int nExpect){
2794a9ebfe20Sdrh   if( pParse->nErr==0 ){
27958da209b1Sdan     const char *zFmt = "sub-select returns %d columns - expected %d";
27968da209b1Sdan     sqlite3ErrorMsg(pParse, zFmt, nActual, nExpect);
27978da209b1Sdan   }
2798a9ebfe20Sdrh }
27998da209b1Sdan #endif
28008da209b1Sdan 
2801626a879aSdrh /*
280244c5604cSdan ** Expression pExpr is a vector that has been used in a context where
280344c5604cSdan ** it is not permitted. If pExpr is a sub-select vector, this routine
280444c5604cSdan ** loads the Parse object with a message of the form:
280544c5604cSdan **
280644c5604cSdan **   "sub-select returns N columns - expected 1"
280744c5604cSdan **
280844c5604cSdan ** Or, if it is a regular scalar vector:
280944c5604cSdan **
281044c5604cSdan **   "row value misused"
281144c5604cSdan */
281244c5604cSdan void sqlite3VectorErrorMsg(Parse *pParse, Expr *pExpr){
281344c5604cSdan #ifndef SQLITE_OMIT_SUBQUERY
281444c5604cSdan   if( pExpr->flags & EP_xIsSelect ){
281544c5604cSdan     sqlite3SubselectError(pParse, pExpr->x.pSelect->pEList->nExpr, 1);
281644c5604cSdan   }else
281744c5604cSdan #endif
281844c5604cSdan   {
281944c5604cSdan     sqlite3ErrorMsg(pParse, "row value misused");
282044c5604cSdan   }
282144c5604cSdan }
282244c5604cSdan 
282385bcdce2Sdrh #ifndef SQLITE_OMIT_SUBQUERY
282444c5604cSdan /*
282585bcdce2Sdrh ** Generate code that will construct an ephemeral table containing all terms
282685bcdce2Sdrh ** in the RHS of an IN operator.  The IN operator can be in either of two
282785bcdce2Sdrh ** forms:
2828626a879aSdrh **
28299cbe6352Sdrh **     x IN (4,5,11)              -- IN operator with list on right-hand side
28309cbe6352Sdrh **     x IN (SELECT a FROM b)     -- IN operator with subquery on the right
2831fef5208cSdrh **
28322c04131cSdrh ** The pExpr parameter is the IN operator.  The cursor number for the
28332c04131cSdrh ** constructed ephermeral table is returned.  The first time the ephemeral
28342c04131cSdrh ** table is computed, the cursor number is also stored in pExpr->iTable,
28352c04131cSdrh ** however the cursor number returned might not be the same, as it might
28362c04131cSdrh ** have been duplicated using OP_OpenDup.
283741a05b7bSdanielk1977 **
283885bcdce2Sdrh ** If the LHS expression ("x" in the examples) is a column value, or
283985bcdce2Sdrh ** the SELECT statement returns a column value, then the affinity of that
284085bcdce2Sdrh ** column is used to build the index keys. If both 'x' and the
284185bcdce2Sdrh ** SELECT... statement are columns, then numeric affinity is used
284285bcdce2Sdrh ** if either column has NUMERIC or INTEGER affinity. If neither
284385bcdce2Sdrh ** 'x' nor the SELECT... statement are columns, then numeric affinity
284485bcdce2Sdrh ** is used.
2845cce7d176Sdrh */
284685bcdce2Sdrh void sqlite3CodeRhsOfIN(
2847fd773cf9Sdrh   Parse *pParse,          /* Parsing context */
284885bcdce2Sdrh   Expr *pExpr,            /* The IN operator */
284950ef6716Sdrh   int iTab                /* Use this cursor number */
285041a05b7bSdanielk1977 ){
28512c04131cSdrh   int addrOnce = 0;           /* Address of the OP_Once instruction at top */
285285bcdce2Sdrh   int addr;                   /* Address of OP_OpenEphemeral instruction */
285385bcdce2Sdrh   Expr *pLeft;                /* the LHS of the IN operator */
285485bcdce2Sdrh   KeyInfo *pKeyInfo = 0;      /* Key information */
285585bcdce2Sdrh   int nVal;                   /* Size of vector pLeft */
285685bcdce2Sdrh   Vdbe *v;                    /* The prepared statement under construction */
2857fc976065Sdanielk1977 
28582c04131cSdrh   v = pParse->pVdbe;
285985bcdce2Sdrh   assert( v!=0 );
286085bcdce2Sdrh 
28612c04131cSdrh   /* The evaluation of the IN must be repeated every time it
286239a11819Sdrh   ** is encountered if any of the following is true:
286357dbd7b3Sdrh   **
286457dbd7b3Sdrh   **    *  The right-hand side is a correlated subquery
286557dbd7b3Sdrh   **    *  The right-hand side is an expression list containing variables
286657dbd7b3Sdrh   **    *  We are inside a trigger
286757dbd7b3Sdrh   **
28682c04131cSdrh   ** If all of the above are false, then we can compute the RHS just once
28692c04131cSdrh   ** and reuse it many names.
2870b3bce662Sdanielk1977   */
2871efb699fcSdrh   if( !ExprHasProperty(pExpr, EP_VarSelect) && pParse->iSelfTab==0 ){
28722c04131cSdrh     /* Reuse of the RHS is allowed */
28732c04131cSdrh     /* If this routine has already been coded, but the previous code
28742c04131cSdrh     ** might not have been invoked yet, so invoke it now as a subroutine.
28752c04131cSdrh     */
28762c04131cSdrh     if( ExprHasProperty(pExpr, EP_Subrtn) ){
2877f9231c34Sdrh       addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
2878bd462bccSdrh       if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2879bd462bccSdrh         ExplainQueryPlan((pParse, 0, "REUSE LIST SUBQUERY %d",
2880bd462bccSdrh               pExpr->x.pSelect->selId));
2881bd462bccSdrh       }
28822c04131cSdrh       sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
28832c04131cSdrh                         pExpr->y.sub.iAddr);
28842c04131cSdrh       sqlite3VdbeAddOp2(v, OP_OpenDup, iTab, pExpr->iTable);
2885f9231c34Sdrh       sqlite3VdbeJumpHere(v, addrOnce);
28862c04131cSdrh       return;
28872c04131cSdrh     }
28882c04131cSdrh 
28892c04131cSdrh     /* Begin coding the subroutine */
28902c04131cSdrh     ExprSetProperty(pExpr, EP_Subrtn);
2891088489e8Sdrh     assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
28922c04131cSdrh     pExpr->y.sub.regReturn = ++pParse->nMem;
28932c04131cSdrh     pExpr->y.sub.iAddr =
28942c04131cSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 0, pExpr->y.sub.regReturn) + 1;
28952c04131cSdrh     VdbeComment((v, "return address"));
28962c04131cSdrh 
28972c04131cSdrh     addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
2898b3bce662Sdanielk1977   }
2899b3bce662Sdanielk1977 
290085bcdce2Sdrh   /* Check to see if this is a vector IN operator */
290185bcdce2Sdrh   pLeft = pExpr->pLeft;
290271c57db0Sdan   nVal = sqlite3ExprVectorSize(pLeft);
2903e014a838Sdanielk1977 
290485bcdce2Sdrh   /* Construct the ephemeral table that will contain the content of
290585bcdce2Sdrh   ** RHS of the IN operator.
2906fef5208cSdrh   */
29072c04131cSdrh   pExpr->iTable = iTab;
290850ef6716Sdrh   addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, pExpr->iTable, nVal);
29092c04131cSdrh #ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
29102c04131cSdrh   if( ExprHasProperty(pExpr, EP_xIsSelect) ){
29112c04131cSdrh     VdbeComment((v, "Result of SELECT %u", pExpr->x.pSelect->selId));
29122c04131cSdrh   }else{
29132c04131cSdrh     VdbeComment((v, "RHS of IN operator"));
29142c04131cSdrh   }
29152c04131cSdrh #endif
291650ef6716Sdrh   pKeyInfo = sqlite3KeyInfoAlloc(pParse->db, nVal, 1);
2917e014a838Sdanielk1977 
29186ab3a2ecSdanielk1977   if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2919e014a838Sdanielk1977     /* Case 1:     expr IN (SELECT ...)
2920e014a838Sdanielk1977     **
2921e014a838Sdanielk1977     ** Generate code to write the results of the select into the temporary
2922e014a838Sdanielk1977     ** table allocated and opened above.
2923e014a838Sdanielk1977     */
29244387006cSdrh     Select *pSelect = pExpr->x.pSelect;
292571c57db0Sdan     ExprList *pEList = pSelect->pEList;
29261013c932Sdrh 
29272c04131cSdrh     ExplainQueryPlan((pParse, 1, "%sLIST SUBQUERY %d",
29282c04131cSdrh         addrOnce?"":"CORRELATED ", pSelect->selId
2929e2ca99c9Sdrh     ));
293064bcb8cfSdrh     /* If the LHS and RHS of the IN operator do not match, that
293164bcb8cfSdrh     ** error will have been caught long before we reach this point. */
293264bcb8cfSdrh     if( ALWAYS(pEList->nExpr==nVal) ){
293371c57db0Sdan       SelectDest dest;
293471c57db0Sdan       int i;
2935bd462bccSdrh       sqlite3SelectDestInit(&dest, SRT_Set, iTab);
293671c57db0Sdan       dest.zAffSdst = exprINAffinity(pParse, pExpr);
29374387006cSdrh       pSelect->iLimit = 0;
29384387006cSdrh       testcase( pSelect->selFlags & SF_Distinct );
2939812ea833Sdrh       testcase( pKeyInfo==0 ); /* Caused by OOM in sqlite3KeyInfoAlloc() */
29404387006cSdrh       if( sqlite3Select(pParse, pSelect, &dest) ){
294171c57db0Sdan         sqlite3DbFree(pParse->db, dest.zAffSdst);
29422ec2fb22Sdrh         sqlite3KeyInfoUnref(pKeyInfo);
294385bcdce2Sdrh         return;
294494ccde58Sdrh       }
294571c57db0Sdan       sqlite3DbFree(pParse->db, dest.zAffSdst);
2946812ea833Sdrh       assert( pKeyInfo!=0 ); /* OOM will cause exit after sqlite3Select() */
29473535ec3eSdrh       assert( pEList!=0 );
29483535ec3eSdrh       assert( pEList->nExpr>0 );
29492ec2fb22Sdrh       assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
295071c57db0Sdan       for(i=0; i<nVal; i++){
2951773d3afaSdan         Expr *p = sqlite3VectorFieldSubexpr(pLeft, i);
295271c57db0Sdan         pKeyInfo->aColl[i] = sqlite3BinaryCompareCollSeq(
295371c57db0Sdan             pParse, p, pEList->a[i].pExpr
295471c57db0Sdan         );
295571c57db0Sdan       }
295671c57db0Sdan     }
2957a7d2db17Sdrh   }else if( ALWAYS(pExpr->x.pList!=0) ){
2958fef5208cSdrh     /* Case 2:     expr IN (exprlist)
2959fef5208cSdrh     **
2960e014a838Sdanielk1977     ** For each expression, build an index key from the evaluation and
2961e014a838Sdanielk1977     ** store it in the temporary table. If <expr> is a column, then use
2962e014a838Sdanielk1977     ** that columns affinity when building index keys. If <expr> is not
2963e014a838Sdanielk1977     ** a column, use numeric affinity.
2964fef5208cSdrh     */
296571c57db0Sdan     char affinity;            /* Affinity of the LHS of the IN */
2966e014a838Sdanielk1977     int i;
29676ab3a2ecSdanielk1977     ExprList *pList = pExpr->x.pList;
296857dbd7b3Sdrh     struct ExprList_item *pItem;
2969c324d446Sdan     int r1, r2;
297071c57db0Sdan     affinity = sqlite3ExprAffinity(pLeft);
297196fb16eeSdrh     if( affinity<=SQLITE_AFF_NONE ){
297205883a34Sdrh       affinity = SQLITE_AFF_BLOB;
297395b39590Sdrh     }else if( affinity==SQLITE_AFF_REAL ){
297495b39590Sdrh       affinity = SQLITE_AFF_NUMERIC;
2975e014a838Sdanielk1977     }
2976323df790Sdrh     if( pKeyInfo ){
29772ec2fb22Sdrh       assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
2978323df790Sdrh       pKeyInfo->aColl[0] = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
2979323df790Sdrh     }
2980e014a838Sdanielk1977 
2981e014a838Sdanielk1977     /* Loop through each expression in <exprlist>. */
29822d401ab8Sdrh     r1 = sqlite3GetTempReg(pParse);
29832d401ab8Sdrh     r2 = sqlite3GetTempReg(pParse);
298457dbd7b3Sdrh     for(i=pList->nExpr, pItem=pList->a; i>0; i--, pItem++){
298557dbd7b3Sdrh       Expr *pE2 = pItem->pExpr;
2986e014a838Sdanielk1977 
298757dbd7b3Sdrh       /* If the expression is not constant then we will need to
298857dbd7b3Sdrh       ** disable the test that was generated above that makes sure
298957dbd7b3Sdrh       ** this code only executes once.  Because for a non-constant
299057dbd7b3Sdrh       ** expression we need to rerun this code each time.
299157dbd7b3Sdrh       */
29922c04131cSdrh       if( addrOnce && !sqlite3ExprIsConstant(pE2) ){
29932c04131cSdrh         sqlite3VdbeChangeToNoop(v, addrOnce);
29947ac0e562Sdan         ExprClearProperty(pExpr, EP_Subrtn);
29952c04131cSdrh         addrOnce = 0;
29964794b980Sdrh       }
2997e014a838Sdanielk1977 
2998e014a838Sdanielk1977       /* Evaluate the expression and insert it into the temp table */
2999c324d446Sdan       sqlite3ExprCode(pParse, pE2, r1);
3000c324d446Sdan       sqlite3VdbeAddOp4(v, OP_MakeRecord, r1, 1, r2, &affinity, 1);
3001c324d446Sdan       sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iTab, r2, r1, 1);
3002fef5208cSdrh     }
30032d401ab8Sdrh     sqlite3ReleaseTempReg(pParse, r1);
30042d401ab8Sdrh     sqlite3ReleaseTempReg(pParse, r2);
3005fef5208cSdrh   }
3006323df790Sdrh   if( pKeyInfo ){
30072ec2fb22Sdrh     sqlite3VdbeChangeP4(v, addr, (void *)pKeyInfo, P4_KEYINFO);
300841a05b7bSdanielk1977   }
30092c04131cSdrh   if( addrOnce ){
30102c04131cSdrh     sqlite3VdbeJumpHere(v, addrOnce);
30112c04131cSdrh     /* Subroutine return */
30122c04131cSdrh     sqlite3VdbeAddOp1(v, OP_Return, pExpr->y.sub.regReturn);
30132c04131cSdrh     sqlite3VdbeChangeP1(v, pExpr->y.sub.iAddr-1, sqlite3VdbeCurrentAddr(v)-1);
30146d2566dfSdrh     sqlite3ClearTempRegCache(pParse);
301585bcdce2Sdrh   }
301685bcdce2Sdrh }
301785bcdce2Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
301885bcdce2Sdrh 
301985bcdce2Sdrh /*
302085bcdce2Sdrh ** Generate code for scalar subqueries used as a subquery expression
302185bcdce2Sdrh ** or EXISTS operator:
302285bcdce2Sdrh **
302385bcdce2Sdrh **     (SELECT a FROM b)          -- subquery
302485bcdce2Sdrh **     EXISTS (SELECT a FROM b)   -- EXISTS subquery
302585bcdce2Sdrh **
302685bcdce2Sdrh ** The pExpr parameter is the SELECT or EXISTS operator to be coded.
302785bcdce2Sdrh **
3028d86fe44aSdrh ** Return the register that holds the result.  For a multi-column SELECT,
302985bcdce2Sdrh ** the result is stored in a contiguous array of registers and the
303085bcdce2Sdrh ** return value is the register of the left-most result column.
303185bcdce2Sdrh ** Return 0 if an error occurs.
303285bcdce2Sdrh */
303385bcdce2Sdrh #ifndef SQLITE_OMIT_SUBQUERY
303485bcdce2Sdrh int sqlite3CodeSubselect(Parse *pParse, Expr *pExpr){
30352c04131cSdrh   int addrOnce = 0;           /* Address of OP_Once at top of subroutine */
303685bcdce2Sdrh   int rReg = 0;               /* Register storing resulting */
303785bcdce2Sdrh   Select *pSel;               /* SELECT statement to encode */
303885bcdce2Sdrh   SelectDest dest;            /* How to deal with SELECT result */
303985bcdce2Sdrh   int nReg;                   /* Registers to allocate */
304085bcdce2Sdrh   Expr *pLimit;               /* New limit expression */
30412c04131cSdrh 
30422c04131cSdrh   Vdbe *v = pParse->pVdbe;
304385bcdce2Sdrh   assert( v!=0 );
3044bd462bccSdrh   testcase( pExpr->op==TK_EXISTS );
3045bd462bccSdrh   testcase( pExpr->op==TK_SELECT );
3046bd462bccSdrh   assert( pExpr->op==TK_EXISTS || pExpr->op==TK_SELECT );
3047bd462bccSdrh   assert( ExprHasProperty(pExpr, EP_xIsSelect) );
3048bd462bccSdrh   pSel = pExpr->x.pSelect;
304985bcdce2Sdrh 
30505198ff57Sdrh   /* The evaluation of the EXISTS/SELECT must be repeated every time it
305185bcdce2Sdrh   ** is encountered if any of the following is true:
305285bcdce2Sdrh   **
305385bcdce2Sdrh   **    *  The right-hand side is a correlated subquery
305485bcdce2Sdrh   **    *  The right-hand side is an expression list containing variables
305585bcdce2Sdrh   **    *  We are inside a trigger
305685bcdce2Sdrh   **
305785bcdce2Sdrh   ** If all of the above are false, then we can run this code just once
305885bcdce2Sdrh   ** save the results, and reuse the same result on subsequent invocations.
305985bcdce2Sdrh   */
306085bcdce2Sdrh   if( !ExprHasProperty(pExpr, EP_VarSelect) ){
30615198ff57Sdrh     /* If this routine has already been coded, then invoke it as a
30625198ff57Sdrh     ** subroutine. */
30635198ff57Sdrh     if( ExprHasProperty(pExpr, EP_Subrtn) ){
3064bd462bccSdrh       ExplainQueryPlan((pParse, 0, "REUSE SUBQUERY %d", pSel->selId));
30655198ff57Sdrh       sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
30665198ff57Sdrh                         pExpr->y.sub.iAddr);
30675198ff57Sdrh       return pExpr->iTable;
30685198ff57Sdrh     }
30695198ff57Sdrh 
30705198ff57Sdrh     /* Begin coding the subroutine */
30715198ff57Sdrh     ExprSetProperty(pExpr, EP_Subrtn);
30725198ff57Sdrh     pExpr->y.sub.regReturn = ++pParse->nMem;
30735198ff57Sdrh     pExpr->y.sub.iAddr =
30745198ff57Sdrh       sqlite3VdbeAddOp2(v, OP_Integer, 0, pExpr->y.sub.regReturn) + 1;
30755198ff57Sdrh     VdbeComment((v, "return address"));
30765198ff57Sdrh 
30772c04131cSdrh     addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
3078fef5208cSdrh   }
3079fef5208cSdrh 
308085bcdce2Sdrh   /* For a SELECT, generate code to put the values for all columns of
308139a11819Sdrh   ** the first row into an array of registers and return the index of
308239a11819Sdrh   ** the first register.
308339a11819Sdrh   **
308439a11819Sdrh   ** If this is an EXISTS, write an integer 0 (not exists) or 1 (exists)
308539a11819Sdrh   ** into a register and return that register number.
308639a11819Sdrh   **
308739a11819Sdrh   ** In both cases, the query is augmented with "LIMIT 1".  Any
308839a11819Sdrh   ** preexisting limit is discarded in place of the new LIMIT 1.
3089fef5208cSdrh   */
3090bd462bccSdrh   ExplainQueryPlan((pParse, 1, "%sSCALAR SUBQUERY %d",
3091bd462bccSdrh         addrOnce?"":"CORRELATED ", pSel->selId));
309271c57db0Sdan   nReg = pExpr->op==TK_SELECT ? pSel->pEList->nExpr : 1;
309371c57db0Sdan   sqlite3SelectDestInit(&dest, 0, pParse->nMem+1);
309471c57db0Sdan   pParse->nMem += nReg;
309551522cd3Sdrh   if( pExpr->op==TK_SELECT ){
30966c8c8ce0Sdanielk1977     dest.eDest = SRT_Mem;
309753932ce8Sdrh     dest.iSdst = dest.iSDParm;
309871c57db0Sdan     dest.nSdst = nReg;
309971c57db0Sdan     sqlite3VdbeAddOp3(v, OP_Null, 0, dest.iSDParm, dest.iSDParm+nReg-1);
3100d4e70ebdSdrh     VdbeComment((v, "Init subquery result"));
310151522cd3Sdrh   }else{
31026c8c8ce0Sdanielk1977     dest.eDest = SRT_Exists;
31032b596da8Sdrh     sqlite3VdbeAddOp2(v, OP_Integer, 0, dest.iSDParm);
3104d4e70ebdSdrh     VdbeComment((v, "Init EXISTS result"));
310551522cd3Sdrh   }
31068c0833fbSdrh   if( pSel->pLimit ){
31077ca1347fSdrh     /* The subquery already has a limit.  If the pre-existing limit is X
31087ca1347fSdrh     ** then make the new limit X<>0 so that the new limit is either 1 or 0 */
31097ca1347fSdrh     sqlite3 *db = pParse->db;
31105776ee5cSdrh     pLimit = sqlite3Expr(db, TK_INTEGER, "0");
31117ca1347fSdrh     if( pLimit ){
31127ca1347fSdrh       pLimit->affExpr = SQLITE_AFF_NUMERIC;
31137ca1347fSdrh       pLimit = sqlite3PExpr(pParse, TK_NE,
31147ca1347fSdrh                             sqlite3ExprDup(db, pSel->pLimit->pLeft, 0), pLimit);
31157ca1347fSdrh     }
31167ca1347fSdrh     sqlite3ExprDelete(db, pSel->pLimit->pLeft);
31178c0833fbSdrh     pSel->pLimit->pLeft = pLimit;
31188c0833fbSdrh   }else{
31197ca1347fSdrh     /* If there is no pre-existing limit add a limit of 1 */
31205776ee5cSdrh     pLimit = sqlite3Expr(pParse->db, TK_INTEGER, "1");
31218c0833fbSdrh     pSel->pLimit = sqlite3PExpr(pParse, TK_LIMIT, pLimit, 0);
31228c0833fbSdrh   }
312348b5b041Sdrh   pSel->iLimit = 0;
31247d10d5a6Sdrh   if( sqlite3Select(pParse, pSel, &dest) ){
31251450bc6eSdrh     return 0;
312694ccde58Sdrh   }
31272c04131cSdrh   pExpr->iTable = rReg = dest.iSDParm;
3128ebb6a65dSdrh   ExprSetVVAProperty(pExpr, EP_NoReduce);
31292c04131cSdrh   if( addrOnce ){
31302c04131cSdrh     sqlite3VdbeJumpHere(v, addrOnce);
3131fc976065Sdanielk1977 
31322c04131cSdrh     /* Subroutine return */
31332c04131cSdrh     sqlite3VdbeAddOp1(v, OP_Return, pExpr->y.sub.regReturn);
31342c04131cSdrh     sqlite3VdbeChangeP1(v, pExpr->y.sub.iAddr-1, sqlite3VdbeCurrentAddr(v)-1);
31356d2566dfSdrh     sqlite3ClearTempRegCache(pParse);
31365198ff57Sdrh   }
31372c04131cSdrh 
31381450bc6eSdrh   return rReg;
3139cce7d176Sdrh }
314051522cd3Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
3141cce7d176Sdrh 
3142e3365e6cSdrh #ifndef SQLITE_OMIT_SUBQUERY
3143e3365e6cSdrh /*
31447b35a77bSdan ** Expr pIn is an IN(...) expression. This function checks that the
31457b35a77bSdan ** sub-select on the RHS of the IN() operator has the same number of
31467b35a77bSdan ** columns as the vector on the LHS. Or, if the RHS of the IN() is not
31477b35a77bSdan ** a sub-query, that the LHS is a vector of size 1.
31487b35a77bSdan */
31497b35a77bSdan int sqlite3ExprCheckIN(Parse *pParse, Expr *pIn){
31507b35a77bSdan   int nVector = sqlite3ExprVectorSize(pIn->pLeft);
31517b35a77bSdan   if( (pIn->flags & EP_xIsSelect) ){
31527b35a77bSdan     if( nVector!=pIn->x.pSelect->pEList->nExpr ){
31537b35a77bSdan       sqlite3SubselectError(pParse, pIn->x.pSelect->pEList->nExpr, nVector);
31547b35a77bSdan       return 1;
31557b35a77bSdan     }
31567b35a77bSdan   }else if( nVector!=1 ){
315744c5604cSdan     sqlite3VectorErrorMsg(pParse, pIn->pLeft);
31587b35a77bSdan     return 1;
31597b35a77bSdan   }
31607b35a77bSdan   return 0;
31617b35a77bSdan }
31627b35a77bSdan #endif
31637b35a77bSdan 
31647b35a77bSdan #ifndef SQLITE_OMIT_SUBQUERY
31657b35a77bSdan /*
3166e3365e6cSdrh ** Generate code for an IN expression.
3167e3365e6cSdrh **
3168e3365e6cSdrh **      x IN (SELECT ...)
3169e3365e6cSdrh **      x IN (value, value, ...)
3170e3365e6cSdrh **
3171ecb87ac8Sdrh ** The left-hand side (LHS) is a scalar or vector expression.  The
3172e347d3e8Sdrh ** right-hand side (RHS) is an array of zero or more scalar values, or a
3173e347d3e8Sdrh ** subquery.  If the RHS is a subquery, the number of result columns must
3174e347d3e8Sdrh ** match the number of columns in the vector on the LHS.  If the RHS is
3175e347d3e8Sdrh ** a list of values, the LHS must be a scalar.
3176e347d3e8Sdrh **
3177e347d3e8Sdrh ** The IN operator is true if the LHS value is contained within the RHS.
3178e347d3e8Sdrh ** The result is false if the LHS is definitely not in the RHS.  The
3179e347d3e8Sdrh ** result is NULL if the presence of the LHS in the RHS cannot be
3180e347d3e8Sdrh ** determined due to NULLs.
3181e3365e6cSdrh **
31826be515ebSdrh ** This routine generates code that jumps to destIfFalse if the LHS is not
3183e3365e6cSdrh ** contained within the RHS.  If due to NULLs we cannot determine if the LHS
3184e3365e6cSdrh ** is contained in the RHS then jump to destIfNull.  If the LHS is contained
3185e3365e6cSdrh ** within the RHS then fall through.
3186ecb87ac8Sdrh **
3187ecb87ac8Sdrh ** See the separate in-operator.md documentation file in the canonical
3188ecb87ac8Sdrh ** SQLite source tree for additional information.
3189e3365e6cSdrh */
3190e3365e6cSdrh static void sqlite3ExprCodeIN(
3191e3365e6cSdrh   Parse *pParse,        /* Parsing and code generating context */
3192e3365e6cSdrh   Expr *pExpr,          /* The IN expression */
3193e3365e6cSdrh   int destIfFalse,      /* Jump here if LHS is not contained in the RHS */
3194e3365e6cSdrh   int destIfNull        /* Jump here if the results are unknown due to NULLs */
3195e3365e6cSdrh ){
3196e3365e6cSdrh   int rRhsHasNull = 0;  /* Register that is true if RHS contains NULL values */
3197e3365e6cSdrh   int eType;            /* Type of the RHS */
3198e347d3e8Sdrh   int rLhs;             /* Register(s) holding the LHS values */
3199e347d3e8Sdrh   int rLhsOrig;         /* LHS values prior to reordering by aiMap[] */
3200e3365e6cSdrh   Vdbe *v;              /* Statement under construction */
3201ba00e30aSdan   int *aiMap = 0;       /* Map from vector field to index column */
3202ba00e30aSdan   char *zAff = 0;       /* Affinity string for comparisons */
3203ecb87ac8Sdrh   int nVector;          /* Size of vectors for this IN operator */
320412abf408Sdrh   int iDummy;           /* Dummy parameter to exprCodeVector() */
3205e347d3e8Sdrh   Expr *pLeft;          /* The LHS of the IN operator */
3206ecb87ac8Sdrh   int i;                /* loop counter */
3207e347d3e8Sdrh   int destStep2;        /* Where to jump when NULLs seen in step 2 */
3208e347d3e8Sdrh   int destStep6 = 0;    /* Start of code for Step 6 */
3209e347d3e8Sdrh   int addrTruthOp;      /* Address of opcode that determines the IN is true */
3210e347d3e8Sdrh   int destNotNull;      /* Jump here if a comparison is not true in step 6 */
3211e347d3e8Sdrh   int addrTop;          /* Top of the step-6 loop */
32122c04131cSdrh   int iTab = 0;         /* Index to use */
3213c59b4acfSdan   u8 okConstFactor = pParse->okConstFactor;
3214e3365e6cSdrh 
3215e7375bfaSdrh   assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
3216e347d3e8Sdrh   pLeft = pExpr->pLeft;
32177b35a77bSdan   if( sqlite3ExprCheckIN(pParse, pExpr) ) return;
3218553168c7Sdan   zAff = exprINAffinity(pParse, pExpr);
3219ba00e30aSdan   nVector = sqlite3ExprVectorSize(pExpr->pLeft);
3220ba00e30aSdan   aiMap = (int*)sqlite3DbMallocZero(
3221ba00e30aSdan       pParse->db, nVector*(sizeof(int) + sizeof(char)) + 1
3222ba00e30aSdan   );
3223e347d3e8Sdrh   if( pParse->db->mallocFailed ) goto sqlite3ExprCodeIN_oom_error;
32247b35a77bSdan 
3225ba00e30aSdan   /* Attempt to compute the RHS. After this step, if anything other than
32262c04131cSdrh   ** IN_INDEX_NOOP is returned, the table opened with cursor iTab
3227ba00e30aSdan   ** contains the values that make up the RHS. If IN_INDEX_NOOP is returned,
3228ba00e30aSdan   ** the RHS has not yet been coded.  */
3229e3365e6cSdrh   v = pParse->pVdbe;
3230e3365e6cSdrh   assert( v!=0 );       /* OOM detected prior to this routine */
3231e3365e6cSdrh   VdbeNoopComment((v, "begin IN expr"));
3232bb53ecb1Sdrh   eType = sqlite3FindInIndex(pParse, pExpr,
3233bb53ecb1Sdrh                              IN_INDEX_MEMBERSHIP | IN_INDEX_NOOP_OK,
32342c04131cSdrh                              destIfFalse==destIfNull ? 0 : &rRhsHasNull,
32352c04131cSdrh                              aiMap, &iTab);
3236e3365e6cSdrh 
3237ba00e30aSdan   assert( pParse->nErr || nVector==1 || eType==IN_INDEX_EPH
3238ba00e30aSdan        || eType==IN_INDEX_INDEX_ASC || eType==IN_INDEX_INDEX_DESC
3239ba00e30aSdan   );
3240ecb87ac8Sdrh #ifdef SQLITE_DEBUG
3241ecb87ac8Sdrh   /* Confirm that aiMap[] contains nVector integer values between 0 and
3242ecb87ac8Sdrh   ** nVector-1. */
3243ecb87ac8Sdrh   for(i=0; i<nVector; i++){
3244ecb87ac8Sdrh     int j, cnt;
3245ecb87ac8Sdrh     for(cnt=j=0; j<nVector; j++) if( aiMap[j]==i ) cnt++;
3246ecb87ac8Sdrh     assert( cnt==1 );
3247ecb87ac8Sdrh   }
3248ecb87ac8Sdrh #endif
3249e3365e6cSdrh 
3250ba00e30aSdan   /* Code the LHS, the <expr> from "<expr> IN (...)". If the LHS is a
3251ba00e30aSdan   ** vector, then it is stored in an array of nVector registers starting
3252ba00e30aSdan   ** at r1.
3253e347d3e8Sdrh   **
3254e347d3e8Sdrh   ** sqlite3FindInIndex() might have reordered the fields of the LHS vector
3255e347d3e8Sdrh   ** so that the fields are in the same order as an existing index.   The
3256e347d3e8Sdrh   ** aiMap[] array contains a mapping from the original LHS field order to
3257e347d3e8Sdrh   ** the field order that matches the RHS index.
3258c59b4acfSdan   **
3259c59b4acfSdan   ** Avoid factoring the LHS of the IN(...) expression out of the loop,
3260c59b4acfSdan   ** even if it is constant, as OP_Affinity may be used on the register
3261c59b4acfSdan   ** by code generated below.  */
3262c59b4acfSdan   assert( pParse->okConstFactor==okConstFactor );
3263c59b4acfSdan   pParse->okConstFactor = 0;
3264e347d3e8Sdrh   rLhsOrig = exprCodeVector(pParse, pLeft, &iDummy);
3265c59b4acfSdan   pParse->okConstFactor = okConstFactor;
3266e347d3e8Sdrh   for(i=0; i<nVector && aiMap[i]==i; i++){} /* Are LHS fields reordered? */
3267ecb87ac8Sdrh   if( i==nVector ){
3268e347d3e8Sdrh     /* LHS fields are not reordered */
3269e347d3e8Sdrh     rLhs = rLhsOrig;
3270ecb87ac8Sdrh   }else{
3271ecb87ac8Sdrh     /* Need to reorder the LHS fields according to aiMap */
3272e347d3e8Sdrh     rLhs = sqlite3GetTempRange(pParse, nVector);
3273ba00e30aSdan     for(i=0; i<nVector; i++){
3274e347d3e8Sdrh       sqlite3VdbeAddOp3(v, OP_Copy, rLhsOrig+i, rLhs+aiMap[i], 0);
3275ba00e30aSdan     }
3276ecb87ac8Sdrh   }
3277e3365e6cSdrh 
3278bb53ecb1Sdrh   /* If sqlite3FindInIndex() did not find or create an index that is
3279bb53ecb1Sdrh   ** suitable for evaluating the IN operator, then evaluate using a
3280bb53ecb1Sdrh   ** sequence of comparisons.
3281e347d3e8Sdrh   **
3282e347d3e8Sdrh   ** This is step (1) in the in-operator.md optimized algorithm.
3283bb53ecb1Sdrh   */
3284bb53ecb1Sdrh   if( eType==IN_INDEX_NOOP ){
3285bb53ecb1Sdrh     ExprList *pList = pExpr->x.pList;
3286bb53ecb1Sdrh     CollSeq *pColl = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
3287ec4ccdbcSdrh     int labelOk = sqlite3VdbeMakeLabel(pParse);
3288bb53ecb1Sdrh     int r2, regToFree;
3289bb53ecb1Sdrh     int regCkNull = 0;
3290bb53ecb1Sdrh     int ii;
3291bb53ecb1Sdrh     assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
3292bb53ecb1Sdrh     if( destIfNull!=destIfFalse ){
3293bb53ecb1Sdrh       regCkNull = sqlite3GetTempReg(pParse);
3294e347d3e8Sdrh       sqlite3VdbeAddOp3(v, OP_BitAnd, rLhs, rLhs, regCkNull);
3295bb53ecb1Sdrh     }
3296bb53ecb1Sdrh     for(ii=0; ii<pList->nExpr; ii++){
32974fc83654Sdrh       r2 = sqlite3ExprCodeTemp(pParse, pList->a[ii].pExpr, &regToFree);
3298a976979bSdrh       if( regCkNull && sqlite3ExprCanBeNull(pList->a[ii].pExpr) ){
3299bb53ecb1Sdrh         sqlite3VdbeAddOp3(v, OP_BitAnd, regCkNull, r2, regCkNull);
3300bb53ecb1Sdrh       }
3301f6ea97eaSdrh       sqlite3ReleaseTempReg(pParse, regToFree);
3302bb53ecb1Sdrh       if( ii<pList->nExpr-1 || destIfNull!=destIfFalse ){
33034799488eSdrh         int op = rLhs!=r2 ? OP_Eq : OP_NotNull;
33044799488eSdrh         sqlite3VdbeAddOp4(v, op, rLhs, labelOk, r2,
33054336b0e6Sdrh                           (void*)pColl, P4_COLLSEQ);
33064799488eSdrh         VdbeCoverageIf(v, ii<pList->nExpr-1 && op==OP_Eq);
33074799488eSdrh         VdbeCoverageIf(v, ii==pList->nExpr-1 && op==OP_Eq);
33084799488eSdrh         VdbeCoverageIf(v, ii<pList->nExpr-1 && op==OP_NotNull);
33094799488eSdrh         VdbeCoverageIf(v, ii==pList->nExpr-1 && op==OP_NotNull);
3310ba00e30aSdan         sqlite3VdbeChangeP5(v, zAff[0]);
3311bb53ecb1Sdrh       }else{
33124799488eSdrh         int op = rLhs!=r2 ? OP_Ne : OP_IsNull;
3313bb53ecb1Sdrh         assert( destIfNull==destIfFalse );
33144799488eSdrh         sqlite3VdbeAddOp4(v, op, rLhs, destIfFalse, r2,
33154799488eSdrh                           (void*)pColl, P4_COLLSEQ);
33164799488eSdrh         VdbeCoverageIf(v, op==OP_Ne);
33174799488eSdrh         VdbeCoverageIf(v, op==OP_IsNull);
3318ba00e30aSdan         sqlite3VdbeChangeP5(v, zAff[0] | SQLITE_JUMPIFNULL);
3319bb53ecb1Sdrh       }
3320bb53ecb1Sdrh     }
3321bb53ecb1Sdrh     if( regCkNull ){
3322bb53ecb1Sdrh       sqlite3VdbeAddOp2(v, OP_IsNull, regCkNull, destIfNull); VdbeCoverage(v);
3323076e85f5Sdrh       sqlite3VdbeGoto(v, destIfFalse);
3324bb53ecb1Sdrh     }
3325bb53ecb1Sdrh     sqlite3VdbeResolveLabel(v, labelOk);
3326bb53ecb1Sdrh     sqlite3ReleaseTempReg(pParse, regCkNull);
3327e347d3e8Sdrh     goto sqlite3ExprCodeIN_finished;
3328e347d3e8Sdrh   }
3329bb53ecb1Sdrh 
3330e347d3e8Sdrh   /* Step 2: Check to see if the LHS contains any NULL columns.  If the
3331e347d3e8Sdrh   ** LHS does contain NULLs then the result must be either FALSE or NULL.
3332e347d3e8Sdrh   ** We will then skip the binary search of the RHS.
3333e347d3e8Sdrh   */
3334094430ebSdrh   if( destIfNull==destIfFalse ){
3335e347d3e8Sdrh     destStep2 = destIfFalse;
3336e347d3e8Sdrh   }else{
3337ec4ccdbcSdrh     destStep2 = destStep6 = sqlite3VdbeMakeLabel(pParse);
3338e347d3e8Sdrh   }
33394eac5f04Sdrh   if( pParse->nErr ) goto sqlite3ExprCodeIN_finished;
3340d49fd4e8Sdan   for(i=0; i<nVector; i++){
3341fc7f27b9Sdrh     Expr *p = sqlite3VectorFieldSubexpr(pExpr->pLeft, i);
3342d49fd4e8Sdan     if( sqlite3ExprCanBeNull(p) ){
3343e347d3e8Sdrh       sqlite3VdbeAddOp2(v, OP_IsNull, rLhs+i, destStep2);
3344471b4b92Sdrh       VdbeCoverage(v);
3345d49fd4e8Sdan     }
3346d49fd4e8Sdan   }
3347e3365e6cSdrh 
3348e347d3e8Sdrh   /* Step 3.  The LHS is now known to be non-NULL.  Do the binary search
3349e347d3e8Sdrh   ** of the RHS using the LHS as a probe.  If found, the result is
3350e347d3e8Sdrh   ** true.
3351e347d3e8Sdrh   */
3352e3365e6cSdrh   if( eType==IN_INDEX_ROWID ){
3353e347d3e8Sdrh     /* In this case, the RHS is the ROWID of table b-tree and so we also
3354e347d3e8Sdrh     ** know that the RHS is non-NULL.  Hence, we combine steps 3 and 4
3355e347d3e8Sdrh     ** into a single opcode. */
33562c04131cSdrh     sqlite3VdbeAddOp3(v, OP_SeekRowid, iTab, destIfFalse, rLhs);
3357688852abSdrh     VdbeCoverage(v);
3358e347d3e8Sdrh     addrTruthOp = sqlite3VdbeAddOp0(v, OP_Goto);  /* Return True */
33597b35a77bSdan   }else{
3360e347d3e8Sdrh     sqlite3VdbeAddOp4(v, OP_Affinity, rLhs, nVector, 0, zAff, nVector);
3361e347d3e8Sdrh     if( destIfFalse==destIfNull ){
3362e347d3e8Sdrh       /* Combine Step 3 and Step 5 into a single opcode */
33632c04131cSdrh       sqlite3VdbeAddOp4Int(v, OP_NotFound, iTab, destIfFalse,
3364e347d3e8Sdrh                            rLhs, nVector); VdbeCoverage(v);
3365e347d3e8Sdrh       goto sqlite3ExprCodeIN_finished;
3366e347d3e8Sdrh     }
3367e347d3e8Sdrh     /* Ordinary Step 3, for the case where FALSE and NULL are distinct */
33682c04131cSdrh     addrTruthOp = sqlite3VdbeAddOp4Int(v, OP_Found, iTab, 0,
3369e347d3e8Sdrh                                       rLhs, nVector); VdbeCoverage(v);
3370e347d3e8Sdrh   }
3371ba00e30aSdan 
3372e347d3e8Sdrh   /* Step 4.  If the RHS is known to be non-NULL and we did not find
3373e347d3e8Sdrh   ** an match on the search above, then the result must be FALSE.
3374e347d3e8Sdrh   */
3375e347d3e8Sdrh   if( rRhsHasNull && nVector==1 ){
3376e347d3e8Sdrh     sqlite3VdbeAddOp2(v, OP_NotNull, rRhsHasNull, destIfFalse);
3377471b4b92Sdrh     VdbeCoverage(v);
3378e347d3e8Sdrh   }
33797b35a77bSdan 
3380e347d3e8Sdrh   /* Step 5.  If we do not care about the difference between NULL and
3381e347d3e8Sdrh   ** FALSE, then just return false.
3382e347d3e8Sdrh   */
3383e347d3e8Sdrh   if( destIfFalse==destIfNull ) sqlite3VdbeGoto(v, destIfFalse);
3384e347d3e8Sdrh 
3385e347d3e8Sdrh   /* Step 6: Loop through rows of the RHS.  Compare each row to the LHS.
3386e347d3e8Sdrh   ** If any comparison is NULL, then the result is NULL.  If all
3387e347d3e8Sdrh   ** comparisons are FALSE then the final result is FALSE.
3388e347d3e8Sdrh   **
3389e347d3e8Sdrh   ** For a scalar LHS, it is sufficient to check just the first row
3390e347d3e8Sdrh   ** of the RHS.
3391e347d3e8Sdrh   */
3392e347d3e8Sdrh   if( destStep6 ) sqlite3VdbeResolveLabel(v, destStep6);
33932c04131cSdrh   addrTop = sqlite3VdbeAddOp2(v, OP_Rewind, iTab, destIfFalse);
3394471b4b92Sdrh   VdbeCoverage(v);
3395e347d3e8Sdrh   if( nVector>1 ){
3396ec4ccdbcSdrh     destNotNull = sqlite3VdbeMakeLabel(pParse);
3397e347d3e8Sdrh   }else{
3398e347d3e8Sdrh     /* For nVector==1, combine steps 6 and 7 by immediately returning
3399e347d3e8Sdrh     ** FALSE if the first comparison is not NULL */
3400e347d3e8Sdrh     destNotNull = destIfFalse;
3401e347d3e8Sdrh   }
3402ba00e30aSdan   for(i=0; i<nVector; i++){
3403ba00e30aSdan     Expr *p;
3404ba00e30aSdan     CollSeq *pColl;
3405e347d3e8Sdrh     int r3 = sqlite3GetTempReg(pParse);
3406fc7f27b9Sdrh     p = sqlite3VectorFieldSubexpr(pLeft, i);
3407ba00e30aSdan     pColl = sqlite3ExprCollSeq(pParse, p);
34082c04131cSdrh     sqlite3VdbeAddOp3(v, OP_Column, iTab, i, r3);
3409e347d3e8Sdrh     sqlite3VdbeAddOp4(v, OP_Ne, rLhs+i, destNotNull, r3,
341018016ad2Sdrh                       (void*)pColl, P4_COLLSEQ);
3411471b4b92Sdrh     VdbeCoverage(v);
3412e347d3e8Sdrh     sqlite3ReleaseTempReg(pParse, r3);
34137b35a77bSdan   }
34147b35a77bSdan   sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfNull);
3415e347d3e8Sdrh   if( nVector>1 ){
3416e347d3e8Sdrh     sqlite3VdbeResolveLabel(v, destNotNull);
34172c04131cSdrh     sqlite3VdbeAddOp2(v, OP_Next, iTab, addrTop+1);
341818016ad2Sdrh     VdbeCoverage(v);
3419e347d3e8Sdrh 
3420e347d3e8Sdrh     /* Step 7:  If we reach this point, we know that the result must
3421e347d3e8Sdrh     ** be false. */
342218016ad2Sdrh     sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfFalse);
34237b35a77bSdan   }
34247b35a77bSdan 
3425e347d3e8Sdrh   /* Jumps here in order to return true. */
3426e347d3e8Sdrh   sqlite3VdbeJumpHere(v, addrTruthOp);
3427e3365e6cSdrh 
3428e347d3e8Sdrh sqlite3ExprCodeIN_finished:
3429e347d3e8Sdrh   if( rLhs!=rLhsOrig ) sqlite3ReleaseTempReg(pParse, rLhs);
3430ecb87ac8Sdrh   VdbeComment((v, "end IN expr"));
3431e347d3e8Sdrh sqlite3ExprCodeIN_oom_error:
3432ba00e30aSdan   sqlite3DbFree(pParse->db, aiMap);
3433553168c7Sdan   sqlite3DbFree(pParse->db, zAff);
3434e3365e6cSdrh }
3435e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
3436e3365e6cSdrh 
343713573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
3438598f1340Sdrh /*
3439598f1340Sdrh ** Generate an instruction that will put the floating point
34409cbf3425Sdrh ** value described by z[0..n-1] into register iMem.
34410cf19ed8Sdrh **
34420cf19ed8Sdrh ** The z[] string will probably not be zero-terminated.  But the
34430cf19ed8Sdrh ** z[n] character is guaranteed to be something that does not look
34440cf19ed8Sdrh ** like the continuation of the number.
3445598f1340Sdrh */
3446b7916a78Sdrh static void codeReal(Vdbe *v, const char *z, int negateFlag, int iMem){
3447fd773cf9Sdrh   if( ALWAYS(z!=0) ){
3448598f1340Sdrh     double value;
34499339da1fSdrh     sqlite3AtoF(z, &value, sqlite3Strlen30(z), SQLITE_UTF8);
3450d0015161Sdrh     assert( !sqlite3IsNaN(value) ); /* The new AtoF never returns NaN */
3451598f1340Sdrh     if( negateFlag ) value = -value;
345297bae794Sdrh     sqlite3VdbeAddOp4Dup8(v, OP_Real, 0, iMem, 0, (u8*)&value, P4_REAL);
3453598f1340Sdrh   }
3454598f1340Sdrh }
345513573c71Sdrh #endif
3456598f1340Sdrh 
3457598f1340Sdrh 
3458598f1340Sdrh /*
3459fec19aadSdrh ** Generate an instruction that will put the integer describe by
34609cbf3425Sdrh ** text z[0..n-1] into register iMem.
34610cf19ed8Sdrh **
34625f1d6b61Sshaneh ** Expr.u.zToken is always UTF8 and zero-terminated.
3463fec19aadSdrh */
346413573c71Sdrh static void codeInteger(Parse *pParse, Expr *pExpr, int negFlag, int iMem){
346513573c71Sdrh   Vdbe *v = pParse->pVdbe;
346692b01d53Sdrh   if( pExpr->flags & EP_IntValue ){
346733e619fcSdrh     int i = pExpr->u.iValue;
3468d50ffc41Sdrh     assert( i>=0 );
346992b01d53Sdrh     if( negFlag ) i = -i;
347092b01d53Sdrh     sqlite3VdbeAddOp2(v, OP_Integer, i, iMem);
3471fd773cf9Sdrh   }else{
34725f1d6b61Sshaneh     int c;
34735f1d6b61Sshaneh     i64 value;
3474fd773cf9Sdrh     const char *z = pExpr->u.zToken;
3475fd773cf9Sdrh     assert( z!=0 );
34769296c18aSdrh     c = sqlite3DecOrHexToI64(z, &value);
347784d4f1a3Sdrh     if( (c==3 && !negFlag) || (c==2) || (negFlag && value==SMALLEST_INT64)){
347813573c71Sdrh #ifdef SQLITE_OMIT_FLOATING_POINT
347913573c71Sdrh       sqlite3ErrorMsg(pParse, "oversized integer: %s%s", negFlag ? "-" : "", z);
348013573c71Sdrh #else
34811b7ddc59Sdrh #ifndef SQLITE_OMIT_HEX_INTEGER
34829296c18aSdrh       if( sqlite3_strnicmp(z,"0x",2)==0 ){
348377320ea4Sdrh         sqlite3ErrorMsg(pParse, "hex literal too big: %s%s", negFlag?"-":"",z);
34841b7ddc59Sdrh       }else
34851b7ddc59Sdrh #endif
34861b7ddc59Sdrh       {
3487b7916a78Sdrh         codeReal(v, z, negFlag, iMem);
34889296c18aSdrh       }
348913573c71Sdrh #endif
349077320ea4Sdrh     }else{
349184d4f1a3Sdrh       if( negFlag ){ value = c==3 ? SMALLEST_INT64 : -value; }
349277320ea4Sdrh       sqlite3VdbeAddOp4Dup8(v, OP_Int64, 0, iMem, 0, (u8*)&value, P4_INT64);
3493fec19aadSdrh     }
3494fec19aadSdrh   }
3495c9cf901dSdanielk1977 }
3496fec19aadSdrh 
34975cd79239Sdrh 
34981f9ca2c8Sdrh /* Generate code that will load into register regOut a value that is
34991f9ca2c8Sdrh ** appropriate for the iIdxCol-th column of index pIdx.
35001f9ca2c8Sdrh */
35011f9ca2c8Sdrh void sqlite3ExprCodeLoadIndexColumn(
35021f9ca2c8Sdrh   Parse *pParse,  /* The parsing context */
35031f9ca2c8Sdrh   Index *pIdx,    /* The index whose column is to be loaded */
35041f9ca2c8Sdrh   int iTabCur,    /* Cursor pointing to a table row */
35051f9ca2c8Sdrh   int iIdxCol,    /* The column of the index to be loaded */
35061f9ca2c8Sdrh   int regOut      /* Store the index column value in this register */
35071f9ca2c8Sdrh ){
35081f9ca2c8Sdrh   i16 iTabCol = pIdx->aiColumn[iIdxCol];
35094b92f98cSdrh   if( iTabCol==XN_EXPR ){
35101f9ca2c8Sdrh     assert( pIdx->aColExpr );
35111f9ca2c8Sdrh     assert( pIdx->aColExpr->nExpr>iIdxCol );
35123e34eabcSdrh     pParse->iSelfTab = iTabCur + 1;
35131c75c9d7Sdrh     sqlite3ExprCodeCopy(pParse, pIdx->aColExpr->a[iIdxCol].pExpr, regOut);
35143e34eabcSdrh     pParse->iSelfTab = 0;
35154b92f98cSdrh   }else{
35166df9c4b9Sdrh     sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pIdx->pTable, iTabCur,
35174b92f98cSdrh                                     iTabCol, regOut);
35184b92f98cSdrh   }
35191f9ca2c8Sdrh }
35201f9ca2c8Sdrh 
3521e70fa7feSdrh #ifndef SQLITE_OMIT_GENERATED_COLUMNS
3522e70fa7feSdrh /*
3523e70fa7feSdrh ** Generate code that will compute the value of generated column pCol
3524e70fa7feSdrh ** and store the result in register regOut
3525e70fa7feSdrh */
3526e70fa7feSdrh void sqlite3ExprCodeGeneratedColumn(
3527e70fa7feSdrh   Parse *pParse,
3528e70fa7feSdrh   Column *pCol,
3529e70fa7feSdrh   int regOut
3530e70fa7feSdrh ){
35314dad7ed5Sdrh   int iAddr;
35324dad7ed5Sdrh   Vdbe *v = pParse->pVdbe;
35334dad7ed5Sdrh   assert( v!=0 );
35344dad7ed5Sdrh   assert( pParse->iSelfTab!=0 );
35354dad7ed5Sdrh   if( pParse->iSelfTab>0 ){
35364dad7ed5Sdrh     iAddr = sqlite3VdbeAddOp3(v, OP_IfNullRow, pParse->iSelfTab-1, 0, regOut);
35374dad7ed5Sdrh   }else{
35384dad7ed5Sdrh     iAddr = 0;
35394dad7ed5Sdrh   }
354024e39903Sdrh   sqlite3ExprCodeCopy(pParse, pCol->pDflt, regOut);
3541e70fa7feSdrh   if( pCol->affinity>=SQLITE_AFF_TEXT ){
35424dad7ed5Sdrh     sqlite3VdbeAddOp4(v, OP_Affinity, regOut, 1, 0, &pCol->affinity, 1);
3543e70fa7feSdrh   }
35444dad7ed5Sdrh   if( iAddr ) sqlite3VdbeJumpHere(v, iAddr);
3545e70fa7feSdrh }
3546e70fa7feSdrh #endif /* SQLITE_OMIT_GENERATED_COLUMNS */
3547e70fa7feSdrh 
35485cd79239Sdrh /*
35495c092e8aSdrh ** Generate code to extract the value of the iCol-th column of a table.
35505c092e8aSdrh */
35515c092e8aSdrh void sqlite3ExprCodeGetColumnOfTable(
35526df9c4b9Sdrh   Vdbe *v,        /* Parsing context */
35535c092e8aSdrh   Table *pTab,    /* The table containing the value */
3554313619f5Sdrh   int iTabCur,    /* The table cursor.  Or the PK cursor for WITHOUT ROWID */
35555c092e8aSdrh   int iCol,       /* Index of the column to extract */
3556313619f5Sdrh   int regOut      /* Extract the value into this register */
35575c092e8aSdrh ){
3558ab45fc04Sdrh   Column *pCol;
355981f7b372Sdrh   assert( v!=0 );
3560aca19e19Sdrh   if( pTab==0 ){
3561aca19e19Sdrh     sqlite3VdbeAddOp3(v, OP_Column, iTabCur, iCol, regOut);
3562aca19e19Sdrh     return;
3563aca19e19Sdrh   }
35645c092e8aSdrh   if( iCol<0 || iCol==pTab->iPKey ){
35655c092e8aSdrh     sqlite3VdbeAddOp2(v, OP_Rowid, iTabCur, regOut);
35665c092e8aSdrh   }else{
356781f7b372Sdrh     int op;
356881f7b372Sdrh     int x;
356981f7b372Sdrh     if( IsVirtual(pTab) ){
357081f7b372Sdrh       op = OP_VColumn;
357181f7b372Sdrh       x = iCol;
357281f7b372Sdrh #ifndef SQLITE_OMIT_GENERATED_COLUMNS
3573ab45fc04Sdrh     }else if( (pCol = &pTab->aCol[iCol])->colFlags & COLFLAG_VIRTUAL ){
35746df9c4b9Sdrh       Parse *pParse = sqlite3VdbeParser(v);
3575ab45fc04Sdrh       if( pCol->colFlags & COLFLAG_BUSY ){
3576ab45fc04Sdrh         sqlite3ErrorMsg(pParse, "generated column loop on \"%s\"", pCol->zName);
3577ab45fc04Sdrh       }else{
357881f7b372Sdrh         int savedSelfTab = pParse->iSelfTab;
3579ab45fc04Sdrh         pCol->colFlags |= COLFLAG_BUSY;
358081f7b372Sdrh         pParse->iSelfTab = iTabCur+1;
3581e70fa7feSdrh         sqlite3ExprCodeGeneratedColumn(pParse, pCol, regOut);
358281f7b372Sdrh         pParse->iSelfTab = savedSelfTab;
3583ab45fc04Sdrh         pCol->colFlags &= ~COLFLAG_BUSY;
3584ab45fc04Sdrh       }
358581f7b372Sdrh       return;
358681f7b372Sdrh #endif
358781f7b372Sdrh     }else if( !HasRowid(pTab) ){
3588c5f808d8Sdrh       testcase( iCol!=sqlite3TableColumnToStorage(pTab, iCol) );
3589b9bcf7caSdrh       x = sqlite3TableColumnToIndex(sqlite3PrimaryKeyIndex(pTab), iCol);
359081f7b372Sdrh       op = OP_Column;
359181f7b372Sdrh     }else{
3592b9bcf7caSdrh       x = sqlite3TableColumnToStorage(pTab,iCol);
3593c5f808d8Sdrh       testcase( x!=iCol );
359481f7b372Sdrh       op = OP_Column;
3595ee0ec8e1Sdrh     }
3596ee0ec8e1Sdrh     sqlite3VdbeAddOp3(v, op, iTabCur, x, regOut);
35975c092e8aSdrh     sqlite3ColumnDefault(v, pTab, iCol, regOut);
35985c092e8aSdrh   }
35995c092e8aSdrh }
36005c092e8aSdrh 
36015c092e8aSdrh /*
3602945498f3Sdrh ** Generate code that will extract the iColumn-th column from
36038c607191Sdrh ** table pTab and store the column value in register iReg.
3604e55cbd72Sdrh **
3605e55cbd72Sdrh ** There must be an open cursor to pTab in iTable when this routine
3606e55cbd72Sdrh ** is called.  If iColumn<0 then code is generated that extracts the rowid.
3607945498f3Sdrh */
3608e55cbd72Sdrh int sqlite3ExprCodeGetColumn(
3609e55cbd72Sdrh   Parse *pParse,   /* Parsing and code generating context */
36102133d822Sdrh   Table *pTab,     /* Description of the table we are reading from */
36112133d822Sdrh   int iColumn,     /* Index of the table column */
36122133d822Sdrh   int iTable,      /* The cursor pointing to the table */
3613a748fdccSdrh   int iReg,        /* Store results here */
3614ce78bc6eSdrh   u8 p5            /* P5 value for OP_Column + FLAGS */
36152133d822Sdrh ){
361681f7b372Sdrh   assert( pParse->pVdbe!=0 );
36176df9c4b9Sdrh   sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pTab, iTable, iColumn, iReg);
3618a748fdccSdrh   if( p5 ){
361999670abbSdrh     VdbeOp *pOp = sqlite3VdbeGetOp(pParse->pVdbe,-1);
362099670abbSdrh     if( pOp->opcode==OP_Column ) pOp->p5 = p5;
3621a748fdccSdrh   }
3622e55cbd72Sdrh   return iReg;
3623e55cbd72Sdrh }
3624e55cbd72Sdrh 
3625e55cbd72Sdrh /*
3626b21e7c70Sdrh ** Generate code to move content from registers iFrom...iFrom+nReg-1
362736a5d88dSdrh ** over to iTo..iTo+nReg-1.
3628e55cbd72Sdrh */
3629b21e7c70Sdrh void sqlite3ExprCodeMove(Parse *pParse, int iFrom, int iTo, int nReg){
3630079a3072Sdrh   sqlite3VdbeAddOp3(pParse->pVdbe, OP_Move, iFrom, iTo, nReg);
3631945498f3Sdrh }
3632945498f3Sdrh 
3633652fbf55Sdrh /*
363412abf408Sdrh ** Convert a scalar expression node to a TK_REGISTER referencing
363512abf408Sdrh ** register iReg.  The caller must ensure that iReg already contains
363612abf408Sdrh ** the correct value for the expression.
3637a4c3c87eSdrh */
3638069d1b1fSdan static void exprToRegister(Expr *pExpr, int iReg){
36390d950af3Sdrh   Expr *p = sqlite3ExprSkipCollateAndLikely(pExpr);
3640235667a8Sdrh   if( NEVER(p==0) ) return;
3641a4c3c87eSdrh   p->op2 = p->op;
3642a4c3c87eSdrh   p->op = TK_REGISTER;
3643a4c3c87eSdrh   p->iTable = iReg;
3644a4c3c87eSdrh   ExprClearProperty(p, EP_Skip);
3645a4c3c87eSdrh }
3646a4c3c87eSdrh 
364712abf408Sdrh /*
364812abf408Sdrh ** Evaluate an expression (either a vector or a scalar expression) and store
364912abf408Sdrh ** the result in continguous temporary registers.  Return the index of
365012abf408Sdrh ** the first register used to store the result.
365112abf408Sdrh **
365212abf408Sdrh ** If the returned result register is a temporary scalar, then also write
365312abf408Sdrh ** that register number into *piFreeable.  If the returned result register
365412abf408Sdrh ** is not a temporary or if the expression is a vector set *piFreeable
365512abf408Sdrh ** to 0.
365612abf408Sdrh */
365712abf408Sdrh static int exprCodeVector(Parse *pParse, Expr *p, int *piFreeable){
365812abf408Sdrh   int iResult;
365912abf408Sdrh   int nResult = sqlite3ExprVectorSize(p);
366012abf408Sdrh   if( nResult==1 ){
366112abf408Sdrh     iResult = sqlite3ExprCodeTemp(pParse, p, piFreeable);
366212abf408Sdrh   }else{
366312abf408Sdrh     *piFreeable = 0;
366412abf408Sdrh     if( p->op==TK_SELECT ){
3665dd1bb43aSdrh #if SQLITE_OMIT_SUBQUERY
3666dd1bb43aSdrh       iResult = 0;
3667dd1bb43aSdrh #else
366885bcdce2Sdrh       iResult = sqlite3CodeSubselect(pParse, p);
3669dd1bb43aSdrh #endif
367012abf408Sdrh     }else{
367112abf408Sdrh       int i;
367212abf408Sdrh       iResult = pParse->nMem+1;
367312abf408Sdrh       pParse->nMem += nResult;
367412abf408Sdrh       for(i=0; i<nResult; i++){
36754b725240Sdan         sqlite3ExprCodeFactorable(pParse, p->x.pList->a[i].pExpr, i+iResult);
367612abf408Sdrh       }
367712abf408Sdrh     }
367812abf408Sdrh   }
367912abf408Sdrh   return iResult;
368012abf408Sdrh }
368112abf408Sdrh 
368225c4296bSdrh /*
368392a27f7bSdrh ** If the last opcode is a OP_Copy, then set the do-not-merge flag (p5)
368492a27f7bSdrh ** so that a subsequent copy will not be merged into this one.
368592a27f7bSdrh */
368692a27f7bSdrh static void setDoNotMergeFlagOnCopy(Vdbe *v){
368792a27f7bSdrh   if( sqlite3VdbeGetOp(v, -1)->opcode==OP_Copy ){
368892a27f7bSdrh     sqlite3VdbeChangeP5(v, 1);  /* Tag trailing OP_Copy as not mergable */
368992a27f7bSdrh   }
369092a27f7bSdrh }
369192a27f7bSdrh 
369292a27f7bSdrh /*
369325c4296bSdrh ** Generate code to implement special SQL functions that are implemented
369425c4296bSdrh ** in-line rather than by using the usual callbacks.
369525c4296bSdrh */
369625c4296bSdrh static int exprCodeInlineFunction(
369725c4296bSdrh   Parse *pParse,        /* Parsing context */
369825c4296bSdrh   ExprList *pFarg,      /* List of function arguments */
369925c4296bSdrh   int iFuncId,          /* Function ID.  One of the INTFUNC_... values */
370025c4296bSdrh   int target            /* Store function result in this register */
370125c4296bSdrh ){
370225c4296bSdrh   int nFarg;
370325c4296bSdrh   Vdbe *v = pParse->pVdbe;
370425c4296bSdrh   assert( v!=0 );
370525c4296bSdrh   assert( pFarg!=0 );
370625c4296bSdrh   nFarg = pFarg->nExpr;
370725c4296bSdrh   assert( nFarg>0 );  /* All in-line functions have at least one argument */
370825c4296bSdrh   switch( iFuncId ){
370925c4296bSdrh     case INLINEFUNC_coalesce: {
371025c4296bSdrh       /* Attempt a direct implementation of the built-in COALESCE() and
371125c4296bSdrh       ** IFNULL() functions.  This avoids unnecessary evaluation of
371225c4296bSdrh       ** arguments past the first non-NULL argument.
371325c4296bSdrh       */
371425c4296bSdrh       int endCoalesce = sqlite3VdbeMakeLabel(pParse);
371525c4296bSdrh       int i;
371625c4296bSdrh       assert( nFarg>=2 );
371725c4296bSdrh       sqlite3ExprCode(pParse, pFarg->a[0].pExpr, target);
371825c4296bSdrh       for(i=1; i<nFarg; i++){
371925c4296bSdrh         sqlite3VdbeAddOp2(v, OP_NotNull, target, endCoalesce);
372025c4296bSdrh         VdbeCoverage(v);
372125c4296bSdrh         sqlite3ExprCode(pParse, pFarg->a[i].pExpr, target);
372225c4296bSdrh       }
372392a27f7bSdrh       setDoNotMergeFlagOnCopy(v);
372425c4296bSdrh       sqlite3VdbeResolveLabel(v, endCoalesce);
372525c4296bSdrh       break;
372625c4296bSdrh     }
37273c0e606bSdrh     case INLINEFUNC_iif: {
37283c0e606bSdrh       Expr caseExpr;
37293c0e606bSdrh       memset(&caseExpr, 0, sizeof(caseExpr));
37303c0e606bSdrh       caseExpr.op = TK_CASE;
37313c0e606bSdrh       caseExpr.x.pList = pFarg;
37323c0e606bSdrh       return sqlite3ExprCodeTarget(pParse, &caseExpr, target);
37333c0e606bSdrh     }
373425c4296bSdrh 
3735171c50ecSdrh     default: {
373625c4296bSdrh       /* The UNLIKELY() function is a no-op.  The result is the value
373725c4296bSdrh       ** of the first argument.
373825c4296bSdrh       */
3739171c50ecSdrh       assert( nFarg==1 || nFarg==2 );
374025c4296bSdrh       target = sqlite3ExprCodeTarget(pParse, pFarg->a[0].pExpr, target);
374125c4296bSdrh       break;
374225c4296bSdrh     }
374325c4296bSdrh 
3744171c50ecSdrh   /***********************************************************************
3745171c50ecSdrh   ** Test-only SQL functions that are only usable if enabled
3746171c50ecSdrh   ** via SQLITE_TESTCTRL_INTERNAL_FUNCTIONS
3747171c50ecSdrh   */
3748171c50ecSdrh     case INLINEFUNC_expr_compare: {
3749171c50ecSdrh       /* Compare two expressions using sqlite3ExprCompare() */
3750171c50ecSdrh       assert( nFarg==2 );
3751171c50ecSdrh       sqlite3VdbeAddOp2(v, OP_Integer,
3752171c50ecSdrh          sqlite3ExprCompare(0,pFarg->a[0].pExpr, pFarg->a[1].pExpr,-1),
3753171c50ecSdrh          target);
3754171c50ecSdrh       break;
3755171c50ecSdrh     }
3756171c50ecSdrh 
3757171c50ecSdrh     case INLINEFUNC_expr_implies_expr: {
3758171c50ecSdrh       /* Compare two expressions using sqlite3ExprImpliesExpr() */
3759171c50ecSdrh       assert( nFarg==2 );
3760171c50ecSdrh       sqlite3VdbeAddOp2(v, OP_Integer,
3761171c50ecSdrh          sqlite3ExprImpliesExpr(pParse,pFarg->a[0].pExpr, pFarg->a[1].pExpr,-1),
3762171c50ecSdrh          target);
3763171c50ecSdrh       break;
3764171c50ecSdrh     }
3765171c50ecSdrh 
3766171c50ecSdrh     case INLINEFUNC_implies_nonnull_row: {
3767171c50ecSdrh       /* REsult of sqlite3ExprImpliesNonNullRow() */
3768171c50ecSdrh       Expr *pA1;
3769171c50ecSdrh       assert( nFarg==2 );
3770171c50ecSdrh       pA1 = pFarg->a[1].pExpr;
3771171c50ecSdrh       if( pA1->op==TK_COLUMN ){
3772171c50ecSdrh         sqlite3VdbeAddOp2(v, OP_Integer,
3773171c50ecSdrh            sqlite3ExprImpliesNonNullRow(pFarg->a[0].pExpr,pA1->iTable),
3774171c50ecSdrh            target);
3775171c50ecSdrh       }else{
3776171c50ecSdrh         sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3777171c50ecSdrh       }
3778171c50ecSdrh       break;
3779171c50ecSdrh     }
3780171c50ecSdrh 
378125c4296bSdrh #ifdef SQLITE_DEBUG
378225c4296bSdrh     case INLINEFUNC_affinity: {
378325c4296bSdrh       /* The AFFINITY() function evaluates to a string that describes
378425c4296bSdrh       ** the type affinity of the argument.  This is used for testing of
378525c4296bSdrh       ** the SQLite type logic.
378625c4296bSdrh       */
378725c4296bSdrh       const char *azAff[] = { "blob", "text", "numeric", "integer", "real" };
378825c4296bSdrh       char aff;
378925c4296bSdrh       assert( nFarg==1 );
379025c4296bSdrh       aff = sqlite3ExprAffinity(pFarg->a[0].pExpr);
379125c4296bSdrh       sqlite3VdbeLoadString(v, target,
379225c4296bSdrh               (aff<=SQLITE_AFF_NONE) ? "none" : azAff[aff-SQLITE_AFF_BLOB]);
379325c4296bSdrh       break;
379425c4296bSdrh     }
379525c4296bSdrh #endif
379625c4296bSdrh   }
379725c4296bSdrh   return target;
379825c4296bSdrh }
379925c4296bSdrh 
380071c57db0Sdan 
3801a4c3c87eSdrh /*
3802cce7d176Sdrh ** Generate code into the current Vdbe to evaluate the given
38032dcef11bSdrh ** expression.  Attempt to store the results in register "target".
38042dcef11bSdrh ** Return the register where results are stored.
3805389a1adbSdrh **
38068b213899Sdrh ** With this routine, there is no guarantee that results will
38072dcef11bSdrh ** be stored in target.  The result might be stored in some other
38082dcef11bSdrh ** register if it is convenient to do so.  The calling function
38092dcef11bSdrh ** must check the return code and move the results to the desired
38102dcef11bSdrh ** register.
3811cce7d176Sdrh */
3812678ccce8Sdrh int sqlite3ExprCodeTarget(Parse *pParse, Expr *pExpr, int target){
38132dcef11bSdrh   Vdbe *v = pParse->pVdbe;  /* The VM under construction */
38142dcef11bSdrh   int op;                   /* The opcode being coded */
38152dcef11bSdrh   int inReg = target;       /* Results stored in register inReg */
38162dcef11bSdrh   int regFree1 = 0;         /* If non-zero free this temporary register */
38172dcef11bSdrh   int regFree2 = 0;         /* If non-zero free this temporary register */
38187b35a77bSdan   int r1, r2;               /* Various register numbers */
381910d1edf0Sdrh   Expr tempX;               /* Temporary expression node */
382071c57db0Sdan   int p5 = 0;
3821ffe07b2dSdrh 
38229cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
3823b639a209Sdrh   assert( v!=0 );
3824389a1adbSdrh 
38251efa8023Sdrh expr_code_doover:
3826389a1adbSdrh   if( pExpr==0 ){
3827389a1adbSdrh     op = TK_NULL;
3828389a1adbSdrh   }else{
3829e7375bfaSdrh     assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
3830f2bc013cSdrh     op = pExpr->op;
3831389a1adbSdrh   }
3832f2bc013cSdrh   switch( op ){
383313449892Sdrh     case TK_AGG_COLUMN: {
383413449892Sdrh       AggInfo *pAggInfo = pExpr->pAggInfo;
38350934d640Sdrh       struct AggInfo_col *pCol;
38360934d640Sdrh       assert( pAggInfo!=0 );
38370934d640Sdrh       assert( pExpr->iAgg>=0 && pExpr->iAgg<pAggInfo->nColumn );
38380934d640Sdrh       pCol = &pAggInfo->aCol[pExpr->iAgg];
383913449892Sdrh       if( !pAggInfo->directMode ){
38409de221dfSdrh         assert( pCol->iMem>0 );
3841c332cc30Sdrh         return pCol->iMem;
384213449892Sdrh       }else if( pAggInfo->useSortingIdx ){
38430c76e892Sdrh         Table *pTab = pCol->pTab;
38445134d135Sdan         sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdxPTab,
3845389a1adbSdrh                               pCol->iSorterColumn, target);
38468d5cea6bSdrh         if( pCol->iColumn<0 ){
38478d5cea6bSdrh           VdbeComment((v,"%s.rowid",pTab->zName));
38488d5cea6bSdrh         }else{
38498d5cea6bSdrh           VdbeComment((v,"%s.%s",pTab->zName,pTab->aCol[pCol->iColumn].zName));
38508d5cea6bSdrh           if( pTab->aCol[pCol->iColumn].affinity==SQLITE_AFF_REAL ){
38518d5cea6bSdrh             sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
38528d5cea6bSdrh           }
38530c76e892Sdrh         }
3854c332cc30Sdrh         return target;
385513449892Sdrh       }
385613449892Sdrh       /* Otherwise, fall thru into the TK_COLUMN case */
385708b92086Sdrh       /* no break */ deliberate_fall_through
385813449892Sdrh     }
3859967e8b73Sdrh     case TK_COLUMN: {
3860b2b9d3d7Sdrh       int iTab = pExpr->iTable;
386167b9ba17Sdrh       int iReg;
3862efad2e23Sdrh       if( ExprHasProperty(pExpr, EP_FixedCol) ){
3863d98f5324Sdrh         /* This COLUMN expression is really a constant due to WHERE clause
3864d98f5324Sdrh         ** constraints, and that constant is coded by the pExpr->pLeft
3865d98f5324Sdrh         ** expresssion.  However, make sure the constant has the correct
3866d98f5324Sdrh         ** datatype by applying the Affinity of the table column to the
3867d98f5324Sdrh         ** constant.
3868d98f5324Sdrh         */
386957f7ece7Sdrh         int aff;
387067b9ba17Sdrh         iReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft,target);
387157f7ece7Sdrh         if( pExpr->y.pTab ){
387257f7ece7Sdrh           aff = sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
387357f7ece7Sdrh         }else{
387457f7ece7Sdrh           aff = pExpr->affExpr;
387557f7ece7Sdrh         }
387696fb16eeSdrh         if( aff>SQLITE_AFF_BLOB ){
3877d98f5324Sdrh           static const char zAff[] = "B\000C\000D\000E";
3878d98f5324Sdrh           assert( SQLITE_AFF_BLOB=='A' );
3879d98f5324Sdrh           assert( SQLITE_AFF_TEXT=='B' );
3880d98f5324Sdrh           sqlite3VdbeAddOp4(v, OP_Affinity, iReg, 1, 0,
3881d98f5324Sdrh                             &zAff[(aff-'B')*2], P4_STATIC);
3882d98f5324Sdrh         }
3883d98f5324Sdrh         return iReg;
3884efad2e23Sdrh       }
3885b2b9d3d7Sdrh       if( iTab<0 ){
38866e97f8ecSdrh         if( pParse->iSelfTab<0 ){
38879942ef0dSdrh           /* Other columns in the same row for CHECK constraints or
38889942ef0dSdrh           ** generated columns or for inserting into partial index.
38899942ef0dSdrh           ** The row is unpacked into registers beginning at
38909942ef0dSdrh           ** 0-(pParse->iSelfTab).  The rowid (if any) is in a register
38919942ef0dSdrh           ** immediately prior to the first column.
38929942ef0dSdrh           */
38939942ef0dSdrh           Column *pCol;
38949942ef0dSdrh           Table *pTab = pExpr->y.pTab;
38959942ef0dSdrh           int iSrc;
3896c5f808d8Sdrh           int iCol = pExpr->iColumn;
38979942ef0dSdrh           assert( pTab!=0 );
3898c5f808d8Sdrh           assert( iCol>=XN_ROWID );
3899b0cbcd0eSdrh           assert( iCol<pTab->nCol );
3900c5f808d8Sdrh           if( iCol<0 ){
39019942ef0dSdrh             return -1-pParse->iSelfTab;
39029942ef0dSdrh           }
3903c5f808d8Sdrh           pCol = pTab->aCol + iCol;
3904c5f808d8Sdrh           testcase( iCol!=sqlite3TableColumnToStorage(pTab,iCol) );
3905c5f808d8Sdrh           iSrc = sqlite3TableColumnToStorage(pTab, iCol) - pParse->iSelfTab;
39069942ef0dSdrh #ifndef SQLITE_OMIT_GENERATED_COLUMNS
39079942ef0dSdrh           if( pCol->colFlags & COLFLAG_GENERATED ){
39084e8e533bSdrh             if( pCol->colFlags & COLFLAG_BUSY ){
39094e8e533bSdrh               sqlite3ErrorMsg(pParse, "generated column loop on \"%s\"",
39104e8e533bSdrh                               pCol->zName);
39114e8e533bSdrh               return 0;
39124e8e533bSdrh             }
39134e8e533bSdrh             pCol->colFlags |= COLFLAG_BUSY;
39144e8e533bSdrh             if( pCol->colFlags & COLFLAG_NOTAVAIL ){
3915e70fa7feSdrh               sqlite3ExprCodeGeneratedColumn(pParse, pCol, iSrc);
39164e8e533bSdrh             }
39174e8e533bSdrh             pCol->colFlags &= ~(COLFLAG_BUSY|COLFLAG_NOTAVAIL);
3918dd6cc9b5Sdrh             return iSrc;
39199942ef0dSdrh           }else
39209942ef0dSdrh #endif /* SQLITE_OMIT_GENERATED_COLUMNS */
39219942ef0dSdrh           if( pCol->affinity==SQLITE_AFF_REAL ){
39229942ef0dSdrh             sqlite3VdbeAddOp2(v, OP_SCopy, iSrc, target);
3923bffdd636Sdrh             sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
3924bffdd636Sdrh             return target;
3925bffdd636Sdrh           }else{
39269942ef0dSdrh             return iSrc;
3927bffdd636Sdrh           }
3928c4a3c779Sdrh         }else{
39291f9ca2c8Sdrh           /* Coding an expression that is part of an index where column names
39301f9ca2c8Sdrh           ** in the index refer to the table to which the index belongs */
39313e34eabcSdrh           iTab = pParse->iSelfTab - 1;
39322282792aSdrh         }
3933b2b9d3d7Sdrh       }
393467b9ba17Sdrh       iReg = sqlite3ExprCodeGetColumn(pParse, pExpr->y.pTab,
3935b2b9d3d7Sdrh                                pExpr->iColumn, iTab, target,
3936b2b9d3d7Sdrh                                pExpr->op2);
393767b9ba17Sdrh       if( pExpr->y.pTab==0 && pExpr->affExpr==SQLITE_AFF_REAL ){
393867b9ba17Sdrh         sqlite3VdbeAddOp1(v, OP_RealAffinity, iReg);
393967b9ba17Sdrh       }
394067b9ba17Sdrh       return iReg;
3941cce7d176Sdrh     }
3942cce7d176Sdrh     case TK_INTEGER: {
394313573c71Sdrh       codeInteger(pParse, pExpr, 0, target);
3944c332cc30Sdrh       return target;
394551e9a445Sdrh     }
39468abed7b9Sdrh     case TK_TRUEFALSE: {
394796acafbeSdrh       sqlite3VdbeAddOp2(v, OP_Integer, sqlite3ExprTruthValue(pExpr), target);
3948007c843bSdrh       return target;
3949007c843bSdrh     }
395013573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
3951598f1340Sdrh     case TK_FLOAT: {
395233e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
395333e619fcSdrh       codeReal(v, pExpr->u.zToken, 0, target);
3954c332cc30Sdrh       return target;
3955598f1340Sdrh     }
395613573c71Sdrh #endif
3957fec19aadSdrh     case TK_STRING: {
395833e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
3959076e85f5Sdrh       sqlite3VdbeLoadString(v, target, pExpr->u.zToken);
3960c332cc30Sdrh       return target;
3961cce7d176Sdrh     }
3962aac30f9bSdrh     default: {
3963c29af653Sdrh       /* Make NULL the default case so that if a bug causes an illegal
3964c29af653Sdrh       ** Expr node to be passed into this function, it will be handled
39659524a7eaSdrh       ** sanely and not crash.  But keep the assert() to bring the problem
39669524a7eaSdrh       ** to the attention of the developers. */
39679524a7eaSdrh       assert( op==TK_NULL );
39689de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3969c332cc30Sdrh       return target;
3970f0863fe5Sdrh     }
39715338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_BLOB_LITERAL
3972c572ef7fSdanielk1977     case TK_BLOB: {
39736c8c6cecSdrh       int n;
39746c8c6cecSdrh       const char *z;
3975ca48c90fSdrh       char *zBlob;
397633e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
397733e619fcSdrh       assert( pExpr->u.zToken[0]=='x' || pExpr->u.zToken[0]=='X' );
397833e619fcSdrh       assert( pExpr->u.zToken[1]=='\'' );
397933e619fcSdrh       z = &pExpr->u.zToken[2];
3980b7916a78Sdrh       n = sqlite3Strlen30(z) - 1;
3981b7916a78Sdrh       assert( z[n]=='\'' );
3982ca48c90fSdrh       zBlob = sqlite3HexToBlob(sqlite3VdbeDb(v), z, n);
3983ca48c90fSdrh       sqlite3VdbeAddOp4(v, OP_Blob, n/2, target, 0, zBlob, P4_DYNAMIC);
3984c332cc30Sdrh       return target;
3985c572ef7fSdanielk1977     }
39865338a5f7Sdanielk1977 #endif
398750457896Sdrh     case TK_VARIABLE: {
398833e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
398933e619fcSdrh       assert( pExpr->u.zToken!=0 );
399033e619fcSdrh       assert( pExpr->u.zToken[0]!=0 );
3991eaf52d88Sdrh       sqlite3VdbeAddOp2(v, OP_Variable, pExpr->iColumn, target);
399233e619fcSdrh       if( pExpr->u.zToken[1]!=0 ){
39939bf755ccSdrh         const char *z = sqlite3VListNumToName(pParse->pVList, pExpr->iColumn);
39949524a7eaSdrh         assert( pExpr->u.zToken[0]=='?' || (z && !strcmp(pExpr->u.zToken, z)) );
3995ce1bbe51Sdrh         pParse->pVList[0] = 0; /* Indicate VList may no longer be enlarged */
39969bf755ccSdrh         sqlite3VdbeAppendP4(v, (char*)z, P4_STATIC);
39979bf755ccSdrh       }
3998c332cc30Sdrh       return target;
399950457896Sdrh     }
40004e0cff60Sdrh     case TK_REGISTER: {
4001c332cc30Sdrh       return pExpr->iTable;
40024e0cff60Sdrh     }
4003487e262fSdrh #ifndef SQLITE_OMIT_CAST
4004487e262fSdrh     case TK_CAST: {
4005487e262fSdrh       /* Expressions of the form:   CAST(pLeft AS token) */
40062dcef11bSdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
40071735fa88Sdrh       if( inReg!=target ){
40081735fa88Sdrh         sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
40091735fa88Sdrh         inReg = target;
40101735fa88Sdrh       }
40114169e430Sdrh       sqlite3VdbeAddOp2(v, OP_Cast, target,
40124169e430Sdrh                         sqlite3AffinityType(pExpr->u.zToken, 0));
4013c332cc30Sdrh       return inReg;
4014487e262fSdrh     }
4015487e262fSdrh #endif /* SQLITE_OMIT_CAST */
401671c57db0Sdan     case TK_IS:
401771c57db0Sdan     case TK_ISNOT:
401871c57db0Sdan       op = (op==TK_IS) ? TK_EQ : TK_NE;
401971c57db0Sdan       p5 = SQLITE_NULLEQ;
402071c57db0Sdan       /* fall-through */
4021c9b84a1fSdrh     case TK_LT:
4022c9b84a1fSdrh     case TK_LE:
4023c9b84a1fSdrh     case TK_GT:
4024c9b84a1fSdrh     case TK_GE:
4025c9b84a1fSdrh     case TK_NE:
4026c9b84a1fSdrh     case TK_EQ: {
402771c57db0Sdan       Expr *pLeft = pExpr->pLeft;
4028625015e0Sdan       if( sqlite3ExprIsVector(pLeft) ){
402979752b6eSdrh         codeVectorCompare(pParse, pExpr, target, op, p5);
403071c57db0Sdan       }else{
403171c57db0Sdan         r1 = sqlite3ExprCodeTemp(pParse, pLeft, &regFree1);
4032b6da74ebSdrh         r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
403371c57db0Sdan         codeCompare(pParse, pLeft, pExpr->pRight, op,
4034898c527eSdrh             r1, r2, inReg, SQLITE_STOREP2 | p5,
4035898c527eSdrh             ExprHasProperty(pExpr,EP_Commuted));
40367d176105Sdrh         assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
40377d176105Sdrh         assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
40387d176105Sdrh         assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
40397d176105Sdrh         assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
40407d176105Sdrh         assert(TK_EQ==OP_Eq); testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
40417d176105Sdrh         assert(TK_NE==OP_Ne); testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
4042c5499befSdrh         testcase( regFree1==0 );
4043c5499befSdrh         testcase( regFree2==0 );
4044c9b84a1fSdrh       }
40456a2fe093Sdrh       break;
40466a2fe093Sdrh     }
4047cce7d176Sdrh     case TK_AND:
4048cce7d176Sdrh     case TK_OR:
4049cce7d176Sdrh     case TK_PLUS:
4050cce7d176Sdrh     case TK_STAR:
4051cce7d176Sdrh     case TK_MINUS:
4052bf4133cbSdrh     case TK_REM:
4053bf4133cbSdrh     case TK_BITAND:
4054bf4133cbSdrh     case TK_BITOR:
405517c40294Sdrh     case TK_SLASH:
4056bf4133cbSdrh     case TK_LSHIFT:
4057855eb1cfSdrh     case TK_RSHIFT:
40580040077dSdrh     case TK_CONCAT: {
40597d176105Sdrh       assert( TK_AND==OP_And );            testcase( op==TK_AND );
40607d176105Sdrh       assert( TK_OR==OP_Or );              testcase( op==TK_OR );
40617d176105Sdrh       assert( TK_PLUS==OP_Add );           testcase( op==TK_PLUS );
40627d176105Sdrh       assert( TK_MINUS==OP_Subtract );     testcase( op==TK_MINUS );
40637d176105Sdrh       assert( TK_REM==OP_Remainder );      testcase( op==TK_REM );
40647d176105Sdrh       assert( TK_BITAND==OP_BitAnd );      testcase( op==TK_BITAND );
40657d176105Sdrh       assert( TK_BITOR==OP_BitOr );        testcase( op==TK_BITOR );
40667d176105Sdrh       assert( TK_SLASH==OP_Divide );       testcase( op==TK_SLASH );
40677d176105Sdrh       assert( TK_LSHIFT==OP_ShiftLeft );   testcase( op==TK_LSHIFT );
40687d176105Sdrh       assert( TK_RSHIFT==OP_ShiftRight );  testcase( op==TK_RSHIFT );
40697d176105Sdrh       assert( TK_CONCAT==OP_Concat );      testcase( op==TK_CONCAT );
40702dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
40712dcef11bSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
40725b6afba9Sdrh       sqlite3VdbeAddOp3(v, op, r2, r1, target);
4073c5499befSdrh       testcase( regFree1==0 );
4074c5499befSdrh       testcase( regFree2==0 );
40750040077dSdrh       break;
40760040077dSdrh     }
4077cce7d176Sdrh     case TK_UMINUS: {
4078fec19aadSdrh       Expr *pLeft = pExpr->pLeft;
4079fec19aadSdrh       assert( pLeft );
408013573c71Sdrh       if( pLeft->op==TK_INTEGER ){
408113573c71Sdrh         codeInteger(pParse, pLeft, 1, target);
4082c332cc30Sdrh         return target;
408313573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
408413573c71Sdrh       }else if( pLeft->op==TK_FLOAT ){
408533e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
408633e619fcSdrh         codeReal(v, pLeft->u.zToken, 1, target);
4087c332cc30Sdrh         return target;
408813573c71Sdrh #endif
40893c84ddffSdrh       }else{
409010d1edf0Sdrh         tempX.op = TK_INTEGER;
409110d1edf0Sdrh         tempX.flags = EP_IntValue|EP_TokenOnly;
409210d1edf0Sdrh         tempX.u.iValue = 0;
4093e7375bfaSdrh         ExprClearVVAProperties(&tempX);
409410d1edf0Sdrh         r1 = sqlite3ExprCodeTemp(pParse, &tempX, &regFree1);
4095e55cbd72Sdrh         r2 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree2);
40962dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_Subtract, r2, r1, target);
4097c5499befSdrh         testcase( regFree2==0 );
40983c84ddffSdrh       }
40996e142f54Sdrh       break;
41006e142f54Sdrh     }
4101bf4133cbSdrh     case TK_BITNOT:
41026e142f54Sdrh     case TK_NOT: {
41037d176105Sdrh       assert( TK_BITNOT==OP_BitNot );   testcase( op==TK_BITNOT );
41047d176105Sdrh       assert( TK_NOT==OP_Not );         testcase( op==TK_NOT );
4105e99fa2afSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4106e99fa2afSdrh       testcase( regFree1==0 );
4107e99fa2afSdrh       sqlite3VdbeAddOp2(v, op, r1, inReg);
4108cce7d176Sdrh       break;
4109cce7d176Sdrh     }
41108abed7b9Sdrh     case TK_TRUTH: {
411196acafbeSdrh       int isTrue;    /* IS TRUE or IS NOT TRUE */
411296acafbeSdrh       int bNormal;   /* IS TRUE or IS FALSE */
4113007c843bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4114007c843bSdrh       testcase( regFree1==0 );
411596acafbeSdrh       isTrue = sqlite3ExprTruthValue(pExpr->pRight);
411696acafbeSdrh       bNormal = pExpr->op2==TK_IS;
411796acafbeSdrh       testcase( isTrue && bNormal);
411896acafbeSdrh       testcase( !isTrue && bNormal);
411996acafbeSdrh       sqlite3VdbeAddOp4Int(v, OP_IsTrue, r1, inReg, !isTrue, isTrue ^ bNormal);
4120007c843bSdrh       break;
4121007c843bSdrh     }
4122cce7d176Sdrh     case TK_ISNULL:
4123cce7d176Sdrh     case TK_NOTNULL: {
41246a288a33Sdrh       int addr;
41257d176105Sdrh       assert( TK_ISNULL==OP_IsNull );   testcase( op==TK_ISNULL );
41267d176105Sdrh       assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
41279de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
41282dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4129c5499befSdrh       testcase( regFree1==0 );
41302dcef11bSdrh       addr = sqlite3VdbeAddOp1(v, op, r1);
41317d176105Sdrh       VdbeCoverageIf(v, op==TK_ISNULL);
41327d176105Sdrh       VdbeCoverageIf(v, op==TK_NOTNULL);
4133a976979bSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 0, target);
41346a288a33Sdrh       sqlite3VdbeJumpHere(v, addr);
4135a37cdde0Sdanielk1977       break;
4136f2bc013cSdrh     }
41372282792aSdrh     case TK_AGG_FUNCTION: {
413813449892Sdrh       AggInfo *pInfo = pExpr->pAggInfo;
41390934d640Sdrh       if( pInfo==0
41400934d640Sdrh        || NEVER(pExpr->iAgg<0)
41410934d640Sdrh        || NEVER(pExpr->iAgg>=pInfo->nFunc)
41420934d640Sdrh       ){
414333e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
414433e619fcSdrh         sqlite3ErrorMsg(pParse, "misuse of aggregate: %s()", pExpr->u.zToken);
41457e56e711Sdrh       }else{
4146c332cc30Sdrh         return pInfo->aFunc[pExpr->iAgg].iMem;
41477e56e711Sdrh       }
41482282792aSdrh       break;
41492282792aSdrh     }
4150cce7d176Sdrh     case TK_FUNCTION: {
415112ffee8cSdrh       ExprList *pFarg;       /* List of function arguments */
415212ffee8cSdrh       int nFarg;             /* Number of function arguments */
415312ffee8cSdrh       FuncDef *pDef;         /* The function definition object */
415412ffee8cSdrh       const char *zId;       /* The function name */
4155693e6719Sdrh       u32 constMask = 0;     /* Mask of function arguments that are constant */
415612ffee8cSdrh       int i;                 /* Loop counter */
4157c332cc30Sdrh       sqlite3 *db = pParse->db;  /* The database connection */
415812ffee8cSdrh       u8 enc = ENC(db);      /* The text encoding used by this database */
415912ffee8cSdrh       CollSeq *pColl = 0;    /* A collating sequence */
416017435752Sdrh 
416167a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
4162eda079cdSdrh       if( ExprHasProperty(pExpr, EP_WinFunc) ){
4163eda079cdSdrh         return pExpr->y.pWin->regResult;
416486fb6e17Sdan       }
416567a9b8edSdan #endif
416686fb6e17Sdan 
41671e9b53f9Sdrh       if( ConstFactorOk(pParse) && sqlite3ExprIsConstantNotJoin(pExpr) ){
41689b258c54Sdrh         /* SQL functions can be expensive. So try to avoid running them
41699b258c54Sdrh         ** multiple times if we know they always give the same result */
41709b258c54Sdrh         return sqlite3ExprCodeRunJustOnce(pParse, pExpr, -1);
41711e9b53f9Sdrh       }
41726ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
4173e7375bfaSdrh       assert( !ExprHasProperty(pExpr, EP_TokenOnly) );
417412ffee8cSdrh       pFarg = pExpr->x.pList;
417512ffee8cSdrh       nFarg = pFarg ? pFarg->nExpr : 0;
417633e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
417733e619fcSdrh       zId = pExpr->u.zToken;
417880738d9cSdrh       pDef = sqlite3FindFunction(db, zId, nFarg, enc, 0);
4179cc15313cSdrh #ifdef SQLITE_ENABLE_UNKNOWN_SQL_FUNCTION
4180cc15313cSdrh       if( pDef==0 && pParse->explain ){
4181cc15313cSdrh         pDef = sqlite3FindFunction(db, "unknown", nFarg, enc, 0);
4182cc15313cSdrh       }
4183cc15313cSdrh #endif
4184b6e9f7a4Sdan       if( pDef==0 || pDef->xFinalize!=0 ){
418580738d9cSdrh         sqlite3ErrorMsg(pParse, "unknown function: %s()", zId);
4186feb306f5Sdrh         break;
4187feb306f5Sdrh       }
418825c4296bSdrh       if( pDef->funcFlags & SQLITE_FUNC_INLINE ){
41890dfa5255Sdrh         assert( (pDef->funcFlags & SQLITE_FUNC_UNSAFE)==0 );
41900dfa5255Sdrh         assert( (pDef->funcFlags & SQLITE_FUNC_DIRECT)==0 );
419125c4296bSdrh         return exprCodeInlineFunction(pParse, pFarg,
419225c4296bSdrh              SQLITE_PTR_TO_INT(pDef->pUserData), target);
41932eeca204Sdrh       }else if( pDef->funcFlags & (SQLITE_FUNC_DIRECT|SQLITE_FUNC_UNSAFE) ){
41940dfa5255Sdrh         sqlite3ExprFunctionUsable(pParse, pExpr, pDef);
4195ae6bb957Sdrh       }
4196a1a523a5Sdrh 
4197d1a01edaSdrh       for(i=0; i<nFarg; i++){
4198d1a01edaSdrh         if( i<32 && sqlite3ExprIsConstant(pFarg->a[i].pExpr) ){
4199693e6719Sdrh           testcase( i==31 );
4200693e6719Sdrh           constMask |= MASKBIT32(i);
4201d1a01edaSdrh         }
4202d1a01edaSdrh         if( (pDef->funcFlags & SQLITE_FUNC_NEEDCOLL)!=0 && !pColl ){
4203d1a01edaSdrh           pColl = sqlite3ExprCollSeq(pParse, pFarg->a[i].pExpr);
4204d1a01edaSdrh         }
4205d1a01edaSdrh       }
420612ffee8cSdrh       if( pFarg ){
4207d1a01edaSdrh         if( constMask ){
4208d1a01edaSdrh           r1 = pParse->nMem+1;
4209d1a01edaSdrh           pParse->nMem += nFarg;
4210d1a01edaSdrh         }else{
421112ffee8cSdrh           r1 = sqlite3GetTempRange(pParse, nFarg);
4212d1a01edaSdrh         }
4213a748fdccSdrh 
4214a748fdccSdrh         /* For length() and typeof() functions with a column argument,
4215a748fdccSdrh         ** set the P5 parameter to the OP_Column opcode to OPFLAG_LENGTHARG
4216a748fdccSdrh         ** or OPFLAG_TYPEOFARG respectively, to avoid unnecessary data
4217a748fdccSdrh         ** loading.
4218a748fdccSdrh         */
4219d36e1041Sdrh         if( (pDef->funcFlags & (SQLITE_FUNC_LENGTH|SQLITE_FUNC_TYPEOF))!=0 ){
42204e245a4cSdrh           u8 exprOp;
4221a748fdccSdrh           assert( nFarg==1 );
4222a748fdccSdrh           assert( pFarg->a[0].pExpr!=0 );
42234e245a4cSdrh           exprOp = pFarg->a[0].pExpr->op;
42244e245a4cSdrh           if( exprOp==TK_COLUMN || exprOp==TK_AGG_COLUMN ){
4225a748fdccSdrh             assert( SQLITE_FUNC_LENGTH==OPFLAG_LENGTHARG );
4226a748fdccSdrh             assert( SQLITE_FUNC_TYPEOF==OPFLAG_TYPEOFARG );
4227b1fba286Sdrh             testcase( pDef->funcFlags & OPFLAG_LENGTHARG );
4228b1fba286Sdrh             pFarg->a[0].pExpr->op2 =
4229b1fba286Sdrh                   pDef->funcFlags & (OPFLAG_LENGTHARG|OPFLAG_TYPEOFARG);
4230a748fdccSdrh           }
4231a748fdccSdrh         }
4232a748fdccSdrh 
42335579d59fSdrh         sqlite3ExprCodeExprList(pParse, pFarg, r1, 0,
4234d1a01edaSdrh                                 SQLITE_ECEL_DUP|SQLITE_ECEL_FACTOR);
4235892d3179Sdrh       }else{
423612ffee8cSdrh         r1 = 0;
4237892d3179Sdrh       }
4238b7f6f68fSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
4239a43fa227Sdrh       /* Possibly overload the function if the first argument is
4240a43fa227Sdrh       ** a virtual table column.
4241a43fa227Sdrh       **
4242a43fa227Sdrh       ** For infix functions (LIKE, GLOB, REGEXP, and MATCH) use the
4243a43fa227Sdrh       ** second argument, not the first, as the argument to test to
4244a43fa227Sdrh       ** see if it is a column in a virtual table.  This is done because
4245a43fa227Sdrh       ** the left operand of infix functions (the operand we want to
4246a43fa227Sdrh       ** control overloading) ends up as the second argument to the
4247a43fa227Sdrh       ** function.  The expression "A glob B" is equivalent to
4248a43fa227Sdrh       ** "glob(B,A).  We want to use the A in "A glob B" to test
4249a43fa227Sdrh       ** for function overloading.  But we use the B term in "glob(B,A)".
4250a43fa227Sdrh       */
425159155065Sdrh       if( nFarg>=2 && ExprHasProperty(pExpr, EP_InfixFunc) ){
425212ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[1].pExpr);
425312ffee8cSdrh       }else if( nFarg>0 ){
425412ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[0].pExpr);
4255b7f6f68fSdrh       }
4256b7f6f68fSdrh #endif
4257d36e1041Sdrh       if( pDef->funcFlags & SQLITE_FUNC_NEEDCOLL ){
42588b213899Sdrh         if( !pColl ) pColl = db->pDfltColl;
425966a5167bSdrh         sqlite3VdbeAddOp4(v, OP_CollSeq, 0, 0, 0, (char *)pColl, P4_COLLSEQ);
4260682f68b0Sdanielk1977       }
4261092457b1Sdrh #ifdef SQLITE_ENABLE_OFFSET_SQL_FUNC
4262092457b1Sdrh       if( pDef->funcFlags & SQLITE_FUNC_OFFSET ){
42632fc865c1Sdrh         Expr *pArg = pFarg->a[0].pExpr;
42642fc865c1Sdrh         if( pArg->op==TK_COLUMN ){
4265092457b1Sdrh           sqlite3VdbeAddOp3(v, OP_Offset, pArg->iTable, pArg->iColumn, target);
42662fc865c1Sdrh         }else{
42672fc865c1Sdrh           sqlite3VdbeAddOp2(v, OP_Null, 0, target);
42682fc865c1Sdrh         }
4269092457b1Sdrh       }else
4270092457b1Sdrh #endif
4271092457b1Sdrh       {
4272920cf596Sdrh         sqlite3VdbeAddFunctionCall(pParse, constMask, r1, target, nFarg,
427320cee7d0Sdrh                                    pDef, pExpr->op2);
42742fc865c1Sdrh       }
427513d79502Sdrh       if( nFarg ){
427613d79502Sdrh         if( constMask==0 ){
427712ffee8cSdrh           sqlite3ReleaseTempRange(pParse, r1, nFarg);
427813d79502Sdrh         }else{
42793aef2fb1Sdrh           sqlite3VdbeReleaseRegisters(pParse, r1, nFarg, constMask, 1);
428013d79502Sdrh         }
42812dcef11bSdrh       }
4282c332cc30Sdrh       return target;
42836ec2733bSdrh     }
4284fe2093d7Sdrh #ifndef SQLITE_OMIT_SUBQUERY
4285fe2093d7Sdrh     case TK_EXISTS:
428619a775c2Sdrh     case TK_SELECT: {
42878da209b1Sdan       int nCol;
4288c5499befSdrh       testcase( op==TK_EXISTS );
4289c5499befSdrh       testcase( op==TK_SELECT );
4290d8d335d7Sdrh       if( pParse->db->mallocFailed ){
4291d8d335d7Sdrh         return 0;
4292d8d335d7Sdrh       }else if( op==TK_SELECT && (nCol = pExpr->x.pSelect->pEList->nExpr)!=1 ){
42938da209b1Sdan         sqlite3SubselectError(pParse, nCol, 1);
42948da209b1Sdan       }else{
429585bcdce2Sdrh         return sqlite3CodeSubselect(pParse, pExpr);
42968da209b1Sdan       }
429719a775c2Sdrh       break;
429819a775c2Sdrh     }
4299fc7f27b9Sdrh     case TK_SELECT_COLUMN: {
4300966e2911Sdrh       int n;
4301fc7f27b9Sdrh       if( pExpr->pLeft->iTable==0 ){
430285bcdce2Sdrh         pExpr->pLeft->iTable = sqlite3CodeSubselect(pParse, pExpr->pLeft);
4303fc7f27b9Sdrh       }
4304966e2911Sdrh       assert( pExpr->iTable==0 || pExpr->pLeft->op==TK_SELECT );
4305554a9dc7Sdrh       if( pExpr->iTable!=0
4306966e2911Sdrh        && pExpr->iTable!=(n = sqlite3ExprVectorSize(pExpr->pLeft))
4307966e2911Sdrh       ){
4308966e2911Sdrh         sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
4309966e2911Sdrh                                 pExpr->iTable, n);
4310966e2911Sdrh       }
4311c332cc30Sdrh       return pExpr->pLeft->iTable + pExpr->iColumn;
4312fc7f27b9Sdrh     }
4313fef5208cSdrh     case TK_IN: {
4314ec4ccdbcSdrh       int destIfFalse = sqlite3VdbeMakeLabel(pParse);
4315ec4ccdbcSdrh       int destIfNull = sqlite3VdbeMakeLabel(pParse);
4316e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
4317e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
431866ba23ceSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
4319e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
4320e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_AddImm, target, 0);
4321e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfNull);
4322c332cc30Sdrh       return target;
4323fef5208cSdrh     }
4324e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
4325e3365e6cSdrh 
4326e3365e6cSdrh 
43272dcef11bSdrh     /*
43282dcef11bSdrh     **    x BETWEEN y AND z
43292dcef11bSdrh     **
43302dcef11bSdrh     ** This is equivalent to
43312dcef11bSdrh     **
43322dcef11bSdrh     **    x>=y AND x<=z
43332dcef11bSdrh     **
43342dcef11bSdrh     ** X is stored in pExpr->pLeft.
43352dcef11bSdrh     ** Y is stored in pExpr->pList->a[0].pExpr.
43362dcef11bSdrh     ** Z is stored in pExpr->pList->a[1].pExpr.
43372dcef11bSdrh     */
4338fef5208cSdrh     case TK_BETWEEN: {
433971c57db0Sdan       exprCodeBetween(pParse, pExpr, target, 0, 0);
4340c332cc30Sdrh       return target;
4341fef5208cSdrh     }
434294fa9c41Sdrh     case TK_SPAN:
4343ae80ddeaSdrh     case TK_COLLATE:
43444f07e5fbSdrh     case TK_UPLUS: {
43451efa8023Sdrh       pExpr = pExpr->pLeft;
434659ee43a7Sdrh       goto expr_code_doover; /* 2018-04-28: Prevent deep recursion. OSSFuzz. */
4347a2e00042Sdrh     }
43482dcef11bSdrh 
4349165921a7Sdan     case TK_TRIGGER: {
435065a7cd16Sdan       /* If the opcode is TK_TRIGGER, then the expression is a reference
435165a7cd16Sdan       ** to a column in the new.* or old.* pseudo-tables available to
435265a7cd16Sdan       ** trigger programs. In this case Expr.iTable is set to 1 for the
435365a7cd16Sdan       ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
435465a7cd16Sdan       ** is set to the column of the pseudo-table to read, or to -1 to
435565a7cd16Sdan       ** read the rowid field.
435665a7cd16Sdan       **
435765a7cd16Sdan       ** The expression is implemented using an OP_Param opcode. The p1
435865a7cd16Sdan       ** parameter is set to 0 for an old.rowid reference, or to (i+1)
435965a7cd16Sdan       ** to reference another column of the old.* pseudo-table, where
436065a7cd16Sdan       ** i is the index of the column. For a new.rowid reference, p1 is
436165a7cd16Sdan       ** set to (n+1), where n is the number of columns in each pseudo-table.
436265a7cd16Sdan       ** For a reference to any other column in the new.* pseudo-table, p1
436365a7cd16Sdan       ** is set to (n+2+i), where n and i are as defined previously. For
436465a7cd16Sdan       ** example, if the table on which triggers are being fired is
436565a7cd16Sdan       ** declared as:
436665a7cd16Sdan       **
436765a7cd16Sdan       **   CREATE TABLE t1(a, b);
436865a7cd16Sdan       **
436965a7cd16Sdan       ** Then p1 is interpreted as follows:
437065a7cd16Sdan       **
437165a7cd16Sdan       **   p1==0   ->    old.rowid     p1==3   ->    new.rowid
437265a7cd16Sdan       **   p1==1   ->    old.a         p1==4   ->    new.a
437365a7cd16Sdan       **   p1==2   ->    old.b         p1==5   ->    new.b
437465a7cd16Sdan       */
4375eda079cdSdrh       Table *pTab = pExpr->y.pTab;
4376dd6cc9b5Sdrh       int iCol = pExpr->iColumn;
4377dd6cc9b5Sdrh       int p1 = pExpr->iTable * (pTab->nCol+1) + 1
43787fe2fc0dSdrh                      + sqlite3TableColumnToStorage(pTab, iCol);
437965a7cd16Sdan 
438065a7cd16Sdan       assert( pExpr->iTable==0 || pExpr->iTable==1 );
4381dd6cc9b5Sdrh       assert( iCol>=-1 && iCol<pTab->nCol );
4382dd6cc9b5Sdrh       assert( pTab->iPKey<0 || iCol!=pTab->iPKey );
438365a7cd16Sdan       assert( p1>=0 && p1<(pTab->nCol*2+2) );
438465a7cd16Sdan 
438565a7cd16Sdan       sqlite3VdbeAddOp2(v, OP_Param, p1, target);
4386896494e8Sdrh       VdbeComment((v, "r[%d]=%s.%s", target,
4387165921a7Sdan         (pExpr->iTable ? "new" : "old"),
4388dd6cc9b5Sdrh         (pExpr->iColumn<0 ? "rowid" : pExpr->y.pTab->aCol[iCol].zName)
4389165921a7Sdan       ));
439065a7cd16Sdan 
439144dbca83Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
439265a7cd16Sdan       /* If the column has REAL affinity, it may currently be stored as an
4393113762a2Sdrh       ** integer. Use OP_RealAffinity to make sure it is really real.
4394113762a2Sdrh       **
4395113762a2Sdrh       ** EVIDENCE-OF: R-60985-57662 SQLite will convert the value back to
4396113762a2Sdrh       ** floating point when extracting it from the record.  */
4397dd6cc9b5Sdrh       if( iCol>=0 && pTab->aCol[iCol].affinity==SQLITE_AFF_REAL ){
43982832ad42Sdan         sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
43992832ad42Sdan       }
440044dbca83Sdrh #endif
4401165921a7Sdan       break;
4402165921a7Sdan     }
4403165921a7Sdan 
440471c57db0Sdan     case TK_VECTOR: {
4405e835bc12Sdrh       sqlite3ErrorMsg(pParse, "row value misused");
440671c57db0Sdan       break;
440771c57db0Sdan     }
440871c57db0Sdan 
44099e9a67adSdrh     /* TK_IF_NULL_ROW Expr nodes are inserted ahead of expressions
44109e9a67adSdrh     ** that derive from the right-hand table of a LEFT JOIN.  The
44119e9a67adSdrh     ** Expr.iTable value is the table number for the right-hand table.
44129e9a67adSdrh     ** The expression is only evaluated if that table is not currently
44139e9a67adSdrh     ** on a LEFT JOIN NULL row.
44149e9a67adSdrh     */
441531d6fd55Sdrh     case TK_IF_NULL_ROW: {
441631d6fd55Sdrh       int addrINR;
44179e9a67adSdrh       u8 okConstFactor = pParse->okConstFactor;
441831d6fd55Sdrh       addrINR = sqlite3VdbeAddOp1(v, OP_IfNullRow, pExpr->iTable);
44199e9a67adSdrh       /* Temporarily disable factoring of constant expressions, since
44209e9a67adSdrh       ** even though expressions may appear to be constant, they are not
44219e9a67adSdrh       ** really constant because they originate from the right-hand side
44229e9a67adSdrh       ** of a LEFT JOIN. */
44239e9a67adSdrh       pParse->okConstFactor = 0;
442431d6fd55Sdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
44259e9a67adSdrh       pParse->okConstFactor = okConstFactor;
442631d6fd55Sdrh       sqlite3VdbeJumpHere(v, addrINR);
442731d6fd55Sdrh       sqlite3VdbeChangeP3(v, addrINR, inReg);
442831d6fd55Sdrh       break;
442931d6fd55Sdrh     }
443031d6fd55Sdrh 
44312dcef11bSdrh     /*
44322dcef11bSdrh     ** Form A:
44332dcef11bSdrh     **   CASE x WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
44342dcef11bSdrh     **
44352dcef11bSdrh     ** Form B:
44362dcef11bSdrh     **   CASE WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
44372dcef11bSdrh     **
44382dcef11bSdrh     ** Form A is can be transformed into the equivalent form B as follows:
44392dcef11bSdrh     **   CASE WHEN x=e1 THEN r1 WHEN x=e2 THEN r2 ...
44402dcef11bSdrh     **        WHEN x=eN THEN rN ELSE y END
44412dcef11bSdrh     **
44422dcef11bSdrh     ** X (if it exists) is in pExpr->pLeft.
4443c5cd1249Sdrh     ** Y is in the last element of pExpr->x.pList if pExpr->x.pList->nExpr is
4444c5cd1249Sdrh     ** odd.  The Y is also optional.  If the number of elements in x.pList
4445c5cd1249Sdrh     ** is even, then Y is omitted and the "otherwise" result is NULL.
44462dcef11bSdrh     ** Ei is in pExpr->pList->a[i*2] and Ri is pExpr->pList->a[i*2+1].
44472dcef11bSdrh     **
44482dcef11bSdrh     ** The result of the expression is the Ri for the first matching Ei,
44492dcef11bSdrh     ** or if there is no matching Ei, the ELSE term Y, or if there is
44502dcef11bSdrh     ** no ELSE term, NULL.
44512dcef11bSdrh     */
4452aac30f9bSdrh     case TK_CASE: {
44532dcef11bSdrh       int endLabel;                     /* GOTO label for end of CASE stmt */
44542dcef11bSdrh       int nextCase;                     /* GOTO label for next WHEN clause */
44552dcef11bSdrh       int nExpr;                        /* 2x number of WHEN terms */
44562dcef11bSdrh       int i;                            /* Loop counter */
44572dcef11bSdrh       ExprList *pEList;                 /* List of WHEN terms */
44582dcef11bSdrh       struct ExprList_item *aListelem;  /* Array of WHEN terms */
44592dcef11bSdrh       Expr opCompare;                   /* The X==Ei expression */
44602dcef11bSdrh       Expr *pX;                         /* The X expression */
44611bd10f8aSdrh       Expr *pTest = 0;                  /* X==Ei (form A) or just Ei (form B) */
44628b65e591Sdan       Expr *pDel = 0;
44638b65e591Sdan       sqlite3 *db = pParse->db;
446417a7f8ddSdrh 
44656ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) && pExpr->x.pList );
44666ab3a2ecSdanielk1977       assert(pExpr->x.pList->nExpr > 0);
44676ab3a2ecSdanielk1977       pEList = pExpr->x.pList;
4468be5c89acSdrh       aListelem = pEList->a;
4469be5c89acSdrh       nExpr = pEList->nExpr;
4470ec4ccdbcSdrh       endLabel = sqlite3VdbeMakeLabel(pParse);
44712dcef11bSdrh       if( (pX = pExpr->pLeft)!=0 ){
44728b65e591Sdan         pDel = sqlite3ExprDup(db, pX, 0);
44738b65e591Sdan         if( db->mallocFailed ){
44748b65e591Sdan           sqlite3ExprDelete(db, pDel);
44758b65e591Sdan           break;
44768b65e591Sdan         }
447733cd4909Sdrh         testcase( pX->op==TK_COLUMN );
44788b65e591Sdan         exprToRegister(pDel, exprCodeVector(pParse, pDel, &regFree1));
4479c5499befSdrh         testcase( regFree1==0 );
4480abb9d5f1Sdrh         memset(&opCompare, 0, sizeof(opCompare));
44812dcef11bSdrh         opCompare.op = TK_EQ;
44828b65e591Sdan         opCompare.pLeft = pDel;
44832dcef11bSdrh         pTest = &opCompare;
44848b1db07fSdrh         /* Ticket b351d95f9cd5ef17e9d9dbae18f5ca8611190001:
44858b1db07fSdrh         ** The value in regFree1 might get SCopy-ed into the file result.
44868b1db07fSdrh         ** So make sure that the regFree1 register is not reused for other
44878b1db07fSdrh         ** purposes and possibly overwritten.  */
44888b1db07fSdrh         regFree1 = 0;
4489cce7d176Sdrh       }
4490c5cd1249Sdrh       for(i=0; i<nExpr-1; i=i+2){
44912dcef11bSdrh         if( pX ){
44921bd10f8aSdrh           assert( pTest!=0 );
44932dcef11bSdrh           opCompare.pRight = aListelem[i].pExpr;
4494f5905aa7Sdrh         }else{
44952dcef11bSdrh           pTest = aListelem[i].pExpr;
449617a7f8ddSdrh         }
4497ec4ccdbcSdrh         nextCase = sqlite3VdbeMakeLabel(pParse);
449833cd4909Sdrh         testcase( pTest->op==TK_COLUMN );
44992dcef11bSdrh         sqlite3ExprIfFalse(pParse, pTest, nextCase, SQLITE_JUMPIFNULL);
4500c5499befSdrh         testcase( aListelem[i+1].pExpr->op==TK_COLUMN );
45019de221dfSdrh         sqlite3ExprCode(pParse, aListelem[i+1].pExpr, target);
4502076e85f5Sdrh         sqlite3VdbeGoto(v, endLabel);
45032dcef11bSdrh         sqlite3VdbeResolveLabel(v, nextCase);
4504f570f011Sdrh       }
4505c5cd1249Sdrh       if( (nExpr&1)!=0 ){
4506c5cd1249Sdrh         sqlite3ExprCode(pParse, pEList->a[nExpr-1].pExpr, target);
450717a7f8ddSdrh       }else{
45089de221dfSdrh         sqlite3VdbeAddOp2(v, OP_Null, 0, target);
450917a7f8ddSdrh       }
45108b65e591Sdan       sqlite3ExprDelete(db, pDel);
451192a27f7bSdrh       setDoNotMergeFlagOnCopy(v);
45122dcef11bSdrh       sqlite3VdbeResolveLabel(v, endLabel);
45136f34903eSdanielk1977       break;
45146f34903eSdanielk1977     }
45155338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_TRIGGER
45166f34903eSdanielk1977     case TK_RAISE: {
45171194904bSdrh       assert( pExpr->affExpr==OE_Rollback
45181194904bSdrh            || pExpr->affExpr==OE_Abort
45191194904bSdrh            || pExpr->affExpr==OE_Fail
45201194904bSdrh            || pExpr->affExpr==OE_Ignore
4521165921a7Sdan       );
45229e5fdc41Sdrh       if( !pParse->pTriggerTab && !pParse->nested ){
4523e0af83acSdan         sqlite3ErrorMsg(pParse,
4524e0af83acSdan                        "RAISE() may only be used within a trigger-program");
4525e0af83acSdan         return 0;
4526e0af83acSdan       }
45271194904bSdrh       if( pExpr->affExpr==OE_Abort ){
4528e0af83acSdan         sqlite3MayAbort(pParse);
4529e0af83acSdan       }
453033e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
45311194904bSdrh       if( pExpr->affExpr==OE_Ignore ){
4532e0af83acSdan         sqlite3VdbeAddOp4(
4533e0af83acSdan             v, OP_Halt, SQLITE_OK, OE_Ignore, 0, pExpr->u.zToken,0);
4534688852abSdrh         VdbeCoverage(v);
4535e0af83acSdan       }else{
45369e5fdc41Sdrh         sqlite3HaltConstraint(pParse,
45379e5fdc41Sdrh              pParse->pTriggerTab ? SQLITE_CONSTRAINT_TRIGGER : SQLITE_ERROR,
45381194904bSdrh              pExpr->affExpr, pExpr->u.zToken, 0, 0);
4539e0af83acSdan       }
4540e0af83acSdan 
4541ffe07b2dSdrh       break;
454217a7f8ddSdrh     }
45435338a5f7Sdanielk1977 #endif
4544ffe07b2dSdrh   }
45452dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
45462dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
45472dcef11bSdrh   return inReg;
45485b6afba9Sdrh }
45492dcef11bSdrh 
45502dcef11bSdrh /*
45519b258c54Sdrh ** Generate code that will evaluate expression pExpr just one time
45529b258c54Sdrh ** per prepared statement execution.
45539b258c54Sdrh **
45549b258c54Sdrh ** If the expression uses functions (that might throw an exception) then
45559b258c54Sdrh ** guard them with an OP_Once opcode to ensure that the code is only executed
45569b258c54Sdrh ** once. If no functions are involved, then factor the code out and put it at
45579b258c54Sdrh ** the end of the prepared statement in the initialization section.
45581e9b53f9Sdrh **
4559ad879ffdSdrh ** If regDest>=0 then the result is always stored in that register and the
4560ad879ffdSdrh ** result is not reusable.  If regDest<0 then this routine is free to
4561ad879ffdSdrh ** store the value whereever it wants.  The register where the expression
45629b258c54Sdrh ** is stored is returned.  When regDest<0, two identical expressions might
45639b258c54Sdrh ** code to the same register, if they do not contain function calls and hence
45649b258c54Sdrh ** are factored out into the initialization section at the end of the
45659b258c54Sdrh ** prepared statement.
4566d1a01edaSdrh */
45679b258c54Sdrh int sqlite3ExprCodeRunJustOnce(
4568d673cddaSdrh   Parse *pParse,    /* Parsing context */
4569d673cddaSdrh   Expr *pExpr,      /* The expression to code when the VDBE initializes */
4570ad879ffdSdrh   int regDest       /* Store the value in this register */
4571d673cddaSdrh ){
4572d1a01edaSdrh   ExprList *p;
4573d9f158e7Sdrh   assert( ConstFactorOk(pParse) );
4574d1a01edaSdrh   p = pParse->pConstExpr;
4575ad879ffdSdrh   if( regDest<0 && p ){
45761e9b53f9Sdrh     struct ExprList_item *pItem;
45771e9b53f9Sdrh     int i;
45781e9b53f9Sdrh     for(pItem=p->a, i=p->nExpr; i>0; pItem++, i--){
45795aa550cfSdan       if( pItem->reusable && sqlite3ExprCompare(0,pItem->pExpr,pExpr,-1)==0 ){
45801e9b53f9Sdrh         return pItem->u.iConstExprReg;
45811e9b53f9Sdrh       }
45821e9b53f9Sdrh     }
45831e9b53f9Sdrh   }
4584d1a01edaSdrh   pExpr = sqlite3ExprDup(pParse->db, pExpr, 0);
458538dfbdaeSdrh   if( pExpr!=0 && ExprHasProperty(pExpr, EP_HasFunc) ){
458638dfbdaeSdrh     Vdbe *v = pParse->pVdbe;
458738dfbdaeSdrh     int addr;
458838dfbdaeSdrh     assert( v );
458938dfbdaeSdrh     addr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
459038dfbdaeSdrh     pParse->okConstFactor = 0;
459138dfbdaeSdrh     if( !pParse->db->mallocFailed ){
45929b258c54Sdrh       if( regDest<0 ) regDest = ++pParse->nMem;
459338dfbdaeSdrh       sqlite3ExprCode(pParse, pExpr, regDest);
459438dfbdaeSdrh     }
459538dfbdaeSdrh     pParse->okConstFactor = 1;
459638dfbdaeSdrh     sqlite3ExprDelete(pParse->db, pExpr);
459738dfbdaeSdrh     sqlite3VdbeJumpHere(v, addr);
459838dfbdaeSdrh   }else{
4599d1a01edaSdrh     p = sqlite3ExprListAppend(pParse, p, pExpr);
4600d673cddaSdrh     if( p ){
4601d673cddaSdrh        struct ExprList_item *pItem = &p->a[p->nExpr-1];
4602ad879ffdSdrh        pItem->reusable = regDest<0;
46039b258c54Sdrh        if( regDest<0 ) regDest = ++pParse->nMem;
4604d673cddaSdrh        pItem->u.iConstExprReg = regDest;
4605d673cddaSdrh     }
4606d1a01edaSdrh     pParse->pConstExpr = p;
460738dfbdaeSdrh   }
46081e9b53f9Sdrh   return regDest;
4609d1a01edaSdrh }
4610d1a01edaSdrh 
4611d1a01edaSdrh /*
46122dcef11bSdrh ** Generate code to evaluate an expression and store the results
46132dcef11bSdrh ** into a register.  Return the register number where the results
46142dcef11bSdrh ** are stored.
46152dcef11bSdrh **
46162dcef11bSdrh ** If the register is a temporary register that can be deallocated,
4617678ccce8Sdrh ** then write its number into *pReg.  If the result register is not
46182dcef11bSdrh ** a temporary, then set *pReg to zero.
4619f30a969bSdrh **
4620f30a969bSdrh ** If pExpr is a constant, then this routine might generate this
4621f30a969bSdrh ** code to fill the register in the initialization section of the
4622f30a969bSdrh ** VDBE program, in order to factor it out of the evaluation loop.
46232dcef11bSdrh */
46242dcef11bSdrh int sqlite3ExprCodeTemp(Parse *pParse, Expr *pExpr, int *pReg){
4625f30a969bSdrh   int r2;
46260d950af3Sdrh   pExpr = sqlite3ExprSkipCollateAndLikely(pExpr);
4627d9f158e7Sdrh   if( ConstFactorOk(pParse)
4628235667a8Sdrh    && ALWAYS(pExpr!=0)
4629f30a969bSdrh    && pExpr->op!=TK_REGISTER
4630f30a969bSdrh    && sqlite3ExprIsConstantNotJoin(pExpr)
4631f30a969bSdrh   ){
4632f30a969bSdrh     *pReg  = 0;
46339b258c54Sdrh     r2 = sqlite3ExprCodeRunJustOnce(pParse, pExpr, -1);
4634f30a969bSdrh   }else{
46352dcef11bSdrh     int r1 = sqlite3GetTempReg(pParse);
4636f30a969bSdrh     r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
46372dcef11bSdrh     if( r2==r1 ){
46382dcef11bSdrh       *pReg = r1;
46392dcef11bSdrh     }else{
46402dcef11bSdrh       sqlite3ReleaseTempReg(pParse, r1);
46412dcef11bSdrh       *pReg = 0;
46422dcef11bSdrh     }
4643f30a969bSdrh   }
46442dcef11bSdrh   return r2;
46452dcef11bSdrh }
46462dcef11bSdrh 
46472dcef11bSdrh /*
46482dcef11bSdrh ** Generate code that will evaluate expression pExpr and store the
46492dcef11bSdrh ** results in register target.  The results are guaranteed to appear
46502dcef11bSdrh ** in register target.
46512dcef11bSdrh */
465205a86c5cSdrh void sqlite3ExprCode(Parse *pParse, Expr *pExpr, int target){
46539cbf3425Sdrh   int inReg;
46549cbf3425Sdrh 
4655e7375bfaSdrh   assert( pExpr==0 || !ExprHasVVAProperty(pExpr,EP_Immutable) );
46569cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
46571c75c9d7Sdrh   assert( pParse->pVdbe!=0 || pParse->db->mallocFailed );
4658b639a209Sdrh   if( pParse->pVdbe==0 ) return;
4659b639a209Sdrh   inReg = sqlite3ExprCodeTarget(pParse, pExpr, target);
4660b639a209Sdrh   if( inReg!=target ){
4661629b88c6Sdrh     u8 op;
4662629b88c6Sdrh     if( ExprHasProperty(pExpr,EP_Subquery) ){
4663629b88c6Sdrh       op = OP_Copy;
4664629b88c6Sdrh     }else{
4665629b88c6Sdrh       op = OP_SCopy;
4666629b88c6Sdrh     }
4667629b88c6Sdrh     sqlite3VdbeAddOp2(pParse->pVdbe, op, inReg, target);
466817a7f8ddSdrh   }
4669ebc16717Sdrh }
4670cce7d176Sdrh 
4671cce7d176Sdrh /*
46721c75c9d7Sdrh ** Make a transient copy of expression pExpr and then code it using
46731c75c9d7Sdrh ** sqlite3ExprCode().  This routine works just like sqlite3ExprCode()
46741c75c9d7Sdrh ** except that the input expression is guaranteed to be unchanged.
46751c75c9d7Sdrh */
46761c75c9d7Sdrh void sqlite3ExprCodeCopy(Parse *pParse, Expr *pExpr, int target){
46771c75c9d7Sdrh   sqlite3 *db = pParse->db;
46781c75c9d7Sdrh   pExpr = sqlite3ExprDup(db, pExpr, 0);
46791c75c9d7Sdrh   if( !db->mallocFailed ) sqlite3ExprCode(pParse, pExpr, target);
46801c75c9d7Sdrh   sqlite3ExprDelete(db, pExpr);
46811c75c9d7Sdrh }
46821c75c9d7Sdrh 
46831c75c9d7Sdrh /*
468405a86c5cSdrh ** Generate code that will evaluate expression pExpr and store the
468505a86c5cSdrh ** results in register target.  The results are guaranteed to appear
468605a86c5cSdrh ** in register target.  If the expression is constant, then this routine
468705a86c5cSdrh ** might choose to code the expression at initialization time.
468805a86c5cSdrh */
468905a86c5cSdrh void sqlite3ExprCodeFactorable(Parse *pParse, Expr *pExpr, int target){
4690b8b06690Sdrh   if( pParse->okConstFactor && sqlite3ExprIsConstantNotJoin(pExpr) ){
46919b258c54Sdrh     sqlite3ExprCodeRunJustOnce(pParse, pExpr, target);
469205a86c5cSdrh   }else{
4693088489e8Sdrh     sqlite3ExprCodeCopy(pParse, pExpr, target);
469405a86c5cSdrh   }
4695cce7d176Sdrh }
4696cce7d176Sdrh 
4697cce7d176Sdrh /*
4698268380caSdrh ** Generate code that pushes the value of every element of the given
46999cbf3425Sdrh ** expression list into a sequence of registers beginning at target.
4700268380caSdrh **
47013df6c3b1Sdrh ** Return the number of elements evaluated.  The number returned will
47023df6c3b1Sdrh ** usually be pList->nExpr but might be reduced if SQLITE_ECEL_OMITREF
47033df6c3b1Sdrh ** is defined.
4704d1a01edaSdrh **
4705d1a01edaSdrh ** The SQLITE_ECEL_DUP flag prevents the arguments from being
4706d1a01edaSdrh ** filled using OP_SCopy.  OP_Copy must be used instead.
4707d1a01edaSdrh **
4708d1a01edaSdrh ** The SQLITE_ECEL_FACTOR argument allows constant arguments to be
4709d1a01edaSdrh ** factored out into initialization code.
4710b0df9634Sdrh **
4711b0df9634Sdrh ** The SQLITE_ECEL_REF flag means that expressions in the list with
4712b0df9634Sdrh ** ExprList.a[].u.x.iOrderByCol>0 have already been evaluated and stored
4713b0df9634Sdrh ** in registers at srcReg, and so the value can be copied from there.
47143df6c3b1Sdrh ** If SQLITE_ECEL_OMITREF is also set, then the values with u.x.iOrderByCol>0
47153df6c3b1Sdrh ** are simply omitted rather than being copied from srcReg.
4716268380caSdrh */
47174adee20fSdanielk1977 int sqlite3ExprCodeExprList(
4718268380caSdrh   Parse *pParse,     /* Parsing context */
4719389a1adbSdrh   ExprList *pList,   /* The expression list to be coded */
4720191b54cbSdrh   int target,        /* Where to write results */
47215579d59fSdrh   int srcReg,        /* Source registers if SQLITE_ECEL_REF */
4722d1a01edaSdrh   u8 flags           /* SQLITE_ECEL_* flags */
4723268380caSdrh ){
4724268380caSdrh   struct ExprList_item *pItem;
47255579d59fSdrh   int i, j, n;
4726d1a01edaSdrh   u8 copyOp = (flags & SQLITE_ECEL_DUP) ? OP_Copy : OP_SCopy;
47275579d59fSdrh   Vdbe *v = pParse->pVdbe;
47289d8b3072Sdrh   assert( pList!=0 );
47299cbf3425Sdrh   assert( target>0 );
4730d81a142bSdrh   assert( pParse->pVdbe!=0 );  /* Never gets this far otherwise */
4731268380caSdrh   n = pList->nExpr;
4732d9f158e7Sdrh   if( !ConstFactorOk(pParse) ) flags &= ~SQLITE_ECEL_FACTOR;
4733191b54cbSdrh   for(pItem=pList->a, i=0; i<n; i++, pItem++){
47347445ffe2Sdrh     Expr *pExpr = pItem->pExpr;
473524e25d32Sdan #ifdef SQLITE_ENABLE_SORTER_REFERENCES
473624e25d32Sdan     if( pItem->bSorterRef ){
473724e25d32Sdan       i--;
473824e25d32Sdan       n--;
473924e25d32Sdan     }else
474024e25d32Sdan #endif
4741257c13faSdan     if( (flags & SQLITE_ECEL_REF)!=0 && (j = pItem->u.x.iOrderByCol)>0 ){
4742257c13faSdan       if( flags & SQLITE_ECEL_OMITREF ){
4743257c13faSdan         i--;
4744257c13faSdan         n--;
4745257c13faSdan       }else{
47465579d59fSdrh         sqlite3VdbeAddOp2(v, copyOp, j+srcReg-1, target+i);
4747257c13faSdan       }
4748b8b06690Sdrh     }else if( (flags & SQLITE_ECEL_FACTOR)!=0
4749b8b06690Sdrh            && sqlite3ExprIsConstantNotJoin(pExpr)
4750b8b06690Sdrh     ){
47519b258c54Sdrh       sqlite3ExprCodeRunJustOnce(pParse, pExpr, target+i);
4752d1a01edaSdrh     }else{
47537445ffe2Sdrh       int inReg = sqlite3ExprCodeTarget(pParse, pExpr, target+i);
4754746fd9ccSdrh       if( inReg!=target+i ){
47554eded604Sdrh         VdbeOp *pOp;
47564eded604Sdrh         if( copyOp==OP_Copy
47574eded604Sdrh          && (pOp=sqlite3VdbeGetOp(v, -1))->opcode==OP_Copy
47584eded604Sdrh          && pOp->p1+pOp->p3+1==inReg
47594eded604Sdrh          && pOp->p2+pOp->p3+1==target+i
476090996885Sdrh          && pOp->p5==0  /* The do-not-merge flag must be clear */
47614eded604Sdrh         ){
47624eded604Sdrh           pOp->p3++;
47634eded604Sdrh         }else{
47644eded604Sdrh           sqlite3VdbeAddOp2(v, copyOp, inReg, target+i);
47654eded604Sdrh         }
4766d1a01edaSdrh       }
4767d176611bSdrh     }
4768268380caSdrh   }
4769f9b596ebSdrh   return n;
4770268380caSdrh }
4771268380caSdrh 
4772268380caSdrh /*
477336c563a2Sdrh ** Generate code for a BETWEEN operator.
477436c563a2Sdrh **
477536c563a2Sdrh **    x BETWEEN y AND z
477636c563a2Sdrh **
477736c563a2Sdrh ** The above is equivalent to
477836c563a2Sdrh **
477936c563a2Sdrh **    x>=y AND x<=z
478036c563a2Sdrh **
478136c563a2Sdrh ** Code it as such, taking care to do the common subexpression
478260ec914cSpeter.d.reid ** elimination of x.
478384b19a3dSdrh **
478484b19a3dSdrh ** The xJumpIf parameter determines details:
478584b19a3dSdrh **
478684b19a3dSdrh **    NULL:                   Store the boolean result in reg[dest]
478784b19a3dSdrh **    sqlite3ExprIfTrue:      Jump to dest if true
478884b19a3dSdrh **    sqlite3ExprIfFalse:     Jump to dest if false
478984b19a3dSdrh **
479084b19a3dSdrh ** The jumpIfNull parameter is ignored if xJumpIf is NULL.
479136c563a2Sdrh */
479236c563a2Sdrh static void exprCodeBetween(
479336c563a2Sdrh   Parse *pParse,    /* Parsing and code generating context */
479436c563a2Sdrh   Expr *pExpr,      /* The BETWEEN expression */
479584b19a3dSdrh   int dest,         /* Jump destination or storage location */
479684b19a3dSdrh   void (*xJump)(Parse*,Expr*,int,int), /* Action to take */
479736c563a2Sdrh   int jumpIfNull    /* Take the jump if the BETWEEN is NULL */
479836c563a2Sdrh ){
479936c563a2Sdrh   Expr exprAnd;     /* The AND operator in  x>=y AND x<=z  */
480036c563a2Sdrh   Expr compLeft;    /* The  x>=y  term */
480136c563a2Sdrh   Expr compRight;   /* The  x<=z  term */
4802db45bd5eSdrh   int regFree1 = 0; /* Temporary use register */
48038b65e591Sdan   Expr *pDel = 0;
48048b65e591Sdan   sqlite3 *db = pParse->db;
480584b19a3dSdrh 
480671c57db0Sdan   memset(&compLeft, 0, sizeof(Expr));
480771c57db0Sdan   memset(&compRight, 0, sizeof(Expr));
480871c57db0Sdan   memset(&exprAnd, 0, sizeof(Expr));
4809db45bd5eSdrh 
4810db45bd5eSdrh   assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
48118b65e591Sdan   pDel = sqlite3ExprDup(db, pExpr->pLeft, 0);
48128b65e591Sdan   if( db->mallocFailed==0 ){
481336c563a2Sdrh     exprAnd.op = TK_AND;
481436c563a2Sdrh     exprAnd.pLeft = &compLeft;
481536c563a2Sdrh     exprAnd.pRight = &compRight;
481636c563a2Sdrh     compLeft.op = TK_GE;
48178b65e591Sdan     compLeft.pLeft = pDel;
481836c563a2Sdrh     compLeft.pRight = pExpr->x.pList->a[0].pExpr;
481936c563a2Sdrh     compRight.op = TK_LE;
48208b65e591Sdan     compRight.pLeft = pDel;
482136c563a2Sdrh     compRight.pRight = pExpr->x.pList->a[1].pExpr;
48228b65e591Sdan     exprToRegister(pDel, exprCodeVector(pParse, pDel, &regFree1));
482384b19a3dSdrh     if( xJump ){
482484b19a3dSdrh       xJump(pParse, &exprAnd, dest, jumpIfNull);
482536c563a2Sdrh     }else{
482636fd41e5Sdrh       /* Mark the expression is being from the ON or USING clause of a join
482736fd41e5Sdrh       ** so that the sqlite3ExprCodeTarget() routine will not attempt to move
482836fd41e5Sdrh       ** it into the Parse.pConstExpr list.  We should use a new bit for this,
482936fd41e5Sdrh       ** for clarity, but we are out of bits in the Expr.flags field so we
483036fd41e5Sdrh       ** have to reuse the EP_FromJoin bit.  Bummer. */
48318b65e591Sdan       pDel->flags |= EP_FromJoin;
483271c57db0Sdan       sqlite3ExprCodeTarget(pParse, &exprAnd, dest);
483336c563a2Sdrh     }
4834db45bd5eSdrh     sqlite3ReleaseTempReg(pParse, regFree1);
48358b65e591Sdan   }
48368b65e591Sdan   sqlite3ExprDelete(db, pDel);
483736c563a2Sdrh 
483836c563a2Sdrh   /* Ensure adequate test coverage */
4839db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull==0 && regFree1==0 );
4840db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull==0 && regFree1!=0 );
4841db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull!=0 && regFree1==0 );
4842db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull!=0 && regFree1!=0 );
4843db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1==0 );
4844db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1!=0 );
4845db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1==0 );
4846db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1!=0 );
484784b19a3dSdrh   testcase( xJump==0 );
484836c563a2Sdrh }
484936c563a2Sdrh 
485036c563a2Sdrh /*
4851cce7d176Sdrh ** Generate code for a boolean expression such that a jump is made
4852cce7d176Sdrh ** to the label "dest" if the expression is true but execution
4853cce7d176Sdrh ** continues straight thru if the expression is false.
4854f5905aa7Sdrh **
4855f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false), then
485635573356Sdrh ** take the jump if the jumpIfNull flag is SQLITE_JUMPIFNULL.
4857f2bc013cSdrh **
4858f2bc013cSdrh ** This code depends on the fact that certain token values (ex: TK_EQ)
4859f2bc013cSdrh ** are the same as opcode values (ex: OP_Eq) that implement the corresponding
4860f2bc013cSdrh ** operation.  Special comments in vdbe.c and the mkopcodeh.awk script in
4861f2bc013cSdrh ** the make process cause these values to align.  Assert()s in the code
4862f2bc013cSdrh ** below verify that the numbers are aligned correctly.
4863cce7d176Sdrh */
48644adee20fSdanielk1977 void sqlite3ExprIfTrue(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
4865cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
4866cce7d176Sdrh   int op = 0;
48672dcef11bSdrh   int regFree1 = 0;
48682dcef11bSdrh   int regFree2 = 0;
48692dcef11bSdrh   int r1, r2;
48702dcef11bSdrh 
487135573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
487248864df9Smistachkin   if( NEVER(v==0) )     return;  /* Existence of VDBE checked by caller */
487333cd4909Sdrh   if( NEVER(pExpr==0) ) return;  /* No way this can happen */
4874e7375bfaSdrh   assert( !ExprHasVVAProperty(pExpr, EP_Immutable) );
4875f2bc013cSdrh   op = pExpr->op;
48767b35a77bSdan   switch( op ){
487717180fcaSdrh     case TK_AND:
487817180fcaSdrh     case TK_OR: {
487917180fcaSdrh       Expr *pAlt = sqlite3ExprSimplifiedAndOr(pExpr);
488017180fcaSdrh       if( pAlt!=pExpr ){
488117180fcaSdrh         sqlite3ExprIfTrue(pParse, pAlt, dest, jumpIfNull);
488217180fcaSdrh       }else if( op==TK_AND ){
4883ec4ccdbcSdrh         int d2 = sqlite3VdbeMakeLabel(pParse);
4884c5499befSdrh         testcase( jumpIfNull==0 );
488517180fcaSdrh         sqlite3ExprIfFalse(pParse, pExpr->pLeft, d2,
488617180fcaSdrh                            jumpIfNull^SQLITE_JUMPIFNULL);
48874adee20fSdanielk1977         sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
48884adee20fSdanielk1977         sqlite3VdbeResolveLabel(v, d2);
488917180fcaSdrh       }else{
4890c5499befSdrh         testcase( jumpIfNull==0 );
48914adee20fSdanielk1977         sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
48924adee20fSdanielk1977         sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
489317180fcaSdrh       }
4894cce7d176Sdrh       break;
4895cce7d176Sdrh     }
4896cce7d176Sdrh     case TK_NOT: {
4897c5499befSdrh       testcase( jumpIfNull==0 );
48984adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
4899cce7d176Sdrh       break;
4900cce7d176Sdrh     }
49018abed7b9Sdrh     case TK_TRUTH: {
490296acafbeSdrh       int isNot;      /* IS NOT TRUE or IS NOT FALSE */
490396acafbeSdrh       int isTrue;     /* IS TRUE or IS NOT TRUE */
4904007c843bSdrh       testcase( jumpIfNull==0 );
49058abed7b9Sdrh       isNot = pExpr->op2==TK_ISNOT;
490696acafbeSdrh       isTrue = sqlite3ExprTruthValue(pExpr->pRight);
490743c4ac8bSdrh       testcase( isTrue && isNot );
490896acafbeSdrh       testcase( !isTrue && isNot );
490943c4ac8bSdrh       if( isTrue ^ isNot ){
49108abed7b9Sdrh         sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
49118abed7b9Sdrh                           isNot ? SQLITE_JUMPIFNULL : 0);
49128abed7b9Sdrh       }else{
49138abed7b9Sdrh         sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
49148abed7b9Sdrh                            isNot ? SQLITE_JUMPIFNULL : 0);
49158abed7b9Sdrh       }
4916007c843bSdrh       break;
4917007c843bSdrh     }
4918de845c2fSdrh     case TK_IS:
4919de845c2fSdrh     case TK_ISNOT:
4920de845c2fSdrh       testcase( op==TK_IS );
4921de845c2fSdrh       testcase( op==TK_ISNOT );
4922de845c2fSdrh       op = (op==TK_IS) ? TK_EQ : TK_NE;
4923de845c2fSdrh       jumpIfNull = SQLITE_NULLEQ;
492408b92086Sdrh       /* no break */ deliberate_fall_through
4925cce7d176Sdrh     case TK_LT:
4926cce7d176Sdrh     case TK_LE:
4927cce7d176Sdrh     case TK_GT:
4928cce7d176Sdrh     case TK_GE:
4929cce7d176Sdrh     case TK_NE:
49300ac65892Sdrh     case TK_EQ: {
4931625015e0Sdan       if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
4932c5499befSdrh       testcase( jumpIfNull==0 );
4933b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4934b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
493535573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
4936898c527eSdrh                   r1, r2, dest, jumpIfNull, ExprHasProperty(pExpr,EP_Commuted));
49377d176105Sdrh       assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
49387d176105Sdrh       assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
49397d176105Sdrh       assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
49407d176105Sdrh       assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
4941de845c2fSdrh       assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4942de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4943de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4944de845c2fSdrh       assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4945de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
4946de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
49476a2fe093Sdrh       testcase( regFree1==0 );
49486a2fe093Sdrh       testcase( regFree2==0 );
49496a2fe093Sdrh       break;
49506a2fe093Sdrh     }
4951cce7d176Sdrh     case TK_ISNULL:
4952cce7d176Sdrh     case TK_NOTNULL: {
49537d176105Sdrh       assert( TK_ISNULL==OP_IsNull );   testcase( op==TK_ISNULL );
49547d176105Sdrh       assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
49552dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
49562dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
49577d176105Sdrh       VdbeCoverageIf(v, op==TK_ISNULL);
49587d176105Sdrh       VdbeCoverageIf(v, op==TK_NOTNULL);
4959c5499befSdrh       testcase( regFree1==0 );
4960cce7d176Sdrh       break;
4961cce7d176Sdrh     }
4962fef5208cSdrh     case TK_BETWEEN: {
49635c03f30aSdrh       testcase( jumpIfNull==0 );
496471c57db0Sdan       exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfTrue, jumpIfNull);
4965fef5208cSdrh       break;
4966fef5208cSdrh     }
4967bb201344Sshaneh #ifndef SQLITE_OMIT_SUBQUERY
4968e3365e6cSdrh     case TK_IN: {
4969ec4ccdbcSdrh       int destIfFalse = sqlite3VdbeMakeLabel(pParse);
4970e3365e6cSdrh       int destIfNull = jumpIfNull ? dest : destIfFalse;
4971e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
4972076e85f5Sdrh       sqlite3VdbeGoto(v, dest);
4973e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
4974e3365e6cSdrh       break;
4975e3365e6cSdrh     }
4976bb201344Sshaneh #endif
4977cce7d176Sdrh     default: {
49787b35a77bSdan     default_expr:
4979ad31727fSdrh       if( ExprAlwaysTrue(pExpr) ){
4980076e85f5Sdrh         sqlite3VdbeGoto(v, dest);
4981ad31727fSdrh       }else if( ExprAlwaysFalse(pExpr) ){
4982991a1985Sdrh         /* No-op */
4983991a1985Sdrh       }else{
49842dcef11bSdrh         r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
49852dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_If, r1, dest, jumpIfNull!=0);
4986688852abSdrh         VdbeCoverage(v);
4987c5499befSdrh         testcase( regFree1==0 );
4988c5499befSdrh         testcase( jumpIfNull==0 );
4989991a1985Sdrh       }
4990cce7d176Sdrh       break;
4991cce7d176Sdrh     }
4992cce7d176Sdrh   }
49932dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
49942dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
4995cce7d176Sdrh }
4996cce7d176Sdrh 
4997cce7d176Sdrh /*
499866b89c8fSdrh ** Generate code for a boolean expression such that a jump is made
4999cce7d176Sdrh ** to the label "dest" if the expression is false but execution
5000cce7d176Sdrh ** continues straight thru if the expression is true.
5001f5905aa7Sdrh **
5002f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false) then
500335573356Sdrh ** jump if jumpIfNull is SQLITE_JUMPIFNULL or fall through if jumpIfNull
500435573356Sdrh ** is 0.
5005cce7d176Sdrh */
50064adee20fSdanielk1977 void sqlite3ExprIfFalse(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
5007cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
5008cce7d176Sdrh   int op = 0;
50092dcef11bSdrh   int regFree1 = 0;
50102dcef11bSdrh   int regFree2 = 0;
50112dcef11bSdrh   int r1, r2;
50122dcef11bSdrh 
501335573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
501448864df9Smistachkin   if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
501533cd4909Sdrh   if( pExpr==0 )    return;
5016e7375bfaSdrh   assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
5017f2bc013cSdrh 
5018f2bc013cSdrh   /* The value of pExpr->op and op are related as follows:
5019f2bc013cSdrh   **
5020f2bc013cSdrh   **       pExpr->op            op
5021f2bc013cSdrh   **       ---------          ----------
5022f2bc013cSdrh   **       TK_ISNULL          OP_NotNull
5023f2bc013cSdrh   **       TK_NOTNULL         OP_IsNull
5024f2bc013cSdrh   **       TK_NE              OP_Eq
5025f2bc013cSdrh   **       TK_EQ              OP_Ne
5026f2bc013cSdrh   **       TK_GT              OP_Le
5027f2bc013cSdrh   **       TK_LE              OP_Gt
5028f2bc013cSdrh   **       TK_GE              OP_Lt
5029f2bc013cSdrh   **       TK_LT              OP_Ge
5030f2bc013cSdrh   **
5031f2bc013cSdrh   ** For other values of pExpr->op, op is undefined and unused.
5032f2bc013cSdrh   ** The value of TK_ and OP_ constants are arranged such that we
5033f2bc013cSdrh   ** can compute the mapping above using the following expression.
5034f2bc013cSdrh   ** Assert()s verify that the computation is correct.
5035f2bc013cSdrh   */
5036f2bc013cSdrh   op = ((pExpr->op+(TK_ISNULL&1))^1)-(TK_ISNULL&1);
5037f2bc013cSdrh 
5038f2bc013cSdrh   /* Verify correct alignment of TK_ and OP_ constants
5039f2bc013cSdrh   */
5040f2bc013cSdrh   assert( pExpr->op!=TK_ISNULL || op==OP_NotNull );
5041f2bc013cSdrh   assert( pExpr->op!=TK_NOTNULL || op==OP_IsNull );
5042f2bc013cSdrh   assert( pExpr->op!=TK_NE || op==OP_Eq );
5043f2bc013cSdrh   assert( pExpr->op!=TK_EQ || op==OP_Ne );
5044f2bc013cSdrh   assert( pExpr->op!=TK_LT || op==OP_Ge );
5045f2bc013cSdrh   assert( pExpr->op!=TK_LE || op==OP_Gt );
5046f2bc013cSdrh   assert( pExpr->op!=TK_GT || op==OP_Le );
5047f2bc013cSdrh   assert( pExpr->op!=TK_GE || op==OP_Lt );
5048f2bc013cSdrh 
5049ba00e30aSdan   switch( pExpr->op ){
505017180fcaSdrh     case TK_AND:
505117180fcaSdrh     case TK_OR: {
505217180fcaSdrh       Expr *pAlt = sqlite3ExprSimplifiedAndOr(pExpr);
505317180fcaSdrh       if( pAlt!=pExpr ){
505417180fcaSdrh         sqlite3ExprIfFalse(pParse, pAlt, dest, jumpIfNull);
505517180fcaSdrh       }else if( pExpr->op==TK_AND ){
5056c5499befSdrh         testcase( jumpIfNull==0 );
50574adee20fSdanielk1977         sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
50584adee20fSdanielk1977         sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
505917180fcaSdrh       }else{
5060ec4ccdbcSdrh         int d2 = sqlite3VdbeMakeLabel(pParse);
5061c5499befSdrh         testcase( jumpIfNull==0 );
506217180fcaSdrh         sqlite3ExprIfTrue(pParse, pExpr->pLeft, d2,
506317180fcaSdrh                           jumpIfNull^SQLITE_JUMPIFNULL);
50644adee20fSdanielk1977         sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
50654adee20fSdanielk1977         sqlite3VdbeResolveLabel(v, d2);
506617180fcaSdrh       }
5067cce7d176Sdrh       break;
5068cce7d176Sdrh     }
5069cce7d176Sdrh     case TK_NOT: {
50705c03f30aSdrh       testcase( jumpIfNull==0 );
50714adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
5072cce7d176Sdrh       break;
5073cce7d176Sdrh     }
50748abed7b9Sdrh     case TK_TRUTH: {
507596acafbeSdrh       int isNot;   /* IS NOT TRUE or IS NOT FALSE */
507696acafbeSdrh       int isTrue;  /* IS TRUE or IS NOT TRUE */
50778abed7b9Sdrh       testcase( jumpIfNull==0 );
50788abed7b9Sdrh       isNot = pExpr->op2==TK_ISNOT;
507996acafbeSdrh       isTrue = sqlite3ExprTruthValue(pExpr->pRight);
508043c4ac8bSdrh       testcase( isTrue && isNot );
508196acafbeSdrh       testcase( !isTrue && isNot );
508243c4ac8bSdrh       if( isTrue ^ isNot ){
50838abed7b9Sdrh         /* IS TRUE and IS NOT FALSE */
50848abed7b9Sdrh         sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
50858abed7b9Sdrh                            isNot ? 0 : SQLITE_JUMPIFNULL);
50868abed7b9Sdrh 
50878abed7b9Sdrh       }else{
50888abed7b9Sdrh         /* IS FALSE and IS NOT TRUE */
50898abed7b9Sdrh         sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
50908abed7b9Sdrh                           isNot ? 0 : SQLITE_JUMPIFNULL);
50918abed7b9Sdrh       }
5092007c843bSdrh       break;
5093007c843bSdrh     }
5094de845c2fSdrh     case TK_IS:
5095de845c2fSdrh     case TK_ISNOT:
5096de845c2fSdrh       testcase( pExpr->op==TK_IS );
5097de845c2fSdrh       testcase( pExpr->op==TK_ISNOT );
5098de845c2fSdrh       op = (pExpr->op==TK_IS) ? TK_NE : TK_EQ;
5099de845c2fSdrh       jumpIfNull = SQLITE_NULLEQ;
510008b92086Sdrh       /* no break */ deliberate_fall_through
5101cce7d176Sdrh     case TK_LT:
5102cce7d176Sdrh     case TK_LE:
5103cce7d176Sdrh     case TK_GT:
5104cce7d176Sdrh     case TK_GE:
5105cce7d176Sdrh     case TK_NE:
5106cce7d176Sdrh     case TK_EQ: {
5107625015e0Sdan       if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
5108c5499befSdrh       testcase( jumpIfNull==0 );
5109b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
5110b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
511135573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
5112898c527eSdrh                   r1, r2, dest, jumpIfNull,ExprHasProperty(pExpr,EP_Commuted));
51137d176105Sdrh       assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
51147d176105Sdrh       assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
51157d176105Sdrh       assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
51167d176105Sdrh       assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
5117de845c2fSdrh       assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
5118de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
5119de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
5120de845c2fSdrh       assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
5121de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
5122de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
51236a2fe093Sdrh       testcase( regFree1==0 );
51246a2fe093Sdrh       testcase( regFree2==0 );
51256a2fe093Sdrh       break;
51266a2fe093Sdrh     }
5127cce7d176Sdrh     case TK_ISNULL:
5128cce7d176Sdrh     case TK_NOTNULL: {
51292dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
51302dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
51317d176105Sdrh       testcase( op==TK_ISNULL );   VdbeCoverageIf(v, op==TK_ISNULL);
51327d176105Sdrh       testcase( op==TK_NOTNULL );  VdbeCoverageIf(v, op==TK_NOTNULL);
5133c5499befSdrh       testcase( regFree1==0 );
5134cce7d176Sdrh       break;
5135cce7d176Sdrh     }
5136fef5208cSdrh     case TK_BETWEEN: {
51375c03f30aSdrh       testcase( jumpIfNull==0 );
513871c57db0Sdan       exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfFalse, jumpIfNull);
5139fef5208cSdrh       break;
5140fef5208cSdrh     }
5141bb201344Sshaneh #ifndef SQLITE_OMIT_SUBQUERY
5142e3365e6cSdrh     case TK_IN: {
5143e3365e6cSdrh       if( jumpIfNull ){
5144e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, dest);
5145e3365e6cSdrh       }else{
5146ec4ccdbcSdrh         int destIfNull = sqlite3VdbeMakeLabel(pParse);
5147e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, destIfNull);
5148e3365e6cSdrh         sqlite3VdbeResolveLabel(v, destIfNull);
5149e3365e6cSdrh       }
5150e3365e6cSdrh       break;
5151e3365e6cSdrh     }
5152bb201344Sshaneh #endif
5153cce7d176Sdrh     default: {
5154ba00e30aSdan     default_expr:
5155ad31727fSdrh       if( ExprAlwaysFalse(pExpr) ){
5156076e85f5Sdrh         sqlite3VdbeGoto(v, dest);
5157ad31727fSdrh       }else if( ExprAlwaysTrue(pExpr) ){
5158991a1985Sdrh         /* no-op */
5159991a1985Sdrh       }else{
51602dcef11bSdrh         r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
51612dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_IfNot, r1, dest, jumpIfNull!=0);
5162688852abSdrh         VdbeCoverage(v);
5163c5499befSdrh         testcase( regFree1==0 );
5164c5499befSdrh         testcase( jumpIfNull==0 );
5165991a1985Sdrh       }
5166cce7d176Sdrh       break;
5167cce7d176Sdrh     }
5168cce7d176Sdrh   }
51692dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
51702dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
5171cce7d176Sdrh }
51722282792aSdrh 
51732282792aSdrh /*
517472bc8208Sdrh ** Like sqlite3ExprIfFalse() except that a copy is made of pExpr before
517572bc8208Sdrh ** code generation, and that copy is deleted after code generation. This
517672bc8208Sdrh ** ensures that the original pExpr is unchanged.
517772bc8208Sdrh */
517872bc8208Sdrh void sqlite3ExprIfFalseDup(Parse *pParse, Expr *pExpr, int dest,int jumpIfNull){
517972bc8208Sdrh   sqlite3 *db = pParse->db;
518072bc8208Sdrh   Expr *pCopy = sqlite3ExprDup(db, pExpr, 0);
518172bc8208Sdrh   if( db->mallocFailed==0 ){
518272bc8208Sdrh     sqlite3ExprIfFalse(pParse, pCopy, dest, jumpIfNull);
518372bc8208Sdrh   }
518472bc8208Sdrh   sqlite3ExprDelete(db, pCopy);
518572bc8208Sdrh }
518672bc8208Sdrh 
51875aa550cfSdan /*
51885aa550cfSdan ** Expression pVar is guaranteed to be an SQL variable. pExpr may be any
51895aa550cfSdan ** type of expression.
51905aa550cfSdan **
51915aa550cfSdan ** If pExpr is a simple SQL value - an integer, real, string, blob
51925aa550cfSdan ** or NULL value - then the VDBE currently being prepared is configured
51935aa550cfSdan ** to re-prepare each time a new value is bound to variable pVar.
51945aa550cfSdan **
51955aa550cfSdan ** Additionally, if pExpr is a simple SQL value and the value is the
51965aa550cfSdan ** same as that currently bound to variable pVar, non-zero is returned.
51975aa550cfSdan ** Otherwise, if the values are not the same or if pExpr is not a simple
51985aa550cfSdan ** SQL value, zero is returned.
51995aa550cfSdan */
52005aa550cfSdan static int exprCompareVariable(Parse *pParse, Expr *pVar, Expr *pExpr){
52015aa550cfSdan   int res = 0;
5202c0804226Sdrh   int iVar;
5203c0804226Sdrh   sqlite3_value *pL, *pR = 0;
52045aa550cfSdan 
52055aa550cfSdan   sqlite3ValueFromExpr(pParse->db, pExpr, SQLITE_UTF8, SQLITE_AFF_BLOB, &pR);
5206c0804226Sdrh   if( pR ){
5207c0804226Sdrh     iVar = pVar->iColumn;
5208c0804226Sdrh     sqlite3VdbeSetVarmask(pParse->pVdbe, iVar);
5209c0804226Sdrh     pL = sqlite3VdbeGetBoundValue(pParse->pReprepare, iVar, SQLITE_AFF_BLOB);
52105aa307e2Sdrh     if( pL ){
52115aa307e2Sdrh       if( sqlite3_value_type(pL)==SQLITE_TEXT ){
52125aa307e2Sdrh         sqlite3_value_text(pL); /* Make sure the encoding is UTF-8 */
52135aa307e2Sdrh       }
52145aa307e2Sdrh       res =  0==sqlite3MemCompare(pL, pR, 0);
52155aa550cfSdan     }
52165aa550cfSdan     sqlite3ValueFree(pR);
52175aa550cfSdan     sqlite3ValueFree(pL);
52185aa550cfSdan   }
52195aa550cfSdan 
52205aa550cfSdan   return res;
52215aa550cfSdan }
522272bc8208Sdrh 
522372bc8208Sdrh /*
52241d9da70aSdrh ** Do a deep comparison of two expression trees.  Return 0 if the two
52251d9da70aSdrh ** expressions are completely identical.  Return 1 if they differ only
52261d9da70aSdrh ** by a COLLATE operator at the top level.  Return 2 if there are differences
52271d9da70aSdrh ** other than the top-level COLLATE operator.
5228d40aab0eSdrh **
5229619a1305Sdrh ** If any subelement of pB has Expr.iTable==(-1) then it is allowed
5230619a1305Sdrh ** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
5231619a1305Sdrh **
523266518ca7Sdrh ** The pA side might be using TK_REGISTER.  If that is the case and pB is
523366518ca7Sdrh ** not using TK_REGISTER but is otherwise equivalent, then still return 0.
523466518ca7Sdrh **
52351d9da70aSdrh ** Sometimes this routine will return 2 even if the two expressions
5236d40aab0eSdrh ** really are equivalent.  If we cannot prove that the expressions are
52371d9da70aSdrh ** identical, we return 2 just to be safe.  So if this routine
52381d9da70aSdrh ** returns 2, then you do not really know for certain if the two
52391d9da70aSdrh ** expressions are the same.  But if you get a 0 or 1 return, then you
5240d40aab0eSdrh ** can be sure the expressions are the same.  In the places where
52411d9da70aSdrh ** this routine is used, it does not hurt to get an extra 2 - that
5242d40aab0eSdrh ** just might result in some slightly slower code.  But returning
52431d9da70aSdrh ** an incorrect 0 or 1 could lead to a malfunction.
52445aa550cfSdan **
5245c0804226Sdrh ** If pParse is not NULL then TK_VARIABLE terms in pA with bindings in
5246c0804226Sdrh ** pParse->pReprepare can be matched against literals in pB.  The
5247c0804226Sdrh ** pParse->pVdbe->expmask bitmask is updated for each variable referenced.
5248c0804226Sdrh ** If pParse is NULL (the normal case) then any TK_VARIABLE term in
5249c0804226Sdrh ** Argument pParse should normally be NULL. If it is not NULL and pA or
5250c0804226Sdrh ** pB causes a return value of 2.
52512282792aSdrh */
52525aa550cfSdan int sqlite3ExprCompare(Parse *pParse, Expr *pA, Expr *pB, int iTab){
525310d1edf0Sdrh   u32 combinedFlags;
52544b202ae2Sdanielk1977   if( pA==0 || pB==0 ){
52551d9da70aSdrh     return pB==pA ? 0 : 2;
52562282792aSdrh   }
52575aa550cfSdan   if( pParse && pA->op==TK_VARIABLE && exprCompareVariable(pParse, pA, pB) ){
52585aa550cfSdan     return 0;
52595aa550cfSdan   }
526010d1edf0Sdrh   combinedFlags = pA->flags | pB->flags;
526110d1edf0Sdrh   if( combinedFlags & EP_IntValue ){
526210d1edf0Sdrh     if( (pA->flags&pB->flags&EP_IntValue)!=0 && pA->u.iValue==pB->u.iValue ){
526310d1edf0Sdrh       return 0;
526410d1edf0Sdrh     }
52651d9da70aSdrh     return 2;
52666ab3a2ecSdanielk1977   }
526716dd3985Sdan   if( pA->op!=pB->op || pA->op==TK_RAISE ){
52685aa550cfSdan     if( pA->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA->pLeft,pB,iTab)<2 ){
5269ae80ddeaSdrh       return 1;
5270ae80ddeaSdrh     }
52715aa550cfSdan     if( pB->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA,pB->pLeft,iTab)<2 ){
5272ae80ddeaSdrh       return 1;
5273ae80ddeaSdrh     }
5274ae80ddeaSdrh     return 2;
5275ae80ddeaSdrh   }
52762edc5fd7Sdrh   if( pA->op!=TK_COLUMN && pA->op!=TK_AGG_COLUMN && pA->u.zToken ){
52774f9adee2Sdan     if( pA->op==TK_FUNCTION || pA->op==TK_AGG_FUNCTION ){
5278390b88a4Sdrh       if( sqlite3StrICmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
5279eda079cdSdrh #ifndef SQLITE_OMIT_WINDOWFUNC
52804f9adee2Sdan       assert( pA->op==pB->op );
52814f9adee2Sdan       if( ExprHasProperty(pA,EP_WinFunc)!=ExprHasProperty(pB,EP_WinFunc) ){
52824f9adee2Sdan         return 2;
52834f9adee2Sdan       }
5284eda079cdSdrh       if( ExprHasProperty(pA,EP_WinFunc) ){
52854f9adee2Sdan         if( sqlite3WindowCompare(pParse, pA->y.pWin, pB->y.pWin, 1)!=0 ){
52864f9adee2Sdan           return 2;
52874f9adee2Sdan         }
5288eda079cdSdrh       }
5289eda079cdSdrh #endif
5290f20bbc5fSdrh     }else if( pA->op==TK_NULL ){
5291f20bbc5fSdrh       return 0;
5292d5af5420Sdrh     }else if( pA->op==TK_COLLATE ){
5293e79f6299Sdrh       if( sqlite3_stricmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
5294f20bbc5fSdrh     }else if( ALWAYS(pB->u.zToken!=0) && strcmp(pA->u.zToken,pB->u.zToken)!=0 ){
5295d5af5420Sdrh       return 2;
529610d1edf0Sdrh     }
529710d1edf0Sdrh   }
5298898c527eSdrh   if( (pA->flags & (EP_Distinct|EP_Commuted))
5299898c527eSdrh      != (pB->flags & (EP_Distinct|EP_Commuted)) ) return 2;
5300e7375bfaSdrh   if( ALWAYS((combinedFlags & EP_TokenOnly)==0) ){
530110d1edf0Sdrh     if( combinedFlags & EP_xIsSelect ) return 2;
5302efad2e23Sdrh     if( (combinedFlags & EP_FixedCol)==0
5303efad2e23Sdrh      && sqlite3ExprCompare(pParse, pA->pLeft, pB->pLeft, iTab) ) return 2;
53045aa550cfSdan     if( sqlite3ExprCompare(pParse, pA->pRight, pB->pRight, iTab) ) return 2;
5305619a1305Sdrh     if( sqlite3ExprListCompare(pA->x.pList, pB->x.pList, iTab) ) return 2;
530603c5c213Sdrh     if( pA->op!=TK_STRING
530703c5c213Sdrh      && pA->op!=TK_TRUEFALSE
5308e7375bfaSdrh      && ALWAYS((combinedFlags & EP_Reduced)==0)
530903c5c213Sdrh     ){
5310619a1305Sdrh       if( pA->iColumn!=pB->iColumn ) return 2;
53119b258c54Sdrh       if( pA->op2!=pB->op2 && pA->op==TK_TRUTH ) return 2;
53120f28e1bdSdrh       if( pA->op!=TK_IN && pA->iTable!=pB->iTable && pA->iTable!=iTab ){
53130f28e1bdSdrh         return 2;
53140f28e1bdSdrh       }
53151d9da70aSdrh     }
53161d9da70aSdrh   }
53172646da7eSdrh   return 0;
53182646da7eSdrh }
53192282792aSdrh 
53208c6f666bSdrh /*
5321fbb6e9ffSdan ** Compare two ExprList objects.  Return 0 if they are identical, 1
5322fbb6e9ffSdan ** if they are certainly different, or 2 if it is not possible to
5323fbb6e9ffSdan ** determine if they are identical or not.
53248c6f666bSdrh **
5325619a1305Sdrh ** If any subelement of pB has Expr.iTable==(-1) then it is allowed
5326619a1305Sdrh ** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
5327619a1305Sdrh **
53288c6f666bSdrh ** This routine might return non-zero for equivalent ExprLists.  The
53298c6f666bSdrh ** only consequence will be disabled optimizations.  But this routine
53308c6f666bSdrh ** must never return 0 if the two ExprList objects are different, or
53318c6f666bSdrh ** a malfunction will result.
53328c6f666bSdrh **
53338c6f666bSdrh ** Two NULL pointers are considered to be the same.  But a NULL pointer
53348c6f666bSdrh ** always differs from a non-NULL pointer.
53358c6f666bSdrh */
5336619a1305Sdrh int sqlite3ExprListCompare(ExprList *pA, ExprList *pB, int iTab){
53378c6f666bSdrh   int i;
53388c6f666bSdrh   if( pA==0 && pB==0 ) return 0;
53398c6f666bSdrh   if( pA==0 || pB==0 ) return 1;
53408c6f666bSdrh   if( pA->nExpr!=pB->nExpr ) return 1;
53418c6f666bSdrh   for(i=0; i<pA->nExpr; i++){
5342fbb6e9ffSdan     int res;
53438c6f666bSdrh     Expr *pExprA = pA->a[i].pExpr;
53448c6f666bSdrh     Expr *pExprB = pB->a[i].pExpr;
53456e11892dSdan     if( pA->a[i].sortFlags!=pB->a[i].sortFlags ) return 1;
5346fbb6e9ffSdan     if( (res = sqlite3ExprCompare(0, pExprA, pExprB, iTab)) ) return res;
53478c6f666bSdrh   }
53488c6f666bSdrh   return 0;
53498c6f666bSdrh }
535013449892Sdrh 
53512282792aSdrh /*
5352f9463dfbSdrh ** Like sqlite3ExprCompare() except COLLATE operators at the top-level
5353f9463dfbSdrh ** are ignored.
5354f9463dfbSdrh */
5355f9463dfbSdrh int sqlite3ExprCompareSkip(Expr *pA, Expr *pB, int iTab){
53565aa550cfSdan   return sqlite3ExprCompare(0,
53570d950af3Sdrh              sqlite3ExprSkipCollateAndLikely(pA),
53580d950af3Sdrh              sqlite3ExprSkipCollateAndLikely(pB),
5359f9463dfbSdrh              iTab);
5360f9463dfbSdrh }
5361f9463dfbSdrh 
5362f9463dfbSdrh /*
5363c51cf864Sdrh ** Return non-zero if Expr p can only be true if pNN is not NULL.
53647a231b49Sdrh **
53657a231b49Sdrh ** Or if seenNot is true, return non-zero if Expr p can only be
53667a231b49Sdrh ** non-NULL if pNN is not NULL
5367c51cf864Sdrh */
5368c51cf864Sdrh static int exprImpliesNotNull(
5369c51cf864Sdrh   Parse *pParse,      /* Parsing context */
5370c51cf864Sdrh   Expr *p,            /* The expression to be checked */
5371c51cf864Sdrh   Expr *pNN,          /* The expression that is NOT NULL */
5372c51cf864Sdrh   int iTab,           /* Table being evaluated */
53737a231b49Sdrh   int seenNot         /* Return true only if p can be any non-NULL value */
5374c51cf864Sdrh ){
5375c51cf864Sdrh   assert( p );
5376c51cf864Sdrh   assert( pNN );
537714c865e8Sdrh   if( sqlite3ExprCompare(pParse, p, pNN, iTab)==0 ){
537814c865e8Sdrh     return pNN->op!=TK_NULL;
537914c865e8Sdrh   }
5380c51cf864Sdrh   switch( p->op ){
5381c51cf864Sdrh     case TK_IN: {
5382c51cf864Sdrh       if( seenNot && ExprHasProperty(p, EP_xIsSelect) ) return 0;
5383c51cf864Sdrh       assert( ExprHasProperty(p,EP_xIsSelect)
5384c51cf864Sdrh            || (p->x.pList!=0 && p->x.pList->nExpr>0) );
5385ae144a1cSdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
5386c51cf864Sdrh     }
5387c51cf864Sdrh     case TK_BETWEEN: {
5388c51cf864Sdrh       ExprList *pList = p->x.pList;
5389c51cf864Sdrh       assert( pList!=0 );
5390c51cf864Sdrh       assert( pList->nExpr==2 );
5391c51cf864Sdrh       if( seenNot ) return 0;
53927a231b49Sdrh       if( exprImpliesNotNull(pParse, pList->a[0].pExpr, pNN, iTab, 1)
53937a231b49Sdrh        || exprImpliesNotNull(pParse, pList->a[1].pExpr, pNN, iTab, 1)
5394c51cf864Sdrh       ){
5395c51cf864Sdrh         return 1;
5396c51cf864Sdrh       }
53977a231b49Sdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
5398c51cf864Sdrh     }
5399c51cf864Sdrh     case TK_EQ:
5400c51cf864Sdrh     case TK_NE:
5401c51cf864Sdrh     case TK_LT:
5402c51cf864Sdrh     case TK_LE:
5403c51cf864Sdrh     case TK_GT:
5404c51cf864Sdrh     case TK_GE:
5405c51cf864Sdrh     case TK_PLUS:
5406c51cf864Sdrh     case TK_MINUS:
54079d23ea74Sdan     case TK_BITOR:
54089d23ea74Sdan     case TK_LSHIFT:
54099d23ea74Sdan     case TK_RSHIFT:
54109d23ea74Sdan     case TK_CONCAT:
54119d23ea74Sdan       seenNot = 1;
541208b92086Sdrh       /* no break */ deliberate_fall_through
5413c51cf864Sdrh     case TK_STAR:
5414c51cf864Sdrh     case TK_REM:
5415c51cf864Sdrh     case TK_BITAND:
54169d23ea74Sdan     case TK_SLASH: {
5417c51cf864Sdrh       if( exprImpliesNotNull(pParse, p->pRight, pNN, iTab, seenNot) ) return 1;
541808b92086Sdrh       /* no break */ deliberate_fall_through
5419c51cf864Sdrh     }
5420c51cf864Sdrh     case TK_SPAN:
5421c51cf864Sdrh     case TK_COLLATE:
5422c51cf864Sdrh     case TK_UPLUS:
5423c51cf864Sdrh     case TK_UMINUS: {
5424c51cf864Sdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, seenNot);
5425c51cf864Sdrh     }
5426c51cf864Sdrh     case TK_TRUTH: {
5427c51cf864Sdrh       if( seenNot ) return 0;
5428c51cf864Sdrh       if( p->op2!=TK_IS ) return 0;
542938cefc83Sdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
5430c51cf864Sdrh     }
54311cd382e3Sdan     case TK_BITNOT:
5432c51cf864Sdrh     case TK_NOT: {
5433c51cf864Sdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
5434c51cf864Sdrh     }
5435c51cf864Sdrh   }
5436c51cf864Sdrh   return 0;
5437c51cf864Sdrh }
5438c51cf864Sdrh 
5439c51cf864Sdrh /*
54404bd5f73fSdrh ** Return true if we can prove the pE2 will always be true if pE1 is
54414bd5f73fSdrh ** true.  Return false if we cannot complete the proof or if pE2 might
54424bd5f73fSdrh ** be false.  Examples:
54434bd5f73fSdrh **
5444619a1305Sdrh **     pE1: x==5       pE2: x==5             Result: true
54454bd5f73fSdrh **     pE1: x>0        pE2: x==5             Result: false
5446619a1305Sdrh **     pE1: x=21       pE2: x=21 OR y=43     Result: true
54474bd5f73fSdrh **     pE1: x!=123     pE2: x IS NOT NULL    Result: true
5448619a1305Sdrh **     pE1: x!=?1      pE2: x IS NOT NULL    Result: true
5449619a1305Sdrh **     pE1: x IS NULL  pE2: x IS NOT NULL    Result: false
5450619a1305Sdrh **     pE1: x IS ?2    pE2: x IS NOT NULL    Reuslt: false
54514bd5f73fSdrh **
54524bd5f73fSdrh ** When comparing TK_COLUMN nodes between pE1 and pE2, if pE2 has
54534bd5f73fSdrh ** Expr.iTable<0 then assume a table number given by iTab.
54544bd5f73fSdrh **
5455c0804226Sdrh ** If pParse is not NULL, then the values of bound variables in pE1 are
5456c0804226Sdrh ** compared against literal values in pE2 and pParse->pVdbe->expmask is
5457c0804226Sdrh ** modified to record which bound variables are referenced.  If pParse
5458c0804226Sdrh ** is NULL, then false will be returned if pE1 contains any bound variables.
5459c0804226Sdrh **
54604bd5f73fSdrh ** When in doubt, return false.  Returning true might give a performance
54614bd5f73fSdrh ** improvement.  Returning false might cause a performance reduction, but
54624bd5f73fSdrh ** it will always give the correct answer and is hence always safe.
54634bd5f73fSdrh */
54645aa550cfSdan int sqlite3ExprImpliesExpr(Parse *pParse, Expr *pE1, Expr *pE2, int iTab){
54655aa550cfSdan   if( sqlite3ExprCompare(pParse, pE1, pE2, iTab)==0 ){
5466619a1305Sdrh     return 1;
5467619a1305Sdrh   }
5468619a1305Sdrh   if( pE2->op==TK_OR
54695aa550cfSdan    && (sqlite3ExprImpliesExpr(pParse, pE1, pE2->pLeft, iTab)
54705aa550cfSdan              || sqlite3ExprImpliesExpr(pParse, pE1, pE2->pRight, iTab) )
5471619a1305Sdrh   ){
5472619a1305Sdrh     return 1;
5473619a1305Sdrh   }
5474664d6d13Sdrh   if( pE2->op==TK_NOTNULL
5475c51cf864Sdrh    && exprImpliesNotNull(pParse, pE1, pE2->pLeft, iTab, 0)
5476664d6d13Sdrh   ){
5477c51cf864Sdrh     return 1;
5478619a1305Sdrh   }
5479619a1305Sdrh   return 0;
54804bd5f73fSdrh }
54814bd5f73fSdrh 
54824bd5f73fSdrh /*
54836c68d759Sdrh ** This is the Expr node callback for sqlite3ExprImpliesNonNullRow().
54842589787cSdrh ** If the expression node requires that the table at pWalker->iCur
5485f8937f90Sdrh ** have one or more non-NULL column, then set pWalker->eCode to 1 and abort.
5486f8937f90Sdrh **
5487f8937f90Sdrh ** This routine controls an optimization.  False positives (setting
5488f8937f90Sdrh ** pWalker->eCode to 1 when it should not be) are deadly, but false-negatives
5489f8937f90Sdrh ** (never setting pWalker->eCode) is a harmless missed optimization.
54902589787cSdrh */
54912589787cSdrh static int impliesNotNullRow(Walker *pWalker, Expr *pExpr){
5492f8937f90Sdrh   testcase( pExpr->op==TK_AGG_COLUMN );
5493821b610bSdrh   testcase( pExpr->op==TK_AGG_FUNCTION );
54942589787cSdrh   if( ExprHasProperty(pExpr, EP_FromJoin) ) return WRC_Prune;
54952589787cSdrh   switch( pExpr->op ){
54960493222fSdan     case TK_ISNOT:
54972589787cSdrh     case TK_ISNULL:
5498d5793672Sdrh     case TK_NOTNULL:
54992589787cSdrh     case TK_IS:
55002589787cSdrh     case TK_OR:
55016c68d759Sdrh     case TK_VECTOR:
55022c492061Sdrh     case TK_CASE:
5503e3eff266Sdrh     case TK_IN:
55042589787cSdrh     case TK_FUNCTION:
5505da03c1e6Sdan     case TK_TRUTH:
55060493222fSdan       testcase( pExpr->op==TK_ISNOT );
5507821b610bSdrh       testcase( pExpr->op==TK_ISNULL );
5508d5793672Sdrh       testcase( pExpr->op==TK_NOTNULL );
5509821b610bSdrh       testcase( pExpr->op==TK_IS );
5510821b610bSdrh       testcase( pExpr->op==TK_OR );
55116c68d759Sdrh       testcase( pExpr->op==TK_VECTOR );
5512821b610bSdrh       testcase( pExpr->op==TK_CASE );
5513821b610bSdrh       testcase( pExpr->op==TK_IN );
5514821b610bSdrh       testcase( pExpr->op==TK_FUNCTION );
5515da03c1e6Sdan       testcase( pExpr->op==TK_TRUTH );
55162589787cSdrh       return WRC_Prune;
55172589787cSdrh     case TK_COLUMN:
55182589787cSdrh       if( pWalker->u.iCur==pExpr->iTable ){
55192589787cSdrh         pWalker->eCode = 1;
55202589787cSdrh         return WRC_Abort;
55212589787cSdrh       }
55222589787cSdrh       return WRC_Prune;
55239881155dSdrh 
55249d23ea74Sdan     case TK_AND:
5525aef81674Sdrh       if( pWalker->eCode==0 ){
55260287c951Sdan         sqlite3WalkExpr(pWalker, pExpr->pLeft);
55270287c951Sdan         if( pWalker->eCode ){
55280287c951Sdan           pWalker->eCode = 0;
55290287c951Sdan           sqlite3WalkExpr(pWalker, pExpr->pRight);
55309d23ea74Sdan         }
5531aef81674Sdrh       }
55329d23ea74Sdan       return WRC_Prune;
55339d23ea74Sdan 
55349d23ea74Sdan     case TK_BETWEEN:
55351d24a531Sdan       if( sqlite3WalkExpr(pWalker, pExpr->pLeft)==WRC_Abort ){
55361d24a531Sdan         assert( pWalker->eCode );
55371d24a531Sdan         return WRC_Abort;
55381d24a531Sdan       }
55399d23ea74Sdan       return WRC_Prune;
55409d23ea74Sdan 
55419881155dSdrh     /* Virtual tables are allowed to use constraints like x=NULL.  So
55429881155dSdrh     ** a term of the form x=y does not prove that y is not null if x
55439881155dSdrh     ** is the column of a virtual table */
55449881155dSdrh     case TK_EQ:
55459881155dSdrh     case TK_NE:
55469881155dSdrh     case TK_LT:
55479881155dSdrh     case TK_LE:
55489881155dSdrh     case TK_GT:
554978d1d225Sdrh     case TK_GE: {
555078d1d225Sdrh       Expr *pLeft = pExpr->pLeft;
555178d1d225Sdrh       Expr *pRight = pExpr->pRight;
55529881155dSdrh       testcase( pExpr->op==TK_EQ );
55539881155dSdrh       testcase( pExpr->op==TK_NE );
55549881155dSdrh       testcase( pExpr->op==TK_LT );
55559881155dSdrh       testcase( pExpr->op==TK_LE );
55569881155dSdrh       testcase( pExpr->op==TK_GT );
55579881155dSdrh       testcase( pExpr->op==TK_GE );
555878d1d225Sdrh       /* The y.pTab=0 assignment in wherecode.c always happens after the
555978d1d225Sdrh       ** impliesNotNullRow() test */
556078d1d225Sdrh       if( (pLeft->op==TK_COLUMN && ALWAYS(pLeft->y.pTab!=0)
556178d1d225Sdrh                                && IsVirtual(pLeft->y.pTab))
556278d1d225Sdrh        || (pRight->op==TK_COLUMN && ALWAYS(pRight->y.pTab!=0)
556378d1d225Sdrh                                && IsVirtual(pRight->y.pTab))
55649881155dSdrh       ){
55659881155dSdrh         return WRC_Prune;
55669881155dSdrh       }
556708b92086Sdrh       /* no break */ deliberate_fall_through
556878d1d225Sdrh     }
55692589787cSdrh     default:
55702589787cSdrh       return WRC_Continue;
55712589787cSdrh   }
55722589787cSdrh }
55732589787cSdrh 
55742589787cSdrh /*
55752589787cSdrh ** Return true (non-zero) if expression p can only be true if at least
55762589787cSdrh ** one column of table iTab is non-null.  In other words, return true
55772589787cSdrh ** if expression p will always be NULL or false if every column of iTab
55782589787cSdrh ** is NULL.
55792589787cSdrh **
5580821b610bSdrh ** False negatives are acceptable.  In other words, it is ok to return
5581821b610bSdrh ** zero even if expression p will never be true of every column of iTab
5582821b610bSdrh ** is NULL.  A false negative is merely a missed optimization opportunity.
5583821b610bSdrh **
5584821b610bSdrh ** False positives are not allowed, however.  A false positive may result
5585821b610bSdrh ** in an incorrect answer.
5586821b610bSdrh **
55872589787cSdrh ** Terms of p that are marked with EP_FromJoin (and hence that come from
55882589787cSdrh ** the ON or USING clauses of LEFT JOINS) are excluded from the analysis.
55892589787cSdrh **
55902589787cSdrh ** This routine is used to check if a LEFT JOIN can be converted into
55912589787cSdrh ** an ordinary JOIN.  The p argument is the WHERE clause.  If the WHERE
55922589787cSdrh ** clause requires that some column of the right table of the LEFT JOIN
55932589787cSdrh ** be non-NULL, then the LEFT JOIN can be safely converted into an
55942589787cSdrh ** ordinary join.
55952589787cSdrh */
55962589787cSdrh int sqlite3ExprImpliesNonNullRow(Expr *p, int iTab){
55972589787cSdrh   Walker w;
55980d950af3Sdrh   p = sqlite3ExprSkipCollateAndLikely(p);
55994a254f98Sdrh   if( p==0 ) return 0;
56004a254f98Sdrh   if( p->op==TK_NOTNULL ){
5601d6db6598Sdrh     p = p->pLeft;
5602a1698993Sdrh   }else{
5603a1698993Sdrh     while( p->op==TK_AND ){
56044a254f98Sdrh       if( sqlite3ExprImpliesNonNullRow(p->pLeft, iTab) ) return 1;
56054a254f98Sdrh       p = p->pRight;
5606d6db6598Sdrh     }
5607a1698993Sdrh   }
56082589787cSdrh   w.xExprCallback = impliesNotNullRow;
56092589787cSdrh   w.xSelectCallback = 0;
56102589787cSdrh   w.xSelectCallback2 = 0;
56112589787cSdrh   w.eCode = 0;
56122589787cSdrh   w.u.iCur = iTab;
56132589787cSdrh   sqlite3WalkExpr(&w, p);
56142589787cSdrh   return w.eCode;
56152589787cSdrh }
56162589787cSdrh 
56172589787cSdrh /*
5618030796dfSdrh ** An instance of the following structure is used by the tree walker
56192409f8a1Sdrh ** to determine if an expression can be evaluated by reference to the
56202409f8a1Sdrh ** index only, without having to do a search for the corresponding
56212409f8a1Sdrh ** table entry.  The IdxCover.pIdx field is the index.  IdxCover.iCur
56222409f8a1Sdrh ** is the cursor for the table.
56232409f8a1Sdrh */
56242409f8a1Sdrh struct IdxCover {
56252409f8a1Sdrh   Index *pIdx;     /* The index to be tested for coverage */
56262409f8a1Sdrh   int iCur;        /* Cursor number for the table corresponding to the index */
56272409f8a1Sdrh };
56282409f8a1Sdrh 
56292409f8a1Sdrh /*
56302409f8a1Sdrh ** Check to see if there are references to columns in table
56312409f8a1Sdrh ** pWalker->u.pIdxCover->iCur can be satisfied using the index
56322409f8a1Sdrh ** pWalker->u.pIdxCover->pIdx.
56332409f8a1Sdrh */
56342409f8a1Sdrh static int exprIdxCover(Walker *pWalker, Expr *pExpr){
56352409f8a1Sdrh   if( pExpr->op==TK_COLUMN
56362409f8a1Sdrh    && pExpr->iTable==pWalker->u.pIdxCover->iCur
5637b9bcf7caSdrh    && sqlite3TableColumnToIndex(pWalker->u.pIdxCover->pIdx, pExpr->iColumn)<0
56382409f8a1Sdrh   ){
56392409f8a1Sdrh     pWalker->eCode = 1;
56402409f8a1Sdrh     return WRC_Abort;
56412409f8a1Sdrh   }
56422409f8a1Sdrh   return WRC_Continue;
56432409f8a1Sdrh }
56442409f8a1Sdrh 
56452409f8a1Sdrh /*
5646e604ec0bSdrh ** Determine if an index pIdx on table with cursor iCur contains will
5647e604ec0bSdrh ** the expression pExpr.  Return true if the index does cover the
5648e604ec0bSdrh ** expression and false if the pExpr expression references table columns
5649e604ec0bSdrh ** that are not found in the index pIdx.
56502409f8a1Sdrh **
56512409f8a1Sdrh ** An index covering an expression means that the expression can be
56522409f8a1Sdrh ** evaluated using only the index and without having to lookup the
56532409f8a1Sdrh ** corresponding table entry.
56542409f8a1Sdrh */
56552409f8a1Sdrh int sqlite3ExprCoveredByIndex(
56562409f8a1Sdrh   Expr *pExpr,        /* The index to be tested */
56572409f8a1Sdrh   int iCur,           /* The cursor number for the corresponding table */
56582409f8a1Sdrh   Index *pIdx         /* The index that might be used for coverage */
56592409f8a1Sdrh ){
56602409f8a1Sdrh   Walker w;
56612409f8a1Sdrh   struct IdxCover xcov;
56622409f8a1Sdrh   memset(&w, 0, sizeof(w));
56632409f8a1Sdrh   xcov.iCur = iCur;
56642409f8a1Sdrh   xcov.pIdx = pIdx;
56652409f8a1Sdrh   w.xExprCallback = exprIdxCover;
56662409f8a1Sdrh   w.u.pIdxCover = &xcov;
56672409f8a1Sdrh   sqlite3WalkExpr(&w, pExpr);
56682409f8a1Sdrh   return !w.eCode;
56692409f8a1Sdrh }
56702409f8a1Sdrh 
56712409f8a1Sdrh 
56722409f8a1Sdrh /*
56732409f8a1Sdrh ** An instance of the following structure is used by the tree walker
5674030796dfSdrh ** to count references to table columns in the arguments of an
5675ed551b95Sdrh ** aggregate function, in order to implement the
5676ed551b95Sdrh ** sqlite3FunctionThisSrc() routine.
5677374fdce4Sdrh */
5678030796dfSdrh struct SrcCount {
5679030796dfSdrh   SrcList *pSrc;   /* One particular FROM clause in a nested query */
5680ed41a96bSdan   int iSrcInner;   /* Smallest cursor number in this context */
5681030796dfSdrh   int nThis;       /* Number of references to columns in pSrcList */
5682030796dfSdrh   int nOther;      /* Number of references to columns in other FROM clauses */
5683030796dfSdrh };
5684030796dfSdrh 
5685030796dfSdrh /*
5686ed41a96bSdan ** xSelect callback for sqlite3FunctionUsesThisSrc(). If this is the first
5687ed41a96bSdan ** SELECT with a FROM clause encountered during this iteration, set
5688ed41a96bSdan ** SrcCount.iSrcInner to the cursor number of the leftmost object in
5689ed41a96bSdan ** the FROM cause.
5690ed41a96bSdan */
5691ed41a96bSdan static int selectSrcCount(Walker *pWalker, Select *pSel){
5692ed41a96bSdan   struct SrcCount *p = pWalker->u.pSrcCount;
5693bc050b8fSdrh   if( p->iSrcInner==0x7FFFFFFF && ALWAYS(pSel->pSrc) && pSel->pSrc->nSrc ){
5694ed41a96bSdan     pWalker->u.pSrcCount->iSrcInner = pSel->pSrc->a[0].iCursor;
5695ed41a96bSdan   }
5696ed41a96bSdan   return WRC_Continue;
5697ed41a96bSdan }
5698ed41a96bSdan 
5699ed41a96bSdan /*
5700030796dfSdrh ** Count the number of references to columns.
5701030796dfSdrh */
5702030796dfSdrh static int exprSrcCount(Walker *pWalker, Expr *pExpr){
5703b4b36306Sdan   /* There was once a NEVER() on the second term on the grounds that
5704b4b36306Sdan   ** sqlite3FunctionUsesThisSrc() was always called before
5705b4b36306Sdan   ** sqlite3ExprAnalyzeAggregates() and so the TK_COLUMNs have not yet
5706b4b36306Sdan   ** been converted into TK_AGG_COLUMN. But this is no longer true due
5707b4b36306Sdan   ** to window functions - sqlite3WindowRewrite() may now indirectly call
5708b4b36306Sdan   ** FunctionUsesThisSrc() when creating a new sub-select. */
5709b4b36306Sdan   if( pExpr->op==TK_COLUMN || pExpr->op==TK_AGG_COLUMN ){
5710374fdce4Sdrh     int i;
5711030796dfSdrh     struct SrcCount *p = pWalker->u.pSrcCount;
5712030796dfSdrh     SrcList *pSrc = p->pSrc;
5713655814d2Sdrh     int nSrc = pSrc ? pSrc->nSrc : 0;
5714655814d2Sdrh     for(i=0; i<nSrc; i++){
5715030796dfSdrh       if( pExpr->iTable==pSrc->a[i].iCursor ) break;
5716374fdce4Sdrh     }
5717655814d2Sdrh     if( i<nSrc ){
5718030796dfSdrh       p->nThis++;
5719ed41a96bSdan     }else if( pExpr->iTable<p->iSrcInner ){
572080f6bfc0Sdrh       /* In a well-formed parse tree (no name resolution errors),
572135a38e08Sdrh       ** TK_COLUMN nodes with smaller Expr.iTable values are in an
572280f6bfc0Sdrh       ** outer context.  Those are the only ones to count as "other" */
5723030796dfSdrh       p->nOther++;
5724374fdce4Sdrh     }
5725374fdce4Sdrh   }
5726030796dfSdrh   return WRC_Continue;
5727030796dfSdrh }
5728374fdce4Sdrh 
5729374fdce4Sdrh /*
5730030796dfSdrh ** Determine if any of the arguments to the pExpr Function reference
5731030796dfSdrh ** pSrcList.  Return true if they do.  Also return true if the function
5732030796dfSdrh ** has no arguments or has only constant arguments.  Return false if pExpr
5733030796dfSdrh ** references columns but not columns of tables found in pSrcList.
5734374fdce4Sdrh */
5735030796dfSdrh int sqlite3FunctionUsesThisSrc(Expr *pExpr, SrcList *pSrcList){
5736374fdce4Sdrh   Walker w;
5737030796dfSdrh   struct SrcCount cnt;
5738374fdce4Sdrh   assert( pExpr->op==TK_AGG_FUNCTION );
573980f6bfc0Sdrh   memset(&w, 0, sizeof(w));
5740030796dfSdrh   w.xExprCallback = exprSrcCount;
5741ed41a96bSdan   w.xSelectCallback = selectSrcCount;
5742030796dfSdrh   w.u.pSrcCount = &cnt;
5743030796dfSdrh   cnt.pSrc = pSrcList;
5744ed41a96bSdan   cnt.iSrcInner = (pSrcList&&pSrcList->nSrc)?pSrcList->a[0].iCursor:0x7FFFFFFF;
5745030796dfSdrh   cnt.nThis = 0;
5746030796dfSdrh   cnt.nOther = 0;
5747030796dfSdrh   sqlite3WalkExprList(&w, pExpr->x.pList);
57485e484cb3Sdan #ifndef SQLITE_OMIT_WINDOWFUNC
57495e484cb3Sdan   if( ExprHasProperty(pExpr, EP_WinFunc) ){
57505e484cb3Sdan     sqlite3WalkExpr(&w, pExpr->y.pWin->pFilter);
57515e484cb3Sdan   }
57525e484cb3Sdan #endif
5753030796dfSdrh   return cnt.nThis>0 || cnt.nOther==0;
5754374fdce4Sdrh }
5755374fdce4Sdrh 
5756374fdce4Sdrh /*
575789636628Sdrh ** This is a Walker expression node callback.
575889636628Sdrh **
575989636628Sdrh ** For Expr nodes that contain pAggInfo pointers, make sure the AggInfo
576089636628Sdrh ** object that is referenced does not refer directly to the Expr.  If
576189636628Sdrh ** it does, make a copy.  This is done because the pExpr argument is
576289636628Sdrh ** subject to change.
576389636628Sdrh **
576489636628Sdrh ** The copy is stored on pParse->pConstExpr with a register number of 0.
576589636628Sdrh ** This will cause the expression to be deleted automatically when the
576689636628Sdrh ** Parse object is destroyed, but the zero register number means that it
576789636628Sdrh ** will not generate any code in the preamble.
576889636628Sdrh */
576989636628Sdrh static int agginfoPersistExprCb(Walker *pWalker, Expr *pExpr){
57702f82acc0Sdrh   if( ALWAYS(!ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced))
577189636628Sdrh    && pExpr->pAggInfo!=0
577289636628Sdrh   ){
577389636628Sdrh     AggInfo *pAggInfo = pExpr->pAggInfo;
577489636628Sdrh     int iAgg = pExpr->iAgg;
577589636628Sdrh     Parse *pParse = pWalker->pParse;
577689636628Sdrh     sqlite3 *db = pParse->db;
57772f82acc0Sdrh     assert( pExpr->op==TK_AGG_COLUMN || pExpr->op==TK_AGG_FUNCTION );
57782f82acc0Sdrh     if( pExpr->op==TK_AGG_COLUMN ){
577989636628Sdrh       assert( iAgg>=0 && iAgg<pAggInfo->nColumn );
578081185a51Sdrh       if( pAggInfo->aCol[iAgg].pCExpr==pExpr ){
578189636628Sdrh         pExpr = sqlite3ExprDup(db, pExpr, 0);
578289636628Sdrh         if( pExpr ){
578381185a51Sdrh           pAggInfo->aCol[iAgg].pCExpr = pExpr;
578489636628Sdrh           pParse->pConstExpr =
578589636628Sdrh              sqlite3ExprListAppend(pParse, pParse->pConstExpr, pExpr);
578689636628Sdrh         }
578789636628Sdrh       }
578889636628Sdrh     }else{
578989636628Sdrh       assert( iAgg>=0 && iAgg<pAggInfo->nFunc );
579081185a51Sdrh       if( pAggInfo->aFunc[iAgg].pFExpr==pExpr ){
579189636628Sdrh         pExpr = sqlite3ExprDup(db, pExpr, 0);
579289636628Sdrh         if( pExpr ){
579381185a51Sdrh           pAggInfo->aFunc[iAgg].pFExpr = pExpr;
579489636628Sdrh           pParse->pConstExpr =
579589636628Sdrh              sqlite3ExprListAppend(pParse, pParse->pConstExpr, pExpr);
579689636628Sdrh         }
579789636628Sdrh       }
579889636628Sdrh     }
579989636628Sdrh   }
580089636628Sdrh   return WRC_Continue;
580189636628Sdrh }
580289636628Sdrh 
580389636628Sdrh /*
580489636628Sdrh ** Initialize a Walker object so that will persist AggInfo entries referenced
580589636628Sdrh ** by the tree that is walked.
580689636628Sdrh */
580789636628Sdrh void sqlite3AggInfoPersistWalkerInit(Walker *pWalker, Parse *pParse){
580889636628Sdrh   memset(pWalker, 0, sizeof(*pWalker));
580989636628Sdrh   pWalker->pParse = pParse;
581089636628Sdrh   pWalker->xExprCallback = agginfoPersistExprCb;
581189636628Sdrh   pWalker->xSelectCallback = sqlite3SelectWalkNoop;
581289636628Sdrh }
581389636628Sdrh 
581489636628Sdrh /*
581513449892Sdrh ** Add a new element to the pAggInfo->aCol[] array.  Return the index of
581613449892Sdrh ** the new element.  Return a negative number if malloc fails.
58172282792aSdrh */
581817435752Sdrh static int addAggInfoColumn(sqlite3 *db, AggInfo *pInfo){
581913449892Sdrh   int i;
5820cf643729Sdrh   pInfo->aCol = sqlite3ArrayAllocate(
582117435752Sdrh        db,
5822cf643729Sdrh        pInfo->aCol,
5823cf643729Sdrh        sizeof(pInfo->aCol[0]),
5824cf643729Sdrh        &pInfo->nColumn,
5825cf643729Sdrh        &i
5826cf643729Sdrh   );
582713449892Sdrh   return i;
58282282792aSdrh }
582913449892Sdrh 
583013449892Sdrh /*
583113449892Sdrh ** Add a new element to the pAggInfo->aFunc[] array.  Return the index of
583213449892Sdrh ** the new element.  Return a negative number if malloc fails.
583313449892Sdrh */
583417435752Sdrh static int addAggInfoFunc(sqlite3 *db, AggInfo *pInfo){
583513449892Sdrh   int i;
5836cf643729Sdrh   pInfo->aFunc = sqlite3ArrayAllocate(
583717435752Sdrh        db,
5838cf643729Sdrh        pInfo->aFunc,
5839cf643729Sdrh        sizeof(pInfo->aFunc[0]),
5840cf643729Sdrh        &pInfo->nFunc,
5841cf643729Sdrh        &i
5842cf643729Sdrh   );
584313449892Sdrh   return i;
58442282792aSdrh }
58452282792aSdrh 
58462282792aSdrh /*
58477d10d5a6Sdrh ** This is the xExprCallback for a tree walker.  It is used to
58487d10d5a6Sdrh ** implement sqlite3ExprAnalyzeAggregates().  See sqlite3ExprAnalyzeAggregates
5849626a879aSdrh ** for additional information.
58502282792aSdrh */
58517d10d5a6Sdrh static int analyzeAggregate(Walker *pWalker, Expr *pExpr){
58522282792aSdrh   int i;
58537d10d5a6Sdrh   NameContext *pNC = pWalker->u.pNC;
5854a58fdfb1Sdanielk1977   Parse *pParse = pNC->pParse;
5855a58fdfb1Sdanielk1977   SrcList *pSrcList = pNC->pSrcList;
585625c3b8caSdrh   AggInfo *pAggInfo = pNC->uNC.pAggInfo;
585713449892Sdrh 
585825c3b8caSdrh   assert( pNC->ncFlags & NC_UAggInfo );
58592282792aSdrh   switch( pExpr->op ){
586089c69d00Sdrh     case TK_AGG_COLUMN:
5861967e8b73Sdrh     case TK_COLUMN: {
58628b213899Sdrh       testcase( pExpr->op==TK_AGG_COLUMN );
58638b213899Sdrh       testcase( pExpr->op==TK_COLUMN );
586413449892Sdrh       /* Check to see if the column is in one of the tables in the FROM
586513449892Sdrh       ** clause of the aggregate query */
586620bc393cSdrh       if( ALWAYS(pSrcList!=0) ){
58677601294aSdrh         SrcItem *pItem = pSrcList->a;
586813449892Sdrh         for(i=0; i<pSrcList->nSrc; i++, pItem++){
586913449892Sdrh           struct AggInfo_col *pCol;
5870c5cd1249Sdrh           assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
587113449892Sdrh           if( pExpr->iTable==pItem->iCursor ){
587213449892Sdrh             /* If we reach this point, it means that pExpr refers to a table
587313449892Sdrh             ** that is in the FROM clause of the aggregate query.
587413449892Sdrh             **
587513449892Sdrh             ** Make an entry for the column in pAggInfo->aCol[] if there
587613449892Sdrh             ** is not an entry there already.
587713449892Sdrh             */
58787f906d63Sdrh             int k;
587913449892Sdrh             pCol = pAggInfo->aCol;
58807f906d63Sdrh             for(k=0; k<pAggInfo->nColumn; k++, pCol++){
588113449892Sdrh               if( pCol->iTable==pExpr->iTable &&
588213449892Sdrh                   pCol->iColumn==pExpr->iColumn ){
58832282792aSdrh                 break;
58842282792aSdrh               }
58852282792aSdrh             }
58861e536953Sdanielk1977             if( (k>=pAggInfo->nColumn)
58871e536953Sdanielk1977              && (k = addAggInfoColumn(pParse->db, pAggInfo))>=0
58881e536953Sdanielk1977             ){
58897f906d63Sdrh               pCol = &pAggInfo->aCol[k];
5890eda079cdSdrh               pCol->pTab = pExpr->y.pTab;
589113449892Sdrh               pCol->iTable = pExpr->iTable;
589213449892Sdrh               pCol->iColumn = pExpr->iColumn;
58930a07c107Sdrh               pCol->iMem = ++pParse->nMem;
589413449892Sdrh               pCol->iSorterColumn = -1;
589581185a51Sdrh               pCol->pCExpr = pExpr;
589613449892Sdrh               if( pAggInfo->pGroupBy ){
589713449892Sdrh                 int j, n;
589813449892Sdrh                 ExprList *pGB = pAggInfo->pGroupBy;
589913449892Sdrh                 struct ExprList_item *pTerm = pGB->a;
590013449892Sdrh                 n = pGB->nExpr;
590113449892Sdrh                 for(j=0; j<n; j++, pTerm++){
590213449892Sdrh                   Expr *pE = pTerm->pExpr;
590313449892Sdrh                   if( pE->op==TK_COLUMN && pE->iTable==pExpr->iTable &&
590413449892Sdrh                       pE->iColumn==pExpr->iColumn ){
590513449892Sdrh                     pCol->iSorterColumn = j;
590613449892Sdrh                     break;
59072282792aSdrh                   }
590813449892Sdrh                 }
590913449892Sdrh               }
591013449892Sdrh               if( pCol->iSorterColumn<0 ){
591113449892Sdrh                 pCol->iSorterColumn = pAggInfo->nSortingColumn++;
591213449892Sdrh               }
591313449892Sdrh             }
591413449892Sdrh             /* There is now an entry for pExpr in pAggInfo->aCol[] (either
591513449892Sdrh             ** because it was there before or because we just created it).
591613449892Sdrh             ** Convert the pExpr to be a TK_AGG_COLUMN referring to that
591713449892Sdrh             ** pAggInfo->aCol[] entry.
591813449892Sdrh             */
5919ebb6a65dSdrh             ExprSetVVAProperty(pExpr, EP_NoReduce);
592013449892Sdrh             pExpr->pAggInfo = pAggInfo;
592113449892Sdrh             pExpr->op = TK_AGG_COLUMN;
5922cf697396Sshane             pExpr->iAgg = (i16)k;
592313449892Sdrh             break;
592413449892Sdrh           } /* endif pExpr->iTable==pItem->iCursor */
592513449892Sdrh         } /* end loop over pSrcList */
5926a58fdfb1Sdanielk1977       }
59277d10d5a6Sdrh       return WRC_Prune;
59282282792aSdrh     }
59292282792aSdrh     case TK_AGG_FUNCTION: {
59303a8c4be7Sdrh       if( (pNC->ncFlags & NC_InAggFunc)==0
5931ed551b95Sdrh        && pWalker->walkerDepth==pExpr->op2
59323a8c4be7Sdrh       ){
593313449892Sdrh         /* Check to see if pExpr is a duplicate of another aggregate
593413449892Sdrh         ** function that is already in the pAggInfo structure
593513449892Sdrh         */
593613449892Sdrh         struct AggInfo_func *pItem = pAggInfo->aFunc;
593713449892Sdrh         for(i=0; i<pAggInfo->nFunc; i++, pItem++){
593881185a51Sdrh           if( sqlite3ExprCompare(0, pItem->pFExpr, pExpr, -1)==0 ){
59392282792aSdrh             break;
59402282792aSdrh           }
59412282792aSdrh         }
594213449892Sdrh         if( i>=pAggInfo->nFunc ){
594313449892Sdrh           /* pExpr is original.  Make a new entry in pAggInfo->aFunc[]
594413449892Sdrh           */
594514db2665Sdanielk1977           u8 enc = ENC(pParse->db);
59461e536953Sdanielk1977           i = addAggInfoFunc(pParse->db, pAggInfo);
594713449892Sdrh           if( i>=0 ){
59486ab3a2ecSdanielk1977             assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
594913449892Sdrh             pItem = &pAggInfo->aFunc[i];
595081185a51Sdrh             pItem->pFExpr = pExpr;
59510a07c107Sdrh             pItem->iMem = ++pParse->nMem;
595233e619fcSdrh             assert( !ExprHasProperty(pExpr, EP_IntValue) );
595313449892Sdrh             pItem->pFunc = sqlite3FindFunction(pParse->db,
595480738d9cSdrh                    pExpr->u.zToken,
59556ab3a2ecSdanielk1977                    pExpr->x.pList ? pExpr->x.pList->nExpr : 0, enc, 0);
5956fd357974Sdrh             if( pExpr->flags & EP_Distinct ){
5957fd357974Sdrh               pItem->iDistinct = pParse->nTab++;
5958fd357974Sdrh             }else{
5959fd357974Sdrh               pItem->iDistinct = -1;
5960fd357974Sdrh             }
59612282792aSdrh           }
596213449892Sdrh         }
596313449892Sdrh         /* Make pExpr point to the appropriate pAggInfo->aFunc[] entry
596413449892Sdrh         */
5965c5cd1249Sdrh         assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
5966ebb6a65dSdrh         ExprSetVVAProperty(pExpr, EP_NoReduce);
5967cf697396Sshane         pExpr->iAgg = (i16)i;
596813449892Sdrh         pExpr->pAggInfo = pAggInfo;
59693a8c4be7Sdrh         return WRC_Prune;
59706e83a57fSdrh       }else{
59716e83a57fSdrh         return WRC_Continue;
59726e83a57fSdrh       }
59732282792aSdrh     }
5974a58fdfb1Sdanielk1977   }
59757d10d5a6Sdrh   return WRC_Continue;
59767d10d5a6Sdrh }
5977626a879aSdrh 
5978626a879aSdrh /*
5979e8abb4caSdrh ** Analyze the pExpr expression looking for aggregate functions and
5980e8abb4caSdrh ** for variables that need to be added to AggInfo object that pNC->pAggInfo
5981e8abb4caSdrh ** points to.  Additional entries are made on the AggInfo object as
5982e8abb4caSdrh ** necessary.
5983626a879aSdrh **
5984626a879aSdrh ** This routine should only be called after the expression has been
59857d10d5a6Sdrh ** analyzed by sqlite3ResolveExprNames().
5986626a879aSdrh */
5987d2b3e23bSdrh void sqlite3ExprAnalyzeAggregates(NameContext *pNC, Expr *pExpr){
59887d10d5a6Sdrh   Walker w;
59897d10d5a6Sdrh   w.xExprCallback = analyzeAggregate;
5990e40cc16bSdrh   w.xSelectCallback = sqlite3WalkerDepthIncrease;
5991e40cc16bSdrh   w.xSelectCallback2 = sqlite3WalkerDepthDecrease;
5992979dd1beSdrh   w.walkerDepth = 0;
59937d10d5a6Sdrh   w.u.pNC = pNC;
5994d9995031Sdan   w.pParse = 0;
599520bc393cSdrh   assert( pNC->pSrcList!=0 );
59967d10d5a6Sdrh   sqlite3WalkExpr(&w, pExpr);
59972282792aSdrh }
59985d9a4af9Sdrh 
59995d9a4af9Sdrh /*
60005d9a4af9Sdrh ** Call sqlite3ExprAnalyzeAggregates() for every expression in an
60015d9a4af9Sdrh ** expression list.  Return the number of errors.
60025d9a4af9Sdrh **
60035d9a4af9Sdrh ** If an error is found, the analysis is cut short.
60045d9a4af9Sdrh */
6005d2b3e23bSdrh void sqlite3ExprAnalyzeAggList(NameContext *pNC, ExprList *pList){
60065d9a4af9Sdrh   struct ExprList_item *pItem;
60075d9a4af9Sdrh   int i;
60085d9a4af9Sdrh   if( pList ){
6009d2b3e23bSdrh     for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
6010d2b3e23bSdrh       sqlite3ExprAnalyzeAggregates(pNC, pItem->pExpr);
60115d9a4af9Sdrh     }
60125d9a4af9Sdrh   }
60135d9a4af9Sdrh }
6014892d3179Sdrh 
6015892d3179Sdrh /*
6016ceea3321Sdrh ** Allocate a single new register for use to hold some intermediate result.
6017892d3179Sdrh */
6018892d3179Sdrh int sqlite3GetTempReg(Parse *pParse){
6019e55cbd72Sdrh   if( pParse->nTempReg==0 ){
6020892d3179Sdrh     return ++pParse->nMem;
6021892d3179Sdrh   }
60222f425f6bSdanielk1977   return pParse->aTempReg[--pParse->nTempReg];
6023892d3179Sdrh }
6024ceea3321Sdrh 
6025ceea3321Sdrh /*
6026ceea3321Sdrh ** Deallocate a register, making available for reuse for some other
6027ceea3321Sdrh ** purpose.
6028ceea3321Sdrh */
6029892d3179Sdrh void sqlite3ReleaseTempReg(Parse *pParse, int iReg){
603013d79502Sdrh   if( iReg ){
60313aef2fb1Sdrh     sqlite3VdbeReleaseRegisters(pParse, iReg, 1, 0, 0);
603213d79502Sdrh     if( pParse->nTempReg<ArraySize(pParse->aTempReg) ){
6033892d3179Sdrh       pParse->aTempReg[pParse->nTempReg++] = iReg;
6034892d3179Sdrh     }
6035892d3179Sdrh   }
603613d79502Sdrh }
6037892d3179Sdrh 
6038892d3179Sdrh /*
6039ed24da4bSdrh ** Allocate or deallocate a block of nReg consecutive registers.
6040892d3179Sdrh */
6041892d3179Sdrh int sqlite3GetTempRange(Parse *pParse, int nReg){
6042e55cbd72Sdrh   int i, n;
6043ed24da4bSdrh   if( nReg==1 ) return sqlite3GetTempReg(pParse);
6044892d3179Sdrh   i = pParse->iRangeReg;
6045e55cbd72Sdrh   n = pParse->nRangeReg;
6046f49f3523Sdrh   if( nReg<=n ){
6047892d3179Sdrh     pParse->iRangeReg += nReg;
6048892d3179Sdrh     pParse->nRangeReg -= nReg;
6049892d3179Sdrh   }else{
6050892d3179Sdrh     i = pParse->nMem+1;
6051892d3179Sdrh     pParse->nMem += nReg;
6052892d3179Sdrh   }
6053892d3179Sdrh   return i;
6054892d3179Sdrh }
6055892d3179Sdrh void sqlite3ReleaseTempRange(Parse *pParse, int iReg, int nReg){
6056ed24da4bSdrh   if( nReg==1 ){
6057ed24da4bSdrh     sqlite3ReleaseTempReg(pParse, iReg);
6058ed24da4bSdrh     return;
6059ed24da4bSdrh   }
60603aef2fb1Sdrh   sqlite3VdbeReleaseRegisters(pParse, iReg, nReg, 0, 0);
6061892d3179Sdrh   if( nReg>pParse->nRangeReg ){
6062892d3179Sdrh     pParse->nRangeReg = nReg;
6063892d3179Sdrh     pParse->iRangeReg = iReg;
6064892d3179Sdrh   }
6065892d3179Sdrh }
6066cdc69557Sdrh 
6067cdc69557Sdrh /*
6068cdc69557Sdrh ** Mark all temporary registers as being unavailable for reuse.
60696d2566dfSdrh **
60706d2566dfSdrh ** Always invoke this procedure after coding a subroutine or co-routine
60716d2566dfSdrh ** that might be invoked from other parts of the code, to ensure that
60726d2566dfSdrh ** the sub/co-routine does not use registers in common with the code that
60736d2566dfSdrh ** invokes the sub/co-routine.
6074cdc69557Sdrh */
6075cdc69557Sdrh void sqlite3ClearTempRegCache(Parse *pParse){
6076cdc69557Sdrh   pParse->nTempReg = 0;
6077cdc69557Sdrh   pParse->nRangeReg = 0;
6078cdc69557Sdrh }
6079bb9b5f26Sdrh 
6080bb9b5f26Sdrh /*
6081bb9b5f26Sdrh ** Validate that no temporary register falls within the range of
6082bb9b5f26Sdrh ** iFirst..iLast, inclusive.  This routine is only call from within assert()
6083bb9b5f26Sdrh ** statements.
6084bb9b5f26Sdrh */
6085bb9b5f26Sdrh #ifdef SQLITE_DEBUG
6086bb9b5f26Sdrh int sqlite3NoTempsInRange(Parse *pParse, int iFirst, int iLast){
6087bb9b5f26Sdrh   int i;
6088bb9b5f26Sdrh   if( pParse->nRangeReg>0
60893963e584Sdrh    && pParse->iRangeReg+pParse->nRangeReg > iFirst
60903963e584Sdrh    && pParse->iRangeReg <= iLast
6091bb9b5f26Sdrh   ){
6092bb9b5f26Sdrh      return 0;
6093bb9b5f26Sdrh   }
6094bb9b5f26Sdrh   for(i=0; i<pParse->nTempReg; i++){
6095bb9b5f26Sdrh     if( pParse->aTempReg[i]>=iFirst && pParse->aTempReg[i]<=iLast ){
6096bb9b5f26Sdrh       return 0;
6097bb9b5f26Sdrh     }
6098bb9b5f26Sdrh   }
6099bb9b5f26Sdrh   return 1;
6100bb9b5f26Sdrh }
6101bb9b5f26Sdrh #endif /* SQLITE_DEBUG */
6102