xref: /sqlite-3.40.0/src/expr.c (revision 46fe138d)
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;
47*46fe138dSdrh   while( ExprHasProperty(pExpr, EP_Skip|EP_IfNullRow) ){
4807f9e8f4Sdan     assert( pExpr->op==TK_COLLATE || pExpr->op==TK_IF_NULL_ROW );
49a7d6db6aSdrh     pExpr = pExpr->pLeft;
50a7d6db6aSdrh     assert( pExpr!=0 );
51a7d6db6aSdrh   }
52580c8c18Sdrh   op = pExpr->op;
53487e262fSdrh   if( op==TK_SELECT ){
546ab3a2ecSdanielk1977     assert( pExpr->flags&EP_xIsSelect );
556af305deSdrh     assert( pExpr->x.pSelect!=0 );
566af305deSdrh     assert( pExpr->x.pSelect->pEList!=0 );
576af305deSdrh     assert( pExpr->x.pSelect->pEList->a[0].pExpr!=0 );
586ab3a2ecSdanielk1977     return sqlite3ExprAffinity(pExpr->x.pSelect->pEList->a[0].pExpr);
59a37cdde0Sdanielk1977   }
60db45bd5eSdrh   if( op==TK_REGISTER ) op = pExpr->op2;
61487e262fSdrh #ifndef SQLITE_OMIT_CAST
62487e262fSdrh   if( op==TK_CAST ){
6333e619fcSdrh     assert( !ExprHasProperty(pExpr, EP_IntValue) );
64fdaac671Sdrh     return sqlite3AffinityType(pExpr->u.zToken, 0);
65487e262fSdrh   }
66487e262fSdrh #endif
67eda079cdSdrh   if( (op==TK_AGG_COLUMN || op==TK_COLUMN) && pExpr->y.pTab ){
68eda079cdSdrh     return sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
697d10d5a6Sdrh   }
7080aa5453Sdan   if( op==TK_SELECT_COLUMN ){
7180aa5453Sdan     assert( pExpr->pLeft->flags&EP_xIsSelect );
7280aa5453Sdan     return sqlite3ExprAffinity(
7380aa5453Sdan         pExpr->pLeft->x.pSelect->pEList->a[pExpr->iColumn].pExpr
7480aa5453Sdan     );
7580aa5453Sdan   }
76db36e255Sdrh   if( op==TK_VECTOR ){
77db36e255Sdrh     return sqlite3ExprAffinity(pExpr->x.pList->a[0].pExpr);
78db36e255Sdrh   }
791194904bSdrh   return pExpr->affExpr;
80a37cdde0Sdanielk1977 }
81a37cdde0Sdanielk1977 
8253db1458Sdrh /*
838b4c40d8Sdrh ** Set the collating sequence for expression pExpr to be the collating
84ae80ddeaSdrh ** sequence named by pToken.   Return a pointer to a new Expr node that
85ae80ddeaSdrh ** implements the COLLATE operator.
860a8a406eSdrh **
870a8a406eSdrh ** If a memory allocation error occurs, that fact is recorded in pParse->db
880a8a406eSdrh ** and the pExpr parameter is returned unchanged.
898b4c40d8Sdrh */
904ef7efadSdrh Expr *sqlite3ExprAddCollateToken(
914ef7efadSdrh   Parse *pParse,           /* Parsing context */
924ef7efadSdrh   Expr *pExpr,             /* Add the "COLLATE" clause to this expression */
9380103fc6Sdan   const Token *pCollName,  /* Name of collating sequence */
9480103fc6Sdan   int dequote              /* True to dequote pCollName */
954ef7efadSdrh ){
960a8a406eSdrh   if( pCollName->n>0 ){
9780103fc6Sdan     Expr *pNew = sqlite3ExprAlloc(pParse->db, TK_COLLATE, pCollName, dequote);
98ae80ddeaSdrh     if( pNew ){
99ae80ddeaSdrh       pNew->pLeft = pExpr;
100a4c3c87eSdrh       pNew->flags |= EP_Collate|EP_Skip;
1010a8a406eSdrh       pExpr = pNew;
102ae80ddeaSdrh     }
1030a8a406eSdrh   }
1040a8a406eSdrh   return pExpr;
1050a8a406eSdrh }
1060a8a406eSdrh Expr *sqlite3ExprAddCollateString(Parse *pParse, Expr *pExpr, const char *zC){
1070a8a406eSdrh   Token s;
108261d8a51Sdrh   assert( zC!=0 );
10940aced5cSdrh   sqlite3TokenInit(&s, (char*)zC);
11080103fc6Sdan   return sqlite3ExprAddCollateToken(pParse, pExpr, &s, 0);
1110a8a406eSdrh }
1120a8a406eSdrh 
1130a8a406eSdrh /*
1140d950af3Sdrh ** Skip over any TK_COLLATE operators.
1150a8a406eSdrh */
1160a8a406eSdrh Expr *sqlite3ExprSkipCollate(Expr *pExpr){
1170d950af3Sdrh   while( pExpr && ExprHasProperty(pExpr, EP_Skip) ){
118*46fe138dSdrh     assert( pExpr->op==TK_COLLATE );
1190d950af3Sdrh     pExpr = pExpr->pLeft;
1200d950af3Sdrh   }
1210d950af3Sdrh   return pExpr;
1220d950af3Sdrh }
1230d950af3Sdrh 
1240d950af3Sdrh /*
1250d950af3Sdrh ** Skip over any TK_COLLATE operators and/or any unlikely()
1260d950af3Sdrh ** or likelihood() or likely() functions at the root of an
1270d950af3Sdrh ** expression.
1280d950af3Sdrh */
1290d950af3Sdrh Expr *sqlite3ExprSkipCollateAndLikely(Expr *pExpr){
130a7d6db6aSdrh   while( pExpr && ExprHasProperty(pExpr, EP_Skip|EP_Unlikely) ){
131a4c3c87eSdrh     if( ExprHasProperty(pExpr, EP_Unlikely) ){
132cca9f3d2Sdrh       assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
133cca9f3d2Sdrh       assert( pExpr->x.pList->nExpr>0 );
134a4c3c87eSdrh       assert( pExpr->op==TK_FUNCTION );
135cca9f3d2Sdrh       pExpr = pExpr->x.pList->a[0].pExpr;
136cca9f3d2Sdrh     }else{
137*46fe138dSdrh       assert( pExpr->op==TK_COLLATE );
138d91eba96Sdrh       pExpr = pExpr->pLeft;
139cca9f3d2Sdrh     }
140d91eba96Sdrh   }
1410a8a406eSdrh   return pExpr;
1428b4c40d8Sdrh }
1438b4c40d8Sdrh 
1448b4c40d8Sdrh /*
145ae80ddeaSdrh ** Return the collation sequence for the expression pExpr. If
146ae80ddeaSdrh ** there is no defined collating sequence, return NULL.
147ae80ddeaSdrh **
14870efa84dSdrh ** See also: sqlite3ExprNNCollSeq()
14970efa84dSdrh **
15070efa84dSdrh ** The sqlite3ExprNNCollSeq() works the same exact that it returns the
15170efa84dSdrh ** default collation if pExpr has no defined collation.
15270efa84dSdrh **
153ae80ddeaSdrh ** The collating sequence might be determined by a COLLATE operator
154ae80ddeaSdrh ** or by the presence of a column with a defined collating sequence.
155ae80ddeaSdrh ** COLLATE operators take first precedence.  Left operands take
156ae80ddeaSdrh ** precedence over right operands.
1570202b29eSdanielk1977 */
158e7375bfaSdrh CollSeq *sqlite3ExprCollSeq(Parse *pParse, const Expr *pExpr){
159ae80ddeaSdrh   sqlite3 *db = pParse->db;
1607cedc8d4Sdanielk1977   CollSeq *pColl = 0;
161e7375bfaSdrh   const Expr *p = pExpr;
162261d8a51Sdrh   while( p ){
163ae80ddeaSdrh     int op = p->op;
164cb0e04f9Sdrh     if( op==TK_REGISTER ) op = p->op2;
165cb0e04f9Sdrh     if( (op==TK_AGG_COLUMN || op==TK_COLUMN || op==TK_TRIGGER)
166eda079cdSdrh      && p->y.pTab!=0
167ae80ddeaSdrh     ){
168eda079cdSdrh       /* op==TK_REGISTER && p->y.pTab!=0 happens when pExpr was originally
1697d10d5a6Sdrh       ** a TK_COLUMN but was previously evaluated and cached in a register */
1707d10d5a6Sdrh       int j = p->iColumn;
1717d10d5a6Sdrh       if( j>=0 ){
172eda079cdSdrh         const char *zColl = p->y.pTab->aCol[j].zColl;
173c4a64facSdrh         pColl = sqlite3FindCollSeq(db, ENC(db), zColl, 0);
1740202b29eSdanielk1977       }
1757d10d5a6Sdrh       break;
1767d10d5a6Sdrh     }
177e081d73cSdrh     if( op==TK_CAST || op==TK_UPLUS ){
178e081d73cSdrh       p = p->pLeft;
179e081d73cSdrh       continue;
180e081d73cSdrh     }
181269d322dSdrh     if( op==TK_VECTOR ){
182269d322dSdrh       p = p->x.pList->a[0].pExpr;
183269d322dSdrh       continue;
184269d322dSdrh     }
185cb0e04f9Sdrh     if( op==TK_COLLATE ){
186e081d73cSdrh       pColl = sqlite3GetCollSeq(pParse, ENC(db), 0, p->u.zToken);
187e081d73cSdrh       break;
188e081d73cSdrh     }
189ae80ddeaSdrh     if( p->flags & EP_Collate ){
1902308ed38Sdrh       if( p->pLeft && (p->pLeft->flags & EP_Collate)!=0 ){
1917d10d5a6Sdrh         p = p->pLeft;
192ae80ddeaSdrh       }else{
1932308ed38Sdrh         Expr *pNext  = p->pRight;
1946728cd91Sdrh         /* The Expr.x union is never used at the same time as Expr.pRight */
1956728cd91Sdrh         assert( p->x.pList==0 || p->pRight==0 );
19692a2824cSdrh         if( p->x.pList!=0
19792a2824cSdrh          && !db->mallocFailed
19892a2824cSdrh          && ALWAYS(!ExprHasProperty(p, EP_xIsSelect))
19992a2824cSdrh         ){
2002308ed38Sdrh           int i;
2015b107654Sdrh           for(i=0; ALWAYS(i<p->x.pList->nExpr); i++){
2022308ed38Sdrh             if( ExprHasProperty(p->x.pList->a[i].pExpr, EP_Collate) ){
2032308ed38Sdrh               pNext = p->x.pList->a[i].pExpr;
2042308ed38Sdrh               break;
2052308ed38Sdrh             }
2062308ed38Sdrh           }
2072308ed38Sdrh         }
2082308ed38Sdrh         p = pNext;
209ae80ddeaSdrh       }
210ae80ddeaSdrh     }else{
211ae80ddeaSdrh       break;
212ae80ddeaSdrh     }
2130202b29eSdanielk1977   }
2147cedc8d4Sdanielk1977   if( sqlite3CheckCollSeq(pParse, pColl) ){
2157cedc8d4Sdanielk1977     pColl = 0;
2167cedc8d4Sdanielk1977   }
2177cedc8d4Sdanielk1977   return pColl;
2180202b29eSdanielk1977 }
2190202b29eSdanielk1977 
2200202b29eSdanielk1977 /*
22170efa84dSdrh ** Return the collation sequence for the expression pExpr. If
22270efa84dSdrh ** there is no defined collating sequence, return a pointer to the
22370efa84dSdrh ** defautl collation sequence.
22470efa84dSdrh **
22570efa84dSdrh ** See also: sqlite3ExprCollSeq()
22670efa84dSdrh **
22770efa84dSdrh ** The sqlite3ExprCollSeq() routine works the same except that it
22870efa84dSdrh ** returns NULL if there is no defined collation.
22970efa84dSdrh */
230e7375bfaSdrh CollSeq *sqlite3ExprNNCollSeq(Parse *pParse, const Expr *pExpr){
23170efa84dSdrh   CollSeq *p = sqlite3ExprCollSeq(pParse, pExpr);
23270efa84dSdrh   if( p==0 ) p = pParse->db->pDfltColl;
23370efa84dSdrh   assert( p!=0 );
23470efa84dSdrh   return p;
23570efa84dSdrh }
23670efa84dSdrh 
23770efa84dSdrh /*
23870efa84dSdrh ** Return TRUE if the two expressions have equivalent collating sequences.
23970efa84dSdrh */
240e7375bfaSdrh int sqlite3ExprCollSeqMatch(Parse *pParse, const Expr *pE1, const Expr *pE2){
24170efa84dSdrh   CollSeq *pColl1 = sqlite3ExprNNCollSeq(pParse, pE1);
24270efa84dSdrh   CollSeq *pColl2 = sqlite3ExprNNCollSeq(pParse, pE2);
24370efa84dSdrh   return sqlite3StrICmp(pColl1->zName, pColl2->zName)==0;
24470efa84dSdrh }
24570efa84dSdrh 
24670efa84dSdrh /*
247626a879aSdrh ** pExpr is an operand of a comparison operator.  aff2 is the
248626a879aSdrh ** type affinity of the other operand.  This routine returns the
24953db1458Sdrh ** type affinity that should be used for the comparison operator.
25053db1458Sdrh */
251e7375bfaSdrh char sqlite3CompareAffinity(const Expr *pExpr, char aff2){
252bf3b721fSdanielk1977   char aff1 = sqlite3ExprAffinity(pExpr);
25396fb16eeSdrh   if( aff1>SQLITE_AFF_NONE && aff2>SQLITE_AFF_NONE ){
2548df447f0Sdrh     /* Both sides of the comparison are columns. If one has numeric
2558df447f0Sdrh     ** affinity, use that. Otherwise use no affinity.
256e014a838Sdanielk1977     */
2578a51256cSdrh     if( sqlite3IsNumericAffinity(aff1) || sqlite3IsNumericAffinity(aff2) ){
258e014a838Sdanielk1977       return SQLITE_AFF_NUMERIC;
259e014a838Sdanielk1977     }else{
26005883a34Sdrh       return SQLITE_AFF_BLOB;
261e014a838Sdanielk1977     }
262e014a838Sdanielk1977   }else{
263e014a838Sdanielk1977     /* One side is a column, the other is not. Use the columns affinity. */
26496fb16eeSdrh     assert( aff1<=SQLITE_AFF_NONE || aff2<=SQLITE_AFF_NONE );
26596fb16eeSdrh     return (aff1<=SQLITE_AFF_NONE ? aff2 : aff1) | SQLITE_AFF_NONE;
266e014a838Sdanielk1977   }
267e014a838Sdanielk1977 }
268e014a838Sdanielk1977 
26953db1458Sdrh /*
27053db1458Sdrh ** pExpr is a comparison operator.  Return the type affinity that should
27153db1458Sdrh ** be applied to both operands prior to doing the comparison.
27253db1458Sdrh */
273e7375bfaSdrh static char comparisonAffinity(const Expr *pExpr){
274e014a838Sdanielk1977   char aff;
275e014a838Sdanielk1977   assert( pExpr->op==TK_EQ || pExpr->op==TK_IN || pExpr->op==TK_LT ||
276e014a838Sdanielk1977           pExpr->op==TK_GT || pExpr->op==TK_GE || pExpr->op==TK_LE ||
2776a2fe093Sdrh           pExpr->op==TK_NE || pExpr->op==TK_IS || pExpr->op==TK_ISNOT );
278e014a838Sdanielk1977   assert( pExpr->pLeft );
279bf3b721fSdanielk1977   aff = sqlite3ExprAffinity(pExpr->pLeft);
280e014a838Sdanielk1977   if( pExpr->pRight ){
281e014a838Sdanielk1977     aff = sqlite3CompareAffinity(pExpr->pRight, aff);
2826ab3a2ecSdanielk1977   }else if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2836ab3a2ecSdanielk1977     aff = sqlite3CompareAffinity(pExpr->x.pSelect->pEList->a[0].pExpr, aff);
28413ac46eeSdrh   }else if( aff==0 ){
28505883a34Sdrh     aff = SQLITE_AFF_BLOB;
286e014a838Sdanielk1977   }
287e014a838Sdanielk1977   return aff;
288e014a838Sdanielk1977 }
289e014a838Sdanielk1977 
290e014a838Sdanielk1977 /*
291e014a838Sdanielk1977 ** pExpr is a comparison expression, eg. '=', '<', IN(...) etc.
292e014a838Sdanielk1977 ** idx_affinity is the affinity of an indexed column. Return true
293e014a838Sdanielk1977 ** if the index with affinity idx_affinity may be used to implement
294e014a838Sdanielk1977 ** the comparison in pExpr.
295e014a838Sdanielk1977 */
296e7375bfaSdrh int sqlite3IndexAffinityOk(const Expr *pExpr, char idx_affinity){
297e014a838Sdanielk1977   char aff = comparisonAffinity(pExpr);
298915e434cSdrh   if( aff<SQLITE_AFF_TEXT ){
2998a51256cSdrh     return 1;
3008a51256cSdrh   }
301915e434cSdrh   if( aff==SQLITE_AFF_TEXT ){
302915e434cSdrh     return idx_affinity==SQLITE_AFF_TEXT;
303915e434cSdrh   }
304915e434cSdrh   return sqlite3IsNumericAffinity(idx_affinity);
305e014a838Sdanielk1977 }
306e014a838Sdanielk1977 
307a37cdde0Sdanielk1977 /*
30835573356Sdrh ** Return the P5 value that should be used for a binary comparison
309a37cdde0Sdanielk1977 ** opcode (OP_Eq, OP_Ge etc.) used to compare pExpr1 and pExpr2.
310a37cdde0Sdanielk1977 */
311e7375bfaSdrh static u8 binaryCompareP5(
312e7375bfaSdrh   const Expr *pExpr1,   /* Left operand */
313e7375bfaSdrh   const Expr *pExpr2,   /* Right operand */
314e7375bfaSdrh   int jumpIfNull        /* Extra flags added to P5 */
315e7375bfaSdrh ){
31635573356Sdrh   u8 aff = (char)sqlite3ExprAffinity(pExpr2);
3171bd10f8aSdrh   aff = (u8)sqlite3CompareAffinity(pExpr1, aff) | (u8)jumpIfNull;
31835573356Sdrh   return aff;
319a37cdde0Sdanielk1977 }
320a37cdde0Sdanielk1977 
321a2e00042Sdrh /*
3220202b29eSdanielk1977 ** Return a pointer to the collation sequence that should be used by
3230202b29eSdanielk1977 ** a binary comparison operator comparing pLeft and pRight.
3240202b29eSdanielk1977 **
3250202b29eSdanielk1977 ** If the left hand expression has a collating sequence type, then it is
3260202b29eSdanielk1977 ** used. Otherwise the collation sequence for the right hand expression
3270202b29eSdanielk1977 ** is used, or the default (BINARY) if neither expression has a collating
3280202b29eSdanielk1977 ** type.
329bcbb04e5Sdanielk1977 **
330bcbb04e5Sdanielk1977 ** Argument pRight (but not pLeft) may be a null pointer. In this case,
331bcbb04e5Sdanielk1977 ** it is not considered.
3320202b29eSdanielk1977 */
333bcbb04e5Sdanielk1977 CollSeq *sqlite3BinaryCompareCollSeq(
334bcbb04e5Sdanielk1977   Parse *pParse,
335e7375bfaSdrh   const Expr *pLeft,
336e7375bfaSdrh   const Expr *pRight
337bcbb04e5Sdanielk1977 ){
338ec41ddacSdrh   CollSeq *pColl;
339ec41ddacSdrh   assert( pLeft );
340ae80ddeaSdrh   if( pLeft->flags & EP_Collate ){
341ae80ddeaSdrh     pColl = sqlite3ExprCollSeq(pParse, pLeft);
342ae80ddeaSdrh   }else if( pRight && (pRight->flags & EP_Collate)!=0 ){
343ae80ddeaSdrh     pColl = sqlite3ExprCollSeq(pParse, pRight);
344ec41ddacSdrh   }else{
345ec41ddacSdrh     pColl = sqlite3ExprCollSeq(pParse, pLeft);
3460202b29eSdanielk1977     if( !pColl ){
3477cedc8d4Sdanielk1977       pColl = sqlite3ExprCollSeq(pParse, pRight);
3480202b29eSdanielk1977     }
349ec41ddacSdrh   }
3500202b29eSdanielk1977   return pColl;
3510202b29eSdanielk1977 }
3520202b29eSdanielk1977 
353898c527eSdrh /* Expresssion p is a comparison operator.  Return a collation sequence
354898c527eSdrh ** appropriate for the comparison operator.
355898c527eSdrh **
356898c527eSdrh ** This is normally just a wrapper around sqlite3BinaryCompareCollSeq().
357898c527eSdrh ** However, if the OP_Commuted flag is set, then the order of the operands
358898c527eSdrh ** is reversed in the sqlite3BinaryCompareCollSeq() call so that the
359898c527eSdrh ** correct collating sequence is found.
360898c527eSdrh */
361e7375bfaSdrh CollSeq *sqlite3ExprCompareCollSeq(Parse *pParse, const Expr *p){
362898c527eSdrh   if( ExprHasProperty(p, EP_Commuted) ){
363898c527eSdrh     return sqlite3BinaryCompareCollSeq(pParse, p->pRight, p->pLeft);
364898c527eSdrh   }else{
365898c527eSdrh     return sqlite3BinaryCompareCollSeq(pParse, p->pLeft, p->pRight);
366898c527eSdrh   }
367898c527eSdrh }
368898c527eSdrh 
3690202b29eSdanielk1977 /*
370be5c89acSdrh ** Generate code for a comparison operator.
371be5c89acSdrh */
372be5c89acSdrh static int codeCompare(
373be5c89acSdrh   Parse *pParse,    /* The parsing (and code generating) context */
374be5c89acSdrh   Expr *pLeft,      /* The left operand */
375be5c89acSdrh   Expr *pRight,     /* The right operand */
376be5c89acSdrh   int opcode,       /* The comparison opcode */
37735573356Sdrh   int in1, int in2, /* Register holding operands */
378be5c89acSdrh   int dest,         /* Jump here if true.  */
379898c527eSdrh   int jumpIfNull,   /* If true, jump if either operand is NULL */
380898c527eSdrh   int isCommuted    /* The comparison has been commuted */
381be5c89acSdrh ){
38235573356Sdrh   int p5;
38335573356Sdrh   int addr;
38435573356Sdrh   CollSeq *p4;
38535573356Sdrh 
3868654186bSdrh   if( pParse->nErr ) return 0;
387898c527eSdrh   if( isCommuted ){
388898c527eSdrh     p4 = sqlite3BinaryCompareCollSeq(pParse, pRight, pLeft);
389898c527eSdrh   }else{
39035573356Sdrh     p4 = sqlite3BinaryCompareCollSeq(pParse, pLeft, pRight);
391898c527eSdrh   }
39235573356Sdrh   p5 = binaryCompareP5(pLeft, pRight, jumpIfNull);
39335573356Sdrh   addr = sqlite3VdbeAddOp4(pParse->pVdbe, opcode, in2, dest, in1,
39435573356Sdrh                            (void*)p4, P4_COLLSEQ);
3951bd10f8aSdrh   sqlite3VdbeChangeP5(pParse->pVdbe, (u8)p5);
39635573356Sdrh   return addr;
397be5c89acSdrh }
398be5c89acSdrh 
399cfbb5e82Sdan /*
400870a0705Sdan ** Return true if expression pExpr is a vector, or false otherwise.
401d832da7fSdrh **
402d832da7fSdrh ** A vector is defined as any expression that results in two or more
403d832da7fSdrh ** columns of result.  Every TK_VECTOR node is an vector because the
404d832da7fSdrh ** parser will not generate a TK_VECTOR with fewer than two entries.
405d832da7fSdrh ** But a TK_SELECT might be either a vector or a scalar. It is only
406d832da7fSdrh ** considered a vector if it has two or more result columns.
407870a0705Sdan */
408870a0705Sdan int sqlite3ExprIsVector(Expr *pExpr){
40976dbe7a8Sdrh   return sqlite3ExprVectorSize(pExpr)>1;
410870a0705Sdan }
411870a0705Sdan 
412870a0705Sdan /*
413cfbb5e82Sdan ** If the expression passed as the only argument is of type TK_VECTOR
414cfbb5e82Sdan ** return the number of expressions in the vector. Or, if the expression
415cfbb5e82Sdan ** is a sub-select, return the number of columns in the sub-select. For
416cfbb5e82Sdan ** any other type of expression, return 1.
417cfbb5e82Sdan */
41871c57db0Sdan int sqlite3ExprVectorSize(Expr *pExpr){
41912abf408Sdrh   u8 op = pExpr->op;
42012abf408Sdrh   if( op==TK_REGISTER ) op = pExpr->op2;
42112abf408Sdrh   if( op==TK_VECTOR ){
42271c57db0Sdan     return pExpr->x.pList->nExpr;
42312abf408Sdrh   }else if( op==TK_SELECT ){
42476dbe7a8Sdrh     return pExpr->x.pSelect->pEList->nExpr;
42576dbe7a8Sdrh   }else{
42676dbe7a8Sdrh     return 1;
42776dbe7a8Sdrh   }
42871c57db0Sdan }
42971c57db0Sdan 
430ba00e30aSdan /*
431fc7f27b9Sdrh ** Return a pointer to a subexpression of pVector that is the i-th
432fc7f27b9Sdrh ** column of the vector (numbered starting with 0).  The caller must
433fc7f27b9Sdrh ** ensure that i is within range.
434fc7f27b9Sdrh **
43576dbe7a8Sdrh ** If pVector is really a scalar (and "scalar" here includes subqueries
43676dbe7a8Sdrh ** that return a single column!) then return pVector unmodified.
43776dbe7a8Sdrh **
438fc7f27b9Sdrh ** pVector retains ownership of the returned subexpression.
439fc7f27b9Sdrh **
440fc7f27b9Sdrh ** If the vector is a (SELECT ...) then the expression returned is
44176dbe7a8Sdrh ** just the expression for the i-th term of the result set, and may
44276dbe7a8Sdrh ** not be ready for evaluation because the table cursor has not yet
44376dbe7a8Sdrh ** been positioned.
444ba00e30aSdan */
445fc7f27b9Sdrh Expr *sqlite3VectorFieldSubexpr(Expr *pVector, int i){
446870a0705Sdan   assert( i<sqlite3ExprVectorSize(pVector) );
447870a0705Sdan   if( sqlite3ExprIsVector(pVector) ){
4489f24b53dSdrh     assert( pVector->op2==0 || pVector->op==TK_REGISTER );
4499f24b53dSdrh     if( pVector->op==TK_SELECT || pVector->op2==TK_SELECT ){
45071c57db0Sdan       return pVector->x.pSelect->pEList->a[i].pExpr;
451870a0705Sdan     }else{
45271c57db0Sdan       return pVector->x.pList->a[i].pExpr;
45371c57db0Sdan     }
454870a0705Sdan   }
455870a0705Sdan   return pVector;
456870a0705Sdan }
457fc7f27b9Sdrh 
458fc7f27b9Sdrh /*
459fc7f27b9Sdrh ** Compute and return a new Expr object which when passed to
460fc7f27b9Sdrh ** sqlite3ExprCode() will generate all necessary code to compute
461fc7f27b9Sdrh ** the iField-th column of the vector expression pVector.
462fc7f27b9Sdrh **
4638762ec19Sdrh ** It is ok for pVector to be a scalar (as long as iField==0).
4648762ec19Sdrh ** In that case, this routine works like sqlite3ExprDup().
4658762ec19Sdrh **
466fc7f27b9Sdrh ** The caller owns the returned Expr object and is responsible for
467fc7f27b9Sdrh ** ensuring that the returned value eventually gets freed.
468fc7f27b9Sdrh **
4698762ec19Sdrh ** The caller retains ownership of pVector.  If pVector is a TK_SELECT,
470fad0e70cSdan ** then the returned object will reference pVector and so pVector must remain
4718762ec19Sdrh ** valid for the life of the returned object.  If pVector is a TK_VECTOR
4728762ec19Sdrh ** or a scalar expression, then it can be deleted as soon as this routine
47376dbe7a8Sdrh ** returns.
4748762ec19Sdrh **
4758762ec19Sdrh ** A trick to cause a TK_SELECT pVector to be deleted together with
4768762ec19Sdrh ** the returned Expr object is to attach the pVector to the pRight field
4778762ec19Sdrh ** of the returned TK_SELECT_COLUMN Expr object.
478fc7f27b9Sdrh */
479fc7f27b9Sdrh Expr *sqlite3ExprForVectorField(
480fc7f27b9Sdrh   Parse *pParse,       /* Parsing context */
481fc7f27b9Sdrh   Expr *pVector,       /* The vector.  List of expressions or a sub-SELECT */
482a1251bc4Sdrh   int iField           /* Which column of the vector to return */
483fc7f27b9Sdrh ){
484fc7f27b9Sdrh   Expr *pRet;
485a1251bc4Sdrh   if( pVector->op==TK_SELECT ){
486a1251bc4Sdrh     assert( pVector->flags & EP_xIsSelect );
487fc7f27b9Sdrh     /* The TK_SELECT_COLUMN Expr node:
488fc7f27b9Sdrh     **
489966e2911Sdrh     ** pLeft:           pVector containing TK_SELECT.  Not deleted.
4908762ec19Sdrh     ** pRight:          not used.  But recursively deleted.
491fc7f27b9Sdrh     ** iColumn:         Index of a column in pVector
492966e2911Sdrh     ** iTable:          0 or the number of columns on the LHS of an assignment
493fc7f27b9Sdrh     ** pLeft->iTable:   First in an array of register holding result, or 0
494fc7f27b9Sdrh     **                  if the result is not yet computed.
495fc7f27b9Sdrh     **
496fc7f27b9Sdrh     ** sqlite3ExprDelete() specifically skips the recursive delete of
497fc7f27b9Sdrh     ** pLeft on TK_SELECT_COLUMN nodes.  But pRight is followed, so pVector
4988762ec19Sdrh     ** can be attached to pRight to cause this node to take ownership of
4998762ec19Sdrh     ** pVector.  Typically there will be multiple TK_SELECT_COLUMN nodes
5008762ec19Sdrh     ** with the same pLeft pointer to the pVector, but only one of them
5018762ec19Sdrh     ** will own the pVector.
502fc7f27b9Sdrh     */
503abfd35eaSdrh     pRet = sqlite3PExpr(pParse, TK_SELECT_COLUMN, 0, 0);
5048bd0d58eSdrh     if( pRet ){
5058bd0d58eSdrh       pRet->iColumn = iField;
5068bd0d58eSdrh       pRet->pLeft = pVector;
5078bd0d58eSdrh     }
508fc7f27b9Sdrh     assert( pRet==0 || pRet->iTable==0 );
509fc7f27b9Sdrh   }else{
510a1251bc4Sdrh     if( pVector->op==TK_VECTOR ) pVector = pVector->x.pList->a[iField].pExpr;
511a1251bc4Sdrh     pRet = sqlite3ExprDup(pParse->db, pVector, 0);
512dfb5c963Sdan     sqlite3RenameTokenRemap(pParse, pRet, pVector);
513fc7f27b9Sdrh   }
514fc7f27b9Sdrh   return pRet;
515fc7f27b9Sdrh }
51671c57db0Sdan 
5175c288b92Sdan /*
5185c288b92Sdan ** If expression pExpr is of type TK_SELECT, generate code to evaluate
5195c288b92Sdan ** it. Return the register in which the result is stored (or, if the
5205c288b92Sdan ** sub-select returns more than one column, the first in an array
5215c288b92Sdan ** of registers in which the result is stored).
5225c288b92Sdan **
5235c288b92Sdan ** If pExpr is not a TK_SELECT expression, return 0.
5245c288b92Sdan */
5255c288b92Sdan static int exprCodeSubselect(Parse *pParse, Expr *pExpr){
5268da209b1Sdan   int reg = 0;
527f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
5285c288b92Sdan   if( pExpr->op==TK_SELECT ){
52985bcdce2Sdrh     reg = sqlite3CodeSubselect(pParse, pExpr);
5308da209b1Sdan   }
531f9b2e05cSdan #endif
5328da209b1Sdan   return reg;
5338da209b1Sdan }
5348da209b1Sdan 
5355c288b92Sdan /*
5365c288b92Sdan ** Argument pVector points to a vector expression - either a TK_VECTOR
537870a0705Sdan ** or TK_SELECT that returns more than one column. This function returns
538870a0705Sdan ** the register number of a register that contains the value of
539870a0705Sdan ** element iField of the vector.
540870a0705Sdan **
541870a0705Sdan ** If pVector is a TK_SELECT expression, then code for it must have
542870a0705Sdan ** already been generated using the exprCodeSubselect() routine. In this
543870a0705Sdan ** case parameter regSelect should be the first in an array of registers
544870a0705Sdan ** containing the results of the sub-select.
545870a0705Sdan **
546870a0705Sdan ** If pVector is of type TK_VECTOR, then code for the requested field
547870a0705Sdan ** is generated. In this case (*pRegFree) may be set to the number of
548870a0705Sdan ** a temporary register to be freed by the caller before returning.
5495c288b92Sdan **
5505c288b92Sdan ** Before returning, output parameter (*ppExpr) is set to point to the
5515c288b92Sdan ** Expr object corresponding to element iElem of the vector.
5525c288b92Sdan */
5535c288b92Sdan static int exprVectorRegister(
5545c288b92Sdan   Parse *pParse,                  /* Parse context */
5555c288b92Sdan   Expr *pVector,                  /* Vector to extract element from */
556870a0705Sdan   int iField,                     /* Field to extract from pVector */
5575c288b92Sdan   int regSelect,                  /* First in array of registers */
5585c288b92Sdan   Expr **ppExpr,                  /* OUT: Expression element */
5595c288b92Sdan   int *pRegFree                   /* OUT: Temp register to free */
5605c288b92Sdan ){
56112abf408Sdrh   u8 op = pVector->op;
562c1bcd9ccSdrh   assert( op==TK_VECTOR || op==TK_REGISTER || op==TK_SELECT );
56312abf408Sdrh   if( op==TK_REGISTER ){
56412abf408Sdrh     *ppExpr = sqlite3VectorFieldSubexpr(pVector, iField);
56512abf408Sdrh     return pVector->iTable+iField;
56612abf408Sdrh   }
56712abf408Sdrh   if( op==TK_SELECT ){
568870a0705Sdan     *ppExpr = pVector->x.pSelect->pEList->a[iField].pExpr;
569870a0705Sdan      return regSelect+iField;
5705c288b92Sdan   }
571870a0705Sdan   *ppExpr = pVector->x.pList->a[iField].pExpr;
5725c288b92Sdan   return sqlite3ExprCodeTemp(pParse, *ppExpr, pRegFree);
5735c288b92Sdan }
5745c288b92Sdan 
5755c288b92Sdan /*
5765c288b92Sdan ** Expression pExpr is a comparison between two vector values. Compute
57779752b6eSdrh ** the result of the comparison (1, 0, or NULL) and write that
57879752b6eSdrh ** result into register dest.
57979752b6eSdrh **
58079752b6eSdrh ** The caller must satisfy the following preconditions:
58179752b6eSdrh **
58279752b6eSdrh **    if pExpr->op==TK_IS:      op==TK_EQ and p5==SQLITE_NULLEQ
58379752b6eSdrh **    if pExpr->op==TK_ISNOT:   op==TK_NE and p5==SQLITE_NULLEQ
58479752b6eSdrh **    otherwise:                op==pExpr->op and p5==0
5855c288b92Sdan */
58679752b6eSdrh static void codeVectorCompare(
58779752b6eSdrh   Parse *pParse,        /* Code generator context */
58879752b6eSdrh   Expr *pExpr,          /* The comparison operation */
58979752b6eSdrh   int dest,             /* Write results into this register */
59079752b6eSdrh   u8 op,                /* Comparison operator */
59179752b6eSdrh   u8 p5                 /* SQLITE_NULLEQ or zero */
59279752b6eSdrh ){
59371c57db0Sdan   Vdbe *v = pParse->pVdbe;
59471c57db0Sdan   Expr *pLeft = pExpr->pLeft;
59571c57db0Sdan   Expr *pRight = pExpr->pRight;
59671c57db0Sdan   int nLeft = sqlite3ExprVectorSize(pLeft);
59771c57db0Sdan   int i;
59871c57db0Sdan   int regLeft = 0;
59971c57db0Sdan   int regRight = 0;
60079752b6eSdrh   u8 opx = op;
601ec4ccdbcSdrh   int addrDone = sqlite3VdbeMakeLabel(pParse);
602898c527eSdrh   int isCommuted = ExprHasProperty(pExpr,EP_Commuted);
60371c57db0Sdan 
604e7375bfaSdrh   assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
60570d6b832Sdrh   if( pParse->nErr ) return;
606245ce62eSdrh   if( nLeft!=sqlite3ExprVectorSize(pRight) ){
607245ce62eSdrh     sqlite3ErrorMsg(pParse, "row value misused");
608245ce62eSdrh     return;
609245ce62eSdrh   }
61071c57db0Sdan   assert( pExpr->op==TK_EQ || pExpr->op==TK_NE
61171c57db0Sdan        || pExpr->op==TK_IS || pExpr->op==TK_ISNOT
61271c57db0Sdan        || pExpr->op==TK_LT || pExpr->op==TK_GT
61371c57db0Sdan        || pExpr->op==TK_LE || pExpr->op==TK_GE
61471c57db0Sdan   );
61579752b6eSdrh   assert( pExpr->op==op || (pExpr->op==TK_IS && op==TK_EQ)
61679752b6eSdrh             || (pExpr->op==TK_ISNOT && op==TK_NE) );
61779752b6eSdrh   assert( p5==0 || pExpr->op!=op );
61879752b6eSdrh   assert( p5==SQLITE_NULLEQ || pExpr->op==op );
61971c57db0Sdan 
62079752b6eSdrh   p5 |= SQLITE_STOREP2;
62179752b6eSdrh   if( opx==TK_LE ) opx = TK_LT;
62279752b6eSdrh   if( opx==TK_GE ) opx = TK_GT;
6235c288b92Sdan 
6245c288b92Sdan   regLeft = exprCodeSubselect(pParse, pLeft);
6255c288b92Sdan   regRight = exprCodeSubselect(pParse, pRight);
6265c288b92Sdan 
627321e828dSdrh   for(i=0; 1 /*Loop exits by "break"*/; i++){
6285c288b92Sdan     int regFree1 = 0, regFree2 = 0;
6295c288b92Sdan     Expr *pL, *pR;
6305c288b92Sdan     int r1, r2;
631321e828dSdrh     assert( i>=0 && i<nLeft );
6325c288b92Sdan     r1 = exprVectorRegister(pParse, pLeft, i, regLeft, &pL, &regFree1);
6335c288b92Sdan     r2 = exprVectorRegister(pParse, pRight, i, regRight, &pR, &regFree2);
634898c527eSdrh     codeCompare(pParse, pL, pR, opx, r1, r2, dest, p5, isCommuted);
63579752b6eSdrh     testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
63679752b6eSdrh     testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
63779752b6eSdrh     testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
63879752b6eSdrh     testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
63979752b6eSdrh     testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
64079752b6eSdrh     testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
64171c57db0Sdan     sqlite3ReleaseTempReg(pParse, regFree1);
64271c57db0Sdan     sqlite3ReleaseTempReg(pParse, regFree2);
64379752b6eSdrh     if( i==nLeft-1 ){
64479752b6eSdrh       break;
64571c57db0Sdan     }
64679752b6eSdrh     if( opx==TK_EQ ){
64779752b6eSdrh       sqlite3VdbeAddOp2(v, OP_IfNot, dest, addrDone); VdbeCoverage(v);
64879752b6eSdrh       p5 |= SQLITE_KEEPNULL;
64979752b6eSdrh     }else if( opx==TK_NE ){
65079752b6eSdrh       sqlite3VdbeAddOp2(v, OP_If, dest, addrDone); VdbeCoverage(v);
65179752b6eSdrh       p5 |= SQLITE_KEEPNULL;
652a2f62925Sdrh     }else{
653a2f62925Sdrh       assert( op==TK_LT || op==TK_GT || op==TK_LE || op==TK_GE );
654a2f62925Sdrh       sqlite3VdbeAddOp2(v, OP_ElseNotEq, 0, addrDone);
65579752b6eSdrh       VdbeCoverageIf(v, op==TK_LT);
65679752b6eSdrh       VdbeCoverageIf(v, op==TK_GT);
65779752b6eSdrh       VdbeCoverageIf(v, op==TK_LE);
65879752b6eSdrh       VdbeCoverageIf(v, op==TK_GE);
65979752b6eSdrh       if( i==nLeft-2 ) opx = op;
66071c57db0Sdan     }
66179752b6eSdrh   }
66279752b6eSdrh   sqlite3VdbeResolveLabel(v, addrDone);
66379752b6eSdrh }
66471c57db0Sdan 
6654b5255acSdanielk1977 #if SQLITE_MAX_EXPR_DEPTH>0
6664b5255acSdanielk1977 /*
6674b5255acSdanielk1977 ** Check that argument nHeight is less than or equal to the maximum
6684b5255acSdanielk1977 ** expression depth allowed. If it is not, leave an error message in
6694b5255acSdanielk1977 ** pParse.
6704b5255acSdanielk1977 */
6717d10d5a6Sdrh int sqlite3ExprCheckHeight(Parse *pParse, int nHeight){
6724b5255acSdanielk1977   int rc = SQLITE_OK;
6734b5255acSdanielk1977   int mxHeight = pParse->db->aLimit[SQLITE_LIMIT_EXPR_DEPTH];
6744b5255acSdanielk1977   if( nHeight>mxHeight ){
6754b5255acSdanielk1977     sqlite3ErrorMsg(pParse,
6764b5255acSdanielk1977        "Expression tree is too large (maximum depth %d)", mxHeight
6774b5255acSdanielk1977     );
6784b5255acSdanielk1977     rc = SQLITE_ERROR;
6794b5255acSdanielk1977   }
6804b5255acSdanielk1977   return rc;
6814b5255acSdanielk1977 }
6824b5255acSdanielk1977 
6834b5255acSdanielk1977 /* The following three functions, heightOfExpr(), heightOfExprList()
6844b5255acSdanielk1977 ** and heightOfSelect(), are used to determine the maximum height
6854b5255acSdanielk1977 ** of any expression tree referenced by the structure passed as the
6864b5255acSdanielk1977 ** first argument.
6874b5255acSdanielk1977 **
6884b5255acSdanielk1977 ** If this maximum height is greater than the current value pointed
6894b5255acSdanielk1977 ** to by pnHeight, the second parameter, then set *pnHeight to that
6904b5255acSdanielk1977 ** value.
6914b5255acSdanielk1977 */
6924b5255acSdanielk1977 static void heightOfExpr(Expr *p, int *pnHeight){
6934b5255acSdanielk1977   if( p ){
6944b5255acSdanielk1977     if( p->nHeight>*pnHeight ){
6954b5255acSdanielk1977       *pnHeight = p->nHeight;
6964b5255acSdanielk1977     }
6974b5255acSdanielk1977   }
6984b5255acSdanielk1977 }
6994b5255acSdanielk1977 static void heightOfExprList(ExprList *p, int *pnHeight){
7004b5255acSdanielk1977   if( p ){
7014b5255acSdanielk1977     int i;
7024b5255acSdanielk1977     for(i=0; i<p->nExpr; i++){
7034b5255acSdanielk1977       heightOfExpr(p->a[i].pExpr, pnHeight);
7044b5255acSdanielk1977     }
7054b5255acSdanielk1977   }
7064b5255acSdanielk1977 }
7071a3a3086Sdan static void heightOfSelect(Select *pSelect, int *pnHeight){
7081a3a3086Sdan   Select *p;
7091a3a3086Sdan   for(p=pSelect; p; p=p->pPrior){
7104b5255acSdanielk1977     heightOfExpr(p->pWhere, pnHeight);
7114b5255acSdanielk1977     heightOfExpr(p->pHaving, pnHeight);
7124b5255acSdanielk1977     heightOfExpr(p->pLimit, pnHeight);
7134b5255acSdanielk1977     heightOfExprList(p->pEList, pnHeight);
7144b5255acSdanielk1977     heightOfExprList(p->pGroupBy, pnHeight);
7154b5255acSdanielk1977     heightOfExprList(p->pOrderBy, pnHeight);
7164b5255acSdanielk1977   }
7174b5255acSdanielk1977 }
7184b5255acSdanielk1977 
7194b5255acSdanielk1977 /*
7204b5255acSdanielk1977 ** Set the Expr.nHeight variable in the structure passed as an
7214b5255acSdanielk1977 ** argument. An expression with no children, Expr.pList or
7224b5255acSdanielk1977 ** Expr.pSelect member has a height of 1. Any other expression
7234b5255acSdanielk1977 ** has a height equal to the maximum height of any other
7244b5255acSdanielk1977 ** referenced Expr plus one.
7252308ed38Sdrh **
7262308ed38Sdrh ** Also propagate EP_Propagate flags up from Expr.x.pList to Expr.flags,
7272308ed38Sdrh ** if appropriate.
7284b5255acSdanielk1977 */
7294b5255acSdanielk1977 static void exprSetHeight(Expr *p){
7304b5255acSdanielk1977   int nHeight = 0;
7314b5255acSdanielk1977   heightOfExpr(p->pLeft, &nHeight);
7324b5255acSdanielk1977   heightOfExpr(p->pRight, &nHeight);
7336ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_xIsSelect) ){
7346ab3a2ecSdanielk1977     heightOfSelect(p->x.pSelect, &nHeight);
7352308ed38Sdrh   }else if( p->x.pList ){
7366ab3a2ecSdanielk1977     heightOfExprList(p->x.pList, &nHeight);
7372308ed38Sdrh     p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
7386ab3a2ecSdanielk1977   }
7394b5255acSdanielk1977   p->nHeight = nHeight + 1;
7404b5255acSdanielk1977 }
7414b5255acSdanielk1977 
7424b5255acSdanielk1977 /*
7434b5255acSdanielk1977 ** Set the Expr.nHeight variable using the exprSetHeight() function. If
7444b5255acSdanielk1977 ** the height is greater than the maximum allowed expression depth,
7454b5255acSdanielk1977 ** leave an error in pParse.
7462308ed38Sdrh **
7472308ed38Sdrh ** Also propagate all EP_Propagate flags from the Expr.x.pList into
7482308ed38Sdrh ** Expr.flags.
7494b5255acSdanielk1977 */
7502308ed38Sdrh void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
75174893a4cSdrh   if( pParse->nErr ) return;
7524b5255acSdanielk1977   exprSetHeight(p);
7537d10d5a6Sdrh   sqlite3ExprCheckHeight(pParse, p->nHeight);
7544b5255acSdanielk1977 }
7554b5255acSdanielk1977 
7564b5255acSdanielk1977 /*
7574b5255acSdanielk1977 ** Return the maximum height of any expression tree referenced
7584b5255acSdanielk1977 ** by the select statement passed as an argument.
7594b5255acSdanielk1977 */
7604b5255acSdanielk1977 int sqlite3SelectExprHeight(Select *p){
7614b5255acSdanielk1977   int nHeight = 0;
7624b5255acSdanielk1977   heightOfSelect(p, &nHeight);
7634b5255acSdanielk1977   return nHeight;
7644b5255acSdanielk1977 }
7652308ed38Sdrh #else /* ABOVE:  Height enforcement enabled.  BELOW: Height enforcement off */
7662308ed38Sdrh /*
7672308ed38Sdrh ** Propagate all EP_Propagate flags from the Expr.x.pList into
7682308ed38Sdrh ** Expr.flags.
7692308ed38Sdrh */
7702308ed38Sdrh void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
7712308ed38Sdrh   if( p && p->x.pList && !ExprHasProperty(p, EP_xIsSelect) ){
7722308ed38Sdrh     p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
7732308ed38Sdrh   }
7742308ed38Sdrh }
7754b5255acSdanielk1977 #define exprSetHeight(y)
7764b5255acSdanielk1977 #endif /* SQLITE_MAX_EXPR_DEPTH>0 */
7774b5255acSdanielk1977 
778be5c89acSdrh /*
779b7916a78Sdrh ** This routine is the core allocator for Expr nodes.
780b7916a78Sdrh **
781a76b5dfcSdrh ** Construct a new expression node and return a pointer to it.  Memory
782b7916a78Sdrh ** for this node and for the pToken argument is a single allocation
783b7916a78Sdrh ** obtained from sqlite3DbMalloc().  The calling function
784a76b5dfcSdrh ** is responsible for making sure the node eventually gets freed.
785b7916a78Sdrh **
786b7916a78Sdrh ** If dequote is true, then the token (if it exists) is dequoted.
787e792b5b4Sdrh ** If dequote is false, no dequoting is performed.  The deQuote
788b7916a78Sdrh ** parameter is ignored if pToken is NULL or if the token does not
789b7916a78Sdrh ** appear to be quoted.  If the quotes were of the form "..." (double-quotes)
790b7916a78Sdrh ** then the EP_DblQuoted flag is set on the expression node.
79133e619fcSdrh **
79233e619fcSdrh ** Special case:  If op==TK_INTEGER and pToken points to a string that
79333e619fcSdrh ** can be translated into a 32-bit integer, then the token is not
79433e619fcSdrh ** stored in u.zToken.  Instead, the integer values is written
79533e619fcSdrh ** into u.iValue and the EP_IntValue flag is set.  No extra storage
79633e619fcSdrh ** is allocated to hold the integer text and the dequote flag is ignored.
797a76b5dfcSdrh */
798b7916a78Sdrh Expr *sqlite3ExprAlloc(
799cca8a4adSdrh   sqlite3 *db,            /* Handle for sqlite3DbMallocRawNN() */
80017435752Sdrh   int op,                 /* Expression opcode */
801b7916a78Sdrh   const Token *pToken,    /* Token argument.  Might be NULL */
802b7916a78Sdrh   int dequote             /* True to dequote */
80317435752Sdrh ){
804a76b5dfcSdrh   Expr *pNew;
80533e619fcSdrh   int nExtra = 0;
806cf697396Sshane   int iValue = 0;
807b7916a78Sdrh 
808575fad65Sdrh   assert( db!=0 );
809b7916a78Sdrh   if( pToken ){
81033e619fcSdrh     if( op!=TK_INTEGER || pToken->z==0
81133e619fcSdrh           || sqlite3GetInt32(pToken->z, &iValue)==0 ){
812b7916a78Sdrh       nExtra = pToken->n+1;
813d50ffc41Sdrh       assert( iValue>=0 );
81433e619fcSdrh     }
815a76b5dfcSdrh   }
816575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, sizeof(Expr)+nExtra);
817b7916a78Sdrh   if( pNew ){
818ca3862dcSdrh     memset(pNew, 0, sizeof(Expr));
8191bd10f8aSdrh     pNew->op = (u8)op;
820a58fdfb1Sdanielk1977     pNew->iAgg = -1;
821a76b5dfcSdrh     if( pToken ){
82233e619fcSdrh       if( nExtra==0 ){
823ad31727fSdrh         pNew->flags |= EP_IntValue|EP_Leaf|(iValue?EP_IsTrue:EP_IsFalse);
82433e619fcSdrh         pNew->u.iValue = iValue;
82533e619fcSdrh       }else{
82633e619fcSdrh         pNew->u.zToken = (char*)&pNew[1];
827b07028f7Sdrh         assert( pToken->z!=0 || pToken->n==0 );
828b07028f7Sdrh         if( pToken->n ) memcpy(pNew->u.zToken, pToken->z, pToken->n);
82933e619fcSdrh         pNew->u.zToken[pToken->n] = 0;
830244b9d6eSdrh         if( dequote && sqlite3Isquote(pNew->u.zToken[0]) ){
83151d35b0fSdrh           sqlite3DequoteExpr(pNew);
832a34001c9Sdrh         }
833a34001c9Sdrh       }
83433e619fcSdrh     }
835b7916a78Sdrh #if SQLITE_MAX_EXPR_DEPTH>0
836b7916a78Sdrh     pNew->nHeight = 1;
837b7916a78Sdrh #endif
838a34001c9Sdrh   }
839a76b5dfcSdrh   return pNew;
840a76b5dfcSdrh }
841a76b5dfcSdrh 
842a76b5dfcSdrh /*
843b7916a78Sdrh ** Allocate a new expression node from a zero-terminated token that has
844b7916a78Sdrh ** already been dequoted.
845b7916a78Sdrh */
846b7916a78Sdrh Expr *sqlite3Expr(
847b7916a78Sdrh   sqlite3 *db,            /* Handle for sqlite3DbMallocZero() (may be null) */
848b7916a78Sdrh   int op,                 /* Expression opcode */
849b7916a78Sdrh   const char *zToken      /* Token argument.  Might be NULL */
850b7916a78Sdrh ){
851b7916a78Sdrh   Token x;
852b7916a78Sdrh   x.z = zToken;
853b40f06c6Sdrh   x.n = sqlite3Strlen30(zToken);
854b7916a78Sdrh   return sqlite3ExprAlloc(db, op, &x, 0);
855b7916a78Sdrh }
856b7916a78Sdrh 
857b7916a78Sdrh /*
858b7916a78Sdrh ** Attach subtrees pLeft and pRight to the Expr node pRoot.
859b7916a78Sdrh **
860b7916a78Sdrh ** If pRoot==NULL that means that a memory allocation error has occurred.
861b7916a78Sdrh ** In that case, delete the subtrees pLeft and pRight.
862b7916a78Sdrh */
863b7916a78Sdrh void sqlite3ExprAttachSubtrees(
864b7916a78Sdrh   sqlite3 *db,
865b7916a78Sdrh   Expr *pRoot,
866b7916a78Sdrh   Expr *pLeft,
867b7916a78Sdrh   Expr *pRight
868b7916a78Sdrh ){
869b7916a78Sdrh   if( pRoot==0 ){
870b7916a78Sdrh     assert( db->mallocFailed );
871b7916a78Sdrh     sqlite3ExprDelete(db, pLeft);
872b7916a78Sdrh     sqlite3ExprDelete(db, pRight);
873b7916a78Sdrh   }else{
874b7916a78Sdrh     if( pRight ){
875b7916a78Sdrh       pRoot->pRight = pRight;
876885a5b03Sdrh       pRoot->flags |= EP_Propagate & pRight->flags;
877b7916a78Sdrh     }
878b7916a78Sdrh     if( pLeft ){
879b7916a78Sdrh       pRoot->pLeft = pLeft;
880885a5b03Sdrh       pRoot->flags |= EP_Propagate & pLeft->flags;
881b7916a78Sdrh     }
882b7916a78Sdrh     exprSetHeight(pRoot);
883b7916a78Sdrh   }
884b7916a78Sdrh }
885b7916a78Sdrh 
886b7916a78Sdrh /*
88760ec914cSpeter.d.reid ** Allocate an Expr node which joins as many as two subtrees.
888b7916a78Sdrh **
889bf664469Sdrh ** One or both of the subtrees can be NULL.  Return a pointer to the new
890bf664469Sdrh ** Expr node.  Or, if an OOM error occurs, set pParse->db->mallocFailed,
891bf664469Sdrh ** free the subtrees and return NULL.
892206f3d96Sdrh */
89317435752Sdrh Expr *sqlite3PExpr(
89417435752Sdrh   Parse *pParse,          /* Parsing context */
89517435752Sdrh   int op,                 /* Expression opcode */
89617435752Sdrh   Expr *pLeft,            /* Left operand */
897abfd35eaSdrh   Expr *pRight            /* Right operand */
89817435752Sdrh ){
8995fb52caaSdrh   Expr *p;
900abfd35eaSdrh   p = sqlite3DbMallocRawNN(pParse->db, sizeof(Expr));
901abfd35eaSdrh   if( p ){
902abfd35eaSdrh     memset(p, 0, sizeof(Expr));
903f1722baaSdrh     p->op = op & 0xff;
904abfd35eaSdrh     p->iAgg = -1;
905b7916a78Sdrh     sqlite3ExprAttachSubtrees(pParse->db, p, pLeft, pRight);
9062b359bdbSdan     sqlite3ExprCheckHeight(pParse, p->nHeight);
907d5c851c1Sdrh   }else{
908d5c851c1Sdrh     sqlite3ExprDelete(pParse->db, pLeft);
909d5c851c1Sdrh     sqlite3ExprDelete(pParse->db, pRight);
9102b359bdbSdan   }
9114e0cff60Sdrh   return p;
9124e0cff60Sdrh }
9134e0cff60Sdrh 
9144e0cff60Sdrh /*
91508de4f79Sdrh ** Add pSelect to the Expr.x.pSelect field.  Or, if pExpr is NULL (due
91608de4f79Sdrh ** do a memory allocation failure) then delete the pSelect object.
91708de4f79Sdrh */
91808de4f79Sdrh void sqlite3PExprAddSelect(Parse *pParse, Expr *pExpr, Select *pSelect){
91908de4f79Sdrh   if( pExpr ){
92008de4f79Sdrh     pExpr->x.pSelect = pSelect;
92108de4f79Sdrh     ExprSetProperty(pExpr, EP_xIsSelect|EP_Subquery);
92208de4f79Sdrh     sqlite3ExprSetHeightAndFlags(pParse, pExpr);
92308de4f79Sdrh   }else{
92408de4f79Sdrh     assert( pParse->db->mallocFailed );
92508de4f79Sdrh     sqlite3SelectDelete(pParse->db, pSelect);
92608de4f79Sdrh   }
92708de4f79Sdrh }
92808de4f79Sdrh 
92908de4f79Sdrh 
93008de4f79Sdrh /*
93191bb0eedSdrh ** Join two expressions using an AND operator.  If either expression is
93291bb0eedSdrh ** NULL, then just return the other expression.
9335fb52caaSdrh **
9345fb52caaSdrh ** If one side or the other of the AND is known to be false, then instead
9355fb52caaSdrh ** of returning an AND expression, just return a constant expression with
9365fb52caaSdrh ** a value of false.
93791bb0eedSdrh */
938d5c851c1Sdrh Expr *sqlite3ExprAnd(Parse *pParse, Expr *pLeft, Expr *pRight){
939d5c851c1Sdrh   sqlite3 *db = pParse->db;
94091bb0eedSdrh   if( pLeft==0  ){
94191bb0eedSdrh     return pRight;
94291bb0eedSdrh   }else if( pRight==0 ){
94391bb0eedSdrh     return pLeft;
9442b6e670fSdan   }else if( (ExprAlwaysFalse(pLeft) || ExprAlwaysFalse(pRight))
9452b6e670fSdan          && !IN_RENAME_OBJECT
9462b6e670fSdan   ){
9472b6e670fSdan     sqlite3ExprDelete(db, pLeft);
9482b6e670fSdan     sqlite3ExprDelete(db, pRight);
9495776ee5cSdrh     return sqlite3Expr(db, TK_INTEGER, "0");
95091bb0eedSdrh   }else{
951d5c851c1Sdrh     return sqlite3PExpr(pParse, TK_AND, pLeft, pRight);
952a76b5dfcSdrh   }
953a76b5dfcSdrh }
954a76b5dfcSdrh 
955a76b5dfcSdrh /*
956a76b5dfcSdrh ** Construct a new expression node for a function with multiple
957a76b5dfcSdrh ** arguments.
958a76b5dfcSdrh */
959954733b3Sdrh Expr *sqlite3ExprFunction(
960954733b3Sdrh   Parse *pParse,        /* Parsing context */
961954733b3Sdrh   ExprList *pList,      /* Argument list */
962954733b3Sdrh   Token *pToken,        /* Name of the function */
963954733b3Sdrh   int eDistinct         /* SF_Distinct or SF_ALL or 0 */
964954733b3Sdrh ){
965a76b5dfcSdrh   Expr *pNew;
966633e6d57Sdrh   sqlite3 *db = pParse->db;
9674b202ae2Sdanielk1977   assert( pToken );
968b7916a78Sdrh   pNew = sqlite3ExprAlloc(db, TK_FUNCTION, pToken, 1);
969a76b5dfcSdrh   if( pNew==0 ){
970d9da78a2Sdrh     sqlite3ExprListDelete(db, pList); /* Avoid memory leak when malloc fails */
971a76b5dfcSdrh     return 0;
972a76b5dfcSdrh   }
973954733b3Sdrh   if( pList && pList->nExpr > pParse->db->aLimit[SQLITE_LIMIT_FUNCTION_ARG] ){
974954733b3Sdrh     sqlite3ErrorMsg(pParse, "too many arguments on function %T", pToken);
975954733b3Sdrh   }
9766ab3a2ecSdanielk1977   pNew->x.pList = pList;
977fca23557Sdrh   ExprSetProperty(pNew, EP_HasFunc);
9786ab3a2ecSdanielk1977   assert( !ExprHasProperty(pNew, EP_xIsSelect) );
9792308ed38Sdrh   sqlite3ExprSetHeightAndFlags(pParse, pNew);
980954733b3Sdrh   if( eDistinct==SF_Distinct ) ExprSetProperty(pNew, EP_Distinct);
981a76b5dfcSdrh   return pNew;
982a76b5dfcSdrh }
983a76b5dfcSdrh 
984a76b5dfcSdrh /*
9850dfa5255Sdrh ** Check to see if a function is usable according to current access
9860dfa5255Sdrh ** rules:
9870dfa5255Sdrh **
9880dfa5255Sdrh **    SQLITE_FUNC_DIRECT    -     Only usable from top-level SQL
9890dfa5255Sdrh **
9900dfa5255Sdrh **    SQLITE_FUNC_UNSAFE    -     Usable if TRUSTED_SCHEMA or from
9910dfa5255Sdrh **                                top-level SQL
9920dfa5255Sdrh **
9930dfa5255Sdrh ** If the function is not usable, create an error.
9940dfa5255Sdrh */
9950dfa5255Sdrh void sqlite3ExprFunctionUsable(
9960dfa5255Sdrh   Parse *pParse,         /* Parsing and code generating context */
9970dfa5255Sdrh   Expr *pExpr,           /* The function invocation */
9980dfa5255Sdrh   FuncDef *pDef          /* The function being invoked */
9990dfa5255Sdrh ){
10000dfa5255Sdrh   assert( !IN_RENAME_OBJECT );
10012eeca204Sdrh   assert( (pDef->funcFlags & (SQLITE_FUNC_DIRECT|SQLITE_FUNC_UNSAFE))!=0 );
10022eeca204Sdrh   if( ExprHasProperty(pExpr, EP_FromDDL) ){
10030dfa5255Sdrh     if( (pDef->funcFlags & SQLITE_FUNC_DIRECT)!=0
10040dfa5255Sdrh      || (pParse->db->flags & SQLITE_TrustedSchema)==0
10050dfa5255Sdrh     ){
10060dfa5255Sdrh       /* Functions prohibited in triggers and views if:
10070dfa5255Sdrh       **     (1) tagged with SQLITE_DIRECTONLY
10080dfa5255Sdrh       **     (2) not tagged with SQLITE_INNOCUOUS (which means it
10090dfa5255Sdrh       **         is tagged with SQLITE_FUNC_UNSAFE) and
10100dfa5255Sdrh       **         SQLITE_DBCONFIG_TRUSTED_SCHEMA is off (meaning
10110dfa5255Sdrh       **         that the schema is possibly tainted).
10120dfa5255Sdrh       */
10130dfa5255Sdrh       sqlite3ErrorMsg(pParse, "unsafe use of %s()", pDef->zName);
10140dfa5255Sdrh     }
10150dfa5255Sdrh   }
10160dfa5255Sdrh }
10170dfa5255Sdrh 
10180dfa5255Sdrh /*
1019fa6bc000Sdrh ** Assign a variable number to an expression that encodes a wildcard
1020fa6bc000Sdrh ** in the original SQL statement.
1021fa6bc000Sdrh **
1022fa6bc000Sdrh ** Wildcards consisting of a single "?" are assigned the next sequential
1023fa6bc000Sdrh ** variable number.
1024fa6bc000Sdrh **
1025fa6bc000Sdrh ** Wildcards of the form "?nnn" are assigned the number "nnn".  We make
10269bf755ccSdrh ** sure "nnn" is not too big to avoid a denial of service attack when
1027fa6bc000Sdrh ** the SQL statement comes from an external source.
1028fa6bc000Sdrh **
102951f49f17Sdrh ** Wildcards of the form ":aaa", "@aaa", or "$aaa" are assigned the same number
1030fa6bc000Sdrh ** as the previous instance of the same wildcard.  Or if this is the first
103160ec914cSpeter.d.reid ** instance of the wildcard, the next sequential variable number is
1032fa6bc000Sdrh ** assigned.
1033fa6bc000Sdrh */
1034de25a88cSdrh void sqlite3ExprAssignVarNumber(Parse *pParse, Expr *pExpr, u32 n){
103517435752Sdrh   sqlite3 *db = pParse->db;
1036b7916a78Sdrh   const char *z;
1037f326d66dSdrh   ynVar x;
103817435752Sdrh 
1039fa6bc000Sdrh   if( pExpr==0 ) return;
1040c5cd1249Sdrh   assert( !ExprHasProperty(pExpr, EP_IntValue|EP_Reduced|EP_TokenOnly) );
104133e619fcSdrh   z = pExpr->u.zToken;
1042b7916a78Sdrh   assert( z!=0 );
1043b7916a78Sdrh   assert( z[0]!=0 );
1044b1ed717fSmistachkin   assert( n==(u32)sqlite3Strlen30(z) );
1045b7916a78Sdrh   if( z[1]==0 ){
1046fa6bc000Sdrh     /* Wildcard of the form "?".  Assign the next variable number */
1047b7916a78Sdrh     assert( z[0]=='?' );
1048f326d66dSdrh     x = (ynVar)(++pParse->nVar);
1049124c0b49Sdrh   }else{
1050f326d66dSdrh     int doAdd = 0;
1051124c0b49Sdrh     if( z[0]=='?' ){
1052fa6bc000Sdrh       /* Wildcard of the form "?nnn".  Convert "nnn" to an integer and
1053fa6bc000Sdrh       ** use it as the variable number */
1054c8d735aeSdan       i64 i;
105518814dfbSdrh       int bOk;
105618814dfbSdrh       if( n==2 ){ /*OPTIMIZATION-IF-TRUE*/
105718814dfbSdrh         i = z[1]-'0';  /* The common case of ?N for a single digit N */
105818814dfbSdrh         bOk = 1;
105918814dfbSdrh       }else{
106018814dfbSdrh         bOk = 0==sqlite3Atoi64(&z[1], &i, n-1, SQLITE_UTF8);
106118814dfbSdrh       }
1062c5499befSdrh       testcase( i==0 );
1063c5499befSdrh       testcase( i==1 );
1064c5499befSdrh       testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]-1 );
1065c5499befSdrh       testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] );
1066c8d735aeSdan       if( bOk==0 || i<1 || i>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
1067fa6bc000Sdrh         sqlite3ErrorMsg(pParse, "variable number must be between ?1 and ?%d",
1068bb4957f8Sdrh             db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]);
1069c9b39288Sdrh         return;
1070fa6bc000Sdrh       }
10718e74e7baSdrh       x = (ynVar)i;
1072f326d66dSdrh       if( x>pParse->nVar ){
1073f326d66dSdrh         pParse->nVar = (int)x;
1074f326d66dSdrh         doAdd = 1;
1075f326d66dSdrh       }else if( sqlite3VListNumToName(pParse->pVList, x)==0 ){
1076f326d66dSdrh         doAdd = 1;
1077fa6bc000Sdrh       }
1078fa6bc000Sdrh     }else{
107951f49f17Sdrh       /* Wildcards like ":aaa", "$aaa" or "@aaa".  Reuse the same variable
1080fa6bc000Sdrh       ** number as the prior appearance of the same name, or if the name
1081fa6bc000Sdrh       ** has never appeared before, reuse the same variable number
1082fa6bc000Sdrh       */
10839bf755ccSdrh       x = (ynVar)sqlite3VListNameToNum(pParse->pVList, z, n);
10849bf755ccSdrh       if( x==0 ){
10859bf755ccSdrh         x = (ynVar)(++pParse->nVar);
1086f326d66dSdrh         doAdd = 1;
1087f326d66dSdrh       }
1088f326d66dSdrh     }
1089f326d66dSdrh     if( doAdd ){
10909bf755ccSdrh       pParse->pVList = sqlite3VListAdd(db, pParse->pVList, z, n, x);
1091fa6bc000Sdrh     }
1092fa6bc000Sdrh   }
1093c9b39288Sdrh   pExpr->iColumn = x;
1094f326d66dSdrh   if( x>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
1095832b2664Sdanielk1977     sqlite3ErrorMsg(pParse, "too many SQL variables");
1096832b2664Sdanielk1977   }
1097fa6bc000Sdrh }
1098fa6bc000Sdrh 
1099fa6bc000Sdrh /*
1100f6963f99Sdan ** Recursively delete an expression tree.
1101a2e00042Sdrh */
11024f0010b1Sdrh static SQLITE_NOINLINE void sqlite3ExprDeleteNN(sqlite3 *db, Expr *p){
11034f0010b1Sdrh   assert( p!=0 );
1104d50ffc41Sdrh   /* Sanity check: Assert that the IntValue is non-negative if it exists */
1105d50ffc41Sdrh   assert( !ExprHasProperty(p, EP_IntValue) || p->u.iValue>=0 );
1106eda079cdSdrh 
1107eda079cdSdrh   assert( !ExprHasProperty(p, EP_WinFunc) || p->y.pWin!=0 || db->mallocFailed );
1108eda079cdSdrh   assert( p->op!=TK_FUNCTION || ExprHasProperty(p, EP_TokenOnly|EP_Reduced)
11094f9adee2Sdan           || p->y.pWin==0 || ExprHasProperty(p, EP_WinFunc) );
1110209bc522Sdrh #ifdef SQLITE_DEBUG
1111209bc522Sdrh   if( ExprHasProperty(p, EP_Leaf) && !ExprHasProperty(p, EP_TokenOnly) ){
1112209bc522Sdrh     assert( p->pLeft==0 );
1113209bc522Sdrh     assert( p->pRight==0 );
1114209bc522Sdrh     assert( p->x.pSelect==0 );
1115209bc522Sdrh   }
1116209bc522Sdrh #endif
1117209bc522Sdrh   if( !ExprHasProperty(p, (EP_TokenOnly|EP_Leaf)) ){
1118c5cd1249Sdrh     /* The Expr.x union is never used at the same time as Expr.pRight */
1119c5cd1249Sdrh     assert( p->x.pList==0 || p->pRight==0 );
11204910a76dSdrh     if( p->pLeft && p->op!=TK_SELECT_COLUMN ) sqlite3ExprDeleteNN(db, p->pLeft);
1121d1086679Sdrh     if( p->pRight ){
11224f9adee2Sdan       assert( !ExprHasProperty(p, EP_WinFunc) );
1123d1086679Sdrh       sqlite3ExprDeleteNN(db, p->pRight);
1124d1086679Sdrh     }else if( ExprHasProperty(p, EP_xIsSelect) ){
11254f9adee2Sdan       assert( !ExprHasProperty(p, EP_WinFunc) );
11266ab3a2ecSdanielk1977       sqlite3SelectDelete(db, p->x.pSelect);
11276ab3a2ecSdanielk1977     }else{
11286ab3a2ecSdanielk1977       sqlite3ExprListDelete(db, p->x.pList);
11296ba7ab0dSdan #ifndef SQLITE_OMIT_WINDOWFUNC
1130eda079cdSdrh       if( ExprHasProperty(p, EP_WinFunc) ){
1131eda079cdSdrh         sqlite3WindowDelete(db, p->y.pWin);
113286fb6e17Sdan       }
11336ba7ab0dSdan #endif
11346ab3a2ecSdanielk1977     }
11358117f113Sdan   }
1136209bc522Sdrh   if( ExprHasProperty(p, EP_MemToken) ) sqlite3DbFree(db, p->u.zToken);
113733e619fcSdrh   if( !ExprHasProperty(p, EP_Static) ){
1138dbd6a7dcSdrh     sqlite3DbFreeNN(db, p);
1139a2e00042Sdrh   }
114033e619fcSdrh }
11414f0010b1Sdrh void sqlite3ExprDelete(sqlite3 *db, Expr *p){
11424f0010b1Sdrh   if( p ) sqlite3ExprDeleteNN(db, p);
11434f0010b1Sdrh }
1144a2e00042Sdrh 
11458e34e406Sdrh /* Invoke sqlite3RenameExprUnmap() and sqlite3ExprDelete() on the
11468e34e406Sdrh ** expression.
11478e34e406Sdrh */
11488e34e406Sdrh void sqlite3ExprUnmapAndDelete(Parse *pParse, Expr *p){
11498e34e406Sdrh   if( p ){
11508e34e406Sdrh     if( IN_RENAME_OBJECT ){
11518e34e406Sdrh       sqlite3RenameExprUnmap(pParse, p);
11528e34e406Sdrh     }
11538e34e406Sdrh     sqlite3ExprDeleteNN(pParse->db, p);
11548e34e406Sdrh   }
11558e34e406Sdrh }
11568e34e406Sdrh 
1157d2687b77Sdrh /*
11586ab3a2ecSdanielk1977 ** Return the number of bytes allocated for the expression structure
11596ab3a2ecSdanielk1977 ** passed as the first argument. This is always one of EXPR_FULLSIZE,
11606ab3a2ecSdanielk1977 ** EXPR_REDUCEDSIZE or EXPR_TOKENONLYSIZE.
11616ab3a2ecSdanielk1977 */
11626ab3a2ecSdanielk1977 static int exprStructSize(Expr *p){
11636ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_TokenOnly) ) return EXPR_TOKENONLYSIZE;
11646ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_Reduced) ) return EXPR_REDUCEDSIZE;
11656ab3a2ecSdanielk1977   return EXPR_FULLSIZE;
11666ab3a2ecSdanielk1977 }
11676ab3a2ecSdanielk1977 
11686ab3a2ecSdanielk1977 /*
116933e619fcSdrh ** The dupedExpr*Size() routines each return the number of bytes required
117033e619fcSdrh ** to store a copy of an expression or expression tree.  They differ in
117133e619fcSdrh ** how much of the tree is measured.
117233e619fcSdrh **
117333e619fcSdrh **     dupedExprStructSize()     Size of only the Expr structure
117433e619fcSdrh **     dupedExprNodeSize()       Size of Expr + space for token
117533e619fcSdrh **     dupedExprSize()           Expr + token + subtree components
117633e619fcSdrh **
117733e619fcSdrh ***************************************************************************
117833e619fcSdrh **
117933e619fcSdrh ** The dupedExprStructSize() function returns two values OR-ed together:
118033e619fcSdrh ** (1) the space required for a copy of the Expr structure only and
118133e619fcSdrh ** (2) the EP_xxx flags that indicate what the structure size should be.
118233e619fcSdrh ** The return values is always one of:
118333e619fcSdrh **
118433e619fcSdrh **      EXPR_FULLSIZE
118533e619fcSdrh **      EXPR_REDUCEDSIZE   | EP_Reduced
118633e619fcSdrh **      EXPR_TOKENONLYSIZE | EP_TokenOnly
118733e619fcSdrh **
118833e619fcSdrh ** The size of the structure can be found by masking the return value
118933e619fcSdrh ** of this routine with 0xfff.  The flags can be found by masking the
119033e619fcSdrh ** return value with EP_Reduced|EP_TokenOnly.
119133e619fcSdrh **
119233e619fcSdrh ** Note that with flags==EXPRDUP_REDUCE, this routines works on full-size
119333e619fcSdrh ** (unreduced) Expr objects as they or originally constructed by the parser.
119433e619fcSdrh ** During expression analysis, extra information is computed and moved into
1195c95f38d4Sdan ** later parts of the Expr object and that extra information might get chopped
119633e619fcSdrh ** off if the expression is reduced.  Note also that it does not work to
119760ec914cSpeter.d.reid ** make an EXPRDUP_REDUCE copy of a reduced expression.  It is only legal
119833e619fcSdrh ** to reduce a pristine expression tree from the parser.  The implementation
119933e619fcSdrh ** of dupedExprStructSize() contain multiple assert() statements that attempt
120033e619fcSdrh ** to enforce this constraint.
12016ab3a2ecSdanielk1977 */
12026ab3a2ecSdanielk1977 static int dupedExprStructSize(Expr *p, int flags){
12036ab3a2ecSdanielk1977   int nSize;
120433e619fcSdrh   assert( flags==EXPRDUP_REDUCE || flags==0 ); /* Only one flag value allowed */
1205aecd8021Sdrh   assert( EXPR_FULLSIZE<=0xfff );
1206aecd8021Sdrh   assert( (0xfff & (EP_Reduced|EP_TokenOnly))==0 );
120767a9b8edSdan   if( 0==flags || p->op==TK_SELECT_COLUMN
120867a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
1209eda079cdSdrh    || ExprHasProperty(p, EP_WinFunc)
121067a9b8edSdan #endif
121167a9b8edSdan   ){
12126ab3a2ecSdanielk1977     nSize = EXPR_FULLSIZE;
12136ab3a2ecSdanielk1977   }else{
1214c5cd1249Sdrh     assert( !ExprHasProperty(p, EP_TokenOnly|EP_Reduced) );
121533e619fcSdrh     assert( !ExprHasProperty(p, EP_FromJoin) );
1216c5cd1249Sdrh     assert( !ExprHasProperty(p, EP_MemToken) );
1217e7375bfaSdrh     assert( !ExprHasVVAProperty(p, EP_NoReduce) );
1218aecd8021Sdrh     if( p->pLeft || p->x.pList ){
121933e619fcSdrh       nSize = EXPR_REDUCEDSIZE | EP_Reduced;
122033e619fcSdrh     }else{
1221aecd8021Sdrh       assert( p->pRight==0 );
122233e619fcSdrh       nSize = EXPR_TOKENONLYSIZE | EP_TokenOnly;
122333e619fcSdrh     }
12246ab3a2ecSdanielk1977   }
12256ab3a2ecSdanielk1977   return nSize;
12266ab3a2ecSdanielk1977 }
12276ab3a2ecSdanielk1977 
12286ab3a2ecSdanielk1977 /*
122933e619fcSdrh ** This function returns the space in bytes required to store the copy
123033e619fcSdrh ** of the Expr structure and a copy of the Expr.u.zToken string (if that
123133e619fcSdrh ** string is defined.)
12326ab3a2ecSdanielk1977 */
12336ab3a2ecSdanielk1977 static int dupedExprNodeSize(Expr *p, int flags){
123433e619fcSdrh   int nByte = dupedExprStructSize(p, flags) & 0xfff;
123533e619fcSdrh   if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
12367301e774Sdrh     nByte += sqlite3Strlen30NN(p->u.zToken)+1;
12376ab3a2ecSdanielk1977   }
1238bc73971dSdanielk1977   return ROUND8(nByte);
12396ab3a2ecSdanielk1977 }
12406ab3a2ecSdanielk1977 
12416ab3a2ecSdanielk1977 /*
12426ab3a2ecSdanielk1977 ** Return the number of bytes required to create a duplicate of the
12436ab3a2ecSdanielk1977 ** expression passed as the first argument. The second argument is a
12446ab3a2ecSdanielk1977 ** mask containing EXPRDUP_XXX flags.
12456ab3a2ecSdanielk1977 **
12466ab3a2ecSdanielk1977 ** The value returned includes space to create a copy of the Expr struct
124733e619fcSdrh ** itself and the buffer referred to by Expr.u.zToken, if any.
12486ab3a2ecSdanielk1977 **
12496ab3a2ecSdanielk1977 ** If the EXPRDUP_REDUCE flag is set, then the return value includes
12506ab3a2ecSdanielk1977 ** space to duplicate all Expr nodes in the tree formed by Expr.pLeft
12516ab3a2ecSdanielk1977 ** and Expr.pRight variables (but not for any structures pointed to or
12526ab3a2ecSdanielk1977 ** descended from the Expr.x.pList or Expr.x.pSelect variables).
12536ab3a2ecSdanielk1977 */
12546ab3a2ecSdanielk1977 static int dupedExprSize(Expr *p, int flags){
12556ab3a2ecSdanielk1977   int nByte = 0;
12566ab3a2ecSdanielk1977   if( p ){
12576ab3a2ecSdanielk1977     nByte = dupedExprNodeSize(p, flags);
12586ab3a2ecSdanielk1977     if( flags&EXPRDUP_REDUCE ){
1259b7916a78Sdrh       nByte += dupedExprSize(p->pLeft, flags) + dupedExprSize(p->pRight, flags);
12606ab3a2ecSdanielk1977     }
12616ab3a2ecSdanielk1977   }
12626ab3a2ecSdanielk1977   return nByte;
12636ab3a2ecSdanielk1977 }
12646ab3a2ecSdanielk1977 
12656ab3a2ecSdanielk1977 /*
12666ab3a2ecSdanielk1977 ** This function is similar to sqlite3ExprDup(), except that if pzBuffer
12676ab3a2ecSdanielk1977 ** is not NULL then *pzBuffer is assumed to point to a buffer large enough
126833e619fcSdrh ** to store the copy of expression p, the copies of p->u.zToken
12696ab3a2ecSdanielk1977 ** (if applicable), and the copies of the p->pLeft and p->pRight expressions,
127060ec914cSpeter.d.reid ** if any. Before returning, *pzBuffer is set to the first byte past the
12716ab3a2ecSdanielk1977 ** portion of the buffer copied into by this function.
12726ab3a2ecSdanielk1977 */
12733c19469cSdrh static Expr *exprDup(sqlite3 *db, Expr *p, int dupFlags, u8 **pzBuffer){
12743c19469cSdrh   Expr *pNew;           /* Value to return */
12753c19469cSdrh   u8 *zAlloc;           /* Memory space from which to build Expr object */
12763c19469cSdrh   u32 staticFlag;       /* EP_Static if space not obtained from malloc */
12776ab3a2ecSdanielk1977 
12783c19469cSdrh   assert( db!=0 );
12793c19469cSdrh   assert( p );
12803c19469cSdrh   assert( dupFlags==0 || dupFlags==EXPRDUP_REDUCE );
12813c19469cSdrh   assert( pzBuffer==0 || dupFlags==EXPRDUP_REDUCE );
12826ab3a2ecSdanielk1977 
12836ab3a2ecSdanielk1977   /* Figure out where to write the new Expr structure. */
12846ab3a2ecSdanielk1977   if( pzBuffer ){
12856ab3a2ecSdanielk1977     zAlloc = *pzBuffer;
128633e619fcSdrh     staticFlag = EP_Static;
12876ab3a2ecSdanielk1977   }else{
12883c19469cSdrh     zAlloc = sqlite3DbMallocRawNN(db, dupedExprSize(p, dupFlags));
12893c19469cSdrh     staticFlag = 0;
12906ab3a2ecSdanielk1977   }
12916ab3a2ecSdanielk1977   pNew = (Expr *)zAlloc;
12926ab3a2ecSdanielk1977 
12936ab3a2ecSdanielk1977   if( pNew ){
12946ab3a2ecSdanielk1977     /* Set nNewSize to the size allocated for the structure pointed to
12956ab3a2ecSdanielk1977     ** by pNew. This is either EXPR_FULLSIZE, EXPR_REDUCEDSIZE or
12966ab3a2ecSdanielk1977     ** EXPR_TOKENONLYSIZE. nToken is set to the number of bytes consumed
129733e619fcSdrh     ** by the copy of the p->u.zToken string (if any).
12986ab3a2ecSdanielk1977     */
12993c19469cSdrh     const unsigned nStructSize = dupedExprStructSize(p, dupFlags);
130033e619fcSdrh     const int nNewSize = nStructSize & 0xfff;
130133e619fcSdrh     int nToken;
130233e619fcSdrh     if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
130333e619fcSdrh       nToken = sqlite3Strlen30(p->u.zToken) + 1;
130433e619fcSdrh     }else{
130533e619fcSdrh       nToken = 0;
130633e619fcSdrh     }
13073c19469cSdrh     if( dupFlags ){
13086ab3a2ecSdanielk1977       assert( ExprHasProperty(p, EP_Reduced)==0 );
13096ab3a2ecSdanielk1977       memcpy(zAlloc, p, nNewSize);
13106ab3a2ecSdanielk1977     }else{
13113e6a1411Sdan       u32 nSize = (u32)exprStructSize(p);
13126ab3a2ecSdanielk1977       memcpy(zAlloc, p, nSize);
131372ea29d7Sdrh       if( nSize<EXPR_FULLSIZE ){
13146ab3a2ecSdanielk1977         memset(&zAlloc[nSize], 0, EXPR_FULLSIZE-nSize);
13156ab3a2ecSdanielk1977       }
131672ea29d7Sdrh     }
13176ab3a2ecSdanielk1977 
131833e619fcSdrh     /* Set the EP_Reduced, EP_TokenOnly, and EP_Static flags appropriately. */
1319c5cd1249Sdrh     pNew->flags &= ~(EP_Reduced|EP_TokenOnly|EP_Static|EP_MemToken);
132033e619fcSdrh     pNew->flags |= nStructSize & (EP_Reduced|EP_TokenOnly);
132133e619fcSdrh     pNew->flags |= staticFlag;
1322e7375bfaSdrh     ExprClearVVAProperties(pNew);
1323e7375bfaSdrh     if( dupFlags ){
1324e7375bfaSdrh       ExprSetVVAProperty(pNew, EP_Immutable);
1325e7375bfaSdrh     }
13266ab3a2ecSdanielk1977 
132733e619fcSdrh     /* Copy the p->u.zToken string, if any. */
13286ab3a2ecSdanielk1977     if( nToken ){
132933e619fcSdrh       char *zToken = pNew->u.zToken = (char*)&zAlloc[nNewSize];
133033e619fcSdrh       memcpy(zToken, p->u.zToken, nToken);
13316ab3a2ecSdanielk1977     }
13326ab3a2ecSdanielk1977 
1333209bc522Sdrh     if( 0==((p->flags|pNew->flags) & (EP_TokenOnly|EP_Leaf)) ){
13346ab3a2ecSdanielk1977       /* Fill in the pNew->x.pSelect or pNew->x.pList member. */
13356ab3a2ecSdanielk1977       if( ExprHasProperty(p, EP_xIsSelect) ){
13363c19469cSdrh         pNew->x.pSelect = sqlite3SelectDup(db, p->x.pSelect, dupFlags);
13376ab3a2ecSdanielk1977       }else{
13383c19469cSdrh         pNew->x.pList = sqlite3ExprListDup(db, p->x.pList, dupFlags);
13396ab3a2ecSdanielk1977       }
13406ab3a2ecSdanielk1977     }
13416ab3a2ecSdanielk1977 
13426ab3a2ecSdanielk1977     /* Fill in pNew->pLeft and pNew->pRight. */
13434f9adee2Sdan     if( ExprHasProperty(pNew, EP_Reduced|EP_TokenOnly|EP_WinFunc) ){
13443c19469cSdrh       zAlloc += dupedExprNodeSize(p, dupFlags);
1345209bc522Sdrh       if( !ExprHasProperty(pNew, EP_TokenOnly|EP_Leaf) ){
13463c19469cSdrh         pNew->pLeft = p->pLeft ?
13473c19469cSdrh                       exprDup(db, p->pLeft, EXPRDUP_REDUCE, &zAlloc) : 0;
13483c19469cSdrh         pNew->pRight = p->pRight ?
13493c19469cSdrh                        exprDup(db, p->pRight, EXPRDUP_REDUCE, &zAlloc) : 0;
13506ab3a2ecSdanielk1977       }
135167a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
1352eda079cdSdrh       if( ExprHasProperty(p, EP_WinFunc) ){
1353eda079cdSdrh         pNew->y.pWin = sqlite3WindowDup(db, pNew, p->y.pWin);
1354eda079cdSdrh         assert( ExprHasProperty(pNew, EP_WinFunc) );
1355e2f781b9Sdan       }
135667a9b8edSdan #endif /* SQLITE_OMIT_WINDOWFUNC */
135753988068Sdrh       if( pzBuffer ){
135853988068Sdrh         *pzBuffer = zAlloc;
135953988068Sdrh       }
136053988068Sdrh     }else{
1361209bc522Sdrh       if( !ExprHasProperty(p, EP_TokenOnly|EP_Leaf) ){
13629854260bSdrh         if( pNew->op==TK_SELECT_COLUMN ){
13639854260bSdrh           pNew->pLeft = p->pLeft;
136447073f62Sdrh           assert( p->iColumn==0 || p->pRight==0 );
136547073f62Sdrh           assert( p->pRight==0  || p->pRight==p->pLeft );
13669854260bSdrh         }else{
13676ab3a2ecSdanielk1977           pNew->pLeft = sqlite3ExprDup(db, p->pLeft, 0);
13689854260bSdrh         }
13696ab3a2ecSdanielk1977         pNew->pRight = sqlite3ExprDup(db, p->pRight, 0);
13706ab3a2ecSdanielk1977       }
13716ab3a2ecSdanielk1977     }
13726ab3a2ecSdanielk1977   }
13736ab3a2ecSdanielk1977   return pNew;
13746ab3a2ecSdanielk1977 }
13756ab3a2ecSdanielk1977 
13766ab3a2ecSdanielk1977 /*
1377bfe31e7fSdan ** Create and return a deep copy of the object passed as the second
1378bfe31e7fSdan ** argument. If an OOM condition is encountered, NULL is returned
1379bfe31e7fSdan ** and the db->mallocFailed flag set.
1380bfe31e7fSdan */
1381eede6a53Sdan #ifndef SQLITE_OMIT_CTE
1382bfe31e7fSdan static With *withDup(sqlite3 *db, With *p){
13834e9119d9Sdan   With *pRet = 0;
13844e9119d9Sdan   if( p ){
1385d4de9f7bSdrh     sqlite3_int64 nByte = sizeof(*p) + sizeof(p->a[0]) * (p->nCte-1);
13864e9119d9Sdan     pRet = sqlite3DbMallocZero(db, nByte);
13874e9119d9Sdan     if( pRet ){
13884e9119d9Sdan       int i;
13894e9119d9Sdan       pRet->nCte = p->nCte;
13904e9119d9Sdan       for(i=0; i<p->nCte; i++){
13914e9119d9Sdan         pRet->a[i].pSelect = sqlite3SelectDup(db, p->a[i].pSelect, 0);
13924e9119d9Sdan         pRet->a[i].pCols = sqlite3ExprListDup(db, p->a[i].pCols, 0);
13934e9119d9Sdan         pRet->a[i].zName = sqlite3DbStrDup(db, p->a[i].zName);
13944e9119d9Sdan       }
13954e9119d9Sdan     }
13964e9119d9Sdan   }
13974e9119d9Sdan   return pRet;
13984e9119d9Sdan }
1399eede6a53Sdan #else
1400eede6a53Sdan # define withDup(x,y) 0
1401eede6a53Sdan #endif
14024e9119d9Sdan 
1403a8389975Sdrh #ifndef SQLITE_OMIT_WINDOWFUNC
1404a8389975Sdrh /*
1405a8389975Sdrh ** The gatherSelectWindows() procedure and its helper routine
1406a8389975Sdrh ** gatherSelectWindowsCallback() are used to scan all the expressions
1407a8389975Sdrh ** an a newly duplicated SELECT statement and gather all of the Window
1408a8389975Sdrh ** objects found there, assembling them onto the linked list at Select->pWin.
1409a8389975Sdrh */
1410a8389975Sdrh static int gatherSelectWindowsCallback(Walker *pWalker, Expr *pExpr){
14116ba7ab0dSdan   if( pExpr->op==TK_FUNCTION && ExprHasProperty(pExpr, EP_WinFunc) ){
141275b0821eSdan     Select *pSelect = pWalker->u.pSelect;
141375b0821eSdan     Window *pWin = pExpr->y.pWin;
141475b0821eSdan     assert( pWin );
14154f9adee2Sdan     assert( IsWindowFunc(pExpr) );
1416e0ae3f69Sdan     assert( pWin->ppThis==0 );
1417a3fcc000Sdan     sqlite3WindowLink(pSelect, pWin);
1418a8389975Sdrh   }
1419a8389975Sdrh   return WRC_Continue;
1420a8389975Sdrh }
1421a37b6a5eSdrh static int gatherSelectWindowsSelectCallback(Walker *pWalker, Select *p){
1422a37b6a5eSdrh   return p==pWalker->u.pSelect ? WRC_Continue : WRC_Prune;
1423a37b6a5eSdrh }
1424a8389975Sdrh static void gatherSelectWindows(Select *p){
1425a8389975Sdrh   Walker w;
1426a8389975Sdrh   w.xExprCallback = gatherSelectWindowsCallback;
1427a37b6a5eSdrh   w.xSelectCallback = gatherSelectWindowsSelectCallback;
1428a37b6a5eSdrh   w.xSelectCallback2 = 0;
14299c46c66cSdrh   w.pParse = 0;
1430a8389975Sdrh   w.u.pSelect = p;
1431a37b6a5eSdrh   sqlite3WalkSelect(&w, p);
1432a8389975Sdrh }
1433a8389975Sdrh #endif
1434a8389975Sdrh 
1435a8389975Sdrh 
1436a76b5dfcSdrh /*
1437ff78bd2fSdrh ** The following group of routines make deep copies of expressions,
1438ff78bd2fSdrh ** expression lists, ID lists, and select statements.  The copies can
1439ff78bd2fSdrh ** be deleted (by being passed to their respective ...Delete() routines)
1440ff78bd2fSdrh ** without effecting the originals.
1441ff78bd2fSdrh **
14424adee20fSdanielk1977 ** The expression list, ID, and source lists return by sqlite3ExprListDup(),
14434adee20fSdanielk1977 ** sqlite3IdListDup(), and sqlite3SrcListDup() can not be further expanded
1444ad3cab52Sdrh ** by subsequent calls to sqlite*ListAppend() routines.
1445ff78bd2fSdrh **
1446ad3cab52Sdrh ** Any tables that the SrcList might point to are not duplicated.
14476ab3a2ecSdanielk1977 **
1448b7916a78Sdrh ** The flags parameter contains a combination of the EXPRDUP_XXX flags.
14496ab3a2ecSdanielk1977 ** If the EXPRDUP_REDUCE flag is set, then the structure returned is a
14506ab3a2ecSdanielk1977 ** truncated version of the usual Expr structure that will be stored as
14516ab3a2ecSdanielk1977 ** part of the in-memory representation of the database schema.
1452ff78bd2fSdrh */
14536ab3a2ecSdanielk1977 Expr *sqlite3ExprDup(sqlite3 *db, Expr *p, int flags){
145472ea29d7Sdrh   assert( flags==0 || flags==EXPRDUP_REDUCE );
14553c19469cSdrh   return p ? exprDup(db, p, flags, 0) : 0;
1456ff78bd2fSdrh }
14576ab3a2ecSdanielk1977 ExprList *sqlite3ExprListDup(sqlite3 *db, ExprList *p, int flags){
1458ff78bd2fSdrh   ExprList *pNew;
1459145716b3Sdrh   struct ExprList_item *pItem, *pOldItem;
1460ff78bd2fSdrh   int i;
1461b163748eSdrh   Expr *pPriorSelectCol = 0;
1462575fad65Sdrh   assert( db!=0 );
1463ff78bd2fSdrh   if( p==0 ) return 0;
146497258194Sdrh   pNew = sqlite3DbMallocRawNN(db, sqlite3DbMallocSize(db, p));
1465ff78bd2fSdrh   if( pNew==0 ) return 0;
1466a19543feSdrh   pNew->nExpr = p->nExpr;
146743606175Sdrh   pItem = pNew->a;
1468145716b3Sdrh   pOldItem = p->a;
1469145716b3Sdrh   for(i=0; i<p->nExpr; i++, pItem++, pOldItem++){
14706ab3a2ecSdanielk1977     Expr *pOldExpr = pOldItem->pExpr;
147147073f62Sdrh     Expr *pNewExpr;
1472b5526ea6Sdrh     pItem->pExpr = sqlite3ExprDup(db, pOldExpr, flags);
147347073f62Sdrh     if( pOldExpr
147447073f62Sdrh      && pOldExpr->op==TK_SELECT_COLUMN
147547073f62Sdrh      && (pNewExpr = pItem->pExpr)!=0
147647073f62Sdrh     ){
147747073f62Sdrh       assert( pNewExpr->iColumn==0 || i>0 );
147847073f62Sdrh       if( pNewExpr->iColumn==0 ){
147947073f62Sdrh         assert( pOldExpr->pLeft==pOldExpr->pRight );
1480b163748eSdrh         pPriorSelectCol = pNewExpr->pLeft = pNewExpr->pRight;
1481b163748eSdrh       }else{
1482b163748eSdrh         assert( i>0 );
1483b163748eSdrh         assert( pItem[-1].pExpr!=0 );
1484b163748eSdrh         assert( pNewExpr->iColumn==pItem[-1].pExpr->iColumn+1 );
1485b163748eSdrh         assert( pPriorSelectCol==pItem[-1].pExpr->pLeft );
1486b163748eSdrh         pNewExpr->pLeft = pPriorSelectCol;
148747073f62Sdrh       }
148847073f62Sdrh     }
148941cee668Sdrh     pItem->zEName = sqlite3DbStrDup(db, pOldItem->zEName);
14906e11892dSdan     pItem->sortFlags = pOldItem->sortFlags;
1491cbb9da33Sdrh     pItem->eEName = pOldItem->eEName;
14923e7bc9caSdrh     pItem->done = 0;
1493ae8e45cbSdan     pItem->bNulls = pOldItem->bNulls;
149424e25d32Sdan     pItem->bSorterRef = pOldItem->bSorterRef;
1495c2acc4e4Sdrh     pItem->u = pOldItem->u;
1496ff78bd2fSdrh   }
1497ff78bd2fSdrh   return pNew;
1498ff78bd2fSdrh }
149993758c8dSdanielk1977 
150093758c8dSdanielk1977 /*
150193758c8dSdanielk1977 ** If cursors, triggers, views and subqueries are all omitted from
150293758c8dSdanielk1977 ** the build, then none of the following routines, except for
150393758c8dSdanielk1977 ** sqlite3SelectDup(), can be called. sqlite3SelectDup() is sometimes
150493758c8dSdanielk1977 ** called with a NULL argument.
150593758c8dSdanielk1977 */
15066a67fe8eSdanielk1977 #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_TRIGGER) \
15076a67fe8eSdanielk1977  || !defined(SQLITE_OMIT_SUBQUERY)
15086ab3a2ecSdanielk1977 SrcList *sqlite3SrcListDup(sqlite3 *db, SrcList *p, int flags){
1509ad3cab52Sdrh   SrcList *pNew;
1510ad3cab52Sdrh   int i;
1511113088ecSdrh   int nByte;
1512575fad65Sdrh   assert( db!=0 );
1513ad3cab52Sdrh   if( p==0 ) return 0;
1514113088ecSdrh   nByte = sizeof(*p) + (p->nSrc>0 ? sizeof(p->a[0]) * (p->nSrc-1) : 0);
1515575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, nByte );
1516ad3cab52Sdrh   if( pNew==0 ) return 0;
15174305d103Sdrh   pNew->nSrc = pNew->nAlloc = p->nSrc;
1518ad3cab52Sdrh   for(i=0; i<p->nSrc; i++){
15194efc4754Sdrh     struct SrcList_item *pNewItem = &pNew->a[i];
15204efc4754Sdrh     struct SrcList_item *pOldItem = &p->a[i];
1521ed8a3bb1Sdrh     Table *pTab;
152241fb5cd1Sdan     pNewItem->pSchema = pOldItem->pSchema;
152317435752Sdrh     pNewItem->zDatabase = sqlite3DbStrDup(db, pOldItem->zDatabase);
152417435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
152517435752Sdrh     pNewItem->zAlias = sqlite3DbStrDup(db, pOldItem->zAlias);
15268a48b9c0Sdrh     pNewItem->fg = pOldItem->fg;
15274efc4754Sdrh     pNewItem->iCursor = pOldItem->iCursor;
15285b6a9ed4Sdrh     pNewItem->addrFillSub = pOldItem->addrFillSub;
15295b6a9ed4Sdrh     pNewItem->regReturn = pOldItem->regReturn;
15308a48b9c0Sdrh     if( pNewItem->fg.isIndexedBy ){
15318a48b9c0Sdrh       pNewItem->u1.zIndexedBy = sqlite3DbStrDup(db, pOldItem->u1.zIndexedBy);
15328a48b9c0Sdrh     }
15338a48b9c0Sdrh     pNewItem->pIBIndex = pOldItem->pIBIndex;
15348a48b9c0Sdrh     if( pNewItem->fg.isTabFunc ){
15358a48b9c0Sdrh       pNewItem->u1.pFuncArg =
15368a48b9c0Sdrh           sqlite3ExprListDup(db, pOldItem->u1.pFuncArg, flags);
15378a48b9c0Sdrh     }
1538ed8a3bb1Sdrh     pTab = pNewItem->pTab = pOldItem->pTab;
1539ed8a3bb1Sdrh     if( pTab ){
154079df7782Sdrh       pTab->nTabRef++;
1541a1cb183dSdanielk1977     }
15426ab3a2ecSdanielk1977     pNewItem->pSelect = sqlite3SelectDup(db, pOldItem->pSelect, flags);
15436ab3a2ecSdanielk1977     pNewItem->pOn = sqlite3ExprDup(db, pOldItem->pOn, flags);
154417435752Sdrh     pNewItem->pUsing = sqlite3IdListDup(db, pOldItem->pUsing);
15456c18b6e0Sdanielk1977     pNewItem->colUsed = pOldItem->colUsed;
1546ad3cab52Sdrh   }
1547ad3cab52Sdrh   return pNew;
1548ad3cab52Sdrh }
154917435752Sdrh IdList *sqlite3IdListDup(sqlite3 *db, IdList *p){
1550ff78bd2fSdrh   IdList *pNew;
1551ff78bd2fSdrh   int i;
1552575fad65Sdrh   assert( db!=0 );
1553ff78bd2fSdrh   if( p==0 ) return 0;
1554575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, sizeof(*pNew) );
1555ff78bd2fSdrh   if( pNew==0 ) return 0;
15566c535158Sdrh   pNew->nId = p->nId;
1557575fad65Sdrh   pNew->a = sqlite3DbMallocRawNN(db, p->nId*sizeof(p->a[0]) );
1558d5d56523Sdanielk1977   if( pNew->a==0 ){
1559dbd6a7dcSdrh     sqlite3DbFreeNN(db, pNew);
1560d5d56523Sdanielk1977     return 0;
1561d5d56523Sdanielk1977   }
15626c535158Sdrh   /* Note that because the size of the allocation for p->a[] is not
15636c535158Sdrh   ** necessarily a power of two, sqlite3IdListAppend() may not be called
15646c535158Sdrh   ** on the duplicate created by this function. */
1565ff78bd2fSdrh   for(i=0; i<p->nId; i++){
15664efc4754Sdrh     struct IdList_item *pNewItem = &pNew->a[i];
15674efc4754Sdrh     struct IdList_item *pOldItem = &p->a[i];
156817435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
15694efc4754Sdrh     pNewItem->idx = pOldItem->idx;
1570ff78bd2fSdrh   }
1571ff78bd2fSdrh   return pNew;
1572ff78bd2fSdrh }
1573a7466205Sdan Select *sqlite3SelectDup(sqlite3 *db, Select *pDup, int flags){
1574a7466205Sdan   Select *pRet = 0;
1575a7466205Sdan   Select *pNext = 0;
1576a7466205Sdan   Select **pp = &pRet;
1577a7466205Sdan   Select *p;
1578a7466205Sdan 
1579575fad65Sdrh   assert( db!=0 );
1580a7466205Sdan   for(p=pDup; p; p=p->pPrior){
1581a7466205Sdan     Select *pNew = sqlite3DbMallocRawNN(db, sizeof(*p) );
1582a7466205Sdan     if( pNew==0 ) break;
1583b7916a78Sdrh     pNew->pEList = sqlite3ExprListDup(db, p->pEList, flags);
15846ab3a2ecSdanielk1977     pNew->pSrc = sqlite3SrcListDup(db, p->pSrc, flags);
15856ab3a2ecSdanielk1977     pNew->pWhere = sqlite3ExprDup(db, p->pWhere, flags);
15866ab3a2ecSdanielk1977     pNew->pGroupBy = sqlite3ExprListDup(db, p->pGroupBy, flags);
15876ab3a2ecSdanielk1977     pNew->pHaving = sqlite3ExprDup(db, p->pHaving, flags);
15886ab3a2ecSdanielk1977     pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, flags);
1589ff78bd2fSdrh     pNew->op = p->op;
1590a7466205Sdan     pNew->pNext = pNext;
1591a7466205Sdan     pNew->pPrior = 0;
15926ab3a2ecSdanielk1977     pNew->pLimit = sqlite3ExprDup(db, p->pLimit, flags);
159392b01d53Sdrh     pNew->iLimit = 0;
159492b01d53Sdrh     pNew->iOffset = 0;
15957d10d5a6Sdrh     pNew->selFlags = p->selFlags & ~SF_UsesEphemeral;
1596b9bb7c18Sdrh     pNew->addrOpenEphm[0] = -1;
1597b9bb7c18Sdrh     pNew->addrOpenEphm[1] = -1;
1598ec2da854Sdrh     pNew->nSelectRow = p->nSelectRow;
15994e9119d9Sdan     pNew->pWith = withDup(db, p->pWith);
160067a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
16012e362f97Sdan     pNew->pWin = 0;
1602c95f38d4Sdan     pNew->pWinDefn = sqlite3WindowListDup(db, p->pWinDefn);
16034780b9adSdan     if( p->pWin && db->mallocFailed==0 ) gatherSelectWindows(pNew);
160467a9b8edSdan #endif
1605fef37760Sdrh     pNew->selId = p->selId;
1606a7466205Sdan     *pp = pNew;
1607a7466205Sdan     pp = &pNew->pPrior;
1608a7466205Sdan     pNext = pNew;
1609a7466205Sdan   }
1610a7466205Sdan 
1611a7466205Sdan   return pRet;
1612ff78bd2fSdrh }
161393758c8dSdanielk1977 #else
16146ab3a2ecSdanielk1977 Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
161593758c8dSdanielk1977   assert( p==0 );
161693758c8dSdanielk1977   return 0;
161793758c8dSdanielk1977 }
161893758c8dSdanielk1977 #endif
1619ff78bd2fSdrh 
1620ff78bd2fSdrh 
1621ff78bd2fSdrh /*
1622a76b5dfcSdrh ** Add a new element to the end of an expression list.  If pList is
1623a76b5dfcSdrh ** initially NULL, then create a new expression list.
1624b7916a78Sdrh **
1625a19543feSdrh ** The pList argument must be either NULL or a pointer to an ExprList
1626a19543feSdrh ** obtained from a prior call to sqlite3ExprListAppend().  This routine
1627a19543feSdrh ** may not be used with an ExprList obtained from sqlite3ExprListDup().
1628a19543feSdrh ** Reason:  This routine assumes that the number of slots in pList->a[]
1629a19543feSdrh ** is a power of two.  That is true for sqlite3ExprListAppend() returns
1630a19543feSdrh ** but is not necessarily true from the return value of sqlite3ExprListDup().
1631a19543feSdrh **
1632b7916a78Sdrh ** If a memory allocation error occurs, the entire list is freed and
1633b7916a78Sdrh ** NULL is returned.  If non-NULL is returned, then it is guaranteed
1634b7916a78Sdrh ** that the new entry was successfully appended.
1635a76b5dfcSdrh */
163617435752Sdrh ExprList *sqlite3ExprListAppend(
163717435752Sdrh   Parse *pParse,          /* Parsing context */
163817435752Sdrh   ExprList *pList,        /* List to which to append. Might be NULL */
1639b7916a78Sdrh   Expr *pExpr             /* Expression to be appended. Might be NULL */
164017435752Sdrh ){
164143606175Sdrh   struct ExprList_item *pItem;
164217435752Sdrh   sqlite3 *db = pParse->db;
1643575fad65Sdrh   assert( db!=0 );
1644a76b5dfcSdrh   if( pList==0 ){
1645575fad65Sdrh     pList = sqlite3DbMallocRawNN(db, sizeof(ExprList) );
1646a76b5dfcSdrh     if( pList==0 ){
1647d5d56523Sdanielk1977       goto no_mem;
1648a76b5dfcSdrh     }
1649c263f7c4Sdrh     pList->nExpr = 0;
1650a19543feSdrh   }else if( (pList->nExpr & (pList->nExpr-1))==0 ){
165143606175Sdrh     ExprList *pNew;
165243606175Sdrh     pNew = sqlite3DbRealloc(db, pList,
16530aa3231fSdrh          sizeof(*pList)+(2*(sqlite3_int64)pList->nExpr-1)*sizeof(pList->a[0]));
165443606175Sdrh     if( pNew==0 ){
1655d5d56523Sdanielk1977       goto no_mem;
1656a76b5dfcSdrh     }
165743606175Sdrh     pList = pNew;
1658a76b5dfcSdrh   }
165943606175Sdrh   pItem = &pList->a[pList->nExpr++];
166041cee668Sdrh   assert( offsetof(struct ExprList_item,zEName)==sizeof(pItem->pExpr) );
1661a8b9793cSdrh   assert( offsetof(struct ExprList_item,pExpr)==0 );
166241cee668Sdrh   memset(&pItem->zEName,0,sizeof(*pItem)-offsetof(struct ExprList_item,zEName));
1663e94ddc9eSdanielk1977   pItem->pExpr = pExpr;
1664a76b5dfcSdrh   return pList;
1665d5d56523Sdanielk1977 
1666d5d56523Sdanielk1977 no_mem:
1667d5d56523Sdanielk1977   /* Avoid leaking memory if malloc has failed. */
1668633e6d57Sdrh   sqlite3ExprDelete(db, pExpr);
1669633e6d57Sdrh   sqlite3ExprListDelete(db, pList);
1670d5d56523Sdanielk1977   return 0;
1671a76b5dfcSdrh }
1672a76b5dfcSdrh 
1673a76b5dfcSdrh /*
16748762ec19Sdrh ** pColumns and pExpr form a vector assignment which is part of the SET
16758762ec19Sdrh ** clause of an UPDATE statement.  Like this:
1676a1251bc4Sdrh **
1677a1251bc4Sdrh **        (a,b,c) = (expr1,expr2,expr3)
1678a1251bc4Sdrh ** Or:    (a,b,c) = (SELECT x,y,z FROM ....)
1679a1251bc4Sdrh **
1680a1251bc4Sdrh ** For each term of the vector assignment, append new entries to the
1681b67343d0Sdrh ** expression list pList.  In the case of a subquery on the RHS, append
1682a1251bc4Sdrh ** TK_SELECT_COLUMN expressions.
1683a1251bc4Sdrh */
1684a1251bc4Sdrh ExprList *sqlite3ExprListAppendVector(
1685a1251bc4Sdrh   Parse *pParse,         /* Parsing context */
1686a1251bc4Sdrh   ExprList *pList,       /* List to which to append. Might be NULL */
1687a1251bc4Sdrh   IdList *pColumns,      /* List of names of LHS of the assignment */
1688a1251bc4Sdrh   Expr *pExpr            /* Vector expression to be appended. Might be NULL */
1689a1251bc4Sdrh ){
1690a1251bc4Sdrh   sqlite3 *db = pParse->db;
1691a1251bc4Sdrh   int n;
1692a1251bc4Sdrh   int i;
169366860af3Sdrh   int iFirst = pList ? pList->nExpr : 0;
1694321e828dSdrh   /* pColumns can only be NULL due to an OOM but an OOM will cause an
1695321e828dSdrh   ** exit prior to this routine being invoked */
1696321e828dSdrh   if( NEVER(pColumns==0) ) goto vector_append_error;
1697a1251bc4Sdrh   if( pExpr==0 ) goto vector_append_error;
1698966e2911Sdrh 
1699966e2911Sdrh   /* If the RHS is a vector, then we can immediately check to see that
1700966e2911Sdrh   ** the size of the RHS and LHS match.  But if the RHS is a SELECT,
1701966e2911Sdrh   ** wildcards ("*") in the result set of the SELECT must be expanded before
1702966e2911Sdrh   ** we can do the size check, so defer the size check until code generation.
1703966e2911Sdrh   */
1704966e2911Sdrh   if( pExpr->op!=TK_SELECT && pColumns->nId!=(n=sqlite3ExprVectorSize(pExpr)) ){
1705a1251bc4Sdrh     sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
1706a1251bc4Sdrh                     pColumns->nId, n);
1707a1251bc4Sdrh     goto vector_append_error;
1708a1251bc4Sdrh   }
1709966e2911Sdrh 
1710966e2911Sdrh   for(i=0; i<pColumns->nId; i++){
1711a1251bc4Sdrh     Expr *pSubExpr = sqlite3ExprForVectorField(pParse, pExpr, i);
1712554a9dc7Sdrh     assert( pSubExpr!=0 || db->mallocFailed );
1713554a9dc7Sdrh     assert( pSubExpr==0 || pSubExpr->iTable==0 );
1714554a9dc7Sdrh     if( pSubExpr==0 ) continue;
1715554a9dc7Sdrh     pSubExpr->iTable = pColumns->nId;
1716a1251bc4Sdrh     pList = sqlite3ExprListAppend(pParse, pList, pSubExpr);
1717a1251bc4Sdrh     if( pList ){
171866860af3Sdrh       assert( pList->nExpr==iFirst+i+1 );
171941cee668Sdrh       pList->a[pList->nExpr-1].zEName = pColumns->a[i].zName;
1720a1251bc4Sdrh       pColumns->a[i].zName = 0;
1721a1251bc4Sdrh     }
1722a1251bc4Sdrh   }
1723966e2911Sdrh 
1724ffe28059Sdrh   if( !db->mallocFailed && pExpr->op==TK_SELECT && ALWAYS(pList!=0) ){
1725966e2911Sdrh     Expr *pFirst = pList->a[iFirst].pExpr;
1726f4dd26c5Sdrh     assert( pFirst!=0 );
1727966e2911Sdrh     assert( pFirst->op==TK_SELECT_COLUMN );
1728966e2911Sdrh 
1729966e2911Sdrh     /* Store the SELECT statement in pRight so it will be deleted when
1730966e2911Sdrh     ** sqlite3ExprListDelete() is called */
1731966e2911Sdrh     pFirst->pRight = pExpr;
1732a1251bc4Sdrh     pExpr = 0;
1733966e2911Sdrh 
1734966e2911Sdrh     /* Remember the size of the LHS in iTable so that we can check that
1735966e2911Sdrh     ** the RHS and LHS sizes match during code generation. */
1736966e2911Sdrh     pFirst->iTable = pColumns->nId;
1737a1251bc4Sdrh   }
1738a1251bc4Sdrh 
1739a1251bc4Sdrh vector_append_error:
17408e34e406Sdrh   sqlite3ExprUnmapAndDelete(pParse, pExpr);
1741a1251bc4Sdrh   sqlite3IdListDelete(db, pColumns);
1742a1251bc4Sdrh   return pList;
1743a1251bc4Sdrh }
1744a1251bc4Sdrh 
1745a1251bc4Sdrh /*
1746bc622bc0Sdrh ** Set the sort order for the last element on the given ExprList.
1747bc622bc0Sdrh */
17486e11892dSdan void sqlite3ExprListSetSortOrder(ExprList *p, int iSortOrder, int eNulls){
17499105fd51Sdan   struct ExprList_item *pItem;
1750bc622bc0Sdrh   if( p==0 ) return;
1751bc622bc0Sdrh   assert( p->nExpr>0 );
17526e11892dSdan 
17536e11892dSdan   assert( SQLITE_SO_UNDEFINED<0 && SQLITE_SO_ASC==0 && SQLITE_SO_DESC>0 );
17546e11892dSdan   assert( iSortOrder==SQLITE_SO_UNDEFINED
17556e11892dSdan        || iSortOrder==SQLITE_SO_ASC
17566e11892dSdan        || iSortOrder==SQLITE_SO_DESC
17576e11892dSdan   );
17586e11892dSdan   assert( eNulls==SQLITE_SO_UNDEFINED
17596e11892dSdan        || eNulls==SQLITE_SO_ASC
17606e11892dSdan        || eNulls==SQLITE_SO_DESC
17616e11892dSdan   );
17626e11892dSdan 
17639105fd51Sdan   pItem = &p->a[p->nExpr-1];
17649105fd51Sdan   assert( pItem->bNulls==0 );
17659105fd51Sdan   if( iSortOrder==SQLITE_SO_UNDEFINED ){
17669105fd51Sdan     iSortOrder = SQLITE_SO_ASC;
1767bc622bc0Sdrh   }
17689105fd51Sdan   pItem->sortFlags = (u8)iSortOrder;
17699105fd51Sdan 
17709105fd51Sdan   if( eNulls!=SQLITE_SO_UNDEFINED ){
17719105fd51Sdan     pItem->bNulls = 1;
17729105fd51Sdan     if( iSortOrder!=eNulls ){
17739105fd51Sdan       pItem->sortFlags |= KEYINFO_ORDER_BIGNULL;
17749105fd51Sdan     }
1775bc622bc0Sdrh   }
1776bc622bc0Sdrh }
1777bc622bc0Sdrh 
1778bc622bc0Sdrh /*
177941cee668Sdrh ** Set the ExprList.a[].zEName element of the most recently added item
1780b7916a78Sdrh ** on the expression list.
1781b7916a78Sdrh **
1782b7916a78Sdrh ** pList might be NULL following an OOM error.  But pName should never be
1783b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1784b7916a78Sdrh ** is set.
1785b7916a78Sdrh */
1786b7916a78Sdrh void sqlite3ExprListSetName(
1787b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1788b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
1789b7916a78Sdrh   Token *pName,           /* Name to be added */
1790b7916a78Sdrh   int dequote             /* True to cause the name to be dequoted */
1791b7916a78Sdrh ){
1792b7916a78Sdrh   assert( pList!=0 || pParse->db->mallocFailed!=0 );
17932d99f957Sdrh   assert( pParse->eParseMode!=PARSE_MODE_UNMAP || dequote==0 );
1794b7916a78Sdrh   if( pList ){
1795b7916a78Sdrh     struct ExprList_item *pItem;
1796b7916a78Sdrh     assert( pList->nExpr>0 );
1797b7916a78Sdrh     pItem = &pList->a[pList->nExpr-1];
179841cee668Sdrh     assert( pItem->zEName==0 );
1799c4938ea2Sdrh     assert( pItem->eEName==ENAME_NAME );
180041cee668Sdrh     pItem->zEName = sqlite3DbStrNDup(pParse->db, pName->z, pName->n);
180185f2c76cSdan     if( dequote ){
180285f2c76cSdan       /* If dequote==0, then pName->z does not point to part of a DDL
180385f2c76cSdan       ** statement handled by the parser. And so no token need be added
180485f2c76cSdan       ** to the token-map.  */
180585f2c76cSdan       sqlite3Dequote(pItem->zEName);
1806c9461eccSdan       if( IN_RENAME_OBJECT ){
180741cee668Sdrh         sqlite3RenameTokenMap(pParse, (void*)pItem->zEName, pName);
18085be60c55Sdan       }
1809b7916a78Sdrh     }
1810b7916a78Sdrh   }
181185f2c76cSdan }
1812b7916a78Sdrh 
1813b7916a78Sdrh /*
1814b7916a78Sdrh ** Set the ExprList.a[].zSpan element of the most recently added item
1815b7916a78Sdrh ** on the expression list.
1816b7916a78Sdrh **
1817b7916a78Sdrh ** pList might be NULL following an OOM error.  But pSpan should never be
1818b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1819b7916a78Sdrh ** is set.
1820b7916a78Sdrh */
1821b7916a78Sdrh void sqlite3ExprListSetSpan(
1822b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1823b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
18241be266baSdrh   const char *zStart,     /* Start of the span */
18251be266baSdrh   const char *zEnd        /* End of the span */
1826b7916a78Sdrh ){
1827b7916a78Sdrh   sqlite3 *db = pParse->db;
1828b7916a78Sdrh   assert( pList!=0 || db->mallocFailed!=0 );
1829b7916a78Sdrh   if( pList ){
1830b7916a78Sdrh     struct ExprList_item *pItem = &pList->a[pList->nExpr-1];
1831b7916a78Sdrh     assert( pList->nExpr>0 );
1832cbb9da33Sdrh     if( pItem->zEName==0 ){
1833cbb9da33Sdrh       pItem->zEName = sqlite3DbSpanDup(db, zStart, zEnd);
1834cbb9da33Sdrh       pItem->eEName = ENAME_SPAN;
1835cbb9da33Sdrh     }
1836b7916a78Sdrh   }
1837b7916a78Sdrh }
1838b7916a78Sdrh 
1839b7916a78Sdrh /*
18407a15a4beSdanielk1977 ** If the expression list pEList contains more than iLimit elements,
18417a15a4beSdanielk1977 ** leave an error message in pParse.
18427a15a4beSdanielk1977 */
18437a15a4beSdanielk1977 void sqlite3ExprListCheckLength(
18447a15a4beSdanielk1977   Parse *pParse,
18457a15a4beSdanielk1977   ExprList *pEList,
18467a15a4beSdanielk1977   const char *zObject
18477a15a4beSdanielk1977 ){
1848b1a6c3c1Sdrh   int mx = pParse->db->aLimit[SQLITE_LIMIT_COLUMN];
1849c5499befSdrh   testcase( pEList && pEList->nExpr==mx );
1850c5499befSdrh   testcase( pEList && pEList->nExpr==mx+1 );
1851b1a6c3c1Sdrh   if( pEList && pEList->nExpr>mx ){
18527a15a4beSdanielk1977     sqlite3ErrorMsg(pParse, "too many columns in %s", zObject);
18537a15a4beSdanielk1977   }
18547a15a4beSdanielk1977 }
18557a15a4beSdanielk1977 
18567a15a4beSdanielk1977 /*
1857a76b5dfcSdrh ** Delete an entire expression list.
1858a76b5dfcSdrh */
1859affa855cSdrh static SQLITE_NOINLINE void exprListDeleteNN(sqlite3 *db, ExprList *pList){
1860ac48b751Sdrh   int i = pList->nExpr;
1861ac48b751Sdrh   struct ExprList_item *pItem =  pList->a;
1862ac48b751Sdrh   assert( pList->nExpr>0 );
1863ac48b751Sdrh   do{
1864633e6d57Sdrh     sqlite3ExprDelete(db, pItem->pExpr);
186541cee668Sdrh     sqlite3DbFree(db, pItem->zEName);
1866ac48b751Sdrh     pItem++;
1867ac48b751Sdrh   }while( --i>0 );
1868dbd6a7dcSdrh   sqlite3DbFreeNN(db, pList);
1869a76b5dfcSdrh }
1870affa855cSdrh void sqlite3ExprListDelete(sqlite3 *db, ExprList *pList){
1871affa855cSdrh   if( pList ) exprListDeleteNN(db, pList);
1872affa855cSdrh }
1873a76b5dfcSdrh 
1874a76b5dfcSdrh /*
18752308ed38Sdrh ** Return the bitwise-OR of all Expr.flags fields in the given
18762308ed38Sdrh ** ExprList.
1877885a5b03Sdrh */
18782308ed38Sdrh u32 sqlite3ExprListFlags(const ExprList *pList){
1879885a5b03Sdrh   int i;
18802308ed38Sdrh   u32 m = 0;
1881508e2d00Sdrh   assert( pList!=0 );
1882885a5b03Sdrh   for(i=0; i<pList->nExpr; i++){
1883d0c73053Sdrh      Expr *pExpr = pList->a[i].pExpr;
1884de845c2fSdrh      assert( pExpr!=0 );
1885de845c2fSdrh      m |= pExpr->flags;
1886885a5b03Sdrh   }
18872308ed38Sdrh   return m;
1888885a5b03Sdrh }
1889885a5b03Sdrh 
1890885a5b03Sdrh /*
18917e6f980bSdrh ** This is a SELECT-node callback for the expression walker that
18927e6f980bSdrh ** always "fails".  By "fail" in this case, we mean set
18937e6f980bSdrh ** pWalker->eCode to zero and abort.
18947e6f980bSdrh **
18957e6f980bSdrh ** This callback is used by multiple expression walkers.
18967e6f980bSdrh */
18977e6f980bSdrh int sqlite3SelectWalkFail(Walker *pWalker, Select *NotUsed){
18987e6f980bSdrh   UNUSED_PARAMETER(NotUsed);
18997e6f980bSdrh   pWalker->eCode = 0;
19007e6f980bSdrh   return WRC_Abort;
19017e6f980bSdrh }
19027e6f980bSdrh 
19037e6f980bSdrh /*
19040cbec59cSdrh ** Check the input string to see if it is "true" or "false" (in any case).
19050cbec59cSdrh **
19060cbec59cSdrh **       If the string is....           Return
19070cbec59cSdrh **         "true"                         EP_IsTrue
19080cbec59cSdrh **         "false"                        EP_IsFalse
19090cbec59cSdrh **         anything else                  0
19100cbec59cSdrh */
19110cbec59cSdrh u32 sqlite3IsTrueOrFalse(const char *zIn){
19120cbec59cSdrh   if( sqlite3StrICmp(zIn, "true")==0  ) return EP_IsTrue;
19130cbec59cSdrh   if( sqlite3StrICmp(zIn, "false")==0 ) return EP_IsFalse;
19140cbec59cSdrh   return 0;
19150cbec59cSdrh }
19160cbec59cSdrh 
19170cbec59cSdrh 
19180cbec59cSdrh /*
1919171d16bbSdrh ** If the input expression is an ID with the name "true" or "false"
192096acafbeSdrh ** then convert it into an TK_TRUEFALSE term.  Return non-zero if
192196acafbeSdrh ** the conversion happened, and zero if the expression is unaltered.
1922171d16bbSdrh */
1923171d16bbSdrh int sqlite3ExprIdToTrueFalse(Expr *pExpr){
19240cbec59cSdrh   u32 v;
1925171d16bbSdrh   assert( pExpr->op==TK_ID || pExpr->op==TK_STRING );
192651d35b0fSdrh   if( !ExprHasProperty(pExpr, EP_Quoted)
19270cbec59cSdrh    && (v = sqlite3IsTrueOrFalse(pExpr->u.zToken))!=0
1928171d16bbSdrh   ){
1929171d16bbSdrh     pExpr->op = TK_TRUEFALSE;
19300cbec59cSdrh     ExprSetProperty(pExpr, v);
1931171d16bbSdrh     return 1;
1932171d16bbSdrh   }
1933171d16bbSdrh   return 0;
1934171d16bbSdrh }
1935171d16bbSdrh 
193643c4ac8bSdrh /*
193796acafbeSdrh ** The argument must be a TK_TRUEFALSE Expr node.  Return 1 if it is TRUE
193843c4ac8bSdrh ** and 0 if it is FALSE.
193943c4ac8bSdrh */
194096acafbeSdrh int sqlite3ExprTruthValue(const Expr *pExpr){
19416ece353fSdan   pExpr = sqlite3ExprSkipCollate((Expr*)pExpr);
194243c4ac8bSdrh   assert( pExpr->op==TK_TRUEFALSE );
194343c4ac8bSdrh   assert( sqlite3StrICmp(pExpr->u.zToken,"true")==0
194443c4ac8bSdrh        || sqlite3StrICmp(pExpr->u.zToken,"false")==0 );
194543c4ac8bSdrh   return pExpr->u.zToken[4]==0;
194643c4ac8bSdrh }
194743c4ac8bSdrh 
194817180fcaSdrh /*
194917180fcaSdrh ** If pExpr is an AND or OR expression, try to simplify it by eliminating
195017180fcaSdrh ** terms that are always true or false.  Return the simplified expression.
195117180fcaSdrh ** Or return the original expression if no simplification is possible.
195217180fcaSdrh **
195317180fcaSdrh ** Examples:
195417180fcaSdrh **
195517180fcaSdrh **     (x<10) AND true                =>   (x<10)
195617180fcaSdrh **     (x<10) AND false               =>   false
195717180fcaSdrh **     (x<10) AND (y=22 OR false)     =>   (x<10) AND (y=22)
195817180fcaSdrh **     (x<10) AND (y=22 OR true)      =>   (x<10)
195917180fcaSdrh **     (y=22) OR true                 =>   true
196017180fcaSdrh */
196117180fcaSdrh Expr *sqlite3ExprSimplifiedAndOr(Expr *pExpr){
196217180fcaSdrh   assert( pExpr!=0 );
196317180fcaSdrh   if( pExpr->op==TK_AND || pExpr->op==TK_OR ){
196417180fcaSdrh     Expr *pRight = sqlite3ExprSimplifiedAndOr(pExpr->pRight);
196517180fcaSdrh     Expr *pLeft = sqlite3ExprSimplifiedAndOr(pExpr->pLeft);
196617180fcaSdrh     if( ExprAlwaysTrue(pLeft) || ExprAlwaysFalse(pRight) ){
196717180fcaSdrh       pExpr = pExpr->op==TK_AND ? pRight : pLeft;
196817180fcaSdrh     }else if( ExprAlwaysTrue(pRight) || ExprAlwaysFalse(pLeft) ){
196917180fcaSdrh       pExpr = pExpr->op==TK_AND ? pLeft : pRight;
197017180fcaSdrh     }
197117180fcaSdrh   }
197217180fcaSdrh   return pExpr;
197317180fcaSdrh }
197417180fcaSdrh 
1975171d16bbSdrh 
1976171d16bbSdrh /*
1977059b2d50Sdrh ** These routines are Walker callbacks used to check expressions to
1978059b2d50Sdrh ** see if they are "constant" for some definition of constant.  The
1979059b2d50Sdrh ** Walker.eCode value determines the type of "constant" we are looking
1980059b2d50Sdrh ** for.
198173b211abSdrh **
19827d10d5a6Sdrh ** These callback routines are used to implement the following:
1983626a879aSdrh **
1984059b2d50Sdrh **     sqlite3ExprIsConstant()                  pWalker->eCode==1
1985059b2d50Sdrh **     sqlite3ExprIsConstantNotJoin()           pWalker->eCode==2
1986fcb9f4f3Sdrh **     sqlite3ExprIsTableConstant()             pWalker->eCode==3
1987059b2d50Sdrh **     sqlite3ExprIsConstantOrFunction()        pWalker->eCode==4 or 5
198887abf5c0Sdrh **
1989059b2d50Sdrh ** In all cases, the callbacks set Walker.eCode=0 and abort if the expression
1990059b2d50Sdrh ** is found to not be a constant.
199187abf5c0Sdrh **
1992014fff20Sdrh ** The sqlite3ExprIsConstantOrFunction() is used for evaluating DEFAULT
1993014fff20Sdrh ** expressions in a CREATE TABLE statement.  The Walker.eCode value is 5
19941e32bed3Sdrh ** when parsing an existing schema out of the sqlite_schema table and 4
1995014fff20Sdrh ** when processing a new CREATE TABLE statement.  A bound parameter raises
1996014fff20Sdrh ** an error for new statements, but is silently converted
19971e32bed3Sdrh ** to NULL for existing schemas.  This allows sqlite_schema tables that
1998feada2dfSdrh ** contain a bound parameter because they were generated by older versions
1999feada2dfSdrh ** of SQLite to be parsed by newer versions of SQLite without raising a
2000feada2dfSdrh ** malformed schema error.
2001626a879aSdrh */
20027d10d5a6Sdrh static int exprNodeIsConstant(Walker *pWalker, Expr *pExpr){
2003626a879aSdrh 
2004059b2d50Sdrh   /* If pWalker->eCode is 2 then any term of the expression that comes from
2005059b2d50Sdrh   ** the ON or USING clauses of a left join disqualifies the expression
20060a168377Sdrh   ** from being considered constant. */
2007059b2d50Sdrh   if( pWalker->eCode==2 && ExprHasProperty(pExpr, EP_FromJoin) ){
2008059b2d50Sdrh     pWalker->eCode = 0;
20097d10d5a6Sdrh     return WRC_Abort;
20100a168377Sdrh   }
20110a168377Sdrh 
2012626a879aSdrh   switch( pExpr->op ){
2013eb55bd2fSdrh     /* Consider functions to be constant if all their arguments are constant
2014059b2d50Sdrh     ** and either pWalker->eCode==4 or 5 or the function has the
2015059b2d50Sdrh     ** SQLITE_FUNC_CONST flag. */
2016eb55bd2fSdrh     case TK_FUNCTION:
2017a634c9e6Sdrh       if( (pWalker->eCode>=4 || ExprHasProperty(pExpr,EP_ConstFunc))
2018a634c9e6Sdrh        && !ExprHasProperty(pExpr, EP_WinFunc)
2019a634c9e6Sdrh       ){
2020014fff20Sdrh         if( pWalker->eCode==5 ) ExprSetProperty(pExpr, EP_FromDDL);
2021b1fba286Sdrh         return WRC_Continue;
2022059b2d50Sdrh       }else{
2023059b2d50Sdrh         pWalker->eCode = 0;
2024059b2d50Sdrh         return WRC_Abort;
2025b1fba286Sdrh       }
2026626a879aSdrh     case TK_ID:
2027171d16bbSdrh       /* Convert "true" or "false" in a DEFAULT clause into the
2028171d16bbSdrh       ** appropriate TK_TRUEFALSE operator */
2029e39ef31cSdrh       if( sqlite3ExprIdToTrueFalse(pExpr) ){
2030171d16bbSdrh         return WRC_Prune;
2031171d16bbSdrh       }
203208b92086Sdrh       /* no break */ deliberate_fall_through
2033626a879aSdrh     case TK_COLUMN:
2034626a879aSdrh     case TK_AGG_FUNCTION:
203513449892Sdrh     case TK_AGG_COLUMN:
2036c5499befSdrh       testcase( pExpr->op==TK_ID );
2037c5499befSdrh       testcase( pExpr->op==TK_COLUMN );
2038c5499befSdrh       testcase( pExpr->op==TK_AGG_FUNCTION );
2039c5499befSdrh       testcase( pExpr->op==TK_AGG_COLUMN );
204007aded63Sdrh       if( ExprHasProperty(pExpr, EP_FixedCol) && pWalker->eCode!=2 ){
2041efad2e23Sdrh         return WRC_Continue;
2042efad2e23Sdrh       }
2043059b2d50Sdrh       if( pWalker->eCode==3 && pExpr->iTable==pWalker->u.iCur ){
2044059b2d50Sdrh         return WRC_Continue;
2045f43ce0b4Sdrh       }
204608b92086Sdrh       /* no break */ deliberate_fall_through
2047f43ce0b4Sdrh     case TK_IF_NULL_ROW:
20486e341b93Sdrh     case TK_REGISTER:
204974e0d966Sdrh     case TK_DOT:
20509916048bSdrh       testcase( pExpr->op==TK_REGISTER );
2051f43ce0b4Sdrh       testcase( pExpr->op==TK_IF_NULL_ROW );
205274e0d966Sdrh       testcase( pExpr->op==TK_DOT );
2053059b2d50Sdrh       pWalker->eCode = 0;
20547d10d5a6Sdrh       return WRC_Abort;
2055feada2dfSdrh     case TK_VARIABLE:
2056059b2d50Sdrh       if( pWalker->eCode==5 ){
2057feada2dfSdrh         /* Silently convert bound parameters that appear inside of CREATE
2058feada2dfSdrh         ** statements into a NULL when parsing the CREATE statement text out
20591e32bed3Sdrh         ** of the sqlite_schema table */
2060feada2dfSdrh         pExpr->op = TK_NULL;
2061059b2d50Sdrh       }else if( pWalker->eCode==4 ){
2062feada2dfSdrh         /* A bound parameter in a CREATE statement that originates from
2063feada2dfSdrh         ** sqlite3_prepare() causes an error */
2064059b2d50Sdrh         pWalker->eCode = 0;
2065feada2dfSdrh         return WRC_Abort;
2066feada2dfSdrh       }
206708b92086Sdrh       /* no break */ deliberate_fall_through
2068626a879aSdrh     default:
20696e341b93Sdrh       testcase( pExpr->op==TK_SELECT ); /* sqlite3SelectWalkFail() disallows */
20706e341b93Sdrh       testcase( pExpr->op==TK_EXISTS ); /* sqlite3SelectWalkFail() disallows */
20717d10d5a6Sdrh       return WRC_Continue;
2072626a879aSdrh   }
2073626a879aSdrh }
2074059b2d50Sdrh static int exprIsConst(Expr *p, int initFlag, int iCur){
20757d10d5a6Sdrh   Walker w;
2076059b2d50Sdrh   w.eCode = initFlag;
20777d10d5a6Sdrh   w.xExprCallback = exprNodeIsConstant;
20787e6f980bSdrh   w.xSelectCallback = sqlite3SelectWalkFail;
2079979dd1beSdrh #ifdef SQLITE_DEBUG
2080979dd1beSdrh   w.xSelectCallback2 = sqlite3SelectWalkAssert2;
2081979dd1beSdrh #endif
2082059b2d50Sdrh   w.u.iCur = iCur;
20837d10d5a6Sdrh   sqlite3WalkExpr(&w, p);
2084059b2d50Sdrh   return w.eCode;
20857d10d5a6Sdrh }
2086626a879aSdrh 
2087626a879aSdrh /*
2088059b2d50Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
2089eb55bd2fSdrh ** and 0 if it involves variables or function calls.
20902398937bSdrh **
20912398937bSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
20922398937bSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
20932398937bSdrh ** a constant.
2094fef5208cSdrh */
20954adee20fSdanielk1977 int sqlite3ExprIsConstant(Expr *p){
2096059b2d50Sdrh   return exprIsConst(p, 1, 0);
2097fef5208cSdrh }
2098fef5208cSdrh 
2099fef5208cSdrh /*
210007aded63Sdrh ** Walk an expression tree.  Return non-zero if
210107aded63Sdrh **
210207aded63Sdrh **   (1) the expression is constant, and
210307aded63Sdrh **   (2) the expression does originate in the ON or USING clause
210407aded63Sdrh **       of a LEFT JOIN, and
210507aded63Sdrh **   (3) the expression does not contain any EP_FixedCol TK_COLUMN
210607aded63Sdrh **       operands created by the constant propagation optimization.
210707aded63Sdrh **
210807aded63Sdrh ** When this routine returns true, it indicates that the expression
210907aded63Sdrh ** can be added to the pParse->pConstExpr list and evaluated once when
21109b258c54Sdrh ** the prepared statement starts up.  See sqlite3ExprCodeRunJustOnce().
21110a168377Sdrh */
21120a168377Sdrh int sqlite3ExprIsConstantNotJoin(Expr *p){
2113059b2d50Sdrh   return exprIsConst(p, 2, 0);
21140a168377Sdrh }
21150a168377Sdrh 
21160a168377Sdrh /*
2117fcb9f4f3Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
2118059b2d50Sdrh ** for any single row of the table with cursor iCur.  In other words, the
2119059b2d50Sdrh ** expression must not refer to any non-deterministic function nor any
2120059b2d50Sdrh ** table other than iCur.
2121059b2d50Sdrh */
2122059b2d50Sdrh int sqlite3ExprIsTableConstant(Expr *p, int iCur){
2123059b2d50Sdrh   return exprIsConst(p, 3, iCur);
2124059b2d50Sdrh }
2125059b2d50Sdrh 
2126ab31a845Sdan 
2127ab31a845Sdan /*
2128ab31a845Sdan ** sqlite3WalkExpr() callback used by sqlite3ExprIsConstantOrGroupBy().
2129ab31a845Sdan */
2130ab31a845Sdan static int exprNodeIsConstantOrGroupBy(Walker *pWalker, Expr *pExpr){
2131ab31a845Sdan   ExprList *pGroupBy = pWalker->u.pGroupBy;
2132ab31a845Sdan   int i;
2133ab31a845Sdan 
2134ab31a845Sdan   /* Check if pExpr is identical to any GROUP BY term. If so, consider
2135ab31a845Sdan   ** it constant.  */
2136ab31a845Sdan   for(i=0; i<pGroupBy->nExpr; i++){
2137ab31a845Sdan     Expr *p = pGroupBy->a[i].pExpr;
21385aa550cfSdan     if( sqlite3ExprCompare(0, pExpr, p, -1)<2 ){
213970efa84dSdrh       CollSeq *pColl = sqlite3ExprNNCollSeq(pWalker->pParse, p);
2140efad2e23Sdrh       if( sqlite3IsBinary(pColl) ){
2141ab31a845Sdan         return WRC_Prune;
2142ab31a845Sdan       }
2143ab31a845Sdan     }
2144ab31a845Sdan   }
2145ab31a845Sdan 
2146ab31a845Sdan   /* Check if pExpr is a sub-select. If so, consider it variable. */
2147ab31a845Sdan   if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2148ab31a845Sdan     pWalker->eCode = 0;
2149ab31a845Sdan     return WRC_Abort;
2150ab31a845Sdan   }
2151ab31a845Sdan 
2152ab31a845Sdan   return exprNodeIsConstant(pWalker, pExpr);
2153ab31a845Sdan }
2154ab31a845Sdan 
2155ab31a845Sdan /*
2156ab31a845Sdan ** Walk the expression tree passed as the first argument. Return non-zero
2157ab31a845Sdan ** if the expression consists entirely of constants or copies of terms
2158ab31a845Sdan ** in pGroupBy that sort with the BINARY collation sequence.
2159ab314001Sdrh **
2160ab314001Sdrh ** This routine is used to determine if a term of the HAVING clause can
2161ab314001Sdrh ** be promoted into the WHERE clause.  In order for such a promotion to work,
2162ab314001Sdrh ** the value of the HAVING clause term must be the same for all members of
2163ab314001Sdrh ** a "group".  The requirement that the GROUP BY term must be BINARY
2164ab314001Sdrh ** assumes that no other collating sequence will have a finer-grained
2165ab314001Sdrh ** grouping than binary.  In other words (A=B COLLATE binary) implies
2166ab314001Sdrh ** A=B in every other collating sequence.  The requirement that the
2167ab314001Sdrh ** GROUP BY be BINARY is stricter than necessary.  It would also work
2168ab314001Sdrh ** to promote HAVING clauses that use the same alternative collating
2169ab314001Sdrh ** sequence as the GROUP BY term, but that is much harder to check,
2170ab314001Sdrh ** alternative collating sequences are uncommon, and this is only an
2171ab314001Sdrh ** optimization, so we take the easy way out and simply require the
2172ab314001Sdrh ** GROUP BY to use the BINARY collating sequence.
2173ab31a845Sdan */
2174ab31a845Sdan int sqlite3ExprIsConstantOrGroupBy(Parse *pParse, Expr *p, ExprList *pGroupBy){
2175ab31a845Sdan   Walker w;
2176ab31a845Sdan   w.eCode = 1;
2177ab31a845Sdan   w.xExprCallback = exprNodeIsConstantOrGroupBy;
2178979dd1beSdrh   w.xSelectCallback = 0;
2179ab31a845Sdan   w.u.pGroupBy = pGroupBy;
2180ab31a845Sdan   w.pParse = pParse;
2181ab31a845Sdan   sqlite3WalkExpr(&w, p);
2182ab31a845Sdan   return w.eCode;
2183ab31a845Sdan }
2184ab31a845Sdan 
2185059b2d50Sdrh /*
2186014fff20Sdrh ** Walk an expression tree for the DEFAULT field of a column definition
2187014fff20Sdrh ** in a CREATE TABLE statement.  Return non-zero if the expression is
2188014fff20Sdrh ** acceptable for use as a DEFAULT.  That is to say, return non-zero if
2189014fff20Sdrh ** the expression is constant or a function call with constant arguments.
2190014fff20Sdrh ** Return and 0 if there are any variables.
2191014fff20Sdrh **
21921e32bed3Sdrh ** isInit is true when parsing from sqlite_schema.  isInit is false when
2193014fff20Sdrh ** processing a new CREATE TABLE statement.  When isInit is true, parameters
2194014fff20Sdrh ** (such as ? or $abc) in the expression are converted into NULL.  When
2195014fff20Sdrh ** isInit is false, parameters raise an error.  Parameters should not be
2196014fff20Sdrh ** allowed in a CREATE TABLE statement, but some legacy versions of SQLite
21971e32bed3Sdrh ** allowed it, so we need to support it when reading sqlite_schema for
2198014fff20Sdrh ** backwards compatibility.
2199014fff20Sdrh **
2200014fff20Sdrh ** If isInit is true, set EP_FromDDL on every TK_FUNCTION node.
2201eb55bd2fSdrh **
2202eb55bd2fSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
2203eb55bd2fSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
2204eb55bd2fSdrh ** a constant.
2205eb55bd2fSdrh */
2206feada2dfSdrh int sqlite3ExprIsConstantOrFunction(Expr *p, u8 isInit){
2207feada2dfSdrh   assert( isInit==0 || isInit==1 );
2208059b2d50Sdrh   return exprIsConst(p, 4+isInit, 0);
2209eb55bd2fSdrh }
2210eb55bd2fSdrh 
22115b88bc4bSdrh #ifdef SQLITE_ENABLE_CURSOR_HINTS
22125b88bc4bSdrh /*
22135b88bc4bSdrh ** Walk an expression tree.  Return 1 if the expression contains a
22145b88bc4bSdrh ** subquery of some kind.  Return 0 if there are no subqueries.
22155b88bc4bSdrh */
22165b88bc4bSdrh int sqlite3ExprContainsSubquery(Expr *p){
22175b88bc4bSdrh   Walker w;
2218bec2476aSdrh   w.eCode = 1;
22195b88bc4bSdrh   w.xExprCallback = sqlite3ExprWalkNoop;
22207e6f980bSdrh   w.xSelectCallback = sqlite3SelectWalkFail;
2221979dd1beSdrh #ifdef SQLITE_DEBUG
2222979dd1beSdrh   w.xSelectCallback2 = sqlite3SelectWalkAssert2;
2223979dd1beSdrh #endif
22245b88bc4bSdrh   sqlite3WalkExpr(&w, p);
222507194bffSdrh   return w.eCode==0;
22265b88bc4bSdrh }
22275b88bc4bSdrh #endif
22285b88bc4bSdrh 
2229eb55bd2fSdrh /*
223073b211abSdrh ** If the expression p codes a constant integer that is small enough
2231202b2df7Sdrh ** to fit in a 32-bit integer, return 1 and put the value of the integer
2232202b2df7Sdrh ** in *pValue.  If the expression is not an integer or if it is too big
2233202b2df7Sdrh ** to fit in a signed 32-bit integer, return 0 and leave *pValue unchanged.
2234e4de1febSdrh */
22354adee20fSdanielk1977 int sqlite3ExprIsInteger(Expr *p, int *pValue){
223692b01d53Sdrh   int rc = 0;
22371d2d71a0Sdrh   if( NEVER(p==0) ) return 0;  /* Used to only happen following on OOM */
2238cd92e84dSdrh 
2239cd92e84dSdrh   /* If an expression is an integer literal that fits in a signed 32-bit
2240cd92e84dSdrh   ** integer, then the EP_IntValue flag will have already been set */
2241cd92e84dSdrh   assert( p->op!=TK_INTEGER || (p->flags & EP_IntValue)!=0
2242cd92e84dSdrh            || sqlite3GetInt32(p->u.zToken, &rc)==0 );
2243cd92e84dSdrh 
224492b01d53Sdrh   if( p->flags & EP_IntValue ){
224533e619fcSdrh     *pValue = p->u.iValue;
2246e4de1febSdrh     return 1;
2247e4de1febSdrh   }
224892b01d53Sdrh   switch( p->op ){
22494b59ab5eSdrh     case TK_UPLUS: {
225092b01d53Sdrh       rc = sqlite3ExprIsInteger(p->pLeft, pValue);
2251f6e369a1Sdrh       break;
22524b59ab5eSdrh     }
2253e4de1febSdrh     case TK_UMINUS: {
2254e4de1febSdrh       int v;
22554adee20fSdanielk1977       if( sqlite3ExprIsInteger(p->pLeft, &v) ){
2256f6418891Smistachkin         assert( v!=(-2147483647-1) );
2257e4de1febSdrh         *pValue = -v;
225892b01d53Sdrh         rc = 1;
2259e4de1febSdrh       }
2260e4de1febSdrh       break;
2261e4de1febSdrh     }
2262e4de1febSdrh     default: break;
2263e4de1febSdrh   }
226492b01d53Sdrh   return rc;
2265e4de1febSdrh }
2266e4de1febSdrh 
2267e4de1febSdrh /*
2268039fc32eSdrh ** Return FALSE if there is no chance that the expression can be NULL.
2269039fc32eSdrh **
2270039fc32eSdrh ** If the expression might be NULL or if the expression is too complex
2271039fc32eSdrh ** to tell return TRUE.
2272039fc32eSdrh **
2273039fc32eSdrh ** This routine is used as an optimization, to skip OP_IsNull opcodes
2274039fc32eSdrh ** when we know that a value cannot be NULL.  Hence, a false positive
2275039fc32eSdrh ** (returning TRUE when in fact the expression can never be NULL) might
2276039fc32eSdrh ** be a small performance hit but is otherwise harmless.  On the other
2277039fc32eSdrh ** hand, a false negative (returning FALSE when the result could be NULL)
2278039fc32eSdrh ** will likely result in an incorrect answer.  So when in doubt, return
2279039fc32eSdrh ** TRUE.
2280039fc32eSdrh */
2281039fc32eSdrh int sqlite3ExprCanBeNull(const Expr *p){
2282039fc32eSdrh   u8 op;
22839bfb0794Sdrh   while( p->op==TK_UPLUS || p->op==TK_UMINUS ){
22849bfb0794Sdrh     p = p->pLeft;
22859bfb0794Sdrh   }
2286039fc32eSdrh   op = p->op;
2287039fc32eSdrh   if( op==TK_REGISTER ) op = p->op2;
2288039fc32eSdrh   switch( op ){
2289039fc32eSdrh     case TK_INTEGER:
2290039fc32eSdrh     case TK_STRING:
2291039fc32eSdrh     case TK_FLOAT:
2292039fc32eSdrh     case TK_BLOB:
2293039fc32eSdrh       return 0;
22947248a8b2Sdrh     case TK_COLUMN:
229572673a24Sdrh       return ExprHasProperty(p, EP_CanBeNull) ||
2296eda079cdSdrh              p->y.pTab==0 ||  /* Reference to column of index on expression */
22974eac5f04Sdrh              (p->iColumn>=0
22984eac5f04Sdrh               && ALWAYS(p->y.pTab->aCol!=0) /* Defense against OOM problems */
22994eac5f04Sdrh               && p->y.pTab->aCol[p->iColumn].notNull==0);
2300039fc32eSdrh     default:
2301039fc32eSdrh       return 1;
2302039fc32eSdrh   }
2303039fc32eSdrh }
2304039fc32eSdrh 
2305039fc32eSdrh /*
2306039fc32eSdrh ** Return TRUE if the given expression is a constant which would be
2307039fc32eSdrh ** unchanged by OP_Affinity with the affinity given in the second
2308039fc32eSdrh ** argument.
2309039fc32eSdrh **
2310039fc32eSdrh ** This routine is used to determine if the OP_Affinity operation
2311039fc32eSdrh ** can be omitted.  When in doubt return FALSE.  A false negative
2312039fc32eSdrh ** is harmless.  A false positive, however, can result in the wrong
2313039fc32eSdrh ** answer.
2314039fc32eSdrh */
2315039fc32eSdrh int sqlite3ExprNeedsNoAffinityChange(const Expr *p, char aff){
2316039fc32eSdrh   u8 op;
2317af866402Sdrh   int unaryMinus = 0;
231805883a34Sdrh   if( aff==SQLITE_AFF_BLOB ) return 1;
2319af866402Sdrh   while( p->op==TK_UPLUS || p->op==TK_UMINUS ){
2320af866402Sdrh     if( p->op==TK_UMINUS ) unaryMinus = 1;
2321af866402Sdrh     p = p->pLeft;
2322af866402Sdrh   }
2323039fc32eSdrh   op = p->op;
2324039fc32eSdrh   if( op==TK_REGISTER ) op = p->op2;
2325039fc32eSdrh   switch( op ){
2326039fc32eSdrh     case TK_INTEGER: {
23276a19865fSdrh       return aff>=SQLITE_AFF_NUMERIC;
2328039fc32eSdrh     }
2329039fc32eSdrh     case TK_FLOAT: {
23306a19865fSdrh       return aff>=SQLITE_AFF_NUMERIC;
2331039fc32eSdrh     }
2332039fc32eSdrh     case TK_STRING: {
2333af866402Sdrh       return !unaryMinus && aff==SQLITE_AFF_TEXT;
2334039fc32eSdrh     }
2335039fc32eSdrh     case TK_BLOB: {
2336af866402Sdrh       return !unaryMinus;
2337039fc32eSdrh     }
23382f2855b6Sdrh     case TK_COLUMN: {
233988376ca7Sdrh       assert( p->iTable>=0 );  /* p cannot be part of a CHECK constraint */
23406a19865fSdrh       return aff>=SQLITE_AFF_NUMERIC && p->iColumn<0;
23412f2855b6Sdrh     }
2342039fc32eSdrh     default: {
2343039fc32eSdrh       return 0;
2344039fc32eSdrh     }
2345039fc32eSdrh   }
2346039fc32eSdrh }
2347039fc32eSdrh 
2348039fc32eSdrh /*
2349c4a3c779Sdrh ** Return TRUE if the given string is a row-id column name.
2350c4a3c779Sdrh */
23514adee20fSdanielk1977 int sqlite3IsRowid(const char *z){
23524adee20fSdanielk1977   if( sqlite3StrICmp(z, "_ROWID_")==0 ) return 1;
23534adee20fSdanielk1977   if( sqlite3StrICmp(z, "ROWID")==0 ) return 1;
23544adee20fSdanielk1977   if( sqlite3StrICmp(z, "OID")==0 ) return 1;
2355c4a3c779Sdrh   return 0;
2356c4a3c779Sdrh }
2357c4a3c779Sdrh 
23589a96b668Sdanielk1977 /*
235969c355bdSdrh ** pX is the RHS of an IN operator.  If pX is a SELECT statement
236069c355bdSdrh ** that can be simplified to a direct table access, then return
236169c355bdSdrh ** a pointer to the SELECT statement.  If pX is not a SELECT statement,
236269c355bdSdrh ** or if the SELECT statement needs to be manifested into a transient
236369c355bdSdrh ** table, then return NULL.
2364b287f4b6Sdrh */
2365b287f4b6Sdrh #ifndef SQLITE_OMIT_SUBQUERY
23667b35a77bSdan static Select *isCandidateForInOpt(Expr *pX){
236769c355bdSdrh   Select *p;
2368b287f4b6Sdrh   SrcList *pSrc;
2369b287f4b6Sdrh   ExprList *pEList;
2370b287f4b6Sdrh   Table *pTab;
2371cfbb5e82Sdan   int i;
237269c355bdSdrh   if( !ExprHasProperty(pX, EP_xIsSelect) ) return 0;  /* Not a subquery */
237369c355bdSdrh   if( ExprHasProperty(pX, EP_VarSelect)  ) return 0;  /* Correlated subq */
237469c355bdSdrh   p = pX->x.pSelect;
2375b287f4b6Sdrh   if( p->pPrior ) return 0;              /* Not a compound SELECT */
23767d10d5a6Sdrh   if( p->selFlags & (SF_Distinct|SF_Aggregate) ){
2377b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
2378b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
23797d10d5a6Sdrh     return 0; /* No DISTINCT keyword and no aggregate functions */
23807d10d5a6Sdrh   }
23812e26a602Sdrh   assert( p->pGroupBy==0 );              /* Has no GROUP BY clause */
2382b287f4b6Sdrh   if( p->pLimit ) return 0;              /* Has no LIMIT clause */
2383b287f4b6Sdrh   if( p->pWhere ) return 0;              /* Has no WHERE clause */
2384b287f4b6Sdrh   pSrc = p->pSrc;
2385d1fa7bcaSdrh   assert( pSrc!=0 );
2386d1fa7bcaSdrh   if( pSrc->nSrc!=1 ) return 0;          /* Single term in FROM clause */
2387b74b1017Sdrh   if( pSrc->a[0].pSelect ) return 0;     /* FROM is not a subquery or view */
2388b287f4b6Sdrh   pTab = pSrc->a[0].pTab;
238969c355bdSdrh   assert( pTab!=0 );
2390b74b1017Sdrh   assert( pTab->pSelect==0 );            /* FROM clause is not a view */
2391b287f4b6Sdrh   if( IsVirtual(pTab) ) return 0;        /* FROM clause not a virtual table */
2392b287f4b6Sdrh   pEList = p->pEList;
2393ac6b47d1Sdrh   assert( pEList!=0 );
23947b35a77bSdan   /* All SELECT results must be columns. */
2395cfbb5e82Sdan   for(i=0; i<pEList->nExpr; i++){
2396cfbb5e82Sdan     Expr *pRes = pEList->a[i].pExpr;
2397cfbb5e82Sdan     if( pRes->op!=TK_COLUMN ) return 0;
239869c355bdSdrh     assert( pRes->iTable==pSrc->a[0].iCursor );  /* Not a correlated subquery */
2399cfbb5e82Sdan   }
240069c355bdSdrh   return p;
2401b287f4b6Sdrh }
2402b287f4b6Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
2403b287f4b6Sdrh 
2404f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
24051d8cb21fSdan /*
24064c259e9fSdrh ** Generate code that checks the left-most column of index table iCur to see if
24074c259e9fSdrh ** it contains any NULL entries.  Cause the register at regHasNull to be set
24086be515ebSdrh ** to a non-NULL value if iCur contains no NULLs.  Cause register regHasNull
24096be515ebSdrh ** to be set to NULL if iCur contains one or more NULL values.
24106be515ebSdrh */
24116be515ebSdrh static void sqlite3SetHasNullFlag(Vdbe *v, int iCur, int regHasNull){
2412728e0f91Sdrh   int addr1;
24136be515ebSdrh   sqlite3VdbeAddOp2(v, OP_Integer, 0, regHasNull);
2414728e0f91Sdrh   addr1 = sqlite3VdbeAddOp1(v, OP_Rewind, iCur); VdbeCoverage(v);
24156be515ebSdrh   sqlite3VdbeAddOp3(v, OP_Column, iCur, 0, regHasNull);
24166be515ebSdrh   sqlite3VdbeChangeP5(v, OPFLAG_TYPEOFARG);
24174c259e9fSdrh   VdbeComment((v, "first_entry_in(%d)", iCur));
2418728e0f91Sdrh   sqlite3VdbeJumpHere(v, addr1);
24196be515ebSdrh }
2420f9b2e05cSdan #endif
24216be515ebSdrh 
2422bb53ecb1Sdrh 
2423bb53ecb1Sdrh #ifndef SQLITE_OMIT_SUBQUERY
2424bb53ecb1Sdrh /*
2425bb53ecb1Sdrh ** The argument is an IN operator with a list (not a subquery) on the
2426bb53ecb1Sdrh ** right-hand side.  Return TRUE if that list is constant.
2427bb53ecb1Sdrh */
2428bb53ecb1Sdrh static int sqlite3InRhsIsConstant(Expr *pIn){
2429bb53ecb1Sdrh   Expr *pLHS;
2430bb53ecb1Sdrh   int res;
2431bb53ecb1Sdrh   assert( !ExprHasProperty(pIn, EP_xIsSelect) );
2432bb53ecb1Sdrh   pLHS = pIn->pLeft;
2433bb53ecb1Sdrh   pIn->pLeft = 0;
2434bb53ecb1Sdrh   res = sqlite3ExprIsConstant(pIn);
2435bb53ecb1Sdrh   pIn->pLeft = pLHS;
2436bb53ecb1Sdrh   return res;
2437bb53ecb1Sdrh }
2438bb53ecb1Sdrh #endif
2439bb53ecb1Sdrh 
24406be515ebSdrh /*
24419a96b668Sdanielk1977 ** This function is used by the implementation of the IN (...) operator.
2442d4305ca6Sdrh ** The pX parameter is the expression on the RHS of the IN operator, which
2443d4305ca6Sdrh ** might be either a list of expressions or a subquery.
24449a96b668Sdanielk1977 **
2445d4305ca6Sdrh ** The job of this routine is to find or create a b-tree object that can
2446d4305ca6Sdrh ** be used either to test for membership in the RHS set or to iterate through
2447d4305ca6Sdrh ** all members of the RHS set, skipping duplicates.
2448d4305ca6Sdrh **
24493a85625dSdrh ** A cursor is opened on the b-tree object that is the RHS of the IN operator
2450d4305ca6Sdrh ** and pX->iTable is set to the index of that cursor.
2451d4305ca6Sdrh **
2452b74b1017Sdrh ** The returned value of this function indicates the b-tree type, as follows:
24539a96b668Sdanielk1977 **
24549a96b668Sdanielk1977 **   IN_INDEX_ROWID      - The cursor was opened on a database table.
24551ccce449Sdrh **   IN_INDEX_INDEX_ASC  - The cursor was opened on an ascending index.
24561ccce449Sdrh **   IN_INDEX_INDEX_DESC - The cursor was opened on a descending index.
24579a96b668Sdanielk1977 **   IN_INDEX_EPH        - The cursor was opened on a specially created and
24589a96b668Sdanielk1977 **                         populated epheremal table.
2459bb53ecb1Sdrh **   IN_INDEX_NOOP       - No cursor was allocated.  The IN operator must be
2460bb53ecb1Sdrh **                         implemented as a sequence of comparisons.
24619a96b668Sdanielk1977 **
2462d4305ca6Sdrh ** An existing b-tree might be used if the RHS expression pX is a simple
2463d4305ca6Sdrh ** subquery such as:
24649a96b668Sdanielk1977 **
2465553168c7Sdan **     SELECT <column1>, <column2>... FROM <table>
24669a96b668Sdanielk1977 **
2467d4305ca6Sdrh ** If the RHS of the IN operator is a list or a more complex subquery, then
2468d4305ca6Sdrh ** an ephemeral table might need to be generated from the RHS and then
246960ec914cSpeter.d.reid ** pX->iTable made to point to the ephemeral table instead of an
2470d4305ca6Sdrh ** existing table.
2471d4305ca6Sdrh **
24727fc0ba0fSdrh ** The inFlags parameter must contain, at a minimum, one of the bits
24737fc0ba0fSdrh ** IN_INDEX_MEMBERSHIP or IN_INDEX_LOOP but not both.  If inFlags contains
24747fc0ba0fSdrh ** IN_INDEX_MEMBERSHIP, then the generated table will be used for a fast
24757fc0ba0fSdrh ** membership test.  When the IN_INDEX_LOOP bit is set, the IN index will
24767fc0ba0fSdrh ** be used to loop over all values of the RHS of the IN operator.
24773a85625dSdrh **
24783a85625dSdrh ** When IN_INDEX_LOOP is used (and the b-tree will be used to iterate
24793a85625dSdrh ** through the set members) then the b-tree must not contain duplicates.
24807fc0ba0fSdrh ** An epheremal table will be created unless the selected columns are guaranteed
2481553168c7Sdan ** to be unique - either because it is an INTEGER PRIMARY KEY or due to
2482553168c7Sdan ** a UNIQUE constraint or index.
24830cdc022eSdanielk1977 **
24843a85625dSdrh ** When IN_INDEX_MEMBERSHIP is used (and the b-tree will be used
24853a85625dSdrh ** for fast set membership tests) then an epheremal table must
2486553168c7Sdan ** be used unless <columns> is a single INTEGER PRIMARY KEY column or an
2487553168c7Sdan ** index can be found with the specified <columns> as its left-most.
24880cdc022eSdanielk1977 **
2489bb53ecb1Sdrh ** If the IN_INDEX_NOOP_OK and IN_INDEX_MEMBERSHIP are both set and
2490bb53ecb1Sdrh ** if the RHS of the IN operator is a list (not a subquery) then this
2491bb53ecb1Sdrh ** routine might decide that creating an ephemeral b-tree for membership
2492bb53ecb1Sdrh ** testing is too expensive and return IN_INDEX_NOOP.  In that case, the
2493bb53ecb1Sdrh ** calling routine should implement the IN operator using a sequence
2494bb53ecb1Sdrh ** of Eq or Ne comparison operations.
2495bb53ecb1Sdrh **
2496b74b1017Sdrh ** When the b-tree is being used for membership tests, the calling function
24973a85625dSdrh ** might need to know whether or not the RHS side of the IN operator
2498e21a6e1dSdrh ** contains a NULL.  If prRhsHasNull is not a NULL pointer and
24993a85625dSdrh ** if there is any chance that the (...) might contain a NULL value at
25000cdc022eSdanielk1977 ** runtime, then a register is allocated and the register number written
2501e21a6e1dSdrh ** to *prRhsHasNull. If there is no chance that the (...) contains a
2502e21a6e1dSdrh ** NULL value, then *prRhsHasNull is left unchanged.
25030cdc022eSdanielk1977 **
2504e21a6e1dSdrh ** If a register is allocated and its location stored in *prRhsHasNull, then
25056be515ebSdrh ** the value in that register will be NULL if the b-tree contains one or more
25066be515ebSdrh ** NULL values, and it will be some non-NULL value if the b-tree contains no
25076be515ebSdrh ** NULL values.
2508553168c7Sdan **
2509553168c7Sdan ** If the aiMap parameter is not NULL, it must point to an array containing
2510553168c7Sdan ** one element for each column returned by the SELECT statement on the RHS
2511553168c7Sdan ** of the IN(...) operator. The i'th entry of the array is populated with the
2512553168c7Sdan ** offset of the index column that matches the i'th column returned by the
2513553168c7Sdan ** SELECT. For example, if the expression and selected index are:
2514553168c7Sdan **
2515553168c7Sdan **   (?,?,?) IN (SELECT a, b, c FROM t1)
2516553168c7Sdan **   CREATE INDEX i1 ON t1(b, c, a);
2517553168c7Sdan **
2518553168c7Sdan ** then aiMap[] is populated with {2, 0, 1}.
25199a96b668Sdanielk1977 */
2520284f4acaSdanielk1977 #ifndef SQLITE_OMIT_SUBQUERY
2521ba00e30aSdan int sqlite3FindInIndex(
25226fc8f364Sdrh   Parse *pParse,             /* Parsing context */
25230167ef20Sdrh   Expr *pX,                  /* The IN expression */
25246fc8f364Sdrh   u32 inFlags,               /* IN_INDEX_LOOP, _MEMBERSHIP, and/or _NOOP_OK */
25256fc8f364Sdrh   int *prRhsHasNull,         /* Register holding NULL status.  See notes */
25262c04131cSdrh   int *aiMap,                /* Mapping from Index fields to RHS fields */
25272c04131cSdrh   int *piTab                 /* OUT: index to use */
2528ba00e30aSdan ){
2529b74b1017Sdrh   Select *p;                            /* SELECT to the right of IN operator */
2530b74b1017Sdrh   int eType = 0;                        /* Type of RHS table. IN_INDEX_* */
2531b74b1017Sdrh   int iTab = pParse->nTab++;            /* Cursor of the RHS table */
25323a85625dSdrh   int mustBeUnique;                     /* True if RHS must be unique */
2533b8475df8Sdrh   Vdbe *v = sqlite3GetVdbe(pParse);     /* Virtual machine being coded */
25349a96b668Sdanielk1977 
25351450bc6eSdrh   assert( pX->op==TK_IN );
25363a85625dSdrh   mustBeUnique = (inFlags & IN_INDEX_LOOP)!=0;
25371450bc6eSdrh 
25387b35a77bSdan   /* If the RHS of this IN(...) operator is a SELECT, and if it matters
25397b35a77bSdan   ** whether or not the SELECT result contains NULL values, check whether
2540870a0705Sdan   ** or not NULL is actually possible (it may not be, for example, due
25417b35a77bSdan   ** to NOT NULL constraints in the schema). If no NULL values are possible,
2542870a0705Sdan   ** set prRhsHasNull to 0 before continuing.  */
25437b35a77bSdan   if( prRhsHasNull && (pX->flags & EP_xIsSelect) ){
25447b35a77bSdan     int i;
25457b35a77bSdan     ExprList *pEList = pX->x.pSelect->pEList;
25467b35a77bSdan     for(i=0; i<pEList->nExpr; i++){
25477b35a77bSdan       if( sqlite3ExprCanBeNull(pEList->a[i].pExpr) ) break;
25487b35a77bSdan     }
25497b35a77bSdan     if( i==pEList->nExpr ){
25507b35a77bSdan       prRhsHasNull = 0;
25517b35a77bSdan     }
25527b35a77bSdan   }
25537b35a77bSdan 
2554b74b1017Sdrh   /* Check to see if an existing table or index can be used to
2555b74b1017Sdrh   ** satisfy the query.  This is preferable to generating a new
25567b35a77bSdan   ** ephemeral table.  */
25577b35a77bSdan   if( pParse->nErr==0 && (p = isCandidateForInOpt(pX))!=0 ){
2558e1fb65a0Sdanielk1977     sqlite3 *db = pParse->db;              /* Database connection */
2559b07028f7Sdrh     Table *pTab;                           /* Table <table>. */
2560399062ccSdrh     int iDb;                               /* Database idx for pTab */
2561cfbb5e82Sdan     ExprList *pEList = p->pEList;
2562cfbb5e82Sdan     int nExpr = pEList->nExpr;
2563e1fb65a0Sdanielk1977 
2564b07028f7Sdrh     assert( p->pEList!=0 );             /* Because of isCandidateForInOpt(p) */
2565b07028f7Sdrh     assert( p->pEList->a[0].pExpr!=0 ); /* Because of isCandidateForInOpt(p) */
2566b07028f7Sdrh     assert( p->pSrc!=0 );               /* Because of isCandidateForInOpt(p) */
2567b07028f7Sdrh     pTab = p->pSrc->a[0].pTab;
2568b07028f7Sdrh 
2569b22f7c83Sdrh     /* Code an OP_Transaction and OP_TableLock for <table>. */
2570e1fb65a0Sdanielk1977     iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
2571bdd4f7d9Sdrh     assert( iDb>=0 && iDb<SQLITE_MAX_ATTACHED );
2572e1fb65a0Sdanielk1977     sqlite3CodeVerifySchema(pParse, iDb);
2573e1fb65a0Sdanielk1977     sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
25749a96b668Sdanielk1977 
2575a84a283dSdrh     assert(v);  /* sqlite3GetVdbe() has always been previously called */
2576cfbb5e82Sdan     if( nExpr==1 && pEList->a[0].pExpr->iColumn<0 ){
257762659b2aSdrh       /* The "x IN (SELECT rowid FROM table)" case */
2578511f9e8dSdrh       int iAddr = sqlite3VdbeAddOp0(v, OP_Once);
25797d176105Sdrh       VdbeCoverage(v);
25809a96b668Sdanielk1977 
25819a96b668Sdanielk1977       sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
25829a96b668Sdanielk1977       eType = IN_INDEX_ROWID;
2583d8852095Sdrh       ExplainQueryPlan((pParse, 0,
2584d8852095Sdrh             "USING ROWID SEARCH ON TABLE %s FOR IN-OPERATOR",pTab->zName));
25859a96b668Sdanielk1977       sqlite3VdbeJumpHere(v, iAddr);
25869a96b668Sdanielk1977     }else{
2587e1fb65a0Sdanielk1977       Index *pIdx;                         /* Iterator variable */
2588cfbb5e82Sdan       int affinity_ok = 1;
2589cfbb5e82Sdan       int i;
2590cfbb5e82Sdan 
2591cfbb5e82Sdan       /* Check that the affinity that will be used to perform each
259262659b2aSdrh       ** comparison is the same as the affinity of each column in table
259362659b2aSdrh       ** on the RHS of the IN operator.  If it not, it is not possible to
259462659b2aSdrh       ** use any index of the RHS table.  */
2595cfbb5e82Sdan       for(i=0; i<nExpr && affinity_ok; i++){
2596fc7f27b9Sdrh         Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2597cfbb5e82Sdan         int iCol = pEList->a[i].pExpr->iColumn;
25980dfa4f6fSdrh         char idxaff = sqlite3TableColumnAffinity(pTab,iCol); /* RHS table */
2599cfbb5e82Sdan         char cmpaff = sqlite3CompareAffinity(pLhs, idxaff);
260062659b2aSdrh         testcase( cmpaff==SQLITE_AFF_BLOB );
260162659b2aSdrh         testcase( cmpaff==SQLITE_AFF_TEXT );
2602cfbb5e82Sdan         switch( cmpaff ){
2603cfbb5e82Sdan           case SQLITE_AFF_BLOB:
2604cfbb5e82Sdan             break;
2605cfbb5e82Sdan           case SQLITE_AFF_TEXT:
260662659b2aSdrh             /* sqlite3CompareAffinity() only returns TEXT if one side or the
260762659b2aSdrh             ** other has no affinity and the other side is TEXT.  Hence,
260862659b2aSdrh             ** the only way for cmpaff to be TEXT is for idxaff to be TEXT
260962659b2aSdrh             ** and for the term on the LHS of the IN to have no affinity. */
261062659b2aSdrh             assert( idxaff==SQLITE_AFF_TEXT );
2611cfbb5e82Sdan             break;
2612cfbb5e82Sdan           default:
2613cfbb5e82Sdan             affinity_ok = sqlite3IsNumericAffinity(idxaff);
2614cfbb5e82Sdan         }
2615cfbb5e82Sdan       }
2616e1fb65a0Sdanielk1977 
2617a84a283dSdrh       if( affinity_ok ){
2618a84a283dSdrh         /* Search for an existing index that will work for this IN operator */
2619a84a283dSdrh         for(pIdx=pTab->pIndex; pIdx && eType==0; pIdx=pIdx->pNext){
2620a84a283dSdrh           Bitmask colUsed;      /* Columns of the index used */
2621a84a283dSdrh           Bitmask mCol;         /* Mask for the current column */
26226fc8f364Sdrh           if( pIdx->nColumn<nExpr ) continue;
2623d4a4a361Sdrh           if( pIdx->pPartIdxWhere!=0 ) continue;
2624a84a283dSdrh           /* Maximum nColumn is BMS-2, not BMS-1, so that we can compute
2625a84a283dSdrh           ** BITMASK(nExpr) without overflowing */
2626a84a283dSdrh           testcase( pIdx->nColumn==BMS-2 );
2627a84a283dSdrh           testcase( pIdx->nColumn==BMS-1 );
2628a84a283dSdrh           if( pIdx->nColumn>=BMS-1 ) continue;
26296fc8f364Sdrh           if( mustBeUnique ){
26306fc8f364Sdrh             if( pIdx->nKeyCol>nExpr
26316fc8f364Sdrh              ||(pIdx->nColumn>nExpr && !IsUniqueIndex(pIdx))
26326fc8f364Sdrh             ){
2633a84a283dSdrh               continue;  /* This index is not unique over the IN RHS columns */
2634cfbb5e82Sdan             }
26356fc8f364Sdrh           }
2636cfbb5e82Sdan 
2637a84a283dSdrh           colUsed = 0;   /* Columns of index used so far */
2638cfbb5e82Sdan           for(i=0; i<nExpr; i++){
2639fc7f27b9Sdrh             Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2640cfbb5e82Sdan             Expr *pRhs = pEList->a[i].pExpr;
2641cfbb5e82Sdan             CollSeq *pReq = sqlite3BinaryCompareCollSeq(pParse, pLhs, pRhs);
2642cfbb5e82Sdan             int j;
2643cfbb5e82Sdan 
26446fc8f364Sdrh             assert( pReq!=0 || pRhs->iColumn==XN_ROWID || pParse->nErr );
2645cfbb5e82Sdan             for(j=0; j<nExpr; j++){
2646cfbb5e82Sdan               if( pIdx->aiColumn[j]!=pRhs->iColumn ) continue;
2647cfbb5e82Sdan               assert( pIdx->azColl[j] );
2648106526e1Sdrh               if( pReq!=0 && sqlite3StrICmp(pReq->zName, pIdx->azColl[j])!=0 ){
2649106526e1Sdrh                 continue;
2650106526e1Sdrh               }
2651cfbb5e82Sdan               break;
2652cfbb5e82Sdan             }
2653cfbb5e82Sdan             if( j==nExpr ) break;
2654a84a283dSdrh             mCol = MASKBIT(j);
2655a84a283dSdrh             if( mCol & colUsed ) break; /* Each column used only once */
2656a84a283dSdrh             colUsed |= mCol;
2657ba00e30aSdan             if( aiMap ) aiMap[i] = j;
2658cfbb5e82Sdan           }
2659cfbb5e82Sdan 
2660a84a283dSdrh           assert( i==nExpr || colUsed!=(MASKBIT(nExpr)-1) );
2661a84a283dSdrh           if( colUsed==(MASKBIT(nExpr)-1) ){
2662a84a283dSdrh             /* If we reach this point, that means the index pIdx is usable */
2663511f9e8dSdrh             int iAddr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
2664e2ca99c9Sdrh             ExplainQueryPlan((pParse, 0,
2665e2ca99c9Sdrh                               "USING INDEX %s FOR IN-OPERATOR",pIdx->zName));
26662ec2fb22Sdrh             sqlite3VdbeAddOp3(v, OP_OpenRead, iTab, pIdx->tnum, iDb);
26672ec2fb22Sdrh             sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
2668207872a4Sdanielk1977             VdbeComment((v, "%s", pIdx->zName));
26691ccce449Sdrh             assert( IN_INDEX_INDEX_DESC == IN_INDEX_INDEX_ASC+1 );
26701ccce449Sdrh             eType = IN_INDEX_INDEX_ASC + pIdx->aSortOrder[0];
26719a96b668Sdanielk1977 
26727b35a77bSdan             if( prRhsHasNull ){
26733480bfdaSdan #ifdef SQLITE_ENABLE_COLUMN_USED_MASK
2674cfbb5e82Sdan               i64 mask = (1<<nExpr)-1;
26753480bfdaSdan               sqlite3VdbeAddOp4Dup8(v, OP_ColumnsUsed,
2676cfbb5e82Sdan                   iTab, 0, 0, (u8*)&mask, P4_INT64);
26773480bfdaSdan #endif
2678b80dbdc2Sdrh               *prRhsHasNull = ++pParse->nMem;
26797b35a77bSdan               if( nExpr==1 ){
26806be515ebSdrh                 sqlite3SetHasNullFlag(v, iTab, *prRhsHasNull);
26810cdc022eSdanielk1977               }
26827b35a77bSdan             }
2683552fd454Sdrh             sqlite3VdbeJumpHere(v, iAddr);
26849a96b668Sdanielk1977           }
2685a84a283dSdrh         } /* End loop over indexes */
2686a84a283dSdrh       } /* End if( affinity_ok ) */
2687a84a283dSdrh     } /* End if not an rowid index */
2688a84a283dSdrh   } /* End attempt to optimize using an index */
26899a96b668Sdanielk1977 
2690bb53ecb1Sdrh   /* If no preexisting index is available for the IN clause
2691bb53ecb1Sdrh   ** and IN_INDEX_NOOP is an allowed reply
2692bb53ecb1Sdrh   ** and the RHS of the IN operator is a list, not a subquery
269371c57db0Sdan   ** and the RHS is not constant or has two or fewer terms,
269460ec914cSpeter.d.reid   ** then it is not worth creating an ephemeral table to evaluate
2695bb53ecb1Sdrh   ** the IN operator so return IN_INDEX_NOOP.
2696bb53ecb1Sdrh   */
2697bb53ecb1Sdrh   if( eType==0
2698bb53ecb1Sdrh    && (inFlags & IN_INDEX_NOOP_OK)
2699bb53ecb1Sdrh    && !ExprHasProperty(pX, EP_xIsSelect)
2700bb53ecb1Sdrh    && (!sqlite3InRhsIsConstant(pX) || pX->x.pList->nExpr<=2)
2701bb53ecb1Sdrh   ){
2702bb53ecb1Sdrh     eType = IN_INDEX_NOOP;
2703bb53ecb1Sdrh   }
2704bb53ecb1Sdrh 
27059a96b668Sdanielk1977   if( eType==0 ){
27064387006cSdrh     /* Could not find an existing table or index to use as the RHS b-tree.
2707b74b1017Sdrh     ** We will have to generate an ephemeral table to do the job.
2708b74b1017Sdrh     */
27098e23daf3Sdrh     u32 savedNQueryLoop = pParse->nQueryLoop;
27100cdc022eSdanielk1977     int rMayHaveNull = 0;
271141a05b7bSdanielk1977     eType = IN_INDEX_EPH;
27123a85625dSdrh     if( inFlags & IN_INDEX_LOOP ){
27134a5acf8eSdrh       pParse->nQueryLoop = 0;
2714e21a6e1dSdrh     }else if( prRhsHasNull ){
2715e21a6e1dSdrh       *prRhsHasNull = rMayHaveNull = ++pParse->nMem;
2716cf4d38aaSdrh     }
271785bcdce2Sdrh     assert( pX->op==TK_IN );
271850ef6716Sdrh     sqlite3CodeRhsOfIN(pParse, pX, iTab);
271985bcdce2Sdrh     if( rMayHaveNull ){
27202c04131cSdrh       sqlite3SetHasNullFlag(v, iTab, rMayHaveNull);
272185bcdce2Sdrh     }
2722cf4d38aaSdrh     pParse->nQueryLoop = savedNQueryLoop;
27239a96b668Sdanielk1977   }
2724ba00e30aSdan 
2725ba00e30aSdan   if( aiMap && eType!=IN_INDEX_INDEX_ASC && eType!=IN_INDEX_INDEX_DESC ){
2726ba00e30aSdan     int i, n;
2727ba00e30aSdan     n = sqlite3ExprVectorSize(pX->pLeft);
2728ba00e30aSdan     for(i=0; i<n; i++) aiMap[i] = i;
2729ba00e30aSdan   }
27302c04131cSdrh   *piTab = iTab;
27319a96b668Sdanielk1977   return eType;
27329a96b668Sdanielk1977 }
2733284f4acaSdanielk1977 #endif
2734626a879aSdrh 
2735f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
2736553168c7Sdan /*
2737553168c7Sdan ** Argument pExpr is an (?, ?...) IN(...) expression. This
2738553168c7Sdan ** function allocates and returns a nul-terminated string containing
2739553168c7Sdan ** the affinities to be used for each column of the comparison.
2740553168c7Sdan **
2741553168c7Sdan ** It is the responsibility of the caller to ensure that the returned
2742553168c7Sdan ** string is eventually freed using sqlite3DbFree().
2743553168c7Sdan */
274471c57db0Sdan static char *exprINAffinity(Parse *pParse, Expr *pExpr){
274571c57db0Sdan   Expr *pLeft = pExpr->pLeft;
274671c57db0Sdan   int nVal = sqlite3ExprVectorSize(pLeft);
2747553168c7Sdan   Select *pSelect = (pExpr->flags & EP_xIsSelect) ? pExpr->x.pSelect : 0;
274871c57db0Sdan   char *zRet;
274971c57db0Sdan 
2750553168c7Sdan   assert( pExpr->op==TK_IN );
27515c258dc1Sdrh   zRet = sqlite3DbMallocRaw(pParse->db, nVal+1);
275271c57db0Sdan   if( zRet ){
275371c57db0Sdan     int i;
275471c57db0Sdan     for(i=0; i<nVal; i++){
2755fc7f27b9Sdrh       Expr *pA = sqlite3VectorFieldSubexpr(pLeft, i);
2756553168c7Sdan       char a = sqlite3ExprAffinity(pA);
2757553168c7Sdan       if( pSelect ){
2758553168c7Sdan         zRet[i] = sqlite3CompareAffinity(pSelect->pEList->a[i].pExpr, a);
275971c57db0Sdan       }else{
2760553168c7Sdan         zRet[i] = a;
276171c57db0Sdan       }
276271c57db0Sdan     }
276371c57db0Sdan     zRet[nVal] = '\0';
276471c57db0Sdan   }
276571c57db0Sdan   return zRet;
276671c57db0Sdan }
2767f9b2e05cSdan #endif
276871c57db0Sdan 
27698da209b1Sdan #ifndef SQLITE_OMIT_SUBQUERY
27708da209b1Sdan /*
27718da209b1Sdan ** Load the Parse object passed as the first argument with an error
27728da209b1Sdan ** message of the form:
27738da209b1Sdan **
27748da209b1Sdan **   "sub-select returns N columns - expected M"
27758da209b1Sdan */
27768da209b1Sdan void sqlite3SubselectError(Parse *pParse, int nActual, int nExpect){
2777a9ebfe20Sdrh   if( pParse->nErr==0 ){
27788da209b1Sdan     const char *zFmt = "sub-select returns %d columns - expected %d";
27798da209b1Sdan     sqlite3ErrorMsg(pParse, zFmt, nActual, nExpect);
27808da209b1Sdan   }
2781a9ebfe20Sdrh }
27828da209b1Sdan #endif
27838da209b1Sdan 
2784626a879aSdrh /*
278544c5604cSdan ** Expression pExpr is a vector that has been used in a context where
278644c5604cSdan ** it is not permitted. If pExpr is a sub-select vector, this routine
278744c5604cSdan ** loads the Parse object with a message of the form:
278844c5604cSdan **
278944c5604cSdan **   "sub-select returns N columns - expected 1"
279044c5604cSdan **
279144c5604cSdan ** Or, if it is a regular scalar vector:
279244c5604cSdan **
279344c5604cSdan **   "row value misused"
279444c5604cSdan */
279544c5604cSdan void sqlite3VectorErrorMsg(Parse *pParse, Expr *pExpr){
279644c5604cSdan #ifndef SQLITE_OMIT_SUBQUERY
279744c5604cSdan   if( pExpr->flags & EP_xIsSelect ){
279844c5604cSdan     sqlite3SubselectError(pParse, pExpr->x.pSelect->pEList->nExpr, 1);
279944c5604cSdan   }else
280044c5604cSdan #endif
280144c5604cSdan   {
280244c5604cSdan     sqlite3ErrorMsg(pParse, "row value misused");
280344c5604cSdan   }
280444c5604cSdan }
280544c5604cSdan 
280685bcdce2Sdrh #ifndef SQLITE_OMIT_SUBQUERY
280744c5604cSdan /*
280885bcdce2Sdrh ** Generate code that will construct an ephemeral table containing all terms
280985bcdce2Sdrh ** in the RHS of an IN operator.  The IN operator can be in either of two
281085bcdce2Sdrh ** forms:
2811626a879aSdrh **
28129cbe6352Sdrh **     x IN (4,5,11)              -- IN operator with list on right-hand side
28139cbe6352Sdrh **     x IN (SELECT a FROM b)     -- IN operator with subquery on the right
2814fef5208cSdrh **
28152c04131cSdrh ** The pExpr parameter is the IN operator.  The cursor number for the
28162c04131cSdrh ** constructed ephermeral table is returned.  The first time the ephemeral
28172c04131cSdrh ** table is computed, the cursor number is also stored in pExpr->iTable,
28182c04131cSdrh ** however the cursor number returned might not be the same, as it might
28192c04131cSdrh ** have been duplicated using OP_OpenDup.
282041a05b7bSdanielk1977 **
282185bcdce2Sdrh ** If the LHS expression ("x" in the examples) is a column value, or
282285bcdce2Sdrh ** the SELECT statement returns a column value, then the affinity of that
282385bcdce2Sdrh ** column is used to build the index keys. If both 'x' and the
282485bcdce2Sdrh ** SELECT... statement are columns, then numeric affinity is used
282585bcdce2Sdrh ** if either column has NUMERIC or INTEGER affinity. If neither
282685bcdce2Sdrh ** 'x' nor the SELECT... statement are columns, then numeric affinity
282785bcdce2Sdrh ** is used.
2828cce7d176Sdrh */
282985bcdce2Sdrh void sqlite3CodeRhsOfIN(
2830fd773cf9Sdrh   Parse *pParse,          /* Parsing context */
283185bcdce2Sdrh   Expr *pExpr,            /* The IN operator */
283250ef6716Sdrh   int iTab                /* Use this cursor number */
283341a05b7bSdanielk1977 ){
28342c04131cSdrh   int addrOnce = 0;           /* Address of the OP_Once instruction at top */
283585bcdce2Sdrh   int addr;                   /* Address of OP_OpenEphemeral instruction */
283685bcdce2Sdrh   Expr *pLeft;                /* the LHS of the IN operator */
283785bcdce2Sdrh   KeyInfo *pKeyInfo = 0;      /* Key information */
283885bcdce2Sdrh   int nVal;                   /* Size of vector pLeft */
283985bcdce2Sdrh   Vdbe *v;                    /* The prepared statement under construction */
2840fc976065Sdanielk1977 
28412c04131cSdrh   v = pParse->pVdbe;
284285bcdce2Sdrh   assert( v!=0 );
284385bcdce2Sdrh 
28442c04131cSdrh   /* The evaluation of the IN must be repeated every time it
284539a11819Sdrh   ** is encountered if any of the following is true:
284657dbd7b3Sdrh   **
284757dbd7b3Sdrh   **    *  The right-hand side is a correlated subquery
284857dbd7b3Sdrh   **    *  The right-hand side is an expression list containing variables
284957dbd7b3Sdrh   **    *  We are inside a trigger
285057dbd7b3Sdrh   **
28512c04131cSdrh   ** If all of the above are false, then we can compute the RHS just once
28522c04131cSdrh   ** and reuse it many names.
2853b3bce662Sdanielk1977   */
2854efb699fcSdrh   if( !ExprHasProperty(pExpr, EP_VarSelect) && pParse->iSelfTab==0 ){
28552c04131cSdrh     /* Reuse of the RHS is allowed */
28562c04131cSdrh     /* If this routine has already been coded, but the previous code
28572c04131cSdrh     ** might not have been invoked yet, so invoke it now as a subroutine.
28582c04131cSdrh     */
28592c04131cSdrh     if( ExprHasProperty(pExpr, EP_Subrtn) ){
2860f9231c34Sdrh       addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
2861bd462bccSdrh       if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2862bd462bccSdrh         ExplainQueryPlan((pParse, 0, "REUSE LIST SUBQUERY %d",
2863bd462bccSdrh               pExpr->x.pSelect->selId));
2864bd462bccSdrh       }
28652c04131cSdrh       sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
28662c04131cSdrh                         pExpr->y.sub.iAddr);
28672c04131cSdrh       sqlite3VdbeAddOp2(v, OP_OpenDup, iTab, pExpr->iTable);
2868f9231c34Sdrh       sqlite3VdbeJumpHere(v, addrOnce);
28692c04131cSdrh       return;
28702c04131cSdrh     }
28712c04131cSdrh 
28722c04131cSdrh     /* Begin coding the subroutine */
28732c04131cSdrh     ExprSetProperty(pExpr, EP_Subrtn);
2874088489e8Sdrh     assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
28752c04131cSdrh     pExpr->y.sub.regReturn = ++pParse->nMem;
28762c04131cSdrh     pExpr->y.sub.iAddr =
28772c04131cSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 0, pExpr->y.sub.regReturn) + 1;
28782c04131cSdrh     VdbeComment((v, "return address"));
28792c04131cSdrh 
28802c04131cSdrh     addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
2881b3bce662Sdanielk1977   }
2882b3bce662Sdanielk1977 
288385bcdce2Sdrh   /* Check to see if this is a vector IN operator */
288485bcdce2Sdrh   pLeft = pExpr->pLeft;
288571c57db0Sdan   nVal = sqlite3ExprVectorSize(pLeft);
2886e014a838Sdanielk1977 
288785bcdce2Sdrh   /* Construct the ephemeral table that will contain the content of
288885bcdce2Sdrh   ** RHS of the IN operator.
2889fef5208cSdrh   */
28902c04131cSdrh   pExpr->iTable = iTab;
289150ef6716Sdrh   addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, pExpr->iTable, nVal);
28922c04131cSdrh #ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
28932c04131cSdrh   if( ExprHasProperty(pExpr, EP_xIsSelect) ){
28942c04131cSdrh     VdbeComment((v, "Result of SELECT %u", pExpr->x.pSelect->selId));
28952c04131cSdrh   }else{
28962c04131cSdrh     VdbeComment((v, "RHS of IN operator"));
28972c04131cSdrh   }
28982c04131cSdrh #endif
289950ef6716Sdrh   pKeyInfo = sqlite3KeyInfoAlloc(pParse->db, nVal, 1);
2900e014a838Sdanielk1977 
29016ab3a2ecSdanielk1977   if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2902e014a838Sdanielk1977     /* Case 1:     expr IN (SELECT ...)
2903e014a838Sdanielk1977     **
2904e014a838Sdanielk1977     ** Generate code to write the results of the select into the temporary
2905e014a838Sdanielk1977     ** table allocated and opened above.
2906e014a838Sdanielk1977     */
29074387006cSdrh     Select *pSelect = pExpr->x.pSelect;
290871c57db0Sdan     ExprList *pEList = pSelect->pEList;
29091013c932Sdrh 
29102c04131cSdrh     ExplainQueryPlan((pParse, 1, "%sLIST SUBQUERY %d",
29112c04131cSdrh         addrOnce?"":"CORRELATED ", pSelect->selId
2912e2ca99c9Sdrh     ));
291364bcb8cfSdrh     /* If the LHS and RHS of the IN operator do not match, that
291464bcb8cfSdrh     ** error will have been caught long before we reach this point. */
291564bcb8cfSdrh     if( ALWAYS(pEList->nExpr==nVal) ){
291671c57db0Sdan       SelectDest dest;
291771c57db0Sdan       int i;
2918bd462bccSdrh       sqlite3SelectDestInit(&dest, SRT_Set, iTab);
291971c57db0Sdan       dest.zAffSdst = exprINAffinity(pParse, pExpr);
29204387006cSdrh       pSelect->iLimit = 0;
29214387006cSdrh       testcase( pSelect->selFlags & SF_Distinct );
2922812ea833Sdrh       testcase( pKeyInfo==0 ); /* Caused by OOM in sqlite3KeyInfoAlloc() */
29234387006cSdrh       if( sqlite3Select(pParse, pSelect, &dest) ){
292471c57db0Sdan         sqlite3DbFree(pParse->db, dest.zAffSdst);
29252ec2fb22Sdrh         sqlite3KeyInfoUnref(pKeyInfo);
292685bcdce2Sdrh         return;
292794ccde58Sdrh       }
292871c57db0Sdan       sqlite3DbFree(pParse->db, dest.zAffSdst);
2929812ea833Sdrh       assert( pKeyInfo!=0 ); /* OOM will cause exit after sqlite3Select() */
29303535ec3eSdrh       assert( pEList!=0 );
29313535ec3eSdrh       assert( pEList->nExpr>0 );
29322ec2fb22Sdrh       assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
293371c57db0Sdan       for(i=0; i<nVal; i++){
2934773d3afaSdan         Expr *p = sqlite3VectorFieldSubexpr(pLeft, i);
293571c57db0Sdan         pKeyInfo->aColl[i] = sqlite3BinaryCompareCollSeq(
293671c57db0Sdan             pParse, p, pEList->a[i].pExpr
293771c57db0Sdan         );
293871c57db0Sdan       }
293971c57db0Sdan     }
2940a7d2db17Sdrh   }else if( ALWAYS(pExpr->x.pList!=0) ){
2941fef5208cSdrh     /* Case 2:     expr IN (exprlist)
2942fef5208cSdrh     **
2943e014a838Sdanielk1977     ** For each expression, build an index key from the evaluation and
2944e014a838Sdanielk1977     ** store it in the temporary table. If <expr> is a column, then use
2945e014a838Sdanielk1977     ** that columns affinity when building index keys. If <expr> is not
2946e014a838Sdanielk1977     ** a column, use numeric affinity.
2947fef5208cSdrh     */
294871c57db0Sdan     char affinity;            /* Affinity of the LHS of the IN */
2949e014a838Sdanielk1977     int i;
29506ab3a2ecSdanielk1977     ExprList *pList = pExpr->x.pList;
295157dbd7b3Sdrh     struct ExprList_item *pItem;
2952c324d446Sdan     int r1, r2;
295371c57db0Sdan     affinity = sqlite3ExprAffinity(pLeft);
295496fb16eeSdrh     if( affinity<=SQLITE_AFF_NONE ){
295505883a34Sdrh       affinity = SQLITE_AFF_BLOB;
295695b39590Sdrh     }else if( affinity==SQLITE_AFF_REAL ){
295795b39590Sdrh       affinity = SQLITE_AFF_NUMERIC;
2958e014a838Sdanielk1977     }
2959323df790Sdrh     if( pKeyInfo ){
29602ec2fb22Sdrh       assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
2961323df790Sdrh       pKeyInfo->aColl[0] = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
2962323df790Sdrh     }
2963e014a838Sdanielk1977 
2964e014a838Sdanielk1977     /* Loop through each expression in <exprlist>. */
29652d401ab8Sdrh     r1 = sqlite3GetTempReg(pParse);
29662d401ab8Sdrh     r2 = sqlite3GetTempReg(pParse);
296757dbd7b3Sdrh     for(i=pList->nExpr, pItem=pList->a; i>0; i--, pItem++){
296857dbd7b3Sdrh       Expr *pE2 = pItem->pExpr;
2969e014a838Sdanielk1977 
297057dbd7b3Sdrh       /* If the expression is not constant then we will need to
297157dbd7b3Sdrh       ** disable the test that was generated above that makes sure
297257dbd7b3Sdrh       ** this code only executes once.  Because for a non-constant
297357dbd7b3Sdrh       ** expression we need to rerun this code each time.
297457dbd7b3Sdrh       */
29752c04131cSdrh       if( addrOnce && !sqlite3ExprIsConstant(pE2) ){
29762c04131cSdrh         sqlite3VdbeChangeToNoop(v, addrOnce);
29777ac0e562Sdan         ExprClearProperty(pExpr, EP_Subrtn);
29782c04131cSdrh         addrOnce = 0;
29794794b980Sdrh       }
2980e014a838Sdanielk1977 
2981e014a838Sdanielk1977       /* Evaluate the expression and insert it into the temp table */
2982c324d446Sdan       sqlite3ExprCode(pParse, pE2, r1);
2983c324d446Sdan       sqlite3VdbeAddOp4(v, OP_MakeRecord, r1, 1, r2, &affinity, 1);
2984c324d446Sdan       sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iTab, r2, r1, 1);
2985fef5208cSdrh     }
29862d401ab8Sdrh     sqlite3ReleaseTempReg(pParse, r1);
29872d401ab8Sdrh     sqlite3ReleaseTempReg(pParse, r2);
2988fef5208cSdrh   }
2989323df790Sdrh   if( pKeyInfo ){
29902ec2fb22Sdrh     sqlite3VdbeChangeP4(v, addr, (void *)pKeyInfo, P4_KEYINFO);
299141a05b7bSdanielk1977   }
29922c04131cSdrh   if( addrOnce ){
29932c04131cSdrh     sqlite3VdbeJumpHere(v, addrOnce);
29942c04131cSdrh     /* Subroutine return */
29952c04131cSdrh     sqlite3VdbeAddOp1(v, OP_Return, pExpr->y.sub.regReturn);
29962c04131cSdrh     sqlite3VdbeChangeP1(v, pExpr->y.sub.iAddr-1, sqlite3VdbeCurrentAddr(v)-1);
29976d2566dfSdrh     sqlite3ClearTempRegCache(pParse);
299885bcdce2Sdrh   }
299985bcdce2Sdrh }
300085bcdce2Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
300185bcdce2Sdrh 
300285bcdce2Sdrh /*
300385bcdce2Sdrh ** Generate code for scalar subqueries used as a subquery expression
300485bcdce2Sdrh ** or EXISTS operator:
300585bcdce2Sdrh **
300685bcdce2Sdrh **     (SELECT a FROM b)          -- subquery
300785bcdce2Sdrh **     EXISTS (SELECT a FROM b)   -- EXISTS subquery
300885bcdce2Sdrh **
300985bcdce2Sdrh ** The pExpr parameter is the SELECT or EXISTS operator to be coded.
301085bcdce2Sdrh **
3011d86fe44aSdrh ** Return the register that holds the result.  For a multi-column SELECT,
301285bcdce2Sdrh ** the result is stored in a contiguous array of registers and the
301385bcdce2Sdrh ** return value is the register of the left-most result column.
301485bcdce2Sdrh ** Return 0 if an error occurs.
301585bcdce2Sdrh */
301685bcdce2Sdrh #ifndef SQLITE_OMIT_SUBQUERY
301785bcdce2Sdrh int sqlite3CodeSubselect(Parse *pParse, Expr *pExpr){
30182c04131cSdrh   int addrOnce = 0;           /* Address of OP_Once at top of subroutine */
301985bcdce2Sdrh   int rReg = 0;               /* Register storing resulting */
302085bcdce2Sdrh   Select *pSel;               /* SELECT statement to encode */
302185bcdce2Sdrh   SelectDest dest;            /* How to deal with SELECT result */
302285bcdce2Sdrh   int nReg;                   /* Registers to allocate */
302385bcdce2Sdrh   Expr *pLimit;               /* New limit expression */
30242c04131cSdrh 
30252c04131cSdrh   Vdbe *v = pParse->pVdbe;
302685bcdce2Sdrh   assert( v!=0 );
3027bd462bccSdrh   testcase( pExpr->op==TK_EXISTS );
3028bd462bccSdrh   testcase( pExpr->op==TK_SELECT );
3029bd462bccSdrh   assert( pExpr->op==TK_EXISTS || pExpr->op==TK_SELECT );
3030bd462bccSdrh   assert( ExprHasProperty(pExpr, EP_xIsSelect) );
3031bd462bccSdrh   pSel = pExpr->x.pSelect;
303285bcdce2Sdrh 
30335198ff57Sdrh   /* The evaluation of the EXISTS/SELECT must be repeated every time it
303485bcdce2Sdrh   ** is encountered if any of the following is true:
303585bcdce2Sdrh   **
303685bcdce2Sdrh   **    *  The right-hand side is a correlated subquery
303785bcdce2Sdrh   **    *  The right-hand side is an expression list containing variables
303885bcdce2Sdrh   **    *  We are inside a trigger
303985bcdce2Sdrh   **
304085bcdce2Sdrh   ** If all of the above are false, then we can run this code just once
304185bcdce2Sdrh   ** save the results, and reuse the same result on subsequent invocations.
304285bcdce2Sdrh   */
304385bcdce2Sdrh   if( !ExprHasProperty(pExpr, EP_VarSelect) ){
30445198ff57Sdrh     /* If this routine has already been coded, then invoke it as a
30455198ff57Sdrh     ** subroutine. */
30465198ff57Sdrh     if( ExprHasProperty(pExpr, EP_Subrtn) ){
3047bd462bccSdrh       ExplainQueryPlan((pParse, 0, "REUSE SUBQUERY %d", pSel->selId));
30485198ff57Sdrh       sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
30495198ff57Sdrh                         pExpr->y.sub.iAddr);
30505198ff57Sdrh       return pExpr->iTable;
30515198ff57Sdrh     }
30525198ff57Sdrh 
30535198ff57Sdrh     /* Begin coding the subroutine */
30545198ff57Sdrh     ExprSetProperty(pExpr, EP_Subrtn);
30555198ff57Sdrh     pExpr->y.sub.regReturn = ++pParse->nMem;
30565198ff57Sdrh     pExpr->y.sub.iAddr =
30575198ff57Sdrh       sqlite3VdbeAddOp2(v, OP_Integer, 0, pExpr->y.sub.regReturn) + 1;
30585198ff57Sdrh     VdbeComment((v, "return address"));
30595198ff57Sdrh 
30602c04131cSdrh     addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
3061fef5208cSdrh   }
3062fef5208cSdrh 
306385bcdce2Sdrh   /* For a SELECT, generate code to put the values for all columns of
306439a11819Sdrh   ** the first row into an array of registers and return the index of
306539a11819Sdrh   ** the first register.
306639a11819Sdrh   **
306739a11819Sdrh   ** If this is an EXISTS, write an integer 0 (not exists) or 1 (exists)
306839a11819Sdrh   ** into a register and return that register number.
306939a11819Sdrh   **
307039a11819Sdrh   ** In both cases, the query is augmented with "LIMIT 1".  Any
307139a11819Sdrh   ** preexisting limit is discarded in place of the new LIMIT 1.
3072fef5208cSdrh   */
3073bd462bccSdrh   ExplainQueryPlan((pParse, 1, "%sSCALAR SUBQUERY %d",
3074bd462bccSdrh         addrOnce?"":"CORRELATED ", pSel->selId));
307571c57db0Sdan   nReg = pExpr->op==TK_SELECT ? pSel->pEList->nExpr : 1;
307671c57db0Sdan   sqlite3SelectDestInit(&dest, 0, pParse->nMem+1);
307771c57db0Sdan   pParse->nMem += nReg;
307851522cd3Sdrh   if( pExpr->op==TK_SELECT ){
30796c8c8ce0Sdanielk1977     dest.eDest = SRT_Mem;
308053932ce8Sdrh     dest.iSdst = dest.iSDParm;
308171c57db0Sdan     dest.nSdst = nReg;
308271c57db0Sdan     sqlite3VdbeAddOp3(v, OP_Null, 0, dest.iSDParm, dest.iSDParm+nReg-1);
3083d4e70ebdSdrh     VdbeComment((v, "Init subquery result"));
308451522cd3Sdrh   }else{
30856c8c8ce0Sdanielk1977     dest.eDest = SRT_Exists;
30862b596da8Sdrh     sqlite3VdbeAddOp2(v, OP_Integer, 0, dest.iSDParm);
3087d4e70ebdSdrh     VdbeComment((v, "Init EXISTS result"));
308851522cd3Sdrh   }
30898c0833fbSdrh   if( pSel->pLimit ){
30907ca1347fSdrh     /* The subquery already has a limit.  If the pre-existing limit is X
30917ca1347fSdrh     ** then make the new limit X<>0 so that the new limit is either 1 or 0 */
30927ca1347fSdrh     sqlite3 *db = pParse->db;
30935776ee5cSdrh     pLimit = sqlite3Expr(db, TK_INTEGER, "0");
30947ca1347fSdrh     if( pLimit ){
30957ca1347fSdrh       pLimit->affExpr = SQLITE_AFF_NUMERIC;
30967ca1347fSdrh       pLimit = sqlite3PExpr(pParse, TK_NE,
30977ca1347fSdrh                             sqlite3ExprDup(db, pSel->pLimit->pLeft, 0), pLimit);
30987ca1347fSdrh     }
30997ca1347fSdrh     sqlite3ExprDelete(db, pSel->pLimit->pLeft);
31008c0833fbSdrh     pSel->pLimit->pLeft = pLimit;
31018c0833fbSdrh   }else{
31027ca1347fSdrh     /* If there is no pre-existing limit add a limit of 1 */
31035776ee5cSdrh     pLimit = sqlite3Expr(pParse->db, TK_INTEGER, "1");
31048c0833fbSdrh     pSel->pLimit = sqlite3PExpr(pParse, TK_LIMIT, pLimit, 0);
31058c0833fbSdrh   }
310648b5b041Sdrh   pSel->iLimit = 0;
31077d10d5a6Sdrh   if( sqlite3Select(pParse, pSel, &dest) ){
31081450bc6eSdrh     return 0;
310994ccde58Sdrh   }
31102c04131cSdrh   pExpr->iTable = rReg = dest.iSDParm;
3111ebb6a65dSdrh   ExprSetVVAProperty(pExpr, EP_NoReduce);
31122c04131cSdrh   if( addrOnce ){
31132c04131cSdrh     sqlite3VdbeJumpHere(v, addrOnce);
3114fc976065Sdanielk1977 
31152c04131cSdrh     /* Subroutine return */
31162c04131cSdrh     sqlite3VdbeAddOp1(v, OP_Return, pExpr->y.sub.regReturn);
31172c04131cSdrh     sqlite3VdbeChangeP1(v, pExpr->y.sub.iAddr-1, sqlite3VdbeCurrentAddr(v)-1);
31186d2566dfSdrh     sqlite3ClearTempRegCache(pParse);
31195198ff57Sdrh   }
31202c04131cSdrh 
31211450bc6eSdrh   return rReg;
3122cce7d176Sdrh }
312351522cd3Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
3124cce7d176Sdrh 
3125e3365e6cSdrh #ifndef SQLITE_OMIT_SUBQUERY
3126e3365e6cSdrh /*
31277b35a77bSdan ** Expr pIn is an IN(...) expression. This function checks that the
31287b35a77bSdan ** sub-select on the RHS of the IN() operator has the same number of
31297b35a77bSdan ** columns as the vector on the LHS. Or, if the RHS of the IN() is not
31307b35a77bSdan ** a sub-query, that the LHS is a vector of size 1.
31317b35a77bSdan */
31327b35a77bSdan int sqlite3ExprCheckIN(Parse *pParse, Expr *pIn){
31337b35a77bSdan   int nVector = sqlite3ExprVectorSize(pIn->pLeft);
31347b35a77bSdan   if( (pIn->flags & EP_xIsSelect) ){
31357b35a77bSdan     if( nVector!=pIn->x.pSelect->pEList->nExpr ){
31367b35a77bSdan       sqlite3SubselectError(pParse, pIn->x.pSelect->pEList->nExpr, nVector);
31377b35a77bSdan       return 1;
31387b35a77bSdan     }
31397b35a77bSdan   }else if( nVector!=1 ){
314044c5604cSdan     sqlite3VectorErrorMsg(pParse, pIn->pLeft);
31417b35a77bSdan     return 1;
31427b35a77bSdan   }
31437b35a77bSdan   return 0;
31447b35a77bSdan }
31457b35a77bSdan #endif
31467b35a77bSdan 
31477b35a77bSdan #ifndef SQLITE_OMIT_SUBQUERY
31487b35a77bSdan /*
3149e3365e6cSdrh ** Generate code for an IN expression.
3150e3365e6cSdrh **
3151e3365e6cSdrh **      x IN (SELECT ...)
3152e3365e6cSdrh **      x IN (value, value, ...)
3153e3365e6cSdrh **
3154ecb87ac8Sdrh ** The left-hand side (LHS) is a scalar or vector expression.  The
3155e347d3e8Sdrh ** right-hand side (RHS) is an array of zero or more scalar values, or a
3156e347d3e8Sdrh ** subquery.  If the RHS is a subquery, the number of result columns must
3157e347d3e8Sdrh ** match the number of columns in the vector on the LHS.  If the RHS is
3158e347d3e8Sdrh ** a list of values, the LHS must be a scalar.
3159e347d3e8Sdrh **
3160e347d3e8Sdrh ** The IN operator is true if the LHS value is contained within the RHS.
3161e347d3e8Sdrh ** The result is false if the LHS is definitely not in the RHS.  The
3162e347d3e8Sdrh ** result is NULL if the presence of the LHS in the RHS cannot be
3163e347d3e8Sdrh ** determined due to NULLs.
3164e3365e6cSdrh **
31656be515ebSdrh ** This routine generates code that jumps to destIfFalse if the LHS is not
3166e3365e6cSdrh ** contained within the RHS.  If due to NULLs we cannot determine if the LHS
3167e3365e6cSdrh ** is contained in the RHS then jump to destIfNull.  If the LHS is contained
3168e3365e6cSdrh ** within the RHS then fall through.
3169ecb87ac8Sdrh **
3170ecb87ac8Sdrh ** See the separate in-operator.md documentation file in the canonical
3171ecb87ac8Sdrh ** SQLite source tree for additional information.
3172e3365e6cSdrh */
3173e3365e6cSdrh static void sqlite3ExprCodeIN(
3174e3365e6cSdrh   Parse *pParse,        /* Parsing and code generating context */
3175e3365e6cSdrh   Expr *pExpr,          /* The IN expression */
3176e3365e6cSdrh   int destIfFalse,      /* Jump here if LHS is not contained in the RHS */
3177e3365e6cSdrh   int destIfNull        /* Jump here if the results are unknown due to NULLs */
3178e3365e6cSdrh ){
3179e3365e6cSdrh   int rRhsHasNull = 0;  /* Register that is true if RHS contains NULL values */
3180e3365e6cSdrh   int eType;            /* Type of the RHS */
3181e347d3e8Sdrh   int rLhs;             /* Register(s) holding the LHS values */
3182e347d3e8Sdrh   int rLhsOrig;         /* LHS values prior to reordering by aiMap[] */
3183e3365e6cSdrh   Vdbe *v;              /* Statement under construction */
3184ba00e30aSdan   int *aiMap = 0;       /* Map from vector field to index column */
3185ba00e30aSdan   char *zAff = 0;       /* Affinity string for comparisons */
3186ecb87ac8Sdrh   int nVector;          /* Size of vectors for this IN operator */
318712abf408Sdrh   int iDummy;           /* Dummy parameter to exprCodeVector() */
3188e347d3e8Sdrh   Expr *pLeft;          /* The LHS of the IN operator */
3189ecb87ac8Sdrh   int i;                /* loop counter */
3190e347d3e8Sdrh   int destStep2;        /* Where to jump when NULLs seen in step 2 */
3191e347d3e8Sdrh   int destStep6 = 0;    /* Start of code for Step 6 */
3192e347d3e8Sdrh   int addrTruthOp;      /* Address of opcode that determines the IN is true */
3193e347d3e8Sdrh   int destNotNull;      /* Jump here if a comparison is not true in step 6 */
3194e347d3e8Sdrh   int addrTop;          /* Top of the step-6 loop */
31952c04131cSdrh   int iTab = 0;         /* Index to use */
3196c59b4acfSdan   u8 okConstFactor = pParse->okConstFactor;
3197e3365e6cSdrh 
3198e7375bfaSdrh   assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
3199e347d3e8Sdrh   pLeft = pExpr->pLeft;
32007b35a77bSdan   if( sqlite3ExprCheckIN(pParse, pExpr) ) return;
3201553168c7Sdan   zAff = exprINAffinity(pParse, pExpr);
3202ba00e30aSdan   nVector = sqlite3ExprVectorSize(pExpr->pLeft);
3203ba00e30aSdan   aiMap = (int*)sqlite3DbMallocZero(
3204ba00e30aSdan       pParse->db, nVector*(sizeof(int) + sizeof(char)) + 1
3205ba00e30aSdan   );
3206e347d3e8Sdrh   if( pParse->db->mallocFailed ) goto sqlite3ExprCodeIN_oom_error;
32077b35a77bSdan 
3208ba00e30aSdan   /* Attempt to compute the RHS. After this step, if anything other than
32092c04131cSdrh   ** IN_INDEX_NOOP is returned, the table opened with cursor iTab
3210ba00e30aSdan   ** contains the values that make up the RHS. If IN_INDEX_NOOP is returned,
3211ba00e30aSdan   ** the RHS has not yet been coded.  */
3212e3365e6cSdrh   v = pParse->pVdbe;
3213e3365e6cSdrh   assert( v!=0 );       /* OOM detected prior to this routine */
3214e3365e6cSdrh   VdbeNoopComment((v, "begin IN expr"));
3215bb53ecb1Sdrh   eType = sqlite3FindInIndex(pParse, pExpr,
3216bb53ecb1Sdrh                              IN_INDEX_MEMBERSHIP | IN_INDEX_NOOP_OK,
32172c04131cSdrh                              destIfFalse==destIfNull ? 0 : &rRhsHasNull,
32182c04131cSdrh                              aiMap, &iTab);
3219e3365e6cSdrh 
3220ba00e30aSdan   assert( pParse->nErr || nVector==1 || eType==IN_INDEX_EPH
3221ba00e30aSdan        || eType==IN_INDEX_INDEX_ASC || eType==IN_INDEX_INDEX_DESC
3222ba00e30aSdan   );
3223ecb87ac8Sdrh #ifdef SQLITE_DEBUG
3224ecb87ac8Sdrh   /* Confirm that aiMap[] contains nVector integer values between 0 and
3225ecb87ac8Sdrh   ** nVector-1. */
3226ecb87ac8Sdrh   for(i=0; i<nVector; i++){
3227ecb87ac8Sdrh     int j, cnt;
3228ecb87ac8Sdrh     for(cnt=j=0; j<nVector; j++) if( aiMap[j]==i ) cnt++;
3229ecb87ac8Sdrh     assert( cnt==1 );
3230ecb87ac8Sdrh   }
3231ecb87ac8Sdrh #endif
3232e3365e6cSdrh 
3233ba00e30aSdan   /* Code the LHS, the <expr> from "<expr> IN (...)". If the LHS is a
3234ba00e30aSdan   ** vector, then it is stored in an array of nVector registers starting
3235ba00e30aSdan   ** at r1.
3236e347d3e8Sdrh   **
3237e347d3e8Sdrh   ** sqlite3FindInIndex() might have reordered the fields of the LHS vector
3238e347d3e8Sdrh   ** so that the fields are in the same order as an existing index.   The
3239e347d3e8Sdrh   ** aiMap[] array contains a mapping from the original LHS field order to
3240e347d3e8Sdrh   ** the field order that matches the RHS index.
3241c59b4acfSdan   **
3242c59b4acfSdan   ** Avoid factoring the LHS of the IN(...) expression out of the loop,
3243c59b4acfSdan   ** even if it is constant, as OP_Affinity may be used on the register
3244c59b4acfSdan   ** by code generated below.  */
3245c59b4acfSdan   assert( pParse->okConstFactor==okConstFactor );
3246c59b4acfSdan   pParse->okConstFactor = 0;
3247e347d3e8Sdrh   rLhsOrig = exprCodeVector(pParse, pLeft, &iDummy);
3248c59b4acfSdan   pParse->okConstFactor = okConstFactor;
3249e347d3e8Sdrh   for(i=0; i<nVector && aiMap[i]==i; i++){} /* Are LHS fields reordered? */
3250ecb87ac8Sdrh   if( i==nVector ){
3251e347d3e8Sdrh     /* LHS fields are not reordered */
3252e347d3e8Sdrh     rLhs = rLhsOrig;
3253ecb87ac8Sdrh   }else{
3254ecb87ac8Sdrh     /* Need to reorder the LHS fields according to aiMap */
3255e347d3e8Sdrh     rLhs = sqlite3GetTempRange(pParse, nVector);
3256ba00e30aSdan     for(i=0; i<nVector; i++){
3257e347d3e8Sdrh       sqlite3VdbeAddOp3(v, OP_Copy, rLhsOrig+i, rLhs+aiMap[i], 0);
3258ba00e30aSdan     }
3259ecb87ac8Sdrh   }
3260e3365e6cSdrh 
3261bb53ecb1Sdrh   /* If sqlite3FindInIndex() did not find or create an index that is
3262bb53ecb1Sdrh   ** suitable for evaluating the IN operator, then evaluate using a
3263bb53ecb1Sdrh   ** sequence of comparisons.
3264e347d3e8Sdrh   **
3265e347d3e8Sdrh   ** This is step (1) in the in-operator.md optimized algorithm.
3266bb53ecb1Sdrh   */
3267bb53ecb1Sdrh   if( eType==IN_INDEX_NOOP ){
3268bb53ecb1Sdrh     ExprList *pList = pExpr->x.pList;
3269bb53ecb1Sdrh     CollSeq *pColl = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
3270ec4ccdbcSdrh     int labelOk = sqlite3VdbeMakeLabel(pParse);
3271bb53ecb1Sdrh     int r2, regToFree;
3272bb53ecb1Sdrh     int regCkNull = 0;
3273bb53ecb1Sdrh     int ii;
3274bb53ecb1Sdrh     assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
3275bb53ecb1Sdrh     if( destIfNull!=destIfFalse ){
3276bb53ecb1Sdrh       regCkNull = sqlite3GetTempReg(pParse);
3277e347d3e8Sdrh       sqlite3VdbeAddOp3(v, OP_BitAnd, rLhs, rLhs, regCkNull);
3278bb53ecb1Sdrh     }
3279bb53ecb1Sdrh     for(ii=0; ii<pList->nExpr; ii++){
32804fc83654Sdrh       r2 = sqlite3ExprCodeTemp(pParse, pList->a[ii].pExpr, &regToFree);
3281a976979bSdrh       if( regCkNull && sqlite3ExprCanBeNull(pList->a[ii].pExpr) ){
3282bb53ecb1Sdrh         sqlite3VdbeAddOp3(v, OP_BitAnd, regCkNull, r2, regCkNull);
3283bb53ecb1Sdrh       }
3284f6ea97eaSdrh       sqlite3ReleaseTempReg(pParse, regToFree);
3285bb53ecb1Sdrh       if( ii<pList->nExpr-1 || destIfNull!=destIfFalse ){
32864799488eSdrh         int op = rLhs!=r2 ? OP_Eq : OP_NotNull;
32874799488eSdrh         sqlite3VdbeAddOp4(v, op, rLhs, labelOk, r2,
32884336b0e6Sdrh                           (void*)pColl, P4_COLLSEQ);
32894799488eSdrh         VdbeCoverageIf(v, ii<pList->nExpr-1 && op==OP_Eq);
32904799488eSdrh         VdbeCoverageIf(v, ii==pList->nExpr-1 && op==OP_Eq);
32914799488eSdrh         VdbeCoverageIf(v, ii<pList->nExpr-1 && op==OP_NotNull);
32924799488eSdrh         VdbeCoverageIf(v, ii==pList->nExpr-1 && op==OP_NotNull);
3293ba00e30aSdan         sqlite3VdbeChangeP5(v, zAff[0]);
3294bb53ecb1Sdrh       }else{
32954799488eSdrh         int op = rLhs!=r2 ? OP_Ne : OP_IsNull;
3296bb53ecb1Sdrh         assert( destIfNull==destIfFalse );
32974799488eSdrh         sqlite3VdbeAddOp4(v, op, rLhs, destIfFalse, r2,
32984799488eSdrh                           (void*)pColl, P4_COLLSEQ);
32994799488eSdrh         VdbeCoverageIf(v, op==OP_Ne);
33004799488eSdrh         VdbeCoverageIf(v, op==OP_IsNull);
3301ba00e30aSdan         sqlite3VdbeChangeP5(v, zAff[0] | SQLITE_JUMPIFNULL);
3302bb53ecb1Sdrh       }
3303bb53ecb1Sdrh     }
3304bb53ecb1Sdrh     if( regCkNull ){
3305bb53ecb1Sdrh       sqlite3VdbeAddOp2(v, OP_IsNull, regCkNull, destIfNull); VdbeCoverage(v);
3306076e85f5Sdrh       sqlite3VdbeGoto(v, destIfFalse);
3307bb53ecb1Sdrh     }
3308bb53ecb1Sdrh     sqlite3VdbeResolveLabel(v, labelOk);
3309bb53ecb1Sdrh     sqlite3ReleaseTempReg(pParse, regCkNull);
3310e347d3e8Sdrh     goto sqlite3ExprCodeIN_finished;
3311e347d3e8Sdrh   }
3312bb53ecb1Sdrh 
3313e347d3e8Sdrh   /* Step 2: Check to see if the LHS contains any NULL columns.  If the
3314e347d3e8Sdrh   ** LHS does contain NULLs then the result must be either FALSE or NULL.
3315e347d3e8Sdrh   ** We will then skip the binary search of the RHS.
3316e347d3e8Sdrh   */
3317094430ebSdrh   if( destIfNull==destIfFalse ){
3318e347d3e8Sdrh     destStep2 = destIfFalse;
3319e347d3e8Sdrh   }else{
3320ec4ccdbcSdrh     destStep2 = destStep6 = sqlite3VdbeMakeLabel(pParse);
3321e347d3e8Sdrh   }
33224eac5f04Sdrh   if( pParse->nErr ) goto sqlite3ExprCodeIN_finished;
3323d49fd4e8Sdan   for(i=0; i<nVector; i++){
3324fc7f27b9Sdrh     Expr *p = sqlite3VectorFieldSubexpr(pExpr->pLeft, i);
3325d49fd4e8Sdan     if( sqlite3ExprCanBeNull(p) ){
3326e347d3e8Sdrh       sqlite3VdbeAddOp2(v, OP_IsNull, rLhs+i, destStep2);
3327471b4b92Sdrh       VdbeCoverage(v);
3328d49fd4e8Sdan     }
3329d49fd4e8Sdan   }
3330e3365e6cSdrh 
3331e347d3e8Sdrh   /* Step 3.  The LHS is now known to be non-NULL.  Do the binary search
3332e347d3e8Sdrh   ** of the RHS using the LHS as a probe.  If found, the result is
3333e347d3e8Sdrh   ** true.
3334e347d3e8Sdrh   */
3335e3365e6cSdrh   if( eType==IN_INDEX_ROWID ){
3336e347d3e8Sdrh     /* In this case, the RHS is the ROWID of table b-tree and so we also
3337e347d3e8Sdrh     ** know that the RHS is non-NULL.  Hence, we combine steps 3 and 4
3338e347d3e8Sdrh     ** into a single opcode. */
33392c04131cSdrh     sqlite3VdbeAddOp3(v, OP_SeekRowid, iTab, destIfFalse, rLhs);
3340688852abSdrh     VdbeCoverage(v);
3341e347d3e8Sdrh     addrTruthOp = sqlite3VdbeAddOp0(v, OP_Goto);  /* Return True */
33427b35a77bSdan   }else{
3343e347d3e8Sdrh     sqlite3VdbeAddOp4(v, OP_Affinity, rLhs, nVector, 0, zAff, nVector);
3344e347d3e8Sdrh     if( destIfFalse==destIfNull ){
3345e347d3e8Sdrh       /* Combine Step 3 and Step 5 into a single opcode */
33462c04131cSdrh       sqlite3VdbeAddOp4Int(v, OP_NotFound, iTab, destIfFalse,
3347e347d3e8Sdrh                            rLhs, nVector); VdbeCoverage(v);
3348e347d3e8Sdrh       goto sqlite3ExprCodeIN_finished;
3349e347d3e8Sdrh     }
3350e347d3e8Sdrh     /* Ordinary Step 3, for the case where FALSE and NULL are distinct */
33512c04131cSdrh     addrTruthOp = sqlite3VdbeAddOp4Int(v, OP_Found, iTab, 0,
3352e347d3e8Sdrh                                       rLhs, nVector); VdbeCoverage(v);
3353e347d3e8Sdrh   }
3354ba00e30aSdan 
3355e347d3e8Sdrh   /* Step 4.  If the RHS is known to be non-NULL and we did not find
3356e347d3e8Sdrh   ** an match on the search above, then the result must be FALSE.
3357e347d3e8Sdrh   */
3358e347d3e8Sdrh   if( rRhsHasNull && nVector==1 ){
3359e347d3e8Sdrh     sqlite3VdbeAddOp2(v, OP_NotNull, rRhsHasNull, destIfFalse);
3360471b4b92Sdrh     VdbeCoverage(v);
3361e347d3e8Sdrh   }
33627b35a77bSdan 
3363e347d3e8Sdrh   /* Step 5.  If we do not care about the difference between NULL and
3364e347d3e8Sdrh   ** FALSE, then just return false.
3365e347d3e8Sdrh   */
3366e347d3e8Sdrh   if( destIfFalse==destIfNull ) sqlite3VdbeGoto(v, destIfFalse);
3367e347d3e8Sdrh 
3368e347d3e8Sdrh   /* Step 6: Loop through rows of the RHS.  Compare each row to the LHS.
3369e347d3e8Sdrh   ** If any comparison is NULL, then the result is NULL.  If all
3370e347d3e8Sdrh   ** comparisons are FALSE then the final result is FALSE.
3371e347d3e8Sdrh   **
3372e347d3e8Sdrh   ** For a scalar LHS, it is sufficient to check just the first row
3373e347d3e8Sdrh   ** of the RHS.
3374e347d3e8Sdrh   */
3375e347d3e8Sdrh   if( destStep6 ) sqlite3VdbeResolveLabel(v, destStep6);
33762c04131cSdrh   addrTop = sqlite3VdbeAddOp2(v, OP_Rewind, iTab, destIfFalse);
3377471b4b92Sdrh   VdbeCoverage(v);
3378e347d3e8Sdrh   if( nVector>1 ){
3379ec4ccdbcSdrh     destNotNull = sqlite3VdbeMakeLabel(pParse);
3380e347d3e8Sdrh   }else{
3381e347d3e8Sdrh     /* For nVector==1, combine steps 6 and 7 by immediately returning
3382e347d3e8Sdrh     ** FALSE if the first comparison is not NULL */
3383e347d3e8Sdrh     destNotNull = destIfFalse;
3384e347d3e8Sdrh   }
3385ba00e30aSdan   for(i=0; i<nVector; i++){
3386ba00e30aSdan     Expr *p;
3387ba00e30aSdan     CollSeq *pColl;
3388e347d3e8Sdrh     int r3 = sqlite3GetTempReg(pParse);
3389fc7f27b9Sdrh     p = sqlite3VectorFieldSubexpr(pLeft, i);
3390ba00e30aSdan     pColl = sqlite3ExprCollSeq(pParse, p);
33912c04131cSdrh     sqlite3VdbeAddOp3(v, OP_Column, iTab, i, r3);
3392e347d3e8Sdrh     sqlite3VdbeAddOp4(v, OP_Ne, rLhs+i, destNotNull, r3,
339318016ad2Sdrh                       (void*)pColl, P4_COLLSEQ);
3394471b4b92Sdrh     VdbeCoverage(v);
3395e347d3e8Sdrh     sqlite3ReleaseTempReg(pParse, r3);
33967b35a77bSdan   }
33977b35a77bSdan   sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfNull);
3398e347d3e8Sdrh   if( nVector>1 ){
3399e347d3e8Sdrh     sqlite3VdbeResolveLabel(v, destNotNull);
34002c04131cSdrh     sqlite3VdbeAddOp2(v, OP_Next, iTab, addrTop+1);
340118016ad2Sdrh     VdbeCoverage(v);
3402e347d3e8Sdrh 
3403e347d3e8Sdrh     /* Step 7:  If we reach this point, we know that the result must
3404e347d3e8Sdrh     ** be false. */
340518016ad2Sdrh     sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfFalse);
34067b35a77bSdan   }
34077b35a77bSdan 
3408e347d3e8Sdrh   /* Jumps here in order to return true. */
3409e347d3e8Sdrh   sqlite3VdbeJumpHere(v, addrTruthOp);
3410e3365e6cSdrh 
3411e347d3e8Sdrh sqlite3ExprCodeIN_finished:
3412e347d3e8Sdrh   if( rLhs!=rLhsOrig ) sqlite3ReleaseTempReg(pParse, rLhs);
3413ecb87ac8Sdrh   VdbeComment((v, "end IN expr"));
3414e347d3e8Sdrh sqlite3ExprCodeIN_oom_error:
3415ba00e30aSdan   sqlite3DbFree(pParse->db, aiMap);
3416553168c7Sdan   sqlite3DbFree(pParse->db, zAff);
3417e3365e6cSdrh }
3418e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
3419e3365e6cSdrh 
342013573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
3421598f1340Sdrh /*
3422598f1340Sdrh ** Generate an instruction that will put the floating point
34239cbf3425Sdrh ** value described by z[0..n-1] into register iMem.
34240cf19ed8Sdrh **
34250cf19ed8Sdrh ** The z[] string will probably not be zero-terminated.  But the
34260cf19ed8Sdrh ** z[n] character is guaranteed to be something that does not look
34270cf19ed8Sdrh ** like the continuation of the number.
3428598f1340Sdrh */
3429b7916a78Sdrh static void codeReal(Vdbe *v, const char *z, int negateFlag, int iMem){
3430fd773cf9Sdrh   if( ALWAYS(z!=0) ){
3431598f1340Sdrh     double value;
34329339da1fSdrh     sqlite3AtoF(z, &value, sqlite3Strlen30(z), SQLITE_UTF8);
3433d0015161Sdrh     assert( !sqlite3IsNaN(value) ); /* The new AtoF never returns NaN */
3434598f1340Sdrh     if( negateFlag ) value = -value;
343597bae794Sdrh     sqlite3VdbeAddOp4Dup8(v, OP_Real, 0, iMem, 0, (u8*)&value, P4_REAL);
3436598f1340Sdrh   }
3437598f1340Sdrh }
343813573c71Sdrh #endif
3439598f1340Sdrh 
3440598f1340Sdrh 
3441598f1340Sdrh /*
3442fec19aadSdrh ** Generate an instruction that will put the integer describe by
34439cbf3425Sdrh ** text z[0..n-1] into register iMem.
34440cf19ed8Sdrh **
34455f1d6b61Sshaneh ** Expr.u.zToken is always UTF8 and zero-terminated.
3446fec19aadSdrh */
344713573c71Sdrh static void codeInteger(Parse *pParse, Expr *pExpr, int negFlag, int iMem){
344813573c71Sdrh   Vdbe *v = pParse->pVdbe;
344992b01d53Sdrh   if( pExpr->flags & EP_IntValue ){
345033e619fcSdrh     int i = pExpr->u.iValue;
3451d50ffc41Sdrh     assert( i>=0 );
345292b01d53Sdrh     if( negFlag ) i = -i;
345392b01d53Sdrh     sqlite3VdbeAddOp2(v, OP_Integer, i, iMem);
3454fd773cf9Sdrh   }else{
34555f1d6b61Sshaneh     int c;
34565f1d6b61Sshaneh     i64 value;
3457fd773cf9Sdrh     const char *z = pExpr->u.zToken;
3458fd773cf9Sdrh     assert( z!=0 );
34599296c18aSdrh     c = sqlite3DecOrHexToI64(z, &value);
346084d4f1a3Sdrh     if( (c==3 && !negFlag) || (c==2) || (negFlag && value==SMALLEST_INT64)){
346113573c71Sdrh #ifdef SQLITE_OMIT_FLOATING_POINT
346213573c71Sdrh       sqlite3ErrorMsg(pParse, "oversized integer: %s%s", negFlag ? "-" : "", z);
346313573c71Sdrh #else
34641b7ddc59Sdrh #ifndef SQLITE_OMIT_HEX_INTEGER
34659296c18aSdrh       if( sqlite3_strnicmp(z,"0x",2)==0 ){
346677320ea4Sdrh         sqlite3ErrorMsg(pParse, "hex literal too big: %s%s", negFlag?"-":"",z);
34671b7ddc59Sdrh       }else
34681b7ddc59Sdrh #endif
34691b7ddc59Sdrh       {
3470b7916a78Sdrh         codeReal(v, z, negFlag, iMem);
34719296c18aSdrh       }
347213573c71Sdrh #endif
347377320ea4Sdrh     }else{
347484d4f1a3Sdrh       if( negFlag ){ value = c==3 ? SMALLEST_INT64 : -value; }
347577320ea4Sdrh       sqlite3VdbeAddOp4Dup8(v, OP_Int64, 0, iMem, 0, (u8*)&value, P4_INT64);
3476fec19aadSdrh     }
3477fec19aadSdrh   }
3478c9cf901dSdanielk1977 }
3479fec19aadSdrh 
34805cd79239Sdrh 
34811f9ca2c8Sdrh /* Generate code that will load into register regOut a value that is
34821f9ca2c8Sdrh ** appropriate for the iIdxCol-th column of index pIdx.
34831f9ca2c8Sdrh */
34841f9ca2c8Sdrh void sqlite3ExprCodeLoadIndexColumn(
34851f9ca2c8Sdrh   Parse *pParse,  /* The parsing context */
34861f9ca2c8Sdrh   Index *pIdx,    /* The index whose column is to be loaded */
34871f9ca2c8Sdrh   int iTabCur,    /* Cursor pointing to a table row */
34881f9ca2c8Sdrh   int iIdxCol,    /* The column of the index to be loaded */
34891f9ca2c8Sdrh   int regOut      /* Store the index column value in this register */
34901f9ca2c8Sdrh ){
34911f9ca2c8Sdrh   i16 iTabCol = pIdx->aiColumn[iIdxCol];
34924b92f98cSdrh   if( iTabCol==XN_EXPR ){
34931f9ca2c8Sdrh     assert( pIdx->aColExpr );
34941f9ca2c8Sdrh     assert( pIdx->aColExpr->nExpr>iIdxCol );
34953e34eabcSdrh     pParse->iSelfTab = iTabCur + 1;
34961c75c9d7Sdrh     sqlite3ExprCodeCopy(pParse, pIdx->aColExpr->a[iIdxCol].pExpr, regOut);
34973e34eabcSdrh     pParse->iSelfTab = 0;
34984b92f98cSdrh   }else{
34996df9c4b9Sdrh     sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pIdx->pTable, iTabCur,
35004b92f98cSdrh                                     iTabCol, regOut);
35014b92f98cSdrh   }
35021f9ca2c8Sdrh }
35031f9ca2c8Sdrh 
3504e70fa7feSdrh #ifndef SQLITE_OMIT_GENERATED_COLUMNS
3505e70fa7feSdrh /*
3506e70fa7feSdrh ** Generate code that will compute the value of generated column pCol
3507e70fa7feSdrh ** and store the result in register regOut
3508e70fa7feSdrh */
3509e70fa7feSdrh void sqlite3ExprCodeGeneratedColumn(
3510e70fa7feSdrh   Parse *pParse,
3511e70fa7feSdrh   Column *pCol,
3512e70fa7feSdrh   int regOut
3513e70fa7feSdrh ){
35144dad7ed5Sdrh   int iAddr;
35154dad7ed5Sdrh   Vdbe *v = pParse->pVdbe;
35164dad7ed5Sdrh   assert( v!=0 );
35174dad7ed5Sdrh   assert( pParse->iSelfTab!=0 );
35184dad7ed5Sdrh   if( pParse->iSelfTab>0 ){
35194dad7ed5Sdrh     iAddr = sqlite3VdbeAddOp3(v, OP_IfNullRow, pParse->iSelfTab-1, 0, regOut);
35204dad7ed5Sdrh   }else{
35214dad7ed5Sdrh     iAddr = 0;
35224dad7ed5Sdrh   }
352324e39903Sdrh   sqlite3ExprCodeCopy(pParse, pCol->pDflt, regOut);
3524e70fa7feSdrh   if( pCol->affinity>=SQLITE_AFF_TEXT ){
35254dad7ed5Sdrh     sqlite3VdbeAddOp4(v, OP_Affinity, regOut, 1, 0, &pCol->affinity, 1);
3526e70fa7feSdrh   }
35274dad7ed5Sdrh   if( iAddr ) sqlite3VdbeJumpHere(v, iAddr);
3528e70fa7feSdrh }
3529e70fa7feSdrh #endif /* SQLITE_OMIT_GENERATED_COLUMNS */
3530e70fa7feSdrh 
35315cd79239Sdrh /*
35325c092e8aSdrh ** Generate code to extract the value of the iCol-th column of a table.
35335c092e8aSdrh */
35345c092e8aSdrh void sqlite3ExprCodeGetColumnOfTable(
35356df9c4b9Sdrh   Vdbe *v,        /* Parsing context */
35365c092e8aSdrh   Table *pTab,    /* The table containing the value */
3537313619f5Sdrh   int iTabCur,    /* The table cursor.  Or the PK cursor for WITHOUT ROWID */
35385c092e8aSdrh   int iCol,       /* Index of the column to extract */
3539313619f5Sdrh   int regOut      /* Extract the value into this register */
35405c092e8aSdrh ){
3541ab45fc04Sdrh   Column *pCol;
354281f7b372Sdrh   assert( v!=0 );
3543aca19e19Sdrh   if( pTab==0 ){
3544aca19e19Sdrh     sqlite3VdbeAddOp3(v, OP_Column, iTabCur, iCol, regOut);
3545aca19e19Sdrh     return;
3546aca19e19Sdrh   }
35475c092e8aSdrh   if( iCol<0 || iCol==pTab->iPKey ){
35485c092e8aSdrh     sqlite3VdbeAddOp2(v, OP_Rowid, iTabCur, regOut);
35495c092e8aSdrh   }else{
355081f7b372Sdrh     int op;
355181f7b372Sdrh     int x;
355281f7b372Sdrh     if( IsVirtual(pTab) ){
355381f7b372Sdrh       op = OP_VColumn;
355481f7b372Sdrh       x = iCol;
355581f7b372Sdrh #ifndef SQLITE_OMIT_GENERATED_COLUMNS
3556ab45fc04Sdrh     }else if( (pCol = &pTab->aCol[iCol])->colFlags & COLFLAG_VIRTUAL ){
35576df9c4b9Sdrh       Parse *pParse = sqlite3VdbeParser(v);
3558ab45fc04Sdrh       if( pCol->colFlags & COLFLAG_BUSY ){
3559ab45fc04Sdrh         sqlite3ErrorMsg(pParse, "generated column loop on \"%s\"", pCol->zName);
3560ab45fc04Sdrh       }else{
356181f7b372Sdrh         int savedSelfTab = pParse->iSelfTab;
3562ab45fc04Sdrh         pCol->colFlags |= COLFLAG_BUSY;
356381f7b372Sdrh         pParse->iSelfTab = iTabCur+1;
3564e70fa7feSdrh         sqlite3ExprCodeGeneratedColumn(pParse, pCol, regOut);
356581f7b372Sdrh         pParse->iSelfTab = savedSelfTab;
3566ab45fc04Sdrh         pCol->colFlags &= ~COLFLAG_BUSY;
3567ab45fc04Sdrh       }
356881f7b372Sdrh       return;
356981f7b372Sdrh #endif
357081f7b372Sdrh     }else if( !HasRowid(pTab) ){
3571c5f808d8Sdrh       testcase( iCol!=sqlite3TableColumnToStorage(pTab, iCol) );
3572b9bcf7caSdrh       x = sqlite3TableColumnToIndex(sqlite3PrimaryKeyIndex(pTab), iCol);
357381f7b372Sdrh       op = OP_Column;
357481f7b372Sdrh     }else{
3575b9bcf7caSdrh       x = sqlite3TableColumnToStorage(pTab,iCol);
3576c5f808d8Sdrh       testcase( x!=iCol );
357781f7b372Sdrh       op = OP_Column;
3578ee0ec8e1Sdrh     }
3579ee0ec8e1Sdrh     sqlite3VdbeAddOp3(v, op, iTabCur, x, regOut);
35805c092e8aSdrh     sqlite3ColumnDefault(v, pTab, iCol, regOut);
35815c092e8aSdrh   }
35825c092e8aSdrh }
35835c092e8aSdrh 
35845c092e8aSdrh /*
3585945498f3Sdrh ** Generate code that will extract the iColumn-th column from
35868c607191Sdrh ** table pTab and store the column value in register iReg.
3587e55cbd72Sdrh **
3588e55cbd72Sdrh ** There must be an open cursor to pTab in iTable when this routine
3589e55cbd72Sdrh ** is called.  If iColumn<0 then code is generated that extracts the rowid.
3590945498f3Sdrh */
3591e55cbd72Sdrh int sqlite3ExprCodeGetColumn(
3592e55cbd72Sdrh   Parse *pParse,   /* Parsing and code generating context */
35932133d822Sdrh   Table *pTab,     /* Description of the table we are reading from */
35942133d822Sdrh   int iColumn,     /* Index of the table column */
35952133d822Sdrh   int iTable,      /* The cursor pointing to the table */
3596a748fdccSdrh   int iReg,        /* Store results here */
3597ce78bc6eSdrh   u8 p5            /* P5 value for OP_Column + FLAGS */
35982133d822Sdrh ){
359981f7b372Sdrh   assert( pParse->pVdbe!=0 );
36006df9c4b9Sdrh   sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pTab, iTable, iColumn, iReg);
3601a748fdccSdrh   if( p5 ){
360299670abbSdrh     VdbeOp *pOp = sqlite3VdbeGetOp(pParse->pVdbe,-1);
360399670abbSdrh     if( pOp->opcode==OP_Column ) pOp->p5 = p5;
3604a748fdccSdrh   }
3605e55cbd72Sdrh   return iReg;
3606e55cbd72Sdrh }
3607e55cbd72Sdrh 
3608e55cbd72Sdrh /*
3609b21e7c70Sdrh ** Generate code to move content from registers iFrom...iFrom+nReg-1
361036a5d88dSdrh ** over to iTo..iTo+nReg-1.
3611e55cbd72Sdrh */
3612b21e7c70Sdrh void sqlite3ExprCodeMove(Parse *pParse, int iFrom, int iTo, int nReg){
3613079a3072Sdrh   sqlite3VdbeAddOp3(pParse->pVdbe, OP_Move, iFrom, iTo, nReg);
3614945498f3Sdrh }
3615945498f3Sdrh 
3616652fbf55Sdrh /*
361712abf408Sdrh ** Convert a scalar expression node to a TK_REGISTER referencing
361812abf408Sdrh ** register iReg.  The caller must ensure that iReg already contains
361912abf408Sdrh ** the correct value for the expression.
3620a4c3c87eSdrh */
3621069d1b1fSdan static void exprToRegister(Expr *pExpr, int iReg){
36220d950af3Sdrh   Expr *p = sqlite3ExprSkipCollateAndLikely(pExpr);
3623a4c3c87eSdrh   p->op2 = p->op;
3624a4c3c87eSdrh   p->op = TK_REGISTER;
3625a4c3c87eSdrh   p->iTable = iReg;
3626a4c3c87eSdrh   ExprClearProperty(p, EP_Skip);
3627a4c3c87eSdrh }
3628a4c3c87eSdrh 
362912abf408Sdrh /*
363012abf408Sdrh ** Evaluate an expression (either a vector or a scalar expression) and store
363112abf408Sdrh ** the result in continguous temporary registers.  Return the index of
363212abf408Sdrh ** the first register used to store the result.
363312abf408Sdrh **
363412abf408Sdrh ** If the returned result register is a temporary scalar, then also write
363512abf408Sdrh ** that register number into *piFreeable.  If the returned result register
363612abf408Sdrh ** is not a temporary or if the expression is a vector set *piFreeable
363712abf408Sdrh ** to 0.
363812abf408Sdrh */
363912abf408Sdrh static int exprCodeVector(Parse *pParse, Expr *p, int *piFreeable){
364012abf408Sdrh   int iResult;
364112abf408Sdrh   int nResult = sqlite3ExprVectorSize(p);
364212abf408Sdrh   if( nResult==1 ){
364312abf408Sdrh     iResult = sqlite3ExprCodeTemp(pParse, p, piFreeable);
364412abf408Sdrh   }else{
364512abf408Sdrh     *piFreeable = 0;
364612abf408Sdrh     if( p->op==TK_SELECT ){
3647dd1bb43aSdrh #if SQLITE_OMIT_SUBQUERY
3648dd1bb43aSdrh       iResult = 0;
3649dd1bb43aSdrh #else
365085bcdce2Sdrh       iResult = sqlite3CodeSubselect(pParse, p);
3651dd1bb43aSdrh #endif
365212abf408Sdrh     }else{
365312abf408Sdrh       int i;
365412abf408Sdrh       iResult = pParse->nMem+1;
365512abf408Sdrh       pParse->nMem += nResult;
365612abf408Sdrh       for(i=0; i<nResult; i++){
36574b725240Sdan         sqlite3ExprCodeFactorable(pParse, p->x.pList->a[i].pExpr, i+iResult);
365812abf408Sdrh       }
365912abf408Sdrh     }
366012abf408Sdrh   }
366112abf408Sdrh   return iResult;
366212abf408Sdrh }
366312abf408Sdrh 
366425c4296bSdrh /*
366592a27f7bSdrh ** If the last opcode is a OP_Copy, then set the do-not-merge flag (p5)
366692a27f7bSdrh ** so that a subsequent copy will not be merged into this one.
366792a27f7bSdrh */
366892a27f7bSdrh static void setDoNotMergeFlagOnCopy(Vdbe *v){
366992a27f7bSdrh   if( sqlite3VdbeGetOp(v, -1)->opcode==OP_Copy ){
367092a27f7bSdrh     sqlite3VdbeChangeP5(v, 1);  /* Tag trailing OP_Copy as not mergable */
367192a27f7bSdrh   }
367292a27f7bSdrh }
367392a27f7bSdrh 
367492a27f7bSdrh /*
367525c4296bSdrh ** Generate code to implement special SQL functions that are implemented
367625c4296bSdrh ** in-line rather than by using the usual callbacks.
367725c4296bSdrh */
367825c4296bSdrh static int exprCodeInlineFunction(
367925c4296bSdrh   Parse *pParse,        /* Parsing context */
368025c4296bSdrh   ExprList *pFarg,      /* List of function arguments */
368125c4296bSdrh   int iFuncId,          /* Function ID.  One of the INTFUNC_... values */
368225c4296bSdrh   int target            /* Store function result in this register */
368325c4296bSdrh ){
368425c4296bSdrh   int nFarg;
368525c4296bSdrh   Vdbe *v = pParse->pVdbe;
368625c4296bSdrh   assert( v!=0 );
368725c4296bSdrh   assert( pFarg!=0 );
368825c4296bSdrh   nFarg = pFarg->nExpr;
368925c4296bSdrh   assert( nFarg>0 );  /* All in-line functions have at least one argument */
369025c4296bSdrh   switch( iFuncId ){
369125c4296bSdrh     case INLINEFUNC_coalesce: {
369225c4296bSdrh       /* Attempt a direct implementation of the built-in COALESCE() and
369325c4296bSdrh       ** IFNULL() functions.  This avoids unnecessary evaluation of
369425c4296bSdrh       ** arguments past the first non-NULL argument.
369525c4296bSdrh       */
369625c4296bSdrh       int endCoalesce = sqlite3VdbeMakeLabel(pParse);
369725c4296bSdrh       int i;
369825c4296bSdrh       assert( nFarg>=2 );
369925c4296bSdrh       sqlite3ExprCode(pParse, pFarg->a[0].pExpr, target);
370025c4296bSdrh       for(i=1; i<nFarg; i++){
370125c4296bSdrh         sqlite3VdbeAddOp2(v, OP_NotNull, target, endCoalesce);
370225c4296bSdrh         VdbeCoverage(v);
370325c4296bSdrh         sqlite3ExprCode(pParse, pFarg->a[i].pExpr, target);
370425c4296bSdrh       }
370592a27f7bSdrh       setDoNotMergeFlagOnCopy(v);
370625c4296bSdrh       sqlite3VdbeResolveLabel(v, endCoalesce);
370725c4296bSdrh       break;
370825c4296bSdrh     }
37093c0e606bSdrh     case INLINEFUNC_iif: {
37103c0e606bSdrh       Expr caseExpr;
37113c0e606bSdrh       memset(&caseExpr, 0, sizeof(caseExpr));
37123c0e606bSdrh       caseExpr.op = TK_CASE;
37133c0e606bSdrh       caseExpr.x.pList = pFarg;
37143c0e606bSdrh       return sqlite3ExprCodeTarget(pParse, &caseExpr, target);
37153c0e606bSdrh     }
371625c4296bSdrh 
3717171c50ecSdrh     default: {
371825c4296bSdrh       /* The UNLIKELY() function is a no-op.  The result is the value
371925c4296bSdrh       ** of the first argument.
372025c4296bSdrh       */
3721171c50ecSdrh       assert( nFarg==1 || nFarg==2 );
372225c4296bSdrh       target = sqlite3ExprCodeTarget(pParse, pFarg->a[0].pExpr, target);
372325c4296bSdrh       break;
372425c4296bSdrh     }
372525c4296bSdrh 
3726171c50ecSdrh   /***********************************************************************
3727171c50ecSdrh   ** Test-only SQL functions that are only usable if enabled
3728171c50ecSdrh   ** via SQLITE_TESTCTRL_INTERNAL_FUNCTIONS
3729171c50ecSdrh   */
3730171c50ecSdrh     case INLINEFUNC_expr_compare: {
3731171c50ecSdrh       /* Compare two expressions using sqlite3ExprCompare() */
3732171c50ecSdrh       assert( nFarg==2 );
3733171c50ecSdrh       sqlite3VdbeAddOp2(v, OP_Integer,
3734171c50ecSdrh          sqlite3ExprCompare(0,pFarg->a[0].pExpr, pFarg->a[1].pExpr,-1),
3735171c50ecSdrh          target);
3736171c50ecSdrh       break;
3737171c50ecSdrh     }
3738171c50ecSdrh 
3739171c50ecSdrh     case INLINEFUNC_expr_implies_expr: {
3740171c50ecSdrh       /* Compare two expressions using sqlite3ExprImpliesExpr() */
3741171c50ecSdrh       assert( nFarg==2 );
3742171c50ecSdrh       sqlite3VdbeAddOp2(v, OP_Integer,
3743171c50ecSdrh          sqlite3ExprImpliesExpr(pParse,pFarg->a[0].pExpr, pFarg->a[1].pExpr,-1),
3744171c50ecSdrh          target);
3745171c50ecSdrh       break;
3746171c50ecSdrh     }
3747171c50ecSdrh 
3748171c50ecSdrh     case INLINEFUNC_implies_nonnull_row: {
3749171c50ecSdrh       /* REsult of sqlite3ExprImpliesNonNullRow() */
3750171c50ecSdrh       Expr *pA1;
3751171c50ecSdrh       assert( nFarg==2 );
3752171c50ecSdrh       pA1 = pFarg->a[1].pExpr;
3753171c50ecSdrh       if( pA1->op==TK_COLUMN ){
3754171c50ecSdrh         sqlite3VdbeAddOp2(v, OP_Integer,
3755171c50ecSdrh            sqlite3ExprImpliesNonNullRow(pFarg->a[0].pExpr,pA1->iTable),
3756171c50ecSdrh            target);
3757171c50ecSdrh       }else{
3758171c50ecSdrh         sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3759171c50ecSdrh       }
3760171c50ecSdrh       break;
3761171c50ecSdrh     }
3762171c50ecSdrh 
376325c4296bSdrh #ifdef SQLITE_DEBUG
376425c4296bSdrh     case INLINEFUNC_affinity: {
376525c4296bSdrh       /* The AFFINITY() function evaluates to a string that describes
376625c4296bSdrh       ** the type affinity of the argument.  This is used for testing of
376725c4296bSdrh       ** the SQLite type logic.
376825c4296bSdrh       */
376925c4296bSdrh       const char *azAff[] = { "blob", "text", "numeric", "integer", "real" };
377025c4296bSdrh       char aff;
377125c4296bSdrh       assert( nFarg==1 );
377225c4296bSdrh       aff = sqlite3ExprAffinity(pFarg->a[0].pExpr);
377325c4296bSdrh       sqlite3VdbeLoadString(v, target,
377425c4296bSdrh               (aff<=SQLITE_AFF_NONE) ? "none" : azAff[aff-SQLITE_AFF_BLOB]);
377525c4296bSdrh       break;
377625c4296bSdrh     }
377725c4296bSdrh #endif
377825c4296bSdrh   }
377925c4296bSdrh   return target;
378025c4296bSdrh }
378125c4296bSdrh 
378271c57db0Sdan 
3783a4c3c87eSdrh /*
3784cce7d176Sdrh ** Generate code into the current Vdbe to evaluate the given
37852dcef11bSdrh ** expression.  Attempt to store the results in register "target".
37862dcef11bSdrh ** Return the register where results are stored.
3787389a1adbSdrh **
37888b213899Sdrh ** With this routine, there is no guarantee that results will
37892dcef11bSdrh ** be stored in target.  The result might be stored in some other
37902dcef11bSdrh ** register if it is convenient to do so.  The calling function
37912dcef11bSdrh ** must check the return code and move the results to the desired
37922dcef11bSdrh ** register.
3793cce7d176Sdrh */
3794678ccce8Sdrh int sqlite3ExprCodeTarget(Parse *pParse, Expr *pExpr, int target){
37952dcef11bSdrh   Vdbe *v = pParse->pVdbe;  /* The VM under construction */
37962dcef11bSdrh   int op;                   /* The opcode being coded */
37972dcef11bSdrh   int inReg = target;       /* Results stored in register inReg */
37982dcef11bSdrh   int regFree1 = 0;         /* If non-zero free this temporary register */
37992dcef11bSdrh   int regFree2 = 0;         /* If non-zero free this temporary register */
38007b35a77bSdan   int r1, r2;               /* Various register numbers */
380110d1edf0Sdrh   Expr tempX;               /* Temporary expression node */
380271c57db0Sdan   int p5 = 0;
3803ffe07b2dSdrh 
38049cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
3805b639a209Sdrh   assert( v!=0 );
3806389a1adbSdrh 
38071efa8023Sdrh expr_code_doover:
3808389a1adbSdrh   if( pExpr==0 ){
3809389a1adbSdrh     op = TK_NULL;
3810389a1adbSdrh   }else{
3811e7375bfaSdrh     assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
3812f2bc013cSdrh     op = pExpr->op;
3813389a1adbSdrh   }
3814f2bc013cSdrh   switch( op ){
381513449892Sdrh     case TK_AGG_COLUMN: {
381613449892Sdrh       AggInfo *pAggInfo = pExpr->pAggInfo;
38170934d640Sdrh       struct AggInfo_col *pCol;
38180934d640Sdrh       assert( pAggInfo!=0 );
38190934d640Sdrh       assert( pExpr->iAgg>=0 && pExpr->iAgg<pAggInfo->nColumn );
38200934d640Sdrh       pCol = &pAggInfo->aCol[pExpr->iAgg];
382113449892Sdrh       if( !pAggInfo->directMode ){
38229de221dfSdrh         assert( pCol->iMem>0 );
3823c332cc30Sdrh         return pCol->iMem;
382413449892Sdrh       }else if( pAggInfo->useSortingIdx ){
38250c76e892Sdrh         Table *pTab = pCol->pTab;
38265134d135Sdan         sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdxPTab,
3827389a1adbSdrh                               pCol->iSorterColumn, target);
38288d5cea6bSdrh         if( pCol->iColumn<0 ){
38298d5cea6bSdrh           VdbeComment((v,"%s.rowid",pTab->zName));
38308d5cea6bSdrh         }else{
38318d5cea6bSdrh           VdbeComment((v,"%s.%s",pTab->zName,pTab->aCol[pCol->iColumn].zName));
38328d5cea6bSdrh           if( pTab->aCol[pCol->iColumn].affinity==SQLITE_AFF_REAL ){
38338d5cea6bSdrh             sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
38348d5cea6bSdrh           }
38350c76e892Sdrh         }
3836c332cc30Sdrh         return target;
383713449892Sdrh       }
383813449892Sdrh       /* Otherwise, fall thru into the TK_COLUMN case */
383908b92086Sdrh       /* no break */ deliberate_fall_through
384013449892Sdrh     }
3841967e8b73Sdrh     case TK_COLUMN: {
3842b2b9d3d7Sdrh       int iTab = pExpr->iTable;
384367b9ba17Sdrh       int iReg;
3844efad2e23Sdrh       if( ExprHasProperty(pExpr, EP_FixedCol) ){
3845d98f5324Sdrh         /* This COLUMN expression is really a constant due to WHERE clause
3846d98f5324Sdrh         ** constraints, and that constant is coded by the pExpr->pLeft
3847d98f5324Sdrh         ** expresssion.  However, make sure the constant has the correct
3848d98f5324Sdrh         ** datatype by applying the Affinity of the table column to the
3849d98f5324Sdrh         ** constant.
3850d98f5324Sdrh         */
385157f7ece7Sdrh         int aff;
385267b9ba17Sdrh         iReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft,target);
385357f7ece7Sdrh         if( pExpr->y.pTab ){
385457f7ece7Sdrh           aff = sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
385557f7ece7Sdrh         }else{
385657f7ece7Sdrh           aff = pExpr->affExpr;
385757f7ece7Sdrh         }
385896fb16eeSdrh         if( aff>SQLITE_AFF_BLOB ){
3859d98f5324Sdrh           static const char zAff[] = "B\000C\000D\000E";
3860d98f5324Sdrh           assert( SQLITE_AFF_BLOB=='A' );
3861d98f5324Sdrh           assert( SQLITE_AFF_TEXT=='B' );
3862d98f5324Sdrh           sqlite3VdbeAddOp4(v, OP_Affinity, iReg, 1, 0,
3863d98f5324Sdrh                             &zAff[(aff-'B')*2], P4_STATIC);
3864d98f5324Sdrh         }
3865d98f5324Sdrh         return iReg;
3866efad2e23Sdrh       }
3867b2b9d3d7Sdrh       if( iTab<0 ){
38686e97f8ecSdrh         if( pParse->iSelfTab<0 ){
38699942ef0dSdrh           /* Other columns in the same row for CHECK constraints or
38709942ef0dSdrh           ** generated columns or for inserting into partial index.
38719942ef0dSdrh           ** The row is unpacked into registers beginning at
38729942ef0dSdrh           ** 0-(pParse->iSelfTab).  The rowid (if any) is in a register
38739942ef0dSdrh           ** immediately prior to the first column.
38749942ef0dSdrh           */
38759942ef0dSdrh           Column *pCol;
38769942ef0dSdrh           Table *pTab = pExpr->y.pTab;
38779942ef0dSdrh           int iSrc;
3878c5f808d8Sdrh           int iCol = pExpr->iColumn;
38799942ef0dSdrh           assert( pTab!=0 );
3880c5f808d8Sdrh           assert( iCol>=XN_ROWID );
3881b0cbcd0eSdrh           assert( iCol<pTab->nCol );
3882c5f808d8Sdrh           if( iCol<0 ){
38839942ef0dSdrh             return -1-pParse->iSelfTab;
38849942ef0dSdrh           }
3885c5f808d8Sdrh           pCol = pTab->aCol + iCol;
3886c5f808d8Sdrh           testcase( iCol!=sqlite3TableColumnToStorage(pTab,iCol) );
3887c5f808d8Sdrh           iSrc = sqlite3TableColumnToStorage(pTab, iCol) - pParse->iSelfTab;
38889942ef0dSdrh #ifndef SQLITE_OMIT_GENERATED_COLUMNS
38899942ef0dSdrh           if( pCol->colFlags & COLFLAG_GENERATED ){
38904e8e533bSdrh             if( pCol->colFlags & COLFLAG_BUSY ){
38914e8e533bSdrh               sqlite3ErrorMsg(pParse, "generated column loop on \"%s\"",
38924e8e533bSdrh                               pCol->zName);
38934e8e533bSdrh               return 0;
38944e8e533bSdrh             }
38954e8e533bSdrh             pCol->colFlags |= COLFLAG_BUSY;
38964e8e533bSdrh             if( pCol->colFlags & COLFLAG_NOTAVAIL ){
3897e70fa7feSdrh               sqlite3ExprCodeGeneratedColumn(pParse, pCol, iSrc);
38984e8e533bSdrh             }
38994e8e533bSdrh             pCol->colFlags &= ~(COLFLAG_BUSY|COLFLAG_NOTAVAIL);
3900dd6cc9b5Sdrh             return iSrc;
39019942ef0dSdrh           }else
39029942ef0dSdrh #endif /* SQLITE_OMIT_GENERATED_COLUMNS */
39039942ef0dSdrh           if( pCol->affinity==SQLITE_AFF_REAL ){
39049942ef0dSdrh             sqlite3VdbeAddOp2(v, OP_SCopy, iSrc, target);
3905bffdd636Sdrh             sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
3906bffdd636Sdrh             return target;
3907bffdd636Sdrh           }else{
39089942ef0dSdrh             return iSrc;
3909bffdd636Sdrh           }
3910c4a3c779Sdrh         }else{
39111f9ca2c8Sdrh           /* Coding an expression that is part of an index where column names
39121f9ca2c8Sdrh           ** in the index refer to the table to which the index belongs */
39133e34eabcSdrh           iTab = pParse->iSelfTab - 1;
39142282792aSdrh         }
3915b2b9d3d7Sdrh       }
391667b9ba17Sdrh       iReg = sqlite3ExprCodeGetColumn(pParse, pExpr->y.pTab,
3917b2b9d3d7Sdrh                                pExpr->iColumn, iTab, target,
3918b2b9d3d7Sdrh                                pExpr->op2);
391967b9ba17Sdrh       if( pExpr->y.pTab==0 && pExpr->affExpr==SQLITE_AFF_REAL ){
392067b9ba17Sdrh         sqlite3VdbeAddOp1(v, OP_RealAffinity, iReg);
392167b9ba17Sdrh       }
392267b9ba17Sdrh       return iReg;
3923cce7d176Sdrh     }
3924cce7d176Sdrh     case TK_INTEGER: {
392513573c71Sdrh       codeInteger(pParse, pExpr, 0, target);
3926c332cc30Sdrh       return target;
392751e9a445Sdrh     }
39288abed7b9Sdrh     case TK_TRUEFALSE: {
392996acafbeSdrh       sqlite3VdbeAddOp2(v, OP_Integer, sqlite3ExprTruthValue(pExpr), target);
3930007c843bSdrh       return target;
3931007c843bSdrh     }
393213573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
3933598f1340Sdrh     case TK_FLOAT: {
393433e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
393533e619fcSdrh       codeReal(v, pExpr->u.zToken, 0, target);
3936c332cc30Sdrh       return target;
3937598f1340Sdrh     }
393813573c71Sdrh #endif
3939fec19aadSdrh     case TK_STRING: {
394033e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
3941076e85f5Sdrh       sqlite3VdbeLoadString(v, target, pExpr->u.zToken);
3942c332cc30Sdrh       return target;
3943cce7d176Sdrh     }
3944aac30f9bSdrh     default: {
3945c29af653Sdrh       /* Make NULL the default case so that if a bug causes an illegal
3946c29af653Sdrh       ** Expr node to be passed into this function, it will be handled
39479524a7eaSdrh       ** sanely and not crash.  But keep the assert() to bring the problem
39489524a7eaSdrh       ** to the attention of the developers. */
39499524a7eaSdrh       assert( op==TK_NULL );
39509de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3951c332cc30Sdrh       return target;
3952f0863fe5Sdrh     }
39535338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_BLOB_LITERAL
3954c572ef7fSdanielk1977     case TK_BLOB: {
39556c8c6cecSdrh       int n;
39566c8c6cecSdrh       const char *z;
3957ca48c90fSdrh       char *zBlob;
395833e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
395933e619fcSdrh       assert( pExpr->u.zToken[0]=='x' || pExpr->u.zToken[0]=='X' );
396033e619fcSdrh       assert( pExpr->u.zToken[1]=='\'' );
396133e619fcSdrh       z = &pExpr->u.zToken[2];
3962b7916a78Sdrh       n = sqlite3Strlen30(z) - 1;
3963b7916a78Sdrh       assert( z[n]=='\'' );
3964ca48c90fSdrh       zBlob = sqlite3HexToBlob(sqlite3VdbeDb(v), z, n);
3965ca48c90fSdrh       sqlite3VdbeAddOp4(v, OP_Blob, n/2, target, 0, zBlob, P4_DYNAMIC);
3966c332cc30Sdrh       return target;
3967c572ef7fSdanielk1977     }
39685338a5f7Sdanielk1977 #endif
396950457896Sdrh     case TK_VARIABLE: {
397033e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
397133e619fcSdrh       assert( pExpr->u.zToken!=0 );
397233e619fcSdrh       assert( pExpr->u.zToken[0]!=0 );
3973eaf52d88Sdrh       sqlite3VdbeAddOp2(v, OP_Variable, pExpr->iColumn, target);
397433e619fcSdrh       if( pExpr->u.zToken[1]!=0 ){
39759bf755ccSdrh         const char *z = sqlite3VListNumToName(pParse->pVList, pExpr->iColumn);
39769524a7eaSdrh         assert( pExpr->u.zToken[0]=='?' || (z && !strcmp(pExpr->u.zToken, z)) );
3977ce1bbe51Sdrh         pParse->pVList[0] = 0; /* Indicate VList may no longer be enlarged */
39789bf755ccSdrh         sqlite3VdbeAppendP4(v, (char*)z, P4_STATIC);
39799bf755ccSdrh       }
3980c332cc30Sdrh       return target;
398150457896Sdrh     }
39824e0cff60Sdrh     case TK_REGISTER: {
3983c332cc30Sdrh       return pExpr->iTable;
39844e0cff60Sdrh     }
3985487e262fSdrh #ifndef SQLITE_OMIT_CAST
3986487e262fSdrh     case TK_CAST: {
3987487e262fSdrh       /* Expressions of the form:   CAST(pLeft AS token) */
39882dcef11bSdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
39891735fa88Sdrh       if( inReg!=target ){
39901735fa88Sdrh         sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
39911735fa88Sdrh         inReg = target;
39921735fa88Sdrh       }
39934169e430Sdrh       sqlite3VdbeAddOp2(v, OP_Cast, target,
39944169e430Sdrh                         sqlite3AffinityType(pExpr->u.zToken, 0));
3995c332cc30Sdrh       return inReg;
3996487e262fSdrh     }
3997487e262fSdrh #endif /* SQLITE_OMIT_CAST */
399871c57db0Sdan     case TK_IS:
399971c57db0Sdan     case TK_ISNOT:
400071c57db0Sdan       op = (op==TK_IS) ? TK_EQ : TK_NE;
400171c57db0Sdan       p5 = SQLITE_NULLEQ;
400271c57db0Sdan       /* fall-through */
4003c9b84a1fSdrh     case TK_LT:
4004c9b84a1fSdrh     case TK_LE:
4005c9b84a1fSdrh     case TK_GT:
4006c9b84a1fSdrh     case TK_GE:
4007c9b84a1fSdrh     case TK_NE:
4008c9b84a1fSdrh     case TK_EQ: {
400971c57db0Sdan       Expr *pLeft = pExpr->pLeft;
4010625015e0Sdan       if( sqlite3ExprIsVector(pLeft) ){
401179752b6eSdrh         codeVectorCompare(pParse, pExpr, target, op, p5);
401271c57db0Sdan       }else{
401371c57db0Sdan         r1 = sqlite3ExprCodeTemp(pParse, pLeft, &regFree1);
4014b6da74ebSdrh         r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
401571c57db0Sdan         codeCompare(pParse, pLeft, pExpr->pRight, op,
4016898c527eSdrh             r1, r2, inReg, SQLITE_STOREP2 | p5,
4017898c527eSdrh             ExprHasProperty(pExpr,EP_Commuted));
40187d176105Sdrh         assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
40197d176105Sdrh         assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
40207d176105Sdrh         assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
40217d176105Sdrh         assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
40227d176105Sdrh         assert(TK_EQ==OP_Eq); testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
40237d176105Sdrh         assert(TK_NE==OP_Ne); testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
4024c5499befSdrh         testcase( regFree1==0 );
4025c5499befSdrh         testcase( regFree2==0 );
4026c9b84a1fSdrh       }
40276a2fe093Sdrh       break;
40286a2fe093Sdrh     }
4029cce7d176Sdrh     case TK_AND:
4030cce7d176Sdrh     case TK_OR:
4031cce7d176Sdrh     case TK_PLUS:
4032cce7d176Sdrh     case TK_STAR:
4033cce7d176Sdrh     case TK_MINUS:
4034bf4133cbSdrh     case TK_REM:
4035bf4133cbSdrh     case TK_BITAND:
4036bf4133cbSdrh     case TK_BITOR:
403717c40294Sdrh     case TK_SLASH:
4038bf4133cbSdrh     case TK_LSHIFT:
4039855eb1cfSdrh     case TK_RSHIFT:
40400040077dSdrh     case TK_CONCAT: {
40417d176105Sdrh       assert( TK_AND==OP_And );            testcase( op==TK_AND );
40427d176105Sdrh       assert( TK_OR==OP_Or );              testcase( op==TK_OR );
40437d176105Sdrh       assert( TK_PLUS==OP_Add );           testcase( op==TK_PLUS );
40447d176105Sdrh       assert( TK_MINUS==OP_Subtract );     testcase( op==TK_MINUS );
40457d176105Sdrh       assert( TK_REM==OP_Remainder );      testcase( op==TK_REM );
40467d176105Sdrh       assert( TK_BITAND==OP_BitAnd );      testcase( op==TK_BITAND );
40477d176105Sdrh       assert( TK_BITOR==OP_BitOr );        testcase( op==TK_BITOR );
40487d176105Sdrh       assert( TK_SLASH==OP_Divide );       testcase( op==TK_SLASH );
40497d176105Sdrh       assert( TK_LSHIFT==OP_ShiftLeft );   testcase( op==TK_LSHIFT );
40507d176105Sdrh       assert( TK_RSHIFT==OP_ShiftRight );  testcase( op==TK_RSHIFT );
40517d176105Sdrh       assert( TK_CONCAT==OP_Concat );      testcase( op==TK_CONCAT );
40522dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
40532dcef11bSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
40545b6afba9Sdrh       sqlite3VdbeAddOp3(v, op, r2, r1, target);
4055c5499befSdrh       testcase( regFree1==0 );
4056c5499befSdrh       testcase( regFree2==0 );
40570040077dSdrh       break;
40580040077dSdrh     }
4059cce7d176Sdrh     case TK_UMINUS: {
4060fec19aadSdrh       Expr *pLeft = pExpr->pLeft;
4061fec19aadSdrh       assert( pLeft );
406213573c71Sdrh       if( pLeft->op==TK_INTEGER ){
406313573c71Sdrh         codeInteger(pParse, pLeft, 1, target);
4064c332cc30Sdrh         return target;
406513573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
406613573c71Sdrh       }else if( pLeft->op==TK_FLOAT ){
406733e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
406833e619fcSdrh         codeReal(v, pLeft->u.zToken, 1, target);
4069c332cc30Sdrh         return target;
407013573c71Sdrh #endif
40713c84ddffSdrh       }else{
407210d1edf0Sdrh         tempX.op = TK_INTEGER;
407310d1edf0Sdrh         tempX.flags = EP_IntValue|EP_TokenOnly;
407410d1edf0Sdrh         tempX.u.iValue = 0;
4075e7375bfaSdrh         ExprClearVVAProperties(&tempX);
407610d1edf0Sdrh         r1 = sqlite3ExprCodeTemp(pParse, &tempX, &regFree1);
4077e55cbd72Sdrh         r2 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree2);
40782dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_Subtract, r2, r1, target);
4079c5499befSdrh         testcase( regFree2==0 );
40803c84ddffSdrh       }
40816e142f54Sdrh       break;
40826e142f54Sdrh     }
4083bf4133cbSdrh     case TK_BITNOT:
40846e142f54Sdrh     case TK_NOT: {
40857d176105Sdrh       assert( TK_BITNOT==OP_BitNot );   testcase( op==TK_BITNOT );
40867d176105Sdrh       assert( TK_NOT==OP_Not );         testcase( op==TK_NOT );
4087e99fa2afSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4088e99fa2afSdrh       testcase( regFree1==0 );
4089e99fa2afSdrh       sqlite3VdbeAddOp2(v, op, r1, inReg);
4090cce7d176Sdrh       break;
4091cce7d176Sdrh     }
40928abed7b9Sdrh     case TK_TRUTH: {
409396acafbeSdrh       int isTrue;    /* IS TRUE or IS NOT TRUE */
409496acafbeSdrh       int bNormal;   /* IS TRUE or IS FALSE */
4095007c843bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4096007c843bSdrh       testcase( regFree1==0 );
409796acafbeSdrh       isTrue = sqlite3ExprTruthValue(pExpr->pRight);
409896acafbeSdrh       bNormal = pExpr->op2==TK_IS;
409996acafbeSdrh       testcase( isTrue && bNormal);
410096acafbeSdrh       testcase( !isTrue && bNormal);
410196acafbeSdrh       sqlite3VdbeAddOp4Int(v, OP_IsTrue, r1, inReg, !isTrue, isTrue ^ bNormal);
4102007c843bSdrh       break;
4103007c843bSdrh     }
4104cce7d176Sdrh     case TK_ISNULL:
4105cce7d176Sdrh     case TK_NOTNULL: {
41066a288a33Sdrh       int addr;
41077d176105Sdrh       assert( TK_ISNULL==OP_IsNull );   testcase( op==TK_ISNULL );
41087d176105Sdrh       assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
41099de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
41102dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4111c5499befSdrh       testcase( regFree1==0 );
41122dcef11bSdrh       addr = sqlite3VdbeAddOp1(v, op, r1);
41137d176105Sdrh       VdbeCoverageIf(v, op==TK_ISNULL);
41147d176105Sdrh       VdbeCoverageIf(v, op==TK_NOTNULL);
4115a976979bSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 0, target);
41166a288a33Sdrh       sqlite3VdbeJumpHere(v, addr);
4117a37cdde0Sdanielk1977       break;
4118f2bc013cSdrh     }
41192282792aSdrh     case TK_AGG_FUNCTION: {
412013449892Sdrh       AggInfo *pInfo = pExpr->pAggInfo;
41210934d640Sdrh       if( pInfo==0
41220934d640Sdrh        || NEVER(pExpr->iAgg<0)
41230934d640Sdrh        || NEVER(pExpr->iAgg>=pInfo->nFunc)
41240934d640Sdrh       ){
412533e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
412633e619fcSdrh         sqlite3ErrorMsg(pParse, "misuse of aggregate: %s()", pExpr->u.zToken);
41277e56e711Sdrh       }else{
4128c332cc30Sdrh         return pInfo->aFunc[pExpr->iAgg].iMem;
41297e56e711Sdrh       }
41302282792aSdrh       break;
41312282792aSdrh     }
4132cce7d176Sdrh     case TK_FUNCTION: {
413312ffee8cSdrh       ExprList *pFarg;       /* List of function arguments */
413412ffee8cSdrh       int nFarg;             /* Number of function arguments */
413512ffee8cSdrh       FuncDef *pDef;         /* The function definition object */
413612ffee8cSdrh       const char *zId;       /* The function name */
4137693e6719Sdrh       u32 constMask = 0;     /* Mask of function arguments that are constant */
413812ffee8cSdrh       int i;                 /* Loop counter */
4139c332cc30Sdrh       sqlite3 *db = pParse->db;  /* The database connection */
414012ffee8cSdrh       u8 enc = ENC(db);      /* The text encoding used by this database */
414112ffee8cSdrh       CollSeq *pColl = 0;    /* A collating sequence */
414217435752Sdrh 
414367a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
4144eda079cdSdrh       if( ExprHasProperty(pExpr, EP_WinFunc) ){
4145eda079cdSdrh         return pExpr->y.pWin->regResult;
414686fb6e17Sdan       }
414767a9b8edSdan #endif
414886fb6e17Sdan 
41491e9b53f9Sdrh       if( ConstFactorOk(pParse) && sqlite3ExprIsConstantNotJoin(pExpr) ){
41509b258c54Sdrh         /* SQL functions can be expensive. So try to avoid running them
41519b258c54Sdrh         ** multiple times if we know they always give the same result */
41529b258c54Sdrh         return sqlite3ExprCodeRunJustOnce(pParse, pExpr, -1);
41531e9b53f9Sdrh       }
41546ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
4155e7375bfaSdrh       assert( !ExprHasProperty(pExpr, EP_TokenOnly) );
415612ffee8cSdrh       pFarg = pExpr->x.pList;
415712ffee8cSdrh       nFarg = pFarg ? pFarg->nExpr : 0;
415833e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
415933e619fcSdrh       zId = pExpr->u.zToken;
416080738d9cSdrh       pDef = sqlite3FindFunction(db, zId, nFarg, enc, 0);
4161cc15313cSdrh #ifdef SQLITE_ENABLE_UNKNOWN_SQL_FUNCTION
4162cc15313cSdrh       if( pDef==0 && pParse->explain ){
4163cc15313cSdrh         pDef = sqlite3FindFunction(db, "unknown", nFarg, enc, 0);
4164cc15313cSdrh       }
4165cc15313cSdrh #endif
4166b6e9f7a4Sdan       if( pDef==0 || pDef->xFinalize!=0 ){
416780738d9cSdrh         sqlite3ErrorMsg(pParse, "unknown function: %s()", zId);
4168feb306f5Sdrh         break;
4169feb306f5Sdrh       }
417025c4296bSdrh       if( pDef->funcFlags & SQLITE_FUNC_INLINE ){
41710dfa5255Sdrh         assert( (pDef->funcFlags & SQLITE_FUNC_UNSAFE)==0 );
41720dfa5255Sdrh         assert( (pDef->funcFlags & SQLITE_FUNC_DIRECT)==0 );
417325c4296bSdrh         return exprCodeInlineFunction(pParse, pFarg,
417425c4296bSdrh              SQLITE_PTR_TO_INT(pDef->pUserData), target);
41752eeca204Sdrh       }else if( pDef->funcFlags & (SQLITE_FUNC_DIRECT|SQLITE_FUNC_UNSAFE) ){
41760dfa5255Sdrh         sqlite3ExprFunctionUsable(pParse, pExpr, pDef);
4177ae6bb957Sdrh       }
4178a1a523a5Sdrh 
4179d1a01edaSdrh       for(i=0; i<nFarg; i++){
4180d1a01edaSdrh         if( i<32 && sqlite3ExprIsConstant(pFarg->a[i].pExpr) ){
4181693e6719Sdrh           testcase( i==31 );
4182693e6719Sdrh           constMask |= MASKBIT32(i);
4183d1a01edaSdrh         }
4184d1a01edaSdrh         if( (pDef->funcFlags & SQLITE_FUNC_NEEDCOLL)!=0 && !pColl ){
4185d1a01edaSdrh           pColl = sqlite3ExprCollSeq(pParse, pFarg->a[i].pExpr);
4186d1a01edaSdrh         }
4187d1a01edaSdrh       }
418812ffee8cSdrh       if( pFarg ){
4189d1a01edaSdrh         if( constMask ){
4190d1a01edaSdrh           r1 = pParse->nMem+1;
4191d1a01edaSdrh           pParse->nMem += nFarg;
4192d1a01edaSdrh         }else{
419312ffee8cSdrh           r1 = sqlite3GetTempRange(pParse, nFarg);
4194d1a01edaSdrh         }
4195a748fdccSdrh 
4196a748fdccSdrh         /* For length() and typeof() functions with a column argument,
4197a748fdccSdrh         ** set the P5 parameter to the OP_Column opcode to OPFLAG_LENGTHARG
4198a748fdccSdrh         ** or OPFLAG_TYPEOFARG respectively, to avoid unnecessary data
4199a748fdccSdrh         ** loading.
4200a748fdccSdrh         */
4201d36e1041Sdrh         if( (pDef->funcFlags & (SQLITE_FUNC_LENGTH|SQLITE_FUNC_TYPEOF))!=0 ){
42024e245a4cSdrh           u8 exprOp;
4203a748fdccSdrh           assert( nFarg==1 );
4204a748fdccSdrh           assert( pFarg->a[0].pExpr!=0 );
42054e245a4cSdrh           exprOp = pFarg->a[0].pExpr->op;
42064e245a4cSdrh           if( exprOp==TK_COLUMN || exprOp==TK_AGG_COLUMN ){
4207a748fdccSdrh             assert( SQLITE_FUNC_LENGTH==OPFLAG_LENGTHARG );
4208a748fdccSdrh             assert( SQLITE_FUNC_TYPEOF==OPFLAG_TYPEOFARG );
4209b1fba286Sdrh             testcase( pDef->funcFlags & OPFLAG_LENGTHARG );
4210b1fba286Sdrh             pFarg->a[0].pExpr->op2 =
4211b1fba286Sdrh                   pDef->funcFlags & (OPFLAG_LENGTHARG|OPFLAG_TYPEOFARG);
4212a748fdccSdrh           }
4213a748fdccSdrh         }
4214a748fdccSdrh 
42155579d59fSdrh         sqlite3ExprCodeExprList(pParse, pFarg, r1, 0,
4216d1a01edaSdrh                                 SQLITE_ECEL_DUP|SQLITE_ECEL_FACTOR);
4217892d3179Sdrh       }else{
421812ffee8cSdrh         r1 = 0;
4219892d3179Sdrh       }
4220b7f6f68fSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
4221a43fa227Sdrh       /* Possibly overload the function if the first argument is
4222a43fa227Sdrh       ** a virtual table column.
4223a43fa227Sdrh       **
4224a43fa227Sdrh       ** For infix functions (LIKE, GLOB, REGEXP, and MATCH) use the
4225a43fa227Sdrh       ** second argument, not the first, as the argument to test to
4226a43fa227Sdrh       ** see if it is a column in a virtual table.  This is done because
4227a43fa227Sdrh       ** the left operand of infix functions (the operand we want to
4228a43fa227Sdrh       ** control overloading) ends up as the second argument to the
4229a43fa227Sdrh       ** function.  The expression "A glob B" is equivalent to
4230a43fa227Sdrh       ** "glob(B,A).  We want to use the A in "A glob B" to test
4231a43fa227Sdrh       ** for function overloading.  But we use the B term in "glob(B,A)".
4232a43fa227Sdrh       */
423359155065Sdrh       if( nFarg>=2 && ExprHasProperty(pExpr, EP_InfixFunc) ){
423412ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[1].pExpr);
423512ffee8cSdrh       }else if( nFarg>0 ){
423612ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[0].pExpr);
4237b7f6f68fSdrh       }
4238b7f6f68fSdrh #endif
4239d36e1041Sdrh       if( pDef->funcFlags & SQLITE_FUNC_NEEDCOLL ){
42408b213899Sdrh         if( !pColl ) pColl = db->pDfltColl;
424166a5167bSdrh         sqlite3VdbeAddOp4(v, OP_CollSeq, 0, 0, 0, (char *)pColl, P4_COLLSEQ);
4242682f68b0Sdanielk1977       }
4243092457b1Sdrh #ifdef SQLITE_ENABLE_OFFSET_SQL_FUNC
4244092457b1Sdrh       if( pDef->funcFlags & SQLITE_FUNC_OFFSET ){
42452fc865c1Sdrh         Expr *pArg = pFarg->a[0].pExpr;
42462fc865c1Sdrh         if( pArg->op==TK_COLUMN ){
4247092457b1Sdrh           sqlite3VdbeAddOp3(v, OP_Offset, pArg->iTable, pArg->iColumn, target);
42482fc865c1Sdrh         }else{
42492fc865c1Sdrh           sqlite3VdbeAddOp2(v, OP_Null, 0, target);
42502fc865c1Sdrh         }
4251092457b1Sdrh       }else
4252092457b1Sdrh #endif
4253092457b1Sdrh       {
4254920cf596Sdrh         sqlite3VdbeAddFunctionCall(pParse, constMask, r1, target, nFarg,
425520cee7d0Sdrh                                    pDef, pExpr->op2);
42562fc865c1Sdrh       }
425713d79502Sdrh       if( nFarg ){
425813d79502Sdrh         if( constMask==0 ){
425912ffee8cSdrh           sqlite3ReleaseTempRange(pParse, r1, nFarg);
426013d79502Sdrh         }else{
42613aef2fb1Sdrh           sqlite3VdbeReleaseRegisters(pParse, r1, nFarg, constMask, 1);
426213d79502Sdrh         }
42632dcef11bSdrh       }
4264c332cc30Sdrh       return target;
42656ec2733bSdrh     }
4266fe2093d7Sdrh #ifndef SQLITE_OMIT_SUBQUERY
4267fe2093d7Sdrh     case TK_EXISTS:
426819a775c2Sdrh     case TK_SELECT: {
42698da209b1Sdan       int nCol;
4270c5499befSdrh       testcase( op==TK_EXISTS );
4271c5499befSdrh       testcase( op==TK_SELECT );
4272d8d335d7Sdrh       if( pParse->db->mallocFailed ){
4273d8d335d7Sdrh         return 0;
4274d8d335d7Sdrh       }else if( op==TK_SELECT && (nCol = pExpr->x.pSelect->pEList->nExpr)!=1 ){
42758da209b1Sdan         sqlite3SubselectError(pParse, nCol, 1);
42768da209b1Sdan       }else{
427785bcdce2Sdrh         return sqlite3CodeSubselect(pParse, pExpr);
42788da209b1Sdan       }
427919a775c2Sdrh       break;
428019a775c2Sdrh     }
4281fc7f27b9Sdrh     case TK_SELECT_COLUMN: {
4282966e2911Sdrh       int n;
4283fc7f27b9Sdrh       if( pExpr->pLeft->iTable==0 ){
428485bcdce2Sdrh         pExpr->pLeft->iTable = sqlite3CodeSubselect(pParse, pExpr->pLeft);
4285fc7f27b9Sdrh       }
4286966e2911Sdrh       assert( pExpr->iTable==0 || pExpr->pLeft->op==TK_SELECT );
4287554a9dc7Sdrh       if( pExpr->iTable!=0
4288966e2911Sdrh        && pExpr->iTable!=(n = sqlite3ExprVectorSize(pExpr->pLeft))
4289966e2911Sdrh       ){
4290966e2911Sdrh         sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
4291966e2911Sdrh                                 pExpr->iTable, n);
4292966e2911Sdrh       }
4293c332cc30Sdrh       return pExpr->pLeft->iTable + pExpr->iColumn;
4294fc7f27b9Sdrh     }
4295fef5208cSdrh     case TK_IN: {
4296ec4ccdbcSdrh       int destIfFalse = sqlite3VdbeMakeLabel(pParse);
4297ec4ccdbcSdrh       int destIfNull = sqlite3VdbeMakeLabel(pParse);
4298e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
4299e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
430066ba23ceSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
4301e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
4302e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_AddImm, target, 0);
4303e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfNull);
4304c332cc30Sdrh       return target;
4305fef5208cSdrh     }
4306e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
4307e3365e6cSdrh 
4308e3365e6cSdrh 
43092dcef11bSdrh     /*
43102dcef11bSdrh     **    x BETWEEN y AND z
43112dcef11bSdrh     **
43122dcef11bSdrh     ** This is equivalent to
43132dcef11bSdrh     **
43142dcef11bSdrh     **    x>=y AND x<=z
43152dcef11bSdrh     **
43162dcef11bSdrh     ** X is stored in pExpr->pLeft.
43172dcef11bSdrh     ** Y is stored in pExpr->pList->a[0].pExpr.
43182dcef11bSdrh     ** Z is stored in pExpr->pList->a[1].pExpr.
43192dcef11bSdrh     */
4320fef5208cSdrh     case TK_BETWEEN: {
432171c57db0Sdan       exprCodeBetween(pParse, pExpr, target, 0, 0);
4322c332cc30Sdrh       return target;
4323fef5208cSdrh     }
432494fa9c41Sdrh     case TK_SPAN:
4325ae80ddeaSdrh     case TK_COLLATE:
43264f07e5fbSdrh     case TK_UPLUS: {
43271efa8023Sdrh       pExpr = pExpr->pLeft;
432859ee43a7Sdrh       goto expr_code_doover; /* 2018-04-28: Prevent deep recursion. OSSFuzz. */
4329a2e00042Sdrh     }
43302dcef11bSdrh 
4331165921a7Sdan     case TK_TRIGGER: {
433265a7cd16Sdan       /* If the opcode is TK_TRIGGER, then the expression is a reference
433365a7cd16Sdan       ** to a column in the new.* or old.* pseudo-tables available to
433465a7cd16Sdan       ** trigger programs. In this case Expr.iTable is set to 1 for the
433565a7cd16Sdan       ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
433665a7cd16Sdan       ** is set to the column of the pseudo-table to read, or to -1 to
433765a7cd16Sdan       ** read the rowid field.
433865a7cd16Sdan       **
433965a7cd16Sdan       ** The expression is implemented using an OP_Param opcode. The p1
434065a7cd16Sdan       ** parameter is set to 0 for an old.rowid reference, or to (i+1)
434165a7cd16Sdan       ** to reference another column of the old.* pseudo-table, where
434265a7cd16Sdan       ** i is the index of the column. For a new.rowid reference, p1 is
434365a7cd16Sdan       ** set to (n+1), where n is the number of columns in each pseudo-table.
434465a7cd16Sdan       ** For a reference to any other column in the new.* pseudo-table, p1
434565a7cd16Sdan       ** is set to (n+2+i), where n and i are as defined previously. For
434665a7cd16Sdan       ** example, if the table on which triggers are being fired is
434765a7cd16Sdan       ** declared as:
434865a7cd16Sdan       **
434965a7cd16Sdan       **   CREATE TABLE t1(a, b);
435065a7cd16Sdan       **
435165a7cd16Sdan       ** Then p1 is interpreted as follows:
435265a7cd16Sdan       **
435365a7cd16Sdan       **   p1==0   ->    old.rowid     p1==3   ->    new.rowid
435465a7cd16Sdan       **   p1==1   ->    old.a         p1==4   ->    new.a
435565a7cd16Sdan       **   p1==2   ->    old.b         p1==5   ->    new.b
435665a7cd16Sdan       */
4357eda079cdSdrh       Table *pTab = pExpr->y.pTab;
4358dd6cc9b5Sdrh       int iCol = pExpr->iColumn;
4359dd6cc9b5Sdrh       int p1 = pExpr->iTable * (pTab->nCol+1) + 1
43607fe2fc0dSdrh                      + sqlite3TableColumnToStorage(pTab, iCol);
436165a7cd16Sdan 
436265a7cd16Sdan       assert( pExpr->iTable==0 || pExpr->iTable==1 );
4363dd6cc9b5Sdrh       assert( iCol>=-1 && iCol<pTab->nCol );
4364dd6cc9b5Sdrh       assert( pTab->iPKey<0 || iCol!=pTab->iPKey );
436565a7cd16Sdan       assert( p1>=0 && p1<(pTab->nCol*2+2) );
436665a7cd16Sdan 
436765a7cd16Sdan       sqlite3VdbeAddOp2(v, OP_Param, p1, target);
4368896494e8Sdrh       VdbeComment((v, "r[%d]=%s.%s", target,
4369165921a7Sdan         (pExpr->iTable ? "new" : "old"),
4370dd6cc9b5Sdrh         (pExpr->iColumn<0 ? "rowid" : pExpr->y.pTab->aCol[iCol].zName)
4371165921a7Sdan       ));
437265a7cd16Sdan 
437344dbca83Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
437465a7cd16Sdan       /* If the column has REAL affinity, it may currently be stored as an
4375113762a2Sdrh       ** integer. Use OP_RealAffinity to make sure it is really real.
4376113762a2Sdrh       **
4377113762a2Sdrh       ** EVIDENCE-OF: R-60985-57662 SQLite will convert the value back to
4378113762a2Sdrh       ** floating point when extracting it from the record.  */
4379dd6cc9b5Sdrh       if( iCol>=0 && pTab->aCol[iCol].affinity==SQLITE_AFF_REAL ){
43802832ad42Sdan         sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
43812832ad42Sdan       }
438244dbca83Sdrh #endif
4383165921a7Sdan       break;
4384165921a7Sdan     }
4385165921a7Sdan 
438671c57db0Sdan     case TK_VECTOR: {
4387e835bc12Sdrh       sqlite3ErrorMsg(pParse, "row value misused");
438871c57db0Sdan       break;
438971c57db0Sdan     }
439071c57db0Sdan 
43919e9a67adSdrh     /* TK_IF_NULL_ROW Expr nodes are inserted ahead of expressions
43929e9a67adSdrh     ** that derive from the right-hand table of a LEFT JOIN.  The
43939e9a67adSdrh     ** Expr.iTable value is the table number for the right-hand table.
43949e9a67adSdrh     ** The expression is only evaluated if that table is not currently
43959e9a67adSdrh     ** on a LEFT JOIN NULL row.
43969e9a67adSdrh     */
439731d6fd55Sdrh     case TK_IF_NULL_ROW: {
439831d6fd55Sdrh       int addrINR;
43999e9a67adSdrh       u8 okConstFactor = pParse->okConstFactor;
440031d6fd55Sdrh       addrINR = sqlite3VdbeAddOp1(v, OP_IfNullRow, pExpr->iTable);
44019e9a67adSdrh       /* Temporarily disable factoring of constant expressions, since
44029e9a67adSdrh       ** even though expressions may appear to be constant, they are not
44039e9a67adSdrh       ** really constant because they originate from the right-hand side
44049e9a67adSdrh       ** of a LEFT JOIN. */
44059e9a67adSdrh       pParse->okConstFactor = 0;
440631d6fd55Sdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
44079e9a67adSdrh       pParse->okConstFactor = okConstFactor;
440831d6fd55Sdrh       sqlite3VdbeJumpHere(v, addrINR);
440931d6fd55Sdrh       sqlite3VdbeChangeP3(v, addrINR, inReg);
441031d6fd55Sdrh       break;
441131d6fd55Sdrh     }
441231d6fd55Sdrh 
44132dcef11bSdrh     /*
44142dcef11bSdrh     ** Form A:
44152dcef11bSdrh     **   CASE x WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
44162dcef11bSdrh     **
44172dcef11bSdrh     ** Form B:
44182dcef11bSdrh     **   CASE WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
44192dcef11bSdrh     **
44202dcef11bSdrh     ** Form A is can be transformed into the equivalent form B as follows:
44212dcef11bSdrh     **   CASE WHEN x=e1 THEN r1 WHEN x=e2 THEN r2 ...
44222dcef11bSdrh     **        WHEN x=eN THEN rN ELSE y END
44232dcef11bSdrh     **
44242dcef11bSdrh     ** X (if it exists) is in pExpr->pLeft.
4425c5cd1249Sdrh     ** Y is in the last element of pExpr->x.pList if pExpr->x.pList->nExpr is
4426c5cd1249Sdrh     ** odd.  The Y is also optional.  If the number of elements in x.pList
4427c5cd1249Sdrh     ** is even, then Y is omitted and the "otherwise" result is NULL.
44282dcef11bSdrh     ** Ei is in pExpr->pList->a[i*2] and Ri is pExpr->pList->a[i*2+1].
44292dcef11bSdrh     **
44302dcef11bSdrh     ** The result of the expression is the Ri for the first matching Ei,
44312dcef11bSdrh     ** or if there is no matching Ei, the ELSE term Y, or if there is
44322dcef11bSdrh     ** no ELSE term, NULL.
44332dcef11bSdrh     */
4434aac30f9bSdrh     case TK_CASE: {
44352dcef11bSdrh       int endLabel;                     /* GOTO label for end of CASE stmt */
44362dcef11bSdrh       int nextCase;                     /* GOTO label for next WHEN clause */
44372dcef11bSdrh       int nExpr;                        /* 2x number of WHEN terms */
44382dcef11bSdrh       int i;                            /* Loop counter */
44392dcef11bSdrh       ExprList *pEList;                 /* List of WHEN terms */
44402dcef11bSdrh       struct ExprList_item *aListelem;  /* Array of WHEN terms */
44412dcef11bSdrh       Expr opCompare;                   /* The X==Ei expression */
44422dcef11bSdrh       Expr *pX;                         /* The X expression */
44431bd10f8aSdrh       Expr *pTest = 0;                  /* X==Ei (form A) or just Ei (form B) */
44448b65e591Sdan       Expr *pDel = 0;
44458b65e591Sdan       sqlite3 *db = pParse->db;
444617a7f8ddSdrh 
44476ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) && pExpr->x.pList );
44486ab3a2ecSdanielk1977       assert(pExpr->x.pList->nExpr > 0);
44496ab3a2ecSdanielk1977       pEList = pExpr->x.pList;
4450be5c89acSdrh       aListelem = pEList->a;
4451be5c89acSdrh       nExpr = pEList->nExpr;
4452ec4ccdbcSdrh       endLabel = sqlite3VdbeMakeLabel(pParse);
44532dcef11bSdrh       if( (pX = pExpr->pLeft)!=0 ){
44548b65e591Sdan         pDel = sqlite3ExprDup(db, pX, 0);
44558b65e591Sdan         if( db->mallocFailed ){
44568b65e591Sdan           sqlite3ExprDelete(db, pDel);
44578b65e591Sdan           break;
44588b65e591Sdan         }
445933cd4909Sdrh         testcase( pX->op==TK_COLUMN );
44608b65e591Sdan         exprToRegister(pDel, exprCodeVector(pParse, pDel, &regFree1));
4461c5499befSdrh         testcase( regFree1==0 );
4462abb9d5f1Sdrh         memset(&opCompare, 0, sizeof(opCompare));
44632dcef11bSdrh         opCompare.op = TK_EQ;
44648b65e591Sdan         opCompare.pLeft = pDel;
44652dcef11bSdrh         pTest = &opCompare;
44668b1db07fSdrh         /* Ticket b351d95f9cd5ef17e9d9dbae18f5ca8611190001:
44678b1db07fSdrh         ** The value in regFree1 might get SCopy-ed into the file result.
44688b1db07fSdrh         ** So make sure that the regFree1 register is not reused for other
44698b1db07fSdrh         ** purposes and possibly overwritten.  */
44708b1db07fSdrh         regFree1 = 0;
4471cce7d176Sdrh       }
4472c5cd1249Sdrh       for(i=0; i<nExpr-1; i=i+2){
44732dcef11bSdrh         if( pX ){
44741bd10f8aSdrh           assert( pTest!=0 );
44752dcef11bSdrh           opCompare.pRight = aListelem[i].pExpr;
4476f5905aa7Sdrh         }else{
44772dcef11bSdrh           pTest = aListelem[i].pExpr;
447817a7f8ddSdrh         }
4479ec4ccdbcSdrh         nextCase = sqlite3VdbeMakeLabel(pParse);
448033cd4909Sdrh         testcase( pTest->op==TK_COLUMN );
44812dcef11bSdrh         sqlite3ExprIfFalse(pParse, pTest, nextCase, SQLITE_JUMPIFNULL);
4482c5499befSdrh         testcase( aListelem[i+1].pExpr->op==TK_COLUMN );
44839de221dfSdrh         sqlite3ExprCode(pParse, aListelem[i+1].pExpr, target);
4484076e85f5Sdrh         sqlite3VdbeGoto(v, endLabel);
44852dcef11bSdrh         sqlite3VdbeResolveLabel(v, nextCase);
4486f570f011Sdrh       }
4487c5cd1249Sdrh       if( (nExpr&1)!=0 ){
4488c5cd1249Sdrh         sqlite3ExprCode(pParse, pEList->a[nExpr-1].pExpr, target);
448917a7f8ddSdrh       }else{
44909de221dfSdrh         sqlite3VdbeAddOp2(v, OP_Null, 0, target);
449117a7f8ddSdrh       }
44928b65e591Sdan       sqlite3ExprDelete(db, pDel);
449392a27f7bSdrh       setDoNotMergeFlagOnCopy(v);
44942dcef11bSdrh       sqlite3VdbeResolveLabel(v, endLabel);
44956f34903eSdanielk1977       break;
44966f34903eSdanielk1977     }
44975338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_TRIGGER
44986f34903eSdanielk1977     case TK_RAISE: {
44991194904bSdrh       assert( pExpr->affExpr==OE_Rollback
45001194904bSdrh            || pExpr->affExpr==OE_Abort
45011194904bSdrh            || pExpr->affExpr==OE_Fail
45021194904bSdrh            || pExpr->affExpr==OE_Ignore
4503165921a7Sdan       );
45049e5fdc41Sdrh       if( !pParse->pTriggerTab && !pParse->nested ){
4505e0af83acSdan         sqlite3ErrorMsg(pParse,
4506e0af83acSdan                        "RAISE() may only be used within a trigger-program");
4507e0af83acSdan         return 0;
4508e0af83acSdan       }
45091194904bSdrh       if( pExpr->affExpr==OE_Abort ){
4510e0af83acSdan         sqlite3MayAbort(pParse);
4511e0af83acSdan       }
451233e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
45131194904bSdrh       if( pExpr->affExpr==OE_Ignore ){
4514e0af83acSdan         sqlite3VdbeAddOp4(
4515e0af83acSdan             v, OP_Halt, SQLITE_OK, OE_Ignore, 0, pExpr->u.zToken,0);
4516688852abSdrh         VdbeCoverage(v);
4517e0af83acSdan       }else{
45189e5fdc41Sdrh         sqlite3HaltConstraint(pParse,
45199e5fdc41Sdrh              pParse->pTriggerTab ? SQLITE_CONSTRAINT_TRIGGER : SQLITE_ERROR,
45201194904bSdrh              pExpr->affExpr, pExpr->u.zToken, 0, 0);
4521e0af83acSdan       }
4522e0af83acSdan 
4523ffe07b2dSdrh       break;
452417a7f8ddSdrh     }
45255338a5f7Sdanielk1977 #endif
4526ffe07b2dSdrh   }
45272dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
45282dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
45292dcef11bSdrh   return inReg;
45305b6afba9Sdrh }
45312dcef11bSdrh 
45322dcef11bSdrh /*
45339b258c54Sdrh ** Generate code that will evaluate expression pExpr just one time
45349b258c54Sdrh ** per prepared statement execution.
45359b258c54Sdrh **
45369b258c54Sdrh ** If the expression uses functions (that might throw an exception) then
45379b258c54Sdrh ** guard them with an OP_Once opcode to ensure that the code is only executed
45389b258c54Sdrh ** once. If no functions are involved, then factor the code out and put it at
45399b258c54Sdrh ** the end of the prepared statement in the initialization section.
45401e9b53f9Sdrh **
4541ad879ffdSdrh ** If regDest>=0 then the result is always stored in that register and the
4542ad879ffdSdrh ** result is not reusable.  If regDest<0 then this routine is free to
4543ad879ffdSdrh ** store the value whereever it wants.  The register where the expression
45449b258c54Sdrh ** is stored is returned.  When regDest<0, two identical expressions might
45459b258c54Sdrh ** code to the same register, if they do not contain function calls and hence
45469b258c54Sdrh ** are factored out into the initialization section at the end of the
45479b258c54Sdrh ** prepared statement.
4548d1a01edaSdrh */
45499b258c54Sdrh int sqlite3ExprCodeRunJustOnce(
4550d673cddaSdrh   Parse *pParse,    /* Parsing context */
4551d673cddaSdrh   Expr *pExpr,      /* The expression to code when the VDBE initializes */
4552ad879ffdSdrh   int regDest       /* Store the value in this register */
4553d673cddaSdrh ){
4554d1a01edaSdrh   ExprList *p;
4555d9f158e7Sdrh   assert( ConstFactorOk(pParse) );
4556d1a01edaSdrh   p = pParse->pConstExpr;
4557ad879ffdSdrh   if( regDest<0 && p ){
45581e9b53f9Sdrh     struct ExprList_item *pItem;
45591e9b53f9Sdrh     int i;
45601e9b53f9Sdrh     for(pItem=p->a, i=p->nExpr; i>0; pItem++, i--){
45615aa550cfSdan       if( pItem->reusable && sqlite3ExprCompare(0,pItem->pExpr,pExpr,-1)==0 ){
45621e9b53f9Sdrh         return pItem->u.iConstExprReg;
45631e9b53f9Sdrh       }
45641e9b53f9Sdrh     }
45651e9b53f9Sdrh   }
4566d1a01edaSdrh   pExpr = sqlite3ExprDup(pParse->db, pExpr, 0);
456738dfbdaeSdrh   if( pExpr!=0 && ExprHasProperty(pExpr, EP_HasFunc) ){
456838dfbdaeSdrh     Vdbe *v = pParse->pVdbe;
456938dfbdaeSdrh     int addr;
457038dfbdaeSdrh     assert( v );
457138dfbdaeSdrh     addr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
457238dfbdaeSdrh     pParse->okConstFactor = 0;
457338dfbdaeSdrh     if( !pParse->db->mallocFailed ){
45749b258c54Sdrh       if( regDest<0 ) regDest = ++pParse->nMem;
457538dfbdaeSdrh       sqlite3ExprCode(pParse, pExpr, regDest);
457638dfbdaeSdrh     }
457738dfbdaeSdrh     pParse->okConstFactor = 1;
457838dfbdaeSdrh     sqlite3ExprDelete(pParse->db, pExpr);
457938dfbdaeSdrh     sqlite3VdbeJumpHere(v, addr);
458038dfbdaeSdrh   }else{
4581d1a01edaSdrh     p = sqlite3ExprListAppend(pParse, p, pExpr);
4582d673cddaSdrh     if( p ){
4583d673cddaSdrh        struct ExprList_item *pItem = &p->a[p->nExpr-1];
4584ad879ffdSdrh        pItem->reusable = regDest<0;
45859b258c54Sdrh        if( regDest<0 ) regDest = ++pParse->nMem;
4586d673cddaSdrh        pItem->u.iConstExprReg = regDest;
4587d673cddaSdrh     }
4588d1a01edaSdrh     pParse->pConstExpr = p;
458938dfbdaeSdrh   }
45901e9b53f9Sdrh   return regDest;
4591d1a01edaSdrh }
4592d1a01edaSdrh 
4593d1a01edaSdrh /*
45942dcef11bSdrh ** Generate code to evaluate an expression and store the results
45952dcef11bSdrh ** into a register.  Return the register number where the results
45962dcef11bSdrh ** are stored.
45972dcef11bSdrh **
45982dcef11bSdrh ** If the register is a temporary register that can be deallocated,
4599678ccce8Sdrh ** then write its number into *pReg.  If the result register is not
46002dcef11bSdrh ** a temporary, then set *pReg to zero.
4601f30a969bSdrh **
4602f30a969bSdrh ** If pExpr is a constant, then this routine might generate this
4603f30a969bSdrh ** code to fill the register in the initialization section of the
4604f30a969bSdrh ** VDBE program, in order to factor it out of the evaluation loop.
46052dcef11bSdrh */
46062dcef11bSdrh int sqlite3ExprCodeTemp(Parse *pParse, Expr *pExpr, int *pReg){
4607f30a969bSdrh   int r2;
46080d950af3Sdrh   pExpr = sqlite3ExprSkipCollateAndLikely(pExpr);
4609d9f158e7Sdrh   if( ConstFactorOk(pParse)
4610f30a969bSdrh    && pExpr->op!=TK_REGISTER
4611f30a969bSdrh    && sqlite3ExprIsConstantNotJoin(pExpr)
4612f30a969bSdrh   ){
4613f30a969bSdrh     *pReg  = 0;
46149b258c54Sdrh     r2 = sqlite3ExprCodeRunJustOnce(pParse, pExpr, -1);
4615f30a969bSdrh   }else{
46162dcef11bSdrh     int r1 = sqlite3GetTempReg(pParse);
4617f30a969bSdrh     r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
46182dcef11bSdrh     if( r2==r1 ){
46192dcef11bSdrh       *pReg = r1;
46202dcef11bSdrh     }else{
46212dcef11bSdrh       sqlite3ReleaseTempReg(pParse, r1);
46222dcef11bSdrh       *pReg = 0;
46232dcef11bSdrh     }
4624f30a969bSdrh   }
46252dcef11bSdrh   return r2;
46262dcef11bSdrh }
46272dcef11bSdrh 
46282dcef11bSdrh /*
46292dcef11bSdrh ** Generate code that will evaluate expression pExpr and store the
46302dcef11bSdrh ** results in register target.  The results are guaranteed to appear
46312dcef11bSdrh ** in register target.
46322dcef11bSdrh */
463305a86c5cSdrh void sqlite3ExprCode(Parse *pParse, Expr *pExpr, int target){
46349cbf3425Sdrh   int inReg;
46359cbf3425Sdrh 
4636e7375bfaSdrh   assert( pExpr==0 || !ExprHasVVAProperty(pExpr,EP_Immutable) );
46379cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
46381c75c9d7Sdrh   assert( pParse->pVdbe!=0 || pParse->db->mallocFailed );
4639b639a209Sdrh   if( pParse->pVdbe==0 ) return;
4640b639a209Sdrh   inReg = sqlite3ExprCodeTarget(pParse, pExpr, target);
4641b639a209Sdrh   if( inReg!=target ){
4642629b88c6Sdrh     u8 op;
4643629b88c6Sdrh     if( ExprHasProperty(pExpr,EP_Subquery) ){
4644629b88c6Sdrh       op = OP_Copy;
4645629b88c6Sdrh     }else{
4646629b88c6Sdrh       op = OP_SCopy;
4647629b88c6Sdrh     }
4648629b88c6Sdrh     sqlite3VdbeAddOp2(pParse->pVdbe, op, inReg, target);
464917a7f8ddSdrh   }
4650ebc16717Sdrh }
4651cce7d176Sdrh 
4652cce7d176Sdrh /*
46531c75c9d7Sdrh ** Make a transient copy of expression pExpr and then code it using
46541c75c9d7Sdrh ** sqlite3ExprCode().  This routine works just like sqlite3ExprCode()
46551c75c9d7Sdrh ** except that the input expression is guaranteed to be unchanged.
46561c75c9d7Sdrh */
46571c75c9d7Sdrh void sqlite3ExprCodeCopy(Parse *pParse, Expr *pExpr, int target){
46581c75c9d7Sdrh   sqlite3 *db = pParse->db;
46591c75c9d7Sdrh   pExpr = sqlite3ExprDup(db, pExpr, 0);
46601c75c9d7Sdrh   if( !db->mallocFailed ) sqlite3ExprCode(pParse, pExpr, target);
46611c75c9d7Sdrh   sqlite3ExprDelete(db, pExpr);
46621c75c9d7Sdrh }
46631c75c9d7Sdrh 
46641c75c9d7Sdrh /*
466505a86c5cSdrh ** Generate code that will evaluate expression pExpr and store the
466605a86c5cSdrh ** results in register target.  The results are guaranteed to appear
466705a86c5cSdrh ** in register target.  If the expression is constant, then this routine
466805a86c5cSdrh ** might choose to code the expression at initialization time.
466905a86c5cSdrh */
467005a86c5cSdrh void sqlite3ExprCodeFactorable(Parse *pParse, Expr *pExpr, int target){
4671b8b06690Sdrh   if( pParse->okConstFactor && sqlite3ExprIsConstantNotJoin(pExpr) ){
46729b258c54Sdrh     sqlite3ExprCodeRunJustOnce(pParse, pExpr, target);
467305a86c5cSdrh   }else{
4674088489e8Sdrh     sqlite3ExprCodeCopy(pParse, pExpr, target);
467505a86c5cSdrh   }
4676cce7d176Sdrh }
4677cce7d176Sdrh 
4678cce7d176Sdrh /*
4679268380caSdrh ** Generate code that pushes the value of every element of the given
46809cbf3425Sdrh ** expression list into a sequence of registers beginning at target.
4681268380caSdrh **
46823df6c3b1Sdrh ** Return the number of elements evaluated.  The number returned will
46833df6c3b1Sdrh ** usually be pList->nExpr but might be reduced if SQLITE_ECEL_OMITREF
46843df6c3b1Sdrh ** is defined.
4685d1a01edaSdrh **
4686d1a01edaSdrh ** The SQLITE_ECEL_DUP flag prevents the arguments from being
4687d1a01edaSdrh ** filled using OP_SCopy.  OP_Copy must be used instead.
4688d1a01edaSdrh **
4689d1a01edaSdrh ** The SQLITE_ECEL_FACTOR argument allows constant arguments to be
4690d1a01edaSdrh ** factored out into initialization code.
4691b0df9634Sdrh **
4692b0df9634Sdrh ** The SQLITE_ECEL_REF flag means that expressions in the list with
4693b0df9634Sdrh ** ExprList.a[].u.x.iOrderByCol>0 have already been evaluated and stored
4694b0df9634Sdrh ** in registers at srcReg, and so the value can be copied from there.
46953df6c3b1Sdrh ** If SQLITE_ECEL_OMITREF is also set, then the values with u.x.iOrderByCol>0
46963df6c3b1Sdrh ** are simply omitted rather than being copied from srcReg.
4697268380caSdrh */
46984adee20fSdanielk1977 int sqlite3ExprCodeExprList(
4699268380caSdrh   Parse *pParse,     /* Parsing context */
4700389a1adbSdrh   ExprList *pList,   /* The expression list to be coded */
4701191b54cbSdrh   int target,        /* Where to write results */
47025579d59fSdrh   int srcReg,        /* Source registers if SQLITE_ECEL_REF */
4703d1a01edaSdrh   u8 flags           /* SQLITE_ECEL_* flags */
4704268380caSdrh ){
4705268380caSdrh   struct ExprList_item *pItem;
47065579d59fSdrh   int i, j, n;
4707d1a01edaSdrh   u8 copyOp = (flags & SQLITE_ECEL_DUP) ? OP_Copy : OP_SCopy;
47085579d59fSdrh   Vdbe *v = pParse->pVdbe;
47099d8b3072Sdrh   assert( pList!=0 );
47109cbf3425Sdrh   assert( target>0 );
4711d81a142bSdrh   assert( pParse->pVdbe!=0 );  /* Never gets this far otherwise */
4712268380caSdrh   n = pList->nExpr;
4713d9f158e7Sdrh   if( !ConstFactorOk(pParse) ) flags &= ~SQLITE_ECEL_FACTOR;
4714191b54cbSdrh   for(pItem=pList->a, i=0; i<n; i++, pItem++){
47157445ffe2Sdrh     Expr *pExpr = pItem->pExpr;
471624e25d32Sdan #ifdef SQLITE_ENABLE_SORTER_REFERENCES
471724e25d32Sdan     if( pItem->bSorterRef ){
471824e25d32Sdan       i--;
471924e25d32Sdan       n--;
472024e25d32Sdan     }else
472124e25d32Sdan #endif
4722257c13faSdan     if( (flags & SQLITE_ECEL_REF)!=0 && (j = pItem->u.x.iOrderByCol)>0 ){
4723257c13faSdan       if( flags & SQLITE_ECEL_OMITREF ){
4724257c13faSdan         i--;
4725257c13faSdan         n--;
4726257c13faSdan       }else{
47275579d59fSdrh         sqlite3VdbeAddOp2(v, copyOp, j+srcReg-1, target+i);
4728257c13faSdan       }
4729b8b06690Sdrh     }else if( (flags & SQLITE_ECEL_FACTOR)!=0
4730b8b06690Sdrh            && sqlite3ExprIsConstantNotJoin(pExpr)
4731b8b06690Sdrh     ){
47329b258c54Sdrh       sqlite3ExprCodeRunJustOnce(pParse, pExpr, target+i);
4733d1a01edaSdrh     }else{
47347445ffe2Sdrh       int inReg = sqlite3ExprCodeTarget(pParse, pExpr, target+i);
4735746fd9ccSdrh       if( inReg!=target+i ){
47364eded604Sdrh         VdbeOp *pOp;
47374eded604Sdrh         if( copyOp==OP_Copy
47384eded604Sdrh          && (pOp=sqlite3VdbeGetOp(v, -1))->opcode==OP_Copy
47394eded604Sdrh          && pOp->p1+pOp->p3+1==inReg
47404eded604Sdrh          && pOp->p2+pOp->p3+1==target+i
474190996885Sdrh          && pOp->p5==0  /* The do-not-merge flag must be clear */
47424eded604Sdrh         ){
47434eded604Sdrh           pOp->p3++;
47444eded604Sdrh         }else{
47454eded604Sdrh           sqlite3VdbeAddOp2(v, copyOp, inReg, target+i);
47464eded604Sdrh         }
4747d1a01edaSdrh       }
4748d176611bSdrh     }
4749268380caSdrh   }
4750f9b596ebSdrh   return n;
4751268380caSdrh }
4752268380caSdrh 
4753268380caSdrh /*
475436c563a2Sdrh ** Generate code for a BETWEEN operator.
475536c563a2Sdrh **
475636c563a2Sdrh **    x BETWEEN y AND z
475736c563a2Sdrh **
475836c563a2Sdrh ** The above is equivalent to
475936c563a2Sdrh **
476036c563a2Sdrh **    x>=y AND x<=z
476136c563a2Sdrh **
476236c563a2Sdrh ** Code it as such, taking care to do the common subexpression
476360ec914cSpeter.d.reid ** elimination of x.
476484b19a3dSdrh **
476584b19a3dSdrh ** The xJumpIf parameter determines details:
476684b19a3dSdrh **
476784b19a3dSdrh **    NULL:                   Store the boolean result in reg[dest]
476884b19a3dSdrh **    sqlite3ExprIfTrue:      Jump to dest if true
476984b19a3dSdrh **    sqlite3ExprIfFalse:     Jump to dest if false
477084b19a3dSdrh **
477184b19a3dSdrh ** The jumpIfNull parameter is ignored if xJumpIf is NULL.
477236c563a2Sdrh */
477336c563a2Sdrh static void exprCodeBetween(
477436c563a2Sdrh   Parse *pParse,    /* Parsing and code generating context */
477536c563a2Sdrh   Expr *pExpr,      /* The BETWEEN expression */
477684b19a3dSdrh   int dest,         /* Jump destination or storage location */
477784b19a3dSdrh   void (*xJump)(Parse*,Expr*,int,int), /* Action to take */
477836c563a2Sdrh   int jumpIfNull    /* Take the jump if the BETWEEN is NULL */
477936c563a2Sdrh ){
478036c563a2Sdrh   Expr exprAnd;     /* The AND operator in  x>=y AND x<=z  */
478136c563a2Sdrh   Expr compLeft;    /* The  x>=y  term */
478236c563a2Sdrh   Expr compRight;   /* The  x<=z  term */
4783db45bd5eSdrh   int regFree1 = 0; /* Temporary use register */
47848b65e591Sdan   Expr *pDel = 0;
47858b65e591Sdan   sqlite3 *db = pParse->db;
478684b19a3dSdrh 
478771c57db0Sdan   memset(&compLeft, 0, sizeof(Expr));
478871c57db0Sdan   memset(&compRight, 0, sizeof(Expr));
478971c57db0Sdan   memset(&exprAnd, 0, sizeof(Expr));
4790db45bd5eSdrh 
4791db45bd5eSdrh   assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
47928b65e591Sdan   pDel = sqlite3ExprDup(db, pExpr->pLeft, 0);
47938b65e591Sdan   if( db->mallocFailed==0 ){
479436c563a2Sdrh     exprAnd.op = TK_AND;
479536c563a2Sdrh     exprAnd.pLeft = &compLeft;
479636c563a2Sdrh     exprAnd.pRight = &compRight;
479736c563a2Sdrh     compLeft.op = TK_GE;
47988b65e591Sdan     compLeft.pLeft = pDel;
479936c563a2Sdrh     compLeft.pRight = pExpr->x.pList->a[0].pExpr;
480036c563a2Sdrh     compRight.op = TK_LE;
48018b65e591Sdan     compRight.pLeft = pDel;
480236c563a2Sdrh     compRight.pRight = pExpr->x.pList->a[1].pExpr;
48038b65e591Sdan     exprToRegister(pDel, exprCodeVector(pParse, pDel, &regFree1));
480484b19a3dSdrh     if( xJump ){
480584b19a3dSdrh       xJump(pParse, &exprAnd, dest, jumpIfNull);
480636c563a2Sdrh     }else{
480736fd41e5Sdrh       /* Mark the expression is being from the ON or USING clause of a join
480836fd41e5Sdrh       ** so that the sqlite3ExprCodeTarget() routine will not attempt to move
480936fd41e5Sdrh       ** it into the Parse.pConstExpr list.  We should use a new bit for this,
481036fd41e5Sdrh       ** for clarity, but we are out of bits in the Expr.flags field so we
481136fd41e5Sdrh       ** have to reuse the EP_FromJoin bit.  Bummer. */
48128b65e591Sdan       pDel->flags |= EP_FromJoin;
481371c57db0Sdan       sqlite3ExprCodeTarget(pParse, &exprAnd, dest);
481436c563a2Sdrh     }
4815db45bd5eSdrh     sqlite3ReleaseTempReg(pParse, regFree1);
48168b65e591Sdan   }
48178b65e591Sdan   sqlite3ExprDelete(db, pDel);
481836c563a2Sdrh 
481936c563a2Sdrh   /* Ensure adequate test coverage */
4820db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull==0 && regFree1==0 );
4821db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull==0 && regFree1!=0 );
4822db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull!=0 && regFree1==0 );
4823db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull!=0 && regFree1!=0 );
4824db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1==0 );
4825db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1!=0 );
4826db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1==0 );
4827db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1!=0 );
482884b19a3dSdrh   testcase( xJump==0 );
482936c563a2Sdrh }
483036c563a2Sdrh 
483136c563a2Sdrh /*
4832cce7d176Sdrh ** Generate code for a boolean expression such that a jump is made
4833cce7d176Sdrh ** to the label "dest" if the expression is true but execution
4834cce7d176Sdrh ** continues straight thru if the expression is false.
4835f5905aa7Sdrh **
4836f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false), then
483735573356Sdrh ** take the jump if the jumpIfNull flag is SQLITE_JUMPIFNULL.
4838f2bc013cSdrh **
4839f2bc013cSdrh ** This code depends on the fact that certain token values (ex: TK_EQ)
4840f2bc013cSdrh ** are the same as opcode values (ex: OP_Eq) that implement the corresponding
4841f2bc013cSdrh ** operation.  Special comments in vdbe.c and the mkopcodeh.awk script in
4842f2bc013cSdrh ** the make process cause these values to align.  Assert()s in the code
4843f2bc013cSdrh ** below verify that the numbers are aligned correctly.
4844cce7d176Sdrh */
48454adee20fSdanielk1977 void sqlite3ExprIfTrue(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
4846cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
4847cce7d176Sdrh   int op = 0;
48482dcef11bSdrh   int regFree1 = 0;
48492dcef11bSdrh   int regFree2 = 0;
48502dcef11bSdrh   int r1, r2;
48512dcef11bSdrh 
485235573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
485348864df9Smistachkin   if( NEVER(v==0) )     return;  /* Existence of VDBE checked by caller */
485433cd4909Sdrh   if( NEVER(pExpr==0) ) return;  /* No way this can happen */
4855e7375bfaSdrh   assert( !ExprHasVVAProperty(pExpr, EP_Immutable) );
4856f2bc013cSdrh   op = pExpr->op;
48577b35a77bSdan   switch( op ){
485817180fcaSdrh     case TK_AND:
485917180fcaSdrh     case TK_OR: {
486017180fcaSdrh       Expr *pAlt = sqlite3ExprSimplifiedAndOr(pExpr);
486117180fcaSdrh       if( pAlt!=pExpr ){
486217180fcaSdrh         sqlite3ExprIfTrue(pParse, pAlt, dest, jumpIfNull);
486317180fcaSdrh       }else if( op==TK_AND ){
4864ec4ccdbcSdrh         int d2 = sqlite3VdbeMakeLabel(pParse);
4865c5499befSdrh         testcase( jumpIfNull==0 );
486617180fcaSdrh         sqlite3ExprIfFalse(pParse, pExpr->pLeft, d2,
486717180fcaSdrh                            jumpIfNull^SQLITE_JUMPIFNULL);
48684adee20fSdanielk1977         sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
48694adee20fSdanielk1977         sqlite3VdbeResolveLabel(v, d2);
487017180fcaSdrh       }else{
4871c5499befSdrh         testcase( jumpIfNull==0 );
48724adee20fSdanielk1977         sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
48734adee20fSdanielk1977         sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
487417180fcaSdrh       }
4875cce7d176Sdrh       break;
4876cce7d176Sdrh     }
4877cce7d176Sdrh     case TK_NOT: {
4878c5499befSdrh       testcase( jumpIfNull==0 );
48794adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
4880cce7d176Sdrh       break;
4881cce7d176Sdrh     }
48828abed7b9Sdrh     case TK_TRUTH: {
488396acafbeSdrh       int isNot;      /* IS NOT TRUE or IS NOT FALSE */
488496acafbeSdrh       int isTrue;     /* IS TRUE or IS NOT TRUE */
4885007c843bSdrh       testcase( jumpIfNull==0 );
48868abed7b9Sdrh       isNot = pExpr->op2==TK_ISNOT;
488796acafbeSdrh       isTrue = sqlite3ExprTruthValue(pExpr->pRight);
488843c4ac8bSdrh       testcase( isTrue && isNot );
488996acafbeSdrh       testcase( !isTrue && isNot );
489043c4ac8bSdrh       if( isTrue ^ isNot ){
48918abed7b9Sdrh         sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
48928abed7b9Sdrh                           isNot ? SQLITE_JUMPIFNULL : 0);
48938abed7b9Sdrh       }else{
48948abed7b9Sdrh         sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
48958abed7b9Sdrh                            isNot ? SQLITE_JUMPIFNULL : 0);
48968abed7b9Sdrh       }
4897007c843bSdrh       break;
4898007c843bSdrh     }
4899de845c2fSdrh     case TK_IS:
4900de845c2fSdrh     case TK_ISNOT:
4901de845c2fSdrh       testcase( op==TK_IS );
4902de845c2fSdrh       testcase( op==TK_ISNOT );
4903de845c2fSdrh       op = (op==TK_IS) ? TK_EQ : TK_NE;
4904de845c2fSdrh       jumpIfNull = SQLITE_NULLEQ;
490508b92086Sdrh       /* no break */ deliberate_fall_through
4906cce7d176Sdrh     case TK_LT:
4907cce7d176Sdrh     case TK_LE:
4908cce7d176Sdrh     case TK_GT:
4909cce7d176Sdrh     case TK_GE:
4910cce7d176Sdrh     case TK_NE:
49110ac65892Sdrh     case TK_EQ: {
4912625015e0Sdan       if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
4913c5499befSdrh       testcase( jumpIfNull==0 );
4914b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4915b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
491635573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
4917898c527eSdrh                   r1, r2, dest, jumpIfNull, ExprHasProperty(pExpr,EP_Commuted));
49187d176105Sdrh       assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
49197d176105Sdrh       assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
49207d176105Sdrh       assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
49217d176105Sdrh       assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
4922de845c2fSdrh       assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4923de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4924de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4925de845c2fSdrh       assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4926de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
4927de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
49286a2fe093Sdrh       testcase( regFree1==0 );
49296a2fe093Sdrh       testcase( regFree2==0 );
49306a2fe093Sdrh       break;
49316a2fe093Sdrh     }
4932cce7d176Sdrh     case TK_ISNULL:
4933cce7d176Sdrh     case TK_NOTNULL: {
49347d176105Sdrh       assert( TK_ISNULL==OP_IsNull );   testcase( op==TK_ISNULL );
49357d176105Sdrh       assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
49362dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
49372dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
49387d176105Sdrh       VdbeCoverageIf(v, op==TK_ISNULL);
49397d176105Sdrh       VdbeCoverageIf(v, op==TK_NOTNULL);
4940c5499befSdrh       testcase( regFree1==0 );
4941cce7d176Sdrh       break;
4942cce7d176Sdrh     }
4943fef5208cSdrh     case TK_BETWEEN: {
49445c03f30aSdrh       testcase( jumpIfNull==0 );
494571c57db0Sdan       exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfTrue, jumpIfNull);
4946fef5208cSdrh       break;
4947fef5208cSdrh     }
4948bb201344Sshaneh #ifndef SQLITE_OMIT_SUBQUERY
4949e3365e6cSdrh     case TK_IN: {
4950ec4ccdbcSdrh       int destIfFalse = sqlite3VdbeMakeLabel(pParse);
4951e3365e6cSdrh       int destIfNull = jumpIfNull ? dest : destIfFalse;
4952e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
4953076e85f5Sdrh       sqlite3VdbeGoto(v, dest);
4954e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
4955e3365e6cSdrh       break;
4956e3365e6cSdrh     }
4957bb201344Sshaneh #endif
4958cce7d176Sdrh     default: {
49597b35a77bSdan     default_expr:
4960ad31727fSdrh       if( ExprAlwaysTrue(pExpr) ){
4961076e85f5Sdrh         sqlite3VdbeGoto(v, dest);
4962ad31727fSdrh       }else if( ExprAlwaysFalse(pExpr) ){
4963991a1985Sdrh         /* No-op */
4964991a1985Sdrh       }else{
49652dcef11bSdrh         r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
49662dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_If, r1, dest, jumpIfNull!=0);
4967688852abSdrh         VdbeCoverage(v);
4968c5499befSdrh         testcase( regFree1==0 );
4969c5499befSdrh         testcase( jumpIfNull==0 );
4970991a1985Sdrh       }
4971cce7d176Sdrh       break;
4972cce7d176Sdrh     }
4973cce7d176Sdrh   }
49742dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
49752dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
4976cce7d176Sdrh }
4977cce7d176Sdrh 
4978cce7d176Sdrh /*
497966b89c8fSdrh ** Generate code for a boolean expression such that a jump is made
4980cce7d176Sdrh ** to the label "dest" if the expression is false but execution
4981cce7d176Sdrh ** continues straight thru if the expression is true.
4982f5905aa7Sdrh **
4983f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false) then
498435573356Sdrh ** jump if jumpIfNull is SQLITE_JUMPIFNULL or fall through if jumpIfNull
498535573356Sdrh ** is 0.
4986cce7d176Sdrh */
49874adee20fSdanielk1977 void sqlite3ExprIfFalse(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
4988cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
4989cce7d176Sdrh   int op = 0;
49902dcef11bSdrh   int regFree1 = 0;
49912dcef11bSdrh   int regFree2 = 0;
49922dcef11bSdrh   int r1, r2;
49932dcef11bSdrh 
499435573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
499548864df9Smistachkin   if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
499633cd4909Sdrh   if( pExpr==0 )    return;
4997e7375bfaSdrh   assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
4998f2bc013cSdrh 
4999f2bc013cSdrh   /* The value of pExpr->op and op are related as follows:
5000f2bc013cSdrh   **
5001f2bc013cSdrh   **       pExpr->op            op
5002f2bc013cSdrh   **       ---------          ----------
5003f2bc013cSdrh   **       TK_ISNULL          OP_NotNull
5004f2bc013cSdrh   **       TK_NOTNULL         OP_IsNull
5005f2bc013cSdrh   **       TK_NE              OP_Eq
5006f2bc013cSdrh   **       TK_EQ              OP_Ne
5007f2bc013cSdrh   **       TK_GT              OP_Le
5008f2bc013cSdrh   **       TK_LE              OP_Gt
5009f2bc013cSdrh   **       TK_GE              OP_Lt
5010f2bc013cSdrh   **       TK_LT              OP_Ge
5011f2bc013cSdrh   **
5012f2bc013cSdrh   ** For other values of pExpr->op, op is undefined and unused.
5013f2bc013cSdrh   ** The value of TK_ and OP_ constants are arranged such that we
5014f2bc013cSdrh   ** can compute the mapping above using the following expression.
5015f2bc013cSdrh   ** Assert()s verify that the computation is correct.
5016f2bc013cSdrh   */
5017f2bc013cSdrh   op = ((pExpr->op+(TK_ISNULL&1))^1)-(TK_ISNULL&1);
5018f2bc013cSdrh 
5019f2bc013cSdrh   /* Verify correct alignment of TK_ and OP_ constants
5020f2bc013cSdrh   */
5021f2bc013cSdrh   assert( pExpr->op!=TK_ISNULL || op==OP_NotNull );
5022f2bc013cSdrh   assert( pExpr->op!=TK_NOTNULL || op==OP_IsNull );
5023f2bc013cSdrh   assert( pExpr->op!=TK_NE || op==OP_Eq );
5024f2bc013cSdrh   assert( pExpr->op!=TK_EQ || op==OP_Ne );
5025f2bc013cSdrh   assert( pExpr->op!=TK_LT || op==OP_Ge );
5026f2bc013cSdrh   assert( pExpr->op!=TK_LE || op==OP_Gt );
5027f2bc013cSdrh   assert( pExpr->op!=TK_GT || op==OP_Le );
5028f2bc013cSdrh   assert( pExpr->op!=TK_GE || op==OP_Lt );
5029f2bc013cSdrh 
5030ba00e30aSdan   switch( pExpr->op ){
503117180fcaSdrh     case TK_AND:
503217180fcaSdrh     case TK_OR: {
503317180fcaSdrh       Expr *pAlt = sqlite3ExprSimplifiedAndOr(pExpr);
503417180fcaSdrh       if( pAlt!=pExpr ){
503517180fcaSdrh         sqlite3ExprIfFalse(pParse, pAlt, dest, jumpIfNull);
503617180fcaSdrh       }else if( pExpr->op==TK_AND ){
5037c5499befSdrh         testcase( jumpIfNull==0 );
50384adee20fSdanielk1977         sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
50394adee20fSdanielk1977         sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
504017180fcaSdrh       }else{
5041ec4ccdbcSdrh         int d2 = sqlite3VdbeMakeLabel(pParse);
5042c5499befSdrh         testcase( jumpIfNull==0 );
504317180fcaSdrh         sqlite3ExprIfTrue(pParse, pExpr->pLeft, d2,
504417180fcaSdrh                           jumpIfNull^SQLITE_JUMPIFNULL);
50454adee20fSdanielk1977         sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
50464adee20fSdanielk1977         sqlite3VdbeResolveLabel(v, d2);
504717180fcaSdrh       }
5048cce7d176Sdrh       break;
5049cce7d176Sdrh     }
5050cce7d176Sdrh     case TK_NOT: {
50515c03f30aSdrh       testcase( jumpIfNull==0 );
50524adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
5053cce7d176Sdrh       break;
5054cce7d176Sdrh     }
50558abed7b9Sdrh     case TK_TRUTH: {
505696acafbeSdrh       int isNot;   /* IS NOT TRUE or IS NOT FALSE */
505796acafbeSdrh       int isTrue;  /* IS TRUE or IS NOT TRUE */
50588abed7b9Sdrh       testcase( jumpIfNull==0 );
50598abed7b9Sdrh       isNot = pExpr->op2==TK_ISNOT;
506096acafbeSdrh       isTrue = sqlite3ExprTruthValue(pExpr->pRight);
506143c4ac8bSdrh       testcase( isTrue && isNot );
506296acafbeSdrh       testcase( !isTrue && isNot );
506343c4ac8bSdrh       if( isTrue ^ isNot ){
50648abed7b9Sdrh         /* IS TRUE and IS NOT FALSE */
50658abed7b9Sdrh         sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
50668abed7b9Sdrh                            isNot ? 0 : SQLITE_JUMPIFNULL);
50678abed7b9Sdrh 
50688abed7b9Sdrh       }else{
50698abed7b9Sdrh         /* IS FALSE and IS NOT TRUE */
50708abed7b9Sdrh         sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
50718abed7b9Sdrh                           isNot ? 0 : SQLITE_JUMPIFNULL);
50728abed7b9Sdrh       }
5073007c843bSdrh       break;
5074007c843bSdrh     }
5075de845c2fSdrh     case TK_IS:
5076de845c2fSdrh     case TK_ISNOT:
5077de845c2fSdrh       testcase( pExpr->op==TK_IS );
5078de845c2fSdrh       testcase( pExpr->op==TK_ISNOT );
5079de845c2fSdrh       op = (pExpr->op==TK_IS) ? TK_NE : TK_EQ;
5080de845c2fSdrh       jumpIfNull = SQLITE_NULLEQ;
508108b92086Sdrh       /* no break */ deliberate_fall_through
5082cce7d176Sdrh     case TK_LT:
5083cce7d176Sdrh     case TK_LE:
5084cce7d176Sdrh     case TK_GT:
5085cce7d176Sdrh     case TK_GE:
5086cce7d176Sdrh     case TK_NE:
5087cce7d176Sdrh     case TK_EQ: {
5088625015e0Sdan       if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
5089c5499befSdrh       testcase( jumpIfNull==0 );
5090b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
5091b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
509235573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
5093898c527eSdrh                   r1, r2, dest, jumpIfNull,ExprHasProperty(pExpr,EP_Commuted));
50947d176105Sdrh       assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
50957d176105Sdrh       assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
50967d176105Sdrh       assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
50977d176105Sdrh       assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
5098de845c2fSdrh       assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
5099de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
5100de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
5101de845c2fSdrh       assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
5102de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
5103de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
51046a2fe093Sdrh       testcase( regFree1==0 );
51056a2fe093Sdrh       testcase( regFree2==0 );
51066a2fe093Sdrh       break;
51076a2fe093Sdrh     }
5108cce7d176Sdrh     case TK_ISNULL:
5109cce7d176Sdrh     case TK_NOTNULL: {
51102dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
51112dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
51127d176105Sdrh       testcase( op==TK_ISNULL );   VdbeCoverageIf(v, op==TK_ISNULL);
51137d176105Sdrh       testcase( op==TK_NOTNULL );  VdbeCoverageIf(v, op==TK_NOTNULL);
5114c5499befSdrh       testcase( regFree1==0 );
5115cce7d176Sdrh       break;
5116cce7d176Sdrh     }
5117fef5208cSdrh     case TK_BETWEEN: {
51185c03f30aSdrh       testcase( jumpIfNull==0 );
511971c57db0Sdan       exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfFalse, jumpIfNull);
5120fef5208cSdrh       break;
5121fef5208cSdrh     }
5122bb201344Sshaneh #ifndef SQLITE_OMIT_SUBQUERY
5123e3365e6cSdrh     case TK_IN: {
5124e3365e6cSdrh       if( jumpIfNull ){
5125e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, dest);
5126e3365e6cSdrh       }else{
5127ec4ccdbcSdrh         int destIfNull = sqlite3VdbeMakeLabel(pParse);
5128e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, destIfNull);
5129e3365e6cSdrh         sqlite3VdbeResolveLabel(v, destIfNull);
5130e3365e6cSdrh       }
5131e3365e6cSdrh       break;
5132e3365e6cSdrh     }
5133bb201344Sshaneh #endif
5134cce7d176Sdrh     default: {
5135ba00e30aSdan     default_expr:
5136ad31727fSdrh       if( ExprAlwaysFalse(pExpr) ){
5137076e85f5Sdrh         sqlite3VdbeGoto(v, dest);
5138ad31727fSdrh       }else if( ExprAlwaysTrue(pExpr) ){
5139991a1985Sdrh         /* no-op */
5140991a1985Sdrh       }else{
51412dcef11bSdrh         r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
51422dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_IfNot, r1, dest, jumpIfNull!=0);
5143688852abSdrh         VdbeCoverage(v);
5144c5499befSdrh         testcase( regFree1==0 );
5145c5499befSdrh         testcase( jumpIfNull==0 );
5146991a1985Sdrh       }
5147cce7d176Sdrh       break;
5148cce7d176Sdrh     }
5149cce7d176Sdrh   }
51502dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
51512dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
5152cce7d176Sdrh }
51532282792aSdrh 
51542282792aSdrh /*
515572bc8208Sdrh ** Like sqlite3ExprIfFalse() except that a copy is made of pExpr before
515672bc8208Sdrh ** code generation, and that copy is deleted after code generation. This
515772bc8208Sdrh ** ensures that the original pExpr is unchanged.
515872bc8208Sdrh */
515972bc8208Sdrh void sqlite3ExprIfFalseDup(Parse *pParse, Expr *pExpr, int dest,int jumpIfNull){
516072bc8208Sdrh   sqlite3 *db = pParse->db;
516172bc8208Sdrh   Expr *pCopy = sqlite3ExprDup(db, pExpr, 0);
516272bc8208Sdrh   if( db->mallocFailed==0 ){
516372bc8208Sdrh     sqlite3ExprIfFalse(pParse, pCopy, dest, jumpIfNull);
516472bc8208Sdrh   }
516572bc8208Sdrh   sqlite3ExprDelete(db, pCopy);
516672bc8208Sdrh }
516772bc8208Sdrh 
51685aa550cfSdan /*
51695aa550cfSdan ** Expression pVar is guaranteed to be an SQL variable. pExpr may be any
51705aa550cfSdan ** type of expression.
51715aa550cfSdan **
51725aa550cfSdan ** If pExpr is a simple SQL value - an integer, real, string, blob
51735aa550cfSdan ** or NULL value - then the VDBE currently being prepared is configured
51745aa550cfSdan ** to re-prepare each time a new value is bound to variable pVar.
51755aa550cfSdan **
51765aa550cfSdan ** Additionally, if pExpr is a simple SQL value and the value is the
51775aa550cfSdan ** same as that currently bound to variable pVar, non-zero is returned.
51785aa550cfSdan ** Otherwise, if the values are not the same or if pExpr is not a simple
51795aa550cfSdan ** SQL value, zero is returned.
51805aa550cfSdan */
51815aa550cfSdan static int exprCompareVariable(Parse *pParse, Expr *pVar, Expr *pExpr){
51825aa550cfSdan   int res = 0;
5183c0804226Sdrh   int iVar;
5184c0804226Sdrh   sqlite3_value *pL, *pR = 0;
51855aa550cfSdan 
51865aa550cfSdan   sqlite3ValueFromExpr(pParse->db, pExpr, SQLITE_UTF8, SQLITE_AFF_BLOB, &pR);
5187c0804226Sdrh   if( pR ){
5188c0804226Sdrh     iVar = pVar->iColumn;
5189c0804226Sdrh     sqlite3VdbeSetVarmask(pParse->pVdbe, iVar);
5190c0804226Sdrh     pL = sqlite3VdbeGetBoundValue(pParse->pReprepare, iVar, SQLITE_AFF_BLOB);
51915aa307e2Sdrh     if( pL ){
51925aa307e2Sdrh       if( sqlite3_value_type(pL)==SQLITE_TEXT ){
51935aa307e2Sdrh         sqlite3_value_text(pL); /* Make sure the encoding is UTF-8 */
51945aa307e2Sdrh       }
51955aa307e2Sdrh       res =  0==sqlite3MemCompare(pL, pR, 0);
51965aa550cfSdan     }
51975aa550cfSdan     sqlite3ValueFree(pR);
51985aa550cfSdan     sqlite3ValueFree(pL);
51995aa550cfSdan   }
52005aa550cfSdan 
52015aa550cfSdan   return res;
52025aa550cfSdan }
520372bc8208Sdrh 
520472bc8208Sdrh /*
52051d9da70aSdrh ** Do a deep comparison of two expression trees.  Return 0 if the two
52061d9da70aSdrh ** expressions are completely identical.  Return 1 if they differ only
52071d9da70aSdrh ** by a COLLATE operator at the top level.  Return 2 if there are differences
52081d9da70aSdrh ** other than the top-level COLLATE operator.
5209d40aab0eSdrh **
5210619a1305Sdrh ** If any subelement of pB has Expr.iTable==(-1) then it is allowed
5211619a1305Sdrh ** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
5212619a1305Sdrh **
521366518ca7Sdrh ** The pA side might be using TK_REGISTER.  If that is the case and pB is
521466518ca7Sdrh ** not using TK_REGISTER but is otherwise equivalent, then still return 0.
521566518ca7Sdrh **
52161d9da70aSdrh ** Sometimes this routine will return 2 even if the two expressions
5217d40aab0eSdrh ** really are equivalent.  If we cannot prove that the expressions are
52181d9da70aSdrh ** identical, we return 2 just to be safe.  So if this routine
52191d9da70aSdrh ** returns 2, then you do not really know for certain if the two
52201d9da70aSdrh ** expressions are the same.  But if you get a 0 or 1 return, then you
5221d40aab0eSdrh ** can be sure the expressions are the same.  In the places where
52221d9da70aSdrh ** this routine is used, it does not hurt to get an extra 2 - that
5223d40aab0eSdrh ** just might result in some slightly slower code.  But returning
52241d9da70aSdrh ** an incorrect 0 or 1 could lead to a malfunction.
52255aa550cfSdan **
5226c0804226Sdrh ** If pParse is not NULL then TK_VARIABLE terms in pA with bindings in
5227c0804226Sdrh ** pParse->pReprepare can be matched against literals in pB.  The
5228c0804226Sdrh ** pParse->pVdbe->expmask bitmask is updated for each variable referenced.
5229c0804226Sdrh ** If pParse is NULL (the normal case) then any TK_VARIABLE term in
5230c0804226Sdrh ** Argument pParse should normally be NULL. If it is not NULL and pA or
5231c0804226Sdrh ** pB causes a return value of 2.
52322282792aSdrh */
52335aa550cfSdan int sqlite3ExprCompare(Parse *pParse, Expr *pA, Expr *pB, int iTab){
523410d1edf0Sdrh   u32 combinedFlags;
52354b202ae2Sdanielk1977   if( pA==0 || pB==0 ){
52361d9da70aSdrh     return pB==pA ? 0 : 2;
52372282792aSdrh   }
52385aa550cfSdan   if( pParse && pA->op==TK_VARIABLE && exprCompareVariable(pParse, pA, pB) ){
52395aa550cfSdan     return 0;
52405aa550cfSdan   }
524110d1edf0Sdrh   combinedFlags = pA->flags | pB->flags;
524210d1edf0Sdrh   if( combinedFlags & EP_IntValue ){
524310d1edf0Sdrh     if( (pA->flags&pB->flags&EP_IntValue)!=0 && pA->u.iValue==pB->u.iValue ){
524410d1edf0Sdrh       return 0;
524510d1edf0Sdrh     }
52461d9da70aSdrh     return 2;
52476ab3a2ecSdanielk1977   }
524816dd3985Sdan   if( pA->op!=pB->op || pA->op==TK_RAISE ){
52495aa550cfSdan     if( pA->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA->pLeft,pB,iTab)<2 ){
5250ae80ddeaSdrh       return 1;
5251ae80ddeaSdrh     }
52525aa550cfSdan     if( pB->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA,pB->pLeft,iTab)<2 ){
5253ae80ddeaSdrh       return 1;
5254ae80ddeaSdrh     }
5255ae80ddeaSdrh     return 2;
5256ae80ddeaSdrh   }
52572edc5fd7Sdrh   if( pA->op!=TK_COLUMN && pA->op!=TK_AGG_COLUMN && pA->u.zToken ){
52584f9adee2Sdan     if( pA->op==TK_FUNCTION || pA->op==TK_AGG_FUNCTION ){
5259390b88a4Sdrh       if( sqlite3StrICmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
5260eda079cdSdrh #ifndef SQLITE_OMIT_WINDOWFUNC
52614f9adee2Sdan       assert( pA->op==pB->op );
52624f9adee2Sdan       if( ExprHasProperty(pA,EP_WinFunc)!=ExprHasProperty(pB,EP_WinFunc) ){
52634f9adee2Sdan         return 2;
52644f9adee2Sdan       }
5265eda079cdSdrh       if( ExprHasProperty(pA,EP_WinFunc) ){
52664f9adee2Sdan         if( sqlite3WindowCompare(pParse, pA->y.pWin, pB->y.pWin, 1)!=0 ){
52674f9adee2Sdan           return 2;
52684f9adee2Sdan         }
5269eda079cdSdrh       }
5270eda079cdSdrh #endif
5271f20bbc5fSdrh     }else if( pA->op==TK_NULL ){
5272f20bbc5fSdrh       return 0;
5273d5af5420Sdrh     }else if( pA->op==TK_COLLATE ){
5274e79f6299Sdrh       if( sqlite3_stricmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
5275f20bbc5fSdrh     }else if( ALWAYS(pB->u.zToken!=0) && strcmp(pA->u.zToken,pB->u.zToken)!=0 ){
5276d5af5420Sdrh       return 2;
527710d1edf0Sdrh     }
527810d1edf0Sdrh   }
5279898c527eSdrh   if( (pA->flags & (EP_Distinct|EP_Commuted))
5280898c527eSdrh      != (pB->flags & (EP_Distinct|EP_Commuted)) ) return 2;
5281e7375bfaSdrh   if( ALWAYS((combinedFlags & EP_TokenOnly)==0) ){
528210d1edf0Sdrh     if( combinedFlags & EP_xIsSelect ) return 2;
5283efad2e23Sdrh     if( (combinedFlags & EP_FixedCol)==0
5284efad2e23Sdrh      && sqlite3ExprCompare(pParse, pA->pLeft, pB->pLeft, iTab) ) return 2;
52855aa550cfSdan     if( sqlite3ExprCompare(pParse, pA->pRight, pB->pRight, iTab) ) return 2;
5286619a1305Sdrh     if( sqlite3ExprListCompare(pA->x.pList, pB->x.pList, iTab) ) return 2;
528703c5c213Sdrh     if( pA->op!=TK_STRING
528803c5c213Sdrh      && pA->op!=TK_TRUEFALSE
5289e7375bfaSdrh      && ALWAYS((combinedFlags & EP_Reduced)==0)
529003c5c213Sdrh     ){
5291619a1305Sdrh       if( pA->iColumn!=pB->iColumn ) return 2;
52929b258c54Sdrh       if( pA->op2!=pB->op2 && pA->op==TK_TRUTH ) return 2;
52930f28e1bdSdrh       if( pA->op!=TK_IN && pA->iTable!=pB->iTable && pA->iTable!=iTab ){
52940f28e1bdSdrh         return 2;
52950f28e1bdSdrh       }
52961d9da70aSdrh     }
52971d9da70aSdrh   }
52982646da7eSdrh   return 0;
52992646da7eSdrh }
53002282792aSdrh 
53018c6f666bSdrh /*
5302fbb6e9ffSdan ** Compare two ExprList objects.  Return 0 if they are identical, 1
5303fbb6e9ffSdan ** if they are certainly different, or 2 if it is not possible to
5304fbb6e9ffSdan ** determine if they are identical or not.
53058c6f666bSdrh **
5306619a1305Sdrh ** If any subelement of pB has Expr.iTable==(-1) then it is allowed
5307619a1305Sdrh ** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
5308619a1305Sdrh **
53098c6f666bSdrh ** This routine might return non-zero for equivalent ExprLists.  The
53108c6f666bSdrh ** only consequence will be disabled optimizations.  But this routine
53118c6f666bSdrh ** must never return 0 if the two ExprList objects are different, or
53128c6f666bSdrh ** a malfunction will result.
53138c6f666bSdrh **
53148c6f666bSdrh ** Two NULL pointers are considered to be the same.  But a NULL pointer
53158c6f666bSdrh ** always differs from a non-NULL pointer.
53168c6f666bSdrh */
5317619a1305Sdrh int sqlite3ExprListCompare(ExprList *pA, ExprList *pB, int iTab){
53188c6f666bSdrh   int i;
53198c6f666bSdrh   if( pA==0 && pB==0 ) return 0;
53208c6f666bSdrh   if( pA==0 || pB==0 ) return 1;
53218c6f666bSdrh   if( pA->nExpr!=pB->nExpr ) return 1;
53228c6f666bSdrh   for(i=0; i<pA->nExpr; i++){
5323fbb6e9ffSdan     int res;
53248c6f666bSdrh     Expr *pExprA = pA->a[i].pExpr;
53258c6f666bSdrh     Expr *pExprB = pB->a[i].pExpr;
53266e11892dSdan     if( pA->a[i].sortFlags!=pB->a[i].sortFlags ) return 1;
5327fbb6e9ffSdan     if( (res = sqlite3ExprCompare(0, pExprA, pExprB, iTab)) ) return res;
53288c6f666bSdrh   }
53298c6f666bSdrh   return 0;
53308c6f666bSdrh }
533113449892Sdrh 
53322282792aSdrh /*
5333f9463dfbSdrh ** Like sqlite3ExprCompare() except COLLATE operators at the top-level
5334f9463dfbSdrh ** are ignored.
5335f9463dfbSdrh */
5336f9463dfbSdrh int sqlite3ExprCompareSkip(Expr *pA, Expr *pB, int iTab){
53375aa550cfSdan   return sqlite3ExprCompare(0,
53380d950af3Sdrh              sqlite3ExprSkipCollateAndLikely(pA),
53390d950af3Sdrh              sqlite3ExprSkipCollateAndLikely(pB),
5340f9463dfbSdrh              iTab);
5341f9463dfbSdrh }
5342f9463dfbSdrh 
5343f9463dfbSdrh /*
5344c51cf864Sdrh ** Return non-zero if Expr p can only be true if pNN is not NULL.
53457a231b49Sdrh **
53467a231b49Sdrh ** Or if seenNot is true, return non-zero if Expr p can only be
53477a231b49Sdrh ** non-NULL if pNN is not NULL
5348c51cf864Sdrh */
5349c51cf864Sdrh static int exprImpliesNotNull(
5350c51cf864Sdrh   Parse *pParse,      /* Parsing context */
5351c51cf864Sdrh   Expr *p,            /* The expression to be checked */
5352c51cf864Sdrh   Expr *pNN,          /* The expression that is NOT NULL */
5353c51cf864Sdrh   int iTab,           /* Table being evaluated */
53547a231b49Sdrh   int seenNot         /* Return true only if p can be any non-NULL value */
5355c51cf864Sdrh ){
5356c51cf864Sdrh   assert( p );
5357c51cf864Sdrh   assert( pNN );
535814c865e8Sdrh   if( sqlite3ExprCompare(pParse, p, pNN, iTab)==0 ){
535914c865e8Sdrh     return pNN->op!=TK_NULL;
536014c865e8Sdrh   }
5361c51cf864Sdrh   switch( p->op ){
5362c51cf864Sdrh     case TK_IN: {
5363c51cf864Sdrh       if( seenNot && ExprHasProperty(p, EP_xIsSelect) ) return 0;
5364c51cf864Sdrh       assert( ExprHasProperty(p,EP_xIsSelect)
5365c51cf864Sdrh            || (p->x.pList!=0 && p->x.pList->nExpr>0) );
5366ae144a1cSdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
5367c51cf864Sdrh     }
5368c51cf864Sdrh     case TK_BETWEEN: {
5369c51cf864Sdrh       ExprList *pList = p->x.pList;
5370c51cf864Sdrh       assert( pList!=0 );
5371c51cf864Sdrh       assert( pList->nExpr==2 );
5372c51cf864Sdrh       if( seenNot ) return 0;
53737a231b49Sdrh       if( exprImpliesNotNull(pParse, pList->a[0].pExpr, pNN, iTab, 1)
53747a231b49Sdrh        || exprImpliesNotNull(pParse, pList->a[1].pExpr, pNN, iTab, 1)
5375c51cf864Sdrh       ){
5376c51cf864Sdrh         return 1;
5377c51cf864Sdrh       }
53787a231b49Sdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
5379c51cf864Sdrh     }
5380c51cf864Sdrh     case TK_EQ:
5381c51cf864Sdrh     case TK_NE:
5382c51cf864Sdrh     case TK_LT:
5383c51cf864Sdrh     case TK_LE:
5384c51cf864Sdrh     case TK_GT:
5385c51cf864Sdrh     case TK_GE:
5386c51cf864Sdrh     case TK_PLUS:
5387c51cf864Sdrh     case TK_MINUS:
53889d23ea74Sdan     case TK_BITOR:
53899d23ea74Sdan     case TK_LSHIFT:
53909d23ea74Sdan     case TK_RSHIFT:
53919d23ea74Sdan     case TK_CONCAT:
53929d23ea74Sdan       seenNot = 1;
539308b92086Sdrh       /* no break */ deliberate_fall_through
5394c51cf864Sdrh     case TK_STAR:
5395c51cf864Sdrh     case TK_REM:
5396c51cf864Sdrh     case TK_BITAND:
53979d23ea74Sdan     case TK_SLASH: {
5398c51cf864Sdrh       if( exprImpliesNotNull(pParse, p->pRight, pNN, iTab, seenNot) ) return 1;
539908b92086Sdrh       /* no break */ deliberate_fall_through
5400c51cf864Sdrh     }
5401c51cf864Sdrh     case TK_SPAN:
5402c51cf864Sdrh     case TK_COLLATE:
5403c51cf864Sdrh     case TK_UPLUS:
5404c51cf864Sdrh     case TK_UMINUS: {
5405c51cf864Sdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, seenNot);
5406c51cf864Sdrh     }
5407c51cf864Sdrh     case TK_TRUTH: {
5408c51cf864Sdrh       if( seenNot ) return 0;
5409c51cf864Sdrh       if( p->op2!=TK_IS ) return 0;
541038cefc83Sdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
5411c51cf864Sdrh     }
54121cd382e3Sdan     case TK_BITNOT:
5413c51cf864Sdrh     case TK_NOT: {
5414c51cf864Sdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
5415c51cf864Sdrh     }
5416c51cf864Sdrh   }
5417c51cf864Sdrh   return 0;
5418c51cf864Sdrh }
5419c51cf864Sdrh 
5420c51cf864Sdrh /*
54214bd5f73fSdrh ** Return true if we can prove the pE2 will always be true if pE1 is
54224bd5f73fSdrh ** true.  Return false if we cannot complete the proof or if pE2 might
54234bd5f73fSdrh ** be false.  Examples:
54244bd5f73fSdrh **
5425619a1305Sdrh **     pE1: x==5       pE2: x==5             Result: true
54264bd5f73fSdrh **     pE1: x>0        pE2: x==5             Result: false
5427619a1305Sdrh **     pE1: x=21       pE2: x=21 OR y=43     Result: true
54284bd5f73fSdrh **     pE1: x!=123     pE2: x IS NOT NULL    Result: true
5429619a1305Sdrh **     pE1: x!=?1      pE2: x IS NOT NULL    Result: true
5430619a1305Sdrh **     pE1: x IS NULL  pE2: x IS NOT NULL    Result: false
5431619a1305Sdrh **     pE1: x IS ?2    pE2: x IS NOT NULL    Reuslt: false
54324bd5f73fSdrh **
54334bd5f73fSdrh ** When comparing TK_COLUMN nodes between pE1 and pE2, if pE2 has
54344bd5f73fSdrh ** Expr.iTable<0 then assume a table number given by iTab.
54354bd5f73fSdrh **
5436c0804226Sdrh ** If pParse is not NULL, then the values of bound variables in pE1 are
5437c0804226Sdrh ** compared against literal values in pE2 and pParse->pVdbe->expmask is
5438c0804226Sdrh ** modified to record which bound variables are referenced.  If pParse
5439c0804226Sdrh ** is NULL, then false will be returned if pE1 contains any bound variables.
5440c0804226Sdrh **
54414bd5f73fSdrh ** When in doubt, return false.  Returning true might give a performance
54424bd5f73fSdrh ** improvement.  Returning false might cause a performance reduction, but
54434bd5f73fSdrh ** it will always give the correct answer and is hence always safe.
54444bd5f73fSdrh */
54455aa550cfSdan int sqlite3ExprImpliesExpr(Parse *pParse, Expr *pE1, Expr *pE2, int iTab){
54465aa550cfSdan   if( sqlite3ExprCompare(pParse, pE1, pE2, iTab)==0 ){
5447619a1305Sdrh     return 1;
5448619a1305Sdrh   }
5449619a1305Sdrh   if( pE2->op==TK_OR
54505aa550cfSdan    && (sqlite3ExprImpliesExpr(pParse, pE1, pE2->pLeft, iTab)
54515aa550cfSdan              || sqlite3ExprImpliesExpr(pParse, pE1, pE2->pRight, iTab) )
5452619a1305Sdrh   ){
5453619a1305Sdrh     return 1;
5454619a1305Sdrh   }
5455664d6d13Sdrh   if( pE2->op==TK_NOTNULL
5456c51cf864Sdrh    && exprImpliesNotNull(pParse, pE1, pE2->pLeft, iTab, 0)
5457664d6d13Sdrh   ){
5458c51cf864Sdrh     return 1;
5459619a1305Sdrh   }
5460619a1305Sdrh   return 0;
54614bd5f73fSdrh }
54624bd5f73fSdrh 
54634bd5f73fSdrh /*
54646c68d759Sdrh ** This is the Expr node callback for sqlite3ExprImpliesNonNullRow().
54652589787cSdrh ** If the expression node requires that the table at pWalker->iCur
5466f8937f90Sdrh ** have one or more non-NULL column, then set pWalker->eCode to 1 and abort.
5467f8937f90Sdrh **
5468f8937f90Sdrh ** This routine controls an optimization.  False positives (setting
5469f8937f90Sdrh ** pWalker->eCode to 1 when it should not be) are deadly, but false-negatives
5470f8937f90Sdrh ** (never setting pWalker->eCode) is a harmless missed optimization.
54712589787cSdrh */
54722589787cSdrh static int impliesNotNullRow(Walker *pWalker, Expr *pExpr){
5473f8937f90Sdrh   testcase( pExpr->op==TK_AGG_COLUMN );
5474821b610bSdrh   testcase( pExpr->op==TK_AGG_FUNCTION );
54752589787cSdrh   if( ExprHasProperty(pExpr, EP_FromJoin) ) return WRC_Prune;
54762589787cSdrh   switch( pExpr->op ){
54770493222fSdan     case TK_ISNOT:
54782589787cSdrh     case TK_ISNULL:
5479d5793672Sdrh     case TK_NOTNULL:
54802589787cSdrh     case TK_IS:
54812589787cSdrh     case TK_OR:
54826c68d759Sdrh     case TK_VECTOR:
54832c492061Sdrh     case TK_CASE:
5484e3eff266Sdrh     case TK_IN:
54852589787cSdrh     case TK_FUNCTION:
5486da03c1e6Sdan     case TK_TRUTH:
54870493222fSdan       testcase( pExpr->op==TK_ISNOT );
5488821b610bSdrh       testcase( pExpr->op==TK_ISNULL );
5489d5793672Sdrh       testcase( pExpr->op==TK_NOTNULL );
5490821b610bSdrh       testcase( pExpr->op==TK_IS );
5491821b610bSdrh       testcase( pExpr->op==TK_OR );
54926c68d759Sdrh       testcase( pExpr->op==TK_VECTOR );
5493821b610bSdrh       testcase( pExpr->op==TK_CASE );
5494821b610bSdrh       testcase( pExpr->op==TK_IN );
5495821b610bSdrh       testcase( pExpr->op==TK_FUNCTION );
5496da03c1e6Sdan       testcase( pExpr->op==TK_TRUTH );
54972589787cSdrh       return WRC_Prune;
54982589787cSdrh     case TK_COLUMN:
54992589787cSdrh       if( pWalker->u.iCur==pExpr->iTable ){
55002589787cSdrh         pWalker->eCode = 1;
55012589787cSdrh         return WRC_Abort;
55022589787cSdrh       }
55032589787cSdrh       return WRC_Prune;
55049881155dSdrh 
55059d23ea74Sdan     case TK_AND:
5506aef81674Sdrh       if( pWalker->eCode==0 ){
55070287c951Sdan         sqlite3WalkExpr(pWalker, pExpr->pLeft);
55080287c951Sdan         if( pWalker->eCode ){
55090287c951Sdan           pWalker->eCode = 0;
55100287c951Sdan           sqlite3WalkExpr(pWalker, pExpr->pRight);
55119d23ea74Sdan         }
5512aef81674Sdrh       }
55139d23ea74Sdan       return WRC_Prune;
55149d23ea74Sdan 
55159d23ea74Sdan     case TK_BETWEEN:
55161d24a531Sdan       if( sqlite3WalkExpr(pWalker, pExpr->pLeft)==WRC_Abort ){
55171d24a531Sdan         assert( pWalker->eCode );
55181d24a531Sdan         return WRC_Abort;
55191d24a531Sdan       }
55209d23ea74Sdan       return WRC_Prune;
55219d23ea74Sdan 
55229881155dSdrh     /* Virtual tables are allowed to use constraints like x=NULL.  So
55239881155dSdrh     ** a term of the form x=y does not prove that y is not null if x
55249881155dSdrh     ** is the column of a virtual table */
55259881155dSdrh     case TK_EQ:
55269881155dSdrh     case TK_NE:
55279881155dSdrh     case TK_LT:
55289881155dSdrh     case TK_LE:
55299881155dSdrh     case TK_GT:
553078d1d225Sdrh     case TK_GE: {
553178d1d225Sdrh       Expr *pLeft = pExpr->pLeft;
553278d1d225Sdrh       Expr *pRight = pExpr->pRight;
55339881155dSdrh       testcase( pExpr->op==TK_EQ );
55349881155dSdrh       testcase( pExpr->op==TK_NE );
55359881155dSdrh       testcase( pExpr->op==TK_LT );
55369881155dSdrh       testcase( pExpr->op==TK_LE );
55379881155dSdrh       testcase( pExpr->op==TK_GT );
55389881155dSdrh       testcase( pExpr->op==TK_GE );
553978d1d225Sdrh       /* The y.pTab=0 assignment in wherecode.c always happens after the
554078d1d225Sdrh       ** impliesNotNullRow() test */
554178d1d225Sdrh       if( (pLeft->op==TK_COLUMN && ALWAYS(pLeft->y.pTab!=0)
554278d1d225Sdrh                                && IsVirtual(pLeft->y.pTab))
554378d1d225Sdrh        || (pRight->op==TK_COLUMN && ALWAYS(pRight->y.pTab!=0)
554478d1d225Sdrh                                && IsVirtual(pRight->y.pTab))
55459881155dSdrh       ){
55469881155dSdrh         return WRC_Prune;
55479881155dSdrh       }
554808b92086Sdrh       /* no break */ deliberate_fall_through
554978d1d225Sdrh     }
55502589787cSdrh     default:
55512589787cSdrh       return WRC_Continue;
55522589787cSdrh   }
55532589787cSdrh }
55542589787cSdrh 
55552589787cSdrh /*
55562589787cSdrh ** Return true (non-zero) if expression p can only be true if at least
55572589787cSdrh ** one column of table iTab is non-null.  In other words, return true
55582589787cSdrh ** if expression p will always be NULL or false if every column of iTab
55592589787cSdrh ** is NULL.
55602589787cSdrh **
5561821b610bSdrh ** False negatives are acceptable.  In other words, it is ok to return
5562821b610bSdrh ** zero even if expression p will never be true of every column of iTab
5563821b610bSdrh ** is NULL.  A false negative is merely a missed optimization opportunity.
5564821b610bSdrh **
5565821b610bSdrh ** False positives are not allowed, however.  A false positive may result
5566821b610bSdrh ** in an incorrect answer.
5567821b610bSdrh **
55682589787cSdrh ** Terms of p that are marked with EP_FromJoin (and hence that come from
55692589787cSdrh ** the ON or USING clauses of LEFT JOINS) are excluded from the analysis.
55702589787cSdrh **
55712589787cSdrh ** This routine is used to check if a LEFT JOIN can be converted into
55722589787cSdrh ** an ordinary JOIN.  The p argument is the WHERE clause.  If the WHERE
55732589787cSdrh ** clause requires that some column of the right table of the LEFT JOIN
55742589787cSdrh ** be non-NULL, then the LEFT JOIN can be safely converted into an
55752589787cSdrh ** ordinary join.
55762589787cSdrh */
55772589787cSdrh int sqlite3ExprImpliesNonNullRow(Expr *p, int iTab){
55782589787cSdrh   Walker w;
55790d950af3Sdrh   p = sqlite3ExprSkipCollateAndLikely(p);
55804a254f98Sdrh   if( p==0 ) return 0;
55814a254f98Sdrh   if( p->op==TK_NOTNULL ){
5582d6db6598Sdrh     p = p->pLeft;
5583a1698993Sdrh   }else{
5584a1698993Sdrh     while( p->op==TK_AND ){
55854a254f98Sdrh       if( sqlite3ExprImpliesNonNullRow(p->pLeft, iTab) ) return 1;
55864a254f98Sdrh       p = p->pRight;
5587d6db6598Sdrh     }
5588a1698993Sdrh   }
55892589787cSdrh   w.xExprCallback = impliesNotNullRow;
55902589787cSdrh   w.xSelectCallback = 0;
55912589787cSdrh   w.xSelectCallback2 = 0;
55922589787cSdrh   w.eCode = 0;
55932589787cSdrh   w.u.iCur = iTab;
55942589787cSdrh   sqlite3WalkExpr(&w, p);
55952589787cSdrh   return w.eCode;
55962589787cSdrh }
55972589787cSdrh 
55982589787cSdrh /*
5599030796dfSdrh ** An instance of the following structure is used by the tree walker
56002409f8a1Sdrh ** to determine if an expression can be evaluated by reference to the
56012409f8a1Sdrh ** index only, without having to do a search for the corresponding
56022409f8a1Sdrh ** table entry.  The IdxCover.pIdx field is the index.  IdxCover.iCur
56032409f8a1Sdrh ** is the cursor for the table.
56042409f8a1Sdrh */
56052409f8a1Sdrh struct IdxCover {
56062409f8a1Sdrh   Index *pIdx;     /* The index to be tested for coverage */
56072409f8a1Sdrh   int iCur;        /* Cursor number for the table corresponding to the index */
56082409f8a1Sdrh };
56092409f8a1Sdrh 
56102409f8a1Sdrh /*
56112409f8a1Sdrh ** Check to see if there are references to columns in table
56122409f8a1Sdrh ** pWalker->u.pIdxCover->iCur can be satisfied using the index
56132409f8a1Sdrh ** pWalker->u.pIdxCover->pIdx.
56142409f8a1Sdrh */
56152409f8a1Sdrh static int exprIdxCover(Walker *pWalker, Expr *pExpr){
56162409f8a1Sdrh   if( pExpr->op==TK_COLUMN
56172409f8a1Sdrh    && pExpr->iTable==pWalker->u.pIdxCover->iCur
5618b9bcf7caSdrh    && sqlite3TableColumnToIndex(pWalker->u.pIdxCover->pIdx, pExpr->iColumn)<0
56192409f8a1Sdrh   ){
56202409f8a1Sdrh     pWalker->eCode = 1;
56212409f8a1Sdrh     return WRC_Abort;
56222409f8a1Sdrh   }
56232409f8a1Sdrh   return WRC_Continue;
56242409f8a1Sdrh }
56252409f8a1Sdrh 
56262409f8a1Sdrh /*
5627e604ec0bSdrh ** Determine if an index pIdx on table with cursor iCur contains will
5628e604ec0bSdrh ** the expression pExpr.  Return true if the index does cover the
5629e604ec0bSdrh ** expression and false if the pExpr expression references table columns
5630e604ec0bSdrh ** that are not found in the index pIdx.
56312409f8a1Sdrh **
56322409f8a1Sdrh ** An index covering an expression means that the expression can be
56332409f8a1Sdrh ** evaluated using only the index and without having to lookup the
56342409f8a1Sdrh ** corresponding table entry.
56352409f8a1Sdrh */
56362409f8a1Sdrh int sqlite3ExprCoveredByIndex(
56372409f8a1Sdrh   Expr *pExpr,        /* The index to be tested */
56382409f8a1Sdrh   int iCur,           /* The cursor number for the corresponding table */
56392409f8a1Sdrh   Index *pIdx         /* The index that might be used for coverage */
56402409f8a1Sdrh ){
56412409f8a1Sdrh   Walker w;
56422409f8a1Sdrh   struct IdxCover xcov;
56432409f8a1Sdrh   memset(&w, 0, sizeof(w));
56442409f8a1Sdrh   xcov.iCur = iCur;
56452409f8a1Sdrh   xcov.pIdx = pIdx;
56462409f8a1Sdrh   w.xExprCallback = exprIdxCover;
56472409f8a1Sdrh   w.u.pIdxCover = &xcov;
56482409f8a1Sdrh   sqlite3WalkExpr(&w, pExpr);
56492409f8a1Sdrh   return !w.eCode;
56502409f8a1Sdrh }
56512409f8a1Sdrh 
56522409f8a1Sdrh 
56532409f8a1Sdrh /*
56542409f8a1Sdrh ** An instance of the following structure is used by the tree walker
5655030796dfSdrh ** to count references to table columns in the arguments of an
5656ed551b95Sdrh ** aggregate function, in order to implement the
5657ed551b95Sdrh ** sqlite3FunctionThisSrc() routine.
5658374fdce4Sdrh */
5659030796dfSdrh struct SrcCount {
5660030796dfSdrh   SrcList *pSrc;   /* One particular FROM clause in a nested query */
5661ed41a96bSdan   int iSrcInner;   /* Smallest cursor number in this context */
5662030796dfSdrh   int nThis;       /* Number of references to columns in pSrcList */
5663030796dfSdrh   int nOther;      /* Number of references to columns in other FROM clauses */
5664030796dfSdrh };
5665030796dfSdrh 
5666030796dfSdrh /*
5667ed41a96bSdan ** xSelect callback for sqlite3FunctionUsesThisSrc(). If this is the first
5668ed41a96bSdan ** SELECT with a FROM clause encountered during this iteration, set
5669ed41a96bSdan ** SrcCount.iSrcInner to the cursor number of the leftmost object in
5670ed41a96bSdan ** the FROM cause.
5671ed41a96bSdan */
5672ed41a96bSdan static int selectSrcCount(Walker *pWalker, Select *pSel){
5673ed41a96bSdan   struct SrcCount *p = pWalker->u.pSrcCount;
5674bc050b8fSdrh   if( p->iSrcInner==0x7FFFFFFF && ALWAYS(pSel->pSrc) && pSel->pSrc->nSrc ){
5675ed41a96bSdan     pWalker->u.pSrcCount->iSrcInner = pSel->pSrc->a[0].iCursor;
5676ed41a96bSdan   }
5677ed41a96bSdan   return WRC_Continue;
5678ed41a96bSdan }
5679ed41a96bSdan 
5680ed41a96bSdan /*
5681030796dfSdrh ** Count the number of references to columns.
5682030796dfSdrh */
5683030796dfSdrh static int exprSrcCount(Walker *pWalker, Expr *pExpr){
5684b4b36306Sdan   /* There was once a NEVER() on the second term on the grounds that
5685b4b36306Sdan   ** sqlite3FunctionUsesThisSrc() was always called before
5686b4b36306Sdan   ** sqlite3ExprAnalyzeAggregates() and so the TK_COLUMNs have not yet
5687b4b36306Sdan   ** been converted into TK_AGG_COLUMN. But this is no longer true due
5688b4b36306Sdan   ** to window functions - sqlite3WindowRewrite() may now indirectly call
5689b4b36306Sdan   ** FunctionUsesThisSrc() when creating a new sub-select. */
5690b4b36306Sdan   if( pExpr->op==TK_COLUMN || pExpr->op==TK_AGG_COLUMN ){
5691374fdce4Sdrh     int i;
5692030796dfSdrh     struct SrcCount *p = pWalker->u.pSrcCount;
5693030796dfSdrh     SrcList *pSrc = p->pSrc;
5694655814d2Sdrh     int nSrc = pSrc ? pSrc->nSrc : 0;
5695655814d2Sdrh     for(i=0; i<nSrc; i++){
5696030796dfSdrh       if( pExpr->iTable==pSrc->a[i].iCursor ) break;
5697374fdce4Sdrh     }
5698655814d2Sdrh     if( i<nSrc ){
5699030796dfSdrh       p->nThis++;
5700ed41a96bSdan     }else if( pExpr->iTable<p->iSrcInner ){
570180f6bfc0Sdrh       /* In a well-formed parse tree (no name resolution errors),
570235a38e08Sdrh       ** TK_COLUMN nodes with smaller Expr.iTable values are in an
570380f6bfc0Sdrh       ** outer context.  Those are the only ones to count as "other" */
5704030796dfSdrh       p->nOther++;
5705374fdce4Sdrh     }
5706374fdce4Sdrh   }
5707030796dfSdrh   return WRC_Continue;
5708030796dfSdrh }
5709374fdce4Sdrh 
5710374fdce4Sdrh /*
5711030796dfSdrh ** Determine if any of the arguments to the pExpr Function reference
5712030796dfSdrh ** pSrcList.  Return true if they do.  Also return true if the function
5713030796dfSdrh ** has no arguments or has only constant arguments.  Return false if pExpr
5714030796dfSdrh ** references columns but not columns of tables found in pSrcList.
5715374fdce4Sdrh */
5716030796dfSdrh int sqlite3FunctionUsesThisSrc(Expr *pExpr, SrcList *pSrcList){
5717374fdce4Sdrh   Walker w;
5718030796dfSdrh   struct SrcCount cnt;
5719374fdce4Sdrh   assert( pExpr->op==TK_AGG_FUNCTION );
572080f6bfc0Sdrh   memset(&w, 0, sizeof(w));
5721030796dfSdrh   w.xExprCallback = exprSrcCount;
5722ed41a96bSdan   w.xSelectCallback = selectSrcCount;
5723030796dfSdrh   w.u.pSrcCount = &cnt;
5724030796dfSdrh   cnt.pSrc = pSrcList;
5725ed41a96bSdan   cnt.iSrcInner = (pSrcList&&pSrcList->nSrc)?pSrcList->a[0].iCursor:0x7FFFFFFF;
5726030796dfSdrh   cnt.nThis = 0;
5727030796dfSdrh   cnt.nOther = 0;
5728030796dfSdrh   sqlite3WalkExprList(&w, pExpr->x.pList);
57295e484cb3Sdan #ifndef SQLITE_OMIT_WINDOWFUNC
57305e484cb3Sdan   if( ExprHasProperty(pExpr, EP_WinFunc) ){
57315e484cb3Sdan     sqlite3WalkExpr(&w, pExpr->y.pWin->pFilter);
57325e484cb3Sdan   }
57335e484cb3Sdan #endif
5734030796dfSdrh   return cnt.nThis>0 || cnt.nOther==0;
5735374fdce4Sdrh }
5736374fdce4Sdrh 
5737374fdce4Sdrh /*
573889636628Sdrh ** This is a Walker expression node callback.
573989636628Sdrh **
574089636628Sdrh ** For Expr nodes that contain pAggInfo pointers, make sure the AggInfo
574189636628Sdrh ** object that is referenced does not refer directly to the Expr.  If
574289636628Sdrh ** it does, make a copy.  This is done because the pExpr argument is
574389636628Sdrh ** subject to change.
574489636628Sdrh **
574589636628Sdrh ** The copy is stored on pParse->pConstExpr with a register number of 0.
574689636628Sdrh ** This will cause the expression to be deleted automatically when the
574789636628Sdrh ** Parse object is destroyed, but the zero register number means that it
574889636628Sdrh ** will not generate any code in the preamble.
574989636628Sdrh */
575089636628Sdrh static int agginfoPersistExprCb(Walker *pWalker, Expr *pExpr){
57512f82acc0Sdrh   if( ALWAYS(!ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced))
575289636628Sdrh    && pExpr->pAggInfo!=0
575389636628Sdrh   ){
575489636628Sdrh     AggInfo *pAggInfo = pExpr->pAggInfo;
575589636628Sdrh     int iAgg = pExpr->iAgg;
575689636628Sdrh     Parse *pParse = pWalker->pParse;
575789636628Sdrh     sqlite3 *db = pParse->db;
57582f82acc0Sdrh     assert( pExpr->op==TK_AGG_COLUMN || pExpr->op==TK_AGG_FUNCTION );
57592f82acc0Sdrh     if( pExpr->op==TK_AGG_COLUMN ){
576089636628Sdrh       assert( iAgg>=0 && iAgg<pAggInfo->nColumn );
576181185a51Sdrh       if( pAggInfo->aCol[iAgg].pCExpr==pExpr ){
576289636628Sdrh         pExpr = sqlite3ExprDup(db, pExpr, 0);
576389636628Sdrh         if( pExpr ){
576481185a51Sdrh           pAggInfo->aCol[iAgg].pCExpr = pExpr;
576589636628Sdrh           pParse->pConstExpr =
576689636628Sdrh              sqlite3ExprListAppend(pParse, pParse->pConstExpr, pExpr);
576789636628Sdrh         }
576889636628Sdrh       }
576989636628Sdrh     }else{
577089636628Sdrh       assert( iAgg>=0 && iAgg<pAggInfo->nFunc );
577181185a51Sdrh       if( pAggInfo->aFunc[iAgg].pFExpr==pExpr ){
577289636628Sdrh         pExpr = sqlite3ExprDup(db, pExpr, 0);
577389636628Sdrh         if( pExpr ){
577481185a51Sdrh           pAggInfo->aFunc[iAgg].pFExpr = pExpr;
577589636628Sdrh           pParse->pConstExpr =
577689636628Sdrh              sqlite3ExprListAppend(pParse, pParse->pConstExpr, pExpr);
577789636628Sdrh         }
577889636628Sdrh       }
577989636628Sdrh     }
578089636628Sdrh   }
578189636628Sdrh   return WRC_Continue;
578289636628Sdrh }
578389636628Sdrh 
578489636628Sdrh /*
578589636628Sdrh ** Initialize a Walker object so that will persist AggInfo entries referenced
578689636628Sdrh ** by the tree that is walked.
578789636628Sdrh */
578889636628Sdrh void sqlite3AggInfoPersistWalkerInit(Walker *pWalker, Parse *pParse){
578989636628Sdrh   memset(pWalker, 0, sizeof(*pWalker));
579089636628Sdrh   pWalker->pParse = pParse;
579189636628Sdrh   pWalker->xExprCallback = agginfoPersistExprCb;
579289636628Sdrh   pWalker->xSelectCallback = sqlite3SelectWalkNoop;
579389636628Sdrh }
579489636628Sdrh 
579589636628Sdrh /*
579613449892Sdrh ** Add a new element to the pAggInfo->aCol[] array.  Return the index of
579713449892Sdrh ** the new element.  Return a negative number if malloc fails.
57982282792aSdrh */
579917435752Sdrh static int addAggInfoColumn(sqlite3 *db, AggInfo *pInfo){
580013449892Sdrh   int i;
5801cf643729Sdrh   pInfo->aCol = sqlite3ArrayAllocate(
580217435752Sdrh        db,
5803cf643729Sdrh        pInfo->aCol,
5804cf643729Sdrh        sizeof(pInfo->aCol[0]),
5805cf643729Sdrh        &pInfo->nColumn,
5806cf643729Sdrh        &i
5807cf643729Sdrh   );
580813449892Sdrh   return i;
58092282792aSdrh }
581013449892Sdrh 
581113449892Sdrh /*
581213449892Sdrh ** Add a new element to the pAggInfo->aFunc[] array.  Return the index of
581313449892Sdrh ** the new element.  Return a negative number if malloc fails.
581413449892Sdrh */
581517435752Sdrh static int addAggInfoFunc(sqlite3 *db, AggInfo *pInfo){
581613449892Sdrh   int i;
5817cf643729Sdrh   pInfo->aFunc = sqlite3ArrayAllocate(
581817435752Sdrh        db,
5819cf643729Sdrh        pInfo->aFunc,
5820cf643729Sdrh        sizeof(pInfo->aFunc[0]),
5821cf643729Sdrh        &pInfo->nFunc,
5822cf643729Sdrh        &i
5823cf643729Sdrh   );
582413449892Sdrh   return i;
58252282792aSdrh }
58262282792aSdrh 
58272282792aSdrh /*
58287d10d5a6Sdrh ** This is the xExprCallback for a tree walker.  It is used to
58297d10d5a6Sdrh ** implement sqlite3ExprAnalyzeAggregates().  See sqlite3ExprAnalyzeAggregates
5830626a879aSdrh ** for additional information.
58312282792aSdrh */
58327d10d5a6Sdrh static int analyzeAggregate(Walker *pWalker, Expr *pExpr){
58332282792aSdrh   int i;
58347d10d5a6Sdrh   NameContext *pNC = pWalker->u.pNC;
5835a58fdfb1Sdanielk1977   Parse *pParse = pNC->pParse;
5836a58fdfb1Sdanielk1977   SrcList *pSrcList = pNC->pSrcList;
583725c3b8caSdrh   AggInfo *pAggInfo = pNC->uNC.pAggInfo;
583813449892Sdrh 
583925c3b8caSdrh   assert( pNC->ncFlags & NC_UAggInfo );
58402282792aSdrh   switch( pExpr->op ){
584189c69d00Sdrh     case TK_AGG_COLUMN:
5842967e8b73Sdrh     case TK_COLUMN: {
58438b213899Sdrh       testcase( pExpr->op==TK_AGG_COLUMN );
58448b213899Sdrh       testcase( pExpr->op==TK_COLUMN );
584513449892Sdrh       /* Check to see if the column is in one of the tables in the FROM
584613449892Sdrh       ** clause of the aggregate query */
584720bc393cSdrh       if( ALWAYS(pSrcList!=0) ){
584813449892Sdrh         struct SrcList_item *pItem = pSrcList->a;
584913449892Sdrh         for(i=0; i<pSrcList->nSrc; i++, pItem++){
585013449892Sdrh           struct AggInfo_col *pCol;
5851c5cd1249Sdrh           assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
585213449892Sdrh           if( pExpr->iTable==pItem->iCursor ){
585313449892Sdrh             /* If we reach this point, it means that pExpr refers to a table
585413449892Sdrh             ** that is in the FROM clause of the aggregate query.
585513449892Sdrh             **
585613449892Sdrh             ** Make an entry for the column in pAggInfo->aCol[] if there
585713449892Sdrh             ** is not an entry there already.
585813449892Sdrh             */
58597f906d63Sdrh             int k;
586013449892Sdrh             pCol = pAggInfo->aCol;
58617f906d63Sdrh             for(k=0; k<pAggInfo->nColumn; k++, pCol++){
586213449892Sdrh               if( pCol->iTable==pExpr->iTable &&
586313449892Sdrh                   pCol->iColumn==pExpr->iColumn ){
58642282792aSdrh                 break;
58652282792aSdrh               }
58662282792aSdrh             }
58671e536953Sdanielk1977             if( (k>=pAggInfo->nColumn)
58681e536953Sdanielk1977              && (k = addAggInfoColumn(pParse->db, pAggInfo))>=0
58691e536953Sdanielk1977             ){
58707f906d63Sdrh               pCol = &pAggInfo->aCol[k];
5871eda079cdSdrh               pCol->pTab = pExpr->y.pTab;
587213449892Sdrh               pCol->iTable = pExpr->iTable;
587313449892Sdrh               pCol->iColumn = pExpr->iColumn;
58740a07c107Sdrh               pCol->iMem = ++pParse->nMem;
587513449892Sdrh               pCol->iSorterColumn = -1;
587681185a51Sdrh               pCol->pCExpr = pExpr;
587713449892Sdrh               if( pAggInfo->pGroupBy ){
587813449892Sdrh                 int j, n;
587913449892Sdrh                 ExprList *pGB = pAggInfo->pGroupBy;
588013449892Sdrh                 struct ExprList_item *pTerm = pGB->a;
588113449892Sdrh                 n = pGB->nExpr;
588213449892Sdrh                 for(j=0; j<n; j++, pTerm++){
588313449892Sdrh                   Expr *pE = pTerm->pExpr;
588413449892Sdrh                   if( pE->op==TK_COLUMN && pE->iTable==pExpr->iTable &&
588513449892Sdrh                       pE->iColumn==pExpr->iColumn ){
588613449892Sdrh                     pCol->iSorterColumn = j;
588713449892Sdrh                     break;
58882282792aSdrh                   }
588913449892Sdrh                 }
589013449892Sdrh               }
589113449892Sdrh               if( pCol->iSorterColumn<0 ){
589213449892Sdrh                 pCol->iSorterColumn = pAggInfo->nSortingColumn++;
589313449892Sdrh               }
589413449892Sdrh             }
589513449892Sdrh             /* There is now an entry for pExpr in pAggInfo->aCol[] (either
589613449892Sdrh             ** because it was there before or because we just created it).
589713449892Sdrh             ** Convert the pExpr to be a TK_AGG_COLUMN referring to that
589813449892Sdrh             ** pAggInfo->aCol[] entry.
589913449892Sdrh             */
5900ebb6a65dSdrh             ExprSetVVAProperty(pExpr, EP_NoReduce);
590113449892Sdrh             pExpr->pAggInfo = pAggInfo;
590213449892Sdrh             pExpr->op = TK_AGG_COLUMN;
5903cf697396Sshane             pExpr->iAgg = (i16)k;
590413449892Sdrh             break;
590513449892Sdrh           } /* endif pExpr->iTable==pItem->iCursor */
590613449892Sdrh         } /* end loop over pSrcList */
5907a58fdfb1Sdanielk1977       }
59087d10d5a6Sdrh       return WRC_Prune;
59092282792aSdrh     }
59102282792aSdrh     case TK_AGG_FUNCTION: {
59113a8c4be7Sdrh       if( (pNC->ncFlags & NC_InAggFunc)==0
5912ed551b95Sdrh        && pWalker->walkerDepth==pExpr->op2
59133a8c4be7Sdrh       ){
591413449892Sdrh         /* Check to see if pExpr is a duplicate of another aggregate
591513449892Sdrh         ** function that is already in the pAggInfo structure
591613449892Sdrh         */
591713449892Sdrh         struct AggInfo_func *pItem = pAggInfo->aFunc;
591813449892Sdrh         for(i=0; i<pAggInfo->nFunc; i++, pItem++){
591981185a51Sdrh           if( sqlite3ExprCompare(0, pItem->pFExpr, pExpr, -1)==0 ){
59202282792aSdrh             break;
59212282792aSdrh           }
59222282792aSdrh         }
592313449892Sdrh         if( i>=pAggInfo->nFunc ){
592413449892Sdrh           /* pExpr is original.  Make a new entry in pAggInfo->aFunc[]
592513449892Sdrh           */
592614db2665Sdanielk1977           u8 enc = ENC(pParse->db);
59271e536953Sdanielk1977           i = addAggInfoFunc(pParse->db, pAggInfo);
592813449892Sdrh           if( i>=0 ){
59296ab3a2ecSdanielk1977             assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
593013449892Sdrh             pItem = &pAggInfo->aFunc[i];
593181185a51Sdrh             pItem->pFExpr = pExpr;
59320a07c107Sdrh             pItem->iMem = ++pParse->nMem;
593333e619fcSdrh             assert( !ExprHasProperty(pExpr, EP_IntValue) );
593413449892Sdrh             pItem->pFunc = sqlite3FindFunction(pParse->db,
593580738d9cSdrh                    pExpr->u.zToken,
59366ab3a2ecSdanielk1977                    pExpr->x.pList ? pExpr->x.pList->nExpr : 0, enc, 0);
5937fd357974Sdrh             if( pExpr->flags & EP_Distinct ){
5938fd357974Sdrh               pItem->iDistinct = pParse->nTab++;
5939fd357974Sdrh             }else{
5940fd357974Sdrh               pItem->iDistinct = -1;
5941fd357974Sdrh             }
59422282792aSdrh           }
594313449892Sdrh         }
594413449892Sdrh         /* Make pExpr point to the appropriate pAggInfo->aFunc[] entry
594513449892Sdrh         */
5946c5cd1249Sdrh         assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
5947ebb6a65dSdrh         ExprSetVVAProperty(pExpr, EP_NoReduce);
5948cf697396Sshane         pExpr->iAgg = (i16)i;
594913449892Sdrh         pExpr->pAggInfo = pAggInfo;
59503a8c4be7Sdrh         return WRC_Prune;
59516e83a57fSdrh       }else{
59526e83a57fSdrh         return WRC_Continue;
59536e83a57fSdrh       }
59542282792aSdrh     }
5955a58fdfb1Sdanielk1977   }
59567d10d5a6Sdrh   return WRC_Continue;
59577d10d5a6Sdrh }
5958626a879aSdrh 
5959626a879aSdrh /*
5960e8abb4caSdrh ** Analyze the pExpr expression looking for aggregate functions and
5961e8abb4caSdrh ** for variables that need to be added to AggInfo object that pNC->pAggInfo
5962e8abb4caSdrh ** points to.  Additional entries are made on the AggInfo object as
5963e8abb4caSdrh ** necessary.
5964626a879aSdrh **
5965626a879aSdrh ** This routine should only be called after the expression has been
59667d10d5a6Sdrh ** analyzed by sqlite3ResolveExprNames().
5967626a879aSdrh */
5968d2b3e23bSdrh void sqlite3ExprAnalyzeAggregates(NameContext *pNC, Expr *pExpr){
59697d10d5a6Sdrh   Walker w;
59707d10d5a6Sdrh   w.xExprCallback = analyzeAggregate;
5971e40cc16bSdrh   w.xSelectCallback = sqlite3WalkerDepthIncrease;
5972e40cc16bSdrh   w.xSelectCallback2 = sqlite3WalkerDepthDecrease;
5973979dd1beSdrh   w.walkerDepth = 0;
59747d10d5a6Sdrh   w.u.pNC = pNC;
5975d9995031Sdan   w.pParse = 0;
597620bc393cSdrh   assert( pNC->pSrcList!=0 );
59777d10d5a6Sdrh   sqlite3WalkExpr(&w, pExpr);
59782282792aSdrh }
59795d9a4af9Sdrh 
59805d9a4af9Sdrh /*
59815d9a4af9Sdrh ** Call sqlite3ExprAnalyzeAggregates() for every expression in an
59825d9a4af9Sdrh ** expression list.  Return the number of errors.
59835d9a4af9Sdrh **
59845d9a4af9Sdrh ** If an error is found, the analysis is cut short.
59855d9a4af9Sdrh */
5986d2b3e23bSdrh void sqlite3ExprAnalyzeAggList(NameContext *pNC, ExprList *pList){
59875d9a4af9Sdrh   struct ExprList_item *pItem;
59885d9a4af9Sdrh   int i;
59895d9a4af9Sdrh   if( pList ){
5990d2b3e23bSdrh     for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
5991d2b3e23bSdrh       sqlite3ExprAnalyzeAggregates(pNC, pItem->pExpr);
59925d9a4af9Sdrh     }
59935d9a4af9Sdrh   }
59945d9a4af9Sdrh }
5995892d3179Sdrh 
5996892d3179Sdrh /*
5997ceea3321Sdrh ** Allocate a single new register for use to hold some intermediate result.
5998892d3179Sdrh */
5999892d3179Sdrh int sqlite3GetTempReg(Parse *pParse){
6000e55cbd72Sdrh   if( pParse->nTempReg==0 ){
6001892d3179Sdrh     return ++pParse->nMem;
6002892d3179Sdrh   }
60032f425f6bSdanielk1977   return pParse->aTempReg[--pParse->nTempReg];
6004892d3179Sdrh }
6005ceea3321Sdrh 
6006ceea3321Sdrh /*
6007ceea3321Sdrh ** Deallocate a register, making available for reuse for some other
6008ceea3321Sdrh ** purpose.
6009ceea3321Sdrh */
6010892d3179Sdrh void sqlite3ReleaseTempReg(Parse *pParse, int iReg){
601113d79502Sdrh   if( iReg ){
60123aef2fb1Sdrh     sqlite3VdbeReleaseRegisters(pParse, iReg, 1, 0, 0);
601313d79502Sdrh     if( pParse->nTempReg<ArraySize(pParse->aTempReg) ){
6014892d3179Sdrh       pParse->aTempReg[pParse->nTempReg++] = iReg;
6015892d3179Sdrh     }
6016892d3179Sdrh   }
601713d79502Sdrh }
6018892d3179Sdrh 
6019892d3179Sdrh /*
6020ed24da4bSdrh ** Allocate or deallocate a block of nReg consecutive registers.
6021892d3179Sdrh */
6022892d3179Sdrh int sqlite3GetTempRange(Parse *pParse, int nReg){
6023e55cbd72Sdrh   int i, n;
6024ed24da4bSdrh   if( nReg==1 ) return sqlite3GetTempReg(pParse);
6025892d3179Sdrh   i = pParse->iRangeReg;
6026e55cbd72Sdrh   n = pParse->nRangeReg;
6027f49f3523Sdrh   if( nReg<=n ){
6028892d3179Sdrh     pParse->iRangeReg += nReg;
6029892d3179Sdrh     pParse->nRangeReg -= nReg;
6030892d3179Sdrh   }else{
6031892d3179Sdrh     i = pParse->nMem+1;
6032892d3179Sdrh     pParse->nMem += nReg;
6033892d3179Sdrh   }
6034892d3179Sdrh   return i;
6035892d3179Sdrh }
6036892d3179Sdrh void sqlite3ReleaseTempRange(Parse *pParse, int iReg, int nReg){
6037ed24da4bSdrh   if( nReg==1 ){
6038ed24da4bSdrh     sqlite3ReleaseTempReg(pParse, iReg);
6039ed24da4bSdrh     return;
6040ed24da4bSdrh   }
60413aef2fb1Sdrh   sqlite3VdbeReleaseRegisters(pParse, iReg, nReg, 0, 0);
6042892d3179Sdrh   if( nReg>pParse->nRangeReg ){
6043892d3179Sdrh     pParse->nRangeReg = nReg;
6044892d3179Sdrh     pParse->iRangeReg = iReg;
6045892d3179Sdrh   }
6046892d3179Sdrh }
6047cdc69557Sdrh 
6048cdc69557Sdrh /*
6049cdc69557Sdrh ** Mark all temporary registers as being unavailable for reuse.
60506d2566dfSdrh **
60516d2566dfSdrh ** Always invoke this procedure after coding a subroutine or co-routine
60526d2566dfSdrh ** that might be invoked from other parts of the code, to ensure that
60536d2566dfSdrh ** the sub/co-routine does not use registers in common with the code that
60546d2566dfSdrh ** invokes the sub/co-routine.
6055cdc69557Sdrh */
6056cdc69557Sdrh void sqlite3ClearTempRegCache(Parse *pParse){
6057cdc69557Sdrh   pParse->nTempReg = 0;
6058cdc69557Sdrh   pParse->nRangeReg = 0;
6059cdc69557Sdrh }
6060bb9b5f26Sdrh 
6061bb9b5f26Sdrh /*
6062bb9b5f26Sdrh ** Validate that no temporary register falls within the range of
6063bb9b5f26Sdrh ** iFirst..iLast, inclusive.  This routine is only call from within assert()
6064bb9b5f26Sdrh ** statements.
6065bb9b5f26Sdrh */
6066bb9b5f26Sdrh #ifdef SQLITE_DEBUG
6067bb9b5f26Sdrh int sqlite3NoTempsInRange(Parse *pParse, int iFirst, int iLast){
6068bb9b5f26Sdrh   int i;
6069bb9b5f26Sdrh   if( pParse->nRangeReg>0
60703963e584Sdrh    && pParse->iRangeReg+pParse->nRangeReg > iFirst
60713963e584Sdrh    && pParse->iRangeReg <= iLast
6072bb9b5f26Sdrh   ){
6073bb9b5f26Sdrh      return 0;
6074bb9b5f26Sdrh   }
6075bb9b5f26Sdrh   for(i=0; i<pParse->nTempReg; i++){
6076bb9b5f26Sdrh     if( pParse->aTempReg[i]>=iFirst && pParse->aTempReg[i]<=iLast ){
6077bb9b5f26Sdrh       return 0;
6078bb9b5f26Sdrh     }
6079bb9b5f26Sdrh   }
6080bb9b5f26Sdrh   return 1;
6081bb9b5f26Sdrh }
6082bb9b5f26Sdrh #endif /* SQLITE_DEBUG */
6083