xref: /sqlite-3.40.0/src/expr.c (revision eda079cd)
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
61*eda079cdSdrh   if( (op==TK_AGG_COLUMN || op==TK_COLUMN) && pExpr->y.pTab ){
62*eda079cdSdrh     return sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
637d10d5a6Sdrh   }
6480aa5453Sdan   if( op==TK_SELECT_COLUMN ){
6580aa5453Sdan     assert( pExpr->pLeft->flags&EP_xIsSelect );
6680aa5453Sdan     return sqlite3ExprAffinity(
6780aa5453Sdan         pExpr->pLeft->x.pSelect->pEList->a[pExpr->iColumn].pExpr
6880aa5453Sdan     );
6980aa5453Sdan   }
70a37cdde0Sdanielk1977   return pExpr->affinity;
71a37cdde0Sdanielk1977 }
72a37cdde0Sdanielk1977 
7353db1458Sdrh /*
748b4c40d8Sdrh ** Set the collating sequence for expression pExpr to be the collating
75ae80ddeaSdrh ** sequence named by pToken.   Return a pointer to a new Expr node that
76ae80ddeaSdrh ** implements the COLLATE operator.
770a8a406eSdrh **
780a8a406eSdrh ** If a memory allocation error occurs, that fact is recorded in pParse->db
790a8a406eSdrh ** and the pExpr parameter is returned unchanged.
808b4c40d8Sdrh */
814ef7efadSdrh Expr *sqlite3ExprAddCollateToken(
824ef7efadSdrh   Parse *pParse,           /* Parsing context */
834ef7efadSdrh   Expr *pExpr,             /* Add the "COLLATE" clause to this expression */
8480103fc6Sdan   const Token *pCollName,  /* Name of collating sequence */
8580103fc6Sdan   int dequote              /* True to dequote pCollName */
864ef7efadSdrh ){
870a8a406eSdrh   if( pCollName->n>0 ){
8880103fc6Sdan     Expr *pNew = sqlite3ExprAlloc(pParse->db, TK_COLLATE, pCollName, dequote);
89ae80ddeaSdrh     if( pNew ){
90ae80ddeaSdrh       pNew->pLeft = pExpr;
91a4c3c87eSdrh       pNew->flags |= EP_Collate|EP_Skip;
920a8a406eSdrh       pExpr = pNew;
93ae80ddeaSdrh     }
940a8a406eSdrh   }
950a8a406eSdrh   return pExpr;
960a8a406eSdrh }
970a8a406eSdrh Expr *sqlite3ExprAddCollateString(Parse *pParse, Expr *pExpr, const char *zC){
980a8a406eSdrh   Token s;
99261d8a51Sdrh   assert( zC!=0 );
10040aced5cSdrh   sqlite3TokenInit(&s, (char*)zC);
10180103fc6Sdan   return sqlite3ExprAddCollateToken(pParse, pExpr, &s, 0);
1020a8a406eSdrh }
1030a8a406eSdrh 
1040a8a406eSdrh /*
1050b8d255cSdrh ** Skip over any TK_COLLATE operators and any unlikely()
106a4c3c87eSdrh ** or likelihood() function at the root of an expression.
1070a8a406eSdrh */
1080a8a406eSdrh Expr *sqlite3ExprSkipCollate(Expr *pExpr){
109a4c3c87eSdrh   while( pExpr && ExprHasProperty(pExpr, EP_Skip) ){
110a4c3c87eSdrh     if( ExprHasProperty(pExpr, EP_Unlikely) ){
111cca9f3d2Sdrh       assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
112cca9f3d2Sdrh       assert( pExpr->x.pList->nExpr>0 );
113a4c3c87eSdrh       assert( pExpr->op==TK_FUNCTION );
114cca9f3d2Sdrh       pExpr = pExpr->x.pList->a[0].pExpr;
115cca9f3d2Sdrh     }else{
1160b8d255cSdrh       assert( pExpr->op==TK_COLLATE );
117d91eba96Sdrh       pExpr = pExpr->pLeft;
118cca9f3d2Sdrh     }
119d91eba96Sdrh   }
1200a8a406eSdrh   return pExpr;
1218b4c40d8Sdrh }
1228b4c40d8Sdrh 
1238b4c40d8Sdrh /*
124ae80ddeaSdrh ** Return the collation sequence for the expression pExpr. If
125ae80ddeaSdrh ** there is no defined collating sequence, return NULL.
126ae80ddeaSdrh **
12770efa84dSdrh ** See also: sqlite3ExprNNCollSeq()
12870efa84dSdrh **
12970efa84dSdrh ** The sqlite3ExprNNCollSeq() works the same exact that it returns the
13070efa84dSdrh ** default collation if pExpr has no defined collation.
13170efa84dSdrh **
132ae80ddeaSdrh ** The collating sequence might be determined by a COLLATE operator
133ae80ddeaSdrh ** or by the presence of a column with a defined collating sequence.
134ae80ddeaSdrh ** COLLATE operators take first precedence.  Left operands take
135ae80ddeaSdrh ** precedence over right operands.
1360202b29eSdanielk1977 */
1377cedc8d4Sdanielk1977 CollSeq *sqlite3ExprCollSeq(Parse *pParse, Expr *pExpr){
138ae80ddeaSdrh   sqlite3 *db = pParse->db;
1397cedc8d4Sdanielk1977   CollSeq *pColl = 0;
1407d10d5a6Sdrh   Expr *p = pExpr;
141261d8a51Sdrh   while( p ){
142ae80ddeaSdrh     int op = p->op;
143fbb24d10Sdrh     if( p->flags & EP_Generic ) break;
144a58d4a96Sdrh     if( (op==TK_AGG_COLUMN || op==TK_COLUMN
145ae80ddeaSdrh           || op==TK_REGISTER || op==TK_TRIGGER)
146*eda079cdSdrh      && p->y.pTab!=0
147ae80ddeaSdrh     ){
148*eda079cdSdrh       /* op==TK_REGISTER && p->y.pTab!=0 happens when pExpr was originally
1497d10d5a6Sdrh       ** a TK_COLUMN but was previously evaluated and cached in a register */
1507d10d5a6Sdrh       int j = p->iColumn;
1517d10d5a6Sdrh       if( j>=0 ){
152*eda079cdSdrh         const char *zColl = p->y.pTab->aCol[j].zColl;
153c4a64facSdrh         pColl = sqlite3FindCollSeq(db, ENC(db), zColl, 0);
1540202b29eSdanielk1977       }
1557d10d5a6Sdrh       break;
1567d10d5a6Sdrh     }
157e081d73cSdrh     if( op==TK_CAST || op==TK_UPLUS ){
158e081d73cSdrh       p = p->pLeft;
159e081d73cSdrh       continue;
160e081d73cSdrh     }
161e081d73cSdrh     if( op==TK_COLLATE || (op==TK_REGISTER && p->op2==TK_COLLATE) ){
162e081d73cSdrh       pColl = sqlite3GetCollSeq(pParse, ENC(db), 0, p->u.zToken);
163e081d73cSdrh       break;
164e081d73cSdrh     }
165ae80ddeaSdrh     if( p->flags & EP_Collate ){
1662308ed38Sdrh       if( p->pLeft && (p->pLeft->flags & EP_Collate)!=0 ){
1677d10d5a6Sdrh         p = p->pLeft;
168ae80ddeaSdrh       }else{
1692308ed38Sdrh         Expr *pNext  = p->pRight;
1706728cd91Sdrh         /* The Expr.x union is never used at the same time as Expr.pRight */
1716728cd91Sdrh         assert( p->x.pList==0 || p->pRight==0 );
1726728cd91Sdrh         /* p->flags holds EP_Collate and p->pLeft->flags does not.  And
1736728cd91Sdrh         ** p->x.pSelect cannot.  So if p->x.pLeft exists, it must hold at
1746728cd91Sdrh         ** least one EP_Collate. Thus the following two ALWAYS. */
1756728cd91Sdrh         if( p->x.pList!=0 && ALWAYS(!ExprHasProperty(p, EP_xIsSelect)) ){
1762308ed38Sdrh           int i;
1776728cd91Sdrh           for(i=0; ALWAYS(i<p->x.pList->nExpr); i++){
1782308ed38Sdrh             if( ExprHasProperty(p->x.pList->a[i].pExpr, EP_Collate) ){
1792308ed38Sdrh               pNext = p->x.pList->a[i].pExpr;
1802308ed38Sdrh               break;
1812308ed38Sdrh             }
1822308ed38Sdrh           }
1832308ed38Sdrh         }
1842308ed38Sdrh         p = pNext;
185ae80ddeaSdrh       }
186ae80ddeaSdrh     }else{
187ae80ddeaSdrh       break;
188ae80ddeaSdrh     }
1890202b29eSdanielk1977   }
1907cedc8d4Sdanielk1977   if( sqlite3CheckCollSeq(pParse, pColl) ){
1917cedc8d4Sdanielk1977     pColl = 0;
1927cedc8d4Sdanielk1977   }
1937cedc8d4Sdanielk1977   return pColl;
1940202b29eSdanielk1977 }
1950202b29eSdanielk1977 
1960202b29eSdanielk1977 /*
19770efa84dSdrh ** Return the collation sequence for the expression pExpr. If
19870efa84dSdrh ** there is no defined collating sequence, return a pointer to the
19970efa84dSdrh ** defautl collation sequence.
20070efa84dSdrh **
20170efa84dSdrh ** See also: sqlite3ExprCollSeq()
20270efa84dSdrh **
20370efa84dSdrh ** The sqlite3ExprCollSeq() routine works the same except that it
20470efa84dSdrh ** returns NULL if there is no defined collation.
20570efa84dSdrh */
20670efa84dSdrh CollSeq *sqlite3ExprNNCollSeq(Parse *pParse, Expr *pExpr){
20770efa84dSdrh   CollSeq *p = sqlite3ExprCollSeq(pParse, pExpr);
20870efa84dSdrh   if( p==0 ) p = pParse->db->pDfltColl;
20970efa84dSdrh   assert( p!=0 );
21070efa84dSdrh   return p;
21170efa84dSdrh }
21270efa84dSdrh 
21370efa84dSdrh /*
21470efa84dSdrh ** Return TRUE if the two expressions have equivalent collating sequences.
21570efa84dSdrh */
21670efa84dSdrh int sqlite3ExprCollSeqMatch(Parse *pParse, Expr *pE1, Expr *pE2){
21770efa84dSdrh   CollSeq *pColl1 = sqlite3ExprNNCollSeq(pParse, pE1);
21870efa84dSdrh   CollSeq *pColl2 = sqlite3ExprNNCollSeq(pParse, pE2);
21970efa84dSdrh   return sqlite3StrICmp(pColl1->zName, pColl2->zName)==0;
22070efa84dSdrh }
22170efa84dSdrh 
22270efa84dSdrh /*
223626a879aSdrh ** pExpr is an operand of a comparison operator.  aff2 is the
224626a879aSdrh ** type affinity of the other operand.  This routine returns the
22553db1458Sdrh ** type affinity that should be used for the comparison operator.
22653db1458Sdrh */
227e014a838Sdanielk1977 char sqlite3CompareAffinity(Expr *pExpr, char aff2){
228bf3b721fSdanielk1977   char aff1 = sqlite3ExprAffinity(pExpr);
229e014a838Sdanielk1977   if( aff1 && aff2 ){
2308df447f0Sdrh     /* Both sides of the comparison are columns. If one has numeric
2318df447f0Sdrh     ** affinity, use that. Otherwise use no affinity.
232e014a838Sdanielk1977     */
2338a51256cSdrh     if( sqlite3IsNumericAffinity(aff1) || sqlite3IsNumericAffinity(aff2) ){
234e014a838Sdanielk1977       return SQLITE_AFF_NUMERIC;
235e014a838Sdanielk1977     }else{
23605883a34Sdrh       return SQLITE_AFF_BLOB;
237e014a838Sdanielk1977     }
238e014a838Sdanielk1977   }else if( !aff1 && !aff2 ){
2395f6a87b3Sdrh     /* Neither side of the comparison is a column.  Compare the
2405f6a87b3Sdrh     ** results directly.
241e014a838Sdanielk1977     */
24205883a34Sdrh     return SQLITE_AFF_BLOB;
243e014a838Sdanielk1977   }else{
244e014a838Sdanielk1977     /* One side is a column, the other is not. Use the columns affinity. */
245fe05af87Sdrh     assert( aff1==0 || aff2==0 );
246e014a838Sdanielk1977     return (aff1 + aff2);
247e014a838Sdanielk1977   }
248e014a838Sdanielk1977 }
249e014a838Sdanielk1977 
25053db1458Sdrh /*
25153db1458Sdrh ** pExpr is a comparison operator.  Return the type affinity that should
25253db1458Sdrh ** be applied to both operands prior to doing the comparison.
25353db1458Sdrh */
254e014a838Sdanielk1977 static char comparisonAffinity(Expr *pExpr){
255e014a838Sdanielk1977   char aff;
256e014a838Sdanielk1977   assert( pExpr->op==TK_EQ || pExpr->op==TK_IN || pExpr->op==TK_LT ||
257e014a838Sdanielk1977           pExpr->op==TK_GT || pExpr->op==TK_GE || pExpr->op==TK_LE ||
2586a2fe093Sdrh           pExpr->op==TK_NE || pExpr->op==TK_IS || pExpr->op==TK_ISNOT );
259e014a838Sdanielk1977   assert( pExpr->pLeft );
260bf3b721fSdanielk1977   aff = sqlite3ExprAffinity(pExpr->pLeft);
261e014a838Sdanielk1977   if( pExpr->pRight ){
262e014a838Sdanielk1977     aff = sqlite3CompareAffinity(pExpr->pRight, aff);
2636ab3a2ecSdanielk1977   }else if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2646ab3a2ecSdanielk1977     aff = sqlite3CompareAffinity(pExpr->x.pSelect->pEList->a[0].pExpr, aff);
26513ac46eeSdrh   }else if( aff==0 ){
26605883a34Sdrh     aff = SQLITE_AFF_BLOB;
267e014a838Sdanielk1977   }
268e014a838Sdanielk1977   return aff;
269e014a838Sdanielk1977 }
270e014a838Sdanielk1977 
271e014a838Sdanielk1977 /*
272e014a838Sdanielk1977 ** pExpr is a comparison expression, eg. '=', '<', IN(...) etc.
273e014a838Sdanielk1977 ** idx_affinity is the affinity of an indexed column. Return true
274e014a838Sdanielk1977 ** if the index with affinity idx_affinity may be used to implement
275e014a838Sdanielk1977 ** the comparison in pExpr.
276e014a838Sdanielk1977 */
277e014a838Sdanielk1977 int sqlite3IndexAffinityOk(Expr *pExpr, char idx_affinity){
278e014a838Sdanielk1977   char aff = comparisonAffinity(pExpr);
2798a51256cSdrh   switch( aff ){
28005883a34Sdrh     case SQLITE_AFF_BLOB:
2818a51256cSdrh       return 1;
2828a51256cSdrh     case SQLITE_AFF_TEXT:
2838a51256cSdrh       return idx_affinity==SQLITE_AFF_TEXT;
2848a51256cSdrh     default:
2858a51256cSdrh       return sqlite3IsNumericAffinity(idx_affinity);
2868a51256cSdrh   }
287e014a838Sdanielk1977 }
288e014a838Sdanielk1977 
289a37cdde0Sdanielk1977 /*
29035573356Sdrh ** Return the P5 value that should be used for a binary comparison
291a37cdde0Sdanielk1977 ** opcode (OP_Eq, OP_Ge etc.) used to compare pExpr1 and pExpr2.
292a37cdde0Sdanielk1977 */
29335573356Sdrh static u8 binaryCompareP5(Expr *pExpr1, Expr *pExpr2, int jumpIfNull){
29435573356Sdrh   u8 aff = (char)sqlite3ExprAffinity(pExpr2);
2951bd10f8aSdrh   aff = (u8)sqlite3CompareAffinity(pExpr1, aff) | (u8)jumpIfNull;
29635573356Sdrh   return aff;
297a37cdde0Sdanielk1977 }
298a37cdde0Sdanielk1977 
299a2e00042Sdrh /*
3000202b29eSdanielk1977 ** Return a pointer to the collation sequence that should be used by
3010202b29eSdanielk1977 ** a binary comparison operator comparing pLeft and pRight.
3020202b29eSdanielk1977 **
3030202b29eSdanielk1977 ** If the left hand expression has a collating sequence type, then it is
3040202b29eSdanielk1977 ** used. Otherwise the collation sequence for the right hand expression
3050202b29eSdanielk1977 ** is used, or the default (BINARY) if neither expression has a collating
3060202b29eSdanielk1977 ** type.
307bcbb04e5Sdanielk1977 **
308bcbb04e5Sdanielk1977 ** Argument pRight (but not pLeft) may be a null pointer. In this case,
309bcbb04e5Sdanielk1977 ** it is not considered.
3100202b29eSdanielk1977 */
311bcbb04e5Sdanielk1977 CollSeq *sqlite3BinaryCompareCollSeq(
312bcbb04e5Sdanielk1977   Parse *pParse,
313bcbb04e5Sdanielk1977   Expr *pLeft,
314bcbb04e5Sdanielk1977   Expr *pRight
315bcbb04e5Sdanielk1977 ){
316ec41ddacSdrh   CollSeq *pColl;
317ec41ddacSdrh   assert( pLeft );
318ae80ddeaSdrh   if( pLeft->flags & EP_Collate ){
319ae80ddeaSdrh     pColl = sqlite3ExprCollSeq(pParse, pLeft);
320ae80ddeaSdrh   }else if( pRight && (pRight->flags & EP_Collate)!=0 ){
321ae80ddeaSdrh     pColl = sqlite3ExprCollSeq(pParse, pRight);
322ec41ddacSdrh   }else{
323ec41ddacSdrh     pColl = sqlite3ExprCollSeq(pParse, pLeft);
3240202b29eSdanielk1977     if( !pColl ){
3257cedc8d4Sdanielk1977       pColl = sqlite3ExprCollSeq(pParse, pRight);
3260202b29eSdanielk1977     }
327ec41ddacSdrh   }
3280202b29eSdanielk1977   return pColl;
3290202b29eSdanielk1977 }
3300202b29eSdanielk1977 
3310202b29eSdanielk1977 /*
332be5c89acSdrh ** Generate code for a comparison operator.
333be5c89acSdrh */
334be5c89acSdrh static int codeCompare(
335be5c89acSdrh   Parse *pParse,    /* The parsing (and code generating) context */
336be5c89acSdrh   Expr *pLeft,      /* The left operand */
337be5c89acSdrh   Expr *pRight,     /* The right operand */
338be5c89acSdrh   int opcode,       /* The comparison opcode */
33935573356Sdrh   int in1, int in2, /* Register holding operands */
340be5c89acSdrh   int dest,         /* Jump here if true.  */
341be5c89acSdrh   int jumpIfNull    /* If true, jump if either operand is NULL */
342be5c89acSdrh ){
34335573356Sdrh   int p5;
34435573356Sdrh   int addr;
34535573356Sdrh   CollSeq *p4;
34635573356Sdrh 
34735573356Sdrh   p4 = sqlite3BinaryCompareCollSeq(pParse, pLeft, pRight);
34835573356Sdrh   p5 = binaryCompareP5(pLeft, pRight, jumpIfNull);
34935573356Sdrh   addr = sqlite3VdbeAddOp4(pParse->pVdbe, opcode, in2, dest, in1,
35035573356Sdrh                            (void*)p4, P4_COLLSEQ);
3511bd10f8aSdrh   sqlite3VdbeChangeP5(pParse->pVdbe, (u8)p5);
35235573356Sdrh   return addr;
353be5c89acSdrh }
354be5c89acSdrh 
355cfbb5e82Sdan /*
356870a0705Sdan ** Return true if expression pExpr is a vector, or false otherwise.
357d832da7fSdrh **
358d832da7fSdrh ** A vector is defined as any expression that results in two or more
359d832da7fSdrh ** columns of result.  Every TK_VECTOR node is an vector because the
360d832da7fSdrh ** parser will not generate a TK_VECTOR with fewer than two entries.
361d832da7fSdrh ** But a TK_SELECT might be either a vector or a scalar. It is only
362d832da7fSdrh ** considered a vector if it has two or more result columns.
363870a0705Sdan */
364870a0705Sdan int sqlite3ExprIsVector(Expr *pExpr){
36576dbe7a8Sdrh   return sqlite3ExprVectorSize(pExpr)>1;
366870a0705Sdan }
367870a0705Sdan 
368870a0705Sdan /*
369cfbb5e82Sdan ** If the expression passed as the only argument is of type TK_VECTOR
370cfbb5e82Sdan ** return the number of expressions in the vector. Or, if the expression
371cfbb5e82Sdan ** is a sub-select, return the number of columns in the sub-select. For
372cfbb5e82Sdan ** any other type of expression, return 1.
373cfbb5e82Sdan */
37471c57db0Sdan int sqlite3ExprVectorSize(Expr *pExpr){
37512abf408Sdrh   u8 op = pExpr->op;
37612abf408Sdrh   if( op==TK_REGISTER ) op = pExpr->op2;
37712abf408Sdrh   if( op==TK_VECTOR ){
37871c57db0Sdan     return pExpr->x.pList->nExpr;
37912abf408Sdrh   }else if( op==TK_SELECT ){
38076dbe7a8Sdrh     return pExpr->x.pSelect->pEList->nExpr;
38176dbe7a8Sdrh   }else{
38276dbe7a8Sdrh     return 1;
38376dbe7a8Sdrh   }
38471c57db0Sdan }
38571c57db0Sdan 
386ba00e30aSdan /*
387fc7f27b9Sdrh ** Return a pointer to a subexpression of pVector that is the i-th
388fc7f27b9Sdrh ** column of the vector (numbered starting with 0).  The caller must
389fc7f27b9Sdrh ** ensure that i is within range.
390fc7f27b9Sdrh **
39176dbe7a8Sdrh ** If pVector is really a scalar (and "scalar" here includes subqueries
39276dbe7a8Sdrh ** that return a single column!) then return pVector unmodified.
39376dbe7a8Sdrh **
394fc7f27b9Sdrh ** pVector retains ownership of the returned subexpression.
395fc7f27b9Sdrh **
396fc7f27b9Sdrh ** If the vector is a (SELECT ...) then the expression returned is
39776dbe7a8Sdrh ** just the expression for the i-th term of the result set, and may
39876dbe7a8Sdrh ** not be ready for evaluation because the table cursor has not yet
39976dbe7a8Sdrh ** been positioned.
400ba00e30aSdan */
401fc7f27b9Sdrh Expr *sqlite3VectorFieldSubexpr(Expr *pVector, int i){
402870a0705Sdan   assert( i<sqlite3ExprVectorSize(pVector) );
403870a0705Sdan   if( sqlite3ExprIsVector(pVector) ){
4049f24b53dSdrh     assert( pVector->op2==0 || pVector->op==TK_REGISTER );
4059f24b53dSdrh     if( pVector->op==TK_SELECT || pVector->op2==TK_SELECT ){
40671c57db0Sdan       return pVector->x.pSelect->pEList->a[i].pExpr;
407870a0705Sdan     }else{
40871c57db0Sdan       return pVector->x.pList->a[i].pExpr;
40971c57db0Sdan     }
410870a0705Sdan   }
411870a0705Sdan   return pVector;
412870a0705Sdan }
413fc7f27b9Sdrh 
414fc7f27b9Sdrh /*
415fc7f27b9Sdrh ** Compute and return a new Expr object which when passed to
416fc7f27b9Sdrh ** sqlite3ExprCode() will generate all necessary code to compute
417fc7f27b9Sdrh ** the iField-th column of the vector expression pVector.
418fc7f27b9Sdrh **
4198762ec19Sdrh ** It is ok for pVector to be a scalar (as long as iField==0).
4208762ec19Sdrh ** In that case, this routine works like sqlite3ExprDup().
4218762ec19Sdrh **
422fc7f27b9Sdrh ** The caller owns the returned Expr object and is responsible for
423fc7f27b9Sdrh ** ensuring that the returned value eventually gets freed.
424fc7f27b9Sdrh **
4258762ec19Sdrh ** The caller retains ownership of pVector.  If pVector is a TK_SELECT,
426fad0e70cSdan ** then the returned object will reference pVector and so pVector must remain
4278762ec19Sdrh ** valid for the life of the returned object.  If pVector is a TK_VECTOR
4288762ec19Sdrh ** or a scalar expression, then it can be deleted as soon as this routine
42976dbe7a8Sdrh ** returns.
4308762ec19Sdrh **
4318762ec19Sdrh ** A trick to cause a TK_SELECT pVector to be deleted together with
4328762ec19Sdrh ** the returned Expr object is to attach the pVector to the pRight field
4338762ec19Sdrh ** of the returned TK_SELECT_COLUMN Expr object.
434fc7f27b9Sdrh */
435fc7f27b9Sdrh Expr *sqlite3ExprForVectorField(
436fc7f27b9Sdrh   Parse *pParse,       /* Parsing context */
437fc7f27b9Sdrh   Expr *pVector,       /* The vector.  List of expressions or a sub-SELECT */
438a1251bc4Sdrh   int iField           /* Which column of the vector to return */
439fc7f27b9Sdrh ){
440fc7f27b9Sdrh   Expr *pRet;
441a1251bc4Sdrh   if( pVector->op==TK_SELECT ){
442a1251bc4Sdrh     assert( pVector->flags & EP_xIsSelect );
443fc7f27b9Sdrh     /* The TK_SELECT_COLUMN Expr node:
444fc7f27b9Sdrh     **
445966e2911Sdrh     ** pLeft:           pVector containing TK_SELECT.  Not deleted.
4468762ec19Sdrh     ** pRight:          not used.  But recursively deleted.
447fc7f27b9Sdrh     ** iColumn:         Index of a column in pVector
448966e2911Sdrh     ** iTable:          0 or the number of columns on the LHS of an assignment
449fc7f27b9Sdrh     ** pLeft->iTable:   First in an array of register holding result, or 0
450fc7f27b9Sdrh     **                  if the result is not yet computed.
451fc7f27b9Sdrh     **
452fc7f27b9Sdrh     ** sqlite3ExprDelete() specifically skips the recursive delete of
453fc7f27b9Sdrh     ** pLeft on TK_SELECT_COLUMN nodes.  But pRight is followed, so pVector
4548762ec19Sdrh     ** can be attached to pRight to cause this node to take ownership of
4558762ec19Sdrh     ** pVector.  Typically there will be multiple TK_SELECT_COLUMN nodes
4568762ec19Sdrh     ** with the same pLeft pointer to the pVector, but only one of them
4578762ec19Sdrh     ** will own the pVector.
458fc7f27b9Sdrh     */
459abfd35eaSdrh     pRet = sqlite3PExpr(pParse, TK_SELECT_COLUMN, 0, 0);
4608bd0d58eSdrh     if( pRet ){
4618bd0d58eSdrh       pRet->iColumn = iField;
4628bd0d58eSdrh       pRet->pLeft = pVector;
4638bd0d58eSdrh     }
464fc7f27b9Sdrh     assert( pRet==0 || pRet->iTable==0 );
465fc7f27b9Sdrh   }else{
466a1251bc4Sdrh     if( pVector->op==TK_VECTOR ) pVector = pVector->x.pList->a[iField].pExpr;
467a1251bc4Sdrh     pRet = sqlite3ExprDup(pParse->db, pVector, 0);
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 );
5845c288b92Sdan     r1 = exprVectorRegister(pParse, pLeft, i, regLeft, &pL, &regFree1);
5855c288b92Sdan     r2 = exprVectorRegister(pParse, pRight, i, regRight, &pR, &regFree2);
58679752b6eSdrh     codeCompare(pParse, pL, pR, opx, r1, r2, dest, p5);
58779752b6eSdrh     testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
58879752b6eSdrh     testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
58979752b6eSdrh     testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
59079752b6eSdrh     testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
59179752b6eSdrh     testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
59279752b6eSdrh     testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
59371c57db0Sdan     sqlite3ReleaseTempReg(pParse, regFree1);
59471c57db0Sdan     sqlite3ReleaseTempReg(pParse, regFree2);
59579752b6eSdrh     if( i==nLeft-1 ){
59679752b6eSdrh       break;
59771c57db0Sdan     }
59879752b6eSdrh     if( opx==TK_EQ ){
59979752b6eSdrh       sqlite3VdbeAddOp2(v, OP_IfNot, dest, addrDone); VdbeCoverage(v);
60079752b6eSdrh       p5 |= SQLITE_KEEPNULL;
60179752b6eSdrh     }else if( opx==TK_NE ){
60279752b6eSdrh       sqlite3VdbeAddOp2(v, OP_If, dest, addrDone); VdbeCoverage(v);
60379752b6eSdrh       p5 |= SQLITE_KEEPNULL;
604a2f62925Sdrh     }else{
605a2f62925Sdrh       assert( op==TK_LT || op==TK_GT || op==TK_LE || op==TK_GE );
606a2f62925Sdrh       sqlite3VdbeAddOp2(v, OP_ElseNotEq, 0, addrDone);
60779752b6eSdrh       VdbeCoverageIf(v, op==TK_LT);
60879752b6eSdrh       VdbeCoverageIf(v, op==TK_GT);
60979752b6eSdrh       VdbeCoverageIf(v, op==TK_LE);
61079752b6eSdrh       VdbeCoverageIf(v, op==TK_GE);
61179752b6eSdrh       if( i==nLeft-2 ) opx = op;
61271c57db0Sdan     }
61379752b6eSdrh   }
61479752b6eSdrh   sqlite3VdbeResolveLabel(v, addrDone);
61579752b6eSdrh }
61671c57db0Sdan 
6174b5255acSdanielk1977 #if SQLITE_MAX_EXPR_DEPTH>0
6184b5255acSdanielk1977 /*
6194b5255acSdanielk1977 ** Check that argument nHeight is less than or equal to the maximum
6204b5255acSdanielk1977 ** expression depth allowed. If it is not, leave an error message in
6214b5255acSdanielk1977 ** pParse.
6224b5255acSdanielk1977 */
6237d10d5a6Sdrh int sqlite3ExprCheckHeight(Parse *pParse, int nHeight){
6244b5255acSdanielk1977   int rc = SQLITE_OK;
6254b5255acSdanielk1977   int mxHeight = pParse->db->aLimit[SQLITE_LIMIT_EXPR_DEPTH];
6264b5255acSdanielk1977   if( nHeight>mxHeight ){
6274b5255acSdanielk1977     sqlite3ErrorMsg(pParse,
6284b5255acSdanielk1977        "Expression tree is too large (maximum depth %d)", mxHeight
6294b5255acSdanielk1977     );
6304b5255acSdanielk1977     rc = SQLITE_ERROR;
6314b5255acSdanielk1977   }
6324b5255acSdanielk1977   return rc;
6334b5255acSdanielk1977 }
6344b5255acSdanielk1977 
6354b5255acSdanielk1977 /* The following three functions, heightOfExpr(), heightOfExprList()
6364b5255acSdanielk1977 ** and heightOfSelect(), are used to determine the maximum height
6374b5255acSdanielk1977 ** of any expression tree referenced by the structure passed as the
6384b5255acSdanielk1977 ** first argument.
6394b5255acSdanielk1977 **
6404b5255acSdanielk1977 ** If this maximum height is greater than the current value pointed
6414b5255acSdanielk1977 ** to by pnHeight, the second parameter, then set *pnHeight to that
6424b5255acSdanielk1977 ** value.
6434b5255acSdanielk1977 */
6444b5255acSdanielk1977 static void heightOfExpr(Expr *p, int *pnHeight){
6454b5255acSdanielk1977   if( p ){
6464b5255acSdanielk1977     if( p->nHeight>*pnHeight ){
6474b5255acSdanielk1977       *pnHeight = p->nHeight;
6484b5255acSdanielk1977     }
6494b5255acSdanielk1977   }
6504b5255acSdanielk1977 }
6514b5255acSdanielk1977 static void heightOfExprList(ExprList *p, int *pnHeight){
6524b5255acSdanielk1977   if( p ){
6534b5255acSdanielk1977     int i;
6544b5255acSdanielk1977     for(i=0; i<p->nExpr; i++){
6554b5255acSdanielk1977       heightOfExpr(p->a[i].pExpr, pnHeight);
6564b5255acSdanielk1977     }
6574b5255acSdanielk1977   }
6584b5255acSdanielk1977 }
6591a3a3086Sdan static void heightOfSelect(Select *pSelect, int *pnHeight){
6601a3a3086Sdan   Select *p;
6611a3a3086Sdan   for(p=pSelect; p; p=p->pPrior){
6624b5255acSdanielk1977     heightOfExpr(p->pWhere, pnHeight);
6634b5255acSdanielk1977     heightOfExpr(p->pHaving, pnHeight);
6644b5255acSdanielk1977     heightOfExpr(p->pLimit, pnHeight);
6654b5255acSdanielk1977     heightOfExprList(p->pEList, pnHeight);
6664b5255acSdanielk1977     heightOfExprList(p->pGroupBy, pnHeight);
6674b5255acSdanielk1977     heightOfExprList(p->pOrderBy, pnHeight);
6684b5255acSdanielk1977   }
6694b5255acSdanielk1977 }
6704b5255acSdanielk1977 
6714b5255acSdanielk1977 /*
6724b5255acSdanielk1977 ** Set the Expr.nHeight variable in the structure passed as an
6734b5255acSdanielk1977 ** argument. An expression with no children, Expr.pList or
6744b5255acSdanielk1977 ** Expr.pSelect member has a height of 1. Any other expression
6754b5255acSdanielk1977 ** has a height equal to the maximum height of any other
6764b5255acSdanielk1977 ** referenced Expr plus one.
6772308ed38Sdrh **
6782308ed38Sdrh ** Also propagate EP_Propagate flags up from Expr.x.pList to Expr.flags,
6792308ed38Sdrh ** if appropriate.
6804b5255acSdanielk1977 */
6814b5255acSdanielk1977 static void exprSetHeight(Expr *p){
6824b5255acSdanielk1977   int nHeight = 0;
6834b5255acSdanielk1977   heightOfExpr(p->pLeft, &nHeight);
6844b5255acSdanielk1977   heightOfExpr(p->pRight, &nHeight);
6856ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_xIsSelect) ){
6866ab3a2ecSdanielk1977     heightOfSelect(p->x.pSelect, &nHeight);
6872308ed38Sdrh   }else if( p->x.pList ){
6886ab3a2ecSdanielk1977     heightOfExprList(p->x.pList, &nHeight);
6892308ed38Sdrh     p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
6906ab3a2ecSdanielk1977   }
6914b5255acSdanielk1977   p->nHeight = nHeight + 1;
6924b5255acSdanielk1977 }
6934b5255acSdanielk1977 
6944b5255acSdanielk1977 /*
6954b5255acSdanielk1977 ** Set the Expr.nHeight variable using the exprSetHeight() function. If
6964b5255acSdanielk1977 ** the height is greater than the maximum allowed expression depth,
6974b5255acSdanielk1977 ** leave an error in pParse.
6982308ed38Sdrh **
6992308ed38Sdrh ** Also propagate all EP_Propagate flags from the Expr.x.pList into
7002308ed38Sdrh ** Expr.flags.
7014b5255acSdanielk1977 */
7022308ed38Sdrh void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
70374893a4cSdrh   if( pParse->nErr ) return;
7044b5255acSdanielk1977   exprSetHeight(p);
7057d10d5a6Sdrh   sqlite3ExprCheckHeight(pParse, p->nHeight);
7064b5255acSdanielk1977 }
7074b5255acSdanielk1977 
7084b5255acSdanielk1977 /*
7094b5255acSdanielk1977 ** Return the maximum height of any expression tree referenced
7104b5255acSdanielk1977 ** by the select statement passed as an argument.
7114b5255acSdanielk1977 */
7124b5255acSdanielk1977 int sqlite3SelectExprHeight(Select *p){
7134b5255acSdanielk1977   int nHeight = 0;
7144b5255acSdanielk1977   heightOfSelect(p, &nHeight);
7154b5255acSdanielk1977   return nHeight;
7164b5255acSdanielk1977 }
7172308ed38Sdrh #else /* ABOVE:  Height enforcement enabled.  BELOW: Height enforcement off */
7182308ed38Sdrh /*
7192308ed38Sdrh ** Propagate all EP_Propagate flags from the Expr.x.pList into
7202308ed38Sdrh ** Expr.flags.
7212308ed38Sdrh */
7222308ed38Sdrh void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
7232308ed38Sdrh   if( p && p->x.pList && !ExprHasProperty(p, EP_xIsSelect) ){
7242308ed38Sdrh     p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
7252308ed38Sdrh   }
7262308ed38Sdrh }
7274b5255acSdanielk1977 #define exprSetHeight(y)
7284b5255acSdanielk1977 #endif /* SQLITE_MAX_EXPR_DEPTH>0 */
7294b5255acSdanielk1977 
730be5c89acSdrh /*
731b7916a78Sdrh ** This routine is the core allocator for Expr nodes.
732b7916a78Sdrh **
733a76b5dfcSdrh ** Construct a new expression node and return a pointer to it.  Memory
734b7916a78Sdrh ** for this node and for the pToken argument is a single allocation
735b7916a78Sdrh ** obtained from sqlite3DbMalloc().  The calling function
736a76b5dfcSdrh ** is responsible for making sure the node eventually gets freed.
737b7916a78Sdrh **
738b7916a78Sdrh ** If dequote is true, then the token (if it exists) is dequoted.
739e792b5b4Sdrh ** If dequote is false, no dequoting is performed.  The deQuote
740b7916a78Sdrh ** parameter is ignored if pToken is NULL or if the token does not
741b7916a78Sdrh ** appear to be quoted.  If the quotes were of the form "..." (double-quotes)
742b7916a78Sdrh ** then the EP_DblQuoted flag is set on the expression node.
74333e619fcSdrh **
74433e619fcSdrh ** Special case:  If op==TK_INTEGER and pToken points to a string that
74533e619fcSdrh ** can be translated into a 32-bit integer, then the token is not
74633e619fcSdrh ** stored in u.zToken.  Instead, the integer values is written
74733e619fcSdrh ** into u.iValue and the EP_IntValue flag is set.  No extra storage
74833e619fcSdrh ** is allocated to hold the integer text and the dequote flag is ignored.
749a76b5dfcSdrh */
750b7916a78Sdrh Expr *sqlite3ExprAlloc(
751cca8a4adSdrh   sqlite3 *db,            /* Handle for sqlite3DbMallocRawNN() */
75217435752Sdrh   int op,                 /* Expression opcode */
753b7916a78Sdrh   const Token *pToken,    /* Token argument.  Might be NULL */
754b7916a78Sdrh   int dequote             /* True to dequote */
75517435752Sdrh ){
756a76b5dfcSdrh   Expr *pNew;
75733e619fcSdrh   int nExtra = 0;
758cf697396Sshane   int iValue = 0;
759b7916a78Sdrh 
760575fad65Sdrh   assert( db!=0 );
761b7916a78Sdrh   if( pToken ){
76233e619fcSdrh     if( op!=TK_INTEGER || pToken->z==0
76333e619fcSdrh           || sqlite3GetInt32(pToken->z, &iValue)==0 ){
764b7916a78Sdrh       nExtra = pToken->n+1;
765d50ffc41Sdrh       assert( iValue>=0 );
76633e619fcSdrh     }
767a76b5dfcSdrh   }
768575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, sizeof(Expr)+nExtra);
769b7916a78Sdrh   if( pNew ){
770ca3862dcSdrh     memset(pNew, 0, sizeof(Expr));
7711bd10f8aSdrh     pNew->op = (u8)op;
772a58fdfb1Sdanielk1977     pNew->iAgg = -1;
773a76b5dfcSdrh     if( pToken ){
77433e619fcSdrh       if( nExtra==0 ){
775b98a2e35Sdrh         pNew->flags |= EP_IntValue|EP_Leaf;
77633e619fcSdrh         pNew->u.iValue = iValue;
77733e619fcSdrh       }else{
77833e619fcSdrh         pNew->u.zToken = (char*)&pNew[1];
779b07028f7Sdrh         assert( pToken->z!=0 || pToken->n==0 );
780b07028f7Sdrh         if( pToken->n ) memcpy(pNew->u.zToken, pToken->z, pToken->n);
78133e619fcSdrh         pNew->u.zToken[pToken->n] = 0;
782244b9d6eSdrh         if( dequote && sqlite3Isquote(pNew->u.zToken[0]) ){
783244b9d6eSdrh           if( pNew->u.zToken[0]=='"' ) pNew->flags |= EP_DblQuoted;
78433e619fcSdrh           sqlite3Dequote(pNew->u.zToken);
785a34001c9Sdrh         }
786a34001c9Sdrh       }
78733e619fcSdrh     }
788b7916a78Sdrh #if SQLITE_MAX_EXPR_DEPTH>0
789b7916a78Sdrh     pNew->nHeight = 1;
790b7916a78Sdrh #endif
791a34001c9Sdrh   }
792a76b5dfcSdrh   return pNew;
793a76b5dfcSdrh }
794a76b5dfcSdrh 
795a76b5dfcSdrh /*
796b7916a78Sdrh ** Allocate a new expression node from a zero-terminated token that has
797b7916a78Sdrh ** already been dequoted.
798b7916a78Sdrh */
799b7916a78Sdrh Expr *sqlite3Expr(
800b7916a78Sdrh   sqlite3 *db,            /* Handle for sqlite3DbMallocZero() (may be null) */
801b7916a78Sdrh   int op,                 /* Expression opcode */
802b7916a78Sdrh   const char *zToken      /* Token argument.  Might be NULL */
803b7916a78Sdrh ){
804b7916a78Sdrh   Token x;
805b7916a78Sdrh   x.z = zToken;
806b40f06c6Sdrh   x.n = sqlite3Strlen30(zToken);
807b7916a78Sdrh   return sqlite3ExprAlloc(db, op, &x, 0);
808b7916a78Sdrh }
809b7916a78Sdrh 
810b7916a78Sdrh /*
811b7916a78Sdrh ** Attach subtrees pLeft and pRight to the Expr node pRoot.
812b7916a78Sdrh **
813b7916a78Sdrh ** If pRoot==NULL that means that a memory allocation error has occurred.
814b7916a78Sdrh ** In that case, delete the subtrees pLeft and pRight.
815b7916a78Sdrh */
816b7916a78Sdrh void sqlite3ExprAttachSubtrees(
817b7916a78Sdrh   sqlite3 *db,
818b7916a78Sdrh   Expr *pRoot,
819b7916a78Sdrh   Expr *pLeft,
820b7916a78Sdrh   Expr *pRight
821b7916a78Sdrh ){
822b7916a78Sdrh   if( pRoot==0 ){
823b7916a78Sdrh     assert( db->mallocFailed );
824b7916a78Sdrh     sqlite3ExprDelete(db, pLeft);
825b7916a78Sdrh     sqlite3ExprDelete(db, pRight);
826b7916a78Sdrh   }else{
827b7916a78Sdrh     if( pRight ){
828b7916a78Sdrh       pRoot->pRight = pRight;
829885a5b03Sdrh       pRoot->flags |= EP_Propagate & pRight->flags;
830b7916a78Sdrh     }
831b7916a78Sdrh     if( pLeft ){
832b7916a78Sdrh       pRoot->pLeft = pLeft;
833885a5b03Sdrh       pRoot->flags |= EP_Propagate & pLeft->flags;
834b7916a78Sdrh     }
835b7916a78Sdrh     exprSetHeight(pRoot);
836b7916a78Sdrh   }
837b7916a78Sdrh }
838b7916a78Sdrh 
839b7916a78Sdrh /*
84060ec914cSpeter.d.reid ** Allocate an Expr node which joins as many as two subtrees.
841b7916a78Sdrh **
842bf664469Sdrh ** One or both of the subtrees can be NULL.  Return a pointer to the new
843bf664469Sdrh ** Expr node.  Or, if an OOM error occurs, set pParse->db->mallocFailed,
844bf664469Sdrh ** free the subtrees and return NULL.
845206f3d96Sdrh */
84617435752Sdrh Expr *sqlite3PExpr(
84717435752Sdrh   Parse *pParse,          /* Parsing context */
84817435752Sdrh   int op,                 /* Expression opcode */
84917435752Sdrh   Expr *pLeft,            /* Left operand */
850abfd35eaSdrh   Expr *pRight            /* Right operand */
85117435752Sdrh ){
8525fb52caaSdrh   Expr *p;
8531167d327Sdrh   if( op==TK_AND && pParse->nErr==0 ){
8545fb52caaSdrh     /* Take advantage of short-circuit false optimization for AND */
8555fb52caaSdrh     p = sqlite3ExprAnd(pParse->db, pLeft, pRight);
8565fb52caaSdrh   }else{
857abfd35eaSdrh     p = sqlite3DbMallocRawNN(pParse->db, sizeof(Expr));
858abfd35eaSdrh     if( p ){
859abfd35eaSdrh       memset(p, 0, sizeof(Expr));
860abfd35eaSdrh       p->op = op & TKFLG_MASK;
861abfd35eaSdrh       p->iAgg = -1;
862abfd35eaSdrh     }
863b7916a78Sdrh     sqlite3ExprAttachSubtrees(pParse->db, p, pLeft, pRight);
8645fb52caaSdrh   }
8652b359bdbSdan   if( p ) {
8662b359bdbSdan     sqlite3ExprCheckHeight(pParse, p->nHeight);
8672b359bdbSdan   }
8684e0cff60Sdrh   return p;
8694e0cff60Sdrh }
8704e0cff60Sdrh 
8714e0cff60Sdrh /*
87208de4f79Sdrh ** Add pSelect to the Expr.x.pSelect field.  Or, if pExpr is NULL (due
87308de4f79Sdrh ** do a memory allocation failure) then delete the pSelect object.
87408de4f79Sdrh */
87508de4f79Sdrh void sqlite3PExprAddSelect(Parse *pParse, Expr *pExpr, Select *pSelect){
87608de4f79Sdrh   if( pExpr ){
87708de4f79Sdrh     pExpr->x.pSelect = pSelect;
87808de4f79Sdrh     ExprSetProperty(pExpr, EP_xIsSelect|EP_Subquery);
87908de4f79Sdrh     sqlite3ExprSetHeightAndFlags(pParse, pExpr);
88008de4f79Sdrh   }else{
88108de4f79Sdrh     assert( pParse->db->mallocFailed );
88208de4f79Sdrh     sqlite3SelectDelete(pParse->db, pSelect);
88308de4f79Sdrh   }
88408de4f79Sdrh }
88508de4f79Sdrh 
88608de4f79Sdrh 
88708de4f79Sdrh /*
888991a1985Sdrh ** If the expression is always either TRUE or FALSE (respectively),
889991a1985Sdrh ** then return 1.  If one cannot determine the truth value of the
890991a1985Sdrh ** expression at compile-time return 0.
891991a1985Sdrh **
892991a1985Sdrh ** This is an optimization.  If is OK to return 0 here even if
893991a1985Sdrh ** the expression really is always false or false (a false negative).
894991a1985Sdrh ** But it is a bug to return 1 if the expression might have different
895991a1985Sdrh ** boolean values in different circumstances (a false positive.)
8965fb52caaSdrh **
8975fb52caaSdrh ** Note that if the expression is part of conditional for a
8985fb52caaSdrh ** LEFT JOIN, then we cannot determine at compile-time whether or not
8995fb52caaSdrh ** is it true or false, so always return 0.
9005fb52caaSdrh */
901991a1985Sdrh static int exprAlwaysTrue(Expr *p){
902991a1985Sdrh   int v = 0;
903991a1985Sdrh   if( ExprHasProperty(p, EP_FromJoin) ) return 0;
904991a1985Sdrh   if( !sqlite3ExprIsInteger(p, &v) ) return 0;
905991a1985Sdrh   return v!=0;
906991a1985Sdrh }
9075fb52caaSdrh static int exprAlwaysFalse(Expr *p){
9085fb52caaSdrh   int v = 0;
9095fb52caaSdrh   if( ExprHasProperty(p, EP_FromJoin) ) return 0;
9105fb52caaSdrh   if( !sqlite3ExprIsInteger(p, &v) ) return 0;
9115fb52caaSdrh   return v==0;
9125fb52caaSdrh }
9135fb52caaSdrh 
9145fb52caaSdrh /*
91591bb0eedSdrh ** Join two expressions using an AND operator.  If either expression is
91691bb0eedSdrh ** NULL, then just return the other expression.
9175fb52caaSdrh **
9185fb52caaSdrh ** If one side or the other of the AND is known to be false, then instead
9195fb52caaSdrh ** of returning an AND expression, just return a constant expression with
9205fb52caaSdrh ** a value of false.
92191bb0eedSdrh */
9221e536953Sdanielk1977 Expr *sqlite3ExprAnd(sqlite3 *db, Expr *pLeft, Expr *pRight){
92391bb0eedSdrh   if( pLeft==0 ){
92491bb0eedSdrh     return pRight;
92591bb0eedSdrh   }else if( pRight==0 ){
92691bb0eedSdrh     return pLeft;
9275fb52caaSdrh   }else if( exprAlwaysFalse(pLeft) || exprAlwaysFalse(pRight) ){
9285fb52caaSdrh     sqlite3ExprDelete(db, pLeft);
9295fb52caaSdrh     sqlite3ExprDelete(db, pRight);
9305fb52caaSdrh     return sqlite3ExprAlloc(db, TK_INTEGER, &sqlite3IntTokens[0], 0);
93191bb0eedSdrh   }else{
932b7916a78Sdrh     Expr *pNew = sqlite3ExprAlloc(db, TK_AND, 0, 0);
933b7916a78Sdrh     sqlite3ExprAttachSubtrees(db, pNew, pLeft, pRight);
934b7916a78Sdrh     return pNew;
935a76b5dfcSdrh   }
936a76b5dfcSdrh }
937a76b5dfcSdrh 
938a76b5dfcSdrh /*
939a76b5dfcSdrh ** Construct a new expression node for a function with multiple
940a76b5dfcSdrh ** arguments.
941a76b5dfcSdrh */
942954733b3Sdrh Expr *sqlite3ExprFunction(
943954733b3Sdrh   Parse *pParse,        /* Parsing context */
944954733b3Sdrh   ExprList *pList,      /* Argument list */
945954733b3Sdrh   Token *pToken,        /* Name of the function */
946954733b3Sdrh   int eDistinct         /* SF_Distinct or SF_ALL or 0 */
947954733b3Sdrh ){
948a76b5dfcSdrh   Expr *pNew;
949633e6d57Sdrh   sqlite3 *db = pParse->db;
9504b202ae2Sdanielk1977   assert( pToken );
951b7916a78Sdrh   pNew = sqlite3ExprAlloc(db, TK_FUNCTION, pToken, 1);
952a76b5dfcSdrh   if( pNew==0 ){
953d9da78a2Sdrh     sqlite3ExprListDelete(db, pList); /* Avoid memory leak when malloc fails */
954a76b5dfcSdrh     return 0;
955a76b5dfcSdrh   }
956954733b3Sdrh   if( pList && pList->nExpr > pParse->db->aLimit[SQLITE_LIMIT_FUNCTION_ARG] ){
957954733b3Sdrh     sqlite3ErrorMsg(pParse, "too many arguments on function %T", pToken);
958954733b3Sdrh   }
9596ab3a2ecSdanielk1977   pNew->x.pList = pList;
960fca23557Sdrh   ExprSetProperty(pNew, EP_HasFunc);
9616ab3a2ecSdanielk1977   assert( !ExprHasProperty(pNew, EP_xIsSelect) );
9622308ed38Sdrh   sqlite3ExprSetHeightAndFlags(pParse, pNew);
963954733b3Sdrh   if( eDistinct==SF_Distinct ) ExprSetProperty(pNew, EP_Distinct);
964a76b5dfcSdrh   return pNew;
965a76b5dfcSdrh }
966a76b5dfcSdrh 
967a76b5dfcSdrh /*
968fa6bc000Sdrh ** Assign a variable number to an expression that encodes a wildcard
969fa6bc000Sdrh ** in the original SQL statement.
970fa6bc000Sdrh **
971fa6bc000Sdrh ** Wildcards consisting of a single "?" are assigned the next sequential
972fa6bc000Sdrh ** variable number.
973fa6bc000Sdrh **
974fa6bc000Sdrh ** Wildcards of the form "?nnn" are assigned the number "nnn".  We make
9759bf755ccSdrh ** sure "nnn" is not too big to avoid a denial of service attack when
976fa6bc000Sdrh ** the SQL statement comes from an external source.
977fa6bc000Sdrh **
97851f49f17Sdrh ** Wildcards of the form ":aaa", "@aaa", or "$aaa" are assigned the same number
979fa6bc000Sdrh ** as the previous instance of the same wildcard.  Or if this is the first
98060ec914cSpeter.d.reid ** instance of the wildcard, the next sequential variable number is
981fa6bc000Sdrh ** assigned.
982fa6bc000Sdrh */
983de25a88cSdrh void sqlite3ExprAssignVarNumber(Parse *pParse, Expr *pExpr, u32 n){
98417435752Sdrh   sqlite3 *db = pParse->db;
985b7916a78Sdrh   const char *z;
986f326d66dSdrh   ynVar x;
98717435752Sdrh 
988fa6bc000Sdrh   if( pExpr==0 ) return;
989c5cd1249Sdrh   assert( !ExprHasProperty(pExpr, EP_IntValue|EP_Reduced|EP_TokenOnly) );
99033e619fcSdrh   z = pExpr->u.zToken;
991b7916a78Sdrh   assert( z!=0 );
992b7916a78Sdrh   assert( z[0]!=0 );
993b1ed717fSmistachkin   assert( n==(u32)sqlite3Strlen30(z) );
994b7916a78Sdrh   if( z[1]==0 ){
995fa6bc000Sdrh     /* Wildcard of the form "?".  Assign the next variable number */
996b7916a78Sdrh     assert( z[0]=='?' );
997f326d66dSdrh     x = (ynVar)(++pParse->nVar);
998124c0b49Sdrh   }else{
999f326d66dSdrh     int doAdd = 0;
1000124c0b49Sdrh     if( z[0]=='?' ){
1001fa6bc000Sdrh       /* Wildcard of the form "?nnn".  Convert "nnn" to an integer and
1002fa6bc000Sdrh       ** use it as the variable number */
1003c8d735aeSdan       i64 i;
100418814dfbSdrh       int bOk;
100518814dfbSdrh       if( n==2 ){ /*OPTIMIZATION-IF-TRUE*/
100618814dfbSdrh         i = z[1]-'0';  /* The common case of ?N for a single digit N */
100718814dfbSdrh         bOk = 1;
100818814dfbSdrh       }else{
100918814dfbSdrh         bOk = 0==sqlite3Atoi64(&z[1], &i, n-1, SQLITE_UTF8);
101018814dfbSdrh       }
1011c5499befSdrh       testcase( i==0 );
1012c5499befSdrh       testcase( i==1 );
1013c5499befSdrh       testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]-1 );
1014c5499befSdrh       testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] );
1015c8d735aeSdan       if( bOk==0 || i<1 || i>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
1016fa6bc000Sdrh         sqlite3ErrorMsg(pParse, "variable number must be between ?1 and ?%d",
1017bb4957f8Sdrh             db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]);
1018c9b39288Sdrh         return;
1019fa6bc000Sdrh       }
10208e74e7baSdrh       x = (ynVar)i;
1021f326d66dSdrh       if( x>pParse->nVar ){
1022f326d66dSdrh         pParse->nVar = (int)x;
1023f326d66dSdrh         doAdd = 1;
1024f326d66dSdrh       }else if( sqlite3VListNumToName(pParse->pVList, x)==0 ){
1025f326d66dSdrh         doAdd = 1;
1026fa6bc000Sdrh       }
1027fa6bc000Sdrh     }else{
102851f49f17Sdrh       /* Wildcards like ":aaa", "$aaa" or "@aaa".  Reuse the same variable
1029fa6bc000Sdrh       ** number as the prior appearance of the same name, or if the name
1030fa6bc000Sdrh       ** has never appeared before, reuse the same variable number
1031fa6bc000Sdrh       */
10329bf755ccSdrh       x = (ynVar)sqlite3VListNameToNum(pParse->pVList, z, n);
10339bf755ccSdrh       if( x==0 ){
10349bf755ccSdrh         x = (ynVar)(++pParse->nVar);
1035f326d66dSdrh         doAdd = 1;
1036f326d66dSdrh       }
1037f326d66dSdrh     }
1038f326d66dSdrh     if( doAdd ){
10399bf755ccSdrh       pParse->pVList = sqlite3VListAdd(db, pParse->pVList, z, n, x);
1040fa6bc000Sdrh     }
1041fa6bc000Sdrh   }
1042c9b39288Sdrh   pExpr->iColumn = x;
1043f326d66dSdrh   if( x>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
1044832b2664Sdanielk1977     sqlite3ErrorMsg(pParse, "too many SQL variables");
1045832b2664Sdanielk1977   }
1046fa6bc000Sdrh }
1047fa6bc000Sdrh 
1048fa6bc000Sdrh /*
1049f6963f99Sdan ** Recursively delete an expression tree.
1050a2e00042Sdrh */
10514f0010b1Sdrh static SQLITE_NOINLINE void sqlite3ExprDeleteNN(sqlite3 *db, Expr *p){
10524f0010b1Sdrh   assert( p!=0 );
1053d50ffc41Sdrh   /* Sanity check: Assert that the IntValue is non-negative if it exists */
1054d50ffc41Sdrh   assert( !ExprHasProperty(p, EP_IntValue) || p->u.iValue>=0 );
1055*eda079cdSdrh 
1056*eda079cdSdrh   assert( !ExprHasProperty(p, EP_WinFunc) || p->y.pWin!=0 || db->mallocFailed );
1057*eda079cdSdrh   assert( p->op!=TK_FUNCTION || ExprHasProperty(p, EP_TokenOnly|EP_Reduced)
1058*eda079cdSdrh           || p->y.pWin==0 || ExprHasProperty(p, EP_WinFunc) );
1059209bc522Sdrh #ifdef SQLITE_DEBUG
1060209bc522Sdrh   if( ExprHasProperty(p, EP_Leaf) && !ExprHasProperty(p, EP_TokenOnly) ){
1061209bc522Sdrh     assert( p->pLeft==0 );
1062209bc522Sdrh     assert( p->pRight==0 );
1063209bc522Sdrh     assert( p->x.pSelect==0 );
1064209bc522Sdrh   }
1065209bc522Sdrh #endif
1066209bc522Sdrh   if( !ExprHasProperty(p, (EP_TokenOnly|EP_Leaf)) ){
1067c5cd1249Sdrh     /* The Expr.x union is never used at the same time as Expr.pRight */
1068c5cd1249Sdrh     assert( p->x.pList==0 || p->pRight==0 );
10694910a76dSdrh     if( p->pLeft && p->op!=TK_SELECT_COLUMN ) sqlite3ExprDeleteNN(db, p->pLeft);
1070d1086679Sdrh     if( p->pRight ){
1071d1086679Sdrh       sqlite3ExprDeleteNN(db, p->pRight);
1072d1086679Sdrh     }else if( ExprHasProperty(p, EP_xIsSelect) ){
10736ab3a2ecSdanielk1977       sqlite3SelectDelete(db, p->x.pSelect);
10746ab3a2ecSdanielk1977     }else{
10756ab3a2ecSdanielk1977       sqlite3ExprListDelete(db, p->x.pList);
10766ab3a2ecSdanielk1977     }
1077*eda079cdSdrh     if( ExprHasProperty(p, EP_WinFunc) ){
1078*eda079cdSdrh       assert( p->op==TK_FUNCTION );
1079*eda079cdSdrh       sqlite3WindowDelete(db, p->y.pWin);
108086fb6e17Sdan     }
10816ab3a2ecSdanielk1977   }
1082209bc522Sdrh   if( ExprHasProperty(p, EP_MemToken) ) sqlite3DbFree(db, p->u.zToken);
108333e619fcSdrh   if( !ExprHasProperty(p, EP_Static) ){
1084dbd6a7dcSdrh     sqlite3DbFreeNN(db, p);
1085a2e00042Sdrh   }
108633e619fcSdrh }
10874f0010b1Sdrh void sqlite3ExprDelete(sqlite3 *db, Expr *p){
10884f0010b1Sdrh   if( p ) sqlite3ExprDeleteNN(db, p);
10894f0010b1Sdrh }
1090a2e00042Sdrh 
1091d2687b77Sdrh /*
10926ab3a2ecSdanielk1977 ** Return the number of bytes allocated for the expression structure
10936ab3a2ecSdanielk1977 ** passed as the first argument. This is always one of EXPR_FULLSIZE,
10946ab3a2ecSdanielk1977 ** EXPR_REDUCEDSIZE or EXPR_TOKENONLYSIZE.
10956ab3a2ecSdanielk1977 */
10966ab3a2ecSdanielk1977 static int exprStructSize(Expr *p){
10976ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_TokenOnly) ) return EXPR_TOKENONLYSIZE;
10986ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_Reduced) ) return EXPR_REDUCEDSIZE;
10996ab3a2ecSdanielk1977   return EXPR_FULLSIZE;
11006ab3a2ecSdanielk1977 }
11016ab3a2ecSdanielk1977 
11026ab3a2ecSdanielk1977 /*
110333e619fcSdrh ** The dupedExpr*Size() routines each return the number of bytes required
110433e619fcSdrh ** to store a copy of an expression or expression tree.  They differ in
110533e619fcSdrh ** how much of the tree is measured.
110633e619fcSdrh **
110733e619fcSdrh **     dupedExprStructSize()     Size of only the Expr structure
110833e619fcSdrh **     dupedExprNodeSize()       Size of Expr + space for token
110933e619fcSdrh **     dupedExprSize()           Expr + token + subtree components
111033e619fcSdrh **
111133e619fcSdrh ***************************************************************************
111233e619fcSdrh **
111333e619fcSdrh ** The dupedExprStructSize() function returns two values OR-ed together:
111433e619fcSdrh ** (1) the space required for a copy of the Expr structure only and
111533e619fcSdrh ** (2) the EP_xxx flags that indicate what the structure size should be.
111633e619fcSdrh ** The return values is always one of:
111733e619fcSdrh **
111833e619fcSdrh **      EXPR_FULLSIZE
111933e619fcSdrh **      EXPR_REDUCEDSIZE   | EP_Reduced
112033e619fcSdrh **      EXPR_TOKENONLYSIZE | EP_TokenOnly
112133e619fcSdrh **
112233e619fcSdrh ** The size of the structure can be found by masking the return value
112333e619fcSdrh ** of this routine with 0xfff.  The flags can be found by masking the
112433e619fcSdrh ** return value with EP_Reduced|EP_TokenOnly.
112533e619fcSdrh **
112633e619fcSdrh ** Note that with flags==EXPRDUP_REDUCE, this routines works on full-size
112733e619fcSdrh ** (unreduced) Expr objects as they or originally constructed by the parser.
112833e619fcSdrh ** During expression analysis, extra information is computed and moved into
1129c95f38d4Sdan ** later parts of the Expr object and that extra information might get chopped
113033e619fcSdrh ** off if the expression is reduced.  Note also that it does not work to
113160ec914cSpeter.d.reid ** make an EXPRDUP_REDUCE copy of a reduced expression.  It is only legal
113233e619fcSdrh ** to reduce a pristine expression tree from the parser.  The implementation
113333e619fcSdrh ** of dupedExprStructSize() contain multiple assert() statements that attempt
113433e619fcSdrh ** to enforce this constraint.
11356ab3a2ecSdanielk1977 */
11366ab3a2ecSdanielk1977 static int dupedExprStructSize(Expr *p, int flags){
11376ab3a2ecSdanielk1977   int nSize;
113833e619fcSdrh   assert( flags==EXPRDUP_REDUCE || flags==0 ); /* Only one flag value allowed */
1139aecd8021Sdrh   assert( EXPR_FULLSIZE<=0xfff );
1140aecd8021Sdrh   assert( (0xfff & (EP_Reduced|EP_TokenOnly))==0 );
114167a9b8edSdan   if( 0==flags || p->op==TK_SELECT_COLUMN
114267a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
1143*eda079cdSdrh    || ExprHasProperty(p, EP_WinFunc)
114467a9b8edSdan #endif
114567a9b8edSdan   ){
11466ab3a2ecSdanielk1977     nSize = EXPR_FULLSIZE;
11476ab3a2ecSdanielk1977   }else{
1148c5cd1249Sdrh     assert( !ExprHasProperty(p, EP_TokenOnly|EP_Reduced) );
114933e619fcSdrh     assert( !ExprHasProperty(p, EP_FromJoin) );
1150c5cd1249Sdrh     assert( !ExprHasProperty(p, EP_MemToken) );
1151ebb6a65dSdrh     assert( !ExprHasProperty(p, EP_NoReduce) );
1152aecd8021Sdrh     if( p->pLeft || p->x.pList ){
115333e619fcSdrh       nSize = EXPR_REDUCEDSIZE | EP_Reduced;
115433e619fcSdrh     }else{
1155aecd8021Sdrh       assert( p->pRight==0 );
115633e619fcSdrh       nSize = EXPR_TOKENONLYSIZE | EP_TokenOnly;
115733e619fcSdrh     }
11586ab3a2ecSdanielk1977   }
11596ab3a2ecSdanielk1977   return nSize;
11606ab3a2ecSdanielk1977 }
11616ab3a2ecSdanielk1977 
11626ab3a2ecSdanielk1977 /*
116333e619fcSdrh ** This function returns the space in bytes required to store the copy
116433e619fcSdrh ** of the Expr structure and a copy of the Expr.u.zToken string (if that
116533e619fcSdrh ** string is defined.)
11666ab3a2ecSdanielk1977 */
11676ab3a2ecSdanielk1977 static int dupedExprNodeSize(Expr *p, int flags){
116833e619fcSdrh   int nByte = dupedExprStructSize(p, flags) & 0xfff;
116933e619fcSdrh   if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
117033e619fcSdrh     nByte += sqlite3Strlen30(p->u.zToken)+1;
11716ab3a2ecSdanielk1977   }
1172bc73971dSdanielk1977   return ROUND8(nByte);
11736ab3a2ecSdanielk1977 }
11746ab3a2ecSdanielk1977 
11756ab3a2ecSdanielk1977 /*
11766ab3a2ecSdanielk1977 ** Return the number of bytes required to create a duplicate of the
11776ab3a2ecSdanielk1977 ** expression passed as the first argument. The second argument is a
11786ab3a2ecSdanielk1977 ** mask containing EXPRDUP_XXX flags.
11796ab3a2ecSdanielk1977 **
11806ab3a2ecSdanielk1977 ** The value returned includes space to create a copy of the Expr struct
118133e619fcSdrh ** itself and the buffer referred to by Expr.u.zToken, if any.
11826ab3a2ecSdanielk1977 **
11836ab3a2ecSdanielk1977 ** If the EXPRDUP_REDUCE flag is set, then the return value includes
11846ab3a2ecSdanielk1977 ** space to duplicate all Expr nodes in the tree formed by Expr.pLeft
11856ab3a2ecSdanielk1977 ** and Expr.pRight variables (but not for any structures pointed to or
11866ab3a2ecSdanielk1977 ** descended from the Expr.x.pList or Expr.x.pSelect variables).
11876ab3a2ecSdanielk1977 */
11886ab3a2ecSdanielk1977 static int dupedExprSize(Expr *p, int flags){
11896ab3a2ecSdanielk1977   int nByte = 0;
11906ab3a2ecSdanielk1977   if( p ){
11916ab3a2ecSdanielk1977     nByte = dupedExprNodeSize(p, flags);
11926ab3a2ecSdanielk1977     if( flags&EXPRDUP_REDUCE ){
1193b7916a78Sdrh       nByte += dupedExprSize(p->pLeft, flags) + dupedExprSize(p->pRight, flags);
11946ab3a2ecSdanielk1977     }
11956ab3a2ecSdanielk1977   }
11966ab3a2ecSdanielk1977   return nByte;
11976ab3a2ecSdanielk1977 }
11986ab3a2ecSdanielk1977 
11996ab3a2ecSdanielk1977 /*
12006ab3a2ecSdanielk1977 ** This function is similar to sqlite3ExprDup(), except that if pzBuffer
12016ab3a2ecSdanielk1977 ** is not NULL then *pzBuffer is assumed to point to a buffer large enough
120233e619fcSdrh ** to store the copy of expression p, the copies of p->u.zToken
12036ab3a2ecSdanielk1977 ** (if applicable), and the copies of the p->pLeft and p->pRight expressions,
120460ec914cSpeter.d.reid ** if any. Before returning, *pzBuffer is set to the first byte past the
12056ab3a2ecSdanielk1977 ** portion of the buffer copied into by this function.
12066ab3a2ecSdanielk1977 */
12073c19469cSdrh static Expr *exprDup(sqlite3 *db, Expr *p, int dupFlags, u8 **pzBuffer){
12083c19469cSdrh   Expr *pNew;           /* Value to return */
12093c19469cSdrh   u8 *zAlloc;           /* Memory space from which to build Expr object */
12103c19469cSdrh   u32 staticFlag;       /* EP_Static if space not obtained from malloc */
12116ab3a2ecSdanielk1977 
12123c19469cSdrh   assert( db!=0 );
12133c19469cSdrh   assert( p );
12143c19469cSdrh   assert( dupFlags==0 || dupFlags==EXPRDUP_REDUCE );
12153c19469cSdrh   assert( pzBuffer==0 || dupFlags==EXPRDUP_REDUCE );
12166ab3a2ecSdanielk1977 
12176ab3a2ecSdanielk1977   /* Figure out where to write the new Expr structure. */
12186ab3a2ecSdanielk1977   if( pzBuffer ){
12196ab3a2ecSdanielk1977     zAlloc = *pzBuffer;
122033e619fcSdrh     staticFlag = EP_Static;
12216ab3a2ecSdanielk1977   }else{
12223c19469cSdrh     zAlloc = sqlite3DbMallocRawNN(db, dupedExprSize(p, dupFlags));
12233c19469cSdrh     staticFlag = 0;
12246ab3a2ecSdanielk1977   }
12256ab3a2ecSdanielk1977   pNew = (Expr *)zAlloc;
12266ab3a2ecSdanielk1977 
12276ab3a2ecSdanielk1977   if( pNew ){
12286ab3a2ecSdanielk1977     /* Set nNewSize to the size allocated for the structure pointed to
12296ab3a2ecSdanielk1977     ** by pNew. This is either EXPR_FULLSIZE, EXPR_REDUCEDSIZE or
12306ab3a2ecSdanielk1977     ** EXPR_TOKENONLYSIZE. nToken is set to the number of bytes consumed
123133e619fcSdrh     ** by the copy of the p->u.zToken string (if any).
12326ab3a2ecSdanielk1977     */
12333c19469cSdrh     const unsigned nStructSize = dupedExprStructSize(p, dupFlags);
123433e619fcSdrh     const int nNewSize = nStructSize & 0xfff;
123533e619fcSdrh     int nToken;
123633e619fcSdrh     if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
123733e619fcSdrh       nToken = sqlite3Strlen30(p->u.zToken) + 1;
123833e619fcSdrh     }else{
123933e619fcSdrh       nToken = 0;
124033e619fcSdrh     }
12413c19469cSdrh     if( dupFlags ){
12426ab3a2ecSdanielk1977       assert( ExprHasProperty(p, EP_Reduced)==0 );
12436ab3a2ecSdanielk1977       memcpy(zAlloc, p, nNewSize);
12446ab3a2ecSdanielk1977     }else{
12453e6a1411Sdan       u32 nSize = (u32)exprStructSize(p);
12466ab3a2ecSdanielk1977       memcpy(zAlloc, p, nSize);
124772ea29d7Sdrh       if( nSize<EXPR_FULLSIZE ){
12486ab3a2ecSdanielk1977         memset(&zAlloc[nSize], 0, EXPR_FULLSIZE-nSize);
12496ab3a2ecSdanielk1977       }
125072ea29d7Sdrh     }
12516ab3a2ecSdanielk1977 
125233e619fcSdrh     /* Set the EP_Reduced, EP_TokenOnly, and EP_Static flags appropriately. */
1253c5cd1249Sdrh     pNew->flags &= ~(EP_Reduced|EP_TokenOnly|EP_Static|EP_MemToken);
125433e619fcSdrh     pNew->flags |= nStructSize & (EP_Reduced|EP_TokenOnly);
125533e619fcSdrh     pNew->flags |= staticFlag;
12566ab3a2ecSdanielk1977 
125733e619fcSdrh     /* Copy the p->u.zToken string, if any. */
12586ab3a2ecSdanielk1977     if( nToken ){
125933e619fcSdrh       char *zToken = pNew->u.zToken = (char*)&zAlloc[nNewSize];
126033e619fcSdrh       memcpy(zToken, p->u.zToken, nToken);
12616ab3a2ecSdanielk1977     }
12626ab3a2ecSdanielk1977 
1263209bc522Sdrh     if( 0==((p->flags|pNew->flags) & (EP_TokenOnly|EP_Leaf)) ){
12646ab3a2ecSdanielk1977       /* Fill in the pNew->x.pSelect or pNew->x.pList member. */
12656ab3a2ecSdanielk1977       if( ExprHasProperty(p, EP_xIsSelect) ){
12663c19469cSdrh         pNew->x.pSelect = sqlite3SelectDup(db, p->x.pSelect, dupFlags);
12676ab3a2ecSdanielk1977       }else{
12683c19469cSdrh         pNew->x.pList = sqlite3ExprListDup(db, p->x.pList, dupFlags);
12696ab3a2ecSdanielk1977       }
12706ab3a2ecSdanielk1977     }
12716ab3a2ecSdanielk1977 
12726ab3a2ecSdanielk1977     /* Fill in pNew->pLeft and pNew->pRight. */
1273c5cd1249Sdrh     if( ExprHasProperty(pNew, EP_Reduced|EP_TokenOnly) ){
12743c19469cSdrh       zAlloc += dupedExprNodeSize(p, dupFlags);
1275209bc522Sdrh       if( !ExprHasProperty(pNew, EP_TokenOnly|EP_Leaf) ){
12763c19469cSdrh         pNew->pLeft = p->pLeft ?
12773c19469cSdrh                       exprDup(db, p->pLeft, EXPRDUP_REDUCE, &zAlloc) : 0;
12783c19469cSdrh         pNew->pRight = p->pRight ?
12793c19469cSdrh                        exprDup(db, p->pRight, EXPRDUP_REDUCE, &zAlloc) : 0;
12806ab3a2ecSdanielk1977       }
12816ab3a2ecSdanielk1977       if( pzBuffer ){
12826ab3a2ecSdanielk1977         *pzBuffer = zAlloc;
12836ab3a2ecSdanielk1977       }
1284b7916a78Sdrh     }else{
128567a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
1286*eda079cdSdrh       if( ExprHasProperty(p, EP_WinFunc) ){
1287*eda079cdSdrh         pNew->y.pWin = sqlite3WindowDup(db, pNew, p->y.pWin);
1288*eda079cdSdrh         assert( ExprHasProperty(pNew, EP_WinFunc) );
1289e2f781b9Sdan       }
129067a9b8edSdan #endif /* SQLITE_OMIT_WINDOWFUNC */
1291209bc522Sdrh       if( !ExprHasProperty(p, EP_TokenOnly|EP_Leaf) ){
12929854260bSdrh         if( pNew->op==TK_SELECT_COLUMN ){
12939854260bSdrh           pNew->pLeft = p->pLeft;
129447073f62Sdrh           assert( p->iColumn==0 || p->pRight==0 );
129547073f62Sdrh           assert( p->pRight==0  || p->pRight==p->pLeft );
12969854260bSdrh         }else{
12976ab3a2ecSdanielk1977           pNew->pLeft = sqlite3ExprDup(db, p->pLeft, 0);
12989854260bSdrh         }
12996ab3a2ecSdanielk1977         pNew->pRight = sqlite3ExprDup(db, p->pRight, 0);
13006ab3a2ecSdanielk1977       }
13016ab3a2ecSdanielk1977     }
13026ab3a2ecSdanielk1977   }
13036ab3a2ecSdanielk1977   return pNew;
13046ab3a2ecSdanielk1977 }
13056ab3a2ecSdanielk1977 
13066ab3a2ecSdanielk1977 /*
1307bfe31e7fSdan ** Create and return a deep copy of the object passed as the second
1308bfe31e7fSdan ** argument. If an OOM condition is encountered, NULL is returned
1309bfe31e7fSdan ** and the db->mallocFailed flag set.
1310bfe31e7fSdan */
1311eede6a53Sdan #ifndef SQLITE_OMIT_CTE
1312bfe31e7fSdan static With *withDup(sqlite3 *db, With *p){
13134e9119d9Sdan   With *pRet = 0;
13144e9119d9Sdan   if( p ){
13154e9119d9Sdan     int nByte = sizeof(*p) + sizeof(p->a[0]) * (p->nCte-1);
13164e9119d9Sdan     pRet = sqlite3DbMallocZero(db, nByte);
13174e9119d9Sdan     if( pRet ){
13184e9119d9Sdan       int i;
13194e9119d9Sdan       pRet->nCte = p->nCte;
13204e9119d9Sdan       for(i=0; i<p->nCte; i++){
13214e9119d9Sdan         pRet->a[i].pSelect = sqlite3SelectDup(db, p->a[i].pSelect, 0);
13224e9119d9Sdan         pRet->a[i].pCols = sqlite3ExprListDup(db, p->a[i].pCols, 0);
13234e9119d9Sdan         pRet->a[i].zName = sqlite3DbStrDup(db, p->a[i].zName);
13244e9119d9Sdan       }
13254e9119d9Sdan     }
13264e9119d9Sdan   }
13274e9119d9Sdan   return pRet;
13284e9119d9Sdan }
1329eede6a53Sdan #else
1330eede6a53Sdan # define withDup(x,y) 0
1331eede6a53Sdan #endif
13324e9119d9Sdan 
1333a76b5dfcSdrh /*
1334ff78bd2fSdrh ** The following group of routines make deep copies of expressions,
1335ff78bd2fSdrh ** expression lists, ID lists, and select statements.  The copies can
1336ff78bd2fSdrh ** be deleted (by being passed to their respective ...Delete() routines)
1337ff78bd2fSdrh ** without effecting the originals.
1338ff78bd2fSdrh **
13394adee20fSdanielk1977 ** The expression list, ID, and source lists return by sqlite3ExprListDup(),
13404adee20fSdanielk1977 ** sqlite3IdListDup(), and sqlite3SrcListDup() can not be further expanded
1341ad3cab52Sdrh ** by subsequent calls to sqlite*ListAppend() routines.
1342ff78bd2fSdrh **
1343ad3cab52Sdrh ** Any tables that the SrcList might point to are not duplicated.
13446ab3a2ecSdanielk1977 **
1345b7916a78Sdrh ** The flags parameter contains a combination of the EXPRDUP_XXX flags.
13466ab3a2ecSdanielk1977 ** If the EXPRDUP_REDUCE flag is set, then the structure returned is a
13476ab3a2ecSdanielk1977 ** truncated version of the usual Expr structure that will be stored as
13486ab3a2ecSdanielk1977 ** part of the in-memory representation of the database schema.
1349ff78bd2fSdrh */
13506ab3a2ecSdanielk1977 Expr *sqlite3ExprDup(sqlite3 *db, Expr *p, int flags){
135172ea29d7Sdrh   assert( flags==0 || flags==EXPRDUP_REDUCE );
13523c19469cSdrh   return p ? exprDup(db, p, flags, 0) : 0;
1353ff78bd2fSdrh }
13546ab3a2ecSdanielk1977 ExprList *sqlite3ExprListDup(sqlite3 *db, ExprList *p, int flags){
1355ff78bd2fSdrh   ExprList *pNew;
1356145716b3Sdrh   struct ExprList_item *pItem, *pOldItem;
1357ff78bd2fSdrh   int i;
1358b163748eSdrh   Expr *pPriorSelectCol = 0;
1359575fad65Sdrh   assert( db!=0 );
1360ff78bd2fSdrh   if( p==0 ) return 0;
136197258194Sdrh   pNew = sqlite3DbMallocRawNN(db, sqlite3DbMallocSize(db, p));
1362ff78bd2fSdrh   if( pNew==0 ) return 0;
1363a19543feSdrh   pNew->nExpr = p->nExpr;
136443606175Sdrh   pItem = pNew->a;
1365145716b3Sdrh   pOldItem = p->a;
1366145716b3Sdrh   for(i=0; i<p->nExpr; i++, pItem++, pOldItem++){
13676ab3a2ecSdanielk1977     Expr *pOldExpr = pOldItem->pExpr;
136847073f62Sdrh     Expr *pNewExpr;
1369b5526ea6Sdrh     pItem->pExpr = sqlite3ExprDup(db, pOldExpr, flags);
137047073f62Sdrh     if( pOldExpr
137147073f62Sdrh      && pOldExpr->op==TK_SELECT_COLUMN
137247073f62Sdrh      && (pNewExpr = pItem->pExpr)!=0
137347073f62Sdrh     ){
137447073f62Sdrh       assert( pNewExpr->iColumn==0 || i>0 );
137547073f62Sdrh       if( pNewExpr->iColumn==0 ){
137647073f62Sdrh         assert( pOldExpr->pLeft==pOldExpr->pRight );
1377b163748eSdrh         pPriorSelectCol = pNewExpr->pLeft = pNewExpr->pRight;
1378b163748eSdrh       }else{
1379b163748eSdrh         assert( i>0 );
1380b163748eSdrh         assert( pItem[-1].pExpr!=0 );
1381b163748eSdrh         assert( pNewExpr->iColumn==pItem[-1].pExpr->iColumn+1 );
1382b163748eSdrh         assert( pPriorSelectCol==pItem[-1].pExpr->pLeft );
1383b163748eSdrh         pNewExpr->pLeft = pPriorSelectCol;
138447073f62Sdrh       }
138547073f62Sdrh     }
138617435752Sdrh     pItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
1387b7916a78Sdrh     pItem->zSpan = sqlite3DbStrDup(db, pOldItem->zSpan);
1388145716b3Sdrh     pItem->sortOrder = pOldItem->sortOrder;
13893e7bc9caSdrh     pItem->done = 0;
13902c036cffSdrh     pItem->bSpanIsTab = pOldItem->bSpanIsTab;
139124e25d32Sdan     pItem->bSorterRef = pOldItem->bSorterRef;
1392c2acc4e4Sdrh     pItem->u = pOldItem->u;
1393ff78bd2fSdrh   }
1394ff78bd2fSdrh   return pNew;
1395ff78bd2fSdrh }
139693758c8dSdanielk1977 
139793758c8dSdanielk1977 /*
139893758c8dSdanielk1977 ** If cursors, triggers, views and subqueries are all omitted from
139993758c8dSdanielk1977 ** the build, then none of the following routines, except for
140093758c8dSdanielk1977 ** sqlite3SelectDup(), can be called. sqlite3SelectDup() is sometimes
140193758c8dSdanielk1977 ** called with a NULL argument.
140293758c8dSdanielk1977 */
14036a67fe8eSdanielk1977 #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_TRIGGER) \
14046a67fe8eSdanielk1977  || !defined(SQLITE_OMIT_SUBQUERY)
14056ab3a2ecSdanielk1977 SrcList *sqlite3SrcListDup(sqlite3 *db, SrcList *p, int flags){
1406ad3cab52Sdrh   SrcList *pNew;
1407ad3cab52Sdrh   int i;
1408113088ecSdrh   int nByte;
1409575fad65Sdrh   assert( db!=0 );
1410ad3cab52Sdrh   if( p==0 ) return 0;
1411113088ecSdrh   nByte = sizeof(*p) + (p->nSrc>0 ? sizeof(p->a[0]) * (p->nSrc-1) : 0);
1412575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, nByte );
1413ad3cab52Sdrh   if( pNew==0 ) return 0;
14144305d103Sdrh   pNew->nSrc = pNew->nAlloc = p->nSrc;
1415ad3cab52Sdrh   for(i=0; i<p->nSrc; i++){
14164efc4754Sdrh     struct SrcList_item *pNewItem = &pNew->a[i];
14174efc4754Sdrh     struct SrcList_item *pOldItem = &p->a[i];
1418ed8a3bb1Sdrh     Table *pTab;
141941fb5cd1Sdan     pNewItem->pSchema = pOldItem->pSchema;
142017435752Sdrh     pNewItem->zDatabase = sqlite3DbStrDup(db, pOldItem->zDatabase);
142117435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
142217435752Sdrh     pNewItem->zAlias = sqlite3DbStrDup(db, pOldItem->zAlias);
14238a48b9c0Sdrh     pNewItem->fg = pOldItem->fg;
14244efc4754Sdrh     pNewItem->iCursor = pOldItem->iCursor;
14255b6a9ed4Sdrh     pNewItem->addrFillSub = pOldItem->addrFillSub;
14265b6a9ed4Sdrh     pNewItem->regReturn = pOldItem->regReturn;
14278a48b9c0Sdrh     if( pNewItem->fg.isIndexedBy ){
14288a48b9c0Sdrh       pNewItem->u1.zIndexedBy = sqlite3DbStrDup(db, pOldItem->u1.zIndexedBy);
14298a48b9c0Sdrh     }
14308a48b9c0Sdrh     pNewItem->pIBIndex = pOldItem->pIBIndex;
14318a48b9c0Sdrh     if( pNewItem->fg.isTabFunc ){
14328a48b9c0Sdrh       pNewItem->u1.pFuncArg =
14338a48b9c0Sdrh           sqlite3ExprListDup(db, pOldItem->u1.pFuncArg, flags);
14348a48b9c0Sdrh     }
1435ed8a3bb1Sdrh     pTab = pNewItem->pTab = pOldItem->pTab;
1436ed8a3bb1Sdrh     if( pTab ){
143779df7782Sdrh       pTab->nTabRef++;
1438a1cb183dSdanielk1977     }
14396ab3a2ecSdanielk1977     pNewItem->pSelect = sqlite3SelectDup(db, pOldItem->pSelect, flags);
14406ab3a2ecSdanielk1977     pNewItem->pOn = sqlite3ExprDup(db, pOldItem->pOn, flags);
144117435752Sdrh     pNewItem->pUsing = sqlite3IdListDup(db, pOldItem->pUsing);
14426c18b6e0Sdanielk1977     pNewItem->colUsed = pOldItem->colUsed;
1443ad3cab52Sdrh   }
1444ad3cab52Sdrh   return pNew;
1445ad3cab52Sdrh }
144617435752Sdrh IdList *sqlite3IdListDup(sqlite3 *db, IdList *p){
1447ff78bd2fSdrh   IdList *pNew;
1448ff78bd2fSdrh   int i;
1449575fad65Sdrh   assert( db!=0 );
1450ff78bd2fSdrh   if( p==0 ) return 0;
1451575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, sizeof(*pNew) );
1452ff78bd2fSdrh   if( pNew==0 ) return 0;
14536c535158Sdrh   pNew->nId = p->nId;
1454575fad65Sdrh   pNew->a = sqlite3DbMallocRawNN(db, p->nId*sizeof(p->a[0]) );
1455d5d56523Sdanielk1977   if( pNew->a==0 ){
1456dbd6a7dcSdrh     sqlite3DbFreeNN(db, pNew);
1457d5d56523Sdanielk1977     return 0;
1458d5d56523Sdanielk1977   }
14596c535158Sdrh   /* Note that because the size of the allocation for p->a[] is not
14606c535158Sdrh   ** necessarily a power of two, sqlite3IdListAppend() may not be called
14616c535158Sdrh   ** on the duplicate created by this function. */
1462ff78bd2fSdrh   for(i=0; i<p->nId; i++){
14634efc4754Sdrh     struct IdList_item *pNewItem = &pNew->a[i];
14644efc4754Sdrh     struct IdList_item *pOldItem = &p->a[i];
146517435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
14664efc4754Sdrh     pNewItem->idx = pOldItem->idx;
1467ff78bd2fSdrh   }
1468ff78bd2fSdrh   return pNew;
1469ff78bd2fSdrh }
1470a7466205Sdan Select *sqlite3SelectDup(sqlite3 *db, Select *pDup, int flags){
1471a7466205Sdan   Select *pRet = 0;
1472a7466205Sdan   Select *pNext = 0;
1473a7466205Sdan   Select **pp = &pRet;
1474a7466205Sdan   Select *p;
1475a7466205Sdan 
1476575fad65Sdrh   assert( db!=0 );
1477a7466205Sdan   for(p=pDup; p; p=p->pPrior){
1478a7466205Sdan     Select *pNew = sqlite3DbMallocRawNN(db, sizeof(*p) );
1479a7466205Sdan     if( pNew==0 ) break;
1480b7916a78Sdrh     pNew->pEList = sqlite3ExprListDup(db, p->pEList, flags);
14816ab3a2ecSdanielk1977     pNew->pSrc = sqlite3SrcListDup(db, p->pSrc, flags);
14826ab3a2ecSdanielk1977     pNew->pWhere = sqlite3ExprDup(db, p->pWhere, flags);
14836ab3a2ecSdanielk1977     pNew->pGroupBy = sqlite3ExprListDup(db, p->pGroupBy, flags);
14846ab3a2ecSdanielk1977     pNew->pHaving = sqlite3ExprDup(db, p->pHaving, flags);
14856ab3a2ecSdanielk1977     pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, flags);
1486ff78bd2fSdrh     pNew->op = p->op;
1487a7466205Sdan     pNew->pNext = pNext;
1488a7466205Sdan     pNew->pPrior = 0;
14896ab3a2ecSdanielk1977     pNew->pLimit = sqlite3ExprDup(db, p->pLimit, flags);
149092b01d53Sdrh     pNew->iLimit = 0;
149192b01d53Sdrh     pNew->iOffset = 0;
14927d10d5a6Sdrh     pNew->selFlags = p->selFlags & ~SF_UsesEphemeral;
1493b9bb7c18Sdrh     pNew->addrOpenEphm[0] = -1;
1494b9bb7c18Sdrh     pNew->addrOpenEphm[1] = -1;
1495ec2da854Sdrh     pNew->nSelectRow = p->nSelectRow;
14964e9119d9Sdan     pNew->pWith = withDup(db, p->pWith);
149767a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
14982e362f97Sdan     pNew->pWin = 0;
1499c95f38d4Sdan     pNew->pWinDefn = sqlite3WindowListDup(db, p->pWinDefn);
150067a9b8edSdan #endif
1501fef37760Sdrh     pNew->selId = p->selId;
1502a7466205Sdan     *pp = pNew;
1503a7466205Sdan     pp = &pNew->pPrior;
1504a7466205Sdan     pNext = pNew;
1505a7466205Sdan   }
1506a7466205Sdan 
1507a7466205Sdan   return pRet;
1508ff78bd2fSdrh }
150993758c8dSdanielk1977 #else
15106ab3a2ecSdanielk1977 Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
151193758c8dSdanielk1977   assert( p==0 );
151293758c8dSdanielk1977   return 0;
151393758c8dSdanielk1977 }
151493758c8dSdanielk1977 #endif
1515ff78bd2fSdrh 
1516ff78bd2fSdrh 
1517ff78bd2fSdrh /*
1518a76b5dfcSdrh ** Add a new element to the end of an expression list.  If pList is
1519a76b5dfcSdrh ** initially NULL, then create a new expression list.
1520b7916a78Sdrh **
1521a19543feSdrh ** The pList argument must be either NULL or a pointer to an ExprList
1522a19543feSdrh ** obtained from a prior call to sqlite3ExprListAppend().  This routine
1523a19543feSdrh ** may not be used with an ExprList obtained from sqlite3ExprListDup().
1524a19543feSdrh ** Reason:  This routine assumes that the number of slots in pList->a[]
1525a19543feSdrh ** is a power of two.  That is true for sqlite3ExprListAppend() returns
1526a19543feSdrh ** but is not necessarily true from the return value of sqlite3ExprListDup().
1527a19543feSdrh **
1528b7916a78Sdrh ** If a memory allocation error occurs, the entire list is freed and
1529b7916a78Sdrh ** NULL is returned.  If non-NULL is returned, then it is guaranteed
1530b7916a78Sdrh ** that the new entry was successfully appended.
1531a76b5dfcSdrh */
153217435752Sdrh ExprList *sqlite3ExprListAppend(
153317435752Sdrh   Parse *pParse,          /* Parsing context */
153417435752Sdrh   ExprList *pList,        /* List to which to append. Might be NULL */
1535b7916a78Sdrh   Expr *pExpr             /* Expression to be appended. Might be NULL */
153617435752Sdrh ){
153743606175Sdrh   struct ExprList_item *pItem;
153817435752Sdrh   sqlite3 *db = pParse->db;
1539575fad65Sdrh   assert( db!=0 );
1540a76b5dfcSdrh   if( pList==0 ){
1541575fad65Sdrh     pList = sqlite3DbMallocRawNN(db, sizeof(ExprList) );
1542a76b5dfcSdrh     if( pList==0 ){
1543d5d56523Sdanielk1977       goto no_mem;
1544a76b5dfcSdrh     }
1545c263f7c4Sdrh     pList->nExpr = 0;
1546a19543feSdrh   }else if( (pList->nExpr & (pList->nExpr-1))==0 ){
154743606175Sdrh     ExprList *pNew;
154843606175Sdrh     pNew = sqlite3DbRealloc(db, pList,
1549a19543feSdrh              sizeof(*pList)+(2*pList->nExpr - 1)*sizeof(pList->a[0]));
155043606175Sdrh     if( pNew==0 ){
1551d5d56523Sdanielk1977       goto no_mem;
1552a76b5dfcSdrh     }
155343606175Sdrh     pList = pNew;
1554a76b5dfcSdrh   }
155543606175Sdrh   pItem = &pList->a[pList->nExpr++];
1556a8b9793cSdrh   assert( offsetof(struct ExprList_item,zName)==sizeof(pItem->pExpr) );
1557a8b9793cSdrh   assert( offsetof(struct ExprList_item,pExpr)==0 );
1558a8b9793cSdrh   memset(&pItem->zName,0,sizeof(*pItem)-offsetof(struct ExprList_item,zName));
1559e94ddc9eSdanielk1977   pItem->pExpr = pExpr;
1560a76b5dfcSdrh   return pList;
1561d5d56523Sdanielk1977 
1562d5d56523Sdanielk1977 no_mem:
1563d5d56523Sdanielk1977   /* Avoid leaking memory if malloc has failed. */
1564633e6d57Sdrh   sqlite3ExprDelete(db, pExpr);
1565633e6d57Sdrh   sqlite3ExprListDelete(db, pList);
1566d5d56523Sdanielk1977   return 0;
1567a76b5dfcSdrh }
1568a76b5dfcSdrh 
1569a76b5dfcSdrh /*
15708762ec19Sdrh ** pColumns and pExpr form a vector assignment which is part of the SET
15718762ec19Sdrh ** clause of an UPDATE statement.  Like this:
1572a1251bc4Sdrh **
1573a1251bc4Sdrh **        (a,b,c) = (expr1,expr2,expr3)
1574a1251bc4Sdrh ** Or:    (a,b,c) = (SELECT x,y,z FROM ....)
1575a1251bc4Sdrh **
1576a1251bc4Sdrh ** For each term of the vector assignment, append new entries to the
1577b67343d0Sdrh ** expression list pList.  In the case of a subquery on the RHS, append
1578a1251bc4Sdrh ** TK_SELECT_COLUMN expressions.
1579a1251bc4Sdrh */
1580a1251bc4Sdrh ExprList *sqlite3ExprListAppendVector(
1581a1251bc4Sdrh   Parse *pParse,         /* Parsing context */
1582a1251bc4Sdrh   ExprList *pList,       /* List to which to append. Might be NULL */
1583a1251bc4Sdrh   IdList *pColumns,      /* List of names of LHS of the assignment */
1584a1251bc4Sdrh   Expr *pExpr            /* Vector expression to be appended. Might be NULL */
1585a1251bc4Sdrh ){
1586a1251bc4Sdrh   sqlite3 *db = pParse->db;
1587a1251bc4Sdrh   int n;
1588a1251bc4Sdrh   int i;
158966860af3Sdrh   int iFirst = pList ? pList->nExpr : 0;
1590321e828dSdrh   /* pColumns can only be NULL due to an OOM but an OOM will cause an
1591321e828dSdrh   ** exit prior to this routine being invoked */
1592321e828dSdrh   if( NEVER(pColumns==0) ) goto vector_append_error;
1593a1251bc4Sdrh   if( pExpr==0 ) goto vector_append_error;
1594966e2911Sdrh 
1595966e2911Sdrh   /* If the RHS is a vector, then we can immediately check to see that
1596966e2911Sdrh   ** the size of the RHS and LHS match.  But if the RHS is a SELECT,
1597966e2911Sdrh   ** wildcards ("*") in the result set of the SELECT must be expanded before
1598966e2911Sdrh   ** we can do the size check, so defer the size check until code generation.
1599966e2911Sdrh   */
1600966e2911Sdrh   if( pExpr->op!=TK_SELECT && pColumns->nId!=(n=sqlite3ExprVectorSize(pExpr)) ){
1601a1251bc4Sdrh     sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
1602a1251bc4Sdrh                     pColumns->nId, n);
1603a1251bc4Sdrh     goto vector_append_error;
1604a1251bc4Sdrh   }
1605966e2911Sdrh 
1606966e2911Sdrh   for(i=0; i<pColumns->nId; i++){
1607a1251bc4Sdrh     Expr *pSubExpr = sqlite3ExprForVectorField(pParse, pExpr, i);
1608a1251bc4Sdrh     pList = sqlite3ExprListAppend(pParse, pList, pSubExpr);
1609a1251bc4Sdrh     if( pList ){
161066860af3Sdrh       assert( pList->nExpr==iFirst+i+1 );
1611a1251bc4Sdrh       pList->a[pList->nExpr-1].zName = pColumns->a[i].zName;
1612a1251bc4Sdrh       pColumns->a[i].zName = 0;
1613a1251bc4Sdrh     }
1614a1251bc4Sdrh   }
1615966e2911Sdrh 
1616ffe28059Sdrh   if( !db->mallocFailed && pExpr->op==TK_SELECT && ALWAYS(pList!=0) ){
1617966e2911Sdrh     Expr *pFirst = pList->a[iFirst].pExpr;
1618f4dd26c5Sdrh     assert( pFirst!=0 );
1619966e2911Sdrh     assert( pFirst->op==TK_SELECT_COLUMN );
1620966e2911Sdrh 
1621966e2911Sdrh     /* Store the SELECT statement in pRight so it will be deleted when
1622966e2911Sdrh     ** sqlite3ExprListDelete() is called */
1623966e2911Sdrh     pFirst->pRight = pExpr;
1624a1251bc4Sdrh     pExpr = 0;
1625966e2911Sdrh 
1626966e2911Sdrh     /* Remember the size of the LHS in iTable so that we can check that
1627966e2911Sdrh     ** the RHS and LHS sizes match during code generation. */
1628966e2911Sdrh     pFirst->iTable = pColumns->nId;
1629a1251bc4Sdrh   }
1630a1251bc4Sdrh 
1631a1251bc4Sdrh vector_append_error:
1632a1251bc4Sdrh   sqlite3ExprDelete(db, pExpr);
1633a1251bc4Sdrh   sqlite3IdListDelete(db, pColumns);
1634a1251bc4Sdrh   return pList;
1635a1251bc4Sdrh }
1636a1251bc4Sdrh 
1637a1251bc4Sdrh /*
1638bc622bc0Sdrh ** Set the sort order for the last element on the given ExprList.
1639bc622bc0Sdrh */
1640bc622bc0Sdrh void sqlite3ExprListSetSortOrder(ExprList *p, int iSortOrder){
1641bc622bc0Sdrh   if( p==0 ) return;
1642bc622bc0Sdrh   assert( SQLITE_SO_UNDEFINED<0 && SQLITE_SO_ASC>=0 && SQLITE_SO_DESC>0 );
1643bc622bc0Sdrh   assert( p->nExpr>0 );
1644bc622bc0Sdrh   if( iSortOrder<0 ){
1645bc622bc0Sdrh     assert( p->a[p->nExpr-1].sortOrder==SQLITE_SO_ASC );
1646bc622bc0Sdrh     return;
1647bc622bc0Sdrh   }
1648bc622bc0Sdrh   p->a[p->nExpr-1].sortOrder = (u8)iSortOrder;
1649bc622bc0Sdrh }
1650bc622bc0Sdrh 
1651bc622bc0Sdrh /*
1652b7916a78Sdrh ** Set the ExprList.a[].zName element of the most recently added item
1653b7916a78Sdrh ** on the expression list.
1654b7916a78Sdrh **
1655b7916a78Sdrh ** pList might be NULL following an OOM error.  But pName should never be
1656b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1657b7916a78Sdrh ** is set.
1658b7916a78Sdrh */
1659b7916a78Sdrh void sqlite3ExprListSetName(
1660b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1661b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
1662b7916a78Sdrh   Token *pName,           /* Name to be added */
1663b7916a78Sdrh   int dequote             /* True to cause the name to be dequoted */
1664b7916a78Sdrh ){
1665b7916a78Sdrh   assert( pList!=0 || pParse->db->mallocFailed!=0 );
1666b7916a78Sdrh   if( pList ){
1667b7916a78Sdrh     struct ExprList_item *pItem;
1668b7916a78Sdrh     assert( pList->nExpr>0 );
1669b7916a78Sdrh     pItem = &pList->a[pList->nExpr-1];
1670b7916a78Sdrh     assert( pItem->zName==0 );
1671b7916a78Sdrh     pItem->zName = sqlite3DbStrNDup(pParse->db, pName->z, pName->n);
1672244b9d6eSdrh     if( dequote ) sqlite3Dequote(pItem->zName);
1673c9461eccSdan     if( IN_RENAME_OBJECT ){
167407e95233Sdan       sqlite3RenameTokenMap(pParse, (void*)pItem->zName, pName);
16755be60c55Sdan     }
1676b7916a78Sdrh   }
1677b7916a78Sdrh }
1678b7916a78Sdrh 
1679b7916a78Sdrh /*
1680b7916a78Sdrh ** Set the ExprList.a[].zSpan element of the most recently added item
1681b7916a78Sdrh ** on the expression list.
1682b7916a78Sdrh **
1683b7916a78Sdrh ** pList might be NULL following an OOM error.  But pSpan should never be
1684b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1685b7916a78Sdrh ** is set.
1686b7916a78Sdrh */
1687b7916a78Sdrh void sqlite3ExprListSetSpan(
1688b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1689b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
16901be266baSdrh   const char *zStart,     /* Start of the span */
16911be266baSdrh   const char *zEnd        /* End of the span */
1692b7916a78Sdrh ){
1693b7916a78Sdrh   sqlite3 *db = pParse->db;
1694b7916a78Sdrh   assert( pList!=0 || db->mallocFailed!=0 );
1695b7916a78Sdrh   if( pList ){
1696b7916a78Sdrh     struct ExprList_item *pItem = &pList->a[pList->nExpr-1];
1697b7916a78Sdrh     assert( pList->nExpr>0 );
1698b7916a78Sdrh     sqlite3DbFree(db, pItem->zSpan);
16999b2e0435Sdrh     pItem->zSpan = sqlite3DbSpanDup(db, zStart, zEnd);
1700b7916a78Sdrh   }
1701b7916a78Sdrh }
1702b7916a78Sdrh 
1703b7916a78Sdrh /*
17047a15a4beSdanielk1977 ** If the expression list pEList contains more than iLimit elements,
17057a15a4beSdanielk1977 ** leave an error message in pParse.
17067a15a4beSdanielk1977 */
17077a15a4beSdanielk1977 void sqlite3ExprListCheckLength(
17087a15a4beSdanielk1977   Parse *pParse,
17097a15a4beSdanielk1977   ExprList *pEList,
17107a15a4beSdanielk1977   const char *zObject
17117a15a4beSdanielk1977 ){
1712b1a6c3c1Sdrh   int mx = pParse->db->aLimit[SQLITE_LIMIT_COLUMN];
1713c5499befSdrh   testcase( pEList && pEList->nExpr==mx );
1714c5499befSdrh   testcase( pEList && pEList->nExpr==mx+1 );
1715b1a6c3c1Sdrh   if( pEList && pEList->nExpr>mx ){
17167a15a4beSdanielk1977     sqlite3ErrorMsg(pParse, "too many columns in %s", zObject);
17177a15a4beSdanielk1977   }
17187a15a4beSdanielk1977 }
17197a15a4beSdanielk1977 
17207a15a4beSdanielk1977 /*
1721a76b5dfcSdrh ** Delete an entire expression list.
1722a76b5dfcSdrh */
1723affa855cSdrh static SQLITE_NOINLINE void exprListDeleteNN(sqlite3 *db, ExprList *pList){
1724ac48b751Sdrh   int i = pList->nExpr;
1725ac48b751Sdrh   struct ExprList_item *pItem =  pList->a;
1726ac48b751Sdrh   assert( pList->nExpr>0 );
1727ac48b751Sdrh   do{
1728633e6d57Sdrh     sqlite3ExprDelete(db, pItem->pExpr);
1729633e6d57Sdrh     sqlite3DbFree(db, pItem->zName);
1730b7916a78Sdrh     sqlite3DbFree(db, pItem->zSpan);
1731ac48b751Sdrh     pItem++;
1732ac48b751Sdrh   }while( --i>0 );
1733dbd6a7dcSdrh   sqlite3DbFreeNN(db, pList);
1734a76b5dfcSdrh }
1735affa855cSdrh void sqlite3ExprListDelete(sqlite3 *db, ExprList *pList){
1736affa855cSdrh   if( pList ) exprListDeleteNN(db, pList);
1737affa855cSdrh }
1738a76b5dfcSdrh 
1739a76b5dfcSdrh /*
17402308ed38Sdrh ** Return the bitwise-OR of all Expr.flags fields in the given
17412308ed38Sdrh ** ExprList.
1742885a5b03Sdrh */
17432308ed38Sdrh u32 sqlite3ExprListFlags(const ExprList *pList){
1744885a5b03Sdrh   int i;
17452308ed38Sdrh   u32 m = 0;
1746508e2d00Sdrh   assert( pList!=0 );
1747885a5b03Sdrh   for(i=0; i<pList->nExpr; i++){
1748d0c73053Sdrh      Expr *pExpr = pList->a[i].pExpr;
1749de845c2fSdrh      assert( pExpr!=0 );
1750de845c2fSdrh      m |= pExpr->flags;
1751885a5b03Sdrh   }
17522308ed38Sdrh   return m;
1753885a5b03Sdrh }
1754885a5b03Sdrh 
1755885a5b03Sdrh /*
17567e6f980bSdrh ** This is a SELECT-node callback for the expression walker that
17577e6f980bSdrh ** always "fails".  By "fail" in this case, we mean set
17587e6f980bSdrh ** pWalker->eCode to zero and abort.
17597e6f980bSdrh **
17607e6f980bSdrh ** This callback is used by multiple expression walkers.
17617e6f980bSdrh */
17627e6f980bSdrh int sqlite3SelectWalkFail(Walker *pWalker, Select *NotUsed){
17637e6f980bSdrh   UNUSED_PARAMETER(NotUsed);
17647e6f980bSdrh   pWalker->eCode = 0;
17657e6f980bSdrh   return WRC_Abort;
17667e6f980bSdrh }
17677e6f980bSdrh 
17687e6f980bSdrh /*
1769171d16bbSdrh ** If the input expression is an ID with the name "true" or "false"
177096acafbeSdrh ** then convert it into an TK_TRUEFALSE term.  Return non-zero if
177196acafbeSdrh ** the conversion happened, and zero if the expression is unaltered.
1772171d16bbSdrh */
1773171d16bbSdrh int sqlite3ExprIdToTrueFalse(Expr *pExpr){
1774171d16bbSdrh   assert( pExpr->op==TK_ID || pExpr->op==TK_STRING );
1775171d16bbSdrh   if( sqlite3StrICmp(pExpr->u.zToken, "true")==0
1776171d16bbSdrh    || sqlite3StrICmp(pExpr->u.zToken, "false")==0
1777171d16bbSdrh   ){
1778171d16bbSdrh     pExpr->op = TK_TRUEFALSE;
1779171d16bbSdrh     return 1;
1780171d16bbSdrh   }
1781171d16bbSdrh   return 0;
1782171d16bbSdrh }
1783171d16bbSdrh 
178443c4ac8bSdrh /*
178596acafbeSdrh ** The argument must be a TK_TRUEFALSE Expr node.  Return 1 if it is TRUE
178643c4ac8bSdrh ** and 0 if it is FALSE.
178743c4ac8bSdrh */
178896acafbeSdrh int sqlite3ExprTruthValue(const Expr *pExpr){
178943c4ac8bSdrh   assert( pExpr->op==TK_TRUEFALSE );
179043c4ac8bSdrh   assert( sqlite3StrICmp(pExpr->u.zToken,"true")==0
179143c4ac8bSdrh        || sqlite3StrICmp(pExpr->u.zToken,"false")==0 );
179243c4ac8bSdrh   return pExpr->u.zToken[4]==0;
179343c4ac8bSdrh }
179443c4ac8bSdrh 
1795171d16bbSdrh 
1796171d16bbSdrh /*
1797059b2d50Sdrh ** These routines are Walker callbacks used to check expressions to
1798059b2d50Sdrh ** see if they are "constant" for some definition of constant.  The
1799059b2d50Sdrh ** Walker.eCode value determines the type of "constant" we are looking
1800059b2d50Sdrh ** for.
180173b211abSdrh **
18027d10d5a6Sdrh ** These callback routines are used to implement the following:
1803626a879aSdrh **
1804059b2d50Sdrh **     sqlite3ExprIsConstant()                  pWalker->eCode==1
1805059b2d50Sdrh **     sqlite3ExprIsConstantNotJoin()           pWalker->eCode==2
1806fcb9f4f3Sdrh **     sqlite3ExprIsTableConstant()             pWalker->eCode==3
1807059b2d50Sdrh **     sqlite3ExprIsConstantOrFunction()        pWalker->eCode==4 or 5
180887abf5c0Sdrh **
1809059b2d50Sdrh ** In all cases, the callbacks set Walker.eCode=0 and abort if the expression
1810059b2d50Sdrh ** is found to not be a constant.
181187abf5c0Sdrh **
1812feada2dfSdrh ** The sqlite3ExprIsConstantOrFunction() is used for evaluating expressions
1813059b2d50Sdrh ** in a CREATE TABLE statement.  The Walker.eCode value is 5 when parsing
1814059b2d50Sdrh ** an existing schema and 4 when processing a new statement.  A bound
1815feada2dfSdrh ** parameter raises an error for new statements, but is silently converted
1816feada2dfSdrh ** to NULL for existing schemas.  This allows sqlite_master tables that
1817feada2dfSdrh ** contain a bound parameter because they were generated by older versions
1818feada2dfSdrh ** of SQLite to be parsed by newer versions of SQLite without raising a
1819feada2dfSdrh ** malformed schema error.
1820626a879aSdrh */
18217d10d5a6Sdrh static int exprNodeIsConstant(Walker *pWalker, Expr *pExpr){
1822626a879aSdrh 
1823059b2d50Sdrh   /* If pWalker->eCode is 2 then any term of the expression that comes from
1824059b2d50Sdrh   ** the ON or USING clauses of a left join disqualifies the expression
18250a168377Sdrh   ** from being considered constant. */
1826059b2d50Sdrh   if( pWalker->eCode==2 && ExprHasProperty(pExpr, EP_FromJoin) ){
1827059b2d50Sdrh     pWalker->eCode = 0;
18287d10d5a6Sdrh     return WRC_Abort;
18290a168377Sdrh   }
18300a168377Sdrh 
1831626a879aSdrh   switch( pExpr->op ){
1832eb55bd2fSdrh     /* Consider functions to be constant if all their arguments are constant
1833059b2d50Sdrh     ** and either pWalker->eCode==4 or 5 or the function has the
1834059b2d50Sdrh     ** SQLITE_FUNC_CONST flag. */
1835eb55bd2fSdrh     case TK_FUNCTION:
183663f84573Sdrh       if( pWalker->eCode>=4 || ExprHasProperty(pExpr,EP_ConstFunc) ){
1837b1fba286Sdrh         return WRC_Continue;
1838059b2d50Sdrh       }else{
1839059b2d50Sdrh         pWalker->eCode = 0;
1840059b2d50Sdrh         return WRC_Abort;
1841b1fba286Sdrh       }
1842626a879aSdrh     case TK_ID:
1843171d16bbSdrh       /* Convert "true" or "false" in a DEFAULT clause into the
1844171d16bbSdrh       ** appropriate TK_TRUEFALSE operator */
1845e39ef31cSdrh       if( sqlite3ExprIdToTrueFalse(pExpr) ){
1846171d16bbSdrh         return WRC_Prune;
1847171d16bbSdrh       }
1848171d16bbSdrh       /* Fall thru */
1849626a879aSdrh     case TK_COLUMN:
1850626a879aSdrh     case TK_AGG_FUNCTION:
185113449892Sdrh     case TK_AGG_COLUMN:
1852c5499befSdrh       testcase( pExpr->op==TK_ID );
1853c5499befSdrh       testcase( pExpr->op==TK_COLUMN );
1854c5499befSdrh       testcase( pExpr->op==TK_AGG_FUNCTION );
1855c5499befSdrh       testcase( pExpr->op==TK_AGG_COLUMN );
185607aded63Sdrh       if( ExprHasProperty(pExpr, EP_FixedCol) && pWalker->eCode!=2 ){
1857efad2e23Sdrh         return WRC_Continue;
1858efad2e23Sdrh       }
1859059b2d50Sdrh       if( pWalker->eCode==3 && pExpr->iTable==pWalker->u.iCur ){
1860059b2d50Sdrh         return WRC_Continue;
1861f43ce0b4Sdrh       }
1862f43ce0b4Sdrh       /* Fall through */
1863f43ce0b4Sdrh     case TK_IF_NULL_ROW:
18646e341b93Sdrh     case TK_REGISTER:
18659916048bSdrh       testcase( pExpr->op==TK_REGISTER );
1866f43ce0b4Sdrh       testcase( pExpr->op==TK_IF_NULL_ROW );
1867059b2d50Sdrh       pWalker->eCode = 0;
18687d10d5a6Sdrh       return WRC_Abort;
1869feada2dfSdrh     case TK_VARIABLE:
1870059b2d50Sdrh       if( pWalker->eCode==5 ){
1871feada2dfSdrh         /* Silently convert bound parameters that appear inside of CREATE
1872feada2dfSdrh         ** statements into a NULL when parsing the CREATE statement text out
1873feada2dfSdrh         ** of the sqlite_master table */
1874feada2dfSdrh         pExpr->op = TK_NULL;
1875059b2d50Sdrh       }else if( pWalker->eCode==4 ){
1876feada2dfSdrh         /* A bound parameter in a CREATE statement that originates from
1877feada2dfSdrh         ** sqlite3_prepare() causes an error */
1878059b2d50Sdrh         pWalker->eCode = 0;
1879feada2dfSdrh         return WRC_Abort;
1880feada2dfSdrh       }
1881feada2dfSdrh       /* Fall through */
1882626a879aSdrh     default:
18836e341b93Sdrh       testcase( pExpr->op==TK_SELECT ); /* sqlite3SelectWalkFail() disallows */
18846e341b93Sdrh       testcase( pExpr->op==TK_EXISTS ); /* sqlite3SelectWalkFail() disallows */
18857d10d5a6Sdrh       return WRC_Continue;
1886626a879aSdrh   }
1887626a879aSdrh }
1888059b2d50Sdrh static int exprIsConst(Expr *p, int initFlag, int iCur){
18897d10d5a6Sdrh   Walker w;
1890059b2d50Sdrh   w.eCode = initFlag;
18917d10d5a6Sdrh   w.xExprCallback = exprNodeIsConstant;
18927e6f980bSdrh   w.xSelectCallback = sqlite3SelectWalkFail;
1893979dd1beSdrh #ifdef SQLITE_DEBUG
1894979dd1beSdrh   w.xSelectCallback2 = sqlite3SelectWalkAssert2;
1895979dd1beSdrh #endif
1896059b2d50Sdrh   w.u.iCur = iCur;
18977d10d5a6Sdrh   sqlite3WalkExpr(&w, p);
1898059b2d50Sdrh   return w.eCode;
18997d10d5a6Sdrh }
1900626a879aSdrh 
1901626a879aSdrh /*
1902059b2d50Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
1903eb55bd2fSdrh ** and 0 if it involves variables or function calls.
19042398937bSdrh **
19052398937bSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
19062398937bSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
19072398937bSdrh ** a constant.
1908fef5208cSdrh */
19094adee20fSdanielk1977 int sqlite3ExprIsConstant(Expr *p){
1910059b2d50Sdrh   return exprIsConst(p, 1, 0);
1911fef5208cSdrh }
1912fef5208cSdrh 
1913fef5208cSdrh /*
191407aded63Sdrh ** Walk an expression tree.  Return non-zero if
191507aded63Sdrh **
191607aded63Sdrh **   (1) the expression is constant, and
191707aded63Sdrh **   (2) the expression does originate in the ON or USING clause
191807aded63Sdrh **       of a LEFT JOIN, and
191907aded63Sdrh **   (3) the expression does not contain any EP_FixedCol TK_COLUMN
192007aded63Sdrh **       operands created by the constant propagation optimization.
192107aded63Sdrh **
192207aded63Sdrh ** When this routine returns true, it indicates that the expression
192307aded63Sdrh ** can be added to the pParse->pConstExpr list and evaluated once when
192407aded63Sdrh ** the prepared statement starts up.  See sqlite3ExprCodeAtInit().
19250a168377Sdrh */
19260a168377Sdrh int sqlite3ExprIsConstantNotJoin(Expr *p){
1927059b2d50Sdrh   return exprIsConst(p, 2, 0);
19280a168377Sdrh }
19290a168377Sdrh 
19300a168377Sdrh /*
1931fcb9f4f3Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
1932059b2d50Sdrh ** for any single row of the table with cursor iCur.  In other words, the
1933059b2d50Sdrh ** expression must not refer to any non-deterministic function nor any
1934059b2d50Sdrh ** table other than iCur.
1935059b2d50Sdrh */
1936059b2d50Sdrh int sqlite3ExprIsTableConstant(Expr *p, int iCur){
1937059b2d50Sdrh   return exprIsConst(p, 3, iCur);
1938059b2d50Sdrh }
1939059b2d50Sdrh 
1940ab31a845Sdan 
1941ab31a845Sdan /*
1942ab31a845Sdan ** sqlite3WalkExpr() callback used by sqlite3ExprIsConstantOrGroupBy().
1943ab31a845Sdan */
1944ab31a845Sdan static int exprNodeIsConstantOrGroupBy(Walker *pWalker, Expr *pExpr){
1945ab31a845Sdan   ExprList *pGroupBy = pWalker->u.pGroupBy;
1946ab31a845Sdan   int i;
1947ab31a845Sdan 
1948ab31a845Sdan   /* Check if pExpr is identical to any GROUP BY term. If so, consider
1949ab31a845Sdan   ** it constant.  */
1950ab31a845Sdan   for(i=0; i<pGroupBy->nExpr; i++){
1951ab31a845Sdan     Expr *p = pGroupBy->a[i].pExpr;
19525aa550cfSdan     if( sqlite3ExprCompare(0, pExpr, p, -1)<2 ){
195370efa84dSdrh       CollSeq *pColl = sqlite3ExprNNCollSeq(pWalker->pParse, p);
1954efad2e23Sdrh       if( sqlite3IsBinary(pColl) ){
1955ab31a845Sdan         return WRC_Prune;
1956ab31a845Sdan       }
1957ab31a845Sdan     }
1958ab31a845Sdan   }
1959ab31a845Sdan 
1960ab31a845Sdan   /* Check if pExpr is a sub-select. If so, consider it variable. */
1961ab31a845Sdan   if( ExprHasProperty(pExpr, EP_xIsSelect) ){
1962ab31a845Sdan     pWalker->eCode = 0;
1963ab31a845Sdan     return WRC_Abort;
1964ab31a845Sdan   }
1965ab31a845Sdan 
1966ab31a845Sdan   return exprNodeIsConstant(pWalker, pExpr);
1967ab31a845Sdan }
1968ab31a845Sdan 
1969ab31a845Sdan /*
1970ab31a845Sdan ** Walk the expression tree passed as the first argument. Return non-zero
1971ab31a845Sdan ** if the expression consists entirely of constants or copies of terms
1972ab31a845Sdan ** in pGroupBy that sort with the BINARY collation sequence.
1973ab314001Sdrh **
1974ab314001Sdrh ** This routine is used to determine if a term of the HAVING clause can
1975ab314001Sdrh ** be promoted into the WHERE clause.  In order for such a promotion to work,
1976ab314001Sdrh ** the value of the HAVING clause term must be the same for all members of
1977ab314001Sdrh ** a "group".  The requirement that the GROUP BY term must be BINARY
1978ab314001Sdrh ** assumes that no other collating sequence will have a finer-grained
1979ab314001Sdrh ** grouping than binary.  In other words (A=B COLLATE binary) implies
1980ab314001Sdrh ** A=B in every other collating sequence.  The requirement that the
1981ab314001Sdrh ** GROUP BY be BINARY is stricter than necessary.  It would also work
1982ab314001Sdrh ** to promote HAVING clauses that use the same alternative collating
1983ab314001Sdrh ** sequence as the GROUP BY term, but that is much harder to check,
1984ab314001Sdrh ** alternative collating sequences are uncommon, and this is only an
1985ab314001Sdrh ** optimization, so we take the easy way out and simply require the
1986ab314001Sdrh ** GROUP BY to use the BINARY collating sequence.
1987ab31a845Sdan */
1988ab31a845Sdan int sqlite3ExprIsConstantOrGroupBy(Parse *pParse, Expr *p, ExprList *pGroupBy){
1989ab31a845Sdan   Walker w;
1990ab31a845Sdan   w.eCode = 1;
1991ab31a845Sdan   w.xExprCallback = exprNodeIsConstantOrGroupBy;
1992979dd1beSdrh   w.xSelectCallback = 0;
1993ab31a845Sdan   w.u.pGroupBy = pGroupBy;
1994ab31a845Sdan   w.pParse = pParse;
1995ab31a845Sdan   sqlite3WalkExpr(&w, p);
1996ab31a845Sdan   return w.eCode;
1997ab31a845Sdan }
1998ab31a845Sdan 
1999059b2d50Sdrh /*
2000059b2d50Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
2001eb55bd2fSdrh ** or a function call with constant arguments.  Return and 0 if there
2002eb55bd2fSdrh ** are any variables.
2003eb55bd2fSdrh **
2004eb55bd2fSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
2005eb55bd2fSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
2006eb55bd2fSdrh ** a constant.
2007eb55bd2fSdrh */
2008feada2dfSdrh int sqlite3ExprIsConstantOrFunction(Expr *p, u8 isInit){
2009feada2dfSdrh   assert( isInit==0 || isInit==1 );
2010059b2d50Sdrh   return exprIsConst(p, 4+isInit, 0);
2011eb55bd2fSdrh }
2012eb55bd2fSdrh 
20135b88bc4bSdrh #ifdef SQLITE_ENABLE_CURSOR_HINTS
20145b88bc4bSdrh /*
20155b88bc4bSdrh ** Walk an expression tree.  Return 1 if the expression contains a
20165b88bc4bSdrh ** subquery of some kind.  Return 0 if there are no subqueries.
20175b88bc4bSdrh */
20185b88bc4bSdrh int sqlite3ExprContainsSubquery(Expr *p){
20195b88bc4bSdrh   Walker w;
2020bec2476aSdrh   w.eCode = 1;
20215b88bc4bSdrh   w.xExprCallback = sqlite3ExprWalkNoop;
20227e6f980bSdrh   w.xSelectCallback = sqlite3SelectWalkFail;
2023979dd1beSdrh #ifdef SQLITE_DEBUG
2024979dd1beSdrh   w.xSelectCallback2 = sqlite3SelectWalkAssert2;
2025979dd1beSdrh #endif
20265b88bc4bSdrh   sqlite3WalkExpr(&w, p);
202707194bffSdrh   return w.eCode==0;
20285b88bc4bSdrh }
20295b88bc4bSdrh #endif
20305b88bc4bSdrh 
2031eb55bd2fSdrh /*
203273b211abSdrh ** If the expression p codes a constant integer that is small enough
2033202b2df7Sdrh ** to fit in a 32-bit integer, return 1 and put the value of the integer
2034202b2df7Sdrh ** in *pValue.  If the expression is not an integer or if it is too big
2035202b2df7Sdrh ** to fit in a signed 32-bit integer, return 0 and leave *pValue unchanged.
2036e4de1febSdrh */
20374adee20fSdanielk1977 int sqlite3ExprIsInteger(Expr *p, int *pValue){
203892b01d53Sdrh   int rc = 0;
2039ba28b5abSdrh   if( p==0 ) return 0;  /* Can only happen following on OOM */
2040cd92e84dSdrh 
2041cd92e84dSdrh   /* If an expression is an integer literal that fits in a signed 32-bit
2042cd92e84dSdrh   ** integer, then the EP_IntValue flag will have already been set */
2043cd92e84dSdrh   assert( p->op!=TK_INTEGER || (p->flags & EP_IntValue)!=0
2044cd92e84dSdrh            || sqlite3GetInt32(p->u.zToken, &rc)==0 );
2045cd92e84dSdrh 
204692b01d53Sdrh   if( p->flags & EP_IntValue ){
204733e619fcSdrh     *pValue = p->u.iValue;
2048e4de1febSdrh     return 1;
2049e4de1febSdrh   }
205092b01d53Sdrh   switch( p->op ){
20514b59ab5eSdrh     case TK_UPLUS: {
205292b01d53Sdrh       rc = sqlite3ExprIsInteger(p->pLeft, pValue);
2053f6e369a1Sdrh       break;
20544b59ab5eSdrh     }
2055e4de1febSdrh     case TK_UMINUS: {
2056e4de1febSdrh       int v;
20574adee20fSdanielk1977       if( sqlite3ExprIsInteger(p->pLeft, &v) ){
2058f6418891Smistachkin         assert( v!=(-2147483647-1) );
2059e4de1febSdrh         *pValue = -v;
206092b01d53Sdrh         rc = 1;
2061e4de1febSdrh       }
2062e4de1febSdrh       break;
2063e4de1febSdrh     }
2064e4de1febSdrh     default: break;
2065e4de1febSdrh   }
206692b01d53Sdrh   return rc;
2067e4de1febSdrh }
2068e4de1febSdrh 
2069e4de1febSdrh /*
2070039fc32eSdrh ** Return FALSE if there is no chance that the expression can be NULL.
2071039fc32eSdrh **
2072039fc32eSdrh ** If the expression might be NULL or if the expression is too complex
2073039fc32eSdrh ** to tell return TRUE.
2074039fc32eSdrh **
2075039fc32eSdrh ** This routine is used as an optimization, to skip OP_IsNull opcodes
2076039fc32eSdrh ** when we know that a value cannot be NULL.  Hence, a false positive
2077039fc32eSdrh ** (returning TRUE when in fact the expression can never be NULL) might
2078039fc32eSdrh ** be a small performance hit but is otherwise harmless.  On the other
2079039fc32eSdrh ** hand, a false negative (returning FALSE when the result could be NULL)
2080039fc32eSdrh ** will likely result in an incorrect answer.  So when in doubt, return
2081039fc32eSdrh ** TRUE.
2082039fc32eSdrh */
2083039fc32eSdrh int sqlite3ExprCanBeNull(const Expr *p){
2084039fc32eSdrh   u8 op;
2085cd7f457eSdrh   while( p->op==TK_UPLUS || p->op==TK_UMINUS ){ p = p->pLeft; }
2086039fc32eSdrh   op = p->op;
2087039fc32eSdrh   if( op==TK_REGISTER ) op = p->op2;
2088039fc32eSdrh   switch( op ){
2089039fc32eSdrh     case TK_INTEGER:
2090039fc32eSdrh     case TK_STRING:
2091039fc32eSdrh     case TK_FLOAT:
2092039fc32eSdrh     case TK_BLOB:
2093039fc32eSdrh       return 0;
20947248a8b2Sdrh     case TK_COLUMN:
209572673a24Sdrh       return ExprHasProperty(p, EP_CanBeNull) ||
2096*eda079cdSdrh              p->y.pTab==0 ||  /* Reference to column of index on expression */
2097*eda079cdSdrh              (p->iColumn>=0 && p->y.pTab->aCol[p->iColumn].notNull==0);
2098039fc32eSdrh     default:
2099039fc32eSdrh       return 1;
2100039fc32eSdrh   }
2101039fc32eSdrh }
2102039fc32eSdrh 
2103039fc32eSdrh /*
2104039fc32eSdrh ** Return TRUE if the given expression is a constant which would be
2105039fc32eSdrh ** unchanged by OP_Affinity with the affinity given in the second
2106039fc32eSdrh ** argument.
2107039fc32eSdrh **
2108039fc32eSdrh ** This routine is used to determine if the OP_Affinity operation
2109039fc32eSdrh ** can be omitted.  When in doubt return FALSE.  A false negative
2110039fc32eSdrh ** is harmless.  A false positive, however, can result in the wrong
2111039fc32eSdrh ** answer.
2112039fc32eSdrh */
2113039fc32eSdrh int sqlite3ExprNeedsNoAffinityChange(const Expr *p, char aff){
2114039fc32eSdrh   u8 op;
211505883a34Sdrh   if( aff==SQLITE_AFF_BLOB ) return 1;
2116cd7f457eSdrh   while( p->op==TK_UPLUS || p->op==TK_UMINUS ){ p = p->pLeft; }
2117039fc32eSdrh   op = p->op;
2118039fc32eSdrh   if( op==TK_REGISTER ) op = p->op2;
2119039fc32eSdrh   switch( op ){
2120039fc32eSdrh     case TK_INTEGER: {
2121039fc32eSdrh       return aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC;
2122039fc32eSdrh     }
2123039fc32eSdrh     case TK_FLOAT: {
2124039fc32eSdrh       return aff==SQLITE_AFF_REAL || aff==SQLITE_AFF_NUMERIC;
2125039fc32eSdrh     }
2126039fc32eSdrh     case TK_STRING: {
2127039fc32eSdrh       return aff==SQLITE_AFF_TEXT;
2128039fc32eSdrh     }
2129039fc32eSdrh     case TK_BLOB: {
2130039fc32eSdrh       return 1;
2131039fc32eSdrh     }
21322f2855b6Sdrh     case TK_COLUMN: {
213388376ca7Sdrh       assert( p->iTable>=0 );  /* p cannot be part of a CHECK constraint */
213488376ca7Sdrh       return p->iColumn<0
21352f2855b6Sdrh           && (aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC);
21362f2855b6Sdrh     }
2137039fc32eSdrh     default: {
2138039fc32eSdrh       return 0;
2139039fc32eSdrh     }
2140039fc32eSdrh   }
2141039fc32eSdrh }
2142039fc32eSdrh 
2143039fc32eSdrh /*
2144c4a3c779Sdrh ** Return TRUE if the given string is a row-id column name.
2145c4a3c779Sdrh */
21464adee20fSdanielk1977 int sqlite3IsRowid(const char *z){
21474adee20fSdanielk1977   if( sqlite3StrICmp(z, "_ROWID_")==0 ) return 1;
21484adee20fSdanielk1977   if( sqlite3StrICmp(z, "ROWID")==0 ) return 1;
21494adee20fSdanielk1977   if( sqlite3StrICmp(z, "OID")==0 ) return 1;
2150c4a3c779Sdrh   return 0;
2151c4a3c779Sdrh }
2152c4a3c779Sdrh 
21539a96b668Sdanielk1977 /*
215469c355bdSdrh ** pX is the RHS of an IN operator.  If pX is a SELECT statement
215569c355bdSdrh ** that can be simplified to a direct table access, then return
215669c355bdSdrh ** a pointer to the SELECT statement.  If pX is not a SELECT statement,
215769c355bdSdrh ** or if the SELECT statement needs to be manifested into a transient
215869c355bdSdrh ** table, then return NULL.
2159b287f4b6Sdrh */
2160b287f4b6Sdrh #ifndef SQLITE_OMIT_SUBQUERY
21617b35a77bSdan static Select *isCandidateForInOpt(Expr *pX){
216269c355bdSdrh   Select *p;
2163b287f4b6Sdrh   SrcList *pSrc;
2164b287f4b6Sdrh   ExprList *pEList;
2165b287f4b6Sdrh   Table *pTab;
2166cfbb5e82Sdan   int i;
216769c355bdSdrh   if( !ExprHasProperty(pX, EP_xIsSelect) ) return 0;  /* Not a subquery */
216869c355bdSdrh   if( ExprHasProperty(pX, EP_VarSelect)  ) return 0;  /* Correlated subq */
216969c355bdSdrh   p = pX->x.pSelect;
2170b287f4b6Sdrh   if( p->pPrior ) return 0;              /* Not a compound SELECT */
21717d10d5a6Sdrh   if( p->selFlags & (SF_Distinct|SF_Aggregate) ){
2172b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
2173b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
21747d10d5a6Sdrh     return 0; /* No DISTINCT keyword and no aggregate functions */
21757d10d5a6Sdrh   }
2176b74b1017Sdrh   assert( p->pGroupBy==0 );              /* Has no GROUP BY clause */
2177b287f4b6Sdrh   if( p->pLimit ) return 0;              /* Has no LIMIT clause */
2178b287f4b6Sdrh   if( p->pWhere ) return 0;              /* Has no WHERE clause */
2179b287f4b6Sdrh   pSrc = p->pSrc;
2180d1fa7bcaSdrh   assert( pSrc!=0 );
2181d1fa7bcaSdrh   if( pSrc->nSrc!=1 ) return 0;          /* Single term in FROM clause */
2182b74b1017Sdrh   if( pSrc->a[0].pSelect ) return 0;     /* FROM is not a subquery or view */
2183b287f4b6Sdrh   pTab = pSrc->a[0].pTab;
218469c355bdSdrh   assert( pTab!=0 );
2185b74b1017Sdrh   assert( pTab->pSelect==0 );            /* FROM clause is not a view */
2186b287f4b6Sdrh   if( IsVirtual(pTab) ) return 0;        /* FROM clause not a virtual table */
2187b287f4b6Sdrh   pEList = p->pEList;
2188ac6b47d1Sdrh   assert( pEList!=0 );
21897b35a77bSdan   /* All SELECT results must be columns. */
2190cfbb5e82Sdan   for(i=0; i<pEList->nExpr; i++){
2191cfbb5e82Sdan     Expr *pRes = pEList->a[i].pExpr;
2192cfbb5e82Sdan     if( pRes->op!=TK_COLUMN ) return 0;
219369c355bdSdrh     assert( pRes->iTable==pSrc->a[0].iCursor );  /* Not a correlated subquery */
2194cfbb5e82Sdan   }
219569c355bdSdrh   return p;
2196b287f4b6Sdrh }
2197b287f4b6Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
2198b287f4b6Sdrh 
2199f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
22001d8cb21fSdan /*
22014c259e9fSdrh ** Generate code that checks the left-most column of index table iCur to see if
22024c259e9fSdrh ** it contains any NULL entries.  Cause the register at regHasNull to be set
22036be515ebSdrh ** to a non-NULL value if iCur contains no NULLs.  Cause register regHasNull
22046be515ebSdrh ** to be set to NULL if iCur contains one or more NULL values.
22056be515ebSdrh */
22066be515ebSdrh static void sqlite3SetHasNullFlag(Vdbe *v, int iCur, int regHasNull){
2207728e0f91Sdrh   int addr1;
22086be515ebSdrh   sqlite3VdbeAddOp2(v, OP_Integer, 0, regHasNull);
2209728e0f91Sdrh   addr1 = sqlite3VdbeAddOp1(v, OP_Rewind, iCur); VdbeCoverage(v);
22106be515ebSdrh   sqlite3VdbeAddOp3(v, OP_Column, iCur, 0, regHasNull);
22116be515ebSdrh   sqlite3VdbeChangeP5(v, OPFLAG_TYPEOFARG);
22124c259e9fSdrh   VdbeComment((v, "first_entry_in(%d)", iCur));
2213728e0f91Sdrh   sqlite3VdbeJumpHere(v, addr1);
22146be515ebSdrh }
2215f9b2e05cSdan #endif
22166be515ebSdrh 
2217bb53ecb1Sdrh 
2218bb53ecb1Sdrh #ifndef SQLITE_OMIT_SUBQUERY
2219bb53ecb1Sdrh /*
2220bb53ecb1Sdrh ** The argument is an IN operator with a list (not a subquery) on the
2221bb53ecb1Sdrh ** right-hand side.  Return TRUE if that list is constant.
2222bb53ecb1Sdrh */
2223bb53ecb1Sdrh static int sqlite3InRhsIsConstant(Expr *pIn){
2224bb53ecb1Sdrh   Expr *pLHS;
2225bb53ecb1Sdrh   int res;
2226bb53ecb1Sdrh   assert( !ExprHasProperty(pIn, EP_xIsSelect) );
2227bb53ecb1Sdrh   pLHS = pIn->pLeft;
2228bb53ecb1Sdrh   pIn->pLeft = 0;
2229bb53ecb1Sdrh   res = sqlite3ExprIsConstant(pIn);
2230bb53ecb1Sdrh   pIn->pLeft = pLHS;
2231bb53ecb1Sdrh   return res;
2232bb53ecb1Sdrh }
2233bb53ecb1Sdrh #endif
2234bb53ecb1Sdrh 
22356be515ebSdrh /*
22369a96b668Sdanielk1977 ** This function is used by the implementation of the IN (...) operator.
2237d4305ca6Sdrh ** The pX parameter is the expression on the RHS of the IN operator, which
2238d4305ca6Sdrh ** might be either a list of expressions or a subquery.
22399a96b668Sdanielk1977 **
2240d4305ca6Sdrh ** The job of this routine is to find or create a b-tree object that can
2241d4305ca6Sdrh ** be used either to test for membership in the RHS set or to iterate through
2242d4305ca6Sdrh ** all members of the RHS set, skipping duplicates.
2243d4305ca6Sdrh **
22443a85625dSdrh ** A cursor is opened on the b-tree object that is the RHS of the IN operator
2245d4305ca6Sdrh ** and pX->iTable is set to the index of that cursor.
2246d4305ca6Sdrh **
2247b74b1017Sdrh ** The returned value of this function indicates the b-tree type, as follows:
22489a96b668Sdanielk1977 **
22499a96b668Sdanielk1977 **   IN_INDEX_ROWID      - The cursor was opened on a database table.
22501ccce449Sdrh **   IN_INDEX_INDEX_ASC  - The cursor was opened on an ascending index.
22511ccce449Sdrh **   IN_INDEX_INDEX_DESC - The cursor was opened on a descending index.
22529a96b668Sdanielk1977 **   IN_INDEX_EPH        - The cursor was opened on a specially created and
22539a96b668Sdanielk1977 **                         populated epheremal table.
2254bb53ecb1Sdrh **   IN_INDEX_NOOP       - No cursor was allocated.  The IN operator must be
2255bb53ecb1Sdrh **                         implemented as a sequence of comparisons.
22569a96b668Sdanielk1977 **
2257d4305ca6Sdrh ** An existing b-tree might be used if the RHS expression pX is a simple
2258d4305ca6Sdrh ** subquery such as:
22599a96b668Sdanielk1977 **
2260553168c7Sdan **     SELECT <column1>, <column2>... FROM <table>
22619a96b668Sdanielk1977 **
2262d4305ca6Sdrh ** If the RHS of the IN operator is a list or a more complex subquery, then
2263d4305ca6Sdrh ** an ephemeral table might need to be generated from the RHS and then
226460ec914cSpeter.d.reid ** pX->iTable made to point to the ephemeral table instead of an
2265d4305ca6Sdrh ** existing table.
2266d4305ca6Sdrh **
22677fc0ba0fSdrh ** The inFlags parameter must contain, at a minimum, one of the bits
22687fc0ba0fSdrh ** IN_INDEX_MEMBERSHIP or IN_INDEX_LOOP but not both.  If inFlags contains
22697fc0ba0fSdrh ** IN_INDEX_MEMBERSHIP, then the generated table will be used for a fast
22707fc0ba0fSdrh ** membership test.  When the IN_INDEX_LOOP bit is set, the IN index will
22717fc0ba0fSdrh ** be used to loop over all values of the RHS of the IN operator.
22723a85625dSdrh **
22733a85625dSdrh ** When IN_INDEX_LOOP is used (and the b-tree will be used to iterate
22743a85625dSdrh ** through the set members) then the b-tree must not contain duplicates.
22757fc0ba0fSdrh ** An epheremal table will be created unless the selected columns are guaranteed
2276553168c7Sdan ** to be unique - either because it is an INTEGER PRIMARY KEY or due to
2277553168c7Sdan ** a UNIQUE constraint or index.
22780cdc022eSdanielk1977 **
22793a85625dSdrh ** When IN_INDEX_MEMBERSHIP is used (and the b-tree will be used
22803a85625dSdrh ** for fast set membership tests) then an epheremal table must
2281553168c7Sdan ** be used unless <columns> is a single INTEGER PRIMARY KEY column or an
2282553168c7Sdan ** index can be found with the specified <columns> as its left-most.
22830cdc022eSdanielk1977 **
2284bb53ecb1Sdrh ** If the IN_INDEX_NOOP_OK and IN_INDEX_MEMBERSHIP are both set and
2285bb53ecb1Sdrh ** if the RHS of the IN operator is a list (not a subquery) then this
2286bb53ecb1Sdrh ** routine might decide that creating an ephemeral b-tree for membership
2287bb53ecb1Sdrh ** testing is too expensive and return IN_INDEX_NOOP.  In that case, the
2288bb53ecb1Sdrh ** calling routine should implement the IN operator using a sequence
2289bb53ecb1Sdrh ** of Eq or Ne comparison operations.
2290bb53ecb1Sdrh **
2291b74b1017Sdrh ** When the b-tree is being used for membership tests, the calling function
22923a85625dSdrh ** might need to know whether or not the RHS side of the IN operator
2293e21a6e1dSdrh ** contains a NULL.  If prRhsHasNull is not a NULL pointer and
22943a85625dSdrh ** if there is any chance that the (...) might contain a NULL value at
22950cdc022eSdanielk1977 ** runtime, then a register is allocated and the register number written
2296e21a6e1dSdrh ** to *prRhsHasNull. If there is no chance that the (...) contains a
2297e21a6e1dSdrh ** NULL value, then *prRhsHasNull is left unchanged.
22980cdc022eSdanielk1977 **
2299e21a6e1dSdrh ** If a register is allocated and its location stored in *prRhsHasNull, then
23006be515ebSdrh ** the value in that register will be NULL if the b-tree contains one or more
23016be515ebSdrh ** NULL values, and it will be some non-NULL value if the b-tree contains no
23026be515ebSdrh ** NULL values.
2303553168c7Sdan **
2304553168c7Sdan ** If the aiMap parameter is not NULL, it must point to an array containing
2305553168c7Sdan ** one element for each column returned by the SELECT statement on the RHS
2306553168c7Sdan ** of the IN(...) operator. The i'th entry of the array is populated with the
2307553168c7Sdan ** offset of the index column that matches the i'th column returned by the
2308553168c7Sdan ** SELECT. For example, if the expression and selected index are:
2309553168c7Sdan **
2310553168c7Sdan **   (?,?,?) IN (SELECT a, b, c FROM t1)
2311553168c7Sdan **   CREATE INDEX i1 ON t1(b, c, a);
2312553168c7Sdan **
2313553168c7Sdan ** then aiMap[] is populated with {2, 0, 1}.
23149a96b668Sdanielk1977 */
2315284f4acaSdanielk1977 #ifndef SQLITE_OMIT_SUBQUERY
2316ba00e30aSdan int sqlite3FindInIndex(
23176fc8f364Sdrh   Parse *pParse,             /* Parsing context */
23186fc8f364Sdrh   Expr *pX,                  /* The right-hand side (RHS) of the IN operator */
23196fc8f364Sdrh   u32 inFlags,               /* IN_INDEX_LOOP, _MEMBERSHIP, and/or _NOOP_OK */
23206fc8f364Sdrh   int *prRhsHasNull,         /* Register holding NULL status.  See notes */
23216fc8f364Sdrh   int *aiMap                 /* Mapping from Index fields to RHS fields */
2322ba00e30aSdan ){
2323b74b1017Sdrh   Select *p;                            /* SELECT to the right of IN operator */
2324b74b1017Sdrh   int eType = 0;                        /* Type of RHS table. IN_INDEX_* */
2325b74b1017Sdrh   int iTab = pParse->nTab++;            /* Cursor of the RHS table */
23263a85625dSdrh   int mustBeUnique;                     /* True if RHS must be unique */
2327b8475df8Sdrh   Vdbe *v = sqlite3GetVdbe(pParse);     /* Virtual machine being coded */
23289a96b668Sdanielk1977 
23291450bc6eSdrh   assert( pX->op==TK_IN );
23303a85625dSdrh   mustBeUnique = (inFlags & IN_INDEX_LOOP)!=0;
23311450bc6eSdrh 
23327b35a77bSdan   /* If the RHS of this IN(...) operator is a SELECT, and if it matters
23337b35a77bSdan   ** whether or not the SELECT result contains NULL values, check whether
2334870a0705Sdan   ** or not NULL is actually possible (it may not be, for example, due
23357b35a77bSdan   ** to NOT NULL constraints in the schema). If no NULL values are possible,
2336870a0705Sdan   ** set prRhsHasNull to 0 before continuing.  */
23377b35a77bSdan   if( prRhsHasNull && (pX->flags & EP_xIsSelect) ){
23387b35a77bSdan     int i;
23397b35a77bSdan     ExprList *pEList = pX->x.pSelect->pEList;
23407b35a77bSdan     for(i=0; i<pEList->nExpr; i++){
23417b35a77bSdan       if( sqlite3ExprCanBeNull(pEList->a[i].pExpr) ) break;
23427b35a77bSdan     }
23437b35a77bSdan     if( i==pEList->nExpr ){
23447b35a77bSdan       prRhsHasNull = 0;
23457b35a77bSdan     }
23467b35a77bSdan   }
23477b35a77bSdan 
2348b74b1017Sdrh   /* Check to see if an existing table or index can be used to
2349b74b1017Sdrh   ** satisfy the query.  This is preferable to generating a new
23507b35a77bSdan   ** ephemeral table.  */
23517b35a77bSdan   if( pParse->nErr==0 && (p = isCandidateForInOpt(pX))!=0 ){
2352e1fb65a0Sdanielk1977     sqlite3 *db = pParse->db;              /* Database connection */
2353b07028f7Sdrh     Table *pTab;                           /* Table <table>. */
2354ba00e30aSdan     i16 iDb;                               /* Database idx for pTab */
2355cfbb5e82Sdan     ExprList *pEList = p->pEList;
2356cfbb5e82Sdan     int nExpr = pEList->nExpr;
2357e1fb65a0Sdanielk1977 
2358b07028f7Sdrh     assert( p->pEList!=0 );             /* Because of isCandidateForInOpt(p) */
2359b07028f7Sdrh     assert( p->pEList->a[0].pExpr!=0 ); /* Because of isCandidateForInOpt(p) */
2360b07028f7Sdrh     assert( p->pSrc!=0 );               /* Because of isCandidateForInOpt(p) */
2361b07028f7Sdrh     pTab = p->pSrc->a[0].pTab;
2362b07028f7Sdrh 
2363b22f7c83Sdrh     /* Code an OP_Transaction and OP_TableLock for <table>. */
2364e1fb65a0Sdanielk1977     iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
2365e1fb65a0Sdanielk1977     sqlite3CodeVerifySchema(pParse, iDb);
2366e1fb65a0Sdanielk1977     sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
23679a96b668Sdanielk1977 
2368a84a283dSdrh     assert(v);  /* sqlite3GetVdbe() has always been previously called */
2369cfbb5e82Sdan     if( nExpr==1 && pEList->a[0].pExpr->iColumn<0 ){
237062659b2aSdrh       /* The "x IN (SELECT rowid FROM table)" case */
2371511f9e8dSdrh       int iAddr = sqlite3VdbeAddOp0(v, OP_Once);
23727d176105Sdrh       VdbeCoverage(v);
23739a96b668Sdanielk1977 
23749a96b668Sdanielk1977       sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
23759a96b668Sdanielk1977       eType = IN_INDEX_ROWID;
2376d8852095Sdrh       ExplainQueryPlan((pParse, 0,
2377d8852095Sdrh             "USING ROWID SEARCH ON TABLE %s FOR IN-OPERATOR",pTab->zName));
23789a96b668Sdanielk1977       sqlite3VdbeJumpHere(v, iAddr);
23799a96b668Sdanielk1977     }else{
2380e1fb65a0Sdanielk1977       Index *pIdx;                         /* Iterator variable */
2381cfbb5e82Sdan       int affinity_ok = 1;
2382cfbb5e82Sdan       int i;
2383cfbb5e82Sdan 
2384cfbb5e82Sdan       /* Check that the affinity that will be used to perform each
238562659b2aSdrh       ** comparison is the same as the affinity of each column in table
238662659b2aSdrh       ** on the RHS of the IN operator.  If it not, it is not possible to
238762659b2aSdrh       ** use any index of the RHS table.  */
2388cfbb5e82Sdan       for(i=0; i<nExpr && affinity_ok; i++){
2389fc7f27b9Sdrh         Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2390cfbb5e82Sdan         int iCol = pEList->a[i].pExpr->iColumn;
23910dfa4f6fSdrh         char idxaff = sqlite3TableColumnAffinity(pTab,iCol); /* RHS table */
2392cfbb5e82Sdan         char cmpaff = sqlite3CompareAffinity(pLhs, idxaff);
239362659b2aSdrh         testcase( cmpaff==SQLITE_AFF_BLOB );
239462659b2aSdrh         testcase( cmpaff==SQLITE_AFF_TEXT );
2395cfbb5e82Sdan         switch( cmpaff ){
2396cfbb5e82Sdan           case SQLITE_AFF_BLOB:
2397cfbb5e82Sdan             break;
2398cfbb5e82Sdan           case SQLITE_AFF_TEXT:
239962659b2aSdrh             /* sqlite3CompareAffinity() only returns TEXT if one side or the
240062659b2aSdrh             ** other has no affinity and the other side is TEXT.  Hence,
240162659b2aSdrh             ** the only way for cmpaff to be TEXT is for idxaff to be TEXT
240262659b2aSdrh             ** and for the term on the LHS of the IN to have no affinity. */
240362659b2aSdrh             assert( idxaff==SQLITE_AFF_TEXT );
2404cfbb5e82Sdan             break;
2405cfbb5e82Sdan           default:
2406cfbb5e82Sdan             affinity_ok = sqlite3IsNumericAffinity(idxaff);
2407cfbb5e82Sdan         }
2408cfbb5e82Sdan       }
2409e1fb65a0Sdanielk1977 
2410a84a283dSdrh       if( affinity_ok ){
2411a84a283dSdrh         /* Search for an existing index that will work for this IN operator */
2412a84a283dSdrh         for(pIdx=pTab->pIndex; pIdx && eType==0; pIdx=pIdx->pNext){
2413a84a283dSdrh           Bitmask colUsed;      /* Columns of the index used */
2414a84a283dSdrh           Bitmask mCol;         /* Mask for the current column */
24156fc8f364Sdrh           if( pIdx->nColumn<nExpr ) continue;
2416a84a283dSdrh           /* Maximum nColumn is BMS-2, not BMS-1, so that we can compute
2417a84a283dSdrh           ** BITMASK(nExpr) without overflowing */
2418a84a283dSdrh           testcase( pIdx->nColumn==BMS-2 );
2419a84a283dSdrh           testcase( pIdx->nColumn==BMS-1 );
2420a84a283dSdrh           if( pIdx->nColumn>=BMS-1 ) continue;
24216fc8f364Sdrh           if( mustBeUnique ){
24226fc8f364Sdrh             if( pIdx->nKeyCol>nExpr
24236fc8f364Sdrh              ||(pIdx->nColumn>nExpr && !IsUniqueIndex(pIdx))
24246fc8f364Sdrh             ){
2425a84a283dSdrh               continue;  /* This index is not unique over the IN RHS columns */
2426cfbb5e82Sdan             }
24276fc8f364Sdrh           }
2428cfbb5e82Sdan 
2429a84a283dSdrh           colUsed = 0;   /* Columns of index used so far */
2430cfbb5e82Sdan           for(i=0; i<nExpr; i++){
2431fc7f27b9Sdrh             Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2432cfbb5e82Sdan             Expr *pRhs = pEList->a[i].pExpr;
2433cfbb5e82Sdan             CollSeq *pReq = sqlite3BinaryCompareCollSeq(pParse, pLhs, pRhs);
2434cfbb5e82Sdan             int j;
2435cfbb5e82Sdan 
24366fc8f364Sdrh             assert( pReq!=0 || pRhs->iColumn==XN_ROWID || pParse->nErr );
2437cfbb5e82Sdan             for(j=0; j<nExpr; j++){
2438cfbb5e82Sdan               if( pIdx->aiColumn[j]!=pRhs->iColumn ) continue;
2439cfbb5e82Sdan               assert( pIdx->azColl[j] );
2440106526e1Sdrh               if( pReq!=0 && sqlite3StrICmp(pReq->zName, pIdx->azColl[j])!=0 ){
2441106526e1Sdrh                 continue;
2442106526e1Sdrh               }
2443cfbb5e82Sdan               break;
2444cfbb5e82Sdan             }
2445cfbb5e82Sdan             if( j==nExpr ) break;
2446a84a283dSdrh             mCol = MASKBIT(j);
2447a84a283dSdrh             if( mCol & colUsed ) break; /* Each column used only once */
2448a84a283dSdrh             colUsed |= mCol;
2449ba00e30aSdan             if( aiMap ) aiMap[i] = j;
2450cfbb5e82Sdan           }
2451cfbb5e82Sdan 
2452a84a283dSdrh           assert( i==nExpr || colUsed!=(MASKBIT(nExpr)-1) );
2453a84a283dSdrh           if( colUsed==(MASKBIT(nExpr)-1) ){
2454a84a283dSdrh             /* If we reach this point, that means the index pIdx is usable */
2455511f9e8dSdrh             int iAddr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
2456e2ca99c9Sdrh             ExplainQueryPlan((pParse, 0,
2457e2ca99c9Sdrh                               "USING INDEX %s FOR IN-OPERATOR",pIdx->zName));
24582ec2fb22Sdrh             sqlite3VdbeAddOp3(v, OP_OpenRead, iTab, pIdx->tnum, iDb);
24592ec2fb22Sdrh             sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
2460207872a4Sdanielk1977             VdbeComment((v, "%s", pIdx->zName));
24611ccce449Sdrh             assert( IN_INDEX_INDEX_DESC == IN_INDEX_INDEX_ASC+1 );
24621ccce449Sdrh             eType = IN_INDEX_INDEX_ASC + pIdx->aSortOrder[0];
24639a96b668Sdanielk1977 
24647b35a77bSdan             if( prRhsHasNull ){
24653480bfdaSdan #ifdef SQLITE_ENABLE_COLUMN_USED_MASK
2466cfbb5e82Sdan               i64 mask = (1<<nExpr)-1;
24673480bfdaSdan               sqlite3VdbeAddOp4Dup8(v, OP_ColumnsUsed,
2468cfbb5e82Sdan                   iTab, 0, 0, (u8*)&mask, P4_INT64);
24693480bfdaSdan #endif
2470b80dbdc2Sdrh               *prRhsHasNull = ++pParse->nMem;
24717b35a77bSdan               if( nExpr==1 ){
24726be515ebSdrh                 sqlite3SetHasNullFlag(v, iTab, *prRhsHasNull);
24730cdc022eSdanielk1977               }
24747b35a77bSdan             }
2475552fd454Sdrh             sqlite3VdbeJumpHere(v, iAddr);
24769a96b668Sdanielk1977           }
2477a84a283dSdrh         } /* End loop over indexes */
2478a84a283dSdrh       } /* End if( affinity_ok ) */
2479a84a283dSdrh     } /* End if not an rowid index */
2480a84a283dSdrh   } /* End attempt to optimize using an index */
24819a96b668Sdanielk1977 
2482bb53ecb1Sdrh   /* If no preexisting index is available for the IN clause
2483bb53ecb1Sdrh   ** and IN_INDEX_NOOP is an allowed reply
2484bb53ecb1Sdrh   ** and the RHS of the IN operator is a list, not a subquery
248571c57db0Sdan   ** and the RHS is not constant or has two or fewer terms,
248660ec914cSpeter.d.reid   ** then it is not worth creating an ephemeral table to evaluate
2487bb53ecb1Sdrh   ** the IN operator so return IN_INDEX_NOOP.
2488bb53ecb1Sdrh   */
2489bb53ecb1Sdrh   if( eType==0
2490bb53ecb1Sdrh    && (inFlags & IN_INDEX_NOOP_OK)
2491bb53ecb1Sdrh    && !ExprHasProperty(pX, EP_xIsSelect)
2492bb53ecb1Sdrh    && (!sqlite3InRhsIsConstant(pX) || pX->x.pList->nExpr<=2)
2493bb53ecb1Sdrh   ){
2494bb53ecb1Sdrh     eType = IN_INDEX_NOOP;
2495bb53ecb1Sdrh   }
2496bb53ecb1Sdrh 
24979a96b668Sdanielk1977   if( eType==0 ){
24984387006cSdrh     /* Could not find an existing table or index to use as the RHS b-tree.
2499b74b1017Sdrh     ** We will have to generate an ephemeral table to do the job.
2500b74b1017Sdrh     */
25018e23daf3Sdrh     u32 savedNQueryLoop = pParse->nQueryLoop;
25020cdc022eSdanielk1977     int rMayHaveNull = 0;
250341a05b7bSdanielk1977     eType = IN_INDEX_EPH;
25043a85625dSdrh     if( inFlags & IN_INDEX_LOOP ){
25054a5acf8eSdrh       pParse->nQueryLoop = 0;
2506c5cd1249Sdrh       if( pX->pLeft->iColumn<0 && !ExprHasProperty(pX, EP_xIsSelect) ){
250741a05b7bSdanielk1977         eType = IN_INDEX_ROWID;
25080cdc022eSdanielk1977       }
2509e21a6e1dSdrh     }else if( prRhsHasNull ){
2510e21a6e1dSdrh       *prRhsHasNull = rMayHaveNull = ++pParse->nMem;
2511cf4d38aaSdrh     }
251241a05b7bSdanielk1977     sqlite3CodeSubselect(pParse, pX, rMayHaveNull, eType==IN_INDEX_ROWID);
2513cf4d38aaSdrh     pParse->nQueryLoop = savedNQueryLoop;
25149a96b668Sdanielk1977   }else{
25159a96b668Sdanielk1977     pX->iTable = iTab;
25169a96b668Sdanielk1977   }
2517ba00e30aSdan 
2518ba00e30aSdan   if( aiMap && eType!=IN_INDEX_INDEX_ASC && eType!=IN_INDEX_INDEX_DESC ){
2519ba00e30aSdan     int i, n;
2520ba00e30aSdan     n = sqlite3ExprVectorSize(pX->pLeft);
2521ba00e30aSdan     for(i=0; i<n; i++) aiMap[i] = i;
2522ba00e30aSdan   }
25239a96b668Sdanielk1977   return eType;
25249a96b668Sdanielk1977 }
2525284f4acaSdanielk1977 #endif
2526626a879aSdrh 
2527f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
2528553168c7Sdan /*
2529553168c7Sdan ** Argument pExpr is an (?, ?...) IN(...) expression. This
2530553168c7Sdan ** function allocates and returns a nul-terminated string containing
2531553168c7Sdan ** the affinities to be used for each column of the comparison.
2532553168c7Sdan **
2533553168c7Sdan ** It is the responsibility of the caller to ensure that the returned
2534553168c7Sdan ** string is eventually freed using sqlite3DbFree().
2535553168c7Sdan */
253671c57db0Sdan static char *exprINAffinity(Parse *pParse, Expr *pExpr){
253771c57db0Sdan   Expr *pLeft = pExpr->pLeft;
253871c57db0Sdan   int nVal = sqlite3ExprVectorSize(pLeft);
2539553168c7Sdan   Select *pSelect = (pExpr->flags & EP_xIsSelect) ? pExpr->x.pSelect : 0;
254071c57db0Sdan   char *zRet;
254171c57db0Sdan 
2542553168c7Sdan   assert( pExpr->op==TK_IN );
25435c258dc1Sdrh   zRet = sqlite3DbMallocRaw(pParse->db, nVal+1);
254471c57db0Sdan   if( zRet ){
254571c57db0Sdan     int i;
254671c57db0Sdan     for(i=0; i<nVal; i++){
2547fc7f27b9Sdrh       Expr *pA = sqlite3VectorFieldSubexpr(pLeft, i);
2548553168c7Sdan       char a = sqlite3ExprAffinity(pA);
2549553168c7Sdan       if( pSelect ){
2550553168c7Sdan         zRet[i] = sqlite3CompareAffinity(pSelect->pEList->a[i].pExpr, a);
255171c57db0Sdan       }else{
2552553168c7Sdan         zRet[i] = a;
255371c57db0Sdan       }
255471c57db0Sdan     }
255571c57db0Sdan     zRet[nVal] = '\0';
255671c57db0Sdan   }
255771c57db0Sdan   return zRet;
255871c57db0Sdan }
2559f9b2e05cSdan #endif
256071c57db0Sdan 
25618da209b1Sdan #ifndef SQLITE_OMIT_SUBQUERY
25628da209b1Sdan /*
25638da209b1Sdan ** Load the Parse object passed as the first argument with an error
25648da209b1Sdan ** message of the form:
25658da209b1Sdan **
25668da209b1Sdan **   "sub-select returns N columns - expected M"
25678da209b1Sdan */
25688da209b1Sdan void sqlite3SubselectError(Parse *pParse, int nActual, int nExpect){
25698da209b1Sdan   const char *zFmt = "sub-select returns %d columns - expected %d";
25708da209b1Sdan   sqlite3ErrorMsg(pParse, zFmt, nActual, nExpect);
25718da209b1Sdan }
25728da209b1Sdan #endif
25738da209b1Sdan 
2574626a879aSdrh /*
257544c5604cSdan ** Expression pExpr is a vector that has been used in a context where
257644c5604cSdan ** it is not permitted. If pExpr is a sub-select vector, this routine
257744c5604cSdan ** loads the Parse object with a message of the form:
257844c5604cSdan **
257944c5604cSdan **   "sub-select returns N columns - expected 1"
258044c5604cSdan **
258144c5604cSdan ** Or, if it is a regular scalar vector:
258244c5604cSdan **
258344c5604cSdan **   "row value misused"
258444c5604cSdan */
258544c5604cSdan void sqlite3VectorErrorMsg(Parse *pParse, Expr *pExpr){
258644c5604cSdan #ifndef SQLITE_OMIT_SUBQUERY
258744c5604cSdan   if( pExpr->flags & EP_xIsSelect ){
258844c5604cSdan     sqlite3SubselectError(pParse, pExpr->x.pSelect->pEList->nExpr, 1);
258944c5604cSdan   }else
259044c5604cSdan #endif
259144c5604cSdan   {
259244c5604cSdan     sqlite3ErrorMsg(pParse, "row value misused");
259344c5604cSdan   }
259444c5604cSdan }
259544c5604cSdan 
259644c5604cSdan /*
2597d4187c71Sdrh ** Generate code for scalar subqueries used as a subquery expression, EXISTS,
2598d4187c71Sdrh ** or IN operators.  Examples:
2599626a879aSdrh **
26009cbe6352Sdrh **     (SELECT a FROM b)          -- subquery
26019cbe6352Sdrh **     EXISTS (SELECT a FROM b)   -- EXISTS subquery
26029cbe6352Sdrh **     x IN (4,5,11)              -- IN operator with list on right-hand side
26039cbe6352Sdrh **     x IN (SELECT a FROM b)     -- IN operator with subquery on the right
2604fef5208cSdrh **
26059cbe6352Sdrh ** The pExpr parameter describes the expression that contains the IN
26069cbe6352Sdrh ** operator or subquery.
260741a05b7bSdanielk1977 **
260841a05b7bSdanielk1977 ** If parameter isRowid is non-zero, then expression pExpr is guaranteed
260941a05b7bSdanielk1977 ** to be of the form "<rowid> IN (?, ?, ?)", where <rowid> is a reference
261041a05b7bSdanielk1977 ** to some integer key column of a table B-Tree. In this case, use an
261141a05b7bSdanielk1977 ** intkey B-Tree to store the set of IN(...) values instead of the usual
261241a05b7bSdanielk1977 ** (slower) variable length keys B-Tree.
2613fd773cf9Sdrh **
2614fd773cf9Sdrh ** If rMayHaveNull is non-zero, that means that the operation is an IN
2615fd773cf9Sdrh ** (not a SELECT or EXISTS) and that the RHS might contains NULLs.
26163a85625dSdrh ** All this routine does is initialize the register given by rMayHaveNull
26173a85625dSdrh ** to NULL.  Calling routines will take care of changing this register
26183a85625dSdrh ** value to non-NULL if the RHS is NULL-free.
26191450bc6eSdrh **
26201450bc6eSdrh ** For a SELECT or EXISTS operator, return the register that holds the
262139a11819Sdrh ** result.  For a multi-column SELECT, the result is stored in a contiguous
262239a11819Sdrh ** array of registers and the return value is the register of the left-most
262339a11819Sdrh ** result column.  Return 0 for IN operators or if an error occurs.
2624cce7d176Sdrh */
262551522cd3Sdrh #ifndef SQLITE_OMIT_SUBQUERY
26261450bc6eSdrh int sqlite3CodeSubselect(
2627fd773cf9Sdrh   Parse *pParse,          /* Parsing context */
2628fd773cf9Sdrh   Expr *pExpr,            /* The IN, SELECT, or EXISTS operator */
26296be515ebSdrh   int rHasNullFlag,       /* Register that records whether NULLs exist in RHS */
2630fd773cf9Sdrh   int isRowid             /* If true, LHS of IN operator is a rowid */
263141a05b7bSdanielk1977 ){
26326be515ebSdrh   int jmpIfDynamic = -1;                      /* One-time test address */
26331450bc6eSdrh   int rReg = 0;                           /* Register storing resulting */
2634b3bce662Sdanielk1977   Vdbe *v = sqlite3GetVdbe(pParse);
26351450bc6eSdrh   if( NEVER(v==0) ) return 0;
2636fc976065Sdanielk1977 
263739a11819Sdrh   /* The evaluation of the IN/EXISTS/SELECT must be repeated every time it
263839a11819Sdrh   ** is encountered if any of the following is true:
263957dbd7b3Sdrh   **
264057dbd7b3Sdrh   **    *  The right-hand side is a correlated subquery
264157dbd7b3Sdrh   **    *  The right-hand side is an expression list containing variables
264257dbd7b3Sdrh   **    *  We are inside a trigger
264357dbd7b3Sdrh   **
264457dbd7b3Sdrh   ** If all of the above are false, then we can run this code just once
264557dbd7b3Sdrh   ** save the results, and reuse the same result on subsequent invocations.
2646b3bce662Sdanielk1977   */
2647c5cd1249Sdrh   if( !ExprHasProperty(pExpr, EP_VarSelect) ){
2648511f9e8dSdrh     jmpIfDynamic = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
2649b3bce662Sdanielk1977   }
2650b3bce662Sdanielk1977 
2651cce7d176Sdrh   switch( pExpr->op ){
2652fef5208cSdrh     case TK_IN: {
2653b9bb7c18Sdrh       int addr;                   /* Address of OP_OpenEphemeral instruction */
2654d4187c71Sdrh       Expr *pLeft = pExpr->pLeft; /* the LHS of the IN operator */
2655323df790Sdrh       KeyInfo *pKeyInfo = 0;      /* Key information */
265671c57db0Sdan       int nVal;                   /* Size of vector pLeft */
2657d3d39e93Sdrh 
265871c57db0Sdan       nVal = sqlite3ExprVectorSize(pLeft);
2659553168c7Sdan       assert( !isRowid || nVal==1 );
2660e014a838Sdanielk1977 
2661e014a838Sdanielk1977       /* Whether this is an 'x IN(SELECT...)' or an 'x IN(<exprlist>)'
26628cff69dfSdrh       ** expression it is handled the same way.  An ephemeral table is
2663553168c7Sdan       ** filled with index keys representing the results from the
2664553168c7Sdan       ** SELECT or the <exprlist>.
2665fef5208cSdrh       **
2666e014a838Sdanielk1977       ** If the 'x' expression is a column value, or the SELECT...
2667e014a838Sdanielk1977       ** statement returns a column value, then the affinity of that
2668e014a838Sdanielk1977       ** column is used to build the index keys. If both 'x' and the
2669e014a838Sdanielk1977       ** SELECT... statement are columns, then numeric affinity is used
2670e014a838Sdanielk1977       ** if either column has NUMERIC or INTEGER affinity. If neither
2671e014a838Sdanielk1977       ** 'x' nor the SELECT... statement are columns, then numeric affinity
2672e014a838Sdanielk1977       ** is used.
2673fef5208cSdrh       */
2674832508b7Sdrh       pExpr->iTable = pParse->nTab++;
267571c57db0Sdan       addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral,
267671c57db0Sdan           pExpr->iTable, (isRowid?0:nVal));
267771c57db0Sdan       pKeyInfo = isRowid ? 0 : sqlite3KeyInfoAlloc(pParse->db, nVal, 1);
2678e014a838Sdanielk1977 
26796ab3a2ecSdanielk1977       if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2680e014a838Sdanielk1977         /* Case 1:     expr IN (SELECT ...)
2681e014a838Sdanielk1977         **
2682e014a838Sdanielk1977         ** Generate code to write the results of the select into the temporary
2683e014a838Sdanielk1977         ** table allocated and opened above.
2684e014a838Sdanielk1977         */
26854387006cSdrh         Select *pSelect = pExpr->x.pSelect;
268671c57db0Sdan         ExprList *pEList = pSelect->pEList;
26871013c932Sdrh 
2688e2ca99c9Sdrh         ExplainQueryPlan((pParse, 1, "%sLIST SUBQUERY",
2689e2ca99c9Sdrh             jmpIfDynamic>=0?"":"CORRELATED "
2690e2ca99c9Sdrh         ));
269141a05b7bSdanielk1977         assert( !isRowid );
269264bcb8cfSdrh         /* If the LHS and RHS of the IN operator do not match, that
269364bcb8cfSdrh         ** error will have been caught long before we reach this point. */
269464bcb8cfSdrh         if( ALWAYS(pEList->nExpr==nVal) ){
269571c57db0Sdan           SelectDest dest;
269671c57db0Sdan           int i;
26971013c932Sdrh           sqlite3SelectDestInit(&dest, SRT_Set, pExpr->iTable);
269871c57db0Sdan           dest.zAffSdst = exprINAffinity(pParse, pExpr);
26994387006cSdrh           pSelect->iLimit = 0;
27004387006cSdrh           testcase( pSelect->selFlags & SF_Distinct );
2701812ea833Sdrh           testcase( pKeyInfo==0 ); /* Caused by OOM in sqlite3KeyInfoAlloc() */
27024387006cSdrh           if( sqlite3Select(pParse, pSelect, &dest) ){
270371c57db0Sdan             sqlite3DbFree(pParse->db, dest.zAffSdst);
27042ec2fb22Sdrh             sqlite3KeyInfoUnref(pKeyInfo);
27051450bc6eSdrh             return 0;
270694ccde58Sdrh           }
270771c57db0Sdan           sqlite3DbFree(pParse->db, dest.zAffSdst);
2708812ea833Sdrh           assert( pKeyInfo!=0 ); /* OOM will cause exit after sqlite3Select() */
27093535ec3eSdrh           assert( pEList!=0 );
27103535ec3eSdrh           assert( pEList->nExpr>0 );
27112ec2fb22Sdrh           assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
271271c57db0Sdan           for(i=0; i<nVal; i++){
2713773d3afaSdan             Expr *p = sqlite3VectorFieldSubexpr(pLeft, i);
271471c57db0Sdan             pKeyInfo->aColl[i] = sqlite3BinaryCompareCollSeq(
271571c57db0Sdan                 pParse, p, pEList->a[i].pExpr
271671c57db0Sdan             );
271771c57db0Sdan           }
271871c57db0Sdan         }
2719a7d2db17Sdrh       }else if( ALWAYS(pExpr->x.pList!=0) ){
2720fef5208cSdrh         /* Case 2:     expr IN (exprlist)
2721fef5208cSdrh         **
2722e014a838Sdanielk1977         ** For each expression, build an index key from the evaluation and
2723e014a838Sdanielk1977         ** store it in the temporary table. If <expr> is a column, then use
2724e014a838Sdanielk1977         ** that columns affinity when building index keys. If <expr> is not
2725e014a838Sdanielk1977         ** a column, use numeric affinity.
2726fef5208cSdrh         */
272771c57db0Sdan         char affinity;            /* Affinity of the LHS of the IN */
2728e014a838Sdanielk1977         int i;
27296ab3a2ecSdanielk1977         ExprList *pList = pExpr->x.pList;
273057dbd7b3Sdrh         struct ExprList_item *pItem;
2731ecc31805Sdrh         int r1, r2, r3;
273271c57db0Sdan         affinity = sqlite3ExprAffinity(pLeft);
2733e014a838Sdanielk1977         if( !affinity ){
273405883a34Sdrh           affinity = SQLITE_AFF_BLOB;
2735e014a838Sdanielk1977         }
2736323df790Sdrh         if( pKeyInfo ){
27372ec2fb22Sdrh           assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
2738323df790Sdrh           pKeyInfo->aColl[0] = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
2739323df790Sdrh         }
2740e014a838Sdanielk1977 
2741e014a838Sdanielk1977         /* Loop through each expression in <exprlist>. */
27422d401ab8Sdrh         r1 = sqlite3GetTempReg(pParse);
27432d401ab8Sdrh         r2 = sqlite3GetTempReg(pParse);
274421cd29abSdan         if( isRowid ) sqlite3VdbeAddOp4(v, OP_Blob, 0, r2, 0, "", P4_STATIC);
274557dbd7b3Sdrh         for(i=pList->nExpr, pItem=pList->a; i>0; i--, pItem++){
274657dbd7b3Sdrh           Expr *pE2 = pItem->pExpr;
2747e05c929bSdrh           int iValToIns;
2748e014a838Sdanielk1977 
274957dbd7b3Sdrh           /* If the expression is not constant then we will need to
275057dbd7b3Sdrh           ** disable the test that was generated above that makes sure
275157dbd7b3Sdrh           ** this code only executes once.  Because for a non-constant
275257dbd7b3Sdrh           ** expression we need to rerun this code each time.
275357dbd7b3Sdrh           */
27546be515ebSdrh           if( jmpIfDynamic>=0 && !sqlite3ExprIsConstant(pE2) ){
27556be515ebSdrh             sqlite3VdbeChangeToNoop(v, jmpIfDynamic);
27566be515ebSdrh             jmpIfDynamic = -1;
27574794b980Sdrh           }
2758e014a838Sdanielk1977 
2759e014a838Sdanielk1977           /* Evaluate the expression and insert it into the temp table */
2760e05c929bSdrh           if( isRowid && sqlite3ExprIsInteger(pE2, &iValToIns) ){
2761e05c929bSdrh             sqlite3VdbeAddOp3(v, OP_InsertInt, pExpr->iTable, r2, iValToIns);
2762e05c929bSdrh           }else{
2763ecc31805Sdrh             r3 = sqlite3ExprCodeTarget(pParse, pE2, r1);
276441a05b7bSdanielk1977             if( isRowid ){
2765e05c929bSdrh               sqlite3VdbeAddOp2(v, OP_MustBeInt, r3,
2766e05c929bSdrh                                 sqlite3VdbeCurrentAddr(v)+2);
2767688852abSdrh               VdbeCoverage(v);
276841a05b7bSdanielk1977               sqlite3VdbeAddOp3(v, OP_Insert, pExpr->iTable, r2, r3);
276941a05b7bSdanielk1977             }else{
2770ecc31805Sdrh               sqlite3VdbeAddOp4(v, OP_MakeRecord, r3, 1, r2, &affinity, 1);
27719b4eaebcSdrh               sqlite3VdbeAddOp4Int(v, OP_IdxInsert, pExpr->iTable, r2, r3, 1);
2772fef5208cSdrh             }
277341a05b7bSdanielk1977           }
2774e05c929bSdrh         }
27752d401ab8Sdrh         sqlite3ReleaseTempReg(pParse, r1);
27762d401ab8Sdrh         sqlite3ReleaseTempReg(pParse, r2);
2777fef5208cSdrh       }
2778323df790Sdrh       if( pKeyInfo ){
27792ec2fb22Sdrh         sqlite3VdbeChangeP4(v, addr, (void *)pKeyInfo, P4_KEYINFO);
278041a05b7bSdanielk1977       }
2781b3bce662Sdanielk1977       break;
2782fef5208cSdrh     }
2783fef5208cSdrh 
278451522cd3Sdrh     case TK_EXISTS:
2785fd773cf9Sdrh     case TK_SELECT:
2786fd773cf9Sdrh     default: {
278739a11819Sdrh       /* Case 3:    (SELECT ... FROM ...)
278839a11819Sdrh       **     or:    EXISTS(SELECT ... FROM ...)
278939a11819Sdrh       **
279039a11819Sdrh       ** For a SELECT, generate code to put the values for all columns of
279139a11819Sdrh       ** the first row into an array of registers and return the index of
279239a11819Sdrh       ** the first register.
279339a11819Sdrh       **
279439a11819Sdrh       ** If this is an EXISTS, write an integer 0 (not exists) or 1 (exists)
279539a11819Sdrh       ** into a register and return that register number.
279639a11819Sdrh       **
279739a11819Sdrh       ** In both cases, the query is augmented with "LIMIT 1".  Any
279839a11819Sdrh       ** preexisting limit is discarded in place of the new LIMIT 1.
2799fef5208cSdrh       */
2800fd773cf9Sdrh       Select *pSel;                         /* SELECT statement to encode */
280139a11819Sdrh       SelectDest dest;                      /* How to deal with SELECT result */
280271c57db0Sdan       int nReg;                             /* Registers to allocate */
28038c0833fbSdrh       Expr *pLimit;                         /* New limit expression */
28041398ad36Sdrh 
2805cf697396Sshane       testcase( pExpr->op==TK_EXISTS );
2806cf697396Sshane       testcase( pExpr->op==TK_SELECT );
2807cf697396Sshane       assert( pExpr->op==TK_EXISTS || pExpr->op==TK_SELECT );
28086ab3a2ecSdanielk1977       assert( ExprHasProperty(pExpr, EP_xIsSelect) );
280971c57db0Sdan 
28106ab3a2ecSdanielk1977       pSel = pExpr->x.pSelect;
2811e2ca99c9Sdrh       ExplainQueryPlan((pParse, 1, "%sSCALAR SUBQUERY",
2812e2ca99c9Sdrh             jmpIfDynamic>=0?"":"CORRELATED "));
281371c57db0Sdan       nReg = pExpr->op==TK_SELECT ? pSel->pEList->nExpr : 1;
281471c57db0Sdan       sqlite3SelectDestInit(&dest, 0, pParse->nMem+1);
281571c57db0Sdan       pParse->nMem += nReg;
281651522cd3Sdrh       if( pExpr->op==TK_SELECT ){
28176c8c8ce0Sdanielk1977         dest.eDest = SRT_Mem;
281853932ce8Sdrh         dest.iSdst = dest.iSDParm;
281971c57db0Sdan         dest.nSdst = nReg;
282071c57db0Sdan         sqlite3VdbeAddOp3(v, OP_Null, 0, dest.iSDParm, dest.iSDParm+nReg-1);
2821d4e70ebdSdrh         VdbeComment((v, "Init subquery result"));
282251522cd3Sdrh       }else{
28236c8c8ce0Sdanielk1977         dest.eDest = SRT_Exists;
28242b596da8Sdrh         sqlite3VdbeAddOp2(v, OP_Integer, 0, dest.iSDParm);
2825d4e70ebdSdrh         VdbeComment((v, "Init EXISTS result"));
282651522cd3Sdrh       }
28278c0833fbSdrh       pLimit = sqlite3ExprAlloc(pParse->db, TK_INTEGER,&sqlite3IntTokens[1], 0);
28288c0833fbSdrh       if( pSel->pLimit ){
28298c0833fbSdrh         sqlite3ExprDelete(pParse->db, pSel->pLimit->pLeft);
28308c0833fbSdrh         pSel->pLimit->pLeft = pLimit;
28318c0833fbSdrh       }else{
28328c0833fbSdrh         pSel->pLimit = sqlite3PExpr(pParse, TK_LIMIT, pLimit, 0);
28338c0833fbSdrh       }
283448b5b041Sdrh       pSel->iLimit = 0;
28357d10d5a6Sdrh       if( sqlite3Select(pParse, pSel, &dest) ){
28361450bc6eSdrh         return 0;
283794ccde58Sdrh       }
28382b596da8Sdrh       rReg = dest.iSDParm;
2839ebb6a65dSdrh       ExprSetVVAProperty(pExpr, EP_NoReduce);
2840b3bce662Sdanielk1977       break;
284119a775c2Sdrh     }
2842cce7d176Sdrh   }
2843b3bce662Sdanielk1977 
28446be515ebSdrh   if( rHasNullFlag ){
28456be515ebSdrh     sqlite3SetHasNullFlag(v, pExpr->iTable, rHasNullFlag);
2846b3bce662Sdanielk1977   }
28476be515ebSdrh 
28486be515ebSdrh   if( jmpIfDynamic>=0 ){
28496be515ebSdrh     sqlite3VdbeJumpHere(v, jmpIfDynamic);
2850b3bce662Sdanielk1977   }
2851fc976065Sdanielk1977 
28521450bc6eSdrh   return rReg;
2853cce7d176Sdrh }
285451522cd3Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
2855cce7d176Sdrh 
2856e3365e6cSdrh #ifndef SQLITE_OMIT_SUBQUERY
2857e3365e6cSdrh /*
28587b35a77bSdan ** Expr pIn is an IN(...) expression. This function checks that the
28597b35a77bSdan ** sub-select on the RHS of the IN() operator has the same number of
28607b35a77bSdan ** columns as the vector on the LHS. Or, if the RHS of the IN() is not
28617b35a77bSdan ** a sub-query, that the LHS is a vector of size 1.
28627b35a77bSdan */
28637b35a77bSdan int sqlite3ExprCheckIN(Parse *pParse, Expr *pIn){
28647b35a77bSdan   int nVector = sqlite3ExprVectorSize(pIn->pLeft);
28657b35a77bSdan   if( (pIn->flags & EP_xIsSelect) ){
28667b35a77bSdan     if( nVector!=pIn->x.pSelect->pEList->nExpr ){
28677b35a77bSdan       sqlite3SubselectError(pParse, pIn->x.pSelect->pEList->nExpr, nVector);
28687b35a77bSdan       return 1;
28697b35a77bSdan     }
28707b35a77bSdan   }else if( nVector!=1 ){
287144c5604cSdan     sqlite3VectorErrorMsg(pParse, pIn->pLeft);
28727b35a77bSdan     return 1;
28737b35a77bSdan   }
28747b35a77bSdan   return 0;
28757b35a77bSdan }
28767b35a77bSdan #endif
28777b35a77bSdan 
28787b35a77bSdan #ifndef SQLITE_OMIT_SUBQUERY
28797b35a77bSdan /*
2880e3365e6cSdrh ** Generate code for an IN expression.
2881e3365e6cSdrh **
2882e3365e6cSdrh **      x IN (SELECT ...)
2883e3365e6cSdrh **      x IN (value, value, ...)
2884e3365e6cSdrh **
2885ecb87ac8Sdrh ** The left-hand side (LHS) is a scalar or vector expression.  The
2886e347d3e8Sdrh ** right-hand side (RHS) is an array of zero or more scalar values, or a
2887e347d3e8Sdrh ** subquery.  If the RHS is a subquery, the number of result columns must
2888e347d3e8Sdrh ** match the number of columns in the vector on the LHS.  If the RHS is
2889e347d3e8Sdrh ** a list of values, the LHS must be a scalar.
2890e347d3e8Sdrh **
2891e347d3e8Sdrh ** The IN operator is true if the LHS value is contained within the RHS.
2892e347d3e8Sdrh ** The result is false if the LHS is definitely not in the RHS.  The
2893e347d3e8Sdrh ** result is NULL if the presence of the LHS in the RHS cannot be
2894e347d3e8Sdrh ** determined due to NULLs.
2895e3365e6cSdrh **
28966be515ebSdrh ** This routine generates code that jumps to destIfFalse if the LHS is not
2897e3365e6cSdrh ** contained within the RHS.  If due to NULLs we cannot determine if the LHS
2898e3365e6cSdrh ** is contained in the RHS then jump to destIfNull.  If the LHS is contained
2899e3365e6cSdrh ** within the RHS then fall through.
2900ecb87ac8Sdrh **
2901ecb87ac8Sdrh ** See the separate in-operator.md documentation file in the canonical
2902ecb87ac8Sdrh ** SQLite source tree for additional information.
2903e3365e6cSdrh */
2904e3365e6cSdrh static void sqlite3ExprCodeIN(
2905e3365e6cSdrh   Parse *pParse,        /* Parsing and code generating context */
2906e3365e6cSdrh   Expr *pExpr,          /* The IN expression */
2907e3365e6cSdrh   int destIfFalse,      /* Jump here if LHS is not contained in the RHS */
2908e3365e6cSdrh   int destIfNull        /* Jump here if the results are unknown due to NULLs */
2909e3365e6cSdrh ){
2910e3365e6cSdrh   int rRhsHasNull = 0;  /* Register that is true if RHS contains NULL values */
2911e3365e6cSdrh   int eType;            /* Type of the RHS */
2912e347d3e8Sdrh   int rLhs;             /* Register(s) holding the LHS values */
2913e347d3e8Sdrh   int rLhsOrig;         /* LHS values prior to reordering by aiMap[] */
2914e3365e6cSdrh   Vdbe *v;              /* Statement under construction */
2915ba00e30aSdan   int *aiMap = 0;       /* Map from vector field to index column */
2916ba00e30aSdan   char *zAff = 0;       /* Affinity string for comparisons */
2917ecb87ac8Sdrh   int nVector;          /* Size of vectors for this IN operator */
291812abf408Sdrh   int iDummy;           /* Dummy parameter to exprCodeVector() */
2919e347d3e8Sdrh   Expr *pLeft;          /* The LHS of the IN operator */
2920ecb87ac8Sdrh   int i;                /* loop counter */
2921e347d3e8Sdrh   int destStep2;        /* Where to jump when NULLs seen in step 2 */
2922e347d3e8Sdrh   int destStep6 = 0;    /* Start of code for Step 6 */
2923e347d3e8Sdrh   int addrTruthOp;      /* Address of opcode that determines the IN is true */
2924e347d3e8Sdrh   int destNotNull;      /* Jump here if a comparison is not true in step 6 */
2925e347d3e8Sdrh   int addrTop;          /* Top of the step-6 loop */
2926e3365e6cSdrh 
2927e347d3e8Sdrh   pLeft = pExpr->pLeft;
29287b35a77bSdan   if( sqlite3ExprCheckIN(pParse, pExpr) ) return;
2929553168c7Sdan   zAff = exprINAffinity(pParse, pExpr);
2930ba00e30aSdan   nVector = sqlite3ExprVectorSize(pExpr->pLeft);
2931ba00e30aSdan   aiMap = (int*)sqlite3DbMallocZero(
2932ba00e30aSdan       pParse->db, nVector*(sizeof(int) + sizeof(char)) + 1
2933ba00e30aSdan   );
2934e347d3e8Sdrh   if( pParse->db->mallocFailed ) goto sqlite3ExprCodeIN_oom_error;
29357b35a77bSdan 
2936ba00e30aSdan   /* Attempt to compute the RHS. After this step, if anything other than
2937ba00e30aSdan   ** IN_INDEX_NOOP is returned, the table opened ith cursor pExpr->iTable
2938ba00e30aSdan   ** contains the values that make up the RHS. If IN_INDEX_NOOP is returned,
2939ba00e30aSdan   ** the RHS has not yet been coded.  */
2940e3365e6cSdrh   v = pParse->pVdbe;
2941e3365e6cSdrh   assert( v!=0 );       /* OOM detected prior to this routine */
2942e3365e6cSdrh   VdbeNoopComment((v, "begin IN expr"));
2943bb53ecb1Sdrh   eType = sqlite3FindInIndex(pParse, pExpr,
2944bb53ecb1Sdrh                              IN_INDEX_MEMBERSHIP | IN_INDEX_NOOP_OK,
2945ba00e30aSdan                              destIfFalse==destIfNull ? 0 : &rRhsHasNull, aiMap);
2946e3365e6cSdrh 
2947ba00e30aSdan   assert( pParse->nErr || nVector==1 || eType==IN_INDEX_EPH
2948ba00e30aSdan        || eType==IN_INDEX_INDEX_ASC || eType==IN_INDEX_INDEX_DESC
2949ba00e30aSdan   );
2950ecb87ac8Sdrh #ifdef SQLITE_DEBUG
2951ecb87ac8Sdrh   /* Confirm that aiMap[] contains nVector integer values between 0 and
2952ecb87ac8Sdrh   ** nVector-1. */
2953ecb87ac8Sdrh   for(i=0; i<nVector; i++){
2954ecb87ac8Sdrh     int j, cnt;
2955ecb87ac8Sdrh     for(cnt=j=0; j<nVector; j++) if( aiMap[j]==i ) cnt++;
2956ecb87ac8Sdrh     assert( cnt==1 );
2957ecb87ac8Sdrh   }
2958ecb87ac8Sdrh #endif
2959e3365e6cSdrh 
2960ba00e30aSdan   /* Code the LHS, the <expr> from "<expr> IN (...)". If the LHS is a
2961ba00e30aSdan   ** vector, then it is stored in an array of nVector registers starting
2962ba00e30aSdan   ** at r1.
2963e347d3e8Sdrh   **
2964e347d3e8Sdrh   ** sqlite3FindInIndex() might have reordered the fields of the LHS vector
2965e347d3e8Sdrh   ** so that the fields are in the same order as an existing index.   The
2966e347d3e8Sdrh   ** aiMap[] array contains a mapping from the original LHS field order to
2967e347d3e8Sdrh   ** the field order that matches the RHS index.
2968e3365e6cSdrh   */
2969e347d3e8Sdrh   rLhsOrig = exprCodeVector(pParse, pLeft, &iDummy);
2970e347d3e8Sdrh   for(i=0; i<nVector && aiMap[i]==i; i++){} /* Are LHS fields reordered? */
2971ecb87ac8Sdrh   if( i==nVector ){
2972e347d3e8Sdrh     /* LHS fields are not reordered */
2973e347d3e8Sdrh     rLhs = rLhsOrig;
2974ecb87ac8Sdrh   }else{
2975ecb87ac8Sdrh     /* Need to reorder the LHS fields according to aiMap */
2976e347d3e8Sdrh     rLhs = sqlite3GetTempRange(pParse, nVector);
2977ba00e30aSdan     for(i=0; i<nVector; i++){
2978e347d3e8Sdrh       sqlite3VdbeAddOp3(v, OP_Copy, rLhsOrig+i, rLhs+aiMap[i], 0);
2979ba00e30aSdan     }
2980ecb87ac8Sdrh   }
2981e3365e6cSdrh 
2982bb53ecb1Sdrh   /* If sqlite3FindInIndex() did not find or create an index that is
2983bb53ecb1Sdrh   ** suitable for evaluating the IN operator, then evaluate using a
2984bb53ecb1Sdrh   ** sequence of comparisons.
2985e347d3e8Sdrh   **
2986e347d3e8Sdrh   ** This is step (1) in the in-operator.md optimized algorithm.
2987bb53ecb1Sdrh   */
2988bb53ecb1Sdrh   if( eType==IN_INDEX_NOOP ){
2989bb53ecb1Sdrh     ExprList *pList = pExpr->x.pList;
2990bb53ecb1Sdrh     CollSeq *pColl = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
2991bb53ecb1Sdrh     int labelOk = sqlite3VdbeMakeLabel(v);
2992bb53ecb1Sdrh     int r2, regToFree;
2993bb53ecb1Sdrh     int regCkNull = 0;
2994bb53ecb1Sdrh     int ii;
2995bb53ecb1Sdrh     assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
2996bb53ecb1Sdrh     if( destIfNull!=destIfFalse ){
2997bb53ecb1Sdrh       regCkNull = sqlite3GetTempReg(pParse);
2998e347d3e8Sdrh       sqlite3VdbeAddOp3(v, OP_BitAnd, rLhs, rLhs, regCkNull);
2999bb53ecb1Sdrh     }
3000bb53ecb1Sdrh     for(ii=0; ii<pList->nExpr; ii++){
3001bb53ecb1Sdrh       r2 = sqlite3ExprCodeTemp(pParse, pList->a[ii].pExpr, &regToFree);
3002a976979bSdrh       if( regCkNull && sqlite3ExprCanBeNull(pList->a[ii].pExpr) ){
3003bb53ecb1Sdrh         sqlite3VdbeAddOp3(v, OP_BitAnd, regCkNull, r2, regCkNull);
3004bb53ecb1Sdrh       }
3005bb53ecb1Sdrh       if( ii<pList->nExpr-1 || destIfNull!=destIfFalse ){
3006e347d3e8Sdrh         sqlite3VdbeAddOp4(v, OP_Eq, rLhs, labelOk, r2,
30074336b0e6Sdrh                           (void*)pColl, P4_COLLSEQ);
30084336b0e6Sdrh         VdbeCoverageIf(v, ii<pList->nExpr-1);
30094336b0e6Sdrh         VdbeCoverageIf(v, ii==pList->nExpr-1);
3010ba00e30aSdan         sqlite3VdbeChangeP5(v, zAff[0]);
3011bb53ecb1Sdrh       }else{
3012bb53ecb1Sdrh         assert( destIfNull==destIfFalse );
3013e347d3e8Sdrh         sqlite3VdbeAddOp4(v, OP_Ne, rLhs, destIfFalse, r2,
3014bb53ecb1Sdrh                           (void*)pColl, P4_COLLSEQ); VdbeCoverage(v);
3015ba00e30aSdan         sqlite3VdbeChangeP5(v, zAff[0] | SQLITE_JUMPIFNULL);
3016bb53ecb1Sdrh       }
3017bb53ecb1Sdrh       sqlite3ReleaseTempReg(pParse, regToFree);
3018bb53ecb1Sdrh     }
3019bb53ecb1Sdrh     if( regCkNull ){
3020bb53ecb1Sdrh       sqlite3VdbeAddOp2(v, OP_IsNull, regCkNull, destIfNull); VdbeCoverage(v);
3021076e85f5Sdrh       sqlite3VdbeGoto(v, destIfFalse);
3022bb53ecb1Sdrh     }
3023bb53ecb1Sdrh     sqlite3VdbeResolveLabel(v, labelOk);
3024bb53ecb1Sdrh     sqlite3ReleaseTempReg(pParse, regCkNull);
3025e347d3e8Sdrh     goto sqlite3ExprCodeIN_finished;
3026e347d3e8Sdrh   }
3027bb53ecb1Sdrh 
3028e347d3e8Sdrh   /* Step 2: Check to see if the LHS contains any NULL columns.  If the
3029e347d3e8Sdrh   ** LHS does contain NULLs then the result must be either FALSE or NULL.
3030e347d3e8Sdrh   ** We will then skip the binary search of the RHS.
3031e347d3e8Sdrh   */
3032094430ebSdrh   if( destIfNull==destIfFalse ){
3033e347d3e8Sdrh     destStep2 = destIfFalse;
3034e347d3e8Sdrh   }else{
3035e347d3e8Sdrh     destStep2 = destStep6 = sqlite3VdbeMakeLabel(v);
3036e347d3e8Sdrh   }
3037d49fd4e8Sdan   for(i=0; i<nVector; i++){
3038fc7f27b9Sdrh     Expr *p = sqlite3VectorFieldSubexpr(pExpr->pLeft, i);
3039d49fd4e8Sdan     if( sqlite3ExprCanBeNull(p) ){
3040e347d3e8Sdrh       sqlite3VdbeAddOp2(v, OP_IsNull, rLhs+i, destStep2);
3041471b4b92Sdrh       VdbeCoverage(v);
3042d49fd4e8Sdan     }
3043d49fd4e8Sdan   }
3044e3365e6cSdrh 
3045e347d3e8Sdrh   /* Step 3.  The LHS is now known to be non-NULL.  Do the binary search
3046e347d3e8Sdrh   ** of the RHS using the LHS as a probe.  If found, the result is
3047e347d3e8Sdrh   ** true.
3048e347d3e8Sdrh   */
3049e3365e6cSdrh   if( eType==IN_INDEX_ROWID ){
3050e347d3e8Sdrh     /* In this case, the RHS is the ROWID of table b-tree and so we also
3051e347d3e8Sdrh     ** know that the RHS is non-NULL.  Hence, we combine steps 3 and 4
3052e347d3e8Sdrh     ** into a single opcode. */
3053e347d3e8Sdrh     sqlite3VdbeAddOp3(v, OP_SeekRowid, pExpr->iTable, destIfFalse, rLhs);
3054688852abSdrh     VdbeCoverage(v);
3055e347d3e8Sdrh     addrTruthOp = sqlite3VdbeAddOp0(v, OP_Goto);  /* Return True */
30567b35a77bSdan   }else{
3057e347d3e8Sdrh     sqlite3VdbeAddOp4(v, OP_Affinity, rLhs, nVector, 0, zAff, nVector);
3058e347d3e8Sdrh     if( destIfFalse==destIfNull ){
3059e347d3e8Sdrh       /* Combine Step 3 and Step 5 into a single opcode */
3060e347d3e8Sdrh       sqlite3VdbeAddOp4Int(v, OP_NotFound, pExpr->iTable, destIfFalse,
3061e347d3e8Sdrh                            rLhs, nVector); VdbeCoverage(v);
3062e347d3e8Sdrh       goto sqlite3ExprCodeIN_finished;
3063e347d3e8Sdrh     }
3064e347d3e8Sdrh     /* Ordinary Step 3, for the case where FALSE and NULL are distinct */
3065e347d3e8Sdrh     addrTruthOp = sqlite3VdbeAddOp4Int(v, OP_Found, pExpr->iTable, 0,
3066e347d3e8Sdrh                                       rLhs, nVector); VdbeCoverage(v);
3067e347d3e8Sdrh   }
3068ba00e30aSdan 
3069e347d3e8Sdrh   /* Step 4.  If the RHS is known to be non-NULL and we did not find
3070e347d3e8Sdrh   ** an match on the search above, then the result must be FALSE.
3071e347d3e8Sdrh   */
3072e347d3e8Sdrh   if( rRhsHasNull && nVector==1 ){
3073e347d3e8Sdrh     sqlite3VdbeAddOp2(v, OP_NotNull, rRhsHasNull, destIfFalse);
3074471b4b92Sdrh     VdbeCoverage(v);
3075e347d3e8Sdrh   }
30767b35a77bSdan 
3077e347d3e8Sdrh   /* Step 5.  If we do not care about the difference between NULL and
3078e347d3e8Sdrh   ** FALSE, then just return false.
3079e347d3e8Sdrh   */
3080e347d3e8Sdrh   if( destIfFalse==destIfNull ) sqlite3VdbeGoto(v, destIfFalse);
3081e347d3e8Sdrh 
3082e347d3e8Sdrh   /* Step 6: Loop through rows of the RHS.  Compare each row to the LHS.
3083e347d3e8Sdrh   ** If any comparison is NULL, then the result is NULL.  If all
3084e347d3e8Sdrh   ** comparisons are FALSE then the final result is FALSE.
3085e347d3e8Sdrh   **
3086e347d3e8Sdrh   ** For a scalar LHS, it is sufficient to check just the first row
3087e347d3e8Sdrh   ** of the RHS.
3088e347d3e8Sdrh   */
3089e347d3e8Sdrh   if( destStep6 ) sqlite3VdbeResolveLabel(v, destStep6);
3090e347d3e8Sdrh   addrTop = sqlite3VdbeAddOp2(v, OP_Rewind, pExpr->iTable, destIfFalse);
3091471b4b92Sdrh   VdbeCoverage(v);
3092e347d3e8Sdrh   if( nVector>1 ){
3093e347d3e8Sdrh     destNotNull = sqlite3VdbeMakeLabel(v);
3094e347d3e8Sdrh   }else{
3095e347d3e8Sdrh     /* For nVector==1, combine steps 6 and 7 by immediately returning
3096e347d3e8Sdrh     ** FALSE if the first comparison is not NULL */
3097e347d3e8Sdrh     destNotNull = destIfFalse;
3098e347d3e8Sdrh   }
3099ba00e30aSdan   for(i=0; i<nVector; i++){
3100ba00e30aSdan     Expr *p;
3101ba00e30aSdan     CollSeq *pColl;
3102e347d3e8Sdrh     int r3 = sqlite3GetTempReg(pParse);
3103fc7f27b9Sdrh     p = sqlite3VectorFieldSubexpr(pLeft, i);
3104ba00e30aSdan     pColl = sqlite3ExprCollSeq(pParse, p);
3105e347d3e8Sdrh     sqlite3VdbeAddOp3(v, OP_Column, pExpr->iTable, i, r3);
3106e347d3e8Sdrh     sqlite3VdbeAddOp4(v, OP_Ne, rLhs+i, destNotNull, r3,
310718016ad2Sdrh                       (void*)pColl, P4_COLLSEQ);
3108471b4b92Sdrh     VdbeCoverage(v);
3109e347d3e8Sdrh     sqlite3ReleaseTempReg(pParse, r3);
31107b35a77bSdan   }
31117b35a77bSdan   sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfNull);
3112e347d3e8Sdrh   if( nVector>1 ){
3113e347d3e8Sdrh     sqlite3VdbeResolveLabel(v, destNotNull);
3114e347d3e8Sdrh     sqlite3VdbeAddOp2(v, OP_Next, pExpr->iTable, addrTop+1);
311518016ad2Sdrh     VdbeCoverage(v);
3116e347d3e8Sdrh 
3117e347d3e8Sdrh     /* Step 7:  If we reach this point, we know that the result must
3118e347d3e8Sdrh     ** be false. */
311918016ad2Sdrh     sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfFalse);
31207b35a77bSdan   }
31217b35a77bSdan 
3122e347d3e8Sdrh   /* Jumps here in order to return true. */
3123e347d3e8Sdrh   sqlite3VdbeJumpHere(v, addrTruthOp);
3124e3365e6cSdrh 
3125e347d3e8Sdrh sqlite3ExprCodeIN_finished:
3126e347d3e8Sdrh   if( rLhs!=rLhsOrig ) sqlite3ReleaseTempReg(pParse, rLhs);
3127ecb87ac8Sdrh   VdbeComment((v, "end IN expr"));
3128e347d3e8Sdrh sqlite3ExprCodeIN_oom_error:
3129ba00e30aSdan   sqlite3DbFree(pParse->db, aiMap);
3130553168c7Sdan   sqlite3DbFree(pParse->db, zAff);
3131e3365e6cSdrh }
3132e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
3133e3365e6cSdrh 
313413573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
3135598f1340Sdrh /*
3136598f1340Sdrh ** Generate an instruction that will put the floating point
31379cbf3425Sdrh ** value described by z[0..n-1] into register iMem.
31380cf19ed8Sdrh **
31390cf19ed8Sdrh ** The z[] string will probably not be zero-terminated.  But the
31400cf19ed8Sdrh ** z[n] character is guaranteed to be something that does not look
31410cf19ed8Sdrh ** like the continuation of the number.
3142598f1340Sdrh */
3143b7916a78Sdrh static void codeReal(Vdbe *v, const char *z, int negateFlag, int iMem){
3144fd773cf9Sdrh   if( ALWAYS(z!=0) ){
3145598f1340Sdrh     double value;
31469339da1fSdrh     sqlite3AtoF(z, &value, sqlite3Strlen30(z), SQLITE_UTF8);
3147d0015161Sdrh     assert( !sqlite3IsNaN(value) ); /* The new AtoF never returns NaN */
3148598f1340Sdrh     if( negateFlag ) value = -value;
314997bae794Sdrh     sqlite3VdbeAddOp4Dup8(v, OP_Real, 0, iMem, 0, (u8*)&value, P4_REAL);
3150598f1340Sdrh   }
3151598f1340Sdrh }
315213573c71Sdrh #endif
3153598f1340Sdrh 
3154598f1340Sdrh 
3155598f1340Sdrh /*
3156fec19aadSdrh ** Generate an instruction that will put the integer describe by
31579cbf3425Sdrh ** text z[0..n-1] into register iMem.
31580cf19ed8Sdrh **
31595f1d6b61Sshaneh ** Expr.u.zToken is always UTF8 and zero-terminated.
3160fec19aadSdrh */
316113573c71Sdrh static void codeInteger(Parse *pParse, Expr *pExpr, int negFlag, int iMem){
316213573c71Sdrh   Vdbe *v = pParse->pVdbe;
316392b01d53Sdrh   if( pExpr->flags & EP_IntValue ){
316433e619fcSdrh     int i = pExpr->u.iValue;
3165d50ffc41Sdrh     assert( i>=0 );
316692b01d53Sdrh     if( negFlag ) i = -i;
316792b01d53Sdrh     sqlite3VdbeAddOp2(v, OP_Integer, i, iMem);
3168fd773cf9Sdrh   }else{
31695f1d6b61Sshaneh     int c;
31705f1d6b61Sshaneh     i64 value;
3171fd773cf9Sdrh     const char *z = pExpr->u.zToken;
3172fd773cf9Sdrh     assert( z!=0 );
31739296c18aSdrh     c = sqlite3DecOrHexToI64(z, &value);
317484d4f1a3Sdrh     if( (c==3 && !negFlag) || (c==2) || (negFlag && value==SMALLEST_INT64)){
317513573c71Sdrh #ifdef SQLITE_OMIT_FLOATING_POINT
317613573c71Sdrh       sqlite3ErrorMsg(pParse, "oversized integer: %s%s", negFlag ? "-" : "", z);
317713573c71Sdrh #else
31781b7ddc59Sdrh #ifndef SQLITE_OMIT_HEX_INTEGER
31799296c18aSdrh       if( sqlite3_strnicmp(z,"0x",2)==0 ){
318077320ea4Sdrh         sqlite3ErrorMsg(pParse, "hex literal too big: %s%s", negFlag?"-":"",z);
31811b7ddc59Sdrh       }else
31821b7ddc59Sdrh #endif
31831b7ddc59Sdrh       {
3184b7916a78Sdrh         codeReal(v, z, negFlag, iMem);
31859296c18aSdrh       }
318613573c71Sdrh #endif
318777320ea4Sdrh     }else{
318884d4f1a3Sdrh       if( negFlag ){ value = c==3 ? SMALLEST_INT64 : -value; }
318977320ea4Sdrh       sqlite3VdbeAddOp4Dup8(v, OP_Int64, 0, iMem, 0, (u8*)&value, P4_INT64);
3190fec19aadSdrh     }
3191fec19aadSdrh   }
3192c9cf901dSdanielk1977 }
3193fec19aadSdrh 
31945cd79239Sdrh 
31951f9ca2c8Sdrh /* Generate code that will load into register regOut a value that is
31961f9ca2c8Sdrh ** appropriate for the iIdxCol-th column of index pIdx.
31971f9ca2c8Sdrh */
31981f9ca2c8Sdrh void sqlite3ExprCodeLoadIndexColumn(
31991f9ca2c8Sdrh   Parse *pParse,  /* The parsing context */
32001f9ca2c8Sdrh   Index *pIdx,    /* The index whose column is to be loaded */
32011f9ca2c8Sdrh   int iTabCur,    /* Cursor pointing to a table row */
32021f9ca2c8Sdrh   int iIdxCol,    /* The column of the index to be loaded */
32031f9ca2c8Sdrh   int regOut      /* Store the index column value in this register */
32041f9ca2c8Sdrh ){
32051f9ca2c8Sdrh   i16 iTabCol = pIdx->aiColumn[iIdxCol];
32064b92f98cSdrh   if( iTabCol==XN_EXPR ){
32071f9ca2c8Sdrh     assert( pIdx->aColExpr );
32081f9ca2c8Sdrh     assert( pIdx->aColExpr->nExpr>iIdxCol );
32093e34eabcSdrh     pParse->iSelfTab = iTabCur + 1;
32101c75c9d7Sdrh     sqlite3ExprCodeCopy(pParse, pIdx->aColExpr->a[iIdxCol].pExpr, regOut);
32113e34eabcSdrh     pParse->iSelfTab = 0;
32124b92f98cSdrh   }else{
32134b92f98cSdrh     sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pIdx->pTable, iTabCur,
32144b92f98cSdrh                                     iTabCol, regOut);
32154b92f98cSdrh   }
32161f9ca2c8Sdrh }
32171f9ca2c8Sdrh 
32185cd79239Sdrh /*
32195c092e8aSdrh ** Generate code to extract the value of the iCol-th column of a table.
32205c092e8aSdrh */
32215c092e8aSdrh void sqlite3ExprCodeGetColumnOfTable(
32225c092e8aSdrh   Vdbe *v,        /* The VDBE under construction */
32235c092e8aSdrh   Table *pTab,    /* The table containing the value */
3224313619f5Sdrh   int iTabCur,    /* The table cursor.  Or the PK cursor for WITHOUT ROWID */
32255c092e8aSdrh   int iCol,       /* Index of the column to extract */
3226313619f5Sdrh   int regOut      /* Extract the value into this register */
32275c092e8aSdrh ){
3228aca19e19Sdrh   if( pTab==0 ){
3229aca19e19Sdrh     sqlite3VdbeAddOp3(v, OP_Column, iTabCur, iCol, regOut);
3230aca19e19Sdrh     return;
3231aca19e19Sdrh   }
32325c092e8aSdrh   if( iCol<0 || iCol==pTab->iPKey ){
32335c092e8aSdrh     sqlite3VdbeAddOp2(v, OP_Rowid, iTabCur, regOut);
32345c092e8aSdrh   }else{
32355c092e8aSdrh     int op = IsVirtual(pTab) ? OP_VColumn : OP_Column;
3236ee0ec8e1Sdrh     int x = iCol;
323735db31b2Sdrh     if( !HasRowid(pTab) && !IsVirtual(pTab) ){
3238ee0ec8e1Sdrh       x = sqlite3ColumnOfIndex(sqlite3PrimaryKeyIndex(pTab), iCol);
3239ee0ec8e1Sdrh     }
3240ee0ec8e1Sdrh     sqlite3VdbeAddOp3(v, op, iTabCur, x, regOut);
32415c092e8aSdrh   }
32425c092e8aSdrh   if( iCol>=0 ){
32435c092e8aSdrh     sqlite3ColumnDefault(v, pTab, iCol, regOut);
32445c092e8aSdrh   }
32455c092e8aSdrh }
32465c092e8aSdrh 
32475c092e8aSdrh /*
3248945498f3Sdrh ** Generate code that will extract the iColumn-th column from
32498c607191Sdrh ** table pTab and store the column value in register iReg.
3250e55cbd72Sdrh **
3251e55cbd72Sdrh ** There must be an open cursor to pTab in iTable when this routine
3252e55cbd72Sdrh ** is called.  If iColumn<0 then code is generated that extracts the rowid.
3253945498f3Sdrh */
3254e55cbd72Sdrh int sqlite3ExprCodeGetColumn(
3255e55cbd72Sdrh   Parse *pParse,   /* Parsing and code generating context */
32562133d822Sdrh   Table *pTab,     /* Description of the table we are reading from */
32572133d822Sdrh   int iColumn,     /* Index of the table column */
32582133d822Sdrh   int iTable,      /* The cursor pointing to the table */
3259a748fdccSdrh   int iReg,        /* Store results here */
3260ce78bc6eSdrh   u8 p5            /* P5 value for OP_Column + FLAGS */
32612133d822Sdrh ){
3262e55cbd72Sdrh   Vdbe *v = pParse->pVdbe;
3263e55cbd72Sdrh   assert( v!=0 );
32645c092e8aSdrh   sqlite3ExprCodeGetColumnOfTable(v, pTab, iTable, iColumn, iReg);
3265a748fdccSdrh   if( p5 ){
3266a748fdccSdrh     sqlite3VdbeChangeP5(v, p5);
3267a748fdccSdrh   }
3268e55cbd72Sdrh   return iReg;
3269e55cbd72Sdrh }
3270e55cbd72Sdrh 
3271e55cbd72Sdrh /*
3272b21e7c70Sdrh ** Generate code to move content from registers iFrom...iFrom+nReg-1
327336a5d88dSdrh ** over to iTo..iTo+nReg-1.
3274e55cbd72Sdrh */
3275b21e7c70Sdrh void sqlite3ExprCodeMove(Parse *pParse, int iFrom, int iTo, int nReg){
3276e8e4af76Sdrh   assert( iFrom>=iTo+nReg || iFrom+nReg<=iTo );
3277079a3072Sdrh   sqlite3VdbeAddOp3(pParse->pVdbe, OP_Move, iFrom, iTo, nReg);
3278945498f3Sdrh }
3279945498f3Sdrh 
3280652fbf55Sdrh /*
328112abf408Sdrh ** Convert a scalar expression node to a TK_REGISTER referencing
328212abf408Sdrh ** register iReg.  The caller must ensure that iReg already contains
328312abf408Sdrh ** the correct value for the expression.
3284a4c3c87eSdrh */
3285a4c3c87eSdrh static void exprToRegister(Expr *p, int iReg){
3286a4c3c87eSdrh   p->op2 = p->op;
3287a4c3c87eSdrh   p->op = TK_REGISTER;
3288a4c3c87eSdrh   p->iTable = iReg;
3289a4c3c87eSdrh   ExprClearProperty(p, EP_Skip);
3290a4c3c87eSdrh }
3291a4c3c87eSdrh 
329212abf408Sdrh /*
329312abf408Sdrh ** Evaluate an expression (either a vector or a scalar expression) and store
329412abf408Sdrh ** the result in continguous temporary registers.  Return the index of
329512abf408Sdrh ** the first register used to store the result.
329612abf408Sdrh **
329712abf408Sdrh ** If the returned result register is a temporary scalar, then also write
329812abf408Sdrh ** that register number into *piFreeable.  If the returned result register
329912abf408Sdrh ** is not a temporary or if the expression is a vector set *piFreeable
330012abf408Sdrh ** to 0.
330112abf408Sdrh */
330212abf408Sdrh static int exprCodeVector(Parse *pParse, Expr *p, int *piFreeable){
330312abf408Sdrh   int iResult;
330412abf408Sdrh   int nResult = sqlite3ExprVectorSize(p);
330512abf408Sdrh   if( nResult==1 ){
330612abf408Sdrh     iResult = sqlite3ExprCodeTemp(pParse, p, piFreeable);
330712abf408Sdrh   }else{
330812abf408Sdrh     *piFreeable = 0;
330912abf408Sdrh     if( p->op==TK_SELECT ){
3310dd1bb43aSdrh #if SQLITE_OMIT_SUBQUERY
3311dd1bb43aSdrh       iResult = 0;
3312dd1bb43aSdrh #else
331312abf408Sdrh       iResult = sqlite3CodeSubselect(pParse, p, 0, 0);
3314dd1bb43aSdrh #endif
331512abf408Sdrh     }else{
331612abf408Sdrh       int i;
331712abf408Sdrh       iResult = pParse->nMem+1;
331812abf408Sdrh       pParse->nMem += nResult;
331912abf408Sdrh       for(i=0; i<nResult; i++){
33204b725240Sdan         sqlite3ExprCodeFactorable(pParse, p->x.pList->a[i].pExpr, i+iResult);
332112abf408Sdrh       }
332212abf408Sdrh     }
332312abf408Sdrh   }
332412abf408Sdrh   return iResult;
332512abf408Sdrh }
332612abf408Sdrh 
332771c57db0Sdan 
3328a4c3c87eSdrh /*
3329cce7d176Sdrh ** Generate code into the current Vdbe to evaluate the given
33302dcef11bSdrh ** expression.  Attempt to store the results in register "target".
33312dcef11bSdrh ** Return the register where results are stored.
3332389a1adbSdrh **
33338b213899Sdrh ** With this routine, there is no guarantee that results will
33342dcef11bSdrh ** be stored in target.  The result might be stored in some other
33352dcef11bSdrh ** register if it is convenient to do so.  The calling function
33362dcef11bSdrh ** must check the return code and move the results to the desired
33372dcef11bSdrh ** register.
3338cce7d176Sdrh */
3339678ccce8Sdrh int sqlite3ExprCodeTarget(Parse *pParse, Expr *pExpr, int target){
33402dcef11bSdrh   Vdbe *v = pParse->pVdbe;  /* The VM under construction */
33412dcef11bSdrh   int op;                   /* The opcode being coded */
33422dcef11bSdrh   int inReg = target;       /* Results stored in register inReg */
33432dcef11bSdrh   int regFree1 = 0;         /* If non-zero free this temporary register */
33442dcef11bSdrh   int regFree2 = 0;         /* If non-zero free this temporary register */
33457b35a77bSdan   int r1, r2;               /* Various register numbers */
334610d1edf0Sdrh   Expr tempX;               /* Temporary expression node */
334771c57db0Sdan   int p5 = 0;
3348ffe07b2dSdrh 
33499cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
335020411ea7Sdrh   if( v==0 ){
335120411ea7Sdrh     assert( pParse->db->mallocFailed );
335220411ea7Sdrh     return 0;
335320411ea7Sdrh   }
3354389a1adbSdrh 
33551efa8023Sdrh expr_code_doover:
3356389a1adbSdrh   if( pExpr==0 ){
3357389a1adbSdrh     op = TK_NULL;
3358389a1adbSdrh   }else{
3359f2bc013cSdrh     op = pExpr->op;
3360389a1adbSdrh   }
3361f2bc013cSdrh   switch( op ){
336213449892Sdrh     case TK_AGG_COLUMN: {
336313449892Sdrh       AggInfo *pAggInfo = pExpr->pAggInfo;
336413449892Sdrh       struct AggInfo_col *pCol = &pAggInfo->aCol[pExpr->iAgg];
336513449892Sdrh       if( !pAggInfo->directMode ){
33669de221dfSdrh         assert( pCol->iMem>0 );
3367c332cc30Sdrh         return pCol->iMem;
336813449892Sdrh       }else if( pAggInfo->useSortingIdx ){
33695134d135Sdan         sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdxPTab,
3370389a1adbSdrh                               pCol->iSorterColumn, target);
3371c332cc30Sdrh         return target;
337213449892Sdrh       }
337313449892Sdrh       /* Otherwise, fall thru into the TK_COLUMN case */
337413449892Sdrh     }
3375967e8b73Sdrh     case TK_COLUMN: {
3376b2b9d3d7Sdrh       int iTab = pExpr->iTable;
3377efad2e23Sdrh       if( ExprHasProperty(pExpr, EP_FixedCol) ){
3378d98f5324Sdrh         /* This COLUMN expression is really a constant due to WHERE clause
3379d98f5324Sdrh         ** constraints, and that constant is coded by the pExpr->pLeft
3380d98f5324Sdrh         ** expresssion.  However, make sure the constant has the correct
3381d98f5324Sdrh         ** datatype by applying the Affinity of the table column to the
3382d98f5324Sdrh         ** constant.
3383d98f5324Sdrh         */
3384d98f5324Sdrh         int iReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft,target);
3385*eda079cdSdrh         int aff = sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
3386d98f5324Sdrh         if( aff!=SQLITE_AFF_BLOB ){
3387d98f5324Sdrh           static const char zAff[] = "B\000C\000D\000E";
3388d98f5324Sdrh           assert( SQLITE_AFF_BLOB=='A' );
3389d98f5324Sdrh           assert( SQLITE_AFF_TEXT=='B' );
3390d98f5324Sdrh           if( iReg!=target ){
3391d98f5324Sdrh             sqlite3VdbeAddOp2(v, OP_SCopy, iReg, target);
3392d98f5324Sdrh             iReg = target;
3393d98f5324Sdrh           }
3394d98f5324Sdrh           sqlite3VdbeAddOp4(v, OP_Affinity, iReg, 1, 0,
3395d98f5324Sdrh                             &zAff[(aff-'B')*2], P4_STATIC);
3396d98f5324Sdrh         }
3397d98f5324Sdrh         return iReg;
3398efad2e23Sdrh       }
3399b2b9d3d7Sdrh       if( iTab<0 ){
34006e97f8ecSdrh         if( pParse->iSelfTab<0 ){
3401b2b9d3d7Sdrh           /* Generating CHECK constraints or inserting into partial index */
34026e97f8ecSdrh           return pExpr->iColumn - pParse->iSelfTab;
3403c4a3c779Sdrh         }else{
34041f9ca2c8Sdrh           /* Coding an expression that is part of an index where column names
34051f9ca2c8Sdrh           ** in the index refer to the table to which the index belongs */
34063e34eabcSdrh           iTab = pParse->iSelfTab - 1;
34072282792aSdrh         }
3408b2b9d3d7Sdrh       }
3409*eda079cdSdrh       return sqlite3ExprCodeGetColumn(pParse, pExpr->y.pTab,
3410b2b9d3d7Sdrh                                pExpr->iColumn, iTab, target,
3411b2b9d3d7Sdrh                                pExpr->op2);
3412cce7d176Sdrh     }
3413cce7d176Sdrh     case TK_INTEGER: {
341413573c71Sdrh       codeInteger(pParse, pExpr, 0, target);
3415c332cc30Sdrh       return target;
341651e9a445Sdrh     }
34178abed7b9Sdrh     case TK_TRUEFALSE: {
341896acafbeSdrh       sqlite3VdbeAddOp2(v, OP_Integer, sqlite3ExprTruthValue(pExpr), target);
3419007c843bSdrh       return target;
3420007c843bSdrh     }
342113573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
3422598f1340Sdrh     case TK_FLOAT: {
342333e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
342433e619fcSdrh       codeReal(v, pExpr->u.zToken, 0, target);
3425c332cc30Sdrh       return target;
3426598f1340Sdrh     }
342713573c71Sdrh #endif
3428fec19aadSdrh     case TK_STRING: {
342933e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
3430076e85f5Sdrh       sqlite3VdbeLoadString(v, target, pExpr->u.zToken);
3431c332cc30Sdrh       return target;
3432cce7d176Sdrh     }
3433f0863fe5Sdrh     case TK_NULL: {
34349de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3435c332cc30Sdrh       return target;
3436f0863fe5Sdrh     }
34375338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_BLOB_LITERAL
3438c572ef7fSdanielk1977     case TK_BLOB: {
34396c8c6cecSdrh       int n;
34406c8c6cecSdrh       const char *z;
3441ca48c90fSdrh       char *zBlob;
344233e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
344333e619fcSdrh       assert( pExpr->u.zToken[0]=='x' || pExpr->u.zToken[0]=='X' );
344433e619fcSdrh       assert( pExpr->u.zToken[1]=='\'' );
344533e619fcSdrh       z = &pExpr->u.zToken[2];
3446b7916a78Sdrh       n = sqlite3Strlen30(z) - 1;
3447b7916a78Sdrh       assert( z[n]=='\'' );
3448ca48c90fSdrh       zBlob = sqlite3HexToBlob(sqlite3VdbeDb(v), z, n);
3449ca48c90fSdrh       sqlite3VdbeAddOp4(v, OP_Blob, n/2, target, 0, zBlob, P4_DYNAMIC);
3450c332cc30Sdrh       return target;
3451c572ef7fSdanielk1977     }
34525338a5f7Sdanielk1977 #endif
345350457896Sdrh     case TK_VARIABLE: {
345433e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
345533e619fcSdrh       assert( pExpr->u.zToken!=0 );
345633e619fcSdrh       assert( pExpr->u.zToken[0]!=0 );
3457eaf52d88Sdrh       sqlite3VdbeAddOp2(v, OP_Variable, pExpr->iColumn, target);
345833e619fcSdrh       if( pExpr->u.zToken[1]!=0 ){
34599bf755ccSdrh         const char *z = sqlite3VListNumToName(pParse->pVList, pExpr->iColumn);
34609bf755ccSdrh         assert( pExpr->u.zToken[0]=='?' || strcmp(pExpr->u.zToken, z)==0 );
3461ce1bbe51Sdrh         pParse->pVList[0] = 0; /* Indicate VList may no longer be enlarged */
34629bf755ccSdrh         sqlite3VdbeAppendP4(v, (char*)z, P4_STATIC);
34639bf755ccSdrh       }
3464c332cc30Sdrh       return target;
346550457896Sdrh     }
34664e0cff60Sdrh     case TK_REGISTER: {
3467c332cc30Sdrh       return pExpr->iTable;
34684e0cff60Sdrh     }
3469487e262fSdrh #ifndef SQLITE_OMIT_CAST
3470487e262fSdrh     case TK_CAST: {
3471487e262fSdrh       /* Expressions of the form:   CAST(pLeft AS token) */
34722dcef11bSdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
34731735fa88Sdrh       if( inReg!=target ){
34741735fa88Sdrh         sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
34751735fa88Sdrh         inReg = target;
34761735fa88Sdrh       }
34774169e430Sdrh       sqlite3VdbeAddOp2(v, OP_Cast, target,
34784169e430Sdrh                         sqlite3AffinityType(pExpr->u.zToken, 0));
3479c332cc30Sdrh       return inReg;
3480487e262fSdrh     }
3481487e262fSdrh #endif /* SQLITE_OMIT_CAST */
348271c57db0Sdan     case TK_IS:
348371c57db0Sdan     case TK_ISNOT:
348471c57db0Sdan       op = (op==TK_IS) ? TK_EQ : TK_NE;
348571c57db0Sdan       p5 = SQLITE_NULLEQ;
348671c57db0Sdan       /* fall-through */
3487c9b84a1fSdrh     case TK_LT:
3488c9b84a1fSdrh     case TK_LE:
3489c9b84a1fSdrh     case TK_GT:
3490c9b84a1fSdrh     case TK_GE:
3491c9b84a1fSdrh     case TK_NE:
3492c9b84a1fSdrh     case TK_EQ: {
349371c57db0Sdan       Expr *pLeft = pExpr->pLeft;
3494625015e0Sdan       if( sqlite3ExprIsVector(pLeft) ){
349579752b6eSdrh         codeVectorCompare(pParse, pExpr, target, op, p5);
349671c57db0Sdan       }else{
349771c57db0Sdan         r1 = sqlite3ExprCodeTemp(pParse, pLeft, &regFree1);
3498b6da74ebSdrh         r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
349971c57db0Sdan         codeCompare(pParse, pLeft, pExpr->pRight, op,
350071c57db0Sdan             r1, r2, inReg, SQLITE_STOREP2 | p5);
35017d176105Sdrh         assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
35027d176105Sdrh         assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
35037d176105Sdrh         assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
35047d176105Sdrh         assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
35057d176105Sdrh         assert(TK_EQ==OP_Eq); testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
35067d176105Sdrh         assert(TK_NE==OP_Ne); testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
3507c5499befSdrh         testcase( regFree1==0 );
3508c5499befSdrh         testcase( regFree2==0 );
3509c9b84a1fSdrh       }
35106a2fe093Sdrh       break;
35116a2fe093Sdrh     }
3512cce7d176Sdrh     case TK_AND:
3513cce7d176Sdrh     case TK_OR:
3514cce7d176Sdrh     case TK_PLUS:
3515cce7d176Sdrh     case TK_STAR:
3516cce7d176Sdrh     case TK_MINUS:
3517bf4133cbSdrh     case TK_REM:
3518bf4133cbSdrh     case TK_BITAND:
3519bf4133cbSdrh     case TK_BITOR:
352017c40294Sdrh     case TK_SLASH:
3521bf4133cbSdrh     case TK_LSHIFT:
3522855eb1cfSdrh     case TK_RSHIFT:
35230040077dSdrh     case TK_CONCAT: {
35247d176105Sdrh       assert( TK_AND==OP_And );            testcase( op==TK_AND );
35257d176105Sdrh       assert( TK_OR==OP_Or );              testcase( op==TK_OR );
35267d176105Sdrh       assert( TK_PLUS==OP_Add );           testcase( op==TK_PLUS );
35277d176105Sdrh       assert( TK_MINUS==OP_Subtract );     testcase( op==TK_MINUS );
35287d176105Sdrh       assert( TK_REM==OP_Remainder );      testcase( op==TK_REM );
35297d176105Sdrh       assert( TK_BITAND==OP_BitAnd );      testcase( op==TK_BITAND );
35307d176105Sdrh       assert( TK_BITOR==OP_BitOr );        testcase( op==TK_BITOR );
35317d176105Sdrh       assert( TK_SLASH==OP_Divide );       testcase( op==TK_SLASH );
35327d176105Sdrh       assert( TK_LSHIFT==OP_ShiftLeft );   testcase( op==TK_LSHIFT );
35337d176105Sdrh       assert( TK_RSHIFT==OP_ShiftRight );  testcase( op==TK_RSHIFT );
35347d176105Sdrh       assert( TK_CONCAT==OP_Concat );      testcase( op==TK_CONCAT );
35352dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
35362dcef11bSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
35375b6afba9Sdrh       sqlite3VdbeAddOp3(v, op, r2, r1, target);
3538c5499befSdrh       testcase( regFree1==0 );
3539c5499befSdrh       testcase( regFree2==0 );
35400040077dSdrh       break;
35410040077dSdrh     }
3542cce7d176Sdrh     case TK_UMINUS: {
3543fec19aadSdrh       Expr *pLeft = pExpr->pLeft;
3544fec19aadSdrh       assert( pLeft );
354513573c71Sdrh       if( pLeft->op==TK_INTEGER ){
354613573c71Sdrh         codeInteger(pParse, pLeft, 1, target);
3547c332cc30Sdrh         return target;
354813573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
354913573c71Sdrh       }else if( pLeft->op==TK_FLOAT ){
355033e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
355133e619fcSdrh         codeReal(v, pLeft->u.zToken, 1, target);
3552c332cc30Sdrh         return target;
355313573c71Sdrh #endif
35543c84ddffSdrh       }else{
355510d1edf0Sdrh         tempX.op = TK_INTEGER;
355610d1edf0Sdrh         tempX.flags = EP_IntValue|EP_TokenOnly;
355710d1edf0Sdrh         tempX.u.iValue = 0;
355810d1edf0Sdrh         r1 = sqlite3ExprCodeTemp(pParse, &tempX, &regFree1);
3559e55cbd72Sdrh         r2 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree2);
35602dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_Subtract, r2, r1, target);
3561c5499befSdrh         testcase( regFree2==0 );
35623c84ddffSdrh       }
35636e142f54Sdrh       break;
35646e142f54Sdrh     }
3565bf4133cbSdrh     case TK_BITNOT:
35666e142f54Sdrh     case TK_NOT: {
35677d176105Sdrh       assert( TK_BITNOT==OP_BitNot );   testcase( op==TK_BITNOT );
35687d176105Sdrh       assert( TK_NOT==OP_Not );         testcase( op==TK_NOT );
3569e99fa2afSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3570e99fa2afSdrh       testcase( regFree1==0 );
3571e99fa2afSdrh       sqlite3VdbeAddOp2(v, op, r1, inReg);
3572cce7d176Sdrh       break;
3573cce7d176Sdrh     }
35748abed7b9Sdrh     case TK_TRUTH: {
357596acafbeSdrh       int isTrue;    /* IS TRUE or IS NOT TRUE */
357696acafbeSdrh       int bNormal;   /* IS TRUE or IS FALSE */
3577007c843bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3578007c843bSdrh       testcase( regFree1==0 );
357996acafbeSdrh       isTrue = sqlite3ExprTruthValue(pExpr->pRight);
358096acafbeSdrh       bNormal = pExpr->op2==TK_IS;
358196acafbeSdrh       testcase( isTrue && bNormal);
358296acafbeSdrh       testcase( !isTrue && bNormal);
358396acafbeSdrh       sqlite3VdbeAddOp4Int(v, OP_IsTrue, r1, inReg, !isTrue, isTrue ^ bNormal);
3584007c843bSdrh       break;
3585007c843bSdrh     }
3586cce7d176Sdrh     case TK_ISNULL:
3587cce7d176Sdrh     case TK_NOTNULL: {
35886a288a33Sdrh       int addr;
35897d176105Sdrh       assert( TK_ISNULL==OP_IsNull );   testcase( op==TK_ISNULL );
35907d176105Sdrh       assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
35919de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
35922dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3593c5499befSdrh       testcase( regFree1==0 );
35942dcef11bSdrh       addr = sqlite3VdbeAddOp1(v, op, r1);
35957d176105Sdrh       VdbeCoverageIf(v, op==TK_ISNULL);
35967d176105Sdrh       VdbeCoverageIf(v, op==TK_NOTNULL);
3597a976979bSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 0, target);
35986a288a33Sdrh       sqlite3VdbeJumpHere(v, addr);
3599a37cdde0Sdanielk1977       break;
3600f2bc013cSdrh     }
36012282792aSdrh     case TK_AGG_FUNCTION: {
360213449892Sdrh       AggInfo *pInfo = pExpr->pAggInfo;
36037e56e711Sdrh       if( pInfo==0 ){
360433e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
360533e619fcSdrh         sqlite3ErrorMsg(pParse, "misuse of aggregate: %s()", pExpr->u.zToken);
36067e56e711Sdrh       }else{
3607c332cc30Sdrh         return pInfo->aFunc[pExpr->iAgg].iMem;
36087e56e711Sdrh       }
36092282792aSdrh       break;
36102282792aSdrh     }
3611cce7d176Sdrh     case TK_FUNCTION: {
361212ffee8cSdrh       ExprList *pFarg;       /* List of function arguments */
361312ffee8cSdrh       int nFarg;             /* Number of function arguments */
361412ffee8cSdrh       FuncDef *pDef;         /* The function definition object */
361512ffee8cSdrh       const char *zId;       /* The function name */
3616693e6719Sdrh       u32 constMask = 0;     /* Mask of function arguments that are constant */
361712ffee8cSdrh       int i;                 /* Loop counter */
3618c332cc30Sdrh       sqlite3 *db = pParse->db;  /* The database connection */
361912ffee8cSdrh       u8 enc = ENC(db);      /* The text encoding used by this database */
362012ffee8cSdrh       CollSeq *pColl = 0;    /* A collating sequence */
362117435752Sdrh 
362267a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
3623*eda079cdSdrh       if( ExprHasProperty(pExpr, EP_WinFunc) ){
3624*eda079cdSdrh         return pExpr->y.pWin->regResult;
362586fb6e17Sdan       }
362667a9b8edSdan #endif
362786fb6e17Sdan 
36281e9b53f9Sdrh       if( ConstFactorOk(pParse) && sqlite3ExprIsConstantNotJoin(pExpr) ){
362949c5ab24Sdrh         /* SQL functions can be expensive. So try to move constant functions
3630ad879ffdSdrh         ** out of the inner loop, even if that means an extra OP_Copy. */
3631ad879ffdSdrh         return sqlite3ExprCodeAtInit(pParse, pExpr, -1);
36321e9b53f9Sdrh       }
36336ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
3634c5cd1249Sdrh       if( ExprHasProperty(pExpr, EP_TokenOnly) ){
363512ffee8cSdrh         pFarg = 0;
363612ffee8cSdrh       }else{
363712ffee8cSdrh         pFarg = pExpr->x.pList;
363812ffee8cSdrh       }
363912ffee8cSdrh       nFarg = pFarg ? pFarg->nExpr : 0;
364033e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
364133e619fcSdrh       zId = pExpr->u.zToken;
364280738d9cSdrh       pDef = sqlite3FindFunction(db, zId, nFarg, enc, 0);
3643cc15313cSdrh #ifdef SQLITE_ENABLE_UNKNOWN_SQL_FUNCTION
3644cc15313cSdrh       if( pDef==0 && pParse->explain ){
3645cc15313cSdrh         pDef = sqlite3FindFunction(db, "unknown", nFarg, enc, 0);
3646cc15313cSdrh       }
3647cc15313cSdrh #endif
3648b6e9f7a4Sdan       if( pDef==0 || pDef->xFinalize!=0 ){
364980738d9cSdrh         sqlite3ErrorMsg(pParse, "unknown function: %s()", zId);
3650feb306f5Sdrh         break;
3651feb306f5Sdrh       }
3652ae6bb957Sdrh 
3653ae6bb957Sdrh       /* Attempt a direct implementation of the built-in COALESCE() and
365460ec914cSpeter.d.reid       ** IFNULL() functions.  This avoids unnecessary evaluation of
3655ae6bb957Sdrh       ** arguments past the first non-NULL argument.
3656ae6bb957Sdrh       */
3657d36e1041Sdrh       if( pDef->funcFlags & SQLITE_FUNC_COALESCE ){
3658ae6bb957Sdrh         int endCoalesce = sqlite3VdbeMakeLabel(v);
3659ae6bb957Sdrh         assert( nFarg>=2 );
3660ae6bb957Sdrh         sqlite3ExprCode(pParse, pFarg->a[0].pExpr, target);
3661ae6bb957Sdrh         for(i=1; i<nFarg; i++){
3662ae6bb957Sdrh           sqlite3VdbeAddOp2(v, OP_NotNull, target, endCoalesce);
3663688852abSdrh           VdbeCoverage(v);
3664ae6bb957Sdrh           sqlite3ExprCode(pParse, pFarg->a[i].pExpr, target);
3665ae6bb957Sdrh         }
3666ae6bb957Sdrh         sqlite3VdbeResolveLabel(v, endCoalesce);
3667ae6bb957Sdrh         break;
3668ae6bb957Sdrh       }
3669ae6bb957Sdrh 
3670cca9f3d2Sdrh       /* The UNLIKELY() function is a no-op.  The result is the value
3671cca9f3d2Sdrh       ** of the first argument.
3672cca9f3d2Sdrh       */
3673cca9f3d2Sdrh       if( pDef->funcFlags & SQLITE_FUNC_UNLIKELY ){
3674cca9f3d2Sdrh         assert( nFarg>=1 );
3675c332cc30Sdrh         return sqlite3ExprCodeTarget(pParse, pFarg->a[0].pExpr, target);
3676cca9f3d2Sdrh       }
3677ae6bb957Sdrh 
367854240751Sdrh #ifdef SQLITE_DEBUG
3679a1a523a5Sdrh       /* The AFFINITY() function evaluates to a string that describes
3680a1a523a5Sdrh       ** the type affinity of the argument.  This is used for testing of
3681a1a523a5Sdrh       ** the SQLite type logic.
3682a1a523a5Sdrh       */
3683a1a523a5Sdrh       if( pDef->funcFlags & SQLITE_FUNC_AFFINITY ){
3684a1a523a5Sdrh         const char *azAff[] = { "blob", "text", "numeric", "integer", "real" };
3685a1a523a5Sdrh         char aff;
3686a1a523a5Sdrh         assert( nFarg==1 );
3687a1a523a5Sdrh         aff = sqlite3ExprAffinity(pFarg->a[0].pExpr);
3688a1a523a5Sdrh         sqlite3VdbeLoadString(v, target,
3689a1a523a5Sdrh                               aff ? azAff[aff-SQLITE_AFF_BLOB] : "none");
3690a1a523a5Sdrh         return target;
3691a1a523a5Sdrh       }
369254240751Sdrh #endif
3693a1a523a5Sdrh 
3694d1a01edaSdrh       for(i=0; i<nFarg; i++){
3695d1a01edaSdrh         if( i<32 && sqlite3ExprIsConstant(pFarg->a[i].pExpr) ){
3696693e6719Sdrh           testcase( i==31 );
3697693e6719Sdrh           constMask |= MASKBIT32(i);
3698d1a01edaSdrh         }
3699d1a01edaSdrh         if( (pDef->funcFlags & SQLITE_FUNC_NEEDCOLL)!=0 && !pColl ){
3700d1a01edaSdrh           pColl = sqlite3ExprCollSeq(pParse, pFarg->a[i].pExpr);
3701d1a01edaSdrh         }
3702d1a01edaSdrh       }
370312ffee8cSdrh       if( pFarg ){
3704d1a01edaSdrh         if( constMask ){
3705d1a01edaSdrh           r1 = pParse->nMem+1;
3706d1a01edaSdrh           pParse->nMem += nFarg;
3707d1a01edaSdrh         }else{
370812ffee8cSdrh           r1 = sqlite3GetTempRange(pParse, nFarg);
3709d1a01edaSdrh         }
3710a748fdccSdrh 
3711a748fdccSdrh         /* For length() and typeof() functions with a column argument,
3712a748fdccSdrh         ** set the P5 parameter to the OP_Column opcode to OPFLAG_LENGTHARG
3713a748fdccSdrh         ** or OPFLAG_TYPEOFARG respectively, to avoid unnecessary data
3714a748fdccSdrh         ** loading.
3715a748fdccSdrh         */
3716d36e1041Sdrh         if( (pDef->funcFlags & (SQLITE_FUNC_LENGTH|SQLITE_FUNC_TYPEOF))!=0 ){
37174e245a4cSdrh           u8 exprOp;
3718a748fdccSdrh           assert( nFarg==1 );
3719a748fdccSdrh           assert( pFarg->a[0].pExpr!=0 );
37204e245a4cSdrh           exprOp = pFarg->a[0].pExpr->op;
37214e245a4cSdrh           if( exprOp==TK_COLUMN || exprOp==TK_AGG_COLUMN ){
3722a748fdccSdrh             assert( SQLITE_FUNC_LENGTH==OPFLAG_LENGTHARG );
3723a748fdccSdrh             assert( SQLITE_FUNC_TYPEOF==OPFLAG_TYPEOFARG );
3724b1fba286Sdrh             testcase( pDef->funcFlags & OPFLAG_LENGTHARG );
3725b1fba286Sdrh             pFarg->a[0].pExpr->op2 =
3726b1fba286Sdrh                   pDef->funcFlags & (OPFLAG_LENGTHARG|OPFLAG_TYPEOFARG);
3727a748fdccSdrh           }
3728a748fdccSdrh         }
3729a748fdccSdrh 
37305579d59fSdrh         sqlite3ExprCodeExprList(pParse, pFarg, r1, 0,
3731d1a01edaSdrh                                 SQLITE_ECEL_DUP|SQLITE_ECEL_FACTOR);
3732892d3179Sdrh       }else{
373312ffee8cSdrh         r1 = 0;
3734892d3179Sdrh       }
3735b7f6f68fSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
3736a43fa227Sdrh       /* Possibly overload the function if the first argument is
3737a43fa227Sdrh       ** a virtual table column.
3738a43fa227Sdrh       **
3739a43fa227Sdrh       ** For infix functions (LIKE, GLOB, REGEXP, and MATCH) use the
3740a43fa227Sdrh       ** second argument, not the first, as the argument to test to
3741a43fa227Sdrh       ** see if it is a column in a virtual table.  This is done because
3742a43fa227Sdrh       ** the left operand of infix functions (the operand we want to
3743a43fa227Sdrh       ** control overloading) ends up as the second argument to the
3744a43fa227Sdrh       ** function.  The expression "A glob B" is equivalent to
3745a43fa227Sdrh       ** "glob(B,A).  We want to use the A in "A glob B" to test
3746a43fa227Sdrh       ** for function overloading.  But we use the B term in "glob(B,A)".
3747a43fa227Sdrh       */
374859155065Sdrh       if( nFarg>=2 && ExprHasProperty(pExpr, EP_InfixFunc) ){
374912ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[1].pExpr);
375012ffee8cSdrh       }else if( nFarg>0 ){
375112ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[0].pExpr);
3752b7f6f68fSdrh       }
3753b7f6f68fSdrh #endif
3754d36e1041Sdrh       if( pDef->funcFlags & SQLITE_FUNC_NEEDCOLL ){
37558b213899Sdrh         if( !pColl ) pColl = db->pDfltColl;
375666a5167bSdrh         sqlite3VdbeAddOp4(v, OP_CollSeq, 0, 0, 0, (char *)pColl, P4_COLLSEQ);
3757682f68b0Sdanielk1977       }
3758092457b1Sdrh #ifdef SQLITE_ENABLE_OFFSET_SQL_FUNC
3759092457b1Sdrh       if( pDef->funcFlags & SQLITE_FUNC_OFFSET ){
37602fc865c1Sdrh         Expr *pArg = pFarg->a[0].pExpr;
37612fc865c1Sdrh         if( pArg->op==TK_COLUMN ){
3762092457b1Sdrh           sqlite3VdbeAddOp3(v, OP_Offset, pArg->iTable, pArg->iColumn, target);
37632fc865c1Sdrh         }else{
37642fc865c1Sdrh           sqlite3VdbeAddOp2(v, OP_Null, 0, target);
37652fc865c1Sdrh         }
3766092457b1Sdrh       }else
3767092457b1Sdrh #endif
3768092457b1Sdrh       {
37693e34eabcSdrh         sqlite3VdbeAddOp4(v, pParse->iSelfTab ? OP_PureFunc0 : OP_Function0,
37703e34eabcSdrh                           constMask, r1, target, (char*)pDef, P4_FUNCDEF);
377112ffee8cSdrh         sqlite3VdbeChangeP5(v, (u8)nFarg);
37722fc865c1Sdrh       }
3773d1a01edaSdrh       if( nFarg && constMask==0 ){
377412ffee8cSdrh         sqlite3ReleaseTempRange(pParse, r1, nFarg);
37752dcef11bSdrh       }
3776c332cc30Sdrh       return target;
37776ec2733bSdrh     }
3778fe2093d7Sdrh #ifndef SQLITE_OMIT_SUBQUERY
3779fe2093d7Sdrh     case TK_EXISTS:
378019a775c2Sdrh     case TK_SELECT: {
37818da209b1Sdan       int nCol;
3782c5499befSdrh       testcase( op==TK_EXISTS );
3783c5499befSdrh       testcase( op==TK_SELECT );
37848da209b1Sdan       if( op==TK_SELECT && (nCol = pExpr->x.pSelect->pEList->nExpr)!=1 ){
37858da209b1Sdan         sqlite3SubselectError(pParse, nCol, 1);
37868da209b1Sdan       }else{
3787c332cc30Sdrh         return sqlite3CodeSubselect(pParse, pExpr, 0, 0);
37888da209b1Sdan       }
378919a775c2Sdrh       break;
379019a775c2Sdrh     }
3791fc7f27b9Sdrh     case TK_SELECT_COLUMN: {
3792966e2911Sdrh       int n;
3793fc7f27b9Sdrh       if( pExpr->pLeft->iTable==0 ){
3794fc7f27b9Sdrh         pExpr->pLeft->iTable = sqlite3CodeSubselect(pParse, pExpr->pLeft, 0, 0);
3795fc7f27b9Sdrh       }
3796966e2911Sdrh       assert( pExpr->iTable==0 || pExpr->pLeft->op==TK_SELECT );
3797966e2911Sdrh       if( pExpr->iTable
3798966e2911Sdrh        && pExpr->iTable!=(n = sqlite3ExprVectorSize(pExpr->pLeft))
3799966e2911Sdrh       ){
3800966e2911Sdrh         sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
3801966e2911Sdrh                                 pExpr->iTable, n);
3802966e2911Sdrh       }
3803c332cc30Sdrh       return pExpr->pLeft->iTable + pExpr->iColumn;
3804fc7f27b9Sdrh     }
3805fef5208cSdrh     case TK_IN: {
3806e3365e6cSdrh       int destIfFalse = sqlite3VdbeMakeLabel(v);
3807e3365e6cSdrh       int destIfNull = sqlite3VdbeMakeLabel(v);
3808e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3809e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
381066ba23ceSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
3811e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
3812e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_AddImm, target, 0);
3813e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfNull);
3814c332cc30Sdrh       return target;
3815fef5208cSdrh     }
3816e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
3817e3365e6cSdrh 
3818e3365e6cSdrh 
38192dcef11bSdrh     /*
38202dcef11bSdrh     **    x BETWEEN y AND z
38212dcef11bSdrh     **
38222dcef11bSdrh     ** This is equivalent to
38232dcef11bSdrh     **
38242dcef11bSdrh     **    x>=y AND x<=z
38252dcef11bSdrh     **
38262dcef11bSdrh     ** X is stored in pExpr->pLeft.
38272dcef11bSdrh     ** Y is stored in pExpr->pList->a[0].pExpr.
38282dcef11bSdrh     ** Z is stored in pExpr->pList->a[1].pExpr.
38292dcef11bSdrh     */
3830fef5208cSdrh     case TK_BETWEEN: {
383171c57db0Sdan       exprCodeBetween(pParse, pExpr, target, 0, 0);
3832c332cc30Sdrh       return target;
3833fef5208cSdrh     }
383494fa9c41Sdrh     case TK_SPAN:
3835ae80ddeaSdrh     case TK_COLLATE:
38364f07e5fbSdrh     case TK_UPLUS: {
38371efa8023Sdrh       pExpr = pExpr->pLeft;
383859ee43a7Sdrh       goto expr_code_doover; /* 2018-04-28: Prevent deep recursion. OSSFuzz. */
3839a2e00042Sdrh     }
38402dcef11bSdrh 
3841165921a7Sdan     case TK_TRIGGER: {
384265a7cd16Sdan       /* If the opcode is TK_TRIGGER, then the expression is a reference
384365a7cd16Sdan       ** to a column in the new.* or old.* pseudo-tables available to
384465a7cd16Sdan       ** trigger programs. In this case Expr.iTable is set to 1 for the
384565a7cd16Sdan       ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
384665a7cd16Sdan       ** is set to the column of the pseudo-table to read, or to -1 to
384765a7cd16Sdan       ** read the rowid field.
384865a7cd16Sdan       **
384965a7cd16Sdan       ** The expression is implemented using an OP_Param opcode. The p1
385065a7cd16Sdan       ** parameter is set to 0 for an old.rowid reference, or to (i+1)
385165a7cd16Sdan       ** to reference another column of the old.* pseudo-table, where
385265a7cd16Sdan       ** i is the index of the column. For a new.rowid reference, p1 is
385365a7cd16Sdan       ** set to (n+1), where n is the number of columns in each pseudo-table.
385465a7cd16Sdan       ** For a reference to any other column in the new.* pseudo-table, p1
385565a7cd16Sdan       ** is set to (n+2+i), where n and i are as defined previously. For
385665a7cd16Sdan       ** example, if the table on which triggers are being fired is
385765a7cd16Sdan       ** declared as:
385865a7cd16Sdan       **
385965a7cd16Sdan       **   CREATE TABLE t1(a, b);
386065a7cd16Sdan       **
386165a7cd16Sdan       ** Then p1 is interpreted as follows:
386265a7cd16Sdan       **
386365a7cd16Sdan       **   p1==0   ->    old.rowid     p1==3   ->    new.rowid
386465a7cd16Sdan       **   p1==1   ->    old.a         p1==4   ->    new.a
386565a7cd16Sdan       **   p1==2   ->    old.b         p1==5   ->    new.b
386665a7cd16Sdan       */
3867*eda079cdSdrh       Table *pTab = pExpr->y.pTab;
386865a7cd16Sdan       int p1 = pExpr->iTable * (pTab->nCol+1) + 1 + pExpr->iColumn;
386965a7cd16Sdan 
387065a7cd16Sdan       assert( pExpr->iTable==0 || pExpr->iTable==1 );
387165a7cd16Sdan       assert( pExpr->iColumn>=-1 && pExpr->iColumn<pTab->nCol );
387265a7cd16Sdan       assert( pTab->iPKey<0 || pExpr->iColumn!=pTab->iPKey );
387365a7cd16Sdan       assert( p1>=0 && p1<(pTab->nCol*2+2) );
387465a7cd16Sdan 
387565a7cd16Sdan       sqlite3VdbeAddOp2(v, OP_Param, p1, target);
3876896494e8Sdrh       VdbeComment((v, "r[%d]=%s.%s", target,
3877165921a7Sdan         (pExpr->iTable ? "new" : "old"),
3878*eda079cdSdrh         (pExpr->iColumn<0 ? "rowid" : pExpr->y.pTab->aCol[pExpr->iColumn].zName)
3879165921a7Sdan       ));
388065a7cd16Sdan 
388144dbca83Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
388265a7cd16Sdan       /* If the column has REAL affinity, it may currently be stored as an
3883113762a2Sdrh       ** integer. Use OP_RealAffinity to make sure it is really real.
3884113762a2Sdrh       **
3885113762a2Sdrh       ** EVIDENCE-OF: R-60985-57662 SQLite will convert the value back to
3886113762a2Sdrh       ** floating point when extracting it from the record.  */
38872832ad42Sdan       if( pExpr->iColumn>=0
38882832ad42Sdan        && pTab->aCol[pExpr->iColumn].affinity==SQLITE_AFF_REAL
38892832ad42Sdan       ){
38902832ad42Sdan         sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
38912832ad42Sdan       }
389244dbca83Sdrh #endif
3893165921a7Sdan       break;
3894165921a7Sdan     }
3895165921a7Sdan 
389671c57db0Sdan     case TK_VECTOR: {
3897e835bc12Sdrh       sqlite3ErrorMsg(pParse, "row value misused");
389871c57db0Sdan       break;
389971c57db0Sdan     }
390071c57db0Sdan 
390131d6fd55Sdrh     case TK_IF_NULL_ROW: {
390231d6fd55Sdrh       int addrINR;
390331d6fd55Sdrh       addrINR = sqlite3VdbeAddOp1(v, OP_IfNullRow, pExpr->iTable);
390431d6fd55Sdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
390531d6fd55Sdrh       sqlite3VdbeJumpHere(v, addrINR);
390631d6fd55Sdrh       sqlite3VdbeChangeP3(v, addrINR, inReg);
390731d6fd55Sdrh       break;
390831d6fd55Sdrh     }
390931d6fd55Sdrh 
39102dcef11bSdrh     /*
39112dcef11bSdrh     ** Form A:
39122dcef11bSdrh     **   CASE x WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
39132dcef11bSdrh     **
39142dcef11bSdrh     ** Form B:
39152dcef11bSdrh     **   CASE WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
39162dcef11bSdrh     **
39172dcef11bSdrh     ** Form A is can be transformed into the equivalent form B as follows:
39182dcef11bSdrh     **   CASE WHEN x=e1 THEN r1 WHEN x=e2 THEN r2 ...
39192dcef11bSdrh     **        WHEN x=eN THEN rN ELSE y END
39202dcef11bSdrh     **
39212dcef11bSdrh     ** X (if it exists) is in pExpr->pLeft.
3922c5cd1249Sdrh     ** Y is in the last element of pExpr->x.pList if pExpr->x.pList->nExpr is
3923c5cd1249Sdrh     ** odd.  The Y is also optional.  If the number of elements in x.pList
3924c5cd1249Sdrh     ** is even, then Y is omitted and the "otherwise" result is NULL.
39252dcef11bSdrh     ** Ei is in pExpr->pList->a[i*2] and Ri is pExpr->pList->a[i*2+1].
39262dcef11bSdrh     **
39272dcef11bSdrh     ** The result of the expression is the Ri for the first matching Ei,
39282dcef11bSdrh     ** or if there is no matching Ei, the ELSE term Y, or if there is
39292dcef11bSdrh     ** no ELSE term, NULL.
39302dcef11bSdrh     */
393133cd4909Sdrh     default: assert( op==TK_CASE ); {
39322dcef11bSdrh       int endLabel;                     /* GOTO label for end of CASE stmt */
39332dcef11bSdrh       int nextCase;                     /* GOTO label for next WHEN clause */
39342dcef11bSdrh       int nExpr;                        /* 2x number of WHEN terms */
39352dcef11bSdrh       int i;                            /* Loop counter */
39362dcef11bSdrh       ExprList *pEList;                 /* List of WHEN terms */
39372dcef11bSdrh       struct ExprList_item *aListelem;  /* Array of WHEN terms */
39382dcef11bSdrh       Expr opCompare;                   /* The X==Ei expression */
39392dcef11bSdrh       Expr *pX;                         /* The X expression */
39401bd10f8aSdrh       Expr *pTest = 0;                  /* X==Ei (form A) or just Ei (form B) */
394117a7f8ddSdrh 
39426ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) && pExpr->x.pList );
39436ab3a2ecSdanielk1977       assert(pExpr->x.pList->nExpr > 0);
39446ab3a2ecSdanielk1977       pEList = pExpr->x.pList;
3945be5c89acSdrh       aListelem = pEList->a;
3946be5c89acSdrh       nExpr = pEList->nExpr;
39472dcef11bSdrh       endLabel = sqlite3VdbeMakeLabel(v);
39482dcef11bSdrh       if( (pX = pExpr->pLeft)!=0 ){
394910d1edf0Sdrh         tempX = *pX;
395033cd4909Sdrh         testcase( pX->op==TK_COLUMN );
395112abf408Sdrh         exprToRegister(&tempX, exprCodeVector(pParse, &tempX, &regFree1));
3952c5499befSdrh         testcase( regFree1==0 );
3953abb9d5f1Sdrh         memset(&opCompare, 0, sizeof(opCompare));
39542dcef11bSdrh         opCompare.op = TK_EQ;
395510d1edf0Sdrh         opCompare.pLeft = &tempX;
39562dcef11bSdrh         pTest = &opCompare;
39578b1db07fSdrh         /* Ticket b351d95f9cd5ef17e9d9dbae18f5ca8611190001:
39588b1db07fSdrh         ** The value in regFree1 might get SCopy-ed into the file result.
39598b1db07fSdrh         ** So make sure that the regFree1 register is not reused for other
39608b1db07fSdrh         ** purposes and possibly overwritten.  */
39618b1db07fSdrh         regFree1 = 0;
3962cce7d176Sdrh       }
3963c5cd1249Sdrh       for(i=0; i<nExpr-1; i=i+2){
39642dcef11bSdrh         if( pX ){
39651bd10f8aSdrh           assert( pTest!=0 );
39662dcef11bSdrh           opCompare.pRight = aListelem[i].pExpr;
3967f5905aa7Sdrh         }else{
39682dcef11bSdrh           pTest = aListelem[i].pExpr;
396917a7f8ddSdrh         }
39702dcef11bSdrh         nextCase = sqlite3VdbeMakeLabel(v);
397133cd4909Sdrh         testcase( pTest->op==TK_COLUMN );
39722dcef11bSdrh         sqlite3ExprIfFalse(pParse, pTest, nextCase, SQLITE_JUMPIFNULL);
3973c5499befSdrh         testcase( aListelem[i+1].pExpr->op==TK_COLUMN );
39749de221dfSdrh         sqlite3ExprCode(pParse, aListelem[i+1].pExpr, target);
3975076e85f5Sdrh         sqlite3VdbeGoto(v, endLabel);
39762dcef11bSdrh         sqlite3VdbeResolveLabel(v, nextCase);
3977f570f011Sdrh       }
3978c5cd1249Sdrh       if( (nExpr&1)!=0 ){
3979c5cd1249Sdrh         sqlite3ExprCode(pParse, pEList->a[nExpr-1].pExpr, target);
398017a7f8ddSdrh       }else{
39819de221dfSdrh         sqlite3VdbeAddOp2(v, OP_Null, 0, target);
398217a7f8ddSdrh       }
39832dcef11bSdrh       sqlite3VdbeResolveLabel(v, endLabel);
39846f34903eSdanielk1977       break;
39856f34903eSdanielk1977     }
39865338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_TRIGGER
39876f34903eSdanielk1977     case TK_RAISE: {
3988165921a7Sdan       assert( pExpr->affinity==OE_Rollback
3989165921a7Sdan            || pExpr->affinity==OE_Abort
3990165921a7Sdan            || pExpr->affinity==OE_Fail
3991165921a7Sdan            || pExpr->affinity==OE_Ignore
3992165921a7Sdan       );
3993e0af83acSdan       if( !pParse->pTriggerTab ){
3994e0af83acSdan         sqlite3ErrorMsg(pParse,
3995e0af83acSdan                        "RAISE() may only be used within a trigger-program");
3996e0af83acSdan         return 0;
3997e0af83acSdan       }
3998e0af83acSdan       if( pExpr->affinity==OE_Abort ){
3999e0af83acSdan         sqlite3MayAbort(pParse);
4000e0af83acSdan       }
400133e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
4002e0af83acSdan       if( pExpr->affinity==OE_Ignore ){
4003e0af83acSdan         sqlite3VdbeAddOp4(
4004e0af83acSdan             v, OP_Halt, SQLITE_OK, OE_Ignore, 0, pExpr->u.zToken,0);
4005688852abSdrh         VdbeCoverage(v);
4006e0af83acSdan       }else{
4007433dccfbSdrh         sqlite3HaltConstraint(pParse, SQLITE_CONSTRAINT_TRIGGER,
4008f9c8ce3cSdrh                               pExpr->affinity, pExpr->u.zToken, 0, 0);
4009e0af83acSdan       }
4010e0af83acSdan 
4011ffe07b2dSdrh       break;
401217a7f8ddSdrh     }
40135338a5f7Sdanielk1977 #endif
4014ffe07b2dSdrh   }
40152dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
40162dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
40172dcef11bSdrh   return inReg;
40185b6afba9Sdrh }
40192dcef11bSdrh 
40202dcef11bSdrh /*
4021d1a01edaSdrh ** Factor out the code of the given expression to initialization time.
40221e9b53f9Sdrh **
4023ad879ffdSdrh ** If regDest>=0 then the result is always stored in that register and the
4024ad879ffdSdrh ** result is not reusable.  If regDest<0 then this routine is free to
4025ad879ffdSdrh ** store the value whereever it wants.  The register where the expression
4026ad879ffdSdrh ** is stored is returned.  When regDest<0, two identical expressions will
4027ad879ffdSdrh ** code to the same register.
4028d1a01edaSdrh */
40291e9b53f9Sdrh int sqlite3ExprCodeAtInit(
4030d673cddaSdrh   Parse *pParse,    /* Parsing context */
4031d673cddaSdrh   Expr *pExpr,      /* The expression to code when the VDBE initializes */
4032ad879ffdSdrh   int regDest       /* Store the value in this register */
4033d673cddaSdrh ){
4034d1a01edaSdrh   ExprList *p;
4035d9f158e7Sdrh   assert( ConstFactorOk(pParse) );
4036d1a01edaSdrh   p = pParse->pConstExpr;
4037ad879ffdSdrh   if( regDest<0 && p ){
40381e9b53f9Sdrh     struct ExprList_item *pItem;
40391e9b53f9Sdrh     int i;
40401e9b53f9Sdrh     for(pItem=p->a, i=p->nExpr; i>0; pItem++, i--){
40415aa550cfSdan       if( pItem->reusable && sqlite3ExprCompare(0,pItem->pExpr,pExpr,-1)==0 ){
40421e9b53f9Sdrh         return pItem->u.iConstExprReg;
40431e9b53f9Sdrh       }
40441e9b53f9Sdrh     }
40451e9b53f9Sdrh   }
4046d1a01edaSdrh   pExpr = sqlite3ExprDup(pParse->db, pExpr, 0);
4047d1a01edaSdrh   p = sqlite3ExprListAppend(pParse, p, pExpr);
4048d673cddaSdrh   if( p ){
4049d673cddaSdrh      struct ExprList_item *pItem = &p->a[p->nExpr-1];
4050ad879ffdSdrh      pItem->reusable = regDest<0;
4051ad879ffdSdrh      if( regDest<0 ) regDest = ++pParse->nMem;
4052d673cddaSdrh      pItem->u.iConstExprReg = regDest;
4053d673cddaSdrh   }
4054d1a01edaSdrh   pParse->pConstExpr = p;
40551e9b53f9Sdrh   return regDest;
4056d1a01edaSdrh }
4057d1a01edaSdrh 
4058d1a01edaSdrh /*
40592dcef11bSdrh ** Generate code to evaluate an expression and store the results
40602dcef11bSdrh ** into a register.  Return the register number where the results
40612dcef11bSdrh ** are stored.
40622dcef11bSdrh **
40632dcef11bSdrh ** If the register is a temporary register that can be deallocated,
4064678ccce8Sdrh ** then write its number into *pReg.  If the result register is not
40652dcef11bSdrh ** a temporary, then set *pReg to zero.
4066f30a969bSdrh **
4067f30a969bSdrh ** If pExpr is a constant, then this routine might generate this
4068f30a969bSdrh ** code to fill the register in the initialization section of the
4069f30a969bSdrh ** VDBE program, in order to factor it out of the evaluation loop.
40702dcef11bSdrh */
40712dcef11bSdrh int sqlite3ExprCodeTemp(Parse *pParse, Expr *pExpr, int *pReg){
4072f30a969bSdrh   int r2;
4073f30a969bSdrh   pExpr = sqlite3ExprSkipCollate(pExpr);
4074d9f158e7Sdrh   if( ConstFactorOk(pParse)
4075f30a969bSdrh    && pExpr->op!=TK_REGISTER
4076f30a969bSdrh    && sqlite3ExprIsConstantNotJoin(pExpr)
4077f30a969bSdrh   ){
4078f30a969bSdrh     *pReg  = 0;
4079ad879ffdSdrh     r2 = sqlite3ExprCodeAtInit(pParse, pExpr, -1);
4080f30a969bSdrh   }else{
40812dcef11bSdrh     int r1 = sqlite3GetTempReg(pParse);
4082f30a969bSdrh     r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
40832dcef11bSdrh     if( r2==r1 ){
40842dcef11bSdrh       *pReg = r1;
40852dcef11bSdrh     }else{
40862dcef11bSdrh       sqlite3ReleaseTempReg(pParse, r1);
40872dcef11bSdrh       *pReg = 0;
40882dcef11bSdrh     }
4089f30a969bSdrh   }
40902dcef11bSdrh   return r2;
40912dcef11bSdrh }
40922dcef11bSdrh 
40932dcef11bSdrh /*
40942dcef11bSdrh ** Generate code that will evaluate expression pExpr and store the
40952dcef11bSdrh ** results in register target.  The results are guaranteed to appear
40962dcef11bSdrh ** in register target.
40972dcef11bSdrh */
409805a86c5cSdrh void sqlite3ExprCode(Parse *pParse, Expr *pExpr, int target){
40999cbf3425Sdrh   int inReg;
41009cbf3425Sdrh 
41019cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
4102ebc16717Sdrh   if( pExpr && pExpr->op==TK_REGISTER ){
4103ebc16717Sdrh     sqlite3VdbeAddOp2(pParse->pVdbe, OP_Copy, pExpr->iTable, target);
4104ebc16717Sdrh   }else{
41059cbf3425Sdrh     inReg = sqlite3ExprCodeTarget(pParse, pExpr, target);
41061c75c9d7Sdrh     assert( pParse->pVdbe!=0 || pParse->db->mallocFailed );
41070e359b30Sdrh     if( inReg!=target && pParse->pVdbe ){
41089cbf3425Sdrh       sqlite3VdbeAddOp2(pParse->pVdbe, OP_SCopy, inReg, target);
410917a7f8ddSdrh     }
4110ebc16717Sdrh   }
4111cce7d176Sdrh }
4112cce7d176Sdrh 
4113cce7d176Sdrh /*
41141c75c9d7Sdrh ** Make a transient copy of expression pExpr and then code it using
41151c75c9d7Sdrh ** sqlite3ExprCode().  This routine works just like sqlite3ExprCode()
41161c75c9d7Sdrh ** except that the input expression is guaranteed to be unchanged.
41171c75c9d7Sdrh */
41181c75c9d7Sdrh void sqlite3ExprCodeCopy(Parse *pParse, Expr *pExpr, int target){
41191c75c9d7Sdrh   sqlite3 *db = pParse->db;
41201c75c9d7Sdrh   pExpr = sqlite3ExprDup(db, pExpr, 0);
41211c75c9d7Sdrh   if( !db->mallocFailed ) sqlite3ExprCode(pParse, pExpr, target);
41221c75c9d7Sdrh   sqlite3ExprDelete(db, pExpr);
41231c75c9d7Sdrh }
41241c75c9d7Sdrh 
41251c75c9d7Sdrh /*
412605a86c5cSdrh ** Generate code that will evaluate expression pExpr and store the
412705a86c5cSdrh ** results in register target.  The results are guaranteed to appear
412805a86c5cSdrh ** in register target.  If the expression is constant, then this routine
412905a86c5cSdrh ** might choose to code the expression at initialization time.
413005a86c5cSdrh */
413105a86c5cSdrh void sqlite3ExprCodeFactorable(Parse *pParse, Expr *pExpr, int target){
4132b8b06690Sdrh   if( pParse->okConstFactor && sqlite3ExprIsConstantNotJoin(pExpr) ){
4133ad879ffdSdrh     sqlite3ExprCodeAtInit(pParse, pExpr, target);
413405a86c5cSdrh   }else{
413505a86c5cSdrh     sqlite3ExprCode(pParse, pExpr, target);
413605a86c5cSdrh   }
4137cce7d176Sdrh }
4138cce7d176Sdrh 
4139cce7d176Sdrh /*
414060ec914cSpeter.d.reid ** Generate code that evaluates the given expression and puts the result
4141de4fcfddSdrh ** in register target.
414225303780Sdrh **
41432dcef11bSdrh ** Also make a copy of the expression results into another "cache" register
41442dcef11bSdrh ** and modify the expression so that the next time it is evaluated,
41452dcef11bSdrh ** the result is a copy of the cache register.
41462dcef11bSdrh **
41472dcef11bSdrh ** This routine is used for expressions that are used multiple
41482dcef11bSdrh ** times.  They are evaluated once and the results of the expression
41492dcef11bSdrh ** are reused.
415025303780Sdrh */
415105a86c5cSdrh void sqlite3ExprCodeAndCache(Parse *pParse, Expr *pExpr, int target){
415225303780Sdrh   Vdbe *v = pParse->pVdbe;
415325303780Sdrh   int iMem;
415405a86c5cSdrh 
415505a86c5cSdrh   assert( target>0 );
415605a86c5cSdrh   assert( pExpr->op!=TK_REGISTER );
415705a86c5cSdrh   sqlite3ExprCode(pParse, pExpr, target);
41582dcef11bSdrh   iMem = ++pParse->nMem;
415905a86c5cSdrh   sqlite3VdbeAddOp2(v, OP_Copy, target, iMem);
4160a4c3c87eSdrh   exprToRegister(pExpr, iMem);
416125303780Sdrh }
41627e02e5e6Sdrh 
4163678ccce8Sdrh /*
4164268380caSdrh ** Generate code that pushes the value of every element of the given
41659cbf3425Sdrh ** expression list into a sequence of registers beginning at target.
4166268380caSdrh **
41673df6c3b1Sdrh ** Return the number of elements evaluated.  The number returned will
41683df6c3b1Sdrh ** usually be pList->nExpr but might be reduced if SQLITE_ECEL_OMITREF
41693df6c3b1Sdrh ** is defined.
4170d1a01edaSdrh **
4171d1a01edaSdrh ** The SQLITE_ECEL_DUP flag prevents the arguments from being
4172d1a01edaSdrh ** filled using OP_SCopy.  OP_Copy must be used instead.
4173d1a01edaSdrh **
4174d1a01edaSdrh ** The SQLITE_ECEL_FACTOR argument allows constant arguments to be
4175d1a01edaSdrh ** factored out into initialization code.
4176b0df9634Sdrh **
4177b0df9634Sdrh ** The SQLITE_ECEL_REF flag means that expressions in the list with
4178b0df9634Sdrh ** ExprList.a[].u.x.iOrderByCol>0 have already been evaluated and stored
4179b0df9634Sdrh ** in registers at srcReg, and so the value can be copied from there.
41803df6c3b1Sdrh ** If SQLITE_ECEL_OMITREF is also set, then the values with u.x.iOrderByCol>0
41813df6c3b1Sdrh ** are simply omitted rather than being copied from srcReg.
4182268380caSdrh */
41834adee20fSdanielk1977 int sqlite3ExprCodeExprList(
4184268380caSdrh   Parse *pParse,     /* Parsing context */
4185389a1adbSdrh   ExprList *pList,   /* The expression list to be coded */
4186191b54cbSdrh   int target,        /* Where to write results */
41875579d59fSdrh   int srcReg,        /* Source registers if SQLITE_ECEL_REF */
4188d1a01edaSdrh   u8 flags           /* SQLITE_ECEL_* flags */
4189268380caSdrh ){
4190268380caSdrh   struct ExprList_item *pItem;
41915579d59fSdrh   int i, j, n;
4192d1a01edaSdrh   u8 copyOp = (flags & SQLITE_ECEL_DUP) ? OP_Copy : OP_SCopy;
41935579d59fSdrh   Vdbe *v = pParse->pVdbe;
41949d8b3072Sdrh   assert( pList!=0 );
41959cbf3425Sdrh   assert( target>0 );
4196d81a142bSdrh   assert( pParse->pVdbe!=0 );  /* Never gets this far otherwise */
4197268380caSdrh   n = pList->nExpr;
4198d9f158e7Sdrh   if( !ConstFactorOk(pParse) ) flags &= ~SQLITE_ECEL_FACTOR;
4199191b54cbSdrh   for(pItem=pList->a, i=0; i<n; i++, pItem++){
42007445ffe2Sdrh     Expr *pExpr = pItem->pExpr;
420124e25d32Sdan #ifdef SQLITE_ENABLE_SORTER_REFERENCES
420224e25d32Sdan     if( pItem->bSorterRef ){
420324e25d32Sdan       i--;
420424e25d32Sdan       n--;
420524e25d32Sdan     }else
420624e25d32Sdan #endif
4207257c13faSdan     if( (flags & SQLITE_ECEL_REF)!=0 && (j = pItem->u.x.iOrderByCol)>0 ){
4208257c13faSdan       if( flags & SQLITE_ECEL_OMITREF ){
4209257c13faSdan         i--;
4210257c13faSdan         n--;
4211257c13faSdan       }else{
42125579d59fSdrh         sqlite3VdbeAddOp2(v, copyOp, j+srcReg-1, target+i);
4213257c13faSdan       }
4214b8b06690Sdrh     }else if( (flags & SQLITE_ECEL_FACTOR)!=0
4215b8b06690Sdrh            && sqlite3ExprIsConstantNotJoin(pExpr)
4216b8b06690Sdrh     ){
4217ad879ffdSdrh       sqlite3ExprCodeAtInit(pParse, pExpr, target+i);
4218d1a01edaSdrh     }else{
42197445ffe2Sdrh       int inReg = sqlite3ExprCodeTarget(pParse, pExpr, target+i);
4220746fd9ccSdrh       if( inReg!=target+i ){
42214eded604Sdrh         VdbeOp *pOp;
42224eded604Sdrh         if( copyOp==OP_Copy
42234eded604Sdrh          && (pOp=sqlite3VdbeGetOp(v, -1))->opcode==OP_Copy
42244eded604Sdrh          && pOp->p1+pOp->p3+1==inReg
42254eded604Sdrh          && pOp->p2+pOp->p3+1==target+i
42264eded604Sdrh         ){
42274eded604Sdrh           pOp->p3++;
42284eded604Sdrh         }else{
42294eded604Sdrh           sqlite3VdbeAddOp2(v, copyOp, inReg, target+i);
42304eded604Sdrh         }
4231d1a01edaSdrh       }
4232d176611bSdrh     }
4233268380caSdrh   }
4234f9b596ebSdrh   return n;
4235268380caSdrh }
4236268380caSdrh 
4237268380caSdrh /*
423836c563a2Sdrh ** Generate code for a BETWEEN operator.
423936c563a2Sdrh **
424036c563a2Sdrh **    x BETWEEN y AND z
424136c563a2Sdrh **
424236c563a2Sdrh ** The above is equivalent to
424336c563a2Sdrh **
424436c563a2Sdrh **    x>=y AND x<=z
424536c563a2Sdrh **
424636c563a2Sdrh ** Code it as such, taking care to do the common subexpression
424760ec914cSpeter.d.reid ** elimination of x.
424884b19a3dSdrh **
424984b19a3dSdrh ** The xJumpIf parameter determines details:
425084b19a3dSdrh **
425184b19a3dSdrh **    NULL:                   Store the boolean result in reg[dest]
425284b19a3dSdrh **    sqlite3ExprIfTrue:      Jump to dest if true
425384b19a3dSdrh **    sqlite3ExprIfFalse:     Jump to dest if false
425484b19a3dSdrh **
425584b19a3dSdrh ** The jumpIfNull parameter is ignored if xJumpIf is NULL.
425636c563a2Sdrh */
425736c563a2Sdrh static void exprCodeBetween(
425836c563a2Sdrh   Parse *pParse,    /* Parsing and code generating context */
425936c563a2Sdrh   Expr *pExpr,      /* The BETWEEN expression */
426084b19a3dSdrh   int dest,         /* Jump destination or storage location */
426184b19a3dSdrh   void (*xJump)(Parse*,Expr*,int,int), /* Action to take */
426236c563a2Sdrh   int jumpIfNull    /* Take the jump if the BETWEEN is NULL */
426336c563a2Sdrh ){
426436c563a2Sdrh  Expr exprAnd;     /* The AND operator in  x>=y AND x<=z  */
426536c563a2Sdrh   Expr compLeft;    /* The  x>=y  term */
426636c563a2Sdrh   Expr compRight;   /* The  x<=z  term */
4267db45bd5eSdrh   Expr exprX;       /* The  x  subexpression */
4268db45bd5eSdrh   int regFree1 = 0; /* Temporary use register */
426984b19a3dSdrh 
427036c563a2Sdrh 
427171c57db0Sdan   memset(&compLeft, 0, sizeof(Expr));
427271c57db0Sdan   memset(&compRight, 0, sizeof(Expr));
427371c57db0Sdan   memset(&exprAnd, 0, sizeof(Expr));
4274db45bd5eSdrh 
4275db45bd5eSdrh   assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
4276db45bd5eSdrh   exprX = *pExpr->pLeft;
427736c563a2Sdrh   exprAnd.op = TK_AND;
427836c563a2Sdrh   exprAnd.pLeft = &compLeft;
427936c563a2Sdrh   exprAnd.pRight = &compRight;
428036c563a2Sdrh   compLeft.op = TK_GE;
4281db45bd5eSdrh   compLeft.pLeft = &exprX;
428236c563a2Sdrh   compLeft.pRight = pExpr->x.pList->a[0].pExpr;
428336c563a2Sdrh   compRight.op = TK_LE;
4284db45bd5eSdrh   compRight.pLeft = &exprX;
428536c563a2Sdrh   compRight.pRight = pExpr->x.pList->a[1].pExpr;
428612abf408Sdrh   exprToRegister(&exprX, exprCodeVector(pParse, &exprX, &regFree1));
428784b19a3dSdrh   if( xJump ){
428884b19a3dSdrh     xJump(pParse, &exprAnd, dest, jumpIfNull);
428936c563a2Sdrh   }else{
429036fd41e5Sdrh     /* Mark the expression is being from the ON or USING clause of a join
429136fd41e5Sdrh     ** so that the sqlite3ExprCodeTarget() routine will not attempt to move
429236fd41e5Sdrh     ** it into the Parse.pConstExpr list.  We should use a new bit for this,
429336fd41e5Sdrh     ** for clarity, but we are out of bits in the Expr.flags field so we
429436fd41e5Sdrh     ** have to reuse the EP_FromJoin bit.  Bummer. */
4295db45bd5eSdrh     exprX.flags |= EP_FromJoin;
429671c57db0Sdan     sqlite3ExprCodeTarget(pParse, &exprAnd, dest);
429736c563a2Sdrh   }
4298db45bd5eSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
429936c563a2Sdrh 
430036c563a2Sdrh   /* Ensure adequate test coverage */
4301db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull==0 && regFree1==0 );
4302db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull==0 && regFree1!=0 );
4303db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull!=0 && regFree1==0 );
4304db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull!=0 && regFree1!=0 );
4305db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1==0 );
4306db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1!=0 );
4307db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1==0 );
4308db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1!=0 );
430984b19a3dSdrh   testcase( xJump==0 );
431036c563a2Sdrh }
431136c563a2Sdrh 
431236c563a2Sdrh /*
4313cce7d176Sdrh ** Generate code for a boolean expression such that a jump is made
4314cce7d176Sdrh ** to the label "dest" if the expression is true but execution
4315cce7d176Sdrh ** continues straight thru if the expression is false.
4316f5905aa7Sdrh **
4317f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false), then
431835573356Sdrh ** take the jump if the jumpIfNull flag is SQLITE_JUMPIFNULL.
4319f2bc013cSdrh **
4320f2bc013cSdrh ** This code depends on the fact that certain token values (ex: TK_EQ)
4321f2bc013cSdrh ** are the same as opcode values (ex: OP_Eq) that implement the corresponding
4322f2bc013cSdrh ** operation.  Special comments in vdbe.c and the mkopcodeh.awk script in
4323f2bc013cSdrh ** the make process cause these values to align.  Assert()s in the code
4324f2bc013cSdrh ** below verify that the numbers are aligned correctly.
4325cce7d176Sdrh */
43264adee20fSdanielk1977 void sqlite3ExprIfTrue(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
4327cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
4328cce7d176Sdrh   int op = 0;
43292dcef11bSdrh   int regFree1 = 0;
43302dcef11bSdrh   int regFree2 = 0;
43312dcef11bSdrh   int r1, r2;
43322dcef11bSdrh 
433335573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
433448864df9Smistachkin   if( NEVER(v==0) )     return;  /* Existence of VDBE checked by caller */
433533cd4909Sdrh   if( NEVER(pExpr==0) ) return;  /* No way this can happen */
4336f2bc013cSdrh   op = pExpr->op;
43377b35a77bSdan   switch( op ){
4338cce7d176Sdrh     case TK_AND: {
43394adee20fSdanielk1977       int d2 = sqlite3VdbeMakeLabel(v);
4340c5499befSdrh       testcase( jumpIfNull==0 );
434135573356Sdrh       sqlite3ExprIfFalse(pParse, pExpr->pLeft, d2,jumpIfNull^SQLITE_JUMPIFNULL);
43424adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
43434adee20fSdanielk1977       sqlite3VdbeResolveLabel(v, d2);
4344cce7d176Sdrh       break;
4345cce7d176Sdrh     }
4346cce7d176Sdrh     case TK_OR: {
4347c5499befSdrh       testcase( jumpIfNull==0 );
43484adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
43494adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
4350cce7d176Sdrh       break;
4351cce7d176Sdrh     }
4352cce7d176Sdrh     case TK_NOT: {
4353c5499befSdrh       testcase( jumpIfNull==0 );
43544adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
4355cce7d176Sdrh       break;
4356cce7d176Sdrh     }
43578abed7b9Sdrh     case TK_TRUTH: {
435896acafbeSdrh       int isNot;      /* IS NOT TRUE or IS NOT FALSE */
435996acafbeSdrh       int isTrue;     /* IS TRUE or IS NOT TRUE */
4360007c843bSdrh       testcase( jumpIfNull==0 );
43618abed7b9Sdrh       isNot = pExpr->op2==TK_ISNOT;
436296acafbeSdrh       isTrue = sqlite3ExprTruthValue(pExpr->pRight);
436343c4ac8bSdrh       testcase( isTrue && isNot );
436496acafbeSdrh       testcase( !isTrue && isNot );
436543c4ac8bSdrh       if( isTrue ^ isNot ){
43668abed7b9Sdrh         sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
43678abed7b9Sdrh                           isNot ? SQLITE_JUMPIFNULL : 0);
43688abed7b9Sdrh       }else{
43698abed7b9Sdrh         sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
43708abed7b9Sdrh                            isNot ? SQLITE_JUMPIFNULL : 0);
43718abed7b9Sdrh       }
4372007c843bSdrh       break;
4373007c843bSdrh     }
4374de845c2fSdrh     case TK_IS:
4375de845c2fSdrh     case TK_ISNOT:
4376de845c2fSdrh       testcase( op==TK_IS );
4377de845c2fSdrh       testcase( op==TK_ISNOT );
4378de845c2fSdrh       op = (op==TK_IS) ? TK_EQ : TK_NE;
4379de845c2fSdrh       jumpIfNull = SQLITE_NULLEQ;
4380de845c2fSdrh       /* Fall thru */
4381cce7d176Sdrh     case TK_LT:
4382cce7d176Sdrh     case TK_LE:
4383cce7d176Sdrh     case TK_GT:
4384cce7d176Sdrh     case TK_GE:
4385cce7d176Sdrh     case TK_NE:
43860ac65892Sdrh     case TK_EQ: {
4387625015e0Sdan       if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
4388c5499befSdrh       testcase( jumpIfNull==0 );
4389b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4390b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
439135573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
43922dcef11bSdrh                   r1, r2, dest, jumpIfNull);
43937d176105Sdrh       assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
43947d176105Sdrh       assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
43957d176105Sdrh       assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
43967d176105Sdrh       assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
4397de845c2fSdrh       assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4398de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4399de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4400de845c2fSdrh       assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4401de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
4402de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
44036a2fe093Sdrh       testcase( regFree1==0 );
44046a2fe093Sdrh       testcase( regFree2==0 );
44056a2fe093Sdrh       break;
44066a2fe093Sdrh     }
4407cce7d176Sdrh     case TK_ISNULL:
4408cce7d176Sdrh     case TK_NOTNULL: {
44097d176105Sdrh       assert( TK_ISNULL==OP_IsNull );   testcase( op==TK_ISNULL );
44107d176105Sdrh       assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
44112dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
44122dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
44137d176105Sdrh       VdbeCoverageIf(v, op==TK_ISNULL);
44147d176105Sdrh       VdbeCoverageIf(v, op==TK_NOTNULL);
4415c5499befSdrh       testcase( regFree1==0 );
4416cce7d176Sdrh       break;
4417cce7d176Sdrh     }
4418fef5208cSdrh     case TK_BETWEEN: {
44195c03f30aSdrh       testcase( jumpIfNull==0 );
442071c57db0Sdan       exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfTrue, jumpIfNull);
4421fef5208cSdrh       break;
4422fef5208cSdrh     }
4423bb201344Sshaneh #ifndef SQLITE_OMIT_SUBQUERY
4424e3365e6cSdrh     case TK_IN: {
4425e3365e6cSdrh       int destIfFalse = sqlite3VdbeMakeLabel(v);
4426e3365e6cSdrh       int destIfNull = jumpIfNull ? dest : destIfFalse;
4427e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
4428076e85f5Sdrh       sqlite3VdbeGoto(v, dest);
4429e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
4430e3365e6cSdrh       break;
4431e3365e6cSdrh     }
4432bb201344Sshaneh #endif
4433cce7d176Sdrh     default: {
44347b35a77bSdan     default_expr:
4435991a1985Sdrh       if( exprAlwaysTrue(pExpr) ){
4436076e85f5Sdrh         sqlite3VdbeGoto(v, dest);
4437991a1985Sdrh       }else if( exprAlwaysFalse(pExpr) ){
4438991a1985Sdrh         /* No-op */
4439991a1985Sdrh       }else{
44402dcef11bSdrh         r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
44412dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_If, r1, dest, jumpIfNull!=0);
4442688852abSdrh         VdbeCoverage(v);
4443c5499befSdrh         testcase( regFree1==0 );
4444c5499befSdrh         testcase( jumpIfNull==0 );
4445991a1985Sdrh       }
4446cce7d176Sdrh       break;
4447cce7d176Sdrh     }
4448cce7d176Sdrh   }
44492dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
44502dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
4451cce7d176Sdrh }
4452cce7d176Sdrh 
4453cce7d176Sdrh /*
445466b89c8fSdrh ** Generate code for a boolean expression such that a jump is made
4455cce7d176Sdrh ** to the label "dest" if the expression is false but execution
4456cce7d176Sdrh ** continues straight thru if the expression is true.
4457f5905aa7Sdrh **
4458f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false) then
445935573356Sdrh ** jump if jumpIfNull is SQLITE_JUMPIFNULL or fall through if jumpIfNull
446035573356Sdrh ** is 0.
4461cce7d176Sdrh */
44624adee20fSdanielk1977 void sqlite3ExprIfFalse(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
4463cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
4464cce7d176Sdrh   int op = 0;
44652dcef11bSdrh   int regFree1 = 0;
44662dcef11bSdrh   int regFree2 = 0;
44672dcef11bSdrh   int r1, r2;
44682dcef11bSdrh 
446935573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
447048864df9Smistachkin   if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
447133cd4909Sdrh   if( pExpr==0 )    return;
4472f2bc013cSdrh 
4473f2bc013cSdrh   /* The value of pExpr->op and op are related as follows:
4474f2bc013cSdrh   **
4475f2bc013cSdrh   **       pExpr->op            op
4476f2bc013cSdrh   **       ---------          ----------
4477f2bc013cSdrh   **       TK_ISNULL          OP_NotNull
4478f2bc013cSdrh   **       TK_NOTNULL         OP_IsNull
4479f2bc013cSdrh   **       TK_NE              OP_Eq
4480f2bc013cSdrh   **       TK_EQ              OP_Ne
4481f2bc013cSdrh   **       TK_GT              OP_Le
4482f2bc013cSdrh   **       TK_LE              OP_Gt
4483f2bc013cSdrh   **       TK_GE              OP_Lt
4484f2bc013cSdrh   **       TK_LT              OP_Ge
4485f2bc013cSdrh   **
4486f2bc013cSdrh   ** For other values of pExpr->op, op is undefined and unused.
4487f2bc013cSdrh   ** The value of TK_ and OP_ constants are arranged such that we
4488f2bc013cSdrh   ** can compute the mapping above using the following expression.
4489f2bc013cSdrh   ** Assert()s verify that the computation is correct.
4490f2bc013cSdrh   */
4491f2bc013cSdrh   op = ((pExpr->op+(TK_ISNULL&1))^1)-(TK_ISNULL&1);
4492f2bc013cSdrh 
4493f2bc013cSdrh   /* Verify correct alignment of TK_ and OP_ constants
4494f2bc013cSdrh   */
4495f2bc013cSdrh   assert( pExpr->op!=TK_ISNULL || op==OP_NotNull );
4496f2bc013cSdrh   assert( pExpr->op!=TK_NOTNULL || op==OP_IsNull );
4497f2bc013cSdrh   assert( pExpr->op!=TK_NE || op==OP_Eq );
4498f2bc013cSdrh   assert( pExpr->op!=TK_EQ || op==OP_Ne );
4499f2bc013cSdrh   assert( pExpr->op!=TK_LT || op==OP_Ge );
4500f2bc013cSdrh   assert( pExpr->op!=TK_LE || op==OP_Gt );
4501f2bc013cSdrh   assert( pExpr->op!=TK_GT || op==OP_Le );
4502f2bc013cSdrh   assert( pExpr->op!=TK_GE || op==OP_Lt );
4503f2bc013cSdrh 
4504ba00e30aSdan   switch( pExpr->op ){
4505cce7d176Sdrh     case TK_AND: {
4506c5499befSdrh       testcase( jumpIfNull==0 );
45074adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
45084adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
4509cce7d176Sdrh       break;
4510cce7d176Sdrh     }
4511cce7d176Sdrh     case TK_OR: {
45124adee20fSdanielk1977       int d2 = sqlite3VdbeMakeLabel(v);
4513c5499befSdrh       testcase( jumpIfNull==0 );
451435573356Sdrh       sqlite3ExprIfTrue(pParse, pExpr->pLeft, d2, jumpIfNull^SQLITE_JUMPIFNULL);
45154adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
45164adee20fSdanielk1977       sqlite3VdbeResolveLabel(v, d2);
4517cce7d176Sdrh       break;
4518cce7d176Sdrh     }
4519cce7d176Sdrh     case TK_NOT: {
45205c03f30aSdrh       testcase( jumpIfNull==0 );
45214adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
4522cce7d176Sdrh       break;
4523cce7d176Sdrh     }
45248abed7b9Sdrh     case TK_TRUTH: {
452596acafbeSdrh       int isNot;   /* IS NOT TRUE or IS NOT FALSE */
452696acafbeSdrh       int isTrue;  /* IS TRUE or IS NOT TRUE */
45278abed7b9Sdrh       testcase( jumpIfNull==0 );
45288abed7b9Sdrh       isNot = pExpr->op2==TK_ISNOT;
452996acafbeSdrh       isTrue = sqlite3ExprTruthValue(pExpr->pRight);
453043c4ac8bSdrh       testcase( isTrue && isNot );
453196acafbeSdrh       testcase( !isTrue && isNot );
453243c4ac8bSdrh       if( isTrue ^ isNot ){
45338abed7b9Sdrh         /* IS TRUE and IS NOT FALSE */
45348abed7b9Sdrh         sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
45358abed7b9Sdrh                            isNot ? 0 : SQLITE_JUMPIFNULL);
45368abed7b9Sdrh 
45378abed7b9Sdrh       }else{
45388abed7b9Sdrh         /* IS FALSE and IS NOT TRUE */
45398abed7b9Sdrh         sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
45408abed7b9Sdrh                           isNot ? 0 : SQLITE_JUMPIFNULL);
45418abed7b9Sdrh       }
4542007c843bSdrh       break;
4543007c843bSdrh     }
4544de845c2fSdrh     case TK_IS:
4545de845c2fSdrh     case TK_ISNOT:
4546de845c2fSdrh       testcase( pExpr->op==TK_IS );
4547de845c2fSdrh       testcase( pExpr->op==TK_ISNOT );
4548de845c2fSdrh       op = (pExpr->op==TK_IS) ? TK_NE : TK_EQ;
4549de845c2fSdrh       jumpIfNull = SQLITE_NULLEQ;
4550de845c2fSdrh       /* Fall thru */
4551cce7d176Sdrh     case TK_LT:
4552cce7d176Sdrh     case TK_LE:
4553cce7d176Sdrh     case TK_GT:
4554cce7d176Sdrh     case TK_GE:
4555cce7d176Sdrh     case TK_NE:
4556cce7d176Sdrh     case TK_EQ: {
4557625015e0Sdan       if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
4558c5499befSdrh       testcase( jumpIfNull==0 );
4559b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4560b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
456135573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
45622dcef11bSdrh                   r1, r2, dest, jumpIfNull);
45637d176105Sdrh       assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
45647d176105Sdrh       assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
45657d176105Sdrh       assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
45667d176105Sdrh       assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
4567de845c2fSdrh       assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4568de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4569de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4570de845c2fSdrh       assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4571de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
4572de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
45736a2fe093Sdrh       testcase( regFree1==0 );
45746a2fe093Sdrh       testcase( regFree2==0 );
45756a2fe093Sdrh       break;
45766a2fe093Sdrh     }
4577cce7d176Sdrh     case TK_ISNULL:
4578cce7d176Sdrh     case TK_NOTNULL: {
45792dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
45802dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
45817d176105Sdrh       testcase( op==TK_ISNULL );   VdbeCoverageIf(v, op==TK_ISNULL);
45827d176105Sdrh       testcase( op==TK_NOTNULL );  VdbeCoverageIf(v, op==TK_NOTNULL);
4583c5499befSdrh       testcase( regFree1==0 );
4584cce7d176Sdrh       break;
4585cce7d176Sdrh     }
4586fef5208cSdrh     case TK_BETWEEN: {
45875c03f30aSdrh       testcase( jumpIfNull==0 );
458871c57db0Sdan       exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfFalse, jumpIfNull);
4589fef5208cSdrh       break;
4590fef5208cSdrh     }
4591bb201344Sshaneh #ifndef SQLITE_OMIT_SUBQUERY
4592e3365e6cSdrh     case TK_IN: {
4593e3365e6cSdrh       if( jumpIfNull ){
4594e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, dest);
4595e3365e6cSdrh       }else{
4596e3365e6cSdrh         int destIfNull = sqlite3VdbeMakeLabel(v);
4597e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, destIfNull);
4598e3365e6cSdrh         sqlite3VdbeResolveLabel(v, destIfNull);
4599e3365e6cSdrh       }
4600e3365e6cSdrh       break;
4601e3365e6cSdrh     }
4602bb201344Sshaneh #endif
4603cce7d176Sdrh     default: {
4604ba00e30aSdan     default_expr:
4605991a1985Sdrh       if( exprAlwaysFalse(pExpr) ){
4606076e85f5Sdrh         sqlite3VdbeGoto(v, dest);
4607991a1985Sdrh       }else if( exprAlwaysTrue(pExpr) ){
4608991a1985Sdrh         /* no-op */
4609991a1985Sdrh       }else{
46102dcef11bSdrh         r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
46112dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_IfNot, r1, dest, jumpIfNull!=0);
4612688852abSdrh         VdbeCoverage(v);
4613c5499befSdrh         testcase( regFree1==0 );
4614c5499befSdrh         testcase( jumpIfNull==0 );
4615991a1985Sdrh       }
4616cce7d176Sdrh       break;
4617cce7d176Sdrh     }
4618cce7d176Sdrh   }
46192dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
46202dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
4621cce7d176Sdrh }
46222282792aSdrh 
46232282792aSdrh /*
462472bc8208Sdrh ** Like sqlite3ExprIfFalse() except that a copy is made of pExpr before
462572bc8208Sdrh ** code generation, and that copy is deleted after code generation. This
462672bc8208Sdrh ** ensures that the original pExpr is unchanged.
462772bc8208Sdrh */
462872bc8208Sdrh void sqlite3ExprIfFalseDup(Parse *pParse, Expr *pExpr, int dest,int jumpIfNull){
462972bc8208Sdrh   sqlite3 *db = pParse->db;
463072bc8208Sdrh   Expr *pCopy = sqlite3ExprDup(db, pExpr, 0);
463172bc8208Sdrh   if( db->mallocFailed==0 ){
463272bc8208Sdrh     sqlite3ExprIfFalse(pParse, pCopy, dest, jumpIfNull);
463372bc8208Sdrh   }
463472bc8208Sdrh   sqlite3ExprDelete(db, pCopy);
463572bc8208Sdrh }
463672bc8208Sdrh 
46375aa550cfSdan /*
46385aa550cfSdan ** Expression pVar is guaranteed to be an SQL variable. pExpr may be any
46395aa550cfSdan ** type of expression.
46405aa550cfSdan **
46415aa550cfSdan ** If pExpr is a simple SQL value - an integer, real, string, blob
46425aa550cfSdan ** or NULL value - then the VDBE currently being prepared is configured
46435aa550cfSdan ** to re-prepare each time a new value is bound to variable pVar.
46445aa550cfSdan **
46455aa550cfSdan ** Additionally, if pExpr is a simple SQL value and the value is the
46465aa550cfSdan ** same as that currently bound to variable pVar, non-zero is returned.
46475aa550cfSdan ** Otherwise, if the values are not the same or if pExpr is not a simple
46485aa550cfSdan ** SQL value, zero is returned.
46495aa550cfSdan */
46505aa550cfSdan static int exprCompareVariable(Parse *pParse, Expr *pVar, Expr *pExpr){
46515aa550cfSdan   int res = 0;
4652c0804226Sdrh   int iVar;
4653c0804226Sdrh   sqlite3_value *pL, *pR = 0;
46545aa550cfSdan 
46555aa550cfSdan   sqlite3ValueFromExpr(pParse->db, pExpr, SQLITE_UTF8, SQLITE_AFF_BLOB, &pR);
4656c0804226Sdrh   if( pR ){
4657c0804226Sdrh     iVar = pVar->iColumn;
4658c0804226Sdrh     sqlite3VdbeSetVarmask(pParse->pVdbe, iVar);
4659c0804226Sdrh     pL = sqlite3VdbeGetBoundValue(pParse->pReprepare, iVar, SQLITE_AFF_BLOB);
46605aa307e2Sdrh     if( pL ){
46615aa307e2Sdrh       if( sqlite3_value_type(pL)==SQLITE_TEXT ){
46625aa307e2Sdrh         sqlite3_value_text(pL); /* Make sure the encoding is UTF-8 */
46635aa307e2Sdrh       }
46645aa307e2Sdrh       res =  0==sqlite3MemCompare(pL, pR, 0);
46655aa550cfSdan     }
46665aa550cfSdan     sqlite3ValueFree(pR);
46675aa550cfSdan     sqlite3ValueFree(pL);
46685aa550cfSdan   }
46695aa550cfSdan 
46705aa550cfSdan   return res;
46715aa550cfSdan }
467272bc8208Sdrh 
467372bc8208Sdrh /*
46741d9da70aSdrh ** Do a deep comparison of two expression trees.  Return 0 if the two
46751d9da70aSdrh ** expressions are completely identical.  Return 1 if they differ only
46761d9da70aSdrh ** by a COLLATE operator at the top level.  Return 2 if there are differences
46771d9da70aSdrh ** other than the top-level COLLATE operator.
4678d40aab0eSdrh **
4679619a1305Sdrh ** If any subelement of pB has Expr.iTable==(-1) then it is allowed
4680619a1305Sdrh ** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
4681619a1305Sdrh **
468266518ca7Sdrh ** The pA side might be using TK_REGISTER.  If that is the case and pB is
468366518ca7Sdrh ** not using TK_REGISTER but is otherwise equivalent, then still return 0.
468466518ca7Sdrh **
46851d9da70aSdrh ** Sometimes this routine will return 2 even if the two expressions
4686d40aab0eSdrh ** really are equivalent.  If we cannot prove that the expressions are
46871d9da70aSdrh ** identical, we return 2 just to be safe.  So if this routine
46881d9da70aSdrh ** returns 2, then you do not really know for certain if the two
46891d9da70aSdrh ** expressions are the same.  But if you get a 0 or 1 return, then you
4690d40aab0eSdrh ** can be sure the expressions are the same.  In the places where
46911d9da70aSdrh ** this routine is used, it does not hurt to get an extra 2 - that
4692d40aab0eSdrh ** just might result in some slightly slower code.  But returning
46931d9da70aSdrh ** an incorrect 0 or 1 could lead to a malfunction.
46945aa550cfSdan **
4695c0804226Sdrh ** If pParse is not NULL then TK_VARIABLE terms in pA with bindings in
4696c0804226Sdrh ** pParse->pReprepare can be matched against literals in pB.  The
4697c0804226Sdrh ** pParse->pVdbe->expmask bitmask is updated for each variable referenced.
4698c0804226Sdrh ** If pParse is NULL (the normal case) then any TK_VARIABLE term in
4699c0804226Sdrh ** Argument pParse should normally be NULL. If it is not NULL and pA or
4700c0804226Sdrh ** pB causes a return value of 2.
47012282792aSdrh */
47025aa550cfSdan int sqlite3ExprCompare(Parse *pParse, Expr *pA, Expr *pB, int iTab){
470310d1edf0Sdrh   u32 combinedFlags;
47044b202ae2Sdanielk1977   if( pA==0 || pB==0 ){
47051d9da70aSdrh     return pB==pA ? 0 : 2;
47062282792aSdrh   }
47075aa550cfSdan   if( pParse && pA->op==TK_VARIABLE && exprCompareVariable(pParse, pA, pB) ){
47085aa550cfSdan     return 0;
47095aa550cfSdan   }
471010d1edf0Sdrh   combinedFlags = pA->flags | pB->flags;
471110d1edf0Sdrh   if( combinedFlags & EP_IntValue ){
471210d1edf0Sdrh     if( (pA->flags&pB->flags&EP_IntValue)!=0 && pA->u.iValue==pB->u.iValue ){
471310d1edf0Sdrh       return 0;
471410d1edf0Sdrh     }
47151d9da70aSdrh     return 2;
47166ab3a2ecSdanielk1977   }
4717c2acc4e4Sdrh   if( pA->op!=pB->op ){
47185aa550cfSdan     if( pA->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA->pLeft,pB,iTab)<2 ){
4719ae80ddeaSdrh       return 1;
4720ae80ddeaSdrh     }
47215aa550cfSdan     if( pB->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA,pB->pLeft,iTab)<2 ){
4722ae80ddeaSdrh       return 1;
4723ae80ddeaSdrh     }
4724ae80ddeaSdrh     return 2;
4725ae80ddeaSdrh   }
47262edc5fd7Sdrh   if( pA->op!=TK_COLUMN && pA->op!=TK_AGG_COLUMN && pA->u.zToken ){
4727390b88a4Sdrh     if( pA->op==TK_FUNCTION ){
4728390b88a4Sdrh       if( sqlite3StrICmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
4729*eda079cdSdrh #ifndef SQLITE_OMIT_WINDOWFUNC
4730*eda079cdSdrh       /* Justification for the assert():
4731*eda079cdSdrh       ** window functions have p->op==TK_FUNCTION but aggregate functions
4732*eda079cdSdrh       ** have p->op==TK_AGG_FUNCTION.  So any comparison between an aggregate
4733*eda079cdSdrh       ** function and a window function should have failed before reaching
4734*eda079cdSdrh       ** this point.  And, it is not possible to have a window function and
4735*eda079cdSdrh       ** a scalar function with the same name and number of arguments.  So
4736*eda079cdSdrh       ** if we reach this point, either A and B both window functions or
4737*eda079cdSdrh       ** neither are a window functions. */
4738*eda079cdSdrh       assert( ExprHasProperty(pA,EP_WinFunc)==ExprHasProperty(pB,EP_WinFunc) );
4739*eda079cdSdrh       if( ExprHasProperty(pA,EP_WinFunc) ){
4740*eda079cdSdrh         if( sqlite3WindowCompare(pParse,pA->y.pWin,pB->y.pWin)!=0 ) return 2;
4741*eda079cdSdrh       }
4742*eda079cdSdrh #endif
4743d5af5420Sdrh     }else if( pA->op==TK_COLLATE ){
4744e79f6299Sdrh       if( sqlite3_stricmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
4745efad2e23Sdrh     }else if( strcmp(pA->u.zToken,pB->u.zToken)!=0 ){
4746d5af5420Sdrh       return 2;
474710d1edf0Sdrh     }
474810d1edf0Sdrh   }
474910d1edf0Sdrh   if( (pA->flags & EP_Distinct)!=(pB->flags & EP_Distinct) ) return 2;
475085f8aa79Sdrh   if( ALWAYS((combinedFlags & EP_TokenOnly)==0) ){
475110d1edf0Sdrh     if( combinedFlags & EP_xIsSelect ) return 2;
4752efad2e23Sdrh     if( (combinedFlags & EP_FixedCol)==0
4753efad2e23Sdrh      && sqlite3ExprCompare(pParse, pA->pLeft, pB->pLeft, iTab) ) return 2;
47545aa550cfSdan     if( sqlite3ExprCompare(pParse, pA->pRight, pB->pRight, iTab) ) return 2;
4755619a1305Sdrh     if( sqlite3ExprListCompare(pA->x.pList, pB->x.pList, iTab) ) return 2;
4756f49ff6ffSdrh     assert( (combinedFlags & EP_Reduced)==0 );
4757f49ff6ffSdrh     if( pA->op!=TK_STRING && pA->op!=TK_TRUEFALSE ){
4758619a1305Sdrh       if( pA->iColumn!=pB->iColumn ) return 2;
475966518ca7Sdrh       if( pA->iTable!=pB->iTable
476085f8aa79Sdrh        && (pA->iTable!=iTab || NEVER(pB->iTable>=0)) ) return 2;
47611d9da70aSdrh     }
47621d9da70aSdrh   }
47632646da7eSdrh   return 0;
47642646da7eSdrh }
47652282792aSdrh 
47668c6f666bSdrh /*
47678c6f666bSdrh ** Compare two ExprList objects.  Return 0 if they are identical and
47688c6f666bSdrh ** non-zero if they differ in any way.
47698c6f666bSdrh **
4770619a1305Sdrh ** If any subelement of pB has Expr.iTable==(-1) then it is allowed
4771619a1305Sdrh ** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
4772619a1305Sdrh **
47738c6f666bSdrh ** This routine might return non-zero for equivalent ExprLists.  The
47748c6f666bSdrh ** only consequence will be disabled optimizations.  But this routine
47758c6f666bSdrh ** must never return 0 if the two ExprList objects are different, or
47768c6f666bSdrh ** a malfunction will result.
47778c6f666bSdrh **
47788c6f666bSdrh ** Two NULL pointers are considered to be the same.  But a NULL pointer
47798c6f666bSdrh ** always differs from a non-NULL pointer.
47808c6f666bSdrh */
4781619a1305Sdrh int sqlite3ExprListCompare(ExprList *pA, ExprList *pB, int iTab){
47828c6f666bSdrh   int i;
47838c6f666bSdrh   if( pA==0 && pB==0 ) return 0;
47848c6f666bSdrh   if( pA==0 || pB==0 ) return 1;
47858c6f666bSdrh   if( pA->nExpr!=pB->nExpr ) return 1;
47868c6f666bSdrh   for(i=0; i<pA->nExpr; i++){
47878c6f666bSdrh     Expr *pExprA = pA->a[i].pExpr;
47888c6f666bSdrh     Expr *pExprB = pB->a[i].pExpr;
47898c6f666bSdrh     if( pA->a[i].sortOrder!=pB->a[i].sortOrder ) return 1;
47905aa550cfSdan     if( sqlite3ExprCompare(0, pExprA, pExprB, iTab) ) return 1;
47918c6f666bSdrh   }
47928c6f666bSdrh   return 0;
47938c6f666bSdrh }
479413449892Sdrh 
47952282792aSdrh /*
4796f9463dfbSdrh ** Like sqlite3ExprCompare() except COLLATE operators at the top-level
4797f9463dfbSdrh ** are ignored.
4798f9463dfbSdrh */
4799f9463dfbSdrh int sqlite3ExprCompareSkip(Expr *pA, Expr *pB, int iTab){
48005aa550cfSdan   return sqlite3ExprCompare(0,
4801f9463dfbSdrh              sqlite3ExprSkipCollate(pA),
4802f9463dfbSdrh              sqlite3ExprSkipCollate(pB),
4803f9463dfbSdrh              iTab);
4804f9463dfbSdrh }
4805f9463dfbSdrh 
4806f9463dfbSdrh /*
48074bd5f73fSdrh ** Return true if we can prove the pE2 will always be true if pE1 is
48084bd5f73fSdrh ** true.  Return false if we cannot complete the proof or if pE2 might
48094bd5f73fSdrh ** be false.  Examples:
48104bd5f73fSdrh **
4811619a1305Sdrh **     pE1: x==5       pE2: x==5             Result: true
48124bd5f73fSdrh **     pE1: x>0        pE2: x==5             Result: false
4813619a1305Sdrh **     pE1: x=21       pE2: x=21 OR y=43     Result: true
48144bd5f73fSdrh **     pE1: x!=123     pE2: x IS NOT NULL    Result: true
4815619a1305Sdrh **     pE1: x!=?1      pE2: x IS NOT NULL    Result: true
4816619a1305Sdrh **     pE1: x IS NULL  pE2: x IS NOT NULL    Result: false
4817619a1305Sdrh **     pE1: x IS ?2    pE2: x IS NOT NULL    Reuslt: false
48184bd5f73fSdrh **
48194bd5f73fSdrh ** When comparing TK_COLUMN nodes between pE1 and pE2, if pE2 has
48204bd5f73fSdrh ** Expr.iTable<0 then assume a table number given by iTab.
48214bd5f73fSdrh **
4822c0804226Sdrh ** If pParse is not NULL, then the values of bound variables in pE1 are
4823c0804226Sdrh ** compared against literal values in pE2 and pParse->pVdbe->expmask is
4824c0804226Sdrh ** modified to record which bound variables are referenced.  If pParse
4825c0804226Sdrh ** is NULL, then false will be returned if pE1 contains any bound variables.
4826c0804226Sdrh **
48274bd5f73fSdrh ** When in doubt, return false.  Returning true might give a performance
48284bd5f73fSdrh ** improvement.  Returning false might cause a performance reduction, but
48294bd5f73fSdrh ** it will always give the correct answer and is hence always safe.
48304bd5f73fSdrh */
48315aa550cfSdan int sqlite3ExprImpliesExpr(Parse *pParse, Expr *pE1, Expr *pE2, int iTab){
48325aa550cfSdan   if( sqlite3ExprCompare(pParse, pE1, pE2, iTab)==0 ){
4833619a1305Sdrh     return 1;
4834619a1305Sdrh   }
4835619a1305Sdrh   if( pE2->op==TK_OR
48365aa550cfSdan    && (sqlite3ExprImpliesExpr(pParse, pE1, pE2->pLeft, iTab)
48375aa550cfSdan              || sqlite3ExprImpliesExpr(pParse, pE1, pE2->pRight, iTab) )
4838619a1305Sdrh   ){
4839619a1305Sdrh     return 1;
4840619a1305Sdrh   }
48411ad93a00Sdrh   if( pE2->op==TK_NOTNULL && pE1->op!=TK_ISNULL && pE1->op!=TK_IS ){
48421ad93a00Sdrh     Expr *pX = sqlite3ExprSkipCollate(pE1->pLeft);
48431ad93a00Sdrh     testcase( pX!=pE1->pLeft );
48445aa550cfSdan     if( sqlite3ExprCompare(pParse, pX, pE2->pLeft, iTab)==0 ) return 1;
4845619a1305Sdrh   }
4846619a1305Sdrh   return 0;
48474bd5f73fSdrh }
48484bd5f73fSdrh 
48494bd5f73fSdrh /*
48502589787cSdrh ** This is the Expr node callback for sqlite3ExprImpliesNotNullRow().
48512589787cSdrh ** If the expression node requires that the table at pWalker->iCur
48522589787cSdrh ** have a non-NULL column, then set pWalker->eCode to 1 and abort.
48532589787cSdrh */
48542589787cSdrh static int impliesNotNullRow(Walker *pWalker, Expr *pExpr){
4855821b610bSdrh   /* This routine is only called for WHERE clause expressions and so it
4856821b610bSdrh   ** cannot have any TK_AGG_COLUMN entries because those are only found
4857821b610bSdrh   ** in HAVING clauses.  We can get a TK_AGG_FUNCTION in a WHERE clause,
4858821b610bSdrh   ** but that is an illegal construct and the query will be rejected at
4859821b610bSdrh   ** a later stage of processing, so the TK_AGG_FUNCTION case does not
4860821b610bSdrh   ** need to be considered here. */
4861821b610bSdrh   assert( pExpr->op!=TK_AGG_COLUMN );
4862821b610bSdrh   testcase( pExpr->op==TK_AGG_FUNCTION );
4863821b610bSdrh 
48642589787cSdrh   if( ExprHasProperty(pExpr, EP_FromJoin) ) return WRC_Prune;
48652589787cSdrh   switch( pExpr->op ){
48660493222fSdan     case TK_ISNOT:
4867a1054dccSdan     case TK_NOT:
48682589787cSdrh     case TK_ISNULL:
48692589787cSdrh     case TK_IS:
48702589787cSdrh     case TK_OR:
48712c492061Sdrh     case TK_CASE:
4872e3eff266Sdrh     case TK_IN:
48732589787cSdrh     case TK_FUNCTION:
48740493222fSdan       testcase( pExpr->op==TK_ISNOT );
48750493222fSdan       testcase( pExpr->op==TK_NOT );
4876821b610bSdrh       testcase( pExpr->op==TK_ISNULL );
4877821b610bSdrh       testcase( pExpr->op==TK_IS );
4878821b610bSdrh       testcase( pExpr->op==TK_OR );
4879821b610bSdrh       testcase( pExpr->op==TK_CASE );
4880821b610bSdrh       testcase( pExpr->op==TK_IN );
4881821b610bSdrh       testcase( pExpr->op==TK_FUNCTION );
48822589787cSdrh       return WRC_Prune;
48832589787cSdrh     case TK_COLUMN:
48842589787cSdrh       if( pWalker->u.iCur==pExpr->iTable ){
48852589787cSdrh         pWalker->eCode = 1;
48862589787cSdrh         return WRC_Abort;
48872589787cSdrh       }
48882589787cSdrh       return WRC_Prune;
48899881155dSdrh 
48909881155dSdrh     /* Virtual tables are allowed to use constraints like x=NULL.  So
48919881155dSdrh     ** a term of the form x=y does not prove that y is not null if x
48929881155dSdrh     ** is the column of a virtual table */
48939881155dSdrh     case TK_EQ:
48949881155dSdrh     case TK_NE:
48959881155dSdrh     case TK_LT:
48969881155dSdrh     case TK_LE:
48979881155dSdrh     case TK_GT:
48989881155dSdrh     case TK_GE:
48999881155dSdrh       testcase( pExpr->op==TK_EQ );
49009881155dSdrh       testcase( pExpr->op==TK_NE );
49019881155dSdrh       testcase( pExpr->op==TK_LT );
49029881155dSdrh       testcase( pExpr->op==TK_LE );
49039881155dSdrh       testcase( pExpr->op==TK_GT );
49049881155dSdrh       testcase( pExpr->op==TK_GE );
4905*eda079cdSdrh       if( (pExpr->pLeft->op==TK_COLUMN && IsVirtual(pExpr->pLeft->y.pTab))
4906*eda079cdSdrh        || (pExpr->pRight->op==TK_COLUMN && IsVirtual(pExpr->pRight->y.pTab))
49079881155dSdrh       ){
49089881155dSdrh        return WRC_Prune;
49099881155dSdrh       }
49102589787cSdrh     default:
49112589787cSdrh       return WRC_Continue;
49122589787cSdrh   }
49132589787cSdrh }
49142589787cSdrh 
49152589787cSdrh /*
49162589787cSdrh ** Return true (non-zero) if expression p can only be true if at least
49172589787cSdrh ** one column of table iTab is non-null.  In other words, return true
49182589787cSdrh ** if expression p will always be NULL or false if every column of iTab
49192589787cSdrh ** is NULL.
49202589787cSdrh **
4921821b610bSdrh ** False negatives are acceptable.  In other words, it is ok to return
4922821b610bSdrh ** zero even if expression p will never be true of every column of iTab
4923821b610bSdrh ** is NULL.  A false negative is merely a missed optimization opportunity.
4924821b610bSdrh **
4925821b610bSdrh ** False positives are not allowed, however.  A false positive may result
4926821b610bSdrh ** in an incorrect answer.
4927821b610bSdrh **
49282589787cSdrh ** Terms of p that are marked with EP_FromJoin (and hence that come from
49292589787cSdrh ** the ON or USING clauses of LEFT JOINS) are excluded from the analysis.
49302589787cSdrh **
49312589787cSdrh ** This routine is used to check if a LEFT JOIN can be converted into
49322589787cSdrh ** an ordinary JOIN.  The p argument is the WHERE clause.  If the WHERE
49332589787cSdrh ** clause requires that some column of the right table of the LEFT JOIN
49342589787cSdrh ** be non-NULL, then the LEFT JOIN can be safely converted into an
49352589787cSdrh ** ordinary join.
49362589787cSdrh */
49372589787cSdrh int sqlite3ExprImpliesNonNullRow(Expr *p, int iTab){
49382589787cSdrh   Walker w;
49392589787cSdrh   w.xExprCallback = impliesNotNullRow;
49402589787cSdrh   w.xSelectCallback = 0;
49412589787cSdrh   w.xSelectCallback2 = 0;
49422589787cSdrh   w.eCode = 0;
49432589787cSdrh   w.u.iCur = iTab;
49442589787cSdrh   sqlite3WalkExpr(&w, p);
49452589787cSdrh   return w.eCode;
49462589787cSdrh }
49472589787cSdrh 
49482589787cSdrh /*
4949030796dfSdrh ** An instance of the following structure is used by the tree walker
49502409f8a1Sdrh ** to determine if an expression can be evaluated by reference to the
49512409f8a1Sdrh ** index only, without having to do a search for the corresponding
49522409f8a1Sdrh ** table entry.  The IdxCover.pIdx field is the index.  IdxCover.iCur
49532409f8a1Sdrh ** is the cursor for the table.
49542409f8a1Sdrh */
49552409f8a1Sdrh struct IdxCover {
49562409f8a1Sdrh   Index *pIdx;     /* The index to be tested for coverage */
49572409f8a1Sdrh   int iCur;        /* Cursor number for the table corresponding to the index */
49582409f8a1Sdrh };
49592409f8a1Sdrh 
49602409f8a1Sdrh /*
49612409f8a1Sdrh ** Check to see if there are references to columns in table
49622409f8a1Sdrh ** pWalker->u.pIdxCover->iCur can be satisfied using the index
49632409f8a1Sdrh ** pWalker->u.pIdxCover->pIdx.
49642409f8a1Sdrh */
49652409f8a1Sdrh static int exprIdxCover(Walker *pWalker, Expr *pExpr){
49662409f8a1Sdrh   if( pExpr->op==TK_COLUMN
49672409f8a1Sdrh    && pExpr->iTable==pWalker->u.pIdxCover->iCur
49682409f8a1Sdrh    && sqlite3ColumnOfIndex(pWalker->u.pIdxCover->pIdx, pExpr->iColumn)<0
49692409f8a1Sdrh   ){
49702409f8a1Sdrh     pWalker->eCode = 1;
49712409f8a1Sdrh     return WRC_Abort;
49722409f8a1Sdrh   }
49732409f8a1Sdrh   return WRC_Continue;
49742409f8a1Sdrh }
49752409f8a1Sdrh 
49762409f8a1Sdrh /*
4977e604ec0bSdrh ** Determine if an index pIdx on table with cursor iCur contains will
4978e604ec0bSdrh ** the expression pExpr.  Return true if the index does cover the
4979e604ec0bSdrh ** expression and false if the pExpr expression references table columns
4980e604ec0bSdrh ** that are not found in the index pIdx.
49812409f8a1Sdrh **
49822409f8a1Sdrh ** An index covering an expression means that the expression can be
49832409f8a1Sdrh ** evaluated using only the index and without having to lookup the
49842409f8a1Sdrh ** corresponding table entry.
49852409f8a1Sdrh */
49862409f8a1Sdrh int sqlite3ExprCoveredByIndex(
49872409f8a1Sdrh   Expr *pExpr,        /* The index to be tested */
49882409f8a1Sdrh   int iCur,           /* The cursor number for the corresponding table */
49892409f8a1Sdrh   Index *pIdx         /* The index that might be used for coverage */
49902409f8a1Sdrh ){
49912409f8a1Sdrh   Walker w;
49922409f8a1Sdrh   struct IdxCover xcov;
49932409f8a1Sdrh   memset(&w, 0, sizeof(w));
49942409f8a1Sdrh   xcov.iCur = iCur;
49952409f8a1Sdrh   xcov.pIdx = pIdx;
49962409f8a1Sdrh   w.xExprCallback = exprIdxCover;
49972409f8a1Sdrh   w.u.pIdxCover = &xcov;
49982409f8a1Sdrh   sqlite3WalkExpr(&w, pExpr);
49992409f8a1Sdrh   return !w.eCode;
50002409f8a1Sdrh }
50012409f8a1Sdrh 
50022409f8a1Sdrh 
50032409f8a1Sdrh /*
50042409f8a1Sdrh ** An instance of the following structure is used by the tree walker
5005030796dfSdrh ** to count references to table columns in the arguments of an
5006ed551b95Sdrh ** aggregate function, in order to implement the
5007ed551b95Sdrh ** sqlite3FunctionThisSrc() routine.
5008374fdce4Sdrh */
5009030796dfSdrh struct SrcCount {
5010030796dfSdrh   SrcList *pSrc;   /* One particular FROM clause in a nested query */
5011030796dfSdrh   int nThis;       /* Number of references to columns in pSrcList */
5012030796dfSdrh   int nOther;      /* Number of references to columns in other FROM clauses */
5013030796dfSdrh };
5014030796dfSdrh 
5015030796dfSdrh /*
5016030796dfSdrh ** Count the number of references to columns.
5017030796dfSdrh */
5018030796dfSdrh static int exprSrcCount(Walker *pWalker, Expr *pExpr){
5019fb0a6081Sdrh   /* The NEVER() on the second term is because sqlite3FunctionUsesThisSrc()
5020fb0a6081Sdrh   ** is always called before sqlite3ExprAnalyzeAggregates() and so the
5021fb0a6081Sdrh   ** TK_COLUMNs have not yet been converted into TK_AGG_COLUMN.  If
5022fb0a6081Sdrh   ** sqlite3FunctionUsesThisSrc() is used differently in the future, the
5023fb0a6081Sdrh   ** NEVER() will need to be removed. */
5024fb0a6081Sdrh   if( pExpr->op==TK_COLUMN || NEVER(pExpr->op==TK_AGG_COLUMN) ){
5025374fdce4Sdrh     int i;
5026030796dfSdrh     struct SrcCount *p = pWalker->u.pSrcCount;
5027030796dfSdrh     SrcList *pSrc = p->pSrc;
5028655814d2Sdrh     int nSrc = pSrc ? pSrc->nSrc : 0;
5029655814d2Sdrh     for(i=0; i<nSrc; i++){
5030030796dfSdrh       if( pExpr->iTable==pSrc->a[i].iCursor ) break;
5031374fdce4Sdrh     }
5032655814d2Sdrh     if( i<nSrc ){
5033030796dfSdrh       p->nThis++;
5034374fdce4Sdrh     }else{
5035030796dfSdrh       p->nOther++;
5036374fdce4Sdrh     }
5037374fdce4Sdrh   }
5038030796dfSdrh   return WRC_Continue;
5039030796dfSdrh }
5040374fdce4Sdrh 
5041374fdce4Sdrh /*
5042030796dfSdrh ** Determine if any of the arguments to the pExpr Function reference
5043030796dfSdrh ** pSrcList.  Return true if they do.  Also return true if the function
5044030796dfSdrh ** has no arguments or has only constant arguments.  Return false if pExpr
5045030796dfSdrh ** references columns but not columns of tables found in pSrcList.
5046374fdce4Sdrh */
5047030796dfSdrh int sqlite3FunctionUsesThisSrc(Expr *pExpr, SrcList *pSrcList){
5048374fdce4Sdrh   Walker w;
5049030796dfSdrh   struct SrcCount cnt;
5050374fdce4Sdrh   assert( pExpr->op==TK_AGG_FUNCTION );
5051030796dfSdrh   w.xExprCallback = exprSrcCount;
5052979dd1beSdrh   w.xSelectCallback = 0;
5053030796dfSdrh   w.u.pSrcCount = &cnt;
5054030796dfSdrh   cnt.pSrc = pSrcList;
5055030796dfSdrh   cnt.nThis = 0;
5056030796dfSdrh   cnt.nOther = 0;
5057030796dfSdrh   sqlite3WalkExprList(&w, pExpr->x.pList);
5058030796dfSdrh   return cnt.nThis>0 || cnt.nOther==0;
5059374fdce4Sdrh }
5060374fdce4Sdrh 
5061374fdce4Sdrh /*
506213449892Sdrh ** Add a new element to the pAggInfo->aCol[] array.  Return the index of
506313449892Sdrh ** the new element.  Return a negative number if malloc fails.
50642282792aSdrh */
506517435752Sdrh static int addAggInfoColumn(sqlite3 *db, AggInfo *pInfo){
506613449892Sdrh   int i;
5067cf643729Sdrh   pInfo->aCol = sqlite3ArrayAllocate(
506817435752Sdrh        db,
5069cf643729Sdrh        pInfo->aCol,
5070cf643729Sdrh        sizeof(pInfo->aCol[0]),
5071cf643729Sdrh        &pInfo->nColumn,
5072cf643729Sdrh        &i
5073cf643729Sdrh   );
507413449892Sdrh   return i;
50752282792aSdrh }
507613449892Sdrh 
507713449892Sdrh /*
507813449892Sdrh ** Add a new element to the pAggInfo->aFunc[] array.  Return the index of
507913449892Sdrh ** the new element.  Return a negative number if malloc fails.
508013449892Sdrh */
508117435752Sdrh static int addAggInfoFunc(sqlite3 *db, AggInfo *pInfo){
508213449892Sdrh   int i;
5083cf643729Sdrh   pInfo->aFunc = sqlite3ArrayAllocate(
508417435752Sdrh        db,
5085cf643729Sdrh        pInfo->aFunc,
5086cf643729Sdrh        sizeof(pInfo->aFunc[0]),
5087cf643729Sdrh        &pInfo->nFunc,
5088cf643729Sdrh        &i
5089cf643729Sdrh   );
509013449892Sdrh   return i;
50912282792aSdrh }
50922282792aSdrh 
50932282792aSdrh /*
50947d10d5a6Sdrh ** This is the xExprCallback for a tree walker.  It is used to
50957d10d5a6Sdrh ** implement sqlite3ExprAnalyzeAggregates().  See sqlite3ExprAnalyzeAggregates
5096626a879aSdrh ** for additional information.
50972282792aSdrh */
50987d10d5a6Sdrh static int analyzeAggregate(Walker *pWalker, Expr *pExpr){
50992282792aSdrh   int i;
51007d10d5a6Sdrh   NameContext *pNC = pWalker->u.pNC;
5101a58fdfb1Sdanielk1977   Parse *pParse = pNC->pParse;
5102a58fdfb1Sdanielk1977   SrcList *pSrcList = pNC->pSrcList;
510325c3b8caSdrh   AggInfo *pAggInfo = pNC->uNC.pAggInfo;
510413449892Sdrh 
510525c3b8caSdrh   assert( pNC->ncFlags & NC_UAggInfo );
51062282792aSdrh   switch( pExpr->op ){
510789c69d00Sdrh     case TK_AGG_COLUMN:
5108967e8b73Sdrh     case TK_COLUMN: {
51098b213899Sdrh       testcase( pExpr->op==TK_AGG_COLUMN );
51108b213899Sdrh       testcase( pExpr->op==TK_COLUMN );
511113449892Sdrh       /* Check to see if the column is in one of the tables in the FROM
511213449892Sdrh       ** clause of the aggregate query */
511320bc393cSdrh       if( ALWAYS(pSrcList!=0) ){
511413449892Sdrh         struct SrcList_item *pItem = pSrcList->a;
511513449892Sdrh         for(i=0; i<pSrcList->nSrc; i++, pItem++){
511613449892Sdrh           struct AggInfo_col *pCol;
5117c5cd1249Sdrh           assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
511813449892Sdrh           if( pExpr->iTable==pItem->iCursor ){
511913449892Sdrh             /* If we reach this point, it means that pExpr refers to a table
512013449892Sdrh             ** that is in the FROM clause of the aggregate query.
512113449892Sdrh             **
512213449892Sdrh             ** Make an entry for the column in pAggInfo->aCol[] if there
512313449892Sdrh             ** is not an entry there already.
512413449892Sdrh             */
51257f906d63Sdrh             int k;
512613449892Sdrh             pCol = pAggInfo->aCol;
51277f906d63Sdrh             for(k=0; k<pAggInfo->nColumn; k++, pCol++){
512813449892Sdrh               if( pCol->iTable==pExpr->iTable &&
512913449892Sdrh                   pCol->iColumn==pExpr->iColumn ){
51302282792aSdrh                 break;
51312282792aSdrh               }
51322282792aSdrh             }
51331e536953Sdanielk1977             if( (k>=pAggInfo->nColumn)
51341e536953Sdanielk1977              && (k = addAggInfoColumn(pParse->db, pAggInfo))>=0
51351e536953Sdanielk1977             ){
51367f906d63Sdrh               pCol = &pAggInfo->aCol[k];
5137*eda079cdSdrh               pCol->pTab = pExpr->y.pTab;
513813449892Sdrh               pCol->iTable = pExpr->iTable;
513913449892Sdrh               pCol->iColumn = pExpr->iColumn;
51400a07c107Sdrh               pCol->iMem = ++pParse->nMem;
514113449892Sdrh               pCol->iSorterColumn = -1;
51425774b806Sdrh               pCol->pExpr = pExpr;
514313449892Sdrh               if( pAggInfo->pGroupBy ){
514413449892Sdrh                 int j, n;
514513449892Sdrh                 ExprList *pGB = pAggInfo->pGroupBy;
514613449892Sdrh                 struct ExprList_item *pTerm = pGB->a;
514713449892Sdrh                 n = pGB->nExpr;
514813449892Sdrh                 for(j=0; j<n; j++, pTerm++){
514913449892Sdrh                   Expr *pE = pTerm->pExpr;
515013449892Sdrh                   if( pE->op==TK_COLUMN && pE->iTable==pExpr->iTable &&
515113449892Sdrh                       pE->iColumn==pExpr->iColumn ){
515213449892Sdrh                     pCol->iSorterColumn = j;
515313449892Sdrh                     break;
51542282792aSdrh                   }
515513449892Sdrh                 }
515613449892Sdrh               }
515713449892Sdrh               if( pCol->iSorterColumn<0 ){
515813449892Sdrh                 pCol->iSorterColumn = pAggInfo->nSortingColumn++;
515913449892Sdrh               }
516013449892Sdrh             }
516113449892Sdrh             /* There is now an entry for pExpr in pAggInfo->aCol[] (either
516213449892Sdrh             ** because it was there before or because we just created it).
516313449892Sdrh             ** Convert the pExpr to be a TK_AGG_COLUMN referring to that
516413449892Sdrh             ** pAggInfo->aCol[] entry.
516513449892Sdrh             */
5166ebb6a65dSdrh             ExprSetVVAProperty(pExpr, EP_NoReduce);
516713449892Sdrh             pExpr->pAggInfo = pAggInfo;
516813449892Sdrh             pExpr->op = TK_AGG_COLUMN;
5169cf697396Sshane             pExpr->iAgg = (i16)k;
517013449892Sdrh             break;
517113449892Sdrh           } /* endif pExpr->iTable==pItem->iCursor */
517213449892Sdrh         } /* end loop over pSrcList */
5173a58fdfb1Sdanielk1977       }
51747d10d5a6Sdrh       return WRC_Prune;
51752282792aSdrh     }
51762282792aSdrh     case TK_AGG_FUNCTION: {
51773a8c4be7Sdrh       if( (pNC->ncFlags & NC_InAggFunc)==0
5178ed551b95Sdrh        && pWalker->walkerDepth==pExpr->op2
51793a8c4be7Sdrh       ){
518013449892Sdrh         /* Check to see if pExpr is a duplicate of another aggregate
518113449892Sdrh         ** function that is already in the pAggInfo structure
518213449892Sdrh         */
518313449892Sdrh         struct AggInfo_func *pItem = pAggInfo->aFunc;
518413449892Sdrh         for(i=0; i<pAggInfo->nFunc; i++, pItem++){
51855aa550cfSdan           if( sqlite3ExprCompare(0, pItem->pExpr, pExpr, -1)==0 ){
51862282792aSdrh             break;
51872282792aSdrh           }
51882282792aSdrh         }
518913449892Sdrh         if( i>=pAggInfo->nFunc ){
519013449892Sdrh           /* pExpr is original.  Make a new entry in pAggInfo->aFunc[]
519113449892Sdrh           */
519214db2665Sdanielk1977           u8 enc = ENC(pParse->db);
51931e536953Sdanielk1977           i = addAggInfoFunc(pParse->db, pAggInfo);
519413449892Sdrh           if( i>=0 ){
51956ab3a2ecSdanielk1977             assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
519613449892Sdrh             pItem = &pAggInfo->aFunc[i];
519713449892Sdrh             pItem->pExpr = pExpr;
51980a07c107Sdrh             pItem->iMem = ++pParse->nMem;
519933e619fcSdrh             assert( !ExprHasProperty(pExpr, EP_IntValue) );
520013449892Sdrh             pItem->pFunc = sqlite3FindFunction(pParse->db,
520180738d9cSdrh                    pExpr->u.zToken,
52026ab3a2ecSdanielk1977                    pExpr->x.pList ? pExpr->x.pList->nExpr : 0, enc, 0);
5203fd357974Sdrh             if( pExpr->flags & EP_Distinct ){
5204fd357974Sdrh               pItem->iDistinct = pParse->nTab++;
5205fd357974Sdrh             }else{
5206fd357974Sdrh               pItem->iDistinct = -1;
5207fd357974Sdrh             }
52082282792aSdrh           }
520913449892Sdrh         }
521013449892Sdrh         /* Make pExpr point to the appropriate pAggInfo->aFunc[] entry
521113449892Sdrh         */
5212c5cd1249Sdrh         assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
5213ebb6a65dSdrh         ExprSetVVAProperty(pExpr, EP_NoReduce);
5214cf697396Sshane         pExpr->iAgg = (i16)i;
521513449892Sdrh         pExpr->pAggInfo = pAggInfo;
52163a8c4be7Sdrh         return WRC_Prune;
52176e83a57fSdrh       }else{
52186e83a57fSdrh         return WRC_Continue;
52196e83a57fSdrh       }
52202282792aSdrh     }
5221a58fdfb1Sdanielk1977   }
52227d10d5a6Sdrh   return WRC_Continue;
52237d10d5a6Sdrh }
52247d10d5a6Sdrh static int analyzeAggregatesInSelect(Walker *pWalker, Select *pSelect){
5225d5a336efSdrh   UNUSED_PARAMETER(pSelect);
5226979dd1beSdrh   pWalker->walkerDepth++;
52277d10d5a6Sdrh   return WRC_Continue;
5228a58fdfb1Sdanielk1977 }
5229979dd1beSdrh static void analyzeAggregatesInSelectEnd(Walker *pWalker, Select *pSelect){
5230979dd1beSdrh   UNUSED_PARAMETER(pSelect);
5231979dd1beSdrh   pWalker->walkerDepth--;
5232979dd1beSdrh }
5233626a879aSdrh 
5234626a879aSdrh /*
5235e8abb4caSdrh ** Analyze the pExpr expression looking for aggregate functions and
5236e8abb4caSdrh ** for variables that need to be added to AggInfo object that pNC->pAggInfo
5237e8abb4caSdrh ** points to.  Additional entries are made on the AggInfo object as
5238e8abb4caSdrh ** necessary.
5239626a879aSdrh **
5240626a879aSdrh ** This routine should only be called after the expression has been
52417d10d5a6Sdrh ** analyzed by sqlite3ResolveExprNames().
5242626a879aSdrh */
5243d2b3e23bSdrh void sqlite3ExprAnalyzeAggregates(NameContext *pNC, Expr *pExpr){
52447d10d5a6Sdrh   Walker w;
52457d10d5a6Sdrh   w.xExprCallback = analyzeAggregate;
52467d10d5a6Sdrh   w.xSelectCallback = analyzeAggregatesInSelect;
5247979dd1beSdrh   w.xSelectCallback2 = analyzeAggregatesInSelectEnd;
5248979dd1beSdrh   w.walkerDepth = 0;
52497d10d5a6Sdrh   w.u.pNC = pNC;
525020bc393cSdrh   assert( pNC->pSrcList!=0 );
52517d10d5a6Sdrh   sqlite3WalkExpr(&w, pExpr);
52522282792aSdrh }
52535d9a4af9Sdrh 
52545d9a4af9Sdrh /*
52555d9a4af9Sdrh ** Call sqlite3ExprAnalyzeAggregates() for every expression in an
52565d9a4af9Sdrh ** expression list.  Return the number of errors.
52575d9a4af9Sdrh **
52585d9a4af9Sdrh ** If an error is found, the analysis is cut short.
52595d9a4af9Sdrh */
5260d2b3e23bSdrh void sqlite3ExprAnalyzeAggList(NameContext *pNC, ExprList *pList){
52615d9a4af9Sdrh   struct ExprList_item *pItem;
52625d9a4af9Sdrh   int i;
52635d9a4af9Sdrh   if( pList ){
5264d2b3e23bSdrh     for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
5265d2b3e23bSdrh       sqlite3ExprAnalyzeAggregates(pNC, pItem->pExpr);
52665d9a4af9Sdrh     }
52675d9a4af9Sdrh   }
52685d9a4af9Sdrh }
5269892d3179Sdrh 
5270892d3179Sdrh /*
5271ceea3321Sdrh ** Allocate a single new register for use to hold some intermediate result.
5272892d3179Sdrh */
5273892d3179Sdrh int sqlite3GetTempReg(Parse *pParse){
5274e55cbd72Sdrh   if( pParse->nTempReg==0 ){
5275892d3179Sdrh     return ++pParse->nMem;
5276892d3179Sdrh   }
52772f425f6bSdanielk1977   return pParse->aTempReg[--pParse->nTempReg];
5278892d3179Sdrh }
5279ceea3321Sdrh 
5280ceea3321Sdrh /*
5281ceea3321Sdrh ** Deallocate a register, making available for reuse for some other
5282ceea3321Sdrh ** purpose.
5283ceea3321Sdrh */
5284892d3179Sdrh void sqlite3ReleaseTempReg(Parse *pParse, int iReg){
52852dcef11bSdrh   if( iReg && pParse->nTempReg<ArraySize(pParse->aTempReg) ){
5286892d3179Sdrh     pParse->aTempReg[pParse->nTempReg++] = iReg;
5287892d3179Sdrh   }
5288892d3179Sdrh }
5289892d3179Sdrh 
5290892d3179Sdrh /*
5291ed24da4bSdrh ** Allocate or deallocate a block of nReg consecutive registers.
5292892d3179Sdrh */
5293892d3179Sdrh int sqlite3GetTempRange(Parse *pParse, int nReg){
5294e55cbd72Sdrh   int i, n;
5295ed24da4bSdrh   if( nReg==1 ) return sqlite3GetTempReg(pParse);
5296892d3179Sdrh   i = pParse->iRangeReg;
5297e55cbd72Sdrh   n = pParse->nRangeReg;
5298f49f3523Sdrh   if( nReg<=n ){
5299892d3179Sdrh     pParse->iRangeReg += nReg;
5300892d3179Sdrh     pParse->nRangeReg -= nReg;
5301892d3179Sdrh   }else{
5302892d3179Sdrh     i = pParse->nMem+1;
5303892d3179Sdrh     pParse->nMem += nReg;
5304892d3179Sdrh   }
5305892d3179Sdrh   return i;
5306892d3179Sdrh }
5307892d3179Sdrh void sqlite3ReleaseTempRange(Parse *pParse, int iReg, int nReg){
5308ed24da4bSdrh   if( nReg==1 ){
5309ed24da4bSdrh     sqlite3ReleaseTempReg(pParse, iReg);
5310ed24da4bSdrh     return;
5311ed24da4bSdrh   }
5312892d3179Sdrh   if( nReg>pParse->nRangeReg ){
5313892d3179Sdrh     pParse->nRangeReg = nReg;
5314892d3179Sdrh     pParse->iRangeReg = iReg;
5315892d3179Sdrh   }
5316892d3179Sdrh }
5317cdc69557Sdrh 
5318cdc69557Sdrh /*
5319cdc69557Sdrh ** Mark all temporary registers as being unavailable for reuse.
5320cdc69557Sdrh */
5321cdc69557Sdrh void sqlite3ClearTempRegCache(Parse *pParse){
5322cdc69557Sdrh   pParse->nTempReg = 0;
5323cdc69557Sdrh   pParse->nRangeReg = 0;
5324cdc69557Sdrh }
5325bb9b5f26Sdrh 
5326bb9b5f26Sdrh /*
5327bb9b5f26Sdrh ** Validate that no temporary register falls within the range of
5328bb9b5f26Sdrh ** iFirst..iLast, inclusive.  This routine is only call from within assert()
5329bb9b5f26Sdrh ** statements.
5330bb9b5f26Sdrh */
5331bb9b5f26Sdrh #ifdef SQLITE_DEBUG
5332bb9b5f26Sdrh int sqlite3NoTempsInRange(Parse *pParse, int iFirst, int iLast){
5333bb9b5f26Sdrh   int i;
5334bb9b5f26Sdrh   if( pParse->nRangeReg>0
53353963e584Sdrh    && pParse->iRangeReg+pParse->nRangeReg > iFirst
53363963e584Sdrh    && pParse->iRangeReg <= iLast
5337bb9b5f26Sdrh   ){
5338bb9b5f26Sdrh      return 0;
5339bb9b5f26Sdrh   }
5340bb9b5f26Sdrh   for(i=0; i<pParse->nTempReg; i++){
5341bb9b5f26Sdrh     if( pParse->aTempReg[i]>=iFirst && pParse->aTempReg[i]<=iLast ){
5342bb9b5f26Sdrh       return 0;
5343bb9b5f26Sdrh     }
5344bb9b5f26Sdrh   }
5345bb9b5f26Sdrh   return 1;
5346bb9b5f26Sdrh }
5347bb9b5f26Sdrh #endif /* SQLITE_DEBUG */
5348