xref: /sqlite-3.40.0/src/expr.c (revision c51cf864)
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
61eda079cdSdrh   if( (op==TK_AGG_COLUMN || op==TK_COLUMN) && pExpr->y.pTab ){
62eda079cdSdrh     return sqlite3TableColumnAffinity(pExpr->y.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;
144cb0e04f9Sdrh     if( op==TK_REGISTER ) op = p->op2;
145cb0e04f9Sdrh     if( (op==TK_AGG_COLUMN || op==TK_COLUMN || op==TK_TRIGGER)
146eda079cdSdrh      && p->y.pTab!=0
147ae80ddeaSdrh     ){
148eda079cdSdrh       /* op==TK_REGISTER && p->y.pTab!=0 happens when pExpr was originally
1497d10d5a6Sdrh       ** a TK_COLUMN but was previously evaluated and cached in a register */
1507d10d5a6Sdrh       int j = p->iColumn;
1517d10d5a6Sdrh       if( j>=0 ){
152eda079cdSdrh         const char *zColl = p->y.pTab->aCol[j].zColl;
153c4a64facSdrh         pColl = sqlite3FindCollSeq(db, ENC(db), zColl, 0);
1540202b29eSdanielk1977       }
1557d10d5a6Sdrh       break;
1567d10d5a6Sdrh     }
157e081d73cSdrh     if( op==TK_CAST || op==TK_UPLUS ){
158e081d73cSdrh       p = p->pLeft;
159e081d73cSdrh       continue;
160e081d73cSdrh     }
161cb0e04f9Sdrh     if( op==TK_COLLATE ){
162e081d73cSdrh       pColl = sqlite3GetCollSeq(pParse, ENC(db), 0, p->u.zToken);
163e081d73cSdrh       break;
164e081d73cSdrh     }
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);
468dfb5c963Sdan     sqlite3RenameTokenRemap(pParse, pRet, pVector);
469fc7f27b9Sdrh   }
470fc7f27b9Sdrh   return pRet;
471fc7f27b9Sdrh }
47271c57db0Sdan 
4735c288b92Sdan /*
4745c288b92Sdan ** If expression pExpr is of type TK_SELECT, generate code to evaluate
4755c288b92Sdan ** it. Return the register in which the result is stored (or, if the
4765c288b92Sdan ** sub-select returns more than one column, the first in an array
4775c288b92Sdan ** of registers in which the result is stored).
4785c288b92Sdan **
4795c288b92Sdan ** If pExpr is not a TK_SELECT expression, return 0.
4805c288b92Sdan */
4815c288b92Sdan static int exprCodeSubselect(Parse *pParse, Expr *pExpr){
4828da209b1Sdan   int reg = 0;
483f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
4845c288b92Sdan   if( pExpr->op==TK_SELECT ){
48585bcdce2Sdrh     reg = sqlite3CodeSubselect(pParse, pExpr);
4868da209b1Sdan   }
487f9b2e05cSdan #endif
4888da209b1Sdan   return reg;
4898da209b1Sdan }
4908da209b1Sdan 
4915c288b92Sdan /*
4925c288b92Sdan ** Argument pVector points to a vector expression - either a TK_VECTOR
493870a0705Sdan ** or TK_SELECT that returns more than one column. This function returns
494870a0705Sdan ** the register number of a register that contains the value of
495870a0705Sdan ** element iField of the vector.
496870a0705Sdan **
497870a0705Sdan ** If pVector is a TK_SELECT expression, then code for it must have
498870a0705Sdan ** already been generated using the exprCodeSubselect() routine. In this
499870a0705Sdan ** case parameter regSelect should be the first in an array of registers
500870a0705Sdan ** containing the results of the sub-select.
501870a0705Sdan **
502870a0705Sdan ** If pVector is of type TK_VECTOR, then code for the requested field
503870a0705Sdan ** is generated. In this case (*pRegFree) may be set to the number of
504870a0705Sdan ** a temporary register to be freed by the caller before returning.
5055c288b92Sdan **
5065c288b92Sdan ** Before returning, output parameter (*ppExpr) is set to point to the
5075c288b92Sdan ** Expr object corresponding to element iElem of the vector.
5085c288b92Sdan */
5095c288b92Sdan static int exprVectorRegister(
5105c288b92Sdan   Parse *pParse,                  /* Parse context */
5115c288b92Sdan   Expr *pVector,                  /* Vector to extract element from */
512870a0705Sdan   int iField,                     /* Field to extract from pVector */
5135c288b92Sdan   int regSelect,                  /* First in array of registers */
5145c288b92Sdan   Expr **ppExpr,                  /* OUT: Expression element */
5155c288b92Sdan   int *pRegFree                   /* OUT: Temp register to free */
5165c288b92Sdan ){
51712abf408Sdrh   u8 op = pVector->op;
518c1bcd9ccSdrh   assert( op==TK_VECTOR || op==TK_REGISTER || op==TK_SELECT );
51912abf408Sdrh   if( op==TK_REGISTER ){
52012abf408Sdrh     *ppExpr = sqlite3VectorFieldSubexpr(pVector, iField);
52112abf408Sdrh     return pVector->iTable+iField;
52212abf408Sdrh   }
52312abf408Sdrh   if( op==TK_SELECT ){
524870a0705Sdan     *ppExpr = pVector->x.pSelect->pEList->a[iField].pExpr;
525870a0705Sdan      return regSelect+iField;
5265c288b92Sdan   }
527870a0705Sdan   *ppExpr = pVector->x.pList->a[iField].pExpr;
5285c288b92Sdan   return sqlite3ExprCodeTemp(pParse, *ppExpr, pRegFree);
5295c288b92Sdan }
5305c288b92Sdan 
5315c288b92Sdan /*
5325c288b92Sdan ** Expression pExpr is a comparison between two vector values. Compute
53379752b6eSdrh ** the result of the comparison (1, 0, or NULL) and write that
53479752b6eSdrh ** result into register dest.
53579752b6eSdrh **
53679752b6eSdrh ** The caller must satisfy the following preconditions:
53779752b6eSdrh **
53879752b6eSdrh **    if pExpr->op==TK_IS:      op==TK_EQ and p5==SQLITE_NULLEQ
53979752b6eSdrh **    if pExpr->op==TK_ISNOT:   op==TK_NE and p5==SQLITE_NULLEQ
54079752b6eSdrh **    otherwise:                op==pExpr->op and p5==0
5415c288b92Sdan */
54279752b6eSdrh static void codeVectorCompare(
54379752b6eSdrh   Parse *pParse,        /* Code generator context */
54479752b6eSdrh   Expr *pExpr,          /* The comparison operation */
54579752b6eSdrh   int dest,             /* Write results into this register */
54679752b6eSdrh   u8 op,                /* Comparison operator */
54779752b6eSdrh   u8 p5                 /* SQLITE_NULLEQ or zero */
54879752b6eSdrh ){
54971c57db0Sdan   Vdbe *v = pParse->pVdbe;
55071c57db0Sdan   Expr *pLeft = pExpr->pLeft;
55171c57db0Sdan   Expr *pRight = pExpr->pRight;
55271c57db0Sdan   int nLeft = sqlite3ExprVectorSize(pLeft);
55371c57db0Sdan   int i;
55471c57db0Sdan   int regLeft = 0;
55571c57db0Sdan   int regRight = 0;
55679752b6eSdrh   u8 opx = op;
557ec4ccdbcSdrh   int addrDone = sqlite3VdbeMakeLabel(pParse);
55871c57db0Sdan 
559245ce62eSdrh   if( nLeft!=sqlite3ExprVectorSize(pRight) ){
560245ce62eSdrh     sqlite3ErrorMsg(pParse, "row value misused");
561245ce62eSdrh     return;
562245ce62eSdrh   }
56371c57db0Sdan   assert( pExpr->op==TK_EQ || pExpr->op==TK_NE
56471c57db0Sdan        || pExpr->op==TK_IS || pExpr->op==TK_ISNOT
56571c57db0Sdan        || pExpr->op==TK_LT || pExpr->op==TK_GT
56671c57db0Sdan        || pExpr->op==TK_LE || pExpr->op==TK_GE
56771c57db0Sdan   );
56879752b6eSdrh   assert( pExpr->op==op || (pExpr->op==TK_IS && op==TK_EQ)
56979752b6eSdrh             || (pExpr->op==TK_ISNOT && op==TK_NE) );
57079752b6eSdrh   assert( p5==0 || pExpr->op!=op );
57179752b6eSdrh   assert( p5==SQLITE_NULLEQ || pExpr->op==op );
57271c57db0Sdan 
57379752b6eSdrh   p5 |= SQLITE_STOREP2;
57479752b6eSdrh   if( opx==TK_LE ) opx = TK_LT;
57579752b6eSdrh   if( opx==TK_GE ) opx = TK_GT;
5765c288b92Sdan 
5775c288b92Sdan   regLeft = exprCodeSubselect(pParse, pLeft);
5785c288b92Sdan   regRight = exprCodeSubselect(pParse, pRight);
5795c288b92Sdan 
580321e828dSdrh   for(i=0; 1 /*Loop exits by "break"*/; i++){
5815c288b92Sdan     int regFree1 = 0, regFree2 = 0;
5825c288b92Sdan     Expr *pL, *pR;
5835c288b92Sdan     int r1, r2;
584321e828dSdrh     assert( i>=0 && i<nLeft );
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==nLeft-1 ){
59779752b6eSdrh       break;
59871c57db0Sdan     }
59979752b6eSdrh     if( opx==TK_EQ ){
60079752b6eSdrh       sqlite3VdbeAddOp2(v, OP_IfNot, dest, addrDone); VdbeCoverage(v);
60179752b6eSdrh       p5 |= SQLITE_KEEPNULL;
60279752b6eSdrh     }else if( opx==TK_NE ){
60379752b6eSdrh       sqlite3VdbeAddOp2(v, OP_If, dest, addrDone); VdbeCoverage(v);
60479752b6eSdrh       p5 |= SQLITE_KEEPNULL;
605a2f62925Sdrh     }else{
606a2f62925Sdrh       assert( op==TK_LT || op==TK_GT || op==TK_LE || op==TK_GE );
607a2f62925Sdrh       sqlite3VdbeAddOp2(v, OP_ElseNotEq, 0, addrDone);
60879752b6eSdrh       VdbeCoverageIf(v, op==TK_LT);
60979752b6eSdrh       VdbeCoverageIf(v, op==TK_GT);
61079752b6eSdrh       VdbeCoverageIf(v, op==TK_LE);
61179752b6eSdrh       VdbeCoverageIf(v, op==TK_GE);
61279752b6eSdrh       if( i==nLeft-2 ) opx = op;
61371c57db0Sdan     }
61479752b6eSdrh   }
61579752b6eSdrh   sqlite3VdbeResolveLabel(v, addrDone);
61679752b6eSdrh }
61771c57db0Sdan 
6184b5255acSdanielk1977 #if SQLITE_MAX_EXPR_DEPTH>0
6194b5255acSdanielk1977 /*
6204b5255acSdanielk1977 ** Check that argument nHeight is less than or equal to the maximum
6214b5255acSdanielk1977 ** expression depth allowed. If it is not, leave an error message in
6224b5255acSdanielk1977 ** pParse.
6234b5255acSdanielk1977 */
6247d10d5a6Sdrh int sqlite3ExprCheckHeight(Parse *pParse, int nHeight){
6254b5255acSdanielk1977   int rc = SQLITE_OK;
6264b5255acSdanielk1977   int mxHeight = pParse->db->aLimit[SQLITE_LIMIT_EXPR_DEPTH];
6274b5255acSdanielk1977   if( nHeight>mxHeight ){
6284b5255acSdanielk1977     sqlite3ErrorMsg(pParse,
6294b5255acSdanielk1977        "Expression tree is too large (maximum depth %d)", mxHeight
6304b5255acSdanielk1977     );
6314b5255acSdanielk1977     rc = SQLITE_ERROR;
6324b5255acSdanielk1977   }
6334b5255acSdanielk1977   return rc;
6344b5255acSdanielk1977 }
6354b5255acSdanielk1977 
6364b5255acSdanielk1977 /* The following three functions, heightOfExpr(), heightOfExprList()
6374b5255acSdanielk1977 ** and heightOfSelect(), are used to determine the maximum height
6384b5255acSdanielk1977 ** of any expression tree referenced by the structure passed as the
6394b5255acSdanielk1977 ** first argument.
6404b5255acSdanielk1977 **
6414b5255acSdanielk1977 ** If this maximum height is greater than the current value pointed
6424b5255acSdanielk1977 ** to by pnHeight, the second parameter, then set *pnHeight to that
6434b5255acSdanielk1977 ** value.
6444b5255acSdanielk1977 */
6454b5255acSdanielk1977 static void heightOfExpr(Expr *p, int *pnHeight){
6464b5255acSdanielk1977   if( p ){
6474b5255acSdanielk1977     if( p->nHeight>*pnHeight ){
6484b5255acSdanielk1977       *pnHeight = p->nHeight;
6494b5255acSdanielk1977     }
6504b5255acSdanielk1977   }
6514b5255acSdanielk1977 }
6524b5255acSdanielk1977 static void heightOfExprList(ExprList *p, int *pnHeight){
6534b5255acSdanielk1977   if( p ){
6544b5255acSdanielk1977     int i;
6554b5255acSdanielk1977     for(i=0; i<p->nExpr; i++){
6564b5255acSdanielk1977       heightOfExpr(p->a[i].pExpr, pnHeight);
6574b5255acSdanielk1977     }
6584b5255acSdanielk1977   }
6594b5255acSdanielk1977 }
6601a3a3086Sdan static void heightOfSelect(Select *pSelect, int *pnHeight){
6611a3a3086Sdan   Select *p;
6621a3a3086Sdan   for(p=pSelect; p; p=p->pPrior){
6634b5255acSdanielk1977     heightOfExpr(p->pWhere, pnHeight);
6644b5255acSdanielk1977     heightOfExpr(p->pHaving, pnHeight);
6654b5255acSdanielk1977     heightOfExpr(p->pLimit, pnHeight);
6664b5255acSdanielk1977     heightOfExprList(p->pEList, pnHeight);
6674b5255acSdanielk1977     heightOfExprList(p->pGroupBy, pnHeight);
6684b5255acSdanielk1977     heightOfExprList(p->pOrderBy, pnHeight);
6694b5255acSdanielk1977   }
6704b5255acSdanielk1977 }
6714b5255acSdanielk1977 
6724b5255acSdanielk1977 /*
6734b5255acSdanielk1977 ** Set the Expr.nHeight variable in the structure passed as an
6744b5255acSdanielk1977 ** argument. An expression with no children, Expr.pList or
6754b5255acSdanielk1977 ** Expr.pSelect member has a height of 1. Any other expression
6764b5255acSdanielk1977 ** has a height equal to the maximum height of any other
6774b5255acSdanielk1977 ** referenced Expr plus one.
6782308ed38Sdrh **
6792308ed38Sdrh ** Also propagate EP_Propagate flags up from Expr.x.pList to Expr.flags,
6802308ed38Sdrh ** if appropriate.
6814b5255acSdanielk1977 */
6824b5255acSdanielk1977 static void exprSetHeight(Expr *p){
6834b5255acSdanielk1977   int nHeight = 0;
6844b5255acSdanielk1977   heightOfExpr(p->pLeft, &nHeight);
6854b5255acSdanielk1977   heightOfExpr(p->pRight, &nHeight);
6866ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_xIsSelect) ){
6876ab3a2ecSdanielk1977     heightOfSelect(p->x.pSelect, &nHeight);
6882308ed38Sdrh   }else if( p->x.pList ){
6896ab3a2ecSdanielk1977     heightOfExprList(p->x.pList, &nHeight);
6902308ed38Sdrh     p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
6916ab3a2ecSdanielk1977   }
6924b5255acSdanielk1977   p->nHeight = nHeight + 1;
6934b5255acSdanielk1977 }
6944b5255acSdanielk1977 
6954b5255acSdanielk1977 /*
6964b5255acSdanielk1977 ** Set the Expr.nHeight variable using the exprSetHeight() function. If
6974b5255acSdanielk1977 ** the height is greater than the maximum allowed expression depth,
6984b5255acSdanielk1977 ** leave an error in pParse.
6992308ed38Sdrh **
7002308ed38Sdrh ** Also propagate all EP_Propagate flags from the Expr.x.pList into
7012308ed38Sdrh ** Expr.flags.
7024b5255acSdanielk1977 */
7032308ed38Sdrh void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
70474893a4cSdrh   if( pParse->nErr ) return;
7054b5255acSdanielk1977   exprSetHeight(p);
7067d10d5a6Sdrh   sqlite3ExprCheckHeight(pParse, p->nHeight);
7074b5255acSdanielk1977 }
7084b5255acSdanielk1977 
7094b5255acSdanielk1977 /*
7104b5255acSdanielk1977 ** Return the maximum height of any expression tree referenced
7114b5255acSdanielk1977 ** by the select statement passed as an argument.
7124b5255acSdanielk1977 */
7134b5255acSdanielk1977 int sqlite3SelectExprHeight(Select *p){
7144b5255acSdanielk1977   int nHeight = 0;
7154b5255acSdanielk1977   heightOfSelect(p, &nHeight);
7164b5255acSdanielk1977   return nHeight;
7174b5255acSdanielk1977 }
7182308ed38Sdrh #else /* ABOVE:  Height enforcement enabled.  BELOW: Height enforcement off */
7192308ed38Sdrh /*
7202308ed38Sdrh ** Propagate all EP_Propagate flags from the Expr.x.pList into
7212308ed38Sdrh ** Expr.flags.
7222308ed38Sdrh */
7232308ed38Sdrh void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
7242308ed38Sdrh   if( p && p->x.pList && !ExprHasProperty(p, EP_xIsSelect) ){
7252308ed38Sdrh     p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
7262308ed38Sdrh   }
7272308ed38Sdrh }
7284b5255acSdanielk1977 #define exprSetHeight(y)
7294b5255acSdanielk1977 #endif /* SQLITE_MAX_EXPR_DEPTH>0 */
7304b5255acSdanielk1977 
731be5c89acSdrh /*
732b7916a78Sdrh ** This routine is the core allocator for Expr nodes.
733b7916a78Sdrh **
734a76b5dfcSdrh ** Construct a new expression node and return a pointer to it.  Memory
735b7916a78Sdrh ** for this node and for the pToken argument is a single allocation
736b7916a78Sdrh ** obtained from sqlite3DbMalloc().  The calling function
737a76b5dfcSdrh ** is responsible for making sure the node eventually gets freed.
738b7916a78Sdrh **
739b7916a78Sdrh ** If dequote is true, then the token (if it exists) is dequoted.
740e792b5b4Sdrh ** If dequote is false, no dequoting is performed.  The deQuote
741b7916a78Sdrh ** parameter is ignored if pToken is NULL or if the token does not
742b7916a78Sdrh ** appear to be quoted.  If the quotes were of the form "..." (double-quotes)
743b7916a78Sdrh ** then the EP_DblQuoted flag is set on the expression node.
74433e619fcSdrh **
74533e619fcSdrh ** Special case:  If op==TK_INTEGER and pToken points to a string that
74633e619fcSdrh ** can be translated into a 32-bit integer, then the token is not
74733e619fcSdrh ** stored in u.zToken.  Instead, the integer values is written
74833e619fcSdrh ** into u.iValue and the EP_IntValue flag is set.  No extra storage
74933e619fcSdrh ** is allocated to hold the integer text and the dequote flag is ignored.
750a76b5dfcSdrh */
751b7916a78Sdrh Expr *sqlite3ExprAlloc(
752cca8a4adSdrh   sqlite3 *db,            /* Handle for sqlite3DbMallocRawNN() */
75317435752Sdrh   int op,                 /* Expression opcode */
754b7916a78Sdrh   const Token *pToken,    /* Token argument.  Might be NULL */
755b7916a78Sdrh   int dequote             /* True to dequote */
75617435752Sdrh ){
757a76b5dfcSdrh   Expr *pNew;
75833e619fcSdrh   int nExtra = 0;
759cf697396Sshane   int iValue = 0;
760b7916a78Sdrh 
761575fad65Sdrh   assert( db!=0 );
762b7916a78Sdrh   if( pToken ){
76333e619fcSdrh     if( op!=TK_INTEGER || pToken->z==0
76433e619fcSdrh           || sqlite3GetInt32(pToken->z, &iValue)==0 ){
765b7916a78Sdrh       nExtra = pToken->n+1;
766d50ffc41Sdrh       assert( iValue>=0 );
76733e619fcSdrh     }
768a76b5dfcSdrh   }
769575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, sizeof(Expr)+nExtra);
770b7916a78Sdrh   if( pNew ){
771ca3862dcSdrh     memset(pNew, 0, sizeof(Expr));
7721bd10f8aSdrh     pNew->op = (u8)op;
773a58fdfb1Sdanielk1977     pNew->iAgg = -1;
774a76b5dfcSdrh     if( pToken ){
77533e619fcSdrh       if( nExtra==0 ){
776ad31727fSdrh         pNew->flags |= EP_IntValue|EP_Leaf|(iValue?EP_IsTrue:EP_IsFalse);
77733e619fcSdrh         pNew->u.iValue = iValue;
77833e619fcSdrh       }else{
77933e619fcSdrh         pNew->u.zToken = (char*)&pNew[1];
780b07028f7Sdrh         assert( pToken->z!=0 || pToken->n==0 );
781b07028f7Sdrh         if( pToken->n ) memcpy(pNew->u.zToken, pToken->z, pToken->n);
78233e619fcSdrh         pNew->u.zToken[pToken->n] = 0;
783244b9d6eSdrh         if( dequote && sqlite3Isquote(pNew->u.zToken[0]) ){
78451d35b0fSdrh           sqlite3DequoteExpr(pNew);
785a34001c9Sdrh         }
786a34001c9Sdrh       }
78733e619fcSdrh     }
788b7916a78Sdrh #if SQLITE_MAX_EXPR_DEPTH>0
789b7916a78Sdrh     pNew->nHeight = 1;
790b7916a78Sdrh #endif
791a34001c9Sdrh   }
792a76b5dfcSdrh   return pNew;
793a76b5dfcSdrh }
794a76b5dfcSdrh 
795a76b5dfcSdrh /*
796b7916a78Sdrh ** Allocate a new expression node from a zero-terminated token that has
797b7916a78Sdrh ** already been dequoted.
798b7916a78Sdrh */
799b7916a78Sdrh Expr *sqlite3Expr(
800b7916a78Sdrh   sqlite3 *db,            /* Handle for sqlite3DbMallocZero() (may be null) */
801b7916a78Sdrh   int op,                 /* Expression opcode */
802b7916a78Sdrh   const char *zToken      /* Token argument.  Might be NULL */
803b7916a78Sdrh ){
804b7916a78Sdrh   Token x;
805b7916a78Sdrh   x.z = zToken;
806b40f06c6Sdrh   x.n = sqlite3Strlen30(zToken);
807b7916a78Sdrh   return sqlite3ExprAlloc(db, op, &x, 0);
808b7916a78Sdrh }
809b7916a78Sdrh 
810b7916a78Sdrh /*
811b7916a78Sdrh ** Attach subtrees pLeft and pRight to the Expr node pRoot.
812b7916a78Sdrh **
813b7916a78Sdrh ** If pRoot==NULL that means that a memory allocation error has occurred.
814b7916a78Sdrh ** In that case, delete the subtrees pLeft and pRight.
815b7916a78Sdrh */
816b7916a78Sdrh void sqlite3ExprAttachSubtrees(
817b7916a78Sdrh   sqlite3 *db,
818b7916a78Sdrh   Expr *pRoot,
819b7916a78Sdrh   Expr *pLeft,
820b7916a78Sdrh   Expr *pRight
821b7916a78Sdrh ){
822b7916a78Sdrh   if( pRoot==0 ){
823b7916a78Sdrh     assert( db->mallocFailed );
824b7916a78Sdrh     sqlite3ExprDelete(db, pLeft);
825b7916a78Sdrh     sqlite3ExprDelete(db, pRight);
826b7916a78Sdrh   }else{
827b7916a78Sdrh     if( pRight ){
828b7916a78Sdrh       pRoot->pRight = pRight;
829885a5b03Sdrh       pRoot->flags |= EP_Propagate & pRight->flags;
830b7916a78Sdrh     }
831b7916a78Sdrh     if( pLeft ){
832b7916a78Sdrh       pRoot->pLeft = pLeft;
833885a5b03Sdrh       pRoot->flags |= EP_Propagate & pLeft->flags;
834b7916a78Sdrh     }
835b7916a78Sdrh     exprSetHeight(pRoot);
836b7916a78Sdrh   }
837b7916a78Sdrh }
838b7916a78Sdrh 
839b7916a78Sdrh /*
84060ec914cSpeter.d.reid ** Allocate an Expr node which joins as many as two subtrees.
841b7916a78Sdrh **
842bf664469Sdrh ** One or both of the subtrees can be NULL.  Return a pointer to the new
843bf664469Sdrh ** Expr node.  Or, if an OOM error occurs, set pParse->db->mallocFailed,
844bf664469Sdrh ** free the subtrees and return NULL.
845206f3d96Sdrh */
84617435752Sdrh Expr *sqlite3PExpr(
84717435752Sdrh   Parse *pParse,          /* Parsing context */
84817435752Sdrh   int op,                 /* Expression opcode */
84917435752Sdrh   Expr *pLeft,            /* Left operand */
850abfd35eaSdrh   Expr *pRight            /* Right operand */
85117435752Sdrh ){
8525fb52caaSdrh   Expr *p;
853abfd35eaSdrh   p = sqlite3DbMallocRawNN(pParse->db, sizeof(Expr));
854abfd35eaSdrh   if( p ){
855abfd35eaSdrh     memset(p, 0, sizeof(Expr));
856f1722baaSdrh     p->op = op & 0xff;
857abfd35eaSdrh     p->iAgg = -1;
858b7916a78Sdrh     sqlite3ExprAttachSubtrees(pParse->db, p, pLeft, pRight);
8592b359bdbSdan     sqlite3ExprCheckHeight(pParse, p->nHeight);
860d5c851c1Sdrh   }else{
861d5c851c1Sdrh     sqlite3ExprDelete(pParse->db, pLeft);
862d5c851c1Sdrh     sqlite3ExprDelete(pParse->db, pRight);
8632b359bdbSdan   }
8644e0cff60Sdrh   return p;
8654e0cff60Sdrh }
8664e0cff60Sdrh 
8674e0cff60Sdrh /*
86808de4f79Sdrh ** Add pSelect to the Expr.x.pSelect field.  Or, if pExpr is NULL (due
86908de4f79Sdrh ** do a memory allocation failure) then delete the pSelect object.
87008de4f79Sdrh */
87108de4f79Sdrh void sqlite3PExprAddSelect(Parse *pParse, Expr *pExpr, Select *pSelect){
87208de4f79Sdrh   if( pExpr ){
87308de4f79Sdrh     pExpr->x.pSelect = pSelect;
87408de4f79Sdrh     ExprSetProperty(pExpr, EP_xIsSelect|EP_Subquery);
87508de4f79Sdrh     sqlite3ExprSetHeightAndFlags(pParse, pExpr);
87608de4f79Sdrh   }else{
87708de4f79Sdrh     assert( pParse->db->mallocFailed );
87808de4f79Sdrh     sqlite3SelectDelete(pParse->db, pSelect);
87908de4f79Sdrh   }
88008de4f79Sdrh }
88108de4f79Sdrh 
88208de4f79Sdrh 
88308de4f79Sdrh /*
88491bb0eedSdrh ** Join two expressions using an AND operator.  If either expression is
88591bb0eedSdrh ** NULL, then just return the other expression.
8865fb52caaSdrh **
8875fb52caaSdrh ** If one side or the other of the AND is known to be false, then instead
8885fb52caaSdrh ** of returning an AND expression, just return a constant expression with
8895fb52caaSdrh ** a value of false.
89091bb0eedSdrh */
891d5c851c1Sdrh Expr *sqlite3ExprAnd(Parse *pParse, Expr *pLeft, Expr *pRight){
892d5c851c1Sdrh   sqlite3 *db = pParse->db;
89391bb0eedSdrh   if( pLeft==0  ){
89491bb0eedSdrh     return pRight;
89591bb0eedSdrh   }else if( pRight==0 ){
89691bb0eedSdrh     return pLeft;
897d5c851c1Sdrh   }else if( pParse->nErr || IN_RENAME_OBJECT ){
898d5c851c1Sdrh     return sqlite3PExpr(pParse, TK_AND, pLeft, pRight);
899ad31727fSdrh   }else if( ExprAlwaysFalse(pLeft) || ExprAlwaysFalse(pRight) ){
9005fb52caaSdrh     sqlite3ExprDelete(db, pLeft);
9015fb52caaSdrh     sqlite3ExprDelete(db, pRight);
9025fb52caaSdrh     return sqlite3ExprAlloc(db, TK_INTEGER, &sqlite3IntTokens[0], 0);
90391bb0eedSdrh   }else{
904d5c851c1Sdrh     return sqlite3PExpr(pParse, TK_AND, pLeft, pRight);
905a76b5dfcSdrh   }
906a76b5dfcSdrh }
907a76b5dfcSdrh 
908a76b5dfcSdrh /*
909a76b5dfcSdrh ** Construct a new expression node for a function with multiple
910a76b5dfcSdrh ** arguments.
911a76b5dfcSdrh */
912954733b3Sdrh Expr *sqlite3ExprFunction(
913954733b3Sdrh   Parse *pParse,        /* Parsing context */
914954733b3Sdrh   ExprList *pList,      /* Argument list */
915954733b3Sdrh   Token *pToken,        /* Name of the function */
916954733b3Sdrh   int eDistinct         /* SF_Distinct or SF_ALL or 0 */
917954733b3Sdrh ){
918a76b5dfcSdrh   Expr *pNew;
919633e6d57Sdrh   sqlite3 *db = pParse->db;
9204b202ae2Sdanielk1977   assert( pToken );
921b7916a78Sdrh   pNew = sqlite3ExprAlloc(db, TK_FUNCTION, pToken, 1);
922a76b5dfcSdrh   if( pNew==0 ){
923d9da78a2Sdrh     sqlite3ExprListDelete(db, pList); /* Avoid memory leak when malloc fails */
924a76b5dfcSdrh     return 0;
925a76b5dfcSdrh   }
926954733b3Sdrh   if( pList && pList->nExpr > pParse->db->aLimit[SQLITE_LIMIT_FUNCTION_ARG] ){
927954733b3Sdrh     sqlite3ErrorMsg(pParse, "too many arguments on function %T", pToken);
928954733b3Sdrh   }
9296ab3a2ecSdanielk1977   pNew->x.pList = pList;
930fca23557Sdrh   ExprSetProperty(pNew, EP_HasFunc);
9316ab3a2ecSdanielk1977   assert( !ExprHasProperty(pNew, EP_xIsSelect) );
9322308ed38Sdrh   sqlite3ExprSetHeightAndFlags(pParse, pNew);
933954733b3Sdrh   if( eDistinct==SF_Distinct ) ExprSetProperty(pNew, EP_Distinct);
934a76b5dfcSdrh   return pNew;
935a76b5dfcSdrh }
936a76b5dfcSdrh 
937a76b5dfcSdrh /*
938fa6bc000Sdrh ** Assign a variable number to an expression that encodes a wildcard
939fa6bc000Sdrh ** in the original SQL statement.
940fa6bc000Sdrh **
941fa6bc000Sdrh ** Wildcards consisting of a single "?" are assigned the next sequential
942fa6bc000Sdrh ** variable number.
943fa6bc000Sdrh **
944fa6bc000Sdrh ** Wildcards of the form "?nnn" are assigned the number "nnn".  We make
9459bf755ccSdrh ** sure "nnn" is not too big to avoid a denial of service attack when
946fa6bc000Sdrh ** the SQL statement comes from an external source.
947fa6bc000Sdrh **
94851f49f17Sdrh ** Wildcards of the form ":aaa", "@aaa", or "$aaa" are assigned the same number
949fa6bc000Sdrh ** as the previous instance of the same wildcard.  Or if this is the first
95060ec914cSpeter.d.reid ** instance of the wildcard, the next sequential variable number is
951fa6bc000Sdrh ** assigned.
952fa6bc000Sdrh */
953de25a88cSdrh void sqlite3ExprAssignVarNumber(Parse *pParse, Expr *pExpr, u32 n){
95417435752Sdrh   sqlite3 *db = pParse->db;
955b7916a78Sdrh   const char *z;
956f326d66dSdrh   ynVar x;
95717435752Sdrh 
958fa6bc000Sdrh   if( pExpr==0 ) return;
959c5cd1249Sdrh   assert( !ExprHasProperty(pExpr, EP_IntValue|EP_Reduced|EP_TokenOnly) );
96033e619fcSdrh   z = pExpr->u.zToken;
961b7916a78Sdrh   assert( z!=0 );
962b7916a78Sdrh   assert( z[0]!=0 );
963b1ed717fSmistachkin   assert( n==(u32)sqlite3Strlen30(z) );
964b7916a78Sdrh   if( z[1]==0 ){
965fa6bc000Sdrh     /* Wildcard of the form "?".  Assign the next variable number */
966b7916a78Sdrh     assert( z[0]=='?' );
967f326d66dSdrh     x = (ynVar)(++pParse->nVar);
968124c0b49Sdrh   }else{
969f326d66dSdrh     int doAdd = 0;
970124c0b49Sdrh     if( z[0]=='?' ){
971fa6bc000Sdrh       /* Wildcard of the form "?nnn".  Convert "nnn" to an integer and
972fa6bc000Sdrh       ** use it as the variable number */
973c8d735aeSdan       i64 i;
97418814dfbSdrh       int bOk;
97518814dfbSdrh       if( n==2 ){ /*OPTIMIZATION-IF-TRUE*/
97618814dfbSdrh         i = z[1]-'0';  /* The common case of ?N for a single digit N */
97718814dfbSdrh         bOk = 1;
97818814dfbSdrh       }else{
97918814dfbSdrh         bOk = 0==sqlite3Atoi64(&z[1], &i, n-1, SQLITE_UTF8);
98018814dfbSdrh       }
981c5499befSdrh       testcase( i==0 );
982c5499befSdrh       testcase( i==1 );
983c5499befSdrh       testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]-1 );
984c5499befSdrh       testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] );
985c8d735aeSdan       if( bOk==0 || i<1 || i>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
986fa6bc000Sdrh         sqlite3ErrorMsg(pParse, "variable number must be between ?1 and ?%d",
987bb4957f8Sdrh             db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]);
988c9b39288Sdrh         return;
989fa6bc000Sdrh       }
9908e74e7baSdrh       x = (ynVar)i;
991f326d66dSdrh       if( x>pParse->nVar ){
992f326d66dSdrh         pParse->nVar = (int)x;
993f326d66dSdrh         doAdd = 1;
994f326d66dSdrh       }else if( sqlite3VListNumToName(pParse->pVList, x)==0 ){
995f326d66dSdrh         doAdd = 1;
996fa6bc000Sdrh       }
997fa6bc000Sdrh     }else{
99851f49f17Sdrh       /* Wildcards like ":aaa", "$aaa" or "@aaa".  Reuse the same variable
999fa6bc000Sdrh       ** number as the prior appearance of the same name, or if the name
1000fa6bc000Sdrh       ** has never appeared before, reuse the same variable number
1001fa6bc000Sdrh       */
10029bf755ccSdrh       x = (ynVar)sqlite3VListNameToNum(pParse->pVList, z, n);
10039bf755ccSdrh       if( x==0 ){
10049bf755ccSdrh         x = (ynVar)(++pParse->nVar);
1005f326d66dSdrh         doAdd = 1;
1006f326d66dSdrh       }
1007f326d66dSdrh     }
1008f326d66dSdrh     if( doAdd ){
10099bf755ccSdrh       pParse->pVList = sqlite3VListAdd(db, pParse->pVList, z, n, x);
1010fa6bc000Sdrh     }
1011fa6bc000Sdrh   }
1012c9b39288Sdrh   pExpr->iColumn = x;
1013f326d66dSdrh   if( x>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
1014832b2664Sdanielk1977     sqlite3ErrorMsg(pParse, "too many SQL variables");
1015832b2664Sdanielk1977   }
1016fa6bc000Sdrh }
1017fa6bc000Sdrh 
1018fa6bc000Sdrh /*
1019f6963f99Sdan ** Recursively delete an expression tree.
1020a2e00042Sdrh */
10214f0010b1Sdrh static SQLITE_NOINLINE void sqlite3ExprDeleteNN(sqlite3 *db, Expr *p){
10224f0010b1Sdrh   assert( p!=0 );
1023d50ffc41Sdrh   /* Sanity check: Assert that the IntValue is non-negative if it exists */
1024d50ffc41Sdrh   assert( !ExprHasProperty(p, EP_IntValue) || p->u.iValue>=0 );
1025eda079cdSdrh 
1026eda079cdSdrh   assert( !ExprHasProperty(p, EP_WinFunc) || p->y.pWin!=0 || db->mallocFailed );
1027eda079cdSdrh   assert( p->op!=TK_FUNCTION || ExprHasProperty(p, EP_TokenOnly|EP_Reduced)
1028eda079cdSdrh           || p->y.pWin==0 || ExprHasProperty(p, EP_WinFunc) );
1029209bc522Sdrh #ifdef SQLITE_DEBUG
1030209bc522Sdrh   if( ExprHasProperty(p, EP_Leaf) && !ExprHasProperty(p, EP_TokenOnly) ){
1031209bc522Sdrh     assert( p->pLeft==0 );
1032209bc522Sdrh     assert( p->pRight==0 );
1033209bc522Sdrh     assert( p->x.pSelect==0 );
1034209bc522Sdrh   }
1035209bc522Sdrh #endif
1036209bc522Sdrh   if( !ExprHasProperty(p, (EP_TokenOnly|EP_Leaf)) ){
1037c5cd1249Sdrh     /* The Expr.x union is never used at the same time as Expr.pRight */
1038c5cd1249Sdrh     assert( p->x.pList==0 || p->pRight==0 );
10394910a76dSdrh     if( p->pLeft && p->op!=TK_SELECT_COLUMN ) sqlite3ExprDeleteNN(db, p->pLeft);
1040d1086679Sdrh     if( p->pRight ){
1041d1086679Sdrh       sqlite3ExprDeleteNN(db, p->pRight);
1042d1086679Sdrh     }else if( ExprHasProperty(p, EP_xIsSelect) ){
10436ab3a2ecSdanielk1977       sqlite3SelectDelete(db, p->x.pSelect);
10446ab3a2ecSdanielk1977     }else{
10456ab3a2ecSdanielk1977       sqlite3ExprListDelete(db, p->x.pList);
10466ab3a2ecSdanielk1977     }
1047eda079cdSdrh     if( ExprHasProperty(p, EP_WinFunc) ){
1048eda079cdSdrh       assert( p->op==TK_FUNCTION );
1049eda079cdSdrh       sqlite3WindowDelete(db, p->y.pWin);
105086fb6e17Sdan     }
10516ab3a2ecSdanielk1977   }
1052209bc522Sdrh   if( ExprHasProperty(p, EP_MemToken) ) sqlite3DbFree(db, p->u.zToken);
105333e619fcSdrh   if( !ExprHasProperty(p, EP_Static) ){
1054dbd6a7dcSdrh     sqlite3DbFreeNN(db, p);
1055a2e00042Sdrh   }
105633e619fcSdrh }
10574f0010b1Sdrh void sqlite3ExprDelete(sqlite3 *db, Expr *p){
10584f0010b1Sdrh   if( p ) sqlite3ExprDeleteNN(db, p);
10594f0010b1Sdrh }
1060a2e00042Sdrh 
1061d2687b77Sdrh /*
10626ab3a2ecSdanielk1977 ** Return the number of bytes allocated for the expression structure
10636ab3a2ecSdanielk1977 ** passed as the first argument. This is always one of EXPR_FULLSIZE,
10646ab3a2ecSdanielk1977 ** EXPR_REDUCEDSIZE or EXPR_TOKENONLYSIZE.
10656ab3a2ecSdanielk1977 */
10666ab3a2ecSdanielk1977 static int exprStructSize(Expr *p){
10676ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_TokenOnly) ) return EXPR_TOKENONLYSIZE;
10686ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_Reduced) ) return EXPR_REDUCEDSIZE;
10696ab3a2ecSdanielk1977   return EXPR_FULLSIZE;
10706ab3a2ecSdanielk1977 }
10716ab3a2ecSdanielk1977 
10726ab3a2ecSdanielk1977 /*
1073a8e05761Sdrh ** Copy the complete content of an Expr node, taking care not to read
1074a8e05761Sdrh ** past the end of the structure for a reduced-size version of the source
1075a8e05761Sdrh ** Expr.
1076a8e05761Sdrh */
1077a8e05761Sdrh static void exprNodeCopy(Expr *pDest, Expr *pSrc){
1078a8e05761Sdrh   memset(pDest, 0, sizeof(Expr));
1079a8e05761Sdrh   memcpy(pDest, pSrc, exprStructSize(pSrc));
1080a8e05761Sdrh }
1081a8e05761Sdrh 
1082a8e05761Sdrh /*
108333e619fcSdrh ** The dupedExpr*Size() routines each return the number of bytes required
108433e619fcSdrh ** to store a copy of an expression or expression tree.  They differ in
108533e619fcSdrh ** how much of the tree is measured.
108633e619fcSdrh **
108733e619fcSdrh **     dupedExprStructSize()     Size of only the Expr structure
108833e619fcSdrh **     dupedExprNodeSize()       Size of Expr + space for token
108933e619fcSdrh **     dupedExprSize()           Expr + token + subtree components
109033e619fcSdrh **
109133e619fcSdrh ***************************************************************************
109233e619fcSdrh **
109333e619fcSdrh ** The dupedExprStructSize() function returns two values OR-ed together:
109433e619fcSdrh ** (1) the space required for a copy of the Expr structure only and
109533e619fcSdrh ** (2) the EP_xxx flags that indicate what the structure size should be.
109633e619fcSdrh ** The return values is always one of:
109733e619fcSdrh **
109833e619fcSdrh **      EXPR_FULLSIZE
109933e619fcSdrh **      EXPR_REDUCEDSIZE   | EP_Reduced
110033e619fcSdrh **      EXPR_TOKENONLYSIZE | EP_TokenOnly
110133e619fcSdrh **
110233e619fcSdrh ** The size of the structure can be found by masking the return value
110333e619fcSdrh ** of this routine with 0xfff.  The flags can be found by masking the
110433e619fcSdrh ** return value with EP_Reduced|EP_TokenOnly.
110533e619fcSdrh **
110633e619fcSdrh ** Note that with flags==EXPRDUP_REDUCE, this routines works on full-size
110733e619fcSdrh ** (unreduced) Expr objects as they or originally constructed by the parser.
110833e619fcSdrh ** During expression analysis, extra information is computed and moved into
1109c95f38d4Sdan ** later parts of the Expr object and that extra information might get chopped
111033e619fcSdrh ** off if the expression is reduced.  Note also that it does not work to
111160ec914cSpeter.d.reid ** make an EXPRDUP_REDUCE copy of a reduced expression.  It is only legal
111233e619fcSdrh ** to reduce a pristine expression tree from the parser.  The implementation
111333e619fcSdrh ** of dupedExprStructSize() contain multiple assert() statements that attempt
111433e619fcSdrh ** to enforce this constraint.
11156ab3a2ecSdanielk1977 */
11166ab3a2ecSdanielk1977 static int dupedExprStructSize(Expr *p, int flags){
11176ab3a2ecSdanielk1977   int nSize;
111833e619fcSdrh   assert( flags==EXPRDUP_REDUCE || flags==0 ); /* Only one flag value allowed */
1119aecd8021Sdrh   assert( EXPR_FULLSIZE<=0xfff );
1120aecd8021Sdrh   assert( (0xfff & (EP_Reduced|EP_TokenOnly))==0 );
112167a9b8edSdan   if( 0==flags || p->op==TK_SELECT_COLUMN
112267a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
1123eda079cdSdrh    || ExprHasProperty(p, EP_WinFunc)
112467a9b8edSdan #endif
112567a9b8edSdan   ){
11266ab3a2ecSdanielk1977     nSize = EXPR_FULLSIZE;
11276ab3a2ecSdanielk1977   }else{
1128c5cd1249Sdrh     assert( !ExprHasProperty(p, EP_TokenOnly|EP_Reduced) );
112933e619fcSdrh     assert( !ExprHasProperty(p, EP_FromJoin) );
1130c5cd1249Sdrh     assert( !ExprHasProperty(p, EP_MemToken) );
1131ebb6a65dSdrh     assert( !ExprHasProperty(p, EP_NoReduce) );
1132aecd8021Sdrh     if( p->pLeft || p->x.pList ){
113333e619fcSdrh       nSize = EXPR_REDUCEDSIZE | EP_Reduced;
113433e619fcSdrh     }else{
1135aecd8021Sdrh       assert( p->pRight==0 );
113633e619fcSdrh       nSize = EXPR_TOKENONLYSIZE | EP_TokenOnly;
113733e619fcSdrh     }
11386ab3a2ecSdanielk1977   }
11396ab3a2ecSdanielk1977   return nSize;
11406ab3a2ecSdanielk1977 }
11416ab3a2ecSdanielk1977 
11426ab3a2ecSdanielk1977 /*
114333e619fcSdrh ** This function returns the space in bytes required to store the copy
114433e619fcSdrh ** of the Expr structure and a copy of the Expr.u.zToken string (if that
114533e619fcSdrh ** string is defined.)
11466ab3a2ecSdanielk1977 */
11476ab3a2ecSdanielk1977 static int dupedExprNodeSize(Expr *p, int flags){
114833e619fcSdrh   int nByte = dupedExprStructSize(p, flags) & 0xfff;
114933e619fcSdrh   if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
11507301e774Sdrh     nByte += sqlite3Strlen30NN(p->u.zToken)+1;
11516ab3a2ecSdanielk1977   }
1152bc73971dSdanielk1977   return ROUND8(nByte);
11536ab3a2ecSdanielk1977 }
11546ab3a2ecSdanielk1977 
11556ab3a2ecSdanielk1977 /*
11566ab3a2ecSdanielk1977 ** Return the number of bytes required to create a duplicate of the
11576ab3a2ecSdanielk1977 ** expression passed as the first argument. The second argument is a
11586ab3a2ecSdanielk1977 ** mask containing EXPRDUP_XXX flags.
11596ab3a2ecSdanielk1977 **
11606ab3a2ecSdanielk1977 ** The value returned includes space to create a copy of the Expr struct
116133e619fcSdrh ** itself and the buffer referred to by Expr.u.zToken, if any.
11626ab3a2ecSdanielk1977 **
11636ab3a2ecSdanielk1977 ** If the EXPRDUP_REDUCE flag is set, then the return value includes
11646ab3a2ecSdanielk1977 ** space to duplicate all Expr nodes in the tree formed by Expr.pLeft
11656ab3a2ecSdanielk1977 ** and Expr.pRight variables (but not for any structures pointed to or
11666ab3a2ecSdanielk1977 ** descended from the Expr.x.pList or Expr.x.pSelect variables).
11676ab3a2ecSdanielk1977 */
11686ab3a2ecSdanielk1977 static int dupedExprSize(Expr *p, int flags){
11696ab3a2ecSdanielk1977   int nByte = 0;
11706ab3a2ecSdanielk1977   if( p ){
11716ab3a2ecSdanielk1977     nByte = dupedExprNodeSize(p, flags);
11726ab3a2ecSdanielk1977     if( flags&EXPRDUP_REDUCE ){
1173b7916a78Sdrh       nByte += dupedExprSize(p->pLeft, flags) + dupedExprSize(p->pRight, flags);
11746ab3a2ecSdanielk1977     }
11756ab3a2ecSdanielk1977   }
11766ab3a2ecSdanielk1977   return nByte;
11776ab3a2ecSdanielk1977 }
11786ab3a2ecSdanielk1977 
11796ab3a2ecSdanielk1977 /*
11806ab3a2ecSdanielk1977 ** This function is similar to sqlite3ExprDup(), except that if pzBuffer
11816ab3a2ecSdanielk1977 ** is not NULL then *pzBuffer is assumed to point to a buffer large enough
118233e619fcSdrh ** to store the copy of expression p, the copies of p->u.zToken
11836ab3a2ecSdanielk1977 ** (if applicable), and the copies of the p->pLeft and p->pRight expressions,
118460ec914cSpeter.d.reid ** if any. Before returning, *pzBuffer is set to the first byte past the
11856ab3a2ecSdanielk1977 ** portion of the buffer copied into by this function.
11866ab3a2ecSdanielk1977 */
11873c19469cSdrh static Expr *exprDup(sqlite3 *db, Expr *p, int dupFlags, u8 **pzBuffer){
11883c19469cSdrh   Expr *pNew;           /* Value to return */
11893c19469cSdrh   u8 *zAlloc;           /* Memory space from which to build Expr object */
11903c19469cSdrh   u32 staticFlag;       /* EP_Static if space not obtained from malloc */
11916ab3a2ecSdanielk1977 
11923c19469cSdrh   assert( db!=0 );
11933c19469cSdrh   assert( p );
11943c19469cSdrh   assert( dupFlags==0 || dupFlags==EXPRDUP_REDUCE );
11953c19469cSdrh   assert( pzBuffer==0 || dupFlags==EXPRDUP_REDUCE );
11966ab3a2ecSdanielk1977 
11976ab3a2ecSdanielk1977   /* Figure out where to write the new Expr structure. */
11986ab3a2ecSdanielk1977   if( pzBuffer ){
11996ab3a2ecSdanielk1977     zAlloc = *pzBuffer;
120033e619fcSdrh     staticFlag = EP_Static;
12016ab3a2ecSdanielk1977   }else{
12023c19469cSdrh     zAlloc = sqlite3DbMallocRawNN(db, dupedExprSize(p, dupFlags));
12033c19469cSdrh     staticFlag = 0;
12046ab3a2ecSdanielk1977   }
12056ab3a2ecSdanielk1977   pNew = (Expr *)zAlloc;
12066ab3a2ecSdanielk1977 
12076ab3a2ecSdanielk1977   if( pNew ){
12086ab3a2ecSdanielk1977     /* Set nNewSize to the size allocated for the structure pointed to
12096ab3a2ecSdanielk1977     ** by pNew. This is either EXPR_FULLSIZE, EXPR_REDUCEDSIZE or
12106ab3a2ecSdanielk1977     ** EXPR_TOKENONLYSIZE. nToken is set to the number of bytes consumed
121133e619fcSdrh     ** by the copy of the p->u.zToken string (if any).
12126ab3a2ecSdanielk1977     */
12133c19469cSdrh     const unsigned nStructSize = dupedExprStructSize(p, dupFlags);
121433e619fcSdrh     const int nNewSize = nStructSize & 0xfff;
121533e619fcSdrh     int nToken;
121633e619fcSdrh     if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
121733e619fcSdrh       nToken = sqlite3Strlen30(p->u.zToken) + 1;
121833e619fcSdrh     }else{
121933e619fcSdrh       nToken = 0;
122033e619fcSdrh     }
12213c19469cSdrh     if( dupFlags ){
12226ab3a2ecSdanielk1977       assert( ExprHasProperty(p, EP_Reduced)==0 );
12236ab3a2ecSdanielk1977       memcpy(zAlloc, p, nNewSize);
12246ab3a2ecSdanielk1977     }else{
12253e6a1411Sdan       u32 nSize = (u32)exprStructSize(p);
12266ab3a2ecSdanielk1977       memcpy(zAlloc, p, nSize);
122772ea29d7Sdrh       if( nSize<EXPR_FULLSIZE ){
12286ab3a2ecSdanielk1977         memset(&zAlloc[nSize], 0, EXPR_FULLSIZE-nSize);
12296ab3a2ecSdanielk1977       }
123072ea29d7Sdrh     }
12316ab3a2ecSdanielk1977 
123233e619fcSdrh     /* Set the EP_Reduced, EP_TokenOnly, and EP_Static flags appropriately. */
1233c5cd1249Sdrh     pNew->flags &= ~(EP_Reduced|EP_TokenOnly|EP_Static|EP_MemToken);
123433e619fcSdrh     pNew->flags |= nStructSize & (EP_Reduced|EP_TokenOnly);
123533e619fcSdrh     pNew->flags |= staticFlag;
12366ab3a2ecSdanielk1977 
123733e619fcSdrh     /* Copy the p->u.zToken string, if any. */
12386ab3a2ecSdanielk1977     if( nToken ){
123933e619fcSdrh       char *zToken = pNew->u.zToken = (char*)&zAlloc[nNewSize];
124033e619fcSdrh       memcpy(zToken, p->u.zToken, nToken);
12416ab3a2ecSdanielk1977     }
12426ab3a2ecSdanielk1977 
1243209bc522Sdrh     if( 0==((p->flags|pNew->flags) & (EP_TokenOnly|EP_Leaf)) ){
12446ab3a2ecSdanielk1977       /* Fill in the pNew->x.pSelect or pNew->x.pList member. */
12456ab3a2ecSdanielk1977       if( ExprHasProperty(p, EP_xIsSelect) ){
12463c19469cSdrh         pNew->x.pSelect = sqlite3SelectDup(db, p->x.pSelect, dupFlags);
12476ab3a2ecSdanielk1977       }else{
12483c19469cSdrh         pNew->x.pList = sqlite3ExprListDup(db, p->x.pList, dupFlags);
12496ab3a2ecSdanielk1977       }
12506ab3a2ecSdanielk1977     }
12516ab3a2ecSdanielk1977 
12526ab3a2ecSdanielk1977     /* Fill in pNew->pLeft and pNew->pRight. */
125353988068Sdrh     if( ExprHasProperty(pNew, EP_Reduced|EP_TokenOnly|EP_WinFunc) ){
12543c19469cSdrh       zAlloc += dupedExprNodeSize(p, dupFlags);
1255209bc522Sdrh       if( !ExprHasProperty(pNew, EP_TokenOnly|EP_Leaf) ){
12563c19469cSdrh         pNew->pLeft = p->pLeft ?
12573c19469cSdrh                       exprDup(db, p->pLeft, EXPRDUP_REDUCE, &zAlloc) : 0;
12583c19469cSdrh         pNew->pRight = p->pRight ?
12593c19469cSdrh                        exprDup(db, p->pRight, EXPRDUP_REDUCE, &zAlloc) : 0;
12606ab3a2ecSdanielk1977       }
126167a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
1262eda079cdSdrh       if( ExprHasProperty(p, EP_WinFunc) ){
1263eda079cdSdrh         pNew->y.pWin = sqlite3WindowDup(db, pNew, p->y.pWin);
1264eda079cdSdrh         assert( ExprHasProperty(pNew, EP_WinFunc) );
1265e2f781b9Sdan       }
126667a9b8edSdan #endif /* SQLITE_OMIT_WINDOWFUNC */
126753988068Sdrh       if( pzBuffer ){
126853988068Sdrh         *pzBuffer = zAlloc;
126953988068Sdrh       }
127053988068Sdrh     }else{
1271209bc522Sdrh       if( !ExprHasProperty(p, EP_TokenOnly|EP_Leaf) ){
12729854260bSdrh         if( pNew->op==TK_SELECT_COLUMN ){
12739854260bSdrh           pNew->pLeft = p->pLeft;
127447073f62Sdrh           assert( p->iColumn==0 || p->pRight==0 );
127547073f62Sdrh           assert( p->pRight==0  || p->pRight==p->pLeft );
12769854260bSdrh         }else{
12776ab3a2ecSdanielk1977           pNew->pLeft = sqlite3ExprDup(db, p->pLeft, 0);
12789854260bSdrh         }
12796ab3a2ecSdanielk1977         pNew->pRight = sqlite3ExprDup(db, p->pRight, 0);
12806ab3a2ecSdanielk1977       }
12816ab3a2ecSdanielk1977     }
12826ab3a2ecSdanielk1977   }
12836ab3a2ecSdanielk1977   return pNew;
12846ab3a2ecSdanielk1977 }
12856ab3a2ecSdanielk1977 
12866ab3a2ecSdanielk1977 /*
1287bfe31e7fSdan ** Create and return a deep copy of the object passed as the second
1288bfe31e7fSdan ** argument. If an OOM condition is encountered, NULL is returned
1289bfe31e7fSdan ** and the db->mallocFailed flag set.
1290bfe31e7fSdan */
1291eede6a53Sdan #ifndef SQLITE_OMIT_CTE
1292bfe31e7fSdan static With *withDup(sqlite3 *db, With *p){
12934e9119d9Sdan   With *pRet = 0;
12944e9119d9Sdan   if( p ){
1295d4de9f7bSdrh     sqlite3_int64 nByte = sizeof(*p) + sizeof(p->a[0]) * (p->nCte-1);
12964e9119d9Sdan     pRet = sqlite3DbMallocZero(db, nByte);
12974e9119d9Sdan     if( pRet ){
12984e9119d9Sdan       int i;
12994e9119d9Sdan       pRet->nCte = p->nCte;
13004e9119d9Sdan       for(i=0; i<p->nCte; i++){
13014e9119d9Sdan         pRet->a[i].pSelect = sqlite3SelectDup(db, p->a[i].pSelect, 0);
13024e9119d9Sdan         pRet->a[i].pCols = sqlite3ExprListDup(db, p->a[i].pCols, 0);
13034e9119d9Sdan         pRet->a[i].zName = sqlite3DbStrDup(db, p->a[i].zName);
13044e9119d9Sdan       }
13054e9119d9Sdan     }
13064e9119d9Sdan   }
13074e9119d9Sdan   return pRet;
13084e9119d9Sdan }
1309eede6a53Sdan #else
1310eede6a53Sdan # define withDup(x,y) 0
1311eede6a53Sdan #endif
13124e9119d9Sdan 
1313a8389975Sdrh #ifndef SQLITE_OMIT_WINDOWFUNC
1314a8389975Sdrh /*
1315a8389975Sdrh ** The gatherSelectWindows() procedure and its helper routine
1316a8389975Sdrh ** gatherSelectWindowsCallback() are used to scan all the expressions
1317a8389975Sdrh ** an a newly duplicated SELECT statement and gather all of the Window
1318a8389975Sdrh ** objects found there, assembling them onto the linked list at Select->pWin.
1319a8389975Sdrh */
1320a8389975Sdrh static int gatherSelectWindowsCallback(Walker *pWalker, Expr *pExpr){
1321a8389975Sdrh   if( pExpr->op==TK_FUNCTION && pExpr->y.pWin!=0 ){
1322a8389975Sdrh     assert( ExprHasProperty(pExpr, EP_WinFunc) );
1323a8389975Sdrh     pExpr->y.pWin->pNextWin = pWalker->u.pSelect->pWin;
1324a8389975Sdrh     pWalker->u.pSelect->pWin = pExpr->y.pWin;
1325a8389975Sdrh   }
1326a8389975Sdrh   return WRC_Continue;
1327a8389975Sdrh }
1328a37b6a5eSdrh static int gatherSelectWindowsSelectCallback(Walker *pWalker, Select *p){
1329a37b6a5eSdrh   return p==pWalker->u.pSelect ? WRC_Continue : WRC_Prune;
1330a37b6a5eSdrh }
1331a8389975Sdrh static void gatherSelectWindows(Select *p){
1332a8389975Sdrh   Walker w;
1333a8389975Sdrh   w.xExprCallback = gatherSelectWindowsCallback;
1334a37b6a5eSdrh   w.xSelectCallback = gatherSelectWindowsSelectCallback;
1335a37b6a5eSdrh   w.xSelectCallback2 = 0;
13369c46c66cSdrh   w.pParse = 0;
1337a8389975Sdrh   w.u.pSelect = p;
1338a37b6a5eSdrh   sqlite3WalkSelect(&w, p);
1339a8389975Sdrh }
1340a8389975Sdrh #endif
1341a8389975Sdrh 
1342a8389975Sdrh 
1343a76b5dfcSdrh /*
1344ff78bd2fSdrh ** The following group of routines make deep copies of expressions,
1345ff78bd2fSdrh ** expression lists, ID lists, and select statements.  The copies can
1346ff78bd2fSdrh ** be deleted (by being passed to their respective ...Delete() routines)
1347ff78bd2fSdrh ** without effecting the originals.
1348ff78bd2fSdrh **
13494adee20fSdanielk1977 ** The expression list, ID, and source lists return by sqlite3ExprListDup(),
13504adee20fSdanielk1977 ** sqlite3IdListDup(), and sqlite3SrcListDup() can not be further expanded
1351ad3cab52Sdrh ** by subsequent calls to sqlite*ListAppend() routines.
1352ff78bd2fSdrh **
1353ad3cab52Sdrh ** Any tables that the SrcList might point to are not duplicated.
13546ab3a2ecSdanielk1977 **
1355b7916a78Sdrh ** The flags parameter contains a combination of the EXPRDUP_XXX flags.
13566ab3a2ecSdanielk1977 ** If the EXPRDUP_REDUCE flag is set, then the structure returned is a
13576ab3a2ecSdanielk1977 ** truncated version of the usual Expr structure that will be stored as
13586ab3a2ecSdanielk1977 ** part of the in-memory representation of the database schema.
1359ff78bd2fSdrh */
13606ab3a2ecSdanielk1977 Expr *sqlite3ExprDup(sqlite3 *db, Expr *p, int flags){
136172ea29d7Sdrh   assert( flags==0 || flags==EXPRDUP_REDUCE );
13623c19469cSdrh   return p ? exprDup(db, p, flags, 0) : 0;
1363ff78bd2fSdrh }
13646ab3a2ecSdanielk1977 ExprList *sqlite3ExprListDup(sqlite3 *db, ExprList *p, int flags){
1365ff78bd2fSdrh   ExprList *pNew;
1366145716b3Sdrh   struct ExprList_item *pItem, *pOldItem;
1367ff78bd2fSdrh   int i;
1368b163748eSdrh   Expr *pPriorSelectCol = 0;
1369575fad65Sdrh   assert( db!=0 );
1370ff78bd2fSdrh   if( p==0 ) return 0;
137197258194Sdrh   pNew = sqlite3DbMallocRawNN(db, sqlite3DbMallocSize(db, p));
1372ff78bd2fSdrh   if( pNew==0 ) return 0;
1373a19543feSdrh   pNew->nExpr = p->nExpr;
137443606175Sdrh   pItem = pNew->a;
1375145716b3Sdrh   pOldItem = p->a;
1376145716b3Sdrh   for(i=0; i<p->nExpr; i++, pItem++, pOldItem++){
13776ab3a2ecSdanielk1977     Expr *pOldExpr = pOldItem->pExpr;
137847073f62Sdrh     Expr *pNewExpr;
1379b5526ea6Sdrh     pItem->pExpr = sqlite3ExprDup(db, pOldExpr, flags);
138047073f62Sdrh     if( pOldExpr
138147073f62Sdrh      && pOldExpr->op==TK_SELECT_COLUMN
138247073f62Sdrh      && (pNewExpr = pItem->pExpr)!=0
138347073f62Sdrh     ){
138447073f62Sdrh       assert( pNewExpr->iColumn==0 || i>0 );
138547073f62Sdrh       if( pNewExpr->iColumn==0 ){
138647073f62Sdrh         assert( pOldExpr->pLeft==pOldExpr->pRight );
1387b163748eSdrh         pPriorSelectCol = pNewExpr->pLeft = pNewExpr->pRight;
1388b163748eSdrh       }else{
1389b163748eSdrh         assert( i>0 );
1390b163748eSdrh         assert( pItem[-1].pExpr!=0 );
1391b163748eSdrh         assert( pNewExpr->iColumn==pItem[-1].pExpr->iColumn+1 );
1392b163748eSdrh         assert( pPriorSelectCol==pItem[-1].pExpr->pLeft );
1393b163748eSdrh         pNewExpr->pLeft = pPriorSelectCol;
139447073f62Sdrh       }
139547073f62Sdrh     }
139617435752Sdrh     pItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
1397b7916a78Sdrh     pItem->zSpan = sqlite3DbStrDup(db, pOldItem->zSpan);
1398145716b3Sdrh     pItem->sortOrder = pOldItem->sortOrder;
13993e7bc9caSdrh     pItem->done = 0;
14002c036cffSdrh     pItem->bSpanIsTab = pOldItem->bSpanIsTab;
140124e25d32Sdan     pItem->bSorterRef = pOldItem->bSorterRef;
1402c2acc4e4Sdrh     pItem->u = pOldItem->u;
1403ff78bd2fSdrh   }
1404ff78bd2fSdrh   return pNew;
1405ff78bd2fSdrh }
140693758c8dSdanielk1977 
140793758c8dSdanielk1977 /*
140893758c8dSdanielk1977 ** If cursors, triggers, views and subqueries are all omitted from
140993758c8dSdanielk1977 ** the build, then none of the following routines, except for
141093758c8dSdanielk1977 ** sqlite3SelectDup(), can be called. sqlite3SelectDup() is sometimes
141193758c8dSdanielk1977 ** called with a NULL argument.
141293758c8dSdanielk1977 */
14136a67fe8eSdanielk1977 #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_TRIGGER) \
14146a67fe8eSdanielk1977  || !defined(SQLITE_OMIT_SUBQUERY)
14156ab3a2ecSdanielk1977 SrcList *sqlite3SrcListDup(sqlite3 *db, SrcList *p, int flags){
1416ad3cab52Sdrh   SrcList *pNew;
1417ad3cab52Sdrh   int i;
1418113088ecSdrh   int nByte;
1419575fad65Sdrh   assert( db!=0 );
1420ad3cab52Sdrh   if( p==0 ) return 0;
1421113088ecSdrh   nByte = sizeof(*p) + (p->nSrc>0 ? sizeof(p->a[0]) * (p->nSrc-1) : 0);
1422575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, nByte );
1423ad3cab52Sdrh   if( pNew==0 ) return 0;
14244305d103Sdrh   pNew->nSrc = pNew->nAlloc = p->nSrc;
1425ad3cab52Sdrh   for(i=0; i<p->nSrc; i++){
14264efc4754Sdrh     struct SrcList_item *pNewItem = &pNew->a[i];
14274efc4754Sdrh     struct SrcList_item *pOldItem = &p->a[i];
1428ed8a3bb1Sdrh     Table *pTab;
142941fb5cd1Sdan     pNewItem->pSchema = pOldItem->pSchema;
143017435752Sdrh     pNewItem->zDatabase = sqlite3DbStrDup(db, pOldItem->zDatabase);
143117435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
143217435752Sdrh     pNewItem->zAlias = sqlite3DbStrDup(db, pOldItem->zAlias);
14338a48b9c0Sdrh     pNewItem->fg = pOldItem->fg;
14344efc4754Sdrh     pNewItem->iCursor = pOldItem->iCursor;
14355b6a9ed4Sdrh     pNewItem->addrFillSub = pOldItem->addrFillSub;
14365b6a9ed4Sdrh     pNewItem->regReturn = pOldItem->regReturn;
14378a48b9c0Sdrh     if( pNewItem->fg.isIndexedBy ){
14388a48b9c0Sdrh       pNewItem->u1.zIndexedBy = sqlite3DbStrDup(db, pOldItem->u1.zIndexedBy);
14398a48b9c0Sdrh     }
14408a48b9c0Sdrh     pNewItem->pIBIndex = pOldItem->pIBIndex;
14418a48b9c0Sdrh     if( pNewItem->fg.isTabFunc ){
14428a48b9c0Sdrh       pNewItem->u1.pFuncArg =
14438a48b9c0Sdrh           sqlite3ExprListDup(db, pOldItem->u1.pFuncArg, flags);
14448a48b9c0Sdrh     }
1445ed8a3bb1Sdrh     pTab = pNewItem->pTab = pOldItem->pTab;
1446ed8a3bb1Sdrh     if( pTab ){
144779df7782Sdrh       pTab->nTabRef++;
1448a1cb183dSdanielk1977     }
14496ab3a2ecSdanielk1977     pNewItem->pSelect = sqlite3SelectDup(db, pOldItem->pSelect, flags);
14506ab3a2ecSdanielk1977     pNewItem->pOn = sqlite3ExprDup(db, pOldItem->pOn, flags);
145117435752Sdrh     pNewItem->pUsing = sqlite3IdListDup(db, pOldItem->pUsing);
14526c18b6e0Sdanielk1977     pNewItem->colUsed = pOldItem->colUsed;
1453ad3cab52Sdrh   }
1454ad3cab52Sdrh   return pNew;
1455ad3cab52Sdrh }
145617435752Sdrh IdList *sqlite3IdListDup(sqlite3 *db, IdList *p){
1457ff78bd2fSdrh   IdList *pNew;
1458ff78bd2fSdrh   int i;
1459575fad65Sdrh   assert( db!=0 );
1460ff78bd2fSdrh   if( p==0 ) return 0;
1461575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, sizeof(*pNew) );
1462ff78bd2fSdrh   if( pNew==0 ) return 0;
14636c535158Sdrh   pNew->nId = p->nId;
1464575fad65Sdrh   pNew->a = sqlite3DbMallocRawNN(db, p->nId*sizeof(p->a[0]) );
1465d5d56523Sdanielk1977   if( pNew->a==0 ){
1466dbd6a7dcSdrh     sqlite3DbFreeNN(db, pNew);
1467d5d56523Sdanielk1977     return 0;
1468d5d56523Sdanielk1977   }
14696c535158Sdrh   /* Note that because the size of the allocation for p->a[] is not
14706c535158Sdrh   ** necessarily a power of two, sqlite3IdListAppend() may not be called
14716c535158Sdrh   ** on the duplicate created by this function. */
1472ff78bd2fSdrh   for(i=0; i<p->nId; i++){
14734efc4754Sdrh     struct IdList_item *pNewItem = &pNew->a[i];
14744efc4754Sdrh     struct IdList_item *pOldItem = &p->a[i];
147517435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
14764efc4754Sdrh     pNewItem->idx = pOldItem->idx;
1477ff78bd2fSdrh   }
1478ff78bd2fSdrh   return pNew;
1479ff78bd2fSdrh }
1480a7466205Sdan Select *sqlite3SelectDup(sqlite3 *db, Select *pDup, int flags){
1481a7466205Sdan   Select *pRet = 0;
1482a7466205Sdan   Select *pNext = 0;
1483a7466205Sdan   Select **pp = &pRet;
1484a7466205Sdan   Select *p;
1485a7466205Sdan 
1486575fad65Sdrh   assert( db!=0 );
1487a7466205Sdan   for(p=pDup; p; p=p->pPrior){
1488a7466205Sdan     Select *pNew = sqlite3DbMallocRawNN(db, sizeof(*p) );
1489a7466205Sdan     if( pNew==0 ) break;
1490b7916a78Sdrh     pNew->pEList = sqlite3ExprListDup(db, p->pEList, flags);
14916ab3a2ecSdanielk1977     pNew->pSrc = sqlite3SrcListDup(db, p->pSrc, flags);
14926ab3a2ecSdanielk1977     pNew->pWhere = sqlite3ExprDup(db, p->pWhere, flags);
14936ab3a2ecSdanielk1977     pNew->pGroupBy = sqlite3ExprListDup(db, p->pGroupBy, flags);
14946ab3a2ecSdanielk1977     pNew->pHaving = sqlite3ExprDup(db, p->pHaving, flags);
14956ab3a2ecSdanielk1977     pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, flags);
1496ff78bd2fSdrh     pNew->op = p->op;
1497a7466205Sdan     pNew->pNext = pNext;
1498a7466205Sdan     pNew->pPrior = 0;
14996ab3a2ecSdanielk1977     pNew->pLimit = sqlite3ExprDup(db, p->pLimit, flags);
150092b01d53Sdrh     pNew->iLimit = 0;
150192b01d53Sdrh     pNew->iOffset = 0;
15027d10d5a6Sdrh     pNew->selFlags = p->selFlags & ~SF_UsesEphemeral;
1503b9bb7c18Sdrh     pNew->addrOpenEphm[0] = -1;
1504b9bb7c18Sdrh     pNew->addrOpenEphm[1] = -1;
1505ec2da854Sdrh     pNew->nSelectRow = p->nSelectRow;
15064e9119d9Sdan     pNew->pWith = withDup(db, p->pWith);
150767a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
15082e362f97Sdan     pNew->pWin = 0;
1509c95f38d4Sdan     pNew->pWinDefn = sqlite3WindowListDup(db, p->pWinDefn);
1510a8389975Sdrh     if( p->pWin ) gatherSelectWindows(pNew);
151167a9b8edSdan #endif
1512fef37760Sdrh     pNew->selId = p->selId;
1513a7466205Sdan     *pp = pNew;
1514a7466205Sdan     pp = &pNew->pPrior;
1515a7466205Sdan     pNext = pNew;
1516a7466205Sdan   }
1517a7466205Sdan 
1518a7466205Sdan   return pRet;
1519ff78bd2fSdrh }
152093758c8dSdanielk1977 #else
15216ab3a2ecSdanielk1977 Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
152293758c8dSdanielk1977   assert( p==0 );
152393758c8dSdanielk1977   return 0;
152493758c8dSdanielk1977 }
152593758c8dSdanielk1977 #endif
1526ff78bd2fSdrh 
1527ff78bd2fSdrh 
1528ff78bd2fSdrh /*
1529a76b5dfcSdrh ** Add a new element to the end of an expression list.  If pList is
1530a76b5dfcSdrh ** initially NULL, then create a new expression list.
1531b7916a78Sdrh **
1532a19543feSdrh ** The pList argument must be either NULL or a pointer to an ExprList
1533a19543feSdrh ** obtained from a prior call to sqlite3ExprListAppend().  This routine
1534a19543feSdrh ** may not be used with an ExprList obtained from sqlite3ExprListDup().
1535a19543feSdrh ** Reason:  This routine assumes that the number of slots in pList->a[]
1536a19543feSdrh ** is a power of two.  That is true for sqlite3ExprListAppend() returns
1537a19543feSdrh ** but is not necessarily true from the return value of sqlite3ExprListDup().
1538a19543feSdrh **
1539b7916a78Sdrh ** If a memory allocation error occurs, the entire list is freed and
1540b7916a78Sdrh ** NULL is returned.  If non-NULL is returned, then it is guaranteed
1541b7916a78Sdrh ** that the new entry was successfully appended.
1542a76b5dfcSdrh */
154317435752Sdrh ExprList *sqlite3ExprListAppend(
154417435752Sdrh   Parse *pParse,          /* Parsing context */
154517435752Sdrh   ExprList *pList,        /* List to which to append. Might be NULL */
1546b7916a78Sdrh   Expr *pExpr             /* Expression to be appended. Might be NULL */
154717435752Sdrh ){
154843606175Sdrh   struct ExprList_item *pItem;
154917435752Sdrh   sqlite3 *db = pParse->db;
1550575fad65Sdrh   assert( db!=0 );
1551a76b5dfcSdrh   if( pList==0 ){
1552575fad65Sdrh     pList = sqlite3DbMallocRawNN(db, sizeof(ExprList) );
1553a76b5dfcSdrh     if( pList==0 ){
1554d5d56523Sdanielk1977       goto no_mem;
1555a76b5dfcSdrh     }
1556c263f7c4Sdrh     pList->nExpr = 0;
1557a19543feSdrh   }else if( (pList->nExpr & (pList->nExpr-1))==0 ){
155843606175Sdrh     ExprList *pNew;
155943606175Sdrh     pNew = sqlite3DbRealloc(db, pList,
15600aa3231fSdrh          sizeof(*pList)+(2*(sqlite3_int64)pList->nExpr-1)*sizeof(pList->a[0]));
156143606175Sdrh     if( pNew==0 ){
1562d5d56523Sdanielk1977       goto no_mem;
1563a76b5dfcSdrh     }
156443606175Sdrh     pList = pNew;
1565a76b5dfcSdrh   }
156643606175Sdrh   pItem = &pList->a[pList->nExpr++];
1567a8b9793cSdrh   assert( offsetof(struct ExprList_item,zName)==sizeof(pItem->pExpr) );
1568a8b9793cSdrh   assert( offsetof(struct ExprList_item,pExpr)==0 );
1569a8b9793cSdrh   memset(&pItem->zName,0,sizeof(*pItem)-offsetof(struct ExprList_item,zName));
1570e94ddc9eSdanielk1977   pItem->pExpr = pExpr;
1571a76b5dfcSdrh   return pList;
1572d5d56523Sdanielk1977 
1573d5d56523Sdanielk1977 no_mem:
1574d5d56523Sdanielk1977   /* Avoid leaking memory if malloc has failed. */
1575633e6d57Sdrh   sqlite3ExprDelete(db, pExpr);
1576633e6d57Sdrh   sqlite3ExprListDelete(db, pList);
1577d5d56523Sdanielk1977   return 0;
1578a76b5dfcSdrh }
1579a76b5dfcSdrh 
1580a76b5dfcSdrh /*
15818762ec19Sdrh ** pColumns and pExpr form a vector assignment which is part of the SET
15828762ec19Sdrh ** clause of an UPDATE statement.  Like this:
1583a1251bc4Sdrh **
1584a1251bc4Sdrh **        (a,b,c) = (expr1,expr2,expr3)
1585a1251bc4Sdrh ** Or:    (a,b,c) = (SELECT x,y,z FROM ....)
1586a1251bc4Sdrh **
1587a1251bc4Sdrh ** For each term of the vector assignment, append new entries to the
1588b67343d0Sdrh ** expression list pList.  In the case of a subquery on the RHS, append
1589a1251bc4Sdrh ** TK_SELECT_COLUMN expressions.
1590a1251bc4Sdrh */
1591a1251bc4Sdrh ExprList *sqlite3ExprListAppendVector(
1592a1251bc4Sdrh   Parse *pParse,         /* Parsing context */
1593a1251bc4Sdrh   ExprList *pList,       /* List to which to append. Might be NULL */
1594a1251bc4Sdrh   IdList *pColumns,      /* List of names of LHS of the assignment */
1595a1251bc4Sdrh   Expr *pExpr            /* Vector expression to be appended. Might be NULL */
1596a1251bc4Sdrh ){
1597a1251bc4Sdrh   sqlite3 *db = pParse->db;
1598a1251bc4Sdrh   int n;
1599a1251bc4Sdrh   int i;
160066860af3Sdrh   int iFirst = pList ? pList->nExpr : 0;
1601321e828dSdrh   /* pColumns can only be NULL due to an OOM but an OOM will cause an
1602321e828dSdrh   ** exit prior to this routine being invoked */
1603321e828dSdrh   if( NEVER(pColumns==0) ) goto vector_append_error;
1604a1251bc4Sdrh   if( pExpr==0 ) goto vector_append_error;
1605966e2911Sdrh 
1606966e2911Sdrh   /* If the RHS is a vector, then we can immediately check to see that
1607966e2911Sdrh   ** the size of the RHS and LHS match.  But if the RHS is a SELECT,
1608966e2911Sdrh   ** wildcards ("*") in the result set of the SELECT must be expanded before
1609966e2911Sdrh   ** we can do the size check, so defer the size check until code generation.
1610966e2911Sdrh   */
1611966e2911Sdrh   if( pExpr->op!=TK_SELECT && pColumns->nId!=(n=sqlite3ExprVectorSize(pExpr)) ){
1612a1251bc4Sdrh     sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
1613a1251bc4Sdrh                     pColumns->nId, n);
1614a1251bc4Sdrh     goto vector_append_error;
1615a1251bc4Sdrh   }
1616966e2911Sdrh 
1617966e2911Sdrh   for(i=0; i<pColumns->nId; i++){
1618a1251bc4Sdrh     Expr *pSubExpr = sqlite3ExprForVectorField(pParse, pExpr, i);
1619a1251bc4Sdrh     pList = sqlite3ExprListAppend(pParse, pList, pSubExpr);
1620a1251bc4Sdrh     if( pList ){
162166860af3Sdrh       assert( pList->nExpr==iFirst+i+1 );
1622a1251bc4Sdrh       pList->a[pList->nExpr-1].zName = pColumns->a[i].zName;
1623a1251bc4Sdrh       pColumns->a[i].zName = 0;
1624a1251bc4Sdrh     }
1625a1251bc4Sdrh   }
1626966e2911Sdrh 
1627ffe28059Sdrh   if( !db->mallocFailed && pExpr->op==TK_SELECT && ALWAYS(pList!=0) ){
1628966e2911Sdrh     Expr *pFirst = pList->a[iFirst].pExpr;
1629f4dd26c5Sdrh     assert( pFirst!=0 );
1630966e2911Sdrh     assert( pFirst->op==TK_SELECT_COLUMN );
1631966e2911Sdrh 
1632966e2911Sdrh     /* Store the SELECT statement in pRight so it will be deleted when
1633966e2911Sdrh     ** sqlite3ExprListDelete() is called */
1634966e2911Sdrh     pFirst->pRight = pExpr;
1635a1251bc4Sdrh     pExpr = 0;
1636966e2911Sdrh 
1637966e2911Sdrh     /* Remember the size of the LHS in iTable so that we can check that
1638966e2911Sdrh     ** the RHS and LHS sizes match during code generation. */
1639966e2911Sdrh     pFirst->iTable = pColumns->nId;
1640a1251bc4Sdrh   }
1641a1251bc4Sdrh 
1642a1251bc4Sdrh vector_append_error:
1643dfb5c963Sdan   if( IN_RENAME_OBJECT ){
1644dfb5c963Sdan     sqlite3RenameExprUnmap(pParse, pExpr);
1645dfb5c963Sdan   }
1646a1251bc4Sdrh   sqlite3ExprDelete(db, pExpr);
1647a1251bc4Sdrh   sqlite3IdListDelete(db, pColumns);
1648a1251bc4Sdrh   return pList;
1649a1251bc4Sdrh }
1650a1251bc4Sdrh 
1651a1251bc4Sdrh /*
1652bc622bc0Sdrh ** Set the sort order for the last element on the given ExprList.
1653bc622bc0Sdrh */
1654bc622bc0Sdrh void sqlite3ExprListSetSortOrder(ExprList *p, int iSortOrder){
1655bc622bc0Sdrh   if( p==0 ) return;
1656bc622bc0Sdrh   assert( SQLITE_SO_UNDEFINED<0 && SQLITE_SO_ASC>=0 && SQLITE_SO_DESC>0 );
1657bc622bc0Sdrh   assert( p->nExpr>0 );
1658bc622bc0Sdrh   if( iSortOrder<0 ){
1659bc622bc0Sdrh     assert( p->a[p->nExpr-1].sortOrder==SQLITE_SO_ASC );
1660bc622bc0Sdrh     return;
1661bc622bc0Sdrh   }
1662bc622bc0Sdrh   p->a[p->nExpr-1].sortOrder = (u8)iSortOrder;
1663bc622bc0Sdrh }
1664bc622bc0Sdrh 
1665bc622bc0Sdrh /*
1666b7916a78Sdrh ** Set the ExprList.a[].zName element of the most recently added item
1667b7916a78Sdrh ** on the expression list.
1668b7916a78Sdrh **
1669b7916a78Sdrh ** pList might be NULL following an OOM error.  But pName should never be
1670b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1671b7916a78Sdrh ** is set.
1672b7916a78Sdrh */
1673b7916a78Sdrh void sqlite3ExprListSetName(
1674b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1675b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
1676b7916a78Sdrh   Token *pName,           /* Name to be added */
1677b7916a78Sdrh   int dequote             /* True to cause the name to be dequoted */
1678b7916a78Sdrh ){
1679b7916a78Sdrh   assert( pList!=0 || pParse->db->mallocFailed!=0 );
1680b7916a78Sdrh   if( pList ){
1681b7916a78Sdrh     struct ExprList_item *pItem;
1682b7916a78Sdrh     assert( pList->nExpr>0 );
1683b7916a78Sdrh     pItem = &pList->a[pList->nExpr-1];
1684b7916a78Sdrh     assert( pItem->zName==0 );
1685b7916a78Sdrh     pItem->zName = sqlite3DbStrNDup(pParse->db, pName->z, pName->n);
1686244b9d6eSdrh     if( dequote ) sqlite3Dequote(pItem->zName);
1687c9461eccSdan     if( IN_RENAME_OBJECT ){
168807e95233Sdan       sqlite3RenameTokenMap(pParse, (void*)pItem->zName, pName);
16895be60c55Sdan     }
1690b7916a78Sdrh   }
1691b7916a78Sdrh }
1692b7916a78Sdrh 
1693b7916a78Sdrh /*
1694b7916a78Sdrh ** Set the ExprList.a[].zSpan element of the most recently added item
1695b7916a78Sdrh ** on the expression list.
1696b7916a78Sdrh **
1697b7916a78Sdrh ** pList might be NULL following an OOM error.  But pSpan should never be
1698b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1699b7916a78Sdrh ** is set.
1700b7916a78Sdrh */
1701b7916a78Sdrh void sqlite3ExprListSetSpan(
1702b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1703b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
17041be266baSdrh   const char *zStart,     /* Start of the span */
17051be266baSdrh   const char *zEnd        /* End of the span */
1706b7916a78Sdrh ){
1707b7916a78Sdrh   sqlite3 *db = pParse->db;
1708b7916a78Sdrh   assert( pList!=0 || db->mallocFailed!=0 );
1709b7916a78Sdrh   if( pList ){
1710b7916a78Sdrh     struct ExprList_item *pItem = &pList->a[pList->nExpr-1];
1711b7916a78Sdrh     assert( pList->nExpr>0 );
1712b7916a78Sdrh     sqlite3DbFree(db, pItem->zSpan);
17139b2e0435Sdrh     pItem->zSpan = sqlite3DbSpanDup(db, zStart, zEnd);
1714b7916a78Sdrh   }
1715b7916a78Sdrh }
1716b7916a78Sdrh 
1717b7916a78Sdrh /*
17187a15a4beSdanielk1977 ** If the expression list pEList contains more than iLimit elements,
17197a15a4beSdanielk1977 ** leave an error message in pParse.
17207a15a4beSdanielk1977 */
17217a15a4beSdanielk1977 void sqlite3ExprListCheckLength(
17227a15a4beSdanielk1977   Parse *pParse,
17237a15a4beSdanielk1977   ExprList *pEList,
17247a15a4beSdanielk1977   const char *zObject
17257a15a4beSdanielk1977 ){
1726b1a6c3c1Sdrh   int mx = pParse->db->aLimit[SQLITE_LIMIT_COLUMN];
1727c5499befSdrh   testcase( pEList && pEList->nExpr==mx );
1728c5499befSdrh   testcase( pEList && pEList->nExpr==mx+1 );
1729b1a6c3c1Sdrh   if( pEList && pEList->nExpr>mx ){
17307a15a4beSdanielk1977     sqlite3ErrorMsg(pParse, "too many columns in %s", zObject);
17317a15a4beSdanielk1977   }
17327a15a4beSdanielk1977 }
17337a15a4beSdanielk1977 
17347a15a4beSdanielk1977 /*
1735a76b5dfcSdrh ** Delete an entire expression list.
1736a76b5dfcSdrh */
1737affa855cSdrh static SQLITE_NOINLINE void exprListDeleteNN(sqlite3 *db, ExprList *pList){
1738ac48b751Sdrh   int i = pList->nExpr;
1739ac48b751Sdrh   struct ExprList_item *pItem =  pList->a;
1740ac48b751Sdrh   assert( pList->nExpr>0 );
1741ac48b751Sdrh   do{
1742633e6d57Sdrh     sqlite3ExprDelete(db, pItem->pExpr);
1743633e6d57Sdrh     sqlite3DbFree(db, pItem->zName);
1744b7916a78Sdrh     sqlite3DbFree(db, pItem->zSpan);
1745ac48b751Sdrh     pItem++;
1746ac48b751Sdrh   }while( --i>0 );
1747dbd6a7dcSdrh   sqlite3DbFreeNN(db, pList);
1748a76b5dfcSdrh }
1749affa855cSdrh void sqlite3ExprListDelete(sqlite3 *db, ExprList *pList){
1750affa855cSdrh   if( pList ) exprListDeleteNN(db, pList);
1751affa855cSdrh }
1752a76b5dfcSdrh 
1753a76b5dfcSdrh /*
17542308ed38Sdrh ** Return the bitwise-OR of all Expr.flags fields in the given
17552308ed38Sdrh ** ExprList.
1756885a5b03Sdrh */
17572308ed38Sdrh u32 sqlite3ExprListFlags(const ExprList *pList){
1758885a5b03Sdrh   int i;
17592308ed38Sdrh   u32 m = 0;
1760508e2d00Sdrh   assert( pList!=0 );
1761885a5b03Sdrh   for(i=0; i<pList->nExpr; i++){
1762d0c73053Sdrh      Expr *pExpr = pList->a[i].pExpr;
1763de845c2fSdrh      assert( pExpr!=0 );
1764de845c2fSdrh      m |= pExpr->flags;
1765885a5b03Sdrh   }
17662308ed38Sdrh   return m;
1767885a5b03Sdrh }
1768885a5b03Sdrh 
1769885a5b03Sdrh /*
17707e6f980bSdrh ** This is a SELECT-node callback for the expression walker that
17717e6f980bSdrh ** always "fails".  By "fail" in this case, we mean set
17727e6f980bSdrh ** pWalker->eCode to zero and abort.
17737e6f980bSdrh **
17747e6f980bSdrh ** This callback is used by multiple expression walkers.
17757e6f980bSdrh */
17767e6f980bSdrh int sqlite3SelectWalkFail(Walker *pWalker, Select *NotUsed){
17777e6f980bSdrh   UNUSED_PARAMETER(NotUsed);
17787e6f980bSdrh   pWalker->eCode = 0;
17797e6f980bSdrh   return WRC_Abort;
17807e6f980bSdrh }
17817e6f980bSdrh 
17827e6f980bSdrh /*
1783171d16bbSdrh ** If the input expression is an ID with the name "true" or "false"
178496acafbeSdrh ** then convert it into an TK_TRUEFALSE term.  Return non-zero if
178596acafbeSdrh ** the conversion happened, and zero if the expression is unaltered.
1786171d16bbSdrh */
1787171d16bbSdrh int sqlite3ExprIdToTrueFalse(Expr *pExpr){
1788171d16bbSdrh   assert( pExpr->op==TK_ID || pExpr->op==TK_STRING );
178951d35b0fSdrh   if( !ExprHasProperty(pExpr, EP_Quoted)
179051d35b0fSdrh    && (sqlite3StrICmp(pExpr->u.zToken, "true")==0
179151d35b0fSdrh        || sqlite3StrICmp(pExpr->u.zToken, "false")==0)
1792171d16bbSdrh   ){
1793171d16bbSdrh     pExpr->op = TK_TRUEFALSE;
1794ad31727fSdrh     ExprSetProperty(pExpr, pExpr->u.zToken[4]==0 ? EP_IsTrue : EP_IsFalse);
1795171d16bbSdrh     return 1;
1796171d16bbSdrh   }
1797171d16bbSdrh   return 0;
1798171d16bbSdrh }
1799171d16bbSdrh 
180043c4ac8bSdrh /*
180196acafbeSdrh ** The argument must be a TK_TRUEFALSE Expr node.  Return 1 if it is TRUE
180243c4ac8bSdrh ** and 0 if it is FALSE.
180343c4ac8bSdrh */
180496acafbeSdrh int sqlite3ExprTruthValue(const Expr *pExpr){
180543c4ac8bSdrh   assert( pExpr->op==TK_TRUEFALSE );
180643c4ac8bSdrh   assert( sqlite3StrICmp(pExpr->u.zToken,"true")==0
180743c4ac8bSdrh        || sqlite3StrICmp(pExpr->u.zToken,"false")==0 );
180843c4ac8bSdrh   return pExpr->u.zToken[4]==0;
180943c4ac8bSdrh }
181043c4ac8bSdrh 
181117180fcaSdrh /*
181217180fcaSdrh ** If pExpr is an AND or OR expression, try to simplify it by eliminating
181317180fcaSdrh ** terms that are always true or false.  Return the simplified expression.
181417180fcaSdrh ** Or return the original expression if no simplification is possible.
181517180fcaSdrh **
181617180fcaSdrh ** Examples:
181717180fcaSdrh **
181817180fcaSdrh **     (x<10) AND true                =>   (x<10)
181917180fcaSdrh **     (x<10) AND false               =>   false
182017180fcaSdrh **     (x<10) AND (y=22 OR false)     =>   (x<10) AND (y=22)
182117180fcaSdrh **     (x<10) AND (y=22 OR true)      =>   (x<10)
182217180fcaSdrh **     (y=22) OR true                 =>   true
182317180fcaSdrh */
182417180fcaSdrh Expr *sqlite3ExprSimplifiedAndOr(Expr *pExpr){
182517180fcaSdrh   assert( pExpr!=0 );
182617180fcaSdrh   if( pExpr->op==TK_AND || pExpr->op==TK_OR ){
182717180fcaSdrh     Expr *pRight = sqlite3ExprSimplifiedAndOr(pExpr->pRight);
182817180fcaSdrh     Expr *pLeft = sqlite3ExprSimplifiedAndOr(pExpr->pLeft);
182917180fcaSdrh     if( ExprAlwaysTrue(pLeft) || ExprAlwaysFalse(pRight) ){
183017180fcaSdrh       pExpr = pExpr->op==TK_AND ? pRight : pLeft;
183117180fcaSdrh     }else if( ExprAlwaysTrue(pRight) || ExprAlwaysFalse(pLeft) ){
183217180fcaSdrh       pExpr = pExpr->op==TK_AND ? pLeft : pRight;
183317180fcaSdrh     }
183417180fcaSdrh   }
183517180fcaSdrh   return pExpr;
183617180fcaSdrh }
183717180fcaSdrh 
1838171d16bbSdrh 
1839171d16bbSdrh /*
1840059b2d50Sdrh ** These routines are Walker callbacks used to check expressions to
1841059b2d50Sdrh ** see if they are "constant" for some definition of constant.  The
1842059b2d50Sdrh ** Walker.eCode value determines the type of "constant" we are looking
1843059b2d50Sdrh ** for.
184473b211abSdrh **
18457d10d5a6Sdrh ** These callback routines are used to implement the following:
1846626a879aSdrh **
1847059b2d50Sdrh **     sqlite3ExprIsConstant()                  pWalker->eCode==1
1848059b2d50Sdrh **     sqlite3ExprIsConstantNotJoin()           pWalker->eCode==2
1849fcb9f4f3Sdrh **     sqlite3ExprIsTableConstant()             pWalker->eCode==3
1850059b2d50Sdrh **     sqlite3ExprIsConstantOrFunction()        pWalker->eCode==4 or 5
185187abf5c0Sdrh **
1852059b2d50Sdrh ** In all cases, the callbacks set Walker.eCode=0 and abort if the expression
1853059b2d50Sdrh ** is found to not be a constant.
185487abf5c0Sdrh **
1855feada2dfSdrh ** The sqlite3ExprIsConstantOrFunction() is used for evaluating expressions
1856059b2d50Sdrh ** in a CREATE TABLE statement.  The Walker.eCode value is 5 when parsing
1857059b2d50Sdrh ** an existing schema and 4 when processing a new statement.  A bound
1858feada2dfSdrh ** parameter raises an error for new statements, but is silently converted
1859feada2dfSdrh ** to NULL for existing schemas.  This allows sqlite_master tables that
1860feada2dfSdrh ** contain a bound parameter because they were generated by older versions
1861feada2dfSdrh ** of SQLite to be parsed by newer versions of SQLite without raising a
1862feada2dfSdrh ** malformed schema error.
1863626a879aSdrh */
18647d10d5a6Sdrh static int exprNodeIsConstant(Walker *pWalker, Expr *pExpr){
1865626a879aSdrh 
1866059b2d50Sdrh   /* If pWalker->eCode is 2 then any term of the expression that comes from
1867059b2d50Sdrh   ** the ON or USING clauses of a left join disqualifies the expression
18680a168377Sdrh   ** from being considered constant. */
1869059b2d50Sdrh   if( pWalker->eCode==2 && ExprHasProperty(pExpr, EP_FromJoin) ){
1870059b2d50Sdrh     pWalker->eCode = 0;
18717d10d5a6Sdrh     return WRC_Abort;
18720a168377Sdrh   }
18730a168377Sdrh 
1874626a879aSdrh   switch( pExpr->op ){
1875eb55bd2fSdrh     /* Consider functions to be constant if all their arguments are constant
1876059b2d50Sdrh     ** and either pWalker->eCode==4 or 5 or the function has the
1877059b2d50Sdrh     ** SQLITE_FUNC_CONST flag. */
1878eb55bd2fSdrh     case TK_FUNCTION:
187963f84573Sdrh       if( pWalker->eCode>=4 || ExprHasProperty(pExpr,EP_ConstFunc) ){
1880b1fba286Sdrh         return WRC_Continue;
1881059b2d50Sdrh       }else{
1882059b2d50Sdrh         pWalker->eCode = 0;
1883059b2d50Sdrh         return WRC_Abort;
1884b1fba286Sdrh       }
1885626a879aSdrh     case TK_ID:
1886171d16bbSdrh       /* Convert "true" or "false" in a DEFAULT clause into the
1887171d16bbSdrh       ** appropriate TK_TRUEFALSE operator */
1888e39ef31cSdrh       if( sqlite3ExprIdToTrueFalse(pExpr) ){
1889171d16bbSdrh         return WRC_Prune;
1890171d16bbSdrh       }
1891171d16bbSdrh       /* Fall thru */
1892626a879aSdrh     case TK_COLUMN:
1893626a879aSdrh     case TK_AGG_FUNCTION:
189413449892Sdrh     case TK_AGG_COLUMN:
1895c5499befSdrh       testcase( pExpr->op==TK_ID );
1896c5499befSdrh       testcase( pExpr->op==TK_COLUMN );
1897c5499befSdrh       testcase( pExpr->op==TK_AGG_FUNCTION );
1898c5499befSdrh       testcase( pExpr->op==TK_AGG_COLUMN );
189907aded63Sdrh       if( ExprHasProperty(pExpr, EP_FixedCol) && pWalker->eCode!=2 ){
1900efad2e23Sdrh         return WRC_Continue;
1901efad2e23Sdrh       }
1902059b2d50Sdrh       if( pWalker->eCode==3 && pExpr->iTable==pWalker->u.iCur ){
1903059b2d50Sdrh         return WRC_Continue;
1904f43ce0b4Sdrh       }
1905f43ce0b4Sdrh       /* Fall through */
1906f43ce0b4Sdrh     case TK_IF_NULL_ROW:
19076e341b93Sdrh     case TK_REGISTER:
19089916048bSdrh       testcase( pExpr->op==TK_REGISTER );
1909f43ce0b4Sdrh       testcase( pExpr->op==TK_IF_NULL_ROW );
1910059b2d50Sdrh       pWalker->eCode = 0;
19117d10d5a6Sdrh       return WRC_Abort;
1912feada2dfSdrh     case TK_VARIABLE:
1913059b2d50Sdrh       if( pWalker->eCode==5 ){
1914feada2dfSdrh         /* Silently convert bound parameters that appear inside of CREATE
1915feada2dfSdrh         ** statements into a NULL when parsing the CREATE statement text out
1916feada2dfSdrh         ** of the sqlite_master table */
1917feada2dfSdrh         pExpr->op = TK_NULL;
1918059b2d50Sdrh       }else if( pWalker->eCode==4 ){
1919feada2dfSdrh         /* A bound parameter in a CREATE statement that originates from
1920feada2dfSdrh         ** sqlite3_prepare() causes an error */
1921059b2d50Sdrh         pWalker->eCode = 0;
1922feada2dfSdrh         return WRC_Abort;
1923feada2dfSdrh       }
1924feada2dfSdrh       /* Fall through */
1925626a879aSdrh     default:
19266e341b93Sdrh       testcase( pExpr->op==TK_SELECT ); /* sqlite3SelectWalkFail() disallows */
19276e341b93Sdrh       testcase( pExpr->op==TK_EXISTS ); /* sqlite3SelectWalkFail() disallows */
19287d10d5a6Sdrh       return WRC_Continue;
1929626a879aSdrh   }
1930626a879aSdrh }
1931059b2d50Sdrh static int exprIsConst(Expr *p, int initFlag, int iCur){
19327d10d5a6Sdrh   Walker w;
1933059b2d50Sdrh   w.eCode = initFlag;
19347d10d5a6Sdrh   w.xExprCallback = exprNodeIsConstant;
19357e6f980bSdrh   w.xSelectCallback = sqlite3SelectWalkFail;
1936979dd1beSdrh #ifdef SQLITE_DEBUG
1937979dd1beSdrh   w.xSelectCallback2 = sqlite3SelectWalkAssert2;
1938979dd1beSdrh #endif
1939059b2d50Sdrh   w.u.iCur = iCur;
19407d10d5a6Sdrh   sqlite3WalkExpr(&w, p);
1941059b2d50Sdrh   return w.eCode;
19427d10d5a6Sdrh }
1943626a879aSdrh 
1944626a879aSdrh /*
1945059b2d50Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
1946eb55bd2fSdrh ** and 0 if it involves variables or function calls.
19472398937bSdrh **
19482398937bSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
19492398937bSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
19502398937bSdrh ** a constant.
1951fef5208cSdrh */
19524adee20fSdanielk1977 int sqlite3ExprIsConstant(Expr *p){
1953059b2d50Sdrh   return exprIsConst(p, 1, 0);
1954fef5208cSdrh }
1955fef5208cSdrh 
1956fef5208cSdrh /*
195707aded63Sdrh ** Walk an expression tree.  Return non-zero if
195807aded63Sdrh **
195907aded63Sdrh **   (1) the expression is constant, and
196007aded63Sdrh **   (2) the expression does originate in the ON or USING clause
196107aded63Sdrh **       of a LEFT JOIN, and
196207aded63Sdrh **   (3) the expression does not contain any EP_FixedCol TK_COLUMN
196307aded63Sdrh **       operands created by the constant propagation optimization.
196407aded63Sdrh **
196507aded63Sdrh ** When this routine returns true, it indicates that the expression
196607aded63Sdrh ** can be added to the pParse->pConstExpr list and evaluated once when
196707aded63Sdrh ** the prepared statement starts up.  See sqlite3ExprCodeAtInit().
19680a168377Sdrh */
19690a168377Sdrh int sqlite3ExprIsConstantNotJoin(Expr *p){
1970059b2d50Sdrh   return exprIsConst(p, 2, 0);
19710a168377Sdrh }
19720a168377Sdrh 
19730a168377Sdrh /*
1974fcb9f4f3Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
1975059b2d50Sdrh ** for any single row of the table with cursor iCur.  In other words, the
1976059b2d50Sdrh ** expression must not refer to any non-deterministic function nor any
1977059b2d50Sdrh ** table other than iCur.
1978059b2d50Sdrh */
1979059b2d50Sdrh int sqlite3ExprIsTableConstant(Expr *p, int iCur){
1980059b2d50Sdrh   return exprIsConst(p, 3, iCur);
1981059b2d50Sdrh }
1982059b2d50Sdrh 
1983ab31a845Sdan 
1984ab31a845Sdan /*
1985ab31a845Sdan ** sqlite3WalkExpr() callback used by sqlite3ExprIsConstantOrGroupBy().
1986ab31a845Sdan */
1987ab31a845Sdan static int exprNodeIsConstantOrGroupBy(Walker *pWalker, Expr *pExpr){
1988ab31a845Sdan   ExprList *pGroupBy = pWalker->u.pGroupBy;
1989ab31a845Sdan   int i;
1990ab31a845Sdan 
1991ab31a845Sdan   /* Check if pExpr is identical to any GROUP BY term. If so, consider
1992ab31a845Sdan   ** it constant.  */
1993ab31a845Sdan   for(i=0; i<pGroupBy->nExpr; i++){
1994ab31a845Sdan     Expr *p = pGroupBy->a[i].pExpr;
19955aa550cfSdan     if( sqlite3ExprCompare(0, pExpr, p, -1)<2 ){
199670efa84dSdrh       CollSeq *pColl = sqlite3ExprNNCollSeq(pWalker->pParse, p);
1997efad2e23Sdrh       if( sqlite3IsBinary(pColl) ){
1998ab31a845Sdan         return WRC_Prune;
1999ab31a845Sdan       }
2000ab31a845Sdan     }
2001ab31a845Sdan   }
2002ab31a845Sdan 
2003ab31a845Sdan   /* Check if pExpr is a sub-select. If so, consider it variable. */
2004ab31a845Sdan   if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2005ab31a845Sdan     pWalker->eCode = 0;
2006ab31a845Sdan     return WRC_Abort;
2007ab31a845Sdan   }
2008ab31a845Sdan 
2009ab31a845Sdan   return exprNodeIsConstant(pWalker, pExpr);
2010ab31a845Sdan }
2011ab31a845Sdan 
2012ab31a845Sdan /*
2013ab31a845Sdan ** Walk the expression tree passed as the first argument. Return non-zero
2014ab31a845Sdan ** if the expression consists entirely of constants or copies of terms
2015ab31a845Sdan ** in pGroupBy that sort with the BINARY collation sequence.
2016ab314001Sdrh **
2017ab314001Sdrh ** This routine is used to determine if a term of the HAVING clause can
2018ab314001Sdrh ** be promoted into the WHERE clause.  In order for such a promotion to work,
2019ab314001Sdrh ** the value of the HAVING clause term must be the same for all members of
2020ab314001Sdrh ** a "group".  The requirement that the GROUP BY term must be BINARY
2021ab314001Sdrh ** assumes that no other collating sequence will have a finer-grained
2022ab314001Sdrh ** grouping than binary.  In other words (A=B COLLATE binary) implies
2023ab314001Sdrh ** A=B in every other collating sequence.  The requirement that the
2024ab314001Sdrh ** GROUP BY be BINARY is stricter than necessary.  It would also work
2025ab314001Sdrh ** to promote HAVING clauses that use the same alternative collating
2026ab314001Sdrh ** sequence as the GROUP BY term, but that is much harder to check,
2027ab314001Sdrh ** alternative collating sequences are uncommon, and this is only an
2028ab314001Sdrh ** optimization, so we take the easy way out and simply require the
2029ab314001Sdrh ** GROUP BY to use the BINARY collating sequence.
2030ab31a845Sdan */
2031ab31a845Sdan int sqlite3ExprIsConstantOrGroupBy(Parse *pParse, Expr *p, ExprList *pGroupBy){
2032ab31a845Sdan   Walker w;
2033ab31a845Sdan   w.eCode = 1;
2034ab31a845Sdan   w.xExprCallback = exprNodeIsConstantOrGroupBy;
2035979dd1beSdrh   w.xSelectCallback = 0;
2036ab31a845Sdan   w.u.pGroupBy = pGroupBy;
2037ab31a845Sdan   w.pParse = pParse;
2038ab31a845Sdan   sqlite3WalkExpr(&w, p);
2039ab31a845Sdan   return w.eCode;
2040ab31a845Sdan }
2041ab31a845Sdan 
2042059b2d50Sdrh /*
2043059b2d50Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
2044eb55bd2fSdrh ** or a function call with constant arguments.  Return and 0 if there
2045eb55bd2fSdrh ** are any variables.
2046eb55bd2fSdrh **
2047eb55bd2fSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
2048eb55bd2fSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
2049eb55bd2fSdrh ** a constant.
2050eb55bd2fSdrh */
2051feada2dfSdrh int sqlite3ExprIsConstantOrFunction(Expr *p, u8 isInit){
2052feada2dfSdrh   assert( isInit==0 || isInit==1 );
2053059b2d50Sdrh   return exprIsConst(p, 4+isInit, 0);
2054eb55bd2fSdrh }
2055eb55bd2fSdrh 
20565b88bc4bSdrh #ifdef SQLITE_ENABLE_CURSOR_HINTS
20575b88bc4bSdrh /*
20585b88bc4bSdrh ** Walk an expression tree.  Return 1 if the expression contains a
20595b88bc4bSdrh ** subquery of some kind.  Return 0 if there are no subqueries.
20605b88bc4bSdrh */
20615b88bc4bSdrh int sqlite3ExprContainsSubquery(Expr *p){
20625b88bc4bSdrh   Walker w;
2063bec2476aSdrh   w.eCode = 1;
20645b88bc4bSdrh   w.xExprCallback = sqlite3ExprWalkNoop;
20657e6f980bSdrh   w.xSelectCallback = sqlite3SelectWalkFail;
2066979dd1beSdrh #ifdef SQLITE_DEBUG
2067979dd1beSdrh   w.xSelectCallback2 = sqlite3SelectWalkAssert2;
2068979dd1beSdrh #endif
20695b88bc4bSdrh   sqlite3WalkExpr(&w, p);
207007194bffSdrh   return w.eCode==0;
20715b88bc4bSdrh }
20725b88bc4bSdrh #endif
20735b88bc4bSdrh 
2074eb55bd2fSdrh /*
207573b211abSdrh ** If the expression p codes a constant integer that is small enough
2076202b2df7Sdrh ** to fit in a 32-bit integer, return 1 and put the value of the integer
2077202b2df7Sdrh ** in *pValue.  If the expression is not an integer or if it is too big
2078202b2df7Sdrh ** to fit in a signed 32-bit integer, return 0 and leave *pValue unchanged.
2079e4de1febSdrh */
20804adee20fSdanielk1977 int sqlite3ExprIsInteger(Expr *p, int *pValue){
208192b01d53Sdrh   int rc = 0;
20821d2d71a0Sdrh   if( NEVER(p==0) ) return 0;  /* Used to only happen following on OOM */
2083cd92e84dSdrh 
2084cd92e84dSdrh   /* If an expression is an integer literal that fits in a signed 32-bit
2085cd92e84dSdrh   ** integer, then the EP_IntValue flag will have already been set */
2086cd92e84dSdrh   assert( p->op!=TK_INTEGER || (p->flags & EP_IntValue)!=0
2087cd92e84dSdrh            || sqlite3GetInt32(p->u.zToken, &rc)==0 );
2088cd92e84dSdrh 
208992b01d53Sdrh   if( p->flags & EP_IntValue ){
209033e619fcSdrh     *pValue = p->u.iValue;
2091e4de1febSdrh     return 1;
2092e4de1febSdrh   }
209392b01d53Sdrh   switch( p->op ){
20944b59ab5eSdrh     case TK_UPLUS: {
209592b01d53Sdrh       rc = sqlite3ExprIsInteger(p->pLeft, pValue);
2096f6e369a1Sdrh       break;
20974b59ab5eSdrh     }
2098e4de1febSdrh     case TK_UMINUS: {
2099e4de1febSdrh       int v;
21004adee20fSdanielk1977       if( sqlite3ExprIsInteger(p->pLeft, &v) ){
2101f6418891Smistachkin         assert( v!=(-2147483647-1) );
2102e4de1febSdrh         *pValue = -v;
210392b01d53Sdrh         rc = 1;
2104e4de1febSdrh       }
2105e4de1febSdrh       break;
2106e4de1febSdrh     }
2107e4de1febSdrh     default: break;
2108e4de1febSdrh   }
210992b01d53Sdrh   return rc;
2110e4de1febSdrh }
2111e4de1febSdrh 
2112e4de1febSdrh /*
2113039fc32eSdrh ** Return FALSE if there is no chance that the expression can be NULL.
2114039fc32eSdrh **
2115039fc32eSdrh ** If the expression might be NULL or if the expression is too complex
2116039fc32eSdrh ** to tell return TRUE.
2117039fc32eSdrh **
2118039fc32eSdrh ** This routine is used as an optimization, to skip OP_IsNull opcodes
2119039fc32eSdrh ** when we know that a value cannot be NULL.  Hence, a false positive
2120039fc32eSdrh ** (returning TRUE when in fact the expression can never be NULL) might
2121039fc32eSdrh ** be a small performance hit but is otherwise harmless.  On the other
2122039fc32eSdrh ** hand, a false negative (returning FALSE when the result could be NULL)
2123039fc32eSdrh ** will likely result in an incorrect answer.  So when in doubt, return
2124039fc32eSdrh ** TRUE.
2125039fc32eSdrh */
2126039fc32eSdrh int sqlite3ExprCanBeNull(const Expr *p){
2127039fc32eSdrh   u8 op;
21289bfb0794Sdrh   while( p->op==TK_UPLUS || p->op==TK_UMINUS ){
21299bfb0794Sdrh     p = p->pLeft;
21309bfb0794Sdrh   }
2131039fc32eSdrh   op = p->op;
2132039fc32eSdrh   if( op==TK_REGISTER ) op = p->op2;
2133039fc32eSdrh   switch( op ){
2134039fc32eSdrh     case TK_INTEGER:
2135039fc32eSdrh     case TK_STRING:
2136039fc32eSdrh     case TK_FLOAT:
2137039fc32eSdrh     case TK_BLOB:
2138039fc32eSdrh       return 0;
21397248a8b2Sdrh     case TK_COLUMN:
214072673a24Sdrh       return ExprHasProperty(p, EP_CanBeNull) ||
2141eda079cdSdrh              p->y.pTab==0 ||  /* Reference to column of index on expression */
2142eda079cdSdrh              (p->iColumn>=0 && p->y.pTab->aCol[p->iColumn].notNull==0);
2143039fc32eSdrh     default:
2144039fc32eSdrh       return 1;
2145039fc32eSdrh   }
2146039fc32eSdrh }
2147039fc32eSdrh 
2148039fc32eSdrh /*
2149039fc32eSdrh ** Return TRUE if the given expression is a constant which would be
2150039fc32eSdrh ** unchanged by OP_Affinity with the affinity given in the second
2151039fc32eSdrh ** argument.
2152039fc32eSdrh **
2153039fc32eSdrh ** This routine is used to determine if the OP_Affinity operation
2154039fc32eSdrh ** can be omitted.  When in doubt return FALSE.  A false negative
2155039fc32eSdrh ** is harmless.  A false positive, however, can result in the wrong
2156039fc32eSdrh ** answer.
2157039fc32eSdrh */
2158039fc32eSdrh int sqlite3ExprNeedsNoAffinityChange(const Expr *p, char aff){
2159039fc32eSdrh   u8 op;
216005883a34Sdrh   if( aff==SQLITE_AFF_BLOB ) return 1;
2161cd7f457eSdrh   while( p->op==TK_UPLUS || p->op==TK_UMINUS ){ p = p->pLeft; }
2162039fc32eSdrh   op = p->op;
2163039fc32eSdrh   if( op==TK_REGISTER ) op = p->op2;
2164039fc32eSdrh   switch( op ){
2165039fc32eSdrh     case TK_INTEGER: {
2166039fc32eSdrh       return aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC;
2167039fc32eSdrh     }
2168039fc32eSdrh     case TK_FLOAT: {
2169039fc32eSdrh       return aff==SQLITE_AFF_REAL || aff==SQLITE_AFF_NUMERIC;
2170039fc32eSdrh     }
2171039fc32eSdrh     case TK_STRING: {
2172039fc32eSdrh       return aff==SQLITE_AFF_TEXT;
2173039fc32eSdrh     }
2174039fc32eSdrh     case TK_BLOB: {
2175039fc32eSdrh       return 1;
2176039fc32eSdrh     }
21772f2855b6Sdrh     case TK_COLUMN: {
217888376ca7Sdrh       assert( p->iTable>=0 );  /* p cannot be part of a CHECK constraint */
217988376ca7Sdrh       return p->iColumn<0
21802f2855b6Sdrh           && (aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC);
21812f2855b6Sdrh     }
2182039fc32eSdrh     default: {
2183039fc32eSdrh       return 0;
2184039fc32eSdrh     }
2185039fc32eSdrh   }
2186039fc32eSdrh }
2187039fc32eSdrh 
2188039fc32eSdrh /*
2189c4a3c779Sdrh ** Return TRUE if the given string is a row-id column name.
2190c4a3c779Sdrh */
21914adee20fSdanielk1977 int sqlite3IsRowid(const char *z){
21924adee20fSdanielk1977   if( sqlite3StrICmp(z, "_ROWID_")==0 ) return 1;
21934adee20fSdanielk1977   if( sqlite3StrICmp(z, "ROWID")==0 ) return 1;
21944adee20fSdanielk1977   if( sqlite3StrICmp(z, "OID")==0 ) return 1;
2195c4a3c779Sdrh   return 0;
2196c4a3c779Sdrh }
2197c4a3c779Sdrh 
21989a96b668Sdanielk1977 /*
219969c355bdSdrh ** pX is the RHS of an IN operator.  If pX is a SELECT statement
220069c355bdSdrh ** that can be simplified to a direct table access, then return
220169c355bdSdrh ** a pointer to the SELECT statement.  If pX is not a SELECT statement,
220269c355bdSdrh ** or if the SELECT statement needs to be manifested into a transient
220369c355bdSdrh ** table, then return NULL.
2204b287f4b6Sdrh */
2205b287f4b6Sdrh #ifndef SQLITE_OMIT_SUBQUERY
22067b35a77bSdan static Select *isCandidateForInOpt(Expr *pX){
220769c355bdSdrh   Select *p;
2208b287f4b6Sdrh   SrcList *pSrc;
2209b287f4b6Sdrh   ExprList *pEList;
2210b287f4b6Sdrh   Table *pTab;
2211cfbb5e82Sdan   int i;
221269c355bdSdrh   if( !ExprHasProperty(pX, EP_xIsSelect) ) return 0;  /* Not a subquery */
221369c355bdSdrh   if( ExprHasProperty(pX, EP_VarSelect)  ) return 0;  /* Correlated subq */
221469c355bdSdrh   p = pX->x.pSelect;
2215b287f4b6Sdrh   if( p->pPrior ) return 0;              /* Not a compound SELECT */
22167d10d5a6Sdrh   if( p->selFlags & (SF_Distinct|SF_Aggregate) ){
2217b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
2218b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
22197d10d5a6Sdrh     return 0; /* No DISTINCT keyword and no aggregate functions */
22207d10d5a6Sdrh   }
2221b74b1017Sdrh   assert( p->pGroupBy==0 );              /* Has no GROUP BY clause */
2222b287f4b6Sdrh   if( p->pLimit ) return 0;              /* Has no LIMIT clause */
2223b287f4b6Sdrh   if( p->pWhere ) return 0;              /* Has no WHERE clause */
2224b287f4b6Sdrh   pSrc = p->pSrc;
2225d1fa7bcaSdrh   assert( pSrc!=0 );
2226d1fa7bcaSdrh   if( pSrc->nSrc!=1 ) return 0;          /* Single term in FROM clause */
2227b74b1017Sdrh   if( pSrc->a[0].pSelect ) return 0;     /* FROM is not a subquery or view */
2228b287f4b6Sdrh   pTab = pSrc->a[0].pTab;
222969c355bdSdrh   assert( pTab!=0 );
2230b74b1017Sdrh   assert( pTab->pSelect==0 );            /* FROM clause is not a view */
2231b287f4b6Sdrh   if( IsVirtual(pTab) ) return 0;        /* FROM clause not a virtual table */
2232b287f4b6Sdrh   pEList = p->pEList;
2233ac6b47d1Sdrh   assert( pEList!=0 );
22347b35a77bSdan   /* All SELECT results must be columns. */
2235cfbb5e82Sdan   for(i=0; i<pEList->nExpr; i++){
2236cfbb5e82Sdan     Expr *pRes = pEList->a[i].pExpr;
2237cfbb5e82Sdan     if( pRes->op!=TK_COLUMN ) return 0;
223869c355bdSdrh     assert( pRes->iTable==pSrc->a[0].iCursor );  /* Not a correlated subquery */
2239cfbb5e82Sdan   }
224069c355bdSdrh   return p;
2241b287f4b6Sdrh }
2242b287f4b6Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
2243b287f4b6Sdrh 
2244f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
22451d8cb21fSdan /*
22464c259e9fSdrh ** Generate code that checks the left-most column of index table iCur to see if
22474c259e9fSdrh ** it contains any NULL entries.  Cause the register at regHasNull to be set
22486be515ebSdrh ** to a non-NULL value if iCur contains no NULLs.  Cause register regHasNull
22496be515ebSdrh ** to be set to NULL if iCur contains one or more NULL values.
22506be515ebSdrh */
22516be515ebSdrh static void sqlite3SetHasNullFlag(Vdbe *v, int iCur, int regHasNull){
2252728e0f91Sdrh   int addr1;
22536be515ebSdrh   sqlite3VdbeAddOp2(v, OP_Integer, 0, regHasNull);
2254728e0f91Sdrh   addr1 = sqlite3VdbeAddOp1(v, OP_Rewind, iCur); VdbeCoverage(v);
22556be515ebSdrh   sqlite3VdbeAddOp3(v, OP_Column, iCur, 0, regHasNull);
22566be515ebSdrh   sqlite3VdbeChangeP5(v, OPFLAG_TYPEOFARG);
22574c259e9fSdrh   VdbeComment((v, "first_entry_in(%d)", iCur));
2258728e0f91Sdrh   sqlite3VdbeJumpHere(v, addr1);
22596be515ebSdrh }
2260f9b2e05cSdan #endif
22616be515ebSdrh 
2262bb53ecb1Sdrh 
2263bb53ecb1Sdrh #ifndef SQLITE_OMIT_SUBQUERY
2264bb53ecb1Sdrh /*
2265bb53ecb1Sdrh ** The argument is an IN operator with a list (not a subquery) on the
2266bb53ecb1Sdrh ** right-hand side.  Return TRUE if that list is constant.
2267bb53ecb1Sdrh */
2268bb53ecb1Sdrh static int sqlite3InRhsIsConstant(Expr *pIn){
2269bb53ecb1Sdrh   Expr *pLHS;
2270bb53ecb1Sdrh   int res;
2271bb53ecb1Sdrh   assert( !ExprHasProperty(pIn, EP_xIsSelect) );
2272bb53ecb1Sdrh   pLHS = pIn->pLeft;
2273bb53ecb1Sdrh   pIn->pLeft = 0;
2274bb53ecb1Sdrh   res = sqlite3ExprIsConstant(pIn);
2275bb53ecb1Sdrh   pIn->pLeft = pLHS;
2276bb53ecb1Sdrh   return res;
2277bb53ecb1Sdrh }
2278bb53ecb1Sdrh #endif
2279bb53ecb1Sdrh 
22806be515ebSdrh /*
22819a96b668Sdanielk1977 ** This function is used by the implementation of the IN (...) operator.
2282d4305ca6Sdrh ** The pX parameter is the expression on the RHS of the IN operator, which
2283d4305ca6Sdrh ** might be either a list of expressions or a subquery.
22849a96b668Sdanielk1977 **
2285d4305ca6Sdrh ** The job of this routine is to find or create a b-tree object that can
2286d4305ca6Sdrh ** be used either to test for membership in the RHS set or to iterate through
2287d4305ca6Sdrh ** all members of the RHS set, skipping duplicates.
2288d4305ca6Sdrh **
22893a85625dSdrh ** A cursor is opened on the b-tree object that is the RHS of the IN operator
2290d4305ca6Sdrh ** and pX->iTable is set to the index of that cursor.
2291d4305ca6Sdrh **
2292b74b1017Sdrh ** The returned value of this function indicates the b-tree type, as follows:
22939a96b668Sdanielk1977 **
22949a96b668Sdanielk1977 **   IN_INDEX_ROWID      - The cursor was opened on a database table.
22951ccce449Sdrh **   IN_INDEX_INDEX_ASC  - The cursor was opened on an ascending index.
22961ccce449Sdrh **   IN_INDEX_INDEX_DESC - The cursor was opened on a descending index.
22979a96b668Sdanielk1977 **   IN_INDEX_EPH        - The cursor was opened on a specially created and
22989a96b668Sdanielk1977 **                         populated epheremal table.
2299bb53ecb1Sdrh **   IN_INDEX_NOOP       - No cursor was allocated.  The IN operator must be
2300bb53ecb1Sdrh **                         implemented as a sequence of comparisons.
23019a96b668Sdanielk1977 **
2302d4305ca6Sdrh ** An existing b-tree might be used if the RHS expression pX is a simple
2303d4305ca6Sdrh ** subquery such as:
23049a96b668Sdanielk1977 **
2305553168c7Sdan **     SELECT <column1>, <column2>... FROM <table>
23069a96b668Sdanielk1977 **
2307d4305ca6Sdrh ** If the RHS of the IN operator is a list or a more complex subquery, then
2308d4305ca6Sdrh ** an ephemeral table might need to be generated from the RHS and then
230960ec914cSpeter.d.reid ** pX->iTable made to point to the ephemeral table instead of an
2310d4305ca6Sdrh ** existing table.
2311d4305ca6Sdrh **
23127fc0ba0fSdrh ** The inFlags parameter must contain, at a minimum, one of the bits
23137fc0ba0fSdrh ** IN_INDEX_MEMBERSHIP or IN_INDEX_LOOP but not both.  If inFlags contains
23147fc0ba0fSdrh ** IN_INDEX_MEMBERSHIP, then the generated table will be used for a fast
23157fc0ba0fSdrh ** membership test.  When the IN_INDEX_LOOP bit is set, the IN index will
23167fc0ba0fSdrh ** be used to loop over all values of the RHS of the IN operator.
23173a85625dSdrh **
23183a85625dSdrh ** When IN_INDEX_LOOP is used (and the b-tree will be used to iterate
23193a85625dSdrh ** through the set members) then the b-tree must not contain duplicates.
23207fc0ba0fSdrh ** An epheremal table will be created unless the selected columns are guaranteed
2321553168c7Sdan ** to be unique - either because it is an INTEGER PRIMARY KEY or due to
2322553168c7Sdan ** a UNIQUE constraint or index.
23230cdc022eSdanielk1977 **
23243a85625dSdrh ** When IN_INDEX_MEMBERSHIP is used (and the b-tree will be used
23253a85625dSdrh ** for fast set membership tests) then an epheremal table must
2326553168c7Sdan ** be used unless <columns> is a single INTEGER PRIMARY KEY column or an
2327553168c7Sdan ** index can be found with the specified <columns> as its left-most.
23280cdc022eSdanielk1977 **
2329bb53ecb1Sdrh ** If the IN_INDEX_NOOP_OK and IN_INDEX_MEMBERSHIP are both set and
2330bb53ecb1Sdrh ** if the RHS of the IN operator is a list (not a subquery) then this
2331bb53ecb1Sdrh ** routine might decide that creating an ephemeral b-tree for membership
2332bb53ecb1Sdrh ** testing is too expensive and return IN_INDEX_NOOP.  In that case, the
2333bb53ecb1Sdrh ** calling routine should implement the IN operator using a sequence
2334bb53ecb1Sdrh ** of Eq or Ne comparison operations.
2335bb53ecb1Sdrh **
2336b74b1017Sdrh ** When the b-tree is being used for membership tests, the calling function
23373a85625dSdrh ** might need to know whether or not the RHS side of the IN operator
2338e21a6e1dSdrh ** contains a NULL.  If prRhsHasNull is not a NULL pointer and
23393a85625dSdrh ** if there is any chance that the (...) might contain a NULL value at
23400cdc022eSdanielk1977 ** runtime, then a register is allocated and the register number written
2341e21a6e1dSdrh ** to *prRhsHasNull. If there is no chance that the (...) contains a
2342e21a6e1dSdrh ** NULL value, then *prRhsHasNull is left unchanged.
23430cdc022eSdanielk1977 **
2344e21a6e1dSdrh ** If a register is allocated and its location stored in *prRhsHasNull, then
23456be515ebSdrh ** the value in that register will be NULL if the b-tree contains one or more
23466be515ebSdrh ** NULL values, and it will be some non-NULL value if the b-tree contains no
23476be515ebSdrh ** NULL values.
2348553168c7Sdan **
2349553168c7Sdan ** If the aiMap parameter is not NULL, it must point to an array containing
2350553168c7Sdan ** one element for each column returned by the SELECT statement on the RHS
2351553168c7Sdan ** of the IN(...) operator. The i'th entry of the array is populated with the
2352553168c7Sdan ** offset of the index column that matches the i'th column returned by the
2353553168c7Sdan ** SELECT. For example, if the expression and selected index are:
2354553168c7Sdan **
2355553168c7Sdan **   (?,?,?) IN (SELECT a, b, c FROM t1)
2356553168c7Sdan **   CREATE INDEX i1 ON t1(b, c, a);
2357553168c7Sdan **
2358553168c7Sdan ** then aiMap[] is populated with {2, 0, 1}.
23599a96b668Sdanielk1977 */
2360284f4acaSdanielk1977 #ifndef SQLITE_OMIT_SUBQUERY
2361ba00e30aSdan int sqlite3FindInIndex(
23626fc8f364Sdrh   Parse *pParse,             /* Parsing context */
23636fc8f364Sdrh   Expr *pX,                  /* The right-hand side (RHS) of the IN operator */
23646fc8f364Sdrh   u32 inFlags,               /* IN_INDEX_LOOP, _MEMBERSHIP, and/or _NOOP_OK */
23656fc8f364Sdrh   int *prRhsHasNull,         /* Register holding NULL status.  See notes */
23662c04131cSdrh   int *aiMap,                /* Mapping from Index fields to RHS fields */
23672c04131cSdrh   int *piTab                 /* OUT: index to use */
2368ba00e30aSdan ){
2369b74b1017Sdrh   Select *p;                            /* SELECT to the right of IN operator */
2370b74b1017Sdrh   int eType = 0;                        /* Type of RHS table. IN_INDEX_* */
2371b74b1017Sdrh   int iTab = pParse->nTab++;            /* Cursor of the RHS table */
23723a85625dSdrh   int mustBeUnique;                     /* True if RHS must be unique */
2373b8475df8Sdrh   Vdbe *v = sqlite3GetVdbe(pParse);     /* Virtual machine being coded */
23749a96b668Sdanielk1977 
23751450bc6eSdrh   assert( pX->op==TK_IN );
23763a85625dSdrh   mustBeUnique = (inFlags & IN_INDEX_LOOP)!=0;
23771450bc6eSdrh 
23787b35a77bSdan   /* If the RHS of this IN(...) operator is a SELECT, and if it matters
23797b35a77bSdan   ** whether or not the SELECT result contains NULL values, check whether
2380870a0705Sdan   ** or not NULL is actually possible (it may not be, for example, due
23817b35a77bSdan   ** to NOT NULL constraints in the schema). If no NULL values are possible,
2382870a0705Sdan   ** set prRhsHasNull to 0 before continuing.  */
23837b35a77bSdan   if( prRhsHasNull && (pX->flags & EP_xIsSelect) ){
23847b35a77bSdan     int i;
23857b35a77bSdan     ExprList *pEList = pX->x.pSelect->pEList;
23867b35a77bSdan     for(i=0; i<pEList->nExpr; i++){
23877b35a77bSdan       if( sqlite3ExprCanBeNull(pEList->a[i].pExpr) ) break;
23887b35a77bSdan     }
23897b35a77bSdan     if( i==pEList->nExpr ){
23907b35a77bSdan       prRhsHasNull = 0;
23917b35a77bSdan     }
23927b35a77bSdan   }
23937b35a77bSdan 
2394b74b1017Sdrh   /* Check to see if an existing table or index can be used to
2395b74b1017Sdrh   ** satisfy the query.  This is preferable to generating a new
23967b35a77bSdan   ** ephemeral table.  */
23977b35a77bSdan   if( pParse->nErr==0 && (p = isCandidateForInOpt(pX))!=0 ){
2398e1fb65a0Sdanielk1977     sqlite3 *db = pParse->db;              /* Database connection */
2399b07028f7Sdrh     Table *pTab;                           /* Table <table>. */
2400ba00e30aSdan     i16 iDb;                               /* Database idx for pTab */
2401cfbb5e82Sdan     ExprList *pEList = p->pEList;
2402cfbb5e82Sdan     int nExpr = pEList->nExpr;
2403e1fb65a0Sdanielk1977 
2404b07028f7Sdrh     assert( p->pEList!=0 );             /* Because of isCandidateForInOpt(p) */
2405b07028f7Sdrh     assert( p->pEList->a[0].pExpr!=0 ); /* Because of isCandidateForInOpt(p) */
2406b07028f7Sdrh     assert( p->pSrc!=0 );               /* Because of isCandidateForInOpt(p) */
2407b07028f7Sdrh     pTab = p->pSrc->a[0].pTab;
2408b07028f7Sdrh 
2409b22f7c83Sdrh     /* Code an OP_Transaction and OP_TableLock for <table>. */
2410e1fb65a0Sdanielk1977     iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
2411e1fb65a0Sdanielk1977     sqlite3CodeVerifySchema(pParse, iDb);
2412e1fb65a0Sdanielk1977     sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
24139a96b668Sdanielk1977 
2414a84a283dSdrh     assert(v);  /* sqlite3GetVdbe() has always been previously called */
2415cfbb5e82Sdan     if( nExpr==1 && pEList->a[0].pExpr->iColumn<0 ){
241662659b2aSdrh       /* The "x IN (SELECT rowid FROM table)" case */
2417511f9e8dSdrh       int iAddr = sqlite3VdbeAddOp0(v, OP_Once);
24187d176105Sdrh       VdbeCoverage(v);
24199a96b668Sdanielk1977 
24209a96b668Sdanielk1977       sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
24219a96b668Sdanielk1977       eType = IN_INDEX_ROWID;
2422d8852095Sdrh       ExplainQueryPlan((pParse, 0,
2423d8852095Sdrh             "USING ROWID SEARCH ON TABLE %s FOR IN-OPERATOR",pTab->zName));
24249a96b668Sdanielk1977       sqlite3VdbeJumpHere(v, iAddr);
24259a96b668Sdanielk1977     }else{
2426e1fb65a0Sdanielk1977       Index *pIdx;                         /* Iterator variable */
2427cfbb5e82Sdan       int affinity_ok = 1;
2428cfbb5e82Sdan       int i;
2429cfbb5e82Sdan 
2430cfbb5e82Sdan       /* Check that the affinity that will be used to perform each
243162659b2aSdrh       ** comparison is the same as the affinity of each column in table
243262659b2aSdrh       ** on the RHS of the IN operator.  If it not, it is not possible to
243362659b2aSdrh       ** use any index of the RHS table.  */
2434cfbb5e82Sdan       for(i=0; i<nExpr && affinity_ok; i++){
2435fc7f27b9Sdrh         Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2436cfbb5e82Sdan         int iCol = pEList->a[i].pExpr->iColumn;
24370dfa4f6fSdrh         char idxaff = sqlite3TableColumnAffinity(pTab,iCol); /* RHS table */
2438cfbb5e82Sdan         char cmpaff = sqlite3CompareAffinity(pLhs, idxaff);
243962659b2aSdrh         testcase( cmpaff==SQLITE_AFF_BLOB );
244062659b2aSdrh         testcase( cmpaff==SQLITE_AFF_TEXT );
2441cfbb5e82Sdan         switch( cmpaff ){
2442cfbb5e82Sdan           case SQLITE_AFF_BLOB:
2443cfbb5e82Sdan             break;
2444cfbb5e82Sdan           case SQLITE_AFF_TEXT:
244562659b2aSdrh             /* sqlite3CompareAffinity() only returns TEXT if one side or the
244662659b2aSdrh             ** other has no affinity and the other side is TEXT.  Hence,
244762659b2aSdrh             ** the only way for cmpaff to be TEXT is for idxaff to be TEXT
244862659b2aSdrh             ** and for the term on the LHS of the IN to have no affinity. */
244962659b2aSdrh             assert( idxaff==SQLITE_AFF_TEXT );
2450cfbb5e82Sdan             break;
2451cfbb5e82Sdan           default:
2452cfbb5e82Sdan             affinity_ok = sqlite3IsNumericAffinity(idxaff);
2453cfbb5e82Sdan         }
2454cfbb5e82Sdan       }
2455e1fb65a0Sdanielk1977 
2456a84a283dSdrh       if( affinity_ok ){
2457a84a283dSdrh         /* Search for an existing index that will work for this IN operator */
2458a84a283dSdrh         for(pIdx=pTab->pIndex; pIdx && eType==0; pIdx=pIdx->pNext){
2459a84a283dSdrh           Bitmask colUsed;      /* Columns of the index used */
2460a84a283dSdrh           Bitmask mCol;         /* Mask for the current column */
24616fc8f364Sdrh           if( pIdx->nColumn<nExpr ) continue;
2462d4a4a361Sdrh           if( pIdx->pPartIdxWhere!=0 ) continue;
2463a84a283dSdrh           /* Maximum nColumn is BMS-2, not BMS-1, so that we can compute
2464a84a283dSdrh           ** BITMASK(nExpr) without overflowing */
2465a84a283dSdrh           testcase( pIdx->nColumn==BMS-2 );
2466a84a283dSdrh           testcase( pIdx->nColumn==BMS-1 );
2467a84a283dSdrh           if( pIdx->nColumn>=BMS-1 ) continue;
24686fc8f364Sdrh           if( mustBeUnique ){
24696fc8f364Sdrh             if( pIdx->nKeyCol>nExpr
24706fc8f364Sdrh              ||(pIdx->nColumn>nExpr && !IsUniqueIndex(pIdx))
24716fc8f364Sdrh             ){
2472a84a283dSdrh               continue;  /* This index is not unique over the IN RHS columns */
2473cfbb5e82Sdan             }
24746fc8f364Sdrh           }
2475cfbb5e82Sdan 
2476a84a283dSdrh           colUsed = 0;   /* Columns of index used so far */
2477cfbb5e82Sdan           for(i=0; i<nExpr; i++){
2478fc7f27b9Sdrh             Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2479cfbb5e82Sdan             Expr *pRhs = pEList->a[i].pExpr;
2480cfbb5e82Sdan             CollSeq *pReq = sqlite3BinaryCompareCollSeq(pParse, pLhs, pRhs);
2481cfbb5e82Sdan             int j;
2482cfbb5e82Sdan 
24836fc8f364Sdrh             assert( pReq!=0 || pRhs->iColumn==XN_ROWID || pParse->nErr );
2484cfbb5e82Sdan             for(j=0; j<nExpr; j++){
2485cfbb5e82Sdan               if( pIdx->aiColumn[j]!=pRhs->iColumn ) continue;
2486cfbb5e82Sdan               assert( pIdx->azColl[j] );
2487106526e1Sdrh               if( pReq!=0 && sqlite3StrICmp(pReq->zName, pIdx->azColl[j])!=0 ){
2488106526e1Sdrh                 continue;
2489106526e1Sdrh               }
2490cfbb5e82Sdan               break;
2491cfbb5e82Sdan             }
2492cfbb5e82Sdan             if( j==nExpr ) break;
2493a84a283dSdrh             mCol = MASKBIT(j);
2494a84a283dSdrh             if( mCol & colUsed ) break; /* Each column used only once */
2495a84a283dSdrh             colUsed |= mCol;
2496ba00e30aSdan             if( aiMap ) aiMap[i] = j;
2497cfbb5e82Sdan           }
2498cfbb5e82Sdan 
2499a84a283dSdrh           assert( i==nExpr || colUsed!=(MASKBIT(nExpr)-1) );
2500a84a283dSdrh           if( colUsed==(MASKBIT(nExpr)-1) ){
2501a84a283dSdrh             /* If we reach this point, that means the index pIdx is usable */
2502511f9e8dSdrh             int iAddr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
2503e2ca99c9Sdrh             ExplainQueryPlan((pParse, 0,
2504e2ca99c9Sdrh                               "USING INDEX %s FOR IN-OPERATOR",pIdx->zName));
25052ec2fb22Sdrh             sqlite3VdbeAddOp3(v, OP_OpenRead, iTab, pIdx->tnum, iDb);
25062ec2fb22Sdrh             sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
2507207872a4Sdanielk1977             VdbeComment((v, "%s", pIdx->zName));
25081ccce449Sdrh             assert( IN_INDEX_INDEX_DESC == IN_INDEX_INDEX_ASC+1 );
25091ccce449Sdrh             eType = IN_INDEX_INDEX_ASC + pIdx->aSortOrder[0];
25109a96b668Sdanielk1977 
25117b35a77bSdan             if( prRhsHasNull ){
25123480bfdaSdan #ifdef SQLITE_ENABLE_COLUMN_USED_MASK
2513cfbb5e82Sdan               i64 mask = (1<<nExpr)-1;
25143480bfdaSdan               sqlite3VdbeAddOp4Dup8(v, OP_ColumnsUsed,
2515cfbb5e82Sdan                   iTab, 0, 0, (u8*)&mask, P4_INT64);
25163480bfdaSdan #endif
2517b80dbdc2Sdrh               *prRhsHasNull = ++pParse->nMem;
25187b35a77bSdan               if( nExpr==1 ){
25196be515ebSdrh                 sqlite3SetHasNullFlag(v, iTab, *prRhsHasNull);
25200cdc022eSdanielk1977               }
25217b35a77bSdan             }
2522552fd454Sdrh             sqlite3VdbeJumpHere(v, iAddr);
25239a96b668Sdanielk1977           }
2524a84a283dSdrh         } /* End loop over indexes */
2525a84a283dSdrh       } /* End if( affinity_ok ) */
2526a84a283dSdrh     } /* End if not an rowid index */
2527a84a283dSdrh   } /* End attempt to optimize using an index */
25289a96b668Sdanielk1977 
2529bb53ecb1Sdrh   /* If no preexisting index is available for the IN clause
2530bb53ecb1Sdrh   ** and IN_INDEX_NOOP is an allowed reply
2531bb53ecb1Sdrh   ** and the RHS of the IN operator is a list, not a subquery
253271c57db0Sdan   ** and the RHS is not constant or has two or fewer terms,
253360ec914cSpeter.d.reid   ** then it is not worth creating an ephemeral table to evaluate
2534bb53ecb1Sdrh   ** the IN operator so return IN_INDEX_NOOP.
2535bb53ecb1Sdrh   */
2536bb53ecb1Sdrh   if( eType==0
2537bb53ecb1Sdrh    && (inFlags & IN_INDEX_NOOP_OK)
2538bb53ecb1Sdrh    && !ExprHasProperty(pX, EP_xIsSelect)
2539bb53ecb1Sdrh    && (!sqlite3InRhsIsConstant(pX) || pX->x.pList->nExpr<=2)
2540bb53ecb1Sdrh   ){
2541bb53ecb1Sdrh     eType = IN_INDEX_NOOP;
2542bb53ecb1Sdrh   }
2543bb53ecb1Sdrh 
25449a96b668Sdanielk1977   if( eType==0 ){
25454387006cSdrh     /* Could not find an existing table or index to use as the RHS b-tree.
2546b74b1017Sdrh     ** We will have to generate an ephemeral table to do the job.
2547b74b1017Sdrh     */
25488e23daf3Sdrh     u32 savedNQueryLoop = pParse->nQueryLoop;
25490cdc022eSdanielk1977     int rMayHaveNull = 0;
255041a05b7bSdanielk1977     eType = IN_INDEX_EPH;
25513a85625dSdrh     if( inFlags & IN_INDEX_LOOP ){
25524a5acf8eSdrh       pParse->nQueryLoop = 0;
2553e21a6e1dSdrh     }else if( prRhsHasNull ){
2554e21a6e1dSdrh       *prRhsHasNull = rMayHaveNull = ++pParse->nMem;
2555cf4d38aaSdrh     }
255685bcdce2Sdrh     assert( pX->op==TK_IN );
255750ef6716Sdrh     sqlite3CodeRhsOfIN(pParse, pX, iTab);
255885bcdce2Sdrh     if( rMayHaveNull ){
25592c04131cSdrh       sqlite3SetHasNullFlag(v, iTab, rMayHaveNull);
256085bcdce2Sdrh     }
2561cf4d38aaSdrh     pParse->nQueryLoop = savedNQueryLoop;
25629a96b668Sdanielk1977   }
2563ba00e30aSdan 
2564ba00e30aSdan   if( aiMap && eType!=IN_INDEX_INDEX_ASC && eType!=IN_INDEX_INDEX_DESC ){
2565ba00e30aSdan     int i, n;
2566ba00e30aSdan     n = sqlite3ExprVectorSize(pX->pLeft);
2567ba00e30aSdan     for(i=0; i<n; i++) aiMap[i] = i;
2568ba00e30aSdan   }
25692c04131cSdrh   *piTab = iTab;
25709a96b668Sdanielk1977   return eType;
25719a96b668Sdanielk1977 }
2572284f4acaSdanielk1977 #endif
2573626a879aSdrh 
2574f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
2575553168c7Sdan /*
2576553168c7Sdan ** Argument pExpr is an (?, ?...) IN(...) expression. This
2577553168c7Sdan ** function allocates and returns a nul-terminated string containing
2578553168c7Sdan ** the affinities to be used for each column of the comparison.
2579553168c7Sdan **
2580553168c7Sdan ** It is the responsibility of the caller to ensure that the returned
2581553168c7Sdan ** string is eventually freed using sqlite3DbFree().
2582553168c7Sdan */
258371c57db0Sdan static char *exprINAffinity(Parse *pParse, Expr *pExpr){
258471c57db0Sdan   Expr *pLeft = pExpr->pLeft;
258571c57db0Sdan   int nVal = sqlite3ExprVectorSize(pLeft);
2586553168c7Sdan   Select *pSelect = (pExpr->flags & EP_xIsSelect) ? pExpr->x.pSelect : 0;
258771c57db0Sdan   char *zRet;
258871c57db0Sdan 
2589553168c7Sdan   assert( pExpr->op==TK_IN );
25905c258dc1Sdrh   zRet = sqlite3DbMallocRaw(pParse->db, nVal+1);
259171c57db0Sdan   if( zRet ){
259271c57db0Sdan     int i;
259371c57db0Sdan     for(i=0; i<nVal; i++){
2594fc7f27b9Sdrh       Expr *pA = sqlite3VectorFieldSubexpr(pLeft, i);
2595553168c7Sdan       char a = sqlite3ExprAffinity(pA);
2596553168c7Sdan       if( pSelect ){
2597553168c7Sdan         zRet[i] = sqlite3CompareAffinity(pSelect->pEList->a[i].pExpr, a);
259871c57db0Sdan       }else{
2599553168c7Sdan         zRet[i] = a;
260071c57db0Sdan       }
260171c57db0Sdan     }
260271c57db0Sdan     zRet[nVal] = '\0';
260371c57db0Sdan   }
260471c57db0Sdan   return zRet;
260571c57db0Sdan }
2606f9b2e05cSdan #endif
260771c57db0Sdan 
26088da209b1Sdan #ifndef SQLITE_OMIT_SUBQUERY
26098da209b1Sdan /*
26108da209b1Sdan ** Load the Parse object passed as the first argument with an error
26118da209b1Sdan ** message of the form:
26128da209b1Sdan **
26138da209b1Sdan **   "sub-select returns N columns - expected M"
26148da209b1Sdan */
26158da209b1Sdan void sqlite3SubselectError(Parse *pParse, int nActual, int nExpect){
26168da209b1Sdan   const char *zFmt = "sub-select returns %d columns - expected %d";
26178da209b1Sdan   sqlite3ErrorMsg(pParse, zFmt, nActual, nExpect);
26188da209b1Sdan }
26198da209b1Sdan #endif
26208da209b1Sdan 
2621626a879aSdrh /*
262244c5604cSdan ** Expression pExpr is a vector that has been used in a context where
262344c5604cSdan ** it is not permitted. If pExpr is a sub-select vector, this routine
262444c5604cSdan ** loads the Parse object with a message of the form:
262544c5604cSdan **
262644c5604cSdan **   "sub-select returns N columns - expected 1"
262744c5604cSdan **
262844c5604cSdan ** Or, if it is a regular scalar vector:
262944c5604cSdan **
263044c5604cSdan **   "row value misused"
263144c5604cSdan */
263244c5604cSdan void sqlite3VectorErrorMsg(Parse *pParse, Expr *pExpr){
263344c5604cSdan #ifndef SQLITE_OMIT_SUBQUERY
263444c5604cSdan   if( pExpr->flags & EP_xIsSelect ){
263544c5604cSdan     sqlite3SubselectError(pParse, pExpr->x.pSelect->pEList->nExpr, 1);
263644c5604cSdan   }else
263744c5604cSdan #endif
263844c5604cSdan   {
263944c5604cSdan     sqlite3ErrorMsg(pParse, "row value misused");
264044c5604cSdan   }
264144c5604cSdan }
264244c5604cSdan 
264385bcdce2Sdrh #ifndef SQLITE_OMIT_SUBQUERY
264444c5604cSdan /*
264585bcdce2Sdrh ** Generate code that will construct an ephemeral table containing all terms
264685bcdce2Sdrh ** in the RHS of an IN operator.  The IN operator can be in either of two
264785bcdce2Sdrh ** forms:
2648626a879aSdrh **
26499cbe6352Sdrh **     x IN (4,5,11)              -- IN operator with list on right-hand side
26509cbe6352Sdrh **     x IN (SELECT a FROM b)     -- IN operator with subquery on the right
2651fef5208cSdrh **
26522c04131cSdrh ** The pExpr parameter is the IN operator.  The cursor number for the
26532c04131cSdrh ** constructed ephermeral table is returned.  The first time the ephemeral
26542c04131cSdrh ** table is computed, the cursor number is also stored in pExpr->iTable,
26552c04131cSdrh ** however the cursor number returned might not be the same, as it might
26562c04131cSdrh ** have been duplicated using OP_OpenDup.
265741a05b7bSdanielk1977 **
265885bcdce2Sdrh ** If the LHS expression ("x" in the examples) is a column value, or
265985bcdce2Sdrh ** the SELECT statement returns a column value, then the affinity of that
266085bcdce2Sdrh ** column is used to build the index keys. If both 'x' and the
266185bcdce2Sdrh ** SELECT... statement are columns, then numeric affinity is used
266285bcdce2Sdrh ** if either column has NUMERIC or INTEGER affinity. If neither
266385bcdce2Sdrh ** 'x' nor the SELECT... statement are columns, then numeric affinity
266485bcdce2Sdrh ** is used.
2665cce7d176Sdrh */
266685bcdce2Sdrh void sqlite3CodeRhsOfIN(
2667fd773cf9Sdrh   Parse *pParse,          /* Parsing context */
266885bcdce2Sdrh   Expr *pExpr,            /* The IN operator */
266950ef6716Sdrh   int iTab                /* Use this cursor number */
267041a05b7bSdanielk1977 ){
26712c04131cSdrh   int addrOnce = 0;           /* Address of the OP_Once instruction at top */
267285bcdce2Sdrh   int addr;                   /* Address of OP_OpenEphemeral instruction */
267385bcdce2Sdrh   Expr *pLeft;                /* the LHS of the IN operator */
267485bcdce2Sdrh   KeyInfo *pKeyInfo = 0;      /* Key information */
267585bcdce2Sdrh   int nVal;                   /* Size of vector pLeft */
267685bcdce2Sdrh   Vdbe *v;                    /* The prepared statement under construction */
2677fc976065Sdanielk1977 
26782c04131cSdrh   v = pParse->pVdbe;
267985bcdce2Sdrh   assert( v!=0 );
268085bcdce2Sdrh 
26812c04131cSdrh   /* The evaluation of the IN must be repeated every time it
268239a11819Sdrh   ** is encountered if any of the following is true:
268357dbd7b3Sdrh   **
268457dbd7b3Sdrh   **    *  The right-hand side is a correlated subquery
268557dbd7b3Sdrh   **    *  The right-hand side is an expression list containing variables
268657dbd7b3Sdrh   **    *  We are inside a trigger
268757dbd7b3Sdrh   **
26882c04131cSdrh   ** If all of the above are false, then we can compute the RHS just once
26892c04131cSdrh   ** and reuse it many names.
2690b3bce662Sdanielk1977   */
2691efb699fcSdrh   if( !ExprHasProperty(pExpr, EP_VarSelect) && pParse->iSelfTab==0 ){
26922c04131cSdrh     /* Reuse of the RHS is allowed */
26932c04131cSdrh     /* If this routine has already been coded, but the previous code
26942c04131cSdrh     ** might not have been invoked yet, so invoke it now as a subroutine.
26952c04131cSdrh     */
26962c04131cSdrh     if( ExprHasProperty(pExpr, EP_Subrtn) ){
2697f9231c34Sdrh       addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
2698bd462bccSdrh       if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2699bd462bccSdrh         ExplainQueryPlan((pParse, 0, "REUSE LIST SUBQUERY %d",
2700bd462bccSdrh               pExpr->x.pSelect->selId));
2701bd462bccSdrh       }
27022c04131cSdrh       sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
27032c04131cSdrh                         pExpr->y.sub.iAddr);
27042c04131cSdrh       sqlite3VdbeAddOp2(v, OP_OpenDup, iTab, pExpr->iTable);
2705f9231c34Sdrh       sqlite3VdbeJumpHere(v, addrOnce);
27062c04131cSdrh       return;
27072c04131cSdrh     }
27082c04131cSdrh 
27092c04131cSdrh     /* Begin coding the subroutine */
27102c04131cSdrh     ExprSetProperty(pExpr, EP_Subrtn);
27112c04131cSdrh     pExpr->y.sub.regReturn = ++pParse->nMem;
27122c04131cSdrh     pExpr->y.sub.iAddr =
27132c04131cSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 0, pExpr->y.sub.regReturn) + 1;
27142c04131cSdrh     VdbeComment((v, "return address"));
27152c04131cSdrh 
27162c04131cSdrh     addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
2717b3bce662Sdanielk1977   }
2718b3bce662Sdanielk1977 
271985bcdce2Sdrh   /* Check to see if this is a vector IN operator */
272085bcdce2Sdrh   pLeft = pExpr->pLeft;
272171c57db0Sdan   nVal = sqlite3ExprVectorSize(pLeft);
2722e014a838Sdanielk1977 
272385bcdce2Sdrh   /* Construct the ephemeral table that will contain the content of
272485bcdce2Sdrh   ** RHS of the IN operator.
2725fef5208cSdrh   */
27262c04131cSdrh   pExpr->iTable = iTab;
272750ef6716Sdrh   addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, pExpr->iTable, nVal);
27282c04131cSdrh #ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
27292c04131cSdrh   if( ExprHasProperty(pExpr, EP_xIsSelect) ){
27302c04131cSdrh     VdbeComment((v, "Result of SELECT %u", pExpr->x.pSelect->selId));
27312c04131cSdrh   }else{
27322c04131cSdrh     VdbeComment((v, "RHS of IN operator"));
27332c04131cSdrh   }
27342c04131cSdrh #endif
273550ef6716Sdrh   pKeyInfo = sqlite3KeyInfoAlloc(pParse->db, nVal, 1);
2736e014a838Sdanielk1977 
27376ab3a2ecSdanielk1977   if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2738e014a838Sdanielk1977     /* Case 1:     expr IN (SELECT ...)
2739e014a838Sdanielk1977     **
2740e014a838Sdanielk1977     ** Generate code to write the results of the select into the temporary
2741e014a838Sdanielk1977     ** table allocated and opened above.
2742e014a838Sdanielk1977     */
27434387006cSdrh     Select *pSelect = pExpr->x.pSelect;
274471c57db0Sdan     ExprList *pEList = pSelect->pEList;
27451013c932Sdrh 
27462c04131cSdrh     ExplainQueryPlan((pParse, 1, "%sLIST SUBQUERY %d",
27472c04131cSdrh         addrOnce?"":"CORRELATED ", pSelect->selId
2748e2ca99c9Sdrh     ));
274964bcb8cfSdrh     /* If the LHS and RHS of the IN operator do not match, that
275064bcb8cfSdrh     ** error will have been caught long before we reach this point. */
275164bcb8cfSdrh     if( ALWAYS(pEList->nExpr==nVal) ){
275271c57db0Sdan       SelectDest dest;
275371c57db0Sdan       int i;
2754bd462bccSdrh       sqlite3SelectDestInit(&dest, SRT_Set, iTab);
275571c57db0Sdan       dest.zAffSdst = exprINAffinity(pParse, pExpr);
27564387006cSdrh       pSelect->iLimit = 0;
27574387006cSdrh       testcase( pSelect->selFlags & SF_Distinct );
2758812ea833Sdrh       testcase( pKeyInfo==0 ); /* Caused by OOM in sqlite3KeyInfoAlloc() */
27594387006cSdrh       if( sqlite3Select(pParse, pSelect, &dest) ){
276071c57db0Sdan         sqlite3DbFree(pParse->db, dest.zAffSdst);
27612ec2fb22Sdrh         sqlite3KeyInfoUnref(pKeyInfo);
276285bcdce2Sdrh         return;
276394ccde58Sdrh       }
276471c57db0Sdan       sqlite3DbFree(pParse->db, dest.zAffSdst);
2765812ea833Sdrh       assert( pKeyInfo!=0 ); /* OOM will cause exit after sqlite3Select() */
27663535ec3eSdrh       assert( pEList!=0 );
27673535ec3eSdrh       assert( pEList->nExpr>0 );
27682ec2fb22Sdrh       assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
276971c57db0Sdan       for(i=0; i<nVal; i++){
2770773d3afaSdan         Expr *p = sqlite3VectorFieldSubexpr(pLeft, i);
277171c57db0Sdan         pKeyInfo->aColl[i] = sqlite3BinaryCompareCollSeq(
277271c57db0Sdan             pParse, p, pEList->a[i].pExpr
277371c57db0Sdan         );
277471c57db0Sdan       }
277571c57db0Sdan     }
2776a7d2db17Sdrh   }else if( ALWAYS(pExpr->x.pList!=0) ){
2777fef5208cSdrh     /* Case 2:     expr IN (exprlist)
2778fef5208cSdrh     **
2779e014a838Sdanielk1977     ** For each expression, build an index key from the evaluation and
2780e014a838Sdanielk1977     ** store it in the temporary table. If <expr> is a column, then use
2781e014a838Sdanielk1977     ** that columns affinity when building index keys. If <expr> is not
2782e014a838Sdanielk1977     ** a column, use numeric affinity.
2783fef5208cSdrh     */
278471c57db0Sdan     char affinity;            /* Affinity of the LHS of the IN */
2785e014a838Sdanielk1977     int i;
27866ab3a2ecSdanielk1977     ExprList *pList = pExpr->x.pList;
278757dbd7b3Sdrh     struct ExprList_item *pItem;
2788ecc31805Sdrh     int r1, r2, r3;
278971c57db0Sdan     affinity = sqlite3ExprAffinity(pLeft);
2790e014a838Sdanielk1977     if( !affinity ){
279105883a34Sdrh       affinity = SQLITE_AFF_BLOB;
2792e014a838Sdanielk1977     }
2793323df790Sdrh     if( pKeyInfo ){
27942ec2fb22Sdrh       assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
2795323df790Sdrh       pKeyInfo->aColl[0] = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
2796323df790Sdrh     }
2797e014a838Sdanielk1977 
2798e014a838Sdanielk1977     /* Loop through each expression in <exprlist>. */
27992d401ab8Sdrh     r1 = sqlite3GetTempReg(pParse);
28002d401ab8Sdrh     r2 = sqlite3GetTempReg(pParse);
280157dbd7b3Sdrh     for(i=pList->nExpr, pItem=pList->a; i>0; i--, pItem++){
280257dbd7b3Sdrh       Expr *pE2 = pItem->pExpr;
2803e014a838Sdanielk1977 
280457dbd7b3Sdrh       /* If the expression is not constant then we will need to
280557dbd7b3Sdrh       ** disable the test that was generated above that makes sure
280657dbd7b3Sdrh       ** this code only executes once.  Because for a non-constant
280757dbd7b3Sdrh       ** expression we need to rerun this code each time.
280857dbd7b3Sdrh       */
28092c04131cSdrh       if( addrOnce && !sqlite3ExprIsConstant(pE2) ){
28102c04131cSdrh         sqlite3VdbeChangeToNoop(v, addrOnce);
28112c04131cSdrh         addrOnce = 0;
28124794b980Sdrh       }
2813e014a838Sdanielk1977 
2814e014a838Sdanielk1977       /* Evaluate the expression and insert it into the temp table */
2815ecc31805Sdrh       r3 = sqlite3ExprCodeTarget(pParse, pE2, r1);
2816ecc31805Sdrh       sqlite3VdbeAddOp4(v, OP_MakeRecord, r3, 1, r2, &affinity, 1);
2817bd462bccSdrh       sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iTab, r2, r3, 1);
2818fef5208cSdrh     }
28192d401ab8Sdrh     sqlite3ReleaseTempReg(pParse, r1);
28202d401ab8Sdrh     sqlite3ReleaseTempReg(pParse, r2);
2821fef5208cSdrh   }
2822323df790Sdrh   if( pKeyInfo ){
28232ec2fb22Sdrh     sqlite3VdbeChangeP4(v, addr, (void *)pKeyInfo, P4_KEYINFO);
282441a05b7bSdanielk1977   }
28252c04131cSdrh   if( addrOnce ){
28262c04131cSdrh     sqlite3VdbeJumpHere(v, addrOnce);
28272c04131cSdrh     /* Subroutine return */
28282c04131cSdrh     sqlite3VdbeAddOp1(v, OP_Return, pExpr->y.sub.regReturn);
28292c04131cSdrh     sqlite3VdbeChangeP1(v, pExpr->y.sub.iAddr-1, sqlite3VdbeCurrentAddr(v)-1);
283085bcdce2Sdrh   }
283185bcdce2Sdrh }
283285bcdce2Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
283385bcdce2Sdrh 
283485bcdce2Sdrh /*
283585bcdce2Sdrh ** Generate code for scalar subqueries used as a subquery expression
283685bcdce2Sdrh ** or EXISTS operator:
283785bcdce2Sdrh **
283885bcdce2Sdrh **     (SELECT a FROM b)          -- subquery
283985bcdce2Sdrh **     EXISTS (SELECT a FROM b)   -- EXISTS subquery
284085bcdce2Sdrh **
284185bcdce2Sdrh ** The pExpr parameter is the SELECT or EXISTS operator to be coded.
284285bcdce2Sdrh **
284385bcdce2Sdrh ** The register that holds the result.  For a multi-column SELECT,
284485bcdce2Sdrh ** the result is stored in a contiguous array of registers and the
284585bcdce2Sdrh ** return value is the register of the left-most result column.
284685bcdce2Sdrh ** Return 0 if an error occurs.
284785bcdce2Sdrh */
284885bcdce2Sdrh #ifndef SQLITE_OMIT_SUBQUERY
284985bcdce2Sdrh int sqlite3CodeSubselect(Parse *pParse, Expr *pExpr){
28502c04131cSdrh   int addrOnce = 0;           /* Address of OP_Once at top of subroutine */
285185bcdce2Sdrh   int rReg = 0;               /* Register storing resulting */
285285bcdce2Sdrh   Select *pSel;               /* SELECT statement to encode */
285385bcdce2Sdrh   SelectDest dest;            /* How to deal with SELECT result */
285485bcdce2Sdrh   int nReg;                   /* Registers to allocate */
285585bcdce2Sdrh   Expr *pLimit;               /* New limit expression */
28562c04131cSdrh 
28572c04131cSdrh   Vdbe *v = pParse->pVdbe;
285885bcdce2Sdrh   assert( v!=0 );
2859bd462bccSdrh   testcase( pExpr->op==TK_EXISTS );
2860bd462bccSdrh   testcase( pExpr->op==TK_SELECT );
2861bd462bccSdrh   assert( pExpr->op==TK_EXISTS || pExpr->op==TK_SELECT );
2862bd462bccSdrh   assert( ExprHasProperty(pExpr, EP_xIsSelect) );
2863bd462bccSdrh   pSel = pExpr->x.pSelect;
286485bcdce2Sdrh 
28655198ff57Sdrh   /* The evaluation of the EXISTS/SELECT must be repeated every time it
286685bcdce2Sdrh   ** is encountered if any of the following is true:
286785bcdce2Sdrh   **
286885bcdce2Sdrh   **    *  The right-hand side is a correlated subquery
286985bcdce2Sdrh   **    *  The right-hand side is an expression list containing variables
287085bcdce2Sdrh   **    *  We are inside a trigger
287185bcdce2Sdrh   **
287285bcdce2Sdrh   ** If all of the above are false, then we can run this code just once
287385bcdce2Sdrh   ** save the results, and reuse the same result on subsequent invocations.
287485bcdce2Sdrh   */
287585bcdce2Sdrh   if( !ExprHasProperty(pExpr, EP_VarSelect) ){
28765198ff57Sdrh     /* If this routine has already been coded, then invoke it as a
28775198ff57Sdrh     ** subroutine. */
28785198ff57Sdrh     if( ExprHasProperty(pExpr, EP_Subrtn) ){
2879bd462bccSdrh       ExplainQueryPlan((pParse, 0, "REUSE SUBQUERY %d", pSel->selId));
28805198ff57Sdrh       sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
28815198ff57Sdrh                         pExpr->y.sub.iAddr);
28825198ff57Sdrh       return pExpr->iTable;
28835198ff57Sdrh     }
28845198ff57Sdrh 
28855198ff57Sdrh     /* Begin coding the subroutine */
28865198ff57Sdrh     ExprSetProperty(pExpr, EP_Subrtn);
28875198ff57Sdrh     pExpr->y.sub.regReturn = ++pParse->nMem;
28885198ff57Sdrh     pExpr->y.sub.iAddr =
28895198ff57Sdrh       sqlite3VdbeAddOp2(v, OP_Integer, 0, pExpr->y.sub.regReturn) + 1;
28905198ff57Sdrh     VdbeComment((v, "return address"));
28915198ff57Sdrh 
28922c04131cSdrh     addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
2893fef5208cSdrh   }
2894fef5208cSdrh 
289585bcdce2Sdrh   /* For a SELECT, generate code to put the values for all columns of
289639a11819Sdrh   ** the first row into an array of registers and return the index of
289739a11819Sdrh   ** the first register.
289839a11819Sdrh   **
289939a11819Sdrh   ** If this is an EXISTS, write an integer 0 (not exists) or 1 (exists)
290039a11819Sdrh   ** into a register and return that register number.
290139a11819Sdrh   **
290239a11819Sdrh   ** In both cases, the query is augmented with "LIMIT 1".  Any
290339a11819Sdrh   ** preexisting limit is discarded in place of the new LIMIT 1.
2904fef5208cSdrh   */
2905bd462bccSdrh   ExplainQueryPlan((pParse, 1, "%sSCALAR SUBQUERY %d",
2906bd462bccSdrh         addrOnce?"":"CORRELATED ", pSel->selId));
290771c57db0Sdan   nReg = pExpr->op==TK_SELECT ? pSel->pEList->nExpr : 1;
290871c57db0Sdan   sqlite3SelectDestInit(&dest, 0, pParse->nMem+1);
290971c57db0Sdan   pParse->nMem += nReg;
291051522cd3Sdrh   if( pExpr->op==TK_SELECT ){
29116c8c8ce0Sdanielk1977     dest.eDest = SRT_Mem;
291253932ce8Sdrh     dest.iSdst = dest.iSDParm;
291371c57db0Sdan     dest.nSdst = nReg;
291471c57db0Sdan     sqlite3VdbeAddOp3(v, OP_Null, 0, dest.iSDParm, dest.iSDParm+nReg-1);
2915d4e70ebdSdrh     VdbeComment((v, "Init subquery result"));
291651522cd3Sdrh   }else{
29176c8c8ce0Sdanielk1977     dest.eDest = SRT_Exists;
29182b596da8Sdrh     sqlite3VdbeAddOp2(v, OP_Integer, 0, dest.iSDParm);
2919d4e70ebdSdrh     VdbeComment((v, "Init EXISTS result"));
292051522cd3Sdrh   }
29218c0833fbSdrh   pLimit = sqlite3ExprAlloc(pParse->db, TK_INTEGER,&sqlite3IntTokens[1], 0);
29228c0833fbSdrh   if( pSel->pLimit ){
29238c0833fbSdrh     sqlite3ExprDelete(pParse->db, pSel->pLimit->pLeft);
29248c0833fbSdrh     pSel->pLimit->pLeft = pLimit;
29258c0833fbSdrh   }else{
29268c0833fbSdrh     pSel->pLimit = sqlite3PExpr(pParse, TK_LIMIT, pLimit, 0);
29278c0833fbSdrh   }
292848b5b041Sdrh   pSel->iLimit = 0;
29297d10d5a6Sdrh   if( sqlite3Select(pParse, pSel, &dest) ){
29301450bc6eSdrh     return 0;
293194ccde58Sdrh   }
29322c04131cSdrh   pExpr->iTable = rReg = dest.iSDParm;
2933ebb6a65dSdrh   ExprSetVVAProperty(pExpr, EP_NoReduce);
29342c04131cSdrh   if( addrOnce ){
29352c04131cSdrh     sqlite3VdbeJumpHere(v, addrOnce);
2936fc976065Sdanielk1977 
29372c04131cSdrh     /* Subroutine return */
29382c04131cSdrh     sqlite3VdbeAddOp1(v, OP_Return, pExpr->y.sub.regReturn);
29392c04131cSdrh     sqlite3VdbeChangeP1(v, pExpr->y.sub.iAddr-1, sqlite3VdbeCurrentAddr(v)-1);
29405198ff57Sdrh   }
29412c04131cSdrh 
29421450bc6eSdrh   return rReg;
2943cce7d176Sdrh }
294451522cd3Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
2945cce7d176Sdrh 
2946e3365e6cSdrh #ifndef SQLITE_OMIT_SUBQUERY
2947e3365e6cSdrh /*
29487b35a77bSdan ** Expr pIn is an IN(...) expression. This function checks that the
29497b35a77bSdan ** sub-select on the RHS of the IN() operator has the same number of
29507b35a77bSdan ** columns as the vector on the LHS. Or, if the RHS of the IN() is not
29517b35a77bSdan ** a sub-query, that the LHS is a vector of size 1.
29527b35a77bSdan */
29537b35a77bSdan int sqlite3ExprCheckIN(Parse *pParse, Expr *pIn){
29547b35a77bSdan   int nVector = sqlite3ExprVectorSize(pIn->pLeft);
29557b35a77bSdan   if( (pIn->flags & EP_xIsSelect) ){
29567b35a77bSdan     if( nVector!=pIn->x.pSelect->pEList->nExpr ){
29577b35a77bSdan       sqlite3SubselectError(pParse, pIn->x.pSelect->pEList->nExpr, nVector);
29587b35a77bSdan       return 1;
29597b35a77bSdan     }
29607b35a77bSdan   }else if( nVector!=1 ){
296144c5604cSdan     sqlite3VectorErrorMsg(pParse, pIn->pLeft);
29627b35a77bSdan     return 1;
29637b35a77bSdan   }
29647b35a77bSdan   return 0;
29657b35a77bSdan }
29667b35a77bSdan #endif
29677b35a77bSdan 
29687b35a77bSdan #ifndef SQLITE_OMIT_SUBQUERY
29697b35a77bSdan /*
2970e3365e6cSdrh ** Generate code for an IN expression.
2971e3365e6cSdrh **
2972e3365e6cSdrh **      x IN (SELECT ...)
2973e3365e6cSdrh **      x IN (value, value, ...)
2974e3365e6cSdrh **
2975ecb87ac8Sdrh ** The left-hand side (LHS) is a scalar or vector expression.  The
2976e347d3e8Sdrh ** right-hand side (RHS) is an array of zero or more scalar values, or a
2977e347d3e8Sdrh ** subquery.  If the RHS is a subquery, the number of result columns must
2978e347d3e8Sdrh ** match the number of columns in the vector on the LHS.  If the RHS is
2979e347d3e8Sdrh ** a list of values, the LHS must be a scalar.
2980e347d3e8Sdrh **
2981e347d3e8Sdrh ** The IN operator is true if the LHS value is contained within the RHS.
2982e347d3e8Sdrh ** The result is false if the LHS is definitely not in the RHS.  The
2983e347d3e8Sdrh ** result is NULL if the presence of the LHS in the RHS cannot be
2984e347d3e8Sdrh ** determined due to NULLs.
2985e3365e6cSdrh **
29866be515ebSdrh ** This routine generates code that jumps to destIfFalse if the LHS is not
2987e3365e6cSdrh ** contained within the RHS.  If due to NULLs we cannot determine if the LHS
2988e3365e6cSdrh ** is contained in the RHS then jump to destIfNull.  If the LHS is contained
2989e3365e6cSdrh ** within the RHS then fall through.
2990ecb87ac8Sdrh **
2991ecb87ac8Sdrh ** See the separate in-operator.md documentation file in the canonical
2992ecb87ac8Sdrh ** SQLite source tree for additional information.
2993e3365e6cSdrh */
2994e3365e6cSdrh static void sqlite3ExprCodeIN(
2995e3365e6cSdrh   Parse *pParse,        /* Parsing and code generating context */
2996e3365e6cSdrh   Expr *pExpr,          /* The IN expression */
2997e3365e6cSdrh   int destIfFalse,      /* Jump here if LHS is not contained in the RHS */
2998e3365e6cSdrh   int destIfNull        /* Jump here if the results are unknown due to NULLs */
2999e3365e6cSdrh ){
3000e3365e6cSdrh   int rRhsHasNull = 0;  /* Register that is true if RHS contains NULL values */
3001e3365e6cSdrh   int eType;            /* Type of the RHS */
3002e347d3e8Sdrh   int rLhs;             /* Register(s) holding the LHS values */
3003e347d3e8Sdrh   int rLhsOrig;         /* LHS values prior to reordering by aiMap[] */
3004e3365e6cSdrh   Vdbe *v;              /* Statement under construction */
3005ba00e30aSdan   int *aiMap = 0;       /* Map from vector field to index column */
3006ba00e30aSdan   char *zAff = 0;       /* Affinity string for comparisons */
3007ecb87ac8Sdrh   int nVector;          /* Size of vectors for this IN operator */
300812abf408Sdrh   int iDummy;           /* Dummy parameter to exprCodeVector() */
3009e347d3e8Sdrh   Expr *pLeft;          /* The LHS of the IN operator */
3010ecb87ac8Sdrh   int i;                /* loop counter */
3011e347d3e8Sdrh   int destStep2;        /* Where to jump when NULLs seen in step 2 */
3012e347d3e8Sdrh   int destStep6 = 0;    /* Start of code for Step 6 */
3013e347d3e8Sdrh   int addrTruthOp;      /* Address of opcode that determines the IN is true */
3014e347d3e8Sdrh   int destNotNull;      /* Jump here if a comparison is not true in step 6 */
3015e347d3e8Sdrh   int addrTop;          /* Top of the step-6 loop */
30162c04131cSdrh   int iTab = 0;         /* Index to use */
3017e3365e6cSdrh 
3018e347d3e8Sdrh   pLeft = pExpr->pLeft;
30197b35a77bSdan   if( sqlite3ExprCheckIN(pParse, pExpr) ) return;
3020553168c7Sdan   zAff = exprINAffinity(pParse, pExpr);
3021ba00e30aSdan   nVector = sqlite3ExprVectorSize(pExpr->pLeft);
3022ba00e30aSdan   aiMap = (int*)sqlite3DbMallocZero(
3023ba00e30aSdan       pParse->db, nVector*(sizeof(int) + sizeof(char)) + 1
3024ba00e30aSdan   );
3025e347d3e8Sdrh   if( pParse->db->mallocFailed ) goto sqlite3ExprCodeIN_oom_error;
30267b35a77bSdan 
3027ba00e30aSdan   /* Attempt to compute the RHS. After this step, if anything other than
30282c04131cSdrh   ** IN_INDEX_NOOP is returned, the table opened with cursor iTab
3029ba00e30aSdan   ** contains the values that make up the RHS. If IN_INDEX_NOOP is returned,
3030ba00e30aSdan   ** the RHS has not yet been coded.  */
3031e3365e6cSdrh   v = pParse->pVdbe;
3032e3365e6cSdrh   assert( v!=0 );       /* OOM detected prior to this routine */
3033e3365e6cSdrh   VdbeNoopComment((v, "begin IN expr"));
3034bb53ecb1Sdrh   eType = sqlite3FindInIndex(pParse, pExpr,
3035bb53ecb1Sdrh                              IN_INDEX_MEMBERSHIP | IN_INDEX_NOOP_OK,
30362c04131cSdrh                              destIfFalse==destIfNull ? 0 : &rRhsHasNull,
30372c04131cSdrh                              aiMap, &iTab);
3038e3365e6cSdrh 
3039ba00e30aSdan   assert( pParse->nErr || nVector==1 || eType==IN_INDEX_EPH
3040ba00e30aSdan        || eType==IN_INDEX_INDEX_ASC || eType==IN_INDEX_INDEX_DESC
3041ba00e30aSdan   );
3042ecb87ac8Sdrh #ifdef SQLITE_DEBUG
3043ecb87ac8Sdrh   /* Confirm that aiMap[] contains nVector integer values between 0 and
3044ecb87ac8Sdrh   ** nVector-1. */
3045ecb87ac8Sdrh   for(i=0; i<nVector; i++){
3046ecb87ac8Sdrh     int j, cnt;
3047ecb87ac8Sdrh     for(cnt=j=0; j<nVector; j++) if( aiMap[j]==i ) cnt++;
3048ecb87ac8Sdrh     assert( cnt==1 );
3049ecb87ac8Sdrh   }
3050ecb87ac8Sdrh #endif
3051e3365e6cSdrh 
3052ba00e30aSdan   /* Code the LHS, the <expr> from "<expr> IN (...)". If the LHS is a
3053ba00e30aSdan   ** vector, then it is stored in an array of nVector registers starting
3054ba00e30aSdan   ** at r1.
3055e347d3e8Sdrh   **
3056e347d3e8Sdrh   ** sqlite3FindInIndex() might have reordered the fields of the LHS vector
3057e347d3e8Sdrh   ** so that the fields are in the same order as an existing index.   The
3058e347d3e8Sdrh   ** aiMap[] array contains a mapping from the original LHS field order to
3059e347d3e8Sdrh   ** the field order that matches the RHS index.
3060e3365e6cSdrh   */
3061e347d3e8Sdrh   rLhsOrig = exprCodeVector(pParse, pLeft, &iDummy);
3062e347d3e8Sdrh   for(i=0; i<nVector && aiMap[i]==i; i++){} /* Are LHS fields reordered? */
3063ecb87ac8Sdrh   if( i==nVector ){
3064e347d3e8Sdrh     /* LHS fields are not reordered */
3065e347d3e8Sdrh     rLhs = rLhsOrig;
3066ecb87ac8Sdrh   }else{
3067ecb87ac8Sdrh     /* Need to reorder the LHS fields according to aiMap */
3068e347d3e8Sdrh     rLhs = sqlite3GetTempRange(pParse, nVector);
3069ba00e30aSdan     for(i=0; i<nVector; i++){
3070e347d3e8Sdrh       sqlite3VdbeAddOp3(v, OP_Copy, rLhsOrig+i, rLhs+aiMap[i], 0);
3071ba00e30aSdan     }
3072ecb87ac8Sdrh   }
3073e3365e6cSdrh 
3074bb53ecb1Sdrh   /* If sqlite3FindInIndex() did not find or create an index that is
3075bb53ecb1Sdrh   ** suitable for evaluating the IN operator, then evaluate using a
3076bb53ecb1Sdrh   ** sequence of comparisons.
3077e347d3e8Sdrh   **
3078e347d3e8Sdrh   ** This is step (1) in the in-operator.md optimized algorithm.
3079bb53ecb1Sdrh   */
3080bb53ecb1Sdrh   if( eType==IN_INDEX_NOOP ){
3081bb53ecb1Sdrh     ExprList *pList = pExpr->x.pList;
3082bb53ecb1Sdrh     CollSeq *pColl = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
3083ec4ccdbcSdrh     int labelOk = sqlite3VdbeMakeLabel(pParse);
3084bb53ecb1Sdrh     int r2, regToFree;
3085bb53ecb1Sdrh     int regCkNull = 0;
3086bb53ecb1Sdrh     int ii;
3087bb53ecb1Sdrh     assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
3088bb53ecb1Sdrh     if( destIfNull!=destIfFalse ){
3089bb53ecb1Sdrh       regCkNull = sqlite3GetTempReg(pParse);
3090e347d3e8Sdrh       sqlite3VdbeAddOp3(v, OP_BitAnd, rLhs, rLhs, regCkNull);
3091bb53ecb1Sdrh     }
3092bb53ecb1Sdrh     for(ii=0; ii<pList->nExpr; ii++){
3093bb53ecb1Sdrh       r2 = sqlite3ExprCodeTemp(pParse, pList->a[ii].pExpr, &regToFree);
3094a976979bSdrh       if( regCkNull && sqlite3ExprCanBeNull(pList->a[ii].pExpr) ){
3095bb53ecb1Sdrh         sqlite3VdbeAddOp3(v, OP_BitAnd, regCkNull, r2, regCkNull);
3096bb53ecb1Sdrh       }
3097bb53ecb1Sdrh       if( ii<pList->nExpr-1 || destIfNull!=destIfFalse ){
3098e347d3e8Sdrh         sqlite3VdbeAddOp4(v, OP_Eq, rLhs, labelOk, r2,
30994336b0e6Sdrh                           (void*)pColl, P4_COLLSEQ);
31004336b0e6Sdrh         VdbeCoverageIf(v, ii<pList->nExpr-1);
31014336b0e6Sdrh         VdbeCoverageIf(v, ii==pList->nExpr-1);
3102ba00e30aSdan         sqlite3VdbeChangeP5(v, zAff[0]);
3103bb53ecb1Sdrh       }else{
3104bb53ecb1Sdrh         assert( destIfNull==destIfFalse );
3105e347d3e8Sdrh         sqlite3VdbeAddOp4(v, OP_Ne, rLhs, destIfFalse, r2,
3106bb53ecb1Sdrh                           (void*)pColl, P4_COLLSEQ); VdbeCoverage(v);
3107ba00e30aSdan         sqlite3VdbeChangeP5(v, zAff[0] | SQLITE_JUMPIFNULL);
3108bb53ecb1Sdrh       }
3109bb53ecb1Sdrh       sqlite3ReleaseTempReg(pParse, regToFree);
3110bb53ecb1Sdrh     }
3111bb53ecb1Sdrh     if( regCkNull ){
3112bb53ecb1Sdrh       sqlite3VdbeAddOp2(v, OP_IsNull, regCkNull, destIfNull); VdbeCoverage(v);
3113076e85f5Sdrh       sqlite3VdbeGoto(v, destIfFalse);
3114bb53ecb1Sdrh     }
3115bb53ecb1Sdrh     sqlite3VdbeResolveLabel(v, labelOk);
3116bb53ecb1Sdrh     sqlite3ReleaseTempReg(pParse, regCkNull);
3117e347d3e8Sdrh     goto sqlite3ExprCodeIN_finished;
3118e347d3e8Sdrh   }
3119bb53ecb1Sdrh 
3120e347d3e8Sdrh   /* Step 2: Check to see if the LHS contains any NULL columns.  If the
3121e347d3e8Sdrh   ** LHS does contain NULLs then the result must be either FALSE or NULL.
3122e347d3e8Sdrh   ** We will then skip the binary search of the RHS.
3123e347d3e8Sdrh   */
3124094430ebSdrh   if( destIfNull==destIfFalse ){
3125e347d3e8Sdrh     destStep2 = destIfFalse;
3126e347d3e8Sdrh   }else{
3127ec4ccdbcSdrh     destStep2 = destStep6 = sqlite3VdbeMakeLabel(pParse);
3128e347d3e8Sdrh   }
3129d49fd4e8Sdan   for(i=0; i<nVector; i++){
3130fc7f27b9Sdrh     Expr *p = sqlite3VectorFieldSubexpr(pExpr->pLeft, i);
3131d49fd4e8Sdan     if( sqlite3ExprCanBeNull(p) ){
3132e347d3e8Sdrh       sqlite3VdbeAddOp2(v, OP_IsNull, rLhs+i, destStep2);
3133471b4b92Sdrh       VdbeCoverage(v);
3134d49fd4e8Sdan     }
3135d49fd4e8Sdan   }
3136e3365e6cSdrh 
3137e347d3e8Sdrh   /* Step 3.  The LHS is now known to be non-NULL.  Do the binary search
3138e347d3e8Sdrh   ** of the RHS using the LHS as a probe.  If found, the result is
3139e347d3e8Sdrh   ** true.
3140e347d3e8Sdrh   */
3141e3365e6cSdrh   if( eType==IN_INDEX_ROWID ){
3142e347d3e8Sdrh     /* In this case, the RHS is the ROWID of table b-tree and so we also
3143e347d3e8Sdrh     ** know that the RHS is non-NULL.  Hence, we combine steps 3 and 4
3144e347d3e8Sdrh     ** into a single opcode. */
31452c04131cSdrh     sqlite3VdbeAddOp3(v, OP_SeekRowid, iTab, destIfFalse, rLhs);
3146688852abSdrh     VdbeCoverage(v);
3147e347d3e8Sdrh     addrTruthOp = sqlite3VdbeAddOp0(v, OP_Goto);  /* Return True */
31487b35a77bSdan   }else{
3149e347d3e8Sdrh     sqlite3VdbeAddOp4(v, OP_Affinity, rLhs, nVector, 0, zAff, nVector);
3150e347d3e8Sdrh     if( destIfFalse==destIfNull ){
3151e347d3e8Sdrh       /* Combine Step 3 and Step 5 into a single opcode */
31522c04131cSdrh       sqlite3VdbeAddOp4Int(v, OP_NotFound, iTab, destIfFalse,
3153e347d3e8Sdrh                            rLhs, nVector); VdbeCoverage(v);
3154e347d3e8Sdrh       goto sqlite3ExprCodeIN_finished;
3155e347d3e8Sdrh     }
3156e347d3e8Sdrh     /* Ordinary Step 3, for the case where FALSE and NULL are distinct */
31572c04131cSdrh     addrTruthOp = sqlite3VdbeAddOp4Int(v, OP_Found, iTab, 0,
3158e347d3e8Sdrh                                       rLhs, nVector); VdbeCoverage(v);
3159e347d3e8Sdrh   }
3160ba00e30aSdan 
3161e347d3e8Sdrh   /* Step 4.  If the RHS is known to be non-NULL and we did not find
3162e347d3e8Sdrh   ** an match on the search above, then the result must be FALSE.
3163e347d3e8Sdrh   */
3164e347d3e8Sdrh   if( rRhsHasNull && nVector==1 ){
3165e347d3e8Sdrh     sqlite3VdbeAddOp2(v, OP_NotNull, rRhsHasNull, destIfFalse);
3166471b4b92Sdrh     VdbeCoverage(v);
3167e347d3e8Sdrh   }
31687b35a77bSdan 
3169e347d3e8Sdrh   /* Step 5.  If we do not care about the difference between NULL and
3170e347d3e8Sdrh   ** FALSE, then just return false.
3171e347d3e8Sdrh   */
3172e347d3e8Sdrh   if( destIfFalse==destIfNull ) sqlite3VdbeGoto(v, destIfFalse);
3173e347d3e8Sdrh 
3174e347d3e8Sdrh   /* Step 6: Loop through rows of the RHS.  Compare each row to the LHS.
3175e347d3e8Sdrh   ** If any comparison is NULL, then the result is NULL.  If all
3176e347d3e8Sdrh   ** comparisons are FALSE then the final result is FALSE.
3177e347d3e8Sdrh   **
3178e347d3e8Sdrh   ** For a scalar LHS, it is sufficient to check just the first row
3179e347d3e8Sdrh   ** of the RHS.
3180e347d3e8Sdrh   */
3181e347d3e8Sdrh   if( destStep6 ) sqlite3VdbeResolveLabel(v, destStep6);
31822c04131cSdrh   addrTop = sqlite3VdbeAddOp2(v, OP_Rewind, iTab, destIfFalse);
3183471b4b92Sdrh   VdbeCoverage(v);
3184e347d3e8Sdrh   if( nVector>1 ){
3185ec4ccdbcSdrh     destNotNull = sqlite3VdbeMakeLabel(pParse);
3186e347d3e8Sdrh   }else{
3187e347d3e8Sdrh     /* For nVector==1, combine steps 6 and 7 by immediately returning
3188e347d3e8Sdrh     ** FALSE if the first comparison is not NULL */
3189e347d3e8Sdrh     destNotNull = destIfFalse;
3190e347d3e8Sdrh   }
3191ba00e30aSdan   for(i=0; i<nVector; i++){
3192ba00e30aSdan     Expr *p;
3193ba00e30aSdan     CollSeq *pColl;
3194e347d3e8Sdrh     int r3 = sqlite3GetTempReg(pParse);
3195fc7f27b9Sdrh     p = sqlite3VectorFieldSubexpr(pLeft, i);
3196ba00e30aSdan     pColl = sqlite3ExprCollSeq(pParse, p);
31972c04131cSdrh     sqlite3VdbeAddOp3(v, OP_Column, iTab, i, r3);
3198e347d3e8Sdrh     sqlite3VdbeAddOp4(v, OP_Ne, rLhs+i, destNotNull, r3,
319918016ad2Sdrh                       (void*)pColl, P4_COLLSEQ);
3200471b4b92Sdrh     VdbeCoverage(v);
3201e347d3e8Sdrh     sqlite3ReleaseTempReg(pParse, r3);
32027b35a77bSdan   }
32037b35a77bSdan   sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfNull);
3204e347d3e8Sdrh   if( nVector>1 ){
3205e347d3e8Sdrh     sqlite3VdbeResolveLabel(v, destNotNull);
32062c04131cSdrh     sqlite3VdbeAddOp2(v, OP_Next, iTab, addrTop+1);
320718016ad2Sdrh     VdbeCoverage(v);
3208e347d3e8Sdrh 
3209e347d3e8Sdrh     /* Step 7:  If we reach this point, we know that the result must
3210e347d3e8Sdrh     ** be false. */
321118016ad2Sdrh     sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfFalse);
32127b35a77bSdan   }
32137b35a77bSdan 
3214e347d3e8Sdrh   /* Jumps here in order to return true. */
3215e347d3e8Sdrh   sqlite3VdbeJumpHere(v, addrTruthOp);
3216e3365e6cSdrh 
3217e347d3e8Sdrh sqlite3ExprCodeIN_finished:
3218e347d3e8Sdrh   if( rLhs!=rLhsOrig ) sqlite3ReleaseTempReg(pParse, rLhs);
3219ecb87ac8Sdrh   VdbeComment((v, "end IN expr"));
3220e347d3e8Sdrh sqlite3ExprCodeIN_oom_error:
3221ba00e30aSdan   sqlite3DbFree(pParse->db, aiMap);
3222553168c7Sdan   sqlite3DbFree(pParse->db, zAff);
3223e3365e6cSdrh }
3224e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
3225e3365e6cSdrh 
322613573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
3227598f1340Sdrh /*
3228598f1340Sdrh ** Generate an instruction that will put the floating point
32299cbf3425Sdrh ** value described by z[0..n-1] into register iMem.
32300cf19ed8Sdrh **
32310cf19ed8Sdrh ** The z[] string will probably not be zero-terminated.  But the
32320cf19ed8Sdrh ** z[n] character is guaranteed to be something that does not look
32330cf19ed8Sdrh ** like the continuation of the number.
3234598f1340Sdrh */
3235b7916a78Sdrh static void codeReal(Vdbe *v, const char *z, int negateFlag, int iMem){
3236fd773cf9Sdrh   if( ALWAYS(z!=0) ){
3237598f1340Sdrh     double value;
32389339da1fSdrh     sqlite3AtoF(z, &value, sqlite3Strlen30(z), SQLITE_UTF8);
3239d0015161Sdrh     assert( !sqlite3IsNaN(value) ); /* The new AtoF never returns NaN */
3240598f1340Sdrh     if( negateFlag ) value = -value;
324197bae794Sdrh     sqlite3VdbeAddOp4Dup8(v, OP_Real, 0, iMem, 0, (u8*)&value, P4_REAL);
3242598f1340Sdrh   }
3243598f1340Sdrh }
324413573c71Sdrh #endif
3245598f1340Sdrh 
3246598f1340Sdrh 
3247598f1340Sdrh /*
3248fec19aadSdrh ** Generate an instruction that will put the integer describe by
32499cbf3425Sdrh ** text z[0..n-1] into register iMem.
32500cf19ed8Sdrh **
32515f1d6b61Sshaneh ** Expr.u.zToken is always UTF8 and zero-terminated.
3252fec19aadSdrh */
325313573c71Sdrh static void codeInteger(Parse *pParse, Expr *pExpr, int negFlag, int iMem){
325413573c71Sdrh   Vdbe *v = pParse->pVdbe;
325592b01d53Sdrh   if( pExpr->flags & EP_IntValue ){
325633e619fcSdrh     int i = pExpr->u.iValue;
3257d50ffc41Sdrh     assert( i>=0 );
325892b01d53Sdrh     if( negFlag ) i = -i;
325992b01d53Sdrh     sqlite3VdbeAddOp2(v, OP_Integer, i, iMem);
3260fd773cf9Sdrh   }else{
32615f1d6b61Sshaneh     int c;
32625f1d6b61Sshaneh     i64 value;
3263fd773cf9Sdrh     const char *z = pExpr->u.zToken;
3264fd773cf9Sdrh     assert( z!=0 );
32659296c18aSdrh     c = sqlite3DecOrHexToI64(z, &value);
326684d4f1a3Sdrh     if( (c==3 && !negFlag) || (c==2) || (negFlag && value==SMALLEST_INT64)){
326713573c71Sdrh #ifdef SQLITE_OMIT_FLOATING_POINT
326813573c71Sdrh       sqlite3ErrorMsg(pParse, "oversized integer: %s%s", negFlag ? "-" : "", z);
326913573c71Sdrh #else
32701b7ddc59Sdrh #ifndef SQLITE_OMIT_HEX_INTEGER
32719296c18aSdrh       if( sqlite3_strnicmp(z,"0x",2)==0 ){
327277320ea4Sdrh         sqlite3ErrorMsg(pParse, "hex literal too big: %s%s", negFlag?"-":"",z);
32731b7ddc59Sdrh       }else
32741b7ddc59Sdrh #endif
32751b7ddc59Sdrh       {
3276b7916a78Sdrh         codeReal(v, z, negFlag, iMem);
32779296c18aSdrh       }
327813573c71Sdrh #endif
327977320ea4Sdrh     }else{
328084d4f1a3Sdrh       if( negFlag ){ value = c==3 ? SMALLEST_INT64 : -value; }
328177320ea4Sdrh       sqlite3VdbeAddOp4Dup8(v, OP_Int64, 0, iMem, 0, (u8*)&value, P4_INT64);
3282fec19aadSdrh     }
3283fec19aadSdrh   }
3284c9cf901dSdanielk1977 }
3285fec19aadSdrh 
32865cd79239Sdrh 
32871f9ca2c8Sdrh /* Generate code that will load into register regOut a value that is
32881f9ca2c8Sdrh ** appropriate for the iIdxCol-th column of index pIdx.
32891f9ca2c8Sdrh */
32901f9ca2c8Sdrh void sqlite3ExprCodeLoadIndexColumn(
32911f9ca2c8Sdrh   Parse *pParse,  /* The parsing context */
32921f9ca2c8Sdrh   Index *pIdx,    /* The index whose column is to be loaded */
32931f9ca2c8Sdrh   int iTabCur,    /* Cursor pointing to a table row */
32941f9ca2c8Sdrh   int iIdxCol,    /* The column of the index to be loaded */
32951f9ca2c8Sdrh   int regOut      /* Store the index column value in this register */
32961f9ca2c8Sdrh ){
32971f9ca2c8Sdrh   i16 iTabCol = pIdx->aiColumn[iIdxCol];
32984b92f98cSdrh   if( iTabCol==XN_EXPR ){
32991f9ca2c8Sdrh     assert( pIdx->aColExpr );
33001f9ca2c8Sdrh     assert( pIdx->aColExpr->nExpr>iIdxCol );
33013e34eabcSdrh     pParse->iSelfTab = iTabCur + 1;
33021c75c9d7Sdrh     sqlite3ExprCodeCopy(pParse, pIdx->aColExpr->a[iIdxCol].pExpr, regOut);
33033e34eabcSdrh     pParse->iSelfTab = 0;
33044b92f98cSdrh   }else{
33054b92f98cSdrh     sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pIdx->pTable, iTabCur,
33064b92f98cSdrh                                     iTabCol, regOut);
33074b92f98cSdrh   }
33081f9ca2c8Sdrh }
33091f9ca2c8Sdrh 
33105cd79239Sdrh /*
33115c092e8aSdrh ** Generate code to extract the value of the iCol-th column of a table.
33125c092e8aSdrh */
33135c092e8aSdrh void sqlite3ExprCodeGetColumnOfTable(
33145c092e8aSdrh   Vdbe *v,        /* The VDBE under construction */
33155c092e8aSdrh   Table *pTab,    /* The table containing the value */
3316313619f5Sdrh   int iTabCur,    /* The table cursor.  Or the PK cursor for WITHOUT ROWID */
33175c092e8aSdrh   int iCol,       /* Index of the column to extract */
3318313619f5Sdrh   int regOut      /* Extract the value into this register */
33195c092e8aSdrh ){
3320aca19e19Sdrh   if( pTab==0 ){
3321aca19e19Sdrh     sqlite3VdbeAddOp3(v, OP_Column, iTabCur, iCol, regOut);
3322aca19e19Sdrh     return;
3323aca19e19Sdrh   }
33245c092e8aSdrh   if( iCol<0 || iCol==pTab->iPKey ){
33255c092e8aSdrh     sqlite3VdbeAddOp2(v, OP_Rowid, iTabCur, regOut);
33265c092e8aSdrh   }else{
33275c092e8aSdrh     int op = IsVirtual(pTab) ? OP_VColumn : OP_Column;
3328ee0ec8e1Sdrh     int x = iCol;
332935db31b2Sdrh     if( !HasRowid(pTab) && !IsVirtual(pTab) ){
3330ee0ec8e1Sdrh       x = sqlite3ColumnOfIndex(sqlite3PrimaryKeyIndex(pTab), iCol);
3331ee0ec8e1Sdrh     }
3332ee0ec8e1Sdrh     sqlite3VdbeAddOp3(v, op, iTabCur, x, regOut);
33335c092e8aSdrh   }
33345c092e8aSdrh   if( iCol>=0 ){
33355c092e8aSdrh     sqlite3ColumnDefault(v, pTab, iCol, regOut);
33365c092e8aSdrh   }
33375c092e8aSdrh }
33385c092e8aSdrh 
33395c092e8aSdrh /*
3340945498f3Sdrh ** Generate code that will extract the iColumn-th column from
33418c607191Sdrh ** table pTab and store the column value in register iReg.
3342e55cbd72Sdrh **
3343e55cbd72Sdrh ** There must be an open cursor to pTab in iTable when this routine
3344e55cbd72Sdrh ** is called.  If iColumn<0 then code is generated that extracts the rowid.
3345945498f3Sdrh */
3346e55cbd72Sdrh int sqlite3ExprCodeGetColumn(
3347e55cbd72Sdrh   Parse *pParse,   /* Parsing and code generating context */
33482133d822Sdrh   Table *pTab,     /* Description of the table we are reading from */
33492133d822Sdrh   int iColumn,     /* Index of the table column */
33502133d822Sdrh   int iTable,      /* The cursor pointing to the table */
3351a748fdccSdrh   int iReg,        /* Store results here */
3352ce78bc6eSdrh   u8 p5            /* P5 value for OP_Column + FLAGS */
33532133d822Sdrh ){
3354e55cbd72Sdrh   Vdbe *v = pParse->pVdbe;
3355e55cbd72Sdrh   assert( v!=0 );
33565c092e8aSdrh   sqlite3ExprCodeGetColumnOfTable(v, pTab, iTable, iColumn, iReg);
3357a748fdccSdrh   if( p5 ){
3358a748fdccSdrh     sqlite3VdbeChangeP5(v, p5);
3359a748fdccSdrh   }
3360e55cbd72Sdrh   return iReg;
3361e55cbd72Sdrh }
3362e55cbd72Sdrh 
3363e55cbd72Sdrh /*
3364b21e7c70Sdrh ** Generate code to move content from registers iFrom...iFrom+nReg-1
336536a5d88dSdrh ** over to iTo..iTo+nReg-1.
3366e55cbd72Sdrh */
3367b21e7c70Sdrh void sqlite3ExprCodeMove(Parse *pParse, int iFrom, int iTo, int nReg){
3368e8e4af76Sdrh   assert( iFrom>=iTo+nReg || iFrom+nReg<=iTo );
3369079a3072Sdrh   sqlite3VdbeAddOp3(pParse->pVdbe, OP_Move, iFrom, iTo, nReg);
3370945498f3Sdrh }
3371945498f3Sdrh 
3372652fbf55Sdrh /*
337312abf408Sdrh ** Convert a scalar expression node to a TK_REGISTER referencing
337412abf408Sdrh ** register iReg.  The caller must ensure that iReg already contains
337512abf408Sdrh ** the correct value for the expression.
3376a4c3c87eSdrh */
3377a4c3c87eSdrh static void exprToRegister(Expr *p, int iReg){
3378a4c3c87eSdrh   p->op2 = p->op;
3379a4c3c87eSdrh   p->op = TK_REGISTER;
3380a4c3c87eSdrh   p->iTable = iReg;
3381a4c3c87eSdrh   ExprClearProperty(p, EP_Skip);
3382a4c3c87eSdrh }
3383a4c3c87eSdrh 
338412abf408Sdrh /*
338512abf408Sdrh ** Evaluate an expression (either a vector or a scalar expression) and store
338612abf408Sdrh ** the result in continguous temporary registers.  Return the index of
338712abf408Sdrh ** the first register used to store the result.
338812abf408Sdrh **
338912abf408Sdrh ** If the returned result register is a temporary scalar, then also write
339012abf408Sdrh ** that register number into *piFreeable.  If the returned result register
339112abf408Sdrh ** is not a temporary or if the expression is a vector set *piFreeable
339212abf408Sdrh ** to 0.
339312abf408Sdrh */
339412abf408Sdrh static int exprCodeVector(Parse *pParse, Expr *p, int *piFreeable){
339512abf408Sdrh   int iResult;
339612abf408Sdrh   int nResult = sqlite3ExprVectorSize(p);
339712abf408Sdrh   if( nResult==1 ){
339812abf408Sdrh     iResult = sqlite3ExprCodeTemp(pParse, p, piFreeable);
339912abf408Sdrh   }else{
340012abf408Sdrh     *piFreeable = 0;
340112abf408Sdrh     if( p->op==TK_SELECT ){
3402dd1bb43aSdrh #if SQLITE_OMIT_SUBQUERY
3403dd1bb43aSdrh       iResult = 0;
3404dd1bb43aSdrh #else
340585bcdce2Sdrh       iResult = sqlite3CodeSubselect(pParse, p);
3406dd1bb43aSdrh #endif
340712abf408Sdrh     }else{
340812abf408Sdrh       int i;
340912abf408Sdrh       iResult = pParse->nMem+1;
341012abf408Sdrh       pParse->nMem += nResult;
341112abf408Sdrh       for(i=0; i<nResult; i++){
34124b725240Sdan         sqlite3ExprCodeFactorable(pParse, p->x.pList->a[i].pExpr, i+iResult);
341312abf408Sdrh       }
341412abf408Sdrh     }
341512abf408Sdrh   }
341612abf408Sdrh   return iResult;
341712abf408Sdrh }
341812abf408Sdrh 
341971c57db0Sdan 
3420a4c3c87eSdrh /*
3421cce7d176Sdrh ** Generate code into the current Vdbe to evaluate the given
34222dcef11bSdrh ** expression.  Attempt to store the results in register "target".
34232dcef11bSdrh ** Return the register where results are stored.
3424389a1adbSdrh **
34258b213899Sdrh ** With this routine, there is no guarantee that results will
34262dcef11bSdrh ** be stored in target.  The result might be stored in some other
34272dcef11bSdrh ** register if it is convenient to do so.  The calling function
34282dcef11bSdrh ** must check the return code and move the results to the desired
34292dcef11bSdrh ** register.
3430cce7d176Sdrh */
3431678ccce8Sdrh int sqlite3ExprCodeTarget(Parse *pParse, Expr *pExpr, int target){
34322dcef11bSdrh   Vdbe *v = pParse->pVdbe;  /* The VM under construction */
34332dcef11bSdrh   int op;                   /* The opcode being coded */
34342dcef11bSdrh   int inReg = target;       /* Results stored in register inReg */
34352dcef11bSdrh   int regFree1 = 0;         /* If non-zero free this temporary register */
34362dcef11bSdrh   int regFree2 = 0;         /* If non-zero free this temporary register */
34377b35a77bSdan   int r1, r2;               /* Various register numbers */
343810d1edf0Sdrh   Expr tempX;               /* Temporary expression node */
343971c57db0Sdan   int p5 = 0;
3440ffe07b2dSdrh 
34419cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
344220411ea7Sdrh   if( v==0 ){
344320411ea7Sdrh     assert( pParse->db->mallocFailed );
344420411ea7Sdrh     return 0;
344520411ea7Sdrh   }
3446389a1adbSdrh 
34471efa8023Sdrh expr_code_doover:
3448389a1adbSdrh   if( pExpr==0 ){
3449389a1adbSdrh     op = TK_NULL;
3450389a1adbSdrh   }else{
3451f2bc013cSdrh     op = pExpr->op;
3452389a1adbSdrh   }
3453f2bc013cSdrh   switch( op ){
345413449892Sdrh     case TK_AGG_COLUMN: {
345513449892Sdrh       AggInfo *pAggInfo = pExpr->pAggInfo;
345613449892Sdrh       struct AggInfo_col *pCol = &pAggInfo->aCol[pExpr->iAgg];
345713449892Sdrh       if( !pAggInfo->directMode ){
34589de221dfSdrh         assert( pCol->iMem>0 );
3459c332cc30Sdrh         return pCol->iMem;
346013449892Sdrh       }else if( pAggInfo->useSortingIdx ){
34615134d135Sdan         sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdxPTab,
3462389a1adbSdrh                               pCol->iSorterColumn, target);
3463c332cc30Sdrh         return target;
346413449892Sdrh       }
346513449892Sdrh       /* Otherwise, fall thru into the TK_COLUMN case */
346613449892Sdrh     }
3467967e8b73Sdrh     case TK_COLUMN: {
3468b2b9d3d7Sdrh       int iTab = pExpr->iTable;
3469efad2e23Sdrh       if( ExprHasProperty(pExpr, EP_FixedCol) ){
3470d98f5324Sdrh         /* This COLUMN expression is really a constant due to WHERE clause
3471d98f5324Sdrh         ** constraints, and that constant is coded by the pExpr->pLeft
3472d98f5324Sdrh         ** expresssion.  However, make sure the constant has the correct
3473d98f5324Sdrh         ** datatype by applying the Affinity of the table column to the
3474d98f5324Sdrh         ** constant.
3475d98f5324Sdrh         */
3476d98f5324Sdrh         int iReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft,target);
3477eda079cdSdrh         int aff = sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
3478d98f5324Sdrh         if( aff!=SQLITE_AFF_BLOB ){
3479d98f5324Sdrh           static const char zAff[] = "B\000C\000D\000E";
3480d98f5324Sdrh           assert( SQLITE_AFF_BLOB=='A' );
3481d98f5324Sdrh           assert( SQLITE_AFF_TEXT=='B' );
3482d98f5324Sdrh           if( iReg!=target ){
3483d98f5324Sdrh             sqlite3VdbeAddOp2(v, OP_SCopy, iReg, target);
3484d98f5324Sdrh             iReg = target;
3485d98f5324Sdrh           }
3486d98f5324Sdrh           sqlite3VdbeAddOp4(v, OP_Affinity, iReg, 1, 0,
3487d98f5324Sdrh                             &zAff[(aff-'B')*2], P4_STATIC);
3488d98f5324Sdrh         }
3489d98f5324Sdrh         return iReg;
3490efad2e23Sdrh       }
3491b2b9d3d7Sdrh       if( iTab<0 ){
34926e97f8ecSdrh         if( pParse->iSelfTab<0 ){
3493b2b9d3d7Sdrh           /* Generating CHECK constraints or inserting into partial index */
34946e97f8ecSdrh           return pExpr->iColumn - pParse->iSelfTab;
3495c4a3c779Sdrh         }else{
34961f9ca2c8Sdrh           /* Coding an expression that is part of an index where column names
34971f9ca2c8Sdrh           ** in the index refer to the table to which the index belongs */
34983e34eabcSdrh           iTab = pParse->iSelfTab - 1;
34992282792aSdrh         }
3500b2b9d3d7Sdrh       }
3501eda079cdSdrh       return sqlite3ExprCodeGetColumn(pParse, pExpr->y.pTab,
3502b2b9d3d7Sdrh                                pExpr->iColumn, iTab, target,
3503b2b9d3d7Sdrh                                pExpr->op2);
3504cce7d176Sdrh     }
3505cce7d176Sdrh     case TK_INTEGER: {
350613573c71Sdrh       codeInteger(pParse, pExpr, 0, target);
3507c332cc30Sdrh       return target;
350851e9a445Sdrh     }
35098abed7b9Sdrh     case TK_TRUEFALSE: {
351096acafbeSdrh       sqlite3VdbeAddOp2(v, OP_Integer, sqlite3ExprTruthValue(pExpr), target);
3511007c843bSdrh       return target;
3512007c843bSdrh     }
351313573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
3514598f1340Sdrh     case TK_FLOAT: {
351533e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
351633e619fcSdrh       codeReal(v, pExpr->u.zToken, 0, target);
3517c332cc30Sdrh       return target;
3518598f1340Sdrh     }
351913573c71Sdrh #endif
3520fec19aadSdrh     case TK_STRING: {
352133e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
3522076e85f5Sdrh       sqlite3VdbeLoadString(v, target, pExpr->u.zToken);
3523c332cc30Sdrh       return target;
3524cce7d176Sdrh     }
3525f0863fe5Sdrh     case TK_NULL: {
35269de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3527c332cc30Sdrh       return target;
3528f0863fe5Sdrh     }
35295338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_BLOB_LITERAL
3530c572ef7fSdanielk1977     case TK_BLOB: {
35316c8c6cecSdrh       int n;
35326c8c6cecSdrh       const char *z;
3533ca48c90fSdrh       char *zBlob;
353433e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
353533e619fcSdrh       assert( pExpr->u.zToken[0]=='x' || pExpr->u.zToken[0]=='X' );
353633e619fcSdrh       assert( pExpr->u.zToken[1]=='\'' );
353733e619fcSdrh       z = &pExpr->u.zToken[2];
3538b7916a78Sdrh       n = sqlite3Strlen30(z) - 1;
3539b7916a78Sdrh       assert( z[n]=='\'' );
3540ca48c90fSdrh       zBlob = sqlite3HexToBlob(sqlite3VdbeDb(v), z, n);
3541ca48c90fSdrh       sqlite3VdbeAddOp4(v, OP_Blob, n/2, target, 0, zBlob, P4_DYNAMIC);
3542c332cc30Sdrh       return target;
3543c572ef7fSdanielk1977     }
35445338a5f7Sdanielk1977 #endif
354550457896Sdrh     case TK_VARIABLE: {
354633e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
354733e619fcSdrh       assert( pExpr->u.zToken!=0 );
354833e619fcSdrh       assert( pExpr->u.zToken[0]!=0 );
3549eaf52d88Sdrh       sqlite3VdbeAddOp2(v, OP_Variable, pExpr->iColumn, target);
355033e619fcSdrh       if( pExpr->u.zToken[1]!=0 ){
35519bf755ccSdrh         const char *z = sqlite3VListNumToName(pParse->pVList, pExpr->iColumn);
35529bf755ccSdrh         assert( pExpr->u.zToken[0]=='?' || strcmp(pExpr->u.zToken, z)==0 );
3553ce1bbe51Sdrh         pParse->pVList[0] = 0; /* Indicate VList may no longer be enlarged */
35549bf755ccSdrh         sqlite3VdbeAppendP4(v, (char*)z, P4_STATIC);
35559bf755ccSdrh       }
3556c332cc30Sdrh       return target;
355750457896Sdrh     }
35584e0cff60Sdrh     case TK_REGISTER: {
3559c332cc30Sdrh       return pExpr->iTable;
35604e0cff60Sdrh     }
3561487e262fSdrh #ifndef SQLITE_OMIT_CAST
3562487e262fSdrh     case TK_CAST: {
3563487e262fSdrh       /* Expressions of the form:   CAST(pLeft AS token) */
35642dcef11bSdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
35651735fa88Sdrh       if( inReg!=target ){
35661735fa88Sdrh         sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
35671735fa88Sdrh         inReg = target;
35681735fa88Sdrh       }
35694169e430Sdrh       sqlite3VdbeAddOp2(v, OP_Cast, target,
35704169e430Sdrh                         sqlite3AffinityType(pExpr->u.zToken, 0));
3571c332cc30Sdrh       return inReg;
3572487e262fSdrh     }
3573487e262fSdrh #endif /* SQLITE_OMIT_CAST */
357471c57db0Sdan     case TK_IS:
357571c57db0Sdan     case TK_ISNOT:
357671c57db0Sdan       op = (op==TK_IS) ? TK_EQ : TK_NE;
357771c57db0Sdan       p5 = SQLITE_NULLEQ;
357871c57db0Sdan       /* fall-through */
3579c9b84a1fSdrh     case TK_LT:
3580c9b84a1fSdrh     case TK_LE:
3581c9b84a1fSdrh     case TK_GT:
3582c9b84a1fSdrh     case TK_GE:
3583c9b84a1fSdrh     case TK_NE:
3584c9b84a1fSdrh     case TK_EQ: {
358571c57db0Sdan       Expr *pLeft = pExpr->pLeft;
3586625015e0Sdan       if( sqlite3ExprIsVector(pLeft) ){
358779752b6eSdrh         codeVectorCompare(pParse, pExpr, target, op, p5);
358871c57db0Sdan       }else{
358971c57db0Sdan         r1 = sqlite3ExprCodeTemp(pParse, pLeft, &regFree1);
3590b6da74ebSdrh         r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
359171c57db0Sdan         codeCompare(pParse, pLeft, pExpr->pRight, op,
359271c57db0Sdan             r1, r2, inReg, SQLITE_STOREP2 | p5);
35937d176105Sdrh         assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
35947d176105Sdrh         assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
35957d176105Sdrh         assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
35967d176105Sdrh         assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
35977d176105Sdrh         assert(TK_EQ==OP_Eq); testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
35987d176105Sdrh         assert(TK_NE==OP_Ne); testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
3599c5499befSdrh         testcase( regFree1==0 );
3600c5499befSdrh         testcase( regFree2==0 );
3601c9b84a1fSdrh       }
36026a2fe093Sdrh       break;
36036a2fe093Sdrh     }
3604cce7d176Sdrh     case TK_AND:
3605cce7d176Sdrh     case TK_OR:
3606cce7d176Sdrh     case TK_PLUS:
3607cce7d176Sdrh     case TK_STAR:
3608cce7d176Sdrh     case TK_MINUS:
3609bf4133cbSdrh     case TK_REM:
3610bf4133cbSdrh     case TK_BITAND:
3611bf4133cbSdrh     case TK_BITOR:
361217c40294Sdrh     case TK_SLASH:
3613bf4133cbSdrh     case TK_LSHIFT:
3614855eb1cfSdrh     case TK_RSHIFT:
36150040077dSdrh     case TK_CONCAT: {
36167d176105Sdrh       assert( TK_AND==OP_And );            testcase( op==TK_AND );
36177d176105Sdrh       assert( TK_OR==OP_Or );              testcase( op==TK_OR );
36187d176105Sdrh       assert( TK_PLUS==OP_Add );           testcase( op==TK_PLUS );
36197d176105Sdrh       assert( TK_MINUS==OP_Subtract );     testcase( op==TK_MINUS );
36207d176105Sdrh       assert( TK_REM==OP_Remainder );      testcase( op==TK_REM );
36217d176105Sdrh       assert( TK_BITAND==OP_BitAnd );      testcase( op==TK_BITAND );
36227d176105Sdrh       assert( TK_BITOR==OP_BitOr );        testcase( op==TK_BITOR );
36237d176105Sdrh       assert( TK_SLASH==OP_Divide );       testcase( op==TK_SLASH );
36247d176105Sdrh       assert( TK_LSHIFT==OP_ShiftLeft );   testcase( op==TK_LSHIFT );
36257d176105Sdrh       assert( TK_RSHIFT==OP_ShiftRight );  testcase( op==TK_RSHIFT );
36267d176105Sdrh       assert( TK_CONCAT==OP_Concat );      testcase( op==TK_CONCAT );
36272dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
36282dcef11bSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
36295b6afba9Sdrh       sqlite3VdbeAddOp3(v, op, r2, r1, target);
3630c5499befSdrh       testcase( regFree1==0 );
3631c5499befSdrh       testcase( regFree2==0 );
36320040077dSdrh       break;
36330040077dSdrh     }
3634cce7d176Sdrh     case TK_UMINUS: {
3635fec19aadSdrh       Expr *pLeft = pExpr->pLeft;
3636fec19aadSdrh       assert( pLeft );
363713573c71Sdrh       if( pLeft->op==TK_INTEGER ){
363813573c71Sdrh         codeInteger(pParse, pLeft, 1, target);
3639c332cc30Sdrh         return target;
364013573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
364113573c71Sdrh       }else if( pLeft->op==TK_FLOAT ){
364233e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
364333e619fcSdrh         codeReal(v, pLeft->u.zToken, 1, target);
3644c332cc30Sdrh         return target;
364513573c71Sdrh #endif
36463c84ddffSdrh       }else{
364710d1edf0Sdrh         tempX.op = TK_INTEGER;
364810d1edf0Sdrh         tempX.flags = EP_IntValue|EP_TokenOnly;
364910d1edf0Sdrh         tempX.u.iValue = 0;
365010d1edf0Sdrh         r1 = sqlite3ExprCodeTemp(pParse, &tempX, &regFree1);
3651e55cbd72Sdrh         r2 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree2);
36522dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_Subtract, r2, r1, target);
3653c5499befSdrh         testcase( regFree2==0 );
36543c84ddffSdrh       }
36556e142f54Sdrh       break;
36566e142f54Sdrh     }
3657bf4133cbSdrh     case TK_BITNOT:
36586e142f54Sdrh     case TK_NOT: {
36597d176105Sdrh       assert( TK_BITNOT==OP_BitNot );   testcase( op==TK_BITNOT );
36607d176105Sdrh       assert( TK_NOT==OP_Not );         testcase( op==TK_NOT );
3661e99fa2afSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3662e99fa2afSdrh       testcase( regFree1==0 );
3663e99fa2afSdrh       sqlite3VdbeAddOp2(v, op, r1, inReg);
3664cce7d176Sdrh       break;
3665cce7d176Sdrh     }
36668abed7b9Sdrh     case TK_TRUTH: {
366796acafbeSdrh       int isTrue;    /* IS TRUE or IS NOT TRUE */
366896acafbeSdrh       int bNormal;   /* IS TRUE or IS FALSE */
3669007c843bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3670007c843bSdrh       testcase( regFree1==0 );
367196acafbeSdrh       isTrue = sqlite3ExprTruthValue(pExpr->pRight);
367296acafbeSdrh       bNormal = pExpr->op2==TK_IS;
367396acafbeSdrh       testcase( isTrue && bNormal);
367496acafbeSdrh       testcase( !isTrue && bNormal);
367596acafbeSdrh       sqlite3VdbeAddOp4Int(v, OP_IsTrue, r1, inReg, !isTrue, isTrue ^ bNormal);
3676007c843bSdrh       break;
3677007c843bSdrh     }
3678cce7d176Sdrh     case TK_ISNULL:
3679cce7d176Sdrh     case TK_NOTNULL: {
36806a288a33Sdrh       int addr;
36817d176105Sdrh       assert( TK_ISNULL==OP_IsNull );   testcase( op==TK_ISNULL );
36827d176105Sdrh       assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
36839de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
36842dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3685c5499befSdrh       testcase( regFree1==0 );
36862dcef11bSdrh       addr = sqlite3VdbeAddOp1(v, op, r1);
36877d176105Sdrh       VdbeCoverageIf(v, op==TK_ISNULL);
36887d176105Sdrh       VdbeCoverageIf(v, op==TK_NOTNULL);
3689a976979bSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 0, target);
36906a288a33Sdrh       sqlite3VdbeJumpHere(v, addr);
3691a37cdde0Sdanielk1977       break;
3692f2bc013cSdrh     }
36932282792aSdrh     case TK_AGG_FUNCTION: {
369413449892Sdrh       AggInfo *pInfo = pExpr->pAggInfo;
36957e56e711Sdrh       if( pInfo==0 ){
369633e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
369733e619fcSdrh         sqlite3ErrorMsg(pParse, "misuse of aggregate: %s()", pExpr->u.zToken);
36987e56e711Sdrh       }else{
3699c332cc30Sdrh         return pInfo->aFunc[pExpr->iAgg].iMem;
37007e56e711Sdrh       }
37012282792aSdrh       break;
37022282792aSdrh     }
3703cce7d176Sdrh     case TK_FUNCTION: {
370412ffee8cSdrh       ExprList *pFarg;       /* List of function arguments */
370512ffee8cSdrh       int nFarg;             /* Number of function arguments */
370612ffee8cSdrh       FuncDef *pDef;         /* The function definition object */
370712ffee8cSdrh       const char *zId;       /* The function name */
3708693e6719Sdrh       u32 constMask = 0;     /* Mask of function arguments that are constant */
370912ffee8cSdrh       int i;                 /* Loop counter */
3710c332cc30Sdrh       sqlite3 *db = pParse->db;  /* The database connection */
371112ffee8cSdrh       u8 enc = ENC(db);      /* The text encoding used by this database */
371212ffee8cSdrh       CollSeq *pColl = 0;    /* A collating sequence */
371317435752Sdrh 
371467a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
3715eda079cdSdrh       if( ExprHasProperty(pExpr, EP_WinFunc) ){
3716eda079cdSdrh         return pExpr->y.pWin->regResult;
371786fb6e17Sdan       }
371867a9b8edSdan #endif
371986fb6e17Sdan 
37201e9b53f9Sdrh       if( ConstFactorOk(pParse) && sqlite3ExprIsConstantNotJoin(pExpr) ){
372149c5ab24Sdrh         /* SQL functions can be expensive. So try to move constant functions
3722ad879ffdSdrh         ** out of the inner loop, even if that means an extra OP_Copy. */
3723ad879ffdSdrh         return sqlite3ExprCodeAtInit(pParse, pExpr, -1);
37241e9b53f9Sdrh       }
37256ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
3726c5cd1249Sdrh       if( ExprHasProperty(pExpr, EP_TokenOnly) ){
372712ffee8cSdrh         pFarg = 0;
372812ffee8cSdrh       }else{
372912ffee8cSdrh         pFarg = pExpr->x.pList;
373012ffee8cSdrh       }
373112ffee8cSdrh       nFarg = pFarg ? pFarg->nExpr : 0;
373233e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
373333e619fcSdrh       zId = pExpr->u.zToken;
373480738d9cSdrh       pDef = sqlite3FindFunction(db, zId, nFarg, enc, 0);
3735cc15313cSdrh #ifdef SQLITE_ENABLE_UNKNOWN_SQL_FUNCTION
3736cc15313cSdrh       if( pDef==0 && pParse->explain ){
3737cc15313cSdrh         pDef = sqlite3FindFunction(db, "unknown", nFarg, enc, 0);
3738cc15313cSdrh       }
3739cc15313cSdrh #endif
3740b6e9f7a4Sdan       if( pDef==0 || pDef->xFinalize!=0 ){
374180738d9cSdrh         sqlite3ErrorMsg(pParse, "unknown function: %s()", zId);
3742feb306f5Sdrh         break;
3743feb306f5Sdrh       }
3744ae6bb957Sdrh 
3745ae6bb957Sdrh       /* Attempt a direct implementation of the built-in COALESCE() and
374660ec914cSpeter.d.reid       ** IFNULL() functions.  This avoids unnecessary evaluation of
3747ae6bb957Sdrh       ** arguments past the first non-NULL argument.
3748ae6bb957Sdrh       */
3749d36e1041Sdrh       if( pDef->funcFlags & SQLITE_FUNC_COALESCE ){
3750ec4ccdbcSdrh         int endCoalesce = sqlite3VdbeMakeLabel(pParse);
3751ae6bb957Sdrh         assert( nFarg>=2 );
3752ae6bb957Sdrh         sqlite3ExprCode(pParse, pFarg->a[0].pExpr, target);
3753ae6bb957Sdrh         for(i=1; i<nFarg; i++){
3754ae6bb957Sdrh           sqlite3VdbeAddOp2(v, OP_NotNull, target, endCoalesce);
3755688852abSdrh           VdbeCoverage(v);
3756ae6bb957Sdrh           sqlite3ExprCode(pParse, pFarg->a[i].pExpr, target);
3757ae6bb957Sdrh         }
3758ae6bb957Sdrh         sqlite3VdbeResolveLabel(v, endCoalesce);
3759ae6bb957Sdrh         break;
3760ae6bb957Sdrh       }
3761ae6bb957Sdrh 
3762cca9f3d2Sdrh       /* The UNLIKELY() function is a no-op.  The result is the value
3763cca9f3d2Sdrh       ** of the first argument.
3764cca9f3d2Sdrh       */
3765cca9f3d2Sdrh       if( pDef->funcFlags & SQLITE_FUNC_UNLIKELY ){
3766cca9f3d2Sdrh         assert( nFarg>=1 );
3767c332cc30Sdrh         return sqlite3ExprCodeTarget(pParse, pFarg->a[0].pExpr, target);
3768cca9f3d2Sdrh       }
3769ae6bb957Sdrh 
377054240751Sdrh #ifdef SQLITE_DEBUG
3771a1a523a5Sdrh       /* The AFFINITY() function evaluates to a string that describes
3772a1a523a5Sdrh       ** the type affinity of the argument.  This is used for testing of
3773a1a523a5Sdrh       ** the SQLite type logic.
3774a1a523a5Sdrh       */
3775a1a523a5Sdrh       if( pDef->funcFlags & SQLITE_FUNC_AFFINITY ){
3776a1a523a5Sdrh         const char *azAff[] = { "blob", "text", "numeric", "integer", "real" };
3777a1a523a5Sdrh         char aff;
3778a1a523a5Sdrh         assert( nFarg==1 );
3779a1a523a5Sdrh         aff = sqlite3ExprAffinity(pFarg->a[0].pExpr);
3780a1a523a5Sdrh         sqlite3VdbeLoadString(v, target,
3781a1a523a5Sdrh                               aff ? azAff[aff-SQLITE_AFF_BLOB] : "none");
3782a1a523a5Sdrh         return target;
3783a1a523a5Sdrh       }
378454240751Sdrh #endif
3785a1a523a5Sdrh 
3786d1a01edaSdrh       for(i=0; i<nFarg; i++){
3787d1a01edaSdrh         if( i<32 && sqlite3ExprIsConstant(pFarg->a[i].pExpr) ){
3788693e6719Sdrh           testcase( i==31 );
3789693e6719Sdrh           constMask |= MASKBIT32(i);
3790d1a01edaSdrh         }
3791d1a01edaSdrh         if( (pDef->funcFlags & SQLITE_FUNC_NEEDCOLL)!=0 && !pColl ){
3792d1a01edaSdrh           pColl = sqlite3ExprCollSeq(pParse, pFarg->a[i].pExpr);
3793d1a01edaSdrh         }
3794d1a01edaSdrh       }
379512ffee8cSdrh       if( pFarg ){
3796d1a01edaSdrh         if( constMask ){
3797d1a01edaSdrh           r1 = pParse->nMem+1;
3798d1a01edaSdrh           pParse->nMem += nFarg;
3799d1a01edaSdrh         }else{
380012ffee8cSdrh           r1 = sqlite3GetTempRange(pParse, nFarg);
3801d1a01edaSdrh         }
3802a748fdccSdrh 
3803a748fdccSdrh         /* For length() and typeof() functions with a column argument,
3804a748fdccSdrh         ** set the P5 parameter to the OP_Column opcode to OPFLAG_LENGTHARG
3805a748fdccSdrh         ** or OPFLAG_TYPEOFARG respectively, to avoid unnecessary data
3806a748fdccSdrh         ** loading.
3807a748fdccSdrh         */
3808d36e1041Sdrh         if( (pDef->funcFlags & (SQLITE_FUNC_LENGTH|SQLITE_FUNC_TYPEOF))!=0 ){
38094e245a4cSdrh           u8 exprOp;
3810a748fdccSdrh           assert( nFarg==1 );
3811a748fdccSdrh           assert( pFarg->a[0].pExpr!=0 );
38124e245a4cSdrh           exprOp = pFarg->a[0].pExpr->op;
38134e245a4cSdrh           if( exprOp==TK_COLUMN || exprOp==TK_AGG_COLUMN ){
3814a748fdccSdrh             assert( SQLITE_FUNC_LENGTH==OPFLAG_LENGTHARG );
3815a748fdccSdrh             assert( SQLITE_FUNC_TYPEOF==OPFLAG_TYPEOFARG );
3816b1fba286Sdrh             testcase( pDef->funcFlags & OPFLAG_LENGTHARG );
3817b1fba286Sdrh             pFarg->a[0].pExpr->op2 =
3818b1fba286Sdrh                   pDef->funcFlags & (OPFLAG_LENGTHARG|OPFLAG_TYPEOFARG);
3819a748fdccSdrh           }
3820a748fdccSdrh         }
3821a748fdccSdrh 
38225579d59fSdrh         sqlite3ExprCodeExprList(pParse, pFarg, r1, 0,
3823d1a01edaSdrh                                 SQLITE_ECEL_DUP|SQLITE_ECEL_FACTOR);
3824892d3179Sdrh       }else{
382512ffee8cSdrh         r1 = 0;
3826892d3179Sdrh       }
3827b7f6f68fSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
3828a43fa227Sdrh       /* Possibly overload the function if the first argument is
3829a43fa227Sdrh       ** a virtual table column.
3830a43fa227Sdrh       **
3831a43fa227Sdrh       ** For infix functions (LIKE, GLOB, REGEXP, and MATCH) use the
3832a43fa227Sdrh       ** second argument, not the first, as the argument to test to
3833a43fa227Sdrh       ** see if it is a column in a virtual table.  This is done because
3834a43fa227Sdrh       ** the left operand of infix functions (the operand we want to
3835a43fa227Sdrh       ** control overloading) ends up as the second argument to the
3836a43fa227Sdrh       ** function.  The expression "A glob B" is equivalent to
3837a43fa227Sdrh       ** "glob(B,A).  We want to use the A in "A glob B" to test
3838a43fa227Sdrh       ** for function overloading.  But we use the B term in "glob(B,A)".
3839a43fa227Sdrh       */
384059155065Sdrh       if( nFarg>=2 && ExprHasProperty(pExpr, EP_InfixFunc) ){
384112ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[1].pExpr);
384212ffee8cSdrh       }else if( nFarg>0 ){
384312ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[0].pExpr);
3844b7f6f68fSdrh       }
3845b7f6f68fSdrh #endif
3846d36e1041Sdrh       if( pDef->funcFlags & SQLITE_FUNC_NEEDCOLL ){
38478b213899Sdrh         if( !pColl ) pColl = db->pDfltColl;
384866a5167bSdrh         sqlite3VdbeAddOp4(v, OP_CollSeq, 0, 0, 0, (char *)pColl, P4_COLLSEQ);
3849682f68b0Sdanielk1977       }
3850092457b1Sdrh #ifdef SQLITE_ENABLE_OFFSET_SQL_FUNC
3851092457b1Sdrh       if( pDef->funcFlags & SQLITE_FUNC_OFFSET ){
38522fc865c1Sdrh         Expr *pArg = pFarg->a[0].pExpr;
38532fc865c1Sdrh         if( pArg->op==TK_COLUMN ){
3854092457b1Sdrh           sqlite3VdbeAddOp3(v, OP_Offset, pArg->iTable, pArg->iColumn, target);
38552fc865c1Sdrh         }else{
38562fc865c1Sdrh           sqlite3VdbeAddOp2(v, OP_Null, 0, target);
38572fc865c1Sdrh         }
3858092457b1Sdrh       }else
3859092457b1Sdrh #endif
3860092457b1Sdrh       {
38613e34eabcSdrh         sqlite3VdbeAddOp4(v, pParse->iSelfTab ? OP_PureFunc0 : OP_Function0,
38623e34eabcSdrh                           constMask, r1, target, (char*)pDef, P4_FUNCDEF);
386312ffee8cSdrh         sqlite3VdbeChangeP5(v, (u8)nFarg);
38642fc865c1Sdrh       }
3865d1a01edaSdrh       if( nFarg && constMask==0 ){
386612ffee8cSdrh         sqlite3ReleaseTempRange(pParse, r1, nFarg);
38672dcef11bSdrh       }
3868c332cc30Sdrh       return target;
38696ec2733bSdrh     }
3870fe2093d7Sdrh #ifndef SQLITE_OMIT_SUBQUERY
3871fe2093d7Sdrh     case TK_EXISTS:
387219a775c2Sdrh     case TK_SELECT: {
38738da209b1Sdan       int nCol;
3874c5499befSdrh       testcase( op==TK_EXISTS );
3875c5499befSdrh       testcase( op==TK_SELECT );
38768da209b1Sdan       if( op==TK_SELECT && (nCol = pExpr->x.pSelect->pEList->nExpr)!=1 ){
38778da209b1Sdan         sqlite3SubselectError(pParse, nCol, 1);
38788da209b1Sdan       }else{
387985bcdce2Sdrh         return sqlite3CodeSubselect(pParse, pExpr);
38808da209b1Sdan       }
388119a775c2Sdrh       break;
388219a775c2Sdrh     }
3883fc7f27b9Sdrh     case TK_SELECT_COLUMN: {
3884966e2911Sdrh       int n;
3885fc7f27b9Sdrh       if( pExpr->pLeft->iTable==0 ){
388685bcdce2Sdrh         pExpr->pLeft->iTable = sqlite3CodeSubselect(pParse, pExpr->pLeft);
3887fc7f27b9Sdrh       }
3888966e2911Sdrh       assert( pExpr->iTable==0 || pExpr->pLeft->op==TK_SELECT );
3889966e2911Sdrh       if( pExpr->iTable
3890966e2911Sdrh        && pExpr->iTable!=(n = sqlite3ExprVectorSize(pExpr->pLeft))
3891966e2911Sdrh       ){
3892966e2911Sdrh         sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
3893966e2911Sdrh                                 pExpr->iTable, n);
3894966e2911Sdrh       }
3895c332cc30Sdrh       return pExpr->pLeft->iTable + pExpr->iColumn;
3896fc7f27b9Sdrh     }
3897fef5208cSdrh     case TK_IN: {
3898ec4ccdbcSdrh       int destIfFalse = sqlite3VdbeMakeLabel(pParse);
3899ec4ccdbcSdrh       int destIfNull = sqlite3VdbeMakeLabel(pParse);
3900e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3901e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
390266ba23ceSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
3903e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
3904e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_AddImm, target, 0);
3905e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfNull);
3906c332cc30Sdrh       return target;
3907fef5208cSdrh     }
3908e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
3909e3365e6cSdrh 
3910e3365e6cSdrh 
39112dcef11bSdrh     /*
39122dcef11bSdrh     **    x BETWEEN y AND z
39132dcef11bSdrh     **
39142dcef11bSdrh     ** This is equivalent to
39152dcef11bSdrh     **
39162dcef11bSdrh     **    x>=y AND x<=z
39172dcef11bSdrh     **
39182dcef11bSdrh     ** X is stored in pExpr->pLeft.
39192dcef11bSdrh     ** Y is stored in pExpr->pList->a[0].pExpr.
39202dcef11bSdrh     ** Z is stored in pExpr->pList->a[1].pExpr.
39212dcef11bSdrh     */
3922fef5208cSdrh     case TK_BETWEEN: {
392371c57db0Sdan       exprCodeBetween(pParse, pExpr, target, 0, 0);
3924c332cc30Sdrh       return target;
3925fef5208cSdrh     }
392694fa9c41Sdrh     case TK_SPAN:
3927ae80ddeaSdrh     case TK_COLLATE:
39284f07e5fbSdrh     case TK_UPLUS: {
39291efa8023Sdrh       pExpr = pExpr->pLeft;
393059ee43a7Sdrh       goto expr_code_doover; /* 2018-04-28: Prevent deep recursion. OSSFuzz. */
3931a2e00042Sdrh     }
39322dcef11bSdrh 
3933165921a7Sdan     case TK_TRIGGER: {
393465a7cd16Sdan       /* If the opcode is TK_TRIGGER, then the expression is a reference
393565a7cd16Sdan       ** to a column in the new.* or old.* pseudo-tables available to
393665a7cd16Sdan       ** trigger programs. In this case Expr.iTable is set to 1 for the
393765a7cd16Sdan       ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
393865a7cd16Sdan       ** is set to the column of the pseudo-table to read, or to -1 to
393965a7cd16Sdan       ** read the rowid field.
394065a7cd16Sdan       **
394165a7cd16Sdan       ** The expression is implemented using an OP_Param opcode. The p1
394265a7cd16Sdan       ** parameter is set to 0 for an old.rowid reference, or to (i+1)
394365a7cd16Sdan       ** to reference another column of the old.* pseudo-table, where
394465a7cd16Sdan       ** i is the index of the column. For a new.rowid reference, p1 is
394565a7cd16Sdan       ** set to (n+1), where n is the number of columns in each pseudo-table.
394665a7cd16Sdan       ** For a reference to any other column in the new.* pseudo-table, p1
394765a7cd16Sdan       ** is set to (n+2+i), where n and i are as defined previously. For
394865a7cd16Sdan       ** example, if the table on which triggers are being fired is
394965a7cd16Sdan       ** declared as:
395065a7cd16Sdan       **
395165a7cd16Sdan       **   CREATE TABLE t1(a, b);
395265a7cd16Sdan       **
395365a7cd16Sdan       ** Then p1 is interpreted as follows:
395465a7cd16Sdan       **
395565a7cd16Sdan       **   p1==0   ->    old.rowid     p1==3   ->    new.rowid
395665a7cd16Sdan       **   p1==1   ->    old.a         p1==4   ->    new.a
395765a7cd16Sdan       **   p1==2   ->    old.b         p1==5   ->    new.b
395865a7cd16Sdan       */
3959eda079cdSdrh       Table *pTab = pExpr->y.pTab;
396065a7cd16Sdan       int p1 = pExpr->iTable * (pTab->nCol+1) + 1 + pExpr->iColumn;
396165a7cd16Sdan 
396265a7cd16Sdan       assert( pExpr->iTable==0 || pExpr->iTable==1 );
396365a7cd16Sdan       assert( pExpr->iColumn>=-1 && pExpr->iColumn<pTab->nCol );
396465a7cd16Sdan       assert( pTab->iPKey<0 || pExpr->iColumn!=pTab->iPKey );
396565a7cd16Sdan       assert( p1>=0 && p1<(pTab->nCol*2+2) );
396665a7cd16Sdan 
396765a7cd16Sdan       sqlite3VdbeAddOp2(v, OP_Param, p1, target);
3968896494e8Sdrh       VdbeComment((v, "r[%d]=%s.%s", target,
3969165921a7Sdan         (pExpr->iTable ? "new" : "old"),
3970eda079cdSdrh         (pExpr->iColumn<0 ? "rowid" : pExpr->y.pTab->aCol[pExpr->iColumn].zName)
3971165921a7Sdan       ));
397265a7cd16Sdan 
397344dbca83Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
397465a7cd16Sdan       /* If the column has REAL affinity, it may currently be stored as an
3975113762a2Sdrh       ** integer. Use OP_RealAffinity to make sure it is really real.
3976113762a2Sdrh       **
3977113762a2Sdrh       ** EVIDENCE-OF: R-60985-57662 SQLite will convert the value back to
3978113762a2Sdrh       ** floating point when extracting it from the record.  */
39792832ad42Sdan       if( pExpr->iColumn>=0
39802832ad42Sdan        && pTab->aCol[pExpr->iColumn].affinity==SQLITE_AFF_REAL
39812832ad42Sdan       ){
39822832ad42Sdan         sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
39832832ad42Sdan       }
398444dbca83Sdrh #endif
3985165921a7Sdan       break;
3986165921a7Sdan     }
3987165921a7Sdan 
398871c57db0Sdan     case TK_VECTOR: {
3989e835bc12Sdrh       sqlite3ErrorMsg(pParse, "row value misused");
399071c57db0Sdan       break;
399171c57db0Sdan     }
399271c57db0Sdan 
399331d6fd55Sdrh     case TK_IF_NULL_ROW: {
399431d6fd55Sdrh       int addrINR;
399531d6fd55Sdrh       addrINR = sqlite3VdbeAddOp1(v, OP_IfNullRow, pExpr->iTable);
399631d6fd55Sdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
399731d6fd55Sdrh       sqlite3VdbeJumpHere(v, addrINR);
399831d6fd55Sdrh       sqlite3VdbeChangeP3(v, addrINR, inReg);
399931d6fd55Sdrh       break;
400031d6fd55Sdrh     }
400131d6fd55Sdrh 
40022dcef11bSdrh     /*
40032dcef11bSdrh     ** Form A:
40042dcef11bSdrh     **   CASE x WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
40052dcef11bSdrh     **
40062dcef11bSdrh     ** Form B:
40072dcef11bSdrh     **   CASE WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
40082dcef11bSdrh     **
40092dcef11bSdrh     ** Form A is can be transformed into the equivalent form B as follows:
40102dcef11bSdrh     **   CASE WHEN x=e1 THEN r1 WHEN x=e2 THEN r2 ...
40112dcef11bSdrh     **        WHEN x=eN THEN rN ELSE y END
40122dcef11bSdrh     **
40132dcef11bSdrh     ** X (if it exists) is in pExpr->pLeft.
4014c5cd1249Sdrh     ** Y is in the last element of pExpr->x.pList if pExpr->x.pList->nExpr is
4015c5cd1249Sdrh     ** odd.  The Y is also optional.  If the number of elements in x.pList
4016c5cd1249Sdrh     ** is even, then Y is omitted and the "otherwise" result is NULL.
40172dcef11bSdrh     ** Ei is in pExpr->pList->a[i*2] and Ri is pExpr->pList->a[i*2+1].
40182dcef11bSdrh     **
40192dcef11bSdrh     ** The result of the expression is the Ri for the first matching Ei,
40202dcef11bSdrh     ** or if there is no matching Ei, the ELSE term Y, or if there is
40212dcef11bSdrh     ** no ELSE term, NULL.
40222dcef11bSdrh     */
402333cd4909Sdrh     default: assert( op==TK_CASE ); {
40242dcef11bSdrh       int endLabel;                     /* GOTO label for end of CASE stmt */
40252dcef11bSdrh       int nextCase;                     /* GOTO label for next WHEN clause */
40262dcef11bSdrh       int nExpr;                        /* 2x number of WHEN terms */
40272dcef11bSdrh       int i;                            /* Loop counter */
40282dcef11bSdrh       ExprList *pEList;                 /* List of WHEN terms */
40292dcef11bSdrh       struct ExprList_item *aListelem;  /* Array of WHEN terms */
40302dcef11bSdrh       Expr opCompare;                   /* The X==Ei expression */
40312dcef11bSdrh       Expr *pX;                         /* The X expression */
40321bd10f8aSdrh       Expr *pTest = 0;                  /* X==Ei (form A) or just Ei (form B) */
403317a7f8ddSdrh 
40346ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) && pExpr->x.pList );
40356ab3a2ecSdanielk1977       assert(pExpr->x.pList->nExpr > 0);
40366ab3a2ecSdanielk1977       pEList = pExpr->x.pList;
4037be5c89acSdrh       aListelem = pEList->a;
4038be5c89acSdrh       nExpr = pEList->nExpr;
4039ec4ccdbcSdrh       endLabel = sqlite3VdbeMakeLabel(pParse);
40402dcef11bSdrh       if( (pX = pExpr->pLeft)!=0 ){
4041a8e05761Sdrh         exprNodeCopy(&tempX, pX);
404233cd4909Sdrh         testcase( pX->op==TK_COLUMN );
404312abf408Sdrh         exprToRegister(&tempX, exprCodeVector(pParse, &tempX, &regFree1));
4044c5499befSdrh         testcase( regFree1==0 );
4045abb9d5f1Sdrh         memset(&opCompare, 0, sizeof(opCompare));
40462dcef11bSdrh         opCompare.op = TK_EQ;
404710d1edf0Sdrh         opCompare.pLeft = &tempX;
40482dcef11bSdrh         pTest = &opCompare;
40498b1db07fSdrh         /* Ticket b351d95f9cd5ef17e9d9dbae18f5ca8611190001:
40508b1db07fSdrh         ** The value in regFree1 might get SCopy-ed into the file result.
40518b1db07fSdrh         ** So make sure that the regFree1 register is not reused for other
40528b1db07fSdrh         ** purposes and possibly overwritten.  */
40538b1db07fSdrh         regFree1 = 0;
4054cce7d176Sdrh       }
4055c5cd1249Sdrh       for(i=0; i<nExpr-1; i=i+2){
40562dcef11bSdrh         if( pX ){
40571bd10f8aSdrh           assert( pTest!=0 );
40582dcef11bSdrh           opCompare.pRight = aListelem[i].pExpr;
4059f5905aa7Sdrh         }else{
40602dcef11bSdrh           pTest = aListelem[i].pExpr;
406117a7f8ddSdrh         }
4062ec4ccdbcSdrh         nextCase = sqlite3VdbeMakeLabel(pParse);
406333cd4909Sdrh         testcase( pTest->op==TK_COLUMN );
40642dcef11bSdrh         sqlite3ExprIfFalse(pParse, pTest, nextCase, SQLITE_JUMPIFNULL);
4065c5499befSdrh         testcase( aListelem[i+1].pExpr->op==TK_COLUMN );
40669de221dfSdrh         sqlite3ExprCode(pParse, aListelem[i+1].pExpr, target);
4067076e85f5Sdrh         sqlite3VdbeGoto(v, endLabel);
40682dcef11bSdrh         sqlite3VdbeResolveLabel(v, nextCase);
4069f570f011Sdrh       }
4070c5cd1249Sdrh       if( (nExpr&1)!=0 ){
4071c5cd1249Sdrh         sqlite3ExprCode(pParse, pEList->a[nExpr-1].pExpr, target);
407217a7f8ddSdrh       }else{
40739de221dfSdrh         sqlite3VdbeAddOp2(v, OP_Null, 0, target);
407417a7f8ddSdrh       }
40752dcef11bSdrh       sqlite3VdbeResolveLabel(v, endLabel);
40766f34903eSdanielk1977       break;
40776f34903eSdanielk1977     }
40785338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_TRIGGER
40796f34903eSdanielk1977     case TK_RAISE: {
4080165921a7Sdan       assert( pExpr->affinity==OE_Rollback
4081165921a7Sdan            || pExpr->affinity==OE_Abort
4082165921a7Sdan            || pExpr->affinity==OE_Fail
4083165921a7Sdan            || pExpr->affinity==OE_Ignore
4084165921a7Sdan       );
4085e0af83acSdan       if( !pParse->pTriggerTab ){
4086e0af83acSdan         sqlite3ErrorMsg(pParse,
4087e0af83acSdan                        "RAISE() may only be used within a trigger-program");
4088e0af83acSdan         return 0;
4089e0af83acSdan       }
4090e0af83acSdan       if( pExpr->affinity==OE_Abort ){
4091e0af83acSdan         sqlite3MayAbort(pParse);
4092e0af83acSdan       }
409333e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
4094e0af83acSdan       if( pExpr->affinity==OE_Ignore ){
4095e0af83acSdan         sqlite3VdbeAddOp4(
4096e0af83acSdan             v, OP_Halt, SQLITE_OK, OE_Ignore, 0, pExpr->u.zToken,0);
4097688852abSdrh         VdbeCoverage(v);
4098e0af83acSdan       }else{
4099433dccfbSdrh         sqlite3HaltConstraint(pParse, SQLITE_CONSTRAINT_TRIGGER,
4100f9c8ce3cSdrh                               pExpr->affinity, pExpr->u.zToken, 0, 0);
4101e0af83acSdan       }
4102e0af83acSdan 
4103ffe07b2dSdrh       break;
410417a7f8ddSdrh     }
41055338a5f7Sdanielk1977 #endif
4106ffe07b2dSdrh   }
41072dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
41082dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
41092dcef11bSdrh   return inReg;
41105b6afba9Sdrh }
41112dcef11bSdrh 
41122dcef11bSdrh /*
4113d1a01edaSdrh ** Factor out the code of the given expression to initialization time.
41141e9b53f9Sdrh **
4115ad879ffdSdrh ** If regDest>=0 then the result is always stored in that register and the
4116ad879ffdSdrh ** result is not reusable.  If regDest<0 then this routine is free to
4117ad879ffdSdrh ** store the value whereever it wants.  The register where the expression
4118ad879ffdSdrh ** is stored is returned.  When regDest<0, two identical expressions will
4119ad879ffdSdrh ** code to the same register.
4120d1a01edaSdrh */
41211e9b53f9Sdrh int sqlite3ExprCodeAtInit(
4122d673cddaSdrh   Parse *pParse,    /* Parsing context */
4123d673cddaSdrh   Expr *pExpr,      /* The expression to code when the VDBE initializes */
4124ad879ffdSdrh   int regDest       /* Store the value in this register */
4125d673cddaSdrh ){
4126d1a01edaSdrh   ExprList *p;
4127d9f158e7Sdrh   assert( ConstFactorOk(pParse) );
4128d1a01edaSdrh   p = pParse->pConstExpr;
4129ad879ffdSdrh   if( regDest<0 && p ){
41301e9b53f9Sdrh     struct ExprList_item *pItem;
41311e9b53f9Sdrh     int i;
41321e9b53f9Sdrh     for(pItem=p->a, i=p->nExpr; i>0; pItem++, i--){
41335aa550cfSdan       if( pItem->reusable && sqlite3ExprCompare(0,pItem->pExpr,pExpr,-1)==0 ){
41341e9b53f9Sdrh         return pItem->u.iConstExprReg;
41351e9b53f9Sdrh       }
41361e9b53f9Sdrh     }
41371e9b53f9Sdrh   }
4138d1a01edaSdrh   pExpr = sqlite3ExprDup(pParse->db, pExpr, 0);
4139d1a01edaSdrh   p = sqlite3ExprListAppend(pParse, p, pExpr);
4140d673cddaSdrh   if( p ){
4141d673cddaSdrh      struct ExprList_item *pItem = &p->a[p->nExpr-1];
4142ad879ffdSdrh      pItem->reusable = regDest<0;
4143ad879ffdSdrh      if( regDest<0 ) regDest = ++pParse->nMem;
4144d673cddaSdrh      pItem->u.iConstExprReg = regDest;
4145d673cddaSdrh   }
4146d1a01edaSdrh   pParse->pConstExpr = p;
41471e9b53f9Sdrh   return regDest;
4148d1a01edaSdrh }
4149d1a01edaSdrh 
4150d1a01edaSdrh /*
41512dcef11bSdrh ** Generate code to evaluate an expression and store the results
41522dcef11bSdrh ** into a register.  Return the register number where the results
41532dcef11bSdrh ** are stored.
41542dcef11bSdrh **
41552dcef11bSdrh ** If the register is a temporary register that can be deallocated,
4156678ccce8Sdrh ** then write its number into *pReg.  If the result register is not
41572dcef11bSdrh ** a temporary, then set *pReg to zero.
4158f30a969bSdrh **
4159f30a969bSdrh ** If pExpr is a constant, then this routine might generate this
4160f30a969bSdrh ** code to fill the register in the initialization section of the
4161f30a969bSdrh ** VDBE program, in order to factor it out of the evaluation loop.
41622dcef11bSdrh */
41632dcef11bSdrh int sqlite3ExprCodeTemp(Parse *pParse, Expr *pExpr, int *pReg){
4164f30a969bSdrh   int r2;
4165f30a969bSdrh   pExpr = sqlite3ExprSkipCollate(pExpr);
4166d9f158e7Sdrh   if( ConstFactorOk(pParse)
4167f30a969bSdrh    && pExpr->op!=TK_REGISTER
4168f30a969bSdrh    && sqlite3ExprIsConstantNotJoin(pExpr)
4169f30a969bSdrh   ){
4170f30a969bSdrh     *pReg  = 0;
4171ad879ffdSdrh     r2 = sqlite3ExprCodeAtInit(pParse, pExpr, -1);
4172f30a969bSdrh   }else{
41732dcef11bSdrh     int r1 = sqlite3GetTempReg(pParse);
4174f30a969bSdrh     r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
41752dcef11bSdrh     if( r2==r1 ){
41762dcef11bSdrh       *pReg = r1;
41772dcef11bSdrh     }else{
41782dcef11bSdrh       sqlite3ReleaseTempReg(pParse, r1);
41792dcef11bSdrh       *pReg = 0;
41802dcef11bSdrh     }
4181f30a969bSdrh   }
41822dcef11bSdrh   return r2;
41832dcef11bSdrh }
41842dcef11bSdrh 
41852dcef11bSdrh /*
41862dcef11bSdrh ** Generate code that will evaluate expression pExpr and store the
41872dcef11bSdrh ** results in register target.  The results are guaranteed to appear
41882dcef11bSdrh ** in register target.
41892dcef11bSdrh */
419005a86c5cSdrh void sqlite3ExprCode(Parse *pParse, Expr *pExpr, int target){
41919cbf3425Sdrh   int inReg;
41929cbf3425Sdrh 
41939cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
4194ebc16717Sdrh   if( pExpr && pExpr->op==TK_REGISTER ){
4195ebc16717Sdrh     sqlite3VdbeAddOp2(pParse->pVdbe, OP_Copy, pExpr->iTable, target);
4196ebc16717Sdrh   }else{
41979cbf3425Sdrh     inReg = sqlite3ExprCodeTarget(pParse, pExpr, target);
41981c75c9d7Sdrh     assert( pParse->pVdbe!=0 || pParse->db->mallocFailed );
41990e359b30Sdrh     if( inReg!=target && pParse->pVdbe ){
42009cbf3425Sdrh       sqlite3VdbeAddOp2(pParse->pVdbe, OP_SCopy, inReg, target);
420117a7f8ddSdrh     }
4202ebc16717Sdrh   }
4203cce7d176Sdrh }
4204cce7d176Sdrh 
4205cce7d176Sdrh /*
42061c75c9d7Sdrh ** Make a transient copy of expression pExpr and then code it using
42071c75c9d7Sdrh ** sqlite3ExprCode().  This routine works just like sqlite3ExprCode()
42081c75c9d7Sdrh ** except that the input expression is guaranteed to be unchanged.
42091c75c9d7Sdrh */
42101c75c9d7Sdrh void sqlite3ExprCodeCopy(Parse *pParse, Expr *pExpr, int target){
42111c75c9d7Sdrh   sqlite3 *db = pParse->db;
42121c75c9d7Sdrh   pExpr = sqlite3ExprDup(db, pExpr, 0);
42131c75c9d7Sdrh   if( !db->mallocFailed ) sqlite3ExprCode(pParse, pExpr, target);
42141c75c9d7Sdrh   sqlite3ExprDelete(db, pExpr);
42151c75c9d7Sdrh }
42161c75c9d7Sdrh 
42171c75c9d7Sdrh /*
421805a86c5cSdrh ** Generate code that will evaluate expression pExpr and store the
421905a86c5cSdrh ** results in register target.  The results are guaranteed to appear
422005a86c5cSdrh ** in register target.  If the expression is constant, then this routine
422105a86c5cSdrh ** might choose to code the expression at initialization time.
422205a86c5cSdrh */
422305a86c5cSdrh void sqlite3ExprCodeFactorable(Parse *pParse, Expr *pExpr, int target){
4224b8b06690Sdrh   if( pParse->okConstFactor && sqlite3ExprIsConstantNotJoin(pExpr) ){
4225ad879ffdSdrh     sqlite3ExprCodeAtInit(pParse, pExpr, target);
422605a86c5cSdrh   }else{
422705a86c5cSdrh     sqlite3ExprCode(pParse, pExpr, target);
422805a86c5cSdrh   }
4229cce7d176Sdrh }
4230cce7d176Sdrh 
4231cce7d176Sdrh /*
423260ec914cSpeter.d.reid ** Generate code that evaluates the given expression and puts the result
4233de4fcfddSdrh ** in register target.
423425303780Sdrh **
42352dcef11bSdrh ** Also make a copy of the expression results into another "cache" register
42362dcef11bSdrh ** and modify the expression so that the next time it is evaluated,
42372dcef11bSdrh ** the result is a copy of the cache register.
42382dcef11bSdrh **
42392dcef11bSdrh ** This routine is used for expressions that are used multiple
42402dcef11bSdrh ** times.  They are evaluated once and the results of the expression
42412dcef11bSdrh ** are reused.
424225303780Sdrh */
424305a86c5cSdrh void sqlite3ExprCodeAndCache(Parse *pParse, Expr *pExpr, int target){
424425303780Sdrh   Vdbe *v = pParse->pVdbe;
424525303780Sdrh   int iMem;
424605a86c5cSdrh 
424705a86c5cSdrh   assert( target>0 );
424805a86c5cSdrh   assert( pExpr->op!=TK_REGISTER );
424905a86c5cSdrh   sqlite3ExprCode(pParse, pExpr, target);
42502dcef11bSdrh   iMem = ++pParse->nMem;
425105a86c5cSdrh   sqlite3VdbeAddOp2(v, OP_Copy, target, iMem);
4252a4c3c87eSdrh   exprToRegister(pExpr, iMem);
425325303780Sdrh }
42547e02e5e6Sdrh 
4255678ccce8Sdrh /*
4256268380caSdrh ** Generate code that pushes the value of every element of the given
42579cbf3425Sdrh ** expression list into a sequence of registers beginning at target.
4258268380caSdrh **
42593df6c3b1Sdrh ** Return the number of elements evaluated.  The number returned will
42603df6c3b1Sdrh ** usually be pList->nExpr but might be reduced if SQLITE_ECEL_OMITREF
42613df6c3b1Sdrh ** is defined.
4262d1a01edaSdrh **
4263d1a01edaSdrh ** The SQLITE_ECEL_DUP flag prevents the arguments from being
4264d1a01edaSdrh ** filled using OP_SCopy.  OP_Copy must be used instead.
4265d1a01edaSdrh **
4266d1a01edaSdrh ** The SQLITE_ECEL_FACTOR argument allows constant arguments to be
4267d1a01edaSdrh ** factored out into initialization code.
4268b0df9634Sdrh **
4269b0df9634Sdrh ** The SQLITE_ECEL_REF flag means that expressions in the list with
4270b0df9634Sdrh ** ExprList.a[].u.x.iOrderByCol>0 have already been evaluated and stored
4271b0df9634Sdrh ** in registers at srcReg, and so the value can be copied from there.
42723df6c3b1Sdrh ** If SQLITE_ECEL_OMITREF is also set, then the values with u.x.iOrderByCol>0
42733df6c3b1Sdrh ** are simply omitted rather than being copied from srcReg.
4274268380caSdrh */
42754adee20fSdanielk1977 int sqlite3ExprCodeExprList(
4276268380caSdrh   Parse *pParse,     /* Parsing context */
4277389a1adbSdrh   ExprList *pList,   /* The expression list to be coded */
4278191b54cbSdrh   int target,        /* Where to write results */
42795579d59fSdrh   int srcReg,        /* Source registers if SQLITE_ECEL_REF */
4280d1a01edaSdrh   u8 flags           /* SQLITE_ECEL_* flags */
4281268380caSdrh ){
4282268380caSdrh   struct ExprList_item *pItem;
42835579d59fSdrh   int i, j, n;
4284d1a01edaSdrh   u8 copyOp = (flags & SQLITE_ECEL_DUP) ? OP_Copy : OP_SCopy;
42855579d59fSdrh   Vdbe *v = pParse->pVdbe;
42869d8b3072Sdrh   assert( pList!=0 );
42879cbf3425Sdrh   assert( target>0 );
4288d81a142bSdrh   assert( pParse->pVdbe!=0 );  /* Never gets this far otherwise */
4289268380caSdrh   n = pList->nExpr;
4290d9f158e7Sdrh   if( !ConstFactorOk(pParse) ) flags &= ~SQLITE_ECEL_FACTOR;
4291191b54cbSdrh   for(pItem=pList->a, i=0; i<n; i++, pItem++){
42927445ffe2Sdrh     Expr *pExpr = pItem->pExpr;
429324e25d32Sdan #ifdef SQLITE_ENABLE_SORTER_REFERENCES
429424e25d32Sdan     if( pItem->bSorterRef ){
429524e25d32Sdan       i--;
429624e25d32Sdan       n--;
429724e25d32Sdan     }else
429824e25d32Sdan #endif
4299257c13faSdan     if( (flags & SQLITE_ECEL_REF)!=0 && (j = pItem->u.x.iOrderByCol)>0 ){
4300257c13faSdan       if( flags & SQLITE_ECEL_OMITREF ){
4301257c13faSdan         i--;
4302257c13faSdan         n--;
4303257c13faSdan       }else{
43045579d59fSdrh         sqlite3VdbeAddOp2(v, copyOp, j+srcReg-1, target+i);
4305257c13faSdan       }
4306b8b06690Sdrh     }else if( (flags & SQLITE_ECEL_FACTOR)!=0
4307b8b06690Sdrh            && sqlite3ExprIsConstantNotJoin(pExpr)
4308b8b06690Sdrh     ){
4309ad879ffdSdrh       sqlite3ExprCodeAtInit(pParse, pExpr, target+i);
4310d1a01edaSdrh     }else{
43117445ffe2Sdrh       int inReg = sqlite3ExprCodeTarget(pParse, pExpr, target+i);
4312746fd9ccSdrh       if( inReg!=target+i ){
43134eded604Sdrh         VdbeOp *pOp;
43144eded604Sdrh         if( copyOp==OP_Copy
43154eded604Sdrh          && (pOp=sqlite3VdbeGetOp(v, -1))->opcode==OP_Copy
43164eded604Sdrh          && pOp->p1+pOp->p3+1==inReg
43174eded604Sdrh          && pOp->p2+pOp->p3+1==target+i
43184eded604Sdrh         ){
43194eded604Sdrh           pOp->p3++;
43204eded604Sdrh         }else{
43214eded604Sdrh           sqlite3VdbeAddOp2(v, copyOp, inReg, target+i);
43224eded604Sdrh         }
4323d1a01edaSdrh       }
4324d176611bSdrh     }
4325268380caSdrh   }
4326f9b596ebSdrh   return n;
4327268380caSdrh }
4328268380caSdrh 
4329268380caSdrh /*
433036c563a2Sdrh ** Generate code for a BETWEEN operator.
433136c563a2Sdrh **
433236c563a2Sdrh **    x BETWEEN y AND z
433336c563a2Sdrh **
433436c563a2Sdrh ** The above is equivalent to
433536c563a2Sdrh **
433636c563a2Sdrh **    x>=y AND x<=z
433736c563a2Sdrh **
433836c563a2Sdrh ** Code it as such, taking care to do the common subexpression
433960ec914cSpeter.d.reid ** elimination of x.
434084b19a3dSdrh **
434184b19a3dSdrh ** The xJumpIf parameter determines details:
434284b19a3dSdrh **
434384b19a3dSdrh **    NULL:                   Store the boolean result in reg[dest]
434484b19a3dSdrh **    sqlite3ExprIfTrue:      Jump to dest if true
434584b19a3dSdrh **    sqlite3ExprIfFalse:     Jump to dest if false
434684b19a3dSdrh **
434784b19a3dSdrh ** The jumpIfNull parameter is ignored if xJumpIf is NULL.
434836c563a2Sdrh */
434936c563a2Sdrh static void exprCodeBetween(
435036c563a2Sdrh   Parse *pParse,    /* Parsing and code generating context */
435136c563a2Sdrh   Expr *pExpr,      /* The BETWEEN expression */
435284b19a3dSdrh   int dest,         /* Jump destination or storage location */
435384b19a3dSdrh   void (*xJump)(Parse*,Expr*,int,int), /* Action to take */
435436c563a2Sdrh   int jumpIfNull    /* Take the jump if the BETWEEN is NULL */
435536c563a2Sdrh ){
435636c563a2Sdrh  Expr exprAnd;     /* The AND operator in  x>=y AND x<=z  */
435736c563a2Sdrh   Expr compLeft;    /* The  x>=y  term */
435836c563a2Sdrh   Expr compRight;   /* The  x<=z  term */
4359db45bd5eSdrh   Expr exprX;       /* The  x  subexpression */
4360db45bd5eSdrh   int regFree1 = 0; /* Temporary use register */
436184b19a3dSdrh 
436271c57db0Sdan   memset(&compLeft, 0, sizeof(Expr));
436371c57db0Sdan   memset(&compRight, 0, sizeof(Expr));
436471c57db0Sdan   memset(&exprAnd, 0, sizeof(Expr));
4365db45bd5eSdrh 
4366db45bd5eSdrh   assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
4367a8e05761Sdrh   exprNodeCopy(&exprX, pExpr->pLeft);
436836c563a2Sdrh   exprAnd.op = TK_AND;
436936c563a2Sdrh   exprAnd.pLeft = &compLeft;
437036c563a2Sdrh   exprAnd.pRight = &compRight;
437136c563a2Sdrh   compLeft.op = TK_GE;
4372db45bd5eSdrh   compLeft.pLeft = &exprX;
437336c563a2Sdrh   compLeft.pRight = pExpr->x.pList->a[0].pExpr;
437436c563a2Sdrh   compRight.op = TK_LE;
4375db45bd5eSdrh   compRight.pLeft = &exprX;
437636c563a2Sdrh   compRight.pRight = pExpr->x.pList->a[1].pExpr;
437712abf408Sdrh   exprToRegister(&exprX, exprCodeVector(pParse, &exprX, &regFree1));
437884b19a3dSdrh   if( xJump ){
437984b19a3dSdrh     xJump(pParse, &exprAnd, dest, jumpIfNull);
438036c563a2Sdrh   }else{
438136fd41e5Sdrh     /* Mark the expression is being from the ON or USING clause of a join
438236fd41e5Sdrh     ** so that the sqlite3ExprCodeTarget() routine will not attempt to move
438336fd41e5Sdrh     ** it into the Parse.pConstExpr list.  We should use a new bit for this,
438436fd41e5Sdrh     ** for clarity, but we are out of bits in the Expr.flags field so we
438536fd41e5Sdrh     ** have to reuse the EP_FromJoin bit.  Bummer. */
4386db45bd5eSdrh     exprX.flags |= EP_FromJoin;
438771c57db0Sdan     sqlite3ExprCodeTarget(pParse, &exprAnd, dest);
438836c563a2Sdrh   }
4389db45bd5eSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
439036c563a2Sdrh 
439136c563a2Sdrh   /* Ensure adequate test coverage */
4392db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull==0 && regFree1==0 );
4393db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull==0 && regFree1!=0 );
4394db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull!=0 && regFree1==0 );
4395db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull!=0 && regFree1!=0 );
4396db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1==0 );
4397db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1!=0 );
4398db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1==0 );
4399db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1!=0 );
440084b19a3dSdrh   testcase( xJump==0 );
440136c563a2Sdrh }
440236c563a2Sdrh 
440336c563a2Sdrh /*
4404cce7d176Sdrh ** Generate code for a boolean expression such that a jump is made
4405cce7d176Sdrh ** to the label "dest" if the expression is true but execution
4406cce7d176Sdrh ** continues straight thru if the expression is false.
4407f5905aa7Sdrh **
4408f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false), then
440935573356Sdrh ** take the jump if the jumpIfNull flag is SQLITE_JUMPIFNULL.
4410f2bc013cSdrh **
4411f2bc013cSdrh ** This code depends on the fact that certain token values (ex: TK_EQ)
4412f2bc013cSdrh ** are the same as opcode values (ex: OP_Eq) that implement the corresponding
4413f2bc013cSdrh ** operation.  Special comments in vdbe.c and the mkopcodeh.awk script in
4414f2bc013cSdrh ** the make process cause these values to align.  Assert()s in the code
4415f2bc013cSdrh ** below verify that the numbers are aligned correctly.
4416cce7d176Sdrh */
44174adee20fSdanielk1977 void sqlite3ExprIfTrue(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
4418cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
4419cce7d176Sdrh   int op = 0;
44202dcef11bSdrh   int regFree1 = 0;
44212dcef11bSdrh   int regFree2 = 0;
44222dcef11bSdrh   int r1, r2;
44232dcef11bSdrh 
442435573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
442548864df9Smistachkin   if( NEVER(v==0) )     return;  /* Existence of VDBE checked by caller */
442633cd4909Sdrh   if( NEVER(pExpr==0) ) return;  /* No way this can happen */
4427f2bc013cSdrh   op = pExpr->op;
44287b35a77bSdan   switch( op ){
442917180fcaSdrh     case TK_AND:
443017180fcaSdrh     case TK_OR: {
443117180fcaSdrh       Expr *pAlt = sqlite3ExprSimplifiedAndOr(pExpr);
443217180fcaSdrh       if( pAlt!=pExpr ){
443317180fcaSdrh         sqlite3ExprIfTrue(pParse, pAlt, dest, jumpIfNull);
443417180fcaSdrh       }else if( op==TK_AND ){
4435ec4ccdbcSdrh         int d2 = sqlite3VdbeMakeLabel(pParse);
4436c5499befSdrh         testcase( jumpIfNull==0 );
443717180fcaSdrh         sqlite3ExprIfFalse(pParse, pExpr->pLeft, d2,
443817180fcaSdrh                            jumpIfNull^SQLITE_JUMPIFNULL);
44394adee20fSdanielk1977         sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
44404adee20fSdanielk1977         sqlite3VdbeResolveLabel(v, d2);
444117180fcaSdrh       }else{
4442c5499befSdrh         testcase( jumpIfNull==0 );
44434adee20fSdanielk1977         sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
44444adee20fSdanielk1977         sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
444517180fcaSdrh       }
4446cce7d176Sdrh       break;
4447cce7d176Sdrh     }
4448cce7d176Sdrh     case TK_NOT: {
4449c5499befSdrh       testcase( jumpIfNull==0 );
44504adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
4451cce7d176Sdrh       break;
4452cce7d176Sdrh     }
44538abed7b9Sdrh     case TK_TRUTH: {
445496acafbeSdrh       int isNot;      /* IS NOT TRUE or IS NOT FALSE */
445596acafbeSdrh       int isTrue;     /* IS TRUE or IS NOT TRUE */
4456007c843bSdrh       testcase( jumpIfNull==0 );
44578abed7b9Sdrh       isNot = pExpr->op2==TK_ISNOT;
445896acafbeSdrh       isTrue = sqlite3ExprTruthValue(pExpr->pRight);
445943c4ac8bSdrh       testcase( isTrue && isNot );
446096acafbeSdrh       testcase( !isTrue && isNot );
446143c4ac8bSdrh       if( isTrue ^ isNot ){
44628abed7b9Sdrh         sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
44638abed7b9Sdrh                           isNot ? SQLITE_JUMPIFNULL : 0);
44648abed7b9Sdrh       }else{
44658abed7b9Sdrh         sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
44668abed7b9Sdrh                            isNot ? SQLITE_JUMPIFNULL : 0);
44678abed7b9Sdrh       }
4468007c843bSdrh       break;
4469007c843bSdrh     }
4470de845c2fSdrh     case TK_IS:
4471de845c2fSdrh     case TK_ISNOT:
4472de845c2fSdrh       testcase( op==TK_IS );
4473de845c2fSdrh       testcase( op==TK_ISNOT );
4474de845c2fSdrh       op = (op==TK_IS) ? TK_EQ : TK_NE;
4475de845c2fSdrh       jumpIfNull = SQLITE_NULLEQ;
4476de845c2fSdrh       /* Fall thru */
4477cce7d176Sdrh     case TK_LT:
4478cce7d176Sdrh     case TK_LE:
4479cce7d176Sdrh     case TK_GT:
4480cce7d176Sdrh     case TK_GE:
4481cce7d176Sdrh     case TK_NE:
44820ac65892Sdrh     case TK_EQ: {
4483625015e0Sdan       if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
4484c5499befSdrh       testcase( jumpIfNull==0 );
4485b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4486b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
448735573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
44882dcef11bSdrh                   r1, r2, dest, jumpIfNull);
44897d176105Sdrh       assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
44907d176105Sdrh       assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
44917d176105Sdrh       assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
44927d176105Sdrh       assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
4493de845c2fSdrh       assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4494de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4495de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4496de845c2fSdrh       assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4497de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
4498de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
44996a2fe093Sdrh       testcase( regFree1==0 );
45006a2fe093Sdrh       testcase( regFree2==0 );
45016a2fe093Sdrh       break;
45026a2fe093Sdrh     }
4503cce7d176Sdrh     case TK_ISNULL:
4504cce7d176Sdrh     case TK_NOTNULL: {
45057d176105Sdrh       assert( TK_ISNULL==OP_IsNull );   testcase( op==TK_ISNULL );
45067d176105Sdrh       assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
45072dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
45082dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
45097d176105Sdrh       VdbeCoverageIf(v, op==TK_ISNULL);
45107d176105Sdrh       VdbeCoverageIf(v, op==TK_NOTNULL);
4511c5499befSdrh       testcase( regFree1==0 );
4512cce7d176Sdrh       break;
4513cce7d176Sdrh     }
4514fef5208cSdrh     case TK_BETWEEN: {
45155c03f30aSdrh       testcase( jumpIfNull==0 );
451671c57db0Sdan       exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfTrue, jumpIfNull);
4517fef5208cSdrh       break;
4518fef5208cSdrh     }
4519bb201344Sshaneh #ifndef SQLITE_OMIT_SUBQUERY
4520e3365e6cSdrh     case TK_IN: {
4521ec4ccdbcSdrh       int destIfFalse = sqlite3VdbeMakeLabel(pParse);
4522e3365e6cSdrh       int destIfNull = jumpIfNull ? dest : destIfFalse;
4523e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
4524076e85f5Sdrh       sqlite3VdbeGoto(v, dest);
4525e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
4526e3365e6cSdrh       break;
4527e3365e6cSdrh     }
4528bb201344Sshaneh #endif
4529cce7d176Sdrh     default: {
45307b35a77bSdan     default_expr:
4531ad31727fSdrh       if( ExprAlwaysTrue(pExpr) ){
4532076e85f5Sdrh         sqlite3VdbeGoto(v, dest);
4533ad31727fSdrh       }else if( ExprAlwaysFalse(pExpr) ){
4534991a1985Sdrh         /* No-op */
4535991a1985Sdrh       }else{
45362dcef11bSdrh         r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
45372dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_If, r1, dest, jumpIfNull!=0);
4538688852abSdrh         VdbeCoverage(v);
4539c5499befSdrh         testcase( regFree1==0 );
4540c5499befSdrh         testcase( jumpIfNull==0 );
4541991a1985Sdrh       }
4542cce7d176Sdrh       break;
4543cce7d176Sdrh     }
4544cce7d176Sdrh   }
45452dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
45462dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
4547cce7d176Sdrh }
4548cce7d176Sdrh 
4549cce7d176Sdrh /*
455066b89c8fSdrh ** Generate code for a boolean expression such that a jump is made
4551cce7d176Sdrh ** to the label "dest" if the expression is false but execution
4552cce7d176Sdrh ** continues straight thru if the expression is true.
4553f5905aa7Sdrh **
4554f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false) then
455535573356Sdrh ** jump if jumpIfNull is SQLITE_JUMPIFNULL or fall through if jumpIfNull
455635573356Sdrh ** is 0.
4557cce7d176Sdrh */
45584adee20fSdanielk1977 void sqlite3ExprIfFalse(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
4559cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
4560cce7d176Sdrh   int op = 0;
45612dcef11bSdrh   int regFree1 = 0;
45622dcef11bSdrh   int regFree2 = 0;
45632dcef11bSdrh   int r1, r2;
45642dcef11bSdrh 
456535573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
456648864df9Smistachkin   if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
456733cd4909Sdrh   if( pExpr==0 )    return;
4568f2bc013cSdrh 
4569f2bc013cSdrh   /* The value of pExpr->op and op are related as follows:
4570f2bc013cSdrh   **
4571f2bc013cSdrh   **       pExpr->op            op
4572f2bc013cSdrh   **       ---------          ----------
4573f2bc013cSdrh   **       TK_ISNULL          OP_NotNull
4574f2bc013cSdrh   **       TK_NOTNULL         OP_IsNull
4575f2bc013cSdrh   **       TK_NE              OP_Eq
4576f2bc013cSdrh   **       TK_EQ              OP_Ne
4577f2bc013cSdrh   **       TK_GT              OP_Le
4578f2bc013cSdrh   **       TK_LE              OP_Gt
4579f2bc013cSdrh   **       TK_GE              OP_Lt
4580f2bc013cSdrh   **       TK_LT              OP_Ge
4581f2bc013cSdrh   **
4582f2bc013cSdrh   ** For other values of pExpr->op, op is undefined and unused.
4583f2bc013cSdrh   ** The value of TK_ and OP_ constants are arranged such that we
4584f2bc013cSdrh   ** can compute the mapping above using the following expression.
4585f2bc013cSdrh   ** Assert()s verify that the computation is correct.
4586f2bc013cSdrh   */
4587f2bc013cSdrh   op = ((pExpr->op+(TK_ISNULL&1))^1)-(TK_ISNULL&1);
4588f2bc013cSdrh 
4589f2bc013cSdrh   /* Verify correct alignment of TK_ and OP_ constants
4590f2bc013cSdrh   */
4591f2bc013cSdrh   assert( pExpr->op!=TK_ISNULL || op==OP_NotNull );
4592f2bc013cSdrh   assert( pExpr->op!=TK_NOTNULL || op==OP_IsNull );
4593f2bc013cSdrh   assert( pExpr->op!=TK_NE || op==OP_Eq );
4594f2bc013cSdrh   assert( pExpr->op!=TK_EQ || op==OP_Ne );
4595f2bc013cSdrh   assert( pExpr->op!=TK_LT || op==OP_Ge );
4596f2bc013cSdrh   assert( pExpr->op!=TK_LE || op==OP_Gt );
4597f2bc013cSdrh   assert( pExpr->op!=TK_GT || op==OP_Le );
4598f2bc013cSdrh   assert( pExpr->op!=TK_GE || op==OP_Lt );
4599f2bc013cSdrh 
4600ba00e30aSdan   switch( pExpr->op ){
460117180fcaSdrh     case TK_AND:
460217180fcaSdrh     case TK_OR: {
460317180fcaSdrh       Expr *pAlt = sqlite3ExprSimplifiedAndOr(pExpr);
460417180fcaSdrh       if( pAlt!=pExpr ){
460517180fcaSdrh         sqlite3ExprIfFalse(pParse, pAlt, dest, jumpIfNull);
460617180fcaSdrh       }else if( pExpr->op==TK_AND ){
4607c5499befSdrh         testcase( jumpIfNull==0 );
46084adee20fSdanielk1977         sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
46094adee20fSdanielk1977         sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
461017180fcaSdrh       }else{
4611ec4ccdbcSdrh         int d2 = sqlite3VdbeMakeLabel(pParse);
4612c5499befSdrh         testcase( jumpIfNull==0 );
461317180fcaSdrh         sqlite3ExprIfTrue(pParse, pExpr->pLeft, d2,
461417180fcaSdrh                           jumpIfNull^SQLITE_JUMPIFNULL);
46154adee20fSdanielk1977         sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
46164adee20fSdanielk1977         sqlite3VdbeResolveLabel(v, d2);
461717180fcaSdrh       }
4618cce7d176Sdrh       break;
4619cce7d176Sdrh     }
4620cce7d176Sdrh     case TK_NOT: {
46215c03f30aSdrh       testcase( jumpIfNull==0 );
46224adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
4623cce7d176Sdrh       break;
4624cce7d176Sdrh     }
46258abed7b9Sdrh     case TK_TRUTH: {
462696acafbeSdrh       int isNot;   /* IS NOT TRUE or IS NOT FALSE */
462796acafbeSdrh       int isTrue;  /* IS TRUE or IS NOT TRUE */
46288abed7b9Sdrh       testcase( jumpIfNull==0 );
46298abed7b9Sdrh       isNot = pExpr->op2==TK_ISNOT;
463096acafbeSdrh       isTrue = sqlite3ExprTruthValue(pExpr->pRight);
463143c4ac8bSdrh       testcase( isTrue && isNot );
463296acafbeSdrh       testcase( !isTrue && isNot );
463343c4ac8bSdrh       if( isTrue ^ isNot ){
46348abed7b9Sdrh         /* IS TRUE and IS NOT FALSE */
46358abed7b9Sdrh         sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
46368abed7b9Sdrh                            isNot ? 0 : SQLITE_JUMPIFNULL);
46378abed7b9Sdrh 
46388abed7b9Sdrh       }else{
46398abed7b9Sdrh         /* IS FALSE and IS NOT TRUE */
46408abed7b9Sdrh         sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
46418abed7b9Sdrh                           isNot ? 0 : SQLITE_JUMPIFNULL);
46428abed7b9Sdrh       }
4643007c843bSdrh       break;
4644007c843bSdrh     }
4645de845c2fSdrh     case TK_IS:
4646de845c2fSdrh     case TK_ISNOT:
4647de845c2fSdrh       testcase( pExpr->op==TK_IS );
4648de845c2fSdrh       testcase( pExpr->op==TK_ISNOT );
4649de845c2fSdrh       op = (pExpr->op==TK_IS) ? TK_NE : TK_EQ;
4650de845c2fSdrh       jumpIfNull = SQLITE_NULLEQ;
4651de845c2fSdrh       /* Fall thru */
4652cce7d176Sdrh     case TK_LT:
4653cce7d176Sdrh     case TK_LE:
4654cce7d176Sdrh     case TK_GT:
4655cce7d176Sdrh     case TK_GE:
4656cce7d176Sdrh     case TK_NE:
4657cce7d176Sdrh     case TK_EQ: {
4658625015e0Sdan       if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
4659c5499befSdrh       testcase( jumpIfNull==0 );
4660b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4661b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
466235573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
46632dcef11bSdrh                   r1, r2, dest, jumpIfNull);
46647d176105Sdrh       assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
46657d176105Sdrh       assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
46667d176105Sdrh       assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
46677d176105Sdrh       assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
4668de845c2fSdrh       assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4669de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4670de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4671de845c2fSdrh       assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4672de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
4673de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
46746a2fe093Sdrh       testcase( regFree1==0 );
46756a2fe093Sdrh       testcase( regFree2==0 );
46766a2fe093Sdrh       break;
46776a2fe093Sdrh     }
4678cce7d176Sdrh     case TK_ISNULL:
4679cce7d176Sdrh     case TK_NOTNULL: {
46802dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
46812dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
46827d176105Sdrh       testcase( op==TK_ISNULL );   VdbeCoverageIf(v, op==TK_ISNULL);
46837d176105Sdrh       testcase( op==TK_NOTNULL );  VdbeCoverageIf(v, op==TK_NOTNULL);
4684c5499befSdrh       testcase( regFree1==0 );
4685cce7d176Sdrh       break;
4686cce7d176Sdrh     }
4687fef5208cSdrh     case TK_BETWEEN: {
46885c03f30aSdrh       testcase( jumpIfNull==0 );
468971c57db0Sdan       exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfFalse, jumpIfNull);
4690fef5208cSdrh       break;
4691fef5208cSdrh     }
4692bb201344Sshaneh #ifndef SQLITE_OMIT_SUBQUERY
4693e3365e6cSdrh     case TK_IN: {
4694e3365e6cSdrh       if( jumpIfNull ){
4695e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, dest);
4696e3365e6cSdrh       }else{
4697ec4ccdbcSdrh         int destIfNull = sqlite3VdbeMakeLabel(pParse);
4698e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, destIfNull);
4699e3365e6cSdrh         sqlite3VdbeResolveLabel(v, destIfNull);
4700e3365e6cSdrh       }
4701e3365e6cSdrh       break;
4702e3365e6cSdrh     }
4703bb201344Sshaneh #endif
4704cce7d176Sdrh     default: {
4705ba00e30aSdan     default_expr:
4706ad31727fSdrh       if( ExprAlwaysFalse(pExpr) ){
4707076e85f5Sdrh         sqlite3VdbeGoto(v, dest);
4708ad31727fSdrh       }else if( ExprAlwaysTrue(pExpr) ){
4709991a1985Sdrh         /* no-op */
4710991a1985Sdrh       }else{
47112dcef11bSdrh         r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
47122dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_IfNot, r1, dest, jumpIfNull!=0);
4713688852abSdrh         VdbeCoverage(v);
4714c5499befSdrh         testcase( regFree1==0 );
4715c5499befSdrh         testcase( jumpIfNull==0 );
4716991a1985Sdrh       }
4717cce7d176Sdrh       break;
4718cce7d176Sdrh     }
4719cce7d176Sdrh   }
47202dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
47212dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
4722cce7d176Sdrh }
47232282792aSdrh 
47242282792aSdrh /*
472572bc8208Sdrh ** Like sqlite3ExprIfFalse() except that a copy is made of pExpr before
472672bc8208Sdrh ** code generation, and that copy is deleted after code generation. This
472772bc8208Sdrh ** ensures that the original pExpr is unchanged.
472872bc8208Sdrh */
472972bc8208Sdrh void sqlite3ExprIfFalseDup(Parse *pParse, Expr *pExpr, int dest,int jumpIfNull){
473072bc8208Sdrh   sqlite3 *db = pParse->db;
473172bc8208Sdrh   Expr *pCopy = sqlite3ExprDup(db, pExpr, 0);
473272bc8208Sdrh   if( db->mallocFailed==0 ){
473372bc8208Sdrh     sqlite3ExprIfFalse(pParse, pCopy, dest, jumpIfNull);
473472bc8208Sdrh   }
473572bc8208Sdrh   sqlite3ExprDelete(db, pCopy);
473672bc8208Sdrh }
473772bc8208Sdrh 
47385aa550cfSdan /*
47395aa550cfSdan ** Expression pVar is guaranteed to be an SQL variable. pExpr may be any
47405aa550cfSdan ** type of expression.
47415aa550cfSdan **
47425aa550cfSdan ** If pExpr is a simple SQL value - an integer, real, string, blob
47435aa550cfSdan ** or NULL value - then the VDBE currently being prepared is configured
47445aa550cfSdan ** to re-prepare each time a new value is bound to variable pVar.
47455aa550cfSdan **
47465aa550cfSdan ** Additionally, if pExpr is a simple SQL value and the value is the
47475aa550cfSdan ** same as that currently bound to variable pVar, non-zero is returned.
47485aa550cfSdan ** Otherwise, if the values are not the same or if pExpr is not a simple
47495aa550cfSdan ** SQL value, zero is returned.
47505aa550cfSdan */
47515aa550cfSdan static int exprCompareVariable(Parse *pParse, Expr *pVar, Expr *pExpr){
47525aa550cfSdan   int res = 0;
4753c0804226Sdrh   int iVar;
4754c0804226Sdrh   sqlite3_value *pL, *pR = 0;
47555aa550cfSdan 
47565aa550cfSdan   sqlite3ValueFromExpr(pParse->db, pExpr, SQLITE_UTF8, SQLITE_AFF_BLOB, &pR);
4757c0804226Sdrh   if( pR ){
4758c0804226Sdrh     iVar = pVar->iColumn;
4759c0804226Sdrh     sqlite3VdbeSetVarmask(pParse->pVdbe, iVar);
4760c0804226Sdrh     pL = sqlite3VdbeGetBoundValue(pParse->pReprepare, iVar, SQLITE_AFF_BLOB);
47615aa307e2Sdrh     if( pL ){
47625aa307e2Sdrh       if( sqlite3_value_type(pL)==SQLITE_TEXT ){
47635aa307e2Sdrh         sqlite3_value_text(pL); /* Make sure the encoding is UTF-8 */
47645aa307e2Sdrh       }
47655aa307e2Sdrh       res =  0==sqlite3MemCompare(pL, pR, 0);
47665aa550cfSdan     }
47675aa550cfSdan     sqlite3ValueFree(pR);
47685aa550cfSdan     sqlite3ValueFree(pL);
47695aa550cfSdan   }
47705aa550cfSdan 
47715aa550cfSdan   return res;
47725aa550cfSdan }
477372bc8208Sdrh 
477472bc8208Sdrh /*
47751d9da70aSdrh ** Do a deep comparison of two expression trees.  Return 0 if the two
47761d9da70aSdrh ** expressions are completely identical.  Return 1 if they differ only
47771d9da70aSdrh ** by a COLLATE operator at the top level.  Return 2 if there are differences
47781d9da70aSdrh ** other than the top-level COLLATE operator.
4779d40aab0eSdrh **
4780619a1305Sdrh ** If any subelement of pB has Expr.iTable==(-1) then it is allowed
4781619a1305Sdrh ** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
4782619a1305Sdrh **
478366518ca7Sdrh ** The pA side might be using TK_REGISTER.  If that is the case and pB is
478466518ca7Sdrh ** not using TK_REGISTER but is otherwise equivalent, then still return 0.
478566518ca7Sdrh **
47861d9da70aSdrh ** Sometimes this routine will return 2 even if the two expressions
4787d40aab0eSdrh ** really are equivalent.  If we cannot prove that the expressions are
47881d9da70aSdrh ** identical, we return 2 just to be safe.  So if this routine
47891d9da70aSdrh ** returns 2, then you do not really know for certain if the two
47901d9da70aSdrh ** expressions are the same.  But if you get a 0 or 1 return, then you
4791d40aab0eSdrh ** can be sure the expressions are the same.  In the places where
47921d9da70aSdrh ** this routine is used, it does not hurt to get an extra 2 - that
4793d40aab0eSdrh ** just might result in some slightly slower code.  But returning
47941d9da70aSdrh ** an incorrect 0 or 1 could lead to a malfunction.
47955aa550cfSdan **
4796c0804226Sdrh ** If pParse is not NULL then TK_VARIABLE terms in pA with bindings in
4797c0804226Sdrh ** pParse->pReprepare can be matched against literals in pB.  The
4798c0804226Sdrh ** pParse->pVdbe->expmask bitmask is updated for each variable referenced.
4799c0804226Sdrh ** If pParse is NULL (the normal case) then any TK_VARIABLE term in
4800c0804226Sdrh ** Argument pParse should normally be NULL. If it is not NULL and pA or
4801c0804226Sdrh ** pB causes a return value of 2.
48022282792aSdrh */
48035aa550cfSdan int sqlite3ExprCompare(Parse *pParse, Expr *pA, Expr *pB, int iTab){
480410d1edf0Sdrh   u32 combinedFlags;
48054b202ae2Sdanielk1977   if( pA==0 || pB==0 ){
48061d9da70aSdrh     return pB==pA ? 0 : 2;
48072282792aSdrh   }
48085aa550cfSdan   if( pParse && pA->op==TK_VARIABLE && exprCompareVariable(pParse, pA, pB) ){
48095aa550cfSdan     return 0;
48105aa550cfSdan   }
481110d1edf0Sdrh   combinedFlags = pA->flags | pB->flags;
481210d1edf0Sdrh   if( combinedFlags & EP_IntValue ){
481310d1edf0Sdrh     if( (pA->flags&pB->flags&EP_IntValue)!=0 && pA->u.iValue==pB->u.iValue ){
481410d1edf0Sdrh       return 0;
481510d1edf0Sdrh     }
48161d9da70aSdrh     return 2;
48176ab3a2ecSdanielk1977   }
481816dd3985Sdan   if( pA->op!=pB->op || pA->op==TK_RAISE ){
48195aa550cfSdan     if( pA->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA->pLeft,pB,iTab)<2 ){
4820ae80ddeaSdrh       return 1;
4821ae80ddeaSdrh     }
48225aa550cfSdan     if( pB->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA,pB->pLeft,iTab)<2 ){
4823ae80ddeaSdrh       return 1;
4824ae80ddeaSdrh     }
4825ae80ddeaSdrh     return 2;
4826ae80ddeaSdrh   }
48272edc5fd7Sdrh   if( pA->op!=TK_COLUMN && pA->op!=TK_AGG_COLUMN && pA->u.zToken ){
4828390b88a4Sdrh     if( pA->op==TK_FUNCTION ){
4829390b88a4Sdrh       if( sqlite3StrICmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
4830eda079cdSdrh #ifndef SQLITE_OMIT_WINDOWFUNC
4831eda079cdSdrh       /* Justification for the assert():
4832eda079cdSdrh       ** window functions have p->op==TK_FUNCTION but aggregate functions
4833eda079cdSdrh       ** have p->op==TK_AGG_FUNCTION.  So any comparison between an aggregate
4834eda079cdSdrh       ** function and a window function should have failed before reaching
4835eda079cdSdrh       ** this point.  And, it is not possible to have a window function and
4836eda079cdSdrh       ** a scalar function with the same name and number of arguments.  So
4837eda079cdSdrh       ** if we reach this point, either A and B both window functions or
4838eda079cdSdrh       ** neither are a window functions. */
4839eda079cdSdrh       assert( ExprHasProperty(pA,EP_WinFunc)==ExprHasProperty(pB,EP_WinFunc) );
4840eda079cdSdrh       if( ExprHasProperty(pA,EP_WinFunc) ){
4841eda079cdSdrh         if( sqlite3WindowCompare(pParse,pA->y.pWin,pB->y.pWin)!=0 ) return 2;
4842eda079cdSdrh       }
4843eda079cdSdrh #endif
4844f20bbc5fSdrh     }else if( pA->op==TK_NULL ){
4845f20bbc5fSdrh       return 0;
4846d5af5420Sdrh     }else if( pA->op==TK_COLLATE ){
4847e79f6299Sdrh       if( sqlite3_stricmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
4848f20bbc5fSdrh     }else if( ALWAYS(pB->u.zToken!=0) && strcmp(pA->u.zToken,pB->u.zToken)!=0 ){
4849d5af5420Sdrh       return 2;
485010d1edf0Sdrh     }
485110d1edf0Sdrh   }
485210d1edf0Sdrh   if( (pA->flags & EP_Distinct)!=(pB->flags & EP_Distinct) ) return 2;
485389b6de03Sdrh   if( (combinedFlags & EP_TokenOnly)==0 ){
485410d1edf0Sdrh     if( combinedFlags & EP_xIsSelect ) return 2;
4855efad2e23Sdrh     if( (combinedFlags & EP_FixedCol)==0
4856efad2e23Sdrh      && sqlite3ExprCompare(pParse, pA->pLeft, pB->pLeft, iTab) ) return 2;
48575aa550cfSdan     if( sqlite3ExprCompare(pParse, pA->pRight, pB->pRight, iTab) ) return 2;
4858619a1305Sdrh     if( sqlite3ExprListCompare(pA->x.pList, pB->x.pList, iTab) ) return 2;
485903c5c213Sdrh     if( pA->op!=TK_STRING
486003c5c213Sdrh      && pA->op!=TK_TRUEFALSE
486103c5c213Sdrh      && (combinedFlags & EP_Reduced)==0
486203c5c213Sdrh     ){
4863619a1305Sdrh       if( pA->iColumn!=pB->iColumn ) return 2;
486466518ca7Sdrh       if( pA->iTable!=pB->iTable
486585f8aa79Sdrh        && (pA->iTable!=iTab || NEVER(pB->iTable>=0)) ) return 2;
48661d9da70aSdrh     }
48671d9da70aSdrh   }
48682646da7eSdrh   return 0;
48692646da7eSdrh }
48702282792aSdrh 
48718c6f666bSdrh /*
48728c6f666bSdrh ** Compare two ExprList objects.  Return 0 if they are identical and
48738c6f666bSdrh ** non-zero if they differ in any way.
48748c6f666bSdrh **
4875619a1305Sdrh ** If any subelement of pB has Expr.iTable==(-1) then it is allowed
4876619a1305Sdrh ** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
4877619a1305Sdrh **
48788c6f666bSdrh ** This routine might return non-zero for equivalent ExprLists.  The
48798c6f666bSdrh ** only consequence will be disabled optimizations.  But this routine
48808c6f666bSdrh ** must never return 0 if the two ExprList objects are different, or
48818c6f666bSdrh ** a malfunction will result.
48828c6f666bSdrh **
48838c6f666bSdrh ** Two NULL pointers are considered to be the same.  But a NULL pointer
48848c6f666bSdrh ** always differs from a non-NULL pointer.
48858c6f666bSdrh */
4886619a1305Sdrh int sqlite3ExprListCompare(ExprList *pA, ExprList *pB, int iTab){
48878c6f666bSdrh   int i;
48888c6f666bSdrh   if( pA==0 && pB==0 ) return 0;
48898c6f666bSdrh   if( pA==0 || pB==0 ) return 1;
48908c6f666bSdrh   if( pA->nExpr!=pB->nExpr ) return 1;
48918c6f666bSdrh   for(i=0; i<pA->nExpr; i++){
48928c6f666bSdrh     Expr *pExprA = pA->a[i].pExpr;
48938c6f666bSdrh     Expr *pExprB = pB->a[i].pExpr;
48948c6f666bSdrh     if( pA->a[i].sortOrder!=pB->a[i].sortOrder ) return 1;
48955aa550cfSdan     if( sqlite3ExprCompare(0, pExprA, pExprB, iTab) ) return 1;
48968c6f666bSdrh   }
48978c6f666bSdrh   return 0;
48988c6f666bSdrh }
489913449892Sdrh 
49002282792aSdrh /*
4901f9463dfbSdrh ** Like sqlite3ExprCompare() except COLLATE operators at the top-level
4902f9463dfbSdrh ** are ignored.
4903f9463dfbSdrh */
4904f9463dfbSdrh int sqlite3ExprCompareSkip(Expr *pA, Expr *pB, int iTab){
49055aa550cfSdan   return sqlite3ExprCompare(0,
4906f9463dfbSdrh              sqlite3ExprSkipCollate(pA),
4907f9463dfbSdrh              sqlite3ExprSkipCollate(pB),
4908f9463dfbSdrh              iTab);
4909f9463dfbSdrh }
4910f9463dfbSdrh 
4911f9463dfbSdrh /*
4912*c51cf864Sdrh ** Return non-zero if Expr p can only be true if pNN is not NULL.
4913*c51cf864Sdrh */
4914*c51cf864Sdrh static int exprImpliesNotNull(
4915*c51cf864Sdrh   Parse *pParse,      /* Parsing context */
4916*c51cf864Sdrh   Expr *p,            /* The expression to be checked */
4917*c51cf864Sdrh   Expr *pNN,          /* The expression that is NOT NULL */
4918*c51cf864Sdrh   int iTab,           /* Table being evaluated */
4919*c51cf864Sdrh   int seenNot         /* True if p is an operand of NOT */
4920*c51cf864Sdrh ){
4921*c51cf864Sdrh   assert( p );
4922*c51cf864Sdrh   assert( pNN );
4923*c51cf864Sdrh   if( sqlite3ExprCompare(pParse, p, pNN, iTab)==0 ) return 1;
4924*c51cf864Sdrh   switch( p->op ){
4925*c51cf864Sdrh     case TK_IN: {
4926*c51cf864Sdrh       if( seenNot && ExprHasProperty(p, EP_xIsSelect) ) return 0;
4927*c51cf864Sdrh       assert( ExprHasProperty(p,EP_xIsSelect)
4928*c51cf864Sdrh            || (p->x.pList!=0 && p->x.pList->nExpr>0) );
4929*c51cf864Sdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, seenNot);
4930*c51cf864Sdrh     }
4931*c51cf864Sdrh     case TK_BETWEEN: {
4932*c51cf864Sdrh       ExprList *pList = p->x.pList;
4933*c51cf864Sdrh       assert( pList!=0 );
4934*c51cf864Sdrh       assert( pList->nExpr==2 );
4935*c51cf864Sdrh       if( seenNot ) return 0;
4936*c51cf864Sdrh       if( exprImpliesNotNull(pParse, pList->a[0].pExpr, pNN, iTab, seenNot)
4937*c51cf864Sdrh        || exprImpliesNotNull(pParse, pList->a[1].pExpr, pNN, iTab, seenNot)
4938*c51cf864Sdrh       ){
4939*c51cf864Sdrh         return 1;
4940*c51cf864Sdrh       }
4941*c51cf864Sdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, seenNot);
4942*c51cf864Sdrh     }
4943*c51cf864Sdrh     case TK_EQ:
4944*c51cf864Sdrh     case TK_NE:
4945*c51cf864Sdrh     case TK_LT:
4946*c51cf864Sdrh     case TK_LE:
4947*c51cf864Sdrh     case TK_GT:
4948*c51cf864Sdrh     case TK_GE:
4949*c51cf864Sdrh     case TK_PLUS:
4950*c51cf864Sdrh     case TK_MINUS:
4951*c51cf864Sdrh     case TK_STAR:
4952*c51cf864Sdrh     case TK_REM:
4953*c51cf864Sdrh     case TK_BITAND:
4954*c51cf864Sdrh     case TK_BITOR:
4955*c51cf864Sdrh     case TK_SLASH:
4956*c51cf864Sdrh     case TK_LSHIFT:
4957*c51cf864Sdrh     case TK_RSHIFT:
4958*c51cf864Sdrh     case TK_CONCAT: {
4959*c51cf864Sdrh       if( exprImpliesNotNull(pParse, p->pRight, pNN, iTab, seenNot) ) return 1;
4960*c51cf864Sdrh       /* Fall thru into the next case */
4961*c51cf864Sdrh     }
4962*c51cf864Sdrh     case TK_SPAN:
4963*c51cf864Sdrh     case TK_COLLATE:
4964*c51cf864Sdrh     case TK_BITNOT:
4965*c51cf864Sdrh     case TK_UPLUS:
4966*c51cf864Sdrh     case TK_UMINUS: {
4967*c51cf864Sdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, seenNot);
4968*c51cf864Sdrh     }
4969*c51cf864Sdrh     case TK_TRUTH: {
4970*c51cf864Sdrh       if( seenNot ) return 0;
4971*c51cf864Sdrh       if( p->op2!=TK_IS ) return 0;
4972*c51cf864Sdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, seenNot);
4973*c51cf864Sdrh     }
4974*c51cf864Sdrh     case TK_NOT: {
4975*c51cf864Sdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
4976*c51cf864Sdrh     }
4977*c51cf864Sdrh   }
4978*c51cf864Sdrh   return 0;
4979*c51cf864Sdrh }
4980*c51cf864Sdrh 
4981*c51cf864Sdrh /*
49824bd5f73fSdrh ** Return true if we can prove the pE2 will always be true if pE1 is
49834bd5f73fSdrh ** true.  Return false if we cannot complete the proof or if pE2 might
49844bd5f73fSdrh ** be false.  Examples:
49854bd5f73fSdrh **
4986619a1305Sdrh **     pE1: x==5       pE2: x==5             Result: true
49874bd5f73fSdrh **     pE1: x>0        pE2: x==5             Result: false
4988619a1305Sdrh **     pE1: x=21       pE2: x=21 OR y=43     Result: true
49894bd5f73fSdrh **     pE1: x!=123     pE2: x IS NOT NULL    Result: true
4990619a1305Sdrh **     pE1: x!=?1      pE2: x IS NOT NULL    Result: true
4991619a1305Sdrh **     pE1: x IS NULL  pE2: x IS NOT NULL    Result: false
4992619a1305Sdrh **     pE1: x IS ?2    pE2: x IS NOT NULL    Reuslt: false
49934bd5f73fSdrh **
49944bd5f73fSdrh ** When comparing TK_COLUMN nodes between pE1 and pE2, if pE2 has
49954bd5f73fSdrh ** Expr.iTable<0 then assume a table number given by iTab.
49964bd5f73fSdrh **
4997c0804226Sdrh ** If pParse is not NULL, then the values of bound variables in pE1 are
4998c0804226Sdrh ** compared against literal values in pE2 and pParse->pVdbe->expmask is
4999c0804226Sdrh ** modified to record which bound variables are referenced.  If pParse
5000c0804226Sdrh ** is NULL, then false will be returned if pE1 contains any bound variables.
5001c0804226Sdrh **
50024bd5f73fSdrh ** When in doubt, return false.  Returning true might give a performance
50034bd5f73fSdrh ** improvement.  Returning false might cause a performance reduction, but
50044bd5f73fSdrh ** it will always give the correct answer and is hence always safe.
50054bd5f73fSdrh */
50065aa550cfSdan int sqlite3ExprImpliesExpr(Parse *pParse, Expr *pE1, Expr *pE2, int iTab){
50075aa550cfSdan   if( sqlite3ExprCompare(pParse, pE1, pE2, iTab)==0 ){
5008619a1305Sdrh     return 1;
5009619a1305Sdrh   }
5010619a1305Sdrh   if( pE2->op==TK_OR
50115aa550cfSdan    && (sqlite3ExprImpliesExpr(pParse, pE1, pE2->pLeft, iTab)
50125aa550cfSdan              || sqlite3ExprImpliesExpr(pParse, pE1, pE2->pRight, iTab) )
5013619a1305Sdrh   ){
5014619a1305Sdrh     return 1;
5015619a1305Sdrh   }
5016664d6d13Sdrh   if( pE2->op==TK_NOTNULL
5017*c51cf864Sdrh    && exprImpliesNotNull(pParse, pE1, pE2->pLeft, iTab, 0)
5018664d6d13Sdrh   ){
5019*c51cf864Sdrh     return 1;
5020619a1305Sdrh   }
5021619a1305Sdrh   return 0;
50224bd5f73fSdrh }
50234bd5f73fSdrh 
50244bd5f73fSdrh /*
50252589787cSdrh ** This is the Expr node callback for sqlite3ExprImpliesNotNullRow().
50262589787cSdrh ** If the expression node requires that the table at pWalker->iCur
5027f8937f90Sdrh ** have one or more non-NULL column, then set pWalker->eCode to 1 and abort.
5028f8937f90Sdrh **
5029f8937f90Sdrh ** This routine controls an optimization.  False positives (setting
5030f8937f90Sdrh ** pWalker->eCode to 1 when it should not be) are deadly, but false-negatives
5031f8937f90Sdrh ** (never setting pWalker->eCode) is a harmless missed optimization.
50322589787cSdrh */
50332589787cSdrh static int impliesNotNullRow(Walker *pWalker, Expr *pExpr){
5034f8937f90Sdrh   testcase( pExpr->op==TK_AGG_COLUMN );
5035821b610bSdrh   testcase( pExpr->op==TK_AGG_FUNCTION );
50362589787cSdrh   if( ExprHasProperty(pExpr, EP_FromJoin) ) return WRC_Prune;
50372589787cSdrh   switch( pExpr->op ){
50380493222fSdan     case TK_ISNOT:
5039a1054dccSdan     case TK_NOT:
50402589787cSdrh     case TK_ISNULL:
5041d5793672Sdrh     case TK_NOTNULL:
50422589787cSdrh     case TK_IS:
50432589787cSdrh     case TK_OR:
50442c492061Sdrh     case TK_CASE:
5045e3eff266Sdrh     case TK_IN:
50462589787cSdrh     case TK_FUNCTION:
50470493222fSdan       testcase( pExpr->op==TK_ISNOT );
50480493222fSdan       testcase( pExpr->op==TK_NOT );
5049821b610bSdrh       testcase( pExpr->op==TK_ISNULL );
5050d5793672Sdrh       testcase( pExpr->op==TK_NOTNULL );
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 );
5079eda079cdSdrh       if( (pExpr->pLeft->op==TK_COLUMN && IsVirtual(pExpr->pLeft->y.pTab))
5080eda079cdSdrh        || (pExpr->pRight->op==TK_COLUMN && IsVirtual(pExpr->pRight->y.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;
5113d6db6598Sdrh   p = sqlite3ExprSkipCollate(p);
5114d6db6598Sdrh   while( p ){
5115d6db6598Sdrh     if( p->op==TK_NOTNULL ){
5116d6db6598Sdrh       p = p->pLeft;
5117d6db6598Sdrh     }else if( p->op==TK_AND ){
5118d6db6598Sdrh       if( sqlite3ExprImpliesNonNullRow(p->pLeft, iTab) ) return 1;
5119d6db6598Sdrh       p = p->pRight;
5120d6db6598Sdrh     }else{
5121d6db6598Sdrh       break;
5122d6db6598Sdrh     }
5123d6db6598Sdrh   }
51242589787cSdrh   w.xExprCallback = impliesNotNullRow;
51252589787cSdrh   w.xSelectCallback = 0;
51262589787cSdrh   w.xSelectCallback2 = 0;
51272589787cSdrh   w.eCode = 0;
51282589787cSdrh   w.u.iCur = iTab;
51292589787cSdrh   sqlite3WalkExpr(&w, p);
51302589787cSdrh   return w.eCode;
51312589787cSdrh }
51322589787cSdrh 
51332589787cSdrh /*
5134030796dfSdrh ** An instance of the following structure is used by the tree walker
51352409f8a1Sdrh ** to determine if an expression can be evaluated by reference to the
51362409f8a1Sdrh ** index only, without having to do a search for the corresponding
51372409f8a1Sdrh ** table entry.  The IdxCover.pIdx field is the index.  IdxCover.iCur
51382409f8a1Sdrh ** is the cursor for the table.
51392409f8a1Sdrh */
51402409f8a1Sdrh struct IdxCover {
51412409f8a1Sdrh   Index *pIdx;     /* The index to be tested for coverage */
51422409f8a1Sdrh   int iCur;        /* Cursor number for the table corresponding to the index */
51432409f8a1Sdrh };
51442409f8a1Sdrh 
51452409f8a1Sdrh /*
51462409f8a1Sdrh ** Check to see if there are references to columns in table
51472409f8a1Sdrh ** pWalker->u.pIdxCover->iCur can be satisfied using the index
51482409f8a1Sdrh ** pWalker->u.pIdxCover->pIdx.
51492409f8a1Sdrh */
51502409f8a1Sdrh static int exprIdxCover(Walker *pWalker, Expr *pExpr){
51512409f8a1Sdrh   if( pExpr->op==TK_COLUMN
51522409f8a1Sdrh    && pExpr->iTable==pWalker->u.pIdxCover->iCur
51532409f8a1Sdrh    && sqlite3ColumnOfIndex(pWalker->u.pIdxCover->pIdx, pExpr->iColumn)<0
51542409f8a1Sdrh   ){
51552409f8a1Sdrh     pWalker->eCode = 1;
51562409f8a1Sdrh     return WRC_Abort;
51572409f8a1Sdrh   }
51582409f8a1Sdrh   return WRC_Continue;
51592409f8a1Sdrh }
51602409f8a1Sdrh 
51612409f8a1Sdrh /*
5162e604ec0bSdrh ** Determine if an index pIdx on table with cursor iCur contains will
5163e604ec0bSdrh ** the expression pExpr.  Return true if the index does cover the
5164e604ec0bSdrh ** expression and false if the pExpr expression references table columns
5165e604ec0bSdrh ** that are not found in the index pIdx.
51662409f8a1Sdrh **
51672409f8a1Sdrh ** An index covering an expression means that the expression can be
51682409f8a1Sdrh ** evaluated using only the index and without having to lookup the
51692409f8a1Sdrh ** corresponding table entry.
51702409f8a1Sdrh */
51712409f8a1Sdrh int sqlite3ExprCoveredByIndex(
51722409f8a1Sdrh   Expr *pExpr,        /* The index to be tested */
51732409f8a1Sdrh   int iCur,           /* The cursor number for the corresponding table */
51742409f8a1Sdrh   Index *pIdx         /* The index that might be used for coverage */
51752409f8a1Sdrh ){
51762409f8a1Sdrh   Walker w;
51772409f8a1Sdrh   struct IdxCover xcov;
51782409f8a1Sdrh   memset(&w, 0, sizeof(w));
51792409f8a1Sdrh   xcov.iCur = iCur;
51802409f8a1Sdrh   xcov.pIdx = pIdx;
51812409f8a1Sdrh   w.xExprCallback = exprIdxCover;
51822409f8a1Sdrh   w.u.pIdxCover = &xcov;
51832409f8a1Sdrh   sqlite3WalkExpr(&w, pExpr);
51842409f8a1Sdrh   return !w.eCode;
51852409f8a1Sdrh }
51862409f8a1Sdrh 
51872409f8a1Sdrh 
51882409f8a1Sdrh /*
51892409f8a1Sdrh ** An instance of the following structure is used by the tree walker
5190030796dfSdrh ** to count references to table columns in the arguments of an
5191ed551b95Sdrh ** aggregate function, in order to implement the
5192ed551b95Sdrh ** sqlite3FunctionThisSrc() routine.
5193374fdce4Sdrh */
5194030796dfSdrh struct SrcCount {
5195030796dfSdrh   SrcList *pSrc;   /* One particular FROM clause in a nested query */
5196030796dfSdrh   int nThis;       /* Number of references to columns in pSrcList */
5197030796dfSdrh   int nOther;      /* Number of references to columns in other FROM clauses */
5198030796dfSdrh };
5199030796dfSdrh 
5200030796dfSdrh /*
5201030796dfSdrh ** Count the number of references to columns.
5202030796dfSdrh */
5203030796dfSdrh static int exprSrcCount(Walker *pWalker, Expr *pExpr){
5204fb0a6081Sdrh   /* The NEVER() on the second term is because sqlite3FunctionUsesThisSrc()
5205fb0a6081Sdrh   ** is always called before sqlite3ExprAnalyzeAggregates() and so the
5206fb0a6081Sdrh   ** TK_COLUMNs have not yet been converted into TK_AGG_COLUMN.  If
5207fb0a6081Sdrh   ** sqlite3FunctionUsesThisSrc() is used differently in the future, the
5208fb0a6081Sdrh   ** NEVER() will need to be removed. */
5209fb0a6081Sdrh   if( pExpr->op==TK_COLUMN || NEVER(pExpr->op==TK_AGG_COLUMN) ){
5210374fdce4Sdrh     int i;
5211030796dfSdrh     struct SrcCount *p = pWalker->u.pSrcCount;
5212030796dfSdrh     SrcList *pSrc = p->pSrc;
5213655814d2Sdrh     int nSrc = pSrc ? pSrc->nSrc : 0;
5214655814d2Sdrh     for(i=0; i<nSrc; i++){
5215030796dfSdrh       if( pExpr->iTable==pSrc->a[i].iCursor ) break;
5216374fdce4Sdrh     }
5217655814d2Sdrh     if( i<nSrc ){
5218030796dfSdrh       p->nThis++;
5219374fdce4Sdrh     }else{
5220030796dfSdrh       p->nOther++;
5221374fdce4Sdrh     }
5222374fdce4Sdrh   }
5223030796dfSdrh   return WRC_Continue;
5224030796dfSdrh }
5225374fdce4Sdrh 
5226374fdce4Sdrh /*
5227030796dfSdrh ** Determine if any of the arguments to the pExpr Function reference
5228030796dfSdrh ** pSrcList.  Return true if they do.  Also return true if the function
5229030796dfSdrh ** has no arguments or has only constant arguments.  Return false if pExpr
5230030796dfSdrh ** references columns but not columns of tables found in pSrcList.
5231374fdce4Sdrh */
5232030796dfSdrh int sqlite3FunctionUsesThisSrc(Expr *pExpr, SrcList *pSrcList){
5233374fdce4Sdrh   Walker w;
5234030796dfSdrh   struct SrcCount cnt;
5235374fdce4Sdrh   assert( pExpr->op==TK_AGG_FUNCTION );
5236030796dfSdrh   w.xExprCallback = exprSrcCount;
5237979dd1beSdrh   w.xSelectCallback = 0;
5238030796dfSdrh   w.u.pSrcCount = &cnt;
5239030796dfSdrh   cnt.pSrc = pSrcList;
5240030796dfSdrh   cnt.nThis = 0;
5241030796dfSdrh   cnt.nOther = 0;
5242030796dfSdrh   sqlite3WalkExprList(&w, pExpr->x.pList);
5243030796dfSdrh   return cnt.nThis>0 || cnt.nOther==0;
5244374fdce4Sdrh }
5245374fdce4Sdrh 
5246374fdce4Sdrh /*
524713449892Sdrh ** Add a new element to the pAggInfo->aCol[] array.  Return the index of
524813449892Sdrh ** the new element.  Return a negative number if malloc fails.
52492282792aSdrh */
525017435752Sdrh static int addAggInfoColumn(sqlite3 *db, AggInfo *pInfo){
525113449892Sdrh   int i;
5252cf643729Sdrh   pInfo->aCol = sqlite3ArrayAllocate(
525317435752Sdrh        db,
5254cf643729Sdrh        pInfo->aCol,
5255cf643729Sdrh        sizeof(pInfo->aCol[0]),
5256cf643729Sdrh        &pInfo->nColumn,
5257cf643729Sdrh        &i
5258cf643729Sdrh   );
525913449892Sdrh   return i;
52602282792aSdrh }
526113449892Sdrh 
526213449892Sdrh /*
526313449892Sdrh ** Add a new element to the pAggInfo->aFunc[] array.  Return the index of
526413449892Sdrh ** the new element.  Return a negative number if malloc fails.
526513449892Sdrh */
526617435752Sdrh static int addAggInfoFunc(sqlite3 *db, AggInfo *pInfo){
526713449892Sdrh   int i;
5268cf643729Sdrh   pInfo->aFunc = sqlite3ArrayAllocate(
526917435752Sdrh        db,
5270cf643729Sdrh        pInfo->aFunc,
5271cf643729Sdrh        sizeof(pInfo->aFunc[0]),
5272cf643729Sdrh        &pInfo->nFunc,
5273cf643729Sdrh        &i
5274cf643729Sdrh   );
527513449892Sdrh   return i;
52762282792aSdrh }
52772282792aSdrh 
52782282792aSdrh /*
52797d10d5a6Sdrh ** This is the xExprCallback for a tree walker.  It is used to
52807d10d5a6Sdrh ** implement sqlite3ExprAnalyzeAggregates().  See sqlite3ExprAnalyzeAggregates
5281626a879aSdrh ** for additional information.
52822282792aSdrh */
52837d10d5a6Sdrh static int analyzeAggregate(Walker *pWalker, Expr *pExpr){
52842282792aSdrh   int i;
52857d10d5a6Sdrh   NameContext *pNC = pWalker->u.pNC;
5286a58fdfb1Sdanielk1977   Parse *pParse = pNC->pParse;
5287a58fdfb1Sdanielk1977   SrcList *pSrcList = pNC->pSrcList;
528825c3b8caSdrh   AggInfo *pAggInfo = pNC->uNC.pAggInfo;
528913449892Sdrh 
529025c3b8caSdrh   assert( pNC->ncFlags & NC_UAggInfo );
52912282792aSdrh   switch( pExpr->op ){
529289c69d00Sdrh     case TK_AGG_COLUMN:
5293967e8b73Sdrh     case TK_COLUMN: {
52948b213899Sdrh       testcase( pExpr->op==TK_AGG_COLUMN );
52958b213899Sdrh       testcase( pExpr->op==TK_COLUMN );
529613449892Sdrh       /* Check to see if the column is in one of the tables in the FROM
529713449892Sdrh       ** clause of the aggregate query */
529820bc393cSdrh       if( ALWAYS(pSrcList!=0) ){
529913449892Sdrh         struct SrcList_item *pItem = pSrcList->a;
530013449892Sdrh         for(i=0; i<pSrcList->nSrc; i++, pItem++){
530113449892Sdrh           struct AggInfo_col *pCol;
5302c5cd1249Sdrh           assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
530313449892Sdrh           if( pExpr->iTable==pItem->iCursor ){
530413449892Sdrh             /* If we reach this point, it means that pExpr refers to a table
530513449892Sdrh             ** that is in the FROM clause of the aggregate query.
530613449892Sdrh             **
530713449892Sdrh             ** Make an entry for the column in pAggInfo->aCol[] if there
530813449892Sdrh             ** is not an entry there already.
530913449892Sdrh             */
53107f906d63Sdrh             int k;
531113449892Sdrh             pCol = pAggInfo->aCol;
53127f906d63Sdrh             for(k=0; k<pAggInfo->nColumn; k++, pCol++){
531313449892Sdrh               if( pCol->iTable==pExpr->iTable &&
531413449892Sdrh                   pCol->iColumn==pExpr->iColumn ){
53152282792aSdrh                 break;
53162282792aSdrh               }
53172282792aSdrh             }
53181e536953Sdanielk1977             if( (k>=pAggInfo->nColumn)
53191e536953Sdanielk1977              && (k = addAggInfoColumn(pParse->db, pAggInfo))>=0
53201e536953Sdanielk1977             ){
53217f906d63Sdrh               pCol = &pAggInfo->aCol[k];
5322eda079cdSdrh               pCol->pTab = pExpr->y.pTab;
532313449892Sdrh               pCol->iTable = pExpr->iTable;
532413449892Sdrh               pCol->iColumn = pExpr->iColumn;
53250a07c107Sdrh               pCol->iMem = ++pParse->nMem;
532613449892Sdrh               pCol->iSorterColumn = -1;
53275774b806Sdrh               pCol->pExpr = pExpr;
532813449892Sdrh               if( pAggInfo->pGroupBy ){
532913449892Sdrh                 int j, n;
533013449892Sdrh                 ExprList *pGB = pAggInfo->pGroupBy;
533113449892Sdrh                 struct ExprList_item *pTerm = pGB->a;
533213449892Sdrh                 n = pGB->nExpr;
533313449892Sdrh                 for(j=0; j<n; j++, pTerm++){
533413449892Sdrh                   Expr *pE = pTerm->pExpr;
533513449892Sdrh                   if( pE->op==TK_COLUMN && pE->iTable==pExpr->iTable &&
533613449892Sdrh                       pE->iColumn==pExpr->iColumn ){
533713449892Sdrh                     pCol->iSorterColumn = j;
533813449892Sdrh                     break;
53392282792aSdrh                   }
534013449892Sdrh                 }
534113449892Sdrh               }
534213449892Sdrh               if( pCol->iSorterColumn<0 ){
534313449892Sdrh                 pCol->iSorterColumn = pAggInfo->nSortingColumn++;
534413449892Sdrh               }
534513449892Sdrh             }
534613449892Sdrh             /* There is now an entry for pExpr in pAggInfo->aCol[] (either
534713449892Sdrh             ** because it was there before or because we just created it).
534813449892Sdrh             ** Convert the pExpr to be a TK_AGG_COLUMN referring to that
534913449892Sdrh             ** pAggInfo->aCol[] entry.
535013449892Sdrh             */
5351ebb6a65dSdrh             ExprSetVVAProperty(pExpr, EP_NoReduce);
535213449892Sdrh             pExpr->pAggInfo = pAggInfo;
535313449892Sdrh             pExpr->op = TK_AGG_COLUMN;
5354cf697396Sshane             pExpr->iAgg = (i16)k;
535513449892Sdrh             break;
535613449892Sdrh           } /* endif pExpr->iTable==pItem->iCursor */
535713449892Sdrh         } /* end loop over pSrcList */
5358a58fdfb1Sdanielk1977       }
53597d10d5a6Sdrh       return WRC_Prune;
53602282792aSdrh     }
53612282792aSdrh     case TK_AGG_FUNCTION: {
53623a8c4be7Sdrh       if( (pNC->ncFlags & NC_InAggFunc)==0
5363ed551b95Sdrh        && pWalker->walkerDepth==pExpr->op2
53643a8c4be7Sdrh       ){
536513449892Sdrh         /* Check to see if pExpr is a duplicate of another aggregate
536613449892Sdrh         ** function that is already in the pAggInfo structure
536713449892Sdrh         */
536813449892Sdrh         struct AggInfo_func *pItem = pAggInfo->aFunc;
536913449892Sdrh         for(i=0; i<pAggInfo->nFunc; i++, pItem++){
53705aa550cfSdan           if( sqlite3ExprCompare(0, pItem->pExpr, pExpr, -1)==0 ){
53712282792aSdrh             break;
53722282792aSdrh           }
53732282792aSdrh         }
537413449892Sdrh         if( i>=pAggInfo->nFunc ){
537513449892Sdrh           /* pExpr is original.  Make a new entry in pAggInfo->aFunc[]
537613449892Sdrh           */
537714db2665Sdanielk1977           u8 enc = ENC(pParse->db);
53781e536953Sdanielk1977           i = addAggInfoFunc(pParse->db, pAggInfo);
537913449892Sdrh           if( i>=0 ){
53806ab3a2ecSdanielk1977             assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
538113449892Sdrh             pItem = &pAggInfo->aFunc[i];
538213449892Sdrh             pItem->pExpr = pExpr;
53830a07c107Sdrh             pItem->iMem = ++pParse->nMem;
538433e619fcSdrh             assert( !ExprHasProperty(pExpr, EP_IntValue) );
538513449892Sdrh             pItem->pFunc = sqlite3FindFunction(pParse->db,
538680738d9cSdrh                    pExpr->u.zToken,
53876ab3a2ecSdanielk1977                    pExpr->x.pList ? pExpr->x.pList->nExpr : 0, enc, 0);
5388fd357974Sdrh             if( pExpr->flags & EP_Distinct ){
5389fd357974Sdrh               pItem->iDistinct = pParse->nTab++;
5390fd357974Sdrh             }else{
5391fd357974Sdrh               pItem->iDistinct = -1;
5392fd357974Sdrh             }
53932282792aSdrh           }
539413449892Sdrh         }
539513449892Sdrh         /* Make pExpr point to the appropriate pAggInfo->aFunc[] entry
539613449892Sdrh         */
5397c5cd1249Sdrh         assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
5398ebb6a65dSdrh         ExprSetVVAProperty(pExpr, EP_NoReduce);
5399cf697396Sshane         pExpr->iAgg = (i16)i;
540013449892Sdrh         pExpr->pAggInfo = pAggInfo;
54013a8c4be7Sdrh         return WRC_Prune;
54026e83a57fSdrh       }else{
54036e83a57fSdrh         return WRC_Continue;
54046e83a57fSdrh       }
54052282792aSdrh     }
5406a58fdfb1Sdanielk1977   }
54077d10d5a6Sdrh   return WRC_Continue;
54087d10d5a6Sdrh }
54097d10d5a6Sdrh static int analyzeAggregatesInSelect(Walker *pWalker, Select *pSelect){
5410d5a336efSdrh   UNUSED_PARAMETER(pSelect);
5411979dd1beSdrh   pWalker->walkerDepth++;
54127d10d5a6Sdrh   return WRC_Continue;
5413a58fdfb1Sdanielk1977 }
5414979dd1beSdrh static void analyzeAggregatesInSelectEnd(Walker *pWalker, Select *pSelect){
5415979dd1beSdrh   UNUSED_PARAMETER(pSelect);
5416979dd1beSdrh   pWalker->walkerDepth--;
5417979dd1beSdrh }
5418626a879aSdrh 
5419626a879aSdrh /*
5420e8abb4caSdrh ** Analyze the pExpr expression looking for aggregate functions and
5421e8abb4caSdrh ** for variables that need to be added to AggInfo object that pNC->pAggInfo
5422e8abb4caSdrh ** points to.  Additional entries are made on the AggInfo object as
5423e8abb4caSdrh ** necessary.
5424626a879aSdrh **
5425626a879aSdrh ** This routine should only be called after the expression has been
54267d10d5a6Sdrh ** analyzed by sqlite3ResolveExprNames().
5427626a879aSdrh */
5428d2b3e23bSdrh void sqlite3ExprAnalyzeAggregates(NameContext *pNC, Expr *pExpr){
54297d10d5a6Sdrh   Walker w;
54307d10d5a6Sdrh   w.xExprCallback = analyzeAggregate;
54317d10d5a6Sdrh   w.xSelectCallback = analyzeAggregatesInSelect;
5432979dd1beSdrh   w.xSelectCallback2 = analyzeAggregatesInSelectEnd;
5433979dd1beSdrh   w.walkerDepth = 0;
54347d10d5a6Sdrh   w.u.pNC = pNC;
5435d9995031Sdan   w.pParse = 0;
543620bc393cSdrh   assert( pNC->pSrcList!=0 );
54377d10d5a6Sdrh   sqlite3WalkExpr(&w, pExpr);
54382282792aSdrh }
54395d9a4af9Sdrh 
54405d9a4af9Sdrh /*
54415d9a4af9Sdrh ** Call sqlite3ExprAnalyzeAggregates() for every expression in an
54425d9a4af9Sdrh ** expression list.  Return the number of errors.
54435d9a4af9Sdrh **
54445d9a4af9Sdrh ** If an error is found, the analysis is cut short.
54455d9a4af9Sdrh */
5446d2b3e23bSdrh void sqlite3ExprAnalyzeAggList(NameContext *pNC, ExprList *pList){
54475d9a4af9Sdrh   struct ExprList_item *pItem;
54485d9a4af9Sdrh   int i;
54495d9a4af9Sdrh   if( pList ){
5450d2b3e23bSdrh     for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
5451d2b3e23bSdrh       sqlite3ExprAnalyzeAggregates(pNC, pItem->pExpr);
54525d9a4af9Sdrh     }
54535d9a4af9Sdrh   }
54545d9a4af9Sdrh }
5455892d3179Sdrh 
5456892d3179Sdrh /*
5457ceea3321Sdrh ** Allocate a single new register for use to hold some intermediate result.
5458892d3179Sdrh */
5459892d3179Sdrh int sqlite3GetTempReg(Parse *pParse){
5460e55cbd72Sdrh   if( pParse->nTempReg==0 ){
5461892d3179Sdrh     return ++pParse->nMem;
5462892d3179Sdrh   }
54632f425f6bSdanielk1977   return pParse->aTempReg[--pParse->nTempReg];
5464892d3179Sdrh }
5465ceea3321Sdrh 
5466ceea3321Sdrh /*
5467ceea3321Sdrh ** Deallocate a register, making available for reuse for some other
5468ceea3321Sdrh ** purpose.
5469ceea3321Sdrh */
5470892d3179Sdrh void sqlite3ReleaseTempReg(Parse *pParse, int iReg){
54712dcef11bSdrh   if( iReg && pParse->nTempReg<ArraySize(pParse->aTempReg) ){
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 ){
5485892d3179Sdrh     pParse->iRangeReg += nReg;
5486892d3179Sdrh     pParse->nRangeReg -= nReg;
5487892d3179Sdrh   }else{
5488892d3179Sdrh     i = pParse->nMem+1;
5489892d3179Sdrh     pParse->nMem += nReg;
5490892d3179Sdrh   }
5491892d3179Sdrh   return i;
5492892d3179Sdrh }
5493892d3179Sdrh void sqlite3ReleaseTempRange(Parse *pParse, int iReg, int nReg){
5494ed24da4bSdrh   if( nReg==1 ){
5495ed24da4bSdrh     sqlite3ReleaseTempReg(pParse, iReg);
5496ed24da4bSdrh     return;
5497ed24da4bSdrh   }
5498892d3179Sdrh   if( nReg>pParse->nRangeReg ){
5499892d3179Sdrh     pParse->nRangeReg = nReg;
5500892d3179Sdrh     pParse->iRangeReg = iReg;
5501892d3179Sdrh   }
5502892d3179Sdrh }
5503cdc69557Sdrh 
5504cdc69557Sdrh /*
5505cdc69557Sdrh ** Mark all temporary registers as being unavailable for reuse.
5506cdc69557Sdrh */
5507cdc69557Sdrh void sqlite3ClearTempRegCache(Parse *pParse){
5508cdc69557Sdrh   pParse->nTempReg = 0;
5509cdc69557Sdrh   pParse->nRangeReg = 0;
5510cdc69557Sdrh }
5511bb9b5f26Sdrh 
5512bb9b5f26Sdrh /*
5513bb9b5f26Sdrh ** Validate that no temporary register falls within the range of
5514bb9b5f26Sdrh ** iFirst..iLast, inclusive.  This routine is only call from within assert()
5515bb9b5f26Sdrh ** statements.
5516bb9b5f26Sdrh */
5517bb9b5f26Sdrh #ifdef SQLITE_DEBUG
5518bb9b5f26Sdrh int sqlite3NoTempsInRange(Parse *pParse, int iFirst, int iLast){
5519bb9b5f26Sdrh   int i;
5520bb9b5f26Sdrh   if( pParse->nRangeReg>0
55213963e584Sdrh    && pParse->iRangeReg+pParse->nRangeReg > iFirst
55223963e584Sdrh    && pParse->iRangeReg <= iLast
5523bb9b5f26Sdrh   ){
5524bb9b5f26Sdrh      return 0;
5525bb9b5f26Sdrh   }
5526bb9b5f26Sdrh   for(i=0; i<pParse->nTempReg; i++){
5527bb9b5f26Sdrh     if( pParse->aTempReg[i]>=iFirst && pParse->aTempReg[i]<=iLast ){
5528bb9b5f26Sdrh       return 0;
5529bb9b5f26Sdrh     }
5530bb9b5f26Sdrh   }
5531bb9b5f26Sdrh   return 1;
5532bb9b5f26Sdrh }
5533bb9b5f26Sdrh #endif /* SQLITE_DEBUG */
5534