xref: /sqlite-3.40.0/src/expr.c (revision a1054dcc)
1cce7d176Sdrh /*
2b19a2bc6Sdrh ** 2001 September 15
3cce7d176Sdrh **
4b19a2bc6Sdrh ** The author disclaims copyright to this source code.  In place of
5b19a2bc6Sdrh ** a legal notice, here is a blessing:
6cce7d176Sdrh **
7b19a2bc6Sdrh **    May you do good and not evil.
8b19a2bc6Sdrh **    May you find forgiveness for yourself and forgive others.
9b19a2bc6Sdrh **    May you share freely, never taking more than you give.
10cce7d176Sdrh **
11cce7d176Sdrh *************************************************************************
121ccde15dSdrh ** This file contains routines used for analyzing expressions and
13b19a2bc6Sdrh ** for generating VDBE code that evaluates expressions in SQLite.
14cce7d176Sdrh */
15cce7d176Sdrh #include "sqliteInt.h"
16a2e00042Sdrh 
1712abf408Sdrh /* Forward declarations */
1812abf408Sdrh static void exprCodeBetween(Parse*,Expr*,int,void(*)(Parse*,Expr*,int,int),int);
1912abf408Sdrh static int exprCodeVector(Parse *pParse, Expr *p, int *piToFree);
2012abf408Sdrh 
210dfa4f6fSdrh /*
220dfa4f6fSdrh ** Return the affinity character for a single column of a table.
230dfa4f6fSdrh */
240dfa4f6fSdrh char sqlite3TableColumnAffinity(Table *pTab, int iCol){
250dfa4f6fSdrh   assert( iCol<pTab->nCol );
260dfa4f6fSdrh   return iCol>=0 ? pTab->aCol[iCol].affinity : SQLITE_AFF_INTEGER;
270dfa4f6fSdrh }
2812abf408Sdrh 
29e014a838Sdanielk1977 /*
30e014a838Sdanielk1977 ** Return the 'affinity' of the expression pExpr if any.
31e014a838Sdanielk1977 **
32e014a838Sdanielk1977 ** If pExpr is a column, a reference to a column via an 'AS' alias,
33e014a838Sdanielk1977 ** or a sub-select with a column as the return value, then the
34e014a838Sdanielk1977 ** affinity of that column is returned. Otherwise, 0x00 is returned,
35e014a838Sdanielk1977 ** indicating no affinity for the expression.
36e014a838Sdanielk1977 **
3760ec914cSpeter.d.reid ** i.e. the WHERE clause expressions in the following statements all
38e014a838Sdanielk1977 ** have an affinity:
39e014a838Sdanielk1977 **
40e014a838Sdanielk1977 ** CREATE TABLE t1(a);
41e014a838Sdanielk1977 ** SELECT * FROM t1 WHERE a;
42e014a838Sdanielk1977 ** SELECT a AS b FROM t1 WHERE b;
43e014a838Sdanielk1977 ** SELECT * FROM t1 WHERE (select a from t1);
44e014a838Sdanielk1977 */
45bf3b721fSdanielk1977 char sqlite3ExprAffinity(Expr *pExpr){
46580c8c18Sdrh   int op;
47580c8c18Sdrh   pExpr = sqlite3ExprSkipCollate(pExpr);
489bec6fb3Smistachkin   if( pExpr->flags & EP_Generic ) return 0;
49580c8c18Sdrh   op = pExpr->op;
50487e262fSdrh   if( op==TK_SELECT ){
516ab3a2ecSdanielk1977     assert( pExpr->flags&EP_xIsSelect );
526ab3a2ecSdanielk1977     return sqlite3ExprAffinity(pExpr->x.pSelect->pEList->a[0].pExpr);
53a37cdde0Sdanielk1977   }
54db45bd5eSdrh   if( op==TK_REGISTER ) op = pExpr->op2;
55487e262fSdrh #ifndef SQLITE_OMIT_CAST
56487e262fSdrh   if( op==TK_CAST ){
5733e619fcSdrh     assert( !ExprHasProperty(pExpr, EP_IntValue) );
58fdaac671Sdrh     return sqlite3AffinityType(pExpr->u.zToken, 0);
59487e262fSdrh   }
60487e262fSdrh #endif
61b8d29c2fSdan   if( (op==TK_AGG_COLUMN || op==TK_COLUMN) && pExpr->pTab ){
620dfa4f6fSdrh     return sqlite3TableColumnAffinity(pExpr->pTab, pExpr->iColumn);
637d10d5a6Sdrh   }
6480aa5453Sdan   if( op==TK_SELECT_COLUMN ){
6580aa5453Sdan     assert( pExpr->pLeft->flags&EP_xIsSelect );
6680aa5453Sdan     return sqlite3ExprAffinity(
6780aa5453Sdan         pExpr->pLeft->x.pSelect->pEList->a[pExpr->iColumn].pExpr
6880aa5453Sdan     );
6980aa5453Sdan   }
70a37cdde0Sdanielk1977   return pExpr->affinity;
71a37cdde0Sdanielk1977 }
72a37cdde0Sdanielk1977 
7353db1458Sdrh /*
748b4c40d8Sdrh ** Set the collating sequence for expression pExpr to be the collating
75ae80ddeaSdrh ** sequence named by pToken.   Return a pointer to a new Expr node that
76ae80ddeaSdrh ** implements the COLLATE operator.
770a8a406eSdrh **
780a8a406eSdrh ** If a memory allocation error occurs, that fact is recorded in pParse->db
790a8a406eSdrh ** and the pExpr parameter is returned unchanged.
808b4c40d8Sdrh */
814ef7efadSdrh Expr *sqlite3ExprAddCollateToken(
824ef7efadSdrh   Parse *pParse,           /* Parsing context */
834ef7efadSdrh   Expr *pExpr,             /* Add the "COLLATE" clause to this expression */
8480103fc6Sdan   const Token *pCollName,  /* Name of collating sequence */
8580103fc6Sdan   int dequote              /* True to dequote pCollName */
864ef7efadSdrh ){
870a8a406eSdrh   if( pCollName->n>0 ){
8880103fc6Sdan     Expr *pNew = sqlite3ExprAlloc(pParse->db, TK_COLLATE, pCollName, dequote);
89ae80ddeaSdrh     if( pNew ){
90ae80ddeaSdrh       pNew->pLeft = pExpr;
91a4c3c87eSdrh       pNew->flags |= EP_Collate|EP_Skip;
920a8a406eSdrh       pExpr = pNew;
93ae80ddeaSdrh     }
940a8a406eSdrh   }
950a8a406eSdrh   return pExpr;
960a8a406eSdrh }
970a8a406eSdrh Expr *sqlite3ExprAddCollateString(Parse *pParse, Expr *pExpr, const char *zC){
980a8a406eSdrh   Token s;
99261d8a51Sdrh   assert( zC!=0 );
10040aced5cSdrh   sqlite3TokenInit(&s, (char*)zC);
10180103fc6Sdan   return sqlite3ExprAddCollateToken(pParse, pExpr, &s, 0);
1020a8a406eSdrh }
1030a8a406eSdrh 
1040a8a406eSdrh /*
1050b8d255cSdrh ** Skip over any TK_COLLATE operators and any unlikely()
106a4c3c87eSdrh ** or likelihood() function at the root of an expression.
1070a8a406eSdrh */
1080a8a406eSdrh Expr *sqlite3ExprSkipCollate(Expr *pExpr){
109a4c3c87eSdrh   while( pExpr && ExprHasProperty(pExpr, EP_Skip) ){
110a4c3c87eSdrh     if( ExprHasProperty(pExpr, EP_Unlikely) ){
111cca9f3d2Sdrh       assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
112cca9f3d2Sdrh       assert( pExpr->x.pList->nExpr>0 );
113a4c3c87eSdrh       assert( pExpr->op==TK_FUNCTION );
114cca9f3d2Sdrh       pExpr = pExpr->x.pList->a[0].pExpr;
115cca9f3d2Sdrh     }else{
1160b8d255cSdrh       assert( pExpr->op==TK_COLLATE );
117d91eba96Sdrh       pExpr = pExpr->pLeft;
118cca9f3d2Sdrh     }
119d91eba96Sdrh   }
1200a8a406eSdrh   return pExpr;
1218b4c40d8Sdrh }
1228b4c40d8Sdrh 
1238b4c40d8Sdrh /*
124ae80ddeaSdrh ** Return the collation sequence for the expression pExpr. If
125ae80ddeaSdrh ** there is no defined collating sequence, return NULL.
126ae80ddeaSdrh **
12770efa84dSdrh ** See also: sqlite3ExprNNCollSeq()
12870efa84dSdrh **
12970efa84dSdrh ** The sqlite3ExprNNCollSeq() works the same exact that it returns the
13070efa84dSdrh ** default collation if pExpr has no defined collation.
13170efa84dSdrh **
132ae80ddeaSdrh ** The collating sequence might be determined by a COLLATE operator
133ae80ddeaSdrh ** or by the presence of a column with a defined collating sequence.
134ae80ddeaSdrh ** COLLATE operators take first precedence.  Left operands take
135ae80ddeaSdrh ** precedence over right operands.
1360202b29eSdanielk1977 */
1377cedc8d4Sdanielk1977 CollSeq *sqlite3ExprCollSeq(Parse *pParse, Expr *pExpr){
138ae80ddeaSdrh   sqlite3 *db = pParse->db;
1397cedc8d4Sdanielk1977   CollSeq *pColl = 0;
1407d10d5a6Sdrh   Expr *p = pExpr;
141261d8a51Sdrh   while( p ){
142ae80ddeaSdrh     int op = p->op;
143fbb24d10Sdrh     if( p->flags & EP_Generic ) break;
144ae80ddeaSdrh     if( op==TK_CAST || op==TK_UPLUS ){
145ae80ddeaSdrh       p = p->pLeft;
146ae80ddeaSdrh       continue;
147ae80ddeaSdrh     }
14836e78309Sdan     if( op==TK_COLLATE || (op==TK_REGISTER && p->op2==TK_COLLATE) ){
1497a66da13Sdrh       pColl = sqlite3GetCollSeq(pParse, ENC(db), 0, p->u.zToken);
150ae80ddeaSdrh       break;
151ae80ddeaSdrh     }
152a58d4a96Sdrh     if( (op==TK_AGG_COLUMN || op==TK_COLUMN
153ae80ddeaSdrh           || op==TK_REGISTER || op==TK_TRIGGER)
154a58d4a96Sdrh      && p->pTab!=0
155ae80ddeaSdrh     ){
1567d10d5a6Sdrh       /* op==TK_REGISTER && p->pTab!=0 happens when pExpr was originally
1577d10d5a6Sdrh       ** a TK_COLUMN but was previously evaluated and cached in a register */
1587d10d5a6Sdrh       int j = p->iColumn;
1597d10d5a6Sdrh       if( j>=0 ){
160ae80ddeaSdrh         const char *zColl = p->pTab->aCol[j].zColl;
161c4a64facSdrh         pColl = sqlite3FindCollSeq(db, ENC(db), zColl, 0);
1620202b29eSdanielk1977       }
1637d10d5a6Sdrh       break;
1647d10d5a6Sdrh     }
165ae80ddeaSdrh     if( p->flags & EP_Collate ){
1662308ed38Sdrh       if( p->pLeft && (p->pLeft->flags & EP_Collate)!=0 ){
1677d10d5a6Sdrh         p = p->pLeft;
168ae80ddeaSdrh       }else{
1692308ed38Sdrh         Expr *pNext  = p->pRight;
1706728cd91Sdrh         /* The Expr.x union is never used at the same time as Expr.pRight */
1716728cd91Sdrh         assert( p->x.pList==0 || p->pRight==0 );
1726728cd91Sdrh         /* p->flags holds EP_Collate and p->pLeft->flags does not.  And
1736728cd91Sdrh         ** p->x.pSelect cannot.  So if p->x.pLeft exists, it must hold at
1746728cd91Sdrh         ** least one EP_Collate. Thus the following two ALWAYS. */
1756728cd91Sdrh         if( p->x.pList!=0 && ALWAYS(!ExprHasProperty(p, EP_xIsSelect)) ){
1762308ed38Sdrh           int i;
1776728cd91Sdrh           for(i=0; ALWAYS(i<p->x.pList->nExpr); i++){
1782308ed38Sdrh             if( ExprHasProperty(p->x.pList->a[i].pExpr, EP_Collate) ){
1792308ed38Sdrh               pNext = p->x.pList->a[i].pExpr;
1802308ed38Sdrh               break;
1812308ed38Sdrh             }
1822308ed38Sdrh           }
1832308ed38Sdrh         }
1842308ed38Sdrh         p = pNext;
185ae80ddeaSdrh       }
186ae80ddeaSdrh     }else{
187ae80ddeaSdrh       break;
188ae80ddeaSdrh     }
1890202b29eSdanielk1977   }
1907cedc8d4Sdanielk1977   if( sqlite3CheckCollSeq(pParse, pColl) ){
1917cedc8d4Sdanielk1977     pColl = 0;
1927cedc8d4Sdanielk1977   }
1937cedc8d4Sdanielk1977   return pColl;
1940202b29eSdanielk1977 }
1950202b29eSdanielk1977 
1960202b29eSdanielk1977 /*
19770efa84dSdrh ** Return the collation sequence for the expression pExpr. If
19870efa84dSdrh ** there is no defined collating sequence, return a pointer to the
19970efa84dSdrh ** defautl collation sequence.
20070efa84dSdrh **
20170efa84dSdrh ** See also: sqlite3ExprCollSeq()
20270efa84dSdrh **
20370efa84dSdrh ** The sqlite3ExprCollSeq() routine works the same except that it
20470efa84dSdrh ** returns NULL if there is no defined collation.
20570efa84dSdrh */
20670efa84dSdrh CollSeq *sqlite3ExprNNCollSeq(Parse *pParse, Expr *pExpr){
20770efa84dSdrh   CollSeq *p = sqlite3ExprCollSeq(pParse, pExpr);
20870efa84dSdrh   if( p==0 ) p = pParse->db->pDfltColl;
20970efa84dSdrh   assert( p!=0 );
21070efa84dSdrh   return p;
21170efa84dSdrh }
21270efa84dSdrh 
21370efa84dSdrh /*
21470efa84dSdrh ** Return TRUE if the two expressions have equivalent collating sequences.
21570efa84dSdrh */
21670efa84dSdrh int sqlite3ExprCollSeqMatch(Parse *pParse, Expr *pE1, Expr *pE2){
21770efa84dSdrh   CollSeq *pColl1 = sqlite3ExprNNCollSeq(pParse, pE1);
21870efa84dSdrh   CollSeq *pColl2 = sqlite3ExprNNCollSeq(pParse, pE2);
21970efa84dSdrh   return sqlite3StrICmp(pColl1->zName, pColl2->zName)==0;
22070efa84dSdrh }
22170efa84dSdrh 
22270efa84dSdrh /*
223626a879aSdrh ** pExpr is an operand of a comparison operator.  aff2 is the
224626a879aSdrh ** type affinity of the other operand.  This routine returns the
22553db1458Sdrh ** type affinity that should be used for the comparison operator.
22653db1458Sdrh */
227e014a838Sdanielk1977 char sqlite3CompareAffinity(Expr *pExpr, char aff2){
228bf3b721fSdanielk1977   char aff1 = sqlite3ExprAffinity(pExpr);
229e014a838Sdanielk1977   if( aff1 && aff2 ){
2308df447f0Sdrh     /* Both sides of the comparison are columns. If one has numeric
2318df447f0Sdrh     ** affinity, use that. Otherwise use no affinity.
232e014a838Sdanielk1977     */
2338a51256cSdrh     if( sqlite3IsNumericAffinity(aff1) || sqlite3IsNumericAffinity(aff2) ){
234e014a838Sdanielk1977       return SQLITE_AFF_NUMERIC;
235e014a838Sdanielk1977     }else{
23605883a34Sdrh       return SQLITE_AFF_BLOB;
237e014a838Sdanielk1977     }
238e014a838Sdanielk1977   }else if( !aff1 && !aff2 ){
2395f6a87b3Sdrh     /* Neither side of the comparison is a column.  Compare the
2405f6a87b3Sdrh     ** results directly.
241e014a838Sdanielk1977     */
24205883a34Sdrh     return SQLITE_AFF_BLOB;
243e014a838Sdanielk1977   }else{
244e014a838Sdanielk1977     /* One side is a column, the other is not. Use the columns affinity. */
245fe05af87Sdrh     assert( aff1==0 || aff2==0 );
246e014a838Sdanielk1977     return (aff1 + aff2);
247e014a838Sdanielk1977   }
248e014a838Sdanielk1977 }
249e014a838Sdanielk1977 
25053db1458Sdrh /*
25153db1458Sdrh ** pExpr is a comparison operator.  Return the type affinity that should
25253db1458Sdrh ** be applied to both operands prior to doing the comparison.
25353db1458Sdrh */
254e014a838Sdanielk1977 static char comparisonAffinity(Expr *pExpr){
255e014a838Sdanielk1977   char aff;
256e014a838Sdanielk1977   assert( pExpr->op==TK_EQ || pExpr->op==TK_IN || pExpr->op==TK_LT ||
257e014a838Sdanielk1977           pExpr->op==TK_GT || pExpr->op==TK_GE || pExpr->op==TK_LE ||
2586a2fe093Sdrh           pExpr->op==TK_NE || pExpr->op==TK_IS || pExpr->op==TK_ISNOT );
259e014a838Sdanielk1977   assert( pExpr->pLeft );
260bf3b721fSdanielk1977   aff = sqlite3ExprAffinity(pExpr->pLeft);
261e014a838Sdanielk1977   if( pExpr->pRight ){
262e014a838Sdanielk1977     aff = sqlite3CompareAffinity(pExpr->pRight, aff);
2636ab3a2ecSdanielk1977   }else if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2646ab3a2ecSdanielk1977     aff = sqlite3CompareAffinity(pExpr->x.pSelect->pEList->a[0].pExpr, aff);
26513ac46eeSdrh   }else if( aff==0 ){
26605883a34Sdrh     aff = SQLITE_AFF_BLOB;
267e014a838Sdanielk1977   }
268e014a838Sdanielk1977   return aff;
269e014a838Sdanielk1977 }
270e014a838Sdanielk1977 
271e014a838Sdanielk1977 /*
272e014a838Sdanielk1977 ** pExpr is a comparison expression, eg. '=', '<', IN(...) etc.
273e014a838Sdanielk1977 ** idx_affinity is the affinity of an indexed column. Return true
274e014a838Sdanielk1977 ** if the index with affinity idx_affinity may be used to implement
275e014a838Sdanielk1977 ** the comparison in pExpr.
276e014a838Sdanielk1977 */
277e014a838Sdanielk1977 int sqlite3IndexAffinityOk(Expr *pExpr, char idx_affinity){
278e014a838Sdanielk1977   char aff = comparisonAffinity(pExpr);
2798a51256cSdrh   switch( aff ){
28005883a34Sdrh     case SQLITE_AFF_BLOB:
2818a51256cSdrh       return 1;
2828a51256cSdrh     case SQLITE_AFF_TEXT:
2838a51256cSdrh       return idx_affinity==SQLITE_AFF_TEXT;
2848a51256cSdrh     default:
2858a51256cSdrh       return sqlite3IsNumericAffinity(idx_affinity);
2868a51256cSdrh   }
287e014a838Sdanielk1977 }
288e014a838Sdanielk1977 
289a37cdde0Sdanielk1977 /*
29035573356Sdrh ** Return the P5 value that should be used for a binary comparison
291a37cdde0Sdanielk1977 ** opcode (OP_Eq, OP_Ge etc.) used to compare pExpr1 and pExpr2.
292a37cdde0Sdanielk1977 */
29335573356Sdrh static u8 binaryCompareP5(Expr *pExpr1, Expr *pExpr2, int jumpIfNull){
29435573356Sdrh   u8 aff = (char)sqlite3ExprAffinity(pExpr2);
2951bd10f8aSdrh   aff = (u8)sqlite3CompareAffinity(pExpr1, aff) | (u8)jumpIfNull;
29635573356Sdrh   return aff;
297a37cdde0Sdanielk1977 }
298a37cdde0Sdanielk1977 
299a2e00042Sdrh /*
3000202b29eSdanielk1977 ** Return a pointer to the collation sequence that should be used by
3010202b29eSdanielk1977 ** a binary comparison operator comparing pLeft and pRight.
3020202b29eSdanielk1977 **
3030202b29eSdanielk1977 ** If the left hand expression has a collating sequence type, then it is
3040202b29eSdanielk1977 ** used. Otherwise the collation sequence for the right hand expression
3050202b29eSdanielk1977 ** is used, or the default (BINARY) if neither expression has a collating
3060202b29eSdanielk1977 ** type.
307bcbb04e5Sdanielk1977 **
308bcbb04e5Sdanielk1977 ** Argument pRight (but not pLeft) may be a null pointer. In this case,
309bcbb04e5Sdanielk1977 ** it is not considered.
3100202b29eSdanielk1977 */
311bcbb04e5Sdanielk1977 CollSeq *sqlite3BinaryCompareCollSeq(
312bcbb04e5Sdanielk1977   Parse *pParse,
313bcbb04e5Sdanielk1977   Expr *pLeft,
314bcbb04e5Sdanielk1977   Expr *pRight
315bcbb04e5Sdanielk1977 ){
316ec41ddacSdrh   CollSeq *pColl;
317ec41ddacSdrh   assert( pLeft );
318ae80ddeaSdrh   if( pLeft->flags & EP_Collate ){
319ae80ddeaSdrh     pColl = sqlite3ExprCollSeq(pParse, pLeft);
320ae80ddeaSdrh   }else if( pRight && (pRight->flags & EP_Collate)!=0 ){
321ae80ddeaSdrh     pColl = sqlite3ExprCollSeq(pParse, pRight);
322ec41ddacSdrh   }else{
323ec41ddacSdrh     pColl = sqlite3ExprCollSeq(pParse, pLeft);
3240202b29eSdanielk1977     if( !pColl ){
3257cedc8d4Sdanielk1977       pColl = sqlite3ExprCollSeq(pParse, pRight);
3260202b29eSdanielk1977     }
327ec41ddacSdrh   }
3280202b29eSdanielk1977   return pColl;
3290202b29eSdanielk1977 }
3300202b29eSdanielk1977 
3310202b29eSdanielk1977 /*
332be5c89acSdrh ** Generate code for a comparison operator.
333be5c89acSdrh */
334be5c89acSdrh static int codeCompare(
335be5c89acSdrh   Parse *pParse,    /* The parsing (and code generating) context */
336be5c89acSdrh   Expr *pLeft,      /* The left operand */
337be5c89acSdrh   Expr *pRight,     /* The right operand */
338be5c89acSdrh   int opcode,       /* The comparison opcode */
33935573356Sdrh   int in1, int in2, /* Register holding operands */
340be5c89acSdrh   int dest,         /* Jump here if true.  */
341be5c89acSdrh   int jumpIfNull    /* If true, jump if either operand is NULL */
342be5c89acSdrh ){
34335573356Sdrh   int p5;
34435573356Sdrh   int addr;
34535573356Sdrh   CollSeq *p4;
34635573356Sdrh 
34735573356Sdrh   p4 = sqlite3BinaryCompareCollSeq(pParse, pLeft, pRight);
34835573356Sdrh   p5 = binaryCompareP5(pLeft, pRight, jumpIfNull);
34935573356Sdrh   addr = sqlite3VdbeAddOp4(pParse->pVdbe, opcode, in2, dest, in1,
35035573356Sdrh                            (void*)p4, P4_COLLSEQ);
3511bd10f8aSdrh   sqlite3VdbeChangeP5(pParse->pVdbe, (u8)p5);
35235573356Sdrh   return addr;
353be5c89acSdrh }
354be5c89acSdrh 
355cfbb5e82Sdan /*
356870a0705Sdan ** Return true if expression pExpr is a vector, or false otherwise.
357d832da7fSdrh **
358d832da7fSdrh ** A vector is defined as any expression that results in two or more
359d832da7fSdrh ** columns of result.  Every TK_VECTOR node is an vector because the
360d832da7fSdrh ** parser will not generate a TK_VECTOR with fewer than two entries.
361d832da7fSdrh ** But a TK_SELECT might be either a vector or a scalar. It is only
362d832da7fSdrh ** considered a vector if it has two or more result columns.
363870a0705Sdan */
364870a0705Sdan int sqlite3ExprIsVector(Expr *pExpr){
36576dbe7a8Sdrh   return sqlite3ExprVectorSize(pExpr)>1;
366870a0705Sdan }
367870a0705Sdan 
368870a0705Sdan /*
369cfbb5e82Sdan ** If the expression passed as the only argument is of type TK_VECTOR
370cfbb5e82Sdan ** return the number of expressions in the vector. Or, if the expression
371cfbb5e82Sdan ** is a sub-select, return the number of columns in the sub-select. For
372cfbb5e82Sdan ** any other type of expression, return 1.
373cfbb5e82Sdan */
37471c57db0Sdan int sqlite3ExprVectorSize(Expr *pExpr){
37512abf408Sdrh   u8 op = pExpr->op;
37612abf408Sdrh   if( op==TK_REGISTER ) op = pExpr->op2;
37712abf408Sdrh   if( op==TK_VECTOR ){
37871c57db0Sdan     return pExpr->x.pList->nExpr;
37912abf408Sdrh   }else if( op==TK_SELECT ){
38076dbe7a8Sdrh     return pExpr->x.pSelect->pEList->nExpr;
38176dbe7a8Sdrh   }else{
38276dbe7a8Sdrh     return 1;
38376dbe7a8Sdrh   }
38471c57db0Sdan }
38571c57db0Sdan 
386ba00e30aSdan /*
387fc7f27b9Sdrh ** Return a pointer to a subexpression of pVector that is the i-th
388fc7f27b9Sdrh ** column of the vector (numbered starting with 0).  The caller must
389fc7f27b9Sdrh ** ensure that i is within range.
390fc7f27b9Sdrh **
39176dbe7a8Sdrh ** If pVector is really a scalar (and "scalar" here includes subqueries
39276dbe7a8Sdrh ** that return a single column!) then return pVector unmodified.
39376dbe7a8Sdrh **
394fc7f27b9Sdrh ** pVector retains ownership of the returned subexpression.
395fc7f27b9Sdrh **
396fc7f27b9Sdrh ** If the vector is a (SELECT ...) then the expression returned is
39776dbe7a8Sdrh ** just the expression for the i-th term of the result set, and may
39876dbe7a8Sdrh ** not be ready for evaluation because the table cursor has not yet
39976dbe7a8Sdrh ** been positioned.
400ba00e30aSdan */
401fc7f27b9Sdrh Expr *sqlite3VectorFieldSubexpr(Expr *pVector, int i){
402870a0705Sdan   assert( i<sqlite3ExprVectorSize(pVector) );
403870a0705Sdan   if( sqlite3ExprIsVector(pVector) ){
4049f24b53dSdrh     assert( pVector->op2==0 || pVector->op==TK_REGISTER );
4059f24b53dSdrh     if( pVector->op==TK_SELECT || pVector->op2==TK_SELECT ){
40671c57db0Sdan       return pVector->x.pSelect->pEList->a[i].pExpr;
407870a0705Sdan     }else{
40871c57db0Sdan       return pVector->x.pList->a[i].pExpr;
40971c57db0Sdan     }
410870a0705Sdan   }
411870a0705Sdan   return pVector;
412870a0705Sdan }
413fc7f27b9Sdrh 
414fc7f27b9Sdrh /*
415fc7f27b9Sdrh ** Compute and return a new Expr object which when passed to
416fc7f27b9Sdrh ** sqlite3ExprCode() will generate all necessary code to compute
417fc7f27b9Sdrh ** the iField-th column of the vector expression pVector.
418fc7f27b9Sdrh **
4198762ec19Sdrh ** It is ok for pVector to be a scalar (as long as iField==0).
4208762ec19Sdrh ** In that case, this routine works like sqlite3ExprDup().
4218762ec19Sdrh **
422fc7f27b9Sdrh ** The caller owns the returned Expr object and is responsible for
423fc7f27b9Sdrh ** ensuring that the returned value eventually gets freed.
424fc7f27b9Sdrh **
4258762ec19Sdrh ** The caller retains ownership of pVector.  If pVector is a TK_SELECT,
426fad0e70cSdan ** then the returned object will reference pVector and so pVector must remain
4278762ec19Sdrh ** valid for the life of the returned object.  If pVector is a TK_VECTOR
4288762ec19Sdrh ** or a scalar expression, then it can be deleted as soon as this routine
42976dbe7a8Sdrh ** returns.
4308762ec19Sdrh **
4318762ec19Sdrh ** A trick to cause a TK_SELECT pVector to be deleted together with
4328762ec19Sdrh ** the returned Expr object is to attach the pVector to the pRight field
4338762ec19Sdrh ** of the returned TK_SELECT_COLUMN Expr object.
434fc7f27b9Sdrh */
435fc7f27b9Sdrh Expr *sqlite3ExprForVectorField(
436fc7f27b9Sdrh   Parse *pParse,       /* Parsing context */
437fc7f27b9Sdrh   Expr *pVector,       /* The vector.  List of expressions or a sub-SELECT */
438a1251bc4Sdrh   int iField           /* Which column of the vector to return */
439fc7f27b9Sdrh ){
440fc7f27b9Sdrh   Expr *pRet;
441a1251bc4Sdrh   if( pVector->op==TK_SELECT ){
442a1251bc4Sdrh     assert( pVector->flags & EP_xIsSelect );
443fc7f27b9Sdrh     /* The TK_SELECT_COLUMN Expr node:
444fc7f27b9Sdrh     **
445966e2911Sdrh     ** pLeft:           pVector containing TK_SELECT.  Not deleted.
4468762ec19Sdrh     ** pRight:          not used.  But recursively deleted.
447fc7f27b9Sdrh     ** iColumn:         Index of a column in pVector
448966e2911Sdrh     ** iTable:          0 or the number of columns on the LHS of an assignment
449fc7f27b9Sdrh     ** pLeft->iTable:   First in an array of register holding result, or 0
450fc7f27b9Sdrh     **                  if the result is not yet computed.
451fc7f27b9Sdrh     **
452fc7f27b9Sdrh     ** sqlite3ExprDelete() specifically skips the recursive delete of
453fc7f27b9Sdrh     ** pLeft on TK_SELECT_COLUMN nodes.  But pRight is followed, so pVector
4548762ec19Sdrh     ** can be attached to pRight to cause this node to take ownership of
4558762ec19Sdrh     ** pVector.  Typically there will be multiple TK_SELECT_COLUMN nodes
4568762ec19Sdrh     ** with the same pLeft pointer to the pVector, but only one of them
4578762ec19Sdrh     ** will own the pVector.
458fc7f27b9Sdrh     */
459abfd35eaSdrh     pRet = sqlite3PExpr(pParse, TK_SELECT_COLUMN, 0, 0);
4608bd0d58eSdrh     if( pRet ){
4618bd0d58eSdrh       pRet->iColumn = iField;
4628bd0d58eSdrh       pRet->pLeft = pVector;
4638bd0d58eSdrh     }
464fc7f27b9Sdrh     assert( pRet==0 || pRet->iTable==0 );
465fc7f27b9Sdrh   }else{
466a1251bc4Sdrh     if( pVector->op==TK_VECTOR ) pVector = pVector->x.pList->a[iField].pExpr;
467a1251bc4Sdrh     pRet = sqlite3ExprDup(pParse->db, pVector, 0);
468fc7f27b9Sdrh   }
469fc7f27b9Sdrh   return pRet;
470fc7f27b9Sdrh }
47171c57db0Sdan 
4725c288b92Sdan /*
4735c288b92Sdan ** If expression pExpr is of type TK_SELECT, generate code to evaluate
4745c288b92Sdan ** it. Return the register in which the result is stored (or, if the
4755c288b92Sdan ** sub-select returns more than one column, the first in an array
4765c288b92Sdan ** of registers in which the result is stored).
4775c288b92Sdan **
4785c288b92Sdan ** If pExpr is not a TK_SELECT expression, return 0.
4795c288b92Sdan */
4805c288b92Sdan static int exprCodeSubselect(Parse *pParse, Expr *pExpr){
4818da209b1Sdan   int reg = 0;
482f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
4835c288b92Sdan   if( pExpr->op==TK_SELECT ){
4848da209b1Sdan     reg = sqlite3CodeSubselect(pParse, pExpr, 0, 0);
4858da209b1Sdan   }
486f9b2e05cSdan #endif
4878da209b1Sdan   return reg;
4888da209b1Sdan }
4898da209b1Sdan 
4905c288b92Sdan /*
4915c288b92Sdan ** Argument pVector points to a vector expression - either a TK_VECTOR
492870a0705Sdan ** or TK_SELECT that returns more than one column. This function returns
493870a0705Sdan ** the register number of a register that contains the value of
494870a0705Sdan ** element iField of the vector.
495870a0705Sdan **
496870a0705Sdan ** If pVector is a TK_SELECT expression, then code for it must have
497870a0705Sdan ** already been generated using the exprCodeSubselect() routine. In this
498870a0705Sdan ** case parameter regSelect should be the first in an array of registers
499870a0705Sdan ** containing the results of the sub-select.
500870a0705Sdan **
501870a0705Sdan ** If pVector is of type TK_VECTOR, then code for the requested field
502870a0705Sdan ** is generated. In this case (*pRegFree) may be set to the number of
503870a0705Sdan ** a temporary register to be freed by the caller before returning.
5045c288b92Sdan **
5055c288b92Sdan ** Before returning, output parameter (*ppExpr) is set to point to the
5065c288b92Sdan ** Expr object corresponding to element iElem of the vector.
5075c288b92Sdan */
5085c288b92Sdan static int exprVectorRegister(
5095c288b92Sdan   Parse *pParse,                  /* Parse context */
5105c288b92Sdan   Expr *pVector,                  /* Vector to extract element from */
511870a0705Sdan   int iField,                     /* Field to extract from pVector */
5125c288b92Sdan   int regSelect,                  /* First in array of registers */
5135c288b92Sdan   Expr **ppExpr,                  /* OUT: Expression element */
5145c288b92Sdan   int *pRegFree                   /* OUT: Temp register to free */
5155c288b92Sdan ){
51612abf408Sdrh   u8 op = pVector->op;
517c1bcd9ccSdrh   assert( op==TK_VECTOR || op==TK_REGISTER || op==TK_SELECT );
51812abf408Sdrh   if( op==TK_REGISTER ){
51912abf408Sdrh     *ppExpr = sqlite3VectorFieldSubexpr(pVector, iField);
52012abf408Sdrh     return pVector->iTable+iField;
52112abf408Sdrh   }
52212abf408Sdrh   if( op==TK_SELECT ){
523870a0705Sdan     *ppExpr = pVector->x.pSelect->pEList->a[iField].pExpr;
524870a0705Sdan      return regSelect+iField;
5255c288b92Sdan   }
526870a0705Sdan   *ppExpr = pVector->x.pList->a[iField].pExpr;
5275c288b92Sdan   return sqlite3ExprCodeTemp(pParse, *ppExpr, pRegFree);
5285c288b92Sdan }
5295c288b92Sdan 
5305c288b92Sdan /*
5315c288b92Sdan ** Expression pExpr is a comparison between two vector values. Compute
53279752b6eSdrh ** the result of the comparison (1, 0, or NULL) and write that
53379752b6eSdrh ** result into register dest.
53479752b6eSdrh **
53579752b6eSdrh ** The caller must satisfy the following preconditions:
53679752b6eSdrh **
53779752b6eSdrh **    if pExpr->op==TK_IS:      op==TK_EQ and p5==SQLITE_NULLEQ
53879752b6eSdrh **    if pExpr->op==TK_ISNOT:   op==TK_NE and p5==SQLITE_NULLEQ
53979752b6eSdrh **    otherwise:                op==pExpr->op and p5==0
5405c288b92Sdan */
54179752b6eSdrh static void codeVectorCompare(
54279752b6eSdrh   Parse *pParse,        /* Code generator context */
54379752b6eSdrh   Expr *pExpr,          /* The comparison operation */
54479752b6eSdrh   int dest,             /* Write results into this register */
54579752b6eSdrh   u8 op,                /* Comparison operator */
54679752b6eSdrh   u8 p5                 /* SQLITE_NULLEQ or zero */
54779752b6eSdrh ){
54871c57db0Sdan   Vdbe *v = pParse->pVdbe;
54971c57db0Sdan   Expr *pLeft = pExpr->pLeft;
55071c57db0Sdan   Expr *pRight = pExpr->pRight;
55171c57db0Sdan   int nLeft = sqlite3ExprVectorSize(pLeft);
55271c57db0Sdan   int i;
55371c57db0Sdan   int regLeft = 0;
55471c57db0Sdan   int regRight = 0;
55579752b6eSdrh   u8 opx = op;
55679752b6eSdrh   int addrDone = sqlite3VdbeMakeLabel(v);
55771c57db0Sdan 
558245ce62eSdrh   if( nLeft!=sqlite3ExprVectorSize(pRight) ){
559245ce62eSdrh     sqlite3ErrorMsg(pParse, "row value misused");
560245ce62eSdrh     return;
561245ce62eSdrh   }
56271c57db0Sdan   assert( pExpr->op==TK_EQ || pExpr->op==TK_NE
56371c57db0Sdan        || pExpr->op==TK_IS || pExpr->op==TK_ISNOT
56471c57db0Sdan        || pExpr->op==TK_LT || pExpr->op==TK_GT
56571c57db0Sdan        || pExpr->op==TK_LE || pExpr->op==TK_GE
56671c57db0Sdan   );
56779752b6eSdrh   assert( pExpr->op==op || (pExpr->op==TK_IS && op==TK_EQ)
56879752b6eSdrh             || (pExpr->op==TK_ISNOT && op==TK_NE) );
56979752b6eSdrh   assert( p5==0 || pExpr->op!=op );
57079752b6eSdrh   assert( p5==SQLITE_NULLEQ || pExpr->op==op );
57171c57db0Sdan 
57279752b6eSdrh   p5 |= SQLITE_STOREP2;
57379752b6eSdrh   if( opx==TK_LE ) opx = TK_LT;
57479752b6eSdrh   if( opx==TK_GE ) opx = TK_GT;
5755c288b92Sdan 
5765c288b92Sdan   regLeft = exprCodeSubselect(pParse, pLeft);
5775c288b92Sdan   regRight = exprCodeSubselect(pParse, pRight);
5785c288b92Sdan 
579321e828dSdrh   for(i=0; 1 /*Loop exits by "break"*/; i++){
5805c288b92Sdan     int regFree1 = 0, regFree2 = 0;
5815c288b92Sdan     Expr *pL, *pR;
5825c288b92Sdan     int r1, r2;
583321e828dSdrh     assert( i>=0 && i<nLeft );
58479752b6eSdrh     if( i>0 ) sqlite3ExprCachePush(pParse);
5855c288b92Sdan     r1 = exprVectorRegister(pParse, pLeft, i, regLeft, &pL, &regFree1);
5865c288b92Sdan     r2 = exprVectorRegister(pParse, pRight, i, regRight, &pR, &regFree2);
58779752b6eSdrh     codeCompare(pParse, pL, pR, opx, r1, r2, dest, p5);
58879752b6eSdrh     testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
58979752b6eSdrh     testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
59079752b6eSdrh     testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
59179752b6eSdrh     testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
59279752b6eSdrh     testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
59379752b6eSdrh     testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
59471c57db0Sdan     sqlite3ReleaseTempReg(pParse, regFree1);
59571c57db0Sdan     sqlite3ReleaseTempReg(pParse, regFree2);
59679752b6eSdrh     if( i>0 ) sqlite3ExprCachePop(pParse);
59779752b6eSdrh     if( i==nLeft-1 ){
59879752b6eSdrh       break;
59971c57db0Sdan     }
60079752b6eSdrh     if( opx==TK_EQ ){
60179752b6eSdrh       sqlite3VdbeAddOp2(v, OP_IfNot, dest, addrDone); VdbeCoverage(v);
60279752b6eSdrh       p5 |= SQLITE_KEEPNULL;
60379752b6eSdrh     }else if( opx==TK_NE ){
60479752b6eSdrh       sqlite3VdbeAddOp2(v, OP_If, dest, addrDone); VdbeCoverage(v);
60579752b6eSdrh       p5 |= SQLITE_KEEPNULL;
606a2f62925Sdrh     }else{
607a2f62925Sdrh       assert( op==TK_LT || op==TK_GT || op==TK_LE || op==TK_GE );
608a2f62925Sdrh       sqlite3VdbeAddOp2(v, OP_ElseNotEq, 0, addrDone);
60979752b6eSdrh       VdbeCoverageIf(v, op==TK_LT);
61079752b6eSdrh       VdbeCoverageIf(v, op==TK_GT);
61179752b6eSdrh       VdbeCoverageIf(v, op==TK_LE);
61279752b6eSdrh       VdbeCoverageIf(v, op==TK_GE);
61379752b6eSdrh       if( i==nLeft-2 ) opx = op;
61471c57db0Sdan     }
61579752b6eSdrh   }
61679752b6eSdrh   sqlite3VdbeResolveLabel(v, addrDone);
61779752b6eSdrh }
61871c57db0Sdan 
6194b5255acSdanielk1977 #if SQLITE_MAX_EXPR_DEPTH>0
6204b5255acSdanielk1977 /*
6214b5255acSdanielk1977 ** Check that argument nHeight is less than or equal to the maximum
6224b5255acSdanielk1977 ** expression depth allowed. If it is not, leave an error message in
6234b5255acSdanielk1977 ** pParse.
6244b5255acSdanielk1977 */
6257d10d5a6Sdrh int sqlite3ExprCheckHeight(Parse *pParse, int nHeight){
6264b5255acSdanielk1977   int rc = SQLITE_OK;
6274b5255acSdanielk1977   int mxHeight = pParse->db->aLimit[SQLITE_LIMIT_EXPR_DEPTH];
6284b5255acSdanielk1977   if( nHeight>mxHeight ){
6294b5255acSdanielk1977     sqlite3ErrorMsg(pParse,
6304b5255acSdanielk1977        "Expression tree is too large (maximum depth %d)", mxHeight
6314b5255acSdanielk1977     );
6324b5255acSdanielk1977     rc = SQLITE_ERROR;
6334b5255acSdanielk1977   }
6344b5255acSdanielk1977   return rc;
6354b5255acSdanielk1977 }
6364b5255acSdanielk1977 
6374b5255acSdanielk1977 /* The following three functions, heightOfExpr(), heightOfExprList()
6384b5255acSdanielk1977 ** and heightOfSelect(), are used to determine the maximum height
6394b5255acSdanielk1977 ** of any expression tree referenced by the structure passed as the
6404b5255acSdanielk1977 ** first argument.
6414b5255acSdanielk1977 **
6424b5255acSdanielk1977 ** If this maximum height is greater than the current value pointed
6434b5255acSdanielk1977 ** to by pnHeight, the second parameter, then set *pnHeight to that
6444b5255acSdanielk1977 ** value.
6454b5255acSdanielk1977 */
6464b5255acSdanielk1977 static void heightOfExpr(Expr *p, int *pnHeight){
6474b5255acSdanielk1977   if( p ){
6484b5255acSdanielk1977     if( p->nHeight>*pnHeight ){
6494b5255acSdanielk1977       *pnHeight = p->nHeight;
6504b5255acSdanielk1977     }
6514b5255acSdanielk1977   }
6524b5255acSdanielk1977 }
6534b5255acSdanielk1977 static void heightOfExprList(ExprList *p, int *pnHeight){
6544b5255acSdanielk1977   if( p ){
6554b5255acSdanielk1977     int i;
6564b5255acSdanielk1977     for(i=0; i<p->nExpr; i++){
6574b5255acSdanielk1977       heightOfExpr(p->a[i].pExpr, pnHeight);
6584b5255acSdanielk1977     }
6594b5255acSdanielk1977   }
6604b5255acSdanielk1977 }
6611a3a3086Sdan static void heightOfSelect(Select *pSelect, int *pnHeight){
6621a3a3086Sdan   Select *p;
6631a3a3086Sdan   for(p=pSelect; p; p=p->pPrior){
6644b5255acSdanielk1977     heightOfExpr(p->pWhere, pnHeight);
6654b5255acSdanielk1977     heightOfExpr(p->pHaving, pnHeight);
6664b5255acSdanielk1977     heightOfExpr(p->pLimit, pnHeight);
6674b5255acSdanielk1977     heightOfExprList(p->pEList, pnHeight);
6684b5255acSdanielk1977     heightOfExprList(p->pGroupBy, pnHeight);
6694b5255acSdanielk1977     heightOfExprList(p->pOrderBy, pnHeight);
6704b5255acSdanielk1977   }
6714b5255acSdanielk1977 }
6724b5255acSdanielk1977 
6734b5255acSdanielk1977 /*
6744b5255acSdanielk1977 ** Set the Expr.nHeight variable in the structure passed as an
6754b5255acSdanielk1977 ** argument. An expression with no children, Expr.pList or
6764b5255acSdanielk1977 ** Expr.pSelect member has a height of 1. Any other expression
6774b5255acSdanielk1977 ** has a height equal to the maximum height of any other
6784b5255acSdanielk1977 ** referenced Expr plus one.
6792308ed38Sdrh **
6802308ed38Sdrh ** Also propagate EP_Propagate flags up from Expr.x.pList to Expr.flags,
6812308ed38Sdrh ** if appropriate.
6824b5255acSdanielk1977 */
6834b5255acSdanielk1977 static void exprSetHeight(Expr *p){
6844b5255acSdanielk1977   int nHeight = 0;
6854b5255acSdanielk1977   heightOfExpr(p->pLeft, &nHeight);
6864b5255acSdanielk1977   heightOfExpr(p->pRight, &nHeight);
6876ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_xIsSelect) ){
6886ab3a2ecSdanielk1977     heightOfSelect(p->x.pSelect, &nHeight);
6892308ed38Sdrh   }else if( p->x.pList ){
6906ab3a2ecSdanielk1977     heightOfExprList(p->x.pList, &nHeight);
6912308ed38Sdrh     p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
6926ab3a2ecSdanielk1977   }
6934b5255acSdanielk1977   p->nHeight = nHeight + 1;
6944b5255acSdanielk1977 }
6954b5255acSdanielk1977 
6964b5255acSdanielk1977 /*
6974b5255acSdanielk1977 ** Set the Expr.nHeight variable using the exprSetHeight() function. If
6984b5255acSdanielk1977 ** the height is greater than the maximum allowed expression depth,
6994b5255acSdanielk1977 ** leave an error in pParse.
7002308ed38Sdrh **
7012308ed38Sdrh ** Also propagate all EP_Propagate flags from the Expr.x.pList into
7022308ed38Sdrh ** Expr.flags.
7034b5255acSdanielk1977 */
7042308ed38Sdrh void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
70574893a4cSdrh   if( pParse->nErr ) return;
7064b5255acSdanielk1977   exprSetHeight(p);
7077d10d5a6Sdrh   sqlite3ExprCheckHeight(pParse, p->nHeight);
7084b5255acSdanielk1977 }
7094b5255acSdanielk1977 
7104b5255acSdanielk1977 /*
7114b5255acSdanielk1977 ** Return the maximum height of any expression tree referenced
7124b5255acSdanielk1977 ** by the select statement passed as an argument.
7134b5255acSdanielk1977 */
7144b5255acSdanielk1977 int sqlite3SelectExprHeight(Select *p){
7154b5255acSdanielk1977   int nHeight = 0;
7164b5255acSdanielk1977   heightOfSelect(p, &nHeight);
7174b5255acSdanielk1977   return nHeight;
7184b5255acSdanielk1977 }
7192308ed38Sdrh #else /* ABOVE:  Height enforcement enabled.  BELOW: Height enforcement off */
7202308ed38Sdrh /*
7212308ed38Sdrh ** Propagate all EP_Propagate flags from the Expr.x.pList into
7222308ed38Sdrh ** Expr.flags.
7232308ed38Sdrh */
7242308ed38Sdrh void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
7252308ed38Sdrh   if( p && p->x.pList && !ExprHasProperty(p, EP_xIsSelect) ){
7262308ed38Sdrh     p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
7272308ed38Sdrh   }
7282308ed38Sdrh }
7294b5255acSdanielk1977 #define exprSetHeight(y)
7304b5255acSdanielk1977 #endif /* SQLITE_MAX_EXPR_DEPTH>0 */
7314b5255acSdanielk1977 
732be5c89acSdrh /*
733b7916a78Sdrh ** This routine is the core allocator for Expr nodes.
734b7916a78Sdrh **
735a76b5dfcSdrh ** Construct a new expression node and return a pointer to it.  Memory
736b7916a78Sdrh ** for this node and for the pToken argument is a single allocation
737b7916a78Sdrh ** obtained from sqlite3DbMalloc().  The calling function
738a76b5dfcSdrh ** is responsible for making sure the node eventually gets freed.
739b7916a78Sdrh **
740b7916a78Sdrh ** If dequote is true, then the token (if it exists) is dequoted.
741e792b5b4Sdrh ** If dequote is false, no dequoting is performed.  The deQuote
742b7916a78Sdrh ** parameter is ignored if pToken is NULL or if the token does not
743b7916a78Sdrh ** appear to be quoted.  If the quotes were of the form "..." (double-quotes)
744b7916a78Sdrh ** then the EP_DblQuoted flag is set on the expression node.
74533e619fcSdrh **
74633e619fcSdrh ** Special case:  If op==TK_INTEGER and pToken points to a string that
74733e619fcSdrh ** can be translated into a 32-bit integer, then the token is not
74833e619fcSdrh ** stored in u.zToken.  Instead, the integer values is written
74933e619fcSdrh ** into u.iValue and the EP_IntValue flag is set.  No extra storage
75033e619fcSdrh ** is allocated to hold the integer text and the dequote flag is ignored.
751a76b5dfcSdrh */
752b7916a78Sdrh Expr *sqlite3ExprAlloc(
753cca8a4adSdrh   sqlite3 *db,            /* Handle for sqlite3DbMallocRawNN() */
75417435752Sdrh   int op,                 /* Expression opcode */
755b7916a78Sdrh   const Token *pToken,    /* Token argument.  Might be NULL */
756b7916a78Sdrh   int dequote             /* True to dequote */
75717435752Sdrh ){
758a76b5dfcSdrh   Expr *pNew;
75933e619fcSdrh   int nExtra = 0;
760cf697396Sshane   int iValue = 0;
761b7916a78Sdrh 
762575fad65Sdrh   assert( db!=0 );
763b7916a78Sdrh   if( pToken ){
76433e619fcSdrh     if( op!=TK_INTEGER || pToken->z==0
76533e619fcSdrh           || sqlite3GetInt32(pToken->z, &iValue)==0 ){
766b7916a78Sdrh       nExtra = pToken->n+1;
767d50ffc41Sdrh       assert( iValue>=0 );
76833e619fcSdrh     }
769a76b5dfcSdrh   }
770575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, sizeof(Expr)+nExtra);
771b7916a78Sdrh   if( pNew ){
772ca3862dcSdrh     memset(pNew, 0, sizeof(Expr));
7731bd10f8aSdrh     pNew->op = (u8)op;
774a58fdfb1Sdanielk1977     pNew->iAgg = -1;
775a76b5dfcSdrh     if( pToken ){
77633e619fcSdrh       if( nExtra==0 ){
777b98a2e35Sdrh         pNew->flags |= EP_IntValue|EP_Leaf;
77833e619fcSdrh         pNew->u.iValue = iValue;
77933e619fcSdrh       }else{
78033e619fcSdrh         pNew->u.zToken = (char*)&pNew[1];
781b07028f7Sdrh         assert( pToken->z!=0 || pToken->n==0 );
782b07028f7Sdrh         if( pToken->n ) memcpy(pNew->u.zToken, pToken->z, pToken->n);
78333e619fcSdrh         pNew->u.zToken[pToken->n] = 0;
784244b9d6eSdrh         if( dequote && sqlite3Isquote(pNew->u.zToken[0]) ){
785244b9d6eSdrh           if( pNew->u.zToken[0]=='"' ) pNew->flags |= EP_DblQuoted;
78633e619fcSdrh           sqlite3Dequote(pNew->u.zToken);
787a34001c9Sdrh         }
788a34001c9Sdrh       }
78933e619fcSdrh     }
790b7916a78Sdrh #if SQLITE_MAX_EXPR_DEPTH>0
791b7916a78Sdrh     pNew->nHeight = 1;
792b7916a78Sdrh #endif
793a34001c9Sdrh   }
794a76b5dfcSdrh   return pNew;
795a76b5dfcSdrh }
796a76b5dfcSdrh 
797a76b5dfcSdrh /*
798b7916a78Sdrh ** Allocate a new expression node from a zero-terminated token that has
799b7916a78Sdrh ** already been dequoted.
800b7916a78Sdrh */
801b7916a78Sdrh Expr *sqlite3Expr(
802b7916a78Sdrh   sqlite3 *db,            /* Handle for sqlite3DbMallocZero() (may be null) */
803b7916a78Sdrh   int op,                 /* Expression opcode */
804b7916a78Sdrh   const char *zToken      /* Token argument.  Might be NULL */
805b7916a78Sdrh ){
806b7916a78Sdrh   Token x;
807b7916a78Sdrh   x.z = zToken;
808b40f06c6Sdrh   x.n = sqlite3Strlen30(zToken);
809b7916a78Sdrh   return sqlite3ExprAlloc(db, op, &x, 0);
810b7916a78Sdrh }
811b7916a78Sdrh 
812b7916a78Sdrh /*
813b7916a78Sdrh ** Attach subtrees pLeft and pRight to the Expr node pRoot.
814b7916a78Sdrh **
815b7916a78Sdrh ** If pRoot==NULL that means that a memory allocation error has occurred.
816b7916a78Sdrh ** In that case, delete the subtrees pLeft and pRight.
817b7916a78Sdrh */
818b7916a78Sdrh void sqlite3ExprAttachSubtrees(
819b7916a78Sdrh   sqlite3 *db,
820b7916a78Sdrh   Expr *pRoot,
821b7916a78Sdrh   Expr *pLeft,
822b7916a78Sdrh   Expr *pRight
823b7916a78Sdrh ){
824b7916a78Sdrh   if( pRoot==0 ){
825b7916a78Sdrh     assert( db->mallocFailed );
826b7916a78Sdrh     sqlite3ExprDelete(db, pLeft);
827b7916a78Sdrh     sqlite3ExprDelete(db, pRight);
828b7916a78Sdrh   }else{
829b7916a78Sdrh     if( pRight ){
830b7916a78Sdrh       pRoot->pRight = pRight;
831885a5b03Sdrh       pRoot->flags |= EP_Propagate & pRight->flags;
832b7916a78Sdrh     }
833b7916a78Sdrh     if( pLeft ){
834b7916a78Sdrh       pRoot->pLeft = pLeft;
835885a5b03Sdrh       pRoot->flags |= EP_Propagate & pLeft->flags;
836b7916a78Sdrh     }
837b7916a78Sdrh     exprSetHeight(pRoot);
838b7916a78Sdrh   }
839b7916a78Sdrh }
840b7916a78Sdrh 
841b7916a78Sdrh /*
84260ec914cSpeter.d.reid ** Allocate an Expr node which joins as many as two subtrees.
843b7916a78Sdrh **
844bf664469Sdrh ** One or both of the subtrees can be NULL.  Return a pointer to the new
845bf664469Sdrh ** Expr node.  Or, if an OOM error occurs, set pParse->db->mallocFailed,
846bf664469Sdrh ** free the subtrees and return NULL.
847206f3d96Sdrh */
84817435752Sdrh Expr *sqlite3PExpr(
84917435752Sdrh   Parse *pParse,          /* Parsing context */
85017435752Sdrh   int op,                 /* Expression opcode */
85117435752Sdrh   Expr *pLeft,            /* Left operand */
852abfd35eaSdrh   Expr *pRight            /* Right operand */
85317435752Sdrh ){
8545fb52caaSdrh   Expr *p;
8551167d327Sdrh   if( op==TK_AND && pParse->nErr==0 ){
8565fb52caaSdrh     /* Take advantage of short-circuit false optimization for AND */
8575fb52caaSdrh     p = sqlite3ExprAnd(pParse->db, pLeft, pRight);
8585fb52caaSdrh   }else{
859abfd35eaSdrh     p = sqlite3DbMallocRawNN(pParse->db, sizeof(Expr));
860abfd35eaSdrh     if( p ){
861abfd35eaSdrh       memset(p, 0, sizeof(Expr));
862abfd35eaSdrh       p->op = op & TKFLG_MASK;
863abfd35eaSdrh       p->iAgg = -1;
864abfd35eaSdrh     }
865b7916a78Sdrh     sqlite3ExprAttachSubtrees(pParse->db, p, pLeft, pRight);
8665fb52caaSdrh   }
8672b359bdbSdan   if( p ) {
8682b359bdbSdan     sqlite3ExprCheckHeight(pParse, p->nHeight);
8692b359bdbSdan   }
8704e0cff60Sdrh   return p;
8714e0cff60Sdrh }
8724e0cff60Sdrh 
8734e0cff60Sdrh /*
87408de4f79Sdrh ** Add pSelect to the Expr.x.pSelect field.  Or, if pExpr is NULL (due
87508de4f79Sdrh ** do a memory allocation failure) then delete the pSelect object.
87608de4f79Sdrh */
87708de4f79Sdrh void sqlite3PExprAddSelect(Parse *pParse, Expr *pExpr, Select *pSelect){
87808de4f79Sdrh   if( pExpr ){
87908de4f79Sdrh     pExpr->x.pSelect = pSelect;
88008de4f79Sdrh     ExprSetProperty(pExpr, EP_xIsSelect|EP_Subquery);
88108de4f79Sdrh     sqlite3ExprSetHeightAndFlags(pParse, pExpr);
88208de4f79Sdrh   }else{
88308de4f79Sdrh     assert( pParse->db->mallocFailed );
88408de4f79Sdrh     sqlite3SelectDelete(pParse->db, pSelect);
88508de4f79Sdrh   }
88608de4f79Sdrh }
88708de4f79Sdrh 
88808de4f79Sdrh 
88908de4f79Sdrh /*
890991a1985Sdrh ** If the expression is always either TRUE or FALSE (respectively),
891991a1985Sdrh ** then return 1.  If one cannot determine the truth value of the
892991a1985Sdrh ** expression at compile-time return 0.
893991a1985Sdrh **
894991a1985Sdrh ** This is an optimization.  If is OK to return 0 here even if
895991a1985Sdrh ** the expression really is always false or false (a false negative).
896991a1985Sdrh ** But it is a bug to return 1 if the expression might have different
897991a1985Sdrh ** boolean values in different circumstances (a false positive.)
8985fb52caaSdrh **
8995fb52caaSdrh ** Note that if the expression is part of conditional for a
9005fb52caaSdrh ** LEFT JOIN, then we cannot determine at compile-time whether or not
9015fb52caaSdrh ** is it true or false, so always return 0.
9025fb52caaSdrh */
903991a1985Sdrh static int exprAlwaysTrue(Expr *p){
904991a1985Sdrh   int v = 0;
905991a1985Sdrh   if( ExprHasProperty(p, EP_FromJoin) ) return 0;
906991a1985Sdrh   if( !sqlite3ExprIsInteger(p, &v) ) return 0;
907991a1985Sdrh   return v!=0;
908991a1985Sdrh }
9095fb52caaSdrh static int exprAlwaysFalse(Expr *p){
9105fb52caaSdrh   int v = 0;
9115fb52caaSdrh   if( ExprHasProperty(p, EP_FromJoin) ) return 0;
9125fb52caaSdrh   if( !sqlite3ExprIsInteger(p, &v) ) return 0;
9135fb52caaSdrh   return v==0;
9145fb52caaSdrh }
9155fb52caaSdrh 
9165fb52caaSdrh /*
91791bb0eedSdrh ** Join two expressions using an AND operator.  If either expression is
91891bb0eedSdrh ** NULL, then just return the other expression.
9195fb52caaSdrh **
9205fb52caaSdrh ** If one side or the other of the AND is known to be false, then instead
9215fb52caaSdrh ** of returning an AND expression, just return a constant expression with
9225fb52caaSdrh ** a value of false.
92391bb0eedSdrh */
9241e536953Sdanielk1977 Expr *sqlite3ExprAnd(sqlite3 *db, Expr *pLeft, Expr *pRight){
92591bb0eedSdrh   if( pLeft==0 ){
92691bb0eedSdrh     return pRight;
92791bb0eedSdrh   }else if( pRight==0 ){
92891bb0eedSdrh     return pLeft;
9295fb52caaSdrh   }else if( exprAlwaysFalse(pLeft) || exprAlwaysFalse(pRight) ){
9305fb52caaSdrh     sqlite3ExprDelete(db, pLeft);
9315fb52caaSdrh     sqlite3ExprDelete(db, pRight);
9325fb52caaSdrh     return sqlite3ExprAlloc(db, TK_INTEGER, &sqlite3IntTokens[0], 0);
93391bb0eedSdrh   }else{
934b7916a78Sdrh     Expr *pNew = sqlite3ExprAlloc(db, TK_AND, 0, 0);
935b7916a78Sdrh     sqlite3ExprAttachSubtrees(db, pNew, pLeft, pRight);
936b7916a78Sdrh     return pNew;
937a76b5dfcSdrh   }
938a76b5dfcSdrh }
939a76b5dfcSdrh 
940a76b5dfcSdrh /*
941a76b5dfcSdrh ** Construct a new expression node for a function with multiple
942a76b5dfcSdrh ** arguments.
943a76b5dfcSdrh */
94417435752Sdrh Expr *sqlite3ExprFunction(Parse *pParse, ExprList *pList, Token *pToken){
945a76b5dfcSdrh   Expr *pNew;
946633e6d57Sdrh   sqlite3 *db = pParse->db;
9474b202ae2Sdanielk1977   assert( pToken );
948b7916a78Sdrh   pNew = sqlite3ExprAlloc(db, TK_FUNCTION, pToken, 1);
949a76b5dfcSdrh   if( pNew==0 ){
950d9da78a2Sdrh     sqlite3ExprListDelete(db, pList); /* Avoid memory leak when malloc fails */
951a76b5dfcSdrh     return 0;
952a76b5dfcSdrh   }
9536ab3a2ecSdanielk1977   pNew->x.pList = pList;
954fca23557Sdrh   ExprSetProperty(pNew, EP_HasFunc);
9556ab3a2ecSdanielk1977   assert( !ExprHasProperty(pNew, EP_xIsSelect) );
9562308ed38Sdrh   sqlite3ExprSetHeightAndFlags(pParse, pNew);
957a76b5dfcSdrh   return pNew;
958a76b5dfcSdrh }
959a76b5dfcSdrh 
960a76b5dfcSdrh /*
961fa6bc000Sdrh ** Assign a variable number to an expression that encodes a wildcard
962fa6bc000Sdrh ** in the original SQL statement.
963fa6bc000Sdrh **
964fa6bc000Sdrh ** Wildcards consisting of a single "?" are assigned the next sequential
965fa6bc000Sdrh ** variable number.
966fa6bc000Sdrh **
967fa6bc000Sdrh ** Wildcards of the form "?nnn" are assigned the number "nnn".  We make
9689bf755ccSdrh ** sure "nnn" is not too big to avoid a denial of service attack when
969fa6bc000Sdrh ** the SQL statement comes from an external source.
970fa6bc000Sdrh **
97151f49f17Sdrh ** Wildcards of the form ":aaa", "@aaa", or "$aaa" are assigned the same number
972fa6bc000Sdrh ** as the previous instance of the same wildcard.  Or if this is the first
97360ec914cSpeter.d.reid ** instance of the wildcard, the next sequential variable number is
974fa6bc000Sdrh ** assigned.
975fa6bc000Sdrh */
976de25a88cSdrh void sqlite3ExprAssignVarNumber(Parse *pParse, Expr *pExpr, u32 n){
97717435752Sdrh   sqlite3 *db = pParse->db;
978b7916a78Sdrh   const char *z;
979f326d66dSdrh   ynVar x;
98017435752Sdrh 
981fa6bc000Sdrh   if( pExpr==0 ) return;
982c5cd1249Sdrh   assert( !ExprHasProperty(pExpr, EP_IntValue|EP_Reduced|EP_TokenOnly) );
98333e619fcSdrh   z = pExpr->u.zToken;
984b7916a78Sdrh   assert( z!=0 );
985b7916a78Sdrh   assert( z[0]!=0 );
986b1ed717fSmistachkin   assert( n==(u32)sqlite3Strlen30(z) );
987b7916a78Sdrh   if( z[1]==0 ){
988fa6bc000Sdrh     /* Wildcard of the form "?".  Assign the next variable number */
989b7916a78Sdrh     assert( z[0]=='?' );
990f326d66dSdrh     x = (ynVar)(++pParse->nVar);
991124c0b49Sdrh   }else{
992f326d66dSdrh     int doAdd = 0;
993124c0b49Sdrh     if( z[0]=='?' ){
994fa6bc000Sdrh       /* Wildcard of the form "?nnn".  Convert "nnn" to an integer and
995fa6bc000Sdrh       ** use it as the variable number */
996c8d735aeSdan       i64 i;
99718814dfbSdrh       int bOk;
99818814dfbSdrh       if( n==2 ){ /*OPTIMIZATION-IF-TRUE*/
99918814dfbSdrh         i = z[1]-'0';  /* The common case of ?N for a single digit N */
100018814dfbSdrh         bOk = 1;
100118814dfbSdrh       }else{
100218814dfbSdrh         bOk = 0==sqlite3Atoi64(&z[1], &i, n-1, SQLITE_UTF8);
100318814dfbSdrh       }
1004c5499befSdrh       testcase( i==0 );
1005c5499befSdrh       testcase( i==1 );
1006c5499befSdrh       testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]-1 );
1007c5499befSdrh       testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] );
1008c8d735aeSdan       if( bOk==0 || i<1 || i>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
1009fa6bc000Sdrh         sqlite3ErrorMsg(pParse, "variable number must be between ?1 and ?%d",
1010bb4957f8Sdrh             db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]);
1011c9b39288Sdrh         return;
1012fa6bc000Sdrh       }
10138e74e7baSdrh       x = (ynVar)i;
1014f326d66dSdrh       if( x>pParse->nVar ){
1015f326d66dSdrh         pParse->nVar = (int)x;
1016f326d66dSdrh         doAdd = 1;
1017f326d66dSdrh       }else if( sqlite3VListNumToName(pParse->pVList, x)==0 ){
1018f326d66dSdrh         doAdd = 1;
1019fa6bc000Sdrh       }
1020fa6bc000Sdrh     }else{
102151f49f17Sdrh       /* Wildcards like ":aaa", "$aaa" or "@aaa".  Reuse the same variable
1022fa6bc000Sdrh       ** number as the prior appearance of the same name, or if the name
1023fa6bc000Sdrh       ** has never appeared before, reuse the same variable number
1024fa6bc000Sdrh       */
10259bf755ccSdrh       x = (ynVar)sqlite3VListNameToNum(pParse->pVList, z, n);
10269bf755ccSdrh       if( x==0 ){
10279bf755ccSdrh         x = (ynVar)(++pParse->nVar);
1028f326d66dSdrh         doAdd = 1;
1029f326d66dSdrh       }
1030f326d66dSdrh     }
1031f326d66dSdrh     if( doAdd ){
10329bf755ccSdrh       pParse->pVList = sqlite3VListAdd(db, pParse->pVList, z, n, x);
1033fa6bc000Sdrh     }
1034fa6bc000Sdrh   }
1035c9b39288Sdrh   pExpr->iColumn = x;
1036f326d66dSdrh   if( x>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
1037832b2664Sdanielk1977     sqlite3ErrorMsg(pParse, "too many SQL variables");
1038832b2664Sdanielk1977   }
1039fa6bc000Sdrh }
1040fa6bc000Sdrh 
1041fa6bc000Sdrh /*
1042f6963f99Sdan ** Recursively delete an expression tree.
1043a2e00042Sdrh */
10444f0010b1Sdrh static SQLITE_NOINLINE void sqlite3ExprDeleteNN(sqlite3 *db, Expr *p){
10454f0010b1Sdrh   assert( p!=0 );
1046d50ffc41Sdrh   /* Sanity check: Assert that the IntValue is non-negative if it exists */
1047d50ffc41Sdrh   assert( !ExprHasProperty(p, EP_IntValue) || p->u.iValue>=0 );
1048209bc522Sdrh #ifdef SQLITE_DEBUG
1049209bc522Sdrh   if( ExprHasProperty(p, EP_Leaf) && !ExprHasProperty(p, EP_TokenOnly) ){
1050209bc522Sdrh     assert( p->pLeft==0 );
1051209bc522Sdrh     assert( p->pRight==0 );
1052209bc522Sdrh     assert( p->x.pSelect==0 );
1053209bc522Sdrh   }
1054209bc522Sdrh #endif
1055209bc522Sdrh   if( !ExprHasProperty(p, (EP_TokenOnly|EP_Leaf)) ){
1056c5cd1249Sdrh     /* The Expr.x union is never used at the same time as Expr.pRight */
1057c5cd1249Sdrh     assert( p->x.pList==0 || p->pRight==0 );
10584910a76dSdrh     if( p->pLeft && p->op!=TK_SELECT_COLUMN ) sqlite3ExprDeleteNN(db, p->pLeft);
1059d1086679Sdrh     if( p->pRight ){
1060d1086679Sdrh       sqlite3ExprDeleteNN(db, p->pRight);
1061d1086679Sdrh     }else if( ExprHasProperty(p, EP_xIsSelect) ){
10626ab3a2ecSdanielk1977       sqlite3SelectDelete(db, p->x.pSelect);
10636ab3a2ecSdanielk1977     }else{
10646ab3a2ecSdanielk1977       sqlite3ExprListDelete(db, p->x.pList);
10656ab3a2ecSdanielk1977     }
10666ab3a2ecSdanielk1977   }
1067209bc522Sdrh   if( ExprHasProperty(p, EP_MemToken) ) sqlite3DbFree(db, p->u.zToken);
106833e619fcSdrh   if( !ExprHasProperty(p, EP_Static) ){
1069dbd6a7dcSdrh     sqlite3DbFreeNN(db, p);
1070a2e00042Sdrh   }
107133e619fcSdrh }
10724f0010b1Sdrh void sqlite3ExprDelete(sqlite3 *db, Expr *p){
10734f0010b1Sdrh   if( p ) sqlite3ExprDeleteNN(db, p);
10744f0010b1Sdrh }
1075a2e00042Sdrh 
1076d2687b77Sdrh /*
10776ab3a2ecSdanielk1977 ** Return the number of bytes allocated for the expression structure
10786ab3a2ecSdanielk1977 ** passed as the first argument. This is always one of EXPR_FULLSIZE,
10796ab3a2ecSdanielk1977 ** EXPR_REDUCEDSIZE or EXPR_TOKENONLYSIZE.
10806ab3a2ecSdanielk1977 */
10816ab3a2ecSdanielk1977 static int exprStructSize(Expr *p){
10826ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_TokenOnly) ) return EXPR_TOKENONLYSIZE;
10836ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_Reduced) ) return EXPR_REDUCEDSIZE;
10846ab3a2ecSdanielk1977   return EXPR_FULLSIZE;
10856ab3a2ecSdanielk1977 }
10866ab3a2ecSdanielk1977 
10876ab3a2ecSdanielk1977 /*
108833e619fcSdrh ** The dupedExpr*Size() routines each return the number of bytes required
108933e619fcSdrh ** to store a copy of an expression or expression tree.  They differ in
109033e619fcSdrh ** how much of the tree is measured.
109133e619fcSdrh **
109233e619fcSdrh **     dupedExprStructSize()     Size of only the Expr structure
109333e619fcSdrh **     dupedExprNodeSize()       Size of Expr + space for token
109433e619fcSdrh **     dupedExprSize()           Expr + token + subtree components
109533e619fcSdrh **
109633e619fcSdrh ***************************************************************************
109733e619fcSdrh **
109833e619fcSdrh ** The dupedExprStructSize() function returns two values OR-ed together:
109933e619fcSdrh ** (1) the space required for a copy of the Expr structure only and
110033e619fcSdrh ** (2) the EP_xxx flags that indicate what the structure size should be.
110133e619fcSdrh ** The return values is always one of:
110233e619fcSdrh **
110333e619fcSdrh **      EXPR_FULLSIZE
110433e619fcSdrh **      EXPR_REDUCEDSIZE   | EP_Reduced
110533e619fcSdrh **      EXPR_TOKENONLYSIZE | EP_TokenOnly
110633e619fcSdrh **
110733e619fcSdrh ** The size of the structure can be found by masking the return value
110833e619fcSdrh ** of this routine with 0xfff.  The flags can be found by masking the
110933e619fcSdrh ** return value with EP_Reduced|EP_TokenOnly.
111033e619fcSdrh **
111133e619fcSdrh ** Note that with flags==EXPRDUP_REDUCE, this routines works on full-size
111233e619fcSdrh ** (unreduced) Expr objects as they or originally constructed by the parser.
111333e619fcSdrh ** During expression analysis, extra information is computed and moved into
111433e619fcSdrh ** later parts of teh Expr object and that extra information might get chopped
111533e619fcSdrh ** off if the expression is reduced.  Note also that it does not work to
111660ec914cSpeter.d.reid ** make an EXPRDUP_REDUCE copy of a reduced expression.  It is only legal
111733e619fcSdrh ** to reduce a pristine expression tree from the parser.  The implementation
111833e619fcSdrh ** of dupedExprStructSize() contain multiple assert() statements that attempt
111933e619fcSdrh ** to enforce this constraint.
11206ab3a2ecSdanielk1977 */
11216ab3a2ecSdanielk1977 static int dupedExprStructSize(Expr *p, int flags){
11226ab3a2ecSdanielk1977   int nSize;
112333e619fcSdrh   assert( flags==EXPRDUP_REDUCE || flags==0 ); /* Only one flag value allowed */
1124aecd8021Sdrh   assert( EXPR_FULLSIZE<=0xfff );
1125aecd8021Sdrh   assert( (0xfff & (EP_Reduced|EP_TokenOnly))==0 );
112643c4ac8bSdrh   if( 0==flags || p->op==TK_SELECT_COLUMN ){
11276ab3a2ecSdanielk1977     nSize = EXPR_FULLSIZE;
11286ab3a2ecSdanielk1977   }else{
1129c5cd1249Sdrh     assert( !ExprHasProperty(p, EP_TokenOnly|EP_Reduced) );
113033e619fcSdrh     assert( !ExprHasProperty(p, EP_FromJoin) );
1131c5cd1249Sdrh     assert( !ExprHasProperty(p, EP_MemToken) );
1132ebb6a65dSdrh     assert( !ExprHasProperty(p, EP_NoReduce) );
1133aecd8021Sdrh     if( p->pLeft || p->x.pList ){
113433e619fcSdrh       nSize = EXPR_REDUCEDSIZE | EP_Reduced;
113533e619fcSdrh     }else{
1136aecd8021Sdrh       assert( p->pRight==0 );
113733e619fcSdrh       nSize = EXPR_TOKENONLYSIZE | EP_TokenOnly;
113833e619fcSdrh     }
11396ab3a2ecSdanielk1977   }
11406ab3a2ecSdanielk1977   return nSize;
11416ab3a2ecSdanielk1977 }
11426ab3a2ecSdanielk1977 
11436ab3a2ecSdanielk1977 /*
114433e619fcSdrh ** This function returns the space in bytes required to store the copy
114533e619fcSdrh ** of the Expr structure and a copy of the Expr.u.zToken string (if that
114633e619fcSdrh ** string is defined.)
11476ab3a2ecSdanielk1977 */
11486ab3a2ecSdanielk1977 static int dupedExprNodeSize(Expr *p, int flags){
114933e619fcSdrh   int nByte = dupedExprStructSize(p, flags) & 0xfff;
115033e619fcSdrh   if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
115133e619fcSdrh     nByte += sqlite3Strlen30(p->u.zToken)+1;
11526ab3a2ecSdanielk1977   }
1153bc73971dSdanielk1977   return ROUND8(nByte);
11546ab3a2ecSdanielk1977 }
11556ab3a2ecSdanielk1977 
11566ab3a2ecSdanielk1977 /*
11576ab3a2ecSdanielk1977 ** Return the number of bytes required to create a duplicate of the
11586ab3a2ecSdanielk1977 ** expression passed as the first argument. The second argument is a
11596ab3a2ecSdanielk1977 ** mask containing EXPRDUP_XXX flags.
11606ab3a2ecSdanielk1977 **
11616ab3a2ecSdanielk1977 ** The value returned includes space to create a copy of the Expr struct
116233e619fcSdrh ** itself and the buffer referred to by Expr.u.zToken, if any.
11636ab3a2ecSdanielk1977 **
11646ab3a2ecSdanielk1977 ** If the EXPRDUP_REDUCE flag is set, then the return value includes
11656ab3a2ecSdanielk1977 ** space to duplicate all Expr nodes in the tree formed by Expr.pLeft
11666ab3a2ecSdanielk1977 ** and Expr.pRight variables (but not for any structures pointed to or
11676ab3a2ecSdanielk1977 ** descended from the Expr.x.pList or Expr.x.pSelect variables).
11686ab3a2ecSdanielk1977 */
11696ab3a2ecSdanielk1977 static int dupedExprSize(Expr *p, int flags){
11706ab3a2ecSdanielk1977   int nByte = 0;
11716ab3a2ecSdanielk1977   if( p ){
11726ab3a2ecSdanielk1977     nByte = dupedExprNodeSize(p, flags);
11736ab3a2ecSdanielk1977     if( flags&EXPRDUP_REDUCE ){
1174b7916a78Sdrh       nByte += dupedExprSize(p->pLeft, flags) + dupedExprSize(p->pRight, flags);
11756ab3a2ecSdanielk1977     }
11766ab3a2ecSdanielk1977   }
11776ab3a2ecSdanielk1977   return nByte;
11786ab3a2ecSdanielk1977 }
11796ab3a2ecSdanielk1977 
11806ab3a2ecSdanielk1977 /*
11816ab3a2ecSdanielk1977 ** This function is similar to sqlite3ExprDup(), except that if pzBuffer
11826ab3a2ecSdanielk1977 ** is not NULL then *pzBuffer is assumed to point to a buffer large enough
118333e619fcSdrh ** to store the copy of expression p, the copies of p->u.zToken
11846ab3a2ecSdanielk1977 ** (if applicable), and the copies of the p->pLeft and p->pRight expressions,
118560ec914cSpeter.d.reid ** if any. Before returning, *pzBuffer is set to the first byte past the
11866ab3a2ecSdanielk1977 ** portion of the buffer copied into by this function.
11876ab3a2ecSdanielk1977 */
11883c19469cSdrh static Expr *exprDup(sqlite3 *db, Expr *p, int dupFlags, u8 **pzBuffer){
11893c19469cSdrh   Expr *pNew;           /* Value to return */
11903c19469cSdrh   u8 *zAlloc;           /* Memory space from which to build Expr object */
11913c19469cSdrh   u32 staticFlag;       /* EP_Static if space not obtained from malloc */
11926ab3a2ecSdanielk1977 
11933c19469cSdrh   assert( db!=0 );
11943c19469cSdrh   assert( p );
11953c19469cSdrh   assert( dupFlags==0 || dupFlags==EXPRDUP_REDUCE );
11963c19469cSdrh   assert( pzBuffer==0 || dupFlags==EXPRDUP_REDUCE );
11976ab3a2ecSdanielk1977 
11986ab3a2ecSdanielk1977   /* Figure out where to write the new Expr structure. */
11996ab3a2ecSdanielk1977   if( pzBuffer ){
12006ab3a2ecSdanielk1977     zAlloc = *pzBuffer;
120133e619fcSdrh     staticFlag = EP_Static;
12026ab3a2ecSdanielk1977   }else{
12033c19469cSdrh     zAlloc = sqlite3DbMallocRawNN(db, dupedExprSize(p, dupFlags));
12043c19469cSdrh     staticFlag = 0;
12056ab3a2ecSdanielk1977   }
12066ab3a2ecSdanielk1977   pNew = (Expr *)zAlloc;
12076ab3a2ecSdanielk1977 
12086ab3a2ecSdanielk1977   if( pNew ){
12096ab3a2ecSdanielk1977     /* Set nNewSize to the size allocated for the structure pointed to
12106ab3a2ecSdanielk1977     ** by pNew. This is either EXPR_FULLSIZE, EXPR_REDUCEDSIZE or
12116ab3a2ecSdanielk1977     ** EXPR_TOKENONLYSIZE. nToken is set to the number of bytes consumed
121233e619fcSdrh     ** by the copy of the p->u.zToken string (if any).
12136ab3a2ecSdanielk1977     */
12143c19469cSdrh     const unsigned nStructSize = dupedExprStructSize(p, dupFlags);
121533e619fcSdrh     const int nNewSize = nStructSize & 0xfff;
121633e619fcSdrh     int nToken;
121733e619fcSdrh     if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
121833e619fcSdrh       nToken = sqlite3Strlen30(p->u.zToken) + 1;
121933e619fcSdrh     }else{
122033e619fcSdrh       nToken = 0;
122133e619fcSdrh     }
12223c19469cSdrh     if( dupFlags ){
12236ab3a2ecSdanielk1977       assert( ExprHasProperty(p, EP_Reduced)==0 );
12246ab3a2ecSdanielk1977       memcpy(zAlloc, p, nNewSize);
12256ab3a2ecSdanielk1977     }else{
12263e6a1411Sdan       u32 nSize = (u32)exprStructSize(p);
12276ab3a2ecSdanielk1977       memcpy(zAlloc, p, nSize);
122872ea29d7Sdrh       if( nSize<EXPR_FULLSIZE ){
12296ab3a2ecSdanielk1977         memset(&zAlloc[nSize], 0, EXPR_FULLSIZE-nSize);
12306ab3a2ecSdanielk1977       }
123172ea29d7Sdrh     }
12326ab3a2ecSdanielk1977 
123333e619fcSdrh     /* Set the EP_Reduced, EP_TokenOnly, and EP_Static flags appropriately. */
1234c5cd1249Sdrh     pNew->flags &= ~(EP_Reduced|EP_TokenOnly|EP_Static|EP_MemToken);
123533e619fcSdrh     pNew->flags |= nStructSize & (EP_Reduced|EP_TokenOnly);
123633e619fcSdrh     pNew->flags |= staticFlag;
12376ab3a2ecSdanielk1977 
123833e619fcSdrh     /* Copy the p->u.zToken string, if any. */
12396ab3a2ecSdanielk1977     if( nToken ){
124033e619fcSdrh       char *zToken = pNew->u.zToken = (char*)&zAlloc[nNewSize];
124133e619fcSdrh       memcpy(zToken, p->u.zToken, nToken);
12426ab3a2ecSdanielk1977     }
12436ab3a2ecSdanielk1977 
1244209bc522Sdrh     if( 0==((p->flags|pNew->flags) & (EP_TokenOnly|EP_Leaf)) ){
12456ab3a2ecSdanielk1977       /* Fill in the pNew->x.pSelect or pNew->x.pList member. */
12466ab3a2ecSdanielk1977       if( ExprHasProperty(p, EP_xIsSelect) ){
12473c19469cSdrh         pNew->x.pSelect = sqlite3SelectDup(db, p->x.pSelect, dupFlags);
12486ab3a2ecSdanielk1977       }else{
12493c19469cSdrh         pNew->x.pList = sqlite3ExprListDup(db, p->x.pList, dupFlags);
12506ab3a2ecSdanielk1977       }
12516ab3a2ecSdanielk1977     }
12526ab3a2ecSdanielk1977 
12536ab3a2ecSdanielk1977     /* Fill in pNew->pLeft and pNew->pRight. */
1254c5cd1249Sdrh     if( ExprHasProperty(pNew, EP_Reduced|EP_TokenOnly) ){
12553c19469cSdrh       zAlloc += dupedExprNodeSize(p, dupFlags);
1256209bc522Sdrh       if( !ExprHasProperty(pNew, EP_TokenOnly|EP_Leaf) ){
12573c19469cSdrh         pNew->pLeft = p->pLeft ?
12583c19469cSdrh                       exprDup(db, p->pLeft, EXPRDUP_REDUCE, &zAlloc) : 0;
12593c19469cSdrh         pNew->pRight = p->pRight ?
12603c19469cSdrh                        exprDup(db, p->pRight, EXPRDUP_REDUCE, &zAlloc) : 0;
12616ab3a2ecSdanielk1977       }
12626ab3a2ecSdanielk1977       if( pzBuffer ){
12636ab3a2ecSdanielk1977         *pzBuffer = zAlloc;
12646ab3a2ecSdanielk1977       }
1265b7916a78Sdrh     }else{
1266209bc522Sdrh       if( !ExprHasProperty(p, EP_TokenOnly|EP_Leaf) ){
12679854260bSdrh         if( pNew->op==TK_SELECT_COLUMN ){
12689854260bSdrh           pNew->pLeft = p->pLeft;
126947073f62Sdrh           assert( p->iColumn==0 || p->pRight==0 );
127047073f62Sdrh           assert( p->pRight==0  || p->pRight==p->pLeft );
12719854260bSdrh         }else{
12726ab3a2ecSdanielk1977           pNew->pLeft = sqlite3ExprDup(db, p->pLeft, 0);
12739854260bSdrh         }
12746ab3a2ecSdanielk1977         pNew->pRight = sqlite3ExprDup(db, p->pRight, 0);
12756ab3a2ecSdanielk1977       }
12766ab3a2ecSdanielk1977     }
12776ab3a2ecSdanielk1977   }
12786ab3a2ecSdanielk1977   return pNew;
12796ab3a2ecSdanielk1977 }
12806ab3a2ecSdanielk1977 
12816ab3a2ecSdanielk1977 /*
1282bfe31e7fSdan ** Create and return a deep copy of the object passed as the second
1283bfe31e7fSdan ** argument. If an OOM condition is encountered, NULL is returned
1284bfe31e7fSdan ** and the db->mallocFailed flag set.
1285bfe31e7fSdan */
1286eede6a53Sdan #ifndef SQLITE_OMIT_CTE
1287bfe31e7fSdan static With *withDup(sqlite3 *db, With *p){
12884e9119d9Sdan   With *pRet = 0;
12894e9119d9Sdan   if( p ){
12904e9119d9Sdan     int nByte = sizeof(*p) + sizeof(p->a[0]) * (p->nCte-1);
12914e9119d9Sdan     pRet = sqlite3DbMallocZero(db, nByte);
12924e9119d9Sdan     if( pRet ){
12934e9119d9Sdan       int i;
12944e9119d9Sdan       pRet->nCte = p->nCte;
12954e9119d9Sdan       for(i=0; i<p->nCte; i++){
12964e9119d9Sdan         pRet->a[i].pSelect = sqlite3SelectDup(db, p->a[i].pSelect, 0);
12974e9119d9Sdan         pRet->a[i].pCols = sqlite3ExprListDup(db, p->a[i].pCols, 0);
12984e9119d9Sdan         pRet->a[i].zName = sqlite3DbStrDup(db, p->a[i].zName);
12994e9119d9Sdan       }
13004e9119d9Sdan     }
13014e9119d9Sdan   }
13024e9119d9Sdan   return pRet;
13034e9119d9Sdan }
1304eede6a53Sdan #else
1305eede6a53Sdan # define withDup(x,y) 0
1306eede6a53Sdan #endif
13074e9119d9Sdan 
1308a76b5dfcSdrh /*
1309ff78bd2fSdrh ** The following group of routines make deep copies of expressions,
1310ff78bd2fSdrh ** expression lists, ID lists, and select statements.  The copies can
1311ff78bd2fSdrh ** be deleted (by being passed to their respective ...Delete() routines)
1312ff78bd2fSdrh ** without effecting the originals.
1313ff78bd2fSdrh **
13144adee20fSdanielk1977 ** The expression list, ID, and source lists return by sqlite3ExprListDup(),
13154adee20fSdanielk1977 ** sqlite3IdListDup(), and sqlite3SrcListDup() can not be further expanded
1316ad3cab52Sdrh ** by subsequent calls to sqlite*ListAppend() routines.
1317ff78bd2fSdrh **
1318ad3cab52Sdrh ** Any tables that the SrcList might point to are not duplicated.
13196ab3a2ecSdanielk1977 **
1320b7916a78Sdrh ** The flags parameter contains a combination of the EXPRDUP_XXX flags.
13216ab3a2ecSdanielk1977 ** If the EXPRDUP_REDUCE flag is set, then the structure returned is a
13226ab3a2ecSdanielk1977 ** truncated version of the usual Expr structure that will be stored as
13236ab3a2ecSdanielk1977 ** part of the in-memory representation of the database schema.
1324ff78bd2fSdrh */
13256ab3a2ecSdanielk1977 Expr *sqlite3ExprDup(sqlite3 *db, Expr *p, int flags){
132672ea29d7Sdrh   assert( flags==0 || flags==EXPRDUP_REDUCE );
13273c19469cSdrh   return p ? exprDup(db, p, flags, 0) : 0;
1328ff78bd2fSdrh }
13296ab3a2ecSdanielk1977 ExprList *sqlite3ExprListDup(sqlite3 *db, ExprList *p, int flags){
1330ff78bd2fSdrh   ExprList *pNew;
1331145716b3Sdrh   struct ExprList_item *pItem, *pOldItem;
1332ff78bd2fSdrh   int i;
1333b163748eSdrh   Expr *pPriorSelectCol = 0;
1334575fad65Sdrh   assert( db!=0 );
1335ff78bd2fSdrh   if( p==0 ) return 0;
133697258194Sdrh   pNew = sqlite3DbMallocRawNN(db, sqlite3DbMallocSize(db, p));
1337ff78bd2fSdrh   if( pNew==0 ) return 0;
1338a19543feSdrh   pNew->nExpr = p->nExpr;
133943606175Sdrh   pItem = pNew->a;
1340145716b3Sdrh   pOldItem = p->a;
1341145716b3Sdrh   for(i=0; i<p->nExpr; i++, pItem++, pOldItem++){
13426ab3a2ecSdanielk1977     Expr *pOldExpr = pOldItem->pExpr;
134347073f62Sdrh     Expr *pNewExpr;
1344b5526ea6Sdrh     pItem->pExpr = sqlite3ExprDup(db, pOldExpr, flags);
134547073f62Sdrh     if( pOldExpr
134647073f62Sdrh      && pOldExpr->op==TK_SELECT_COLUMN
134747073f62Sdrh      && (pNewExpr = pItem->pExpr)!=0
134847073f62Sdrh     ){
134947073f62Sdrh       assert( pNewExpr->iColumn==0 || i>0 );
135047073f62Sdrh       if( pNewExpr->iColumn==0 ){
135147073f62Sdrh         assert( pOldExpr->pLeft==pOldExpr->pRight );
1352b163748eSdrh         pPriorSelectCol = pNewExpr->pLeft = pNewExpr->pRight;
1353b163748eSdrh       }else{
1354b163748eSdrh         assert( i>0 );
1355b163748eSdrh         assert( pItem[-1].pExpr!=0 );
1356b163748eSdrh         assert( pNewExpr->iColumn==pItem[-1].pExpr->iColumn+1 );
1357b163748eSdrh         assert( pPriorSelectCol==pItem[-1].pExpr->pLeft );
1358b163748eSdrh         pNewExpr->pLeft = pPriorSelectCol;
135947073f62Sdrh       }
136047073f62Sdrh     }
136117435752Sdrh     pItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
1362b7916a78Sdrh     pItem->zSpan = sqlite3DbStrDup(db, pOldItem->zSpan);
1363145716b3Sdrh     pItem->sortOrder = pOldItem->sortOrder;
13643e7bc9caSdrh     pItem->done = 0;
13652c036cffSdrh     pItem->bSpanIsTab = pOldItem->bSpanIsTab;
1366c2acc4e4Sdrh     pItem->u = pOldItem->u;
1367ff78bd2fSdrh   }
1368ff78bd2fSdrh   return pNew;
1369ff78bd2fSdrh }
137093758c8dSdanielk1977 
137193758c8dSdanielk1977 /*
137293758c8dSdanielk1977 ** If cursors, triggers, views and subqueries are all omitted from
137393758c8dSdanielk1977 ** the build, then none of the following routines, except for
137493758c8dSdanielk1977 ** sqlite3SelectDup(), can be called. sqlite3SelectDup() is sometimes
137593758c8dSdanielk1977 ** called with a NULL argument.
137693758c8dSdanielk1977 */
13776a67fe8eSdanielk1977 #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_TRIGGER) \
13786a67fe8eSdanielk1977  || !defined(SQLITE_OMIT_SUBQUERY)
13796ab3a2ecSdanielk1977 SrcList *sqlite3SrcListDup(sqlite3 *db, SrcList *p, int flags){
1380ad3cab52Sdrh   SrcList *pNew;
1381ad3cab52Sdrh   int i;
1382113088ecSdrh   int nByte;
1383575fad65Sdrh   assert( db!=0 );
1384ad3cab52Sdrh   if( p==0 ) return 0;
1385113088ecSdrh   nByte = sizeof(*p) + (p->nSrc>0 ? sizeof(p->a[0]) * (p->nSrc-1) : 0);
1386575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, nByte );
1387ad3cab52Sdrh   if( pNew==0 ) return 0;
13884305d103Sdrh   pNew->nSrc = pNew->nAlloc = p->nSrc;
1389ad3cab52Sdrh   for(i=0; i<p->nSrc; i++){
13904efc4754Sdrh     struct SrcList_item *pNewItem = &pNew->a[i];
13914efc4754Sdrh     struct SrcList_item *pOldItem = &p->a[i];
1392ed8a3bb1Sdrh     Table *pTab;
139341fb5cd1Sdan     pNewItem->pSchema = pOldItem->pSchema;
139417435752Sdrh     pNewItem->zDatabase = sqlite3DbStrDup(db, pOldItem->zDatabase);
139517435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
139617435752Sdrh     pNewItem->zAlias = sqlite3DbStrDup(db, pOldItem->zAlias);
13978a48b9c0Sdrh     pNewItem->fg = pOldItem->fg;
13984efc4754Sdrh     pNewItem->iCursor = pOldItem->iCursor;
13995b6a9ed4Sdrh     pNewItem->addrFillSub = pOldItem->addrFillSub;
14005b6a9ed4Sdrh     pNewItem->regReturn = pOldItem->regReturn;
14018a48b9c0Sdrh     if( pNewItem->fg.isIndexedBy ){
14028a48b9c0Sdrh       pNewItem->u1.zIndexedBy = sqlite3DbStrDup(db, pOldItem->u1.zIndexedBy);
14038a48b9c0Sdrh     }
14048a48b9c0Sdrh     pNewItem->pIBIndex = pOldItem->pIBIndex;
14058a48b9c0Sdrh     if( pNewItem->fg.isTabFunc ){
14068a48b9c0Sdrh       pNewItem->u1.pFuncArg =
14078a48b9c0Sdrh           sqlite3ExprListDup(db, pOldItem->u1.pFuncArg, flags);
14088a48b9c0Sdrh     }
1409ed8a3bb1Sdrh     pTab = pNewItem->pTab = pOldItem->pTab;
1410ed8a3bb1Sdrh     if( pTab ){
141179df7782Sdrh       pTab->nTabRef++;
1412a1cb183dSdanielk1977     }
14136ab3a2ecSdanielk1977     pNewItem->pSelect = sqlite3SelectDup(db, pOldItem->pSelect, flags);
14146ab3a2ecSdanielk1977     pNewItem->pOn = sqlite3ExprDup(db, pOldItem->pOn, flags);
141517435752Sdrh     pNewItem->pUsing = sqlite3IdListDup(db, pOldItem->pUsing);
14166c18b6e0Sdanielk1977     pNewItem->colUsed = pOldItem->colUsed;
1417ad3cab52Sdrh   }
1418ad3cab52Sdrh   return pNew;
1419ad3cab52Sdrh }
142017435752Sdrh IdList *sqlite3IdListDup(sqlite3 *db, IdList *p){
1421ff78bd2fSdrh   IdList *pNew;
1422ff78bd2fSdrh   int i;
1423575fad65Sdrh   assert( db!=0 );
1424ff78bd2fSdrh   if( p==0 ) return 0;
1425575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, sizeof(*pNew) );
1426ff78bd2fSdrh   if( pNew==0 ) return 0;
14276c535158Sdrh   pNew->nId = p->nId;
1428575fad65Sdrh   pNew->a = sqlite3DbMallocRawNN(db, p->nId*sizeof(p->a[0]) );
1429d5d56523Sdanielk1977   if( pNew->a==0 ){
1430dbd6a7dcSdrh     sqlite3DbFreeNN(db, pNew);
1431d5d56523Sdanielk1977     return 0;
1432d5d56523Sdanielk1977   }
14336c535158Sdrh   /* Note that because the size of the allocation for p->a[] is not
14346c535158Sdrh   ** necessarily a power of two, sqlite3IdListAppend() may not be called
14356c535158Sdrh   ** on the duplicate created by this function. */
1436ff78bd2fSdrh   for(i=0; i<p->nId; i++){
14374efc4754Sdrh     struct IdList_item *pNewItem = &pNew->a[i];
14384efc4754Sdrh     struct IdList_item *pOldItem = &p->a[i];
143917435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
14404efc4754Sdrh     pNewItem->idx = pOldItem->idx;
1441ff78bd2fSdrh   }
1442ff78bd2fSdrh   return pNew;
1443ff78bd2fSdrh }
1444a7466205Sdan Select *sqlite3SelectDup(sqlite3 *db, Select *pDup, int flags){
1445a7466205Sdan   Select *pRet = 0;
1446a7466205Sdan   Select *pNext = 0;
1447a7466205Sdan   Select **pp = &pRet;
1448a7466205Sdan   Select *p;
1449a7466205Sdan 
1450575fad65Sdrh   assert( db!=0 );
1451a7466205Sdan   for(p=pDup; p; p=p->pPrior){
1452a7466205Sdan     Select *pNew = sqlite3DbMallocRawNN(db, sizeof(*p) );
1453a7466205Sdan     if( pNew==0 ) break;
1454b7916a78Sdrh     pNew->pEList = sqlite3ExprListDup(db, p->pEList, flags);
14556ab3a2ecSdanielk1977     pNew->pSrc = sqlite3SrcListDup(db, p->pSrc, flags);
14566ab3a2ecSdanielk1977     pNew->pWhere = sqlite3ExprDup(db, p->pWhere, flags);
14576ab3a2ecSdanielk1977     pNew->pGroupBy = sqlite3ExprListDup(db, p->pGroupBy, flags);
14586ab3a2ecSdanielk1977     pNew->pHaving = sqlite3ExprDup(db, p->pHaving, flags);
14596ab3a2ecSdanielk1977     pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, flags);
1460ff78bd2fSdrh     pNew->op = p->op;
1461a7466205Sdan     pNew->pNext = pNext;
1462a7466205Sdan     pNew->pPrior = 0;
14636ab3a2ecSdanielk1977     pNew->pLimit = sqlite3ExprDup(db, p->pLimit, flags);
146492b01d53Sdrh     pNew->iLimit = 0;
146592b01d53Sdrh     pNew->iOffset = 0;
14667d10d5a6Sdrh     pNew->selFlags = p->selFlags & ~SF_UsesEphemeral;
1467b9bb7c18Sdrh     pNew->addrOpenEphm[0] = -1;
1468b9bb7c18Sdrh     pNew->addrOpenEphm[1] = -1;
1469ec2da854Sdrh     pNew->nSelectRow = p->nSelectRow;
14704e9119d9Sdan     pNew->pWith = withDup(db, p->pWith);
1471eb9b884cSdrh     sqlite3SelectSetName(pNew, p->zSelName);
1472a7466205Sdan     *pp = pNew;
1473a7466205Sdan     pp = &pNew->pPrior;
1474a7466205Sdan     pNext = pNew;
1475a7466205Sdan   }
1476a7466205Sdan 
1477a7466205Sdan   return pRet;
1478ff78bd2fSdrh }
147993758c8dSdanielk1977 #else
14806ab3a2ecSdanielk1977 Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
148193758c8dSdanielk1977   assert( p==0 );
148293758c8dSdanielk1977   return 0;
148393758c8dSdanielk1977 }
148493758c8dSdanielk1977 #endif
1485ff78bd2fSdrh 
1486ff78bd2fSdrh 
1487ff78bd2fSdrh /*
1488a76b5dfcSdrh ** Add a new element to the end of an expression list.  If pList is
1489a76b5dfcSdrh ** initially NULL, then create a new expression list.
1490b7916a78Sdrh **
1491a19543feSdrh ** The pList argument must be either NULL or a pointer to an ExprList
1492a19543feSdrh ** obtained from a prior call to sqlite3ExprListAppend().  This routine
1493a19543feSdrh ** may not be used with an ExprList obtained from sqlite3ExprListDup().
1494a19543feSdrh ** Reason:  This routine assumes that the number of slots in pList->a[]
1495a19543feSdrh ** is a power of two.  That is true for sqlite3ExprListAppend() returns
1496a19543feSdrh ** but is not necessarily true from the return value of sqlite3ExprListDup().
1497a19543feSdrh **
1498b7916a78Sdrh ** If a memory allocation error occurs, the entire list is freed and
1499b7916a78Sdrh ** NULL is returned.  If non-NULL is returned, then it is guaranteed
1500b7916a78Sdrh ** that the new entry was successfully appended.
1501a76b5dfcSdrh */
150217435752Sdrh ExprList *sqlite3ExprListAppend(
150317435752Sdrh   Parse *pParse,          /* Parsing context */
150417435752Sdrh   ExprList *pList,        /* List to which to append. Might be NULL */
1505b7916a78Sdrh   Expr *pExpr             /* Expression to be appended. Might be NULL */
150617435752Sdrh ){
150743606175Sdrh   struct ExprList_item *pItem;
150817435752Sdrh   sqlite3 *db = pParse->db;
1509575fad65Sdrh   assert( db!=0 );
1510a76b5dfcSdrh   if( pList==0 ){
1511575fad65Sdrh     pList = sqlite3DbMallocRawNN(db, sizeof(ExprList) );
1512a76b5dfcSdrh     if( pList==0 ){
1513d5d56523Sdanielk1977       goto no_mem;
1514a76b5dfcSdrh     }
1515c263f7c4Sdrh     pList->nExpr = 0;
1516a19543feSdrh   }else if( (pList->nExpr & (pList->nExpr-1))==0 ){
151743606175Sdrh     ExprList *pNew;
151843606175Sdrh     pNew = sqlite3DbRealloc(db, pList,
1519a19543feSdrh              sizeof(*pList)+(2*pList->nExpr - 1)*sizeof(pList->a[0]));
152043606175Sdrh     if( pNew==0 ){
1521d5d56523Sdanielk1977       goto no_mem;
1522a76b5dfcSdrh     }
152343606175Sdrh     pList = pNew;
1524a76b5dfcSdrh   }
152543606175Sdrh   pItem = &pList->a[pList->nExpr++];
1526a8b9793cSdrh   assert( offsetof(struct ExprList_item,zName)==sizeof(pItem->pExpr) );
1527a8b9793cSdrh   assert( offsetof(struct ExprList_item,pExpr)==0 );
1528a8b9793cSdrh   memset(&pItem->zName,0,sizeof(*pItem)-offsetof(struct ExprList_item,zName));
1529e94ddc9eSdanielk1977   pItem->pExpr = pExpr;
1530a76b5dfcSdrh   return pList;
1531d5d56523Sdanielk1977 
1532d5d56523Sdanielk1977 no_mem:
1533d5d56523Sdanielk1977   /* Avoid leaking memory if malloc has failed. */
1534633e6d57Sdrh   sqlite3ExprDelete(db, pExpr);
1535633e6d57Sdrh   sqlite3ExprListDelete(db, pList);
1536d5d56523Sdanielk1977   return 0;
1537a76b5dfcSdrh }
1538a76b5dfcSdrh 
1539a76b5dfcSdrh /*
15408762ec19Sdrh ** pColumns and pExpr form a vector assignment which is part of the SET
15418762ec19Sdrh ** clause of an UPDATE statement.  Like this:
1542a1251bc4Sdrh **
1543a1251bc4Sdrh **        (a,b,c) = (expr1,expr2,expr3)
1544a1251bc4Sdrh ** Or:    (a,b,c) = (SELECT x,y,z FROM ....)
1545a1251bc4Sdrh **
1546a1251bc4Sdrh ** For each term of the vector assignment, append new entries to the
1547b67343d0Sdrh ** expression list pList.  In the case of a subquery on the RHS, append
1548a1251bc4Sdrh ** TK_SELECT_COLUMN expressions.
1549a1251bc4Sdrh */
1550a1251bc4Sdrh ExprList *sqlite3ExprListAppendVector(
1551a1251bc4Sdrh   Parse *pParse,         /* Parsing context */
1552a1251bc4Sdrh   ExprList *pList,       /* List to which to append. Might be NULL */
1553a1251bc4Sdrh   IdList *pColumns,      /* List of names of LHS of the assignment */
1554a1251bc4Sdrh   Expr *pExpr            /* Vector expression to be appended. Might be NULL */
1555a1251bc4Sdrh ){
1556a1251bc4Sdrh   sqlite3 *db = pParse->db;
1557a1251bc4Sdrh   int n;
1558a1251bc4Sdrh   int i;
155966860af3Sdrh   int iFirst = pList ? pList->nExpr : 0;
1560321e828dSdrh   /* pColumns can only be NULL due to an OOM but an OOM will cause an
1561321e828dSdrh   ** exit prior to this routine being invoked */
1562321e828dSdrh   if( NEVER(pColumns==0) ) goto vector_append_error;
1563a1251bc4Sdrh   if( pExpr==0 ) goto vector_append_error;
1564966e2911Sdrh 
1565966e2911Sdrh   /* If the RHS is a vector, then we can immediately check to see that
1566966e2911Sdrh   ** the size of the RHS and LHS match.  But if the RHS is a SELECT,
1567966e2911Sdrh   ** wildcards ("*") in the result set of the SELECT must be expanded before
1568966e2911Sdrh   ** we can do the size check, so defer the size check until code generation.
1569966e2911Sdrh   */
1570966e2911Sdrh   if( pExpr->op!=TK_SELECT && pColumns->nId!=(n=sqlite3ExprVectorSize(pExpr)) ){
1571a1251bc4Sdrh     sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
1572a1251bc4Sdrh                     pColumns->nId, n);
1573a1251bc4Sdrh     goto vector_append_error;
1574a1251bc4Sdrh   }
1575966e2911Sdrh 
1576966e2911Sdrh   for(i=0; i<pColumns->nId; i++){
1577a1251bc4Sdrh     Expr *pSubExpr = sqlite3ExprForVectorField(pParse, pExpr, i);
1578a1251bc4Sdrh     pList = sqlite3ExprListAppend(pParse, pList, pSubExpr);
1579a1251bc4Sdrh     if( pList ){
158066860af3Sdrh       assert( pList->nExpr==iFirst+i+1 );
1581a1251bc4Sdrh       pList->a[pList->nExpr-1].zName = pColumns->a[i].zName;
1582a1251bc4Sdrh       pColumns->a[i].zName = 0;
1583a1251bc4Sdrh     }
1584a1251bc4Sdrh   }
1585966e2911Sdrh 
1586ffe28059Sdrh   if( !db->mallocFailed && pExpr->op==TK_SELECT && ALWAYS(pList!=0) ){
1587966e2911Sdrh     Expr *pFirst = pList->a[iFirst].pExpr;
1588f4dd26c5Sdrh     assert( pFirst!=0 );
1589966e2911Sdrh     assert( pFirst->op==TK_SELECT_COLUMN );
1590966e2911Sdrh 
1591966e2911Sdrh     /* Store the SELECT statement in pRight so it will be deleted when
1592966e2911Sdrh     ** sqlite3ExprListDelete() is called */
1593966e2911Sdrh     pFirst->pRight = pExpr;
1594a1251bc4Sdrh     pExpr = 0;
1595966e2911Sdrh 
1596966e2911Sdrh     /* Remember the size of the LHS in iTable so that we can check that
1597966e2911Sdrh     ** the RHS and LHS sizes match during code generation. */
1598966e2911Sdrh     pFirst->iTable = pColumns->nId;
1599a1251bc4Sdrh   }
1600a1251bc4Sdrh 
1601a1251bc4Sdrh vector_append_error:
1602a1251bc4Sdrh   sqlite3ExprDelete(db, pExpr);
1603a1251bc4Sdrh   sqlite3IdListDelete(db, pColumns);
1604a1251bc4Sdrh   return pList;
1605a1251bc4Sdrh }
1606a1251bc4Sdrh 
1607a1251bc4Sdrh /*
1608bc622bc0Sdrh ** Set the sort order for the last element on the given ExprList.
1609bc622bc0Sdrh */
1610bc622bc0Sdrh void sqlite3ExprListSetSortOrder(ExprList *p, int iSortOrder){
1611bc622bc0Sdrh   if( p==0 ) return;
1612bc622bc0Sdrh   assert( SQLITE_SO_UNDEFINED<0 && SQLITE_SO_ASC>=0 && SQLITE_SO_DESC>0 );
1613bc622bc0Sdrh   assert( p->nExpr>0 );
1614bc622bc0Sdrh   if( iSortOrder<0 ){
1615bc622bc0Sdrh     assert( p->a[p->nExpr-1].sortOrder==SQLITE_SO_ASC );
1616bc622bc0Sdrh     return;
1617bc622bc0Sdrh   }
1618bc622bc0Sdrh   p->a[p->nExpr-1].sortOrder = (u8)iSortOrder;
1619bc622bc0Sdrh }
1620bc622bc0Sdrh 
1621bc622bc0Sdrh /*
1622b7916a78Sdrh ** Set the ExprList.a[].zName element of the most recently added item
1623b7916a78Sdrh ** on the expression list.
1624b7916a78Sdrh **
1625b7916a78Sdrh ** pList might be NULL following an OOM error.  But pName should never be
1626b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1627b7916a78Sdrh ** is set.
1628b7916a78Sdrh */
1629b7916a78Sdrh void sqlite3ExprListSetName(
1630b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1631b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
1632b7916a78Sdrh   Token *pName,           /* Name to be added */
1633b7916a78Sdrh   int dequote             /* True to cause the name to be dequoted */
1634b7916a78Sdrh ){
1635b7916a78Sdrh   assert( pList!=0 || pParse->db->mallocFailed!=0 );
1636b7916a78Sdrh   if( pList ){
1637b7916a78Sdrh     struct ExprList_item *pItem;
1638b7916a78Sdrh     assert( pList->nExpr>0 );
1639b7916a78Sdrh     pItem = &pList->a[pList->nExpr-1];
1640b7916a78Sdrh     assert( pItem->zName==0 );
1641b7916a78Sdrh     pItem->zName = sqlite3DbStrNDup(pParse->db, pName->z, pName->n);
1642244b9d6eSdrh     if( dequote ) sqlite3Dequote(pItem->zName);
1643b7916a78Sdrh   }
1644b7916a78Sdrh }
1645b7916a78Sdrh 
1646b7916a78Sdrh /*
1647b7916a78Sdrh ** Set the ExprList.a[].zSpan element of the most recently added item
1648b7916a78Sdrh ** on the expression list.
1649b7916a78Sdrh **
1650b7916a78Sdrh ** pList might be NULL following an OOM error.  But pSpan should never be
1651b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1652b7916a78Sdrh ** is set.
1653b7916a78Sdrh */
1654b7916a78Sdrh void sqlite3ExprListSetSpan(
1655b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1656b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
16571be266baSdrh   const char *zStart,     /* Start of the span */
16581be266baSdrh   const char *zEnd        /* End of the span */
1659b7916a78Sdrh ){
1660b7916a78Sdrh   sqlite3 *db = pParse->db;
1661b7916a78Sdrh   assert( pList!=0 || db->mallocFailed!=0 );
1662b7916a78Sdrh   if( pList ){
1663b7916a78Sdrh     struct ExprList_item *pItem = &pList->a[pList->nExpr-1];
1664b7916a78Sdrh     assert( pList->nExpr>0 );
1665b7916a78Sdrh     sqlite3DbFree(db, pItem->zSpan);
16669b2e0435Sdrh     pItem->zSpan = sqlite3DbSpanDup(db, zStart, zEnd);
1667b7916a78Sdrh   }
1668b7916a78Sdrh }
1669b7916a78Sdrh 
1670b7916a78Sdrh /*
16717a15a4beSdanielk1977 ** If the expression list pEList contains more than iLimit elements,
16727a15a4beSdanielk1977 ** leave an error message in pParse.
16737a15a4beSdanielk1977 */
16747a15a4beSdanielk1977 void sqlite3ExprListCheckLength(
16757a15a4beSdanielk1977   Parse *pParse,
16767a15a4beSdanielk1977   ExprList *pEList,
16777a15a4beSdanielk1977   const char *zObject
16787a15a4beSdanielk1977 ){
1679b1a6c3c1Sdrh   int mx = pParse->db->aLimit[SQLITE_LIMIT_COLUMN];
1680c5499befSdrh   testcase( pEList && pEList->nExpr==mx );
1681c5499befSdrh   testcase( pEList && pEList->nExpr==mx+1 );
1682b1a6c3c1Sdrh   if( pEList && pEList->nExpr>mx ){
16837a15a4beSdanielk1977     sqlite3ErrorMsg(pParse, "too many columns in %s", zObject);
16847a15a4beSdanielk1977   }
16857a15a4beSdanielk1977 }
16867a15a4beSdanielk1977 
16877a15a4beSdanielk1977 /*
1688a76b5dfcSdrh ** Delete an entire expression list.
1689a76b5dfcSdrh */
1690affa855cSdrh static SQLITE_NOINLINE void exprListDeleteNN(sqlite3 *db, ExprList *pList){
1691ac48b751Sdrh   int i = pList->nExpr;
1692ac48b751Sdrh   struct ExprList_item *pItem =  pList->a;
1693ac48b751Sdrh   assert( pList->nExpr>0 );
1694ac48b751Sdrh   do{
1695633e6d57Sdrh     sqlite3ExprDelete(db, pItem->pExpr);
1696633e6d57Sdrh     sqlite3DbFree(db, pItem->zName);
1697b7916a78Sdrh     sqlite3DbFree(db, pItem->zSpan);
1698ac48b751Sdrh     pItem++;
1699ac48b751Sdrh   }while( --i>0 );
1700dbd6a7dcSdrh   sqlite3DbFreeNN(db, pList);
1701a76b5dfcSdrh }
1702affa855cSdrh void sqlite3ExprListDelete(sqlite3 *db, ExprList *pList){
1703affa855cSdrh   if( pList ) exprListDeleteNN(db, pList);
1704affa855cSdrh }
1705a76b5dfcSdrh 
1706a76b5dfcSdrh /*
17072308ed38Sdrh ** Return the bitwise-OR of all Expr.flags fields in the given
17082308ed38Sdrh ** ExprList.
1709885a5b03Sdrh */
17102308ed38Sdrh u32 sqlite3ExprListFlags(const ExprList *pList){
1711885a5b03Sdrh   int i;
17122308ed38Sdrh   u32 m = 0;
1713508e2d00Sdrh   assert( pList!=0 );
1714885a5b03Sdrh   for(i=0; i<pList->nExpr; i++){
1715d0c73053Sdrh      Expr *pExpr = pList->a[i].pExpr;
1716de845c2fSdrh      assert( pExpr!=0 );
1717de845c2fSdrh      m |= pExpr->flags;
1718885a5b03Sdrh   }
17192308ed38Sdrh   return m;
1720885a5b03Sdrh }
1721885a5b03Sdrh 
1722885a5b03Sdrh /*
17237e6f980bSdrh ** This is a SELECT-node callback for the expression walker that
17247e6f980bSdrh ** always "fails".  By "fail" in this case, we mean set
17257e6f980bSdrh ** pWalker->eCode to zero and abort.
17267e6f980bSdrh **
17277e6f980bSdrh ** This callback is used by multiple expression walkers.
17287e6f980bSdrh */
17297e6f980bSdrh int sqlite3SelectWalkFail(Walker *pWalker, Select *NotUsed){
17307e6f980bSdrh   UNUSED_PARAMETER(NotUsed);
17317e6f980bSdrh   pWalker->eCode = 0;
17327e6f980bSdrh   return WRC_Abort;
17337e6f980bSdrh }
17347e6f980bSdrh 
17357e6f980bSdrh /*
1736171d16bbSdrh ** If the input expression is an ID with the name "true" or "false"
173796acafbeSdrh ** then convert it into an TK_TRUEFALSE term.  Return non-zero if
173896acafbeSdrh ** the conversion happened, and zero if the expression is unaltered.
1739171d16bbSdrh */
1740171d16bbSdrh int sqlite3ExprIdToTrueFalse(Expr *pExpr){
1741171d16bbSdrh   assert( pExpr->op==TK_ID || pExpr->op==TK_STRING );
1742171d16bbSdrh   if( sqlite3StrICmp(pExpr->u.zToken, "true")==0
1743171d16bbSdrh    || sqlite3StrICmp(pExpr->u.zToken, "false")==0
1744171d16bbSdrh   ){
1745171d16bbSdrh     pExpr->op = TK_TRUEFALSE;
1746171d16bbSdrh     return 1;
1747171d16bbSdrh   }
1748171d16bbSdrh   return 0;
1749171d16bbSdrh }
1750171d16bbSdrh 
175143c4ac8bSdrh /*
175296acafbeSdrh ** The argument must be a TK_TRUEFALSE Expr node.  Return 1 if it is TRUE
175343c4ac8bSdrh ** and 0 if it is FALSE.
175443c4ac8bSdrh */
175596acafbeSdrh int sqlite3ExprTruthValue(const Expr *pExpr){
175643c4ac8bSdrh   assert( pExpr->op==TK_TRUEFALSE );
175743c4ac8bSdrh   assert( sqlite3StrICmp(pExpr->u.zToken,"true")==0
175843c4ac8bSdrh        || sqlite3StrICmp(pExpr->u.zToken,"false")==0 );
175943c4ac8bSdrh   return pExpr->u.zToken[4]==0;
176043c4ac8bSdrh }
176143c4ac8bSdrh 
1762171d16bbSdrh 
1763171d16bbSdrh /*
1764059b2d50Sdrh ** These routines are Walker callbacks used to check expressions to
1765059b2d50Sdrh ** see if they are "constant" for some definition of constant.  The
1766059b2d50Sdrh ** Walker.eCode value determines the type of "constant" we are looking
1767059b2d50Sdrh ** for.
176873b211abSdrh **
17697d10d5a6Sdrh ** These callback routines are used to implement the following:
1770626a879aSdrh **
1771059b2d50Sdrh **     sqlite3ExprIsConstant()                  pWalker->eCode==1
1772059b2d50Sdrh **     sqlite3ExprIsConstantNotJoin()           pWalker->eCode==2
1773fcb9f4f3Sdrh **     sqlite3ExprIsTableConstant()             pWalker->eCode==3
1774059b2d50Sdrh **     sqlite3ExprIsConstantOrFunction()        pWalker->eCode==4 or 5
177587abf5c0Sdrh **
1776059b2d50Sdrh ** In all cases, the callbacks set Walker.eCode=0 and abort if the expression
1777059b2d50Sdrh ** is found to not be a constant.
177887abf5c0Sdrh **
1779feada2dfSdrh ** The sqlite3ExprIsConstantOrFunction() is used for evaluating expressions
1780059b2d50Sdrh ** in a CREATE TABLE statement.  The Walker.eCode value is 5 when parsing
1781059b2d50Sdrh ** an existing schema and 4 when processing a new statement.  A bound
1782feada2dfSdrh ** parameter raises an error for new statements, but is silently converted
1783feada2dfSdrh ** to NULL for existing schemas.  This allows sqlite_master tables that
1784feada2dfSdrh ** contain a bound parameter because they were generated by older versions
1785feada2dfSdrh ** of SQLite to be parsed by newer versions of SQLite without raising a
1786feada2dfSdrh ** malformed schema error.
1787626a879aSdrh */
17887d10d5a6Sdrh static int exprNodeIsConstant(Walker *pWalker, Expr *pExpr){
1789626a879aSdrh 
1790059b2d50Sdrh   /* If pWalker->eCode is 2 then any term of the expression that comes from
1791059b2d50Sdrh   ** the ON or USING clauses of a left join disqualifies the expression
17920a168377Sdrh   ** from being considered constant. */
1793059b2d50Sdrh   if( pWalker->eCode==2 && ExprHasProperty(pExpr, EP_FromJoin) ){
1794059b2d50Sdrh     pWalker->eCode = 0;
17957d10d5a6Sdrh     return WRC_Abort;
17960a168377Sdrh   }
17970a168377Sdrh 
1798626a879aSdrh   switch( pExpr->op ){
1799eb55bd2fSdrh     /* Consider functions to be constant if all their arguments are constant
1800059b2d50Sdrh     ** and either pWalker->eCode==4 or 5 or the function has the
1801059b2d50Sdrh     ** SQLITE_FUNC_CONST flag. */
1802eb55bd2fSdrh     case TK_FUNCTION:
180363f84573Sdrh       if( pWalker->eCode>=4 || ExprHasProperty(pExpr,EP_ConstFunc) ){
1804b1fba286Sdrh         return WRC_Continue;
1805059b2d50Sdrh       }else{
1806059b2d50Sdrh         pWalker->eCode = 0;
1807059b2d50Sdrh         return WRC_Abort;
1808b1fba286Sdrh       }
1809626a879aSdrh     case TK_ID:
1810171d16bbSdrh       /* Convert "true" or "false" in a DEFAULT clause into the
1811171d16bbSdrh       ** appropriate TK_TRUEFALSE operator */
1812e39ef31cSdrh       if( sqlite3ExprIdToTrueFalse(pExpr) ){
1813171d16bbSdrh         return WRC_Prune;
1814171d16bbSdrh       }
1815171d16bbSdrh       /* Fall thru */
1816626a879aSdrh     case TK_COLUMN:
1817626a879aSdrh     case TK_AGG_FUNCTION:
181813449892Sdrh     case TK_AGG_COLUMN:
1819c5499befSdrh       testcase( pExpr->op==TK_ID );
1820c5499befSdrh       testcase( pExpr->op==TK_COLUMN );
1821c5499befSdrh       testcase( pExpr->op==TK_AGG_FUNCTION );
1822c5499befSdrh       testcase( pExpr->op==TK_AGG_COLUMN );
1823059b2d50Sdrh       if( pWalker->eCode==3 && pExpr->iTable==pWalker->u.iCur ){
1824059b2d50Sdrh         return WRC_Continue;
1825f43ce0b4Sdrh       }
1826f43ce0b4Sdrh       /* Fall through */
1827f43ce0b4Sdrh     case TK_IF_NULL_ROW:
1828f43ce0b4Sdrh       testcase( pExpr->op==TK_IF_NULL_ROW );
1829059b2d50Sdrh       pWalker->eCode = 0;
18307d10d5a6Sdrh       return WRC_Abort;
1831feada2dfSdrh     case TK_VARIABLE:
1832059b2d50Sdrh       if( pWalker->eCode==5 ){
1833feada2dfSdrh         /* Silently convert bound parameters that appear inside of CREATE
1834feada2dfSdrh         ** statements into a NULL when parsing the CREATE statement text out
1835feada2dfSdrh         ** of the sqlite_master table */
1836feada2dfSdrh         pExpr->op = TK_NULL;
1837059b2d50Sdrh       }else if( pWalker->eCode==4 ){
1838feada2dfSdrh         /* A bound parameter in a CREATE statement that originates from
1839feada2dfSdrh         ** sqlite3_prepare() causes an error */
1840059b2d50Sdrh         pWalker->eCode = 0;
1841feada2dfSdrh         return WRC_Abort;
1842feada2dfSdrh       }
1843feada2dfSdrh       /* Fall through */
1844626a879aSdrh     default:
18457e6f980bSdrh       testcase( pExpr->op==TK_SELECT ); /* sqlite3SelectWalkFail will disallow */
18467e6f980bSdrh       testcase( pExpr->op==TK_EXISTS ); /* sqlite3SelectWalkFail will disallow */
18477d10d5a6Sdrh       return WRC_Continue;
1848626a879aSdrh   }
1849626a879aSdrh }
1850059b2d50Sdrh static int exprIsConst(Expr *p, int initFlag, int iCur){
18517d10d5a6Sdrh   Walker w;
1852059b2d50Sdrh   w.eCode = initFlag;
18537d10d5a6Sdrh   w.xExprCallback = exprNodeIsConstant;
18547e6f980bSdrh   w.xSelectCallback = sqlite3SelectWalkFail;
1855979dd1beSdrh #ifdef SQLITE_DEBUG
1856979dd1beSdrh   w.xSelectCallback2 = sqlite3SelectWalkAssert2;
1857979dd1beSdrh #endif
1858059b2d50Sdrh   w.u.iCur = iCur;
18597d10d5a6Sdrh   sqlite3WalkExpr(&w, p);
1860059b2d50Sdrh   return w.eCode;
18617d10d5a6Sdrh }
1862626a879aSdrh 
1863626a879aSdrh /*
1864059b2d50Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
1865eb55bd2fSdrh ** and 0 if it involves variables or function calls.
18662398937bSdrh **
18672398937bSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
18682398937bSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
18692398937bSdrh ** a constant.
1870fef5208cSdrh */
18714adee20fSdanielk1977 int sqlite3ExprIsConstant(Expr *p){
1872059b2d50Sdrh   return exprIsConst(p, 1, 0);
1873fef5208cSdrh }
1874fef5208cSdrh 
1875fef5208cSdrh /*
1876059b2d50Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
18770a168377Sdrh ** that does no originate from the ON or USING clauses of a join.
18780a168377Sdrh ** Return 0 if it involves variables or function calls or terms from
18790a168377Sdrh ** an ON or USING clause.
18800a168377Sdrh */
18810a168377Sdrh int sqlite3ExprIsConstantNotJoin(Expr *p){
1882059b2d50Sdrh   return exprIsConst(p, 2, 0);
18830a168377Sdrh }
18840a168377Sdrh 
18850a168377Sdrh /*
1886fcb9f4f3Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
1887059b2d50Sdrh ** for any single row of the table with cursor iCur.  In other words, the
1888059b2d50Sdrh ** expression must not refer to any non-deterministic function nor any
1889059b2d50Sdrh ** table other than iCur.
1890059b2d50Sdrh */
1891059b2d50Sdrh int sqlite3ExprIsTableConstant(Expr *p, int iCur){
1892059b2d50Sdrh   return exprIsConst(p, 3, iCur);
1893059b2d50Sdrh }
1894059b2d50Sdrh 
1895ab31a845Sdan 
1896ab31a845Sdan /*
1897ab31a845Sdan ** sqlite3WalkExpr() callback used by sqlite3ExprIsConstantOrGroupBy().
1898ab31a845Sdan */
1899ab31a845Sdan static int exprNodeIsConstantOrGroupBy(Walker *pWalker, Expr *pExpr){
1900ab31a845Sdan   ExprList *pGroupBy = pWalker->u.pGroupBy;
1901ab31a845Sdan   int i;
1902ab31a845Sdan 
1903ab31a845Sdan   /* Check if pExpr is identical to any GROUP BY term. If so, consider
1904ab31a845Sdan   ** it constant.  */
1905ab31a845Sdan   for(i=0; i<pGroupBy->nExpr; i++){
1906ab31a845Sdan     Expr *p = pGroupBy->a[i].pExpr;
19075aa550cfSdan     if( sqlite3ExprCompare(0, pExpr, p, -1)<2 ){
190870efa84dSdrh       CollSeq *pColl = sqlite3ExprNNCollSeq(pWalker->pParse, p);
190970efa84dSdrh       if( sqlite3_stricmp("BINARY", pColl->zName)==0 ){
1910ab31a845Sdan         return WRC_Prune;
1911ab31a845Sdan       }
1912ab31a845Sdan     }
1913ab31a845Sdan   }
1914ab31a845Sdan 
1915ab31a845Sdan   /* Check if pExpr is a sub-select. If so, consider it variable. */
1916ab31a845Sdan   if( ExprHasProperty(pExpr, EP_xIsSelect) ){
1917ab31a845Sdan     pWalker->eCode = 0;
1918ab31a845Sdan     return WRC_Abort;
1919ab31a845Sdan   }
1920ab31a845Sdan 
1921ab31a845Sdan   return exprNodeIsConstant(pWalker, pExpr);
1922ab31a845Sdan }
1923ab31a845Sdan 
1924ab31a845Sdan /*
1925ab31a845Sdan ** Walk the expression tree passed as the first argument. Return non-zero
1926ab31a845Sdan ** if the expression consists entirely of constants or copies of terms
1927ab31a845Sdan ** in pGroupBy that sort with the BINARY collation sequence.
1928ab314001Sdrh **
1929ab314001Sdrh ** This routine is used to determine if a term of the HAVING clause can
1930ab314001Sdrh ** be promoted into the WHERE clause.  In order for such a promotion to work,
1931ab314001Sdrh ** the value of the HAVING clause term must be the same for all members of
1932ab314001Sdrh ** a "group".  The requirement that the GROUP BY term must be BINARY
1933ab314001Sdrh ** assumes that no other collating sequence will have a finer-grained
1934ab314001Sdrh ** grouping than binary.  In other words (A=B COLLATE binary) implies
1935ab314001Sdrh ** A=B in every other collating sequence.  The requirement that the
1936ab314001Sdrh ** GROUP BY be BINARY is stricter than necessary.  It would also work
1937ab314001Sdrh ** to promote HAVING clauses that use the same alternative collating
1938ab314001Sdrh ** sequence as the GROUP BY term, but that is much harder to check,
1939ab314001Sdrh ** alternative collating sequences are uncommon, and this is only an
1940ab314001Sdrh ** optimization, so we take the easy way out and simply require the
1941ab314001Sdrh ** GROUP BY to use the BINARY collating sequence.
1942ab31a845Sdan */
1943ab31a845Sdan int sqlite3ExprIsConstantOrGroupBy(Parse *pParse, Expr *p, ExprList *pGroupBy){
1944ab31a845Sdan   Walker w;
1945ab31a845Sdan   w.eCode = 1;
1946ab31a845Sdan   w.xExprCallback = exprNodeIsConstantOrGroupBy;
1947979dd1beSdrh   w.xSelectCallback = 0;
1948ab31a845Sdan   w.u.pGroupBy = pGroupBy;
1949ab31a845Sdan   w.pParse = pParse;
1950ab31a845Sdan   sqlite3WalkExpr(&w, p);
1951ab31a845Sdan   return w.eCode;
1952ab31a845Sdan }
1953ab31a845Sdan 
1954059b2d50Sdrh /*
1955059b2d50Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
1956eb55bd2fSdrh ** or a function call with constant arguments.  Return and 0 if there
1957eb55bd2fSdrh ** are any variables.
1958eb55bd2fSdrh **
1959eb55bd2fSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
1960eb55bd2fSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
1961eb55bd2fSdrh ** a constant.
1962eb55bd2fSdrh */
1963feada2dfSdrh int sqlite3ExprIsConstantOrFunction(Expr *p, u8 isInit){
1964feada2dfSdrh   assert( isInit==0 || isInit==1 );
1965059b2d50Sdrh   return exprIsConst(p, 4+isInit, 0);
1966eb55bd2fSdrh }
1967eb55bd2fSdrh 
19685b88bc4bSdrh #ifdef SQLITE_ENABLE_CURSOR_HINTS
19695b88bc4bSdrh /*
19705b88bc4bSdrh ** Walk an expression tree.  Return 1 if the expression contains a
19715b88bc4bSdrh ** subquery of some kind.  Return 0 if there are no subqueries.
19725b88bc4bSdrh */
19735b88bc4bSdrh int sqlite3ExprContainsSubquery(Expr *p){
19745b88bc4bSdrh   Walker w;
1975bec2476aSdrh   w.eCode = 1;
19765b88bc4bSdrh   w.xExprCallback = sqlite3ExprWalkNoop;
19777e6f980bSdrh   w.xSelectCallback = sqlite3SelectWalkFail;
1978979dd1beSdrh #ifdef SQLITE_DEBUG
1979979dd1beSdrh   w.xSelectCallback2 = sqlite3SelectWalkAssert2;
1980979dd1beSdrh #endif
19815b88bc4bSdrh   sqlite3WalkExpr(&w, p);
198207194bffSdrh   return w.eCode==0;
19835b88bc4bSdrh }
19845b88bc4bSdrh #endif
19855b88bc4bSdrh 
1986eb55bd2fSdrh /*
198773b211abSdrh ** If the expression p codes a constant integer that is small enough
1988202b2df7Sdrh ** to fit in a 32-bit integer, return 1 and put the value of the integer
1989202b2df7Sdrh ** in *pValue.  If the expression is not an integer or if it is too big
1990202b2df7Sdrh ** to fit in a signed 32-bit integer, return 0 and leave *pValue unchanged.
1991e4de1febSdrh */
19924adee20fSdanielk1977 int sqlite3ExprIsInteger(Expr *p, int *pValue){
199392b01d53Sdrh   int rc = 0;
1994ba28b5abSdrh   if( p==0 ) return 0;  /* Can only happen following on OOM */
1995cd92e84dSdrh 
1996cd92e84dSdrh   /* If an expression is an integer literal that fits in a signed 32-bit
1997cd92e84dSdrh   ** integer, then the EP_IntValue flag will have already been set */
1998cd92e84dSdrh   assert( p->op!=TK_INTEGER || (p->flags & EP_IntValue)!=0
1999cd92e84dSdrh            || sqlite3GetInt32(p->u.zToken, &rc)==0 );
2000cd92e84dSdrh 
200192b01d53Sdrh   if( p->flags & EP_IntValue ){
200233e619fcSdrh     *pValue = p->u.iValue;
2003e4de1febSdrh     return 1;
2004e4de1febSdrh   }
200592b01d53Sdrh   switch( p->op ){
20064b59ab5eSdrh     case TK_UPLUS: {
200792b01d53Sdrh       rc = sqlite3ExprIsInteger(p->pLeft, pValue);
2008f6e369a1Sdrh       break;
20094b59ab5eSdrh     }
2010e4de1febSdrh     case TK_UMINUS: {
2011e4de1febSdrh       int v;
20124adee20fSdanielk1977       if( sqlite3ExprIsInteger(p->pLeft, &v) ){
2013f6418891Smistachkin         assert( v!=(-2147483647-1) );
2014e4de1febSdrh         *pValue = -v;
201592b01d53Sdrh         rc = 1;
2016e4de1febSdrh       }
2017e4de1febSdrh       break;
2018e4de1febSdrh     }
2019e4de1febSdrh     default: break;
2020e4de1febSdrh   }
202192b01d53Sdrh   return rc;
2022e4de1febSdrh }
2023e4de1febSdrh 
2024e4de1febSdrh /*
2025039fc32eSdrh ** Return FALSE if there is no chance that the expression can be NULL.
2026039fc32eSdrh **
2027039fc32eSdrh ** If the expression might be NULL or if the expression is too complex
2028039fc32eSdrh ** to tell return TRUE.
2029039fc32eSdrh **
2030039fc32eSdrh ** This routine is used as an optimization, to skip OP_IsNull opcodes
2031039fc32eSdrh ** when we know that a value cannot be NULL.  Hence, a false positive
2032039fc32eSdrh ** (returning TRUE when in fact the expression can never be NULL) might
2033039fc32eSdrh ** be a small performance hit but is otherwise harmless.  On the other
2034039fc32eSdrh ** hand, a false negative (returning FALSE when the result could be NULL)
2035039fc32eSdrh ** will likely result in an incorrect answer.  So when in doubt, return
2036039fc32eSdrh ** TRUE.
2037039fc32eSdrh */
2038039fc32eSdrh int sqlite3ExprCanBeNull(const Expr *p){
2039039fc32eSdrh   u8 op;
2040cd7f457eSdrh   while( p->op==TK_UPLUS || p->op==TK_UMINUS ){ p = p->pLeft; }
2041039fc32eSdrh   op = p->op;
2042039fc32eSdrh   if( op==TK_REGISTER ) op = p->op2;
2043039fc32eSdrh   switch( op ){
2044039fc32eSdrh     case TK_INTEGER:
2045039fc32eSdrh     case TK_STRING:
2046039fc32eSdrh     case TK_FLOAT:
2047039fc32eSdrh     case TK_BLOB:
2048039fc32eSdrh       return 0;
20497248a8b2Sdrh     case TK_COLUMN:
205072673a24Sdrh       return ExprHasProperty(p, EP_CanBeNull) ||
20514dd89d5aSdrh              p->pTab==0 ||  /* Reference to column of index on expression */
205272673a24Sdrh              (p->iColumn>=0 && p->pTab->aCol[p->iColumn].notNull==0);
2053039fc32eSdrh     default:
2054039fc32eSdrh       return 1;
2055039fc32eSdrh   }
2056039fc32eSdrh }
2057039fc32eSdrh 
2058039fc32eSdrh /*
2059039fc32eSdrh ** Return TRUE if the given expression is a constant which would be
2060039fc32eSdrh ** unchanged by OP_Affinity with the affinity given in the second
2061039fc32eSdrh ** argument.
2062039fc32eSdrh **
2063039fc32eSdrh ** This routine is used to determine if the OP_Affinity operation
2064039fc32eSdrh ** can be omitted.  When in doubt return FALSE.  A false negative
2065039fc32eSdrh ** is harmless.  A false positive, however, can result in the wrong
2066039fc32eSdrh ** answer.
2067039fc32eSdrh */
2068039fc32eSdrh int sqlite3ExprNeedsNoAffinityChange(const Expr *p, char aff){
2069039fc32eSdrh   u8 op;
207005883a34Sdrh   if( aff==SQLITE_AFF_BLOB ) return 1;
2071cd7f457eSdrh   while( p->op==TK_UPLUS || p->op==TK_UMINUS ){ p = p->pLeft; }
2072039fc32eSdrh   op = p->op;
2073039fc32eSdrh   if( op==TK_REGISTER ) op = p->op2;
2074039fc32eSdrh   switch( op ){
2075039fc32eSdrh     case TK_INTEGER: {
2076039fc32eSdrh       return aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC;
2077039fc32eSdrh     }
2078039fc32eSdrh     case TK_FLOAT: {
2079039fc32eSdrh       return aff==SQLITE_AFF_REAL || aff==SQLITE_AFF_NUMERIC;
2080039fc32eSdrh     }
2081039fc32eSdrh     case TK_STRING: {
2082039fc32eSdrh       return aff==SQLITE_AFF_TEXT;
2083039fc32eSdrh     }
2084039fc32eSdrh     case TK_BLOB: {
2085039fc32eSdrh       return 1;
2086039fc32eSdrh     }
20872f2855b6Sdrh     case TK_COLUMN: {
208888376ca7Sdrh       assert( p->iTable>=0 );  /* p cannot be part of a CHECK constraint */
208988376ca7Sdrh       return p->iColumn<0
20902f2855b6Sdrh           && (aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC);
20912f2855b6Sdrh     }
2092039fc32eSdrh     default: {
2093039fc32eSdrh       return 0;
2094039fc32eSdrh     }
2095039fc32eSdrh   }
2096039fc32eSdrh }
2097039fc32eSdrh 
2098039fc32eSdrh /*
2099c4a3c779Sdrh ** Return TRUE if the given string is a row-id column name.
2100c4a3c779Sdrh */
21014adee20fSdanielk1977 int sqlite3IsRowid(const char *z){
21024adee20fSdanielk1977   if( sqlite3StrICmp(z, "_ROWID_")==0 ) return 1;
21034adee20fSdanielk1977   if( sqlite3StrICmp(z, "ROWID")==0 ) return 1;
21044adee20fSdanielk1977   if( sqlite3StrICmp(z, "OID")==0 ) return 1;
2105c4a3c779Sdrh   return 0;
2106c4a3c779Sdrh }
2107c4a3c779Sdrh 
21089a96b668Sdanielk1977 /*
210969c355bdSdrh ** pX is the RHS of an IN operator.  If pX is a SELECT statement
211069c355bdSdrh ** that can be simplified to a direct table access, then return
211169c355bdSdrh ** a pointer to the SELECT statement.  If pX is not a SELECT statement,
211269c355bdSdrh ** or if the SELECT statement needs to be manifested into a transient
211369c355bdSdrh ** table, then return NULL.
2114b287f4b6Sdrh */
2115b287f4b6Sdrh #ifndef SQLITE_OMIT_SUBQUERY
21167b35a77bSdan static Select *isCandidateForInOpt(Expr *pX){
211769c355bdSdrh   Select *p;
2118b287f4b6Sdrh   SrcList *pSrc;
2119b287f4b6Sdrh   ExprList *pEList;
2120b287f4b6Sdrh   Table *pTab;
2121cfbb5e82Sdan   int i;
212269c355bdSdrh   if( !ExprHasProperty(pX, EP_xIsSelect) ) return 0;  /* Not a subquery */
212369c355bdSdrh   if( ExprHasProperty(pX, EP_VarSelect)  ) return 0;  /* Correlated subq */
212469c355bdSdrh   p = pX->x.pSelect;
2125b287f4b6Sdrh   if( p->pPrior ) return 0;              /* Not a compound SELECT */
21267d10d5a6Sdrh   if( p->selFlags & (SF_Distinct|SF_Aggregate) ){
2127b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
2128b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
21297d10d5a6Sdrh     return 0; /* No DISTINCT keyword and no aggregate functions */
21307d10d5a6Sdrh   }
2131b74b1017Sdrh   assert( p->pGroupBy==0 );              /* Has no GROUP BY clause */
2132b287f4b6Sdrh   if( p->pLimit ) return 0;              /* Has no LIMIT clause */
2133b287f4b6Sdrh   if( p->pWhere ) return 0;              /* Has no WHERE clause */
2134b287f4b6Sdrh   pSrc = p->pSrc;
2135d1fa7bcaSdrh   assert( pSrc!=0 );
2136d1fa7bcaSdrh   if( pSrc->nSrc!=1 ) return 0;          /* Single term in FROM clause */
2137b74b1017Sdrh   if( pSrc->a[0].pSelect ) return 0;     /* FROM is not a subquery or view */
2138b287f4b6Sdrh   pTab = pSrc->a[0].pTab;
213969c355bdSdrh   assert( pTab!=0 );
2140b74b1017Sdrh   assert( pTab->pSelect==0 );            /* FROM clause is not a view */
2141b287f4b6Sdrh   if( IsVirtual(pTab) ) return 0;        /* FROM clause not a virtual table */
2142b287f4b6Sdrh   pEList = p->pEList;
2143ac6b47d1Sdrh   assert( pEList!=0 );
21447b35a77bSdan   /* All SELECT results must be columns. */
2145cfbb5e82Sdan   for(i=0; i<pEList->nExpr; i++){
2146cfbb5e82Sdan     Expr *pRes = pEList->a[i].pExpr;
2147cfbb5e82Sdan     if( pRes->op!=TK_COLUMN ) return 0;
214869c355bdSdrh     assert( pRes->iTable==pSrc->a[0].iCursor );  /* Not a correlated subquery */
2149cfbb5e82Sdan   }
215069c355bdSdrh   return p;
2151b287f4b6Sdrh }
2152b287f4b6Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
2153b287f4b6Sdrh 
2154f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
21551d8cb21fSdan /*
21564c259e9fSdrh ** Generate code that checks the left-most column of index table iCur to see if
21574c259e9fSdrh ** it contains any NULL entries.  Cause the register at regHasNull to be set
21586be515ebSdrh ** to a non-NULL value if iCur contains no NULLs.  Cause register regHasNull
21596be515ebSdrh ** to be set to NULL if iCur contains one or more NULL values.
21606be515ebSdrh */
21616be515ebSdrh static void sqlite3SetHasNullFlag(Vdbe *v, int iCur, int regHasNull){
2162728e0f91Sdrh   int addr1;
21636be515ebSdrh   sqlite3VdbeAddOp2(v, OP_Integer, 0, regHasNull);
2164728e0f91Sdrh   addr1 = sqlite3VdbeAddOp1(v, OP_Rewind, iCur); VdbeCoverage(v);
21656be515ebSdrh   sqlite3VdbeAddOp3(v, OP_Column, iCur, 0, regHasNull);
21666be515ebSdrh   sqlite3VdbeChangeP5(v, OPFLAG_TYPEOFARG);
21674c259e9fSdrh   VdbeComment((v, "first_entry_in(%d)", iCur));
2168728e0f91Sdrh   sqlite3VdbeJumpHere(v, addr1);
21696be515ebSdrh }
2170f9b2e05cSdan #endif
21716be515ebSdrh 
2172bb53ecb1Sdrh 
2173bb53ecb1Sdrh #ifndef SQLITE_OMIT_SUBQUERY
2174bb53ecb1Sdrh /*
2175bb53ecb1Sdrh ** The argument is an IN operator with a list (not a subquery) on the
2176bb53ecb1Sdrh ** right-hand side.  Return TRUE if that list is constant.
2177bb53ecb1Sdrh */
2178bb53ecb1Sdrh static int sqlite3InRhsIsConstant(Expr *pIn){
2179bb53ecb1Sdrh   Expr *pLHS;
2180bb53ecb1Sdrh   int res;
2181bb53ecb1Sdrh   assert( !ExprHasProperty(pIn, EP_xIsSelect) );
2182bb53ecb1Sdrh   pLHS = pIn->pLeft;
2183bb53ecb1Sdrh   pIn->pLeft = 0;
2184bb53ecb1Sdrh   res = sqlite3ExprIsConstant(pIn);
2185bb53ecb1Sdrh   pIn->pLeft = pLHS;
2186bb53ecb1Sdrh   return res;
2187bb53ecb1Sdrh }
2188bb53ecb1Sdrh #endif
2189bb53ecb1Sdrh 
21906be515ebSdrh /*
21919a96b668Sdanielk1977 ** This function is used by the implementation of the IN (...) operator.
2192d4305ca6Sdrh ** The pX parameter is the expression on the RHS of the IN operator, which
2193d4305ca6Sdrh ** might be either a list of expressions or a subquery.
21949a96b668Sdanielk1977 **
2195d4305ca6Sdrh ** The job of this routine is to find or create a b-tree object that can
2196d4305ca6Sdrh ** be used either to test for membership in the RHS set or to iterate through
2197d4305ca6Sdrh ** all members of the RHS set, skipping duplicates.
2198d4305ca6Sdrh **
21993a85625dSdrh ** A cursor is opened on the b-tree object that is the RHS of the IN operator
2200d4305ca6Sdrh ** and pX->iTable is set to the index of that cursor.
2201d4305ca6Sdrh **
2202b74b1017Sdrh ** The returned value of this function indicates the b-tree type, as follows:
22039a96b668Sdanielk1977 **
22049a96b668Sdanielk1977 **   IN_INDEX_ROWID      - The cursor was opened on a database table.
22051ccce449Sdrh **   IN_INDEX_INDEX_ASC  - The cursor was opened on an ascending index.
22061ccce449Sdrh **   IN_INDEX_INDEX_DESC - The cursor was opened on a descending index.
22079a96b668Sdanielk1977 **   IN_INDEX_EPH        - The cursor was opened on a specially created and
22089a96b668Sdanielk1977 **                         populated epheremal table.
2209bb53ecb1Sdrh **   IN_INDEX_NOOP       - No cursor was allocated.  The IN operator must be
2210bb53ecb1Sdrh **                         implemented as a sequence of comparisons.
22119a96b668Sdanielk1977 **
2212d4305ca6Sdrh ** An existing b-tree might be used if the RHS expression pX is a simple
2213d4305ca6Sdrh ** subquery such as:
22149a96b668Sdanielk1977 **
2215553168c7Sdan **     SELECT <column1>, <column2>... FROM <table>
22169a96b668Sdanielk1977 **
2217d4305ca6Sdrh ** If the RHS of the IN operator is a list or a more complex subquery, then
2218d4305ca6Sdrh ** an ephemeral table might need to be generated from the RHS and then
221960ec914cSpeter.d.reid ** pX->iTable made to point to the ephemeral table instead of an
2220d4305ca6Sdrh ** existing table.
2221d4305ca6Sdrh **
22227fc0ba0fSdrh ** The inFlags parameter must contain, at a minimum, one of the bits
22237fc0ba0fSdrh ** IN_INDEX_MEMBERSHIP or IN_INDEX_LOOP but not both.  If inFlags contains
22247fc0ba0fSdrh ** IN_INDEX_MEMBERSHIP, then the generated table will be used for a fast
22257fc0ba0fSdrh ** membership test.  When the IN_INDEX_LOOP bit is set, the IN index will
22267fc0ba0fSdrh ** be used to loop over all values of the RHS of the IN operator.
22273a85625dSdrh **
22283a85625dSdrh ** When IN_INDEX_LOOP is used (and the b-tree will be used to iterate
22293a85625dSdrh ** through the set members) then the b-tree must not contain duplicates.
22307fc0ba0fSdrh ** An epheremal table will be created unless the selected columns are guaranteed
2231553168c7Sdan ** to be unique - either because it is an INTEGER PRIMARY KEY or due to
2232553168c7Sdan ** a UNIQUE constraint or index.
22330cdc022eSdanielk1977 **
22343a85625dSdrh ** When IN_INDEX_MEMBERSHIP is used (and the b-tree will be used
22353a85625dSdrh ** for fast set membership tests) then an epheremal table must
2236553168c7Sdan ** be used unless <columns> is a single INTEGER PRIMARY KEY column or an
2237553168c7Sdan ** index can be found with the specified <columns> as its left-most.
22380cdc022eSdanielk1977 **
2239bb53ecb1Sdrh ** If the IN_INDEX_NOOP_OK and IN_INDEX_MEMBERSHIP are both set and
2240bb53ecb1Sdrh ** if the RHS of the IN operator is a list (not a subquery) then this
2241bb53ecb1Sdrh ** routine might decide that creating an ephemeral b-tree for membership
2242bb53ecb1Sdrh ** testing is too expensive and return IN_INDEX_NOOP.  In that case, the
2243bb53ecb1Sdrh ** calling routine should implement the IN operator using a sequence
2244bb53ecb1Sdrh ** of Eq or Ne comparison operations.
2245bb53ecb1Sdrh **
2246b74b1017Sdrh ** When the b-tree is being used for membership tests, the calling function
22473a85625dSdrh ** might need to know whether or not the RHS side of the IN operator
2248e21a6e1dSdrh ** contains a NULL.  If prRhsHasNull is not a NULL pointer and
22493a85625dSdrh ** if there is any chance that the (...) might contain a NULL value at
22500cdc022eSdanielk1977 ** runtime, then a register is allocated and the register number written
2251e21a6e1dSdrh ** to *prRhsHasNull. If there is no chance that the (...) contains a
2252e21a6e1dSdrh ** NULL value, then *prRhsHasNull is left unchanged.
22530cdc022eSdanielk1977 **
2254e21a6e1dSdrh ** If a register is allocated and its location stored in *prRhsHasNull, then
22556be515ebSdrh ** the value in that register will be NULL if the b-tree contains one or more
22566be515ebSdrh ** NULL values, and it will be some non-NULL value if the b-tree contains no
22576be515ebSdrh ** NULL values.
2258553168c7Sdan **
2259553168c7Sdan ** If the aiMap parameter is not NULL, it must point to an array containing
2260553168c7Sdan ** one element for each column returned by the SELECT statement on the RHS
2261553168c7Sdan ** of the IN(...) operator. The i'th entry of the array is populated with the
2262553168c7Sdan ** offset of the index column that matches the i'th column returned by the
2263553168c7Sdan ** SELECT. For example, if the expression and selected index are:
2264553168c7Sdan **
2265553168c7Sdan **   (?,?,?) IN (SELECT a, b, c FROM t1)
2266553168c7Sdan **   CREATE INDEX i1 ON t1(b, c, a);
2267553168c7Sdan **
2268553168c7Sdan ** then aiMap[] is populated with {2, 0, 1}.
22699a96b668Sdanielk1977 */
2270284f4acaSdanielk1977 #ifndef SQLITE_OMIT_SUBQUERY
2271ba00e30aSdan int sqlite3FindInIndex(
22726fc8f364Sdrh   Parse *pParse,             /* Parsing context */
22736fc8f364Sdrh   Expr *pX,                  /* The right-hand side (RHS) of the IN operator */
22746fc8f364Sdrh   u32 inFlags,               /* IN_INDEX_LOOP, _MEMBERSHIP, and/or _NOOP_OK */
22756fc8f364Sdrh   int *prRhsHasNull,         /* Register holding NULL status.  See notes */
22766fc8f364Sdrh   int *aiMap                 /* Mapping from Index fields to RHS fields */
2277ba00e30aSdan ){
2278b74b1017Sdrh   Select *p;                            /* SELECT to the right of IN operator */
2279b74b1017Sdrh   int eType = 0;                        /* Type of RHS table. IN_INDEX_* */
2280b74b1017Sdrh   int iTab = pParse->nTab++;            /* Cursor of the RHS table */
22813a85625dSdrh   int mustBeUnique;                     /* True if RHS must be unique */
2282b8475df8Sdrh   Vdbe *v = sqlite3GetVdbe(pParse);     /* Virtual machine being coded */
22839a96b668Sdanielk1977 
22841450bc6eSdrh   assert( pX->op==TK_IN );
22853a85625dSdrh   mustBeUnique = (inFlags & IN_INDEX_LOOP)!=0;
22861450bc6eSdrh 
22877b35a77bSdan   /* If the RHS of this IN(...) operator is a SELECT, and if it matters
22887b35a77bSdan   ** whether or not the SELECT result contains NULL values, check whether
2289870a0705Sdan   ** or not NULL is actually possible (it may not be, for example, due
22907b35a77bSdan   ** to NOT NULL constraints in the schema). If no NULL values are possible,
2291870a0705Sdan   ** set prRhsHasNull to 0 before continuing.  */
22927b35a77bSdan   if( prRhsHasNull && (pX->flags & EP_xIsSelect) ){
22937b35a77bSdan     int i;
22947b35a77bSdan     ExprList *pEList = pX->x.pSelect->pEList;
22957b35a77bSdan     for(i=0; i<pEList->nExpr; i++){
22967b35a77bSdan       if( sqlite3ExprCanBeNull(pEList->a[i].pExpr) ) break;
22977b35a77bSdan     }
22987b35a77bSdan     if( i==pEList->nExpr ){
22997b35a77bSdan       prRhsHasNull = 0;
23007b35a77bSdan     }
23017b35a77bSdan   }
23027b35a77bSdan 
2303b74b1017Sdrh   /* Check to see if an existing table or index can be used to
2304b74b1017Sdrh   ** satisfy the query.  This is preferable to generating a new
23057b35a77bSdan   ** ephemeral table.  */
23067b35a77bSdan   if( pParse->nErr==0 && (p = isCandidateForInOpt(pX))!=0 ){
2307e1fb65a0Sdanielk1977     sqlite3 *db = pParse->db;              /* Database connection */
2308b07028f7Sdrh     Table *pTab;                           /* Table <table>. */
2309ba00e30aSdan     i16 iDb;                               /* Database idx for pTab */
2310cfbb5e82Sdan     ExprList *pEList = p->pEList;
2311cfbb5e82Sdan     int nExpr = pEList->nExpr;
2312e1fb65a0Sdanielk1977 
2313b07028f7Sdrh     assert( p->pEList!=0 );             /* Because of isCandidateForInOpt(p) */
2314b07028f7Sdrh     assert( p->pEList->a[0].pExpr!=0 ); /* Because of isCandidateForInOpt(p) */
2315b07028f7Sdrh     assert( p->pSrc!=0 );               /* Because of isCandidateForInOpt(p) */
2316b07028f7Sdrh     pTab = p->pSrc->a[0].pTab;
2317b07028f7Sdrh 
2318b22f7c83Sdrh     /* Code an OP_Transaction and OP_TableLock for <table>. */
2319e1fb65a0Sdanielk1977     iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
2320e1fb65a0Sdanielk1977     sqlite3CodeVerifySchema(pParse, iDb);
2321e1fb65a0Sdanielk1977     sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
23229a96b668Sdanielk1977 
2323a84a283dSdrh     assert(v);  /* sqlite3GetVdbe() has always been previously called */
2324cfbb5e82Sdan     if( nExpr==1 && pEList->a[0].pExpr->iColumn<0 ){
232562659b2aSdrh       /* The "x IN (SELECT rowid FROM table)" case */
2326511f9e8dSdrh       int iAddr = sqlite3VdbeAddOp0(v, OP_Once);
23277d176105Sdrh       VdbeCoverage(v);
23289a96b668Sdanielk1977 
23299a96b668Sdanielk1977       sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
23309a96b668Sdanielk1977       eType = IN_INDEX_ROWID;
23319a96b668Sdanielk1977 
23329a96b668Sdanielk1977       sqlite3VdbeJumpHere(v, iAddr);
23339a96b668Sdanielk1977     }else{
2334e1fb65a0Sdanielk1977       Index *pIdx;                         /* Iterator variable */
2335cfbb5e82Sdan       int affinity_ok = 1;
2336cfbb5e82Sdan       int i;
2337cfbb5e82Sdan 
2338cfbb5e82Sdan       /* Check that the affinity that will be used to perform each
233962659b2aSdrh       ** comparison is the same as the affinity of each column in table
234062659b2aSdrh       ** on the RHS of the IN operator.  If it not, it is not possible to
234162659b2aSdrh       ** use any index of the RHS table.  */
2342cfbb5e82Sdan       for(i=0; i<nExpr && affinity_ok; i++){
2343fc7f27b9Sdrh         Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2344cfbb5e82Sdan         int iCol = pEList->a[i].pExpr->iColumn;
23450dfa4f6fSdrh         char idxaff = sqlite3TableColumnAffinity(pTab,iCol); /* RHS table */
2346cfbb5e82Sdan         char cmpaff = sqlite3CompareAffinity(pLhs, idxaff);
234762659b2aSdrh         testcase( cmpaff==SQLITE_AFF_BLOB );
234862659b2aSdrh         testcase( cmpaff==SQLITE_AFF_TEXT );
2349cfbb5e82Sdan         switch( cmpaff ){
2350cfbb5e82Sdan           case SQLITE_AFF_BLOB:
2351cfbb5e82Sdan             break;
2352cfbb5e82Sdan           case SQLITE_AFF_TEXT:
235362659b2aSdrh             /* sqlite3CompareAffinity() only returns TEXT if one side or the
235462659b2aSdrh             ** other has no affinity and the other side is TEXT.  Hence,
235562659b2aSdrh             ** the only way for cmpaff to be TEXT is for idxaff to be TEXT
235662659b2aSdrh             ** and for the term on the LHS of the IN to have no affinity. */
235762659b2aSdrh             assert( idxaff==SQLITE_AFF_TEXT );
2358cfbb5e82Sdan             break;
2359cfbb5e82Sdan           default:
2360cfbb5e82Sdan             affinity_ok = sqlite3IsNumericAffinity(idxaff);
2361cfbb5e82Sdan         }
2362cfbb5e82Sdan       }
2363e1fb65a0Sdanielk1977 
2364a84a283dSdrh       if( affinity_ok ){
2365a84a283dSdrh         /* Search for an existing index that will work for this IN operator */
2366a84a283dSdrh         for(pIdx=pTab->pIndex; pIdx && eType==0; pIdx=pIdx->pNext){
2367a84a283dSdrh           Bitmask colUsed;      /* Columns of the index used */
2368a84a283dSdrh           Bitmask mCol;         /* Mask for the current column */
23696fc8f364Sdrh           if( pIdx->nColumn<nExpr ) continue;
2370a84a283dSdrh           /* Maximum nColumn is BMS-2, not BMS-1, so that we can compute
2371a84a283dSdrh           ** BITMASK(nExpr) without overflowing */
2372a84a283dSdrh           testcase( pIdx->nColumn==BMS-2 );
2373a84a283dSdrh           testcase( pIdx->nColumn==BMS-1 );
2374a84a283dSdrh           if( pIdx->nColumn>=BMS-1 ) continue;
23756fc8f364Sdrh           if( mustBeUnique ){
23766fc8f364Sdrh             if( pIdx->nKeyCol>nExpr
23776fc8f364Sdrh              ||(pIdx->nColumn>nExpr && !IsUniqueIndex(pIdx))
23786fc8f364Sdrh             ){
2379a84a283dSdrh               continue;  /* This index is not unique over the IN RHS columns */
2380cfbb5e82Sdan             }
23816fc8f364Sdrh           }
2382cfbb5e82Sdan 
2383a84a283dSdrh           colUsed = 0;   /* Columns of index used so far */
2384cfbb5e82Sdan           for(i=0; i<nExpr; i++){
2385fc7f27b9Sdrh             Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2386cfbb5e82Sdan             Expr *pRhs = pEList->a[i].pExpr;
2387cfbb5e82Sdan             CollSeq *pReq = sqlite3BinaryCompareCollSeq(pParse, pLhs, pRhs);
2388cfbb5e82Sdan             int j;
2389cfbb5e82Sdan 
23906fc8f364Sdrh             assert( pReq!=0 || pRhs->iColumn==XN_ROWID || pParse->nErr );
2391cfbb5e82Sdan             for(j=0; j<nExpr; j++){
2392cfbb5e82Sdan               if( pIdx->aiColumn[j]!=pRhs->iColumn ) continue;
2393cfbb5e82Sdan               assert( pIdx->azColl[j] );
2394106526e1Sdrh               if( pReq!=0 && sqlite3StrICmp(pReq->zName, pIdx->azColl[j])!=0 ){
2395106526e1Sdrh                 continue;
2396106526e1Sdrh               }
2397cfbb5e82Sdan               break;
2398cfbb5e82Sdan             }
2399cfbb5e82Sdan             if( j==nExpr ) break;
2400a84a283dSdrh             mCol = MASKBIT(j);
2401a84a283dSdrh             if( mCol & colUsed ) break; /* Each column used only once */
2402a84a283dSdrh             colUsed |= mCol;
2403ba00e30aSdan             if( aiMap ) aiMap[i] = j;
2404cfbb5e82Sdan           }
2405cfbb5e82Sdan 
2406a84a283dSdrh           assert( i==nExpr || colUsed!=(MASKBIT(nExpr)-1) );
2407a84a283dSdrh           if( colUsed==(MASKBIT(nExpr)-1) ){
2408a84a283dSdrh             /* If we reach this point, that means the index pIdx is usable */
2409511f9e8dSdrh             int iAddr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
2410363fb95bSdrh #ifndef SQLITE_OMIT_EXPLAIN
2411363fb95bSdrh             sqlite3VdbeAddOp4(v, OP_Explain, 0, 0, 0,
2412363fb95bSdrh               sqlite3MPrintf(db, "USING INDEX %s FOR IN-OPERATOR",pIdx->zName),
2413363fb95bSdrh               P4_DYNAMIC);
2414363fb95bSdrh #endif
24152ec2fb22Sdrh             sqlite3VdbeAddOp3(v, OP_OpenRead, iTab, pIdx->tnum, iDb);
24162ec2fb22Sdrh             sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
2417207872a4Sdanielk1977             VdbeComment((v, "%s", pIdx->zName));
24181ccce449Sdrh             assert( IN_INDEX_INDEX_DESC == IN_INDEX_INDEX_ASC+1 );
24191ccce449Sdrh             eType = IN_INDEX_INDEX_ASC + pIdx->aSortOrder[0];
24209a96b668Sdanielk1977 
24217b35a77bSdan             if( prRhsHasNull ){
24223480bfdaSdan #ifdef SQLITE_ENABLE_COLUMN_USED_MASK
2423cfbb5e82Sdan               i64 mask = (1<<nExpr)-1;
24243480bfdaSdan               sqlite3VdbeAddOp4Dup8(v, OP_ColumnsUsed,
2425cfbb5e82Sdan                   iTab, 0, 0, (u8*)&mask, P4_INT64);
24263480bfdaSdan #endif
2427b80dbdc2Sdrh               *prRhsHasNull = ++pParse->nMem;
24287b35a77bSdan               if( nExpr==1 ){
24296be515ebSdrh                 sqlite3SetHasNullFlag(v, iTab, *prRhsHasNull);
24300cdc022eSdanielk1977               }
24317b35a77bSdan             }
2432552fd454Sdrh             sqlite3VdbeJumpHere(v, iAddr);
24339a96b668Sdanielk1977           }
2434a84a283dSdrh         } /* End loop over indexes */
2435a84a283dSdrh       } /* End if( affinity_ok ) */
2436a84a283dSdrh     } /* End if not an rowid index */
2437a84a283dSdrh   } /* End attempt to optimize using an index */
24389a96b668Sdanielk1977 
2439bb53ecb1Sdrh   /* If no preexisting index is available for the IN clause
2440bb53ecb1Sdrh   ** and IN_INDEX_NOOP is an allowed reply
2441bb53ecb1Sdrh   ** and the RHS of the IN operator is a list, not a subquery
244271c57db0Sdan   ** and the RHS is not constant or has two or fewer terms,
244360ec914cSpeter.d.reid   ** then it is not worth creating an ephemeral table to evaluate
2444bb53ecb1Sdrh   ** the IN operator so return IN_INDEX_NOOP.
2445bb53ecb1Sdrh   */
2446bb53ecb1Sdrh   if( eType==0
2447bb53ecb1Sdrh    && (inFlags & IN_INDEX_NOOP_OK)
2448bb53ecb1Sdrh    && !ExprHasProperty(pX, EP_xIsSelect)
2449bb53ecb1Sdrh    && (!sqlite3InRhsIsConstant(pX) || pX->x.pList->nExpr<=2)
2450bb53ecb1Sdrh   ){
2451bb53ecb1Sdrh     eType = IN_INDEX_NOOP;
2452bb53ecb1Sdrh   }
2453bb53ecb1Sdrh 
24549a96b668Sdanielk1977   if( eType==0 ){
24554387006cSdrh     /* Could not find an existing table or index to use as the RHS b-tree.
2456b74b1017Sdrh     ** We will have to generate an ephemeral table to do the job.
2457b74b1017Sdrh     */
24588e23daf3Sdrh     u32 savedNQueryLoop = pParse->nQueryLoop;
24590cdc022eSdanielk1977     int rMayHaveNull = 0;
246041a05b7bSdanielk1977     eType = IN_INDEX_EPH;
24613a85625dSdrh     if( inFlags & IN_INDEX_LOOP ){
24624a5acf8eSdrh       pParse->nQueryLoop = 0;
2463c5cd1249Sdrh       if( pX->pLeft->iColumn<0 && !ExprHasProperty(pX, EP_xIsSelect) ){
246441a05b7bSdanielk1977         eType = IN_INDEX_ROWID;
24650cdc022eSdanielk1977       }
2466e21a6e1dSdrh     }else if( prRhsHasNull ){
2467e21a6e1dSdrh       *prRhsHasNull = rMayHaveNull = ++pParse->nMem;
2468cf4d38aaSdrh     }
246941a05b7bSdanielk1977     sqlite3CodeSubselect(pParse, pX, rMayHaveNull, eType==IN_INDEX_ROWID);
2470cf4d38aaSdrh     pParse->nQueryLoop = savedNQueryLoop;
24719a96b668Sdanielk1977   }else{
24729a96b668Sdanielk1977     pX->iTable = iTab;
24739a96b668Sdanielk1977   }
2474ba00e30aSdan 
2475ba00e30aSdan   if( aiMap && eType!=IN_INDEX_INDEX_ASC && eType!=IN_INDEX_INDEX_DESC ){
2476ba00e30aSdan     int i, n;
2477ba00e30aSdan     n = sqlite3ExprVectorSize(pX->pLeft);
2478ba00e30aSdan     for(i=0; i<n; i++) aiMap[i] = i;
2479ba00e30aSdan   }
24809a96b668Sdanielk1977   return eType;
24819a96b668Sdanielk1977 }
2482284f4acaSdanielk1977 #endif
2483626a879aSdrh 
2484f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
2485553168c7Sdan /*
2486553168c7Sdan ** Argument pExpr is an (?, ?...) IN(...) expression. This
2487553168c7Sdan ** function allocates and returns a nul-terminated string containing
2488553168c7Sdan ** the affinities to be used for each column of the comparison.
2489553168c7Sdan **
2490553168c7Sdan ** It is the responsibility of the caller to ensure that the returned
2491553168c7Sdan ** string is eventually freed using sqlite3DbFree().
2492553168c7Sdan */
249371c57db0Sdan static char *exprINAffinity(Parse *pParse, Expr *pExpr){
249471c57db0Sdan   Expr *pLeft = pExpr->pLeft;
249571c57db0Sdan   int nVal = sqlite3ExprVectorSize(pLeft);
2496553168c7Sdan   Select *pSelect = (pExpr->flags & EP_xIsSelect) ? pExpr->x.pSelect : 0;
249771c57db0Sdan   char *zRet;
249871c57db0Sdan 
2499553168c7Sdan   assert( pExpr->op==TK_IN );
25005c258dc1Sdrh   zRet = sqlite3DbMallocRaw(pParse->db, nVal+1);
250171c57db0Sdan   if( zRet ){
250271c57db0Sdan     int i;
250371c57db0Sdan     for(i=0; i<nVal; i++){
2504fc7f27b9Sdrh       Expr *pA = sqlite3VectorFieldSubexpr(pLeft, i);
2505553168c7Sdan       char a = sqlite3ExprAffinity(pA);
2506553168c7Sdan       if( pSelect ){
2507553168c7Sdan         zRet[i] = sqlite3CompareAffinity(pSelect->pEList->a[i].pExpr, a);
250871c57db0Sdan       }else{
2509553168c7Sdan         zRet[i] = a;
251071c57db0Sdan       }
251171c57db0Sdan     }
251271c57db0Sdan     zRet[nVal] = '\0';
251371c57db0Sdan   }
251471c57db0Sdan   return zRet;
251571c57db0Sdan }
2516f9b2e05cSdan #endif
251771c57db0Sdan 
25188da209b1Sdan #ifndef SQLITE_OMIT_SUBQUERY
25198da209b1Sdan /*
25208da209b1Sdan ** Load the Parse object passed as the first argument with an error
25218da209b1Sdan ** message of the form:
25228da209b1Sdan **
25238da209b1Sdan **   "sub-select returns N columns - expected M"
25248da209b1Sdan */
25258da209b1Sdan void sqlite3SubselectError(Parse *pParse, int nActual, int nExpect){
25268da209b1Sdan   const char *zFmt = "sub-select returns %d columns - expected %d";
25278da209b1Sdan   sqlite3ErrorMsg(pParse, zFmt, nActual, nExpect);
25288da209b1Sdan }
25298da209b1Sdan #endif
25308da209b1Sdan 
2531626a879aSdrh /*
253244c5604cSdan ** Expression pExpr is a vector that has been used in a context where
253344c5604cSdan ** it is not permitted. If pExpr is a sub-select vector, this routine
253444c5604cSdan ** loads the Parse object with a message of the form:
253544c5604cSdan **
253644c5604cSdan **   "sub-select returns N columns - expected 1"
253744c5604cSdan **
253844c5604cSdan ** Or, if it is a regular scalar vector:
253944c5604cSdan **
254044c5604cSdan **   "row value misused"
254144c5604cSdan */
254244c5604cSdan void sqlite3VectorErrorMsg(Parse *pParse, Expr *pExpr){
254344c5604cSdan #ifndef SQLITE_OMIT_SUBQUERY
254444c5604cSdan   if( pExpr->flags & EP_xIsSelect ){
254544c5604cSdan     sqlite3SubselectError(pParse, pExpr->x.pSelect->pEList->nExpr, 1);
254644c5604cSdan   }else
254744c5604cSdan #endif
254844c5604cSdan   {
254944c5604cSdan     sqlite3ErrorMsg(pParse, "row value misused");
255044c5604cSdan   }
255144c5604cSdan }
255244c5604cSdan 
255344c5604cSdan /*
2554d4187c71Sdrh ** Generate code for scalar subqueries used as a subquery expression, EXISTS,
2555d4187c71Sdrh ** or IN operators.  Examples:
2556626a879aSdrh **
25579cbe6352Sdrh **     (SELECT a FROM b)          -- subquery
25589cbe6352Sdrh **     EXISTS (SELECT a FROM b)   -- EXISTS subquery
25599cbe6352Sdrh **     x IN (4,5,11)              -- IN operator with list on right-hand side
25609cbe6352Sdrh **     x IN (SELECT a FROM b)     -- IN operator with subquery on the right
2561fef5208cSdrh **
25629cbe6352Sdrh ** The pExpr parameter describes the expression that contains the IN
25639cbe6352Sdrh ** operator or subquery.
256441a05b7bSdanielk1977 **
256541a05b7bSdanielk1977 ** If parameter isRowid is non-zero, then expression pExpr is guaranteed
256641a05b7bSdanielk1977 ** to be of the form "<rowid> IN (?, ?, ?)", where <rowid> is a reference
256741a05b7bSdanielk1977 ** to some integer key column of a table B-Tree. In this case, use an
256841a05b7bSdanielk1977 ** intkey B-Tree to store the set of IN(...) values instead of the usual
256941a05b7bSdanielk1977 ** (slower) variable length keys B-Tree.
2570fd773cf9Sdrh **
2571fd773cf9Sdrh ** If rMayHaveNull is non-zero, that means that the operation is an IN
2572fd773cf9Sdrh ** (not a SELECT or EXISTS) and that the RHS might contains NULLs.
25733a85625dSdrh ** All this routine does is initialize the register given by rMayHaveNull
25743a85625dSdrh ** to NULL.  Calling routines will take care of changing this register
25753a85625dSdrh ** value to non-NULL if the RHS is NULL-free.
25761450bc6eSdrh **
25771450bc6eSdrh ** For a SELECT or EXISTS operator, return the register that holds the
257839a11819Sdrh ** result.  For a multi-column SELECT, the result is stored in a contiguous
257939a11819Sdrh ** array of registers and the return value is the register of the left-most
258039a11819Sdrh ** result column.  Return 0 for IN operators or if an error occurs.
2581cce7d176Sdrh */
258251522cd3Sdrh #ifndef SQLITE_OMIT_SUBQUERY
25831450bc6eSdrh int sqlite3CodeSubselect(
2584fd773cf9Sdrh   Parse *pParse,          /* Parsing context */
2585fd773cf9Sdrh   Expr *pExpr,            /* The IN, SELECT, or EXISTS operator */
25866be515ebSdrh   int rHasNullFlag,       /* Register that records whether NULLs exist in RHS */
2587fd773cf9Sdrh   int isRowid             /* If true, LHS of IN operator is a rowid */
258841a05b7bSdanielk1977 ){
25896be515ebSdrh   int jmpIfDynamic = -1;                      /* One-time test address */
25901450bc6eSdrh   int rReg = 0;                           /* Register storing resulting */
2591b3bce662Sdanielk1977   Vdbe *v = sqlite3GetVdbe(pParse);
25921450bc6eSdrh   if( NEVER(v==0) ) return 0;
2593ceea3321Sdrh   sqlite3ExprCachePush(pParse);
2594fc976065Sdanielk1977 
259539a11819Sdrh   /* The evaluation of the IN/EXISTS/SELECT must be repeated every time it
259639a11819Sdrh   ** is encountered if any of the following is true:
259757dbd7b3Sdrh   **
259857dbd7b3Sdrh   **    *  The right-hand side is a correlated subquery
259957dbd7b3Sdrh   **    *  The right-hand side is an expression list containing variables
260057dbd7b3Sdrh   **    *  We are inside a trigger
260157dbd7b3Sdrh   **
260257dbd7b3Sdrh   ** If all of the above are false, then we can run this code just once
260357dbd7b3Sdrh   ** save the results, and reuse the same result on subsequent invocations.
2604b3bce662Sdanielk1977   */
2605c5cd1249Sdrh   if( !ExprHasProperty(pExpr, EP_VarSelect) ){
2606511f9e8dSdrh     jmpIfDynamic = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
2607b3bce662Sdanielk1977   }
2608b3bce662Sdanielk1977 
26094a07e3dbSdan #ifndef SQLITE_OMIT_EXPLAIN
26104a07e3dbSdan   if( pParse->explain==2 ){
261162aaa6caSdrh     char *zMsg = sqlite3MPrintf(pParse->db, "EXECUTE %s%s SUBQUERY %d",
261262aaa6caSdrh         jmpIfDynamic>=0?"":"CORRELATED ",
261362aaa6caSdrh         pExpr->op==TK_IN?"LIST":"SCALAR",
261462aaa6caSdrh         pParse->iNextSelectId
26154a07e3dbSdan     );
26164a07e3dbSdan     sqlite3VdbeAddOp4(v, OP_Explain, pParse->iSelectId, 0, 0, zMsg, P4_DYNAMIC);
26174a07e3dbSdan   }
26184a07e3dbSdan #endif
26194a07e3dbSdan 
2620cce7d176Sdrh   switch( pExpr->op ){
2621fef5208cSdrh     case TK_IN: {
2622b9bb7c18Sdrh       int addr;                   /* Address of OP_OpenEphemeral instruction */
2623d4187c71Sdrh       Expr *pLeft = pExpr->pLeft; /* the LHS of the IN operator */
2624323df790Sdrh       KeyInfo *pKeyInfo = 0;      /* Key information */
262571c57db0Sdan       int nVal;                   /* Size of vector pLeft */
2626d3d39e93Sdrh 
262771c57db0Sdan       nVal = sqlite3ExprVectorSize(pLeft);
2628553168c7Sdan       assert( !isRowid || nVal==1 );
2629e014a838Sdanielk1977 
2630e014a838Sdanielk1977       /* Whether this is an 'x IN(SELECT...)' or an 'x IN(<exprlist>)'
26318cff69dfSdrh       ** expression it is handled the same way.  An ephemeral table is
2632553168c7Sdan       ** filled with index keys representing the results from the
2633553168c7Sdan       ** SELECT or the <exprlist>.
2634fef5208cSdrh       **
2635e014a838Sdanielk1977       ** If the 'x' expression is a column value, or the SELECT...
2636e014a838Sdanielk1977       ** statement returns a column value, then the affinity of that
2637e014a838Sdanielk1977       ** column is used to build the index keys. If both 'x' and the
2638e014a838Sdanielk1977       ** SELECT... statement are columns, then numeric affinity is used
2639e014a838Sdanielk1977       ** if either column has NUMERIC or INTEGER affinity. If neither
2640e014a838Sdanielk1977       ** 'x' nor the SELECT... statement are columns, then numeric affinity
2641e014a838Sdanielk1977       ** is used.
2642fef5208cSdrh       */
2643832508b7Sdrh       pExpr->iTable = pParse->nTab++;
264471c57db0Sdan       addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral,
264571c57db0Sdan           pExpr->iTable, (isRowid?0:nVal));
264671c57db0Sdan       pKeyInfo = isRowid ? 0 : sqlite3KeyInfoAlloc(pParse->db, nVal, 1);
2647e014a838Sdanielk1977 
26486ab3a2ecSdanielk1977       if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2649e014a838Sdanielk1977         /* Case 1:     expr IN (SELECT ...)
2650e014a838Sdanielk1977         **
2651e014a838Sdanielk1977         ** Generate code to write the results of the select into the temporary
2652e014a838Sdanielk1977         ** table allocated and opened above.
2653e014a838Sdanielk1977         */
26544387006cSdrh         Select *pSelect = pExpr->x.pSelect;
265571c57db0Sdan         ExprList *pEList = pSelect->pEList;
26561013c932Sdrh 
265741a05b7bSdanielk1977         assert( !isRowid );
265864bcb8cfSdrh         /* If the LHS and RHS of the IN operator do not match, that
265964bcb8cfSdrh         ** error will have been caught long before we reach this point. */
266064bcb8cfSdrh         if( ALWAYS(pEList->nExpr==nVal) ){
266171c57db0Sdan           SelectDest dest;
266271c57db0Sdan           int i;
26631013c932Sdrh           sqlite3SelectDestInit(&dest, SRT_Set, pExpr->iTable);
266471c57db0Sdan           dest.zAffSdst = exprINAffinity(pParse, pExpr);
26654387006cSdrh           pSelect->iLimit = 0;
26664387006cSdrh           testcase( pSelect->selFlags & SF_Distinct );
2667812ea833Sdrh           testcase( pKeyInfo==0 ); /* Caused by OOM in sqlite3KeyInfoAlloc() */
26684387006cSdrh           if( sqlite3Select(pParse, pSelect, &dest) ){
266971c57db0Sdan             sqlite3DbFree(pParse->db, dest.zAffSdst);
26702ec2fb22Sdrh             sqlite3KeyInfoUnref(pKeyInfo);
26711450bc6eSdrh             return 0;
267294ccde58Sdrh           }
267371c57db0Sdan           sqlite3DbFree(pParse->db, dest.zAffSdst);
2674812ea833Sdrh           assert( pKeyInfo!=0 ); /* OOM will cause exit after sqlite3Select() */
26753535ec3eSdrh           assert( pEList!=0 );
26763535ec3eSdrh           assert( pEList->nExpr>0 );
26772ec2fb22Sdrh           assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
267871c57db0Sdan           for(i=0; i<nVal; i++){
2679773d3afaSdan             Expr *p = sqlite3VectorFieldSubexpr(pLeft, i);
268071c57db0Sdan             pKeyInfo->aColl[i] = sqlite3BinaryCompareCollSeq(
268171c57db0Sdan                 pParse, p, pEList->a[i].pExpr
268271c57db0Sdan             );
268371c57db0Sdan           }
268471c57db0Sdan         }
2685a7d2db17Sdrh       }else if( ALWAYS(pExpr->x.pList!=0) ){
2686fef5208cSdrh         /* Case 2:     expr IN (exprlist)
2687fef5208cSdrh         **
2688e014a838Sdanielk1977         ** For each expression, build an index key from the evaluation and
2689e014a838Sdanielk1977         ** store it in the temporary table. If <expr> is a column, then use
2690e014a838Sdanielk1977         ** that columns affinity when building index keys. If <expr> is not
2691e014a838Sdanielk1977         ** a column, use numeric affinity.
2692fef5208cSdrh         */
269371c57db0Sdan         char affinity;            /* Affinity of the LHS of the IN */
2694e014a838Sdanielk1977         int i;
26956ab3a2ecSdanielk1977         ExprList *pList = pExpr->x.pList;
269657dbd7b3Sdrh         struct ExprList_item *pItem;
2697ecc31805Sdrh         int r1, r2, r3;
269857dbd7b3Sdrh 
269971c57db0Sdan         affinity = sqlite3ExprAffinity(pLeft);
2700e014a838Sdanielk1977         if( !affinity ){
270105883a34Sdrh           affinity = SQLITE_AFF_BLOB;
2702e014a838Sdanielk1977         }
2703323df790Sdrh         if( pKeyInfo ){
27042ec2fb22Sdrh           assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
2705323df790Sdrh           pKeyInfo->aColl[0] = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
2706323df790Sdrh         }
2707e014a838Sdanielk1977 
2708e014a838Sdanielk1977         /* Loop through each expression in <exprlist>. */
27092d401ab8Sdrh         r1 = sqlite3GetTempReg(pParse);
27102d401ab8Sdrh         r2 = sqlite3GetTempReg(pParse);
271121cd29abSdan         if( isRowid ) sqlite3VdbeAddOp4(v, OP_Blob, 0, r2, 0, "", P4_STATIC);
271257dbd7b3Sdrh         for(i=pList->nExpr, pItem=pList->a; i>0; i--, pItem++){
271357dbd7b3Sdrh           Expr *pE2 = pItem->pExpr;
2714e05c929bSdrh           int iValToIns;
2715e014a838Sdanielk1977 
271657dbd7b3Sdrh           /* If the expression is not constant then we will need to
271757dbd7b3Sdrh           ** disable the test that was generated above that makes sure
271857dbd7b3Sdrh           ** this code only executes once.  Because for a non-constant
271957dbd7b3Sdrh           ** expression we need to rerun this code each time.
272057dbd7b3Sdrh           */
27216be515ebSdrh           if( jmpIfDynamic>=0 && !sqlite3ExprIsConstant(pE2) ){
27226be515ebSdrh             sqlite3VdbeChangeToNoop(v, jmpIfDynamic);
27236be515ebSdrh             jmpIfDynamic = -1;
27244794b980Sdrh           }
2725e014a838Sdanielk1977 
2726e014a838Sdanielk1977           /* Evaluate the expression and insert it into the temp table */
2727e05c929bSdrh           if( isRowid && sqlite3ExprIsInteger(pE2, &iValToIns) ){
2728e05c929bSdrh             sqlite3VdbeAddOp3(v, OP_InsertInt, pExpr->iTable, r2, iValToIns);
2729e05c929bSdrh           }else{
2730ecc31805Sdrh             r3 = sqlite3ExprCodeTarget(pParse, pE2, r1);
273141a05b7bSdanielk1977             if( isRowid ){
2732e05c929bSdrh               sqlite3VdbeAddOp2(v, OP_MustBeInt, r3,
2733e05c929bSdrh                                 sqlite3VdbeCurrentAddr(v)+2);
2734688852abSdrh               VdbeCoverage(v);
273541a05b7bSdanielk1977               sqlite3VdbeAddOp3(v, OP_Insert, pExpr->iTable, r2, r3);
273641a05b7bSdanielk1977             }else{
2737ecc31805Sdrh               sqlite3VdbeAddOp4(v, OP_MakeRecord, r3, 1, r2, &affinity, 1);
27383c31fc23Sdrh               sqlite3ExprCacheAffinityChange(pParse, r3, 1);
27399b4eaebcSdrh               sqlite3VdbeAddOp4Int(v, OP_IdxInsert, pExpr->iTable, r2, r3, 1);
2740fef5208cSdrh             }
274141a05b7bSdanielk1977           }
2742e05c929bSdrh         }
27432d401ab8Sdrh         sqlite3ReleaseTempReg(pParse, r1);
27442d401ab8Sdrh         sqlite3ReleaseTempReg(pParse, r2);
2745fef5208cSdrh       }
2746323df790Sdrh       if( pKeyInfo ){
27472ec2fb22Sdrh         sqlite3VdbeChangeP4(v, addr, (void *)pKeyInfo, P4_KEYINFO);
274841a05b7bSdanielk1977       }
2749b3bce662Sdanielk1977       break;
2750fef5208cSdrh     }
2751fef5208cSdrh 
275251522cd3Sdrh     case TK_EXISTS:
2753fd773cf9Sdrh     case TK_SELECT:
2754fd773cf9Sdrh     default: {
275539a11819Sdrh       /* Case 3:    (SELECT ... FROM ...)
275639a11819Sdrh       **     or:    EXISTS(SELECT ... FROM ...)
275739a11819Sdrh       **
275839a11819Sdrh       ** For a SELECT, generate code to put the values for all columns of
275939a11819Sdrh       ** the first row into an array of registers and return the index of
276039a11819Sdrh       ** the first register.
276139a11819Sdrh       **
276239a11819Sdrh       ** If this is an EXISTS, write an integer 0 (not exists) or 1 (exists)
276339a11819Sdrh       ** into a register and return that register number.
276439a11819Sdrh       **
276539a11819Sdrh       ** In both cases, the query is augmented with "LIMIT 1".  Any
276639a11819Sdrh       ** preexisting limit is discarded in place of the new LIMIT 1.
2767fef5208cSdrh       */
2768fd773cf9Sdrh       Select *pSel;                         /* SELECT statement to encode */
276939a11819Sdrh       SelectDest dest;                      /* How to deal with SELECT result */
277071c57db0Sdan       int nReg;                             /* Registers to allocate */
27718c0833fbSdrh       Expr *pLimit;                         /* New limit expression */
27721398ad36Sdrh 
2773cf697396Sshane       testcase( pExpr->op==TK_EXISTS );
2774cf697396Sshane       testcase( pExpr->op==TK_SELECT );
2775cf697396Sshane       assert( pExpr->op==TK_EXISTS || pExpr->op==TK_SELECT );
27766ab3a2ecSdanielk1977       assert( ExprHasProperty(pExpr, EP_xIsSelect) );
277771c57db0Sdan 
27786ab3a2ecSdanielk1977       pSel = pExpr->x.pSelect;
277971c57db0Sdan       nReg = pExpr->op==TK_SELECT ? pSel->pEList->nExpr : 1;
278071c57db0Sdan       sqlite3SelectDestInit(&dest, 0, pParse->nMem+1);
278171c57db0Sdan       pParse->nMem += nReg;
278251522cd3Sdrh       if( pExpr->op==TK_SELECT ){
27836c8c8ce0Sdanielk1977         dest.eDest = SRT_Mem;
278453932ce8Sdrh         dest.iSdst = dest.iSDParm;
278571c57db0Sdan         dest.nSdst = nReg;
278671c57db0Sdan         sqlite3VdbeAddOp3(v, OP_Null, 0, dest.iSDParm, dest.iSDParm+nReg-1);
2787d4e70ebdSdrh         VdbeComment((v, "Init subquery result"));
278851522cd3Sdrh       }else{
27896c8c8ce0Sdanielk1977         dest.eDest = SRT_Exists;
27902b596da8Sdrh         sqlite3VdbeAddOp2(v, OP_Integer, 0, dest.iSDParm);
2791d4e70ebdSdrh         VdbeComment((v, "Init EXISTS result"));
279251522cd3Sdrh       }
27938c0833fbSdrh       pLimit = sqlite3ExprAlloc(pParse->db, TK_INTEGER,&sqlite3IntTokens[1], 0);
27948c0833fbSdrh       if( pSel->pLimit ){
27958c0833fbSdrh         sqlite3ExprDelete(pParse->db, pSel->pLimit->pLeft);
27968c0833fbSdrh         pSel->pLimit->pLeft = pLimit;
27978c0833fbSdrh       }else{
27988c0833fbSdrh         pSel->pLimit = sqlite3PExpr(pParse, TK_LIMIT, pLimit, 0);
27998c0833fbSdrh       }
280048b5b041Sdrh       pSel->iLimit = 0;
28017d10d5a6Sdrh       if( sqlite3Select(pParse, pSel, &dest) ){
28021450bc6eSdrh         return 0;
280394ccde58Sdrh       }
28042b596da8Sdrh       rReg = dest.iSDParm;
2805ebb6a65dSdrh       ExprSetVVAProperty(pExpr, EP_NoReduce);
2806b3bce662Sdanielk1977       break;
280719a775c2Sdrh     }
2808cce7d176Sdrh   }
2809b3bce662Sdanielk1977 
28106be515ebSdrh   if( rHasNullFlag ){
28116be515ebSdrh     sqlite3SetHasNullFlag(v, pExpr->iTable, rHasNullFlag);
2812b3bce662Sdanielk1977   }
28136be515ebSdrh 
28146be515ebSdrh   if( jmpIfDynamic>=0 ){
28156be515ebSdrh     sqlite3VdbeJumpHere(v, jmpIfDynamic);
2816b3bce662Sdanielk1977   }
2817d2490904Sdrh   sqlite3ExprCachePop(pParse);
2818fc976065Sdanielk1977 
28191450bc6eSdrh   return rReg;
2820cce7d176Sdrh }
282151522cd3Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
2822cce7d176Sdrh 
2823e3365e6cSdrh #ifndef SQLITE_OMIT_SUBQUERY
2824e3365e6cSdrh /*
28257b35a77bSdan ** Expr pIn is an IN(...) expression. This function checks that the
28267b35a77bSdan ** sub-select on the RHS of the IN() operator has the same number of
28277b35a77bSdan ** columns as the vector on the LHS. Or, if the RHS of the IN() is not
28287b35a77bSdan ** a sub-query, that the LHS is a vector of size 1.
28297b35a77bSdan */
28307b35a77bSdan int sqlite3ExprCheckIN(Parse *pParse, Expr *pIn){
28317b35a77bSdan   int nVector = sqlite3ExprVectorSize(pIn->pLeft);
28327b35a77bSdan   if( (pIn->flags & EP_xIsSelect) ){
28337b35a77bSdan     if( nVector!=pIn->x.pSelect->pEList->nExpr ){
28347b35a77bSdan       sqlite3SubselectError(pParse, pIn->x.pSelect->pEList->nExpr, nVector);
28357b35a77bSdan       return 1;
28367b35a77bSdan     }
28377b35a77bSdan   }else if( nVector!=1 ){
283844c5604cSdan     sqlite3VectorErrorMsg(pParse, pIn->pLeft);
28397b35a77bSdan     return 1;
28407b35a77bSdan   }
28417b35a77bSdan   return 0;
28427b35a77bSdan }
28437b35a77bSdan #endif
28447b35a77bSdan 
28457b35a77bSdan #ifndef SQLITE_OMIT_SUBQUERY
28467b35a77bSdan /*
2847e3365e6cSdrh ** Generate code for an IN expression.
2848e3365e6cSdrh **
2849e3365e6cSdrh **      x IN (SELECT ...)
2850e3365e6cSdrh **      x IN (value, value, ...)
2851e3365e6cSdrh **
2852ecb87ac8Sdrh ** The left-hand side (LHS) is a scalar or vector expression.  The
2853e347d3e8Sdrh ** right-hand side (RHS) is an array of zero or more scalar values, or a
2854e347d3e8Sdrh ** subquery.  If the RHS is a subquery, the number of result columns must
2855e347d3e8Sdrh ** match the number of columns in the vector on the LHS.  If the RHS is
2856e347d3e8Sdrh ** a list of values, the LHS must be a scalar.
2857e347d3e8Sdrh **
2858e347d3e8Sdrh ** The IN operator is true if the LHS value is contained within the RHS.
2859e347d3e8Sdrh ** The result is false if the LHS is definitely not in the RHS.  The
2860e347d3e8Sdrh ** result is NULL if the presence of the LHS in the RHS cannot be
2861e347d3e8Sdrh ** determined due to NULLs.
2862e3365e6cSdrh **
28636be515ebSdrh ** This routine generates code that jumps to destIfFalse if the LHS is not
2864e3365e6cSdrh ** contained within the RHS.  If due to NULLs we cannot determine if the LHS
2865e3365e6cSdrh ** is contained in the RHS then jump to destIfNull.  If the LHS is contained
2866e3365e6cSdrh ** within the RHS then fall through.
2867ecb87ac8Sdrh **
2868ecb87ac8Sdrh ** See the separate in-operator.md documentation file in the canonical
2869ecb87ac8Sdrh ** SQLite source tree for additional information.
2870e3365e6cSdrh */
2871e3365e6cSdrh static void sqlite3ExprCodeIN(
2872e3365e6cSdrh   Parse *pParse,        /* Parsing and code generating context */
2873e3365e6cSdrh   Expr *pExpr,          /* The IN expression */
2874e3365e6cSdrh   int destIfFalse,      /* Jump here if LHS is not contained in the RHS */
2875e3365e6cSdrh   int destIfNull        /* Jump here if the results are unknown due to NULLs */
2876e3365e6cSdrh ){
2877e3365e6cSdrh   int rRhsHasNull = 0;  /* Register that is true if RHS contains NULL values */
2878e3365e6cSdrh   int eType;            /* Type of the RHS */
2879e347d3e8Sdrh   int rLhs;             /* Register(s) holding the LHS values */
2880e347d3e8Sdrh   int rLhsOrig;         /* LHS values prior to reordering by aiMap[] */
2881e3365e6cSdrh   Vdbe *v;              /* Statement under construction */
2882ba00e30aSdan   int *aiMap = 0;       /* Map from vector field to index column */
2883ba00e30aSdan   char *zAff = 0;       /* Affinity string for comparisons */
2884ecb87ac8Sdrh   int nVector;          /* Size of vectors for this IN operator */
288512abf408Sdrh   int iDummy;           /* Dummy parameter to exprCodeVector() */
2886e347d3e8Sdrh   Expr *pLeft;          /* The LHS of the IN operator */
2887ecb87ac8Sdrh   int i;                /* loop counter */
2888e347d3e8Sdrh   int destStep2;        /* Where to jump when NULLs seen in step 2 */
2889e347d3e8Sdrh   int destStep6 = 0;    /* Start of code for Step 6 */
2890e347d3e8Sdrh   int addrTruthOp;      /* Address of opcode that determines the IN is true */
2891e347d3e8Sdrh   int destNotNull;      /* Jump here if a comparison is not true in step 6 */
2892e347d3e8Sdrh   int addrTop;          /* Top of the step-6 loop */
2893e3365e6cSdrh 
2894e347d3e8Sdrh   pLeft = pExpr->pLeft;
28957b35a77bSdan   if( sqlite3ExprCheckIN(pParse, pExpr) ) return;
2896553168c7Sdan   zAff = exprINAffinity(pParse, pExpr);
2897ba00e30aSdan   nVector = sqlite3ExprVectorSize(pExpr->pLeft);
2898ba00e30aSdan   aiMap = (int*)sqlite3DbMallocZero(
2899ba00e30aSdan       pParse->db, nVector*(sizeof(int) + sizeof(char)) + 1
2900ba00e30aSdan   );
2901e347d3e8Sdrh   if( pParse->db->mallocFailed ) goto sqlite3ExprCodeIN_oom_error;
29027b35a77bSdan 
2903ba00e30aSdan   /* Attempt to compute the RHS. After this step, if anything other than
2904ba00e30aSdan   ** IN_INDEX_NOOP is returned, the table opened ith cursor pExpr->iTable
2905ba00e30aSdan   ** contains the values that make up the RHS. If IN_INDEX_NOOP is returned,
2906ba00e30aSdan   ** the RHS has not yet been coded.  */
2907e3365e6cSdrh   v = pParse->pVdbe;
2908e3365e6cSdrh   assert( v!=0 );       /* OOM detected prior to this routine */
2909e3365e6cSdrh   VdbeNoopComment((v, "begin IN expr"));
2910bb53ecb1Sdrh   eType = sqlite3FindInIndex(pParse, pExpr,
2911bb53ecb1Sdrh                              IN_INDEX_MEMBERSHIP | IN_INDEX_NOOP_OK,
2912ba00e30aSdan                              destIfFalse==destIfNull ? 0 : &rRhsHasNull, aiMap);
2913e3365e6cSdrh 
2914ba00e30aSdan   assert( pParse->nErr || nVector==1 || eType==IN_INDEX_EPH
2915ba00e30aSdan        || eType==IN_INDEX_INDEX_ASC || eType==IN_INDEX_INDEX_DESC
2916ba00e30aSdan   );
2917ecb87ac8Sdrh #ifdef SQLITE_DEBUG
2918ecb87ac8Sdrh   /* Confirm that aiMap[] contains nVector integer values between 0 and
2919ecb87ac8Sdrh   ** nVector-1. */
2920ecb87ac8Sdrh   for(i=0; i<nVector; i++){
2921ecb87ac8Sdrh     int j, cnt;
2922ecb87ac8Sdrh     for(cnt=j=0; j<nVector; j++) if( aiMap[j]==i ) cnt++;
2923ecb87ac8Sdrh     assert( cnt==1 );
2924ecb87ac8Sdrh   }
2925ecb87ac8Sdrh #endif
2926e3365e6cSdrh 
2927ba00e30aSdan   /* Code the LHS, the <expr> from "<expr> IN (...)". If the LHS is a
2928ba00e30aSdan   ** vector, then it is stored in an array of nVector registers starting
2929ba00e30aSdan   ** at r1.
2930e347d3e8Sdrh   **
2931e347d3e8Sdrh   ** sqlite3FindInIndex() might have reordered the fields of the LHS vector
2932e347d3e8Sdrh   ** so that the fields are in the same order as an existing index.   The
2933e347d3e8Sdrh   ** aiMap[] array contains a mapping from the original LHS field order to
2934e347d3e8Sdrh   ** the field order that matches the RHS index.
2935e3365e6cSdrh   */
2936e3365e6cSdrh   sqlite3ExprCachePush(pParse);
2937e347d3e8Sdrh   rLhsOrig = exprCodeVector(pParse, pLeft, &iDummy);
2938e347d3e8Sdrh   for(i=0; i<nVector && aiMap[i]==i; i++){} /* Are LHS fields reordered? */
2939ecb87ac8Sdrh   if( i==nVector ){
2940e347d3e8Sdrh     /* LHS fields are not reordered */
2941e347d3e8Sdrh     rLhs = rLhsOrig;
2942ecb87ac8Sdrh   }else{
2943ecb87ac8Sdrh     /* Need to reorder the LHS fields according to aiMap */
2944e347d3e8Sdrh     rLhs = sqlite3GetTempRange(pParse, nVector);
2945ba00e30aSdan     for(i=0; i<nVector; i++){
2946e347d3e8Sdrh       sqlite3VdbeAddOp3(v, OP_Copy, rLhsOrig+i, rLhs+aiMap[i], 0);
2947ba00e30aSdan     }
2948ecb87ac8Sdrh   }
2949e3365e6cSdrh 
2950bb53ecb1Sdrh   /* If sqlite3FindInIndex() did not find or create an index that is
2951bb53ecb1Sdrh   ** suitable for evaluating the IN operator, then evaluate using a
2952bb53ecb1Sdrh   ** sequence of comparisons.
2953e347d3e8Sdrh   **
2954e347d3e8Sdrh   ** This is step (1) in the in-operator.md optimized algorithm.
2955bb53ecb1Sdrh   */
2956bb53ecb1Sdrh   if( eType==IN_INDEX_NOOP ){
2957bb53ecb1Sdrh     ExprList *pList = pExpr->x.pList;
2958bb53ecb1Sdrh     CollSeq *pColl = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
2959bb53ecb1Sdrh     int labelOk = sqlite3VdbeMakeLabel(v);
2960bb53ecb1Sdrh     int r2, regToFree;
2961bb53ecb1Sdrh     int regCkNull = 0;
2962bb53ecb1Sdrh     int ii;
2963bb53ecb1Sdrh     assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
2964bb53ecb1Sdrh     if( destIfNull!=destIfFalse ){
2965bb53ecb1Sdrh       regCkNull = sqlite3GetTempReg(pParse);
2966e347d3e8Sdrh       sqlite3VdbeAddOp3(v, OP_BitAnd, rLhs, rLhs, regCkNull);
2967bb53ecb1Sdrh     }
2968bb53ecb1Sdrh     for(ii=0; ii<pList->nExpr; ii++){
2969bb53ecb1Sdrh       r2 = sqlite3ExprCodeTemp(pParse, pList->a[ii].pExpr, &regToFree);
2970a976979bSdrh       if( regCkNull && sqlite3ExprCanBeNull(pList->a[ii].pExpr) ){
2971bb53ecb1Sdrh         sqlite3VdbeAddOp3(v, OP_BitAnd, regCkNull, r2, regCkNull);
2972bb53ecb1Sdrh       }
2973bb53ecb1Sdrh       if( ii<pList->nExpr-1 || destIfNull!=destIfFalse ){
2974e347d3e8Sdrh         sqlite3VdbeAddOp4(v, OP_Eq, rLhs, labelOk, r2,
29754336b0e6Sdrh                           (void*)pColl, P4_COLLSEQ);
29764336b0e6Sdrh         VdbeCoverageIf(v, ii<pList->nExpr-1);
29774336b0e6Sdrh         VdbeCoverageIf(v, ii==pList->nExpr-1);
2978ba00e30aSdan         sqlite3VdbeChangeP5(v, zAff[0]);
2979bb53ecb1Sdrh       }else{
2980bb53ecb1Sdrh         assert( destIfNull==destIfFalse );
2981e347d3e8Sdrh         sqlite3VdbeAddOp4(v, OP_Ne, rLhs, destIfFalse, r2,
2982bb53ecb1Sdrh                           (void*)pColl, P4_COLLSEQ); VdbeCoverage(v);
2983ba00e30aSdan         sqlite3VdbeChangeP5(v, zAff[0] | SQLITE_JUMPIFNULL);
2984bb53ecb1Sdrh       }
2985bb53ecb1Sdrh       sqlite3ReleaseTempReg(pParse, regToFree);
2986bb53ecb1Sdrh     }
2987bb53ecb1Sdrh     if( regCkNull ){
2988bb53ecb1Sdrh       sqlite3VdbeAddOp2(v, OP_IsNull, regCkNull, destIfNull); VdbeCoverage(v);
2989076e85f5Sdrh       sqlite3VdbeGoto(v, destIfFalse);
2990bb53ecb1Sdrh     }
2991bb53ecb1Sdrh     sqlite3VdbeResolveLabel(v, labelOk);
2992bb53ecb1Sdrh     sqlite3ReleaseTempReg(pParse, regCkNull);
2993e347d3e8Sdrh     goto sqlite3ExprCodeIN_finished;
2994e347d3e8Sdrh   }
2995bb53ecb1Sdrh 
2996e347d3e8Sdrh   /* Step 2: Check to see if the LHS contains any NULL columns.  If the
2997e347d3e8Sdrh   ** LHS does contain NULLs then the result must be either FALSE or NULL.
2998e347d3e8Sdrh   ** We will then skip the binary search of the RHS.
2999e347d3e8Sdrh   */
3000094430ebSdrh   if( destIfNull==destIfFalse ){
3001e347d3e8Sdrh     destStep2 = destIfFalse;
3002e347d3e8Sdrh   }else{
3003e347d3e8Sdrh     destStep2 = destStep6 = sqlite3VdbeMakeLabel(v);
3004e347d3e8Sdrh   }
3005d49fd4e8Sdan   for(i=0; i<nVector; i++){
3006fc7f27b9Sdrh     Expr *p = sqlite3VectorFieldSubexpr(pExpr->pLeft, i);
3007d49fd4e8Sdan     if( sqlite3ExprCanBeNull(p) ){
3008e347d3e8Sdrh       sqlite3VdbeAddOp2(v, OP_IsNull, rLhs+i, destStep2);
3009471b4b92Sdrh       VdbeCoverage(v);
3010d49fd4e8Sdan     }
3011d49fd4e8Sdan   }
3012e3365e6cSdrh 
3013e347d3e8Sdrh   /* Step 3.  The LHS is now known to be non-NULL.  Do the binary search
3014e347d3e8Sdrh   ** of the RHS using the LHS as a probe.  If found, the result is
3015e347d3e8Sdrh   ** true.
3016e347d3e8Sdrh   */
3017e3365e6cSdrh   if( eType==IN_INDEX_ROWID ){
3018e347d3e8Sdrh     /* In this case, the RHS is the ROWID of table b-tree and so we also
3019e347d3e8Sdrh     ** know that the RHS is non-NULL.  Hence, we combine steps 3 and 4
3020e347d3e8Sdrh     ** into a single opcode. */
3021e347d3e8Sdrh     sqlite3VdbeAddOp3(v, OP_SeekRowid, pExpr->iTable, destIfFalse, rLhs);
3022688852abSdrh     VdbeCoverage(v);
3023e347d3e8Sdrh     addrTruthOp = sqlite3VdbeAddOp0(v, OP_Goto);  /* Return True */
30247b35a77bSdan   }else{
3025e347d3e8Sdrh     sqlite3VdbeAddOp4(v, OP_Affinity, rLhs, nVector, 0, zAff, nVector);
3026e347d3e8Sdrh     if( destIfFalse==destIfNull ){
3027e347d3e8Sdrh       /* Combine Step 3 and Step 5 into a single opcode */
3028e347d3e8Sdrh       sqlite3VdbeAddOp4Int(v, OP_NotFound, pExpr->iTable, destIfFalse,
3029e347d3e8Sdrh                            rLhs, nVector); VdbeCoverage(v);
3030e347d3e8Sdrh       goto sqlite3ExprCodeIN_finished;
3031e347d3e8Sdrh     }
3032e347d3e8Sdrh     /* Ordinary Step 3, for the case where FALSE and NULL are distinct */
3033e347d3e8Sdrh     addrTruthOp = sqlite3VdbeAddOp4Int(v, OP_Found, pExpr->iTable, 0,
3034e347d3e8Sdrh                                       rLhs, nVector); VdbeCoverage(v);
3035e347d3e8Sdrh   }
3036ba00e30aSdan 
3037e347d3e8Sdrh   /* Step 4.  If the RHS is known to be non-NULL and we did not find
3038e347d3e8Sdrh   ** an match on the search above, then the result must be FALSE.
3039e347d3e8Sdrh   */
3040e347d3e8Sdrh   if( rRhsHasNull && nVector==1 ){
3041e347d3e8Sdrh     sqlite3VdbeAddOp2(v, OP_NotNull, rRhsHasNull, destIfFalse);
3042471b4b92Sdrh     VdbeCoverage(v);
3043e347d3e8Sdrh   }
30447b35a77bSdan 
3045e347d3e8Sdrh   /* Step 5.  If we do not care about the difference between NULL and
3046e347d3e8Sdrh   ** FALSE, then just return false.
3047e347d3e8Sdrh   */
3048e347d3e8Sdrh   if( destIfFalse==destIfNull ) sqlite3VdbeGoto(v, destIfFalse);
3049e347d3e8Sdrh 
3050e347d3e8Sdrh   /* Step 6: Loop through rows of the RHS.  Compare each row to the LHS.
3051e347d3e8Sdrh   ** If any comparison is NULL, then the result is NULL.  If all
3052e347d3e8Sdrh   ** comparisons are FALSE then the final result is FALSE.
3053e347d3e8Sdrh   **
3054e347d3e8Sdrh   ** For a scalar LHS, it is sufficient to check just the first row
3055e347d3e8Sdrh   ** of the RHS.
3056e347d3e8Sdrh   */
3057e347d3e8Sdrh   if( destStep6 ) sqlite3VdbeResolveLabel(v, destStep6);
3058e347d3e8Sdrh   addrTop = sqlite3VdbeAddOp2(v, OP_Rewind, pExpr->iTable, destIfFalse);
3059471b4b92Sdrh   VdbeCoverage(v);
3060e347d3e8Sdrh   if( nVector>1 ){
3061e347d3e8Sdrh     destNotNull = sqlite3VdbeMakeLabel(v);
3062e347d3e8Sdrh   }else{
3063e347d3e8Sdrh     /* For nVector==1, combine steps 6 and 7 by immediately returning
3064e347d3e8Sdrh     ** FALSE if the first comparison is not NULL */
3065e347d3e8Sdrh     destNotNull = destIfFalse;
3066e347d3e8Sdrh   }
3067ba00e30aSdan   for(i=0; i<nVector; i++){
3068ba00e30aSdan     Expr *p;
3069ba00e30aSdan     CollSeq *pColl;
3070e347d3e8Sdrh     int r3 = sqlite3GetTempReg(pParse);
3071fc7f27b9Sdrh     p = sqlite3VectorFieldSubexpr(pLeft, i);
3072ba00e30aSdan     pColl = sqlite3ExprCollSeq(pParse, p);
3073e347d3e8Sdrh     sqlite3VdbeAddOp3(v, OP_Column, pExpr->iTable, i, r3);
3074e347d3e8Sdrh     sqlite3VdbeAddOp4(v, OP_Ne, rLhs+i, destNotNull, r3,
307518016ad2Sdrh                       (void*)pColl, P4_COLLSEQ);
3076471b4b92Sdrh     VdbeCoverage(v);
3077e347d3e8Sdrh     sqlite3ReleaseTempReg(pParse, r3);
30787b35a77bSdan   }
30797b35a77bSdan   sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfNull);
3080e347d3e8Sdrh   if( nVector>1 ){
3081e347d3e8Sdrh     sqlite3VdbeResolveLabel(v, destNotNull);
3082e347d3e8Sdrh     sqlite3VdbeAddOp2(v, OP_Next, pExpr->iTable, addrTop+1);
308318016ad2Sdrh     VdbeCoverage(v);
3084e347d3e8Sdrh 
3085e347d3e8Sdrh     /* Step 7:  If we reach this point, we know that the result must
3086e347d3e8Sdrh     ** be false. */
308718016ad2Sdrh     sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfFalse);
30887b35a77bSdan   }
30897b35a77bSdan 
3090e347d3e8Sdrh   /* Jumps here in order to return true. */
3091e347d3e8Sdrh   sqlite3VdbeJumpHere(v, addrTruthOp);
3092e3365e6cSdrh 
3093e347d3e8Sdrh sqlite3ExprCodeIN_finished:
3094e347d3e8Sdrh   if( rLhs!=rLhsOrig ) sqlite3ReleaseTempReg(pParse, rLhs);
3095d2490904Sdrh   sqlite3ExprCachePop(pParse);
3096ecb87ac8Sdrh   VdbeComment((v, "end IN expr"));
3097e347d3e8Sdrh sqlite3ExprCodeIN_oom_error:
3098ba00e30aSdan   sqlite3DbFree(pParse->db, aiMap);
3099553168c7Sdan   sqlite3DbFree(pParse->db, zAff);
3100e3365e6cSdrh }
3101e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
3102e3365e6cSdrh 
310313573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
3104598f1340Sdrh /*
3105598f1340Sdrh ** Generate an instruction that will put the floating point
31069cbf3425Sdrh ** value described by z[0..n-1] into register iMem.
31070cf19ed8Sdrh **
31080cf19ed8Sdrh ** The z[] string will probably not be zero-terminated.  But the
31090cf19ed8Sdrh ** z[n] character is guaranteed to be something that does not look
31100cf19ed8Sdrh ** like the continuation of the number.
3111598f1340Sdrh */
3112b7916a78Sdrh static void codeReal(Vdbe *v, const char *z, int negateFlag, int iMem){
3113fd773cf9Sdrh   if( ALWAYS(z!=0) ){
3114598f1340Sdrh     double value;
31159339da1fSdrh     sqlite3AtoF(z, &value, sqlite3Strlen30(z), SQLITE_UTF8);
3116d0015161Sdrh     assert( !sqlite3IsNaN(value) ); /* The new AtoF never returns NaN */
3117598f1340Sdrh     if( negateFlag ) value = -value;
311897bae794Sdrh     sqlite3VdbeAddOp4Dup8(v, OP_Real, 0, iMem, 0, (u8*)&value, P4_REAL);
3119598f1340Sdrh   }
3120598f1340Sdrh }
312113573c71Sdrh #endif
3122598f1340Sdrh 
3123598f1340Sdrh 
3124598f1340Sdrh /*
3125fec19aadSdrh ** Generate an instruction that will put the integer describe by
31269cbf3425Sdrh ** text z[0..n-1] into register iMem.
31270cf19ed8Sdrh **
31285f1d6b61Sshaneh ** Expr.u.zToken is always UTF8 and zero-terminated.
3129fec19aadSdrh */
313013573c71Sdrh static void codeInteger(Parse *pParse, Expr *pExpr, int negFlag, int iMem){
313113573c71Sdrh   Vdbe *v = pParse->pVdbe;
313292b01d53Sdrh   if( pExpr->flags & EP_IntValue ){
313333e619fcSdrh     int i = pExpr->u.iValue;
3134d50ffc41Sdrh     assert( i>=0 );
313592b01d53Sdrh     if( negFlag ) i = -i;
313692b01d53Sdrh     sqlite3VdbeAddOp2(v, OP_Integer, i, iMem);
3137fd773cf9Sdrh   }else{
31385f1d6b61Sshaneh     int c;
31395f1d6b61Sshaneh     i64 value;
3140fd773cf9Sdrh     const char *z = pExpr->u.zToken;
3141fd773cf9Sdrh     assert( z!=0 );
31429296c18aSdrh     c = sqlite3DecOrHexToI64(z, &value);
314384d4f1a3Sdrh     if( (c==3 && !negFlag) || (c==2) || (negFlag && value==SMALLEST_INT64)){
314413573c71Sdrh #ifdef SQLITE_OMIT_FLOATING_POINT
314513573c71Sdrh       sqlite3ErrorMsg(pParse, "oversized integer: %s%s", negFlag ? "-" : "", z);
314613573c71Sdrh #else
31471b7ddc59Sdrh #ifndef SQLITE_OMIT_HEX_INTEGER
31489296c18aSdrh       if( sqlite3_strnicmp(z,"0x",2)==0 ){
314977320ea4Sdrh         sqlite3ErrorMsg(pParse, "hex literal too big: %s%s", negFlag?"-":"",z);
31501b7ddc59Sdrh       }else
31511b7ddc59Sdrh #endif
31521b7ddc59Sdrh       {
3153b7916a78Sdrh         codeReal(v, z, negFlag, iMem);
31549296c18aSdrh       }
315513573c71Sdrh #endif
315677320ea4Sdrh     }else{
315784d4f1a3Sdrh       if( negFlag ){ value = c==3 ? SMALLEST_INT64 : -value; }
315877320ea4Sdrh       sqlite3VdbeAddOp4Dup8(v, OP_Int64, 0, iMem, 0, (u8*)&value, P4_INT64);
3159fec19aadSdrh     }
3160fec19aadSdrh   }
3161c9cf901dSdanielk1977 }
3162fec19aadSdrh 
3163bea119cdSdrh /*
31649b40d13fSdrh ** Erase column-cache entry number i
3165bea119cdSdrh */
31669b40d13fSdrh static void cacheEntryClear(Parse *pParse, int i){
31679b40d13fSdrh   if( pParse->aColCache[i].tempReg ){
3168ceea3321Sdrh     if( pParse->nTempReg<ArraySize(pParse->aTempReg) ){
31699b40d13fSdrh       pParse->aTempReg[pParse->nTempReg++] = pParse->aColCache[i].iReg;
3170ceea3321Sdrh     }
3171ceea3321Sdrh   }
3172bea119cdSdrh   pParse->nColCache--;
31739b40d13fSdrh   if( i<pParse->nColCache ){
31749b40d13fSdrh     pParse->aColCache[i] = pParse->aColCache[pParse->nColCache];
31759b40d13fSdrh   }
3176ceea3321Sdrh }
3177ceea3321Sdrh 
3178ceea3321Sdrh 
3179ceea3321Sdrh /*
3180ceea3321Sdrh ** Record in the column cache that a particular column from a
3181ceea3321Sdrh ** particular table is stored in a particular register.
3182ceea3321Sdrh */
3183ceea3321Sdrh void sqlite3ExprCacheStore(Parse *pParse, int iTab, int iCol, int iReg){
3184ceea3321Sdrh   int i;
3185ceea3321Sdrh   int minLru;
3186ceea3321Sdrh   int idxLru;
3187ceea3321Sdrh   struct yColCache *p;
3188ceea3321Sdrh 
3189ce8f53d4Sdan   /* Unless an error has occurred, register numbers are always positive. */
3190ce8f53d4Sdan   assert( iReg>0 || pParse->nErr || pParse->db->mallocFailed );
319120411ea7Sdrh   assert( iCol>=-1 && iCol<32768 );  /* Finite column numbers */
319220411ea7Sdrh 
3193b6da74ebSdrh   /* The SQLITE_ColumnCache flag disables the column cache.  This is used
3194b6da74ebSdrh   ** for testing only - to verify that SQLite always gets the same answer
3195b6da74ebSdrh   ** with and without the column cache.
3196b6da74ebSdrh   */
31977e5418e4Sdrh   if( OptimizationDisabled(pParse->db, SQLITE_ColumnCache) ) return;
3198b6da74ebSdrh 
319927ee406eSdrh   /* First replace any existing entry.
320027ee406eSdrh   **
320127ee406eSdrh   ** Actually, the way the column cache is currently used, we are guaranteed
320227ee406eSdrh   ** that the object will never already be in cache.  Verify this guarantee.
320327ee406eSdrh   */
320427ee406eSdrh #ifndef NDEBUG
32059b40d13fSdrh   for(i=0, p=pParse->aColCache; i<pParse->nColCache; i++, p++){
32069b40d13fSdrh     assert( p->iTable!=iTab || p->iColumn!=iCol );
3207ceea3321Sdrh   }
320827ee406eSdrh #endif
3209ceea3321Sdrh 
32109b40d13fSdrh   /* If the cache is already full, delete the least recently used entry */
32119b40d13fSdrh   if( pParse->nColCache>=SQLITE_N_COLCACHE ){
3212ceea3321Sdrh     minLru = 0x7fffffff;
3213ceea3321Sdrh     idxLru = -1;
3214ceea3321Sdrh     for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
3215ceea3321Sdrh       if( p->lru<minLru ){
3216ceea3321Sdrh         idxLru = i;
3217ceea3321Sdrh         minLru = p->lru;
3218ceea3321Sdrh       }
3219ceea3321Sdrh     }
3220ceea3321Sdrh     p = &pParse->aColCache[idxLru];
32219b40d13fSdrh   }else{
32229b40d13fSdrh     p = &pParse->aColCache[pParse->nColCache++];
32239b40d13fSdrh   }
32249b40d13fSdrh 
32259b40d13fSdrh   /* Add the new entry to the end of the cache */
3226ceea3321Sdrh   p->iLevel = pParse->iCacheLevel;
3227ceea3321Sdrh   p->iTable = iTab;
3228ceea3321Sdrh   p->iColumn = iCol;
3229ceea3321Sdrh   p->iReg = iReg;
3230ceea3321Sdrh   p->tempReg = 0;
3231ceea3321Sdrh   p->lru = pParse->iCacheCnt++;
3232ceea3321Sdrh }
3233ceea3321Sdrh 
3234ceea3321Sdrh /*
3235f49f3523Sdrh ** Indicate that registers between iReg..iReg+nReg-1 are being overwritten.
3236f49f3523Sdrh ** Purge the range of registers from the column cache.
3237ceea3321Sdrh */
3238f49f3523Sdrh void sqlite3ExprCacheRemove(Parse *pParse, int iReg, int nReg){
32399b40d13fSdrh   int i = 0;
32409b40d13fSdrh   while( i<pParse->nColCache ){
32419b40d13fSdrh     struct yColCache *p = &pParse->aColCache[i];
32429b40d13fSdrh     if( p->iReg >= iReg && p->iReg < iReg+nReg ){
32439b40d13fSdrh       cacheEntryClear(pParse, i);
32449b40d13fSdrh     }else{
32459b40d13fSdrh       i++;
32469b40d13fSdrh     }
3247ceea3321Sdrh   }
3248ceea3321Sdrh }
3249ceea3321Sdrh 
3250ceea3321Sdrh /*
3251ceea3321Sdrh ** Remember the current column cache context.  Any new entries added
3252ceea3321Sdrh ** added to the column cache after this call are removed when the
3253ceea3321Sdrh ** corresponding pop occurs.
3254ceea3321Sdrh */
3255ceea3321Sdrh void sqlite3ExprCachePush(Parse *pParse){
3256ceea3321Sdrh   pParse->iCacheLevel++;
32579ac7962aSdrh #ifdef SQLITE_DEBUG
32589ac7962aSdrh   if( pParse->db->flags & SQLITE_VdbeAddopTrace ){
32599ac7962aSdrh     printf("PUSH to %d\n", pParse->iCacheLevel);
32609ac7962aSdrh   }
32619ac7962aSdrh #endif
3262ceea3321Sdrh }
3263ceea3321Sdrh 
3264ceea3321Sdrh /*
3265ceea3321Sdrh ** Remove from the column cache any entries that were added since the
3266d2490904Sdrh ** the previous sqlite3ExprCachePush operation.  In other words, restore
3267d2490904Sdrh ** the cache to the state it was in prior the most recent Push.
3268ceea3321Sdrh */
3269d2490904Sdrh void sqlite3ExprCachePop(Parse *pParse){
32709b40d13fSdrh   int i = 0;
3271d2490904Sdrh   assert( pParse->iCacheLevel>=1 );
3272d2490904Sdrh   pParse->iCacheLevel--;
32739ac7962aSdrh #ifdef SQLITE_DEBUG
32749ac7962aSdrh   if( pParse->db->flags & SQLITE_VdbeAddopTrace ){
32759ac7962aSdrh     printf("POP  to %d\n", pParse->iCacheLevel);
32769ac7962aSdrh   }
32779ac7962aSdrh #endif
32789b40d13fSdrh   while( i<pParse->nColCache ){
32799b40d13fSdrh     if( pParse->aColCache[i].iLevel>pParse->iCacheLevel ){
32809b40d13fSdrh       cacheEntryClear(pParse, i);
32819b40d13fSdrh     }else{
32829b40d13fSdrh       i++;
3283ceea3321Sdrh     }
3284ceea3321Sdrh   }
3285ceea3321Sdrh }
3286945498f3Sdrh 
3287945498f3Sdrh /*
32885cd79239Sdrh ** When a cached column is reused, make sure that its register is
32895cd79239Sdrh ** no longer available as a temp register.  ticket #3879:  that same
32905cd79239Sdrh ** register might be in the cache in multiple places, so be sure to
32915cd79239Sdrh ** get them all.
32925cd79239Sdrh */
32935cd79239Sdrh static void sqlite3ExprCachePinRegister(Parse *pParse, int iReg){
32945cd79239Sdrh   int i;
32955cd79239Sdrh   struct yColCache *p;
32969b40d13fSdrh   for(i=0, p=pParse->aColCache; i<pParse->nColCache; i++, p++){
32975cd79239Sdrh     if( p->iReg==iReg ){
32985cd79239Sdrh       p->tempReg = 0;
32995cd79239Sdrh     }
33005cd79239Sdrh   }
33015cd79239Sdrh }
33025cd79239Sdrh 
33031f9ca2c8Sdrh /* Generate code that will load into register regOut a value that is
33041f9ca2c8Sdrh ** appropriate for the iIdxCol-th column of index pIdx.
33051f9ca2c8Sdrh */
33061f9ca2c8Sdrh void sqlite3ExprCodeLoadIndexColumn(
33071f9ca2c8Sdrh   Parse *pParse,  /* The parsing context */
33081f9ca2c8Sdrh   Index *pIdx,    /* The index whose column is to be loaded */
33091f9ca2c8Sdrh   int iTabCur,    /* Cursor pointing to a table row */
33101f9ca2c8Sdrh   int iIdxCol,    /* The column of the index to be loaded */
33111f9ca2c8Sdrh   int regOut      /* Store the index column value in this register */
33121f9ca2c8Sdrh ){
33131f9ca2c8Sdrh   i16 iTabCol = pIdx->aiColumn[iIdxCol];
33144b92f98cSdrh   if( iTabCol==XN_EXPR ){
33151f9ca2c8Sdrh     assert( pIdx->aColExpr );
33161f9ca2c8Sdrh     assert( pIdx->aColExpr->nExpr>iIdxCol );
33173e34eabcSdrh     pParse->iSelfTab = iTabCur + 1;
33181c75c9d7Sdrh     sqlite3ExprCodeCopy(pParse, pIdx->aColExpr->a[iIdxCol].pExpr, regOut);
33193e34eabcSdrh     pParse->iSelfTab = 0;
33204b92f98cSdrh   }else{
33214b92f98cSdrh     sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pIdx->pTable, iTabCur,
33224b92f98cSdrh                                     iTabCol, regOut);
33234b92f98cSdrh   }
33241f9ca2c8Sdrh }
33251f9ca2c8Sdrh 
33265cd79239Sdrh /*
33275c092e8aSdrh ** Generate code to extract the value of the iCol-th column of a table.
33285c092e8aSdrh */
33295c092e8aSdrh void sqlite3ExprCodeGetColumnOfTable(
33305c092e8aSdrh   Vdbe *v,        /* The VDBE under construction */
33315c092e8aSdrh   Table *pTab,    /* The table containing the value */
3332313619f5Sdrh   int iTabCur,    /* The table cursor.  Or the PK cursor for WITHOUT ROWID */
33335c092e8aSdrh   int iCol,       /* Index of the column to extract */
3334313619f5Sdrh   int regOut      /* Extract the value into this register */
33355c092e8aSdrh ){
3336aca19e19Sdrh   if( pTab==0 ){
3337aca19e19Sdrh     sqlite3VdbeAddOp3(v, OP_Column, iTabCur, iCol, regOut);
3338aca19e19Sdrh     return;
3339aca19e19Sdrh   }
33405c092e8aSdrh   if( iCol<0 || iCol==pTab->iPKey ){
33415c092e8aSdrh     sqlite3VdbeAddOp2(v, OP_Rowid, iTabCur, regOut);
33425c092e8aSdrh   }else{
33435c092e8aSdrh     int op = IsVirtual(pTab) ? OP_VColumn : OP_Column;
3344ee0ec8e1Sdrh     int x = iCol;
334535db31b2Sdrh     if( !HasRowid(pTab) && !IsVirtual(pTab) ){
3346ee0ec8e1Sdrh       x = sqlite3ColumnOfIndex(sqlite3PrimaryKeyIndex(pTab), iCol);
3347ee0ec8e1Sdrh     }
3348ee0ec8e1Sdrh     sqlite3VdbeAddOp3(v, op, iTabCur, x, regOut);
33495c092e8aSdrh   }
33505c092e8aSdrh   if( iCol>=0 ){
33515c092e8aSdrh     sqlite3ColumnDefault(v, pTab, iCol, regOut);
33525c092e8aSdrh   }
33535c092e8aSdrh }
33545c092e8aSdrh 
33555c092e8aSdrh /*
3356945498f3Sdrh ** Generate code that will extract the iColumn-th column from
3357ce78bc6eSdrh ** table pTab and store the column value in a register.
3358ce78bc6eSdrh **
3359ce78bc6eSdrh ** An effort is made to store the column value in register iReg.  This
3360ce78bc6eSdrh ** is not garanteeed for GetColumn() - the result can be stored in
3361ce78bc6eSdrh ** any register.  But the result is guaranteed to land in register iReg
3362ce78bc6eSdrh ** for GetColumnToReg().
3363e55cbd72Sdrh **
3364e55cbd72Sdrh ** There must be an open cursor to pTab in iTable when this routine
3365e55cbd72Sdrh ** is called.  If iColumn<0 then code is generated that extracts the rowid.
3366945498f3Sdrh */
3367e55cbd72Sdrh int sqlite3ExprCodeGetColumn(
3368e55cbd72Sdrh   Parse *pParse,   /* Parsing and code generating context */
33692133d822Sdrh   Table *pTab,     /* Description of the table we are reading from */
33702133d822Sdrh   int iColumn,     /* Index of the table column */
33712133d822Sdrh   int iTable,      /* The cursor pointing to the table */
3372a748fdccSdrh   int iReg,        /* Store results here */
3373ce78bc6eSdrh   u8 p5            /* P5 value for OP_Column + FLAGS */
33742133d822Sdrh ){
3375e55cbd72Sdrh   Vdbe *v = pParse->pVdbe;
3376e55cbd72Sdrh   int i;
3377da250ea5Sdrh   struct yColCache *p;
3378e55cbd72Sdrh 
33799b40d13fSdrh   for(i=0, p=pParse->aColCache; i<pParse->nColCache; i++, p++){
338094881d73Sdrh     if( p->iTable==iTable && p->iColumn==iColumn ){
3381ceea3321Sdrh       p->lru = pParse->iCacheCnt++;
33825cd79239Sdrh       sqlite3ExprCachePinRegister(pParse, p->iReg);
3383da250ea5Sdrh       return p->iReg;
3384e55cbd72Sdrh     }
3385e55cbd72Sdrh   }
3386e55cbd72Sdrh   assert( v!=0 );
33875c092e8aSdrh   sqlite3ExprCodeGetColumnOfTable(v, pTab, iTable, iColumn, iReg);
3388a748fdccSdrh   if( p5 ){
3389a748fdccSdrh     sqlite3VdbeChangeP5(v, p5);
3390a748fdccSdrh   }else{
3391ceea3321Sdrh     sqlite3ExprCacheStore(pParse, iTable, iColumn, iReg);
3392a748fdccSdrh   }
3393e55cbd72Sdrh   return iReg;
3394e55cbd72Sdrh }
3395ce78bc6eSdrh void sqlite3ExprCodeGetColumnToReg(
3396ce78bc6eSdrh   Parse *pParse,   /* Parsing and code generating context */
3397ce78bc6eSdrh   Table *pTab,     /* Description of the table we are reading from */
3398ce78bc6eSdrh   int iColumn,     /* Index of the table column */
3399ce78bc6eSdrh   int iTable,      /* The cursor pointing to the table */
3400ce78bc6eSdrh   int iReg         /* Store results here */
3401ce78bc6eSdrh ){
3402ce78bc6eSdrh   int r1 = sqlite3ExprCodeGetColumn(pParse, pTab, iColumn, iTable, iReg, 0);
3403ce78bc6eSdrh   if( r1!=iReg ) sqlite3VdbeAddOp2(pParse->pVdbe, OP_SCopy, r1, iReg);
3404ce78bc6eSdrh }
3405ce78bc6eSdrh 
3406e55cbd72Sdrh 
3407e55cbd72Sdrh /*
3408ceea3321Sdrh ** Clear all column cache entries.
3409e55cbd72Sdrh */
3410ceea3321Sdrh void sqlite3ExprCacheClear(Parse *pParse){
3411e55cbd72Sdrh   int i;
3412ceea3321Sdrh 
3413d879e3ebSdrh #ifdef SQLITE_DEBUG
34149ac7962aSdrh   if( pParse->db->flags & SQLITE_VdbeAddopTrace ){
34159ac7962aSdrh     printf("CLEAR\n");
34169ac7962aSdrh   }
34179ac7962aSdrh #endif
34189b40d13fSdrh   for(i=0; i<pParse->nColCache; i++){
34199b40d13fSdrh     if( pParse->aColCache[i].tempReg
34209b40d13fSdrh      && pParse->nTempReg<ArraySize(pParse->aTempReg)
34219b40d13fSdrh     ){
34229b40d13fSdrh        pParse->aTempReg[pParse->nTempReg++] = pParse->aColCache[i].iReg;
3423e55cbd72Sdrh     }
3424da250ea5Sdrh   }
34259b40d13fSdrh   pParse->nColCache = 0;
3426da250ea5Sdrh }
3427e55cbd72Sdrh 
3428e55cbd72Sdrh /*
3429da250ea5Sdrh ** Record the fact that an affinity change has occurred on iCount
3430da250ea5Sdrh ** registers starting with iStart.
3431e55cbd72Sdrh */
3432da250ea5Sdrh void sqlite3ExprCacheAffinityChange(Parse *pParse, int iStart, int iCount){
3433f49f3523Sdrh   sqlite3ExprCacheRemove(pParse, iStart, iCount);
3434e55cbd72Sdrh }
3435e55cbd72Sdrh 
3436e55cbd72Sdrh /*
3437b21e7c70Sdrh ** Generate code to move content from registers iFrom...iFrom+nReg-1
3438b21e7c70Sdrh ** over to iTo..iTo+nReg-1. Keep the column cache up-to-date.
3439e55cbd72Sdrh */
3440b21e7c70Sdrh void sqlite3ExprCodeMove(Parse *pParse, int iFrom, int iTo, int nReg){
3441e8e4af76Sdrh   assert( iFrom>=iTo+nReg || iFrom+nReg<=iTo );
3442079a3072Sdrh   sqlite3VdbeAddOp3(pParse->pVdbe, OP_Move, iFrom, iTo, nReg);
3443236241aeSdrh   sqlite3ExprCacheRemove(pParse, iFrom, nReg);
3444945498f3Sdrh }
3445945498f3Sdrh 
3446f49f3523Sdrh #if defined(SQLITE_DEBUG) || defined(SQLITE_COVERAGE_TEST)
344792b01d53Sdrh /*
3448652fbf55Sdrh ** Return true if any register in the range iFrom..iTo (inclusive)
3449652fbf55Sdrh ** is used as part of the column cache.
3450f49f3523Sdrh **
3451f49f3523Sdrh ** This routine is used within assert() and testcase() macros only
3452f49f3523Sdrh ** and does not appear in a normal build.
3453652fbf55Sdrh */
3454652fbf55Sdrh static int usedAsColumnCache(Parse *pParse, int iFrom, int iTo){
3455652fbf55Sdrh   int i;
3456ceea3321Sdrh   struct yColCache *p;
34579b40d13fSdrh   for(i=0, p=pParse->aColCache; i<pParse->nColCache; i++, p++){
3458ceea3321Sdrh     int r = p->iReg;
3459f49f3523Sdrh     if( r>=iFrom && r<=iTo ) return 1;    /*NO_TEST*/
3460652fbf55Sdrh   }
3461652fbf55Sdrh   return 0;
3462652fbf55Sdrh }
3463f49f3523Sdrh #endif /* SQLITE_DEBUG || SQLITE_COVERAGE_TEST */
3464652fbf55Sdrh 
3465bea119cdSdrh 
3466652fbf55Sdrh /*
346712abf408Sdrh ** Convert a scalar expression node to a TK_REGISTER referencing
346812abf408Sdrh ** register iReg.  The caller must ensure that iReg already contains
346912abf408Sdrh ** the correct value for the expression.
3470a4c3c87eSdrh */
3471a4c3c87eSdrh static void exprToRegister(Expr *p, int iReg){
3472a4c3c87eSdrh   p->op2 = p->op;
3473a4c3c87eSdrh   p->op = TK_REGISTER;
3474a4c3c87eSdrh   p->iTable = iReg;
3475a4c3c87eSdrh   ExprClearProperty(p, EP_Skip);
3476a4c3c87eSdrh }
3477a4c3c87eSdrh 
347812abf408Sdrh /*
347912abf408Sdrh ** Evaluate an expression (either a vector or a scalar expression) and store
348012abf408Sdrh ** the result in continguous temporary registers.  Return the index of
348112abf408Sdrh ** the first register used to store the result.
348212abf408Sdrh **
348312abf408Sdrh ** If the returned result register is a temporary scalar, then also write
348412abf408Sdrh ** that register number into *piFreeable.  If the returned result register
348512abf408Sdrh ** is not a temporary or if the expression is a vector set *piFreeable
348612abf408Sdrh ** to 0.
348712abf408Sdrh */
348812abf408Sdrh static int exprCodeVector(Parse *pParse, Expr *p, int *piFreeable){
348912abf408Sdrh   int iResult;
349012abf408Sdrh   int nResult = sqlite3ExprVectorSize(p);
349112abf408Sdrh   if( nResult==1 ){
349212abf408Sdrh     iResult = sqlite3ExprCodeTemp(pParse, p, piFreeable);
349312abf408Sdrh   }else{
349412abf408Sdrh     *piFreeable = 0;
349512abf408Sdrh     if( p->op==TK_SELECT ){
3496dd1bb43aSdrh #if SQLITE_OMIT_SUBQUERY
3497dd1bb43aSdrh       iResult = 0;
3498dd1bb43aSdrh #else
349912abf408Sdrh       iResult = sqlite3CodeSubselect(pParse, p, 0, 0);
3500dd1bb43aSdrh #endif
350112abf408Sdrh     }else{
350212abf408Sdrh       int i;
350312abf408Sdrh       iResult = pParse->nMem+1;
350412abf408Sdrh       pParse->nMem += nResult;
350512abf408Sdrh       for(i=0; i<nResult; i++){
35064b725240Sdan         sqlite3ExprCodeFactorable(pParse, p->x.pList->a[i].pExpr, i+iResult);
350712abf408Sdrh       }
350812abf408Sdrh     }
350912abf408Sdrh   }
351012abf408Sdrh   return iResult;
351112abf408Sdrh }
351212abf408Sdrh 
351371c57db0Sdan 
3514a4c3c87eSdrh /*
3515cce7d176Sdrh ** Generate code into the current Vdbe to evaluate the given
35162dcef11bSdrh ** expression.  Attempt to store the results in register "target".
35172dcef11bSdrh ** Return the register where results are stored.
3518389a1adbSdrh **
35198b213899Sdrh ** With this routine, there is no guarantee that results will
35202dcef11bSdrh ** be stored in target.  The result might be stored in some other
35212dcef11bSdrh ** register if it is convenient to do so.  The calling function
35222dcef11bSdrh ** must check the return code and move the results to the desired
35232dcef11bSdrh ** register.
3524cce7d176Sdrh */
3525678ccce8Sdrh int sqlite3ExprCodeTarget(Parse *pParse, Expr *pExpr, int target){
35262dcef11bSdrh   Vdbe *v = pParse->pVdbe;  /* The VM under construction */
35272dcef11bSdrh   int op;                   /* The opcode being coded */
35282dcef11bSdrh   int inReg = target;       /* Results stored in register inReg */
35292dcef11bSdrh   int regFree1 = 0;         /* If non-zero free this temporary register */
35302dcef11bSdrh   int regFree2 = 0;         /* If non-zero free this temporary register */
35317b35a77bSdan   int r1, r2;               /* Various register numbers */
353210d1edf0Sdrh   Expr tempX;               /* Temporary expression node */
353371c57db0Sdan   int p5 = 0;
3534ffe07b2dSdrh 
35359cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
353620411ea7Sdrh   if( v==0 ){
353720411ea7Sdrh     assert( pParse->db->mallocFailed );
353820411ea7Sdrh     return 0;
353920411ea7Sdrh   }
3540389a1adbSdrh 
3541389a1adbSdrh   if( pExpr==0 ){
3542389a1adbSdrh     op = TK_NULL;
3543389a1adbSdrh   }else{
3544f2bc013cSdrh     op = pExpr->op;
3545389a1adbSdrh   }
3546f2bc013cSdrh   switch( op ){
354713449892Sdrh     case TK_AGG_COLUMN: {
354813449892Sdrh       AggInfo *pAggInfo = pExpr->pAggInfo;
354913449892Sdrh       struct AggInfo_col *pCol = &pAggInfo->aCol[pExpr->iAgg];
355013449892Sdrh       if( !pAggInfo->directMode ){
35519de221dfSdrh         assert( pCol->iMem>0 );
3552c332cc30Sdrh         return pCol->iMem;
355313449892Sdrh       }else if( pAggInfo->useSortingIdx ){
35545134d135Sdan         sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdxPTab,
3555389a1adbSdrh                               pCol->iSorterColumn, target);
3556c332cc30Sdrh         return target;
355713449892Sdrh       }
355813449892Sdrh       /* Otherwise, fall thru into the TK_COLUMN case */
355913449892Sdrh     }
3560967e8b73Sdrh     case TK_COLUMN: {
3561b2b9d3d7Sdrh       int iTab = pExpr->iTable;
3562b2b9d3d7Sdrh       if( iTab<0 ){
35636e97f8ecSdrh         if( pParse->iSelfTab<0 ){
3564b2b9d3d7Sdrh           /* Generating CHECK constraints or inserting into partial index */
35656e97f8ecSdrh           return pExpr->iColumn - pParse->iSelfTab;
3566c4a3c779Sdrh         }else{
35671f9ca2c8Sdrh           /* Coding an expression that is part of an index where column names
35681f9ca2c8Sdrh           ** in the index refer to the table to which the index belongs */
35693e34eabcSdrh           iTab = pParse->iSelfTab - 1;
35702282792aSdrh         }
3571b2b9d3d7Sdrh       }
3572c332cc30Sdrh       return sqlite3ExprCodeGetColumn(pParse, pExpr->pTab,
3573b2b9d3d7Sdrh                                pExpr->iColumn, iTab, target,
3574b2b9d3d7Sdrh                                pExpr->op2);
3575cce7d176Sdrh     }
3576cce7d176Sdrh     case TK_INTEGER: {
357713573c71Sdrh       codeInteger(pParse, pExpr, 0, target);
3578c332cc30Sdrh       return target;
357951e9a445Sdrh     }
35808abed7b9Sdrh     case TK_TRUEFALSE: {
358196acafbeSdrh       sqlite3VdbeAddOp2(v, OP_Integer, sqlite3ExprTruthValue(pExpr), target);
3582007c843bSdrh       return target;
3583007c843bSdrh     }
358413573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
3585598f1340Sdrh     case TK_FLOAT: {
358633e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
358733e619fcSdrh       codeReal(v, pExpr->u.zToken, 0, target);
3588c332cc30Sdrh       return target;
3589598f1340Sdrh     }
359013573c71Sdrh #endif
3591fec19aadSdrh     case TK_STRING: {
359233e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
3593076e85f5Sdrh       sqlite3VdbeLoadString(v, target, pExpr->u.zToken);
3594c332cc30Sdrh       return target;
3595cce7d176Sdrh     }
3596f0863fe5Sdrh     case TK_NULL: {
35979de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3598c332cc30Sdrh       return target;
3599f0863fe5Sdrh     }
36005338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_BLOB_LITERAL
3601c572ef7fSdanielk1977     case TK_BLOB: {
36026c8c6cecSdrh       int n;
36036c8c6cecSdrh       const char *z;
3604ca48c90fSdrh       char *zBlob;
360533e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
360633e619fcSdrh       assert( pExpr->u.zToken[0]=='x' || pExpr->u.zToken[0]=='X' );
360733e619fcSdrh       assert( pExpr->u.zToken[1]=='\'' );
360833e619fcSdrh       z = &pExpr->u.zToken[2];
3609b7916a78Sdrh       n = sqlite3Strlen30(z) - 1;
3610b7916a78Sdrh       assert( z[n]=='\'' );
3611ca48c90fSdrh       zBlob = sqlite3HexToBlob(sqlite3VdbeDb(v), z, n);
3612ca48c90fSdrh       sqlite3VdbeAddOp4(v, OP_Blob, n/2, target, 0, zBlob, P4_DYNAMIC);
3613c332cc30Sdrh       return target;
3614c572ef7fSdanielk1977     }
36155338a5f7Sdanielk1977 #endif
361650457896Sdrh     case TK_VARIABLE: {
361733e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
361833e619fcSdrh       assert( pExpr->u.zToken!=0 );
361933e619fcSdrh       assert( pExpr->u.zToken[0]!=0 );
3620eaf52d88Sdrh       sqlite3VdbeAddOp2(v, OP_Variable, pExpr->iColumn, target);
362133e619fcSdrh       if( pExpr->u.zToken[1]!=0 ){
36229bf755ccSdrh         const char *z = sqlite3VListNumToName(pParse->pVList, pExpr->iColumn);
36239bf755ccSdrh         assert( pExpr->u.zToken[0]=='?' || strcmp(pExpr->u.zToken, z)==0 );
3624ce1bbe51Sdrh         pParse->pVList[0] = 0; /* Indicate VList may no longer be enlarged */
36259bf755ccSdrh         sqlite3VdbeAppendP4(v, (char*)z, P4_STATIC);
36269bf755ccSdrh       }
3627c332cc30Sdrh       return target;
362850457896Sdrh     }
36294e0cff60Sdrh     case TK_REGISTER: {
3630c332cc30Sdrh       return pExpr->iTable;
36314e0cff60Sdrh     }
3632487e262fSdrh #ifndef SQLITE_OMIT_CAST
3633487e262fSdrh     case TK_CAST: {
3634487e262fSdrh       /* Expressions of the form:   CAST(pLeft AS token) */
36352dcef11bSdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
36361735fa88Sdrh       if( inReg!=target ){
36371735fa88Sdrh         sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
36381735fa88Sdrh         inReg = target;
36391735fa88Sdrh       }
36404169e430Sdrh       sqlite3VdbeAddOp2(v, OP_Cast, target,
36414169e430Sdrh                         sqlite3AffinityType(pExpr->u.zToken, 0));
3642c5499befSdrh       testcase( usedAsColumnCache(pParse, inReg, inReg) );
3643b3843a82Sdrh       sqlite3ExprCacheAffinityChange(pParse, inReg, 1);
3644c332cc30Sdrh       return inReg;
3645487e262fSdrh     }
3646487e262fSdrh #endif /* SQLITE_OMIT_CAST */
364771c57db0Sdan     case TK_IS:
364871c57db0Sdan     case TK_ISNOT:
364971c57db0Sdan       op = (op==TK_IS) ? TK_EQ : TK_NE;
365071c57db0Sdan       p5 = SQLITE_NULLEQ;
365171c57db0Sdan       /* fall-through */
3652c9b84a1fSdrh     case TK_LT:
3653c9b84a1fSdrh     case TK_LE:
3654c9b84a1fSdrh     case TK_GT:
3655c9b84a1fSdrh     case TK_GE:
3656c9b84a1fSdrh     case TK_NE:
3657c9b84a1fSdrh     case TK_EQ: {
365871c57db0Sdan       Expr *pLeft = pExpr->pLeft;
3659625015e0Sdan       if( sqlite3ExprIsVector(pLeft) ){
366079752b6eSdrh         codeVectorCompare(pParse, pExpr, target, op, p5);
366171c57db0Sdan       }else{
366271c57db0Sdan         r1 = sqlite3ExprCodeTemp(pParse, pLeft, &regFree1);
3663b6da74ebSdrh         r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
366471c57db0Sdan         codeCompare(pParse, pLeft, pExpr->pRight, op,
366571c57db0Sdan             r1, r2, inReg, SQLITE_STOREP2 | p5);
36667d176105Sdrh         assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
36677d176105Sdrh         assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
36687d176105Sdrh         assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
36697d176105Sdrh         assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
36707d176105Sdrh         assert(TK_EQ==OP_Eq); testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
36717d176105Sdrh         assert(TK_NE==OP_Ne); testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
3672c5499befSdrh         testcase( regFree1==0 );
3673c5499befSdrh         testcase( regFree2==0 );
3674c9b84a1fSdrh       }
36756a2fe093Sdrh       break;
36766a2fe093Sdrh     }
3677cce7d176Sdrh     case TK_AND:
3678cce7d176Sdrh     case TK_OR:
3679cce7d176Sdrh     case TK_PLUS:
3680cce7d176Sdrh     case TK_STAR:
3681cce7d176Sdrh     case TK_MINUS:
3682bf4133cbSdrh     case TK_REM:
3683bf4133cbSdrh     case TK_BITAND:
3684bf4133cbSdrh     case TK_BITOR:
368517c40294Sdrh     case TK_SLASH:
3686bf4133cbSdrh     case TK_LSHIFT:
3687855eb1cfSdrh     case TK_RSHIFT:
36880040077dSdrh     case TK_CONCAT: {
36897d176105Sdrh       assert( TK_AND==OP_And );            testcase( op==TK_AND );
36907d176105Sdrh       assert( TK_OR==OP_Or );              testcase( op==TK_OR );
36917d176105Sdrh       assert( TK_PLUS==OP_Add );           testcase( op==TK_PLUS );
36927d176105Sdrh       assert( TK_MINUS==OP_Subtract );     testcase( op==TK_MINUS );
36937d176105Sdrh       assert( TK_REM==OP_Remainder );      testcase( op==TK_REM );
36947d176105Sdrh       assert( TK_BITAND==OP_BitAnd );      testcase( op==TK_BITAND );
36957d176105Sdrh       assert( TK_BITOR==OP_BitOr );        testcase( op==TK_BITOR );
36967d176105Sdrh       assert( TK_SLASH==OP_Divide );       testcase( op==TK_SLASH );
36977d176105Sdrh       assert( TK_LSHIFT==OP_ShiftLeft );   testcase( op==TK_LSHIFT );
36987d176105Sdrh       assert( TK_RSHIFT==OP_ShiftRight );  testcase( op==TK_RSHIFT );
36997d176105Sdrh       assert( TK_CONCAT==OP_Concat );      testcase( op==TK_CONCAT );
37002dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
37012dcef11bSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
37025b6afba9Sdrh       sqlite3VdbeAddOp3(v, op, r2, r1, target);
3703c5499befSdrh       testcase( regFree1==0 );
3704c5499befSdrh       testcase( regFree2==0 );
37050040077dSdrh       break;
37060040077dSdrh     }
3707cce7d176Sdrh     case TK_UMINUS: {
3708fec19aadSdrh       Expr *pLeft = pExpr->pLeft;
3709fec19aadSdrh       assert( pLeft );
371013573c71Sdrh       if( pLeft->op==TK_INTEGER ){
371113573c71Sdrh         codeInteger(pParse, pLeft, 1, target);
3712c332cc30Sdrh         return target;
371313573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
371413573c71Sdrh       }else if( pLeft->op==TK_FLOAT ){
371533e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
371633e619fcSdrh         codeReal(v, pLeft->u.zToken, 1, target);
3717c332cc30Sdrh         return target;
371813573c71Sdrh #endif
37193c84ddffSdrh       }else{
372010d1edf0Sdrh         tempX.op = TK_INTEGER;
372110d1edf0Sdrh         tempX.flags = EP_IntValue|EP_TokenOnly;
372210d1edf0Sdrh         tempX.u.iValue = 0;
372310d1edf0Sdrh         r1 = sqlite3ExprCodeTemp(pParse, &tempX, &regFree1);
3724e55cbd72Sdrh         r2 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree2);
37252dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_Subtract, r2, r1, target);
3726c5499befSdrh         testcase( regFree2==0 );
37273c84ddffSdrh       }
37286e142f54Sdrh       break;
37296e142f54Sdrh     }
3730bf4133cbSdrh     case TK_BITNOT:
37316e142f54Sdrh     case TK_NOT: {
37327d176105Sdrh       assert( TK_BITNOT==OP_BitNot );   testcase( op==TK_BITNOT );
37337d176105Sdrh       assert( TK_NOT==OP_Not );         testcase( op==TK_NOT );
3734e99fa2afSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3735e99fa2afSdrh       testcase( regFree1==0 );
3736e99fa2afSdrh       sqlite3VdbeAddOp2(v, op, r1, inReg);
3737cce7d176Sdrh       break;
3738cce7d176Sdrh     }
37398abed7b9Sdrh     case TK_TRUTH: {
374096acafbeSdrh       int isTrue;    /* IS TRUE or IS NOT TRUE */
374196acafbeSdrh       int bNormal;   /* IS TRUE or IS FALSE */
3742007c843bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3743007c843bSdrh       testcase( regFree1==0 );
374496acafbeSdrh       isTrue = sqlite3ExprTruthValue(pExpr->pRight);
374596acafbeSdrh       bNormal = pExpr->op2==TK_IS;
374696acafbeSdrh       testcase( isTrue && bNormal);
374796acafbeSdrh       testcase( !isTrue && bNormal);
374896acafbeSdrh       sqlite3VdbeAddOp4Int(v, OP_IsTrue, r1, inReg, !isTrue, isTrue ^ bNormal);
3749007c843bSdrh       break;
3750007c843bSdrh     }
3751cce7d176Sdrh     case TK_ISNULL:
3752cce7d176Sdrh     case TK_NOTNULL: {
37536a288a33Sdrh       int addr;
37547d176105Sdrh       assert( TK_ISNULL==OP_IsNull );   testcase( op==TK_ISNULL );
37557d176105Sdrh       assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
37569de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
37572dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3758c5499befSdrh       testcase( regFree1==0 );
37592dcef11bSdrh       addr = sqlite3VdbeAddOp1(v, op, r1);
37607d176105Sdrh       VdbeCoverageIf(v, op==TK_ISNULL);
37617d176105Sdrh       VdbeCoverageIf(v, op==TK_NOTNULL);
3762a976979bSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 0, target);
37636a288a33Sdrh       sqlite3VdbeJumpHere(v, addr);
3764a37cdde0Sdanielk1977       break;
3765f2bc013cSdrh     }
37662282792aSdrh     case TK_AGG_FUNCTION: {
376713449892Sdrh       AggInfo *pInfo = pExpr->pAggInfo;
37687e56e711Sdrh       if( pInfo==0 ){
376933e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
377033e619fcSdrh         sqlite3ErrorMsg(pParse, "misuse of aggregate: %s()", pExpr->u.zToken);
37717e56e711Sdrh       }else{
3772c332cc30Sdrh         return pInfo->aFunc[pExpr->iAgg].iMem;
37737e56e711Sdrh       }
37742282792aSdrh       break;
37752282792aSdrh     }
3776cce7d176Sdrh     case TK_FUNCTION: {
377712ffee8cSdrh       ExprList *pFarg;       /* List of function arguments */
377812ffee8cSdrh       int nFarg;             /* Number of function arguments */
377912ffee8cSdrh       FuncDef *pDef;         /* The function definition object */
378012ffee8cSdrh       const char *zId;       /* The function name */
3781693e6719Sdrh       u32 constMask = 0;     /* Mask of function arguments that are constant */
378212ffee8cSdrh       int i;                 /* Loop counter */
3783c332cc30Sdrh       sqlite3 *db = pParse->db;  /* The database connection */
378412ffee8cSdrh       u8 enc = ENC(db);      /* The text encoding used by this database */
378512ffee8cSdrh       CollSeq *pColl = 0;    /* A collating sequence */
378617435752Sdrh 
37871e9b53f9Sdrh       if( ConstFactorOk(pParse) && sqlite3ExprIsConstantNotJoin(pExpr) ){
378849c5ab24Sdrh         /* SQL functions can be expensive. So try to move constant functions
3789ad879ffdSdrh         ** out of the inner loop, even if that means an extra OP_Copy. */
3790ad879ffdSdrh         return sqlite3ExprCodeAtInit(pParse, pExpr, -1);
37911e9b53f9Sdrh       }
37926ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
3793c5cd1249Sdrh       if( ExprHasProperty(pExpr, EP_TokenOnly) ){
379412ffee8cSdrh         pFarg = 0;
379512ffee8cSdrh       }else{
379612ffee8cSdrh         pFarg = pExpr->x.pList;
379712ffee8cSdrh       }
379812ffee8cSdrh       nFarg = pFarg ? pFarg->nExpr : 0;
379933e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
380033e619fcSdrh       zId = pExpr->u.zToken;
380180738d9cSdrh       pDef = sqlite3FindFunction(db, zId, nFarg, enc, 0);
3802cc15313cSdrh #ifdef SQLITE_ENABLE_UNKNOWN_SQL_FUNCTION
3803cc15313cSdrh       if( pDef==0 && pParse->explain ){
3804cc15313cSdrh         pDef = sqlite3FindFunction(db, "unknown", nFarg, enc, 0);
3805cc15313cSdrh       }
3806cc15313cSdrh #endif
38072d80151fSdrh       if( pDef==0 || pDef->xFinalize!=0 ){
380880738d9cSdrh         sqlite3ErrorMsg(pParse, "unknown function: %s()", zId);
3809feb306f5Sdrh         break;
3810feb306f5Sdrh       }
3811ae6bb957Sdrh 
3812ae6bb957Sdrh       /* Attempt a direct implementation of the built-in COALESCE() and
381360ec914cSpeter.d.reid       ** IFNULL() functions.  This avoids unnecessary evaluation of
3814ae6bb957Sdrh       ** arguments past the first non-NULL argument.
3815ae6bb957Sdrh       */
3816d36e1041Sdrh       if( pDef->funcFlags & SQLITE_FUNC_COALESCE ){
3817ae6bb957Sdrh         int endCoalesce = sqlite3VdbeMakeLabel(v);
3818ae6bb957Sdrh         assert( nFarg>=2 );
3819ae6bb957Sdrh         sqlite3ExprCode(pParse, pFarg->a[0].pExpr, target);
3820ae6bb957Sdrh         for(i=1; i<nFarg; i++){
3821ae6bb957Sdrh           sqlite3VdbeAddOp2(v, OP_NotNull, target, endCoalesce);
3822688852abSdrh           VdbeCoverage(v);
3823f49f3523Sdrh           sqlite3ExprCacheRemove(pParse, target, 1);
3824ae6bb957Sdrh           sqlite3ExprCachePush(pParse);
3825ae6bb957Sdrh           sqlite3ExprCode(pParse, pFarg->a[i].pExpr, target);
3826d2490904Sdrh           sqlite3ExprCachePop(pParse);
3827ae6bb957Sdrh         }
3828ae6bb957Sdrh         sqlite3VdbeResolveLabel(v, endCoalesce);
3829ae6bb957Sdrh         break;
3830ae6bb957Sdrh       }
3831ae6bb957Sdrh 
3832cca9f3d2Sdrh       /* The UNLIKELY() function is a no-op.  The result is the value
3833cca9f3d2Sdrh       ** of the first argument.
3834cca9f3d2Sdrh       */
3835cca9f3d2Sdrh       if( pDef->funcFlags & SQLITE_FUNC_UNLIKELY ){
3836cca9f3d2Sdrh         assert( nFarg>=1 );
3837c332cc30Sdrh         return sqlite3ExprCodeTarget(pParse, pFarg->a[0].pExpr, target);
3838cca9f3d2Sdrh       }
3839ae6bb957Sdrh 
384054240751Sdrh #ifdef SQLITE_DEBUG
3841a1a523a5Sdrh       /* The AFFINITY() function evaluates to a string that describes
3842a1a523a5Sdrh       ** the type affinity of the argument.  This is used for testing of
3843a1a523a5Sdrh       ** the SQLite type logic.
3844a1a523a5Sdrh       */
3845a1a523a5Sdrh       if( pDef->funcFlags & SQLITE_FUNC_AFFINITY ){
3846a1a523a5Sdrh         const char *azAff[] = { "blob", "text", "numeric", "integer", "real" };
3847a1a523a5Sdrh         char aff;
3848a1a523a5Sdrh         assert( nFarg==1 );
3849a1a523a5Sdrh         aff = sqlite3ExprAffinity(pFarg->a[0].pExpr);
3850a1a523a5Sdrh         sqlite3VdbeLoadString(v, target,
3851a1a523a5Sdrh                               aff ? azAff[aff-SQLITE_AFF_BLOB] : "none");
3852a1a523a5Sdrh         return target;
3853a1a523a5Sdrh       }
385454240751Sdrh #endif
3855a1a523a5Sdrh 
3856d1a01edaSdrh       for(i=0; i<nFarg; i++){
3857d1a01edaSdrh         if( i<32 && sqlite3ExprIsConstant(pFarg->a[i].pExpr) ){
3858693e6719Sdrh           testcase( i==31 );
3859693e6719Sdrh           constMask |= MASKBIT32(i);
3860d1a01edaSdrh         }
3861d1a01edaSdrh         if( (pDef->funcFlags & SQLITE_FUNC_NEEDCOLL)!=0 && !pColl ){
3862d1a01edaSdrh           pColl = sqlite3ExprCollSeq(pParse, pFarg->a[i].pExpr);
3863d1a01edaSdrh         }
3864d1a01edaSdrh       }
386512ffee8cSdrh       if( pFarg ){
3866d1a01edaSdrh         if( constMask ){
3867d1a01edaSdrh           r1 = pParse->nMem+1;
3868d1a01edaSdrh           pParse->nMem += nFarg;
3869d1a01edaSdrh         }else{
387012ffee8cSdrh           r1 = sqlite3GetTempRange(pParse, nFarg);
3871d1a01edaSdrh         }
3872a748fdccSdrh 
3873a748fdccSdrh         /* For length() and typeof() functions with a column argument,
3874a748fdccSdrh         ** set the P5 parameter to the OP_Column opcode to OPFLAG_LENGTHARG
3875a748fdccSdrh         ** or OPFLAG_TYPEOFARG respectively, to avoid unnecessary data
3876a748fdccSdrh         ** loading.
3877a748fdccSdrh         */
3878d36e1041Sdrh         if( (pDef->funcFlags & (SQLITE_FUNC_LENGTH|SQLITE_FUNC_TYPEOF))!=0 ){
38794e245a4cSdrh           u8 exprOp;
3880a748fdccSdrh           assert( nFarg==1 );
3881a748fdccSdrh           assert( pFarg->a[0].pExpr!=0 );
38824e245a4cSdrh           exprOp = pFarg->a[0].pExpr->op;
38834e245a4cSdrh           if( exprOp==TK_COLUMN || exprOp==TK_AGG_COLUMN ){
3884a748fdccSdrh             assert( SQLITE_FUNC_LENGTH==OPFLAG_LENGTHARG );
3885a748fdccSdrh             assert( SQLITE_FUNC_TYPEOF==OPFLAG_TYPEOFARG );
3886b1fba286Sdrh             testcase( pDef->funcFlags & OPFLAG_LENGTHARG );
3887b1fba286Sdrh             pFarg->a[0].pExpr->op2 =
3888b1fba286Sdrh                   pDef->funcFlags & (OPFLAG_LENGTHARG|OPFLAG_TYPEOFARG);
3889a748fdccSdrh           }
3890a748fdccSdrh         }
3891a748fdccSdrh 
3892d7d385ddSdrh         sqlite3ExprCachePush(pParse);     /* Ticket 2ea2425d34be */
38935579d59fSdrh         sqlite3ExprCodeExprList(pParse, pFarg, r1, 0,
3894d1a01edaSdrh                                 SQLITE_ECEL_DUP|SQLITE_ECEL_FACTOR);
3895d2490904Sdrh         sqlite3ExprCachePop(pParse);      /* Ticket 2ea2425d34be */
3896892d3179Sdrh       }else{
389712ffee8cSdrh         r1 = 0;
3898892d3179Sdrh       }
3899b7f6f68fSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
3900a43fa227Sdrh       /* Possibly overload the function if the first argument is
3901a43fa227Sdrh       ** a virtual table column.
3902a43fa227Sdrh       **
3903a43fa227Sdrh       ** For infix functions (LIKE, GLOB, REGEXP, and MATCH) use the
3904a43fa227Sdrh       ** second argument, not the first, as the argument to test to
3905a43fa227Sdrh       ** see if it is a column in a virtual table.  This is done because
3906a43fa227Sdrh       ** the left operand of infix functions (the operand we want to
3907a43fa227Sdrh       ** control overloading) ends up as the second argument to the
3908a43fa227Sdrh       ** function.  The expression "A glob B" is equivalent to
3909a43fa227Sdrh       ** "glob(B,A).  We want to use the A in "A glob B" to test
3910a43fa227Sdrh       ** for function overloading.  But we use the B term in "glob(B,A)".
3911a43fa227Sdrh       */
391212ffee8cSdrh       if( nFarg>=2 && (pExpr->flags & EP_InfixFunc) ){
391312ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[1].pExpr);
391412ffee8cSdrh       }else if( nFarg>0 ){
391512ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[0].pExpr);
3916b7f6f68fSdrh       }
3917b7f6f68fSdrh #endif
3918d36e1041Sdrh       if( pDef->funcFlags & SQLITE_FUNC_NEEDCOLL ){
39198b213899Sdrh         if( !pColl ) pColl = db->pDfltColl;
392066a5167bSdrh         sqlite3VdbeAddOp4(v, OP_CollSeq, 0, 0, 0, (char *)pColl, P4_COLLSEQ);
3921682f68b0Sdanielk1977       }
3922092457b1Sdrh #ifdef SQLITE_ENABLE_OFFSET_SQL_FUNC
3923092457b1Sdrh       if( pDef->funcFlags & SQLITE_FUNC_OFFSET ){
39242fc865c1Sdrh         Expr *pArg = pFarg->a[0].pExpr;
39252fc865c1Sdrh         if( pArg->op==TK_COLUMN ){
3926092457b1Sdrh           sqlite3VdbeAddOp3(v, OP_Offset, pArg->iTable, pArg->iColumn, target);
39272fc865c1Sdrh         }else{
39282fc865c1Sdrh           sqlite3VdbeAddOp2(v, OP_Null, 0, target);
39292fc865c1Sdrh         }
3930092457b1Sdrh       }else
3931092457b1Sdrh #endif
3932092457b1Sdrh       {
39333e34eabcSdrh         sqlite3VdbeAddOp4(v, pParse->iSelfTab ? OP_PureFunc0 : OP_Function0,
39343e34eabcSdrh                           constMask, r1, target, (char*)pDef, P4_FUNCDEF);
393512ffee8cSdrh         sqlite3VdbeChangeP5(v, (u8)nFarg);
39362fc865c1Sdrh       }
3937d1a01edaSdrh       if( nFarg && constMask==0 ){
393812ffee8cSdrh         sqlite3ReleaseTempRange(pParse, r1, nFarg);
39392dcef11bSdrh       }
3940c332cc30Sdrh       return target;
39416ec2733bSdrh     }
3942fe2093d7Sdrh #ifndef SQLITE_OMIT_SUBQUERY
3943fe2093d7Sdrh     case TK_EXISTS:
394419a775c2Sdrh     case TK_SELECT: {
39458da209b1Sdan       int nCol;
3946c5499befSdrh       testcase( op==TK_EXISTS );
3947c5499befSdrh       testcase( op==TK_SELECT );
39488da209b1Sdan       if( op==TK_SELECT && (nCol = pExpr->x.pSelect->pEList->nExpr)!=1 ){
39498da209b1Sdan         sqlite3SubselectError(pParse, nCol, 1);
39508da209b1Sdan       }else{
3951c332cc30Sdrh         return sqlite3CodeSubselect(pParse, pExpr, 0, 0);
39528da209b1Sdan       }
395319a775c2Sdrh       break;
395419a775c2Sdrh     }
3955fc7f27b9Sdrh     case TK_SELECT_COLUMN: {
3956966e2911Sdrh       int n;
3957fc7f27b9Sdrh       if( pExpr->pLeft->iTable==0 ){
3958fc7f27b9Sdrh         pExpr->pLeft->iTable = sqlite3CodeSubselect(pParse, pExpr->pLeft, 0, 0);
3959fc7f27b9Sdrh       }
3960966e2911Sdrh       assert( pExpr->iTable==0 || pExpr->pLeft->op==TK_SELECT );
3961966e2911Sdrh       if( pExpr->iTable
3962966e2911Sdrh        && pExpr->iTable!=(n = sqlite3ExprVectorSize(pExpr->pLeft))
3963966e2911Sdrh       ){
3964966e2911Sdrh         sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
3965966e2911Sdrh                                 pExpr->iTable, n);
3966966e2911Sdrh       }
3967c332cc30Sdrh       return pExpr->pLeft->iTable + pExpr->iColumn;
3968fc7f27b9Sdrh     }
3969fef5208cSdrh     case TK_IN: {
3970e3365e6cSdrh       int destIfFalse = sqlite3VdbeMakeLabel(v);
3971e3365e6cSdrh       int destIfNull = sqlite3VdbeMakeLabel(v);
3972e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3973e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
397466ba23ceSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
3975e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
3976e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_AddImm, target, 0);
3977e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfNull);
3978c332cc30Sdrh       return target;
3979fef5208cSdrh     }
3980e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
3981e3365e6cSdrh 
3982e3365e6cSdrh 
39832dcef11bSdrh     /*
39842dcef11bSdrh     **    x BETWEEN y AND z
39852dcef11bSdrh     **
39862dcef11bSdrh     ** This is equivalent to
39872dcef11bSdrh     **
39882dcef11bSdrh     **    x>=y AND x<=z
39892dcef11bSdrh     **
39902dcef11bSdrh     ** X is stored in pExpr->pLeft.
39912dcef11bSdrh     ** Y is stored in pExpr->pList->a[0].pExpr.
39922dcef11bSdrh     ** Z is stored in pExpr->pList->a[1].pExpr.
39932dcef11bSdrh     */
3994fef5208cSdrh     case TK_BETWEEN: {
399571c57db0Sdan       exprCodeBetween(pParse, pExpr, target, 0, 0);
3996c332cc30Sdrh       return target;
3997fef5208cSdrh     }
399894fa9c41Sdrh     case TK_SPAN:
3999ae80ddeaSdrh     case TK_COLLATE:
40004f07e5fbSdrh     case TK_UPLUS: {
4001c332cc30Sdrh       return sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
4002a2e00042Sdrh     }
40032dcef11bSdrh 
4004165921a7Sdan     case TK_TRIGGER: {
400565a7cd16Sdan       /* If the opcode is TK_TRIGGER, then the expression is a reference
400665a7cd16Sdan       ** to a column in the new.* or old.* pseudo-tables available to
400765a7cd16Sdan       ** trigger programs. In this case Expr.iTable is set to 1 for the
400865a7cd16Sdan       ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
400965a7cd16Sdan       ** is set to the column of the pseudo-table to read, or to -1 to
401065a7cd16Sdan       ** read the rowid field.
401165a7cd16Sdan       **
401265a7cd16Sdan       ** The expression is implemented using an OP_Param opcode. The p1
401365a7cd16Sdan       ** parameter is set to 0 for an old.rowid reference, or to (i+1)
401465a7cd16Sdan       ** to reference another column of the old.* pseudo-table, where
401565a7cd16Sdan       ** i is the index of the column. For a new.rowid reference, p1 is
401665a7cd16Sdan       ** set to (n+1), where n is the number of columns in each pseudo-table.
401765a7cd16Sdan       ** For a reference to any other column in the new.* pseudo-table, p1
401865a7cd16Sdan       ** is set to (n+2+i), where n and i are as defined previously. For
401965a7cd16Sdan       ** example, if the table on which triggers are being fired is
402065a7cd16Sdan       ** declared as:
402165a7cd16Sdan       **
402265a7cd16Sdan       **   CREATE TABLE t1(a, b);
402365a7cd16Sdan       **
402465a7cd16Sdan       ** Then p1 is interpreted as follows:
402565a7cd16Sdan       **
402665a7cd16Sdan       **   p1==0   ->    old.rowid     p1==3   ->    new.rowid
402765a7cd16Sdan       **   p1==1   ->    old.a         p1==4   ->    new.a
402865a7cd16Sdan       **   p1==2   ->    old.b         p1==5   ->    new.b
402965a7cd16Sdan       */
40302832ad42Sdan       Table *pTab = pExpr->pTab;
403165a7cd16Sdan       int p1 = pExpr->iTable * (pTab->nCol+1) + 1 + pExpr->iColumn;
403265a7cd16Sdan 
403365a7cd16Sdan       assert( pExpr->iTable==0 || pExpr->iTable==1 );
403465a7cd16Sdan       assert( pExpr->iColumn>=-1 && pExpr->iColumn<pTab->nCol );
403565a7cd16Sdan       assert( pTab->iPKey<0 || pExpr->iColumn!=pTab->iPKey );
403665a7cd16Sdan       assert( p1>=0 && p1<(pTab->nCol*2+2) );
403765a7cd16Sdan 
403865a7cd16Sdan       sqlite3VdbeAddOp2(v, OP_Param, p1, target);
403976d462eeSdan       VdbeComment((v, "%s.%s -> $%d",
4040165921a7Sdan         (pExpr->iTable ? "new" : "old"),
404176d462eeSdan         (pExpr->iColumn<0 ? "rowid" : pExpr->pTab->aCol[pExpr->iColumn].zName),
404276d462eeSdan         target
4043165921a7Sdan       ));
404465a7cd16Sdan 
404544dbca83Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
404665a7cd16Sdan       /* If the column has REAL affinity, it may currently be stored as an
4047113762a2Sdrh       ** integer. Use OP_RealAffinity to make sure it is really real.
4048113762a2Sdrh       **
4049113762a2Sdrh       ** EVIDENCE-OF: R-60985-57662 SQLite will convert the value back to
4050113762a2Sdrh       ** floating point when extracting it from the record.  */
40512832ad42Sdan       if( pExpr->iColumn>=0
40522832ad42Sdan        && pTab->aCol[pExpr->iColumn].affinity==SQLITE_AFF_REAL
40532832ad42Sdan       ){
40542832ad42Sdan         sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
40552832ad42Sdan       }
405644dbca83Sdrh #endif
4057165921a7Sdan       break;
4058165921a7Sdan     }
4059165921a7Sdan 
406071c57db0Sdan     case TK_VECTOR: {
4061e835bc12Sdrh       sqlite3ErrorMsg(pParse, "row value misused");
406271c57db0Sdan       break;
406371c57db0Sdan     }
406471c57db0Sdan 
406531d6fd55Sdrh     case TK_IF_NULL_ROW: {
406631d6fd55Sdrh       int addrINR;
406731d6fd55Sdrh       addrINR = sqlite3VdbeAddOp1(v, OP_IfNullRow, pExpr->iTable);
406831d6fd55Sdrh       sqlite3ExprCachePush(pParse);
406931d6fd55Sdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
407031d6fd55Sdrh       sqlite3ExprCachePop(pParse);
407131d6fd55Sdrh       sqlite3VdbeJumpHere(v, addrINR);
407231d6fd55Sdrh       sqlite3VdbeChangeP3(v, addrINR, inReg);
407331d6fd55Sdrh       break;
407431d6fd55Sdrh     }
407531d6fd55Sdrh 
40762dcef11bSdrh     /*
40772dcef11bSdrh     ** Form A:
40782dcef11bSdrh     **   CASE x WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
40792dcef11bSdrh     **
40802dcef11bSdrh     ** Form B:
40812dcef11bSdrh     **   CASE WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
40822dcef11bSdrh     **
40832dcef11bSdrh     ** Form A is can be transformed into the equivalent form B as follows:
40842dcef11bSdrh     **   CASE WHEN x=e1 THEN r1 WHEN x=e2 THEN r2 ...
40852dcef11bSdrh     **        WHEN x=eN THEN rN ELSE y END
40862dcef11bSdrh     **
40872dcef11bSdrh     ** X (if it exists) is in pExpr->pLeft.
4088c5cd1249Sdrh     ** Y is in the last element of pExpr->x.pList if pExpr->x.pList->nExpr is
4089c5cd1249Sdrh     ** odd.  The Y is also optional.  If the number of elements in x.pList
4090c5cd1249Sdrh     ** is even, then Y is omitted and the "otherwise" result is NULL.
40912dcef11bSdrh     ** Ei is in pExpr->pList->a[i*2] and Ri is pExpr->pList->a[i*2+1].
40922dcef11bSdrh     **
40932dcef11bSdrh     ** The result of the expression is the Ri for the first matching Ei,
40942dcef11bSdrh     ** or if there is no matching Ei, the ELSE term Y, or if there is
40952dcef11bSdrh     ** no ELSE term, NULL.
40962dcef11bSdrh     */
409733cd4909Sdrh     default: assert( op==TK_CASE ); {
40982dcef11bSdrh       int endLabel;                     /* GOTO label for end of CASE stmt */
40992dcef11bSdrh       int nextCase;                     /* GOTO label for next WHEN clause */
41002dcef11bSdrh       int nExpr;                        /* 2x number of WHEN terms */
41012dcef11bSdrh       int i;                            /* Loop counter */
41022dcef11bSdrh       ExprList *pEList;                 /* List of WHEN terms */
41032dcef11bSdrh       struct ExprList_item *aListelem;  /* Array of WHEN terms */
41042dcef11bSdrh       Expr opCompare;                   /* The X==Ei expression */
41052dcef11bSdrh       Expr *pX;                         /* The X expression */
41061bd10f8aSdrh       Expr *pTest = 0;                  /* X==Ei (form A) or just Ei (form B) */
4107ceea3321Sdrh       VVA_ONLY( int iCacheLevel = pParse->iCacheLevel; )
410817a7f8ddSdrh 
41096ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) && pExpr->x.pList );
41106ab3a2ecSdanielk1977       assert(pExpr->x.pList->nExpr > 0);
41116ab3a2ecSdanielk1977       pEList = pExpr->x.pList;
4112be5c89acSdrh       aListelem = pEList->a;
4113be5c89acSdrh       nExpr = pEList->nExpr;
41142dcef11bSdrh       endLabel = sqlite3VdbeMakeLabel(v);
41152dcef11bSdrh       if( (pX = pExpr->pLeft)!=0 ){
411610d1edf0Sdrh         tempX = *pX;
411733cd4909Sdrh         testcase( pX->op==TK_COLUMN );
411812abf408Sdrh         exprToRegister(&tempX, exprCodeVector(pParse, &tempX, &regFree1));
4119c5499befSdrh         testcase( regFree1==0 );
4120abb9d5f1Sdrh         memset(&opCompare, 0, sizeof(opCompare));
41212dcef11bSdrh         opCompare.op = TK_EQ;
412210d1edf0Sdrh         opCompare.pLeft = &tempX;
41232dcef11bSdrh         pTest = &opCompare;
41248b1db07fSdrh         /* Ticket b351d95f9cd5ef17e9d9dbae18f5ca8611190001:
41258b1db07fSdrh         ** The value in regFree1 might get SCopy-ed into the file result.
41268b1db07fSdrh         ** So make sure that the regFree1 register is not reused for other
41278b1db07fSdrh         ** purposes and possibly overwritten.  */
41288b1db07fSdrh         regFree1 = 0;
4129cce7d176Sdrh       }
4130c5cd1249Sdrh       for(i=0; i<nExpr-1; i=i+2){
4131ceea3321Sdrh         sqlite3ExprCachePush(pParse);
41322dcef11bSdrh         if( pX ){
41331bd10f8aSdrh           assert( pTest!=0 );
41342dcef11bSdrh           opCompare.pRight = aListelem[i].pExpr;
4135f5905aa7Sdrh         }else{
41362dcef11bSdrh           pTest = aListelem[i].pExpr;
413717a7f8ddSdrh         }
41382dcef11bSdrh         nextCase = sqlite3VdbeMakeLabel(v);
413933cd4909Sdrh         testcase( pTest->op==TK_COLUMN );
41402dcef11bSdrh         sqlite3ExprIfFalse(pParse, pTest, nextCase, SQLITE_JUMPIFNULL);
4141c5499befSdrh         testcase( aListelem[i+1].pExpr->op==TK_COLUMN );
41429de221dfSdrh         sqlite3ExprCode(pParse, aListelem[i+1].pExpr, target);
4143076e85f5Sdrh         sqlite3VdbeGoto(v, endLabel);
4144d2490904Sdrh         sqlite3ExprCachePop(pParse);
41452dcef11bSdrh         sqlite3VdbeResolveLabel(v, nextCase);
4146f570f011Sdrh       }
4147c5cd1249Sdrh       if( (nExpr&1)!=0 ){
4148ceea3321Sdrh         sqlite3ExprCachePush(pParse);
4149c5cd1249Sdrh         sqlite3ExprCode(pParse, pEList->a[nExpr-1].pExpr, target);
4150d2490904Sdrh         sqlite3ExprCachePop(pParse);
415117a7f8ddSdrh       }else{
41529de221dfSdrh         sqlite3VdbeAddOp2(v, OP_Null, 0, target);
415317a7f8ddSdrh       }
4154c332cc30Sdrh       assert( pParse->db->mallocFailed || pParse->nErr>0
4155c1f4a19bSdanielk1977            || pParse->iCacheLevel==iCacheLevel );
41562dcef11bSdrh       sqlite3VdbeResolveLabel(v, endLabel);
41576f34903eSdanielk1977       break;
41586f34903eSdanielk1977     }
41595338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_TRIGGER
41606f34903eSdanielk1977     case TK_RAISE: {
4161165921a7Sdan       assert( pExpr->affinity==OE_Rollback
4162165921a7Sdan            || pExpr->affinity==OE_Abort
4163165921a7Sdan            || pExpr->affinity==OE_Fail
4164165921a7Sdan            || pExpr->affinity==OE_Ignore
4165165921a7Sdan       );
4166e0af83acSdan       if( !pParse->pTriggerTab ){
4167e0af83acSdan         sqlite3ErrorMsg(pParse,
4168e0af83acSdan                        "RAISE() may only be used within a trigger-program");
4169e0af83acSdan         return 0;
4170e0af83acSdan       }
4171e0af83acSdan       if( pExpr->affinity==OE_Abort ){
4172e0af83acSdan         sqlite3MayAbort(pParse);
4173e0af83acSdan       }
417433e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
4175e0af83acSdan       if( pExpr->affinity==OE_Ignore ){
4176e0af83acSdan         sqlite3VdbeAddOp4(
4177e0af83acSdan             v, OP_Halt, SQLITE_OK, OE_Ignore, 0, pExpr->u.zToken,0);
4178688852abSdrh         VdbeCoverage(v);
4179e0af83acSdan       }else{
4180433dccfbSdrh         sqlite3HaltConstraint(pParse, SQLITE_CONSTRAINT_TRIGGER,
4181f9c8ce3cSdrh                               pExpr->affinity, pExpr->u.zToken, 0, 0);
4182e0af83acSdan       }
4183e0af83acSdan 
4184ffe07b2dSdrh       break;
418517a7f8ddSdrh     }
41865338a5f7Sdanielk1977 #endif
4187ffe07b2dSdrh   }
41882dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
41892dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
41902dcef11bSdrh   return inReg;
41915b6afba9Sdrh }
41922dcef11bSdrh 
41932dcef11bSdrh /*
4194d1a01edaSdrh ** Factor out the code of the given expression to initialization time.
41951e9b53f9Sdrh **
4196ad879ffdSdrh ** If regDest>=0 then the result is always stored in that register and the
4197ad879ffdSdrh ** result is not reusable.  If regDest<0 then this routine is free to
4198ad879ffdSdrh ** store the value whereever it wants.  The register where the expression
4199ad879ffdSdrh ** is stored is returned.  When regDest<0, two identical expressions will
4200ad879ffdSdrh ** code to the same register.
4201d1a01edaSdrh */
42021e9b53f9Sdrh int sqlite3ExprCodeAtInit(
4203d673cddaSdrh   Parse *pParse,    /* Parsing context */
4204d673cddaSdrh   Expr *pExpr,      /* The expression to code when the VDBE initializes */
4205ad879ffdSdrh   int regDest       /* Store the value in this register */
4206d673cddaSdrh ){
4207d1a01edaSdrh   ExprList *p;
4208d9f158e7Sdrh   assert( ConstFactorOk(pParse) );
4209d1a01edaSdrh   p = pParse->pConstExpr;
4210ad879ffdSdrh   if( regDest<0 && p ){
42111e9b53f9Sdrh     struct ExprList_item *pItem;
42121e9b53f9Sdrh     int i;
42131e9b53f9Sdrh     for(pItem=p->a, i=p->nExpr; i>0; pItem++, i--){
42145aa550cfSdan       if( pItem->reusable && sqlite3ExprCompare(0,pItem->pExpr,pExpr,-1)==0 ){
42151e9b53f9Sdrh         return pItem->u.iConstExprReg;
42161e9b53f9Sdrh       }
42171e9b53f9Sdrh     }
42181e9b53f9Sdrh   }
4219d1a01edaSdrh   pExpr = sqlite3ExprDup(pParse->db, pExpr, 0);
4220d1a01edaSdrh   p = sqlite3ExprListAppend(pParse, p, pExpr);
4221d673cddaSdrh   if( p ){
4222d673cddaSdrh      struct ExprList_item *pItem = &p->a[p->nExpr-1];
4223ad879ffdSdrh      pItem->reusable = regDest<0;
4224ad879ffdSdrh      if( regDest<0 ) regDest = ++pParse->nMem;
4225d673cddaSdrh      pItem->u.iConstExprReg = regDest;
4226d673cddaSdrh   }
4227d1a01edaSdrh   pParse->pConstExpr = p;
42281e9b53f9Sdrh   return regDest;
4229d1a01edaSdrh }
4230d1a01edaSdrh 
4231d1a01edaSdrh /*
42322dcef11bSdrh ** Generate code to evaluate an expression and store the results
42332dcef11bSdrh ** into a register.  Return the register number where the results
42342dcef11bSdrh ** are stored.
42352dcef11bSdrh **
42362dcef11bSdrh ** If the register is a temporary register that can be deallocated,
4237678ccce8Sdrh ** then write its number into *pReg.  If the result register is not
42382dcef11bSdrh ** a temporary, then set *pReg to zero.
4239f30a969bSdrh **
4240f30a969bSdrh ** If pExpr is a constant, then this routine might generate this
4241f30a969bSdrh ** code to fill the register in the initialization section of the
4242f30a969bSdrh ** VDBE program, in order to factor it out of the evaluation loop.
42432dcef11bSdrh */
42442dcef11bSdrh int sqlite3ExprCodeTemp(Parse *pParse, Expr *pExpr, int *pReg){
4245f30a969bSdrh   int r2;
4246f30a969bSdrh   pExpr = sqlite3ExprSkipCollate(pExpr);
4247d9f158e7Sdrh   if( ConstFactorOk(pParse)
4248f30a969bSdrh    && pExpr->op!=TK_REGISTER
4249f30a969bSdrh    && sqlite3ExprIsConstantNotJoin(pExpr)
4250f30a969bSdrh   ){
4251f30a969bSdrh     *pReg  = 0;
4252ad879ffdSdrh     r2 = sqlite3ExprCodeAtInit(pParse, pExpr, -1);
4253f30a969bSdrh   }else{
42542dcef11bSdrh     int r1 = sqlite3GetTempReg(pParse);
4255f30a969bSdrh     r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
42562dcef11bSdrh     if( r2==r1 ){
42572dcef11bSdrh       *pReg = r1;
42582dcef11bSdrh     }else{
42592dcef11bSdrh       sqlite3ReleaseTempReg(pParse, r1);
42602dcef11bSdrh       *pReg = 0;
42612dcef11bSdrh     }
4262f30a969bSdrh   }
42632dcef11bSdrh   return r2;
42642dcef11bSdrh }
42652dcef11bSdrh 
42662dcef11bSdrh /*
42672dcef11bSdrh ** Generate code that will evaluate expression pExpr and store the
42682dcef11bSdrh ** results in register target.  The results are guaranteed to appear
42692dcef11bSdrh ** in register target.
42702dcef11bSdrh */
427105a86c5cSdrh void sqlite3ExprCode(Parse *pParse, Expr *pExpr, int target){
42729cbf3425Sdrh   int inReg;
42739cbf3425Sdrh 
42749cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
4275ebc16717Sdrh   if( pExpr && pExpr->op==TK_REGISTER ){
4276ebc16717Sdrh     sqlite3VdbeAddOp2(pParse->pVdbe, OP_Copy, pExpr->iTable, target);
4277ebc16717Sdrh   }else{
42789cbf3425Sdrh     inReg = sqlite3ExprCodeTarget(pParse, pExpr, target);
42791c75c9d7Sdrh     assert( pParse->pVdbe!=0 || pParse->db->mallocFailed );
42800e359b30Sdrh     if( inReg!=target && pParse->pVdbe ){
42819cbf3425Sdrh       sqlite3VdbeAddOp2(pParse->pVdbe, OP_SCopy, inReg, target);
428217a7f8ddSdrh     }
4283ebc16717Sdrh   }
4284cce7d176Sdrh }
4285cce7d176Sdrh 
4286cce7d176Sdrh /*
42871c75c9d7Sdrh ** Make a transient copy of expression pExpr and then code it using
42881c75c9d7Sdrh ** sqlite3ExprCode().  This routine works just like sqlite3ExprCode()
42891c75c9d7Sdrh ** except that the input expression is guaranteed to be unchanged.
42901c75c9d7Sdrh */
42911c75c9d7Sdrh void sqlite3ExprCodeCopy(Parse *pParse, Expr *pExpr, int target){
42921c75c9d7Sdrh   sqlite3 *db = pParse->db;
42931c75c9d7Sdrh   pExpr = sqlite3ExprDup(db, pExpr, 0);
42941c75c9d7Sdrh   if( !db->mallocFailed ) sqlite3ExprCode(pParse, pExpr, target);
42951c75c9d7Sdrh   sqlite3ExprDelete(db, pExpr);
42961c75c9d7Sdrh }
42971c75c9d7Sdrh 
42981c75c9d7Sdrh /*
429905a86c5cSdrh ** Generate code that will evaluate expression pExpr and store the
430005a86c5cSdrh ** results in register target.  The results are guaranteed to appear
430105a86c5cSdrh ** in register target.  If the expression is constant, then this routine
430205a86c5cSdrh ** might choose to code the expression at initialization time.
430305a86c5cSdrh */
430405a86c5cSdrh void sqlite3ExprCodeFactorable(Parse *pParse, Expr *pExpr, int target){
430505a86c5cSdrh   if( pParse->okConstFactor && sqlite3ExprIsConstant(pExpr) ){
4306ad879ffdSdrh     sqlite3ExprCodeAtInit(pParse, pExpr, target);
430705a86c5cSdrh   }else{
430805a86c5cSdrh     sqlite3ExprCode(pParse, pExpr, target);
430905a86c5cSdrh   }
4310cce7d176Sdrh }
4311cce7d176Sdrh 
4312cce7d176Sdrh /*
431360ec914cSpeter.d.reid ** Generate code that evaluates the given expression and puts the result
4314de4fcfddSdrh ** in register target.
431525303780Sdrh **
43162dcef11bSdrh ** Also make a copy of the expression results into another "cache" register
43172dcef11bSdrh ** and modify the expression so that the next time it is evaluated,
43182dcef11bSdrh ** the result is a copy of the cache register.
43192dcef11bSdrh **
43202dcef11bSdrh ** This routine is used for expressions that are used multiple
43212dcef11bSdrh ** times.  They are evaluated once and the results of the expression
43222dcef11bSdrh ** are reused.
432325303780Sdrh */
432405a86c5cSdrh void sqlite3ExprCodeAndCache(Parse *pParse, Expr *pExpr, int target){
432525303780Sdrh   Vdbe *v = pParse->pVdbe;
432625303780Sdrh   int iMem;
432705a86c5cSdrh 
432805a86c5cSdrh   assert( target>0 );
432905a86c5cSdrh   assert( pExpr->op!=TK_REGISTER );
433005a86c5cSdrh   sqlite3ExprCode(pParse, pExpr, target);
43312dcef11bSdrh   iMem = ++pParse->nMem;
433205a86c5cSdrh   sqlite3VdbeAddOp2(v, OP_Copy, target, iMem);
4333a4c3c87eSdrh   exprToRegister(pExpr, iMem);
433425303780Sdrh }
43357e02e5e6Sdrh 
4336678ccce8Sdrh /*
4337268380caSdrh ** Generate code that pushes the value of every element of the given
43389cbf3425Sdrh ** expression list into a sequence of registers beginning at target.
4339268380caSdrh **
43403df6c3b1Sdrh ** Return the number of elements evaluated.  The number returned will
43413df6c3b1Sdrh ** usually be pList->nExpr but might be reduced if SQLITE_ECEL_OMITREF
43423df6c3b1Sdrh ** is defined.
4343d1a01edaSdrh **
4344d1a01edaSdrh ** The SQLITE_ECEL_DUP flag prevents the arguments from being
4345d1a01edaSdrh ** filled using OP_SCopy.  OP_Copy must be used instead.
4346d1a01edaSdrh **
4347d1a01edaSdrh ** The SQLITE_ECEL_FACTOR argument allows constant arguments to be
4348d1a01edaSdrh ** factored out into initialization code.
4349b0df9634Sdrh **
4350b0df9634Sdrh ** The SQLITE_ECEL_REF flag means that expressions in the list with
4351b0df9634Sdrh ** ExprList.a[].u.x.iOrderByCol>0 have already been evaluated and stored
4352b0df9634Sdrh ** in registers at srcReg, and so the value can be copied from there.
43533df6c3b1Sdrh ** If SQLITE_ECEL_OMITREF is also set, then the values with u.x.iOrderByCol>0
43543df6c3b1Sdrh ** are simply omitted rather than being copied from srcReg.
4355268380caSdrh */
43564adee20fSdanielk1977 int sqlite3ExprCodeExprList(
4357268380caSdrh   Parse *pParse,     /* Parsing context */
4358389a1adbSdrh   ExprList *pList,   /* The expression list to be coded */
4359191b54cbSdrh   int target,        /* Where to write results */
43605579d59fSdrh   int srcReg,        /* Source registers if SQLITE_ECEL_REF */
4361d1a01edaSdrh   u8 flags           /* SQLITE_ECEL_* flags */
4362268380caSdrh ){
4363268380caSdrh   struct ExprList_item *pItem;
43645579d59fSdrh   int i, j, n;
4365d1a01edaSdrh   u8 copyOp = (flags & SQLITE_ECEL_DUP) ? OP_Copy : OP_SCopy;
43665579d59fSdrh   Vdbe *v = pParse->pVdbe;
43679d8b3072Sdrh   assert( pList!=0 );
43689cbf3425Sdrh   assert( target>0 );
4369d81a142bSdrh   assert( pParse->pVdbe!=0 );  /* Never gets this far otherwise */
4370268380caSdrh   n = pList->nExpr;
4371d9f158e7Sdrh   if( !ConstFactorOk(pParse) ) flags &= ~SQLITE_ECEL_FACTOR;
4372191b54cbSdrh   for(pItem=pList->a, i=0; i<n; i++, pItem++){
43737445ffe2Sdrh     Expr *pExpr = pItem->pExpr;
4374257c13faSdan     if( (flags & SQLITE_ECEL_REF)!=0 && (j = pItem->u.x.iOrderByCol)>0 ){
4375257c13faSdan       if( flags & SQLITE_ECEL_OMITREF ){
4376257c13faSdan         i--;
4377257c13faSdan         n--;
4378257c13faSdan       }else{
43795579d59fSdrh         sqlite3VdbeAddOp2(v, copyOp, j+srcReg-1, target+i);
4380257c13faSdan       }
43815579d59fSdrh     }else if( (flags & SQLITE_ECEL_FACTOR)!=0 && sqlite3ExprIsConstant(pExpr) ){
4382ad879ffdSdrh       sqlite3ExprCodeAtInit(pParse, pExpr, target+i);
4383d1a01edaSdrh     }else{
43847445ffe2Sdrh       int inReg = sqlite3ExprCodeTarget(pParse, pExpr, target+i);
4385746fd9ccSdrh       if( inReg!=target+i ){
43864eded604Sdrh         VdbeOp *pOp;
43874eded604Sdrh         if( copyOp==OP_Copy
43884eded604Sdrh          && (pOp=sqlite3VdbeGetOp(v, -1))->opcode==OP_Copy
43894eded604Sdrh          && pOp->p1+pOp->p3+1==inReg
43904eded604Sdrh          && pOp->p2+pOp->p3+1==target+i
43914eded604Sdrh         ){
43924eded604Sdrh           pOp->p3++;
43934eded604Sdrh         }else{
43944eded604Sdrh           sqlite3VdbeAddOp2(v, copyOp, inReg, target+i);
43954eded604Sdrh         }
4396d1a01edaSdrh       }
4397d176611bSdrh     }
4398268380caSdrh   }
4399f9b596ebSdrh   return n;
4400268380caSdrh }
4401268380caSdrh 
4402268380caSdrh /*
440336c563a2Sdrh ** Generate code for a BETWEEN operator.
440436c563a2Sdrh **
440536c563a2Sdrh **    x BETWEEN y AND z
440636c563a2Sdrh **
440736c563a2Sdrh ** The above is equivalent to
440836c563a2Sdrh **
440936c563a2Sdrh **    x>=y AND x<=z
441036c563a2Sdrh **
441136c563a2Sdrh ** Code it as such, taking care to do the common subexpression
441260ec914cSpeter.d.reid ** elimination of x.
441384b19a3dSdrh **
441484b19a3dSdrh ** The xJumpIf parameter determines details:
441584b19a3dSdrh **
441684b19a3dSdrh **    NULL:                   Store the boolean result in reg[dest]
441784b19a3dSdrh **    sqlite3ExprIfTrue:      Jump to dest if true
441884b19a3dSdrh **    sqlite3ExprIfFalse:     Jump to dest if false
441984b19a3dSdrh **
442084b19a3dSdrh ** The jumpIfNull parameter is ignored if xJumpIf is NULL.
442136c563a2Sdrh */
442236c563a2Sdrh static void exprCodeBetween(
442336c563a2Sdrh   Parse *pParse,    /* Parsing and code generating context */
442436c563a2Sdrh   Expr *pExpr,      /* The BETWEEN expression */
442584b19a3dSdrh   int dest,         /* Jump destination or storage location */
442684b19a3dSdrh   void (*xJump)(Parse*,Expr*,int,int), /* Action to take */
442736c563a2Sdrh   int jumpIfNull    /* Take the jump if the BETWEEN is NULL */
442836c563a2Sdrh ){
442936c563a2Sdrh  Expr exprAnd;     /* The AND operator in  x>=y AND x<=z  */
443036c563a2Sdrh   Expr compLeft;    /* The  x>=y  term */
443136c563a2Sdrh   Expr compRight;   /* The  x<=z  term */
4432db45bd5eSdrh   Expr exprX;       /* The  x  subexpression */
4433db45bd5eSdrh   int regFree1 = 0; /* Temporary use register */
443484b19a3dSdrh 
443536c563a2Sdrh 
443671c57db0Sdan   memset(&compLeft, 0, sizeof(Expr));
443771c57db0Sdan   memset(&compRight, 0, sizeof(Expr));
443871c57db0Sdan   memset(&exprAnd, 0, sizeof(Expr));
4439db45bd5eSdrh 
4440db45bd5eSdrh   assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
4441db45bd5eSdrh   exprX = *pExpr->pLeft;
444236c563a2Sdrh   exprAnd.op = TK_AND;
444336c563a2Sdrh   exprAnd.pLeft = &compLeft;
444436c563a2Sdrh   exprAnd.pRight = &compRight;
444536c563a2Sdrh   compLeft.op = TK_GE;
4446db45bd5eSdrh   compLeft.pLeft = &exprX;
444736c563a2Sdrh   compLeft.pRight = pExpr->x.pList->a[0].pExpr;
444836c563a2Sdrh   compRight.op = TK_LE;
4449db45bd5eSdrh   compRight.pLeft = &exprX;
445036c563a2Sdrh   compRight.pRight = pExpr->x.pList->a[1].pExpr;
445112abf408Sdrh   exprToRegister(&exprX, exprCodeVector(pParse, &exprX, &regFree1));
445284b19a3dSdrh   if( xJump ){
445384b19a3dSdrh     xJump(pParse, &exprAnd, dest, jumpIfNull);
445436c563a2Sdrh   }else{
445536fd41e5Sdrh     /* Mark the expression is being from the ON or USING clause of a join
445636fd41e5Sdrh     ** so that the sqlite3ExprCodeTarget() routine will not attempt to move
445736fd41e5Sdrh     ** it into the Parse.pConstExpr list.  We should use a new bit for this,
445836fd41e5Sdrh     ** for clarity, but we are out of bits in the Expr.flags field so we
445936fd41e5Sdrh     ** have to reuse the EP_FromJoin bit.  Bummer. */
4460db45bd5eSdrh     exprX.flags |= EP_FromJoin;
446171c57db0Sdan     sqlite3ExprCodeTarget(pParse, &exprAnd, dest);
446236c563a2Sdrh   }
4463db45bd5eSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
446436c563a2Sdrh 
446536c563a2Sdrh   /* Ensure adequate test coverage */
4466db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull==0 && regFree1==0 );
4467db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull==0 && regFree1!=0 );
4468db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull!=0 && regFree1==0 );
4469db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull!=0 && regFree1!=0 );
4470db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1==0 );
4471db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1!=0 );
4472db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1==0 );
4473db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1!=0 );
447484b19a3dSdrh   testcase( xJump==0 );
447536c563a2Sdrh }
447636c563a2Sdrh 
447736c563a2Sdrh /*
4478cce7d176Sdrh ** Generate code for a boolean expression such that a jump is made
4479cce7d176Sdrh ** to the label "dest" if the expression is true but execution
4480cce7d176Sdrh ** continues straight thru if the expression is false.
4481f5905aa7Sdrh **
4482f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false), then
448335573356Sdrh ** take the jump if the jumpIfNull flag is SQLITE_JUMPIFNULL.
4484f2bc013cSdrh **
4485f2bc013cSdrh ** This code depends on the fact that certain token values (ex: TK_EQ)
4486f2bc013cSdrh ** are the same as opcode values (ex: OP_Eq) that implement the corresponding
4487f2bc013cSdrh ** operation.  Special comments in vdbe.c and the mkopcodeh.awk script in
4488f2bc013cSdrh ** the make process cause these values to align.  Assert()s in the code
4489f2bc013cSdrh ** below verify that the numbers are aligned correctly.
4490cce7d176Sdrh */
44914adee20fSdanielk1977 void sqlite3ExprIfTrue(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
4492cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
4493cce7d176Sdrh   int op = 0;
44942dcef11bSdrh   int regFree1 = 0;
44952dcef11bSdrh   int regFree2 = 0;
44962dcef11bSdrh   int r1, r2;
44972dcef11bSdrh 
449835573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
449948864df9Smistachkin   if( NEVER(v==0) )     return;  /* Existence of VDBE checked by caller */
450033cd4909Sdrh   if( NEVER(pExpr==0) ) return;  /* No way this can happen */
4501f2bc013cSdrh   op = pExpr->op;
45027b35a77bSdan   switch( op ){
4503cce7d176Sdrh     case TK_AND: {
45044adee20fSdanielk1977       int d2 = sqlite3VdbeMakeLabel(v);
4505c5499befSdrh       testcase( jumpIfNull==0 );
450635573356Sdrh       sqlite3ExprIfFalse(pParse, pExpr->pLeft, d2,jumpIfNull^SQLITE_JUMPIFNULL);
450754e2adb5Sdrh       sqlite3ExprCachePush(pParse);
45084adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
45094adee20fSdanielk1977       sqlite3VdbeResolveLabel(v, d2);
4510d2490904Sdrh       sqlite3ExprCachePop(pParse);
4511cce7d176Sdrh       break;
4512cce7d176Sdrh     }
4513cce7d176Sdrh     case TK_OR: {
4514c5499befSdrh       testcase( jumpIfNull==0 );
45154adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
451654e2adb5Sdrh       sqlite3ExprCachePush(pParse);
45174adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
4518d2490904Sdrh       sqlite3ExprCachePop(pParse);
4519cce7d176Sdrh       break;
4520cce7d176Sdrh     }
4521cce7d176Sdrh     case TK_NOT: {
4522c5499befSdrh       testcase( jumpIfNull==0 );
45234adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
4524cce7d176Sdrh       break;
4525cce7d176Sdrh     }
45268abed7b9Sdrh     case TK_TRUTH: {
452796acafbeSdrh       int isNot;      /* IS NOT TRUE or IS NOT FALSE */
452896acafbeSdrh       int isTrue;     /* IS TRUE or IS NOT TRUE */
4529007c843bSdrh       testcase( jumpIfNull==0 );
45308abed7b9Sdrh       isNot = pExpr->op2==TK_ISNOT;
453196acafbeSdrh       isTrue = sqlite3ExprTruthValue(pExpr->pRight);
453243c4ac8bSdrh       testcase( isTrue && isNot );
453396acafbeSdrh       testcase( !isTrue && isNot );
453443c4ac8bSdrh       if( isTrue ^ isNot ){
45358abed7b9Sdrh         sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
45368abed7b9Sdrh                           isNot ? SQLITE_JUMPIFNULL : 0);
45378abed7b9Sdrh       }else{
45388abed7b9Sdrh         sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
45398abed7b9Sdrh                            isNot ? SQLITE_JUMPIFNULL : 0);
45408abed7b9Sdrh       }
4541007c843bSdrh       break;
4542007c843bSdrh     }
4543de845c2fSdrh     case TK_IS:
4544de845c2fSdrh     case TK_ISNOT:
4545de845c2fSdrh       testcase( op==TK_IS );
4546de845c2fSdrh       testcase( op==TK_ISNOT );
4547de845c2fSdrh       op = (op==TK_IS) ? TK_EQ : TK_NE;
4548de845c2fSdrh       jumpIfNull = SQLITE_NULLEQ;
4549de845c2fSdrh       /* Fall thru */
4550cce7d176Sdrh     case TK_LT:
4551cce7d176Sdrh     case TK_LE:
4552cce7d176Sdrh     case TK_GT:
4553cce7d176Sdrh     case TK_GE:
4554cce7d176Sdrh     case TK_NE:
45550ac65892Sdrh     case TK_EQ: {
4556625015e0Sdan       if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
4557c5499befSdrh       testcase( jumpIfNull==0 );
4558b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4559b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
456035573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
45612dcef11bSdrh                   r1, r2, dest, jumpIfNull);
45627d176105Sdrh       assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
45637d176105Sdrh       assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
45647d176105Sdrh       assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
45657d176105Sdrh       assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
4566de845c2fSdrh       assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4567de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4568de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4569de845c2fSdrh       assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4570de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
4571de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
45726a2fe093Sdrh       testcase( regFree1==0 );
45736a2fe093Sdrh       testcase( regFree2==0 );
45746a2fe093Sdrh       break;
45756a2fe093Sdrh     }
4576cce7d176Sdrh     case TK_ISNULL:
4577cce7d176Sdrh     case TK_NOTNULL: {
45787d176105Sdrh       assert( TK_ISNULL==OP_IsNull );   testcase( op==TK_ISNULL );
45797d176105Sdrh       assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
45802dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
45812dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
45827d176105Sdrh       VdbeCoverageIf(v, op==TK_ISNULL);
45837d176105Sdrh       VdbeCoverageIf(v, op==TK_NOTNULL);
4584c5499befSdrh       testcase( regFree1==0 );
4585cce7d176Sdrh       break;
4586cce7d176Sdrh     }
4587fef5208cSdrh     case TK_BETWEEN: {
45885c03f30aSdrh       testcase( jumpIfNull==0 );
458971c57db0Sdan       exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfTrue, jumpIfNull);
4590fef5208cSdrh       break;
4591fef5208cSdrh     }
4592bb201344Sshaneh #ifndef SQLITE_OMIT_SUBQUERY
4593e3365e6cSdrh     case TK_IN: {
4594e3365e6cSdrh       int destIfFalse = sqlite3VdbeMakeLabel(v);
4595e3365e6cSdrh       int destIfNull = jumpIfNull ? dest : destIfFalse;
4596e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
4597076e85f5Sdrh       sqlite3VdbeGoto(v, dest);
4598e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
4599e3365e6cSdrh       break;
4600e3365e6cSdrh     }
4601bb201344Sshaneh #endif
4602cce7d176Sdrh     default: {
46037b35a77bSdan     default_expr:
4604991a1985Sdrh       if( exprAlwaysTrue(pExpr) ){
4605076e85f5Sdrh         sqlite3VdbeGoto(v, dest);
4606991a1985Sdrh       }else if( exprAlwaysFalse(pExpr) ){
4607991a1985Sdrh         /* No-op */
4608991a1985Sdrh       }else{
46092dcef11bSdrh         r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
46102dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_If, r1, dest, jumpIfNull!=0);
4611688852abSdrh         VdbeCoverage(v);
4612c5499befSdrh         testcase( regFree1==0 );
4613c5499befSdrh         testcase( jumpIfNull==0 );
4614991a1985Sdrh       }
4615cce7d176Sdrh       break;
4616cce7d176Sdrh     }
4617cce7d176Sdrh   }
46182dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
46192dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
4620cce7d176Sdrh }
4621cce7d176Sdrh 
4622cce7d176Sdrh /*
462366b89c8fSdrh ** Generate code for a boolean expression such that a jump is made
4624cce7d176Sdrh ** to the label "dest" if the expression is false but execution
4625cce7d176Sdrh ** continues straight thru if the expression is true.
4626f5905aa7Sdrh **
4627f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false) then
462835573356Sdrh ** jump if jumpIfNull is SQLITE_JUMPIFNULL or fall through if jumpIfNull
462935573356Sdrh ** is 0.
4630cce7d176Sdrh */
46314adee20fSdanielk1977 void sqlite3ExprIfFalse(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
4632cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
4633cce7d176Sdrh   int op = 0;
46342dcef11bSdrh   int regFree1 = 0;
46352dcef11bSdrh   int regFree2 = 0;
46362dcef11bSdrh   int r1, r2;
46372dcef11bSdrh 
463835573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
463948864df9Smistachkin   if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
464033cd4909Sdrh   if( pExpr==0 )    return;
4641f2bc013cSdrh 
4642f2bc013cSdrh   /* The value of pExpr->op and op are related as follows:
4643f2bc013cSdrh   **
4644f2bc013cSdrh   **       pExpr->op            op
4645f2bc013cSdrh   **       ---------          ----------
4646f2bc013cSdrh   **       TK_ISNULL          OP_NotNull
4647f2bc013cSdrh   **       TK_NOTNULL         OP_IsNull
4648f2bc013cSdrh   **       TK_NE              OP_Eq
4649f2bc013cSdrh   **       TK_EQ              OP_Ne
4650f2bc013cSdrh   **       TK_GT              OP_Le
4651f2bc013cSdrh   **       TK_LE              OP_Gt
4652f2bc013cSdrh   **       TK_GE              OP_Lt
4653f2bc013cSdrh   **       TK_LT              OP_Ge
4654f2bc013cSdrh   **
4655f2bc013cSdrh   ** For other values of pExpr->op, op is undefined and unused.
4656f2bc013cSdrh   ** The value of TK_ and OP_ constants are arranged such that we
4657f2bc013cSdrh   ** can compute the mapping above using the following expression.
4658f2bc013cSdrh   ** Assert()s verify that the computation is correct.
4659f2bc013cSdrh   */
4660f2bc013cSdrh   op = ((pExpr->op+(TK_ISNULL&1))^1)-(TK_ISNULL&1);
4661f2bc013cSdrh 
4662f2bc013cSdrh   /* Verify correct alignment of TK_ and OP_ constants
4663f2bc013cSdrh   */
4664f2bc013cSdrh   assert( pExpr->op!=TK_ISNULL || op==OP_NotNull );
4665f2bc013cSdrh   assert( pExpr->op!=TK_NOTNULL || op==OP_IsNull );
4666f2bc013cSdrh   assert( pExpr->op!=TK_NE || op==OP_Eq );
4667f2bc013cSdrh   assert( pExpr->op!=TK_EQ || op==OP_Ne );
4668f2bc013cSdrh   assert( pExpr->op!=TK_LT || op==OP_Ge );
4669f2bc013cSdrh   assert( pExpr->op!=TK_LE || op==OP_Gt );
4670f2bc013cSdrh   assert( pExpr->op!=TK_GT || op==OP_Le );
4671f2bc013cSdrh   assert( pExpr->op!=TK_GE || op==OP_Lt );
4672f2bc013cSdrh 
4673ba00e30aSdan   switch( pExpr->op ){
4674cce7d176Sdrh     case TK_AND: {
4675c5499befSdrh       testcase( jumpIfNull==0 );
46764adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
467754e2adb5Sdrh       sqlite3ExprCachePush(pParse);
46784adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
4679d2490904Sdrh       sqlite3ExprCachePop(pParse);
4680cce7d176Sdrh       break;
4681cce7d176Sdrh     }
4682cce7d176Sdrh     case TK_OR: {
46834adee20fSdanielk1977       int d2 = sqlite3VdbeMakeLabel(v);
4684c5499befSdrh       testcase( jumpIfNull==0 );
468535573356Sdrh       sqlite3ExprIfTrue(pParse, pExpr->pLeft, d2, jumpIfNull^SQLITE_JUMPIFNULL);
468654e2adb5Sdrh       sqlite3ExprCachePush(pParse);
46874adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
46884adee20fSdanielk1977       sqlite3VdbeResolveLabel(v, d2);
4689d2490904Sdrh       sqlite3ExprCachePop(pParse);
4690cce7d176Sdrh       break;
4691cce7d176Sdrh     }
4692cce7d176Sdrh     case TK_NOT: {
46935c03f30aSdrh       testcase( jumpIfNull==0 );
46944adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
4695cce7d176Sdrh       break;
4696cce7d176Sdrh     }
46978abed7b9Sdrh     case TK_TRUTH: {
469896acafbeSdrh       int isNot;   /* IS NOT TRUE or IS NOT FALSE */
469996acafbeSdrh       int isTrue;  /* IS TRUE or IS NOT TRUE */
47008abed7b9Sdrh       testcase( jumpIfNull==0 );
47018abed7b9Sdrh       isNot = pExpr->op2==TK_ISNOT;
470296acafbeSdrh       isTrue = sqlite3ExprTruthValue(pExpr->pRight);
470343c4ac8bSdrh       testcase( isTrue && isNot );
470496acafbeSdrh       testcase( !isTrue && isNot );
470543c4ac8bSdrh       if( isTrue ^ isNot ){
47068abed7b9Sdrh         /* IS TRUE and IS NOT FALSE */
47078abed7b9Sdrh         sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
47088abed7b9Sdrh                            isNot ? 0 : SQLITE_JUMPIFNULL);
47098abed7b9Sdrh 
47108abed7b9Sdrh       }else{
47118abed7b9Sdrh         /* IS FALSE and IS NOT TRUE */
47128abed7b9Sdrh         sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
47138abed7b9Sdrh                           isNot ? 0 : SQLITE_JUMPIFNULL);
47148abed7b9Sdrh       }
4715007c843bSdrh       break;
4716007c843bSdrh     }
4717de845c2fSdrh     case TK_IS:
4718de845c2fSdrh     case TK_ISNOT:
4719de845c2fSdrh       testcase( pExpr->op==TK_IS );
4720de845c2fSdrh       testcase( pExpr->op==TK_ISNOT );
4721de845c2fSdrh       op = (pExpr->op==TK_IS) ? TK_NE : TK_EQ;
4722de845c2fSdrh       jumpIfNull = SQLITE_NULLEQ;
4723de845c2fSdrh       /* Fall thru */
4724cce7d176Sdrh     case TK_LT:
4725cce7d176Sdrh     case TK_LE:
4726cce7d176Sdrh     case TK_GT:
4727cce7d176Sdrh     case TK_GE:
4728cce7d176Sdrh     case TK_NE:
4729cce7d176Sdrh     case TK_EQ: {
4730625015e0Sdan       if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
4731c5499befSdrh       testcase( jumpIfNull==0 );
4732b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4733b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
473435573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
47352dcef11bSdrh                   r1, r2, dest, jumpIfNull);
47367d176105Sdrh       assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
47377d176105Sdrh       assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
47387d176105Sdrh       assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
47397d176105Sdrh       assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
4740de845c2fSdrh       assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4741de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4742de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4743de845c2fSdrh       assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4744de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
4745de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
47466a2fe093Sdrh       testcase( regFree1==0 );
47476a2fe093Sdrh       testcase( regFree2==0 );
47486a2fe093Sdrh       break;
47496a2fe093Sdrh     }
4750cce7d176Sdrh     case TK_ISNULL:
4751cce7d176Sdrh     case TK_NOTNULL: {
47522dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
47532dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
47547d176105Sdrh       testcase( op==TK_ISNULL );   VdbeCoverageIf(v, op==TK_ISNULL);
47557d176105Sdrh       testcase( op==TK_NOTNULL );  VdbeCoverageIf(v, op==TK_NOTNULL);
4756c5499befSdrh       testcase( regFree1==0 );
4757cce7d176Sdrh       break;
4758cce7d176Sdrh     }
4759fef5208cSdrh     case TK_BETWEEN: {
47605c03f30aSdrh       testcase( jumpIfNull==0 );
476171c57db0Sdan       exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfFalse, jumpIfNull);
4762fef5208cSdrh       break;
4763fef5208cSdrh     }
4764bb201344Sshaneh #ifndef SQLITE_OMIT_SUBQUERY
4765e3365e6cSdrh     case TK_IN: {
4766e3365e6cSdrh       if( jumpIfNull ){
4767e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, dest);
4768e3365e6cSdrh       }else{
4769e3365e6cSdrh         int destIfNull = sqlite3VdbeMakeLabel(v);
4770e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, destIfNull);
4771e3365e6cSdrh         sqlite3VdbeResolveLabel(v, destIfNull);
4772e3365e6cSdrh       }
4773e3365e6cSdrh       break;
4774e3365e6cSdrh     }
4775bb201344Sshaneh #endif
4776cce7d176Sdrh     default: {
4777ba00e30aSdan     default_expr:
4778991a1985Sdrh       if( exprAlwaysFalse(pExpr) ){
4779076e85f5Sdrh         sqlite3VdbeGoto(v, dest);
4780991a1985Sdrh       }else if( exprAlwaysTrue(pExpr) ){
4781991a1985Sdrh         /* no-op */
4782991a1985Sdrh       }else{
47832dcef11bSdrh         r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
47842dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_IfNot, r1, dest, jumpIfNull!=0);
4785688852abSdrh         VdbeCoverage(v);
4786c5499befSdrh         testcase( regFree1==0 );
4787c5499befSdrh         testcase( jumpIfNull==0 );
4788991a1985Sdrh       }
4789cce7d176Sdrh       break;
4790cce7d176Sdrh     }
4791cce7d176Sdrh   }
47922dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
47932dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
4794cce7d176Sdrh }
47952282792aSdrh 
47962282792aSdrh /*
479772bc8208Sdrh ** Like sqlite3ExprIfFalse() except that a copy is made of pExpr before
479872bc8208Sdrh ** code generation, and that copy is deleted after code generation. This
479972bc8208Sdrh ** ensures that the original pExpr is unchanged.
480072bc8208Sdrh */
480172bc8208Sdrh void sqlite3ExprIfFalseDup(Parse *pParse, Expr *pExpr, int dest,int jumpIfNull){
480272bc8208Sdrh   sqlite3 *db = pParse->db;
480372bc8208Sdrh   Expr *pCopy = sqlite3ExprDup(db, pExpr, 0);
480472bc8208Sdrh   if( db->mallocFailed==0 ){
480572bc8208Sdrh     sqlite3ExprIfFalse(pParse, pCopy, dest, jumpIfNull);
480672bc8208Sdrh   }
480772bc8208Sdrh   sqlite3ExprDelete(db, pCopy);
480872bc8208Sdrh }
480972bc8208Sdrh 
48105aa550cfSdan /*
48115aa550cfSdan ** Expression pVar is guaranteed to be an SQL variable. pExpr may be any
48125aa550cfSdan ** type of expression.
48135aa550cfSdan **
48145aa550cfSdan ** If pExpr is a simple SQL value - an integer, real, string, blob
48155aa550cfSdan ** or NULL value - then the VDBE currently being prepared is configured
48165aa550cfSdan ** to re-prepare each time a new value is bound to variable pVar.
48175aa550cfSdan **
48185aa550cfSdan ** Additionally, if pExpr is a simple SQL value and the value is the
48195aa550cfSdan ** same as that currently bound to variable pVar, non-zero is returned.
48205aa550cfSdan ** Otherwise, if the values are not the same or if pExpr is not a simple
48215aa550cfSdan ** SQL value, zero is returned.
48225aa550cfSdan */
48235aa550cfSdan static int exprCompareVariable(Parse *pParse, Expr *pVar, Expr *pExpr){
48245aa550cfSdan   int res = 0;
4825c0804226Sdrh   int iVar;
4826c0804226Sdrh   sqlite3_value *pL, *pR = 0;
48275aa550cfSdan 
48285aa550cfSdan   sqlite3ValueFromExpr(pParse->db, pExpr, SQLITE_UTF8, SQLITE_AFF_BLOB, &pR);
4829c0804226Sdrh   if( pR ){
4830c0804226Sdrh     iVar = pVar->iColumn;
4831c0804226Sdrh     sqlite3VdbeSetVarmask(pParse->pVdbe, iVar);
4832c0804226Sdrh     pL = sqlite3VdbeGetBoundValue(pParse->pReprepare, iVar, SQLITE_AFF_BLOB);
48335aa307e2Sdrh     if( pL ){
48345aa307e2Sdrh       if( sqlite3_value_type(pL)==SQLITE_TEXT ){
48355aa307e2Sdrh         sqlite3_value_text(pL); /* Make sure the encoding is UTF-8 */
48365aa307e2Sdrh       }
48375aa307e2Sdrh       res =  0==sqlite3MemCompare(pL, pR, 0);
48385aa550cfSdan     }
48395aa550cfSdan     sqlite3ValueFree(pR);
48405aa550cfSdan     sqlite3ValueFree(pL);
48415aa550cfSdan   }
48425aa550cfSdan 
48435aa550cfSdan   return res;
48445aa550cfSdan }
484572bc8208Sdrh 
484672bc8208Sdrh /*
48471d9da70aSdrh ** Do a deep comparison of two expression trees.  Return 0 if the two
48481d9da70aSdrh ** expressions are completely identical.  Return 1 if they differ only
48491d9da70aSdrh ** by a COLLATE operator at the top level.  Return 2 if there are differences
48501d9da70aSdrh ** other than the top-level COLLATE operator.
4851d40aab0eSdrh **
4852619a1305Sdrh ** If any subelement of pB has Expr.iTable==(-1) then it is allowed
4853619a1305Sdrh ** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
4854619a1305Sdrh **
485566518ca7Sdrh ** The pA side might be using TK_REGISTER.  If that is the case and pB is
485666518ca7Sdrh ** not using TK_REGISTER but is otherwise equivalent, then still return 0.
485766518ca7Sdrh **
48581d9da70aSdrh ** Sometimes this routine will return 2 even if the two expressions
4859d40aab0eSdrh ** really are equivalent.  If we cannot prove that the expressions are
48601d9da70aSdrh ** identical, we return 2 just to be safe.  So if this routine
48611d9da70aSdrh ** returns 2, then you do not really know for certain if the two
48621d9da70aSdrh ** expressions are the same.  But if you get a 0 or 1 return, then you
4863d40aab0eSdrh ** can be sure the expressions are the same.  In the places where
48641d9da70aSdrh ** this routine is used, it does not hurt to get an extra 2 - that
4865d40aab0eSdrh ** just might result in some slightly slower code.  But returning
48661d9da70aSdrh ** an incorrect 0 or 1 could lead to a malfunction.
48675aa550cfSdan **
4868c0804226Sdrh ** If pParse is not NULL then TK_VARIABLE terms in pA with bindings in
4869c0804226Sdrh ** pParse->pReprepare can be matched against literals in pB.  The
4870c0804226Sdrh ** pParse->pVdbe->expmask bitmask is updated for each variable referenced.
4871c0804226Sdrh ** If pParse is NULL (the normal case) then any TK_VARIABLE term in
4872c0804226Sdrh ** Argument pParse should normally be NULL. If it is not NULL and pA or
4873c0804226Sdrh ** pB causes a return value of 2.
48742282792aSdrh */
48755aa550cfSdan int sqlite3ExprCompare(Parse *pParse, Expr *pA, Expr *pB, int iTab){
487610d1edf0Sdrh   u32 combinedFlags;
48774b202ae2Sdanielk1977   if( pA==0 || pB==0 ){
48781d9da70aSdrh     return pB==pA ? 0 : 2;
48792282792aSdrh   }
48805aa550cfSdan   if( pParse && pA->op==TK_VARIABLE && exprCompareVariable(pParse, pA, pB) ){
48815aa550cfSdan     return 0;
48825aa550cfSdan   }
488310d1edf0Sdrh   combinedFlags = pA->flags | pB->flags;
488410d1edf0Sdrh   if( combinedFlags & EP_IntValue ){
488510d1edf0Sdrh     if( (pA->flags&pB->flags&EP_IntValue)!=0 && pA->u.iValue==pB->u.iValue ){
488610d1edf0Sdrh       return 0;
488710d1edf0Sdrh     }
48881d9da70aSdrh     return 2;
48896ab3a2ecSdanielk1977   }
4890c2acc4e4Sdrh   if( pA->op!=pB->op ){
48915aa550cfSdan     if( pA->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA->pLeft,pB,iTab)<2 ){
4892ae80ddeaSdrh       return 1;
4893ae80ddeaSdrh     }
48945aa550cfSdan     if( pB->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA,pB->pLeft,iTab)<2 ){
4895ae80ddeaSdrh       return 1;
4896ae80ddeaSdrh     }
4897ae80ddeaSdrh     return 2;
4898ae80ddeaSdrh   }
48992edc5fd7Sdrh   if( pA->op!=TK_COLUMN && pA->op!=TK_AGG_COLUMN && pA->u.zToken ){
4900390b88a4Sdrh     if( pA->op==TK_FUNCTION ){
4901390b88a4Sdrh       if( sqlite3StrICmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
4902390b88a4Sdrh     }else if( strcmp(pA->u.zToken,pB->u.zToken)!=0 ){
490310d1edf0Sdrh       return pA->op==TK_COLLATE ? 1 : 2;
490410d1edf0Sdrh     }
490510d1edf0Sdrh   }
490610d1edf0Sdrh   if( (pA->flags & EP_Distinct)!=(pB->flags & EP_Distinct) ) return 2;
490785f8aa79Sdrh   if( ALWAYS((combinedFlags & EP_TokenOnly)==0) ){
490810d1edf0Sdrh     if( combinedFlags & EP_xIsSelect ) return 2;
49095aa550cfSdan     if( sqlite3ExprCompare(pParse, pA->pLeft, pB->pLeft, iTab) ) return 2;
49105aa550cfSdan     if( sqlite3ExprCompare(pParse, pA->pRight, pB->pRight, iTab) ) return 2;
4911619a1305Sdrh     if( sqlite3ExprListCompare(pA->x.pList, pB->x.pList, iTab) ) return 2;
49127693c42fSdrh     if( ALWAYS((combinedFlags & EP_Reduced)==0) && pA->op!=TK_STRING ){
4913619a1305Sdrh       if( pA->iColumn!=pB->iColumn ) return 2;
491466518ca7Sdrh       if( pA->iTable!=pB->iTable
491585f8aa79Sdrh        && (pA->iTable!=iTab || NEVER(pB->iTable>=0)) ) return 2;
49161d9da70aSdrh     }
49171d9da70aSdrh   }
49182646da7eSdrh   return 0;
49192646da7eSdrh }
49202282792aSdrh 
49218c6f666bSdrh /*
49228c6f666bSdrh ** Compare two ExprList objects.  Return 0 if they are identical and
49238c6f666bSdrh ** non-zero if they differ in any way.
49248c6f666bSdrh **
4925619a1305Sdrh ** If any subelement of pB has Expr.iTable==(-1) then it is allowed
4926619a1305Sdrh ** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
4927619a1305Sdrh **
49288c6f666bSdrh ** This routine might return non-zero for equivalent ExprLists.  The
49298c6f666bSdrh ** only consequence will be disabled optimizations.  But this routine
49308c6f666bSdrh ** must never return 0 if the two ExprList objects are different, or
49318c6f666bSdrh ** a malfunction will result.
49328c6f666bSdrh **
49338c6f666bSdrh ** Two NULL pointers are considered to be the same.  But a NULL pointer
49348c6f666bSdrh ** always differs from a non-NULL pointer.
49358c6f666bSdrh */
4936619a1305Sdrh int sqlite3ExprListCompare(ExprList *pA, ExprList *pB, int iTab){
49378c6f666bSdrh   int i;
49388c6f666bSdrh   if( pA==0 && pB==0 ) return 0;
49398c6f666bSdrh   if( pA==0 || pB==0 ) return 1;
49408c6f666bSdrh   if( pA->nExpr!=pB->nExpr ) return 1;
49418c6f666bSdrh   for(i=0; i<pA->nExpr; i++){
49428c6f666bSdrh     Expr *pExprA = pA->a[i].pExpr;
49438c6f666bSdrh     Expr *pExprB = pB->a[i].pExpr;
49448c6f666bSdrh     if( pA->a[i].sortOrder!=pB->a[i].sortOrder ) return 1;
49455aa550cfSdan     if( sqlite3ExprCompare(0, pExprA, pExprB, iTab) ) return 1;
49468c6f666bSdrh   }
49478c6f666bSdrh   return 0;
49488c6f666bSdrh }
494913449892Sdrh 
49502282792aSdrh /*
4951f9463dfbSdrh ** Like sqlite3ExprCompare() except COLLATE operators at the top-level
4952f9463dfbSdrh ** are ignored.
4953f9463dfbSdrh */
4954f9463dfbSdrh int sqlite3ExprCompareSkip(Expr *pA, Expr *pB, int iTab){
49555aa550cfSdan   return sqlite3ExprCompare(0,
4956f9463dfbSdrh              sqlite3ExprSkipCollate(pA),
4957f9463dfbSdrh              sqlite3ExprSkipCollate(pB),
4958f9463dfbSdrh              iTab);
4959f9463dfbSdrh }
4960f9463dfbSdrh 
4961f9463dfbSdrh /*
49624bd5f73fSdrh ** Return true if we can prove the pE2 will always be true if pE1 is
49634bd5f73fSdrh ** true.  Return false if we cannot complete the proof or if pE2 might
49644bd5f73fSdrh ** be false.  Examples:
49654bd5f73fSdrh **
4966619a1305Sdrh **     pE1: x==5       pE2: x==5             Result: true
49674bd5f73fSdrh **     pE1: x>0        pE2: x==5             Result: false
4968619a1305Sdrh **     pE1: x=21       pE2: x=21 OR y=43     Result: true
49694bd5f73fSdrh **     pE1: x!=123     pE2: x IS NOT NULL    Result: true
4970619a1305Sdrh **     pE1: x!=?1      pE2: x IS NOT NULL    Result: true
4971619a1305Sdrh **     pE1: x IS NULL  pE2: x IS NOT NULL    Result: false
4972619a1305Sdrh **     pE1: x IS ?2    pE2: x IS NOT NULL    Reuslt: false
49734bd5f73fSdrh **
49744bd5f73fSdrh ** When comparing TK_COLUMN nodes between pE1 and pE2, if pE2 has
49754bd5f73fSdrh ** Expr.iTable<0 then assume a table number given by iTab.
49764bd5f73fSdrh **
4977c0804226Sdrh ** If pParse is not NULL, then the values of bound variables in pE1 are
4978c0804226Sdrh ** compared against literal values in pE2 and pParse->pVdbe->expmask is
4979c0804226Sdrh ** modified to record which bound variables are referenced.  If pParse
4980c0804226Sdrh ** is NULL, then false will be returned if pE1 contains any bound variables.
4981c0804226Sdrh **
49824bd5f73fSdrh ** When in doubt, return false.  Returning true might give a performance
49834bd5f73fSdrh ** improvement.  Returning false might cause a performance reduction, but
49844bd5f73fSdrh ** it will always give the correct answer and is hence always safe.
49854bd5f73fSdrh */
49865aa550cfSdan int sqlite3ExprImpliesExpr(Parse *pParse, Expr *pE1, Expr *pE2, int iTab){
49875aa550cfSdan   if( sqlite3ExprCompare(pParse, pE1, pE2, iTab)==0 ){
4988619a1305Sdrh     return 1;
4989619a1305Sdrh   }
4990619a1305Sdrh   if( pE2->op==TK_OR
49915aa550cfSdan    && (sqlite3ExprImpliesExpr(pParse, pE1, pE2->pLeft, iTab)
49925aa550cfSdan              || sqlite3ExprImpliesExpr(pParse, pE1, pE2->pRight, iTab) )
4993619a1305Sdrh   ){
4994619a1305Sdrh     return 1;
4995619a1305Sdrh   }
49961ad93a00Sdrh   if( pE2->op==TK_NOTNULL && pE1->op!=TK_ISNULL && pE1->op!=TK_IS ){
49971ad93a00Sdrh     Expr *pX = sqlite3ExprSkipCollate(pE1->pLeft);
49981ad93a00Sdrh     testcase( pX!=pE1->pLeft );
49995aa550cfSdan     if( sqlite3ExprCompare(pParse, pX, pE2->pLeft, iTab)==0 ) return 1;
5000619a1305Sdrh   }
5001619a1305Sdrh   return 0;
50024bd5f73fSdrh }
50034bd5f73fSdrh 
50044bd5f73fSdrh /*
50052589787cSdrh ** This is the Expr node callback for sqlite3ExprImpliesNotNullRow().
50062589787cSdrh ** If the expression node requires that the table at pWalker->iCur
50072589787cSdrh ** have a non-NULL column, then set pWalker->eCode to 1 and abort.
50082589787cSdrh */
50092589787cSdrh static int impliesNotNullRow(Walker *pWalker, Expr *pExpr){
5010821b610bSdrh   /* This routine is only called for WHERE clause expressions and so it
5011821b610bSdrh   ** cannot have any TK_AGG_COLUMN entries because those are only found
5012821b610bSdrh   ** in HAVING clauses.  We can get a TK_AGG_FUNCTION in a WHERE clause,
5013821b610bSdrh   ** but that is an illegal construct and the query will be rejected at
5014821b610bSdrh   ** a later stage of processing, so the TK_AGG_FUNCTION case does not
5015821b610bSdrh   ** need to be considered here. */
5016821b610bSdrh   assert( pExpr->op!=TK_AGG_COLUMN );
5017821b610bSdrh   testcase( pExpr->op==TK_AGG_FUNCTION );
5018821b610bSdrh 
50192589787cSdrh   if( ExprHasProperty(pExpr, EP_FromJoin) ) return WRC_Prune;
50202589787cSdrh   switch( pExpr->op ){
5021*a1054dccSdan     case TK_NOT:
50222589787cSdrh     case TK_ISNULL:
50232589787cSdrh     case TK_IS:
50242589787cSdrh     case TK_OR:
50252c492061Sdrh     case TK_CASE:
5026e3eff266Sdrh     case TK_IN:
50272589787cSdrh     case TK_FUNCTION:
5028821b610bSdrh       testcase( pExpr->op==TK_ISNULL );
5029821b610bSdrh       testcase( pExpr->op==TK_IS );
5030821b610bSdrh       testcase( pExpr->op==TK_OR );
5031821b610bSdrh       testcase( pExpr->op==TK_CASE );
5032821b610bSdrh       testcase( pExpr->op==TK_IN );
5033821b610bSdrh       testcase( pExpr->op==TK_FUNCTION );
50342589787cSdrh       return WRC_Prune;
50352589787cSdrh     case TK_COLUMN:
50362589787cSdrh       if( pWalker->u.iCur==pExpr->iTable ){
50372589787cSdrh         pWalker->eCode = 1;
50382589787cSdrh         return WRC_Abort;
50392589787cSdrh       }
50402589787cSdrh       return WRC_Prune;
50419881155dSdrh 
50429881155dSdrh     /* Virtual tables are allowed to use constraints like x=NULL.  So
50439881155dSdrh     ** a term of the form x=y does not prove that y is not null if x
50449881155dSdrh     ** is the column of a virtual table */
50459881155dSdrh     case TK_EQ:
50469881155dSdrh     case TK_NE:
50479881155dSdrh     case TK_LT:
50489881155dSdrh     case TK_LE:
50499881155dSdrh     case TK_GT:
50509881155dSdrh     case TK_GE:
50519881155dSdrh       testcase( pExpr->op==TK_EQ );
50529881155dSdrh       testcase( pExpr->op==TK_NE );
50539881155dSdrh       testcase( pExpr->op==TK_LT );
50549881155dSdrh       testcase( pExpr->op==TK_LE );
50559881155dSdrh       testcase( pExpr->op==TK_GT );
50569881155dSdrh       testcase( pExpr->op==TK_GE );
50579881155dSdrh       if( (pExpr->pLeft->op==TK_COLUMN && IsVirtual(pExpr->pLeft->pTab))
50589881155dSdrh        || (pExpr->pRight->op==TK_COLUMN && IsVirtual(pExpr->pRight->pTab))
50599881155dSdrh       ){
50609881155dSdrh        return WRC_Prune;
50619881155dSdrh       }
50622589787cSdrh     default:
50632589787cSdrh       return WRC_Continue;
50642589787cSdrh   }
50652589787cSdrh }
50662589787cSdrh 
50672589787cSdrh /*
50682589787cSdrh ** Return true (non-zero) if expression p can only be true if at least
50692589787cSdrh ** one column of table iTab is non-null.  In other words, return true
50702589787cSdrh ** if expression p will always be NULL or false if every column of iTab
50712589787cSdrh ** is NULL.
50722589787cSdrh **
5073821b610bSdrh ** False negatives are acceptable.  In other words, it is ok to return
5074821b610bSdrh ** zero even if expression p will never be true of every column of iTab
5075821b610bSdrh ** is NULL.  A false negative is merely a missed optimization opportunity.
5076821b610bSdrh **
5077821b610bSdrh ** False positives are not allowed, however.  A false positive may result
5078821b610bSdrh ** in an incorrect answer.
5079821b610bSdrh **
50802589787cSdrh ** Terms of p that are marked with EP_FromJoin (and hence that come from
50812589787cSdrh ** the ON or USING clauses of LEFT JOINS) are excluded from the analysis.
50822589787cSdrh **
50832589787cSdrh ** This routine is used to check if a LEFT JOIN can be converted into
50842589787cSdrh ** an ordinary JOIN.  The p argument is the WHERE clause.  If the WHERE
50852589787cSdrh ** clause requires that some column of the right table of the LEFT JOIN
50862589787cSdrh ** be non-NULL, then the LEFT JOIN can be safely converted into an
50872589787cSdrh ** ordinary join.
50882589787cSdrh */
50892589787cSdrh int sqlite3ExprImpliesNonNullRow(Expr *p, int iTab){
50902589787cSdrh   Walker w;
50912589787cSdrh   w.xExprCallback = impliesNotNullRow;
50922589787cSdrh   w.xSelectCallback = 0;
50932589787cSdrh   w.xSelectCallback2 = 0;
50942589787cSdrh   w.eCode = 0;
50952589787cSdrh   w.u.iCur = iTab;
50962589787cSdrh   sqlite3WalkExpr(&w, p);
50972589787cSdrh   return w.eCode;
50982589787cSdrh }
50992589787cSdrh 
51002589787cSdrh /*
5101030796dfSdrh ** An instance of the following structure is used by the tree walker
51022409f8a1Sdrh ** to determine if an expression can be evaluated by reference to the
51032409f8a1Sdrh ** index only, without having to do a search for the corresponding
51042409f8a1Sdrh ** table entry.  The IdxCover.pIdx field is the index.  IdxCover.iCur
51052409f8a1Sdrh ** is the cursor for the table.
51062409f8a1Sdrh */
51072409f8a1Sdrh struct IdxCover {
51082409f8a1Sdrh   Index *pIdx;     /* The index to be tested for coverage */
51092409f8a1Sdrh   int iCur;        /* Cursor number for the table corresponding to the index */
51102409f8a1Sdrh };
51112409f8a1Sdrh 
51122409f8a1Sdrh /*
51132409f8a1Sdrh ** Check to see if there are references to columns in table
51142409f8a1Sdrh ** pWalker->u.pIdxCover->iCur can be satisfied using the index
51152409f8a1Sdrh ** pWalker->u.pIdxCover->pIdx.
51162409f8a1Sdrh */
51172409f8a1Sdrh static int exprIdxCover(Walker *pWalker, Expr *pExpr){
51182409f8a1Sdrh   if( pExpr->op==TK_COLUMN
51192409f8a1Sdrh    && pExpr->iTable==pWalker->u.pIdxCover->iCur
51202409f8a1Sdrh    && sqlite3ColumnOfIndex(pWalker->u.pIdxCover->pIdx, pExpr->iColumn)<0
51212409f8a1Sdrh   ){
51222409f8a1Sdrh     pWalker->eCode = 1;
51232409f8a1Sdrh     return WRC_Abort;
51242409f8a1Sdrh   }
51252409f8a1Sdrh   return WRC_Continue;
51262409f8a1Sdrh }
51272409f8a1Sdrh 
51282409f8a1Sdrh /*
5129e604ec0bSdrh ** Determine if an index pIdx on table with cursor iCur contains will
5130e604ec0bSdrh ** the expression pExpr.  Return true if the index does cover the
5131e604ec0bSdrh ** expression and false if the pExpr expression references table columns
5132e604ec0bSdrh ** that are not found in the index pIdx.
51332409f8a1Sdrh **
51342409f8a1Sdrh ** An index covering an expression means that the expression can be
51352409f8a1Sdrh ** evaluated using only the index and without having to lookup the
51362409f8a1Sdrh ** corresponding table entry.
51372409f8a1Sdrh */
51382409f8a1Sdrh int sqlite3ExprCoveredByIndex(
51392409f8a1Sdrh   Expr *pExpr,        /* The index to be tested */
51402409f8a1Sdrh   int iCur,           /* The cursor number for the corresponding table */
51412409f8a1Sdrh   Index *pIdx         /* The index that might be used for coverage */
51422409f8a1Sdrh ){
51432409f8a1Sdrh   Walker w;
51442409f8a1Sdrh   struct IdxCover xcov;
51452409f8a1Sdrh   memset(&w, 0, sizeof(w));
51462409f8a1Sdrh   xcov.iCur = iCur;
51472409f8a1Sdrh   xcov.pIdx = pIdx;
51482409f8a1Sdrh   w.xExprCallback = exprIdxCover;
51492409f8a1Sdrh   w.u.pIdxCover = &xcov;
51502409f8a1Sdrh   sqlite3WalkExpr(&w, pExpr);
51512409f8a1Sdrh   return !w.eCode;
51522409f8a1Sdrh }
51532409f8a1Sdrh 
51542409f8a1Sdrh 
51552409f8a1Sdrh /*
51562409f8a1Sdrh ** An instance of the following structure is used by the tree walker
5157030796dfSdrh ** to count references to table columns in the arguments of an
5158ed551b95Sdrh ** aggregate function, in order to implement the
5159ed551b95Sdrh ** sqlite3FunctionThisSrc() routine.
5160374fdce4Sdrh */
5161030796dfSdrh struct SrcCount {
5162030796dfSdrh   SrcList *pSrc;   /* One particular FROM clause in a nested query */
5163030796dfSdrh   int nThis;       /* Number of references to columns in pSrcList */
5164030796dfSdrh   int nOther;      /* Number of references to columns in other FROM clauses */
5165030796dfSdrh };
5166030796dfSdrh 
5167030796dfSdrh /*
5168030796dfSdrh ** Count the number of references to columns.
5169030796dfSdrh */
5170030796dfSdrh static int exprSrcCount(Walker *pWalker, Expr *pExpr){
5171fb0a6081Sdrh   /* The NEVER() on the second term is because sqlite3FunctionUsesThisSrc()
5172fb0a6081Sdrh   ** is always called before sqlite3ExprAnalyzeAggregates() and so the
5173fb0a6081Sdrh   ** TK_COLUMNs have not yet been converted into TK_AGG_COLUMN.  If
5174fb0a6081Sdrh   ** sqlite3FunctionUsesThisSrc() is used differently in the future, the
5175fb0a6081Sdrh   ** NEVER() will need to be removed. */
5176fb0a6081Sdrh   if( pExpr->op==TK_COLUMN || NEVER(pExpr->op==TK_AGG_COLUMN) ){
5177374fdce4Sdrh     int i;
5178030796dfSdrh     struct SrcCount *p = pWalker->u.pSrcCount;
5179030796dfSdrh     SrcList *pSrc = p->pSrc;
5180655814d2Sdrh     int nSrc = pSrc ? pSrc->nSrc : 0;
5181655814d2Sdrh     for(i=0; i<nSrc; i++){
5182030796dfSdrh       if( pExpr->iTable==pSrc->a[i].iCursor ) break;
5183374fdce4Sdrh     }
5184655814d2Sdrh     if( i<nSrc ){
5185030796dfSdrh       p->nThis++;
5186374fdce4Sdrh     }else{
5187030796dfSdrh       p->nOther++;
5188374fdce4Sdrh     }
5189374fdce4Sdrh   }
5190030796dfSdrh   return WRC_Continue;
5191030796dfSdrh }
5192374fdce4Sdrh 
5193374fdce4Sdrh /*
5194030796dfSdrh ** Determine if any of the arguments to the pExpr Function reference
5195030796dfSdrh ** pSrcList.  Return true if they do.  Also return true if the function
5196030796dfSdrh ** has no arguments or has only constant arguments.  Return false if pExpr
5197030796dfSdrh ** references columns but not columns of tables found in pSrcList.
5198374fdce4Sdrh */
5199030796dfSdrh int sqlite3FunctionUsesThisSrc(Expr *pExpr, SrcList *pSrcList){
5200374fdce4Sdrh   Walker w;
5201030796dfSdrh   struct SrcCount cnt;
5202374fdce4Sdrh   assert( pExpr->op==TK_AGG_FUNCTION );
5203030796dfSdrh   w.xExprCallback = exprSrcCount;
5204979dd1beSdrh   w.xSelectCallback = 0;
5205030796dfSdrh   w.u.pSrcCount = &cnt;
5206030796dfSdrh   cnt.pSrc = pSrcList;
5207030796dfSdrh   cnt.nThis = 0;
5208030796dfSdrh   cnt.nOther = 0;
5209030796dfSdrh   sqlite3WalkExprList(&w, pExpr->x.pList);
5210030796dfSdrh   return cnt.nThis>0 || cnt.nOther==0;
5211374fdce4Sdrh }
5212374fdce4Sdrh 
5213374fdce4Sdrh /*
521413449892Sdrh ** Add a new element to the pAggInfo->aCol[] array.  Return the index of
521513449892Sdrh ** the new element.  Return a negative number if malloc fails.
52162282792aSdrh */
521717435752Sdrh static int addAggInfoColumn(sqlite3 *db, AggInfo *pInfo){
521813449892Sdrh   int i;
5219cf643729Sdrh   pInfo->aCol = sqlite3ArrayAllocate(
522017435752Sdrh        db,
5221cf643729Sdrh        pInfo->aCol,
5222cf643729Sdrh        sizeof(pInfo->aCol[0]),
5223cf643729Sdrh        &pInfo->nColumn,
5224cf643729Sdrh        &i
5225cf643729Sdrh   );
522613449892Sdrh   return i;
52272282792aSdrh }
522813449892Sdrh 
522913449892Sdrh /*
523013449892Sdrh ** Add a new element to the pAggInfo->aFunc[] array.  Return the index of
523113449892Sdrh ** the new element.  Return a negative number if malloc fails.
523213449892Sdrh */
523317435752Sdrh static int addAggInfoFunc(sqlite3 *db, AggInfo *pInfo){
523413449892Sdrh   int i;
5235cf643729Sdrh   pInfo->aFunc = sqlite3ArrayAllocate(
523617435752Sdrh        db,
5237cf643729Sdrh        pInfo->aFunc,
5238cf643729Sdrh        sizeof(pInfo->aFunc[0]),
5239cf643729Sdrh        &pInfo->nFunc,
5240cf643729Sdrh        &i
5241cf643729Sdrh   );
524213449892Sdrh   return i;
52432282792aSdrh }
52442282792aSdrh 
52452282792aSdrh /*
52467d10d5a6Sdrh ** This is the xExprCallback for a tree walker.  It is used to
52477d10d5a6Sdrh ** implement sqlite3ExprAnalyzeAggregates().  See sqlite3ExprAnalyzeAggregates
5248626a879aSdrh ** for additional information.
52492282792aSdrh */
52507d10d5a6Sdrh static int analyzeAggregate(Walker *pWalker, Expr *pExpr){
52512282792aSdrh   int i;
52527d10d5a6Sdrh   NameContext *pNC = pWalker->u.pNC;
5253a58fdfb1Sdanielk1977   Parse *pParse = pNC->pParse;
5254a58fdfb1Sdanielk1977   SrcList *pSrcList = pNC->pSrcList;
525513449892Sdrh   AggInfo *pAggInfo = pNC->pAggInfo;
525613449892Sdrh 
52572282792aSdrh   switch( pExpr->op ){
525889c69d00Sdrh     case TK_AGG_COLUMN:
5259967e8b73Sdrh     case TK_COLUMN: {
52608b213899Sdrh       testcase( pExpr->op==TK_AGG_COLUMN );
52618b213899Sdrh       testcase( pExpr->op==TK_COLUMN );
526213449892Sdrh       /* Check to see if the column is in one of the tables in the FROM
526313449892Sdrh       ** clause of the aggregate query */
526420bc393cSdrh       if( ALWAYS(pSrcList!=0) ){
526513449892Sdrh         struct SrcList_item *pItem = pSrcList->a;
526613449892Sdrh         for(i=0; i<pSrcList->nSrc; i++, pItem++){
526713449892Sdrh           struct AggInfo_col *pCol;
5268c5cd1249Sdrh           assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
526913449892Sdrh           if( pExpr->iTable==pItem->iCursor ){
527013449892Sdrh             /* If we reach this point, it means that pExpr refers to a table
527113449892Sdrh             ** that is in the FROM clause of the aggregate query.
527213449892Sdrh             **
527313449892Sdrh             ** Make an entry for the column in pAggInfo->aCol[] if there
527413449892Sdrh             ** is not an entry there already.
527513449892Sdrh             */
52767f906d63Sdrh             int k;
527713449892Sdrh             pCol = pAggInfo->aCol;
52787f906d63Sdrh             for(k=0; k<pAggInfo->nColumn; k++, pCol++){
527913449892Sdrh               if( pCol->iTable==pExpr->iTable &&
528013449892Sdrh                   pCol->iColumn==pExpr->iColumn ){
52812282792aSdrh                 break;
52822282792aSdrh               }
52832282792aSdrh             }
52841e536953Sdanielk1977             if( (k>=pAggInfo->nColumn)
52851e536953Sdanielk1977              && (k = addAggInfoColumn(pParse->db, pAggInfo))>=0
52861e536953Sdanielk1977             ){
52877f906d63Sdrh               pCol = &pAggInfo->aCol[k];
52880817d0dfSdanielk1977               pCol->pTab = pExpr->pTab;
528913449892Sdrh               pCol->iTable = pExpr->iTable;
529013449892Sdrh               pCol->iColumn = pExpr->iColumn;
52910a07c107Sdrh               pCol->iMem = ++pParse->nMem;
529213449892Sdrh               pCol->iSorterColumn = -1;
52935774b806Sdrh               pCol->pExpr = pExpr;
529413449892Sdrh               if( pAggInfo->pGroupBy ){
529513449892Sdrh                 int j, n;
529613449892Sdrh                 ExprList *pGB = pAggInfo->pGroupBy;
529713449892Sdrh                 struct ExprList_item *pTerm = pGB->a;
529813449892Sdrh                 n = pGB->nExpr;
529913449892Sdrh                 for(j=0; j<n; j++, pTerm++){
530013449892Sdrh                   Expr *pE = pTerm->pExpr;
530113449892Sdrh                   if( pE->op==TK_COLUMN && pE->iTable==pExpr->iTable &&
530213449892Sdrh                       pE->iColumn==pExpr->iColumn ){
530313449892Sdrh                     pCol->iSorterColumn = j;
530413449892Sdrh                     break;
53052282792aSdrh                   }
530613449892Sdrh                 }
530713449892Sdrh               }
530813449892Sdrh               if( pCol->iSorterColumn<0 ){
530913449892Sdrh                 pCol->iSorterColumn = pAggInfo->nSortingColumn++;
531013449892Sdrh               }
531113449892Sdrh             }
531213449892Sdrh             /* There is now an entry for pExpr in pAggInfo->aCol[] (either
531313449892Sdrh             ** because it was there before or because we just created it).
531413449892Sdrh             ** Convert the pExpr to be a TK_AGG_COLUMN referring to that
531513449892Sdrh             ** pAggInfo->aCol[] entry.
531613449892Sdrh             */
5317ebb6a65dSdrh             ExprSetVVAProperty(pExpr, EP_NoReduce);
531813449892Sdrh             pExpr->pAggInfo = pAggInfo;
531913449892Sdrh             pExpr->op = TK_AGG_COLUMN;
5320cf697396Sshane             pExpr->iAgg = (i16)k;
532113449892Sdrh             break;
532213449892Sdrh           } /* endif pExpr->iTable==pItem->iCursor */
532313449892Sdrh         } /* end loop over pSrcList */
5324a58fdfb1Sdanielk1977       }
53257d10d5a6Sdrh       return WRC_Prune;
53262282792aSdrh     }
53272282792aSdrh     case TK_AGG_FUNCTION: {
53283a8c4be7Sdrh       if( (pNC->ncFlags & NC_InAggFunc)==0
5329ed551b95Sdrh        && pWalker->walkerDepth==pExpr->op2
53303a8c4be7Sdrh       ){
533113449892Sdrh         /* Check to see if pExpr is a duplicate of another aggregate
533213449892Sdrh         ** function that is already in the pAggInfo structure
533313449892Sdrh         */
533413449892Sdrh         struct AggInfo_func *pItem = pAggInfo->aFunc;
533513449892Sdrh         for(i=0; i<pAggInfo->nFunc; i++, pItem++){
53365aa550cfSdan           if( sqlite3ExprCompare(0, pItem->pExpr, pExpr, -1)==0 ){
53372282792aSdrh             break;
53382282792aSdrh           }
53392282792aSdrh         }
534013449892Sdrh         if( i>=pAggInfo->nFunc ){
534113449892Sdrh           /* pExpr is original.  Make a new entry in pAggInfo->aFunc[]
534213449892Sdrh           */
534314db2665Sdanielk1977           u8 enc = ENC(pParse->db);
53441e536953Sdanielk1977           i = addAggInfoFunc(pParse->db, pAggInfo);
534513449892Sdrh           if( i>=0 ){
53466ab3a2ecSdanielk1977             assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
534713449892Sdrh             pItem = &pAggInfo->aFunc[i];
534813449892Sdrh             pItem->pExpr = pExpr;
53490a07c107Sdrh             pItem->iMem = ++pParse->nMem;
535033e619fcSdrh             assert( !ExprHasProperty(pExpr, EP_IntValue) );
535113449892Sdrh             pItem->pFunc = sqlite3FindFunction(pParse->db,
535280738d9cSdrh                    pExpr->u.zToken,
53536ab3a2ecSdanielk1977                    pExpr->x.pList ? pExpr->x.pList->nExpr : 0, enc, 0);
5354fd357974Sdrh             if( pExpr->flags & EP_Distinct ){
5355fd357974Sdrh               pItem->iDistinct = pParse->nTab++;
5356fd357974Sdrh             }else{
5357fd357974Sdrh               pItem->iDistinct = -1;
5358fd357974Sdrh             }
53592282792aSdrh           }
536013449892Sdrh         }
536113449892Sdrh         /* Make pExpr point to the appropriate pAggInfo->aFunc[] entry
536213449892Sdrh         */
5363c5cd1249Sdrh         assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
5364ebb6a65dSdrh         ExprSetVVAProperty(pExpr, EP_NoReduce);
5365cf697396Sshane         pExpr->iAgg = (i16)i;
536613449892Sdrh         pExpr->pAggInfo = pAggInfo;
53673a8c4be7Sdrh         return WRC_Prune;
53686e83a57fSdrh       }else{
53696e83a57fSdrh         return WRC_Continue;
53706e83a57fSdrh       }
53712282792aSdrh     }
5372a58fdfb1Sdanielk1977   }
53737d10d5a6Sdrh   return WRC_Continue;
53747d10d5a6Sdrh }
53757d10d5a6Sdrh static int analyzeAggregatesInSelect(Walker *pWalker, Select *pSelect){
5376d5a336efSdrh   UNUSED_PARAMETER(pSelect);
5377979dd1beSdrh   pWalker->walkerDepth++;
53787d10d5a6Sdrh   return WRC_Continue;
5379a58fdfb1Sdanielk1977 }
5380979dd1beSdrh static void analyzeAggregatesInSelectEnd(Walker *pWalker, Select *pSelect){
5381979dd1beSdrh   UNUSED_PARAMETER(pSelect);
5382979dd1beSdrh   pWalker->walkerDepth--;
5383979dd1beSdrh }
5384626a879aSdrh 
5385626a879aSdrh /*
5386e8abb4caSdrh ** Analyze the pExpr expression looking for aggregate functions and
5387e8abb4caSdrh ** for variables that need to be added to AggInfo object that pNC->pAggInfo
5388e8abb4caSdrh ** points to.  Additional entries are made on the AggInfo object as
5389e8abb4caSdrh ** necessary.
5390626a879aSdrh **
5391626a879aSdrh ** This routine should only be called after the expression has been
53927d10d5a6Sdrh ** analyzed by sqlite3ResolveExprNames().
5393626a879aSdrh */
5394d2b3e23bSdrh void sqlite3ExprAnalyzeAggregates(NameContext *pNC, Expr *pExpr){
53957d10d5a6Sdrh   Walker w;
53967d10d5a6Sdrh   w.xExprCallback = analyzeAggregate;
53977d10d5a6Sdrh   w.xSelectCallback = analyzeAggregatesInSelect;
5398979dd1beSdrh   w.xSelectCallback2 = analyzeAggregatesInSelectEnd;
5399979dd1beSdrh   w.walkerDepth = 0;
54007d10d5a6Sdrh   w.u.pNC = pNC;
540120bc393cSdrh   assert( pNC->pSrcList!=0 );
54027d10d5a6Sdrh   sqlite3WalkExpr(&w, pExpr);
54032282792aSdrh }
54045d9a4af9Sdrh 
54055d9a4af9Sdrh /*
54065d9a4af9Sdrh ** Call sqlite3ExprAnalyzeAggregates() for every expression in an
54075d9a4af9Sdrh ** expression list.  Return the number of errors.
54085d9a4af9Sdrh **
54095d9a4af9Sdrh ** If an error is found, the analysis is cut short.
54105d9a4af9Sdrh */
5411d2b3e23bSdrh void sqlite3ExprAnalyzeAggList(NameContext *pNC, ExprList *pList){
54125d9a4af9Sdrh   struct ExprList_item *pItem;
54135d9a4af9Sdrh   int i;
54145d9a4af9Sdrh   if( pList ){
5415d2b3e23bSdrh     for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
5416d2b3e23bSdrh       sqlite3ExprAnalyzeAggregates(pNC, pItem->pExpr);
54175d9a4af9Sdrh     }
54185d9a4af9Sdrh   }
54195d9a4af9Sdrh }
5420892d3179Sdrh 
5421892d3179Sdrh /*
5422ceea3321Sdrh ** Allocate a single new register for use to hold some intermediate result.
5423892d3179Sdrh */
5424892d3179Sdrh int sqlite3GetTempReg(Parse *pParse){
5425e55cbd72Sdrh   if( pParse->nTempReg==0 ){
5426892d3179Sdrh     return ++pParse->nMem;
5427892d3179Sdrh   }
54282f425f6bSdanielk1977   return pParse->aTempReg[--pParse->nTempReg];
5429892d3179Sdrh }
5430ceea3321Sdrh 
5431ceea3321Sdrh /*
5432ceea3321Sdrh ** Deallocate a register, making available for reuse for some other
5433ceea3321Sdrh ** purpose.
5434ceea3321Sdrh **
5435ceea3321Sdrh ** If a register is currently being used by the column cache, then
543660ec914cSpeter.d.reid ** the deallocation is deferred until the column cache line that uses
5437ceea3321Sdrh ** the register becomes stale.
5438ceea3321Sdrh */
5439892d3179Sdrh void sqlite3ReleaseTempReg(Parse *pParse, int iReg){
54402dcef11bSdrh   if( iReg && pParse->nTempReg<ArraySize(pParse->aTempReg) ){
5441ceea3321Sdrh     int i;
5442ceea3321Sdrh     struct yColCache *p;
54439b40d13fSdrh     for(i=0, p=pParse->aColCache; i<pParse->nColCache; i++, p++){
5444ceea3321Sdrh       if( p->iReg==iReg ){
5445ceea3321Sdrh         p->tempReg = 1;
5446ceea3321Sdrh         return;
5447ceea3321Sdrh       }
5448ceea3321Sdrh     }
5449892d3179Sdrh     pParse->aTempReg[pParse->nTempReg++] = iReg;
5450892d3179Sdrh   }
5451892d3179Sdrh }
5452892d3179Sdrh 
5453892d3179Sdrh /*
5454ed24da4bSdrh ** Allocate or deallocate a block of nReg consecutive registers.
5455892d3179Sdrh */
5456892d3179Sdrh int sqlite3GetTempRange(Parse *pParse, int nReg){
5457e55cbd72Sdrh   int i, n;
5458ed24da4bSdrh   if( nReg==1 ) return sqlite3GetTempReg(pParse);
5459892d3179Sdrh   i = pParse->iRangeReg;
5460e55cbd72Sdrh   n = pParse->nRangeReg;
5461f49f3523Sdrh   if( nReg<=n ){
5462f49f3523Sdrh     assert( !usedAsColumnCache(pParse, i, i+n-1) );
5463892d3179Sdrh     pParse->iRangeReg += nReg;
5464892d3179Sdrh     pParse->nRangeReg -= nReg;
5465892d3179Sdrh   }else{
5466892d3179Sdrh     i = pParse->nMem+1;
5467892d3179Sdrh     pParse->nMem += nReg;
5468892d3179Sdrh   }
5469892d3179Sdrh   return i;
5470892d3179Sdrh }
5471892d3179Sdrh void sqlite3ReleaseTempRange(Parse *pParse, int iReg, int nReg){
5472ed24da4bSdrh   if( nReg==1 ){
5473ed24da4bSdrh     sqlite3ReleaseTempReg(pParse, iReg);
5474ed24da4bSdrh     return;
5475ed24da4bSdrh   }
5476f49f3523Sdrh   sqlite3ExprCacheRemove(pParse, iReg, nReg);
5477892d3179Sdrh   if( nReg>pParse->nRangeReg ){
5478892d3179Sdrh     pParse->nRangeReg = nReg;
5479892d3179Sdrh     pParse->iRangeReg = iReg;
5480892d3179Sdrh   }
5481892d3179Sdrh }
5482cdc69557Sdrh 
5483cdc69557Sdrh /*
5484cdc69557Sdrh ** Mark all temporary registers as being unavailable for reuse.
5485cdc69557Sdrh */
5486cdc69557Sdrh void sqlite3ClearTempRegCache(Parse *pParse){
5487cdc69557Sdrh   pParse->nTempReg = 0;
5488cdc69557Sdrh   pParse->nRangeReg = 0;
5489cdc69557Sdrh }
5490bb9b5f26Sdrh 
5491bb9b5f26Sdrh /*
5492bb9b5f26Sdrh ** Validate that no temporary register falls within the range of
5493bb9b5f26Sdrh ** iFirst..iLast, inclusive.  This routine is only call from within assert()
5494bb9b5f26Sdrh ** statements.
5495bb9b5f26Sdrh */
5496bb9b5f26Sdrh #ifdef SQLITE_DEBUG
5497bb9b5f26Sdrh int sqlite3NoTempsInRange(Parse *pParse, int iFirst, int iLast){
5498bb9b5f26Sdrh   int i;
5499bb9b5f26Sdrh   if( pParse->nRangeReg>0
55003963e584Sdrh    && pParse->iRangeReg+pParse->nRangeReg > iFirst
55013963e584Sdrh    && pParse->iRangeReg <= iLast
5502bb9b5f26Sdrh   ){
5503bb9b5f26Sdrh      return 0;
5504bb9b5f26Sdrh   }
5505bb9b5f26Sdrh   for(i=0; i<pParse->nTempReg; i++){
5506bb9b5f26Sdrh     if( pParse->aTempReg[i]>=iFirst && pParse->aTempReg[i]<=iLast ){
5507bb9b5f26Sdrh       return 0;
5508bb9b5f26Sdrh     }
5509bb9b5f26Sdrh   }
5510bb9b5f26Sdrh   return 1;
5511bb9b5f26Sdrh }
5512bb9b5f26Sdrh #endif /* SQLITE_DEBUG */
5513