xref: /sqlite-3.40.0/src/expr.c (revision 4f9adee2)
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 */
45bf3b721fSdanielk1977 char sqlite3ExprAffinity(Expr *pExpr){
46580c8c18Sdrh   int op;
479bec6fb3Smistachkin   if( pExpr->flags & EP_Generic ) return 0;
48a7d6db6aSdrh   while( ExprHasProperty(pExpr, EP_Skip) ){
49a7d6db6aSdrh     assert( pExpr->op==TK_COLLATE );
50a7d6db6aSdrh     pExpr = pExpr->pLeft;
51a7d6db6aSdrh     assert( pExpr!=0 );
52a7d6db6aSdrh   }
53580c8c18Sdrh   op = pExpr->op;
54487e262fSdrh   if( op==TK_SELECT ){
556ab3a2ecSdanielk1977     assert( pExpr->flags&EP_xIsSelect );
566ab3a2ecSdanielk1977     return sqlite3ExprAffinity(pExpr->x.pSelect->pEList->a[0].pExpr);
57a37cdde0Sdanielk1977   }
58db45bd5eSdrh   if( op==TK_REGISTER ) op = pExpr->op2;
59487e262fSdrh #ifndef SQLITE_OMIT_CAST
60487e262fSdrh   if( op==TK_CAST ){
6133e619fcSdrh     assert( !ExprHasProperty(pExpr, EP_IntValue) );
62fdaac671Sdrh     return sqlite3AffinityType(pExpr->u.zToken, 0);
63487e262fSdrh   }
64487e262fSdrh #endif
65eda079cdSdrh   if( (op==TK_AGG_COLUMN || op==TK_COLUMN) && pExpr->y.pTab ){
66eda079cdSdrh     return sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
677d10d5a6Sdrh   }
6880aa5453Sdan   if( op==TK_SELECT_COLUMN ){
6980aa5453Sdan     assert( pExpr->pLeft->flags&EP_xIsSelect );
7080aa5453Sdan     return sqlite3ExprAffinity(
7180aa5453Sdan         pExpr->pLeft->x.pSelect->pEList->a[pExpr->iColumn].pExpr
7280aa5453Sdan     );
7380aa5453Sdan   }
74a37cdde0Sdanielk1977   return pExpr->affinity;
75a37cdde0Sdanielk1977 }
76a37cdde0Sdanielk1977 
7753db1458Sdrh /*
788b4c40d8Sdrh ** Set the collating sequence for expression pExpr to be the collating
79ae80ddeaSdrh ** sequence named by pToken.   Return a pointer to a new Expr node that
80ae80ddeaSdrh ** implements the COLLATE operator.
810a8a406eSdrh **
820a8a406eSdrh ** If a memory allocation error occurs, that fact is recorded in pParse->db
830a8a406eSdrh ** and the pExpr parameter is returned unchanged.
848b4c40d8Sdrh */
854ef7efadSdrh Expr *sqlite3ExprAddCollateToken(
864ef7efadSdrh   Parse *pParse,           /* Parsing context */
874ef7efadSdrh   Expr *pExpr,             /* Add the "COLLATE" clause to this expression */
8880103fc6Sdan   const Token *pCollName,  /* Name of collating sequence */
8980103fc6Sdan   int dequote              /* True to dequote pCollName */
904ef7efadSdrh ){
910a8a406eSdrh   if( pCollName->n>0 ){
9280103fc6Sdan     Expr *pNew = sqlite3ExprAlloc(pParse->db, TK_COLLATE, pCollName, dequote);
93ae80ddeaSdrh     if( pNew ){
94ae80ddeaSdrh       pNew->pLeft = pExpr;
95a4c3c87eSdrh       pNew->flags |= EP_Collate|EP_Skip;
960a8a406eSdrh       pExpr = pNew;
97ae80ddeaSdrh     }
980a8a406eSdrh   }
990a8a406eSdrh   return pExpr;
1000a8a406eSdrh }
1010a8a406eSdrh Expr *sqlite3ExprAddCollateString(Parse *pParse, Expr *pExpr, const char *zC){
1020a8a406eSdrh   Token s;
103261d8a51Sdrh   assert( zC!=0 );
10440aced5cSdrh   sqlite3TokenInit(&s, (char*)zC);
10580103fc6Sdan   return sqlite3ExprAddCollateToken(pParse, pExpr, &s, 0);
1060a8a406eSdrh }
1070a8a406eSdrh 
1080a8a406eSdrh /*
1090b8d255cSdrh ** Skip over any TK_COLLATE operators and any unlikely()
110a4c3c87eSdrh ** or likelihood() function at the root of an expression.
1110a8a406eSdrh */
1120a8a406eSdrh Expr *sqlite3ExprSkipCollate(Expr *pExpr){
113a7d6db6aSdrh   while( pExpr && ExprHasProperty(pExpr, EP_Skip|EP_Unlikely) ){
114a4c3c87eSdrh     if( ExprHasProperty(pExpr, EP_Unlikely) ){
115cca9f3d2Sdrh       assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
116cca9f3d2Sdrh       assert( pExpr->x.pList->nExpr>0 );
117a4c3c87eSdrh       assert( pExpr->op==TK_FUNCTION );
118cca9f3d2Sdrh       pExpr = pExpr->x.pList->a[0].pExpr;
119cca9f3d2Sdrh     }else{
1200b8d255cSdrh       assert( pExpr->op==TK_COLLATE );
121d91eba96Sdrh       pExpr = pExpr->pLeft;
122cca9f3d2Sdrh     }
123d91eba96Sdrh   }
1240a8a406eSdrh   return pExpr;
1258b4c40d8Sdrh }
1268b4c40d8Sdrh 
1278b4c40d8Sdrh /*
128ae80ddeaSdrh ** Return the collation sequence for the expression pExpr. If
129ae80ddeaSdrh ** there is no defined collating sequence, return NULL.
130ae80ddeaSdrh **
13170efa84dSdrh ** See also: sqlite3ExprNNCollSeq()
13270efa84dSdrh **
13370efa84dSdrh ** The sqlite3ExprNNCollSeq() works the same exact that it returns the
13470efa84dSdrh ** default collation if pExpr has no defined collation.
13570efa84dSdrh **
136ae80ddeaSdrh ** The collating sequence might be determined by a COLLATE operator
137ae80ddeaSdrh ** or by the presence of a column with a defined collating sequence.
138ae80ddeaSdrh ** COLLATE operators take first precedence.  Left operands take
139ae80ddeaSdrh ** precedence over right operands.
1400202b29eSdanielk1977 */
1417cedc8d4Sdanielk1977 CollSeq *sqlite3ExprCollSeq(Parse *pParse, Expr *pExpr){
142ae80ddeaSdrh   sqlite3 *db = pParse->db;
1437cedc8d4Sdanielk1977   CollSeq *pColl = 0;
1447d10d5a6Sdrh   Expr *p = pExpr;
145261d8a51Sdrh   while( p ){
146ae80ddeaSdrh     int op = p->op;
147fbb24d10Sdrh     if( p->flags & EP_Generic ) break;
148cb0e04f9Sdrh     if( op==TK_REGISTER ) op = p->op2;
149cb0e04f9Sdrh     if( (op==TK_AGG_COLUMN || op==TK_COLUMN || op==TK_TRIGGER)
150eda079cdSdrh      && p->y.pTab!=0
151ae80ddeaSdrh     ){
152eda079cdSdrh       /* op==TK_REGISTER && p->y.pTab!=0 happens when pExpr was originally
1537d10d5a6Sdrh       ** a TK_COLUMN but was previously evaluated and cached in a register */
1547d10d5a6Sdrh       int j = p->iColumn;
1557d10d5a6Sdrh       if( j>=0 ){
156eda079cdSdrh         const char *zColl = p->y.pTab->aCol[j].zColl;
157c4a64facSdrh         pColl = sqlite3FindCollSeq(db, ENC(db), zColl, 0);
1580202b29eSdanielk1977       }
1597d10d5a6Sdrh       break;
1607d10d5a6Sdrh     }
161e081d73cSdrh     if( op==TK_CAST || op==TK_UPLUS ){
162e081d73cSdrh       p = p->pLeft;
163e081d73cSdrh       continue;
164e081d73cSdrh     }
165cb0e04f9Sdrh     if( op==TK_COLLATE ){
166e081d73cSdrh       pColl = sqlite3GetCollSeq(pParse, ENC(db), 0, p->u.zToken);
167e081d73cSdrh       break;
168e081d73cSdrh     }
169ae80ddeaSdrh     if( p->flags & EP_Collate ){
1702308ed38Sdrh       if( p->pLeft && (p->pLeft->flags & EP_Collate)!=0 ){
1717d10d5a6Sdrh         p = p->pLeft;
172ae80ddeaSdrh       }else{
1732308ed38Sdrh         Expr *pNext  = p->pRight;
1746728cd91Sdrh         /* The Expr.x union is never used at the same time as Expr.pRight */
1756728cd91Sdrh         assert( p->x.pList==0 || p->pRight==0 );
1766728cd91Sdrh         /* p->flags holds EP_Collate and p->pLeft->flags does not.  And
1776728cd91Sdrh         ** p->x.pSelect cannot.  So if p->x.pLeft exists, it must hold at
1786728cd91Sdrh         ** least one EP_Collate. Thus the following two ALWAYS. */
1796728cd91Sdrh         if( p->x.pList!=0 && ALWAYS(!ExprHasProperty(p, EP_xIsSelect)) ){
1802308ed38Sdrh           int i;
1816728cd91Sdrh           for(i=0; ALWAYS(i<p->x.pList->nExpr); i++){
1822308ed38Sdrh             if( ExprHasProperty(p->x.pList->a[i].pExpr, EP_Collate) ){
1832308ed38Sdrh               pNext = p->x.pList->a[i].pExpr;
1842308ed38Sdrh               break;
1852308ed38Sdrh             }
1862308ed38Sdrh           }
1872308ed38Sdrh         }
1882308ed38Sdrh         p = pNext;
189ae80ddeaSdrh       }
190ae80ddeaSdrh     }else{
191ae80ddeaSdrh       break;
192ae80ddeaSdrh     }
1930202b29eSdanielk1977   }
1947cedc8d4Sdanielk1977   if( sqlite3CheckCollSeq(pParse, pColl) ){
1957cedc8d4Sdanielk1977     pColl = 0;
1967cedc8d4Sdanielk1977   }
1977cedc8d4Sdanielk1977   return pColl;
1980202b29eSdanielk1977 }
1990202b29eSdanielk1977 
2000202b29eSdanielk1977 /*
20170efa84dSdrh ** Return the collation sequence for the expression pExpr. If
20270efa84dSdrh ** there is no defined collating sequence, return a pointer to the
20370efa84dSdrh ** defautl collation sequence.
20470efa84dSdrh **
20570efa84dSdrh ** See also: sqlite3ExprCollSeq()
20670efa84dSdrh **
20770efa84dSdrh ** The sqlite3ExprCollSeq() routine works the same except that it
20870efa84dSdrh ** returns NULL if there is no defined collation.
20970efa84dSdrh */
21070efa84dSdrh CollSeq *sqlite3ExprNNCollSeq(Parse *pParse, Expr *pExpr){
21170efa84dSdrh   CollSeq *p = sqlite3ExprCollSeq(pParse, pExpr);
21270efa84dSdrh   if( p==0 ) p = pParse->db->pDfltColl;
21370efa84dSdrh   assert( p!=0 );
21470efa84dSdrh   return p;
21570efa84dSdrh }
21670efa84dSdrh 
21770efa84dSdrh /*
21870efa84dSdrh ** Return TRUE if the two expressions have equivalent collating sequences.
21970efa84dSdrh */
22070efa84dSdrh int sqlite3ExprCollSeqMatch(Parse *pParse, Expr *pE1, Expr *pE2){
22170efa84dSdrh   CollSeq *pColl1 = sqlite3ExprNNCollSeq(pParse, pE1);
22270efa84dSdrh   CollSeq *pColl2 = sqlite3ExprNNCollSeq(pParse, pE2);
22370efa84dSdrh   return sqlite3StrICmp(pColl1->zName, pColl2->zName)==0;
22470efa84dSdrh }
22570efa84dSdrh 
22670efa84dSdrh /*
227626a879aSdrh ** pExpr is an operand of a comparison operator.  aff2 is the
228626a879aSdrh ** type affinity of the other operand.  This routine returns the
22953db1458Sdrh ** type affinity that should be used for the comparison operator.
23053db1458Sdrh */
231e014a838Sdanielk1977 char sqlite3CompareAffinity(Expr *pExpr, char aff2){
232bf3b721fSdanielk1977   char aff1 = sqlite3ExprAffinity(pExpr);
233e014a838Sdanielk1977   if( aff1 && aff2 ){
2348df447f0Sdrh     /* Both sides of the comparison are columns. If one has numeric
2358df447f0Sdrh     ** affinity, use that. Otherwise use no affinity.
236e014a838Sdanielk1977     */
2378a51256cSdrh     if( sqlite3IsNumericAffinity(aff1) || sqlite3IsNumericAffinity(aff2) ){
238e014a838Sdanielk1977       return SQLITE_AFF_NUMERIC;
239e014a838Sdanielk1977     }else{
24005883a34Sdrh       return SQLITE_AFF_BLOB;
241e014a838Sdanielk1977     }
242e014a838Sdanielk1977   }else if( !aff1 && !aff2 ){
2435f6a87b3Sdrh     /* Neither side of the comparison is a column.  Compare the
2445f6a87b3Sdrh     ** results directly.
245e014a838Sdanielk1977     */
24605883a34Sdrh     return SQLITE_AFF_BLOB;
247e014a838Sdanielk1977   }else{
248e014a838Sdanielk1977     /* One side is a column, the other is not. Use the columns affinity. */
249fe05af87Sdrh     assert( aff1==0 || aff2==0 );
250e014a838Sdanielk1977     return (aff1 + aff2);
251e014a838Sdanielk1977   }
252e014a838Sdanielk1977 }
253e014a838Sdanielk1977 
25453db1458Sdrh /*
25553db1458Sdrh ** pExpr is a comparison operator.  Return the type affinity that should
25653db1458Sdrh ** be applied to both operands prior to doing the comparison.
25753db1458Sdrh */
258e014a838Sdanielk1977 static char comparisonAffinity(Expr *pExpr){
259e014a838Sdanielk1977   char aff;
260e014a838Sdanielk1977   assert( pExpr->op==TK_EQ || pExpr->op==TK_IN || pExpr->op==TK_LT ||
261e014a838Sdanielk1977           pExpr->op==TK_GT || pExpr->op==TK_GE || pExpr->op==TK_LE ||
2626a2fe093Sdrh           pExpr->op==TK_NE || pExpr->op==TK_IS || pExpr->op==TK_ISNOT );
263e014a838Sdanielk1977   assert( pExpr->pLeft );
264bf3b721fSdanielk1977   aff = sqlite3ExprAffinity(pExpr->pLeft);
265e014a838Sdanielk1977   if( pExpr->pRight ){
266e014a838Sdanielk1977     aff = sqlite3CompareAffinity(pExpr->pRight, aff);
2676ab3a2ecSdanielk1977   }else if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2686ab3a2ecSdanielk1977     aff = sqlite3CompareAffinity(pExpr->x.pSelect->pEList->a[0].pExpr, aff);
26913ac46eeSdrh   }else if( aff==0 ){
27005883a34Sdrh     aff = SQLITE_AFF_BLOB;
271e014a838Sdanielk1977   }
272e014a838Sdanielk1977   return aff;
273e014a838Sdanielk1977 }
274e014a838Sdanielk1977 
275e014a838Sdanielk1977 /*
276e014a838Sdanielk1977 ** pExpr is a comparison expression, eg. '=', '<', IN(...) etc.
277e014a838Sdanielk1977 ** idx_affinity is the affinity of an indexed column. Return true
278e014a838Sdanielk1977 ** if the index with affinity idx_affinity may be used to implement
279e014a838Sdanielk1977 ** the comparison in pExpr.
280e014a838Sdanielk1977 */
281e014a838Sdanielk1977 int sqlite3IndexAffinityOk(Expr *pExpr, char idx_affinity){
282e014a838Sdanielk1977   char aff = comparisonAffinity(pExpr);
2838a51256cSdrh   switch( aff ){
28405883a34Sdrh     case SQLITE_AFF_BLOB:
2858a51256cSdrh       return 1;
2868a51256cSdrh     case SQLITE_AFF_TEXT:
2878a51256cSdrh       return idx_affinity==SQLITE_AFF_TEXT;
2888a51256cSdrh     default:
2898a51256cSdrh       return sqlite3IsNumericAffinity(idx_affinity);
2908a51256cSdrh   }
291e014a838Sdanielk1977 }
292e014a838Sdanielk1977 
293a37cdde0Sdanielk1977 /*
29435573356Sdrh ** Return the P5 value that should be used for a binary comparison
295a37cdde0Sdanielk1977 ** opcode (OP_Eq, OP_Ge etc.) used to compare pExpr1 and pExpr2.
296a37cdde0Sdanielk1977 */
29735573356Sdrh static u8 binaryCompareP5(Expr *pExpr1, Expr *pExpr2, int jumpIfNull){
29835573356Sdrh   u8 aff = (char)sqlite3ExprAffinity(pExpr2);
2991bd10f8aSdrh   aff = (u8)sqlite3CompareAffinity(pExpr1, aff) | (u8)jumpIfNull;
30035573356Sdrh   return aff;
301a37cdde0Sdanielk1977 }
302a37cdde0Sdanielk1977 
303a2e00042Sdrh /*
3040202b29eSdanielk1977 ** Return a pointer to the collation sequence that should be used by
3050202b29eSdanielk1977 ** a binary comparison operator comparing pLeft and pRight.
3060202b29eSdanielk1977 **
3070202b29eSdanielk1977 ** If the left hand expression has a collating sequence type, then it is
3080202b29eSdanielk1977 ** used. Otherwise the collation sequence for the right hand expression
3090202b29eSdanielk1977 ** is used, or the default (BINARY) if neither expression has a collating
3100202b29eSdanielk1977 ** type.
311bcbb04e5Sdanielk1977 **
312bcbb04e5Sdanielk1977 ** Argument pRight (but not pLeft) may be a null pointer. In this case,
313bcbb04e5Sdanielk1977 ** it is not considered.
3140202b29eSdanielk1977 */
315bcbb04e5Sdanielk1977 CollSeq *sqlite3BinaryCompareCollSeq(
316bcbb04e5Sdanielk1977   Parse *pParse,
317bcbb04e5Sdanielk1977   Expr *pLeft,
318bcbb04e5Sdanielk1977   Expr *pRight
319bcbb04e5Sdanielk1977 ){
320ec41ddacSdrh   CollSeq *pColl;
321ec41ddacSdrh   assert( pLeft );
322ae80ddeaSdrh   if( pLeft->flags & EP_Collate ){
323ae80ddeaSdrh     pColl = sqlite3ExprCollSeq(pParse, pLeft);
324ae80ddeaSdrh   }else if( pRight && (pRight->flags & EP_Collate)!=0 ){
325ae80ddeaSdrh     pColl = sqlite3ExprCollSeq(pParse, pRight);
326ec41ddacSdrh   }else{
327ec41ddacSdrh     pColl = sqlite3ExprCollSeq(pParse, pLeft);
3280202b29eSdanielk1977     if( !pColl ){
3297cedc8d4Sdanielk1977       pColl = sqlite3ExprCollSeq(pParse, pRight);
3300202b29eSdanielk1977     }
331ec41ddacSdrh   }
3320202b29eSdanielk1977   return pColl;
3330202b29eSdanielk1977 }
3340202b29eSdanielk1977 
3350202b29eSdanielk1977 /*
336be5c89acSdrh ** Generate code for a comparison operator.
337be5c89acSdrh */
338be5c89acSdrh static int codeCompare(
339be5c89acSdrh   Parse *pParse,    /* The parsing (and code generating) context */
340be5c89acSdrh   Expr *pLeft,      /* The left operand */
341be5c89acSdrh   Expr *pRight,     /* The right operand */
342be5c89acSdrh   int opcode,       /* The comparison opcode */
34335573356Sdrh   int in1, int in2, /* Register holding operands */
344be5c89acSdrh   int dest,         /* Jump here if true.  */
345be5c89acSdrh   int jumpIfNull    /* If true, jump if either operand is NULL */
346be5c89acSdrh ){
34735573356Sdrh   int p5;
34835573356Sdrh   int addr;
34935573356Sdrh   CollSeq *p4;
35035573356Sdrh 
35135573356Sdrh   p4 = sqlite3BinaryCompareCollSeq(pParse, pLeft, pRight);
35235573356Sdrh   p5 = binaryCompareP5(pLeft, pRight, jumpIfNull);
35335573356Sdrh   addr = sqlite3VdbeAddOp4(pParse->pVdbe, opcode, in2, dest, in1,
35435573356Sdrh                            (void*)p4, P4_COLLSEQ);
3551bd10f8aSdrh   sqlite3VdbeChangeP5(pParse->pVdbe, (u8)p5);
35635573356Sdrh   return addr;
357be5c89acSdrh }
358be5c89acSdrh 
359cfbb5e82Sdan /*
360870a0705Sdan ** Return true if expression pExpr is a vector, or false otherwise.
361d832da7fSdrh **
362d832da7fSdrh ** A vector is defined as any expression that results in two or more
363d832da7fSdrh ** columns of result.  Every TK_VECTOR node is an vector because the
364d832da7fSdrh ** parser will not generate a TK_VECTOR with fewer than two entries.
365d832da7fSdrh ** But a TK_SELECT might be either a vector or a scalar. It is only
366d832da7fSdrh ** considered a vector if it has two or more result columns.
367870a0705Sdan */
368870a0705Sdan int sqlite3ExprIsVector(Expr *pExpr){
36976dbe7a8Sdrh   return sqlite3ExprVectorSize(pExpr)>1;
370870a0705Sdan }
371870a0705Sdan 
372870a0705Sdan /*
373cfbb5e82Sdan ** If the expression passed as the only argument is of type TK_VECTOR
374cfbb5e82Sdan ** return the number of expressions in the vector. Or, if the expression
375cfbb5e82Sdan ** is a sub-select, return the number of columns in the sub-select. For
376cfbb5e82Sdan ** any other type of expression, return 1.
377cfbb5e82Sdan */
37871c57db0Sdan int sqlite3ExprVectorSize(Expr *pExpr){
37912abf408Sdrh   u8 op = pExpr->op;
38012abf408Sdrh   if( op==TK_REGISTER ) op = pExpr->op2;
38112abf408Sdrh   if( op==TK_VECTOR ){
38271c57db0Sdan     return pExpr->x.pList->nExpr;
38312abf408Sdrh   }else if( op==TK_SELECT ){
38476dbe7a8Sdrh     return pExpr->x.pSelect->pEList->nExpr;
38576dbe7a8Sdrh   }else{
38676dbe7a8Sdrh     return 1;
38776dbe7a8Sdrh   }
38871c57db0Sdan }
38971c57db0Sdan 
390ba00e30aSdan /*
391fc7f27b9Sdrh ** Return a pointer to a subexpression of pVector that is the i-th
392fc7f27b9Sdrh ** column of the vector (numbered starting with 0).  The caller must
393fc7f27b9Sdrh ** ensure that i is within range.
394fc7f27b9Sdrh **
39576dbe7a8Sdrh ** If pVector is really a scalar (and "scalar" here includes subqueries
39676dbe7a8Sdrh ** that return a single column!) then return pVector unmodified.
39776dbe7a8Sdrh **
398fc7f27b9Sdrh ** pVector retains ownership of the returned subexpression.
399fc7f27b9Sdrh **
400fc7f27b9Sdrh ** If the vector is a (SELECT ...) then the expression returned is
40176dbe7a8Sdrh ** just the expression for the i-th term of the result set, and may
40276dbe7a8Sdrh ** not be ready for evaluation because the table cursor has not yet
40376dbe7a8Sdrh ** been positioned.
404ba00e30aSdan */
405fc7f27b9Sdrh Expr *sqlite3VectorFieldSubexpr(Expr *pVector, int i){
406870a0705Sdan   assert( i<sqlite3ExprVectorSize(pVector) );
407870a0705Sdan   if( sqlite3ExprIsVector(pVector) ){
4089f24b53dSdrh     assert( pVector->op2==0 || pVector->op==TK_REGISTER );
4099f24b53dSdrh     if( pVector->op==TK_SELECT || pVector->op2==TK_SELECT ){
41071c57db0Sdan       return pVector->x.pSelect->pEList->a[i].pExpr;
411870a0705Sdan     }else{
41271c57db0Sdan       return pVector->x.pList->a[i].pExpr;
41371c57db0Sdan     }
414870a0705Sdan   }
415870a0705Sdan   return pVector;
416870a0705Sdan }
417fc7f27b9Sdrh 
418fc7f27b9Sdrh /*
419fc7f27b9Sdrh ** Compute and return a new Expr object which when passed to
420fc7f27b9Sdrh ** sqlite3ExprCode() will generate all necessary code to compute
421fc7f27b9Sdrh ** the iField-th column of the vector expression pVector.
422fc7f27b9Sdrh **
4238762ec19Sdrh ** It is ok for pVector to be a scalar (as long as iField==0).
4248762ec19Sdrh ** In that case, this routine works like sqlite3ExprDup().
4258762ec19Sdrh **
426fc7f27b9Sdrh ** The caller owns the returned Expr object and is responsible for
427fc7f27b9Sdrh ** ensuring that the returned value eventually gets freed.
428fc7f27b9Sdrh **
4298762ec19Sdrh ** The caller retains ownership of pVector.  If pVector is a TK_SELECT,
430fad0e70cSdan ** then the returned object will reference pVector and so pVector must remain
4318762ec19Sdrh ** valid for the life of the returned object.  If pVector is a TK_VECTOR
4328762ec19Sdrh ** or a scalar expression, then it can be deleted as soon as this routine
43376dbe7a8Sdrh ** returns.
4348762ec19Sdrh **
4358762ec19Sdrh ** A trick to cause a TK_SELECT pVector to be deleted together with
4368762ec19Sdrh ** the returned Expr object is to attach the pVector to the pRight field
4378762ec19Sdrh ** of the returned TK_SELECT_COLUMN Expr object.
438fc7f27b9Sdrh */
439fc7f27b9Sdrh Expr *sqlite3ExprForVectorField(
440fc7f27b9Sdrh   Parse *pParse,       /* Parsing context */
441fc7f27b9Sdrh   Expr *pVector,       /* The vector.  List of expressions or a sub-SELECT */
442a1251bc4Sdrh   int iField           /* Which column of the vector to return */
443fc7f27b9Sdrh ){
444fc7f27b9Sdrh   Expr *pRet;
445a1251bc4Sdrh   if( pVector->op==TK_SELECT ){
446a1251bc4Sdrh     assert( pVector->flags & EP_xIsSelect );
447fc7f27b9Sdrh     /* The TK_SELECT_COLUMN Expr node:
448fc7f27b9Sdrh     **
449966e2911Sdrh     ** pLeft:           pVector containing TK_SELECT.  Not deleted.
4508762ec19Sdrh     ** pRight:          not used.  But recursively deleted.
451fc7f27b9Sdrh     ** iColumn:         Index of a column in pVector
452966e2911Sdrh     ** iTable:          0 or the number of columns on the LHS of an assignment
453fc7f27b9Sdrh     ** pLeft->iTable:   First in an array of register holding result, or 0
454fc7f27b9Sdrh     **                  if the result is not yet computed.
455fc7f27b9Sdrh     **
456fc7f27b9Sdrh     ** sqlite3ExprDelete() specifically skips the recursive delete of
457fc7f27b9Sdrh     ** pLeft on TK_SELECT_COLUMN nodes.  But pRight is followed, so pVector
4588762ec19Sdrh     ** can be attached to pRight to cause this node to take ownership of
4598762ec19Sdrh     ** pVector.  Typically there will be multiple TK_SELECT_COLUMN nodes
4608762ec19Sdrh     ** with the same pLeft pointer to the pVector, but only one of them
4618762ec19Sdrh     ** will own the pVector.
462fc7f27b9Sdrh     */
463abfd35eaSdrh     pRet = sqlite3PExpr(pParse, TK_SELECT_COLUMN, 0, 0);
4648bd0d58eSdrh     if( pRet ){
4658bd0d58eSdrh       pRet->iColumn = iField;
4668bd0d58eSdrh       pRet->pLeft = pVector;
4678bd0d58eSdrh     }
468fc7f27b9Sdrh     assert( pRet==0 || pRet->iTable==0 );
469fc7f27b9Sdrh   }else{
470a1251bc4Sdrh     if( pVector->op==TK_VECTOR ) pVector = pVector->x.pList->a[iField].pExpr;
471a1251bc4Sdrh     pRet = sqlite3ExprDup(pParse->db, pVector, 0);
472dfb5c963Sdan     sqlite3RenameTokenRemap(pParse, pRet, pVector);
473fc7f27b9Sdrh   }
474fc7f27b9Sdrh   return pRet;
475fc7f27b9Sdrh }
47671c57db0Sdan 
4775c288b92Sdan /*
4785c288b92Sdan ** If expression pExpr is of type TK_SELECT, generate code to evaluate
4795c288b92Sdan ** it. Return the register in which the result is stored (or, if the
4805c288b92Sdan ** sub-select returns more than one column, the first in an array
4815c288b92Sdan ** of registers in which the result is stored).
4825c288b92Sdan **
4835c288b92Sdan ** If pExpr is not a TK_SELECT expression, return 0.
4845c288b92Sdan */
4855c288b92Sdan static int exprCodeSubselect(Parse *pParse, Expr *pExpr){
4868da209b1Sdan   int reg = 0;
487f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
4885c288b92Sdan   if( pExpr->op==TK_SELECT ){
48985bcdce2Sdrh     reg = sqlite3CodeSubselect(pParse, pExpr);
4908da209b1Sdan   }
491f9b2e05cSdan #endif
4928da209b1Sdan   return reg;
4938da209b1Sdan }
4948da209b1Sdan 
4955c288b92Sdan /*
4965c288b92Sdan ** Argument pVector points to a vector expression - either a TK_VECTOR
497870a0705Sdan ** or TK_SELECT that returns more than one column. This function returns
498870a0705Sdan ** the register number of a register that contains the value of
499870a0705Sdan ** element iField of the vector.
500870a0705Sdan **
501870a0705Sdan ** If pVector is a TK_SELECT expression, then code for it must have
502870a0705Sdan ** already been generated using the exprCodeSubselect() routine. In this
503870a0705Sdan ** case parameter regSelect should be the first in an array of registers
504870a0705Sdan ** containing the results of the sub-select.
505870a0705Sdan **
506870a0705Sdan ** If pVector is of type TK_VECTOR, then code for the requested field
507870a0705Sdan ** is generated. In this case (*pRegFree) may be set to the number of
508870a0705Sdan ** a temporary register to be freed by the caller before returning.
5095c288b92Sdan **
5105c288b92Sdan ** Before returning, output parameter (*ppExpr) is set to point to the
5115c288b92Sdan ** Expr object corresponding to element iElem of the vector.
5125c288b92Sdan */
5135c288b92Sdan static int exprVectorRegister(
5145c288b92Sdan   Parse *pParse,                  /* Parse context */
5155c288b92Sdan   Expr *pVector,                  /* Vector to extract element from */
516870a0705Sdan   int iField,                     /* Field to extract from pVector */
5175c288b92Sdan   int regSelect,                  /* First in array of registers */
5185c288b92Sdan   Expr **ppExpr,                  /* OUT: Expression element */
5195c288b92Sdan   int *pRegFree                   /* OUT: Temp register to free */
5205c288b92Sdan ){
52112abf408Sdrh   u8 op = pVector->op;
522c1bcd9ccSdrh   assert( op==TK_VECTOR || op==TK_REGISTER || op==TK_SELECT );
52312abf408Sdrh   if( op==TK_REGISTER ){
52412abf408Sdrh     *ppExpr = sqlite3VectorFieldSubexpr(pVector, iField);
52512abf408Sdrh     return pVector->iTable+iField;
52612abf408Sdrh   }
52712abf408Sdrh   if( op==TK_SELECT ){
528870a0705Sdan     *ppExpr = pVector->x.pSelect->pEList->a[iField].pExpr;
529870a0705Sdan      return regSelect+iField;
5305c288b92Sdan   }
531870a0705Sdan   *ppExpr = pVector->x.pList->a[iField].pExpr;
5325c288b92Sdan   return sqlite3ExprCodeTemp(pParse, *ppExpr, pRegFree);
5335c288b92Sdan }
5345c288b92Sdan 
5355c288b92Sdan /*
5365c288b92Sdan ** Expression pExpr is a comparison between two vector values. Compute
53779752b6eSdrh ** the result of the comparison (1, 0, or NULL) and write that
53879752b6eSdrh ** result into register dest.
53979752b6eSdrh **
54079752b6eSdrh ** The caller must satisfy the following preconditions:
54179752b6eSdrh **
54279752b6eSdrh **    if pExpr->op==TK_IS:      op==TK_EQ and p5==SQLITE_NULLEQ
54379752b6eSdrh **    if pExpr->op==TK_ISNOT:   op==TK_NE and p5==SQLITE_NULLEQ
54479752b6eSdrh **    otherwise:                op==pExpr->op and p5==0
5455c288b92Sdan */
54679752b6eSdrh static void codeVectorCompare(
54779752b6eSdrh   Parse *pParse,        /* Code generator context */
54879752b6eSdrh   Expr *pExpr,          /* The comparison operation */
54979752b6eSdrh   int dest,             /* Write results into this register */
55079752b6eSdrh   u8 op,                /* Comparison operator */
55179752b6eSdrh   u8 p5                 /* SQLITE_NULLEQ or zero */
55279752b6eSdrh ){
55371c57db0Sdan   Vdbe *v = pParse->pVdbe;
55471c57db0Sdan   Expr *pLeft = pExpr->pLeft;
55571c57db0Sdan   Expr *pRight = pExpr->pRight;
55671c57db0Sdan   int nLeft = sqlite3ExprVectorSize(pLeft);
55771c57db0Sdan   int i;
55871c57db0Sdan   int regLeft = 0;
55971c57db0Sdan   int regRight = 0;
56079752b6eSdrh   u8 opx = op;
561ec4ccdbcSdrh   int addrDone = sqlite3VdbeMakeLabel(pParse);
56271c57db0Sdan 
563245ce62eSdrh   if( nLeft!=sqlite3ExprVectorSize(pRight) ){
564245ce62eSdrh     sqlite3ErrorMsg(pParse, "row value misused");
565245ce62eSdrh     return;
566245ce62eSdrh   }
56771c57db0Sdan   assert( pExpr->op==TK_EQ || pExpr->op==TK_NE
56871c57db0Sdan        || pExpr->op==TK_IS || pExpr->op==TK_ISNOT
56971c57db0Sdan        || pExpr->op==TK_LT || pExpr->op==TK_GT
57071c57db0Sdan        || pExpr->op==TK_LE || pExpr->op==TK_GE
57171c57db0Sdan   );
57279752b6eSdrh   assert( pExpr->op==op || (pExpr->op==TK_IS && op==TK_EQ)
57379752b6eSdrh             || (pExpr->op==TK_ISNOT && op==TK_NE) );
57479752b6eSdrh   assert( p5==0 || pExpr->op!=op );
57579752b6eSdrh   assert( p5==SQLITE_NULLEQ || pExpr->op==op );
57671c57db0Sdan 
57779752b6eSdrh   p5 |= SQLITE_STOREP2;
57879752b6eSdrh   if( opx==TK_LE ) opx = TK_LT;
57979752b6eSdrh   if( opx==TK_GE ) opx = TK_GT;
5805c288b92Sdan 
5815c288b92Sdan   regLeft = exprCodeSubselect(pParse, pLeft);
5825c288b92Sdan   regRight = exprCodeSubselect(pParse, pRight);
5835c288b92Sdan 
584321e828dSdrh   for(i=0; 1 /*Loop exits by "break"*/; i++){
5855c288b92Sdan     int regFree1 = 0, regFree2 = 0;
5865c288b92Sdan     Expr *pL, *pR;
5875c288b92Sdan     int r1, r2;
588321e828dSdrh     assert( i>=0 && i<nLeft );
5895c288b92Sdan     r1 = exprVectorRegister(pParse, pLeft, i, regLeft, &pL, &regFree1);
5905c288b92Sdan     r2 = exprVectorRegister(pParse, pRight, i, regRight, &pR, &regFree2);
59179752b6eSdrh     codeCompare(pParse, pL, pR, opx, r1, r2, dest, p5);
59279752b6eSdrh     testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
59379752b6eSdrh     testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
59479752b6eSdrh     testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
59579752b6eSdrh     testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
59679752b6eSdrh     testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
59779752b6eSdrh     testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
59871c57db0Sdan     sqlite3ReleaseTempReg(pParse, regFree1);
59971c57db0Sdan     sqlite3ReleaseTempReg(pParse, regFree2);
60079752b6eSdrh     if( i==nLeft-1 ){
60179752b6eSdrh       break;
60271c57db0Sdan     }
60379752b6eSdrh     if( opx==TK_EQ ){
60479752b6eSdrh       sqlite3VdbeAddOp2(v, OP_IfNot, dest, addrDone); VdbeCoverage(v);
60579752b6eSdrh       p5 |= SQLITE_KEEPNULL;
60679752b6eSdrh     }else if( opx==TK_NE ){
60779752b6eSdrh       sqlite3VdbeAddOp2(v, OP_If, dest, addrDone); VdbeCoverage(v);
60879752b6eSdrh       p5 |= SQLITE_KEEPNULL;
609a2f62925Sdrh     }else{
610a2f62925Sdrh       assert( op==TK_LT || op==TK_GT || op==TK_LE || op==TK_GE );
611a2f62925Sdrh       sqlite3VdbeAddOp2(v, OP_ElseNotEq, 0, addrDone);
61279752b6eSdrh       VdbeCoverageIf(v, op==TK_LT);
61379752b6eSdrh       VdbeCoverageIf(v, op==TK_GT);
61479752b6eSdrh       VdbeCoverageIf(v, op==TK_LE);
61579752b6eSdrh       VdbeCoverageIf(v, op==TK_GE);
61679752b6eSdrh       if( i==nLeft-2 ) opx = op;
61771c57db0Sdan     }
61879752b6eSdrh   }
61979752b6eSdrh   sqlite3VdbeResolveLabel(v, addrDone);
62079752b6eSdrh }
62171c57db0Sdan 
6224b5255acSdanielk1977 #if SQLITE_MAX_EXPR_DEPTH>0
6234b5255acSdanielk1977 /*
6244b5255acSdanielk1977 ** Check that argument nHeight is less than or equal to the maximum
6254b5255acSdanielk1977 ** expression depth allowed. If it is not, leave an error message in
6264b5255acSdanielk1977 ** pParse.
6274b5255acSdanielk1977 */
6287d10d5a6Sdrh int sqlite3ExprCheckHeight(Parse *pParse, int nHeight){
6294b5255acSdanielk1977   int rc = SQLITE_OK;
6304b5255acSdanielk1977   int mxHeight = pParse->db->aLimit[SQLITE_LIMIT_EXPR_DEPTH];
6314b5255acSdanielk1977   if( nHeight>mxHeight ){
6324b5255acSdanielk1977     sqlite3ErrorMsg(pParse,
6334b5255acSdanielk1977        "Expression tree is too large (maximum depth %d)", mxHeight
6344b5255acSdanielk1977     );
6354b5255acSdanielk1977     rc = SQLITE_ERROR;
6364b5255acSdanielk1977   }
6374b5255acSdanielk1977   return rc;
6384b5255acSdanielk1977 }
6394b5255acSdanielk1977 
6404b5255acSdanielk1977 /* The following three functions, heightOfExpr(), heightOfExprList()
6414b5255acSdanielk1977 ** and heightOfSelect(), are used to determine the maximum height
6424b5255acSdanielk1977 ** of any expression tree referenced by the structure passed as the
6434b5255acSdanielk1977 ** first argument.
6444b5255acSdanielk1977 **
6454b5255acSdanielk1977 ** If this maximum height is greater than the current value pointed
6464b5255acSdanielk1977 ** to by pnHeight, the second parameter, then set *pnHeight to that
6474b5255acSdanielk1977 ** value.
6484b5255acSdanielk1977 */
6494b5255acSdanielk1977 static void heightOfExpr(Expr *p, int *pnHeight){
6504b5255acSdanielk1977   if( p ){
6514b5255acSdanielk1977     if( p->nHeight>*pnHeight ){
6524b5255acSdanielk1977       *pnHeight = p->nHeight;
6534b5255acSdanielk1977     }
6544b5255acSdanielk1977   }
6554b5255acSdanielk1977 }
6564b5255acSdanielk1977 static void heightOfExprList(ExprList *p, int *pnHeight){
6574b5255acSdanielk1977   if( p ){
6584b5255acSdanielk1977     int i;
6594b5255acSdanielk1977     for(i=0; i<p->nExpr; i++){
6604b5255acSdanielk1977       heightOfExpr(p->a[i].pExpr, pnHeight);
6614b5255acSdanielk1977     }
6624b5255acSdanielk1977   }
6634b5255acSdanielk1977 }
6641a3a3086Sdan static void heightOfSelect(Select *pSelect, int *pnHeight){
6651a3a3086Sdan   Select *p;
6661a3a3086Sdan   for(p=pSelect; p; p=p->pPrior){
6674b5255acSdanielk1977     heightOfExpr(p->pWhere, pnHeight);
6684b5255acSdanielk1977     heightOfExpr(p->pHaving, pnHeight);
6694b5255acSdanielk1977     heightOfExpr(p->pLimit, pnHeight);
6704b5255acSdanielk1977     heightOfExprList(p->pEList, pnHeight);
6714b5255acSdanielk1977     heightOfExprList(p->pGroupBy, pnHeight);
6724b5255acSdanielk1977     heightOfExprList(p->pOrderBy, pnHeight);
6734b5255acSdanielk1977   }
6744b5255acSdanielk1977 }
6754b5255acSdanielk1977 
6764b5255acSdanielk1977 /*
6774b5255acSdanielk1977 ** Set the Expr.nHeight variable in the structure passed as an
6784b5255acSdanielk1977 ** argument. An expression with no children, Expr.pList or
6794b5255acSdanielk1977 ** Expr.pSelect member has a height of 1. Any other expression
6804b5255acSdanielk1977 ** has a height equal to the maximum height of any other
6814b5255acSdanielk1977 ** referenced Expr plus one.
6822308ed38Sdrh **
6832308ed38Sdrh ** Also propagate EP_Propagate flags up from Expr.x.pList to Expr.flags,
6842308ed38Sdrh ** if appropriate.
6854b5255acSdanielk1977 */
6864b5255acSdanielk1977 static void exprSetHeight(Expr *p){
6874b5255acSdanielk1977   int nHeight = 0;
6884b5255acSdanielk1977   heightOfExpr(p->pLeft, &nHeight);
6894b5255acSdanielk1977   heightOfExpr(p->pRight, &nHeight);
6906ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_xIsSelect) ){
6916ab3a2ecSdanielk1977     heightOfSelect(p->x.pSelect, &nHeight);
6922308ed38Sdrh   }else if( p->x.pList ){
6936ab3a2ecSdanielk1977     heightOfExprList(p->x.pList, &nHeight);
6942308ed38Sdrh     p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
6956ab3a2ecSdanielk1977   }
6964b5255acSdanielk1977   p->nHeight = nHeight + 1;
6974b5255acSdanielk1977 }
6984b5255acSdanielk1977 
6994b5255acSdanielk1977 /*
7004b5255acSdanielk1977 ** Set the Expr.nHeight variable using the exprSetHeight() function. If
7014b5255acSdanielk1977 ** the height is greater than the maximum allowed expression depth,
7024b5255acSdanielk1977 ** leave an error in pParse.
7032308ed38Sdrh **
7042308ed38Sdrh ** Also propagate all EP_Propagate flags from the Expr.x.pList into
7052308ed38Sdrh ** Expr.flags.
7064b5255acSdanielk1977 */
7072308ed38Sdrh void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
70874893a4cSdrh   if( pParse->nErr ) return;
7094b5255acSdanielk1977   exprSetHeight(p);
7107d10d5a6Sdrh   sqlite3ExprCheckHeight(pParse, p->nHeight);
7114b5255acSdanielk1977 }
7124b5255acSdanielk1977 
7134b5255acSdanielk1977 /*
7144b5255acSdanielk1977 ** Return the maximum height of any expression tree referenced
7154b5255acSdanielk1977 ** by the select statement passed as an argument.
7164b5255acSdanielk1977 */
7174b5255acSdanielk1977 int sqlite3SelectExprHeight(Select *p){
7184b5255acSdanielk1977   int nHeight = 0;
7194b5255acSdanielk1977   heightOfSelect(p, &nHeight);
7204b5255acSdanielk1977   return nHeight;
7214b5255acSdanielk1977 }
7222308ed38Sdrh #else /* ABOVE:  Height enforcement enabled.  BELOW: Height enforcement off */
7232308ed38Sdrh /*
7242308ed38Sdrh ** Propagate all EP_Propagate flags from the Expr.x.pList into
7252308ed38Sdrh ** Expr.flags.
7262308ed38Sdrh */
7272308ed38Sdrh void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
7282308ed38Sdrh   if( p && p->x.pList && !ExprHasProperty(p, EP_xIsSelect) ){
7292308ed38Sdrh     p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
7302308ed38Sdrh   }
7312308ed38Sdrh }
7324b5255acSdanielk1977 #define exprSetHeight(y)
7334b5255acSdanielk1977 #endif /* SQLITE_MAX_EXPR_DEPTH>0 */
7344b5255acSdanielk1977 
735be5c89acSdrh /*
736b7916a78Sdrh ** This routine is the core allocator for Expr nodes.
737b7916a78Sdrh **
738a76b5dfcSdrh ** Construct a new expression node and return a pointer to it.  Memory
739b7916a78Sdrh ** for this node and for the pToken argument is a single allocation
740b7916a78Sdrh ** obtained from sqlite3DbMalloc().  The calling function
741a76b5dfcSdrh ** is responsible for making sure the node eventually gets freed.
742b7916a78Sdrh **
743b7916a78Sdrh ** If dequote is true, then the token (if it exists) is dequoted.
744e792b5b4Sdrh ** If dequote is false, no dequoting is performed.  The deQuote
745b7916a78Sdrh ** parameter is ignored if pToken is NULL or if the token does not
746b7916a78Sdrh ** appear to be quoted.  If the quotes were of the form "..." (double-quotes)
747b7916a78Sdrh ** then the EP_DblQuoted flag is set on the expression node.
74833e619fcSdrh **
74933e619fcSdrh ** Special case:  If op==TK_INTEGER and pToken points to a string that
75033e619fcSdrh ** can be translated into a 32-bit integer, then the token is not
75133e619fcSdrh ** stored in u.zToken.  Instead, the integer values is written
75233e619fcSdrh ** into u.iValue and the EP_IntValue flag is set.  No extra storage
75333e619fcSdrh ** is allocated to hold the integer text and the dequote flag is ignored.
754a76b5dfcSdrh */
755b7916a78Sdrh Expr *sqlite3ExprAlloc(
756cca8a4adSdrh   sqlite3 *db,            /* Handle for sqlite3DbMallocRawNN() */
75717435752Sdrh   int op,                 /* Expression opcode */
758b7916a78Sdrh   const Token *pToken,    /* Token argument.  Might be NULL */
759b7916a78Sdrh   int dequote             /* True to dequote */
76017435752Sdrh ){
761a76b5dfcSdrh   Expr *pNew;
76233e619fcSdrh   int nExtra = 0;
763cf697396Sshane   int iValue = 0;
764b7916a78Sdrh 
765575fad65Sdrh   assert( db!=0 );
766b7916a78Sdrh   if( pToken ){
76733e619fcSdrh     if( op!=TK_INTEGER || pToken->z==0
76833e619fcSdrh           || sqlite3GetInt32(pToken->z, &iValue)==0 ){
769b7916a78Sdrh       nExtra = pToken->n+1;
770d50ffc41Sdrh       assert( iValue>=0 );
77133e619fcSdrh     }
772a76b5dfcSdrh   }
773575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, sizeof(Expr)+nExtra);
774b7916a78Sdrh   if( pNew ){
775ca3862dcSdrh     memset(pNew, 0, sizeof(Expr));
7761bd10f8aSdrh     pNew->op = (u8)op;
777a58fdfb1Sdanielk1977     pNew->iAgg = -1;
778a76b5dfcSdrh     if( pToken ){
77933e619fcSdrh       if( nExtra==0 ){
780ad31727fSdrh         pNew->flags |= EP_IntValue|EP_Leaf|(iValue?EP_IsTrue:EP_IsFalse);
78133e619fcSdrh         pNew->u.iValue = iValue;
78233e619fcSdrh       }else{
78333e619fcSdrh         pNew->u.zToken = (char*)&pNew[1];
784b07028f7Sdrh         assert( pToken->z!=0 || pToken->n==0 );
785b07028f7Sdrh         if( pToken->n ) memcpy(pNew->u.zToken, pToken->z, pToken->n);
78633e619fcSdrh         pNew->u.zToken[pToken->n] = 0;
787244b9d6eSdrh         if( dequote && sqlite3Isquote(pNew->u.zToken[0]) ){
78851d35b0fSdrh           sqlite3DequoteExpr(pNew);
789a34001c9Sdrh         }
790a34001c9Sdrh       }
79133e619fcSdrh     }
792b7916a78Sdrh #if SQLITE_MAX_EXPR_DEPTH>0
793b7916a78Sdrh     pNew->nHeight = 1;
794b7916a78Sdrh #endif
795a34001c9Sdrh   }
796a76b5dfcSdrh   return pNew;
797a76b5dfcSdrh }
798a76b5dfcSdrh 
799a76b5dfcSdrh /*
800b7916a78Sdrh ** Allocate a new expression node from a zero-terminated token that has
801b7916a78Sdrh ** already been dequoted.
802b7916a78Sdrh */
803b7916a78Sdrh Expr *sqlite3Expr(
804b7916a78Sdrh   sqlite3 *db,            /* Handle for sqlite3DbMallocZero() (may be null) */
805b7916a78Sdrh   int op,                 /* Expression opcode */
806b7916a78Sdrh   const char *zToken      /* Token argument.  Might be NULL */
807b7916a78Sdrh ){
808b7916a78Sdrh   Token x;
809b7916a78Sdrh   x.z = zToken;
810b40f06c6Sdrh   x.n = sqlite3Strlen30(zToken);
811b7916a78Sdrh   return sqlite3ExprAlloc(db, op, &x, 0);
812b7916a78Sdrh }
813b7916a78Sdrh 
814b7916a78Sdrh /*
815b7916a78Sdrh ** Attach subtrees pLeft and pRight to the Expr node pRoot.
816b7916a78Sdrh **
817b7916a78Sdrh ** If pRoot==NULL that means that a memory allocation error has occurred.
818b7916a78Sdrh ** In that case, delete the subtrees pLeft and pRight.
819b7916a78Sdrh */
820b7916a78Sdrh void sqlite3ExprAttachSubtrees(
821b7916a78Sdrh   sqlite3 *db,
822b7916a78Sdrh   Expr *pRoot,
823b7916a78Sdrh   Expr *pLeft,
824b7916a78Sdrh   Expr *pRight
825b7916a78Sdrh ){
826b7916a78Sdrh   if( pRoot==0 ){
827b7916a78Sdrh     assert( db->mallocFailed );
828b7916a78Sdrh     sqlite3ExprDelete(db, pLeft);
829b7916a78Sdrh     sqlite3ExprDelete(db, pRight);
830b7916a78Sdrh   }else{
831b7916a78Sdrh     if( pRight ){
832b7916a78Sdrh       pRoot->pRight = pRight;
833885a5b03Sdrh       pRoot->flags |= EP_Propagate & pRight->flags;
834b7916a78Sdrh     }
835b7916a78Sdrh     if( pLeft ){
836b7916a78Sdrh       pRoot->pLeft = pLeft;
837885a5b03Sdrh       pRoot->flags |= EP_Propagate & pLeft->flags;
838b7916a78Sdrh     }
839b7916a78Sdrh     exprSetHeight(pRoot);
840b7916a78Sdrh   }
841b7916a78Sdrh }
842b7916a78Sdrh 
843b7916a78Sdrh /*
84460ec914cSpeter.d.reid ** Allocate an Expr node which joins as many as two subtrees.
845b7916a78Sdrh **
846bf664469Sdrh ** One or both of the subtrees can be NULL.  Return a pointer to the new
847bf664469Sdrh ** Expr node.  Or, if an OOM error occurs, set pParse->db->mallocFailed,
848bf664469Sdrh ** free the subtrees and return NULL.
849206f3d96Sdrh */
85017435752Sdrh Expr *sqlite3PExpr(
85117435752Sdrh   Parse *pParse,          /* Parsing context */
85217435752Sdrh   int op,                 /* Expression opcode */
85317435752Sdrh   Expr *pLeft,            /* Left operand */
854abfd35eaSdrh   Expr *pRight            /* Right operand */
85517435752Sdrh ){
8565fb52caaSdrh   Expr *p;
857abfd35eaSdrh   p = sqlite3DbMallocRawNN(pParse->db, sizeof(Expr));
858abfd35eaSdrh   if( p ){
859abfd35eaSdrh     memset(p, 0, sizeof(Expr));
860f1722baaSdrh     p->op = op & 0xff;
861abfd35eaSdrh     p->iAgg = -1;
862b7916a78Sdrh     sqlite3ExprAttachSubtrees(pParse->db, p, pLeft, pRight);
8632b359bdbSdan     sqlite3ExprCheckHeight(pParse, p->nHeight);
864d5c851c1Sdrh   }else{
865d5c851c1Sdrh     sqlite3ExprDelete(pParse->db, pLeft);
866d5c851c1Sdrh     sqlite3ExprDelete(pParse->db, pRight);
8672b359bdbSdan   }
8684e0cff60Sdrh   return p;
8694e0cff60Sdrh }
8704e0cff60Sdrh 
8714e0cff60Sdrh /*
87208de4f79Sdrh ** Add pSelect to the Expr.x.pSelect field.  Or, if pExpr is NULL (due
87308de4f79Sdrh ** do a memory allocation failure) then delete the pSelect object.
87408de4f79Sdrh */
87508de4f79Sdrh void sqlite3PExprAddSelect(Parse *pParse, Expr *pExpr, Select *pSelect){
87608de4f79Sdrh   if( pExpr ){
87708de4f79Sdrh     pExpr->x.pSelect = pSelect;
87808de4f79Sdrh     ExprSetProperty(pExpr, EP_xIsSelect|EP_Subquery);
87908de4f79Sdrh     sqlite3ExprSetHeightAndFlags(pParse, pExpr);
88008de4f79Sdrh   }else{
88108de4f79Sdrh     assert( pParse->db->mallocFailed );
88208de4f79Sdrh     sqlite3SelectDelete(pParse->db, pSelect);
88308de4f79Sdrh   }
88408de4f79Sdrh }
88508de4f79Sdrh 
88608de4f79Sdrh 
88708de4f79Sdrh /*
88891bb0eedSdrh ** Join two expressions using an AND operator.  If either expression is
88991bb0eedSdrh ** NULL, then just return the other expression.
8905fb52caaSdrh **
8915fb52caaSdrh ** If one side or the other of the AND is known to be false, then instead
8925fb52caaSdrh ** of returning an AND expression, just return a constant expression with
8935fb52caaSdrh ** a value of false.
89491bb0eedSdrh */
895d5c851c1Sdrh Expr *sqlite3ExprAnd(Parse *pParse, Expr *pLeft, Expr *pRight){
896d5c851c1Sdrh   sqlite3 *db = pParse->db;
89791bb0eedSdrh   if( pLeft==0  ){
89891bb0eedSdrh     return pRight;
89991bb0eedSdrh   }else if( pRight==0 ){
90091bb0eedSdrh     return pLeft;
901ad31727fSdrh   }else if( ExprAlwaysFalse(pLeft) || ExprAlwaysFalse(pRight) ){
9028e34e406Sdrh     sqlite3ExprUnmapAndDelete(pParse, pLeft);
9038e34e406Sdrh     sqlite3ExprUnmapAndDelete(pParse, pRight);
9045fb52caaSdrh     return sqlite3ExprAlloc(db, TK_INTEGER, &sqlite3IntTokens[0], 0);
90591bb0eedSdrh   }else{
906d5c851c1Sdrh     return sqlite3PExpr(pParse, TK_AND, pLeft, pRight);
907a76b5dfcSdrh   }
908a76b5dfcSdrh }
909a76b5dfcSdrh 
910a76b5dfcSdrh /*
911a76b5dfcSdrh ** Construct a new expression node for a function with multiple
912a76b5dfcSdrh ** arguments.
913a76b5dfcSdrh */
914954733b3Sdrh Expr *sqlite3ExprFunction(
915954733b3Sdrh   Parse *pParse,        /* Parsing context */
916954733b3Sdrh   ExprList *pList,      /* Argument list */
917954733b3Sdrh   Token *pToken,        /* Name of the function */
918954733b3Sdrh   int eDistinct         /* SF_Distinct or SF_ALL or 0 */
919954733b3Sdrh ){
920a76b5dfcSdrh   Expr *pNew;
921633e6d57Sdrh   sqlite3 *db = pParse->db;
9224b202ae2Sdanielk1977   assert( pToken );
923b7916a78Sdrh   pNew = sqlite3ExprAlloc(db, TK_FUNCTION, pToken, 1);
924a76b5dfcSdrh   if( pNew==0 ){
925d9da78a2Sdrh     sqlite3ExprListDelete(db, pList); /* Avoid memory leak when malloc fails */
926a76b5dfcSdrh     return 0;
927a76b5dfcSdrh   }
928954733b3Sdrh   if( pList && pList->nExpr > pParse->db->aLimit[SQLITE_LIMIT_FUNCTION_ARG] ){
929954733b3Sdrh     sqlite3ErrorMsg(pParse, "too many arguments on function %T", pToken);
930954733b3Sdrh   }
9316ab3a2ecSdanielk1977   pNew->x.pList = pList;
932fca23557Sdrh   ExprSetProperty(pNew, EP_HasFunc);
9336ab3a2ecSdanielk1977   assert( !ExprHasProperty(pNew, EP_xIsSelect) );
9342308ed38Sdrh   sqlite3ExprSetHeightAndFlags(pParse, pNew);
935954733b3Sdrh   if( eDistinct==SF_Distinct ) ExprSetProperty(pNew, EP_Distinct);
936a76b5dfcSdrh   return pNew;
937a76b5dfcSdrh }
938a76b5dfcSdrh 
939a76b5dfcSdrh /*
940fa6bc000Sdrh ** Assign a variable number to an expression that encodes a wildcard
941fa6bc000Sdrh ** in the original SQL statement.
942fa6bc000Sdrh **
943fa6bc000Sdrh ** Wildcards consisting of a single "?" are assigned the next sequential
944fa6bc000Sdrh ** variable number.
945fa6bc000Sdrh **
946fa6bc000Sdrh ** Wildcards of the form "?nnn" are assigned the number "nnn".  We make
9479bf755ccSdrh ** sure "nnn" is not too big to avoid a denial of service attack when
948fa6bc000Sdrh ** the SQL statement comes from an external source.
949fa6bc000Sdrh **
95051f49f17Sdrh ** Wildcards of the form ":aaa", "@aaa", or "$aaa" are assigned the same number
951fa6bc000Sdrh ** as the previous instance of the same wildcard.  Or if this is the first
95260ec914cSpeter.d.reid ** instance of the wildcard, the next sequential variable number is
953fa6bc000Sdrh ** assigned.
954fa6bc000Sdrh */
955de25a88cSdrh void sqlite3ExprAssignVarNumber(Parse *pParse, Expr *pExpr, u32 n){
95617435752Sdrh   sqlite3 *db = pParse->db;
957b7916a78Sdrh   const char *z;
958f326d66dSdrh   ynVar x;
95917435752Sdrh 
960fa6bc000Sdrh   if( pExpr==0 ) return;
961c5cd1249Sdrh   assert( !ExprHasProperty(pExpr, EP_IntValue|EP_Reduced|EP_TokenOnly) );
96233e619fcSdrh   z = pExpr->u.zToken;
963b7916a78Sdrh   assert( z!=0 );
964b7916a78Sdrh   assert( z[0]!=0 );
965b1ed717fSmistachkin   assert( n==(u32)sqlite3Strlen30(z) );
966b7916a78Sdrh   if( z[1]==0 ){
967fa6bc000Sdrh     /* Wildcard of the form "?".  Assign the next variable number */
968b7916a78Sdrh     assert( z[0]=='?' );
969f326d66dSdrh     x = (ynVar)(++pParse->nVar);
970124c0b49Sdrh   }else{
971f326d66dSdrh     int doAdd = 0;
972124c0b49Sdrh     if( z[0]=='?' ){
973fa6bc000Sdrh       /* Wildcard of the form "?nnn".  Convert "nnn" to an integer and
974fa6bc000Sdrh       ** use it as the variable number */
975c8d735aeSdan       i64 i;
97618814dfbSdrh       int bOk;
97718814dfbSdrh       if( n==2 ){ /*OPTIMIZATION-IF-TRUE*/
97818814dfbSdrh         i = z[1]-'0';  /* The common case of ?N for a single digit N */
97918814dfbSdrh         bOk = 1;
98018814dfbSdrh       }else{
98118814dfbSdrh         bOk = 0==sqlite3Atoi64(&z[1], &i, n-1, SQLITE_UTF8);
98218814dfbSdrh       }
983c5499befSdrh       testcase( i==0 );
984c5499befSdrh       testcase( i==1 );
985c5499befSdrh       testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]-1 );
986c5499befSdrh       testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] );
987c8d735aeSdan       if( bOk==0 || i<1 || i>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
988fa6bc000Sdrh         sqlite3ErrorMsg(pParse, "variable number must be between ?1 and ?%d",
989bb4957f8Sdrh             db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]);
990c9b39288Sdrh         return;
991fa6bc000Sdrh       }
9928e74e7baSdrh       x = (ynVar)i;
993f326d66dSdrh       if( x>pParse->nVar ){
994f326d66dSdrh         pParse->nVar = (int)x;
995f326d66dSdrh         doAdd = 1;
996f326d66dSdrh       }else if( sqlite3VListNumToName(pParse->pVList, x)==0 ){
997f326d66dSdrh         doAdd = 1;
998fa6bc000Sdrh       }
999fa6bc000Sdrh     }else{
100051f49f17Sdrh       /* Wildcards like ":aaa", "$aaa" or "@aaa".  Reuse the same variable
1001fa6bc000Sdrh       ** number as the prior appearance of the same name, or if the name
1002fa6bc000Sdrh       ** has never appeared before, reuse the same variable number
1003fa6bc000Sdrh       */
10049bf755ccSdrh       x = (ynVar)sqlite3VListNameToNum(pParse->pVList, z, n);
10059bf755ccSdrh       if( x==0 ){
10069bf755ccSdrh         x = (ynVar)(++pParse->nVar);
1007f326d66dSdrh         doAdd = 1;
1008f326d66dSdrh       }
1009f326d66dSdrh     }
1010f326d66dSdrh     if( doAdd ){
10119bf755ccSdrh       pParse->pVList = sqlite3VListAdd(db, pParse->pVList, z, n, x);
1012fa6bc000Sdrh     }
1013fa6bc000Sdrh   }
1014c9b39288Sdrh   pExpr->iColumn = x;
1015f326d66dSdrh   if( x>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
1016832b2664Sdanielk1977     sqlite3ErrorMsg(pParse, "too many SQL variables");
1017832b2664Sdanielk1977   }
1018fa6bc000Sdrh }
1019fa6bc000Sdrh 
1020fa6bc000Sdrh /*
1021f6963f99Sdan ** Recursively delete an expression tree.
1022a2e00042Sdrh */
10234f0010b1Sdrh static SQLITE_NOINLINE void sqlite3ExprDeleteNN(sqlite3 *db, Expr *p){
10244f0010b1Sdrh   assert( p!=0 );
1025d50ffc41Sdrh   /* Sanity check: Assert that the IntValue is non-negative if it exists */
1026d50ffc41Sdrh   assert( !ExprHasProperty(p, EP_IntValue) || p->u.iValue>=0 );
1027eda079cdSdrh 
1028eda079cdSdrh   assert( !ExprHasProperty(p, EP_WinFunc) || p->y.pWin!=0 || db->mallocFailed );
1029eda079cdSdrh   assert( p->op!=TK_FUNCTION || ExprHasProperty(p, EP_TokenOnly|EP_Reduced)
1030*4f9adee2Sdan           || p->y.pWin==0 || ExprHasProperty(p, EP_WinFunc) );
1031209bc522Sdrh #ifdef SQLITE_DEBUG
1032209bc522Sdrh   if( ExprHasProperty(p, EP_Leaf) && !ExprHasProperty(p, EP_TokenOnly) ){
1033209bc522Sdrh     assert( p->pLeft==0 );
1034209bc522Sdrh     assert( p->pRight==0 );
1035209bc522Sdrh     assert( p->x.pSelect==0 );
1036209bc522Sdrh   }
1037209bc522Sdrh #endif
1038209bc522Sdrh   if( !ExprHasProperty(p, (EP_TokenOnly|EP_Leaf)) ){
1039c5cd1249Sdrh     /* The Expr.x union is never used at the same time as Expr.pRight */
1040c5cd1249Sdrh     assert( p->x.pList==0 || p->pRight==0 );
10414910a76dSdrh     if( p->pLeft && p->op!=TK_SELECT_COLUMN ) sqlite3ExprDeleteNN(db, p->pLeft);
1042d1086679Sdrh     if( p->pRight ){
1043*4f9adee2Sdan       assert( !ExprHasProperty(p, EP_WinFunc) );
1044d1086679Sdrh       sqlite3ExprDeleteNN(db, p->pRight);
1045d1086679Sdrh     }else if( ExprHasProperty(p, EP_xIsSelect) ){
1046*4f9adee2Sdan       assert( !ExprHasProperty(p, EP_WinFunc) );
10476ab3a2ecSdanielk1977       sqlite3SelectDelete(db, p->x.pSelect);
10486ab3a2ecSdanielk1977     }else{
10496ab3a2ecSdanielk1977       sqlite3ExprListDelete(db, p->x.pList);
10506ba7ab0dSdan #ifndef SQLITE_OMIT_WINDOWFUNC
1051eda079cdSdrh       if( ExprHasProperty(p, EP_WinFunc) ){
1052eda079cdSdrh         sqlite3WindowDelete(db, p->y.pWin);
105386fb6e17Sdan       }
10546ba7ab0dSdan #endif
10556ab3a2ecSdanielk1977     }
10568117f113Sdan   }
1057209bc522Sdrh   if( ExprHasProperty(p, EP_MemToken) ) sqlite3DbFree(db, p->u.zToken);
105833e619fcSdrh   if( !ExprHasProperty(p, EP_Static) ){
1059dbd6a7dcSdrh     sqlite3DbFreeNN(db, p);
1060a2e00042Sdrh   }
106133e619fcSdrh }
10624f0010b1Sdrh void sqlite3ExprDelete(sqlite3 *db, Expr *p){
10634f0010b1Sdrh   if( p ) sqlite3ExprDeleteNN(db, p);
10644f0010b1Sdrh }
1065a2e00042Sdrh 
10668e34e406Sdrh /* Invoke sqlite3RenameExprUnmap() and sqlite3ExprDelete() on the
10678e34e406Sdrh ** expression.
10688e34e406Sdrh */
10698e34e406Sdrh void sqlite3ExprUnmapAndDelete(Parse *pParse, Expr *p){
10708e34e406Sdrh   if( p ){
10718e34e406Sdrh     if( IN_RENAME_OBJECT ){
10728e34e406Sdrh       sqlite3RenameExprUnmap(pParse, p);
10738e34e406Sdrh     }
10748e34e406Sdrh     sqlite3ExprDeleteNN(pParse->db, p);
10758e34e406Sdrh   }
10768e34e406Sdrh }
10778e34e406Sdrh 
1078d2687b77Sdrh /*
10796ab3a2ecSdanielk1977 ** Return the number of bytes allocated for the expression structure
10806ab3a2ecSdanielk1977 ** passed as the first argument. This is always one of EXPR_FULLSIZE,
10816ab3a2ecSdanielk1977 ** EXPR_REDUCEDSIZE or EXPR_TOKENONLYSIZE.
10826ab3a2ecSdanielk1977 */
10836ab3a2ecSdanielk1977 static int exprStructSize(Expr *p){
10846ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_TokenOnly) ) return EXPR_TOKENONLYSIZE;
10856ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_Reduced) ) return EXPR_REDUCEDSIZE;
10866ab3a2ecSdanielk1977   return EXPR_FULLSIZE;
10876ab3a2ecSdanielk1977 }
10886ab3a2ecSdanielk1977 
10896ab3a2ecSdanielk1977 /*
1090a8e05761Sdrh ** Copy the complete content of an Expr node, taking care not to read
1091a8e05761Sdrh ** past the end of the structure for a reduced-size version of the source
1092a8e05761Sdrh ** Expr.
1093a8e05761Sdrh */
1094a8e05761Sdrh static void exprNodeCopy(Expr *pDest, Expr *pSrc){
1095a8e05761Sdrh   memset(pDest, 0, sizeof(Expr));
1096a8e05761Sdrh   memcpy(pDest, pSrc, exprStructSize(pSrc));
1097a8e05761Sdrh }
1098a8e05761Sdrh 
1099a8e05761Sdrh /*
110033e619fcSdrh ** The dupedExpr*Size() routines each return the number of bytes required
110133e619fcSdrh ** to store a copy of an expression or expression tree.  They differ in
110233e619fcSdrh ** how much of the tree is measured.
110333e619fcSdrh **
110433e619fcSdrh **     dupedExprStructSize()     Size of only the Expr structure
110533e619fcSdrh **     dupedExprNodeSize()       Size of Expr + space for token
110633e619fcSdrh **     dupedExprSize()           Expr + token + subtree components
110733e619fcSdrh **
110833e619fcSdrh ***************************************************************************
110933e619fcSdrh **
111033e619fcSdrh ** The dupedExprStructSize() function returns two values OR-ed together:
111133e619fcSdrh ** (1) the space required for a copy of the Expr structure only and
111233e619fcSdrh ** (2) the EP_xxx flags that indicate what the structure size should be.
111333e619fcSdrh ** The return values is always one of:
111433e619fcSdrh **
111533e619fcSdrh **      EXPR_FULLSIZE
111633e619fcSdrh **      EXPR_REDUCEDSIZE   | EP_Reduced
111733e619fcSdrh **      EXPR_TOKENONLYSIZE | EP_TokenOnly
111833e619fcSdrh **
111933e619fcSdrh ** The size of the structure can be found by masking the return value
112033e619fcSdrh ** of this routine with 0xfff.  The flags can be found by masking the
112133e619fcSdrh ** return value with EP_Reduced|EP_TokenOnly.
112233e619fcSdrh **
112333e619fcSdrh ** Note that with flags==EXPRDUP_REDUCE, this routines works on full-size
112433e619fcSdrh ** (unreduced) Expr objects as they or originally constructed by the parser.
112533e619fcSdrh ** During expression analysis, extra information is computed and moved into
1126c95f38d4Sdan ** later parts of the Expr object and that extra information might get chopped
112733e619fcSdrh ** off if the expression is reduced.  Note also that it does not work to
112860ec914cSpeter.d.reid ** make an EXPRDUP_REDUCE copy of a reduced expression.  It is only legal
112933e619fcSdrh ** to reduce a pristine expression tree from the parser.  The implementation
113033e619fcSdrh ** of dupedExprStructSize() contain multiple assert() statements that attempt
113133e619fcSdrh ** to enforce this constraint.
11326ab3a2ecSdanielk1977 */
11336ab3a2ecSdanielk1977 static int dupedExprStructSize(Expr *p, int flags){
11346ab3a2ecSdanielk1977   int nSize;
113533e619fcSdrh   assert( flags==EXPRDUP_REDUCE || flags==0 ); /* Only one flag value allowed */
1136aecd8021Sdrh   assert( EXPR_FULLSIZE<=0xfff );
1137aecd8021Sdrh   assert( (0xfff & (EP_Reduced|EP_TokenOnly))==0 );
113867a9b8edSdan   if( 0==flags || p->op==TK_SELECT_COLUMN
113967a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
1140eda079cdSdrh    || ExprHasProperty(p, EP_WinFunc)
114167a9b8edSdan #endif
114267a9b8edSdan   ){
11436ab3a2ecSdanielk1977     nSize = EXPR_FULLSIZE;
11446ab3a2ecSdanielk1977   }else{
1145c5cd1249Sdrh     assert( !ExprHasProperty(p, EP_TokenOnly|EP_Reduced) );
114633e619fcSdrh     assert( !ExprHasProperty(p, EP_FromJoin) );
1147c5cd1249Sdrh     assert( !ExprHasProperty(p, EP_MemToken) );
1148ebb6a65dSdrh     assert( !ExprHasProperty(p, EP_NoReduce) );
1149aecd8021Sdrh     if( p->pLeft || p->x.pList ){
115033e619fcSdrh       nSize = EXPR_REDUCEDSIZE | EP_Reduced;
115133e619fcSdrh     }else{
1152aecd8021Sdrh       assert( p->pRight==0 );
115333e619fcSdrh       nSize = EXPR_TOKENONLYSIZE | EP_TokenOnly;
115433e619fcSdrh     }
11556ab3a2ecSdanielk1977   }
11566ab3a2ecSdanielk1977   return nSize;
11576ab3a2ecSdanielk1977 }
11586ab3a2ecSdanielk1977 
11596ab3a2ecSdanielk1977 /*
116033e619fcSdrh ** This function returns the space in bytes required to store the copy
116133e619fcSdrh ** of the Expr structure and a copy of the Expr.u.zToken string (if that
116233e619fcSdrh ** string is defined.)
11636ab3a2ecSdanielk1977 */
11646ab3a2ecSdanielk1977 static int dupedExprNodeSize(Expr *p, int flags){
116533e619fcSdrh   int nByte = dupedExprStructSize(p, flags) & 0xfff;
116633e619fcSdrh   if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
11677301e774Sdrh     nByte += sqlite3Strlen30NN(p->u.zToken)+1;
11686ab3a2ecSdanielk1977   }
1169bc73971dSdanielk1977   return ROUND8(nByte);
11706ab3a2ecSdanielk1977 }
11716ab3a2ecSdanielk1977 
11726ab3a2ecSdanielk1977 /*
11736ab3a2ecSdanielk1977 ** Return the number of bytes required to create a duplicate of the
11746ab3a2ecSdanielk1977 ** expression passed as the first argument. The second argument is a
11756ab3a2ecSdanielk1977 ** mask containing EXPRDUP_XXX flags.
11766ab3a2ecSdanielk1977 **
11776ab3a2ecSdanielk1977 ** The value returned includes space to create a copy of the Expr struct
117833e619fcSdrh ** itself and the buffer referred to by Expr.u.zToken, if any.
11796ab3a2ecSdanielk1977 **
11806ab3a2ecSdanielk1977 ** If the EXPRDUP_REDUCE flag is set, then the return value includes
11816ab3a2ecSdanielk1977 ** space to duplicate all Expr nodes in the tree formed by Expr.pLeft
11826ab3a2ecSdanielk1977 ** and Expr.pRight variables (but not for any structures pointed to or
11836ab3a2ecSdanielk1977 ** descended from the Expr.x.pList or Expr.x.pSelect variables).
11846ab3a2ecSdanielk1977 */
11856ab3a2ecSdanielk1977 static int dupedExprSize(Expr *p, int flags){
11866ab3a2ecSdanielk1977   int nByte = 0;
11876ab3a2ecSdanielk1977   if( p ){
11886ab3a2ecSdanielk1977     nByte = dupedExprNodeSize(p, flags);
11896ab3a2ecSdanielk1977     if( flags&EXPRDUP_REDUCE ){
1190b7916a78Sdrh       nByte += dupedExprSize(p->pLeft, flags) + dupedExprSize(p->pRight, flags);
11916ab3a2ecSdanielk1977     }
11926ab3a2ecSdanielk1977   }
11936ab3a2ecSdanielk1977   return nByte;
11946ab3a2ecSdanielk1977 }
11956ab3a2ecSdanielk1977 
11966ab3a2ecSdanielk1977 /*
11976ab3a2ecSdanielk1977 ** This function is similar to sqlite3ExprDup(), except that if pzBuffer
11986ab3a2ecSdanielk1977 ** is not NULL then *pzBuffer is assumed to point to a buffer large enough
119933e619fcSdrh ** to store the copy of expression p, the copies of p->u.zToken
12006ab3a2ecSdanielk1977 ** (if applicable), and the copies of the p->pLeft and p->pRight expressions,
120160ec914cSpeter.d.reid ** if any. Before returning, *pzBuffer is set to the first byte past the
12026ab3a2ecSdanielk1977 ** portion of the buffer copied into by this function.
12036ab3a2ecSdanielk1977 */
12043c19469cSdrh static Expr *exprDup(sqlite3 *db, Expr *p, int dupFlags, u8 **pzBuffer){
12053c19469cSdrh   Expr *pNew;           /* Value to return */
12063c19469cSdrh   u8 *zAlloc;           /* Memory space from which to build Expr object */
12073c19469cSdrh   u32 staticFlag;       /* EP_Static if space not obtained from malloc */
12086ab3a2ecSdanielk1977 
12093c19469cSdrh   assert( db!=0 );
12103c19469cSdrh   assert( p );
12113c19469cSdrh   assert( dupFlags==0 || dupFlags==EXPRDUP_REDUCE );
12123c19469cSdrh   assert( pzBuffer==0 || dupFlags==EXPRDUP_REDUCE );
12136ab3a2ecSdanielk1977 
12146ab3a2ecSdanielk1977   /* Figure out where to write the new Expr structure. */
12156ab3a2ecSdanielk1977   if( pzBuffer ){
12166ab3a2ecSdanielk1977     zAlloc = *pzBuffer;
121733e619fcSdrh     staticFlag = EP_Static;
12186ab3a2ecSdanielk1977   }else{
12193c19469cSdrh     zAlloc = sqlite3DbMallocRawNN(db, dupedExprSize(p, dupFlags));
12203c19469cSdrh     staticFlag = 0;
12216ab3a2ecSdanielk1977   }
12226ab3a2ecSdanielk1977   pNew = (Expr *)zAlloc;
12236ab3a2ecSdanielk1977 
12246ab3a2ecSdanielk1977   if( pNew ){
12256ab3a2ecSdanielk1977     /* Set nNewSize to the size allocated for the structure pointed to
12266ab3a2ecSdanielk1977     ** by pNew. This is either EXPR_FULLSIZE, EXPR_REDUCEDSIZE or
12276ab3a2ecSdanielk1977     ** EXPR_TOKENONLYSIZE. nToken is set to the number of bytes consumed
122833e619fcSdrh     ** by the copy of the p->u.zToken string (if any).
12296ab3a2ecSdanielk1977     */
12303c19469cSdrh     const unsigned nStructSize = dupedExprStructSize(p, dupFlags);
123133e619fcSdrh     const int nNewSize = nStructSize & 0xfff;
123233e619fcSdrh     int nToken;
123333e619fcSdrh     if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
123433e619fcSdrh       nToken = sqlite3Strlen30(p->u.zToken) + 1;
123533e619fcSdrh     }else{
123633e619fcSdrh       nToken = 0;
123733e619fcSdrh     }
12383c19469cSdrh     if( dupFlags ){
12396ab3a2ecSdanielk1977       assert( ExprHasProperty(p, EP_Reduced)==0 );
12406ab3a2ecSdanielk1977       memcpy(zAlloc, p, nNewSize);
12416ab3a2ecSdanielk1977     }else{
12423e6a1411Sdan       u32 nSize = (u32)exprStructSize(p);
12436ab3a2ecSdanielk1977       memcpy(zAlloc, p, nSize);
124472ea29d7Sdrh       if( nSize<EXPR_FULLSIZE ){
12456ab3a2ecSdanielk1977         memset(&zAlloc[nSize], 0, EXPR_FULLSIZE-nSize);
12466ab3a2ecSdanielk1977       }
124772ea29d7Sdrh     }
12486ab3a2ecSdanielk1977 
124933e619fcSdrh     /* Set the EP_Reduced, EP_TokenOnly, and EP_Static flags appropriately. */
1250c5cd1249Sdrh     pNew->flags &= ~(EP_Reduced|EP_TokenOnly|EP_Static|EP_MemToken);
125133e619fcSdrh     pNew->flags |= nStructSize & (EP_Reduced|EP_TokenOnly);
125233e619fcSdrh     pNew->flags |= staticFlag;
12536ab3a2ecSdanielk1977 
125433e619fcSdrh     /* Copy the p->u.zToken string, if any. */
12556ab3a2ecSdanielk1977     if( nToken ){
125633e619fcSdrh       char *zToken = pNew->u.zToken = (char*)&zAlloc[nNewSize];
125733e619fcSdrh       memcpy(zToken, p->u.zToken, nToken);
12586ab3a2ecSdanielk1977     }
12596ab3a2ecSdanielk1977 
1260209bc522Sdrh     if( 0==((p->flags|pNew->flags) & (EP_TokenOnly|EP_Leaf)) ){
12616ab3a2ecSdanielk1977       /* Fill in the pNew->x.pSelect or pNew->x.pList member. */
12626ab3a2ecSdanielk1977       if( ExprHasProperty(p, EP_xIsSelect) ){
12633c19469cSdrh         pNew->x.pSelect = sqlite3SelectDup(db, p->x.pSelect, dupFlags);
12646ab3a2ecSdanielk1977       }else{
12653c19469cSdrh         pNew->x.pList = sqlite3ExprListDup(db, p->x.pList, dupFlags);
12666ab3a2ecSdanielk1977       }
12676ab3a2ecSdanielk1977     }
12686ab3a2ecSdanielk1977 
12696ab3a2ecSdanielk1977     /* Fill in pNew->pLeft and pNew->pRight. */
1270*4f9adee2Sdan     if( ExprHasProperty(pNew, EP_Reduced|EP_TokenOnly|EP_WinFunc) ){
12713c19469cSdrh       zAlloc += dupedExprNodeSize(p, dupFlags);
1272209bc522Sdrh       if( !ExprHasProperty(pNew, EP_TokenOnly|EP_Leaf) ){
12733c19469cSdrh         pNew->pLeft = p->pLeft ?
12743c19469cSdrh                       exprDup(db, p->pLeft, EXPRDUP_REDUCE, &zAlloc) : 0;
12753c19469cSdrh         pNew->pRight = p->pRight ?
12763c19469cSdrh                        exprDup(db, p->pRight, EXPRDUP_REDUCE, &zAlloc) : 0;
12776ab3a2ecSdanielk1977       }
127867a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
1279eda079cdSdrh       if( ExprHasProperty(p, EP_WinFunc) ){
1280eda079cdSdrh         pNew->y.pWin = sqlite3WindowDup(db, pNew, p->y.pWin);
1281eda079cdSdrh         assert( ExprHasProperty(pNew, EP_WinFunc) );
1282e2f781b9Sdan       }
128367a9b8edSdan #endif /* SQLITE_OMIT_WINDOWFUNC */
128453988068Sdrh       if( pzBuffer ){
128553988068Sdrh         *pzBuffer = zAlloc;
128653988068Sdrh       }
128753988068Sdrh     }else{
1288209bc522Sdrh       if( !ExprHasProperty(p, EP_TokenOnly|EP_Leaf) ){
12899854260bSdrh         if( pNew->op==TK_SELECT_COLUMN ){
12909854260bSdrh           pNew->pLeft = p->pLeft;
129147073f62Sdrh           assert( p->iColumn==0 || p->pRight==0 );
129247073f62Sdrh           assert( p->pRight==0  || p->pRight==p->pLeft );
12939854260bSdrh         }else{
12946ab3a2ecSdanielk1977           pNew->pLeft = sqlite3ExprDup(db, p->pLeft, 0);
12959854260bSdrh         }
12966ab3a2ecSdanielk1977         pNew->pRight = sqlite3ExprDup(db, p->pRight, 0);
12976ab3a2ecSdanielk1977       }
12986ab3a2ecSdanielk1977     }
12996ab3a2ecSdanielk1977   }
13006ab3a2ecSdanielk1977   return pNew;
13016ab3a2ecSdanielk1977 }
13026ab3a2ecSdanielk1977 
13036ab3a2ecSdanielk1977 /*
1304bfe31e7fSdan ** Create and return a deep copy of the object passed as the second
1305bfe31e7fSdan ** argument. If an OOM condition is encountered, NULL is returned
1306bfe31e7fSdan ** and the db->mallocFailed flag set.
1307bfe31e7fSdan */
1308eede6a53Sdan #ifndef SQLITE_OMIT_CTE
1309bfe31e7fSdan static With *withDup(sqlite3 *db, With *p){
13104e9119d9Sdan   With *pRet = 0;
13114e9119d9Sdan   if( p ){
1312d4de9f7bSdrh     sqlite3_int64 nByte = sizeof(*p) + sizeof(p->a[0]) * (p->nCte-1);
13134e9119d9Sdan     pRet = sqlite3DbMallocZero(db, nByte);
13144e9119d9Sdan     if( pRet ){
13154e9119d9Sdan       int i;
13164e9119d9Sdan       pRet->nCte = p->nCte;
13174e9119d9Sdan       for(i=0; i<p->nCte; i++){
13184e9119d9Sdan         pRet->a[i].pSelect = sqlite3SelectDup(db, p->a[i].pSelect, 0);
13194e9119d9Sdan         pRet->a[i].pCols = sqlite3ExprListDup(db, p->a[i].pCols, 0);
13204e9119d9Sdan         pRet->a[i].zName = sqlite3DbStrDup(db, p->a[i].zName);
13214e9119d9Sdan       }
13224e9119d9Sdan     }
13234e9119d9Sdan   }
13244e9119d9Sdan   return pRet;
13254e9119d9Sdan }
1326eede6a53Sdan #else
1327eede6a53Sdan # define withDup(x,y) 0
1328eede6a53Sdan #endif
13294e9119d9Sdan 
1330a8389975Sdrh #ifndef SQLITE_OMIT_WINDOWFUNC
1331a8389975Sdrh /*
1332a8389975Sdrh ** The gatherSelectWindows() procedure and its helper routine
1333a8389975Sdrh ** gatherSelectWindowsCallback() are used to scan all the expressions
1334a8389975Sdrh ** an a newly duplicated SELECT statement and gather all of the Window
1335a8389975Sdrh ** objects found there, assembling them onto the linked list at Select->pWin.
1336a8389975Sdrh */
1337a8389975Sdrh static int gatherSelectWindowsCallback(Walker *pWalker, Expr *pExpr){
13386ba7ab0dSdan   if( pExpr->op==TK_FUNCTION && ExprHasProperty(pExpr, EP_WinFunc) ){
13396ba7ab0dSdan     assert( pExpr->y.pWin );
1340*4f9adee2Sdan     assert( IsWindowFunc(pExpr) );
1341a8389975Sdrh     pExpr->y.pWin->pNextWin = pWalker->u.pSelect->pWin;
1342a8389975Sdrh     pWalker->u.pSelect->pWin = pExpr->y.pWin;
1343a8389975Sdrh   }
1344a8389975Sdrh   return WRC_Continue;
1345a8389975Sdrh }
1346a37b6a5eSdrh static int gatherSelectWindowsSelectCallback(Walker *pWalker, Select *p){
1347a37b6a5eSdrh   return p==pWalker->u.pSelect ? WRC_Continue : WRC_Prune;
1348a37b6a5eSdrh }
1349a8389975Sdrh static void gatherSelectWindows(Select *p){
1350a8389975Sdrh   Walker w;
1351a8389975Sdrh   w.xExprCallback = gatherSelectWindowsCallback;
1352a37b6a5eSdrh   w.xSelectCallback = gatherSelectWindowsSelectCallback;
1353a37b6a5eSdrh   w.xSelectCallback2 = 0;
13549c46c66cSdrh   w.pParse = 0;
1355a8389975Sdrh   w.u.pSelect = p;
1356a37b6a5eSdrh   sqlite3WalkSelect(&w, p);
1357a8389975Sdrh }
1358a8389975Sdrh #endif
1359a8389975Sdrh 
1360a8389975Sdrh 
1361a76b5dfcSdrh /*
1362ff78bd2fSdrh ** The following group of routines make deep copies of expressions,
1363ff78bd2fSdrh ** expression lists, ID lists, and select statements.  The copies can
1364ff78bd2fSdrh ** be deleted (by being passed to their respective ...Delete() routines)
1365ff78bd2fSdrh ** without effecting the originals.
1366ff78bd2fSdrh **
13674adee20fSdanielk1977 ** The expression list, ID, and source lists return by sqlite3ExprListDup(),
13684adee20fSdanielk1977 ** sqlite3IdListDup(), and sqlite3SrcListDup() can not be further expanded
1369ad3cab52Sdrh ** by subsequent calls to sqlite*ListAppend() routines.
1370ff78bd2fSdrh **
1371ad3cab52Sdrh ** Any tables that the SrcList might point to are not duplicated.
13726ab3a2ecSdanielk1977 **
1373b7916a78Sdrh ** The flags parameter contains a combination of the EXPRDUP_XXX flags.
13746ab3a2ecSdanielk1977 ** If the EXPRDUP_REDUCE flag is set, then the structure returned is a
13756ab3a2ecSdanielk1977 ** truncated version of the usual Expr structure that will be stored as
13766ab3a2ecSdanielk1977 ** part of the in-memory representation of the database schema.
1377ff78bd2fSdrh */
13786ab3a2ecSdanielk1977 Expr *sqlite3ExprDup(sqlite3 *db, Expr *p, int flags){
137972ea29d7Sdrh   assert( flags==0 || flags==EXPRDUP_REDUCE );
13803c19469cSdrh   return p ? exprDup(db, p, flags, 0) : 0;
1381ff78bd2fSdrh }
13826ab3a2ecSdanielk1977 ExprList *sqlite3ExprListDup(sqlite3 *db, ExprList *p, int flags){
1383ff78bd2fSdrh   ExprList *pNew;
1384145716b3Sdrh   struct ExprList_item *pItem, *pOldItem;
1385ff78bd2fSdrh   int i;
1386b163748eSdrh   Expr *pPriorSelectCol = 0;
1387575fad65Sdrh   assert( db!=0 );
1388ff78bd2fSdrh   if( p==0 ) return 0;
138997258194Sdrh   pNew = sqlite3DbMallocRawNN(db, sqlite3DbMallocSize(db, p));
1390ff78bd2fSdrh   if( pNew==0 ) return 0;
1391a19543feSdrh   pNew->nExpr = p->nExpr;
139243606175Sdrh   pItem = pNew->a;
1393145716b3Sdrh   pOldItem = p->a;
1394145716b3Sdrh   for(i=0; i<p->nExpr; i++, pItem++, pOldItem++){
13956ab3a2ecSdanielk1977     Expr *pOldExpr = pOldItem->pExpr;
139647073f62Sdrh     Expr *pNewExpr;
1397b5526ea6Sdrh     pItem->pExpr = sqlite3ExprDup(db, pOldExpr, flags);
139847073f62Sdrh     if( pOldExpr
139947073f62Sdrh      && pOldExpr->op==TK_SELECT_COLUMN
140047073f62Sdrh      && (pNewExpr = pItem->pExpr)!=0
140147073f62Sdrh     ){
140247073f62Sdrh       assert( pNewExpr->iColumn==0 || i>0 );
140347073f62Sdrh       if( pNewExpr->iColumn==0 ){
140447073f62Sdrh         assert( pOldExpr->pLeft==pOldExpr->pRight );
1405b163748eSdrh         pPriorSelectCol = pNewExpr->pLeft = pNewExpr->pRight;
1406b163748eSdrh       }else{
1407b163748eSdrh         assert( i>0 );
1408b163748eSdrh         assert( pItem[-1].pExpr!=0 );
1409b163748eSdrh         assert( pNewExpr->iColumn==pItem[-1].pExpr->iColumn+1 );
1410b163748eSdrh         assert( pPriorSelectCol==pItem[-1].pExpr->pLeft );
1411b163748eSdrh         pNewExpr->pLeft = pPriorSelectCol;
141247073f62Sdrh       }
141347073f62Sdrh     }
141417435752Sdrh     pItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
1415b7916a78Sdrh     pItem->zSpan = sqlite3DbStrDup(db, pOldItem->zSpan);
1416145716b3Sdrh     pItem->sortOrder = pOldItem->sortOrder;
14173e7bc9caSdrh     pItem->done = 0;
14182c036cffSdrh     pItem->bSpanIsTab = pOldItem->bSpanIsTab;
141924e25d32Sdan     pItem->bSorterRef = pOldItem->bSorterRef;
1420c2acc4e4Sdrh     pItem->u = pOldItem->u;
1421ff78bd2fSdrh   }
1422ff78bd2fSdrh   return pNew;
1423ff78bd2fSdrh }
142493758c8dSdanielk1977 
142593758c8dSdanielk1977 /*
142693758c8dSdanielk1977 ** If cursors, triggers, views and subqueries are all omitted from
142793758c8dSdanielk1977 ** the build, then none of the following routines, except for
142893758c8dSdanielk1977 ** sqlite3SelectDup(), can be called. sqlite3SelectDup() is sometimes
142993758c8dSdanielk1977 ** called with a NULL argument.
143093758c8dSdanielk1977 */
14316a67fe8eSdanielk1977 #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_TRIGGER) \
14326a67fe8eSdanielk1977  || !defined(SQLITE_OMIT_SUBQUERY)
14336ab3a2ecSdanielk1977 SrcList *sqlite3SrcListDup(sqlite3 *db, SrcList *p, int flags){
1434ad3cab52Sdrh   SrcList *pNew;
1435ad3cab52Sdrh   int i;
1436113088ecSdrh   int nByte;
1437575fad65Sdrh   assert( db!=0 );
1438ad3cab52Sdrh   if( p==0 ) return 0;
1439113088ecSdrh   nByte = sizeof(*p) + (p->nSrc>0 ? sizeof(p->a[0]) * (p->nSrc-1) : 0);
1440575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, nByte );
1441ad3cab52Sdrh   if( pNew==0 ) return 0;
14424305d103Sdrh   pNew->nSrc = pNew->nAlloc = p->nSrc;
1443ad3cab52Sdrh   for(i=0; i<p->nSrc; i++){
14444efc4754Sdrh     struct SrcList_item *pNewItem = &pNew->a[i];
14454efc4754Sdrh     struct SrcList_item *pOldItem = &p->a[i];
1446ed8a3bb1Sdrh     Table *pTab;
144741fb5cd1Sdan     pNewItem->pSchema = pOldItem->pSchema;
144817435752Sdrh     pNewItem->zDatabase = sqlite3DbStrDup(db, pOldItem->zDatabase);
144917435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
145017435752Sdrh     pNewItem->zAlias = sqlite3DbStrDup(db, pOldItem->zAlias);
14518a48b9c0Sdrh     pNewItem->fg = pOldItem->fg;
14524efc4754Sdrh     pNewItem->iCursor = pOldItem->iCursor;
14535b6a9ed4Sdrh     pNewItem->addrFillSub = pOldItem->addrFillSub;
14545b6a9ed4Sdrh     pNewItem->regReturn = pOldItem->regReturn;
14558a48b9c0Sdrh     if( pNewItem->fg.isIndexedBy ){
14568a48b9c0Sdrh       pNewItem->u1.zIndexedBy = sqlite3DbStrDup(db, pOldItem->u1.zIndexedBy);
14578a48b9c0Sdrh     }
14588a48b9c0Sdrh     pNewItem->pIBIndex = pOldItem->pIBIndex;
14598a48b9c0Sdrh     if( pNewItem->fg.isTabFunc ){
14608a48b9c0Sdrh       pNewItem->u1.pFuncArg =
14618a48b9c0Sdrh           sqlite3ExprListDup(db, pOldItem->u1.pFuncArg, flags);
14628a48b9c0Sdrh     }
1463ed8a3bb1Sdrh     pTab = pNewItem->pTab = pOldItem->pTab;
1464ed8a3bb1Sdrh     if( pTab ){
146579df7782Sdrh       pTab->nTabRef++;
1466a1cb183dSdanielk1977     }
14676ab3a2ecSdanielk1977     pNewItem->pSelect = sqlite3SelectDup(db, pOldItem->pSelect, flags);
14686ab3a2ecSdanielk1977     pNewItem->pOn = sqlite3ExprDup(db, pOldItem->pOn, flags);
146917435752Sdrh     pNewItem->pUsing = sqlite3IdListDup(db, pOldItem->pUsing);
14706c18b6e0Sdanielk1977     pNewItem->colUsed = pOldItem->colUsed;
1471ad3cab52Sdrh   }
1472ad3cab52Sdrh   return pNew;
1473ad3cab52Sdrh }
147417435752Sdrh IdList *sqlite3IdListDup(sqlite3 *db, IdList *p){
1475ff78bd2fSdrh   IdList *pNew;
1476ff78bd2fSdrh   int i;
1477575fad65Sdrh   assert( db!=0 );
1478ff78bd2fSdrh   if( p==0 ) return 0;
1479575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, sizeof(*pNew) );
1480ff78bd2fSdrh   if( pNew==0 ) return 0;
14816c535158Sdrh   pNew->nId = p->nId;
1482575fad65Sdrh   pNew->a = sqlite3DbMallocRawNN(db, p->nId*sizeof(p->a[0]) );
1483d5d56523Sdanielk1977   if( pNew->a==0 ){
1484dbd6a7dcSdrh     sqlite3DbFreeNN(db, pNew);
1485d5d56523Sdanielk1977     return 0;
1486d5d56523Sdanielk1977   }
14876c535158Sdrh   /* Note that because the size of the allocation for p->a[] is not
14886c535158Sdrh   ** necessarily a power of two, sqlite3IdListAppend() may not be called
14896c535158Sdrh   ** on the duplicate created by this function. */
1490ff78bd2fSdrh   for(i=0; i<p->nId; i++){
14914efc4754Sdrh     struct IdList_item *pNewItem = &pNew->a[i];
14924efc4754Sdrh     struct IdList_item *pOldItem = &p->a[i];
149317435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
14944efc4754Sdrh     pNewItem->idx = pOldItem->idx;
1495ff78bd2fSdrh   }
1496ff78bd2fSdrh   return pNew;
1497ff78bd2fSdrh }
1498a7466205Sdan Select *sqlite3SelectDup(sqlite3 *db, Select *pDup, int flags){
1499a7466205Sdan   Select *pRet = 0;
1500a7466205Sdan   Select *pNext = 0;
1501a7466205Sdan   Select **pp = &pRet;
1502a7466205Sdan   Select *p;
1503a7466205Sdan 
1504575fad65Sdrh   assert( db!=0 );
1505a7466205Sdan   for(p=pDup; p; p=p->pPrior){
1506a7466205Sdan     Select *pNew = sqlite3DbMallocRawNN(db, sizeof(*p) );
1507a7466205Sdan     if( pNew==0 ) break;
1508b7916a78Sdrh     pNew->pEList = sqlite3ExprListDup(db, p->pEList, flags);
15096ab3a2ecSdanielk1977     pNew->pSrc = sqlite3SrcListDup(db, p->pSrc, flags);
15106ab3a2ecSdanielk1977     pNew->pWhere = sqlite3ExprDup(db, p->pWhere, flags);
15116ab3a2ecSdanielk1977     pNew->pGroupBy = sqlite3ExprListDup(db, p->pGroupBy, flags);
15126ab3a2ecSdanielk1977     pNew->pHaving = sqlite3ExprDup(db, p->pHaving, flags);
15136ab3a2ecSdanielk1977     pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, flags);
1514ff78bd2fSdrh     pNew->op = p->op;
1515a7466205Sdan     pNew->pNext = pNext;
1516a7466205Sdan     pNew->pPrior = 0;
15176ab3a2ecSdanielk1977     pNew->pLimit = sqlite3ExprDup(db, p->pLimit, flags);
151892b01d53Sdrh     pNew->iLimit = 0;
151992b01d53Sdrh     pNew->iOffset = 0;
15207d10d5a6Sdrh     pNew->selFlags = p->selFlags & ~SF_UsesEphemeral;
1521b9bb7c18Sdrh     pNew->addrOpenEphm[0] = -1;
1522b9bb7c18Sdrh     pNew->addrOpenEphm[1] = -1;
1523ec2da854Sdrh     pNew->nSelectRow = p->nSelectRow;
15244e9119d9Sdan     pNew->pWith = withDup(db, p->pWith);
152567a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
15262e362f97Sdan     pNew->pWin = 0;
1527c95f38d4Sdan     pNew->pWinDefn = sqlite3WindowListDup(db, p->pWinDefn);
1528a8389975Sdrh     if( p->pWin ) gatherSelectWindows(pNew);
152967a9b8edSdan #endif
1530fef37760Sdrh     pNew->selId = p->selId;
1531a7466205Sdan     *pp = pNew;
1532a7466205Sdan     pp = &pNew->pPrior;
1533a7466205Sdan     pNext = pNew;
1534a7466205Sdan   }
1535a7466205Sdan 
1536a7466205Sdan   return pRet;
1537ff78bd2fSdrh }
153893758c8dSdanielk1977 #else
15396ab3a2ecSdanielk1977 Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
154093758c8dSdanielk1977   assert( p==0 );
154193758c8dSdanielk1977   return 0;
154293758c8dSdanielk1977 }
154393758c8dSdanielk1977 #endif
1544ff78bd2fSdrh 
1545ff78bd2fSdrh 
1546ff78bd2fSdrh /*
1547a76b5dfcSdrh ** Add a new element to the end of an expression list.  If pList is
1548a76b5dfcSdrh ** initially NULL, then create a new expression list.
1549b7916a78Sdrh **
1550a19543feSdrh ** The pList argument must be either NULL or a pointer to an ExprList
1551a19543feSdrh ** obtained from a prior call to sqlite3ExprListAppend().  This routine
1552a19543feSdrh ** may not be used with an ExprList obtained from sqlite3ExprListDup().
1553a19543feSdrh ** Reason:  This routine assumes that the number of slots in pList->a[]
1554a19543feSdrh ** is a power of two.  That is true for sqlite3ExprListAppend() returns
1555a19543feSdrh ** but is not necessarily true from the return value of sqlite3ExprListDup().
1556a19543feSdrh **
1557b7916a78Sdrh ** If a memory allocation error occurs, the entire list is freed and
1558b7916a78Sdrh ** NULL is returned.  If non-NULL is returned, then it is guaranteed
1559b7916a78Sdrh ** that the new entry was successfully appended.
1560a76b5dfcSdrh */
156117435752Sdrh ExprList *sqlite3ExprListAppend(
156217435752Sdrh   Parse *pParse,          /* Parsing context */
156317435752Sdrh   ExprList *pList,        /* List to which to append. Might be NULL */
1564b7916a78Sdrh   Expr *pExpr             /* Expression to be appended. Might be NULL */
156517435752Sdrh ){
156643606175Sdrh   struct ExprList_item *pItem;
156717435752Sdrh   sqlite3 *db = pParse->db;
1568575fad65Sdrh   assert( db!=0 );
1569a76b5dfcSdrh   if( pList==0 ){
1570575fad65Sdrh     pList = sqlite3DbMallocRawNN(db, sizeof(ExprList) );
1571a76b5dfcSdrh     if( pList==0 ){
1572d5d56523Sdanielk1977       goto no_mem;
1573a76b5dfcSdrh     }
1574c263f7c4Sdrh     pList->nExpr = 0;
1575a19543feSdrh   }else if( (pList->nExpr & (pList->nExpr-1))==0 ){
157643606175Sdrh     ExprList *pNew;
157743606175Sdrh     pNew = sqlite3DbRealloc(db, pList,
15780aa3231fSdrh          sizeof(*pList)+(2*(sqlite3_int64)pList->nExpr-1)*sizeof(pList->a[0]));
157943606175Sdrh     if( pNew==0 ){
1580d5d56523Sdanielk1977       goto no_mem;
1581a76b5dfcSdrh     }
158243606175Sdrh     pList = pNew;
1583a76b5dfcSdrh   }
158443606175Sdrh   pItem = &pList->a[pList->nExpr++];
1585a8b9793cSdrh   assert( offsetof(struct ExprList_item,zName)==sizeof(pItem->pExpr) );
1586a8b9793cSdrh   assert( offsetof(struct ExprList_item,pExpr)==0 );
1587a8b9793cSdrh   memset(&pItem->zName,0,sizeof(*pItem)-offsetof(struct ExprList_item,zName));
1588e94ddc9eSdanielk1977   pItem->pExpr = pExpr;
1589a76b5dfcSdrh   return pList;
1590d5d56523Sdanielk1977 
1591d5d56523Sdanielk1977 no_mem:
1592d5d56523Sdanielk1977   /* Avoid leaking memory if malloc has failed. */
1593633e6d57Sdrh   sqlite3ExprDelete(db, pExpr);
1594633e6d57Sdrh   sqlite3ExprListDelete(db, pList);
1595d5d56523Sdanielk1977   return 0;
1596a76b5dfcSdrh }
1597a76b5dfcSdrh 
1598a76b5dfcSdrh /*
15998762ec19Sdrh ** pColumns and pExpr form a vector assignment which is part of the SET
16008762ec19Sdrh ** clause of an UPDATE statement.  Like this:
1601a1251bc4Sdrh **
1602a1251bc4Sdrh **        (a,b,c) = (expr1,expr2,expr3)
1603a1251bc4Sdrh ** Or:    (a,b,c) = (SELECT x,y,z FROM ....)
1604a1251bc4Sdrh **
1605a1251bc4Sdrh ** For each term of the vector assignment, append new entries to the
1606b67343d0Sdrh ** expression list pList.  In the case of a subquery on the RHS, append
1607a1251bc4Sdrh ** TK_SELECT_COLUMN expressions.
1608a1251bc4Sdrh */
1609a1251bc4Sdrh ExprList *sqlite3ExprListAppendVector(
1610a1251bc4Sdrh   Parse *pParse,         /* Parsing context */
1611a1251bc4Sdrh   ExprList *pList,       /* List to which to append. Might be NULL */
1612a1251bc4Sdrh   IdList *pColumns,      /* List of names of LHS of the assignment */
1613a1251bc4Sdrh   Expr *pExpr            /* Vector expression to be appended. Might be NULL */
1614a1251bc4Sdrh ){
1615a1251bc4Sdrh   sqlite3 *db = pParse->db;
1616a1251bc4Sdrh   int n;
1617a1251bc4Sdrh   int i;
161866860af3Sdrh   int iFirst = pList ? pList->nExpr : 0;
1619321e828dSdrh   /* pColumns can only be NULL due to an OOM but an OOM will cause an
1620321e828dSdrh   ** exit prior to this routine being invoked */
1621321e828dSdrh   if( NEVER(pColumns==0) ) goto vector_append_error;
1622a1251bc4Sdrh   if( pExpr==0 ) goto vector_append_error;
1623966e2911Sdrh 
1624966e2911Sdrh   /* If the RHS is a vector, then we can immediately check to see that
1625966e2911Sdrh   ** the size of the RHS and LHS match.  But if the RHS is a SELECT,
1626966e2911Sdrh   ** wildcards ("*") in the result set of the SELECT must be expanded before
1627966e2911Sdrh   ** we can do the size check, so defer the size check until code generation.
1628966e2911Sdrh   */
1629966e2911Sdrh   if( pExpr->op!=TK_SELECT && pColumns->nId!=(n=sqlite3ExprVectorSize(pExpr)) ){
1630a1251bc4Sdrh     sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
1631a1251bc4Sdrh                     pColumns->nId, n);
1632a1251bc4Sdrh     goto vector_append_error;
1633a1251bc4Sdrh   }
1634966e2911Sdrh 
1635966e2911Sdrh   for(i=0; i<pColumns->nId; i++){
1636a1251bc4Sdrh     Expr *pSubExpr = sqlite3ExprForVectorField(pParse, pExpr, i);
1637a1251bc4Sdrh     pList = sqlite3ExprListAppend(pParse, pList, pSubExpr);
1638a1251bc4Sdrh     if( pList ){
163966860af3Sdrh       assert( pList->nExpr==iFirst+i+1 );
1640a1251bc4Sdrh       pList->a[pList->nExpr-1].zName = pColumns->a[i].zName;
1641a1251bc4Sdrh       pColumns->a[i].zName = 0;
1642a1251bc4Sdrh     }
1643a1251bc4Sdrh   }
1644966e2911Sdrh 
1645ffe28059Sdrh   if( !db->mallocFailed && pExpr->op==TK_SELECT && ALWAYS(pList!=0) ){
1646966e2911Sdrh     Expr *pFirst = pList->a[iFirst].pExpr;
1647f4dd26c5Sdrh     assert( pFirst!=0 );
1648966e2911Sdrh     assert( pFirst->op==TK_SELECT_COLUMN );
1649966e2911Sdrh 
1650966e2911Sdrh     /* Store the SELECT statement in pRight so it will be deleted when
1651966e2911Sdrh     ** sqlite3ExprListDelete() is called */
1652966e2911Sdrh     pFirst->pRight = pExpr;
1653a1251bc4Sdrh     pExpr = 0;
1654966e2911Sdrh 
1655966e2911Sdrh     /* Remember the size of the LHS in iTable so that we can check that
1656966e2911Sdrh     ** the RHS and LHS sizes match during code generation. */
1657966e2911Sdrh     pFirst->iTable = pColumns->nId;
1658a1251bc4Sdrh   }
1659a1251bc4Sdrh 
1660a1251bc4Sdrh vector_append_error:
16618e34e406Sdrh   sqlite3ExprUnmapAndDelete(pParse, pExpr);
1662a1251bc4Sdrh   sqlite3IdListDelete(db, pColumns);
1663a1251bc4Sdrh   return pList;
1664a1251bc4Sdrh }
1665a1251bc4Sdrh 
1666a1251bc4Sdrh /*
1667bc622bc0Sdrh ** Set the sort order for the last element on the given ExprList.
1668bc622bc0Sdrh */
1669bc622bc0Sdrh void sqlite3ExprListSetSortOrder(ExprList *p, int iSortOrder){
1670bc622bc0Sdrh   if( p==0 ) return;
1671bc622bc0Sdrh   assert( SQLITE_SO_UNDEFINED<0 && SQLITE_SO_ASC>=0 && SQLITE_SO_DESC>0 );
1672bc622bc0Sdrh   assert( p->nExpr>0 );
1673bc622bc0Sdrh   if( iSortOrder<0 ){
1674bc622bc0Sdrh     assert( p->a[p->nExpr-1].sortOrder==SQLITE_SO_ASC );
1675bc622bc0Sdrh     return;
1676bc622bc0Sdrh   }
1677bc622bc0Sdrh   p->a[p->nExpr-1].sortOrder = (u8)iSortOrder;
1678bc622bc0Sdrh }
1679bc622bc0Sdrh 
1680bc622bc0Sdrh /*
1681b7916a78Sdrh ** Set the ExprList.a[].zName element of the most recently added item
1682b7916a78Sdrh ** on the expression list.
1683b7916a78Sdrh **
1684b7916a78Sdrh ** pList might be NULL following an OOM error.  But pName should never be
1685b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1686b7916a78Sdrh ** is set.
1687b7916a78Sdrh */
1688b7916a78Sdrh void sqlite3ExprListSetName(
1689b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1690b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
1691b7916a78Sdrh   Token *pName,           /* Name to be added */
1692b7916a78Sdrh   int dequote             /* True to cause the name to be dequoted */
1693b7916a78Sdrh ){
1694b7916a78Sdrh   assert( pList!=0 || pParse->db->mallocFailed!=0 );
1695b7916a78Sdrh   if( pList ){
1696b7916a78Sdrh     struct ExprList_item *pItem;
1697b7916a78Sdrh     assert( pList->nExpr>0 );
1698b7916a78Sdrh     pItem = &pList->a[pList->nExpr-1];
1699b7916a78Sdrh     assert( pItem->zName==0 );
1700b7916a78Sdrh     pItem->zName = sqlite3DbStrNDup(pParse->db, pName->z, pName->n);
1701244b9d6eSdrh     if( dequote ) sqlite3Dequote(pItem->zName);
1702c9461eccSdan     if( IN_RENAME_OBJECT ){
170307e95233Sdan       sqlite3RenameTokenMap(pParse, (void*)pItem->zName, pName);
17045be60c55Sdan     }
1705b7916a78Sdrh   }
1706b7916a78Sdrh }
1707b7916a78Sdrh 
1708b7916a78Sdrh /*
1709b7916a78Sdrh ** Set the ExprList.a[].zSpan element of the most recently added item
1710b7916a78Sdrh ** on the expression list.
1711b7916a78Sdrh **
1712b7916a78Sdrh ** pList might be NULL following an OOM error.  But pSpan should never be
1713b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1714b7916a78Sdrh ** is set.
1715b7916a78Sdrh */
1716b7916a78Sdrh void sqlite3ExprListSetSpan(
1717b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1718b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
17191be266baSdrh   const char *zStart,     /* Start of the span */
17201be266baSdrh   const char *zEnd        /* End of the span */
1721b7916a78Sdrh ){
1722b7916a78Sdrh   sqlite3 *db = pParse->db;
1723b7916a78Sdrh   assert( pList!=0 || db->mallocFailed!=0 );
1724b7916a78Sdrh   if( pList ){
1725b7916a78Sdrh     struct ExprList_item *pItem = &pList->a[pList->nExpr-1];
1726b7916a78Sdrh     assert( pList->nExpr>0 );
1727b7916a78Sdrh     sqlite3DbFree(db, pItem->zSpan);
17289b2e0435Sdrh     pItem->zSpan = sqlite3DbSpanDup(db, zStart, zEnd);
1729b7916a78Sdrh   }
1730b7916a78Sdrh }
1731b7916a78Sdrh 
1732b7916a78Sdrh /*
17337a15a4beSdanielk1977 ** If the expression list pEList contains more than iLimit elements,
17347a15a4beSdanielk1977 ** leave an error message in pParse.
17357a15a4beSdanielk1977 */
17367a15a4beSdanielk1977 void sqlite3ExprListCheckLength(
17377a15a4beSdanielk1977   Parse *pParse,
17387a15a4beSdanielk1977   ExprList *pEList,
17397a15a4beSdanielk1977   const char *zObject
17407a15a4beSdanielk1977 ){
1741b1a6c3c1Sdrh   int mx = pParse->db->aLimit[SQLITE_LIMIT_COLUMN];
1742c5499befSdrh   testcase( pEList && pEList->nExpr==mx );
1743c5499befSdrh   testcase( pEList && pEList->nExpr==mx+1 );
1744b1a6c3c1Sdrh   if( pEList && pEList->nExpr>mx ){
17457a15a4beSdanielk1977     sqlite3ErrorMsg(pParse, "too many columns in %s", zObject);
17467a15a4beSdanielk1977   }
17477a15a4beSdanielk1977 }
17487a15a4beSdanielk1977 
17497a15a4beSdanielk1977 /*
1750a76b5dfcSdrh ** Delete an entire expression list.
1751a76b5dfcSdrh */
1752affa855cSdrh static SQLITE_NOINLINE void exprListDeleteNN(sqlite3 *db, ExprList *pList){
1753ac48b751Sdrh   int i = pList->nExpr;
1754ac48b751Sdrh   struct ExprList_item *pItem =  pList->a;
1755ac48b751Sdrh   assert( pList->nExpr>0 );
1756ac48b751Sdrh   do{
1757633e6d57Sdrh     sqlite3ExprDelete(db, pItem->pExpr);
1758633e6d57Sdrh     sqlite3DbFree(db, pItem->zName);
1759b7916a78Sdrh     sqlite3DbFree(db, pItem->zSpan);
1760ac48b751Sdrh     pItem++;
1761ac48b751Sdrh   }while( --i>0 );
1762dbd6a7dcSdrh   sqlite3DbFreeNN(db, pList);
1763a76b5dfcSdrh }
1764affa855cSdrh void sqlite3ExprListDelete(sqlite3 *db, ExprList *pList){
1765affa855cSdrh   if( pList ) exprListDeleteNN(db, pList);
1766affa855cSdrh }
1767a76b5dfcSdrh 
1768a76b5dfcSdrh /*
17692308ed38Sdrh ** Return the bitwise-OR of all Expr.flags fields in the given
17702308ed38Sdrh ** ExprList.
1771885a5b03Sdrh */
17722308ed38Sdrh u32 sqlite3ExprListFlags(const ExprList *pList){
1773885a5b03Sdrh   int i;
17742308ed38Sdrh   u32 m = 0;
1775508e2d00Sdrh   assert( pList!=0 );
1776885a5b03Sdrh   for(i=0; i<pList->nExpr; i++){
1777d0c73053Sdrh      Expr *pExpr = pList->a[i].pExpr;
1778de845c2fSdrh      assert( pExpr!=0 );
1779de845c2fSdrh      m |= pExpr->flags;
1780885a5b03Sdrh   }
17812308ed38Sdrh   return m;
1782885a5b03Sdrh }
1783885a5b03Sdrh 
1784885a5b03Sdrh /*
17857e6f980bSdrh ** This is a SELECT-node callback for the expression walker that
17867e6f980bSdrh ** always "fails".  By "fail" in this case, we mean set
17877e6f980bSdrh ** pWalker->eCode to zero and abort.
17887e6f980bSdrh **
17897e6f980bSdrh ** This callback is used by multiple expression walkers.
17907e6f980bSdrh */
17917e6f980bSdrh int sqlite3SelectWalkFail(Walker *pWalker, Select *NotUsed){
17927e6f980bSdrh   UNUSED_PARAMETER(NotUsed);
17937e6f980bSdrh   pWalker->eCode = 0;
17947e6f980bSdrh   return WRC_Abort;
17957e6f980bSdrh }
17967e6f980bSdrh 
17977e6f980bSdrh /*
1798171d16bbSdrh ** If the input expression is an ID with the name "true" or "false"
179996acafbeSdrh ** then convert it into an TK_TRUEFALSE term.  Return non-zero if
180096acafbeSdrh ** the conversion happened, and zero if the expression is unaltered.
1801171d16bbSdrh */
1802171d16bbSdrh int sqlite3ExprIdToTrueFalse(Expr *pExpr){
1803171d16bbSdrh   assert( pExpr->op==TK_ID || pExpr->op==TK_STRING );
180451d35b0fSdrh   if( !ExprHasProperty(pExpr, EP_Quoted)
180551d35b0fSdrh    && (sqlite3StrICmp(pExpr->u.zToken, "true")==0
180651d35b0fSdrh        || sqlite3StrICmp(pExpr->u.zToken, "false")==0)
1807171d16bbSdrh   ){
1808171d16bbSdrh     pExpr->op = TK_TRUEFALSE;
1809ad31727fSdrh     ExprSetProperty(pExpr, pExpr->u.zToken[4]==0 ? EP_IsTrue : EP_IsFalse);
1810171d16bbSdrh     return 1;
1811171d16bbSdrh   }
1812171d16bbSdrh   return 0;
1813171d16bbSdrh }
1814171d16bbSdrh 
181543c4ac8bSdrh /*
181696acafbeSdrh ** The argument must be a TK_TRUEFALSE Expr node.  Return 1 if it is TRUE
181743c4ac8bSdrh ** and 0 if it is FALSE.
181843c4ac8bSdrh */
181996acafbeSdrh int sqlite3ExprTruthValue(const Expr *pExpr){
18206ece353fSdan   pExpr = sqlite3ExprSkipCollate((Expr*)pExpr);
182143c4ac8bSdrh   assert( pExpr->op==TK_TRUEFALSE );
182243c4ac8bSdrh   assert( sqlite3StrICmp(pExpr->u.zToken,"true")==0
182343c4ac8bSdrh        || sqlite3StrICmp(pExpr->u.zToken,"false")==0 );
182443c4ac8bSdrh   return pExpr->u.zToken[4]==0;
182543c4ac8bSdrh }
182643c4ac8bSdrh 
182717180fcaSdrh /*
182817180fcaSdrh ** If pExpr is an AND or OR expression, try to simplify it by eliminating
182917180fcaSdrh ** terms that are always true or false.  Return the simplified expression.
183017180fcaSdrh ** Or return the original expression if no simplification is possible.
183117180fcaSdrh **
183217180fcaSdrh ** Examples:
183317180fcaSdrh **
183417180fcaSdrh **     (x<10) AND true                =>   (x<10)
183517180fcaSdrh **     (x<10) AND false               =>   false
183617180fcaSdrh **     (x<10) AND (y=22 OR false)     =>   (x<10) AND (y=22)
183717180fcaSdrh **     (x<10) AND (y=22 OR true)      =>   (x<10)
183817180fcaSdrh **     (y=22) OR true                 =>   true
183917180fcaSdrh */
184017180fcaSdrh Expr *sqlite3ExprSimplifiedAndOr(Expr *pExpr){
184117180fcaSdrh   assert( pExpr!=0 );
184217180fcaSdrh   if( pExpr->op==TK_AND || pExpr->op==TK_OR ){
184317180fcaSdrh     Expr *pRight = sqlite3ExprSimplifiedAndOr(pExpr->pRight);
184417180fcaSdrh     Expr *pLeft = sqlite3ExprSimplifiedAndOr(pExpr->pLeft);
184517180fcaSdrh     if( ExprAlwaysTrue(pLeft) || ExprAlwaysFalse(pRight) ){
184617180fcaSdrh       pExpr = pExpr->op==TK_AND ? pRight : pLeft;
184717180fcaSdrh     }else if( ExprAlwaysTrue(pRight) || ExprAlwaysFalse(pLeft) ){
184817180fcaSdrh       pExpr = pExpr->op==TK_AND ? pLeft : pRight;
184917180fcaSdrh     }
185017180fcaSdrh   }
185117180fcaSdrh   return pExpr;
185217180fcaSdrh }
185317180fcaSdrh 
1854171d16bbSdrh 
1855171d16bbSdrh /*
1856059b2d50Sdrh ** These routines are Walker callbacks used to check expressions to
1857059b2d50Sdrh ** see if they are "constant" for some definition of constant.  The
1858059b2d50Sdrh ** Walker.eCode value determines the type of "constant" we are looking
1859059b2d50Sdrh ** for.
186073b211abSdrh **
18617d10d5a6Sdrh ** These callback routines are used to implement the following:
1862626a879aSdrh **
1863059b2d50Sdrh **     sqlite3ExprIsConstant()                  pWalker->eCode==1
1864059b2d50Sdrh **     sqlite3ExprIsConstantNotJoin()           pWalker->eCode==2
1865fcb9f4f3Sdrh **     sqlite3ExprIsTableConstant()             pWalker->eCode==3
1866059b2d50Sdrh **     sqlite3ExprIsConstantOrFunction()        pWalker->eCode==4 or 5
186787abf5c0Sdrh **
1868059b2d50Sdrh ** In all cases, the callbacks set Walker.eCode=0 and abort if the expression
1869059b2d50Sdrh ** is found to not be a constant.
187087abf5c0Sdrh **
1871feada2dfSdrh ** The sqlite3ExprIsConstantOrFunction() is used for evaluating expressions
1872059b2d50Sdrh ** in a CREATE TABLE statement.  The Walker.eCode value is 5 when parsing
1873059b2d50Sdrh ** an existing schema and 4 when processing a new statement.  A bound
1874feada2dfSdrh ** parameter raises an error for new statements, but is silently converted
1875feada2dfSdrh ** to NULL for existing schemas.  This allows sqlite_master tables that
1876feada2dfSdrh ** contain a bound parameter because they were generated by older versions
1877feada2dfSdrh ** of SQLite to be parsed by newer versions of SQLite without raising a
1878feada2dfSdrh ** malformed schema error.
1879626a879aSdrh */
18807d10d5a6Sdrh static int exprNodeIsConstant(Walker *pWalker, Expr *pExpr){
1881626a879aSdrh 
1882059b2d50Sdrh   /* If pWalker->eCode is 2 then any term of the expression that comes from
1883059b2d50Sdrh   ** the ON or USING clauses of a left join disqualifies the expression
18840a168377Sdrh   ** from being considered constant. */
1885059b2d50Sdrh   if( pWalker->eCode==2 && ExprHasProperty(pExpr, EP_FromJoin) ){
1886059b2d50Sdrh     pWalker->eCode = 0;
18877d10d5a6Sdrh     return WRC_Abort;
18880a168377Sdrh   }
18890a168377Sdrh 
1890626a879aSdrh   switch( pExpr->op ){
1891eb55bd2fSdrh     /* Consider functions to be constant if all their arguments are constant
1892059b2d50Sdrh     ** and either pWalker->eCode==4 or 5 or the function has the
1893059b2d50Sdrh     ** SQLITE_FUNC_CONST flag. */
1894eb55bd2fSdrh     case TK_FUNCTION:
189563f84573Sdrh       if( pWalker->eCode>=4 || ExprHasProperty(pExpr,EP_ConstFunc) ){
1896b1fba286Sdrh         return WRC_Continue;
1897059b2d50Sdrh       }else{
1898059b2d50Sdrh         pWalker->eCode = 0;
1899059b2d50Sdrh         return WRC_Abort;
1900b1fba286Sdrh       }
1901626a879aSdrh     case TK_ID:
1902171d16bbSdrh       /* Convert "true" or "false" in a DEFAULT clause into the
1903171d16bbSdrh       ** appropriate TK_TRUEFALSE operator */
1904e39ef31cSdrh       if( sqlite3ExprIdToTrueFalse(pExpr) ){
1905171d16bbSdrh         return WRC_Prune;
1906171d16bbSdrh       }
1907171d16bbSdrh       /* Fall thru */
1908626a879aSdrh     case TK_COLUMN:
1909626a879aSdrh     case TK_AGG_FUNCTION:
191013449892Sdrh     case TK_AGG_COLUMN:
1911c5499befSdrh       testcase( pExpr->op==TK_ID );
1912c5499befSdrh       testcase( pExpr->op==TK_COLUMN );
1913c5499befSdrh       testcase( pExpr->op==TK_AGG_FUNCTION );
1914c5499befSdrh       testcase( pExpr->op==TK_AGG_COLUMN );
191507aded63Sdrh       if( ExprHasProperty(pExpr, EP_FixedCol) && pWalker->eCode!=2 ){
1916efad2e23Sdrh         return WRC_Continue;
1917efad2e23Sdrh       }
1918059b2d50Sdrh       if( pWalker->eCode==3 && pExpr->iTable==pWalker->u.iCur ){
1919059b2d50Sdrh         return WRC_Continue;
1920f43ce0b4Sdrh       }
1921f43ce0b4Sdrh       /* Fall through */
1922f43ce0b4Sdrh     case TK_IF_NULL_ROW:
19236e341b93Sdrh     case TK_REGISTER:
19249916048bSdrh       testcase( pExpr->op==TK_REGISTER );
1925f43ce0b4Sdrh       testcase( pExpr->op==TK_IF_NULL_ROW );
1926059b2d50Sdrh       pWalker->eCode = 0;
19277d10d5a6Sdrh       return WRC_Abort;
1928feada2dfSdrh     case TK_VARIABLE:
1929059b2d50Sdrh       if( pWalker->eCode==5 ){
1930feada2dfSdrh         /* Silently convert bound parameters that appear inside of CREATE
1931feada2dfSdrh         ** statements into a NULL when parsing the CREATE statement text out
1932feada2dfSdrh         ** of the sqlite_master table */
1933feada2dfSdrh         pExpr->op = TK_NULL;
1934059b2d50Sdrh       }else if( pWalker->eCode==4 ){
1935feada2dfSdrh         /* A bound parameter in a CREATE statement that originates from
1936feada2dfSdrh         ** sqlite3_prepare() causes an error */
1937059b2d50Sdrh         pWalker->eCode = 0;
1938feada2dfSdrh         return WRC_Abort;
1939feada2dfSdrh       }
1940feada2dfSdrh       /* Fall through */
1941626a879aSdrh     default:
19426e341b93Sdrh       testcase( pExpr->op==TK_SELECT ); /* sqlite3SelectWalkFail() disallows */
19436e341b93Sdrh       testcase( pExpr->op==TK_EXISTS ); /* sqlite3SelectWalkFail() disallows */
19447d10d5a6Sdrh       return WRC_Continue;
1945626a879aSdrh   }
1946626a879aSdrh }
1947059b2d50Sdrh static int exprIsConst(Expr *p, int initFlag, int iCur){
19487d10d5a6Sdrh   Walker w;
1949059b2d50Sdrh   w.eCode = initFlag;
19507d10d5a6Sdrh   w.xExprCallback = exprNodeIsConstant;
19517e6f980bSdrh   w.xSelectCallback = sqlite3SelectWalkFail;
1952979dd1beSdrh #ifdef SQLITE_DEBUG
1953979dd1beSdrh   w.xSelectCallback2 = sqlite3SelectWalkAssert2;
1954979dd1beSdrh #endif
1955059b2d50Sdrh   w.u.iCur = iCur;
19567d10d5a6Sdrh   sqlite3WalkExpr(&w, p);
1957059b2d50Sdrh   return w.eCode;
19587d10d5a6Sdrh }
1959626a879aSdrh 
1960626a879aSdrh /*
1961059b2d50Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
1962eb55bd2fSdrh ** and 0 if it involves variables or function calls.
19632398937bSdrh **
19642398937bSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
19652398937bSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
19662398937bSdrh ** a constant.
1967fef5208cSdrh */
19684adee20fSdanielk1977 int sqlite3ExprIsConstant(Expr *p){
1969059b2d50Sdrh   return exprIsConst(p, 1, 0);
1970fef5208cSdrh }
1971fef5208cSdrh 
1972fef5208cSdrh /*
197307aded63Sdrh ** Walk an expression tree.  Return non-zero if
197407aded63Sdrh **
197507aded63Sdrh **   (1) the expression is constant, and
197607aded63Sdrh **   (2) the expression does originate in the ON or USING clause
197707aded63Sdrh **       of a LEFT JOIN, and
197807aded63Sdrh **   (3) the expression does not contain any EP_FixedCol TK_COLUMN
197907aded63Sdrh **       operands created by the constant propagation optimization.
198007aded63Sdrh **
198107aded63Sdrh ** When this routine returns true, it indicates that the expression
198207aded63Sdrh ** can be added to the pParse->pConstExpr list and evaluated once when
198307aded63Sdrh ** the prepared statement starts up.  See sqlite3ExprCodeAtInit().
19840a168377Sdrh */
19850a168377Sdrh int sqlite3ExprIsConstantNotJoin(Expr *p){
1986059b2d50Sdrh   return exprIsConst(p, 2, 0);
19870a168377Sdrh }
19880a168377Sdrh 
19890a168377Sdrh /*
1990fcb9f4f3Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
1991059b2d50Sdrh ** for any single row of the table with cursor iCur.  In other words, the
1992059b2d50Sdrh ** expression must not refer to any non-deterministic function nor any
1993059b2d50Sdrh ** table other than iCur.
1994059b2d50Sdrh */
1995059b2d50Sdrh int sqlite3ExprIsTableConstant(Expr *p, int iCur){
1996059b2d50Sdrh   return exprIsConst(p, 3, iCur);
1997059b2d50Sdrh }
1998059b2d50Sdrh 
1999ab31a845Sdan 
2000ab31a845Sdan /*
2001ab31a845Sdan ** sqlite3WalkExpr() callback used by sqlite3ExprIsConstantOrGroupBy().
2002ab31a845Sdan */
2003ab31a845Sdan static int exprNodeIsConstantOrGroupBy(Walker *pWalker, Expr *pExpr){
2004ab31a845Sdan   ExprList *pGroupBy = pWalker->u.pGroupBy;
2005ab31a845Sdan   int i;
2006ab31a845Sdan 
2007ab31a845Sdan   /* Check if pExpr is identical to any GROUP BY term. If so, consider
2008ab31a845Sdan   ** it constant.  */
2009ab31a845Sdan   for(i=0; i<pGroupBy->nExpr; i++){
2010ab31a845Sdan     Expr *p = pGroupBy->a[i].pExpr;
20115aa550cfSdan     if( sqlite3ExprCompare(0, pExpr, p, -1)<2 ){
201270efa84dSdrh       CollSeq *pColl = sqlite3ExprNNCollSeq(pWalker->pParse, p);
2013efad2e23Sdrh       if( sqlite3IsBinary(pColl) ){
2014ab31a845Sdan         return WRC_Prune;
2015ab31a845Sdan       }
2016ab31a845Sdan     }
2017ab31a845Sdan   }
2018ab31a845Sdan 
2019ab31a845Sdan   /* Check if pExpr is a sub-select. If so, consider it variable. */
2020ab31a845Sdan   if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2021ab31a845Sdan     pWalker->eCode = 0;
2022ab31a845Sdan     return WRC_Abort;
2023ab31a845Sdan   }
2024ab31a845Sdan 
2025ab31a845Sdan   return exprNodeIsConstant(pWalker, pExpr);
2026ab31a845Sdan }
2027ab31a845Sdan 
2028ab31a845Sdan /*
2029ab31a845Sdan ** Walk the expression tree passed as the first argument. Return non-zero
2030ab31a845Sdan ** if the expression consists entirely of constants or copies of terms
2031ab31a845Sdan ** in pGroupBy that sort with the BINARY collation sequence.
2032ab314001Sdrh **
2033ab314001Sdrh ** This routine is used to determine if a term of the HAVING clause can
2034ab314001Sdrh ** be promoted into the WHERE clause.  In order for such a promotion to work,
2035ab314001Sdrh ** the value of the HAVING clause term must be the same for all members of
2036ab314001Sdrh ** a "group".  The requirement that the GROUP BY term must be BINARY
2037ab314001Sdrh ** assumes that no other collating sequence will have a finer-grained
2038ab314001Sdrh ** grouping than binary.  In other words (A=B COLLATE binary) implies
2039ab314001Sdrh ** A=B in every other collating sequence.  The requirement that the
2040ab314001Sdrh ** GROUP BY be BINARY is stricter than necessary.  It would also work
2041ab314001Sdrh ** to promote HAVING clauses that use the same alternative collating
2042ab314001Sdrh ** sequence as the GROUP BY term, but that is much harder to check,
2043ab314001Sdrh ** alternative collating sequences are uncommon, and this is only an
2044ab314001Sdrh ** optimization, so we take the easy way out and simply require the
2045ab314001Sdrh ** GROUP BY to use the BINARY collating sequence.
2046ab31a845Sdan */
2047ab31a845Sdan int sqlite3ExprIsConstantOrGroupBy(Parse *pParse, Expr *p, ExprList *pGroupBy){
2048ab31a845Sdan   Walker w;
2049ab31a845Sdan   w.eCode = 1;
2050ab31a845Sdan   w.xExprCallback = exprNodeIsConstantOrGroupBy;
2051979dd1beSdrh   w.xSelectCallback = 0;
2052ab31a845Sdan   w.u.pGroupBy = pGroupBy;
2053ab31a845Sdan   w.pParse = pParse;
2054ab31a845Sdan   sqlite3WalkExpr(&w, p);
2055ab31a845Sdan   return w.eCode;
2056ab31a845Sdan }
2057ab31a845Sdan 
2058059b2d50Sdrh /*
2059059b2d50Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
2060eb55bd2fSdrh ** or a function call with constant arguments.  Return and 0 if there
2061eb55bd2fSdrh ** are any variables.
2062eb55bd2fSdrh **
2063eb55bd2fSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
2064eb55bd2fSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
2065eb55bd2fSdrh ** a constant.
2066eb55bd2fSdrh */
2067feada2dfSdrh int sqlite3ExprIsConstantOrFunction(Expr *p, u8 isInit){
2068feada2dfSdrh   assert( isInit==0 || isInit==1 );
2069059b2d50Sdrh   return exprIsConst(p, 4+isInit, 0);
2070eb55bd2fSdrh }
2071eb55bd2fSdrh 
20725b88bc4bSdrh #ifdef SQLITE_ENABLE_CURSOR_HINTS
20735b88bc4bSdrh /*
20745b88bc4bSdrh ** Walk an expression tree.  Return 1 if the expression contains a
20755b88bc4bSdrh ** subquery of some kind.  Return 0 if there are no subqueries.
20765b88bc4bSdrh */
20775b88bc4bSdrh int sqlite3ExprContainsSubquery(Expr *p){
20785b88bc4bSdrh   Walker w;
2079bec2476aSdrh   w.eCode = 1;
20805b88bc4bSdrh   w.xExprCallback = sqlite3ExprWalkNoop;
20817e6f980bSdrh   w.xSelectCallback = sqlite3SelectWalkFail;
2082979dd1beSdrh #ifdef SQLITE_DEBUG
2083979dd1beSdrh   w.xSelectCallback2 = sqlite3SelectWalkAssert2;
2084979dd1beSdrh #endif
20855b88bc4bSdrh   sqlite3WalkExpr(&w, p);
208607194bffSdrh   return w.eCode==0;
20875b88bc4bSdrh }
20885b88bc4bSdrh #endif
20895b88bc4bSdrh 
2090eb55bd2fSdrh /*
209173b211abSdrh ** If the expression p codes a constant integer that is small enough
2092202b2df7Sdrh ** to fit in a 32-bit integer, return 1 and put the value of the integer
2093202b2df7Sdrh ** in *pValue.  If the expression is not an integer or if it is too big
2094202b2df7Sdrh ** to fit in a signed 32-bit integer, return 0 and leave *pValue unchanged.
2095e4de1febSdrh */
20964adee20fSdanielk1977 int sqlite3ExprIsInteger(Expr *p, int *pValue){
209792b01d53Sdrh   int rc = 0;
20981d2d71a0Sdrh   if( NEVER(p==0) ) return 0;  /* Used to only happen following on OOM */
2099cd92e84dSdrh 
2100cd92e84dSdrh   /* If an expression is an integer literal that fits in a signed 32-bit
2101cd92e84dSdrh   ** integer, then the EP_IntValue flag will have already been set */
2102cd92e84dSdrh   assert( p->op!=TK_INTEGER || (p->flags & EP_IntValue)!=0
2103cd92e84dSdrh            || sqlite3GetInt32(p->u.zToken, &rc)==0 );
2104cd92e84dSdrh 
210592b01d53Sdrh   if( p->flags & EP_IntValue ){
210633e619fcSdrh     *pValue = p->u.iValue;
2107e4de1febSdrh     return 1;
2108e4de1febSdrh   }
210992b01d53Sdrh   switch( p->op ){
21104b59ab5eSdrh     case TK_UPLUS: {
211192b01d53Sdrh       rc = sqlite3ExprIsInteger(p->pLeft, pValue);
2112f6e369a1Sdrh       break;
21134b59ab5eSdrh     }
2114e4de1febSdrh     case TK_UMINUS: {
2115e4de1febSdrh       int v;
21164adee20fSdanielk1977       if( sqlite3ExprIsInteger(p->pLeft, &v) ){
2117f6418891Smistachkin         assert( v!=(-2147483647-1) );
2118e4de1febSdrh         *pValue = -v;
211992b01d53Sdrh         rc = 1;
2120e4de1febSdrh       }
2121e4de1febSdrh       break;
2122e4de1febSdrh     }
2123e4de1febSdrh     default: break;
2124e4de1febSdrh   }
212592b01d53Sdrh   return rc;
2126e4de1febSdrh }
2127e4de1febSdrh 
2128e4de1febSdrh /*
2129039fc32eSdrh ** Return FALSE if there is no chance that the expression can be NULL.
2130039fc32eSdrh **
2131039fc32eSdrh ** If the expression might be NULL or if the expression is too complex
2132039fc32eSdrh ** to tell return TRUE.
2133039fc32eSdrh **
2134039fc32eSdrh ** This routine is used as an optimization, to skip OP_IsNull opcodes
2135039fc32eSdrh ** when we know that a value cannot be NULL.  Hence, a false positive
2136039fc32eSdrh ** (returning TRUE when in fact the expression can never be NULL) might
2137039fc32eSdrh ** be a small performance hit but is otherwise harmless.  On the other
2138039fc32eSdrh ** hand, a false negative (returning FALSE when the result could be NULL)
2139039fc32eSdrh ** will likely result in an incorrect answer.  So when in doubt, return
2140039fc32eSdrh ** TRUE.
2141039fc32eSdrh */
2142039fc32eSdrh int sqlite3ExprCanBeNull(const Expr *p){
2143039fc32eSdrh   u8 op;
21449bfb0794Sdrh   while( p->op==TK_UPLUS || p->op==TK_UMINUS ){
21459bfb0794Sdrh     p = p->pLeft;
21469bfb0794Sdrh   }
2147039fc32eSdrh   op = p->op;
2148039fc32eSdrh   if( op==TK_REGISTER ) op = p->op2;
2149039fc32eSdrh   switch( op ){
2150039fc32eSdrh     case TK_INTEGER:
2151039fc32eSdrh     case TK_STRING:
2152039fc32eSdrh     case TK_FLOAT:
2153039fc32eSdrh     case TK_BLOB:
2154039fc32eSdrh       return 0;
21557248a8b2Sdrh     case TK_COLUMN:
215672673a24Sdrh       return ExprHasProperty(p, EP_CanBeNull) ||
2157eda079cdSdrh              p->y.pTab==0 ||  /* Reference to column of index on expression */
2158eda079cdSdrh              (p->iColumn>=0 && p->y.pTab->aCol[p->iColumn].notNull==0);
2159039fc32eSdrh     default:
2160039fc32eSdrh       return 1;
2161039fc32eSdrh   }
2162039fc32eSdrh }
2163039fc32eSdrh 
2164039fc32eSdrh /*
2165039fc32eSdrh ** Return TRUE if the given expression is a constant which would be
2166039fc32eSdrh ** unchanged by OP_Affinity with the affinity given in the second
2167039fc32eSdrh ** argument.
2168039fc32eSdrh **
2169039fc32eSdrh ** This routine is used to determine if the OP_Affinity operation
2170039fc32eSdrh ** can be omitted.  When in doubt return FALSE.  A false negative
2171039fc32eSdrh ** is harmless.  A false positive, however, can result in the wrong
2172039fc32eSdrh ** answer.
2173039fc32eSdrh */
2174039fc32eSdrh int sqlite3ExprNeedsNoAffinityChange(const Expr *p, char aff){
2175039fc32eSdrh   u8 op;
217605883a34Sdrh   if( aff==SQLITE_AFF_BLOB ) return 1;
2177cd7f457eSdrh   while( p->op==TK_UPLUS || p->op==TK_UMINUS ){ p = p->pLeft; }
2178039fc32eSdrh   op = p->op;
2179039fc32eSdrh   if( op==TK_REGISTER ) op = p->op2;
2180039fc32eSdrh   switch( op ){
2181039fc32eSdrh     case TK_INTEGER: {
2182039fc32eSdrh       return aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC;
2183039fc32eSdrh     }
2184039fc32eSdrh     case TK_FLOAT: {
2185039fc32eSdrh       return aff==SQLITE_AFF_REAL || aff==SQLITE_AFF_NUMERIC;
2186039fc32eSdrh     }
2187039fc32eSdrh     case TK_STRING: {
2188039fc32eSdrh       return aff==SQLITE_AFF_TEXT;
2189039fc32eSdrh     }
2190039fc32eSdrh     case TK_BLOB: {
2191039fc32eSdrh       return 1;
2192039fc32eSdrh     }
21932f2855b6Sdrh     case TK_COLUMN: {
219488376ca7Sdrh       assert( p->iTable>=0 );  /* p cannot be part of a CHECK constraint */
219588376ca7Sdrh       return p->iColumn<0
21962f2855b6Sdrh           && (aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC);
21972f2855b6Sdrh     }
2198039fc32eSdrh     default: {
2199039fc32eSdrh       return 0;
2200039fc32eSdrh     }
2201039fc32eSdrh   }
2202039fc32eSdrh }
2203039fc32eSdrh 
2204039fc32eSdrh /*
2205c4a3c779Sdrh ** Return TRUE if the given string is a row-id column name.
2206c4a3c779Sdrh */
22074adee20fSdanielk1977 int sqlite3IsRowid(const char *z){
22084adee20fSdanielk1977   if( sqlite3StrICmp(z, "_ROWID_")==0 ) return 1;
22094adee20fSdanielk1977   if( sqlite3StrICmp(z, "ROWID")==0 ) return 1;
22104adee20fSdanielk1977   if( sqlite3StrICmp(z, "OID")==0 ) return 1;
2211c4a3c779Sdrh   return 0;
2212c4a3c779Sdrh }
2213c4a3c779Sdrh 
22149a96b668Sdanielk1977 /*
221569c355bdSdrh ** pX is the RHS of an IN operator.  If pX is a SELECT statement
221669c355bdSdrh ** that can be simplified to a direct table access, then return
221769c355bdSdrh ** a pointer to the SELECT statement.  If pX is not a SELECT statement,
221869c355bdSdrh ** or if the SELECT statement needs to be manifested into a transient
221969c355bdSdrh ** table, then return NULL.
2220b287f4b6Sdrh */
2221b287f4b6Sdrh #ifndef SQLITE_OMIT_SUBQUERY
22227b35a77bSdan static Select *isCandidateForInOpt(Expr *pX){
222369c355bdSdrh   Select *p;
2224b287f4b6Sdrh   SrcList *pSrc;
2225b287f4b6Sdrh   ExprList *pEList;
2226b287f4b6Sdrh   Table *pTab;
2227cfbb5e82Sdan   int i;
222869c355bdSdrh   if( !ExprHasProperty(pX, EP_xIsSelect) ) return 0;  /* Not a subquery */
222969c355bdSdrh   if( ExprHasProperty(pX, EP_VarSelect)  ) return 0;  /* Correlated subq */
223069c355bdSdrh   p = pX->x.pSelect;
2231b287f4b6Sdrh   if( p->pPrior ) return 0;              /* Not a compound SELECT */
22327d10d5a6Sdrh   if( p->selFlags & (SF_Distinct|SF_Aggregate) ){
2233b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
2234b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
22357d10d5a6Sdrh     return 0; /* No DISTINCT keyword and no aggregate functions */
22367d10d5a6Sdrh   }
2237b74b1017Sdrh   assert( p->pGroupBy==0 );              /* Has no GROUP BY clause */
2238b287f4b6Sdrh   if( p->pLimit ) return 0;              /* Has no LIMIT clause */
2239b287f4b6Sdrh   if( p->pWhere ) return 0;              /* Has no WHERE clause */
2240b287f4b6Sdrh   pSrc = p->pSrc;
2241d1fa7bcaSdrh   assert( pSrc!=0 );
2242d1fa7bcaSdrh   if( pSrc->nSrc!=1 ) return 0;          /* Single term in FROM clause */
2243b74b1017Sdrh   if( pSrc->a[0].pSelect ) return 0;     /* FROM is not a subquery or view */
2244b287f4b6Sdrh   pTab = pSrc->a[0].pTab;
224569c355bdSdrh   assert( pTab!=0 );
2246b74b1017Sdrh   assert( pTab->pSelect==0 );            /* FROM clause is not a view */
2247b287f4b6Sdrh   if( IsVirtual(pTab) ) return 0;        /* FROM clause not a virtual table */
2248b287f4b6Sdrh   pEList = p->pEList;
2249ac6b47d1Sdrh   assert( pEList!=0 );
22507b35a77bSdan   /* All SELECT results must be columns. */
2251cfbb5e82Sdan   for(i=0; i<pEList->nExpr; i++){
2252cfbb5e82Sdan     Expr *pRes = pEList->a[i].pExpr;
2253cfbb5e82Sdan     if( pRes->op!=TK_COLUMN ) return 0;
225469c355bdSdrh     assert( pRes->iTable==pSrc->a[0].iCursor );  /* Not a correlated subquery */
2255cfbb5e82Sdan   }
225669c355bdSdrh   return p;
2257b287f4b6Sdrh }
2258b287f4b6Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
2259b287f4b6Sdrh 
2260f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
22611d8cb21fSdan /*
22624c259e9fSdrh ** Generate code that checks the left-most column of index table iCur to see if
22634c259e9fSdrh ** it contains any NULL entries.  Cause the register at regHasNull to be set
22646be515ebSdrh ** to a non-NULL value if iCur contains no NULLs.  Cause register regHasNull
22656be515ebSdrh ** to be set to NULL if iCur contains one or more NULL values.
22666be515ebSdrh */
22676be515ebSdrh static void sqlite3SetHasNullFlag(Vdbe *v, int iCur, int regHasNull){
2268728e0f91Sdrh   int addr1;
22696be515ebSdrh   sqlite3VdbeAddOp2(v, OP_Integer, 0, regHasNull);
2270728e0f91Sdrh   addr1 = sqlite3VdbeAddOp1(v, OP_Rewind, iCur); VdbeCoverage(v);
22716be515ebSdrh   sqlite3VdbeAddOp3(v, OP_Column, iCur, 0, regHasNull);
22726be515ebSdrh   sqlite3VdbeChangeP5(v, OPFLAG_TYPEOFARG);
22734c259e9fSdrh   VdbeComment((v, "first_entry_in(%d)", iCur));
2274728e0f91Sdrh   sqlite3VdbeJumpHere(v, addr1);
22756be515ebSdrh }
2276f9b2e05cSdan #endif
22776be515ebSdrh 
2278bb53ecb1Sdrh 
2279bb53ecb1Sdrh #ifndef SQLITE_OMIT_SUBQUERY
2280bb53ecb1Sdrh /*
2281bb53ecb1Sdrh ** The argument is an IN operator with a list (not a subquery) on the
2282bb53ecb1Sdrh ** right-hand side.  Return TRUE if that list is constant.
2283bb53ecb1Sdrh */
2284bb53ecb1Sdrh static int sqlite3InRhsIsConstant(Expr *pIn){
2285bb53ecb1Sdrh   Expr *pLHS;
2286bb53ecb1Sdrh   int res;
2287bb53ecb1Sdrh   assert( !ExprHasProperty(pIn, EP_xIsSelect) );
2288bb53ecb1Sdrh   pLHS = pIn->pLeft;
2289bb53ecb1Sdrh   pIn->pLeft = 0;
2290bb53ecb1Sdrh   res = sqlite3ExprIsConstant(pIn);
2291bb53ecb1Sdrh   pIn->pLeft = pLHS;
2292bb53ecb1Sdrh   return res;
2293bb53ecb1Sdrh }
2294bb53ecb1Sdrh #endif
2295bb53ecb1Sdrh 
22966be515ebSdrh /*
22979a96b668Sdanielk1977 ** This function is used by the implementation of the IN (...) operator.
2298d4305ca6Sdrh ** The pX parameter is the expression on the RHS of the IN operator, which
2299d4305ca6Sdrh ** might be either a list of expressions or a subquery.
23009a96b668Sdanielk1977 **
2301d4305ca6Sdrh ** The job of this routine is to find or create a b-tree object that can
2302d4305ca6Sdrh ** be used either to test for membership in the RHS set or to iterate through
2303d4305ca6Sdrh ** all members of the RHS set, skipping duplicates.
2304d4305ca6Sdrh **
23053a85625dSdrh ** A cursor is opened on the b-tree object that is the RHS of the IN operator
2306d4305ca6Sdrh ** and pX->iTable is set to the index of that cursor.
2307d4305ca6Sdrh **
2308b74b1017Sdrh ** The returned value of this function indicates the b-tree type, as follows:
23099a96b668Sdanielk1977 **
23109a96b668Sdanielk1977 **   IN_INDEX_ROWID      - The cursor was opened on a database table.
23111ccce449Sdrh **   IN_INDEX_INDEX_ASC  - The cursor was opened on an ascending index.
23121ccce449Sdrh **   IN_INDEX_INDEX_DESC - The cursor was opened on a descending index.
23139a96b668Sdanielk1977 **   IN_INDEX_EPH        - The cursor was opened on a specially created and
23149a96b668Sdanielk1977 **                         populated epheremal table.
2315bb53ecb1Sdrh **   IN_INDEX_NOOP       - No cursor was allocated.  The IN operator must be
2316bb53ecb1Sdrh **                         implemented as a sequence of comparisons.
23179a96b668Sdanielk1977 **
2318d4305ca6Sdrh ** An existing b-tree might be used if the RHS expression pX is a simple
2319d4305ca6Sdrh ** subquery such as:
23209a96b668Sdanielk1977 **
2321553168c7Sdan **     SELECT <column1>, <column2>... FROM <table>
23229a96b668Sdanielk1977 **
2323d4305ca6Sdrh ** If the RHS of the IN operator is a list or a more complex subquery, then
2324d4305ca6Sdrh ** an ephemeral table might need to be generated from the RHS and then
232560ec914cSpeter.d.reid ** pX->iTable made to point to the ephemeral table instead of an
2326d4305ca6Sdrh ** existing table.
2327d4305ca6Sdrh **
23287fc0ba0fSdrh ** The inFlags parameter must contain, at a minimum, one of the bits
23297fc0ba0fSdrh ** IN_INDEX_MEMBERSHIP or IN_INDEX_LOOP but not both.  If inFlags contains
23307fc0ba0fSdrh ** IN_INDEX_MEMBERSHIP, then the generated table will be used for a fast
23317fc0ba0fSdrh ** membership test.  When the IN_INDEX_LOOP bit is set, the IN index will
23327fc0ba0fSdrh ** be used to loop over all values of the RHS of the IN operator.
23333a85625dSdrh **
23343a85625dSdrh ** When IN_INDEX_LOOP is used (and the b-tree will be used to iterate
23353a85625dSdrh ** through the set members) then the b-tree must not contain duplicates.
23367fc0ba0fSdrh ** An epheremal table will be created unless the selected columns are guaranteed
2337553168c7Sdan ** to be unique - either because it is an INTEGER PRIMARY KEY or due to
2338553168c7Sdan ** a UNIQUE constraint or index.
23390cdc022eSdanielk1977 **
23403a85625dSdrh ** When IN_INDEX_MEMBERSHIP is used (and the b-tree will be used
23413a85625dSdrh ** for fast set membership tests) then an epheremal table must
2342553168c7Sdan ** be used unless <columns> is a single INTEGER PRIMARY KEY column or an
2343553168c7Sdan ** index can be found with the specified <columns> as its left-most.
23440cdc022eSdanielk1977 **
2345bb53ecb1Sdrh ** If the IN_INDEX_NOOP_OK and IN_INDEX_MEMBERSHIP are both set and
2346bb53ecb1Sdrh ** if the RHS of the IN operator is a list (not a subquery) then this
2347bb53ecb1Sdrh ** routine might decide that creating an ephemeral b-tree for membership
2348bb53ecb1Sdrh ** testing is too expensive and return IN_INDEX_NOOP.  In that case, the
2349bb53ecb1Sdrh ** calling routine should implement the IN operator using a sequence
2350bb53ecb1Sdrh ** of Eq or Ne comparison operations.
2351bb53ecb1Sdrh **
2352b74b1017Sdrh ** When the b-tree is being used for membership tests, the calling function
23533a85625dSdrh ** might need to know whether or not the RHS side of the IN operator
2354e21a6e1dSdrh ** contains a NULL.  If prRhsHasNull is not a NULL pointer and
23553a85625dSdrh ** if there is any chance that the (...) might contain a NULL value at
23560cdc022eSdanielk1977 ** runtime, then a register is allocated and the register number written
2357e21a6e1dSdrh ** to *prRhsHasNull. If there is no chance that the (...) contains a
2358e21a6e1dSdrh ** NULL value, then *prRhsHasNull is left unchanged.
23590cdc022eSdanielk1977 **
2360e21a6e1dSdrh ** If a register is allocated and its location stored in *prRhsHasNull, then
23616be515ebSdrh ** the value in that register will be NULL if the b-tree contains one or more
23626be515ebSdrh ** NULL values, and it will be some non-NULL value if the b-tree contains no
23636be515ebSdrh ** NULL values.
2364553168c7Sdan **
2365553168c7Sdan ** If the aiMap parameter is not NULL, it must point to an array containing
2366553168c7Sdan ** one element for each column returned by the SELECT statement on the RHS
2367553168c7Sdan ** of the IN(...) operator. The i'th entry of the array is populated with the
2368553168c7Sdan ** offset of the index column that matches the i'th column returned by the
2369553168c7Sdan ** SELECT. For example, if the expression and selected index are:
2370553168c7Sdan **
2371553168c7Sdan **   (?,?,?) IN (SELECT a, b, c FROM t1)
2372553168c7Sdan **   CREATE INDEX i1 ON t1(b, c, a);
2373553168c7Sdan **
2374553168c7Sdan ** then aiMap[] is populated with {2, 0, 1}.
23759a96b668Sdanielk1977 */
2376284f4acaSdanielk1977 #ifndef SQLITE_OMIT_SUBQUERY
2377ba00e30aSdan int sqlite3FindInIndex(
23786fc8f364Sdrh   Parse *pParse,             /* Parsing context */
23796fc8f364Sdrh   Expr *pX,                  /* The right-hand side (RHS) of the IN operator */
23806fc8f364Sdrh   u32 inFlags,               /* IN_INDEX_LOOP, _MEMBERSHIP, and/or _NOOP_OK */
23816fc8f364Sdrh   int *prRhsHasNull,         /* Register holding NULL status.  See notes */
23822c04131cSdrh   int *aiMap,                /* Mapping from Index fields to RHS fields */
23832c04131cSdrh   int *piTab                 /* OUT: index to use */
2384ba00e30aSdan ){
2385b74b1017Sdrh   Select *p;                            /* SELECT to the right of IN operator */
2386b74b1017Sdrh   int eType = 0;                        /* Type of RHS table. IN_INDEX_* */
2387b74b1017Sdrh   int iTab = pParse->nTab++;            /* Cursor of the RHS table */
23883a85625dSdrh   int mustBeUnique;                     /* True if RHS must be unique */
2389b8475df8Sdrh   Vdbe *v = sqlite3GetVdbe(pParse);     /* Virtual machine being coded */
23909a96b668Sdanielk1977 
23911450bc6eSdrh   assert( pX->op==TK_IN );
23923a85625dSdrh   mustBeUnique = (inFlags & IN_INDEX_LOOP)!=0;
23931450bc6eSdrh 
23947b35a77bSdan   /* If the RHS of this IN(...) operator is a SELECT, and if it matters
23957b35a77bSdan   ** whether or not the SELECT result contains NULL values, check whether
2396870a0705Sdan   ** or not NULL is actually possible (it may not be, for example, due
23977b35a77bSdan   ** to NOT NULL constraints in the schema). If no NULL values are possible,
2398870a0705Sdan   ** set prRhsHasNull to 0 before continuing.  */
23997b35a77bSdan   if( prRhsHasNull && (pX->flags & EP_xIsSelect) ){
24007b35a77bSdan     int i;
24017b35a77bSdan     ExprList *pEList = pX->x.pSelect->pEList;
24027b35a77bSdan     for(i=0; i<pEList->nExpr; i++){
24037b35a77bSdan       if( sqlite3ExprCanBeNull(pEList->a[i].pExpr) ) break;
24047b35a77bSdan     }
24057b35a77bSdan     if( i==pEList->nExpr ){
24067b35a77bSdan       prRhsHasNull = 0;
24077b35a77bSdan     }
24087b35a77bSdan   }
24097b35a77bSdan 
2410b74b1017Sdrh   /* Check to see if an existing table or index can be used to
2411b74b1017Sdrh   ** satisfy the query.  This is preferable to generating a new
24127b35a77bSdan   ** ephemeral table.  */
24137b35a77bSdan   if( pParse->nErr==0 && (p = isCandidateForInOpt(pX))!=0 ){
2414e1fb65a0Sdanielk1977     sqlite3 *db = pParse->db;              /* Database connection */
2415b07028f7Sdrh     Table *pTab;                           /* Table <table>. */
2416ba00e30aSdan     i16 iDb;                               /* Database idx for pTab */
2417cfbb5e82Sdan     ExprList *pEList = p->pEList;
2418cfbb5e82Sdan     int nExpr = pEList->nExpr;
2419e1fb65a0Sdanielk1977 
2420b07028f7Sdrh     assert( p->pEList!=0 );             /* Because of isCandidateForInOpt(p) */
2421b07028f7Sdrh     assert( p->pEList->a[0].pExpr!=0 ); /* Because of isCandidateForInOpt(p) */
2422b07028f7Sdrh     assert( p->pSrc!=0 );               /* Because of isCandidateForInOpt(p) */
2423b07028f7Sdrh     pTab = p->pSrc->a[0].pTab;
2424b07028f7Sdrh 
2425b22f7c83Sdrh     /* Code an OP_Transaction and OP_TableLock for <table>. */
2426e1fb65a0Sdanielk1977     iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
2427e1fb65a0Sdanielk1977     sqlite3CodeVerifySchema(pParse, iDb);
2428e1fb65a0Sdanielk1977     sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
24299a96b668Sdanielk1977 
2430a84a283dSdrh     assert(v);  /* sqlite3GetVdbe() has always been previously called */
2431cfbb5e82Sdan     if( nExpr==1 && pEList->a[0].pExpr->iColumn<0 ){
243262659b2aSdrh       /* The "x IN (SELECT rowid FROM table)" case */
2433511f9e8dSdrh       int iAddr = sqlite3VdbeAddOp0(v, OP_Once);
24347d176105Sdrh       VdbeCoverage(v);
24359a96b668Sdanielk1977 
24369a96b668Sdanielk1977       sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
24379a96b668Sdanielk1977       eType = IN_INDEX_ROWID;
2438d8852095Sdrh       ExplainQueryPlan((pParse, 0,
2439d8852095Sdrh             "USING ROWID SEARCH ON TABLE %s FOR IN-OPERATOR",pTab->zName));
24409a96b668Sdanielk1977       sqlite3VdbeJumpHere(v, iAddr);
24419a96b668Sdanielk1977     }else{
2442e1fb65a0Sdanielk1977       Index *pIdx;                         /* Iterator variable */
2443cfbb5e82Sdan       int affinity_ok = 1;
2444cfbb5e82Sdan       int i;
2445cfbb5e82Sdan 
2446cfbb5e82Sdan       /* Check that the affinity that will be used to perform each
244762659b2aSdrh       ** comparison is the same as the affinity of each column in table
244862659b2aSdrh       ** on the RHS of the IN operator.  If it not, it is not possible to
244962659b2aSdrh       ** use any index of the RHS table.  */
2450cfbb5e82Sdan       for(i=0; i<nExpr && affinity_ok; i++){
2451fc7f27b9Sdrh         Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2452cfbb5e82Sdan         int iCol = pEList->a[i].pExpr->iColumn;
24530dfa4f6fSdrh         char idxaff = sqlite3TableColumnAffinity(pTab,iCol); /* RHS table */
2454cfbb5e82Sdan         char cmpaff = sqlite3CompareAffinity(pLhs, idxaff);
245562659b2aSdrh         testcase( cmpaff==SQLITE_AFF_BLOB );
245662659b2aSdrh         testcase( cmpaff==SQLITE_AFF_TEXT );
2457cfbb5e82Sdan         switch( cmpaff ){
2458cfbb5e82Sdan           case SQLITE_AFF_BLOB:
2459cfbb5e82Sdan             break;
2460cfbb5e82Sdan           case SQLITE_AFF_TEXT:
246162659b2aSdrh             /* sqlite3CompareAffinity() only returns TEXT if one side or the
246262659b2aSdrh             ** other has no affinity and the other side is TEXT.  Hence,
246362659b2aSdrh             ** the only way for cmpaff to be TEXT is for idxaff to be TEXT
246462659b2aSdrh             ** and for the term on the LHS of the IN to have no affinity. */
246562659b2aSdrh             assert( idxaff==SQLITE_AFF_TEXT );
2466cfbb5e82Sdan             break;
2467cfbb5e82Sdan           default:
2468cfbb5e82Sdan             affinity_ok = sqlite3IsNumericAffinity(idxaff);
2469cfbb5e82Sdan         }
2470cfbb5e82Sdan       }
2471e1fb65a0Sdanielk1977 
2472a84a283dSdrh       if( affinity_ok ){
2473a84a283dSdrh         /* Search for an existing index that will work for this IN operator */
2474a84a283dSdrh         for(pIdx=pTab->pIndex; pIdx && eType==0; pIdx=pIdx->pNext){
2475a84a283dSdrh           Bitmask colUsed;      /* Columns of the index used */
2476a84a283dSdrh           Bitmask mCol;         /* Mask for the current column */
24776fc8f364Sdrh           if( pIdx->nColumn<nExpr ) continue;
2478d4a4a361Sdrh           if( pIdx->pPartIdxWhere!=0 ) continue;
2479a84a283dSdrh           /* Maximum nColumn is BMS-2, not BMS-1, so that we can compute
2480a84a283dSdrh           ** BITMASK(nExpr) without overflowing */
2481a84a283dSdrh           testcase( pIdx->nColumn==BMS-2 );
2482a84a283dSdrh           testcase( pIdx->nColumn==BMS-1 );
2483a84a283dSdrh           if( pIdx->nColumn>=BMS-1 ) continue;
24846fc8f364Sdrh           if( mustBeUnique ){
24856fc8f364Sdrh             if( pIdx->nKeyCol>nExpr
24866fc8f364Sdrh              ||(pIdx->nColumn>nExpr && !IsUniqueIndex(pIdx))
24876fc8f364Sdrh             ){
2488a84a283dSdrh               continue;  /* This index is not unique over the IN RHS columns */
2489cfbb5e82Sdan             }
24906fc8f364Sdrh           }
2491cfbb5e82Sdan 
2492a84a283dSdrh           colUsed = 0;   /* Columns of index used so far */
2493cfbb5e82Sdan           for(i=0; i<nExpr; i++){
2494fc7f27b9Sdrh             Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2495cfbb5e82Sdan             Expr *pRhs = pEList->a[i].pExpr;
2496cfbb5e82Sdan             CollSeq *pReq = sqlite3BinaryCompareCollSeq(pParse, pLhs, pRhs);
2497cfbb5e82Sdan             int j;
2498cfbb5e82Sdan 
24996fc8f364Sdrh             assert( pReq!=0 || pRhs->iColumn==XN_ROWID || pParse->nErr );
2500cfbb5e82Sdan             for(j=0; j<nExpr; j++){
2501cfbb5e82Sdan               if( pIdx->aiColumn[j]!=pRhs->iColumn ) continue;
2502cfbb5e82Sdan               assert( pIdx->azColl[j] );
2503106526e1Sdrh               if( pReq!=0 && sqlite3StrICmp(pReq->zName, pIdx->azColl[j])!=0 ){
2504106526e1Sdrh                 continue;
2505106526e1Sdrh               }
2506cfbb5e82Sdan               break;
2507cfbb5e82Sdan             }
2508cfbb5e82Sdan             if( j==nExpr ) break;
2509a84a283dSdrh             mCol = MASKBIT(j);
2510a84a283dSdrh             if( mCol & colUsed ) break; /* Each column used only once */
2511a84a283dSdrh             colUsed |= mCol;
2512ba00e30aSdan             if( aiMap ) aiMap[i] = j;
2513cfbb5e82Sdan           }
2514cfbb5e82Sdan 
2515a84a283dSdrh           assert( i==nExpr || colUsed!=(MASKBIT(nExpr)-1) );
2516a84a283dSdrh           if( colUsed==(MASKBIT(nExpr)-1) ){
2517a84a283dSdrh             /* If we reach this point, that means the index pIdx is usable */
2518511f9e8dSdrh             int iAddr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
2519e2ca99c9Sdrh             ExplainQueryPlan((pParse, 0,
2520e2ca99c9Sdrh                               "USING INDEX %s FOR IN-OPERATOR",pIdx->zName));
25212ec2fb22Sdrh             sqlite3VdbeAddOp3(v, OP_OpenRead, iTab, pIdx->tnum, iDb);
25222ec2fb22Sdrh             sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
2523207872a4Sdanielk1977             VdbeComment((v, "%s", pIdx->zName));
25241ccce449Sdrh             assert( IN_INDEX_INDEX_DESC == IN_INDEX_INDEX_ASC+1 );
25251ccce449Sdrh             eType = IN_INDEX_INDEX_ASC + pIdx->aSortOrder[0];
25269a96b668Sdanielk1977 
25277b35a77bSdan             if( prRhsHasNull ){
25283480bfdaSdan #ifdef SQLITE_ENABLE_COLUMN_USED_MASK
2529cfbb5e82Sdan               i64 mask = (1<<nExpr)-1;
25303480bfdaSdan               sqlite3VdbeAddOp4Dup8(v, OP_ColumnsUsed,
2531cfbb5e82Sdan                   iTab, 0, 0, (u8*)&mask, P4_INT64);
25323480bfdaSdan #endif
2533b80dbdc2Sdrh               *prRhsHasNull = ++pParse->nMem;
25347b35a77bSdan               if( nExpr==1 ){
25356be515ebSdrh                 sqlite3SetHasNullFlag(v, iTab, *prRhsHasNull);
25360cdc022eSdanielk1977               }
25377b35a77bSdan             }
2538552fd454Sdrh             sqlite3VdbeJumpHere(v, iAddr);
25399a96b668Sdanielk1977           }
2540a84a283dSdrh         } /* End loop over indexes */
2541a84a283dSdrh       } /* End if( affinity_ok ) */
2542a84a283dSdrh     } /* End if not an rowid index */
2543a84a283dSdrh   } /* End attempt to optimize using an index */
25449a96b668Sdanielk1977 
2545bb53ecb1Sdrh   /* If no preexisting index is available for the IN clause
2546bb53ecb1Sdrh   ** and IN_INDEX_NOOP is an allowed reply
2547bb53ecb1Sdrh   ** and the RHS of the IN operator is a list, not a subquery
254871c57db0Sdan   ** and the RHS is not constant or has two or fewer terms,
254960ec914cSpeter.d.reid   ** then it is not worth creating an ephemeral table to evaluate
2550bb53ecb1Sdrh   ** the IN operator so return IN_INDEX_NOOP.
2551bb53ecb1Sdrh   */
2552bb53ecb1Sdrh   if( eType==0
2553bb53ecb1Sdrh    && (inFlags & IN_INDEX_NOOP_OK)
2554bb53ecb1Sdrh    && !ExprHasProperty(pX, EP_xIsSelect)
2555bb53ecb1Sdrh    && (!sqlite3InRhsIsConstant(pX) || pX->x.pList->nExpr<=2)
2556bb53ecb1Sdrh   ){
2557bb53ecb1Sdrh     eType = IN_INDEX_NOOP;
2558bb53ecb1Sdrh   }
2559bb53ecb1Sdrh 
25609a96b668Sdanielk1977   if( eType==0 ){
25614387006cSdrh     /* Could not find an existing table or index to use as the RHS b-tree.
2562b74b1017Sdrh     ** We will have to generate an ephemeral table to do the job.
2563b74b1017Sdrh     */
25648e23daf3Sdrh     u32 savedNQueryLoop = pParse->nQueryLoop;
25650cdc022eSdanielk1977     int rMayHaveNull = 0;
256641a05b7bSdanielk1977     eType = IN_INDEX_EPH;
25673a85625dSdrh     if( inFlags & IN_INDEX_LOOP ){
25684a5acf8eSdrh       pParse->nQueryLoop = 0;
2569e21a6e1dSdrh     }else if( prRhsHasNull ){
2570e21a6e1dSdrh       *prRhsHasNull = rMayHaveNull = ++pParse->nMem;
2571cf4d38aaSdrh     }
257285bcdce2Sdrh     assert( pX->op==TK_IN );
257350ef6716Sdrh     sqlite3CodeRhsOfIN(pParse, pX, iTab);
257485bcdce2Sdrh     if( rMayHaveNull ){
25752c04131cSdrh       sqlite3SetHasNullFlag(v, iTab, rMayHaveNull);
257685bcdce2Sdrh     }
2577cf4d38aaSdrh     pParse->nQueryLoop = savedNQueryLoop;
25789a96b668Sdanielk1977   }
2579ba00e30aSdan 
2580ba00e30aSdan   if( aiMap && eType!=IN_INDEX_INDEX_ASC && eType!=IN_INDEX_INDEX_DESC ){
2581ba00e30aSdan     int i, n;
2582ba00e30aSdan     n = sqlite3ExprVectorSize(pX->pLeft);
2583ba00e30aSdan     for(i=0; i<n; i++) aiMap[i] = i;
2584ba00e30aSdan   }
25852c04131cSdrh   *piTab = iTab;
25869a96b668Sdanielk1977   return eType;
25879a96b668Sdanielk1977 }
2588284f4acaSdanielk1977 #endif
2589626a879aSdrh 
2590f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
2591553168c7Sdan /*
2592553168c7Sdan ** Argument pExpr is an (?, ?...) IN(...) expression. This
2593553168c7Sdan ** function allocates and returns a nul-terminated string containing
2594553168c7Sdan ** the affinities to be used for each column of the comparison.
2595553168c7Sdan **
2596553168c7Sdan ** It is the responsibility of the caller to ensure that the returned
2597553168c7Sdan ** string is eventually freed using sqlite3DbFree().
2598553168c7Sdan */
259971c57db0Sdan static char *exprINAffinity(Parse *pParse, Expr *pExpr){
260071c57db0Sdan   Expr *pLeft = pExpr->pLeft;
260171c57db0Sdan   int nVal = sqlite3ExprVectorSize(pLeft);
2602553168c7Sdan   Select *pSelect = (pExpr->flags & EP_xIsSelect) ? pExpr->x.pSelect : 0;
260371c57db0Sdan   char *zRet;
260471c57db0Sdan 
2605553168c7Sdan   assert( pExpr->op==TK_IN );
26065c258dc1Sdrh   zRet = sqlite3DbMallocRaw(pParse->db, nVal+1);
260771c57db0Sdan   if( zRet ){
260871c57db0Sdan     int i;
260971c57db0Sdan     for(i=0; i<nVal; i++){
2610fc7f27b9Sdrh       Expr *pA = sqlite3VectorFieldSubexpr(pLeft, i);
2611553168c7Sdan       char a = sqlite3ExprAffinity(pA);
2612553168c7Sdan       if( pSelect ){
2613553168c7Sdan         zRet[i] = sqlite3CompareAffinity(pSelect->pEList->a[i].pExpr, a);
261471c57db0Sdan       }else{
2615553168c7Sdan         zRet[i] = a;
261671c57db0Sdan       }
261771c57db0Sdan     }
261871c57db0Sdan     zRet[nVal] = '\0';
261971c57db0Sdan   }
262071c57db0Sdan   return zRet;
262171c57db0Sdan }
2622f9b2e05cSdan #endif
262371c57db0Sdan 
26248da209b1Sdan #ifndef SQLITE_OMIT_SUBQUERY
26258da209b1Sdan /*
26268da209b1Sdan ** Load the Parse object passed as the first argument with an error
26278da209b1Sdan ** message of the form:
26288da209b1Sdan **
26298da209b1Sdan **   "sub-select returns N columns - expected M"
26308da209b1Sdan */
26318da209b1Sdan void sqlite3SubselectError(Parse *pParse, int nActual, int nExpect){
26328da209b1Sdan   const char *zFmt = "sub-select returns %d columns - expected %d";
26338da209b1Sdan   sqlite3ErrorMsg(pParse, zFmt, nActual, nExpect);
26348da209b1Sdan }
26358da209b1Sdan #endif
26368da209b1Sdan 
2637626a879aSdrh /*
263844c5604cSdan ** Expression pExpr is a vector that has been used in a context where
263944c5604cSdan ** it is not permitted. If pExpr is a sub-select vector, this routine
264044c5604cSdan ** loads the Parse object with a message of the form:
264144c5604cSdan **
264244c5604cSdan **   "sub-select returns N columns - expected 1"
264344c5604cSdan **
264444c5604cSdan ** Or, if it is a regular scalar vector:
264544c5604cSdan **
264644c5604cSdan **   "row value misused"
264744c5604cSdan */
264844c5604cSdan void sqlite3VectorErrorMsg(Parse *pParse, Expr *pExpr){
264944c5604cSdan #ifndef SQLITE_OMIT_SUBQUERY
265044c5604cSdan   if( pExpr->flags & EP_xIsSelect ){
265144c5604cSdan     sqlite3SubselectError(pParse, pExpr->x.pSelect->pEList->nExpr, 1);
265244c5604cSdan   }else
265344c5604cSdan #endif
265444c5604cSdan   {
265544c5604cSdan     sqlite3ErrorMsg(pParse, "row value misused");
265644c5604cSdan   }
265744c5604cSdan }
265844c5604cSdan 
265985bcdce2Sdrh #ifndef SQLITE_OMIT_SUBQUERY
266044c5604cSdan /*
266185bcdce2Sdrh ** Generate code that will construct an ephemeral table containing all terms
266285bcdce2Sdrh ** in the RHS of an IN operator.  The IN operator can be in either of two
266385bcdce2Sdrh ** forms:
2664626a879aSdrh **
26659cbe6352Sdrh **     x IN (4,5,11)              -- IN operator with list on right-hand side
26669cbe6352Sdrh **     x IN (SELECT a FROM b)     -- IN operator with subquery on the right
2667fef5208cSdrh **
26682c04131cSdrh ** The pExpr parameter is the IN operator.  The cursor number for the
26692c04131cSdrh ** constructed ephermeral table is returned.  The first time the ephemeral
26702c04131cSdrh ** table is computed, the cursor number is also stored in pExpr->iTable,
26712c04131cSdrh ** however the cursor number returned might not be the same, as it might
26722c04131cSdrh ** have been duplicated using OP_OpenDup.
267341a05b7bSdanielk1977 **
267485bcdce2Sdrh ** If the LHS expression ("x" in the examples) is a column value, or
267585bcdce2Sdrh ** the SELECT statement returns a column value, then the affinity of that
267685bcdce2Sdrh ** column is used to build the index keys. If both 'x' and the
267785bcdce2Sdrh ** SELECT... statement are columns, then numeric affinity is used
267885bcdce2Sdrh ** if either column has NUMERIC or INTEGER affinity. If neither
267985bcdce2Sdrh ** 'x' nor the SELECT... statement are columns, then numeric affinity
268085bcdce2Sdrh ** is used.
2681cce7d176Sdrh */
268285bcdce2Sdrh void sqlite3CodeRhsOfIN(
2683fd773cf9Sdrh   Parse *pParse,          /* Parsing context */
268485bcdce2Sdrh   Expr *pExpr,            /* The IN operator */
268550ef6716Sdrh   int iTab                /* Use this cursor number */
268641a05b7bSdanielk1977 ){
26872c04131cSdrh   int addrOnce = 0;           /* Address of the OP_Once instruction at top */
268885bcdce2Sdrh   int addr;                   /* Address of OP_OpenEphemeral instruction */
268985bcdce2Sdrh   Expr *pLeft;                /* the LHS of the IN operator */
269085bcdce2Sdrh   KeyInfo *pKeyInfo = 0;      /* Key information */
269185bcdce2Sdrh   int nVal;                   /* Size of vector pLeft */
269285bcdce2Sdrh   Vdbe *v;                    /* The prepared statement under construction */
2693fc976065Sdanielk1977 
26942c04131cSdrh   v = pParse->pVdbe;
269585bcdce2Sdrh   assert( v!=0 );
269685bcdce2Sdrh 
26972c04131cSdrh   /* The evaluation of the IN must be repeated every time it
269839a11819Sdrh   ** is encountered if any of the following is true:
269957dbd7b3Sdrh   **
270057dbd7b3Sdrh   **    *  The right-hand side is a correlated subquery
270157dbd7b3Sdrh   **    *  The right-hand side is an expression list containing variables
270257dbd7b3Sdrh   **    *  We are inside a trigger
270357dbd7b3Sdrh   **
27042c04131cSdrh   ** If all of the above are false, then we can compute the RHS just once
27052c04131cSdrh   ** and reuse it many names.
2706b3bce662Sdanielk1977   */
2707efb699fcSdrh   if( !ExprHasProperty(pExpr, EP_VarSelect) && pParse->iSelfTab==0 ){
27082c04131cSdrh     /* Reuse of the RHS is allowed */
27092c04131cSdrh     /* If this routine has already been coded, but the previous code
27102c04131cSdrh     ** might not have been invoked yet, so invoke it now as a subroutine.
27112c04131cSdrh     */
27122c04131cSdrh     if( ExprHasProperty(pExpr, EP_Subrtn) ){
2713f9231c34Sdrh       addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
2714bd462bccSdrh       if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2715bd462bccSdrh         ExplainQueryPlan((pParse, 0, "REUSE LIST SUBQUERY %d",
2716bd462bccSdrh               pExpr->x.pSelect->selId));
2717bd462bccSdrh       }
27182c04131cSdrh       sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
27192c04131cSdrh                         pExpr->y.sub.iAddr);
27202c04131cSdrh       sqlite3VdbeAddOp2(v, OP_OpenDup, iTab, pExpr->iTable);
2721f9231c34Sdrh       sqlite3VdbeJumpHere(v, addrOnce);
27222c04131cSdrh       return;
27232c04131cSdrh     }
27242c04131cSdrh 
27252c04131cSdrh     /* Begin coding the subroutine */
27262c04131cSdrh     ExprSetProperty(pExpr, EP_Subrtn);
27272c04131cSdrh     pExpr->y.sub.regReturn = ++pParse->nMem;
27282c04131cSdrh     pExpr->y.sub.iAddr =
27292c04131cSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 0, pExpr->y.sub.regReturn) + 1;
27302c04131cSdrh     VdbeComment((v, "return address"));
27312c04131cSdrh 
27322c04131cSdrh     addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
2733b3bce662Sdanielk1977   }
2734b3bce662Sdanielk1977 
273585bcdce2Sdrh   /* Check to see if this is a vector IN operator */
273685bcdce2Sdrh   pLeft = pExpr->pLeft;
273771c57db0Sdan   nVal = sqlite3ExprVectorSize(pLeft);
2738e014a838Sdanielk1977 
273985bcdce2Sdrh   /* Construct the ephemeral table that will contain the content of
274085bcdce2Sdrh   ** RHS of the IN operator.
2741fef5208cSdrh   */
27422c04131cSdrh   pExpr->iTable = iTab;
274350ef6716Sdrh   addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, pExpr->iTable, nVal);
27442c04131cSdrh #ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
27452c04131cSdrh   if( ExprHasProperty(pExpr, EP_xIsSelect) ){
27462c04131cSdrh     VdbeComment((v, "Result of SELECT %u", pExpr->x.pSelect->selId));
27472c04131cSdrh   }else{
27482c04131cSdrh     VdbeComment((v, "RHS of IN operator"));
27492c04131cSdrh   }
27502c04131cSdrh #endif
275150ef6716Sdrh   pKeyInfo = sqlite3KeyInfoAlloc(pParse->db, nVal, 1);
2752e014a838Sdanielk1977 
27536ab3a2ecSdanielk1977   if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2754e014a838Sdanielk1977     /* Case 1:     expr IN (SELECT ...)
2755e014a838Sdanielk1977     **
2756e014a838Sdanielk1977     ** Generate code to write the results of the select into the temporary
2757e014a838Sdanielk1977     ** table allocated and opened above.
2758e014a838Sdanielk1977     */
27594387006cSdrh     Select *pSelect = pExpr->x.pSelect;
276071c57db0Sdan     ExprList *pEList = pSelect->pEList;
27611013c932Sdrh 
27622c04131cSdrh     ExplainQueryPlan((pParse, 1, "%sLIST SUBQUERY %d",
27632c04131cSdrh         addrOnce?"":"CORRELATED ", pSelect->selId
2764e2ca99c9Sdrh     ));
276564bcb8cfSdrh     /* If the LHS and RHS of the IN operator do not match, that
276664bcb8cfSdrh     ** error will have been caught long before we reach this point. */
276764bcb8cfSdrh     if( ALWAYS(pEList->nExpr==nVal) ){
276871c57db0Sdan       SelectDest dest;
276971c57db0Sdan       int i;
2770bd462bccSdrh       sqlite3SelectDestInit(&dest, SRT_Set, iTab);
277171c57db0Sdan       dest.zAffSdst = exprINAffinity(pParse, pExpr);
27724387006cSdrh       pSelect->iLimit = 0;
27734387006cSdrh       testcase( pSelect->selFlags & SF_Distinct );
2774812ea833Sdrh       testcase( pKeyInfo==0 ); /* Caused by OOM in sqlite3KeyInfoAlloc() */
27754387006cSdrh       if( sqlite3Select(pParse, pSelect, &dest) ){
277671c57db0Sdan         sqlite3DbFree(pParse->db, dest.zAffSdst);
27772ec2fb22Sdrh         sqlite3KeyInfoUnref(pKeyInfo);
277885bcdce2Sdrh         return;
277994ccde58Sdrh       }
278071c57db0Sdan       sqlite3DbFree(pParse->db, dest.zAffSdst);
2781812ea833Sdrh       assert( pKeyInfo!=0 ); /* OOM will cause exit after sqlite3Select() */
27823535ec3eSdrh       assert( pEList!=0 );
27833535ec3eSdrh       assert( pEList->nExpr>0 );
27842ec2fb22Sdrh       assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
278571c57db0Sdan       for(i=0; i<nVal; i++){
2786773d3afaSdan         Expr *p = sqlite3VectorFieldSubexpr(pLeft, i);
278771c57db0Sdan         pKeyInfo->aColl[i] = sqlite3BinaryCompareCollSeq(
278871c57db0Sdan             pParse, p, pEList->a[i].pExpr
278971c57db0Sdan         );
279071c57db0Sdan       }
279171c57db0Sdan     }
2792a7d2db17Sdrh   }else if( ALWAYS(pExpr->x.pList!=0) ){
2793fef5208cSdrh     /* Case 2:     expr IN (exprlist)
2794fef5208cSdrh     **
2795e014a838Sdanielk1977     ** For each expression, build an index key from the evaluation and
2796e014a838Sdanielk1977     ** store it in the temporary table. If <expr> is a column, then use
2797e014a838Sdanielk1977     ** that columns affinity when building index keys. If <expr> is not
2798e014a838Sdanielk1977     ** a column, use numeric affinity.
2799fef5208cSdrh     */
280071c57db0Sdan     char affinity;            /* Affinity of the LHS of the IN */
2801e014a838Sdanielk1977     int i;
28026ab3a2ecSdanielk1977     ExprList *pList = pExpr->x.pList;
280357dbd7b3Sdrh     struct ExprList_item *pItem;
2804ecc31805Sdrh     int r1, r2, r3;
280571c57db0Sdan     affinity = sqlite3ExprAffinity(pLeft);
2806e014a838Sdanielk1977     if( !affinity ){
280705883a34Sdrh       affinity = SQLITE_AFF_BLOB;
2808e014a838Sdanielk1977     }
2809323df790Sdrh     if( pKeyInfo ){
28102ec2fb22Sdrh       assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
2811323df790Sdrh       pKeyInfo->aColl[0] = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
2812323df790Sdrh     }
2813e014a838Sdanielk1977 
2814e014a838Sdanielk1977     /* Loop through each expression in <exprlist>. */
28152d401ab8Sdrh     r1 = sqlite3GetTempReg(pParse);
28162d401ab8Sdrh     r2 = sqlite3GetTempReg(pParse);
281757dbd7b3Sdrh     for(i=pList->nExpr, pItem=pList->a; i>0; i--, pItem++){
281857dbd7b3Sdrh       Expr *pE2 = pItem->pExpr;
2819e014a838Sdanielk1977 
282057dbd7b3Sdrh       /* If the expression is not constant then we will need to
282157dbd7b3Sdrh       ** disable the test that was generated above that makes sure
282257dbd7b3Sdrh       ** this code only executes once.  Because for a non-constant
282357dbd7b3Sdrh       ** expression we need to rerun this code each time.
282457dbd7b3Sdrh       */
28252c04131cSdrh       if( addrOnce && !sqlite3ExprIsConstant(pE2) ){
28262c04131cSdrh         sqlite3VdbeChangeToNoop(v, addrOnce);
28277ac0e562Sdan         ExprClearProperty(pExpr, EP_Subrtn);
28282c04131cSdrh         addrOnce = 0;
28294794b980Sdrh       }
2830e014a838Sdanielk1977 
2831e014a838Sdanielk1977       /* Evaluate the expression and insert it into the temp table */
2832ecc31805Sdrh       r3 = sqlite3ExprCodeTarget(pParse, pE2, r1);
2833ecc31805Sdrh       sqlite3VdbeAddOp4(v, OP_MakeRecord, r3, 1, r2, &affinity, 1);
2834bd462bccSdrh       sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iTab, r2, r3, 1);
2835fef5208cSdrh     }
28362d401ab8Sdrh     sqlite3ReleaseTempReg(pParse, r1);
28372d401ab8Sdrh     sqlite3ReleaseTempReg(pParse, r2);
2838fef5208cSdrh   }
2839323df790Sdrh   if( pKeyInfo ){
28402ec2fb22Sdrh     sqlite3VdbeChangeP4(v, addr, (void *)pKeyInfo, P4_KEYINFO);
284141a05b7bSdanielk1977   }
28422c04131cSdrh   if( addrOnce ){
28432c04131cSdrh     sqlite3VdbeJumpHere(v, addrOnce);
28442c04131cSdrh     /* Subroutine return */
28452c04131cSdrh     sqlite3VdbeAddOp1(v, OP_Return, pExpr->y.sub.regReturn);
28462c04131cSdrh     sqlite3VdbeChangeP1(v, pExpr->y.sub.iAddr-1, sqlite3VdbeCurrentAddr(v)-1);
284785bcdce2Sdrh   }
284885bcdce2Sdrh }
284985bcdce2Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
285085bcdce2Sdrh 
285185bcdce2Sdrh /*
285285bcdce2Sdrh ** Generate code for scalar subqueries used as a subquery expression
285385bcdce2Sdrh ** or EXISTS operator:
285485bcdce2Sdrh **
285585bcdce2Sdrh **     (SELECT a FROM b)          -- subquery
285685bcdce2Sdrh **     EXISTS (SELECT a FROM b)   -- EXISTS subquery
285785bcdce2Sdrh **
285885bcdce2Sdrh ** The pExpr parameter is the SELECT or EXISTS operator to be coded.
285985bcdce2Sdrh **
286085bcdce2Sdrh ** The register that holds the result.  For a multi-column SELECT,
286185bcdce2Sdrh ** the result is stored in a contiguous array of registers and the
286285bcdce2Sdrh ** return value is the register of the left-most result column.
286385bcdce2Sdrh ** Return 0 if an error occurs.
286485bcdce2Sdrh */
286585bcdce2Sdrh #ifndef SQLITE_OMIT_SUBQUERY
286685bcdce2Sdrh int sqlite3CodeSubselect(Parse *pParse, Expr *pExpr){
28672c04131cSdrh   int addrOnce = 0;           /* Address of OP_Once at top of subroutine */
286885bcdce2Sdrh   int rReg = 0;               /* Register storing resulting */
286985bcdce2Sdrh   Select *pSel;               /* SELECT statement to encode */
287085bcdce2Sdrh   SelectDest dest;            /* How to deal with SELECT result */
287185bcdce2Sdrh   int nReg;                   /* Registers to allocate */
287285bcdce2Sdrh   Expr *pLimit;               /* New limit expression */
28732c04131cSdrh 
28742c04131cSdrh   Vdbe *v = pParse->pVdbe;
287585bcdce2Sdrh   assert( v!=0 );
2876bd462bccSdrh   testcase( pExpr->op==TK_EXISTS );
2877bd462bccSdrh   testcase( pExpr->op==TK_SELECT );
2878bd462bccSdrh   assert( pExpr->op==TK_EXISTS || pExpr->op==TK_SELECT );
2879bd462bccSdrh   assert( ExprHasProperty(pExpr, EP_xIsSelect) );
2880bd462bccSdrh   pSel = pExpr->x.pSelect;
288185bcdce2Sdrh 
28825198ff57Sdrh   /* The evaluation of the EXISTS/SELECT must be repeated every time it
288385bcdce2Sdrh   ** is encountered if any of the following is true:
288485bcdce2Sdrh   **
288585bcdce2Sdrh   **    *  The right-hand side is a correlated subquery
288685bcdce2Sdrh   **    *  The right-hand side is an expression list containing variables
288785bcdce2Sdrh   **    *  We are inside a trigger
288885bcdce2Sdrh   **
288985bcdce2Sdrh   ** If all of the above are false, then we can run this code just once
289085bcdce2Sdrh   ** save the results, and reuse the same result on subsequent invocations.
289185bcdce2Sdrh   */
289285bcdce2Sdrh   if( !ExprHasProperty(pExpr, EP_VarSelect) ){
28935198ff57Sdrh     /* If this routine has already been coded, then invoke it as a
28945198ff57Sdrh     ** subroutine. */
28955198ff57Sdrh     if( ExprHasProperty(pExpr, EP_Subrtn) ){
2896bd462bccSdrh       ExplainQueryPlan((pParse, 0, "REUSE SUBQUERY %d", pSel->selId));
28975198ff57Sdrh       sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
28985198ff57Sdrh                         pExpr->y.sub.iAddr);
28995198ff57Sdrh       return pExpr->iTable;
29005198ff57Sdrh     }
29015198ff57Sdrh 
29025198ff57Sdrh     /* Begin coding the subroutine */
29035198ff57Sdrh     ExprSetProperty(pExpr, EP_Subrtn);
29045198ff57Sdrh     pExpr->y.sub.regReturn = ++pParse->nMem;
29055198ff57Sdrh     pExpr->y.sub.iAddr =
29065198ff57Sdrh       sqlite3VdbeAddOp2(v, OP_Integer, 0, pExpr->y.sub.regReturn) + 1;
29075198ff57Sdrh     VdbeComment((v, "return address"));
29085198ff57Sdrh 
29092c04131cSdrh     addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
2910fef5208cSdrh   }
2911fef5208cSdrh 
291285bcdce2Sdrh   /* For a SELECT, generate code to put the values for all columns of
291339a11819Sdrh   ** the first row into an array of registers and return the index of
291439a11819Sdrh   ** the first register.
291539a11819Sdrh   **
291639a11819Sdrh   ** If this is an EXISTS, write an integer 0 (not exists) or 1 (exists)
291739a11819Sdrh   ** into a register and return that register number.
291839a11819Sdrh   **
291939a11819Sdrh   ** In both cases, the query is augmented with "LIMIT 1".  Any
292039a11819Sdrh   ** preexisting limit is discarded in place of the new LIMIT 1.
2921fef5208cSdrh   */
2922bd462bccSdrh   ExplainQueryPlan((pParse, 1, "%sSCALAR SUBQUERY %d",
2923bd462bccSdrh         addrOnce?"":"CORRELATED ", pSel->selId));
292471c57db0Sdan   nReg = pExpr->op==TK_SELECT ? pSel->pEList->nExpr : 1;
292571c57db0Sdan   sqlite3SelectDestInit(&dest, 0, pParse->nMem+1);
292671c57db0Sdan   pParse->nMem += nReg;
292751522cd3Sdrh   if( pExpr->op==TK_SELECT ){
29286c8c8ce0Sdanielk1977     dest.eDest = SRT_Mem;
292953932ce8Sdrh     dest.iSdst = dest.iSDParm;
293071c57db0Sdan     dest.nSdst = nReg;
293171c57db0Sdan     sqlite3VdbeAddOp3(v, OP_Null, 0, dest.iSDParm, dest.iSDParm+nReg-1);
2932d4e70ebdSdrh     VdbeComment((v, "Init subquery result"));
293351522cd3Sdrh   }else{
29346c8c8ce0Sdanielk1977     dest.eDest = SRT_Exists;
29352b596da8Sdrh     sqlite3VdbeAddOp2(v, OP_Integer, 0, dest.iSDParm);
2936d4e70ebdSdrh     VdbeComment((v, "Init EXISTS result"));
293751522cd3Sdrh   }
29388c0833fbSdrh   pLimit = sqlite3ExprAlloc(pParse->db, TK_INTEGER,&sqlite3IntTokens[1], 0);
29398c0833fbSdrh   if( pSel->pLimit ){
29408c0833fbSdrh     sqlite3ExprDelete(pParse->db, pSel->pLimit->pLeft);
29418c0833fbSdrh     pSel->pLimit->pLeft = pLimit;
29428c0833fbSdrh   }else{
29438c0833fbSdrh     pSel->pLimit = sqlite3PExpr(pParse, TK_LIMIT, pLimit, 0);
29448c0833fbSdrh   }
294548b5b041Sdrh   pSel->iLimit = 0;
29467d10d5a6Sdrh   if( sqlite3Select(pParse, pSel, &dest) ){
29471450bc6eSdrh     return 0;
294894ccde58Sdrh   }
29492c04131cSdrh   pExpr->iTable = rReg = dest.iSDParm;
2950ebb6a65dSdrh   ExprSetVVAProperty(pExpr, EP_NoReduce);
29512c04131cSdrh   if( addrOnce ){
29522c04131cSdrh     sqlite3VdbeJumpHere(v, addrOnce);
2953fc976065Sdanielk1977 
29542c04131cSdrh     /* Subroutine return */
29552c04131cSdrh     sqlite3VdbeAddOp1(v, OP_Return, pExpr->y.sub.regReturn);
29562c04131cSdrh     sqlite3VdbeChangeP1(v, pExpr->y.sub.iAddr-1, sqlite3VdbeCurrentAddr(v)-1);
29575198ff57Sdrh   }
29582c04131cSdrh 
29591450bc6eSdrh   return rReg;
2960cce7d176Sdrh }
296151522cd3Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
2962cce7d176Sdrh 
2963e3365e6cSdrh #ifndef SQLITE_OMIT_SUBQUERY
2964e3365e6cSdrh /*
29657b35a77bSdan ** Expr pIn is an IN(...) expression. This function checks that the
29667b35a77bSdan ** sub-select on the RHS of the IN() operator has the same number of
29677b35a77bSdan ** columns as the vector on the LHS. Or, if the RHS of the IN() is not
29687b35a77bSdan ** a sub-query, that the LHS is a vector of size 1.
29697b35a77bSdan */
29707b35a77bSdan int sqlite3ExprCheckIN(Parse *pParse, Expr *pIn){
29717b35a77bSdan   int nVector = sqlite3ExprVectorSize(pIn->pLeft);
29727b35a77bSdan   if( (pIn->flags & EP_xIsSelect) ){
29737b35a77bSdan     if( nVector!=pIn->x.pSelect->pEList->nExpr ){
29747b35a77bSdan       sqlite3SubselectError(pParse, pIn->x.pSelect->pEList->nExpr, nVector);
29757b35a77bSdan       return 1;
29767b35a77bSdan     }
29777b35a77bSdan   }else if( nVector!=1 ){
297844c5604cSdan     sqlite3VectorErrorMsg(pParse, pIn->pLeft);
29797b35a77bSdan     return 1;
29807b35a77bSdan   }
29817b35a77bSdan   return 0;
29827b35a77bSdan }
29837b35a77bSdan #endif
29847b35a77bSdan 
29857b35a77bSdan #ifndef SQLITE_OMIT_SUBQUERY
29867b35a77bSdan /*
2987e3365e6cSdrh ** Generate code for an IN expression.
2988e3365e6cSdrh **
2989e3365e6cSdrh **      x IN (SELECT ...)
2990e3365e6cSdrh **      x IN (value, value, ...)
2991e3365e6cSdrh **
2992ecb87ac8Sdrh ** The left-hand side (LHS) is a scalar or vector expression.  The
2993e347d3e8Sdrh ** right-hand side (RHS) is an array of zero or more scalar values, or a
2994e347d3e8Sdrh ** subquery.  If the RHS is a subquery, the number of result columns must
2995e347d3e8Sdrh ** match the number of columns in the vector on the LHS.  If the RHS is
2996e347d3e8Sdrh ** a list of values, the LHS must be a scalar.
2997e347d3e8Sdrh **
2998e347d3e8Sdrh ** The IN operator is true if the LHS value is contained within the RHS.
2999e347d3e8Sdrh ** The result is false if the LHS is definitely not in the RHS.  The
3000e347d3e8Sdrh ** result is NULL if the presence of the LHS in the RHS cannot be
3001e347d3e8Sdrh ** determined due to NULLs.
3002e3365e6cSdrh **
30036be515ebSdrh ** This routine generates code that jumps to destIfFalse if the LHS is not
3004e3365e6cSdrh ** contained within the RHS.  If due to NULLs we cannot determine if the LHS
3005e3365e6cSdrh ** is contained in the RHS then jump to destIfNull.  If the LHS is contained
3006e3365e6cSdrh ** within the RHS then fall through.
3007ecb87ac8Sdrh **
3008ecb87ac8Sdrh ** See the separate in-operator.md documentation file in the canonical
3009ecb87ac8Sdrh ** SQLite source tree for additional information.
3010e3365e6cSdrh */
3011e3365e6cSdrh static void sqlite3ExprCodeIN(
3012e3365e6cSdrh   Parse *pParse,        /* Parsing and code generating context */
3013e3365e6cSdrh   Expr *pExpr,          /* The IN expression */
3014e3365e6cSdrh   int destIfFalse,      /* Jump here if LHS is not contained in the RHS */
3015e3365e6cSdrh   int destIfNull        /* Jump here if the results are unknown due to NULLs */
3016e3365e6cSdrh ){
3017e3365e6cSdrh   int rRhsHasNull = 0;  /* Register that is true if RHS contains NULL values */
3018e3365e6cSdrh   int eType;            /* Type of the RHS */
3019e347d3e8Sdrh   int rLhs;             /* Register(s) holding the LHS values */
3020e347d3e8Sdrh   int rLhsOrig;         /* LHS values prior to reordering by aiMap[] */
3021e3365e6cSdrh   Vdbe *v;              /* Statement under construction */
3022ba00e30aSdan   int *aiMap = 0;       /* Map from vector field to index column */
3023ba00e30aSdan   char *zAff = 0;       /* Affinity string for comparisons */
3024ecb87ac8Sdrh   int nVector;          /* Size of vectors for this IN operator */
302512abf408Sdrh   int iDummy;           /* Dummy parameter to exprCodeVector() */
3026e347d3e8Sdrh   Expr *pLeft;          /* The LHS of the IN operator */
3027ecb87ac8Sdrh   int i;                /* loop counter */
3028e347d3e8Sdrh   int destStep2;        /* Where to jump when NULLs seen in step 2 */
3029e347d3e8Sdrh   int destStep6 = 0;    /* Start of code for Step 6 */
3030e347d3e8Sdrh   int addrTruthOp;      /* Address of opcode that determines the IN is true */
3031e347d3e8Sdrh   int destNotNull;      /* Jump here if a comparison is not true in step 6 */
3032e347d3e8Sdrh   int addrTop;          /* Top of the step-6 loop */
30332c04131cSdrh   int iTab = 0;         /* Index to use */
3034e3365e6cSdrh 
3035e347d3e8Sdrh   pLeft = pExpr->pLeft;
30367b35a77bSdan   if( sqlite3ExprCheckIN(pParse, pExpr) ) return;
3037553168c7Sdan   zAff = exprINAffinity(pParse, pExpr);
3038ba00e30aSdan   nVector = sqlite3ExprVectorSize(pExpr->pLeft);
3039ba00e30aSdan   aiMap = (int*)sqlite3DbMallocZero(
3040ba00e30aSdan       pParse->db, nVector*(sizeof(int) + sizeof(char)) + 1
3041ba00e30aSdan   );
3042e347d3e8Sdrh   if( pParse->db->mallocFailed ) goto sqlite3ExprCodeIN_oom_error;
30437b35a77bSdan 
3044ba00e30aSdan   /* Attempt to compute the RHS. After this step, if anything other than
30452c04131cSdrh   ** IN_INDEX_NOOP is returned, the table opened with cursor iTab
3046ba00e30aSdan   ** contains the values that make up the RHS. If IN_INDEX_NOOP is returned,
3047ba00e30aSdan   ** the RHS has not yet been coded.  */
3048e3365e6cSdrh   v = pParse->pVdbe;
3049e3365e6cSdrh   assert( v!=0 );       /* OOM detected prior to this routine */
3050e3365e6cSdrh   VdbeNoopComment((v, "begin IN expr"));
3051bb53ecb1Sdrh   eType = sqlite3FindInIndex(pParse, pExpr,
3052bb53ecb1Sdrh                              IN_INDEX_MEMBERSHIP | IN_INDEX_NOOP_OK,
30532c04131cSdrh                              destIfFalse==destIfNull ? 0 : &rRhsHasNull,
30542c04131cSdrh                              aiMap, &iTab);
3055e3365e6cSdrh 
3056ba00e30aSdan   assert( pParse->nErr || nVector==1 || eType==IN_INDEX_EPH
3057ba00e30aSdan        || eType==IN_INDEX_INDEX_ASC || eType==IN_INDEX_INDEX_DESC
3058ba00e30aSdan   );
3059ecb87ac8Sdrh #ifdef SQLITE_DEBUG
3060ecb87ac8Sdrh   /* Confirm that aiMap[] contains nVector integer values between 0 and
3061ecb87ac8Sdrh   ** nVector-1. */
3062ecb87ac8Sdrh   for(i=0; i<nVector; i++){
3063ecb87ac8Sdrh     int j, cnt;
3064ecb87ac8Sdrh     for(cnt=j=0; j<nVector; j++) if( aiMap[j]==i ) cnt++;
3065ecb87ac8Sdrh     assert( cnt==1 );
3066ecb87ac8Sdrh   }
3067ecb87ac8Sdrh #endif
3068e3365e6cSdrh 
3069ba00e30aSdan   /* Code the LHS, the <expr> from "<expr> IN (...)". If the LHS is a
3070ba00e30aSdan   ** vector, then it is stored in an array of nVector registers starting
3071ba00e30aSdan   ** at r1.
3072e347d3e8Sdrh   **
3073e347d3e8Sdrh   ** sqlite3FindInIndex() might have reordered the fields of the LHS vector
3074e347d3e8Sdrh   ** so that the fields are in the same order as an existing index.   The
3075e347d3e8Sdrh   ** aiMap[] array contains a mapping from the original LHS field order to
3076e347d3e8Sdrh   ** the field order that matches the RHS index.
3077e3365e6cSdrh   */
3078e347d3e8Sdrh   rLhsOrig = exprCodeVector(pParse, pLeft, &iDummy);
3079e347d3e8Sdrh   for(i=0; i<nVector && aiMap[i]==i; i++){} /* Are LHS fields reordered? */
3080ecb87ac8Sdrh   if( i==nVector ){
3081e347d3e8Sdrh     /* LHS fields are not reordered */
3082e347d3e8Sdrh     rLhs = rLhsOrig;
3083ecb87ac8Sdrh   }else{
3084ecb87ac8Sdrh     /* Need to reorder the LHS fields according to aiMap */
3085e347d3e8Sdrh     rLhs = sqlite3GetTempRange(pParse, nVector);
3086ba00e30aSdan     for(i=0; i<nVector; i++){
3087e347d3e8Sdrh       sqlite3VdbeAddOp3(v, OP_Copy, rLhsOrig+i, rLhs+aiMap[i], 0);
3088ba00e30aSdan     }
3089ecb87ac8Sdrh   }
3090e3365e6cSdrh 
3091bb53ecb1Sdrh   /* If sqlite3FindInIndex() did not find or create an index that is
3092bb53ecb1Sdrh   ** suitable for evaluating the IN operator, then evaluate using a
3093bb53ecb1Sdrh   ** sequence of comparisons.
3094e347d3e8Sdrh   **
3095e347d3e8Sdrh   ** This is step (1) in the in-operator.md optimized algorithm.
3096bb53ecb1Sdrh   */
3097bb53ecb1Sdrh   if( eType==IN_INDEX_NOOP ){
3098bb53ecb1Sdrh     ExprList *pList = pExpr->x.pList;
3099bb53ecb1Sdrh     CollSeq *pColl = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
3100ec4ccdbcSdrh     int labelOk = sqlite3VdbeMakeLabel(pParse);
3101bb53ecb1Sdrh     int r2, regToFree;
3102bb53ecb1Sdrh     int regCkNull = 0;
3103bb53ecb1Sdrh     int ii;
3104bb53ecb1Sdrh     assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
3105bb53ecb1Sdrh     if( destIfNull!=destIfFalse ){
3106bb53ecb1Sdrh       regCkNull = sqlite3GetTempReg(pParse);
3107e347d3e8Sdrh       sqlite3VdbeAddOp3(v, OP_BitAnd, rLhs, rLhs, regCkNull);
3108bb53ecb1Sdrh     }
3109bb53ecb1Sdrh     for(ii=0; ii<pList->nExpr; ii++){
3110bb53ecb1Sdrh       r2 = sqlite3ExprCodeTemp(pParse, pList->a[ii].pExpr, &regToFree);
3111a976979bSdrh       if( regCkNull && sqlite3ExprCanBeNull(pList->a[ii].pExpr) ){
3112bb53ecb1Sdrh         sqlite3VdbeAddOp3(v, OP_BitAnd, regCkNull, r2, regCkNull);
3113bb53ecb1Sdrh       }
3114bb53ecb1Sdrh       if( ii<pList->nExpr-1 || destIfNull!=destIfFalse ){
3115e347d3e8Sdrh         sqlite3VdbeAddOp4(v, OP_Eq, rLhs, labelOk, r2,
31164336b0e6Sdrh                           (void*)pColl, P4_COLLSEQ);
31174336b0e6Sdrh         VdbeCoverageIf(v, ii<pList->nExpr-1);
31184336b0e6Sdrh         VdbeCoverageIf(v, ii==pList->nExpr-1);
3119ba00e30aSdan         sqlite3VdbeChangeP5(v, zAff[0]);
3120bb53ecb1Sdrh       }else{
3121bb53ecb1Sdrh         assert( destIfNull==destIfFalse );
3122e347d3e8Sdrh         sqlite3VdbeAddOp4(v, OP_Ne, rLhs, destIfFalse, r2,
3123bb53ecb1Sdrh                           (void*)pColl, P4_COLLSEQ); VdbeCoverage(v);
3124ba00e30aSdan         sqlite3VdbeChangeP5(v, zAff[0] | SQLITE_JUMPIFNULL);
3125bb53ecb1Sdrh       }
3126bb53ecb1Sdrh       sqlite3ReleaseTempReg(pParse, regToFree);
3127bb53ecb1Sdrh     }
3128bb53ecb1Sdrh     if( regCkNull ){
3129bb53ecb1Sdrh       sqlite3VdbeAddOp2(v, OP_IsNull, regCkNull, destIfNull); VdbeCoverage(v);
3130076e85f5Sdrh       sqlite3VdbeGoto(v, destIfFalse);
3131bb53ecb1Sdrh     }
3132bb53ecb1Sdrh     sqlite3VdbeResolveLabel(v, labelOk);
3133bb53ecb1Sdrh     sqlite3ReleaseTempReg(pParse, regCkNull);
3134e347d3e8Sdrh     goto sqlite3ExprCodeIN_finished;
3135e347d3e8Sdrh   }
3136bb53ecb1Sdrh 
3137e347d3e8Sdrh   /* Step 2: Check to see if the LHS contains any NULL columns.  If the
3138e347d3e8Sdrh   ** LHS does contain NULLs then the result must be either FALSE or NULL.
3139e347d3e8Sdrh   ** We will then skip the binary search of the RHS.
3140e347d3e8Sdrh   */
3141094430ebSdrh   if( destIfNull==destIfFalse ){
3142e347d3e8Sdrh     destStep2 = destIfFalse;
3143e347d3e8Sdrh   }else{
3144ec4ccdbcSdrh     destStep2 = destStep6 = sqlite3VdbeMakeLabel(pParse);
3145e347d3e8Sdrh   }
3146d49fd4e8Sdan   for(i=0; i<nVector; i++){
3147fc7f27b9Sdrh     Expr *p = sqlite3VectorFieldSubexpr(pExpr->pLeft, i);
3148d49fd4e8Sdan     if( sqlite3ExprCanBeNull(p) ){
3149e347d3e8Sdrh       sqlite3VdbeAddOp2(v, OP_IsNull, rLhs+i, destStep2);
3150471b4b92Sdrh       VdbeCoverage(v);
3151d49fd4e8Sdan     }
3152d49fd4e8Sdan   }
3153e3365e6cSdrh 
3154e347d3e8Sdrh   /* Step 3.  The LHS is now known to be non-NULL.  Do the binary search
3155e347d3e8Sdrh   ** of the RHS using the LHS as a probe.  If found, the result is
3156e347d3e8Sdrh   ** true.
3157e347d3e8Sdrh   */
3158e3365e6cSdrh   if( eType==IN_INDEX_ROWID ){
3159e347d3e8Sdrh     /* In this case, the RHS is the ROWID of table b-tree and so we also
3160e347d3e8Sdrh     ** know that the RHS is non-NULL.  Hence, we combine steps 3 and 4
3161e347d3e8Sdrh     ** into a single opcode. */
31622c04131cSdrh     sqlite3VdbeAddOp3(v, OP_SeekRowid, iTab, destIfFalse, rLhs);
3163688852abSdrh     VdbeCoverage(v);
3164e347d3e8Sdrh     addrTruthOp = sqlite3VdbeAddOp0(v, OP_Goto);  /* Return True */
31657b35a77bSdan   }else{
3166e347d3e8Sdrh     sqlite3VdbeAddOp4(v, OP_Affinity, rLhs, nVector, 0, zAff, nVector);
3167e347d3e8Sdrh     if( destIfFalse==destIfNull ){
3168e347d3e8Sdrh       /* Combine Step 3 and Step 5 into a single opcode */
31692c04131cSdrh       sqlite3VdbeAddOp4Int(v, OP_NotFound, iTab, destIfFalse,
3170e347d3e8Sdrh                            rLhs, nVector); VdbeCoverage(v);
3171e347d3e8Sdrh       goto sqlite3ExprCodeIN_finished;
3172e347d3e8Sdrh     }
3173e347d3e8Sdrh     /* Ordinary Step 3, for the case where FALSE and NULL are distinct */
31742c04131cSdrh     addrTruthOp = sqlite3VdbeAddOp4Int(v, OP_Found, iTab, 0,
3175e347d3e8Sdrh                                       rLhs, nVector); VdbeCoverage(v);
3176e347d3e8Sdrh   }
3177ba00e30aSdan 
3178e347d3e8Sdrh   /* Step 4.  If the RHS is known to be non-NULL and we did not find
3179e347d3e8Sdrh   ** an match on the search above, then the result must be FALSE.
3180e347d3e8Sdrh   */
3181e347d3e8Sdrh   if( rRhsHasNull && nVector==1 ){
3182e347d3e8Sdrh     sqlite3VdbeAddOp2(v, OP_NotNull, rRhsHasNull, destIfFalse);
3183471b4b92Sdrh     VdbeCoverage(v);
3184e347d3e8Sdrh   }
31857b35a77bSdan 
3186e347d3e8Sdrh   /* Step 5.  If we do not care about the difference between NULL and
3187e347d3e8Sdrh   ** FALSE, then just return false.
3188e347d3e8Sdrh   */
3189e347d3e8Sdrh   if( destIfFalse==destIfNull ) sqlite3VdbeGoto(v, destIfFalse);
3190e347d3e8Sdrh 
3191e347d3e8Sdrh   /* Step 6: Loop through rows of the RHS.  Compare each row to the LHS.
3192e347d3e8Sdrh   ** If any comparison is NULL, then the result is NULL.  If all
3193e347d3e8Sdrh   ** comparisons are FALSE then the final result is FALSE.
3194e347d3e8Sdrh   **
3195e347d3e8Sdrh   ** For a scalar LHS, it is sufficient to check just the first row
3196e347d3e8Sdrh   ** of the RHS.
3197e347d3e8Sdrh   */
3198e347d3e8Sdrh   if( destStep6 ) sqlite3VdbeResolveLabel(v, destStep6);
31992c04131cSdrh   addrTop = sqlite3VdbeAddOp2(v, OP_Rewind, iTab, destIfFalse);
3200471b4b92Sdrh   VdbeCoverage(v);
3201e347d3e8Sdrh   if( nVector>1 ){
3202ec4ccdbcSdrh     destNotNull = sqlite3VdbeMakeLabel(pParse);
3203e347d3e8Sdrh   }else{
3204e347d3e8Sdrh     /* For nVector==1, combine steps 6 and 7 by immediately returning
3205e347d3e8Sdrh     ** FALSE if the first comparison is not NULL */
3206e347d3e8Sdrh     destNotNull = destIfFalse;
3207e347d3e8Sdrh   }
3208ba00e30aSdan   for(i=0; i<nVector; i++){
3209ba00e30aSdan     Expr *p;
3210ba00e30aSdan     CollSeq *pColl;
3211e347d3e8Sdrh     int r3 = sqlite3GetTempReg(pParse);
3212fc7f27b9Sdrh     p = sqlite3VectorFieldSubexpr(pLeft, i);
3213ba00e30aSdan     pColl = sqlite3ExprCollSeq(pParse, p);
32142c04131cSdrh     sqlite3VdbeAddOp3(v, OP_Column, iTab, i, r3);
3215e347d3e8Sdrh     sqlite3VdbeAddOp4(v, OP_Ne, rLhs+i, destNotNull, r3,
321618016ad2Sdrh                       (void*)pColl, P4_COLLSEQ);
3217471b4b92Sdrh     VdbeCoverage(v);
3218e347d3e8Sdrh     sqlite3ReleaseTempReg(pParse, r3);
32197b35a77bSdan   }
32207b35a77bSdan   sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfNull);
3221e347d3e8Sdrh   if( nVector>1 ){
3222e347d3e8Sdrh     sqlite3VdbeResolveLabel(v, destNotNull);
32232c04131cSdrh     sqlite3VdbeAddOp2(v, OP_Next, iTab, addrTop+1);
322418016ad2Sdrh     VdbeCoverage(v);
3225e347d3e8Sdrh 
3226e347d3e8Sdrh     /* Step 7:  If we reach this point, we know that the result must
3227e347d3e8Sdrh     ** be false. */
322818016ad2Sdrh     sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfFalse);
32297b35a77bSdan   }
32307b35a77bSdan 
3231e347d3e8Sdrh   /* Jumps here in order to return true. */
3232e347d3e8Sdrh   sqlite3VdbeJumpHere(v, addrTruthOp);
3233e3365e6cSdrh 
3234e347d3e8Sdrh sqlite3ExprCodeIN_finished:
3235e347d3e8Sdrh   if( rLhs!=rLhsOrig ) sqlite3ReleaseTempReg(pParse, rLhs);
3236ecb87ac8Sdrh   VdbeComment((v, "end IN expr"));
3237e347d3e8Sdrh sqlite3ExprCodeIN_oom_error:
3238ba00e30aSdan   sqlite3DbFree(pParse->db, aiMap);
3239553168c7Sdan   sqlite3DbFree(pParse->db, zAff);
3240e3365e6cSdrh }
3241e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
3242e3365e6cSdrh 
324313573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
3244598f1340Sdrh /*
3245598f1340Sdrh ** Generate an instruction that will put the floating point
32469cbf3425Sdrh ** value described by z[0..n-1] into register iMem.
32470cf19ed8Sdrh **
32480cf19ed8Sdrh ** The z[] string will probably not be zero-terminated.  But the
32490cf19ed8Sdrh ** z[n] character is guaranteed to be something that does not look
32500cf19ed8Sdrh ** like the continuation of the number.
3251598f1340Sdrh */
3252b7916a78Sdrh static void codeReal(Vdbe *v, const char *z, int negateFlag, int iMem){
3253fd773cf9Sdrh   if( ALWAYS(z!=0) ){
3254598f1340Sdrh     double value;
32559339da1fSdrh     sqlite3AtoF(z, &value, sqlite3Strlen30(z), SQLITE_UTF8);
3256d0015161Sdrh     assert( !sqlite3IsNaN(value) ); /* The new AtoF never returns NaN */
3257598f1340Sdrh     if( negateFlag ) value = -value;
325897bae794Sdrh     sqlite3VdbeAddOp4Dup8(v, OP_Real, 0, iMem, 0, (u8*)&value, P4_REAL);
3259598f1340Sdrh   }
3260598f1340Sdrh }
326113573c71Sdrh #endif
3262598f1340Sdrh 
3263598f1340Sdrh 
3264598f1340Sdrh /*
3265fec19aadSdrh ** Generate an instruction that will put the integer describe by
32669cbf3425Sdrh ** text z[0..n-1] into register iMem.
32670cf19ed8Sdrh **
32685f1d6b61Sshaneh ** Expr.u.zToken is always UTF8 and zero-terminated.
3269fec19aadSdrh */
327013573c71Sdrh static void codeInteger(Parse *pParse, Expr *pExpr, int negFlag, int iMem){
327113573c71Sdrh   Vdbe *v = pParse->pVdbe;
327292b01d53Sdrh   if( pExpr->flags & EP_IntValue ){
327333e619fcSdrh     int i = pExpr->u.iValue;
3274d50ffc41Sdrh     assert( i>=0 );
327592b01d53Sdrh     if( negFlag ) i = -i;
327692b01d53Sdrh     sqlite3VdbeAddOp2(v, OP_Integer, i, iMem);
3277fd773cf9Sdrh   }else{
32785f1d6b61Sshaneh     int c;
32795f1d6b61Sshaneh     i64 value;
3280fd773cf9Sdrh     const char *z = pExpr->u.zToken;
3281fd773cf9Sdrh     assert( z!=0 );
32829296c18aSdrh     c = sqlite3DecOrHexToI64(z, &value);
328384d4f1a3Sdrh     if( (c==3 && !negFlag) || (c==2) || (negFlag && value==SMALLEST_INT64)){
328413573c71Sdrh #ifdef SQLITE_OMIT_FLOATING_POINT
328513573c71Sdrh       sqlite3ErrorMsg(pParse, "oversized integer: %s%s", negFlag ? "-" : "", z);
328613573c71Sdrh #else
32871b7ddc59Sdrh #ifndef SQLITE_OMIT_HEX_INTEGER
32889296c18aSdrh       if( sqlite3_strnicmp(z,"0x",2)==0 ){
328977320ea4Sdrh         sqlite3ErrorMsg(pParse, "hex literal too big: %s%s", negFlag?"-":"",z);
32901b7ddc59Sdrh       }else
32911b7ddc59Sdrh #endif
32921b7ddc59Sdrh       {
3293b7916a78Sdrh         codeReal(v, z, negFlag, iMem);
32949296c18aSdrh       }
329513573c71Sdrh #endif
329677320ea4Sdrh     }else{
329784d4f1a3Sdrh       if( negFlag ){ value = c==3 ? SMALLEST_INT64 : -value; }
329877320ea4Sdrh       sqlite3VdbeAddOp4Dup8(v, OP_Int64, 0, iMem, 0, (u8*)&value, P4_INT64);
3299fec19aadSdrh     }
3300fec19aadSdrh   }
3301c9cf901dSdanielk1977 }
3302fec19aadSdrh 
33035cd79239Sdrh 
33041f9ca2c8Sdrh /* Generate code that will load into register regOut a value that is
33051f9ca2c8Sdrh ** appropriate for the iIdxCol-th column of index pIdx.
33061f9ca2c8Sdrh */
33071f9ca2c8Sdrh void sqlite3ExprCodeLoadIndexColumn(
33081f9ca2c8Sdrh   Parse *pParse,  /* The parsing context */
33091f9ca2c8Sdrh   Index *pIdx,    /* The index whose column is to be loaded */
33101f9ca2c8Sdrh   int iTabCur,    /* Cursor pointing to a table row */
33111f9ca2c8Sdrh   int iIdxCol,    /* The column of the index to be loaded */
33121f9ca2c8Sdrh   int regOut      /* Store the index column value in this register */
33131f9ca2c8Sdrh ){
33141f9ca2c8Sdrh   i16 iTabCol = pIdx->aiColumn[iIdxCol];
33154b92f98cSdrh   if( iTabCol==XN_EXPR ){
33161f9ca2c8Sdrh     assert( pIdx->aColExpr );
33171f9ca2c8Sdrh     assert( pIdx->aColExpr->nExpr>iIdxCol );
33183e34eabcSdrh     pParse->iSelfTab = iTabCur + 1;
33191c75c9d7Sdrh     sqlite3ExprCodeCopy(pParse, pIdx->aColExpr->a[iIdxCol].pExpr, regOut);
33203e34eabcSdrh     pParse->iSelfTab = 0;
33214b92f98cSdrh   }else{
33224b92f98cSdrh     sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pIdx->pTable, iTabCur,
33234b92f98cSdrh                                     iTabCol, regOut);
33244b92f98cSdrh   }
33251f9ca2c8Sdrh }
33261f9ca2c8Sdrh 
33275cd79239Sdrh /*
33285c092e8aSdrh ** Generate code to extract the value of the iCol-th column of a table.
33295c092e8aSdrh */
33305c092e8aSdrh void sqlite3ExprCodeGetColumnOfTable(
33315c092e8aSdrh   Vdbe *v,        /* The VDBE under construction */
33325c092e8aSdrh   Table *pTab,    /* The table containing the value */
3333313619f5Sdrh   int iTabCur,    /* The table cursor.  Or the PK cursor for WITHOUT ROWID */
33345c092e8aSdrh   int iCol,       /* Index of the column to extract */
3335313619f5Sdrh   int regOut      /* Extract the value into this register */
33365c092e8aSdrh ){
3337aca19e19Sdrh   if( pTab==0 ){
3338aca19e19Sdrh     sqlite3VdbeAddOp3(v, OP_Column, iTabCur, iCol, regOut);
3339aca19e19Sdrh     return;
3340aca19e19Sdrh   }
33415c092e8aSdrh   if( iCol<0 || iCol==pTab->iPKey ){
33425c092e8aSdrh     sqlite3VdbeAddOp2(v, OP_Rowid, iTabCur, regOut);
33435c092e8aSdrh   }else{
33445c092e8aSdrh     int op = IsVirtual(pTab) ? OP_VColumn : OP_Column;
3345ee0ec8e1Sdrh     int x = iCol;
334635db31b2Sdrh     if( !HasRowid(pTab) && !IsVirtual(pTab) ){
3347ee0ec8e1Sdrh       x = sqlite3ColumnOfIndex(sqlite3PrimaryKeyIndex(pTab), iCol);
3348ee0ec8e1Sdrh     }
3349ee0ec8e1Sdrh     sqlite3VdbeAddOp3(v, op, iTabCur, x, regOut);
33505c092e8aSdrh   }
33515c092e8aSdrh   if( iCol>=0 ){
33525c092e8aSdrh     sqlite3ColumnDefault(v, pTab, iCol, regOut);
33535c092e8aSdrh   }
33545c092e8aSdrh }
33555c092e8aSdrh 
33565c092e8aSdrh /*
3357945498f3Sdrh ** Generate code that will extract the iColumn-th column from
33588c607191Sdrh ** table pTab and store the column value in register iReg.
3359e55cbd72Sdrh **
3360e55cbd72Sdrh ** There must be an open cursor to pTab in iTable when this routine
3361e55cbd72Sdrh ** is called.  If iColumn<0 then code is generated that extracts the rowid.
3362945498f3Sdrh */
3363e55cbd72Sdrh int sqlite3ExprCodeGetColumn(
3364e55cbd72Sdrh   Parse *pParse,   /* Parsing and code generating context */
33652133d822Sdrh   Table *pTab,     /* Description of the table we are reading from */
33662133d822Sdrh   int iColumn,     /* Index of the table column */
33672133d822Sdrh   int iTable,      /* The cursor pointing to the table */
3368a748fdccSdrh   int iReg,        /* Store results here */
3369ce78bc6eSdrh   u8 p5            /* P5 value for OP_Column + FLAGS */
33702133d822Sdrh ){
3371e55cbd72Sdrh   Vdbe *v = pParse->pVdbe;
3372e55cbd72Sdrh   assert( v!=0 );
33735c092e8aSdrh   sqlite3ExprCodeGetColumnOfTable(v, pTab, iTable, iColumn, iReg);
3374a748fdccSdrh   if( p5 ){
3375a748fdccSdrh     sqlite3VdbeChangeP5(v, p5);
3376a748fdccSdrh   }
3377e55cbd72Sdrh   return iReg;
3378e55cbd72Sdrh }
3379e55cbd72Sdrh 
3380e55cbd72Sdrh /*
3381b21e7c70Sdrh ** Generate code to move content from registers iFrom...iFrom+nReg-1
338236a5d88dSdrh ** over to iTo..iTo+nReg-1.
3383e55cbd72Sdrh */
3384b21e7c70Sdrh void sqlite3ExprCodeMove(Parse *pParse, int iFrom, int iTo, int nReg){
3385e8e4af76Sdrh   assert( iFrom>=iTo+nReg || iFrom+nReg<=iTo );
3386079a3072Sdrh   sqlite3VdbeAddOp3(pParse->pVdbe, OP_Move, iFrom, iTo, nReg);
3387945498f3Sdrh }
3388945498f3Sdrh 
3389652fbf55Sdrh /*
339012abf408Sdrh ** Convert a scalar expression node to a TK_REGISTER referencing
339112abf408Sdrh ** register iReg.  The caller must ensure that iReg already contains
339212abf408Sdrh ** the correct value for the expression.
3393a4c3c87eSdrh */
3394069d1b1fSdan static void exprToRegister(Expr *pExpr, int iReg){
3395069d1b1fSdan   Expr *p = sqlite3ExprSkipCollate(pExpr);
3396a4c3c87eSdrh   p->op2 = p->op;
3397a4c3c87eSdrh   p->op = TK_REGISTER;
3398a4c3c87eSdrh   p->iTable = iReg;
3399a4c3c87eSdrh   ExprClearProperty(p, EP_Skip);
3400a4c3c87eSdrh }
3401a4c3c87eSdrh 
340212abf408Sdrh /*
340312abf408Sdrh ** Evaluate an expression (either a vector or a scalar expression) and store
340412abf408Sdrh ** the result in continguous temporary registers.  Return the index of
340512abf408Sdrh ** the first register used to store the result.
340612abf408Sdrh **
340712abf408Sdrh ** If the returned result register is a temporary scalar, then also write
340812abf408Sdrh ** that register number into *piFreeable.  If the returned result register
340912abf408Sdrh ** is not a temporary or if the expression is a vector set *piFreeable
341012abf408Sdrh ** to 0.
341112abf408Sdrh */
341212abf408Sdrh static int exprCodeVector(Parse *pParse, Expr *p, int *piFreeable){
341312abf408Sdrh   int iResult;
341412abf408Sdrh   int nResult = sqlite3ExprVectorSize(p);
341512abf408Sdrh   if( nResult==1 ){
341612abf408Sdrh     iResult = sqlite3ExprCodeTemp(pParse, p, piFreeable);
341712abf408Sdrh   }else{
341812abf408Sdrh     *piFreeable = 0;
341912abf408Sdrh     if( p->op==TK_SELECT ){
3420dd1bb43aSdrh #if SQLITE_OMIT_SUBQUERY
3421dd1bb43aSdrh       iResult = 0;
3422dd1bb43aSdrh #else
342385bcdce2Sdrh       iResult = sqlite3CodeSubselect(pParse, p);
3424dd1bb43aSdrh #endif
342512abf408Sdrh     }else{
342612abf408Sdrh       int i;
342712abf408Sdrh       iResult = pParse->nMem+1;
342812abf408Sdrh       pParse->nMem += nResult;
342912abf408Sdrh       for(i=0; i<nResult; i++){
34304b725240Sdan         sqlite3ExprCodeFactorable(pParse, p->x.pList->a[i].pExpr, i+iResult);
343112abf408Sdrh       }
343212abf408Sdrh     }
343312abf408Sdrh   }
343412abf408Sdrh   return iResult;
343512abf408Sdrh }
343612abf408Sdrh 
343771c57db0Sdan 
3438a4c3c87eSdrh /*
3439cce7d176Sdrh ** Generate code into the current Vdbe to evaluate the given
34402dcef11bSdrh ** expression.  Attempt to store the results in register "target".
34412dcef11bSdrh ** Return the register where results are stored.
3442389a1adbSdrh **
34438b213899Sdrh ** With this routine, there is no guarantee that results will
34442dcef11bSdrh ** be stored in target.  The result might be stored in some other
34452dcef11bSdrh ** register if it is convenient to do so.  The calling function
34462dcef11bSdrh ** must check the return code and move the results to the desired
34472dcef11bSdrh ** register.
3448cce7d176Sdrh */
3449678ccce8Sdrh int sqlite3ExprCodeTarget(Parse *pParse, Expr *pExpr, int target){
34502dcef11bSdrh   Vdbe *v = pParse->pVdbe;  /* The VM under construction */
34512dcef11bSdrh   int op;                   /* The opcode being coded */
34522dcef11bSdrh   int inReg = target;       /* Results stored in register inReg */
34532dcef11bSdrh   int regFree1 = 0;         /* If non-zero free this temporary register */
34542dcef11bSdrh   int regFree2 = 0;         /* If non-zero free this temporary register */
34557b35a77bSdan   int r1, r2;               /* Various register numbers */
345610d1edf0Sdrh   Expr tempX;               /* Temporary expression node */
345771c57db0Sdan   int p5 = 0;
3458ffe07b2dSdrh 
34599cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
346020411ea7Sdrh   if( v==0 ){
346120411ea7Sdrh     assert( pParse->db->mallocFailed );
346220411ea7Sdrh     return 0;
346320411ea7Sdrh   }
3464389a1adbSdrh 
34651efa8023Sdrh expr_code_doover:
3466389a1adbSdrh   if( pExpr==0 ){
3467389a1adbSdrh     op = TK_NULL;
3468389a1adbSdrh   }else{
3469f2bc013cSdrh     op = pExpr->op;
3470389a1adbSdrh   }
3471f2bc013cSdrh   switch( op ){
347213449892Sdrh     case TK_AGG_COLUMN: {
347313449892Sdrh       AggInfo *pAggInfo = pExpr->pAggInfo;
347413449892Sdrh       struct AggInfo_col *pCol = &pAggInfo->aCol[pExpr->iAgg];
347513449892Sdrh       if( !pAggInfo->directMode ){
34769de221dfSdrh         assert( pCol->iMem>0 );
3477c332cc30Sdrh         return pCol->iMem;
347813449892Sdrh       }else if( pAggInfo->useSortingIdx ){
34795134d135Sdan         sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdxPTab,
3480389a1adbSdrh                               pCol->iSorterColumn, target);
3481c332cc30Sdrh         return target;
348213449892Sdrh       }
348313449892Sdrh       /* Otherwise, fall thru into the TK_COLUMN case */
348413449892Sdrh     }
3485967e8b73Sdrh     case TK_COLUMN: {
3486b2b9d3d7Sdrh       int iTab = pExpr->iTable;
3487efad2e23Sdrh       if( ExprHasProperty(pExpr, EP_FixedCol) ){
3488d98f5324Sdrh         /* This COLUMN expression is really a constant due to WHERE clause
3489d98f5324Sdrh         ** constraints, and that constant is coded by the pExpr->pLeft
3490d98f5324Sdrh         ** expresssion.  However, make sure the constant has the correct
3491d98f5324Sdrh         ** datatype by applying the Affinity of the table column to the
3492d98f5324Sdrh         ** constant.
3493d98f5324Sdrh         */
3494d98f5324Sdrh         int iReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft,target);
3495eda079cdSdrh         int aff = sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
3496d98f5324Sdrh         if( aff!=SQLITE_AFF_BLOB ){
3497d98f5324Sdrh           static const char zAff[] = "B\000C\000D\000E";
3498d98f5324Sdrh           assert( SQLITE_AFF_BLOB=='A' );
3499d98f5324Sdrh           assert( SQLITE_AFF_TEXT=='B' );
3500d98f5324Sdrh           if( iReg!=target ){
3501d98f5324Sdrh             sqlite3VdbeAddOp2(v, OP_SCopy, iReg, target);
3502d98f5324Sdrh             iReg = target;
3503d98f5324Sdrh           }
3504d98f5324Sdrh           sqlite3VdbeAddOp4(v, OP_Affinity, iReg, 1, 0,
3505d98f5324Sdrh                             &zAff[(aff-'B')*2], P4_STATIC);
3506d98f5324Sdrh         }
3507d98f5324Sdrh         return iReg;
3508efad2e23Sdrh       }
3509b2b9d3d7Sdrh       if( iTab<0 ){
35106e97f8ecSdrh         if( pParse->iSelfTab<0 ){
3511b2b9d3d7Sdrh           /* Generating CHECK constraints or inserting into partial index */
35126e97f8ecSdrh           return pExpr->iColumn - pParse->iSelfTab;
3513c4a3c779Sdrh         }else{
35141f9ca2c8Sdrh           /* Coding an expression that is part of an index where column names
35151f9ca2c8Sdrh           ** in the index refer to the table to which the index belongs */
35163e34eabcSdrh           iTab = pParse->iSelfTab - 1;
35172282792aSdrh         }
3518b2b9d3d7Sdrh       }
3519eda079cdSdrh       return sqlite3ExprCodeGetColumn(pParse, pExpr->y.pTab,
3520b2b9d3d7Sdrh                                pExpr->iColumn, iTab, target,
3521b2b9d3d7Sdrh                                pExpr->op2);
3522cce7d176Sdrh     }
3523cce7d176Sdrh     case TK_INTEGER: {
352413573c71Sdrh       codeInteger(pParse, pExpr, 0, target);
3525c332cc30Sdrh       return target;
352651e9a445Sdrh     }
35278abed7b9Sdrh     case TK_TRUEFALSE: {
352896acafbeSdrh       sqlite3VdbeAddOp2(v, OP_Integer, sqlite3ExprTruthValue(pExpr), target);
3529007c843bSdrh       return target;
3530007c843bSdrh     }
353113573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
3532598f1340Sdrh     case TK_FLOAT: {
353333e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
353433e619fcSdrh       codeReal(v, pExpr->u.zToken, 0, target);
3535c332cc30Sdrh       return target;
3536598f1340Sdrh     }
353713573c71Sdrh #endif
3538fec19aadSdrh     case TK_STRING: {
353933e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
3540076e85f5Sdrh       sqlite3VdbeLoadString(v, target, pExpr->u.zToken);
3541c332cc30Sdrh       return target;
3542cce7d176Sdrh     }
3543f0863fe5Sdrh     case TK_NULL: {
35449de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3545c332cc30Sdrh       return target;
3546f0863fe5Sdrh     }
35475338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_BLOB_LITERAL
3548c572ef7fSdanielk1977     case TK_BLOB: {
35496c8c6cecSdrh       int n;
35506c8c6cecSdrh       const char *z;
3551ca48c90fSdrh       char *zBlob;
355233e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
355333e619fcSdrh       assert( pExpr->u.zToken[0]=='x' || pExpr->u.zToken[0]=='X' );
355433e619fcSdrh       assert( pExpr->u.zToken[1]=='\'' );
355533e619fcSdrh       z = &pExpr->u.zToken[2];
3556b7916a78Sdrh       n = sqlite3Strlen30(z) - 1;
3557b7916a78Sdrh       assert( z[n]=='\'' );
3558ca48c90fSdrh       zBlob = sqlite3HexToBlob(sqlite3VdbeDb(v), z, n);
3559ca48c90fSdrh       sqlite3VdbeAddOp4(v, OP_Blob, n/2, target, 0, zBlob, P4_DYNAMIC);
3560c332cc30Sdrh       return target;
3561c572ef7fSdanielk1977     }
35625338a5f7Sdanielk1977 #endif
356350457896Sdrh     case TK_VARIABLE: {
356433e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
356533e619fcSdrh       assert( pExpr->u.zToken!=0 );
356633e619fcSdrh       assert( pExpr->u.zToken[0]!=0 );
3567eaf52d88Sdrh       sqlite3VdbeAddOp2(v, OP_Variable, pExpr->iColumn, target);
356833e619fcSdrh       if( pExpr->u.zToken[1]!=0 ){
35699bf755ccSdrh         const char *z = sqlite3VListNumToName(pParse->pVList, pExpr->iColumn);
35709bf755ccSdrh         assert( pExpr->u.zToken[0]=='?' || strcmp(pExpr->u.zToken, z)==0 );
3571ce1bbe51Sdrh         pParse->pVList[0] = 0; /* Indicate VList may no longer be enlarged */
35729bf755ccSdrh         sqlite3VdbeAppendP4(v, (char*)z, P4_STATIC);
35739bf755ccSdrh       }
3574c332cc30Sdrh       return target;
357550457896Sdrh     }
35764e0cff60Sdrh     case TK_REGISTER: {
3577c332cc30Sdrh       return pExpr->iTable;
35784e0cff60Sdrh     }
3579487e262fSdrh #ifndef SQLITE_OMIT_CAST
3580487e262fSdrh     case TK_CAST: {
3581487e262fSdrh       /* Expressions of the form:   CAST(pLeft AS token) */
35822dcef11bSdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
35831735fa88Sdrh       if( inReg!=target ){
35841735fa88Sdrh         sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
35851735fa88Sdrh         inReg = target;
35861735fa88Sdrh       }
35874169e430Sdrh       sqlite3VdbeAddOp2(v, OP_Cast, target,
35884169e430Sdrh                         sqlite3AffinityType(pExpr->u.zToken, 0));
3589c332cc30Sdrh       return inReg;
3590487e262fSdrh     }
3591487e262fSdrh #endif /* SQLITE_OMIT_CAST */
359271c57db0Sdan     case TK_IS:
359371c57db0Sdan     case TK_ISNOT:
359471c57db0Sdan       op = (op==TK_IS) ? TK_EQ : TK_NE;
359571c57db0Sdan       p5 = SQLITE_NULLEQ;
359671c57db0Sdan       /* fall-through */
3597c9b84a1fSdrh     case TK_LT:
3598c9b84a1fSdrh     case TK_LE:
3599c9b84a1fSdrh     case TK_GT:
3600c9b84a1fSdrh     case TK_GE:
3601c9b84a1fSdrh     case TK_NE:
3602c9b84a1fSdrh     case TK_EQ: {
360371c57db0Sdan       Expr *pLeft = pExpr->pLeft;
3604625015e0Sdan       if( sqlite3ExprIsVector(pLeft) ){
360579752b6eSdrh         codeVectorCompare(pParse, pExpr, target, op, p5);
360671c57db0Sdan       }else{
360771c57db0Sdan         r1 = sqlite3ExprCodeTemp(pParse, pLeft, &regFree1);
3608b6da74ebSdrh         r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
360971c57db0Sdan         codeCompare(pParse, pLeft, pExpr->pRight, op,
361071c57db0Sdan             r1, r2, inReg, SQLITE_STOREP2 | p5);
36117d176105Sdrh         assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
36127d176105Sdrh         assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
36137d176105Sdrh         assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
36147d176105Sdrh         assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
36157d176105Sdrh         assert(TK_EQ==OP_Eq); testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
36167d176105Sdrh         assert(TK_NE==OP_Ne); testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
3617c5499befSdrh         testcase( regFree1==0 );
3618c5499befSdrh         testcase( regFree2==0 );
3619c9b84a1fSdrh       }
36206a2fe093Sdrh       break;
36216a2fe093Sdrh     }
3622cce7d176Sdrh     case TK_AND:
3623cce7d176Sdrh     case TK_OR:
3624cce7d176Sdrh     case TK_PLUS:
3625cce7d176Sdrh     case TK_STAR:
3626cce7d176Sdrh     case TK_MINUS:
3627bf4133cbSdrh     case TK_REM:
3628bf4133cbSdrh     case TK_BITAND:
3629bf4133cbSdrh     case TK_BITOR:
363017c40294Sdrh     case TK_SLASH:
3631bf4133cbSdrh     case TK_LSHIFT:
3632855eb1cfSdrh     case TK_RSHIFT:
36330040077dSdrh     case TK_CONCAT: {
36347d176105Sdrh       assert( TK_AND==OP_And );            testcase( op==TK_AND );
36357d176105Sdrh       assert( TK_OR==OP_Or );              testcase( op==TK_OR );
36367d176105Sdrh       assert( TK_PLUS==OP_Add );           testcase( op==TK_PLUS );
36377d176105Sdrh       assert( TK_MINUS==OP_Subtract );     testcase( op==TK_MINUS );
36387d176105Sdrh       assert( TK_REM==OP_Remainder );      testcase( op==TK_REM );
36397d176105Sdrh       assert( TK_BITAND==OP_BitAnd );      testcase( op==TK_BITAND );
36407d176105Sdrh       assert( TK_BITOR==OP_BitOr );        testcase( op==TK_BITOR );
36417d176105Sdrh       assert( TK_SLASH==OP_Divide );       testcase( op==TK_SLASH );
36427d176105Sdrh       assert( TK_LSHIFT==OP_ShiftLeft );   testcase( op==TK_LSHIFT );
36437d176105Sdrh       assert( TK_RSHIFT==OP_ShiftRight );  testcase( op==TK_RSHIFT );
36447d176105Sdrh       assert( TK_CONCAT==OP_Concat );      testcase( op==TK_CONCAT );
36452dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
36462dcef11bSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
36475b6afba9Sdrh       sqlite3VdbeAddOp3(v, op, r2, r1, target);
3648c5499befSdrh       testcase( regFree1==0 );
3649c5499befSdrh       testcase( regFree2==0 );
36500040077dSdrh       break;
36510040077dSdrh     }
3652cce7d176Sdrh     case TK_UMINUS: {
3653fec19aadSdrh       Expr *pLeft = pExpr->pLeft;
3654fec19aadSdrh       assert( pLeft );
365513573c71Sdrh       if( pLeft->op==TK_INTEGER ){
365613573c71Sdrh         codeInteger(pParse, pLeft, 1, target);
3657c332cc30Sdrh         return target;
365813573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
365913573c71Sdrh       }else if( pLeft->op==TK_FLOAT ){
366033e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
366133e619fcSdrh         codeReal(v, pLeft->u.zToken, 1, target);
3662c332cc30Sdrh         return target;
366313573c71Sdrh #endif
36643c84ddffSdrh       }else{
366510d1edf0Sdrh         tempX.op = TK_INTEGER;
366610d1edf0Sdrh         tempX.flags = EP_IntValue|EP_TokenOnly;
366710d1edf0Sdrh         tempX.u.iValue = 0;
366810d1edf0Sdrh         r1 = sqlite3ExprCodeTemp(pParse, &tempX, &regFree1);
3669e55cbd72Sdrh         r2 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree2);
36702dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_Subtract, r2, r1, target);
3671c5499befSdrh         testcase( regFree2==0 );
36723c84ddffSdrh       }
36736e142f54Sdrh       break;
36746e142f54Sdrh     }
3675bf4133cbSdrh     case TK_BITNOT:
36766e142f54Sdrh     case TK_NOT: {
36777d176105Sdrh       assert( TK_BITNOT==OP_BitNot );   testcase( op==TK_BITNOT );
36787d176105Sdrh       assert( TK_NOT==OP_Not );         testcase( op==TK_NOT );
3679e99fa2afSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3680e99fa2afSdrh       testcase( regFree1==0 );
3681e99fa2afSdrh       sqlite3VdbeAddOp2(v, op, r1, inReg);
3682cce7d176Sdrh       break;
3683cce7d176Sdrh     }
36848abed7b9Sdrh     case TK_TRUTH: {
368596acafbeSdrh       int isTrue;    /* IS TRUE or IS NOT TRUE */
368696acafbeSdrh       int bNormal;   /* IS TRUE or IS FALSE */
3687007c843bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3688007c843bSdrh       testcase( regFree1==0 );
368996acafbeSdrh       isTrue = sqlite3ExprTruthValue(pExpr->pRight);
369096acafbeSdrh       bNormal = pExpr->op2==TK_IS;
369196acafbeSdrh       testcase( isTrue && bNormal);
369296acafbeSdrh       testcase( !isTrue && bNormal);
369396acafbeSdrh       sqlite3VdbeAddOp4Int(v, OP_IsTrue, r1, inReg, !isTrue, isTrue ^ bNormal);
3694007c843bSdrh       break;
3695007c843bSdrh     }
3696cce7d176Sdrh     case TK_ISNULL:
3697cce7d176Sdrh     case TK_NOTNULL: {
36986a288a33Sdrh       int addr;
36997d176105Sdrh       assert( TK_ISNULL==OP_IsNull );   testcase( op==TK_ISNULL );
37007d176105Sdrh       assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
37019de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
37022dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3703c5499befSdrh       testcase( regFree1==0 );
37042dcef11bSdrh       addr = sqlite3VdbeAddOp1(v, op, r1);
37057d176105Sdrh       VdbeCoverageIf(v, op==TK_ISNULL);
37067d176105Sdrh       VdbeCoverageIf(v, op==TK_NOTNULL);
3707a976979bSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 0, target);
37086a288a33Sdrh       sqlite3VdbeJumpHere(v, addr);
3709a37cdde0Sdanielk1977       break;
3710f2bc013cSdrh     }
37112282792aSdrh     case TK_AGG_FUNCTION: {
371213449892Sdrh       AggInfo *pInfo = pExpr->pAggInfo;
37137e56e711Sdrh       if( pInfo==0 ){
371433e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
371533e619fcSdrh         sqlite3ErrorMsg(pParse, "misuse of aggregate: %s()", pExpr->u.zToken);
37167e56e711Sdrh       }else{
3717c332cc30Sdrh         return pInfo->aFunc[pExpr->iAgg].iMem;
37187e56e711Sdrh       }
37192282792aSdrh       break;
37202282792aSdrh     }
3721cce7d176Sdrh     case TK_FUNCTION: {
372212ffee8cSdrh       ExprList *pFarg;       /* List of function arguments */
372312ffee8cSdrh       int nFarg;             /* Number of function arguments */
372412ffee8cSdrh       FuncDef *pDef;         /* The function definition object */
372512ffee8cSdrh       const char *zId;       /* The function name */
3726693e6719Sdrh       u32 constMask = 0;     /* Mask of function arguments that are constant */
372712ffee8cSdrh       int i;                 /* Loop counter */
3728c332cc30Sdrh       sqlite3 *db = pParse->db;  /* The database connection */
372912ffee8cSdrh       u8 enc = ENC(db);      /* The text encoding used by this database */
373012ffee8cSdrh       CollSeq *pColl = 0;    /* A collating sequence */
373117435752Sdrh 
373267a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
3733eda079cdSdrh       if( ExprHasProperty(pExpr, EP_WinFunc) ){
3734eda079cdSdrh         return pExpr->y.pWin->regResult;
373586fb6e17Sdan       }
373667a9b8edSdan #endif
373786fb6e17Sdan 
37381e9b53f9Sdrh       if( ConstFactorOk(pParse) && sqlite3ExprIsConstantNotJoin(pExpr) ){
373949c5ab24Sdrh         /* SQL functions can be expensive. So try to move constant functions
3740ad879ffdSdrh         ** out of the inner loop, even if that means an extra OP_Copy. */
3741ad879ffdSdrh         return sqlite3ExprCodeAtInit(pParse, pExpr, -1);
37421e9b53f9Sdrh       }
37436ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
3744c5cd1249Sdrh       if( ExprHasProperty(pExpr, EP_TokenOnly) ){
374512ffee8cSdrh         pFarg = 0;
374612ffee8cSdrh       }else{
374712ffee8cSdrh         pFarg = pExpr->x.pList;
374812ffee8cSdrh       }
374912ffee8cSdrh       nFarg = pFarg ? pFarg->nExpr : 0;
375033e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
375133e619fcSdrh       zId = pExpr->u.zToken;
375280738d9cSdrh       pDef = sqlite3FindFunction(db, zId, nFarg, enc, 0);
3753cc15313cSdrh #ifdef SQLITE_ENABLE_UNKNOWN_SQL_FUNCTION
3754cc15313cSdrh       if( pDef==0 && pParse->explain ){
3755cc15313cSdrh         pDef = sqlite3FindFunction(db, "unknown", nFarg, enc, 0);
3756cc15313cSdrh       }
3757cc15313cSdrh #endif
3758b6e9f7a4Sdan       if( pDef==0 || pDef->xFinalize!=0 ){
375980738d9cSdrh         sqlite3ErrorMsg(pParse, "unknown function: %s()", zId);
3760feb306f5Sdrh         break;
3761feb306f5Sdrh       }
3762ae6bb957Sdrh 
3763ae6bb957Sdrh       /* Attempt a direct implementation of the built-in COALESCE() and
376460ec914cSpeter.d.reid       ** IFNULL() functions.  This avoids unnecessary evaluation of
3765ae6bb957Sdrh       ** arguments past the first non-NULL argument.
3766ae6bb957Sdrh       */
3767d36e1041Sdrh       if( pDef->funcFlags & SQLITE_FUNC_COALESCE ){
3768ec4ccdbcSdrh         int endCoalesce = sqlite3VdbeMakeLabel(pParse);
3769ae6bb957Sdrh         assert( nFarg>=2 );
3770ae6bb957Sdrh         sqlite3ExprCode(pParse, pFarg->a[0].pExpr, target);
3771ae6bb957Sdrh         for(i=1; i<nFarg; i++){
3772ae6bb957Sdrh           sqlite3VdbeAddOp2(v, OP_NotNull, target, endCoalesce);
3773688852abSdrh           VdbeCoverage(v);
3774ae6bb957Sdrh           sqlite3ExprCode(pParse, pFarg->a[i].pExpr, target);
3775ae6bb957Sdrh         }
3776ae6bb957Sdrh         sqlite3VdbeResolveLabel(v, endCoalesce);
3777ae6bb957Sdrh         break;
3778ae6bb957Sdrh       }
3779ae6bb957Sdrh 
3780cca9f3d2Sdrh       /* The UNLIKELY() function is a no-op.  The result is the value
3781cca9f3d2Sdrh       ** of the first argument.
3782cca9f3d2Sdrh       */
3783cca9f3d2Sdrh       if( pDef->funcFlags & SQLITE_FUNC_UNLIKELY ){
3784cca9f3d2Sdrh         assert( nFarg>=1 );
3785c332cc30Sdrh         return sqlite3ExprCodeTarget(pParse, pFarg->a[0].pExpr, target);
3786cca9f3d2Sdrh       }
3787ae6bb957Sdrh 
378854240751Sdrh #ifdef SQLITE_DEBUG
3789a1a523a5Sdrh       /* The AFFINITY() function evaluates to a string that describes
3790a1a523a5Sdrh       ** the type affinity of the argument.  This is used for testing of
3791a1a523a5Sdrh       ** the SQLite type logic.
3792a1a523a5Sdrh       */
3793a1a523a5Sdrh       if( pDef->funcFlags & SQLITE_FUNC_AFFINITY ){
3794a1a523a5Sdrh         const char *azAff[] = { "blob", "text", "numeric", "integer", "real" };
3795a1a523a5Sdrh         char aff;
3796a1a523a5Sdrh         assert( nFarg==1 );
3797a1a523a5Sdrh         aff = sqlite3ExprAffinity(pFarg->a[0].pExpr);
3798a1a523a5Sdrh         sqlite3VdbeLoadString(v, target,
3799a1a523a5Sdrh                               aff ? azAff[aff-SQLITE_AFF_BLOB] : "none");
3800a1a523a5Sdrh         return target;
3801a1a523a5Sdrh       }
380254240751Sdrh #endif
3803a1a523a5Sdrh 
3804d1a01edaSdrh       for(i=0; i<nFarg; i++){
3805d1a01edaSdrh         if( i<32 && sqlite3ExprIsConstant(pFarg->a[i].pExpr) ){
3806693e6719Sdrh           testcase( i==31 );
3807693e6719Sdrh           constMask |= MASKBIT32(i);
3808d1a01edaSdrh         }
3809d1a01edaSdrh         if( (pDef->funcFlags & SQLITE_FUNC_NEEDCOLL)!=0 && !pColl ){
3810d1a01edaSdrh           pColl = sqlite3ExprCollSeq(pParse, pFarg->a[i].pExpr);
3811d1a01edaSdrh         }
3812d1a01edaSdrh       }
381312ffee8cSdrh       if( pFarg ){
3814d1a01edaSdrh         if( constMask ){
3815d1a01edaSdrh           r1 = pParse->nMem+1;
3816d1a01edaSdrh           pParse->nMem += nFarg;
3817d1a01edaSdrh         }else{
381812ffee8cSdrh           r1 = sqlite3GetTempRange(pParse, nFarg);
3819d1a01edaSdrh         }
3820a748fdccSdrh 
3821a748fdccSdrh         /* For length() and typeof() functions with a column argument,
3822a748fdccSdrh         ** set the P5 parameter to the OP_Column opcode to OPFLAG_LENGTHARG
3823a748fdccSdrh         ** or OPFLAG_TYPEOFARG respectively, to avoid unnecessary data
3824a748fdccSdrh         ** loading.
3825a748fdccSdrh         */
3826d36e1041Sdrh         if( (pDef->funcFlags & (SQLITE_FUNC_LENGTH|SQLITE_FUNC_TYPEOF))!=0 ){
38274e245a4cSdrh           u8 exprOp;
3828a748fdccSdrh           assert( nFarg==1 );
3829a748fdccSdrh           assert( pFarg->a[0].pExpr!=0 );
38304e245a4cSdrh           exprOp = pFarg->a[0].pExpr->op;
38314e245a4cSdrh           if( exprOp==TK_COLUMN || exprOp==TK_AGG_COLUMN ){
3832a748fdccSdrh             assert( SQLITE_FUNC_LENGTH==OPFLAG_LENGTHARG );
3833a748fdccSdrh             assert( SQLITE_FUNC_TYPEOF==OPFLAG_TYPEOFARG );
3834b1fba286Sdrh             testcase( pDef->funcFlags & OPFLAG_LENGTHARG );
3835b1fba286Sdrh             pFarg->a[0].pExpr->op2 =
3836b1fba286Sdrh                   pDef->funcFlags & (OPFLAG_LENGTHARG|OPFLAG_TYPEOFARG);
3837a748fdccSdrh           }
3838a748fdccSdrh         }
3839a748fdccSdrh 
38405579d59fSdrh         sqlite3ExprCodeExprList(pParse, pFarg, r1, 0,
3841d1a01edaSdrh                                 SQLITE_ECEL_DUP|SQLITE_ECEL_FACTOR);
3842892d3179Sdrh       }else{
384312ffee8cSdrh         r1 = 0;
3844892d3179Sdrh       }
3845b7f6f68fSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
3846a43fa227Sdrh       /* Possibly overload the function if the first argument is
3847a43fa227Sdrh       ** a virtual table column.
3848a43fa227Sdrh       **
3849a43fa227Sdrh       ** For infix functions (LIKE, GLOB, REGEXP, and MATCH) use the
3850a43fa227Sdrh       ** second argument, not the first, as the argument to test to
3851a43fa227Sdrh       ** see if it is a column in a virtual table.  This is done because
3852a43fa227Sdrh       ** the left operand of infix functions (the operand we want to
3853a43fa227Sdrh       ** control overloading) ends up as the second argument to the
3854a43fa227Sdrh       ** function.  The expression "A glob B" is equivalent to
3855a43fa227Sdrh       ** "glob(B,A).  We want to use the A in "A glob B" to test
3856a43fa227Sdrh       ** for function overloading.  But we use the B term in "glob(B,A)".
3857a43fa227Sdrh       */
385859155065Sdrh       if( nFarg>=2 && ExprHasProperty(pExpr, EP_InfixFunc) ){
385912ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[1].pExpr);
386012ffee8cSdrh       }else if( nFarg>0 ){
386112ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[0].pExpr);
3862b7f6f68fSdrh       }
3863b7f6f68fSdrh #endif
3864d36e1041Sdrh       if( pDef->funcFlags & SQLITE_FUNC_NEEDCOLL ){
38658b213899Sdrh         if( !pColl ) pColl = db->pDfltColl;
386666a5167bSdrh         sqlite3VdbeAddOp4(v, OP_CollSeq, 0, 0, 0, (char *)pColl, P4_COLLSEQ);
3867682f68b0Sdanielk1977       }
3868092457b1Sdrh #ifdef SQLITE_ENABLE_OFFSET_SQL_FUNC
3869092457b1Sdrh       if( pDef->funcFlags & SQLITE_FUNC_OFFSET ){
38702fc865c1Sdrh         Expr *pArg = pFarg->a[0].pExpr;
38712fc865c1Sdrh         if( pArg->op==TK_COLUMN ){
3872092457b1Sdrh           sqlite3VdbeAddOp3(v, OP_Offset, pArg->iTable, pArg->iColumn, target);
38732fc865c1Sdrh         }else{
38742fc865c1Sdrh           sqlite3VdbeAddOp2(v, OP_Null, 0, target);
38752fc865c1Sdrh         }
3876092457b1Sdrh       }else
3877092457b1Sdrh #endif
3878092457b1Sdrh       {
38793e34eabcSdrh         sqlite3VdbeAddOp4(v, pParse->iSelfTab ? OP_PureFunc0 : OP_Function0,
38803e34eabcSdrh                           constMask, r1, target, (char*)pDef, P4_FUNCDEF);
388112ffee8cSdrh         sqlite3VdbeChangeP5(v, (u8)nFarg);
38822fc865c1Sdrh       }
3883d1a01edaSdrh       if( nFarg && constMask==0 ){
388412ffee8cSdrh         sqlite3ReleaseTempRange(pParse, r1, nFarg);
38852dcef11bSdrh       }
3886c332cc30Sdrh       return target;
38876ec2733bSdrh     }
3888fe2093d7Sdrh #ifndef SQLITE_OMIT_SUBQUERY
3889fe2093d7Sdrh     case TK_EXISTS:
389019a775c2Sdrh     case TK_SELECT: {
38918da209b1Sdan       int nCol;
3892c5499befSdrh       testcase( op==TK_EXISTS );
3893c5499befSdrh       testcase( op==TK_SELECT );
38948da209b1Sdan       if( op==TK_SELECT && (nCol = pExpr->x.pSelect->pEList->nExpr)!=1 ){
38958da209b1Sdan         sqlite3SubselectError(pParse, nCol, 1);
38968da209b1Sdan       }else{
389785bcdce2Sdrh         return sqlite3CodeSubselect(pParse, pExpr);
38988da209b1Sdan       }
389919a775c2Sdrh       break;
390019a775c2Sdrh     }
3901fc7f27b9Sdrh     case TK_SELECT_COLUMN: {
3902966e2911Sdrh       int n;
3903fc7f27b9Sdrh       if( pExpr->pLeft->iTable==0 ){
390485bcdce2Sdrh         pExpr->pLeft->iTable = sqlite3CodeSubselect(pParse, pExpr->pLeft);
3905fc7f27b9Sdrh       }
3906966e2911Sdrh       assert( pExpr->iTable==0 || pExpr->pLeft->op==TK_SELECT );
3907966e2911Sdrh       if( pExpr->iTable
3908966e2911Sdrh        && pExpr->iTable!=(n = sqlite3ExprVectorSize(pExpr->pLeft))
3909966e2911Sdrh       ){
3910966e2911Sdrh         sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
3911966e2911Sdrh                                 pExpr->iTable, n);
3912966e2911Sdrh       }
3913c332cc30Sdrh       return pExpr->pLeft->iTable + pExpr->iColumn;
3914fc7f27b9Sdrh     }
3915fef5208cSdrh     case TK_IN: {
3916ec4ccdbcSdrh       int destIfFalse = sqlite3VdbeMakeLabel(pParse);
3917ec4ccdbcSdrh       int destIfNull = sqlite3VdbeMakeLabel(pParse);
3918e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3919e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
392066ba23ceSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
3921e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
3922e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_AddImm, target, 0);
3923e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfNull);
3924c332cc30Sdrh       return target;
3925fef5208cSdrh     }
3926e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
3927e3365e6cSdrh 
3928e3365e6cSdrh 
39292dcef11bSdrh     /*
39302dcef11bSdrh     **    x BETWEEN y AND z
39312dcef11bSdrh     **
39322dcef11bSdrh     ** This is equivalent to
39332dcef11bSdrh     **
39342dcef11bSdrh     **    x>=y AND x<=z
39352dcef11bSdrh     **
39362dcef11bSdrh     ** X is stored in pExpr->pLeft.
39372dcef11bSdrh     ** Y is stored in pExpr->pList->a[0].pExpr.
39382dcef11bSdrh     ** Z is stored in pExpr->pList->a[1].pExpr.
39392dcef11bSdrh     */
3940fef5208cSdrh     case TK_BETWEEN: {
394171c57db0Sdan       exprCodeBetween(pParse, pExpr, target, 0, 0);
3942c332cc30Sdrh       return target;
3943fef5208cSdrh     }
394494fa9c41Sdrh     case TK_SPAN:
3945ae80ddeaSdrh     case TK_COLLATE:
39464f07e5fbSdrh     case TK_UPLUS: {
39471efa8023Sdrh       pExpr = pExpr->pLeft;
394859ee43a7Sdrh       goto expr_code_doover; /* 2018-04-28: Prevent deep recursion. OSSFuzz. */
3949a2e00042Sdrh     }
39502dcef11bSdrh 
3951165921a7Sdan     case TK_TRIGGER: {
395265a7cd16Sdan       /* If the opcode is TK_TRIGGER, then the expression is a reference
395365a7cd16Sdan       ** to a column in the new.* or old.* pseudo-tables available to
395465a7cd16Sdan       ** trigger programs. In this case Expr.iTable is set to 1 for the
395565a7cd16Sdan       ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
395665a7cd16Sdan       ** is set to the column of the pseudo-table to read, or to -1 to
395765a7cd16Sdan       ** read the rowid field.
395865a7cd16Sdan       **
395965a7cd16Sdan       ** The expression is implemented using an OP_Param opcode. The p1
396065a7cd16Sdan       ** parameter is set to 0 for an old.rowid reference, or to (i+1)
396165a7cd16Sdan       ** to reference another column of the old.* pseudo-table, where
396265a7cd16Sdan       ** i is the index of the column. For a new.rowid reference, p1 is
396365a7cd16Sdan       ** set to (n+1), where n is the number of columns in each pseudo-table.
396465a7cd16Sdan       ** For a reference to any other column in the new.* pseudo-table, p1
396565a7cd16Sdan       ** is set to (n+2+i), where n and i are as defined previously. For
396665a7cd16Sdan       ** example, if the table on which triggers are being fired is
396765a7cd16Sdan       ** declared as:
396865a7cd16Sdan       **
396965a7cd16Sdan       **   CREATE TABLE t1(a, b);
397065a7cd16Sdan       **
397165a7cd16Sdan       ** Then p1 is interpreted as follows:
397265a7cd16Sdan       **
397365a7cd16Sdan       **   p1==0   ->    old.rowid     p1==3   ->    new.rowid
397465a7cd16Sdan       **   p1==1   ->    old.a         p1==4   ->    new.a
397565a7cd16Sdan       **   p1==2   ->    old.b         p1==5   ->    new.b
397665a7cd16Sdan       */
3977eda079cdSdrh       Table *pTab = pExpr->y.pTab;
397865a7cd16Sdan       int p1 = pExpr->iTable * (pTab->nCol+1) + 1 + pExpr->iColumn;
397965a7cd16Sdan 
398065a7cd16Sdan       assert( pExpr->iTable==0 || pExpr->iTable==1 );
398165a7cd16Sdan       assert( pExpr->iColumn>=-1 && pExpr->iColumn<pTab->nCol );
398265a7cd16Sdan       assert( pTab->iPKey<0 || pExpr->iColumn!=pTab->iPKey );
398365a7cd16Sdan       assert( p1>=0 && p1<(pTab->nCol*2+2) );
398465a7cd16Sdan 
398565a7cd16Sdan       sqlite3VdbeAddOp2(v, OP_Param, p1, target);
3986896494e8Sdrh       VdbeComment((v, "r[%d]=%s.%s", target,
3987165921a7Sdan         (pExpr->iTable ? "new" : "old"),
3988eda079cdSdrh         (pExpr->iColumn<0 ? "rowid" : pExpr->y.pTab->aCol[pExpr->iColumn].zName)
3989165921a7Sdan       ));
399065a7cd16Sdan 
399144dbca83Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
399265a7cd16Sdan       /* If the column has REAL affinity, it may currently be stored as an
3993113762a2Sdrh       ** integer. Use OP_RealAffinity to make sure it is really real.
3994113762a2Sdrh       **
3995113762a2Sdrh       ** EVIDENCE-OF: R-60985-57662 SQLite will convert the value back to
3996113762a2Sdrh       ** floating point when extracting it from the record.  */
39972832ad42Sdan       if( pExpr->iColumn>=0
39982832ad42Sdan        && pTab->aCol[pExpr->iColumn].affinity==SQLITE_AFF_REAL
39992832ad42Sdan       ){
40002832ad42Sdan         sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
40012832ad42Sdan       }
400244dbca83Sdrh #endif
4003165921a7Sdan       break;
4004165921a7Sdan     }
4005165921a7Sdan 
400671c57db0Sdan     case TK_VECTOR: {
4007e835bc12Sdrh       sqlite3ErrorMsg(pParse, "row value misused");
400871c57db0Sdan       break;
400971c57db0Sdan     }
401071c57db0Sdan 
401131d6fd55Sdrh     case TK_IF_NULL_ROW: {
401231d6fd55Sdrh       int addrINR;
401331d6fd55Sdrh       addrINR = sqlite3VdbeAddOp1(v, OP_IfNullRow, pExpr->iTable);
401431d6fd55Sdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
401531d6fd55Sdrh       sqlite3VdbeJumpHere(v, addrINR);
401631d6fd55Sdrh       sqlite3VdbeChangeP3(v, addrINR, inReg);
401731d6fd55Sdrh       break;
401831d6fd55Sdrh     }
401931d6fd55Sdrh 
40202dcef11bSdrh     /*
40212dcef11bSdrh     ** Form A:
40222dcef11bSdrh     **   CASE x WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
40232dcef11bSdrh     **
40242dcef11bSdrh     ** Form B:
40252dcef11bSdrh     **   CASE WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
40262dcef11bSdrh     **
40272dcef11bSdrh     ** Form A is can be transformed into the equivalent form B as follows:
40282dcef11bSdrh     **   CASE WHEN x=e1 THEN r1 WHEN x=e2 THEN r2 ...
40292dcef11bSdrh     **        WHEN x=eN THEN rN ELSE y END
40302dcef11bSdrh     **
40312dcef11bSdrh     ** X (if it exists) is in pExpr->pLeft.
4032c5cd1249Sdrh     ** Y is in the last element of pExpr->x.pList if pExpr->x.pList->nExpr is
4033c5cd1249Sdrh     ** odd.  The Y is also optional.  If the number of elements in x.pList
4034c5cd1249Sdrh     ** is even, then Y is omitted and the "otherwise" result is NULL.
40352dcef11bSdrh     ** Ei is in pExpr->pList->a[i*2] and Ri is pExpr->pList->a[i*2+1].
40362dcef11bSdrh     **
40372dcef11bSdrh     ** The result of the expression is the Ri for the first matching Ei,
40382dcef11bSdrh     ** or if there is no matching Ei, the ELSE term Y, or if there is
40392dcef11bSdrh     ** no ELSE term, NULL.
40402dcef11bSdrh     */
404133cd4909Sdrh     default: assert( op==TK_CASE ); {
40422dcef11bSdrh       int endLabel;                     /* GOTO label for end of CASE stmt */
40432dcef11bSdrh       int nextCase;                     /* GOTO label for next WHEN clause */
40442dcef11bSdrh       int nExpr;                        /* 2x number of WHEN terms */
40452dcef11bSdrh       int i;                            /* Loop counter */
40462dcef11bSdrh       ExprList *pEList;                 /* List of WHEN terms */
40472dcef11bSdrh       struct ExprList_item *aListelem;  /* Array of WHEN terms */
40482dcef11bSdrh       Expr opCompare;                   /* The X==Ei expression */
40492dcef11bSdrh       Expr *pX;                         /* The X expression */
40501bd10f8aSdrh       Expr *pTest = 0;                  /* X==Ei (form A) or just Ei (form B) */
405117a7f8ddSdrh 
40526ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) && pExpr->x.pList );
40536ab3a2ecSdanielk1977       assert(pExpr->x.pList->nExpr > 0);
40546ab3a2ecSdanielk1977       pEList = pExpr->x.pList;
4055be5c89acSdrh       aListelem = pEList->a;
4056be5c89acSdrh       nExpr = pEList->nExpr;
4057ec4ccdbcSdrh       endLabel = sqlite3VdbeMakeLabel(pParse);
40582dcef11bSdrh       if( (pX = pExpr->pLeft)!=0 ){
4059a8e05761Sdrh         exprNodeCopy(&tempX, pX);
406033cd4909Sdrh         testcase( pX->op==TK_COLUMN );
406112abf408Sdrh         exprToRegister(&tempX, exprCodeVector(pParse, &tempX, &regFree1));
4062c5499befSdrh         testcase( regFree1==0 );
4063abb9d5f1Sdrh         memset(&opCompare, 0, sizeof(opCompare));
40642dcef11bSdrh         opCompare.op = TK_EQ;
406510d1edf0Sdrh         opCompare.pLeft = &tempX;
40662dcef11bSdrh         pTest = &opCompare;
40678b1db07fSdrh         /* Ticket b351d95f9cd5ef17e9d9dbae18f5ca8611190001:
40688b1db07fSdrh         ** The value in regFree1 might get SCopy-ed into the file result.
40698b1db07fSdrh         ** So make sure that the regFree1 register is not reused for other
40708b1db07fSdrh         ** purposes and possibly overwritten.  */
40718b1db07fSdrh         regFree1 = 0;
4072cce7d176Sdrh       }
4073c5cd1249Sdrh       for(i=0; i<nExpr-1; i=i+2){
40742dcef11bSdrh         if( pX ){
40751bd10f8aSdrh           assert( pTest!=0 );
40762dcef11bSdrh           opCompare.pRight = aListelem[i].pExpr;
4077f5905aa7Sdrh         }else{
40782dcef11bSdrh           pTest = aListelem[i].pExpr;
407917a7f8ddSdrh         }
4080ec4ccdbcSdrh         nextCase = sqlite3VdbeMakeLabel(pParse);
408133cd4909Sdrh         testcase( pTest->op==TK_COLUMN );
40822dcef11bSdrh         sqlite3ExprIfFalse(pParse, pTest, nextCase, SQLITE_JUMPIFNULL);
4083c5499befSdrh         testcase( aListelem[i+1].pExpr->op==TK_COLUMN );
40849de221dfSdrh         sqlite3ExprCode(pParse, aListelem[i+1].pExpr, target);
4085076e85f5Sdrh         sqlite3VdbeGoto(v, endLabel);
40862dcef11bSdrh         sqlite3VdbeResolveLabel(v, nextCase);
4087f570f011Sdrh       }
4088c5cd1249Sdrh       if( (nExpr&1)!=0 ){
4089c5cd1249Sdrh         sqlite3ExprCode(pParse, pEList->a[nExpr-1].pExpr, target);
409017a7f8ddSdrh       }else{
40919de221dfSdrh         sqlite3VdbeAddOp2(v, OP_Null, 0, target);
409217a7f8ddSdrh       }
40932dcef11bSdrh       sqlite3VdbeResolveLabel(v, endLabel);
40946f34903eSdanielk1977       break;
40956f34903eSdanielk1977     }
40965338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_TRIGGER
40976f34903eSdanielk1977     case TK_RAISE: {
4098165921a7Sdan       assert( pExpr->affinity==OE_Rollback
4099165921a7Sdan            || pExpr->affinity==OE_Abort
4100165921a7Sdan            || pExpr->affinity==OE_Fail
4101165921a7Sdan            || pExpr->affinity==OE_Ignore
4102165921a7Sdan       );
4103e0af83acSdan       if( !pParse->pTriggerTab ){
4104e0af83acSdan         sqlite3ErrorMsg(pParse,
4105e0af83acSdan                        "RAISE() may only be used within a trigger-program");
4106e0af83acSdan         return 0;
4107e0af83acSdan       }
4108e0af83acSdan       if( pExpr->affinity==OE_Abort ){
4109e0af83acSdan         sqlite3MayAbort(pParse);
4110e0af83acSdan       }
411133e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
4112e0af83acSdan       if( pExpr->affinity==OE_Ignore ){
4113e0af83acSdan         sqlite3VdbeAddOp4(
4114e0af83acSdan             v, OP_Halt, SQLITE_OK, OE_Ignore, 0, pExpr->u.zToken,0);
4115688852abSdrh         VdbeCoverage(v);
4116e0af83acSdan       }else{
4117433dccfbSdrh         sqlite3HaltConstraint(pParse, SQLITE_CONSTRAINT_TRIGGER,
4118f9c8ce3cSdrh                               pExpr->affinity, pExpr->u.zToken, 0, 0);
4119e0af83acSdan       }
4120e0af83acSdan 
4121ffe07b2dSdrh       break;
412217a7f8ddSdrh     }
41235338a5f7Sdanielk1977 #endif
4124ffe07b2dSdrh   }
41252dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
41262dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
41272dcef11bSdrh   return inReg;
41285b6afba9Sdrh }
41292dcef11bSdrh 
41302dcef11bSdrh /*
4131d1a01edaSdrh ** Factor out the code of the given expression to initialization time.
41321e9b53f9Sdrh **
4133ad879ffdSdrh ** If regDest>=0 then the result is always stored in that register and the
4134ad879ffdSdrh ** result is not reusable.  If regDest<0 then this routine is free to
4135ad879ffdSdrh ** store the value whereever it wants.  The register where the expression
4136ad879ffdSdrh ** is stored is returned.  When regDest<0, two identical expressions will
4137ad879ffdSdrh ** code to the same register.
4138d1a01edaSdrh */
41391e9b53f9Sdrh int sqlite3ExprCodeAtInit(
4140d673cddaSdrh   Parse *pParse,    /* Parsing context */
4141d673cddaSdrh   Expr *pExpr,      /* The expression to code when the VDBE initializes */
4142ad879ffdSdrh   int regDest       /* Store the value in this register */
4143d673cddaSdrh ){
4144d1a01edaSdrh   ExprList *p;
4145d9f158e7Sdrh   assert( ConstFactorOk(pParse) );
4146d1a01edaSdrh   p = pParse->pConstExpr;
4147ad879ffdSdrh   if( regDest<0 && p ){
41481e9b53f9Sdrh     struct ExprList_item *pItem;
41491e9b53f9Sdrh     int i;
41501e9b53f9Sdrh     for(pItem=p->a, i=p->nExpr; i>0; pItem++, i--){
41515aa550cfSdan       if( pItem->reusable && sqlite3ExprCompare(0,pItem->pExpr,pExpr,-1)==0 ){
41521e9b53f9Sdrh         return pItem->u.iConstExprReg;
41531e9b53f9Sdrh       }
41541e9b53f9Sdrh     }
41551e9b53f9Sdrh   }
4156d1a01edaSdrh   pExpr = sqlite3ExprDup(pParse->db, pExpr, 0);
4157d1a01edaSdrh   p = sqlite3ExprListAppend(pParse, p, pExpr);
4158d673cddaSdrh   if( p ){
4159d673cddaSdrh      struct ExprList_item *pItem = &p->a[p->nExpr-1];
4160ad879ffdSdrh      pItem->reusable = regDest<0;
4161ad879ffdSdrh      if( regDest<0 ) regDest = ++pParse->nMem;
4162d673cddaSdrh      pItem->u.iConstExprReg = regDest;
4163d673cddaSdrh   }
4164d1a01edaSdrh   pParse->pConstExpr = p;
41651e9b53f9Sdrh   return regDest;
4166d1a01edaSdrh }
4167d1a01edaSdrh 
4168d1a01edaSdrh /*
41692dcef11bSdrh ** Generate code to evaluate an expression and store the results
41702dcef11bSdrh ** into a register.  Return the register number where the results
41712dcef11bSdrh ** are stored.
41722dcef11bSdrh **
41732dcef11bSdrh ** If the register is a temporary register that can be deallocated,
4174678ccce8Sdrh ** then write its number into *pReg.  If the result register is not
41752dcef11bSdrh ** a temporary, then set *pReg to zero.
4176f30a969bSdrh **
4177f30a969bSdrh ** If pExpr is a constant, then this routine might generate this
4178f30a969bSdrh ** code to fill the register in the initialization section of the
4179f30a969bSdrh ** VDBE program, in order to factor it out of the evaluation loop.
41802dcef11bSdrh */
41812dcef11bSdrh int sqlite3ExprCodeTemp(Parse *pParse, Expr *pExpr, int *pReg){
4182f30a969bSdrh   int r2;
4183f30a969bSdrh   pExpr = sqlite3ExprSkipCollate(pExpr);
4184d9f158e7Sdrh   if( ConstFactorOk(pParse)
4185f30a969bSdrh    && pExpr->op!=TK_REGISTER
4186f30a969bSdrh    && sqlite3ExprIsConstantNotJoin(pExpr)
4187f30a969bSdrh   ){
4188f30a969bSdrh     *pReg  = 0;
4189ad879ffdSdrh     r2 = sqlite3ExprCodeAtInit(pParse, pExpr, -1);
4190f30a969bSdrh   }else{
41912dcef11bSdrh     int r1 = sqlite3GetTempReg(pParse);
4192f30a969bSdrh     r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
41932dcef11bSdrh     if( r2==r1 ){
41942dcef11bSdrh       *pReg = r1;
41952dcef11bSdrh     }else{
41962dcef11bSdrh       sqlite3ReleaseTempReg(pParse, r1);
41972dcef11bSdrh       *pReg = 0;
41982dcef11bSdrh     }
4199f30a969bSdrh   }
42002dcef11bSdrh   return r2;
42012dcef11bSdrh }
42022dcef11bSdrh 
42032dcef11bSdrh /*
42042dcef11bSdrh ** Generate code that will evaluate expression pExpr and store the
42052dcef11bSdrh ** results in register target.  The results are guaranteed to appear
42062dcef11bSdrh ** in register target.
42072dcef11bSdrh */
420805a86c5cSdrh void sqlite3ExprCode(Parse *pParse, Expr *pExpr, int target){
42099cbf3425Sdrh   int inReg;
42109cbf3425Sdrh 
42119cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
4212ebc16717Sdrh   if( pExpr && pExpr->op==TK_REGISTER ){
4213ebc16717Sdrh     sqlite3VdbeAddOp2(pParse->pVdbe, OP_Copy, pExpr->iTable, target);
4214ebc16717Sdrh   }else{
42159cbf3425Sdrh     inReg = sqlite3ExprCodeTarget(pParse, pExpr, target);
42161c75c9d7Sdrh     assert( pParse->pVdbe!=0 || pParse->db->mallocFailed );
42170e359b30Sdrh     if( inReg!=target && pParse->pVdbe ){
42189cbf3425Sdrh       sqlite3VdbeAddOp2(pParse->pVdbe, OP_SCopy, inReg, target);
421917a7f8ddSdrh     }
4220ebc16717Sdrh   }
4221cce7d176Sdrh }
4222cce7d176Sdrh 
4223cce7d176Sdrh /*
42241c75c9d7Sdrh ** Make a transient copy of expression pExpr and then code it using
42251c75c9d7Sdrh ** sqlite3ExprCode().  This routine works just like sqlite3ExprCode()
42261c75c9d7Sdrh ** except that the input expression is guaranteed to be unchanged.
42271c75c9d7Sdrh */
42281c75c9d7Sdrh void sqlite3ExprCodeCopy(Parse *pParse, Expr *pExpr, int target){
42291c75c9d7Sdrh   sqlite3 *db = pParse->db;
42301c75c9d7Sdrh   pExpr = sqlite3ExprDup(db, pExpr, 0);
42311c75c9d7Sdrh   if( !db->mallocFailed ) sqlite3ExprCode(pParse, pExpr, target);
42321c75c9d7Sdrh   sqlite3ExprDelete(db, pExpr);
42331c75c9d7Sdrh }
42341c75c9d7Sdrh 
42351c75c9d7Sdrh /*
423605a86c5cSdrh ** Generate code that will evaluate expression pExpr and store the
423705a86c5cSdrh ** results in register target.  The results are guaranteed to appear
423805a86c5cSdrh ** in register target.  If the expression is constant, then this routine
423905a86c5cSdrh ** might choose to code the expression at initialization time.
424005a86c5cSdrh */
424105a86c5cSdrh void sqlite3ExprCodeFactorable(Parse *pParse, Expr *pExpr, int target){
4242b8b06690Sdrh   if( pParse->okConstFactor && sqlite3ExprIsConstantNotJoin(pExpr) ){
4243ad879ffdSdrh     sqlite3ExprCodeAtInit(pParse, pExpr, target);
424405a86c5cSdrh   }else{
424505a86c5cSdrh     sqlite3ExprCode(pParse, pExpr, target);
424605a86c5cSdrh   }
4247cce7d176Sdrh }
4248cce7d176Sdrh 
4249cce7d176Sdrh /*
425060ec914cSpeter.d.reid ** Generate code that evaluates the given expression and puts the result
4251de4fcfddSdrh ** in register target.
425225303780Sdrh **
42532dcef11bSdrh ** Also make a copy of the expression results into another "cache" register
42542dcef11bSdrh ** and modify the expression so that the next time it is evaluated,
42552dcef11bSdrh ** the result is a copy of the cache register.
42562dcef11bSdrh **
42572dcef11bSdrh ** This routine is used for expressions that are used multiple
42582dcef11bSdrh ** times.  They are evaluated once and the results of the expression
42592dcef11bSdrh ** are reused.
426025303780Sdrh */
426105a86c5cSdrh void sqlite3ExprCodeAndCache(Parse *pParse, Expr *pExpr, int target){
426225303780Sdrh   Vdbe *v = pParse->pVdbe;
426325303780Sdrh   int iMem;
426405a86c5cSdrh 
426505a86c5cSdrh   assert( target>0 );
426605a86c5cSdrh   assert( pExpr->op!=TK_REGISTER );
426705a86c5cSdrh   sqlite3ExprCode(pParse, pExpr, target);
42682dcef11bSdrh   iMem = ++pParse->nMem;
426905a86c5cSdrh   sqlite3VdbeAddOp2(v, OP_Copy, target, iMem);
4270a4c3c87eSdrh   exprToRegister(pExpr, iMem);
427125303780Sdrh }
42727e02e5e6Sdrh 
4273678ccce8Sdrh /*
4274268380caSdrh ** Generate code that pushes the value of every element of the given
42759cbf3425Sdrh ** expression list into a sequence of registers beginning at target.
4276268380caSdrh **
42773df6c3b1Sdrh ** Return the number of elements evaluated.  The number returned will
42783df6c3b1Sdrh ** usually be pList->nExpr but might be reduced if SQLITE_ECEL_OMITREF
42793df6c3b1Sdrh ** is defined.
4280d1a01edaSdrh **
4281d1a01edaSdrh ** The SQLITE_ECEL_DUP flag prevents the arguments from being
4282d1a01edaSdrh ** filled using OP_SCopy.  OP_Copy must be used instead.
4283d1a01edaSdrh **
4284d1a01edaSdrh ** The SQLITE_ECEL_FACTOR argument allows constant arguments to be
4285d1a01edaSdrh ** factored out into initialization code.
4286b0df9634Sdrh **
4287b0df9634Sdrh ** The SQLITE_ECEL_REF flag means that expressions in the list with
4288b0df9634Sdrh ** ExprList.a[].u.x.iOrderByCol>0 have already been evaluated and stored
4289b0df9634Sdrh ** in registers at srcReg, and so the value can be copied from there.
42903df6c3b1Sdrh ** If SQLITE_ECEL_OMITREF is also set, then the values with u.x.iOrderByCol>0
42913df6c3b1Sdrh ** are simply omitted rather than being copied from srcReg.
4292268380caSdrh */
42934adee20fSdanielk1977 int sqlite3ExprCodeExprList(
4294268380caSdrh   Parse *pParse,     /* Parsing context */
4295389a1adbSdrh   ExprList *pList,   /* The expression list to be coded */
4296191b54cbSdrh   int target,        /* Where to write results */
42975579d59fSdrh   int srcReg,        /* Source registers if SQLITE_ECEL_REF */
4298d1a01edaSdrh   u8 flags           /* SQLITE_ECEL_* flags */
4299268380caSdrh ){
4300268380caSdrh   struct ExprList_item *pItem;
43015579d59fSdrh   int i, j, n;
4302d1a01edaSdrh   u8 copyOp = (flags & SQLITE_ECEL_DUP) ? OP_Copy : OP_SCopy;
43035579d59fSdrh   Vdbe *v = pParse->pVdbe;
43049d8b3072Sdrh   assert( pList!=0 );
43059cbf3425Sdrh   assert( target>0 );
4306d81a142bSdrh   assert( pParse->pVdbe!=0 );  /* Never gets this far otherwise */
4307268380caSdrh   n = pList->nExpr;
4308d9f158e7Sdrh   if( !ConstFactorOk(pParse) ) flags &= ~SQLITE_ECEL_FACTOR;
4309191b54cbSdrh   for(pItem=pList->a, i=0; i<n; i++, pItem++){
43107445ffe2Sdrh     Expr *pExpr = pItem->pExpr;
431124e25d32Sdan #ifdef SQLITE_ENABLE_SORTER_REFERENCES
431224e25d32Sdan     if( pItem->bSorterRef ){
431324e25d32Sdan       i--;
431424e25d32Sdan       n--;
431524e25d32Sdan     }else
431624e25d32Sdan #endif
4317257c13faSdan     if( (flags & SQLITE_ECEL_REF)!=0 && (j = pItem->u.x.iOrderByCol)>0 ){
4318257c13faSdan       if( flags & SQLITE_ECEL_OMITREF ){
4319257c13faSdan         i--;
4320257c13faSdan         n--;
4321257c13faSdan       }else{
43225579d59fSdrh         sqlite3VdbeAddOp2(v, copyOp, j+srcReg-1, target+i);
4323257c13faSdan       }
4324b8b06690Sdrh     }else if( (flags & SQLITE_ECEL_FACTOR)!=0
4325b8b06690Sdrh            && sqlite3ExprIsConstantNotJoin(pExpr)
4326b8b06690Sdrh     ){
4327ad879ffdSdrh       sqlite3ExprCodeAtInit(pParse, pExpr, target+i);
4328d1a01edaSdrh     }else{
43297445ffe2Sdrh       int inReg = sqlite3ExprCodeTarget(pParse, pExpr, target+i);
4330746fd9ccSdrh       if( inReg!=target+i ){
43314eded604Sdrh         VdbeOp *pOp;
43324eded604Sdrh         if( copyOp==OP_Copy
43334eded604Sdrh          && (pOp=sqlite3VdbeGetOp(v, -1))->opcode==OP_Copy
43344eded604Sdrh          && pOp->p1+pOp->p3+1==inReg
43354eded604Sdrh          && pOp->p2+pOp->p3+1==target+i
43364eded604Sdrh         ){
43374eded604Sdrh           pOp->p3++;
43384eded604Sdrh         }else{
43394eded604Sdrh           sqlite3VdbeAddOp2(v, copyOp, inReg, target+i);
43404eded604Sdrh         }
4341d1a01edaSdrh       }
4342d176611bSdrh     }
4343268380caSdrh   }
4344f9b596ebSdrh   return n;
4345268380caSdrh }
4346268380caSdrh 
4347268380caSdrh /*
434836c563a2Sdrh ** Generate code for a BETWEEN operator.
434936c563a2Sdrh **
435036c563a2Sdrh **    x BETWEEN y AND z
435136c563a2Sdrh **
435236c563a2Sdrh ** The above is equivalent to
435336c563a2Sdrh **
435436c563a2Sdrh **    x>=y AND x<=z
435536c563a2Sdrh **
435636c563a2Sdrh ** Code it as such, taking care to do the common subexpression
435760ec914cSpeter.d.reid ** elimination of x.
435884b19a3dSdrh **
435984b19a3dSdrh ** The xJumpIf parameter determines details:
436084b19a3dSdrh **
436184b19a3dSdrh **    NULL:                   Store the boolean result in reg[dest]
436284b19a3dSdrh **    sqlite3ExprIfTrue:      Jump to dest if true
436384b19a3dSdrh **    sqlite3ExprIfFalse:     Jump to dest if false
436484b19a3dSdrh **
436584b19a3dSdrh ** The jumpIfNull parameter is ignored if xJumpIf is NULL.
436636c563a2Sdrh */
436736c563a2Sdrh static void exprCodeBetween(
436836c563a2Sdrh   Parse *pParse,    /* Parsing and code generating context */
436936c563a2Sdrh   Expr *pExpr,      /* The BETWEEN expression */
437084b19a3dSdrh   int dest,         /* Jump destination or storage location */
437184b19a3dSdrh   void (*xJump)(Parse*,Expr*,int,int), /* Action to take */
437236c563a2Sdrh   int jumpIfNull    /* Take the jump if the BETWEEN is NULL */
437336c563a2Sdrh ){
437436c563a2Sdrh  Expr exprAnd;     /* The AND operator in  x>=y AND x<=z  */
437536c563a2Sdrh   Expr compLeft;    /* The  x>=y  term */
437636c563a2Sdrh   Expr compRight;   /* The  x<=z  term */
4377db45bd5eSdrh   Expr exprX;       /* The  x  subexpression */
4378db45bd5eSdrh   int regFree1 = 0; /* Temporary use register */
437984b19a3dSdrh 
438071c57db0Sdan   memset(&compLeft, 0, sizeof(Expr));
438171c57db0Sdan   memset(&compRight, 0, sizeof(Expr));
438271c57db0Sdan   memset(&exprAnd, 0, sizeof(Expr));
4383db45bd5eSdrh 
4384db45bd5eSdrh   assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
4385a8e05761Sdrh   exprNodeCopy(&exprX, pExpr->pLeft);
438636c563a2Sdrh   exprAnd.op = TK_AND;
438736c563a2Sdrh   exprAnd.pLeft = &compLeft;
438836c563a2Sdrh   exprAnd.pRight = &compRight;
438936c563a2Sdrh   compLeft.op = TK_GE;
4390db45bd5eSdrh   compLeft.pLeft = &exprX;
439136c563a2Sdrh   compLeft.pRight = pExpr->x.pList->a[0].pExpr;
439236c563a2Sdrh   compRight.op = TK_LE;
4393db45bd5eSdrh   compRight.pLeft = &exprX;
439436c563a2Sdrh   compRight.pRight = pExpr->x.pList->a[1].pExpr;
439512abf408Sdrh   exprToRegister(&exprX, exprCodeVector(pParse, &exprX, &regFree1));
439684b19a3dSdrh   if( xJump ){
439784b19a3dSdrh     xJump(pParse, &exprAnd, dest, jumpIfNull);
439836c563a2Sdrh   }else{
439936fd41e5Sdrh     /* Mark the expression is being from the ON or USING clause of a join
440036fd41e5Sdrh     ** so that the sqlite3ExprCodeTarget() routine will not attempt to move
440136fd41e5Sdrh     ** it into the Parse.pConstExpr list.  We should use a new bit for this,
440236fd41e5Sdrh     ** for clarity, but we are out of bits in the Expr.flags field so we
440336fd41e5Sdrh     ** have to reuse the EP_FromJoin bit.  Bummer. */
4404db45bd5eSdrh     exprX.flags |= EP_FromJoin;
440571c57db0Sdan     sqlite3ExprCodeTarget(pParse, &exprAnd, dest);
440636c563a2Sdrh   }
4407db45bd5eSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
440836c563a2Sdrh 
440936c563a2Sdrh   /* Ensure adequate test coverage */
4410db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull==0 && regFree1==0 );
4411db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull==0 && regFree1!=0 );
4412db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull!=0 && regFree1==0 );
4413db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull!=0 && regFree1!=0 );
4414db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1==0 );
4415db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1!=0 );
4416db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1==0 );
4417db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1!=0 );
441884b19a3dSdrh   testcase( xJump==0 );
441936c563a2Sdrh }
442036c563a2Sdrh 
442136c563a2Sdrh /*
4422cce7d176Sdrh ** Generate code for a boolean expression such that a jump is made
4423cce7d176Sdrh ** to the label "dest" if the expression is true but execution
4424cce7d176Sdrh ** continues straight thru if the expression is false.
4425f5905aa7Sdrh **
4426f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false), then
442735573356Sdrh ** take the jump if the jumpIfNull flag is SQLITE_JUMPIFNULL.
4428f2bc013cSdrh **
4429f2bc013cSdrh ** This code depends on the fact that certain token values (ex: TK_EQ)
4430f2bc013cSdrh ** are the same as opcode values (ex: OP_Eq) that implement the corresponding
4431f2bc013cSdrh ** operation.  Special comments in vdbe.c and the mkopcodeh.awk script in
4432f2bc013cSdrh ** the make process cause these values to align.  Assert()s in the code
4433f2bc013cSdrh ** below verify that the numbers are aligned correctly.
4434cce7d176Sdrh */
44354adee20fSdanielk1977 void sqlite3ExprIfTrue(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
4436cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
4437cce7d176Sdrh   int op = 0;
44382dcef11bSdrh   int regFree1 = 0;
44392dcef11bSdrh   int regFree2 = 0;
44402dcef11bSdrh   int r1, r2;
44412dcef11bSdrh 
444235573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
444348864df9Smistachkin   if( NEVER(v==0) )     return;  /* Existence of VDBE checked by caller */
444433cd4909Sdrh   if( NEVER(pExpr==0) ) return;  /* No way this can happen */
4445f2bc013cSdrh   op = pExpr->op;
44467b35a77bSdan   switch( op ){
444717180fcaSdrh     case TK_AND:
444817180fcaSdrh     case TK_OR: {
444917180fcaSdrh       Expr *pAlt = sqlite3ExprSimplifiedAndOr(pExpr);
445017180fcaSdrh       if( pAlt!=pExpr ){
445117180fcaSdrh         sqlite3ExprIfTrue(pParse, pAlt, dest, jumpIfNull);
445217180fcaSdrh       }else if( op==TK_AND ){
4453ec4ccdbcSdrh         int d2 = sqlite3VdbeMakeLabel(pParse);
4454c5499befSdrh         testcase( jumpIfNull==0 );
445517180fcaSdrh         sqlite3ExprIfFalse(pParse, pExpr->pLeft, d2,
445617180fcaSdrh                            jumpIfNull^SQLITE_JUMPIFNULL);
44574adee20fSdanielk1977         sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
44584adee20fSdanielk1977         sqlite3VdbeResolveLabel(v, d2);
445917180fcaSdrh       }else{
4460c5499befSdrh         testcase( jumpIfNull==0 );
44614adee20fSdanielk1977         sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
44624adee20fSdanielk1977         sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
446317180fcaSdrh       }
4464cce7d176Sdrh       break;
4465cce7d176Sdrh     }
4466cce7d176Sdrh     case TK_NOT: {
4467c5499befSdrh       testcase( jumpIfNull==0 );
44684adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
4469cce7d176Sdrh       break;
4470cce7d176Sdrh     }
44718abed7b9Sdrh     case TK_TRUTH: {
447296acafbeSdrh       int isNot;      /* IS NOT TRUE or IS NOT FALSE */
447396acafbeSdrh       int isTrue;     /* IS TRUE or IS NOT TRUE */
4474007c843bSdrh       testcase( jumpIfNull==0 );
44758abed7b9Sdrh       isNot = pExpr->op2==TK_ISNOT;
447696acafbeSdrh       isTrue = sqlite3ExprTruthValue(pExpr->pRight);
447743c4ac8bSdrh       testcase( isTrue && isNot );
447896acafbeSdrh       testcase( !isTrue && isNot );
447943c4ac8bSdrh       if( isTrue ^ isNot ){
44808abed7b9Sdrh         sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
44818abed7b9Sdrh                           isNot ? SQLITE_JUMPIFNULL : 0);
44828abed7b9Sdrh       }else{
44838abed7b9Sdrh         sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
44848abed7b9Sdrh                            isNot ? SQLITE_JUMPIFNULL : 0);
44858abed7b9Sdrh       }
4486007c843bSdrh       break;
4487007c843bSdrh     }
4488de845c2fSdrh     case TK_IS:
4489de845c2fSdrh     case TK_ISNOT:
4490de845c2fSdrh       testcase( op==TK_IS );
4491de845c2fSdrh       testcase( op==TK_ISNOT );
4492de845c2fSdrh       op = (op==TK_IS) ? TK_EQ : TK_NE;
4493de845c2fSdrh       jumpIfNull = SQLITE_NULLEQ;
4494de845c2fSdrh       /* Fall thru */
4495cce7d176Sdrh     case TK_LT:
4496cce7d176Sdrh     case TK_LE:
4497cce7d176Sdrh     case TK_GT:
4498cce7d176Sdrh     case TK_GE:
4499cce7d176Sdrh     case TK_NE:
45000ac65892Sdrh     case TK_EQ: {
4501625015e0Sdan       if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
4502c5499befSdrh       testcase( jumpIfNull==0 );
4503b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4504b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
450535573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
45062dcef11bSdrh                   r1, r2, dest, jumpIfNull);
45077d176105Sdrh       assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
45087d176105Sdrh       assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
45097d176105Sdrh       assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
45107d176105Sdrh       assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
4511de845c2fSdrh       assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4512de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4513de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4514de845c2fSdrh       assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4515de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
4516de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
45176a2fe093Sdrh       testcase( regFree1==0 );
45186a2fe093Sdrh       testcase( regFree2==0 );
45196a2fe093Sdrh       break;
45206a2fe093Sdrh     }
4521cce7d176Sdrh     case TK_ISNULL:
4522cce7d176Sdrh     case TK_NOTNULL: {
45237d176105Sdrh       assert( TK_ISNULL==OP_IsNull );   testcase( op==TK_ISNULL );
45247d176105Sdrh       assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
45252dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
45262dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
45277d176105Sdrh       VdbeCoverageIf(v, op==TK_ISNULL);
45287d176105Sdrh       VdbeCoverageIf(v, op==TK_NOTNULL);
4529c5499befSdrh       testcase( regFree1==0 );
4530cce7d176Sdrh       break;
4531cce7d176Sdrh     }
4532fef5208cSdrh     case TK_BETWEEN: {
45335c03f30aSdrh       testcase( jumpIfNull==0 );
453471c57db0Sdan       exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfTrue, jumpIfNull);
4535fef5208cSdrh       break;
4536fef5208cSdrh     }
4537bb201344Sshaneh #ifndef SQLITE_OMIT_SUBQUERY
4538e3365e6cSdrh     case TK_IN: {
4539ec4ccdbcSdrh       int destIfFalse = sqlite3VdbeMakeLabel(pParse);
4540e3365e6cSdrh       int destIfNull = jumpIfNull ? dest : destIfFalse;
4541e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
4542076e85f5Sdrh       sqlite3VdbeGoto(v, dest);
4543e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
4544e3365e6cSdrh       break;
4545e3365e6cSdrh     }
4546bb201344Sshaneh #endif
4547cce7d176Sdrh     default: {
45487b35a77bSdan     default_expr:
4549ad31727fSdrh       if( ExprAlwaysTrue(pExpr) ){
4550076e85f5Sdrh         sqlite3VdbeGoto(v, dest);
4551ad31727fSdrh       }else if( ExprAlwaysFalse(pExpr) ){
4552991a1985Sdrh         /* No-op */
4553991a1985Sdrh       }else{
45542dcef11bSdrh         r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
45552dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_If, r1, dest, jumpIfNull!=0);
4556688852abSdrh         VdbeCoverage(v);
4557c5499befSdrh         testcase( regFree1==0 );
4558c5499befSdrh         testcase( jumpIfNull==0 );
4559991a1985Sdrh       }
4560cce7d176Sdrh       break;
4561cce7d176Sdrh     }
4562cce7d176Sdrh   }
45632dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
45642dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
4565cce7d176Sdrh }
4566cce7d176Sdrh 
4567cce7d176Sdrh /*
456866b89c8fSdrh ** Generate code for a boolean expression such that a jump is made
4569cce7d176Sdrh ** to the label "dest" if the expression is false but execution
4570cce7d176Sdrh ** continues straight thru if the expression is true.
4571f5905aa7Sdrh **
4572f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false) then
457335573356Sdrh ** jump if jumpIfNull is SQLITE_JUMPIFNULL or fall through if jumpIfNull
457435573356Sdrh ** is 0.
4575cce7d176Sdrh */
45764adee20fSdanielk1977 void sqlite3ExprIfFalse(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
4577cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
4578cce7d176Sdrh   int op = 0;
45792dcef11bSdrh   int regFree1 = 0;
45802dcef11bSdrh   int regFree2 = 0;
45812dcef11bSdrh   int r1, r2;
45822dcef11bSdrh 
458335573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
458448864df9Smistachkin   if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
458533cd4909Sdrh   if( pExpr==0 )    return;
4586f2bc013cSdrh 
4587f2bc013cSdrh   /* The value of pExpr->op and op are related as follows:
4588f2bc013cSdrh   **
4589f2bc013cSdrh   **       pExpr->op            op
4590f2bc013cSdrh   **       ---------          ----------
4591f2bc013cSdrh   **       TK_ISNULL          OP_NotNull
4592f2bc013cSdrh   **       TK_NOTNULL         OP_IsNull
4593f2bc013cSdrh   **       TK_NE              OP_Eq
4594f2bc013cSdrh   **       TK_EQ              OP_Ne
4595f2bc013cSdrh   **       TK_GT              OP_Le
4596f2bc013cSdrh   **       TK_LE              OP_Gt
4597f2bc013cSdrh   **       TK_GE              OP_Lt
4598f2bc013cSdrh   **       TK_LT              OP_Ge
4599f2bc013cSdrh   **
4600f2bc013cSdrh   ** For other values of pExpr->op, op is undefined and unused.
4601f2bc013cSdrh   ** The value of TK_ and OP_ constants are arranged such that we
4602f2bc013cSdrh   ** can compute the mapping above using the following expression.
4603f2bc013cSdrh   ** Assert()s verify that the computation is correct.
4604f2bc013cSdrh   */
4605f2bc013cSdrh   op = ((pExpr->op+(TK_ISNULL&1))^1)-(TK_ISNULL&1);
4606f2bc013cSdrh 
4607f2bc013cSdrh   /* Verify correct alignment of TK_ and OP_ constants
4608f2bc013cSdrh   */
4609f2bc013cSdrh   assert( pExpr->op!=TK_ISNULL || op==OP_NotNull );
4610f2bc013cSdrh   assert( pExpr->op!=TK_NOTNULL || op==OP_IsNull );
4611f2bc013cSdrh   assert( pExpr->op!=TK_NE || op==OP_Eq );
4612f2bc013cSdrh   assert( pExpr->op!=TK_EQ || op==OP_Ne );
4613f2bc013cSdrh   assert( pExpr->op!=TK_LT || op==OP_Ge );
4614f2bc013cSdrh   assert( pExpr->op!=TK_LE || op==OP_Gt );
4615f2bc013cSdrh   assert( pExpr->op!=TK_GT || op==OP_Le );
4616f2bc013cSdrh   assert( pExpr->op!=TK_GE || op==OP_Lt );
4617f2bc013cSdrh 
4618ba00e30aSdan   switch( pExpr->op ){
461917180fcaSdrh     case TK_AND:
462017180fcaSdrh     case TK_OR: {
462117180fcaSdrh       Expr *pAlt = sqlite3ExprSimplifiedAndOr(pExpr);
462217180fcaSdrh       if( pAlt!=pExpr ){
462317180fcaSdrh         sqlite3ExprIfFalse(pParse, pAlt, dest, jumpIfNull);
462417180fcaSdrh       }else if( pExpr->op==TK_AND ){
4625c5499befSdrh         testcase( jumpIfNull==0 );
46264adee20fSdanielk1977         sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
46274adee20fSdanielk1977         sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
462817180fcaSdrh       }else{
4629ec4ccdbcSdrh         int d2 = sqlite3VdbeMakeLabel(pParse);
4630c5499befSdrh         testcase( jumpIfNull==0 );
463117180fcaSdrh         sqlite3ExprIfTrue(pParse, pExpr->pLeft, d2,
463217180fcaSdrh                           jumpIfNull^SQLITE_JUMPIFNULL);
46334adee20fSdanielk1977         sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
46344adee20fSdanielk1977         sqlite3VdbeResolveLabel(v, d2);
463517180fcaSdrh       }
4636cce7d176Sdrh       break;
4637cce7d176Sdrh     }
4638cce7d176Sdrh     case TK_NOT: {
46395c03f30aSdrh       testcase( jumpIfNull==0 );
46404adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
4641cce7d176Sdrh       break;
4642cce7d176Sdrh     }
46438abed7b9Sdrh     case TK_TRUTH: {
464496acafbeSdrh       int isNot;   /* IS NOT TRUE or IS NOT FALSE */
464596acafbeSdrh       int isTrue;  /* IS TRUE or IS NOT TRUE */
46468abed7b9Sdrh       testcase( jumpIfNull==0 );
46478abed7b9Sdrh       isNot = pExpr->op2==TK_ISNOT;
464896acafbeSdrh       isTrue = sqlite3ExprTruthValue(pExpr->pRight);
464943c4ac8bSdrh       testcase( isTrue && isNot );
465096acafbeSdrh       testcase( !isTrue && isNot );
465143c4ac8bSdrh       if( isTrue ^ isNot ){
46528abed7b9Sdrh         /* IS TRUE and IS NOT FALSE */
46538abed7b9Sdrh         sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
46548abed7b9Sdrh                            isNot ? 0 : SQLITE_JUMPIFNULL);
46558abed7b9Sdrh 
46568abed7b9Sdrh       }else{
46578abed7b9Sdrh         /* IS FALSE and IS NOT TRUE */
46588abed7b9Sdrh         sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
46598abed7b9Sdrh                           isNot ? 0 : SQLITE_JUMPIFNULL);
46608abed7b9Sdrh       }
4661007c843bSdrh       break;
4662007c843bSdrh     }
4663de845c2fSdrh     case TK_IS:
4664de845c2fSdrh     case TK_ISNOT:
4665de845c2fSdrh       testcase( pExpr->op==TK_IS );
4666de845c2fSdrh       testcase( pExpr->op==TK_ISNOT );
4667de845c2fSdrh       op = (pExpr->op==TK_IS) ? TK_NE : TK_EQ;
4668de845c2fSdrh       jumpIfNull = SQLITE_NULLEQ;
4669de845c2fSdrh       /* Fall thru */
4670cce7d176Sdrh     case TK_LT:
4671cce7d176Sdrh     case TK_LE:
4672cce7d176Sdrh     case TK_GT:
4673cce7d176Sdrh     case TK_GE:
4674cce7d176Sdrh     case TK_NE:
4675cce7d176Sdrh     case TK_EQ: {
4676625015e0Sdan       if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
4677c5499befSdrh       testcase( jumpIfNull==0 );
4678b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4679b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
468035573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
46812dcef11bSdrh                   r1, r2, dest, jumpIfNull);
46827d176105Sdrh       assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
46837d176105Sdrh       assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
46847d176105Sdrh       assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
46857d176105Sdrh       assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
4686de845c2fSdrh       assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4687de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4688de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4689de845c2fSdrh       assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4690de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
4691de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
46926a2fe093Sdrh       testcase( regFree1==0 );
46936a2fe093Sdrh       testcase( regFree2==0 );
46946a2fe093Sdrh       break;
46956a2fe093Sdrh     }
4696cce7d176Sdrh     case TK_ISNULL:
4697cce7d176Sdrh     case TK_NOTNULL: {
46982dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
46992dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
47007d176105Sdrh       testcase( op==TK_ISNULL );   VdbeCoverageIf(v, op==TK_ISNULL);
47017d176105Sdrh       testcase( op==TK_NOTNULL );  VdbeCoverageIf(v, op==TK_NOTNULL);
4702c5499befSdrh       testcase( regFree1==0 );
4703cce7d176Sdrh       break;
4704cce7d176Sdrh     }
4705fef5208cSdrh     case TK_BETWEEN: {
47065c03f30aSdrh       testcase( jumpIfNull==0 );
470771c57db0Sdan       exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfFalse, jumpIfNull);
4708fef5208cSdrh       break;
4709fef5208cSdrh     }
4710bb201344Sshaneh #ifndef SQLITE_OMIT_SUBQUERY
4711e3365e6cSdrh     case TK_IN: {
4712e3365e6cSdrh       if( jumpIfNull ){
4713e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, dest);
4714e3365e6cSdrh       }else{
4715ec4ccdbcSdrh         int destIfNull = sqlite3VdbeMakeLabel(pParse);
4716e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, destIfNull);
4717e3365e6cSdrh         sqlite3VdbeResolveLabel(v, destIfNull);
4718e3365e6cSdrh       }
4719e3365e6cSdrh       break;
4720e3365e6cSdrh     }
4721bb201344Sshaneh #endif
4722cce7d176Sdrh     default: {
4723ba00e30aSdan     default_expr:
4724ad31727fSdrh       if( ExprAlwaysFalse(pExpr) ){
4725076e85f5Sdrh         sqlite3VdbeGoto(v, dest);
4726ad31727fSdrh       }else if( ExprAlwaysTrue(pExpr) ){
4727991a1985Sdrh         /* no-op */
4728991a1985Sdrh       }else{
47292dcef11bSdrh         r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
47302dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_IfNot, r1, dest, jumpIfNull!=0);
4731688852abSdrh         VdbeCoverage(v);
4732c5499befSdrh         testcase( regFree1==0 );
4733c5499befSdrh         testcase( jumpIfNull==0 );
4734991a1985Sdrh       }
4735cce7d176Sdrh       break;
4736cce7d176Sdrh     }
4737cce7d176Sdrh   }
47382dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
47392dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
4740cce7d176Sdrh }
47412282792aSdrh 
47422282792aSdrh /*
474372bc8208Sdrh ** Like sqlite3ExprIfFalse() except that a copy is made of pExpr before
474472bc8208Sdrh ** code generation, and that copy is deleted after code generation. This
474572bc8208Sdrh ** ensures that the original pExpr is unchanged.
474672bc8208Sdrh */
474772bc8208Sdrh void sqlite3ExprIfFalseDup(Parse *pParse, Expr *pExpr, int dest,int jumpIfNull){
474872bc8208Sdrh   sqlite3 *db = pParse->db;
474972bc8208Sdrh   Expr *pCopy = sqlite3ExprDup(db, pExpr, 0);
475072bc8208Sdrh   if( db->mallocFailed==0 ){
475172bc8208Sdrh     sqlite3ExprIfFalse(pParse, pCopy, dest, jumpIfNull);
475272bc8208Sdrh   }
475372bc8208Sdrh   sqlite3ExprDelete(db, pCopy);
475472bc8208Sdrh }
475572bc8208Sdrh 
47565aa550cfSdan /*
47575aa550cfSdan ** Expression pVar is guaranteed to be an SQL variable. pExpr may be any
47585aa550cfSdan ** type of expression.
47595aa550cfSdan **
47605aa550cfSdan ** If pExpr is a simple SQL value - an integer, real, string, blob
47615aa550cfSdan ** or NULL value - then the VDBE currently being prepared is configured
47625aa550cfSdan ** to re-prepare each time a new value is bound to variable pVar.
47635aa550cfSdan **
47645aa550cfSdan ** Additionally, if pExpr is a simple SQL value and the value is the
47655aa550cfSdan ** same as that currently bound to variable pVar, non-zero is returned.
47665aa550cfSdan ** Otherwise, if the values are not the same or if pExpr is not a simple
47675aa550cfSdan ** SQL value, zero is returned.
47685aa550cfSdan */
47695aa550cfSdan static int exprCompareVariable(Parse *pParse, Expr *pVar, Expr *pExpr){
47705aa550cfSdan   int res = 0;
4771c0804226Sdrh   int iVar;
4772c0804226Sdrh   sqlite3_value *pL, *pR = 0;
47735aa550cfSdan 
47745aa550cfSdan   sqlite3ValueFromExpr(pParse->db, pExpr, SQLITE_UTF8, SQLITE_AFF_BLOB, &pR);
4775c0804226Sdrh   if( pR ){
4776c0804226Sdrh     iVar = pVar->iColumn;
4777c0804226Sdrh     sqlite3VdbeSetVarmask(pParse->pVdbe, iVar);
4778c0804226Sdrh     pL = sqlite3VdbeGetBoundValue(pParse->pReprepare, iVar, SQLITE_AFF_BLOB);
47795aa307e2Sdrh     if( pL ){
47805aa307e2Sdrh       if( sqlite3_value_type(pL)==SQLITE_TEXT ){
47815aa307e2Sdrh         sqlite3_value_text(pL); /* Make sure the encoding is UTF-8 */
47825aa307e2Sdrh       }
47835aa307e2Sdrh       res =  0==sqlite3MemCompare(pL, pR, 0);
47845aa550cfSdan     }
47855aa550cfSdan     sqlite3ValueFree(pR);
47865aa550cfSdan     sqlite3ValueFree(pL);
47875aa550cfSdan   }
47885aa550cfSdan 
47895aa550cfSdan   return res;
47905aa550cfSdan }
479172bc8208Sdrh 
479272bc8208Sdrh /*
47931d9da70aSdrh ** Do a deep comparison of two expression trees.  Return 0 if the two
47941d9da70aSdrh ** expressions are completely identical.  Return 1 if they differ only
47951d9da70aSdrh ** by a COLLATE operator at the top level.  Return 2 if there are differences
47961d9da70aSdrh ** other than the top-level COLLATE operator.
4797d40aab0eSdrh **
4798619a1305Sdrh ** If any subelement of pB has Expr.iTable==(-1) then it is allowed
4799619a1305Sdrh ** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
4800619a1305Sdrh **
480166518ca7Sdrh ** The pA side might be using TK_REGISTER.  If that is the case and pB is
480266518ca7Sdrh ** not using TK_REGISTER but is otherwise equivalent, then still return 0.
480366518ca7Sdrh **
48041d9da70aSdrh ** Sometimes this routine will return 2 even if the two expressions
4805d40aab0eSdrh ** really are equivalent.  If we cannot prove that the expressions are
48061d9da70aSdrh ** identical, we return 2 just to be safe.  So if this routine
48071d9da70aSdrh ** returns 2, then you do not really know for certain if the two
48081d9da70aSdrh ** expressions are the same.  But if you get a 0 or 1 return, then you
4809d40aab0eSdrh ** can be sure the expressions are the same.  In the places where
48101d9da70aSdrh ** this routine is used, it does not hurt to get an extra 2 - that
4811d40aab0eSdrh ** just might result in some slightly slower code.  But returning
48121d9da70aSdrh ** an incorrect 0 or 1 could lead to a malfunction.
48135aa550cfSdan **
4814c0804226Sdrh ** If pParse is not NULL then TK_VARIABLE terms in pA with bindings in
4815c0804226Sdrh ** pParse->pReprepare can be matched against literals in pB.  The
4816c0804226Sdrh ** pParse->pVdbe->expmask bitmask is updated for each variable referenced.
4817c0804226Sdrh ** If pParse is NULL (the normal case) then any TK_VARIABLE term in
4818c0804226Sdrh ** Argument pParse should normally be NULL. If it is not NULL and pA or
4819c0804226Sdrh ** pB causes a return value of 2.
48202282792aSdrh */
48215aa550cfSdan int sqlite3ExprCompare(Parse *pParse, Expr *pA, Expr *pB, int iTab){
482210d1edf0Sdrh   u32 combinedFlags;
48234b202ae2Sdanielk1977   if( pA==0 || pB==0 ){
48241d9da70aSdrh     return pB==pA ? 0 : 2;
48252282792aSdrh   }
48265aa550cfSdan   if( pParse && pA->op==TK_VARIABLE && exprCompareVariable(pParse, pA, pB) ){
48275aa550cfSdan     return 0;
48285aa550cfSdan   }
482910d1edf0Sdrh   combinedFlags = pA->flags | pB->flags;
483010d1edf0Sdrh   if( combinedFlags & EP_IntValue ){
483110d1edf0Sdrh     if( (pA->flags&pB->flags&EP_IntValue)!=0 && pA->u.iValue==pB->u.iValue ){
483210d1edf0Sdrh       return 0;
483310d1edf0Sdrh     }
48341d9da70aSdrh     return 2;
48356ab3a2ecSdanielk1977   }
483616dd3985Sdan   if( pA->op!=pB->op || pA->op==TK_RAISE ){
48375aa550cfSdan     if( pA->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA->pLeft,pB,iTab)<2 ){
4838ae80ddeaSdrh       return 1;
4839ae80ddeaSdrh     }
48405aa550cfSdan     if( pB->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA,pB->pLeft,iTab)<2 ){
4841ae80ddeaSdrh       return 1;
4842ae80ddeaSdrh     }
4843ae80ddeaSdrh     return 2;
4844ae80ddeaSdrh   }
48452edc5fd7Sdrh   if( pA->op!=TK_COLUMN && pA->op!=TK_AGG_COLUMN && pA->u.zToken ){
4846*4f9adee2Sdan     if( pA->op==TK_FUNCTION || pA->op==TK_AGG_FUNCTION ){
4847390b88a4Sdrh       if( sqlite3StrICmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
4848eda079cdSdrh #ifndef SQLITE_OMIT_WINDOWFUNC
4849*4f9adee2Sdan       assert( pA->op==pB->op );
4850*4f9adee2Sdan       if( ExprHasProperty(pA,EP_WinFunc)!=ExprHasProperty(pB,EP_WinFunc) ){
4851*4f9adee2Sdan         return 2;
4852*4f9adee2Sdan       }
4853eda079cdSdrh       if( ExprHasProperty(pA,EP_WinFunc) ){
4854*4f9adee2Sdan         if( sqlite3WindowCompare(pParse, pA->y.pWin, pB->y.pWin, 1)!=0 ){
4855*4f9adee2Sdan           return 2;
4856*4f9adee2Sdan         }
4857eda079cdSdrh       }
4858eda079cdSdrh #endif
4859f20bbc5fSdrh     }else if( pA->op==TK_NULL ){
4860f20bbc5fSdrh       return 0;
4861d5af5420Sdrh     }else if( pA->op==TK_COLLATE ){
4862e79f6299Sdrh       if( sqlite3_stricmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
4863f20bbc5fSdrh     }else if( ALWAYS(pB->u.zToken!=0) && strcmp(pA->u.zToken,pB->u.zToken)!=0 ){
4864d5af5420Sdrh       return 2;
486510d1edf0Sdrh     }
486610d1edf0Sdrh   }
486710d1edf0Sdrh   if( (pA->flags & EP_Distinct)!=(pB->flags & EP_Distinct) ) return 2;
486889b6de03Sdrh   if( (combinedFlags & EP_TokenOnly)==0 ){
486910d1edf0Sdrh     if( combinedFlags & EP_xIsSelect ) return 2;
4870efad2e23Sdrh     if( (combinedFlags & EP_FixedCol)==0
4871efad2e23Sdrh      && sqlite3ExprCompare(pParse, pA->pLeft, pB->pLeft, iTab) ) return 2;
48725aa550cfSdan     if( sqlite3ExprCompare(pParse, pA->pRight, pB->pRight, iTab) ) return 2;
4873619a1305Sdrh     if( sqlite3ExprListCompare(pA->x.pList, pB->x.pList, iTab) ) return 2;
487403c5c213Sdrh     if( pA->op!=TK_STRING
487503c5c213Sdrh      && pA->op!=TK_TRUEFALSE
487603c5c213Sdrh      && (combinedFlags & EP_Reduced)==0
487703c5c213Sdrh     ){
4878619a1305Sdrh       if( pA->iColumn!=pB->iColumn ) return 2;
48798ac02a94Sdan       if( pA->op2!=pB->op2 ) return 2;
488066518ca7Sdrh       if( pA->iTable!=pB->iTable
488185f8aa79Sdrh        && (pA->iTable!=iTab || NEVER(pB->iTable>=0)) ) return 2;
48821d9da70aSdrh     }
48831d9da70aSdrh   }
48842646da7eSdrh   return 0;
48852646da7eSdrh }
48862282792aSdrh 
48878c6f666bSdrh /*
48888c6f666bSdrh ** Compare two ExprList objects.  Return 0 if they are identical and
48898c6f666bSdrh ** non-zero if they differ in any way.
48908c6f666bSdrh **
4891619a1305Sdrh ** If any subelement of pB has Expr.iTable==(-1) then it is allowed
4892619a1305Sdrh ** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
4893619a1305Sdrh **
48948c6f666bSdrh ** This routine might return non-zero for equivalent ExprLists.  The
48958c6f666bSdrh ** only consequence will be disabled optimizations.  But this routine
48968c6f666bSdrh ** must never return 0 if the two ExprList objects are different, or
48978c6f666bSdrh ** a malfunction will result.
48988c6f666bSdrh **
48998c6f666bSdrh ** Two NULL pointers are considered to be the same.  But a NULL pointer
49008c6f666bSdrh ** always differs from a non-NULL pointer.
49018c6f666bSdrh */
4902619a1305Sdrh int sqlite3ExprListCompare(ExprList *pA, ExprList *pB, int iTab){
49038c6f666bSdrh   int i;
49048c6f666bSdrh   if( pA==0 && pB==0 ) return 0;
49058c6f666bSdrh   if( pA==0 || pB==0 ) return 1;
49068c6f666bSdrh   if( pA->nExpr!=pB->nExpr ) return 1;
49078c6f666bSdrh   for(i=0; i<pA->nExpr; i++){
49088c6f666bSdrh     Expr *pExprA = pA->a[i].pExpr;
49098c6f666bSdrh     Expr *pExprB = pB->a[i].pExpr;
49108c6f666bSdrh     if( pA->a[i].sortOrder!=pB->a[i].sortOrder ) return 1;
49115aa550cfSdan     if( sqlite3ExprCompare(0, pExprA, pExprB, iTab) ) return 1;
49128c6f666bSdrh   }
49138c6f666bSdrh   return 0;
49148c6f666bSdrh }
491513449892Sdrh 
49162282792aSdrh /*
4917f9463dfbSdrh ** Like sqlite3ExprCompare() except COLLATE operators at the top-level
4918f9463dfbSdrh ** are ignored.
4919f9463dfbSdrh */
4920f9463dfbSdrh int sqlite3ExprCompareSkip(Expr *pA, Expr *pB, int iTab){
49215aa550cfSdan   return sqlite3ExprCompare(0,
4922f9463dfbSdrh              sqlite3ExprSkipCollate(pA),
4923f9463dfbSdrh              sqlite3ExprSkipCollate(pB),
4924f9463dfbSdrh              iTab);
4925f9463dfbSdrh }
4926f9463dfbSdrh 
4927f9463dfbSdrh /*
4928c51cf864Sdrh ** Return non-zero if Expr p can only be true if pNN is not NULL.
4929c51cf864Sdrh */
4930c51cf864Sdrh static int exprImpliesNotNull(
4931c51cf864Sdrh   Parse *pParse,      /* Parsing context */
4932c51cf864Sdrh   Expr *p,            /* The expression to be checked */
4933c51cf864Sdrh   Expr *pNN,          /* The expression that is NOT NULL */
4934c51cf864Sdrh   int iTab,           /* Table being evaluated */
4935c51cf864Sdrh   int seenNot         /* True if p is an operand of NOT */
4936c51cf864Sdrh ){
4937c51cf864Sdrh   assert( p );
4938c51cf864Sdrh   assert( pNN );
4939c51cf864Sdrh   if( sqlite3ExprCompare(pParse, p, pNN, iTab)==0 ) return 1;
4940c51cf864Sdrh   switch( p->op ){
4941c51cf864Sdrh     case TK_IN: {
4942c51cf864Sdrh       if( seenNot && ExprHasProperty(p, EP_xIsSelect) ) return 0;
4943c51cf864Sdrh       assert( ExprHasProperty(p,EP_xIsSelect)
4944c51cf864Sdrh            || (p->x.pList!=0 && p->x.pList->nExpr>0) );
4945c51cf864Sdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, seenNot);
4946c51cf864Sdrh     }
4947c51cf864Sdrh     case TK_BETWEEN: {
4948c51cf864Sdrh       ExprList *pList = p->x.pList;
4949c51cf864Sdrh       assert( pList!=0 );
4950c51cf864Sdrh       assert( pList->nExpr==2 );
4951c51cf864Sdrh       if( seenNot ) return 0;
4952c51cf864Sdrh       if( exprImpliesNotNull(pParse, pList->a[0].pExpr, pNN, iTab, seenNot)
4953c51cf864Sdrh        || exprImpliesNotNull(pParse, pList->a[1].pExpr, pNN, iTab, seenNot)
4954c51cf864Sdrh       ){
4955c51cf864Sdrh         return 1;
4956c51cf864Sdrh       }
4957c51cf864Sdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, seenNot);
4958c51cf864Sdrh     }
4959c51cf864Sdrh     case TK_EQ:
4960c51cf864Sdrh     case TK_NE:
4961c51cf864Sdrh     case TK_LT:
4962c51cf864Sdrh     case TK_LE:
4963c51cf864Sdrh     case TK_GT:
4964c51cf864Sdrh     case TK_GE:
4965c51cf864Sdrh     case TK_PLUS:
4966c51cf864Sdrh     case TK_MINUS:
4967c51cf864Sdrh     case TK_STAR:
4968c51cf864Sdrh     case TK_REM:
4969c51cf864Sdrh     case TK_BITAND:
4970c51cf864Sdrh     case TK_BITOR:
4971c51cf864Sdrh     case TK_SLASH:
4972c51cf864Sdrh     case TK_LSHIFT:
4973c51cf864Sdrh     case TK_RSHIFT:
4974c51cf864Sdrh     case TK_CONCAT: {
4975c51cf864Sdrh       if( exprImpliesNotNull(pParse, p->pRight, pNN, iTab, seenNot) ) return 1;
4976c51cf864Sdrh       /* Fall thru into the next case */
4977c51cf864Sdrh     }
4978c51cf864Sdrh     case TK_SPAN:
4979c51cf864Sdrh     case TK_COLLATE:
4980c51cf864Sdrh     case TK_BITNOT:
4981c51cf864Sdrh     case TK_UPLUS:
4982c51cf864Sdrh     case TK_UMINUS: {
4983c51cf864Sdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, seenNot);
4984c51cf864Sdrh     }
4985c51cf864Sdrh     case TK_TRUTH: {
4986c51cf864Sdrh       if( seenNot ) return 0;
4987c51cf864Sdrh       if( p->op2!=TK_IS ) return 0;
4988c51cf864Sdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, seenNot);
4989c51cf864Sdrh     }
4990c51cf864Sdrh     case TK_NOT: {
4991c51cf864Sdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
4992c51cf864Sdrh     }
4993c51cf864Sdrh   }
4994c51cf864Sdrh   return 0;
4995c51cf864Sdrh }
4996c51cf864Sdrh 
4997c51cf864Sdrh /*
49984bd5f73fSdrh ** Return true if we can prove the pE2 will always be true if pE1 is
49994bd5f73fSdrh ** true.  Return false if we cannot complete the proof or if pE2 might
50004bd5f73fSdrh ** be false.  Examples:
50014bd5f73fSdrh **
5002619a1305Sdrh **     pE1: x==5       pE2: x==5             Result: true
50034bd5f73fSdrh **     pE1: x>0        pE2: x==5             Result: false
5004619a1305Sdrh **     pE1: x=21       pE2: x=21 OR y=43     Result: true
50054bd5f73fSdrh **     pE1: x!=123     pE2: x IS NOT NULL    Result: true
5006619a1305Sdrh **     pE1: x!=?1      pE2: x IS NOT NULL    Result: true
5007619a1305Sdrh **     pE1: x IS NULL  pE2: x IS NOT NULL    Result: false
5008619a1305Sdrh **     pE1: x IS ?2    pE2: x IS NOT NULL    Reuslt: false
50094bd5f73fSdrh **
50104bd5f73fSdrh ** When comparing TK_COLUMN nodes between pE1 and pE2, if pE2 has
50114bd5f73fSdrh ** Expr.iTable<0 then assume a table number given by iTab.
50124bd5f73fSdrh **
5013c0804226Sdrh ** If pParse is not NULL, then the values of bound variables in pE1 are
5014c0804226Sdrh ** compared against literal values in pE2 and pParse->pVdbe->expmask is
5015c0804226Sdrh ** modified to record which bound variables are referenced.  If pParse
5016c0804226Sdrh ** is NULL, then false will be returned if pE1 contains any bound variables.
5017c0804226Sdrh **
50184bd5f73fSdrh ** When in doubt, return false.  Returning true might give a performance
50194bd5f73fSdrh ** improvement.  Returning false might cause a performance reduction, but
50204bd5f73fSdrh ** it will always give the correct answer and is hence always safe.
50214bd5f73fSdrh */
50225aa550cfSdan int sqlite3ExprImpliesExpr(Parse *pParse, Expr *pE1, Expr *pE2, int iTab){
50235aa550cfSdan   if( sqlite3ExprCompare(pParse, pE1, pE2, iTab)==0 ){
5024619a1305Sdrh     return 1;
5025619a1305Sdrh   }
5026619a1305Sdrh   if( pE2->op==TK_OR
50275aa550cfSdan    && (sqlite3ExprImpliesExpr(pParse, pE1, pE2->pLeft, iTab)
50285aa550cfSdan              || sqlite3ExprImpliesExpr(pParse, pE1, pE2->pRight, iTab) )
5029619a1305Sdrh   ){
5030619a1305Sdrh     return 1;
5031619a1305Sdrh   }
5032664d6d13Sdrh   if( pE2->op==TK_NOTNULL
5033c51cf864Sdrh    && exprImpliesNotNull(pParse, pE1, pE2->pLeft, iTab, 0)
5034664d6d13Sdrh   ){
5035c51cf864Sdrh     return 1;
5036619a1305Sdrh   }
5037619a1305Sdrh   return 0;
50384bd5f73fSdrh }
50394bd5f73fSdrh 
50404bd5f73fSdrh /*
50412589787cSdrh ** This is the Expr node callback for sqlite3ExprImpliesNotNullRow().
50422589787cSdrh ** If the expression node requires that the table at pWalker->iCur
5043f8937f90Sdrh ** have one or more non-NULL column, then set pWalker->eCode to 1 and abort.
5044f8937f90Sdrh **
5045f8937f90Sdrh ** This routine controls an optimization.  False positives (setting
5046f8937f90Sdrh ** pWalker->eCode to 1 when it should not be) are deadly, but false-negatives
5047f8937f90Sdrh ** (never setting pWalker->eCode) is a harmless missed optimization.
50482589787cSdrh */
50492589787cSdrh static int impliesNotNullRow(Walker *pWalker, Expr *pExpr){
5050f8937f90Sdrh   testcase( pExpr->op==TK_AGG_COLUMN );
5051821b610bSdrh   testcase( pExpr->op==TK_AGG_FUNCTION );
50522589787cSdrh   if( ExprHasProperty(pExpr, EP_FromJoin) ) return WRC_Prune;
50532589787cSdrh   switch( pExpr->op ){
50540493222fSdan     case TK_ISNOT:
5055a1054dccSdan     case TK_NOT:
50562589787cSdrh     case TK_ISNULL:
5057d5793672Sdrh     case TK_NOTNULL:
50582589787cSdrh     case TK_IS:
50592589787cSdrh     case TK_OR:
50602c492061Sdrh     case TK_CASE:
5061e3eff266Sdrh     case TK_IN:
50622589787cSdrh     case TK_FUNCTION:
50630493222fSdan       testcase( pExpr->op==TK_ISNOT );
50640493222fSdan       testcase( pExpr->op==TK_NOT );
5065821b610bSdrh       testcase( pExpr->op==TK_ISNULL );
5066d5793672Sdrh       testcase( pExpr->op==TK_NOTNULL );
5067821b610bSdrh       testcase( pExpr->op==TK_IS );
5068821b610bSdrh       testcase( pExpr->op==TK_OR );
5069821b610bSdrh       testcase( pExpr->op==TK_CASE );
5070821b610bSdrh       testcase( pExpr->op==TK_IN );
5071821b610bSdrh       testcase( pExpr->op==TK_FUNCTION );
50722589787cSdrh       return WRC_Prune;
50732589787cSdrh     case TK_COLUMN:
50742589787cSdrh       if( pWalker->u.iCur==pExpr->iTable ){
50752589787cSdrh         pWalker->eCode = 1;
50762589787cSdrh         return WRC_Abort;
50772589787cSdrh       }
50782589787cSdrh       return WRC_Prune;
50799881155dSdrh 
50809881155dSdrh     /* Virtual tables are allowed to use constraints like x=NULL.  So
50819881155dSdrh     ** a term of the form x=y does not prove that y is not null if x
50829881155dSdrh     ** is the column of a virtual table */
50839881155dSdrh     case TK_EQ:
50849881155dSdrh     case TK_NE:
50859881155dSdrh     case TK_LT:
50869881155dSdrh     case TK_LE:
50879881155dSdrh     case TK_GT:
50889881155dSdrh     case TK_GE:
50899881155dSdrh       testcase( pExpr->op==TK_EQ );
50909881155dSdrh       testcase( pExpr->op==TK_NE );
50919881155dSdrh       testcase( pExpr->op==TK_LT );
50929881155dSdrh       testcase( pExpr->op==TK_LE );
50939881155dSdrh       testcase( pExpr->op==TK_GT );
50949881155dSdrh       testcase( pExpr->op==TK_GE );
5095eda079cdSdrh       if( (pExpr->pLeft->op==TK_COLUMN && IsVirtual(pExpr->pLeft->y.pTab))
5096eda079cdSdrh        || (pExpr->pRight->op==TK_COLUMN && IsVirtual(pExpr->pRight->y.pTab))
50979881155dSdrh       ){
50989881155dSdrh        return WRC_Prune;
50999881155dSdrh       }
51002589787cSdrh     default:
51012589787cSdrh       return WRC_Continue;
51022589787cSdrh   }
51032589787cSdrh }
51042589787cSdrh 
51052589787cSdrh /*
51062589787cSdrh ** Return true (non-zero) if expression p can only be true if at least
51072589787cSdrh ** one column of table iTab is non-null.  In other words, return true
51082589787cSdrh ** if expression p will always be NULL or false if every column of iTab
51092589787cSdrh ** is NULL.
51102589787cSdrh **
5111821b610bSdrh ** False negatives are acceptable.  In other words, it is ok to return
5112821b610bSdrh ** zero even if expression p will never be true of every column of iTab
5113821b610bSdrh ** is NULL.  A false negative is merely a missed optimization opportunity.
5114821b610bSdrh **
5115821b610bSdrh ** False positives are not allowed, however.  A false positive may result
5116821b610bSdrh ** in an incorrect answer.
5117821b610bSdrh **
51182589787cSdrh ** Terms of p that are marked with EP_FromJoin (and hence that come from
51192589787cSdrh ** the ON or USING clauses of LEFT JOINS) are excluded from the analysis.
51202589787cSdrh **
51212589787cSdrh ** This routine is used to check if a LEFT JOIN can be converted into
51222589787cSdrh ** an ordinary JOIN.  The p argument is the WHERE clause.  If the WHERE
51232589787cSdrh ** clause requires that some column of the right table of the LEFT JOIN
51242589787cSdrh ** be non-NULL, then the LEFT JOIN can be safely converted into an
51252589787cSdrh ** ordinary join.
51262589787cSdrh */
51272589787cSdrh int sqlite3ExprImpliesNonNullRow(Expr *p, int iTab){
51282589787cSdrh   Walker w;
5129d6db6598Sdrh   p = sqlite3ExprSkipCollate(p);
5130d6db6598Sdrh   while( p ){
5131d6db6598Sdrh     if( p->op==TK_NOTNULL ){
5132d6db6598Sdrh       p = p->pLeft;
5133d6db6598Sdrh     }else if( p->op==TK_AND ){
5134d6db6598Sdrh       if( sqlite3ExprImpliesNonNullRow(p->pLeft, iTab) ) return 1;
5135d6db6598Sdrh       p = p->pRight;
5136d6db6598Sdrh     }else{
5137d6db6598Sdrh       break;
5138d6db6598Sdrh     }
5139d6db6598Sdrh   }
51402589787cSdrh   w.xExprCallback = impliesNotNullRow;
51412589787cSdrh   w.xSelectCallback = 0;
51422589787cSdrh   w.xSelectCallback2 = 0;
51432589787cSdrh   w.eCode = 0;
51442589787cSdrh   w.u.iCur = iTab;
51452589787cSdrh   sqlite3WalkExpr(&w, p);
51462589787cSdrh   return w.eCode;
51472589787cSdrh }
51482589787cSdrh 
51492589787cSdrh /*
5150030796dfSdrh ** An instance of the following structure is used by the tree walker
51512409f8a1Sdrh ** to determine if an expression can be evaluated by reference to the
51522409f8a1Sdrh ** index only, without having to do a search for the corresponding
51532409f8a1Sdrh ** table entry.  The IdxCover.pIdx field is the index.  IdxCover.iCur
51542409f8a1Sdrh ** is the cursor for the table.
51552409f8a1Sdrh */
51562409f8a1Sdrh struct IdxCover {
51572409f8a1Sdrh   Index *pIdx;     /* The index to be tested for coverage */
51582409f8a1Sdrh   int iCur;        /* Cursor number for the table corresponding to the index */
51592409f8a1Sdrh };
51602409f8a1Sdrh 
51612409f8a1Sdrh /*
51622409f8a1Sdrh ** Check to see if there are references to columns in table
51632409f8a1Sdrh ** pWalker->u.pIdxCover->iCur can be satisfied using the index
51642409f8a1Sdrh ** pWalker->u.pIdxCover->pIdx.
51652409f8a1Sdrh */
51662409f8a1Sdrh static int exprIdxCover(Walker *pWalker, Expr *pExpr){
51672409f8a1Sdrh   if( pExpr->op==TK_COLUMN
51682409f8a1Sdrh    && pExpr->iTable==pWalker->u.pIdxCover->iCur
51692409f8a1Sdrh    && sqlite3ColumnOfIndex(pWalker->u.pIdxCover->pIdx, pExpr->iColumn)<0
51702409f8a1Sdrh   ){
51712409f8a1Sdrh     pWalker->eCode = 1;
51722409f8a1Sdrh     return WRC_Abort;
51732409f8a1Sdrh   }
51742409f8a1Sdrh   return WRC_Continue;
51752409f8a1Sdrh }
51762409f8a1Sdrh 
51772409f8a1Sdrh /*
5178e604ec0bSdrh ** Determine if an index pIdx on table with cursor iCur contains will
5179e604ec0bSdrh ** the expression pExpr.  Return true if the index does cover the
5180e604ec0bSdrh ** expression and false if the pExpr expression references table columns
5181e604ec0bSdrh ** that are not found in the index pIdx.
51822409f8a1Sdrh **
51832409f8a1Sdrh ** An index covering an expression means that the expression can be
51842409f8a1Sdrh ** evaluated using only the index and without having to lookup the
51852409f8a1Sdrh ** corresponding table entry.
51862409f8a1Sdrh */
51872409f8a1Sdrh int sqlite3ExprCoveredByIndex(
51882409f8a1Sdrh   Expr *pExpr,        /* The index to be tested */
51892409f8a1Sdrh   int iCur,           /* The cursor number for the corresponding table */
51902409f8a1Sdrh   Index *pIdx         /* The index that might be used for coverage */
51912409f8a1Sdrh ){
51922409f8a1Sdrh   Walker w;
51932409f8a1Sdrh   struct IdxCover xcov;
51942409f8a1Sdrh   memset(&w, 0, sizeof(w));
51952409f8a1Sdrh   xcov.iCur = iCur;
51962409f8a1Sdrh   xcov.pIdx = pIdx;
51972409f8a1Sdrh   w.xExprCallback = exprIdxCover;
51982409f8a1Sdrh   w.u.pIdxCover = &xcov;
51992409f8a1Sdrh   sqlite3WalkExpr(&w, pExpr);
52002409f8a1Sdrh   return !w.eCode;
52012409f8a1Sdrh }
52022409f8a1Sdrh 
52032409f8a1Sdrh 
52042409f8a1Sdrh /*
52052409f8a1Sdrh ** An instance of the following structure is used by the tree walker
5206030796dfSdrh ** to count references to table columns in the arguments of an
5207ed551b95Sdrh ** aggregate function, in order to implement the
5208ed551b95Sdrh ** sqlite3FunctionThisSrc() routine.
5209374fdce4Sdrh */
5210030796dfSdrh struct SrcCount {
5211030796dfSdrh   SrcList *pSrc;   /* One particular FROM clause in a nested query */
5212030796dfSdrh   int nThis;       /* Number of references to columns in pSrcList */
5213030796dfSdrh   int nOther;      /* Number of references to columns in other FROM clauses */
5214030796dfSdrh };
5215030796dfSdrh 
5216030796dfSdrh /*
5217030796dfSdrh ** Count the number of references to columns.
5218030796dfSdrh */
5219030796dfSdrh static int exprSrcCount(Walker *pWalker, Expr *pExpr){
5220fb0a6081Sdrh   /* The NEVER() on the second term is because sqlite3FunctionUsesThisSrc()
5221fb0a6081Sdrh   ** is always called before sqlite3ExprAnalyzeAggregates() and so the
5222fb0a6081Sdrh   ** TK_COLUMNs have not yet been converted into TK_AGG_COLUMN.  If
5223fb0a6081Sdrh   ** sqlite3FunctionUsesThisSrc() is used differently in the future, the
5224fb0a6081Sdrh   ** NEVER() will need to be removed. */
5225fb0a6081Sdrh   if( pExpr->op==TK_COLUMN || NEVER(pExpr->op==TK_AGG_COLUMN) ){
5226374fdce4Sdrh     int i;
5227030796dfSdrh     struct SrcCount *p = pWalker->u.pSrcCount;
5228030796dfSdrh     SrcList *pSrc = p->pSrc;
5229655814d2Sdrh     int nSrc = pSrc ? pSrc->nSrc : 0;
5230655814d2Sdrh     for(i=0; i<nSrc; i++){
5231030796dfSdrh       if( pExpr->iTable==pSrc->a[i].iCursor ) break;
5232374fdce4Sdrh     }
5233655814d2Sdrh     if( i<nSrc ){
5234030796dfSdrh       p->nThis++;
5235374fdce4Sdrh     }else{
5236030796dfSdrh       p->nOther++;
5237374fdce4Sdrh     }
5238374fdce4Sdrh   }
5239030796dfSdrh   return WRC_Continue;
5240030796dfSdrh }
5241374fdce4Sdrh 
5242374fdce4Sdrh /*
5243030796dfSdrh ** Determine if any of the arguments to the pExpr Function reference
5244030796dfSdrh ** pSrcList.  Return true if they do.  Also return true if the function
5245030796dfSdrh ** has no arguments or has only constant arguments.  Return false if pExpr
5246030796dfSdrh ** references columns but not columns of tables found in pSrcList.
5247374fdce4Sdrh */
5248030796dfSdrh int sqlite3FunctionUsesThisSrc(Expr *pExpr, SrcList *pSrcList){
5249374fdce4Sdrh   Walker w;
5250030796dfSdrh   struct SrcCount cnt;
5251374fdce4Sdrh   assert( pExpr->op==TK_AGG_FUNCTION );
5252030796dfSdrh   w.xExprCallback = exprSrcCount;
5253979dd1beSdrh   w.xSelectCallback = 0;
5254030796dfSdrh   w.u.pSrcCount = &cnt;
5255030796dfSdrh   cnt.pSrc = pSrcList;
5256030796dfSdrh   cnt.nThis = 0;
5257030796dfSdrh   cnt.nOther = 0;
5258030796dfSdrh   sqlite3WalkExprList(&w, pExpr->x.pList);
5259030796dfSdrh   return cnt.nThis>0 || cnt.nOther==0;
5260374fdce4Sdrh }
5261374fdce4Sdrh 
5262374fdce4Sdrh /*
526313449892Sdrh ** Add a new element to the pAggInfo->aCol[] array.  Return the index of
526413449892Sdrh ** the new element.  Return a negative number if malloc fails.
52652282792aSdrh */
526617435752Sdrh static int addAggInfoColumn(sqlite3 *db, AggInfo *pInfo){
526713449892Sdrh   int i;
5268cf643729Sdrh   pInfo->aCol = sqlite3ArrayAllocate(
526917435752Sdrh        db,
5270cf643729Sdrh        pInfo->aCol,
5271cf643729Sdrh        sizeof(pInfo->aCol[0]),
5272cf643729Sdrh        &pInfo->nColumn,
5273cf643729Sdrh        &i
5274cf643729Sdrh   );
527513449892Sdrh   return i;
52762282792aSdrh }
527713449892Sdrh 
527813449892Sdrh /*
527913449892Sdrh ** Add a new element to the pAggInfo->aFunc[] array.  Return the index of
528013449892Sdrh ** the new element.  Return a negative number if malloc fails.
528113449892Sdrh */
528217435752Sdrh static int addAggInfoFunc(sqlite3 *db, AggInfo *pInfo){
528313449892Sdrh   int i;
5284cf643729Sdrh   pInfo->aFunc = sqlite3ArrayAllocate(
528517435752Sdrh        db,
5286cf643729Sdrh        pInfo->aFunc,
5287cf643729Sdrh        sizeof(pInfo->aFunc[0]),
5288cf643729Sdrh        &pInfo->nFunc,
5289cf643729Sdrh        &i
5290cf643729Sdrh   );
529113449892Sdrh   return i;
52922282792aSdrh }
52932282792aSdrh 
52942282792aSdrh /*
52957d10d5a6Sdrh ** This is the xExprCallback for a tree walker.  It is used to
52967d10d5a6Sdrh ** implement sqlite3ExprAnalyzeAggregates().  See sqlite3ExprAnalyzeAggregates
5297626a879aSdrh ** for additional information.
52982282792aSdrh */
52997d10d5a6Sdrh static int analyzeAggregate(Walker *pWalker, Expr *pExpr){
53002282792aSdrh   int i;
53017d10d5a6Sdrh   NameContext *pNC = pWalker->u.pNC;
5302a58fdfb1Sdanielk1977   Parse *pParse = pNC->pParse;
5303a58fdfb1Sdanielk1977   SrcList *pSrcList = pNC->pSrcList;
530425c3b8caSdrh   AggInfo *pAggInfo = pNC->uNC.pAggInfo;
530513449892Sdrh 
530625c3b8caSdrh   assert( pNC->ncFlags & NC_UAggInfo );
53072282792aSdrh   switch( pExpr->op ){
530889c69d00Sdrh     case TK_AGG_COLUMN:
5309967e8b73Sdrh     case TK_COLUMN: {
53108b213899Sdrh       testcase( pExpr->op==TK_AGG_COLUMN );
53118b213899Sdrh       testcase( pExpr->op==TK_COLUMN );
531213449892Sdrh       /* Check to see if the column is in one of the tables in the FROM
531313449892Sdrh       ** clause of the aggregate query */
531420bc393cSdrh       if( ALWAYS(pSrcList!=0) ){
531513449892Sdrh         struct SrcList_item *pItem = pSrcList->a;
531613449892Sdrh         for(i=0; i<pSrcList->nSrc; i++, pItem++){
531713449892Sdrh           struct AggInfo_col *pCol;
5318c5cd1249Sdrh           assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
531913449892Sdrh           if( pExpr->iTable==pItem->iCursor ){
532013449892Sdrh             /* If we reach this point, it means that pExpr refers to a table
532113449892Sdrh             ** that is in the FROM clause of the aggregate query.
532213449892Sdrh             **
532313449892Sdrh             ** Make an entry for the column in pAggInfo->aCol[] if there
532413449892Sdrh             ** is not an entry there already.
532513449892Sdrh             */
53267f906d63Sdrh             int k;
532713449892Sdrh             pCol = pAggInfo->aCol;
53287f906d63Sdrh             for(k=0; k<pAggInfo->nColumn; k++, pCol++){
532913449892Sdrh               if( pCol->iTable==pExpr->iTable &&
533013449892Sdrh                   pCol->iColumn==pExpr->iColumn ){
53312282792aSdrh                 break;
53322282792aSdrh               }
53332282792aSdrh             }
53341e536953Sdanielk1977             if( (k>=pAggInfo->nColumn)
53351e536953Sdanielk1977              && (k = addAggInfoColumn(pParse->db, pAggInfo))>=0
53361e536953Sdanielk1977             ){
53377f906d63Sdrh               pCol = &pAggInfo->aCol[k];
5338eda079cdSdrh               pCol->pTab = pExpr->y.pTab;
533913449892Sdrh               pCol->iTable = pExpr->iTable;
534013449892Sdrh               pCol->iColumn = pExpr->iColumn;
53410a07c107Sdrh               pCol->iMem = ++pParse->nMem;
534213449892Sdrh               pCol->iSorterColumn = -1;
53435774b806Sdrh               pCol->pExpr = pExpr;
534413449892Sdrh               if( pAggInfo->pGroupBy ){
534513449892Sdrh                 int j, n;
534613449892Sdrh                 ExprList *pGB = pAggInfo->pGroupBy;
534713449892Sdrh                 struct ExprList_item *pTerm = pGB->a;
534813449892Sdrh                 n = pGB->nExpr;
534913449892Sdrh                 for(j=0; j<n; j++, pTerm++){
535013449892Sdrh                   Expr *pE = pTerm->pExpr;
535113449892Sdrh                   if( pE->op==TK_COLUMN && pE->iTable==pExpr->iTable &&
535213449892Sdrh                       pE->iColumn==pExpr->iColumn ){
535313449892Sdrh                     pCol->iSorterColumn = j;
535413449892Sdrh                     break;
53552282792aSdrh                   }
535613449892Sdrh                 }
535713449892Sdrh               }
535813449892Sdrh               if( pCol->iSorterColumn<0 ){
535913449892Sdrh                 pCol->iSorterColumn = pAggInfo->nSortingColumn++;
536013449892Sdrh               }
536113449892Sdrh             }
536213449892Sdrh             /* There is now an entry for pExpr in pAggInfo->aCol[] (either
536313449892Sdrh             ** because it was there before or because we just created it).
536413449892Sdrh             ** Convert the pExpr to be a TK_AGG_COLUMN referring to that
536513449892Sdrh             ** pAggInfo->aCol[] entry.
536613449892Sdrh             */
5367ebb6a65dSdrh             ExprSetVVAProperty(pExpr, EP_NoReduce);
536813449892Sdrh             pExpr->pAggInfo = pAggInfo;
536913449892Sdrh             pExpr->op = TK_AGG_COLUMN;
5370cf697396Sshane             pExpr->iAgg = (i16)k;
537113449892Sdrh             break;
537213449892Sdrh           } /* endif pExpr->iTable==pItem->iCursor */
537313449892Sdrh         } /* end loop over pSrcList */
5374a58fdfb1Sdanielk1977       }
53757d10d5a6Sdrh       return WRC_Prune;
53762282792aSdrh     }
53772282792aSdrh     case TK_AGG_FUNCTION: {
53783a8c4be7Sdrh       if( (pNC->ncFlags & NC_InAggFunc)==0
5379ed551b95Sdrh        && pWalker->walkerDepth==pExpr->op2
53803a8c4be7Sdrh       ){
538113449892Sdrh         /* Check to see if pExpr is a duplicate of another aggregate
538213449892Sdrh         ** function that is already in the pAggInfo structure
538313449892Sdrh         */
538413449892Sdrh         struct AggInfo_func *pItem = pAggInfo->aFunc;
538513449892Sdrh         for(i=0; i<pAggInfo->nFunc; i++, pItem++){
53865aa550cfSdan           if( sqlite3ExprCompare(0, pItem->pExpr, pExpr, -1)==0 ){
53872282792aSdrh             break;
53882282792aSdrh           }
53892282792aSdrh         }
539013449892Sdrh         if( i>=pAggInfo->nFunc ){
539113449892Sdrh           /* pExpr is original.  Make a new entry in pAggInfo->aFunc[]
539213449892Sdrh           */
539314db2665Sdanielk1977           u8 enc = ENC(pParse->db);
53941e536953Sdanielk1977           i = addAggInfoFunc(pParse->db, pAggInfo);
539513449892Sdrh           if( i>=0 ){
53966ab3a2ecSdanielk1977             assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
539713449892Sdrh             pItem = &pAggInfo->aFunc[i];
539813449892Sdrh             pItem->pExpr = pExpr;
53990a07c107Sdrh             pItem->iMem = ++pParse->nMem;
540033e619fcSdrh             assert( !ExprHasProperty(pExpr, EP_IntValue) );
540113449892Sdrh             pItem->pFunc = sqlite3FindFunction(pParse->db,
540280738d9cSdrh                    pExpr->u.zToken,
54036ab3a2ecSdanielk1977                    pExpr->x.pList ? pExpr->x.pList->nExpr : 0, enc, 0);
5404fd357974Sdrh             if( pExpr->flags & EP_Distinct ){
5405fd357974Sdrh               pItem->iDistinct = pParse->nTab++;
5406fd357974Sdrh             }else{
5407fd357974Sdrh               pItem->iDistinct = -1;
5408fd357974Sdrh             }
54092282792aSdrh           }
541013449892Sdrh         }
541113449892Sdrh         /* Make pExpr point to the appropriate pAggInfo->aFunc[] entry
541213449892Sdrh         */
5413c5cd1249Sdrh         assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
5414ebb6a65dSdrh         ExprSetVVAProperty(pExpr, EP_NoReduce);
5415cf697396Sshane         pExpr->iAgg = (i16)i;
541613449892Sdrh         pExpr->pAggInfo = pAggInfo;
54173a8c4be7Sdrh         return WRC_Prune;
54186e83a57fSdrh       }else{
54196e83a57fSdrh         return WRC_Continue;
54206e83a57fSdrh       }
54212282792aSdrh     }
5422a58fdfb1Sdanielk1977   }
54237d10d5a6Sdrh   return WRC_Continue;
54247d10d5a6Sdrh }
54257d10d5a6Sdrh static int analyzeAggregatesInSelect(Walker *pWalker, Select *pSelect){
5426d5a336efSdrh   UNUSED_PARAMETER(pSelect);
5427979dd1beSdrh   pWalker->walkerDepth++;
54287d10d5a6Sdrh   return WRC_Continue;
5429a58fdfb1Sdanielk1977 }
5430979dd1beSdrh static void analyzeAggregatesInSelectEnd(Walker *pWalker, Select *pSelect){
5431979dd1beSdrh   UNUSED_PARAMETER(pSelect);
5432979dd1beSdrh   pWalker->walkerDepth--;
5433979dd1beSdrh }
5434626a879aSdrh 
5435626a879aSdrh /*
5436e8abb4caSdrh ** Analyze the pExpr expression looking for aggregate functions and
5437e8abb4caSdrh ** for variables that need to be added to AggInfo object that pNC->pAggInfo
5438e8abb4caSdrh ** points to.  Additional entries are made on the AggInfo object as
5439e8abb4caSdrh ** necessary.
5440626a879aSdrh **
5441626a879aSdrh ** This routine should only be called after the expression has been
54427d10d5a6Sdrh ** analyzed by sqlite3ResolveExprNames().
5443626a879aSdrh */
5444d2b3e23bSdrh void sqlite3ExprAnalyzeAggregates(NameContext *pNC, Expr *pExpr){
54457d10d5a6Sdrh   Walker w;
54467d10d5a6Sdrh   w.xExprCallback = analyzeAggregate;
54477d10d5a6Sdrh   w.xSelectCallback = analyzeAggregatesInSelect;
5448979dd1beSdrh   w.xSelectCallback2 = analyzeAggregatesInSelectEnd;
5449979dd1beSdrh   w.walkerDepth = 0;
54507d10d5a6Sdrh   w.u.pNC = pNC;
5451d9995031Sdan   w.pParse = 0;
545220bc393cSdrh   assert( pNC->pSrcList!=0 );
54537d10d5a6Sdrh   sqlite3WalkExpr(&w, pExpr);
54542282792aSdrh }
54555d9a4af9Sdrh 
54565d9a4af9Sdrh /*
54575d9a4af9Sdrh ** Call sqlite3ExprAnalyzeAggregates() for every expression in an
54585d9a4af9Sdrh ** expression list.  Return the number of errors.
54595d9a4af9Sdrh **
54605d9a4af9Sdrh ** If an error is found, the analysis is cut short.
54615d9a4af9Sdrh */
5462d2b3e23bSdrh void sqlite3ExprAnalyzeAggList(NameContext *pNC, ExprList *pList){
54635d9a4af9Sdrh   struct ExprList_item *pItem;
54645d9a4af9Sdrh   int i;
54655d9a4af9Sdrh   if( pList ){
5466d2b3e23bSdrh     for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
5467d2b3e23bSdrh       sqlite3ExprAnalyzeAggregates(pNC, pItem->pExpr);
54685d9a4af9Sdrh     }
54695d9a4af9Sdrh   }
54705d9a4af9Sdrh }
5471892d3179Sdrh 
5472892d3179Sdrh /*
5473ceea3321Sdrh ** Allocate a single new register for use to hold some intermediate result.
5474892d3179Sdrh */
5475892d3179Sdrh int sqlite3GetTempReg(Parse *pParse){
5476e55cbd72Sdrh   if( pParse->nTempReg==0 ){
5477892d3179Sdrh     return ++pParse->nMem;
5478892d3179Sdrh   }
54792f425f6bSdanielk1977   return pParse->aTempReg[--pParse->nTempReg];
5480892d3179Sdrh }
5481ceea3321Sdrh 
5482ceea3321Sdrh /*
5483ceea3321Sdrh ** Deallocate a register, making available for reuse for some other
5484ceea3321Sdrh ** purpose.
5485ceea3321Sdrh */
5486892d3179Sdrh void sqlite3ReleaseTempReg(Parse *pParse, int iReg){
54872dcef11bSdrh   if( iReg && pParse->nTempReg<ArraySize(pParse->aTempReg) ){
5488892d3179Sdrh     pParse->aTempReg[pParse->nTempReg++] = iReg;
5489892d3179Sdrh   }
5490892d3179Sdrh }
5491892d3179Sdrh 
5492892d3179Sdrh /*
5493ed24da4bSdrh ** Allocate or deallocate a block of nReg consecutive registers.
5494892d3179Sdrh */
5495892d3179Sdrh int sqlite3GetTempRange(Parse *pParse, int nReg){
5496e55cbd72Sdrh   int i, n;
5497ed24da4bSdrh   if( nReg==1 ) return sqlite3GetTempReg(pParse);
5498892d3179Sdrh   i = pParse->iRangeReg;
5499e55cbd72Sdrh   n = pParse->nRangeReg;
5500f49f3523Sdrh   if( nReg<=n ){
5501892d3179Sdrh     pParse->iRangeReg += nReg;
5502892d3179Sdrh     pParse->nRangeReg -= nReg;
5503892d3179Sdrh   }else{
5504892d3179Sdrh     i = pParse->nMem+1;
5505892d3179Sdrh     pParse->nMem += nReg;
5506892d3179Sdrh   }
5507892d3179Sdrh   return i;
5508892d3179Sdrh }
5509892d3179Sdrh void sqlite3ReleaseTempRange(Parse *pParse, int iReg, int nReg){
5510ed24da4bSdrh   if( nReg==1 ){
5511ed24da4bSdrh     sqlite3ReleaseTempReg(pParse, iReg);
5512ed24da4bSdrh     return;
5513ed24da4bSdrh   }
5514892d3179Sdrh   if( nReg>pParse->nRangeReg ){
5515892d3179Sdrh     pParse->nRangeReg = nReg;
5516892d3179Sdrh     pParse->iRangeReg = iReg;
5517892d3179Sdrh   }
5518892d3179Sdrh }
5519cdc69557Sdrh 
5520cdc69557Sdrh /*
5521cdc69557Sdrh ** Mark all temporary registers as being unavailable for reuse.
5522cdc69557Sdrh */
5523cdc69557Sdrh void sqlite3ClearTempRegCache(Parse *pParse){
5524cdc69557Sdrh   pParse->nTempReg = 0;
5525cdc69557Sdrh   pParse->nRangeReg = 0;
5526cdc69557Sdrh }
5527bb9b5f26Sdrh 
5528bb9b5f26Sdrh /*
5529bb9b5f26Sdrh ** Validate that no temporary register falls within the range of
5530bb9b5f26Sdrh ** iFirst..iLast, inclusive.  This routine is only call from within assert()
5531bb9b5f26Sdrh ** statements.
5532bb9b5f26Sdrh */
5533bb9b5f26Sdrh #ifdef SQLITE_DEBUG
5534bb9b5f26Sdrh int sqlite3NoTempsInRange(Parse *pParse, int iFirst, int iLast){
5535bb9b5f26Sdrh   int i;
5536bb9b5f26Sdrh   if( pParse->nRangeReg>0
55373963e584Sdrh    && pParse->iRangeReg+pParse->nRangeReg > iFirst
55383963e584Sdrh    && pParse->iRangeReg <= iLast
5539bb9b5f26Sdrh   ){
5540bb9b5f26Sdrh      return 0;
5541bb9b5f26Sdrh   }
5542bb9b5f26Sdrh   for(i=0; i<pParse->nTempReg; i++){
5543bb9b5f26Sdrh     if( pParse->aTempReg[i]>=iFirst && pParse->aTempReg[i]<=iLast ){
5544bb9b5f26Sdrh       return 0;
5545bb9b5f26Sdrh     }
5546bb9b5f26Sdrh   }
5547bb9b5f26Sdrh   return 1;
5548bb9b5f26Sdrh }
5549bb9b5f26Sdrh #endif /* SQLITE_DEBUG */
5550