xref: /sqlite-3.40.0/src/expr.c (revision efad2e23)
1cce7d176Sdrh /*
2b19a2bc6Sdrh ** 2001 September 15
3cce7d176Sdrh **
4b19a2bc6Sdrh ** The author disclaims copyright to this source code.  In place of
5b19a2bc6Sdrh ** a legal notice, here is a blessing:
6cce7d176Sdrh **
7b19a2bc6Sdrh **    May you do good and not evil.
8b19a2bc6Sdrh **    May you find forgiveness for yourself and forgive others.
9b19a2bc6Sdrh **    May you share freely, never taking more than you give.
10cce7d176Sdrh **
11cce7d176Sdrh *************************************************************************
121ccde15dSdrh ** This file contains routines used for analyzing expressions and
13b19a2bc6Sdrh ** for generating VDBE code that evaluates expressions in SQLite.
14cce7d176Sdrh */
15cce7d176Sdrh #include "sqliteInt.h"
16a2e00042Sdrh 
1712abf408Sdrh /* Forward declarations */
1812abf408Sdrh static void exprCodeBetween(Parse*,Expr*,int,void(*)(Parse*,Expr*,int,int),int);
1912abf408Sdrh static int exprCodeVector(Parse *pParse, Expr *p, int *piToFree);
2012abf408Sdrh 
210dfa4f6fSdrh /*
220dfa4f6fSdrh ** Return the affinity character for a single column of a table.
230dfa4f6fSdrh */
240dfa4f6fSdrh char sqlite3TableColumnAffinity(Table *pTab, int iCol){
250dfa4f6fSdrh   assert( iCol<pTab->nCol );
260dfa4f6fSdrh   return iCol>=0 ? pTab->aCol[iCol].affinity : SQLITE_AFF_INTEGER;
270dfa4f6fSdrh }
2812abf408Sdrh 
29e014a838Sdanielk1977 /*
30e014a838Sdanielk1977 ** Return the 'affinity' of the expression pExpr if any.
31e014a838Sdanielk1977 **
32e014a838Sdanielk1977 ** If pExpr is a column, a reference to a column via an 'AS' alias,
33e014a838Sdanielk1977 ** or a sub-select with a column as the return value, then the
34e014a838Sdanielk1977 ** affinity of that column is returned. Otherwise, 0x00 is returned,
35e014a838Sdanielk1977 ** indicating no affinity for the expression.
36e014a838Sdanielk1977 **
3760ec914cSpeter.d.reid ** i.e. the WHERE clause expressions in the following statements all
38e014a838Sdanielk1977 ** have an affinity:
39e014a838Sdanielk1977 **
40e014a838Sdanielk1977 ** CREATE TABLE t1(a);
41e014a838Sdanielk1977 ** SELECT * FROM t1 WHERE a;
42e014a838Sdanielk1977 ** SELECT a AS b FROM t1 WHERE b;
43e014a838Sdanielk1977 ** SELECT * FROM t1 WHERE (select a from t1);
44e014a838Sdanielk1977 */
45bf3b721fSdanielk1977 char sqlite3ExprAffinity(Expr *pExpr){
46580c8c18Sdrh   int op;
47580c8c18Sdrh   pExpr = sqlite3ExprSkipCollate(pExpr);
489bec6fb3Smistachkin   if( pExpr->flags & EP_Generic ) return 0;
49580c8c18Sdrh   op = pExpr->op;
50487e262fSdrh   if( op==TK_SELECT ){
516ab3a2ecSdanielk1977     assert( pExpr->flags&EP_xIsSelect );
526ab3a2ecSdanielk1977     return sqlite3ExprAffinity(pExpr->x.pSelect->pEList->a[0].pExpr);
53a37cdde0Sdanielk1977   }
54db45bd5eSdrh   if( op==TK_REGISTER ) op = pExpr->op2;
55487e262fSdrh #ifndef SQLITE_OMIT_CAST
56487e262fSdrh   if( op==TK_CAST ){
5733e619fcSdrh     assert( !ExprHasProperty(pExpr, EP_IntValue) );
58fdaac671Sdrh     return sqlite3AffinityType(pExpr->u.zToken, 0);
59487e262fSdrh   }
60487e262fSdrh #endif
61b8d29c2fSdan   if( (op==TK_AGG_COLUMN || op==TK_COLUMN) && pExpr->pTab ){
620dfa4f6fSdrh     return sqlite3TableColumnAffinity(pExpr->pTab, pExpr->iColumn);
637d10d5a6Sdrh   }
6480aa5453Sdan   if( op==TK_SELECT_COLUMN ){
6580aa5453Sdan     assert( pExpr->pLeft->flags&EP_xIsSelect );
6680aa5453Sdan     return sqlite3ExprAffinity(
6780aa5453Sdan         pExpr->pLeft->x.pSelect->pEList->a[pExpr->iColumn].pExpr
6880aa5453Sdan     );
6980aa5453Sdan   }
70a37cdde0Sdanielk1977   return pExpr->affinity;
71a37cdde0Sdanielk1977 }
72a37cdde0Sdanielk1977 
7353db1458Sdrh /*
748b4c40d8Sdrh ** Set the collating sequence for expression pExpr to be the collating
75ae80ddeaSdrh ** sequence named by pToken.   Return a pointer to a new Expr node that
76ae80ddeaSdrh ** implements the COLLATE operator.
770a8a406eSdrh **
780a8a406eSdrh ** If a memory allocation error occurs, that fact is recorded in pParse->db
790a8a406eSdrh ** and the pExpr parameter is returned unchanged.
808b4c40d8Sdrh */
814ef7efadSdrh Expr *sqlite3ExprAddCollateToken(
824ef7efadSdrh   Parse *pParse,           /* Parsing context */
834ef7efadSdrh   Expr *pExpr,             /* Add the "COLLATE" clause to this expression */
8480103fc6Sdan   const Token *pCollName,  /* Name of collating sequence */
8580103fc6Sdan   int dequote              /* True to dequote pCollName */
864ef7efadSdrh ){
870a8a406eSdrh   if( pCollName->n>0 ){
8880103fc6Sdan     Expr *pNew = sqlite3ExprAlloc(pParse->db, TK_COLLATE, pCollName, dequote);
89ae80ddeaSdrh     if( pNew ){
90ae80ddeaSdrh       pNew->pLeft = pExpr;
91a4c3c87eSdrh       pNew->flags |= EP_Collate|EP_Skip;
920a8a406eSdrh       pExpr = pNew;
93ae80ddeaSdrh     }
940a8a406eSdrh   }
950a8a406eSdrh   return pExpr;
960a8a406eSdrh }
970a8a406eSdrh Expr *sqlite3ExprAddCollateString(Parse *pParse, Expr *pExpr, const char *zC){
980a8a406eSdrh   Token s;
99261d8a51Sdrh   assert( zC!=0 );
10040aced5cSdrh   sqlite3TokenInit(&s, (char*)zC);
10180103fc6Sdan   return sqlite3ExprAddCollateToken(pParse, pExpr, &s, 0);
1020a8a406eSdrh }
1030a8a406eSdrh 
1040a8a406eSdrh /*
1050b8d255cSdrh ** Skip over any TK_COLLATE operators and any unlikely()
106a4c3c87eSdrh ** or likelihood() function at the root of an expression.
1070a8a406eSdrh */
1080a8a406eSdrh Expr *sqlite3ExprSkipCollate(Expr *pExpr){
109a4c3c87eSdrh   while( pExpr && ExprHasProperty(pExpr, EP_Skip) ){
110a4c3c87eSdrh     if( ExprHasProperty(pExpr, EP_Unlikely) ){
111cca9f3d2Sdrh       assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
112cca9f3d2Sdrh       assert( pExpr->x.pList->nExpr>0 );
113a4c3c87eSdrh       assert( pExpr->op==TK_FUNCTION );
114cca9f3d2Sdrh       pExpr = pExpr->x.pList->a[0].pExpr;
115cca9f3d2Sdrh     }else{
1160b8d255cSdrh       assert( pExpr->op==TK_COLLATE );
117d91eba96Sdrh       pExpr = pExpr->pLeft;
118cca9f3d2Sdrh     }
119d91eba96Sdrh   }
1200a8a406eSdrh   return pExpr;
1218b4c40d8Sdrh }
1228b4c40d8Sdrh 
1238b4c40d8Sdrh /*
124ae80ddeaSdrh ** Return the collation sequence for the expression pExpr. If
125ae80ddeaSdrh ** there is no defined collating sequence, return NULL.
126ae80ddeaSdrh **
12770efa84dSdrh ** See also: sqlite3ExprNNCollSeq()
12870efa84dSdrh **
12970efa84dSdrh ** The sqlite3ExprNNCollSeq() works the same exact that it returns the
13070efa84dSdrh ** default collation if pExpr has no defined collation.
13170efa84dSdrh **
132ae80ddeaSdrh ** The collating sequence might be determined by a COLLATE operator
133ae80ddeaSdrh ** or by the presence of a column with a defined collating sequence.
134ae80ddeaSdrh ** COLLATE operators take first precedence.  Left operands take
135ae80ddeaSdrh ** precedence over right operands.
1360202b29eSdanielk1977 */
1377cedc8d4Sdanielk1977 CollSeq *sqlite3ExprCollSeq(Parse *pParse, Expr *pExpr){
138ae80ddeaSdrh   sqlite3 *db = pParse->db;
1397cedc8d4Sdanielk1977   CollSeq *pColl = 0;
1407d10d5a6Sdrh   Expr *p = pExpr;
141261d8a51Sdrh   while( p ){
142ae80ddeaSdrh     int op = p->op;
143fbb24d10Sdrh     if( p->flags & EP_Generic ) break;
144ae80ddeaSdrh     if( op==TK_CAST || op==TK_UPLUS ){
145ae80ddeaSdrh       p = p->pLeft;
146ae80ddeaSdrh       continue;
147ae80ddeaSdrh     }
14836e78309Sdan     if( op==TK_COLLATE || (op==TK_REGISTER && p->op2==TK_COLLATE) ){
1497a66da13Sdrh       pColl = sqlite3GetCollSeq(pParse, ENC(db), 0, p->u.zToken);
150ae80ddeaSdrh       break;
151ae80ddeaSdrh     }
152a58d4a96Sdrh     if( (op==TK_AGG_COLUMN || op==TK_COLUMN
153ae80ddeaSdrh           || op==TK_REGISTER || op==TK_TRIGGER)
154a58d4a96Sdrh      && p->pTab!=0
155ae80ddeaSdrh     ){
1567d10d5a6Sdrh       /* op==TK_REGISTER && p->pTab!=0 happens when pExpr was originally
1577d10d5a6Sdrh       ** a TK_COLUMN but was previously evaluated and cached in a register */
1587d10d5a6Sdrh       int j = p->iColumn;
1597d10d5a6Sdrh       if( j>=0 ){
160ae80ddeaSdrh         const char *zColl = p->pTab->aCol[j].zColl;
161c4a64facSdrh         pColl = sqlite3FindCollSeq(db, ENC(db), zColl, 0);
1620202b29eSdanielk1977       }
1637d10d5a6Sdrh       break;
1647d10d5a6Sdrh     }
165ae80ddeaSdrh     if( p->flags & EP_Collate ){
1662308ed38Sdrh       if( p->pLeft && (p->pLeft->flags & EP_Collate)!=0 ){
1677d10d5a6Sdrh         p = p->pLeft;
168ae80ddeaSdrh       }else{
1692308ed38Sdrh         Expr *pNext  = p->pRight;
1706728cd91Sdrh         /* The Expr.x union is never used at the same time as Expr.pRight */
1716728cd91Sdrh         assert( p->x.pList==0 || p->pRight==0 );
1726728cd91Sdrh         /* p->flags holds EP_Collate and p->pLeft->flags does not.  And
1736728cd91Sdrh         ** p->x.pSelect cannot.  So if p->x.pLeft exists, it must hold at
1746728cd91Sdrh         ** least one EP_Collate. Thus the following two ALWAYS. */
1756728cd91Sdrh         if( p->x.pList!=0 && ALWAYS(!ExprHasProperty(p, EP_xIsSelect)) ){
1762308ed38Sdrh           int i;
1776728cd91Sdrh           for(i=0; ALWAYS(i<p->x.pList->nExpr); i++){
1782308ed38Sdrh             if( ExprHasProperty(p->x.pList->a[i].pExpr, EP_Collate) ){
1792308ed38Sdrh               pNext = p->x.pList->a[i].pExpr;
1802308ed38Sdrh               break;
1812308ed38Sdrh             }
1822308ed38Sdrh           }
1832308ed38Sdrh         }
1842308ed38Sdrh         p = pNext;
185ae80ddeaSdrh       }
186ae80ddeaSdrh     }else{
187ae80ddeaSdrh       break;
188ae80ddeaSdrh     }
1890202b29eSdanielk1977   }
1907cedc8d4Sdanielk1977   if( sqlite3CheckCollSeq(pParse, pColl) ){
1917cedc8d4Sdanielk1977     pColl = 0;
1927cedc8d4Sdanielk1977   }
1937cedc8d4Sdanielk1977   return pColl;
1940202b29eSdanielk1977 }
1950202b29eSdanielk1977 
1960202b29eSdanielk1977 /*
19770efa84dSdrh ** Return the collation sequence for the expression pExpr. If
19870efa84dSdrh ** there is no defined collating sequence, return a pointer to the
19970efa84dSdrh ** defautl collation sequence.
20070efa84dSdrh **
20170efa84dSdrh ** See also: sqlite3ExprCollSeq()
20270efa84dSdrh **
20370efa84dSdrh ** The sqlite3ExprCollSeq() routine works the same except that it
20470efa84dSdrh ** returns NULL if there is no defined collation.
20570efa84dSdrh */
20670efa84dSdrh CollSeq *sqlite3ExprNNCollSeq(Parse *pParse, Expr *pExpr){
20770efa84dSdrh   CollSeq *p = sqlite3ExprCollSeq(pParse, pExpr);
20870efa84dSdrh   if( p==0 ) p = pParse->db->pDfltColl;
20970efa84dSdrh   assert( p!=0 );
21070efa84dSdrh   return p;
21170efa84dSdrh }
21270efa84dSdrh 
21370efa84dSdrh /*
21470efa84dSdrh ** Return TRUE if the two expressions have equivalent collating sequences.
21570efa84dSdrh */
21670efa84dSdrh int sqlite3ExprCollSeqMatch(Parse *pParse, Expr *pE1, Expr *pE2){
21770efa84dSdrh   CollSeq *pColl1 = sqlite3ExprNNCollSeq(pParse, pE1);
21870efa84dSdrh   CollSeq *pColl2 = sqlite3ExprNNCollSeq(pParse, pE2);
21970efa84dSdrh   return sqlite3StrICmp(pColl1->zName, pColl2->zName)==0;
22070efa84dSdrh }
22170efa84dSdrh 
22270efa84dSdrh /*
223626a879aSdrh ** pExpr is an operand of a comparison operator.  aff2 is the
224626a879aSdrh ** type affinity of the other operand.  This routine returns the
22553db1458Sdrh ** type affinity that should be used for the comparison operator.
22653db1458Sdrh */
227e014a838Sdanielk1977 char sqlite3CompareAffinity(Expr *pExpr, char aff2){
228bf3b721fSdanielk1977   char aff1 = sqlite3ExprAffinity(pExpr);
229e014a838Sdanielk1977   if( aff1 && aff2 ){
2308df447f0Sdrh     /* Both sides of the comparison are columns. If one has numeric
2318df447f0Sdrh     ** affinity, use that. Otherwise use no affinity.
232e014a838Sdanielk1977     */
2338a51256cSdrh     if( sqlite3IsNumericAffinity(aff1) || sqlite3IsNumericAffinity(aff2) ){
234e014a838Sdanielk1977       return SQLITE_AFF_NUMERIC;
235e014a838Sdanielk1977     }else{
23605883a34Sdrh       return SQLITE_AFF_BLOB;
237e014a838Sdanielk1977     }
238e014a838Sdanielk1977   }else if( !aff1 && !aff2 ){
2395f6a87b3Sdrh     /* Neither side of the comparison is a column.  Compare the
2405f6a87b3Sdrh     ** results directly.
241e014a838Sdanielk1977     */
24205883a34Sdrh     return SQLITE_AFF_BLOB;
243e014a838Sdanielk1977   }else{
244e014a838Sdanielk1977     /* One side is a column, the other is not. Use the columns affinity. */
245fe05af87Sdrh     assert( aff1==0 || aff2==0 );
246e014a838Sdanielk1977     return (aff1 + aff2);
247e014a838Sdanielk1977   }
248e014a838Sdanielk1977 }
249e014a838Sdanielk1977 
25053db1458Sdrh /*
25153db1458Sdrh ** pExpr is a comparison operator.  Return the type affinity that should
25253db1458Sdrh ** be applied to both operands prior to doing the comparison.
25353db1458Sdrh */
254e014a838Sdanielk1977 static char comparisonAffinity(Expr *pExpr){
255e014a838Sdanielk1977   char aff;
256e014a838Sdanielk1977   assert( pExpr->op==TK_EQ || pExpr->op==TK_IN || pExpr->op==TK_LT ||
257e014a838Sdanielk1977           pExpr->op==TK_GT || pExpr->op==TK_GE || pExpr->op==TK_LE ||
2586a2fe093Sdrh           pExpr->op==TK_NE || pExpr->op==TK_IS || pExpr->op==TK_ISNOT );
259e014a838Sdanielk1977   assert( pExpr->pLeft );
260bf3b721fSdanielk1977   aff = sqlite3ExprAffinity(pExpr->pLeft);
261e014a838Sdanielk1977   if( pExpr->pRight ){
262e014a838Sdanielk1977     aff = sqlite3CompareAffinity(pExpr->pRight, aff);
2636ab3a2ecSdanielk1977   }else if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2646ab3a2ecSdanielk1977     aff = sqlite3CompareAffinity(pExpr->x.pSelect->pEList->a[0].pExpr, aff);
26513ac46eeSdrh   }else if( aff==0 ){
26605883a34Sdrh     aff = SQLITE_AFF_BLOB;
267e014a838Sdanielk1977   }
268e014a838Sdanielk1977   return aff;
269e014a838Sdanielk1977 }
270e014a838Sdanielk1977 
271e014a838Sdanielk1977 /*
272e014a838Sdanielk1977 ** pExpr is a comparison expression, eg. '=', '<', IN(...) etc.
273e014a838Sdanielk1977 ** idx_affinity is the affinity of an indexed column. Return true
274e014a838Sdanielk1977 ** if the index with affinity idx_affinity may be used to implement
275e014a838Sdanielk1977 ** the comparison in pExpr.
276e014a838Sdanielk1977 */
277e014a838Sdanielk1977 int sqlite3IndexAffinityOk(Expr *pExpr, char idx_affinity){
278e014a838Sdanielk1977   char aff = comparisonAffinity(pExpr);
2798a51256cSdrh   switch( aff ){
28005883a34Sdrh     case SQLITE_AFF_BLOB:
2818a51256cSdrh       return 1;
2828a51256cSdrh     case SQLITE_AFF_TEXT:
2838a51256cSdrh       return idx_affinity==SQLITE_AFF_TEXT;
2848a51256cSdrh     default:
2858a51256cSdrh       return sqlite3IsNumericAffinity(idx_affinity);
2868a51256cSdrh   }
287e014a838Sdanielk1977 }
288e014a838Sdanielk1977 
289a37cdde0Sdanielk1977 /*
29035573356Sdrh ** Return the P5 value that should be used for a binary comparison
291a37cdde0Sdanielk1977 ** opcode (OP_Eq, OP_Ge etc.) used to compare pExpr1 and pExpr2.
292a37cdde0Sdanielk1977 */
29335573356Sdrh static u8 binaryCompareP5(Expr *pExpr1, Expr *pExpr2, int jumpIfNull){
29435573356Sdrh   u8 aff = (char)sqlite3ExprAffinity(pExpr2);
2951bd10f8aSdrh   aff = (u8)sqlite3CompareAffinity(pExpr1, aff) | (u8)jumpIfNull;
29635573356Sdrh   return aff;
297a37cdde0Sdanielk1977 }
298a37cdde0Sdanielk1977 
299a2e00042Sdrh /*
3000202b29eSdanielk1977 ** Return a pointer to the collation sequence that should be used by
3010202b29eSdanielk1977 ** a binary comparison operator comparing pLeft and pRight.
3020202b29eSdanielk1977 **
3030202b29eSdanielk1977 ** If the left hand expression has a collating sequence type, then it is
3040202b29eSdanielk1977 ** used. Otherwise the collation sequence for the right hand expression
3050202b29eSdanielk1977 ** is used, or the default (BINARY) if neither expression has a collating
3060202b29eSdanielk1977 ** type.
307bcbb04e5Sdanielk1977 **
308bcbb04e5Sdanielk1977 ** Argument pRight (but not pLeft) may be a null pointer. In this case,
309bcbb04e5Sdanielk1977 ** it is not considered.
3100202b29eSdanielk1977 */
311bcbb04e5Sdanielk1977 CollSeq *sqlite3BinaryCompareCollSeq(
312bcbb04e5Sdanielk1977   Parse *pParse,
313bcbb04e5Sdanielk1977   Expr *pLeft,
314bcbb04e5Sdanielk1977   Expr *pRight
315bcbb04e5Sdanielk1977 ){
316ec41ddacSdrh   CollSeq *pColl;
317ec41ddacSdrh   assert( pLeft );
318ae80ddeaSdrh   if( pLeft->flags & EP_Collate ){
319ae80ddeaSdrh     pColl = sqlite3ExprCollSeq(pParse, pLeft);
320ae80ddeaSdrh   }else if( pRight && (pRight->flags & EP_Collate)!=0 ){
321ae80ddeaSdrh     pColl = sqlite3ExprCollSeq(pParse, pRight);
322ec41ddacSdrh   }else{
323ec41ddacSdrh     pColl = sqlite3ExprCollSeq(pParse, pLeft);
3240202b29eSdanielk1977     if( !pColl ){
3257cedc8d4Sdanielk1977       pColl = sqlite3ExprCollSeq(pParse, pRight);
3260202b29eSdanielk1977     }
327ec41ddacSdrh   }
3280202b29eSdanielk1977   return pColl;
3290202b29eSdanielk1977 }
3300202b29eSdanielk1977 
3310202b29eSdanielk1977 /*
332*efad2e23Sdrh ** Return true if CollSeq is the default built-in BINARY.
333*efad2e23Sdrh */
334*efad2e23Sdrh int sqlite3IsBinary(const CollSeq *p){
335*efad2e23Sdrh   if( p==0 ) return 1;
336*efad2e23Sdrh   if( sqlite3_stricmp(p->zName,"BINARY")==0 ) return 1;
337*efad2e23Sdrh   return 0;
338*efad2e23Sdrh }
339*efad2e23Sdrh 
340*efad2e23Sdrh /*
341be5c89acSdrh ** Generate code for a comparison operator.
342be5c89acSdrh */
343be5c89acSdrh static int codeCompare(
344be5c89acSdrh   Parse *pParse,    /* The parsing (and code generating) context */
345be5c89acSdrh   Expr *pLeft,      /* The left operand */
346be5c89acSdrh   Expr *pRight,     /* The right operand */
347be5c89acSdrh   int opcode,       /* The comparison opcode */
34835573356Sdrh   int in1, int in2, /* Register holding operands */
349be5c89acSdrh   int dest,         /* Jump here if true.  */
350be5c89acSdrh   int jumpIfNull    /* If true, jump if either operand is NULL */
351be5c89acSdrh ){
35235573356Sdrh   int p5;
35335573356Sdrh   int addr;
35435573356Sdrh   CollSeq *p4;
35535573356Sdrh 
35635573356Sdrh   p4 = sqlite3BinaryCompareCollSeq(pParse, pLeft, pRight);
35735573356Sdrh   p5 = binaryCompareP5(pLeft, pRight, jumpIfNull);
35835573356Sdrh   addr = sqlite3VdbeAddOp4(pParse->pVdbe, opcode, in2, dest, in1,
35935573356Sdrh                            (void*)p4, P4_COLLSEQ);
3601bd10f8aSdrh   sqlite3VdbeChangeP5(pParse->pVdbe, (u8)p5);
36135573356Sdrh   return addr;
362be5c89acSdrh }
363be5c89acSdrh 
364cfbb5e82Sdan /*
365870a0705Sdan ** Return true if expression pExpr is a vector, or false otherwise.
366d832da7fSdrh **
367d832da7fSdrh ** A vector is defined as any expression that results in two or more
368d832da7fSdrh ** columns of result.  Every TK_VECTOR node is an vector because the
369d832da7fSdrh ** parser will not generate a TK_VECTOR with fewer than two entries.
370d832da7fSdrh ** But a TK_SELECT might be either a vector or a scalar. It is only
371d832da7fSdrh ** considered a vector if it has two or more result columns.
372870a0705Sdan */
373870a0705Sdan int sqlite3ExprIsVector(Expr *pExpr){
37476dbe7a8Sdrh   return sqlite3ExprVectorSize(pExpr)>1;
375870a0705Sdan }
376870a0705Sdan 
377870a0705Sdan /*
378cfbb5e82Sdan ** If the expression passed as the only argument is of type TK_VECTOR
379cfbb5e82Sdan ** return the number of expressions in the vector. Or, if the expression
380cfbb5e82Sdan ** is a sub-select, return the number of columns in the sub-select. For
381cfbb5e82Sdan ** any other type of expression, return 1.
382cfbb5e82Sdan */
38371c57db0Sdan int sqlite3ExprVectorSize(Expr *pExpr){
38412abf408Sdrh   u8 op = pExpr->op;
38512abf408Sdrh   if( op==TK_REGISTER ) op = pExpr->op2;
38612abf408Sdrh   if( op==TK_VECTOR ){
38771c57db0Sdan     return pExpr->x.pList->nExpr;
38812abf408Sdrh   }else if( op==TK_SELECT ){
38976dbe7a8Sdrh     return pExpr->x.pSelect->pEList->nExpr;
39076dbe7a8Sdrh   }else{
39176dbe7a8Sdrh     return 1;
39276dbe7a8Sdrh   }
39371c57db0Sdan }
39471c57db0Sdan 
395ba00e30aSdan /*
396fc7f27b9Sdrh ** Return a pointer to a subexpression of pVector that is the i-th
397fc7f27b9Sdrh ** column of the vector (numbered starting with 0).  The caller must
398fc7f27b9Sdrh ** ensure that i is within range.
399fc7f27b9Sdrh **
40076dbe7a8Sdrh ** If pVector is really a scalar (and "scalar" here includes subqueries
40176dbe7a8Sdrh ** that return a single column!) then return pVector unmodified.
40276dbe7a8Sdrh **
403fc7f27b9Sdrh ** pVector retains ownership of the returned subexpression.
404fc7f27b9Sdrh **
405fc7f27b9Sdrh ** If the vector is a (SELECT ...) then the expression returned is
40676dbe7a8Sdrh ** just the expression for the i-th term of the result set, and may
40776dbe7a8Sdrh ** not be ready for evaluation because the table cursor has not yet
40876dbe7a8Sdrh ** been positioned.
409ba00e30aSdan */
410fc7f27b9Sdrh Expr *sqlite3VectorFieldSubexpr(Expr *pVector, int i){
411870a0705Sdan   assert( i<sqlite3ExprVectorSize(pVector) );
412870a0705Sdan   if( sqlite3ExprIsVector(pVector) ){
4139f24b53dSdrh     assert( pVector->op2==0 || pVector->op==TK_REGISTER );
4149f24b53dSdrh     if( pVector->op==TK_SELECT || pVector->op2==TK_SELECT ){
41571c57db0Sdan       return pVector->x.pSelect->pEList->a[i].pExpr;
416870a0705Sdan     }else{
41771c57db0Sdan       return pVector->x.pList->a[i].pExpr;
41871c57db0Sdan     }
419870a0705Sdan   }
420870a0705Sdan   return pVector;
421870a0705Sdan }
422fc7f27b9Sdrh 
423fc7f27b9Sdrh /*
424fc7f27b9Sdrh ** Compute and return a new Expr object which when passed to
425fc7f27b9Sdrh ** sqlite3ExprCode() will generate all necessary code to compute
426fc7f27b9Sdrh ** the iField-th column of the vector expression pVector.
427fc7f27b9Sdrh **
4288762ec19Sdrh ** It is ok for pVector to be a scalar (as long as iField==0).
4298762ec19Sdrh ** In that case, this routine works like sqlite3ExprDup().
4308762ec19Sdrh **
431fc7f27b9Sdrh ** The caller owns the returned Expr object and is responsible for
432fc7f27b9Sdrh ** ensuring that the returned value eventually gets freed.
433fc7f27b9Sdrh **
4348762ec19Sdrh ** The caller retains ownership of pVector.  If pVector is a TK_SELECT,
435fad0e70cSdan ** then the returned object will reference pVector and so pVector must remain
4368762ec19Sdrh ** valid for the life of the returned object.  If pVector is a TK_VECTOR
4378762ec19Sdrh ** or a scalar expression, then it can be deleted as soon as this routine
43876dbe7a8Sdrh ** returns.
4398762ec19Sdrh **
4408762ec19Sdrh ** A trick to cause a TK_SELECT pVector to be deleted together with
4418762ec19Sdrh ** the returned Expr object is to attach the pVector to the pRight field
4428762ec19Sdrh ** of the returned TK_SELECT_COLUMN Expr object.
443fc7f27b9Sdrh */
444fc7f27b9Sdrh Expr *sqlite3ExprForVectorField(
445fc7f27b9Sdrh   Parse *pParse,       /* Parsing context */
446fc7f27b9Sdrh   Expr *pVector,       /* The vector.  List of expressions or a sub-SELECT */
447a1251bc4Sdrh   int iField           /* Which column of the vector to return */
448fc7f27b9Sdrh ){
449fc7f27b9Sdrh   Expr *pRet;
450a1251bc4Sdrh   if( pVector->op==TK_SELECT ){
451a1251bc4Sdrh     assert( pVector->flags & EP_xIsSelect );
452fc7f27b9Sdrh     /* The TK_SELECT_COLUMN Expr node:
453fc7f27b9Sdrh     **
454966e2911Sdrh     ** pLeft:           pVector containing TK_SELECT.  Not deleted.
4558762ec19Sdrh     ** pRight:          not used.  But recursively deleted.
456fc7f27b9Sdrh     ** iColumn:         Index of a column in pVector
457966e2911Sdrh     ** iTable:          0 or the number of columns on the LHS of an assignment
458fc7f27b9Sdrh     ** pLeft->iTable:   First in an array of register holding result, or 0
459fc7f27b9Sdrh     **                  if the result is not yet computed.
460fc7f27b9Sdrh     **
461fc7f27b9Sdrh     ** sqlite3ExprDelete() specifically skips the recursive delete of
462fc7f27b9Sdrh     ** pLeft on TK_SELECT_COLUMN nodes.  But pRight is followed, so pVector
4638762ec19Sdrh     ** can be attached to pRight to cause this node to take ownership of
4648762ec19Sdrh     ** pVector.  Typically there will be multiple TK_SELECT_COLUMN nodes
4658762ec19Sdrh     ** with the same pLeft pointer to the pVector, but only one of them
4668762ec19Sdrh     ** will own the pVector.
467fc7f27b9Sdrh     */
468abfd35eaSdrh     pRet = sqlite3PExpr(pParse, TK_SELECT_COLUMN, 0, 0);
4698bd0d58eSdrh     if( pRet ){
4708bd0d58eSdrh       pRet->iColumn = iField;
4718bd0d58eSdrh       pRet->pLeft = pVector;
4728bd0d58eSdrh     }
473fc7f27b9Sdrh     assert( pRet==0 || pRet->iTable==0 );
474fc7f27b9Sdrh   }else{
475a1251bc4Sdrh     if( pVector->op==TK_VECTOR ) pVector = pVector->x.pList->a[iField].pExpr;
476a1251bc4Sdrh     pRet = sqlite3ExprDup(pParse->db, pVector, 0);
477fc7f27b9Sdrh   }
478fc7f27b9Sdrh   return pRet;
479fc7f27b9Sdrh }
48071c57db0Sdan 
4815c288b92Sdan /*
4825c288b92Sdan ** If expression pExpr is of type TK_SELECT, generate code to evaluate
4835c288b92Sdan ** it. Return the register in which the result is stored (or, if the
4845c288b92Sdan ** sub-select returns more than one column, the first in an array
4855c288b92Sdan ** of registers in which the result is stored).
4865c288b92Sdan **
4875c288b92Sdan ** If pExpr is not a TK_SELECT expression, return 0.
4885c288b92Sdan */
4895c288b92Sdan static int exprCodeSubselect(Parse *pParse, Expr *pExpr){
4908da209b1Sdan   int reg = 0;
491f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
4925c288b92Sdan   if( pExpr->op==TK_SELECT ){
4938da209b1Sdan     reg = sqlite3CodeSubselect(pParse, pExpr, 0, 0);
4948da209b1Sdan   }
495f9b2e05cSdan #endif
4968da209b1Sdan   return reg;
4978da209b1Sdan }
4988da209b1Sdan 
4995c288b92Sdan /*
5005c288b92Sdan ** Argument pVector points to a vector expression - either a TK_VECTOR
501870a0705Sdan ** or TK_SELECT that returns more than one column. This function returns
502870a0705Sdan ** the register number of a register that contains the value of
503870a0705Sdan ** element iField of the vector.
504870a0705Sdan **
505870a0705Sdan ** If pVector is a TK_SELECT expression, then code for it must have
506870a0705Sdan ** already been generated using the exprCodeSubselect() routine. In this
507870a0705Sdan ** case parameter regSelect should be the first in an array of registers
508870a0705Sdan ** containing the results of the sub-select.
509870a0705Sdan **
510870a0705Sdan ** If pVector is of type TK_VECTOR, then code for the requested field
511870a0705Sdan ** is generated. In this case (*pRegFree) may be set to the number of
512870a0705Sdan ** a temporary register to be freed by the caller before returning.
5135c288b92Sdan **
5145c288b92Sdan ** Before returning, output parameter (*ppExpr) is set to point to the
5155c288b92Sdan ** Expr object corresponding to element iElem of the vector.
5165c288b92Sdan */
5175c288b92Sdan static int exprVectorRegister(
5185c288b92Sdan   Parse *pParse,                  /* Parse context */
5195c288b92Sdan   Expr *pVector,                  /* Vector to extract element from */
520870a0705Sdan   int iField,                     /* Field to extract from pVector */
5215c288b92Sdan   int regSelect,                  /* First in array of registers */
5225c288b92Sdan   Expr **ppExpr,                  /* OUT: Expression element */
5235c288b92Sdan   int *pRegFree                   /* OUT: Temp register to free */
5245c288b92Sdan ){
52512abf408Sdrh   u8 op = pVector->op;
526c1bcd9ccSdrh   assert( op==TK_VECTOR || op==TK_REGISTER || op==TK_SELECT );
52712abf408Sdrh   if( op==TK_REGISTER ){
52812abf408Sdrh     *ppExpr = sqlite3VectorFieldSubexpr(pVector, iField);
52912abf408Sdrh     return pVector->iTable+iField;
53012abf408Sdrh   }
53112abf408Sdrh   if( op==TK_SELECT ){
532870a0705Sdan     *ppExpr = pVector->x.pSelect->pEList->a[iField].pExpr;
533870a0705Sdan      return regSelect+iField;
5345c288b92Sdan   }
535870a0705Sdan   *ppExpr = pVector->x.pList->a[iField].pExpr;
5365c288b92Sdan   return sqlite3ExprCodeTemp(pParse, *ppExpr, pRegFree);
5375c288b92Sdan }
5385c288b92Sdan 
5395c288b92Sdan /*
5405c288b92Sdan ** Expression pExpr is a comparison between two vector values. Compute
54179752b6eSdrh ** the result of the comparison (1, 0, or NULL) and write that
54279752b6eSdrh ** result into register dest.
54379752b6eSdrh **
54479752b6eSdrh ** The caller must satisfy the following preconditions:
54579752b6eSdrh **
54679752b6eSdrh **    if pExpr->op==TK_IS:      op==TK_EQ and p5==SQLITE_NULLEQ
54779752b6eSdrh **    if pExpr->op==TK_ISNOT:   op==TK_NE and p5==SQLITE_NULLEQ
54879752b6eSdrh **    otherwise:                op==pExpr->op and p5==0
5495c288b92Sdan */
55079752b6eSdrh static void codeVectorCompare(
55179752b6eSdrh   Parse *pParse,        /* Code generator context */
55279752b6eSdrh   Expr *pExpr,          /* The comparison operation */
55379752b6eSdrh   int dest,             /* Write results into this register */
55479752b6eSdrh   u8 op,                /* Comparison operator */
55579752b6eSdrh   u8 p5                 /* SQLITE_NULLEQ or zero */
55679752b6eSdrh ){
55771c57db0Sdan   Vdbe *v = pParse->pVdbe;
55871c57db0Sdan   Expr *pLeft = pExpr->pLeft;
55971c57db0Sdan   Expr *pRight = pExpr->pRight;
56071c57db0Sdan   int nLeft = sqlite3ExprVectorSize(pLeft);
56171c57db0Sdan   int i;
56271c57db0Sdan   int regLeft = 0;
56371c57db0Sdan   int regRight = 0;
56479752b6eSdrh   u8 opx = op;
56579752b6eSdrh   int addrDone = sqlite3VdbeMakeLabel(v);
56671c57db0Sdan 
567245ce62eSdrh   if( nLeft!=sqlite3ExprVectorSize(pRight) ){
568245ce62eSdrh     sqlite3ErrorMsg(pParse, "row value misused");
569245ce62eSdrh     return;
570245ce62eSdrh   }
57171c57db0Sdan   assert( pExpr->op==TK_EQ || pExpr->op==TK_NE
57271c57db0Sdan        || pExpr->op==TK_IS || pExpr->op==TK_ISNOT
57371c57db0Sdan        || pExpr->op==TK_LT || pExpr->op==TK_GT
57471c57db0Sdan        || pExpr->op==TK_LE || pExpr->op==TK_GE
57571c57db0Sdan   );
57679752b6eSdrh   assert( pExpr->op==op || (pExpr->op==TK_IS && op==TK_EQ)
57779752b6eSdrh             || (pExpr->op==TK_ISNOT && op==TK_NE) );
57879752b6eSdrh   assert( p5==0 || pExpr->op!=op );
57979752b6eSdrh   assert( p5==SQLITE_NULLEQ || pExpr->op==op );
58071c57db0Sdan 
58179752b6eSdrh   p5 |= SQLITE_STOREP2;
58279752b6eSdrh   if( opx==TK_LE ) opx = TK_LT;
58379752b6eSdrh   if( opx==TK_GE ) opx = TK_GT;
5845c288b92Sdan 
5855c288b92Sdan   regLeft = exprCodeSubselect(pParse, pLeft);
5865c288b92Sdan   regRight = exprCodeSubselect(pParse, pRight);
5875c288b92Sdan 
588321e828dSdrh   for(i=0; 1 /*Loop exits by "break"*/; i++){
5895c288b92Sdan     int regFree1 = 0, regFree2 = 0;
5905c288b92Sdan     Expr *pL, *pR;
5915c288b92Sdan     int r1, r2;
592321e828dSdrh     assert( i>=0 && i<nLeft );
59379752b6eSdrh     if( i>0 ) sqlite3ExprCachePush(pParse);
5945c288b92Sdan     r1 = exprVectorRegister(pParse, pLeft, i, regLeft, &pL, &regFree1);
5955c288b92Sdan     r2 = exprVectorRegister(pParse, pRight, i, regRight, &pR, &regFree2);
59679752b6eSdrh     codeCompare(pParse, pL, pR, opx, r1, r2, dest, p5);
59779752b6eSdrh     testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
59879752b6eSdrh     testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
59979752b6eSdrh     testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
60079752b6eSdrh     testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
60179752b6eSdrh     testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
60279752b6eSdrh     testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
60371c57db0Sdan     sqlite3ReleaseTempReg(pParse, regFree1);
60471c57db0Sdan     sqlite3ReleaseTempReg(pParse, regFree2);
60579752b6eSdrh     if( i>0 ) sqlite3ExprCachePop(pParse);
60679752b6eSdrh     if( i==nLeft-1 ){
60779752b6eSdrh       break;
60871c57db0Sdan     }
60979752b6eSdrh     if( opx==TK_EQ ){
61079752b6eSdrh       sqlite3VdbeAddOp2(v, OP_IfNot, dest, addrDone); VdbeCoverage(v);
61179752b6eSdrh       p5 |= SQLITE_KEEPNULL;
61279752b6eSdrh     }else if( opx==TK_NE ){
61379752b6eSdrh       sqlite3VdbeAddOp2(v, OP_If, dest, addrDone); VdbeCoverage(v);
61479752b6eSdrh       p5 |= SQLITE_KEEPNULL;
615a2f62925Sdrh     }else{
616a2f62925Sdrh       assert( op==TK_LT || op==TK_GT || op==TK_LE || op==TK_GE );
617a2f62925Sdrh       sqlite3VdbeAddOp2(v, OP_ElseNotEq, 0, addrDone);
61879752b6eSdrh       VdbeCoverageIf(v, op==TK_LT);
61979752b6eSdrh       VdbeCoverageIf(v, op==TK_GT);
62079752b6eSdrh       VdbeCoverageIf(v, op==TK_LE);
62179752b6eSdrh       VdbeCoverageIf(v, op==TK_GE);
62279752b6eSdrh       if( i==nLeft-2 ) opx = op;
62371c57db0Sdan     }
62479752b6eSdrh   }
62579752b6eSdrh   sqlite3VdbeResolveLabel(v, addrDone);
62679752b6eSdrh }
62771c57db0Sdan 
6284b5255acSdanielk1977 #if SQLITE_MAX_EXPR_DEPTH>0
6294b5255acSdanielk1977 /*
6304b5255acSdanielk1977 ** Check that argument nHeight is less than or equal to the maximum
6314b5255acSdanielk1977 ** expression depth allowed. If it is not, leave an error message in
6324b5255acSdanielk1977 ** pParse.
6334b5255acSdanielk1977 */
6347d10d5a6Sdrh int sqlite3ExprCheckHeight(Parse *pParse, int nHeight){
6354b5255acSdanielk1977   int rc = SQLITE_OK;
6364b5255acSdanielk1977   int mxHeight = pParse->db->aLimit[SQLITE_LIMIT_EXPR_DEPTH];
6374b5255acSdanielk1977   if( nHeight>mxHeight ){
6384b5255acSdanielk1977     sqlite3ErrorMsg(pParse,
6394b5255acSdanielk1977        "Expression tree is too large (maximum depth %d)", mxHeight
6404b5255acSdanielk1977     );
6414b5255acSdanielk1977     rc = SQLITE_ERROR;
6424b5255acSdanielk1977   }
6434b5255acSdanielk1977   return rc;
6444b5255acSdanielk1977 }
6454b5255acSdanielk1977 
6464b5255acSdanielk1977 /* The following three functions, heightOfExpr(), heightOfExprList()
6474b5255acSdanielk1977 ** and heightOfSelect(), are used to determine the maximum height
6484b5255acSdanielk1977 ** of any expression tree referenced by the structure passed as the
6494b5255acSdanielk1977 ** first argument.
6504b5255acSdanielk1977 **
6514b5255acSdanielk1977 ** If this maximum height is greater than the current value pointed
6524b5255acSdanielk1977 ** to by pnHeight, the second parameter, then set *pnHeight to that
6534b5255acSdanielk1977 ** value.
6544b5255acSdanielk1977 */
6554b5255acSdanielk1977 static void heightOfExpr(Expr *p, int *pnHeight){
6564b5255acSdanielk1977   if( p ){
6574b5255acSdanielk1977     if( p->nHeight>*pnHeight ){
6584b5255acSdanielk1977       *pnHeight = p->nHeight;
6594b5255acSdanielk1977     }
6604b5255acSdanielk1977   }
6614b5255acSdanielk1977 }
6624b5255acSdanielk1977 static void heightOfExprList(ExprList *p, int *pnHeight){
6634b5255acSdanielk1977   if( p ){
6644b5255acSdanielk1977     int i;
6654b5255acSdanielk1977     for(i=0; i<p->nExpr; i++){
6664b5255acSdanielk1977       heightOfExpr(p->a[i].pExpr, pnHeight);
6674b5255acSdanielk1977     }
6684b5255acSdanielk1977   }
6694b5255acSdanielk1977 }
6701a3a3086Sdan static void heightOfSelect(Select *pSelect, int *pnHeight){
6711a3a3086Sdan   Select *p;
6721a3a3086Sdan   for(p=pSelect; p; p=p->pPrior){
6734b5255acSdanielk1977     heightOfExpr(p->pWhere, pnHeight);
6744b5255acSdanielk1977     heightOfExpr(p->pHaving, pnHeight);
6754b5255acSdanielk1977     heightOfExpr(p->pLimit, pnHeight);
6764b5255acSdanielk1977     heightOfExprList(p->pEList, pnHeight);
6774b5255acSdanielk1977     heightOfExprList(p->pGroupBy, pnHeight);
6784b5255acSdanielk1977     heightOfExprList(p->pOrderBy, pnHeight);
6794b5255acSdanielk1977   }
6804b5255acSdanielk1977 }
6814b5255acSdanielk1977 
6824b5255acSdanielk1977 /*
6834b5255acSdanielk1977 ** Set the Expr.nHeight variable in the structure passed as an
6844b5255acSdanielk1977 ** argument. An expression with no children, Expr.pList or
6854b5255acSdanielk1977 ** Expr.pSelect member has a height of 1. Any other expression
6864b5255acSdanielk1977 ** has a height equal to the maximum height of any other
6874b5255acSdanielk1977 ** referenced Expr plus one.
6882308ed38Sdrh **
6892308ed38Sdrh ** Also propagate EP_Propagate flags up from Expr.x.pList to Expr.flags,
6902308ed38Sdrh ** if appropriate.
6914b5255acSdanielk1977 */
6924b5255acSdanielk1977 static void exprSetHeight(Expr *p){
6934b5255acSdanielk1977   int nHeight = 0;
6944b5255acSdanielk1977   heightOfExpr(p->pLeft, &nHeight);
6954b5255acSdanielk1977   heightOfExpr(p->pRight, &nHeight);
6966ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_xIsSelect) ){
6976ab3a2ecSdanielk1977     heightOfSelect(p->x.pSelect, &nHeight);
6982308ed38Sdrh   }else if( p->x.pList ){
6996ab3a2ecSdanielk1977     heightOfExprList(p->x.pList, &nHeight);
7002308ed38Sdrh     p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
7016ab3a2ecSdanielk1977   }
7024b5255acSdanielk1977   p->nHeight = nHeight + 1;
7034b5255acSdanielk1977 }
7044b5255acSdanielk1977 
7054b5255acSdanielk1977 /*
7064b5255acSdanielk1977 ** Set the Expr.nHeight variable using the exprSetHeight() function. If
7074b5255acSdanielk1977 ** the height is greater than the maximum allowed expression depth,
7084b5255acSdanielk1977 ** leave an error in pParse.
7092308ed38Sdrh **
7102308ed38Sdrh ** Also propagate all EP_Propagate flags from the Expr.x.pList into
7112308ed38Sdrh ** Expr.flags.
7124b5255acSdanielk1977 */
7132308ed38Sdrh void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
71474893a4cSdrh   if( pParse->nErr ) return;
7154b5255acSdanielk1977   exprSetHeight(p);
7167d10d5a6Sdrh   sqlite3ExprCheckHeight(pParse, p->nHeight);
7174b5255acSdanielk1977 }
7184b5255acSdanielk1977 
7194b5255acSdanielk1977 /*
7204b5255acSdanielk1977 ** Return the maximum height of any expression tree referenced
7214b5255acSdanielk1977 ** by the select statement passed as an argument.
7224b5255acSdanielk1977 */
7234b5255acSdanielk1977 int sqlite3SelectExprHeight(Select *p){
7244b5255acSdanielk1977   int nHeight = 0;
7254b5255acSdanielk1977   heightOfSelect(p, &nHeight);
7264b5255acSdanielk1977   return nHeight;
7274b5255acSdanielk1977 }
7282308ed38Sdrh #else /* ABOVE:  Height enforcement enabled.  BELOW: Height enforcement off */
7292308ed38Sdrh /*
7302308ed38Sdrh ** Propagate all EP_Propagate flags from the Expr.x.pList into
7312308ed38Sdrh ** Expr.flags.
7322308ed38Sdrh */
7332308ed38Sdrh void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
7342308ed38Sdrh   if( p && p->x.pList && !ExprHasProperty(p, EP_xIsSelect) ){
7352308ed38Sdrh     p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
7362308ed38Sdrh   }
7372308ed38Sdrh }
7384b5255acSdanielk1977 #define exprSetHeight(y)
7394b5255acSdanielk1977 #endif /* SQLITE_MAX_EXPR_DEPTH>0 */
7404b5255acSdanielk1977 
741be5c89acSdrh /*
742b7916a78Sdrh ** This routine is the core allocator for Expr nodes.
743b7916a78Sdrh **
744a76b5dfcSdrh ** Construct a new expression node and return a pointer to it.  Memory
745b7916a78Sdrh ** for this node and for the pToken argument is a single allocation
746b7916a78Sdrh ** obtained from sqlite3DbMalloc().  The calling function
747a76b5dfcSdrh ** is responsible for making sure the node eventually gets freed.
748b7916a78Sdrh **
749b7916a78Sdrh ** If dequote is true, then the token (if it exists) is dequoted.
750e792b5b4Sdrh ** If dequote is false, no dequoting is performed.  The deQuote
751b7916a78Sdrh ** parameter is ignored if pToken is NULL or if the token does not
752b7916a78Sdrh ** appear to be quoted.  If the quotes were of the form "..." (double-quotes)
753b7916a78Sdrh ** then the EP_DblQuoted flag is set on the expression node.
75433e619fcSdrh **
75533e619fcSdrh ** Special case:  If op==TK_INTEGER and pToken points to a string that
75633e619fcSdrh ** can be translated into a 32-bit integer, then the token is not
75733e619fcSdrh ** stored in u.zToken.  Instead, the integer values is written
75833e619fcSdrh ** into u.iValue and the EP_IntValue flag is set.  No extra storage
75933e619fcSdrh ** is allocated to hold the integer text and the dequote flag is ignored.
760a76b5dfcSdrh */
761b7916a78Sdrh Expr *sqlite3ExprAlloc(
762cca8a4adSdrh   sqlite3 *db,            /* Handle for sqlite3DbMallocRawNN() */
76317435752Sdrh   int op,                 /* Expression opcode */
764b7916a78Sdrh   const Token *pToken,    /* Token argument.  Might be NULL */
765b7916a78Sdrh   int dequote             /* True to dequote */
76617435752Sdrh ){
767a76b5dfcSdrh   Expr *pNew;
76833e619fcSdrh   int nExtra = 0;
769cf697396Sshane   int iValue = 0;
770b7916a78Sdrh 
771575fad65Sdrh   assert( db!=0 );
772b7916a78Sdrh   if( pToken ){
77333e619fcSdrh     if( op!=TK_INTEGER || pToken->z==0
77433e619fcSdrh           || sqlite3GetInt32(pToken->z, &iValue)==0 ){
775b7916a78Sdrh       nExtra = pToken->n+1;
776d50ffc41Sdrh       assert( iValue>=0 );
77733e619fcSdrh     }
778a76b5dfcSdrh   }
779575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, sizeof(Expr)+nExtra);
780b7916a78Sdrh   if( pNew ){
781ca3862dcSdrh     memset(pNew, 0, sizeof(Expr));
7821bd10f8aSdrh     pNew->op = (u8)op;
783a58fdfb1Sdanielk1977     pNew->iAgg = -1;
784a76b5dfcSdrh     if( pToken ){
78533e619fcSdrh       if( nExtra==0 ){
786b98a2e35Sdrh         pNew->flags |= EP_IntValue|EP_Leaf;
78733e619fcSdrh         pNew->u.iValue = iValue;
78833e619fcSdrh       }else{
78933e619fcSdrh         pNew->u.zToken = (char*)&pNew[1];
790b07028f7Sdrh         assert( pToken->z!=0 || pToken->n==0 );
791b07028f7Sdrh         if( pToken->n ) memcpy(pNew->u.zToken, pToken->z, pToken->n);
79233e619fcSdrh         pNew->u.zToken[pToken->n] = 0;
793244b9d6eSdrh         if( dequote && sqlite3Isquote(pNew->u.zToken[0]) ){
794244b9d6eSdrh           if( pNew->u.zToken[0]=='"' ) pNew->flags |= EP_DblQuoted;
79533e619fcSdrh           sqlite3Dequote(pNew->u.zToken);
796a34001c9Sdrh         }
797a34001c9Sdrh       }
79833e619fcSdrh     }
799b7916a78Sdrh #if SQLITE_MAX_EXPR_DEPTH>0
800b7916a78Sdrh     pNew->nHeight = 1;
801b7916a78Sdrh #endif
802a34001c9Sdrh   }
803a76b5dfcSdrh   return pNew;
804a76b5dfcSdrh }
805a76b5dfcSdrh 
806a76b5dfcSdrh /*
807b7916a78Sdrh ** Allocate a new expression node from a zero-terminated token that has
808b7916a78Sdrh ** already been dequoted.
809b7916a78Sdrh */
810b7916a78Sdrh Expr *sqlite3Expr(
811b7916a78Sdrh   sqlite3 *db,            /* Handle for sqlite3DbMallocZero() (may be null) */
812b7916a78Sdrh   int op,                 /* Expression opcode */
813b7916a78Sdrh   const char *zToken      /* Token argument.  Might be NULL */
814b7916a78Sdrh ){
815b7916a78Sdrh   Token x;
816b7916a78Sdrh   x.z = zToken;
817b40f06c6Sdrh   x.n = sqlite3Strlen30(zToken);
818b7916a78Sdrh   return sqlite3ExprAlloc(db, op, &x, 0);
819b7916a78Sdrh }
820b7916a78Sdrh 
821b7916a78Sdrh /*
822b7916a78Sdrh ** Attach subtrees pLeft and pRight to the Expr node pRoot.
823b7916a78Sdrh **
824b7916a78Sdrh ** If pRoot==NULL that means that a memory allocation error has occurred.
825b7916a78Sdrh ** In that case, delete the subtrees pLeft and pRight.
826b7916a78Sdrh */
827b7916a78Sdrh void sqlite3ExprAttachSubtrees(
828b7916a78Sdrh   sqlite3 *db,
829b7916a78Sdrh   Expr *pRoot,
830b7916a78Sdrh   Expr *pLeft,
831b7916a78Sdrh   Expr *pRight
832b7916a78Sdrh ){
833b7916a78Sdrh   if( pRoot==0 ){
834b7916a78Sdrh     assert( db->mallocFailed );
835b7916a78Sdrh     sqlite3ExprDelete(db, pLeft);
836b7916a78Sdrh     sqlite3ExprDelete(db, pRight);
837b7916a78Sdrh   }else{
838b7916a78Sdrh     if( pRight ){
839b7916a78Sdrh       pRoot->pRight = pRight;
840885a5b03Sdrh       pRoot->flags |= EP_Propagate & pRight->flags;
841b7916a78Sdrh     }
842b7916a78Sdrh     if( pLeft ){
843b7916a78Sdrh       pRoot->pLeft = pLeft;
844885a5b03Sdrh       pRoot->flags |= EP_Propagate & pLeft->flags;
845b7916a78Sdrh     }
846b7916a78Sdrh     exprSetHeight(pRoot);
847b7916a78Sdrh   }
848b7916a78Sdrh }
849b7916a78Sdrh 
850b7916a78Sdrh /*
85160ec914cSpeter.d.reid ** Allocate an Expr node which joins as many as two subtrees.
852b7916a78Sdrh **
853bf664469Sdrh ** One or both of the subtrees can be NULL.  Return a pointer to the new
854bf664469Sdrh ** Expr node.  Or, if an OOM error occurs, set pParse->db->mallocFailed,
855bf664469Sdrh ** free the subtrees and return NULL.
856206f3d96Sdrh */
85717435752Sdrh Expr *sqlite3PExpr(
85817435752Sdrh   Parse *pParse,          /* Parsing context */
85917435752Sdrh   int op,                 /* Expression opcode */
86017435752Sdrh   Expr *pLeft,            /* Left operand */
861abfd35eaSdrh   Expr *pRight            /* Right operand */
86217435752Sdrh ){
8635fb52caaSdrh   Expr *p;
8641167d327Sdrh   if( op==TK_AND && pParse->nErr==0 ){
8655fb52caaSdrh     /* Take advantage of short-circuit false optimization for AND */
8665fb52caaSdrh     p = sqlite3ExprAnd(pParse->db, pLeft, pRight);
8675fb52caaSdrh   }else{
868abfd35eaSdrh     p = sqlite3DbMallocRawNN(pParse->db, sizeof(Expr));
869abfd35eaSdrh     if( p ){
870abfd35eaSdrh       memset(p, 0, sizeof(Expr));
871abfd35eaSdrh       p->op = op & TKFLG_MASK;
872abfd35eaSdrh       p->iAgg = -1;
873abfd35eaSdrh     }
874b7916a78Sdrh     sqlite3ExprAttachSubtrees(pParse->db, p, pLeft, pRight);
8755fb52caaSdrh   }
8762b359bdbSdan   if( p ) {
8772b359bdbSdan     sqlite3ExprCheckHeight(pParse, p->nHeight);
8782b359bdbSdan   }
8794e0cff60Sdrh   return p;
8804e0cff60Sdrh }
8814e0cff60Sdrh 
8824e0cff60Sdrh /*
88308de4f79Sdrh ** Add pSelect to the Expr.x.pSelect field.  Or, if pExpr is NULL (due
88408de4f79Sdrh ** do a memory allocation failure) then delete the pSelect object.
88508de4f79Sdrh */
88608de4f79Sdrh void sqlite3PExprAddSelect(Parse *pParse, Expr *pExpr, Select *pSelect){
88708de4f79Sdrh   if( pExpr ){
88808de4f79Sdrh     pExpr->x.pSelect = pSelect;
88908de4f79Sdrh     ExprSetProperty(pExpr, EP_xIsSelect|EP_Subquery);
89008de4f79Sdrh     sqlite3ExprSetHeightAndFlags(pParse, pExpr);
89108de4f79Sdrh   }else{
89208de4f79Sdrh     assert( pParse->db->mallocFailed );
89308de4f79Sdrh     sqlite3SelectDelete(pParse->db, pSelect);
89408de4f79Sdrh   }
89508de4f79Sdrh }
89608de4f79Sdrh 
89708de4f79Sdrh 
89808de4f79Sdrh /*
899991a1985Sdrh ** If the expression is always either TRUE or FALSE (respectively),
900991a1985Sdrh ** then return 1.  If one cannot determine the truth value of the
901991a1985Sdrh ** expression at compile-time return 0.
902991a1985Sdrh **
903991a1985Sdrh ** This is an optimization.  If is OK to return 0 here even if
904991a1985Sdrh ** the expression really is always false or false (a false negative).
905991a1985Sdrh ** But it is a bug to return 1 if the expression might have different
906991a1985Sdrh ** boolean values in different circumstances (a false positive.)
9075fb52caaSdrh **
9085fb52caaSdrh ** Note that if the expression is part of conditional for a
9095fb52caaSdrh ** LEFT JOIN, then we cannot determine at compile-time whether or not
9105fb52caaSdrh ** is it true or false, so always return 0.
9115fb52caaSdrh */
912991a1985Sdrh static int exprAlwaysTrue(Expr *p){
913991a1985Sdrh   int v = 0;
914991a1985Sdrh   if( ExprHasProperty(p, EP_FromJoin) ) return 0;
915991a1985Sdrh   if( !sqlite3ExprIsInteger(p, &v) ) return 0;
916991a1985Sdrh   return v!=0;
917991a1985Sdrh }
9185fb52caaSdrh static int exprAlwaysFalse(Expr *p){
9195fb52caaSdrh   int v = 0;
9205fb52caaSdrh   if( ExprHasProperty(p, EP_FromJoin) ) return 0;
9215fb52caaSdrh   if( !sqlite3ExprIsInteger(p, &v) ) return 0;
9225fb52caaSdrh   return v==0;
9235fb52caaSdrh }
9245fb52caaSdrh 
9255fb52caaSdrh /*
92691bb0eedSdrh ** Join two expressions using an AND operator.  If either expression is
92791bb0eedSdrh ** NULL, then just return the other expression.
9285fb52caaSdrh **
9295fb52caaSdrh ** If one side or the other of the AND is known to be false, then instead
9305fb52caaSdrh ** of returning an AND expression, just return a constant expression with
9315fb52caaSdrh ** a value of false.
93291bb0eedSdrh */
9331e536953Sdanielk1977 Expr *sqlite3ExprAnd(sqlite3 *db, Expr *pLeft, Expr *pRight){
93491bb0eedSdrh   if( pLeft==0 ){
93591bb0eedSdrh     return pRight;
93691bb0eedSdrh   }else if( pRight==0 ){
93791bb0eedSdrh     return pLeft;
9385fb52caaSdrh   }else if( exprAlwaysFalse(pLeft) || exprAlwaysFalse(pRight) ){
9395fb52caaSdrh     sqlite3ExprDelete(db, pLeft);
9405fb52caaSdrh     sqlite3ExprDelete(db, pRight);
9415fb52caaSdrh     return sqlite3ExprAlloc(db, TK_INTEGER, &sqlite3IntTokens[0], 0);
94291bb0eedSdrh   }else{
943b7916a78Sdrh     Expr *pNew = sqlite3ExprAlloc(db, TK_AND, 0, 0);
944b7916a78Sdrh     sqlite3ExprAttachSubtrees(db, pNew, pLeft, pRight);
945b7916a78Sdrh     return pNew;
946a76b5dfcSdrh   }
947a76b5dfcSdrh }
948a76b5dfcSdrh 
949a76b5dfcSdrh /*
950a76b5dfcSdrh ** Construct a new expression node for a function with multiple
951a76b5dfcSdrh ** arguments.
952a76b5dfcSdrh */
95317435752Sdrh Expr *sqlite3ExprFunction(Parse *pParse, ExprList *pList, Token *pToken){
954a76b5dfcSdrh   Expr *pNew;
955633e6d57Sdrh   sqlite3 *db = pParse->db;
9564b202ae2Sdanielk1977   assert( pToken );
957b7916a78Sdrh   pNew = sqlite3ExprAlloc(db, TK_FUNCTION, pToken, 1);
958a76b5dfcSdrh   if( pNew==0 ){
959d9da78a2Sdrh     sqlite3ExprListDelete(db, pList); /* Avoid memory leak when malloc fails */
960a76b5dfcSdrh     return 0;
961a76b5dfcSdrh   }
9626ab3a2ecSdanielk1977   pNew->x.pList = pList;
963fca23557Sdrh   ExprSetProperty(pNew, EP_HasFunc);
9646ab3a2ecSdanielk1977   assert( !ExprHasProperty(pNew, EP_xIsSelect) );
9652308ed38Sdrh   sqlite3ExprSetHeightAndFlags(pParse, pNew);
966a76b5dfcSdrh   return pNew;
967a76b5dfcSdrh }
968a76b5dfcSdrh 
969a76b5dfcSdrh /*
970fa6bc000Sdrh ** Assign a variable number to an expression that encodes a wildcard
971fa6bc000Sdrh ** in the original SQL statement.
972fa6bc000Sdrh **
973fa6bc000Sdrh ** Wildcards consisting of a single "?" are assigned the next sequential
974fa6bc000Sdrh ** variable number.
975fa6bc000Sdrh **
976fa6bc000Sdrh ** Wildcards of the form "?nnn" are assigned the number "nnn".  We make
9779bf755ccSdrh ** sure "nnn" is not too big to avoid a denial of service attack when
978fa6bc000Sdrh ** the SQL statement comes from an external source.
979fa6bc000Sdrh **
98051f49f17Sdrh ** Wildcards of the form ":aaa", "@aaa", or "$aaa" are assigned the same number
981fa6bc000Sdrh ** as the previous instance of the same wildcard.  Or if this is the first
98260ec914cSpeter.d.reid ** instance of the wildcard, the next sequential variable number is
983fa6bc000Sdrh ** assigned.
984fa6bc000Sdrh */
985de25a88cSdrh void sqlite3ExprAssignVarNumber(Parse *pParse, Expr *pExpr, u32 n){
98617435752Sdrh   sqlite3 *db = pParse->db;
987b7916a78Sdrh   const char *z;
988f326d66dSdrh   ynVar x;
98917435752Sdrh 
990fa6bc000Sdrh   if( pExpr==0 ) return;
991c5cd1249Sdrh   assert( !ExprHasProperty(pExpr, EP_IntValue|EP_Reduced|EP_TokenOnly) );
99233e619fcSdrh   z = pExpr->u.zToken;
993b7916a78Sdrh   assert( z!=0 );
994b7916a78Sdrh   assert( z[0]!=0 );
995b1ed717fSmistachkin   assert( n==(u32)sqlite3Strlen30(z) );
996b7916a78Sdrh   if( z[1]==0 ){
997fa6bc000Sdrh     /* Wildcard of the form "?".  Assign the next variable number */
998b7916a78Sdrh     assert( z[0]=='?' );
999f326d66dSdrh     x = (ynVar)(++pParse->nVar);
1000124c0b49Sdrh   }else{
1001f326d66dSdrh     int doAdd = 0;
1002124c0b49Sdrh     if( z[0]=='?' ){
1003fa6bc000Sdrh       /* Wildcard of the form "?nnn".  Convert "nnn" to an integer and
1004fa6bc000Sdrh       ** use it as the variable number */
1005c8d735aeSdan       i64 i;
100618814dfbSdrh       int bOk;
100718814dfbSdrh       if( n==2 ){ /*OPTIMIZATION-IF-TRUE*/
100818814dfbSdrh         i = z[1]-'0';  /* The common case of ?N for a single digit N */
100918814dfbSdrh         bOk = 1;
101018814dfbSdrh       }else{
101118814dfbSdrh         bOk = 0==sqlite3Atoi64(&z[1], &i, n-1, SQLITE_UTF8);
101218814dfbSdrh       }
1013c5499befSdrh       testcase( i==0 );
1014c5499befSdrh       testcase( i==1 );
1015c5499befSdrh       testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]-1 );
1016c5499befSdrh       testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] );
1017c8d735aeSdan       if( bOk==0 || i<1 || i>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
1018fa6bc000Sdrh         sqlite3ErrorMsg(pParse, "variable number must be between ?1 and ?%d",
1019bb4957f8Sdrh             db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]);
1020c9b39288Sdrh         return;
1021fa6bc000Sdrh       }
10228e74e7baSdrh       x = (ynVar)i;
1023f326d66dSdrh       if( x>pParse->nVar ){
1024f326d66dSdrh         pParse->nVar = (int)x;
1025f326d66dSdrh         doAdd = 1;
1026f326d66dSdrh       }else if( sqlite3VListNumToName(pParse->pVList, x)==0 ){
1027f326d66dSdrh         doAdd = 1;
1028fa6bc000Sdrh       }
1029fa6bc000Sdrh     }else{
103051f49f17Sdrh       /* Wildcards like ":aaa", "$aaa" or "@aaa".  Reuse the same variable
1031fa6bc000Sdrh       ** number as the prior appearance of the same name, or if the name
1032fa6bc000Sdrh       ** has never appeared before, reuse the same variable number
1033fa6bc000Sdrh       */
10349bf755ccSdrh       x = (ynVar)sqlite3VListNameToNum(pParse->pVList, z, n);
10359bf755ccSdrh       if( x==0 ){
10369bf755ccSdrh         x = (ynVar)(++pParse->nVar);
1037f326d66dSdrh         doAdd = 1;
1038f326d66dSdrh       }
1039f326d66dSdrh     }
1040f326d66dSdrh     if( doAdd ){
10419bf755ccSdrh       pParse->pVList = sqlite3VListAdd(db, pParse->pVList, z, n, x);
1042fa6bc000Sdrh     }
1043fa6bc000Sdrh   }
1044c9b39288Sdrh   pExpr->iColumn = x;
1045f326d66dSdrh   if( x>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
1046832b2664Sdanielk1977     sqlite3ErrorMsg(pParse, "too many SQL variables");
1047832b2664Sdanielk1977   }
1048fa6bc000Sdrh }
1049fa6bc000Sdrh 
1050fa6bc000Sdrh /*
1051f6963f99Sdan ** Recursively delete an expression tree.
1052a2e00042Sdrh */
10534f0010b1Sdrh static SQLITE_NOINLINE void sqlite3ExprDeleteNN(sqlite3 *db, Expr *p){
10544f0010b1Sdrh   assert( p!=0 );
1055d50ffc41Sdrh   /* Sanity check: Assert that the IntValue is non-negative if it exists */
1056d50ffc41Sdrh   assert( !ExprHasProperty(p, EP_IntValue) || p->u.iValue>=0 );
1057209bc522Sdrh #ifdef SQLITE_DEBUG
1058209bc522Sdrh   if( ExprHasProperty(p, EP_Leaf) && !ExprHasProperty(p, EP_TokenOnly) ){
1059209bc522Sdrh     assert( p->pLeft==0 );
1060209bc522Sdrh     assert( p->pRight==0 );
1061209bc522Sdrh     assert( p->x.pSelect==0 );
1062209bc522Sdrh   }
1063209bc522Sdrh #endif
1064209bc522Sdrh   if( !ExprHasProperty(p, (EP_TokenOnly|EP_Leaf)) ){
1065c5cd1249Sdrh     /* The Expr.x union is never used at the same time as Expr.pRight */
1066c5cd1249Sdrh     assert( p->x.pList==0 || p->pRight==0 );
10674910a76dSdrh     if( p->pLeft && p->op!=TK_SELECT_COLUMN ) sqlite3ExprDeleteNN(db, p->pLeft);
1068d1086679Sdrh     if( p->pRight ){
1069d1086679Sdrh       sqlite3ExprDeleteNN(db, p->pRight);
1070d1086679Sdrh     }else if( ExprHasProperty(p, EP_xIsSelect) ){
10716ab3a2ecSdanielk1977       sqlite3SelectDelete(db, p->x.pSelect);
10726ab3a2ecSdanielk1977     }else{
10736ab3a2ecSdanielk1977       sqlite3ExprListDelete(db, p->x.pList);
10746ab3a2ecSdanielk1977     }
107586fb6e17Sdan     if( !ExprHasProperty(p, EP_Reduced) ){
107686fb6e17Sdan       sqlite3WindowDelete(db, p->pWin);
107786fb6e17Sdan     }
10786ab3a2ecSdanielk1977   }
1079209bc522Sdrh   if( ExprHasProperty(p, EP_MemToken) ) sqlite3DbFree(db, p->u.zToken);
108033e619fcSdrh   if( !ExprHasProperty(p, EP_Static) ){
1081dbd6a7dcSdrh     sqlite3DbFreeNN(db, p);
1082a2e00042Sdrh   }
108333e619fcSdrh }
10844f0010b1Sdrh void sqlite3ExprDelete(sqlite3 *db, Expr *p){
10854f0010b1Sdrh   if( p ) sqlite3ExprDeleteNN(db, p);
10864f0010b1Sdrh }
1087a2e00042Sdrh 
1088d2687b77Sdrh /*
10896ab3a2ecSdanielk1977 ** Return the number of bytes allocated for the expression structure
10906ab3a2ecSdanielk1977 ** passed as the first argument. This is always one of EXPR_FULLSIZE,
10916ab3a2ecSdanielk1977 ** EXPR_REDUCEDSIZE or EXPR_TOKENONLYSIZE.
10926ab3a2ecSdanielk1977 */
10936ab3a2ecSdanielk1977 static int exprStructSize(Expr *p){
10946ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_TokenOnly) ) return EXPR_TOKENONLYSIZE;
10956ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_Reduced) ) return EXPR_REDUCEDSIZE;
10966ab3a2ecSdanielk1977   return EXPR_FULLSIZE;
10976ab3a2ecSdanielk1977 }
10986ab3a2ecSdanielk1977 
10996ab3a2ecSdanielk1977 /*
110033e619fcSdrh ** The dupedExpr*Size() routines each return the number of bytes required
110133e619fcSdrh ** to store a copy of an expression or expression tree.  They differ in
110233e619fcSdrh ** how much of the tree is measured.
110333e619fcSdrh **
110433e619fcSdrh **     dupedExprStructSize()     Size of only the Expr structure
110533e619fcSdrh **     dupedExprNodeSize()       Size of Expr + space for token
110633e619fcSdrh **     dupedExprSize()           Expr + token + subtree components
110733e619fcSdrh **
110833e619fcSdrh ***************************************************************************
110933e619fcSdrh **
111033e619fcSdrh ** The dupedExprStructSize() function returns two values OR-ed together:
111133e619fcSdrh ** (1) the space required for a copy of the Expr structure only and
111233e619fcSdrh ** (2) the EP_xxx flags that indicate what the structure size should be.
111333e619fcSdrh ** The return values is always one of:
111433e619fcSdrh **
111533e619fcSdrh **      EXPR_FULLSIZE
111633e619fcSdrh **      EXPR_REDUCEDSIZE   | EP_Reduced
111733e619fcSdrh **      EXPR_TOKENONLYSIZE | EP_TokenOnly
111833e619fcSdrh **
111933e619fcSdrh ** The size of the structure can be found by masking the return value
112033e619fcSdrh ** of this routine with 0xfff.  The flags can be found by masking the
112133e619fcSdrh ** return value with EP_Reduced|EP_TokenOnly.
112233e619fcSdrh **
112333e619fcSdrh ** Note that with flags==EXPRDUP_REDUCE, this routines works on full-size
112433e619fcSdrh ** (unreduced) Expr objects as they or originally constructed by the parser.
112533e619fcSdrh ** During expression analysis, extra information is computed and moved into
1126c95f38d4Sdan ** later parts of the Expr object and that extra information might get chopped
112733e619fcSdrh ** off if the expression is reduced.  Note also that it does not work to
112860ec914cSpeter.d.reid ** make an EXPRDUP_REDUCE copy of a reduced expression.  It is only legal
112933e619fcSdrh ** to reduce a pristine expression tree from the parser.  The implementation
113033e619fcSdrh ** of dupedExprStructSize() contain multiple assert() statements that attempt
113133e619fcSdrh ** to enforce this constraint.
11326ab3a2ecSdanielk1977 */
11336ab3a2ecSdanielk1977 static int dupedExprStructSize(Expr *p, int flags){
11346ab3a2ecSdanielk1977   int nSize;
113533e619fcSdrh   assert( flags==EXPRDUP_REDUCE || flags==0 ); /* Only one flag value allowed */
1136aecd8021Sdrh   assert( EXPR_FULLSIZE<=0xfff );
1137aecd8021Sdrh   assert( (0xfff & (EP_Reduced|EP_TokenOnly))==0 );
113867a9b8edSdan   if( 0==flags || p->op==TK_SELECT_COLUMN
113967a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
114067a9b8edSdan    || p->pWin
114167a9b8edSdan #endif
114267a9b8edSdan   ){
11436ab3a2ecSdanielk1977     nSize = EXPR_FULLSIZE;
11446ab3a2ecSdanielk1977   }else{
1145c5cd1249Sdrh     assert( !ExprHasProperty(p, EP_TokenOnly|EP_Reduced) );
114633e619fcSdrh     assert( !ExprHasProperty(p, EP_FromJoin) );
1147c5cd1249Sdrh     assert( !ExprHasProperty(p, EP_MemToken) );
1148ebb6a65dSdrh     assert( !ExprHasProperty(p, EP_NoReduce) );
1149aecd8021Sdrh     if( p->pLeft || p->x.pList ){
115033e619fcSdrh       nSize = EXPR_REDUCEDSIZE | EP_Reduced;
115133e619fcSdrh     }else{
1152aecd8021Sdrh       assert( p->pRight==0 );
115333e619fcSdrh       nSize = EXPR_TOKENONLYSIZE | EP_TokenOnly;
115433e619fcSdrh     }
11556ab3a2ecSdanielk1977   }
11566ab3a2ecSdanielk1977   return nSize;
11576ab3a2ecSdanielk1977 }
11586ab3a2ecSdanielk1977 
11596ab3a2ecSdanielk1977 /*
116033e619fcSdrh ** This function returns the space in bytes required to store the copy
116133e619fcSdrh ** of the Expr structure and a copy of the Expr.u.zToken string (if that
116233e619fcSdrh ** string is defined.)
11636ab3a2ecSdanielk1977 */
11646ab3a2ecSdanielk1977 static int dupedExprNodeSize(Expr *p, int flags){
116533e619fcSdrh   int nByte = dupedExprStructSize(p, flags) & 0xfff;
116633e619fcSdrh   if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
116733e619fcSdrh     nByte += sqlite3Strlen30(p->u.zToken)+1;
11686ab3a2ecSdanielk1977   }
1169bc73971dSdanielk1977   return ROUND8(nByte);
11706ab3a2ecSdanielk1977 }
11716ab3a2ecSdanielk1977 
11726ab3a2ecSdanielk1977 /*
11736ab3a2ecSdanielk1977 ** Return the number of bytes required to create a duplicate of the
11746ab3a2ecSdanielk1977 ** expression passed as the first argument. The second argument is a
11756ab3a2ecSdanielk1977 ** mask containing EXPRDUP_XXX flags.
11766ab3a2ecSdanielk1977 **
11776ab3a2ecSdanielk1977 ** The value returned includes space to create a copy of the Expr struct
117833e619fcSdrh ** itself and the buffer referred to by Expr.u.zToken, if any.
11796ab3a2ecSdanielk1977 **
11806ab3a2ecSdanielk1977 ** If the EXPRDUP_REDUCE flag is set, then the return value includes
11816ab3a2ecSdanielk1977 ** space to duplicate all Expr nodes in the tree formed by Expr.pLeft
11826ab3a2ecSdanielk1977 ** and Expr.pRight variables (but not for any structures pointed to or
11836ab3a2ecSdanielk1977 ** descended from the Expr.x.pList or Expr.x.pSelect variables).
11846ab3a2ecSdanielk1977 */
11856ab3a2ecSdanielk1977 static int dupedExprSize(Expr *p, int flags){
11866ab3a2ecSdanielk1977   int nByte = 0;
11876ab3a2ecSdanielk1977   if( p ){
11886ab3a2ecSdanielk1977     nByte = dupedExprNodeSize(p, flags);
11896ab3a2ecSdanielk1977     if( flags&EXPRDUP_REDUCE ){
1190b7916a78Sdrh       nByte += dupedExprSize(p->pLeft, flags) + dupedExprSize(p->pRight, flags);
11916ab3a2ecSdanielk1977     }
11926ab3a2ecSdanielk1977   }
11936ab3a2ecSdanielk1977   return nByte;
11946ab3a2ecSdanielk1977 }
11956ab3a2ecSdanielk1977 
11966ab3a2ecSdanielk1977 /*
11976ab3a2ecSdanielk1977 ** This function is similar to sqlite3ExprDup(), except that if pzBuffer
11986ab3a2ecSdanielk1977 ** is not NULL then *pzBuffer is assumed to point to a buffer large enough
119933e619fcSdrh ** to store the copy of expression p, the copies of p->u.zToken
12006ab3a2ecSdanielk1977 ** (if applicable), and the copies of the p->pLeft and p->pRight expressions,
120160ec914cSpeter.d.reid ** if any. Before returning, *pzBuffer is set to the first byte past the
12026ab3a2ecSdanielk1977 ** portion of the buffer copied into by this function.
12036ab3a2ecSdanielk1977 */
12043c19469cSdrh static Expr *exprDup(sqlite3 *db, Expr *p, int dupFlags, u8 **pzBuffer){
12053c19469cSdrh   Expr *pNew;           /* Value to return */
12063c19469cSdrh   u8 *zAlloc;           /* Memory space from which to build Expr object */
12073c19469cSdrh   u32 staticFlag;       /* EP_Static if space not obtained from malloc */
12086ab3a2ecSdanielk1977 
12093c19469cSdrh   assert( db!=0 );
12103c19469cSdrh   assert( p );
12113c19469cSdrh   assert( dupFlags==0 || dupFlags==EXPRDUP_REDUCE );
12123c19469cSdrh   assert( pzBuffer==0 || dupFlags==EXPRDUP_REDUCE );
12136ab3a2ecSdanielk1977 
12146ab3a2ecSdanielk1977   /* Figure out where to write the new Expr structure. */
12156ab3a2ecSdanielk1977   if( pzBuffer ){
12166ab3a2ecSdanielk1977     zAlloc = *pzBuffer;
121733e619fcSdrh     staticFlag = EP_Static;
12186ab3a2ecSdanielk1977   }else{
12193c19469cSdrh     zAlloc = sqlite3DbMallocRawNN(db, dupedExprSize(p, dupFlags));
12203c19469cSdrh     staticFlag = 0;
12216ab3a2ecSdanielk1977   }
12226ab3a2ecSdanielk1977   pNew = (Expr *)zAlloc;
12236ab3a2ecSdanielk1977 
12246ab3a2ecSdanielk1977   if( pNew ){
12256ab3a2ecSdanielk1977     /* Set nNewSize to the size allocated for the structure pointed to
12266ab3a2ecSdanielk1977     ** by pNew. This is either EXPR_FULLSIZE, EXPR_REDUCEDSIZE or
12276ab3a2ecSdanielk1977     ** EXPR_TOKENONLYSIZE. nToken is set to the number of bytes consumed
122833e619fcSdrh     ** by the copy of the p->u.zToken string (if any).
12296ab3a2ecSdanielk1977     */
12303c19469cSdrh     const unsigned nStructSize = dupedExprStructSize(p, dupFlags);
123133e619fcSdrh     const int nNewSize = nStructSize & 0xfff;
123233e619fcSdrh     int nToken;
123333e619fcSdrh     if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
123433e619fcSdrh       nToken = sqlite3Strlen30(p->u.zToken) + 1;
123533e619fcSdrh     }else{
123633e619fcSdrh       nToken = 0;
123733e619fcSdrh     }
12383c19469cSdrh     if( dupFlags ){
12396ab3a2ecSdanielk1977       assert( ExprHasProperty(p, EP_Reduced)==0 );
12406ab3a2ecSdanielk1977       memcpy(zAlloc, p, nNewSize);
12416ab3a2ecSdanielk1977     }else{
12423e6a1411Sdan       u32 nSize = (u32)exprStructSize(p);
12436ab3a2ecSdanielk1977       memcpy(zAlloc, p, nSize);
124472ea29d7Sdrh       if( nSize<EXPR_FULLSIZE ){
12456ab3a2ecSdanielk1977         memset(&zAlloc[nSize], 0, EXPR_FULLSIZE-nSize);
12466ab3a2ecSdanielk1977       }
124772ea29d7Sdrh     }
12486ab3a2ecSdanielk1977 
124933e619fcSdrh     /* Set the EP_Reduced, EP_TokenOnly, and EP_Static flags appropriately. */
1250c5cd1249Sdrh     pNew->flags &= ~(EP_Reduced|EP_TokenOnly|EP_Static|EP_MemToken);
125133e619fcSdrh     pNew->flags |= nStructSize & (EP_Reduced|EP_TokenOnly);
125233e619fcSdrh     pNew->flags |= staticFlag;
12536ab3a2ecSdanielk1977 
125433e619fcSdrh     /* Copy the p->u.zToken string, if any. */
12556ab3a2ecSdanielk1977     if( nToken ){
125633e619fcSdrh       char *zToken = pNew->u.zToken = (char*)&zAlloc[nNewSize];
125733e619fcSdrh       memcpy(zToken, p->u.zToken, nToken);
12586ab3a2ecSdanielk1977     }
12596ab3a2ecSdanielk1977 
1260209bc522Sdrh     if( 0==((p->flags|pNew->flags) & (EP_TokenOnly|EP_Leaf)) ){
12616ab3a2ecSdanielk1977       /* Fill in the pNew->x.pSelect or pNew->x.pList member. */
12626ab3a2ecSdanielk1977       if( ExprHasProperty(p, EP_xIsSelect) ){
12633c19469cSdrh         pNew->x.pSelect = sqlite3SelectDup(db, p->x.pSelect, dupFlags);
12646ab3a2ecSdanielk1977       }else{
12653c19469cSdrh         pNew->x.pList = sqlite3ExprListDup(db, p->x.pList, dupFlags);
12666ab3a2ecSdanielk1977       }
12676ab3a2ecSdanielk1977     }
12686ab3a2ecSdanielk1977 
12696ab3a2ecSdanielk1977     /* Fill in pNew->pLeft and pNew->pRight. */
1270c5cd1249Sdrh     if( ExprHasProperty(pNew, EP_Reduced|EP_TokenOnly) ){
12713c19469cSdrh       zAlloc += dupedExprNodeSize(p, dupFlags);
1272209bc522Sdrh       if( !ExprHasProperty(pNew, EP_TokenOnly|EP_Leaf) ){
12733c19469cSdrh         pNew->pLeft = p->pLeft ?
12743c19469cSdrh                       exprDup(db, p->pLeft, EXPRDUP_REDUCE, &zAlloc) : 0;
12753c19469cSdrh         pNew->pRight = p->pRight ?
12763c19469cSdrh                        exprDup(db, p->pRight, EXPRDUP_REDUCE, &zAlloc) : 0;
12776ab3a2ecSdanielk1977       }
12786ab3a2ecSdanielk1977       if( pzBuffer ){
12796ab3a2ecSdanielk1977         *pzBuffer = zAlloc;
12806ab3a2ecSdanielk1977       }
1281b7916a78Sdrh     }else{
128267a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
1283e2f781b9Sdan       if( ExprHasProperty(p, EP_Reduced|EP_TokenOnly) ){
1284e2f781b9Sdan         pNew->pWin = 0;
1285e2f781b9Sdan       }else{
12862a11bb23Sdan         pNew->pWin = sqlite3WindowDup(db, pNew, p->pWin);
1287e2f781b9Sdan       }
128867a9b8edSdan #endif /* SQLITE_OMIT_WINDOWFUNC */
1289209bc522Sdrh       if( !ExprHasProperty(p, EP_TokenOnly|EP_Leaf) ){
12909854260bSdrh         if( pNew->op==TK_SELECT_COLUMN ){
12919854260bSdrh           pNew->pLeft = p->pLeft;
129247073f62Sdrh           assert( p->iColumn==0 || p->pRight==0 );
129347073f62Sdrh           assert( p->pRight==0  || p->pRight==p->pLeft );
12949854260bSdrh         }else{
12956ab3a2ecSdanielk1977           pNew->pLeft = sqlite3ExprDup(db, p->pLeft, 0);
12969854260bSdrh         }
12976ab3a2ecSdanielk1977         pNew->pRight = sqlite3ExprDup(db, p->pRight, 0);
12986ab3a2ecSdanielk1977       }
12996ab3a2ecSdanielk1977     }
13006ab3a2ecSdanielk1977   }
13016ab3a2ecSdanielk1977   return pNew;
13026ab3a2ecSdanielk1977 }
13036ab3a2ecSdanielk1977 
13046ab3a2ecSdanielk1977 /*
1305bfe31e7fSdan ** Create and return a deep copy of the object passed as the second
1306bfe31e7fSdan ** argument. If an OOM condition is encountered, NULL is returned
1307bfe31e7fSdan ** and the db->mallocFailed flag set.
1308bfe31e7fSdan */
1309eede6a53Sdan #ifndef SQLITE_OMIT_CTE
1310bfe31e7fSdan static With *withDup(sqlite3 *db, With *p){
13114e9119d9Sdan   With *pRet = 0;
13124e9119d9Sdan   if( p ){
13134e9119d9Sdan     int nByte = sizeof(*p) + sizeof(p->a[0]) * (p->nCte-1);
13144e9119d9Sdan     pRet = sqlite3DbMallocZero(db, nByte);
13154e9119d9Sdan     if( pRet ){
13164e9119d9Sdan       int i;
13174e9119d9Sdan       pRet->nCte = p->nCte;
13184e9119d9Sdan       for(i=0; i<p->nCte; i++){
13194e9119d9Sdan         pRet->a[i].pSelect = sqlite3SelectDup(db, p->a[i].pSelect, 0);
13204e9119d9Sdan         pRet->a[i].pCols = sqlite3ExprListDup(db, p->a[i].pCols, 0);
13214e9119d9Sdan         pRet->a[i].zName = sqlite3DbStrDup(db, p->a[i].zName);
13224e9119d9Sdan       }
13234e9119d9Sdan     }
13244e9119d9Sdan   }
13254e9119d9Sdan   return pRet;
13264e9119d9Sdan }
1327eede6a53Sdan #else
1328eede6a53Sdan # define withDup(x,y) 0
1329eede6a53Sdan #endif
13304e9119d9Sdan 
1331a76b5dfcSdrh /*
1332ff78bd2fSdrh ** The following group of routines make deep copies of expressions,
1333ff78bd2fSdrh ** expression lists, ID lists, and select statements.  The copies can
1334ff78bd2fSdrh ** be deleted (by being passed to their respective ...Delete() routines)
1335ff78bd2fSdrh ** without effecting the originals.
1336ff78bd2fSdrh **
13374adee20fSdanielk1977 ** The expression list, ID, and source lists return by sqlite3ExprListDup(),
13384adee20fSdanielk1977 ** sqlite3IdListDup(), and sqlite3SrcListDup() can not be further expanded
1339ad3cab52Sdrh ** by subsequent calls to sqlite*ListAppend() routines.
1340ff78bd2fSdrh **
1341ad3cab52Sdrh ** Any tables that the SrcList might point to are not duplicated.
13426ab3a2ecSdanielk1977 **
1343b7916a78Sdrh ** The flags parameter contains a combination of the EXPRDUP_XXX flags.
13446ab3a2ecSdanielk1977 ** If the EXPRDUP_REDUCE flag is set, then the structure returned is a
13456ab3a2ecSdanielk1977 ** truncated version of the usual Expr structure that will be stored as
13466ab3a2ecSdanielk1977 ** part of the in-memory representation of the database schema.
1347ff78bd2fSdrh */
13486ab3a2ecSdanielk1977 Expr *sqlite3ExprDup(sqlite3 *db, Expr *p, int flags){
134972ea29d7Sdrh   assert( flags==0 || flags==EXPRDUP_REDUCE );
13503c19469cSdrh   return p ? exprDup(db, p, flags, 0) : 0;
1351ff78bd2fSdrh }
13526ab3a2ecSdanielk1977 ExprList *sqlite3ExprListDup(sqlite3 *db, ExprList *p, int flags){
1353ff78bd2fSdrh   ExprList *pNew;
1354145716b3Sdrh   struct ExprList_item *pItem, *pOldItem;
1355ff78bd2fSdrh   int i;
1356b163748eSdrh   Expr *pPriorSelectCol = 0;
1357575fad65Sdrh   assert( db!=0 );
1358ff78bd2fSdrh   if( p==0 ) return 0;
135997258194Sdrh   pNew = sqlite3DbMallocRawNN(db, sqlite3DbMallocSize(db, p));
1360ff78bd2fSdrh   if( pNew==0 ) return 0;
1361a19543feSdrh   pNew->nExpr = p->nExpr;
136243606175Sdrh   pItem = pNew->a;
1363145716b3Sdrh   pOldItem = p->a;
1364145716b3Sdrh   for(i=0; i<p->nExpr; i++, pItem++, pOldItem++){
13656ab3a2ecSdanielk1977     Expr *pOldExpr = pOldItem->pExpr;
136647073f62Sdrh     Expr *pNewExpr;
1367b5526ea6Sdrh     pItem->pExpr = sqlite3ExprDup(db, pOldExpr, flags);
136847073f62Sdrh     if( pOldExpr
136947073f62Sdrh      && pOldExpr->op==TK_SELECT_COLUMN
137047073f62Sdrh      && (pNewExpr = pItem->pExpr)!=0
137147073f62Sdrh     ){
137247073f62Sdrh       assert( pNewExpr->iColumn==0 || i>0 );
137347073f62Sdrh       if( pNewExpr->iColumn==0 ){
137447073f62Sdrh         assert( pOldExpr->pLeft==pOldExpr->pRight );
1375b163748eSdrh         pPriorSelectCol = pNewExpr->pLeft = pNewExpr->pRight;
1376b163748eSdrh       }else{
1377b163748eSdrh         assert( i>0 );
1378b163748eSdrh         assert( pItem[-1].pExpr!=0 );
1379b163748eSdrh         assert( pNewExpr->iColumn==pItem[-1].pExpr->iColumn+1 );
1380b163748eSdrh         assert( pPriorSelectCol==pItem[-1].pExpr->pLeft );
1381b163748eSdrh         pNewExpr->pLeft = pPriorSelectCol;
138247073f62Sdrh       }
138347073f62Sdrh     }
138417435752Sdrh     pItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
1385b7916a78Sdrh     pItem->zSpan = sqlite3DbStrDup(db, pOldItem->zSpan);
1386145716b3Sdrh     pItem->sortOrder = pOldItem->sortOrder;
13873e7bc9caSdrh     pItem->done = 0;
13882c036cffSdrh     pItem->bSpanIsTab = pOldItem->bSpanIsTab;
138924e25d32Sdan     pItem->bSorterRef = pOldItem->bSorterRef;
1390c2acc4e4Sdrh     pItem->u = pOldItem->u;
1391ff78bd2fSdrh   }
1392ff78bd2fSdrh   return pNew;
1393ff78bd2fSdrh }
139493758c8dSdanielk1977 
139593758c8dSdanielk1977 /*
139693758c8dSdanielk1977 ** If cursors, triggers, views and subqueries are all omitted from
139793758c8dSdanielk1977 ** the build, then none of the following routines, except for
139893758c8dSdanielk1977 ** sqlite3SelectDup(), can be called. sqlite3SelectDup() is sometimes
139993758c8dSdanielk1977 ** called with a NULL argument.
140093758c8dSdanielk1977 */
14016a67fe8eSdanielk1977 #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_TRIGGER) \
14026a67fe8eSdanielk1977  || !defined(SQLITE_OMIT_SUBQUERY)
14036ab3a2ecSdanielk1977 SrcList *sqlite3SrcListDup(sqlite3 *db, SrcList *p, int flags){
1404ad3cab52Sdrh   SrcList *pNew;
1405ad3cab52Sdrh   int i;
1406113088ecSdrh   int nByte;
1407575fad65Sdrh   assert( db!=0 );
1408ad3cab52Sdrh   if( p==0 ) return 0;
1409113088ecSdrh   nByte = sizeof(*p) + (p->nSrc>0 ? sizeof(p->a[0]) * (p->nSrc-1) : 0);
1410575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, nByte );
1411ad3cab52Sdrh   if( pNew==0 ) return 0;
14124305d103Sdrh   pNew->nSrc = pNew->nAlloc = p->nSrc;
1413ad3cab52Sdrh   for(i=0; i<p->nSrc; i++){
14144efc4754Sdrh     struct SrcList_item *pNewItem = &pNew->a[i];
14154efc4754Sdrh     struct SrcList_item *pOldItem = &p->a[i];
1416ed8a3bb1Sdrh     Table *pTab;
141741fb5cd1Sdan     pNewItem->pSchema = pOldItem->pSchema;
141817435752Sdrh     pNewItem->zDatabase = sqlite3DbStrDup(db, pOldItem->zDatabase);
141917435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
142017435752Sdrh     pNewItem->zAlias = sqlite3DbStrDup(db, pOldItem->zAlias);
14218a48b9c0Sdrh     pNewItem->fg = pOldItem->fg;
14224efc4754Sdrh     pNewItem->iCursor = pOldItem->iCursor;
14235b6a9ed4Sdrh     pNewItem->addrFillSub = pOldItem->addrFillSub;
14245b6a9ed4Sdrh     pNewItem->regReturn = pOldItem->regReturn;
14258a48b9c0Sdrh     if( pNewItem->fg.isIndexedBy ){
14268a48b9c0Sdrh       pNewItem->u1.zIndexedBy = sqlite3DbStrDup(db, pOldItem->u1.zIndexedBy);
14278a48b9c0Sdrh     }
14288a48b9c0Sdrh     pNewItem->pIBIndex = pOldItem->pIBIndex;
14298a48b9c0Sdrh     if( pNewItem->fg.isTabFunc ){
14308a48b9c0Sdrh       pNewItem->u1.pFuncArg =
14318a48b9c0Sdrh           sqlite3ExprListDup(db, pOldItem->u1.pFuncArg, flags);
14328a48b9c0Sdrh     }
1433ed8a3bb1Sdrh     pTab = pNewItem->pTab = pOldItem->pTab;
1434ed8a3bb1Sdrh     if( pTab ){
143579df7782Sdrh       pTab->nTabRef++;
1436a1cb183dSdanielk1977     }
14376ab3a2ecSdanielk1977     pNewItem->pSelect = sqlite3SelectDup(db, pOldItem->pSelect, flags);
14386ab3a2ecSdanielk1977     pNewItem->pOn = sqlite3ExprDup(db, pOldItem->pOn, flags);
143917435752Sdrh     pNewItem->pUsing = sqlite3IdListDup(db, pOldItem->pUsing);
14406c18b6e0Sdanielk1977     pNewItem->colUsed = pOldItem->colUsed;
1441ad3cab52Sdrh   }
1442ad3cab52Sdrh   return pNew;
1443ad3cab52Sdrh }
144417435752Sdrh IdList *sqlite3IdListDup(sqlite3 *db, IdList *p){
1445ff78bd2fSdrh   IdList *pNew;
1446ff78bd2fSdrh   int i;
1447575fad65Sdrh   assert( db!=0 );
1448ff78bd2fSdrh   if( p==0 ) return 0;
1449575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, sizeof(*pNew) );
1450ff78bd2fSdrh   if( pNew==0 ) return 0;
14516c535158Sdrh   pNew->nId = p->nId;
1452575fad65Sdrh   pNew->a = sqlite3DbMallocRawNN(db, p->nId*sizeof(p->a[0]) );
1453d5d56523Sdanielk1977   if( pNew->a==0 ){
1454dbd6a7dcSdrh     sqlite3DbFreeNN(db, pNew);
1455d5d56523Sdanielk1977     return 0;
1456d5d56523Sdanielk1977   }
14576c535158Sdrh   /* Note that because the size of the allocation for p->a[] is not
14586c535158Sdrh   ** necessarily a power of two, sqlite3IdListAppend() may not be called
14596c535158Sdrh   ** on the duplicate created by this function. */
1460ff78bd2fSdrh   for(i=0; i<p->nId; i++){
14614efc4754Sdrh     struct IdList_item *pNewItem = &pNew->a[i];
14624efc4754Sdrh     struct IdList_item *pOldItem = &p->a[i];
146317435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
14644efc4754Sdrh     pNewItem->idx = pOldItem->idx;
1465ff78bd2fSdrh   }
1466ff78bd2fSdrh   return pNew;
1467ff78bd2fSdrh }
1468a7466205Sdan Select *sqlite3SelectDup(sqlite3 *db, Select *pDup, int flags){
1469a7466205Sdan   Select *pRet = 0;
1470a7466205Sdan   Select *pNext = 0;
1471a7466205Sdan   Select **pp = &pRet;
1472a7466205Sdan   Select *p;
1473a7466205Sdan 
1474575fad65Sdrh   assert( db!=0 );
1475a7466205Sdan   for(p=pDup; p; p=p->pPrior){
1476a7466205Sdan     Select *pNew = sqlite3DbMallocRawNN(db, sizeof(*p) );
1477a7466205Sdan     if( pNew==0 ) break;
1478b7916a78Sdrh     pNew->pEList = sqlite3ExprListDup(db, p->pEList, flags);
14796ab3a2ecSdanielk1977     pNew->pSrc = sqlite3SrcListDup(db, p->pSrc, flags);
14806ab3a2ecSdanielk1977     pNew->pWhere = sqlite3ExprDup(db, p->pWhere, flags);
14816ab3a2ecSdanielk1977     pNew->pGroupBy = sqlite3ExprListDup(db, p->pGroupBy, flags);
14826ab3a2ecSdanielk1977     pNew->pHaving = sqlite3ExprDup(db, p->pHaving, flags);
14836ab3a2ecSdanielk1977     pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, flags);
1484ff78bd2fSdrh     pNew->op = p->op;
1485a7466205Sdan     pNew->pNext = pNext;
1486a7466205Sdan     pNew->pPrior = 0;
14876ab3a2ecSdanielk1977     pNew->pLimit = sqlite3ExprDup(db, p->pLimit, flags);
148892b01d53Sdrh     pNew->iLimit = 0;
148992b01d53Sdrh     pNew->iOffset = 0;
14907d10d5a6Sdrh     pNew->selFlags = p->selFlags & ~SF_UsesEphemeral;
1491b9bb7c18Sdrh     pNew->addrOpenEphm[0] = -1;
1492b9bb7c18Sdrh     pNew->addrOpenEphm[1] = -1;
1493ec2da854Sdrh     pNew->nSelectRow = p->nSelectRow;
14944e9119d9Sdan     pNew->pWith = withDup(db, p->pWith);
149567a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
14962e362f97Sdan     pNew->pWin = 0;
1497c95f38d4Sdan     pNew->pWinDefn = sqlite3WindowListDup(db, p->pWinDefn);
149867a9b8edSdan #endif
1499fef37760Sdrh     pNew->selId = p->selId;
1500a7466205Sdan     *pp = pNew;
1501a7466205Sdan     pp = &pNew->pPrior;
1502a7466205Sdan     pNext = pNew;
1503a7466205Sdan   }
1504a7466205Sdan 
1505a7466205Sdan   return pRet;
1506ff78bd2fSdrh }
150793758c8dSdanielk1977 #else
15086ab3a2ecSdanielk1977 Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
150993758c8dSdanielk1977   assert( p==0 );
151093758c8dSdanielk1977   return 0;
151193758c8dSdanielk1977 }
151293758c8dSdanielk1977 #endif
1513ff78bd2fSdrh 
1514ff78bd2fSdrh 
1515ff78bd2fSdrh /*
1516a76b5dfcSdrh ** Add a new element to the end of an expression list.  If pList is
1517a76b5dfcSdrh ** initially NULL, then create a new expression list.
1518b7916a78Sdrh **
1519a19543feSdrh ** The pList argument must be either NULL or a pointer to an ExprList
1520a19543feSdrh ** obtained from a prior call to sqlite3ExprListAppend().  This routine
1521a19543feSdrh ** may not be used with an ExprList obtained from sqlite3ExprListDup().
1522a19543feSdrh ** Reason:  This routine assumes that the number of slots in pList->a[]
1523a19543feSdrh ** is a power of two.  That is true for sqlite3ExprListAppend() returns
1524a19543feSdrh ** but is not necessarily true from the return value of sqlite3ExprListDup().
1525a19543feSdrh **
1526b7916a78Sdrh ** If a memory allocation error occurs, the entire list is freed and
1527b7916a78Sdrh ** NULL is returned.  If non-NULL is returned, then it is guaranteed
1528b7916a78Sdrh ** that the new entry was successfully appended.
1529a76b5dfcSdrh */
153017435752Sdrh ExprList *sqlite3ExprListAppend(
153117435752Sdrh   Parse *pParse,          /* Parsing context */
153217435752Sdrh   ExprList *pList,        /* List to which to append. Might be NULL */
1533b7916a78Sdrh   Expr *pExpr             /* Expression to be appended. Might be NULL */
153417435752Sdrh ){
153543606175Sdrh   struct ExprList_item *pItem;
153617435752Sdrh   sqlite3 *db = pParse->db;
1537575fad65Sdrh   assert( db!=0 );
1538a76b5dfcSdrh   if( pList==0 ){
1539575fad65Sdrh     pList = sqlite3DbMallocRawNN(db, sizeof(ExprList) );
1540a76b5dfcSdrh     if( pList==0 ){
1541d5d56523Sdanielk1977       goto no_mem;
1542a76b5dfcSdrh     }
1543c263f7c4Sdrh     pList->nExpr = 0;
1544a19543feSdrh   }else if( (pList->nExpr & (pList->nExpr-1))==0 ){
154543606175Sdrh     ExprList *pNew;
154643606175Sdrh     pNew = sqlite3DbRealloc(db, pList,
1547a19543feSdrh              sizeof(*pList)+(2*pList->nExpr - 1)*sizeof(pList->a[0]));
154843606175Sdrh     if( pNew==0 ){
1549d5d56523Sdanielk1977       goto no_mem;
1550a76b5dfcSdrh     }
155143606175Sdrh     pList = pNew;
1552a76b5dfcSdrh   }
155343606175Sdrh   pItem = &pList->a[pList->nExpr++];
1554a8b9793cSdrh   assert( offsetof(struct ExprList_item,zName)==sizeof(pItem->pExpr) );
1555a8b9793cSdrh   assert( offsetof(struct ExprList_item,pExpr)==0 );
1556a8b9793cSdrh   memset(&pItem->zName,0,sizeof(*pItem)-offsetof(struct ExprList_item,zName));
1557e94ddc9eSdanielk1977   pItem->pExpr = pExpr;
1558a76b5dfcSdrh   return pList;
1559d5d56523Sdanielk1977 
1560d5d56523Sdanielk1977 no_mem:
1561d5d56523Sdanielk1977   /* Avoid leaking memory if malloc has failed. */
1562633e6d57Sdrh   sqlite3ExprDelete(db, pExpr);
1563633e6d57Sdrh   sqlite3ExprListDelete(db, pList);
1564d5d56523Sdanielk1977   return 0;
1565a76b5dfcSdrh }
1566a76b5dfcSdrh 
1567a76b5dfcSdrh /*
15688762ec19Sdrh ** pColumns and pExpr form a vector assignment which is part of the SET
15698762ec19Sdrh ** clause of an UPDATE statement.  Like this:
1570a1251bc4Sdrh **
1571a1251bc4Sdrh **        (a,b,c) = (expr1,expr2,expr3)
1572a1251bc4Sdrh ** Or:    (a,b,c) = (SELECT x,y,z FROM ....)
1573a1251bc4Sdrh **
1574a1251bc4Sdrh ** For each term of the vector assignment, append new entries to the
1575b67343d0Sdrh ** expression list pList.  In the case of a subquery on the RHS, append
1576a1251bc4Sdrh ** TK_SELECT_COLUMN expressions.
1577a1251bc4Sdrh */
1578a1251bc4Sdrh ExprList *sqlite3ExprListAppendVector(
1579a1251bc4Sdrh   Parse *pParse,         /* Parsing context */
1580a1251bc4Sdrh   ExprList *pList,       /* List to which to append. Might be NULL */
1581a1251bc4Sdrh   IdList *pColumns,      /* List of names of LHS of the assignment */
1582a1251bc4Sdrh   Expr *pExpr            /* Vector expression to be appended. Might be NULL */
1583a1251bc4Sdrh ){
1584a1251bc4Sdrh   sqlite3 *db = pParse->db;
1585a1251bc4Sdrh   int n;
1586a1251bc4Sdrh   int i;
158766860af3Sdrh   int iFirst = pList ? pList->nExpr : 0;
1588321e828dSdrh   /* pColumns can only be NULL due to an OOM but an OOM will cause an
1589321e828dSdrh   ** exit prior to this routine being invoked */
1590321e828dSdrh   if( NEVER(pColumns==0) ) goto vector_append_error;
1591a1251bc4Sdrh   if( pExpr==0 ) goto vector_append_error;
1592966e2911Sdrh 
1593966e2911Sdrh   /* If the RHS is a vector, then we can immediately check to see that
1594966e2911Sdrh   ** the size of the RHS and LHS match.  But if the RHS is a SELECT,
1595966e2911Sdrh   ** wildcards ("*") in the result set of the SELECT must be expanded before
1596966e2911Sdrh   ** we can do the size check, so defer the size check until code generation.
1597966e2911Sdrh   */
1598966e2911Sdrh   if( pExpr->op!=TK_SELECT && pColumns->nId!=(n=sqlite3ExprVectorSize(pExpr)) ){
1599a1251bc4Sdrh     sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
1600a1251bc4Sdrh                     pColumns->nId, n);
1601a1251bc4Sdrh     goto vector_append_error;
1602a1251bc4Sdrh   }
1603966e2911Sdrh 
1604966e2911Sdrh   for(i=0; i<pColumns->nId; i++){
1605a1251bc4Sdrh     Expr *pSubExpr = sqlite3ExprForVectorField(pParse, pExpr, i);
1606a1251bc4Sdrh     pList = sqlite3ExprListAppend(pParse, pList, pSubExpr);
1607a1251bc4Sdrh     if( pList ){
160866860af3Sdrh       assert( pList->nExpr==iFirst+i+1 );
1609a1251bc4Sdrh       pList->a[pList->nExpr-1].zName = pColumns->a[i].zName;
1610a1251bc4Sdrh       pColumns->a[i].zName = 0;
1611a1251bc4Sdrh     }
1612a1251bc4Sdrh   }
1613966e2911Sdrh 
1614ffe28059Sdrh   if( !db->mallocFailed && pExpr->op==TK_SELECT && ALWAYS(pList!=0) ){
1615966e2911Sdrh     Expr *pFirst = pList->a[iFirst].pExpr;
1616f4dd26c5Sdrh     assert( pFirst!=0 );
1617966e2911Sdrh     assert( pFirst->op==TK_SELECT_COLUMN );
1618966e2911Sdrh 
1619966e2911Sdrh     /* Store the SELECT statement in pRight so it will be deleted when
1620966e2911Sdrh     ** sqlite3ExprListDelete() is called */
1621966e2911Sdrh     pFirst->pRight = pExpr;
1622a1251bc4Sdrh     pExpr = 0;
1623966e2911Sdrh 
1624966e2911Sdrh     /* Remember the size of the LHS in iTable so that we can check that
1625966e2911Sdrh     ** the RHS and LHS sizes match during code generation. */
1626966e2911Sdrh     pFirst->iTable = pColumns->nId;
1627a1251bc4Sdrh   }
1628a1251bc4Sdrh 
1629a1251bc4Sdrh vector_append_error:
1630a1251bc4Sdrh   sqlite3ExprDelete(db, pExpr);
1631a1251bc4Sdrh   sqlite3IdListDelete(db, pColumns);
1632a1251bc4Sdrh   return pList;
1633a1251bc4Sdrh }
1634a1251bc4Sdrh 
1635a1251bc4Sdrh /*
1636bc622bc0Sdrh ** Set the sort order for the last element on the given ExprList.
1637bc622bc0Sdrh */
1638bc622bc0Sdrh void sqlite3ExprListSetSortOrder(ExprList *p, int iSortOrder){
1639bc622bc0Sdrh   if( p==0 ) return;
1640bc622bc0Sdrh   assert( SQLITE_SO_UNDEFINED<0 && SQLITE_SO_ASC>=0 && SQLITE_SO_DESC>0 );
1641bc622bc0Sdrh   assert( p->nExpr>0 );
1642bc622bc0Sdrh   if( iSortOrder<0 ){
1643bc622bc0Sdrh     assert( p->a[p->nExpr-1].sortOrder==SQLITE_SO_ASC );
1644bc622bc0Sdrh     return;
1645bc622bc0Sdrh   }
1646bc622bc0Sdrh   p->a[p->nExpr-1].sortOrder = (u8)iSortOrder;
1647bc622bc0Sdrh }
1648bc622bc0Sdrh 
1649bc622bc0Sdrh /*
1650b7916a78Sdrh ** Set the ExprList.a[].zName element of the most recently added item
1651b7916a78Sdrh ** on the expression list.
1652b7916a78Sdrh **
1653b7916a78Sdrh ** pList might be NULL following an OOM error.  But pName should never be
1654b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1655b7916a78Sdrh ** is set.
1656b7916a78Sdrh */
1657b7916a78Sdrh void sqlite3ExprListSetName(
1658b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1659b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
1660b7916a78Sdrh   Token *pName,           /* Name to be added */
1661b7916a78Sdrh   int dequote             /* True to cause the name to be dequoted */
1662b7916a78Sdrh ){
1663b7916a78Sdrh   assert( pList!=0 || pParse->db->mallocFailed!=0 );
1664b7916a78Sdrh   if( pList ){
1665b7916a78Sdrh     struct ExprList_item *pItem;
1666b7916a78Sdrh     assert( pList->nExpr>0 );
1667b7916a78Sdrh     pItem = &pList->a[pList->nExpr-1];
1668b7916a78Sdrh     assert( pItem->zName==0 );
1669b7916a78Sdrh     pItem->zName = sqlite3DbStrNDup(pParse->db, pName->z, pName->n);
1670244b9d6eSdrh     if( dequote ) sqlite3Dequote(pItem->zName);
1671b7916a78Sdrh   }
1672b7916a78Sdrh }
1673b7916a78Sdrh 
1674b7916a78Sdrh /*
1675b7916a78Sdrh ** Set the ExprList.a[].zSpan element of the most recently added item
1676b7916a78Sdrh ** on the expression list.
1677b7916a78Sdrh **
1678b7916a78Sdrh ** pList might be NULL following an OOM error.  But pSpan should never be
1679b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1680b7916a78Sdrh ** is set.
1681b7916a78Sdrh */
1682b7916a78Sdrh void sqlite3ExprListSetSpan(
1683b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1684b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
16851be266baSdrh   const char *zStart,     /* Start of the span */
16861be266baSdrh   const char *zEnd        /* End of the span */
1687b7916a78Sdrh ){
1688b7916a78Sdrh   sqlite3 *db = pParse->db;
1689b7916a78Sdrh   assert( pList!=0 || db->mallocFailed!=0 );
1690b7916a78Sdrh   if( pList ){
1691b7916a78Sdrh     struct ExprList_item *pItem = &pList->a[pList->nExpr-1];
1692b7916a78Sdrh     assert( pList->nExpr>0 );
1693b7916a78Sdrh     sqlite3DbFree(db, pItem->zSpan);
16949b2e0435Sdrh     pItem->zSpan = sqlite3DbSpanDup(db, zStart, zEnd);
1695b7916a78Sdrh   }
1696b7916a78Sdrh }
1697b7916a78Sdrh 
1698b7916a78Sdrh /*
16997a15a4beSdanielk1977 ** If the expression list pEList contains more than iLimit elements,
17007a15a4beSdanielk1977 ** leave an error message in pParse.
17017a15a4beSdanielk1977 */
17027a15a4beSdanielk1977 void sqlite3ExprListCheckLength(
17037a15a4beSdanielk1977   Parse *pParse,
17047a15a4beSdanielk1977   ExprList *pEList,
17057a15a4beSdanielk1977   const char *zObject
17067a15a4beSdanielk1977 ){
1707b1a6c3c1Sdrh   int mx = pParse->db->aLimit[SQLITE_LIMIT_COLUMN];
1708c5499befSdrh   testcase( pEList && pEList->nExpr==mx );
1709c5499befSdrh   testcase( pEList && pEList->nExpr==mx+1 );
1710b1a6c3c1Sdrh   if( pEList && pEList->nExpr>mx ){
17117a15a4beSdanielk1977     sqlite3ErrorMsg(pParse, "too many columns in %s", zObject);
17127a15a4beSdanielk1977   }
17137a15a4beSdanielk1977 }
17147a15a4beSdanielk1977 
17157a15a4beSdanielk1977 /*
1716a76b5dfcSdrh ** Delete an entire expression list.
1717a76b5dfcSdrh */
1718affa855cSdrh static SQLITE_NOINLINE void exprListDeleteNN(sqlite3 *db, ExprList *pList){
1719ac48b751Sdrh   int i = pList->nExpr;
1720ac48b751Sdrh   struct ExprList_item *pItem =  pList->a;
1721ac48b751Sdrh   assert( pList->nExpr>0 );
1722ac48b751Sdrh   do{
1723633e6d57Sdrh     sqlite3ExprDelete(db, pItem->pExpr);
1724633e6d57Sdrh     sqlite3DbFree(db, pItem->zName);
1725b7916a78Sdrh     sqlite3DbFree(db, pItem->zSpan);
1726ac48b751Sdrh     pItem++;
1727ac48b751Sdrh   }while( --i>0 );
1728dbd6a7dcSdrh   sqlite3DbFreeNN(db, pList);
1729a76b5dfcSdrh }
1730affa855cSdrh void sqlite3ExprListDelete(sqlite3 *db, ExprList *pList){
1731affa855cSdrh   if( pList ) exprListDeleteNN(db, pList);
1732affa855cSdrh }
1733a76b5dfcSdrh 
1734a76b5dfcSdrh /*
17352308ed38Sdrh ** Return the bitwise-OR of all Expr.flags fields in the given
17362308ed38Sdrh ** ExprList.
1737885a5b03Sdrh */
17382308ed38Sdrh u32 sqlite3ExprListFlags(const ExprList *pList){
1739885a5b03Sdrh   int i;
17402308ed38Sdrh   u32 m = 0;
1741508e2d00Sdrh   assert( pList!=0 );
1742885a5b03Sdrh   for(i=0; i<pList->nExpr; i++){
1743d0c73053Sdrh      Expr *pExpr = pList->a[i].pExpr;
1744de845c2fSdrh      assert( pExpr!=0 );
1745de845c2fSdrh      m |= pExpr->flags;
1746885a5b03Sdrh   }
17472308ed38Sdrh   return m;
1748885a5b03Sdrh }
1749885a5b03Sdrh 
1750885a5b03Sdrh /*
17517e6f980bSdrh ** This is a SELECT-node callback for the expression walker that
17527e6f980bSdrh ** always "fails".  By "fail" in this case, we mean set
17537e6f980bSdrh ** pWalker->eCode to zero and abort.
17547e6f980bSdrh **
17557e6f980bSdrh ** This callback is used by multiple expression walkers.
17567e6f980bSdrh */
17577e6f980bSdrh int sqlite3SelectWalkFail(Walker *pWalker, Select *NotUsed){
17587e6f980bSdrh   UNUSED_PARAMETER(NotUsed);
17597e6f980bSdrh   pWalker->eCode = 0;
17607e6f980bSdrh   return WRC_Abort;
17617e6f980bSdrh }
17627e6f980bSdrh 
17637e6f980bSdrh /*
1764171d16bbSdrh ** If the input expression is an ID with the name "true" or "false"
176596acafbeSdrh ** then convert it into an TK_TRUEFALSE term.  Return non-zero if
176696acafbeSdrh ** the conversion happened, and zero if the expression is unaltered.
1767171d16bbSdrh */
1768171d16bbSdrh int sqlite3ExprIdToTrueFalse(Expr *pExpr){
1769171d16bbSdrh   assert( pExpr->op==TK_ID || pExpr->op==TK_STRING );
1770171d16bbSdrh   if( sqlite3StrICmp(pExpr->u.zToken, "true")==0
1771171d16bbSdrh    || sqlite3StrICmp(pExpr->u.zToken, "false")==0
1772171d16bbSdrh   ){
1773171d16bbSdrh     pExpr->op = TK_TRUEFALSE;
1774171d16bbSdrh     return 1;
1775171d16bbSdrh   }
1776171d16bbSdrh   return 0;
1777171d16bbSdrh }
1778171d16bbSdrh 
177943c4ac8bSdrh /*
178096acafbeSdrh ** The argument must be a TK_TRUEFALSE Expr node.  Return 1 if it is TRUE
178143c4ac8bSdrh ** and 0 if it is FALSE.
178243c4ac8bSdrh */
178396acafbeSdrh int sqlite3ExprTruthValue(const Expr *pExpr){
178443c4ac8bSdrh   assert( pExpr->op==TK_TRUEFALSE );
178543c4ac8bSdrh   assert( sqlite3StrICmp(pExpr->u.zToken,"true")==0
178643c4ac8bSdrh        || sqlite3StrICmp(pExpr->u.zToken,"false")==0 );
178743c4ac8bSdrh   return pExpr->u.zToken[4]==0;
178843c4ac8bSdrh }
178943c4ac8bSdrh 
1790171d16bbSdrh 
1791171d16bbSdrh /*
1792059b2d50Sdrh ** These routines are Walker callbacks used to check expressions to
1793059b2d50Sdrh ** see if they are "constant" for some definition of constant.  The
1794059b2d50Sdrh ** Walker.eCode value determines the type of "constant" we are looking
1795059b2d50Sdrh ** for.
179673b211abSdrh **
17977d10d5a6Sdrh ** These callback routines are used to implement the following:
1798626a879aSdrh **
1799059b2d50Sdrh **     sqlite3ExprIsConstant()                  pWalker->eCode==1
1800059b2d50Sdrh **     sqlite3ExprIsConstantNotJoin()           pWalker->eCode==2
1801fcb9f4f3Sdrh **     sqlite3ExprIsTableConstant()             pWalker->eCode==3
1802059b2d50Sdrh **     sqlite3ExprIsConstantOrFunction()        pWalker->eCode==4 or 5
180387abf5c0Sdrh **
1804059b2d50Sdrh ** In all cases, the callbacks set Walker.eCode=0 and abort if the expression
1805059b2d50Sdrh ** is found to not be a constant.
180687abf5c0Sdrh **
1807feada2dfSdrh ** The sqlite3ExprIsConstantOrFunction() is used for evaluating expressions
1808059b2d50Sdrh ** in a CREATE TABLE statement.  The Walker.eCode value is 5 when parsing
1809059b2d50Sdrh ** an existing schema and 4 when processing a new statement.  A bound
1810feada2dfSdrh ** parameter raises an error for new statements, but is silently converted
1811feada2dfSdrh ** to NULL for existing schemas.  This allows sqlite_master tables that
1812feada2dfSdrh ** contain a bound parameter because they were generated by older versions
1813feada2dfSdrh ** of SQLite to be parsed by newer versions of SQLite without raising a
1814feada2dfSdrh ** malformed schema error.
1815626a879aSdrh */
18167d10d5a6Sdrh static int exprNodeIsConstant(Walker *pWalker, Expr *pExpr){
1817626a879aSdrh 
1818059b2d50Sdrh   /* If pWalker->eCode is 2 then any term of the expression that comes from
1819059b2d50Sdrh   ** the ON or USING clauses of a left join disqualifies the expression
18200a168377Sdrh   ** from being considered constant. */
1821059b2d50Sdrh   if( pWalker->eCode==2 && ExprHasProperty(pExpr, EP_FromJoin) ){
1822059b2d50Sdrh     pWalker->eCode = 0;
18237d10d5a6Sdrh     return WRC_Abort;
18240a168377Sdrh   }
18250a168377Sdrh 
1826626a879aSdrh   switch( pExpr->op ){
1827eb55bd2fSdrh     /* Consider functions to be constant if all their arguments are constant
1828059b2d50Sdrh     ** and either pWalker->eCode==4 or 5 or the function has the
1829059b2d50Sdrh     ** SQLITE_FUNC_CONST flag. */
1830eb55bd2fSdrh     case TK_FUNCTION:
183163f84573Sdrh       if( pWalker->eCode>=4 || ExprHasProperty(pExpr,EP_ConstFunc) ){
1832b1fba286Sdrh         return WRC_Continue;
1833059b2d50Sdrh       }else{
1834059b2d50Sdrh         pWalker->eCode = 0;
1835059b2d50Sdrh         return WRC_Abort;
1836b1fba286Sdrh       }
1837626a879aSdrh     case TK_ID:
1838171d16bbSdrh       /* Convert "true" or "false" in a DEFAULT clause into the
1839171d16bbSdrh       ** appropriate TK_TRUEFALSE operator */
1840e39ef31cSdrh       if( sqlite3ExprIdToTrueFalse(pExpr) ){
1841171d16bbSdrh         return WRC_Prune;
1842171d16bbSdrh       }
1843171d16bbSdrh       /* Fall thru */
1844626a879aSdrh     case TK_COLUMN:
1845626a879aSdrh     case TK_AGG_FUNCTION:
184613449892Sdrh     case TK_AGG_COLUMN:
1847c5499befSdrh       testcase( pExpr->op==TK_ID );
1848c5499befSdrh       testcase( pExpr->op==TK_COLUMN );
1849c5499befSdrh       testcase( pExpr->op==TK_AGG_FUNCTION );
1850c5499befSdrh       testcase( pExpr->op==TK_AGG_COLUMN );
1851*efad2e23Sdrh       if( ExprHasProperty(pExpr, EP_FixedCol) ){
1852*efad2e23Sdrh         return WRC_Continue;
1853*efad2e23Sdrh       }
1854059b2d50Sdrh       if( pWalker->eCode==3 && pExpr->iTable==pWalker->u.iCur ){
1855059b2d50Sdrh         return WRC_Continue;
1856f43ce0b4Sdrh       }
1857f43ce0b4Sdrh       /* Fall through */
1858f43ce0b4Sdrh     case TK_IF_NULL_ROW:
18596e341b93Sdrh     case TK_REGISTER:
18609916048bSdrh       testcase( pExpr->op==TK_REGISTER );
1861f43ce0b4Sdrh       testcase( pExpr->op==TK_IF_NULL_ROW );
1862059b2d50Sdrh       pWalker->eCode = 0;
18637d10d5a6Sdrh       return WRC_Abort;
1864feada2dfSdrh     case TK_VARIABLE:
1865059b2d50Sdrh       if( pWalker->eCode==5 ){
1866feada2dfSdrh         /* Silently convert bound parameters that appear inside of CREATE
1867feada2dfSdrh         ** statements into a NULL when parsing the CREATE statement text out
1868feada2dfSdrh         ** of the sqlite_master table */
1869feada2dfSdrh         pExpr->op = TK_NULL;
1870059b2d50Sdrh       }else if( pWalker->eCode==4 ){
1871feada2dfSdrh         /* A bound parameter in a CREATE statement that originates from
1872feada2dfSdrh         ** sqlite3_prepare() causes an error */
1873059b2d50Sdrh         pWalker->eCode = 0;
1874feada2dfSdrh         return WRC_Abort;
1875feada2dfSdrh       }
1876feada2dfSdrh       /* Fall through */
1877626a879aSdrh     default:
18786e341b93Sdrh       testcase( pExpr->op==TK_SELECT ); /* sqlite3SelectWalkFail() disallows */
18796e341b93Sdrh       testcase( pExpr->op==TK_EXISTS ); /* sqlite3SelectWalkFail() disallows */
18807d10d5a6Sdrh       return WRC_Continue;
1881626a879aSdrh   }
1882626a879aSdrh }
1883059b2d50Sdrh static int exprIsConst(Expr *p, int initFlag, int iCur){
18847d10d5a6Sdrh   Walker w;
1885059b2d50Sdrh   w.eCode = initFlag;
18867d10d5a6Sdrh   w.xExprCallback = exprNodeIsConstant;
18877e6f980bSdrh   w.xSelectCallback = sqlite3SelectWalkFail;
1888979dd1beSdrh #ifdef SQLITE_DEBUG
1889979dd1beSdrh   w.xSelectCallback2 = sqlite3SelectWalkAssert2;
1890979dd1beSdrh #endif
1891059b2d50Sdrh   w.u.iCur = iCur;
18927d10d5a6Sdrh   sqlite3WalkExpr(&w, p);
1893059b2d50Sdrh   return w.eCode;
18947d10d5a6Sdrh }
1895626a879aSdrh 
1896626a879aSdrh /*
1897059b2d50Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
1898eb55bd2fSdrh ** and 0 if it involves variables or function calls.
18992398937bSdrh **
19002398937bSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
19012398937bSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
19022398937bSdrh ** a constant.
1903fef5208cSdrh */
19044adee20fSdanielk1977 int sqlite3ExprIsConstant(Expr *p){
1905059b2d50Sdrh   return exprIsConst(p, 1, 0);
1906fef5208cSdrh }
1907fef5208cSdrh 
1908fef5208cSdrh /*
1909059b2d50Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
19100a168377Sdrh ** that does no originate from the ON or USING clauses of a join.
19110a168377Sdrh ** Return 0 if it involves variables or function calls or terms from
19120a168377Sdrh ** an ON or USING clause.
19130a168377Sdrh */
19140a168377Sdrh int sqlite3ExprIsConstantNotJoin(Expr *p){
1915059b2d50Sdrh   return exprIsConst(p, 2, 0);
19160a168377Sdrh }
19170a168377Sdrh 
19180a168377Sdrh /*
1919fcb9f4f3Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
1920059b2d50Sdrh ** for any single row of the table with cursor iCur.  In other words, the
1921059b2d50Sdrh ** expression must not refer to any non-deterministic function nor any
1922059b2d50Sdrh ** table other than iCur.
1923059b2d50Sdrh */
1924059b2d50Sdrh int sqlite3ExprIsTableConstant(Expr *p, int iCur){
1925059b2d50Sdrh   return exprIsConst(p, 3, iCur);
1926059b2d50Sdrh }
1927059b2d50Sdrh 
1928ab31a845Sdan 
1929ab31a845Sdan /*
1930ab31a845Sdan ** sqlite3WalkExpr() callback used by sqlite3ExprIsConstantOrGroupBy().
1931ab31a845Sdan */
1932ab31a845Sdan static int exprNodeIsConstantOrGroupBy(Walker *pWalker, Expr *pExpr){
1933ab31a845Sdan   ExprList *pGroupBy = pWalker->u.pGroupBy;
1934ab31a845Sdan   int i;
1935ab31a845Sdan 
1936ab31a845Sdan   /* Check if pExpr is identical to any GROUP BY term. If so, consider
1937ab31a845Sdan   ** it constant.  */
1938ab31a845Sdan   for(i=0; i<pGroupBy->nExpr; i++){
1939ab31a845Sdan     Expr *p = pGroupBy->a[i].pExpr;
19405aa550cfSdan     if( sqlite3ExprCompare(0, pExpr, p, -1)<2 ){
194170efa84dSdrh       CollSeq *pColl = sqlite3ExprNNCollSeq(pWalker->pParse, p);
1942*efad2e23Sdrh       if( sqlite3IsBinary(pColl) ){
1943ab31a845Sdan         return WRC_Prune;
1944ab31a845Sdan       }
1945ab31a845Sdan     }
1946ab31a845Sdan   }
1947ab31a845Sdan 
1948ab31a845Sdan   /* Check if pExpr is a sub-select. If so, consider it variable. */
1949ab31a845Sdan   if( ExprHasProperty(pExpr, EP_xIsSelect) ){
1950ab31a845Sdan     pWalker->eCode = 0;
1951ab31a845Sdan     return WRC_Abort;
1952ab31a845Sdan   }
1953ab31a845Sdan 
1954ab31a845Sdan   return exprNodeIsConstant(pWalker, pExpr);
1955ab31a845Sdan }
1956ab31a845Sdan 
1957ab31a845Sdan /*
1958ab31a845Sdan ** Walk the expression tree passed as the first argument. Return non-zero
1959ab31a845Sdan ** if the expression consists entirely of constants or copies of terms
1960ab31a845Sdan ** in pGroupBy that sort with the BINARY collation sequence.
1961ab314001Sdrh **
1962ab314001Sdrh ** This routine is used to determine if a term of the HAVING clause can
1963ab314001Sdrh ** be promoted into the WHERE clause.  In order for such a promotion to work,
1964ab314001Sdrh ** the value of the HAVING clause term must be the same for all members of
1965ab314001Sdrh ** a "group".  The requirement that the GROUP BY term must be BINARY
1966ab314001Sdrh ** assumes that no other collating sequence will have a finer-grained
1967ab314001Sdrh ** grouping than binary.  In other words (A=B COLLATE binary) implies
1968ab314001Sdrh ** A=B in every other collating sequence.  The requirement that the
1969ab314001Sdrh ** GROUP BY be BINARY is stricter than necessary.  It would also work
1970ab314001Sdrh ** to promote HAVING clauses that use the same alternative collating
1971ab314001Sdrh ** sequence as the GROUP BY term, but that is much harder to check,
1972ab314001Sdrh ** alternative collating sequences are uncommon, and this is only an
1973ab314001Sdrh ** optimization, so we take the easy way out and simply require the
1974ab314001Sdrh ** GROUP BY to use the BINARY collating sequence.
1975ab31a845Sdan */
1976ab31a845Sdan int sqlite3ExprIsConstantOrGroupBy(Parse *pParse, Expr *p, ExprList *pGroupBy){
1977ab31a845Sdan   Walker w;
1978ab31a845Sdan   w.eCode = 1;
1979ab31a845Sdan   w.xExprCallback = exprNodeIsConstantOrGroupBy;
1980979dd1beSdrh   w.xSelectCallback = 0;
1981ab31a845Sdan   w.u.pGroupBy = pGroupBy;
1982ab31a845Sdan   w.pParse = pParse;
1983ab31a845Sdan   sqlite3WalkExpr(&w, p);
1984ab31a845Sdan   return w.eCode;
1985ab31a845Sdan }
1986ab31a845Sdan 
1987059b2d50Sdrh /*
1988059b2d50Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
1989eb55bd2fSdrh ** or a function call with constant arguments.  Return and 0 if there
1990eb55bd2fSdrh ** are any variables.
1991eb55bd2fSdrh **
1992eb55bd2fSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
1993eb55bd2fSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
1994eb55bd2fSdrh ** a constant.
1995eb55bd2fSdrh */
1996feada2dfSdrh int sqlite3ExprIsConstantOrFunction(Expr *p, u8 isInit){
1997feada2dfSdrh   assert( isInit==0 || isInit==1 );
1998059b2d50Sdrh   return exprIsConst(p, 4+isInit, 0);
1999eb55bd2fSdrh }
2000eb55bd2fSdrh 
20015b88bc4bSdrh #ifdef SQLITE_ENABLE_CURSOR_HINTS
20025b88bc4bSdrh /*
20035b88bc4bSdrh ** Walk an expression tree.  Return 1 if the expression contains a
20045b88bc4bSdrh ** subquery of some kind.  Return 0 if there are no subqueries.
20055b88bc4bSdrh */
20065b88bc4bSdrh int sqlite3ExprContainsSubquery(Expr *p){
20075b88bc4bSdrh   Walker w;
2008bec2476aSdrh   w.eCode = 1;
20095b88bc4bSdrh   w.xExprCallback = sqlite3ExprWalkNoop;
20107e6f980bSdrh   w.xSelectCallback = sqlite3SelectWalkFail;
2011979dd1beSdrh #ifdef SQLITE_DEBUG
2012979dd1beSdrh   w.xSelectCallback2 = sqlite3SelectWalkAssert2;
2013979dd1beSdrh #endif
20145b88bc4bSdrh   sqlite3WalkExpr(&w, p);
201507194bffSdrh   return w.eCode==0;
20165b88bc4bSdrh }
20175b88bc4bSdrh #endif
20185b88bc4bSdrh 
2019eb55bd2fSdrh /*
202073b211abSdrh ** If the expression p codes a constant integer that is small enough
2021202b2df7Sdrh ** to fit in a 32-bit integer, return 1 and put the value of the integer
2022202b2df7Sdrh ** in *pValue.  If the expression is not an integer or if it is too big
2023202b2df7Sdrh ** to fit in a signed 32-bit integer, return 0 and leave *pValue unchanged.
2024e4de1febSdrh */
20254adee20fSdanielk1977 int sqlite3ExprIsInteger(Expr *p, int *pValue){
202692b01d53Sdrh   int rc = 0;
2027ba28b5abSdrh   if( p==0 ) return 0;  /* Can only happen following on OOM */
2028cd92e84dSdrh 
2029cd92e84dSdrh   /* If an expression is an integer literal that fits in a signed 32-bit
2030cd92e84dSdrh   ** integer, then the EP_IntValue flag will have already been set */
2031cd92e84dSdrh   assert( p->op!=TK_INTEGER || (p->flags & EP_IntValue)!=0
2032cd92e84dSdrh            || sqlite3GetInt32(p->u.zToken, &rc)==0 );
2033cd92e84dSdrh 
203492b01d53Sdrh   if( p->flags & EP_IntValue ){
203533e619fcSdrh     *pValue = p->u.iValue;
2036e4de1febSdrh     return 1;
2037e4de1febSdrh   }
203892b01d53Sdrh   switch( p->op ){
20394b59ab5eSdrh     case TK_UPLUS: {
204092b01d53Sdrh       rc = sqlite3ExprIsInteger(p->pLeft, pValue);
2041f6e369a1Sdrh       break;
20424b59ab5eSdrh     }
2043e4de1febSdrh     case TK_UMINUS: {
2044e4de1febSdrh       int v;
20454adee20fSdanielk1977       if( sqlite3ExprIsInteger(p->pLeft, &v) ){
2046f6418891Smistachkin         assert( v!=(-2147483647-1) );
2047e4de1febSdrh         *pValue = -v;
204892b01d53Sdrh         rc = 1;
2049e4de1febSdrh       }
2050e4de1febSdrh       break;
2051e4de1febSdrh     }
2052e4de1febSdrh     default: break;
2053e4de1febSdrh   }
205492b01d53Sdrh   return rc;
2055e4de1febSdrh }
2056e4de1febSdrh 
2057e4de1febSdrh /*
2058039fc32eSdrh ** Return FALSE if there is no chance that the expression can be NULL.
2059039fc32eSdrh **
2060039fc32eSdrh ** If the expression might be NULL or if the expression is too complex
2061039fc32eSdrh ** to tell return TRUE.
2062039fc32eSdrh **
2063039fc32eSdrh ** This routine is used as an optimization, to skip OP_IsNull opcodes
2064039fc32eSdrh ** when we know that a value cannot be NULL.  Hence, a false positive
2065039fc32eSdrh ** (returning TRUE when in fact the expression can never be NULL) might
2066039fc32eSdrh ** be a small performance hit but is otherwise harmless.  On the other
2067039fc32eSdrh ** hand, a false negative (returning FALSE when the result could be NULL)
2068039fc32eSdrh ** will likely result in an incorrect answer.  So when in doubt, return
2069039fc32eSdrh ** TRUE.
2070039fc32eSdrh */
2071039fc32eSdrh int sqlite3ExprCanBeNull(const Expr *p){
2072039fc32eSdrh   u8 op;
2073cd7f457eSdrh   while( p->op==TK_UPLUS || p->op==TK_UMINUS ){ p = p->pLeft; }
2074039fc32eSdrh   op = p->op;
2075039fc32eSdrh   if( op==TK_REGISTER ) op = p->op2;
2076039fc32eSdrh   switch( op ){
2077039fc32eSdrh     case TK_INTEGER:
2078039fc32eSdrh     case TK_STRING:
2079039fc32eSdrh     case TK_FLOAT:
2080039fc32eSdrh     case TK_BLOB:
2081039fc32eSdrh       return 0;
20827248a8b2Sdrh     case TK_COLUMN:
208372673a24Sdrh       return ExprHasProperty(p, EP_CanBeNull) ||
20844dd89d5aSdrh              p->pTab==0 ||  /* Reference to column of index on expression */
208572673a24Sdrh              (p->iColumn>=0 && p->pTab->aCol[p->iColumn].notNull==0);
2086039fc32eSdrh     default:
2087039fc32eSdrh       return 1;
2088039fc32eSdrh   }
2089039fc32eSdrh }
2090039fc32eSdrh 
2091039fc32eSdrh /*
2092039fc32eSdrh ** Return TRUE if the given expression is a constant which would be
2093039fc32eSdrh ** unchanged by OP_Affinity with the affinity given in the second
2094039fc32eSdrh ** argument.
2095039fc32eSdrh **
2096039fc32eSdrh ** This routine is used to determine if the OP_Affinity operation
2097039fc32eSdrh ** can be omitted.  When in doubt return FALSE.  A false negative
2098039fc32eSdrh ** is harmless.  A false positive, however, can result in the wrong
2099039fc32eSdrh ** answer.
2100039fc32eSdrh */
2101039fc32eSdrh int sqlite3ExprNeedsNoAffinityChange(const Expr *p, char aff){
2102039fc32eSdrh   u8 op;
210305883a34Sdrh   if( aff==SQLITE_AFF_BLOB ) return 1;
2104cd7f457eSdrh   while( p->op==TK_UPLUS || p->op==TK_UMINUS ){ p = p->pLeft; }
2105039fc32eSdrh   op = p->op;
2106039fc32eSdrh   if( op==TK_REGISTER ) op = p->op2;
2107039fc32eSdrh   switch( op ){
2108039fc32eSdrh     case TK_INTEGER: {
2109039fc32eSdrh       return aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC;
2110039fc32eSdrh     }
2111039fc32eSdrh     case TK_FLOAT: {
2112039fc32eSdrh       return aff==SQLITE_AFF_REAL || aff==SQLITE_AFF_NUMERIC;
2113039fc32eSdrh     }
2114039fc32eSdrh     case TK_STRING: {
2115039fc32eSdrh       return aff==SQLITE_AFF_TEXT;
2116039fc32eSdrh     }
2117039fc32eSdrh     case TK_BLOB: {
2118039fc32eSdrh       return 1;
2119039fc32eSdrh     }
21202f2855b6Sdrh     case TK_COLUMN: {
212188376ca7Sdrh       assert( p->iTable>=0 );  /* p cannot be part of a CHECK constraint */
212288376ca7Sdrh       return p->iColumn<0
21232f2855b6Sdrh           && (aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC);
21242f2855b6Sdrh     }
2125039fc32eSdrh     default: {
2126039fc32eSdrh       return 0;
2127039fc32eSdrh     }
2128039fc32eSdrh   }
2129039fc32eSdrh }
2130039fc32eSdrh 
2131039fc32eSdrh /*
2132c4a3c779Sdrh ** Return TRUE if the given string is a row-id column name.
2133c4a3c779Sdrh */
21344adee20fSdanielk1977 int sqlite3IsRowid(const char *z){
21354adee20fSdanielk1977   if( sqlite3StrICmp(z, "_ROWID_")==0 ) return 1;
21364adee20fSdanielk1977   if( sqlite3StrICmp(z, "ROWID")==0 ) return 1;
21374adee20fSdanielk1977   if( sqlite3StrICmp(z, "OID")==0 ) return 1;
2138c4a3c779Sdrh   return 0;
2139c4a3c779Sdrh }
2140c4a3c779Sdrh 
21419a96b668Sdanielk1977 /*
214269c355bdSdrh ** pX is the RHS of an IN operator.  If pX is a SELECT statement
214369c355bdSdrh ** that can be simplified to a direct table access, then return
214469c355bdSdrh ** a pointer to the SELECT statement.  If pX is not a SELECT statement,
214569c355bdSdrh ** or if the SELECT statement needs to be manifested into a transient
214669c355bdSdrh ** table, then return NULL.
2147b287f4b6Sdrh */
2148b287f4b6Sdrh #ifndef SQLITE_OMIT_SUBQUERY
21497b35a77bSdan static Select *isCandidateForInOpt(Expr *pX){
215069c355bdSdrh   Select *p;
2151b287f4b6Sdrh   SrcList *pSrc;
2152b287f4b6Sdrh   ExprList *pEList;
2153b287f4b6Sdrh   Table *pTab;
2154cfbb5e82Sdan   int i;
215569c355bdSdrh   if( !ExprHasProperty(pX, EP_xIsSelect) ) return 0;  /* Not a subquery */
215669c355bdSdrh   if( ExprHasProperty(pX, EP_VarSelect)  ) return 0;  /* Correlated subq */
215769c355bdSdrh   p = pX->x.pSelect;
2158b287f4b6Sdrh   if( p->pPrior ) return 0;              /* Not a compound SELECT */
21597d10d5a6Sdrh   if( p->selFlags & (SF_Distinct|SF_Aggregate) ){
2160b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
2161b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
21627d10d5a6Sdrh     return 0; /* No DISTINCT keyword and no aggregate functions */
21637d10d5a6Sdrh   }
2164b74b1017Sdrh   assert( p->pGroupBy==0 );              /* Has no GROUP BY clause */
2165b287f4b6Sdrh   if( p->pLimit ) return 0;              /* Has no LIMIT clause */
2166b287f4b6Sdrh   if( p->pWhere ) return 0;              /* Has no WHERE clause */
2167b287f4b6Sdrh   pSrc = p->pSrc;
2168d1fa7bcaSdrh   assert( pSrc!=0 );
2169d1fa7bcaSdrh   if( pSrc->nSrc!=1 ) return 0;          /* Single term in FROM clause */
2170b74b1017Sdrh   if( pSrc->a[0].pSelect ) return 0;     /* FROM is not a subquery or view */
2171b287f4b6Sdrh   pTab = pSrc->a[0].pTab;
217269c355bdSdrh   assert( pTab!=0 );
2173b74b1017Sdrh   assert( pTab->pSelect==0 );            /* FROM clause is not a view */
2174b287f4b6Sdrh   if( IsVirtual(pTab) ) return 0;        /* FROM clause not a virtual table */
2175b287f4b6Sdrh   pEList = p->pEList;
2176ac6b47d1Sdrh   assert( pEList!=0 );
21777b35a77bSdan   /* All SELECT results must be columns. */
2178cfbb5e82Sdan   for(i=0; i<pEList->nExpr; i++){
2179cfbb5e82Sdan     Expr *pRes = pEList->a[i].pExpr;
2180cfbb5e82Sdan     if( pRes->op!=TK_COLUMN ) return 0;
218169c355bdSdrh     assert( pRes->iTable==pSrc->a[0].iCursor );  /* Not a correlated subquery */
2182cfbb5e82Sdan   }
218369c355bdSdrh   return p;
2184b287f4b6Sdrh }
2185b287f4b6Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
2186b287f4b6Sdrh 
2187f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
21881d8cb21fSdan /*
21894c259e9fSdrh ** Generate code that checks the left-most column of index table iCur to see if
21904c259e9fSdrh ** it contains any NULL entries.  Cause the register at regHasNull to be set
21916be515ebSdrh ** to a non-NULL value if iCur contains no NULLs.  Cause register regHasNull
21926be515ebSdrh ** to be set to NULL if iCur contains one or more NULL values.
21936be515ebSdrh */
21946be515ebSdrh static void sqlite3SetHasNullFlag(Vdbe *v, int iCur, int regHasNull){
2195728e0f91Sdrh   int addr1;
21966be515ebSdrh   sqlite3VdbeAddOp2(v, OP_Integer, 0, regHasNull);
2197728e0f91Sdrh   addr1 = sqlite3VdbeAddOp1(v, OP_Rewind, iCur); VdbeCoverage(v);
21986be515ebSdrh   sqlite3VdbeAddOp3(v, OP_Column, iCur, 0, regHasNull);
21996be515ebSdrh   sqlite3VdbeChangeP5(v, OPFLAG_TYPEOFARG);
22004c259e9fSdrh   VdbeComment((v, "first_entry_in(%d)", iCur));
2201728e0f91Sdrh   sqlite3VdbeJumpHere(v, addr1);
22026be515ebSdrh }
2203f9b2e05cSdan #endif
22046be515ebSdrh 
2205bb53ecb1Sdrh 
2206bb53ecb1Sdrh #ifndef SQLITE_OMIT_SUBQUERY
2207bb53ecb1Sdrh /*
2208bb53ecb1Sdrh ** The argument is an IN operator with a list (not a subquery) on the
2209bb53ecb1Sdrh ** right-hand side.  Return TRUE if that list is constant.
2210bb53ecb1Sdrh */
2211bb53ecb1Sdrh static int sqlite3InRhsIsConstant(Expr *pIn){
2212bb53ecb1Sdrh   Expr *pLHS;
2213bb53ecb1Sdrh   int res;
2214bb53ecb1Sdrh   assert( !ExprHasProperty(pIn, EP_xIsSelect) );
2215bb53ecb1Sdrh   pLHS = pIn->pLeft;
2216bb53ecb1Sdrh   pIn->pLeft = 0;
2217bb53ecb1Sdrh   res = sqlite3ExprIsConstant(pIn);
2218bb53ecb1Sdrh   pIn->pLeft = pLHS;
2219bb53ecb1Sdrh   return res;
2220bb53ecb1Sdrh }
2221bb53ecb1Sdrh #endif
2222bb53ecb1Sdrh 
22236be515ebSdrh /*
22249a96b668Sdanielk1977 ** This function is used by the implementation of the IN (...) operator.
2225d4305ca6Sdrh ** The pX parameter is the expression on the RHS of the IN operator, which
2226d4305ca6Sdrh ** might be either a list of expressions or a subquery.
22279a96b668Sdanielk1977 **
2228d4305ca6Sdrh ** The job of this routine is to find or create a b-tree object that can
2229d4305ca6Sdrh ** be used either to test for membership in the RHS set or to iterate through
2230d4305ca6Sdrh ** all members of the RHS set, skipping duplicates.
2231d4305ca6Sdrh **
22323a85625dSdrh ** A cursor is opened on the b-tree object that is the RHS of the IN operator
2233d4305ca6Sdrh ** and pX->iTable is set to the index of that cursor.
2234d4305ca6Sdrh **
2235b74b1017Sdrh ** The returned value of this function indicates the b-tree type, as follows:
22369a96b668Sdanielk1977 **
22379a96b668Sdanielk1977 **   IN_INDEX_ROWID      - The cursor was opened on a database table.
22381ccce449Sdrh **   IN_INDEX_INDEX_ASC  - The cursor was opened on an ascending index.
22391ccce449Sdrh **   IN_INDEX_INDEX_DESC - The cursor was opened on a descending index.
22409a96b668Sdanielk1977 **   IN_INDEX_EPH        - The cursor was opened on a specially created and
22419a96b668Sdanielk1977 **                         populated epheremal table.
2242bb53ecb1Sdrh **   IN_INDEX_NOOP       - No cursor was allocated.  The IN operator must be
2243bb53ecb1Sdrh **                         implemented as a sequence of comparisons.
22449a96b668Sdanielk1977 **
2245d4305ca6Sdrh ** An existing b-tree might be used if the RHS expression pX is a simple
2246d4305ca6Sdrh ** subquery such as:
22479a96b668Sdanielk1977 **
2248553168c7Sdan **     SELECT <column1>, <column2>... FROM <table>
22499a96b668Sdanielk1977 **
2250d4305ca6Sdrh ** If the RHS of the IN operator is a list or a more complex subquery, then
2251d4305ca6Sdrh ** an ephemeral table might need to be generated from the RHS and then
225260ec914cSpeter.d.reid ** pX->iTable made to point to the ephemeral table instead of an
2253d4305ca6Sdrh ** existing table.
2254d4305ca6Sdrh **
22557fc0ba0fSdrh ** The inFlags parameter must contain, at a minimum, one of the bits
22567fc0ba0fSdrh ** IN_INDEX_MEMBERSHIP or IN_INDEX_LOOP but not both.  If inFlags contains
22577fc0ba0fSdrh ** IN_INDEX_MEMBERSHIP, then the generated table will be used for a fast
22587fc0ba0fSdrh ** membership test.  When the IN_INDEX_LOOP bit is set, the IN index will
22597fc0ba0fSdrh ** be used to loop over all values of the RHS of the IN operator.
22603a85625dSdrh **
22613a85625dSdrh ** When IN_INDEX_LOOP is used (and the b-tree will be used to iterate
22623a85625dSdrh ** through the set members) then the b-tree must not contain duplicates.
22637fc0ba0fSdrh ** An epheremal table will be created unless the selected columns are guaranteed
2264553168c7Sdan ** to be unique - either because it is an INTEGER PRIMARY KEY or due to
2265553168c7Sdan ** a UNIQUE constraint or index.
22660cdc022eSdanielk1977 **
22673a85625dSdrh ** When IN_INDEX_MEMBERSHIP is used (and the b-tree will be used
22683a85625dSdrh ** for fast set membership tests) then an epheremal table must
2269553168c7Sdan ** be used unless <columns> is a single INTEGER PRIMARY KEY column or an
2270553168c7Sdan ** index can be found with the specified <columns> as its left-most.
22710cdc022eSdanielk1977 **
2272bb53ecb1Sdrh ** If the IN_INDEX_NOOP_OK and IN_INDEX_MEMBERSHIP are both set and
2273bb53ecb1Sdrh ** if the RHS of the IN operator is a list (not a subquery) then this
2274bb53ecb1Sdrh ** routine might decide that creating an ephemeral b-tree for membership
2275bb53ecb1Sdrh ** testing is too expensive and return IN_INDEX_NOOP.  In that case, the
2276bb53ecb1Sdrh ** calling routine should implement the IN operator using a sequence
2277bb53ecb1Sdrh ** of Eq or Ne comparison operations.
2278bb53ecb1Sdrh **
2279b74b1017Sdrh ** When the b-tree is being used for membership tests, the calling function
22803a85625dSdrh ** might need to know whether or not the RHS side of the IN operator
2281e21a6e1dSdrh ** contains a NULL.  If prRhsHasNull is not a NULL pointer and
22823a85625dSdrh ** if there is any chance that the (...) might contain a NULL value at
22830cdc022eSdanielk1977 ** runtime, then a register is allocated and the register number written
2284e21a6e1dSdrh ** to *prRhsHasNull. If there is no chance that the (...) contains a
2285e21a6e1dSdrh ** NULL value, then *prRhsHasNull is left unchanged.
22860cdc022eSdanielk1977 **
2287e21a6e1dSdrh ** If a register is allocated and its location stored in *prRhsHasNull, then
22886be515ebSdrh ** the value in that register will be NULL if the b-tree contains one or more
22896be515ebSdrh ** NULL values, and it will be some non-NULL value if the b-tree contains no
22906be515ebSdrh ** NULL values.
2291553168c7Sdan **
2292553168c7Sdan ** If the aiMap parameter is not NULL, it must point to an array containing
2293553168c7Sdan ** one element for each column returned by the SELECT statement on the RHS
2294553168c7Sdan ** of the IN(...) operator. The i'th entry of the array is populated with the
2295553168c7Sdan ** offset of the index column that matches the i'th column returned by the
2296553168c7Sdan ** SELECT. For example, if the expression and selected index are:
2297553168c7Sdan **
2298553168c7Sdan **   (?,?,?) IN (SELECT a, b, c FROM t1)
2299553168c7Sdan **   CREATE INDEX i1 ON t1(b, c, a);
2300553168c7Sdan **
2301553168c7Sdan ** then aiMap[] is populated with {2, 0, 1}.
23029a96b668Sdanielk1977 */
2303284f4acaSdanielk1977 #ifndef SQLITE_OMIT_SUBQUERY
2304ba00e30aSdan int sqlite3FindInIndex(
23056fc8f364Sdrh   Parse *pParse,             /* Parsing context */
23066fc8f364Sdrh   Expr *pX,                  /* The right-hand side (RHS) of the IN operator */
23076fc8f364Sdrh   u32 inFlags,               /* IN_INDEX_LOOP, _MEMBERSHIP, and/or _NOOP_OK */
23086fc8f364Sdrh   int *prRhsHasNull,         /* Register holding NULL status.  See notes */
23096fc8f364Sdrh   int *aiMap                 /* Mapping from Index fields to RHS fields */
2310ba00e30aSdan ){
2311b74b1017Sdrh   Select *p;                            /* SELECT to the right of IN operator */
2312b74b1017Sdrh   int eType = 0;                        /* Type of RHS table. IN_INDEX_* */
2313b74b1017Sdrh   int iTab = pParse->nTab++;            /* Cursor of the RHS table */
23143a85625dSdrh   int mustBeUnique;                     /* True if RHS must be unique */
2315b8475df8Sdrh   Vdbe *v = sqlite3GetVdbe(pParse);     /* Virtual machine being coded */
23169a96b668Sdanielk1977 
23171450bc6eSdrh   assert( pX->op==TK_IN );
23183a85625dSdrh   mustBeUnique = (inFlags & IN_INDEX_LOOP)!=0;
23191450bc6eSdrh 
23207b35a77bSdan   /* If the RHS of this IN(...) operator is a SELECT, and if it matters
23217b35a77bSdan   ** whether or not the SELECT result contains NULL values, check whether
2322870a0705Sdan   ** or not NULL is actually possible (it may not be, for example, due
23237b35a77bSdan   ** to NOT NULL constraints in the schema). If no NULL values are possible,
2324870a0705Sdan   ** set prRhsHasNull to 0 before continuing.  */
23257b35a77bSdan   if( prRhsHasNull && (pX->flags & EP_xIsSelect) ){
23267b35a77bSdan     int i;
23277b35a77bSdan     ExprList *pEList = pX->x.pSelect->pEList;
23287b35a77bSdan     for(i=0; i<pEList->nExpr; i++){
23297b35a77bSdan       if( sqlite3ExprCanBeNull(pEList->a[i].pExpr) ) break;
23307b35a77bSdan     }
23317b35a77bSdan     if( i==pEList->nExpr ){
23327b35a77bSdan       prRhsHasNull = 0;
23337b35a77bSdan     }
23347b35a77bSdan   }
23357b35a77bSdan 
2336b74b1017Sdrh   /* Check to see if an existing table or index can be used to
2337b74b1017Sdrh   ** satisfy the query.  This is preferable to generating a new
23387b35a77bSdan   ** ephemeral table.  */
23397b35a77bSdan   if( pParse->nErr==0 && (p = isCandidateForInOpt(pX))!=0 ){
2340e1fb65a0Sdanielk1977     sqlite3 *db = pParse->db;              /* Database connection */
2341b07028f7Sdrh     Table *pTab;                           /* Table <table>. */
2342ba00e30aSdan     i16 iDb;                               /* Database idx for pTab */
2343cfbb5e82Sdan     ExprList *pEList = p->pEList;
2344cfbb5e82Sdan     int nExpr = pEList->nExpr;
2345e1fb65a0Sdanielk1977 
2346b07028f7Sdrh     assert( p->pEList!=0 );             /* Because of isCandidateForInOpt(p) */
2347b07028f7Sdrh     assert( p->pEList->a[0].pExpr!=0 ); /* Because of isCandidateForInOpt(p) */
2348b07028f7Sdrh     assert( p->pSrc!=0 );               /* Because of isCandidateForInOpt(p) */
2349b07028f7Sdrh     pTab = p->pSrc->a[0].pTab;
2350b07028f7Sdrh 
2351b22f7c83Sdrh     /* Code an OP_Transaction and OP_TableLock for <table>. */
2352e1fb65a0Sdanielk1977     iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
2353e1fb65a0Sdanielk1977     sqlite3CodeVerifySchema(pParse, iDb);
2354e1fb65a0Sdanielk1977     sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
23559a96b668Sdanielk1977 
2356a84a283dSdrh     assert(v);  /* sqlite3GetVdbe() has always been previously called */
2357cfbb5e82Sdan     if( nExpr==1 && pEList->a[0].pExpr->iColumn<0 ){
235862659b2aSdrh       /* The "x IN (SELECT rowid FROM table)" case */
2359511f9e8dSdrh       int iAddr = sqlite3VdbeAddOp0(v, OP_Once);
23607d176105Sdrh       VdbeCoverage(v);
23619a96b668Sdanielk1977 
23629a96b668Sdanielk1977       sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
23639a96b668Sdanielk1977       eType = IN_INDEX_ROWID;
23649a96b668Sdanielk1977 
23659a96b668Sdanielk1977       sqlite3VdbeJumpHere(v, iAddr);
23669a96b668Sdanielk1977     }else{
2367e1fb65a0Sdanielk1977       Index *pIdx;                         /* Iterator variable */
2368cfbb5e82Sdan       int affinity_ok = 1;
2369cfbb5e82Sdan       int i;
2370cfbb5e82Sdan 
2371cfbb5e82Sdan       /* Check that the affinity that will be used to perform each
237262659b2aSdrh       ** comparison is the same as the affinity of each column in table
237362659b2aSdrh       ** on the RHS of the IN operator.  If it not, it is not possible to
237462659b2aSdrh       ** use any index of the RHS table.  */
2375cfbb5e82Sdan       for(i=0; i<nExpr && affinity_ok; i++){
2376fc7f27b9Sdrh         Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2377cfbb5e82Sdan         int iCol = pEList->a[i].pExpr->iColumn;
23780dfa4f6fSdrh         char idxaff = sqlite3TableColumnAffinity(pTab,iCol); /* RHS table */
2379cfbb5e82Sdan         char cmpaff = sqlite3CompareAffinity(pLhs, idxaff);
238062659b2aSdrh         testcase( cmpaff==SQLITE_AFF_BLOB );
238162659b2aSdrh         testcase( cmpaff==SQLITE_AFF_TEXT );
2382cfbb5e82Sdan         switch( cmpaff ){
2383cfbb5e82Sdan           case SQLITE_AFF_BLOB:
2384cfbb5e82Sdan             break;
2385cfbb5e82Sdan           case SQLITE_AFF_TEXT:
238662659b2aSdrh             /* sqlite3CompareAffinity() only returns TEXT if one side or the
238762659b2aSdrh             ** other has no affinity and the other side is TEXT.  Hence,
238862659b2aSdrh             ** the only way for cmpaff to be TEXT is for idxaff to be TEXT
238962659b2aSdrh             ** and for the term on the LHS of the IN to have no affinity. */
239062659b2aSdrh             assert( idxaff==SQLITE_AFF_TEXT );
2391cfbb5e82Sdan             break;
2392cfbb5e82Sdan           default:
2393cfbb5e82Sdan             affinity_ok = sqlite3IsNumericAffinity(idxaff);
2394cfbb5e82Sdan         }
2395cfbb5e82Sdan       }
2396e1fb65a0Sdanielk1977 
2397a84a283dSdrh       if( affinity_ok ){
2398a84a283dSdrh         /* Search for an existing index that will work for this IN operator */
2399a84a283dSdrh         for(pIdx=pTab->pIndex; pIdx && eType==0; pIdx=pIdx->pNext){
2400a84a283dSdrh           Bitmask colUsed;      /* Columns of the index used */
2401a84a283dSdrh           Bitmask mCol;         /* Mask for the current column */
24026fc8f364Sdrh           if( pIdx->nColumn<nExpr ) continue;
2403a84a283dSdrh           /* Maximum nColumn is BMS-2, not BMS-1, so that we can compute
2404a84a283dSdrh           ** BITMASK(nExpr) without overflowing */
2405a84a283dSdrh           testcase( pIdx->nColumn==BMS-2 );
2406a84a283dSdrh           testcase( pIdx->nColumn==BMS-1 );
2407a84a283dSdrh           if( pIdx->nColumn>=BMS-1 ) continue;
24086fc8f364Sdrh           if( mustBeUnique ){
24096fc8f364Sdrh             if( pIdx->nKeyCol>nExpr
24106fc8f364Sdrh              ||(pIdx->nColumn>nExpr && !IsUniqueIndex(pIdx))
24116fc8f364Sdrh             ){
2412a84a283dSdrh               continue;  /* This index is not unique over the IN RHS columns */
2413cfbb5e82Sdan             }
24146fc8f364Sdrh           }
2415cfbb5e82Sdan 
2416a84a283dSdrh           colUsed = 0;   /* Columns of index used so far */
2417cfbb5e82Sdan           for(i=0; i<nExpr; i++){
2418fc7f27b9Sdrh             Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2419cfbb5e82Sdan             Expr *pRhs = pEList->a[i].pExpr;
2420cfbb5e82Sdan             CollSeq *pReq = sqlite3BinaryCompareCollSeq(pParse, pLhs, pRhs);
2421cfbb5e82Sdan             int j;
2422cfbb5e82Sdan 
24236fc8f364Sdrh             assert( pReq!=0 || pRhs->iColumn==XN_ROWID || pParse->nErr );
2424cfbb5e82Sdan             for(j=0; j<nExpr; j++){
2425cfbb5e82Sdan               if( pIdx->aiColumn[j]!=pRhs->iColumn ) continue;
2426cfbb5e82Sdan               assert( pIdx->azColl[j] );
2427106526e1Sdrh               if( pReq!=0 && sqlite3StrICmp(pReq->zName, pIdx->azColl[j])!=0 ){
2428106526e1Sdrh                 continue;
2429106526e1Sdrh               }
2430cfbb5e82Sdan               break;
2431cfbb5e82Sdan             }
2432cfbb5e82Sdan             if( j==nExpr ) break;
2433a84a283dSdrh             mCol = MASKBIT(j);
2434a84a283dSdrh             if( mCol & colUsed ) break; /* Each column used only once */
2435a84a283dSdrh             colUsed |= mCol;
2436ba00e30aSdan             if( aiMap ) aiMap[i] = j;
2437cfbb5e82Sdan           }
2438cfbb5e82Sdan 
2439a84a283dSdrh           assert( i==nExpr || colUsed!=(MASKBIT(nExpr)-1) );
2440a84a283dSdrh           if( colUsed==(MASKBIT(nExpr)-1) ){
2441a84a283dSdrh             /* If we reach this point, that means the index pIdx is usable */
2442511f9e8dSdrh             int iAddr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
2443e2ca99c9Sdrh             ExplainQueryPlan((pParse, 0,
2444e2ca99c9Sdrh                               "USING INDEX %s FOR IN-OPERATOR",pIdx->zName));
24452ec2fb22Sdrh             sqlite3VdbeAddOp3(v, OP_OpenRead, iTab, pIdx->tnum, iDb);
24462ec2fb22Sdrh             sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
2447207872a4Sdanielk1977             VdbeComment((v, "%s", pIdx->zName));
24481ccce449Sdrh             assert( IN_INDEX_INDEX_DESC == IN_INDEX_INDEX_ASC+1 );
24491ccce449Sdrh             eType = IN_INDEX_INDEX_ASC + pIdx->aSortOrder[0];
24509a96b668Sdanielk1977 
24517b35a77bSdan             if( prRhsHasNull ){
24523480bfdaSdan #ifdef SQLITE_ENABLE_COLUMN_USED_MASK
2453cfbb5e82Sdan               i64 mask = (1<<nExpr)-1;
24543480bfdaSdan               sqlite3VdbeAddOp4Dup8(v, OP_ColumnsUsed,
2455cfbb5e82Sdan                   iTab, 0, 0, (u8*)&mask, P4_INT64);
24563480bfdaSdan #endif
2457b80dbdc2Sdrh               *prRhsHasNull = ++pParse->nMem;
24587b35a77bSdan               if( nExpr==1 ){
24596be515ebSdrh                 sqlite3SetHasNullFlag(v, iTab, *prRhsHasNull);
24600cdc022eSdanielk1977               }
24617b35a77bSdan             }
2462552fd454Sdrh             sqlite3VdbeJumpHere(v, iAddr);
24639a96b668Sdanielk1977           }
2464a84a283dSdrh         } /* End loop over indexes */
2465a84a283dSdrh       } /* End if( affinity_ok ) */
2466a84a283dSdrh     } /* End if not an rowid index */
2467a84a283dSdrh   } /* End attempt to optimize using an index */
24689a96b668Sdanielk1977 
2469bb53ecb1Sdrh   /* If no preexisting index is available for the IN clause
2470bb53ecb1Sdrh   ** and IN_INDEX_NOOP is an allowed reply
2471bb53ecb1Sdrh   ** and the RHS of the IN operator is a list, not a subquery
247271c57db0Sdan   ** and the RHS is not constant or has two or fewer terms,
247360ec914cSpeter.d.reid   ** then it is not worth creating an ephemeral table to evaluate
2474bb53ecb1Sdrh   ** the IN operator so return IN_INDEX_NOOP.
2475bb53ecb1Sdrh   */
2476bb53ecb1Sdrh   if( eType==0
2477bb53ecb1Sdrh    && (inFlags & IN_INDEX_NOOP_OK)
2478bb53ecb1Sdrh    && !ExprHasProperty(pX, EP_xIsSelect)
2479bb53ecb1Sdrh    && (!sqlite3InRhsIsConstant(pX) || pX->x.pList->nExpr<=2)
2480bb53ecb1Sdrh   ){
2481bb53ecb1Sdrh     eType = IN_INDEX_NOOP;
2482bb53ecb1Sdrh   }
2483bb53ecb1Sdrh 
24849a96b668Sdanielk1977   if( eType==0 ){
24854387006cSdrh     /* Could not find an existing table or index to use as the RHS b-tree.
2486b74b1017Sdrh     ** We will have to generate an ephemeral table to do the job.
2487b74b1017Sdrh     */
24888e23daf3Sdrh     u32 savedNQueryLoop = pParse->nQueryLoop;
24890cdc022eSdanielk1977     int rMayHaveNull = 0;
249041a05b7bSdanielk1977     eType = IN_INDEX_EPH;
24913a85625dSdrh     if( inFlags & IN_INDEX_LOOP ){
24924a5acf8eSdrh       pParse->nQueryLoop = 0;
2493c5cd1249Sdrh       if( pX->pLeft->iColumn<0 && !ExprHasProperty(pX, EP_xIsSelect) ){
249441a05b7bSdanielk1977         eType = IN_INDEX_ROWID;
24950cdc022eSdanielk1977       }
2496e21a6e1dSdrh     }else if( prRhsHasNull ){
2497e21a6e1dSdrh       *prRhsHasNull = rMayHaveNull = ++pParse->nMem;
2498cf4d38aaSdrh     }
249941a05b7bSdanielk1977     sqlite3CodeSubselect(pParse, pX, rMayHaveNull, eType==IN_INDEX_ROWID);
2500cf4d38aaSdrh     pParse->nQueryLoop = savedNQueryLoop;
25019a96b668Sdanielk1977   }else{
25029a96b668Sdanielk1977     pX->iTable = iTab;
25039a96b668Sdanielk1977   }
2504ba00e30aSdan 
2505ba00e30aSdan   if( aiMap && eType!=IN_INDEX_INDEX_ASC && eType!=IN_INDEX_INDEX_DESC ){
2506ba00e30aSdan     int i, n;
2507ba00e30aSdan     n = sqlite3ExprVectorSize(pX->pLeft);
2508ba00e30aSdan     for(i=0; i<n; i++) aiMap[i] = i;
2509ba00e30aSdan   }
25109a96b668Sdanielk1977   return eType;
25119a96b668Sdanielk1977 }
2512284f4acaSdanielk1977 #endif
2513626a879aSdrh 
2514f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
2515553168c7Sdan /*
2516553168c7Sdan ** Argument pExpr is an (?, ?...) IN(...) expression. This
2517553168c7Sdan ** function allocates and returns a nul-terminated string containing
2518553168c7Sdan ** the affinities to be used for each column of the comparison.
2519553168c7Sdan **
2520553168c7Sdan ** It is the responsibility of the caller to ensure that the returned
2521553168c7Sdan ** string is eventually freed using sqlite3DbFree().
2522553168c7Sdan */
252371c57db0Sdan static char *exprINAffinity(Parse *pParse, Expr *pExpr){
252471c57db0Sdan   Expr *pLeft = pExpr->pLeft;
252571c57db0Sdan   int nVal = sqlite3ExprVectorSize(pLeft);
2526553168c7Sdan   Select *pSelect = (pExpr->flags & EP_xIsSelect) ? pExpr->x.pSelect : 0;
252771c57db0Sdan   char *zRet;
252871c57db0Sdan 
2529553168c7Sdan   assert( pExpr->op==TK_IN );
25305c258dc1Sdrh   zRet = sqlite3DbMallocRaw(pParse->db, nVal+1);
253171c57db0Sdan   if( zRet ){
253271c57db0Sdan     int i;
253371c57db0Sdan     for(i=0; i<nVal; i++){
2534fc7f27b9Sdrh       Expr *pA = sqlite3VectorFieldSubexpr(pLeft, i);
2535553168c7Sdan       char a = sqlite3ExprAffinity(pA);
2536553168c7Sdan       if( pSelect ){
2537553168c7Sdan         zRet[i] = sqlite3CompareAffinity(pSelect->pEList->a[i].pExpr, a);
253871c57db0Sdan       }else{
2539553168c7Sdan         zRet[i] = a;
254071c57db0Sdan       }
254171c57db0Sdan     }
254271c57db0Sdan     zRet[nVal] = '\0';
254371c57db0Sdan   }
254471c57db0Sdan   return zRet;
254571c57db0Sdan }
2546f9b2e05cSdan #endif
254771c57db0Sdan 
25488da209b1Sdan #ifndef SQLITE_OMIT_SUBQUERY
25498da209b1Sdan /*
25508da209b1Sdan ** Load the Parse object passed as the first argument with an error
25518da209b1Sdan ** message of the form:
25528da209b1Sdan **
25538da209b1Sdan **   "sub-select returns N columns - expected M"
25548da209b1Sdan */
25558da209b1Sdan void sqlite3SubselectError(Parse *pParse, int nActual, int nExpect){
25568da209b1Sdan   const char *zFmt = "sub-select returns %d columns - expected %d";
25578da209b1Sdan   sqlite3ErrorMsg(pParse, zFmt, nActual, nExpect);
25588da209b1Sdan }
25598da209b1Sdan #endif
25608da209b1Sdan 
2561626a879aSdrh /*
256244c5604cSdan ** Expression pExpr is a vector that has been used in a context where
256344c5604cSdan ** it is not permitted. If pExpr is a sub-select vector, this routine
256444c5604cSdan ** loads the Parse object with a message of the form:
256544c5604cSdan **
256644c5604cSdan **   "sub-select returns N columns - expected 1"
256744c5604cSdan **
256844c5604cSdan ** Or, if it is a regular scalar vector:
256944c5604cSdan **
257044c5604cSdan **   "row value misused"
257144c5604cSdan */
257244c5604cSdan void sqlite3VectorErrorMsg(Parse *pParse, Expr *pExpr){
257344c5604cSdan #ifndef SQLITE_OMIT_SUBQUERY
257444c5604cSdan   if( pExpr->flags & EP_xIsSelect ){
257544c5604cSdan     sqlite3SubselectError(pParse, pExpr->x.pSelect->pEList->nExpr, 1);
257644c5604cSdan   }else
257744c5604cSdan #endif
257844c5604cSdan   {
257944c5604cSdan     sqlite3ErrorMsg(pParse, "row value misused");
258044c5604cSdan   }
258144c5604cSdan }
258244c5604cSdan 
258344c5604cSdan /*
2584d4187c71Sdrh ** Generate code for scalar subqueries used as a subquery expression, EXISTS,
2585d4187c71Sdrh ** or IN operators.  Examples:
2586626a879aSdrh **
25879cbe6352Sdrh **     (SELECT a FROM b)          -- subquery
25889cbe6352Sdrh **     EXISTS (SELECT a FROM b)   -- EXISTS subquery
25899cbe6352Sdrh **     x IN (4,5,11)              -- IN operator with list on right-hand side
25909cbe6352Sdrh **     x IN (SELECT a FROM b)     -- IN operator with subquery on the right
2591fef5208cSdrh **
25929cbe6352Sdrh ** The pExpr parameter describes the expression that contains the IN
25939cbe6352Sdrh ** operator or subquery.
259441a05b7bSdanielk1977 **
259541a05b7bSdanielk1977 ** If parameter isRowid is non-zero, then expression pExpr is guaranteed
259641a05b7bSdanielk1977 ** to be of the form "<rowid> IN (?, ?, ?)", where <rowid> is a reference
259741a05b7bSdanielk1977 ** to some integer key column of a table B-Tree. In this case, use an
259841a05b7bSdanielk1977 ** intkey B-Tree to store the set of IN(...) values instead of the usual
259941a05b7bSdanielk1977 ** (slower) variable length keys B-Tree.
2600fd773cf9Sdrh **
2601fd773cf9Sdrh ** If rMayHaveNull is non-zero, that means that the operation is an IN
2602fd773cf9Sdrh ** (not a SELECT or EXISTS) and that the RHS might contains NULLs.
26033a85625dSdrh ** All this routine does is initialize the register given by rMayHaveNull
26043a85625dSdrh ** to NULL.  Calling routines will take care of changing this register
26053a85625dSdrh ** value to non-NULL if the RHS is NULL-free.
26061450bc6eSdrh **
26071450bc6eSdrh ** For a SELECT or EXISTS operator, return the register that holds the
260839a11819Sdrh ** result.  For a multi-column SELECT, the result is stored in a contiguous
260939a11819Sdrh ** array of registers and the return value is the register of the left-most
261039a11819Sdrh ** result column.  Return 0 for IN operators or if an error occurs.
2611cce7d176Sdrh */
261251522cd3Sdrh #ifndef SQLITE_OMIT_SUBQUERY
26131450bc6eSdrh int sqlite3CodeSubselect(
2614fd773cf9Sdrh   Parse *pParse,          /* Parsing context */
2615fd773cf9Sdrh   Expr *pExpr,            /* The IN, SELECT, or EXISTS operator */
26166be515ebSdrh   int rHasNullFlag,       /* Register that records whether NULLs exist in RHS */
2617fd773cf9Sdrh   int isRowid             /* If true, LHS of IN operator is a rowid */
261841a05b7bSdanielk1977 ){
26196be515ebSdrh   int jmpIfDynamic = -1;                      /* One-time test address */
26201450bc6eSdrh   int rReg = 0;                           /* Register storing resulting */
2621b3bce662Sdanielk1977   Vdbe *v = sqlite3GetVdbe(pParse);
26221450bc6eSdrh   if( NEVER(v==0) ) return 0;
2623ceea3321Sdrh   sqlite3ExprCachePush(pParse);
2624fc976065Sdanielk1977 
262539a11819Sdrh   /* The evaluation of the IN/EXISTS/SELECT must be repeated every time it
262639a11819Sdrh   ** is encountered if any of the following is true:
262757dbd7b3Sdrh   **
262857dbd7b3Sdrh   **    *  The right-hand side is a correlated subquery
262957dbd7b3Sdrh   **    *  The right-hand side is an expression list containing variables
263057dbd7b3Sdrh   **    *  We are inside a trigger
263157dbd7b3Sdrh   **
263257dbd7b3Sdrh   ** If all of the above are false, then we can run this code just once
263357dbd7b3Sdrh   ** save the results, and reuse the same result on subsequent invocations.
2634b3bce662Sdanielk1977   */
2635c5cd1249Sdrh   if( !ExprHasProperty(pExpr, EP_VarSelect) ){
2636511f9e8dSdrh     jmpIfDynamic = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
2637b3bce662Sdanielk1977   }
2638b3bce662Sdanielk1977 
2639cce7d176Sdrh   switch( pExpr->op ){
2640fef5208cSdrh     case TK_IN: {
2641b9bb7c18Sdrh       int addr;                   /* Address of OP_OpenEphemeral instruction */
2642d4187c71Sdrh       Expr *pLeft = pExpr->pLeft; /* the LHS of the IN operator */
2643323df790Sdrh       KeyInfo *pKeyInfo = 0;      /* Key information */
264471c57db0Sdan       int nVal;                   /* Size of vector pLeft */
2645d3d39e93Sdrh 
264671c57db0Sdan       nVal = sqlite3ExprVectorSize(pLeft);
2647553168c7Sdan       assert( !isRowid || nVal==1 );
2648e014a838Sdanielk1977 
2649e014a838Sdanielk1977       /* Whether this is an 'x IN(SELECT...)' or an 'x IN(<exprlist>)'
26508cff69dfSdrh       ** expression it is handled the same way.  An ephemeral table is
2651553168c7Sdan       ** filled with index keys representing the results from the
2652553168c7Sdan       ** SELECT or the <exprlist>.
2653fef5208cSdrh       **
2654e014a838Sdanielk1977       ** If the 'x' expression is a column value, or the SELECT...
2655e014a838Sdanielk1977       ** statement returns a column value, then the affinity of that
2656e014a838Sdanielk1977       ** column is used to build the index keys. If both 'x' and the
2657e014a838Sdanielk1977       ** SELECT... statement are columns, then numeric affinity is used
2658e014a838Sdanielk1977       ** if either column has NUMERIC or INTEGER affinity. If neither
2659e014a838Sdanielk1977       ** 'x' nor the SELECT... statement are columns, then numeric affinity
2660e014a838Sdanielk1977       ** is used.
2661fef5208cSdrh       */
2662832508b7Sdrh       pExpr->iTable = pParse->nTab++;
266371c57db0Sdan       addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral,
266471c57db0Sdan           pExpr->iTable, (isRowid?0:nVal));
266571c57db0Sdan       pKeyInfo = isRowid ? 0 : sqlite3KeyInfoAlloc(pParse->db, nVal, 1);
2666e014a838Sdanielk1977 
26676ab3a2ecSdanielk1977       if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2668e014a838Sdanielk1977         /* Case 1:     expr IN (SELECT ...)
2669e014a838Sdanielk1977         **
2670e014a838Sdanielk1977         ** Generate code to write the results of the select into the temporary
2671e014a838Sdanielk1977         ** table allocated and opened above.
2672e014a838Sdanielk1977         */
26734387006cSdrh         Select *pSelect = pExpr->x.pSelect;
267471c57db0Sdan         ExprList *pEList = pSelect->pEList;
26751013c932Sdrh 
2676e2ca99c9Sdrh         ExplainQueryPlan((pParse, 1, "%sLIST SUBQUERY",
2677e2ca99c9Sdrh             jmpIfDynamic>=0?"":"CORRELATED "
2678e2ca99c9Sdrh         ));
267941a05b7bSdanielk1977         assert( !isRowid );
268064bcb8cfSdrh         /* If the LHS and RHS of the IN operator do not match, that
268164bcb8cfSdrh         ** error will have been caught long before we reach this point. */
268264bcb8cfSdrh         if( ALWAYS(pEList->nExpr==nVal) ){
268371c57db0Sdan           SelectDest dest;
268471c57db0Sdan           int i;
26851013c932Sdrh           sqlite3SelectDestInit(&dest, SRT_Set, pExpr->iTable);
268671c57db0Sdan           dest.zAffSdst = exprINAffinity(pParse, pExpr);
26874387006cSdrh           pSelect->iLimit = 0;
26884387006cSdrh           testcase( pSelect->selFlags & SF_Distinct );
2689812ea833Sdrh           testcase( pKeyInfo==0 ); /* Caused by OOM in sqlite3KeyInfoAlloc() */
26904387006cSdrh           if( sqlite3Select(pParse, pSelect, &dest) ){
269171c57db0Sdan             sqlite3DbFree(pParse->db, dest.zAffSdst);
26922ec2fb22Sdrh             sqlite3KeyInfoUnref(pKeyInfo);
26931450bc6eSdrh             return 0;
269494ccde58Sdrh           }
269571c57db0Sdan           sqlite3DbFree(pParse->db, dest.zAffSdst);
2696812ea833Sdrh           assert( pKeyInfo!=0 ); /* OOM will cause exit after sqlite3Select() */
26973535ec3eSdrh           assert( pEList!=0 );
26983535ec3eSdrh           assert( pEList->nExpr>0 );
26992ec2fb22Sdrh           assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
270071c57db0Sdan           for(i=0; i<nVal; i++){
2701773d3afaSdan             Expr *p = sqlite3VectorFieldSubexpr(pLeft, i);
270271c57db0Sdan             pKeyInfo->aColl[i] = sqlite3BinaryCompareCollSeq(
270371c57db0Sdan                 pParse, p, pEList->a[i].pExpr
270471c57db0Sdan             );
270571c57db0Sdan           }
270671c57db0Sdan         }
2707a7d2db17Sdrh       }else if( ALWAYS(pExpr->x.pList!=0) ){
2708fef5208cSdrh         /* Case 2:     expr IN (exprlist)
2709fef5208cSdrh         **
2710e014a838Sdanielk1977         ** For each expression, build an index key from the evaluation and
2711e014a838Sdanielk1977         ** store it in the temporary table. If <expr> is a column, then use
2712e014a838Sdanielk1977         ** that columns affinity when building index keys. If <expr> is not
2713e014a838Sdanielk1977         ** a column, use numeric affinity.
2714fef5208cSdrh         */
271571c57db0Sdan         char affinity;            /* Affinity of the LHS of the IN */
2716e014a838Sdanielk1977         int i;
27176ab3a2ecSdanielk1977         ExprList *pList = pExpr->x.pList;
271857dbd7b3Sdrh         struct ExprList_item *pItem;
2719ecc31805Sdrh         int r1, r2, r3;
272071c57db0Sdan         affinity = sqlite3ExprAffinity(pLeft);
2721e014a838Sdanielk1977         if( !affinity ){
272205883a34Sdrh           affinity = SQLITE_AFF_BLOB;
2723e014a838Sdanielk1977         }
2724323df790Sdrh         if( pKeyInfo ){
27252ec2fb22Sdrh           assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
2726323df790Sdrh           pKeyInfo->aColl[0] = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
2727323df790Sdrh         }
2728e014a838Sdanielk1977 
2729e014a838Sdanielk1977         /* Loop through each expression in <exprlist>. */
27302d401ab8Sdrh         r1 = sqlite3GetTempReg(pParse);
27312d401ab8Sdrh         r2 = sqlite3GetTempReg(pParse);
273221cd29abSdan         if( isRowid ) sqlite3VdbeAddOp4(v, OP_Blob, 0, r2, 0, "", P4_STATIC);
273357dbd7b3Sdrh         for(i=pList->nExpr, pItem=pList->a; i>0; i--, pItem++){
273457dbd7b3Sdrh           Expr *pE2 = pItem->pExpr;
2735e05c929bSdrh           int iValToIns;
2736e014a838Sdanielk1977 
273757dbd7b3Sdrh           /* If the expression is not constant then we will need to
273857dbd7b3Sdrh           ** disable the test that was generated above that makes sure
273957dbd7b3Sdrh           ** this code only executes once.  Because for a non-constant
274057dbd7b3Sdrh           ** expression we need to rerun this code each time.
274157dbd7b3Sdrh           */
27426be515ebSdrh           if( jmpIfDynamic>=0 && !sqlite3ExprIsConstant(pE2) ){
27436be515ebSdrh             sqlite3VdbeChangeToNoop(v, jmpIfDynamic);
27446be515ebSdrh             jmpIfDynamic = -1;
27454794b980Sdrh           }
2746e014a838Sdanielk1977 
2747e014a838Sdanielk1977           /* Evaluate the expression and insert it into the temp table */
2748e05c929bSdrh           if( isRowid && sqlite3ExprIsInteger(pE2, &iValToIns) ){
2749e05c929bSdrh             sqlite3VdbeAddOp3(v, OP_InsertInt, pExpr->iTable, r2, iValToIns);
2750e05c929bSdrh           }else{
2751ecc31805Sdrh             r3 = sqlite3ExprCodeTarget(pParse, pE2, r1);
275241a05b7bSdanielk1977             if( isRowid ){
2753e05c929bSdrh               sqlite3VdbeAddOp2(v, OP_MustBeInt, r3,
2754e05c929bSdrh                                 sqlite3VdbeCurrentAddr(v)+2);
2755688852abSdrh               VdbeCoverage(v);
275641a05b7bSdanielk1977               sqlite3VdbeAddOp3(v, OP_Insert, pExpr->iTable, r2, r3);
275741a05b7bSdanielk1977             }else{
2758ecc31805Sdrh               sqlite3VdbeAddOp4(v, OP_MakeRecord, r3, 1, r2, &affinity, 1);
27593c31fc23Sdrh               sqlite3ExprCacheAffinityChange(pParse, r3, 1);
27609b4eaebcSdrh               sqlite3VdbeAddOp4Int(v, OP_IdxInsert, pExpr->iTable, r2, r3, 1);
2761fef5208cSdrh             }
276241a05b7bSdanielk1977           }
2763e05c929bSdrh         }
27642d401ab8Sdrh         sqlite3ReleaseTempReg(pParse, r1);
27652d401ab8Sdrh         sqlite3ReleaseTempReg(pParse, r2);
2766fef5208cSdrh       }
2767323df790Sdrh       if( pKeyInfo ){
27682ec2fb22Sdrh         sqlite3VdbeChangeP4(v, addr, (void *)pKeyInfo, P4_KEYINFO);
276941a05b7bSdanielk1977       }
2770b3bce662Sdanielk1977       break;
2771fef5208cSdrh     }
2772fef5208cSdrh 
277351522cd3Sdrh     case TK_EXISTS:
2774fd773cf9Sdrh     case TK_SELECT:
2775fd773cf9Sdrh     default: {
277639a11819Sdrh       /* Case 3:    (SELECT ... FROM ...)
277739a11819Sdrh       **     or:    EXISTS(SELECT ... FROM ...)
277839a11819Sdrh       **
277939a11819Sdrh       ** For a SELECT, generate code to put the values for all columns of
278039a11819Sdrh       ** the first row into an array of registers and return the index of
278139a11819Sdrh       ** the first register.
278239a11819Sdrh       **
278339a11819Sdrh       ** If this is an EXISTS, write an integer 0 (not exists) or 1 (exists)
278439a11819Sdrh       ** into a register and return that register number.
278539a11819Sdrh       **
278639a11819Sdrh       ** In both cases, the query is augmented with "LIMIT 1".  Any
278739a11819Sdrh       ** preexisting limit is discarded in place of the new LIMIT 1.
2788fef5208cSdrh       */
2789fd773cf9Sdrh       Select *pSel;                         /* SELECT statement to encode */
279039a11819Sdrh       SelectDest dest;                      /* How to deal with SELECT result */
279171c57db0Sdan       int nReg;                             /* Registers to allocate */
27928c0833fbSdrh       Expr *pLimit;                         /* New limit expression */
27931398ad36Sdrh 
2794cf697396Sshane       testcase( pExpr->op==TK_EXISTS );
2795cf697396Sshane       testcase( pExpr->op==TK_SELECT );
2796cf697396Sshane       assert( pExpr->op==TK_EXISTS || pExpr->op==TK_SELECT );
27976ab3a2ecSdanielk1977       assert( ExprHasProperty(pExpr, EP_xIsSelect) );
279871c57db0Sdan 
27996ab3a2ecSdanielk1977       pSel = pExpr->x.pSelect;
2800e2ca99c9Sdrh       ExplainQueryPlan((pParse, 1, "%sSCALAR SUBQUERY",
2801e2ca99c9Sdrh             jmpIfDynamic>=0?"":"CORRELATED "));
280271c57db0Sdan       nReg = pExpr->op==TK_SELECT ? pSel->pEList->nExpr : 1;
280371c57db0Sdan       sqlite3SelectDestInit(&dest, 0, pParse->nMem+1);
280471c57db0Sdan       pParse->nMem += nReg;
280551522cd3Sdrh       if( pExpr->op==TK_SELECT ){
28066c8c8ce0Sdanielk1977         dest.eDest = SRT_Mem;
280753932ce8Sdrh         dest.iSdst = dest.iSDParm;
280871c57db0Sdan         dest.nSdst = nReg;
280971c57db0Sdan         sqlite3VdbeAddOp3(v, OP_Null, 0, dest.iSDParm, dest.iSDParm+nReg-1);
2810d4e70ebdSdrh         VdbeComment((v, "Init subquery result"));
281151522cd3Sdrh       }else{
28126c8c8ce0Sdanielk1977         dest.eDest = SRT_Exists;
28132b596da8Sdrh         sqlite3VdbeAddOp2(v, OP_Integer, 0, dest.iSDParm);
2814d4e70ebdSdrh         VdbeComment((v, "Init EXISTS result"));
281551522cd3Sdrh       }
28168c0833fbSdrh       pLimit = sqlite3ExprAlloc(pParse->db, TK_INTEGER,&sqlite3IntTokens[1], 0);
28178c0833fbSdrh       if( pSel->pLimit ){
28188c0833fbSdrh         sqlite3ExprDelete(pParse->db, pSel->pLimit->pLeft);
28198c0833fbSdrh         pSel->pLimit->pLeft = pLimit;
28208c0833fbSdrh       }else{
28218c0833fbSdrh         pSel->pLimit = sqlite3PExpr(pParse, TK_LIMIT, pLimit, 0);
28228c0833fbSdrh       }
282348b5b041Sdrh       pSel->iLimit = 0;
28247d10d5a6Sdrh       if( sqlite3Select(pParse, pSel, &dest) ){
28251450bc6eSdrh         return 0;
282694ccde58Sdrh       }
28272b596da8Sdrh       rReg = dest.iSDParm;
2828ebb6a65dSdrh       ExprSetVVAProperty(pExpr, EP_NoReduce);
2829b3bce662Sdanielk1977       break;
283019a775c2Sdrh     }
2831cce7d176Sdrh   }
2832b3bce662Sdanielk1977 
28336be515ebSdrh   if( rHasNullFlag ){
28346be515ebSdrh     sqlite3SetHasNullFlag(v, pExpr->iTable, rHasNullFlag);
2835b3bce662Sdanielk1977   }
28366be515ebSdrh 
28376be515ebSdrh   if( jmpIfDynamic>=0 ){
28386be515ebSdrh     sqlite3VdbeJumpHere(v, jmpIfDynamic);
2839b3bce662Sdanielk1977   }
2840d2490904Sdrh   sqlite3ExprCachePop(pParse);
2841fc976065Sdanielk1977 
28421450bc6eSdrh   return rReg;
2843cce7d176Sdrh }
284451522cd3Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
2845cce7d176Sdrh 
2846e3365e6cSdrh #ifndef SQLITE_OMIT_SUBQUERY
2847e3365e6cSdrh /*
28487b35a77bSdan ** Expr pIn is an IN(...) expression. This function checks that the
28497b35a77bSdan ** sub-select on the RHS of the IN() operator has the same number of
28507b35a77bSdan ** columns as the vector on the LHS. Or, if the RHS of the IN() is not
28517b35a77bSdan ** a sub-query, that the LHS is a vector of size 1.
28527b35a77bSdan */
28537b35a77bSdan int sqlite3ExprCheckIN(Parse *pParse, Expr *pIn){
28547b35a77bSdan   int nVector = sqlite3ExprVectorSize(pIn->pLeft);
28557b35a77bSdan   if( (pIn->flags & EP_xIsSelect) ){
28567b35a77bSdan     if( nVector!=pIn->x.pSelect->pEList->nExpr ){
28577b35a77bSdan       sqlite3SubselectError(pParse, pIn->x.pSelect->pEList->nExpr, nVector);
28587b35a77bSdan       return 1;
28597b35a77bSdan     }
28607b35a77bSdan   }else if( nVector!=1 ){
286144c5604cSdan     sqlite3VectorErrorMsg(pParse, pIn->pLeft);
28627b35a77bSdan     return 1;
28637b35a77bSdan   }
28647b35a77bSdan   return 0;
28657b35a77bSdan }
28667b35a77bSdan #endif
28677b35a77bSdan 
28687b35a77bSdan #ifndef SQLITE_OMIT_SUBQUERY
28697b35a77bSdan /*
2870e3365e6cSdrh ** Generate code for an IN expression.
2871e3365e6cSdrh **
2872e3365e6cSdrh **      x IN (SELECT ...)
2873e3365e6cSdrh **      x IN (value, value, ...)
2874e3365e6cSdrh **
2875ecb87ac8Sdrh ** The left-hand side (LHS) is a scalar or vector expression.  The
2876e347d3e8Sdrh ** right-hand side (RHS) is an array of zero or more scalar values, or a
2877e347d3e8Sdrh ** subquery.  If the RHS is a subquery, the number of result columns must
2878e347d3e8Sdrh ** match the number of columns in the vector on the LHS.  If the RHS is
2879e347d3e8Sdrh ** a list of values, the LHS must be a scalar.
2880e347d3e8Sdrh **
2881e347d3e8Sdrh ** The IN operator is true if the LHS value is contained within the RHS.
2882e347d3e8Sdrh ** The result is false if the LHS is definitely not in the RHS.  The
2883e347d3e8Sdrh ** result is NULL if the presence of the LHS in the RHS cannot be
2884e347d3e8Sdrh ** determined due to NULLs.
2885e3365e6cSdrh **
28866be515ebSdrh ** This routine generates code that jumps to destIfFalse if the LHS is not
2887e3365e6cSdrh ** contained within the RHS.  If due to NULLs we cannot determine if the LHS
2888e3365e6cSdrh ** is contained in the RHS then jump to destIfNull.  If the LHS is contained
2889e3365e6cSdrh ** within the RHS then fall through.
2890ecb87ac8Sdrh **
2891ecb87ac8Sdrh ** See the separate in-operator.md documentation file in the canonical
2892ecb87ac8Sdrh ** SQLite source tree for additional information.
2893e3365e6cSdrh */
2894e3365e6cSdrh static void sqlite3ExprCodeIN(
2895e3365e6cSdrh   Parse *pParse,        /* Parsing and code generating context */
2896e3365e6cSdrh   Expr *pExpr,          /* The IN expression */
2897e3365e6cSdrh   int destIfFalse,      /* Jump here if LHS is not contained in the RHS */
2898e3365e6cSdrh   int destIfNull        /* Jump here if the results are unknown due to NULLs */
2899e3365e6cSdrh ){
2900e3365e6cSdrh   int rRhsHasNull = 0;  /* Register that is true if RHS contains NULL values */
2901e3365e6cSdrh   int eType;            /* Type of the RHS */
2902e347d3e8Sdrh   int rLhs;             /* Register(s) holding the LHS values */
2903e347d3e8Sdrh   int rLhsOrig;         /* LHS values prior to reordering by aiMap[] */
2904e3365e6cSdrh   Vdbe *v;              /* Statement under construction */
2905ba00e30aSdan   int *aiMap = 0;       /* Map from vector field to index column */
2906ba00e30aSdan   char *zAff = 0;       /* Affinity string for comparisons */
2907ecb87ac8Sdrh   int nVector;          /* Size of vectors for this IN operator */
290812abf408Sdrh   int iDummy;           /* Dummy parameter to exprCodeVector() */
2909e347d3e8Sdrh   Expr *pLeft;          /* The LHS of the IN operator */
2910ecb87ac8Sdrh   int i;                /* loop counter */
2911e347d3e8Sdrh   int destStep2;        /* Where to jump when NULLs seen in step 2 */
2912e347d3e8Sdrh   int destStep6 = 0;    /* Start of code for Step 6 */
2913e347d3e8Sdrh   int addrTruthOp;      /* Address of opcode that determines the IN is true */
2914e347d3e8Sdrh   int destNotNull;      /* Jump here if a comparison is not true in step 6 */
2915e347d3e8Sdrh   int addrTop;          /* Top of the step-6 loop */
2916e3365e6cSdrh 
2917e347d3e8Sdrh   pLeft = pExpr->pLeft;
29187b35a77bSdan   if( sqlite3ExprCheckIN(pParse, pExpr) ) return;
2919553168c7Sdan   zAff = exprINAffinity(pParse, pExpr);
2920ba00e30aSdan   nVector = sqlite3ExprVectorSize(pExpr->pLeft);
2921ba00e30aSdan   aiMap = (int*)sqlite3DbMallocZero(
2922ba00e30aSdan       pParse->db, nVector*(sizeof(int) + sizeof(char)) + 1
2923ba00e30aSdan   );
2924e347d3e8Sdrh   if( pParse->db->mallocFailed ) goto sqlite3ExprCodeIN_oom_error;
29257b35a77bSdan 
2926ba00e30aSdan   /* Attempt to compute the RHS. After this step, if anything other than
2927ba00e30aSdan   ** IN_INDEX_NOOP is returned, the table opened ith cursor pExpr->iTable
2928ba00e30aSdan   ** contains the values that make up the RHS. If IN_INDEX_NOOP is returned,
2929ba00e30aSdan   ** the RHS has not yet been coded.  */
2930e3365e6cSdrh   v = pParse->pVdbe;
2931e3365e6cSdrh   assert( v!=0 );       /* OOM detected prior to this routine */
2932e3365e6cSdrh   VdbeNoopComment((v, "begin IN expr"));
2933bb53ecb1Sdrh   eType = sqlite3FindInIndex(pParse, pExpr,
2934bb53ecb1Sdrh                              IN_INDEX_MEMBERSHIP | IN_INDEX_NOOP_OK,
2935ba00e30aSdan                              destIfFalse==destIfNull ? 0 : &rRhsHasNull, aiMap);
2936e3365e6cSdrh 
2937ba00e30aSdan   assert( pParse->nErr || nVector==1 || eType==IN_INDEX_EPH
2938ba00e30aSdan        || eType==IN_INDEX_INDEX_ASC || eType==IN_INDEX_INDEX_DESC
2939ba00e30aSdan   );
2940ecb87ac8Sdrh #ifdef SQLITE_DEBUG
2941ecb87ac8Sdrh   /* Confirm that aiMap[] contains nVector integer values between 0 and
2942ecb87ac8Sdrh   ** nVector-1. */
2943ecb87ac8Sdrh   for(i=0; i<nVector; i++){
2944ecb87ac8Sdrh     int j, cnt;
2945ecb87ac8Sdrh     for(cnt=j=0; j<nVector; j++) if( aiMap[j]==i ) cnt++;
2946ecb87ac8Sdrh     assert( cnt==1 );
2947ecb87ac8Sdrh   }
2948ecb87ac8Sdrh #endif
2949e3365e6cSdrh 
2950ba00e30aSdan   /* Code the LHS, the <expr> from "<expr> IN (...)". If the LHS is a
2951ba00e30aSdan   ** vector, then it is stored in an array of nVector registers starting
2952ba00e30aSdan   ** at r1.
2953e347d3e8Sdrh   **
2954e347d3e8Sdrh   ** sqlite3FindInIndex() might have reordered the fields of the LHS vector
2955e347d3e8Sdrh   ** so that the fields are in the same order as an existing index.   The
2956e347d3e8Sdrh   ** aiMap[] array contains a mapping from the original LHS field order to
2957e347d3e8Sdrh   ** the field order that matches the RHS index.
2958e3365e6cSdrh   */
2959e3365e6cSdrh   sqlite3ExprCachePush(pParse);
2960e347d3e8Sdrh   rLhsOrig = exprCodeVector(pParse, pLeft, &iDummy);
2961e347d3e8Sdrh   for(i=0; i<nVector && aiMap[i]==i; i++){} /* Are LHS fields reordered? */
2962ecb87ac8Sdrh   if( i==nVector ){
2963e347d3e8Sdrh     /* LHS fields are not reordered */
2964e347d3e8Sdrh     rLhs = rLhsOrig;
2965ecb87ac8Sdrh   }else{
2966ecb87ac8Sdrh     /* Need to reorder the LHS fields according to aiMap */
2967e347d3e8Sdrh     rLhs = sqlite3GetTempRange(pParse, nVector);
2968ba00e30aSdan     for(i=0; i<nVector; i++){
2969e347d3e8Sdrh       sqlite3VdbeAddOp3(v, OP_Copy, rLhsOrig+i, rLhs+aiMap[i], 0);
2970ba00e30aSdan     }
2971ecb87ac8Sdrh   }
2972e3365e6cSdrh 
2973bb53ecb1Sdrh   /* If sqlite3FindInIndex() did not find or create an index that is
2974bb53ecb1Sdrh   ** suitable for evaluating the IN operator, then evaluate using a
2975bb53ecb1Sdrh   ** sequence of comparisons.
2976e347d3e8Sdrh   **
2977e347d3e8Sdrh   ** This is step (1) in the in-operator.md optimized algorithm.
2978bb53ecb1Sdrh   */
2979bb53ecb1Sdrh   if( eType==IN_INDEX_NOOP ){
2980bb53ecb1Sdrh     ExprList *pList = pExpr->x.pList;
2981bb53ecb1Sdrh     CollSeq *pColl = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
2982bb53ecb1Sdrh     int labelOk = sqlite3VdbeMakeLabel(v);
2983bb53ecb1Sdrh     int r2, regToFree;
2984bb53ecb1Sdrh     int regCkNull = 0;
2985bb53ecb1Sdrh     int ii;
2986bb53ecb1Sdrh     assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
2987bb53ecb1Sdrh     if( destIfNull!=destIfFalse ){
2988bb53ecb1Sdrh       regCkNull = sqlite3GetTempReg(pParse);
2989e347d3e8Sdrh       sqlite3VdbeAddOp3(v, OP_BitAnd, rLhs, rLhs, regCkNull);
2990bb53ecb1Sdrh     }
2991bb53ecb1Sdrh     for(ii=0; ii<pList->nExpr; ii++){
2992bb53ecb1Sdrh       r2 = sqlite3ExprCodeTemp(pParse, pList->a[ii].pExpr, &regToFree);
2993a976979bSdrh       if( regCkNull && sqlite3ExprCanBeNull(pList->a[ii].pExpr) ){
2994bb53ecb1Sdrh         sqlite3VdbeAddOp3(v, OP_BitAnd, regCkNull, r2, regCkNull);
2995bb53ecb1Sdrh       }
2996bb53ecb1Sdrh       if( ii<pList->nExpr-1 || destIfNull!=destIfFalse ){
2997e347d3e8Sdrh         sqlite3VdbeAddOp4(v, OP_Eq, rLhs, labelOk, r2,
29984336b0e6Sdrh                           (void*)pColl, P4_COLLSEQ);
29994336b0e6Sdrh         VdbeCoverageIf(v, ii<pList->nExpr-1);
30004336b0e6Sdrh         VdbeCoverageIf(v, ii==pList->nExpr-1);
3001ba00e30aSdan         sqlite3VdbeChangeP5(v, zAff[0]);
3002bb53ecb1Sdrh       }else{
3003bb53ecb1Sdrh         assert( destIfNull==destIfFalse );
3004e347d3e8Sdrh         sqlite3VdbeAddOp4(v, OP_Ne, rLhs, destIfFalse, r2,
3005bb53ecb1Sdrh                           (void*)pColl, P4_COLLSEQ); VdbeCoverage(v);
3006ba00e30aSdan         sqlite3VdbeChangeP5(v, zAff[0] | SQLITE_JUMPIFNULL);
3007bb53ecb1Sdrh       }
3008bb53ecb1Sdrh       sqlite3ReleaseTempReg(pParse, regToFree);
3009bb53ecb1Sdrh     }
3010bb53ecb1Sdrh     if( regCkNull ){
3011bb53ecb1Sdrh       sqlite3VdbeAddOp2(v, OP_IsNull, regCkNull, destIfNull); VdbeCoverage(v);
3012076e85f5Sdrh       sqlite3VdbeGoto(v, destIfFalse);
3013bb53ecb1Sdrh     }
3014bb53ecb1Sdrh     sqlite3VdbeResolveLabel(v, labelOk);
3015bb53ecb1Sdrh     sqlite3ReleaseTempReg(pParse, regCkNull);
3016e347d3e8Sdrh     goto sqlite3ExprCodeIN_finished;
3017e347d3e8Sdrh   }
3018bb53ecb1Sdrh 
3019e347d3e8Sdrh   /* Step 2: Check to see if the LHS contains any NULL columns.  If the
3020e347d3e8Sdrh   ** LHS does contain NULLs then the result must be either FALSE or NULL.
3021e347d3e8Sdrh   ** We will then skip the binary search of the RHS.
3022e347d3e8Sdrh   */
3023094430ebSdrh   if( destIfNull==destIfFalse ){
3024e347d3e8Sdrh     destStep2 = destIfFalse;
3025e347d3e8Sdrh   }else{
3026e347d3e8Sdrh     destStep2 = destStep6 = sqlite3VdbeMakeLabel(v);
3027e347d3e8Sdrh   }
3028d49fd4e8Sdan   for(i=0; i<nVector; i++){
3029fc7f27b9Sdrh     Expr *p = sqlite3VectorFieldSubexpr(pExpr->pLeft, i);
3030d49fd4e8Sdan     if( sqlite3ExprCanBeNull(p) ){
3031e347d3e8Sdrh       sqlite3VdbeAddOp2(v, OP_IsNull, rLhs+i, destStep2);
3032471b4b92Sdrh       VdbeCoverage(v);
3033d49fd4e8Sdan     }
3034d49fd4e8Sdan   }
3035e3365e6cSdrh 
3036e347d3e8Sdrh   /* Step 3.  The LHS is now known to be non-NULL.  Do the binary search
3037e347d3e8Sdrh   ** of the RHS using the LHS as a probe.  If found, the result is
3038e347d3e8Sdrh   ** true.
3039e347d3e8Sdrh   */
3040e3365e6cSdrh   if( eType==IN_INDEX_ROWID ){
3041e347d3e8Sdrh     /* In this case, the RHS is the ROWID of table b-tree and so we also
3042e347d3e8Sdrh     ** know that the RHS is non-NULL.  Hence, we combine steps 3 and 4
3043e347d3e8Sdrh     ** into a single opcode. */
3044e347d3e8Sdrh     sqlite3VdbeAddOp3(v, OP_SeekRowid, pExpr->iTable, destIfFalse, rLhs);
3045688852abSdrh     VdbeCoverage(v);
3046e347d3e8Sdrh     addrTruthOp = sqlite3VdbeAddOp0(v, OP_Goto);  /* Return True */
30477b35a77bSdan   }else{
3048e347d3e8Sdrh     sqlite3VdbeAddOp4(v, OP_Affinity, rLhs, nVector, 0, zAff, nVector);
3049e347d3e8Sdrh     if( destIfFalse==destIfNull ){
3050e347d3e8Sdrh       /* Combine Step 3 and Step 5 into a single opcode */
3051e347d3e8Sdrh       sqlite3VdbeAddOp4Int(v, OP_NotFound, pExpr->iTable, destIfFalse,
3052e347d3e8Sdrh                            rLhs, nVector); VdbeCoverage(v);
3053e347d3e8Sdrh       goto sqlite3ExprCodeIN_finished;
3054e347d3e8Sdrh     }
3055e347d3e8Sdrh     /* Ordinary Step 3, for the case where FALSE and NULL are distinct */
3056e347d3e8Sdrh     addrTruthOp = sqlite3VdbeAddOp4Int(v, OP_Found, pExpr->iTable, 0,
3057e347d3e8Sdrh                                       rLhs, nVector); VdbeCoverage(v);
3058e347d3e8Sdrh   }
3059ba00e30aSdan 
3060e347d3e8Sdrh   /* Step 4.  If the RHS is known to be non-NULL and we did not find
3061e347d3e8Sdrh   ** an match on the search above, then the result must be FALSE.
3062e347d3e8Sdrh   */
3063e347d3e8Sdrh   if( rRhsHasNull && nVector==1 ){
3064e347d3e8Sdrh     sqlite3VdbeAddOp2(v, OP_NotNull, rRhsHasNull, destIfFalse);
3065471b4b92Sdrh     VdbeCoverage(v);
3066e347d3e8Sdrh   }
30677b35a77bSdan 
3068e347d3e8Sdrh   /* Step 5.  If we do not care about the difference between NULL and
3069e347d3e8Sdrh   ** FALSE, then just return false.
3070e347d3e8Sdrh   */
3071e347d3e8Sdrh   if( destIfFalse==destIfNull ) sqlite3VdbeGoto(v, destIfFalse);
3072e347d3e8Sdrh 
3073e347d3e8Sdrh   /* Step 6: Loop through rows of the RHS.  Compare each row to the LHS.
3074e347d3e8Sdrh   ** If any comparison is NULL, then the result is NULL.  If all
3075e347d3e8Sdrh   ** comparisons are FALSE then the final result is FALSE.
3076e347d3e8Sdrh   **
3077e347d3e8Sdrh   ** For a scalar LHS, it is sufficient to check just the first row
3078e347d3e8Sdrh   ** of the RHS.
3079e347d3e8Sdrh   */
3080e347d3e8Sdrh   if( destStep6 ) sqlite3VdbeResolveLabel(v, destStep6);
3081e347d3e8Sdrh   addrTop = sqlite3VdbeAddOp2(v, OP_Rewind, pExpr->iTable, destIfFalse);
3082471b4b92Sdrh   VdbeCoverage(v);
3083e347d3e8Sdrh   if( nVector>1 ){
3084e347d3e8Sdrh     destNotNull = sqlite3VdbeMakeLabel(v);
3085e347d3e8Sdrh   }else{
3086e347d3e8Sdrh     /* For nVector==1, combine steps 6 and 7 by immediately returning
3087e347d3e8Sdrh     ** FALSE if the first comparison is not NULL */
3088e347d3e8Sdrh     destNotNull = destIfFalse;
3089e347d3e8Sdrh   }
3090ba00e30aSdan   for(i=0; i<nVector; i++){
3091ba00e30aSdan     Expr *p;
3092ba00e30aSdan     CollSeq *pColl;
3093e347d3e8Sdrh     int r3 = sqlite3GetTempReg(pParse);
3094fc7f27b9Sdrh     p = sqlite3VectorFieldSubexpr(pLeft, i);
3095ba00e30aSdan     pColl = sqlite3ExprCollSeq(pParse, p);
3096e347d3e8Sdrh     sqlite3VdbeAddOp3(v, OP_Column, pExpr->iTable, i, r3);
3097e347d3e8Sdrh     sqlite3VdbeAddOp4(v, OP_Ne, rLhs+i, destNotNull, r3,
309818016ad2Sdrh                       (void*)pColl, P4_COLLSEQ);
3099471b4b92Sdrh     VdbeCoverage(v);
3100e347d3e8Sdrh     sqlite3ReleaseTempReg(pParse, r3);
31017b35a77bSdan   }
31027b35a77bSdan   sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfNull);
3103e347d3e8Sdrh   if( nVector>1 ){
3104e347d3e8Sdrh     sqlite3VdbeResolveLabel(v, destNotNull);
3105e347d3e8Sdrh     sqlite3VdbeAddOp2(v, OP_Next, pExpr->iTable, addrTop+1);
310618016ad2Sdrh     VdbeCoverage(v);
3107e347d3e8Sdrh 
3108e347d3e8Sdrh     /* Step 7:  If we reach this point, we know that the result must
3109e347d3e8Sdrh     ** be false. */
311018016ad2Sdrh     sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfFalse);
31117b35a77bSdan   }
31127b35a77bSdan 
3113e347d3e8Sdrh   /* Jumps here in order to return true. */
3114e347d3e8Sdrh   sqlite3VdbeJumpHere(v, addrTruthOp);
3115e3365e6cSdrh 
3116e347d3e8Sdrh sqlite3ExprCodeIN_finished:
3117e347d3e8Sdrh   if( rLhs!=rLhsOrig ) sqlite3ReleaseTempReg(pParse, rLhs);
3118d2490904Sdrh   sqlite3ExprCachePop(pParse);
3119ecb87ac8Sdrh   VdbeComment((v, "end IN expr"));
3120e347d3e8Sdrh sqlite3ExprCodeIN_oom_error:
3121ba00e30aSdan   sqlite3DbFree(pParse->db, aiMap);
3122553168c7Sdan   sqlite3DbFree(pParse->db, zAff);
3123e3365e6cSdrh }
3124e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
3125e3365e6cSdrh 
312613573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
3127598f1340Sdrh /*
3128598f1340Sdrh ** Generate an instruction that will put the floating point
31299cbf3425Sdrh ** value described by z[0..n-1] into register iMem.
31300cf19ed8Sdrh **
31310cf19ed8Sdrh ** The z[] string will probably not be zero-terminated.  But the
31320cf19ed8Sdrh ** z[n] character is guaranteed to be something that does not look
31330cf19ed8Sdrh ** like the continuation of the number.
3134598f1340Sdrh */
3135b7916a78Sdrh static void codeReal(Vdbe *v, const char *z, int negateFlag, int iMem){
3136fd773cf9Sdrh   if( ALWAYS(z!=0) ){
3137598f1340Sdrh     double value;
31389339da1fSdrh     sqlite3AtoF(z, &value, sqlite3Strlen30(z), SQLITE_UTF8);
3139d0015161Sdrh     assert( !sqlite3IsNaN(value) ); /* The new AtoF never returns NaN */
3140598f1340Sdrh     if( negateFlag ) value = -value;
314197bae794Sdrh     sqlite3VdbeAddOp4Dup8(v, OP_Real, 0, iMem, 0, (u8*)&value, P4_REAL);
3142598f1340Sdrh   }
3143598f1340Sdrh }
314413573c71Sdrh #endif
3145598f1340Sdrh 
3146598f1340Sdrh 
3147598f1340Sdrh /*
3148fec19aadSdrh ** Generate an instruction that will put the integer describe by
31499cbf3425Sdrh ** text z[0..n-1] into register iMem.
31500cf19ed8Sdrh **
31515f1d6b61Sshaneh ** Expr.u.zToken is always UTF8 and zero-terminated.
3152fec19aadSdrh */
315313573c71Sdrh static void codeInteger(Parse *pParse, Expr *pExpr, int negFlag, int iMem){
315413573c71Sdrh   Vdbe *v = pParse->pVdbe;
315592b01d53Sdrh   if( pExpr->flags & EP_IntValue ){
315633e619fcSdrh     int i = pExpr->u.iValue;
3157d50ffc41Sdrh     assert( i>=0 );
315892b01d53Sdrh     if( negFlag ) i = -i;
315992b01d53Sdrh     sqlite3VdbeAddOp2(v, OP_Integer, i, iMem);
3160fd773cf9Sdrh   }else{
31615f1d6b61Sshaneh     int c;
31625f1d6b61Sshaneh     i64 value;
3163fd773cf9Sdrh     const char *z = pExpr->u.zToken;
3164fd773cf9Sdrh     assert( z!=0 );
31659296c18aSdrh     c = sqlite3DecOrHexToI64(z, &value);
316684d4f1a3Sdrh     if( (c==3 && !negFlag) || (c==2) || (negFlag && value==SMALLEST_INT64)){
316713573c71Sdrh #ifdef SQLITE_OMIT_FLOATING_POINT
316813573c71Sdrh       sqlite3ErrorMsg(pParse, "oversized integer: %s%s", negFlag ? "-" : "", z);
316913573c71Sdrh #else
31701b7ddc59Sdrh #ifndef SQLITE_OMIT_HEX_INTEGER
31719296c18aSdrh       if( sqlite3_strnicmp(z,"0x",2)==0 ){
317277320ea4Sdrh         sqlite3ErrorMsg(pParse, "hex literal too big: %s%s", negFlag?"-":"",z);
31731b7ddc59Sdrh       }else
31741b7ddc59Sdrh #endif
31751b7ddc59Sdrh       {
3176b7916a78Sdrh         codeReal(v, z, negFlag, iMem);
31779296c18aSdrh       }
317813573c71Sdrh #endif
317977320ea4Sdrh     }else{
318084d4f1a3Sdrh       if( negFlag ){ value = c==3 ? SMALLEST_INT64 : -value; }
318177320ea4Sdrh       sqlite3VdbeAddOp4Dup8(v, OP_Int64, 0, iMem, 0, (u8*)&value, P4_INT64);
3182fec19aadSdrh     }
3183fec19aadSdrh   }
3184c9cf901dSdanielk1977 }
3185fec19aadSdrh 
3186bea119cdSdrh /*
31879b40d13fSdrh ** Erase column-cache entry number i
3188bea119cdSdrh */
31899b40d13fSdrh static void cacheEntryClear(Parse *pParse, int i){
31909b40d13fSdrh   if( pParse->aColCache[i].tempReg ){
3191ceea3321Sdrh     if( pParse->nTempReg<ArraySize(pParse->aTempReg) ){
31929b40d13fSdrh       pParse->aTempReg[pParse->nTempReg++] = pParse->aColCache[i].iReg;
3193ceea3321Sdrh     }
3194ceea3321Sdrh   }
3195bea119cdSdrh   pParse->nColCache--;
31969b40d13fSdrh   if( i<pParse->nColCache ){
31979b40d13fSdrh     pParse->aColCache[i] = pParse->aColCache[pParse->nColCache];
31989b40d13fSdrh   }
3199ceea3321Sdrh }
3200ceea3321Sdrh 
3201ceea3321Sdrh 
3202ceea3321Sdrh /*
3203ceea3321Sdrh ** Record in the column cache that a particular column from a
3204ceea3321Sdrh ** particular table is stored in a particular register.
3205ceea3321Sdrh */
3206ceea3321Sdrh void sqlite3ExprCacheStore(Parse *pParse, int iTab, int iCol, int iReg){
3207ceea3321Sdrh   int i;
3208ceea3321Sdrh   int minLru;
3209ceea3321Sdrh   int idxLru;
3210ceea3321Sdrh   struct yColCache *p;
3211ceea3321Sdrh 
3212ce8f53d4Sdan   /* Unless an error has occurred, register numbers are always positive. */
3213ce8f53d4Sdan   assert( iReg>0 || pParse->nErr || pParse->db->mallocFailed );
321420411ea7Sdrh   assert( iCol>=-1 && iCol<32768 );  /* Finite column numbers */
321520411ea7Sdrh 
3216b6da74ebSdrh   /* The SQLITE_ColumnCache flag disables the column cache.  This is used
3217b6da74ebSdrh   ** for testing only - to verify that SQLite always gets the same answer
3218b6da74ebSdrh   ** with and without the column cache.
3219b6da74ebSdrh   */
32207e5418e4Sdrh   if( OptimizationDisabled(pParse->db, SQLITE_ColumnCache) ) return;
3221b6da74ebSdrh 
322227ee406eSdrh   /* First replace any existing entry.
322327ee406eSdrh   **
322427ee406eSdrh   ** Actually, the way the column cache is currently used, we are guaranteed
322527ee406eSdrh   ** that the object will never already be in cache.  Verify this guarantee.
322627ee406eSdrh   */
322727ee406eSdrh #ifndef NDEBUG
32289b40d13fSdrh   for(i=0, p=pParse->aColCache; i<pParse->nColCache; i++, p++){
32299b40d13fSdrh     assert( p->iTable!=iTab || p->iColumn!=iCol );
3230ceea3321Sdrh   }
323127ee406eSdrh #endif
3232ceea3321Sdrh 
3233299bf7c2Sdrh #ifdef SQLITE_DEBUG_COLUMNCACHE
3234299bf7c2Sdrh   /* Add a SetTabCol opcode for run-time verification that the column
3235299bf7c2Sdrh   ** cache is working correctly.
3236299bf7c2Sdrh   */
3237299bf7c2Sdrh   sqlite3VdbeAddOp3(pParse->pVdbe, OP_SetTabCol, iTab, iCol, iReg);
3238299bf7c2Sdrh #endif
3239299bf7c2Sdrh 
32409b40d13fSdrh   /* If the cache is already full, delete the least recently used entry */
32419b40d13fSdrh   if( pParse->nColCache>=SQLITE_N_COLCACHE ){
3242ceea3321Sdrh     minLru = 0x7fffffff;
3243ceea3321Sdrh     idxLru = -1;
3244ceea3321Sdrh     for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
3245ceea3321Sdrh       if( p->lru<minLru ){
3246ceea3321Sdrh         idxLru = i;
3247ceea3321Sdrh         minLru = p->lru;
3248ceea3321Sdrh       }
3249ceea3321Sdrh     }
3250ceea3321Sdrh     p = &pParse->aColCache[idxLru];
32519b40d13fSdrh   }else{
32529b40d13fSdrh     p = &pParse->aColCache[pParse->nColCache++];
32539b40d13fSdrh   }
32549b40d13fSdrh 
32559b40d13fSdrh   /* Add the new entry to the end of the cache */
3256ceea3321Sdrh   p->iLevel = pParse->iCacheLevel;
3257ceea3321Sdrh   p->iTable = iTab;
3258ceea3321Sdrh   p->iColumn = iCol;
3259ceea3321Sdrh   p->iReg = iReg;
3260ceea3321Sdrh   p->tempReg = 0;
3261ceea3321Sdrh   p->lru = pParse->iCacheCnt++;
3262ceea3321Sdrh }
3263ceea3321Sdrh 
3264ceea3321Sdrh /*
3265f49f3523Sdrh ** Indicate that registers between iReg..iReg+nReg-1 are being overwritten.
3266f49f3523Sdrh ** Purge the range of registers from the column cache.
3267ceea3321Sdrh */
3268f49f3523Sdrh void sqlite3ExprCacheRemove(Parse *pParse, int iReg, int nReg){
32699b40d13fSdrh   int i = 0;
32709b40d13fSdrh   while( i<pParse->nColCache ){
32719b40d13fSdrh     struct yColCache *p = &pParse->aColCache[i];
32729b40d13fSdrh     if( p->iReg >= iReg && p->iReg < iReg+nReg ){
32739b40d13fSdrh       cacheEntryClear(pParse, i);
32749b40d13fSdrh     }else{
32759b40d13fSdrh       i++;
32769b40d13fSdrh     }
3277ceea3321Sdrh   }
3278ceea3321Sdrh }
3279ceea3321Sdrh 
3280ceea3321Sdrh /*
3281ceea3321Sdrh ** Remember the current column cache context.  Any new entries added
3282ceea3321Sdrh ** added to the column cache after this call are removed when the
3283ceea3321Sdrh ** corresponding pop occurs.
3284ceea3321Sdrh */
3285ceea3321Sdrh void sqlite3ExprCachePush(Parse *pParse){
3286ceea3321Sdrh   pParse->iCacheLevel++;
32879ac7962aSdrh #ifdef SQLITE_DEBUG
32889ac7962aSdrh   if( pParse->db->flags & SQLITE_VdbeAddopTrace ){
32899ac7962aSdrh     printf("PUSH to %d\n", pParse->iCacheLevel);
32909ac7962aSdrh   }
32919ac7962aSdrh #endif
3292ceea3321Sdrh }
3293ceea3321Sdrh 
3294ceea3321Sdrh /*
3295ceea3321Sdrh ** Remove from the column cache any entries that were added since the
3296d2490904Sdrh ** the previous sqlite3ExprCachePush operation.  In other words, restore
3297d2490904Sdrh ** the cache to the state it was in prior the most recent Push.
3298ceea3321Sdrh */
3299d2490904Sdrh void sqlite3ExprCachePop(Parse *pParse){
33009b40d13fSdrh   int i = 0;
3301d2490904Sdrh   assert( pParse->iCacheLevel>=1 );
3302d2490904Sdrh   pParse->iCacheLevel--;
33039ac7962aSdrh #ifdef SQLITE_DEBUG
33049ac7962aSdrh   if( pParse->db->flags & SQLITE_VdbeAddopTrace ){
33059ac7962aSdrh     printf("POP  to %d\n", pParse->iCacheLevel);
33069ac7962aSdrh   }
33079ac7962aSdrh #endif
33089b40d13fSdrh   while( i<pParse->nColCache ){
33099b40d13fSdrh     if( pParse->aColCache[i].iLevel>pParse->iCacheLevel ){
33109b40d13fSdrh       cacheEntryClear(pParse, i);
33119b40d13fSdrh     }else{
33129b40d13fSdrh       i++;
3313ceea3321Sdrh     }
3314ceea3321Sdrh   }
3315ceea3321Sdrh }
3316945498f3Sdrh 
3317945498f3Sdrh /*
33185cd79239Sdrh ** When a cached column is reused, make sure that its register is
33195cd79239Sdrh ** no longer available as a temp register.  ticket #3879:  that same
33205cd79239Sdrh ** register might be in the cache in multiple places, so be sure to
33215cd79239Sdrh ** get them all.
33225cd79239Sdrh */
33235cd79239Sdrh static void sqlite3ExprCachePinRegister(Parse *pParse, int iReg){
33245cd79239Sdrh   int i;
33255cd79239Sdrh   struct yColCache *p;
33269b40d13fSdrh   for(i=0, p=pParse->aColCache; i<pParse->nColCache; i++, p++){
33275cd79239Sdrh     if( p->iReg==iReg ){
33285cd79239Sdrh       p->tempReg = 0;
33295cd79239Sdrh     }
33305cd79239Sdrh   }
33315cd79239Sdrh }
33325cd79239Sdrh 
33331f9ca2c8Sdrh /* Generate code that will load into register regOut a value that is
33341f9ca2c8Sdrh ** appropriate for the iIdxCol-th column of index pIdx.
33351f9ca2c8Sdrh */
33361f9ca2c8Sdrh void sqlite3ExprCodeLoadIndexColumn(
33371f9ca2c8Sdrh   Parse *pParse,  /* The parsing context */
33381f9ca2c8Sdrh   Index *pIdx,    /* The index whose column is to be loaded */
33391f9ca2c8Sdrh   int iTabCur,    /* Cursor pointing to a table row */
33401f9ca2c8Sdrh   int iIdxCol,    /* The column of the index to be loaded */
33411f9ca2c8Sdrh   int regOut      /* Store the index column value in this register */
33421f9ca2c8Sdrh ){
33431f9ca2c8Sdrh   i16 iTabCol = pIdx->aiColumn[iIdxCol];
33444b92f98cSdrh   if( iTabCol==XN_EXPR ){
33451f9ca2c8Sdrh     assert( pIdx->aColExpr );
33461f9ca2c8Sdrh     assert( pIdx->aColExpr->nExpr>iIdxCol );
33473e34eabcSdrh     pParse->iSelfTab = iTabCur + 1;
33481c75c9d7Sdrh     sqlite3ExprCodeCopy(pParse, pIdx->aColExpr->a[iIdxCol].pExpr, regOut);
33493e34eabcSdrh     pParse->iSelfTab = 0;
33504b92f98cSdrh   }else{
33514b92f98cSdrh     sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pIdx->pTable, iTabCur,
33524b92f98cSdrh                                     iTabCol, regOut);
33534b92f98cSdrh   }
33541f9ca2c8Sdrh }
33551f9ca2c8Sdrh 
33565cd79239Sdrh /*
33575c092e8aSdrh ** Generate code to extract the value of the iCol-th column of a table.
33585c092e8aSdrh */
33595c092e8aSdrh void sqlite3ExprCodeGetColumnOfTable(
33605c092e8aSdrh   Vdbe *v,        /* The VDBE under construction */
33615c092e8aSdrh   Table *pTab,    /* The table containing the value */
3362313619f5Sdrh   int iTabCur,    /* The table cursor.  Or the PK cursor for WITHOUT ROWID */
33635c092e8aSdrh   int iCol,       /* Index of the column to extract */
3364313619f5Sdrh   int regOut      /* Extract the value into this register */
33655c092e8aSdrh ){
3366aca19e19Sdrh   if( pTab==0 ){
3367aca19e19Sdrh     sqlite3VdbeAddOp3(v, OP_Column, iTabCur, iCol, regOut);
3368aca19e19Sdrh     return;
3369aca19e19Sdrh   }
33705c092e8aSdrh   if( iCol<0 || iCol==pTab->iPKey ){
33715c092e8aSdrh     sqlite3VdbeAddOp2(v, OP_Rowid, iTabCur, regOut);
33725c092e8aSdrh   }else{
33735c092e8aSdrh     int op = IsVirtual(pTab) ? OP_VColumn : OP_Column;
3374ee0ec8e1Sdrh     int x = iCol;
337535db31b2Sdrh     if( !HasRowid(pTab) && !IsVirtual(pTab) ){
3376ee0ec8e1Sdrh       x = sqlite3ColumnOfIndex(sqlite3PrimaryKeyIndex(pTab), iCol);
3377ee0ec8e1Sdrh     }
3378ee0ec8e1Sdrh     sqlite3VdbeAddOp3(v, op, iTabCur, x, regOut);
33795c092e8aSdrh   }
33805c092e8aSdrh   if( iCol>=0 ){
33815c092e8aSdrh     sqlite3ColumnDefault(v, pTab, iCol, regOut);
33825c092e8aSdrh   }
33835c092e8aSdrh }
33845c092e8aSdrh 
33855c092e8aSdrh /*
3386945498f3Sdrh ** Generate code that will extract the iColumn-th column from
3387ce78bc6eSdrh ** table pTab and store the column value in a register.
3388ce78bc6eSdrh **
3389ce78bc6eSdrh ** An effort is made to store the column value in register iReg.  This
3390ce78bc6eSdrh ** is not garanteeed for GetColumn() - the result can be stored in
3391ce78bc6eSdrh ** any register.  But the result is guaranteed to land in register iReg
3392ce78bc6eSdrh ** for GetColumnToReg().
3393e55cbd72Sdrh **
3394e55cbd72Sdrh ** There must be an open cursor to pTab in iTable when this routine
3395e55cbd72Sdrh ** is called.  If iColumn<0 then code is generated that extracts the rowid.
3396945498f3Sdrh */
3397e55cbd72Sdrh int sqlite3ExprCodeGetColumn(
3398e55cbd72Sdrh   Parse *pParse,   /* Parsing and code generating context */
33992133d822Sdrh   Table *pTab,     /* Description of the table we are reading from */
34002133d822Sdrh   int iColumn,     /* Index of the table column */
34012133d822Sdrh   int iTable,      /* The cursor pointing to the table */
3402a748fdccSdrh   int iReg,        /* Store results here */
3403ce78bc6eSdrh   u8 p5            /* P5 value for OP_Column + FLAGS */
34042133d822Sdrh ){
3405e55cbd72Sdrh   Vdbe *v = pParse->pVdbe;
3406e55cbd72Sdrh   int i;
3407da250ea5Sdrh   struct yColCache *p;
3408e55cbd72Sdrh 
34099b40d13fSdrh   for(i=0, p=pParse->aColCache; i<pParse->nColCache; i++, p++){
341094881d73Sdrh     if( p->iTable==iTable && p->iColumn==iColumn ){
3411ceea3321Sdrh       p->lru = pParse->iCacheCnt++;
34125cd79239Sdrh       sqlite3ExprCachePinRegister(pParse, p->iReg);
3413299bf7c2Sdrh #ifdef SQLITE_DEBUG_COLUMNCACHE
3414299bf7c2Sdrh       sqlite3VdbeAddOp3(v, OP_VerifyTabCol, iTable, iColumn, p->iReg);
3415299bf7c2Sdrh #endif
3416da250ea5Sdrh       return p->iReg;
3417e55cbd72Sdrh     }
3418e55cbd72Sdrh   }
3419e55cbd72Sdrh   assert( v!=0 );
34205c092e8aSdrh   sqlite3ExprCodeGetColumnOfTable(v, pTab, iTable, iColumn, iReg);
3421a748fdccSdrh   if( p5 ){
3422a748fdccSdrh     sqlite3VdbeChangeP5(v, p5);
3423a748fdccSdrh   }else{
3424ceea3321Sdrh     sqlite3ExprCacheStore(pParse, iTable, iColumn, iReg);
3425a748fdccSdrh   }
3426e55cbd72Sdrh   return iReg;
3427e55cbd72Sdrh }
3428ce78bc6eSdrh void sqlite3ExprCodeGetColumnToReg(
3429ce78bc6eSdrh   Parse *pParse,   /* Parsing and code generating context */
3430ce78bc6eSdrh   Table *pTab,     /* Description of the table we are reading from */
3431ce78bc6eSdrh   int iColumn,     /* Index of the table column */
3432ce78bc6eSdrh   int iTable,      /* The cursor pointing to the table */
3433ce78bc6eSdrh   int iReg         /* Store results here */
3434ce78bc6eSdrh ){
3435ce78bc6eSdrh   int r1 = sqlite3ExprCodeGetColumn(pParse, pTab, iColumn, iTable, iReg, 0);
3436ce78bc6eSdrh   if( r1!=iReg ) sqlite3VdbeAddOp2(pParse->pVdbe, OP_SCopy, r1, iReg);
3437ce78bc6eSdrh }
3438ce78bc6eSdrh 
3439e55cbd72Sdrh 
3440e55cbd72Sdrh /*
3441ceea3321Sdrh ** Clear all column cache entries.
3442e55cbd72Sdrh */
3443ceea3321Sdrh void sqlite3ExprCacheClear(Parse *pParse){
3444e55cbd72Sdrh   int i;
3445ceea3321Sdrh 
3446d879e3ebSdrh #ifdef SQLITE_DEBUG
34479ac7962aSdrh   if( pParse->db->flags & SQLITE_VdbeAddopTrace ){
34489ac7962aSdrh     printf("CLEAR\n");
34499ac7962aSdrh   }
34509ac7962aSdrh #endif
34519b40d13fSdrh   for(i=0; i<pParse->nColCache; i++){
34529b40d13fSdrh     if( pParse->aColCache[i].tempReg
34539b40d13fSdrh      && pParse->nTempReg<ArraySize(pParse->aTempReg)
34549b40d13fSdrh     ){
34559b40d13fSdrh        pParse->aTempReg[pParse->nTempReg++] = pParse->aColCache[i].iReg;
3456e55cbd72Sdrh     }
3457da250ea5Sdrh   }
34589b40d13fSdrh   pParse->nColCache = 0;
3459da250ea5Sdrh }
3460e55cbd72Sdrh 
3461e55cbd72Sdrh /*
3462da250ea5Sdrh ** Record the fact that an affinity change has occurred on iCount
3463da250ea5Sdrh ** registers starting with iStart.
3464e55cbd72Sdrh */
3465da250ea5Sdrh void sqlite3ExprCacheAffinityChange(Parse *pParse, int iStart, int iCount){
3466f49f3523Sdrh   sqlite3ExprCacheRemove(pParse, iStart, iCount);
3467e55cbd72Sdrh }
3468e55cbd72Sdrh 
3469e55cbd72Sdrh /*
3470b21e7c70Sdrh ** Generate code to move content from registers iFrom...iFrom+nReg-1
3471b21e7c70Sdrh ** over to iTo..iTo+nReg-1. Keep the column cache up-to-date.
3472e55cbd72Sdrh */
3473b21e7c70Sdrh void sqlite3ExprCodeMove(Parse *pParse, int iFrom, int iTo, int nReg){
3474e8e4af76Sdrh   assert( iFrom>=iTo+nReg || iFrom+nReg<=iTo );
3475079a3072Sdrh   sqlite3VdbeAddOp3(pParse->pVdbe, OP_Move, iFrom, iTo, nReg);
3476236241aeSdrh   sqlite3ExprCacheRemove(pParse, iFrom, nReg);
3477945498f3Sdrh }
3478945498f3Sdrh 
3479f49f3523Sdrh #if defined(SQLITE_DEBUG) || defined(SQLITE_COVERAGE_TEST)
348092b01d53Sdrh /*
3481652fbf55Sdrh ** Return true if any register in the range iFrom..iTo (inclusive)
3482652fbf55Sdrh ** is used as part of the column cache.
3483f49f3523Sdrh **
3484f49f3523Sdrh ** This routine is used within assert() and testcase() macros only
3485f49f3523Sdrh ** and does not appear in a normal build.
3486652fbf55Sdrh */
3487652fbf55Sdrh static int usedAsColumnCache(Parse *pParse, int iFrom, int iTo){
3488652fbf55Sdrh   int i;
3489ceea3321Sdrh   struct yColCache *p;
34909b40d13fSdrh   for(i=0, p=pParse->aColCache; i<pParse->nColCache; i++, p++){
3491ceea3321Sdrh     int r = p->iReg;
3492f49f3523Sdrh     if( r>=iFrom && r<=iTo ) return 1;    /*NO_TEST*/
3493652fbf55Sdrh   }
3494652fbf55Sdrh   return 0;
3495652fbf55Sdrh }
3496f49f3523Sdrh #endif /* SQLITE_DEBUG || SQLITE_COVERAGE_TEST */
3497652fbf55Sdrh 
3498bea119cdSdrh 
3499652fbf55Sdrh /*
350012abf408Sdrh ** Convert a scalar expression node to a TK_REGISTER referencing
350112abf408Sdrh ** register iReg.  The caller must ensure that iReg already contains
350212abf408Sdrh ** the correct value for the expression.
3503a4c3c87eSdrh */
3504a4c3c87eSdrh static void exprToRegister(Expr *p, int iReg){
3505a4c3c87eSdrh   p->op2 = p->op;
3506a4c3c87eSdrh   p->op = TK_REGISTER;
3507a4c3c87eSdrh   p->iTable = iReg;
3508a4c3c87eSdrh   ExprClearProperty(p, EP_Skip);
3509a4c3c87eSdrh }
3510a4c3c87eSdrh 
351112abf408Sdrh /*
351212abf408Sdrh ** Evaluate an expression (either a vector or a scalar expression) and store
351312abf408Sdrh ** the result in continguous temporary registers.  Return the index of
351412abf408Sdrh ** the first register used to store the result.
351512abf408Sdrh **
351612abf408Sdrh ** If the returned result register is a temporary scalar, then also write
351712abf408Sdrh ** that register number into *piFreeable.  If the returned result register
351812abf408Sdrh ** is not a temporary or if the expression is a vector set *piFreeable
351912abf408Sdrh ** to 0.
352012abf408Sdrh */
352112abf408Sdrh static int exprCodeVector(Parse *pParse, Expr *p, int *piFreeable){
352212abf408Sdrh   int iResult;
352312abf408Sdrh   int nResult = sqlite3ExprVectorSize(p);
352412abf408Sdrh   if( nResult==1 ){
352512abf408Sdrh     iResult = sqlite3ExprCodeTemp(pParse, p, piFreeable);
352612abf408Sdrh   }else{
352712abf408Sdrh     *piFreeable = 0;
352812abf408Sdrh     if( p->op==TK_SELECT ){
3529dd1bb43aSdrh #if SQLITE_OMIT_SUBQUERY
3530dd1bb43aSdrh       iResult = 0;
3531dd1bb43aSdrh #else
353212abf408Sdrh       iResult = sqlite3CodeSubselect(pParse, p, 0, 0);
3533dd1bb43aSdrh #endif
353412abf408Sdrh     }else{
353512abf408Sdrh       int i;
353612abf408Sdrh       iResult = pParse->nMem+1;
353712abf408Sdrh       pParse->nMem += nResult;
353812abf408Sdrh       for(i=0; i<nResult; i++){
35394b725240Sdan         sqlite3ExprCodeFactorable(pParse, p->x.pList->a[i].pExpr, i+iResult);
354012abf408Sdrh       }
354112abf408Sdrh     }
354212abf408Sdrh   }
354312abf408Sdrh   return iResult;
354412abf408Sdrh }
354512abf408Sdrh 
354671c57db0Sdan 
3547a4c3c87eSdrh /*
3548cce7d176Sdrh ** Generate code into the current Vdbe to evaluate the given
35492dcef11bSdrh ** expression.  Attempt to store the results in register "target".
35502dcef11bSdrh ** Return the register where results are stored.
3551389a1adbSdrh **
35528b213899Sdrh ** With this routine, there is no guarantee that results will
35532dcef11bSdrh ** be stored in target.  The result might be stored in some other
35542dcef11bSdrh ** register if it is convenient to do so.  The calling function
35552dcef11bSdrh ** must check the return code and move the results to the desired
35562dcef11bSdrh ** register.
3557cce7d176Sdrh */
3558678ccce8Sdrh int sqlite3ExprCodeTarget(Parse *pParse, Expr *pExpr, int target){
35592dcef11bSdrh   Vdbe *v = pParse->pVdbe;  /* The VM under construction */
35602dcef11bSdrh   int op;                   /* The opcode being coded */
35612dcef11bSdrh   int inReg = target;       /* Results stored in register inReg */
35622dcef11bSdrh   int regFree1 = 0;         /* If non-zero free this temporary register */
35632dcef11bSdrh   int regFree2 = 0;         /* If non-zero free this temporary register */
35647b35a77bSdan   int r1, r2;               /* Various register numbers */
356510d1edf0Sdrh   Expr tempX;               /* Temporary expression node */
356671c57db0Sdan   int p5 = 0;
3567ffe07b2dSdrh 
35689cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
356920411ea7Sdrh   if( v==0 ){
357020411ea7Sdrh     assert( pParse->db->mallocFailed );
357120411ea7Sdrh     return 0;
357220411ea7Sdrh   }
3573389a1adbSdrh 
35741efa8023Sdrh expr_code_doover:
3575389a1adbSdrh   if( pExpr==0 ){
3576389a1adbSdrh     op = TK_NULL;
3577389a1adbSdrh   }else{
3578f2bc013cSdrh     op = pExpr->op;
3579389a1adbSdrh   }
3580f2bc013cSdrh   switch( op ){
358113449892Sdrh     case TK_AGG_COLUMN: {
358213449892Sdrh       AggInfo *pAggInfo = pExpr->pAggInfo;
358313449892Sdrh       struct AggInfo_col *pCol = &pAggInfo->aCol[pExpr->iAgg];
358413449892Sdrh       if( !pAggInfo->directMode ){
35859de221dfSdrh         assert( pCol->iMem>0 );
3586c332cc30Sdrh         return pCol->iMem;
358713449892Sdrh       }else if( pAggInfo->useSortingIdx ){
35885134d135Sdan         sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdxPTab,
3589389a1adbSdrh                               pCol->iSorterColumn, target);
3590c332cc30Sdrh         return target;
359113449892Sdrh       }
359213449892Sdrh       /* Otherwise, fall thru into the TK_COLUMN case */
359313449892Sdrh     }
3594967e8b73Sdrh     case TK_COLUMN: {
3595b2b9d3d7Sdrh       int iTab = pExpr->iTable;
3596*efad2e23Sdrh       if( ExprHasProperty(pExpr, EP_FixedCol) ){
3597*efad2e23Sdrh         pExpr = pExpr->pLeft;
3598*efad2e23Sdrh         goto expr_code_doover;
3599*efad2e23Sdrh       }
3600b2b9d3d7Sdrh       if( iTab<0 ){
36016e97f8ecSdrh         if( pParse->iSelfTab<0 ){
3602b2b9d3d7Sdrh           /* Generating CHECK constraints or inserting into partial index */
36036e97f8ecSdrh           return pExpr->iColumn - pParse->iSelfTab;
3604c4a3c779Sdrh         }else{
36051f9ca2c8Sdrh           /* Coding an expression that is part of an index where column names
36061f9ca2c8Sdrh           ** in the index refer to the table to which the index belongs */
36073e34eabcSdrh           iTab = pParse->iSelfTab - 1;
36082282792aSdrh         }
3609b2b9d3d7Sdrh       }
3610c332cc30Sdrh       return sqlite3ExprCodeGetColumn(pParse, pExpr->pTab,
3611b2b9d3d7Sdrh                                pExpr->iColumn, iTab, target,
3612b2b9d3d7Sdrh                                pExpr->op2);
3613cce7d176Sdrh     }
3614cce7d176Sdrh     case TK_INTEGER: {
361513573c71Sdrh       codeInteger(pParse, pExpr, 0, target);
3616c332cc30Sdrh       return target;
361751e9a445Sdrh     }
36188abed7b9Sdrh     case TK_TRUEFALSE: {
361996acafbeSdrh       sqlite3VdbeAddOp2(v, OP_Integer, sqlite3ExprTruthValue(pExpr), target);
3620007c843bSdrh       return target;
3621007c843bSdrh     }
362213573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
3623598f1340Sdrh     case TK_FLOAT: {
362433e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
362533e619fcSdrh       codeReal(v, pExpr->u.zToken, 0, target);
3626c332cc30Sdrh       return target;
3627598f1340Sdrh     }
362813573c71Sdrh #endif
3629fec19aadSdrh     case TK_STRING: {
363033e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
3631076e85f5Sdrh       sqlite3VdbeLoadString(v, target, pExpr->u.zToken);
3632c332cc30Sdrh       return target;
3633cce7d176Sdrh     }
3634f0863fe5Sdrh     case TK_NULL: {
36359de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3636c332cc30Sdrh       return target;
3637f0863fe5Sdrh     }
36385338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_BLOB_LITERAL
3639c572ef7fSdanielk1977     case TK_BLOB: {
36406c8c6cecSdrh       int n;
36416c8c6cecSdrh       const char *z;
3642ca48c90fSdrh       char *zBlob;
364333e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
364433e619fcSdrh       assert( pExpr->u.zToken[0]=='x' || pExpr->u.zToken[0]=='X' );
364533e619fcSdrh       assert( pExpr->u.zToken[1]=='\'' );
364633e619fcSdrh       z = &pExpr->u.zToken[2];
3647b7916a78Sdrh       n = sqlite3Strlen30(z) - 1;
3648b7916a78Sdrh       assert( z[n]=='\'' );
3649ca48c90fSdrh       zBlob = sqlite3HexToBlob(sqlite3VdbeDb(v), z, n);
3650ca48c90fSdrh       sqlite3VdbeAddOp4(v, OP_Blob, n/2, target, 0, zBlob, P4_DYNAMIC);
3651c332cc30Sdrh       return target;
3652c572ef7fSdanielk1977     }
36535338a5f7Sdanielk1977 #endif
365450457896Sdrh     case TK_VARIABLE: {
365533e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
365633e619fcSdrh       assert( pExpr->u.zToken!=0 );
365733e619fcSdrh       assert( pExpr->u.zToken[0]!=0 );
3658eaf52d88Sdrh       sqlite3VdbeAddOp2(v, OP_Variable, pExpr->iColumn, target);
365933e619fcSdrh       if( pExpr->u.zToken[1]!=0 ){
36609bf755ccSdrh         const char *z = sqlite3VListNumToName(pParse->pVList, pExpr->iColumn);
36619bf755ccSdrh         assert( pExpr->u.zToken[0]=='?' || strcmp(pExpr->u.zToken, z)==0 );
3662ce1bbe51Sdrh         pParse->pVList[0] = 0; /* Indicate VList may no longer be enlarged */
36639bf755ccSdrh         sqlite3VdbeAppendP4(v, (char*)z, P4_STATIC);
36649bf755ccSdrh       }
3665c332cc30Sdrh       return target;
366650457896Sdrh     }
36674e0cff60Sdrh     case TK_REGISTER: {
3668c332cc30Sdrh       return pExpr->iTable;
36694e0cff60Sdrh     }
3670487e262fSdrh #ifndef SQLITE_OMIT_CAST
3671487e262fSdrh     case TK_CAST: {
3672487e262fSdrh       /* Expressions of the form:   CAST(pLeft AS token) */
36732dcef11bSdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
36741735fa88Sdrh       if( inReg!=target ){
36751735fa88Sdrh         sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
36761735fa88Sdrh         inReg = target;
36771735fa88Sdrh       }
36784169e430Sdrh       sqlite3VdbeAddOp2(v, OP_Cast, target,
36794169e430Sdrh                         sqlite3AffinityType(pExpr->u.zToken, 0));
3680c5499befSdrh       testcase( usedAsColumnCache(pParse, inReg, inReg) );
3681b3843a82Sdrh       sqlite3ExprCacheAffinityChange(pParse, inReg, 1);
3682c332cc30Sdrh       return inReg;
3683487e262fSdrh     }
3684487e262fSdrh #endif /* SQLITE_OMIT_CAST */
368571c57db0Sdan     case TK_IS:
368671c57db0Sdan     case TK_ISNOT:
368771c57db0Sdan       op = (op==TK_IS) ? TK_EQ : TK_NE;
368871c57db0Sdan       p5 = SQLITE_NULLEQ;
368971c57db0Sdan       /* fall-through */
3690c9b84a1fSdrh     case TK_LT:
3691c9b84a1fSdrh     case TK_LE:
3692c9b84a1fSdrh     case TK_GT:
3693c9b84a1fSdrh     case TK_GE:
3694c9b84a1fSdrh     case TK_NE:
3695c9b84a1fSdrh     case TK_EQ: {
369671c57db0Sdan       Expr *pLeft = pExpr->pLeft;
3697625015e0Sdan       if( sqlite3ExprIsVector(pLeft) ){
369879752b6eSdrh         codeVectorCompare(pParse, pExpr, target, op, p5);
369971c57db0Sdan       }else{
370071c57db0Sdan         r1 = sqlite3ExprCodeTemp(pParse, pLeft, &regFree1);
3701b6da74ebSdrh         r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
370271c57db0Sdan         codeCompare(pParse, pLeft, pExpr->pRight, op,
370371c57db0Sdan             r1, r2, inReg, SQLITE_STOREP2 | p5);
37047d176105Sdrh         assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
37057d176105Sdrh         assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
37067d176105Sdrh         assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
37077d176105Sdrh         assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
37087d176105Sdrh         assert(TK_EQ==OP_Eq); testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
37097d176105Sdrh         assert(TK_NE==OP_Ne); testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
3710c5499befSdrh         testcase( regFree1==0 );
3711c5499befSdrh         testcase( regFree2==0 );
3712c9b84a1fSdrh       }
37136a2fe093Sdrh       break;
37146a2fe093Sdrh     }
3715cce7d176Sdrh     case TK_AND:
3716cce7d176Sdrh     case TK_OR:
3717cce7d176Sdrh     case TK_PLUS:
3718cce7d176Sdrh     case TK_STAR:
3719cce7d176Sdrh     case TK_MINUS:
3720bf4133cbSdrh     case TK_REM:
3721bf4133cbSdrh     case TK_BITAND:
3722bf4133cbSdrh     case TK_BITOR:
372317c40294Sdrh     case TK_SLASH:
3724bf4133cbSdrh     case TK_LSHIFT:
3725855eb1cfSdrh     case TK_RSHIFT:
37260040077dSdrh     case TK_CONCAT: {
37277d176105Sdrh       assert( TK_AND==OP_And );            testcase( op==TK_AND );
37287d176105Sdrh       assert( TK_OR==OP_Or );              testcase( op==TK_OR );
37297d176105Sdrh       assert( TK_PLUS==OP_Add );           testcase( op==TK_PLUS );
37307d176105Sdrh       assert( TK_MINUS==OP_Subtract );     testcase( op==TK_MINUS );
37317d176105Sdrh       assert( TK_REM==OP_Remainder );      testcase( op==TK_REM );
37327d176105Sdrh       assert( TK_BITAND==OP_BitAnd );      testcase( op==TK_BITAND );
37337d176105Sdrh       assert( TK_BITOR==OP_BitOr );        testcase( op==TK_BITOR );
37347d176105Sdrh       assert( TK_SLASH==OP_Divide );       testcase( op==TK_SLASH );
37357d176105Sdrh       assert( TK_LSHIFT==OP_ShiftLeft );   testcase( op==TK_LSHIFT );
37367d176105Sdrh       assert( TK_RSHIFT==OP_ShiftRight );  testcase( op==TK_RSHIFT );
37377d176105Sdrh       assert( TK_CONCAT==OP_Concat );      testcase( op==TK_CONCAT );
37382dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
37392dcef11bSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
37405b6afba9Sdrh       sqlite3VdbeAddOp3(v, op, r2, r1, target);
3741c5499befSdrh       testcase( regFree1==0 );
3742c5499befSdrh       testcase( regFree2==0 );
37430040077dSdrh       break;
37440040077dSdrh     }
3745cce7d176Sdrh     case TK_UMINUS: {
3746fec19aadSdrh       Expr *pLeft = pExpr->pLeft;
3747fec19aadSdrh       assert( pLeft );
374813573c71Sdrh       if( pLeft->op==TK_INTEGER ){
374913573c71Sdrh         codeInteger(pParse, pLeft, 1, target);
3750c332cc30Sdrh         return target;
375113573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
375213573c71Sdrh       }else if( pLeft->op==TK_FLOAT ){
375333e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
375433e619fcSdrh         codeReal(v, pLeft->u.zToken, 1, target);
3755c332cc30Sdrh         return target;
375613573c71Sdrh #endif
37573c84ddffSdrh       }else{
375810d1edf0Sdrh         tempX.op = TK_INTEGER;
375910d1edf0Sdrh         tempX.flags = EP_IntValue|EP_TokenOnly;
376010d1edf0Sdrh         tempX.u.iValue = 0;
376110d1edf0Sdrh         r1 = sqlite3ExprCodeTemp(pParse, &tempX, &regFree1);
3762e55cbd72Sdrh         r2 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree2);
37632dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_Subtract, r2, r1, target);
3764c5499befSdrh         testcase( regFree2==0 );
37653c84ddffSdrh       }
37666e142f54Sdrh       break;
37676e142f54Sdrh     }
3768bf4133cbSdrh     case TK_BITNOT:
37696e142f54Sdrh     case TK_NOT: {
37707d176105Sdrh       assert( TK_BITNOT==OP_BitNot );   testcase( op==TK_BITNOT );
37717d176105Sdrh       assert( TK_NOT==OP_Not );         testcase( op==TK_NOT );
3772e99fa2afSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3773e99fa2afSdrh       testcase( regFree1==0 );
3774e99fa2afSdrh       sqlite3VdbeAddOp2(v, op, r1, inReg);
3775cce7d176Sdrh       break;
3776cce7d176Sdrh     }
37778abed7b9Sdrh     case TK_TRUTH: {
377896acafbeSdrh       int isTrue;    /* IS TRUE or IS NOT TRUE */
377996acafbeSdrh       int bNormal;   /* IS TRUE or IS FALSE */
3780007c843bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3781007c843bSdrh       testcase( regFree1==0 );
378296acafbeSdrh       isTrue = sqlite3ExprTruthValue(pExpr->pRight);
378396acafbeSdrh       bNormal = pExpr->op2==TK_IS;
378496acafbeSdrh       testcase( isTrue && bNormal);
378596acafbeSdrh       testcase( !isTrue && bNormal);
378696acafbeSdrh       sqlite3VdbeAddOp4Int(v, OP_IsTrue, r1, inReg, !isTrue, isTrue ^ bNormal);
3787007c843bSdrh       break;
3788007c843bSdrh     }
3789cce7d176Sdrh     case TK_ISNULL:
3790cce7d176Sdrh     case TK_NOTNULL: {
37916a288a33Sdrh       int addr;
37927d176105Sdrh       assert( TK_ISNULL==OP_IsNull );   testcase( op==TK_ISNULL );
37937d176105Sdrh       assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
37949de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
37952dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3796c5499befSdrh       testcase( regFree1==0 );
37972dcef11bSdrh       addr = sqlite3VdbeAddOp1(v, op, r1);
37987d176105Sdrh       VdbeCoverageIf(v, op==TK_ISNULL);
37997d176105Sdrh       VdbeCoverageIf(v, op==TK_NOTNULL);
3800a976979bSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 0, target);
38016a288a33Sdrh       sqlite3VdbeJumpHere(v, addr);
3802a37cdde0Sdanielk1977       break;
3803f2bc013cSdrh     }
38042282792aSdrh     case TK_AGG_FUNCTION: {
380513449892Sdrh       AggInfo *pInfo = pExpr->pAggInfo;
38067e56e711Sdrh       if( pInfo==0 ){
380733e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
380833e619fcSdrh         sqlite3ErrorMsg(pParse, "misuse of aggregate: %s()", pExpr->u.zToken);
38097e56e711Sdrh       }else{
3810c332cc30Sdrh         return pInfo->aFunc[pExpr->iAgg].iMem;
38117e56e711Sdrh       }
38122282792aSdrh       break;
38132282792aSdrh     }
3814cce7d176Sdrh     case TK_FUNCTION: {
381512ffee8cSdrh       ExprList *pFarg;       /* List of function arguments */
381612ffee8cSdrh       int nFarg;             /* Number of function arguments */
381712ffee8cSdrh       FuncDef *pDef;         /* The function definition object */
381812ffee8cSdrh       const char *zId;       /* The function name */
3819693e6719Sdrh       u32 constMask = 0;     /* Mask of function arguments that are constant */
382012ffee8cSdrh       int i;                 /* Loop counter */
3821c332cc30Sdrh       sqlite3 *db = pParse->db;  /* The database connection */
382212ffee8cSdrh       u8 enc = ENC(db);      /* The text encoding used by this database */
382312ffee8cSdrh       CollSeq *pColl = 0;    /* A collating sequence */
382417435752Sdrh 
382567a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
382686fb6e17Sdan       if( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) && pExpr->pWin ){
382786fb6e17Sdan         return pExpr->pWin->regResult;
382886fb6e17Sdan       }
382967a9b8edSdan #endif
383086fb6e17Sdan 
38311e9b53f9Sdrh       if( ConstFactorOk(pParse) && sqlite3ExprIsConstantNotJoin(pExpr) ){
383249c5ab24Sdrh         /* SQL functions can be expensive. So try to move constant functions
3833ad879ffdSdrh         ** out of the inner loop, even if that means an extra OP_Copy. */
3834ad879ffdSdrh         return sqlite3ExprCodeAtInit(pParse, pExpr, -1);
38351e9b53f9Sdrh       }
38366ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
3837c5cd1249Sdrh       if( ExprHasProperty(pExpr, EP_TokenOnly) ){
383812ffee8cSdrh         pFarg = 0;
383912ffee8cSdrh       }else{
384012ffee8cSdrh         pFarg = pExpr->x.pList;
384112ffee8cSdrh       }
384212ffee8cSdrh       nFarg = pFarg ? pFarg->nExpr : 0;
384333e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
384433e619fcSdrh       zId = pExpr->u.zToken;
384580738d9cSdrh       pDef = sqlite3FindFunction(db, zId, nFarg, enc, 0);
3846cc15313cSdrh #ifdef SQLITE_ENABLE_UNKNOWN_SQL_FUNCTION
3847cc15313cSdrh       if( pDef==0 && pParse->explain ){
3848cc15313cSdrh         pDef = sqlite3FindFunction(db, "unknown", nFarg, enc, 0);
3849cc15313cSdrh       }
3850cc15313cSdrh #endif
3851b6e9f7a4Sdan       if( pDef==0 || pDef->xFinalize!=0 ){
385280738d9cSdrh         sqlite3ErrorMsg(pParse, "unknown function: %s()", zId);
3853feb306f5Sdrh         break;
3854feb306f5Sdrh       }
3855ae6bb957Sdrh 
3856ae6bb957Sdrh       /* Attempt a direct implementation of the built-in COALESCE() and
385760ec914cSpeter.d.reid       ** IFNULL() functions.  This avoids unnecessary evaluation of
3858ae6bb957Sdrh       ** arguments past the first non-NULL argument.
3859ae6bb957Sdrh       */
3860d36e1041Sdrh       if( pDef->funcFlags & SQLITE_FUNC_COALESCE ){
3861ae6bb957Sdrh         int endCoalesce = sqlite3VdbeMakeLabel(v);
3862ae6bb957Sdrh         assert( nFarg>=2 );
3863ae6bb957Sdrh         sqlite3ExprCode(pParse, pFarg->a[0].pExpr, target);
3864ae6bb957Sdrh         for(i=1; i<nFarg; i++){
3865ae6bb957Sdrh           sqlite3VdbeAddOp2(v, OP_NotNull, target, endCoalesce);
3866688852abSdrh           VdbeCoverage(v);
3867f49f3523Sdrh           sqlite3ExprCacheRemove(pParse, target, 1);
3868ae6bb957Sdrh           sqlite3ExprCachePush(pParse);
3869ae6bb957Sdrh           sqlite3ExprCode(pParse, pFarg->a[i].pExpr, target);
3870d2490904Sdrh           sqlite3ExprCachePop(pParse);
3871ae6bb957Sdrh         }
3872ae6bb957Sdrh         sqlite3VdbeResolveLabel(v, endCoalesce);
3873ae6bb957Sdrh         break;
3874ae6bb957Sdrh       }
3875ae6bb957Sdrh 
3876cca9f3d2Sdrh       /* The UNLIKELY() function is a no-op.  The result is the value
3877cca9f3d2Sdrh       ** of the first argument.
3878cca9f3d2Sdrh       */
3879cca9f3d2Sdrh       if( pDef->funcFlags & SQLITE_FUNC_UNLIKELY ){
3880cca9f3d2Sdrh         assert( nFarg>=1 );
3881c332cc30Sdrh         return sqlite3ExprCodeTarget(pParse, pFarg->a[0].pExpr, target);
3882cca9f3d2Sdrh       }
3883ae6bb957Sdrh 
388454240751Sdrh #ifdef SQLITE_DEBUG
3885a1a523a5Sdrh       /* The AFFINITY() function evaluates to a string that describes
3886a1a523a5Sdrh       ** the type affinity of the argument.  This is used for testing of
3887a1a523a5Sdrh       ** the SQLite type logic.
3888a1a523a5Sdrh       */
3889a1a523a5Sdrh       if( pDef->funcFlags & SQLITE_FUNC_AFFINITY ){
3890a1a523a5Sdrh         const char *azAff[] = { "blob", "text", "numeric", "integer", "real" };
3891a1a523a5Sdrh         char aff;
3892a1a523a5Sdrh         assert( nFarg==1 );
3893a1a523a5Sdrh         aff = sqlite3ExprAffinity(pFarg->a[0].pExpr);
3894a1a523a5Sdrh         sqlite3VdbeLoadString(v, target,
3895a1a523a5Sdrh                               aff ? azAff[aff-SQLITE_AFF_BLOB] : "none");
3896a1a523a5Sdrh         return target;
3897a1a523a5Sdrh       }
389854240751Sdrh #endif
3899a1a523a5Sdrh 
3900d1a01edaSdrh       for(i=0; i<nFarg; i++){
3901d1a01edaSdrh         if( i<32 && sqlite3ExprIsConstant(pFarg->a[i].pExpr) ){
3902693e6719Sdrh           testcase( i==31 );
3903693e6719Sdrh           constMask |= MASKBIT32(i);
3904d1a01edaSdrh         }
3905d1a01edaSdrh         if( (pDef->funcFlags & SQLITE_FUNC_NEEDCOLL)!=0 && !pColl ){
3906d1a01edaSdrh           pColl = sqlite3ExprCollSeq(pParse, pFarg->a[i].pExpr);
3907d1a01edaSdrh         }
3908d1a01edaSdrh       }
390912ffee8cSdrh       if( pFarg ){
3910d1a01edaSdrh         if( constMask ){
3911d1a01edaSdrh           r1 = pParse->nMem+1;
3912d1a01edaSdrh           pParse->nMem += nFarg;
3913d1a01edaSdrh         }else{
391412ffee8cSdrh           r1 = sqlite3GetTempRange(pParse, nFarg);
3915d1a01edaSdrh         }
3916a748fdccSdrh 
3917a748fdccSdrh         /* For length() and typeof() functions with a column argument,
3918a748fdccSdrh         ** set the P5 parameter to the OP_Column opcode to OPFLAG_LENGTHARG
3919a748fdccSdrh         ** or OPFLAG_TYPEOFARG respectively, to avoid unnecessary data
3920a748fdccSdrh         ** loading.
3921a748fdccSdrh         */
3922d36e1041Sdrh         if( (pDef->funcFlags & (SQLITE_FUNC_LENGTH|SQLITE_FUNC_TYPEOF))!=0 ){
39234e245a4cSdrh           u8 exprOp;
3924a748fdccSdrh           assert( nFarg==1 );
3925a748fdccSdrh           assert( pFarg->a[0].pExpr!=0 );
39264e245a4cSdrh           exprOp = pFarg->a[0].pExpr->op;
39274e245a4cSdrh           if( exprOp==TK_COLUMN || exprOp==TK_AGG_COLUMN ){
3928a748fdccSdrh             assert( SQLITE_FUNC_LENGTH==OPFLAG_LENGTHARG );
3929a748fdccSdrh             assert( SQLITE_FUNC_TYPEOF==OPFLAG_TYPEOFARG );
3930b1fba286Sdrh             testcase( pDef->funcFlags & OPFLAG_LENGTHARG );
3931b1fba286Sdrh             pFarg->a[0].pExpr->op2 =
3932b1fba286Sdrh                   pDef->funcFlags & (OPFLAG_LENGTHARG|OPFLAG_TYPEOFARG);
3933a748fdccSdrh           }
3934a748fdccSdrh         }
3935a748fdccSdrh 
3936d7d385ddSdrh         sqlite3ExprCachePush(pParse);     /* Ticket 2ea2425d34be */
39375579d59fSdrh         sqlite3ExprCodeExprList(pParse, pFarg, r1, 0,
3938d1a01edaSdrh                                 SQLITE_ECEL_DUP|SQLITE_ECEL_FACTOR);
3939d2490904Sdrh         sqlite3ExprCachePop(pParse);      /* Ticket 2ea2425d34be */
3940892d3179Sdrh       }else{
394112ffee8cSdrh         r1 = 0;
3942892d3179Sdrh       }
3943b7f6f68fSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
3944a43fa227Sdrh       /* Possibly overload the function if the first argument is
3945a43fa227Sdrh       ** a virtual table column.
3946a43fa227Sdrh       **
3947a43fa227Sdrh       ** For infix functions (LIKE, GLOB, REGEXP, and MATCH) use the
3948a43fa227Sdrh       ** second argument, not the first, as the argument to test to
3949a43fa227Sdrh       ** see if it is a column in a virtual table.  This is done because
3950a43fa227Sdrh       ** the left operand of infix functions (the operand we want to
3951a43fa227Sdrh       ** control overloading) ends up as the second argument to the
3952a43fa227Sdrh       ** function.  The expression "A glob B" is equivalent to
3953a43fa227Sdrh       ** "glob(B,A).  We want to use the A in "A glob B" to test
3954a43fa227Sdrh       ** for function overloading.  But we use the B term in "glob(B,A)".
3955a43fa227Sdrh       */
395612ffee8cSdrh       if( nFarg>=2 && (pExpr->flags & EP_InfixFunc) ){
395712ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[1].pExpr);
395812ffee8cSdrh       }else if( nFarg>0 ){
395912ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[0].pExpr);
3960b7f6f68fSdrh       }
3961b7f6f68fSdrh #endif
3962d36e1041Sdrh       if( pDef->funcFlags & SQLITE_FUNC_NEEDCOLL ){
39638b213899Sdrh         if( !pColl ) pColl = db->pDfltColl;
396466a5167bSdrh         sqlite3VdbeAddOp4(v, OP_CollSeq, 0, 0, 0, (char *)pColl, P4_COLLSEQ);
3965682f68b0Sdanielk1977       }
3966092457b1Sdrh #ifdef SQLITE_ENABLE_OFFSET_SQL_FUNC
3967092457b1Sdrh       if( pDef->funcFlags & SQLITE_FUNC_OFFSET ){
39682fc865c1Sdrh         Expr *pArg = pFarg->a[0].pExpr;
39692fc865c1Sdrh         if( pArg->op==TK_COLUMN ){
3970092457b1Sdrh           sqlite3VdbeAddOp3(v, OP_Offset, pArg->iTable, pArg->iColumn, target);
39712fc865c1Sdrh         }else{
39722fc865c1Sdrh           sqlite3VdbeAddOp2(v, OP_Null, 0, target);
39732fc865c1Sdrh         }
3974092457b1Sdrh       }else
3975092457b1Sdrh #endif
3976092457b1Sdrh       {
39773e34eabcSdrh         sqlite3VdbeAddOp4(v, pParse->iSelfTab ? OP_PureFunc0 : OP_Function0,
39783e34eabcSdrh                           constMask, r1, target, (char*)pDef, P4_FUNCDEF);
397912ffee8cSdrh         sqlite3VdbeChangeP5(v, (u8)nFarg);
39802fc865c1Sdrh       }
3981d1a01edaSdrh       if( nFarg && constMask==0 ){
398212ffee8cSdrh         sqlite3ReleaseTempRange(pParse, r1, nFarg);
39832dcef11bSdrh       }
3984c332cc30Sdrh       return target;
39856ec2733bSdrh     }
3986fe2093d7Sdrh #ifndef SQLITE_OMIT_SUBQUERY
3987fe2093d7Sdrh     case TK_EXISTS:
398819a775c2Sdrh     case TK_SELECT: {
39898da209b1Sdan       int nCol;
3990c5499befSdrh       testcase( op==TK_EXISTS );
3991c5499befSdrh       testcase( op==TK_SELECT );
39928da209b1Sdan       if( op==TK_SELECT && (nCol = pExpr->x.pSelect->pEList->nExpr)!=1 ){
39938da209b1Sdan         sqlite3SubselectError(pParse, nCol, 1);
39948da209b1Sdan       }else{
3995c332cc30Sdrh         return sqlite3CodeSubselect(pParse, pExpr, 0, 0);
39968da209b1Sdan       }
399719a775c2Sdrh       break;
399819a775c2Sdrh     }
3999fc7f27b9Sdrh     case TK_SELECT_COLUMN: {
4000966e2911Sdrh       int n;
4001fc7f27b9Sdrh       if( pExpr->pLeft->iTable==0 ){
4002fc7f27b9Sdrh         pExpr->pLeft->iTable = sqlite3CodeSubselect(pParse, pExpr->pLeft, 0, 0);
4003fc7f27b9Sdrh       }
4004966e2911Sdrh       assert( pExpr->iTable==0 || pExpr->pLeft->op==TK_SELECT );
4005966e2911Sdrh       if( pExpr->iTable
4006966e2911Sdrh        && pExpr->iTable!=(n = sqlite3ExprVectorSize(pExpr->pLeft))
4007966e2911Sdrh       ){
4008966e2911Sdrh         sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
4009966e2911Sdrh                                 pExpr->iTable, n);
4010966e2911Sdrh       }
4011c332cc30Sdrh       return pExpr->pLeft->iTable + pExpr->iColumn;
4012fc7f27b9Sdrh     }
4013fef5208cSdrh     case TK_IN: {
4014e3365e6cSdrh       int destIfFalse = sqlite3VdbeMakeLabel(v);
4015e3365e6cSdrh       int destIfNull = sqlite3VdbeMakeLabel(v);
4016e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
4017e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
401866ba23ceSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
4019e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
4020e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_AddImm, target, 0);
4021e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfNull);
4022c332cc30Sdrh       return target;
4023fef5208cSdrh     }
4024e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
4025e3365e6cSdrh 
4026e3365e6cSdrh 
40272dcef11bSdrh     /*
40282dcef11bSdrh     **    x BETWEEN y AND z
40292dcef11bSdrh     **
40302dcef11bSdrh     ** This is equivalent to
40312dcef11bSdrh     **
40322dcef11bSdrh     **    x>=y AND x<=z
40332dcef11bSdrh     **
40342dcef11bSdrh     ** X is stored in pExpr->pLeft.
40352dcef11bSdrh     ** Y is stored in pExpr->pList->a[0].pExpr.
40362dcef11bSdrh     ** Z is stored in pExpr->pList->a[1].pExpr.
40372dcef11bSdrh     */
4038fef5208cSdrh     case TK_BETWEEN: {
403971c57db0Sdan       exprCodeBetween(pParse, pExpr, target, 0, 0);
4040c332cc30Sdrh       return target;
4041fef5208cSdrh     }
404294fa9c41Sdrh     case TK_SPAN:
4043ae80ddeaSdrh     case TK_COLLATE:
40444f07e5fbSdrh     case TK_UPLUS: {
40451efa8023Sdrh       pExpr = pExpr->pLeft;
404659ee43a7Sdrh       goto expr_code_doover; /* 2018-04-28: Prevent deep recursion. OSSFuzz. */
4047a2e00042Sdrh     }
40482dcef11bSdrh 
4049165921a7Sdan     case TK_TRIGGER: {
405065a7cd16Sdan       /* If the opcode is TK_TRIGGER, then the expression is a reference
405165a7cd16Sdan       ** to a column in the new.* or old.* pseudo-tables available to
405265a7cd16Sdan       ** trigger programs. In this case Expr.iTable is set to 1 for the
405365a7cd16Sdan       ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
405465a7cd16Sdan       ** is set to the column of the pseudo-table to read, or to -1 to
405565a7cd16Sdan       ** read the rowid field.
405665a7cd16Sdan       **
405765a7cd16Sdan       ** The expression is implemented using an OP_Param opcode. The p1
405865a7cd16Sdan       ** parameter is set to 0 for an old.rowid reference, or to (i+1)
405965a7cd16Sdan       ** to reference another column of the old.* pseudo-table, where
406065a7cd16Sdan       ** i is the index of the column. For a new.rowid reference, p1 is
406165a7cd16Sdan       ** set to (n+1), where n is the number of columns in each pseudo-table.
406265a7cd16Sdan       ** For a reference to any other column in the new.* pseudo-table, p1
406365a7cd16Sdan       ** is set to (n+2+i), where n and i are as defined previously. For
406465a7cd16Sdan       ** example, if the table on which triggers are being fired is
406565a7cd16Sdan       ** declared as:
406665a7cd16Sdan       **
406765a7cd16Sdan       **   CREATE TABLE t1(a, b);
406865a7cd16Sdan       **
406965a7cd16Sdan       ** Then p1 is interpreted as follows:
407065a7cd16Sdan       **
407165a7cd16Sdan       **   p1==0   ->    old.rowid     p1==3   ->    new.rowid
407265a7cd16Sdan       **   p1==1   ->    old.a         p1==4   ->    new.a
407365a7cd16Sdan       **   p1==2   ->    old.b         p1==5   ->    new.b
407465a7cd16Sdan       */
40752832ad42Sdan       Table *pTab = pExpr->pTab;
407665a7cd16Sdan       int p1 = pExpr->iTable * (pTab->nCol+1) + 1 + pExpr->iColumn;
407765a7cd16Sdan 
407865a7cd16Sdan       assert( pExpr->iTable==0 || pExpr->iTable==1 );
407965a7cd16Sdan       assert( pExpr->iColumn>=-1 && pExpr->iColumn<pTab->nCol );
408065a7cd16Sdan       assert( pTab->iPKey<0 || pExpr->iColumn!=pTab->iPKey );
408165a7cd16Sdan       assert( p1>=0 && p1<(pTab->nCol*2+2) );
408265a7cd16Sdan 
408365a7cd16Sdan       sqlite3VdbeAddOp2(v, OP_Param, p1, target);
4084896494e8Sdrh       VdbeComment((v, "r[%d]=%s.%s", target,
4085165921a7Sdan         (pExpr->iTable ? "new" : "old"),
4086896494e8Sdrh         (pExpr->iColumn<0 ? "rowid" : pExpr->pTab->aCol[pExpr->iColumn].zName)
4087165921a7Sdan       ));
408865a7cd16Sdan 
408944dbca83Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
409065a7cd16Sdan       /* If the column has REAL affinity, it may currently be stored as an
4091113762a2Sdrh       ** integer. Use OP_RealAffinity to make sure it is really real.
4092113762a2Sdrh       **
4093113762a2Sdrh       ** EVIDENCE-OF: R-60985-57662 SQLite will convert the value back to
4094113762a2Sdrh       ** floating point when extracting it from the record.  */
40952832ad42Sdan       if( pExpr->iColumn>=0
40962832ad42Sdan        && pTab->aCol[pExpr->iColumn].affinity==SQLITE_AFF_REAL
40972832ad42Sdan       ){
40982832ad42Sdan         sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
40992832ad42Sdan       }
410044dbca83Sdrh #endif
4101165921a7Sdan       break;
4102165921a7Sdan     }
4103165921a7Sdan 
410471c57db0Sdan     case TK_VECTOR: {
4105e835bc12Sdrh       sqlite3ErrorMsg(pParse, "row value misused");
410671c57db0Sdan       break;
410771c57db0Sdan     }
410871c57db0Sdan 
410931d6fd55Sdrh     case TK_IF_NULL_ROW: {
411031d6fd55Sdrh       int addrINR;
411131d6fd55Sdrh       addrINR = sqlite3VdbeAddOp1(v, OP_IfNullRow, pExpr->iTable);
411231d6fd55Sdrh       sqlite3ExprCachePush(pParse);
411331d6fd55Sdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
411431d6fd55Sdrh       sqlite3ExprCachePop(pParse);
411531d6fd55Sdrh       sqlite3VdbeJumpHere(v, addrINR);
411631d6fd55Sdrh       sqlite3VdbeChangeP3(v, addrINR, inReg);
411731d6fd55Sdrh       break;
411831d6fd55Sdrh     }
411931d6fd55Sdrh 
41202dcef11bSdrh     /*
41212dcef11bSdrh     ** Form A:
41222dcef11bSdrh     **   CASE x WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
41232dcef11bSdrh     **
41242dcef11bSdrh     ** Form B:
41252dcef11bSdrh     **   CASE WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
41262dcef11bSdrh     **
41272dcef11bSdrh     ** Form A is can be transformed into the equivalent form B as follows:
41282dcef11bSdrh     **   CASE WHEN x=e1 THEN r1 WHEN x=e2 THEN r2 ...
41292dcef11bSdrh     **        WHEN x=eN THEN rN ELSE y END
41302dcef11bSdrh     **
41312dcef11bSdrh     ** X (if it exists) is in pExpr->pLeft.
4132c5cd1249Sdrh     ** Y is in the last element of pExpr->x.pList if pExpr->x.pList->nExpr is
4133c5cd1249Sdrh     ** odd.  The Y is also optional.  If the number of elements in x.pList
4134c5cd1249Sdrh     ** is even, then Y is omitted and the "otherwise" result is NULL.
41352dcef11bSdrh     ** Ei is in pExpr->pList->a[i*2] and Ri is pExpr->pList->a[i*2+1].
41362dcef11bSdrh     **
41372dcef11bSdrh     ** The result of the expression is the Ri for the first matching Ei,
41382dcef11bSdrh     ** or if there is no matching Ei, the ELSE term Y, or if there is
41392dcef11bSdrh     ** no ELSE term, NULL.
41402dcef11bSdrh     */
414133cd4909Sdrh     default: assert( op==TK_CASE ); {
41422dcef11bSdrh       int endLabel;                     /* GOTO label for end of CASE stmt */
41432dcef11bSdrh       int nextCase;                     /* GOTO label for next WHEN clause */
41442dcef11bSdrh       int nExpr;                        /* 2x number of WHEN terms */
41452dcef11bSdrh       int i;                            /* Loop counter */
41462dcef11bSdrh       ExprList *pEList;                 /* List of WHEN terms */
41472dcef11bSdrh       struct ExprList_item *aListelem;  /* Array of WHEN terms */
41482dcef11bSdrh       Expr opCompare;                   /* The X==Ei expression */
41492dcef11bSdrh       Expr *pX;                         /* The X expression */
41501bd10f8aSdrh       Expr *pTest = 0;                  /* X==Ei (form A) or just Ei (form B) */
4151ceea3321Sdrh       VVA_ONLY( int iCacheLevel = pParse->iCacheLevel; )
415217a7f8ddSdrh 
41536ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) && pExpr->x.pList );
41546ab3a2ecSdanielk1977       assert(pExpr->x.pList->nExpr > 0);
41556ab3a2ecSdanielk1977       pEList = pExpr->x.pList;
4156be5c89acSdrh       aListelem = pEList->a;
4157be5c89acSdrh       nExpr = pEList->nExpr;
41582dcef11bSdrh       endLabel = sqlite3VdbeMakeLabel(v);
41592dcef11bSdrh       if( (pX = pExpr->pLeft)!=0 ){
416010d1edf0Sdrh         tempX = *pX;
416133cd4909Sdrh         testcase( pX->op==TK_COLUMN );
416212abf408Sdrh         exprToRegister(&tempX, exprCodeVector(pParse, &tempX, &regFree1));
4163c5499befSdrh         testcase( regFree1==0 );
4164abb9d5f1Sdrh         memset(&opCompare, 0, sizeof(opCompare));
41652dcef11bSdrh         opCompare.op = TK_EQ;
416610d1edf0Sdrh         opCompare.pLeft = &tempX;
41672dcef11bSdrh         pTest = &opCompare;
41688b1db07fSdrh         /* Ticket b351d95f9cd5ef17e9d9dbae18f5ca8611190001:
41698b1db07fSdrh         ** The value in regFree1 might get SCopy-ed into the file result.
41708b1db07fSdrh         ** So make sure that the regFree1 register is not reused for other
41718b1db07fSdrh         ** purposes and possibly overwritten.  */
41728b1db07fSdrh         regFree1 = 0;
4173cce7d176Sdrh       }
4174c5cd1249Sdrh       for(i=0; i<nExpr-1; i=i+2){
4175ceea3321Sdrh         sqlite3ExprCachePush(pParse);
41762dcef11bSdrh         if( pX ){
41771bd10f8aSdrh           assert( pTest!=0 );
41782dcef11bSdrh           opCompare.pRight = aListelem[i].pExpr;
4179f5905aa7Sdrh         }else{
41802dcef11bSdrh           pTest = aListelem[i].pExpr;
418117a7f8ddSdrh         }
41822dcef11bSdrh         nextCase = sqlite3VdbeMakeLabel(v);
418333cd4909Sdrh         testcase( pTest->op==TK_COLUMN );
41842dcef11bSdrh         sqlite3ExprIfFalse(pParse, pTest, nextCase, SQLITE_JUMPIFNULL);
4185c5499befSdrh         testcase( aListelem[i+1].pExpr->op==TK_COLUMN );
41869de221dfSdrh         sqlite3ExprCode(pParse, aListelem[i+1].pExpr, target);
4187076e85f5Sdrh         sqlite3VdbeGoto(v, endLabel);
4188d2490904Sdrh         sqlite3ExprCachePop(pParse);
41892dcef11bSdrh         sqlite3VdbeResolveLabel(v, nextCase);
4190f570f011Sdrh       }
4191c5cd1249Sdrh       if( (nExpr&1)!=0 ){
4192ceea3321Sdrh         sqlite3ExprCachePush(pParse);
4193c5cd1249Sdrh         sqlite3ExprCode(pParse, pEList->a[nExpr-1].pExpr, target);
4194d2490904Sdrh         sqlite3ExprCachePop(pParse);
419517a7f8ddSdrh       }else{
41969de221dfSdrh         sqlite3VdbeAddOp2(v, OP_Null, 0, target);
419717a7f8ddSdrh       }
4198c332cc30Sdrh       assert( pParse->db->mallocFailed || pParse->nErr>0
4199c1f4a19bSdanielk1977            || pParse->iCacheLevel==iCacheLevel );
42002dcef11bSdrh       sqlite3VdbeResolveLabel(v, endLabel);
42016f34903eSdanielk1977       break;
42026f34903eSdanielk1977     }
42035338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_TRIGGER
42046f34903eSdanielk1977     case TK_RAISE: {
4205165921a7Sdan       assert( pExpr->affinity==OE_Rollback
4206165921a7Sdan            || pExpr->affinity==OE_Abort
4207165921a7Sdan            || pExpr->affinity==OE_Fail
4208165921a7Sdan            || pExpr->affinity==OE_Ignore
4209165921a7Sdan       );
4210e0af83acSdan       if( !pParse->pTriggerTab ){
4211e0af83acSdan         sqlite3ErrorMsg(pParse,
4212e0af83acSdan                        "RAISE() may only be used within a trigger-program");
4213e0af83acSdan         return 0;
4214e0af83acSdan       }
4215e0af83acSdan       if( pExpr->affinity==OE_Abort ){
4216e0af83acSdan         sqlite3MayAbort(pParse);
4217e0af83acSdan       }
421833e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
4219e0af83acSdan       if( pExpr->affinity==OE_Ignore ){
4220e0af83acSdan         sqlite3VdbeAddOp4(
4221e0af83acSdan             v, OP_Halt, SQLITE_OK, OE_Ignore, 0, pExpr->u.zToken,0);
4222688852abSdrh         VdbeCoverage(v);
4223e0af83acSdan       }else{
4224433dccfbSdrh         sqlite3HaltConstraint(pParse, SQLITE_CONSTRAINT_TRIGGER,
4225f9c8ce3cSdrh                               pExpr->affinity, pExpr->u.zToken, 0, 0);
4226e0af83acSdan       }
4227e0af83acSdan 
4228ffe07b2dSdrh       break;
422917a7f8ddSdrh     }
42305338a5f7Sdanielk1977 #endif
4231ffe07b2dSdrh   }
42322dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
42332dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
42342dcef11bSdrh   return inReg;
42355b6afba9Sdrh }
42362dcef11bSdrh 
42372dcef11bSdrh /*
4238d1a01edaSdrh ** Factor out the code of the given expression to initialization time.
42391e9b53f9Sdrh **
4240ad879ffdSdrh ** If regDest>=0 then the result is always stored in that register and the
4241ad879ffdSdrh ** result is not reusable.  If regDest<0 then this routine is free to
4242ad879ffdSdrh ** store the value whereever it wants.  The register where the expression
4243ad879ffdSdrh ** is stored is returned.  When regDest<0, two identical expressions will
4244ad879ffdSdrh ** code to the same register.
4245d1a01edaSdrh */
42461e9b53f9Sdrh int sqlite3ExprCodeAtInit(
4247d673cddaSdrh   Parse *pParse,    /* Parsing context */
4248d673cddaSdrh   Expr *pExpr,      /* The expression to code when the VDBE initializes */
4249ad879ffdSdrh   int regDest       /* Store the value in this register */
4250d673cddaSdrh ){
4251d1a01edaSdrh   ExprList *p;
4252d9f158e7Sdrh   assert( ConstFactorOk(pParse) );
4253d1a01edaSdrh   p = pParse->pConstExpr;
4254ad879ffdSdrh   if( regDest<0 && p ){
42551e9b53f9Sdrh     struct ExprList_item *pItem;
42561e9b53f9Sdrh     int i;
42571e9b53f9Sdrh     for(pItem=p->a, i=p->nExpr; i>0; pItem++, i--){
42585aa550cfSdan       if( pItem->reusable && sqlite3ExprCompare(0,pItem->pExpr,pExpr,-1)==0 ){
42591e9b53f9Sdrh         return pItem->u.iConstExprReg;
42601e9b53f9Sdrh       }
42611e9b53f9Sdrh     }
42621e9b53f9Sdrh   }
4263d1a01edaSdrh   pExpr = sqlite3ExprDup(pParse->db, pExpr, 0);
4264d1a01edaSdrh   p = sqlite3ExprListAppend(pParse, p, pExpr);
4265d673cddaSdrh   if( p ){
4266d673cddaSdrh      struct ExprList_item *pItem = &p->a[p->nExpr-1];
4267ad879ffdSdrh      pItem->reusable = regDest<0;
4268ad879ffdSdrh      if( regDest<0 ) regDest = ++pParse->nMem;
4269d673cddaSdrh      pItem->u.iConstExprReg = regDest;
4270d673cddaSdrh   }
4271d1a01edaSdrh   pParse->pConstExpr = p;
42721e9b53f9Sdrh   return regDest;
4273d1a01edaSdrh }
4274d1a01edaSdrh 
4275d1a01edaSdrh /*
42762dcef11bSdrh ** Generate code to evaluate an expression and store the results
42772dcef11bSdrh ** into a register.  Return the register number where the results
42782dcef11bSdrh ** are stored.
42792dcef11bSdrh **
42802dcef11bSdrh ** If the register is a temporary register that can be deallocated,
4281678ccce8Sdrh ** then write its number into *pReg.  If the result register is not
42822dcef11bSdrh ** a temporary, then set *pReg to zero.
4283f30a969bSdrh **
4284f30a969bSdrh ** If pExpr is a constant, then this routine might generate this
4285f30a969bSdrh ** code to fill the register in the initialization section of the
4286f30a969bSdrh ** VDBE program, in order to factor it out of the evaluation loop.
42872dcef11bSdrh */
42882dcef11bSdrh int sqlite3ExprCodeTemp(Parse *pParse, Expr *pExpr, int *pReg){
4289f30a969bSdrh   int r2;
4290f30a969bSdrh   pExpr = sqlite3ExprSkipCollate(pExpr);
4291d9f158e7Sdrh   if( ConstFactorOk(pParse)
4292f30a969bSdrh    && pExpr->op!=TK_REGISTER
4293f30a969bSdrh    && sqlite3ExprIsConstantNotJoin(pExpr)
4294f30a969bSdrh   ){
4295f30a969bSdrh     *pReg  = 0;
4296ad879ffdSdrh     r2 = sqlite3ExprCodeAtInit(pParse, pExpr, -1);
4297f30a969bSdrh   }else{
42982dcef11bSdrh     int r1 = sqlite3GetTempReg(pParse);
4299f30a969bSdrh     r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
43002dcef11bSdrh     if( r2==r1 ){
43012dcef11bSdrh       *pReg = r1;
43022dcef11bSdrh     }else{
43032dcef11bSdrh       sqlite3ReleaseTempReg(pParse, r1);
43042dcef11bSdrh       *pReg = 0;
43052dcef11bSdrh     }
4306f30a969bSdrh   }
43072dcef11bSdrh   return r2;
43082dcef11bSdrh }
43092dcef11bSdrh 
43102dcef11bSdrh /*
43112dcef11bSdrh ** Generate code that will evaluate expression pExpr and store the
43122dcef11bSdrh ** results in register target.  The results are guaranteed to appear
43132dcef11bSdrh ** in register target.
43142dcef11bSdrh */
431505a86c5cSdrh void sqlite3ExprCode(Parse *pParse, Expr *pExpr, int target){
43169cbf3425Sdrh   int inReg;
43179cbf3425Sdrh 
43189cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
4319ebc16717Sdrh   if( pExpr && pExpr->op==TK_REGISTER ){
4320ebc16717Sdrh     sqlite3VdbeAddOp2(pParse->pVdbe, OP_Copy, pExpr->iTable, target);
4321ebc16717Sdrh   }else{
43229cbf3425Sdrh     inReg = sqlite3ExprCodeTarget(pParse, pExpr, target);
43231c75c9d7Sdrh     assert( pParse->pVdbe!=0 || pParse->db->mallocFailed );
43240e359b30Sdrh     if( inReg!=target && pParse->pVdbe ){
43259cbf3425Sdrh       sqlite3VdbeAddOp2(pParse->pVdbe, OP_SCopy, inReg, target);
432617a7f8ddSdrh     }
4327ebc16717Sdrh   }
4328cce7d176Sdrh }
4329cce7d176Sdrh 
4330cce7d176Sdrh /*
43311c75c9d7Sdrh ** Make a transient copy of expression pExpr and then code it using
43321c75c9d7Sdrh ** sqlite3ExprCode().  This routine works just like sqlite3ExprCode()
43331c75c9d7Sdrh ** except that the input expression is guaranteed to be unchanged.
43341c75c9d7Sdrh */
43351c75c9d7Sdrh void sqlite3ExprCodeCopy(Parse *pParse, Expr *pExpr, int target){
43361c75c9d7Sdrh   sqlite3 *db = pParse->db;
43371c75c9d7Sdrh   pExpr = sqlite3ExprDup(db, pExpr, 0);
43381c75c9d7Sdrh   if( !db->mallocFailed ) sqlite3ExprCode(pParse, pExpr, target);
43391c75c9d7Sdrh   sqlite3ExprDelete(db, pExpr);
43401c75c9d7Sdrh }
43411c75c9d7Sdrh 
43421c75c9d7Sdrh /*
434305a86c5cSdrh ** Generate code that will evaluate expression pExpr and store the
434405a86c5cSdrh ** results in register target.  The results are guaranteed to appear
434505a86c5cSdrh ** in register target.  If the expression is constant, then this routine
434605a86c5cSdrh ** might choose to code the expression at initialization time.
434705a86c5cSdrh */
434805a86c5cSdrh void sqlite3ExprCodeFactorable(Parse *pParse, Expr *pExpr, int target){
434905a86c5cSdrh   if( pParse->okConstFactor && sqlite3ExprIsConstant(pExpr) ){
4350ad879ffdSdrh     sqlite3ExprCodeAtInit(pParse, pExpr, target);
435105a86c5cSdrh   }else{
435205a86c5cSdrh     sqlite3ExprCode(pParse, pExpr, target);
435305a86c5cSdrh   }
4354cce7d176Sdrh }
4355cce7d176Sdrh 
4356cce7d176Sdrh /*
435760ec914cSpeter.d.reid ** Generate code that evaluates the given expression and puts the result
4358de4fcfddSdrh ** in register target.
435925303780Sdrh **
43602dcef11bSdrh ** Also make a copy of the expression results into another "cache" register
43612dcef11bSdrh ** and modify the expression so that the next time it is evaluated,
43622dcef11bSdrh ** the result is a copy of the cache register.
43632dcef11bSdrh **
43642dcef11bSdrh ** This routine is used for expressions that are used multiple
43652dcef11bSdrh ** times.  They are evaluated once and the results of the expression
43662dcef11bSdrh ** are reused.
436725303780Sdrh */
436805a86c5cSdrh void sqlite3ExprCodeAndCache(Parse *pParse, Expr *pExpr, int target){
436925303780Sdrh   Vdbe *v = pParse->pVdbe;
437025303780Sdrh   int iMem;
437105a86c5cSdrh 
437205a86c5cSdrh   assert( target>0 );
437305a86c5cSdrh   assert( pExpr->op!=TK_REGISTER );
437405a86c5cSdrh   sqlite3ExprCode(pParse, pExpr, target);
43752dcef11bSdrh   iMem = ++pParse->nMem;
437605a86c5cSdrh   sqlite3VdbeAddOp2(v, OP_Copy, target, iMem);
4377a4c3c87eSdrh   exprToRegister(pExpr, iMem);
437825303780Sdrh }
43797e02e5e6Sdrh 
4380678ccce8Sdrh /*
4381268380caSdrh ** Generate code that pushes the value of every element of the given
43829cbf3425Sdrh ** expression list into a sequence of registers beginning at target.
4383268380caSdrh **
43843df6c3b1Sdrh ** Return the number of elements evaluated.  The number returned will
43853df6c3b1Sdrh ** usually be pList->nExpr but might be reduced if SQLITE_ECEL_OMITREF
43863df6c3b1Sdrh ** is defined.
4387d1a01edaSdrh **
4388d1a01edaSdrh ** The SQLITE_ECEL_DUP flag prevents the arguments from being
4389d1a01edaSdrh ** filled using OP_SCopy.  OP_Copy must be used instead.
4390d1a01edaSdrh **
4391d1a01edaSdrh ** The SQLITE_ECEL_FACTOR argument allows constant arguments to be
4392d1a01edaSdrh ** factored out into initialization code.
4393b0df9634Sdrh **
4394b0df9634Sdrh ** The SQLITE_ECEL_REF flag means that expressions in the list with
4395b0df9634Sdrh ** ExprList.a[].u.x.iOrderByCol>0 have already been evaluated and stored
4396b0df9634Sdrh ** in registers at srcReg, and so the value can be copied from there.
43973df6c3b1Sdrh ** If SQLITE_ECEL_OMITREF is also set, then the values with u.x.iOrderByCol>0
43983df6c3b1Sdrh ** are simply omitted rather than being copied from srcReg.
4399268380caSdrh */
44004adee20fSdanielk1977 int sqlite3ExprCodeExprList(
4401268380caSdrh   Parse *pParse,     /* Parsing context */
4402389a1adbSdrh   ExprList *pList,   /* The expression list to be coded */
4403191b54cbSdrh   int target,        /* Where to write results */
44045579d59fSdrh   int srcReg,        /* Source registers if SQLITE_ECEL_REF */
4405d1a01edaSdrh   u8 flags           /* SQLITE_ECEL_* flags */
4406268380caSdrh ){
4407268380caSdrh   struct ExprList_item *pItem;
44085579d59fSdrh   int i, j, n;
4409d1a01edaSdrh   u8 copyOp = (flags & SQLITE_ECEL_DUP) ? OP_Copy : OP_SCopy;
44105579d59fSdrh   Vdbe *v = pParse->pVdbe;
44119d8b3072Sdrh   assert( pList!=0 );
44129cbf3425Sdrh   assert( target>0 );
4413d81a142bSdrh   assert( pParse->pVdbe!=0 );  /* Never gets this far otherwise */
4414268380caSdrh   n = pList->nExpr;
4415d9f158e7Sdrh   if( !ConstFactorOk(pParse) ) flags &= ~SQLITE_ECEL_FACTOR;
4416191b54cbSdrh   for(pItem=pList->a, i=0; i<n; i++, pItem++){
44177445ffe2Sdrh     Expr *pExpr = pItem->pExpr;
441824e25d32Sdan #ifdef SQLITE_ENABLE_SORTER_REFERENCES
441924e25d32Sdan     if( pItem->bSorterRef ){
442024e25d32Sdan       i--;
442124e25d32Sdan       n--;
442224e25d32Sdan     }else
442324e25d32Sdan #endif
4424257c13faSdan     if( (flags & SQLITE_ECEL_REF)!=0 && (j = pItem->u.x.iOrderByCol)>0 ){
4425257c13faSdan       if( flags & SQLITE_ECEL_OMITREF ){
4426257c13faSdan         i--;
4427257c13faSdan         n--;
4428257c13faSdan       }else{
44295579d59fSdrh         sqlite3VdbeAddOp2(v, copyOp, j+srcReg-1, target+i);
4430257c13faSdan       }
44315579d59fSdrh     }else if( (flags & SQLITE_ECEL_FACTOR)!=0 && sqlite3ExprIsConstant(pExpr) ){
4432ad879ffdSdrh       sqlite3ExprCodeAtInit(pParse, pExpr, target+i);
4433d1a01edaSdrh     }else{
44347445ffe2Sdrh       int inReg = sqlite3ExprCodeTarget(pParse, pExpr, target+i);
4435746fd9ccSdrh       if( inReg!=target+i ){
44364eded604Sdrh         VdbeOp *pOp;
44374eded604Sdrh         if( copyOp==OP_Copy
44384eded604Sdrh          && (pOp=sqlite3VdbeGetOp(v, -1))->opcode==OP_Copy
44394eded604Sdrh          && pOp->p1+pOp->p3+1==inReg
44404eded604Sdrh          && pOp->p2+pOp->p3+1==target+i
44414eded604Sdrh         ){
44424eded604Sdrh           pOp->p3++;
44434eded604Sdrh         }else{
44444eded604Sdrh           sqlite3VdbeAddOp2(v, copyOp, inReg, target+i);
44454eded604Sdrh         }
4446d1a01edaSdrh       }
4447d176611bSdrh     }
4448268380caSdrh   }
4449f9b596ebSdrh   return n;
4450268380caSdrh }
4451268380caSdrh 
4452268380caSdrh /*
445336c563a2Sdrh ** Generate code for a BETWEEN operator.
445436c563a2Sdrh **
445536c563a2Sdrh **    x BETWEEN y AND z
445636c563a2Sdrh **
445736c563a2Sdrh ** The above is equivalent to
445836c563a2Sdrh **
445936c563a2Sdrh **    x>=y AND x<=z
446036c563a2Sdrh **
446136c563a2Sdrh ** Code it as such, taking care to do the common subexpression
446260ec914cSpeter.d.reid ** elimination of x.
446384b19a3dSdrh **
446484b19a3dSdrh ** The xJumpIf parameter determines details:
446584b19a3dSdrh **
446684b19a3dSdrh **    NULL:                   Store the boolean result in reg[dest]
446784b19a3dSdrh **    sqlite3ExprIfTrue:      Jump to dest if true
446884b19a3dSdrh **    sqlite3ExprIfFalse:     Jump to dest if false
446984b19a3dSdrh **
447084b19a3dSdrh ** The jumpIfNull parameter is ignored if xJumpIf is NULL.
447136c563a2Sdrh */
447236c563a2Sdrh static void exprCodeBetween(
447336c563a2Sdrh   Parse *pParse,    /* Parsing and code generating context */
447436c563a2Sdrh   Expr *pExpr,      /* The BETWEEN expression */
447584b19a3dSdrh   int dest,         /* Jump destination or storage location */
447684b19a3dSdrh   void (*xJump)(Parse*,Expr*,int,int), /* Action to take */
447736c563a2Sdrh   int jumpIfNull    /* Take the jump if the BETWEEN is NULL */
447836c563a2Sdrh ){
447936c563a2Sdrh  Expr exprAnd;     /* The AND operator in  x>=y AND x<=z  */
448036c563a2Sdrh   Expr compLeft;    /* The  x>=y  term */
448136c563a2Sdrh   Expr compRight;   /* The  x<=z  term */
4482db45bd5eSdrh   Expr exprX;       /* The  x  subexpression */
4483db45bd5eSdrh   int regFree1 = 0; /* Temporary use register */
448484b19a3dSdrh 
448536c563a2Sdrh 
448671c57db0Sdan   memset(&compLeft, 0, sizeof(Expr));
448771c57db0Sdan   memset(&compRight, 0, sizeof(Expr));
448871c57db0Sdan   memset(&exprAnd, 0, sizeof(Expr));
4489db45bd5eSdrh 
4490db45bd5eSdrh   assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
4491db45bd5eSdrh   exprX = *pExpr->pLeft;
449236c563a2Sdrh   exprAnd.op = TK_AND;
449336c563a2Sdrh   exprAnd.pLeft = &compLeft;
449436c563a2Sdrh   exprAnd.pRight = &compRight;
449536c563a2Sdrh   compLeft.op = TK_GE;
4496db45bd5eSdrh   compLeft.pLeft = &exprX;
449736c563a2Sdrh   compLeft.pRight = pExpr->x.pList->a[0].pExpr;
449836c563a2Sdrh   compRight.op = TK_LE;
4499db45bd5eSdrh   compRight.pLeft = &exprX;
450036c563a2Sdrh   compRight.pRight = pExpr->x.pList->a[1].pExpr;
450112abf408Sdrh   exprToRegister(&exprX, exprCodeVector(pParse, &exprX, &regFree1));
450284b19a3dSdrh   if( xJump ){
450384b19a3dSdrh     xJump(pParse, &exprAnd, dest, jumpIfNull);
450436c563a2Sdrh   }else{
450536fd41e5Sdrh     /* Mark the expression is being from the ON or USING clause of a join
450636fd41e5Sdrh     ** so that the sqlite3ExprCodeTarget() routine will not attempt to move
450736fd41e5Sdrh     ** it into the Parse.pConstExpr list.  We should use a new bit for this,
450836fd41e5Sdrh     ** for clarity, but we are out of bits in the Expr.flags field so we
450936fd41e5Sdrh     ** have to reuse the EP_FromJoin bit.  Bummer. */
4510db45bd5eSdrh     exprX.flags |= EP_FromJoin;
451171c57db0Sdan     sqlite3ExprCodeTarget(pParse, &exprAnd, dest);
451236c563a2Sdrh   }
4513db45bd5eSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
451436c563a2Sdrh 
451536c563a2Sdrh   /* Ensure adequate test coverage */
4516db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull==0 && regFree1==0 );
4517db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull==0 && regFree1!=0 );
4518db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull!=0 && regFree1==0 );
4519db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull!=0 && regFree1!=0 );
4520db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1==0 );
4521db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1!=0 );
4522db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1==0 );
4523db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1!=0 );
452484b19a3dSdrh   testcase( xJump==0 );
452536c563a2Sdrh }
452636c563a2Sdrh 
452736c563a2Sdrh /*
4528cce7d176Sdrh ** Generate code for a boolean expression such that a jump is made
4529cce7d176Sdrh ** to the label "dest" if the expression is true but execution
4530cce7d176Sdrh ** continues straight thru if the expression is false.
4531f5905aa7Sdrh **
4532f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false), then
453335573356Sdrh ** take the jump if the jumpIfNull flag is SQLITE_JUMPIFNULL.
4534f2bc013cSdrh **
4535f2bc013cSdrh ** This code depends on the fact that certain token values (ex: TK_EQ)
4536f2bc013cSdrh ** are the same as opcode values (ex: OP_Eq) that implement the corresponding
4537f2bc013cSdrh ** operation.  Special comments in vdbe.c and the mkopcodeh.awk script in
4538f2bc013cSdrh ** the make process cause these values to align.  Assert()s in the code
4539f2bc013cSdrh ** below verify that the numbers are aligned correctly.
4540cce7d176Sdrh */
45414adee20fSdanielk1977 void sqlite3ExprIfTrue(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
4542cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
4543cce7d176Sdrh   int op = 0;
45442dcef11bSdrh   int regFree1 = 0;
45452dcef11bSdrh   int regFree2 = 0;
45462dcef11bSdrh   int r1, r2;
45472dcef11bSdrh 
454835573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
454948864df9Smistachkin   if( NEVER(v==0) )     return;  /* Existence of VDBE checked by caller */
455033cd4909Sdrh   if( NEVER(pExpr==0) ) return;  /* No way this can happen */
4551f2bc013cSdrh   op = pExpr->op;
45527b35a77bSdan   switch( op ){
4553cce7d176Sdrh     case TK_AND: {
45544adee20fSdanielk1977       int d2 = sqlite3VdbeMakeLabel(v);
4555c5499befSdrh       testcase( jumpIfNull==0 );
455635573356Sdrh       sqlite3ExprIfFalse(pParse, pExpr->pLeft, d2,jumpIfNull^SQLITE_JUMPIFNULL);
455754e2adb5Sdrh       sqlite3ExprCachePush(pParse);
45584adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
45594adee20fSdanielk1977       sqlite3VdbeResolveLabel(v, d2);
4560d2490904Sdrh       sqlite3ExprCachePop(pParse);
4561cce7d176Sdrh       break;
4562cce7d176Sdrh     }
4563cce7d176Sdrh     case TK_OR: {
4564c5499befSdrh       testcase( jumpIfNull==0 );
45654adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
456654e2adb5Sdrh       sqlite3ExprCachePush(pParse);
45674adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
4568d2490904Sdrh       sqlite3ExprCachePop(pParse);
4569cce7d176Sdrh       break;
4570cce7d176Sdrh     }
4571cce7d176Sdrh     case TK_NOT: {
4572c5499befSdrh       testcase( jumpIfNull==0 );
45734adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
4574cce7d176Sdrh       break;
4575cce7d176Sdrh     }
45768abed7b9Sdrh     case TK_TRUTH: {
457796acafbeSdrh       int isNot;      /* IS NOT TRUE or IS NOT FALSE */
457896acafbeSdrh       int isTrue;     /* IS TRUE or IS NOT TRUE */
4579007c843bSdrh       testcase( jumpIfNull==0 );
45808abed7b9Sdrh       isNot = pExpr->op2==TK_ISNOT;
458196acafbeSdrh       isTrue = sqlite3ExprTruthValue(pExpr->pRight);
458243c4ac8bSdrh       testcase( isTrue && isNot );
458396acafbeSdrh       testcase( !isTrue && isNot );
458443c4ac8bSdrh       if( isTrue ^ isNot ){
45858abed7b9Sdrh         sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
45868abed7b9Sdrh                           isNot ? SQLITE_JUMPIFNULL : 0);
45878abed7b9Sdrh       }else{
45888abed7b9Sdrh         sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
45898abed7b9Sdrh                            isNot ? SQLITE_JUMPIFNULL : 0);
45908abed7b9Sdrh       }
4591007c843bSdrh       break;
4592007c843bSdrh     }
4593de845c2fSdrh     case TK_IS:
4594de845c2fSdrh     case TK_ISNOT:
4595de845c2fSdrh       testcase( op==TK_IS );
4596de845c2fSdrh       testcase( op==TK_ISNOT );
4597de845c2fSdrh       op = (op==TK_IS) ? TK_EQ : TK_NE;
4598de845c2fSdrh       jumpIfNull = SQLITE_NULLEQ;
4599de845c2fSdrh       /* Fall thru */
4600cce7d176Sdrh     case TK_LT:
4601cce7d176Sdrh     case TK_LE:
4602cce7d176Sdrh     case TK_GT:
4603cce7d176Sdrh     case TK_GE:
4604cce7d176Sdrh     case TK_NE:
46050ac65892Sdrh     case TK_EQ: {
4606625015e0Sdan       if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
4607c5499befSdrh       testcase( jumpIfNull==0 );
4608b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4609b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
461035573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
46112dcef11bSdrh                   r1, r2, dest, jumpIfNull);
46127d176105Sdrh       assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
46137d176105Sdrh       assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
46147d176105Sdrh       assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
46157d176105Sdrh       assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
4616de845c2fSdrh       assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4617de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4618de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4619de845c2fSdrh       assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4620de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
4621de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
46226a2fe093Sdrh       testcase( regFree1==0 );
46236a2fe093Sdrh       testcase( regFree2==0 );
46246a2fe093Sdrh       break;
46256a2fe093Sdrh     }
4626cce7d176Sdrh     case TK_ISNULL:
4627cce7d176Sdrh     case TK_NOTNULL: {
46287d176105Sdrh       assert( TK_ISNULL==OP_IsNull );   testcase( op==TK_ISNULL );
46297d176105Sdrh       assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
46302dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
46312dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
46327d176105Sdrh       VdbeCoverageIf(v, op==TK_ISNULL);
46337d176105Sdrh       VdbeCoverageIf(v, op==TK_NOTNULL);
4634c5499befSdrh       testcase( regFree1==0 );
4635cce7d176Sdrh       break;
4636cce7d176Sdrh     }
4637fef5208cSdrh     case TK_BETWEEN: {
46385c03f30aSdrh       testcase( jumpIfNull==0 );
463971c57db0Sdan       exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfTrue, jumpIfNull);
4640fef5208cSdrh       break;
4641fef5208cSdrh     }
4642bb201344Sshaneh #ifndef SQLITE_OMIT_SUBQUERY
4643e3365e6cSdrh     case TK_IN: {
4644e3365e6cSdrh       int destIfFalse = sqlite3VdbeMakeLabel(v);
4645e3365e6cSdrh       int destIfNull = jumpIfNull ? dest : destIfFalse;
4646e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
4647076e85f5Sdrh       sqlite3VdbeGoto(v, dest);
4648e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
4649e3365e6cSdrh       break;
4650e3365e6cSdrh     }
4651bb201344Sshaneh #endif
4652cce7d176Sdrh     default: {
46537b35a77bSdan     default_expr:
4654991a1985Sdrh       if( exprAlwaysTrue(pExpr) ){
4655076e85f5Sdrh         sqlite3VdbeGoto(v, dest);
4656991a1985Sdrh       }else if( exprAlwaysFalse(pExpr) ){
4657991a1985Sdrh         /* No-op */
4658991a1985Sdrh       }else{
46592dcef11bSdrh         r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
46602dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_If, r1, dest, jumpIfNull!=0);
4661688852abSdrh         VdbeCoverage(v);
4662c5499befSdrh         testcase( regFree1==0 );
4663c5499befSdrh         testcase( jumpIfNull==0 );
4664991a1985Sdrh       }
4665cce7d176Sdrh       break;
4666cce7d176Sdrh     }
4667cce7d176Sdrh   }
46682dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
46692dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
4670cce7d176Sdrh }
4671cce7d176Sdrh 
4672cce7d176Sdrh /*
467366b89c8fSdrh ** Generate code for a boolean expression such that a jump is made
4674cce7d176Sdrh ** to the label "dest" if the expression is false but execution
4675cce7d176Sdrh ** continues straight thru if the expression is true.
4676f5905aa7Sdrh **
4677f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false) then
467835573356Sdrh ** jump if jumpIfNull is SQLITE_JUMPIFNULL or fall through if jumpIfNull
467935573356Sdrh ** is 0.
4680cce7d176Sdrh */
46814adee20fSdanielk1977 void sqlite3ExprIfFalse(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
4682cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
4683cce7d176Sdrh   int op = 0;
46842dcef11bSdrh   int regFree1 = 0;
46852dcef11bSdrh   int regFree2 = 0;
46862dcef11bSdrh   int r1, r2;
46872dcef11bSdrh 
468835573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
468948864df9Smistachkin   if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
469033cd4909Sdrh   if( pExpr==0 )    return;
4691f2bc013cSdrh 
4692f2bc013cSdrh   /* The value of pExpr->op and op are related as follows:
4693f2bc013cSdrh   **
4694f2bc013cSdrh   **       pExpr->op            op
4695f2bc013cSdrh   **       ---------          ----------
4696f2bc013cSdrh   **       TK_ISNULL          OP_NotNull
4697f2bc013cSdrh   **       TK_NOTNULL         OP_IsNull
4698f2bc013cSdrh   **       TK_NE              OP_Eq
4699f2bc013cSdrh   **       TK_EQ              OP_Ne
4700f2bc013cSdrh   **       TK_GT              OP_Le
4701f2bc013cSdrh   **       TK_LE              OP_Gt
4702f2bc013cSdrh   **       TK_GE              OP_Lt
4703f2bc013cSdrh   **       TK_LT              OP_Ge
4704f2bc013cSdrh   **
4705f2bc013cSdrh   ** For other values of pExpr->op, op is undefined and unused.
4706f2bc013cSdrh   ** The value of TK_ and OP_ constants are arranged such that we
4707f2bc013cSdrh   ** can compute the mapping above using the following expression.
4708f2bc013cSdrh   ** Assert()s verify that the computation is correct.
4709f2bc013cSdrh   */
4710f2bc013cSdrh   op = ((pExpr->op+(TK_ISNULL&1))^1)-(TK_ISNULL&1);
4711f2bc013cSdrh 
4712f2bc013cSdrh   /* Verify correct alignment of TK_ and OP_ constants
4713f2bc013cSdrh   */
4714f2bc013cSdrh   assert( pExpr->op!=TK_ISNULL || op==OP_NotNull );
4715f2bc013cSdrh   assert( pExpr->op!=TK_NOTNULL || op==OP_IsNull );
4716f2bc013cSdrh   assert( pExpr->op!=TK_NE || op==OP_Eq );
4717f2bc013cSdrh   assert( pExpr->op!=TK_EQ || op==OP_Ne );
4718f2bc013cSdrh   assert( pExpr->op!=TK_LT || op==OP_Ge );
4719f2bc013cSdrh   assert( pExpr->op!=TK_LE || op==OP_Gt );
4720f2bc013cSdrh   assert( pExpr->op!=TK_GT || op==OP_Le );
4721f2bc013cSdrh   assert( pExpr->op!=TK_GE || op==OP_Lt );
4722f2bc013cSdrh 
4723ba00e30aSdan   switch( pExpr->op ){
4724cce7d176Sdrh     case TK_AND: {
4725c5499befSdrh       testcase( jumpIfNull==0 );
47264adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
472754e2adb5Sdrh       sqlite3ExprCachePush(pParse);
47284adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
4729d2490904Sdrh       sqlite3ExprCachePop(pParse);
4730cce7d176Sdrh       break;
4731cce7d176Sdrh     }
4732cce7d176Sdrh     case TK_OR: {
47334adee20fSdanielk1977       int d2 = sqlite3VdbeMakeLabel(v);
4734c5499befSdrh       testcase( jumpIfNull==0 );
473535573356Sdrh       sqlite3ExprIfTrue(pParse, pExpr->pLeft, d2, jumpIfNull^SQLITE_JUMPIFNULL);
473654e2adb5Sdrh       sqlite3ExprCachePush(pParse);
47374adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
47384adee20fSdanielk1977       sqlite3VdbeResolveLabel(v, d2);
4739d2490904Sdrh       sqlite3ExprCachePop(pParse);
4740cce7d176Sdrh       break;
4741cce7d176Sdrh     }
4742cce7d176Sdrh     case TK_NOT: {
47435c03f30aSdrh       testcase( jumpIfNull==0 );
47444adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
4745cce7d176Sdrh       break;
4746cce7d176Sdrh     }
47478abed7b9Sdrh     case TK_TRUTH: {
474896acafbeSdrh       int isNot;   /* IS NOT TRUE or IS NOT FALSE */
474996acafbeSdrh       int isTrue;  /* IS TRUE or IS NOT TRUE */
47508abed7b9Sdrh       testcase( jumpIfNull==0 );
47518abed7b9Sdrh       isNot = pExpr->op2==TK_ISNOT;
475296acafbeSdrh       isTrue = sqlite3ExprTruthValue(pExpr->pRight);
475343c4ac8bSdrh       testcase( isTrue && isNot );
475496acafbeSdrh       testcase( !isTrue && isNot );
475543c4ac8bSdrh       if( isTrue ^ isNot ){
47568abed7b9Sdrh         /* IS TRUE and IS NOT FALSE */
47578abed7b9Sdrh         sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
47588abed7b9Sdrh                            isNot ? 0 : SQLITE_JUMPIFNULL);
47598abed7b9Sdrh 
47608abed7b9Sdrh       }else{
47618abed7b9Sdrh         /* IS FALSE and IS NOT TRUE */
47628abed7b9Sdrh         sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
47638abed7b9Sdrh                           isNot ? 0 : SQLITE_JUMPIFNULL);
47648abed7b9Sdrh       }
4765007c843bSdrh       break;
4766007c843bSdrh     }
4767de845c2fSdrh     case TK_IS:
4768de845c2fSdrh     case TK_ISNOT:
4769de845c2fSdrh       testcase( pExpr->op==TK_IS );
4770de845c2fSdrh       testcase( pExpr->op==TK_ISNOT );
4771de845c2fSdrh       op = (pExpr->op==TK_IS) ? TK_NE : TK_EQ;
4772de845c2fSdrh       jumpIfNull = SQLITE_NULLEQ;
4773de845c2fSdrh       /* Fall thru */
4774cce7d176Sdrh     case TK_LT:
4775cce7d176Sdrh     case TK_LE:
4776cce7d176Sdrh     case TK_GT:
4777cce7d176Sdrh     case TK_GE:
4778cce7d176Sdrh     case TK_NE:
4779cce7d176Sdrh     case TK_EQ: {
4780625015e0Sdan       if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
4781c5499befSdrh       testcase( jumpIfNull==0 );
4782b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4783b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
478435573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
47852dcef11bSdrh                   r1, r2, dest, jumpIfNull);
47867d176105Sdrh       assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
47877d176105Sdrh       assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
47887d176105Sdrh       assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
47897d176105Sdrh       assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
4790de845c2fSdrh       assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4791de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4792de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4793de845c2fSdrh       assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4794de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
4795de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
47966a2fe093Sdrh       testcase( regFree1==0 );
47976a2fe093Sdrh       testcase( regFree2==0 );
47986a2fe093Sdrh       break;
47996a2fe093Sdrh     }
4800cce7d176Sdrh     case TK_ISNULL:
4801cce7d176Sdrh     case TK_NOTNULL: {
48022dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
48032dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
48047d176105Sdrh       testcase( op==TK_ISNULL );   VdbeCoverageIf(v, op==TK_ISNULL);
48057d176105Sdrh       testcase( op==TK_NOTNULL );  VdbeCoverageIf(v, op==TK_NOTNULL);
4806c5499befSdrh       testcase( regFree1==0 );
4807cce7d176Sdrh       break;
4808cce7d176Sdrh     }
4809fef5208cSdrh     case TK_BETWEEN: {
48105c03f30aSdrh       testcase( jumpIfNull==0 );
481171c57db0Sdan       exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfFalse, jumpIfNull);
4812fef5208cSdrh       break;
4813fef5208cSdrh     }
4814bb201344Sshaneh #ifndef SQLITE_OMIT_SUBQUERY
4815e3365e6cSdrh     case TK_IN: {
4816e3365e6cSdrh       if( jumpIfNull ){
4817e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, dest);
4818e3365e6cSdrh       }else{
4819e3365e6cSdrh         int destIfNull = sqlite3VdbeMakeLabel(v);
4820e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, destIfNull);
4821e3365e6cSdrh         sqlite3VdbeResolveLabel(v, destIfNull);
4822e3365e6cSdrh       }
4823e3365e6cSdrh       break;
4824e3365e6cSdrh     }
4825bb201344Sshaneh #endif
4826cce7d176Sdrh     default: {
4827ba00e30aSdan     default_expr:
4828991a1985Sdrh       if( exprAlwaysFalse(pExpr) ){
4829076e85f5Sdrh         sqlite3VdbeGoto(v, dest);
4830991a1985Sdrh       }else if( exprAlwaysTrue(pExpr) ){
4831991a1985Sdrh         /* no-op */
4832991a1985Sdrh       }else{
48332dcef11bSdrh         r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
48342dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_IfNot, r1, dest, jumpIfNull!=0);
4835688852abSdrh         VdbeCoverage(v);
4836c5499befSdrh         testcase( regFree1==0 );
4837c5499befSdrh         testcase( jumpIfNull==0 );
4838991a1985Sdrh       }
4839cce7d176Sdrh       break;
4840cce7d176Sdrh     }
4841cce7d176Sdrh   }
48422dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
48432dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
4844cce7d176Sdrh }
48452282792aSdrh 
48462282792aSdrh /*
484772bc8208Sdrh ** Like sqlite3ExprIfFalse() except that a copy is made of pExpr before
484872bc8208Sdrh ** code generation, and that copy is deleted after code generation. This
484972bc8208Sdrh ** ensures that the original pExpr is unchanged.
485072bc8208Sdrh */
485172bc8208Sdrh void sqlite3ExprIfFalseDup(Parse *pParse, Expr *pExpr, int dest,int jumpIfNull){
485272bc8208Sdrh   sqlite3 *db = pParse->db;
485372bc8208Sdrh   Expr *pCopy = sqlite3ExprDup(db, pExpr, 0);
485472bc8208Sdrh   if( db->mallocFailed==0 ){
485572bc8208Sdrh     sqlite3ExprIfFalse(pParse, pCopy, dest, jumpIfNull);
485672bc8208Sdrh   }
485772bc8208Sdrh   sqlite3ExprDelete(db, pCopy);
485872bc8208Sdrh }
485972bc8208Sdrh 
48605aa550cfSdan /*
48615aa550cfSdan ** Expression pVar is guaranteed to be an SQL variable. pExpr may be any
48625aa550cfSdan ** type of expression.
48635aa550cfSdan **
48645aa550cfSdan ** If pExpr is a simple SQL value - an integer, real, string, blob
48655aa550cfSdan ** or NULL value - then the VDBE currently being prepared is configured
48665aa550cfSdan ** to re-prepare each time a new value is bound to variable pVar.
48675aa550cfSdan **
48685aa550cfSdan ** Additionally, if pExpr is a simple SQL value and the value is the
48695aa550cfSdan ** same as that currently bound to variable pVar, non-zero is returned.
48705aa550cfSdan ** Otherwise, if the values are not the same or if pExpr is not a simple
48715aa550cfSdan ** SQL value, zero is returned.
48725aa550cfSdan */
48735aa550cfSdan static int exprCompareVariable(Parse *pParse, Expr *pVar, Expr *pExpr){
48745aa550cfSdan   int res = 0;
4875c0804226Sdrh   int iVar;
4876c0804226Sdrh   sqlite3_value *pL, *pR = 0;
48775aa550cfSdan 
48785aa550cfSdan   sqlite3ValueFromExpr(pParse->db, pExpr, SQLITE_UTF8, SQLITE_AFF_BLOB, &pR);
4879c0804226Sdrh   if( pR ){
4880c0804226Sdrh     iVar = pVar->iColumn;
4881c0804226Sdrh     sqlite3VdbeSetVarmask(pParse->pVdbe, iVar);
4882c0804226Sdrh     pL = sqlite3VdbeGetBoundValue(pParse->pReprepare, iVar, SQLITE_AFF_BLOB);
48835aa307e2Sdrh     if( pL ){
48845aa307e2Sdrh       if( sqlite3_value_type(pL)==SQLITE_TEXT ){
48855aa307e2Sdrh         sqlite3_value_text(pL); /* Make sure the encoding is UTF-8 */
48865aa307e2Sdrh       }
48875aa307e2Sdrh       res =  0==sqlite3MemCompare(pL, pR, 0);
48885aa550cfSdan     }
48895aa550cfSdan     sqlite3ValueFree(pR);
48905aa550cfSdan     sqlite3ValueFree(pL);
48915aa550cfSdan   }
48925aa550cfSdan 
48935aa550cfSdan   return res;
48945aa550cfSdan }
489572bc8208Sdrh 
489672bc8208Sdrh /*
48971d9da70aSdrh ** Do a deep comparison of two expression trees.  Return 0 if the two
48981d9da70aSdrh ** expressions are completely identical.  Return 1 if they differ only
48991d9da70aSdrh ** by a COLLATE operator at the top level.  Return 2 if there are differences
49001d9da70aSdrh ** other than the top-level COLLATE operator.
4901d40aab0eSdrh **
4902619a1305Sdrh ** If any subelement of pB has Expr.iTable==(-1) then it is allowed
4903619a1305Sdrh ** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
4904619a1305Sdrh **
490566518ca7Sdrh ** The pA side might be using TK_REGISTER.  If that is the case and pB is
490666518ca7Sdrh ** not using TK_REGISTER but is otherwise equivalent, then still return 0.
490766518ca7Sdrh **
49081d9da70aSdrh ** Sometimes this routine will return 2 even if the two expressions
4909d40aab0eSdrh ** really are equivalent.  If we cannot prove that the expressions are
49101d9da70aSdrh ** identical, we return 2 just to be safe.  So if this routine
49111d9da70aSdrh ** returns 2, then you do not really know for certain if the two
49121d9da70aSdrh ** expressions are the same.  But if you get a 0 or 1 return, then you
4913d40aab0eSdrh ** can be sure the expressions are the same.  In the places where
49141d9da70aSdrh ** this routine is used, it does not hurt to get an extra 2 - that
4915d40aab0eSdrh ** just might result in some slightly slower code.  But returning
49161d9da70aSdrh ** an incorrect 0 or 1 could lead to a malfunction.
49175aa550cfSdan **
4918c0804226Sdrh ** If pParse is not NULL then TK_VARIABLE terms in pA with bindings in
4919c0804226Sdrh ** pParse->pReprepare can be matched against literals in pB.  The
4920c0804226Sdrh ** pParse->pVdbe->expmask bitmask is updated for each variable referenced.
4921c0804226Sdrh ** If pParse is NULL (the normal case) then any TK_VARIABLE term in
4922c0804226Sdrh ** Argument pParse should normally be NULL. If it is not NULL and pA or
4923c0804226Sdrh ** pB causes a return value of 2.
49242282792aSdrh */
49255aa550cfSdan int sqlite3ExprCompare(Parse *pParse, Expr *pA, Expr *pB, int iTab){
492610d1edf0Sdrh   u32 combinedFlags;
49274b202ae2Sdanielk1977   if( pA==0 || pB==0 ){
49281d9da70aSdrh     return pB==pA ? 0 : 2;
49292282792aSdrh   }
49305aa550cfSdan   if( pParse && pA->op==TK_VARIABLE && exprCompareVariable(pParse, pA, pB) ){
49315aa550cfSdan     return 0;
49325aa550cfSdan   }
493310d1edf0Sdrh   combinedFlags = pA->flags | pB->flags;
493410d1edf0Sdrh   if( combinedFlags & EP_IntValue ){
493510d1edf0Sdrh     if( (pA->flags&pB->flags&EP_IntValue)!=0 && pA->u.iValue==pB->u.iValue ){
493610d1edf0Sdrh       return 0;
493710d1edf0Sdrh     }
49381d9da70aSdrh     return 2;
49396ab3a2ecSdanielk1977   }
4940c2acc4e4Sdrh   if( pA->op!=pB->op ){
49415aa550cfSdan     if( pA->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA->pLeft,pB,iTab)<2 ){
4942ae80ddeaSdrh       return 1;
4943ae80ddeaSdrh     }
49445aa550cfSdan     if( pB->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA,pB->pLeft,iTab)<2 ){
4945ae80ddeaSdrh       return 1;
4946ae80ddeaSdrh     }
4947ae80ddeaSdrh     return 2;
4948ae80ddeaSdrh   }
49492edc5fd7Sdrh   if( pA->op!=TK_COLUMN && pA->op!=TK_AGG_COLUMN && pA->u.zToken ){
4950390b88a4Sdrh     if( pA->op==TK_FUNCTION ){
4951390b88a4Sdrh       if( sqlite3StrICmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
4952d5af5420Sdrh     }else if( pA->op==TK_COLLATE ){
4953e79f6299Sdrh       if( sqlite3_stricmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
4954*efad2e23Sdrh     }else if( strcmp(pA->u.zToken,pB->u.zToken)!=0 ){
4955d5af5420Sdrh       return 2;
495610d1edf0Sdrh     }
495710d1edf0Sdrh   }
495810d1edf0Sdrh   if( (pA->flags & EP_Distinct)!=(pB->flags & EP_Distinct) ) return 2;
495985f8aa79Sdrh   if( ALWAYS((combinedFlags & EP_TokenOnly)==0) ){
496010d1edf0Sdrh     if( combinedFlags & EP_xIsSelect ) return 2;
4961*efad2e23Sdrh     if( (combinedFlags & EP_FixedCol)==0
4962*efad2e23Sdrh      && sqlite3ExprCompare(pParse, pA->pLeft, pB->pLeft, iTab) ) return 2;
49635aa550cfSdan     if( sqlite3ExprCompare(pParse, pA->pRight, pB->pRight, iTab) ) return 2;
4964619a1305Sdrh     if( sqlite3ExprListCompare(pA->x.pList, pB->x.pList, iTab) ) return 2;
4965f49ff6ffSdrh     assert( (combinedFlags & EP_Reduced)==0 );
4966f49ff6ffSdrh     if( pA->op!=TK_STRING && pA->op!=TK_TRUEFALSE ){
4967619a1305Sdrh       if( pA->iColumn!=pB->iColumn ) return 2;
496866518ca7Sdrh       if( pA->iTable!=pB->iTable
496985f8aa79Sdrh        && (pA->iTable!=iTab || NEVER(pB->iTable>=0)) ) return 2;
49701d9da70aSdrh     }
49716cbb4c93Sdrh #ifndef SQLITE_OMIT_WINDOWFUNC
497238630ae1Sdrh     /* Justification for the assert():
4973eee08611Sdrh     ** window functions have p->op==TK_FUNCTION but aggregate functions
497438630ae1Sdrh     ** have p->op==TK_AGG_FUNCTION.  So any comparison between an aggregate
497538630ae1Sdrh     ** function and a window function should have failed before reaching
497638630ae1Sdrh     ** this point.  And, it is not possible to have a window function and
497738630ae1Sdrh     ** a scalar function with the same name and number of arguments.  So
497838630ae1Sdrh     ** if we reach this point, either A and B both window functions or
497938630ae1Sdrh     ** neither are a window functions. */
498038630ae1Sdrh     assert( (pA->pWin==0)==(pB->pWin==0) );
498138630ae1Sdrh 
49826cbb4c93Sdrh     if( pA->pWin!=0 ){
49836cbb4c93Sdrh       if( sqlite3WindowCompare(pParse,pA->pWin,pB->pWin)!=0 ) return 2;
49846cbb4c93Sdrh     }
49856cbb4c93Sdrh #endif
49861d9da70aSdrh   }
49872646da7eSdrh   return 0;
49882646da7eSdrh }
49892282792aSdrh 
49908c6f666bSdrh /*
49918c6f666bSdrh ** Compare two ExprList objects.  Return 0 if they are identical and
49928c6f666bSdrh ** non-zero if they differ in any way.
49938c6f666bSdrh **
4994619a1305Sdrh ** If any subelement of pB has Expr.iTable==(-1) then it is allowed
4995619a1305Sdrh ** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
4996619a1305Sdrh **
49978c6f666bSdrh ** This routine might return non-zero for equivalent ExprLists.  The
49988c6f666bSdrh ** only consequence will be disabled optimizations.  But this routine
49998c6f666bSdrh ** must never return 0 if the two ExprList objects are different, or
50008c6f666bSdrh ** a malfunction will result.
50018c6f666bSdrh **
50028c6f666bSdrh ** Two NULL pointers are considered to be the same.  But a NULL pointer
50038c6f666bSdrh ** always differs from a non-NULL pointer.
50048c6f666bSdrh */
5005619a1305Sdrh int sqlite3ExprListCompare(ExprList *pA, ExprList *pB, int iTab){
50068c6f666bSdrh   int i;
50078c6f666bSdrh   if( pA==0 && pB==0 ) return 0;
50088c6f666bSdrh   if( pA==0 || pB==0 ) return 1;
50098c6f666bSdrh   if( pA->nExpr!=pB->nExpr ) return 1;
50108c6f666bSdrh   for(i=0; i<pA->nExpr; i++){
50118c6f666bSdrh     Expr *pExprA = pA->a[i].pExpr;
50128c6f666bSdrh     Expr *pExprB = pB->a[i].pExpr;
50138c6f666bSdrh     if( pA->a[i].sortOrder!=pB->a[i].sortOrder ) return 1;
50145aa550cfSdan     if( sqlite3ExprCompare(0, pExprA, pExprB, iTab) ) return 1;
50158c6f666bSdrh   }
50168c6f666bSdrh   return 0;
50178c6f666bSdrh }
501813449892Sdrh 
50192282792aSdrh /*
5020f9463dfbSdrh ** Like sqlite3ExprCompare() except COLLATE operators at the top-level
5021f9463dfbSdrh ** are ignored.
5022f9463dfbSdrh */
5023f9463dfbSdrh int sqlite3ExprCompareSkip(Expr *pA, Expr *pB, int iTab){
50245aa550cfSdan   return sqlite3ExprCompare(0,
5025f9463dfbSdrh              sqlite3ExprSkipCollate(pA),
5026f9463dfbSdrh              sqlite3ExprSkipCollate(pB),
5027f9463dfbSdrh              iTab);
5028f9463dfbSdrh }
5029f9463dfbSdrh 
5030f9463dfbSdrh /*
50314bd5f73fSdrh ** Return true if we can prove the pE2 will always be true if pE1 is
50324bd5f73fSdrh ** true.  Return false if we cannot complete the proof or if pE2 might
50334bd5f73fSdrh ** be false.  Examples:
50344bd5f73fSdrh **
5035619a1305Sdrh **     pE1: x==5       pE2: x==5             Result: true
50364bd5f73fSdrh **     pE1: x>0        pE2: x==5             Result: false
5037619a1305Sdrh **     pE1: x=21       pE2: x=21 OR y=43     Result: true
50384bd5f73fSdrh **     pE1: x!=123     pE2: x IS NOT NULL    Result: true
5039619a1305Sdrh **     pE1: x!=?1      pE2: x IS NOT NULL    Result: true
5040619a1305Sdrh **     pE1: x IS NULL  pE2: x IS NOT NULL    Result: false
5041619a1305Sdrh **     pE1: x IS ?2    pE2: x IS NOT NULL    Reuslt: false
50424bd5f73fSdrh **
50434bd5f73fSdrh ** When comparing TK_COLUMN nodes between pE1 and pE2, if pE2 has
50444bd5f73fSdrh ** Expr.iTable<0 then assume a table number given by iTab.
50454bd5f73fSdrh **
5046c0804226Sdrh ** If pParse is not NULL, then the values of bound variables in pE1 are
5047c0804226Sdrh ** compared against literal values in pE2 and pParse->pVdbe->expmask is
5048c0804226Sdrh ** modified to record which bound variables are referenced.  If pParse
5049c0804226Sdrh ** is NULL, then false will be returned if pE1 contains any bound variables.
5050c0804226Sdrh **
50514bd5f73fSdrh ** When in doubt, return false.  Returning true might give a performance
50524bd5f73fSdrh ** improvement.  Returning false might cause a performance reduction, but
50534bd5f73fSdrh ** it will always give the correct answer and is hence always safe.
50544bd5f73fSdrh */
50555aa550cfSdan int sqlite3ExprImpliesExpr(Parse *pParse, Expr *pE1, Expr *pE2, int iTab){
50565aa550cfSdan   if( sqlite3ExprCompare(pParse, pE1, pE2, iTab)==0 ){
5057619a1305Sdrh     return 1;
5058619a1305Sdrh   }
5059619a1305Sdrh   if( pE2->op==TK_OR
50605aa550cfSdan    && (sqlite3ExprImpliesExpr(pParse, pE1, pE2->pLeft, iTab)
50615aa550cfSdan              || sqlite3ExprImpliesExpr(pParse, pE1, pE2->pRight, iTab) )
5062619a1305Sdrh   ){
5063619a1305Sdrh     return 1;
5064619a1305Sdrh   }
50651ad93a00Sdrh   if( pE2->op==TK_NOTNULL && pE1->op!=TK_ISNULL && pE1->op!=TK_IS ){
50661ad93a00Sdrh     Expr *pX = sqlite3ExprSkipCollate(pE1->pLeft);
50671ad93a00Sdrh     testcase( pX!=pE1->pLeft );
50685aa550cfSdan     if( sqlite3ExprCompare(pParse, pX, pE2->pLeft, iTab)==0 ) return 1;
5069619a1305Sdrh   }
5070619a1305Sdrh   return 0;
50714bd5f73fSdrh }
50724bd5f73fSdrh 
50734bd5f73fSdrh /*
50742589787cSdrh ** This is the Expr node callback for sqlite3ExprImpliesNotNullRow().
50752589787cSdrh ** If the expression node requires that the table at pWalker->iCur
50762589787cSdrh ** have a non-NULL column, then set pWalker->eCode to 1 and abort.
50772589787cSdrh */
50782589787cSdrh static int impliesNotNullRow(Walker *pWalker, Expr *pExpr){
5079821b610bSdrh   /* This routine is only called for WHERE clause expressions and so it
5080821b610bSdrh   ** cannot have any TK_AGG_COLUMN entries because those are only found
5081821b610bSdrh   ** in HAVING clauses.  We can get a TK_AGG_FUNCTION in a WHERE clause,
5082821b610bSdrh   ** but that is an illegal construct and the query will be rejected at
5083821b610bSdrh   ** a later stage of processing, so the TK_AGG_FUNCTION case does not
5084821b610bSdrh   ** need to be considered here. */
5085821b610bSdrh   assert( pExpr->op!=TK_AGG_COLUMN );
5086821b610bSdrh   testcase( pExpr->op==TK_AGG_FUNCTION );
5087821b610bSdrh 
50882589787cSdrh   if( ExprHasProperty(pExpr, EP_FromJoin) ) return WRC_Prune;
50892589787cSdrh   switch( pExpr->op ){
50900493222fSdan     case TK_ISNOT:
5091a1054dccSdan     case TK_NOT:
50922589787cSdrh     case TK_ISNULL:
50932589787cSdrh     case TK_IS:
50942589787cSdrh     case TK_OR:
50952c492061Sdrh     case TK_CASE:
5096e3eff266Sdrh     case TK_IN:
50972589787cSdrh     case TK_FUNCTION:
50980493222fSdan       testcase( pExpr->op==TK_ISNOT );
50990493222fSdan       testcase( pExpr->op==TK_NOT );
5100821b610bSdrh       testcase( pExpr->op==TK_ISNULL );
5101821b610bSdrh       testcase( pExpr->op==TK_IS );
5102821b610bSdrh       testcase( pExpr->op==TK_OR );
5103821b610bSdrh       testcase( pExpr->op==TK_CASE );
5104821b610bSdrh       testcase( pExpr->op==TK_IN );
5105821b610bSdrh       testcase( pExpr->op==TK_FUNCTION );
51062589787cSdrh       return WRC_Prune;
51072589787cSdrh     case TK_COLUMN:
51082589787cSdrh       if( pWalker->u.iCur==pExpr->iTable ){
51092589787cSdrh         pWalker->eCode = 1;
51102589787cSdrh         return WRC_Abort;
51112589787cSdrh       }
51122589787cSdrh       return WRC_Prune;
51139881155dSdrh 
51149881155dSdrh     /* Virtual tables are allowed to use constraints like x=NULL.  So
51159881155dSdrh     ** a term of the form x=y does not prove that y is not null if x
51169881155dSdrh     ** is the column of a virtual table */
51179881155dSdrh     case TK_EQ:
51189881155dSdrh     case TK_NE:
51199881155dSdrh     case TK_LT:
51209881155dSdrh     case TK_LE:
51219881155dSdrh     case TK_GT:
51229881155dSdrh     case TK_GE:
51239881155dSdrh       testcase( pExpr->op==TK_EQ );
51249881155dSdrh       testcase( pExpr->op==TK_NE );
51259881155dSdrh       testcase( pExpr->op==TK_LT );
51269881155dSdrh       testcase( pExpr->op==TK_LE );
51279881155dSdrh       testcase( pExpr->op==TK_GT );
51289881155dSdrh       testcase( pExpr->op==TK_GE );
51299881155dSdrh       if( (pExpr->pLeft->op==TK_COLUMN && IsVirtual(pExpr->pLeft->pTab))
51309881155dSdrh        || (pExpr->pRight->op==TK_COLUMN && IsVirtual(pExpr->pRight->pTab))
51319881155dSdrh       ){
51329881155dSdrh        return WRC_Prune;
51339881155dSdrh       }
51342589787cSdrh     default:
51352589787cSdrh       return WRC_Continue;
51362589787cSdrh   }
51372589787cSdrh }
51382589787cSdrh 
51392589787cSdrh /*
51402589787cSdrh ** Return true (non-zero) if expression p can only be true if at least
51412589787cSdrh ** one column of table iTab is non-null.  In other words, return true
51422589787cSdrh ** if expression p will always be NULL or false if every column of iTab
51432589787cSdrh ** is NULL.
51442589787cSdrh **
5145821b610bSdrh ** False negatives are acceptable.  In other words, it is ok to return
5146821b610bSdrh ** zero even if expression p will never be true of every column of iTab
5147821b610bSdrh ** is NULL.  A false negative is merely a missed optimization opportunity.
5148821b610bSdrh **
5149821b610bSdrh ** False positives are not allowed, however.  A false positive may result
5150821b610bSdrh ** in an incorrect answer.
5151821b610bSdrh **
51522589787cSdrh ** Terms of p that are marked with EP_FromJoin (and hence that come from
51532589787cSdrh ** the ON or USING clauses of LEFT JOINS) are excluded from the analysis.
51542589787cSdrh **
51552589787cSdrh ** This routine is used to check if a LEFT JOIN can be converted into
51562589787cSdrh ** an ordinary JOIN.  The p argument is the WHERE clause.  If the WHERE
51572589787cSdrh ** clause requires that some column of the right table of the LEFT JOIN
51582589787cSdrh ** be non-NULL, then the LEFT JOIN can be safely converted into an
51592589787cSdrh ** ordinary join.
51602589787cSdrh */
51612589787cSdrh int sqlite3ExprImpliesNonNullRow(Expr *p, int iTab){
51622589787cSdrh   Walker w;
51632589787cSdrh   w.xExprCallback = impliesNotNullRow;
51642589787cSdrh   w.xSelectCallback = 0;
51652589787cSdrh   w.xSelectCallback2 = 0;
51662589787cSdrh   w.eCode = 0;
51672589787cSdrh   w.u.iCur = iTab;
51682589787cSdrh   sqlite3WalkExpr(&w, p);
51692589787cSdrh   return w.eCode;
51702589787cSdrh }
51712589787cSdrh 
51722589787cSdrh /*
5173030796dfSdrh ** An instance of the following structure is used by the tree walker
51742409f8a1Sdrh ** to determine if an expression can be evaluated by reference to the
51752409f8a1Sdrh ** index only, without having to do a search for the corresponding
51762409f8a1Sdrh ** table entry.  The IdxCover.pIdx field is the index.  IdxCover.iCur
51772409f8a1Sdrh ** is the cursor for the table.
51782409f8a1Sdrh */
51792409f8a1Sdrh struct IdxCover {
51802409f8a1Sdrh   Index *pIdx;     /* The index to be tested for coverage */
51812409f8a1Sdrh   int iCur;        /* Cursor number for the table corresponding to the index */
51822409f8a1Sdrh };
51832409f8a1Sdrh 
51842409f8a1Sdrh /*
51852409f8a1Sdrh ** Check to see if there are references to columns in table
51862409f8a1Sdrh ** pWalker->u.pIdxCover->iCur can be satisfied using the index
51872409f8a1Sdrh ** pWalker->u.pIdxCover->pIdx.
51882409f8a1Sdrh */
51892409f8a1Sdrh static int exprIdxCover(Walker *pWalker, Expr *pExpr){
51902409f8a1Sdrh   if( pExpr->op==TK_COLUMN
51912409f8a1Sdrh    && pExpr->iTable==pWalker->u.pIdxCover->iCur
51922409f8a1Sdrh    && sqlite3ColumnOfIndex(pWalker->u.pIdxCover->pIdx, pExpr->iColumn)<0
51932409f8a1Sdrh   ){
51942409f8a1Sdrh     pWalker->eCode = 1;
51952409f8a1Sdrh     return WRC_Abort;
51962409f8a1Sdrh   }
51972409f8a1Sdrh   return WRC_Continue;
51982409f8a1Sdrh }
51992409f8a1Sdrh 
52002409f8a1Sdrh /*
5201e604ec0bSdrh ** Determine if an index pIdx on table with cursor iCur contains will
5202e604ec0bSdrh ** the expression pExpr.  Return true if the index does cover the
5203e604ec0bSdrh ** expression and false if the pExpr expression references table columns
5204e604ec0bSdrh ** that are not found in the index pIdx.
52052409f8a1Sdrh **
52062409f8a1Sdrh ** An index covering an expression means that the expression can be
52072409f8a1Sdrh ** evaluated using only the index and without having to lookup the
52082409f8a1Sdrh ** corresponding table entry.
52092409f8a1Sdrh */
52102409f8a1Sdrh int sqlite3ExprCoveredByIndex(
52112409f8a1Sdrh   Expr *pExpr,        /* The index to be tested */
52122409f8a1Sdrh   int iCur,           /* The cursor number for the corresponding table */
52132409f8a1Sdrh   Index *pIdx         /* The index that might be used for coverage */
52142409f8a1Sdrh ){
52152409f8a1Sdrh   Walker w;
52162409f8a1Sdrh   struct IdxCover xcov;
52172409f8a1Sdrh   memset(&w, 0, sizeof(w));
52182409f8a1Sdrh   xcov.iCur = iCur;
52192409f8a1Sdrh   xcov.pIdx = pIdx;
52202409f8a1Sdrh   w.xExprCallback = exprIdxCover;
52212409f8a1Sdrh   w.u.pIdxCover = &xcov;
52222409f8a1Sdrh   sqlite3WalkExpr(&w, pExpr);
52232409f8a1Sdrh   return !w.eCode;
52242409f8a1Sdrh }
52252409f8a1Sdrh 
52262409f8a1Sdrh 
52272409f8a1Sdrh /*
52282409f8a1Sdrh ** An instance of the following structure is used by the tree walker
5229030796dfSdrh ** to count references to table columns in the arguments of an
5230ed551b95Sdrh ** aggregate function, in order to implement the
5231ed551b95Sdrh ** sqlite3FunctionThisSrc() routine.
5232374fdce4Sdrh */
5233030796dfSdrh struct SrcCount {
5234030796dfSdrh   SrcList *pSrc;   /* One particular FROM clause in a nested query */
5235030796dfSdrh   int nThis;       /* Number of references to columns in pSrcList */
5236030796dfSdrh   int nOther;      /* Number of references to columns in other FROM clauses */
5237030796dfSdrh };
5238030796dfSdrh 
5239030796dfSdrh /*
5240030796dfSdrh ** Count the number of references to columns.
5241030796dfSdrh */
5242030796dfSdrh static int exprSrcCount(Walker *pWalker, Expr *pExpr){
5243fb0a6081Sdrh   /* The NEVER() on the second term is because sqlite3FunctionUsesThisSrc()
5244fb0a6081Sdrh   ** is always called before sqlite3ExprAnalyzeAggregates() and so the
5245fb0a6081Sdrh   ** TK_COLUMNs have not yet been converted into TK_AGG_COLUMN.  If
5246fb0a6081Sdrh   ** sqlite3FunctionUsesThisSrc() is used differently in the future, the
5247fb0a6081Sdrh   ** NEVER() will need to be removed. */
5248fb0a6081Sdrh   if( pExpr->op==TK_COLUMN || NEVER(pExpr->op==TK_AGG_COLUMN) ){
5249374fdce4Sdrh     int i;
5250030796dfSdrh     struct SrcCount *p = pWalker->u.pSrcCount;
5251030796dfSdrh     SrcList *pSrc = p->pSrc;
5252655814d2Sdrh     int nSrc = pSrc ? pSrc->nSrc : 0;
5253655814d2Sdrh     for(i=0; i<nSrc; i++){
5254030796dfSdrh       if( pExpr->iTable==pSrc->a[i].iCursor ) break;
5255374fdce4Sdrh     }
5256655814d2Sdrh     if( i<nSrc ){
5257030796dfSdrh       p->nThis++;
5258374fdce4Sdrh     }else{
5259030796dfSdrh       p->nOther++;
5260374fdce4Sdrh     }
5261374fdce4Sdrh   }
5262030796dfSdrh   return WRC_Continue;
5263030796dfSdrh }
5264374fdce4Sdrh 
5265374fdce4Sdrh /*
5266030796dfSdrh ** Determine if any of the arguments to the pExpr Function reference
5267030796dfSdrh ** pSrcList.  Return true if they do.  Also return true if the function
5268030796dfSdrh ** has no arguments or has only constant arguments.  Return false if pExpr
5269030796dfSdrh ** references columns but not columns of tables found in pSrcList.
5270374fdce4Sdrh */
5271030796dfSdrh int sqlite3FunctionUsesThisSrc(Expr *pExpr, SrcList *pSrcList){
5272374fdce4Sdrh   Walker w;
5273030796dfSdrh   struct SrcCount cnt;
5274374fdce4Sdrh   assert( pExpr->op==TK_AGG_FUNCTION );
5275030796dfSdrh   w.xExprCallback = exprSrcCount;
5276979dd1beSdrh   w.xSelectCallback = 0;
5277030796dfSdrh   w.u.pSrcCount = &cnt;
5278030796dfSdrh   cnt.pSrc = pSrcList;
5279030796dfSdrh   cnt.nThis = 0;
5280030796dfSdrh   cnt.nOther = 0;
5281030796dfSdrh   sqlite3WalkExprList(&w, pExpr->x.pList);
5282030796dfSdrh   return cnt.nThis>0 || cnt.nOther==0;
5283374fdce4Sdrh }
5284374fdce4Sdrh 
5285374fdce4Sdrh /*
528613449892Sdrh ** Add a new element to the pAggInfo->aCol[] array.  Return the index of
528713449892Sdrh ** the new element.  Return a negative number if malloc fails.
52882282792aSdrh */
528917435752Sdrh static int addAggInfoColumn(sqlite3 *db, AggInfo *pInfo){
529013449892Sdrh   int i;
5291cf643729Sdrh   pInfo->aCol = sqlite3ArrayAllocate(
529217435752Sdrh        db,
5293cf643729Sdrh        pInfo->aCol,
5294cf643729Sdrh        sizeof(pInfo->aCol[0]),
5295cf643729Sdrh        &pInfo->nColumn,
5296cf643729Sdrh        &i
5297cf643729Sdrh   );
529813449892Sdrh   return i;
52992282792aSdrh }
530013449892Sdrh 
530113449892Sdrh /*
530213449892Sdrh ** Add a new element to the pAggInfo->aFunc[] array.  Return the index of
530313449892Sdrh ** the new element.  Return a negative number if malloc fails.
530413449892Sdrh */
530517435752Sdrh static int addAggInfoFunc(sqlite3 *db, AggInfo *pInfo){
530613449892Sdrh   int i;
5307cf643729Sdrh   pInfo->aFunc = sqlite3ArrayAllocate(
530817435752Sdrh        db,
5309cf643729Sdrh        pInfo->aFunc,
5310cf643729Sdrh        sizeof(pInfo->aFunc[0]),
5311cf643729Sdrh        &pInfo->nFunc,
5312cf643729Sdrh        &i
5313cf643729Sdrh   );
531413449892Sdrh   return i;
53152282792aSdrh }
53162282792aSdrh 
53172282792aSdrh /*
53187d10d5a6Sdrh ** This is the xExprCallback for a tree walker.  It is used to
53197d10d5a6Sdrh ** implement sqlite3ExprAnalyzeAggregates().  See sqlite3ExprAnalyzeAggregates
5320626a879aSdrh ** for additional information.
53212282792aSdrh */
53227d10d5a6Sdrh static int analyzeAggregate(Walker *pWalker, Expr *pExpr){
53232282792aSdrh   int i;
53247d10d5a6Sdrh   NameContext *pNC = pWalker->u.pNC;
5325a58fdfb1Sdanielk1977   Parse *pParse = pNC->pParse;
5326a58fdfb1Sdanielk1977   SrcList *pSrcList = pNC->pSrcList;
532725c3b8caSdrh   AggInfo *pAggInfo = pNC->uNC.pAggInfo;
532813449892Sdrh 
532925c3b8caSdrh   assert( pNC->ncFlags & NC_UAggInfo );
53302282792aSdrh   switch( pExpr->op ){
533189c69d00Sdrh     case TK_AGG_COLUMN:
5332967e8b73Sdrh     case TK_COLUMN: {
53338b213899Sdrh       testcase( pExpr->op==TK_AGG_COLUMN );
53348b213899Sdrh       testcase( pExpr->op==TK_COLUMN );
533513449892Sdrh       /* Check to see if the column is in one of the tables in the FROM
533613449892Sdrh       ** clause of the aggregate query */
533720bc393cSdrh       if( ALWAYS(pSrcList!=0) ){
533813449892Sdrh         struct SrcList_item *pItem = pSrcList->a;
533913449892Sdrh         for(i=0; i<pSrcList->nSrc; i++, pItem++){
534013449892Sdrh           struct AggInfo_col *pCol;
5341c5cd1249Sdrh           assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
534213449892Sdrh           if( pExpr->iTable==pItem->iCursor ){
534313449892Sdrh             /* If we reach this point, it means that pExpr refers to a table
534413449892Sdrh             ** that is in the FROM clause of the aggregate query.
534513449892Sdrh             **
534613449892Sdrh             ** Make an entry for the column in pAggInfo->aCol[] if there
534713449892Sdrh             ** is not an entry there already.
534813449892Sdrh             */
53497f906d63Sdrh             int k;
535013449892Sdrh             pCol = pAggInfo->aCol;
53517f906d63Sdrh             for(k=0; k<pAggInfo->nColumn; k++, pCol++){
535213449892Sdrh               if( pCol->iTable==pExpr->iTable &&
535313449892Sdrh                   pCol->iColumn==pExpr->iColumn ){
53542282792aSdrh                 break;
53552282792aSdrh               }
53562282792aSdrh             }
53571e536953Sdanielk1977             if( (k>=pAggInfo->nColumn)
53581e536953Sdanielk1977              && (k = addAggInfoColumn(pParse->db, pAggInfo))>=0
53591e536953Sdanielk1977             ){
53607f906d63Sdrh               pCol = &pAggInfo->aCol[k];
53610817d0dfSdanielk1977               pCol->pTab = pExpr->pTab;
536213449892Sdrh               pCol->iTable = pExpr->iTable;
536313449892Sdrh               pCol->iColumn = pExpr->iColumn;
53640a07c107Sdrh               pCol->iMem = ++pParse->nMem;
536513449892Sdrh               pCol->iSorterColumn = -1;
53665774b806Sdrh               pCol->pExpr = pExpr;
536713449892Sdrh               if( pAggInfo->pGroupBy ){
536813449892Sdrh                 int j, n;
536913449892Sdrh                 ExprList *pGB = pAggInfo->pGroupBy;
537013449892Sdrh                 struct ExprList_item *pTerm = pGB->a;
537113449892Sdrh                 n = pGB->nExpr;
537213449892Sdrh                 for(j=0; j<n; j++, pTerm++){
537313449892Sdrh                   Expr *pE = pTerm->pExpr;
537413449892Sdrh                   if( pE->op==TK_COLUMN && pE->iTable==pExpr->iTable &&
537513449892Sdrh                       pE->iColumn==pExpr->iColumn ){
537613449892Sdrh                     pCol->iSorterColumn = j;
537713449892Sdrh                     break;
53782282792aSdrh                   }
537913449892Sdrh                 }
538013449892Sdrh               }
538113449892Sdrh               if( pCol->iSorterColumn<0 ){
538213449892Sdrh                 pCol->iSorterColumn = pAggInfo->nSortingColumn++;
538313449892Sdrh               }
538413449892Sdrh             }
538513449892Sdrh             /* There is now an entry for pExpr in pAggInfo->aCol[] (either
538613449892Sdrh             ** because it was there before or because we just created it).
538713449892Sdrh             ** Convert the pExpr to be a TK_AGG_COLUMN referring to that
538813449892Sdrh             ** pAggInfo->aCol[] entry.
538913449892Sdrh             */
5390ebb6a65dSdrh             ExprSetVVAProperty(pExpr, EP_NoReduce);
539113449892Sdrh             pExpr->pAggInfo = pAggInfo;
539213449892Sdrh             pExpr->op = TK_AGG_COLUMN;
5393cf697396Sshane             pExpr->iAgg = (i16)k;
539413449892Sdrh             break;
539513449892Sdrh           } /* endif pExpr->iTable==pItem->iCursor */
539613449892Sdrh         } /* end loop over pSrcList */
5397a58fdfb1Sdanielk1977       }
53987d10d5a6Sdrh       return WRC_Prune;
53992282792aSdrh     }
54002282792aSdrh     case TK_AGG_FUNCTION: {
54013a8c4be7Sdrh       if( (pNC->ncFlags & NC_InAggFunc)==0
5402ed551b95Sdrh        && pWalker->walkerDepth==pExpr->op2
54033a8c4be7Sdrh       ){
540413449892Sdrh         /* Check to see if pExpr is a duplicate of another aggregate
540513449892Sdrh         ** function that is already in the pAggInfo structure
540613449892Sdrh         */
540713449892Sdrh         struct AggInfo_func *pItem = pAggInfo->aFunc;
540813449892Sdrh         for(i=0; i<pAggInfo->nFunc; i++, pItem++){
54095aa550cfSdan           if( sqlite3ExprCompare(0, pItem->pExpr, pExpr, -1)==0 ){
54102282792aSdrh             break;
54112282792aSdrh           }
54122282792aSdrh         }
541313449892Sdrh         if( i>=pAggInfo->nFunc ){
541413449892Sdrh           /* pExpr is original.  Make a new entry in pAggInfo->aFunc[]
541513449892Sdrh           */
541614db2665Sdanielk1977           u8 enc = ENC(pParse->db);
54171e536953Sdanielk1977           i = addAggInfoFunc(pParse->db, pAggInfo);
541813449892Sdrh           if( i>=0 ){
54196ab3a2ecSdanielk1977             assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
542013449892Sdrh             pItem = &pAggInfo->aFunc[i];
542113449892Sdrh             pItem->pExpr = pExpr;
54220a07c107Sdrh             pItem->iMem = ++pParse->nMem;
542333e619fcSdrh             assert( !ExprHasProperty(pExpr, EP_IntValue) );
542413449892Sdrh             pItem->pFunc = sqlite3FindFunction(pParse->db,
542580738d9cSdrh                    pExpr->u.zToken,
54266ab3a2ecSdanielk1977                    pExpr->x.pList ? pExpr->x.pList->nExpr : 0, enc, 0);
5427fd357974Sdrh             if( pExpr->flags & EP_Distinct ){
5428fd357974Sdrh               pItem->iDistinct = pParse->nTab++;
5429fd357974Sdrh             }else{
5430fd357974Sdrh               pItem->iDistinct = -1;
5431fd357974Sdrh             }
54322282792aSdrh           }
543313449892Sdrh         }
543413449892Sdrh         /* Make pExpr point to the appropriate pAggInfo->aFunc[] entry
543513449892Sdrh         */
5436c5cd1249Sdrh         assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
5437ebb6a65dSdrh         ExprSetVVAProperty(pExpr, EP_NoReduce);
5438cf697396Sshane         pExpr->iAgg = (i16)i;
543913449892Sdrh         pExpr->pAggInfo = pAggInfo;
54403a8c4be7Sdrh         return WRC_Prune;
54416e83a57fSdrh       }else{
54426e83a57fSdrh         return WRC_Continue;
54436e83a57fSdrh       }
54442282792aSdrh     }
5445a58fdfb1Sdanielk1977   }
54467d10d5a6Sdrh   return WRC_Continue;
54477d10d5a6Sdrh }
54487d10d5a6Sdrh static int analyzeAggregatesInSelect(Walker *pWalker, Select *pSelect){
5449d5a336efSdrh   UNUSED_PARAMETER(pSelect);
5450979dd1beSdrh   pWalker->walkerDepth++;
54517d10d5a6Sdrh   return WRC_Continue;
5452a58fdfb1Sdanielk1977 }
5453979dd1beSdrh static void analyzeAggregatesInSelectEnd(Walker *pWalker, Select *pSelect){
5454979dd1beSdrh   UNUSED_PARAMETER(pSelect);
5455979dd1beSdrh   pWalker->walkerDepth--;
5456979dd1beSdrh }
5457626a879aSdrh 
5458626a879aSdrh /*
5459e8abb4caSdrh ** Analyze the pExpr expression looking for aggregate functions and
5460e8abb4caSdrh ** for variables that need to be added to AggInfo object that pNC->pAggInfo
5461e8abb4caSdrh ** points to.  Additional entries are made on the AggInfo object as
5462e8abb4caSdrh ** necessary.
5463626a879aSdrh **
5464626a879aSdrh ** This routine should only be called after the expression has been
54657d10d5a6Sdrh ** analyzed by sqlite3ResolveExprNames().
5466626a879aSdrh */
5467d2b3e23bSdrh void sqlite3ExprAnalyzeAggregates(NameContext *pNC, Expr *pExpr){
54687d10d5a6Sdrh   Walker w;
54697d10d5a6Sdrh   w.xExprCallback = analyzeAggregate;
54707d10d5a6Sdrh   w.xSelectCallback = analyzeAggregatesInSelect;
5471979dd1beSdrh   w.xSelectCallback2 = analyzeAggregatesInSelectEnd;
5472979dd1beSdrh   w.walkerDepth = 0;
54737d10d5a6Sdrh   w.u.pNC = pNC;
547420bc393cSdrh   assert( pNC->pSrcList!=0 );
54757d10d5a6Sdrh   sqlite3WalkExpr(&w, pExpr);
54762282792aSdrh }
54775d9a4af9Sdrh 
54785d9a4af9Sdrh /*
54795d9a4af9Sdrh ** Call sqlite3ExprAnalyzeAggregates() for every expression in an
54805d9a4af9Sdrh ** expression list.  Return the number of errors.
54815d9a4af9Sdrh **
54825d9a4af9Sdrh ** If an error is found, the analysis is cut short.
54835d9a4af9Sdrh */
5484d2b3e23bSdrh void sqlite3ExprAnalyzeAggList(NameContext *pNC, ExprList *pList){
54855d9a4af9Sdrh   struct ExprList_item *pItem;
54865d9a4af9Sdrh   int i;
54875d9a4af9Sdrh   if( pList ){
5488d2b3e23bSdrh     for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
5489d2b3e23bSdrh       sqlite3ExprAnalyzeAggregates(pNC, pItem->pExpr);
54905d9a4af9Sdrh     }
54915d9a4af9Sdrh   }
54925d9a4af9Sdrh }
5493892d3179Sdrh 
5494892d3179Sdrh /*
5495ceea3321Sdrh ** Allocate a single new register for use to hold some intermediate result.
5496892d3179Sdrh */
5497892d3179Sdrh int sqlite3GetTempReg(Parse *pParse){
5498e55cbd72Sdrh   if( pParse->nTempReg==0 ){
5499892d3179Sdrh     return ++pParse->nMem;
5500892d3179Sdrh   }
55012f425f6bSdanielk1977   return pParse->aTempReg[--pParse->nTempReg];
5502892d3179Sdrh }
5503ceea3321Sdrh 
5504ceea3321Sdrh /*
5505ceea3321Sdrh ** Deallocate a register, making available for reuse for some other
5506ceea3321Sdrh ** purpose.
5507ceea3321Sdrh **
5508ceea3321Sdrh ** If a register is currently being used by the column cache, then
550960ec914cSpeter.d.reid ** the deallocation is deferred until the column cache line that uses
5510ceea3321Sdrh ** the register becomes stale.
5511ceea3321Sdrh */
5512892d3179Sdrh void sqlite3ReleaseTempReg(Parse *pParse, int iReg){
55132dcef11bSdrh   if( iReg && pParse->nTempReg<ArraySize(pParse->aTempReg) ){
5514ceea3321Sdrh     int i;
5515ceea3321Sdrh     struct yColCache *p;
55169b40d13fSdrh     for(i=0, p=pParse->aColCache; i<pParse->nColCache; i++, p++){
5517ceea3321Sdrh       if( p->iReg==iReg ){
5518ceea3321Sdrh         p->tempReg = 1;
5519ceea3321Sdrh         return;
5520ceea3321Sdrh       }
5521ceea3321Sdrh     }
5522892d3179Sdrh     pParse->aTempReg[pParse->nTempReg++] = iReg;
5523892d3179Sdrh   }
5524892d3179Sdrh }
5525892d3179Sdrh 
5526892d3179Sdrh /*
5527ed24da4bSdrh ** Allocate or deallocate a block of nReg consecutive registers.
5528892d3179Sdrh */
5529892d3179Sdrh int sqlite3GetTempRange(Parse *pParse, int nReg){
5530e55cbd72Sdrh   int i, n;
5531ed24da4bSdrh   if( nReg==1 ) return sqlite3GetTempReg(pParse);
5532892d3179Sdrh   i = pParse->iRangeReg;
5533e55cbd72Sdrh   n = pParse->nRangeReg;
5534f49f3523Sdrh   if( nReg<=n ){
5535f49f3523Sdrh     assert( !usedAsColumnCache(pParse, i, i+n-1) );
5536892d3179Sdrh     pParse->iRangeReg += nReg;
5537892d3179Sdrh     pParse->nRangeReg -= nReg;
5538892d3179Sdrh   }else{
5539892d3179Sdrh     i = pParse->nMem+1;
5540892d3179Sdrh     pParse->nMem += nReg;
5541892d3179Sdrh   }
5542892d3179Sdrh   return i;
5543892d3179Sdrh }
5544892d3179Sdrh void sqlite3ReleaseTempRange(Parse *pParse, int iReg, int nReg){
5545ed24da4bSdrh   if( nReg==1 ){
5546ed24da4bSdrh     sqlite3ReleaseTempReg(pParse, iReg);
5547ed24da4bSdrh     return;
5548ed24da4bSdrh   }
5549f49f3523Sdrh   sqlite3ExprCacheRemove(pParse, iReg, nReg);
5550892d3179Sdrh   if( nReg>pParse->nRangeReg ){
5551892d3179Sdrh     pParse->nRangeReg = nReg;
5552892d3179Sdrh     pParse->iRangeReg = iReg;
5553892d3179Sdrh   }
5554892d3179Sdrh }
5555cdc69557Sdrh 
5556cdc69557Sdrh /*
5557cdc69557Sdrh ** Mark all temporary registers as being unavailable for reuse.
5558cdc69557Sdrh */
5559cdc69557Sdrh void sqlite3ClearTempRegCache(Parse *pParse){
5560cdc69557Sdrh   pParse->nTempReg = 0;
5561cdc69557Sdrh   pParse->nRangeReg = 0;
5562cdc69557Sdrh }
5563bb9b5f26Sdrh 
5564bb9b5f26Sdrh /*
5565bb9b5f26Sdrh ** Validate that no temporary register falls within the range of
5566bb9b5f26Sdrh ** iFirst..iLast, inclusive.  This routine is only call from within assert()
5567bb9b5f26Sdrh ** statements.
5568bb9b5f26Sdrh */
5569bb9b5f26Sdrh #ifdef SQLITE_DEBUG
5570bb9b5f26Sdrh int sqlite3NoTempsInRange(Parse *pParse, int iFirst, int iLast){
5571bb9b5f26Sdrh   int i;
5572bb9b5f26Sdrh   if( pParse->nRangeReg>0
55733963e584Sdrh    && pParse->iRangeReg+pParse->nRangeReg > iFirst
55743963e584Sdrh    && pParse->iRangeReg <= iLast
5575bb9b5f26Sdrh   ){
5576bb9b5f26Sdrh      return 0;
5577bb9b5f26Sdrh   }
5578bb9b5f26Sdrh   for(i=0; i<pParse->nTempReg; i++){
5579bb9b5f26Sdrh     if( pParse->aTempReg[i]>=iFirst && pParse->aTempReg[i]<=iLast ){
5580bb9b5f26Sdrh       return 0;
5581bb9b5f26Sdrh     }
5582bb9b5f26Sdrh   }
5583bb9b5f26Sdrh   return 1;
5584bb9b5f26Sdrh }
5585bb9b5f26Sdrh #endif /* SQLITE_DEBUG */
5586