xref: /sqlite-3.40.0/src/expr.c (revision 2a11bb23)
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;
7752e362f97Sdan     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;
8652e362f97Sdan       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 
11856ab3a2ecSdanielk1977 /*
11866ab3a2ecSdanielk1977 ** This function is similar to sqlite3ExprDup(), except that if pzBuffer
11876ab3a2ecSdanielk1977 ** is not NULL then *pzBuffer is assumed to point to a buffer large enough
118833e619fcSdrh ** to store the copy of expression p, the copies of p->u.zToken
11896ab3a2ecSdanielk1977 ** (if applicable), and the copies of the p->pLeft and p->pRight expressions,
119060ec914cSpeter.d.reid ** if any. Before returning, *pzBuffer is set to the first byte past the
11916ab3a2ecSdanielk1977 ** portion of the buffer copied into by this function.
11926ab3a2ecSdanielk1977 */
11933c19469cSdrh static Expr *exprDup(sqlite3 *db, Expr *p, int dupFlags, u8 **pzBuffer){
11943c19469cSdrh   Expr *pNew;           /* Value to return */
11953c19469cSdrh   u8 *zAlloc;           /* Memory space from which to build Expr object */
11963c19469cSdrh   u32 staticFlag;       /* EP_Static if space not obtained from malloc */
11976ab3a2ecSdanielk1977 
11983c19469cSdrh   assert( db!=0 );
11993c19469cSdrh   assert( p );
12003c19469cSdrh   assert( dupFlags==0 || dupFlags==EXPRDUP_REDUCE );
12013c19469cSdrh   assert( pzBuffer==0 || dupFlags==EXPRDUP_REDUCE );
12026ab3a2ecSdanielk1977 
12036ab3a2ecSdanielk1977   /* Figure out where to write the new Expr structure. */
12046ab3a2ecSdanielk1977   if( pzBuffer ){
12056ab3a2ecSdanielk1977     zAlloc = *pzBuffer;
120633e619fcSdrh     staticFlag = EP_Static;
12076ab3a2ecSdanielk1977   }else{
12083c19469cSdrh     zAlloc = sqlite3DbMallocRawNN(db, dupedExprSize(p, dupFlags));
12093c19469cSdrh     staticFlag = 0;
12106ab3a2ecSdanielk1977   }
12116ab3a2ecSdanielk1977   pNew = (Expr *)zAlloc;
12126ab3a2ecSdanielk1977 
12136ab3a2ecSdanielk1977   if( pNew ){
12146ab3a2ecSdanielk1977     /* Set nNewSize to the size allocated for the structure pointed to
12156ab3a2ecSdanielk1977     ** by pNew. This is either EXPR_FULLSIZE, EXPR_REDUCEDSIZE or
12166ab3a2ecSdanielk1977     ** EXPR_TOKENONLYSIZE. nToken is set to the number of bytes consumed
121733e619fcSdrh     ** by the copy of the p->u.zToken string (if any).
12186ab3a2ecSdanielk1977     */
12193c19469cSdrh     const unsigned nStructSize = dupedExprStructSize(p, dupFlags);
122033e619fcSdrh     const int nNewSize = nStructSize & 0xfff;
122133e619fcSdrh     int nToken;
122233e619fcSdrh     if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
122333e619fcSdrh       nToken = sqlite3Strlen30(p->u.zToken) + 1;
122433e619fcSdrh     }else{
122533e619fcSdrh       nToken = 0;
122633e619fcSdrh     }
12273c19469cSdrh     if( dupFlags ){
12286ab3a2ecSdanielk1977       assert( ExprHasProperty(p, EP_Reduced)==0 );
12296ab3a2ecSdanielk1977       memcpy(zAlloc, p, nNewSize);
12306ab3a2ecSdanielk1977     }else{
12313e6a1411Sdan       u32 nSize = (u32)exprStructSize(p);
12326ab3a2ecSdanielk1977       memcpy(zAlloc, p, nSize);
123372ea29d7Sdrh       if( nSize<EXPR_FULLSIZE ){
12346ab3a2ecSdanielk1977         memset(&zAlloc[nSize], 0, EXPR_FULLSIZE-nSize);
12356ab3a2ecSdanielk1977       }
123672ea29d7Sdrh     }
12376ab3a2ecSdanielk1977 
123833e619fcSdrh     /* Set the EP_Reduced, EP_TokenOnly, and EP_Static flags appropriately. */
1239c5cd1249Sdrh     pNew->flags &= ~(EP_Reduced|EP_TokenOnly|EP_Static|EP_MemToken);
124033e619fcSdrh     pNew->flags |= nStructSize & (EP_Reduced|EP_TokenOnly);
124133e619fcSdrh     pNew->flags |= staticFlag;
12426ab3a2ecSdanielk1977 
124333e619fcSdrh     /* Copy the p->u.zToken string, if any. */
12446ab3a2ecSdanielk1977     if( nToken ){
124533e619fcSdrh       char *zToken = pNew->u.zToken = (char*)&zAlloc[nNewSize];
124633e619fcSdrh       memcpy(zToken, p->u.zToken, nToken);
12476ab3a2ecSdanielk1977     }
12486ab3a2ecSdanielk1977 
1249209bc522Sdrh     if( 0==((p->flags|pNew->flags) & (EP_TokenOnly|EP_Leaf)) ){
12506ab3a2ecSdanielk1977       /* Fill in the pNew->x.pSelect or pNew->x.pList member. */
12516ab3a2ecSdanielk1977       if( ExprHasProperty(p, EP_xIsSelect) ){
12523c19469cSdrh         pNew->x.pSelect = sqlite3SelectDup(db, p->x.pSelect, dupFlags);
12536ab3a2ecSdanielk1977       }else{
12543c19469cSdrh         pNew->x.pList = sqlite3ExprListDup(db, p->x.pList, dupFlags);
12556ab3a2ecSdanielk1977       }
12566ab3a2ecSdanielk1977     }
12576ab3a2ecSdanielk1977 
12586ab3a2ecSdanielk1977     /* Fill in pNew->pLeft and pNew->pRight. */
1259c5cd1249Sdrh     if( ExprHasProperty(pNew, EP_Reduced|EP_TokenOnly) ){
12603c19469cSdrh       zAlloc += dupedExprNodeSize(p, dupFlags);
1261209bc522Sdrh       if( !ExprHasProperty(pNew, EP_TokenOnly|EP_Leaf) ){
12623c19469cSdrh         pNew->pLeft = p->pLeft ?
12633c19469cSdrh                       exprDup(db, p->pLeft, EXPRDUP_REDUCE, &zAlloc) : 0;
12643c19469cSdrh         pNew->pRight = p->pRight ?
12653c19469cSdrh                        exprDup(db, p->pRight, EXPRDUP_REDUCE, &zAlloc) : 0;
12666ab3a2ecSdanielk1977       }
12676ab3a2ecSdanielk1977       if( pzBuffer ){
12686ab3a2ecSdanielk1977         *pzBuffer = zAlloc;
12696ab3a2ecSdanielk1977       }
1270b7916a78Sdrh     }else{
1271e2f781b9Sdan       if( ExprHasProperty(p, EP_Reduced|EP_TokenOnly) ){
1272e2f781b9Sdan         pNew->pWin = 0;
1273e2f781b9Sdan       }else{
1274*2a11bb23Sdan         pNew->pWin = sqlite3WindowDup(db, pNew, p->pWin);
1275e2f781b9Sdan       }
1276209bc522Sdrh       if( !ExprHasProperty(p, EP_TokenOnly|EP_Leaf) ){
12779854260bSdrh         if( pNew->op==TK_SELECT_COLUMN ){
12789854260bSdrh           pNew->pLeft = p->pLeft;
127947073f62Sdrh           assert( p->iColumn==0 || p->pRight==0 );
128047073f62Sdrh           assert( p->pRight==0  || p->pRight==p->pLeft );
12819854260bSdrh         }else{
12826ab3a2ecSdanielk1977           pNew->pLeft = sqlite3ExprDup(db, p->pLeft, 0);
12839854260bSdrh         }
12846ab3a2ecSdanielk1977         pNew->pRight = sqlite3ExprDup(db, p->pRight, 0);
12856ab3a2ecSdanielk1977       }
12866ab3a2ecSdanielk1977     }
12876ab3a2ecSdanielk1977   }
12886ab3a2ecSdanielk1977   return pNew;
12896ab3a2ecSdanielk1977 }
12906ab3a2ecSdanielk1977 
12916ab3a2ecSdanielk1977 /*
1292bfe31e7fSdan ** Create and return a deep copy of the object passed as the second
1293bfe31e7fSdan ** argument. If an OOM condition is encountered, NULL is returned
1294bfe31e7fSdan ** and the db->mallocFailed flag set.
1295bfe31e7fSdan */
1296eede6a53Sdan #ifndef SQLITE_OMIT_CTE
1297bfe31e7fSdan static With *withDup(sqlite3 *db, With *p){
12984e9119d9Sdan   With *pRet = 0;
12994e9119d9Sdan   if( p ){
13004e9119d9Sdan     int nByte = sizeof(*p) + sizeof(p->a[0]) * (p->nCte-1);
13014e9119d9Sdan     pRet = sqlite3DbMallocZero(db, nByte);
13024e9119d9Sdan     if( pRet ){
13034e9119d9Sdan       int i;
13044e9119d9Sdan       pRet->nCte = p->nCte;
13054e9119d9Sdan       for(i=0; i<p->nCte; i++){
13064e9119d9Sdan         pRet->a[i].pSelect = sqlite3SelectDup(db, p->a[i].pSelect, 0);
13074e9119d9Sdan         pRet->a[i].pCols = sqlite3ExprListDup(db, p->a[i].pCols, 0);
13084e9119d9Sdan         pRet->a[i].zName = sqlite3DbStrDup(db, p->a[i].zName);
13094e9119d9Sdan       }
13104e9119d9Sdan     }
13114e9119d9Sdan   }
13124e9119d9Sdan   return pRet;
13134e9119d9Sdan }
1314eede6a53Sdan #else
1315eede6a53Sdan # define withDup(x,y) 0
1316eede6a53Sdan #endif
13174e9119d9Sdan 
1318a76b5dfcSdrh /*
1319ff78bd2fSdrh ** The following group of routines make deep copies of expressions,
1320ff78bd2fSdrh ** expression lists, ID lists, and select statements.  The copies can
1321ff78bd2fSdrh ** be deleted (by being passed to their respective ...Delete() routines)
1322ff78bd2fSdrh ** without effecting the originals.
1323ff78bd2fSdrh **
13244adee20fSdanielk1977 ** The expression list, ID, and source lists return by sqlite3ExprListDup(),
13254adee20fSdanielk1977 ** sqlite3IdListDup(), and sqlite3SrcListDup() can not be further expanded
1326ad3cab52Sdrh ** by subsequent calls to sqlite*ListAppend() routines.
1327ff78bd2fSdrh **
1328ad3cab52Sdrh ** Any tables that the SrcList might point to are not duplicated.
13296ab3a2ecSdanielk1977 **
1330b7916a78Sdrh ** The flags parameter contains a combination of the EXPRDUP_XXX flags.
13316ab3a2ecSdanielk1977 ** If the EXPRDUP_REDUCE flag is set, then the structure returned is a
13326ab3a2ecSdanielk1977 ** truncated version of the usual Expr structure that will be stored as
13336ab3a2ecSdanielk1977 ** part of the in-memory representation of the database schema.
1334ff78bd2fSdrh */
13356ab3a2ecSdanielk1977 Expr *sqlite3ExprDup(sqlite3 *db, Expr *p, int flags){
133672ea29d7Sdrh   assert( flags==0 || flags==EXPRDUP_REDUCE );
13373c19469cSdrh   return p ? exprDup(db, p, flags, 0) : 0;
1338ff78bd2fSdrh }
13396ab3a2ecSdanielk1977 ExprList *sqlite3ExprListDup(sqlite3 *db, ExprList *p, int flags){
1340ff78bd2fSdrh   ExprList *pNew;
1341145716b3Sdrh   struct ExprList_item *pItem, *pOldItem;
1342ff78bd2fSdrh   int i;
1343b163748eSdrh   Expr *pPriorSelectCol = 0;
1344575fad65Sdrh   assert( db!=0 );
1345ff78bd2fSdrh   if( p==0 ) return 0;
134697258194Sdrh   pNew = sqlite3DbMallocRawNN(db, sqlite3DbMallocSize(db, p));
1347ff78bd2fSdrh   if( pNew==0 ) return 0;
1348a19543feSdrh   pNew->nExpr = p->nExpr;
134943606175Sdrh   pItem = pNew->a;
1350145716b3Sdrh   pOldItem = p->a;
1351145716b3Sdrh   for(i=0; i<p->nExpr; i++, pItem++, pOldItem++){
13526ab3a2ecSdanielk1977     Expr *pOldExpr = pOldItem->pExpr;
135347073f62Sdrh     Expr *pNewExpr;
1354b5526ea6Sdrh     pItem->pExpr = sqlite3ExprDup(db, pOldExpr, flags);
135547073f62Sdrh     if( pOldExpr
135647073f62Sdrh      && pOldExpr->op==TK_SELECT_COLUMN
135747073f62Sdrh      && (pNewExpr = pItem->pExpr)!=0
135847073f62Sdrh     ){
135947073f62Sdrh       assert( pNewExpr->iColumn==0 || i>0 );
136047073f62Sdrh       if( pNewExpr->iColumn==0 ){
136147073f62Sdrh         assert( pOldExpr->pLeft==pOldExpr->pRight );
1362b163748eSdrh         pPriorSelectCol = pNewExpr->pLeft = pNewExpr->pRight;
1363b163748eSdrh       }else{
1364b163748eSdrh         assert( i>0 );
1365b163748eSdrh         assert( pItem[-1].pExpr!=0 );
1366b163748eSdrh         assert( pNewExpr->iColumn==pItem[-1].pExpr->iColumn+1 );
1367b163748eSdrh         assert( pPriorSelectCol==pItem[-1].pExpr->pLeft );
1368b163748eSdrh         pNewExpr->pLeft = pPriorSelectCol;
136947073f62Sdrh       }
137047073f62Sdrh     }
137117435752Sdrh     pItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
1372b7916a78Sdrh     pItem->zSpan = sqlite3DbStrDup(db, pOldItem->zSpan);
1373145716b3Sdrh     pItem->sortOrder = pOldItem->sortOrder;
13743e7bc9caSdrh     pItem->done = 0;
13752c036cffSdrh     pItem->bSpanIsTab = pOldItem->bSpanIsTab;
137624e25d32Sdan     pItem->bSorterRef = pOldItem->bSorterRef;
1377c2acc4e4Sdrh     pItem->u = pOldItem->u;
1378ff78bd2fSdrh   }
1379ff78bd2fSdrh   return pNew;
1380ff78bd2fSdrh }
138193758c8dSdanielk1977 
138293758c8dSdanielk1977 /*
138393758c8dSdanielk1977 ** If cursors, triggers, views and subqueries are all omitted from
138493758c8dSdanielk1977 ** the build, then none of the following routines, except for
138593758c8dSdanielk1977 ** sqlite3SelectDup(), can be called. sqlite3SelectDup() is sometimes
138693758c8dSdanielk1977 ** called with a NULL argument.
138793758c8dSdanielk1977 */
13886a67fe8eSdanielk1977 #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_TRIGGER) \
13896a67fe8eSdanielk1977  || !defined(SQLITE_OMIT_SUBQUERY)
13906ab3a2ecSdanielk1977 SrcList *sqlite3SrcListDup(sqlite3 *db, SrcList *p, int flags){
1391ad3cab52Sdrh   SrcList *pNew;
1392ad3cab52Sdrh   int i;
1393113088ecSdrh   int nByte;
1394575fad65Sdrh   assert( db!=0 );
1395ad3cab52Sdrh   if( p==0 ) return 0;
1396113088ecSdrh   nByte = sizeof(*p) + (p->nSrc>0 ? sizeof(p->a[0]) * (p->nSrc-1) : 0);
1397575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, nByte );
1398ad3cab52Sdrh   if( pNew==0 ) return 0;
13994305d103Sdrh   pNew->nSrc = pNew->nAlloc = p->nSrc;
1400ad3cab52Sdrh   for(i=0; i<p->nSrc; i++){
14014efc4754Sdrh     struct SrcList_item *pNewItem = &pNew->a[i];
14024efc4754Sdrh     struct SrcList_item *pOldItem = &p->a[i];
1403ed8a3bb1Sdrh     Table *pTab;
140441fb5cd1Sdan     pNewItem->pSchema = pOldItem->pSchema;
140517435752Sdrh     pNewItem->zDatabase = sqlite3DbStrDup(db, pOldItem->zDatabase);
140617435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
140717435752Sdrh     pNewItem->zAlias = sqlite3DbStrDup(db, pOldItem->zAlias);
14088a48b9c0Sdrh     pNewItem->fg = pOldItem->fg;
14094efc4754Sdrh     pNewItem->iCursor = pOldItem->iCursor;
14105b6a9ed4Sdrh     pNewItem->addrFillSub = pOldItem->addrFillSub;
14115b6a9ed4Sdrh     pNewItem->regReturn = pOldItem->regReturn;
14128a48b9c0Sdrh     if( pNewItem->fg.isIndexedBy ){
14138a48b9c0Sdrh       pNewItem->u1.zIndexedBy = sqlite3DbStrDup(db, pOldItem->u1.zIndexedBy);
14148a48b9c0Sdrh     }
14158a48b9c0Sdrh     pNewItem->pIBIndex = pOldItem->pIBIndex;
14168a48b9c0Sdrh     if( pNewItem->fg.isTabFunc ){
14178a48b9c0Sdrh       pNewItem->u1.pFuncArg =
14188a48b9c0Sdrh           sqlite3ExprListDup(db, pOldItem->u1.pFuncArg, flags);
14198a48b9c0Sdrh     }
1420ed8a3bb1Sdrh     pTab = pNewItem->pTab = pOldItem->pTab;
1421ed8a3bb1Sdrh     if( pTab ){
142279df7782Sdrh       pTab->nTabRef++;
1423a1cb183dSdanielk1977     }
14246ab3a2ecSdanielk1977     pNewItem->pSelect = sqlite3SelectDup(db, pOldItem->pSelect, flags);
14256ab3a2ecSdanielk1977     pNewItem->pOn = sqlite3ExprDup(db, pOldItem->pOn, flags);
142617435752Sdrh     pNewItem->pUsing = sqlite3IdListDup(db, pOldItem->pUsing);
14276c18b6e0Sdanielk1977     pNewItem->colUsed = pOldItem->colUsed;
1428ad3cab52Sdrh   }
1429ad3cab52Sdrh   return pNew;
1430ad3cab52Sdrh }
143117435752Sdrh IdList *sqlite3IdListDup(sqlite3 *db, IdList *p){
1432ff78bd2fSdrh   IdList *pNew;
1433ff78bd2fSdrh   int i;
1434575fad65Sdrh   assert( db!=0 );
1435ff78bd2fSdrh   if( p==0 ) return 0;
1436575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, sizeof(*pNew) );
1437ff78bd2fSdrh   if( pNew==0 ) return 0;
14386c535158Sdrh   pNew->nId = p->nId;
1439575fad65Sdrh   pNew->a = sqlite3DbMallocRawNN(db, p->nId*sizeof(p->a[0]) );
1440d5d56523Sdanielk1977   if( pNew->a==0 ){
1441dbd6a7dcSdrh     sqlite3DbFreeNN(db, pNew);
1442d5d56523Sdanielk1977     return 0;
1443d5d56523Sdanielk1977   }
14446c535158Sdrh   /* Note that because the size of the allocation for p->a[] is not
14456c535158Sdrh   ** necessarily a power of two, sqlite3IdListAppend() may not be called
14466c535158Sdrh   ** on the duplicate created by this function. */
1447ff78bd2fSdrh   for(i=0; i<p->nId; i++){
14484efc4754Sdrh     struct IdList_item *pNewItem = &pNew->a[i];
14494efc4754Sdrh     struct IdList_item *pOldItem = &p->a[i];
145017435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
14514efc4754Sdrh     pNewItem->idx = pOldItem->idx;
1452ff78bd2fSdrh   }
1453ff78bd2fSdrh   return pNew;
1454ff78bd2fSdrh }
1455a7466205Sdan Select *sqlite3SelectDup(sqlite3 *db, Select *pDup, int flags){
1456a7466205Sdan   Select *pRet = 0;
1457a7466205Sdan   Select *pNext = 0;
1458a7466205Sdan   Select **pp = &pRet;
1459a7466205Sdan   Select *p;
1460a7466205Sdan 
1461575fad65Sdrh   assert( db!=0 );
1462a7466205Sdan   for(p=pDup; p; p=p->pPrior){
1463a7466205Sdan     Select *pNew = sqlite3DbMallocRawNN(db, sizeof(*p) );
1464a7466205Sdan     if( pNew==0 ) break;
1465b7916a78Sdrh     pNew->pEList = sqlite3ExprListDup(db, p->pEList, flags);
14666ab3a2ecSdanielk1977     pNew->pSrc = sqlite3SrcListDup(db, p->pSrc, flags);
14676ab3a2ecSdanielk1977     pNew->pWhere = sqlite3ExprDup(db, p->pWhere, flags);
14686ab3a2ecSdanielk1977     pNew->pGroupBy = sqlite3ExprListDup(db, p->pGroupBy, flags);
14696ab3a2ecSdanielk1977     pNew->pHaving = sqlite3ExprDup(db, p->pHaving, flags);
14706ab3a2ecSdanielk1977     pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, flags);
1471ff78bd2fSdrh     pNew->op = p->op;
1472a7466205Sdan     pNew->pNext = pNext;
1473a7466205Sdan     pNew->pPrior = 0;
14746ab3a2ecSdanielk1977     pNew->pLimit = sqlite3ExprDup(db, p->pLimit, flags);
147592b01d53Sdrh     pNew->iLimit = 0;
147692b01d53Sdrh     pNew->iOffset = 0;
14777d10d5a6Sdrh     pNew->selFlags = p->selFlags & ~SF_UsesEphemeral;
1478b9bb7c18Sdrh     pNew->addrOpenEphm[0] = -1;
1479b9bb7c18Sdrh     pNew->addrOpenEphm[1] = -1;
1480ec2da854Sdrh     pNew->nSelectRow = p->nSelectRow;
14814e9119d9Sdan     pNew->pWith = withDup(db, p->pWith);
14822e362f97Sdan     pNew->pWin = 0;
1483e3bf632cSdan     pNew->pWinDefn = 0;           /* TODO!! */
1484eb9b884cSdrh     sqlite3SelectSetName(pNew, p->zSelName);
1485a7466205Sdan     *pp = pNew;
1486a7466205Sdan     pp = &pNew->pPrior;
1487a7466205Sdan     pNext = pNew;
1488a7466205Sdan   }
1489a7466205Sdan 
1490a7466205Sdan   return pRet;
1491ff78bd2fSdrh }
149293758c8dSdanielk1977 #else
14936ab3a2ecSdanielk1977 Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
149493758c8dSdanielk1977   assert( p==0 );
149593758c8dSdanielk1977   return 0;
149693758c8dSdanielk1977 }
149793758c8dSdanielk1977 #endif
1498ff78bd2fSdrh 
1499ff78bd2fSdrh 
1500ff78bd2fSdrh /*
1501a76b5dfcSdrh ** Add a new element to the end of an expression list.  If pList is
1502a76b5dfcSdrh ** initially NULL, then create a new expression list.
1503b7916a78Sdrh **
1504a19543feSdrh ** The pList argument must be either NULL or a pointer to an ExprList
1505a19543feSdrh ** obtained from a prior call to sqlite3ExprListAppend().  This routine
1506a19543feSdrh ** may not be used with an ExprList obtained from sqlite3ExprListDup().
1507a19543feSdrh ** Reason:  This routine assumes that the number of slots in pList->a[]
1508a19543feSdrh ** is a power of two.  That is true for sqlite3ExprListAppend() returns
1509a19543feSdrh ** but is not necessarily true from the return value of sqlite3ExprListDup().
1510a19543feSdrh **
1511b7916a78Sdrh ** If a memory allocation error occurs, the entire list is freed and
1512b7916a78Sdrh ** NULL is returned.  If non-NULL is returned, then it is guaranteed
1513b7916a78Sdrh ** that the new entry was successfully appended.
1514a76b5dfcSdrh */
151517435752Sdrh ExprList *sqlite3ExprListAppend(
151617435752Sdrh   Parse *pParse,          /* Parsing context */
151717435752Sdrh   ExprList *pList,        /* List to which to append. Might be NULL */
1518b7916a78Sdrh   Expr *pExpr             /* Expression to be appended. Might be NULL */
151917435752Sdrh ){
152043606175Sdrh   struct ExprList_item *pItem;
152117435752Sdrh   sqlite3 *db = pParse->db;
1522575fad65Sdrh   assert( db!=0 );
1523a76b5dfcSdrh   if( pList==0 ){
1524575fad65Sdrh     pList = sqlite3DbMallocRawNN(db, sizeof(ExprList) );
1525a76b5dfcSdrh     if( pList==0 ){
1526d5d56523Sdanielk1977       goto no_mem;
1527a76b5dfcSdrh     }
1528c263f7c4Sdrh     pList->nExpr = 0;
1529a19543feSdrh   }else if( (pList->nExpr & (pList->nExpr-1))==0 ){
153043606175Sdrh     ExprList *pNew;
153143606175Sdrh     pNew = sqlite3DbRealloc(db, pList,
1532a19543feSdrh              sizeof(*pList)+(2*pList->nExpr - 1)*sizeof(pList->a[0]));
153343606175Sdrh     if( pNew==0 ){
1534d5d56523Sdanielk1977       goto no_mem;
1535a76b5dfcSdrh     }
153643606175Sdrh     pList = pNew;
1537a76b5dfcSdrh   }
153843606175Sdrh   pItem = &pList->a[pList->nExpr++];
1539a8b9793cSdrh   assert( offsetof(struct ExprList_item,zName)==sizeof(pItem->pExpr) );
1540a8b9793cSdrh   assert( offsetof(struct ExprList_item,pExpr)==0 );
1541a8b9793cSdrh   memset(&pItem->zName,0,sizeof(*pItem)-offsetof(struct ExprList_item,zName));
1542e94ddc9eSdanielk1977   pItem->pExpr = pExpr;
1543a76b5dfcSdrh   return pList;
1544d5d56523Sdanielk1977 
1545d5d56523Sdanielk1977 no_mem:
1546d5d56523Sdanielk1977   /* Avoid leaking memory if malloc has failed. */
1547633e6d57Sdrh   sqlite3ExprDelete(db, pExpr);
1548633e6d57Sdrh   sqlite3ExprListDelete(db, pList);
1549d5d56523Sdanielk1977   return 0;
1550a76b5dfcSdrh }
1551a76b5dfcSdrh 
1552a76b5dfcSdrh /*
15538762ec19Sdrh ** pColumns and pExpr form a vector assignment which is part of the SET
15548762ec19Sdrh ** clause of an UPDATE statement.  Like this:
1555a1251bc4Sdrh **
1556a1251bc4Sdrh **        (a,b,c) = (expr1,expr2,expr3)
1557a1251bc4Sdrh ** Or:    (a,b,c) = (SELECT x,y,z FROM ....)
1558a1251bc4Sdrh **
1559a1251bc4Sdrh ** For each term of the vector assignment, append new entries to the
1560b67343d0Sdrh ** expression list pList.  In the case of a subquery on the RHS, append
1561a1251bc4Sdrh ** TK_SELECT_COLUMN expressions.
1562a1251bc4Sdrh */
1563a1251bc4Sdrh ExprList *sqlite3ExprListAppendVector(
1564a1251bc4Sdrh   Parse *pParse,         /* Parsing context */
1565a1251bc4Sdrh   ExprList *pList,       /* List to which to append. Might be NULL */
1566a1251bc4Sdrh   IdList *pColumns,      /* List of names of LHS of the assignment */
1567a1251bc4Sdrh   Expr *pExpr            /* Vector expression to be appended. Might be NULL */
1568a1251bc4Sdrh ){
1569a1251bc4Sdrh   sqlite3 *db = pParse->db;
1570a1251bc4Sdrh   int n;
1571a1251bc4Sdrh   int i;
157266860af3Sdrh   int iFirst = pList ? pList->nExpr : 0;
1573321e828dSdrh   /* pColumns can only be NULL due to an OOM but an OOM will cause an
1574321e828dSdrh   ** exit prior to this routine being invoked */
1575321e828dSdrh   if( NEVER(pColumns==0) ) goto vector_append_error;
1576a1251bc4Sdrh   if( pExpr==0 ) goto vector_append_error;
1577966e2911Sdrh 
1578966e2911Sdrh   /* If the RHS is a vector, then we can immediately check to see that
1579966e2911Sdrh   ** the size of the RHS and LHS match.  But if the RHS is a SELECT,
1580966e2911Sdrh   ** wildcards ("*") in the result set of the SELECT must be expanded before
1581966e2911Sdrh   ** we can do the size check, so defer the size check until code generation.
1582966e2911Sdrh   */
1583966e2911Sdrh   if( pExpr->op!=TK_SELECT && pColumns->nId!=(n=sqlite3ExprVectorSize(pExpr)) ){
1584a1251bc4Sdrh     sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
1585a1251bc4Sdrh                     pColumns->nId, n);
1586a1251bc4Sdrh     goto vector_append_error;
1587a1251bc4Sdrh   }
1588966e2911Sdrh 
1589966e2911Sdrh   for(i=0; i<pColumns->nId; i++){
1590a1251bc4Sdrh     Expr *pSubExpr = sqlite3ExprForVectorField(pParse, pExpr, i);
1591a1251bc4Sdrh     pList = sqlite3ExprListAppend(pParse, pList, pSubExpr);
1592a1251bc4Sdrh     if( pList ){
159366860af3Sdrh       assert( pList->nExpr==iFirst+i+1 );
1594a1251bc4Sdrh       pList->a[pList->nExpr-1].zName = pColumns->a[i].zName;
1595a1251bc4Sdrh       pColumns->a[i].zName = 0;
1596a1251bc4Sdrh     }
1597a1251bc4Sdrh   }
1598966e2911Sdrh 
1599ffe28059Sdrh   if( !db->mallocFailed && pExpr->op==TK_SELECT && ALWAYS(pList!=0) ){
1600966e2911Sdrh     Expr *pFirst = pList->a[iFirst].pExpr;
1601f4dd26c5Sdrh     assert( pFirst!=0 );
1602966e2911Sdrh     assert( pFirst->op==TK_SELECT_COLUMN );
1603966e2911Sdrh 
1604966e2911Sdrh     /* Store the SELECT statement in pRight so it will be deleted when
1605966e2911Sdrh     ** sqlite3ExprListDelete() is called */
1606966e2911Sdrh     pFirst->pRight = pExpr;
1607a1251bc4Sdrh     pExpr = 0;
1608966e2911Sdrh 
1609966e2911Sdrh     /* Remember the size of the LHS in iTable so that we can check that
1610966e2911Sdrh     ** the RHS and LHS sizes match during code generation. */
1611966e2911Sdrh     pFirst->iTable = pColumns->nId;
1612a1251bc4Sdrh   }
1613a1251bc4Sdrh 
1614a1251bc4Sdrh vector_append_error:
1615a1251bc4Sdrh   sqlite3ExprDelete(db, pExpr);
1616a1251bc4Sdrh   sqlite3IdListDelete(db, pColumns);
1617a1251bc4Sdrh   return pList;
1618a1251bc4Sdrh }
1619a1251bc4Sdrh 
1620a1251bc4Sdrh /*
1621bc622bc0Sdrh ** Set the sort order for the last element on the given ExprList.
1622bc622bc0Sdrh */
1623bc622bc0Sdrh void sqlite3ExprListSetSortOrder(ExprList *p, int iSortOrder){
1624bc622bc0Sdrh   if( p==0 ) return;
1625bc622bc0Sdrh   assert( SQLITE_SO_UNDEFINED<0 && SQLITE_SO_ASC>=0 && SQLITE_SO_DESC>0 );
1626bc622bc0Sdrh   assert( p->nExpr>0 );
1627bc622bc0Sdrh   if( iSortOrder<0 ){
1628bc622bc0Sdrh     assert( p->a[p->nExpr-1].sortOrder==SQLITE_SO_ASC );
1629bc622bc0Sdrh     return;
1630bc622bc0Sdrh   }
1631bc622bc0Sdrh   p->a[p->nExpr-1].sortOrder = (u8)iSortOrder;
1632bc622bc0Sdrh }
1633bc622bc0Sdrh 
1634bc622bc0Sdrh /*
1635b7916a78Sdrh ** Set the ExprList.a[].zName element of the most recently added item
1636b7916a78Sdrh ** on the expression list.
1637b7916a78Sdrh **
1638b7916a78Sdrh ** pList might be NULL following an OOM error.  But pName should never be
1639b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1640b7916a78Sdrh ** is set.
1641b7916a78Sdrh */
1642b7916a78Sdrh void sqlite3ExprListSetName(
1643b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1644b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
1645b7916a78Sdrh   Token *pName,           /* Name to be added */
1646b7916a78Sdrh   int dequote             /* True to cause the name to be dequoted */
1647b7916a78Sdrh ){
1648b7916a78Sdrh   assert( pList!=0 || pParse->db->mallocFailed!=0 );
1649b7916a78Sdrh   if( pList ){
1650b7916a78Sdrh     struct ExprList_item *pItem;
1651b7916a78Sdrh     assert( pList->nExpr>0 );
1652b7916a78Sdrh     pItem = &pList->a[pList->nExpr-1];
1653b7916a78Sdrh     assert( pItem->zName==0 );
1654b7916a78Sdrh     pItem->zName = sqlite3DbStrNDup(pParse->db, pName->z, pName->n);
1655244b9d6eSdrh     if( dequote ) sqlite3Dequote(pItem->zName);
1656b7916a78Sdrh   }
1657b7916a78Sdrh }
1658b7916a78Sdrh 
1659b7916a78Sdrh /*
1660b7916a78Sdrh ** Set the ExprList.a[].zSpan element of the most recently added item
1661b7916a78Sdrh ** on the expression list.
1662b7916a78Sdrh **
1663b7916a78Sdrh ** pList might be NULL following an OOM error.  But pSpan should never be
1664b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1665b7916a78Sdrh ** is set.
1666b7916a78Sdrh */
1667b7916a78Sdrh void sqlite3ExprListSetSpan(
1668b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1669b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
16701be266baSdrh   const char *zStart,     /* Start of the span */
16711be266baSdrh   const char *zEnd        /* End of the span */
1672b7916a78Sdrh ){
1673b7916a78Sdrh   sqlite3 *db = pParse->db;
1674b7916a78Sdrh   assert( pList!=0 || db->mallocFailed!=0 );
1675b7916a78Sdrh   if( pList ){
1676b7916a78Sdrh     struct ExprList_item *pItem = &pList->a[pList->nExpr-1];
1677b7916a78Sdrh     assert( pList->nExpr>0 );
1678b7916a78Sdrh     sqlite3DbFree(db, pItem->zSpan);
16799b2e0435Sdrh     pItem->zSpan = sqlite3DbSpanDup(db, zStart, zEnd);
1680b7916a78Sdrh   }
1681b7916a78Sdrh }
1682b7916a78Sdrh 
1683b7916a78Sdrh /*
16847a15a4beSdanielk1977 ** If the expression list pEList contains more than iLimit elements,
16857a15a4beSdanielk1977 ** leave an error message in pParse.
16867a15a4beSdanielk1977 */
16877a15a4beSdanielk1977 void sqlite3ExprListCheckLength(
16887a15a4beSdanielk1977   Parse *pParse,
16897a15a4beSdanielk1977   ExprList *pEList,
16907a15a4beSdanielk1977   const char *zObject
16917a15a4beSdanielk1977 ){
1692b1a6c3c1Sdrh   int mx = pParse->db->aLimit[SQLITE_LIMIT_COLUMN];
1693c5499befSdrh   testcase( pEList && pEList->nExpr==mx );
1694c5499befSdrh   testcase( pEList && pEList->nExpr==mx+1 );
1695b1a6c3c1Sdrh   if( pEList && pEList->nExpr>mx ){
16967a15a4beSdanielk1977     sqlite3ErrorMsg(pParse, "too many columns in %s", zObject);
16977a15a4beSdanielk1977   }
16987a15a4beSdanielk1977 }
16997a15a4beSdanielk1977 
17007a15a4beSdanielk1977 /*
1701a76b5dfcSdrh ** Delete an entire expression list.
1702a76b5dfcSdrh */
1703affa855cSdrh static SQLITE_NOINLINE void exprListDeleteNN(sqlite3 *db, ExprList *pList){
1704ac48b751Sdrh   int i = pList->nExpr;
1705ac48b751Sdrh   struct ExprList_item *pItem =  pList->a;
1706ac48b751Sdrh   assert( pList->nExpr>0 );
1707ac48b751Sdrh   do{
1708633e6d57Sdrh     sqlite3ExprDelete(db, pItem->pExpr);
1709633e6d57Sdrh     sqlite3DbFree(db, pItem->zName);
1710b7916a78Sdrh     sqlite3DbFree(db, pItem->zSpan);
1711ac48b751Sdrh     pItem++;
1712ac48b751Sdrh   }while( --i>0 );
1713dbd6a7dcSdrh   sqlite3DbFreeNN(db, pList);
1714a76b5dfcSdrh }
1715affa855cSdrh void sqlite3ExprListDelete(sqlite3 *db, ExprList *pList){
1716affa855cSdrh   if( pList ) exprListDeleteNN(db, pList);
1717affa855cSdrh }
1718a76b5dfcSdrh 
1719a76b5dfcSdrh /*
17202308ed38Sdrh ** Return the bitwise-OR of all Expr.flags fields in the given
17212308ed38Sdrh ** ExprList.
1722885a5b03Sdrh */
17232308ed38Sdrh u32 sqlite3ExprListFlags(const ExprList *pList){
1724885a5b03Sdrh   int i;
17252308ed38Sdrh   u32 m = 0;
1726508e2d00Sdrh   assert( pList!=0 );
1727885a5b03Sdrh   for(i=0; i<pList->nExpr; i++){
1728d0c73053Sdrh      Expr *pExpr = pList->a[i].pExpr;
1729de845c2fSdrh      assert( pExpr!=0 );
1730de845c2fSdrh      m |= pExpr->flags;
1731885a5b03Sdrh   }
17322308ed38Sdrh   return m;
1733885a5b03Sdrh }
1734885a5b03Sdrh 
1735885a5b03Sdrh /*
17367e6f980bSdrh ** This is a SELECT-node callback for the expression walker that
17377e6f980bSdrh ** always "fails".  By "fail" in this case, we mean set
17387e6f980bSdrh ** pWalker->eCode to zero and abort.
17397e6f980bSdrh **
17407e6f980bSdrh ** This callback is used by multiple expression walkers.
17417e6f980bSdrh */
17427e6f980bSdrh int sqlite3SelectWalkFail(Walker *pWalker, Select *NotUsed){
17437e6f980bSdrh   UNUSED_PARAMETER(NotUsed);
17447e6f980bSdrh   pWalker->eCode = 0;
17457e6f980bSdrh   return WRC_Abort;
17467e6f980bSdrh }
17477e6f980bSdrh 
17487e6f980bSdrh /*
1749171d16bbSdrh ** If the input expression is an ID with the name "true" or "false"
175096acafbeSdrh ** then convert it into an TK_TRUEFALSE term.  Return non-zero if
175196acafbeSdrh ** the conversion happened, and zero if the expression is unaltered.
1752171d16bbSdrh */
1753171d16bbSdrh int sqlite3ExprIdToTrueFalse(Expr *pExpr){
1754171d16bbSdrh   assert( pExpr->op==TK_ID || pExpr->op==TK_STRING );
1755171d16bbSdrh   if( sqlite3StrICmp(pExpr->u.zToken, "true")==0
1756171d16bbSdrh    || sqlite3StrICmp(pExpr->u.zToken, "false")==0
1757171d16bbSdrh   ){
1758171d16bbSdrh     pExpr->op = TK_TRUEFALSE;
1759171d16bbSdrh     return 1;
1760171d16bbSdrh   }
1761171d16bbSdrh   return 0;
1762171d16bbSdrh }
1763171d16bbSdrh 
176443c4ac8bSdrh /*
176596acafbeSdrh ** The argument must be a TK_TRUEFALSE Expr node.  Return 1 if it is TRUE
176643c4ac8bSdrh ** and 0 if it is FALSE.
176743c4ac8bSdrh */
176896acafbeSdrh int sqlite3ExprTruthValue(const Expr *pExpr){
176943c4ac8bSdrh   assert( pExpr->op==TK_TRUEFALSE );
177043c4ac8bSdrh   assert( sqlite3StrICmp(pExpr->u.zToken,"true")==0
177143c4ac8bSdrh        || sqlite3StrICmp(pExpr->u.zToken,"false")==0 );
177243c4ac8bSdrh   return pExpr->u.zToken[4]==0;
177343c4ac8bSdrh }
177443c4ac8bSdrh 
1775171d16bbSdrh 
1776171d16bbSdrh /*
1777059b2d50Sdrh ** These routines are Walker callbacks used to check expressions to
1778059b2d50Sdrh ** see if they are "constant" for some definition of constant.  The
1779059b2d50Sdrh ** Walker.eCode value determines the type of "constant" we are looking
1780059b2d50Sdrh ** for.
178173b211abSdrh **
17827d10d5a6Sdrh ** These callback routines are used to implement the following:
1783626a879aSdrh **
1784059b2d50Sdrh **     sqlite3ExprIsConstant()                  pWalker->eCode==1
1785059b2d50Sdrh **     sqlite3ExprIsConstantNotJoin()           pWalker->eCode==2
1786fcb9f4f3Sdrh **     sqlite3ExprIsTableConstant()             pWalker->eCode==3
1787059b2d50Sdrh **     sqlite3ExprIsConstantOrFunction()        pWalker->eCode==4 or 5
178887abf5c0Sdrh **
1789059b2d50Sdrh ** In all cases, the callbacks set Walker.eCode=0 and abort if the expression
1790059b2d50Sdrh ** is found to not be a constant.
179187abf5c0Sdrh **
1792feada2dfSdrh ** The sqlite3ExprIsConstantOrFunction() is used for evaluating expressions
1793059b2d50Sdrh ** in a CREATE TABLE statement.  The Walker.eCode value is 5 when parsing
1794059b2d50Sdrh ** an existing schema and 4 when processing a new statement.  A bound
1795feada2dfSdrh ** parameter raises an error for new statements, but is silently converted
1796feada2dfSdrh ** to NULL for existing schemas.  This allows sqlite_master tables that
1797feada2dfSdrh ** contain a bound parameter because they were generated by older versions
1798feada2dfSdrh ** of SQLite to be parsed by newer versions of SQLite without raising a
1799feada2dfSdrh ** malformed schema error.
1800626a879aSdrh */
18017d10d5a6Sdrh static int exprNodeIsConstant(Walker *pWalker, Expr *pExpr){
1802626a879aSdrh 
1803059b2d50Sdrh   /* If pWalker->eCode is 2 then any term of the expression that comes from
1804059b2d50Sdrh   ** the ON or USING clauses of a left join disqualifies the expression
18050a168377Sdrh   ** from being considered constant. */
1806059b2d50Sdrh   if( pWalker->eCode==2 && ExprHasProperty(pExpr, EP_FromJoin) ){
1807059b2d50Sdrh     pWalker->eCode = 0;
18087d10d5a6Sdrh     return WRC_Abort;
18090a168377Sdrh   }
18100a168377Sdrh 
1811626a879aSdrh   switch( pExpr->op ){
1812eb55bd2fSdrh     /* Consider functions to be constant if all their arguments are constant
1813059b2d50Sdrh     ** and either pWalker->eCode==4 or 5 or the function has the
1814059b2d50Sdrh     ** SQLITE_FUNC_CONST flag. */
1815eb55bd2fSdrh     case TK_FUNCTION:
181663f84573Sdrh       if( pWalker->eCode>=4 || ExprHasProperty(pExpr,EP_ConstFunc) ){
1817b1fba286Sdrh         return WRC_Continue;
1818059b2d50Sdrh       }else{
1819059b2d50Sdrh         pWalker->eCode = 0;
1820059b2d50Sdrh         return WRC_Abort;
1821b1fba286Sdrh       }
1822626a879aSdrh     case TK_ID:
1823171d16bbSdrh       /* Convert "true" or "false" in a DEFAULT clause into the
1824171d16bbSdrh       ** appropriate TK_TRUEFALSE operator */
1825e39ef31cSdrh       if( sqlite3ExprIdToTrueFalse(pExpr) ){
1826171d16bbSdrh         return WRC_Prune;
1827171d16bbSdrh       }
1828171d16bbSdrh       /* Fall thru */
1829626a879aSdrh     case TK_COLUMN:
1830626a879aSdrh     case TK_AGG_FUNCTION:
183113449892Sdrh     case TK_AGG_COLUMN:
1832c5499befSdrh       testcase( pExpr->op==TK_ID );
1833c5499befSdrh       testcase( pExpr->op==TK_COLUMN );
1834c5499befSdrh       testcase( pExpr->op==TK_AGG_FUNCTION );
1835c5499befSdrh       testcase( pExpr->op==TK_AGG_COLUMN );
1836059b2d50Sdrh       if( pWalker->eCode==3 && pExpr->iTable==pWalker->u.iCur ){
1837059b2d50Sdrh         return WRC_Continue;
1838f43ce0b4Sdrh       }
1839f43ce0b4Sdrh       /* Fall through */
1840f43ce0b4Sdrh     case TK_IF_NULL_ROW:
18416e341b93Sdrh     case TK_REGISTER:
18429916048bSdrh       testcase( pExpr->op==TK_REGISTER );
1843f43ce0b4Sdrh       testcase( pExpr->op==TK_IF_NULL_ROW );
1844059b2d50Sdrh       pWalker->eCode = 0;
18457d10d5a6Sdrh       return WRC_Abort;
1846feada2dfSdrh     case TK_VARIABLE:
1847059b2d50Sdrh       if( pWalker->eCode==5 ){
1848feada2dfSdrh         /* Silently convert bound parameters that appear inside of CREATE
1849feada2dfSdrh         ** statements into a NULL when parsing the CREATE statement text out
1850feada2dfSdrh         ** of the sqlite_master table */
1851feada2dfSdrh         pExpr->op = TK_NULL;
1852059b2d50Sdrh       }else if( pWalker->eCode==4 ){
1853feada2dfSdrh         /* A bound parameter in a CREATE statement that originates from
1854feada2dfSdrh         ** sqlite3_prepare() causes an error */
1855059b2d50Sdrh         pWalker->eCode = 0;
1856feada2dfSdrh         return WRC_Abort;
1857feada2dfSdrh       }
1858feada2dfSdrh       /* Fall through */
1859626a879aSdrh     default:
18606e341b93Sdrh       testcase( pExpr->op==TK_SELECT ); /* sqlite3SelectWalkFail() disallows */
18616e341b93Sdrh       testcase( pExpr->op==TK_EXISTS ); /* sqlite3SelectWalkFail() disallows */
18627d10d5a6Sdrh       return WRC_Continue;
1863626a879aSdrh   }
1864626a879aSdrh }
1865059b2d50Sdrh static int exprIsConst(Expr *p, int initFlag, int iCur){
18667d10d5a6Sdrh   Walker w;
1867059b2d50Sdrh   w.eCode = initFlag;
18687d10d5a6Sdrh   w.xExprCallback = exprNodeIsConstant;
18697e6f980bSdrh   w.xSelectCallback = sqlite3SelectWalkFail;
1870979dd1beSdrh #ifdef SQLITE_DEBUG
1871979dd1beSdrh   w.xSelectCallback2 = sqlite3SelectWalkAssert2;
1872979dd1beSdrh #endif
1873059b2d50Sdrh   w.u.iCur = iCur;
18747d10d5a6Sdrh   sqlite3WalkExpr(&w, p);
1875059b2d50Sdrh   return w.eCode;
18767d10d5a6Sdrh }
1877626a879aSdrh 
1878626a879aSdrh /*
1879059b2d50Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
1880eb55bd2fSdrh ** and 0 if it involves variables or function calls.
18812398937bSdrh **
18822398937bSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
18832398937bSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
18842398937bSdrh ** a constant.
1885fef5208cSdrh */
18864adee20fSdanielk1977 int sqlite3ExprIsConstant(Expr *p){
1887059b2d50Sdrh   return exprIsConst(p, 1, 0);
1888fef5208cSdrh }
1889fef5208cSdrh 
1890fef5208cSdrh /*
1891059b2d50Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
18920a168377Sdrh ** that does no originate from the ON or USING clauses of a join.
18930a168377Sdrh ** Return 0 if it involves variables or function calls or terms from
18940a168377Sdrh ** an ON or USING clause.
18950a168377Sdrh */
18960a168377Sdrh int sqlite3ExprIsConstantNotJoin(Expr *p){
1897059b2d50Sdrh   return exprIsConst(p, 2, 0);
18980a168377Sdrh }
18990a168377Sdrh 
19000a168377Sdrh /*
1901fcb9f4f3Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
1902059b2d50Sdrh ** for any single row of the table with cursor iCur.  In other words, the
1903059b2d50Sdrh ** expression must not refer to any non-deterministic function nor any
1904059b2d50Sdrh ** table other than iCur.
1905059b2d50Sdrh */
1906059b2d50Sdrh int sqlite3ExprIsTableConstant(Expr *p, int iCur){
1907059b2d50Sdrh   return exprIsConst(p, 3, iCur);
1908059b2d50Sdrh }
1909059b2d50Sdrh 
1910ab31a845Sdan 
1911ab31a845Sdan /*
1912ab31a845Sdan ** sqlite3WalkExpr() callback used by sqlite3ExprIsConstantOrGroupBy().
1913ab31a845Sdan */
1914ab31a845Sdan static int exprNodeIsConstantOrGroupBy(Walker *pWalker, Expr *pExpr){
1915ab31a845Sdan   ExprList *pGroupBy = pWalker->u.pGroupBy;
1916ab31a845Sdan   int i;
1917ab31a845Sdan 
1918ab31a845Sdan   /* Check if pExpr is identical to any GROUP BY term. If so, consider
1919ab31a845Sdan   ** it constant.  */
1920ab31a845Sdan   for(i=0; i<pGroupBy->nExpr; i++){
1921ab31a845Sdan     Expr *p = pGroupBy->a[i].pExpr;
19225aa550cfSdan     if( sqlite3ExprCompare(0, pExpr, p, -1)<2 ){
192370efa84dSdrh       CollSeq *pColl = sqlite3ExprNNCollSeq(pWalker->pParse, p);
192470efa84dSdrh       if( sqlite3_stricmp("BINARY", pColl->zName)==0 ){
1925ab31a845Sdan         return WRC_Prune;
1926ab31a845Sdan       }
1927ab31a845Sdan     }
1928ab31a845Sdan   }
1929ab31a845Sdan 
1930ab31a845Sdan   /* Check if pExpr is a sub-select. If so, consider it variable. */
1931ab31a845Sdan   if( ExprHasProperty(pExpr, EP_xIsSelect) ){
1932ab31a845Sdan     pWalker->eCode = 0;
1933ab31a845Sdan     return WRC_Abort;
1934ab31a845Sdan   }
1935ab31a845Sdan 
1936ab31a845Sdan   return exprNodeIsConstant(pWalker, pExpr);
1937ab31a845Sdan }
1938ab31a845Sdan 
1939ab31a845Sdan /*
1940ab31a845Sdan ** Walk the expression tree passed as the first argument. Return non-zero
1941ab31a845Sdan ** if the expression consists entirely of constants or copies of terms
1942ab31a845Sdan ** in pGroupBy that sort with the BINARY collation sequence.
1943ab314001Sdrh **
1944ab314001Sdrh ** This routine is used to determine if a term of the HAVING clause can
1945ab314001Sdrh ** be promoted into the WHERE clause.  In order for such a promotion to work,
1946ab314001Sdrh ** the value of the HAVING clause term must be the same for all members of
1947ab314001Sdrh ** a "group".  The requirement that the GROUP BY term must be BINARY
1948ab314001Sdrh ** assumes that no other collating sequence will have a finer-grained
1949ab314001Sdrh ** grouping than binary.  In other words (A=B COLLATE binary) implies
1950ab314001Sdrh ** A=B in every other collating sequence.  The requirement that the
1951ab314001Sdrh ** GROUP BY be BINARY is stricter than necessary.  It would also work
1952ab314001Sdrh ** to promote HAVING clauses that use the same alternative collating
1953ab314001Sdrh ** sequence as the GROUP BY term, but that is much harder to check,
1954ab314001Sdrh ** alternative collating sequences are uncommon, and this is only an
1955ab314001Sdrh ** optimization, so we take the easy way out and simply require the
1956ab314001Sdrh ** GROUP BY to use the BINARY collating sequence.
1957ab31a845Sdan */
1958ab31a845Sdan int sqlite3ExprIsConstantOrGroupBy(Parse *pParse, Expr *p, ExprList *pGroupBy){
1959ab31a845Sdan   Walker w;
1960ab31a845Sdan   w.eCode = 1;
1961ab31a845Sdan   w.xExprCallback = exprNodeIsConstantOrGroupBy;
1962979dd1beSdrh   w.xSelectCallback = 0;
1963ab31a845Sdan   w.u.pGroupBy = pGroupBy;
1964ab31a845Sdan   w.pParse = pParse;
1965ab31a845Sdan   sqlite3WalkExpr(&w, p);
1966ab31a845Sdan   return w.eCode;
1967ab31a845Sdan }
1968ab31a845Sdan 
1969059b2d50Sdrh /*
1970059b2d50Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
1971eb55bd2fSdrh ** or a function call with constant arguments.  Return and 0 if there
1972eb55bd2fSdrh ** are any variables.
1973eb55bd2fSdrh **
1974eb55bd2fSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
1975eb55bd2fSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
1976eb55bd2fSdrh ** a constant.
1977eb55bd2fSdrh */
1978feada2dfSdrh int sqlite3ExprIsConstantOrFunction(Expr *p, u8 isInit){
1979feada2dfSdrh   assert( isInit==0 || isInit==1 );
1980059b2d50Sdrh   return exprIsConst(p, 4+isInit, 0);
1981eb55bd2fSdrh }
1982eb55bd2fSdrh 
19835b88bc4bSdrh #ifdef SQLITE_ENABLE_CURSOR_HINTS
19845b88bc4bSdrh /*
19855b88bc4bSdrh ** Walk an expression tree.  Return 1 if the expression contains a
19865b88bc4bSdrh ** subquery of some kind.  Return 0 if there are no subqueries.
19875b88bc4bSdrh */
19885b88bc4bSdrh int sqlite3ExprContainsSubquery(Expr *p){
19895b88bc4bSdrh   Walker w;
1990bec2476aSdrh   w.eCode = 1;
19915b88bc4bSdrh   w.xExprCallback = sqlite3ExprWalkNoop;
19927e6f980bSdrh   w.xSelectCallback = sqlite3SelectWalkFail;
1993979dd1beSdrh #ifdef SQLITE_DEBUG
1994979dd1beSdrh   w.xSelectCallback2 = sqlite3SelectWalkAssert2;
1995979dd1beSdrh #endif
19965b88bc4bSdrh   sqlite3WalkExpr(&w, p);
199707194bffSdrh   return w.eCode==0;
19985b88bc4bSdrh }
19995b88bc4bSdrh #endif
20005b88bc4bSdrh 
2001eb55bd2fSdrh /*
200273b211abSdrh ** If the expression p codes a constant integer that is small enough
2003202b2df7Sdrh ** to fit in a 32-bit integer, return 1 and put the value of the integer
2004202b2df7Sdrh ** in *pValue.  If the expression is not an integer or if it is too big
2005202b2df7Sdrh ** to fit in a signed 32-bit integer, return 0 and leave *pValue unchanged.
2006e4de1febSdrh */
20074adee20fSdanielk1977 int sqlite3ExprIsInteger(Expr *p, int *pValue){
200892b01d53Sdrh   int rc = 0;
2009ba28b5abSdrh   if( p==0 ) return 0;  /* Can only happen following on OOM */
2010cd92e84dSdrh 
2011cd92e84dSdrh   /* If an expression is an integer literal that fits in a signed 32-bit
2012cd92e84dSdrh   ** integer, then the EP_IntValue flag will have already been set */
2013cd92e84dSdrh   assert( p->op!=TK_INTEGER || (p->flags & EP_IntValue)!=0
2014cd92e84dSdrh            || sqlite3GetInt32(p->u.zToken, &rc)==0 );
2015cd92e84dSdrh 
201692b01d53Sdrh   if( p->flags & EP_IntValue ){
201733e619fcSdrh     *pValue = p->u.iValue;
2018e4de1febSdrh     return 1;
2019e4de1febSdrh   }
202092b01d53Sdrh   switch( p->op ){
20214b59ab5eSdrh     case TK_UPLUS: {
202292b01d53Sdrh       rc = sqlite3ExprIsInteger(p->pLeft, pValue);
2023f6e369a1Sdrh       break;
20244b59ab5eSdrh     }
2025e4de1febSdrh     case TK_UMINUS: {
2026e4de1febSdrh       int v;
20274adee20fSdanielk1977       if( sqlite3ExprIsInteger(p->pLeft, &v) ){
2028f6418891Smistachkin         assert( v!=(-2147483647-1) );
2029e4de1febSdrh         *pValue = -v;
203092b01d53Sdrh         rc = 1;
2031e4de1febSdrh       }
2032e4de1febSdrh       break;
2033e4de1febSdrh     }
2034e4de1febSdrh     default: break;
2035e4de1febSdrh   }
203692b01d53Sdrh   return rc;
2037e4de1febSdrh }
2038e4de1febSdrh 
2039e4de1febSdrh /*
2040039fc32eSdrh ** Return FALSE if there is no chance that the expression can be NULL.
2041039fc32eSdrh **
2042039fc32eSdrh ** If the expression might be NULL or if the expression is too complex
2043039fc32eSdrh ** to tell return TRUE.
2044039fc32eSdrh **
2045039fc32eSdrh ** This routine is used as an optimization, to skip OP_IsNull opcodes
2046039fc32eSdrh ** when we know that a value cannot be NULL.  Hence, a false positive
2047039fc32eSdrh ** (returning TRUE when in fact the expression can never be NULL) might
2048039fc32eSdrh ** be a small performance hit but is otherwise harmless.  On the other
2049039fc32eSdrh ** hand, a false negative (returning FALSE when the result could be NULL)
2050039fc32eSdrh ** will likely result in an incorrect answer.  So when in doubt, return
2051039fc32eSdrh ** TRUE.
2052039fc32eSdrh */
2053039fc32eSdrh int sqlite3ExprCanBeNull(const Expr *p){
2054039fc32eSdrh   u8 op;
2055cd7f457eSdrh   while( p->op==TK_UPLUS || p->op==TK_UMINUS ){ p = p->pLeft; }
2056039fc32eSdrh   op = p->op;
2057039fc32eSdrh   if( op==TK_REGISTER ) op = p->op2;
2058039fc32eSdrh   switch( op ){
2059039fc32eSdrh     case TK_INTEGER:
2060039fc32eSdrh     case TK_STRING:
2061039fc32eSdrh     case TK_FLOAT:
2062039fc32eSdrh     case TK_BLOB:
2063039fc32eSdrh       return 0;
20647248a8b2Sdrh     case TK_COLUMN:
206572673a24Sdrh       return ExprHasProperty(p, EP_CanBeNull) ||
20664dd89d5aSdrh              p->pTab==0 ||  /* Reference to column of index on expression */
206772673a24Sdrh              (p->iColumn>=0 && p->pTab->aCol[p->iColumn].notNull==0);
2068039fc32eSdrh     default:
2069039fc32eSdrh       return 1;
2070039fc32eSdrh   }
2071039fc32eSdrh }
2072039fc32eSdrh 
2073039fc32eSdrh /*
2074039fc32eSdrh ** Return TRUE if the given expression is a constant which would be
2075039fc32eSdrh ** unchanged by OP_Affinity with the affinity given in the second
2076039fc32eSdrh ** argument.
2077039fc32eSdrh **
2078039fc32eSdrh ** This routine is used to determine if the OP_Affinity operation
2079039fc32eSdrh ** can be omitted.  When in doubt return FALSE.  A false negative
2080039fc32eSdrh ** is harmless.  A false positive, however, can result in the wrong
2081039fc32eSdrh ** answer.
2082039fc32eSdrh */
2083039fc32eSdrh int sqlite3ExprNeedsNoAffinityChange(const Expr *p, char aff){
2084039fc32eSdrh   u8 op;
208505883a34Sdrh   if( aff==SQLITE_AFF_BLOB ) return 1;
2086cd7f457eSdrh   while( p->op==TK_UPLUS || p->op==TK_UMINUS ){ p = p->pLeft; }
2087039fc32eSdrh   op = p->op;
2088039fc32eSdrh   if( op==TK_REGISTER ) op = p->op2;
2089039fc32eSdrh   switch( op ){
2090039fc32eSdrh     case TK_INTEGER: {
2091039fc32eSdrh       return aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC;
2092039fc32eSdrh     }
2093039fc32eSdrh     case TK_FLOAT: {
2094039fc32eSdrh       return aff==SQLITE_AFF_REAL || aff==SQLITE_AFF_NUMERIC;
2095039fc32eSdrh     }
2096039fc32eSdrh     case TK_STRING: {
2097039fc32eSdrh       return aff==SQLITE_AFF_TEXT;
2098039fc32eSdrh     }
2099039fc32eSdrh     case TK_BLOB: {
2100039fc32eSdrh       return 1;
2101039fc32eSdrh     }
21022f2855b6Sdrh     case TK_COLUMN: {
210388376ca7Sdrh       assert( p->iTable>=0 );  /* p cannot be part of a CHECK constraint */
210488376ca7Sdrh       return p->iColumn<0
21052f2855b6Sdrh           && (aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC);
21062f2855b6Sdrh     }
2107039fc32eSdrh     default: {
2108039fc32eSdrh       return 0;
2109039fc32eSdrh     }
2110039fc32eSdrh   }
2111039fc32eSdrh }
2112039fc32eSdrh 
2113039fc32eSdrh /*
2114c4a3c779Sdrh ** Return TRUE if the given string is a row-id column name.
2115c4a3c779Sdrh */
21164adee20fSdanielk1977 int sqlite3IsRowid(const char *z){
21174adee20fSdanielk1977   if( sqlite3StrICmp(z, "_ROWID_")==0 ) return 1;
21184adee20fSdanielk1977   if( sqlite3StrICmp(z, "ROWID")==0 ) return 1;
21194adee20fSdanielk1977   if( sqlite3StrICmp(z, "OID")==0 ) return 1;
2120c4a3c779Sdrh   return 0;
2121c4a3c779Sdrh }
2122c4a3c779Sdrh 
21239a96b668Sdanielk1977 /*
212469c355bdSdrh ** pX is the RHS of an IN operator.  If pX is a SELECT statement
212569c355bdSdrh ** that can be simplified to a direct table access, then return
212669c355bdSdrh ** a pointer to the SELECT statement.  If pX is not a SELECT statement,
212769c355bdSdrh ** or if the SELECT statement needs to be manifested into a transient
212869c355bdSdrh ** table, then return NULL.
2129b287f4b6Sdrh */
2130b287f4b6Sdrh #ifndef SQLITE_OMIT_SUBQUERY
21317b35a77bSdan static Select *isCandidateForInOpt(Expr *pX){
213269c355bdSdrh   Select *p;
2133b287f4b6Sdrh   SrcList *pSrc;
2134b287f4b6Sdrh   ExprList *pEList;
2135b287f4b6Sdrh   Table *pTab;
2136cfbb5e82Sdan   int i;
213769c355bdSdrh   if( !ExprHasProperty(pX, EP_xIsSelect) ) return 0;  /* Not a subquery */
213869c355bdSdrh   if( ExprHasProperty(pX, EP_VarSelect)  ) return 0;  /* Correlated subq */
213969c355bdSdrh   p = pX->x.pSelect;
2140b287f4b6Sdrh   if( p->pPrior ) return 0;              /* Not a compound SELECT */
21417d10d5a6Sdrh   if( p->selFlags & (SF_Distinct|SF_Aggregate) ){
2142b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
2143b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
21447d10d5a6Sdrh     return 0; /* No DISTINCT keyword and no aggregate functions */
21457d10d5a6Sdrh   }
2146b74b1017Sdrh   assert( p->pGroupBy==0 );              /* Has no GROUP BY clause */
2147b287f4b6Sdrh   if( p->pLimit ) return 0;              /* Has no LIMIT clause */
2148b287f4b6Sdrh   if( p->pWhere ) return 0;              /* Has no WHERE clause */
2149b287f4b6Sdrh   pSrc = p->pSrc;
2150d1fa7bcaSdrh   assert( pSrc!=0 );
2151d1fa7bcaSdrh   if( pSrc->nSrc!=1 ) return 0;          /* Single term in FROM clause */
2152b74b1017Sdrh   if( pSrc->a[0].pSelect ) return 0;     /* FROM is not a subquery or view */
2153b287f4b6Sdrh   pTab = pSrc->a[0].pTab;
215469c355bdSdrh   assert( pTab!=0 );
2155b74b1017Sdrh   assert( pTab->pSelect==0 );            /* FROM clause is not a view */
2156b287f4b6Sdrh   if( IsVirtual(pTab) ) return 0;        /* FROM clause not a virtual table */
2157b287f4b6Sdrh   pEList = p->pEList;
2158ac6b47d1Sdrh   assert( pEList!=0 );
21597b35a77bSdan   /* All SELECT results must be columns. */
2160cfbb5e82Sdan   for(i=0; i<pEList->nExpr; i++){
2161cfbb5e82Sdan     Expr *pRes = pEList->a[i].pExpr;
2162cfbb5e82Sdan     if( pRes->op!=TK_COLUMN ) return 0;
216369c355bdSdrh     assert( pRes->iTable==pSrc->a[0].iCursor );  /* Not a correlated subquery */
2164cfbb5e82Sdan   }
216569c355bdSdrh   return p;
2166b287f4b6Sdrh }
2167b287f4b6Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
2168b287f4b6Sdrh 
2169f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
21701d8cb21fSdan /*
21714c259e9fSdrh ** Generate code that checks the left-most column of index table iCur to see if
21724c259e9fSdrh ** it contains any NULL entries.  Cause the register at regHasNull to be set
21736be515ebSdrh ** to a non-NULL value if iCur contains no NULLs.  Cause register regHasNull
21746be515ebSdrh ** to be set to NULL if iCur contains one or more NULL values.
21756be515ebSdrh */
21766be515ebSdrh static void sqlite3SetHasNullFlag(Vdbe *v, int iCur, int regHasNull){
2177728e0f91Sdrh   int addr1;
21786be515ebSdrh   sqlite3VdbeAddOp2(v, OP_Integer, 0, regHasNull);
2179728e0f91Sdrh   addr1 = sqlite3VdbeAddOp1(v, OP_Rewind, iCur); VdbeCoverage(v);
21806be515ebSdrh   sqlite3VdbeAddOp3(v, OP_Column, iCur, 0, regHasNull);
21816be515ebSdrh   sqlite3VdbeChangeP5(v, OPFLAG_TYPEOFARG);
21824c259e9fSdrh   VdbeComment((v, "first_entry_in(%d)", iCur));
2183728e0f91Sdrh   sqlite3VdbeJumpHere(v, addr1);
21846be515ebSdrh }
2185f9b2e05cSdan #endif
21866be515ebSdrh 
2187bb53ecb1Sdrh 
2188bb53ecb1Sdrh #ifndef SQLITE_OMIT_SUBQUERY
2189bb53ecb1Sdrh /*
2190bb53ecb1Sdrh ** The argument is an IN operator with a list (not a subquery) on the
2191bb53ecb1Sdrh ** right-hand side.  Return TRUE if that list is constant.
2192bb53ecb1Sdrh */
2193bb53ecb1Sdrh static int sqlite3InRhsIsConstant(Expr *pIn){
2194bb53ecb1Sdrh   Expr *pLHS;
2195bb53ecb1Sdrh   int res;
2196bb53ecb1Sdrh   assert( !ExprHasProperty(pIn, EP_xIsSelect) );
2197bb53ecb1Sdrh   pLHS = pIn->pLeft;
2198bb53ecb1Sdrh   pIn->pLeft = 0;
2199bb53ecb1Sdrh   res = sqlite3ExprIsConstant(pIn);
2200bb53ecb1Sdrh   pIn->pLeft = pLHS;
2201bb53ecb1Sdrh   return res;
2202bb53ecb1Sdrh }
2203bb53ecb1Sdrh #endif
2204bb53ecb1Sdrh 
22056be515ebSdrh /*
22069a96b668Sdanielk1977 ** This function is used by the implementation of the IN (...) operator.
2207d4305ca6Sdrh ** The pX parameter is the expression on the RHS of the IN operator, which
2208d4305ca6Sdrh ** might be either a list of expressions or a subquery.
22099a96b668Sdanielk1977 **
2210d4305ca6Sdrh ** The job of this routine is to find or create a b-tree object that can
2211d4305ca6Sdrh ** be used either to test for membership in the RHS set or to iterate through
2212d4305ca6Sdrh ** all members of the RHS set, skipping duplicates.
2213d4305ca6Sdrh **
22143a85625dSdrh ** A cursor is opened on the b-tree object that is the RHS of the IN operator
2215d4305ca6Sdrh ** and pX->iTable is set to the index of that cursor.
2216d4305ca6Sdrh **
2217b74b1017Sdrh ** The returned value of this function indicates the b-tree type, as follows:
22189a96b668Sdanielk1977 **
22199a96b668Sdanielk1977 **   IN_INDEX_ROWID      - The cursor was opened on a database table.
22201ccce449Sdrh **   IN_INDEX_INDEX_ASC  - The cursor was opened on an ascending index.
22211ccce449Sdrh **   IN_INDEX_INDEX_DESC - The cursor was opened on a descending index.
22229a96b668Sdanielk1977 **   IN_INDEX_EPH        - The cursor was opened on a specially created and
22239a96b668Sdanielk1977 **                         populated epheremal table.
2224bb53ecb1Sdrh **   IN_INDEX_NOOP       - No cursor was allocated.  The IN operator must be
2225bb53ecb1Sdrh **                         implemented as a sequence of comparisons.
22269a96b668Sdanielk1977 **
2227d4305ca6Sdrh ** An existing b-tree might be used if the RHS expression pX is a simple
2228d4305ca6Sdrh ** subquery such as:
22299a96b668Sdanielk1977 **
2230553168c7Sdan **     SELECT <column1>, <column2>... FROM <table>
22319a96b668Sdanielk1977 **
2232d4305ca6Sdrh ** If the RHS of the IN operator is a list or a more complex subquery, then
2233d4305ca6Sdrh ** an ephemeral table might need to be generated from the RHS and then
223460ec914cSpeter.d.reid ** pX->iTable made to point to the ephemeral table instead of an
2235d4305ca6Sdrh ** existing table.
2236d4305ca6Sdrh **
22377fc0ba0fSdrh ** The inFlags parameter must contain, at a minimum, one of the bits
22387fc0ba0fSdrh ** IN_INDEX_MEMBERSHIP or IN_INDEX_LOOP but not both.  If inFlags contains
22397fc0ba0fSdrh ** IN_INDEX_MEMBERSHIP, then the generated table will be used for a fast
22407fc0ba0fSdrh ** membership test.  When the IN_INDEX_LOOP bit is set, the IN index will
22417fc0ba0fSdrh ** be used to loop over all values of the RHS of the IN operator.
22423a85625dSdrh **
22433a85625dSdrh ** When IN_INDEX_LOOP is used (and the b-tree will be used to iterate
22443a85625dSdrh ** through the set members) then the b-tree must not contain duplicates.
22457fc0ba0fSdrh ** An epheremal table will be created unless the selected columns are guaranteed
2246553168c7Sdan ** to be unique - either because it is an INTEGER PRIMARY KEY or due to
2247553168c7Sdan ** a UNIQUE constraint or index.
22480cdc022eSdanielk1977 **
22493a85625dSdrh ** When IN_INDEX_MEMBERSHIP is used (and the b-tree will be used
22503a85625dSdrh ** for fast set membership tests) then an epheremal table must
2251553168c7Sdan ** be used unless <columns> is a single INTEGER PRIMARY KEY column or an
2252553168c7Sdan ** index can be found with the specified <columns> as its left-most.
22530cdc022eSdanielk1977 **
2254bb53ecb1Sdrh ** If the IN_INDEX_NOOP_OK and IN_INDEX_MEMBERSHIP are both set and
2255bb53ecb1Sdrh ** if the RHS of the IN operator is a list (not a subquery) then this
2256bb53ecb1Sdrh ** routine might decide that creating an ephemeral b-tree for membership
2257bb53ecb1Sdrh ** testing is too expensive and return IN_INDEX_NOOP.  In that case, the
2258bb53ecb1Sdrh ** calling routine should implement the IN operator using a sequence
2259bb53ecb1Sdrh ** of Eq or Ne comparison operations.
2260bb53ecb1Sdrh **
2261b74b1017Sdrh ** When the b-tree is being used for membership tests, the calling function
22623a85625dSdrh ** might need to know whether or not the RHS side of the IN operator
2263e21a6e1dSdrh ** contains a NULL.  If prRhsHasNull is not a NULL pointer and
22643a85625dSdrh ** if there is any chance that the (...) might contain a NULL value at
22650cdc022eSdanielk1977 ** runtime, then a register is allocated and the register number written
2266e21a6e1dSdrh ** to *prRhsHasNull. If there is no chance that the (...) contains a
2267e21a6e1dSdrh ** NULL value, then *prRhsHasNull is left unchanged.
22680cdc022eSdanielk1977 **
2269e21a6e1dSdrh ** If a register is allocated and its location stored in *prRhsHasNull, then
22706be515ebSdrh ** the value in that register will be NULL if the b-tree contains one or more
22716be515ebSdrh ** NULL values, and it will be some non-NULL value if the b-tree contains no
22726be515ebSdrh ** NULL values.
2273553168c7Sdan **
2274553168c7Sdan ** If the aiMap parameter is not NULL, it must point to an array containing
2275553168c7Sdan ** one element for each column returned by the SELECT statement on the RHS
2276553168c7Sdan ** of the IN(...) operator. The i'th entry of the array is populated with the
2277553168c7Sdan ** offset of the index column that matches the i'th column returned by the
2278553168c7Sdan ** SELECT. For example, if the expression and selected index are:
2279553168c7Sdan **
2280553168c7Sdan **   (?,?,?) IN (SELECT a, b, c FROM t1)
2281553168c7Sdan **   CREATE INDEX i1 ON t1(b, c, a);
2282553168c7Sdan **
2283553168c7Sdan ** then aiMap[] is populated with {2, 0, 1}.
22849a96b668Sdanielk1977 */
2285284f4acaSdanielk1977 #ifndef SQLITE_OMIT_SUBQUERY
2286ba00e30aSdan int sqlite3FindInIndex(
22876fc8f364Sdrh   Parse *pParse,             /* Parsing context */
22886fc8f364Sdrh   Expr *pX,                  /* The right-hand side (RHS) of the IN operator */
22896fc8f364Sdrh   u32 inFlags,               /* IN_INDEX_LOOP, _MEMBERSHIP, and/or _NOOP_OK */
22906fc8f364Sdrh   int *prRhsHasNull,         /* Register holding NULL status.  See notes */
22916fc8f364Sdrh   int *aiMap                 /* Mapping from Index fields to RHS fields */
2292ba00e30aSdan ){
2293b74b1017Sdrh   Select *p;                            /* SELECT to the right of IN operator */
2294b74b1017Sdrh   int eType = 0;                        /* Type of RHS table. IN_INDEX_* */
2295b74b1017Sdrh   int iTab = pParse->nTab++;            /* Cursor of the RHS table */
22963a85625dSdrh   int mustBeUnique;                     /* True if RHS must be unique */
2297b8475df8Sdrh   Vdbe *v = sqlite3GetVdbe(pParse);     /* Virtual machine being coded */
22989a96b668Sdanielk1977 
22991450bc6eSdrh   assert( pX->op==TK_IN );
23003a85625dSdrh   mustBeUnique = (inFlags & IN_INDEX_LOOP)!=0;
23011450bc6eSdrh 
23027b35a77bSdan   /* If the RHS of this IN(...) operator is a SELECT, and if it matters
23037b35a77bSdan   ** whether or not the SELECT result contains NULL values, check whether
2304870a0705Sdan   ** or not NULL is actually possible (it may not be, for example, due
23057b35a77bSdan   ** to NOT NULL constraints in the schema). If no NULL values are possible,
2306870a0705Sdan   ** set prRhsHasNull to 0 before continuing.  */
23077b35a77bSdan   if( prRhsHasNull && (pX->flags & EP_xIsSelect) ){
23087b35a77bSdan     int i;
23097b35a77bSdan     ExprList *pEList = pX->x.pSelect->pEList;
23107b35a77bSdan     for(i=0; i<pEList->nExpr; i++){
23117b35a77bSdan       if( sqlite3ExprCanBeNull(pEList->a[i].pExpr) ) break;
23127b35a77bSdan     }
23137b35a77bSdan     if( i==pEList->nExpr ){
23147b35a77bSdan       prRhsHasNull = 0;
23157b35a77bSdan     }
23167b35a77bSdan   }
23177b35a77bSdan 
2318b74b1017Sdrh   /* Check to see if an existing table or index can be used to
2319b74b1017Sdrh   ** satisfy the query.  This is preferable to generating a new
23207b35a77bSdan   ** ephemeral table.  */
23217b35a77bSdan   if( pParse->nErr==0 && (p = isCandidateForInOpt(pX))!=0 ){
2322e1fb65a0Sdanielk1977     sqlite3 *db = pParse->db;              /* Database connection */
2323b07028f7Sdrh     Table *pTab;                           /* Table <table>. */
2324ba00e30aSdan     i16 iDb;                               /* Database idx for pTab */
2325cfbb5e82Sdan     ExprList *pEList = p->pEList;
2326cfbb5e82Sdan     int nExpr = pEList->nExpr;
2327e1fb65a0Sdanielk1977 
2328b07028f7Sdrh     assert( p->pEList!=0 );             /* Because of isCandidateForInOpt(p) */
2329b07028f7Sdrh     assert( p->pEList->a[0].pExpr!=0 ); /* Because of isCandidateForInOpt(p) */
2330b07028f7Sdrh     assert( p->pSrc!=0 );               /* Because of isCandidateForInOpt(p) */
2331b07028f7Sdrh     pTab = p->pSrc->a[0].pTab;
2332b07028f7Sdrh 
2333b22f7c83Sdrh     /* Code an OP_Transaction and OP_TableLock for <table>. */
2334e1fb65a0Sdanielk1977     iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
2335e1fb65a0Sdanielk1977     sqlite3CodeVerifySchema(pParse, iDb);
2336e1fb65a0Sdanielk1977     sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
23379a96b668Sdanielk1977 
2338a84a283dSdrh     assert(v);  /* sqlite3GetVdbe() has always been previously called */
2339cfbb5e82Sdan     if( nExpr==1 && pEList->a[0].pExpr->iColumn<0 ){
234062659b2aSdrh       /* The "x IN (SELECT rowid FROM table)" case */
2341511f9e8dSdrh       int iAddr = sqlite3VdbeAddOp0(v, OP_Once);
23427d176105Sdrh       VdbeCoverage(v);
23439a96b668Sdanielk1977 
23449a96b668Sdanielk1977       sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
23459a96b668Sdanielk1977       eType = IN_INDEX_ROWID;
23469a96b668Sdanielk1977 
23479a96b668Sdanielk1977       sqlite3VdbeJumpHere(v, iAddr);
23489a96b668Sdanielk1977     }else{
2349e1fb65a0Sdanielk1977       Index *pIdx;                         /* Iterator variable */
2350cfbb5e82Sdan       int affinity_ok = 1;
2351cfbb5e82Sdan       int i;
2352cfbb5e82Sdan 
2353cfbb5e82Sdan       /* Check that the affinity that will be used to perform each
235462659b2aSdrh       ** comparison is the same as the affinity of each column in table
235562659b2aSdrh       ** on the RHS of the IN operator.  If it not, it is not possible to
235662659b2aSdrh       ** use any index of the RHS table.  */
2357cfbb5e82Sdan       for(i=0; i<nExpr && affinity_ok; i++){
2358fc7f27b9Sdrh         Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2359cfbb5e82Sdan         int iCol = pEList->a[i].pExpr->iColumn;
23600dfa4f6fSdrh         char idxaff = sqlite3TableColumnAffinity(pTab,iCol); /* RHS table */
2361cfbb5e82Sdan         char cmpaff = sqlite3CompareAffinity(pLhs, idxaff);
236262659b2aSdrh         testcase( cmpaff==SQLITE_AFF_BLOB );
236362659b2aSdrh         testcase( cmpaff==SQLITE_AFF_TEXT );
2364cfbb5e82Sdan         switch( cmpaff ){
2365cfbb5e82Sdan           case SQLITE_AFF_BLOB:
2366cfbb5e82Sdan             break;
2367cfbb5e82Sdan           case SQLITE_AFF_TEXT:
236862659b2aSdrh             /* sqlite3CompareAffinity() only returns TEXT if one side or the
236962659b2aSdrh             ** other has no affinity and the other side is TEXT.  Hence,
237062659b2aSdrh             ** the only way for cmpaff to be TEXT is for idxaff to be TEXT
237162659b2aSdrh             ** and for the term on the LHS of the IN to have no affinity. */
237262659b2aSdrh             assert( idxaff==SQLITE_AFF_TEXT );
2373cfbb5e82Sdan             break;
2374cfbb5e82Sdan           default:
2375cfbb5e82Sdan             affinity_ok = sqlite3IsNumericAffinity(idxaff);
2376cfbb5e82Sdan         }
2377cfbb5e82Sdan       }
2378e1fb65a0Sdanielk1977 
2379a84a283dSdrh       if( affinity_ok ){
2380a84a283dSdrh         /* Search for an existing index that will work for this IN operator */
2381a84a283dSdrh         for(pIdx=pTab->pIndex; pIdx && eType==0; pIdx=pIdx->pNext){
2382a84a283dSdrh           Bitmask colUsed;      /* Columns of the index used */
2383a84a283dSdrh           Bitmask mCol;         /* Mask for the current column */
23846fc8f364Sdrh           if( pIdx->nColumn<nExpr ) continue;
2385a84a283dSdrh           /* Maximum nColumn is BMS-2, not BMS-1, so that we can compute
2386a84a283dSdrh           ** BITMASK(nExpr) without overflowing */
2387a84a283dSdrh           testcase( pIdx->nColumn==BMS-2 );
2388a84a283dSdrh           testcase( pIdx->nColumn==BMS-1 );
2389a84a283dSdrh           if( pIdx->nColumn>=BMS-1 ) continue;
23906fc8f364Sdrh           if( mustBeUnique ){
23916fc8f364Sdrh             if( pIdx->nKeyCol>nExpr
23926fc8f364Sdrh              ||(pIdx->nColumn>nExpr && !IsUniqueIndex(pIdx))
23936fc8f364Sdrh             ){
2394a84a283dSdrh               continue;  /* This index is not unique over the IN RHS columns */
2395cfbb5e82Sdan             }
23966fc8f364Sdrh           }
2397cfbb5e82Sdan 
2398a84a283dSdrh           colUsed = 0;   /* Columns of index used so far */
2399cfbb5e82Sdan           for(i=0; i<nExpr; i++){
2400fc7f27b9Sdrh             Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2401cfbb5e82Sdan             Expr *pRhs = pEList->a[i].pExpr;
2402cfbb5e82Sdan             CollSeq *pReq = sqlite3BinaryCompareCollSeq(pParse, pLhs, pRhs);
2403cfbb5e82Sdan             int j;
2404cfbb5e82Sdan 
24056fc8f364Sdrh             assert( pReq!=0 || pRhs->iColumn==XN_ROWID || pParse->nErr );
2406cfbb5e82Sdan             for(j=0; j<nExpr; j++){
2407cfbb5e82Sdan               if( pIdx->aiColumn[j]!=pRhs->iColumn ) continue;
2408cfbb5e82Sdan               assert( pIdx->azColl[j] );
2409106526e1Sdrh               if( pReq!=0 && sqlite3StrICmp(pReq->zName, pIdx->azColl[j])!=0 ){
2410106526e1Sdrh                 continue;
2411106526e1Sdrh               }
2412cfbb5e82Sdan               break;
2413cfbb5e82Sdan             }
2414cfbb5e82Sdan             if( j==nExpr ) break;
2415a84a283dSdrh             mCol = MASKBIT(j);
2416a84a283dSdrh             if( mCol & colUsed ) break; /* Each column used only once */
2417a84a283dSdrh             colUsed |= mCol;
2418ba00e30aSdan             if( aiMap ) aiMap[i] = j;
2419cfbb5e82Sdan           }
2420cfbb5e82Sdan 
2421a84a283dSdrh           assert( i==nExpr || colUsed!=(MASKBIT(nExpr)-1) );
2422a84a283dSdrh           if( colUsed==(MASKBIT(nExpr)-1) ){
2423a84a283dSdrh             /* If we reach this point, that means the index pIdx is usable */
2424511f9e8dSdrh             int iAddr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
2425e2ca99c9Sdrh             ExplainQueryPlan((pParse, 0,
2426e2ca99c9Sdrh                               "USING INDEX %s FOR IN-OPERATOR",pIdx->zName));
24272ec2fb22Sdrh             sqlite3VdbeAddOp3(v, OP_OpenRead, iTab, pIdx->tnum, iDb);
24282ec2fb22Sdrh             sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
2429207872a4Sdanielk1977             VdbeComment((v, "%s", pIdx->zName));
24301ccce449Sdrh             assert( IN_INDEX_INDEX_DESC == IN_INDEX_INDEX_ASC+1 );
24311ccce449Sdrh             eType = IN_INDEX_INDEX_ASC + pIdx->aSortOrder[0];
24329a96b668Sdanielk1977 
24337b35a77bSdan             if( prRhsHasNull ){
24343480bfdaSdan #ifdef SQLITE_ENABLE_COLUMN_USED_MASK
2435cfbb5e82Sdan               i64 mask = (1<<nExpr)-1;
24363480bfdaSdan               sqlite3VdbeAddOp4Dup8(v, OP_ColumnsUsed,
2437cfbb5e82Sdan                   iTab, 0, 0, (u8*)&mask, P4_INT64);
24383480bfdaSdan #endif
2439b80dbdc2Sdrh               *prRhsHasNull = ++pParse->nMem;
24407b35a77bSdan               if( nExpr==1 ){
24416be515ebSdrh                 sqlite3SetHasNullFlag(v, iTab, *prRhsHasNull);
24420cdc022eSdanielk1977               }
24437b35a77bSdan             }
2444552fd454Sdrh             sqlite3VdbeJumpHere(v, iAddr);
24459a96b668Sdanielk1977           }
2446a84a283dSdrh         } /* End loop over indexes */
2447a84a283dSdrh       } /* End if( affinity_ok ) */
2448a84a283dSdrh     } /* End if not an rowid index */
2449a84a283dSdrh   } /* End attempt to optimize using an index */
24509a96b668Sdanielk1977 
2451bb53ecb1Sdrh   /* If no preexisting index is available for the IN clause
2452bb53ecb1Sdrh   ** and IN_INDEX_NOOP is an allowed reply
2453bb53ecb1Sdrh   ** and the RHS of the IN operator is a list, not a subquery
245471c57db0Sdan   ** and the RHS is not constant or has two or fewer terms,
245560ec914cSpeter.d.reid   ** then it is not worth creating an ephemeral table to evaluate
2456bb53ecb1Sdrh   ** the IN operator so return IN_INDEX_NOOP.
2457bb53ecb1Sdrh   */
2458bb53ecb1Sdrh   if( eType==0
2459bb53ecb1Sdrh    && (inFlags & IN_INDEX_NOOP_OK)
2460bb53ecb1Sdrh    && !ExprHasProperty(pX, EP_xIsSelect)
2461bb53ecb1Sdrh    && (!sqlite3InRhsIsConstant(pX) || pX->x.pList->nExpr<=2)
2462bb53ecb1Sdrh   ){
2463bb53ecb1Sdrh     eType = IN_INDEX_NOOP;
2464bb53ecb1Sdrh   }
2465bb53ecb1Sdrh 
24669a96b668Sdanielk1977   if( eType==0 ){
24674387006cSdrh     /* Could not find an existing table or index to use as the RHS b-tree.
2468b74b1017Sdrh     ** We will have to generate an ephemeral table to do the job.
2469b74b1017Sdrh     */
24708e23daf3Sdrh     u32 savedNQueryLoop = pParse->nQueryLoop;
24710cdc022eSdanielk1977     int rMayHaveNull = 0;
247241a05b7bSdanielk1977     eType = IN_INDEX_EPH;
24733a85625dSdrh     if( inFlags & IN_INDEX_LOOP ){
24744a5acf8eSdrh       pParse->nQueryLoop = 0;
2475c5cd1249Sdrh       if( pX->pLeft->iColumn<0 && !ExprHasProperty(pX, EP_xIsSelect) ){
247641a05b7bSdanielk1977         eType = IN_INDEX_ROWID;
24770cdc022eSdanielk1977       }
2478e21a6e1dSdrh     }else if( prRhsHasNull ){
2479e21a6e1dSdrh       *prRhsHasNull = rMayHaveNull = ++pParse->nMem;
2480cf4d38aaSdrh     }
248141a05b7bSdanielk1977     sqlite3CodeSubselect(pParse, pX, rMayHaveNull, eType==IN_INDEX_ROWID);
2482cf4d38aaSdrh     pParse->nQueryLoop = savedNQueryLoop;
24839a96b668Sdanielk1977   }else{
24849a96b668Sdanielk1977     pX->iTable = iTab;
24859a96b668Sdanielk1977   }
2486ba00e30aSdan 
2487ba00e30aSdan   if( aiMap && eType!=IN_INDEX_INDEX_ASC && eType!=IN_INDEX_INDEX_DESC ){
2488ba00e30aSdan     int i, n;
2489ba00e30aSdan     n = sqlite3ExprVectorSize(pX->pLeft);
2490ba00e30aSdan     for(i=0; i<n; i++) aiMap[i] = i;
2491ba00e30aSdan   }
24929a96b668Sdanielk1977   return eType;
24939a96b668Sdanielk1977 }
2494284f4acaSdanielk1977 #endif
2495626a879aSdrh 
2496f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
2497553168c7Sdan /*
2498553168c7Sdan ** Argument pExpr is an (?, ?...) IN(...) expression. This
2499553168c7Sdan ** function allocates and returns a nul-terminated string containing
2500553168c7Sdan ** the affinities to be used for each column of the comparison.
2501553168c7Sdan **
2502553168c7Sdan ** It is the responsibility of the caller to ensure that the returned
2503553168c7Sdan ** string is eventually freed using sqlite3DbFree().
2504553168c7Sdan */
250571c57db0Sdan static char *exprINAffinity(Parse *pParse, Expr *pExpr){
250671c57db0Sdan   Expr *pLeft = pExpr->pLeft;
250771c57db0Sdan   int nVal = sqlite3ExprVectorSize(pLeft);
2508553168c7Sdan   Select *pSelect = (pExpr->flags & EP_xIsSelect) ? pExpr->x.pSelect : 0;
250971c57db0Sdan   char *zRet;
251071c57db0Sdan 
2511553168c7Sdan   assert( pExpr->op==TK_IN );
25125c258dc1Sdrh   zRet = sqlite3DbMallocRaw(pParse->db, nVal+1);
251371c57db0Sdan   if( zRet ){
251471c57db0Sdan     int i;
251571c57db0Sdan     for(i=0; i<nVal; i++){
2516fc7f27b9Sdrh       Expr *pA = sqlite3VectorFieldSubexpr(pLeft, i);
2517553168c7Sdan       char a = sqlite3ExprAffinity(pA);
2518553168c7Sdan       if( pSelect ){
2519553168c7Sdan         zRet[i] = sqlite3CompareAffinity(pSelect->pEList->a[i].pExpr, a);
252071c57db0Sdan       }else{
2521553168c7Sdan         zRet[i] = a;
252271c57db0Sdan       }
252371c57db0Sdan     }
252471c57db0Sdan     zRet[nVal] = '\0';
252571c57db0Sdan   }
252671c57db0Sdan   return zRet;
252771c57db0Sdan }
2528f9b2e05cSdan #endif
252971c57db0Sdan 
25308da209b1Sdan #ifndef SQLITE_OMIT_SUBQUERY
25318da209b1Sdan /*
25328da209b1Sdan ** Load the Parse object passed as the first argument with an error
25338da209b1Sdan ** message of the form:
25348da209b1Sdan **
25358da209b1Sdan **   "sub-select returns N columns - expected M"
25368da209b1Sdan */
25378da209b1Sdan void sqlite3SubselectError(Parse *pParse, int nActual, int nExpect){
25388da209b1Sdan   const char *zFmt = "sub-select returns %d columns - expected %d";
25398da209b1Sdan   sqlite3ErrorMsg(pParse, zFmt, nActual, nExpect);
25408da209b1Sdan }
25418da209b1Sdan #endif
25428da209b1Sdan 
2543626a879aSdrh /*
254444c5604cSdan ** Expression pExpr is a vector that has been used in a context where
254544c5604cSdan ** it is not permitted. If pExpr is a sub-select vector, this routine
254644c5604cSdan ** loads the Parse object with a message of the form:
254744c5604cSdan **
254844c5604cSdan **   "sub-select returns N columns - expected 1"
254944c5604cSdan **
255044c5604cSdan ** Or, if it is a regular scalar vector:
255144c5604cSdan **
255244c5604cSdan **   "row value misused"
255344c5604cSdan */
255444c5604cSdan void sqlite3VectorErrorMsg(Parse *pParse, Expr *pExpr){
255544c5604cSdan #ifndef SQLITE_OMIT_SUBQUERY
255644c5604cSdan   if( pExpr->flags & EP_xIsSelect ){
255744c5604cSdan     sqlite3SubselectError(pParse, pExpr->x.pSelect->pEList->nExpr, 1);
255844c5604cSdan   }else
255944c5604cSdan #endif
256044c5604cSdan   {
256144c5604cSdan     sqlite3ErrorMsg(pParse, "row value misused");
256244c5604cSdan   }
256344c5604cSdan }
256444c5604cSdan 
256544c5604cSdan /*
2566d4187c71Sdrh ** Generate code for scalar subqueries used as a subquery expression, EXISTS,
2567d4187c71Sdrh ** or IN operators.  Examples:
2568626a879aSdrh **
25699cbe6352Sdrh **     (SELECT a FROM b)          -- subquery
25709cbe6352Sdrh **     EXISTS (SELECT a FROM b)   -- EXISTS subquery
25719cbe6352Sdrh **     x IN (4,5,11)              -- IN operator with list on right-hand side
25729cbe6352Sdrh **     x IN (SELECT a FROM b)     -- IN operator with subquery on the right
2573fef5208cSdrh **
25749cbe6352Sdrh ** The pExpr parameter describes the expression that contains the IN
25759cbe6352Sdrh ** operator or subquery.
257641a05b7bSdanielk1977 **
257741a05b7bSdanielk1977 ** If parameter isRowid is non-zero, then expression pExpr is guaranteed
257841a05b7bSdanielk1977 ** to be of the form "<rowid> IN (?, ?, ?)", where <rowid> is a reference
257941a05b7bSdanielk1977 ** to some integer key column of a table B-Tree. In this case, use an
258041a05b7bSdanielk1977 ** intkey B-Tree to store the set of IN(...) values instead of the usual
258141a05b7bSdanielk1977 ** (slower) variable length keys B-Tree.
2582fd773cf9Sdrh **
2583fd773cf9Sdrh ** If rMayHaveNull is non-zero, that means that the operation is an IN
2584fd773cf9Sdrh ** (not a SELECT or EXISTS) and that the RHS might contains NULLs.
25853a85625dSdrh ** All this routine does is initialize the register given by rMayHaveNull
25863a85625dSdrh ** to NULL.  Calling routines will take care of changing this register
25873a85625dSdrh ** value to non-NULL if the RHS is NULL-free.
25881450bc6eSdrh **
25891450bc6eSdrh ** For a SELECT or EXISTS operator, return the register that holds the
259039a11819Sdrh ** result.  For a multi-column SELECT, the result is stored in a contiguous
259139a11819Sdrh ** array of registers and the return value is the register of the left-most
259239a11819Sdrh ** result column.  Return 0 for IN operators or if an error occurs.
2593cce7d176Sdrh */
259451522cd3Sdrh #ifndef SQLITE_OMIT_SUBQUERY
25951450bc6eSdrh int sqlite3CodeSubselect(
2596fd773cf9Sdrh   Parse *pParse,          /* Parsing context */
2597fd773cf9Sdrh   Expr *pExpr,            /* The IN, SELECT, or EXISTS operator */
25986be515ebSdrh   int rHasNullFlag,       /* Register that records whether NULLs exist in RHS */
2599fd773cf9Sdrh   int isRowid             /* If true, LHS of IN operator is a rowid */
260041a05b7bSdanielk1977 ){
26016be515ebSdrh   int jmpIfDynamic = -1;                      /* One-time test address */
26021450bc6eSdrh   int rReg = 0;                           /* Register storing resulting */
2603b3bce662Sdanielk1977   Vdbe *v = sqlite3GetVdbe(pParse);
26041450bc6eSdrh   if( NEVER(v==0) ) return 0;
2605ceea3321Sdrh   sqlite3ExprCachePush(pParse);
2606fc976065Sdanielk1977 
260739a11819Sdrh   /* The evaluation of the IN/EXISTS/SELECT must be repeated every time it
260839a11819Sdrh   ** is encountered if any of the following is true:
260957dbd7b3Sdrh   **
261057dbd7b3Sdrh   **    *  The right-hand side is a correlated subquery
261157dbd7b3Sdrh   **    *  The right-hand side is an expression list containing variables
261257dbd7b3Sdrh   **    *  We are inside a trigger
261357dbd7b3Sdrh   **
261457dbd7b3Sdrh   ** If all of the above are false, then we can run this code just once
261557dbd7b3Sdrh   ** save the results, and reuse the same result on subsequent invocations.
2616b3bce662Sdanielk1977   */
2617c5cd1249Sdrh   if( !ExprHasProperty(pExpr, EP_VarSelect) ){
2618511f9e8dSdrh     jmpIfDynamic = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
2619b3bce662Sdanielk1977   }
2620b3bce662Sdanielk1977 
2621cce7d176Sdrh   switch( pExpr->op ){
2622fef5208cSdrh     case TK_IN: {
2623b9bb7c18Sdrh       int addr;                   /* Address of OP_OpenEphemeral instruction */
2624d4187c71Sdrh       Expr *pLeft = pExpr->pLeft; /* the LHS of the IN operator */
2625323df790Sdrh       KeyInfo *pKeyInfo = 0;      /* Key information */
262671c57db0Sdan       int nVal;                   /* Size of vector pLeft */
2627d3d39e93Sdrh 
262871c57db0Sdan       nVal = sqlite3ExprVectorSize(pLeft);
2629553168c7Sdan       assert( !isRowid || nVal==1 );
2630e014a838Sdanielk1977 
2631e014a838Sdanielk1977       /* Whether this is an 'x IN(SELECT...)' or an 'x IN(<exprlist>)'
26328cff69dfSdrh       ** expression it is handled the same way.  An ephemeral table is
2633553168c7Sdan       ** filled with index keys representing the results from the
2634553168c7Sdan       ** SELECT or the <exprlist>.
2635fef5208cSdrh       **
2636e014a838Sdanielk1977       ** If the 'x' expression is a column value, or the SELECT...
2637e014a838Sdanielk1977       ** statement returns a column value, then the affinity of that
2638e014a838Sdanielk1977       ** column is used to build the index keys. If both 'x' and the
2639e014a838Sdanielk1977       ** SELECT... statement are columns, then numeric affinity is used
2640e014a838Sdanielk1977       ** if either column has NUMERIC or INTEGER affinity. If neither
2641e014a838Sdanielk1977       ** 'x' nor the SELECT... statement are columns, then numeric affinity
2642e014a838Sdanielk1977       ** is used.
2643fef5208cSdrh       */
2644832508b7Sdrh       pExpr->iTable = pParse->nTab++;
264571c57db0Sdan       addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral,
264671c57db0Sdan           pExpr->iTable, (isRowid?0:nVal));
264771c57db0Sdan       pKeyInfo = isRowid ? 0 : sqlite3KeyInfoAlloc(pParse->db, nVal, 1);
2648e014a838Sdanielk1977 
26496ab3a2ecSdanielk1977       if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2650e014a838Sdanielk1977         /* Case 1:     expr IN (SELECT ...)
2651e014a838Sdanielk1977         **
2652e014a838Sdanielk1977         ** Generate code to write the results of the select into the temporary
2653e014a838Sdanielk1977         ** table allocated and opened above.
2654e014a838Sdanielk1977         */
26554387006cSdrh         Select *pSelect = pExpr->x.pSelect;
265671c57db0Sdan         ExprList *pEList = pSelect->pEList;
26571013c932Sdrh 
2658e2ca99c9Sdrh         ExplainQueryPlan((pParse, 1, "%sLIST SUBQUERY",
2659e2ca99c9Sdrh             jmpIfDynamic>=0?"":"CORRELATED "
2660e2ca99c9Sdrh         ));
266141a05b7bSdanielk1977         assert( !isRowid );
266264bcb8cfSdrh         /* If the LHS and RHS of the IN operator do not match, that
266364bcb8cfSdrh         ** error will have been caught long before we reach this point. */
266464bcb8cfSdrh         if( ALWAYS(pEList->nExpr==nVal) ){
266571c57db0Sdan           SelectDest dest;
266671c57db0Sdan           int i;
26671013c932Sdrh           sqlite3SelectDestInit(&dest, SRT_Set, pExpr->iTable);
266871c57db0Sdan           dest.zAffSdst = exprINAffinity(pParse, pExpr);
26694387006cSdrh           pSelect->iLimit = 0;
26704387006cSdrh           testcase( pSelect->selFlags & SF_Distinct );
2671812ea833Sdrh           testcase( pKeyInfo==0 ); /* Caused by OOM in sqlite3KeyInfoAlloc() */
26724387006cSdrh           if( sqlite3Select(pParse, pSelect, &dest) ){
267371c57db0Sdan             sqlite3DbFree(pParse->db, dest.zAffSdst);
26742ec2fb22Sdrh             sqlite3KeyInfoUnref(pKeyInfo);
26751450bc6eSdrh             return 0;
267694ccde58Sdrh           }
267771c57db0Sdan           sqlite3DbFree(pParse->db, dest.zAffSdst);
2678812ea833Sdrh           assert( pKeyInfo!=0 ); /* OOM will cause exit after sqlite3Select() */
26793535ec3eSdrh           assert( pEList!=0 );
26803535ec3eSdrh           assert( pEList->nExpr>0 );
26812ec2fb22Sdrh           assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
268271c57db0Sdan           for(i=0; i<nVal; i++){
2683773d3afaSdan             Expr *p = sqlite3VectorFieldSubexpr(pLeft, i);
268471c57db0Sdan             pKeyInfo->aColl[i] = sqlite3BinaryCompareCollSeq(
268571c57db0Sdan                 pParse, p, pEList->a[i].pExpr
268671c57db0Sdan             );
268771c57db0Sdan           }
268871c57db0Sdan         }
2689a7d2db17Sdrh       }else if( ALWAYS(pExpr->x.pList!=0) ){
2690fef5208cSdrh         /* Case 2:     expr IN (exprlist)
2691fef5208cSdrh         **
2692e014a838Sdanielk1977         ** For each expression, build an index key from the evaluation and
2693e014a838Sdanielk1977         ** store it in the temporary table. If <expr> is a column, then use
2694e014a838Sdanielk1977         ** that columns affinity when building index keys. If <expr> is not
2695e014a838Sdanielk1977         ** a column, use numeric affinity.
2696fef5208cSdrh         */
269771c57db0Sdan         char affinity;            /* Affinity of the LHS of the IN */
2698e014a838Sdanielk1977         int i;
26996ab3a2ecSdanielk1977         ExprList *pList = pExpr->x.pList;
270057dbd7b3Sdrh         struct ExprList_item *pItem;
2701ecc31805Sdrh         int r1, r2, r3;
270271c57db0Sdan         affinity = sqlite3ExprAffinity(pLeft);
2703e014a838Sdanielk1977         if( !affinity ){
270405883a34Sdrh           affinity = SQLITE_AFF_BLOB;
2705e014a838Sdanielk1977         }
2706323df790Sdrh         if( pKeyInfo ){
27072ec2fb22Sdrh           assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
2708323df790Sdrh           pKeyInfo->aColl[0] = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
2709323df790Sdrh         }
2710e014a838Sdanielk1977 
2711e014a838Sdanielk1977         /* Loop through each expression in <exprlist>. */
27122d401ab8Sdrh         r1 = sqlite3GetTempReg(pParse);
27132d401ab8Sdrh         r2 = sqlite3GetTempReg(pParse);
271421cd29abSdan         if( isRowid ) sqlite3VdbeAddOp4(v, OP_Blob, 0, r2, 0, "", P4_STATIC);
271557dbd7b3Sdrh         for(i=pList->nExpr, pItem=pList->a; i>0; i--, pItem++){
271657dbd7b3Sdrh           Expr *pE2 = pItem->pExpr;
2717e05c929bSdrh           int iValToIns;
2718e014a838Sdanielk1977 
271957dbd7b3Sdrh           /* If the expression is not constant then we will need to
272057dbd7b3Sdrh           ** disable the test that was generated above that makes sure
272157dbd7b3Sdrh           ** this code only executes once.  Because for a non-constant
272257dbd7b3Sdrh           ** expression we need to rerun this code each time.
272357dbd7b3Sdrh           */
27246be515ebSdrh           if( jmpIfDynamic>=0 && !sqlite3ExprIsConstant(pE2) ){
27256be515ebSdrh             sqlite3VdbeChangeToNoop(v, jmpIfDynamic);
27266be515ebSdrh             jmpIfDynamic = -1;
27274794b980Sdrh           }
2728e014a838Sdanielk1977 
2729e014a838Sdanielk1977           /* Evaluate the expression and insert it into the temp table */
2730e05c929bSdrh           if( isRowid && sqlite3ExprIsInteger(pE2, &iValToIns) ){
2731e05c929bSdrh             sqlite3VdbeAddOp3(v, OP_InsertInt, pExpr->iTable, r2, iValToIns);
2732e05c929bSdrh           }else{
2733ecc31805Sdrh             r3 = sqlite3ExprCodeTarget(pParse, pE2, r1);
273441a05b7bSdanielk1977             if( isRowid ){
2735e05c929bSdrh               sqlite3VdbeAddOp2(v, OP_MustBeInt, r3,
2736e05c929bSdrh                                 sqlite3VdbeCurrentAddr(v)+2);
2737688852abSdrh               VdbeCoverage(v);
273841a05b7bSdanielk1977               sqlite3VdbeAddOp3(v, OP_Insert, pExpr->iTable, r2, r3);
273941a05b7bSdanielk1977             }else{
2740ecc31805Sdrh               sqlite3VdbeAddOp4(v, OP_MakeRecord, r3, 1, r2, &affinity, 1);
27413c31fc23Sdrh               sqlite3ExprCacheAffinityChange(pParse, r3, 1);
27429b4eaebcSdrh               sqlite3VdbeAddOp4Int(v, OP_IdxInsert, pExpr->iTable, r2, r3, 1);
2743fef5208cSdrh             }
274441a05b7bSdanielk1977           }
2745e05c929bSdrh         }
27462d401ab8Sdrh         sqlite3ReleaseTempReg(pParse, r1);
27472d401ab8Sdrh         sqlite3ReleaseTempReg(pParse, r2);
2748fef5208cSdrh       }
2749323df790Sdrh       if( pKeyInfo ){
27502ec2fb22Sdrh         sqlite3VdbeChangeP4(v, addr, (void *)pKeyInfo, P4_KEYINFO);
275141a05b7bSdanielk1977       }
2752b3bce662Sdanielk1977       break;
2753fef5208cSdrh     }
2754fef5208cSdrh 
275551522cd3Sdrh     case TK_EXISTS:
2756fd773cf9Sdrh     case TK_SELECT:
2757fd773cf9Sdrh     default: {
275839a11819Sdrh       /* Case 3:    (SELECT ... FROM ...)
275939a11819Sdrh       **     or:    EXISTS(SELECT ... FROM ...)
276039a11819Sdrh       **
276139a11819Sdrh       ** For a SELECT, generate code to put the values for all columns of
276239a11819Sdrh       ** the first row into an array of registers and return the index of
276339a11819Sdrh       ** the first register.
276439a11819Sdrh       **
276539a11819Sdrh       ** If this is an EXISTS, write an integer 0 (not exists) or 1 (exists)
276639a11819Sdrh       ** into a register and return that register number.
276739a11819Sdrh       **
276839a11819Sdrh       ** In both cases, the query is augmented with "LIMIT 1".  Any
276939a11819Sdrh       ** preexisting limit is discarded in place of the new LIMIT 1.
2770fef5208cSdrh       */
2771fd773cf9Sdrh       Select *pSel;                         /* SELECT statement to encode */
277239a11819Sdrh       SelectDest dest;                      /* How to deal with SELECT result */
277371c57db0Sdan       int nReg;                             /* Registers to allocate */
27748c0833fbSdrh       Expr *pLimit;                         /* New limit expression */
27751398ad36Sdrh 
2776cf697396Sshane       testcase( pExpr->op==TK_EXISTS );
2777cf697396Sshane       testcase( pExpr->op==TK_SELECT );
2778cf697396Sshane       assert( pExpr->op==TK_EXISTS || pExpr->op==TK_SELECT );
27796ab3a2ecSdanielk1977       assert( ExprHasProperty(pExpr, EP_xIsSelect) );
278071c57db0Sdan 
27816ab3a2ecSdanielk1977       pSel = pExpr->x.pSelect;
2782e2ca99c9Sdrh       ExplainQueryPlan((pParse, 1, "%sSCALAR SUBQUERY",
2783e2ca99c9Sdrh             jmpIfDynamic>=0?"":"CORRELATED "));
278471c57db0Sdan       nReg = pExpr->op==TK_SELECT ? pSel->pEList->nExpr : 1;
278571c57db0Sdan       sqlite3SelectDestInit(&dest, 0, pParse->nMem+1);
278671c57db0Sdan       pParse->nMem += nReg;
278751522cd3Sdrh       if( pExpr->op==TK_SELECT ){
27886c8c8ce0Sdanielk1977         dest.eDest = SRT_Mem;
278953932ce8Sdrh         dest.iSdst = dest.iSDParm;
279071c57db0Sdan         dest.nSdst = nReg;
279171c57db0Sdan         sqlite3VdbeAddOp3(v, OP_Null, 0, dest.iSDParm, dest.iSDParm+nReg-1);
2792d4e70ebdSdrh         VdbeComment((v, "Init subquery result"));
279351522cd3Sdrh       }else{
27946c8c8ce0Sdanielk1977         dest.eDest = SRT_Exists;
27952b596da8Sdrh         sqlite3VdbeAddOp2(v, OP_Integer, 0, dest.iSDParm);
2796d4e70ebdSdrh         VdbeComment((v, "Init EXISTS result"));
279751522cd3Sdrh       }
27988c0833fbSdrh       pLimit = sqlite3ExprAlloc(pParse->db, TK_INTEGER,&sqlite3IntTokens[1], 0);
27998c0833fbSdrh       if( pSel->pLimit ){
28008c0833fbSdrh         sqlite3ExprDelete(pParse->db, pSel->pLimit->pLeft);
28018c0833fbSdrh         pSel->pLimit->pLeft = pLimit;
28028c0833fbSdrh       }else{
28038c0833fbSdrh         pSel->pLimit = sqlite3PExpr(pParse, TK_LIMIT, pLimit, 0);
28048c0833fbSdrh       }
280548b5b041Sdrh       pSel->iLimit = 0;
28067d10d5a6Sdrh       if( sqlite3Select(pParse, pSel, &dest) ){
28071450bc6eSdrh         return 0;
280894ccde58Sdrh       }
28092b596da8Sdrh       rReg = dest.iSDParm;
2810ebb6a65dSdrh       ExprSetVVAProperty(pExpr, EP_NoReduce);
2811b3bce662Sdanielk1977       break;
281219a775c2Sdrh     }
2813cce7d176Sdrh   }
2814b3bce662Sdanielk1977 
28156be515ebSdrh   if( rHasNullFlag ){
28166be515ebSdrh     sqlite3SetHasNullFlag(v, pExpr->iTable, rHasNullFlag);
2817b3bce662Sdanielk1977   }
28186be515ebSdrh 
28196be515ebSdrh   if( jmpIfDynamic>=0 ){
28206be515ebSdrh     sqlite3VdbeJumpHere(v, jmpIfDynamic);
2821b3bce662Sdanielk1977   }
2822d2490904Sdrh   sqlite3ExprCachePop(pParse);
2823fc976065Sdanielk1977 
28241450bc6eSdrh   return rReg;
2825cce7d176Sdrh }
282651522cd3Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
2827cce7d176Sdrh 
2828e3365e6cSdrh #ifndef SQLITE_OMIT_SUBQUERY
2829e3365e6cSdrh /*
28307b35a77bSdan ** Expr pIn is an IN(...) expression. This function checks that the
28317b35a77bSdan ** sub-select on the RHS of the IN() operator has the same number of
28327b35a77bSdan ** columns as the vector on the LHS. Or, if the RHS of the IN() is not
28337b35a77bSdan ** a sub-query, that the LHS is a vector of size 1.
28347b35a77bSdan */
28357b35a77bSdan int sqlite3ExprCheckIN(Parse *pParse, Expr *pIn){
28367b35a77bSdan   int nVector = sqlite3ExprVectorSize(pIn->pLeft);
28377b35a77bSdan   if( (pIn->flags & EP_xIsSelect) ){
28387b35a77bSdan     if( nVector!=pIn->x.pSelect->pEList->nExpr ){
28397b35a77bSdan       sqlite3SubselectError(pParse, pIn->x.pSelect->pEList->nExpr, nVector);
28407b35a77bSdan       return 1;
28417b35a77bSdan     }
28427b35a77bSdan   }else if( nVector!=1 ){
284344c5604cSdan     sqlite3VectorErrorMsg(pParse, pIn->pLeft);
28447b35a77bSdan     return 1;
28457b35a77bSdan   }
28467b35a77bSdan   return 0;
28477b35a77bSdan }
28487b35a77bSdan #endif
28497b35a77bSdan 
28507b35a77bSdan #ifndef SQLITE_OMIT_SUBQUERY
28517b35a77bSdan /*
2852e3365e6cSdrh ** Generate code for an IN expression.
2853e3365e6cSdrh **
2854e3365e6cSdrh **      x IN (SELECT ...)
2855e3365e6cSdrh **      x IN (value, value, ...)
2856e3365e6cSdrh **
2857ecb87ac8Sdrh ** The left-hand side (LHS) is a scalar or vector expression.  The
2858e347d3e8Sdrh ** right-hand side (RHS) is an array of zero or more scalar values, or a
2859e347d3e8Sdrh ** subquery.  If the RHS is a subquery, the number of result columns must
2860e347d3e8Sdrh ** match the number of columns in the vector on the LHS.  If the RHS is
2861e347d3e8Sdrh ** a list of values, the LHS must be a scalar.
2862e347d3e8Sdrh **
2863e347d3e8Sdrh ** The IN operator is true if the LHS value is contained within the RHS.
2864e347d3e8Sdrh ** The result is false if the LHS is definitely not in the RHS.  The
2865e347d3e8Sdrh ** result is NULL if the presence of the LHS in the RHS cannot be
2866e347d3e8Sdrh ** determined due to NULLs.
2867e3365e6cSdrh **
28686be515ebSdrh ** This routine generates code that jumps to destIfFalse if the LHS is not
2869e3365e6cSdrh ** contained within the RHS.  If due to NULLs we cannot determine if the LHS
2870e3365e6cSdrh ** is contained in the RHS then jump to destIfNull.  If the LHS is contained
2871e3365e6cSdrh ** within the RHS then fall through.
2872ecb87ac8Sdrh **
2873ecb87ac8Sdrh ** See the separate in-operator.md documentation file in the canonical
2874ecb87ac8Sdrh ** SQLite source tree for additional information.
2875e3365e6cSdrh */
2876e3365e6cSdrh static void sqlite3ExprCodeIN(
2877e3365e6cSdrh   Parse *pParse,        /* Parsing and code generating context */
2878e3365e6cSdrh   Expr *pExpr,          /* The IN expression */
2879e3365e6cSdrh   int destIfFalse,      /* Jump here if LHS is not contained in the RHS */
2880e3365e6cSdrh   int destIfNull        /* Jump here if the results are unknown due to NULLs */
2881e3365e6cSdrh ){
2882e3365e6cSdrh   int rRhsHasNull = 0;  /* Register that is true if RHS contains NULL values */
2883e3365e6cSdrh   int eType;            /* Type of the RHS */
2884e347d3e8Sdrh   int rLhs;             /* Register(s) holding the LHS values */
2885e347d3e8Sdrh   int rLhsOrig;         /* LHS values prior to reordering by aiMap[] */
2886e3365e6cSdrh   Vdbe *v;              /* Statement under construction */
2887ba00e30aSdan   int *aiMap = 0;       /* Map from vector field to index column */
2888ba00e30aSdan   char *zAff = 0;       /* Affinity string for comparisons */
2889ecb87ac8Sdrh   int nVector;          /* Size of vectors for this IN operator */
289012abf408Sdrh   int iDummy;           /* Dummy parameter to exprCodeVector() */
2891e347d3e8Sdrh   Expr *pLeft;          /* The LHS of the IN operator */
2892ecb87ac8Sdrh   int i;                /* loop counter */
2893e347d3e8Sdrh   int destStep2;        /* Where to jump when NULLs seen in step 2 */
2894e347d3e8Sdrh   int destStep6 = 0;    /* Start of code for Step 6 */
2895e347d3e8Sdrh   int addrTruthOp;      /* Address of opcode that determines the IN is true */
2896e347d3e8Sdrh   int destNotNull;      /* Jump here if a comparison is not true in step 6 */
2897e347d3e8Sdrh   int addrTop;          /* Top of the step-6 loop */
2898e3365e6cSdrh 
2899e347d3e8Sdrh   pLeft = pExpr->pLeft;
29007b35a77bSdan   if( sqlite3ExprCheckIN(pParse, pExpr) ) return;
2901553168c7Sdan   zAff = exprINAffinity(pParse, pExpr);
2902ba00e30aSdan   nVector = sqlite3ExprVectorSize(pExpr->pLeft);
2903ba00e30aSdan   aiMap = (int*)sqlite3DbMallocZero(
2904ba00e30aSdan       pParse->db, nVector*(sizeof(int) + sizeof(char)) + 1
2905ba00e30aSdan   );
2906e347d3e8Sdrh   if( pParse->db->mallocFailed ) goto sqlite3ExprCodeIN_oom_error;
29077b35a77bSdan 
2908ba00e30aSdan   /* Attempt to compute the RHS. After this step, if anything other than
2909ba00e30aSdan   ** IN_INDEX_NOOP is returned, the table opened ith cursor pExpr->iTable
2910ba00e30aSdan   ** contains the values that make up the RHS. If IN_INDEX_NOOP is returned,
2911ba00e30aSdan   ** the RHS has not yet been coded.  */
2912e3365e6cSdrh   v = pParse->pVdbe;
2913e3365e6cSdrh   assert( v!=0 );       /* OOM detected prior to this routine */
2914e3365e6cSdrh   VdbeNoopComment((v, "begin IN expr"));
2915bb53ecb1Sdrh   eType = sqlite3FindInIndex(pParse, pExpr,
2916bb53ecb1Sdrh                              IN_INDEX_MEMBERSHIP | IN_INDEX_NOOP_OK,
2917ba00e30aSdan                              destIfFalse==destIfNull ? 0 : &rRhsHasNull, aiMap);
2918e3365e6cSdrh 
2919ba00e30aSdan   assert( pParse->nErr || nVector==1 || eType==IN_INDEX_EPH
2920ba00e30aSdan        || eType==IN_INDEX_INDEX_ASC || eType==IN_INDEX_INDEX_DESC
2921ba00e30aSdan   );
2922ecb87ac8Sdrh #ifdef SQLITE_DEBUG
2923ecb87ac8Sdrh   /* Confirm that aiMap[] contains nVector integer values between 0 and
2924ecb87ac8Sdrh   ** nVector-1. */
2925ecb87ac8Sdrh   for(i=0; i<nVector; i++){
2926ecb87ac8Sdrh     int j, cnt;
2927ecb87ac8Sdrh     for(cnt=j=0; j<nVector; j++) if( aiMap[j]==i ) cnt++;
2928ecb87ac8Sdrh     assert( cnt==1 );
2929ecb87ac8Sdrh   }
2930ecb87ac8Sdrh #endif
2931e3365e6cSdrh 
2932ba00e30aSdan   /* Code the LHS, the <expr> from "<expr> IN (...)". If the LHS is a
2933ba00e30aSdan   ** vector, then it is stored in an array of nVector registers starting
2934ba00e30aSdan   ** at r1.
2935e347d3e8Sdrh   **
2936e347d3e8Sdrh   ** sqlite3FindInIndex() might have reordered the fields of the LHS vector
2937e347d3e8Sdrh   ** so that the fields are in the same order as an existing index.   The
2938e347d3e8Sdrh   ** aiMap[] array contains a mapping from the original LHS field order to
2939e347d3e8Sdrh   ** the field order that matches the RHS index.
2940e3365e6cSdrh   */
2941e3365e6cSdrh   sqlite3ExprCachePush(pParse);
2942e347d3e8Sdrh   rLhsOrig = exprCodeVector(pParse, pLeft, &iDummy);
2943e347d3e8Sdrh   for(i=0; i<nVector && aiMap[i]==i; i++){} /* Are LHS fields reordered? */
2944ecb87ac8Sdrh   if( i==nVector ){
2945e347d3e8Sdrh     /* LHS fields are not reordered */
2946e347d3e8Sdrh     rLhs = rLhsOrig;
2947ecb87ac8Sdrh   }else{
2948ecb87ac8Sdrh     /* Need to reorder the LHS fields according to aiMap */
2949e347d3e8Sdrh     rLhs = sqlite3GetTempRange(pParse, nVector);
2950ba00e30aSdan     for(i=0; i<nVector; i++){
2951e347d3e8Sdrh       sqlite3VdbeAddOp3(v, OP_Copy, rLhsOrig+i, rLhs+aiMap[i], 0);
2952ba00e30aSdan     }
2953ecb87ac8Sdrh   }
2954e3365e6cSdrh 
2955bb53ecb1Sdrh   /* If sqlite3FindInIndex() did not find or create an index that is
2956bb53ecb1Sdrh   ** suitable for evaluating the IN operator, then evaluate using a
2957bb53ecb1Sdrh   ** sequence of comparisons.
2958e347d3e8Sdrh   **
2959e347d3e8Sdrh   ** This is step (1) in the in-operator.md optimized algorithm.
2960bb53ecb1Sdrh   */
2961bb53ecb1Sdrh   if( eType==IN_INDEX_NOOP ){
2962bb53ecb1Sdrh     ExprList *pList = pExpr->x.pList;
2963bb53ecb1Sdrh     CollSeq *pColl = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
2964bb53ecb1Sdrh     int labelOk = sqlite3VdbeMakeLabel(v);
2965bb53ecb1Sdrh     int r2, regToFree;
2966bb53ecb1Sdrh     int regCkNull = 0;
2967bb53ecb1Sdrh     int ii;
2968bb53ecb1Sdrh     assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
2969bb53ecb1Sdrh     if( destIfNull!=destIfFalse ){
2970bb53ecb1Sdrh       regCkNull = sqlite3GetTempReg(pParse);
2971e347d3e8Sdrh       sqlite3VdbeAddOp3(v, OP_BitAnd, rLhs, rLhs, regCkNull);
2972bb53ecb1Sdrh     }
2973bb53ecb1Sdrh     for(ii=0; ii<pList->nExpr; ii++){
2974bb53ecb1Sdrh       r2 = sqlite3ExprCodeTemp(pParse, pList->a[ii].pExpr, &regToFree);
2975a976979bSdrh       if( regCkNull && sqlite3ExprCanBeNull(pList->a[ii].pExpr) ){
2976bb53ecb1Sdrh         sqlite3VdbeAddOp3(v, OP_BitAnd, regCkNull, r2, regCkNull);
2977bb53ecb1Sdrh       }
2978bb53ecb1Sdrh       if( ii<pList->nExpr-1 || destIfNull!=destIfFalse ){
2979e347d3e8Sdrh         sqlite3VdbeAddOp4(v, OP_Eq, rLhs, labelOk, r2,
29804336b0e6Sdrh                           (void*)pColl, P4_COLLSEQ);
29814336b0e6Sdrh         VdbeCoverageIf(v, ii<pList->nExpr-1);
29824336b0e6Sdrh         VdbeCoverageIf(v, ii==pList->nExpr-1);
2983ba00e30aSdan         sqlite3VdbeChangeP5(v, zAff[0]);
2984bb53ecb1Sdrh       }else{
2985bb53ecb1Sdrh         assert( destIfNull==destIfFalse );
2986e347d3e8Sdrh         sqlite3VdbeAddOp4(v, OP_Ne, rLhs, destIfFalse, r2,
2987bb53ecb1Sdrh                           (void*)pColl, P4_COLLSEQ); VdbeCoverage(v);
2988ba00e30aSdan         sqlite3VdbeChangeP5(v, zAff[0] | SQLITE_JUMPIFNULL);
2989bb53ecb1Sdrh       }
2990bb53ecb1Sdrh       sqlite3ReleaseTempReg(pParse, regToFree);
2991bb53ecb1Sdrh     }
2992bb53ecb1Sdrh     if( regCkNull ){
2993bb53ecb1Sdrh       sqlite3VdbeAddOp2(v, OP_IsNull, regCkNull, destIfNull); VdbeCoverage(v);
2994076e85f5Sdrh       sqlite3VdbeGoto(v, destIfFalse);
2995bb53ecb1Sdrh     }
2996bb53ecb1Sdrh     sqlite3VdbeResolveLabel(v, labelOk);
2997bb53ecb1Sdrh     sqlite3ReleaseTempReg(pParse, regCkNull);
2998e347d3e8Sdrh     goto sqlite3ExprCodeIN_finished;
2999e347d3e8Sdrh   }
3000bb53ecb1Sdrh 
3001e347d3e8Sdrh   /* Step 2: Check to see if the LHS contains any NULL columns.  If the
3002e347d3e8Sdrh   ** LHS does contain NULLs then the result must be either FALSE or NULL.
3003e347d3e8Sdrh   ** We will then skip the binary search of the RHS.
3004e347d3e8Sdrh   */
3005094430ebSdrh   if( destIfNull==destIfFalse ){
3006e347d3e8Sdrh     destStep2 = destIfFalse;
3007e347d3e8Sdrh   }else{
3008e347d3e8Sdrh     destStep2 = destStep6 = sqlite3VdbeMakeLabel(v);
3009e347d3e8Sdrh   }
3010d49fd4e8Sdan   for(i=0; i<nVector; i++){
3011fc7f27b9Sdrh     Expr *p = sqlite3VectorFieldSubexpr(pExpr->pLeft, i);
3012d49fd4e8Sdan     if( sqlite3ExprCanBeNull(p) ){
3013e347d3e8Sdrh       sqlite3VdbeAddOp2(v, OP_IsNull, rLhs+i, destStep2);
3014471b4b92Sdrh       VdbeCoverage(v);
3015d49fd4e8Sdan     }
3016d49fd4e8Sdan   }
3017e3365e6cSdrh 
3018e347d3e8Sdrh   /* Step 3.  The LHS is now known to be non-NULL.  Do the binary search
3019e347d3e8Sdrh   ** of the RHS using the LHS as a probe.  If found, the result is
3020e347d3e8Sdrh   ** true.
3021e347d3e8Sdrh   */
3022e3365e6cSdrh   if( eType==IN_INDEX_ROWID ){
3023e347d3e8Sdrh     /* In this case, the RHS is the ROWID of table b-tree and so we also
3024e347d3e8Sdrh     ** know that the RHS is non-NULL.  Hence, we combine steps 3 and 4
3025e347d3e8Sdrh     ** into a single opcode. */
3026e347d3e8Sdrh     sqlite3VdbeAddOp3(v, OP_SeekRowid, pExpr->iTable, destIfFalse, rLhs);
3027688852abSdrh     VdbeCoverage(v);
3028e347d3e8Sdrh     addrTruthOp = sqlite3VdbeAddOp0(v, OP_Goto);  /* Return True */
30297b35a77bSdan   }else{
3030e347d3e8Sdrh     sqlite3VdbeAddOp4(v, OP_Affinity, rLhs, nVector, 0, zAff, nVector);
3031e347d3e8Sdrh     if( destIfFalse==destIfNull ){
3032e347d3e8Sdrh       /* Combine Step 3 and Step 5 into a single opcode */
3033e347d3e8Sdrh       sqlite3VdbeAddOp4Int(v, OP_NotFound, pExpr->iTable, destIfFalse,
3034e347d3e8Sdrh                            rLhs, nVector); VdbeCoverage(v);
3035e347d3e8Sdrh       goto sqlite3ExprCodeIN_finished;
3036e347d3e8Sdrh     }
3037e347d3e8Sdrh     /* Ordinary Step 3, for the case where FALSE and NULL are distinct */
3038e347d3e8Sdrh     addrTruthOp = sqlite3VdbeAddOp4Int(v, OP_Found, pExpr->iTable, 0,
3039e347d3e8Sdrh                                       rLhs, nVector); VdbeCoverage(v);
3040e347d3e8Sdrh   }
3041ba00e30aSdan 
3042e347d3e8Sdrh   /* Step 4.  If the RHS is known to be non-NULL and we did not find
3043e347d3e8Sdrh   ** an match on the search above, then the result must be FALSE.
3044e347d3e8Sdrh   */
3045e347d3e8Sdrh   if( rRhsHasNull && nVector==1 ){
3046e347d3e8Sdrh     sqlite3VdbeAddOp2(v, OP_NotNull, rRhsHasNull, destIfFalse);
3047471b4b92Sdrh     VdbeCoverage(v);
3048e347d3e8Sdrh   }
30497b35a77bSdan 
3050e347d3e8Sdrh   /* Step 5.  If we do not care about the difference between NULL and
3051e347d3e8Sdrh   ** FALSE, then just return false.
3052e347d3e8Sdrh   */
3053e347d3e8Sdrh   if( destIfFalse==destIfNull ) sqlite3VdbeGoto(v, destIfFalse);
3054e347d3e8Sdrh 
3055e347d3e8Sdrh   /* Step 6: Loop through rows of the RHS.  Compare each row to the LHS.
3056e347d3e8Sdrh   ** If any comparison is NULL, then the result is NULL.  If all
3057e347d3e8Sdrh   ** comparisons are FALSE then the final result is FALSE.
3058e347d3e8Sdrh   **
3059e347d3e8Sdrh   ** For a scalar LHS, it is sufficient to check just the first row
3060e347d3e8Sdrh   ** of the RHS.
3061e347d3e8Sdrh   */
3062e347d3e8Sdrh   if( destStep6 ) sqlite3VdbeResolveLabel(v, destStep6);
3063e347d3e8Sdrh   addrTop = sqlite3VdbeAddOp2(v, OP_Rewind, pExpr->iTable, destIfFalse);
3064471b4b92Sdrh   VdbeCoverage(v);
3065e347d3e8Sdrh   if( nVector>1 ){
3066e347d3e8Sdrh     destNotNull = sqlite3VdbeMakeLabel(v);
3067e347d3e8Sdrh   }else{
3068e347d3e8Sdrh     /* For nVector==1, combine steps 6 and 7 by immediately returning
3069e347d3e8Sdrh     ** FALSE if the first comparison is not NULL */
3070e347d3e8Sdrh     destNotNull = destIfFalse;
3071e347d3e8Sdrh   }
3072ba00e30aSdan   for(i=0; i<nVector; i++){
3073ba00e30aSdan     Expr *p;
3074ba00e30aSdan     CollSeq *pColl;
3075e347d3e8Sdrh     int r3 = sqlite3GetTempReg(pParse);
3076fc7f27b9Sdrh     p = sqlite3VectorFieldSubexpr(pLeft, i);
3077ba00e30aSdan     pColl = sqlite3ExprCollSeq(pParse, p);
3078e347d3e8Sdrh     sqlite3VdbeAddOp3(v, OP_Column, pExpr->iTable, i, r3);
3079e347d3e8Sdrh     sqlite3VdbeAddOp4(v, OP_Ne, rLhs+i, destNotNull, r3,
308018016ad2Sdrh                       (void*)pColl, P4_COLLSEQ);
3081471b4b92Sdrh     VdbeCoverage(v);
3082e347d3e8Sdrh     sqlite3ReleaseTempReg(pParse, r3);
30837b35a77bSdan   }
30847b35a77bSdan   sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfNull);
3085e347d3e8Sdrh   if( nVector>1 ){
3086e347d3e8Sdrh     sqlite3VdbeResolveLabel(v, destNotNull);
3087e347d3e8Sdrh     sqlite3VdbeAddOp2(v, OP_Next, pExpr->iTable, addrTop+1);
308818016ad2Sdrh     VdbeCoverage(v);
3089e347d3e8Sdrh 
3090e347d3e8Sdrh     /* Step 7:  If we reach this point, we know that the result must
3091e347d3e8Sdrh     ** be false. */
309218016ad2Sdrh     sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfFalse);
30937b35a77bSdan   }
30947b35a77bSdan 
3095e347d3e8Sdrh   /* Jumps here in order to return true. */
3096e347d3e8Sdrh   sqlite3VdbeJumpHere(v, addrTruthOp);
3097e3365e6cSdrh 
3098e347d3e8Sdrh sqlite3ExprCodeIN_finished:
3099e347d3e8Sdrh   if( rLhs!=rLhsOrig ) sqlite3ReleaseTempReg(pParse, rLhs);
3100d2490904Sdrh   sqlite3ExprCachePop(pParse);
3101ecb87ac8Sdrh   VdbeComment((v, "end IN expr"));
3102e347d3e8Sdrh sqlite3ExprCodeIN_oom_error:
3103ba00e30aSdan   sqlite3DbFree(pParse->db, aiMap);
3104553168c7Sdan   sqlite3DbFree(pParse->db, zAff);
3105e3365e6cSdrh }
3106e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
3107e3365e6cSdrh 
310813573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
3109598f1340Sdrh /*
3110598f1340Sdrh ** Generate an instruction that will put the floating point
31119cbf3425Sdrh ** value described by z[0..n-1] into register iMem.
31120cf19ed8Sdrh **
31130cf19ed8Sdrh ** The z[] string will probably not be zero-terminated.  But the
31140cf19ed8Sdrh ** z[n] character is guaranteed to be something that does not look
31150cf19ed8Sdrh ** like the continuation of the number.
3116598f1340Sdrh */
3117b7916a78Sdrh static void codeReal(Vdbe *v, const char *z, int negateFlag, int iMem){
3118fd773cf9Sdrh   if( ALWAYS(z!=0) ){
3119598f1340Sdrh     double value;
31209339da1fSdrh     sqlite3AtoF(z, &value, sqlite3Strlen30(z), SQLITE_UTF8);
3121d0015161Sdrh     assert( !sqlite3IsNaN(value) ); /* The new AtoF never returns NaN */
3122598f1340Sdrh     if( negateFlag ) value = -value;
312397bae794Sdrh     sqlite3VdbeAddOp4Dup8(v, OP_Real, 0, iMem, 0, (u8*)&value, P4_REAL);
3124598f1340Sdrh   }
3125598f1340Sdrh }
312613573c71Sdrh #endif
3127598f1340Sdrh 
3128598f1340Sdrh 
3129598f1340Sdrh /*
3130fec19aadSdrh ** Generate an instruction that will put the integer describe by
31319cbf3425Sdrh ** text z[0..n-1] into register iMem.
31320cf19ed8Sdrh **
31335f1d6b61Sshaneh ** Expr.u.zToken is always UTF8 and zero-terminated.
3134fec19aadSdrh */
313513573c71Sdrh static void codeInteger(Parse *pParse, Expr *pExpr, int negFlag, int iMem){
313613573c71Sdrh   Vdbe *v = pParse->pVdbe;
313792b01d53Sdrh   if( pExpr->flags & EP_IntValue ){
313833e619fcSdrh     int i = pExpr->u.iValue;
3139d50ffc41Sdrh     assert( i>=0 );
314092b01d53Sdrh     if( negFlag ) i = -i;
314192b01d53Sdrh     sqlite3VdbeAddOp2(v, OP_Integer, i, iMem);
3142fd773cf9Sdrh   }else{
31435f1d6b61Sshaneh     int c;
31445f1d6b61Sshaneh     i64 value;
3145fd773cf9Sdrh     const char *z = pExpr->u.zToken;
3146fd773cf9Sdrh     assert( z!=0 );
31479296c18aSdrh     c = sqlite3DecOrHexToI64(z, &value);
314884d4f1a3Sdrh     if( (c==3 && !negFlag) || (c==2) || (negFlag && value==SMALLEST_INT64)){
314913573c71Sdrh #ifdef SQLITE_OMIT_FLOATING_POINT
315013573c71Sdrh       sqlite3ErrorMsg(pParse, "oversized integer: %s%s", negFlag ? "-" : "", z);
315113573c71Sdrh #else
31521b7ddc59Sdrh #ifndef SQLITE_OMIT_HEX_INTEGER
31539296c18aSdrh       if( sqlite3_strnicmp(z,"0x",2)==0 ){
315477320ea4Sdrh         sqlite3ErrorMsg(pParse, "hex literal too big: %s%s", negFlag?"-":"",z);
31551b7ddc59Sdrh       }else
31561b7ddc59Sdrh #endif
31571b7ddc59Sdrh       {
3158b7916a78Sdrh         codeReal(v, z, negFlag, iMem);
31599296c18aSdrh       }
316013573c71Sdrh #endif
316177320ea4Sdrh     }else{
316284d4f1a3Sdrh       if( negFlag ){ value = c==3 ? SMALLEST_INT64 : -value; }
316377320ea4Sdrh       sqlite3VdbeAddOp4Dup8(v, OP_Int64, 0, iMem, 0, (u8*)&value, P4_INT64);
3164fec19aadSdrh     }
3165fec19aadSdrh   }
3166c9cf901dSdanielk1977 }
3167fec19aadSdrh 
3168bea119cdSdrh /*
31699b40d13fSdrh ** Erase column-cache entry number i
3170bea119cdSdrh */
31719b40d13fSdrh static void cacheEntryClear(Parse *pParse, int i){
31729b40d13fSdrh   if( pParse->aColCache[i].tempReg ){
3173ceea3321Sdrh     if( pParse->nTempReg<ArraySize(pParse->aTempReg) ){
31749b40d13fSdrh       pParse->aTempReg[pParse->nTempReg++] = pParse->aColCache[i].iReg;
3175ceea3321Sdrh     }
3176ceea3321Sdrh   }
3177bea119cdSdrh   pParse->nColCache--;
31789b40d13fSdrh   if( i<pParse->nColCache ){
31799b40d13fSdrh     pParse->aColCache[i] = pParse->aColCache[pParse->nColCache];
31809b40d13fSdrh   }
3181ceea3321Sdrh }
3182ceea3321Sdrh 
3183ceea3321Sdrh 
3184ceea3321Sdrh /*
3185ceea3321Sdrh ** Record in the column cache that a particular column from a
3186ceea3321Sdrh ** particular table is stored in a particular register.
3187ceea3321Sdrh */
3188ceea3321Sdrh void sqlite3ExprCacheStore(Parse *pParse, int iTab, int iCol, int iReg){
3189ceea3321Sdrh   int i;
3190ceea3321Sdrh   int minLru;
3191ceea3321Sdrh   int idxLru;
3192ceea3321Sdrh   struct yColCache *p;
3193ceea3321Sdrh 
3194ce8f53d4Sdan   /* Unless an error has occurred, register numbers are always positive. */
3195ce8f53d4Sdan   assert( iReg>0 || pParse->nErr || pParse->db->mallocFailed );
319620411ea7Sdrh   assert( iCol>=-1 && iCol<32768 );  /* Finite column numbers */
319720411ea7Sdrh 
3198b6da74ebSdrh   /* The SQLITE_ColumnCache flag disables the column cache.  This is used
3199b6da74ebSdrh   ** for testing only - to verify that SQLite always gets the same answer
3200b6da74ebSdrh   ** with and without the column cache.
3201b6da74ebSdrh   */
32027e5418e4Sdrh   if( OptimizationDisabled(pParse->db, SQLITE_ColumnCache) ) return;
3203b6da74ebSdrh 
320427ee406eSdrh   /* First replace any existing entry.
320527ee406eSdrh   **
320627ee406eSdrh   ** Actually, the way the column cache is currently used, we are guaranteed
320727ee406eSdrh   ** that the object will never already be in cache.  Verify this guarantee.
320827ee406eSdrh   */
320927ee406eSdrh #ifndef NDEBUG
32109b40d13fSdrh   for(i=0, p=pParse->aColCache; i<pParse->nColCache; i++, p++){
32119b40d13fSdrh     assert( p->iTable!=iTab || p->iColumn!=iCol );
3212ceea3321Sdrh   }
321327ee406eSdrh #endif
3214ceea3321Sdrh 
32159b40d13fSdrh   /* If the cache is already full, delete the least recently used entry */
32169b40d13fSdrh   if( pParse->nColCache>=SQLITE_N_COLCACHE ){
3217ceea3321Sdrh     minLru = 0x7fffffff;
3218ceea3321Sdrh     idxLru = -1;
3219ceea3321Sdrh     for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
3220ceea3321Sdrh       if( p->lru<minLru ){
3221ceea3321Sdrh         idxLru = i;
3222ceea3321Sdrh         minLru = p->lru;
3223ceea3321Sdrh       }
3224ceea3321Sdrh     }
3225ceea3321Sdrh     p = &pParse->aColCache[idxLru];
32269b40d13fSdrh   }else{
32279b40d13fSdrh     p = &pParse->aColCache[pParse->nColCache++];
32289b40d13fSdrh   }
32299b40d13fSdrh 
32309b40d13fSdrh   /* Add the new entry to the end of the cache */
3231ceea3321Sdrh   p->iLevel = pParse->iCacheLevel;
3232ceea3321Sdrh   p->iTable = iTab;
3233ceea3321Sdrh   p->iColumn = iCol;
3234ceea3321Sdrh   p->iReg = iReg;
3235ceea3321Sdrh   p->tempReg = 0;
3236ceea3321Sdrh   p->lru = pParse->iCacheCnt++;
3237ceea3321Sdrh }
3238ceea3321Sdrh 
3239ceea3321Sdrh /*
3240f49f3523Sdrh ** Indicate that registers between iReg..iReg+nReg-1 are being overwritten.
3241f49f3523Sdrh ** Purge the range of registers from the column cache.
3242ceea3321Sdrh */
3243f49f3523Sdrh void sqlite3ExprCacheRemove(Parse *pParse, int iReg, int nReg){
32449b40d13fSdrh   int i = 0;
32459b40d13fSdrh   while( i<pParse->nColCache ){
32469b40d13fSdrh     struct yColCache *p = &pParse->aColCache[i];
32479b40d13fSdrh     if( p->iReg >= iReg && p->iReg < iReg+nReg ){
32489b40d13fSdrh       cacheEntryClear(pParse, i);
32499b40d13fSdrh     }else{
32509b40d13fSdrh       i++;
32519b40d13fSdrh     }
3252ceea3321Sdrh   }
3253ceea3321Sdrh }
3254ceea3321Sdrh 
3255ceea3321Sdrh /*
3256ceea3321Sdrh ** Remember the current column cache context.  Any new entries added
3257ceea3321Sdrh ** added to the column cache after this call are removed when the
3258ceea3321Sdrh ** corresponding pop occurs.
3259ceea3321Sdrh */
3260ceea3321Sdrh void sqlite3ExprCachePush(Parse *pParse){
3261ceea3321Sdrh   pParse->iCacheLevel++;
32629ac7962aSdrh #ifdef SQLITE_DEBUG
32639ac7962aSdrh   if( pParse->db->flags & SQLITE_VdbeAddopTrace ){
32649ac7962aSdrh     printf("PUSH to %d\n", pParse->iCacheLevel);
32659ac7962aSdrh   }
32669ac7962aSdrh #endif
3267ceea3321Sdrh }
3268ceea3321Sdrh 
3269ceea3321Sdrh /*
3270ceea3321Sdrh ** Remove from the column cache any entries that were added since the
3271d2490904Sdrh ** the previous sqlite3ExprCachePush operation.  In other words, restore
3272d2490904Sdrh ** the cache to the state it was in prior the most recent Push.
3273ceea3321Sdrh */
3274d2490904Sdrh void sqlite3ExprCachePop(Parse *pParse){
32759b40d13fSdrh   int i = 0;
3276d2490904Sdrh   assert( pParse->iCacheLevel>=1 );
3277d2490904Sdrh   pParse->iCacheLevel--;
32789ac7962aSdrh #ifdef SQLITE_DEBUG
32799ac7962aSdrh   if( pParse->db->flags & SQLITE_VdbeAddopTrace ){
32809ac7962aSdrh     printf("POP  to %d\n", pParse->iCacheLevel);
32819ac7962aSdrh   }
32829ac7962aSdrh #endif
32839b40d13fSdrh   while( i<pParse->nColCache ){
32849b40d13fSdrh     if( pParse->aColCache[i].iLevel>pParse->iCacheLevel ){
32859b40d13fSdrh       cacheEntryClear(pParse, i);
32869b40d13fSdrh     }else{
32879b40d13fSdrh       i++;
3288ceea3321Sdrh     }
3289ceea3321Sdrh   }
3290ceea3321Sdrh }
3291945498f3Sdrh 
3292945498f3Sdrh /*
32935cd79239Sdrh ** When a cached column is reused, make sure that its register is
32945cd79239Sdrh ** no longer available as a temp register.  ticket #3879:  that same
32955cd79239Sdrh ** register might be in the cache in multiple places, so be sure to
32965cd79239Sdrh ** get them all.
32975cd79239Sdrh */
32985cd79239Sdrh static void sqlite3ExprCachePinRegister(Parse *pParse, int iReg){
32995cd79239Sdrh   int i;
33005cd79239Sdrh   struct yColCache *p;
33019b40d13fSdrh   for(i=0, p=pParse->aColCache; i<pParse->nColCache; i++, p++){
33025cd79239Sdrh     if( p->iReg==iReg ){
33035cd79239Sdrh       p->tempReg = 0;
33045cd79239Sdrh     }
33055cd79239Sdrh   }
33065cd79239Sdrh }
33075cd79239Sdrh 
33081f9ca2c8Sdrh /* Generate code that will load into register regOut a value that is
33091f9ca2c8Sdrh ** appropriate for the iIdxCol-th column of index pIdx.
33101f9ca2c8Sdrh */
33111f9ca2c8Sdrh void sqlite3ExprCodeLoadIndexColumn(
33121f9ca2c8Sdrh   Parse *pParse,  /* The parsing context */
33131f9ca2c8Sdrh   Index *pIdx,    /* The index whose column is to be loaded */
33141f9ca2c8Sdrh   int iTabCur,    /* Cursor pointing to a table row */
33151f9ca2c8Sdrh   int iIdxCol,    /* The column of the index to be loaded */
33161f9ca2c8Sdrh   int regOut      /* Store the index column value in this register */
33171f9ca2c8Sdrh ){
33181f9ca2c8Sdrh   i16 iTabCol = pIdx->aiColumn[iIdxCol];
33194b92f98cSdrh   if( iTabCol==XN_EXPR ){
33201f9ca2c8Sdrh     assert( pIdx->aColExpr );
33211f9ca2c8Sdrh     assert( pIdx->aColExpr->nExpr>iIdxCol );
33223e34eabcSdrh     pParse->iSelfTab = iTabCur + 1;
33231c75c9d7Sdrh     sqlite3ExprCodeCopy(pParse, pIdx->aColExpr->a[iIdxCol].pExpr, regOut);
33243e34eabcSdrh     pParse->iSelfTab = 0;
33254b92f98cSdrh   }else{
33264b92f98cSdrh     sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pIdx->pTable, iTabCur,
33274b92f98cSdrh                                     iTabCol, regOut);
33284b92f98cSdrh   }
33291f9ca2c8Sdrh }
33301f9ca2c8Sdrh 
33315cd79239Sdrh /*
33325c092e8aSdrh ** Generate code to extract the value of the iCol-th column of a table.
33335c092e8aSdrh */
33345c092e8aSdrh void sqlite3ExprCodeGetColumnOfTable(
33355c092e8aSdrh   Vdbe *v,        /* The VDBE under construction */
33365c092e8aSdrh   Table *pTab,    /* The table containing the value */
3337313619f5Sdrh   int iTabCur,    /* The table cursor.  Or the PK cursor for WITHOUT ROWID */
33385c092e8aSdrh   int iCol,       /* Index of the column to extract */
3339313619f5Sdrh   int regOut      /* Extract the value into this register */
33405c092e8aSdrh ){
3341aca19e19Sdrh   if( pTab==0 ){
3342aca19e19Sdrh     sqlite3VdbeAddOp3(v, OP_Column, iTabCur, iCol, regOut);
3343aca19e19Sdrh     return;
3344aca19e19Sdrh   }
33455c092e8aSdrh   if( iCol<0 || iCol==pTab->iPKey ){
33465c092e8aSdrh     sqlite3VdbeAddOp2(v, OP_Rowid, iTabCur, regOut);
33475c092e8aSdrh   }else{
33485c092e8aSdrh     int op = IsVirtual(pTab) ? OP_VColumn : OP_Column;
3349ee0ec8e1Sdrh     int x = iCol;
335035db31b2Sdrh     if( !HasRowid(pTab) && !IsVirtual(pTab) ){
3351ee0ec8e1Sdrh       x = sqlite3ColumnOfIndex(sqlite3PrimaryKeyIndex(pTab), iCol);
3352ee0ec8e1Sdrh     }
3353ee0ec8e1Sdrh     sqlite3VdbeAddOp3(v, op, iTabCur, x, regOut);
33545c092e8aSdrh   }
33555c092e8aSdrh   if( iCol>=0 ){
33565c092e8aSdrh     sqlite3ColumnDefault(v, pTab, iCol, regOut);
33575c092e8aSdrh   }
33585c092e8aSdrh }
33595c092e8aSdrh 
33605c092e8aSdrh /*
3361945498f3Sdrh ** Generate code that will extract the iColumn-th column from
3362ce78bc6eSdrh ** table pTab and store the column value in a register.
3363ce78bc6eSdrh **
3364ce78bc6eSdrh ** An effort is made to store the column value in register iReg.  This
3365ce78bc6eSdrh ** is not garanteeed for GetColumn() - the result can be stored in
3366ce78bc6eSdrh ** any register.  But the result is guaranteed to land in register iReg
3367ce78bc6eSdrh ** for GetColumnToReg().
3368e55cbd72Sdrh **
3369e55cbd72Sdrh ** There must be an open cursor to pTab in iTable when this routine
3370e55cbd72Sdrh ** is called.  If iColumn<0 then code is generated that extracts the rowid.
3371945498f3Sdrh */
3372e55cbd72Sdrh int sqlite3ExprCodeGetColumn(
3373e55cbd72Sdrh   Parse *pParse,   /* Parsing and code generating context */
33742133d822Sdrh   Table *pTab,     /* Description of the table we are reading from */
33752133d822Sdrh   int iColumn,     /* Index of the table column */
33762133d822Sdrh   int iTable,      /* The cursor pointing to the table */
3377a748fdccSdrh   int iReg,        /* Store results here */
3378ce78bc6eSdrh   u8 p5            /* P5 value for OP_Column + FLAGS */
33792133d822Sdrh ){
3380e55cbd72Sdrh   Vdbe *v = pParse->pVdbe;
3381e55cbd72Sdrh   int i;
3382da250ea5Sdrh   struct yColCache *p;
3383e55cbd72Sdrh 
33849b40d13fSdrh   for(i=0, p=pParse->aColCache; i<pParse->nColCache; i++, p++){
338594881d73Sdrh     if( p->iTable==iTable && p->iColumn==iColumn ){
3386ceea3321Sdrh       p->lru = pParse->iCacheCnt++;
33875cd79239Sdrh       sqlite3ExprCachePinRegister(pParse, p->iReg);
3388da250ea5Sdrh       return p->iReg;
3389e55cbd72Sdrh     }
3390e55cbd72Sdrh   }
3391e55cbd72Sdrh   assert( v!=0 );
33925c092e8aSdrh   sqlite3ExprCodeGetColumnOfTable(v, pTab, iTable, iColumn, iReg);
3393a748fdccSdrh   if( p5 ){
3394a748fdccSdrh     sqlite3VdbeChangeP5(v, p5);
3395a748fdccSdrh   }else{
3396ceea3321Sdrh     sqlite3ExprCacheStore(pParse, iTable, iColumn, iReg);
3397a748fdccSdrh   }
3398e55cbd72Sdrh   return iReg;
3399e55cbd72Sdrh }
3400ce78bc6eSdrh void sqlite3ExprCodeGetColumnToReg(
3401ce78bc6eSdrh   Parse *pParse,   /* Parsing and code generating context */
3402ce78bc6eSdrh   Table *pTab,     /* Description of the table we are reading from */
3403ce78bc6eSdrh   int iColumn,     /* Index of the table column */
3404ce78bc6eSdrh   int iTable,      /* The cursor pointing to the table */
3405ce78bc6eSdrh   int iReg         /* Store results here */
3406ce78bc6eSdrh ){
3407ce78bc6eSdrh   int r1 = sqlite3ExprCodeGetColumn(pParse, pTab, iColumn, iTable, iReg, 0);
3408ce78bc6eSdrh   if( r1!=iReg ) sqlite3VdbeAddOp2(pParse->pVdbe, OP_SCopy, r1, iReg);
3409ce78bc6eSdrh }
3410ce78bc6eSdrh 
3411e55cbd72Sdrh 
3412e55cbd72Sdrh /*
3413ceea3321Sdrh ** Clear all column cache entries.
3414e55cbd72Sdrh */
3415ceea3321Sdrh void sqlite3ExprCacheClear(Parse *pParse){
3416e55cbd72Sdrh   int i;
3417ceea3321Sdrh 
3418d879e3ebSdrh #ifdef SQLITE_DEBUG
34199ac7962aSdrh   if( pParse->db->flags & SQLITE_VdbeAddopTrace ){
34209ac7962aSdrh     printf("CLEAR\n");
34219ac7962aSdrh   }
34229ac7962aSdrh #endif
34239b40d13fSdrh   for(i=0; i<pParse->nColCache; i++){
34249b40d13fSdrh     if( pParse->aColCache[i].tempReg
34259b40d13fSdrh      && pParse->nTempReg<ArraySize(pParse->aTempReg)
34269b40d13fSdrh     ){
34279b40d13fSdrh        pParse->aTempReg[pParse->nTempReg++] = pParse->aColCache[i].iReg;
3428e55cbd72Sdrh     }
3429da250ea5Sdrh   }
34309b40d13fSdrh   pParse->nColCache = 0;
3431da250ea5Sdrh }
3432e55cbd72Sdrh 
3433e55cbd72Sdrh /*
3434da250ea5Sdrh ** Record the fact that an affinity change has occurred on iCount
3435da250ea5Sdrh ** registers starting with iStart.
3436e55cbd72Sdrh */
3437da250ea5Sdrh void sqlite3ExprCacheAffinityChange(Parse *pParse, int iStart, int iCount){
3438f49f3523Sdrh   sqlite3ExprCacheRemove(pParse, iStart, iCount);
3439e55cbd72Sdrh }
3440e55cbd72Sdrh 
3441e55cbd72Sdrh /*
3442b21e7c70Sdrh ** Generate code to move content from registers iFrom...iFrom+nReg-1
3443b21e7c70Sdrh ** over to iTo..iTo+nReg-1. Keep the column cache up-to-date.
3444e55cbd72Sdrh */
3445b21e7c70Sdrh void sqlite3ExprCodeMove(Parse *pParse, int iFrom, int iTo, int nReg){
3446e8e4af76Sdrh   assert( iFrom>=iTo+nReg || iFrom+nReg<=iTo );
3447079a3072Sdrh   sqlite3VdbeAddOp3(pParse->pVdbe, OP_Move, iFrom, iTo, nReg);
3448236241aeSdrh   sqlite3ExprCacheRemove(pParse, iFrom, nReg);
3449945498f3Sdrh }
3450945498f3Sdrh 
3451f49f3523Sdrh #if defined(SQLITE_DEBUG) || defined(SQLITE_COVERAGE_TEST)
345292b01d53Sdrh /*
3453652fbf55Sdrh ** Return true if any register in the range iFrom..iTo (inclusive)
3454652fbf55Sdrh ** is used as part of the column cache.
3455f49f3523Sdrh **
3456f49f3523Sdrh ** This routine is used within assert() and testcase() macros only
3457f49f3523Sdrh ** and does not appear in a normal build.
3458652fbf55Sdrh */
3459652fbf55Sdrh static int usedAsColumnCache(Parse *pParse, int iFrom, int iTo){
3460652fbf55Sdrh   int i;
3461ceea3321Sdrh   struct yColCache *p;
34629b40d13fSdrh   for(i=0, p=pParse->aColCache; i<pParse->nColCache; i++, p++){
3463ceea3321Sdrh     int r = p->iReg;
3464f49f3523Sdrh     if( r>=iFrom && r<=iTo ) return 1;    /*NO_TEST*/
3465652fbf55Sdrh   }
3466652fbf55Sdrh   return 0;
3467652fbf55Sdrh }
3468f49f3523Sdrh #endif /* SQLITE_DEBUG || SQLITE_COVERAGE_TEST */
3469652fbf55Sdrh 
3470bea119cdSdrh 
3471652fbf55Sdrh /*
347212abf408Sdrh ** Convert a scalar expression node to a TK_REGISTER referencing
347312abf408Sdrh ** register iReg.  The caller must ensure that iReg already contains
347412abf408Sdrh ** the correct value for the expression.
3475a4c3c87eSdrh */
3476a4c3c87eSdrh static void exprToRegister(Expr *p, int iReg){
3477a4c3c87eSdrh   p->op2 = p->op;
3478a4c3c87eSdrh   p->op = TK_REGISTER;
3479a4c3c87eSdrh   p->iTable = iReg;
3480a4c3c87eSdrh   ExprClearProperty(p, EP_Skip);
3481a4c3c87eSdrh }
3482a4c3c87eSdrh 
348312abf408Sdrh /*
348412abf408Sdrh ** Evaluate an expression (either a vector or a scalar expression) and store
348512abf408Sdrh ** the result in continguous temporary registers.  Return the index of
348612abf408Sdrh ** the first register used to store the result.
348712abf408Sdrh **
348812abf408Sdrh ** If the returned result register is a temporary scalar, then also write
348912abf408Sdrh ** that register number into *piFreeable.  If the returned result register
349012abf408Sdrh ** is not a temporary or if the expression is a vector set *piFreeable
349112abf408Sdrh ** to 0.
349212abf408Sdrh */
349312abf408Sdrh static int exprCodeVector(Parse *pParse, Expr *p, int *piFreeable){
349412abf408Sdrh   int iResult;
349512abf408Sdrh   int nResult = sqlite3ExprVectorSize(p);
349612abf408Sdrh   if( nResult==1 ){
349712abf408Sdrh     iResult = sqlite3ExprCodeTemp(pParse, p, piFreeable);
349812abf408Sdrh   }else{
349912abf408Sdrh     *piFreeable = 0;
350012abf408Sdrh     if( p->op==TK_SELECT ){
3501dd1bb43aSdrh #if SQLITE_OMIT_SUBQUERY
3502dd1bb43aSdrh       iResult = 0;
3503dd1bb43aSdrh #else
350412abf408Sdrh       iResult = sqlite3CodeSubselect(pParse, p, 0, 0);
3505dd1bb43aSdrh #endif
350612abf408Sdrh     }else{
350712abf408Sdrh       int i;
350812abf408Sdrh       iResult = pParse->nMem+1;
350912abf408Sdrh       pParse->nMem += nResult;
351012abf408Sdrh       for(i=0; i<nResult; i++){
35114b725240Sdan         sqlite3ExprCodeFactorable(pParse, p->x.pList->a[i].pExpr, i+iResult);
351212abf408Sdrh       }
351312abf408Sdrh     }
351412abf408Sdrh   }
351512abf408Sdrh   return iResult;
351612abf408Sdrh }
351712abf408Sdrh 
351871c57db0Sdan 
3519a4c3c87eSdrh /*
3520cce7d176Sdrh ** Generate code into the current Vdbe to evaluate the given
35212dcef11bSdrh ** expression.  Attempt to store the results in register "target".
35222dcef11bSdrh ** Return the register where results are stored.
3523389a1adbSdrh **
35248b213899Sdrh ** With this routine, there is no guarantee that results will
35252dcef11bSdrh ** be stored in target.  The result might be stored in some other
35262dcef11bSdrh ** register if it is convenient to do so.  The calling function
35272dcef11bSdrh ** must check the return code and move the results to the desired
35282dcef11bSdrh ** register.
3529cce7d176Sdrh */
3530678ccce8Sdrh int sqlite3ExprCodeTarget(Parse *pParse, Expr *pExpr, int target){
35312dcef11bSdrh   Vdbe *v = pParse->pVdbe;  /* The VM under construction */
35322dcef11bSdrh   int op;                   /* The opcode being coded */
35332dcef11bSdrh   int inReg = target;       /* Results stored in register inReg */
35342dcef11bSdrh   int regFree1 = 0;         /* If non-zero free this temporary register */
35352dcef11bSdrh   int regFree2 = 0;         /* If non-zero free this temporary register */
35367b35a77bSdan   int r1, r2;               /* Various register numbers */
353710d1edf0Sdrh   Expr tempX;               /* Temporary expression node */
353871c57db0Sdan   int p5 = 0;
3539ffe07b2dSdrh 
35409cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
354120411ea7Sdrh   if( v==0 ){
354220411ea7Sdrh     assert( pParse->db->mallocFailed );
354320411ea7Sdrh     return 0;
354420411ea7Sdrh   }
3545389a1adbSdrh 
35461efa8023Sdrh expr_code_doover:
3547389a1adbSdrh   if( pExpr==0 ){
3548389a1adbSdrh     op = TK_NULL;
3549389a1adbSdrh   }else{
3550f2bc013cSdrh     op = pExpr->op;
3551389a1adbSdrh   }
3552f2bc013cSdrh   switch( op ){
355313449892Sdrh     case TK_AGG_COLUMN: {
355413449892Sdrh       AggInfo *pAggInfo = pExpr->pAggInfo;
355513449892Sdrh       struct AggInfo_col *pCol = &pAggInfo->aCol[pExpr->iAgg];
355613449892Sdrh       if( !pAggInfo->directMode ){
35579de221dfSdrh         assert( pCol->iMem>0 );
3558c332cc30Sdrh         return pCol->iMem;
355913449892Sdrh       }else if( pAggInfo->useSortingIdx ){
35605134d135Sdan         sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdxPTab,
3561389a1adbSdrh                               pCol->iSorterColumn, target);
3562c332cc30Sdrh         return target;
356313449892Sdrh       }
356413449892Sdrh       /* Otherwise, fall thru into the TK_COLUMN case */
356513449892Sdrh     }
3566967e8b73Sdrh     case TK_COLUMN: {
3567b2b9d3d7Sdrh       int iTab = pExpr->iTable;
3568b2b9d3d7Sdrh       if( iTab<0 ){
35696e97f8ecSdrh         if( pParse->iSelfTab<0 ){
3570b2b9d3d7Sdrh           /* Generating CHECK constraints or inserting into partial index */
35716e97f8ecSdrh           return pExpr->iColumn - pParse->iSelfTab;
3572c4a3c779Sdrh         }else{
35731f9ca2c8Sdrh           /* Coding an expression that is part of an index where column names
35741f9ca2c8Sdrh           ** in the index refer to the table to which the index belongs */
35753e34eabcSdrh           iTab = pParse->iSelfTab - 1;
35762282792aSdrh         }
3577b2b9d3d7Sdrh       }
3578c332cc30Sdrh       return sqlite3ExprCodeGetColumn(pParse, pExpr->pTab,
3579b2b9d3d7Sdrh                                pExpr->iColumn, iTab, target,
3580b2b9d3d7Sdrh                                pExpr->op2);
3581cce7d176Sdrh     }
3582cce7d176Sdrh     case TK_INTEGER: {
358313573c71Sdrh       codeInteger(pParse, pExpr, 0, target);
3584c332cc30Sdrh       return target;
358551e9a445Sdrh     }
35868abed7b9Sdrh     case TK_TRUEFALSE: {
358796acafbeSdrh       sqlite3VdbeAddOp2(v, OP_Integer, sqlite3ExprTruthValue(pExpr), target);
3588007c843bSdrh       return target;
3589007c843bSdrh     }
359013573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
3591598f1340Sdrh     case TK_FLOAT: {
359233e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
359333e619fcSdrh       codeReal(v, pExpr->u.zToken, 0, target);
3594c332cc30Sdrh       return target;
3595598f1340Sdrh     }
359613573c71Sdrh #endif
3597fec19aadSdrh     case TK_STRING: {
359833e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
3599076e85f5Sdrh       sqlite3VdbeLoadString(v, target, pExpr->u.zToken);
3600c332cc30Sdrh       return target;
3601cce7d176Sdrh     }
3602f0863fe5Sdrh     case TK_NULL: {
36039de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3604c332cc30Sdrh       return target;
3605f0863fe5Sdrh     }
36065338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_BLOB_LITERAL
3607c572ef7fSdanielk1977     case TK_BLOB: {
36086c8c6cecSdrh       int n;
36096c8c6cecSdrh       const char *z;
3610ca48c90fSdrh       char *zBlob;
361133e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
361233e619fcSdrh       assert( pExpr->u.zToken[0]=='x' || pExpr->u.zToken[0]=='X' );
361333e619fcSdrh       assert( pExpr->u.zToken[1]=='\'' );
361433e619fcSdrh       z = &pExpr->u.zToken[2];
3615b7916a78Sdrh       n = sqlite3Strlen30(z) - 1;
3616b7916a78Sdrh       assert( z[n]=='\'' );
3617ca48c90fSdrh       zBlob = sqlite3HexToBlob(sqlite3VdbeDb(v), z, n);
3618ca48c90fSdrh       sqlite3VdbeAddOp4(v, OP_Blob, n/2, target, 0, zBlob, P4_DYNAMIC);
3619c332cc30Sdrh       return target;
3620c572ef7fSdanielk1977     }
36215338a5f7Sdanielk1977 #endif
362250457896Sdrh     case TK_VARIABLE: {
362333e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
362433e619fcSdrh       assert( pExpr->u.zToken!=0 );
362533e619fcSdrh       assert( pExpr->u.zToken[0]!=0 );
3626eaf52d88Sdrh       sqlite3VdbeAddOp2(v, OP_Variable, pExpr->iColumn, target);
362733e619fcSdrh       if( pExpr->u.zToken[1]!=0 ){
36289bf755ccSdrh         const char *z = sqlite3VListNumToName(pParse->pVList, pExpr->iColumn);
36299bf755ccSdrh         assert( pExpr->u.zToken[0]=='?' || strcmp(pExpr->u.zToken, z)==0 );
3630ce1bbe51Sdrh         pParse->pVList[0] = 0; /* Indicate VList may no longer be enlarged */
36319bf755ccSdrh         sqlite3VdbeAppendP4(v, (char*)z, P4_STATIC);
36329bf755ccSdrh       }
3633c332cc30Sdrh       return target;
363450457896Sdrh     }
36354e0cff60Sdrh     case TK_REGISTER: {
3636c332cc30Sdrh       return pExpr->iTable;
36374e0cff60Sdrh     }
3638487e262fSdrh #ifndef SQLITE_OMIT_CAST
3639487e262fSdrh     case TK_CAST: {
3640487e262fSdrh       /* Expressions of the form:   CAST(pLeft AS token) */
36412dcef11bSdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
36421735fa88Sdrh       if( inReg!=target ){
36431735fa88Sdrh         sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
36441735fa88Sdrh         inReg = target;
36451735fa88Sdrh       }
36464169e430Sdrh       sqlite3VdbeAddOp2(v, OP_Cast, target,
36474169e430Sdrh                         sqlite3AffinityType(pExpr->u.zToken, 0));
3648c5499befSdrh       testcase( usedAsColumnCache(pParse, inReg, inReg) );
3649b3843a82Sdrh       sqlite3ExprCacheAffinityChange(pParse, inReg, 1);
3650c332cc30Sdrh       return inReg;
3651487e262fSdrh     }
3652487e262fSdrh #endif /* SQLITE_OMIT_CAST */
365371c57db0Sdan     case TK_IS:
365471c57db0Sdan     case TK_ISNOT:
365571c57db0Sdan       op = (op==TK_IS) ? TK_EQ : TK_NE;
365671c57db0Sdan       p5 = SQLITE_NULLEQ;
365771c57db0Sdan       /* fall-through */
3658c9b84a1fSdrh     case TK_LT:
3659c9b84a1fSdrh     case TK_LE:
3660c9b84a1fSdrh     case TK_GT:
3661c9b84a1fSdrh     case TK_GE:
3662c9b84a1fSdrh     case TK_NE:
3663c9b84a1fSdrh     case TK_EQ: {
366471c57db0Sdan       Expr *pLeft = pExpr->pLeft;
3665625015e0Sdan       if( sqlite3ExprIsVector(pLeft) ){
366679752b6eSdrh         codeVectorCompare(pParse, pExpr, target, op, p5);
366771c57db0Sdan       }else{
366871c57db0Sdan         r1 = sqlite3ExprCodeTemp(pParse, pLeft, &regFree1);
3669b6da74ebSdrh         r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
367071c57db0Sdan         codeCompare(pParse, pLeft, pExpr->pRight, op,
367171c57db0Sdan             r1, r2, inReg, SQLITE_STOREP2 | p5);
36727d176105Sdrh         assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
36737d176105Sdrh         assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
36747d176105Sdrh         assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
36757d176105Sdrh         assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
36767d176105Sdrh         assert(TK_EQ==OP_Eq); testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
36777d176105Sdrh         assert(TK_NE==OP_Ne); testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
3678c5499befSdrh         testcase( regFree1==0 );
3679c5499befSdrh         testcase( regFree2==0 );
3680c9b84a1fSdrh       }
36816a2fe093Sdrh       break;
36826a2fe093Sdrh     }
3683cce7d176Sdrh     case TK_AND:
3684cce7d176Sdrh     case TK_OR:
3685cce7d176Sdrh     case TK_PLUS:
3686cce7d176Sdrh     case TK_STAR:
3687cce7d176Sdrh     case TK_MINUS:
3688bf4133cbSdrh     case TK_REM:
3689bf4133cbSdrh     case TK_BITAND:
3690bf4133cbSdrh     case TK_BITOR:
369117c40294Sdrh     case TK_SLASH:
3692bf4133cbSdrh     case TK_LSHIFT:
3693855eb1cfSdrh     case TK_RSHIFT:
36940040077dSdrh     case TK_CONCAT: {
36957d176105Sdrh       assert( TK_AND==OP_And );            testcase( op==TK_AND );
36967d176105Sdrh       assert( TK_OR==OP_Or );              testcase( op==TK_OR );
36977d176105Sdrh       assert( TK_PLUS==OP_Add );           testcase( op==TK_PLUS );
36987d176105Sdrh       assert( TK_MINUS==OP_Subtract );     testcase( op==TK_MINUS );
36997d176105Sdrh       assert( TK_REM==OP_Remainder );      testcase( op==TK_REM );
37007d176105Sdrh       assert( TK_BITAND==OP_BitAnd );      testcase( op==TK_BITAND );
37017d176105Sdrh       assert( TK_BITOR==OP_BitOr );        testcase( op==TK_BITOR );
37027d176105Sdrh       assert( TK_SLASH==OP_Divide );       testcase( op==TK_SLASH );
37037d176105Sdrh       assert( TK_LSHIFT==OP_ShiftLeft );   testcase( op==TK_LSHIFT );
37047d176105Sdrh       assert( TK_RSHIFT==OP_ShiftRight );  testcase( op==TK_RSHIFT );
37057d176105Sdrh       assert( TK_CONCAT==OP_Concat );      testcase( op==TK_CONCAT );
37062dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
37072dcef11bSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
37085b6afba9Sdrh       sqlite3VdbeAddOp3(v, op, r2, r1, target);
3709c5499befSdrh       testcase( regFree1==0 );
3710c5499befSdrh       testcase( regFree2==0 );
37110040077dSdrh       break;
37120040077dSdrh     }
3713cce7d176Sdrh     case TK_UMINUS: {
3714fec19aadSdrh       Expr *pLeft = pExpr->pLeft;
3715fec19aadSdrh       assert( pLeft );
371613573c71Sdrh       if( pLeft->op==TK_INTEGER ){
371713573c71Sdrh         codeInteger(pParse, pLeft, 1, target);
3718c332cc30Sdrh         return target;
371913573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
372013573c71Sdrh       }else if( pLeft->op==TK_FLOAT ){
372133e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
372233e619fcSdrh         codeReal(v, pLeft->u.zToken, 1, target);
3723c332cc30Sdrh         return target;
372413573c71Sdrh #endif
37253c84ddffSdrh       }else{
372610d1edf0Sdrh         tempX.op = TK_INTEGER;
372710d1edf0Sdrh         tempX.flags = EP_IntValue|EP_TokenOnly;
372810d1edf0Sdrh         tempX.u.iValue = 0;
372910d1edf0Sdrh         r1 = sqlite3ExprCodeTemp(pParse, &tempX, &regFree1);
3730e55cbd72Sdrh         r2 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree2);
37312dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_Subtract, r2, r1, target);
3732c5499befSdrh         testcase( regFree2==0 );
37333c84ddffSdrh       }
37346e142f54Sdrh       break;
37356e142f54Sdrh     }
3736bf4133cbSdrh     case TK_BITNOT:
37376e142f54Sdrh     case TK_NOT: {
37387d176105Sdrh       assert( TK_BITNOT==OP_BitNot );   testcase( op==TK_BITNOT );
37397d176105Sdrh       assert( TK_NOT==OP_Not );         testcase( op==TK_NOT );
3740e99fa2afSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3741e99fa2afSdrh       testcase( regFree1==0 );
3742e99fa2afSdrh       sqlite3VdbeAddOp2(v, op, r1, inReg);
3743cce7d176Sdrh       break;
3744cce7d176Sdrh     }
37458abed7b9Sdrh     case TK_TRUTH: {
374696acafbeSdrh       int isTrue;    /* IS TRUE or IS NOT TRUE */
374796acafbeSdrh       int bNormal;   /* IS TRUE or IS FALSE */
3748007c843bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3749007c843bSdrh       testcase( regFree1==0 );
375096acafbeSdrh       isTrue = sqlite3ExprTruthValue(pExpr->pRight);
375196acafbeSdrh       bNormal = pExpr->op2==TK_IS;
375296acafbeSdrh       testcase( isTrue && bNormal);
375396acafbeSdrh       testcase( !isTrue && bNormal);
375496acafbeSdrh       sqlite3VdbeAddOp4Int(v, OP_IsTrue, r1, inReg, !isTrue, isTrue ^ bNormal);
3755007c843bSdrh       break;
3756007c843bSdrh     }
3757cce7d176Sdrh     case TK_ISNULL:
3758cce7d176Sdrh     case TK_NOTNULL: {
37596a288a33Sdrh       int addr;
37607d176105Sdrh       assert( TK_ISNULL==OP_IsNull );   testcase( op==TK_ISNULL );
37617d176105Sdrh       assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
37629de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
37632dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3764c5499befSdrh       testcase( regFree1==0 );
37652dcef11bSdrh       addr = sqlite3VdbeAddOp1(v, op, r1);
37667d176105Sdrh       VdbeCoverageIf(v, op==TK_ISNULL);
37677d176105Sdrh       VdbeCoverageIf(v, op==TK_NOTNULL);
3768a976979bSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 0, target);
37696a288a33Sdrh       sqlite3VdbeJumpHere(v, addr);
3770a37cdde0Sdanielk1977       break;
3771f2bc013cSdrh     }
37722282792aSdrh     case TK_AGG_FUNCTION: {
377313449892Sdrh       AggInfo *pInfo = pExpr->pAggInfo;
37747e56e711Sdrh       if( pInfo==0 ){
377533e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
377633e619fcSdrh         sqlite3ErrorMsg(pParse, "misuse of aggregate: %s()", pExpr->u.zToken);
37777e56e711Sdrh       }else{
3778c332cc30Sdrh         return pInfo->aFunc[pExpr->iAgg].iMem;
37797e56e711Sdrh       }
37802282792aSdrh       break;
37812282792aSdrh     }
3782cce7d176Sdrh     case TK_FUNCTION: {
378312ffee8cSdrh       ExprList *pFarg;       /* List of function arguments */
378412ffee8cSdrh       int nFarg;             /* Number of function arguments */
378512ffee8cSdrh       FuncDef *pDef;         /* The function definition object */
378612ffee8cSdrh       const char *zId;       /* The function name */
3787693e6719Sdrh       u32 constMask = 0;     /* Mask of function arguments that are constant */
378812ffee8cSdrh       int i;                 /* Loop counter */
3789c332cc30Sdrh       sqlite3 *db = pParse->db;  /* The database connection */
379012ffee8cSdrh       u8 enc = ENC(db);      /* The text encoding used by this database */
379112ffee8cSdrh       CollSeq *pColl = 0;    /* A collating sequence */
379217435752Sdrh 
379386fb6e17Sdan       if( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) && pExpr->pWin ){
379486fb6e17Sdan         return pExpr->pWin->regResult;
379586fb6e17Sdan       }
379686fb6e17Sdan 
37971e9b53f9Sdrh       if( ConstFactorOk(pParse) && sqlite3ExprIsConstantNotJoin(pExpr) ){
379849c5ab24Sdrh         /* SQL functions can be expensive. So try to move constant functions
3799ad879ffdSdrh         ** out of the inner loop, even if that means an extra OP_Copy. */
3800ad879ffdSdrh         return sqlite3ExprCodeAtInit(pParse, pExpr, -1);
38011e9b53f9Sdrh       }
38026ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
3803c5cd1249Sdrh       if( ExprHasProperty(pExpr, EP_TokenOnly) ){
380412ffee8cSdrh         pFarg = 0;
380512ffee8cSdrh       }else{
380612ffee8cSdrh         pFarg = pExpr->x.pList;
380712ffee8cSdrh       }
380812ffee8cSdrh       nFarg = pFarg ? pFarg->nExpr : 0;
380933e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
381033e619fcSdrh       zId = pExpr->u.zToken;
381180738d9cSdrh       pDef = sqlite3FindFunction(db, zId, nFarg, enc, 0);
3812cc15313cSdrh #ifdef SQLITE_ENABLE_UNKNOWN_SQL_FUNCTION
3813cc15313cSdrh       if( pDef==0 && pParse->explain ){
3814cc15313cSdrh         pDef = sqlite3FindFunction(db, "unknown", nFarg, enc, 0);
3815cc15313cSdrh       }
3816cc15313cSdrh #endif
3817b6e9f7a4Sdan       if( pDef==0 || pDef->xFinalize!=0 ){
381880738d9cSdrh         sqlite3ErrorMsg(pParse, "unknown function: %s()", zId);
3819feb306f5Sdrh         break;
3820feb306f5Sdrh       }
3821ae6bb957Sdrh 
3822ae6bb957Sdrh       /* Attempt a direct implementation of the built-in COALESCE() and
382360ec914cSpeter.d.reid       ** IFNULL() functions.  This avoids unnecessary evaluation of
3824ae6bb957Sdrh       ** arguments past the first non-NULL argument.
3825ae6bb957Sdrh       */
3826d36e1041Sdrh       if( pDef->funcFlags & SQLITE_FUNC_COALESCE ){
3827ae6bb957Sdrh         int endCoalesce = sqlite3VdbeMakeLabel(v);
3828ae6bb957Sdrh         assert( nFarg>=2 );
3829ae6bb957Sdrh         sqlite3ExprCode(pParse, pFarg->a[0].pExpr, target);
3830ae6bb957Sdrh         for(i=1; i<nFarg; i++){
3831ae6bb957Sdrh           sqlite3VdbeAddOp2(v, OP_NotNull, target, endCoalesce);
3832688852abSdrh           VdbeCoverage(v);
3833f49f3523Sdrh           sqlite3ExprCacheRemove(pParse, target, 1);
3834ae6bb957Sdrh           sqlite3ExprCachePush(pParse);
3835ae6bb957Sdrh           sqlite3ExprCode(pParse, pFarg->a[i].pExpr, target);
3836d2490904Sdrh           sqlite3ExprCachePop(pParse);
3837ae6bb957Sdrh         }
3838ae6bb957Sdrh         sqlite3VdbeResolveLabel(v, endCoalesce);
3839ae6bb957Sdrh         break;
3840ae6bb957Sdrh       }
3841ae6bb957Sdrh 
3842cca9f3d2Sdrh       /* The UNLIKELY() function is a no-op.  The result is the value
3843cca9f3d2Sdrh       ** of the first argument.
3844cca9f3d2Sdrh       */
3845cca9f3d2Sdrh       if( pDef->funcFlags & SQLITE_FUNC_UNLIKELY ){
3846cca9f3d2Sdrh         assert( nFarg>=1 );
3847c332cc30Sdrh         return sqlite3ExprCodeTarget(pParse, pFarg->a[0].pExpr, target);
3848cca9f3d2Sdrh       }
3849ae6bb957Sdrh 
385054240751Sdrh #ifdef SQLITE_DEBUG
3851a1a523a5Sdrh       /* The AFFINITY() function evaluates to a string that describes
3852a1a523a5Sdrh       ** the type affinity of the argument.  This is used for testing of
3853a1a523a5Sdrh       ** the SQLite type logic.
3854a1a523a5Sdrh       */
3855a1a523a5Sdrh       if( pDef->funcFlags & SQLITE_FUNC_AFFINITY ){
3856a1a523a5Sdrh         const char *azAff[] = { "blob", "text", "numeric", "integer", "real" };
3857a1a523a5Sdrh         char aff;
3858a1a523a5Sdrh         assert( nFarg==1 );
3859a1a523a5Sdrh         aff = sqlite3ExprAffinity(pFarg->a[0].pExpr);
3860a1a523a5Sdrh         sqlite3VdbeLoadString(v, target,
3861a1a523a5Sdrh                               aff ? azAff[aff-SQLITE_AFF_BLOB] : "none");
3862a1a523a5Sdrh         return target;
3863a1a523a5Sdrh       }
386454240751Sdrh #endif
3865a1a523a5Sdrh 
3866d1a01edaSdrh       for(i=0; i<nFarg; i++){
3867d1a01edaSdrh         if( i<32 && sqlite3ExprIsConstant(pFarg->a[i].pExpr) ){
3868693e6719Sdrh           testcase( i==31 );
3869693e6719Sdrh           constMask |= MASKBIT32(i);
3870d1a01edaSdrh         }
3871d1a01edaSdrh         if( (pDef->funcFlags & SQLITE_FUNC_NEEDCOLL)!=0 && !pColl ){
3872d1a01edaSdrh           pColl = sqlite3ExprCollSeq(pParse, pFarg->a[i].pExpr);
3873d1a01edaSdrh         }
3874d1a01edaSdrh       }
387512ffee8cSdrh       if( pFarg ){
3876d1a01edaSdrh         if( constMask ){
3877d1a01edaSdrh           r1 = pParse->nMem+1;
3878d1a01edaSdrh           pParse->nMem += nFarg;
3879d1a01edaSdrh         }else{
388012ffee8cSdrh           r1 = sqlite3GetTempRange(pParse, nFarg);
3881d1a01edaSdrh         }
3882a748fdccSdrh 
3883a748fdccSdrh         /* For length() and typeof() functions with a column argument,
3884a748fdccSdrh         ** set the P5 parameter to the OP_Column opcode to OPFLAG_LENGTHARG
3885a748fdccSdrh         ** or OPFLAG_TYPEOFARG respectively, to avoid unnecessary data
3886a748fdccSdrh         ** loading.
3887a748fdccSdrh         */
3888d36e1041Sdrh         if( (pDef->funcFlags & (SQLITE_FUNC_LENGTH|SQLITE_FUNC_TYPEOF))!=0 ){
38894e245a4cSdrh           u8 exprOp;
3890a748fdccSdrh           assert( nFarg==1 );
3891a748fdccSdrh           assert( pFarg->a[0].pExpr!=0 );
38924e245a4cSdrh           exprOp = pFarg->a[0].pExpr->op;
38934e245a4cSdrh           if( exprOp==TK_COLUMN || exprOp==TK_AGG_COLUMN ){
3894a748fdccSdrh             assert( SQLITE_FUNC_LENGTH==OPFLAG_LENGTHARG );
3895a748fdccSdrh             assert( SQLITE_FUNC_TYPEOF==OPFLAG_TYPEOFARG );
3896b1fba286Sdrh             testcase( pDef->funcFlags & OPFLAG_LENGTHARG );
3897b1fba286Sdrh             pFarg->a[0].pExpr->op2 =
3898b1fba286Sdrh                   pDef->funcFlags & (OPFLAG_LENGTHARG|OPFLAG_TYPEOFARG);
3899a748fdccSdrh           }
3900a748fdccSdrh         }
3901a748fdccSdrh 
3902d7d385ddSdrh         sqlite3ExprCachePush(pParse);     /* Ticket 2ea2425d34be */
39035579d59fSdrh         sqlite3ExprCodeExprList(pParse, pFarg, r1, 0,
3904d1a01edaSdrh                                 SQLITE_ECEL_DUP|SQLITE_ECEL_FACTOR);
3905d2490904Sdrh         sqlite3ExprCachePop(pParse);      /* Ticket 2ea2425d34be */
3906892d3179Sdrh       }else{
390712ffee8cSdrh         r1 = 0;
3908892d3179Sdrh       }
3909b7f6f68fSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
3910a43fa227Sdrh       /* Possibly overload the function if the first argument is
3911a43fa227Sdrh       ** a virtual table column.
3912a43fa227Sdrh       **
3913a43fa227Sdrh       ** For infix functions (LIKE, GLOB, REGEXP, and MATCH) use the
3914a43fa227Sdrh       ** second argument, not the first, as the argument to test to
3915a43fa227Sdrh       ** see if it is a column in a virtual table.  This is done because
3916a43fa227Sdrh       ** the left operand of infix functions (the operand we want to
3917a43fa227Sdrh       ** control overloading) ends up as the second argument to the
3918a43fa227Sdrh       ** function.  The expression "A glob B" is equivalent to
3919a43fa227Sdrh       ** "glob(B,A).  We want to use the A in "A glob B" to test
3920a43fa227Sdrh       ** for function overloading.  But we use the B term in "glob(B,A)".
3921a43fa227Sdrh       */
392212ffee8cSdrh       if( nFarg>=2 && (pExpr->flags & EP_InfixFunc) ){
392312ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[1].pExpr);
392412ffee8cSdrh       }else if( nFarg>0 ){
392512ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[0].pExpr);
3926b7f6f68fSdrh       }
3927b7f6f68fSdrh #endif
3928d36e1041Sdrh       if( pDef->funcFlags & SQLITE_FUNC_NEEDCOLL ){
39298b213899Sdrh         if( !pColl ) pColl = db->pDfltColl;
393066a5167bSdrh         sqlite3VdbeAddOp4(v, OP_CollSeq, 0, 0, 0, (char *)pColl, P4_COLLSEQ);
3931682f68b0Sdanielk1977       }
3932092457b1Sdrh #ifdef SQLITE_ENABLE_OFFSET_SQL_FUNC
3933092457b1Sdrh       if( pDef->funcFlags & SQLITE_FUNC_OFFSET ){
39342fc865c1Sdrh         Expr *pArg = pFarg->a[0].pExpr;
39352fc865c1Sdrh         if( pArg->op==TK_COLUMN ){
3936092457b1Sdrh           sqlite3VdbeAddOp3(v, OP_Offset, pArg->iTable, pArg->iColumn, target);
39372fc865c1Sdrh         }else{
39382fc865c1Sdrh           sqlite3VdbeAddOp2(v, OP_Null, 0, target);
39392fc865c1Sdrh         }
3940092457b1Sdrh       }else
3941092457b1Sdrh #endif
3942092457b1Sdrh       {
39433e34eabcSdrh         sqlite3VdbeAddOp4(v, pParse->iSelfTab ? OP_PureFunc0 : OP_Function0,
39443e34eabcSdrh                           constMask, r1, target, (char*)pDef, P4_FUNCDEF);
394512ffee8cSdrh         sqlite3VdbeChangeP5(v, (u8)nFarg);
39462fc865c1Sdrh       }
3947d1a01edaSdrh       if( nFarg && constMask==0 ){
394812ffee8cSdrh         sqlite3ReleaseTempRange(pParse, r1, nFarg);
39492dcef11bSdrh       }
3950c332cc30Sdrh       return target;
39516ec2733bSdrh     }
3952fe2093d7Sdrh #ifndef SQLITE_OMIT_SUBQUERY
3953fe2093d7Sdrh     case TK_EXISTS:
395419a775c2Sdrh     case TK_SELECT: {
39558da209b1Sdan       int nCol;
3956c5499befSdrh       testcase( op==TK_EXISTS );
3957c5499befSdrh       testcase( op==TK_SELECT );
39588da209b1Sdan       if( op==TK_SELECT && (nCol = pExpr->x.pSelect->pEList->nExpr)!=1 ){
39598da209b1Sdan         sqlite3SubselectError(pParse, nCol, 1);
39608da209b1Sdan       }else{
3961c332cc30Sdrh         return sqlite3CodeSubselect(pParse, pExpr, 0, 0);
39628da209b1Sdan       }
396319a775c2Sdrh       break;
396419a775c2Sdrh     }
3965fc7f27b9Sdrh     case TK_SELECT_COLUMN: {
3966966e2911Sdrh       int n;
3967fc7f27b9Sdrh       if( pExpr->pLeft->iTable==0 ){
3968fc7f27b9Sdrh         pExpr->pLeft->iTable = sqlite3CodeSubselect(pParse, pExpr->pLeft, 0, 0);
3969fc7f27b9Sdrh       }
3970966e2911Sdrh       assert( pExpr->iTable==0 || pExpr->pLeft->op==TK_SELECT );
3971966e2911Sdrh       if( pExpr->iTable
3972966e2911Sdrh        && pExpr->iTable!=(n = sqlite3ExprVectorSize(pExpr->pLeft))
3973966e2911Sdrh       ){
3974966e2911Sdrh         sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
3975966e2911Sdrh                                 pExpr->iTable, n);
3976966e2911Sdrh       }
3977c332cc30Sdrh       return pExpr->pLeft->iTable + pExpr->iColumn;
3978fc7f27b9Sdrh     }
3979fef5208cSdrh     case TK_IN: {
3980e3365e6cSdrh       int destIfFalse = sqlite3VdbeMakeLabel(v);
3981e3365e6cSdrh       int destIfNull = sqlite3VdbeMakeLabel(v);
3982e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3983e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
398466ba23ceSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
3985e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
3986e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_AddImm, target, 0);
3987e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfNull);
3988c332cc30Sdrh       return target;
3989fef5208cSdrh     }
3990e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
3991e3365e6cSdrh 
3992e3365e6cSdrh 
39932dcef11bSdrh     /*
39942dcef11bSdrh     **    x BETWEEN y AND z
39952dcef11bSdrh     **
39962dcef11bSdrh     ** This is equivalent to
39972dcef11bSdrh     **
39982dcef11bSdrh     **    x>=y AND x<=z
39992dcef11bSdrh     **
40002dcef11bSdrh     ** X is stored in pExpr->pLeft.
40012dcef11bSdrh     ** Y is stored in pExpr->pList->a[0].pExpr.
40022dcef11bSdrh     ** Z is stored in pExpr->pList->a[1].pExpr.
40032dcef11bSdrh     */
4004fef5208cSdrh     case TK_BETWEEN: {
400571c57db0Sdan       exprCodeBetween(pParse, pExpr, target, 0, 0);
4006c332cc30Sdrh       return target;
4007fef5208cSdrh     }
400894fa9c41Sdrh     case TK_SPAN:
4009ae80ddeaSdrh     case TK_COLLATE:
40104f07e5fbSdrh     case TK_UPLUS: {
40111efa8023Sdrh       pExpr = pExpr->pLeft;
401259ee43a7Sdrh       goto expr_code_doover; /* 2018-04-28: Prevent deep recursion. OSSFuzz. */
4013a2e00042Sdrh     }
40142dcef11bSdrh 
4015165921a7Sdan     case TK_TRIGGER: {
401665a7cd16Sdan       /* If the opcode is TK_TRIGGER, then the expression is a reference
401765a7cd16Sdan       ** to a column in the new.* or old.* pseudo-tables available to
401865a7cd16Sdan       ** trigger programs. In this case Expr.iTable is set to 1 for the
401965a7cd16Sdan       ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
402065a7cd16Sdan       ** is set to the column of the pseudo-table to read, or to -1 to
402165a7cd16Sdan       ** read the rowid field.
402265a7cd16Sdan       **
402365a7cd16Sdan       ** The expression is implemented using an OP_Param opcode. The p1
402465a7cd16Sdan       ** parameter is set to 0 for an old.rowid reference, or to (i+1)
402565a7cd16Sdan       ** to reference another column of the old.* pseudo-table, where
402665a7cd16Sdan       ** i is the index of the column. For a new.rowid reference, p1 is
402765a7cd16Sdan       ** set to (n+1), where n is the number of columns in each pseudo-table.
402865a7cd16Sdan       ** For a reference to any other column in the new.* pseudo-table, p1
402965a7cd16Sdan       ** is set to (n+2+i), where n and i are as defined previously. For
403065a7cd16Sdan       ** example, if the table on which triggers are being fired is
403165a7cd16Sdan       ** declared as:
403265a7cd16Sdan       **
403365a7cd16Sdan       **   CREATE TABLE t1(a, b);
403465a7cd16Sdan       **
403565a7cd16Sdan       ** Then p1 is interpreted as follows:
403665a7cd16Sdan       **
403765a7cd16Sdan       **   p1==0   ->    old.rowid     p1==3   ->    new.rowid
403865a7cd16Sdan       **   p1==1   ->    old.a         p1==4   ->    new.a
403965a7cd16Sdan       **   p1==2   ->    old.b         p1==5   ->    new.b
404065a7cd16Sdan       */
40412832ad42Sdan       Table *pTab = pExpr->pTab;
404265a7cd16Sdan       int p1 = pExpr->iTable * (pTab->nCol+1) + 1 + pExpr->iColumn;
404365a7cd16Sdan 
404465a7cd16Sdan       assert( pExpr->iTable==0 || pExpr->iTable==1 );
404565a7cd16Sdan       assert( pExpr->iColumn>=-1 && pExpr->iColumn<pTab->nCol );
404665a7cd16Sdan       assert( pTab->iPKey<0 || pExpr->iColumn!=pTab->iPKey );
404765a7cd16Sdan       assert( p1>=0 && p1<(pTab->nCol*2+2) );
404865a7cd16Sdan 
404965a7cd16Sdan       sqlite3VdbeAddOp2(v, OP_Param, p1, target);
4050896494e8Sdrh       VdbeComment((v, "r[%d]=%s.%s", target,
4051165921a7Sdan         (pExpr->iTable ? "new" : "old"),
4052896494e8Sdrh         (pExpr->iColumn<0 ? "rowid" : pExpr->pTab->aCol[pExpr->iColumn].zName)
4053165921a7Sdan       ));
405465a7cd16Sdan 
405544dbca83Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
405665a7cd16Sdan       /* If the column has REAL affinity, it may currently be stored as an
4057113762a2Sdrh       ** integer. Use OP_RealAffinity to make sure it is really real.
4058113762a2Sdrh       **
4059113762a2Sdrh       ** EVIDENCE-OF: R-60985-57662 SQLite will convert the value back to
4060113762a2Sdrh       ** floating point when extracting it from the record.  */
40612832ad42Sdan       if( pExpr->iColumn>=0
40622832ad42Sdan        && pTab->aCol[pExpr->iColumn].affinity==SQLITE_AFF_REAL
40632832ad42Sdan       ){
40642832ad42Sdan         sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
40652832ad42Sdan       }
406644dbca83Sdrh #endif
4067165921a7Sdan       break;
4068165921a7Sdan     }
4069165921a7Sdan 
407071c57db0Sdan     case TK_VECTOR: {
4071e835bc12Sdrh       sqlite3ErrorMsg(pParse, "row value misused");
407271c57db0Sdan       break;
407371c57db0Sdan     }
407471c57db0Sdan 
407531d6fd55Sdrh     case TK_IF_NULL_ROW: {
407631d6fd55Sdrh       int addrINR;
407731d6fd55Sdrh       addrINR = sqlite3VdbeAddOp1(v, OP_IfNullRow, pExpr->iTable);
407831d6fd55Sdrh       sqlite3ExprCachePush(pParse);
407931d6fd55Sdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
408031d6fd55Sdrh       sqlite3ExprCachePop(pParse);
408131d6fd55Sdrh       sqlite3VdbeJumpHere(v, addrINR);
408231d6fd55Sdrh       sqlite3VdbeChangeP3(v, addrINR, inReg);
408331d6fd55Sdrh       break;
408431d6fd55Sdrh     }
408531d6fd55Sdrh 
40862dcef11bSdrh     /*
40872dcef11bSdrh     ** Form A:
40882dcef11bSdrh     **   CASE x WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
40892dcef11bSdrh     **
40902dcef11bSdrh     ** Form B:
40912dcef11bSdrh     **   CASE WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
40922dcef11bSdrh     **
40932dcef11bSdrh     ** Form A is can be transformed into the equivalent form B as follows:
40942dcef11bSdrh     **   CASE WHEN x=e1 THEN r1 WHEN x=e2 THEN r2 ...
40952dcef11bSdrh     **        WHEN x=eN THEN rN ELSE y END
40962dcef11bSdrh     **
40972dcef11bSdrh     ** X (if it exists) is in pExpr->pLeft.
4098c5cd1249Sdrh     ** Y is in the last element of pExpr->x.pList if pExpr->x.pList->nExpr is
4099c5cd1249Sdrh     ** odd.  The Y is also optional.  If the number of elements in x.pList
4100c5cd1249Sdrh     ** is even, then Y is omitted and the "otherwise" result is NULL.
41012dcef11bSdrh     ** Ei is in pExpr->pList->a[i*2] and Ri is pExpr->pList->a[i*2+1].
41022dcef11bSdrh     **
41032dcef11bSdrh     ** The result of the expression is the Ri for the first matching Ei,
41042dcef11bSdrh     ** or if there is no matching Ei, the ELSE term Y, or if there is
41052dcef11bSdrh     ** no ELSE term, NULL.
41062dcef11bSdrh     */
410733cd4909Sdrh     default: assert( op==TK_CASE ); {
41082dcef11bSdrh       int endLabel;                     /* GOTO label for end of CASE stmt */
41092dcef11bSdrh       int nextCase;                     /* GOTO label for next WHEN clause */
41102dcef11bSdrh       int nExpr;                        /* 2x number of WHEN terms */
41112dcef11bSdrh       int i;                            /* Loop counter */
41122dcef11bSdrh       ExprList *pEList;                 /* List of WHEN terms */
41132dcef11bSdrh       struct ExprList_item *aListelem;  /* Array of WHEN terms */
41142dcef11bSdrh       Expr opCompare;                   /* The X==Ei expression */
41152dcef11bSdrh       Expr *pX;                         /* The X expression */
41161bd10f8aSdrh       Expr *pTest = 0;                  /* X==Ei (form A) or just Ei (form B) */
4117ceea3321Sdrh       VVA_ONLY( int iCacheLevel = pParse->iCacheLevel; )
411817a7f8ddSdrh 
41196ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) && pExpr->x.pList );
41206ab3a2ecSdanielk1977       assert(pExpr->x.pList->nExpr > 0);
41216ab3a2ecSdanielk1977       pEList = pExpr->x.pList;
4122be5c89acSdrh       aListelem = pEList->a;
4123be5c89acSdrh       nExpr = pEList->nExpr;
41242dcef11bSdrh       endLabel = sqlite3VdbeMakeLabel(v);
41252dcef11bSdrh       if( (pX = pExpr->pLeft)!=0 ){
412610d1edf0Sdrh         tempX = *pX;
412733cd4909Sdrh         testcase( pX->op==TK_COLUMN );
412812abf408Sdrh         exprToRegister(&tempX, exprCodeVector(pParse, &tempX, &regFree1));
4129c5499befSdrh         testcase( regFree1==0 );
4130abb9d5f1Sdrh         memset(&opCompare, 0, sizeof(opCompare));
41312dcef11bSdrh         opCompare.op = TK_EQ;
413210d1edf0Sdrh         opCompare.pLeft = &tempX;
41332dcef11bSdrh         pTest = &opCompare;
41348b1db07fSdrh         /* Ticket b351d95f9cd5ef17e9d9dbae18f5ca8611190001:
41358b1db07fSdrh         ** The value in regFree1 might get SCopy-ed into the file result.
41368b1db07fSdrh         ** So make sure that the regFree1 register is not reused for other
41378b1db07fSdrh         ** purposes and possibly overwritten.  */
41388b1db07fSdrh         regFree1 = 0;
4139cce7d176Sdrh       }
4140c5cd1249Sdrh       for(i=0; i<nExpr-1; i=i+2){
4141ceea3321Sdrh         sqlite3ExprCachePush(pParse);
41422dcef11bSdrh         if( pX ){
41431bd10f8aSdrh           assert( pTest!=0 );
41442dcef11bSdrh           opCompare.pRight = aListelem[i].pExpr;
4145f5905aa7Sdrh         }else{
41462dcef11bSdrh           pTest = aListelem[i].pExpr;
414717a7f8ddSdrh         }
41482dcef11bSdrh         nextCase = sqlite3VdbeMakeLabel(v);
414933cd4909Sdrh         testcase( pTest->op==TK_COLUMN );
41502dcef11bSdrh         sqlite3ExprIfFalse(pParse, pTest, nextCase, SQLITE_JUMPIFNULL);
4151c5499befSdrh         testcase( aListelem[i+1].pExpr->op==TK_COLUMN );
41529de221dfSdrh         sqlite3ExprCode(pParse, aListelem[i+1].pExpr, target);
4153076e85f5Sdrh         sqlite3VdbeGoto(v, endLabel);
4154d2490904Sdrh         sqlite3ExprCachePop(pParse);
41552dcef11bSdrh         sqlite3VdbeResolveLabel(v, nextCase);
4156f570f011Sdrh       }
4157c5cd1249Sdrh       if( (nExpr&1)!=0 ){
4158ceea3321Sdrh         sqlite3ExprCachePush(pParse);
4159c5cd1249Sdrh         sqlite3ExprCode(pParse, pEList->a[nExpr-1].pExpr, target);
4160d2490904Sdrh         sqlite3ExprCachePop(pParse);
416117a7f8ddSdrh       }else{
41629de221dfSdrh         sqlite3VdbeAddOp2(v, OP_Null, 0, target);
416317a7f8ddSdrh       }
4164c332cc30Sdrh       assert( pParse->db->mallocFailed || pParse->nErr>0
4165c1f4a19bSdanielk1977            || pParse->iCacheLevel==iCacheLevel );
41662dcef11bSdrh       sqlite3VdbeResolveLabel(v, endLabel);
41676f34903eSdanielk1977       break;
41686f34903eSdanielk1977     }
41695338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_TRIGGER
41706f34903eSdanielk1977     case TK_RAISE: {
4171165921a7Sdan       assert( pExpr->affinity==OE_Rollback
4172165921a7Sdan            || pExpr->affinity==OE_Abort
4173165921a7Sdan            || pExpr->affinity==OE_Fail
4174165921a7Sdan            || pExpr->affinity==OE_Ignore
4175165921a7Sdan       );
4176e0af83acSdan       if( !pParse->pTriggerTab ){
4177e0af83acSdan         sqlite3ErrorMsg(pParse,
4178e0af83acSdan                        "RAISE() may only be used within a trigger-program");
4179e0af83acSdan         return 0;
4180e0af83acSdan       }
4181e0af83acSdan       if( pExpr->affinity==OE_Abort ){
4182e0af83acSdan         sqlite3MayAbort(pParse);
4183e0af83acSdan       }
418433e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
4185e0af83acSdan       if( pExpr->affinity==OE_Ignore ){
4186e0af83acSdan         sqlite3VdbeAddOp4(
4187e0af83acSdan             v, OP_Halt, SQLITE_OK, OE_Ignore, 0, pExpr->u.zToken,0);
4188688852abSdrh         VdbeCoverage(v);
4189e0af83acSdan       }else{
4190433dccfbSdrh         sqlite3HaltConstraint(pParse, SQLITE_CONSTRAINT_TRIGGER,
4191f9c8ce3cSdrh                               pExpr->affinity, pExpr->u.zToken, 0, 0);
4192e0af83acSdan       }
4193e0af83acSdan 
4194ffe07b2dSdrh       break;
419517a7f8ddSdrh     }
41965338a5f7Sdanielk1977 #endif
4197ffe07b2dSdrh   }
41982dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
41992dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
42002dcef11bSdrh   return inReg;
42015b6afba9Sdrh }
42022dcef11bSdrh 
42032dcef11bSdrh /*
4204d1a01edaSdrh ** Factor out the code of the given expression to initialization time.
42051e9b53f9Sdrh **
4206ad879ffdSdrh ** If regDest>=0 then the result is always stored in that register and the
4207ad879ffdSdrh ** result is not reusable.  If regDest<0 then this routine is free to
4208ad879ffdSdrh ** store the value whereever it wants.  The register where the expression
4209ad879ffdSdrh ** is stored is returned.  When regDest<0, two identical expressions will
4210ad879ffdSdrh ** code to the same register.
4211d1a01edaSdrh */
42121e9b53f9Sdrh int sqlite3ExprCodeAtInit(
4213d673cddaSdrh   Parse *pParse,    /* Parsing context */
4214d673cddaSdrh   Expr *pExpr,      /* The expression to code when the VDBE initializes */
4215ad879ffdSdrh   int regDest       /* Store the value in this register */
4216d673cddaSdrh ){
4217d1a01edaSdrh   ExprList *p;
4218d9f158e7Sdrh   assert( ConstFactorOk(pParse) );
4219d1a01edaSdrh   p = pParse->pConstExpr;
4220ad879ffdSdrh   if( regDest<0 && p ){
42211e9b53f9Sdrh     struct ExprList_item *pItem;
42221e9b53f9Sdrh     int i;
42231e9b53f9Sdrh     for(pItem=p->a, i=p->nExpr; i>0; pItem++, i--){
42245aa550cfSdan       if( pItem->reusable && sqlite3ExprCompare(0,pItem->pExpr,pExpr,-1)==0 ){
42251e9b53f9Sdrh         return pItem->u.iConstExprReg;
42261e9b53f9Sdrh       }
42271e9b53f9Sdrh     }
42281e9b53f9Sdrh   }
4229d1a01edaSdrh   pExpr = sqlite3ExprDup(pParse->db, pExpr, 0);
4230d1a01edaSdrh   p = sqlite3ExprListAppend(pParse, p, pExpr);
4231d673cddaSdrh   if( p ){
4232d673cddaSdrh      struct ExprList_item *pItem = &p->a[p->nExpr-1];
4233ad879ffdSdrh      pItem->reusable = regDest<0;
4234ad879ffdSdrh      if( regDest<0 ) regDest = ++pParse->nMem;
4235d673cddaSdrh      pItem->u.iConstExprReg = regDest;
4236d673cddaSdrh   }
4237d1a01edaSdrh   pParse->pConstExpr = p;
42381e9b53f9Sdrh   return regDest;
4239d1a01edaSdrh }
4240d1a01edaSdrh 
4241d1a01edaSdrh /*
42422dcef11bSdrh ** Generate code to evaluate an expression and store the results
42432dcef11bSdrh ** into a register.  Return the register number where the results
42442dcef11bSdrh ** are stored.
42452dcef11bSdrh **
42462dcef11bSdrh ** If the register is a temporary register that can be deallocated,
4247678ccce8Sdrh ** then write its number into *pReg.  If the result register is not
42482dcef11bSdrh ** a temporary, then set *pReg to zero.
4249f30a969bSdrh **
4250f30a969bSdrh ** If pExpr is a constant, then this routine might generate this
4251f30a969bSdrh ** code to fill the register in the initialization section of the
4252f30a969bSdrh ** VDBE program, in order to factor it out of the evaluation loop.
42532dcef11bSdrh */
42542dcef11bSdrh int sqlite3ExprCodeTemp(Parse *pParse, Expr *pExpr, int *pReg){
4255f30a969bSdrh   int r2;
4256f30a969bSdrh   pExpr = sqlite3ExprSkipCollate(pExpr);
4257d9f158e7Sdrh   if( ConstFactorOk(pParse)
4258f30a969bSdrh    && pExpr->op!=TK_REGISTER
4259f30a969bSdrh    && sqlite3ExprIsConstantNotJoin(pExpr)
4260f30a969bSdrh   ){
4261f30a969bSdrh     *pReg  = 0;
4262ad879ffdSdrh     r2 = sqlite3ExprCodeAtInit(pParse, pExpr, -1);
4263f30a969bSdrh   }else{
42642dcef11bSdrh     int r1 = sqlite3GetTempReg(pParse);
4265f30a969bSdrh     r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
42662dcef11bSdrh     if( r2==r1 ){
42672dcef11bSdrh       *pReg = r1;
42682dcef11bSdrh     }else{
42692dcef11bSdrh       sqlite3ReleaseTempReg(pParse, r1);
42702dcef11bSdrh       *pReg = 0;
42712dcef11bSdrh     }
4272f30a969bSdrh   }
42732dcef11bSdrh   return r2;
42742dcef11bSdrh }
42752dcef11bSdrh 
42762dcef11bSdrh /*
42772dcef11bSdrh ** Generate code that will evaluate expression pExpr and store the
42782dcef11bSdrh ** results in register target.  The results are guaranteed to appear
42792dcef11bSdrh ** in register target.
42802dcef11bSdrh */
428105a86c5cSdrh void sqlite3ExprCode(Parse *pParse, Expr *pExpr, int target){
42829cbf3425Sdrh   int inReg;
42839cbf3425Sdrh 
42849cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
4285ebc16717Sdrh   if( pExpr && pExpr->op==TK_REGISTER ){
4286ebc16717Sdrh     sqlite3VdbeAddOp2(pParse->pVdbe, OP_Copy, pExpr->iTable, target);
4287ebc16717Sdrh   }else{
42889cbf3425Sdrh     inReg = sqlite3ExprCodeTarget(pParse, pExpr, target);
42891c75c9d7Sdrh     assert( pParse->pVdbe!=0 || pParse->db->mallocFailed );
42900e359b30Sdrh     if( inReg!=target && pParse->pVdbe ){
42919cbf3425Sdrh       sqlite3VdbeAddOp2(pParse->pVdbe, OP_SCopy, inReg, target);
429217a7f8ddSdrh     }
4293ebc16717Sdrh   }
4294cce7d176Sdrh }
4295cce7d176Sdrh 
4296cce7d176Sdrh /*
42971c75c9d7Sdrh ** Make a transient copy of expression pExpr and then code it using
42981c75c9d7Sdrh ** sqlite3ExprCode().  This routine works just like sqlite3ExprCode()
42991c75c9d7Sdrh ** except that the input expression is guaranteed to be unchanged.
43001c75c9d7Sdrh */
43011c75c9d7Sdrh void sqlite3ExprCodeCopy(Parse *pParse, Expr *pExpr, int target){
43021c75c9d7Sdrh   sqlite3 *db = pParse->db;
43031c75c9d7Sdrh   pExpr = sqlite3ExprDup(db, pExpr, 0);
43041c75c9d7Sdrh   if( !db->mallocFailed ) sqlite3ExprCode(pParse, pExpr, target);
43051c75c9d7Sdrh   sqlite3ExprDelete(db, pExpr);
43061c75c9d7Sdrh }
43071c75c9d7Sdrh 
43081c75c9d7Sdrh /*
430905a86c5cSdrh ** Generate code that will evaluate expression pExpr and store the
431005a86c5cSdrh ** results in register target.  The results are guaranteed to appear
431105a86c5cSdrh ** in register target.  If the expression is constant, then this routine
431205a86c5cSdrh ** might choose to code the expression at initialization time.
431305a86c5cSdrh */
431405a86c5cSdrh void sqlite3ExprCodeFactorable(Parse *pParse, Expr *pExpr, int target){
431505a86c5cSdrh   if( pParse->okConstFactor && sqlite3ExprIsConstant(pExpr) ){
4316ad879ffdSdrh     sqlite3ExprCodeAtInit(pParse, pExpr, target);
431705a86c5cSdrh   }else{
431805a86c5cSdrh     sqlite3ExprCode(pParse, pExpr, target);
431905a86c5cSdrh   }
4320cce7d176Sdrh }
4321cce7d176Sdrh 
4322cce7d176Sdrh /*
432360ec914cSpeter.d.reid ** Generate code that evaluates the given expression and puts the result
4324de4fcfddSdrh ** in register target.
432525303780Sdrh **
43262dcef11bSdrh ** Also make a copy of the expression results into another "cache" register
43272dcef11bSdrh ** and modify the expression so that the next time it is evaluated,
43282dcef11bSdrh ** the result is a copy of the cache register.
43292dcef11bSdrh **
43302dcef11bSdrh ** This routine is used for expressions that are used multiple
43312dcef11bSdrh ** times.  They are evaluated once and the results of the expression
43322dcef11bSdrh ** are reused.
433325303780Sdrh */
433405a86c5cSdrh void sqlite3ExprCodeAndCache(Parse *pParse, Expr *pExpr, int target){
433525303780Sdrh   Vdbe *v = pParse->pVdbe;
433625303780Sdrh   int iMem;
433705a86c5cSdrh 
433805a86c5cSdrh   assert( target>0 );
433905a86c5cSdrh   assert( pExpr->op!=TK_REGISTER );
434005a86c5cSdrh   sqlite3ExprCode(pParse, pExpr, target);
43412dcef11bSdrh   iMem = ++pParse->nMem;
434205a86c5cSdrh   sqlite3VdbeAddOp2(v, OP_Copy, target, iMem);
4343a4c3c87eSdrh   exprToRegister(pExpr, iMem);
434425303780Sdrh }
43457e02e5e6Sdrh 
4346678ccce8Sdrh /*
4347268380caSdrh ** Generate code that pushes the value of every element of the given
43489cbf3425Sdrh ** expression list into a sequence of registers beginning at target.
4349268380caSdrh **
43503df6c3b1Sdrh ** Return the number of elements evaluated.  The number returned will
43513df6c3b1Sdrh ** usually be pList->nExpr but might be reduced if SQLITE_ECEL_OMITREF
43523df6c3b1Sdrh ** is defined.
4353d1a01edaSdrh **
4354d1a01edaSdrh ** The SQLITE_ECEL_DUP flag prevents the arguments from being
4355d1a01edaSdrh ** filled using OP_SCopy.  OP_Copy must be used instead.
4356d1a01edaSdrh **
4357d1a01edaSdrh ** The SQLITE_ECEL_FACTOR argument allows constant arguments to be
4358d1a01edaSdrh ** factored out into initialization code.
4359b0df9634Sdrh **
4360b0df9634Sdrh ** The SQLITE_ECEL_REF flag means that expressions in the list with
4361b0df9634Sdrh ** ExprList.a[].u.x.iOrderByCol>0 have already been evaluated and stored
4362b0df9634Sdrh ** in registers at srcReg, and so the value can be copied from there.
43633df6c3b1Sdrh ** If SQLITE_ECEL_OMITREF is also set, then the values with u.x.iOrderByCol>0
43643df6c3b1Sdrh ** are simply omitted rather than being copied from srcReg.
4365268380caSdrh */
43664adee20fSdanielk1977 int sqlite3ExprCodeExprList(
4367268380caSdrh   Parse *pParse,     /* Parsing context */
4368389a1adbSdrh   ExprList *pList,   /* The expression list to be coded */
4369191b54cbSdrh   int target,        /* Where to write results */
43705579d59fSdrh   int srcReg,        /* Source registers if SQLITE_ECEL_REF */
4371d1a01edaSdrh   u8 flags           /* SQLITE_ECEL_* flags */
4372268380caSdrh ){
4373268380caSdrh   struct ExprList_item *pItem;
43745579d59fSdrh   int i, j, n;
4375d1a01edaSdrh   u8 copyOp = (flags & SQLITE_ECEL_DUP) ? OP_Copy : OP_SCopy;
43765579d59fSdrh   Vdbe *v = pParse->pVdbe;
43779d8b3072Sdrh   assert( pList!=0 );
43789cbf3425Sdrh   assert( target>0 );
4379d81a142bSdrh   assert( pParse->pVdbe!=0 );  /* Never gets this far otherwise */
4380268380caSdrh   n = pList->nExpr;
4381d9f158e7Sdrh   if( !ConstFactorOk(pParse) ) flags &= ~SQLITE_ECEL_FACTOR;
4382191b54cbSdrh   for(pItem=pList->a, i=0; i<n; i++, pItem++){
43837445ffe2Sdrh     Expr *pExpr = pItem->pExpr;
438424e25d32Sdan #ifdef SQLITE_ENABLE_SORTER_REFERENCES
438524e25d32Sdan     if( pItem->bSorterRef ){
438624e25d32Sdan       i--;
438724e25d32Sdan       n--;
438824e25d32Sdan     }else
438924e25d32Sdan #endif
4390257c13faSdan     if( (flags & SQLITE_ECEL_REF)!=0 && (j = pItem->u.x.iOrderByCol)>0 ){
4391257c13faSdan       if( flags & SQLITE_ECEL_OMITREF ){
4392257c13faSdan         i--;
4393257c13faSdan         n--;
4394257c13faSdan       }else{
43955579d59fSdrh         sqlite3VdbeAddOp2(v, copyOp, j+srcReg-1, target+i);
4396257c13faSdan       }
43975579d59fSdrh     }else if( (flags & SQLITE_ECEL_FACTOR)!=0 && sqlite3ExprIsConstant(pExpr) ){
4398ad879ffdSdrh       sqlite3ExprCodeAtInit(pParse, pExpr, target+i);
4399d1a01edaSdrh     }else{
44007445ffe2Sdrh       int inReg = sqlite3ExprCodeTarget(pParse, pExpr, target+i);
4401746fd9ccSdrh       if( inReg!=target+i ){
44024eded604Sdrh         VdbeOp *pOp;
44034eded604Sdrh         if( copyOp==OP_Copy
44044eded604Sdrh          && (pOp=sqlite3VdbeGetOp(v, -1))->opcode==OP_Copy
44054eded604Sdrh          && pOp->p1+pOp->p3+1==inReg
44064eded604Sdrh          && pOp->p2+pOp->p3+1==target+i
44074eded604Sdrh         ){
44084eded604Sdrh           pOp->p3++;
44094eded604Sdrh         }else{
44104eded604Sdrh           sqlite3VdbeAddOp2(v, copyOp, inReg, target+i);
44114eded604Sdrh         }
4412d1a01edaSdrh       }
4413d176611bSdrh     }
4414268380caSdrh   }
4415f9b596ebSdrh   return n;
4416268380caSdrh }
4417268380caSdrh 
4418268380caSdrh /*
441936c563a2Sdrh ** Generate code for a BETWEEN operator.
442036c563a2Sdrh **
442136c563a2Sdrh **    x BETWEEN y AND z
442236c563a2Sdrh **
442336c563a2Sdrh ** The above is equivalent to
442436c563a2Sdrh **
442536c563a2Sdrh **    x>=y AND x<=z
442636c563a2Sdrh **
442736c563a2Sdrh ** Code it as such, taking care to do the common subexpression
442860ec914cSpeter.d.reid ** elimination of x.
442984b19a3dSdrh **
443084b19a3dSdrh ** The xJumpIf parameter determines details:
443184b19a3dSdrh **
443284b19a3dSdrh **    NULL:                   Store the boolean result in reg[dest]
443384b19a3dSdrh **    sqlite3ExprIfTrue:      Jump to dest if true
443484b19a3dSdrh **    sqlite3ExprIfFalse:     Jump to dest if false
443584b19a3dSdrh **
443684b19a3dSdrh ** The jumpIfNull parameter is ignored if xJumpIf is NULL.
443736c563a2Sdrh */
443836c563a2Sdrh static void exprCodeBetween(
443936c563a2Sdrh   Parse *pParse,    /* Parsing and code generating context */
444036c563a2Sdrh   Expr *pExpr,      /* The BETWEEN expression */
444184b19a3dSdrh   int dest,         /* Jump destination or storage location */
444284b19a3dSdrh   void (*xJump)(Parse*,Expr*,int,int), /* Action to take */
444336c563a2Sdrh   int jumpIfNull    /* Take the jump if the BETWEEN is NULL */
444436c563a2Sdrh ){
444536c563a2Sdrh  Expr exprAnd;     /* The AND operator in  x>=y AND x<=z  */
444636c563a2Sdrh   Expr compLeft;    /* The  x>=y  term */
444736c563a2Sdrh   Expr compRight;   /* The  x<=z  term */
4448db45bd5eSdrh   Expr exprX;       /* The  x  subexpression */
4449db45bd5eSdrh   int regFree1 = 0; /* Temporary use register */
445084b19a3dSdrh 
445136c563a2Sdrh 
445271c57db0Sdan   memset(&compLeft, 0, sizeof(Expr));
445371c57db0Sdan   memset(&compRight, 0, sizeof(Expr));
445471c57db0Sdan   memset(&exprAnd, 0, sizeof(Expr));
4455db45bd5eSdrh 
4456db45bd5eSdrh   assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
4457db45bd5eSdrh   exprX = *pExpr->pLeft;
445836c563a2Sdrh   exprAnd.op = TK_AND;
445936c563a2Sdrh   exprAnd.pLeft = &compLeft;
446036c563a2Sdrh   exprAnd.pRight = &compRight;
446136c563a2Sdrh   compLeft.op = TK_GE;
4462db45bd5eSdrh   compLeft.pLeft = &exprX;
446336c563a2Sdrh   compLeft.pRight = pExpr->x.pList->a[0].pExpr;
446436c563a2Sdrh   compRight.op = TK_LE;
4465db45bd5eSdrh   compRight.pLeft = &exprX;
446636c563a2Sdrh   compRight.pRight = pExpr->x.pList->a[1].pExpr;
446712abf408Sdrh   exprToRegister(&exprX, exprCodeVector(pParse, &exprX, &regFree1));
446884b19a3dSdrh   if( xJump ){
446984b19a3dSdrh     xJump(pParse, &exprAnd, dest, jumpIfNull);
447036c563a2Sdrh   }else{
447136fd41e5Sdrh     /* Mark the expression is being from the ON or USING clause of a join
447236fd41e5Sdrh     ** so that the sqlite3ExprCodeTarget() routine will not attempt to move
447336fd41e5Sdrh     ** it into the Parse.pConstExpr list.  We should use a new bit for this,
447436fd41e5Sdrh     ** for clarity, but we are out of bits in the Expr.flags field so we
447536fd41e5Sdrh     ** have to reuse the EP_FromJoin bit.  Bummer. */
4476db45bd5eSdrh     exprX.flags |= EP_FromJoin;
447771c57db0Sdan     sqlite3ExprCodeTarget(pParse, &exprAnd, dest);
447836c563a2Sdrh   }
4479db45bd5eSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
448036c563a2Sdrh 
448136c563a2Sdrh   /* Ensure adequate test coverage */
4482db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull==0 && regFree1==0 );
4483db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull==0 && regFree1!=0 );
4484db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull!=0 && regFree1==0 );
4485db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull!=0 && regFree1!=0 );
4486db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1==0 );
4487db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1!=0 );
4488db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1==0 );
4489db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1!=0 );
449084b19a3dSdrh   testcase( xJump==0 );
449136c563a2Sdrh }
449236c563a2Sdrh 
449336c563a2Sdrh /*
4494cce7d176Sdrh ** Generate code for a boolean expression such that a jump is made
4495cce7d176Sdrh ** to the label "dest" if the expression is true but execution
4496cce7d176Sdrh ** continues straight thru if the expression is false.
4497f5905aa7Sdrh **
4498f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false), then
449935573356Sdrh ** take the jump if the jumpIfNull flag is SQLITE_JUMPIFNULL.
4500f2bc013cSdrh **
4501f2bc013cSdrh ** This code depends on the fact that certain token values (ex: TK_EQ)
4502f2bc013cSdrh ** are the same as opcode values (ex: OP_Eq) that implement the corresponding
4503f2bc013cSdrh ** operation.  Special comments in vdbe.c and the mkopcodeh.awk script in
4504f2bc013cSdrh ** the make process cause these values to align.  Assert()s in the code
4505f2bc013cSdrh ** below verify that the numbers are aligned correctly.
4506cce7d176Sdrh */
45074adee20fSdanielk1977 void sqlite3ExprIfTrue(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
4508cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
4509cce7d176Sdrh   int op = 0;
45102dcef11bSdrh   int regFree1 = 0;
45112dcef11bSdrh   int regFree2 = 0;
45122dcef11bSdrh   int r1, r2;
45132dcef11bSdrh 
451435573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
451548864df9Smistachkin   if( NEVER(v==0) )     return;  /* Existence of VDBE checked by caller */
451633cd4909Sdrh   if( NEVER(pExpr==0) ) return;  /* No way this can happen */
4517f2bc013cSdrh   op = pExpr->op;
45187b35a77bSdan   switch( op ){
4519cce7d176Sdrh     case TK_AND: {
45204adee20fSdanielk1977       int d2 = sqlite3VdbeMakeLabel(v);
4521c5499befSdrh       testcase( jumpIfNull==0 );
452235573356Sdrh       sqlite3ExprIfFalse(pParse, pExpr->pLeft, d2,jumpIfNull^SQLITE_JUMPIFNULL);
452354e2adb5Sdrh       sqlite3ExprCachePush(pParse);
45244adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
45254adee20fSdanielk1977       sqlite3VdbeResolveLabel(v, d2);
4526d2490904Sdrh       sqlite3ExprCachePop(pParse);
4527cce7d176Sdrh       break;
4528cce7d176Sdrh     }
4529cce7d176Sdrh     case TK_OR: {
4530c5499befSdrh       testcase( jumpIfNull==0 );
45314adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
453254e2adb5Sdrh       sqlite3ExprCachePush(pParse);
45334adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
4534d2490904Sdrh       sqlite3ExprCachePop(pParse);
4535cce7d176Sdrh       break;
4536cce7d176Sdrh     }
4537cce7d176Sdrh     case TK_NOT: {
4538c5499befSdrh       testcase( jumpIfNull==0 );
45394adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
4540cce7d176Sdrh       break;
4541cce7d176Sdrh     }
45428abed7b9Sdrh     case TK_TRUTH: {
454396acafbeSdrh       int isNot;      /* IS NOT TRUE or IS NOT FALSE */
454496acafbeSdrh       int isTrue;     /* IS TRUE or IS NOT TRUE */
4545007c843bSdrh       testcase( jumpIfNull==0 );
45468abed7b9Sdrh       isNot = pExpr->op2==TK_ISNOT;
454796acafbeSdrh       isTrue = sqlite3ExprTruthValue(pExpr->pRight);
454843c4ac8bSdrh       testcase( isTrue && isNot );
454996acafbeSdrh       testcase( !isTrue && isNot );
455043c4ac8bSdrh       if( isTrue ^ isNot ){
45518abed7b9Sdrh         sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
45528abed7b9Sdrh                           isNot ? SQLITE_JUMPIFNULL : 0);
45538abed7b9Sdrh       }else{
45548abed7b9Sdrh         sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
45558abed7b9Sdrh                            isNot ? SQLITE_JUMPIFNULL : 0);
45568abed7b9Sdrh       }
4557007c843bSdrh       break;
4558007c843bSdrh     }
4559de845c2fSdrh     case TK_IS:
4560de845c2fSdrh     case TK_ISNOT:
4561de845c2fSdrh       testcase( op==TK_IS );
4562de845c2fSdrh       testcase( op==TK_ISNOT );
4563de845c2fSdrh       op = (op==TK_IS) ? TK_EQ : TK_NE;
4564de845c2fSdrh       jumpIfNull = SQLITE_NULLEQ;
4565de845c2fSdrh       /* Fall thru */
4566cce7d176Sdrh     case TK_LT:
4567cce7d176Sdrh     case TK_LE:
4568cce7d176Sdrh     case TK_GT:
4569cce7d176Sdrh     case TK_GE:
4570cce7d176Sdrh     case TK_NE:
45710ac65892Sdrh     case TK_EQ: {
4572625015e0Sdan       if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
4573c5499befSdrh       testcase( jumpIfNull==0 );
4574b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4575b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
457635573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
45772dcef11bSdrh                   r1, r2, dest, jumpIfNull);
45787d176105Sdrh       assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
45797d176105Sdrh       assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
45807d176105Sdrh       assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
45817d176105Sdrh       assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
4582de845c2fSdrh       assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4583de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4584de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4585de845c2fSdrh       assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4586de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
4587de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
45886a2fe093Sdrh       testcase( regFree1==0 );
45896a2fe093Sdrh       testcase( regFree2==0 );
45906a2fe093Sdrh       break;
45916a2fe093Sdrh     }
4592cce7d176Sdrh     case TK_ISNULL:
4593cce7d176Sdrh     case TK_NOTNULL: {
45947d176105Sdrh       assert( TK_ISNULL==OP_IsNull );   testcase( op==TK_ISNULL );
45957d176105Sdrh       assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
45962dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
45972dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
45987d176105Sdrh       VdbeCoverageIf(v, op==TK_ISNULL);
45997d176105Sdrh       VdbeCoverageIf(v, op==TK_NOTNULL);
4600c5499befSdrh       testcase( regFree1==0 );
4601cce7d176Sdrh       break;
4602cce7d176Sdrh     }
4603fef5208cSdrh     case TK_BETWEEN: {
46045c03f30aSdrh       testcase( jumpIfNull==0 );
460571c57db0Sdan       exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfTrue, jumpIfNull);
4606fef5208cSdrh       break;
4607fef5208cSdrh     }
4608bb201344Sshaneh #ifndef SQLITE_OMIT_SUBQUERY
4609e3365e6cSdrh     case TK_IN: {
4610e3365e6cSdrh       int destIfFalse = sqlite3VdbeMakeLabel(v);
4611e3365e6cSdrh       int destIfNull = jumpIfNull ? dest : destIfFalse;
4612e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
4613076e85f5Sdrh       sqlite3VdbeGoto(v, dest);
4614e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
4615e3365e6cSdrh       break;
4616e3365e6cSdrh     }
4617bb201344Sshaneh #endif
4618cce7d176Sdrh     default: {
46197b35a77bSdan     default_expr:
4620991a1985Sdrh       if( exprAlwaysTrue(pExpr) ){
4621076e85f5Sdrh         sqlite3VdbeGoto(v, dest);
4622991a1985Sdrh       }else if( exprAlwaysFalse(pExpr) ){
4623991a1985Sdrh         /* No-op */
4624991a1985Sdrh       }else{
46252dcef11bSdrh         r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
46262dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_If, r1, dest, jumpIfNull!=0);
4627688852abSdrh         VdbeCoverage(v);
4628c5499befSdrh         testcase( regFree1==0 );
4629c5499befSdrh         testcase( jumpIfNull==0 );
4630991a1985Sdrh       }
4631cce7d176Sdrh       break;
4632cce7d176Sdrh     }
4633cce7d176Sdrh   }
46342dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
46352dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
4636cce7d176Sdrh }
4637cce7d176Sdrh 
4638cce7d176Sdrh /*
463966b89c8fSdrh ** Generate code for a boolean expression such that a jump is made
4640cce7d176Sdrh ** to the label "dest" if the expression is false but execution
4641cce7d176Sdrh ** continues straight thru if the expression is true.
4642f5905aa7Sdrh **
4643f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false) then
464435573356Sdrh ** jump if jumpIfNull is SQLITE_JUMPIFNULL or fall through if jumpIfNull
464535573356Sdrh ** is 0.
4646cce7d176Sdrh */
46474adee20fSdanielk1977 void sqlite3ExprIfFalse(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
4648cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
4649cce7d176Sdrh   int op = 0;
46502dcef11bSdrh   int regFree1 = 0;
46512dcef11bSdrh   int regFree2 = 0;
46522dcef11bSdrh   int r1, r2;
46532dcef11bSdrh 
465435573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
465548864df9Smistachkin   if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
465633cd4909Sdrh   if( pExpr==0 )    return;
4657f2bc013cSdrh 
4658f2bc013cSdrh   /* The value of pExpr->op and op are related as follows:
4659f2bc013cSdrh   **
4660f2bc013cSdrh   **       pExpr->op            op
4661f2bc013cSdrh   **       ---------          ----------
4662f2bc013cSdrh   **       TK_ISNULL          OP_NotNull
4663f2bc013cSdrh   **       TK_NOTNULL         OP_IsNull
4664f2bc013cSdrh   **       TK_NE              OP_Eq
4665f2bc013cSdrh   **       TK_EQ              OP_Ne
4666f2bc013cSdrh   **       TK_GT              OP_Le
4667f2bc013cSdrh   **       TK_LE              OP_Gt
4668f2bc013cSdrh   **       TK_GE              OP_Lt
4669f2bc013cSdrh   **       TK_LT              OP_Ge
4670f2bc013cSdrh   **
4671f2bc013cSdrh   ** For other values of pExpr->op, op is undefined and unused.
4672f2bc013cSdrh   ** The value of TK_ and OP_ constants are arranged such that we
4673f2bc013cSdrh   ** can compute the mapping above using the following expression.
4674f2bc013cSdrh   ** Assert()s verify that the computation is correct.
4675f2bc013cSdrh   */
4676f2bc013cSdrh   op = ((pExpr->op+(TK_ISNULL&1))^1)-(TK_ISNULL&1);
4677f2bc013cSdrh 
4678f2bc013cSdrh   /* Verify correct alignment of TK_ and OP_ constants
4679f2bc013cSdrh   */
4680f2bc013cSdrh   assert( pExpr->op!=TK_ISNULL || op==OP_NotNull );
4681f2bc013cSdrh   assert( pExpr->op!=TK_NOTNULL || op==OP_IsNull );
4682f2bc013cSdrh   assert( pExpr->op!=TK_NE || op==OP_Eq );
4683f2bc013cSdrh   assert( pExpr->op!=TK_EQ || op==OP_Ne );
4684f2bc013cSdrh   assert( pExpr->op!=TK_LT || op==OP_Ge );
4685f2bc013cSdrh   assert( pExpr->op!=TK_LE || op==OP_Gt );
4686f2bc013cSdrh   assert( pExpr->op!=TK_GT || op==OP_Le );
4687f2bc013cSdrh   assert( pExpr->op!=TK_GE || op==OP_Lt );
4688f2bc013cSdrh 
4689ba00e30aSdan   switch( pExpr->op ){
4690cce7d176Sdrh     case TK_AND: {
4691c5499befSdrh       testcase( jumpIfNull==0 );
46924adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
469354e2adb5Sdrh       sqlite3ExprCachePush(pParse);
46944adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
4695d2490904Sdrh       sqlite3ExprCachePop(pParse);
4696cce7d176Sdrh       break;
4697cce7d176Sdrh     }
4698cce7d176Sdrh     case TK_OR: {
46994adee20fSdanielk1977       int d2 = sqlite3VdbeMakeLabel(v);
4700c5499befSdrh       testcase( jumpIfNull==0 );
470135573356Sdrh       sqlite3ExprIfTrue(pParse, pExpr->pLeft, d2, jumpIfNull^SQLITE_JUMPIFNULL);
470254e2adb5Sdrh       sqlite3ExprCachePush(pParse);
47034adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
47044adee20fSdanielk1977       sqlite3VdbeResolveLabel(v, d2);
4705d2490904Sdrh       sqlite3ExprCachePop(pParse);
4706cce7d176Sdrh       break;
4707cce7d176Sdrh     }
4708cce7d176Sdrh     case TK_NOT: {
47095c03f30aSdrh       testcase( jumpIfNull==0 );
47104adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
4711cce7d176Sdrh       break;
4712cce7d176Sdrh     }
47138abed7b9Sdrh     case TK_TRUTH: {
471496acafbeSdrh       int isNot;   /* IS NOT TRUE or IS NOT FALSE */
471596acafbeSdrh       int isTrue;  /* IS TRUE or IS NOT TRUE */
47168abed7b9Sdrh       testcase( jumpIfNull==0 );
47178abed7b9Sdrh       isNot = pExpr->op2==TK_ISNOT;
471896acafbeSdrh       isTrue = sqlite3ExprTruthValue(pExpr->pRight);
471943c4ac8bSdrh       testcase( isTrue && isNot );
472096acafbeSdrh       testcase( !isTrue && isNot );
472143c4ac8bSdrh       if( isTrue ^ isNot ){
47228abed7b9Sdrh         /* IS TRUE and IS NOT FALSE */
47238abed7b9Sdrh         sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
47248abed7b9Sdrh                            isNot ? 0 : SQLITE_JUMPIFNULL);
47258abed7b9Sdrh 
47268abed7b9Sdrh       }else{
47278abed7b9Sdrh         /* IS FALSE and IS NOT TRUE */
47288abed7b9Sdrh         sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
47298abed7b9Sdrh                           isNot ? 0 : SQLITE_JUMPIFNULL);
47308abed7b9Sdrh       }
4731007c843bSdrh       break;
4732007c843bSdrh     }
4733de845c2fSdrh     case TK_IS:
4734de845c2fSdrh     case TK_ISNOT:
4735de845c2fSdrh       testcase( pExpr->op==TK_IS );
4736de845c2fSdrh       testcase( pExpr->op==TK_ISNOT );
4737de845c2fSdrh       op = (pExpr->op==TK_IS) ? TK_NE : TK_EQ;
4738de845c2fSdrh       jumpIfNull = SQLITE_NULLEQ;
4739de845c2fSdrh       /* Fall thru */
4740cce7d176Sdrh     case TK_LT:
4741cce7d176Sdrh     case TK_LE:
4742cce7d176Sdrh     case TK_GT:
4743cce7d176Sdrh     case TK_GE:
4744cce7d176Sdrh     case TK_NE:
4745cce7d176Sdrh     case TK_EQ: {
4746625015e0Sdan       if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
4747c5499befSdrh       testcase( jumpIfNull==0 );
4748b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4749b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
475035573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
47512dcef11bSdrh                   r1, r2, dest, jumpIfNull);
47527d176105Sdrh       assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
47537d176105Sdrh       assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
47547d176105Sdrh       assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
47557d176105Sdrh       assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
4756de845c2fSdrh       assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4757de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4758de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4759de845c2fSdrh       assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4760de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
4761de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
47626a2fe093Sdrh       testcase( regFree1==0 );
47636a2fe093Sdrh       testcase( regFree2==0 );
47646a2fe093Sdrh       break;
47656a2fe093Sdrh     }
4766cce7d176Sdrh     case TK_ISNULL:
4767cce7d176Sdrh     case TK_NOTNULL: {
47682dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
47692dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
47707d176105Sdrh       testcase( op==TK_ISNULL );   VdbeCoverageIf(v, op==TK_ISNULL);
47717d176105Sdrh       testcase( op==TK_NOTNULL );  VdbeCoverageIf(v, op==TK_NOTNULL);
4772c5499befSdrh       testcase( regFree1==0 );
4773cce7d176Sdrh       break;
4774cce7d176Sdrh     }
4775fef5208cSdrh     case TK_BETWEEN: {
47765c03f30aSdrh       testcase( jumpIfNull==0 );
477771c57db0Sdan       exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfFalse, jumpIfNull);
4778fef5208cSdrh       break;
4779fef5208cSdrh     }
4780bb201344Sshaneh #ifndef SQLITE_OMIT_SUBQUERY
4781e3365e6cSdrh     case TK_IN: {
4782e3365e6cSdrh       if( jumpIfNull ){
4783e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, dest);
4784e3365e6cSdrh       }else{
4785e3365e6cSdrh         int destIfNull = sqlite3VdbeMakeLabel(v);
4786e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, destIfNull);
4787e3365e6cSdrh         sqlite3VdbeResolveLabel(v, destIfNull);
4788e3365e6cSdrh       }
4789e3365e6cSdrh       break;
4790e3365e6cSdrh     }
4791bb201344Sshaneh #endif
4792cce7d176Sdrh     default: {
4793ba00e30aSdan     default_expr:
4794991a1985Sdrh       if( exprAlwaysFalse(pExpr) ){
4795076e85f5Sdrh         sqlite3VdbeGoto(v, dest);
4796991a1985Sdrh       }else if( exprAlwaysTrue(pExpr) ){
4797991a1985Sdrh         /* no-op */
4798991a1985Sdrh       }else{
47992dcef11bSdrh         r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
48002dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_IfNot, r1, dest, jumpIfNull!=0);
4801688852abSdrh         VdbeCoverage(v);
4802c5499befSdrh         testcase( regFree1==0 );
4803c5499befSdrh         testcase( jumpIfNull==0 );
4804991a1985Sdrh       }
4805cce7d176Sdrh       break;
4806cce7d176Sdrh     }
4807cce7d176Sdrh   }
48082dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
48092dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
4810cce7d176Sdrh }
48112282792aSdrh 
48122282792aSdrh /*
481372bc8208Sdrh ** Like sqlite3ExprIfFalse() except that a copy is made of pExpr before
481472bc8208Sdrh ** code generation, and that copy is deleted after code generation. This
481572bc8208Sdrh ** ensures that the original pExpr is unchanged.
481672bc8208Sdrh */
481772bc8208Sdrh void sqlite3ExprIfFalseDup(Parse *pParse, Expr *pExpr, int dest,int jumpIfNull){
481872bc8208Sdrh   sqlite3 *db = pParse->db;
481972bc8208Sdrh   Expr *pCopy = sqlite3ExprDup(db, pExpr, 0);
482072bc8208Sdrh   if( db->mallocFailed==0 ){
482172bc8208Sdrh     sqlite3ExprIfFalse(pParse, pCopy, dest, jumpIfNull);
482272bc8208Sdrh   }
482372bc8208Sdrh   sqlite3ExprDelete(db, pCopy);
482472bc8208Sdrh }
482572bc8208Sdrh 
48265aa550cfSdan /*
48275aa550cfSdan ** Expression pVar is guaranteed to be an SQL variable. pExpr may be any
48285aa550cfSdan ** type of expression.
48295aa550cfSdan **
48305aa550cfSdan ** If pExpr is a simple SQL value - an integer, real, string, blob
48315aa550cfSdan ** or NULL value - then the VDBE currently being prepared is configured
48325aa550cfSdan ** to re-prepare each time a new value is bound to variable pVar.
48335aa550cfSdan **
48345aa550cfSdan ** Additionally, if pExpr is a simple SQL value and the value is the
48355aa550cfSdan ** same as that currently bound to variable pVar, non-zero is returned.
48365aa550cfSdan ** Otherwise, if the values are not the same or if pExpr is not a simple
48375aa550cfSdan ** SQL value, zero is returned.
48385aa550cfSdan */
48395aa550cfSdan static int exprCompareVariable(Parse *pParse, Expr *pVar, Expr *pExpr){
48405aa550cfSdan   int res = 0;
4841c0804226Sdrh   int iVar;
4842c0804226Sdrh   sqlite3_value *pL, *pR = 0;
48435aa550cfSdan 
48445aa550cfSdan   sqlite3ValueFromExpr(pParse->db, pExpr, SQLITE_UTF8, SQLITE_AFF_BLOB, &pR);
4845c0804226Sdrh   if( pR ){
4846c0804226Sdrh     iVar = pVar->iColumn;
4847c0804226Sdrh     sqlite3VdbeSetVarmask(pParse->pVdbe, iVar);
4848c0804226Sdrh     pL = sqlite3VdbeGetBoundValue(pParse->pReprepare, iVar, SQLITE_AFF_BLOB);
48495aa307e2Sdrh     if( pL ){
48505aa307e2Sdrh       if( sqlite3_value_type(pL)==SQLITE_TEXT ){
48515aa307e2Sdrh         sqlite3_value_text(pL); /* Make sure the encoding is UTF-8 */
48525aa307e2Sdrh       }
48535aa307e2Sdrh       res =  0==sqlite3MemCompare(pL, pR, 0);
48545aa550cfSdan     }
48555aa550cfSdan     sqlite3ValueFree(pR);
48565aa550cfSdan     sqlite3ValueFree(pL);
48575aa550cfSdan   }
48585aa550cfSdan 
48595aa550cfSdan   return res;
48605aa550cfSdan }
486172bc8208Sdrh 
486272bc8208Sdrh /*
48631d9da70aSdrh ** Do a deep comparison of two expression trees.  Return 0 if the two
48641d9da70aSdrh ** expressions are completely identical.  Return 1 if they differ only
48651d9da70aSdrh ** by a COLLATE operator at the top level.  Return 2 if there are differences
48661d9da70aSdrh ** other than the top-level COLLATE operator.
4867d40aab0eSdrh **
4868619a1305Sdrh ** If any subelement of pB has Expr.iTable==(-1) then it is allowed
4869619a1305Sdrh ** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
4870619a1305Sdrh **
487166518ca7Sdrh ** The pA side might be using TK_REGISTER.  If that is the case and pB is
487266518ca7Sdrh ** not using TK_REGISTER but is otherwise equivalent, then still return 0.
487366518ca7Sdrh **
48741d9da70aSdrh ** Sometimes this routine will return 2 even if the two expressions
4875d40aab0eSdrh ** really are equivalent.  If we cannot prove that the expressions are
48761d9da70aSdrh ** identical, we return 2 just to be safe.  So if this routine
48771d9da70aSdrh ** returns 2, then you do not really know for certain if the two
48781d9da70aSdrh ** expressions are the same.  But if you get a 0 or 1 return, then you
4879d40aab0eSdrh ** can be sure the expressions are the same.  In the places where
48801d9da70aSdrh ** this routine is used, it does not hurt to get an extra 2 - that
4881d40aab0eSdrh ** just might result in some slightly slower code.  But returning
48821d9da70aSdrh ** an incorrect 0 or 1 could lead to a malfunction.
48835aa550cfSdan **
4884c0804226Sdrh ** If pParse is not NULL then TK_VARIABLE terms in pA with bindings in
4885c0804226Sdrh ** pParse->pReprepare can be matched against literals in pB.  The
4886c0804226Sdrh ** pParse->pVdbe->expmask bitmask is updated for each variable referenced.
4887c0804226Sdrh ** If pParse is NULL (the normal case) then any TK_VARIABLE term in
4888c0804226Sdrh ** Argument pParse should normally be NULL. If it is not NULL and pA or
4889c0804226Sdrh ** pB causes a return value of 2.
48902282792aSdrh */
48915aa550cfSdan int sqlite3ExprCompare(Parse *pParse, Expr *pA, Expr *pB, int iTab){
489210d1edf0Sdrh   u32 combinedFlags;
48934b202ae2Sdanielk1977   if( pA==0 || pB==0 ){
48941d9da70aSdrh     return pB==pA ? 0 : 2;
48952282792aSdrh   }
48965aa550cfSdan   if( pParse && pA->op==TK_VARIABLE && exprCompareVariable(pParse, pA, pB) ){
48975aa550cfSdan     return 0;
48985aa550cfSdan   }
489910d1edf0Sdrh   combinedFlags = pA->flags | pB->flags;
490010d1edf0Sdrh   if( combinedFlags & EP_IntValue ){
490110d1edf0Sdrh     if( (pA->flags&pB->flags&EP_IntValue)!=0 && pA->u.iValue==pB->u.iValue ){
490210d1edf0Sdrh       return 0;
490310d1edf0Sdrh     }
49041d9da70aSdrh     return 2;
49056ab3a2ecSdanielk1977   }
4906c2acc4e4Sdrh   if( pA->op!=pB->op ){
49075aa550cfSdan     if( pA->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA->pLeft,pB,iTab)<2 ){
4908ae80ddeaSdrh       return 1;
4909ae80ddeaSdrh     }
49105aa550cfSdan     if( pB->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA,pB->pLeft,iTab)<2 ){
4911ae80ddeaSdrh       return 1;
4912ae80ddeaSdrh     }
4913ae80ddeaSdrh     return 2;
4914ae80ddeaSdrh   }
49152edc5fd7Sdrh   if( pA->op!=TK_COLUMN && pA->op!=TK_AGG_COLUMN && pA->u.zToken ){
4916390b88a4Sdrh     if( pA->op==TK_FUNCTION ){
4917390b88a4Sdrh       if( sqlite3StrICmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
4918d5af5420Sdrh     }else if( pA->op==TK_COLLATE ){
4919e79f6299Sdrh       if( sqlite3_stricmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
4920390b88a4Sdrh     }else if( strcmp(pA->u.zToken,pB->u.zToken)!=0 ){
4921d5af5420Sdrh       return 2;
492210d1edf0Sdrh     }
492310d1edf0Sdrh   }
492410d1edf0Sdrh   if( (pA->flags & EP_Distinct)!=(pB->flags & EP_Distinct) ) return 2;
492585f8aa79Sdrh   if( ALWAYS((combinedFlags & EP_TokenOnly)==0) ){
492610d1edf0Sdrh     if( combinedFlags & EP_xIsSelect ) return 2;
49275aa550cfSdan     if( sqlite3ExprCompare(pParse, pA->pLeft, pB->pLeft, iTab) ) return 2;
49285aa550cfSdan     if( sqlite3ExprCompare(pParse, pA->pRight, pB->pRight, iTab) ) return 2;
4929619a1305Sdrh     if( sqlite3ExprListCompare(pA->x.pList, pB->x.pList, iTab) ) return 2;
4930f49ff6ffSdrh     assert( (combinedFlags & EP_Reduced)==0 );
4931f49ff6ffSdrh     if( pA->op!=TK_STRING && pA->op!=TK_TRUEFALSE ){
4932619a1305Sdrh       if( pA->iColumn!=pB->iColumn ) return 2;
493366518ca7Sdrh       if( pA->iTable!=pB->iTable
493485f8aa79Sdrh        && (pA->iTable!=iTab || NEVER(pB->iTable>=0)) ) return 2;
49351d9da70aSdrh     }
49361d9da70aSdrh   }
49372646da7eSdrh   return 0;
49382646da7eSdrh }
49392282792aSdrh 
49408c6f666bSdrh /*
49418c6f666bSdrh ** Compare two ExprList objects.  Return 0 if they are identical and
49428c6f666bSdrh ** non-zero if they differ in any way.
49438c6f666bSdrh **
4944619a1305Sdrh ** If any subelement of pB has Expr.iTable==(-1) then it is allowed
4945619a1305Sdrh ** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
4946619a1305Sdrh **
49478c6f666bSdrh ** This routine might return non-zero for equivalent ExprLists.  The
49488c6f666bSdrh ** only consequence will be disabled optimizations.  But this routine
49498c6f666bSdrh ** must never return 0 if the two ExprList objects are different, or
49508c6f666bSdrh ** a malfunction will result.
49518c6f666bSdrh **
49528c6f666bSdrh ** Two NULL pointers are considered to be the same.  But a NULL pointer
49538c6f666bSdrh ** always differs from a non-NULL pointer.
49548c6f666bSdrh */
4955619a1305Sdrh int sqlite3ExprListCompare(ExprList *pA, ExprList *pB, int iTab){
49568c6f666bSdrh   int i;
49578c6f666bSdrh   if( pA==0 && pB==0 ) return 0;
49588c6f666bSdrh   if( pA==0 || pB==0 ) return 1;
49598c6f666bSdrh   if( pA->nExpr!=pB->nExpr ) return 1;
49608c6f666bSdrh   for(i=0; i<pA->nExpr; i++){
49618c6f666bSdrh     Expr *pExprA = pA->a[i].pExpr;
49628c6f666bSdrh     Expr *pExprB = pB->a[i].pExpr;
49638c6f666bSdrh     if( pA->a[i].sortOrder!=pB->a[i].sortOrder ) return 1;
49645aa550cfSdan     if( sqlite3ExprCompare(0, pExprA, pExprB, iTab) ) return 1;
49658c6f666bSdrh   }
49668c6f666bSdrh   return 0;
49678c6f666bSdrh }
496813449892Sdrh 
49692282792aSdrh /*
4970f9463dfbSdrh ** Like sqlite3ExprCompare() except COLLATE operators at the top-level
4971f9463dfbSdrh ** are ignored.
4972f9463dfbSdrh */
4973f9463dfbSdrh int sqlite3ExprCompareSkip(Expr *pA, Expr *pB, int iTab){
49745aa550cfSdan   return sqlite3ExprCompare(0,
4975f9463dfbSdrh              sqlite3ExprSkipCollate(pA),
4976f9463dfbSdrh              sqlite3ExprSkipCollate(pB),
4977f9463dfbSdrh              iTab);
4978f9463dfbSdrh }
4979f9463dfbSdrh 
4980f9463dfbSdrh /*
49814bd5f73fSdrh ** Return true if we can prove the pE2 will always be true if pE1 is
49824bd5f73fSdrh ** true.  Return false if we cannot complete the proof or if pE2 might
49834bd5f73fSdrh ** be false.  Examples:
49844bd5f73fSdrh **
4985619a1305Sdrh **     pE1: x==5       pE2: x==5             Result: true
49864bd5f73fSdrh **     pE1: x>0        pE2: x==5             Result: false
4987619a1305Sdrh **     pE1: x=21       pE2: x=21 OR y=43     Result: true
49884bd5f73fSdrh **     pE1: x!=123     pE2: x IS NOT NULL    Result: true
4989619a1305Sdrh **     pE1: x!=?1      pE2: x IS NOT NULL    Result: true
4990619a1305Sdrh **     pE1: x IS NULL  pE2: x IS NOT NULL    Result: false
4991619a1305Sdrh **     pE1: x IS ?2    pE2: x IS NOT NULL    Reuslt: false
49924bd5f73fSdrh **
49934bd5f73fSdrh ** When comparing TK_COLUMN nodes between pE1 and pE2, if pE2 has
49944bd5f73fSdrh ** Expr.iTable<0 then assume a table number given by iTab.
49954bd5f73fSdrh **
4996c0804226Sdrh ** If pParse is not NULL, then the values of bound variables in pE1 are
4997c0804226Sdrh ** compared against literal values in pE2 and pParse->pVdbe->expmask is
4998c0804226Sdrh ** modified to record which bound variables are referenced.  If pParse
4999c0804226Sdrh ** is NULL, then false will be returned if pE1 contains any bound variables.
5000c0804226Sdrh **
50014bd5f73fSdrh ** When in doubt, return false.  Returning true might give a performance
50024bd5f73fSdrh ** improvement.  Returning false might cause a performance reduction, but
50034bd5f73fSdrh ** it will always give the correct answer and is hence always safe.
50044bd5f73fSdrh */
50055aa550cfSdan int sqlite3ExprImpliesExpr(Parse *pParse, Expr *pE1, Expr *pE2, int iTab){
50065aa550cfSdan   if( sqlite3ExprCompare(pParse, pE1, pE2, iTab)==0 ){
5007619a1305Sdrh     return 1;
5008619a1305Sdrh   }
5009619a1305Sdrh   if( pE2->op==TK_OR
50105aa550cfSdan    && (sqlite3ExprImpliesExpr(pParse, pE1, pE2->pLeft, iTab)
50115aa550cfSdan              || sqlite3ExprImpliesExpr(pParse, pE1, pE2->pRight, iTab) )
5012619a1305Sdrh   ){
5013619a1305Sdrh     return 1;
5014619a1305Sdrh   }
50151ad93a00Sdrh   if( pE2->op==TK_NOTNULL && pE1->op!=TK_ISNULL && pE1->op!=TK_IS ){
50161ad93a00Sdrh     Expr *pX = sqlite3ExprSkipCollate(pE1->pLeft);
50171ad93a00Sdrh     testcase( pX!=pE1->pLeft );
50185aa550cfSdan     if( sqlite3ExprCompare(pParse, pX, pE2->pLeft, iTab)==0 ) return 1;
5019619a1305Sdrh   }
5020619a1305Sdrh   return 0;
50214bd5f73fSdrh }
50224bd5f73fSdrh 
50234bd5f73fSdrh /*
50242589787cSdrh ** This is the Expr node callback for sqlite3ExprImpliesNotNullRow().
50252589787cSdrh ** If the expression node requires that the table at pWalker->iCur
50262589787cSdrh ** have a non-NULL column, then set pWalker->eCode to 1 and abort.
50272589787cSdrh */
50282589787cSdrh static int impliesNotNullRow(Walker *pWalker, Expr *pExpr){
5029821b610bSdrh   /* This routine is only called for WHERE clause expressions and so it
5030821b610bSdrh   ** cannot have any TK_AGG_COLUMN entries because those are only found
5031821b610bSdrh   ** in HAVING clauses.  We can get a TK_AGG_FUNCTION in a WHERE clause,
5032821b610bSdrh   ** but that is an illegal construct and the query will be rejected at
5033821b610bSdrh   ** a later stage of processing, so the TK_AGG_FUNCTION case does not
5034821b610bSdrh   ** need to be considered here. */
5035821b610bSdrh   assert( pExpr->op!=TK_AGG_COLUMN );
5036821b610bSdrh   testcase( pExpr->op==TK_AGG_FUNCTION );
5037821b610bSdrh 
50382589787cSdrh   if( ExprHasProperty(pExpr, EP_FromJoin) ) return WRC_Prune;
50392589787cSdrh   switch( pExpr->op ){
50400493222fSdan     case TK_ISNOT:
5041a1054dccSdan     case TK_NOT:
50422589787cSdrh     case TK_ISNULL:
50432589787cSdrh     case TK_IS:
50442589787cSdrh     case TK_OR:
50452c492061Sdrh     case TK_CASE:
5046e3eff266Sdrh     case TK_IN:
50472589787cSdrh     case TK_FUNCTION:
50480493222fSdan       testcase( pExpr->op==TK_ISNOT );
50490493222fSdan       testcase( pExpr->op==TK_NOT );
5050821b610bSdrh       testcase( pExpr->op==TK_ISNULL );
5051821b610bSdrh       testcase( pExpr->op==TK_IS );
5052821b610bSdrh       testcase( pExpr->op==TK_OR );
5053821b610bSdrh       testcase( pExpr->op==TK_CASE );
5054821b610bSdrh       testcase( pExpr->op==TK_IN );
5055821b610bSdrh       testcase( pExpr->op==TK_FUNCTION );
50562589787cSdrh       return WRC_Prune;
50572589787cSdrh     case TK_COLUMN:
50582589787cSdrh       if( pWalker->u.iCur==pExpr->iTable ){
50592589787cSdrh         pWalker->eCode = 1;
50602589787cSdrh         return WRC_Abort;
50612589787cSdrh       }
50622589787cSdrh       return WRC_Prune;
50639881155dSdrh 
50649881155dSdrh     /* Virtual tables are allowed to use constraints like x=NULL.  So
50659881155dSdrh     ** a term of the form x=y does not prove that y is not null if x
50669881155dSdrh     ** is the column of a virtual table */
50679881155dSdrh     case TK_EQ:
50689881155dSdrh     case TK_NE:
50699881155dSdrh     case TK_LT:
50709881155dSdrh     case TK_LE:
50719881155dSdrh     case TK_GT:
50729881155dSdrh     case TK_GE:
50739881155dSdrh       testcase( pExpr->op==TK_EQ );
50749881155dSdrh       testcase( pExpr->op==TK_NE );
50759881155dSdrh       testcase( pExpr->op==TK_LT );
50769881155dSdrh       testcase( pExpr->op==TK_LE );
50779881155dSdrh       testcase( pExpr->op==TK_GT );
50789881155dSdrh       testcase( pExpr->op==TK_GE );
50799881155dSdrh       if( (pExpr->pLeft->op==TK_COLUMN && IsVirtual(pExpr->pLeft->pTab))
50809881155dSdrh        || (pExpr->pRight->op==TK_COLUMN && IsVirtual(pExpr->pRight->pTab))
50819881155dSdrh       ){
50829881155dSdrh        return WRC_Prune;
50839881155dSdrh       }
50842589787cSdrh     default:
50852589787cSdrh       return WRC_Continue;
50862589787cSdrh   }
50872589787cSdrh }
50882589787cSdrh 
50892589787cSdrh /*
50902589787cSdrh ** Return true (non-zero) if expression p can only be true if at least
50912589787cSdrh ** one column of table iTab is non-null.  In other words, return true
50922589787cSdrh ** if expression p will always be NULL or false if every column of iTab
50932589787cSdrh ** is NULL.
50942589787cSdrh **
5095821b610bSdrh ** False negatives are acceptable.  In other words, it is ok to return
5096821b610bSdrh ** zero even if expression p will never be true of every column of iTab
5097821b610bSdrh ** is NULL.  A false negative is merely a missed optimization opportunity.
5098821b610bSdrh **
5099821b610bSdrh ** False positives are not allowed, however.  A false positive may result
5100821b610bSdrh ** in an incorrect answer.
5101821b610bSdrh **
51022589787cSdrh ** Terms of p that are marked with EP_FromJoin (and hence that come from
51032589787cSdrh ** the ON or USING clauses of LEFT JOINS) are excluded from the analysis.
51042589787cSdrh **
51052589787cSdrh ** This routine is used to check if a LEFT JOIN can be converted into
51062589787cSdrh ** an ordinary JOIN.  The p argument is the WHERE clause.  If the WHERE
51072589787cSdrh ** clause requires that some column of the right table of the LEFT JOIN
51082589787cSdrh ** be non-NULL, then the LEFT JOIN can be safely converted into an
51092589787cSdrh ** ordinary join.
51102589787cSdrh */
51112589787cSdrh int sqlite3ExprImpliesNonNullRow(Expr *p, int iTab){
51122589787cSdrh   Walker w;
51132589787cSdrh   w.xExprCallback = impliesNotNullRow;
51142589787cSdrh   w.xSelectCallback = 0;
51152589787cSdrh   w.xSelectCallback2 = 0;
51162589787cSdrh   w.eCode = 0;
51172589787cSdrh   w.u.iCur = iTab;
51182589787cSdrh   sqlite3WalkExpr(&w, p);
51192589787cSdrh   return w.eCode;
51202589787cSdrh }
51212589787cSdrh 
51222589787cSdrh /*
5123030796dfSdrh ** An instance of the following structure is used by the tree walker
51242409f8a1Sdrh ** to determine if an expression can be evaluated by reference to the
51252409f8a1Sdrh ** index only, without having to do a search for the corresponding
51262409f8a1Sdrh ** table entry.  The IdxCover.pIdx field is the index.  IdxCover.iCur
51272409f8a1Sdrh ** is the cursor for the table.
51282409f8a1Sdrh */
51292409f8a1Sdrh struct IdxCover {
51302409f8a1Sdrh   Index *pIdx;     /* The index to be tested for coverage */
51312409f8a1Sdrh   int iCur;        /* Cursor number for the table corresponding to the index */
51322409f8a1Sdrh };
51332409f8a1Sdrh 
51342409f8a1Sdrh /*
51352409f8a1Sdrh ** Check to see if there are references to columns in table
51362409f8a1Sdrh ** pWalker->u.pIdxCover->iCur can be satisfied using the index
51372409f8a1Sdrh ** pWalker->u.pIdxCover->pIdx.
51382409f8a1Sdrh */
51392409f8a1Sdrh static int exprIdxCover(Walker *pWalker, Expr *pExpr){
51402409f8a1Sdrh   if( pExpr->op==TK_COLUMN
51412409f8a1Sdrh    && pExpr->iTable==pWalker->u.pIdxCover->iCur
51422409f8a1Sdrh    && sqlite3ColumnOfIndex(pWalker->u.pIdxCover->pIdx, pExpr->iColumn)<0
51432409f8a1Sdrh   ){
51442409f8a1Sdrh     pWalker->eCode = 1;
51452409f8a1Sdrh     return WRC_Abort;
51462409f8a1Sdrh   }
51472409f8a1Sdrh   return WRC_Continue;
51482409f8a1Sdrh }
51492409f8a1Sdrh 
51502409f8a1Sdrh /*
5151e604ec0bSdrh ** Determine if an index pIdx on table with cursor iCur contains will
5152e604ec0bSdrh ** the expression pExpr.  Return true if the index does cover the
5153e604ec0bSdrh ** expression and false if the pExpr expression references table columns
5154e604ec0bSdrh ** that are not found in the index pIdx.
51552409f8a1Sdrh **
51562409f8a1Sdrh ** An index covering an expression means that the expression can be
51572409f8a1Sdrh ** evaluated using only the index and without having to lookup the
51582409f8a1Sdrh ** corresponding table entry.
51592409f8a1Sdrh */
51602409f8a1Sdrh int sqlite3ExprCoveredByIndex(
51612409f8a1Sdrh   Expr *pExpr,        /* The index to be tested */
51622409f8a1Sdrh   int iCur,           /* The cursor number for the corresponding table */
51632409f8a1Sdrh   Index *pIdx         /* The index that might be used for coverage */
51642409f8a1Sdrh ){
51652409f8a1Sdrh   Walker w;
51662409f8a1Sdrh   struct IdxCover xcov;
51672409f8a1Sdrh   memset(&w, 0, sizeof(w));
51682409f8a1Sdrh   xcov.iCur = iCur;
51692409f8a1Sdrh   xcov.pIdx = pIdx;
51702409f8a1Sdrh   w.xExprCallback = exprIdxCover;
51712409f8a1Sdrh   w.u.pIdxCover = &xcov;
51722409f8a1Sdrh   sqlite3WalkExpr(&w, pExpr);
51732409f8a1Sdrh   return !w.eCode;
51742409f8a1Sdrh }
51752409f8a1Sdrh 
51762409f8a1Sdrh 
51772409f8a1Sdrh /*
51782409f8a1Sdrh ** An instance of the following structure is used by the tree walker
5179030796dfSdrh ** to count references to table columns in the arguments of an
5180ed551b95Sdrh ** aggregate function, in order to implement the
5181ed551b95Sdrh ** sqlite3FunctionThisSrc() routine.
5182374fdce4Sdrh */
5183030796dfSdrh struct SrcCount {
5184030796dfSdrh   SrcList *pSrc;   /* One particular FROM clause in a nested query */
5185030796dfSdrh   int nThis;       /* Number of references to columns in pSrcList */
5186030796dfSdrh   int nOther;      /* Number of references to columns in other FROM clauses */
5187030796dfSdrh };
5188030796dfSdrh 
5189030796dfSdrh /*
5190030796dfSdrh ** Count the number of references to columns.
5191030796dfSdrh */
5192030796dfSdrh static int exprSrcCount(Walker *pWalker, Expr *pExpr){
5193fb0a6081Sdrh   /* The NEVER() on the second term is because sqlite3FunctionUsesThisSrc()
5194fb0a6081Sdrh   ** is always called before sqlite3ExprAnalyzeAggregates() and so the
5195fb0a6081Sdrh   ** TK_COLUMNs have not yet been converted into TK_AGG_COLUMN.  If
5196fb0a6081Sdrh   ** sqlite3FunctionUsesThisSrc() is used differently in the future, the
5197fb0a6081Sdrh   ** NEVER() will need to be removed. */
5198fb0a6081Sdrh   if( pExpr->op==TK_COLUMN || NEVER(pExpr->op==TK_AGG_COLUMN) ){
5199374fdce4Sdrh     int i;
5200030796dfSdrh     struct SrcCount *p = pWalker->u.pSrcCount;
5201030796dfSdrh     SrcList *pSrc = p->pSrc;
5202655814d2Sdrh     int nSrc = pSrc ? pSrc->nSrc : 0;
5203655814d2Sdrh     for(i=0; i<nSrc; i++){
5204030796dfSdrh       if( pExpr->iTable==pSrc->a[i].iCursor ) break;
5205374fdce4Sdrh     }
5206655814d2Sdrh     if( i<nSrc ){
5207030796dfSdrh       p->nThis++;
5208374fdce4Sdrh     }else{
5209030796dfSdrh       p->nOther++;
5210374fdce4Sdrh     }
5211374fdce4Sdrh   }
5212030796dfSdrh   return WRC_Continue;
5213030796dfSdrh }
5214374fdce4Sdrh 
5215374fdce4Sdrh /*
5216030796dfSdrh ** Determine if any of the arguments to the pExpr Function reference
5217030796dfSdrh ** pSrcList.  Return true if they do.  Also return true if the function
5218030796dfSdrh ** has no arguments or has only constant arguments.  Return false if pExpr
5219030796dfSdrh ** references columns but not columns of tables found in pSrcList.
5220374fdce4Sdrh */
5221030796dfSdrh int sqlite3FunctionUsesThisSrc(Expr *pExpr, SrcList *pSrcList){
5222374fdce4Sdrh   Walker w;
5223030796dfSdrh   struct SrcCount cnt;
5224374fdce4Sdrh   assert( pExpr->op==TK_AGG_FUNCTION );
5225030796dfSdrh   w.xExprCallback = exprSrcCount;
5226979dd1beSdrh   w.xSelectCallback = 0;
5227030796dfSdrh   w.u.pSrcCount = &cnt;
5228030796dfSdrh   cnt.pSrc = pSrcList;
5229030796dfSdrh   cnt.nThis = 0;
5230030796dfSdrh   cnt.nOther = 0;
5231030796dfSdrh   sqlite3WalkExprList(&w, pExpr->x.pList);
5232030796dfSdrh   return cnt.nThis>0 || cnt.nOther==0;
5233374fdce4Sdrh }
5234374fdce4Sdrh 
5235374fdce4Sdrh /*
523613449892Sdrh ** Add a new element to the pAggInfo->aCol[] array.  Return the index of
523713449892Sdrh ** the new element.  Return a negative number if malloc fails.
52382282792aSdrh */
523917435752Sdrh static int addAggInfoColumn(sqlite3 *db, AggInfo *pInfo){
524013449892Sdrh   int i;
5241cf643729Sdrh   pInfo->aCol = sqlite3ArrayAllocate(
524217435752Sdrh        db,
5243cf643729Sdrh        pInfo->aCol,
5244cf643729Sdrh        sizeof(pInfo->aCol[0]),
5245cf643729Sdrh        &pInfo->nColumn,
5246cf643729Sdrh        &i
5247cf643729Sdrh   );
524813449892Sdrh   return i;
52492282792aSdrh }
525013449892Sdrh 
525113449892Sdrh /*
525213449892Sdrh ** Add a new element to the pAggInfo->aFunc[] array.  Return the index of
525313449892Sdrh ** the new element.  Return a negative number if malloc fails.
525413449892Sdrh */
525517435752Sdrh static int addAggInfoFunc(sqlite3 *db, AggInfo *pInfo){
525613449892Sdrh   int i;
5257cf643729Sdrh   pInfo->aFunc = sqlite3ArrayAllocate(
525817435752Sdrh        db,
5259cf643729Sdrh        pInfo->aFunc,
5260cf643729Sdrh        sizeof(pInfo->aFunc[0]),
5261cf643729Sdrh        &pInfo->nFunc,
5262cf643729Sdrh        &i
5263cf643729Sdrh   );
526413449892Sdrh   return i;
52652282792aSdrh }
52662282792aSdrh 
52672282792aSdrh /*
52687d10d5a6Sdrh ** This is the xExprCallback for a tree walker.  It is used to
52697d10d5a6Sdrh ** implement sqlite3ExprAnalyzeAggregates().  See sqlite3ExprAnalyzeAggregates
5270626a879aSdrh ** for additional information.
52712282792aSdrh */
52727d10d5a6Sdrh static int analyzeAggregate(Walker *pWalker, Expr *pExpr){
52732282792aSdrh   int i;
52747d10d5a6Sdrh   NameContext *pNC = pWalker->u.pNC;
5275a58fdfb1Sdanielk1977   Parse *pParse = pNC->pParse;
5276a58fdfb1Sdanielk1977   SrcList *pSrcList = pNC->pSrcList;
527725c3b8caSdrh   AggInfo *pAggInfo = pNC->uNC.pAggInfo;
527813449892Sdrh 
527925c3b8caSdrh   assert( pNC->ncFlags & NC_UAggInfo );
52802282792aSdrh   switch( pExpr->op ){
528189c69d00Sdrh     case TK_AGG_COLUMN:
5282967e8b73Sdrh     case TK_COLUMN: {
52838b213899Sdrh       testcase( pExpr->op==TK_AGG_COLUMN );
52848b213899Sdrh       testcase( pExpr->op==TK_COLUMN );
528513449892Sdrh       /* Check to see if the column is in one of the tables in the FROM
528613449892Sdrh       ** clause of the aggregate query */
528720bc393cSdrh       if( ALWAYS(pSrcList!=0) ){
528813449892Sdrh         struct SrcList_item *pItem = pSrcList->a;
528913449892Sdrh         for(i=0; i<pSrcList->nSrc; i++, pItem++){
529013449892Sdrh           struct AggInfo_col *pCol;
5291c5cd1249Sdrh           assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
529213449892Sdrh           if( pExpr->iTable==pItem->iCursor ){
529313449892Sdrh             /* If we reach this point, it means that pExpr refers to a table
529413449892Sdrh             ** that is in the FROM clause of the aggregate query.
529513449892Sdrh             **
529613449892Sdrh             ** Make an entry for the column in pAggInfo->aCol[] if there
529713449892Sdrh             ** is not an entry there already.
529813449892Sdrh             */
52997f906d63Sdrh             int k;
530013449892Sdrh             pCol = pAggInfo->aCol;
53017f906d63Sdrh             for(k=0; k<pAggInfo->nColumn; k++, pCol++){
530213449892Sdrh               if( pCol->iTable==pExpr->iTable &&
530313449892Sdrh                   pCol->iColumn==pExpr->iColumn ){
53042282792aSdrh                 break;
53052282792aSdrh               }
53062282792aSdrh             }
53071e536953Sdanielk1977             if( (k>=pAggInfo->nColumn)
53081e536953Sdanielk1977              && (k = addAggInfoColumn(pParse->db, pAggInfo))>=0
53091e536953Sdanielk1977             ){
53107f906d63Sdrh               pCol = &pAggInfo->aCol[k];
53110817d0dfSdanielk1977               pCol->pTab = pExpr->pTab;
531213449892Sdrh               pCol->iTable = pExpr->iTable;
531313449892Sdrh               pCol->iColumn = pExpr->iColumn;
53140a07c107Sdrh               pCol->iMem = ++pParse->nMem;
531513449892Sdrh               pCol->iSorterColumn = -1;
53165774b806Sdrh               pCol->pExpr = pExpr;
531713449892Sdrh               if( pAggInfo->pGroupBy ){
531813449892Sdrh                 int j, n;
531913449892Sdrh                 ExprList *pGB = pAggInfo->pGroupBy;
532013449892Sdrh                 struct ExprList_item *pTerm = pGB->a;
532113449892Sdrh                 n = pGB->nExpr;
532213449892Sdrh                 for(j=0; j<n; j++, pTerm++){
532313449892Sdrh                   Expr *pE = pTerm->pExpr;
532413449892Sdrh                   if( pE->op==TK_COLUMN && pE->iTable==pExpr->iTable &&
532513449892Sdrh                       pE->iColumn==pExpr->iColumn ){
532613449892Sdrh                     pCol->iSorterColumn = j;
532713449892Sdrh                     break;
53282282792aSdrh                   }
532913449892Sdrh                 }
533013449892Sdrh               }
533113449892Sdrh               if( pCol->iSorterColumn<0 ){
533213449892Sdrh                 pCol->iSorterColumn = pAggInfo->nSortingColumn++;
533313449892Sdrh               }
533413449892Sdrh             }
533513449892Sdrh             /* There is now an entry for pExpr in pAggInfo->aCol[] (either
533613449892Sdrh             ** because it was there before or because we just created it).
533713449892Sdrh             ** Convert the pExpr to be a TK_AGG_COLUMN referring to that
533813449892Sdrh             ** pAggInfo->aCol[] entry.
533913449892Sdrh             */
5340ebb6a65dSdrh             ExprSetVVAProperty(pExpr, EP_NoReduce);
534113449892Sdrh             pExpr->pAggInfo = pAggInfo;
534213449892Sdrh             pExpr->op = TK_AGG_COLUMN;
5343cf697396Sshane             pExpr->iAgg = (i16)k;
534413449892Sdrh             break;
534513449892Sdrh           } /* endif pExpr->iTable==pItem->iCursor */
534613449892Sdrh         } /* end loop over pSrcList */
5347a58fdfb1Sdanielk1977       }
53487d10d5a6Sdrh       return WRC_Prune;
53492282792aSdrh     }
53502282792aSdrh     case TK_AGG_FUNCTION: {
53513a8c4be7Sdrh       if( (pNC->ncFlags & NC_InAggFunc)==0
5352ed551b95Sdrh        && pWalker->walkerDepth==pExpr->op2
53533a8c4be7Sdrh       ){
535413449892Sdrh         /* Check to see if pExpr is a duplicate of another aggregate
535513449892Sdrh         ** function that is already in the pAggInfo structure
535613449892Sdrh         */
535713449892Sdrh         struct AggInfo_func *pItem = pAggInfo->aFunc;
535813449892Sdrh         for(i=0; i<pAggInfo->nFunc; i++, pItem++){
53595aa550cfSdan           if( sqlite3ExprCompare(0, pItem->pExpr, pExpr, -1)==0 ){
53602282792aSdrh             break;
53612282792aSdrh           }
53622282792aSdrh         }
536313449892Sdrh         if( i>=pAggInfo->nFunc ){
536413449892Sdrh           /* pExpr is original.  Make a new entry in pAggInfo->aFunc[]
536513449892Sdrh           */
536614db2665Sdanielk1977           u8 enc = ENC(pParse->db);
53671e536953Sdanielk1977           i = addAggInfoFunc(pParse->db, pAggInfo);
536813449892Sdrh           if( i>=0 ){
53696ab3a2ecSdanielk1977             assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
537013449892Sdrh             pItem = &pAggInfo->aFunc[i];
537113449892Sdrh             pItem->pExpr = pExpr;
53720a07c107Sdrh             pItem->iMem = ++pParse->nMem;
537333e619fcSdrh             assert( !ExprHasProperty(pExpr, EP_IntValue) );
537413449892Sdrh             pItem->pFunc = sqlite3FindFunction(pParse->db,
537580738d9cSdrh                    pExpr->u.zToken,
53766ab3a2ecSdanielk1977                    pExpr->x.pList ? pExpr->x.pList->nExpr : 0, enc, 0);
5377fd357974Sdrh             if( pExpr->flags & EP_Distinct ){
5378fd357974Sdrh               pItem->iDistinct = pParse->nTab++;
5379fd357974Sdrh             }else{
5380fd357974Sdrh               pItem->iDistinct = -1;
5381fd357974Sdrh             }
53822282792aSdrh           }
538313449892Sdrh         }
538413449892Sdrh         /* Make pExpr point to the appropriate pAggInfo->aFunc[] entry
538513449892Sdrh         */
5386c5cd1249Sdrh         assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
5387ebb6a65dSdrh         ExprSetVVAProperty(pExpr, EP_NoReduce);
5388cf697396Sshane         pExpr->iAgg = (i16)i;
538913449892Sdrh         pExpr->pAggInfo = pAggInfo;
53903a8c4be7Sdrh         return WRC_Prune;
53916e83a57fSdrh       }else{
53926e83a57fSdrh         return WRC_Continue;
53936e83a57fSdrh       }
53942282792aSdrh     }
5395a58fdfb1Sdanielk1977   }
53967d10d5a6Sdrh   return WRC_Continue;
53977d10d5a6Sdrh }
53987d10d5a6Sdrh static int analyzeAggregatesInSelect(Walker *pWalker, Select *pSelect){
5399d5a336efSdrh   UNUSED_PARAMETER(pSelect);
5400979dd1beSdrh   pWalker->walkerDepth++;
54017d10d5a6Sdrh   return WRC_Continue;
5402a58fdfb1Sdanielk1977 }
5403979dd1beSdrh static void analyzeAggregatesInSelectEnd(Walker *pWalker, Select *pSelect){
5404979dd1beSdrh   UNUSED_PARAMETER(pSelect);
5405979dd1beSdrh   pWalker->walkerDepth--;
5406979dd1beSdrh }
5407626a879aSdrh 
5408626a879aSdrh /*
5409e8abb4caSdrh ** Analyze the pExpr expression looking for aggregate functions and
5410e8abb4caSdrh ** for variables that need to be added to AggInfo object that pNC->pAggInfo
5411e8abb4caSdrh ** points to.  Additional entries are made on the AggInfo object as
5412e8abb4caSdrh ** necessary.
5413626a879aSdrh **
5414626a879aSdrh ** This routine should only be called after the expression has been
54157d10d5a6Sdrh ** analyzed by sqlite3ResolveExprNames().
5416626a879aSdrh */
5417d2b3e23bSdrh void sqlite3ExprAnalyzeAggregates(NameContext *pNC, Expr *pExpr){
54187d10d5a6Sdrh   Walker w;
54197d10d5a6Sdrh   w.xExprCallback = analyzeAggregate;
54207d10d5a6Sdrh   w.xSelectCallback = analyzeAggregatesInSelect;
5421979dd1beSdrh   w.xSelectCallback2 = analyzeAggregatesInSelectEnd;
5422979dd1beSdrh   w.walkerDepth = 0;
54237d10d5a6Sdrh   w.u.pNC = pNC;
542420bc393cSdrh   assert( pNC->pSrcList!=0 );
54257d10d5a6Sdrh   sqlite3WalkExpr(&w, pExpr);
54262282792aSdrh }
54275d9a4af9Sdrh 
54285d9a4af9Sdrh /*
54295d9a4af9Sdrh ** Call sqlite3ExprAnalyzeAggregates() for every expression in an
54305d9a4af9Sdrh ** expression list.  Return the number of errors.
54315d9a4af9Sdrh **
54325d9a4af9Sdrh ** If an error is found, the analysis is cut short.
54335d9a4af9Sdrh */
5434d2b3e23bSdrh void sqlite3ExprAnalyzeAggList(NameContext *pNC, ExprList *pList){
54355d9a4af9Sdrh   struct ExprList_item *pItem;
54365d9a4af9Sdrh   int i;
54375d9a4af9Sdrh   if( pList ){
5438d2b3e23bSdrh     for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
5439d2b3e23bSdrh       sqlite3ExprAnalyzeAggregates(pNC, pItem->pExpr);
54405d9a4af9Sdrh     }
54415d9a4af9Sdrh   }
54425d9a4af9Sdrh }
5443892d3179Sdrh 
5444892d3179Sdrh /*
5445ceea3321Sdrh ** Allocate a single new register for use to hold some intermediate result.
5446892d3179Sdrh */
5447892d3179Sdrh int sqlite3GetTempReg(Parse *pParse){
5448e55cbd72Sdrh   if( pParse->nTempReg==0 ){
5449892d3179Sdrh     return ++pParse->nMem;
5450892d3179Sdrh   }
54512f425f6bSdanielk1977   return pParse->aTempReg[--pParse->nTempReg];
5452892d3179Sdrh }
5453ceea3321Sdrh 
5454ceea3321Sdrh /*
5455ceea3321Sdrh ** Deallocate a register, making available for reuse for some other
5456ceea3321Sdrh ** purpose.
5457ceea3321Sdrh **
5458ceea3321Sdrh ** If a register is currently being used by the column cache, then
545960ec914cSpeter.d.reid ** the deallocation is deferred until the column cache line that uses
5460ceea3321Sdrh ** the register becomes stale.
5461ceea3321Sdrh */
5462892d3179Sdrh void sqlite3ReleaseTempReg(Parse *pParse, int iReg){
54632dcef11bSdrh   if( iReg && pParse->nTempReg<ArraySize(pParse->aTempReg) ){
5464ceea3321Sdrh     int i;
5465ceea3321Sdrh     struct yColCache *p;
54669b40d13fSdrh     for(i=0, p=pParse->aColCache; i<pParse->nColCache; i++, p++){
5467ceea3321Sdrh       if( p->iReg==iReg ){
5468ceea3321Sdrh         p->tempReg = 1;
5469ceea3321Sdrh         return;
5470ceea3321Sdrh       }
5471ceea3321Sdrh     }
5472892d3179Sdrh     pParse->aTempReg[pParse->nTempReg++] = iReg;
5473892d3179Sdrh   }
5474892d3179Sdrh }
5475892d3179Sdrh 
5476892d3179Sdrh /*
5477ed24da4bSdrh ** Allocate or deallocate a block of nReg consecutive registers.
5478892d3179Sdrh */
5479892d3179Sdrh int sqlite3GetTempRange(Parse *pParse, int nReg){
5480e55cbd72Sdrh   int i, n;
5481ed24da4bSdrh   if( nReg==1 ) return sqlite3GetTempReg(pParse);
5482892d3179Sdrh   i = pParse->iRangeReg;
5483e55cbd72Sdrh   n = pParse->nRangeReg;
5484f49f3523Sdrh   if( nReg<=n ){
5485f49f3523Sdrh     assert( !usedAsColumnCache(pParse, i, i+n-1) );
5486892d3179Sdrh     pParse->iRangeReg += nReg;
5487892d3179Sdrh     pParse->nRangeReg -= nReg;
5488892d3179Sdrh   }else{
5489892d3179Sdrh     i = pParse->nMem+1;
5490892d3179Sdrh     pParse->nMem += nReg;
5491892d3179Sdrh   }
5492892d3179Sdrh   return i;
5493892d3179Sdrh }
5494892d3179Sdrh void sqlite3ReleaseTempRange(Parse *pParse, int iReg, int nReg){
5495ed24da4bSdrh   if( nReg==1 ){
5496ed24da4bSdrh     sqlite3ReleaseTempReg(pParse, iReg);
5497ed24da4bSdrh     return;
5498ed24da4bSdrh   }
5499f49f3523Sdrh   sqlite3ExprCacheRemove(pParse, iReg, nReg);
5500892d3179Sdrh   if( nReg>pParse->nRangeReg ){
5501892d3179Sdrh     pParse->nRangeReg = nReg;
5502892d3179Sdrh     pParse->iRangeReg = iReg;
5503892d3179Sdrh   }
5504892d3179Sdrh }
5505cdc69557Sdrh 
5506cdc69557Sdrh /*
5507cdc69557Sdrh ** Mark all temporary registers as being unavailable for reuse.
5508cdc69557Sdrh */
5509cdc69557Sdrh void sqlite3ClearTempRegCache(Parse *pParse){
5510cdc69557Sdrh   pParse->nTempReg = 0;
5511cdc69557Sdrh   pParse->nRangeReg = 0;
5512cdc69557Sdrh }
5513bb9b5f26Sdrh 
5514bb9b5f26Sdrh /*
5515bb9b5f26Sdrh ** Validate that no temporary register falls within the range of
5516bb9b5f26Sdrh ** iFirst..iLast, inclusive.  This routine is only call from within assert()
5517bb9b5f26Sdrh ** statements.
5518bb9b5f26Sdrh */
5519bb9b5f26Sdrh #ifdef SQLITE_DEBUG
5520bb9b5f26Sdrh int sqlite3NoTempsInRange(Parse *pParse, int iFirst, int iLast){
5521bb9b5f26Sdrh   int i;
5522bb9b5f26Sdrh   if( pParse->nRangeReg>0
55233963e584Sdrh    && pParse->iRangeReg+pParse->nRangeReg > iFirst
55243963e584Sdrh    && pParse->iRangeReg <= iLast
5525bb9b5f26Sdrh   ){
5526bb9b5f26Sdrh      return 0;
5527bb9b5f26Sdrh   }
5528bb9b5f26Sdrh   for(i=0; i<pParse->nTempReg; i++){
5529bb9b5f26Sdrh     if( pParse->aTempReg[i]>=iFirst && pParse->aTempReg[i]<=iLast ){
5530bb9b5f26Sdrh       return 0;
5531bb9b5f26Sdrh     }
5532bb9b5f26Sdrh   }
5533bb9b5f26Sdrh   return 1;
5534bb9b5f26Sdrh }
5535bb9b5f26Sdrh #endif /* SQLITE_DEBUG */
5536