xref: /sqlite-3.40.0/src/expr.c (revision 508e2d00)
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 }
6614b5255acSdanielk1977 static void heightOfSelect(Select *p, int *pnHeight){
6624b5255acSdanielk1977   if( p ){
6634b5255acSdanielk1977     heightOfExpr(p->pWhere, pnHeight);
6644b5255acSdanielk1977     heightOfExpr(p->pHaving, pnHeight);
6654b5255acSdanielk1977     heightOfExpr(p->pLimit, pnHeight);
6664b5255acSdanielk1977     heightOfExpr(p->pOffset, pnHeight);
6674b5255acSdanielk1977     heightOfExprList(p->pEList, pnHeight);
6684b5255acSdanielk1977     heightOfExprList(p->pGroupBy, pnHeight);
6694b5255acSdanielk1977     heightOfExprList(p->pOrderBy, pnHeight);
6704b5255acSdanielk1977     heightOfSelect(p->pPrior, pnHeight);
6714b5255acSdanielk1977   }
6724b5255acSdanielk1977 }
6734b5255acSdanielk1977 
6744b5255acSdanielk1977 /*
6754b5255acSdanielk1977 ** Set the Expr.nHeight variable in the structure passed as an
6764b5255acSdanielk1977 ** argument. An expression with no children, Expr.pList or
6774b5255acSdanielk1977 ** Expr.pSelect member has a height of 1. Any other expression
6784b5255acSdanielk1977 ** has a height equal to the maximum height of any other
6794b5255acSdanielk1977 ** referenced Expr plus one.
6802308ed38Sdrh **
6812308ed38Sdrh ** Also propagate EP_Propagate flags up from Expr.x.pList to Expr.flags,
6822308ed38Sdrh ** if appropriate.
6834b5255acSdanielk1977 */
6844b5255acSdanielk1977 static void exprSetHeight(Expr *p){
6854b5255acSdanielk1977   int nHeight = 0;
6864b5255acSdanielk1977   heightOfExpr(p->pLeft, &nHeight);
6874b5255acSdanielk1977   heightOfExpr(p->pRight, &nHeight);
6886ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_xIsSelect) ){
6896ab3a2ecSdanielk1977     heightOfSelect(p->x.pSelect, &nHeight);
6902308ed38Sdrh   }else if( p->x.pList ){
6916ab3a2ecSdanielk1977     heightOfExprList(p->x.pList, &nHeight);
6922308ed38Sdrh     p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
6936ab3a2ecSdanielk1977   }
6944b5255acSdanielk1977   p->nHeight = nHeight + 1;
6954b5255acSdanielk1977 }
6964b5255acSdanielk1977 
6974b5255acSdanielk1977 /*
6984b5255acSdanielk1977 ** Set the Expr.nHeight variable using the exprSetHeight() function. If
6994b5255acSdanielk1977 ** the height is greater than the maximum allowed expression depth,
7004b5255acSdanielk1977 ** leave an error in pParse.
7012308ed38Sdrh **
7022308ed38Sdrh ** Also propagate all EP_Propagate flags from the Expr.x.pList into
7032308ed38Sdrh ** Expr.flags.
7044b5255acSdanielk1977 */
7052308ed38Sdrh void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
70674893a4cSdrh   if( pParse->nErr ) return;
7074b5255acSdanielk1977   exprSetHeight(p);
7087d10d5a6Sdrh   sqlite3ExprCheckHeight(pParse, p->nHeight);
7094b5255acSdanielk1977 }
7104b5255acSdanielk1977 
7114b5255acSdanielk1977 /*
7124b5255acSdanielk1977 ** Return the maximum height of any expression tree referenced
7134b5255acSdanielk1977 ** by the select statement passed as an argument.
7144b5255acSdanielk1977 */
7154b5255acSdanielk1977 int sqlite3SelectExprHeight(Select *p){
7164b5255acSdanielk1977   int nHeight = 0;
7174b5255acSdanielk1977   heightOfSelect(p, &nHeight);
7184b5255acSdanielk1977   return nHeight;
7194b5255acSdanielk1977 }
7202308ed38Sdrh #else /* ABOVE:  Height enforcement enabled.  BELOW: Height enforcement off */
7212308ed38Sdrh /*
7222308ed38Sdrh ** Propagate all EP_Propagate flags from the Expr.x.pList into
7232308ed38Sdrh ** Expr.flags.
7242308ed38Sdrh */
7252308ed38Sdrh void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
7262308ed38Sdrh   if( p && p->x.pList && !ExprHasProperty(p, EP_xIsSelect) ){
7272308ed38Sdrh     p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
7282308ed38Sdrh   }
7292308ed38Sdrh }
7304b5255acSdanielk1977 #define exprSetHeight(y)
7314b5255acSdanielk1977 #endif /* SQLITE_MAX_EXPR_DEPTH>0 */
7324b5255acSdanielk1977 
733be5c89acSdrh /*
734b7916a78Sdrh ** This routine is the core allocator for Expr nodes.
735b7916a78Sdrh **
736a76b5dfcSdrh ** Construct a new expression node and return a pointer to it.  Memory
737b7916a78Sdrh ** for this node and for the pToken argument is a single allocation
738b7916a78Sdrh ** obtained from sqlite3DbMalloc().  The calling function
739a76b5dfcSdrh ** is responsible for making sure the node eventually gets freed.
740b7916a78Sdrh **
741b7916a78Sdrh ** If dequote is true, then the token (if it exists) is dequoted.
742e792b5b4Sdrh ** If dequote is false, no dequoting is performed.  The deQuote
743b7916a78Sdrh ** parameter is ignored if pToken is NULL or if the token does not
744b7916a78Sdrh ** appear to be quoted.  If the quotes were of the form "..." (double-quotes)
745b7916a78Sdrh ** then the EP_DblQuoted flag is set on the expression node.
74633e619fcSdrh **
74733e619fcSdrh ** Special case:  If op==TK_INTEGER and pToken points to a string that
74833e619fcSdrh ** can be translated into a 32-bit integer, then the token is not
74933e619fcSdrh ** stored in u.zToken.  Instead, the integer values is written
75033e619fcSdrh ** into u.iValue and the EP_IntValue flag is set.  No extra storage
75133e619fcSdrh ** is allocated to hold the integer text and the dequote flag is ignored.
752a76b5dfcSdrh */
753b7916a78Sdrh Expr *sqlite3ExprAlloc(
754cca8a4adSdrh   sqlite3 *db,            /* Handle for sqlite3DbMallocRawNN() */
75517435752Sdrh   int op,                 /* Expression opcode */
756b7916a78Sdrh   const Token *pToken,    /* Token argument.  Might be NULL */
757b7916a78Sdrh   int dequote             /* True to dequote */
75817435752Sdrh ){
759a76b5dfcSdrh   Expr *pNew;
76033e619fcSdrh   int nExtra = 0;
761cf697396Sshane   int iValue = 0;
762b7916a78Sdrh 
763575fad65Sdrh   assert( db!=0 );
764b7916a78Sdrh   if( pToken ){
76533e619fcSdrh     if( op!=TK_INTEGER || pToken->z==0
76633e619fcSdrh           || sqlite3GetInt32(pToken->z, &iValue)==0 ){
767b7916a78Sdrh       nExtra = pToken->n+1;
768d50ffc41Sdrh       assert( iValue>=0 );
76933e619fcSdrh     }
770a76b5dfcSdrh   }
771575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, sizeof(Expr)+nExtra);
772b7916a78Sdrh   if( pNew ){
773ca3862dcSdrh     memset(pNew, 0, sizeof(Expr));
7741bd10f8aSdrh     pNew->op = (u8)op;
775a58fdfb1Sdanielk1977     pNew->iAgg = -1;
776a76b5dfcSdrh     if( pToken ){
77733e619fcSdrh       if( nExtra==0 ){
778b98a2e35Sdrh         pNew->flags |= EP_IntValue|EP_Leaf;
77933e619fcSdrh         pNew->u.iValue = iValue;
78033e619fcSdrh       }else{
78133e619fcSdrh         pNew->u.zToken = (char*)&pNew[1];
782b07028f7Sdrh         assert( pToken->z!=0 || pToken->n==0 );
783b07028f7Sdrh         if( pToken->n ) memcpy(pNew->u.zToken, pToken->z, pToken->n);
78433e619fcSdrh         pNew->u.zToken[pToken->n] = 0;
785244b9d6eSdrh         if( dequote && sqlite3Isquote(pNew->u.zToken[0]) ){
786244b9d6eSdrh           if( pNew->u.zToken[0]=='"' ) pNew->flags |= EP_DblQuoted;
78733e619fcSdrh           sqlite3Dequote(pNew->u.zToken);
788a34001c9Sdrh         }
789a34001c9Sdrh       }
79033e619fcSdrh     }
791b7916a78Sdrh #if SQLITE_MAX_EXPR_DEPTH>0
792b7916a78Sdrh     pNew->nHeight = 1;
793b7916a78Sdrh #endif
794a34001c9Sdrh   }
795a76b5dfcSdrh   return pNew;
796a76b5dfcSdrh }
797a76b5dfcSdrh 
798a76b5dfcSdrh /*
799b7916a78Sdrh ** Allocate a new expression node from a zero-terminated token that has
800b7916a78Sdrh ** already been dequoted.
801b7916a78Sdrh */
802b7916a78Sdrh Expr *sqlite3Expr(
803b7916a78Sdrh   sqlite3 *db,            /* Handle for sqlite3DbMallocZero() (may be null) */
804b7916a78Sdrh   int op,                 /* Expression opcode */
805b7916a78Sdrh   const char *zToken      /* Token argument.  Might be NULL */
806b7916a78Sdrh ){
807b7916a78Sdrh   Token x;
808b7916a78Sdrh   x.z = zToken;
809b40f06c6Sdrh   x.n = sqlite3Strlen30(zToken);
810b7916a78Sdrh   return sqlite3ExprAlloc(db, op, &x, 0);
811b7916a78Sdrh }
812b7916a78Sdrh 
813b7916a78Sdrh /*
814b7916a78Sdrh ** Attach subtrees pLeft and pRight to the Expr node pRoot.
815b7916a78Sdrh **
816b7916a78Sdrh ** If pRoot==NULL that means that a memory allocation error has occurred.
817b7916a78Sdrh ** In that case, delete the subtrees pLeft and pRight.
818b7916a78Sdrh */
819b7916a78Sdrh void sqlite3ExprAttachSubtrees(
820b7916a78Sdrh   sqlite3 *db,
821b7916a78Sdrh   Expr *pRoot,
822b7916a78Sdrh   Expr *pLeft,
823b7916a78Sdrh   Expr *pRight
824b7916a78Sdrh ){
825b7916a78Sdrh   if( pRoot==0 ){
826b7916a78Sdrh     assert( db->mallocFailed );
827b7916a78Sdrh     sqlite3ExprDelete(db, pLeft);
828b7916a78Sdrh     sqlite3ExprDelete(db, pRight);
829b7916a78Sdrh   }else{
830b7916a78Sdrh     if( pRight ){
831b7916a78Sdrh       pRoot->pRight = pRight;
832885a5b03Sdrh       pRoot->flags |= EP_Propagate & pRight->flags;
833b7916a78Sdrh     }
834b7916a78Sdrh     if( pLeft ){
835b7916a78Sdrh       pRoot->pLeft = pLeft;
836885a5b03Sdrh       pRoot->flags |= EP_Propagate & pLeft->flags;
837b7916a78Sdrh     }
838b7916a78Sdrh     exprSetHeight(pRoot);
839b7916a78Sdrh   }
840b7916a78Sdrh }
841b7916a78Sdrh 
842b7916a78Sdrh /*
84360ec914cSpeter.d.reid ** Allocate an Expr node which joins as many as two subtrees.
844b7916a78Sdrh **
845bf664469Sdrh ** One or both of the subtrees can be NULL.  Return a pointer to the new
846bf664469Sdrh ** Expr node.  Or, if an OOM error occurs, set pParse->db->mallocFailed,
847bf664469Sdrh ** free the subtrees and return NULL.
848206f3d96Sdrh */
84917435752Sdrh Expr *sqlite3PExpr(
85017435752Sdrh   Parse *pParse,          /* Parsing context */
85117435752Sdrh   int op,                 /* Expression opcode */
85217435752Sdrh   Expr *pLeft,            /* Left operand */
853abfd35eaSdrh   Expr *pRight            /* Right operand */
85417435752Sdrh ){
8555fb52caaSdrh   Expr *p;
8561167d327Sdrh   if( op==TK_AND && pParse->nErr==0 ){
8575fb52caaSdrh     /* Take advantage of short-circuit false optimization for AND */
8585fb52caaSdrh     p = sqlite3ExprAnd(pParse->db, pLeft, pRight);
8595fb52caaSdrh   }else{
860abfd35eaSdrh     p = sqlite3DbMallocRawNN(pParse->db, sizeof(Expr));
861abfd35eaSdrh     if( p ){
862abfd35eaSdrh       memset(p, 0, sizeof(Expr));
863abfd35eaSdrh       p->op = op & TKFLG_MASK;
864abfd35eaSdrh       p->iAgg = -1;
865abfd35eaSdrh     }
866b7916a78Sdrh     sqlite3ExprAttachSubtrees(pParse->db, p, pLeft, pRight);
8675fb52caaSdrh   }
8682b359bdbSdan   if( p ) {
8692b359bdbSdan     sqlite3ExprCheckHeight(pParse, p->nHeight);
8702b359bdbSdan   }
8714e0cff60Sdrh   return p;
8724e0cff60Sdrh }
8734e0cff60Sdrh 
8744e0cff60Sdrh /*
87508de4f79Sdrh ** Add pSelect to the Expr.x.pSelect field.  Or, if pExpr is NULL (due
87608de4f79Sdrh ** do a memory allocation failure) then delete the pSelect object.
87708de4f79Sdrh */
87808de4f79Sdrh void sqlite3PExprAddSelect(Parse *pParse, Expr *pExpr, Select *pSelect){
87908de4f79Sdrh   if( pExpr ){
88008de4f79Sdrh     pExpr->x.pSelect = pSelect;
88108de4f79Sdrh     ExprSetProperty(pExpr, EP_xIsSelect|EP_Subquery);
88208de4f79Sdrh     sqlite3ExprSetHeightAndFlags(pParse, pExpr);
88308de4f79Sdrh   }else{
88408de4f79Sdrh     assert( pParse->db->mallocFailed );
88508de4f79Sdrh     sqlite3SelectDelete(pParse->db, pSelect);
88608de4f79Sdrh   }
88708de4f79Sdrh }
88808de4f79Sdrh 
88908de4f79Sdrh 
89008de4f79Sdrh /*
891991a1985Sdrh ** If the expression is always either TRUE or FALSE (respectively),
892991a1985Sdrh ** then return 1.  If one cannot determine the truth value of the
893991a1985Sdrh ** expression at compile-time return 0.
894991a1985Sdrh **
895991a1985Sdrh ** This is an optimization.  If is OK to return 0 here even if
896991a1985Sdrh ** the expression really is always false or false (a false negative).
897991a1985Sdrh ** But it is a bug to return 1 if the expression might have different
898991a1985Sdrh ** boolean values in different circumstances (a false positive.)
8995fb52caaSdrh **
9005fb52caaSdrh ** Note that if the expression is part of conditional for a
9015fb52caaSdrh ** LEFT JOIN, then we cannot determine at compile-time whether or not
9025fb52caaSdrh ** is it true or false, so always return 0.
9035fb52caaSdrh */
904991a1985Sdrh static int exprAlwaysTrue(Expr *p){
905991a1985Sdrh   int v = 0;
906991a1985Sdrh   if( ExprHasProperty(p, EP_FromJoin) ) return 0;
907991a1985Sdrh   if( !sqlite3ExprIsInteger(p, &v) ) return 0;
908991a1985Sdrh   return v!=0;
909991a1985Sdrh }
9105fb52caaSdrh static int exprAlwaysFalse(Expr *p){
9115fb52caaSdrh   int v = 0;
9125fb52caaSdrh   if( ExprHasProperty(p, EP_FromJoin) ) return 0;
9135fb52caaSdrh   if( !sqlite3ExprIsInteger(p, &v) ) return 0;
9145fb52caaSdrh   return v==0;
9155fb52caaSdrh }
9165fb52caaSdrh 
9175fb52caaSdrh /*
91891bb0eedSdrh ** Join two expressions using an AND operator.  If either expression is
91991bb0eedSdrh ** NULL, then just return the other expression.
9205fb52caaSdrh **
9215fb52caaSdrh ** If one side or the other of the AND is known to be false, then instead
9225fb52caaSdrh ** of returning an AND expression, just return a constant expression with
9235fb52caaSdrh ** a value of false.
92491bb0eedSdrh */
9251e536953Sdanielk1977 Expr *sqlite3ExprAnd(sqlite3 *db, Expr *pLeft, Expr *pRight){
92691bb0eedSdrh   if( pLeft==0 ){
92791bb0eedSdrh     return pRight;
92891bb0eedSdrh   }else if( pRight==0 ){
92991bb0eedSdrh     return pLeft;
9305fb52caaSdrh   }else if( exprAlwaysFalse(pLeft) || exprAlwaysFalse(pRight) ){
9315fb52caaSdrh     sqlite3ExprDelete(db, pLeft);
9325fb52caaSdrh     sqlite3ExprDelete(db, pRight);
9335fb52caaSdrh     return sqlite3ExprAlloc(db, TK_INTEGER, &sqlite3IntTokens[0], 0);
93491bb0eedSdrh   }else{
935b7916a78Sdrh     Expr *pNew = sqlite3ExprAlloc(db, TK_AND, 0, 0);
936b7916a78Sdrh     sqlite3ExprAttachSubtrees(db, pNew, pLeft, pRight);
937b7916a78Sdrh     return pNew;
938a76b5dfcSdrh   }
939a76b5dfcSdrh }
940a76b5dfcSdrh 
941a76b5dfcSdrh /*
942a76b5dfcSdrh ** Construct a new expression node for a function with multiple
943a76b5dfcSdrh ** arguments.
944a76b5dfcSdrh */
94517435752Sdrh Expr *sqlite3ExprFunction(Parse *pParse, ExprList *pList, Token *pToken){
946a76b5dfcSdrh   Expr *pNew;
947633e6d57Sdrh   sqlite3 *db = pParse->db;
9484b202ae2Sdanielk1977   assert( pToken );
949b7916a78Sdrh   pNew = sqlite3ExprAlloc(db, TK_FUNCTION, pToken, 1);
950a76b5dfcSdrh   if( pNew==0 ){
951d9da78a2Sdrh     sqlite3ExprListDelete(db, pList); /* Avoid memory leak when malloc fails */
952a76b5dfcSdrh     return 0;
953a76b5dfcSdrh   }
9546ab3a2ecSdanielk1977   pNew->x.pList = pList;
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 );
112647073f62Sdrh   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);
14646ab3a2ecSdanielk1977     pNew->pOffset = sqlite3ExprDup(db, p->pOffset, flags);
146592b01d53Sdrh     pNew->iLimit = 0;
146692b01d53Sdrh     pNew->iOffset = 0;
14677d10d5a6Sdrh     pNew->selFlags = p->selFlags & ~SF_UsesEphemeral;
1468b9bb7c18Sdrh     pNew->addrOpenEphm[0] = -1;
1469b9bb7c18Sdrh     pNew->addrOpenEphm[1] = -1;
1470ec2da854Sdrh     pNew->nSelectRow = p->nSelectRow;
14714e9119d9Sdan     pNew->pWith = withDup(db, p->pWith);
1472eb9b884cSdrh     sqlite3SelectSetName(pNew, p->zSelName);
1473a7466205Sdan     *pp = pNew;
1474a7466205Sdan     pp = &pNew->pPrior;
1475a7466205Sdan     pNext = pNew;
1476a7466205Sdan   }
1477a7466205Sdan 
1478a7466205Sdan   return pRet;
1479ff78bd2fSdrh }
148093758c8dSdanielk1977 #else
14816ab3a2ecSdanielk1977 Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
148293758c8dSdanielk1977   assert( p==0 );
148393758c8dSdanielk1977   return 0;
148493758c8dSdanielk1977 }
148593758c8dSdanielk1977 #endif
1486ff78bd2fSdrh 
1487ff78bd2fSdrh 
1488ff78bd2fSdrh /*
1489a76b5dfcSdrh ** Add a new element to the end of an expression list.  If pList is
1490a76b5dfcSdrh ** initially NULL, then create a new expression list.
1491b7916a78Sdrh **
1492a19543feSdrh ** The pList argument must be either NULL or a pointer to an ExprList
1493a19543feSdrh ** obtained from a prior call to sqlite3ExprListAppend().  This routine
1494a19543feSdrh ** may not be used with an ExprList obtained from sqlite3ExprListDup().
1495a19543feSdrh ** Reason:  This routine assumes that the number of slots in pList->a[]
1496a19543feSdrh ** is a power of two.  That is true for sqlite3ExprListAppend() returns
1497a19543feSdrh ** but is not necessarily true from the return value of sqlite3ExprListDup().
1498a19543feSdrh **
1499b7916a78Sdrh ** If a memory allocation error occurs, the entire list is freed and
1500b7916a78Sdrh ** NULL is returned.  If non-NULL is returned, then it is guaranteed
1501b7916a78Sdrh ** that the new entry was successfully appended.
1502a76b5dfcSdrh */
150317435752Sdrh ExprList *sqlite3ExprListAppend(
150417435752Sdrh   Parse *pParse,          /* Parsing context */
150517435752Sdrh   ExprList *pList,        /* List to which to append. Might be NULL */
1506b7916a78Sdrh   Expr *pExpr             /* Expression to be appended. Might be NULL */
150717435752Sdrh ){
150843606175Sdrh   struct ExprList_item *pItem;
150917435752Sdrh   sqlite3 *db = pParse->db;
1510575fad65Sdrh   assert( db!=0 );
1511a76b5dfcSdrh   if( pList==0 ){
1512575fad65Sdrh     pList = sqlite3DbMallocRawNN(db, sizeof(ExprList) );
1513a76b5dfcSdrh     if( pList==0 ){
1514d5d56523Sdanielk1977       goto no_mem;
1515a76b5dfcSdrh     }
1516c263f7c4Sdrh     pList->nExpr = 0;
1517a19543feSdrh   }else if( (pList->nExpr & (pList->nExpr-1))==0 ){
151843606175Sdrh     ExprList *pNew;
151943606175Sdrh     pNew = sqlite3DbRealloc(db, pList,
1520a19543feSdrh              sizeof(*pList)+(2*pList->nExpr - 1)*sizeof(pList->a[0]));
152143606175Sdrh     if( pNew==0 ){
1522d5d56523Sdanielk1977       goto no_mem;
1523a76b5dfcSdrh     }
152443606175Sdrh     pList = pNew;
1525a76b5dfcSdrh   }
152643606175Sdrh   pItem = &pList->a[pList->nExpr++];
1527a8b9793cSdrh   assert( offsetof(struct ExprList_item,zName)==sizeof(pItem->pExpr) );
1528a8b9793cSdrh   assert( offsetof(struct ExprList_item,pExpr)==0 );
1529a8b9793cSdrh   memset(&pItem->zName,0,sizeof(*pItem)-offsetof(struct ExprList_item,zName));
1530e94ddc9eSdanielk1977   pItem->pExpr = pExpr;
1531a76b5dfcSdrh   return pList;
1532d5d56523Sdanielk1977 
1533d5d56523Sdanielk1977 no_mem:
1534d5d56523Sdanielk1977   /* Avoid leaking memory if malloc has failed. */
1535633e6d57Sdrh   sqlite3ExprDelete(db, pExpr);
1536633e6d57Sdrh   sqlite3ExprListDelete(db, pList);
1537d5d56523Sdanielk1977   return 0;
1538a76b5dfcSdrh }
1539a76b5dfcSdrh 
1540a76b5dfcSdrh /*
15418762ec19Sdrh ** pColumns and pExpr form a vector assignment which is part of the SET
15428762ec19Sdrh ** clause of an UPDATE statement.  Like this:
1543a1251bc4Sdrh **
1544a1251bc4Sdrh **        (a,b,c) = (expr1,expr2,expr3)
1545a1251bc4Sdrh ** Or:    (a,b,c) = (SELECT x,y,z FROM ....)
1546a1251bc4Sdrh **
1547a1251bc4Sdrh ** For each term of the vector assignment, append new entries to the
1548b67343d0Sdrh ** expression list pList.  In the case of a subquery on the RHS, append
1549a1251bc4Sdrh ** TK_SELECT_COLUMN expressions.
1550a1251bc4Sdrh */
1551a1251bc4Sdrh ExprList *sqlite3ExprListAppendVector(
1552a1251bc4Sdrh   Parse *pParse,         /* Parsing context */
1553a1251bc4Sdrh   ExprList *pList,       /* List to which to append. Might be NULL */
1554a1251bc4Sdrh   IdList *pColumns,      /* List of names of LHS of the assignment */
1555a1251bc4Sdrh   Expr *pExpr            /* Vector expression to be appended. Might be NULL */
1556a1251bc4Sdrh ){
1557a1251bc4Sdrh   sqlite3 *db = pParse->db;
1558a1251bc4Sdrh   int n;
1559a1251bc4Sdrh   int i;
156066860af3Sdrh   int iFirst = pList ? pList->nExpr : 0;
1561321e828dSdrh   /* pColumns can only be NULL due to an OOM but an OOM will cause an
1562321e828dSdrh   ** exit prior to this routine being invoked */
1563321e828dSdrh   if( NEVER(pColumns==0) ) goto vector_append_error;
1564a1251bc4Sdrh   if( pExpr==0 ) goto vector_append_error;
1565966e2911Sdrh 
1566966e2911Sdrh   /* If the RHS is a vector, then we can immediately check to see that
1567966e2911Sdrh   ** the size of the RHS and LHS match.  But if the RHS is a SELECT,
1568966e2911Sdrh   ** wildcards ("*") in the result set of the SELECT must be expanded before
1569966e2911Sdrh   ** we can do the size check, so defer the size check until code generation.
1570966e2911Sdrh   */
1571966e2911Sdrh   if( pExpr->op!=TK_SELECT && pColumns->nId!=(n=sqlite3ExprVectorSize(pExpr)) ){
1572a1251bc4Sdrh     sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
1573a1251bc4Sdrh                     pColumns->nId, n);
1574a1251bc4Sdrh     goto vector_append_error;
1575a1251bc4Sdrh   }
1576966e2911Sdrh 
1577966e2911Sdrh   for(i=0; i<pColumns->nId; i++){
1578a1251bc4Sdrh     Expr *pSubExpr = sqlite3ExprForVectorField(pParse, pExpr, i);
1579a1251bc4Sdrh     pList = sqlite3ExprListAppend(pParse, pList, pSubExpr);
1580a1251bc4Sdrh     if( pList ){
158166860af3Sdrh       assert( pList->nExpr==iFirst+i+1 );
1582a1251bc4Sdrh       pList->a[pList->nExpr-1].zName = pColumns->a[i].zName;
1583a1251bc4Sdrh       pColumns->a[i].zName = 0;
1584a1251bc4Sdrh     }
1585a1251bc4Sdrh   }
1586966e2911Sdrh 
1587ffe28059Sdrh   if( !db->mallocFailed && pExpr->op==TK_SELECT && ALWAYS(pList!=0) ){
1588966e2911Sdrh     Expr *pFirst = pList->a[iFirst].pExpr;
1589f4dd26c5Sdrh     assert( pFirst!=0 );
1590966e2911Sdrh     assert( pFirst->op==TK_SELECT_COLUMN );
1591966e2911Sdrh 
1592966e2911Sdrh     /* Store the SELECT statement in pRight so it will be deleted when
1593966e2911Sdrh     ** sqlite3ExprListDelete() is called */
1594966e2911Sdrh     pFirst->pRight = pExpr;
1595a1251bc4Sdrh     pExpr = 0;
1596966e2911Sdrh 
1597966e2911Sdrh     /* Remember the size of the LHS in iTable so that we can check that
1598966e2911Sdrh     ** the RHS and LHS sizes match during code generation. */
1599966e2911Sdrh     pFirst->iTable = pColumns->nId;
1600a1251bc4Sdrh   }
1601a1251bc4Sdrh 
1602a1251bc4Sdrh vector_append_error:
1603a1251bc4Sdrh   sqlite3ExprDelete(db, pExpr);
1604a1251bc4Sdrh   sqlite3IdListDelete(db, pColumns);
1605a1251bc4Sdrh   return pList;
1606a1251bc4Sdrh }
1607a1251bc4Sdrh 
1608a1251bc4Sdrh /*
1609bc622bc0Sdrh ** Set the sort order for the last element on the given ExprList.
1610bc622bc0Sdrh */
1611bc622bc0Sdrh void sqlite3ExprListSetSortOrder(ExprList *p, int iSortOrder){
1612bc622bc0Sdrh   if( p==0 ) return;
1613bc622bc0Sdrh   assert( SQLITE_SO_UNDEFINED<0 && SQLITE_SO_ASC>=0 && SQLITE_SO_DESC>0 );
1614bc622bc0Sdrh   assert( p->nExpr>0 );
1615bc622bc0Sdrh   if( iSortOrder<0 ){
1616bc622bc0Sdrh     assert( p->a[p->nExpr-1].sortOrder==SQLITE_SO_ASC );
1617bc622bc0Sdrh     return;
1618bc622bc0Sdrh   }
1619bc622bc0Sdrh   p->a[p->nExpr-1].sortOrder = (u8)iSortOrder;
1620bc622bc0Sdrh }
1621bc622bc0Sdrh 
1622bc622bc0Sdrh /*
1623b7916a78Sdrh ** Set the ExprList.a[].zName element of the most recently added item
1624b7916a78Sdrh ** on the expression list.
1625b7916a78Sdrh **
1626b7916a78Sdrh ** pList might be NULL following an OOM error.  But pName should never be
1627b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1628b7916a78Sdrh ** is set.
1629b7916a78Sdrh */
1630b7916a78Sdrh void sqlite3ExprListSetName(
1631b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1632b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
1633b7916a78Sdrh   Token *pName,           /* Name to be added */
1634b7916a78Sdrh   int dequote             /* True to cause the name to be dequoted */
1635b7916a78Sdrh ){
1636b7916a78Sdrh   assert( pList!=0 || pParse->db->mallocFailed!=0 );
1637b7916a78Sdrh   if( pList ){
1638b7916a78Sdrh     struct ExprList_item *pItem;
1639b7916a78Sdrh     assert( pList->nExpr>0 );
1640b7916a78Sdrh     pItem = &pList->a[pList->nExpr-1];
1641b7916a78Sdrh     assert( pItem->zName==0 );
1642b7916a78Sdrh     pItem->zName = sqlite3DbStrNDup(pParse->db, pName->z, pName->n);
1643244b9d6eSdrh     if( dequote ) sqlite3Dequote(pItem->zName);
1644b7916a78Sdrh   }
1645b7916a78Sdrh }
1646b7916a78Sdrh 
1647b7916a78Sdrh /*
1648b7916a78Sdrh ** Set the ExprList.a[].zSpan element of the most recently added item
1649b7916a78Sdrh ** on the expression list.
1650b7916a78Sdrh **
1651b7916a78Sdrh ** pList might be NULL following an OOM error.  But pSpan should never be
1652b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1653b7916a78Sdrh ** is set.
1654b7916a78Sdrh */
1655b7916a78Sdrh void sqlite3ExprListSetSpan(
1656b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1657b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
1658b7916a78Sdrh   ExprSpan *pSpan         /* The span to be added */
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     assert( db->mallocFailed || pItem->pExpr==pSpan->pExpr );
1666b7916a78Sdrh     sqlite3DbFree(db, pItem->zSpan);
1667b7916a78Sdrh     pItem->zSpan = sqlite3DbStrNDup(db, (char*)pSpan->zStart,
1668cf697396Sshane                                     (int)(pSpan->zEnd - pSpan->zStart));
1669b7916a78Sdrh   }
1670b7916a78Sdrh }
1671b7916a78Sdrh 
1672b7916a78Sdrh /*
16737a15a4beSdanielk1977 ** If the expression list pEList contains more than iLimit elements,
16747a15a4beSdanielk1977 ** leave an error message in pParse.
16757a15a4beSdanielk1977 */
16767a15a4beSdanielk1977 void sqlite3ExprListCheckLength(
16777a15a4beSdanielk1977   Parse *pParse,
16787a15a4beSdanielk1977   ExprList *pEList,
16797a15a4beSdanielk1977   const char *zObject
16807a15a4beSdanielk1977 ){
1681b1a6c3c1Sdrh   int mx = pParse->db->aLimit[SQLITE_LIMIT_COLUMN];
1682c5499befSdrh   testcase( pEList && pEList->nExpr==mx );
1683c5499befSdrh   testcase( pEList && pEList->nExpr==mx+1 );
1684b1a6c3c1Sdrh   if( pEList && pEList->nExpr>mx ){
16857a15a4beSdanielk1977     sqlite3ErrorMsg(pParse, "too many columns in %s", zObject);
16867a15a4beSdanielk1977   }
16877a15a4beSdanielk1977 }
16887a15a4beSdanielk1977 
16897a15a4beSdanielk1977 /*
1690a76b5dfcSdrh ** Delete an entire expression list.
1691a76b5dfcSdrh */
1692affa855cSdrh static SQLITE_NOINLINE void exprListDeleteNN(sqlite3 *db, ExprList *pList){
1693ac48b751Sdrh   int i = pList->nExpr;
1694ac48b751Sdrh   struct ExprList_item *pItem =  pList->a;
1695ac48b751Sdrh   assert( pList->nExpr>0 );
1696ac48b751Sdrh   do{
1697633e6d57Sdrh     sqlite3ExprDelete(db, pItem->pExpr);
1698633e6d57Sdrh     sqlite3DbFree(db, pItem->zName);
1699b7916a78Sdrh     sqlite3DbFree(db, pItem->zSpan);
1700ac48b751Sdrh     pItem++;
1701ac48b751Sdrh   }while( --i>0 );
1702dbd6a7dcSdrh   sqlite3DbFreeNN(db, pList);
1703a76b5dfcSdrh }
1704affa855cSdrh void sqlite3ExprListDelete(sqlite3 *db, ExprList *pList){
1705affa855cSdrh   if( pList ) exprListDeleteNN(db, pList);
1706affa855cSdrh }
1707a76b5dfcSdrh 
1708a76b5dfcSdrh /*
17092308ed38Sdrh ** Return the bitwise-OR of all Expr.flags fields in the given
17102308ed38Sdrh ** ExprList.
1711885a5b03Sdrh */
17122308ed38Sdrh u32 sqlite3ExprListFlags(const ExprList *pList){
1713885a5b03Sdrh   int i;
17142308ed38Sdrh   u32 m = 0;
1715*508e2d00Sdrh   assert( pList!=0 );
1716885a5b03Sdrh   for(i=0; i<pList->nExpr; i++){
1717d0c73053Sdrh      Expr *pExpr = pList->a[i].pExpr;
1718de845c2fSdrh      assert( pExpr!=0 );
1719de845c2fSdrh      m |= pExpr->flags;
1720885a5b03Sdrh   }
17212308ed38Sdrh   return m;
1722885a5b03Sdrh }
1723885a5b03Sdrh 
1724885a5b03Sdrh /*
17257e6f980bSdrh ** This is a SELECT-node callback for the expression walker that
17267e6f980bSdrh ** always "fails".  By "fail" in this case, we mean set
17277e6f980bSdrh ** pWalker->eCode to zero and abort.
17287e6f980bSdrh **
17297e6f980bSdrh ** This callback is used by multiple expression walkers.
17307e6f980bSdrh */
17317e6f980bSdrh int sqlite3SelectWalkFail(Walker *pWalker, Select *NotUsed){
17327e6f980bSdrh   UNUSED_PARAMETER(NotUsed);
17337e6f980bSdrh   pWalker->eCode = 0;
17347e6f980bSdrh   return WRC_Abort;
17357e6f980bSdrh }
17367e6f980bSdrh 
17377e6f980bSdrh /*
1738059b2d50Sdrh ** These routines are Walker callbacks used to check expressions to
1739059b2d50Sdrh ** see if they are "constant" for some definition of constant.  The
1740059b2d50Sdrh ** Walker.eCode value determines the type of "constant" we are looking
1741059b2d50Sdrh ** for.
174273b211abSdrh **
17437d10d5a6Sdrh ** These callback routines are used to implement the following:
1744626a879aSdrh **
1745059b2d50Sdrh **     sqlite3ExprIsConstant()                  pWalker->eCode==1
1746059b2d50Sdrh **     sqlite3ExprIsConstantNotJoin()           pWalker->eCode==2
1747fcb9f4f3Sdrh **     sqlite3ExprIsTableConstant()             pWalker->eCode==3
1748059b2d50Sdrh **     sqlite3ExprIsConstantOrFunction()        pWalker->eCode==4 or 5
174987abf5c0Sdrh **
1750059b2d50Sdrh ** In all cases, the callbacks set Walker.eCode=0 and abort if the expression
1751059b2d50Sdrh ** is found to not be a constant.
175287abf5c0Sdrh **
1753feada2dfSdrh ** The sqlite3ExprIsConstantOrFunction() is used for evaluating expressions
1754059b2d50Sdrh ** in a CREATE TABLE statement.  The Walker.eCode value is 5 when parsing
1755059b2d50Sdrh ** an existing schema and 4 when processing a new statement.  A bound
1756feada2dfSdrh ** parameter raises an error for new statements, but is silently converted
1757feada2dfSdrh ** to NULL for existing schemas.  This allows sqlite_master tables that
1758feada2dfSdrh ** contain a bound parameter because they were generated by older versions
1759feada2dfSdrh ** of SQLite to be parsed by newer versions of SQLite without raising a
1760feada2dfSdrh ** malformed schema error.
1761626a879aSdrh */
17627d10d5a6Sdrh static int exprNodeIsConstant(Walker *pWalker, Expr *pExpr){
1763626a879aSdrh 
1764059b2d50Sdrh   /* If pWalker->eCode is 2 then any term of the expression that comes from
1765059b2d50Sdrh   ** the ON or USING clauses of a left join disqualifies the expression
17660a168377Sdrh   ** from being considered constant. */
1767059b2d50Sdrh   if( pWalker->eCode==2 && ExprHasProperty(pExpr, EP_FromJoin) ){
1768059b2d50Sdrh     pWalker->eCode = 0;
17697d10d5a6Sdrh     return WRC_Abort;
17700a168377Sdrh   }
17710a168377Sdrh 
1772626a879aSdrh   switch( pExpr->op ){
1773eb55bd2fSdrh     /* Consider functions to be constant if all their arguments are constant
1774059b2d50Sdrh     ** and either pWalker->eCode==4 or 5 or the function has the
1775059b2d50Sdrh     ** SQLITE_FUNC_CONST flag. */
1776eb55bd2fSdrh     case TK_FUNCTION:
177763f84573Sdrh       if( pWalker->eCode>=4 || ExprHasProperty(pExpr,EP_ConstFunc) ){
1778b1fba286Sdrh         return WRC_Continue;
1779059b2d50Sdrh       }else{
1780059b2d50Sdrh         pWalker->eCode = 0;
1781059b2d50Sdrh         return WRC_Abort;
1782b1fba286Sdrh       }
1783626a879aSdrh     case TK_ID:
1784626a879aSdrh     case TK_COLUMN:
1785626a879aSdrh     case TK_AGG_FUNCTION:
178613449892Sdrh     case TK_AGG_COLUMN:
1787c5499befSdrh       testcase( pExpr->op==TK_ID );
1788c5499befSdrh       testcase( pExpr->op==TK_COLUMN );
1789c5499befSdrh       testcase( pExpr->op==TK_AGG_FUNCTION );
1790c5499befSdrh       testcase( pExpr->op==TK_AGG_COLUMN );
1791059b2d50Sdrh       if( pWalker->eCode==3 && pExpr->iTable==pWalker->u.iCur ){
1792059b2d50Sdrh         return WRC_Continue;
1793f43ce0b4Sdrh       }
1794f43ce0b4Sdrh       /* Fall through */
1795f43ce0b4Sdrh     case TK_IF_NULL_ROW:
1796f43ce0b4Sdrh       testcase( pExpr->op==TK_IF_NULL_ROW );
1797059b2d50Sdrh       pWalker->eCode = 0;
17987d10d5a6Sdrh       return WRC_Abort;
1799feada2dfSdrh     case TK_VARIABLE:
1800059b2d50Sdrh       if( pWalker->eCode==5 ){
1801feada2dfSdrh         /* Silently convert bound parameters that appear inside of CREATE
1802feada2dfSdrh         ** statements into a NULL when parsing the CREATE statement text out
1803feada2dfSdrh         ** of the sqlite_master table */
1804feada2dfSdrh         pExpr->op = TK_NULL;
1805059b2d50Sdrh       }else if( pWalker->eCode==4 ){
1806feada2dfSdrh         /* A bound parameter in a CREATE statement that originates from
1807feada2dfSdrh         ** sqlite3_prepare() causes an error */
1808059b2d50Sdrh         pWalker->eCode = 0;
1809feada2dfSdrh         return WRC_Abort;
1810feada2dfSdrh       }
1811feada2dfSdrh       /* Fall through */
1812626a879aSdrh     default:
18137e6f980bSdrh       testcase( pExpr->op==TK_SELECT ); /* sqlite3SelectWalkFail will disallow */
18147e6f980bSdrh       testcase( pExpr->op==TK_EXISTS ); /* sqlite3SelectWalkFail will disallow */
18157d10d5a6Sdrh       return WRC_Continue;
1816626a879aSdrh   }
1817626a879aSdrh }
1818059b2d50Sdrh static int exprIsConst(Expr *p, int initFlag, int iCur){
18197d10d5a6Sdrh   Walker w;
1820059b2d50Sdrh   w.eCode = initFlag;
18217d10d5a6Sdrh   w.xExprCallback = exprNodeIsConstant;
18227e6f980bSdrh   w.xSelectCallback = sqlite3SelectWalkFail;
1823979dd1beSdrh #ifdef SQLITE_DEBUG
1824979dd1beSdrh   w.xSelectCallback2 = sqlite3SelectWalkAssert2;
1825979dd1beSdrh #endif
1826059b2d50Sdrh   w.u.iCur = iCur;
18277d10d5a6Sdrh   sqlite3WalkExpr(&w, p);
1828059b2d50Sdrh   return w.eCode;
18297d10d5a6Sdrh }
1830626a879aSdrh 
1831626a879aSdrh /*
1832059b2d50Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
1833eb55bd2fSdrh ** and 0 if it involves variables or function calls.
18342398937bSdrh **
18352398937bSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
18362398937bSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
18372398937bSdrh ** a constant.
1838fef5208cSdrh */
18394adee20fSdanielk1977 int sqlite3ExprIsConstant(Expr *p){
1840059b2d50Sdrh   return exprIsConst(p, 1, 0);
1841fef5208cSdrh }
1842fef5208cSdrh 
1843fef5208cSdrh /*
1844059b2d50Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
18450a168377Sdrh ** that does no originate from the ON or USING clauses of a join.
18460a168377Sdrh ** Return 0 if it involves variables or function calls or terms from
18470a168377Sdrh ** an ON or USING clause.
18480a168377Sdrh */
18490a168377Sdrh int sqlite3ExprIsConstantNotJoin(Expr *p){
1850059b2d50Sdrh   return exprIsConst(p, 2, 0);
18510a168377Sdrh }
18520a168377Sdrh 
18530a168377Sdrh /*
1854fcb9f4f3Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
1855059b2d50Sdrh ** for any single row of the table with cursor iCur.  In other words, the
1856059b2d50Sdrh ** expression must not refer to any non-deterministic function nor any
1857059b2d50Sdrh ** table other than iCur.
1858059b2d50Sdrh */
1859059b2d50Sdrh int sqlite3ExprIsTableConstant(Expr *p, int iCur){
1860059b2d50Sdrh   return exprIsConst(p, 3, iCur);
1861059b2d50Sdrh }
1862059b2d50Sdrh 
1863ab31a845Sdan 
1864ab31a845Sdan /*
1865ab31a845Sdan ** sqlite3WalkExpr() callback used by sqlite3ExprIsConstantOrGroupBy().
1866ab31a845Sdan */
1867ab31a845Sdan static int exprNodeIsConstantOrGroupBy(Walker *pWalker, Expr *pExpr){
1868ab31a845Sdan   ExprList *pGroupBy = pWalker->u.pGroupBy;
1869ab31a845Sdan   int i;
1870ab31a845Sdan 
1871ab31a845Sdan   /* Check if pExpr is identical to any GROUP BY term. If so, consider
1872ab31a845Sdan   ** it constant.  */
1873ab31a845Sdan   for(i=0; i<pGroupBy->nExpr; i++){
1874ab31a845Sdan     Expr *p = pGroupBy->a[i].pExpr;
18755aa550cfSdan     if( sqlite3ExprCompare(0, pExpr, p, -1)<2 ){
187670efa84dSdrh       CollSeq *pColl = sqlite3ExprNNCollSeq(pWalker->pParse, p);
187770efa84dSdrh       if( sqlite3_stricmp("BINARY", pColl->zName)==0 ){
1878ab31a845Sdan         return WRC_Prune;
1879ab31a845Sdan       }
1880ab31a845Sdan     }
1881ab31a845Sdan   }
1882ab31a845Sdan 
1883ab31a845Sdan   /* Check if pExpr is a sub-select. If so, consider it variable. */
1884ab31a845Sdan   if( ExprHasProperty(pExpr, EP_xIsSelect) ){
1885ab31a845Sdan     pWalker->eCode = 0;
1886ab31a845Sdan     return WRC_Abort;
1887ab31a845Sdan   }
1888ab31a845Sdan 
1889ab31a845Sdan   return exprNodeIsConstant(pWalker, pExpr);
1890ab31a845Sdan }
1891ab31a845Sdan 
1892ab31a845Sdan /*
1893ab31a845Sdan ** Walk the expression tree passed as the first argument. Return non-zero
1894ab31a845Sdan ** if the expression consists entirely of constants or copies of terms
1895ab31a845Sdan ** in pGroupBy that sort with the BINARY collation sequence.
1896ab314001Sdrh **
1897ab314001Sdrh ** This routine is used to determine if a term of the HAVING clause can
1898ab314001Sdrh ** be promoted into the WHERE clause.  In order for such a promotion to work,
1899ab314001Sdrh ** the value of the HAVING clause term must be the same for all members of
1900ab314001Sdrh ** a "group".  The requirement that the GROUP BY term must be BINARY
1901ab314001Sdrh ** assumes that no other collating sequence will have a finer-grained
1902ab314001Sdrh ** grouping than binary.  In other words (A=B COLLATE binary) implies
1903ab314001Sdrh ** A=B in every other collating sequence.  The requirement that the
1904ab314001Sdrh ** GROUP BY be BINARY is stricter than necessary.  It would also work
1905ab314001Sdrh ** to promote HAVING clauses that use the same alternative collating
1906ab314001Sdrh ** sequence as the GROUP BY term, but that is much harder to check,
1907ab314001Sdrh ** alternative collating sequences are uncommon, and this is only an
1908ab314001Sdrh ** optimization, so we take the easy way out and simply require the
1909ab314001Sdrh ** GROUP BY to use the BINARY collating sequence.
1910ab31a845Sdan */
1911ab31a845Sdan int sqlite3ExprIsConstantOrGroupBy(Parse *pParse, Expr *p, ExprList *pGroupBy){
1912ab31a845Sdan   Walker w;
1913ab31a845Sdan   w.eCode = 1;
1914ab31a845Sdan   w.xExprCallback = exprNodeIsConstantOrGroupBy;
1915979dd1beSdrh   w.xSelectCallback = 0;
1916ab31a845Sdan   w.u.pGroupBy = pGroupBy;
1917ab31a845Sdan   w.pParse = pParse;
1918ab31a845Sdan   sqlite3WalkExpr(&w, p);
1919ab31a845Sdan   return w.eCode;
1920ab31a845Sdan }
1921ab31a845Sdan 
1922059b2d50Sdrh /*
1923059b2d50Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
1924eb55bd2fSdrh ** or a function call with constant arguments.  Return and 0 if there
1925eb55bd2fSdrh ** are any variables.
1926eb55bd2fSdrh **
1927eb55bd2fSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
1928eb55bd2fSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
1929eb55bd2fSdrh ** a constant.
1930eb55bd2fSdrh */
1931feada2dfSdrh int sqlite3ExprIsConstantOrFunction(Expr *p, u8 isInit){
1932feada2dfSdrh   assert( isInit==0 || isInit==1 );
1933059b2d50Sdrh   return exprIsConst(p, 4+isInit, 0);
1934eb55bd2fSdrh }
1935eb55bd2fSdrh 
19365b88bc4bSdrh #ifdef SQLITE_ENABLE_CURSOR_HINTS
19375b88bc4bSdrh /*
19385b88bc4bSdrh ** Walk an expression tree.  Return 1 if the expression contains a
19395b88bc4bSdrh ** subquery of some kind.  Return 0 if there are no subqueries.
19405b88bc4bSdrh */
19415b88bc4bSdrh int sqlite3ExprContainsSubquery(Expr *p){
19425b88bc4bSdrh   Walker w;
1943bec2476aSdrh   w.eCode = 1;
19445b88bc4bSdrh   w.xExprCallback = sqlite3ExprWalkNoop;
19457e6f980bSdrh   w.xSelectCallback = sqlite3SelectWalkFail;
1946979dd1beSdrh #ifdef SQLITE_DEBUG
1947979dd1beSdrh   w.xSelectCallback2 = sqlite3SelectWalkAssert2;
1948979dd1beSdrh #endif
19495b88bc4bSdrh   sqlite3WalkExpr(&w, p);
195007194bffSdrh   return w.eCode==0;
19515b88bc4bSdrh }
19525b88bc4bSdrh #endif
19535b88bc4bSdrh 
1954eb55bd2fSdrh /*
195573b211abSdrh ** If the expression p codes a constant integer that is small enough
1956202b2df7Sdrh ** to fit in a 32-bit integer, return 1 and put the value of the integer
1957202b2df7Sdrh ** in *pValue.  If the expression is not an integer or if it is too big
1958202b2df7Sdrh ** to fit in a signed 32-bit integer, return 0 and leave *pValue unchanged.
1959e4de1febSdrh */
19604adee20fSdanielk1977 int sqlite3ExprIsInteger(Expr *p, int *pValue){
196192b01d53Sdrh   int rc = 0;
1962ba28b5abSdrh   if( p==0 ) return 0;  /* Can only happen following on OOM */
1963cd92e84dSdrh 
1964cd92e84dSdrh   /* If an expression is an integer literal that fits in a signed 32-bit
1965cd92e84dSdrh   ** integer, then the EP_IntValue flag will have already been set */
1966cd92e84dSdrh   assert( p->op!=TK_INTEGER || (p->flags & EP_IntValue)!=0
1967cd92e84dSdrh            || sqlite3GetInt32(p->u.zToken, &rc)==0 );
1968cd92e84dSdrh 
196992b01d53Sdrh   if( p->flags & EP_IntValue ){
197033e619fcSdrh     *pValue = p->u.iValue;
1971e4de1febSdrh     return 1;
1972e4de1febSdrh   }
197392b01d53Sdrh   switch( p->op ){
19744b59ab5eSdrh     case TK_UPLUS: {
197592b01d53Sdrh       rc = sqlite3ExprIsInteger(p->pLeft, pValue);
1976f6e369a1Sdrh       break;
19774b59ab5eSdrh     }
1978e4de1febSdrh     case TK_UMINUS: {
1979e4de1febSdrh       int v;
19804adee20fSdanielk1977       if( sqlite3ExprIsInteger(p->pLeft, &v) ){
1981f6418891Smistachkin         assert( v!=(-2147483647-1) );
1982e4de1febSdrh         *pValue = -v;
198392b01d53Sdrh         rc = 1;
1984e4de1febSdrh       }
1985e4de1febSdrh       break;
1986e4de1febSdrh     }
1987e4de1febSdrh     default: break;
1988e4de1febSdrh   }
198992b01d53Sdrh   return rc;
1990e4de1febSdrh }
1991e4de1febSdrh 
1992e4de1febSdrh /*
1993039fc32eSdrh ** Return FALSE if there is no chance that the expression can be NULL.
1994039fc32eSdrh **
1995039fc32eSdrh ** If the expression might be NULL or if the expression is too complex
1996039fc32eSdrh ** to tell return TRUE.
1997039fc32eSdrh **
1998039fc32eSdrh ** This routine is used as an optimization, to skip OP_IsNull opcodes
1999039fc32eSdrh ** when we know that a value cannot be NULL.  Hence, a false positive
2000039fc32eSdrh ** (returning TRUE when in fact the expression can never be NULL) might
2001039fc32eSdrh ** be a small performance hit but is otherwise harmless.  On the other
2002039fc32eSdrh ** hand, a false negative (returning FALSE when the result could be NULL)
2003039fc32eSdrh ** will likely result in an incorrect answer.  So when in doubt, return
2004039fc32eSdrh ** TRUE.
2005039fc32eSdrh */
2006039fc32eSdrh int sqlite3ExprCanBeNull(const Expr *p){
2007039fc32eSdrh   u8 op;
2008cd7f457eSdrh   while( p->op==TK_UPLUS || p->op==TK_UMINUS ){ p = p->pLeft; }
2009039fc32eSdrh   op = p->op;
2010039fc32eSdrh   if( op==TK_REGISTER ) op = p->op2;
2011039fc32eSdrh   switch( op ){
2012039fc32eSdrh     case TK_INTEGER:
2013039fc32eSdrh     case TK_STRING:
2014039fc32eSdrh     case TK_FLOAT:
2015039fc32eSdrh     case TK_BLOB:
2016039fc32eSdrh       return 0;
20177248a8b2Sdrh     case TK_COLUMN:
201872673a24Sdrh       return ExprHasProperty(p, EP_CanBeNull) ||
20194dd89d5aSdrh              p->pTab==0 ||  /* Reference to column of index on expression */
202072673a24Sdrh              (p->iColumn>=0 && p->pTab->aCol[p->iColumn].notNull==0);
2021039fc32eSdrh     default:
2022039fc32eSdrh       return 1;
2023039fc32eSdrh   }
2024039fc32eSdrh }
2025039fc32eSdrh 
2026039fc32eSdrh /*
2027039fc32eSdrh ** Return TRUE if the given expression is a constant which would be
2028039fc32eSdrh ** unchanged by OP_Affinity with the affinity given in the second
2029039fc32eSdrh ** argument.
2030039fc32eSdrh **
2031039fc32eSdrh ** This routine is used to determine if the OP_Affinity operation
2032039fc32eSdrh ** can be omitted.  When in doubt return FALSE.  A false negative
2033039fc32eSdrh ** is harmless.  A false positive, however, can result in the wrong
2034039fc32eSdrh ** answer.
2035039fc32eSdrh */
2036039fc32eSdrh int sqlite3ExprNeedsNoAffinityChange(const Expr *p, char aff){
2037039fc32eSdrh   u8 op;
203805883a34Sdrh   if( aff==SQLITE_AFF_BLOB ) return 1;
2039cd7f457eSdrh   while( p->op==TK_UPLUS || p->op==TK_UMINUS ){ p = p->pLeft; }
2040039fc32eSdrh   op = p->op;
2041039fc32eSdrh   if( op==TK_REGISTER ) op = p->op2;
2042039fc32eSdrh   switch( op ){
2043039fc32eSdrh     case TK_INTEGER: {
2044039fc32eSdrh       return aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC;
2045039fc32eSdrh     }
2046039fc32eSdrh     case TK_FLOAT: {
2047039fc32eSdrh       return aff==SQLITE_AFF_REAL || aff==SQLITE_AFF_NUMERIC;
2048039fc32eSdrh     }
2049039fc32eSdrh     case TK_STRING: {
2050039fc32eSdrh       return aff==SQLITE_AFF_TEXT;
2051039fc32eSdrh     }
2052039fc32eSdrh     case TK_BLOB: {
2053039fc32eSdrh       return 1;
2054039fc32eSdrh     }
20552f2855b6Sdrh     case TK_COLUMN: {
205688376ca7Sdrh       assert( p->iTable>=0 );  /* p cannot be part of a CHECK constraint */
205788376ca7Sdrh       return p->iColumn<0
20582f2855b6Sdrh           && (aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC);
20592f2855b6Sdrh     }
2060039fc32eSdrh     default: {
2061039fc32eSdrh       return 0;
2062039fc32eSdrh     }
2063039fc32eSdrh   }
2064039fc32eSdrh }
2065039fc32eSdrh 
2066039fc32eSdrh /*
2067c4a3c779Sdrh ** Return TRUE if the given string is a row-id column name.
2068c4a3c779Sdrh */
20694adee20fSdanielk1977 int sqlite3IsRowid(const char *z){
20704adee20fSdanielk1977   if( sqlite3StrICmp(z, "_ROWID_")==0 ) return 1;
20714adee20fSdanielk1977   if( sqlite3StrICmp(z, "ROWID")==0 ) return 1;
20724adee20fSdanielk1977   if( sqlite3StrICmp(z, "OID")==0 ) return 1;
2073c4a3c779Sdrh   return 0;
2074c4a3c779Sdrh }
2075c4a3c779Sdrh 
20769a96b668Sdanielk1977 /*
207769c355bdSdrh ** pX is the RHS of an IN operator.  If pX is a SELECT statement
207869c355bdSdrh ** that can be simplified to a direct table access, then return
207969c355bdSdrh ** a pointer to the SELECT statement.  If pX is not a SELECT statement,
208069c355bdSdrh ** or if the SELECT statement needs to be manifested into a transient
208169c355bdSdrh ** table, then return NULL.
2082b287f4b6Sdrh */
2083b287f4b6Sdrh #ifndef SQLITE_OMIT_SUBQUERY
20847b35a77bSdan static Select *isCandidateForInOpt(Expr *pX){
208569c355bdSdrh   Select *p;
2086b287f4b6Sdrh   SrcList *pSrc;
2087b287f4b6Sdrh   ExprList *pEList;
2088b287f4b6Sdrh   Table *pTab;
2089cfbb5e82Sdan   int i;
209069c355bdSdrh   if( !ExprHasProperty(pX, EP_xIsSelect) ) return 0;  /* Not a subquery */
209169c355bdSdrh   if( ExprHasProperty(pX, EP_VarSelect)  ) return 0;  /* Correlated subq */
209269c355bdSdrh   p = pX->x.pSelect;
2093b287f4b6Sdrh   if( p->pPrior ) return 0;              /* Not a compound SELECT */
20947d10d5a6Sdrh   if( p->selFlags & (SF_Distinct|SF_Aggregate) ){
2095b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
2096b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
20977d10d5a6Sdrh     return 0; /* No DISTINCT keyword and no aggregate functions */
20987d10d5a6Sdrh   }
2099b74b1017Sdrh   assert( p->pGroupBy==0 );              /* Has no GROUP BY clause */
2100b287f4b6Sdrh   if( p->pLimit ) return 0;              /* Has no LIMIT clause */
2101b74b1017Sdrh   assert( p->pOffset==0 );               /* No LIMIT means no OFFSET */
2102b287f4b6Sdrh   if( p->pWhere ) return 0;              /* Has no WHERE clause */
2103b287f4b6Sdrh   pSrc = p->pSrc;
2104d1fa7bcaSdrh   assert( pSrc!=0 );
2105d1fa7bcaSdrh   if( pSrc->nSrc!=1 ) return 0;          /* Single term in FROM clause */
2106b74b1017Sdrh   if( pSrc->a[0].pSelect ) return 0;     /* FROM is not a subquery or view */
2107b287f4b6Sdrh   pTab = pSrc->a[0].pTab;
210869c355bdSdrh   assert( pTab!=0 );
2109b74b1017Sdrh   assert( pTab->pSelect==0 );            /* FROM clause is not a view */
2110b287f4b6Sdrh   if( IsVirtual(pTab) ) return 0;        /* FROM clause not a virtual table */
2111b287f4b6Sdrh   pEList = p->pEList;
2112ac6b47d1Sdrh   assert( pEList!=0 );
21137b35a77bSdan   /* All SELECT results must be columns. */
2114cfbb5e82Sdan   for(i=0; i<pEList->nExpr; i++){
2115cfbb5e82Sdan     Expr *pRes = pEList->a[i].pExpr;
2116cfbb5e82Sdan     if( pRes->op!=TK_COLUMN ) return 0;
211769c355bdSdrh     assert( pRes->iTable==pSrc->a[0].iCursor );  /* Not a correlated subquery */
2118cfbb5e82Sdan   }
211969c355bdSdrh   return p;
2120b287f4b6Sdrh }
2121b287f4b6Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
2122b287f4b6Sdrh 
2123f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
21241d8cb21fSdan /*
21254c259e9fSdrh ** Generate code that checks the left-most column of index table iCur to see if
21264c259e9fSdrh ** it contains any NULL entries.  Cause the register at regHasNull to be set
21276be515ebSdrh ** to a non-NULL value if iCur contains no NULLs.  Cause register regHasNull
21286be515ebSdrh ** to be set to NULL if iCur contains one or more NULL values.
21296be515ebSdrh */
21306be515ebSdrh static void sqlite3SetHasNullFlag(Vdbe *v, int iCur, int regHasNull){
2131728e0f91Sdrh   int addr1;
21326be515ebSdrh   sqlite3VdbeAddOp2(v, OP_Integer, 0, regHasNull);
2133728e0f91Sdrh   addr1 = sqlite3VdbeAddOp1(v, OP_Rewind, iCur); VdbeCoverage(v);
21346be515ebSdrh   sqlite3VdbeAddOp3(v, OP_Column, iCur, 0, regHasNull);
21356be515ebSdrh   sqlite3VdbeChangeP5(v, OPFLAG_TYPEOFARG);
21364c259e9fSdrh   VdbeComment((v, "first_entry_in(%d)", iCur));
2137728e0f91Sdrh   sqlite3VdbeJumpHere(v, addr1);
21386be515ebSdrh }
2139f9b2e05cSdan #endif
21406be515ebSdrh 
2141bb53ecb1Sdrh 
2142bb53ecb1Sdrh #ifndef SQLITE_OMIT_SUBQUERY
2143bb53ecb1Sdrh /*
2144bb53ecb1Sdrh ** The argument is an IN operator with a list (not a subquery) on the
2145bb53ecb1Sdrh ** right-hand side.  Return TRUE if that list is constant.
2146bb53ecb1Sdrh */
2147bb53ecb1Sdrh static int sqlite3InRhsIsConstant(Expr *pIn){
2148bb53ecb1Sdrh   Expr *pLHS;
2149bb53ecb1Sdrh   int res;
2150bb53ecb1Sdrh   assert( !ExprHasProperty(pIn, EP_xIsSelect) );
2151bb53ecb1Sdrh   pLHS = pIn->pLeft;
2152bb53ecb1Sdrh   pIn->pLeft = 0;
2153bb53ecb1Sdrh   res = sqlite3ExprIsConstant(pIn);
2154bb53ecb1Sdrh   pIn->pLeft = pLHS;
2155bb53ecb1Sdrh   return res;
2156bb53ecb1Sdrh }
2157bb53ecb1Sdrh #endif
2158bb53ecb1Sdrh 
21596be515ebSdrh /*
21609a96b668Sdanielk1977 ** This function is used by the implementation of the IN (...) operator.
2161d4305ca6Sdrh ** The pX parameter is the expression on the RHS of the IN operator, which
2162d4305ca6Sdrh ** might be either a list of expressions or a subquery.
21639a96b668Sdanielk1977 **
2164d4305ca6Sdrh ** The job of this routine is to find or create a b-tree object that can
2165d4305ca6Sdrh ** be used either to test for membership in the RHS set or to iterate through
2166d4305ca6Sdrh ** all members of the RHS set, skipping duplicates.
2167d4305ca6Sdrh **
21683a85625dSdrh ** A cursor is opened on the b-tree object that is the RHS of the IN operator
2169d4305ca6Sdrh ** and pX->iTable is set to the index of that cursor.
2170d4305ca6Sdrh **
2171b74b1017Sdrh ** The returned value of this function indicates the b-tree type, as follows:
21729a96b668Sdanielk1977 **
21739a96b668Sdanielk1977 **   IN_INDEX_ROWID      - The cursor was opened on a database table.
21741ccce449Sdrh **   IN_INDEX_INDEX_ASC  - The cursor was opened on an ascending index.
21751ccce449Sdrh **   IN_INDEX_INDEX_DESC - The cursor was opened on a descending index.
21769a96b668Sdanielk1977 **   IN_INDEX_EPH        - The cursor was opened on a specially created and
21779a96b668Sdanielk1977 **                         populated epheremal table.
2178bb53ecb1Sdrh **   IN_INDEX_NOOP       - No cursor was allocated.  The IN operator must be
2179bb53ecb1Sdrh **                         implemented as a sequence of comparisons.
21809a96b668Sdanielk1977 **
2181d4305ca6Sdrh ** An existing b-tree might be used if the RHS expression pX is a simple
2182d4305ca6Sdrh ** subquery such as:
21839a96b668Sdanielk1977 **
2184553168c7Sdan **     SELECT <column1>, <column2>... FROM <table>
21859a96b668Sdanielk1977 **
2186d4305ca6Sdrh ** If the RHS of the IN operator is a list or a more complex subquery, then
2187d4305ca6Sdrh ** an ephemeral table might need to be generated from the RHS and then
218860ec914cSpeter.d.reid ** pX->iTable made to point to the ephemeral table instead of an
2189d4305ca6Sdrh ** existing table.
2190d4305ca6Sdrh **
21913a85625dSdrh ** The inFlags parameter must contain exactly one of the bits
21923a85625dSdrh ** IN_INDEX_MEMBERSHIP or IN_INDEX_LOOP.  If inFlags contains
21933a85625dSdrh ** IN_INDEX_MEMBERSHIP, then the generated table will be used for a
21943a85625dSdrh ** fast membership test.  When the IN_INDEX_LOOP bit is set, the
21953a85625dSdrh ** IN index will be used to loop over all values of the RHS of the
21963a85625dSdrh ** IN operator.
21973a85625dSdrh **
21983a85625dSdrh ** When IN_INDEX_LOOP is used (and the b-tree will be used to iterate
21993a85625dSdrh ** through the set members) then the b-tree must not contain duplicates.
2200553168c7Sdan ** An epheremal table must be used unless the selected columns are guaranteed
2201553168c7Sdan ** to be unique - either because it is an INTEGER PRIMARY KEY or due to
2202553168c7Sdan ** a UNIQUE constraint or index.
22030cdc022eSdanielk1977 **
22043a85625dSdrh ** When IN_INDEX_MEMBERSHIP is used (and the b-tree will be used
22053a85625dSdrh ** for fast set membership tests) then an epheremal table must
2206553168c7Sdan ** be used unless <columns> is a single INTEGER PRIMARY KEY column or an
2207553168c7Sdan ** index can be found with the specified <columns> as its left-most.
22080cdc022eSdanielk1977 **
2209bb53ecb1Sdrh ** If the IN_INDEX_NOOP_OK and IN_INDEX_MEMBERSHIP are both set and
2210bb53ecb1Sdrh ** if the RHS of the IN operator is a list (not a subquery) then this
2211bb53ecb1Sdrh ** routine might decide that creating an ephemeral b-tree for membership
2212bb53ecb1Sdrh ** testing is too expensive and return IN_INDEX_NOOP.  In that case, the
2213bb53ecb1Sdrh ** calling routine should implement the IN operator using a sequence
2214bb53ecb1Sdrh ** of Eq or Ne comparison operations.
2215bb53ecb1Sdrh **
2216b74b1017Sdrh ** When the b-tree is being used for membership tests, the calling function
22173a85625dSdrh ** might need to know whether or not the RHS side of the IN operator
2218e21a6e1dSdrh ** contains a NULL.  If prRhsHasNull is not a NULL pointer and
22193a85625dSdrh ** if there is any chance that the (...) might contain a NULL value at
22200cdc022eSdanielk1977 ** runtime, then a register is allocated and the register number written
2221e21a6e1dSdrh ** to *prRhsHasNull. If there is no chance that the (...) contains a
2222e21a6e1dSdrh ** NULL value, then *prRhsHasNull is left unchanged.
22230cdc022eSdanielk1977 **
2224e21a6e1dSdrh ** If a register is allocated and its location stored in *prRhsHasNull, then
22256be515ebSdrh ** the value in that register will be NULL if the b-tree contains one or more
22266be515ebSdrh ** NULL values, and it will be some non-NULL value if the b-tree contains no
22276be515ebSdrh ** NULL values.
2228553168c7Sdan **
2229553168c7Sdan ** If the aiMap parameter is not NULL, it must point to an array containing
2230553168c7Sdan ** one element for each column returned by the SELECT statement on the RHS
2231553168c7Sdan ** of the IN(...) operator. The i'th entry of the array is populated with the
2232553168c7Sdan ** offset of the index column that matches the i'th column returned by the
2233553168c7Sdan ** SELECT. For example, if the expression and selected index are:
2234553168c7Sdan **
2235553168c7Sdan **   (?,?,?) IN (SELECT a, b, c FROM t1)
2236553168c7Sdan **   CREATE INDEX i1 ON t1(b, c, a);
2237553168c7Sdan **
2238553168c7Sdan ** then aiMap[] is populated with {2, 0, 1}.
22399a96b668Sdanielk1977 */
2240284f4acaSdanielk1977 #ifndef SQLITE_OMIT_SUBQUERY
2241ba00e30aSdan int sqlite3FindInIndex(
22426fc8f364Sdrh   Parse *pParse,             /* Parsing context */
22436fc8f364Sdrh   Expr *pX,                  /* The right-hand side (RHS) of the IN operator */
22446fc8f364Sdrh   u32 inFlags,               /* IN_INDEX_LOOP, _MEMBERSHIP, and/or _NOOP_OK */
22456fc8f364Sdrh   int *prRhsHasNull,         /* Register holding NULL status.  See notes */
22466fc8f364Sdrh   int *aiMap                 /* Mapping from Index fields to RHS fields */
2247ba00e30aSdan ){
2248b74b1017Sdrh   Select *p;                            /* SELECT to the right of IN operator */
2249b74b1017Sdrh   int eType = 0;                        /* Type of RHS table. IN_INDEX_* */
2250b74b1017Sdrh   int iTab = pParse->nTab++;            /* Cursor of the RHS table */
22513a85625dSdrh   int mustBeUnique;                     /* True if RHS must be unique */
2252b8475df8Sdrh   Vdbe *v = sqlite3GetVdbe(pParse);     /* Virtual machine being coded */
22539a96b668Sdanielk1977 
22541450bc6eSdrh   assert( pX->op==TK_IN );
22553a85625dSdrh   mustBeUnique = (inFlags & IN_INDEX_LOOP)!=0;
22561450bc6eSdrh 
22577b35a77bSdan   /* If the RHS of this IN(...) operator is a SELECT, and if it matters
22587b35a77bSdan   ** whether or not the SELECT result contains NULL values, check whether
2259870a0705Sdan   ** or not NULL is actually possible (it may not be, for example, due
22607b35a77bSdan   ** to NOT NULL constraints in the schema). If no NULL values are possible,
2261870a0705Sdan   ** set prRhsHasNull to 0 before continuing.  */
22627b35a77bSdan   if( prRhsHasNull && (pX->flags & EP_xIsSelect) ){
22637b35a77bSdan     int i;
22647b35a77bSdan     ExprList *pEList = pX->x.pSelect->pEList;
22657b35a77bSdan     for(i=0; i<pEList->nExpr; i++){
22667b35a77bSdan       if( sqlite3ExprCanBeNull(pEList->a[i].pExpr) ) break;
22677b35a77bSdan     }
22687b35a77bSdan     if( i==pEList->nExpr ){
22697b35a77bSdan       prRhsHasNull = 0;
22707b35a77bSdan     }
22717b35a77bSdan   }
22727b35a77bSdan 
2273b74b1017Sdrh   /* Check to see if an existing table or index can be used to
2274b74b1017Sdrh   ** satisfy the query.  This is preferable to generating a new
22757b35a77bSdan   ** ephemeral table.  */
22767b35a77bSdan   if( pParse->nErr==0 && (p = isCandidateForInOpt(pX))!=0 ){
2277e1fb65a0Sdanielk1977     sqlite3 *db = pParse->db;              /* Database connection */
2278b07028f7Sdrh     Table *pTab;                           /* Table <table>. */
2279ba00e30aSdan     i16 iDb;                               /* Database idx for pTab */
2280cfbb5e82Sdan     ExprList *pEList = p->pEList;
2281cfbb5e82Sdan     int nExpr = pEList->nExpr;
2282e1fb65a0Sdanielk1977 
2283b07028f7Sdrh     assert( p->pEList!=0 );             /* Because of isCandidateForInOpt(p) */
2284b07028f7Sdrh     assert( p->pEList->a[0].pExpr!=0 ); /* Because of isCandidateForInOpt(p) */
2285b07028f7Sdrh     assert( p->pSrc!=0 );               /* Because of isCandidateForInOpt(p) */
2286b07028f7Sdrh     pTab = p->pSrc->a[0].pTab;
2287b07028f7Sdrh 
2288b22f7c83Sdrh     /* Code an OP_Transaction and OP_TableLock for <table>. */
2289e1fb65a0Sdanielk1977     iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
2290e1fb65a0Sdanielk1977     sqlite3CodeVerifySchema(pParse, iDb);
2291e1fb65a0Sdanielk1977     sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
22929a96b668Sdanielk1977 
2293a84a283dSdrh     assert(v);  /* sqlite3GetVdbe() has always been previously called */
2294cfbb5e82Sdan     if( nExpr==1 && pEList->a[0].pExpr->iColumn<0 ){
229562659b2aSdrh       /* The "x IN (SELECT rowid FROM table)" case */
2296511f9e8dSdrh       int iAddr = sqlite3VdbeAddOp0(v, OP_Once);
22977d176105Sdrh       VdbeCoverage(v);
22989a96b668Sdanielk1977 
22999a96b668Sdanielk1977       sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
23009a96b668Sdanielk1977       eType = IN_INDEX_ROWID;
23019a96b668Sdanielk1977 
23029a96b668Sdanielk1977       sqlite3VdbeJumpHere(v, iAddr);
23039a96b668Sdanielk1977     }else{
2304e1fb65a0Sdanielk1977       Index *pIdx;                         /* Iterator variable */
2305cfbb5e82Sdan       int affinity_ok = 1;
2306cfbb5e82Sdan       int i;
2307cfbb5e82Sdan 
2308cfbb5e82Sdan       /* Check that the affinity that will be used to perform each
230962659b2aSdrh       ** comparison is the same as the affinity of each column in table
231062659b2aSdrh       ** on the RHS of the IN operator.  If it not, it is not possible to
231162659b2aSdrh       ** use any index of the RHS table.  */
2312cfbb5e82Sdan       for(i=0; i<nExpr && affinity_ok; i++){
2313fc7f27b9Sdrh         Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2314cfbb5e82Sdan         int iCol = pEList->a[i].pExpr->iColumn;
23150dfa4f6fSdrh         char idxaff = sqlite3TableColumnAffinity(pTab,iCol); /* RHS table */
2316cfbb5e82Sdan         char cmpaff = sqlite3CompareAffinity(pLhs, idxaff);
231762659b2aSdrh         testcase( cmpaff==SQLITE_AFF_BLOB );
231862659b2aSdrh         testcase( cmpaff==SQLITE_AFF_TEXT );
2319cfbb5e82Sdan         switch( cmpaff ){
2320cfbb5e82Sdan           case SQLITE_AFF_BLOB:
2321cfbb5e82Sdan             break;
2322cfbb5e82Sdan           case SQLITE_AFF_TEXT:
232362659b2aSdrh             /* sqlite3CompareAffinity() only returns TEXT if one side or the
232462659b2aSdrh             ** other has no affinity and the other side is TEXT.  Hence,
232562659b2aSdrh             ** the only way for cmpaff to be TEXT is for idxaff to be TEXT
232662659b2aSdrh             ** and for the term on the LHS of the IN to have no affinity. */
232762659b2aSdrh             assert( idxaff==SQLITE_AFF_TEXT );
2328cfbb5e82Sdan             break;
2329cfbb5e82Sdan           default:
2330cfbb5e82Sdan             affinity_ok = sqlite3IsNumericAffinity(idxaff);
2331cfbb5e82Sdan         }
2332cfbb5e82Sdan       }
2333e1fb65a0Sdanielk1977 
2334a84a283dSdrh       if( affinity_ok ){
2335a84a283dSdrh         /* Search for an existing index that will work for this IN operator */
2336a84a283dSdrh         for(pIdx=pTab->pIndex; pIdx && eType==0; pIdx=pIdx->pNext){
2337a84a283dSdrh           Bitmask colUsed;      /* Columns of the index used */
2338a84a283dSdrh           Bitmask mCol;         /* Mask for the current column */
23396fc8f364Sdrh           if( pIdx->nColumn<nExpr ) continue;
2340a84a283dSdrh           /* Maximum nColumn is BMS-2, not BMS-1, so that we can compute
2341a84a283dSdrh           ** BITMASK(nExpr) without overflowing */
2342a84a283dSdrh           testcase( pIdx->nColumn==BMS-2 );
2343a84a283dSdrh           testcase( pIdx->nColumn==BMS-1 );
2344a84a283dSdrh           if( pIdx->nColumn>=BMS-1 ) continue;
23456fc8f364Sdrh           if( mustBeUnique ){
23466fc8f364Sdrh             if( pIdx->nKeyCol>nExpr
23476fc8f364Sdrh              ||(pIdx->nColumn>nExpr && !IsUniqueIndex(pIdx))
23486fc8f364Sdrh             ){
2349a84a283dSdrh               continue;  /* This index is not unique over the IN RHS columns */
2350cfbb5e82Sdan             }
23516fc8f364Sdrh           }
2352cfbb5e82Sdan 
2353a84a283dSdrh           colUsed = 0;   /* Columns of index used so far */
2354cfbb5e82Sdan           for(i=0; i<nExpr; i++){
2355fc7f27b9Sdrh             Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2356cfbb5e82Sdan             Expr *pRhs = pEList->a[i].pExpr;
2357cfbb5e82Sdan             CollSeq *pReq = sqlite3BinaryCompareCollSeq(pParse, pLhs, pRhs);
2358cfbb5e82Sdan             int j;
2359cfbb5e82Sdan 
23606fc8f364Sdrh             assert( pReq!=0 || pRhs->iColumn==XN_ROWID || pParse->nErr );
2361cfbb5e82Sdan             for(j=0; j<nExpr; j++){
2362cfbb5e82Sdan               if( pIdx->aiColumn[j]!=pRhs->iColumn ) continue;
2363cfbb5e82Sdan               assert( pIdx->azColl[j] );
2364106526e1Sdrh               if( pReq!=0 && sqlite3StrICmp(pReq->zName, pIdx->azColl[j])!=0 ){
2365106526e1Sdrh                 continue;
2366106526e1Sdrh               }
2367cfbb5e82Sdan               break;
2368cfbb5e82Sdan             }
2369cfbb5e82Sdan             if( j==nExpr ) break;
2370a84a283dSdrh             mCol = MASKBIT(j);
2371a84a283dSdrh             if( mCol & colUsed ) break; /* Each column used only once */
2372a84a283dSdrh             colUsed |= mCol;
2373ba00e30aSdan             if( aiMap ) aiMap[i] = j;
2374cfbb5e82Sdan           }
2375cfbb5e82Sdan 
2376a84a283dSdrh           assert( i==nExpr || colUsed!=(MASKBIT(nExpr)-1) );
2377a84a283dSdrh           if( colUsed==(MASKBIT(nExpr)-1) ){
2378a84a283dSdrh             /* If we reach this point, that means the index pIdx is usable */
2379511f9e8dSdrh             int iAddr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
2380363fb95bSdrh #ifndef SQLITE_OMIT_EXPLAIN
2381363fb95bSdrh             sqlite3VdbeAddOp4(v, OP_Explain, 0, 0, 0,
2382363fb95bSdrh               sqlite3MPrintf(db, "USING INDEX %s FOR IN-OPERATOR",pIdx->zName),
2383363fb95bSdrh               P4_DYNAMIC);
2384363fb95bSdrh #endif
23852ec2fb22Sdrh             sqlite3VdbeAddOp3(v, OP_OpenRead, iTab, pIdx->tnum, iDb);
23862ec2fb22Sdrh             sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
2387207872a4Sdanielk1977             VdbeComment((v, "%s", pIdx->zName));
23881ccce449Sdrh             assert( IN_INDEX_INDEX_DESC == IN_INDEX_INDEX_ASC+1 );
23891ccce449Sdrh             eType = IN_INDEX_INDEX_ASC + pIdx->aSortOrder[0];
23909a96b668Sdanielk1977 
23917b35a77bSdan             if( prRhsHasNull ){
23923480bfdaSdan #ifdef SQLITE_ENABLE_COLUMN_USED_MASK
2393cfbb5e82Sdan               i64 mask = (1<<nExpr)-1;
23943480bfdaSdan               sqlite3VdbeAddOp4Dup8(v, OP_ColumnsUsed,
2395cfbb5e82Sdan                   iTab, 0, 0, (u8*)&mask, P4_INT64);
23963480bfdaSdan #endif
2397b80dbdc2Sdrh               *prRhsHasNull = ++pParse->nMem;
23987b35a77bSdan               if( nExpr==1 ){
23996be515ebSdrh                 sqlite3SetHasNullFlag(v, iTab, *prRhsHasNull);
24000cdc022eSdanielk1977               }
24017b35a77bSdan             }
2402552fd454Sdrh             sqlite3VdbeJumpHere(v, iAddr);
24039a96b668Sdanielk1977           }
2404a84a283dSdrh         } /* End loop over indexes */
2405a84a283dSdrh       } /* End if( affinity_ok ) */
2406a84a283dSdrh     } /* End if not an rowid index */
2407a84a283dSdrh   } /* End attempt to optimize using an index */
24089a96b668Sdanielk1977 
2409bb53ecb1Sdrh   /* If no preexisting index is available for the IN clause
2410bb53ecb1Sdrh   ** and IN_INDEX_NOOP is an allowed reply
2411bb53ecb1Sdrh   ** and the RHS of the IN operator is a list, not a subquery
241271c57db0Sdan   ** and the RHS is not constant or has two or fewer terms,
241360ec914cSpeter.d.reid   ** then it is not worth creating an ephemeral table to evaluate
2414bb53ecb1Sdrh   ** the IN operator so return IN_INDEX_NOOP.
2415bb53ecb1Sdrh   */
2416bb53ecb1Sdrh   if( eType==0
2417bb53ecb1Sdrh    && (inFlags & IN_INDEX_NOOP_OK)
2418bb53ecb1Sdrh    && !ExprHasProperty(pX, EP_xIsSelect)
2419bb53ecb1Sdrh    && (!sqlite3InRhsIsConstant(pX) || pX->x.pList->nExpr<=2)
2420bb53ecb1Sdrh   ){
2421bb53ecb1Sdrh     eType = IN_INDEX_NOOP;
2422bb53ecb1Sdrh   }
2423bb53ecb1Sdrh 
24249a96b668Sdanielk1977   if( eType==0 ){
24254387006cSdrh     /* Could not find an existing table or index to use as the RHS b-tree.
2426b74b1017Sdrh     ** We will have to generate an ephemeral table to do the job.
2427b74b1017Sdrh     */
24288e23daf3Sdrh     u32 savedNQueryLoop = pParse->nQueryLoop;
24290cdc022eSdanielk1977     int rMayHaveNull = 0;
243041a05b7bSdanielk1977     eType = IN_INDEX_EPH;
24313a85625dSdrh     if( inFlags & IN_INDEX_LOOP ){
24324a5acf8eSdrh       pParse->nQueryLoop = 0;
2433c5cd1249Sdrh       if( pX->pLeft->iColumn<0 && !ExprHasProperty(pX, EP_xIsSelect) ){
243441a05b7bSdanielk1977         eType = IN_INDEX_ROWID;
24350cdc022eSdanielk1977       }
2436e21a6e1dSdrh     }else if( prRhsHasNull ){
2437e21a6e1dSdrh       *prRhsHasNull = rMayHaveNull = ++pParse->nMem;
2438cf4d38aaSdrh     }
243941a05b7bSdanielk1977     sqlite3CodeSubselect(pParse, pX, rMayHaveNull, eType==IN_INDEX_ROWID);
2440cf4d38aaSdrh     pParse->nQueryLoop = savedNQueryLoop;
24419a96b668Sdanielk1977   }else{
24429a96b668Sdanielk1977     pX->iTable = iTab;
24439a96b668Sdanielk1977   }
2444ba00e30aSdan 
2445ba00e30aSdan   if( aiMap && eType!=IN_INDEX_INDEX_ASC && eType!=IN_INDEX_INDEX_DESC ){
2446ba00e30aSdan     int i, n;
2447ba00e30aSdan     n = sqlite3ExprVectorSize(pX->pLeft);
2448ba00e30aSdan     for(i=0; i<n; i++) aiMap[i] = i;
2449ba00e30aSdan   }
24509a96b668Sdanielk1977   return eType;
24519a96b668Sdanielk1977 }
2452284f4acaSdanielk1977 #endif
2453626a879aSdrh 
2454f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
2455553168c7Sdan /*
2456553168c7Sdan ** Argument pExpr is an (?, ?...) IN(...) expression. This
2457553168c7Sdan ** function allocates and returns a nul-terminated string containing
2458553168c7Sdan ** the affinities to be used for each column of the comparison.
2459553168c7Sdan **
2460553168c7Sdan ** It is the responsibility of the caller to ensure that the returned
2461553168c7Sdan ** string is eventually freed using sqlite3DbFree().
2462553168c7Sdan */
246371c57db0Sdan static char *exprINAffinity(Parse *pParse, Expr *pExpr){
246471c57db0Sdan   Expr *pLeft = pExpr->pLeft;
246571c57db0Sdan   int nVal = sqlite3ExprVectorSize(pLeft);
2466553168c7Sdan   Select *pSelect = (pExpr->flags & EP_xIsSelect) ? pExpr->x.pSelect : 0;
246771c57db0Sdan   char *zRet;
246871c57db0Sdan 
2469553168c7Sdan   assert( pExpr->op==TK_IN );
24705c258dc1Sdrh   zRet = sqlite3DbMallocRaw(pParse->db, nVal+1);
247171c57db0Sdan   if( zRet ){
247271c57db0Sdan     int i;
247371c57db0Sdan     for(i=0; i<nVal; i++){
2474fc7f27b9Sdrh       Expr *pA = sqlite3VectorFieldSubexpr(pLeft, i);
2475553168c7Sdan       char a = sqlite3ExprAffinity(pA);
2476553168c7Sdan       if( pSelect ){
2477553168c7Sdan         zRet[i] = sqlite3CompareAffinity(pSelect->pEList->a[i].pExpr, a);
247871c57db0Sdan       }else{
2479553168c7Sdan         zRet[i] = a;
248071c57db0Sdan       }
248171c57db0Sdan     }
248271c57db0Sdan     zRet[nVal] = '\0';
248371c57db0Sdan   }
248471c57db0Sdan   return zRet;
248571c57db0Sdan }
2486f9b2e05cSdan #endif
248771c57db0Sdan 
24888da209b1Sdan #ifndef SQLITE_OMIT_SUBQUERY
24898da209b1Sdan /*
24908da209b1Sdan ** Load the Parse object passed as the first argument with an error
24918da209b1Sdan ** message of the form:
24928da209b1Sdan **
24938da209b1Sdan **   "sub-select returns N columns - expected M"
24948da209b1Sdan */
24958da209b1Sdan void sqlite3SubselectError(Parse *pParse, int nActual, int nExpect){
24968da209b1Sdan   const char *zFmt = "sub-select returns %d columns - expected %d";
24978da209b1Sdan   sqlite3ErrorMsg(pParse, zFmt, nActual, nExpect);
24988da209b1Sdan }
24998da209b1Sdan #endif
25008da209b1Sdan 
2501626a879aSdrh /*
250244c5604cSdan ** Expression pExpr is a vector that has been used in a context where
250344c5604cSdan ** it is not permitted. If pExpr is a sub-select vector, this routine
250444c5604cSdan ** loads the Parse object with a message of the form:
250544c5604cSdan **
250644c5604cSdan **   "sub-select returns N columns - expected 1"
250744c5604cSdan **
250844c5604cSdan ** Or, if it is a regular scalar vector:
250944c5604cSdan **
251044c5604cSdan **   "row value misused"
251144c5604cSdan */
251244c5604cSdan void sqlite3VectorErrorMsg(Parse *pParse, Expr *pExpr){
251344c5604cSdan #ifndef SQLITE_OMIT_SUBQUERY
251444c5604cSdan   if( pExpr->flags & EP_xIsSelect ){
251544c5604cSdan     sqlite3SubselectError(pParse, pExpr->x.pSelect->pEList->nExpr, 1);
251644c5604cSdan   }else
251744c5604cSdan #endif
251844c5604cSdan   {
251944c5604cSdan     sqlite3ErrorMsg(pParse, "row value misused");
252044c5604cSdan   }
252144c5604cSdan }
252244c5604cSdan 
252344c5604cSdan /*
2524d4187c71Sdrh ** Generate code for scalar subqueries used as a subquery expression, EXISTS,
2525d4187c71Sdrh ** or IN operators.  Examples:
2526626a879aSdrh **
25279cbe6352Sdrh **     (SELECT a FROM b)          -- subquery
25289cbe6352Sdrh **     EXISTS (SELECT a FROM b)   -- EXISTS subquery
25299cbe6352Sdrh **     x IN (4,5,11)              -- IN operator with list on right-hand side
25309cbe6352Sdrh **     x IN (SELECT a FROM b)     -- IN operator with subquery on the right
2531fef5208cSdrh **
25329cbe6352Sdrh ** The pExpr parameter describes the expression that contains the IN
25339cbe6352Sdrh ** operator or subquery.
253441a05b7bSdanielk1977 **
253541a05b7bSdanielk1977 ** If parameter isRowid is non-zero, then expression pExpr is guaranteed
253641a05b7bSdanielk1977 ** to be of the form "<rowid> IN (?, ?, ?)", where <rowid> is a reference
253741a05b7bSdanielk1977 ** to some integer key column of a table B-Tree. In this case, use an
253841a05b7bSdanielk1977 ** intkey B-Tree to store the set of IN(...) values instead of the usual
253941a05b7bSdanielk1977 ** (slower) variable length keys B-Tree.
2540fd773cf9Sdrh **
2541fd773cf9Sdrh ** If rMayHaveNull is non-zero, that means that the operation is an IN
2542fd773cf9Sdrh ** (not a SELECT or EXISTS) and that the RHS might contains NULLs.
25433a85625dSdrh ** All this routine does is initialize the register given by rMayHaveNull
25443a85625dSdrh ** to NULL.  Calling routines will take care of changing this register
25453a85625dSdrh ** value to non-NULL if the RHS is NULL-free.
25461450bc6eSdrh **
25471450bc6eSdrh ** For a SELECT or EXISTS operator, return the register that holds the
254839a11819Sdrh ** result.  For a multi-column SELECT, the result is stored in a contiguous
254939a11819Sdrh ** array of registers and the return value is the register of the left-most
255039a11819Sdrh ** result column.  Return 0 for IN operators or if an error occurs.
2551cce7d176Sdrh */
255251522cd3Sdrh #ifndef SQLITE_OMIT_SUBQUERY
25531450bc6eSdrh int sqlite3CodeSubselect(
2554fd773cf9Sdrh   Parse *pParse,          /* Parsing context */
2555fd773cf9Sdrh   Expr *pExpr,            /* The IN, SELECT, or EXISTS operator */
25566be515ebSdrh   int rHasNullFlag,       /* Register that records whether NULLs exist in RHS */
2557fd773cf9Sdrh   int isRowid             /* If true, LHS of IN operator is a rowid */
255841a05b7bSdanielk1977 ){
25596be515ebSdrh   int jmpIfDynamic = -1;                      /* One-time test address */
25601450bc6eSdrh   int rReg = 0;                           /* Register storing resulting */
2561b3bce662Sdanielk1977   Vdbe *v = sqlite3GetVdbe(pParse);
25621450bc6eSdrh   if( NEVER(v==0) ) return 0;
2563ceea3321Sdrh   sqlite3ExprCachePush(pParse);
2564fc976065Sdanielk1977 
256539a11819Sdrh   /* The evaluation of the IN/EXISTS/SELECT must be repeated every time it
256639a11819Sdrh   ** is encountered if any of the following is true:
256757dbd7b3Sdrh   **
256857dbd7b3Sdrh   **    *  The right-hand side is a correlated subquery
256957dbd7b3Sdrh   **    *  The right-hand side is an expression list containing variables
257057dbd7b3Sdrh   **    *  We are inside a trigger
257157dbd7b3Sdrh   **
257257dbd7b3Sdrh   ** If all of the above are false, then we can run this code just once
257357dbd7b3Sdrh   ** save the results, and reuse the same result on subsequent invocations.
2574b3bce662Sdanielk1977   */
2575c5cd1249Sdrh   if( !ExprHasProperty(pExpr, EP_VarSelect) ){
2576511f9e8dSdrh     jmpIfDynamic = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
2577b3bce662Sdanielk1977   }
2578b3bce662Sdanielk1977 
25794a07e3dbSdan #ifndef SQLITE_OMIT_EXPLAIN
25804a07e3dbSdan   if( pParse->explain==2 ){
258162aaa6caSdrh     char *zMsg = sqlite3MPrintf(pParse->db, "EXECUTE %s%s SUBQUERY %d",
258262aaa6caSdrh         jmpIfDynamic>=0?"":"CORRELATED ",
258362aaa6caSdrh         pExpr->op==TK_IN?"LIST":"SCALAR",
258462aaa6caSdrh         pParse->iNextSelectId
25854a07e3dbSdan     );
25864a07e3dbSdan     sqlite3VdbeAddOp4(v, OP_Explain, pParse->iSelectId, 0, 0, zMsg, P4_DYNAMIC);
25874a07e3dbSdan   }
25884a07e3dbSdan #endif
25894a07e3dbSdan 
2590cce7d176Sdrh   switch( pExpr->op ){
2591fef5208cSdrh     case TK_IN: {
2592b9bb7c18Sdrh       int addr;                   /* Address of OP_OpenEphemeral instruction */
2593d4187c71Sdrh       Expr *pLeft = pExpr->pLeft; /* the LHS of the IN operator */
2594323df790Sdrh       KeyInfo *pKeyInfo = 0;      /* Key information */
259571c57db0Sdan       int nVal;                   /* Size of vector pLeft */
2596d3d39e93Sdrh 
259771c57db0Sdan       nVal = sqlite3ExprVectorSize(pLeft);
2598553168c7Sdan       assert( !isRowid || nVal==1 );
2599e014a838Sdanielk1977 
2600e014a838Sdanielk1977       /* Whether this is an 'x IN(SELECT...)' or an 'x IN(<exprlist>)'
26018cff69dfSdrh       ** expression it is handled the same way.  An ephemeral table is
2602553168c7Sdan       ** filled with index keys representing the results from the
2603553168c7Sdan       ** SELECT or the <exprlist>.
2604fef5208cSdrh       **
2605e014a838Sdanielk1977       ** If the 'x' expression is a column value, or the SELECT...
2606e014a838Sdanielk1977       ** statement returns a column value, then the affinity of that
2607e014a838Sdanielk1977       ** column is used to build the index keys. If both 'x' and the
2608e014a838Sdanielk1977       ** SELECT... statement are columns, then numeric affinity is used
2609e014a838Sdanielk1977       ** if either column has NUMERIC or INTEGER affinity. If neither
2610e014a838Sdanielk1977       ** 'x' nor the SELECT... statement are columns, then numeric affinity
2611e014a838Sdanielk1977       ** is used.
2612fef5208cSdrh       */
2613832508b7Sdrh       pExpr->iTable = pParse->nTab++;
261471c57db0Sdan       addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral,
261571c57db0Sdan           pExpr->iTable, (isRowid?0:nVal));
261671c57db0Sdan       pKeyInfo = isRowid ? 0 : sqlite3KeyInfoAlloc(pParse->db, nVal, 1);
2617e014a838Sdanielk1977 
26186ab3a2ecSdanielk1977       if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2619e014a838Sdanielk1977         /* Case 1:     expr IN (SELECT ...)
2620e014a838Sdanielk1977         **
2621e014a838Sdanielk1977         ** Generate code to write the results of the select into the temporary
2622e014a838Sdanielk1977         ** table allocated and opened above.
2623e014a838Sdanielk1977         */
26244387006cSdrh         Select *pSelect = pExpr->x.pSelect;
262571c57db0Sdan         ExprList *pEList = pSelect->pEList;
26261013c932Sdrh 
262741a05b7bSdanielk1977         assert( !isRowid );
262864bcb8cfSdrh         /* If the LHS and RHS of the IN operator do not match, that
262964bcb8cfSdrh         ** error will have been caught long before we reach this point. */
263064bcb8cfSdrh         if( ALWAYS(pEList->nExpr==nVal) ){
263171c57db0Sdan           SelectDest dest;
263271c57db0Sdan           int i;
26331013c932Sdrh           sqlite3SelectDestInit(&dest, SRT_Set, pExpr->iTable);
263471c57db0Sdan           dest.zAffSdst = exprINAffinity(pParse, pExpr);
26354387006cSdrh           pSelect->iLimit = 0;
26364387006cSdrh           testcase( pSelect->selFlags & SF_Distinct );
2637812ea833Sdrh           testcase( pKeyInfo==0 ); /* Caused by OOM in sqlite3KeyInfoAlloc() */
26384387006cSdrh           if( sqlite3Select(pParse, pSelect, &dest) ){
263971c57db0Sdan             sqlite3DbFree(pParse->db, dest.zAffSdst);
26402ec2fb22Sdrh             sqlite3KeyInfoUnref(pKeyInfo);
26411450bc6eSdrh             return 0;
264294ccde58Sdrh           }
264371c57db0Sdan           sqlite3DbFree(pParse->db, dest.zAffSdst);
2644812ea833Sdrh           assert( pKeyInfo!=0 ); /* OOM will cause exit after sqlite3Select() */
26453535ec3eSdrh           assert( pEList!=0 );
26463535ec3eSdrh           assert( pEList->nExpr>0 );
26472ec2fb22Sdrh           assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
264871c57db0Sdan           for(i=0; i<nVal; i++){
2649773d3afaSdan             Expr *p = sqlite3VectorFieldSubexpr(pLeft, i);
265071c57db0Sdan             pKeyInfo->aColl[i] = sqlite3BinaryCompareCollSeq(
265171c57db0Sdan                 pParse, p, pEList->a[i].pExpr
265271c57db0Sdan             );
265371c57db0Sdan           }
265471c57db0Sdan         }
2655a7d2db17Sdrh       }else if( ALWAYS(pExpr->x.pList!=0) ){
2656fef5208cSdrh         /* Case 2:     expr IN (exprlist)
2657fef5208cSdrh         **
2658e014a838Sdanielk1977         ** For each expression, build an index key from the evaluation and
2659e014a838Sdanielk1977         ** store it in the temporary table. If <expr> is a column, then use
2660e014a838Sdanielk1977         ** that columns affinity when building index keys. If <expr> is not
2661e014a838Sdanielk1977         ** a column, use numeric affinity.
2662fef5208cSdrh         */
266371c57db0Sdan         char affinity;            /* Affinity of the LHS of the IN */
2664e014a838Sdanielk1977         int i;
26656ab3a2ecSdanielk1977         ExprList *pList = pExpr->x.pList;
266657dbd7b3Sdrh         struct ExprList_item *pItem;
2667ecc31805Sdrh         int r1, r2, r3;
266857dbd7b3Sdrh 
266971c57db0Sdan         affinity = sqlite3ExprAffinity(pLeft);
2670e014a838Sdanielk1977         if( !affinity ){
267105883a34Sdrh           affinity = SQLITE_AFF_BLOB;
2672e014a838Sdanielk1977         }
2673323df790Sdrh         if( pKeyInfo ){
26742ec2fb22Sdrh           assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
2675323df790Sdrh           pKeyInfo->aColl[0] = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
2676323df790Sdrh         }
2677e014a838Sdanielk1977 
2678e014a838Sdanielk1977         /* Loop through each expression in <exprlist>. */
26792d401ab8Sdrh         r1 = sqlite3GetTempReg(pParse);
26802d401ab8Sdrh         r2 = sqlite3GetTempReg(pParse);
268137e08081Sdrh         if( isRowid ) sqlite3VdbeAddOp2(v, OP_Null, 0, r2);
268257dbd7b3Sdrh         for(i=pList->nExpr, pItem=pList->a; i>0; i--, pItem++){
268357dbd7b3Sdrh           Expr *pE2 = pItem->pExpr;
2684e05c929bSdrh           int iValToIns;
2685e014a838Sdanielk1977 
268657dbd7b3Sdrh           /* If the expression is not constant then we will need to
268757dbd7b3Sdrh           ** disable the test that was generated above that makes sure
268857dbd7b3Sdrh           ** this code only executes once.  Because for a non-constant
268957dbd7b3Sdrh           ** expression we need to rerun this code each time.
269057dbd7b3Sdrh           */
26916be515ebSdrh           if( jmpIfDynamic>=0 && !sqlite3ExprIsConstant(pE2) ){
26926be515ebSdrh             sqlite3VdbeChangeToNoop(v, jmpIfDynamic);
26936be515ebSdrh             jmpIfDynamic = -1;
26944794b980Sdrh           }
2695e014a838Sdanielk1977 
2696e014a838Sdanielk1977           /* Evaluate the expression and insert it into the temp table */
2697e05c929bSdrh           if( isRowid && sqlite3ExprIsInteger(pE2, &iValToIns) ){
2698e05c929bSdrh             sqlite3VdbeAddOp3(v, OP_InsertInt, pExpr->iTable, r2, iValToIns);
2699e05c929bSdrh           }else{
2700ecc31805Sdrh             r3 = sqlite3ExprCodeTarget(pParse, pE2, r1);
270141a05b7bSdanielk1977             if( isRowid ){
2702e05c929bSdrh               sqlite3VdbeAddOp2(v, OP_MustBeInt, r3,
2703e05c929bSdrh                                 sqlite3VdbeCurrentAddr(v)+2);
2704688852abSdrh               VdbeCoverage(v);
270541a05b7bSdanielk1977               sqlite3VdbeAddOp3(v, OP_Insert, pExpr->iTable, r2, r3);
270641a05b7bSdanielk1977             }else{
2707ecc31805Sdrh               sqlite3VdbeAddOp4(v, OP_MakeRecord, r3, 1, r2, &affinity, 1);
27083c31fc23Sdrh               sqlite3ExprCacheAffinityChange(pParse, r3, 1);
27099b4eaebcSdrh               sqlite3VdbeAddOp4Int(v, OP_IdxInsert, pExpr->iTable, r2, r3, 1);
2710fef5208cSdrh             }
271141a05b7bSdanielk1977           }
2712e05c929bSdrh         }
27132d401ab8Sdrh         sqlite3ReleaseTempReg(pParse, r1);
27142d401ab8Sdrh         sqlite3ReleaseTempReg(pParse, r2);
2715fef5208cSdrh       }
2716323df790Sdrh       if( pKeyInfo ){
27172ec2fb22Sdrh         sqlite3VdbeChangeP4(v, addr, (void *)pKeyInfo, P4_KEYINFO);
271841a05b7bSdanielk1977       }
2719b3bce662Sdanielk1977       break;
2720fef5208cSdrh     }
2721fef5208cSdrh 
272251522cd3Sdrh     case TK_EXISTS:
2723fd773cf9Sdrh     case TK_SELECT:
2724fd773cf9Sdrh     default: {
272539a11819Sdrh       /* Case 3:    (SELECT ... FROM ...)
272639a11819Sdrh       **     or:    EXISTS(SELECT ... FROM ...)
272739a11819Sdrh       **
272839a11819Sdrh       ** For a SELECT, generate code to put the values for all columns of
272939a11819Sdrh       ** the first row into an array of registers and return the index of
273039a11819Sdrh       ** the first register.
273139a11819Sdrh       **
273239a11819Sdrh       ** If this is an EXISTS, write an integer 0 (not exists) or 1 (exists)
273339a11819Sdrh       ** into a register and return that register number.
273439a11819Sdrh       **
273539a11819Sdrh       ** In both cases, the query is augmented with "LIMIT 1".  Any
273639a11819Sdrh       ** preexisting limit is discarded in place of the new LIMIT 1.
2737fef5208cSdrh       */
2738fd773cf9Sdrh       Select *pSel;                         /* SELECT statement to encode */
273939a11819Sdrh       SelectDest dest;                      /* How to deal with SELECT result */
274071c57db0Sdan       int nReg;                             /* Registers to allocate */
27411398ad36Sdrh 
2742cf697396Sshane       testcase( pExpr->op==TK_EXISTS );
2743cf697396Sshane       testcase( pExpr->op==TK_SELECT );
2744cf697396Sshane       assert( pExpr->op==TK_EXISTS || pExpr->op==TK_SELECT );
27456ab3a2ecSdanielk1977       assert( ExprHasProperty(pExpr, EP_xIsSelect) );
274671c57db0Sdan 
27476ab3a2ecSdanielk1977       pSel = pExpr->x.pSelect;
274871c57db0Sdan       nReg = pExpr->op==TK_SELECT ? pSel->pEList->nExpr : 1;
274971c57db0Sdan       sqlite3SelectDestInit(&dest, 0, pParse->nMem+1);
275071c57db0Sdan       pParse->nMem += nReg;
275151522cd3Sdrh       if( pExpr->op==TK_SELECT ){
27526c8c8ce0Sdanielk1977         dest.eDest = SRT_Mem;
275353932ce8Sdrh         dest.iSdst = dest.iSDParm;
275471c57db0Sdan         dest.nSdst = nReg;
275571c57db0Sdan         sqlite3VdbeAddOp3(v, OP_Null, 0, dest.iSDParm, dest.iSDParm+nReg-1);
2756d4e70ebdSdrh         VdbeComment((v, "Init subquery result"));
275751522cd3Sdrh       }else{
27586c8c8ce0Sdanielk1977         dest.eDest = SRT_Exists;
27592b596da8Sdrh         sqlite3VdbeAddOp2(v, OP_Integer, 0, dest.iSDParm);
2760d4e70ebdSdrh         VdbeComment((v, "Init EXISTS result"));
276151522cd3Sdrh       }
2762633e6d57Sdrh       sqlite3ExprDelete(pParse->db, pSel->pLimit);
2763e1c03b62Sdrh       pSel->pLimit = sqlite3ExprAlloc(pParse->db, TK_INTEGER,
2764e1c03b62Sdrh                                   &sqlite3IntTokens[1], 0);
276548b5b041Sdrh       pSel->iLimit = 0;
2766772460fdSdrh       pSel->selFlags &= ~SF_MultiValue;
27677d10d5a6Sdrh       if( sqlite3Select(pParse, pSel, &dest) ){
27681450bc6eSdrh         return 0;
276994ccde58Sdrh       }
27702b596da8Sdrh       rReg = dest.iSDParm;
2771ebb6a65dSdrh       ExprSetVVAProperty(pExpr, EP_NoReduce);
2772b3bce662Sdanielk1977       break;
277319a775c2Sdrh     }
2774cce7d176Sdrh   }
2775b3bce662Sdanielk1977 
27766be515ebSdrh   if( rHasNullFlag ){
27776be515ebSdrh     sqlite3SetHasNullFlag(v, pExpr->iTable, rHasNullFlag);
2778b3bce662Sdanielk1977   }
27796be515ebSdrh 
27806be515ebSdrh   if( jmpIfDynamic>=0 ){
27816be515ebSdrh     sqlite3VdbeJumpHere(v, jmpIfDynamic);
2782b3bce662Sdanielk1977   }
2783d2490904Sdrh   sqlite3ExprCachePop(pParse);
2784fc976065Sdanielk1977 
27851450bc6eSdrh   return rReg;
2786cce7d176Sdrh }
278751522cd3Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
2788cce7d176Sdrh 
2789e3365e6cSdrh #ifndef SQLITE_OMIT_SUBQUERY
2790e3365e6cSdrh /*
27917b35a77bSdan ** Expr pIn is an IN(...) expression. This function checks that the
27927b35a77bSdan ** sub-select on the RHS of the IN() operator has the same number of
27937b35a77bSdan ** columns as the vector on the LHS. Or, if the RHS of the IN() is not
27947b35a77bSdan ** a sub-query, that the LHS is a vector of size 1.
27957b35a77bSdan */
27967b35a77bSdan int sqlite3ExprCheckIN(Parse *pParse, Expr *pIn){
27977b35a77bSdan   int nVector = sqlite3ExprVectorSize(pIn->pLeft);
27987b35a77bSdan   if( (pIn->flags & EP_xIsSelect) ){
27997b35a77bSdan     if( nVector!=pIn->x.pSelect->pEList->nExpr ){
28007b35a77bSdan       sqlite3SubselectError(pParse, pIn->x.pSelect->pEList->nExpr, nVector);
28017b35a77bSdan       return 1;
28027b35a77bSdan     }
28037b35a77bSdan   }else if( nVector!=1 ){
280444c5604cSdan     sqlite3VectorErrorMsg(pParse, pIn->pLeft);
28057b35a77bSdan     return 1;
28067b35a77bSdan   }
28077b35a77bSdan   return 0;
28087b35a77bSdan }
28097b35a77bSdan #endif
28107b35a77bSdan 
28117b35a77bSdan #ifndef SQLITE_OMIT_SUBQUERY
28127b35a77bSdan /*
2813e3365e6cSdrh ** Generate code for an IN expression.
2814e3365e6cSdrh **
2815e3365e6cSdrh **      x IN (SELECT ...)
2816e3365e6cSdrh **      x IN (value, value, ...)
2817e3365e6cSdrh **
2818ecb87ac8Sdrh ** The left-hand side (LHS) is a scalar or vector expression.  The
2819e347d3e8Sdrh ** right-hand side (RHS) is an array of zero or more scalar values, or a
2820e347d3e8Sdrh ** subquery.  If the RHS is a subquery, the number of result columns must
2821e347d3e8Sdrh ** match the number of columns in the vector on the LHS.  If the RHS is
2822e347d3e8Sdrh ** a list of values, the LHS must be a scalar.
2823e347d3e8Sdrh **
2824e347d3e8Sdrh ** The IN operator is true if the LHS value is contained within the RHS.
2825e347d3e8Sdrh ** The result is false if the LHS is definitely not in the RHS.  The
2826e347d3e8Sdrh ** result is NULL if the presence of the LHS in the RHS cannot be
2827e347d3e8Sdrh ** determined due to NULLs.
2828e3365e6cSdrh **
28296be515ebSdrh ** This routine generates code that jumps to destIfFalse if the LHS is not
2830e3365e6cSdrh ** contained within the RHS.  If due to NULLs we cannot determine if the LHS
2831e3365e6cSdrh ** is contained in the RHS then jump to destIfNull.  If the LHS is contained
2832e3365e6cSdrh ** within the RHS then fall through.
2833ecb87ac8Sdrh **
2834ecb87ac8Sdrh ** See the separate in-operator.md documentation file in the canonical
2835ecb87ac8Sdrh ** SQLite source tree for additional information.
2836e3365e6cSdrh */
2837e3365e6cSdrh static void sqlite3ExprCodeIN(
2838e3365e6cSdrh   Parse *pParse,        /* Parsing and code generating context */
2839e3365e6cSdrh   Expr *pExpr,          /* The IN expression */
2840e3365e6cSdrh   int destIfFalse,      /* Jump here if LHS is not contained in the RHS */
2841e3365e6cSdrh   int destIfNull        /* Jump here if the results are unknown due to NULLs */
2842e3365e6cSdrh ){
2843e3365e6cSdrh   int rRhsHasNull = 0;  /* Register that is true if RHS contains NULL values */
2844e3365e6cSdrh   int eType;            /* Type of the RHS */
2845e347d3e8Sdrh   int rLhs;             /* Register(s) holding the LHS values */
2846e347d3e8Sdrh   int rLhsOrig;         /* LHS values prior to reordering by aiMap[] */
2847e3365e6cSdrh   Vdbe *v;              /* Statement under construction */
2848ba00e30aSdan   int *aiMap = 0;       /* Map from vector field to index column */
2849ba00e30aSdan   char *zAff = 0;       /* Affinity string for comparisons */
2850ecb87ac8Sdrh   int nVector;          /* Size of vectors for this IN operator */
285112abf408Sdrh   int iDummy;           /* Dummy parameter to exprCodeVector() */
2852e347d3e8Sdrh   Expr *pLeft;          /* The LHS of the IN operator */
2853ecb87ac8Sdrh   int i;                /* loop counter */
2854e347d3e8Sdrh   int destStep2;        /* Where to jump when NULLs seen in step 2 */
2855e347d3e8Sdrh   int destStep6 = 0;    /* Start of code for Step 6 */
2856e347d3e8Sdrh   int addrTruthOp;      /* Address of opcode that determines the IN is true */
2857e347d3e8Sdrh   int destNotNull;      /* Jump here if a comparison is not true in step 6 */
2858e347d3e8Sdrh   int addrTop;          /* Top of the step-6 loop */
2859e3365e6cSdrh 
2860e347d3e8Sdrh   pLeft = pExpr->pLeft;
28617b35a77bSdan   if( sqlite3ExprCheckIN(pParse, pExpr) ) return;
2862553168c7Sdan   zAff = exprINAffinity(pParse, pExpr);
2863ba00e30aSdan   nVector = sqlite3ExprVectorSize(pExpr->pLeft);
2864ba00e30aSdan   aiMap = (int*)sqlite3DbMallocZero(
2865ba00e30aSdan       pParse->db, nVector*(sizeof(int) + sizeof(char)) + 1
2866ba00e30aSdan   );
2867e347d3e8Sdrh   if( pParse->db->mallocFailed ) goto sqlite3ExprCodeIN_oom_error;
28687b35a77bSdan 
2869ba00e30aSdan   /* Attempt to compute the RHS. After this step, if anything other than
2870ba00e30aSdan   ** IN_INDEX_NOOP is returned, the table opened ith cursor pExpr->iTable
2871ba00e30aSdan   ** contains the values that make up the RHS. If IN_INDEX_NOOP is returned,
2872ba00e30aSdan   ** the RHS has not yet been coded.  */
2873e3365e6cSdrh   v = pParse->pVdbe;
2874e3365e6cSdrh   assert( v!=0 );       /* OOM detected prior to this routine */
2875e3365e6cSdrh   VdbeNoopComment((v, "begin IN expr"));
2876bb53ecb1Sdrh   eType = sqlite3FindInIndex(pParse, pExpr,
2877bb53ecb1Sdrh                              IN_INDEX_MEMBERSHIP | IN_INDEX_NOOP_OK,
2878ba00e30aSdan                              destIfFalse==destIfNull ? 0 : &rRhsHasNull, aiMap);
2879e3365e6cSdrh 
2880ba00e30aSdan   assert( pParse->nErr || nVector==1 || eType==IN_INDEX_EPH
2881ba00e30aSdan        || eType==IN_INDEX_INDEX_ASC || eType==IN_INDEX_INDEX_DESC
2882ba00e30aSdan   );
2883ecb87ac8Sdrh #ifdef SQLITE_DEBUG
2884ecb87ac8Sdrh   /* Confirm that aiMap[] contains nVector integer values between 0 and
2885ecb87ac8Sdrh   ** nVector-1. */
2886ecb87ac8Sdrh   for(i=0; i<nVector; i++){
2887ecb87ac8Sdrh     int j, cnt;
2888ecb87ac8Sdrh     for(cnt=j=0; j<nVector; j++) if( aiMap[j]==i ) cnt++;
2889ecb87ac8Sdrh     assert( cnt==1 );
2890ecb87ac8Sdrh   }
2891ecb87ac8Sdrh #endif
2892e3365e6cSdrh 
2893ba00e30aSdan   /* Code the LHS, the <expr> from "<expr> IN (...)". If the LHS is a
2894ba00e30aSdan   ** vector, then it is stored in an array of nVector registers starting
2895ba00e30aSdan   ** at r1.
2896e347d3e8Sdrh   **
2897e347d3e8Sdrh   ** sqlite3FindInIndex() might have reordered the fields of the LHS vector
2898e347d3e8Sdrh   ** so that the fields are in the same order as an existing index.   The
2899e347d3e8Sdrh   ** aiMap[] array contains a mapping from the original LHS field order to
2900e347d3e8Sdrh   ** the field order that matches the RHS index.
2901e3365e6cSdrh   */
2902e3365e6cSdrh   sqlite3ExprCachePush(pParse);
2903e347d3e8Sdrh   rLhsOrig = exprCodeVector(pParse, pLeft, &iDummy);
2904e347d3e8Sdrh   for(i=0; i<nVector && aiMap[i]==i; i++){} /* Are LHS fields reordered? */
2905ecb87ac8Sdrh   if( i==nVector ){
2906e347d3e8Sdrh     /* LHS fields are not reordered */
2907e347d3e8Sdrh     rLhs = rLhsOrig;
2908ecb87ac8Sdrh   }else{
2909ecb87ac8Sdrh     /* Need to reorder the LHS fields according to aiMap */
2910e347d3e8Sdrh     rLhs = sqlite3GetTempRange(pParse, nVector);
2911ba00e30aSdan     for(i=0; i<nVector; i++){
2912e347d3e8Sdrh       sqlite3VdbeAddOp3(v, OP_Copy, rLhsOrig+i, rLhs+aiMap[i], 0);
2913ba00e30aSdan     }
2914ecb87ac8Sdrh   }
2915e3365e6cSdrh 
2916bb53ecb1Sdrh   /* If sqlite3FindInIndex() did not find or create an index that is
2917bb53ecb1Sdrh   ** suitable for evaluating the IN operator, then evaluate using a
2918bb53ecb1Sdrh   ** sequence of comparisons.
2919e347d3e8Sdrh   **
2920e347d3e8Sdrh   ** This is step (1) in the in-operator.md optimized algorithm.
2921bb53ecb1Sdrh   */
2922bb53ecb1Sdrh   if( eType==IN_INDEX_NOOP ){
2923bb53ecb1Sdrh     ExprList *pList = pExpr->x.pList;
2924bb53ecb1Sdrh     CollSeq *pColl = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
2925bb53ecb1Sdrh     int labelOk = sqlite3VdbeMakeLabel(v);
2926bb53ecb1Sdrh     int r2, regToFree;
2927bb53ecb1Sdrh     int regCkNull = 0;
2928bb53ecb1Sdrh     int ii;
2929bb53ecb1Sdrh     assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
2930bb53ecb1Sdrh     if( destIfNull!=destIfFalse ){
2931bb53ecb1Sdrh       regCkNull = sqlite3GetTempReg(pParse);
2932e347d3e8Sdrh       sqlite3VdbeAddOp3(v, OP_BitAnd, rLhs, rLhs, regCkNull);
2933bb53ecb1Sdrh     }
2934bb53ecb1Sdrh     for(ii=0; ii<pList->nExpr; ii++){
2935bb53ecb1Sdrh       r2 = sqlite3ExprCodeTemp(pParse, pList->a[ii].pExpr, &regToFree);
2936a976979bSdrh       if( regCkNull && sqlite3ExprCanBeNull(pList->a[ii].pExpr) ){
2937bb53ecb1Sdrh         sqlite3VdbeAddOp3(v, OP_BitAnd, regCkNull, r2, regCkNull);
2938bb53ecb1Sdrh       }
2939bb53ecb1Sdrh       if( ii<pList->nExpr-1 || destIfNull!=destIfFalse ){
2940e347d3e8Sdrh         sqlite3VdbeAddOp4(v, OP_Eq, rLhs, labelOk, r2,
29414336b0e6Sdrh                           (void*)pColl, P4_COLLSEQ);
29424336b0e6Sdrh         VdbeCoverageIf(v, ii<pList->nExpr-1);
29434336b0e6Sdrh         VdbeCoverageIf(v, ii==pList->nExpr-1);
2944ba00e30aSdan         sqlite3VdbeChangeP5(v, zAff[0]);
2945bb53ecb1Sdrh       }else{
2946bb53ecb1Sdrh         assert( destIfNull==destIfFalse );
2947e347d3e8Sdrh         sqlite3VdbeAddOp4(v, OP_Ne, rLhs, destIfFalse, r2,
2948bb53ecb1Sdrh                           (void*)pColl, P4_COLLSEQ); VdbeCoverage(v);
2949ba00e30aSdan         sqlite3VdbeChangeP5(v, zAff[0] | SQLITE_JUMPIFNULL);
2950bb53ecb1Sdrh       }
2951bb53ecb1Sdrh       sqlite3ReleaseTempReg(pParse, regToFree);
2952bb53ecb1Sdrh     }
2953bb53ecb1Sdrh     if( regCkNull ){
2954bb53ecb1Sdrh       sqlite3VdbeAddOp2(v, OP_IsNull, regCkNull, destIfNull); VdbeCoverage(v);
2955076e85f5Sdrh       sqlite3VdbeGoto(v, destIfFalse);
2956bb53ecb1Sdrh     }
2957bb53ecb1Sdrh     sqlite3VdbeResolveLabel(v, labelOk);
2958bb53ecb1Sdrh     sqlite3ReleaseTempReg(pParse, regCkNull);
2959e347d3e8Sdrh     goto sqlite3ExprCodeIN_finished;
2960e347d3e8Sdrh   }
2961bb53ecb1Sdrh 
2962e347d3e8Sdrh   /* Step 2: Check to see if the LHS contains any NULL columns.  If the
2963e347d3e8Sdrh   ** LHS does contain NULLs then the result must be either FALSE or NULL.
2964e347d3e8Sdrh   ** We will then skip the binary search of the RHS.
2965e347d3e8Sdrh   */
2966094430ebSdrh   if( destIfNull==destIfFalse ){
2967e347d3e8Sdrh     destStep2 = destIfFalse;
2968e347d3e8Sdrh   }else{
2969e347d3e8Sdrh     destStep2 = destStep6 = sqlite3VdbeMakeLabel(v);
2970e347d3e8Sdrh   }
2971d49fd4e8Sdan   for(i=0; i<nVector; i++){
2972fc7f27b9Sdrh     Expr *p = sqlite3VectorFieldSubexpr(pExpr->pLeft, i);
2973d49fd4e8Sdan     if( sqlite3ExprCanBeNull(p) ){
2974e347d3e8Sdrh       sqlite3VdbeAddOp2(v, OP_IsNull, rLhs+i, destStep2);
2975471b4b92Sdrh       VdbeCoverage(v);
2976d49fd4e8Sdan     }
2977d49fd4e8Sdan   }
2978e3365e6cSdrh 
2979e347d3e8Sdrh   /* Step 3.  The LHS is now known to be non-NULL.  Do the binary search
2980e347d3e8Sdrh   ** of the RHS using the LHS as a probe.  If found, the result is
2981e347d3e8Sdrh   ** true.
2982e347d3e8Sdrh   */
2983e3365e6cSdrh   if( eType==IN_INDEX_ROWID ){
2984e347d3e8Sdrh     /* In this case, the RHS is the ROWID of table b-tree and so we also
2985e347d3e8Sdrh     ** know that the RHS is non-NULL.  Hence, we combine steps 3 and 4
2986e347d3e8Sdrh     ** into a single opcode. */
2987e347d3e8Sdrh     sqlite3VdbeAddOp3(v, OP_SeekRowid, pExpr->iTable, destIfFalse, rLhs);
2988688852abSdrh     VdbeCoverage(v);
2989e347d3e8Sdrh     addrTruthOp = sqlite3VdbeAddOp0(v, OP_Goto);  /* Return True */
29907b35a77bSdan   }else{
2991e347d3e8Sdrh     sqlite3VdbeAddOp4(v, OP_Affinity, rLhs, nVector, 0, zAff, nVector);
2992e347d3e8Sdrh     if( destIfFalse==destIfNull ){
2993e347d3e8Sdrh       /* Combine Step 3 and Step 5 into a single opcode */
2994e347d3e8Sdrh       sqlite3VdbeAddOp4Int(v, OP_NotFound, pExpr->iTable, destIfFalse,
2995e347d3e8Sdrh                            rLhs, nVector); VdbeCoverage(v);
2996e347d3e8Sdrh       goto sqlite3ExprCodeIN_finished;
2997e347d3e8Sdrh     }
2998e347d3e8Sdrh     /* Ordinary Step 3, for the case where FALSE and NULL are distinct */
2999e347d3e8Sdrh     addrTruthOp = sqlite3VdbeAddOp4Int(v, OP_Found, pExpr->iTable, 0,
3000e347d3e8Sdrh                                       rLhs, nVector); VdbeCoverage(v);
3001e347d3e8Sdrh   }
3002ba00e30aSdan 
3003e347d3e8Sdrh   /* Step 4.  If the RHS is known to be non-NULL and we did not find
3004e347d3e8Sdrh   ** an match on the search above, then the result must be FALSE.
3005e347d3e8Sdrh   */
3006e347d3e8Sdrh   if( rRhsHasNull && nVector==1 ){
3007e347d3e8Sdrh     sqlite3VdbeAddOp2(v, OP_NotNull, rRhsHasNull, destIfFalse);
3008471b4b92Sdrh     VdbeCoverage(v);
3009e347d3e8Sdrh   }
30107b35a77bSdan 
3011e347d3e8Sdrh   /* Step 5.  If we do not care about the difference between NULL and
3012e347d3e8Sdrh   ** FALSE, then just return false.
3013e347d3e8Sdrh   */
3014e347d3e8Sdrh   if( destIfFalse==destIfNull ) sqlite3VdbeGoto(v, destIfFalse);
3015e347d3e8Sdrh 
3016e347d3e8Sdrh   /* Step 6: Loop through rows of the RHS.  Compare each row to the LHS.
3017e347d3e8Sdrh   ** If any comparison is NULL, then the result is NULL.  If all
3018e347d3e8Sdrh   ** comparisons are FALSE then the final result is FALSE.
3019e347d3e8Sdrh   **
3020e347d3e8Sdrh   ** For a scalar LHS, it is sufficient to check just the first row
3021e347d3e8Sdrh   ** of the RHS.
3022e347d3e8Sdrh   */
3023e347d3e8Sdrh   if( destStep6 ) sqlite3VdbeResolveLabel(v, destStep6);
3024e347d3e8Sdrh   addrTop = sqlite3VdbeAddOp2(v, OP_Rewind, pExpr->iTable, destIfFalse);
3025471b4b92Sdrh   VdbeCoverage(v);
3026e347d3e8Sdrh   if( nVector>1 ){
3027e347d3e8Sdrh     destNotNull = sqlite3VdbeMakeLabel(v);
3028e347d3e8Sdrh   }else{
3029e347d3e8Sdrh     /* For nVector==1, combine steps 6 and 7 by immediately returning
3030e347d3e8Sdrh     ** FALSE if the first comparison is not NULL */
3031e347d3e8Sdrh     destNotNull = destIfFalse;
3032e347d3e8Sdrh   }
3033ba00e30aSdan   for(i=0; i<nVector; i++){
3034ba00e30aSdan     Expr *p;
3035ba00e30aSdan     CollSeq *pColl;
3036e347d3e8Sdrh     int r3 = sqlite3GetTempReg(pParse);
3037fc7f27b9Sdrh     p = sqlite3VectorFieldSubexpr(pLeft, i);
3038ba00e30aSdan     pColl = sqlite3ExprCollSeq(pParse, p);
3039e347d3e8Sdrh     sqlite3VdbeAddOp3(v, OP_Column, pExpr->iTable, i, r3);
3040e347d3e8Sdrh     sqlite3VdbeAddOp4(v, OP_Ne, rLhs+i, destNotNull, r3,
304118016ad2Sdrh                       (void*)pColl, P4_COLLSEQ);
3042471b4b92Sdrh     VdbeCoverage(v);
3043e347d3e8Sdrh     sqlite3ReleaseTempReg(pParse, r3);
30447b35a77bSdan   }
30457b35a77bSdan   sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfNull);
3046e347d3e8Sdrh   if( nVector>1 ){
3047e347d3e8Sdrh     sqlite3VdbeResolveLabel(v, destNotNull);
3048e347d3e8Sdrh     sqlite3VdbeAddOp2(v, OP_Next, pExpr->iTable, addrTop+1);
304918016ad2Sdrh     VdbeCoverage(v);
3050e347d3e8Sdrh 
3051e347d3e8Sdrh     /* Step 7:  If we reach this point, we know that the result must
3052e347d3e8Sdrh     ** be false. */
305318016ad2Sdrh     sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfFalse);
30547b35a77bSdan   }
30557b35a77bSdan 
3056e347d3e8Sdrh   /* Jumps here in order to return true. */
3057e347d3e8Sdrh   sqlite3VdbeJumpHere(v, addrTruthOp);
3058e3365e6cSdrh 
3059e347d3e8Sdrh sqlite3ExprCodeIN_finished:
3060e347d3e8Sdrh   if( rLhs!=rLhsOrig ) sqlite3ReleaseTempReg(pParse, rLhs);
3061d2490904Sdrh   sqlite3ExprCachePop(pParse);
3062ecb87ac8Sdrh   VdbeComment((v, "end IN expr"));
3063e347d3e8Sdrh sqlite3ExprCodeIN_oom_error:
3064ba00e30aSdan   sqlite3DbFree(pParse->db, aiMap);
3065553168c7Sdan   sqlite3DbFree(pParse->db, zAff);
3066e3365e6cSdrh }
3067e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
3068e3365e6cSdrh 
306913573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
3070598f1340Sdrh /*
3071598f1340Sdrh ** Generate an instruction that will put the floating point
30729cbf3425Sdrh ** value described by z[0..n-1] into register iMem.
30730cf19ed8Sdrh **
30740cf19ed8Sdrh ** The z[] string will probably not be zero-terminated.  But the
30750cf19ed8Sdrh ** z[n] character is guaranteed to be something that does not look
30760cf19ed8Sdrh ** like the continuation of the number.
3077598f1340Sdrh */
3078b7916a78Sdrh static void codeReal(Vdbe *v, const char *z, int negateFlag, int iMem){
3079fd773cf9Sdrh   if( ALWAYS(z!=0) ){
3080598f1340Sdrh     double value;
30819339da1fSdrh     sqlite3AtoF(z, &value, sqlite3Strlen30(z), SQLITE_UTF8);
3082d0015161Sdrh     assert( !sqlite3IsNaN(value) ); /* The new AtoF never returns NaN */
3083598f1340Sdrh     if( negateFlag ) value = -value;
308497bae794Sdrh     sqlite3VdbeAddOp4Dup8(v, OP_Real, 0, iMem, 0, (u8*)&value, P4_REAL);
3085598f1340Sdrh   }
3086598f1340Sdrh }
308713573c71Sdrh #endif
3088598f1340Sdrh 
3089598f1340Sdrh 
3090598f1340Sdrh /*
3091fec19aadSdrh ** Generate an instruction that will put the integer describe by
30929cbf3425Sdrh ** text z[0..n-1] into register iMem.
30930cf19ed8Sdrh **
30945f1d6b61Sshaneh ** Expr.u.zToken is always UTF8 and zero-terminated.
3095fec19aadSdrh */
309613573c71Sdrh static void codeInteger(Parse *pParse, Expr *pExpr, int negFlag, int iMem){
309713573c71Sdrh   Vdbe *v = pParse->pVdbe;
309892b01d53Sdrh   if( pExpr->flags & EP_IntValue ){
309933e619fcSdrh     int i = pExpr->u.iValue;
3100d50ffc41Sdrh     assert( i>=0 );
310192b01d53Sdrh     if( negFlag ) i = -i;
310292b01d53Sdrh     sqlite3VdbeAddOp2(v, OP_Integer, i, iMem);
3103fd773cf9Sdrh   }else{
31045f1d6b61Sshaneh     int c;
31055f1d6b61Sshaneh     i64 value;
3106fd773cf9Sdrh     const char *z = pExpr->u.zToken;
3107fd773cf9Sdrh     assert( z!=0 );
31089296c18aSdrh     c = sqlite3DecOrHexToI64(z, &value);
310984d4f1a3Sdrh     if( (c==3 && !negFlag) || (c==2) || (negFlag && value==SMALLEST_INT64)){
311013573c71Sdrh #ifdef SQLITE_OMIT_FLOATING_POINT
311113573c71Sdrh       sqlite3ErrorMsg(pParse, "oversized integer: %s%s", negFlag ? "-" : "", z);
311213573c71Sdrh #else
31131b7ddc59Sdrh #ifndef SQLITE_OMIT_HEX_INTEGER
31149296c18aSdrh       if( sqlite3_strnicmp(z,"0x",2)==0 ){
311577320ea4Sdrh         sqlite3ErrorMsg(pParse, "hex literal too big: %s%s", negFlag?"-":"",z);
31161b7ddc59Sdrh       }else
31171b7ddc59Sdrh #endif
31181b7ddc59Sdrh       {
3119b7916a78Sdrh         codeReal(v, z, negFlag, iMem);
31209296c18aSdrh       }
312113573c71Sdrh #endif
312277320ea4Sdrh     }else{
312384d4f1a3Sdrh       if( negFlag ){ value = c==3 ? SMALLEST_INT64 : -value; }
312477320ea4Sdrh       sqlite3VdbeAddOp4Dup8(v, OP_Int64, 0, iMem, 0, (u8*)&value, P4_INT64);
3125fec19aadSdrh     }
3126fec19aadSdrh   }
3127c9cf901dSdanielk1977 }
3128fec19aadSdrh 
3129bea119cdSdrh /*
31309b40d13fSdrh ** Erase column-cache entry number i
3131bea119cdSdrh */
31329b40d13fSdrh static void cacheEntryClear(Parse *pParse, int i){
31339b40d13fSdrh   if( pParse->aColCache[i].tempReg ){
3134ceea3321Sdrh     if( pParse->nTempReg<ArraySize(pParse->aTempReg) ){
31359b40d13fSdrh       pParse->aTempReg[pParse->nTempReg++] = pParse->aColCache[i].iReg;
3136ceea3321Sdrh     }
3137ceea3321Sdrh   }
3138bea119cdSdrh   pParse->nColCache--;
31399b40d13fSdrh   if( i<pParse->nColCache ){
31409b40d13fSdrh     pParse->aColCache[i] = pParse->aColCache[pParse->nColCache];
31419b40d13fSdrh   }
3142ceea3321Sdrh }
3143ceea3321Sdrh 
3144ceea3321Sdrh 
3145ceea3321Sdrh /*
3146ceea3321Sdrh ** Record in the column cache that a particular column from a
3147ceea3321Sdrh ** particular table is stored in a particular register.
3148ceea3321Sdrh */
3149ceea3321Sdrh void sqlite3ExprCacheStore(Parse *pParse, int iTab, int iCol, int iReg){
3150ceea3321Sdrh   int i;
3151ceea3321Sdrh   int minLru;
3152ceea3321Sdrh   int idxLru;
3153ceea3321Sdrh   struct yColCache *p;
3154ceea3321Sdrh 
3155ce8f53d4Sdan   /* Unless an error has occurred, register numbers are always positive. */
3156ce8f53d4Sdan   assert( iReg>0 || pParse->nErr || pParse->db->mallocFailed );
315720411ea7Sdrh   assert( iCol>=-1 && iCol<32768 );  /* Finite column numbers */
315820411ea7Sdrh 
3159b6da74ebSdrh   /* The SQLITE_ColumnCache flag disables the column cache.  This is used
3160b6da74ebSdrh   ** for testing only - to verify that SQLite always gets the same answer
3161b6da74ebSdrh   ** with and without the column cache.
3162b6da74ebSdrh   */
31637e5418e4Sdrh   if( OptimizationDisabled(pParse->db, SQLITE_ColumnCache) ) return;
3164b6da74ebSdrh 
316527ee406eSdrh   /* First replace any existing entry.
316627ee406eSdrh   **
316727ee406eSdrh   ** Actually, the way the column cache is currently used, we are guaranteed
316827ee406eSdrh   ** that the object will never already be in cache.  Verify this guarantee.
316927ee406eSdrh   */
317027ee406eSdrh #ifndef NDEBUG
31719b40d13fSdrh   for(i=0, p=pParse->aColCache; i<pParse->nColCache; i++, p++){
31729b40d13fSdrh     assert( p->iTable!=iTab || p->iColumn!=iCol );
3173ceea3321Sdrh   }
317427ee406eSdrh #endif
3175ceea3321Sdrh 
31769b40d13fSdrh   /* If the cache is already full, delete the least recently used entry */
31779b40d13fSdrh   if( pParse->nColCache>=SQLITE_N_COLCACHE ){
3178ceea3321Sdrh     minLru = 0x7fffffff;
3179ceea3321Sdrh     idxLru = -1;
3180ceea3321Sdrh     for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
3181ceea3321Sdrh       if( p->lru<minLru ){
3182ceea3321Sdrh         idxLru = i;
3183ceea3321Sdrh         minLru = p->lru;
3184ceea3321Sdrh       }
3185ceea3321Sdrh     }
3186ceea3321Sdrh     p = &pParse->aColCache[idxLru];
31879b40d13fSdrh   }else{
31889b40d13fSdrh     p = &pParse->aColCache[pParse->nColCache++];
31899b40d13fSdrh   }
31909b40d13fSdrh 
31919b40d13fSdrh   /* Add the new entry to the end of the cache */
3192ceea3321Sdrh   p->iLevel = pParse->iCacheLevel;
3193ceea3321Sdrh   p->iTable = iTab;
3194ceea3321Sdrh   p->iColumn = iCol;
3195ceea3321Sdrh   p->iReg = iReg;
3196ceea3321Sdrh   p->tempReg = 0;
3197ceea3321Sdrh   p->lru = pParse->iCacheCnt++;
3198ceea3321Sdrh }
3199ceea3321Sdrh 
3200ceea3321Sdrh /*
3201f49f3523Sdrh ** Indicate that registers between iReg..iReg+nReg-1 are being overwritten.
3202f49f3523Sdrh ** Purge the range of registers from the column cache.
3203ceea3321Sdrh */
3204f49f3523Sdrh void sqlite3ExprCacheRemove(Parse *pParse, int iReg, int nReg){
32059b40d13fSdrh   int i = 0;
32069b40d13fSdrh   while( i<pParse->nColCache ){
32079b40d13fSdrh     struct yColCache *p = &pParse->aColCache[i];
32089b40d13fSdrh     if( p->iReg >= iReg && p->iReg < iReg+nReg ){
32099b40d13fSdrh       cacheEntryClear(pParse, i);
32109b40d13fSdrh     }else{
32119b40d13fSdrh       i++;
32129b40d13fSdrh     }
3213ceea3321Sdrh   }
3214ceea3321Sdrh }
3215ceea3321Sdrh 
3216ceea3321Sdrh /*
3217ceea3321Sdrh ** Remember the current column cache context.  Any new entries added
3218ceea3321Sdrh ** added to the column cache after this call are removed when the
3219ceea3321Sdrh ** corresponding pop occurs.
3220ceea3321Sdrh */
3221ceea3321Sdrh void sqlite3ExprCachePush(Parse *pParse){
3222ceea3321Sdrh   pParse->iCacheLevel++;
32239ac7962aSdrh #ifdef SQLITE_DEBUG
32249ac7962aSdrh   if( pParse->db->flags & SQLITE_VdbeAddopTrace ){
32259ac7962aSdrh     printf("PUSH to %d\n", pParse->iCacheLevel);
32269ac7962aSdrh   }
32279ac7962aSdrh #endif
3228ceea3321Sdrh }
3229ceea3321Sdrh 
3230ceea3321Sdrh /*
3231ceea3321Sdrh ** Remove from the column cache any entries that were added since the
3232d2490904Sdrh ** the previous sqlite3ExprCachePush operation.  In other words, restore
3233d2490904Sdrh ** the cache to the state it was in prior the most recent Push.
3234ceea3321Sdrh */
3235d2490904Sdrh void sqlite3ExprCachePop(Parse *pParse){
32369b40d13fSdrh   int i = 0;
3237d2490904Sdrh   assert( pParse->iCacheLevel>=1 );
3238d2490904Sdrh   pParse->iCacheLevel--;
32399ac7962aSdrh #ifdef SQLITE_DEBUG
32409ac7962aSdrh   if( pParse->db->flags & SQLITE_VdbeAddopTrace ){
32419ac7962aSdrh     printf("POP  to %d\n", pParse->iCacheLevel);
32429ac7962aSdrh   }
32439ac7962aSdrh #endif
32449b40d13fSdrh   while( i<pParse->nColCache ){
32459b40d13fSdrh     if( pParse->aColCache[i].iLevel>pParse->iCacheLevel ){
32469b40d13fSdrh       cacheEntryClear(pParse, i);
32479b40d13fSdrh     }else{
32489b40d13fSdrh       i++;
3249ceea3321Sdrh     }
3250ceea3321Sdrh   }
3251ceea3321Sdrh }
3252945498f3Sdrh 
3253945498f3Sdrh /*
32545cd79239Sdrh ** When a cached column is reused, make sure that its register is
32555cd79239Sdrh ** no longer available as a temp register.  ticket #3879:  that same
32565cd79239Sdrh ** register might be in the cache in multiple places, so be sure to
32575cd79239Sdrh ** get them all.
32585cd79239Sdrh */
32595cd79239Sdrh static void sqlite3ExprCachePinRegister(Parse *pParse, int iReg){
32605cd79239Sdrh   int i;
32615cd79239Sdrh   struct yColCache *p;
32629b40d13fSdrh   for(i=0, p=pParse->aColCache; i<pParse->nColCache; i++, p++){
32635cd79239Sdrh     if( p->iReg==iReg ){
32645cd79239Sdrh       p->tempReg = 0;
32655cd79239Sdrh     }
32665cd79239Sdrh   }
32675cd79239Sdrh }
32685cd79239Sdrh 
32691f9ca2c8Sdrh /* Generate code that will load into register regOut a value that is
32701f9ca2c8Sdrh ** appropriate for the iIdxCol-th column of index pIdx.
32711f9ca2c8Sdrh */
32721f9ca2c8Sdrh void sqlite3ExprCodeLoadIndexColumn(
32731f9ca2c8Sdrh   Parse *pParse,  /* The parsing context */
32741f9ca2c8Sdrh   Index *pIdx,    /* The index whose column is to be loaded */
32751f9ca2c8Sdrh   int iTabCur,    /* Cursor pointing to a table row */
32761f9ca2c8Sdrh   int iIdxCol,    /* The column of the index to be loaded */
32771f9ca2c8Sdrh   int regOut      /* Store the index column value in this register */
32781f9ca2c8Sdrh ){
32791f9ca2c8Sdrh   i16 iTabCol = pIdx->aiColumn[iIdxCol];
32804b92f98cSdrh   if( iTabCol==XN_EXPR ){
32811f9ca2c8Sdrh     assert( pIdx->aColExpr );
32821f9ca2c8Sdrh     assert( pIdx->aColExpr->nExpr>iIdxCol );
32833e34eabcSdrh     pParse->iSelfTab = iTabCur + 1;
32841c75c9d7Sdrh     sqlite3ExprCodeCopy(pParse, pIdx->aColExpr->a[iIdxCol].pExpr, regOut);
32853e34eabcSdrh     pParse->iSelfTab = 0;
32864b92f98cSdrh   }else{
32874b92f98cSdrh     sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pIdx->pTable, iTabCur,
32884b92f98cSdrh                                     iTabCol, regOut);
32894b92f98cSdrh   }
32901f9ca2c8Sdrh }
32911f9ca2c8Sdrh 
32925cd79239Sdrh /*
32935c092e8aSdrh ** Generate code to extract the value of the iCol-th column of a table.
32945c092e8aSdrh */
32955c092e8aSdrh void sqlite3ExprCodeGetColumnOfTable(
32965c092e8aSdrh   Vdbe *v,        /* The VDBE under construction */
32975c092e8aSdrh   Table *pTab,    /* The table containing the value */
3298313619f5Sdrh   int iTabCur,    /* The table cursor.  Or the PK cursor for WITHOUT ROWID */
32995c092e8aSdrh   int iCol,       /* Index of the column to extract */
3300313619f5Sdrh   int regOut      /* Extract the value into this register */
33015c092e8aSdrh ){
3302aca19e19Sdrh   if( pTab==0 ){
3303aca19e19Sdrh     sqlite3VdbeAddOp3(v, OP_Column, iTabCur, iCol, regOut);
3304aca19e19Sdrh     return;
3305aca19e19Sdrh   }
33065c092e8aSdrh   if( iCol<0 || iCol==pTab->iPKey ){
33075c092e8aSdrh     sqlite3VdbeAddOp2(v, OP_Rowid, iTabCur, regOut);
33085c092e8aSdrh   }else{
33095c092e8aSdrh     int op = IsVirtual(pTab) ? OP_VColumn : OP_Column;
3310ee0ec8e1Sdrh     int x = iCol;
331135db31b2Sdrh     if( !HasRowid(pTab) && !IsVirtual(pTab) ){
3312ee0ec8e1Sdrh       x = sqlite3ColumnOfIndex(sqlite3PrimaryKeyIndex(pTab), iCol);
3313ee0ec8e1Sdrh     }
3314ee0ec8e1Sdrh     sqlite3VdbeAddOp3(v, op, iTabCur, x, regOut);
33155c092e8aSdrh   }
33165c092e8aSdrh   if( iCol>=0 ){
33175c092e8aSdrh     sqlite3ColumnDefault(v, pTab, iCol, regOut);
33185c092e8aSdrh   }
33195c092e8aSdrh }
33205c092e8aSdrh 
33215c092e8aSdrh /*
3322945498f3Sdrh ** Generate code that will extract the iColumn-th column from
3323ce78bc6eSdrh ** table pTab and store the column value in a register.
3324ce78bc6eSdrh **
3325ce78bc6eSdrh ** An effort is made to store the column value in register iReg.  This
3326ce78bc6eSdrh ** is not garanteeed for GetColumn() - the result can be stored in
3327ce78bc6eSdrh ** any register.  But the result is guaranteed to land in register iReg
3328ce78bc6eSdrh ** for GetColumnToReg().
3329e55cbd72Sdrh **
3330e55cbd72Sdrh ** There must be an open cursor to pTab in iTable when this routine
3331e55cbd72Sdrh ** is called.  If iColumn<0 then code is generated that extracts the rowid.
3332945498f3Sdrh */
3333e55cbd72Sdrh int sqlite3ExprCodeGetColumn(
3334e55cbd72Sdrh   Parse *pParse,   /* Parsing and code generating context */
33352133d822Sdrh   Table *pTab,     /* Description of the table we are reading from */
33362133d822Sdrh   int iColumn,     /* Index of the table column */
33372133d822Sdrh   int iTable,      /* The cursor pointing to the table */
3338a748fdccSdrh   int iReg,        /* Store results here */
3339ce78bc6eSdrh   u8 p5            /* P5 value for OP_Column + FLAGS */
33402133d822Sdrh ){
3341e55cbd72Sdrh   Vdbe *v = pParse->pVdbe;
3342e55cbd72Sdrh   int i;
3343da250ea5Sdrh   struct yColCache *p;
3344e55cbd72Sdrh 
33459b40d13fSdrh   for(i=0, p=pParse->aColCache; i<pParse->nColCache; i++, p++){
334694881d73Sdrh     if( p->iTable==iTable && p->iColumn==iColumn ){
3347ceea3321Sdrh       p->lru = pParse->iCacheCnt++;
33485cd79239Sdrh       sqlite3ExprCachePinRegister(pParse, p->iReg);
3349da250ea5Sdrh       return p->iReg;
3350e55cbd72Sdrh     }
3351e55cbd72Sdrh   }
3352e55cbd72Sdrh   assert( v!=0 );
33535c092e8aSdrh   sqlite3ExprCodeGetColumnOfTable(v, pTab, iTable, iColumn, iReg);
3354a748fdccSdrh   if( p5 ){
3355a748fdccSdrh     sqlite3VdbeChangeP5(v, p5);
3356a748fdccSdrh   }else{
3357ceea3321Sdrh     sqlite3ExprCacheStore(pParse, iTable, iColumn, iReg);
3358a748fdccSdrh   }
3359e55cbd72Sdrh   return iReg;
3360e55cbd72Sdrh }
3361ce78bc6eSdrh void sqlite3ExprCodeGetColumnToReg(
3362ce78bc6eSdrh   Parse *pParse,   /* Parsing and code generating context */
3363ce78bc6eSdrh   Table *pTab,     /* Description of the table we are reading from */
3364ce78bc6eSdrh   int iColumn,     /* Index of the table column */
3365ce78bc6eSdrh   int iTable,      /* The cursor pointing to the table */
3366ce78bc6eSdrh   int iReg         /* Store results here */
3367ce78bc6eSdrh ){
3368ce78bc6eSdrh   int r1 = sqlite3ExprCodeGetColumn(pParse, pTab, iColumn, iTable, iReg, 0);
3369ce78bc6eSdrh   if( r1!=iReg ) sqlite3VdbeAddOp2(pParse->pVdbe, OP_SCopy, r1, iReg);
3370ce78bc6eSdrh }
3371ce78bc6eSdrh 
3372e55cbd72Sdrh 
3373e55cbd72Sdrh /*
3374ceea3321Sdrh ** Clear all column cache entries.
3375e55cbd72Sdrh */
3376ceea3321Sdrh void sqlite3ExprCacheClear(Parse *pParse){
3377e55cbd72Sdrh   int i;
3378ceea3321Sdrh 
3379d879e3ebSdrh #ifdef SQLITE_DEBUG
33809ac7962aSdrh   if( pParse->db->flags & SQLITE_VdbeAddopTrace ){
33819ac7962aSdrh     printf("CLEAR\n");
33829ac7962aSdrh   }
33839ac7962aSdrh #endif
33849b40d13fSdrh   for(i=0; i<pParse->nColCache; i++){
33859b40d13fSdrh     if( pParse->aColCache[i].tempReg
33869b40d13fSdrh      && pParse->nTempReg<ArraySize(pParse->aTempReg)
33879b40d13fSdrh     ){
33889b40d13fSdrh        pParse->aTempReg[pParse->nTempReg++] = pParse->aColCache[i].iReg;
3389e55cbd72Sdrh     }
3390da250ea5Sdrh   }
33919b40d13fSdrh   pParse->nColCache = 0;
3392da250ea5Sdrh }
3393e55cbd72Sdrh 
3394e55cbd72Sdrh /*
3395da250ea5Sdrh ** Record the fact that an affinity change has occurred on iCount
3396da250ea5Sdrh ** registers starting with iStart.
3397e55cbd72Sdrh */
3398da250ea5Sdrh void sqlite3ExprCacheAffinityChange(Parse *pParse, int iStart, int iCount){
3399f49f3523Sdrh   sqlite3ExprCacheRemove(pParse, iStart, iCount);
3400e55cbd72Sdrh }
3401e55cbd72Sdrh 
3402e55cbd72Sdrh /*
3403b21e7c70Sdrh ** Generate code to move content from registers iFrom...iFrom+nReg-1
3404b21e7c70Sdrh ** over to iTo..iTo+nReg-1. Keep the column cache up-to-date.
3405e55cbd72Sdrh */
3406b21e7c70Sdrh void sqlite3ExprCodeMove(Parse *pParse, int iFrom, int iTo, int nReg){
3407e8e4af76Sdrh   assert( iFrom>=iTo+nReg || iFrom+nReg<=iTo );
3408079a3072Sdrh   sqlite3VdbeAddOp3(pParse->pVdbe, OP_Move, iFrom, iTo, nReg);
3409236241aeSdrh   sqlite3ExprCacheRemove(pParse, iFrom, nReg);
3410945498f3Sdrh }
3411945498f3Sdrh 
3412f49f3523Sdrh #if defined(SQLITE_DEBUG) || defined(SQLITE_COVERAGE_TEST)
341392b01d53Sdrh /*
3414652fbf55Sdrh ** Return true if any register in the range iFrom..iTo (inclusive)
3415652fbf55Sdrh ** is used as part of the column cache.
3416f49f3523Sdrh **
3417f49f3523Sdrh ** This routine is used within assert() and testcase() macros only
3418f49f3523Sdrh ** and does not appear in a normal build.
3419652fbf55Sdrh */
3420652fbf55Sdrh static int usedAsColumnCache(Parse *pParse, int iFrom, int iTo){
3421652fbf55Sdrh   int i;
3422ceea3321Sdrh   struct yColCache *p;
34239b40d13fSdrh   for(i=0, p=pParse->aColCache; i<pParse->nColCache; i++, p++){
3424ceea3321Sdrh     int r = p->iReg;
3425f49f3523Sdrh     if( r>=iFrom && r<=iTo ) return 1;    /*NO_TEST*/
3426652fbf55Sdrh   }
3427652fbf55Sdrh   return 0;
3428652fbf55Sdrh }
3429f49f3523Sdrh #endif /* SQLITE_DEBUG || SQLITE_COVERAGE_TEST */
3430652fbf55Sdrh 
3431bea119cdSdrh 
3432652fbf55Sdrh /*
343312abf408Sdrh ** Convert a scalar expression node to a TK_REGISTER referencing
343412abf408Sdrh ** register iReg.  The caller must ensure that iReg already contains
343512abf408Sdrh ** the correct value for the expression.
3436a4c3c87eSdrh */
3437a4c3c87eSdrh static void exprToRegister(Expr *p, int iReg){
3438a4c3c87eSdrh   p->op2 = p->op;
3439a4c3c87eSdrh   p->op = TK_REGISTER;
3440a4c3c87eSdrh   p->iTable = iReg;
3441a4c3c87eSdrh   ExprClearProperty(p, EP_Skip);
3442a4c3c87eSdrh }
3443a4c3c87eSdrh 
344412abf408Sdrh /*
344512abf408Sdrh ** Evaluate an expression (either a vector or a scalar expression) and store
344612abf408Sdrh ** the result in continguous temporary registers.  Return the index of
344712abf408Sdrh ** the first register used to store the result.
344812abf408Sdrh **
344912abf408Sdrh ** If the returned result register is a temporary scalar, then also write
345012abf408Sdrh ** that register number into *piFreeable.  If the returned result register
345112abf408Sdrh ** is not a temporary or if the expression is a vector set *piFreeable
345212abf408Sdrh ** to 0.
345312abf408Sdrh */
345412abf408Sdrh static int exprCodeVector(Parse *pParse, Expr *p, int *piFreeable){
345512abf408Sdrh   int iResult;
345612abf408Sdrh   int nResult = sqlite3ExprVectorSize(p);
345712abf408Sdrh   if( nResult==1 ){
345812abf408Sdrh     iResult = sqlite3ExprCodeTemp(pParse, p, piFreeable);
345912abf408Sdrh   }else{
346012abf408Sdrh     *piFreeable = 0;
346112abf408Sdrh     if( p->op==TK_SELECT ){
3462dd1bb43aSdrh #if SQLITE_OMIT_SUBQUERY
3463dd1bb43aSdrh       iResult = 0;
3464dd1bb43aSdrh #else
346512abf408Sdrh       iResult = sqlite3CodeSubselect(pParse, p, 0, 0);
3466dd1bb43aSdrh #endif
346712abf408Sdrh     }else{
346812abf408Sdrh       int i;
346912abf408Sdrh       iResult = pParse->nMem+1;
347012abf408Sdrh       pParse->nMem += nResult;
347112abf408Sdrh       for(i=0; i<nResult; i++){
34724b725240Sdan         sqlite3ExprCodeFactorable(pParse, p->x.pList->a[i].pExpr, i+iResult);
347312abf408Sdrh       }
347412abf408Sdrh     }
347512abf408Sdrh   }
347612abf408Sdrh   return iResult;
347712abf408Sdrh }
347812abf408Sdrh 
347971c57db0Sdan 
3480a4c3c87eSdrh /*
3481cce7d176Sdrh ** Generate code into the current Vdbe to evaluate the given
34822dcef11bSdrh ** expression.  Attempt to store the results in register "target".
34832dcef11bSdrh ** Return the register where results are stored.
3484389a1adbSdrh **
34858b213899Sdrh ** With this routine, there is no guarantee that results will
34862dcef11bSdrh ** be stored in target.  The result might be stored in some other
34872dcef11bSdrh ** register if it is convenient to do so.  The calling function
34882dcef11bSdrh ** must check the return code and move the results to the desired
34892dcef11bSdrh ** register.
3490cce7d176Sdrh */
3491678ccce8Sdrh int sqlite3ExprCodeTarget(Parse *pParse, Expr *pExpr, int target){
34922dcef11bSdrh   Vdbe *v = pParse->pVdbe;  /* The VM under construction */
34932dcef11bSdrh   int op;                   /* The opcode being coded */
34942dcef11bSdrh   int inReg = target;       /* Results stored in register inReg */
34952dcef11bSdrh   int regFree1 = 0;         /* If non-zero free this temporary register */
34962dcef11bSdrh   int regFree2 = 0;         /* If non-zero free this temporary register */
34977b35a77bSdan   int r1, r2;               /* Various register numbers */
349810d1edf0Sdrh   Expr tempX;               /* Temporary expression node */
349971c57db0Sdan   int p5 = 0;
3500ffe07b2dSdrh 
35019cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
350220411ea7Sdrh   if( v==0 ){
350320411ea7Sdrh     assert( pParse->db->mallocFailed );
350420411ea7Sdrh     return 0;
350520411ea7Sdrh   }
3506389a1adbSdrh 
3507389a1adbSdrh   if( pExpr==0 ){
3508389a1adbSdrh     op = TK_NULL;
3509389a1adbSdrh   }else{
3510f2bc013cSdrh     op = pExpr->op;
3511389a1adbSdrh   }
3512f2bc013cSdrh   switch( op ){
351313449892Sdrh     case TK_AGG_COLUMN: {
351413449892Sdrh       AggInfo *pAggInfo = pExpr->pAggInfo;
351513449892Sdrh       struct AggInfo_col *pCol = &pAggInfo->aCol[pExpr->iAgg];
351613449892Sdrh       if( !pAggInfo->directMode ){
35179de221dfSdrh         assert( pCol->iMem>0 );
3518c332cc30Sdrh         return pCol->iMem;
351913449892Sdrh       }else if( pAggInfo->useSortingIdx ){
35205134d135Sdan         sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdxPTab,
3521389a1adbSdrh                               pCol->iSorterColumn, target);
3522c332cc30Sdrh         return target;
352313449892Sdrh       }
352413449892Sdrh       /* Otherwise, fall thru into the TK_COLUMN case */
352513449892Sdrh     }
3526967e8b73Sdrh     case TK_COLUMN: {
3527b2b9d3d7Sdrh       int iTab = pExpr->iTable;
3528b2b9d3d7Sdrh       if( iTab<0 ){
35296e97f8ecSdrh         if( pParse->iSelfTab<0 ){
3530b2b9d3d7Sdrh           /* Generating CHECK constraints or inserting into partial index */
35316e97f8ecSdrh           return pExpr->iColumn - pParse->iSelfTab;
3532c4a3c779Sdrh         }else{
35331f9ca2c8Sdrh           /* Coding an expression that is part of an index where column names
35341f9ca2c8Sdrh           ** in the index refer to the table to which the index belongs */
35353e34eabcSdrh           iTab = pParse->iSelfTab - 1;
35362282792aSdrh         }
3537b2b9d3d7Sdrh       }
3538c332cc30Sdrh       return sqlite3ExprCodeGetColumn(pParse, pExpr->pTab,
3539b2b9d3d7Sdrh                                pExpr->iColumn, iTab, target,
3540b2b9d3d7Sdrh                                pExpr->op2);
3541cce7d176Sdrh     }
3542cce7d176Sdrh     case TK_INTEGER: {
354313573c71Sdrh       codeInteger(pParse, pExpr, 0, target);
3544c332cc30Sdrh       return target;
354551e9a445Sdrh     }
354613573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
3547598f1340Sdrh     case TK_FLOAT: {
354833e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
354933e619fcSdrh       codeReal(v, pExpr->u.zToken, 0, target);
3550c332cc30Sdrh       return target;
3551598f1340Sdrh     }
355213573c71Sdrh #endif
3553fec19aadSdrh     case TK_STRING: {
355433e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
3555076e85f5Sdrh       sqlite3VdbeLoadString(v, target, pExpr->u.zToken);
3556c332cc30Sdrh       return target;
3557cce7d176Sdrh     }
3558f0863fe5Sdrh     case TK_NULL: {
35599de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3560c332cc30Sdrh       return target;
3561f0863fe5Sdrh     }
35625338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_BLOB_LITERAL
3563c572ef7fSdanielk1977     case TK_BLOB: {
35646c8c6cecSdrh       int n;
35656c8c6cecSdrh       const char *z;
3566ca48c90fSdrh       char *zBlob;
356733e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
356833e619fcSdrh       assert( pExpr->u.zToken[0]=='x' || pExpr->u.zToken[0]=='X' );
356933e619fcSdrh       assert( pExpr->u.zToken[1]=='\'' );
357033e619fcSdrh       z = &pExpr->u.zToken[2];
3571b7916a78Sdrh       n = sqlite3Strlen30(z) - 1;
3572b7916a78Sdrh       assert( z[n]=='\'' );
3573ca48c90fSdrh       zBlob = sqlite3HexToBlob(sqlite3VdbeDb(v), z, n);
3574ca48c90fSdrh       sqlite3VdbeAddOp4(v, OP_Blob, n/2, target, 0, zBlob, P4_DYNAMIC);
3575c332cc30Sdrh       return target;
3576c572ef7fSdanielk1977     }
35775338a5f7Sdanielk1977 #endif
357850457896Sdrh     case TK_VARIABLE: {
357933e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
358033e619fcSdrh       assert( pExpr->u.zToken!=0 );
358133e619fcSdrh       assert( pExpr->u.zToken[0]!=0 );
3582eaf52d88Sdrh       sqlite3VdbeAddOp2(v, OP_Variable, pExpr->iColumn, target);
358333e619fcSdrh       if( pExpr->u.zToken[1]!=0 ){
35849bf755ccSdrh         const char *z = sqlite3VListNumToName(pParse->pVList, pExpr->iColumn);
35859bf755ccSdrh         assert( pExpr->u.zToken[0]=='?' || strcmp(pExpr->u.zToken, z)==0 );
3586ce1bbe51Sdrh         pParse->pVList[0] = 0; /* Indicate VList may no longer be enlarged */
35879bf755ccSdrh         sqlite3VdbeAppendP4(v, (char*)z, P4_STATIC);
35889bf755ccSdrh       }
3589c332cc30Sdrh       return target;
359050457896Sdrh     }
35914e0cff60Sdrh     case TK_REGISTER: {
3592c332cc30Sdrh       return pExpr->iTable;
35934e0cff60Sdrh     }
3594487e262fSdrh #ifndef SQLITE_OMIT_CAST
3595487e262fSdrh     case TK_CAST: {
3596487e262fSdrh       /* Expressions of the form:   CAST(pLeft AS token) */
35972dcef11bSdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
35981735fa88Sdrh       if( inReg!=target ){
35991735fa88Sdrh         sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
36001735fa88Sdrh         inReg = target;
36011735fa88Sdrh       }
36024169e430Sdrh       sqlite3VdbeAddOp2(v, OP_Cast, target,
36034169e430Sdrh                         sqlite3AffinityType(pExpr->u.zToken, 0));
3604c5499befSdrh       testcase( usedAsColumnCache(pParse, inReg, inReg) );
3605b3843a82Sdrh       sqlite3ExprCacheAffinityChange(pParse, inReg, 1);
3606c332cc30Sdrh       return inReg;
3607487e262fSdrh     }
3608487e262fSdrh #endif /* SQLITE_OMIT_CAST */
360971c57db0Sdan     case TK_IS:
361071c57db0Sdan     case TK_ISNOT:
361171c57db0Sdan       op = (op==TK_IS) ? TK_EQ : TK_NE;
361271c57db0Sdan       p5 = SQLITE_NULLEQ;
361371c57db0Sdan       /* fall-through */
3614c9b84a1fSdrh     case TK_LT:
3615c9b84a1fSdrh     case TK_LE:
3616c9b84a1fSdrh     case TK_GT:
3617c9b84a1fSdrh     case TK_GE:
3618c9b84a1fSdrh     case TK_NE:
3619c9b84a1fSdrh     case TK_EQ: {
362071c57db0Sdan       Expr *pLeft = pExpr->pLeft;
3621625015e0Sdan       if( sqlite3ExprIsVector(pLeft) ){
362279752b6eSdrh         codeVectorCompare(pParse, pExpr, target, op, p5);
362371c57db0Sdan       }else{
362471c57db0Sdan         r1 = sqlite3ExprCodeTemp(pParse, pLeft, &regFree1);
3625b6da74ebSdrh         r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
362671c57db0Sdan         codeCompare(pParse, pLeft, pExpr->pRight, op,
362771c57db0Sdan             r1, r2, inReg, SQLITE_STOREP2 | p5);
36287d176105Sdrh         assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
36297d176105Sdrh         assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
36307d176105Sdrh         assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
36317d176105Sdrh         assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
36327d176105Sdrh         assert(TK_EQ==OP_Eq); testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
36337d176105Sdrh         assert(TK_NE==OP_Ne); testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
3634c5499befSdrh         testcase( regFree1==0 );
3635c5499befSdrh         testcase( regFree2==0 );
3636c9b84a1fSdrh       }
36376a2fe093Sdrh       break;
36386a2fe093Sdrh     }
3639cce7d176Sdrh     case TK_AND:
3640cce7d176Sdrh     case TK_OR:
3641cce7d176Sdrh     case TK_PLUS:
3642cce7d176Sdrh     case TK_STAR:
3643cce7d176Sdrh     case TK_MINUS:
3644bf4133cbSdrh     case TK_REM:
3645bf4133cbSdrh     case TK_BITAND:
3646bf4133cbSdrh     case TK_BITOR:
364717c40294Sdrh     case TK_SLASH:
3648bf4133cbSdrh     case TK_LSHIFT:
3649855eb1cfSdrh     case TK_RSHIFT:
36500040077dSdrh     case TK_CONCAT: {
36517d176105Sdrh       assert( TK_AND==OP_And );            testcase( op==TK_AND );
36527d176105Sdrh       assert( TK_OR==OP_Or );              testcase( op==TK_OR );
36537d176105Sdrh       assert( TK_PLUS==OP_Add );           testcase( op==TK_PLUS );
36547d176105Sdrh       assert( TK_MINUS==OP_Subtract );     testcase( op==TK_MINUS );
36557d176105Sdrh       assert( TK_REM==OP_Remainder );      testcase( op==TK_REM );
36567d176105Sdrh       assert( TK_BITAND==OP_BitAnd );      testcase( op==TK_BITAND );
36577d176105Sdrh       assert( TK_BITOR==OP_BitOr );        testcase( op==TK_BITOR );
36587d176105Sdrh       assert( TK_SLASH==OP_Divide );       testcase( op==TK_SLASH );
36597d176105Sdrh       assert( TK_LSHIFT==OP_ShiftLeft );   testcase( op==TK_LSHIFT );
36607d176105Sdrh       assert( TK_RSHIFT==OP_ShiftRight );  testcase( op==TK_RSHIFT );
36617d176105Sdrh       assert( TK_CONCAT==OP_Concat );      testcase( op==TK_CONCAT );
36622dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
36632dcef11bSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
36645b6afba9Sdrh       sqlite3VdbeAddOp3(v, op, r2, r1, target);
3665c5499befSdrh       testcase( regFree1==0 );
3666c5499befSdrh       testcase( regFree2==0 );
36670040077dSdrh       break;
36680040077dSdrh     }
3669cce7d176Sdrh     case TK_UMINUS: {
3670fec19aadSdrh       Expr *pLeft = pExpr->pLeft;
3671fec19aadSdrh       assert( pLeft );
367213573c71Sdrh       if( pLeft->op==TK_INTEGER ){
367313573c71Sdrh         codeInteger(pParse, pLeft, 1, target);
3674c332cc30Sdrh         return target;
367513573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
367613573c71Sdrh       }else if( pLeft->op==TK_FLOAT ){
367733e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
367833e619fcSdrh         codeReal(v, pLeft->u.zToken, 1, target);
3679c332cc30Sdrh         return target;
368013573c71Sdrh #endif
36813c84ddffSdrh       }else{
368210d1edf0Sdrh         tempX.op = TK_INTEGER;
368310d1edf0Sdrh         tempX.flags = EP_IntValue|EP_TokenOnly;
368410d1edf0Sdrh         tempX.u.iValue = 0;
368510d1edf0Sdrh         r1 = sqlite3ExprCodeTemp(pParse, &tempX, &regFree1);
3686e55cbd72Sdrh         r2 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree2);
36872dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_Subtract, r2, r1, target);
3688c5499befSdrh         testcase( regFree2==0 );
36893c84ddffSdrh       }
36906e142f54Sdrh       break;
36916e142f54Sdrh     }
3692bf4133cbSdrh     case TK_BITNOT:
36936e142f54Sdrh     case TK_NOT: {
36947d176105Sdrh       assert( TK_BITNOT==OP_BitNot );   testcase( op==TK_BITNOT );
36957d176105Sdrh       assert( TK_NOT==OP_Not );         testcase( op==TK_NOT );
3696e99fa2afSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3697e99fa2afSdrh       testcase( regFree1==0 );
3698e99fa2afSdrh       sqlite3VdbeAddOp2(v, op, r1, inReg);
3699cce7d176Sdrh       break;
3700cce7d176Sdrh     }
3701cce7d176Sdrh     case TK_ISNULL:
3702cce7d176Sdrh     case TK_NOTNULL: {
37036a288a33Sdrh       int addr;
37047d176105Sdrh       assert( TK_ISNULL==OP_IsNull );   testcase( op==TK_ISNULL );
37057d176105Sdrh       assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
37069de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
37072dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3708c5499befSdrh       testcase( regFree1==0 );
37092dcef11bSdrh       addr = sqlite3VdbeAddOp1(v, op, r1);
37107d176105Sdrh       VdbeCoverageIf(v, op==TK_ISNULL);
37117d176105Sdrh       VdbeCoverageIf(v, op==TK_NOTNULL);
3712a976979bSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 0, target);
37136a288a33Sdrh       sqlite3VdbeJumpHere(v, addr);
3714a37cdde0Sdanielk1977       break;
3715f2bc013cSdrh     }
37162282792aSdrh     case TK_AGG_FUNCTION: {
371713449892Sdrh       AggInfo *pInfo = pExpr->pAggInfo;
37187e56e711Sdrh       if( pInfo==0 ){
371933e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
372033e619fcSdrh         sqlite3ErrorMsg(pParse, "misuse of aggregate: %s()", pExpr->u.zToken);
37217e56e711Sdrh       }else{
3722c332cc30Sdrh         return pInfo->aFunc[pExpr->iAgg].iMem;
37237e56e711Sdrh       }
37242282792aSdrh       break;
37252282792aSdrh     }
3726cce7d176Sdrh     case TK_FUNCTION: {
372712ffee8cSdrh       ExprList *pFarg;       /* List of function arguments */
372812ffee8cSdrh       int nFarg;             /* Number of function arguments */
372912ffee8cSdrh       FuncDef *pDef;         /* The function definition object */
373012ffee8cSdrh       const char *zId;       /* The function name */
3731693e6719Sdrh       u32 constMask = 0;     /* Mask of function arguments that are constant */
373212ffee8cSdrh       int i;                 /* Loop counter */
3733c332cc30Sdrh       sqlite3 *db = pParse->db;  /* The database connection */
373412ffee8cSdrh       u8 enc = ENC(db);      /* The text encoding used by this database */
373512ffee8cSdrh       CollSeq *pColl = 0;    /* A collating sequence */
373617435752Sdrh 
37371e9b53f9Sdrh       if( ConstFactorOk(pParse) && sqlite3ExprIsConstantNotJoin(pExpr) ){
373849c5ab24Sdrh         /* SQL functions can be expensive. So try to move constant functions
3739ad879ffdSdrh         ** out of the inner loop, even if that means an extra OP_Copy. */
3740ad879ffdSdrh         return sqlite3ExprCodeAtInit(pParse, pExpr, -1);
37411e9b53f9Sdrh       }
37426ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
3743c5cd1249Sdrh       if( ExprHasProperty(pExpr, EP_TokenOnly) ){
374412ffee8cSdrh         pFarg = 0;
374512ffee8cSdrh       }else{
374612ffee8cSdrh         pFarg = pExpr->x.pList;
374712ffee8cSdrh       }
374812ffee8cSdrh       nFarg = pFarg ? pFarg->nExpr : 0;
374933e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
375033e619fcSdrh       zId = pExpr->u.zToken;
375180738d9cSdrh       pDef = sqlite3FindFunction(db, zId, nFarg, enc, 0);
3752cc15313cSdrh #ifdef SQLITE_ENABLE_UNKNOWN_SQL_FUNCTION
3753cc15313cSdrh       if( pDef==0 && pParse->explain ){
3754cc15313cSdrh         pDef = sqlite3FindFunction(db, "unknown", nFarg, enc, 0);
3755cc15313cSdrh       }
3756cc15313cSdrh #endif
37572d80151fSdrh       if( pDef==0 || pDef->xFinalize!=0 ){
375880738d9cSdrh         sqlite3ErrorMsg(pParse, "unknown function: %s()", zId);
3759feb306f5Sdrh         break;
3760feb306f5Sdrh       }
3761ae6bb957Sdrh 
3762ae6bb957Sdrh       /* Attempt a direct implementation of the built-in COALESCE() and
376360ec914cSpeter.d.reid       ** IFNULL() functions.  This avoids unnecessary evaluation of
3764ae6bb957Sdrh       ** arguments past the first non-NULL argument.
3765ae6bb957Sdrh       */
3766d36e1041Sdrh       if( pDef->funcFlags & SQLITE_FUNC_COALESCE ){
3767ae6bb957Sdrh         int endCoalesce = sqlite3VdbeMakeLabel(v);
3768ae6bb957Sdrh         assert( nFarg>=2 );
3769ae6bb957Sdrh         sqlite3ExprCode(pParse, pFarg->a[0].pExpr, target);
3770ae6bb957Sdrh         for(i=1; i<nFarg; i++){
3771ae6bb957Sdrh           sqlite3VdbeAddOp2(v, OP_NotNull, target, endCoalesce);
3772688852abSdrh           VdbeCoverage(v);
3773f49f3523Sdrh           sqlite3ExprCacheRemove(pParse, target, 1);
3774ae6bb957Sdrh           sqlite3ExprCachePush(pParse);
3775ae6bb957Sdrh           sqlite3ExprCode(pParse, pFarg->a[i].pExpr, target);
3776d2490904Sdrh           sqlite3ExprCachePop(pParse);
3777ae6bb957Sdrh         }
3778ae6bb957Sdrh         sqlite3VdbeResolveLabel(v, endCoalesce);
3779ae6bb957Sdrh         break;
3780ae6bb957Sdrh       }
3781ae6bb957Sdrh 
3782cca9f3d2Sdrh       /* The UNLIKELY() function is a no-op.  The result is the value
3783cca9f3d2Sdrh       ** of the first argument.
3784cca9f3d2Sdrh       */
3785cca9f3d2Sdrh       if( pDef->funcFlags & SQLITE_FUNC_UNLIKELY ){
3786cca9f3d2Sdrh         assert( nFarg>=1 );
3787c332cc30Sdrh         return sqlite3ExprCodeTarget(pParse, pFarg->a[0].pExpr, target);
3788cca9f3d2Sdrh       }
3789ae6bb957Sdrh 
379054240751Sdrh #ifdef SQLITE_DEBUG
3791a1a523a5Sdrh       /* The AFFINITY() function evaluates to a string that describes
3792a1a523a5Sdrh       ** the type affinity of the argument.  This is used for testing of
3793a1a523a5Sdrh       ** the SQLite type logic.
3794a1a523a5Sdrh       */
3795a1a523a5Sdrh       if( pDef->funcFlags & SQLITE_FUNC_AFFINITY ){
3796a1a523a5Sdrh         const char *azAff[] = { "blob", "text", "numeric", "integer", "real" };
3797a1a523a5Sdrh         char aff;
3798a1a523a5Sdrh         assert( nFarg==1 );
3799a1a523a5Sdrh         aff = sqlite3ExprAffinity(pFarg->a[0].pExpr);
3800a1a523a5Sdrh         sqlite3VdbeLoadString(v, target,
3801a1a523a5Sdrh                               aff ? azAff[aff-SQLITE_AFF_BLOB] : "none");
3802a1a523a5Sdrh         return target;
3803a1a523a5Sdrh       }
380454240751Sdrh #endif
3805a1a523a5Sdrh 
3806d1a01edaSdrh       for(i=0; i<nFarg; i++){
3807d1a01edaSdrh         if( i<32 && sqlite3ExprIsConstant(pFarg->a[i].pExpr) ){
3808693e6719Sdrh           testcase( i==31 );
3809693e6719Sdrh           constMask |= MASKBIT32(i);
3810d1a01edaSdrh         }
3811d1a01edaSdrh         if( (pDef->funcFlags & SQLITE_FUNC_NEEDCOLL)!=0 && !pColl ){
3812d1a01edaSdrh           pColl = sqlite3ExprCollSeq(pParse, pFarg->a[i].pExpr);
3813d1a01edaSdrh         }
3814d1a01edaSdrh       }
381512ffee8cSdrh       if( pFarg ){
3816d1a01edaSdrh         if( constMask ){
3817d1a01edaSdrh           r1 = pParse->nMem+1;
3818d1a01edaSdrh           pParse->nMem += nFarg;
3819d1a01edaSdrh         }else{
382012ffee8cSdrh           r1 = sqlite3GetTempRange(pParse, nFarg);
3821d1a01edaSdrh         }
3822a748fdccSdrh 
3823a748fdccSdrh         /* For length() and typeof() functions with a column argument,
3824a748fdccSdrh         ** set the P5 parameter to the OP_Column opcode to OPFLAG_LENGTHARG
3825a748fdccSdrh         ** or OPFLAG_TYPEOFARG respectively, to avoid unnecessary data
3826a748fdccSdrh         ** loading.
3827a748fdccSdrh         */
3828d36e1041Sdrh         if( (pDef->funcFlags & (SQLITE_FUNC_LENGTH|SQLITE_FUNC_TYPEOF))!=0 ){
38294e245a4cSdrh           u8 exprOp;
3830a748fdccSdrh           assert( nFarg==1 );
3831a748fdccSdrh           assert( pFarg->a[0].pExpr!=0 );
38324e245a4cSdrh           exprOp = pFarg->a[0].pExpr->op;
38334e245a4cSdrh           if( exprOp==TK_COLUMN || exprOp==TK_AGG_COLUMN ){
3834a748fdccSdrh             assert( SQLITE_FUNC_LENGTH==OPFLAG_LENGTHARG );
3835a748fdccSdrh             assert( SQLITE_FUNC_TYPEOF==OPFLAG_TYPEOFARG );
3836b1fba286Sdrh             testcase( pDef->funcFlags & OPFLAG_LENGTHARG );
3837b1fba286Sdrh             pFarg->a[0].pExpr->op2 =
3838b1fba286Sdrh                   pDef->funcFlags & (OPFLAG_LENGTHARG|OPFLAG_TYPEOFARG);
3839a748fdccSdrh           }
3840a748fdccSdrh         }
3841a748fdccSdrh 
3842d7d385ddSdrh         sqlite3ExprCachePush(pParse);     /* Ticket 2ea2425d34be */
38435579d59fSdrh         sqlite3ExprCodeExprList(pParse, pFarg, r1, 0,
3844d1a01edaSdrh                                 SQLITE_ECEL_DUP|SQLITE_ECEL_FACTOR);
3845d2490904Sdrh         sqlite3ExprCachePop(pParse);      /* Ticket 2ea2425d34be */
3846892d3179Sdrh       }else{
384712ffee8cSdrh         r1 = 0;
3848892d3179Sdrh       }
3849b7f6f68fSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
3850a43fa227Sdrh       /* Possibly overload the function if the first argument is
3851a43fa227Sdrh       ** a virtual table column.
3852a43fa227Sdrh       **
3853a43fa227Sdrh       ** For infix functions (LIKE, GLOB, REGEXP, and MATCH) use the
3854a43fa227Sdrh       ** second argument, not the first, as the argument to test to
3855a43fa227Sdrh       ** see if it is a column in a virtual table.  This is done because
3856a43fa227Sdrh       ** the left operand of infix functions (the operand we want to
3857a43fa227Sdrh       ** control overloading) ends up as the second argument to the
3858a43fa227Sdrh       ** function.  The expression "A glob B" is equivalent to
3859a43fa227Sdrh       ** "glob(B,A).  We want to use the A in "A glob B" to test
3860a43fa227Sdrh       ** for function overloading.  But we use the B term in "glob(B,A)".
3861a43fa227Sdrh       */
386212ffee8cSdrh       if( nFarg>=2 && (pExpr->flags & EP_InfixFunc) ){
386312ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[1].pExpr);
386412ffee8cSdrh       }else if( nFarg>0 ){
386512ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[0].pExpr);
3866b7f6f68fSdrh       }
3867b7f6f68fSdrh #endif
3868d36e1041Sdrh       if( pDef->funcFlags & SQLITE_FUNC_NEEDCOLL ){
38698b213899Sdrh         if( !pColl ) pColl = db->pDfltColl;
387066a5167bSdrh         sqlite3VdbeAddOp4(v, OP_CollSeq, 0, 0, 0, (char *)pColl, P4_COLLSEQ);
3871682f68b0Sdanielk1977       }
38723e34eabcSdrh       sqlite3VdbeAddOp4(v, pParse->iSelfTab ? OP_PureFunc0 : OP_Function0,
38733e34eabcSdrh                         constMask, r1, target, (char*)pDef, P4_FUNCDEF);
387412ffee8cSdrh       sqlite3VdbeChangeP5(v, (u8)nFarg);
3875d1a01edaSdrh       if( nFarg && constMask==0 ){
387612ffee8cSdrh         sqlite3ReleaseTempRange(pParse, r1, nFarg);
38772dcef11bSdrh       }
3878c332cc30Sdrh       return target;
38796ec2733bSdrh     }
3880fe2093d7Sdrh #ifndef SQLITE_OMIT_SUBQUERY
3881fe2093d7Sdrh     case TK_EXISTS:
388219a775c2Sdrh     case TK_SELECT: {
38838da209b1Sdan       int nCol;
3884c5499befSdrh       testcase( op==TK_EXISTS );
3885c5499befSdrh       testcase( op==TK_SELECT );
38868da209b1Sdan       if( op==TK_SELECT && (nCol = pExpr->x.pSelect->pEList->nExpr)!=1 ){
38878da209b1Sdan         sqlite3SubselectError(pParse, nCol, 1);
38888da209b1Sdan       }else{
3889c332cc30Sdrh         return sqlite3CodeSubselect(pParse, pExpr, 0, 0);
38908da209b1Sdan       }
389119a775c2Sdrh       break;
389219a775c2Sdrh     }
3893fc7f27b9Sdrh     case TK_SELECT_COLUMN: {
3894966e2911Sdrh       int n;
3895fc7f27b9Sdrh       if( pExpr->pLeft->iTable==0 ){
3896fc7f27b9Sdrh         pExpr->pLeft->iTable = sqlite3CodeSubselect(pParse, pExpr->pLeft, 0, 0);
3897fc7f27b9Sdrh       }
3898966e2911Sdrh       assert( pExpr->iTable==0 || pExpr->pLeft->op==TK_SELECT );
3899966e2911Sdrh       if( pExpr->iTable
3900966e2911Sdrh        && pExpr->iTable!=(n = sqlite3ExprVectorSize(pExpr->pLeft))
3901966e2911Sdrh       ){
3902966e2911Sdrh         sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
3903966e2911Sdrh                                 pExpr->iTable, n);
3904966e2911Sdrh       }
3905c332cc30Sdrh       return pExpr->pLeft->iTable + pExpr->iColumn;
3906fc7f27b9Sdrh     }
3907fef5208cSdrh     case TK_IN: {
3908e3365e6cSdrh       int destIfFalse = sqlite3VdbeMakeLabel(v);
3909e3365e6cSdrh       int destIfNull = sqlite3VdbeMakeLabel(v);
3910e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3911e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
391266ba23ceSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
3913e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
3914e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_AddImm, target, 0);
3915e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfNull);
3916c332cc30Sdrh       return target;
3917fef5208cSdrh     }
3918e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
3919e3365e6cSdrh 
3920e3365e6cSdrh 
39212dcef11bSdrh     /*
39222dcef11bSdrh     **    x BETWEEN y AND z
39232dcef11bSdrh     **
39242dcef11bSdrh     ** This is equivalent to
39252dcef11bSdrh     **
39262dcef11bSdrh     **    x>=y AND x<=z
39272dcef11bSdrh     **
39282dcef11bSdrh     ** X is stored in pExpr->pLeft.
39292dcef11bSdrh     ** Y is stored in pExpr->pList->a[0].pExpr.
39302dcef11bSdrh     ** Z is stored in pExpr->pList->a[1].pExpr.
39312dcef11bSdrh     */
3932fef5208cSdrh     case TK_BETWEEN: {
393371c57db0Sdan       exprCodeBetween(pParse, pExpr, target, 0, 0);
3934c332cc30Sdrh       return target;
3935fef5208cSdrh     }
393694fa9c41Sdrh     case TK_SPAN:
3937ae80ddeaSdrh     case TK_COLLATE:
39384f07e5fbSdrh     case TK_UPLUS: {
3939c332cc30Sdrh       return sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
3940a2e00042Sdrh     }
39412dcef11bSdrh 
3942165921a7Sdan     case TK_TRIGGER: {
394365a7cd16Sdan       /* If the opcode is TK_TRIGGER, then the expression is a reference
394465a7cd16Sdan       ** to a column in the new.* or old.* pseudo-tables available to
394565a7cd16Sdan       ** trigger programs. In this case Expr.iTable is set to 1 for the
394665a7cd16Sdan       ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
394765a7cd16Sdan       ** is set to the column of the pseudo-table to read, or to -1 to
394865a7cd16Sdan       ** read the rowid field.
394965a7cd16Sdan       **
395065a7cd16Sdan       ** The expression is implemented using an OP_Param opcode. The p1
395165a7cd16Sdan       ** parameter is set to 0 for an old.rowid reference, or to (i+1)
395265a7cd16Sdan       ** to reference another column of the old.* pseudo-table, where
395365a7cd16Sdan       ** i is the index of the column. For a new.rowid reference, p1 is
395465a7cd16Sdan       ** set to (n+1), where n is the number of columns in each pseudo-table.
395565a7cd16Sdan       ** For a reference to any other column in the new.* pseudo-table, p1
395665a7cd16Sdan       ** is set to (n+2+i), where n and i are as defined previously. For
395765a7cd16Sdan       ** example, if the table on which triggers are being fired is
395865a7cd16Sdan       ** declared as:
395965a7cd16Sdan       **
396065a7cd16Sdan       **   CREATE TABLE t1(a, b);
396165a7cd16Sdan       **
396265a7cd16Sdan       ** Then p1 is interpreted as follows:
396365a7cd16Sdan       **
396465a7cd16Sdan       **   p1==0   ->    old.rowid     p1==3   ->    new.rowid
396565a7cd16Sdan       **   p1==1   ->    old.a         p1==4   ->    new.a
396665a7cd16Sdan       **   p1==2   ->    old.b         p1==5   ->    new.b
396765a7cd16Sdan       */
39682832ad42Sdan       Table *pTab = pExpr->pTab;
396965a7cd16Sdan       int p1 = pExpr->iTable * (pTab->nCol+1) + 1 + pExpr->iColumn;
397065a7cd16Sdan 
397165a7cd16Sdan       assert( pExpr->iTable==0 || pExpr->iTable==1 );
397265a7cd16Sdan       assert( pExpr->iColumn>=-1 && pExpr->iColumn<pTab->nCol );
397365a7cd16Sdan       assert( pTab->iPKey<0 || pExpr->iColumn!=pTab->iPKey );
397465a7cd16Sdan       assert( p1>=0 && p1<(pTab->nCol*2+2) );
397565a7cd16Sdan 
397665a7cd16Sdan       sqlite3VdbeAddOp2(v, OP_Param, p1, target);
397776d462eeSdan       VdbeComment((v, "%s.%s -> $%d",
3978165921a7Sdan         (pExpr->iTable ? "new" : "old"),
397976d462eeSdan         (pExpr->iColumn<0 ? "rowid" : pExpr->pTab->aCol[pExpr->iColumn].zName),
398076d462eeSdan         target
3981165921a7Sdan       ));
398265a7cd16Sdan 
398344dbca83Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
398465a7cd16Sdan       /* If the column has REAL affinity, it may currently be stored as an
3985113762a2Sdrh       ** integer. Use OP_RealAffinity to make sure it is really real.
3986113762a2Sdrh       **
3987113762a2Sdrh       ** EVIDENCE-OF: R-60985-57662 SQLite will convert the value back to
3988113762a2Sdrh       ** floating point when extracting it from the record.  */
39892832ad42Sdan       if( pExpr->iColumn>=0
39902832ad42Sdan        && pTab->aCol[pExpr->iColumn].affinity==SQLITE_AFF_REAL
39912832ad42Sdan       ){
39922832ad42Sdan         sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
39932832ad42Sdan       }
399444dbca83Sdrh #endif
3995165921a7Sdan       break;
3996165921a7Sdan     }
3997165921a7Sdan 
399871c57db0Sdan     case TK_VECTOR: {
3999e835bc12Sdrh       sqlite3ErrorMsg(pParse, "row value misused");
400071c57db0Sdan       break;
400171c57db0Sdan     }
400271c57db0Sdan 
400331d6fd55Sdrh     case TK_IF_NULL_ROW: {
400431d6fd55Sdrh       int addrINR;
400531d6fd55Sdrh       addrINR = sqlite3VdbeAddOp1(v, OP_IfNullRow, pExpr->iTable);
400631d6fd55Sdrh       sqlite3ExprCachePush(pParse);
400731d6fd55Sdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
400831d6fd55Sdrh       sqlite3ExprCachePop(pParse);
400931d6fd55Sdrh       sqlite3VdbeJumpHere(v, addrINR);
401031d6fd55Sdrh       sqlite3VdbeChangeP3(v, addrINR, inReg);
401131d6fd55Sdrh       break;
401231d6fd55Sdrh     }
401331d6fd55Sdrh 
40142dcef11bSdrh     /*
40152dcef11bSdrh     ** Form A:
40162dcef11bSdrh     **   CASE x WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
40172dcef11bSdrh     **
40182dcef11bSdrh     ** Form B:
40192dcef11bSdrh     **   CASE WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
40202dcef11bSdrh     **
40212dcef11bSdrh     ** Form A is can be transformed into the equivalent form B as follows:
40222dcef11bSdrh     **   CASE WHEN x=e1 THEN r1 WHEN x=e2 THEN r2 ...
40232dcef11bSdrh     **        WHEN x=eN THEN rN ELSE y END
40242dcef11bSdrh     **
40252dcef11bSdrh     ** X (if it exists) is in pExpr->pLeft.
4026c5cd1249Sdrh     ** Y is in the last element of pExpr->x.pList if pExpr->x.pList->nExpr is
4027c5cd1249Sdrh     ** odd.  The Y is also optional.  If the number of elements in x.pList
4028c5cd1249Sdrh     ** is even, then Y is omitted and the "otherwise" result is NULL.
40292dcef11bSdrh     ** Ei is in pExpr->pList->a[i*2] and Ri is pExpr->pList->a[i*2+1].
40302dcef11bSdrh     **
40312dcef11bSdrh     ** The result of the expression is the Ri for the first matching Ei,
40322dcef11bSdrh     ** or if there is no matching Ei, the ELSE term Y, or if there is
40332dcef11bSdrh     ** no ELSE term, NULL.
40342dcef11bSdrh     */
403533cd4909Sdrh     default: assert( op==TK_CASE ); {
40362dcef11bSdrh       int endLabel;                     /* GOTO label for end of CASE stmt */
40372dcef11bSdrh       int nextCase;                     /* GOTO label for next WHEN clause */
40382dcef11bSdrh       int nExpr;                        /* 2x number of WHEN terms */
40392dcef11bSdrh       int i;                            /* Loop counter */
40402dcef11bSdrh       ExprList *pEList;                 /* List of WHEN terms */
40412dcef11bSdrh       struct ExprList_item *aListelem;  /* Array of WHEN terms */
40422dcef11bSdrh       Expr opCompare;                   /* The X==Ei expression */
40432dcef11bSdrh       Expr *pX;                         /* The X expression */
40441bd10f8aSdrh       Expr *pTest = 0;                  /* X==Ei (form A) or just Ei (form B) */
4045ceea3321Sdrh       VVA_ONLY( int iCacheLevel = pParse->iCacheLevel; )
404617a7f8ddSdrh 
40476ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) && pExpr->x.pList );
40486ab3a2ecSdanielk1977       assert(pExpr->x.pList->nExpr > 0);
40496ab3a2ecSdanielk1977       pEList = pExpr->x.pList;
4050be5c89acSdrh       aListelem = pEList->a;
4051be5c89acSdrh       nExpr = pEList->nExpr;
40522dcef11bSdrh       endLabel = sqlite3VdbeMakeLabel(v);
40532dcef11bSdrh       if( (pX = pExpr->pLeft)!=0 ){
405410d1edf0Sdrh         tempX = *pX;
405533cd4909Sdrh         testcase( pX->op==TK_COLUMN );
405612abf408Sdrh         exprToRegister(&tempX, exprCodeVector(pParse, &tempX, &regFree1));
4057c5499befSdrh         testcase( regFree1==0 );
4058abb9d5f1Sdrh         memset(&opCompare, 0, sizeof(opCompare));
40592dcef11bSdrh         opCompare.op = TK_EQ;
406010d1edf0Sdrh         opCompare.pLeft = &tempX;
40612dcef11bSdrh         pTest = &opCompare;
40628b1db07fSdrh         /* Ticket b351d95f9cd5ef17e9d9dbae18f5ca8611190001:
40638b1db07fSdrh         ** The value in regFree1 might get SCopy-ed into the file result.
40648b1db07fSdrh         ** So make sure that the regFree1 register is not reused for other
40658b1db07fSdrh         ** purposes and possibly overwritten.  */
40668b1db07fSdrh         regFree1 = 0;
4067cce7d176Sdrh       }
4068c5cd1249Sdrh       for(i=0; i<nExpr-1; i=i+2){
4069ceea3321Sdrh         sqlite3ExprCachePush(pParse);
40702dcef11bSdrh         if( pX ){
40711bd10f8aSdrh           assert( pTest!=0 );
40722dcef11bSdrh           opCompare.pRight = aListelem[i].pExpr;
4073f5905aa7Sdrh         }else{
40742dcef11bSdrh           pTest = aListelem[i].pExpr;
407517a7f8ddSdrh         }
40762dcef11bSdrh         nextCase = sqlite3VdbeMakeLabel(v);
407733cd4909Sdrh         testcase( pTest->op==TK_COLUMN );
40782dcef11bSdrh         sqlite3ExprIfFalse(pParse, pTest, nextCase, SQLITE_JUMPIFNULL);
4079c5499befSdrh         testcase( aListelem[i+1].pExpr->op==TK_COLUMN );
40809de221dfSdrh         sqlite3ExprCode(pParse, aListelem[i+1].pExpr, target);
4081076e85f5Sdrh         sqlite3VdbeGoto(v, endLabel);
4082d2490904Sdrh         sqlite3ExprCachePop(pParse);
40832dcef11bSdrh         sqlite3VdbeResolveLabel(v, nextCase);
4084f570f011Sdrh       }
4085c5cd1249Sdrh       if( (nExpr&1)!=0 ){
4086ceea3321Sdrh         sqlite3ExprCachePush(pParse);
4087c5cd1249Sdrh         sqlite3ExprCode(pParse, pEList->a[nExpr-1].pExpr, target);
4088d2490904Sdrh         sqlite3ExprCachePop(pParse);
408917a7f8ddSdrh       }else{
40909de221dfSdrh         sqlite3VdbeAddOp2(v, OP_Null, 0, target);
409117a7f8ddSdrh       }
4092c332cc30Sdrh       assert( pParse->db->mallocFailed || pParse->nErr>0
4093c1f4a19bSdanielk1977            || pParse->iCacheLevel==iCacheLevel );
40942dcef11bSdrh       sqlite3VdbeResolveLabel(v, endLabel);
40956f34903eSdanielk1977       break;
40966f34903eSdanielk1977     }
40975338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_TRIGGER
40986f34903eSdanielk1977     case TK_RAISE: {
4099165921a7Sdan       assert( pExpr->affinity==OE_Rollback
4100165921a7Sdan            || pExpr->affinity==OE_Abort
4101165921a7Sdan            || pExpr->affinity==OE_Fail
4102165921a7Sdan            || pExpr->affinity==OE_Ignore
4103165921a7Sdan       );
4104e0af83acSdan       if( !pParse->pTriggerTab ){
4105e0af83acSdan         sqlite3ErrorMsg(pParse,
4106e0af83acSdan                        "RAISE() may only be used within a trigger-program");
4107e0af83acSdan         return 0;
4108e0af83acSdan       }
4109e0af83acSdan       if( pExpr->affinity==OE_Abort ){
4110e0af83acSdan         sqlite3MayAbort(pParse);
4111e0af83acSdan       }
411233e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
4113e0af83acSdan       if( pExpr->affinity==OE_Ignore ){
4114e0af83acSdan         sqlite3VdbeAddOp4(
4115e0af83acSdan             v, OP_Halt, SQLITE_OK, OE_Ignore, 0, pExpr->u.zToken,0);
4116688852abSdrh         VdbeCoverage(v);
4117e0af83acSdan       }else{
4118433dccfbSdrh         sqlite3HaltConstraint(pParse, SQLITE_CONSTRAINT_TRIGGER,
4119f9c8ce3cSdrh                               pExpr->affinity, pExpr->u.zToken, 0, 0);
4120e0af83acSdan       }
4121e0af83acSdan 
4122ffe07b2dSdrh       break;
412317a7f8ddSdrh     }
41245338a5f7Sdanielk1977 #endif
4125ffe07b2dSdrh   }
41262dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
41272dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
41282dcef11bSdrh   return inReg;
41295b6afba9Sdrh }
41302dcef11bSdrh 
41312dcef11bSdrh /*
4132d1a01edaSdrh ** Factor out the code of the given expression to initialization time.
41331e9b53f9Sdrh **
4134ad879ffdSdrh ** If regDest>=0 then the result is always stored in that register and the
4135ad879ffdSdrh ** result is not reusable.  If regDest<0 then this routine is free to
4136ad879ffdSdrh ** store the value whereever it wants.  The register where the expression
4137ad879ffdSdrh ** is stored is returned.  When regDest<0, two identical expressions will
4138ad879ffdSdrh ** code to the same register.
4139d1a01edaSdrh */
41401e9b53f9Sdrh int sqlite3ExprCodeAtInit(
4141d673cddaSdrh   Parse *pParse,    /* Parsing context */
4142d673cddaSdrh   Expr *pExpr,      /* The expression to code when the VDBE initializes */
4143ad879ffdSdrh   int regDest       /* Store the value in this register */
4144d673cddaSdrh ){
4145d1a01edaSdrh   ExprList *p;
4146d9f158e7Sdrh   assert( ConstFactorOk(pParse) );
4147d1a01edaSdrh   p = pParse->pConstExpr;
4148ad879ffdSdrh   if( regDest<0 && p ){
41491e9b53f9Sdrh     struct ExprList_item *pItem;
41501e9b53f9Sdrh     int i;
41511e9b53f9Sdrh     for(pItem=p->a, i=p->nExpr; i>0; pItem++, i--){
41525aa550cfSdan       if( pItem->reusable && sqlite3ExprCompare(0,pItem->pExpr,pExpr,-1)==0 ){
41531e9b53f9Sdrh         return pItem->u.iConstExprReg;
41541e9b53f9Sdrh       }
41551e9b53f9Sdrh     }
41561e9b53f9Sdrh   }
4157d1a01edaSdrh   pExpr = sqlite3ExprDup(pParse->db, pExpr, 0);
4158d1a01edaSdrh   p = sqlite3ExprListAppend(pParse, p, pExpr);
4159d673cddaSdrh   if( p ){
4160d673cddaSdrh      struct ExprList_item *pItem = &p->a[p->nExpr-1];
4161ad879ffdSdrh      pItem->reusable = regDest<0;
4162ad879ffdSdrh      if( regDest<0 ) regDest = ++pParse->nMem;
4163d673cddaSdrh      pItem->u.iConstExprReg = regDest;
4164d673cddaSdrh   }
4165d1a01edaSdrh   pParse->pConstExpr = p;
41661e9b53f9Sdrh   return regDest;
4167d1a01edaSdrh }
4168d1a01edaSdrh 
4169d1a01edaSdrh /*
41702dcef11bSdrh ** Generate code to evaluate an expression and store the results
41712dcef11bSdrh ** into a register.  Return the register number where the results
41722dcef11bSdrh ** are stored.
41732dcef11bSdrh **
41742dcef11bSdrh ** If the register is a temporary register that can be deallocated,
4175678ccce8Sdrh ** then write its number into *pReg.  If the result register is not
41762dcef11bSdrh ** a temporary, then set *pReg to zero.
4177f30a969bSdrh **
4178f30a969bSdrh ** If pExpr is a constant, then this routine might generate this
4179f30a969bSdrh ** code to fill the register in the initialization section of the
4180f30a969bSdrh ** VDBE program, in order to factor it out of the evaluation loop.
41812dcef11bSdrh */
41822dcef11bSdrh int sqlite3ExprCodeTemp(Parse *pParse, Expr *pExpr, int *pReg){
4183f30a969bSdrh   int r2;
4184f30a969bSdrh   pExpr = sqlite3ExprSkipCollate(pExpr);
4185d9f158e7Sdrh   if( ConstFactorOk(pParse)
4186f30a969bSdrh    && pExpr->op!=TK_REGISTER
4187f30a969bSdrh    && sqlite3ExprIsConstantNotJoin(pExpr)
4188f30a969bSdrh   ){
4189f30a969bSdrh     *pReg  = 0;
4190ad879ffdSdrh     r2 = sqlite3ExprCodeAtInit(pParse, pExpr, -1);
4191f30a969bSdrh   }else{
41922dcef11bSdrh     int r1 = sqlite3GetTempReg(pParse);
4193f30a969bSdrh     r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
41942dcef11bSdrh     if( r2==r1 ){
41952dcef11bSdrh       *pReg = r1;
41962dcef11bSdrh     }else{
41972dcef11bSdrh       sqlite3ReleaseTempReg(pParse, r1);
41982dcef11bSdrh       *pReg = 0;
41992dcef11bSdrh     }
4200f30a969bSdrh   }
42012dcef11bSdrh   return r2;
42022dcef11bSdrh }
42032dcef11bSdrh 
42042dcef11bSdrh /*
42052dcef11bSdrh ** Generate code that will evaluate expression pExpr and store the
42062dcef11bSdrh ** results in register target.  The results are guaranteed to appear
42072dcef11bSdrh ** in register target.
42082dcef11bSdrh */
420905a86c5cSdrh void sqlite3ExprCode(Parse *pParse, Expr *pExpr, int target){
42109cbf3425Sdrh   int inReg;
42119cbf3425Sdrh 
42129cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
4213ebc16717Sdrh   if( pExpr && pExpr->op==TK_REGISTER ){
4214ebc16717Sdrh     sqlite3VdbeAddOp2(pParse->pVdbe, OP_Copy, pExpr->iTable, target);
4215ebc16717Sdrh   }else{
42169cbf3425Sdrh     inReg = sqlite3ExprCodeTarget(pParse, pExpr, target);
42171c75c9d7Sdrh     assert( pParse->pVdbe!=0 || pParse->db->mallocFailed );
42180e359b30Sdrh     if( inReg!=target && pParse->pVdbe ){
42199cbf3425Sdrh       sqlite3VdbeAddOp2(pParse->pVdbe, OP_SCopy, inReg, target);
422017a7f8ddSdrh     }
4221ebc16717Sdrh   }
4222cce7d176Sdrh }
4223cce7d176Sdrh 
4224cce7d176Sdrh /*
42251c75c9d7Sdrh ** Make a transient copy of expression pExpr and then code it using
42261c75c9d7Sdrh ** sqlite3ExprCode().  This routine works just like sqlite3ExprCode()
42271c75c9d7Sdrh ** except that the input expression is guaranteed to be unchanged.
42281c75c9d7Sdrh */
42291c75c9d7Sdrh void sqlite3ExprCodeCopy(Parse *pParse, Expr *pExpr, int target){
42301c75c9d7Sdrh   sqlite3 *db = pParse->db;
42311c75c9d7Sdrh   pExpr = sqlite3ExprDup(db, pExpr, 0);
42321c75c9d7Sdrh   if( !db->mallocFailed ) sqlite3ExprCode(pParse, pExpr, target);
42331c75c9d7Sdrh   sqlite3ExprDelete(db, pExpr);
42341c75c9d7Sdrh }
42351c75c9d7Sdrh 
42361c75c9d7Sdrh /*
423705a86c5cSdrh ** Generate code that will evaluate expression pExpr and store the
423805a86c5cSdrh ** results in register target.  The results are guaranteed to appear
423905a86c5cSdrh ** in register target.  If the expression is constant, then this routine
424005a86c5cSdrh ** might choose to code the expression at initialization time.
424105a86c5cSdrh */
424205a86c5cSdrh void sqlite3ExprCodeFactorable(Parse *pParse, Expr *pExpr, int target){
424305a86c5cSdrh   if( pParse->okConstFactor && sqlite3ExprIsConstant(pExpr) ){
4244ad879ffdSdrh     sqlite3ExprCodeAtInit(pParse, pExpr, target);
424505a86c5cSdrh   }else{
424605a86c5cSdrh     sqlite3ExprCode(pParse, pExpr, target);
424705a86c5cSdrh   }
4248cce7d176Sdrh }
4249cce7d176Sdrh 
4250cce7d176Sdrh /*
425160ec914cSpeter.d.reid ** Generate code that evaluates the given expression and puts the result
4252de4fcfddSdrh ** in register target.
425325303780Sdrh **
42542dcef11bSdrh ** Also make a copy of the expression results into another "cache" register
42552dcef11bSdrh ** and modify the expression so that the next time it is evaluated,
42562dcef11bSdrh ** the result is a copy of the cache register.
42572dcef11bSdrh **
42582dcef11bSdrh ** This routine is used for expressions that are used multiple
42592dcef11bSdrh ** times.  They are evaluated once and the results of the expression
42602dcef11bSdrh ** are reused.
426125303780Sdrh */
426205a86c5cSdrh void sqlite3ExprCodeAndCache(Parse *pParse, Expr *pExpr, int target){
426325303780Sdrh   Vdbe *v = pParse->pVdbe;
426425303780Sdrh   int iMem;
426505a86c5cSdrh 
426605a86c5cSdrh   assert( target>0 );
426705a86c5cSdrh   assert( pExpr->op!=TK_REGISTER );
426805a86c5cSdrh   sqlite3ExprCode(pParse, pExpr, target);
42692dcef11bSdrh   iMem = ++pParse->nMem;
427005a86c5cSdrh   sqlite3VdbeAddOp2(v, OP_Copy, target, iMem);
4271a4c3c87eSdrh   exprToRegister(pExpr, iMem);
427225303780Sdrh }
42737e02e5e6Sdrh 
4274678ccce8Sdrh /*
4275268380caSdrh ** Generate code that pushes the value of every element of the given
42769cbf3425Sdrh ** expression list into a sequence of registers beginning at target.
4277268380caSdrh **
42783df6c3b1Sdrh ** Return the number of elements evaluated.  The number returned will
42793df6c3b1Sdrh ** usually be pList->nExpr but might be reduced if SQLITE_ECEL_OMITREF
42803df6c3b1Sdrh ** is defined.
4281d1a01edaSdrh **
4282d1a01edaSdrh ** The SQLITE_ECEL_DUP flag prevents the arguments from being
4283d1a01edaSdrh ** filled using OP_SCopy.  OP_Copy must be used instead.
4284d1a01edaSdrh **
4285d1a01edaSdrh ** The SQLITE_ECEL_FACTOR argument allows constant arguments to be
4286d1a01edaSdrh ** factored out into initialization code.
4287b0df9634Sdrh **
4288b0df9634Sdrh ** The SQLITE_ECEL_REF flag means that expressions in the list with
4289b0df9634Sdrh ** ExprList.a[].u.x.iOrderByCol>0 have already been evaluated and stored
4290b0df9634Sdrh ** in registers at srcReg, and so the value can be copied from there.
42913df6c3b1Sdrh ** If SQLITE_ECEL_OMITREF is also set, then the values with u.x.iOrderByCol>0
42923df6c3b1Sdrh ** are simply omitted rather than being copied from srcReg.
4293268380caSdrh */
42944adee20fSdanielk1977 int sqlite3ExprCodeExprList(
4295268380caSdrh   Parse *pParse,     /* Parsing context */
4296389a1adbSdrh   ExprList *pList,   /* The expression list to be coded */
4297191b54cbSdrh   int target,        /* Where to write results */
42985579d59fSdrh   int srcReg,        /* Source registers if SQLITE_ECEL_REF */
4299d1a01edaSdrh   u8 flags           /* SQLITE_ECEL_* flags */
4300268380caSdrh ){
4301268380caSdrh   struct ExprList_item *pItem;
43025579d59fSdrh   int i, j, n;
4303d1a01edaSdrh   u8 copyOp = (flags & SQLITE_ECEL_DUP) ? OP_Copy : OP_SCopy;
43045579d59fSdrh   Vdbe *v = pParse->pVdbe;
43059d8b3072Sdrh   assert( pList!=0 );
43069cbf3425Sdrh   assert( target>0 );
4307d81a142bSdrh   assert( pParse->pVdbe!=0 );  /* Never gets this far otherwise */
4308268380caSdrh   n = pList->nExpr;
4309d9f158e7Sdrh   if( !ConstFactorOk(pParse) ) flags &= ~SQLITE_ECEL_FACTOR;
4310191b54cbSdrh   for(pItem=pList->a, i=0; i<n; i++, pItem++){
43117445ffe2Sdrh     Expr *pExpr = pItem->pExpr;
4312257c13faSdan     if( (flags & SQLITE_ECEL_REF)!=0 && (j = pItem->u.x.iOrderByCol)>0 ){
4313257c13faSdan       if( flags & SQLITE_ECEL_OMITREF ){
4314257c13faSdan         i--;
4315257c13faSdan         n--;
4316257c13faSdan       }else{
43175579d59fSdrh         sqlite3VdbeAddOp2(v, copyOp, j+srcReg-1, target+i);
4318257c13faSdan       }
43195579d59fSdrh     }else if( (flags & SQLITE_ECEL_FACTOR)!=0 && sqlite3ExprIsConstant(pExpr) ){
4320ad879ffdSdrh       sqlite3ExprCodeAtInit(pParse, pExpr, target+i);
4321d1a01edaSdrh     }else{
43227445ffe2Sdrh       int inReg = sqlite3ExprCodeTarget(pParse, pExpr, target+i);
4323746fd9ccSdrh       if( inReg!=target+i ){
43244eded604Sdrh         VdbeOp *pOp;
43254eded604Sdrh         if( copyOp==OP_Copy
43264eded604Sdrh          && (pOp=sqlite3VdbeGetOp(v, -1))->opcode==OP_Copy
43274eded604Sdrh          && pOp->p1+pOp->p3+1==inReg
43284eded604Sdrh          && pOp->p2+pOp->p3+1==target+i
43294eded604Sdrh         ){
43304eded604Sdrh           pOp->p3++;
43314eded604Sdrh         }else{
43324eded604Sdrh           sqlite3VdbeAddOp2(v, copyOp, inReg, target+i);
43334eded604Sdrh         }
4334d1a01edaSdrh       }
4335d176611bSdrh     }
4336268380caSdrh   }
4337f9b596ebSdrh   return n;
4338268380caSdrh }
4339268380caSdrh 
4340268380caSdrh /*
434136c563a2Sdrh ** Generate code for a BETWEEN operator.
434236c563a2Sdrh **
434336c563a2Sdrh **    x BETWEEN y AND z
434436c563a2Sdrh **
434536c563a2Sdrh ** The above is equivalent to
434636c563a2Sdrh **
434736c563a2Sdrh **    x>=y AND x<=z
434836c563a2Sdrh **
434936c563a2Sdrh ** Code it as such, taking care to do the common subexpression
435060ec914cSpeter.d.reid ** elimination of x.
435184b19a3dSdrh **
435284b19a3dSdrh ** The xJumpIf parameter determines details:
435384b19a3dSdrh **
435484b19a3dSdrh **    NULL:                   Store the boolean result in reg[dest]
435584b19a3dSdrh **    sqlite3ExprIfTrue:      Jump to dest if true
435684b19a3dSdrh **    sqlite3ExprIfFalse:     Jump to dest if false
435784b19a3dSdrh **
435884b19a3dSdrh ** The jumpIfNull parameter is ignored if xJumpIf is NULL.
435936c563a2Sdrh */
436036c563a2Sdrh static void exprCodeBetween(
436136c563a2Sdrh   Parse *pParse,    /* Parsing and code generating context */
436236c563a2Sdrh   Expr *pExpr,      /* The BETWEEN expression */
436384b19a3dSdrh   int dest,         /* Jump destination or storage location */
436484b19a3dSdrh   void (*xJump)(Parse*,Expr*,int,int), /* Action to take */
436536c563a2Sdrh   int jumpIfNull    /* Take the jump if the BETWEEN is NULL */
436636c563a2Sdrh ){
436736c563a2Sdrh  Expr exprAnd;     /* The AND operator in  x>=y AND x<=z  */
436836c563a2Sdrh   Expr compLeft;    /* The  x>=y  term */
436936c563a2Sdrh   Expr compRight;   /* The  x<=z  term */
4370db45bd5eSdrh   Expr exprX;       /* The  x  subexpression */
4371db45bd5eSdrh   int regFree1 = 0; /* Temporary use register */
437284b19a3dSdrh 
437336c563a2Sdrh 
437471c57db0Sdan   memset(&compLeft, 0, sizeof(Expr));
437571c57db0Sdan   memset(&compRight, 0, sizeof(Expr));
437671c57db0Sdan   memset(&exprAnd, 0, sizeof(Expr));
4377db45bd5eSdrh 
4378db45bd5eSdrh   assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
4379db45bd5eSdrh   exprX = *pExpr->pLeft;
438036c563a2Sdrh   exprAnd.op = TK_AND;
438136c563a2Sdrh   exprAnd.pLeft = &compLeft;
438236c563a2Sdrh   exprAnd.pRight = &compRight;
438336c563a2Sdrh   compLeft.op = TK_GE;
4384db45bd5eSdrh   compLeft.pLeft = &exprX;
438536c563a2Sdrh   compLeft.pRight = pExpr->x.pList->a[0].pExpr;
438636c563a2Sdrh   compRight.op = TK_LE;
4387db45bd5eSdrh   compRight.pLeft = &exprX;
438836c563a2Sdrh   compRight.pRight = pExpr->x.pList->a[1].pExpr;
438912abf408Sdrh   exprToRegister(&exprX, exprCodeVector(pParse, &exprX, &regFree1));
439084b19a3dSdrh   if( xJump ){
439184b19a3dSdrh     xJump(pParse, &exprAnd, dest, jumpIfNull);
439236c563a2Sdrh   }else{
439336fd41e5Sdrh     /* Mark the expression is being from the ON or USING clause of a join
439436fd41e5Sdrh     ** so that the sqlite3ExprCodeTarget() routine will not attempt to move
439536fd41e5Sdrh     ** it into the Parse.pConstExpr list.  We should use a new bit for this,
439636fd41e5Sdrh     ** for clarity, but we are out of bits in the Expr.flags field so we
439736fd41e5Sdrh     ** have to reuse the EP_FromJoin bit.  Bummer. */
4398db45bd5eSdrh     exprX.flags |= EP_FromJoin;
439971c57db0Sdan     sqlite3ExprCodeTarget(pParse, &exprAnd, dest);
440036c563a2Sdrh   }
4401db45bd5eSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
440236c563a2Sdrh 
440336c563a2Sdrh   /* Ensure adequate test coverage */
4404db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull==0 && regFree1==0 );
4405db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull==0 && regFree1!=0 );
4406db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull!=0 && regFree1==0 );
4407db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull!=0 && regFree1!=0 );
4408db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1==0 );
4409db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1!=0 );
4410db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1==0 );
4411db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1!=0 );
441284b19a3dSdrh   testcase( xJump==0 );
441336c563a2Sdrh }
441436c563a2Sdrh 
441536c563a2Sdrh /*
4416cce7d176Sdrh ** Generate code for a boolean expression such that a jump is made
4417cce7d176Sdrh ** to the label "dest" if the expression is true but execution
4418cce7d176Sdrh ** continues straight thru if the expression is false.
4419f5905aa7Sdrh **
4420f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false), then
442135573356Sdrh ** take the jump if the jumpIfNull flag is SQLITE_JUMPIFNULL.
4422f2bc013cSdrh **
4423f2bc013cSdrh ** This code depends on the fact that certain token values (ex: TK_EQ)
4424f2bc013cSdrh ** are the same as opcode values (ex: OP_Eq) that implement the corresponding
4425f2bc013cSdrh ** operation.  Special comments in vdbe.c and the mkopcodeh.awk script in
4426f2bc013cSdrh ** the make process cause these values to align.  Assert()s in the code
4427f2bc013cSdrh ** below verify that the numbers are aligned correctly.
4428cce7d176Sdrh */
44294adee20fSdanielk1977 void sqlite3ExprIfTrue(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
4430cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
4431cce7d176Sdrh   int op = 0;
44322dcef11bSdrh   int regFree1 = 0;
44332dcef11bSdrh   int regFree2 = 0;
44342dcef11bSdrh   int r1, r2;
44352dcef11bSdrh 
443635573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
443748864df9Smistachkin   if( NEVER(v==0) )     return;  /* Existence of VDBE checked by caller */
443833cd4909Sdrh   if( NEVER(pExpr==0) ) return;  /* No way this can happen */
4439f2bc013cSdrh   op = pExpr->op;
44407b35a77bSdan   switch( op ){
4441cce7d176Sdrh     case TK_AND: {
44424adee20fSdanielk1977       int d2 = sqlite3VdbeMakeLabel(v);
4443c5499befSdrh       testcase( jumpIfNull==0 );
444435573356Sdrh       sqlite3ExprIfFalse(pParse, pExpr->pLeft, d2,jumpIfNull^SQLITE_JUMPIFNULL);
444554e2adb5Sdrh       sqlite3ExprCachePush(pParse);
44464adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
44474adee20fSdanielk1977       sqlite3VdbeResolveLabel(v, d2);
4448d2490904Sdrh       sqlite3ExprCachePop(pParse);
4449cce7d176Sdrh       break;
4450cce7d176Sdrh     }
4451cce7d176Sdrh     case TK_OR: {
4452c5499befSdrh       testcase( jumpIfNull==0 );
44534adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
445454e2adb5Sdrh       sqlite3ExprCachePush(pParse);
44554adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
4456d2490904Sdrh       sqlite3ExprCachePop(pParse);
4457cce7d176Sdrh       break;
4458cce7d176Sdrh     }
4459cce7d176Sdrh     case TK_NOT: {
4460c5499befSdrh       testcase( jumpIfNull==0 );
44614adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
4462cce7d176Sdrh       break;
4463cce7d176Sdrh     }
4464de845c2fSdrh     case TK_IS:
4465de845c2fSdrh     case TK_ISNOT:
4466de845c2fSdrh       testcase( op==TK_IS );
4467de845c2fSdrh       testcase( op==TK_ISNOT );
4468de845c2fSdrh       op = (op==TK_IS) ? TK_EQ : TK_NE;
4469de845c2fSdrh       jumpIfNull = SQLITE_NULLEQ;
4470de845c2fSdrh       /* Fall thru */
4471cce7d176Sdrh     case TK_LT:
4472cce7d176Sdrh     case TK_LE:
4473cce7d176Sdrh     case TK_GT:
4474cce7d176Sdrh     case TK_GE:
4475cce7d176Sdrh     case TK_NE:
44760ac65892Sdrh     case TK_EQ: {
4477625015e0Sdan       if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
4478c5499befSdrh       testcase( jumpIfNull==0 );
4479b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4480b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
448135573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
44822dcef11bSdrh                   r1, r2, dest, jumpIfNull);
44837d176105Sdrh       assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
44847d176105Sdrh       assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
44857d176105Sdrh       assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
44867d176105Sdrh       assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
4487de845c2fSdrh       assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4488de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4489de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4490de845c2fSdrh       assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4491de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
4492de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
44936a2fe093Sdrh       testcase( regFree1==0 );
44946a2fe093Sdrh       testcase( regFree2==0 );
44956a2fe093Sdrh       break;
44966a2fe093Sdrh     }
4497cce7d176Sdrh     case TK_ISNULL:
4498cce7d176Sdrh     case TK_NOTNULL: {
44997d176105Sdrh       assert( TK_ISNULL==OP_IsNull );   testcase( op==TK_ISNULL );
45007d176105Sdrh       assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
45012dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
45022dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
45037d176105Sdrh       VdbeCoverageIf(v, op==TK_ISNULL);
45047d176105Sdrh       VdbeCoverageIf(v, op==TK_NOTNULL);
4505c5499befSdrh       testcase( regFree1==0 );
4506cce7d176Sdrh       break;
4507cce7d176Sdrh     }
4508fef5208cSdrh     case TK_BETWEEN: {
45095c03f30aSdrh       testcase( jumpIfNull==0 );
451071c57db0Sdan       exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfTrue, jumpIfNull);
4511fef5208cSdrh       break;
4512fef5208cSdrh     }
4513bb201344Sshaneh #ifndef SQLITE_OMIT_SUBQUERY
4514e3365e6cSdrh     case TK_IN: {
4515e3365e6cSdrh       int destIfFalse = sqlite3VdbeMakeLabel(v);
4516e3365e6cSdrh       int destIfNull = jumpIfNull ? dest : destIfFalse;
4517e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
4518076e85f5Sdrh       sqlite3VdbeGoto(v, dest);
4519e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
4520e3365e6cSdrh       break;
4521e3365e6cSdrh     }
4522bb201344Sshaneh #endif
4523cce7d176Sdrh     default: {
45247b35a77bSdan     default_expr:
4525991a1985Sdrh       if( exprAlwaysTrue(pExpr) ){
4526076e85f5Sdrh         sqlite3VdbeGoto(v, dest);
4527991a1985Sdrh       }else if( exprAlwaysFalse(pExpr) ){
4528991a1985Sdrh         /* No-op */
4529991a1985Sdrh       }else{
45302dcef11bSdrh         r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
45312dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_If, r1, dest, jumpIfNull!=0);
4532688852abSdrh         VdbeCoverage(v);
4533c5499befSdrh         testcase( regFree1==0 );
4534c5499befSdrh         testcase( jumpIfNull==0 );
4535991a1985Sdrh       }
4536cce7d176Sdrh       break;
4537cce7d176Sdrh     }
4538cce7d176Sdrh   }
45392dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
45402dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
4541cce7d176Sdrh }
4542cce7d176Sdrh 
4543cce7d176Sdrh /*
454466b89c8fSdrh ** Generate code for a boolean expression such that a jump is made
4545cce7d176Sdrh ** to the label "dest" if the expression is false but execution
4546cce7d176Sdrh ** continues straight thru if the expression is true.
4547f5905aa7Sdrh **
4548f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false) then
454935573356Sdrh ** jump if jumpIfNull is SQLITE_JUMPIFNULL or fall through if jumpIfNull
455035573356Sdrh ** is 0.
4551cce7d176Sdrh */
45524adee20fSdanielk1977 void sqlite3ExprIfFalse(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
4553cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
4554cce7d176Sdrh   int op = 0;
45552dcef11bSdrh   int regFree1 = 0;
45562dcef11bSdrh   int regFree2 = 0;
45572dcef11bSdrh   int r1, r2;
45582dcef11bSdrh 
455935573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
456048864df9Smistachkin   if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
456133cd4909Sdrh   if( pExpr==0 )    return;
4562f2bc013cSdrh 
4563f2bc013cSdrh   /* The value of pExpr->op and op are related as follows:
4564f2bc013cSdrh   **
4565f2bc013cSdrh   **       pExpr->op            op
4566f2bc013cSdrh   **       ---------          ----------
4567f2bc013cSdrh   **       TK_ISNULL          OP_NotNull
4568f2bc013cSdrh   **       TK_NOTNULL         OP_IsNull
4569f2bc013cSdrh   **       TK_NE              OP_Eq
4570f2bc013cSdrh   **       TK_EQ              OP_Ne
4571f2bc013cSdrh   **       TK_GT              OP_Le
4572f2bc013cSdrh   **       TK_LE              OP_Gt
4573f2bc013cSdrh   **       TK_GE              OP_Lt
4574f2bc013cSdrh   **       TK_LT              OP_Ge
4575f2bc013cSdrh   **
4576f2bc013cSdrh   ** For other values of pExpr->op, op is undefined and unused.
4577f2bc013cSdrh   ** The value of TK_ and OP_ constants are arranged such that we
4578f2bc013cSdrh   ** can compute the mapping above using the following expression.
4579f2bc013cSdrh   ** Assert()s verify that the computation is correct.
4580f2bc013cSdrh   */
4581f2bc013cSdrh   op = ((pExpr->op+(TK_ISNULL&1))^1)-(TK_ISNULL&1);
4582f2bc013cSdrh 
4583f2bc013cSdrh   /* Verify correct alignment of TK_ and OP_ constants
4584f2bc013cSdrh   */
4585f2bc013cSdrh   assert( pExpr->op!=TK_ISNULL || op==OP_NotNull );
4586f2bc013cSdrh   assert( pExpr->op!=TK_NOTNULL || op==OP_IsNull );
4587f2bc013cSdrh   assert( pExpr->op!=TK_NE || op==OP_Eq );
4588f2bc013cSdrh   assert( pExpr->op!=TK_EQ || op==OP_Ne );
4589f2bc013cSdrh   assert( pExpr->op!=TK_LT || op==OP_Ge );
4590f2bc013cSdrh   assert( pExpr->op!=TK_LE || op==OP_Gt );
4591f2bc013cSdrh   assert( pExpr->op!=TK_GT || op==OP_Le );
4592f2bc013cSdrh   assert( pExpr->op!=TK_GE || op==OP_Lt );
4593f2bc013cSdrh 
4594ba00e30aSdan   switch( pExpr->op ){
4595cce7d176Sdrh     case TK_AND: {
4596c5499befSdrh       testcase( jumpIfNull==0 );
45974adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
459854e2adb5Sdrh       sqlite3ExprCachePush(pParse);
45994adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
4600d2490904Sdrh       sqlite3ExprCachePop(pParse);
4601cce7d176Sdrh       break;
4602cce7d176Sdrh     }
4603cce7d176Sdrh     case TK_OR: {
46044adee20fSdanielk1977       int d2 = sqlite3VdbeMakeLabel(v);
4605c5499befSdrh       testcase( jumpIfNull==0 );
460635573356Sdrh       sqlite3ExprIfTrue(pParse, pExpr->pLeft, d2, jumpIfNull^SQLITE_JUMPIFNULL);
460754e2adb5Sdrh       sqlite3ExprCachePush(pParse);
46084adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
46094adee20fSdanielk1977       sqlite3VdbeResolveLabel(v, d2);
4610d2490904Sdrh       sqlite3ExprCachePop(pParse);
4611cce7d176Sdrh       break;
4612cce7d176Sdrh     }
4613cce7d176Sdrh     case TK_NOT: {
46145c03f30aSdrh       testcase( jumpIfNull==0 );
46154adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
4616cce7d176Sdrh       break;
4617cce7d176Sdrh     }
4618de845c2fSdrh     case TK_IS:
4619de845c2fSdrh     case TK_ISNOT:
4620de845c2fSdrh       testcase( pExpr->op==TK_IS );
4621de845c2fSdrh       testcase( pExpr->op==TK_ISNOT );
4622de845c2fSdrh       op = (pExpr->op==TK_IS) ? TK_NE : TK_EQ;
4623de845c2fSdrh       jumpIfNull = SQLITE_NULLEQ;
4624de845c2fSdrh       /* Fall thru */
4625cce7d176Sdrh     case TK_LT:
4626cce7d176Sdrh     case TK_LE:
4627cce7d176Sdrh     case TK_GT:
4628cce7d176Sdrh     case TK_GE:
4629cce7d176Sdrh     case TK_NE:
4630cce7d176Sdrh     case TK_EQ: {
4631625015e0Sdan       if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
4632c5499befSdrh       testcase( jumpIfNull==0 );
4633b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4634b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
463535573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
46362dcef11bSdrh                   r1, r2, dest, jumpIfNull);
46377d176105Sdrh       assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
46387d176105Sdrh       assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
46397d176105Sdrh       assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
46407d176105Sdrh       assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
4641de845c2fSdrh       assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4642de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4643de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4644de845c2fSdrh       assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4645de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
4646de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
46476a2fe093Sdrh       testcase( regFree1==0 );
46486a2fe093Sdrh       testcase( regFree2==0 );
46496a2fe093Sdrh       break;
46506a2fe093Sdrh     }
4651cce7d176Sdrh     case TK_ISNULL:
4652cce7d176Sdrh     case TK_NOTNULL: {
46532dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
46542dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
46557d176105Sdrh       testcase( op==TK_ISNULL );   VdbeCoverageIf(v, op==TK_ISNULL);
46567d176105Sdrh       testcase( op==TK_NOTNULL );  VdbeCoverageIf(v, op==TK_NOTNULL);
4657c5499befSdrh       testcase( regFree1==0 );
4658cce7d176Sdrh       break;
4659cce7d176Sdrh     }
4660fef5208cSdrh     case TK_BETWEEN: {
46615c03f30aSdrh       testcase( jumpIfNull==0 );
466271c57db0Sdan       exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfFalse, jumpIfNull);
4663fef5208cSdrh       break;
4664fef5208cSdrh     }
4665bb201344Sshaneh #ifndef SQLITE_OMIT_SUBQUERY
4666e3365e6cSdrh     case TK_IN: {
4667e3365e6cSdrh       if( jumpIfNull ){
4668e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, dest);
4669e3365e6cSdrh       }else{
4670e3365e6cSdrh         int destIfNull = sqlite3VdbeMakeLabel(v);
4671e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, destIfNull);
4672e3365e6cSdrh         sqlite3VdbeResolveLabel(v, destIfNull);
4673e3365e6cSdrh       }
4674e3365e6cSdrh       break;
4675e3365e6cSdrh     }
4676bb201344Sshaneh #endif
4677cce7d176Sdrh     default: {
4678ba00e30aSdan     default_expr:
4679991a1985Sdrh       if( exprAlwaysFalse(pExpr) ){
4680076e85f5Sdrh         sqlite3VdbeGoto(v, dest);
4681991a1985Sdrh       }else if( exprAlwaysTrue(pExpr) ){
4682991a1985Sdrh         /* no-op */
4683991a1985Sdrh       }else{
46842dcef11bSdrh         r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
46852dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_IfNot, r1, dest, jumpIfNull!=0);
4686688852abSdrh         VdbeCoverage(v);
4687c5499befSdrh         testcase( regFree1==0 );
4688c5499befSdrh         testcase( jumpIfNull==0 );
4689991a1985Sdrh       }
4690cce7d176Sdrh       break;
4691cce7d176Sdrh     }
4692cce7d176Sdrh   }
46932dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
46942dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
4695cce7d176Sdrh }
46962282792aSdrh 
46972282792aSdrh /*
469872bc8208Sdrh ** Like sqlite3ExprIfFalse() except that a copy is made of pExpr before
469972bc8208Sdrh ** code generation, and that copy is deleted after code generation. This
470072bc8208Sdrh ** ensures that the original pExpr is unchanged.
470172bc8208Sdrh */
470272bc8208Sdrh void sqlite3ExprIfFalseDup(Parse *pParse, Expr *pExpr, int dest,int jumpIfNull){
470372bc8208Sdrh   sqlite3 *db = pParse->db;
470472bc8208Sdrh   Expr *pCopy = sqlite3ExprDup(db, pExpr, 0);
470572bc8208Sdrh   if( db->mallocFailed==0 ){
470672bc8208Sdrh     sqlite3ExprIfFalse(pParse, pCopy, dest, jumpIfNull);
470772bc8208Sdrh   }
470872bc8208Sdrh   sqlite3ExprDelete(db, pCopy);
470972bc8208Sdrh }
471072bc8208Sdrh 
47115aa550cfSdan /*
47125aa550cfSdan ** Expression pVar is guaranteed to be an SQL variable. pExpr may be any
47135aa550cfSdan ** type of expression.
47145aa550cfSdan **
47155aa550cfSdan ** If pExpr is a simple SQL value - an integer, real, string, blob
47165aa550cfSdan ** or NULL value - then the VDBE currently being prepared is configured
47175aa550cfSdan ** to re-prepare each time a new value is bound to variable pVar.
47185aa550cfSdan **
47195aa550cfSdan ** Additionally, if pExpr is a simple SQL value and the value is the
47205aa550cfSdan ** same as that currently bound to variable pVar, non-zero is returned.
47215aa550cfSdan ** Otherwise, if the values are not the same or if pExpr is not a simple
47225aa550cfSdan ** SQL value, zero is returned.
47235aa550cfSdan */
47245aa550cfSdan static int exprCompareVariable(Parse *pParse, Expr *pVar, Expr *pExpr){
47255aa550cfSdan   int res = 0;
4726c0804226Sdrh   int iVar;
4727c0804226Sdrh   sqlite3_value *pL, *pR = 0;
47285aa550cfSdan 
47295aa550cfSdan   sqlite3ValueFromExpr(pParse->db, pExpr, SQLITE_UTF8, SQLITE_AFF_BLOB, &pR);
4730c0804226Sdrh   if( pR ){
4731c0804226Sdrh     iVar = pVar->iColumn;
4732c0804226Sdrh     sqlite3VdbeSetVarmask(pParse->pVdbe, iVar);
4733c0804226Sdrh     pL = sqlite3VdbeGetBoundValue(pParse->pReprepare, iVar, SQLITE_AFF_BLOB);
47345aa307e2Sdrh     if( pL ){
47355aa307e2Sdrh       if( sqlite3_value_type(pL)==SQLITE_TEXT ){
47365aa307e2Sdrh         sqlite3_value_text(pL); /* Make sure the encoding is UTF-8 */
47375aa307e2Sdrh       }
47385aa307e2Sdrh       res =  0==sqlite3MemCompare(pL, pR, 0);
47395aa550cfSdan     }
47405aa550cfSdan     sqlite3ValueFree(pR);
47415aa550cfSdan     sqlite3ValueFree(pL);
47425aa550cfSdan   }
47435aa550cfSdan 
47445aa550cfSdan   return res;
47455aa550cfSdan }
474672bc8208Sdrh 
474772bc8208Sdrh /*
47481d9da70aSdrh ** Do a deep comparison of two expression trees.  Return 0 if the two
47491d9da70aSdrh ** expressions are completely identical.  Return 1 if they differ only
47501d9da70aSdrh ** by a COLLATE operator at the top level.  Return 2 if there are differences
47511d9da70aSdrh ** other than the top-level COLLATE operator.
4752d40aab0eSdrh **
4753619a1305Sdrh ** If any subelement of pB has Expr.iTable==(-1) then it is allowed
4754619a1305Sdrh ** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
4755619a1305Sdrh **
475666518ca7Sdrh ** The pA side might be using TK_REGISTER.  If that is the case and pB is
475766518ca7Sdrh ** not using TK_REGISTER but is otherwise equivalent, then still return 0.
475866518ca7Sdrh **
47591d9da70aSdrh ** Sometimes this routine will return 2 even if the two expressions
4760d40aab0eSdrh ** really are equivalent.  If we cannot prove that the expressions are
47611d9da70aSdrh ** identical, we return 2 just to be safe.  So if this routine
47621d9da70aSdrh ** returns 2, then you do not really know for certain if the two
47631d9da70aSdrh ** expressions are the same.  But if you get a 0 or 1 return, then you
4764d40aab0eSdrh ** can be sure the expressions are the same.  In the places where
47651d9da70aSdrh ** this routine is used, it does not hurt to get an extra 2 - that
4766d40aab0eSdrh ** just might result in some slightly slower code.  But returning
47671d9da70aSdrh ** an incorrect 0 or 1 could lead to a malfunction.
47685aa550cfSdan **
4769c0804226Sdrh ** If pParse is not NULL then TK_VARIABLE terms in pA with bindings in
4770c0804226Sdrh ** pParse->pReprepare can be matched against literals in pB.  The
4771c0804226Sdrh ** pParse->pVdbe->expmask bitmask is updated for each variable referenced.
4772c0804226Sdrh ** If pParse is NULL (the normal case) then any TK_VARIABLE term in
4773c0804226Sdrh ** Argument pParse should normally be NULL. If it is not NULL and pA or
4774c0804226Sdrh ** pB causes a return value of 2.
47752282792aSdrh */
47765aa550cfSdan int sqlite3ExprCompare(Parse *pParse, Expr *pA, Expr *pB, int iTab){
477710d1edf0Sdrh   u32 combinedFlags;
47784b202ae2Sdanielk1977   if( pA==0 || pB==0 ){
47791d9da70aSdrh     return pB==pA ? 0 : 2;
47802282792aSdrh   }
47815aa550cfSdan   if( pParse && pA->op==TK_VARIABLE && exprCompareVariable(pParse, pA, pB) ){
47825aa550cfSdan     return 0;
47835aa550cfSdan   }
478410d1edf0Sdrh   combinedFlags = pA->flags | pB->flags;
478510d1edf0Sdrh   if( combinedFlags & EP_IntValue ){
478610d1edf0Sdrh     if( (pA->flags&pB->flags&EP_IntValue)!=0 && pA->u.iValue==pB->u.iValue ){
478710d1edf0Sdrh       return 0;
478810d1edf0Sdrh     }
47891d9da70aSdrh     return 2;
47906ab3a2ecSdanielk1977   }
4791c2acc4e4Sdrh   if( pA->op!=pB->op ){
47925aa550cfSdan     if( pA->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA->pLeft,pB,iTab)<2 ){
4793ae80ddeaSdrh       return 1;
4794ae80ddeaSdrh     }
47955aa550cfSdan     if( pB->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA,pB->pLeft,iTab)<2 ){
4796ae80ddeaSdrh       return 1;
4797ae80ddeaSdrh     }
4798ae80ddeaSdrh     return 2;
4799ae80ddeaSdrh   }
48002edc5fd7Sdrh   if( pA->op!=TK_COLUMN && pA->op!=TK_AGG_COLUMN && pA->u.zToken ){
4801390b88a4Sdrh     if( pA->op==TK_FUNCTION ){
4802390b88a4Sdrh       if( sqlite3StrICmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
4803390b88a4Sdrh     }else if( strcmp(pA->u.zToken,pB->u.zToken)!=0 ){
480410d1edf0Sdrh       return pA->op==TK_COLLATE ? 1 : 2;
480510d1edf0Sdrh     }
480610d1edf0Sdrh   }
480710d1edf0Sdrh   if( (pA->flags & EP_Distinct)!=(pB->flags & EP_Distinct) ) return 2;
480885f8aa79Sdrh   if( ALWAYS((combinedFlags & EP_TokenOnly)==0) ){
480910d1edf0Sdrh     if( combinedFlags & EP_xIsSelect ) return 2;
48105aa550cfSdan     if( sqlite3ExprCompare(pParse, pA->pLeft, pB->pLeft, iTab) ) return 2;
48115aa550cfSdan     if( sqlite3ExprCompare(pParse, pA->pRight, pB->pRight, iTab) ) return 2;
4812619a1305Sdrh     if( sqlite3ExprListCompare(pA->x.pList, pB->x.pList, iTab) ) return 2;
48137693c42fSdrh     if( ALWAYS((combinedFlags & EP_Reduced)==0) && pA->op!=TK_STRING ){
4814619a1305Sdrh       if( pA->iColumn!=pB->iColumn ) return 2;
481566518ca7Sdrh       if( pA->iTable!=pB->iTable
481685f8aa79Sdrh        && (pA->iTable!=iTab || NEVER(pB->iTable>=0)) ) return 2;
48171d9da70aSdrh     }
48181d9da70aSdrh   }
48192646da7eSdrh   return 0;
48202646da7eSdrh }
48212282792aSdrh 
48228c6f666bSdrh /*
48238c6f666bSdrh ** Compare two ExprList objects.  Return 0 if they are identical and
48248c6f666bSdrh ** non-zero if they differ in any way.
48258c6f666bSdrh **
4826619a1305Sdrh ** If any subelement of pB has Expr.iTable==(-1) then it is allowed
4827619a1305Sdrh ** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
4828619a1305Sdrh **
48298c6f666bSdrh ** This routine might return non-zero for equivalent ExprLists.  The
48308c6f666bSdrh ** only consequence will be disabled optimizations.  But this routine
48318c6f666bSdrh ** must never return 0 if the two ExprList objects are different, or
48328c6f666bSdrh ** a malfunction will result.
48338c6f666bSdrh **
48348c6f666bSdrh ** Two NULL pointers are considered to be the same.  But a NULL pointer
48358c6f666bSdrh ** always differs from a non-NULL pointer.
48368c6f666bSdrh */
4837619a1305Sdrh int sqlite3ExprListCompare(ExprList *pA, ExprList *pB, int iTab){
48388c6f666bSdrh   int i;
48398c6f666bSdrh   if( pA==0 && pB==0 ) return 0;
48408c6f666bSdrh   if( pA==0 || pB==0 ) return 1;
48418c6f666bSdrh   if( pA->nExpr!=pB->nExpr ) return 1;
48428c6f666bSdrh   for(i=0; i<pA->nExpr; i++){
48438c6f666bSdrh     Expr *pExprA = pA->a[i].pExpr;
48448c6f666bSdrh     Expr *pExprB = pB->a[i].pExpr;
48458c6f666bSdrh     if( pA->a[i].sortOrder!=pB->a[i].sortOrder ) return 1;
48465aa550cfSdan     if( sqlite3ExprCompare(0, pExprA, pExprB, iTab) ) return 1;
48478c6f666bSdrh   }
48488c6f666bSdrh   return 0;
48498c6f666bSdrh }
485013449892Sdrh 
48512282792aSdrh /*
4852f9463dfbSdrh ** Like sqlite3ExprCompare() except COLLATE operators at the top-level
4853f9463dfbSdrh ** are ignored.
4854f9463dfbSdrh */
4855f9463dfbSdrh int sqlite3ExprCompareSkip(Expr *pA, Expr *pB, int iTab){
48565aa550cfSdan   return sqlite3ExprCompare(0,
4857f9463dfbSdrh              sqlite3ExprSkipCollate(pA),
4858f9463dfbSdrh              sqlite3ExprSkipCollate(pB),
4859f9463dfbSdrh              iTab);
4860f9463dfbSdrh }
4861f9463dfbSdrh 
4862f9463dfbSdrh /*
48634bd5f73fSdrh ** Return true if we can prove the pE2 will always be true if pE1 is
48644bd5f73fSdrh ** true.  Return false if we cannot complete the proof or if pE2 might
48654bd5f73fSdrh ** be false.  Examples:
48664bd5f73fSdrh **
4867619a1305Sdrh **     pE1: x==5       pE2: x==5             Result: true
48684bd5f73fSdrh **     pE1: x>0        pE2: x==5             Result: false
4869619a1305Sdrh **     pE1: x=21       pE2: x=21 OR y=43     Result: true
48704bd5f73fSdrh **     pE1: x!=123     pE2: x IS NOT NULL    Result: true
4871619a1305Sdrh **     pE1: x!=?1      pE2: x IS NOT NULL    Result: true
4872619a1305Sdrh **     pE1: x IS NULL  pE2: x IS NOT NULL    Result: false
4873619a1305Sdrh **     pE1: x IS ?2    pE2: x IS NOT NULL    Reuslt: false
48744bd5f73fSdrh **
48754bd5f73fSdrh ** When comparing TK_COLUMN nodes between pE1 and pE2, if pE2 has
48764bd5f73fSdrh ** Expr.iTable<0 then assume a table number given by iTab.
48774bd5f73fSdrh **
4878c0804226Sdrh ** If pParse is not NULL, then the values of bound variables in pE1 are
4879c0804226Sdrh ** compared against literal values in pE2 and pParse->pVdbe->expmask is
4880c0804226Sdrh ** modified to record which bound variables are referenced.  If pParse
4881c0804226Sdrh ** is NULL, then false will be returned if pE1 contains any bound variables.
4882c0804226Sdrh **
48834bd5f73fSdrh ** When in doubt, return false.  Returning true might give a performance
48844bd5f73fSdrh ** improvement.  Returning false might cause a performance reduction, but
48854bd5f73fSdrh ** it will always give the correct answer and is hence always safe.
48864bd5f73fSdrh */
48875aa550cfSdan int sqlite3ExprImpliesExpr(Parse *pParse, Expr *pE1, Expr *pE2, int iTab){
48885aa550cfSdan   if( sqlite3ExprCompare(pParse, pE1, pE2, iTab)==0 ){
4889619a1305Sdrh     return 1;
4890619a1305Sdrh   }
4891619a1305Sdrh   if( pE2->op==TK_OR
48925aa550cfSdan    && (sqlite3ExprImpliesExpr(pParse, pE1, pE2->pLeft, iTab)
48935aa550cfSdan              || sqlite3ExprImpliesExpr(pParse, pE1, pE2->pRight, iTab) )
4894619a1305Sdrh   ){
4895619a1305Sdrh     return 1;
4896619a1305Sdrh   }
48971ad93a00Sdrh   if( pE2->op==TK_NOTNULL && pE1->op!=TK_ISNULL && pE1->op!=TK_IS ){
48981ad93a00Sdrh     Expr *pX = sqlite3ExprSkipCollate(pE1->pLeft);
48991ad93a00Sdrh     testcase( pX!=pE1->pLeft );
49005aa550cfSdan     if( sqlite3ExprCompare(pParse, pX, pE2->pLeft, iTab)==0 ) return 1;
4901619a1305Sdrh   }
4902619a1305Sdrh   return 0;
49034bd5f73fSdrh }
49044bd5f73fSdrh 
49054bd5f73fSdrh /*
4906030796dfSdrh ** An instance of the following structure is used by the tree walker
49072409f8a1Sdrh ** to determine if an expression can be evaluated by reference to the
49082409f8a1Sdrh ** index only, without having to do a search for the corresponding
49092409f8a1Sdrh ** table entry.  The IdxCover.pIdx field is the index.  IdxCover.iCur
49102409f8a1Sdrh ** is the cursor for the table.
49112409f8a1Sdrh */
49122409f8a1Sdrh struct IdxCover {
49132409f8a1Sdrh   Index *pIdx;     /* The index to be tested for coverage */
49142409f8a1Sdrh   int iCur;        /* Cursor number for the table corresponding to the index */
49152409f8a1Sdrh };
49162409f8a1Sdrh 
49172409f8a1Sdrh /*
49182409f8a1Sdrh ** Check to see if there are references to columns in table
49192409f8a1Sdrh ** pWalker->u.pIdxCover->iCur can be satisfied using the index
49202409f8a1Sdrh ** pWalker->u.pIdxCover->pIdx.
49212409f8a1Sdrh */
49222409f8a1Sdrh static int exprIdxCover(Walker *pWalker, Expr *pExpr){
49232409f8a1Sdrh   if( pExpr->op==TK_COLUMN
49242409f8a1Sdrh    && pExpr->iTable==pWalker->u.pIdxCover->iCur
49252409f8a1Sdrh    && sqlite3ColumnOfIndex(pWalker->u.pIdxCover->pIdx, pExpr->iColumn)<0
49262409f8a1Sdrh   ){
49272409f8a1Sdrh     pWalker->eCode = 1;
49282409f8a1Sdrh     return WRC_Abort;
49292409f8a1Sdrh   }
49302409f8a1Sdrh   return WRC_Continue;
49312409f8a1Sdrh }
49322409f8a1Sdrh 
49332409f8a1Sdrh /*
4934e604ec0bSdrh ** Determine if an index pIdx on table with cursor iCur contains will
4935e604ec0bSdrh ** the expression pExpr.  Return true if the index does cover the
4936e604ec0bSdrh ** expression and false if the pExpr expression references table columns
4937e604ec0bSdrh ** that are not found in the index pIdx.
49382409f8a1Sdrh **
49392409f8a1Sdrh ** An index covering an expression means that the expression can be
49402409f8a1Sdrh ** evaluated using only the index and without having to lookup the
49412409f8a1Sdrh ** corresponding table entry.
49422409f8a1Sdrh */
49432409f8a1Sdrh int sqlite3ExprCoveredByIndex(
49442409f8a1Sdrh   Expr *pExpr,        /* The index to be tested */
49452409f8a1Sdrh   int iCur,           /* The cursor number for the corresponding table */
49462409f8a1Sdrh   Index *pIdx         /* The index that might be used for coverage */
49472409f8a1Sdrh ){
49482409f8a1Sdrh   Walker w;
49492409f8a1Sdrh   struct IdxCover xcov;
49502409f8a1Sdrh   memset(&w, 0, sizeof(w));
49512409f8a1Sdrh   xcov.iCur = iCur;
49522409f8a1Sdrh   xcov.pIdx = pIdx;
49532409f8a1Sdrh   w.xExprCallback = exprIdxCover;
49542409f8a1Sdrh   w.u.pIdxCover = &xcov;
49552409f8a1Sdrh   sqlite3WalkExpr(&w, pExpr);
49562409f8a1Sdrh   return !w.eCode;
49572409f8a1Sdrh }
49582409f8a1Sdrh 
49592409f8a1Sdrh 
49602409f8a1Sdrh /*
49612409f8a1Sdrh ** An instance of the following structure is used by the tree walker
4962030796dfSdrh ** to count references to table columns in the arguments of an
4963ed551b95Sdrh ** aggregate function, in order to implement the
4964ed551b95Sdrh ** sqlite3FunctionThisSrc() routine.
4965374fdce4Sdrh */
4966030796dfSdrh struct SrcCount {
4967030796dfSdrh   SrcList *pSrc;   /* One particular FROM clause in a nested query */
4968030796dfSdrh   int nThis;       /* Number of references to columns in pSrcList */
4969030796dfSdrh   int nOther;      /* Number of references to columns in other FROM clauses */
4970030796dfSdrh };
4971030796dfSdrh 
4972030796dfSdrh /*
4973030796dfSdrh ** Count the number of references to columns.
4974030796dfSdrh */
4975030796dfSdrh static int exprSrcCount(Walker *pWalker, Expr *pExpr){
4976fb0a6081Sdrh   /* The NEVER() on the second term is because sqlite3FunctionUsesThisSrc()
4977fb0a6081Sdrh   ** is always called before sqlite3ExprAnalyzeAggregates() and so the
4978fb0a6081Sdrh   ** TK_COLUMNs have not yet been converted into TK_AGG_COLUMN.  If
4979fb0a6081Sdrh   ** sqlite3FunctionUsesThisSrc() is used differently in the future, the
4980fb0a6081Sdrh   ** NEVER() will need to be removed. */
4981fb0a6081Sdrh   if( pExpr->op==TK_COLUMN || NEVER(pExpr->op==TK_AGG_COLUMN) ){
4982374fdce4Sdrh     int i;
4983030796dfSdrh     struct SrcCount *p = pWalker->u.pSrcCount;
4984030796dfSdrh     SrcList *pSrc = p->pSrc;
4985655814d2Sdrh     int nSrc = pSrc ? pSrc->nSrc : 0;
4986655814d2Sdrh     for(i=0; i<nSrc; i++){
4987030796dfSdrh       if( pExpr->iTable==pSrc->a[i].iCursor ) break;
4988374fdce4Sdrh     }
4989655814d2Sdrh     if( i<nSrc ){
4990030796dfSdrh       p->nThis++;
4991374fdce4Sdrh     }else{
4992030796dfSdrh       p->nOther++;
4993374fdce4Sdrh     }
4994374fdce4Sdrh   }
4995030796dfSdrh   return WRC_Continue;
4996030796dfSdrh }
4997374fdce4Sdrh 
4998374fdce4Sdrh /*
4999030796dfSdrh ** Determine if any of the arguments to the pExpr Function reference
5000030796dfSdrh ** pSrcList.  Return true if they do.  Also return true if the function
5001030796dfSdrh ** has no arguments or has only constant arguments.  Return false if pExpr
5002030796dfSdrh ** references columns but not columns of tables found in pSrcList.
5003374fdce4Sdrh */
5004030796dfSdrh int sqlite3FunctionUsesThisSrc(Expr *pExpr, SrcList *pSrcList){
5005374fdce4Sdrh   Walker w;
5006030796dfSdrh   struct SrcCount cnt;
5007374fdce4Sdrh   assert( pExpr->op==TK_AGG_FUNCTION );
5008030796dfSdrh   w.xExprCallback = exprSrcCount;
5009979dd1beSdrh   w.xSelectCallback = 0;
5010030796dfSdrh   w.u.pSrcCount = &cnt;
5011030796dfSdrh   cnt.pSrc = pSrcList;
5012030796dfSdrh   cnt.nThis = 0;
5013030796dfSdrh   cnt.nOther = 0;
5014030796dfSdrh   sqlite3WalkExprList(&w, pExpr->x.pList);
5015030796dfSdrh   return cnt.nThis>0 || cnt.nOther==0;
5016374fdce4Sdrh }
5017374fdce4Sdrh 
5018374fdce4Sdrh /*
501913449892Sdrh ** Add a new element to the pAggInfo->aCol[] array.  Return the index of
502013449892Sdrh ** the new element.  Return a negative number if malloc fails.
50212282792aSdrh */
502217435752Sdrh static int addAggInfoColumn(sqlite3 *db, AggInfo *pInfo){
502313449892Sdrh   int i;
5024cf643729Sdrh   pInfo->aCol = sqlite3ArrayAllocate(
502517435752Sdrh        db,
5026cf643729Sdrh        pInfo->aCol,
5027cf643729Sdrh        sizeof(pInfo->aCol[0]),
5028cf643729Sdrh        &pInfo->nColumn,
5029cf643729Sdrh        &i
5030cf643729Sdrh   );
503113449892Sdrh   return i;
50322282792aSdrh }
503313449892Sdrh 
503413449892Sdrh /*
503513449892Sdrh ** Add a new element to the pAggInfo->aFunc[] array.  Return the index of
503613449892Sdrh ** the new element.  Return a negative number if malloc fails.
503713449892Sdrh */
503817435752Sdrh static int addAggInfoFunc(sqlite3 *db, AggInfo *pInfo){
503913449892Sdrh   int i;
5040cf643729Sdrh   pInfo->aFunc = sqlite3ArrayAllocate(
504117435752Sdrh        db,
5042cf643729Sdrh        pInfo->aFunc,
5043cf643729Sdrh        sizeof(pInfo->aFunc[0]),
5044cf643729Sdrh        &pInfo->nFunc,
5045cf643729Sdrh        &i
5046cf643729Sdrh   );
504713449892Sdrh   return i;
50482282792aSdrh }
50492282792aSdrh 
50502282792aSdrh /*
50517d10d5a6Sdrh ** This is the xExprCallback for a tree walker.  It is used to
50527d10d5a6Sdrh ** implement sqlite3ExprAnalyzeAggregates().  See sqlite3ExprAnalyzeAggregates
5053626a879aSdrh ** for additional information.
50542282792aSdrh */
50557d10d5a6Sdrh static int analyzeAggregate(Walker *pWalker, Expr *pExpr){
50562282792aSdrh   int i;
50577d10d5a6Sdrh   NameContext *pNC = pWalker->u.pNC;
5058a58fdfb1Sdanielk1977   Parse *pParse = pNC->pParse;
5059a58fdfb1Sdanielk1977   SrcList *pSrcList = pNC->pSrcList;
506013449892Sdrh   AggInfo *pAggInfo = pNC->pAggInfo;
506113449892Sdrh 
50622282792aSdrh   switch( pExpr->op ){
506389c69d00Sdrh     case TK_AGG_COLUMN:
5064967e8b73Sdrh     case TK_COLUMN: {
50658b213899Sdrh       testcase( pExpr->op==TK_AGG_COLUMN );
50668b213899Sdrh       testcase( pExpr->op==TK_COLUMN );
506713449892Sdrh       /* Check to see if the column is in one of the tables in the FROM
506813449892Sdrh       ** clause of the aggregate query */
506920bc393cSdrh       if( ALWAYS(pSrcList!=0) ){
507013449892Sdrh         struct SrcList_item *pItem = pSrcList->a;
507113449892Sdrh         for(i=0; i<pSrcList->nSrc; i++, pItem++){
507213449892Sdrh           struct AggInfo_col *pCol;
5073c5cd1249Sdrh           assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
507413449892Sdrh           if( pExpr->iTable==pItem->iCursor ){
507513449892Sdrh             /* If we reach this point, it means that pExpr refers to a table
507613449892Sdrh             ** that is in the FROM clause of the aggregate query.
507713449892Sdrh             **
507813449892Sdrh             ** Make an entry for the column in pAggInfo->aCol[] if there
507913449892Sdrh             ** is not an entry there already.
508013449892Sdrh             */
50817f906d63Sdrh             int k;
508213449892Sdrh             pCol = pAggInfo->aCol;
50837f906d63Sdrh             for(k=0; k<pAggInfo->nColumn; k++, pCol++){
508413449892Sdrh               if( pCol->iTable==pExpr->iTable &&
508513449892Sdrh                   pCol->iColumn==pExpr->iColumn ){
50862282792aSdrh                 break;
50872282792aSdrh               }
50882282792aSdrh             }
50891e536953Sdanielk1977             if( (k>=pAggInfo->nColumn)
50901e536953Sdanielk1977              && (k = addAggInfoColumn(pParse->db, pAggInfo))>=0
50911e536953Sdanielk1977             ){
50927f906d63Sdrh               pCol = &pAggInfo->aCol[k];
50930817d0dfSdanielk1977               pCol->pTab = pExpr->pTab;
509413449892Sdrh               pCol->iTable = pExpr->iTable;
509513449892Sdrh               pCol->iColumn = pExpr->iColumn;
50960a07c107Sdrh               pCol->iMem = ++pParse->nMem;
509713449892Sdrh               pCol->iSorterColumn = -1;
50985774b806Sdrh               pCol->pExpr = pExpr;
509913449892Sdrh               if( pAggInfo->pGroupBy ){
510013449892Sdrh                 int j, n;
510113449892Sdrh                 ExprList *pGB = pAggInfo->pGroupBy;
510213449892Sdrh                 struct ExprList_item *pTerm = pGB->a;
510313449892Sdrh                 n = pGB->nExpr;
510413449892Sdrh                 for(j=0; j<n; j++, pTerm++){
510513449892Sdrh                   Expr *pE = pTerm->pExpr;
510613449892Sdrh                   if( pE->op==TK_COLUMN && pE->iTable==pExpr->iTable &&
510713449892Sdrh                       pE->iColumn==pExpr->iColumn ){
510813449892Sdrh                     pCol->iSorterColumn = j;
510913449892Sdrh                     break;
51102282792aSdrh                   }
511113449892Sdrh                 }
511213449892Sdrh               }
511313449892Sdrh               if( pCol->iSorterColumn<0 ){
511413449892Sdrh                 pCol->iSorterColumn = pAggInfo->nSortingColumn++;
511513449892Sdrh               }
511613449892Sdrh             }
511713449892Sdrh             /* There is now an entry for pExpr in pAggInfo->aCol[] (either
511813449892Sdrh             ** because it was there before or because we just created it).
511913449892Sdrh             ** Convert the pExpr to be a TK_AGG_COLUMN referring to that
512013449892Sdrh             ** pAggInfo->aCol[] entry.
512113449892Sdrh             */
5122ebb6a65dSdrh             ExprSetVVAProperty(pExpr, EP_NoReduce);
512313449892Sdrh             pExpr->pAggInfo = pAggInfo;
512413449892Sdrh             pExpr->op = TK_AGG_COLUMN;
5125cf697396Sshane             pExpr->iAgg = (i16)k;
512613449892Sdrh             break;
512713449892Sdrh           } /* endif pExpr->iTable==pItem->iCursor */
512813449892Sdrh         } /* end loop over pSrcList */
5129a58fdfb1Sdanielk1977       }
51307d10d5a6Sdrh       return WRC_Prune;
51312282792aSdrh     }
51322282792aSdrh     case TK_AGG_FUNCTION: {
51333a8c4be7Sdrh       if( (pNC->ncFlags & NC_InAggFunc)==0
5134ed551b95Sdrh        && pWalker->walkerDepth==pExpr->op2
51353a8c4be7Sdrh       ){
513613449892Sdrh         /* Check to see if pExpr is a duplicate of another aggregate
513713449892Sdrh         ** function that is already in the pAggInfo structure
513813449892Sdrh         */
513913449892Sdrh         struct AggInfo_func *pItem = pAggInfo->aFunc;
514013449892Sdrh         for(i=0; i<pAggInfo->nFunc; i++, pItem++){
51415aa550cfSdan           if( sqlite3ExprCompare(0, pItem->pExpr, pExpr, -1)==0 ){
51422282792aSdrh             break;
51432282792aSdrh           }
51442282792aSdrh         }
514513449892Sdrh         if( i>=pAggInfo->nFunc ){
514613449892Sdrh           /* pExpr is original.  Make a new entry in pAggInfo->aFunc[]
514713449892Sdrh           */
514814db2665Sdanielk1977           u8 enc = ENC(pParse->db);
51491e536953Sdanielk1977           i = addAggInfoFunc(pParse->db, pAggInfo);
515013449892Sdrh           if( i>=0 ){
51516ab3a2ecSdanielk1977             assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
515213449892Sdrh             pItem = &pAggInfo->aFunc[i];
515313449892Sdrh             pItem->pExpr = pExpr;
51540a07c107Sdrh             pItem->iMem = ++pParse->nMem;
515533e619fcSdrh             assert( !ExprHasProperty(pExpr, EP_IntValue) );
515613449892Sdrh             pItem->pFunc = sqlite3FindFunction(pParse->db,
515780738d9cSdrh                    pExpr->u.zToken,
51586ab3a2ecSdanielk1977                    pExpr->x.pList ? pExpr->x.pList->nExpr : 0, enc, 0);
5159fd357974Sdrh             if( pExpr->flags & EP_Distinct ){
5160fd357974Sdrh               pItem->iDistinct = pParse->nTab++;
5161fd357974Sdrh             }else{
5162fd357974Sdrh               pItem->iDistinct = -1;
5163fd357974Sdrh             }
51642282792aSdrh           }
516513449892Sdrh         }
516613449892Sdrh         /* Make pExpr point to the appropriate pAggInfo->aFunc[] entry
516713449892Sdrh         */
5168c5cd1249Sdrh         assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
5169ebb6a65dSdrh         ExprSetVVAProperty(pExpr, EP_NoReduce);
5170cf697396Sshane         pExpr->iAgg = (i16)i;
517113449892Sdrh         pExpr->pAggInfo = pAggInfo;
51723a8c4be7Sdrh         return WRC_Prune;
51736e83a57fSdrh       }else{
51746e83a57fSdrh         return WRC_Continue;
51756e83a57fSdrh       }
51762282792aSdrh     }
5177a58fdfb1Sdanielk1977   }
51787d10d5a6Sdrh   return WRC_Continue;
51797d10d5a6Sdrh }
51807d10d5a6Sdrh static int analyzeAggregatesInSelect(Walker *pWalker, Select *pSelect){
5181d5a336efSdrh   UNUSED_PARAMETER(pSelect);
5182979dd1beSdrh   pWalker->walkerDepth++;
51837d10d5a6Sdrh   return WRC_Continue;
5184a58fdfb1Sdanielk1977 }
5185979dd1beSdrh static void analyzeAggregatesInSelectEnd(Walker *pWalker, Select *pSelect){
5186979dd1beSdrh   UNUSED_PARAMETER(pSelect);
5187979dd1beSdrh   pWalker->walkerDepth--;
5188979dd1beSdrh }
5189626a879aSdrh 
5190626a879aSdrh /*
5191e8abb4caSdrh ** Analyze the pExpr expression looking for aggregate functions and
5192e8abb4caSdrh ** for variables that need to be added to AggInfo object that pNC->pAggInfo
5193e8abb4caSdrh ** points to.  Additional entries are made on the AggInfo object as
5194e8abb4caSdrh ** necessary.
5195626a879aSdrh **
5196626a879aSdrh ** This routine should only be called after the expression has been
51977d10d5a6Sdrh ** analyzed by sqlite3ResolveExprNames().
5198626a879aSdrh */
5199d2b3e23bSdrh void sqlite3ExprAnalyzeAggregates(NameContext *pNC, Expr *pExpr){
52007d10d5a6Sdrh   Walker w;
52017d10d5a6Sdrh   w.xExprCallback = analyzeAggregate;
52027d10d5a6Sdrh   w.xSelectCallback = analyzeAggregatesInSelect;
5203979dd1beSdrh   w.xSelectCallback2 = analyzeAggregatesInSelectEnd;
5204979dd1beSdrh   w.walkerDepth = 0;
52057d10d5a6Sdrh   w.u.pNC = pNC;
520620bc393cSdrh   assert( pNC->pSrcList!=0 );
52077d10d5a6Sdrh   sqlite3WalkExpr(&w, pExpr);
52082282792aSdrh }
52095d9a4af9Sdrh 
52105d9a4af9Sdrh /*
52115d9a4af9Sdrh ** Call sqlite3ExprAnalyzeAggregates() for every expression in an
52125d9a4af9Sdrh ** expression list.  Return the number of errors.
52135d9a4af9Sdrh **
52145d9a4af9Sdrh ** If an error is found, the analysis is cut short.
52155d9a4af9Sdrh */
5216d2b3e23bSdrh void sqlite3ExprAnalyzeAggList(NameContext *pNC, ExprList *pList){
52175d9a4af9Sdrh   struct ExprList_item *pItem;
52185d9a4af9Sdrh   int i;
52195d9a4af9Sdrh   if( pList ){
5220d2b3e23bSdrh     for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
5221d2b3e23bSdrh       sqlite3ExprAnalyzeAggregates(pNC, pItem->pExpr);
52225d9a4af9Sdrh     }
52235d9a4af9Sdrh   }
52245d9a4af9Sdrh }
5225892d3179Sdrh 
5226892d3179Sdrh /*
5227ceea3321Sdrh ** Allocate a single new register for use to hold some intermediate result.
5228892d3179Sdrh */
5229892d3179Sdrh int sqlite3GetTempReg(Parse *pParse){
5230e55cbd72Sdrh   if( pParse->nTempReg==0 ){
5231892d3179Sdrh     return ++pParse->nMem;
5232892d3179Sdrh   }
52332f425f6bSdanielk1977   return pParse->aTempReg[--pParse->nTempReg];
5234892d3179Sdrh }
5235ceea3321Sdrh 
5236ceea3321Sdrh /*
5237ceea3321Sdrh ** Deallocate a register, making available for reuse for some other
5238ceea3321Sdrh ** purpose.
5239ceea3321Sdrh **
5240ceea3321Sdrh ** If a register is currently being used by the column cache, then
524160ec914cSpeter.d.reid ** the deallocation is deferred until the column cache line that uses
5242ceea3321Sdrh ** the register becomes stale.
5243ceea3321Sdrh */
5244892d3179Sdrh void sqlite3ReleaseTempReg(Parse *pParse, int iReg){
52452dcef11bSdrh   if( iReg && pParse->nTempReg<ArraySize(pParse->aTempReg) ){
5246ceea3321Sdrh     int i;
5247ceea3321Sdrh     struct yColCache *p;
52489b40d13fSdrh     for(i=0, p=pParse->aColCache; i<pParse->nColCache; i++, p++){
5249ceea3321Sdrh       if( p->iReg==iReg ){
5250ceea3321Sdrh         p->tempReg = 1;
5251ceea3321Sdrh         return;
5252ceea3321Sdrh       }
5253ceea3321Sdrh     }
5254892d3179Sdrh     pParse->aTempReg[pParse->nTempReg++] = iReg;
5255892d3179Sdrh   }
5256892d3179Sdrh }
5257892d3179Sdrh 
5258892d3179Sdrh /*
5259ed24da4bSdrh ** Allocate or deallocate a block of nReg consecutive registers.
5260892d3179Sdrh */
5261892d3179Sdrh int sqlite3GetTempRange(Parse *pParse, int nReg){
5262e55cbd72Sdrh   int i, n;
5263ed24da4bSdrh   if( nReg==1 ) return sqlite3GetTempReg(pParse);
5264892d3179Sdrh   i = pParse->iRangeReg;
5265e55cbd72Sdrh   n = pParse->nRangeReg;
5266f49f3523Sdrh   if( nReg<=n ){
5267f49f3523Sdrh     assert( !usedAsColumnCache(pParse, i, i+n-1) );
5268892d3179Sdrh     pParse->iRangeReg += nReg;
5269892d3179Sdrh     pParse->nRangeReg -= nReg;
5270892d3179Sdrh   }else{
5271892d3179Sdrh     i = pParse->nMem+1;
5272892d3179Sdrh     pParse->nMem += nReg;
5273892d3179Sdrh   }
5274892d3179Sdrh   return i;
5275892d3179Sdrh }
5276892d3179Sdrh void sqlite3ReleaseTempRange(Parse *pParse, int iReg, int nReg){
5277ed24da4bSdrh   if( nReg==1 ){
5278ed24da4bSdrh     sqlite3ReleaseTempReg(pParse, iReg);
5279ed24da4bSdrh     return;
5280ed24da4bSdrh   }
5281f49f3523Sdrh   sqlite3ExprCacheRemove(pParse, iReg, nReg);
5282892d3179Sdrh   if( nReg>pParse->nRangeReg ){
5283892d3179Sdrh     pParse->nRangeReg = nReg;
5284892d3179Sdrh     pParse->iRangeReg = iReg;
5285892d3179Sdrh   }
5286892d3179Sdrh }
5287cdc69557Sdrh 
5288cdc69557Sdrh /*
5289cdc69557Sdrh ** Mark all temporary registers as being unavailable for reuse.
5290cdc69557Sdrh */
5291cdc69557Sdrh void sqlite3ClearTempRegCache(Parse *pParse){
5292cdc69557Sdrh   pParse->nTempReg = 0;
5293cdc69557Sdrh   pParse->nRangeReg = 0;
5294cdc69557Sdrh }
5295bb9b5f26Sdrh 
5296bb9b5f26Sdrh /*
5297bb9b5f26Sdrh ** Validate that no temporary register falls within the range of
5298bb9b5f26Sdrh ** iFirst..iLast, inclusive.  This routine is only call from within assert()
5299bb9b5f26Sdrh ** statements.
5300bb9b5f26Sdrh */
5301bb9b5f26Sdrh #ifdef SQLITE_DEBUG
5302bb9b5f26Sdrh int sqlite3NoTempsInRange(Parse *pParse, int iFirst, int iLast){
5303bb9b5f26Sdrh   int i;
5304bb9b5f26Sdrh   if( pParse->nRangeReg>0
53053963e584Sdrh    && pParse->iRangeReg+pParse->nRangeReg > iFirst
53063963e584Sdrh    && pParse->iRangeReg <= iLast
5307bb9b5f26Sdrh   ){
5308bb9b5f26Sdrh      return 0;
5309bb9b5f26Sdrh   }
5310bb9b5f26Sdrh   for(i=0; i<pParse->nTempReg; i++){
5311bb9b5f26Sdrh     if( pParse->aTempReg[i]>=iFirst && pParse->aTempReg[i]<=iLast ){
5312bb9b5f26Sdrh       return 0;
5313bb9b5f26Sdrh     }
5314bb9b5f26Sdrh   }
5315bb9b5f26Sdrh   return 1;
5316bb9b5f26Sdrh }
5317bb9b5f26Sdrh #endif /* SQLITE_DEBUG */
5318