xref: /sqlite-3.40.0/src/expr.c (revision 2e362f97)
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;
47580c8c18Sdrh   pExpr = sqlite3ExprSkipCollate(pExpr);
489bec6fb3Smistachkin   if( pExpr->flags & EP_Generic ) return 0;
49580c8c18Sdrh   op = pExpr->op;
50487e262fSdrh   if( op==TK_SELECT ){
516ab3a2ecSdanielk1977     assert( pExpr->flags&EP_xIsSelect );
526ab3a2ecSdanielk1977     return sqlite3ExprAffinity(pExpr->x.pSelect->pEList->a[0].pExpr);
53a37cdde0Sdanielk1977   }
54db45bd5eSdrh   if( op==TK_REGISTER ) op = pExpr->op2;
55487e262fSdrh #ifndef SQLITE_OMIT_CAST
56487e262fSdrh   if( op==TK_CAST ){
5733e619fcSdrh     assert( !ExprHasProperty(pExpr, EP_IntValue) );
58fdaac671Sdrh     return sqlite3AffinityType(pExpr->u.zToken, 0);
59487e262fSdrh   }
60487e262fSdrh #endif
61b8d29c2fSdan   if( (op==TK_AGG_COLUMN || op==TK_COLUMN) && pExpr->pTab ){
620dfa4f6fSdrh     return sqlite3TableColumnAffinity(pExpr->pTab, pExpr->iColumn);
637d10d5a6Sdrh   }
6480aa5453Sdan   if( op==TK_SELECT_COLUMN ){
6580aa5453Sdan     assert( pExpr->pLeft->flags&EP_xIsSelect );
6680aa5453Sdan     return sqlite3ExprAffinity(
6780aa5453Sdan         pExpr->pLeft->x.pSelect->pEList->a[pExpr->iColumn].pExpr
6880aa5453Sdan     );
6980aa5453Sdan   }
70a37cdde0Sdanielk1977   return pExpr->affinity;
71a37cdde0Sdanielk1977 }
72a37cdde0Sdanielk1977 
7353db1458Sdrh /*
748b4c40d8Sdrh ** Set the collating sequence for expression pExpr to be the collating
75ae80ddeaSdrh ** sequence named by pToken.   Return a pointer to a new Expr node that
76ae80ddeaSdrh ** implements the COLLATE operator.
770a8a406eSdrh **
780a8a406eSdrh ** If a memory allocation error occurs, that fact is recorded in pParse->db
790a8a406eSdrh ** and the pExpr parameter is returned unchanged.
808b4c40d8Sdrh */
814ef7efadSdrh Expr *sqlite3ExprAddCollateToken(
824ef7efadSdrh   Parse *pParse,           /* Parsing context */
834ef7efadSdrh   Expr *pExpr,             /* Add the "COLLATE" clause to this expression */
8480103fc6Sdan   const Token *pCollName,  /* Name of collating sequence */
8580103fc6Sdan   int dequote              /* True to dequote pCollName */
864ef7efadSdrh ){
870a8a406eSdrh   if( pCollName->n>0 ){
8880103fc6Sdan     Expr *pNew = sqlite3ExprAlloc(pParse->db, TK_COLLATE, pCollName, dequote);
89ae80ddeaSdrh     if( pNew ){
90ae80ddeaSdrh       pNew->pLeft = pExpr;
91a4c3c87eSdrh       pNew->flags |= EP_Collate|EP_Skip;
920a8a406eSdrh       pExpr = pNew;
93ae80ddeaSdrh     }
940a8a406eSdrh   }
950a8a406eSdrh   return pExpr;
960a8a406eSdrh }
970a8a406eSdrh Expr *sqlite3ExprAddCollateString(Parse *pParse, Expr *pExpr, const char *zC){
980a8a406eSdrh   Token s;
99261d8a51Sdrh   assert( zC!=0 );
10040aced5cSdrh   sqlite3TokenInit(&s, (char*)zC);
10180103fc6Sdan   return sqlite3ExprAddCollateToken(pParse, pExpr, &s, 0);
1020a8a406eSdrh }
1030a8a406eSdrh 
1040a8a406eSdrh /*
1050b8d255cSdrh ** Skip over any TK_COLLATE operators and any unlikely()
106a4c3c87eSdrh ** or likelihood() function at the root of an expression.
1070a8a406eSdrh */
1080a8a406eSdrh Expr *sqlite3ExprSkipCollate(Expr *pExpr){
109a4c3c87eSdrh   while( pExpr && ExprHasProperty(pExpr, EP_Skip) ){
110a4c3c87eSdrh     if( ExprHasProperty(pExpr, EP_Unlikely) ){
111cca9f3d2Sdrh       assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
112cca9f3d2Sdrh       assert( pExpr->x.pList->nExpr>0 );
113a4c3c87eSdrh       assert( pExpr->op==TK_FUNCTION );
114cca9f3d2Sdrh       pExpr = pExpr->x.pList->a[0].pExpr;
115cca9f3d2Sdrh     }else{
1160b8d255cSdrh       assert( pExpr->op==TK_COLLATE );
117d91eba96Sdrh       pExpr = pExpr->pLeft;
118cca9f3d2Sdrh     }
119d91eba96Sdrh   }
1200a8a406eSdrh   return pExpr;
1218b4c40d8Sdrh }
1228b4c40d8Sdrh 
1238b4c40d8Sdrh /*
124ae80ddeaSdrh ** Return the collation sequence for the expression pExpr. If
125ae80ddeaSdrh ** there is no defined collating sequence, return NULL.
126ae80ddeaSdrh **
12770efa84dSdrh ** See also: sqlite3ExprNNCollSeq()
12870efa84dSdrh **
12970efa84dSdrh ** The sqlite3ExprNNCollSeq() works the same exact that it returns the
13070efa84dSdrh ** default collation if pExpr has no defined collation.
13170efa84dSdrh **
132ae80ddeaSdrh ** The collating sequence might be determined by a COLLATE operator
133ae80ddeaSdrh ** or by the presence of a column with a defined collating sequence.
134ae80ddeaSdrh ** COLLATE operators take first precedence.  Left operands take
135ae80ddeaSdrh ** precedence over right operands.
1360202b29eSdanielk1977 */
1377cedc8d4Sdanielk1977 CollSeq *sqlite3ExprCollSeq(Parse *pParse, Expr *pExpr){
138ae80ddeaSdrh   sqlite3 *db = pParse->db;
1397cedc8d4Sdanielk1977   CollSeq *pColl = 0;
1407d10d5a6Sdrh   Expr *p = pExpr;
141261d8a51Sdrh   while( p ){
142ae80ddeaSdrh     int op = p->op;
143fbb24d10Sdrh     if( p->flags & EP_Generic ) break;
144ae80ddeaSdrh     if( op==TK_CAST || op==TK_UPLUS ){
145ae80ddeaSdrh       p = p->pLeft;
146ae80ddeaSdrh       continue;
147ae80ddeaSdrh     }
14836e78309Sdan     if( op==TK_COLLATE || (op==TK_REGISTER && p->op2==TK_COLLATE) ){
1497a66da13Sdrh       pColl = sqlite3GetCollSeq(pParse, ENC(db), 0, p->u.zToken);
150ae80ddeaSdrh       break;
151ae80ddeaSdrh     }
152a58d4a96Sdrh     if( (op==TK_AGG_COLUMN || op==TK_COLUMN
153ae80ddeaSdrh           || op==TK_REGISTER || op==TK_TRIGGER)
154a58d4a96Sdrh      && p->pTab!=0
155ae80ddeaSdrh     ){
1567d10d5a6Sdrh       /* op==TK_REGISTER && p->pTab!=0 happens when pExpr was originally
1577d10d5a6Sdrh       ** a TK_COLUMN but was previously evaluated and cached in a register */
1587d10d5a6Sdrh       int j = p->iColumn;
1597d10d5a6Sdrh       if( j>=0 ){
160ae80ddeaSdrh         const char *zColl = p->pTab->aCol[j].zColl;
161c4a64facSdrh         pColl = sqlite3FindCollSeq(db, ENC(db), zColl, 0);
1620202b29eSdanielk1977       }
1637d10d5a6Sdrh       break;
1647d10d5a6Sdrh     }
165ae80ddeaSdrh     if( p->flags & EP_Collate ){
1662308ed38Sdrh       if( p->pLeft && (p->pLeft->flags & EP_Collate)!=0 ){
1677d10d5a6Sdrh         p = p->pLeft;
168ae80ddeaSdrh       }else{
1692308ed38Sdrh         Expr *pNext  = p->pRight;
1706728cd91Sdrh         /* The Expr.x union is never used at the same time as Expr.pRight */
1716728cd91Sdrh         assert( p->x.pList==0 || p->pRight==0 );
1726728cd91Sdrh         /* p->flags holds EP_Collate and p->pLeft->flags does not.  And
1736728cd91Sdrh         ** p->x.pSelect cannot.  So if p->x.pLeft exists, it must hold at
1746728cd91Sdrh         ** least one EP_Collate. Thus the following two ALWAYS. */
1756728cd91Sdrh         if( p->x.pList!=0 && ALWAYS(!ExprHasProperty(p, EP_xIsSelect)) ){
1762308ed38Sdrh           int i;
1776728cd91Sdrh           for(i=0; ALWAYS(i<p->x.pList->nExpr); i++){
1782308ed38Sdrh             if( ExprHasProperty(p->x.pList->a[i].pExpr, EP_Collate) ){
1792308ed38Sdrh               pNext = p->x.pList->a[i].pExpr;
1802308ed38Sdrh               break;
1812308ed38Sdrh             }
1822308ed38Sdrh           }
1832308ed38Sdrh         }
1842308ed38Sdrh         p = pNext;
185ae80ddeaSdrh       }
186ae80ddeaSdrh     }else{
187ae80ddeaSdrh       break;
188ae80ddeaSdrh     }
1890202b29eSdanielk1977   }
1907cedc8d4Sdanielk1977   if( sqlite3CheckCollSeq(pParse, pColl) ){
1917cedc8d4Sdanielk1977     pColl = 0;
1927cedc8d4Sdanielk1977   }
1937cedc8d4Sdanielk1977   return pColl;
1940202b29eSdanielk1977 }
1950202b29eSdanielk1977 
1960202b29eSdanielk1977 /*
19770efa84dSdrh ** Return the collation sequence for the expression pExpr. If
19870efa84dSdrh ** there is no defined collating sequence, return a pointer to the
19970efa84dSdrh ** defautl collation sequence.
20070efa84dSdrh **
20170efa84dSdrh ** See also: sqlite3ExprCollSeq()
20270efa84dSdrh **
20370efa84dSdrh ** The sqlite3ExprCollSeq() routine works the same except that it
20470efa84dSdrh ** returns NULL if there is no defined collation.
20570efa84dSdrh */
20670efa84dSdrh CollSeq *sqlite3ExprNNCollSeq(Parse *pParse, Expr *pExpr){
20770efa84dSdrh   CollSeq *p = sqlite3ExprCollSeq(pParse, pExpr);
20870efa84dSdrh   if( p==0 ) p = pParse->db->pDfltColl;
20970efa84dSdrh   assert( p!=0 );
21070efa84dSdrh   return p;
21170efa84dSdrh }
21270efa84dSdrh 
21370efa84dSdrh /*
21470efa84dSdrh ** Return TRUE if the two expressions have equivalent collating sequences.
21570efa84dSdrh */
21670efa84dSdrh int sqlite3ExprCollSeqMatch(Parse *pParse, Expr *pE1, Expr *pE2){
21770efa84dSdrh   CollSeq *pColl1 = sqlite3ExprNNCollSeq(pParse, pE1);
21870efa84dSdrh   CollSeq *pColl2 = sqlite3ExprNNCollSeq(pParse, pE2);
21970efa84dSdrh   return sqlite3StrICmp(pColl1->zName, pColl2->zName)==0;
22070efa84dSdrh }
22170efa84dSdrh 
22270efa84dSdrh /*
223626a879aSdrh ** pExpr is an operand of a comparison operator.  aff2 is the
224626a879aSdrh ** type affinity of the other operand.  This routine returns the
22553db1458Sdrh ** type affinity that should be used for the comparison operator.
22653db1458Sdrh */
227e014a838Sdanielk1977 char sqlite3CompareAffinity(Expr *pExpr, char aff2){
228bf3b721fSdanielk1977   char aff1 = sqlite3ExprAffinity(pExpr);
229e014a838Sdanielk1977   if( aff1 && aff2 ){
2308df447f0Sdrh     /* Both sides of the comparison are columns. If one has numeric
2318df447f0Sdrh     ** affinity, use that. Otherwise use no affinity.
232e014a838Sdanielk1977     */
2338a51256cSdrh     if( sqlite3IsNumericAffinity(aff1) || sqlite3IsNumericAffinity(aff2) ){
234e014a838Sdanielk1977       return SQLITE_AFF_NUMERIC;
235e014a838Sdanielk1977     }else{
23605883a34Sdrh       return SQLITE_AFF_BLOB;
237e014a838Sdanielk1977     }
238e014a838Sdanielk1977   }else if( !aff1 && !aff2 ){
2395f6a87b3Sdrh     /* Neither side of the comparison is a column.  Compare the
2405f6a87b3Sdrh     ** results directly.
241e014a838Sdanielk1977     */
24205883a34Sdrh     return SQLITE_AFF_BLOB;
243e014a838Sdanielk1977   }else{
244e014a838Sdanielk1977     /* One side is a column, the other is not. Use the columns affinity. */
245fe05af87Sdrh     assert( aff1==0 || aff2==0 );
246e014a838Sdanielk1977     return (aff1 + aff2);
247e014a838Sdanielk1977   }
248e014a838Sdanielk1977 }
249e014a838Sdanielk1977 
25053db1458Sdrh /*
25153db1458Sdrh ** pExpr is a comparison operator.  Return the type affinity that should
25253db1458Sdrh ** be applied to both operands prior to doing the comparison.
25353db1458Sdrh */
254e014a838Sdanielk1977 static char comparisonAffinity(Expr *pExpr){
255e014a838Sdanielk1977   char aff;
256e014a838Sdanielk1977   assert( pExpr->op==TK_EQ || pExpr->op==TK_IN || pExpr->op==TK_LT ||
257e014a838Sdanielk1977           pExpr->op==TK_GT || pExpr->op==TK_GE || pExpr->op==TK_LE ||
2586a2fe093Sdrh           pExpr->op==TK_NE || pExpr->op==TK_IS || pExpr->op==TK_ISNOT );
259e014a838Sdanielk1977   assert( pExpr->pLeft );
260bf3b721fSdanielk1977   aff = sqlite3ExprAffinity(pExpr->pLeft);
261e014a838Sdanielk1977   if( pExpr->pRight ){
262e014a838Sdanielk1977     aff = sqlite3CompareAffinity(pExpr->pRight, aff);
2636ab3a2ecSdanielk1977   }else if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2646ab3a2ecSdanielk1977     aff = sqlite3CompareAffinity(pExpr->x.pSelect->pEList->a[0].pExpr, aff);
26513ac46eeSdrh   }else if( aff==0 ){
26605883a34Sdrh     aff = SQLITE_AFF_BLOB;
267e014a838Sdanielk1977   }
268e014a838Sdanielk1977   return aff;
269e014a838Sdanielk1977 }
270e014a838Sdanielk1977 
271e014a838Sdanielk1977 /*
272e014a838Sdanielk1977 ** pExpr is a comparison expression, eg. '=', '<', IN(...) etc.
273e014a838Sdanielk1977 ** idx_affinity is the affinity of an indexed column. Return true
274e014a838Sdanielk1977 ** if the index with affinity idx_affinity may be used to implement
275e014a838Sdanielk1977 ** the comparison in pExpr.
276e014a838Sdanielk1977 */
277e014a838Sdanielk1977 int sqlite3IndexAffinityOk(Expr *pExpr, char idx_affinity){
278e014a838Sdanielk1977   char aff = comparisonAffinity(pExpr);
2798a51256cSdrh   switch( aff ){
28005883a34Sdrh     case SQLITE_AFF_BLOB:
2818a51256cSdrh       return 1;
2828a51256cSdrh     case SQLITE_AFF_TEXT:
2838a51256cSdrh       return idx_affinity==SQLITE_AFF_TEXT;
2848a51256cSdrh     default:
2858a51256cSdrh       return sqlite3IsNumericAffinity(idx_affinity);
2868a51256cSdrh   }
287e014a838Sdanielk1977 }
288e014a838Sdanielk1977 
289a37cdde0Sdanielk1977 /*
29035573356Sdrh ** Return the P5 value that should be used for a binary comparison
291a37cdde0Sdanielk1977 ** opcode (OP_Eq, OP_Ge etc.) used to compare pExpr1 and pExpr2.
292a37cdde0Sdanielk1977 */
29335573356Sdrh static u8 binaryCompareP5(Expr *pExpr1, Expr *pExpr2, int jumpIfNull){
29435573356Sdrh   u8 aff = (char)sqlite3ExprAffinity(pExpr2);
2951bd10f8aSdrh   aff = (u8)sqlite3CompareAffinity(pExpr1, aff) | (u8)jumpIfNull;
29635573356Sdrh   return aff;
297a37cdde0Sdanielk1977 }
298a37cdde0Sdanielk1977 
299a2e00042Sdrh /*
3000202b29eSdanielk1977 ** Return a pointer to the collation sequence that should be used by
3010202b29eSdanielk1977 ** a binary comparison operator comparing pLeft and pRight.
3020202b29eSdanielk1977 **
3030202b29eSdanielk1977 ** If the left hand expression has a collating sequence type, then it is
3040202b29eSdanielk1977 ** used. Otherwise the collation sequence for the right hand expression
3050202b29eSdanielk1977 ** is used, or the default (BINARY) if neither expression has a collating
3060202b29eSdanielk1977 ** type.
307bcbb04e5Sdanielk1977 **
308bcbb04e5Sdanielk1977 ** Argument pRight (but not pLeft) may be a null pointer. In this case,
309bcbb04e5Sdanielk1977 ** it is not considered.
3100202b29eSdanielk1977 */
311bcbb04e5Sdanielk1977 CollSeq *sqlite3BinaryCompareCollSeq(
312bcbb04e5Sdanielk1977   Parse *pParse,
313bcbb04e5Sdanielk1977   Expr *pLeft,
314bcbb04e5Sdanielk1977   Expr *pRight
315bcbb04e5Sdanielk1977 ){
316ec41ddacSdrh   CollSeq *pColl;
317ec41ddacSdrh   assert( pLeft );
318ae80ddeaSdrh   if( pLeft->flags & EP_Collate ){
319ae80ddeaSdrh     pColl = sqlite3ExprCollSeq(pParse, pLeft);
320ae80ddeaSdrh   }else if( pRight && (pRight->flags & EP_Collate)!=0 ){
321ae80ddeaSdrh     pColl = sqlite3ExprCollSeq(pParse, pRight);
322ec41ddacSdrh   }else{
323ec41ddacSdrh     pColl = sqlite3ExprCollSeq(pParse, pLeft);
3240202b29eSdanielk1977     if( !pColl ){
3257cedc8d4Sdanielk1977       pColl = sqlite3ExprCollSeq(pParse, pRight);
3260202b29eSdanielk1977     }
327ec41ddacSdrh   }
3280202b29eSdanielk1977   return pColl;
3290202b29eSdanielk1977 }
3300202b29eSdanielk1977 
3310202b29eSdanielk1977 /*
332be5c89acSdrh ** Generate code for a comparison operator.
333be5c89acSdrh */
334be5c89acSdrh static int codeCompare(
335be5c89acSdrh   Parse *pParse,    /* The parsing (and code generating) context */
336be5c89acSdrh   Expr *pLeft,      /* The left operand */
337be5c89acSdrh   Expr *pRight,     /* The right operand */
338be5c89acSdrh   int opcode,       /* The comparison opcode */
33935573356Sdrh   int in1, int in2, /* Register holding operands */
340be5c89acSdrh   int dest,         /* Jump here if true.  */
341be5c89acSdrh   int jumpIfNull    /* If true, jump if either operand is NULL */
342be5c89acSdrh ){
34335573356Sdrh   int p5;
34435573356Sdrh   int addr;
34535573356Sdrh   CollSeq *p4;
34635573356Sdrh 
34735573356Sdrh   p4 = sqlite3BinaryCompareCollSeq(pParse, pLeft, pRight);
34835573356Sdrh   p5 = binaryCompareP5(pLeft, pRight, jumpIfNull);
34935573356Sdrh   addr = sqlite3VdbeAddOp4(pParse->pVdbe, opcode, in2, dest, in1,
35035573356Sdrh                            (void*)p4, P4_COLLSEQ);
3511bd10f8aSdrh   sqlite3VdbeChangeP5(pParse->pVdbe, (u8)p5);
35235573356Sdrh   return addr;
353be5c89acSdrh }
354be5c89acSdrh 
355cfbb5e82Sdan /*
356870a0705Sdan ** Return true if expression pExpr is a vector, or false otherwise.
357d832da7fSdrh **
358d832da7fSdrh ** A vector is defined as any expression that results in two or more
359d832da7fSdrh ** columns of result.  Every TK_VECTOR node is an vector because the
360d832da7fSdrh ** parser will not generate a TK_VECTOR with fewer than two entries.
361d832da7fSdrh ** But a TK_SELECT might be either a vector or a scalar. It is only
362d832da7fSdrh ** considered a vector if it has two or more result columns.
363870a0705Sdan */
364870a0705Sdan int sqlite3ExprIsVector(Expr *pExpr){
36576dbe7a8Sdrh   return sqlite3ExprVectorSize(pExpr)>1;
366870a0705Sdan }
367870a0705Sdan 
368870a0705Sdan /*
369cfbb5e82Sdan ** If the expression passed as the only argument is of type TK_VECTOR
370cfbb5e82Sdan ** return the number of expressions in the vector. Or, if the expression
371cfbb5e82Sdan ** is a sub-select, return the number of columns in the sub-select. For
372cfbb5e82Sdan ** any other type of expression, return 1.
373cfbb5e82Sdan */
37471c57db0Sdan int sqlite3ExprVectorSize(Expr *pExpr){
37512abf408Sdrh   u8 op = pExpr->op;
37612abf408Sdrh   if( op==TK_REGISTER ) op = pExpr->op2;
37712abf408Sdrh   if( op==TK_VECTOR ){
37871c57db0Sdan     return pExpr->x.pList->nExpr;
37912abf408Sdrh   }else if( op==TK_SELECT ){
38076dbe7a8Sdrh     return pExpr->x.pSelect->pEList->nExpr;
38176dbe7a8Sdrh   }else{
38276dbe7a8Sdrh     return 1;
38376dbe7a8Sdrh   }
38471c57db0Sdan }
38571c57db0Sdan 
386ba00e30aSdan /*
387fc7f27b9Sdrh ** Return a pointer to a subexpression of pVector that is the i-th
388fc7f27b9Sdrh ** column of the vector (numbered starting with 0).  The caller must
389fc7f27b9Sdrh ** ensure that i is within range.
390fc7f27b9Sdrh **
39176dbe7a8Sdrh ** If pVector is really a scalar (and "scalar" here includes subqueries
39276dbe7a8Sdrh ** that return a single column!) then return pVector unmodified.
39376dbe7a8Sdrh **
394fc7f27b9Sdrh ** pVector retains ownership of the returned subexpression.
395fc7f27b9Sdrh **
396fc7f27b9Sdrh ** If the vector is a (SELECT ...) then the expression returned is
39776dbe7a8Sdrh ** just the expression for the i-th term of the result set, and may
39876dbe7a8Sdrh ** not be ready for evaluation because the table cursor has not yet
39976dbe7a8Sdrh ** been positioned.
400ba00e30aSdan */
401fc7f27b9Sdrh Expr *sqlite3VectorFieldSubexpr(Expr *pVector, int i){
402870a0705Sdan   assert( i<sqlite3ExprVectorSize(pVector) );
403870a0705Sdan   if( sqlite3ExprIsVector(pVector) ){
4049f24b53dSdrh     assert( pVector->op2==0 || pVector->op==TK_REGISTER );
4059f24b53dSdrh     if( pVector->op==TK_SELECT || pVector->op2==TK_SELECT ){
40671c57db0Sdan       return pVector->x.pSelect->pEList->a[i].pExpr;
407870a0705Sdan     }else{
40871c57db0Sdan       return pVector->x.pList->a[i].pExpr;
40971c57db0Sdan     }
410870a0705Sdan   }
411870a0705Sdan   return pVector;
412870a0705Sdan }
413fc7f27b9Sdrh 
414fc7f27b9Sdrh /*
415fc7f27b9Sdrh ** Compute and return a new Expr object which when passed to
416fc7f27b9Sdrh ** sqlite3ExprCode() will generate all necessary code to compute
417fc7f27b9Sdrh ** the iField-th column of the vector expression pVector.
418fc7f27b9Sdrh **
4198762ec19Sdrh ** It is ok for pVector to be a scalar (as long as iField==0).
4208762ec19Sdrh ** In that case, this routine works like sqlite3ExprDup().
4218762ec19Sdrh **
422fc7f27b9Sdrh ** The caller owns the returned Expr object and is responsible for
423fc7f27b9Sdrh ** ensuring that the returned value eventually gets freed.
424fc7f27b9Sdrh **
4258762ec19Sdrh ** The caller retains ownership of pVector.  If pVector is a TK_SELECT,
426fad0e70cSdan ** then the returned object will reference pVector and so pVector must remain
4278762ec19Sdrh ** valid for the life of the returned object.  If pVector is a TK_VECTOR
4288762ec19Sdrh ** or a scalar expression, then it can be deleted as soon as this routine
42976dbe7a8Sdrh ** returns.
4308762ec19Sdrh **
4318762ec19Sdrh ** A trick to cause a TK_SELECT pVector to be deleted together with
4328762ec19Sdrh ** the returned Expr object is to attach the pVector to the pRight field
4338762ec19Sdrh ** of the returned TK_SELECT_COLUMN Expr object.
434fc7f27b9Sdrh */
435fc7f27b9Sdrh Expr *sqlite3ExprForVectorField(
436fc7f27b9Sdrh   Parse *pParse,       /* Parsing context */
437fc7f27b9Sdrh   Expr *pVector,       /* The vector.  List of expressions or a sub-SELECT */
438a1251bc4Sdrh   int iField           /* Which column of the vector to return */
439fc7f27b9Sdrh ){
440fc7f27b9Sdrh   Expr *pRet;
441a1251bc4Sdrh   if( pVector->op==TK_SELECT ){
442a1251bc4Sdrh     assert( pVector->flags & EP_xIsSelect );
443fc7f27b9Sdrh     /* The TK_SELECT_COLUMN Expr node:
444fc7f27b9Sdrh     **
445966e2911Sdrh     ** pLeft:           pVector containing TK_SELECT.  Not deleted.
4468762ec19Sdrh     ** pRight:          not used.  But recursively deleted.
447fc7f27b9Sdrh     ** iColumn:         Index of a column in pVector
448966e2911Sdrh     ** iTable:          0 or the number of columns on the LHS of an assignment
449fc7f27b9Sdrh     ** pLeft->iTable:   First in an array of register holding result, or 0
450fc7f27b9Sdrh     **                  if the result is not yet computed.
451fc7f27b9Sdrh     **
452fc7f27b9Sdrh     ** sqlite3ExprDelete() specifically skips the recursive delete of
453fc7f27b9Sdrh     ** pLeft on TK_SELECT_COLUMN nodes.  But pRight is followed, so pVector
4548762ec19Sdrh     ** can be attached to pRight to cause this node to take ownership of
4558762ec19Sdrh     ** pVector.  Typically there will be multiple TK_SELECT_COLUMN nodes
4568762ec19Sdrh     ** with the same pLeft pointer to the pVector, but only one of them
4578762ec19Sdrh     ** will own the pVector.
458fc7f27b9Sdrh     */
459abfd35eaSdrh     pRet = sqlite3PExpr(pParse, TK_SELECT_COLUMN, 0, 0);
4608bd0d58eSdrh     if( pRet ){
4618bd0d58eSdrh       pRet->iColumn = iField;
4628bd0d58eSdrh       pRet->pLeft = pVector;
4638bd0d58eSdrh     }
464fc7f27b9Sdrh     assert( pRet==0 || pRet->iTable==0 );
465fc7f27b9Sdrh   }else{
466a1251bc4Sdrh     if( pVector->op==TK_VECTOR ) pVector = pVector->x.pList->a[iField].pExpr;
467a1251bc4Sdrh     pRet = sqlite3ExprDup(pParse->db, pVector, 0);
468fc7f27b9Sdrh   }
469fc7f27b9Sdrh   return pRet;
470fc7f27b9Sdrh }
47171c57db0Sdan 
4725c288b92Sdan /*
4735c288b92Sdan ** If expression pExpr is of type TK_SELECT, generate code to evaluate
4745c288b92Sdan ** it. Return the register in which the result is stored (or, if the
4755c288b92Sdan ** sub-select returns more than one column, the first in an array
4765c288b92Sdan ** of registers in which the result is stored).
4775c288b92Sdan **
4785c288b92Sdan ** If pExpr is not a TK_SELECT expression, return 0.
4795c288b92Sdan */
4805c288b92Sdan static int exprCodeSubselect(Parse *pParse, Expr *pExpr){
4818da209b1Sdan   int reg = 0;
482f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
4835c288b92Sdan   if( pExpr->op==TK_SELECT ){
4848da209b1Sdan     reg = sqlite3CodeSubselect(pParse, pExpr, 0, 0);
4858da209b1Sdan   }
486f9b2e05cSdan #endif
4878da209b1Sdan   return reg;
4888da209b1Sdan }
4898da209b1Sdan 
4905c288b92Sdan /*
4915c288b92Sdan ** Argument pVector points to a vector expression - either a TK_VECTOR
492870a0705Sdan ** or TK_SELECT that returns more than one column. This function returns
493870a0705Sdan ** the register number of a register that contains the value of
494870a0705Sdan ** element iField of the vector.
495870a0705Sdan **
496870a0705Sdan ** If pVector is a TK_SELECT expression, then code for it must have
497870a0705Sdan ** already been generated using the exprCodeSubselect() routine. In this
498870a0705Sdan ** case parameter regSelect should be the first in an array of registers
499870a0705Sdan ** containing the results of the sub-select.
500870a0705Sdan **
501870a0705Sdan ** If pVector is of type TK_VECTOR, then code for the requested field
502870a0705Sdan ** is generated. In this case (*pRegFree) may be set to the number of
503870a0705Sdan ** a temporary register to be freed by the caller before returning.
5045c288b92Sdan **
5055c288b92Sdan ** Before returning, output parameter (*ppExpr) is set to point to the
5065c288b92Sdan ** Expr object corresponding to element iElem of the vector.
5075c288b92Sdan */
5085c288b92Sdan static int exprVectorRegister(
5095c288b92Sdan   Parse *pParse,                  /* Parse context */
5105c288b92Sdan   Expr *pVector,                  /* Vector to extract element from */
511870a0705Sdan   int iField,                     /* Field to extract from pVector */
5125c288b92Sdan   int regSelect,                  /* First in array of registers */
5135c288b92Sdan   Expr **ppExpr,                  /* OUT: Expression element */
5145c288b92Sdan   int *pRegFree                   /* OUT: Temp register to free */
5155c288b92Sdan ){
51612abf408Sdrh   u8 op = pVector->op;
517c1bcd9ccSdrh   assert( op==TK_VECTOR || op==TK_REGISTER || op==TK_SELECT );
51812abf408Sdrh   if( op==TK_REGISTER ){
51912abf408Sdrh     *ppExpr = sqlite3VectorFieldSubexpr(pVector, iField);
52012abf408Sdrh     return pVector->iTable+iField;
52112abf408Sdrh   }
52212abf408Sdrh   if( op==TK_SELECT ){
523870a0705Sdan     *ppExpr = pVector->x.pSelect->pEList->a[iField].pExpr;
524870a0705Sdan      return regSelect+iField;
5255c288b92Sdan   }
526870a0705Sdan   *ppExpr = pVector->x.pList->a[iField].pExpr;
5275c288b92Sdan   return sqlite3ExprCodeTemp(pParse, *ppExpr, pRegFree);
5285c288b92Sdan }
5295c288b92Sdan 
5305c288b92Sdan /*
5315c288b92Sdan ** Expression pExpr is a comparison between two vector values. Compute
53279752b6eSdrh ** the result of the comparison (1, 0, or NULL) and write that
53379752b6eSdrh ** result into register dest.
53479752b6eSdrh **
53579752b6eSdrh ** The caller must satisfy the following preconditions:
53679752b6eSdrh **
53779752b6eSdrh **    if pExpr->op==TK_IS:      op==TK_EQ and p5==SQLITE_NULLEQ
53879752b6eSdrh **    if pExpr->op==TK_ISNOT:   op==TK_NE and p5==SQLITE_NULLEQ
53979752b6eSdrh **    otherwise:                op==pExpr->op and p5==0
5405c288b92Sdan */
54179752b6eSdrh static void codeVectorCompare(
54279752b6eSdrh   Parse *pParse,        /* Code generator context */
54379752b6eSdrh   Expr *pExpr,          /* The comparison operation */
54479752b6eSdrh   int dest,             /* Write results into this register */
54579752b6eSdrh   u8 op,                /* Comparison operator */
54679752b6eSdrh   u8 p5                 /* SQLITE_NULLEQ or zero */
54779752b6eSdrh ){
54871c57db0Sdan   Vdbe *v = pParse->pVdbe;
54971c57db0Sdan   Expr *pLeft = pExpr->pLeft;
55071c57db0Sdan   Expr *pRight = pExpr->pRight;
55171c57db0Sdan   int nLeft = sqlite3ExprVectorSize(pLeft);
55271c57db0Sdan   int i;
55371c57db0Sdan   int regLeft = 0;
55471c57db0Sdan   int regRight = 0;
55579752b6eSdrh   u8 opx = op;
55679752b6eSdrh   int addrDone = sqlite3VdbeMakeLabel(v);
55771c57db0Sdan 
558245ce62eSdrh   if( nLeft!=sqlite3ExprVectorSize(pRight) ){
559245ce62eSdrh     sqlite3ErrorMsg(pParse, "row value misused");
560245ce62eSdrh     return;
561245ce62eSdrh   }
56271c57db0Sdan   assert( pExpr->op==TK_EQ || pExpr->op==TK_NE
56371c57db0Sdan        || pExpr->op==TK_IS || pExpr->op==TK_ISNOT
56471c57db0Sdan        || pExpr->op==TK_LT || pExpr->op==TK_GT
56571c57db0Sdan        || pExpr->op==TK_LE || pExpr->op==TK_GE
56671c57db0Sdan   );
56779752b6eSdrh   assert( pExpr->op==op || (pExpr->op==TK_IS && op==TK_EQ)
56879752b6eSdrh             || (pExpr->op==TK_ISNOT && op==TK_NE) );
56979752b6eSdrh   assert( p5==0 || pExpr->op!=op );
57079752b6eSdrh   assert( p5==SQLITE_NULLEQ || pExpr->op==op );
57171c57db0Sdan 
57279752b6eSdrh   p5 |= SQLITE_STOREP2;
57379752b6eSdrh   if( opx==TK_LE ) opx = TK_LT;
57479752b6eSdrh   if( opx==TK_GE ) opx = TK_GT;
5755c288b92Sdan 
5765c288b92Sdan   regLeft = exprCodeSubselect(pParse, pLeft);
5775c288b92Sdan   regRight = exprCodeSubselect(pParse, pRight);
5785c288b92Sdan 
579321e828dSdrh   for(i=0; 1 /*Loop exits by "break"*/; i++){
5805c288b92Sdan     int regFree1 = 0, regFree2 = 0;
5815c288b92Sdan     Expr *pL, *pR;
5825c288b92Sdan     int r1, r2;
583321e828dSdrh     assert( i>=0 && i<nLeft );
58479752b6eSdrh     if( i>0 ) sqlite3ExprCachePush(pParse);
5855c288b92Sdan     r1 = exprVectorRegister(pParse, pLeft, i, regLeft, &pL, &regFree1);
5865c288b92Sdan     r2 = exprVectorRegister(pParse, pRight, i, regRight, &pR, &regFree2);
58779752b6eSdrh     codeCompare(pParse, pL, pR, opx, r1, r2, dest, p5);
58879752b6eSdrh     testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
58979752b6eSdrh     testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
59079752b6eSdrh     testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
59179752b6eSdrh     testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
59279752b6eSdrh     testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
59379752b6eSdrh     testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
59471c57db0Sdan     sqlite3ReleaseTempReg(pParse, regFree1);
59571c57db0Sdan     sqlite3ReleaseTempReg(pParse, regFree2);
59679752b6eSdrh     if( i>0 ) sqlite3ExprCachePop(pParse);
59779752b6eSdrh     if( i==nLeft-1 ){
59879752b6eSdrh       break;
59971c57db0Sdan     }
60079752b6eSdrh     if( opx==TK_EQ ){
60179752b6eSdrh       sqlite3VdbeAddOp2(v, OP_IfNot, dest, addrDone); VdbeCoverage(v);
60279752b6eSdrh       p5 |= SQLITE_KEEPNULL;
60379752b6eSdrh     }else if( opx==TK_NE ){
60479752b6eSdrh       sqlite3VdbeAddOp2(v, OP_If, dest, addrDone); VdbeCoverage(v);
60579752b6eSdrh       p5 |= SQLITE_KEEPNULL;
606a2f62925Sdrh     }else{
607a2f62925Sdrh       assert( op==TK_LT || op==TK_GT || op==TK_LE || op==TK_GE );
608a2f62925Sdrh       sqlite3VdbeAddOp2(v, OP_ElseNotEq, 0, addrDone);
60979752b6eSdrh       VdbeCoverageIf(v, op==TK_LT);
61079752b6eSdrh       VdbeCoverageIf(v, op==TK_GT);
61179752b6eSdrh       VdbeCoverageIf(v, op==TK_LE);
61279752b6eSdrh       VdbeCoverageIf(v, op==TK_GE);
61379752b6eSdrh       if( i==nLeft-2 ) opx = op;
61471c57db0Sdan     }
61579752b6eSdrh   }
61679752b6eSdrh   sqlite3VdbeResolveLabel(v, addrDone);
61779752b6eSdrh }
61871c57db0Sdan 
6194b5255acSdanielk1977 #if SQLITE_MAX_EXPR_DEPTH>0
6204b5255acSdanielk1977 /*
6214b5255acSdanielk1977 ** Check that argument nHeight is less than or equal to the maximum
6224b5255acSdanielk1977 ** expression depth allowed. If it is not, leave an error message in
6234b5255acSdanielk1977 ** pParse.
6244b5255acSdanielk1977 */
6257d10d5a6Sdrh int sqlite3ExprCheckHeight(Parse *pParse, int nHeight){
6264b5255acSdanielk1977   int rc = SQLITE_OK;
6274b5255acSdanielk1977   int mxHeight = pParse->db->aLimit[SQLITE_LIMIT_EXPR_DEPTH];
6284b5255acSdanielk1977   if( nHeight>mxHeight ){
6294b5255acSdanielk1977     sqlite3ErrorMsg(pParse,
6304b5255acSdanielk1977        "Expression tree is too large (maximum depth %d)", mxHeight
6314b5255acSdanielk1977     );
6324b5255acSdanielk1977     rc = SQLITE_ERROR;
6334b5255acSdanielk1977   }
6344b5255acSdanielk1977   return rc;
6354b5255acSdanielk1977 }
6364b5255acSdanielk1977 
6374b5255acSdanielk1977 /* The following three functions, heightOfExpr(), heightOfExprList()
6384b5255acSdanielk1977 ** and heightOfSelect(), are used to determine the maximum height
6394b5255acSdanielk1977 ** of any expression tree referenced by the structure passed as the
6404b5255acSdanielk1977 ** first argument.
6414b5255acSdanielk1977 **
6424b5255acSdanielk1977 ** If this maximum height is greater than the current value pointed
6434b5255acSdanielk1977 ** to by pnHeight, the second parameter, then set *pnHeight to that
6444b5255acSdanielk1977 ** value.
6454b5255acSdanielk1977 */
6464b5255acSdanielk1977 static void heightOfExpr(Expr *p, int *pnHeight){
6474b5255acSdanielk1977   if( p ){
6484b5255acSdanielk1977     if( p->nHeight>*pnHeight ){
6494b5255acSdanielk1977       *pnHeight = p->nHeight;
6504b5255acSdanielk1977     }
6514b5255acSdanielk1977   }
6524b5255acSdanielk1977 }
6534b5255acSdanielk1977 static void heightOfExprList(ExprList *p, int *pnHeight){
6544b5255acSdanielk1977   if( p ){
6554b5255acSdanielk1977     int i;
6564b5255acSdanielk1977     for(i=0; i<p->nExpr; i++){
6574b5255acSdanielk1977       heightOfExpr(p->a[i].pExpr, pnHeight);
6584b5255acSdanielk1977     }
6594b5255acSdanielk1977   }
6604b5255acSdanielk1977 }
6611a3a3086Sdan static void heightOfSelect(Select *pSelect, int *pnHeight){
6621a3a3086Sdan   Select *p;
6631a3a3086Sdan   for(p=pSelect; p; p=p->pPrior){
6644b5255acSdanielk1977     heightOfExpr(p->pWhere, pnHeight);
6654b5255acSdanielk1977     heightOfExpr(p->pHaving, pnHeight);
6664b5255acSdanielk1977     heightOfExpr(p->pLimit, pnHeight);
6674b5255acSdanielk1977     heightOfExprList(p->pEList, pnHeight);
6684b5255acSdanielk1977     heightOfExprList(p->pGroupBy, pnHeight);
6694b5255acSdanielk1977     heightOfExprList(p->pOrderBy, pnHeight);
6704b5255acSdanielk1977   }
6714b5255acSdanielk1977 }
6724b5255acSdanielk1977 
6734b5255acSdanielk1977 /*
6744b5255acSdanielk1977 ** Set the Expr.nHeight variable in the structure passed as an
6754b5255acSdanielk1977 ** argument. An expression with no children, Expr.pList or
6764b5255acSdanielk1977 ** Expr.pSelect member has a height of 1. Any other expression
6774b5255acSdanielk1977 ** has a height equal to the maximum height of any other
6784b5255acSdanielk1977 ** referenced Expr plus one.
6792308ed38Sdrh **
6802308ed38Sdrh ** Also propagate EP_Propagate flags up from Expr.x.pList to Expr.flags,
6812308ed38Sdrh ** if appropriate.
6824b5255acSdanielk1977 */
6834b5255acSdanielk1977 static void exprSetHeight(Expr *p){
6844b5255acSdanielk1977   int nHeight = 0;
6854b5255acSdanielk1977   heightOfExpr(p->pLeft, &nHeight);
6864b5255acSdanielk1977   heightOfExpr(p->pRight, &nHeight);
6876ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_xIsSelect) ){
6886ab3a2ecSdanielk1977     heightOfSelect(p->x.pSelect, &nHeight);
6892308ed38Sdrh   }else if( p->x.pList ){
6906ab3a2ecSdanielk1977     heightOfExprList(p->x.pList, &nHeight);
6912308ed38Sdrh     p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
6926ab3a2ecSdanielk1977   }
6934b5255acSdanielk1977   p->nHeight = nHeight + 1;
6944b5255acSdanielk1977 }
6954b5255acSdanielk1977 
6964b5255acSdanielk1977 /*
6974b5255acSdanielk1977 ** Set the Expr.nHeight variable using the exprSetHeight() function. If
6984b5255acSdanielk1977 ** the height is greater than the maximum allowed expression depth,
6994b5255acSdanielk1977 ** leave an error in pParse.
7002308ed38Sdrh **
7012308ed38Sdrh ** Also propagate all EP_Propagate flags from the Expr.x.pList into
7022308ed38Sdrh ** Expr.flags.
7034b5255acSdanielk1977 */
7042308ed38Sdrh void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
70574893a4cSdrh   if( pParse->nErr ) return;
7064b5255acSdanielk1977   exprSetHeight(p);
7077d10d5a6Sdrh   sqlite3ExprCheckHeight(pParse, p->nHeight);
7084b5255acSdanielk1977 }
7094b5255acSdanielk1977 
7104b5255acSdanielk1977 /*
7114b5255acSdanielk1977 ** Return the maximum height of any expression tree referenced
7124b5255acSdanielk1977 ** by the select statement passed as an argument.
7134b5255acSdanielk1977 */
7144b5255acSdanielk1977 int sqlite3SelectExprHeight(Select *p){
7154b5255acSdanielk1977   int nHeight = 0;
7164b5255acSdanielk1977   heightOfSelect(p, &nHeight);
7174b5255acSdanielk1977   return nHeight;
7184b5255acSdanielk1977 }
7192308ed38Sdrh #else /* ABOVE:  Height enforcement enabled.  BELOW: Height enforcement off */
7202308ed38Sdrh /*
7212308ed38Sdrh ** Propagate all EP_Propagate flags from the Expr.x.pList into
7222308ed38Sdrh ** Expr.flags.
7232308ed38Sdrh */
7242308ed38Sdrh void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
7252308ed38Sdrh   if( p && p->x.pList && !ExprHasProperty(p, EP_xIsSelect) ){
7262308ed38Sdrh     p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
7272308ed38Sdrh   }
7282308ed38Sdrh }
7294b5255acSdanielk1977 #define exprSetHeight(y)
7304b5255acSdanielk1977 #endif /* SQLITE_MAX_EXPR_DEPTH>0 */
7314b5255acSdanielk1977 
732be5c89acSdrh /*
733b7916a78Sdrh ** This routine is the core allocator for Expr nodes.
734b7916a78Sdrh **
735a76b5dfcSdrh ** Construct a new expression node and return a pointer to it.  Memory
736b7916a78Sdrh ** for this node and for the pToken argument is a single allocation
737b7916a78Sdrh ** obtained from sqlite3DbMalloc().  The calling function
738a76b5dfcSdrh ** is responsible for making sure the node eventually gets freed.
739b7916a78Sdrh **
740b7916a78Sdrh ** If dequote is true, then the token (if it exists) is dequoted.
741e792b5b4Sdrh ** If dequote is false, no dequoting is performed.  The deQuote
742b7916a78Sdrh ** parameter is ignored if pToken is NULL or if the token does not
743b7916a78Sdrh ** appear to be quoted.  If the quotes were of the form "..." (double-quotes)
744b7916a78Sdrh ** then the EP_DblQuoted flag is set on the expression node.
74533e619fcSdrh **
74633e619fcSdrh ** Special case:  If op==TK_INTEGER and pToken points to a string that
74733e619fcSdrh ** can be translated into a 32-bit integer, then the token is not
74833e619fcSdrh ** stored in u.zToken.  Instead, the integer values is written
74933e619fcSdrh ** into u.iValue and the EP_IntValue flag is set.  No extra storage
75033e619fcSdrh ** is allocated to hold the integer text and the dequote flag is ignored.
751a76b5dfcSdrh */
752b7916a78Sdrh Expr *sqlite3ExprAlloc(
753cca8a4adSdrh   sqlite3 *db,            /* Handle for sqlite3DbMallocRawNN() */
75417435752Sdrh   int op,                 /* Expression opcode */
755b7916a78Sdrh   const Token *pToken,    /* Token argument.  Might be NULL */
756b7916a78Sdrh   int dequote             /* True to dequote */
75717435752Sdrh ){
758a76b5dfcSdrh   Expr *pNew;
75933e619fcSdrh   int nExtra = 0;
760cf697396Sshane   int iValue = 0;
761b7916a78Sdrh 
762575fad65Sdrh   assert( db!=0 );
763b7916a78Sdrh   if( pToken ){
76433e619fcSdrh     if( op!=TK_INTEGER || pToken->z==0
76533e619fcSdrh           || sqlite3GetInt32(pToken->z, &iValue)==0 ){
766b7916a78Sdrh       nExtra = pToken->n+1;
767d50ffc41Sdrh       assert( iValue>=0 );
76833e619fcSdrh     }
769a76b5dfcSdrh   }
770575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, sizeof(Expr)+nExtra);
771b7916a78Sdrh   if( pNew ){
772ca3862dcSdrh     memset(pNew, 0, sizeof(Expr));
7731bd10f8aSdrh     pNew->op = (u8)op;
774a58fdfb1Sdanielk1977     pNew->iAgg = -1;
775*2e362f97Sdan     pNew->pWin = 0;
776a76b5dfcSdrh     if( pToken ){
77733e619fcSdrh       if( nExtra==0 ){
778b98a2e35Sdrh         pNew->flags |= EP_IntValue|EP_Leaf;
77933e619fcSdrh         pNew->u.iValue = iValue;
78033e619fcSdrh       }else{
78133e619fcSdrh         pNew->u.zToken = (char*)&pNew[1];
782b07028f7Sdrh         assert( pToken->z!=0 || pToken->n==0 );
783b07028f7Sdrh         if( pToken->n ) memcpy(pNew->u.zToken, pToken->z, pToken->n);
78433e619fcSdrh         pNew->u.zToken[pToken->n] = 0;
785244b9d6eSdrh         if( dequote && sqlite3Isquote(pNew->u.zToken[0]) ){
786244b9d6eSdrh           if( pNew->u.zToken[0]=='"' ) pNew->flags |= EP_DblQuoted;
78733e619fcSdrh           sqlite3Dequote(pNew->u.zToken);
788a34001c9Sdrh         }
789a34001c9Sdrh       }
79033e619fcSdrh     }
791b7916a78Sdrh #if SQLITE_MAX_EXPR_DEPTH>0
792b7916a78Sdrh     pNew->nHeight = 1;
793b7916a78Sdrh #endif
794a34001c9Sdrh   }
795a76b5dfcSdrh   return pNew;
796a76b5dfcSdrh }
797a76b5dfcSdrh 
798a76b5dfcSdrh /*
799b7916a78Sdrh ** Allocate a new expression node from a zero-terminated token that has
800b7916a78Sdrh ** already been dequoted.
801b7916a78Sdrh */
802b7916a78Sdrh Expr *sqlite3Expr(
803b7916a78Sdrh   sqlite3 *db,            /* Handle for sqlite3DbMallocZero() (may be null) */
804b7916a78Sdrh   int op,                 /* Expression opcode */
805b7916a78Sdrh   const char *zToken      /* Token argument.  Might be NULL */
806b7916a78Sdrh ){
807b7916a78Sdrh   Token x;
808b7916a78Sdrh   x.z = zToken;
809b40f06c6Sdrh   x.n = sqlite3Strlen30(zToken);
810b7916a78Sdrh   return sqlite3ExprAlloc(db, op, &x, 0);
811b7916a78Sdrh }
812b7916a78Sdrh 
813b7916a78Sdrh /*
814b7916a78Sdrh ** Attach subtrees pLeft and pRight to the Expr node pRoot.
815b7916a78Sdrh **
816b7916a78Sdrh ** If pRoot==NULL that means that a memory allocation error has occurred.
817b7916a78Sdrh ** In that case, delete the subtrees pLeft and pRight.
818b7916a78Sdrh */
819b7916a78Sdrh void sqlite3ExprAttachSubtrees(
820b7916a78Sdrh   sqlite3 *db,
821b7916a78Sdrh   Expr *pRoot,
822b7916a78Sdrh   Expr *pLeft,
823b7916a78Sdrh   Expr *pRight
824b7916a78Sdrh ){
825b7916a78Sdrh   if( pRoot==0 ){
826b7916a78Sdrh     assert( db->mallocFailed );
827b7916a78Sdrh     sqlite3ExprDelete(db, pLeft);
828b7916a78Sdrh     sqlite3ExprDelete(db, pRight);
829b7916a78Sdrh   }else{
830b7916a78Sdrh     if( pRight ){
831b7916a78Sdrh       pRoot->pRight = pRight;
832885a5b03Sdrh       pRoot->flags |= EP_Propagate & pRight->flags;
833b7916a78Sdrh     }
834b7916a78Sdrh     if( pLeft ){
835b7916a78Sdrh       pRoot->pLeft = pLeft;
836885a5b03Sdrh       pRoot->flags |= EP_Propagate & pLeft->flags;
837b7916a78Sdrh     }
838b7916a78Sdrh     exprSetHeight(pRoot);
839b7916a78Sdrh   }
840b7916a78Sdrh }
841b7916a78Sdrh 
842b7916a78Sdrh /*
84360ec914cSpeter.d.reid ** Allocate an Expr node which joins as many as two subtrees.
844b7916a78Sdrh **
845bf664469Sdrh ** One or both of the subtrees can be NULL.  Return a pointer to the new
846bf664469Sdrh ** Expr node.  Or, if an OOM error occurs, set pParse->db->mallocFailed,
847bf664469Sdrh ** free the subtrees and return NULL.
848206f3d96Sdrh */
84917435752Sdrh Expr *sqlite3PExpr(
85017435752Sdrh   Parse *pParse,          /* Parsing context */
85117435752Sdrh   int op,                 /* Expression opcode */
85217435752Sdrh   Expr *pLeft,            /* Left operand */
853abfd35eaSdrh   Expr *pRight            /* Right operand */
85417435752Sdrh ){
8555fb52caaSdrh   Expr *p;
8561167d327Sdrh   if( op==TK_AND && pParse->nErr==0 ){
8575fb52caaSdrh     /* Take advantage of short-circuit false optimization for AND */
8585fb52caaSdrh     p = sqlite3ExprAnd(pParse->db, pLeft, pRight);
8595fb52caaSdrh   }else{
860abfd35eaSdrh     p = sqlite3DbMallocRawNN(pParse->db, sizeof(Expr));
861abfd35eaSdrh     if( p ){
862abfd35eaSdrh       memset(p, 0, sizeof(Expr));
863abfd35eaSdrh       p->op = op & TKFLG_MASK;
864abfd35eaSdrh       p->iAgg = -1;
865*2e362f97Sdan       p->pWin = 0;
866abfd35eaSdrh     }
867b7916a78Sdrh     sqlite3ExprAttachSubtrees(pParse->db, p, pLeft, pRight);
8685fb52caaSdrh   }
8692b359bdbSdan   if( p ) {
8702b359bdbSdan     sqlite3ExprCheckHeight(pParse, p->nHeight);
8712b359bdbSdan   }
8724e0cff60Sdrh   return p;
8734e0cff60Sdrh }
8744e0cff60Sdrh 
8754e0cff60Sdrh /*
87608de4f79Sdrh ** Add pSelect to the Expr.x.pSelect field.  Or, if pExpr is NULL (due
87708de4f79Sdrh ** do a memory allocation failure) then delete the pSelect object.
87808de4f79Sdrh */
87908de4f79Sdrh void sqlite3PExprAddSelect(Parse *pParse, Expr *pExpr, Select *pSelect){
88008de4f79Sdrh   if( pExpr ){
88108de4f79Sdrh     pExpr->x.pSelect = pSelect;
88208de4f79Sdrh     ExprSetProperty(pExpr, EP_xIsSelect|EP_Subquery);
88308de4f79Sdrh     sqlite3ExprSetHeightAndFlags(pParse, pExpr);
88408de4f79Sdrh   }else{
88508de4f79Sdrh     assert( pParse->db->mallocFailed );
88608de4f79Sdrh     sqlite3SelectDelete(pParse->db, pSelect);
88708de4f79Sdrh   }
88808de4f79Sdrh }
88908de4f79Sdrh 
89008de4f79Sdrh 
89108de4f79Sdrh /*
892991a1985Sdrh ** If the expression is always either TRUE or FALSE (respectively),
893991a1985Sdrh ** then return 1.  If one cannot determine the truth value of the
894991a1985Sdrh ** expression at compile-time return 0.
895991a1985Sdrh **
896991a1985Sdrh ** This is an optimization.  If is OK to return 0 here even if
897991a1985Sdrh ** the expression really is always false or false (a false negative).
898991a1985Sdrh ** But it is a bug to return 1 if the expression might have different
899991a1985Sdrh ** boolean values in different circumstances (a false positive.)
9005fb52caaSdrh **
9015fb52caaSdrh ** Note that if the expression is part of conditional for a
9025fb52caaSdrh ** LEFT JOIN, then we cannot determine at compile-time whether or not
9035fb52caaSdrh ** is it true or false, so always return 0.
9045fb52caaSdrh */
905991a1985Sdrh static int exprAlwaysTrue(Expr *p){
906991a1985Sdrh   int v = 0;
907991a1985Sdrh   if( ExprHasProperty(p, EP_FromJoin) ) return 0;
908991a1985Sdrh   if( !sqlite3ExprIsInteger(p, &v) ) return 0;
909991a1985Sdrh   return v!=0;
910991a1985Sdrh }
9115fb52caaSdrh static int exprAlwaysFalse(Expr *p){
9125fb52caaSdrh   int v = 0;
9135fb52caaSdrh   if( ExprHasProperty(p, EP_FromJoin) ) return 0;
9145fb52caaSdrh   if( !sqlite3ExprIsInteger(p, &v) ) return 0;
9155fb52caaSdrh   return v==0;
9165fb52caaSdrh }
9175fb52caaSdrh 
9185fb52caaSdrh /*
91991bb0eedSdrh ** Join two expressions using an AND operator.  If either expression is
92091bb0eedSdrh ** NULL, then just return the other expression.
9215fb52caaSdrh **
9225fb52caaSdrh ** If one side or the other of the AND is known to be false, then instead
9235fb52caaSdrh ** of returning an AND expression, just return a constant expression with
9245fb52caaSdrh ** a value of false.
92591bb0eedSdrh */
9261e536953Sdanielk1977 Expr *sqlite3ExprAnd(sqlite3 *db, Expr *pLeft, Expr *pRight){
92791bb0eedSdrh   if( pLeft==0 ){
92891bb0eedSdrh     return pRight;
92991bb0eedSdrh   }else if( pRight==0 ){
93091bb0eedSdrh     return pLeft;
9315fb52caaSdrh   }else if( exprAlwaysFalse(pLeft) || exprAlwaysFalse(pRight) ){
9325fb52caaSdrh     sqlite3ExprDelete(db, pLeft);
9335fb52caaSdrh     sqlite3ExprDelete(db, pRight);
9345fb52caaSdrh     return sqlite3ExprAlloc(db, TK_INTEGER, &sqlite3IntTokens[0], 0);
93591bb0eedSdrh   }else{
936b7916a78Sdrh     Expr *pNew = sqlite3ExprAlloc(db, TK_AND, 0, 0);
937b7916a78Sdrh     sqlite3ExprAttachSubtrees(db, pNew, pLeft, pRight);
938b7916a78Sdrh     return pNew;
939a76b5dfcSdrh   }
940a76b5dfcSdrh }
941a76b5dfcSdrh 
942a76b5dfcSdrh /*
943a76b5dfcSdrh ** Construct a new expression node for a function with multiple
944a76b5dfcSdrh ** arguments.
945a76b5dfcSdrh */
94617435752Sdrh Expr *sqlite3ExprFunction(Parse *pParse, ExprList *pList, Token *pToken){
947a76b5dfcSdrh   Expr *pNew;
948633e6d57Sdrh   sqlite3 *db = pParse->db;
9494b202ae2Sdanielk1977   assert( pToken );
950b7916a78Sdrh   pNew = sqlite3ExprAlloc(db, TK_FUNCTION, pToken, 1);
951a76b5dfcSdrh   if( pNew==0 ){
952d9da78a2Sdrh     sqlite3ExprListDelete(db, pList); /* Avoid memory leak when malloc fails */
953a76b5dfcSdrh     return 0;
954a76b5dfcSdrh   }
9556ab3a2ecSdanielk1977   pNew->x.pList = pList;
956fca23557Sdrh   ExprSetProperty(pNew, EP_HasFunc);
9576ab3a2ecSdanielk1977   assert( !ExprHasProperty(pNew, EP_xIsSelect) );
9582308ed38Sdrh   sqlite3ExprSetHeightAndFlags(pParse, pNew);
959a76b5dfcSdrh   return pNew;
960a76b5dfcSdrh }
961a76b5dfcSdrh 
962a76b5dfcSdrh /*
963fa6bc000Sdrh ** Assign a variable number to an expression that encodes a wildcard
964fa6bc000Sdrh ** in the original SQL statement.
965fa6bc000Sdrh **
966fa6bc000Sdrh ** Wildcards consisting of a single "?" are assigned the next sequential
967fa6bc000Sdrh ** variable number.
968fa6bc000Sdrh **
969fa6bc000Sdrh ** Wildcards of the form "?nnn" are assigned the number "nnn".  We make
9709bf755ccSdrh ** sure "nnn" is not too big to avoid a denial of service attack when
971fa6bc000Sdrh ** the SQL statement comes from an external source.
972fa6bc000Sdrh **
97351f49f17Sdrh ** Wildcards of the form ":aaa", "@aaa", or "$aaa" are assigned the same number
974fa6bc000Sdrh ** as the previous instance of the same wildcard.  Or if this is the first
97560ec914cSpeter.d.reid ** instance of the wildcard, the next sequential variable number is
976fa6bc000Sdrh ** assigned.
977fa6bc000Sdrh */
978de25a88cSdrh void sqlite3ExprAssignVarNumber(Parse *pParse, Expr *pExpr, u32 n){
97917435752Sdrh   sqlite3 *db = pParse->db;
980b7916a78Sdrh   const char *z;
981f326d66dSdrh   ynVar x;
98217435752Sdrh 
983fa6bc000Sdrh   if( pExpr==0 ) return;
984c5cd1249Sdrh   assert( !ExprHasProperty(pExpr, EP_IntValue|EP_Reduced|EP_TokenOnly) );
98533e619fcSdrh   z = pExpr->u.zToken;
986b7916a78Sdrh   assert( z!=0 );
987b7916a78Sdrh   assert( z[0]!=0 );
988b1ed717fSmistachkin   assert( n==(u32)sqlite3Strlen30(z) );
989b7916a78Sdrh   if( z[1]==0 ){
990fa6bc000Sdrh     /* Wildcard of the form "?".  Assign the next variable number */
991b7916a78Sdrh     assert( z[0]=='?' );
992f326d66dSdrh     x = (ynVar)(++pParse->nVar);
993124c0b49Sdrh   }else{
994f326d66dSdrh     int doAdd = 0;
995124c0b49Sdrh     if( z[0]=='?' ){
996fa6bc000Sdrh       /* Wildcard of the form "?nnn".  Convert "nnn" to an integer and
997fa6bc000Sdrh       ** use it as the variable number */
998c8d735aeSdan       i64 i;
99918814dfbSdrh       int bOk;
100018814dfbSdrh       if( n==2 ){ /*OPTIMIZATION-IF-TRUE*/
100118814dfbSdrh         i = z[1]-'0';  /* The common case of ?N for a single digit N */
100218814dfbSdrh         bOk = 1;
100318814dfbSdrh       }else{
100418814dfbSdrh         bOk = 0==sqlite3Atoi64(&z[1], &i, n-1, SQLITE_UTF8);
100518814dfbSdrh       }
1006c5499befSdrh       testcase( i==0 );
1007c5499befSdrh       testcase( i==1 );
1008c5499befSdrh       testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]-1 );
1009c5499befSdrh       testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] );
1010c8d735aeSdan       if( bOk==0 || i<1 || i>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
1011fa6bc000Sdrh         sqlite3ErrorMsg(pParse, "variable number must be between ?1 and ?%d",
1012bb4957f8Sdrh             db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]);
1013c9b39288Sdrh         return;
1014fa6bc000Sdrh       }
10158e74e7baSdrh       x = (ynVar)i;
1016f326d66dSdrh       if( x>pParse->nVar ){
1017f326d66dSdrh         pParse->nVar = (int)x;
1018f326d66dSdrh         doAdd = 1;
1019f326d66dSdrh       }else if( sqlite3VListNumToName(pParse->pVList, x)==0 ){
1020f326d66dSdrh         doAdd = 1;
1021fa6bc000Sdrh       }
1022fa6bc000Sdrh     }else{
102351f49f17Sdrh       /* Wildcards like ":aaa", "$aaa" or "@aaa".  Reuse the same variable
1024fa6bc000Sdrh       ** number as the prior appearance of the same name, or if the name
1025fa6bc000Sdrh       ** has never appeared before, reuse the same variable number
1026fa6bc000Sdrh       */
10279bf755ccSdrh       x = (ynVar)sqlite3VListNameToNum(pParse->pVList, z, n);
10289bf755ccSdrh       if( x==0 ){
10299bf755ccSdrh         x = (ynVar)(++pParse->nVar);
1030f326d66dSdrh         doAdd = 1;
1031f326d66dSdrh       }
1032f326d66dSdrh     }
1033f326d66dSdrh     if( doAdd ){
10349bf755ccSdrh       pParse->pVList = sqlite3VListAdd(db, pParse->pVList, z, n, x);
1035fa6bc000Sdrh     }
1036fa6bc000Sdrh   }
1037c9b39288Sdrh   pExpr->iColumn = x;
1038f326d66dSdrh   if( x>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
1039832b2664Sdanielk1977     sqlite3ErrorMsg(pParse, "too many SQL variables");
1040832b2664Sdanielk1977   }
1041fa6bc000Sdrh }
1042fa6bc000Sdrh 
1043fa6bc000Sdrh /*
1044f6963f99Sdan ** Recursively delete an expression tree.
1045a2e00042Sdrh */
10464f0010b1Sdrh static SQLITE_NOINLINE void sqlite3ExprDeleteNN(sqlite3 *db, Expr *p){
10474f0010b1Sdrh   assert( p!=0 );
1048d50ffc41Sdrh   /* Sanity check: Assert that the IntValue is non-negative if it exists */
1049d50ffc41Sdrh   assert( !ExprHasProperty(p, EP_IntValue) || p->u.iValue>=0 );
1050209bc522Sdrh #ifdef SQLITE_DEBUG
1051209bc522Sdrh   if( ExprHasProperty(p, EP_Leaf) && !ExprHasProperty(p, EP_TokenOnly) ){
1052209bc522Sdrh     assert( p->pLeft==0 );
1053209bc522Sdrh     assert( p->pRight==0 );
1054209bc522Sdrh     assert( p->x.pSelect==0 );
1055209bc522Sdrh   }
1056209bc522Sdrh #endif
1057209bc522Sdrh   if( !ExprHasProperty(p, (EP_TokenOnly|EP_Leaf)) ){
1058c5cd1249Sdrh     /* The Expr.x union is never used at the same time as Expr.pRight */
1059c5cd1249Sdrh     assert( p->x.pList==0 || p->pRight==0 );
10604910a76dSdrh     if( p->pLeft && p->op!=TK_SELECT_COLUMN ) sqlite3ExprDeleteNN(db, p->pLeft);
1061d1086679Sdrh     if( p->pRight ){
1062d1086679Sdrh       sqlite3ExprDeleteNN(db, p->pRight);
1063d1086679Sdrh     }else if( ExprHasProperty(p, EP_xIsSelect) ){
10646ab3a2ecSdanielk1977       sqlite3SelectDelete(db, p->x.pSelect);
10656ab3a2ecSdanielk1977     }else{
10666ab3a2ecSdanielk1977       sqlite3ExprListDelete(db, p->x.pList);
10676ab3a2ecSdanielk1977     }
106886fb6e17Sdan     if( !ExprHasProperty(p, EP_Reduced) ){
106986fb6e17Sdan       sqlite3WindowDelete(db, p->pWin);
107086fb6e17Sdan     }
10716ab3a2ecSdanielk1977   }
1072209bc522Sdrh   if( ExprHasProperty(p, EP_MemToken) ) sqlite3DbFree(db, p->u.zToken);
107333e619fcSdrh   if( !ExprHasProperty(p, EP_Static) ){
1074dbd6a7dcSdrh     sqlite3DbFreeNN(db, p);
1075a2e00042Sdrh   }
107633e619fcSdrh }
10774f0010b1Sdrh void sqlite3ExprDelete(sqlite3 *db, Expr *p){
10784f0010b1Sdrh   if( p ) sqlite3ExprDeleteNN(db, p);
10794f0010b1Sdrh }
1080a2e00042Sdrh 
1081d2687b77Sdrh /*
10826ab3a2ecSdanielk1977 ** Return the number of bytes allocated for the expression structure
10836ab3a2ecSdanielk1977 ** passed as the first argument. This is always one of EXPR_FULLSIZE,
10846ab3a2ecSdanielk1977 ** EXPR_REDUCEDSIZE or EXPR_TOKENONLYSIZE.
10856ab3a2ecSdanielk1977 */
10866ab3a2ecSdanielk1977 static int exprStructSize(Expr *p){
10876ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_TokenOnly) ) return EXPR_TOKENONLYSIZE;
10886ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_Reduced) ) return EXPR_REDUCEDSIZE;
10896ab3a2ecSdanielk1977   return EXPR_FULLSIZE;
10906ab3a2ecSdanielk1977 }
10916ab3a2ecSdanielk1977 
10926ab3a2ecSdanielk1977 /*
109333e619fcSdrh ** The dupedExpr*Size() routines each return the number of bytes required
109433e619fcSdrh ** to store a copy of an expression or expression tree.  They differ in
109533e619fcSdrh ** how much of the tree is measured.
109633e619fcSdrh **
109733e619fcSdrh **     dupedExprStructSize()     Size of only the Expr structure
109833e619fcSdrh **     dupedExprNodeSize()       Size of Expr + space for token
109933e619fcSdrh **     dupedExprSize()           Expr + token + subtree components
110033e619fcSdrh **
110133e619fcSdrh ***************************************************************************
110233e619fcSdrh **
110333e619fcSdrh ** The dupedExprStructSize() function returns two values OR-ed together:
110433e619fcSdrh ** (1) the space required for a copy of the Expr structure only and
110533e619fcSdrh ** (2) the EP_xxx flags that indicate what the structure size should be.
110633e619fcSdrh ** The return values is always one of:
110733e619fcSdrh **
110833e619fcSdrh **      EXPR_FULLSIZE
110933e619fcSdrh **      EXPR_REDUCEDSIZE   | EP_Reduced
111033e619fcSdrh **      EXPR_TOKENONLYSIZE | EP_TokenOnly
111133e619fcSdrh **
111233e619fcSdrh ** The size of the structure can be found by masking the return value
111333e619fcSdrh ** of this routine with 0xfff.  The flags can be found by masking the
111433e619fcSdrh ** return value with EP_Reduced|EP_TokenOnly.
111533e619fcSdrh **
111633e619fcSdrh ** Note that with flags==EXPRDUP_REDUCE, this routines works on full-size
111733e619fcSdrh ** (unreduced) Expr objects as they or originally constructed by the parser.
111833e619fcSdrh ** During expression analysis, extra information is computed and moved into
111933e619fcSdrh ** later parts of teh Expr object and that extra information might get chopped
112033e619fcSdrh ** off if the expression is reduced.  Note also that it does not work to
112160ec914cSpeter.d.reid ** make an EXPRDUP_REDUCE copy of a reduced expression.  It is only legal
112233e619fcSdrh ** to reduce a pristine expression tree from the parser.  The implementation
112333e619fcSdrh ** of dupedExprStructSize() contain multiple assert() statements that attempt
112433e619fcSdrh ** to enforce this constraint.
11256ab3a2ecSdanielk1977 */
11266ab3a2ecSdanielk1977 static int dupedExprStructSize(Expr *p, int flags){
11276ab3a2ecSdanielk1977   int nSize;
112833e619fcSdrh   assert( flags==EXPRDUP_REDUCE || flags==0 ); /* Only one flag value allowed */
1129aecd8021Sdrh   assert( EXPR_FULLSIZE<=0xfff );
1130aecd8021Sdrh   assert( (0xfff & (EP_Reduced|EP_TokenOnly))==0 );
113143c4ac8bSdrh   if( 0==flags || p->op==TK_SELECT_COLUMN ){
11326ab3a2ecSdanielk1977     nSize = EXPR_FULLSIZE;
11336ab3a2ecSdanielk1977   }else{
1134c5cd1249Sdrh     assert( !ExprHasProperty(p, EP_TokenOnly|EP_Reduced) );
113533e619fcSdrh     assert( !ExprHasProperty(p, EP_FromJoin) );
1136c5cd1249Sdrh     assert( !ExprHasProperty(p, EP_MemToken) );
1137ebb6a65dSdrh     assert( !ExprHasProperty(p, EP_NoReduce) );
1138aecd8021Sdrh     if( p->pLeft || p->x.pList ){
113933e619fcSdrh       nSize = EXPR_REDUCEDSIZE | EP_Reduced;
114033e619fcSdrh     }else{
1141aecd8021Sdrh       assert( p->pRight==0 );
114233e619fcSdrh       nSize = EXPR_TOKENONLYSIZE | EP_TokenOnly;
114333e619fcSdrh     }
11446ab3a2ecSdanielk1977   }
11456ab3a2ecSdanielk1977   return nSize;
11466ab3a2ecSdanielk1977 }
11476ab3a2ecSdanielk1977 
11486ab3a2ecSdanielk1977 /*
114933e619fcSdrh ** This function returns the space in bytes required to store the copy
115033e619fcSdrh ** of the Expr structure and a copy of the Expr.u.zToken string (if that
115133e619fcSdrh ** string is defined.)
11526ab3a2ecSdanielk1977 */
11536ab3a2ecSdanielk1977 static int dupedExprNodeSize(Expr *p, int flags){
115433e619fcSdrh   int nByte = dupedExprStructSize(p, flags) & 0xfff;
115533e619fcSdrh   if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
115633e619fcSdrh     nByte += sqlite3Strlen30(p->u.zToken)+1;
11576ab3a2ecSdanielk1977   }
1158bc73971dSdanielk1977   return ROUND8(nByte);
11596ab3a2ecSdanielk1977 }
11606ab3a2ecSdanielk1977 
11616ab3a2ecSdanielk1977 /*
11626ab3a2ecSdanielk1977 ** Return the number of bytes required to create a duplicate of the
11636ab3a2ecSdanielk1977 ** expression passed as the first argument. The second argument is a
11646ab3a2ecSdanielk1977 ** mask containing EXPRDUP_XXX flags.
11656ab3a2ecSdanielk1977 **
11666ab3a2ecSdanielk1977 ** The value returned includes space to create a copy of the Expr struct
116733e619fcSdrh ** itself and the buffer referred to by Expr.u.zToken, if any.
11686ab3a2ecSdanielk1977 **
11696ab3a2ecSdanielk1977 ** If the EXPRDUP_REDUCE flag is set, then the return value includes
11706ab3a2ecSdanielk1977 ** space to duplicate all Expr nodes in the tree formed by Expr.pLeft
11716ab3a2ecSdanielk1977 ** and Expr.pRight variables (but not for any structures pointed to or
11726ab3a2ecSdanielk1977 ** descended from the Expr.x.pList or Expr.x.pSelect variables).
11736ab3a2ecSdanielk1977 */
11746ab3a2ecSdanielk1977 static int dupedExprSize(Expr *p, int flags){
11756ab3a2ecSdanielk1977   int nByte = 0;
11766ab3a2ecSdanielk1977   if( p ){
11776ab3a2ecSdanielk1977     nByte = dupedExprNodeSize(p, flags);
11786ab3a2ecSdanielk1977     if( flags&EXPRDUP_REDUCE ){
1179b7916a78Sdrh       nByte += dupedExprSize(p->pLeft, flags) + dupedExprSize(p->pRight, flags);
11806ab3a2ecSdanielk1977     }
11816ab3a2ecSdanielk1977   }
11826ab3a2ecSdanielk1977   return nByte;
11836ab3a2ecSdanielk1977 }
11846ab3a2ecSdanielk1977 
1185*2e362f97Sdan static Window *winDup(sqlite3 *db, Window *p){
1186*2e362f97Sdan   Window *pNew = 0;
1187*2e362f97Sdan   if( p ){
1188*2e362f97Sdan     pNew = sqlite3DbMallocZero(db, sizeof(Window));
1189*2e362f97Sdan     if( pNew ){
1190*2e362f97Sdan       pNew->pFilter = sqlite3ExprDup(db, p->pFilter, 0);
1191*2e362f97Sdan       pNew->pPartition = sqlite3ExprListDup(db, p->pPartition, 0);
1192*2e362f97Sdan       pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, 0);
1193*2e362f97Sdan       pNew->eType = p->eType;
1194*2e362f97Sdan       pNew->eEnd = p->eEnd;
1195*2e362f97Sdan       pNew->eStart = p->eStart;
1196*2e362f97Sdan       pNew->pStart = sqlite3ExprDup(db, pNew->pStart, 0);
1197*2e362f97Sdan       pNew->pEnd = sqlite3ExprDup(db, pNew->pEnd, 0);
1198*2e362f97Sdan     }
1199*2e362f97Sdan   }
1200*2e362f97Sdan   return pNew;
1201*2e362f97Sdan }
1202*2e362f97Sdan 
12036ab3a2ecSdanielk1977 /*
12046ab3a2ecSdanielk1977 ** This function is similar to sqlite3ExprDup(), except that if pzBuffer
12056ab3a2ecSdanielk1977 ** is not NULL then *pzBuffer is assumed to point to a buffer large enough
120633e619fcSdrh ** to store the copy of expression p, the copies of p->u.zToken
12076ab3a2ecSdanielk1977 ** (if applicable), and the copies of the p->pLeft and p->pRight expressions,
120860ec914cSpeter.d.reid ** if any. Before returning, *pzBuffer is set to the first byte past the
12096ab3a2ecSdanielk1977 ** portion of the buffer copied into by this function.
12106ab3a2ecSdanielk1977 */
12113c19469cSdrh static Expr *exprDup(sqlite3 *db, Expr *p, int dupFlags, u8 **pzBuffer){
12123c19469cSdrh   Expr *pNew;           /* Value to return */
12133c19469cSdrh   u8 *zAlloc;           /* Memory space from which to build Expr object */
12143c19469cSdrh   u32 staticFlag;       /* EP_Static if space not obtained from malloc */
12156ab3a2ecSdanielk1977 
12163c19469cSdrh   assert( db!=0 );
12173c19469cSdrh   assert( p );
12183c19469cSdrh   assert( dupFlags==0 || dupFlags==EXPRDUP_REDUCE );
12193c19469cSdrh   assert( pzBuffer==0 || dupFlags==EXPRDUP_REDUCE );
12206ab3a2ecSdanielk1977 
12216ab3a2ecSdanielk1977   /* Figure out where to write the new Expr structure. */
12226ab3a2ecSdanielk1977   if( pzBuffer ){
12236ab3a2ecSdanielk1977     zAlloc = *pzBuffer;
122433e619fcSdrh     staticFlag = EP_Static;
12256ab3a2ecSdanielk1977   }else{
12263c19469cSdrh     zAlloc = sqlite3DbMallocRawNN(db, dupedExprSize(p, dupFlags));
12273c19469cSdrh     staticFlag = 0;
12286ab3a2ecSdanielk1977   }
12296ab3a2ecSdanielk1977   pNew = (Expr *)zAlloc;
12306ab3a2ecSdanielk1977 
12316ab3a2ecSdanielk1977   if( pNew ){
12326ab3a2ecSdanielk1977     /* Set nNewSize to the size allocated for the structure pointed to
12336ab3a2ecSdanielk1977     ** by pNew. This is either EXPR_FULLSIZE, EXPR_REDUCEDSIZE or
12346ab3a2ecSdanielk1977     ** EXPR_TOKENONLYSIZE. nToken is set to the number of bytes consumed
123533e619fcSdrh     ** by the copy of the p->u.zToken string (if any).
12366ab3a2ecSdanielk1977     */
12373c19469cSdrh     const unsigned nStructSize = dupedExprStructSize(p, dupFlags);
123833e619fcSdrh     const int nNewSize = nStructSize & 0xfff;
123933e619fcSdrh     int nToken;
124033e619fcSdrh     if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
124133e619fcSdrh       nToken = sqlite3Strlen30(p->u.zToken) + 1;
124233e619fcSdrh     }else{
124333e619fcSdrh       nToken = 0;
124433e619fcSdrh     }
12453c19469cSdrh     if( dupFlags ){
12466ab3a2ecSdanielk1977       assert( ExprHasProperty(p, EP_Reduced)==0 );
12476ab3a2ecSdanielk1977       memcpy(zAlloc, p, nNewSize);
12486ab3a2ecSdanielk1977     }else{
12493e6a1411Sdan       u32 nSize = (u32)exprStructSize(p);
12506ab3a2ecSdanielk1977       memcpy(zAlloc, p, nSize);
125172ea29d7Sdrh       if( nSize<EXPR_FULLSIZE ){
12526ab3a2ecSdanielk1977         memset(&zAlloc[nSize], 0, EXPR_FULLSIZE-nSize);
12536ab3a2ecSdanielk1977       }
125472ea29d7Sdrh     }
12556ab3a2ecSdanielk1977 
125633e619fcSdrh     /* Set the EP_Reduced, EP_TokenOnly, and EP_Static flags appropriately. */
1257c5cd1249Sdrh     pNew->flags &= ~(EP_Reduced|EP_TokenOnly|EP_Static|EP_MemToken);
125833e619fcSdrh     pNew->flags |= nStructSize & (EP_Reduced|EP_TokenOnly);
125933e619fcSdrh     pNew->flags |= staticFlag;
12606ab3a2ecSdanielk1977 
126133e619fcSdrh     /* Copy the p->u.zToken string, if any. */
12626ab3a2ecSdanielk1977     if( nToken ){
126333e619fcSdrh       char *zToken = pNew->u.zToken = (char*)&zAlloc[nNewSize];
126433e619fcSdrh       memcpy(zToken, p->u.zToken, nToken);
12656ab3a2ecSdanielk1977     }
12666ab3a2ecSdanielk1977 
1267209bc522Sdrh     if( 0==((p->flags|pNew->flags) & (EP_TokenOnly|EP_Leaf)) ){
12686ab3a2ecSdanielk1977       /* Fill in the pNew->x.pSelect or pNew->x.pList member. */
12696ab3a2ecSdanielk1977       if( ExprHasProperty(p, EP_xIsSelect) ){
12703c19469cSdrh         pNew->x.pSelect = sqlite3SelectDup(db, p->x.pSelect, dupFlags);
12716ab3a2ecSdanielk1977       }else{
12723c19469cSdrh         pNew->x.pList = sqlite3ExprListDup(db, p->x.pList, dupFlags);
12736ab3a2ecSdanielk1977       }
12746ab3a2ecSdanielk1977     }
12756ab3a2ecSdanielk1977 
12766ab3a2ecSdanielk1977     /* Fill in pNew->pLeft and pNew->pRight. */
1277c5cd1249Sdrh     if( ExprHasProperty(pNew, EP_Reduced|EP_TokenOnly) ){
12783c19469cSdrh       zAlloc += dupedExprNodeSize(p, dupFlags);
1279209bc522Sdrh       if( !ExprHasProperty(pNew, EP_TokenOnly|EP_Leaf) ){
12803c19469cSdrh         pNew->pLeft = p->pLeft ?
12813c19469cSdrh                       exprDup(db, p->pLeft, EXPRDUP_REDUCE, &zAlloc) : 0;
12823c19469cSdrh         pNew->pRight = p->pRight ?
12833c19469cSdrh                        exprDup(db, p->pRight, EXPRDUP_REDUCE, &zAlloc) : 0;
12846ab3a2ecSdanielk1977       }
12856ab3a2ecSdanielk1977       if( pzBuffer ){
12866ab3a2ecSdanielk1977         *pzBuffer = zAlloc;
12876ab3a2ecSdanielk1977       }
1288b7916a78Sdrh     }else{
1289*2e362f97Sdan       pNew->pWin = winDup(db, p->pWin);
1290209bc522Sdrh       if( !ExprHasProperty(p, EP_TokenOnly|EP_Leaf) ){
12919854260bSdrh         if( pNew->op==TK_SELECT_COLUMN ){
12929854260bSdrh           pNew->pLeft = p->pLeft;
129347073f62Sdrh           assert( p->iColumn==0 || p->pRight==0 );
129447073f62Sdrh           assert( p->pRight==0  || p->pRight==p->pLeft );
12959854260bSdrh         }else{
12966ab3a2ecSdanielk1977           pNew->pLeft = sqlite3ExprDup(db, p->pLeft, 0);
12979854260bSdrh         }
12986ab3a2ecSdanielk1977         pNew->pRight = sqlite3ExprDup(db, p->pRight, 0);
12996ab3a2ecSdanielk1977       }
13006ab3a2ecSdanielk1977     }
13016ab3a2ecSdanielk1977   }
13026ab3a2ecSdanielk1977   return pNew;
13036ab3a2ecSdanielk1977 }
13046ab3a2ecSdanielk1977 
13056ab3a2ecSdanielk1977 /*
1306bfe31e7fSdan ** Create and return a deep copy of the object passed as the second
1307bfe31e7fSdan ** argument. If an OOM condition is encountered, NULL is returned
1308bfe31e7fSdan ** and the db->mallocFailed flag set.
1309bfe31e7fSdan */
1310eede6a53Sdan #ifndef SQLITE_OMIT_CTE
1311bfe31e7fSdan static With *withDup(sqlite3 *db, With *p){
13124e9119d9Sdan   With *pRet = 0;
13134e9119d9Sdan   if( p ){
13144e9119d9Sdan     int nByte = sizeof(*p) + sizeof(p->a[0]) * (p->nCte-1);
13154e9119d9Sdan     pRet = sqlite3DbMallocZero(db, nByte);
13164e9119d9Sdan     if( pRet ){
13174e9119d9Sdan       int i;
13184e9119d9Sdan       pRet->nCte = p->nCte;
13194e9119d9Sdan       for(i=0; i<p->nCte; i++){
13204e9119d9Sdan         pRet->a[i].pSelect = sqlite3SelectDup(db, p->a[i].pSelect, 0);
13214e9119d9Sdan         pRet->a[i].pCols = sqlite3ExprListDup(db, p->a[i].pCols, 0);
13224e9119d9Sdan         pRet->a[i].zName = sqlite3DbStrDup(db, p->a[i].zName);
13234e9119d9Sdan       }
13244e9119d9Sdan     }
13254e9119d9Sdan   }
13264e9119d9Sdan   return pRet;
13274e9119d9Sdan }
1328eede6a53Sdan #else
1329eede6a53Sdan # define withDup(x,y) 0
1330eede6a53Sdan #endif
13314e9119d9Sdan 
1332a76b5dfcSdrh /*
1333ff78bd2fSdrh ** The following group of routines make deep copies of expressions,
1334ff78bd2fSdrh ** expression lists, ID lists, and select statements.  The copies can
1335ff78bd2fSdrh ** be deleted (by being passed to their respective ...Delete() routines)
1336ff78bd2fSdrh ** without effecting the originals.
1337ff78bd2fSdrh **
13384adee20fSdanielk1977 ** The expression list, ID, and source lists return by sqlite3ExprListDup(),
13394adee20fSdanielk1977 ** sqlite3IdListDup(), and sqlite3SrcListDup() can not be further expanded
1340ad3cab52Sdrh ** by subsequent calls to sqlite*ListAppend() routines.
1341ff78bd2fSdrh **
1342ad3cab52Sdrh ** Any tables that the SrcList might point to are not duplicated.
13436ab3a2ecSdanielk1977 **
1344b7916a78Sdrh ** The flags parameter contains a combination of the EXPRDUP_XXX flags.
13456ab3a2ecSdanielk1977 ** If the EXPRDUP_REDUCE flag is set, then the structure returned is a
13466ab3a2ecSdanielk1977 ** truncated version of the usual Expr structure that will be stored as
13476ab3a2ecSdanielk1977 ** part of the in-memory representation of the database schema.
1348ff78bd2fSdrh */
13496ab3a2ecSdanielk1977 Expr *sqlite3ExprDup(sqlite3 *db, Expr *p, int flags){
135072ea29d7Sdrh   assert( flags==0 || flags==EXPRDUP_REDUCE );
13513c19469cSdrh   return p ? exprDup(db, p, flags, 0) : 0;
1352ff78bd2fSdrh }
13536ab3a2ecSdanielk1977 ExprList *sqlite3ExprListDup(sqlite3 *db, ExprList *p, int flags){
1354ff78bd2fSdrh   ExprList *pNew;
1355145716b3Sdrh   struct ExprList_item *pItem, *pOldItem;
1356ff78bd2fSdrh   int i;
1357b163748eSdrh   Expr *pPriorSelectCol = 0;
1358575fad65Sdrh   assert( db!=0 );
1359ff78bd2fSdrh   if( p==0 ) return 0;
136097258194Sdrh   pNew = sqlite3DbMallocRawNN(db, sqlite3DbMallocSize(db, p));
1361ff78bd2fSdrh   if( pNew==0 ) return 0;
1362a19543feSdrh   pNew->nExpr = p->nExpr;
136343606175Sdrh   pItem = pNew->a;
1364145716b3Sdrh   pOldItem = p->a;
1365145716b3Sdrh   for(i=0; i<p->nExpr; i++, pItem++, pOldItem++){
13666ab3a2ecSdanielk1977     Expr *pOldExpr = pOldItem->pExpr;
136747073f62Sdrh     Expr *pNewExpr;
1368b5526ea6Sdrh     pItem->pExpr = sqlite3ExprDup(db, pOldExpr, flags);
136947073f62Sdrh     if( pOldExpr
137047073f62Sdrh      && pOldExpr->op==TK_SELECT_COLUMN
137147073f62Sdrh      && (pNewExpr = pItem->pExpr)!=0
137247073f62Sdrh     ){
137347073f62Sdrh       assert( pNewExpr->iColumn==0 || i>0 );
137447073f62Sdrh       if( pNewExpr->iColumn==0 ){
137547073f62Sdrh         assert( pOldExpr->pLeft==pOldExpr->pRight );
1376b163748eSdrh         pPriorSelectCol = pNewExpr->pLeft = pNewExpr->pRight;
1377b163748eSdrh       }else{
1378b163748eSdrh         assert( i>0 );
1379b163748eSdrh         assert( pItem[-1].pExpr!=0 );
1380b163748eSdrh         assert( pNewExpr->iColumn==pItem[-1].pExpr->iColumn+1 );
1381b163748eSdrh         assert( pPriorSelectCol==pItem[-1].pExpr->pLeft );
1382b163748eSdrh         pNewExpr->pLeft = pPriorSelectCol;
138347073f62Sdrh       }
138447073f62Sdrh     }
138517435752Sdrh     pItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
1386b7916a78Sdrh     pItem->zSpan = sqlite3DbStrDup(db, pOldItem->zSpan);
1387145716b3Sdrh     pItem->sortOrder = pOldItem->sortOrder;
13883e7bc9caSdrh     pItem->done = 0;
13892c036cffSdrh     pItem->bSpanIsTab = pOldItem->bSpanIsTab;
139024e25d32Sdan     pItem->bSorterRef = pOldItem->bSorterRef;
1391c2acc4e4Sdrh     pItem->u = pOldItem->u;
1392ff78bd2fSdrh   }
1393ff78bd2fSdrh   return pNew;
1394ff78bd2fSdrh }
139593758c8dSdanielk1977 
139693758c8dSdanielk1977 /*
139793758c8dSdanielk1977 ** If cursors, triggers, views and subqueries are all omitted from
139893758c8dSdanielk1977 ** the build, then none of the following routines, except for
139993758c8dSdanielk1977 ** sqlite3SelectDup(), can be called. sqlite3SelectDup() is sometimes
140093758c8dSdanielk1977 ** called with a NULL argument.
140193758c8dSdanielk1977 */
14026a67fe8eSdanielk1977 #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_TRIGGER) \
14036a67fe8eSdanielk1977  || !defined(SQLITE_OMIT_SUBQUERY)
14046ab3a2ecSdanielk1977 SrcList *sqlite3SrcListDup(sqlite3 *db, SrcList *p, int flags){
1405ad3cab52Sdrh   SrcList *pNew;
1406ad3cab52Sdrh   int i;
1407113088ecSdrh   int nByte;
1408575fad65Sdrh   assert( db!=0 );
1409ad3cab52Sdrh   if( p==0 ) return 0;
1410113088ecSdrh   nByte = sizeof(*p) + (p->nSrc>0 ? sizeof(p->a[0]) * (p->nSrc-1) : 0);
1411575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, nByte );
1412ad3cab52Sdrh   if( pNew==0 ) return 0;
14134305d103Sdrh   pNew->nSrc = pNew->nAlloc = p->nSrc;
1414ad3cab52Sdrh   for(i=0; i<p->nSrc; i++){
14154efc4754Sdrh     struct SrcList_item *pNewItem = &pNew->a[i];
14164efc4754Sdrh     struct SrcList_item *pOldItem = &p->a[i];
1417ed8a3bb1Sdrh     Table *pTab;
141841fb5cd1Sdan     pNewItem->pSchema = pOldItem->pSchema;
141917435752Sdrh     pNewItem->zDatabase = sqlite3DbStrDup(db, pOldItem->zDatabase);
142017435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
142117435752Sdrh     pNewItem->zAlias = sqlite3DbStrDup(db, pOldItem->zAlias);
14228a48b9c0Sdrh     pNewItem->fg = pOldItem->fg;
14234efc4754Sdrh     pNewItem->iCursor = pOldItem->iCursor;
14245b6a9ed4Sdrh     pNewItem->addrFillSub = pOldItem->addrFillSub;
14255b6a9ed4Sdrh     pNewItem->regReturn = pOldItem->regReturn;
14268a48b9c0Sdrh     if( pNewItem->fg.isIndexedBy ){
14278a48b9c0Sdrh       pNewItem->u1.zIndexedBy = sqlite3DbStrDup(db, pOldItem->u1.zIndexedBy);
14288a48b9c0Sdrh     }
14298a48b9c0Sdrh     pNewItem->pIBIndex = pOldItem->pIBIndex;
14308a48b9c0Sdrh     if( pNewItem->fg.isTabFunc ){
14318a48b9c0Sdrh       pNewItem->u1.pFuncArg =
14328a48b9c0Sdrh           sqlite3ExprListDup(db, pOldItem->u1.pFuncArg, flags);
14338a48b9c0Sdrh     }
1434ed8a3bb1Sdrh     pTab = pNewItem->pTab = pOldItem->pTab;
1435ed8a3bb1Sdrh     if( pTab ){
143679df7782Sdrh       pTab->nTabRef++;
1437a1cb183dSdanielk1977     }
14386ab3a2ecSdanielk1977     pNewItem->pSelect = sqlite3SelectDup(db, pOldItem->pSelect, flags);
14396ab3a2ecSdanielk1977     pNewItem->pOn = sqlite3ExprDup(db, pOldItem->pOn, flags);
144017435752Sdrh     pNewItem->pUsing = sqlite3IdListDup(db, pOldItem->pUsing);
14416c18b6e0Sdanielk1977     pNewItem->colUsed = pOldItem->colUsed;
1442ad3cab52Sdrh   }
1443ad3cab52Sdrh   return pNew;
1444ad3cab52Sdrh }
144517435752Sdrh IdList *sqlite3IdListDup(sqlite3 *db, IdList *p){
1446ff78bd2fSdrh   IdList *pNew;
1447ff78bd2fSdrh   int i;
1448575fad65Sdrh   assert( db!=0 );
1449ff78bd2fSdrh   if( p==0 ) return 0;
1450575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, sizeof(*pNew) );
1451ff78bd2fSdrh   if( pNew==0 ) return 0;
14526c535158Sdrh   pNew->nId = p->nId;
1453575fad65Sdrh   pNew->a = sqlite3DbMallocRawNN(db, p->nId*sizeof(p->a[0]) );
1454d5d56523Sdanielk1977   if( pNew->a==0 ){
1455dbd6a7dcSdrh     sqlite3DbFreeNN(db, pNew);
1456d5d56523Sdanielk1977     return 0;
1457d5d56523Sdanielk1977   }
14586c535158Sdrh   /* Note that because the size of the allocation for p->a[] is not
14596c535158Sdrh   ** necessarily a power of two, sqlite3IdListAppend() may not be called
14606c535158Sdrh   ** on the duplicate created by this function. */
1461ff78bd2fSdrh   for(i=0; i<p->nId; i++){
14624efc4754Sdrh     struct IdList_item *pNewItem = &pNew->a[i];
14634efc4754Sdrh     struct IdList_item *pOldItem = &p->a[i];
146417435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
14654efc4754Sdrh     pNewItem->idx = pOldItem->idx;
1466ff78bd2fSdrh   }
1467ff78bd2fSdrh   return pNew;
1468ff78bd2fSdrh }
1469a7466205Sdan Select *sqlite3SelectDup(sqlite3 *db, Select *pDup, int flags){
1470a7466205Sdan   Select *pRet = 0;
1471a7466205Sdan   Select *pNext = 0;
1472a7466205Sdan   Select **pp = &pRet;
1473a7466205Sdan   Select *p;
1474a7466205Sdan 
1475575fad65Sdrh   assert( db!=0 );
1476a7466205Sdan   for(p=pDup; p; p=p->pPrior){
1477a7466205Sdan     Select *pNew = sqlite3DbMallocRawNN(db, sizeof(*p) );
1478a7466205Sdan     if( pNew==0 ) break;
1479b7916a78Sdrh     pNew->pEList = sqlite3ExprListDup(db, p->pEList, flags);
14806ab3a2ecSdanielk1977     pNew->pSrc = sqlite3SrcListDup(db, p->pSrc, flags);
14816ab3a2ecSdanielk1977     pNew->pWhere = sqlite3ExprDup(db, p->pWhere, flags);
14826ab3a2ecSdanielk1977     pNew->pGroupBy = sqlite3ExprListDup(db, p->pGroupBy, flags);
14836ab3a2ecSdanielk1977     pNew->pHaving = sqlite3ExprDup(db, p->pHaving, flags);
14846ab3a2ecSdanielk1977     pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, flags);
1485ff78bd2fSdrh     pNew->op = p->op;
1486a7466205Sdan     pNew->pNext = pNext;
1487a7466205Sdan     pNew->pPrior = 0;
14886ab3a2ecSdanielk1977     pNew->pLimit = sqlite3ExprDup(db, p->pLimit, flags);
148992b01d53Sdrh     pNew->iLimit = 0;
149092b01d53Sdrh     pNew->iOffset = 0;
14917d10d5a6Sdrh     pNew->selFlags = p->selFlags & ~SF_UsesEphemeral;
1492b9bb7c18Sdrh     pNew->addrOpenEphm[0] = -1;
1493b9bb7c18Sdrh     pNew->addrOpenEphm[1] = -1;
1494ec2da854Sdrh     pNew->nSelectRow = p->nSelectRow;
14954e9119d9Sdan     pNew->pWith = withDup(db, p->pWith);
1496*2e362f97Sdan     pNew->pWin = 0;
1497eb9b884cSdrh     sqlite3SelectSetName(pNew, p->zSelName);
1498a7466205Sdan     *pp = pNew;
1499a7466205Sdan     pp = &pNew->pPrior;
1500a7466205Sdan     pNext = pNew;
1501a7466205Sdan   }
1502a7466205Sdan 
1503a7466205Sdan   return pRet;
1504ff78bd2fSdrh }
150593758c8dSdanielk1977 #else
15066ab3a2ecSdanielk1977 Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
150793758c8dSdanielk1977   assert( p==0 );
150893758c8dSdanielk1977   return 0;
150993758c8dSdanielk1977 }
151093758c8dSdanielk1977 #endif
1511ff78bd2fSdrh 
1512ff78bd2fSdrh 
1513ff78bd2fSdrh /*
1514a76b5dfcSdrh ** Add a new element to the end of an expression list.  If pList is
1515a76b5dfcSdrh ** initially NULL, then create a new expression list.
1516b7916a78Sdrh **
1517a19543feSdrh ** The pList argument must be either NULL or a pointer to an ExprList
1518a19543feSdrh ** obtained from a prior call to sqlite3ExprListAppend().  This routine
1519a19543feSdrh ** may not be used with an ExprList obtained from sqlite3ExprListDup().
1520a19543feSdrh ** Reason:  This routine assumes that the number of slots in pList->a[]
1521a19543feSdrh ** is a power of two.  That is true for sqlite3ExprListAppend() returns
1522a19543feSdrh ** but is not necessarily true from the return value of sqlite3ExprListDup().
1523a19543feSdrh **
1524b7916a78Sdrh ** If a memory allocation error occurs, the entire list is freed and
1525b7916a78Sdrh ** NULL is returned.  If non-NULL is returned, then it is guaranteed
1526b7916a78Sdrh ** that the new entry was successfully appended.
1527a76b5dfcSdrh */
152817435752Sdrh ExprList *sqlite3ExprListAppend(
152917435752Sdrh   Parse *pParse,          /* Parsing context */
153017435752Sdrh   ExprList *pList,        /* List to which to append. Might be NULL */
1531b7916a78Sdrh   Expr *pExpr             /* Expression to be appended. Might be NULL */
153217435752Sdrh ){
153343606175Sdrh   struct ExprList_item *pItem;
153417435752Sdrh   sqlite3 *db = pParse->db;
1535575fad65Sdrh   assert( db!=0 );
1536a76b5dfcSdrh   if( pList==0 ){
1537575fad65Sdrh     pList = sqlite3DbMallocRawNN(db, sizeof(ExprList) );
1538a76b5dfcSdrh     if( pList==0 ){
1539d5d56523Sdanielk1977       goto no_mem;
1540a76b5dfcSdrh     }
1541c263f7c4Sdrh     pList->nExpr = 0;
1542a19543feSdrh   }else if( (pList->nExpr & (pList->nExpr-1))==0 ){
154343606175Sdrh     ExprList *pNew;
154443606175Sdrh     pNew = sqlite3DbRealloc(db, pList,
1545a19543feSdrh              sizeof(*pList)+(2*pList->nExpr - 1)*sizeof(pList->a[0]));
154643606175Sdrh     if( pNew==0 ){
1547d5d56523Sdanielk1977       goto no_mem;
1548a76b5dfcSdrh     }
154943606175Sdrh     pList = pNew;
1550a76b5dfcSdrh   }
155143606175Sdrh   pItem = &pList->a[pList->nExpr++];
1552a8b9793cSdrh   assert( offsetof(struct ExprList_item,zName)==sizeof(pItem->pExpr) );
1553a8b9793cSdrh   assert( offsetof(struct ExprList_item,pExpr)==0 );
1554a8b9793cSdrh   memset(&pItem->zName,0,sizeof(*pItem)-offsetof(struct ExprList_item,zName));
1555e94ddc9eSdanielk1977   pItem->pExpr = pExpr;
1556a76b5dfcSdrh   return pList;
1557d5d56523Sdanielk1977 
1558d5d56523Sdanielk1977 no_mem:
1559d5d56523Sdanielk1977   /* Avoid leaking memory if malloc has failed. */
1560633e6d57Sdrh   sqlite3ExprDelete(db, pExpr);
1561633e6d57Sdrh   sqlite3ExprListDelete(db, pList);
1562d5d56523Sdanielk1977   return 0;
1563a76b5dfcSdrh }
1564a76b5dfcSdrh 
1565a76b5dfcSdrh /*
15668762ec19Sdrh ** pColumns and pExpr form a vector assignment which is part of the SET
15678762ec19Sdrh ** clause of an UPDATE statement.  Like this:
1568a1251bc4Sdrh **
1569a1251bc4Sdrh **        (a,b,c) = (expr1,expr2,expr3)
1570a1251bc4Sdrh ** Or:    (a,b,c) = (SELECT x,y,z FROM ....)
1571a1251bc4Sdrh **
1572a1251bc4Sdrh ** For each term of the vector assignment, append new entries to the
1573b67343d0Sdrh ** expression list pList.  In the case of a subquery on the RHS, append
1574a1251bc4Sdrh ** TK_SELECT_COLUMN expressions.
1575a1251bc4Sdrh */
1576a1251bc4Sdrh ExprList *sqlite3ExprListAppendVector(
1577a1251bc4Sdrh   Parse *pParse,         /* Parsing context */
1578a1251bc4Sdrh   ExprList *pList,       /* List to which to append. Might be NULL */
1579a1251bc4Sdrh   IdList *pColumns,      /* List of names of LHS of the assignment */
1580a1251bc4Sdrh   Expr *pExpr            /* Vector expression to be appended. Might be NULL */
1581a1251bc4Sdrh ){
1582a1251bc4Sdrh   sqlite3 *db = pParse->db;
1583a1251bc4Sdrh   int n;
1584a1251bc4Sdrh   int i;
158566860af3Sdrh   int iFirst = pList ? pList->nExpr : 0;
1586321e828dSdrh   /* pColumns can only be NULL due to an OOM but an OOM will cause an
1587321e828dSdrh   ** exit prior to this routine being invoked */
1588321e828dSdrh   if( NEVER(pColumns==0) ) goto vector_append_error;
1589a1251bc4Sdrh   if( pExpr==0 ) goto vector_append_error;
1590966e2911Sdrh 
1591966e2911Sdrh   /* If the RHS is a vector, then we can immediately check to see that
1592966e2911Sdrh   ** the size of the RHS and LHS match.  But if the RHS is a SELECT,
1593966e2911Sdrh   ** wildcards ("*") in the result set of the SELECT must be expanded before
1594966e2911Sdrh   ** we can do the size check, so defer the size check until code generation.
1595966e2911Sdrh   */
1596966e2911Sdrh   if( pExpr->op!=TK_SELECT && pColumns->nId!=(n=sqlite3ExprVectorSize(pExpr)) ){
1597a1251bc4Sdrh     sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
1598a1251bc4Sdrh                     pColumns->nId, n);
1599a1251bc4Sdrh     goto vector_append_error;
1600a1251bc4Sdrh   }
1601966e2911Sdrh 
1602966e2911Sdrh   for(i=0; i<pColumns->nId; i++){
1603a1251bc4Sdrh     Expr *pSubExpr = sqlite3ExprForVectorField(pParse, pExpr, i);
1604a1251bc4Sdrh     pList = sqlite3ExprListAppend(pParse, pList, pSubExpr);
1605a1251bc4Sdrh     if( pList ){
160666860af3Sdrh       assert( pList->nExpr==iFirst+i+1 );
1607a1251bc4Sdrh       pList->a[pList->nExpr-1].zName = pColumns->a[i].zName;
1608a1251bc4Sdrh       pColumns->a[i].zName = 0;
1609a1251bc4Sdrh     }
1610a1251bc4Sdrh   }
1611966e2911Sdrh 
1612ffe28059Sdrh   if( !db->mallocFailed && pExpr->op==TK_SELECT && ALWAYS(pList!=0) ){
1613966e2911Sdrh     Expr *pFirst = pList->a[iFirst].pExpr;
1614f4dd26c5Sdrh     assert( pFirst!=0 );
1615966e2911Sdrh     assert( pFirst->op==TK_SELECT_COLUMN );
1616966e2911Sdrh 
1617966e2911Sdrh     /* Store the SELECT statement in pRight so it will be deleted when
1618966e2911Sdrh     ** sqlite3ExprListDelete() is called */
1619966e2911Sdrh     pFirst->pRight = pExpr;
1620a1251bc4Sdrh     pExpr = 0;
1621966e2911Sdrh 
1622966e2911Sdrh     /* Remember the size of the LHS in iTable so that we can check that
1623966e2911Sdrh     ** the RHS and LHS sizes match during code generation. */
1624966e2911Sdrh     pFirst->iTable = pColumns->nId;
1625a1251bc4Sdrh   }
1626a1251bc4Sdrh 
1627a1251bc4Sdrh vector_append_error:
1628a1251bc4Sdrh   sqlite3ExprDelete(db, pExpr);
1629a1251bc4Sdrh   sqlite3IdListDelete(db, pColumns);
1630a1251bc4Sdrh   return pList;
1631a1251bc4Sdrh }
1632a1251bc4Sdrh 
1633a1251bc4Sdrh /*
1634bc622bc0Sdrh ** Set the sort order for the last element on the given ExprList.
1635bc622bc0Sdrh */
1636bc622bc0Sdrh void sqlite3ExprListSetSortOrder(ExprList *p, int iSortOrder){
1637bc622bc0Sdrh   if( p==0 ) return;
1638bc622bc0Sdrh   assert( SQLITE_SO_UNDEFINED<0 && SQLITE_SO_ASC>=0 && SQLITE_SO_DESC>0 );
1639bc622bc0Sdrh   assert( p->nExpr>0 );
1640bc622bc0Sdrh   if( iSortOrder<0 ){
1641bc622bc0Sdrh     assert( p->a[p->nExpr-1].sortOrder==SQLITE_SO_ASC );
1642bc622bc0Sdrh     return;
1643bc622bc0Sdrh   }
1644bc622bc0Sdrh   p->a[p->nExpr-1].sortOrder = (u8)iSortOrder;
1645bc622bc0Sdrh }
1646bc622bc0Sdrh 
1647bc622bc0Sdrh /*
1648b7916a78Sdrh ** Set the ExprList.a[].zName element of the most recently added item
1649b7916a78Sdrh ** on the expression list.
1650b7916a78Sdrh **
1651b7916a78Sdrh ** pList might be NULL following an OOM error.  But pName should never be
1652b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1653b7916a78Sdrh ** is set.
1654b7916a78Sdrh */
1655b7916a78Sdrh void sqlite3ExprListSetName(
1656b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1657b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
1658b7916a78Sdrh   Token *pName,           /* Name to be added */
1659b7916a78Sdrh   int dequote             /* True to cause the name to be dequoted */
1660b7916a78Sdrh ){
1661b7916a78Sdrh   assert( pList!=0 || pParse->db->mallocFailed!=0 );
1662b7916a78Sdrh   if( pList ){
1663b7916a78Sdrh     struct ExprList_item *pItem;
1664b7916a78Sdrh     assert( pList->nExpr>0 );
1665b7916a78Sdrh     pItem = &pList->a[pList->nExpr-1];
1666b7916a78Sdrh     assert( pItem->zName==0 );
1667b7916a78Sdrh     pItem->zName = sqlite3DbStrNDup(pParse->db, pName->z, pName->n);
1668244b9d6eSdrh     if( dequote ) sqlite3Dequote(pItem->zName);
1669b7916a78Sdrh   }
1670b7916a78Sdrh }
1671b7916a78Sdrh 
1672b7916a78Sdrh /*
1673b7916a78Sdrh ** Set the ExprList.a[].zSpan element of the most recently added item
1674b7916a78Sdrh ** on the expression list.
1675b7916a78Sdrh **
1676b7916a78Sdrh ** pList might be NULL following an OOM error.  But pSpan should never be
1677b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1678b7916a78Sdrh ** is set.
1679b7916a78Sdrh */
1680b7916a78Sdrh void sqlite3ExprListSetSpan(
1681b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1682b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
16831be266baSdrh   const char *zStart,     /* Start of the span */
16841be266baSdrh   const char *zEnd        /* End of the span */
1685b7916a78Sdrh ){
1686b7916a78Sdrh   sqlite3 *db = pParse->db;
1687b7916a78Sdrh   assert( pList!=0 || db->mallocFailed!=0 );
1688b7916a78Sdrh   if( pList ){
1689b7916a78Sdrh     struct ExprList_item *pItem = &pList->a[pList->nExpr-1];
1690b7916a78Sdrh     assert( pList->nExpr>0 );
1691b7916a78Sdrh     sqlite3DbFree(db, pItem->zSpan);
16929b2e0435Sdrh     pItem->zSpan = sqlite3DbSpanDup(db, zStart, zEnd);
1693b7916a78Sdrh   }
1694b7916a78Sdrh }
1695b7916a78Sdrh 
1696b7916a78Sdrh /*
16977a15a4beSdanielk1977 ** If the expression list pEList contains more than iLimit elements,
16987a15a4beSdanielk1977 ** leave an error message in pParse.
16997a15a4beSdanielk1977 */
17007a15a4beSdanielk1977 void sqlite3ExprListCheckLength(
17017a15a4beSdanielk1977   Parse *pParse,
17027a15a4beSdanielk1977   ExprList *pEList,
17037a15a4beSdanielk1977   const char *zObject
17047a15a4beSdanielk1977 ){
1705b1a6c3c1Sdrh   int mx = pParse->db->aLimit[SQLITE_LIMIT_COLUMN];
1706c5499befSdrh   testcase( pEList && pEList->nExpr==mx );
1707c5499befSdrh   testcase( pEList && pEList->nExpr==mx+1 );
1708b1a6c3c1Sdrh   if( pEList && pEList->nExpr>mx ){
17097a15a4beSdanielk1977     sqlite3ErrorMsg(pParse, "too many columns in %s", zObject);
17107a15a4beSdanielk1977   }
17117a15a4beSdanielk1977 }
17127a15a4beSdanielk1977 
17137a15a4beSdanielk1977 /*
1714a76b5dfcSdrh ** Delete an entire expression list.
1715a76b5dfcSdrh */
1716affa855cSdrh static SQLITE_NOINLINE void exprListDeleteNN(sqlite3 *db, ExprList *pList){
1717ac48b751Sdrh   int i = pList->nExpr;
1718ac48b751Sdrh   struct ExprList_item *pItem =  pList->a;
1719ac48b751Sdrh   assert( pList->nExpr>0 );
1720ac48b751Sdrh   do{
1721633e6d57Sdrh     sqlite3ExprDelete(db, pItem->pExpr);
1722633e6d57Sdrh     sqlite3DbFree(db, pItem->zName);
1723b7916a78Sdrh     sqlite3DbFree(db, pItem->zSpan);
1724ac48b751Sdrh     pItem++;
1725ac48b751Sdrh   }while( --i>0 );
1726dbd6a7dcSdrh   sqlite3DbFreeNN(db, pList);
1727a76b5dfcSdrh }
1728affa855cSdrh void sqlite3ExprListDelete(sqlite3 *db, ExprList *pList){
1729affa855cSdrh   if( pList ) exprListDeleteNN(db, pList);
1730affa855cSdrh }
1731a76b5dfcSdrh 
1732a76b5dfcSdrh /*
17332308ed38Sdrh ** Return the bitwise-OR of all Expr.flags fields in the given
17342308ed38Sdrh ** ExprList.
1735885a5b03Sdrh */
17362308ed38Sdrh u32 sqlite3ExprListFlags(const ExprList *pList){
1737885a5b03Sdrh   int i;
17382308ed38Sdrh   u32 m = 0;
1739508e2d00Sdrh   assert( pList!=0 );
1740885a5b03Sdrh   for(i=0; i<pList->nExpr; i++){
1741d0c73053Sdrh      Expr *pExpr = pList->a[i].pExpr;
1742de845c2fSdrh      assert( pExpr!=0 );
1743de845c2fSdrh      m |= pExpr->flags;
1744885a5b03Sdrh   }
17452308ed38Sdrh   return m;
1746885a5b03Sdrh }
1747885a5b03Sdrh 
1748885a5b03Sdrh /*
17497e6f980bSdrh ** This is a SELECT-node callback for the expression walker that
17507e6f980bSdrh ** always "fails".  By "fail" in this case, we mean set
17517e6f980bSdrh ** pWalker->eCode to zero and abort.
17527e6f980bSdrh **
17537e6f980bSdrh ** This callback is used by multiple expression walkers.
17547e6f980bSdrh */
17557e6f980bSdrh int sqlite3SelectWalkFail(Walker *pWalker, Select *NotUsed){
17567e6f980bSdrh   UNUSED_PARAMETER(NotUsed);
17577e6f980bSdrh   pWalker->eCode = 0;
17587e6f980bSdrh   return WRC_Abort;
17597e6f980bSdrh }
17607e6f980bSdrh 
17617e6f980bSdrh /*
1762171d16bbSdrh ** If the input expression is an ID with the name "true" or "false"
176396acafbeSdrh ** then convert it into an TK_TRUEFALSE term.  Return non-zero if
176496acafbeSdrh ** the conversion happened, and zero if the expression is unaltered.
1765171d16bbSdrh */
1766171d16bbSdrh int sqlite3ExprIdToTrueFalse(Expr *pExpr){
1767171d16bbSdrh   assert( pExpr->op==TK_ID || pExpr->op==TK_STRING );
1768171d16bbSdrh   if( sqlite3StrICmp(pExpr->u.zToken, "true")==0
1769171d16bbSdrh    || sqlite3StrICmp(pExpr->u.zToken, "false")==0
1770171d16bbSdrh   ){
1771171d16bbSdrh     pExpr->op = TK_TRUEFALSE;
1772171d16bbSdrh     return 1;
1773171d16bbSdrh   }
1774171d16bbSdrh   return 0;
1775171d16bbSdrh }
1776171d16bbSdrh 
177743c4ac8bSdrh /*
177896acafbeSdrh ** The argument must be a TK_TRUEFALSE Expr node.  Return 1 if it is TRUE
177943c4ac8bSdrh ** and 0 if it is FALSE.
178043c4ac8bSdrh */
178196acafbeSdrh int sqlite3ExprTruthValue(const Expr *pExpr){
178243c4ac8bSdrh   assert( pExpr->op==TK_TRUEFALSE );
178343c4ac8bSdrh   assert( sqlite3StrICmp(pExpr->u.zToken,"true")==0
178443c4ac8bSdrh        || sqlite3StrICmp(pExpr->u.zToken,"false")==0 );
178543c4ac8bSdrh   return pExpr->u.zToken[4]==0;
178643c4ac8bSdrh }
178743c4ac8bSdrh 
1788171d16bbSdrh 
1789171d16bbSdrh /*
1790059b2d50Sdrh ** These routines are Walker callbacks used to check expressions to
1791059b2d50Sdrh ** see if they are "constant" for some definition of constant.  The
1792059b2d50Sdrh ** Walker.eCode value determines the type of "constant" we are looking
1793059b2d50Sdrh ** for.
179473b211abSdrh **
17957d10d5a6Sdrh ** These callback routines are used to implement the following:
1796626a879aSdrh **
1797059b2d50Sdrh **     sqlite3ExprIsConstant()                  pWalker->eCode==1
1798059b2d50Sdrh **     sqlite3ExprIsConstantNotJoin()           pWalker->eCode==2
1799fcb9f4f3Sdrh **     sqlite3ExprIsTableConstant()             pWalker->eCode==3
1800059b2d50Sdrh **     sqlite3ExprIsConstantOrFunction()        pWalker->eCode==4 or 5
180187abf5c0Sdrh **
1802059b2d50Sdrh ** In all cases, the callbacks set Walker.eCode=0 and abort if the expression
1803059b2d50Sdrh ** is found to not be a constant.
180487abf5c0Sdrh **
1805feada2dfSdrh ** The sqlite3ExprIsConstantOrFunction() is used for evaluating expressions
1806059b2d50Sdrh ** in a CREATE TABLE statement.  The Walker.eCode value is 5 when parsing
1807059b2d50Sdrh ** an existing schema and 4 when processing a new statement.  A bound
1808feada2dfSdrh ** parameter raises an error for new statements, but is silently converted
1809feada2dfSdrh ** to NULL for existing schemas.  This allows sqlite_master tables that
1810feada2dfSdrh ** contain a bound parameter because they were generated by older versions
1811feada2dfSdrh ** of SQLite to be parsed by newer versions of SQLite without raising a
1812feada2dfSdrh ** malformed schema error.
1813626a879aSdrh */
18147d10d5a6Sdrh static int exprNodeIsConstant(Walker *pWalker, Expr *pExpr){
1815626a879aSdrh 
1816059b2d50Sdrh   /* If pWalker->eCode is 2 then any term of the expression that comes from
1817059b2d50Sdrh   ** the ON or USING clauses of a left join disqualifies the expression
18180a168377Sdrh   ** from being considered constant. */
1819059b2d50Sdrh   if( pWalker->eCode==2 && ExprHasProperty(pExpr, EP_FromJoin) ){
1820059b2d50Sdrh     pWalker->eCode = 0;
18217d10d5a6Sdrh     return WRC_Abort;
18220a168377Sdrh   }
18230a168377Sdrh 
1824626a879aSdrh   switch( pExpr->op ){
1825eb55bd2fSdrh     /* Consider functions to be constant if all their arguments are constant
1826059b2d50Sdrh     ** and either pWalker->eCode==4 or 5 or the function has the
1827059b2d50Sdrh     ** SQLITE_FUNC_CONST flag. */
1828eb55bd2fSdrh     case TK_FUNCTION:
182963f84573Sdrh       if( pWalker->eCode>=4 || ExprHasProperty(pExpr,EP_ConstFunc) ){
1830b1fba286Sdrh         return WRC_Continue;
1831059b2d50Sdrh       }else{
1832059b2d50Sdrh         pWalker->eCode = 0;
1833059b2d50Sdrh         return WRC_Abort;
1834b1fba286Sdrh       }
1835626a879aSdrh     case TK_ID:
1836171d16bbSdrh       /* Convert "true" or "false" in a DEFAULT clause into the
1837171d16bbSdrh       ** appropriate TK_TRUEFALSE operator */
1838e39ef31cSdrh       if( sqlite3ExprIdToTrueFalse(pExpr) ){
1839171d16bbSdrh         return WRC_Prune;
1840171d16bbSdrh       }
1841171d16bbSdrh       /* Fall thru */
1842626a879aSdrh     case TK_COLUMN:
1843626a879aSdrh     case TK_AGG_FUNCTION:
184413449892Sdrh     case TK_AGG_COLUMN:
1845c5499befSdrh       testcase( pExpr->op==TK_ID );
1846c5499befSdrh       testcase( pExpr->op==TK_COLUMN );
1847c5499befSdrh       testcase( pExpr->op==TK_AGG_FUNCTION );
1848c5499befSdrh       testcase( pExpr->op==TK_AGG_COLUMN );
1849059b2d50Sdrh       if( pWalker->eCode==3 && pExpr->iTable==pWalker->u.iCur ){
1850059b2d50Sdrh         return WRC_Continue;
1851f43ce0b4Sdrh       }
1852f43ce0b4Sdrh       /* Fall through */
1853f43ce0b4Sdrh     case TK_IF_NULL_ROW:
18546e341b93Sdrh     case TK_REGISTER:
18559916048bSdrh       testcase( pExpr->op==TK_REGISTER );
1856f43ce0b4Sdrh       testcase( pExpr->op==TK_IF_NULL_ROW );
1857059b2d50Sdrh       pWalker->eCode = 0;
18587d10d5a6Sdrh       return WRC_Abort;
1859feada2dfSdrh     case TK_VARIABLE:
1860059b2d50Sdrh       if( pWalker->eCode==5 ){
1861feada2dfSdrh         /* Silently convert bound parameters that appear inside of CREATE
1862feada2dfSdrh         ** statements into a NULL when parsing the CREATE statement text out
1863feada2dfSdrh         ** of the sqlite_master table */
1864feada2dfSdrh         pExpr->op = TK_NULL;
1865059b2d50Sdrh       }else if( pWalker->eCode==4 ){
1866feada2dfSdrh         /* A bound parameter in a CREATE statement that originates from
1867feada2dfSdrh         ** sqlite3_prepare() causes an error */
1868059b2d50Sdrh         pWalker->eCode = 0;
1869feada2dfSdrh         return WRC_Abort;
1870feada2dfSdrh       }
1871feada2dfSdrh       /* Fall through */
1872626a879aSdrh     default:
18736e341b93Sdrh       testcase( pExpr->op==TK_SELECT ); /* sqlite3SelectWalkFail() disallows */
18746e341b93Sdrh       testcase( pExpr->op==TK_EXISTS ); /* sqlite3SelectWalkFail() disallows */
18757d10d5a6Sdrh       return WRC_Continue;
1876626a879aSdrh   }
1877626a879aSdrh }
1878059b2d50Sdrh static int exprIsConst(Expr *p, int initFlag, int iCur){
18797d10d5a6Sdrh   Walker w;
1880059b2d50Sdrh   w.eCode = initFlag;
18817d10d5a6Sdrh   w.xExprCallback = exprNodeIsConstant;
18827e6f980bSdrh   w.xSelectCallback = sqlite3SelectWalkFail;
1883979dd1beSdrh #ifdef SQLITE_DEBUG
1884979dd1beSdrh   w.xSelectCallback2 = sqlite3SelectWalkAssert2;
1885979dd1beSdrh #endif
1886059b2d50Sdrh   w.u.iCur = iCur;
18877d10d5a6Sdrh   sqlite3WalkExpr(&w, p);
1888059b2d50Sdrh   return w.eCode;
18897d10d5a6Sdrh }
1890626a879aSdrh 
1891626a879aSdrh /*
1892059b2d50Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
1893eb55bd2fSdrh ** and 0 if it involves variables or function calls.
18942398937bSdrh **
18952398937bSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
18962398937bSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
18972398937bSdrh ** a constant.
1898fef5208cSdrh */
18994adee20fSdanielk1977 int sqlite3ExprIsConstant(Expr *p){
1900059b2d50Sdrh   return exprIsConst(p, 1, 0);
1901fef5208cSdrh }
1902fef5208cSdrh 
1903fef5208cSdrh /*
1904059b2d50Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
19050a168377Sdrh ** that does no originate from the ON or USING clauses of a join.
19060a168377Sdrh ** Return 0 if it involves variables or function calls or terms from
19070a168377Sdrh ** an ON or USING clause.
19080a168377Sdrh */
19090a168377Sdrh int sqlite3ExprIsConstantNotJoin(Expr *p){
1910059b2d50Sdrh   return exprIsConst(p, 2, 0);
19110a168377Sdrh }
19120a168377Sdrh 
19130a168377Sdrh /*
1914fcb9f4f3Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
1915059b2d50Sdrh ** for any single row of the table with cursor iCur.  In other words, the
1916059b2d50Sdrh ** expression must not refer to any non-deterministic function nor any
1917059b2d50Sdrh ** table other than iCur.
1918059b2d50Sdrh */
1919059b2d50Sdrh int sqlite3ExprIsTableConstant(Expr *p, int iCur){
1920059b2d50Sdrh   return exprIsConst(p, 3, iCur);
1921059b2d50Sdrh }
1922059b2d50Sdrh 
1923ab31a845Sdan 
1924ab31a845Sdan /*
1925ab31a845Sdan ** sqlite3WalkExpr() callback used by sqlite3ExprIsConstantOrGroupBy().
1926ab31a845Sdan */
1927ab31a845Sdan static int exprNodeIsConstantOrGroupBy(Walker *pWalker, Expr *pExpr){
1928ab31a845Sdan   ExprList *pGroupBy = pWalker->u.pGroupBy;
1929ab31a845Sdan   int i;
1930ab31a845Sdan 
1931ab31a845Sdan   /* Check if pExpr is identical to any GROUP BY term. If so, consider
1932ab31a845Sdan   ** it constant.  */
1933ab31a845Sdan   for(i=0; i<pGroupBy->nExpr; i++){
1934ab31a845Sdan     Expr *p = pGroupBy->a[i].pExpr;
19355aa550cfSdan     if( sqlite3ExprCompare(0, pExpr, p, -1)<2 ){
193670efa84dSdrh       CollSeq *pColl = sqlite3ExprNNCollSeq(pWalker->pParse, p);
193770efa84dSdrh       if( sqlite3_stricmp("BINARY", pColl->zName)==0 ){
1938ab31a845Sdan         return WRC_Prune;
1939ab31a845Sdan       }
1940ab31a845Sdan     }
1941ab31a845Sdan   }
1942ab31a845Sdan 
1943ab31a845Sdan   /* Check if pExpr is a sub-select. If so, consider it variable. */
1944ab31a845Sdan   if( ExprHasProperty(pExpr, EP_xIsSelect) ){
1945ab31a845Sdan     pWalker->eCode = 0;
1946ab31a845Sdan     return WRC_Abort;
1947ab31a845Sdan   }
1948ab31a845Sdan 
1949ab31a845Sdan   return exprNodeIsConstant(pWalker, pExpr);
1950ab31a845Sdan }
1951ab31a845Sdan 
1952ab31a845Sdan /*
1953ab31a845Sdan ** Walk the expression tree passed as the first argument. Return non-zero
1954ab31a845Sdan ** if the expression consists entirely of constants or copies of terms
1955ab31a845Sdan ** in pGroupBy that sort with the BINARY collation sequence.
1956ab314001Sdrh **
1957ab314001Sdrh ** This routine is used to determine if a term of the HAVING clause can
1958ab314001Sdrh ** be promoted into the WHERE clause.  In order for such a promotion to work,
1959ab314001Sdrh ** the value of the HAVING clause term must be the same for all members of
1960ab314001Sdrh ** a "group".  The requirement that the GROUP BY term must be BINARY
1961ab314001Sdrh ** assumes that no other collating sequence will have a finer-grained
1962ab314001Sdrh ** grouping than binary.  In other words (A=B COLLATE binary) implies
1963ab314001Sdrh ** A=B in every other collating sequence.  The requirement that the
1964ab314001Sdrh ** GROUP BY be BINARY is stricter than necessary.  It would also work
1965ab314001Sdrh ** to promote HAVING clauses that use the same alternative collating
1966ab314001Sdrh ** sequence as the GROUP BY term, but that is much harder to check,
1967ab314001Sdrh ** alternative collating sequences are uncommon, and this is only an
1968ab314001Sdrh ** optimization, so we take the easy way out and simply require the
1969ab314001Sdrh ** GROUP BY to use the BINARY collating sequence.
1970ab31a845Sdan */
1971ab31a845Sdan int sqlite3ExprIsConstantOrGroupBy(Parse *pParse, Expr *p, ExprList *pGroupBy){
1972ab31a845Sdan   Walker w;
1973ab31a845Sdan   w.eCode = 1;
1974ab31a845Sdan   w.xExprCallback = exprNodeIsConstantOrGroupBy;
1975979dd1beSdrh   w.xSelectCallback = 0;
1976ab31a845Sdan   w.u.pGroupBy = pGroupBy;
1977ab31a845Sdan   w.pParse = pParse;
1978ab31a845Sdan   sqlite3WalkExpr(&w, p);
1979ab31a845Sdan   return w.eCode;
1980ab31a845Sdan }
1981ab31a845Sdan 
1982059b2d50Sdrh /*
1983059b2d50Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
1984eb55bd2fSdrh ** or a function call with constant arguments.  Return and 0 if there
1985eb55bd2fSdrh ** are any variables.
1986eb55bd2fSdrh **
1987eb55bd2fSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
1988eb55bd2fSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
1989eb55bd2fSdrh ** a constant.
1990eb55bd2fSdrh */
1991feada2dfSdrh int sqlite3ExprIsConstantOrFunction(Expr *p, u8 isInit){
1992feada2dfSdrh   assert( isInit==0 || isInit==1 );
1993059b2d50Sdrh   return exprIsConst(p, 4+isInit, 0);
1994eb55bd2fSdrh }
1995eb55bd2fSdrh 
19965b88bc4bSdrh #ifdef SQLITE_ENABLE_CURSOR_HINTS
19975b88bc4bSdrh /*
19985b88bc4bSdrh ** Walk an expression tree.  Return 1 if the expression contains a
19995b88bc4bSdrh ** subquery of some kind.  Return 0 if there are no subqueries.
20005b88bc4bSdrh */
20015b88bc4bSdrh int sqlite3ExprContainsSubquery(Expr *p){
20025b88bc4bSdrh   Walker w;
2003bec2476aSdrh   w.eCode = 1;
20045b88bc4bSdrh   w.xExprCallback = sqlite3ExprWalkNoop;
20057e6f980bSdrh   w.xSelectCallback = sqlite3SelectWalkFail;
2006979dd1beSdrh #ifdef SQLITE_DEBUG
2007979dd1beSdrh   w.xSelectCallback2 = sqlite3SelectWalkAssert2;
2008979dd1beSdrh #endif
20095b88bc4bSdrh   sqlite3WalkExpr(&w, p);
201007194bffSdrh   return w.eCode==0;
20115b88bc4bSdrh }
20125b88bc4bSdrh #endif
20135b88bc4bSdrh 
2014eb55bd2fSdrh /*
201573b211abSdrh ** If the expression p codes a constant integer that is small enough
2016202b2df7Sdrh ** to fit in a 32-bit integer, return 1 and put the value of the integer
2017202b2df7Sdrh ** in *pValue.  If the expression is not an integer or if it is too big
2018202b2df7Sdrh ** to fit in a signed 32-bit integer, return 0 and leave *pValue unchanged.
2019e4de1febSdrh */
20204adee20fSdanielk1977 int sqlite3ExprIsInteger(Expr *p, int *pValue){
202192b01d53Sdrh   int rc = 0;
2022ba28b5abSdrh   if( p==0 ) return 0;  /* Can only happen following on OOM */
2023cd92e84dSdrh 
2024cd92e84dSdrh   /* If an expression is an integer literal that fits in a signed 32-bit
2025cd92e84dSdrh   ** integer, then the EP_IntValue flag will have already been set */
2026cd92e84dSdrh   assert( p->op!=TK_INTEGER || (p->flags & EP_IntValue)!=0
2027cd92e84dSdrh            || sqlite3GetInt32(p->u.zToken, &rc)==0 );
2028cd92e84dSdrh 
202992b01d53Sdrh   if( p->flags & EP_IntValue ){
203033e619fcSdrh     *pValue = p->u.iValue;
2031e4de1febSdrh     return 1;
2032e4de1febSdrh   }
203392b01d53Sdrh   switch( p->op ){
20344b59ab5eSdrh     case TK_UPLUS: {
203592b01d53Sdrh       rc = sqlite3ExprIsInteger(p->pLeft, pValue);
2036f6e369a1Sdrh       break;
20374b59ab5eSdrh     }
2038e4de1febSdrh     case TK_UMINUS: {
2039e4de1febSdrh       int v;
20404adee20fSdanielk1977       if( sqlite3ExprIsInteger(p->pLeft, &v) ){
2041f6418891Smistachkin         assert( v!=(-2147483647-1) );
2042e4de1febSdrh         *pValue = -v;
204392b01d53Sdrh         rc = 1;
2044e4de1febSdrh       }
2045e4de1febSdrh       break;
2046e4de1febSdrh     }
2047e4de1febSdrh     default: break;
2048e4de1febSdrh   }
204992b01d53Sdrh   return rc;
2050e4de1febSdrh }
2051e4de1febSdrh 
2052e4de1febSdrh /*
2053039fc32eSdrh ** Return FALSE if there is no chance that the expression can be NULL.
2054039fc32eSdrh **
2055039fc32eSdrh ** If the expression might be NULL or if the expression is too complex
2056039fc32eSdrh ** to tell return TRUE.
2057039fc32eSdrh **
2058039fc32eSdrh ** This routine is used as an optimization, to skip OP_IsNull opcodes
2059039fc32eSdrh ** when we know that a value cannot be NULL.  Hence, a false positive
2060039fc32eSdrh ** (returning TRUE when in fact the expression can never be NULL) might
2061039fc32eSdrh ** be a small performance hit but is otherwise harmless.  On the other
2062039fc32eSdrh ** hand, a false negative (returning FALSE when the result could be NULL)
2063039fc32eSdrh ** will likely result in an incorrect answer.  So when in doubt, return
2064039fc32eSdrh ** TRUE.
2065039fc32eSdrh */
2066039fc32eSdrh int sqlite3ExprCanBeNull(const Expr *p){
2067039fc32eSdrh   u8 op;
2068cd7f457eSdrh   while( p->op==TK_UPLUS || p->op==TK_UMINUS ){ p = p->pLeft; }
2069039fc32eSdrh   op = p->op;
2070039fc32eSdrh   if( op==TK_REGISTER ) op = p->op2;
2071039fc32eSdrh   switch( op ){
2072039fc32eSdrh     case TK_INTEGER:
2073039fc32eSdrh     case TK_STRING:
2074039fc32eSdrh     case TK_FLOAT:
2075039fc32eSdrh     case TK_BLOB:
2076039fc32eSdrh       return 0;
20777248a8b2Sdrh     case TK_COLUMN:
207872673a24Sdrh       return ExprHasProperty(p, EP_CanBeNull) ||
20794dd89d5aSdrh              p->pTab==0 ||  /* Reference to column of index on expression */
208072673a24Sdrh              (p->iColumn>=0 && p->pTab->aCol[p->iColumn].notNull==0);
2081039fc32eSdrh     default:
2082039fc32eSdrh       return 1;
2083039fc32eSdrh   }
2084039fc32eSdrh }
2085039fc32eSdrh 
2086039fc32eSdrh /*
2087039fc32eSdrh ** Return TRUE if the given expression is a constant which would be
2088039fc32eSdrh ** unchanged by OP_Affinity with the affinity given in the second
2089039fc32eSdrh ** argument.
2090039fc32eSdrh **
2091039fc32eSdrh ** This routine is used to determine if the OP_Affinity operation
2092039fc32eSdrh ** can be omitted.  When in doubt return FALSE.  A false negative
2093039fc32eSdrh ** is harmless.  A false positive, however, can result in the wrong
2094039fc32eSdrh ** answer.
2095039fc32eSdrh */
2096039fc32eSdrh int sqlite3ExprNeedsNoAffinityChange(const Expr *p, char aff){
2097039fc32eSdrh   u8 op;
209805883a34Sdrh   if( aff==SQLITE_AFF_BLOB ) return 1;
2099cd7f457eSdrh   while( p->op==TK_UPLUS || p->op==TK_UMINUS ){ p = p->pLeft; }
2100039fc32eSdrh   op = p->op;
2101039fc32eSdrh   if( op==TK_REGISTER ) op = p->op2;
2102039fc32eSdrh   switch( op ){
2103039fc32eSdrh     case TK_INTEGER: {
2104039fc32eSdrh       return aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC;
2105039fc32eSdrh     }
2106039fc32eSdrh     case TK_FLOAT: {
2107039fc32eSdrh       return aff==SQLITE_AFF_REAL || aff==SQLITE_AFF_NUMERIC;
2108039fc32eSdrh     }
2109039fc32eSdrh     case TK_STRING: {
2110039fc32eSdrh       return aff==SQLITE_AFF_TEXT;
2111039fc32eSdrh     }
2112039fc32eSdrh     case TK_BLOB: {
2113039fc32eSdrh       return 1;
2114039fc32eSdrh     }
21152f2855b6Sdrh     case TK_COLUMN: {
211688376ca7Sdrh       assert( p->iTable>=0 );  /* p cannot be part of a CHECK constraint */
211788376ca7Sdrh       return p->iColumn<0
21182f2855b6Sdrh           && (aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC);
21192f2855b6Sdrh     }
2120039fc32eSdrh     default: {
2121039fc32eSdrh       return 0;
2122039fc32eSdrh     }
2123039fc32eSdrh   }
2124039fc32eSdrh }
2125039fc32eSdrh 
2126039fc32eSdrh /*
2127c4a3c779Sdrh ** Return TRUE if the given string is a row-id column name.
2128c4a3c779Sdrh */
21294adee20fSdanielk1977 int sqlite3IsRowid(const char *z){
21304adee20fSdanielk1977   if( sqlite3StrICmp(z, "_ROWID_")==0 ) return 1;
21314adee20fSdanielk1977   if( sqlite3StrICmp(z, "ROWID")==0 ) return 1;
21324adee20fSdanielk1977   if( sqlite3StrICmp(z, "OID")==0 ) return 1;
2133c4a3c779Sdrh   return 0;
2134c4a3c779Sdrh }
2135c4a3c779Sdrh 
21369a96b668Sdanielk1977 /*
213769c355bdSdrh ** pX is the RHS of an IN operator.  If pX is a SELECT statement
213869c355bdSdrh ** that can be simplified to a direct table access, then return
213969c355bdSdrh ** a pointer to the SELECT statement.  If pX is not a SELECT statement,
214069c355bdSdrh ** or if the SELECT statement needs to be manifested into a transient
214169c355bdSdrh ** table, then return NULL.
2142b287f4b6Sdrh */
2143b287f4b6Sdrh #ifndef SQLITE_OMIT_SUBQUERY
21447b35a77bSdan static Select *isCandidateForInOpt(Expr *pX){
214569c355bdSdrh   Select *p;
2146b287f4b6Sdrh   SrcList *pSrc;
2147b287f4b6Sdrh   ExprList *pEList;
2148b287f4b6Sdrh   Table *pTab;
2149cfbb5e82Sdan   int i;
215069c355bdSdrh   if( !ExprHasProperty(pX, EP_xIsSelect) ) return 0;  /* Not a subquery */
215169c355bdSdrh   if( ExprHasProperty(pX, EP_VarSelect)  ) return 0;  /* Correlated subq */
215269c355bdSdrh   p = pX->x.pSelect;
2153b287f4b6Sdrh   if( p->pPrior ) return 0;              /* Not a compound SELECT */
21547d10d5a6Sdrh   if( p->selFlags & (SF_Distinct|SF_Aggregate) ){
2155b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
2156b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
21577d10d5a6Sdrh     return 0; /* No DISTINCT keyword and no aggregate functions */
21587d10d5a6Sdrh   }
2159b74b1017Sdrh   assert( p->pGroupBy==0 );              /* Has no GROUP BY clause */
2160b287f4b6Sdrh   if( p->pLimit ) return 0;              /* Has no LIMIT clause */
2161b287f4b6Sdrh   if( p->pWhere ) return 0;              /* Has no WHERE clause */
2162b287f4b6Sdrh   pSrc = p->pSrc;
2163d1fa7bcaSdrh   assert( pSrc!=0 );
2164d1fa7bcaSdrh   if( pSrc->nSrc!=1 ) return 0;          /* Single term in FROM clause */
2165b74b1017Sdrh   if( pSrc->a[0].pSelect ) return 0;     /* FROM is not a subquery or view */
2166b287f4b6Sdrh   pTab = pSrc->a[0].pTab;
216769c355bdSdrh   assert( pTab!=0 );
2168b74b1017Sdrh   assert( pTab->pSelect==0 );            /* FROM clause is not a view */
2169b287f4b6Sdrh   if( IsVirtual(pTab) ) return 0;        /* FROM clause not a virtual table */
2170b287f4b6Sdrh   pEList = p->pEList;
2171ac6b47d1Sdrh   assert( pEList!=0 );
21727b35a77bSdan   /* All SELECT results must be columns. */
2173cfbb5e82Sdan   for(i=0; i<pEList->nExpr; i++){
2174cfbb5e82Sdan     Expr *pRes = pEList->a[i].pExpr;
2175cfbb5e82Sdan     if( pRes->op!=TK_COLUMN ) return 0;
217669c355bdSdrh     assert( pRes->iTable==pSrc->a[0].iCursor );  /* Not a correlated subquery */
2177cfbb5e82Sdan   }
217869c355bdSdrh   return p;
2179b287f4b6Sdrh }
2180b287f4b6Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
2181b287f4b6Sdrh 
2182f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
21831d8cb21fSdan /*
21844c259e9fSdrh ** Generate code that checks the left-most column of index table iCur to see if
21854c259e9fSdrh ** it contains any NULL entries.  Cause the register at regHasNull to be set
21866be515ebSdrh ** to a non-NULL value if iCur contains no NULLs.  Cause register regHasNull
21876be515ebSdrh ** to be set to NULL if iCur contains one or more NULL values.
21886be515ebSdrh */
21896be515ebSdrh static void sqlite3SetHasNullFlag(Vdbe *v, int iCur, int regHasNull){
2190728e0f91Sdrh   int addr1;
21916be515ebSdrh   sqlite3VdbeAddOp2(v, OP_Integer, 0, regHasNull);
2192728e0f91Sdrh   addr1 = sqlite3VdbeAddOp1(v, OP_Rewind, iCur); VdbeCoverage(v);
21936be515ebSdrh   sqlite3VdbeAddOp3(v, OP_Column, iCur, 0, regHasNull);
21946be515ebSdrh   sqlite3VdbeChangeP5(v, OPFLAG_TYPEOFARG);
21954c259e9fSdrh   VdbeComment((v, "first_entry_in(%d)", iCur));
2196728e0f91Sdrh   sqlite3VdbeJumpHere(v, addr1);
21976be515ebSdrh }
2198f9b2e05cSdan #endif
21996be515ebSdrh 
2200bb53ecb1Sdrh 
2201bb53ecb1Sdrh #ifndef SQLITE_OMIT_SUBQUERY
2202bb53ecb1Sdrh /*
2203bb53ecb1Sdrh ** The argument is an IN operator with a list (not a subquery) on the
2204bb53ecb1Sdrh ** right-hand side.  Return TRUE if that list is constant.
2205bb53ecb1Sdrh */
2206bb53ecb1Sdrh static int sqlite3InRhsIsConstant(Expr *pIn){
2207bb53ecb1Sdrh   Expr *pLHS;
2208bb53ecb1Sdrh   int res;
2209bb53ecb1Sdrh   assert( !ExprHasProperty(pIn, EP_xIsSelect) );
2210bb53ecb1Sdrh   pLHS = pIn->pLeft;
2211bb53ecb1Sdrh   pIn->pLeft = 0;
2212bb53ecb1Sdrh   res = sqlite3ExprIsConstant(pIn);
2213bb53ecb1Sdrh   pIn->pLeft = pLHS;
2214bb53ecb1Sdrh   return res;
2215bb53ecb1Sdrh }
2216bb53ecb1Sdrh #endif
2217bb53ecb1Sdrh 
22186be515ebSdrh /*
22199a96b668Sdanielk1977 ** This function is used by the implementation of the IN (...) operator.
2220d4305ca6Sdrh ** The pX parameter is the expression on the RHS of the IN operator, which
2221d4305ca6Sdrh ** might be either a list of expressions or a subquery.
22229a96b668Sdanielk1977 **
2223d4305ca6Sdrh ** The job of this routine is to find or create a b-tree object that can
2224d4305ca6Sdrh ** be used either to test for membership in the RHS set or to iterate through
2225d4305ca6Sdrh ** all members of the RHS set, skipping duplicates.
2226d4305ca6Sdrh **
22273a85625dSdrh ** A cursor is opened on the b-tree object that is the RHS of the IN operator
2228d4305ca6Sdrh ** and pX->iTable is set to the index of that cursor.
2229d4305ca6Sdrh **
2230b74b1017Sdrh ** The returned value of this function indicates the b-tree type, as follows:
22319a96b668Sdanielk1977 **
22329a96b668Sdanielk1977 **   IN_INDEX_ROWID      - The cursor was opened on a database table.
22331ccce449Sdrh **   IN_INDEX_INDEX_ASC  - The cursor was opened on an ascending index.
22341ccce449Sdrh **   IN_INDEX_INDEX_DESC - The cursor was opened on a descending index.
22359a96b668Sdanielk1977 **   IN_INDEX_EPH        - The cursor was opened on a specially created and
22369a96b668Sdanielk1977 **                         populated epheremal table.
2237bb53ecb1Sdrh **   IN_INDEX_NOOP       - No cursor was allocated.  The IN operator must be
2238bb53ecb1Sdrh **                         implemented as a sequence of comparisons.
22399a96b668Sdanielk1977 **
2240d4305ca6Sdrh ** An existing b-tree might be used if the RHS expression pX is a simple
2241d4305ca6Sdrh ** subquery such as:
22429a96b668Sdanielk1977 **
2243553168c7Sdan **     SELECT <column1>, <column2>... FROM <table>
22449a96b668Sdanielk1977 **
2245d4305ca6Sdrh ** If the RHS of the IN operator is a list or a more complex subquery, then
2246d4305ca6Sdrh ** an ephemeral table might need to be generated from the RHS and then
224760ec914cSpeter.d.reid ** pX->iTable made to point to the ephemeral table instead of an
2248d4305ca6Sdrh ** existing table.
2249d4305ca6Sdrh **
22507fc0ba0fSdrh ** The inFlags parameter must contain, at a minimum, one of the bits
22517fc0ba0fSdrh ** IN_INDEX_MEMBERSHIP or IN_INDEX_LOOP but not both.  If inFlags contains
22527fc0ba0fSdrh ** IN_INDEX_MEMBERSHIP, then the generated table will be used for a fast
22537fc0ba0fSdrh ** membership test.  When the IN_INDEX_LOOP bit is set, the IN index will
22547fc0ba0fSdrh ** be used to loop over all values of the RHS of the IN operator.
22553a85625dSdrh **
22563a85625dSdrh ** When IN_INDEX_LOOP is used (and the b-tree will be used to iterate
22573a85625dSdrh ** through the set members) then the b-tree must not contain duplicates.
22587fc0ba0fSdrh ** An epheremal table will be created unless the selected columns are guaranteed
2259553168c7Sdan ** to be unique - either because it is an INTEGER PRIMARY KEY or due to
2260553168c7Sdan ** a UNIQUE constraint or index.
22610cdc022eSdanielk1977 **
22623a85625dSdrh ** When IN_INDEX_MEMBERSHIP is used (and the b-tree will be used
22633a85625dSdrh ** for fast set membership tests) then an epheremal table must
2264553168c7Sdan ** be used unless <columns> is a single INTEGER PRIMARY KEY column or an
2265553168c7Sdan ** index can be found with the specified <columns> as its left-most.
22660cdc022eSdanielk1977 **
2267bb53ecb1Sdrh ** If the IN_INDEX_NOOP_OK and IN_INDEX_MEMBERSHIP are both set and
2268bb53ecb1Sdrh ** if the RHS of the IN operator is a list (not a subquery) then this
2269bb53ecb1Sdrh ** routine might decide that creating an ephemeral b-tree for membership
2270bb53ecb1Sdrh ** testing is too expensive and return IN_INDEX_NOOP.  In that case, the
2271bb53ecb1Sdrh ** calling routine should implement the IN operator using a sequence
2272bb53ecb1Sdrh ** of Eq or Ne comparison operations.
2273bb53ecb1Sdrh **
2274b74b1017Sdrh ** When the b-tree is being used for membership tests, the calling function
22753a85625dSdrh ** might need to know whether or not the RHS side of the IN operator
2276e21a6e1dSdrh ** contains a NULL.  If prRhsHasNull is not a NULL pointer and
22773a85625dSdrh ** if there is any chance that the (...) might contain a NULL value at
22780cdc022eSdanielk1977 ** runtime, then a register is allocated and the register number written
2279e21a6e1dSdrh ** to *prRhsHasNull. If there is no chance that the (...) contains a
2280e21a6e1dSdrh ** NULL value, then *prRhsHasNull is left unchanged.
22810cdc022eSdanielk1977 **
2282e21a6e1dSdrh ** If a register is allocated and its location stored in *prRhsHasNull, then
22836be515ebSdrh ** the value in that register will be NULL if the b-tree contains one or more
22846be515ebSdrh ** NULL values, and it will be some non-NULL value if the b-tree contains no
22856be515ebSdrh ** NULL values.
2286553168c7Sdan **
2287553168c7Sdan ** If the aiMap parameter is not NULL, it must point to an array containing
2288553168c7Sdan ** one element for each column returned by the SELECT statement on the RHS
2289553168c7Sdan ** of the IN(...) operator. The i'th entry of the array is populated with the
2290553168c7Sdan ** offset of the index column that matches the i'th column returned by the
2291553168c7Sdan ** SELECT. For example, if the expression and selected index are:
2292553168c7Sdan **
2293553168c7Sdan **   (?,?,?) IN (SELECT a, b, c FROM t1)
2294553168c7Sdan **   CREATE INDEX i1 ON t1(b, c, a);
2295553168c7Sdan **
2296553168c7Sdan ** then aiMap[] is populated with {2, 0, 1}.
22979a96b668Sdanielk1977 */
2298284f4acaSdanielk1977 #ifndef SQLITE_OMIT_SUBQUERY
2299ba00e30aSdan int sqlite3FindInIndex(
23006fc8f364Sdrh   Parse *pParse,             /* Parsing context */
23016fc8f364Sdrh   Expr *pX,                  /* The right-hand side (RHS) of the IN operator */
23026fc8f364Sdrh   u32 inFlags,               /* IN_INDEX_LOOP, _MEMBERSHIP, and/or _NOOP_OK */
23036fc8f364Sdrh   int *prRhsHasNull,         /* Register holding NULL status.  See notes */
23046fc8f364Sdrh   int *aiMap                 /* Mapping from Index fields to RHS fields */
2305ba00e30aSdan ){
2306b74b1017Sdrh   Select *p;                            /* SELECT to the right of IN operator */
2307b74b1017Sdrh   int eType = 0;                        /* Type of RHS table. IN_INDEX_* */
2308b74b1017Sdrh   int iTab = pParse->nTab++;            /* Cursor of the RHS table */
23093a85625dSdrh   int mustBeUnique;                     /* True if RHS must be unique */
2310b8475df8Sdrh   Vdbe *v = sqlite3GetVdbe(pParse);     /* Virtual machine being coded */
23119a96b668Sdanielk1977 
23121450bc6eSdrh   assert( pX->op==TK_IN );
23133a85625dSdrh   mustBeUnique = (inFlags & IN_INDEX_LOOP)!=0;
23141450bc6eSdrh 
23157b35a77bSdan   /* If the RHS of this IN(...) operator is a SELECT, and if it matters
23167b35a77bSdan   ** whether or not the SELECT result contains NULL values, check whether
2317870a0705Sdan   ** or not NULL is actually possible (it may not be, for example, due
23187b35a77bSdan   ** to NOT NULL constraints in the schema). If no NULL values are possible,
2319870a0705Sdan   ** set prRhsHasNull to 0 before continuing.  */
23207b35a77bSdan   if( prRhsHasNull && (pX->flags & EP_xIsSelect) ){
23217b35a77bSdan     int i;
23227b35a77bSdan     ExprList *pEList = pX->x.pSelect->pEList;
23237b35a77bSdan     for(i=0; i<pEList->nExpr; i++){
23247b35a77bSdan       if( sqlite3ExprCanBeNull(pEList->a[i].pExpr) ) break;
23257b35a77bSdan     }
23267b35a77bSdan     if( i==pEList->nExpr ){
23277b35a77bSdan       prRhsHasNull = 0;
23287b35a77bSdan     }
23297b35a77bSdan   }
23307b35a77bSdan 
2331b74b1017Sdrh   /* Check to see if an existing table or index can be used to
2332b74b1017Sdrh   ** satisfy the query.  This is preferable to generating a new
23337b35a77bSdan   ** ephemeral table.  */
23347b35a77bSdan   if( pParse->nErr==0 && (p = isCandidateForInOpt(pX))!=0 ){
2335e1fb65a0Sdanielk1977     sqlite3 *db = pParse->db;              /* Database connection */
2336b07028f7Sdrh     Table *pTab;                           /* Table <table>. */
2337ba00e30aSdan     i16 iDb;                               /* Database idx for pTab */
2338cfbb5e82Sdan     ExprList *pEList = p->pEList;
2339cfbb5e82Sdan     int nExpr = pEList->nExpr;
2340e1fb65a0Sdanielk1977 
2341b07028f7Sdrh     assert( p->pEList!=0 );             /* Because of isCandidateForInOpt(p) */
2342b07028f7Sdrh     assert( p->pEList->a[0].pExpr!=0 ); /* Because of isCandidateForInOpt(p) */
2343b07028f7Sdrh     assert( p->pSrc!=0 );               /* Because of isCandidateForInOpt(p) */
2344b07028f7Sdrh     pTab = p->pSrc->a[0].pTab;
2345b07028f7Sdrh 
2346b22f7c83Sdrh     /* Code an OP_Transaction and OP_TableLock for <table>. */
2347e1fb65a0Sdanielk1977     iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
2348e1fb65a0Sdanielk1977     sqlite3CodeVerifySchema(pParse, iDb);
2349e1fb65a0Sdanielk1977     sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
23509a96b668Sdanielk1977 
2351a84a283dSdrh     assert(v);  /* sqlite3GetVdbe() has always been previously called */
2352cfbb5e82Sdan     if( nExpr==1 && pEList->a[0].pExpr->iColumn<0 ){
235362659b2aSdrh       /* The "x IN (SELECT rowid FROM table)" case */
2354511f9e8dSdrh       int iAddr = sqlite3VdbeAddOp0(v, OP_Once);
23557d176105Sdrh       VdbeCoverage(v);
23569a96b668Sdanielk1977 
23579a96b668Sdanielk1977       sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
23589a96b668Sdanielk1977       eType = IN_INDEX_ROWID;
23599a96b668Sdanielk1977 
23609a96b668Sdanielk1977       sqlite3VdbeJumpHere(v, iAddr);
23619a96b668Sdanielk1977     }else{
2362e1fb65a0Sdanielk1977       Index *pIdx;                         /* Iterator variable */
2363cfbb5e82Sdan       int affinity_ok = 1;
2364cfbb5e82Sdan       int i;
2365cfbb5e82Sdan 
2366cfbb5e82Sdan       /* Check that the affinity that will be used to perform each
236762659b2aSdrh       ** comparison is the same as the affinity of each column in table
236862659b2aSdrh       ** on the RHS of the IN operator.  If it not, it is not possible to
236962659b2aSdrh       ** use any index of the RHS table.  */
2370cfbb5e82Sdan       for(i=0; i<nExpr && affinity_ok; i++){
2371fc7f27b9Sdrh         Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2372cfbb5e82Sdan         int iCol = pEList->a[i].pExpr->iColumn;
23730dfa4f6fSdrh         char idxaff = sqlite3TableColumnAffinity(pTab,iCol); /* RHS table */
2374cfbb5e82Sdan         char cmpaff = sqlite3CompareAffinity(pLhs, idxaff);
237562659b2aSdrh         testcase( cmpaff==SQLITE_AFF_BLOB );
237662659b2aSdrh         testcase( cmpaff==SQLITE_AFF_TEXT );
2377cfbb5e82Sdan         switch( cmpaff ){
2378cfbb5e82Sdan           case SQLITE_AFF_BLOB:
2379cfbb5e82Sdan             break;
2380cfbb5e82Sdan           case SQLITE_AFF_TEXT:
238162659b2aSdrh             /* sqlite3CompareAffinity() only returns TEXT if one side or the
238262659b2aSdrh             ** other has no affinity and the other side is TEXT.  Hence,
238362659b2aSdrh             ** the only way for cmpaff to be TEXT is for idxaff to be TEXT
238462659b2aSdrh             ** and for the term on the LHS of the IN to have no affinity. */
238562659b2aSdrh             assert( idxaff==SQLITE_AFF_TEXT );
2386cfbb5e82Sdan             break;
2387cfbb5e82Sdan           default:
2388cfbb5e82Sdan             affinity_ok = sqlite3IsNumericAffinity(idxaff);
2389cfbb5e82Sdan         }
2390cfbb5e82Sdan       }
2391e1fb65a0Sdanielk1977 
2392a84a283dSdrh       if( affinity_ok ){
2393a84a283dSdrh         /* Search for an existing index that will work for this IN operator */
2394a84a283dSdrh         for(pIdx=pTab->pIndex; pIdx && eType==0; pIdx=pIdx->pNext){
2395a84a283dSdrh           Bitmask colUsed;      /* Columns of the index used */
2396a84a283dSdrh           Bitmask mCol;         /* Mask for the current column */
23976fc8f364Sdrh           if( pIdx->nColumn<nExpr ) continue;
2398a84a283dSdrh           /* Maximum nColumn is BMS-2, not BMS-1, so that we can compute
2399a84a283dSdrh           ** BITMASK(nExpr) without overflowing */
2400a84a283dSdrh           testcase( pIdx->nColumn==BMS-2 );
2401a84a283dSdrh           testcase( pIdx->nColumn==BMS-1 );
2402a84a283dSdrh           if( pIdx->nColumn>=BMS-1 ) continue;
24036fc8f364Sdrh           if( mustBeUnique ){
24046fc8f364Sdrh             if( pIdx->nKeyCol>nExpr
24056fc8f364Sdrh              ||(pIdx->nColumn>nExpr && !IsUniqueIndex(pIdx))
24066fc8f364Sdrh             ){
2407a84a283dSdrh               continue;  /* This index is not unique over the IN RHS columns */
2408cfbb5e82Sdan             }
24096fc8f364Sdrh           }
2410cfbb5e82Sdan 
2411a84a283dSdrh           colUsed = 0;   /* Columns of index used so far */
2412cfbb5e82Sdan           for(i=0; i<nExpr; i++){
2413fc7f27b9Sdrh             Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2414cfbb5e82Sdan             Expr *pRhs = pEList->a[i].pExpr;
2415cfbb5e82Sdan             CollSeq *pReq = sqlite3BinaryCompareCollSeq(pParse, pLhs, pRhs);
2416cfbb5e82Sdan             int j;
2417cfbb5e82Sdan 
24186fc8f364Sdrh             assert( pReq!=0 || pRhs->iColumn==XN_ROWID || pParse->nErr );
2419cfbb5e82Sdan             for(j=0; j<nExpr; j++){
2420cfbb5e82Sdan               if( pIdx->aiColumn[j]!=pRhs->iColumn ) continue;
2421cfbb5e82Sdan               assert( pIdx->azColl[j] );
2422106526e1Sdrh               if( pReq!=0 && sqlite3StrICmp(pReq->zName, pIdx->azColl[j])!=0 ){
2423106526e1Sdrh                 continue;
2424106526e1Sdrh               }
2425cfbb5e82Sdan               break;
2426cfbb5e82Sdan             }
2427cfbb5e82Sdan             if( j==nExpr ) break;
2428a84a283dSdrh             mCol = MASKBIT(j);
2429a84a283dSdrh             if( mCol & colUsed ) break; /* Each column used only once */
2430a84a283dSdrh             colUsed |= mCol;
2431ba00e30aSdan             if( aiMap ) aiMap[i] = j;
2432cfbb5e82Sdan           }
2433cfbb5e82Sdan 
2434a84a283dSdrh           assert( i==nExpr || colUsed!=(MASKBIT(nExpr)-1) );
2435a84a283dSdrh           if( colUsed==(MASKBIT(nExpr)-1) ){
2436a84a283dSdrh             /* If we reach this point, that means the index pIdx is usable */
2437511f9e8dSdrh             int iAddr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
2438e2ca99c9Sdrh             ExplainQueryPlan((pParse, 0,
2439e2ca99c9Sdrh                               "USING INDEX %s FOR IN-OPERATOR",pIdx->zName));
24402ec2fb22Sdrh             sqlite3VdbeAddOp3(v, OP_OpenRead, iTab, pIdx->tnum, iDb);
24412ec2fb22Sdrh             sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
2442207872a4Sdanielk1977             VdbeComment((v, "%s", pIdx->zName));
24431ccce449Sdrh             assert( IN_INDEX_INDEX_DESC == IN_INDEX_INDEX_ASC+1 );
24441ccce449Sdrh             eType = IN_INDEX_INDEX_ASC + pIdx->aSortOrder[0];
24459a96b668Sdanielk1977 
24467b35a77bSdan             if( prRhsHasNull ){
24473480bfdaSdan #ifdef SQLITE_ENABLE_COLUMN_USED_MASK
2448cfbb5e82Sdan               i64 mask = (1<<nExpr)-1;
24493480bfdaSdan               sqlite3VdbeAddOp4Dup8(v, OP_ColumnsUsed,
2450cfbb5e82Sdan                   iTab, 0, 0, (u8*)&mask, P4_INT64);
24513480bfdaSdan #endif
2452b80dbdc2Sdrh               *prRhsHasNull = ++pParse->nMem;
24537b35a77bSdan               if( nExpr==1 ){
24546be515ebSdrh                 sqlite3SetHasNullFlag(v, iTab, *prRhsHasNull);
24550cdc022eSdanielk1977               }
24567b35a77bSdan             }
2457552fd454Sdrh             sqlite3VdbeJumpHere(v, iAddr);
24589a96b668Sdanielk1977           }
2459a84a283dSdrh         } /* End loop over indexes */
2460a84a283dSdrh       } /* End if( affinity_ok ) */
2461a84a283dSdrh     } /* End if not an rowid index */
2462a84a283dSdrh   } /* End attempt to optimize using an index */
24639a96b668Sdanielk1977 
2464bb53ecb1Sdrh   /* If no preexisting index is available for the IN clause
2465bb53ecb1Sdrh   ** and IN_INDEX_NOOP is an allowed reply
2466bb53ecb1Sdrh   ** and the RHS of the IN operator is a list, not a subquery
246771c57db0Sdan   ** and the RHS is not constant or has two or fewer terms,
246860ec914cSpeter.d.reid   ** then it is not worth creating an ephemeral table to evaluate
2469bb53ecb1Sdrh   ** the IN operator so return IN_INDEX_NOOP.
2470bb53ecb1Sdrh   */
2471bb53ecb1Sdrh   if( eType==0
2472bb53ecb1Sdrh    && (inFlags & IN_INDEX_NOOP_OK)
2473bb53ecb1Sdrh    && !ExprHasProperty(pX, EP_xIsSelect)
2474bb53ecb1Sdrh    && (!sqlite3InRhsIsConstant(pX) || pX->x.pList->nExpr<=2)
2475bb53ecb1Sdrh   ){
2476bb53ecb1Sdrh     eType = IN_INDEX_NOOP;
2477bb53ecb1Sdrh   }
2478bb53ecb1Sdrh 
24799a96b668Sdanielk1977   if( eType==0 ){
24804387006cSdrh     /* Could not find an existing table or index to use as the RHS b-tree.
2481b74b1017Sdrh     ** We will have to generate an ephemeral table to do the job.
2482b74b1017Sdrh     */
24838e23daf3Sdrh     u32 savedNQueryLoop = pParse->nQueryLoop;
24840cdc022eSdanielk1977     int rMayHaveNull = 0;
248541a05b7bSdanielk1977     eType = IN_INDEX_EPH;
24863a85625dSdrh     if( inFlags & IN_INDEX_LOOP ){
24874a5acf8eSdrh       pParse->nQueryLoop = 0;
2488c5cd1249Sdrh       if( pX->pLeft->iColumn<0 && !ExprHasProperty(pX, EP_xIsSelect) ){
248941a05b7bSdanielk1977         eType = IN_INDEX_ROWID;
24900cdc022eSdanielk1977       }
2491e21a6e1dSdrh     }else if( prRhsHasNull ){
2492e21a6e1dSdrh       *prRhsHasNull = rMayHaveNull = ++pParse->nMem;
2493cf4d38aaSdrh     }
249441a05b7bSdanielk1977     sqlite3CodeSubselect(pParse, pX, rMayHaveNull, eType==IN_INDEX_ROWID);
2495cf4d38aaSdrh     pParse->nQueryLoop = savedNQueryLoop;
24969a96b668Sdanielk1977   }else{
24979a96b668Sdanielk1977     pX->iTable = iTab;
24989a96b668Sdanielk1977   }
2499ba00e30aSdan 
2500ba00e30aSdan   if( aiMap && eType!=IN_INDEX_INDEX_ASC && eType!=IN_INDEX_INDEX_DESC ){
2501ba00e30aSdan     int i, n;
2502ba00e30aSdan     n = sqlite3ExprVectorSize(pX->pLeft);
2503ba00e30aSdan     for(i=0; i<n; i++) aiMap[i] = i;
2504ba00e30aSdan   }
25059a96b668Sdanielk1977   return eType;
25069a96b668Sdanielk1977 }
2507284f4acaSdanielk1977 #endif
2508626a879aSdrh 
2509f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
2510553168c7Sdan /*
2511553168c7Sdan ** Argument pExpr is an (?, ?...) IN(...) expression. This
2512553168c7Sdan ** function allocates and returns a nul-terminated string containing
2513553168c7Sdan ** the affinities to be used for each column of the comparison.
2514553168c7Sdan **
2515553168c7Sdan ** It is the responsibility of the caller to ensure that the returned
2516553168c7Sdan ** string is eventually freed using sqlite3DbFree().
2517553168c7Sdan */
251871c57db0Sdan static char *exprINAffinity(Parse *pParse, Expr *pExpr){
251971c57db0Sdan   Expr *pLeft = pExpr->pLeft;
252071c57db0Sdan   int nVal = sqlite3ExprVectorSize(pLeft);
2521553168c7Sdan   Select *pSelect = (pExpr->flags & EP_xIsSelect) ? pExpr->x.pSelect : 0;
252271c57db0Sdan   char *zRet;
252371c57db0Sdan 
2524553168c7Sdan   assert( pExpr->op==TK_IN );
25255c258dc1Sdrh   zRet = sqlite3DbMallocRaw(pParse->db, nVal+1);
252671c57db0Sdan   if( zRet ){
252771c57db0Sdan     int i;
252871c57db0Sdan     for(i=0; i<nVal; i++){
2529fc7f27b9Sdrh       Expr *pA = sqlite3VectorFieldSubexpr(pLeft, i);
2530553168c7Sdan       char a = sqlite3ExprAffinity(pA);
2531553168c7Sdan       if( pSelect ){
2532553168c7Sdan         zRet[i] = sqlite3CompareAffinity(pSelect->pEList->a[i].pExpr, a);
253371c57db0Sdan       }else{
2534553168c7Sdan         zRet[i] = a;
253571c57db0Sdan       }
253671c57db0Sdan     }
253771c57db0Sdan     zRet[nVal] = '\0';
253871c57db0Sdan   }
253971c57db0Sdan   return zRet;
254071c57db0Sdan }
2541f9b2e05cSdan #endif
254271c57db0Sdan 
25438da209b1Sdan #ifndef SQLITE_OMIT_SUBQUERY
25448da209b1Sdan /*
25458da209b1Sdan ** Load the Parse object passed as the first argument with an error
25468da209b1Sdan ** message of the form:
25478da209b1Sdan **
25488da209b1Sdan **   "sub-select returns N columns - expected M"
25498da209b1Sdan */
25508da209b1Sdan void sqlite3SubselectError(Parse *pParse, int nActual, int nExpect){
25518da209b1Sdan   const char *zFmt = "sub-select returns %d columns - expected %d";
25528da209b1Sdan   sqlite3ErrorMsg(pParse, zFmt, nActual, nExpect);
25538da209b1Sdan }
25548da209b1Sdan #endif
25558da209b1Sdan 
2556626a879aSdrh /*
255744c5604cSdan ** Expression pExpr is a vector that has been used in a context where
255844c5604cSdan ** it is not permitted. If pExpr is a sub-select vector, this routine
255944c5604cSdan ** loads the Parse object with a message of the form:
256044c5604cSdan **
256144c5604cSdan **   "sub-select returns N columns - expected 1"
256244c5604cSdan **
256344c5604cSdan ** Or, if it is a regular scalar vector:
256444c5604cSdan **
256544c5604cSdan **   "row value misused"
256644c5604cSdan */
256744c5604cSdan void sqlite3VectorErrorMsg(Parse *pParse, Expr *pExpr){
256844c5604cSdan #ifndef SQLITE_OMIT_SUBQUERY
256944c5604cSdan   if( pExpr->flags & EP_xIsSelect ){
257044c5604cSdan     sqlite3SubselectError(pParse, pExpr->x.pSelect->pEList->nExpr, 1);
257144c5604cSdan   }else
257244c5604cSdan #endif
257344c5604cSdan   {
257444c5604cSdan     sqlite3ErrorMsg(pParse, "row value misused");
257544c5604cSdan   }
257644c5604cSdan }
257744c5604cSdan 
257844c5604cSdan /*
2579d4187c71Sdrh ** Generate code for scalar subqueries used as a subquery expression, EXISTS,
2580d4187c71Sdrh ** or IN operators.  Examples:
2581626a879aSdrh **
25829cbe6352Sdrh **     (SELECT a FROM b)          -- subquery
25839cbe6352Sdrh **     EXISTS (SELECT a FROM b)   -- EXISTS subquery
25849cbe6352Sdrh **     x IN (4,5,11)              -- IN operator with list on right-hand side
25859cbe6352Sdrh **     x IN (SELECT a FROM b)     -- IN operator with subquery on the right
2586fef5208cSdrh **
25879cbe6352Sdrh ** The pExpr parameter describes the expression that contains the IN
25889cbe6352Sdrh ** operator or subquery.
258941a05b7bSdanielk1977 **
259041a05b7bSdanielk1977 ** If parameter isRowid is non-zero, then expression pExpr is guaranteed
259141a05b7bSdanielk1977 ** to be of the form "<rowid> IN (?, ?, ?)", where <rowid> is a reference
259241a05b7bSdanielk1977 ** to some integer key column of a table B-Tree. In this case, use an
259341a05b7bSdanielk1977 ** intkey B-Tree to store the set of IN(...) values instead of the usual
259441a05b7bSdanielk1977 ** (slower) variable length keys B-Tree.
2595fd773cf9Sdrh **
2596fd773cf9Sdrh ** If rMayHaveNull is non-zero, that means that the operation is an IN
2597fd773cf9Sdrh ** (not a SELECT or EXISTS) and that the RHS might contains NULLs.
25983a85625dSdrh ** All this routine does is initialize the register given by rMayHaveNull
25993a85625dSdrh ** to NULL.  Calling routines will take care of changing this register
26003a85625dSdrh ** value to non-NULL if the RHS is NULL-free.
26011450bc6eSdrh **
26021450bc6eSdrh ** For a SELECT or EXISTS operator, return the register that holds the
260339a11819Sdrh ** result.  For a multi-column SELECT, the result is stored in a contiguous
260439a11819Sdrh ** array of registers and the return value is the register of the left-most
260539a11819Sdrh ** result column.  Return 0 for IN operators or if an error occurs.
2606cce7d176Sdrh */
260751522cd3Sdrh #ifndef SQLITE_OMIT_SUBQUERY
26081450bc6eSdrh int sqlite3CodeSubselect(
2609fd773cf9Sdrh   Parse *pParse,          /* Parsing context */
2610fd773cf9Sdrh   Expr *pExpr,            /* The IN, SELECT, or EXISTS operator */
26116be515ebSdrh   int rHasNullFlag,       /* Register that records whether NULLs exist in RHS */
2612fd773cf9Sdrh   int isRowid             /* If true, LHS of IN operator is a rowid */
261341a05b7bSdanielk1977 ){
26146be515ebSdrh   int jmpIfDynamic = -1;                      /* One-time test address */
26151450bc6eSdrh   int rReg = 0;                           /* Register storing resulting */
2616b3bce662Sdanielk1977   Vdbe *v = sqlite3GetVdbe(pParse);
26171450bc6eSdrh   if( NEVER(v==0) ) return 0;
2618ceea3321Sdrh   sqlite3ExprCachePush(pParse);
2619fc976065Sdanielk1977 
262039a11819Sdrh   /* The evaluation of the IN/EXISTS/SELECT must be repeated every time it
262139a11819Sdrh   ** is encountered if any of the following is true:
262257dbd7b3Sdrh   **
262357dbd7b3Sdrh   **    *  The right-hand side is a correlated subquery
262457dbd7b3Sdrh   **    *  The right-hand side is an expression list containing variables
262557dbd7b3Sdrh   **    *  We are inside a trigger
262657dbd7b3Sdrh   **
262757dbd7b3Sdrh   ** If all of the above are false, then we can run this code just once
262857dbd7b3Sdrh   ** save the results, and reuse the same result on subsequent invocations.
2629b3bce662Sdanielk1977   */
2630c5cd1249Sdrh   if( !ExprHasProperty(pExpr, EP_VarSelect) ){
2631511f9e8dSdrh     jmpIfDynamic = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
2632b3bce662Sdanielk1977   }
2633b3bce662Sdanielk1977 
2634cce7d176Sdrh   switch( pExpr->op ){
2635fef5208cSdrh     case TK_IN: {
2636b9bb7c18Sdrh       int addr;                   /* Address of OP_OpenEphemeral instruction */
2637d4187c71Sdrh       Expr *pLeft = pExpr->pLeft; /* the LHS of the IN operator */
2638323df790Sdrh       KeyInfo *pKeyInfo = 0;      /* Key information */
263971c57db0Sdan       int nVal;                   /* Size of vector pLeft */
2640d3d39e93Sdrh 
264171c57db0Sdan       nVal = sqlite3ExprVectorSize(pLeft);
2642553168c7Sdan       assert( !isRowid || nVal==1 );
2643e014a838Sdanielk1977 
2644e014a838Sdanielk1977       /* Whether this is an 'x IN(SELECT...)' or an 'x IN(<exprlist>)'
26458cff69dfSdrh       ** expression it is handled the same way.  An ephemeral table is
2646553168c7Sdan       ** filled with index keys representing the results from the
2647553168c7Sdan       ** SELECT or the <exprlist>.
2648fef5208cSdrh       **
2649e014a838Sdanielk1977       ** If the 'x' expression is a column value, or the SELECT...
2650e014a838Sdanielk1977       ** statement returns a column value, then the affinity of that
2651e014a838Sdanielk1977       ** column is used to build the index keys. If both 'x' and the
2652e014a838Sdanielk1977       ** SELECT... statement are columns, then numeric affinity is used
2653e014a838Sdanielk1977       ** if either column has NUMERIC or INTEGER affinity. If neither
2654e014a838Sdanielk1977       ** 'x' nor the SELECT... statement are columns, then numeric affinity
2655e014a838Sdanielk1977       ** is used.
2656fef5208cSdrh       */
2657832508b7Sdrh       pExpr->iTable = pParse->nTab++;
265871c57db0Sdan       addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral,
265971c57db0Sdan           pExpr->iTable, (isRowid?0:nVal));
266071c57db0Sdan       pKeyInfo = isRowid ? 0 : sqlite3KeyInfoAlloc(pParse->db, nVal, 1);
2661e014a838Sdanielk1977 
26626ab3a2ecSdanielk1977       if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2663e014a838Sdanielk1977         /* Case 1:     expr IN (SELECT ...)
2664e014a838Sdanielk1977         **
2665e014a838Sdanielk1977         ** Generate code to write the results of the select into the temporary
2666e014a838Sdanielk1977         ** table allocated and opened above.
2667e014a838Sdanielk1977         */
26684387006cSdrh         Select *pSelect = pExpr->x.pSelect;
266971c57db0Sdan         ExprList *pEList = pSelect->pEList;
26701013c932Sdrh 
2671e2ca99c9Sdrh         ExplainQueryPlan((pParse, 1, "%sLIST SUBQUERY",
2672e2ca99c9Sdrh             jmpIfDynamic>=0?"":"CORRELATED "
2673e2ca99c9Sdrh         ));
267441a05b7bSdanielk1977         assert( !isRowid );
267564bcb8cfSdrh         /* If the LHS and RHS of the IN operator do not match, that
267664bcb8cfSdrh         ** error will have been caught long before we reach this point. */
267764bcb8cfSdrh         if( ALWAYS(pEList->nExpr==nVal) ){
267871c57db0Sdan           SelectDest dest;
267971c57db0Sdan           int i;
26801013c932Sdrh           sqlite3SelectDestInit(&dest, SRT_Set, pExpr->iTable);
268171c57db0Sdan           dest.zAffSdst = exprINAffinity(pParse, pExpr);
26824387006cSdrh           pSelect->iLimit = 0;
26834387006cSdrh           testcase( pSelect->selFlags & SF_Distinct );
2684812ea833Sdrh           testcase( pKeyInfo==0 ); /* Caused by OOM in sqlite3KeyInfoAlloc() */
26854387006cSdrh           if( sqlite3Select(pParse, pSelect, &dest) ){
268671c57db0Sdan             sqlite3DbFree(pParse->db, dest.zAffSdst);
26872ec2fb22Sdrh             sqlite3KeyInfoUnref(pKeyInfo);
26881450bc6eSdrh             return 0;
268994ccde58Sdrh           }
269071c57db0Sdan           sqlite3DbFree(pParse->db, dest.zAffSdst);
2691812ea833Sdrh           assert( pKeyInfo!=0 ); /* OOM will cause exit after sqlite3Select() */
26923535ec3eSdrh           assert( pEList!=0 );
26933535ec3eSdrh           assert( pEList->nExpr>0 );
26942ec2fb22Sdrh           assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
269571c57db0Sdan           for(i=0; i<nVal; i++){
2696773d3afaSdan             Expr *p = sqlite3VectorFieldSubexpr(pLeft, i);
269771c57db0Sdan             pKeyInfo->aColl[i] = sqlite3BinaryCompareCollSeq(
269871c57db0Sdan                 pParse, p, pEList->a[i].pExpr
269971c57db0Sdan             );
270071c57db0Sdan           }
270171c57db0Sdan         }
2702a7d2db17Sdrh       }else if( ALWAYS(pExpr->x.pList!=0) ){
2703fef5208cSdrh         /* Case 2:     expr IN (exprlist)
2704fef5208cSdrh         **
2705e014a838Sdanielk1977         ** For each expression, build an index key from the evaluation and
2706e014a838Sdanielk1977         ** store it in the temporary table. If <expr> is a column, then use
2707e014a838Sdanielk1977         ** that columns affinity when building index keys. If <expr> is not
2708e014a838Sdanielk1977         ** a column, use numeric affinity.
2709fef5208cSdrh         */
271071c57db0Sdan         char affinity;            /* Affinity of the LHS of the IN */
2711e014a838Sdanielk1977         int i;
27126ab3a2ecSdanielk1977         ExprList *pList = pExpr->x.pList;
271357dbd7b3Sdrh         struct ExprList_item *pItem;
2714ecc31805Sdrh         int r1, r2, r3;
271571c57db0Sdan         affinity = sqlite3ExprAffinity(pLeft);
2716e014a838Sdanielk1977         if( !affinity ){
271705883a34Sdrh           affinity = SQLITE_AFF_BLOB;
2718e014a838Sdanielk1977         }
2719323df790Sdrh         if( pKeyInfo ){
27202ec2fb22Sdrh           assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
2721323df790Sdrh           pKeyInfo->aColl[0] = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
2722323df790Sdrh         }
2723e014a838Sdanielk1977 
2724e014a838Sdanielk1977         /* Loop through each expression in <exprlist>. */
27252d401ab8Sdrh         r1 = sqlite3GetTempReg(pParse);
27262d401ab8Sdrh         r2 = sqlite3GetTempReg(pParse);
272721cd29abSdan         if( isRowid ) sqlite3VdbeAddOp4(v, OP_Blob, 0, r2, 0, "", P4_STATIC);
272857dbd7b3Sdrh         for(i=pList->nExpr, pItem=pList->a; i>0; i--, pItem++){
272957dbd7b3Sdrh           Expr *pE2 = pItem->pExpr;
2730e05c929bSdrh           int iValToIns;
2731e014a838Sdanielk1977 
273257dbd7b3Sdrh           /* If the expression is not constant then we will need to
273357dbd7b3Sdrh           ** disable the test that was generated above that makes sure
273457dbd7b3Sdrh           ** this code only executes once.  Because for a non-constant
273557dbd7b3Sdrh           ** expression we need to rerun this code each time.
273657dbd7b3Sdrh           */
27376be515ebSdrh           if( jmpIfDynamic>=0 && !sqlite3ExprIsConstant(pE2) ){
27386be515ebSdrh             sqlite3VdbeChangeToNoop(v, jmpIfDynamic);
27396be515ebSdrh             jmpIfDynamic = -1;
27404794b980Sdrh           }
2741e014a838Sdanielk1977 
2742e014a838Sdanielk1977           /* Evaluate the expression and insert it into the temp table */
2743e05c929bSdrh           if( isRowid && sqlite3ExprIsInteger(pE2, &iValToIns) ){
2744e05c929bSdrh             sqlite3VdbeAddOp3(v, OP_InsertInt, pExpr->iTable, r2, iValToIns);
2745e05c929bSdrh           }else{
2746ecc31805Sdrh             r3 = sqlite3ExprCodeTarget(pParse, pE2, r1);
274741a05b7bSdanielk1977             if( isRowid ){
2748e05c929bSdrh               sqlite3VdbeAddOp2(v, OP_MustBeInt, r3,
2749e05c929bSdrh                                 sqlite3VdbeCurrentAddr(v)+2);
2750688852abSdrh               VdbeCoverage(v);
275141a05b7bSdanielk1977               sqlite3VdbeAddOp3(v, OP_Insert, pExpr->iTable, r2, r3);
275241a05b7bSdanielk1977             }else{
2753ecc31805Sdrh               sqlite3VdbeAddOp4(v, OP_MakeRecord, r3, 1, r2, &affinity, 1);
27543c31fc23Sdrh               sqlite3ExprCacheAffinityChange(pParse, r3, 1);
27559b4eaebcSdrh               sqlite3VdbeAddOp4Int(v, OP_IdxInsert, pExpr->iTable, r2, r3, 1);
2756fef5208cSdrh             }
275741a05b7bSdanielk1977           }
2758e05c929bSdrh         }
27592d401ab8Sdrh         sqlite3ReleaseTempReg(pParse, r1);
27602d401ab8Sdrh         sqlite3ReleaseTempReg(pParse, r2);
2761fef5208cSdrh       }
2762323df790Sdrh       if( pKeyInfo ){
27632ec2fb22Sdrh         sqlite3VdbeChangeP4(v, addr, (void *)pKeyInfo, P4_KEYINFO);
276441a05b7bSdanielk1977       }
2765b3bce662Sdanielk1977       break;
2766fef5208cSdrh     }
2767fef5208cSdrh 
276851522cd3Sdrh     case TK_EXISTS:
2769fd773cf9Sdrh     case TK_SELECT:
2770fd773cf9Sdrh     default: {
277139a11819Sdrh       /* Case 3:    (SELECT ... FROM ...)
277239a11819Sdrh       **     or:    EXISTS(SELECT ... FROM ...)
277339a11819Sdrh       **
277439a11819Sdrh       ** For a SELECT, generate code to put the values for all columns of
277539a11819Sdrh       ** the first row into an array of registers and return the index of
277639a11819Sdrh       ** the first register.
277739a11819Sdrh       **
277839a11819Sdrh       ** If this is an EXISTS, write an integer 0 (not exists) or 1 (exists)
277939a11819Sdrh       ** into a register and return that register number.
278039a11819Sdrh       **
278139a11819Sdrh       ** In both cases, the query is augmented with "LIMIT 1".  Any
278239a11819Sdrh       ** preexisting limit is discarded in place of the new LIMIT 1.
2783fef5208cSdrh       */
2784fd773cf9Sdrh       Select *pSel;                         /* SELECT statement to encode */
278539a11819Sdrh       SelectDest dest;                      /* How to deal with SELECT result */
278671c57db0Sdan       int nReg;                             /* Registers to allocate */
27878c0833fbSdrh       Expr *pLimit;                         /* New limit expression */
27881398ad36Sdrh 
2789cf697396Sshane       testcase( pExpr->op==TK_EXISTS );
2790cf697396Sshane       testcase( pExpr->op==TK_SELECT );
2791cf697396Sshane       assert( pExpr->op==TK_EXISTS || pExpr->op==TK_SELECT );
27926ab3a2ecSdanielk1977       assert( ExprHasProperty(pExpr, EP_xIsSelect) );
279371c57db0Sdan 
27946ab3a2ecSdanielk1977       pSel = pExpr->x.pSelect;
2795e2ca99c9Sdrh       ExplainQueryPlan((pParse, 1, "%sSCALAR SUBQUERY",
2796e2ca99c9Sdrh             jmpIfDynamic>=0?"":"CORRELATED "));
279771c57db0Sdan       nReg = pExpr->op==TK_SELECT ? pSel->pEList->nExpr : 1;
279871c57db0Sdan       sqlite3SelectDestInit(&dest, 0, pParse->nMem+1);
279971c57db0Sdan       pParse->nMem += nReg;
280051522cd3Sdrh       if( pExpr->op==TK_SELECT ){
28016c8c8ce0Sdanielk1977         dest.eDest = SRT_Mem;
280253932ce8Sdrh         dest.iSdst = dest.iSDParm;
280371c57db0Sdan         dest.nSdst = nReg;
280471c57db0Sdan         sqlite3VdbeAddOp3(v, OP_Null, 0, dest.iSDParm, dest.iSDParm+nReg-1);
2805d4e70ebdSdrh         VdbeComment((v, "Init subquery result"));
280651522cd3Sdrh       }else{
28076c8c8ce0Sdanielk1977         dest.eDest = SRT_Exists;
28082b596da8Sdrh         sqlite3VdbeAddOp2(v, OP_Integer, 0, dest.iSDParm);
2809d4e70ebdSdrh         VdbeComment((v, "Init EXISTS result"));
281051522cd3Sdrh       }
28118c0833fbSdrh       pLimit = sqlite3ExprAlloc(pParse->db, TK_INTEGER,&sqlite3IntTokens[1], 0);
28128c0833fbSdrh       if( pSel->pLimit ){
28138c0833fbSdrh         sqlite3ExprDelete(pParse->db, pSel->pLimit->pLeft);
28148c0833fbSdrh         pSel->pLimit->pLeft = pLimit;
28158c0833fbSdrh       }else{
28168c0833fbSdrh         pSel->pLimit = sqlite3PExpr(pParse, TK_LIMIT, pLimit, 0);
28178c0833fbSdrh       }
281848b5b041Sdrh       pSel->iLimit = 0;
28197d10d5a6Sdrh       if( sqlite3Select(pParse, pSel, &dest) ){
28201450bc6eSdrh         return 0;
282194ccde58Sdrh       }
28222b596da8Sdrh       rReg = dest.iSDParm;
2823ebb6a65dSdrh       ExprSetVVAProperty(pExpr, EP_NoReduce);
2824b3bce662Sdanielk1977       break;
282519a775c2Sdrh     }
2826cce7d176Sdrh   }
2827b3bce662Sdanielk1977 
28286be515ebSdrh   if( rHasNullFlag ){
28296be515ebSdrh     sqlite3SetHasNullFlag(v, pExpr->iTable, rHasNullFlag);
2830b3bce662Sdanielk1977   }
28316be515ebSdrh 
28326be515ebSdrh   if( jmpIfDynamic>=0 ){
28336be515ebSdrh     sqlite3VdbeJumpHere(v, jmpIfDynamic);
2834b3bce662Sdanielk1977   }
2835d2490904Sdrh   sqlite3ExprCachePop(pParse);
2836fc976065Sdanielk1977 
28371450bc6eSdrh   return rReg;
2838cce7d176Sdrh }
283951522cd3Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
2840cce7d176Sdrh 
2841e3365e6cSdrh #ifndef SQLITE_OMIT_SUBQUERY
2842e3365e6cSdrh /*
28437b35a77bSdan ** Expr pIn is an IN(...) expression. This function checks that the
28447b35a77bSdan ** sub-select on the RHS of the IN() operator has the same number of
28457b35a77bSdan ** columns as the vector on the LHS. Or, if the RHS of the IN() is not
28467b35a77bSdan ** a sub-query, that the LHS is a vector of size 1.
28477b35a77bSdan */
28487b35a77bSdan int sqlite3ExprCheckIN(Parse *pParse, Expr *pIn){
28497b35a77bSdan   int nVector = sqlite3ExprVectorSize(pIn->pLeft);
28507b35a77bSdan   if( (pIn->flags & EP_xIsSelect) ){
28517b35a77bSdan     if( nVector!=pIn->x.pSelect->pEList->nExpr ){
28527b35a77bSdan       sqlite3SubselectError(pParse, pIn->x.pSelect->pEList->nExpr, nVector);
28537b35a77bSdan       return 1;
28547b35a77bSdan     }
28557b35a77bSdan   }else if( nVector!=1 ){
285644c5604cSdan     sqlite3VectorErrorMsg(pParse, pIn->pLeft);
28577b35a77bSdan     return 1;
28587b35a77bSdan   }
28597b35a77bSdan   return 0;
28607b35a77bSdan }
28617b35a77bSdan #endif
28627b35a77bSdan 
28637b35a77bSdan #ifndef SQLITE_OMIT_SUBQUERY
28647b35a77bSdan /*
2865e3365e6cSdrh ** Generate code for an IN expression.
2866e3365e6cSdrh **
2867e3365e6cSdrh **      x IN (SELECT ...)
2868e3365e6cSdrh **      x IN (value, value, ...)
2869e3365e6cSdrh **
2870ecb87ac8Sdrh ** The left-hand side (LHS) is a scalar or vector expression.  The
2871e347d3e8Sdrh ** right-hand side (RHS) is an array of zero or more scalar values, or a
2872e347d3e8Sdrh ** subquery.  If the RHS is a subquery, the number of result columns must
2873e347d3e8Sdrh ** match the number of columns in the vector on the LHS.  If the RHS is
2874e347d3e8Sdrh ** a list of values, the LHS must be a scalar.
2875e347d3e8Sdrh **
2876e347d3e8Sdrh ** The IN operator is true if the LHS value is contained within the RHS.
2877e347d3e8Sdrh ** The result is false if the LHS is definitely not in the RHS.  The
2878e347d3e8Sdrh ** result is NULL if the presence of the LHS in the RHS cannot be
2879e347d3e8Sdrh ** determined due to NULLs.
2880e3365e6cSdrh **
28816be515ebSdrh ** This routine generates code that jumps to destIfFalse if the LHS is not
2882e3365e6cSdrh ** contained within the RHS.  If due to NULLs we cannot determine if the LHS
2883e3365e6cSdrh ** is contained in the RHS then jump to destIfNull.  If the LHS is contained
2884e3365e6cSdrh ** within the RHS then fall through.
2885ecb87ac8Sdrh **
2886ecb87ac8Sdrh ** See the separate in-operator.md documentation file in the canonical
2887ecb87ac8Sdrh ** SQLite source tree for additional information.
2888e3365e6cSdrh */
2889e3365e6cSdrh static void sqlite3ExprCodeIN(
2890e3365e6cSdrh   Parse *pParse,        /* Parsing and code generating context */
2891e3365e6cSdrh   Expr *pExpr,          /* The IN expression */
2892e3365e6cSdrh   int destIfFalse,      /* Jump here if LHS is not contained in the RHS */
2893e3365e6cSdrh   int destIfNull        /* Jump here if the results are unknown due to NULLs */
2894e3365e6cSdrh ){
2895e3365e6cSdrh   int rRhsHasNull = 0;  /* Register that is true if RHS contains NULL values */
2896e3365e6cSdrh   int eType;            /* Type of the RHS */
2897e347d3e8Sdrh   int rLhs;             /* Register(s) holding the LHS values */
2898e347d3e8Sdrh   int rLhsOrig;         /* LHS values prior to reordering by aiMap[] */
2899e3365e6cSdrh   Vdbe *v;              /* Statement under construction */
2900ba00e30aSdan   int *aiMap = 0;       /* Map from vector field to index column */
2901ba00e30aSdan   char *zAff = 0;       /* Affinity string for comparisons */
2902ecb87ac8Sdrh   int nVector;          /* Size of vectors for this IN operator */
290312abf408Sdrh   int iDummy;           /* Dummy parameter to exprCodeVector() */
2904e347d3e8Sdrh   Expr *pLeft;          /* The LHS of the IN operator */
2905ecb87ac8Sdrh   int i;                /* loop counter */
2906e347d3e8Sdrh   int destStep2;        /* Where to jump when NULLs seen in step 2 */
2907e347d3e8Sdrh   int destStep6 = 0;    /* Start of code for Step 6 */
2908e347d3e8Sdrh   int addrTruthOp;      /* Address of opcode that determines the IN is true */
2909e347d3e8Sdrh   int destNotNull;      /* Jump here if a comparison is not true in step 6 */
2910e347d3e8Sdrh   int addrTop;          /* Top of the step-6 loop */
2911e3365e6cSdrh 
2912e347d3e8Sdrh   pLeft = pExpr->pLeft;
29137b35a77bSdan   if( sqlite3ExprCheckIN(pParse, pExpr) ) return;
2914553168c7Sdan   zAff = exprINAffinity(pParse, pExpr);
2915ba00e30aSdan   nVector = sqlite3ExprVectorSize(pExpr->pLeft);
2916ba00e30aSdan   aiMap = (int*)sqlite3DbMallocZero(
2917ba00e30aSdan       pParse->db, nVector*(sizeof(int) + sizeof(char)) + 1
2918ba00e30aSdan   );
2919e347d3e8Sdrh   if( pParse->db->mallocFailed ) goto sqlite3ExprCodeIN_oom_error;
29207b35a77bSdan 
2921ba00e30aSdan   /* Attempt to compute the RHS. After this step, if anything other than
2922ba00e30aSdan   ** IN_INDEX_NOOP is returned, the table opened ith cursor pExpr->iTable
2923ba00e30aSdan   ** contains the values that make up the RHS. If IN_INDEX_NOOP is returned,
2924ba00e30aSdan   ** the RHS has not yet been coded.  */
2925e3365e6cSdrh   v = pParse->pVdbe;
2926e3365e6cSdrh   assert( v!=0 );       /* OOM detected prior to this routine */
2927e3365e6cSdrh   VdbeNoopComment((v, "begin IN expr"));
2928bb53ecb1Sdrh   eType = sqlite3FindInIndex(pParse, pExpr,
2929bb53ecb1Sdrh                              IN_INDEX_MEMBERSHIP | IN_INDEX_NOOP_OK,
2930ba00e30aSdan                              destIfFalse==destIfNull ? 0 : &rRhsHasNull, aiMap);
2931e3365e6cSdrh 
2932ba00e30aSdan   assert( pParse->nErr || nVector==1 || eType==IN_INDEX_EPH
2933ba00e30aSdan        || eType==IN_INDEX_INDEX_ASC || eType==IN_INDEX_INDEX_DESC
2934ba00e30aSdan   );
2935ecb87ac8Sdrh #ifdef SQLITE_DEBUG
2936ecb87ac8Sdrh   /* Confirm that aiMap[] contains nVector integer values between 0 and
2937ecb87ac8Sdrh   ** nVector-1. */
2938ecb87ac8Sdrh   for(i=0; i<nVector; i++){
2939ecb87ac8Sdrh     int j, cnt;
2940ecb87ac8Sdrh     for(cnt=j=0; j<nVector; j++) if( aiMap[j]==i ) cnt++;
2941ecb87ac8Sdrh     assert( cnt==1 );
2942ecb87ac8Sdrh   }
2943ecb87ac8Sdrh #endif
2944e3365e6cSdrh 
2945ba00e30aSdan   /* Code the LHS, the <expr> from "<expr> IN (...)". If the LHS is a
2946ba00e30aSdan   ** vector, then it is stored in an array of nVector registers starting
2947ba00e30aSdan   ** at r1.
2948e347d3e8Sdrh   **
2949e347d3e8Sdrh   ** sqlite3FindInIndex() might have reordered the fields of the LHS vector
2950e347d3e8Sdrh   ** so that the fields are in the same order as an existing index.   The
2951e347d3e8Sdrh   ** aiMap[] array contains a mapping from the original LHS field order to
2952e347d3e8Sdrh   ** the field order that matches the RHS index.
2953e3365e6cSdrh   */
2954e3365e6cSdrh   sqlite3ExprCachePush(pParse);
2955e347d3e8Sdrh   rLhsOrig = exprCodeVector(pParse, pLeft, &iDummy);
2956e347d3e8Sdrh   for(i=0; i<nVector && aiMap[i]==i; i++){} /* Are LHS fields reordered? */
2957ecb87ac8Sdrh   if( i==nVector ){
2958e347d3e8Sdrh     /* LHS fields are not reordered */
2959e347d3e8Sdrh     rLhs = rLhsOrig;
2960ecb87ac8Sdrh   }else{
2961ecb87ac8Sdrh     /* Need to reorder the LHS fields according to aiMap */
2962e347d3e8Sdrh     rLhs = sqlite3GetTempRange(pParse, nVector);
2963ba00e30aSdan     for(i=0; i<nVector; i++){
2964e347d3e8Sdrh       sqlite3VdbeAddOp3(v, OP_Copy, rLhsOrig+i, rLhs+aiMap[i], 0);
2965ba00e30aSdan     }
2966ecb87ac8Sdrh   }
2967e3365e6cSdrh 
2968bb53ecb1Sdrh   /* If sqlite3FindInIndex() did not find or create an index that is
2969bb53ecb1Sdrh   ** suitable for evaluating the IN operator, then evaluate using a
2970bb53ecb1Sdrh   ** sequence of comparisons.
2971e347d3e8Sdrh   **
2972e347d3e8Sdrh   ** This is step (1) in the in-operator.md optimized algorithm.
2973bb53ecb1Sdrh   */
2974bb53ecb1Sdrh   if( eType==IN_INDEX_NOOP ){
2975bb53ecb1Sdrh     ExprList *pList = pExpr->x.pList;
2976bb53ecb1Sdrh     CollSeq *pColl = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
2977bb53ecb1Sdrh     int labelOk = sqlite3VdbeMakeLabel(v);
2978bb53ecb1Sdrh     int r2, regToFree;
2979bb53ecb1Sdrh     int regCkNull = 0;
2980bb53ecb1Sdrh     int ii;
2981bb53ecb1Sdrh     assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
2982bb53ecb1Sdrh     if( destIfNull!=destIfFalse ){
2983bb53ecb1Sdrh       regCkNull = sqlite3GetTempReg(pParse);
2984e347d3e8Sdrh       sqlite3VdbeAddOp3(v, OP_BitAnd, rLhs, rLhs, regCkNull);
2985bb53ecb1Sdrh     }
2986bb53ecb1Sdrh     for(ii=0; ii<pList->nExpr; ii++){
2987bb53ecb1Sdrh       r2 = sqlite3ExprCodeTemp(pParse, pList->a[ii].pExpr, &regToFree);
2988a976979bSdrh       if( regCkNull && sqlite3ExprCanBeNull(pList->a[ii].pExpr) ){
2989bb53ecb1Sdrh         sqlite3VdbeAddOp3(v, OP_BitAnd, regCkNull, r2, regCkNull);
2990bb53ecb1Sdrh       }
2991bb53ecb1Sdrh       if( ii<pList->nExpr-1 || destIfNull!=destIfFalse ){
2992e347d3e8Sdrh         sqlite3VdbeAddOp4(v, OP_Eq, rLhs, labelOk, r2,
29934336b0e6Sdrh                           (void*)pColl, P4_COLLSEQ);
29944336b0e6Sdrh         VdbeCoverageIf(v, ii<pList->nExpr-1);
29954336b0e6Sdrh         VdbeCoverageIf(v, ii==pList->nExpr-1);
2996ba00e30aSdan         sqlite3VdbeChangeP5(v, zAff[0]);
2997bb53ecb1Sdrh       }else{
2998bb53ecb1Sdrh         assert( destIfNull==destIfFalse );
2999e347d3e8Sdrh         sqlite3VdbeAddOp4(v, OP_Ne, rLhs, destIfFalse, r2,
3000bb53ecb1Sdrh                           (void*)pColl, P4_COLLSEQ); VdbeCoverage(v);
3001ba00e30aSdan         sqlite3VdbeChangeP5(v, zAff[0] | SQLITE_JUMPIFNULL);
3002bb53ecb1Sdrh       }
3003bb53ecb1Sdrh       sqlite3ReleaseTempReg(pParse, regToFree);
3004bb53ecb1Sdrh     }
3005bb53ecb1Sdrh     if( regCkNull ){
3006bb53ecb1Sdrh       sqlite3VdbeAddOp2(v, OP_IsNull, regCkNull, destIfNull); VdbeCoverage(v);
3007076e85f5Sdrh       sqlite3VdbeGoto(v, destIfFalse);
3008bb53ecb1Sdrh     }
3009bb53ecb1Sdrh     sqlite3VdbeResolveLabel(v, labelOk);
3010bb53ecb1Sdrh     sqlite3ReleaseTempReg(pParse, regCkNull);
3011e347d3e8Sdrh     goto sqlite3ExprCodeIN_finished;
3012e347d3e8Sdrh   }
3013bb53ecb1Sdrh 
3014e347d3e8Sdrh   /* Step 2: Check to see if the LHS contains any NULL columns.  If the
3015e347d3e8Sdrh   ** LHS does contain NULLs then the result must be either FALSE or NULL.
3016e347d3e8Sdrh   ** We will then skip the binary search of the RHS.
3017e347d3e8Sdrh   */
3018094430ebSdrh   if( destIfNull==destIfFalse ){
3019e347d3e8Sdrh     destStep2 = destIfFalse;
3020e347d3e8Sdrh   }else{
3021e347d3e8Sdrh     destStep2 = destStep6 = sqlite3VdbeMakeLabel(v);
3022e347d3e8Sdrh   }
3023d49fd4e8Sdan   for(i=0; i<nVector; i++){
3024fc7f27b9Sdrh     Expr *p = sqlite3VectorFieldSubexpr(pExpr->pLeft, i);
3025d49fd4e8Sdan     if( sqlite3ExprCanBeNull(p) ){
3026e347d3e8Sdrh       sqlite3VdbeAddOp2(v, OP_IsNull, rLhs+i, destStep2);
3027471b4b92Sdrh       VdbeCoverage(v);
3028d49fd4e8Sdan     }
3029d49fd4e8Sdan   }
3030e3365e6cSdrh 
3031e347d3e8Sdrh   /* Step 3.  The LHS is now known to be non-NULL.  Do the binary search
3032e347d3e8Sdrh   ** of the RHS using the LHS as a probe.  If found, the result is
3033e347d3e8Sdrh   ** true.
3034e347d3e8Sdrh   */
3035e3365e6cSdrh   if( eType==IN_INDEX_ROWID ){
3036e347d3e8Sdrh     /* In this case, the RHS is the ROWID of table b-tree and so we also
3037e347d3e8Sdrh     ** know that the RHS is non-NULL.  Hence, we combine steps 3 and 4
3038e347d3e8Sdrh     ** into a single opcode. */
3039e347d3e8Sdrh     sqlite3VdbeAddOp3(v, OP_SeekRowid, pExpr->iTable, destIfFalse, rLhs);
3040688852abSdrh     VdbeCoverage(v);
3041e347d3e8Sdrh     addrTruthOp = sqlite3VdbeAddOp0(v, OP_Goto);  /* Return True */
30427b35a77bSdan   }else{
3043e347d3e8Sdrh     sqlite3VdbeAddOp4(v, OP_Affinity, rLhs, nVector, 0, zAff, nVector);
3044e347d3e8Sdrh     if( destIfFalse==destIfNull ){
3045e347d3e8Sdrh       /* Combine Step 3 and Step 5 into a single opcode */
3046e347d3e8Sdrh       sqlite3VdbeAddOp4Int(v, OP_NotFound, pExpr->iTable, destIfFalse,
3047e347d3e8Sdrh                            rLhs, nVector); VdbeCoverage(v);
3048e347d3e8Sdrh       goto sqlite3ExprCodeIN_finished;
3049e347d3e8Sdrh     }
3050e347d3e8Sdrh     /* Ordinary Step 3, for the case where FALSE and NULL are distinct */
3051e347d3e8Sdrh     addrTruthOp = sqlite3VdbeAddOp4Int(v, OP_Found, pExpr->iTable, 0,
3052e347d3e8Sdrh                                       rLhs, nVector); VdbeCoverage(v);
3053e347d3e8Sdrh   }
3054ba00e30aSdan 
3055e347d3e8Sdrh   /* Step 4.  If the RHS is known to be non-NULL and we did not find
3056e347d3e8Sdrh   ** an match on the search above, then the result must be FALSE.
3057e347d3e8Sdrh   */
3058e347d3e8Sdrh   if( rRhsHasNull && nVector==1 ){
3059e347d3e8Sdrh     sqlite3VdbeAddOp2(v, OP_NotNull, rRhsHasNull, destIfFalse);
3060471b4b92Sdrh     VdbeCoverage(v);
3061e347d3e8Sdrh   }
30627b35a77bSdan 
3063e347d3e8Sdrh   /* Step 5.  If we do not care about the difference between NULL and
3064e347d3e8Sdrh   ** FALSE, then just return false.
3065e347d3e8Sdrh   */
3066e347d3e8Sdrh   if( destIfFalse==destIfNull ) sqlite3VdbeGoto(v, destIfFalse);
3067e347d3e8Sdrh 
3068e347d3e8Sdrh   /* Step 6: Loop through rows of the RHS.  Compare each row to the LHS.
3069e347d3e8Sdrh   ** If any comparison is NULL, then the result is NULL.  If all
3070e347d3e8Sdrh   ** comparisons are FALSE then the final result is FALSE.
3071e347d3e8Sdrh   **
3072e347d3e8Sdrh   ** For a scalar LHS, it is sufficient to check just the first row
3073e347d3e8Sdrh   ** of the RHS.
3074e347d3e8Sdrh   */
3075e347d3e8Sdrh   if( destStep6 ) sqlite3VdbeResolveLabel(v, destStep6);
3076e347d3e8Sdrh   addrTop = sqlite3VdbeAddOp2(v, OP_Rewind, pExpr->iTable, destIfFalse);
3077471b4b92Sdrh   VdbeCoverage(v);
3078e347d3e8Sdrh   if( nVector>1 ){
3079e347d3e8Sdrh     destNotNull = sqlite3VdbeMakeLabel(v);
3080e347d3e8Sdrh   }else{
3081e347d3e8Sdrh     /* For nVector==1, combine steps 6 and 7 by immediately returning
3082e347d3e8Sdrh     ** FALSE if the first comparison is not NULL */
3083e347d3e8Sdrh     destNotNull = destIfFalse;
3084e347d3e8Sdrh   }
3085ba00e30aSdan   for(i=0; i<nVector; i++){
3086ba00e30aSdan     Expr *p;
3087ba00e30aSdan     CollSeq *pColl;
3088e347d3e8Sdrh     int r3 = sqlite3GetTempReg(pParse);
3089fc7f27b9Sdrh     p = sqlite3VectorFieldSubexpr(pLeft, i);
3090ba00e30aSdan     pColl = sqlite3ExprCollSeq(pParse, p);
3091e347d3e8Sdrh     sqlite3VdbeAddOp3(v, OP_Column, pExpr->iTable, i, r3);
3092e347d3e8Sdrh     sqlite3VdbeAddOp4(v, OP_Ne, rLhs+i, destNotNull, r3,
309318016ad2Sdrh                       (void*)pColl, P4_COLLSEQ);
3094471b4b92Sdrh     VdbeCoverage(v);
3095e347d3e8Sdrh     sqlite3ReleaseTempReg(pParse, r3);
30967b35a77bSdan   }
30977b35a77bSdan   sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfNull);
3098e347d3e8Sdrh   if( nVector>1 ){
3099e347d3e8Sdrh     sqlite3VdbeResolveLabel(v, destNotNull);
3100e347d3e8Sdrh     sqlite3VdbeAddOp2(v, OP_Next, pExpr->iTable, addrTop+1);
310118016ad2Sdrh     VdbeCoverage(v);
3102e347d3e8Sdrh 
3103e347d3e8Sdrh     /* Step 7:  If we reach this point, we know that the result must
3104e347d3e8Sdrh     ** be false. */
310518016ad2Sdrh     sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfFalse);
31067b35a77bSdan   }
31077b35a77bSdan 
3108e347d3e8Sdrh   /* Jumps here in order to return true. */
3109e347d3e8Sdrh   sqlite3VdbeJumpHere(v, addrTruthOp);
3110e3365e6cSdrh 
3111e347d3e8Sdrh sqlite3ExprCodeIN_finished:
3112e347d3e8Sdrh   if( rLhs!=rLhsOrig ) sqlite3ReleaseTempReg(pParse, rLhs);
3113d2490904Sdrh   sqlite3ExprCachePop(pParse);
3114ecb87ac8Sdrh   VdbeComment((v, "end IN expr"));
3115e347d3e8Sdrh sqlite3ExprCodeIN_oom_error:
3116ba00e30aSdan   sqlite3DbFree(pParse->db, aiMap);
3117553168c7Sdan   sqlite3DbFree(pParse->db, zAff);
3118e3365e6cSdrh }
3119e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
3120e3365e6cSdrh 
312113573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
3122598f1340Sdrh /*
3123598f1340Sdrh ** Generate an instruction that will put the floating point
31249cbf3425Sdrh ** value described by z[0..n-1] into register iMem.
31250cf19ed8Sdrh **
31260cf19ed8Sdrh ** The z[] string will probably not be zero-terminated.  But the
31270cf19ed8Sdrh ** z[n] character is guaranteed to be something that does not look
31280cf19ed8Sdrh ** like the continuation of the number.
3129598f1340Sdrh */
3130b7916a78Sdrh static void codeReal(Vdbe *v, const char *z, int negateFlag, int iMem){
3131fd773cf9Sdrh   if( ALWAYS(z!=0) ){
3132598f1340Sdrh     double value;
31339339da1fSdrh     sqlite3AtoF(z, &value, sqlite3Strlen30(z), SQLITE_UTF8);
3134d0015161Sdrh     assert( !sqlite3IsNaN(value) ); /* The new AtoF never returns NaN */
3135598f1340Sdrh     if( negateFlag ) value = -value;
313697bae794Sdrh     sqlite3VdbeAddOp4Dup8(v, OP_Real, 0, iMem, 0, (u8*)&value, P4_REAL);
3137598f1340Sdrh   }
3138598f1340Sdrh }
313913573c71Sdrh #endif
3140598f1340Sdrh 
3141598f1340Sdrh 
3142598f1340Sdrh /*
3143fec19aadSdrh ** Generate an instruction that will put the integer describe by
31449cbf3425Sdrh ** text z[0..n-1] into register iMem.
31450cf19ed8Sdrh **
31465f1d6b61Sshaneh ** Expr.u.zToken is always UTF8 and zero-terminated.
3147fec19aadSdrh */
314813573c71Sdrh static void codeInteger(Parse *pParse, Expr *pExpr, int negFlag, int iMem){
314913573c71Sdrh   Vdbe *v = pParse->pVdbe;
315092b01d53Sdrh   if( pExpr->flags & EP_IntValue ){
315133e619fcSdrh     int i = pExpr->u.iValue;
3152d50ffc41Sdrh     assert( i>=0 );
315392b01d53Sdrh     if( negFlag ) i = -i;
315492b01d53Sdrh     sqlite3VdbeAddOp2(v, OP_Integer, i, iMem);
3155fd773cf9Sdrh   }else{
31565f1d6b61Sshaneh     int c;
31575f1d6b61Sshaneh     i64 value;
3158fd773cf9Sdrh     const char *z = pExpr->u.zToken;
3159fd773cf9Sdrh     assert( z!=0 );
31609296c18aSdrh     c = sqlite3DecOrHexToI64(z, &value);
316184d4f1a3Sdrh     if( (c==3 && !negFlag) || (c==2) || (negFlag && value==SMALLEST_INT64)){
316213573c71Sdrh #ifdef SQLITE_OMIT_FLOATING_POINT
316313573c71Sdrh       sqlite3ErrorMsg(pParse, "oversized integer: %s%s", negFlag ? "-" : "", z);
316413573c71Sdrh #else
31651b7ddc59Sdrh #ifndef SQLITE_OMIT_HEX_INTEGER
31669296c18aSdrh       if( sqlite3_strnicmp(z,"0x",2)==0 ){
316777320ea4Sdrh         sqlite3ErrorMsg(pParse, "hex literal too big: %s%s", negFlag?"-":"",z);
31681b7ddc59Sdrh       }else
31691b7ddc59Sdrh #endif
31701b7ddc59Sdrh       {
3171b7916a78Sdrh         codeReal(v, z, negFlag, iMem);
31729296c18aSdrh       }
317313573c71Sdrh #endif
317477320ea4Sdrh     }else{
317584d4f1a3Sdrh       if( negFlag ){ value = c==3 ? SMALLEST_INT64 : -value; }
317677320ea4Sdrh       sqlite3VdbeAddOp4Dup8(v, OP_Int64, 0, iMem, 0, (u8*)&value, P4_INT64);
3177fec19aadSdrh     }
3178fec19aadSdrh   }
3179c9cf901dSdanielk1977 }
3180fec19aadSdrh 
3181bea119cdSdrh /*
31829b40d13fSdrh ** Erase column-cache entry number i
3183bea119cdSdrh */
31849b40d13fSdrh static void cacheEntryClear(Parse *pParse, int i){
31859b40d13fSdrh   if( pParse->aColCache[i].tempReg ){
3186ceea3321Sdrh     if( pParse->nTempReg<ArraySize(pParse->aTempReg) ){
31879b40d13fSdrh       pParse->aTempReg[pParse->nTempReg++] = pParse->aColCache[i].iReg;
3188ceea3321Sdrh     }
3189ceea3321Sdrh   }
3190bea119cdSdrh   pParse->nColCache--;
31919b40d13fSdrh   if( i<pParse->nColCache ){
31929b40d13fSdrh     pParse->aColCache[i] = pParse->aColCache[pParse->nColCache];
31939b40d13fSdrh   }
3194ceea3321Sdrh }
3195ceea3321Sdrh 
3196ceea3321Sdrh 
3197ceea3321Sdrh /*
3198ceea3321Sdrh ** Record in the column cache that a particular column from a
3199ceea3321Sdrh ** particular table is stored in a particular register.
3200ceea3321Sdrh */
3201ceea3321Sdrh void sqlite3ExprCacheStore(Parse *pParse, int iTab, int iCol, int iReg){
3202ceea3321Sdrh   int i;
3203ceea3321Sdrh   int minLru;
3204ceea3321Sdrh   int idxLru;
3205ceea3321Sdrh   struct yColCache *p;
3206ceea3321Sdrh 
3207ce8f53d4Sdan   /* Unless an error has occurred, register numbers are always positive. */
3208ce8f53d4Sdan   assert( iReg>0 || pParse->nErr || pParse->db->mallocFailed );
320920411ea7Sdrh   assert( iCol>=-1 && iCol<32768 );  /* Finite column numbers */
321020411ea7Sdrh 
3211b6da74ebSdrh   /* The SQLITE_ColumnCache flag disables the column cache.  This is used
3212b6da74ebSdrh   ** for testing only - to verify that SQLite always gets the same answer
3213b6da74ebSdrh   ** with and without the column cache.
3214b6da74ebSdrh   */
32157e5418e4Sdrh   if( OptimizationDisabled(pParse->db, SQLITE_ColumnCache) ) return;
3216b6da74ebSdrh 
321727ee406eSdrh   /* First replace any existing entry.
321827ee406eSdrh   **
321927ee406eSdrh   ** Actually, the way the column cache is currently used, we are guaranteed
322027ee406eSdrh   ** that the object will never already be in cache.  Verify this guarantee.
322127ee406eSdrh   */
322227ee406eSdrh #ifndef NDEBUG
32239b40d13fSdrh   for(i=0, p=pParse->aColCache; i<pParse->nColCache; i++, p++){
32249b40d13fSdrh     assert( p->iTable!=iTab || p->iColumn!=iCol );
3225ceea3321Sdrh   }
322627ee406eSdrh #endif
3227ceea3321Sdrh 
32289b40d13fSdrh   /* If the cache is already full, delete the least recently used entry */
32299b40d13fSdrh   if( pParse->nColCache>=SQLITE_N_COLCACHE ){
3230ceea3321Sdrh     minLru = 0x7fffffff;
3231ceea3321Sdrh     idxLru = -1;
3232ceea3321Sdrh     for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
3233ceea3321Sdrh       if( p->lru<minLru ){
3234ceea3321Sdrh         idxLru = i;
3235ceea3321Sdrh         minLru = p->lru;
3236ceea3321Sdrh       }
3237ceea3321Sdrh     }
3238ceea3321Sdrh     p = &pParse->aColCache[idxLru];
32399b40d13fSdrh   }else{
32409b40d13fSdrh     p = &pParse->aColCache[pParse->nColCache++];
32419b40d13fSdrh   }
32429b40d13fSdrh 
32439b40d13fSdrh   /* Add the new entry to the end of the cache */
3244ceea3321Sdrh   p->iLevel = pParse->iCacheLevel;
3245ceea3321Sdrh   p->iTable = iTab;
3246ceea3321Sdrh   p->iColumn = iCol;
3247ceea3321Sdrh   p->iReg = iReg;
3248ceea3321Sdrh   p->tempReg = 0;
3249ceea3321Sdrh   p->lru = pParse->iCacheCnt++;
3250ceea3321Sdrh }
3251ceea3321Sdrh 
3252ceea3321Sdrh /*
3253f49f3523Sdrh ** Indicate that registers between iReg..iReg+nReg-1 are being overwritten.
3254f49f3523Sdrh ** Purge the range of registers from the column cache.
3255ceea3321Sdrh */
3256f49f3523Sdrh void sqlite3ExprCacheRemove(Parse *pParse, int iReg, int nReg){
32579b40d13fSdrh   int i = 0;
32589b40d13fSdrh   while( i<pParse->nColCache ){
32599b40d13fSdrh     struct yColCache *p = &pParse->aColCache[i];
32609b40d13fSdrh     if( p->iReg >= iReg && p->iReg < iReg+nReg ){
32619b40d13fSdrh       cacheEntryClear(pParse, i);
32629b40d13fSdrh     }else{
32639b40d13fSdrh       i++;
32649b40d13fSdrh     }
3265ceea3321Sdrh   }
3266ceea3321Sdrh }
3267ceea3321Sdrh 
3268ceea3321Sdrh /*
3269ceea3321Sdrh ** Remember the current column cache context.  Any new entries added
3270ceea3321Sdrh ** added to the column cache after this call are removed when the
3271ceea3321Sdrh ** corresponding pop occurs.
3272ceea3321Sdrh */
3273ceea3321Sdrh void sqlite3ExprCachePush(Parse *pParse){
3274ceea3321Sdrh   pParse->iCacheLevel++;
32759ac7962aSdrh #ifdef SQLITE_DEBUG
32769ac7962aSdrh   if( pParse->db->flags & SQLITE_VdbeAddopTrace ){
32779ac7962aSdrh     printf("PUSH to %d\n", pParse->iCacheLevel);
32789ac7962aSdrh   }
32799ac7962aSdrh #endif
3280ceea3321Sdrh }
3281ceea3321Sdrh 
3282ceea3321Sdrh /*
3283ceea3321Sdrh ** Remove from the column cache any entries that were added since the
3284d2490904Sdrh ** the previous sqlite3ExprCachePush operation.  In other words, restore
3285d2490904Sdrh ** the cache to the state it was in prior the most recent Push.
3286ceea3321Sdrh */
3287d2490904Sdrh void sqlite3ExprCachePop(Parse *pParse){
32889b40d13fSdrh   int i = 0;
3289d2490904Sdrh   assert( pParse->iCacheLevel>=1 );
3290d2490904Sdrh   pParse->iCacheLevel--;
32919ac7962aSdrh #ifdef SQLITE_DEBUG
32929ac7962aSdrh   if( pParse->db->flags & SQLITE_VdbeAddopTrace ){
32939ac7962aSdrh     printf("POP  to %d\n", pParse->iCacheLevel);
32949ac7962aSdrh   }
32959ac7962aSdrh #endif
32969b40d13fSdrh   while( i<pParse->nColCache ){
32979b40d13fSdrh     if( pParse->aColCache[i].iLevel>pParse->iCacheLevel ){
32989b40d13fSdrh       cacheEntryClear(pParse, i);
32999b40d13fSdrh     }else{
33009b40d13fSdrh       i++;
3301ceea3321Sdrh     }
3302ceea3321Sdrh   }
3303ceea3321Sdrh }
3304945498f3Sdrh 
3305945498f3Sdrh /*
33065cd79239Sdrh ** When a cached column is reused, make sure that its register is
33075cd79239Sdrh ** no longer available as a temp register.  ticket #3879:  that same
33085cd79239Sdrh ** register might be in the cache in multiple places, so be sure to
33095cd79239Sdrh ** get them all.
33105cd79239Sdrh */
33115cd79239Sdrh static void sqlite3ExprCachePinRegister(Parse *pParse, int iReg){
33125cd79239Sdrh   int i;
33135cd79239Sdrh   struct yColCache *p;
33149b40d13fSdrh   for(i=0, p=pParse->aColCache; i<pParse->nColCache; i++, p++){
33155cd79239Sdrh     if( p->iReg==iReg ){
33165cd79239Sdrh       p->tempReg = 0;
33175cd79239Sdrh     }
33185cd79239Sdrh   }
33195cd79239Sdrh }
33205cd79239Sdrh 
33211f9ca2c8Sdrh /* Generate code that will load into register regOut a value that is
33221f9ca2c8Sdrh ** appropriate for the iIdxCol-th column of index pIdx.
33231f9ca2c8Sdrh */
33241f9ca2c8Sdrh void sqlite3ExprCodeLoadIndexColumn(
33251f9ca2c8Sdrh   Parse *pParse,  /* The parsing context */
33261f9ca2c8Sdrh   Index *pIdx,    /* The index whose column is to be loaded */
33271f9ca2c8Sdrh   int iTabCur,    /* Cursor pointing to a table row */
33281f9ca2c8Sdrh   int iIdxCol,    /* The column of the index to be loaded */
33291f9ca2c8Sdrh   int regOut      /* Store the index column value in this register */
33301f9ca2c8Sdrh ){
33311f9ca2c8Sdrh   i16 iTabCol = pIdx->aiColumn[iIdxCol];
33324b92f98cSdrh   if( iTabCol==XN_EXPR ){
33331f9ca2c8Sdrh     assert( pIdx->aColExpr );
33341f9ca2c8Sdrh     assert( pIdx->aColExpr->nExpr>iIdxCol );
33353e34eabcSdrh     pParse->iSelfTab = iTabCur + 1;
33361c75c9d7Sdrh     sqlite3ExprCodeCopy(pParse, pIdx->aColExpr->a[iIdxCol].pExpr, regOut);
33373e34eabcSdrh     pParse->iSelfTab = 0;
33384b92f98cSdrh   }else{
33394b92f98cSdrh     sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pIdx->pTable, iTabCur,
33404b92f98cSdrh                                     iTabCol, regOut);
33414b92f98cSdrh   }
33421f9ca2c8Sdrh }
33431f9ca2c8Sdrh 
33445cd79239Sdrh /*
33455c092e8aSdrh ** Generate code to extract the value of the iCol-th column of a table.
33465c092e8aSdrh */
33475c092e8aSdrh void sqlite3ExprCodeGetColumnOfTable(
33485c092e8aSdrh   Vdbe *v,        /* The VDBE under construction */
33495c092e8aSdrh   Table *pTab,    /* The table containing the value */
3350313619f5Sdrh   int iTabCur,    /* The table cursor.  Or the PK cursor for WITHOUT ROWID */
33515c092e8aSdrh   int iCol,       /* Index of the column to extract */
3352313619f5Sdrh   int regOut      /* Extract the value into this register */
33535c092e8aSdrh ){
3354aca19e19Sdrh   if( pTab==0 ){
3355aca19e19Sdrh     sqlite3VdbeAddOp3(v, OP_Column, iTabCur, iCol, regOut);
3356aca19e19Sdrh     return;
3357aca19e19Sdrh   }
33585c092e8aSdrh   if( iCol<0 || iCol==pTab->iPKey ){
33595c092e8aSdrh     sqlite3VdbeAddOp2(v, OP_Rowid, iTabCur, regOut);
33605c092e8aSdrh   }else{
33615c092e8aSdrh     int op = IsVirtual(pTab) ? OP_VColumn : OP_Column;
3362ee0ec8e1Sdrh     int x = iCol;
336335db31b2Sdrh     if( !HasRowid(pTab) && !IsVirtual(pTab) ){
3364ee0ec8e1Sdrh       x = sqlite3ColumnOfIndex(sqlite3PrimaryKeyIndex(pTab), iCol);
3365ee0ec8e1Sdrh     }
3366ee0ec8e1Sdrh     sqlite3VdbeAddOp3(v, op, iTabCur, x, regOut);
33675c092e8aSdrh   }
33685c092e8aSdrh   if( iCol>=0 ){
33695c092e8aSdrh     sqlite3ColumnDefault(v, pTab, iCol, regOut);
33705c092e8aSdrh   }
33715c092e8aSdrh }
33725c092e8aSdrh 
33735c092e8aSdrh /*
3374945498f3Sdrh ** Generate code that will extract the iColumn-th column from
3375ce78bc6eSdrh ** table pTab and store the column value in a register.
3376ce78bc6eSdrh **
3377ce78bc6eSdrh ** An effort is made to store the column value in register iReg.  This
3378ce78bc6eSdrh ** is not garanteeed for GetColumn() - the result can be stored in
3379ce78bc6eSdrh ** any register.  But the result is guaranteed to land in register iReg
3380ce78bc6eSdrh ** for GetColumnToReg().
3381e55cbd72Sdrh **
3382e55cbd72Sdrh ** There must be an open cursor to pTab in iTable when this routine
3383e55cbd72Sdrh ** is called.  If iColumn<0 then code is generated that extracts the rowid.
3384945498f3Sdrh */
3385e55cbd72Sdrh int sqlite3ExprCodeGetColumn(
3386e55cbd72Sdrh   Parse *pParse,   /* Parsing and code generating context */
33872133d822Sdrh   Table *pTab,     /* Description of the table we are reading from */
33882133d822Sdrh   int iColumn,     /* Index of the table column */
33892133d822Sdrh   int iTable,      /* The cursor pointing to the table */
3390a748fdccSdrh   int iReg,        /* Store results here */
3391ce78bc6eSdrh   u8 p5            /* P5 value for OP_Column + FLAGS */
33922133d822Sdrh ){
3393e55cbd72Sdrh   Vdbe *v = pParse->pVdbe;
3394e55cbd72Sdrh   int i;
3395da250ea5Sdrh   struct yColCache *p;
3396e55cbd72Sdrh 
33979b40d13fSdrh   for(i=0, p=pParse->aColCache; i<pParse->nColCache; i++, p++){
339894881d73Sdrh     if( p->iTable==iTable && p->iColumn==iColumn ){
3399ceea3321Sdrh       p->lru = pParse->iCacheCnt++;
34005cd79239Sdrh       sqlite3ExprCachePinRegister(pParse, p->iReg);
3401da250ea5Sdrh       return p->iReg;
3402e55cbd72Sdrh     }
3403e55cbd72Sdrh   }
3404e55cbd72Sdrh   assert( v!=0 );
34055c092e8aSdrh   sqlite3ExprCodeGetColumnOfTable(v, pTab, iTable, iColumn, iReg);
3406a748fdccSdrh   if( p5 ){
3407a748fdccSdrh     sqlite3VdbeChangeP5(v, p5);
3408a748fdccSdrh   }else{
3409ceea3321Sdrh     sqlite3ExprCacheStore(pParse, iTable, iColumn, iReg);
3410a748fdccSdrh   }
3411e55cbd72Sdrh   return iReg;
3412e55cbd72Sdrh }
3413ce78bc6eSdrh void sqlite3ExprCodeGetColumnToReg(
3414ce78bc6eSdrh   Parse *pParse,   /* Parsing and code generating context */
3415ce78bc6eSdrh   Table *pTab,     /* Description of the table we are reading from */
3416ce78bc6eSdrh   int iColumn,     /* Index of the table column */
3417ce78bc6eSdrh   int iTable,      /* The cursor pointing to the table */
3418ce78bc6eSdrh   int iReg         /* Store results here */
3419ce78bc6eSdrh ){
3420ce78bc6eSdrh   int r1 = sqlite3ExprCodeGetColumn(pParse, pTab, iColumn, iTable, iReg, 0);
3421ce78bc6eSdrh   if( r1!=iReg ) sqlite3VdbeAddOp2(pParse->pVdbe, OP_SCopy, r1, iReg);
3422ce78bc6eSdrh }
3423ce78bc6eSdrh 
3424e55cbd72Sdrh 
3425e55cbd72Sdrh /*
3426ceea3321Sdrh ** Clear all column cache entries.
3427e55cbd72Sdrh */
3428ceea3321Sdrh void sqlite3ExprCacheClear(Parse *pParse){
3429e55cbd72Sdrh   int i;
3430ceea3321Sdrh 
3431d879e3ebSdrh #ifdef SQLITE_DEBUG
34329ac7962aSdrh   if( pParse->db->flags & SQLITE_VdbeAddopTrace ){
34339ac7962aSdrh     printf("CLEAR\n");
34349ac7962aSdrh   }
34359ac7962aSdrh #endif
34369b40d13fSdrh   for(i=0; i<pParse->nColCache; i++){
34379b40d13fSdrh     if( pParse->aColCache[i].tempReg
34389b40d13fSdrh      && pParse->nTempReg<ArraySize(pParse->aTempReg)
34399b40d13fSdrh     ){
34409b40d13fSdrh        pParse->aTempReg[pParse->nTempReg++] = pParse->aColCache[i].iReg;
3441e55cbd72Sdrh     }
3442da250ea5Sdrh   }
34439b40d13fSdrh   pParse->nColCache = 0;
3444da250ea5Sdrh }
3445e55cbd72Sdrh 
3446e55cbd72Sdrh /*
3447da250ea5Sdrh ** Record the fact that an affinity change has occurred on iCount
3448da250ea5Sdrh ** registers starting with iStart.
3449e55cbd72Sdrh */
3450da250ea5Sdrh void sqlite3ExprCacheAffinityChange(Parse *pParse, int iStart, int iCount){
3451f49f3523Sdrh   sqlite3ExprCacheRemove(pParse, iStart, iCount);
3452e55cbd72Sdrh }
3453e55cbd72Sdrh 
3454e55cbd72Sdrh /*
3455b21e7c70Sdrh ** Generate code to move content from registers iFrom...iFrom+nReg-1
3456b21e7c70Sdrh ** over to iTo..iTo+nReg-1. Keep the column cache up-to-date.
3457e55cbd72Sdrh */
3458b21e7c70Sdrh void sqlite3ExprCodeMove(Parse *pParse, int iFrom, int iTo, int nReg){
3459e8e4af76Sdrh   assert( iFrom>=iTo+nReg || iFrom+nReg<=iTo );
3460079a3072Sdrh   sqlite3VdbeAddOp3(pParse->pVdbe, OP_Move, iFrom, iTo, nReg);
3461236241aeSdrh   sqlite3ExprCacheRemove(pParse, iFrom, nReg);
3462945498f3Sdrh }
3463945498f3Sdrh 
3464f49f3523Sdrh #if defined(SQLITE_DEBUG) || defined(SQLITE_COVERAGE_TEST)
346592b01d53Sdrh /*
3466652fbf55Sdrh ** Return true if any register in the range iFrom..iTo (inclusive)
3467652fbf55Sdrh ** is used as part of the column cache.
3468f49f3523Sdrh **
3469f49f3523Sdrh ** This routine is used within assert() and testcase() macros only
3470f49f3523Sdrh ** and does not appear in a normal build.
3471652fbf55Sdrh */
3472652fbf55Sdrh static int usedAsColumnCache(Parse *pParse, int iFrom, int iTo){
3473652fbf55Sdrh   int i;
3474ceea3321Sdrh   struct yColCache *p;
34759b40d13fSdrh   for(i=0, p=pParse->aColCache; i<pParse->nColCache; i++, p++){
3476ceea3321Sdrh     int r = p->iReg;
3477f49f3523Sdrh     if( r>=iFrom && r<=iTo ) return 1;    /*NO_TEST*/
3478652fbf55Sdrh   }
3479652fbf55Sdrh   return 0;
3480652fbf55Sdrh }
3481f49f3523Sdrh #endif /* SQLITE_DEBUG || SQLITE_COVERAGE_TEST */
3482652fbf55Sdrh 
3483bea119cdSdrh 
3484652fbf55Sdrh /*
348512abf408Sdrh ** Convert a scalar expression node to a TK_REGISTER referencing
348612abf408Sdrh ** register iReg.  The caller must ensure that iReg already contains
348712abf408Sdrh ** the correct value for the expression.
3488a4c3c87eSdrh */
3489a4c3c87eSdrh static void exprToRegister(Expr *p, int iReg){
3490a4c3c87eSdrh   p->op2 = p->op;
3491a4c3c87eSdrh   p->op = TK_REGISTER;
3492a4c3c87eSdrh   p->iTable = iReg;
3493a4c3c87eSdrh   ExprClearProperty(p, EP_Skip);
3494a4c3c87eSdrh }
3495a4c3c87eSdrh 
349612abf408Sdrh /*
349712abf408Sdrh ** Evaluate an expression (either a vector or a scalar expression) and store
349812abf408Sdrh ** the result in continguous temporary registers.  Return the index of
349912abf408Sdrh ** the first register used to store the result.
350012abf408Sdrh **
350112abf408Sdrh ** If the returned result register is a temporary scalar, then also write
350212abf408Sdrh ** that register number into *piFreeable.  If the returned result register
350312abf408Sdrh ** is not a temporary or if the expression is a vector set *piFreeable
350412abf408Sdrh ** to 0.
350512abf408Sdrh */
350612abf408Sdrh static int exprCodeVector(Parse *pParse, Expr *p, int *piFreeable){
350712abf408Sdrh   int iResult;
350812abf408Sdrh   int nResult = sqlite3ExprVectorSize(p);
350912abf408Sdrh   if( nResult==1 ){
351012abf408Sdrh     iResult = sqlite3ExprCodeTemp(pParse, p, piFreeable);
351112abf408Sdrh   }else{
351212abf408Sdrh     *piFreeable = 0;
351312abf408Sdrh     if( p->op==TK_SELECT ){
3514dd1bb43aSdrh #if SQLITE_OMIT_SUBQUERY
3515dd1bb43aSdrh       iResult = 0;
3516dd1bb43aSdrh #else
351712abf408Sdrh       iResult = sqlite3CodeSubselect(pParse, p, 0, 0);
3518dd1bb43aSdrh #endif
351912abf408Sdrh     }else{
352012abf408Sdrh       int i;
352112abf408Sdrh       iResult = pParse->nMem+1;
352212abf408Sdrh       pParse->nMem += nResult;
352312abf408Sdrh       for(i=0; i<nResult; i++){
35244b725240Sdan         sqlite3ExprCodeFactorable(pParse, p->x.pList->a[i].pExpr, i+iResult);
352512abf408Sdrh       }
352612abf408Sdrh     }
352712abf408Sdrh   }
352812abf408Sdrh   return iResult;
352912abf408Sdrh }
353012abf408Sdrh 
353171c57db0Sdan 
3532a4c3c87eSdrh /*
3533cce7d176Sdrh ** Generate code into the current Vdbe to evaluate the given
35342dcef11bSdrh ** expression.  Attempt to store the results in register "target".
35352dcef11bSdrh ** Return the register where results are stored.
3536389a1adbSdrh **
35378b213899Sdrh ** With this routine, there is no guarantee that results will
35382dcef11bSdrh ** be stored in target.  The result might be stored in some other
35392dcef11bSdrh ** register if it is convenient to do so.  The calling function
35402dcef11bSdrh ** must check the return code and move the results to the desired
35412dcef11bSdrh ** register.
3542cce7d176Sdrh */
3543678ccce8Sdrh int sqlite3ExprCodeTarget(Parse *pParse, Expr *pExpr, int target){
35442dcef11bSdrh   Vdbe *v = pParse->pVdbe;  /* The VM under construction */
35452dcef11bSdrh   int op;                   /* The opcode being coded */
35462dcef11bSdrh   int inReg = target;       /* Results stored in register inReg */
35472dcef11bSdrh   int regFree1 = 0;         /* If non-zero free this temporary register */
35482dcef11bSdrh   int regFree2 = 0;         /* If non-zero free this temporary register */
35497b35a77bSdan   int r1, r2;               /* Various register numbers */
355010d1edf0Sdrh   Expr tempX;               /* Temporary expression node */
355171c57db0Sdan   int p5 = 0;
3552ffe07b2dSdrh 
35539cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
355420411ea7Sdrh   if( v==0 ){
355520411ea7Sdrh     assert( pParse->db->mallocFailed );
355620411ea7Sdrh     return 0;
355720411ea7Sdrh   }
3558389a1adbSdrh 
35591efa8023Sdrh expr_code_doover:
3560389a1adbSdrh   if( pExpr==0 ){
3561389a1adbSdrh     op = TK_NULL;
3562389a1adbSdrh   }else{
3563f2bc013cSdrh     op = pExpr->op;
3564389a1adbSdrh   }
3565f2bc013cSdrh   switch( op ){
356613449892Sdrh     case TK_AGG_COLUMN: {
356713449892Sdrh       AggInfo *pAggInfo = pExpr->pAggInfo;
356813449892Sdrh       struct AggInfo_col *pCol = &pAggInfo->aCol[pExpr->iAgg];
356913449892Sdrh       if( !pAggInfo->directMode ){
35709de221dfSdrh         assert( pCol->iMem>0 );
3571c332cc30Sdrh         return pCol->iMem;
357213449892Sdrh       }else if( pAggInfo->useSortingIdx ){
35735134d135Sdan         sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdxPTab,
3574389a1adbSdrh                               pCol->iSorterColumn, target);
3575c332cc30Sdrh         return target;
357613449892Sdrh       }
357713449892Sdrh       /* Otherwise, fall thru into the TK_COLUMN case */
357813449892Sdrh     }
3579967e8b73Sdrh     case TK_COLUMN: {
3580b2b9d3d7Sdrh       int iTab = pExpr->iTable;
3581b2b9d3d7Sdrh       if( iTab<0 ){
35826e97f8ecSdrh         if( pParse->iSelfTab<0 ){
3583b2b9d3d7Sdrh           /* Generating CHECK constraints or inserting into partial index */
35846e97f8ecSdrh           return pExpr->iColumn - pParse->iSelfTab;
3585c4a3c779Sdrh         }else{
35861f9ca2c8Sdrh           /* Coding an expression that is part of an index where column names
35871f9ca2c8Sdrh           ** in the index refer to the table to which the index belongs */
35883e34eabcSdrh           iTab = pParse->iSelfTab - 1;
35892282792aSdrh         }
3590b2b9d3d7Sdrh       }
3591c332cc30Sdrh       return sqlite3ExprCodeGetColumn(pParse, pExpr->pTab,
3592b2b9d3d7Sdrh                                pExpr->iColumn, iTab, target,
3593b2b9d3d7Sdrh                                pExpr->op2);
3594cce7d176Sdrh     }
3595cce7d176Sdrh     case TK_INTEGER: {
359613573c71Sdrh       codeInteger(pParse, pExpr, 0, target);
3597c332cc30Sdrh       return target;
359851e9a445Sdrh     }
35998abed7b9Sdrh     case TK_TRUEFALSE: {
360096acafbeSdrh       sqlite3VdbeAddOp2(v, OP_Integer, sqlite3ExprTruthValue(pExpr), target);
3601007c843bSdrh       return target;
3602007c843bSdrh     }
360313573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
3604598f1340Sdrh     case TK_FLOAT: {
360533e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
360633e619fcSdrh       codeReal(v, pExpr->u.zToken, 0, target);
3607c332cc30Sdrh       return target;
3608598f1340Sdrh     }
360913573c71Sdrh #endif
3610fec19aadSdrh     case TK_STRING: {
361133e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
3612076e85f5Sdrh       sqlite3VdbeLoadString(v, target, pExpr->u.zToken);
3613c332cc30Sdrh       return target;
3614cce7d176Sdrh     }
3615f0863fe5Sdrh     case TK_NULL: {
36169de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3617c332cc30Sdrh       return target;
3618f0863fe5Sdrh     }
36195338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_BLOB_LITERAL
3620c572ef7fSdanielk1977     case TK_BLOB: {
36216c8c6cecSdrh       int n;
36226c8c6cecSdrh       const char *z;
3623ca48c90fSdrh       char *zBlob;
362433e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
362533e619fcSdrh       assert( pExpr->u.zToken[0]=='x' || pExpr->u.zToken[0]=='X' );
362633e619fcSdrh       assert( pExpr->u.zToken[1]=='\'' );
362733e619fcSdrh       z = &pExpr->u.zToken[2];
3628b7916a78Sdrh       n = sqlite3Strlen30(z) - 1;
3629b7916a78Sdrh       assert( z[n]=='\'' );
3630ca48c90fSdrh       zBlob = sqlite3HexToBlob(sqlite3VdbeDb(v), z, n);
3631ca48c90fSdrh       sqlite3VdbeAddOp4(v, OP_Blob, n/2, target, 0, zBlob, P4_DYNAMIC);
3632c332cc30Sdrh       return target;
3633c572ef7fSdanielk1977     }
36345338a5f7Sdanielk1977 #endif
363550457896Sdrh     case TK_VARIABLE: {
363633e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
363733e619fcSdrh       assert( pExpr->u.zToken!=0 );
363833e619fcSdrh       assert( pExpr->u.zToken[0]!=0 );
3639eaf52d88Sdrh       sqlite3VdbeAddOp2(v, OP_Variable, pExpr->iColumn, target);
364033e619fcSdrh       if( pExpr->u.zToken[1]!=0 ){
36419bf755ccSdrh         const char *z = sqlite3VListNumToName(pParse->pVList, pExpr->iColumn);
36429bf755ccSdrh         assert( pExpr->u.zToken[0]=='?' || strcmp(pExpr->u.zToken, z)==0 );
3643ce1bbe51Sdrh         pParse->pVList[0] = 0; /* Indicate VList may no longer be enlarged */
36449bf755ccSdrh         sqlite3VdbeAppendP4(v, (char*)z, P4_STATIC);
36459bf755ccSdrh       }
3646c332cc30Sdrh       return target;
364750457896Sdrh     }
36484e0cff60Sdrh     case TK_REGISTER: {
3649c332cc30Sdrh       return pExpr->iTable;
36504e0cff60Sdrh     }
3651487e262fSdrh #ifndef SQLITE_OMIT_CAST
3652487e262fSdrh     case TK_CAST: {
3653487e262fSdrh       /* Expressions of the form:   CAST(pLeft AS token) */
36542dcef11bSdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
36551735fa88Sdrh       if( inReg!=target ){
36561735fa88Sdrh         sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
36571735fa88Sdrh         inReg = target;
36581735fa88Sdrh       }
36594169e430Sdrh       sqlite3VdbeAddOp2(v, OP_Cast, target,
36604169e430Sdrh                         sqlite3AffinityType(pExpr->u.zToken, 0));
3661c5499befSdrh       testcase( usedAsColumnCache(pParse, inReg, inReg) );
3662b3843a82Sdrh       sqlite3ExprCacheAffinityChange(pParse, inReg, 1);
3663c332cc30Sdrh       return inReg;
3664487e262fSdrh     }
3665487e262fSdrh #endif /* SQLITE_OMIT_CAST */
366671c57db0Sdan     case TK_IS:
366771c57db0Sdan     case TK_ISNOT:
366871c57db0Sdan       op = (op==TK_IS) ? TK_EQ : TK_NE;
366971c57db0Sdan       p5 = SQLITE_NULLEQ;
367071c57db0Sdan       /* fall-through */
3671c9b84a1fSdrh     case TK_LT:
3672c9b84a1fSdrh     case TK_LE:
3673c9b84a1fSdrh     case TK_GT:
3674c9b84a1fSdrh     case TK_GE:
3675c9b84a1fSdrh     case TK_NE:
3676c9b84a1fSdrh     case TK_EQ: {
367771c57db0Sdan       Expr *pLeft = pExpr->pLeft;
3678625015e0Sdan       if( sqlite3ExprIsVector(pLeft) ){
367979752b6eSdrh         codeVectorCompare(pParse, pExpr, target, op, p5);
368071c57db0Sdan       }else{
368171c57db0Sdan         r1 = sqlite3ExprCodeTemp(pParse, pLeft, &regFree1);
3682b6da74ebSdrh         r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
368371c57db0Sdan         codeCompare(pParse, pLeft, pExpr->pRight, op,
368471c57db0Sdan             r1, r2, inReg, SQLITE_STOREP2 | p5);
36857d176105Sdrh         assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
36867d176105Sdrh         assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
36877d176105Sdrh         assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
36887d176105Sdrh         assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
36897d176105Sdrh         assert(TK_EQ==OP_Eq); testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
36907d176105Sdrh         assert(TK_NE==OP_Ne); testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
3691c5499befSdrh         testcase( regFree1==0 );
3692c5499befSdrh         testcase( regFree2==0 );
3693c9b84a1fSdrh       }
36946a2fe093Sdrh       break;
36956a2fe093Sdrh     }
3696cce7d176Sdrh     case TK_AND:
3697cce7d176Sdrh     case TK_OR:
3698cce7d176Sdrh     case TK_PLUS:
3699cce7d176Sdrh     case TK_STAR:
3700cce7d176Sdrh     case TK_MINUS:
3701bf4133cbSdrh     case TK_REM:
3702bf4133cbSdrh     case TK_BITAND:
3703bf4133cbSdrh     case TK_BITOR:
370417c40294Sdrh     case TK_SLASH:
3705bf4133cbSdrh     case TK_LSHIFT:
3706855eb1cfSdrh     case TK_RSHIFT:
37070040077dSdrh     case TK_CONCAT: {
37087d176105Sdrh       assert( TK_AND==OP_And );            testcase( op==TK_AND );
37097d176105Sdrh       assert( TK_OR==OP_Or );              testcase( op==TK_OR );
37107d176105Sdrh       assert( TK_PLUS==OP_Add );           testcase( op==TK_PLUS );
37117d176105Sdrh       assert( TK_MINUS==OP_Subtract );     testcase( op==TK_MINUS );
37127d176105Sdrh       assert( TK_REM==OP_Remainder );      testcase( op==TK_REM );
37137d176105Sdrh       assert( TK_BITAND==OP_BitAnd );      testcase( op==TK_BITAND );
37147d176105Sdrh       assert( TK_BITOR==OP_BitOr );        testcase( op==TK_BITOR );
37157d176105Sdrh       assert( TK_SLASH==OP_Divide );       testcase( op==TK_SLASH );
37167d176105Sdrh       assert( TK_LSHIFT==OP_ShiftLeft );   testcase( op==TK_LSHIFT );
37177d176105Sdrh       assert( TK_RSHIFT==OP_ShiftRight );  testcase( op==TK_RSHIFT );
37187d176105Sdrh       assert( TK_CONCAT==OP_Concat );      testcase( op==TK_CONCAT );
37192dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
37202dcef11bSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
37215b6afba9Sdrh       sqlite3VdbeAddOp3(v, op, r2, r1, target);
3722c5499befSdrh       testcase( regFree1==0 );
3723c5499befSdrh       testcase( regFree2==0 );
37240040077dSdrh       break;
37250040077dSdrh     }
3726cce7d176Sdrh     case TK_UMINUS: {
3727fec19aadSdrh       Expr *pLeft = pExpr->pLeft;
3728fec19aadSdrh       assert( pLeft );
372913573c71Sdrh       if( pLeft->op==TK_INTEGER ){
373013573c71Sdrh         codeInteger(pParse, pLeft, 1, target);
3731c332cc30Sdrh         return target;
373213573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
373313573c71Sdrh       }else if( pLeft->op==TK_FLOAT ){
373433e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
373533e619fcSdrh         codeReal(v, pLeft->u.zToken, 1, target);
3736c332cc30Sdrh         return target;
373713573c71Sdrh #endif
37383c84ddffSdrh       }else{
373910d1edf0Sdrh         tempX.op = TK_INTEGER;
374010d1edf0Sdrh         tempX.flags = EP_IntValue|EP_TokenOnly;
374110d1edf0Sdrh         tempX.u.iValue = 0;
374210d1edf0Sdrh         r1 = sqlite3ExprCodeTemp(pParse, &tempX, &regFree1);
3743e55cbd72Sdrh         r2 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree2);
37442dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_Subtract, r2, r1, target);
3745c5499befSdrh         testcase( regFree2==0 );
37463c84ddffSdrh       }
37476e142f54Sdrh       break;
37486e142f54Sdrh     }
3749bf4133cbSdrh     case TK_BITNOT:
37506e142f54Sdrh     case TK_NOT: {
37517d176105Sdrh       assert( TK_BITNOT==OP_BitNot );   testcase( op==TK_BITNOT );
37527d176105Sdrh       assert( TK_NOT==OP_Not );         testcase( op==TK_NOT );
3753e99fa2afSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3754e99fa2afSdrh       testcase( regFree1==0 );
3755e99fa2afSdrh       sqlite3VdbeAddOp2(v, op, r1, inReg);
3756cce7d176Sdrh       break;
3757cce7d176Sdrh     }
37588abed7b9Sdrh     case TK_TRUTH: {
375996acafbeSdrh       int isTrue;    /* IS TRUE or IS NOT TRUE */
376096acafbeSdrh       int bNormal;   /* IS TRUE or IS FALSE */
3761007c843bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3762007c843bSdrh       testcase( regFree1==0 );
376396acafbeSdrh       isTrue = sqlite3ExprTruthValue(pExpr->pRight);
376496acafbeSdrh       bNormal = pExpr->op2==TK_IS;
376596acafbeSdrh       testcase( isTrue && bNormal);
376696acafbeSdrh       testcase( !isTrue && bNormal);
376796acafbeSdrh       sqlite3VdbeAddOp4Int(v, OP_IsTrue, r1, inReg, !isTrue, isTrue ^ bNormal);
3768007c843bSdrh       break;
3769007c843bSdrh     }
3770cce7d176Sdrh     case TK_ISNULL:
3771cce7d176Sdrh     case TK_NOTNULL: {
37726a288a33Sdrh       int addr;
37737d176105Sdrh       assert( TK_ISNULL==OP_IsNull );   testcase( op==TK_ISNULL );
37747d176105Sdrh       assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
37759de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
37762dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3777c5499befSdrh       testcase( regFree1==0 );
37782dcef11bSdrh       addr = sqlite3VdbeAddOp1(v, op, r1);
37797d176105Sdrh       VdbeCoverageIf(v, op==TK_ISNULL);
37807d176105Sdrh       VdbeCoverageIf(v, op==TK_NOTNULL);
3781a976979bSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 0, target);
37826a288a33Sdrh       sqlite3VdbeJumpHere(v, addr);
3783a37cdde0Sdanielk1977       break;
3784f2bc013cSdrh     }
37852282792aSdrh     case TK_AGG_FUNCTION: {
378613449892Sdrh       AggInfo *pInfo = pExpr->pAggInfo;
37877e56e711Sdrh       if( pInfo==0 ){
378833e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
378933e619fcSdrh         sqlite3ErrorMsg(pParse, "misuse of aggregate: %s()", pExpr->u.zToken);
37907e56e711Sdrh       }else{
3791c332cc30Sdrh         return pInfo->aFunc[pExpr->iAgg].iMem;
37927e56e711Sdrh       }
37932282792aSdrh       break;
37942282792aSdrh     }
3795cce7d176Sdrh     case TK_FUNCTION: {
379612ffee8cSdrh       ExprList *pFarg;       /* List of function arguments */
379712ffee8cSdrh       int nFarg;             /* Number of function arguments */
379812ffee8cSdrh       FuncDef *pDef;         /* The function definition object */
379912ffee8cSdrh       const char *zId;       /* The function name */
3800693e6719Sdrh       u32 constMask = 0;     /* Mask of function arguments that are constant */
380112ffee8cSdrh       int i;                 /* Loop counter */
3802c332cc30Sdrh       sqlite3 *db = pParse->db;  /* The database connection */
380312ffee8cSdrh       u8 enc = ENC(db);      /* The text encoding used by this database */
380412ffee8cSdrh       CollSeq *pColl = 0;    /* A collating sequence */
380517435752Sdrh 
380686fb6e17Sdan       if( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) && pExpr->pWin ){
380786fb6e17Sdan         return pExpr->pWin->regResult;
380886fb6e17Sdan       }
380986fb6e17Sdan 
38101e9b53f9Sdrh       if( ConstFactorOk(pParse) && sqlite3ExprIsConstantNotJoin(pExpr) ){
381149c5ab24Sdrh         /* SQL functions can be expensive. So try to move constant functions
3812ad879ffdSdrh         ** out of the inner loop, even if that means an extra OP_Copy. */
3813ad879ffdSdrh         return sqlite3ExprCodeAtInit(pParse, pExpr, -1);
38141e9b53f9Sdrh       }
38156ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
3816c5cd1249Sdrh       if( ExprHasProperty(pExpr, EP_TokenOnly) ){
381712ffee8cSdrh         pFarg = 0;
381812ffee8cSdrh       }else{
381912ffee8cSdrh         pFarg = pExpr->x.pList;
382012ffee8cSdrh       }
382112ffee8cSdrh       nFarg = pFarg ? pFarg->nExpr : 0;
382233e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
382333e619fcSdrh       zId = pExpr->u.zToken;
382480738d9cSdrh       pDef = sqlite3FindFunction(db, zId, nFarg, enc, 0);
3825cc15313cSdrh #ifdef SQLITE_ENABLE_UNKNOWN_SQL_FUNCTION
3826cc15313cSdrh       if( pDef==0 && pParse->explain ){
3827cc15313cSdrh         pDef = sqlite3FindFunction(db, "unknown", nFarg, enc, 0);
3828cc15313cSdrh       }
3829cc15313cSdrh #endif
383086fb6e17Sdan       if( pDef==0 /* || pDef->xFinalize!=0 */ ){
383180738d9cSdrh         sqlite3ErrorMsg(pParse, "unknown function: %s()", zId);
3832feb306f5Sdrh         break;
3833feb306f5Sdrh       }
3834ae6bb957Sdrh 
3835ae6bb957Sdrh       /* Attempt a direct implementation of the built-in COALESCE() and
383660ec914cSpeter.d.reid       ** IFNULL() functions.  This avoids unnecessary evaluation of
3837ae6bb957Sdrh       ** arguments past the first non-NULL argument.
3838ae6bb957Sdrh       */
3839d36e1041Sdrh       if( pDef->funcFlags & SQLITE_FUNC_COALESCE ){
3840ae6bb957Sdrh         int endCoalesce = sqlite3VdbeMakeLabel(v);
3841ae6bb957Sdrh         assert( nFarg>=2 );
3842ae6bb957Sdrh         sqlite3ExprCode(pParse, pFarg->a[0].pExpr, target);
3843ae6bb957Sdrh         for(i=1; i<nFarg; i++){
3844ae6bb957Sdrh           sqlite3VdbeAddOp2(v, OP_NotNull, target, endCoalesce);
3845688852abSdrh           VdbeCoverage(v);
3846f49f3523Sdrh           sqlite3ExprCacheRemove(pParse, target, 1);
3847ae6bb957Sdrh           sqlite3ExprCachePush(pParse);
3848ae6bb957Sdrh           sqlite3ExprCode(pParse, pFarg->a[i].pExpr, target);
3849d2490904Sdrh           sqlite3ExprCachePop(pParse);
3850ae6bb957Sdrh         }
3851ae6bb957Sdrh         sqlite3VdbeResolveLabel(v, endCoalesce);
3852ae6bb957Sdrh         break;
3853ae6bb957Sdrh       }
3854ae6bb957Sdrh 
3855cca9f3d2Sdrh       /* The UNLIKELY() function is a no-op.  The result is the value
3856cca9f3d2Sdrh       ** of the first argument.
3857cca9f3d2Sdrh       */
3858cca9f3d2Sdrh       if( pDef->funcFlags & SQLITE_FUNC_UNLIKELY ){
3859cca9f3d2Sdrh         assert( nFarg>=1 );
3860c332cc30Sdrh         return sqlite3ExprCodeTarget(pParse, pFarg->a[0].pExpr, target);
3861cca9f3d2Sdrh       }
3862ae6bb957Sdrh 
386354240751Sdrh #ifdef SQLITE_DEBUG
3864a1a523a5Sdrh       /* The AFFINITY() function evaluates to a string that describes
3865a1a523a5Sdrh       ** the type affinity of the argument.  This is used for testing of
3866a1a523a5Sdrh       ** the SQLite type logic.
3867a1a523a5Sdrh       */
3868a1a523a5Sdrh       if( pDef->funcFlags & SQLITE_FUNC_AFFINITY ){
3869a1a523a5Sdrh         const char *azAff[] = { "blob", "text", "numeric", "integer", "real" };
3870a1a523a5Sdrh         char aff;
3871a1a523a5Sdrh         assert( nFarg==1 );
3872a1a523a5Sdrh         aff = sqlite3ExprAffinity(pFarg->a[0].pExpr);
3873a1a523a5Sdrh         sqlite3VdbeLoadString(v, target,
3874a1a523a5Sdrh                               aff ? azAff[aff-SQLITE_AFF_BLOB] : "none");
3875a1a523a5Sdrh         return target;
3876a1a523a5Sdrh       }
387754240751Sdrh #endif
3878a1a523a5Sdrh 
3879d1a01edaSdrh       for(i=0; i<nFarg; i++){
3880d1a01edaSdrh         if( i<32 && sqlite3ExprIsConstant(pFarg->a[i].pExpr) ){
3881693e6719Sdrh           testcase( i==31 );
3882693e6719Sdrh           constMask |= MASKBIT32(i);
3883d1a01edaSdrh         }
3884d1a01edaSdrh         if( (pDef->funcFlags & SQLITE_FUNC_NEEDCOLL)!=0 && !pColl ){
3885d1a01edaSdrh           pColl = sqlite3ExprCollSeq(pParse, pFarg->a[i].pExpr);
3886d1a01edaSdrh         }
3887d1a01edaSdrh       }
388812ffee8cSdrh       if( pFarg ){
3889d1a01edaSdrh         if( constMask ){
3890d1a01edaSdrh           r1 = pParse->nMem+1;
3891d1a01edaSdrh           pParse->nMem += nFarg;
3892d1a01edaSdrh         }else{
389312ffee8cSdrh           r1 = sqlite3GetTempRange(pParse, nFarg);
3894d1a01edaSdrh         }
3895a748fdccSdrh 
3896a748fdccSdrh         /* For length() and typeof() functions with a column argument,
3897a748fdccSdrh         ** set the P5 parameter to the OP_Column opcode to OPFLAG_LENGTHARG
3898a748fdccSdrh         ** or OPFLAG_TYPEOFARG respectively, to avoid unnecessary data
3899a748fdccSdrh         ** loading.
3900a748fdccSdrh         */
3901d36e1041Sdrh         if( (pDef->funcFlags & (SQLITE_FUNC_LENGTH|SQLITE_FUNC_TYPEOF))!=0 ){
39024e245a4cSdrh           u8 exprOp;
3903a748fdccSdrh           assert( nFarg==1 );
3904a748fdccSdrh           assert( pFarg->a[0].pExpr!=0 );
39054e245a4cSdrh           exprOp = pFarg->a[0].pExpr->op;
39064e245a4cSdrh           if( exprOp==TK_COLUMN || exprOp==TK_AGG_COLUMN ){
3907a748fdccSdrh             assert( SQLITE_FUNC_LENGTH==OPFLAG_LENGTHARG );
3908a748fdccSdrh             assert( SQLITE_FUNC_TYPEOF==OPFLAG_TYPEOFARG );
3909b1fba286Sdrh             testcase( pDef->funcFlags & OPFLAG_LENGTHARG );
3910b1fba286Sdrh             pFarg->a[0].pExpr->op2 =
3911b1fba286Sdrh                   pDef->funcFlags & (OPFLAG_LENGTHARG|OPFLAG_TYPEOFARG);
3912a748fdccSdrh           }
3913a748fdccSdrh         }
3914a748fdccSdrh 
3915d7d385ddSdrh         sqlite3ExprCachePush(pParse);     /* Ticket 2ea2425d34be */
39165579d59fSdrh         sqlite3ExprCodeExprList(pParse, pFarg, r1, 0,
3917d1a01edaSdrh                                 SQLITE_ECEL_DUP|SQLITE_ECEL_FACTOR);
3918d2490904Sdrh         sqlite3ExprCachePop(pParse);      /* Ticket 2ea2425d34be */
3919892d3179Sdrh       }else{
392012ffee8cSdrh         r1 = 0;
3921892d3179Sdrh       }
3922b7f6f68fSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
3923a43fa227Sdrh       /* Possibly overload the function if the first argument is
3924a43fa227Sdrh       ** a virtual table column.
3925a43fa227Sdrh       **
3926a43fa227Sdrh       ** For infix functions (LIKE, GLOB, REGEXP, and MATCH) use the
3927a43fa227Sdrh       ** second argument, not the first, as the argument to test to
3928a43fa227Sdrh       ** see if it is a column in a virtual table.  This is done because
3929a43fa227Sdrh       ** the left operand of infix functions (the operand we want to
3930a43fa227Sdrh       ** control overloading) ends up as the second argument to the
3931a43fa227Sdrh       ** function.  The expression "A glob B" is equivalent to
3932a43fa227Sdrh       ** "glob(B,A).  We want to use the A in "A glob B" to test
3933a43fa227Sdrh       ** for function overloading.  But we use the B term in "glob(B,A)".
3934a43fa227Sdrh       */
393512ffee8cSdrh       if( nFarg>=2 && (pExpr->flags & EP_InfixFunc) ){
393612ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[1].pExpr);
393712ffee8cSdrh       }else if( nFarg>0 ){
393812ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[0].pExpr);
3939b7f6f68fSdrh       }
3940b7f6f68fSdrh #endif
3941d36e1041Sdrh       if( pDef->funcFlags & SQLITE_FUNC_NEEDCOLL ){
39428b213899Sdrh         if( !pColl ) pColl = db->pDfltColl;
394366a5167bSdrh         sqlite3VdbeAddOp4(v, OP_CollSeq, 0, 0, 0, (char *)pColl, P4_COLLSEQ);
3944682f68b0Sdanielk1977       }
3945092457b1Sdrh #ifdef SQLITE_ENABLE_OFFSET_SQL_FUNC
3946092457b1Sdrh       if( pDef->funcFlags & SQLITE_FUNC_OFFSET ){
39472fc865c1Sdrh         Expr *pArg = pFarg->a[0].pExpr;
39482fc865c1Sdrh         if( pArg->op==TK_COLUMN ){
3949092457b1Sdrh           sqlite3VdbeAddOp3(v, OP_Offset, pArg->iTable, pArg->iColumn, target);
39502fc865c1Sdrh         }else{
39512fc865c1Sdrh           sqlite3VdbeAddOp2(v, OP_Null, 0, target);
39522fc865c1Sdrh         }
3953092457b1Sdrh       }else
3954092457b1Sdrh #endif
3955092457b1Sdrh       {
39563e34eabcSdrh         sqlite3VdbeAddOp4(v, pParse->iSelfTab ? OP_PureFunc0 : OP_Function0,
39573e34eabcSdrh                           constMask, r1, target, (char*)pDef, P4_FUNCDEF);
395812ffee8cSdrh         sqlite3VdbeChangeP5(v, (u8)nFarg);
39592fc865c1Sdrh       }
3960d1a01edaSdrh       if( nFarg && constMask==0 ){
396112ffee8cSdrh         sqlite3ReleaseTempRange(pParse, r1, nFarg);
39622dcef11bSdrh       }
3963c332cc30Sdrh       return target;
39646ec2733bSdrh     }
3965fe2093d7Sdrh #ifndef SQLITE_OMIT_SUBQUERY
3966fe2093d7Sdrh     case TK_EXISTS:
396719a775c2Sdrh     case TK_SELECT: {
39688da209b1Sdan       int nCol;
3969c5499befSdrh       testcase( op==TK_EXISTS );
3970c5499befSdrh       testcase( op==TK_SELECT );
39718da209b1Sdan       if( op==TK_SELECT && (nCol = pExpr->x.pSelect->pEList->nExpr)!=1 ){
39728da209b1Sdan         sqlite3SubselectError(pParse, nCol, 1);
39738da209b1Sdan       }else{
3974c332cc30Sdrh         return sqlite3CodeSubselect(pParse, pExpr, 0, 0);
39758da209b1Sdan       }
397619a775c2Sdrh       break;
397719a775c2Sdrh     }
3978fc7f27b9Sdrh     case TK_SELECT_COLUMN: {
3979966e2911Sdrh       int n;
3980fc7f27b9Sdrh       if( pExpr->pLeft->iTable==0 ){
3981fc7f27b9Sdrh         pExpr->pLeft->iTable = sqlite3CodeSubselect(pParse, pExpr->pLeft, 0, 0);
3982fc7f27b9Sdrh       }
3983966e2911Sdrh       assert( pExpr->iTable==0 || pExpr->pLeft->op==TK_SELECT );
3984966e2911Sdrh       if( pExpr->iTable
3985966e2911Sdrh        && pExpr->iTable!=(n = sqlite3ExprVectorSize(pExpr->pLeft))
3986966e2911Sdrh       ){
3987966e2911Sdrh         sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
3988966e2911Sdrh                                 pExpr->iTable, n);
3989966e2911Sdrh       }
3990c332cc30Sdrh       return pExpr->pLeft->iTable + pExpr->iColumn;
3991fc7f27b9Sdrh     }
3992fef5208cSdrh     case TK_IN: {
3993e3365e6cSdrh       int destIfFalse = sqlite3VdbeMakeLabel(v);
3994e3365e6cSdrh       int destIfNull = sqlite3VdbeMakeLabel(v);
3995e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3996e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
399766ba23ceSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
3998e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
3999e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_AddImm, target, 0);
4000e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfNull);
4001c332cc30Sdrh       return target;
4002fef5208cSdrh     }
4003e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
4004e3365e6cSdrh 
4005e3365e6cSdrh 
40062dcef11bSdrh     /*
40072dcef11bSdrh     **    x BETWEEN y AND z
40082dcef11bSdrh     **
40092dcef11bSdrh     ** This is equivalent to
40102dcef11bSdrh     **
40112dcef11bSdrh     **    x>=y AND x<=z
40122dcef11bSdrh     **
40132dcef11bSdrh     ** X is stored in pExpr->pLeft.
40142dcef11bSdrh     ** Y is stored in pExpr->pList->a[0].pExpr.
40152dcef11bSdrh     ** Z is stored in pExpr->pList->a[1].pExpr.
40162dcef11bSdrh     */
4017fef5208cSdrh     case TK_BETWEEN: {
401871c57db0Sdan       exprCodeBetween(pParse, pExpr, target, 0, 0);
4019c332cc30Sdrh       return target;
4020fef5208cSdrh     }
402194fa9c41Sdrh     case TK_SPAN:
4022ae80ddeaSdrh     case TK_COLLATE:
40234f07e5fbSdrh     case TK_UPLUS: {
40241efa8023Sdrh       pExpr = pExpr->pLeft;
40251efa8023Sdrh       goto expr_code_doover;
4026a2e00042Sdrh     }
40272dcef11bSdrh 
4028165921a7Sdan     case TK_TRIGGER: {
402965a7cd16Sdan       /* If the opcode is TK_TRIGGER, then the expression is a reference
403065a7cd16Sdan       ** to a column in the new.* or old.* pseudo-tables available to
403165a7cd16Sdan       ** trigger programs. In this case Expr.iTable is set to 1 for the
403265a7cd16Sdan       ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
403365a7cd16Sdan       ** is set to the column of the pseudo-table to read, or to -1 to
403465a7cd16Sdan       ** read the rowid field.
403565a7cd16Sdan       **
403665a7cd16Sdan       ** The expression is implemented using an OP_Param opcode. The p1
403765a7cd16Sdan       ** parameter is set to 0 for an old.rowid reference, or to (i+1)
403865a7cd16Sdan       ** to reference another column of the old.* pseudo-table, where
403965a7cd16Sdan       ** i is the index of the column. For a new.rowid reference, p1 is
404065a7cd16Sdan       ** set to (n+1), where n is the number of columns in each pseudo-table.
404165a7cd16Sdan       ** For a reference to any other column in the new.* pseudo-table, p1
404265a7cd16Sdan       ** is set to (n+2+i), where n and i are as defined previously. For
404365a7cd16Sdan       ** example, if the table on which triggers are being fired is
404465a7cd16Sdan       ** declared as:
404565a7cd16Sdan       **
404665a7cd16Sdan       **   CREATE TABLE t1(a, b);
404765a7cd16Sdan       **
404865a7cd16Sdan       ** Then p1 is interpreted as follows:
404965a7cd16Sdan       **
405065a7cd16Sdan       **   p1==0   ->    old.rowid     p1==3   ->    new.rowid
405165a7cd16Sdan       **   p1==1   ->    old.a         p1==4   ->    new.a
405265a7cd16Sdan       **   p1==2   ->    old.b         p1==5   ->    new.b
405365a7cd16Sdan       */
40542832ad42Sdan       Table *pTab = pExpr->pTab;
405565a7cd16Sdan       int p1 = pExpr->iTable * (pTab->nCol+1) + 1 + pExpr->iColumn;
405665a7cd16Sdan 
405765a7cd16Sdan       assert( pExpr->iTable==0 || pExpr->iTable==1 );
405865a7cd16Sdan       assert( pExpr->iColumn>=-1 && pExpr->iColumn<pTab->nCol );
405965a7cd16Sdan       assert( pTab->iPKey<0 || pExpr->iColumn!=pTab->iPKey );
406065a7cd16Sdan       assert( p1>=0 && p1<(pTab->nCol*2+2) );
406165a7cd16Sdan 
406265a7cd16Sdan       sqlite3VdbeAddOp2(v, OP_Param, p1, target);
4063896494e8Sdrh       VdbeComment((v, "r[%d]=%s.%s", target,
4064165921a7Sdan         (pExpr->iTable ? "new" : "old"),
4065896494e8Sdrh         (pExpr->iColumn<0 ? "rowid" : pExpr->pTab->aCol[pExpr->iColumn].zName)
4066165921a7Sdan       ));
406765a7cd16Sdan 
406844dbca83Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
406965a7cd16Sdan       /* If the column has REAL affinity, it may currently be stored as an
4070113762a2Sdrh       ** integer. Use OP_RealAffinity to make sure it is really real.
4071113762a2Sdrh       **
4072113762a2Sdrh       ** EVIDENCE-OF: R-60985-57662 SQLite will convert the value back to
4073113762a2Sdrh       ** floating point when extracting it from the record.  */
40742832ad42Sdan       if( pExpr->iColumn>=0
40752832ad42Sdan        && pTab->aCol[pExpr->iColumn].affinity==SQLITE_AFF_REAL
40762832ad42Sdan       ){
40772832ad42Sdan         sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
40782832ad42Sdan       }
407944dbca83Sdrh #endif
4080165921a7Sdan       break;
4081165921a7Sdan     }
4082165921a7Sdan 
408371c57db0Sdan     case TK_VECTOR: {
4084e835bc12Sdrh       sqlite3ErrorMsg(pParse, "row value misused");
408571c57db0Sdan       break;
408671c57db0Sdan     }
408771c57db0Sdan 
408831d6fd55Sdrh     case TK_IF_NULL_ROW: {
408931d6fd55Sdrh       int addrINR;
409031d6fd55Sdrh       addrINR = sqlite3VdbeAddOp1(v, OP_IfNullRow, pExpr->iTable);
409131d6fd55Sdrh       sqlite3ExprCachePush(pParse);
409231d6fd55Sdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
409331d6fd55Sdrh       sqlite3ExprCachePop(pParse);
409431d6fd55Sdrh       sqlite3VdbeJumpHere(v, addrINR);
409531d6fd55Sdrh       sqlite3VdbeChangeP3(v, addrINR, inReg);
409631d6fd55Sdrh       break;
409731d6fd55Sdrh     }
409831d6fd55Sdrh 
40992dcef11bSdrh     /*
41002dcef11bSdrh     ** Form A:
41012dcef11bSdrh     **   CASE x WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
41022dcef11bSdrh     **
41032dcef11bSdrh     ** Form B:
41042dcef11bSdrh     **   CASE WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
41052dcef11bSdrh     **
41062dcef11bSdrh     ** Form A is can be transformed into the equivalent form B as follows:
41072dcef11bSdrh     **   CASE WHEN x=e1 THEN r1 WHEN x=e2 THEN r2 ...
41082dcef11bSdrh     **        WHEN x=eN THEN rN ELSE y END
41092dcef11bSdrh     **
41102dcef11bSdrh     ** X (if it exists) is in pExpr->pLeft.
4111c5cd1249Sdrh     ** Y is in the last element of pExpr->x.pList if pExpr->x.pList->nExpr is
4112c5cd1249Sdrh     ** odd.  The Y is also optional.  If the number of elements in x.pList
4113c5cd1249Sdrh     ** is even, then Y is omitted and the "otherwise" result is NULL.
41142dcef11bSdrh     ** Ei is in pExpr->pList->a[i*2] and Ri is pExpr->pList->a[i*2+1].
41152dcef11bSdrh     **
41162dcef11bSdrh     ** The result of the expression is the Ri for the first matching Ei,
41172dcef11bSdrh     ** or if there is no matching Ei, the ELSE term Y, or if there is
41182dcef11bSdrh     ** no ELSE term, NULL.
41192dcef11bSdrh     */
412033cd4909Sdrh     default: assert( op==TK_CASE ); {
41212dcef11bSdrh       int endLabel;                     /* GOTO label for end of CASE stmt */
41222dcef11bSdrh       int nextCase;                     /* GOTO label for next WHEN clause */
41232dcef11bSdrh       int nExpr;                        /* 2x number of WHEN terms */
41242dcef11bSdrh       int i;                            /* Loop counter */
41252dcef11bSdrh       ExprList *pEList;                 /* List of WHEN terms */
41262dcef11bSdrh       struct ExprList_item *aListelem;  /* Array of WHEN terms */
41272dcef11bSdrh       Expr opCompare;                   /* The X==Ei expression */
41282dcef11bSdrh       Expr *pX;                         /* The X expression */
41291bd10f8aSdrh       Expr *pTest = 0;                  /* X==Ei (form A) or just Ei (form B) */
4130ceea3321Sdrh       VVA_ONLY( int iCacheLevel = pParse->iCacheLevel; )
413117a7f8ddSdrh 
41326ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) && pExpr->x.pList );
41336ab3a2ecSdanielk1977       assert(pExpr->x.pList->nExpr > 0);
41346ab3a2ecSdanielk1977       pEList = pExpr->x.pList;
4135be5c89acSdrh       aListelem = pEList->a;
4136be5c89acSdrh       nExpr = pEList->nExpr;
41372dcef11bSdrh       endLabel = sqlite3VdbeMakeLabel(v);
41382dcef11bSdrh       if( (pX = pExpr->pLeft)!=0 ){
413910d1edf0Sdrh         tempX = *pX;
414033cd4909Sdrh         testcase( pX->op==TK_COLUMN );
414112abf408Sdrh         exprToRegister(&tempX, exprCodeVector(pParse, &tempX, &regFree1));
4142c5499befSdrh         testcase( regFree1==0 );
4143abb9d5f1Sdrh         memset(&opCompare, 0, sizeof(opCompare));
41442dcef11bSdrh         opCompare.op = TK_EQ;
414510d1edf0Sdrh         opCompare.pLeft = &tempX;
41462dcef11bSdrh         pTest = &opCompare;
41478b1db07fSdrh         /* Ticket b351d95f9cd5ef17e9d9dbae18f5ca8611190001:
41488b1db07fSdrh         ** The value in regFree1 might get SCopy-ed into the file result.
41498b1db07fSdrh         ** So make sure that the regFree1 register is not reused for other
41508b1db07fSdrh         ** purposes and possibly overwritten.  */
41518b1db07fSdrh         regFree1 = 0;
4152cce7d176Sdrh       }
4153c5cd1249Sdrh       for(i=0; i<nExpr-1; i=i+2){
4154ceea3321Sdrh         sqlite3ExprCachePush(pParse);
41552dcef11bSdrh         if( pX ){
41561bd10f8aSdrh           assert( pTest!=0 );
41572dcef11bSdrh           opCompare.pRight = aListelem[i].pExpr;
4158f5905aa7Sdrh         }else{
41592dcef11bSdrh           pTest = aListelem[i].pExpr;
416017a7f8ddSdrh         }
41612dcef11bSdrh         nextCase = sqlite3VdbeMakeLabel(v);
416233cd4909Sdrh         testcase( pTest->op==TK_COLUMN );
41632dcef11bSdrh         sqlite3ExprIfFalse(pParse, pTest, nextCase, SQLITE_JUMPIFNULL);
4164c5499befSdrh         testcase( aListelem[i+1].pExpr->op==TK_COLUMN );
41659de221dfSdrh         sqlite3ExprCode(pParse, aListelem[i+1].pExpr, target);
4166076e85f5Sdrh         sqlite3VdbeGoto(v, endLabel);
4167d2490904Sdrh         sqlite3ExprCachePop(pParse);
41682dcef11bSdrh         sqlite3VdbeResolveLabel(v, nextCase);
4169f570f011Sdrh       }
4170c5cd1249Sdrh       if( (nExpr&1)!=0 ){
4171ceea3321Sdrh         sqlite3ExprCachePush(pParse);
4172c5cd1249Sdrh         sqlite3ExprCode(pParse, pEList->a[nExpr-1].pExpr, target);
4173d2490904Sdrh         sqlite3ExprCachePop(pParse);
417417a7f8ddSdrh       }else{
41759de221dfSdrh         sqlite3VdbeAddOp2(v, OP_Null, 0, target);
417617a7f8ddSdrh       }
4177c332cc30Sdrh       assert( pParse->db->mallocFailed || pParse->nErr>0
4178c1f4a19bSdanielk1977            || pParse->iCacheLevel==iCacheLevel );
41792dcef11bSdrh       sqlite3VdbeResolveLabel(v, endLabel);
41806f34903eSdanielk1977       break;
41816f34903eSdanielk1977     }
41825338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_TRIGGER
41836f34903eSdanielk1977     case TK_RAISE: {
4184165921a7Sdan       assert( pExpr->affinity==OE_Rollback
4185165921a7Sdan            || pExpr->affinity==OE_Abort
4186165921a7Sdan            || pExpr->affinity==OE_Fail
4187165921a7Sdan            || pExpr->affinity==OE_Ignore
4188165921a7Sdan       );
4189e0af83acSdan       if( !pParse->pTriggerTab ){
4190e0af83acSdan         sqlite3ErrorMsg(pParse,
4191e0af83acSdan                        "RAISE() may only be used within a trigger-program");
4192e0af83acSdan         return 0;
4193e0af83acSdan       }
4194e0af83acSdan       if( pExpr->affinity==OE_Abort ){
4195e0af83acSdan         sqlite3MayAbort(pParse);
4196e0af83acSdan       }
419733e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
4198e0af83acSdan       if( pExpr->affinity==OE_Ignore ){
4199e0af83acSdan         sqlite3VdbeAddOp4(
4200e0af83acSdan             v, OP_Halt, SQLITE_OK, OE_Ignore, 0, pExpr->u.zToken,0);
4201688852abSdrh         VdbeCoverage(v);
4202e0af83acSdan       }else{
4203433dccfbSdrh         sqlite3HaltConstraint(pParse, SQLITE_CONSTRAINT_TRIGGER,
4204f9c8ce3cSdrh                               pExpr->affinity, pExpr->u.zToken, 0, 0);
4205e0af83acSdan       }
4206e0af83acSdan 
4207ffe07b2dSdrh       break;
420817a7f8ddSdrh     }
42095338a5f7Sdanielk1977 #endif
4210ffe07b2dSdrh   }
42112dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
42122dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
42132dcef11bSdrh   return inReg;
42145b6afba9Sdrh }
42152dcef11bSdrh 
42162dcef11bSdrh /*
4217d1a01edaSdrh ** Factor out the code of the given expression to initialization time.
42181e9b53f9Sdrh **
4219ad879ffdSdrh ** If regDest>=0 then the result is always stored in that register and the
4220ad879ffdSdrh ** result is not reusable.  If regDest<0 then this routine is free to
4221ad879ffdSdrh ** store the value whereever it wants.  The register where the expression
4222ad879ffdSdrh ** is stored is returned.  When regDest<0, two identical expressions will
4223ad879ffdSdrh ** code to the same register.
4224d1a01edaSdrh */
42251e9b53f9Sdrh int sqlite3ExprCodeAtInit(
4226d673cddaSdrh   Parse *pParse,    /* Parsing context */
4227d673cddaSdrh   Expr *pExpr,      /* The expression to code when the VDBE initializes */
4228ad879ffdSdrh   int regDest       /* Store the value in this register */
4229d673cddaSdrh ){
4230d1a01edaSdrh   ExprList *p;
4231d9f158e7Sdrh   assert( ConstFactorOk(pParse) );
4232d1a01edaSdrh   p = pParse->pConstExpr;
4233ad879ffdSdrh   if( regDest<0 && p ){
42341e9b53f9Sdrh     struct ExprList_item *pItem;
42351e9b53f9Sdrh     int i;
42361e9b53f9Sdrh     for(pItem=p->a, i=p->nExpr; i>0; pItem++, i--){
42375aa550cfSdan       if( pItem->reusable && sqlite3ExprCompare(0,pItem->pExpr,pExpr,-1)==0 ){
42381e9b53f9Sdrh         return pItem->u.iConstExprReg;
42391e9b53f9Sdrh       }
42401e9b53f9Sdrh     }
42411e9b53f9Sdrh   }
4242d1a01edaSdrh   pExpr = sqlite3ExprDup(pParse->db, pExpr, 0);
4243d1a01edaSdrh   p = sqlite3ExprListAppend(pParse, p, pExpr);
4244d673cddaSdrh   if( p ){
4245d673cddaSdrh      struct ExprList_item *pItem = &p->a[p->nExpr-1];
4246ad879ffdSdrh      pItem->reusable = regDest<0;
4247ad879ffdSdrh      if( regDest<0 ) regDest = ++pParse->nMem;
4248d673cddaSdrh      pItem->u.iConstExprReg = regDest;
4249d673cddaSdrh   }
4250d1a01edaSdrh   pParse->pConstExpr = p;
42511e9b53f9Sdrh   return regDest;
4252d1a01edaSdrh }
4253d1a01edaSdrh 
4254d1a01edaSdrh /*
42552dcef11bSdrh ** Generate code to evaluate an expression and store the results
42562dcef11bSdrh ** into a register.  Return the register number where the results
42572dcef11bSdrh ** are stored.
42582dcef11bSdrh **
42592dcef11bSdrh ** If the register is a temporary register that can be deallocated,
4260678ccce8Sdrh ** then write its number into *pReg.  If the result register is not
42612dcef11bSdrh ** a temporary, then set *pReg to zero.
4262f30a969bSdrh **
4263f30a969bSdrh ** If pExpr is a constant, then this routine might generate this
4264f30a969bSdrh ** code to fill the register in the initialization section of the
4265f30a969bSdrh ** VDBE program, in order to factor it out of the evaluation loop.
42662dcef11bSdrh */
42672dcef11bSdrh int sqlite3ExprCodeTemp(Parse *pParse, Expr *pExpr, int *pReg){
4268f30a969bSdrh   int r2;
4269f30a969bSdrh   pExpr = sqlite3ExprSkipCollate(pExpr);
4270d9f158e7Sdrh   if( ConstFactorOk(pParse)
4271f30a969bSdrh    && pExpr->op!=TK_REGISTER
4272f30a969bSdrh    && sqlite3ExprIsConstantNotJoin(pExpr)
4273f30a969bSdrh   ){
4274f30a969bSdrh     *pReg  = 0;
4275ad879ffdSdrh     r2 = sqlite3ExprCodeAtInit(pParse, pExpr, -1);
4276f30a969bSdrh   }else{
42772dcef11bSdrh     int r1 = sqlite3GetTempReg(pParse);
4278f30a969bSdrh     r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
42792dcef11bSdrh     if( r2==r1 ){
42802dcef11bSdrh       *pReg = r1;
42812dcef11bSdrh     }else{
42822dcef11bSdrh       sqlite3ReleaseTempReg(pParse, r1);
42832dcef11bSdrh       *pReg = 0;
42842dcef11bSdrh     }
4285f30a969bSdrh   }
42862dcef11bSdrh   return r2;
42872dcef11bSdrh }
42882dcef11bSdrh 
42892dcef11bSdrh /*
42902dcef11bSdrh ** Generate code that will evaluate expression pExpr and store the
42912dcef11bSdrh ** results in register target.  The results are guaranteed to appear
42922dcef11bSdrh ** in register target.
42932dcef11bSdrh */
429405a86c5cSdrh void sqlite3ExprCode(Parse *pParse, Expr *pExpr, int target){
42959cbf3425Sdrh   int inReg;
42969cbf3425Sdrh 
42979cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
4298ebc16717Sdrh   if( pExpr && pExpr->op==TK_REGISTER ){
4299ebc16717Sdrh     sqlite3VdbeAddOp2(pParse->pVdbe, OP_Copy, pExpr->iTable, target);
4300ebc16717Sdrh   }else{
43019cbf3425Sdrh     inReg = sqlite3ExprCodeTarget(pParse, pExpr, target);
43021c75c9d7Sdrh     assert( pParse->pVdbe!=0 || pParse->db->mallocFailed );
43030e359b30Sdrh     if( inReg!=target && pParse->pVdbe ){
43049cbf3425Sdrh       sqlite3VdbeAddOp2(pParse->pVdbe, OP_SCopy, inReg, target);
430517a7f8ddSdrh     }
4306ebc16717Sdrh   }
4307cce7d176Sdrh }
4308cce7d176Sdrh 
4309cce7d176Sdrh /*
43101c75c9d7Sdrh ** Make a transient copy of expression pExpr and then code it using
43111c75c9d7Sdrh ** sqlite3ExprCode().  This routine works just like sqlite3ExprCode()
43121c75c9d7Sdrh ** except that the input expression is guaranteed to be unchanged.
43131c75c9d7Sdrh */
43141c75c9d7Sdrh void sqlite3ExprCodeCopy(Parse *pParse, Expr *pExpr, int target){
43151c75c9d7Sdrh   sqlite3 *db = pParse->db;
43161c75c9d7Sdrh   pExpr = sqlite3ExprDup(db, pExpr, 0);
43171c75c9d7Sdrh   if( !db->mallocFailed ) sqlite3ExprCode(pParse, pExpr, target);
43181c75c9d7Sdrh   sqlite3ExprDelete(db, pExpr);
43191c75c9d7Sdrh }
43201c75c9d7Sdrh 
43211c75c9d7Sdrh /*
432205a86c5cSdrh ** Generate code that will evaluate expression pExpr and store the
432305a86c5cSdrh ** results in register target.  The results are guaranteed to appear
432405a86c5cSdrh ** in register target.  If the expression is constant, then this routine
432505a86c5cSdrh ** might choose to code the expression at initialization time.
432605a86c5cSdrh */
432705a86c5cSdrh void sqlite3ExprCodeFactorable(Parse *pParse, Expr *pExpr, int target){
432805a86c5cSdrh   if( pParse->okConstFactor && sqlite3ExprIsConstant(pExpr) ){
4329ad879ffdSdrh     sqlite3ExprCodeAtInit(pParse, pExpr, target);
433005a86c5cSdrh   }else{
433105a86c5cSdrh     sqlite3ExprCode(pParse, pExpr, target);
433205a86c5cSdrh   }
4333cce7d176Sdrh }
4334cce7d176Sdrh 
4335cce7d176Sdrh /*
433660ec914cSpeter.d.reid ** Generate code that evaluates the given expression and puts the result
4337de4fcfddSdrh ** in register target.
433825303780Sdrh **
43392dcef11bSdrh ** Also make a copy of the expression results into another "cache" register
43402dcef11bSdrh ** and modify the expression so that the next time it is evaluated,
43412dcef11bSdrh ** the result is a copy of the cache register.
43422dcef11bSdrh **
43432dcef11bSdrh ** This routine is used for expressions that are used multiple
43442dcef11bSdrh ** times.  They are evaluated once and the results of the expression
43452dcef11bSdrh ** are reused.
434625303780Sdrh */
434705a86c5cSdrh void sqlite3ExprCodeAndCache(Parse *pParse, Expr *pExpr, int target){
434825303780Sdrh   Vdbe *v = pParse->pVdbe;
434925303780Sdrh   int iMem;
435005a86c5cSdrh 
435105a86c5cSdrh   assert( target>0 );
435205a86c5cSdrh   assert( pExpr->op!=TK_REGISTER );
435305a86c5cSdrh   sqlite3ExprCode(pParse, pExpr, target);
43542dcef11bSdrh   iMem = ++pParse->nMem;
435505a86c5cSdrh   sqlite3VdbeAddOp2(v, OP_Copy, target, iMem);
4356a4c3c87eSdrh   exprToRegister(pExpr, iMem);
435725303780Sdrh }
43587e02e5e6Sdrh 
4359678ccce8Sdrh /*
4360268380caSdrh ** Generate code that pushes the value of every element of the given
43619cbf3425Sdrh ** expression list into a sequence of registers beginning at target.
4362268380caSdrh **
43633df6c3b1Sdrh ** Return the number of elements evaluated.  The number returned will
43643df6c3b1Sdrh ** usually be pList->nExpr but might be reduced if SQLITE_ECEL_OMITREF
43653df6c3b1Sdrh ** is defined.
4366d1a01edaSdrh **
4367d1a01edaSdrh ** The SQLITE_ECEL_DUP flag prevents the arguments from being
4368d1a01edaSdrh ** filled using OP_SCopy.  OP_Copy must be used instead.
4369d1a01edaSdrh **
4370d1a01edaSdrh ** The SQLITE_ECEL_FACTOR argument allows constant arguments to be
4371d1a01edaSdrh ** factored out into initialization code.
4372b0df9634Sdrh **
4373b0df9634Sdrh ** The SQLITE_ECEL_REF flag means that expressions in the list with
4374b0df9634Sdrh ** ExprList.a[].u.x.iOrderByCol>0 have already been evaluated and stored
4375b0df9634Sdrh ** in registers at srcReg, and so the value can be copied from there.
43763df6c3b1Sdrh ** If SQLITE_ECEL_OMITREF is also set, then the values with u.x.iOrderByCol>0
43773df6c3b1Sdrh ** are simply omitted rather than being copied from srcReg.
4378268380caSdrh */
43794adee20fSdanielk1977 int sqlite3ExprCodeExprList(
4380268380caSdrh   Parse *pParse,     /* Parsing context */
4381389a1adbSdrh   ExprList *pList,   /* The expression list to be coded */
4382191b54cbSdrh   int target,        /* Where to write results */
43835579d59fSdrh   int srcReg,        /* Source registers if SQLITE_ECEL_REF */
4384d1a01edaSdrh   u8 flags           /* SQLITE_ECEL_* flags */
4385268380caSdrh ){
4386268380caSdrh   struct ExprList_item *pItem;
43875579d59fSdrh   int i, j, n;
4388d1a01edaSdrh   u8 copyOp = (flags & SQLITE_ECEL_DUP) ? OP_Copy : OP_SCopy;
43895579d59fSdrh   Vdbe *v = pParse->pVdbe;
43909d8b3072Sdrh   assert( pList!=0 );
43919cbf3425Sdrh   assert( target>0 );
4392d81a142bSdrh   assert( pParse->pVdbe!=0 );  /* Never gets this far otherwise */
4393268380caSdrh   n = pList->nExpr;
4394d9f158e7Sdrh   if( !ConstFactorOk(pParse) ) flags &= ~SQLITE_ECEL_FACTOR;
4395191b54cbSdrh   for(pItem=pList->a, i=0; i<n; i++, pItem++){
43967445ffe2Sdrh     Expr *pExpr = pItem->pExpr;
439724e25d32Sdan #ifdef SQLITE_ENABLE_SORTER_REFERENCES
439824e25d32Sdan     if( pItem->bSorterRef ){
439924e25d32Sdan       i--;
440024e25d32Sdan       n--;
440124e25d32Sdan     }else
440224e25d32Sdan #endif
4403257c13faSdan     if( (flags & SQLITE_ECEL_REF)!=0 && (j = pItem->u.x.iOrderByCol)>0 ){
4404257c13faSdan       if( flags & SQLITE_ECEL_OMITREF ){
4405257c13faSdan         i--;
4406257c13faSdan         n--;
4407257c13faSdan       }else{
44085579d59fSdrh         sqlite3VdbeAddOp2(v, copyOp, j+srcReg-1, target+i);
4409257c13faSdan       }
44105579d59fSdrh     }else if( (flags & SQLITE_ECEL_FACTOR)!=0 && sqlite3ExprIsConstant(pExpr) ){
4411ad879ffdSdrh       sqlite3ExprCodeAtInit(pParse, pExpr, target+i);
4412d1a01edaSdrh     }else{
44137445ffe2Sdrh       int inReg = sqlite3ExprCodeTarget(pParse, pExpr, target+i);
4414746fd9ccSdrh       if( inReg!=target+i ){
44154eded604Sdrh         VdbeOp *pOp;
44164eded604Sdrh         if( copyOp==OP_Copy
44174eded604Sdrh          && (pOp=sqlite3VdbeGetOp(v, -1))->opcode==OP_Copy
44184eded604Sdrh          && pOp->p1+pOp->p3+1==inReg
44194eded604Sdrh          && pOp->p2+pOp->p3+1==target+i
44204eded604Sdrh         ){
44214eded604Sdrh           pOp->p3++;
44224eded604Sdrh         }else{
44234eded604Sdrh           sqlite3VdbeAddOp2(v, copyOp, inReg, target+i);
44244eded604Sdrh         }
4425d1a01edaSdrh       }
4426d176611bSdrh     }
4427268380caSdrh   }
4428f9b596ebSdrh   return n;
4429268380caSdrh }
4430268380caSdrh 
4431268380caSdrh /*
443236c563a2Sdrh ** Generate code for a BETWEEN operator.
443336c563a2Sdrh **
443436c563a2Sdrh **    x BETWEEN y AND z
443536c563a2Sdrh **
443636c563a2Sdrh ** The above is equivalent to
443736c563a2Sdrh **
443836c563a2Sdrh **    x>=y AND x<=z
443936c563a2Sdrh **
444036c563a2Sdrh ** Code it as such, taking care to do the common subexpression
444160ec914cSpeter.d.reid ** elimination of x.
444284b19a3dSdrh **
444384b19a3dSdrh ** The xJumpIf parameter determines details:
444484b19a3dSdrh **
444584b19a3dSdrh **    NULL:                   Store the boolean result in reg[dest]
444684b19a3dSdrh **    sqlite3ExprIfTrue:      Jump to dest if true
444784b19a3dSdrh **    sqlite3ExprIfFalse:     Jump to dest if false
444884b19a3dSdrh **
444984b19a3dSdrh ** The jumpIfNull parameter is ignored if xJumpIf is NULL.
445036c563a2Sdrh */
445136c563a2Sdrh static void exprCodeBetween(
445236c563a2Sdrh   Parse *pParse,    /* Parsing and code generating context */
445336c563a2Sdrh   Expr *pExpr,      /* The BETWEEN expression */
445484b19a3dSdrh   int dest,         /* Jump destination or storage location */
445584b19a3dSdrh   void (*xJump)(Parse*,Expr*,int,int), /* Action to take */
445636c563a2Sdrh   int jumpIfNull    /* Take the jump if the BETWEEN is NULL */
445736c563a2Sdrh ){
445836c563a2Sdrh  Expr exprAnd;     /* The AND operator in  x>=y AND x<=z  */
445936c563a2Sdrh   Expr compLeft;    /* The  x>=y  term */
446036c563a2Sdrh   Expr compRight;   /* The  x<=z  term */
4461db45bd5eSdrh   Expr exprX;       /* The  x  subexpression */
4462db45bd5eSdrh   int regFree1 = 0; /* Temporary use register */
446384b19a3dSdrh 
446436c563a2Sdrh 
446571c57db0Sdan   memset(&compLeft, 0, sizeof(Expr));
446671c57db0Sdan   memset(&compRight, 0, sizeof(Expr));
446771c57db0Sdan   memset(&exprAnd, 0, sizeof(Expr));
4468db45bd5eSdrh 
4469db45bd5eSdrh   assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
4470db45bd5eSdrh   exprX = *pExpr->pLeft;
447136c563a2Sdrh   exprAnd.op = TK_AND;
447236c563a2Sdrh   exprAnd.pLeft = &compLeft;
447336c563a2Sdrh   exprAnd.pRight = &compRight;
447436c563a2Sdrh   compLeft.op = TK_GE;
4475db45bd5eSdrh   compLeft.pLeft = &exprX;
447636c563a2Sdrh   compLeft.pRight = pExpr->x.pList->a[0].pExpr;
447736c563a2Sdrh   compRight.op = TK_LE;
4478db45bd5eSdrh   compRight.pLeft = &exprX;
447936c563a2Sdrh   compRight.pRight = pExpr->x.pList->a[1].pExpr;
448012abf408Sdrh   exprToRegister(&exprX, exprCodeVector(pParse, &exprX, &regFree1));
448184b19a3dSdrh   if( xJump ){
448284b19a3dSdrh     xJump(pParse, &exprAnd, dest, jumpIfNull);
448336c563a2Sdrh   }else{
448436fd41e5Sdrh     /* Mark the expression is being from the ON or USING clause of a join
448536fd41e5Sdrh     ** so that the sqlite3ExprCodeTarget() routine will not attempt to move
448636fd41e5Sdrh     ** it into the Parse.pConstExpr list.  We should use a new bit for this,
448736fd41e5Sdrh     ** for clarity, but we are out of bits in the Expr.flags field so we
448836fd41e5Sdrh     ** have to reuse the EP_FromJoin bit.  Bummer. */
4489db45bd5eSdrh     exprX.flags |= EP_FromJoin;
449071c57db0Sdan     sqlite3ExprCodeTarget(pParse, &exprAnd, dest);
449136c563a2Sdrh   }
4492db45bd5eSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
449336c563a2Sdrh 
449436c563a2Sdrh   /* Ensure adequate test coverage */
4495db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull==0 && regFree1==0 );
4496db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull==0 && regFree1!=0 );
4497db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull!=0 && regFree1==0 );
4498db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull!=0 && regFree1!=0 );
4499db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1==0 );
4500db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1!=0 );
4501db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1==0 );
4502db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1!=0 );
450384b19a3dSdrh   testcase( xJump==0 );
450436c563a2Sdrh }
450536c563a2Sdrh 
450636c563a2Sdrh /*
4507cce7d176Sdrh ** Generate code for a boolean expression such that a jump is made
4508cce7d176Sdrh ** to the label "dest" if the expression is true but execution
4509cce7d176Sdrh ** continues straight thru if the expression is false.
4510f5905aa7Sdrh **
4511f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false), then
451235573356Sdrh ** take the jump if the jumpIfNull flag is SQLITE_JUMPIFNULL.
4513f2bc013cSdrh **
4514f2bc013cSdrh ** This code depends on the fact that certain token values (ex: TK_EQ)
4515f2bc013cSdrh ** are the same as opcode values (ex: OP_Eq) that implement the corresponding
4516f2bc013cSdrh ** operation.  Special comments in vdbe.c and the mkopcodeh.awk script in
4517f2bc013cSdrh ** the make process cause these values to align.  Assert()s in the code
4518f2bc013cSdrh ** below verify that the numbers are aligned correctly.
4519cce7d176Sdrh */
45204adee20fSdanielk1977 void sqlite3ExprIfTrue(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
4521cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
4522cce7d176Sdrh   int op = 0;
45232dcef11bSdrh   int regFree1 = 0;
45242dcef11bSdrh   int regFree2 = 0;
45252dcef11bSdrh   int r1, r2;
45262dcef11bSdrh 
452735573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
452848864df9Smistachkin   if( NEVER(v==0) )     return;  /* Existence of VDBE checked by caller */
452933cd4909Sdrh   if( NEVER(pExpr==0) ) return;  /* No way this can happen */
4530f2bc013cSdrh   op = pExpr->op;
45317b35a77bSdan   switch( op ){
4532cce7d176Sdrh     case TK_AND: {
45334adee20fSdanielk1977       int d2 = sqlite3VdbeMakeLabel(v);
4534c5499befSdrh       testcase( jumpIfNull==0 );
453535573356Sdrh       sqlite3ExprIfFalse(pParse, pExpr->pLeft, d2,jumpIfNull^SQLITE_JUMPIFNULL);
453654e2adb5Sdrh       sqlite3ExprCachePush(pParse);
45374adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
45384adee20fSdanielk1977       sqlite3VdbeResolveLabel(v, d2);
4539d2490904Sdrh       sqlite3ExprCachePop(pParse);
4540cce7d176Sdrh       break;
4541cce7d176Sdrh     }
4542cce7d176Sdrh     case TK_OR: {
4543c5499befSdrh       testcase( jumpIfNull==0 );
45444adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
454554e2adb5Sdrh       sqlite3ExprCachePush(pParse);
45464adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
4547d2490904Sdrh       sqlite3ExprCachePop(pParse);
4548cce7d176Sdrh       break;
4549cce7d176Sdrh     }
4550cce7d176Sdrh     case TK_NOT: {
4551c5499befSdrh       testcase( jumpIfNull==0 );
45524adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
4553cce7d176Sdrh       break;
4554cce7d176Sdrh     }
45558abed7b9Sdrh     case TK_TRUTH: {
455696acafbeSdrh       int isNot;      /* IS NOT TRUE or IS NOT FALSE */
455796acafbeSdrh       int isTrue;     /* IS TRUE or IS NOT TRUE */
4558007c843bSdrh       testcase( jumpIfNull==0 );
45598abed7b9Sdrh       isNot = pExpr->op2==TK_ISNOT;
456096acafbeSdrh       isTrue = sqlite3ExprTruthValue(pExpr->pRight);
456143c4ac8bSdrh       testcase( isTrue && isNot );
456296acafbeSdrh       testcase( !isTrue && isNot );
456343c4ac8bSdrh       if( isTrue ^ isNot ){
45648abed7b9Sdrh         sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
45658abed7b9Sdrh                           isNot ? SQLITE_JUMPIFNULL : 0);
45668abed7b9Sdrh       }else{
45678abed7b9Sdrh         sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
45688abed7b9Sdrh                            isNot ? SQLITE_JUMPIFNULL : 0);
45698abed7b9Sdrh       }
4570007c843bSdrh       break;
4571007c843bSdrh     }
4572de845c2fSdrh     case TK_IS:
4573de845c2fSdrh     case TK_ISNOT:
4574de845c2fSdrh       testcase( op==TK_IS );
4575de845c2fSdrh       testcase( op==TK_ISNOT );
4576de845c2fSdrh       op = (op==TK_IS) ? TK_EQ : TK_NE;
4577de845c2fSdrh       jumpIfNull = SQLITE_NULLEQ;
4578de845c2fSdrh       /* Fall thru */
4579cce7d176Sdrh     case TK_LT:
4580cce7d176Sdrh     case TK_LE:
4581cce7d176Sdrh     case TK_GT:
4582cce7d176Sdrh     case TK_GE:
4583cce7d176Sdrh     case TK_NE:
45840ac65892Sdrh     case TK_EQ: {
4585625015e0Sdan       if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
4586c5499befSdrh       testcase( jumpIfNull==0 );
4587b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4588b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
458935573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
45902dcef11bSdrh                   r1, r2, dest, jumpIfNull);
45917d176105Sdrh       assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
45927d176105Sdrh       assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
45937d176105Sdrh       assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
45947d176105Sdrh       assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
4595de845c2fSdrh       assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4596de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4597de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4598de845c2fSdrh       assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4599de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
4600de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
46016a2fe093Sdrh       testcase( regFree1==0 );
46026a2fe093Sdrh       testcase( regFree2==0 );
46036a2fe093Sdrh       break;
46046a2fe093Sdrh     }
4605cce7d176Sdrh     case TK_ISNULL:
4606cce7d176Sdrh     case TK_NOTNULL: {
46077d176105Sdrh       assert( TK_ISNULL==OP_IsNull );   testcase( op==TK_ISNULL );
46087d176105Sdrh       assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
46092dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
46102dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
46117d176105Sdrh       VdbeCoverageIf(v, op==TK_ISNULL);
46127d176105Sdrh       VdbeCoverageIf(v, op==TK_NOTNULL);
4613c5499befSdrh       testcase( regFree1==0 );
4614cce7d176Sdrh       break;
4615cce7d176Sdrh     }
4616fef5208cSdrh     case TK_BETWEEN: {
46175c03f30aSdrh       testcase( jumpIfNull==0 );
461871c57db0Sdan       exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfTrue, jumpIfNull);
4619fef5208cSdrh       break;
4620fef5208cSdrh     }
4621bb201344Sshaneh #ifndef SQLITE_OMIT_SUBQUERY
4622e3365e6cSdrh     case TK_IN: {
4623e3365e6cSdrh       int destIfFalse = sqlite3VdbeMakeLabel(v);
4624e3365e6cSdrh       int destIfNull = jumpIfNull ? dest : destIfFalse;
4625e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
4626076e85f5Sdrh       sqlite3VdbeGoto(v, dest);
4627e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
4628e3365e6cSdrh       break;
4629e3365e6cSdrh     }
4630bb201344Sshaneh #endif
4631cce7d176Sdrh     default: {
46327b35a77bSdan     default_expr:
4633991a1985Sdrh       if( exprAlwaysTrue(pExpr) ){
4634076e85f5Sdrh         sqlite3VdbeGoto(v, dest);
4635991a1985Sdrh       }else if( exprAlwaysFalse(pExpr) ){
4636991a1985Sdrh         /* No-op */
4637991a1985Sdrh       }else{
46382dcef11bSdrh         r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
46392dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_If, r1, dest, jumpIfNull!=0);
4640688852abSdrh         VdbeCoverage(v);
4641c5499befSdrh         testcase( regFree1==0 );
4642c5499befSdrh         testcase( jumpIfNull==0 );
4643991a1985Sdrh       }
4644cce7d176Sdrh       break;
4645cce7d176Sdrh     }
4646cce7d176Sdrh   }
46472dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
46482dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
4649cce7d176Sdrh }
4650cce7d176Sdrh 
4651cce7d176Sdrh /*
465266b89c8fSdrh ** Generate code for a boolean expression such that a jump is made
4653cce7d176Sdrh ** to the label "dest" if the expression is false but execution
4654cce7d176Sdrh ** continues straight thru if the expression is true.
4655f5905aa7Sdrh **
4656f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false) then
465735573356Sdrh ** jump if jumpIfNull is SQLITE_JUMPIFNULL or fall through if jumpIfNull
465835573356Sdrh ** is 0.
4659cce7d176Sdrh */
46604adee20fSdanielk1977 void sqlite3ExprIfFalse(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
4661cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
4662cce7d176Sdrh   int op = 0;
46632dcef11bSdrh   int regFree1 = 0;
46642dcef11bSdrh   int regFree2 = 0;
46652dcef11bSdrh   int r1, r2;
46662dcef11bSdrh 
466735573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
466848864df9Smistachkin   if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
466933cd4909Sdrh   if( pExpr==0 )    return;
4670f2bc013cSdrh 
4671f2bc013cSdrh   /* The value of pExpr->op and op are related as follows:
4672f2bc013cSdrh   **
4673f2bc013cSdrh   **       pExpr->op            op
4674f2bc013cSdrh   **       ---------          ----------
4675f2bc013cSdrh   **       TK_ISNULL          OP_NotNull
4676f2bc013cSdrh   **       TK_NOTNULL         OP_IsNull
4677f2bc013cSdrh   **       TK_NE              OP_Eq
4678f2bc013cSdrh   **       TK_EQ              OP_Ne
4679f2bc013cSdrh   **       TK_GT              OP_Le
4680f2bc013cSdrh   **       TK_LE              OP_Gt
4681f2bc013cSdrh   **       TK_GE              OP_Lt
4682f2bc013cSdrh   **       TK_LT              OP_Ge
4683f2bc013cSdrh   **
4684f2bc013cSdrh   ** For other values of pExpr->op, op is undefined and unused.
4685f2bc013cSdrh   ** The value of TK_ and OP_ constants are arranged such that we
4686f2bc013cSdrh   ** can compute the mapping above using the following expression.
4687f2bc013cSdrh   ** Assert()s verify that the computation is correct.
4688f2bc013cSdrh   */
4689f2bc013cSdrh   op = ((pExpr->op+(TK_ISNULL&1))^1)-(TK_ISNULL&1);
4690f2bc013cSdrh 
4691f2bc013cSdrh   /* Verify correct alignment of TK_ and OP_ constants
4692f2bc013cSdrh   */
4693f2bc013cSdrh   assert( pExpr->op!=TK_ISNULL || op==OP_NotNull );
4694f2bc013cSdrh   assert( pExpr->op!=TK_NOTNULL || op==OP_IsNull );
4695f2bc013cSdrh   assert( pExpr->op!=TK_NE || op==OP_Eq );
4696f2bc013cSdrh   assert( pExpr->op!=TK_EQ || op==OP_Ne );
4697f2bc013cSdrh   assert( pExpr->op!=TK_LT || op==OP_Ge );
4698f2bc013cSdrh   assert( pExpr->op!=TK_LE || op==OP_Gt );
4699f2bc013cSdrh   assert( pExpr->op!=TK_GT || op==OP_Le );
4700f2bc013cSdrh   assert( pExpr->op!=TK_GE || op==OP_Lt );
4701f2bc013cSdrh 
4702ba00e30aSdan   switch( pExpr->op ){
4703cce7d176Sdrh     case TK_AND: {
4704c5499befSdrh       testcase( jumpIfNull==0 );
47054adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
470654e2adb5Sdrh       sqlite3ExprCachePush(pParse);
47074adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
4708d2490904Sdrh       sqlite3ExprCachePop(pParse);
4709cce7d176Sdrh       break;
4710cce7d176Sdrh     }
4711cce7d176Sdrh     case TK_OR: {
47124adee20fSdanielk1977       int d2 = sqlite3VdbeMakeLabel(v);
4713c5499befSdrh       testcase( jumpIfNull==0 );
471435573356Sdrh       sqlite3ExprIfTrue(pParse, pExpr->pLeft, d2, jumpIfNull^SQLITE_JUMPIFNULL);
471554e2adb5Sdrh       sqlite3ExprCachePush(pParse);
47164adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
47174adee20fSdanielk1977       sqlite3VdbeResolveLabel(v, d2);
4718d2490904Sdrh       sqlite3ExprCachePop(pParse);
4719cce7d176Sdrh       break;
4720cce7d176Sdrh     }
4721cce7d176Sdrh     case TK_NOT: {
47225c03f30aSdrh       testcase( jumpIfNull==0 );
47234adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
4724cce7d176Sdrh       break;
4725cce7d176Sdrh     }
47268abed7b9Sdrh     case TK_TRUTH: {
472796acafbeSdrh       int isNot;   /* IS NOT TRUE or IS NOT FALSE */
472896acafbeSdrh       int isTrue;  /* IS TRUE or IS NOT TRUE */
47298abed7b9Sdrh       testcase( jumpIfNull==0 );
47308abed7b9Sdrh       isNot = pExpr->op2==TK_ISNOT;
473196acafbeSdrh       isTrue = sqlite3ExprTruthValue(pExpr->pRight);
473243c4ac8bSdrh       testcase( isTrue && isNot );
473396acafbeSdrh       testcase( !isTrue && isNot );
473443c4ac8bSdrh       if( isTrue ^ isNot ){
47358abed7b9Sdrh         /* IS TRUE and IS NOT FALSE */
47368abed7b9Sdrh         sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
47378abed7b9Sdrh                            isNot ? 0 : SQLITE_JUMPIFNULL);
47388abed7b9Sdrh 
47398abed7b9Sdrh       }else{
47408abed7b9Sdrh         /* IS FALSE and IS NOT TRUE */
47418abed7b9Sdrh         sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
47428abed7b9Sdrh                           isNot ? 0 : SQLITE_JUMPIFNULL);
47438abed7b9Sdrh       }
4744007c843bSdrh       break;
4745007c843bSdrh     }
4746de845c2fSdrh     case TK_IS:
4747de845c2fSdrh     case TK_ISNOT:
4748de845c2fSdrh       testcase( pExpr->op==TK_IS );
4749de845c2fSdrh       testcase( pExpr->op==TK_ISNOT );
4750de845c2fSdrh       op = (pExpr->op==TK_IS) ? TK_NE : TK_EQ;
4751de845c2fSdrh       jumpIfNull = SQLITE_NULLEQ;
4752de845c2fSdrh       /* Fall thru */
4753cce7d176Sdrh     case TK_LT:
4754cce7d176Sdrh     case TK_LE:
4755cce7d176Sdrh     case TK_GT:
4756cce7d176Sdrh     case TK_GE:
4757cce7d176Sdrh     case TK_NE:
4758cce7d176Sdrh     case TK_EQ: {
4759625015e0Sdan       if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
4760c5499befSdrh       testcase( jumpIfNull==0 );
4761b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4762b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
476335573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
47642dcef11bSdrh                   r1, r2, dest, jumpIfNull);
47657d176105Sdrh       assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
47667d176105Sdrh       assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
47677d176105Sdrh       assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
47687d176105Sdrh       assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
4769de845c2fSdrh       assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4770de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4771de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4772de845c2fSdrh       assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4773de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
4774de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
47756a2fe093Sdrh       testcase( regFree1==0 );
47766a2fe093Sdrh       testcase( regFree2==0 );
47776a2fe093Sdrh       break;
47786a2fe093Sdrh     }
4779cce7d176Sdrh     case TK_ISNULL:
4780cce7d176Sdrh     case TK_NOTNULL: {
47812dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
47822dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
47837d176105Sdrh       testcase( op==TK_ISNULL );   VdbeCoverageIf(v, op==TK_ISNULL);
47847d176105Sdrh       testcase( op==TK_NOTNULL );  VdbeCoverageIf(v, op==TK_NOTNULL);
4785c5499befSdrh       testcase( regFree1==0 );
4786cce7d176Sdrh       break;
4787cce7d176Sdrh     }
4788fef5208cSdrh     case TK_BETWEEN: {
47895c03f30aSdrh       testcase( jumpIfNull==0 );
479071c57db0Sdan       exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfFalse, jumpIfNull);
4791fef5208cSdrh       break;
4792fef5208cSdrh     }
4793bb201344Sshaneh #ifndef SQLITE_OMIT_SUBQUERY
4794e3365e6cSdrh     case TK_IN: {
4795e3365e6cSdrh       if( jumpIfNull ){
4796e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, dest);
4797e3365e6cSdrh       }else{
4798e3365e6cSdrh         int destIfNull = sqlite3VdbeMakeLabel(v);
4799e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, destIfNull);
4800e3365e6cSdrh         sqlite3VdbeResolveLabel(v, destIfNull);
4801e3365e6cSdrh       }
4802e3365e6cSdrh       break;
4803e3365e6cSdrh     }
4804bb201344Sshaneh #endif
4805cce7d176Sdrh     default: {
4806ba00e30aSdan     default_expr:
4807991a1985Sdrh       if( exprAlwaysFalse(pExpr) ){
4808076e85f5Sdrh         sqlite3VdbeGoto(v, dest);
4809991a1985Sdrh       }else if( exprAlwaysTrue(pExpr) ){
4810991a1985Sdrh         /* no-op */
4811991a1985Sdrh       }else{
48122dcef11bSdrh         r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
48132dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_IfNot, r1, dest, jumpIfNull!=0);
4814688852abSdrh         VdbeCoverage(v);
4815c5499befSdrh         testcase( regFree1==0 );
4816c5499befSdrh         testcase( jumpIfNull==0 );
4817991a1985Sdrh       }
4818cce7d176Sdrh       break;
4819cce7d176Sdrh     }
4820cce7d176Sdrh   }
48212dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
48222dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
4823cce7d176Sdrh }
48242282792aSdrh 
48252282792aSdrh /*
482672bc8208Sdrh ** Like sqlite3ExprIfFalse() except that a copy is made of pExpr before
482772bc8208Sdrh ** code generation, and that copy is deleted after code generation. This
482872bc8208Sdrh ** ensures that the original pExpr is unchanged.
482972bc8208Sdrh */
483072bc8208Sdrh void sqlite3ExprIfFalseDup(Parse *pParse, Expr *pExpr, int dest,int jumpIfNull){
483172bc8208Sdrh   sqlite3 *db = pParse->db;
483272bc8208Sdrh   Expr *pCopy = sqlite3ExprDup(db, pExpr, 0);
483372bc8208Sdrh   if( db->mallocFailed==0 ){
483472bc8208Sdrh     sqlite3ExprIfFalse(pParse, pCopy, dest, jumpIfNull);
483572bc8208Sdrh   }
483672bc8208Sdrh   sqlite3ExprDelete(db, pCopy);
483772bc8208Sdrh }
483872bc8208Sdrh 
48395aa550cfSdan /*
48405aa550cfSdan ** Expression pVar is guaranteed to be an SQL variable. pExpr may be any
48415aa550cfSdan ** type of expression.
48425aa550cfSdan **
48435aa550cfSdan ** If pExpr is a simple SQL value - an integer, real, string, blob
48445aa550cfSdan ** or NULL value - then the VDBE currently being prepared is configured
48455aa550cfSdan ** to re-prepare each time a new value is bound to variable pVar.
48465aa550cfSdan **
48475aa550cfSdan ** Additionally, if pExpr is a simple SQL value and the value is the
48485aa550cfSdan ** same as that currently bound to variable pVar, non-zero is returned.
48495aa550cfSdan ** Otherwise, if the values are not the same or if pExpr is not a simple
48505aa550cfSdan ** SQL value, zero is returned.
48515aa550cfSdan */
48525aa550cfSdan static int exprCompareVariable(Parse *pParse, Expr *pVar, Expr *pExpr){
48535aa550cfSdan   int res = 0;
4854c0804226Sdrh   int iVar;
4855c0804226Sdrh   sqlite3_value *pL, *pR = 0;
48565aa550cfSdan 
48575aa550cfSdan   sqlite3ValueFromExpr(pParse->db, pExpr, SQLITE_UTF8, SQLITE_AFF_BLOB, &pR);
4858c0804226Sdrh   if( pR ){
4859c0804226Sdrh     iVar = pVar->iColumn;
4860c0804226Sdrh     sqlite3VdbeSetVarmask(pParse->pVdbe, iVar);
4861c0804226Sdrh     pL = sqlite3VdbeGetBoundValue(pParse->pReprepare, iVar, SQLITE_AFF_BLOB);
48625aa307e2Sdrh     if( pL ){
48635aa307e2Sdrh       if( sqlite3_value_type(pL)==SQLITE_TEXT ){
48645aa307e2Sdrh         sqlite3_value_text(pL); /* Make sure the encoding is UTF-8 */
48655aa307e2Sdrh       }
48665aa307e2Sdrh       res =  0==sqlite3MemCompare(pL, pR, 0);
48675aa550cfSdan     }
48685aa550cfSdan     sqlite3ValueFree(pR);
48695aa550cfSdan     sqlite3ValueFree(pL);
48705aa550cfSdan   }
48715aa550cfSdan 
48725aa550cfSdan   return res;
48735aa550cfSdan }
487472bc8208Sdrh 
487572bc8208Sdrh /*
48761d9da70aSdrh ** Do a deep comparison of two expression trees.  Return 0 if the two
48771d9da70aSdrh ** expressions are completely identical.  Return 1 if they differ only
48781d9da70aSdrh ** by a COLLATE operator at the top level.  Return 2 if there are differences
48791d9da70aSdrh ** other than the top-level COLLATE operator.
4880d40aab0eSdrh **
4881619a1305Sdrh ** If any subelement of pB has Expr.iTable==(-1) then it is allowed
4882619a1305Sdrh ** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
4883619a1305Sdrh **
488466518ca7Sdrh ** The pA side might be using TK_REGISTER.  If that is the case and pB is
488566518ca7Sdrh ** not using TK_REGISTER but is otherwise equivalent, then still return 0.
488666518ca7Sdrh **
48871d9da70aSdrh ** Sometimes this routine will return 2 even if the two expressions
4888d40aab0eSdrh ** really are equivalent.  If we cannot prove that the expressions are
48891d9da70aSdrh ** identical, we return 2 just to be safe.  So if this routine
48901d9da70aSdrh ** returns 2, then you do not really know for certain if the two
48911d9da70aSdrh ** expressions are the same.  But if you get a 0 or 1 return, then you
4892d40aab0eSdrh ** can be sure the expressions are the same.  In the places where
48931d9da70aSdrh ** this routine is used, it does not hurt to get an extra 2 - that
4894d40aab0eSdrh ** just might result in some slightly slower code.  But returning
48951d9da70aSdrh ** an incorrect 0 or 1 could lead to a malfunction.
48965aa550cfSdan **
4897c0804226Sdrh ** If pParse is not NULL then TK_VARIABLE terms in pA with bindings in
4898c0804226Sdrh ** pParse->pReprepare can be matched against literals in pB.  The
4899c0804226Sdrh ** pParse->pVdbe->expmask bitmask is updated for each variable referenced.
4900c0804226Sdrh ** If pParse is NULL (the normal case) then any TK_VARIABLE term in
4901c0804226Sdrh ** Argument pParse should normally be NULL. If it is not NULL and pA or
4902c0804226Sdrh ** pB causes a return value of 2.
49032282792aSdrh */
49045aa550cfSdan int sqlite3ExprCompare(Parse *pParse, Expr *pA, Expr *pB, int iTab){
490510d1edf0Sdrh   u32 combinedFlags;
49064b202ae2Sdanielk1977   if( pA==0 || pB==0 ){
49071d9da70aSdrh     return pB==pA ? 0 : 2;
49082282792aSdrh   }
49095aa550cfSdan   if( pParse && pA->op==TK_VARIABLE && exprCompareVariable(pParse, pA, pB) ){
49105aa550cfSdan     return 0;
49115aa550cfSdan   }
491210d1edf0Sdrh   combinedFlags = pA->flags | pB->flags;
491310d1edf0Sdrh   if( combinedFlags & EP_IntValue ){
491410d1edf0Sdrh     if( (pA->flags&pB->flags&EP_IntValue)!=0 && pA->u.iValue==pB->u.iValue ){
491510d1edf0Sdrh       return 0;
491610d1edf0Sdrh     }
49171d9da70aSdrh     return 2;
49186ab3a2ecSdanielk1977   }
4919c2acc4e4Sdrh   if( pA->op!=pB->op ){
49205aa550cfSdan     if( pA->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA->pLeft,pB,iTab)<2 ){
4921ae80ddeaSdrh       return 1;
4922ae80ddeaSdrh     }
49235aa550cfSdan     if( pB->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA,pB->pLeft,iTab)<2 ){
4924ae80ddeaSdrh       return 1;
4925ae80ddeaSdrh     }
4926ae80ddeaSdrh     return 2;
4927ae80ddeaSdrh   }
49282edc5fd7Sdrh   if( pA->op!=TK_COLUMN && pA->op!=TK_AGG_COLUMN && pA->u.zToken ){
4929390b88a4Sdrh     if( pA->op==TK_FUNCTION ){
4930390b88a4Sdrh       if( sqlite3StrICmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
4931d5af5420Sdrh     }else if( pA->op==TK_COLLATE ){
4932e79f6299Sdrh       if( sqlite3_stricmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
4933390b88a4Sdrh     }else if( strcmp(pA->u.zToken,pB->u.zToken)!=0 ){
4934d5af5420Sdrh       return 2;
493510d1edf0Sdrh     }
493610d1edf0Sdrh   }
493710d1edf0Sdrh   if( (pA->flags & EP_Distinct)!=(pB->flags & EP_Distinct) ) return 2;
493885f8aa79Sdrh   if( ALWAYS((combinedFlags & EP_TokenOnly)==0) ){
493910d1edf0Sdrh     if( combinedFlags & EP_xIsSelect ) return 2;
49405aa550cfSdan     if( sqlite3ExprCompare(pParse, pA->pLeft, pB->pLeft, iTab) ) return 2;
49415aa550cfSdan     if( sqlite3ExprCompare(pParse, pA->pRight, pB->pRight, iTab) ) return 2;
4942619a1305Sdrh     if( sqlite3ExprListCompare(pA->x.pList, pB->x.pList, iTab) ) return 2;
4943f49ff6ffSdrh     assert( (combinedFlags & EP_Reduced)==0 );
4944f49ff6ffSdrh     if( pA->op!=TK_STRING && pA->op!=TK_TRUEFALSE ){
4945619a1305Sdrh       if( pA->iColumn!=pB->iColumn ) return 2;
494666518ca7Sdrh       if( pA->iTable!=pB->iTable
494785f8aa79Sdrh        && (pA->iTable!=iTab || NEVER(pB->iTable>=0)) ) return 2;
49481d9da70aSdrh     }
49491d9da70aSdrh   }
49502646da7eSdrh   return 0;
49512646da7eSdrh }
49522282792aSdrh 
49538c6f666bSdrh /*
49548c6f666bSdrh ** Compare two ExprList objects.  Return 0 if they are identical and
49558c6f666bSdrh ** non-zero if they differ in any way.
49568c6f666bSdrh **
4957619a1305Sdrh ** If any subelement of pB has Expr.iTable==(-1) then it is allowed
4958619a1305Sdrh ** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
4959619a1305Sdrh **
49608c6f666bSdrh ** This routine might return non-zero for equivalent ExprLists.  The
49618c6f666bSdrh ** only consequence will be disabled optimizations.  But this routine
49628c6f666bSdrh ** must never return 0 if the two ExprList objects are different, or
49638c6f666bSdrh ** a malfunction will result.
49648c6f666bSdrh **
49658c6f666bSdrh ** Two NULL pointers are considered to be the same.  But a NULL pointer
49668c6f666bSdrh ** always differs from a non-NULL pointer.
49678c6f666bSdrh */
4968619a1305Sdrh int sqlite3ExprListCompare(ExprList *pA, ExprList *pB, int iTab){
49698c6f666bSdrh   int i;
49708c6f666bSdrh   if( pA==0 && pB==0 ) return 0;
49718c6f666bSdrh   if( pA==0 || pB==0 ) return 1;
49728c6f666bSdrh   if( pA->nExpr!=pB->nExpr ) return 1;
49738c6f666bSdrh   for(i=0; i<pA->nExpr; i++){
49748c6f666bSdrh     Expr *pExprA = pA->a[i].pExpr;
49758c6f666bSdrh     Expr *pExprB = pB->a[i].pExpr;
49768c6f666bSdrh     if( pA->a[i].sortOrder!=pB->a[i].sortOrder ) return 1;
49775aa550cfSdan     if( sqlite3ExprCompare(0, pExprA, pExprB, iTab) ) return 1;
49788c6f666bSdrh   }
49798c6f666bSdrh   return 0;
49808c6f666bSdrh }
498113449892Sdrh 
49822282792aSdrh /*
4983f9463dfbSdrh ** Like sqlite3ExprCompare() except COLLATE operators at the top-level
4984f9463dfbSdrh ** are ignored.
4985f9463dfbSdrh */
4986f9463dfbSdrh int sqlite3ExprCompareSkip(Expr *pA, Expr *pB, int iTab){
49875aa550cfSdan   return sqlite3ExprCompare(0,
4988f9463dfbSdrh              sqlite3ExprSkipCollate(pA),
4989f9463dfbSdrh              sqlite3ExprSkipCollate(pB),
4990f9463dfbSdrh              iTab);
4991f9463dfbSdrh }
4992f9463dfbSdrh 
4993f9463dfbSdrh /*
49944bd5f73fSdrh ** Return true if we can prove the pE2 will always be true if pE1 is
49954bd5f73fSdrh ** true.  Return false if we cannot complete the proof or if pE2 might
49964bd5f73fSdrh ** be false.  Examples:
49974bd5f73fSdrh **
4998619a1305Sdrh **     pE1: x==5       pE2: x==5             Result: true
49994bd5f73fSdrh **     pE1: x>0        pE2: x==5             Result: false
5000619a1305Sdrh **     pE1: x=21       pE2: x=21 OR y=43     Result: true
50014bd5f73fSdrh **     pE1: x!=123     pE2: x IS NOT NULL    Result: true
5002619a1305Sdrh **     pE1: x!=?1      pE2: x IS NOT NULL    Result: true
5003619a1305Sdrh **     pE1: x IS NULL  pE2: x IS NOT NULL    Result: false
5004619a1305Sdrh **     pE1: x IS ?2    pE2: x IS NOT NULL    Reuslt: false
50054bd5f73fSdrh **
50064bd5f73fSdrh ** When comparing TK_COLUMN nodes between pE1 and pE2, if pE2 has
50074bd5f73fSdrh ** Expr.iTable<0 then assume a table number given by iTab.
50084bd5f73fSdrh **
5009c0804226Sdrh ** If pParse is not NULL, then the values of bound variables in pE1 are
5010c0804226Sdrh ** compared against literal values in pE2 and pParse->pVdbe->expmask is
5011c0804226Sdrh ** modified to record which bound variables are referenced.  If pParse
5012c0804226Sdrh ** is NULL, then false will be returned if pE1 contains any bound variables.
5013c0804226Sdrh **
50144bd5f73fSdrh ** When in doubt, return false.  Returning true might give a performance
50154bd5f73fSdrh ** improvement.  Returning false might cause a performance reduction, but
50164bd5f73fSdrh ** it will always give the correct answer and is hence always safe.
50174bd5f73fSdrh */
50185aa550cfSdan int sqlite3ExprImpliesExpr(Parse *pParse, Expr *pE1, Expr *pE2, int iTab){
50195aa550cfSdan   if( sqlite3ExprCompare(pParse, pE1, pE2, iTab)==0 ){
5020619a1305Sdrh     return 1;
5021619a1305Sdrh   }
5022619a1305Sdrh   if( pE2->op==TK_OR
50235aa550cfSdan    && (sqlite3ExprImpliesExpr(pParse, pE1, pE2->pLeft, iTab)
50245aa550cfSdan              || sqlite3ExprImpliesExpr(pParse, pE1, pE2->pRight, iTab) )
5025619a1305Sdrh   ){
5026619a1305Sdrh     return 1;
5027619a1305Sdrh   }
50281ad93a00Sdrh   if( pE2->op==TK_NOTNULL && pE1->op!=TK_ISNULL && pE1->op!=TK_IS ){
50291ad93a00Sdrh     Expr *pX = sqlite3ExprSkipCollate(pE1->pLeft);
50301ad93a00Sdrh     testcase( pX!=pE1->pLeft );
50315aa550cfSdan     if( sqlite3ExprCompare(pParse, pX, pE2->pLeft, iTab)==0 ) return 1;
5032619a1305Sdrh   }
5033619a1305Sdrh   return 0;
50344bd5f73fSdrh }
50354bd5f73fSdrh 
50364bd5f73fSdrh /*
50372589787cSdrh ** This is the Expr node callback for sqlite3ExprImpliesNotNullRow().
50382589787cSdrh ** If the expression node requires that the table at pWalker->iCur
50392589787cSdrh ** have a non-NULL column, then set pWalker->eCode to 1 and abort.
50402589787cSdrh */
50412589787cSdrh static int impliesNotNullRow(Walker *pWalker, Expr *pExpr){
5042821b610bSdrh   /* This routine is only called for WHERE clause expressions and so it
5043821b610bSdrh   ** cannot have any TK_AGG_COLUMN entries because those are only found
5044821b610bSdrh   ** in HAVING clauses.  We can get a TK_AGG_FUNCTION in a WHERE clause,
5045821b610bSdrh   ** but that is an illegal construct and the query will be rejected at
5046821b610bSdrh   ** a later stage of processing, so the TK_AGG_FUNCTION case does not
5047821b610bSdrh   ** need to be considered here. */
5048821b610bSdrh   assert( pExpr->op!=TK_AGG_COLUMN );
5049821b610bSdrh   testcase( pExpr->op==TK_AGG_FUNCTION );
5050821b610bSdrh 
50512589787cSdrh   if( ExprHasProperty(pExpr, EP_FromJoin) ) return WRC_Prune;
50522589787cSdrh   switch( pExpr->op ){
50530493222fSdan     case TK_ISNOT:
5054a1054dccSdan     case TK_NOT:
50552589787cSdrh     case TK_ISNULL:
50562589787cSdrh     case TK_IS:
50572589787cSdrh     case TK_OR:
50582c492061Sdrh     case TK_CASE:
5059e3eff266Sdrh     case TK_IN:
50602589787cSdrh     case TK_FUNCTION:
50610493222fSdan       testcase( pExpr->op==TK_ISNOT );
50620493222fSdan       testcase( pExpr->op==TK_NOT );
5063821b610bSdrh       testcase( pExpr->op==TK_ISNULL );
5064821b610bSdrh       testcase( pExpr->op==TK_IS );
5065821b610bSdrh       testcase( pExpr->op==TK_OR );
5066821b610bSdrh       testcase( pExpr->op==TK_CASE );
5067821b610bSdrh       testcase( pExpr->op==TK_IN );
5068821b610bSdrh       testcase( pExpr->op==TK_FUNCTION );
50692589787cSdrh       return WRC_Prune;
50702589787cSdrh     case TK_COLUMN:
50712589787cSdrh       if( pWalker->u.iCur==pExpr->iTable ){
50722589787cSdrh         pWalker->eCode = 1;
50732589787cSdrh         return WRC_Abort;
50742589787cSdrh       }
50752589787cSdrh       return WRC_Prune;
50769881155dSdrh 
50779881155dSdrh     /* Virtual tables are allowed to use constraints like x=NULL.  So
50789881155dSdrh     ** a term of the form x=y does not prove that y is not null if x
50799881155dSdrh     ** is the column of a virtual table */
50809881155dSdrh     case TK_EQ:
50819881155dSdrh     case TK_NE:
50829881155dSdrh     case TK_LT:
50839881155dSdrh     case TK_LE:
50849881155dSdrh     case TK_GT:
50859881155dSdrh     case TK_GE:
50869881155dSdrh       testcase( pExpr->op==TK_EQ );
50879881155dSdrh       testcase( pExpr->op==TK_NE );
50889881155dSdrh       testcase( pExpr->op==TK_LT );
50899881155dSdrh       testcase( pExpr->op==TK_LE );
50909881155dSdrh       testcase( pExpr->op==TK_GT );
50919881155dSdrh       testcase( pExpr->op==TK_GE );
50929881155dSdrh       if( (pExpr->pLeft->op==TK_COLUMN && IsVirtual(pExpr->pLeft->pTab))
50939881155dSdrh        || (pExpr->pRight->op==TK_COLUMN && IsVirtual(pExpr->pRight->pTab))
50949881155dSdrh       ){
50959881155dSdrh        return WRC_Prune;
50969881155dSdrh       }
50972589787cSdrh     default:
50982589787cSdrh       return WRC_Continue;
50992589787cSdrh   }
51002589787cSdrh }
51012589787cSdrh 
51022589787cSdrh /*
51032589787cSdrh ** Return true (non-zero) if expression p can only be true if at least
51042589787cSdrh ** one column of table iTab is non-null.  In other words, return true
51052589787cSdrh ** if expression p will always be NULL or false if every column of iTab
51062589787cSdrh ** is NULL.
51072589787cSdrh **
5108821b610bSdrh ** False negatives are acceptable.  In other words, it is ok to return
5109821b610bSdrh ** zero even if expression p will never be true of every column of iTab
5110821b610bSdrh ** is NULL.  A false negative is merely a missed optimization opportunity.
5111821b610bSdrh **
5112821b610bSdrh ** False positives are not allowed, however.  A false positive may result
5113821b610bSdrh ** in an incorrect answer.
5114821b610bSdrh **
51152589787cSdrh ** Terms of p that are marked with EP_FromJoin (and hence that come from
51162589787cSdrh ** the ON or USING clauses of LEFT JOINS) are excluded from the analysis.
51172589787cSdrh **
51182589787cSdrh ** This routine is used to check if a LEFT JOIN can be converted into
51192589787cSdrh ** an ordinary JOIN.  The p argument is the WHERE clause.  If the WHERE
51202589787cSdrh ** clause requires that some column of the right table of the LEFT JOIN
51212589787cSdrh ** be non-NULL, then the LEFT JOIN can be safely converted into an
51222589787cSdrh ** ordinary join.
51232589787cSdrh */
51242589787cSdrh int sqlite3ExprImpliesNonNullRow(Expr *p, int iTab){
51252589787cSdrh   Walker w;
51262589787cSdrh   w.xExprCallback = impliesNotNullRow;
51272589787cSdrh   w.xSelectCallback = 0;
51282589787cSdrh   w.xSelectCallback2 = 0;
51292589787cSdrh   w.eCode = 0;
51302589787cSdrh   w.u.iCur = iTab;
51312589787cSdrh   sqlite3WalkExpr(&w, p);
51322589787cSdrh   return w.eCode;
51332589787cSdrh }
51342589787cSdrh 
51352589787cSdrh /*
5136030796dfSdrh ** An instance of the following structure is used by the tree walker
51372409f8a1Sdrh ** to determine if an expression can be evaluated by reference to the
51382409f8a1Sdrh ** index only, without having to do a search for the corresponding
51392409f8a1Sdrh ** table entry.  The IdxCover.pIdx field is the index.  IdxCover.iCur
51402409f8a1Sdrh ** is the cursor for the table.
51412409f8a1Sdrh */
51422409f8a1Sdrh struct IdxCover {
51432409f8a1Sdrh   Index *pIdx;     /* The index to be tested for coverage */
51442409f8a1Sdrh   int iCur;        /* Cursor number for the table corresponding to the index */
51452409f8a1Sdrh };
51462409f8a1Sdrh 
51472409f8a1Sdrh /*
51482409f8a1Sdrh ** Check to see if there are references to columns in table
51492409f8a1Sdrh ** pWalker->u.pIdxCover->iCur can be satisfied using the index
51502409f8a1Sdrh ** pWalker->u.pIdxCover->pIdx.
51512409f8a1Sdrh */
51522409f8a1Sdrh static int exprIdxCover(Walker *pWalker, Expr *pExpr){
51532409f8a1Sdrh   if( pExpr->op==TK_COLUMN
51542409f8a1Sdrh    && pExpr->iTable==pWalker->u.pIdxCover->iCur
51552409f8a1Sdrh    && sqlite3ColumnOfIndex(pWalker->u.pIdxCover->pIdx, pExpr->iColumn)<0
51562409f8a1Sdrh   ){
51572409f8a1Sdrh     pWalker->eCode = 1;
51582409f8a1Sdrh     return WRC_Abort;
51592409f8a1Sdrh   }
51602409f8a1Sdrh   return WRC_Continue;
51612409f8a1Sdrh }
51622409f8a1Sdrh 
51632409f8a1Sdrh /*
5164e604ec0bSdrh ** Determine if an index pIdx on table with cursor iCur contains will
5165e604ec0bSdrh ** the expression pExpr.  Return true if the index does cover the
5166e604ec0bSdrh ** expression and false if the pExpr expression references table columns
5167e604ec0bSdrh ** that are not found in the index pIdx.
51682409f8a1Sdrh **
51692409f8a1Sdrh ** An index covering an expression means that the expression can be
51702409f8a1Sdrh ** evaluated using only the index and without having to lookup the
51712409f8a1Sdrh ** corresponding table entry.
51722409f8a1Sdrh */
51732409f8a1Sdrh int sqlite3ExprCoveredByIndex(
51742409f8a1Sdrh   Expr *pExpr,        /* The index to be tested */
51752409f8a1Sdrh   int iCur,           /* The cursor number for the corresponding table */
51762409f8a1Sdrh   Index *pIdx         /* The index that might be used for coverage */
51772409f8a1Sdrh ){
51782409f8a1Sdrh   Walker w;
51792409f8a1Sdrh   struct IdxCover xcov;
51802409f8a1Sdrh   memset(&w, 0, sizeof(w));
51812409f8a1Sdrh   xcov.iCur = iCur;
51822409f8a1Sdrh   xcov.pIdx = pIdx;
51832409f8a1Sdrh   w.xExprCallback = exprIdxCover;
51842409f8a1Sdrh   w.u.pIdxCover = &xcov;
51852409f8a1Sdrh   sqlite3WalkExpr(&w, pExpr);
51862409f8a1Sdrh   return !w.eCode;
51872409f8a1Sdrh }
51882409f8a1Sdrh 
51892409f8a1Sdrh 
51902409f8a1Sdrh /*
51912409f8a1Sdrh ** An instance of the following structure is used by the tree walker
5192030796dfSdrh ** to count references to table columns in the arguments of an
5193ed551b95Sdrh ** aggregate function, in order to implement the
5194ed551b95Sdrh ** sqlite3FunctionThisSrc() routine.
5195374fdce4Sdrh */
5196030796dfSdrh struct SrcCount {
5197030796dfSdrh   SrcList *pSrc;   /* One particular FROM clause in a nested query */
5198030796dfSdrh   int nThis;       /* Number of references to columns in pSrcList */
5199030796dfSdrh   int nOther;      /* Number of references to columns in other FROM clauses */
5200030796dfSdrh };
5201030796dfSdrh 
5202030796dfSdrh /*
5203030796dfSdrh ** Count the number of references to columns.
5204030796dfSdrh */
5205030796dfSdrh static int exprSrcCount(Walker *pWalker, Expr *pExpr){
5206fb0a6081Sdrh   /* The NEVER() on the second term is because sqlite3FunctionUsesThisSrc()
5207fb0a6081Sdrh   ** is always called before sqlite3ExprAnalyzeAggregates() and so the
5208fb0a6081Sdrh   ** TK_COLUMNs have not yet been converted into TK_AGG_COLUMN.  If
5209fb0a6081Sdrh   ** sqlite3FunctionUsesThisSrc() is used differently in the future, the
5210fb0a6081Sdrh   ** NEVER() will need to be removed. */
5211fb0a6081Sdrh   if( pExpr->op==TK_COLUMN || NEVER(pExpr->op==TK_AGG_COLUMN) ){
5212374fdce4Sdrh     int i;
5213030796dfSdrh     struct SrcCount *p = pWalker->u.pSrcCount;
5214030796dfSdrh     SrcList *pSrc = p->pSrc;
5215655814d2Sdrh     int nSrc = pSrc ? pSrc->nSrc : 0;
5216655814d2Sdrh     for(i=0; i<nSrc; i++){
5217030796dfSdrh       if( pExpr->iTable==pSrc->a[i].iCursor ) break;
5218374fdce4Sdrh     }
5219655814d2Sdrh     if( i<nSrc ){
5220030796dfSdrh       p->nThis++;
5221374fdce4Sdrh     }else{
5222030796dfSdrh       p->nOther++;
5223374fdce4Sdrh     }
5224374fdce4Sdrh   }
5225030796dfSdrh   return WRC_Continue;
5226030796dfSdrh }
5227374fdce4Sdrh 
5228374fdce4Sdrh /*
5229030796dfSdrh ** Determine if any of the arguments to the pExpr Function reference
5230030796dfSdrh ** pSrcList.  Return true if they do.  Also return true if the function
5231030796dfSdrh ** has no arguments or has only constant arguments.  Return false if pExpr
5232030796dfSdrh ** references columns but not columns of tables found in pSrcList.
5233374fdce4Sdrh */
5234030796dfSdrh int sqlite3FunctionUsesThisSrc(Expr *pExpr, SrcList *pSrcList){
5235374fdce4Sdrh   Walker w;
5236030796dfSdrh   struct SrcCount cnt;
5237374fdce4Sdrh   assert( pExpr->op==TK_AGG_FUNCTION );
5238030796dfSdrh   w.xExprCallback = exprSrcCount;
5239979dd1beSdrh   w.xSelectCallback = 0;
5240030796dfSdrh   w.u.pSrcCount = &cnt;
5241030796dfSdrh   cnt.pSrc = pSrcList;
5242030796dfSdrh   cnt.nThis = 0;
5243030796dfSdrh   cnt.nOther = 0;
5244030796dfSdrh   sqlite3WalkExprList(&w, pExpr->x.pList);
5245030796dfSdrh   return cnt.nThis>0 || cnt.nOther==0;
5246374fdce4Sdrh }
5247374fdce4Sdrh 
5248374fdce4Sdrh /*
524913449892Sdrh ** Add a new element to the pAggInfo->aCol[] array.  Return the index of
525013449892Sdrh ** the new element.  Return a negative number if malloc fails.
52512282792aSdrh */
525217435752Sdrh static int addAggInfoColumn(sqlite3 *db, AggInfo *pInfo){
525313449892Sdrh   int i;
5254cf643729Sdrh   pInfo->aCol = sqlite3ArrayAllocate(
525517435752Sdrh        db,
5256cf643729Sdrh        pInfo->aCol,
5257cf643729Sdrh        sizeof(pInfo->aCol[0]),
5258cf643729Sdrh        &pInfo->nColumn,
5259cf643729Sdrh        &i
5260cf643729Sdrh   );
526113449892Sdrh   return i;
52622282792aSdrh }
526313449892Sdrh 
526413449892Sdrh /*
526513449892Sdrh ** Add a new element to the pAggInfo->aFunc[] array.  Return the index of
526613449892Sdrh ** the new element.  Return a negative number if malloc fails.
526713449892Sdrh */
526817435752Sdrh static int addAggInfoFunc(sqlite3 *db, AggInfo *pInfo){
526913449892Sdrh   int i;
5270cf643729Sdrh   pInfo->aFunc = sqlite3ArrayAllocate(
527117435752Sdrh        db,
5272cf643729Sdrh        pInfo->aFunc,
5273cf643729Sdrh        sizeof(pInfo->aFunc[0]),
5274cf643729Sdrh        &pInfo->nFunc,
5275cf643729Sdrh        &i
5276cf643729Sdrh   );
527713449892Sdrh   return i;
52782282792aSdrh }
52792282792aSdrh 
52802282792aSdrh /*
52817d10d5a6Sdrh ** This is the xExprCallback for a tree walker.  It is used to
52827d10d5a6Sdrh ** implement sqlite3ExprAnalyzeAggregates().  See sqlite3ExprAnalyzeAggregates
5283626a879aSdrh ** for additional information.
52842282792aSdrh */
52857d10d5a6Sdrh static int analyzeAggregate(Walker *pWalker, Expr *pExpr){
52862282792aSdrh   int i;
52877d10d5a6Sdrh   NameContext *pNC = pWalker->u.pNC;
5288a58fdfb1Sdanielk1977   Parse *pParse = pNC->pParse;
5289a58fdfb1Sdanielk1977   SrcList *pSrcList = pNC->pSrcList;
529025c3b8caSdrh   AggInfo *pAggInfo = pNC->uNC.pAggInfo;
529113449892Sdrh 
529225c3b8caSdrh   assert( pNC->ncFlags & NC_UAggInfo );
52932282792aSdrh   switch( pExpr->op ){
529489c69d00Sdrh     case TK_AGG_COLUMN:
5295967e8b73Sdrh     case TK_COLUMN: {
52968b213899Sdrh       testcase( pExpr->op==TK_AGG_COLUMN );
52978b213899Sdrh       testcase( pExpr->op==TK_COLUMN );
529813449892Sdrh       /* Check to see if the column is in one of the tables in the FROM
529913449892Sdrh       ** clause of the aggregate query */
530020bc393cSdrh       if( ALWAYS(pSrcList!=0) ){
530113449892Sdrh         struct SrcList_item *pItem = pSrcList->a;
530213449892Sdrh         for(i=0; i<pSrcList->nSrc; i++, pItem++){
530313449892Sdrh           struct AggInfo_col *pCol;
5304c5cd1249Sdrh           assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
530513449892Sdrh           if( pExpr->iTable==pItem->iCursor ){
530613449892Sdrh             /* If we reach this point, it means that pExpr refers to a table
530713449892Sdrh             ** that is in the FROM clause of the aggregate query.
530813449892Sdrh             **
530913449892Sdrh             ** Make an entry for the column in pAggInfo->aCol[] if there
531013449892Sdrh             ** is not an entry there already.
531113449892Sdrh             */
53127f906d63Sdrh             int k;
531313449892Sdrh             pCol = pAggInfo->aCol;
53147f906d63Sdrh             for(k=0; k<pAggInfo->nColumn; k++, pCol++){
531513449892Sdrh               if( pCol->iTable==pExpr->iTable &&
531613449892Sdrh                   pCol->iColumn==pExpr->iColumn ){
53172282792aSdrh                 break;
53182282792aSdrh               }
53192282792aSdrh             }
53201e536953Sdanielk1977             if( (k>=pAggInfo->nColumn)
53211e536953Sdanielk1977              && (k = addAggInfoColumn(pParse->db, pAggInfo))>=0
53221e536953Sdanielk1977             ){
53237f906d63Sdrh               pCol = &pAggInfo->aCol[k];
53240817d0dfSdanielk1977               pCol->pTab = pExpr->pTab;
532513449892Sdrh               pCol->iTable = pExpr->iTable;
532613449892Sdrh               pCol->iColumn = pExpr->iColumn;
53270a07c107Sdrh               pCol->iMem = ++pParse->nMem;
532813449892Sdrh               pCol->iSorterColumn = -1;
53295774b806Sdrh               pCol->pExpr = pExpr;
533013449892Sdrh               if( pAggInfo->pGroupBy ){
533113449892Sdrh                 int j, n;
533213449892Sdrh                 ExprList *pGB = pAggInfo->pGroupBy;
533313449892Sdrh                 struct ExprList_item *pTerm = pGB->a;
533413449892Sdrh                 n = pGB->nExpr;
533513449892Sdrh                 for(j=0; j<n; j++, pTerm++){
533613449892Sdrh                   Expr *pE = pTerm->pExpr;
533713449892Sdrh                   if( pE->op==TK_COLUMN && pE->iTable==pExpr->iTable &&
533813449892Sdrh                       pE->iColumn==pExpr->iColumn ){
533913449892Sdrh                     pCol->iSorterColumn = j;
534013449892Sdrh                     break;
53412282792aSdrh                   }
534213449892Sdrh                 }
534313449892Sdrh               }
534413449892Sdrh               if( pCol->iSorterColumn<0 ){
534513449892Sdrh                 pCol->iSorterColumn = pAggInfo->nSortingColumn++;
534613449892Sdrh               }
534713449892Sdrh             }
534813449892Sdrh             /* There is now an entry for pExpr in pAggInfo->aCol[] (either
534913449892Sdrh             ** because it was there before or because we just created it).
535013449892Sdrh             ** Convert the pExpr to be a TK_AGG_COLUMN referring to that
535113449892Sdrh             ** pAggInfo->aCol[] entry.
535213449892Sdrh             */
5353ebb6a65dSdrh             ExprSetVVAProperty(pExpr, EP_NoReduce);
535413449892Sdrh             pExpr->pAggInfo = pAggInfo;
535513449892Sdrh             pExpr->op = TK_AGG_COLUMN;
5356cf697396Sshane             pExpr->iAgg = (i16)k;
535713449892Sdrh             break;
535813449892Sdrh           } /* endif pExpr->iTable==pItem->iCursor */
535913449892Sdrh         } /* end loop over pSrcList */
5360a58fdfb1Sdanielk1977       }
53617d10d5a6Sdrh       return WRC_Prune;
53622282792aSdrh     }
53632282792aSdrh     case TK_AGG_FUNCTION: {
53643a8c4be7Sdrh       if( (pNC->ncFlags & NC_InAggFunc)==0
5365ed551b95Sdrh        && pWalker->walkerDepth==pExpr->op2
53663a8c4be7Sdrh       ){
536713449892Sdrh         /* Check to see if pExpr is a duplicate of another aggregate
536813449892Sdrh         ** function that is already in the pAggInfo structure
536913449892Sdrh         */
537013449892Sdrh         struct AggInfo_func *pItem = pAggInfo->aFunc;
537113449892Sdrh         for(i=0; i<pAggInfo->nFunc; i++, pItem++){
53725aa550cfSdan           if( sqlite3ExprCompare(0, pItem->pExpr, pExpr, -1)==0 ){
53732282792aSdrh             break;
53742282792aSdrh           }
53752282792aSdrh         }
537613449892Sdrh         if( i>=pAggInfo->nFunc ){
537713449892Sdrh           /* pExpr is original.  Make a new entry in pAggInfo->aFunc[]
537813449892Sdrh           */
537914db2665Sdanielk1977           u8 enc = ENC(pParse->db);
53801e536953Sdanielk1977           i = addAggInfoFunc(pParse->db, pAggInfo);
538113449892Sdrh           if( i>=0 ){
53826ab3a2ecSdanielk1977             assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
538313449892Sdrh             pItem = &pAggInfo->aFunc[i];
538413449892Sdrh             pItem->pExpr = pExpr;
53850a07c107Sdrh             pItem->iMem = ++pParse->nMem;
538633e619fcSdrh             assert( !ExprHasProperty(pExpr, EP_IntValue) );
538713449892Sdrh             pItem->pFunc = sqlite3FindFunction(pParse->db,
538880738d9cSdrh                    pExpr->u.zToken,
53896ab3a2ecSdanielk1977                    pExpr->x.pList ? pExpr->x.pList->nExpr : 0, enc, 0);
5390fd357974Sdrh             if( pExpr->flags & EP_Distinct ){
5391fd357974Sdrh               pItem->iDistinct = pParse->nTab++;
5392fd357974Sdrh             }else{
5393fd357974Sdrh               pItem->iDistinct = -1;
5394fd357974Sdrh             }
53952282792aSdrh           }
539613449892Sdrh         }
539713449892Sdrh         /* Make pExpr point to the appropriate pAggInfo->aFunc[] entry
539813449892Sdrh         */
5399c5cd1249Sdrh         assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
5400ebb6a65dSdrh         ExprSetVVAProperty(pExpr, EP_NoReduce);
5401cf697396Sshane         pExpr->iAgg = (i16)i;
540213449892Sdrh         pExpr->pAggInfo = pAggInfo;
54033a8c4be7Sdrh         return WRC_Prune;
54046e83a57fSdrh       }else{
54056e83a57fSdrh         return WRC_Continue;
54066e83a57fSdrh       }
54072282792aSdrh     }
5408a58fdfb1Sdanielk1977   }
54097d10d5a6Sdrh   return WRC_Continue;
54107d10d5a6Sdrh }
54117d10d5a6Sdrh static int analyzeAggregatesInSelect(Walker *pWalker, Select *pSelect){
5412d5a336efSdrh   UNUSED_PARAMETER(pSelect);
5413979dd1beSdrh   pWalker->walkerDepth++;
54147d10d5a6Sdrh   return WRC_Continue;
5415a58fdfb1Sdanielk1977 }
5416979dd1beSdrh static void analyzeAggregatesInSelectEnd(Walker *pWalker, Select *pSelect){
5417979dd1beSdrh   UNUSED_PARAMETER(pSelect);
5418979dd1beSdrh   pWalker->walkerDepth--;
5419979dd1beSdrh }
5420626a879aSdrh 
5421626a879aSdrh /*
5422e8abb4caSdrh ** Analyze the pExpr expression looking for aggregate functions and
5423e8abb4caSdrh ** for variables that need to be added to AggInfo object that pNC->pAggInfo
5424e8abb4caSdrh ** points to.  Additional entries are made on the AggInfo object as
5425e8abb4caSdrh ** necessary.
5426626a879aSdrh **
5427626a879aSdrh ** This routine should only be called after the expression has been
54287d10d5a6Sdrh ** analyzed by sqlite3ResolveExprNames().
5429626a879aSdrh */
5430d2b3e23bSdrh void sqlite3ExprAnalyzeAggregates(NameContext *pNC, Expr *pExpr){
54317d10d5a6Sdrh   Walker w;
54327d10d5a6Sdrh   w.xExprCallback = analyzeAggregate;
54337d10d5a6Sdrh   w.xSelectCallback = analyzeAggregatesInSelect;
5434979dd1beSdrh   w.xSelectCallback2 = analyzeAggregatesInSelectEnd;
5435979dd1beSdrh   w.walkerDepth = 0;
54367d10d5a6Sdrh   w.u.pNC = pNC;
543720bc393cSdrh   assert( pNC->pSrcList!=0 );
54387d10d5a6Sdrh   sqlite3WalkExpr(&w, pExpr);
54392282792aSdrh }
54405d9a4af9Sdrh 
54415d9a4af9Sdrh /*
54425d9a4af9Sdrh ** Call sqlite3ExprAnalyzeAggregates() for every expression in an
54435d9a4af9Sdrh ** expression list.  Return the number of errors.
54445d9a4af9Sdrh **
54455d9a4af9Sdrh ** If an error is found, the analysis is cut short.
54465d9a4af9Sdrh */
5447d2b3e23bSdrh void sqlite3ExprAnalyzeAggList(NameContext *pNC, ExprList *pList){
54485d9a4af9Sdrh   struct ExprList_item *pItem;
54495d9a4af9Sdrh   int i;
54505d9a4af9Sdrh   if( pList ){
5451d2b3e23bSdrh     for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
5452d2b3e23bSdrh       sqlite3ExprAnalyzeAggregates(pNC, pItem->pExpr);
54535d9a4af9Sdrh     }
54545d9a4af9Sdrh   }
54555d9a4af9Sdrh }
5456892d3179Sdrh 
5457892d3179Sdrh /*
5458ceea3321Sdrh ** Allocate a single new register for use to hold some intermediate result.
5459892d3179Sdrh */
5460892d3179Sdrh int sqlite3GetTempReg(Parse *pParse){
5461e55cbd72Sdrh   if( pParse->nTempReg==0 ){
5462892d3179Sdrh     return ++pParse->nMem;
5463892d3179Sdrh   }
54642f425f6bSdanielk1977   return pParse->aTempReg[--pParse->nTempReg];
5465892d3179Sdrh }
5466ceea3321Sdrh 
5467ceea3321Sdrh /*
5468ceea3321Sdrh ** Deallocate a register, making available for reuse for some other
5469ceea3321Sdrh ** purpose.
5470ceea3321Sdrh **
5471ceea3321Sdrh ** If a register is currently being used by the column cache, then
547260ec914cSpeter.d.reid ** the deallocation is deferred until the column cache line that uses
5473ceea3321Sdrh ** the register becomes stale.
5474ceea3321Sdrh */
5475892d3179Sdrh void sqlite3ReleaseTempReg(Parse *pParse, int iReg){
54762dcef11bSdrh   if( iReg && pParse->nTempReg<ArraySize(pParse->aTempReg) ){
5477ceea3321Sdrh     int i;
5478ceea3321Sdrh     struct yColCache *p;
54799b40d13fSdrh     for(i=0, p=pParse->aColCache; i<pParse->nColCache; i++, p++){
5480ceea3321Sdrh       if( p->iReg==iReg ){
5481ceea3321Sdrh         p->tempReg = 1;
5482ceea3321Sdrh         return;
5483ceea3321Sdrh       }
5484ceea3321Sdrh     }
5485892d3179Sdrh     pParse->aTempReg[pParse->nTempReg++] = iReg;
5486892d3179Sdrh   }
5487892d3179Sdrh }
5488892d3179Sdrh 
5489892d3179Sdrh /*
5490ed24da4bSdrh ** Allocate or deallocate a block of nReg consecutive registers.
5491892d3179Sdrh */
5492892d3179Sdrh int sqlite3GetTempRange(Parse *pParse, int nReg){
5493e55cbd72Sdrh   int i, n;
5494ed24da4bSdrh   if( nReg==1 ) return sqlite3GetTempReg(pParse);
5495892d3179Sdrh   i = pParse->iRangeReg;
5496e55cbd72Sdrh   n = pParse->nRangeReg;
5497f49f3523Sdrh   if( nReg<=n ){
5498f49f3523Sdrh     assert( !usedAsColumnCache(pParse, i, i+n-1) );
5499892d3179Sdrh     pParse->iRangeReg += nReg;
5500892d3179Sdrh     pParse->nRangeReg -= nReg;
5501892d3179Sdrh   }else{
5502892d3179Sdrh     i = pParse->nMem+1;
5503892d3179Sdrh     pParse->nMem += nReg;
5504892d3179Sdrh   }
5505892d3179Sdrh   return i;
5506892d3179Sdrh }
5507892d3179Sdrh void sqlite3ReleaseTempRange(Parse *pParse, int iReg, int nReg){
5508ed24da4bSdrh   if( nReg==1 ){
5509ed24da4bSdrh     sqlite3ReleaseTempReg(pParse, iReg);
5510ed24da4bSdrh     return;
5511ed24da4bSdrh   }
5512f49f3523Sdrh   sqlite3ExprCacheRemove(pParse, iReg, nReg);
5513892d3179Sdrh   if( nReg>pParse->nRangeReg ){
5514892d3179Sdrh     pParse->nRangeReg = nReg;
5515892d3179Sdrh     pParse->iRangeReg = iReg;
5516892d3179Sdrh   }
5517892d3179Sdrh }
5518cdc69557Sdrh 
5519cdc69557Sdrh /*
5520cdc69557Sdrh ** Mark all temporary registers as being unavailable for reuse.
5521cdc69557Sdrh */
5522cdc69557Sdrh void sqlite3ClearTempRegCache(Parse *pParse){
5523cdc69557Sdrh   pParse->nTempReg = 0;
5524cdc69557Sdrh   pParse->nRangeReg = 0;
5525cdc69557Sdrh }
5526bb9b5f26Sdrh 
5527bb9b5f26Sdrh /*
5528bb9b5f26Sdrh ** Validate that no temporary register falls within the range of
5529bb9b5f26Sdrh ** iFirst..iLast, inclusive.  This routine is only call from within assert()
5530bb9b5f26Sdrh ** statements.
5531bb9b5f26Sdrh */
5532bb9b5f26Sdrh #ifdef SQLITE_DEBUG
5533bb9b5f26Sdrh int sqlite3NoTempsInRange(Parse *pParse, int iFirst, int iLast){
5534bb9b5f26Sdrh   int i;
5535bb9b5f26Sdrh   if( pParse->nRangeReg>0
55363963e584Sdrh    && pParse->iRangeReg+pParse->nRangeReg > iFirst
55373963e584Sdrh    && pParse->iRangeReg <= iLast
5538bb9b5f26Sdrh   ){
5539bb9b5f26Sdrh      return 0;
5540bb9b5f26Sdrh   }
5541bb9b5f26Sdrh   for(i=0; i<pParse->nTempReg; i++){
5542bb9b5f26Sdrh     if( pParse->aTempReg[i]>=iFirst && pParse->aTempReg[i]<=iLast ){
5543bb9b5f26Sdrh       return 0;
5544bb9b5f26Sdrh     }
5545bb9b5f26Sdrh   }
5546bb9b5f26Sdrh   return 1;
5547bb9b5f26Sdrh }
5548bb9b5f26Sdrh #endif /* SQLITE_DEBUG */
5549