xref: /sqlite-3.40.0/src/expr.c (revision f20bbc5f)
1cce7d176Sdrh /*
2b19a2bc6Sdrh ** 2001 September 15
3cce7d176Sdrh **
4b19a2bc6Sdrh ** The author disclaims copyright to this source code.  In place of
5b19a2bc6Sdrh ** a legal notice, here is a blessing:
6cce7d176Sdrh **
7b19a2bc6Sdrh **    May you do good and not evil.
8b19a2bc6Sdrh **    May you find forgiveness for yourself and forgive others.
9b19a2bc6Sdrh **    May you share freely, never taking more than you give.
10cce7d176Sdrh **
11cce7d176Sdrh *************************************************************************
121ccde15dSdrh ** This file contains routines used for analyzing expressions and
13b19a2bc6Sdrh ** for generating VDBE code that evaluates expressions in SQLite.
14cce7d176Sdrh */
15cce7d176Sdrh #include "sqliteInt.h"
16a2e00042Sdrh 
1712abf408Sdrh /* Forward declarations */
1812abf408Sdrh static void exprCodeBetween(Parse*,Expr*,int,void(*)(Parse*,Expr*,int,int),int);
1912abf408Sdrh static int exprCodeVector(Parse *pParse, Expr *p, int *piToFree);
2012abf408Sdrh 
210dfa4f6fSdrh /*
220dfa4f6fSdrh ** Return the affinity character for a single column of a table.
230dfa4f6fSdrh */
240dfa4f6fSdrh char sqlite3TableColumnAffinity(Table *pTab, int iCol){
250dfa4f6fSdrh   assert( iCol<pTab->nCol );
260dfa4f6fSdrh   return iCol>=0 ? pTab->aCol[iCol].affinity : SQLITE_AFF_INTEGER;
270dfa4f6fSdrh }
2812abf408Sdrh 
29e014a838Sdanielk1977 /*
30e014a838Sdanielk1977 ** Return the 'affinity' of the expression pExpr if any.
31e014a838Sdanielk1977 **
32e014a838Sdanielk1977 ** If pExpr is a column, a reference to a column via an 'AS' alias,
33e014a838Sdanielk1977 ** or a sub-select with a column as the return value, then the
34e014a838Sdanielk1977 ** affinity of that column is returned. Otherwise, 0x00 is returned,
35e014a838Sdanielk1977 ** indicating no affinity for the expression.
36e014a838Sdanielk1977 **
3760ec914cSpeter.d.reid ** i.e. the WHERE clause expressions in the following statements all
38e014a838Sdanielk1977 ** have an affinity:
39e014a838Sdanielk1977 **
40e014a838Sdanielk1977 ** CREATE TABLE t1(a);
41e014a838Sdanielk1977 ** SELECT * FROM t1 WHERE a;
42e014a838Sdanielk1977 ** SELECT a AS b FROM t1 WHERE b;
43e014a838Sdanielk1977 ** SELECT * FROM t1 WHERE (select a from t1);
44e014a838Sdanielk1977 */
45bf3b721fSdanielk1977 char sqlite3ExprAffinity(Expr *pExpr){
46580c8c18Sdrh   int op;
47580c8c18Sdrh   pExpr = sqlite3ExprSkipCollate(pExpr);
489bec6fb3Smistachkin   if( pExpr->flags & EP_Generic ) return 0;
49580c8c18Sdrh   op = pExpr->op;
50487e262fSdrh   if( op==TK_SELECT ){
516ab3a2ecSdanielk1977     assert( pExpr->flags&EP_xIsSelect );
526ab3a2ecSdanielk1977     return sqlite3ExprAffinity(pExpr->x.pSelect->pEList->a[0].pExpr);
53a37cdde0Sdanielk1977   }
54db45bd5eSdrh   if( op==TK_REGISTER ) op = pExpr->op2;
55487e262fSdrh #ifndef SQLITE_OMIT_CAST
56487e262fSdrh   if( op==TK_CAST ){
5733e619fcSdrh     assert( !ExprHasProperty(pExpr, EP_IntValue) );
58fdaac671Sdrh     return sqlite3AffinityType(pExpr->u.zToken, 0);
59487e262fSdrh   }
60487e262fSdrh #endif
61eda079cdSdrh   if( (op==TK_AGG_COLUMN || op==TK_COLUMN) && pExpr->y.pTab ){
62eda079cdSdrh     return sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
637d10d5a6Sdrh   }
6480aa5453Sdan   if( op==TK_SELECT_COLUMN ){
6580aa5453Sdan     assert( pExpr->pLeft->flags&EP_xIsSelect );
6680aa5453Sdan     return sqlite3ExprAffinity(
6780aa5453Sdan         pExpr->pLeft->x.pSelect->pEList->a[pExpr->iColumn].pExpr
6880aa5453Sdan     );
6980aa5453Sdan   }
70a37cdde0Sdanielk1977   return pExpr->affinity;
71a37cdde0Sdanielk1977 }
72a37cdde0Sdanielk1977 
7353db1458Sdrh /*
748b4c40d8Sdrh ** Set the collating sequence for expression pExpr to be the collating
75ae80ddeaSdrh ** sequence named by pToken.   Return a pointer to a new Expr node that
76ae80ddeaSdrh ** implements the COLLATE operator.
770a8a406eSdrh **
780a8a406eSdrh ** If a memory allocation error occurs, that fact is recorded in pParse->db
790a8a406eSdrh ** and the pExpr parameter is returned unchanged.
808b4c40d8Sdrh */
814ef7efadSdrh Expr *sqlite3ExprAddCollateToken(
824ef7efadSdrh   Parse *pParse,           /* Parsing context */
834ef7efadSdrh   Expr *pExpr,             /* Add the "COLLATE" clause to this expression */
8480103fc6Sdan   const Token *pCollName,  /* Name of collating sequence */
8580103fc6Sdan   int dequote              /* True to dequote pCollName */
864ef7efadSdrh ){
870a8a406eSdrh   if( pCollName->n>0 ){
8880103fc6Sdan     Expr *pNew = sqlite3ExprAlloc(pParse->db, TK_COLLATE, pCollName, dequote);
89ae80ddeaSdrh     if( pNew ){
90ae80ddeaSdrh       pNew->pLeft = pExpr;
91a4c3c87eSdrh       pNew->flags |= EP_Collate|EP_Skip;
920a8a406eSdrh       pExpr = pNew;
93ae80ddeaSdrh     }
940a8a406eSdrh   }
950a8a406eSdrh   return pExpr;
960a8a406eSdrh }
970a8a406eSdrh Expr *sqlite3ExprAddCollateString(Parse *pParse, Expr *pExpr, const char *zC){
980a8a406eSdrh   Token s;
99261d8a51Sdrh   assert( zC!=0 );
10040aced5cSdrh   sqlite3TokenInit(&s, (char*)zC);
10180103fc6Sdan   return sqlite3ExprAddCollateToken(pParse, pExpr, &s, 0);
1020a8a406eSdrh }
1030a8a406eSdrh 
1040a8a406eSdrh /*
1050b8d255cSdrh ** Skip over any TK_COLLATE operators and any unlikely()
106a4c3c87eSdrh ** or likelihood() function at the root of an expression.
1070a8a406eSdrh */
1080a8a406eSdrh Expr *sqlite3ExprSkipCollate(Expr *pExpr){
109a4c3c87eSdrh   while( pExpr && ExprHasProperty(pExpr, EP_Skip) ){
110a4c3c87eSdrh     if( ExprHasProperty(pExpr, EP_Unlikely) ){
111cca9f3d2Sdrh       assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
112cca9f3d2Sdrh       assert( pExpr->x.pList->nExpr>0 );
113a4c3c87eSdrh       assert( pExpr->op==TK_FUNCTION );
114cca9f3d2Sdrh       pExpr = pExpr->x.pList->a[0].pExpr;
115cca9f3d2Sdrh     }else{
1160b8d255cSdrh       assert( pExpr->op==TK_COLLATE );
117d91eba96Sdrh       pExpr = pExpr->pLeft;
118cca9f3d2Sdrh     }
119d91eba96Sdrh   }
1200a8a406eSdrh   return pExpr;
1218b4c40d8Sdrh }
1228b4c40d8Sdrh 
1238b4c40d8Sdrh /*
124ae80ddeaSdrh ** Return the collation sequence for the expression pExpr. If
125ae80ddeaSdrh ** there is no defined collating sequence, return NULL.
126ae80ddeaSdrh **
12770efa84dSdrh ** See also: sqlite3ExprNNCollSeq()
12870efa84dSdrh **
12970efa84dSdrh ** The sqlite3ExprNNCollSeq() works the same exact that it returns the
13070efa84dSdrh ** default collation if pExpr has no defined collation.
13170efa84dSdrh **
132ae80ddeaSdrh ** The collating sequence might be determined by a COLLATE operator
133ae80ddeaSdrh ** or by the presence of a column with a defined collating sequence.
134ae80ddeaSdrh ** COLLATE operators take first precedence.  Left operands take
135ae80ddeaSdrh ** precedence over right operands.
1360202b29eSdanielk1977 */
1377cedc8d4Sdanielk1977 CollSeq *sqlite3ExprCollSeq(Parse *pParse, Expr *pExpr){
138ae80ddeaSdrh   sqlite3 *db = pParse->db;
1397cedc8d4Sdanielk1977   CollSeq *pColl = 0;
1407d10d5a6Sdrh   Expr *p = pExpr;
141261d8a51Sdrh   while( p ){
142ae80ddeaSdrh     int op = p->op;
143fbb24d10Sdrh     if( p->flags & EP_Generic ) break;
144cb0e04f9Sdrh     if( op==TK_REGISTER ) op = p->op2;
145cb0e04f9Sdrh     if( (op==TK_AGG_COLUMN || op==TK_COLUMN || op==TK_TRIGGER)
146eda079cdSdrh      && p->y.pTab!=0
147ae80ddeaSdrh     ){
148eda079cdSdrh       /* op==TK_REGISTER && p->y.pTab!=0 happens when pExpr was originally
1497d10d5a6Sdrh       ** a TK_COLUMN but was previously evaluated and cached in a register */
1507d10d5a6Sdrh       int j = p->iColumn;
1517d10d5a6Sdrh       if( j>=0 ){
152eda079cdSdrh         const char *zColl = p->y.pTab->aCol[j].zColl;
153c4a64facSdrh         pColl = sqlite3FindCollSeq(db, ENC(db), zColl, 0);
1540202b29eSdanielk1977       }
1557d10d5a6Sdrh       break;
1567d10d5a6Sdrh     }
157e081d73cSdrh     if( op==TK_CAST || op==TK_UPLUS ){
158e081d73cSdrh       p = p->pLeft;
159e081d73cSdrh       continue;
160e081d73cSdrh     }
161cb0e04f9Sdrh     if( op==TK_COLLATE ){
162e081d73cSdrh       pColl = sqlite3GetCollSeq(pParse, ENC(db), 0, p->u.zToken);
163e081d73cSdrh       break;
164e081d73cSdrh     }
165ae80ddeaSdrh     if( p->flags & EP_Collate ){
1662308ed38Sdrh       if( p->pLeft && (p->pLeft->flags & EP_Collate)!=0 ){
1677d10d5a6Sdrh         p = p->pLeft;
168ae80ddeaSdrh       }else{
1692308ed38Sdrh         Expr *pNext  = p->pRight;
1706728cd91Sdrh         /* The Expr.x union is never used at the same time as Expr.pRight */
1716728cd91Sdrh         assert( p->x.pList==0 || p->pRight==0 );
1726728cd91Sdrh         /* p->flags holds EP_Collate and p->pLeft->flags does not.  And
1736728cd91Sdrh         ** p->x.pSelect cannot.  So if p->x.pLeft exists, it must hold at
1746728cd91Sdrh         ** least one EP_Collate. Thus the following two ALWAYS. */
1756728cd91Sdrh         if( p->x.pList!=0 && ALWAYS(!ExprHasProperty(p, EP_xIsSelect)) ){
1762308ed38Sdrh           int i;
1776728cd91Sdrh           for(i=0; ALWAYS(i<p->x.pList->nExpr); i++){
1782308ed38Sdrh             if( ExprHasProperty(p->x.pList->a[i].pExpr, EP_Collate) ){
1792308ed38Sdrh               pNext = p->x.pList->a[i].pExpr;
1802308ed38Sdrh               break;
1812308ed38Sdrh             }
1822308ed38Sdrh           }
1832308ed38Sdrh         }
1842308ed38Sdrh         p = pNext;
185ae80ddeaSdrh       }
186ae80ddeaSdrh     }else{
187ae80ddeaSdrh       break;
188ae80ddeaSdrh     }
1890202b29eSdanielk1977   }
1907cedc8d4Sdanielk1977   if( sqlite3CheckCollSeq(pParse, pColl) ){
1917cedc8d4Sdanielk1977     pColl = 0;
1927cedc8d4Sdanielk1977   }
1937cedc8d4Sdanielk1977   return pColl;
1940202b29eSdanielk1977 }
1950202b29eSdanielk1977 
1960202b29eSdanielk1977 /*
19770efa84dSdrh ** Return the collation sequence for the expression pExpr. If
19870efa84dSdrh ** there is no defined collating sequence, return a pointer to the
19970efa84dSdrh ** defautl collation sequence.
20070efa84dSdrh **
20170efa84dSdrh ** See also: sqlite3ExprCollSeq()
20270efa84dSdrh **
20370efa84dSdrh ** The sqlite3ExprCollSeq() routine works the same except that it
20470efa84dSdrh ** returns NULL if there is no defined collation.
20570efa84dSdrh */
20670efa84dSdrh CollSeq *sqlite3ExprNNCollSeq(Parse *pParse, Expr *pExpr){
20770efa84dSdrh   CollSeq *p = sqlite3ExprCollSeq(pParse, pExpr);
20870efa84dSdrh   if( p==0 ) p = pParse->db->pDfltColl;
20970efa84dSdrh   assert( p!=0 );
21070efa84dSdrh   return p;
21170efa84dSdrh }
21270efa84dSdrh 
21370efa84dSdrh /*
21470efa84dSdrh ** Return TRUE if the two expressions have equivalent collating sequences.
21570efa84dSdrh */
21670efa84dSdrh int sqlite3ExprCollSeqMatch(Parse *pParse, Expr *pE1, Expr *pE2){
21770efa84dSdrh   CollSeq *pColl1 = sqlite3ExprNNCollSeq(pParse, pE1);
21870efa84dSdrh   CollSeq *pColl2 = sqlite3ExprNNCollSeq(pParse, pE2);
21970efa84dSdrh   return sqlite3StrICmp(pColl1->zName, pColl2->zName)==0;
22070efa84dSdrh }
22170efa84dSdrh 
22270efa84dSdrh /*
223626a879aSdrh ** pExpr is an operand of a comparison operator.  aff2 is the
224626a879aSdrh ** type affinity of the other operand.  This routine returns the
22553db1458Sdrh ** type affinity that should be used for the comparison operator.
22653db1458Sdrh */
227e014a838Sdanielk1977 char sqlite3CompareAffinity(Expr *pExpr, char aff2){
228bf3b721fSdanielk1977   char aff1 = sqlite3ExprAffinity(pExpr);
229e014a838Sdanielk1977   if( aff1 && aff2 ){
2308df447f0Sdrh     /* Both sides of the comparison are columns. If one has numeric
2318df447f0Sdrh     ** affinity, use that. Otherwise use no affinity.
232e014a838Sdanielk1977     */
2338a51256cSdrh     if( sqlite3IsNumericAffinity(aff1) || sqlite3IsNumericAffinity(aff2) ){
234e014a838Sdanielk1977       return SQLITE_AFF_NUMERIC;
235e014a838Sdanielk1977     }else{
23605883a34Sdrh       return SQLITE_AFF_BLOB;
237e014a838Sdanielk1977     }
238e014a838Sdanielk1977   }else if( !aff1 && !aff2 ){
2395f6a87b3Sdrh     /* Neither side of the comparison is a column.  Compare the
2405f6a87b3Sdrh     ** results directly.
241e014a838Sdanielk1977     */
24205883a34Sdrh     return SQLITE_AFF_BLOB;
243e014a838Sdanielk1977   }else{
244e014a838Sdanielk1977     /* One side is a column, the other is not. Use the columns affinity. */
245fe05af87Sdrh     assert( aff1==0 || aff2==0 );
246e014a838Sdanielk1977     return (aff1 + aff2);
247e014a838Sdanielk1977   }
248e014a838Sdanielk1977 }
249e014a838Sdanielk1977 
25053db1458Sdrh /*
25153db1458Sdrh ** pExpr is a comparison operator.  Return the type affinity that should
25253db1458Sdrh ** be applied to both operands prior to doing the comparison.
25353db1458Sdrh */
254e014a838Sdanielk1977 static char comparisonAffinity(Expr *pExpr){
255e014a838Sdanielk1977   char aff;
256e014a838Sdanielk1977   assert( pExpr->op==TK_EQ || pExpr->op==TK_IN || pExpr->op==TK_LT ||
257e014a838Sdanielk1977           pExpr->op==TK_GT || pExpr->op==TK_GE || pExpr->op==TK_LE ||
2586a2fe093Sdrh           pExpr->op==TK_NE || pExpr->op==TK_IS || pExpr->op==TK_ISNOT );
259e014a838Sdanielk1977   assert( pExpr->pLeft );
260bf3b721fSdanielk1977   aff = sqlite3ExprAffinity(pExpr->pLeft);
261e014a838Sdanielk1977   if( pExpr->pRight ){
262e014a838Sdanielk1977     aff = sqlite3CompareAffinity(pExpr->pRight, aff);
2636ab3a2ecSdanielk1977   }else if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2646ab3a2ecSdanielk1977     aff = sqlite3CompareAffinity(pExpr->x.pSelect->pEList->a[0].pExpr, aff);
26513ac46eeSdrh   }else if( aff==0 ){
26605883a34Sdrh     aff = SQLITE_AFF_BLOB;
267e014a838Sdanielk1977   }
268e014a838Sdanielk1977   return aff;
269e014a838Sdanielk1977 }
270e014a838Sdanielk1977 
271e014a838Sdanielk1977 /*
272e014a838Sdanielk1977 ** pExpr is a comparison expression, eg. '=', '<', IN(...) etc.
273e014a838Sdanielk1977 ** idx_affinity is the affinity of an indexed column. Return true
274e014a838Sdanielk1977 ** if the index with affinity idx_affinity may be used to implement
275e014a838Sdanielk1977 ** the comparison in pExpr.
276e014a838Sdanielk1977 */
277e014a838Sdanielk1977 int sqlite3IndexAffinityOk(Expr *pExpr, char idx_affinity){
278e014a838Sdanielk1977   char aff = comparisonAffinity(pExpr);
2798a51256cSdrh   switch( aff ){
28005883a34Sdrh     case SQLITE_AFF_BLOB:
2818a51256cSdrh       return 1;
2828a51256cSdrh     case SQLITE_AFF_TEXT:
2838a51256cSdrh       return idx_affinity==SQLITE_AFF_TEXT;
2848a51256cSdrh     default:
2858a51256cSdrh       return sqlite3IsNumericAffinity(idx_affinity);
2868a51256cSdrh   }
287e014a838Sdanielk1977 }
288e014a838Sdanielk1977 
289a37cdde0Sdanielk1977 /*
29035573356Sdrh ** Return the P5 value that should be used for a binary comparison
291a37cdde0Sdanielk1977 ** opcode (OP_Eq, OP_Ge etc.) used to compare pExpr1 and pExpr2.
292a37cdde0Sdanielk1977 */
29335573356Sdrh static u8 binaryCompareP5(Expr *pExpr1, Expr *pExpr2, int jumpIfNull){
29435573356Sdrh   u8 aff = (char)sqlite3ExprAffinity(pExpr2);
2951bd10f8aSdrh   aff = (u8)sqlite3CompareAffinity(pExpr1, aff) | (u8)jumpIfNull;
29635573356Sdrh   return aff;
297a37cdde0Sdanielk1977 }
298a37cdde0Sdanielk1977 
299a2e00042Sdrh /*
3000202b29eSdanielk1977 ** Return a pointer to the collation sequence that should be used by
3010202b29eSdanielk1977 ** a binary comparison operator comparing pLeft and pRight.
3020202b29eSdanielk1977 **
3030202b29eSdanielk1977 ** If the left hand expression has a collating sequence type, then it is
3040202b29eSdanielk1977 ** used. Otherwise the collation sequence for the right hand expression
3050202b29eSdanielk1977 ** is used, or the default (BINARY) if neither expression has a collating
3060202b29eSdanielk1977 ** type.
307bcbb04e5Sdanielk1977 **
308bcbb04e5Sdanielk1977 ** Argument pRight (but not pLeft) may be a null pointer. In this case,
309bcbb04e5Sdanielk1977 ** it is not considered.
3100202b29eSdanielk1977 */
311bcbb04e5Sdanielk1977 CollSeq *sqlite3BinaryCompareCollSeq(
312bcbb04e5Sdanielk1977   Parse *pParse,
313bcbb04e5Sdanielk1977   Expr *pLeft,
314bcbb04e5Sdanielk1977   Expr *pRight
315bcbb04e5Sdanielk1977 ){
316ec41ddacSdrh   CollSeq *pColl;
317ec41ddacSdrh   assert( pLeft );
318ae80ddeaSdrh   if( pLeft->flags & EP_Collate ){
319ae80ddeaSdrh     pColl = sqlite3ExprCollSeq(pParse, pLeft);
320ae80ddeaSdrh   }else if( pRight && (pRight->flags & EP_Collate)!=0 ){
321ae80ddeaSdrh     pColl = sqlite3ExprCollSeq(pParse, pRight);
322ec41ddacSdrh   }else{
323ec41ddacSdrh     pColl = sqlite3ExprCollSeq(pParse, pLeft);
3240202b29eSdanielk1977     if( !pColl ){
3257cedc8d4Sdanielk1977       pColl = sqlite3ExprCollSeq(pParse, pRight);
3260202b29eSdanielk1977     }
327ec41ddacSdrh   }
3280202b29eSdanielk1977   return pColl;
3290202b29eSdanielk1977 }
3300202b29eSdanielk1977 
3310202b29eSdanielk1977 /*
332be5c89acSdrh ** Generate code for a comparison operator.
333be5c89acSdrh */
334be5c89acSdrh static int codeCompare(
335be5c89acSdrh   Parse *pParse,    /* The parsing (and code generating) context */
336be5c89acSdrh   Expr *pLeft,      /* The left operand */
337be5c89acSdrh   Expr *pRight,     /* The right operand */
338be5c89acSdrh   int opcode,       /* The comparison opcode */
33935573356Sdrh   int in1, int in2, /* Register holding operands */
340be5c89acSdrh   int dest,         /* Jump here if true.  */
341be5c89acSdrh   int jumpIfNull    /* If true, jump if either operand is NULL */
342be5c89acSdrh ){
34335573356Sdrh   int p5;
34435573356Sdrh   int addr;
34535573356Sdrh   CollSeq *p4;
34635573356Sdrh 
34735573356Sdrh   p4 = sqlite3BinaryCompareCollSeq(pParse, pLeft, pRight);
34835573356Sdrh   p5 = binaryCompareP5(pLeft, pRight, jumpIfNull);
34935573356Sdrh   addr = sqlite3VdbeAddOp4(pParse->pVdbe, opcode, in2, dest, in1,
35035573356Sdrh                            (void*)p4, P4_COLLSEQ);
3511bd10f8aSdrh   sqlite3VdbeChangeP5(pParse->pVdbe, (u8)p5);
35235573356Sdrh   return addr;
353be5c89acSdrh }
354be5c89acSdrh 
355cfbb5e82Sdan /*
356870a0705Sdan ** Return true if expression pExpr is a vector, or false otherwise.
357d832da7fSdrh **
358d832da7fSdrh ** A vector is defined as any expression that results in two or more
359d832da7fSdrh ** columns of result.  Every TK_VECTOR node is an vector because the
360d832da7fSdrh ** parser will not generate a TK_VECTOR with fewer than two entries.
361d832da7fSdrh ** But a TK_SELECT might be either a vector or a scalar. It is only
362d832da7fSdrh ** considered a vector if it has two or more result columns.
363870a0705Sdan */
364870a0705Sdan int sqlite3ExprIsVector(Expr *pExpr){
36576dbe7a8Sdrh   return sqlite3ExprVectorSize(pExpr)>1;
366870a0705Sdan }
367870a0705Sdan 
368870a0705Sdan /*
369cfbb5e82Sdan ** If the expression passed as the only argument is of type TK_VECTOR
370cfbb5e82Sdan ** return the number of expressions in the vector. Or, if the expression
371cfbb5e82Sdan ** is a sub-select, return the number of columns in the sub-select. For
372cfbb5e82Sdan ** any other type of expression, return 1.
373cfbb5e82Sdan */
37471c57db0Sdan int sqlite3ExprVectorSize(Expr *pExpr){
37512abf408Sdrh   u8 op = pExpr->op;
37612abf408Sdrh   if( op==TK_REGISTER ) op = pExpr->op2;
37712abf408Sdrh   if( op==TK_VECTOR ){
37871c57db0Sdan     return pExpr->x.pList->nExpr;
37912abf408Sdrh   }else if( op==TK_SELECT ){
38076dbe7a8Sdrh     return pExpr->x.pSelect->pEList->nExpr;
38176dbe7a8Sdrh   }else{
38276dbe7a8Sdrh     return 1;
38376dbe7a8Sdrh   }
38471c57db0Sdan }
38571c57db0Sdan 
386ba00e30aSdan /*
387fc7f27b9Sdrh ** Return a pointer to a subexpression of pVector that is the i-th
388fc7f27b9Sdrh ** column of the vector (numbered starting with 0).  The caller must
389fc7f27b9Sdrh ** ensure that i is within range.
390fc7f27b9Sdrh **
39176dbe7a8Sdrh ** If pVector is really a scalar (and "scalar" here includes subqueries
39276dbe7a8Sdrh ** that return a single column!) then return pVector unmodified.
39376dbe7a8Sdrh **
394fc7f27b9Sdrh ** pVector retains ownership of the returned subexpression.
395fc7f27b9Sdrh **
396fc7f27b9Sdrh ** If the vector is a (SELECT ...) then the expression returned is
39776dbe7a8Sdrh ** just the expression for the i-th term of the result set, and may
39876dbe7a8Sdrh ** not be ready for evaluation because the table cursor has not yet
39976dbe7a8Sdrh ** been positioned.
400ba00e30aSdan */
401fc7f27b9Sdrh Expr *sqlite3VectorFieldSubexpr(Expr *pVector, int i){
402870a0705Sdan   assert( i<sqlite3ExprVectorSize(pVector) );
403870a0705Sdan   if( sqlite3ExprIsVector(pVector) ){
4049f24b53dSdrh     assert( pVector->op2==0 || pVector->op==TK_REGISTER );
4059f24b53dSdrh     if( pVector->op==TK_SELECT || pVector->op2==TK_SELECT ){
40671c57db0Sdan       return pVector->x.pSelect->pEList->a[i].pExpr;
407870a0705Sdan     }else{
40871c57db0Sdan       return pVector->x.pList->a[i].pExpr;
40971c57db0Sdan     }
410870a0705Sdan   }
411870a0705Sdan   return pVector;
412870a0705Sdan }
413fc7f27b9Sdrh 
414fc7f27b9Sdrh /*
415fc7f27b9Sdrh ** Compute and return a new Expr object which when passed to
416fc7f27b9Sdrh ** sqlite3ExprCode() will generate all necessary code to compute
417fc7f27b9Sdrh ** the iField-th column of the vector expression pVector.
418fc7f27b9Sdrh **
4198762ec19Sdrh ** It is ok for pVector to be a scalar (as long as iField==0).
4208762ec19Sdrh ** In that case, this routine works like sqlite3ExprDup().
4218762ec19Sdrh **
422fc7f27b9Sdrh ** The caller owns the returned Expr object and is responsible for
423fc7f27b9Sdrh ** ensuring that the returned value eventually gets freed.
424fc7f27b9Sdrh **
4258762ec19Sdrh ** The caller retains ownership of pVector.  If pVector is a TK_SELECT,
426fad0e70cSdan ** then the returned object will reference pVector and so pVector must remain
4278762ec19Sdrh ** valid for the life of the returned object.  If pVector is a TK_VECTOR
4288762ec19Sdrh ** or a scalar expression, then it can be deleted as soon as this routine
42976dbe7a8Sdrh ** returns.
4308762ec19Sdrh **
4318762ec19Sdrh ** A trick to cause a TK_SELECT pVector to be deleted together with
4328762ec19Sdrh ** the returned Expr object is to attach the pVector to the pRight field
4338762ec19Sdrh ** of the returned TK_SELECT_COLUMN Expr object.
434fc7f27b9Sdrh */
435fc7f27b9Sdrh Expr *sqlite3ExprForVectorField(
436fc7f27b9Sdrh   Parse *pParse,       /* Parsing context */
437fc7f27b9Sdrh   Expr *pVector,       /* The vector.  List of expressions or a sub-SELECT */
438a1251bc4Sdrh   int iField           /* Which column of the vector to return */
439fc7f27b9Sdrh ){
440fc7f27b9Sdrh   Expr *pRet;
441a1251bc4Sdrh   if( pVector->op==TK_SELECT ){
442a1251bc4Sdrh     assert( pVector->flags & EP_xIsSelect );
443fc7f27b9Sdrh     /* The TK_SELECT_COLUMN Expr node:
444fc7f27b9Sdrh     **
445966e2911Sdrh     ** pLeft:           pVector containing TK_SELECT.  Not deleted.
4468762ec19Sdrh     ** pRight:          not used.  But recursively deleted.
447fc7f27b9Sdrh     ** iColumn:         Index of a column in pVector
448966e2911Sdrh     ** iTable:          0 or the number of columns on the LHS of an assignment
449fc7f27b9Sdrh     ** pLeft->iTable:   First in an array of register holding result, or 0
450fc7f27b9Sdrh     **                  if the result is not yet computed.
451fc7f27b9Sdrh     **
452fc7f27b9Sdrh     ** sqlite3ExprDelete() specifically skips the recursive delete of
453fc7f27b9Sdrh     ** pLeft on TK_SELECT_COLUMN nodes.  But pRight is followed, so pVector
4548762ec19Sdrh     ** can be attached to pRight to cause this node to take ownership of
4558762ec19Sdrh     ** pVector.  Typically there will be multiple TK_SELECT_COLUMN nodes
4568762ec19Sdrh     ** with the same pLeft pointer to the pVector, but only one of them
4578762ec19Sdrh     ** will own the pVector.
458fc7f27b9Sdrh     */
459abfd35eaSdrh     pRet = sqlite3PExpr(pParse, TK_SELECT_COLUMN, 0, 0);
4608bd0d58eSdrh     if( pRet ){
4618bd0d58eSdrh       pRet->iColumn = iField;
4628bd0d58eSdrh       pRet->pLeft = pVector;
4638bd0d58eSdrh     }
464fc7f27b9Sdrh     assert( pRet==0 || pRet->iTable==0 );
465fc7f27b9Sdrh   }else{
466a1251bc4Sdrh     if( pVector->op==TK_VECTOR ) pVector = pVector->x.pList->a[iField].pExpr;
467a1251bc4Sdrh     pRet = sqlite3ExprDup(pParse->db, pVector, 0);
468dfb5c963Sdan     sqlite3RenameTokenRemap(pParse, pRet, pVector);
469fc7f27b9Sdrh   }
470fc7f27b9Sdrh   return pRet;
471fc7f27b9Sdrh }
47271c57db0Sdan 
4735c288b92Sdan /*
4745c288b92Sdan ** If expression pExpr is of type TK_SELECT, generate code to evaluate
4755c288b92Sdan ** it. Return the register in which the result is stored (or, if the
4765c288b92Sdan ** sub-select returns more than one column, the first in an array
4775c288b92Sdan ** of registers in which the result is stored).
4785c288b92Sdan **
4795c288b92Sdan ** If pExpr is not a TK_SELECT expression, return 0.
4805c288b92Sdan */
4815c288b92Sdan static int exprCodeSubselect(Parse *pParse, Expr *pExpr){
4828da209b1Sdan   int reg = 0;
483f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
4845c288b92Sdan   if( pExpr->op==TK_SELECT ){
48585bcdce2Sdrh     reg = sqlite3CodeSubselect(pParse, pExpr);
4868da209b1Sdan   }
487f9b2e05cSdan #endif
4888da209b1Sdan   return reg;
4898da209b1Sdan }
4908da209b1Sdan 
4915c288b92Sdan /*
4925c288b92Sdan ** Argument pVector points to a vector expression - either a TK_VECTOR
493870a0705Sdan ** or TK_SELECT that returns more than one column. This function returns
494870a0705Sdan ** the register number of a register that contains the value of
495870a0705Sdan ** element iField of the vector.
496870a0705Sdan **
497870a0705Sdan ** If pVector is a TK_SELECT expression, then code for it must have
498870a0705Sdan ** already been generated using the exprCodeSubselect() routine. In this
499870a0705Sdan ** case parameter regSelect should be the first in an array of registers
500870a0705Sdan ** containing the results of the sub-select.
501870a0705Sdan **
502870a0705Sdan ** If pVector is of type TK_VECTOR, then code for the requested field
503870a0705Sdan ** is generated. In this case (*pRegFree) may be set to the number of
504870a0705Sdan ** a temporary register to be freed by the caller before returning.
5055c288b92Sdan **
5065c288b92Sdan ** Before returning, output parameter (*ppExpr) is set to point to the
5075c288b92Sdan ** Expr object corresponding to element iElem of the vector.
5085c288b92Sdan */
5095c288b92Sdan static int exprVectorRegister(
5105c288b92Sdan   Parse *pParse,                  /* Parse context */
5115c288b92Sdan   Expr *pVector,                  /* Vector to extract element from */
512870a0705Sdan   int iField,                     /* Field to extract from pVector */
5135c288b92Sdan   int regSelect,                  /* First in array of registers */
5145c288b92Sdan   Expr **ppExpr,                  /* OUT: Expression element */
5155c288b92Sdan   int *pRegFree                   /* OUT: Temp register to free */
5165c288b92Sdan ){
51712abf408Sdrh   u8 op = pVector->op;
518c1bcd9ccSdrh   assert( op==TK_VECTOR || op==TK_REGISTER || op==TK_SELECT );
51912abf408Sdrh   if( op==TK_REGISTER ){
52012abf408Sdrh     *ppExpr = sqlite3VectorFieldSubexpr(pVector, iField);
52112abf408Sdrh     return pVector->iTable+iField;
52212abf408Sdrh   }
52312abf408Sdrh   if( op==TK_SELECT ){
524870a0705Sdan     *ppExpr = pVector->x.pSelect->pEList->a[iField].pExpr;
525870a0705Sdan      return regSelect+iField;
5265c288b92Sdan   }
527870a0705Sdan   *ppExpr = pVector->x.pList->a[iField].pExpr;
5285c288b92Sdan   return sqlite3ExprCodeTemp(pParse, *ppExpr, pRegFree);
5295c288b92Sdan }
5305c288b92Sdan 
5315c288b92Sdan /*
5325c288b92Sdan ** Expression pExpr is a comparison between two vector values. Compute
53379752b6eSdrh ** the result of the comparison (1, 0, or NULL) and write that
53479752b6eSdrh ** result into register dest.
53579752b6eSdrh **
53679752b6eSdrh ** The caller must satisfy the following preconditions:
53779752b6eSdrh **
53879752b6eSdrh **    if pExpr->op==TK_IS:      op==TK_EQ and p5==SQLITE_NULLEQ
53979752b6eSdrh **    if pExpr->op==TK_ISNOT:   op==TK_NE and p5==SQLITE_NULLEQ
54079752b6eSdrh **    otherwise:                op==pExpr->op and p5==0
5415c288b92Sdan */
54279752b6eSdrh static void codeVectorCompare(
54379752b6eSdrh   Parse *pParse,        /* Code generator context */
54479752b6eSdrh   Expr *pExpr,          /* The comparison operation */
54579752b6eSdrh   int dest,             /* Write results into this register */
54679752b6eSdrh   u8 op,                /* Comparison operator */
54779752b6eSdrh   u8 p5                 /* SQLITE_NULLEQ or zero */
54879752b6eSdrh ){
54971c57db0Sdan   Vdbe *v = pParse->pVdbe;
55071c57db0Sdan   Expr *pLeft = pExpr->pLeft;
55171c57db0Sdan   Expr *pRight = pExpr->pRight;
55271c57db0Sdan   int nLeft = sqlite3ExprVectorSize(pLeft);
55371c57db0Sdan   int i;
55471c57db0Sdan   int regLeft = 0;
55571c57db0Sdan   int regRight = 0;
55679752b6eSdrh   u8 opx = op;
557ec4ccdbcSdrh   int addrDone = sqlite3VdbeMakeLabel(pParse);
55871c57db0Sdan 
559245ce62eSdrh   if( nLeft!=sqlite3ExprVectorSize(pRight) ){
560245ce62eSdrh     sqlite3ErrorMsg(pParse, "row value misused");
561245ce62eSdrh     return;
562245ce62eSdrh   }
56371c57db0Sdan   assert( pExpr->op==TK_EQ || pExpr->op==TK_NE
56471c57db0Sdan        || pExpr->op==TK_IS || pExpr->op==TK_ISNOT
56571c57db0Sdan        || pExpr->op==TK_LT || pExpr->op==TK_GT
56671c57db0Sdan        || pExpr->op==TK_LE || pExpr->op==TK_GE
56771c57db0Sdan   );
56879752b6eSdrh   assert( pExpr->op==op || (pExpr->op==TK_IS && op==TK_EQ)
56979752b6eSdrh             || (pExpr->op==TK_ISNOT && op==TK_NE) );
57079752b6eSdrh   assert( p5==0 || pExpr->op!=op );
57179752b6eSdrh   assert( p5==SQLITE_NULLEQ || pExpr->op==op );
57271c57db0Sdan 
57379752b6eSdrh   p5 |= SQLITE_STOREP2;
57479752b6eSdrh   if( opx==TK_LE ) opx = TK_LT;
57579752b6eSdrh   if( opx==TK_GE ) opx = TK_GT;
5765c288b92Sdan 
5775c288b92Sdan   regLeft = exprCodeSubselect(pParse, pLeft);
5785c288b92Sdan   regRight = exprCodeSubselect(pParse, pRight);
5795c288b92Sdan 
580321e828dSdrh   for(i=0; 1 /*Loop exits by "break"*/; i++){
5815c288b92Sdan     int regFree1 = 0, regFree2 = 0;
5825c288b92Sdan     Expr *pL, *pR;
5835c288b92Sdan     int r1, r2;
584321e828dSdrh     assert( i>=0 && i<nLeft );
5855c288b92Sdan     r1 = exprVectorRegister(pParse, pLeft, i, regLeft, &pL, &regFree1);
5865c288b92Sdan     r2 = exprVectorRegister(pParse, pRight, i, regRight, &pR, &regFree2);
58779752b6eSdrh     codeCompare(pParse, pL, pR, opx, r1, r2, dest, p5);
58879752b6eSdrh     testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
58979752b6eSdrh     testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
59079752b6eSdrh     testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
59179752b6eSdrh     testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
59279752b6eSdrh     testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
59379752b6eSdrh     testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
59471c57db0Sdan     sqlite3ReleaseTempReg(pParse, regFree1);
59571c57db0Sdan     sqlite3ReleaseTempReg(pParse, regFree2);
59679752b6eSdrh     if( i==nLeft-1 ){
59779752b6eSdrh       break;
59871c57db0Sdan     }
59979752b6eSdrh     if( opx==TK_EQ ){
60079752b6eSdrh       sqlite3VdbeAddOp2(v, OP_IfNot, dest, addrDone); VdbeCoverage(v);
60179752b6eSdrh       p5 |= SQLITE_KEEPNULL;
60279752b6eSdrh     }else if( opx==TK_NE ){
60379752b6eSdrh       sqlite3VdbeAddOp2(v, OP_If, dest, addrDone); VdbeCoverage(v);
60479752b6eSdrh       p5 |= SQLITE_KEEPNULL;
605a2f62925Sdrh     }else{
606a2f62925Sdrh       assert( op==TK_LT || op==TK_GT || op==TK_LE || op==TK_GE );
607a2f62925Sdrh       sqlite3VdbeAddOp2(v, OP_ElseNotEq, 0, addrDone);
60879752b6eSdrh       VdbeCoverageIf(v, op==TK_LT);
60979752b6eSdrh       VdbeCoverageIf(v, op==TK_GT);
61079752b6eSdrh       VdbeCoverageIf(v, op==TK_LE);
61179752b6eSdrh       VdbeCoverageIf(v, op==TK_GE);
61279752b6eSdrh       if( i==nLeft-2 ) opx = op;
61371c57db0Sdan     }
61479752b6eSdrh   }
61579752b6eSdrh   sqlite3VdbeResolveLabel(v, addrDone);
61679752b6eSdrh }
61771c57db0Sdan 
6184b5255acSdanielk1977 #if SQLITE_MAX_EXPR_DEPTH>0
6194b5255acSdanielk1977 /*
6204b5255acSdanielk1977 ** Check that argument nHeight is less than or equal to the maximum
6214b5255acSdanielk1977 ** expression depth allowed. If it is not, leave an error message in
6224b5255acSdanielk1977 ** pParse.
6234b5255acSdanielk1977 */
6247d10d5a6Sdrh int sqlite3ExprCheckHeight(Parse *pParse, int nHeight){
6254b5255acSdanielk1977   int rc = SQLITE_OK;
6264b5255acSdanielk1977   int mxHeight = pParse->db->aLimit[SQLITE_LIMIT_EXPR_DEPTH];
6274b5255acSdanielk1977   if( nHeight>mxHeight ){
6284b5255acSdanielk1977     sqlite3ErrorMsg(pParse,
6294b5255acSdanielk1977        "Expression tree is too large (maximum depth %d)", mxHeight
6304b5255acSdanielk1977     );
6314b5255acSdanielk1977     rc = SQLITE_ERROR;
6324b5255acSdanielk1977   }
6334b5255acSdanielk1977   return rc;
6344b5255acSdanielk1977 }
6354b5255acSdanielk1977 
6364b5255acSdanielk1977 /* The following three functions, heightOfExpr(), heightOfExprList()
6374b5255acSdanielk1977 ** and heightOfSelect(), are used to determine the maximum height
6384b5255acSdanielk1977 ** of any expression tree referenced by the structure passed as the
6394b5255acSdanielk1977 ** first argument.
6404b5255acSdanielk1977 **
6414b5255acSdanielk1977 ** If this maximum height is greater than the current value pointed
6424b5255acSdanielk1977 ** to by pnHeight, the second parameter, then set *pnHeight to that
6434b5255acSdanielk1977 ** value.
6444b5255acSdanielk1977 */
6454b5255acSdanielk1977 static void heightOfExpr(Expr *p, int *pnHeight){
6464b5255acSdanielk1977   if( p ){
6474b5255acSdanielk1977     if( p->nHeight>*pnHeight ){
6484b5255acSdanielk1977       *pnHeight = p->nHeight;
6494b5255acSdanielk1977     }
6504b5255acSdanielk1977   }
6514b5255acSdanielk1977 }
6524b5255acSdanielk1977 static void heightOfExprList(ExprList *p, int *pnHeight){
6534b5255acSdanielk1977   if( p ){
6544b5255acSdanielk1977     int i;
6554b5255acSdanielk1977     for(i=0; i<p->nExpr; i++){
6564b5255acSdanielk1977       heightOfExpr(p->a[i].pExpr, pnHeight);
6574b5255acSdanielk1977     }
6584b5255acSdanielk1977   }
6594b5255acSdanielk1977 }
6601a3a3086Sdan static void heightOfSelect(Select *pSelect, int *pnHeight){
6611a3a3086Sdan   Select *p;
6621a3a3086Sdan   for(p=pSelect; p; p=p->pPrior){
6634b5255acSdanielk1977     heightOfExpr(p->pWhere, pnHeight);
6644b5255acSdanielk1977     heightOfExpr(p->pHaving, pnHeight);
6654b5255acSdanielk1977     heightOfExpr(p->pLimit, pnHeight);
6664b5255acSdanielk1977     heightOfExprList(p->pEList, pnHeight);
6674b5255acSdanielk1977     heightOfExprList(p->pGroupBy, pnHeight);
6684b5255acSdanielk1977     heightOfExprList(p->pOrderBy, pnHeight);
6694b5255acSdanielk1977   }
6704b5255acSdanielk1977 }
6714b5255acSdanielk1977 
6724b5255acSdanielk1977 /*
6734b5255acSdanielk1977 ** Set the Expr.nHeight variable in the structure passed as an
6744b5255acSdanielk1977 ** argument. An expression with no children, Expr.pList or
6754b5255acSdanielk1977 ** Expr.pSelect member has a height of 1. Any other expression
6764b5255acSdanielk1977 ** has a height equal to the maximum height of any other
6774b5255acSdanielk1977 ** referenced Expr plus one.
6782308ed38Sdrh **
6792308ed38Sdrh ** Also propagate EP_Propagate flags up from Expr.x.pList to Expr.flags,
6802308ed38Sdrh ** if appropriate.
6814b5255acSdanielk1977 */
6824b5255acSdanielk1977 static void exprSetHeight(Expr *p){
6834b5255acSdanielk1977   int nHeight = 0;
6844b5255acSdanielk1977   heightOfExpr(p->pLeft, &nHeight);
6854b5255acSdanielk1977   heightOfExpr(p->pRight, &nHeight);
6866ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_xIsSelect) ){
6876ab3a2ecSdanielk1977     heightOfSelect(p->x.pSelect, &nHeight);
6882308ed38Sdrh   }else if( p->x.pList ){
6896ab3a2ecSdanielk1977     heightOfExprList(p->x.pList, &nHeight);
6902308ed38Sdrh     p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
6916ab3a2ecSdanielk1977   }
6924b5255acSdanielk1977   p->nHeight = nHeight + 1;
6934b5255acSdanielk1977 }
6944b5255acSdanielk1977 
6954b5255acSdanielk1977 /*
6964b5255acSdanielk1977 ** Set the Expr.nHeight variable using the exprSetHeight() function. If
6974b5255acSdanielk1977 ** the height is greater than the maximum allowed expression depth,
6984b5255acSdanielk1977 ** leave an error in pParse.
6992308ed38Sdrh **
7002308ed38Sdrh ** Also propagate all EP_Propagate flags from the Expr.x.pList into
7012308ed38Sdrh ** Expr.flags.
7024b5255acSdanielk1977 */
7032308ed38Sdrh void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
70474893a4cSdrh   if( pParse->nErr ) return;
7054b5255acSdanielk1977   exprSetHeight(p);
7067d10d5a6Sdrh   sqlite3ExprCheckHeight(pParse, p->nHeight);
7074b5255acSdanielk1977 }
7084b5255acSdanielk1977 
7094b5255acSdanielk1977 /*
7104b5255acSdanielk1977 ** Return the maximum height of any expression tree referenced
7114b5255acSdanielk1977 ** by the select statement passed as an argument.
7124b5255acSdanielk1977 */
7134b5255acSdanielk1977 int sqlite3SelectExprHeight(Select *p){
7144b5255acSdanielk1977   int nHeight = 0;
7154b5255acSdanielk1977   heightOfSelect(p, &nHeight);
7164b5255acSdanielk1977   return nHeight;
7174b5255acSdanielk1977 }
7182308ed38Sdrh #else /* ABOVE:  Height enforcement enabled.  BELOW: Height enforcement off */
7192308ed38Sdrh /*
7202308ed38Sdrh ** Propagate all EP_Propagate flags from the Expr.x.pList into
7212308ed38Sdrh ** Expr.flags.
7222308ed38Sdrh */
7232308ed38Sdrh void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
7242308ed38Sdrh   if( p && p->x.pList && !ExprHasProperty(p, EP_xIsSelect) ){
7252308ed38Sdrh     p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
7262308ed38Sdrh   }
7272308ed38Sdrh }
7284b5255acSdanielk1977 #define exprSetHeight(y)
7294b5255acSdanielk1977 #endif /* SQLITE_MAX_EXPR_DEPTH>0 */
7304b5255acSdanielk1977 
731be5c89acSdrh /*
732b7916a78Sdrh ** This routine is the core allocator for Expr nodes.
733b7916a78Sdrh **
734a76b5dfcSdrh ** Construct a new expression node and return a pointer to it.  Memory
735b7916a78Sdrh ** for this node and for the pToken argument is a single allocation
736b7916a78Sdrh ** obtained from sqlite3DbMalloc().  The calling function
737a76b5dfcSdrh ** is responsible for making sure the node eventually gets freed.
738b7916a78Sdrh **
739b7916a78Sdrh ** If dequote is true, then the token (if it exists) is dequoted.
740e792b5b4Sdrh ** If dequote is false, no dequoting is performed.  The deQuote
741b7916a78Sdrh ** parameter is ignored if pToken is NULL or if the token does not
742b7916a78Sdrh ** appear to be quoted.  If the quotes were of the form "..." (double-quotes)
743b7916a78Sdrh ** then the EP_DblQuoted flag is set on the expression node.
74433e619fcSdrh **
74533e619fcSdrh ** Special case:  If op==TK_INTEGER and pToken points to a string that
74633e619fcSdrh ** can be translated into a 32-bit integer, then the token is not
74733e619fcSdrh ** stored in u.zToken.  Instead, the integer values is written
74833e619fcSdrh ** into u.iValue and the EP_IntValue flag is set.  No extra storage
74933e619fcSdrh ** is allocated to hold the integer text and the dequote flag is ignored.
750a76b5dfcSdrh */
751b7916a78Sdrh Expr *sqlite3ExprAlloc(
752cca8a4adSdrh   sqlite3 *db,            /* Handle for sqlite3DbMallocRawNN() */
75317435752Sdrh   int op,                 /* Expression opcode */
754b7916a78Sdrh   const Token *pToken,    /* Token argument.  Might be NULL */
755b7916a78Sdrh   int dequote             /* True to dequote */
75617435752Sdrh ){
757a76b5dfcSdrh   Expr *pNew;
75833e619fcSdrh   int nExtra = 0;
759cf697396Sshane   int iValue = 0;
760b7916a78Sdrh 
761575fad65Sdrh   assert( db!=0 );
762b7916a78Sdrh   if( pToken ){
76333e619fcSdrh     if( op!=TK_INTEGER || pToken->z==0
76433e619fcSdrh           || sqlite3GetInt32(pToken->z, &iValue)==0 ){
765b7916a78Sdrh       nExtra = pToken->n+1;
766d50ffc41Sdrh       assert( iValue>=0 );
76733e619fcSdrh     }
768a76b5dfcSdrh   }
769575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, sizeof(Expr)+nExtra);
770b7916a78Sdrh   if( pNew ){
771ca3862dcSdrh     memset(pNew, 0, sizeof(Expr));
7721bd10f8aSdrh     pNew->op = (u8)op;
773a58fdfb1Sdanielk1977     pNew->iAgg = -1;
774a76b5dfcSdrh     if( pToken ){
77533e619fcSdrh       if( nExtra==0 ){
776b98a2e35Sdrh         pNew->flags |= EP_IntValue|EP_Leaf;
77733e619fcSdrh         pNew->u.iValue = iValue;
77833e619fcSdrh       }else{
77933e619fcSdrh         pNew->u.zToken = (char*)&pNew[1];
780b07028f7Sdrh         assert( pToken->z!=0 || pToken->n==0 );
781b07028f7Sdrh         if( pToken->n ) memcpy(pNew->u.zToken, pToken->z, pToken->n);
78233e619fcSdrh         pNew->u.zToken[pToken->n] = 0;
783244b9d6eSdrh         if( dequote && sqlite3Isquote(pNew->u.zToken[0]) ){
78451d35b0fSdrh           sqlite3DequoteExpr(pNew);
785a34001c9Sdrh         }
786a34001c9Sdrh       }
78733e619fcSdrh     }
788b7916a78Sdrh #if SQLITE_MAX_EXPR_DEPTH>0
789b7916a78Sdrh     pNew->nHeight = 1;
790b7916a78Sdrh #endif
791a34001c9Sdrh   }
792a76b5dfcSdrh   return pNew;
793a76b5dfcSdrh }
794a76b5dfcSdrh 
795a76b5dfcSdrh /*
796b7916a78Sdrh ** Allocate a new expression node from a zero-terminated token that has
797b7916a78Sdrh ** already been dequoted.
798b7916a78Sdrh */
799b7916a78Sdrh Expr *sqlite3Expr(
800b7916a78Sdrh   sqlite3 *db,            /* Handle for sqlite3DbMallocZero() (may be null) */
801b7916a78Sdrh   int op,                 /* Expression opcode */
802b7916a78Sdrh   const char *zToken      /* Token argument.  Might be NULL */
803b7916a78Sdrh ){
804b7916a78Sdrh   Token x;
805b7916a78Sdrh   x.z = zToken;
806b40f06c6Sdrh   x.n = sqlite3Strlen30(zToken);
807b7916a78Sdrh   return sqlite3ExprAlloc(db, op, &x, 0);
808b7916a78Sdrh }
809b7916a78Sdrh 
810b7916a78Sdrh /*
811b7916a78Sdrh ** Attach subtrees pLeft and pRight to the Expr node pRoot.
812b7916a78Sdrh **
813b7916a78Sdrh ** If pRoot==NULL that means that a memory allocation error has occurred.
814b7916a78Sdrh ** In that case, delete the subtrees pLeft and pRight.
815b7916a78Sdrh */
816b7916a78Sdrh void sqlite3ExprAttachSubtrees(
817b7916a78Sdrh   sqlite3 *db,
818b7916a78Sdrh   Expr *pRoot,
819b7916a78Sdrh   Expr *pLeft,
820b7916a78Sdrh   Expr *pRight
821b7916a78Sdrh ){
822b7916a78Sdrh   if( pRoot==0 ){
823b7916a78Sdrh     assert( db->mallocFailed );
824b7916a78Sdrh     sqlite3ExprDelete(db, pLeft);
825b7916a78Sdrh     sqlite3ExprDelete(db, pRight);
826b7916a78Sdrh   }else{
827b7916a78Sdrh     if( pRight ){
828b7916a78Sdrh       pRoot->pRight = pRight;
829885a5b03Sdrh       pRoot->flags |= EP_Propagate & pRight->flags;
830b7916a78Sdrh     }
831b7916a78Sdrh     if( pLeft ){
832b7916a78Sdrh       pRoot->pLeft = pLeft;
833885a5b03Sdrh       pRoot->flags |= EP_Propagate & pLeft->flags;
834b7916a78Sdrh     }
835b7916a78Sdrh     exprSetHeight(pRoot);
836b7916a78Sdrh   }
837b7916a78Sdrh }
838b7916a78Sdrh 
839b7916a78Sdrh /*
84060ec914cSpeter.d.reid ** Allocate an Expr node which joins as many as two subtrees.
841b7916a78Sdrh **
842bf664469Sdrh ** One or both of the subtrees can be NULL.  Return a pointer to the new
843bf664469Sdrh ** Expr node.  Or, if an OOM error occurs, set pParse->db->mallocFailed,
844bf664469Sdrh ** free the subtrees and return NULL.
845206f3d96Sdrh */
84617435752Sdrh Expr *sqlite3PExpr(
84717435752Sdrh   Parse *pParse,          /* Parsing context */
84817435752Sdrh   int op,                 /* Expression opcode */
84917435752Sdrh   Expr *pLeft,            /* Left operand */
850abfd35eaSdrh   Expr *pRight            /* Right operand */
85117435752Sdrh ){
8525fb52caaSdrh   Expr *p;
8531167d327Sdrh   if( op==TK_AND && pParse->nErr==0 ){
8545fb52caaSdrh     /* Take advantage of short-circuit false optimization for AND */
8555fb52caaSdrh     p = sqlite3ExprAnd(pParse->db, pLeft, pRight);
8565fb52caaSdrh   }else{
857abfd35eaSdrh     p = sqlite3DbMallocRawNN(pParse->db, sizeof(Expr));
858abfd35eaSdrh     if( p ){
859abfd35eaSdrh       memset(p, 0, sizeof(Expr));
860abfd35eaSdrh       p->op = op & TKFLG_MASK;
861abfd35eaSdrh       p->iAgg = -1;
862abfd35eaSdrh     }
863b7916a78Sdrh     sqlite3ExprAttachSubtrees(pParse->db, p, pLeft, pRight);
8645fb52caaSdrh   }
8652b359bdbSdan   if( p ) {
8662b359bdbSdan     sqlite3ExprCheckHeight(pParse, p->nHeight);
8672b359bdbSdan   }
8684e0cff60Sdrh   return p;
8694e0cff60Sdrh }
8704e0cff60Sdrh 
8714e0cff60Sdrh /*
87208de4f79Sdrh ** Add pSelect to the Expr.x.pSelect field.  Or, if pExpr is NULL (due
87308de4f79Sdrh ** do a memory allocation failure) then delete the pSelect object.
87408de4f79Sdrh */
87508de4f79Sdrh void sqlite3PExprAddSelect(Parse *pParse, Expr *pExpr, Select *pSelect){
87608de4f79Sdrh   if( pExpr ){
87708de4f79Sdrh     pExpr->x.pSelect = pSelect;
87808de4f79Sdrh     ExprSetProperty(pExpr, EP_xIsSelect|EP_Subquery);
87908de4f79Sdrh     sqlite3ExprSetHeightAndFlags(pParse, pExpr);
88008de4f79Sdrh   }else{
88108de4f79Sdrh     assert( pParse->db->mallocFailed );
88208de4f79Sdrh     sqlite3SelectDelete(pParse->db, pSelect);
88308de4f79Sdrh   }
88408de4f79Sdrh }
88508de4f79Sdrh 
88608de4f79Sdrh 
88708de4f79Sdrh /*
888991a1985Sdrh ** If the expression is always either TRUE or FALSE (respectively),
889991a1985Sdrh ** then return 1.  If one cannot determine the truth value of the
890991a1985Sdrh ** expression at compile-time return 0.
891991a1985Sdrh **
892991a1985Sdrh ** This is an optimization.  If is OK to return 0 here even if
893991a1985Sdrh ** the expression really is always false or false (a false negative).
894991a1985Sdrh ** But it is a bug to return 1 if the expression might have different
895991a1985Sdrh ** boolean values in different circumstances (a false positive.)
8965fb52caaSdrh **
8975fb52caaSdrh ** Note that if the expression is part of conditional for a
8985fb52caaSdrh ** LEFT JOIN, then we cannot determine at compile-time whether or not
8995fb52caaSdrh ** is it true or false, so always return 0.
9005fb52caaSdrh */
901991a1985Sdrh static int exprAlwaysTrue(Expr *p){
902991a1985Sdrh   int v = 0;
903991a1985Sdrh   if( ExprHasProperty(p, EP_FromJoin) ) return 0;
904991a1985Sdrh   if( !sqlite3ExprIsInteger(p, &v) ) return 0;
905991a1985Sdrh   return v!=0;
906991a1985Sdrh }
9075fb52caaSdrh static int exprAlwaysFalse(Expr *p){
9085fb52caaSdrh   int v = 0;
9095fb52caaSdrh   if( ExprHasProperty(p, EP_FromJoin) ) return 0;
9105fb52caaSdrh   if( !sqlite3ExprIsInteger(p, &v) ) return 0;
9115fb52caaSdrh   return v==0;
9125fb52caaSdrh }
9135fb52caaSdrh 
9145fb52caaSdrh /*
91591bb0eedSdrh ** Join two expressions using an AND operator.  If either expression is
91691bb0eedSdrh ** NULL, then just return the other expression.
9175fb52caaSdrh **
9185fb52caaSdrh ** If one side or the other of the AND is known to be false, then instead
9195fb52caaSdrh ** of returning an AND expression, just return a constant expression with
9205fb52caaSdrh ** a value of false.
92191bb0eedSdrh */
9221e536953Sdanielk1977 Expr *sqlite3ExprAnd(sqlite3 *db, Expr *pLeft, Expr *pRight){
92391bb0eedSdrh   if( pLeft==0 ){
92491bb0eedSdrh     return pRight;
92591bb0eedSdrh   }else if( pRight==0 ){
92691bb0eedSdrh     return pLeft;
9275fb52caaSdrh   }else if( exprAlwaysFalse(pLeft) || exprAlwaysFalse(pRight) ){
9285fb52caaSdrh     sqlite3ExprDelete(db, pLeft);
9295fb52caaSdrh     sqlite3ExprDelete(db, pRight);
9305fb52caaSdrh     return sqlite3ExprAlloc(db, TK_INTEGER, &sqlite3IntTokens[0], 0);
93191bb0eedSdrh   }else{
932b7916a78Sdrh     Expr *pNew = sqlite3ExprAlloc(db, TK_AND, 0, 0);
933b7916a78Sdrh     sqlite3ExprAttachSubtrees(db, pNew, pLeft, pRight);
934b7916a78Sdrh     return pNew;
935a76b5dfcSdrh   }
936a76b5dfcSdrh }
937a76b5dfcSdrh 
938a76b5dfcSdrh /*
939a76b5dfcSdrh ** Construct a new expression node for a function with multiple
940a76b5dfcSdrh ** arguments.
941a76b5dfcSdrh */
942954733b3Sdrh Expr *sqlite3ExprFunction(
943954733b3Sdrh   Parse *pParse,        /* Parsing context */
944954733b3Sdrh   ExprList *pList,      /* Argument list */
945954733b3Sdrh   Token *pToken,        /* Name of the function */
946954733b3Sdrh   int eDistinct         /* SF_Distinct or SF_ALL or 0 */
947954733b3Sdrh ){
948a76b5dfcSdrh   Expr *pNew;
949633e6d57Sdrh   sqlite3 *db = pParse->db;
9504b202ae2Sdanielk1977   assert( pToken );
951b7916a78Sdrh   pNew = sqlite3ExprAlloc(db, TK_FUNCTION, pToken, 1);
952a76b5dfcSdrh   if( pNew==0 ){
953d9da78a2Sdrh     sqlite3ExprListDelete(db, pList); /* Avoid memory leak when malloc fails */
954a76b5dfcSdrh     return 0;
955a76b5dfcSdrh   }
956954733b3Sdrh   if( pList && pList->nExpr > pParse->db->aLimit[SQLITE_LIMIT_FUNCTION_ARG] ){
957954733b3Sdrh     sqlite3ErrorMsg(pParse, "too many arguments on function %T", pToken);
958954733b3Sdrh   }
9596ab3a2ecSdanielk1977   pNew->x.pList = pList;
960fca23557Sdrh   ExprSetProperty(pNew, EP_HasFunc);
9616ab3a2ecSdanielk1977   assert( !ExprHasProperty(pNew, EP_xIsSelect) );
9622308ed38Sdrh   sqlite3ExprSetHeightAndFlags(pParse, pNew);
963954733b3Sdrh   if( eDistinct==SF_Distinct ) ExprSetProperty(pNew, EP_Distinct);
964a76b5dfcSdrh   return pNew;
965a76b5dfcSdrh }
966a76b5dfcSdrh 
967a76b5dfcSdrh /*
968fa6bc000Sdrh ** Assign a variable number to an expression that encodes a wildcard
969fa6bc000Sdrh ** in the original SQL statement.
970fa6bc000Sdrh **
971fa6bc000Sdrh ** Wildcards consisting of a single "?" are assigned the next sequential
972fa6bc000Sdrh ** variable number.
973fa6bc000Sdrh **
974fa6bc000Sdrh ** Wildcards of the form "?nnn" are assigned the number "nnn".  We make
9759bf755ccSdrh ** sure "nnn" is not too big to avoid a denial of service attack when
976fa6bc000Sdrh ** the SQL statement comes from an external source.
977fa6bc000Sdrh **
97851f49f17Sdrh ** Wildcards of the form ":aaa", "@aaa", or "$aaa" are assigned the same number
979fa6bc000Sdrh ** as the previous instance of the same wildcard.  Or if this is the first
98060ec914cSpeter.d.reid ** instance of the wildcard, the next sequential variable number is
981fa6bc000Sdrh ** assigned.
982fa6bc000Sdrh */
983de25a88cSdrh void sqlite3ExprAssignVarNumber(Parse *pParse, Expr *pExpr, u32 n){
98417435752Sdrh   sqlite3 *db = pParse->db;
985b7916a78Sdrh   const char *z;
986f326d66dSdrh   ynVar x;
98717435752Sdrh 
988fa6bc000Sdrh   if( pExpr==0 ) return;
989c5cd1249Sdrh   assert( !ExprHasProperty(pExpr, EP_IntValue|EP_Reduced|EP_TokenOnly) );
99033e619fcSdrh   z = pExpr->u.zToken;
991b7916a78Sdrh   assert( z!=0 );
992b7916a78Sdrh   assert( z[0]!=0 );
993b1ed717fSmistachkin   assert( n==(u32)sqlite3Strlen30(z) );
994b7916a78Sdrh   if( z[1]==0 ){
995fa6bc000Sdrh     /* Wildcard of the form "?".  Assign the next variable number */
996b7916a78Sdrh     assert( z[0]=='?' );
997f326d66dSdrh     x = (ynVar)(++pParse->nVar);
998124c0b49Sdrh   }else{
999f326d66dSdrh     int doAdd = 0;
1000124c0b49Sdrh     if( z[0]=='?' ){
1001fa6bc000Sdrh       /* Wildcard of the form "?nnn".  Convert "nnn" to an integer and
1002fa6bc000Sdrh       ** use it as the variable number */
1003c8d735aeSdan       i64 i;
100418814dfbSdrh       int bOk;
100518814dfbSdrh       if( n==2 ){ /*OPTIMIZATION-IF-TRUE*/
100618814dfbSdrh         i = z[1]-'0';  /* The common case of ?N for a single digit N */
100718814dfbSdrh         bOk = 1;
100818814dfbSdrh       }else{
100918814dfbSdrh         bOk = 0==sqlite3Atoi64(&z[1], &i, n-1, SQLITE_UTF8);
101018814dfbSdrh       }
1011c5499befSdrh       testcase( i==0 );
1012c5499befSdrh       testcase( i==1 );
1013c5499befSdrh       testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]-1 );
1014c5499befSdrh       testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] );
1015c8d735aeSdan       if( bOk==0 || i<1 || i>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
1016fa6bc000Sdrh         sqlite3ErrorMsg(pParse, "variable number must be between ?1 and ?%d",
1017bb4957f8Sdrh             db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]);
1018c9b39288Sdrh         return;
1019fa6bc000Sdrh       }
10208e74e7baSdrh       x = (ynVar)i;
1021f326d66dSdrh       if( x>pParse->nVar ){
1022f326d66dSdrh         pParse->nVar = (int)x;
1023f326d66dSdrh         doAdd = 1;
1024f326d66dSdrh       }else if( sqlite3VListNumToName(pParse->pVList, x)==0 ){
1025f326d66dSdrh         doAdd = 1;
1026fa6bc000Sdrh       }
1027fa6bc000Sdrh     }else{
102851f49f17Sdrh       /* Wildcards like ":aaa", "$aaa" or "@aaa".  Reuse the same variable
1029fa6bc000Sdrh       ** number as the prior appearance of the same name, or if the name
1030fa6bc000Sdrh       ** has never appeared before, reuse the same variable number
1031fa6bc000Sdrh       */
10329bf755ccSdrh       x = (ynVar)sqlite3VListNameToNum(pParse->pVList, z, n);
10339bf755ccSdrh       if( x==0 ){
10349bf755ccSdrh         x = (ynVar)(++pParse->nVar);
1035f326d66dSdrh         doAdd = 1;
1036f326d66dSdrh       }
1037f326d66dSdrh     }
1038f326d66dSdrh     if( doAdd ){
10399bf755ccSdrh       pParse->pVList = sqlite3VListAdd(db, pParse->pVList, z, n, x);
1040fa6bc000Sdrh     }
1041fa6bc000Sdrh   }
1042c9b39288Sdrh   pExpr->iColumn = x;
1043f326d66dSdrh   if( x>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
1044832b2664Sdanielk1977     sqlite3ErrorMsg(pParse, "too many SQL variables");
1045832b2664Sdanielk1977   }
1046fa6bc000Sdrh }
1047fa6bc000Sdrh 
1048fa6bc000Sdrh /*
1049f6963f99Sdan ** Recursively delete an expression tree.
1050a2e00042Sdrh */
10514f0010b1Sdrh static SQLITE_NOINLINE void sqlite3ExprDeleteNN(sqlite3 *db, Expr *p){
10524f0010b1Sdrh   assert( p!=0 );
1053d50ffc41Sdrh   /* Sanity check: Assert that the IntValue is non-negative if it exists */
1054d50ffc41Sdrh   assert( !ExprHasProperty(p, EP_IntValue) || p->u.iValue>=0 );
1055eda079cdSdrh 
1056eda079cdSdrh   assert( !ExprHasProperty(p, EP_WinFunc) || p->y.pWin!=0 || db->mallocFailed );
1057eda079cdSdrh   assert( p->op!=TK_FUNCTION || ExprHasProperty(p, EP_TokenOnly|EP_Reduced)
1058eda079cdSdrh           || p->y.pWin==0 || ExprHasProperty(p, EP_WinFunc) );
1059209bc522Sdrh #ifdef SQLITE_DEBUG
1060209bc522Sdrh   if( ExprHasProperty(p, EP_Leaf) && !ExprHasProperty(p, EP_TokenOnly) ){
1061209bc522Sdrh     assert( p->pLeft==0 );
1062209bc522Sdrh     assert( p->pRight==0 );
1063209bc522Sdrh     assert( p->x.pSelect==0 );
1064209bc522Sdrh   }
1065209bc522Sdrh #endif
1066209bc522Sdrh   if( !ExprHasProperty(p, (EP_TokenOnly|EP_Leaf)) ){
1067c5cd1249Sdrh     /* The Expr.x union is never used at the same time as Expr.pRight */
1068c5cd1249Sdrh     assert( p->x.pList==0 || p->pRight==0 );
10694910a76dSdrh     if( p->pLeft && p->op!=TK_SELECT_COLUMN ) sqlite3ExprDeleteNN(db, p->pLeft);
1070d1086679Sdrh     if( p->pRight ){
1071d1086679Sdrh       sqlite3ExprDeleteNN(db, p->pRight);
1072d1086679Sdrh     }else if( ExprHasProperty(p, EP_xIsSelect) ){
10736ab3a2ecSdanielk1977       sqlite3SelectDelete(db, p->x.pSelect);
10746ab3a2ecSdanielk1977     }else{
10756ab3a2ecSdanielk1977       sqlite3ExprListDelete(db, p->x.pList);
10766ab3a2ecSdanielk1977     }
1077eda079cdSdrh     if( ExprHasProperty(p, EP_WinFunc) ){
1078eda079cdSdrh       assert( p->op==TK_FUNCTION );
1079eda079cdSdrh       sqlite3WindowDelete(db, p->y.pWin);
108086fb6e17Sdan     }
10816ab3a2ecSdanielk1977   }
1082209bc522Sdrh   if( ExprHasProperty(p, EP_MemToken) ) sqlite3DbFree(db, p->u.zToken);
108333e619fcSdrh   if( !ExprHasProperty(p, EP_Static) ){
1084dbd6a7dcSdrh     sqlite3DbFreeNN(db, p);
1085a2e00042Sdrh   }
108633e619fcSdrh }
10874f0010b1Sdrh void sqlite3ExprDelete(sqlite3 *db, Expr *p){
10884f0010b1Sdrh   if( p ) sqlite3ExprDeleteNN(db, p);
10894f0010b1Sdrh }
1090a2e00042Sdrh 
1091d2687b77Sdrh /*
10926ab3a2ecSdanielk1977 ** Return the number of bytes allocated for the expression structure
10936ab3a2ecSdanielk1977 ** passed as the first argument. This is always one of EXPR_FULLSIZE,
10946ab3a2ecSdanielk1977 ** EXPR_REDUCEDSIZE or EXPR_TOKENONLYSIZE.
10956ab3a2ecSdanielk1977 */
10966ab3a2ecSdanielk1977 static int exprStructSize(Expr *p){
10976ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_TokenOnly) ) return EXPR_TOKENONLYSIZE;
10986ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_Reduced) ) return EXPR_REDUCEDSIZE;
10996ab3a2ecSdanielk1977   return EXPR_FULLSIZE;
11006ab3a2ecSdanielk1977 }
11016ab3a2ecSdanielk1977 
11026ab3a2ecSdanielk1977 /*
1103a8e05761Sdrh ** Copy the complete content of an Expr node, taking care not to read
1104a8e05761Sdrh ** past the end of the structure for a reduced-size version of the source
1105a8e05761Sdrh ** Expr.
1106a8e05761Sdrh */
1107a8e05761Sdrh static void exprNodeCopy(Expr *pDest, Expr *pSrc){
1108a8e05761Sdrh   memset(pDest, 0, sizeof(Expr));
1109a8e05761Sdrh   memcpy(pDest, pSrc, exprStructSize(pSrc));
1110a8e05761Sdrh }
1111a8e05761Sdrh 
1112a8e05761Sdrh /*
111333e619fcSdrh ** The dupedExpr*Size() routines each return the number of bytes required
111433e619fcSdrh ** to store a copy of an expression or expression tree.  They differ in
111533e619fcSdrh ** how much of the tree is measured.
111633e619fcSdrh **
111733e619fcSdrh **     dupedExprStructSize()     Size of only the Expr structure
111833e619fcSdrh **     dupedExprNodeSize()       Size of Expr + space for token
111933e619fcSdrh **     dupedExprSize()           Expr + token + subtree components
112033e619fcSdrh **
112133e619fcSdrh ***************************************************************************
112233e619fcSdrh **
112333e619fcSdrh ** The dupedExprStructSize() function returns two values OR-ed together:
112433e619fcSdrh ** (1) the space required for a copy of the Expr structure only and
112533e619fcSdrh ** (2) the EP_xxx flags that indicate what the structure size should be.
112633e619fcSdrh ** The return values is always one of:
112733e619fcSdrh **
112833e619fcSdrh **      EXPR_FULLSIZE
112933e619fcSdrh **      EXPR_REDUCEDSIZE   | EP_Reduced
113033e619fcSdrh **      EXPR_TOKENONLYSIZE | EP_TokenOnly
113133e619fcSdrh **
113233e619fcSdrh ** The size of the structure can be found by masking the return value
113333e619fcSdrh ** of this routine with 0xfff.  The flags can be found by masking the
113433e619fcSdrh ** return value with EP_Reduced|EP_TokenOnly.
113533e619fcSdrh **
113633e619fcSdrh ** Note that with flags==EXPRDUP_REDUCE, this routines works on full-size
113733e619fcSdrh ** (unreduced) Expr objects as they or originally constructed by the parser.
113833e619fcSdrh ** During expression analysis, extra information is computed and moved into
1139c95f38d4Sdan ** later parts of the Expr object and that extra information might get chopped
114033e619fcSdrh ** off if the expression is reduced.  Note also that it does not work to
114160ec914cSpeter.d.reid ** make an EXPRDUP_REDUCE copy of a reduced expression.  It is only legal
114233e619fcSdrh ** to reduce a pristine expression tree from the parser.  The implementation
114333e619fcSdrh ** of dupedExprStructSize() contain multiple assert() statements that attempt
114433e619fcSdrh ** to enforce this constraint.
11456ab3a2ecSdanielk1977 */
11466ab3a2ecSdanielk1977 static int dupedExprStructSize(Expr *p, int flags){
11476ab3a2ecSdanielk1977   int nSize;
114833e619fcSdrh   assert( flags==EXPRDUP_REDUCE || flags==0 ); /* Only one flag value allowed */
1149aecd8021Sdrh   assert( EXPR_FULLSIZE<=0xfff );
1150aecd8021Sdrh   assert( (0xfff & (EP_Reduced|EP_TokenOnly))==0 );
115167a9b8edSdan   if( 0==flags || p->op==TK_SELECT_COLUMN
115267a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
1153eda079cdSdrh    || ExprHasProperty(p, EP_WinFunc)
115467a9b8edSdan #endif
115567a9b8edSdan   ){
11566ab3a2ecSdanielk1977     nSize = EXPR_FULLSIZE;
11576ab3a2ecSdanielk1977   }else{
1158c5cd1249Sdrh     assert( !ExprHasProperty(p, EP_TokenOnly|EP_Reduced) );
115933e619fcSdrh     assert( !ExprHasProperty(p, EP_FromJoin) );
1160c5cd1249Sdrh     assert( !ExprHasProperty(p, EP_MemToken) );
1161ebb6a65dSdrh     assert( !ExprHasProperty(p, EP_NoReduce) );
1162aecd8021Sdrh     if( p->pLeft || p->x.pList ){
116333e619fcSdrh       nSize = EXPR_REDUCEDSIZE | EP_Reduced;
116433e619fcSdrh     }else{
1165aecd8021Sdrh       assert( p->pRight==0 );
116633e619fcSdrh       nSize = EXPR_TOKENONLYSIZE | EP_TokenOnly;
116733e619fcSdrh     }
11686ab3a2ecSdanielk1977   }
11696ab3a2ecSdanielk1977   return nSize;
11706ab3a2ecSdanielk1977 }
11716ab3a2ecSdanielk1977 
11726ab3a2ecSdanielk1977 /*
117333e619fcSdrh ** This function returns the space in bytes required to store the copy
117433e619fcSdrh ** of the Expr structure and a copy of the Expr.u.zToken string (if that
117533e619fcSdrh ** string is defined.)
11766ab3a2ecSdanielk1977 */
11776ab3a2ecSdanielk1977 static int dupedExprNodeSize(Expr *p, int flags){
117833e619fcSdrh   int nByte = dupedExprStructSize(p, flags) & 0xfff;
117933e619fcSdrh   if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
11807301e774Sdrh     nByte += sqlite3Strlen30NN(p->u.zToken)+1;
11816ab3a2ecSdanielk1977   }
1182bc73971dSdanielk1977   return ROUND8(nByte);
11836ab3a2ecSdanielk1977 }
11846ab3a2ecSdanielk1977 
11856ab3a2ecSdanielk1977 /*
11866ab3a2ecSdanielk1977 ** Return the number of bytes required to create a duplicate of the
11876ab3a2ecSdanielk1977 ** expression passed as the first argument. The second argument is a
11886ab3a2ecSdanielk1977 ** mask containing EXPRDUP_XXX flags.
11896ab3a2ecSdanielk1977 **
11906ab3a2ecSdanielk1977 ** The value returned includes space to create a copy of the Expr struct
119133e619fcSdrh ** itself and the buffer referred to by Expr.u.zToken, if any.
11926ab3a2ecSdanielk1977 **
11936ab3a2ecSdanielk1977 ** If the EXPRDUP_REDUCE flag is set, then the return value includes
11946ab3a2ecSdanielk1977 ** space to duplicate all Expr nodes in the tree formed by Expr.pLeft
11956ab3a2ecSdanielk1977 ** and Expr.pRight variables (but not for any structures pointed to or
11966ab3a2ecSdanielk1977 ** descended from the Expr.x.pList or Expr.x.pSelect variables).
11976ab3a2ecSdanielk1977 */
11986ab3a2ecSdanielk1977 static int dupedExprSize(Expr *p, int flags){
11996ab3a2ecSdanielk1977   int nByte = 0;
12006ab3a2ecSdanielk1977   if( p ){
12016ab3a2ecSdanielk1977     nByte = dupedExprNodeSize(p, flags);
12026ab3a2ecSdanielk1977     if( flags&EXPRDUP_REDUCE ){
1203b7916a78Sdrh       nByte += dupedExprSize(p->pLeft, flags) + dupedExprSize(p->pRight, flags);
12046ab3a2ecSdanielk1977     }
12056ab3a2ecSdanielk1977   }
12066ab3a2ecSdanielk1977   return nByte;
12076ab3a2ecSdanielk1977 }
12086ab3a2ecSdanielk1977 
12096ab3a2ecSdanielk1977 /*
12106ab3a2ecSdanielk1977 ** This function is similar to sqlite3ExprDup(), except that if pzBuffer
12116ab3a2ecSdanielk1977 ** is not NULL then *pzBuffer is assumed to point to a buffer large enough
121233e619fcSdrh ** to store the copy of expression p, the copies of p->u.zToken
12136ab3a2ecSdanielk1977 ** (if applicable), and the copies of the p->pLeft and p->pRight expressions,
121460ec914cSpeter.d.reid ** if any. Before returning, *pzBuffer is set to the first byte past the
12156ab3a2ecSdanielk1977 ** portion of the buffer copied into by this function.
12166ab3a2ecSdanielk1977 */
12173c19469cSdrh static Expr *exprDup(sqlite3 *db, Expr *p, int dupFlags, u8 **pzBuffer){
12183c19469cSdrh   Expr *pNew;           /* Value to return */
12193c19469cSdrh   u8 *zAlloc;           /* Memory space from which to build Expr object */
12203c19469cSdrh   u32 staticFlag;       /* EP_Static if space not obtained from malloc */
12216ab3a2ecSdanielk1977 
12223c19469cSdrh   assert( db!=0 );
12233c19469cSdrh   assert( p );
12243c19469cSdrh   assert( dupFlags==0 || dupFlags==EXPRDUP_REDUCE );
12253c19469cSdrh   assert( pzBuffer==0 || dupFlags==EXPRDUP_REDUCE );
12266ab3a2ecSdanielk1977 
12276ab3a2ecSdanielk1977   /* Figure out where to write the new Expr structure. */
12286ab3a2ecSdanielk1977   if( pzBuffer ){
12296ab3a2ecSdanielk1977     zAlloc = *pzBuffer;
123033e619fcSdrh     staticFlag = EP_Static;
12316ab3a2ecSdanielk1977   }else{
12323c19469cSdrh     zAlloc = sqlite3DbMallocRawNN(db, dupedExprSize(p, dupFlags));
12333c19469cSdrh     staticFlag = 0;
12346ab3a2ecSdanielk1977   }
12356ab3a2ecSdanielk1977   pNew = (Expr *)zAlloc;
12366ab3a2ecSdanielk1977 
12376ab3a2ecSdanielk1977   if( pNew ){
12386ab3a2ecSdanielk1977     /* Set nNewSize to the size allocated for the structure pointed to
12396ab3a2ecSdanielk1977     ** by pNew. This is either EXPR_FULLSIZE, EXPR_REDUCEDSIZE or
12406ab3a2ecSdanielk1977     ** EXPR_TOKENONLYSIZE. nToken is set to the number of bytes consumed
124133e619fcSdrh     ** by the copy of the p->u.zToken string (if any).
12426ab3a2ecSdanielk1977     */
12433c19469cSdrh     const unsigned nStructSize = dupedExprStructSize(p, dupFlags);
124433e619fcSdrh     const int nNewSize = nStructSize & 0xfff;
124533e619fcSdrh     int nToken;
124633e619fcSdrh     if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
124733e619fcSdrh       nToken = sqlite3Strlen30(p->u.zToken) + 1;
124833e619fcSdrh     }else{
124933e619fcSdrh       nToken = 0;
125033e619fcSdrh     }
12513c19469cSdrh     if( dupFlags ){
12526ab3a2ecSdanielk1977       assert( ExprHasProperty(p, EP_Reduced)==0 );
12536ab3a2ecSdanielk1977       memcpy(zAlloc, p, nNewSize);
12546ab3a2ecSdanielk1977     }else{
12553e6a1411Sdan       u32 nSize = (u32)exprStructSize(p);
12566ab3a2ecSdanielk1977       memcpy(zAlloc, p, nSize);
125772ea29d7Sdrh       if( nSize<EXPR_FULLSIZE ){
12586ab3a2ecSdanielk1977         memset(&zAlloc[nSize], 0, EXPR_FULLSIZE-nSize);
12596ab3a2ecSdanielk1977       }
126072ea29d7Sdrh     }
12616ab3a2ecSdanielk1977 
126233e619fcSdrh     /* Set the EP_Reduced, EP_TokenOnly, and EP_Static flags appropriately. */
1263c5cd1249Sdrh     pNew->flags &= ~(EP_Reduced|EP_TokenOnly|EP_Static|EP_MemToken);
126433e619fcSdrh     pNew->flags |= nStructSize & (EP_Reduced|EP_TokenOnly);
126533e619fcSdrh     pNew->flags |= staticFlag;
12666ab3a2ecSdanielk1977 
126733e619fcSdrh     /* Copy the p->u.zToken string, if any. */
12686ab3a2ecSdanielk1977     if( nToken ){
126933e619fcSdrh       char *zToken = pNew->u.zToken = (char*)&zAlloc[nNewSize];
127033e619fcSdrh       memcpy(zToken, p->u.zToken, nToken);
12716ab3a2ecSdanielk1977     }
12726ab3a2ecSdanielk1977 
1273209bc522Sdrh     if( 0==((p->flags|pNew->flags) & (EP_TokenOnly|EP_Leaf)) ){
12746ab3a2ecSdanielk1977       /* Fill in the pNew->x.pSelect or pNew->x.pList member. */
12756ab3a2ecSdanielk1977       if( ExprHasProperty(p, EP_xIsSelect) ){
12763c19469cSdrh         pNew->x.pSelect = sqlite3SelectDup(db, p->x.pSelect, dupFlags);
12776ab3a2ecSdanielk1977       }else{
12783c19469cSdrh         pNew->x.pList = sqlite3ExprListDup(db, p->x.pList, dupFlags);
12796ab3a2ecSdanielk1977       }
12806ab3a2ecSdanielk1977     }
12816ab3a2ecSdanielk1977 
12826ab3a2ecSdanielk1977     /* Fill in pNew->pLeft and pNew->pRight. */
128353988068Sdrh     if( ExprHasProperty(pNew, EP_Reduced|EP_TokenOnly|EP_WinFunc) ){
12843c19469cSdrh       zAlloc += dupedExprNodeSize(p, dupFlags);
1285209bc522Sdrh       if( !ExprHasProperty(pNew, EP_TokenOnly|EP_Leaf) ){
12863c19469cSdrh         pNew->pLeft = p->pLeft ?
12873c19469cSdrh                       exprDup(db, p->pLeft, EXPRDUP_REDUCE, &zAlloc) : 0;
12883c19469cSdrh         pNew->pRight = p->pRight ?
12893c19469cSdrh                        exprDup(db, p->pRight, EXPRDUP_REDUCE, &zAlloc) : 0;
12906ab3a2ecSdanielk1977       }
129167a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
1292eda079cdSdrh       if( ExprHasProperty(p, EP_WinFunc) ){
1293eda079cdSdrh         pNew->y.pWin = sqlite3WindowDup(db, pNew, p->y.pWin);
1294eda079cdSdrh         assert( ExprHasProperty(pNew, EP_WinFunc) );
1295e2f781b9Sdan       }
129667a9b8edSdan #endif /* SQLITE_OMIT_WINDOWFUNC */
129753988068Sdrh       if( pzBuffer ){
129853988068Sdrh         *pzBuffer = zAlloc;
129953988068Sdrh       }
130053988068Sdrh     }else{
1301209bc522Sdrh       if( !ExprHasProperty(p, EP_TokenOnly|EP_Leaf) ){
13029854260bSdrh         if( pNew->op==TK_SELECT_COLUMN ){
13039854260bSdrh           pNew->pLeft = p->pLeft;
130447073f62Sdrh           assert( p->iColumn==0 || p->pRight==0 );
130547073f62Sdrh           assert( p->pRight==0  || p->pRight==p->pLeft );
13069854260bSdrh         }else{
13076ab3a2ecSdanielk1977           pNew->pLeft = sqlite3ExprDup(db, p->pLeft, 0);
13089854260bSdrh         }
13096ab3a2ecSdanielk1977         pNew->pRight = sqlite3ExprDup(db, p->pRight, 0);
13106ab3a2ecSdanielk1977       }
13116ab3a2ecSdanielk1977     }
13126ab3a2ecSdanielk1977   }
13136ab3a2ecSdanielk1977   return pNew;
13146ab3a2ecSdanielk1977 }
13156ab3a2ecSdanielk1977 
13166ab3a2ecSdanielk1977 /*
1317bfe31e7fSdan ** Create and return a deep copy of the object passed as the second
1318bfe31e7fSdan ** argument. If an OOM condition is encountered, NULL is returned
1319bfe31e7fSdan ** and the db->mallocFailed flag set.
1320bfe31e7fSdan */
1321eede6a53Sdan #ifndef SQLITE_OMIT_CTE
1322bfe31e7fSdan static With *withDup(sqlite3 *db, With *p){
13234e9119d9Sdan   With *pRet = 0;
13244e9119d9Sdan   if( p ){
13254e9119d9Sdan     int nByte = sizeof(*p) + sizeof(p->a[0]) * (p->nCte-1);
13264e9119d9Sdan     pRet = sqlite3DbMallocZero(db, nByte);
13274e9119d9Sdan     if( pRet ){
13284e9119d9Sdan       int i;
13294e9119d9Sdan       pRet->nCte = p->nCte;
13304e9119d9Sdan       for(i=0; i<p->nCte; i++){
13314e9119d9Sdan         pRet->a[i].pSelect = sqlite3SelectDup(db, p->a[i].pSelect, 0);
13324e9119d9Sdan         pRet->a[i].pCols = sqlite3ExprListDup(db, p->a[i].pCols, 0);
13334e9119d9Sdan         pRet->a[i].zName = sqlite3DbStrDup(db, p->a[i].zName);
13344e9119d9Sdan       }
13354e9119d9Sdan     }
13364e9119d9Sdan   }
13374e9119d9Sdan   return pRet;
13384e9119d9Sdan }
1339eede6a53Sdan #else
1340eede6a53Sdan # define withDup(x,y) 0
1341eede6a53Sdan #endif
13424e9119d9Sdan 
1343a8389975Sdrh #ifndef SQLITE_OMIT_WINDOWFUNC
1344a8389975Sdrh /*
1345a8389975Sdrh ** The gatherSelectWindows() procedure and its helper routine
1346a8389975Sdrh ** gatherSelectWindowsCallback() are used to scan all the expressions
1347a8389975Sdrh ** an a newly duplicated SELECT statement and gather all of the Window
1348a8389975Sdrh ** objects found there, assembling them onto the linked list at Select->pWin.
1349a8389975Sdrh */
1350a8389975Sdrh static int gatherSelectWindowsCallback(Walker *pWalker, Expr *pExpr){
1351a8389975Sdrh   if( pExpr->op==TK_FUNCTION && pExpr->y.pWin!=0 ){
1352a8389975Sdrh     assert( ExprHasProperty(pExpr, EP_WinFunc) );
1353a8389975Sdrh     pExpr->y.pWin->pNextWin = pWalker->u.pSelect->pWin;
1354a8389975Sdrh     pWalker->u.pSelect->pWin = pExpr->y.pWin;
1355a8389975Sdrh   }
1356a8389975Sdrh   return WRC_Continue;
1357a8389975Sdrh }
1358a37b6a5eSdrh static int gatherSelectWindowsSelectCallback(Walker *pWalker, Select *p){
1359a37b6a5eSdrh   return p==pWalker->u.pSelect ? WRC_Continue : WRC_Prune;
1360a37b6a5eSdrh }
1361a8389975Sdrh static void gatherSelectWindows(Select *p){
1362a8389975Sdrh   Walker w;
1363a8389975Sdrh   w.xExprCallback = gatherSelectWindowsCallback;
1364a37b6a5eSdrh   w.xSelectCallback = gatherSelectWindowsSelectCallback;
1365a37b6a5eSdrh   w.xSelectCallback2 = 0;
1366a8389975Sdrh   w.u.pSelect = p;
1367a37b6a5eSdrh   sqlite3WalkSelect(&w, p);
1368a8389975Sdrh }
1369a8389975Sdrh #endif
1370a8389975Sdrh 
1371a8389975Sdrh 
1372a76b5dfcSdrh /*
1373ff78bd2fSdrh ** The following group of routines make deep copies of expressions,
1374ff78bd2fSdrh ** expression lists, ID lists, and select statements.  The copies can
1375ff78bd2fSdrh ** be deleted (by being passed to their respective ...Delete() routines)
1376ff78bd2fSdrh ** without effecting the originals.
1377ff78bd2fSdrh **
13784adee20fSdanielk1977 ** The expression list, ID, and source lists return by sqlite3ExprListDup(),
13794adee20fSdanielk1977 ** sqlite3IdListDup(), and sqlite3SrcListDup() can not be further expanded
1380ad3cab52Sdrh ** by subsequent calls to sqlite*ListAppend() routines.
1381ff78bd2fSdrh **
1382ad3cab52Sdrh ** Any tables that the SrcList might point to are not duplicated.
13836ab3a2ecSdanielk1977 **
1384b7916a78Sdrh ** The flags parameter contains a combination of the EXPRDUP_XXX flags.
13856ab3a2ecSdanielk1977 ** If the EXPRDUP_REDUCE flag is set, then the structure returned is a
13866ab3a2ecSdanielk1977 ** truncated version of the usual Expr structure that will be stored as
13876ab3a2ecSdanielk1977 ** part of the in-memory representation of the database schema.
1388ff78bd2fSdrh */
13896ab3a2ecSdanielk1977 Expr *sqlite3ExprDup(sqlite3 *db, Expr *p, int flags){
139072ea29d7Sdrh   assert( flags==0 || flags==EXPRDUP_REDUCE );
13913c19469cSdrh   return p ? exprDup(db, p, flags, 0) : 0;
1392ff78bd2fSdrh }
13936ab3a2ecSdanielk1977 ExprList *sqlite3ExprListDup(sqlite3 *db, ExprList *p, int flags){
1394ff78bd2fSdrh   ExprList *pNew;
1395145716b3Sdrh   struct ExprList_item *pItem, *pOldItem;
1396ff78bd2fSdrh   int i;
1397b163748eSdrh   Expr *pPriorSelectCol = 0;
1398575fad65Sdrh   assert( db!=0 );
1399ff78bd2fSdrh   if( p==0 ) return 0;
140097258194Sdrh   pNew = sqlite3DbMallocRawNN(db, sqlite3DbMallocSize(db, p));
1401ff78bd2fSdrh   if( pNew==0 ) return 0;
1402a19543feSdrh   pNew->nExpr = p->nExpr;
140343606175Sdrh   pItem = pNew->a;
1404145716b3Sdrh   pOldItem = p->a;
1405145716b3Sdrh   for(i=0; i<p->nExpr; i++, pItem++, pOldItem++){
14066ab3a2ecSdanielk1977     Expr *pOldExpr = pOldItem->pExpr;
140747073f62Sdrh     Expr *pNewExpr;
1408b5526ea6Sdrh     pItem->pExpr = sqlite3ExprDup(db, pOldExpr, flags);
140947073f62Sdrh     if( pOldExpr
141047073f62Sdrh      && pOldExpr->op==TK_SELECT_COLUMN
141147073f62Sdrh      && (pNewExpr = pItem->pExpr)!=0
141247073f62Sdrh     ){
141347073f62Sdrh       assert( pNewExpr->iColumn==0 || i>0 );
141447073f62Sdrh       if( pNewExpr->iColumn==0 ){
141547073f62Sdrh         assert( pOldExpr->pLeft==pOldExpr->pRight );
1416b163748eSdrh         pPriorSelectCol = pNewExpr->pLeft = pNewExpr->pRight;
1417b163748eSdrh       }else{
1418b163748eSdrh         assert( i>0 );
1419b163748eSdrh         assert( pItem[-1].pExpr!=0 );
1420b163748eSdrh         assert( pNewExpr->iColumn==pItem[-1].pExpr->iColumn+1 );
1421b163748eSdrh         assert( pPriorSelectCol==pItem[-1].pExpr->pLeft );
1422b163748eSdrh         pNewExpr->pLeft = pPriorSelectCol;
142347073f62Sdrh       }
142447073f62Sdrh     }
142517435752Sdrh     pItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
1426b7916a78Sdrh     pItem->zSpan = sqlite3DbStrDup(db, pOldItem->zSpan);
1427145716b3Sdrh     pItem->sortOrder = pOldItem->sortOrder;
14283e7bc9caSdrh     pItem->done = 0;
14292c036cffSdrh     pItem->bSpanIsTab = pOldItem->bSpanIsTab;
143024e25d32Sdan     pItem->bSorterRef = pOldItem->bSorterRef;
1431c2acc4e4Sdrh     pItem->u = pOldItem->u;
1432ff78bd2fSdrh   }
1433ff78bd2fSdrh   return pNew;
1434ff78bd2fSdrh }
143593758c8dSdanielk1977 
143693758c8dSdanielk1977 /*
143793758c8dSdanielk1977 ** If cursors, triggers, views and subqueries are all omitted from
143893758c8dSdanielk1977 ** the build, then none of the following routines, except for
143993758c8dSdanielk1977 ** sqlite3SelectDup(), can be called. sqlite3SelectDup() is sometimes
144093758c8dSdanielk1977 ** called with a NULL argument.
144193758c8dSdanielk1977 */
14426a67fe8eSdanielk1977 #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_TRIGGER) \
14436a67fe8eSdanielk1977  || !defined(SQLITE_OMIT_SUBQUERY)
14446ab3a2ecSdanielk1977 SrcList *sqlite3SrcListDup(sqlite3 *db, SrcList *p, int flags){
1445ad3cab52Sdrh   SrcList *pNew;
1446ad3cab52Sdrh   int i;
1447113088ecSdrh   int nByte;
1448575fad65Sdrh   assert( db!=0 );
1449ad3cab52Sdrh   if( p==0 ) return 0;
1450113088ecSdrh   nByte = sizeof(*p) + (p->nSrc>0 ? sizeof(p->a[0]) * (p->nSrc-1) : 0);
1451575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, nByte );
1452ad3cab52Sdrh   if( pNew==0 ) return 0;
14534305d103Sdrh   pNew->nSrc = pNew->nAlloc = p->nSrc;
1454ad3cab52Sdrh   for(i=0; i<p->nSrc; i++){
14554efc4754Sdrh     struct SrcList_item *pNewItem = &pNew->a[i];
14564efc4754Sdrh     struct SrcList_item *pOldItem = &p->a[i];
1457ed8a3bb1Sdrh     Table *pTab;
145841fb5cd1Sdan     pNewItem->pSchema = pOldItem->pSchema;
145917435752Sdrh     pNewItem->zDatabase = sqlite3DbStrDup(db, pOldItem->zDatabase);
146017435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
146117435752Sdrh     pNewItem->zAlias = sqlite3DbStrDup(db, pOldItem->zAlias);
14628a48b9c0Sdrh     pNewItem->fg = pOldItem->fg;
14634efc4754Sdrh     pNewItem->iCursor = pOldItem->iCursor;
14645b6a9ed4Sdrh     pNewItem->addrFillSub = pOldItem->addrFillSub;
14655b6a9ed4Sdrh     pNewItem->regReturn = pOldItem->regReturn;
14668a48b9c0Sdrh     if( pNewItem->fg.isIndexedBy ){
14678a48b9c0Sdrh       pNewItem->u1.zIndexedBy = sqlite3DbStrDup(db, pOldItem->u1.zIndexedBy);
14688a48b9c0Sdrh     }
14698a48b9c0Sdrh     pNewItem->pIBIndex = pOldItem->pIBIndex;
14708a48b9c0Sdrh     if( pNewItem->fg.isTabFunc ){
14718a48b9c0Sdrh       pNewItem->u1.pFuncArg =
14728a48b9c0Sdrh           sqlite3ExprListDup(db, pOldItem->u1.pFuncArg, flags);
14738a48b9c0Sdrh     }
1474ed8a3bb1Sdrh     pTab = pNewItem->pTab = pOldItem->pTab;
1475ed8a3bb1Sdrh     if( pTab ){
147679df7782Sdrh       pTab->nTabRef++;
1477a1cb183dSdanielk1977     }
14786ab3a2ecSdanielk1977     pNewItem->pSelect = sqlite3SelectDup(db, pOldItem->pSelect, flags);
14796ab3a2ecSdanielk1977     pNewItem->pOn = sqlite3ExprDup(db, pOldItem->pOn, flags);
148017435752Sdrh     pNewItem->pUsing = sqlite3IdListDup(db, pOldItem->pUsing);
14816c18b6e0Sdanielk1977     pNewItem->colUsed = pOldItem->colUsed;
1482ad3cab52Sdrh   }
1483ad3cab52Sdrh   return pNew;
1484ad3cab52Sdrh }
148517435752Sdrh IdList *sqlite3IdListDup(sqlite3 *db, IdList *p){
1486ff78bd2fSdrh   IdList *pNew;
1487ff78bd2fSdrh   int i;
1488575fad65Sdrh   assert( db!=0 );
1489ff78bd2fSdrh   if( p==0 ) return 0;
1490575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, sizeof(*pNew) );
1491ff78bd2fSdrh   if( pNew==0 ) return 0;
14926c535158Sdrh   pNew->nId = p->nId;
1493575fad65Sdrh   pNew->a = sqlite3DbMallocRawNN(db, p->nId*sizeof(p->a[0]) );
1494d5d56523Sdanielk1977   if( pNew->a==0 ){
1495dbd6a7dcSdrh     sqlite3DbFreeNN(db, pNew);
1496d5d56523Sdanielk1977     return 0;
1497d5d56523Sdanielk1977   }
14986c535158Sdrh   /* Note that because the size of the allocation for p->a[] is not
14996c535158Sdrh   ** necessarily a power of two, sqlite3IdListAppend() may not be called
15006c535158Sdrh   ** on the duplicate created by this function. */
1501ff78bd2fSdrh   for(i=0; i<p->nId; i++){
15024efc4754Sdrh     struct IdList_item *pNewItem = &pNew->a[i];
15034efc4754Sdrh     struct IdList_item *pOldItem = &p->a[i];
150417435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
15054efc4754Sdrh     pNewItem->idx = pOldItem->idx;
1506ff78bd2fSdrh   }
1507ff78bd2fSdrh   return pNew;
1508ff78bd2fSdrh }
1509a7466205Sdan Select *sqlite3SelectDup(sqlite3 *db, Select *pDup, int flags){
1510a7466205Sdan   Select *pRet = 0;
1511a7466205Sdan   Select *pNext = 0;
1512a7466205Sdan   Select **pp = &pRet;
1513a7466205Sdan   Select *p;
1514a7466205Sdan 
1515575fad65Sdrh   assert( db!=0 );
1516a7466205Sdan   for(p=pDup; p; p=p->pPrior){
1517a7466205Sdan     Select *pNew = sqlite3DbMallocRawNN(db, sizeof(*p) );
1518a7466205Sdan     if( pNew==0 ) break;
1519b7916a78Sdrh     pNew->pEList = sqlite3ExprListDup(db, p->pEList, flags);
15206ab3a2ecSdanielk1977     pNew->pSrc = sqlite3SrcListDup(db, p->pSrc, flags);
15216ab3a2ecSdanielk1977     pNew->pWhere = sqlite3ExprDup(db, p->pWhere, flags);
15226ab3a2ecSdanielk1977     pNew->pGroupBy = sqlite3ExprListDup(db, p->pGroupBy, flags);
15236ab3a2ecSdanielk1977     pNew->pHaving = sqlite3ExprDup(db, p->pHaving, flags);
15246ab3a2ecSdanielk1977     pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, flags);
1525ff78bd2fSdrh     pNew->op = p->op;
1526a7466205Sdan     pNew->pNext = pNext;
1527a7466205Sdan     pNew->pPrior = 0;
15286ab3a2ecSdanielk1977     pNew->pLimit = sqlite3ExprDup(db, p->pLimit, flags);
152992b01d53Sdrh     pNew->iLimit = 0;
153092b01d53Sdrh     pNew->iOffset = 0;
15317d10d5a6Sdrh     pNew->selFlags = p->selFlags & ~SF_UsesEphemeral;
1532b9bb7c18Sdrh     pNew->addrOpenEphm[0] = -1;
1533b9bb7c18Sdrh     pNew->addrOpenEphm[1] = -1;
1534ec2da854Sdrh     pNew->nSelectRow = p->nSelectRow;
15354e9119d9Sdan     pNew->pWith = withDup(db, p->pWith);
153667a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
15372e362f97Sdan     pNew->pWin = 0;
1538c95f38d4Sdan     pNew->pWinDefn = sqlite3WindowListDup(db, p->pWinDefn);
1539a8389975Sdrh     if( p->pWin ) gatherSelectWindows(pNew);
154067a9b8edSdan #endif
1541fef37760Sdrh     pNew->selId = p->selId;
1542a7466205Sdan     *pp = pNew;
1543a7466205Sdan     pp = &pNew->pPrior;
1544a7466205Sdan     pNext = pNew;
1545a7466205Sdan   }
1546a7466205Sdan 
1547a7466205Sdan   return pRet;
1548ff78bd2fSdrh }
154993758c8dSdanielk1977 #else
15506ab3a2ecSdanielk1977 Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
155193758c8dSdanielk1977   assert( p==0 );
155293758c8dSdanielk1977   return 0;
155393758c8dSdanielk1977 }
155493758c8dSdanielk1977 #endif
1555ff78bd2fSdrh 
1556ff78bd2fSdrh 
1557ff78bd2fSdrh /*
1558a76b5dfcSdrh ** Add a new element to the end of an expression list.  If pList is
1559a76b5dfcSdrh ** initially NULL, then create a new expression list.
1560b7916a78Sdrh **
1561a19543feSdrh ** The pList argument must be either NULL or a pointer to an ExprList
1562a19543feSdrh ** obtained from a prior call to sqlite3ExprListAppend().  This routine
1563a19543feSdrh ** may not be used with an ExprList obtained from sqlite3ExprListDup().
1564a19543feSdrh ** Reason:  This routine assumes that the number of slots in pList->a[]
1565a19543feSdrh ** is a power of two.  That is true for sqlite3ExprListAppend() returns
1566a19543feSdrh ** but is not necessarily true from the return value of sqlite3ExprListDup().
1567a19543feSdrh **
1568b7916a78Sdrh ** If a memory allocation error occurs, the entire list is freed and
1569b7916a78Sdrh ** NULL is returned.  If non-NULL is returned, then it is guaranteed
1570b7916a78Sdrh ** that the new entry was successfully appended.
1571a76b5dfcSdrh */
157217435752Sdrh ExprList *sqlite3ExprListAppend(
157317435752Sdrh   Parse *pParse,          /* Parsing context */
157417435752Sdrh   ExprList *pList,        /* List to which to append. Might be NULL */
1575b7916a78Sdrh   Expr *pExpr             /* Expression to be appended. Might be NULL */
157617435752Sdrh ){
157743606175Sdrh   struct ExprList_item *pItem;
157817435752Sdrh   sqlite3 *db = pParse->db;
1579575fad65Sdrh   assert( db!=0 );
1580a76b5dfcSdrh   if( pList==0 ){
1581575fad65Sdrh     pList = sqlite3DbMallocRawNN(db, sizeof(ExprList) );
1582a76b5dfcSdrh     if( pList==0 ){
1583d5d56523Sdanielk1977       goto no_mem;
1584a76b5dfcSdrh     }
1585c263f7c4Sdrh     pList->nExpr = 0;
1586a19543feSdrh   }else if( (pList->nExpr & (pList->nExpr-1))==0 ){
158743606175Sdrh     ExprList *pNew;
158843606175Sdrh     pNew = sqlite3DbRealloc(db, pList,
1589a19543feSdrh              sizeof(*pList)+(2*pList->nExpr - 1)*sizeof(pList->a[0]));
159043606175Sdrh     if( pNew==0 ){
1591d5d56523Sdanielk1977       goto no_mem;
1592a76b5dfcSdrh     }
159343606175Sdrh     pList = pNew;
1594a76b5dfcSdrh   }
159543606175Sdrh   pItem = &pList->a[pList->nExpr++];
1596a8b9793cSdrh   assert( offsetof(struct ExprList_item,zName)==sizeof(pItem->pExpr) );
1597a8b9793cSdrh   assert( offsetof(struct ExprList_item,pExpr)==0 );
1598a8b9793cSdrh   memset(&pItem->zName,0,sizeof(*pItem)-offsetof(struct ExprList_item,zName));
1599e94ddc9eSdanielk1977   pItem->pExpr = pExpr;
1600a76b5dfcSdrh   return pList;
1601d5d56523Sdanielk1977 
1602d5d56523Sdanielk1977 no_mem:
1603d5d56523Sdanielk1977   /* Avoid leaking memory if malloc has failed. */
1604633e6d57Sdrh   sqlite3ExprDelete(db, pExpr);
1605633e6d57Sdrh   sqlite3ExprListDelete(db, pList);
1606d5d56523Sdanielk1977   return 0;
1607a76b5dfcSdrh }
1608a76b5dfcSdrh 
1609a76b5dfcSdrh /*
16108762ec19Sdrh ** pColumns and pExpr form a vector assignment which is part of the SET
16118762ec19Sdrh ** clause of an UPDATE statement.  Like this:
1612a1251bc4Sdrh **
1613a1251bc4Sdrh **        (a,b,c) = (expr1,expr2,expr3)
1614a1251bc4Sdrh ** Or:    (a,b,c) = (SELECT x,y,z FROM ....)
1615a1251bc4Sdrh **
1616a1251bc4Sdrh ** For each term of the vector assignment, append new entries to the
1617b67343d0Sdrh ** expression list pList.  In the case of a subquery on the RHS, append
1618a1251bc4Sdrh ** TK_SELECT_COLUMN expressions.
1619a1251bc4Sdrh */
1620a1251bc4Sdrh ExprList *sqlite3ExprListAppendVector(
1621a1251bc4Sdrh   Parse *pParse,         /* Parsing context */
1622a1251bc4Sdrh   ExprList *pList,       /* List to which to append. Might be NULL */
1623a1251bc4Sdrh   IdList *pColumns,      /* List of names of LHS of the assignment */
1624a1251bc4Sdrh   Expr *pExpr            /* Vector expression to be appended. Might be NULL */
1625a1251bc4Sdrh ){
1626a1251bc4Sdrh   sqlite3 *db = pParse->db;
1627a1251bc4Sdrh   int n;
1628a1251bc4Sdrh   int i;
162966860af3Sdrh   int iFirst = pList ? pList->nExpr : 0;
1630321e828dSdrh   /* pColumns can only be NULL due to an OOM but an OOM will cause an
1631321e828dSdrh   ** exit prior to this routine being invoked */
1632321e828dSdrh   if( NEVER(pColumns==0) ) goto vector_append_error;
1633a1251bc4Sdrh   if( pExpr==0 ) goto vector_append_error;
1634966e2911Sdrh 
1635966e2911Sdrh   /* If the RHS is a vector, then we can immediately check to see that
1636966e2911Sdrh   ** the size of the RHS and LHS match.  But if the RHS is a SELECT,
1637966e2911Sdrh   ** wildcards ("*") in the result set of the SELECT must be expanded before
1638966e2911Sdrh   ** we can do the size check, so defer the size check until code generation.
1639966e2911Sdrh   */
1640966e2911Sdrh   if( pExpr->op!=TK_SELECT && pColumns->nId!=(n=sqlite3ExprVectorSize(pExpr)) ){
1641a1251bc4Sdrh     sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
1642a1251bc4Sdrh                     pColumns->nId, n);
1643a1251bc4Sdrh     goto vector_append_error;
1644a1251bc4Sdrh   }
1645966e2911Sdrh 
1646966e2911Sdrh   for(i=0; i<pColumns->nId; i++){
1647a1251bc4Sdrh     Expr *pSubExpr = sqlite3ExprForVectorField(pParse, pExpr, i);
1648a1251bc4Sdrh     pList = sqlite3ExprListAppend(pParse, pList, pSubExpr);
1649a1251bc4Sdrh     if( pList ){
165066860af3Sdrh       assert( pList->nExpr==iFirst+i+1 );
1651a1251bc4Sdrh       pList->a[pList->nExpr-1].zName = pColumns->a[i].zName;
1652a1251bc4Sdrh       pColumns->a[i].zName = 0;
1653a1251bc4Sdrh     }
1654a1251bc4Sdrh   }
1655966e2911Sdrh 
1656ffe28059Sdrh   if( !db->mallocFailed && pExpr->op==TK_SELECT && ALWAYS(pList!=0) ){
1657966e2911Sdrh     Expr *pFirst = pList->a[iFirst].pExpr;
1658f4dd26c5Sdrh     assert( pFirst!=0 );
1659966e2911Sdrh     assert( pFirst->op==TK_SELECT_COLUMN );
1660966e2911Sdrh 
1661966e2911Sdrh     /* Store the SELECT statement in pRight so it will be deleted when
1662966e2911Sdrh     ** sqlite3ExprListDelete() is called */
1663966e2911Sdrh     pFirst->pRight = pExpr;
1664a1251bc4Sdrh     pExpr = 0;
1665966e2911Sdrh 
1666966e2911Sdrh     /* Remember the size of the LHS in iTable so that we can check that
1667966e2911Sdrh     ** the RHS and LHS sizes match during code generation. */
1668966e2911Sdrh     pFirst->iTable = pColumns->nId;
1669a1251bc4Sdrh   }
1670a1251bc4Sdrh 
1671a1251bc4Sdrh vector_append_error:
1672dfb5c963Sdan   if( IN_RENAME_OBJECT ){
1673dfb5c963Sdan     sqlite3RenameExprUnmap(pParse, pExpr);
1674dfb5c963Sdan   }
1675a1251bc4Sdrh   sqlite3ExprDelete(db, pExpr);
1676a1251bc4Sdrh   sqlite3IdListDelete(db, pColumns);
1677a1251bc4Sdrh   return pList;
1678a1251bc4Sdrh }
1679a1251bc4Sdrh 
1680a1251bc4Sdrh /*
1681bc622bc0Sdrh ** Set the sort order for the last element on the given ExprList.
1682bc622bc0Sdrh */
1683bc622bc0Sdrh void sqlite3ExprListSetSortOrder(ExprList *p, int iSortOrder){
1684bc622bc0Sdrh   if( p==0 ) return;
1685bc622bc0Sdrh   assert( SQLITE_SO_UNDEFINED<0 && SQLITE_SO_ASC>=0 && SQLITE_SO_DESC>0 );
1686bc622bc0Sdrh   assert( p->nExpr>0 );
1687bc622bc0Sdrh   if( iSortOrder<0 ){
1688bc622bc0Sdrh     assert( p->a[p->nExpr-1].sortOrder==SQLITE_SO_ASC );
1689bc622bc0Sdrh     return;
1690bc622bc0Sdrh   }
1691bc622bc0Sdrh   p->a[p->nExpr-1].sortOrder = (u8)iSortOrder;
1692bc622bc0Sdrh }
1693bc622bc0Sdrh 
1694bc622bc0Sdrh /*
1695b7916a78Sdrh ** Set the ExprList.a[].zName element of the most recently added item
1696b7916a78Sdrh ** on the expression list.
1697b7916a78Sdrh **
1698b7916a78Sdrh ** pList might be NULL following an OOM error.  But pName should never be
1699b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1700b7916a78Sdrh ** is set.
1701b7916a78Sdrh */
1702b7916a78Sdrh void sqlite3ExprListSetName(
1703b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1704b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
1705b7916a78Sdrh   Token *pName,           /* Name to be added */
1706b7916a78Sdrh   int dequote             /* True to cause the name to be dequoted */
1707b7916a78Sdrh ){
1708b7916a78Sdrh   assert( pList!=0 || pParse->db->mallocFailed!=0 );
1709b7916a78Sdrh   if( pList ){
1710b7916a78Sdrh     struct ExprList_item *pItem;
1711b7916a78Sdrh     assert( pList->nExpr>0 );
1712b7916a78Sdrh     pItem = &pList->a[pList->nExpr-1];
1713b7916a78Sdrh     assert( pItem->zName==0 );
1714b7916a78Sdrh     pItem->zName = sqlite3DbStrNDup(pParse->db, pName->z, pName->n);
1715244b9d6eSdrh     if( dequote ) sqlite3Dequote(pItem->zName);
1716c9461eccSdan     if( IN_RENAME_OBJECT ){
171707e95233Sdan       sqlite3RenameTokenMap(pParse, (void*)pItem->zName, pName);
17185be60c55Sdan     }
1719b7916a78Sdrh   }
1720b7916a78Sdrh }
1721b7916a78Sdrh 
1722b7916a78Sdrh /*
1723b7916a78Sdrh ** Set the ExprList.a[].zSpan element of the most recently added item
1724b7916a78Sdrh ** on the expression list.
1725b7916a78Sdrh **
1726b7916a78Sdrh ** pList might be NULL following an OOM error.  But pSpan should never be
1727b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1728b7916a78Sdrh ** is set.
1729b7916a78Sdrh */
1730b7916a78Sdrh void sqlite3ExprListSetSpan(
1731b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1732b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
17331be266baSdrh   const char *zStart,     /* Start of the span */
17341be266baSdrh   const char *zEnd        /* End of the span */
1735b7916a78Sdrh ){
1736b7916a78Sdrh   sqlite3 *db = pParse->db;
1737b7916a78Sdrh   assert( pList!=0 || db->mallocFailed!=0 );
1738b7916a78Sdrh   if( pList ){
1739b7916a78Sdrh     struct ExprList_item *pItem = &pList->a[pList->nExpr-1];
1740b7916a78Sdrh     assert( pList->nExpr>0 );
1741b7916a78Sdrh     sqlite3DbFree(db, pItem->zSpan);
17429b2e0435Sdrh     pItem->zSpan = sqlite3DbSpanDup(db, zStart, zEnd);
1743b7916a78Sdrh   }
1744b7916a78Sdrh }
1745b7916a78Sdrh 
1746b7916a78Sdrh /*
17477a15a4beSdanielk1977 ** If the expression list pEList contains more than iLimit elements,
17487a15a4beSdanielk1977 ** leave an error message in pParse.
17497a15a4beSdanielk1977 */
17507a15a4beSdanielk1977 void sqlite3ExprListCheckLength(
17517a15a4beSdanielk1977   Parse *pParse,
17527a15a4beSdanielk1977   ExprList *pEList,
17537a15a4beSdanielk1977   const char *zObject
17547a15a4beSdanielk1977 ){
1755b1a6c3c1Sdrh   int mx = pParse->db->aLimit[SQLITE_LIMIT_COLUMN];
1756c5499befSdrh   testcase( pEList && pEList->nExpr==mx );
1757c5499befSdrh   testcase( pEList && pEList->nExpr==mx+1 );
1758b1a6c3c1Sdrh   if( pEList && pEList->nExpr>mx ){
17597a15a4beSdanielk1977     sqlite3ErrorMsg(pParse, "too many columns in %s", zObject);
17607a15a4beSdanielk1977   }
17617a15a4beSdanielk1977 }
17627a15a4beSdanielk1977 
17637a15a4beSdanielk1977 /*
1764a76b5dfcSdrh ** Delete an entire expression list.
1765a76b5dfcSdrh */
1766affa855cSdrh static SQLITE_NOINLINE void exprListDeleteNN(sqlite3 *db, ExprList *pList){
1767ac48b751Sdrh   int i = pList->nExpr;
1768ac48b751Sdrh   struct ExprList_item *pItem =  pList->a;
1769ac48b751Sdrh   assert( pList->nExpr>0 );
1770ac48b751Sdrh   do{
1771633e6d57Sdrh     sqlite3ExprDelete(db, pItem->pExpr);
1772633e6d57Sdrh     sqlite3DbFree(db, pItem->zName);
1773b7916a78Sdrh     sqlite3DbFree(db, pItem->zSpan);
1774ac48b751Sdrh     pItem++;
1775ac48b751Sdrh   }while( --i>0 );
1776dbd6a7dcSdrh   sqlite3DbFreeNN(db, pList);
1777a76b5dfcSdrh }
1778affa855cSdrh void sqlite3ExprListDelete(sqlite3 *db, ExprList *pList){
1779affa855cSdrh   if( pList ) exprListDeleteNN(db, pList);
1780affa855cSdrh }
1781a76b5dfcSdrh 
1782a76b5dfcSdrh /*
17832308ed38Sdrh ** Return the bitwise-OR of all Expr.flags fields in the given
17842308ed38Sdrh ** ExprList.
1785885a5b03Sdrh */
17862308ed38Sdrh u32 sqlite3ExprListFlags(const ExprList *pList){
1787885a5b03Sdrh   int i;
17882308ed38Sdrh   u32 m = 0;
1789508e2d00Sdrh   assert( pList!=0 );
1790885a5b03Sdrh   for(i=0; i<pList->nExpr; i++){
1791d0c73053Sdrh      Expr *pExpr = pList->a[i].pExpr;
1792de845c2fSdrh      assert( pExpr!=0 );
1793de845c2fSdrh      m |= pExpr->flags;
1794885a5b03Sdrh   }
17952308ed38Sdrh   return m;
1796885a5b03Sdrh }
1797885a5b03Sdrh 
1798885a5b03Sdrh /*
17997e6f980bSdrh ** This is a SELECT-node callback for the expression walker that
18007e6f980bSdrh ** always "fails".  By "fail" in this case, we mean set
18017e6f980bSdrh ** pWalker->eCode to zero and abort.
18027e6f980bSdrh **
18037e6f980bSdrh ** This callback is used by multiple expression walkers.
18047e6f980bSdrh */
18057e6f980bSdrh int sqlite3SelectWalkFail(Walker *pWalker, Select *NotUsed){
18067e6f980bSdrh   UNUSED_PARAMETER(NotUsed);
18077e6f980bSdrh   pWalker->eCode = 0;
18087e6f980bSdrh   return WRC_Abort;
18097e6f980bSdrh }
18107e6f980bSdrh 
18117e6f980bSdrh /*
1812171d16bbSdrh ** If the input expression is an ID with the name "true" or "false"
181396acafbeSdrh ** then convert it into an TK_TRUEFALSE term.  Return non-zero if
181496acafbeSdrh ** the conversion happened, and zero if the expression is unaltered.
1815171d16bbSdrh */
1816171d16bbSdrh int sqlite3ExprIdToTrueFalse(Expr *pExpr){
1817171d16bbSdrh   assert( pExpr->op==TK_ID || pExpr->op==TK_STRING );
181851d35b0fSdrh   if( !ExprHasProperty(pExpr, EP_Quoted)
181951d35b0fSdrh    && (sqlite3StrICmp(pExpr->u.zToken, "true")==0
182051d35b0fSdrh        || sqlite3StrICmp(pExpr->u.zToken, "false")==0)
1821171d16bbSdrh   ){
1822171d16bbSdrh     pExpr->op = TK_TRUEFALSE;
1823171d16bbSdrh     return 1;
1824171d16bbSdrh   }
1825171d16bbSdrh   return 0;
1826171d16bbSdrh }
1827171d16bbSdrh 
182843c4ac8bSdrh /*
182996acafbeSdrh ** The argument must be a TK_TRUEFALSE Expr node.  Return 1 if it is TRUE
183043c4ac8bSdrh ** and 0 if it is FALSE.
183143c4ac8bSdrh */
183296acafbeSdrh int sqlite3ExprTruthValue(const Expr *pExpr){
183343c4ac8bSdrh   assert( pExpr->op==TK_TRUEFALSE );
183443c4ac8bSdrh   assert( sqlite3StrICmp(pExpr->u.zToken,"true")==0
183543c4ac8bSdrh        || sqlite3StrICmp(pExpr->u.zToken,"false")==0 );
183643c4ac8bSdrh   return pExpr->u.zToken[4]==0;
183743c4ac8bSdrh }
183843c4ac8bSdrh 
1839171d16bbSdrh 
1840171d16bbSdrh /*
1841059b2d50Sdrh ** These routines are Walker callbacks used to check expressions to
1842059b2d50Sdrh ** see if they are "constant" for some definition of constant.  The
1843059b2d50Sdrh ** Walker.eCode value determines the type of "constant" we are looking
1844059b2d50Sdrh ** for.
184573b211abSdrh **
18467d10d5a6Sdrh ** These callback routines are used to implement the following:
1847626a879aSdrh **
1848059b2d50Sdrh **     sqlite3ExprIsConstant()                  pWalker->eCode==1
1849059b2d50Sdrh **     sqlite3ExprIsConstantNotJoin()           pWalker->eCode==2
1850fcb9f4f3Sdrh **     sqlite3ExprIsTableConstant()             pWalker->eCode==3
1851059b2d50Sdrh **     sqlite3ExprIsConstantOrFunction()        pWalker->eCode==4 or 5
185287abf5c0Sdrh **
1853059b2d50Sdrh ** In all cases, the callbacks set Walker.eCode=0 and abort if the expression
1854059b2d50Sdrh ** is found to not be a constant.
185587abf5c0Sdrh **
1856feada2dfSdrh ** The sqlite3ExprIsConstantOrFunction() is used for evaluating expressions
1857059b2d50Sdrh ** in a CREATE TABLE statement.  The Walker.eCode value is 5 when parsing
1858059b2d50Sdrh ** an existing schema and 4 when processing a new statement.  A bound
1859feada2dfSdrh ** parameter raises an error for new statements, but is silently converted
1860feada2dfSdrh ** to NULL for existing schemas.  This allows sqlite_master tables that
1861feada2dfSdrh ** contain a bound parameter because they were generated by older versions
1862feada2dfSdrh ** of SQLite to be parsed by newer versions of SQLite without raising a
1863feada2dfSdrh ** malformed schema error.
1864626a879aSdrh */
18657d10d5a6Sdrh static int exprNodeIsConstant(Walker *pWalker, Expr *pExpr){
1866626a879aSdrh 
1867059b2d50Sdrh   /* If pWalker->eCode is 2 then any term of the expression that comes from
1868059b2d50Sdrh   ** the ON or USING clauses of a left join disqualifies the expression
18690a168377Sdrh   ** from being considered constant. */
1870059b2d50Sdrh   if( pWalker->eCode==2 && ExprHasProperty(pExpr, EP_FromJoin) ){
1871059b2d50Sdrh     pWalker->eCode = 0;
18727d10d5a6Sdrh     return WRC_Abort;
18730a168377Sdrh   }
18740a168377Sdrh 
1875626a879aSdrh   switch( pExpr->op ){
1876eb55bd2fSdrh     /* Consider functions to be constant if all their arguments are constant
1877059b2d50Sdrh     ** and either pWalker->eCode==4 or 5 or the function has the
1878059b2d50Sdrh     ** SQLITE_FUNC_CONST flag. */
1879eb55bd2fSdrh     case TK_FUNCTION:
188063f84573Sdrh       if( pWalker->eCode>=4 || ExprHasProperty(pExpr,EP_ConstFunc) ){
1881b1fba286Sdrh         return WRC_Continue;
1882059b2d50Sdrh       }else{
1883059b2d50Sdrh         pWalker->eCode = 0;
1884059b2d50Sdrh         return WRC_Abort;
1885b1fba286Sdrh       }
1886626a879aSdrh     case TK_ID:
1887171d16bbSdrh       /* Convert "true" or "false" in a DEFAULT clause into the
1888171d16bbSdrh       ** appropriate TK_TRUEFALSE operator */
1889e39ef31cSdrh       if( sqlite3ExprIdToTrueFalse(pExpr) ){
1890171d16bbSdrh         return WRC_Prune;
1891171d16bbSdrh       }
1892171d16bbSdrh       /* Fall thru */
1893626a879aSdrh     case TK_COLUMN:
1894626a879aSdrh     case TK_AGG_FUNCTION:
189513449892Sdrh     case TK_AGG_COLUMN:
1896c5499befSdrh       testcase( pExpr->op==TK_ID );
1897c5499befSdrh       testcase( pExpr->op==TK_COLUMN );
1898c5499befSdrh       testcase( pExpr->op==TK_AGG_FUNCTION );
1899c5499befSdrh       testcase( pExpr->op==TK_AGG_COLUMN );
190007aded63Sdrh       if( ExprHasProperty(pExpr, EP_FixedCol) && pWalker->eCode!=2 ){
1901efad2e23Sdrh         return WRC_Continue;
1902efad2e23Sdrh       }
1903059b2d50Sdrh       if( pWalker->eCode==3 && pExpr->iTable==pWalker->u.iCur ){
1904059b2d50Sdrh         return WRC_Continue;
1905f43ce0b4Sdrh       }
1906f43ce0b4Sdrh       /* Fall through */
1907f43ce0b4Sdrh     case TK_IF_NULL_ROW:
19086e341b93Sdrh     case TK_REGISTER:
19099916048bSdrh       testcase( pExpr->op==TK_REGISTER );
1910f43ce0b4Sdrh       testcase( pExpr->op==TK_IF_NULL_ROW );
1911059b2d50Sdrh       pWalker->eCode = 0;
19127d10d5a6Sdrh       return WRC_Abort;
1913feada2dfSdrh     case TK_VARIABLE:
1914059b2d50Sdrh       if( pWalker->eCode==5 ){
1915feada2dfSdrh         /* Silently convert bound parameters that appear inside of CREATE
1916feada2dfSdrh         ** statements into a NULL when parsing the CREATE statement text out
1917feada2dfSdrh         ** of the sqlite_master table */
1918feada2dfSdrh         pExpr->op = TK_NULL;
1919059b2d50Sdrh       }else if( pWalker->eCode==4 ){
1920feada2dfSdrh         /* A bound parameter in a CREATE statement that originates from
1921feada2dfSdrh         ** sqlite3_prepare() causes an error */
1922059b2d50Sdrh         pWalker->eCode = 0;
1923feada2dfSdrh         return WRC_Abort;
1924feada2dfSdrh       }
1925feada2dfSdrh       /* Fall through */
1926626a879aSdrh     default:
19276e341b93Sdrh       testcase( pExpr->op==TK_SELECT ); /* sqlite3SelectWalkFail() disallows */
19286e341b93Sdrh       testcase( pExpr->op==TK_EXISTS ); /* sqlite3SelectWalkFail() disallows */
19297d10d5a6Sdrh       return WRC_Continue;
1930626a879aSdrh   }
1931626a879aSdrh }
1932059b2d50Sdrh static int exprIsConst(Expr *p, int initFlag, int iCur){
19337d10d5a6Sdrh   Walker w;
1934059b2d50Sdrh   w.eCode = initFlag;
19357d10d5a6Sdrh   w.xExprCallback = exprNodeIsConstant;
19367e6f980bSdrh   w.xSelectCallback = sqlite3SelectWalkFail;
1937979dd1beSdrh #ifdef SQLITE_DEBUG
1938979dd1beSdrh   w.xSelectCallback2 = sqlite3SelectWalkAssert2;
1939979dd1beSdrh #endif
1940059b2d50Sdrh   w.u.iCur = iCur;
19417d10d5a6Sdrh   sqlite3WalkExpr(&w, p);
1942059b2d50Sdrh   return w.eCode;
19437d10d5a6Sdrh }
1944626a879aSdrh 
1945626a879aSdrh /*
1946059b2d50Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
1947eb55bd2fSdrh ** and 0 if it involves variables or function calls.
19482398937bSdrh **
19492398937bSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
19502398937bSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
19512398937bSdrh ** a constant.
1952fef5208cSdrh */
19534adee20fSdanielk1977 int sqlite3ExprIsConstant(Expr *p){
1954059b2d50Sdrh   return exprIsConst(p, 1, 0);
1955fef5208cSdrh }
1956fef5208cSdrh 
1957fef5208cSdrh /*
195807aded63Sdrh ** Walk an expression tree.  Return non-zero if
195907aded63Sdrh **
196007aded63Sdrh **   (1) the expression is constant, and
196107aded63Sdrh **   (2) the expression does originate in the ON or USING clause
196207aded63Sdrh **       of a LEFT JOIN, and
196307aded63Sdrh **   (3) the expression does not contain any EP_FixedCol TK_COLUMN
196407aded63Sdrh **       operands created by the constant propagation optimization.
196507aded63Sdrh **
196607aded63Sdrh ** When this routine returns true, it indicates that the expression
196707aded63Sdrh ** can be added to the pParse->pConstExpr list and evaluated once when
196807aded63Sdrh ** the prepared statement starts up.  See sqlite3ExprCodeAtInit().
19690a168377Sdrh */
19700a168377Sdrh int sqlite3ExprIsConstantNotJoin(Expr *p){
1971059b2d50Sdrh   return exprIsConst(p, 2, 0);
19720a168377Sdrh }
19730a168377Sdrh 
19740a168377Sdrh /*
1975fcb9f4f3Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
1976059b2d50Sdrh ** for any single row of the table with cursor iCur.  In other words, the
1977059b2d50Sdrh ** expression must not refer to any non-deterministic function nor any
1978059b2d50Sdrh ** table other than iCur.
1979059b2d50Sdrh */
1980059b2d50Sdrh int sqlite3ExprIsTableConstant(Expr *p, int iCur){
1981059b2d50Sdrh   return exprIsConst(p, 3, iCur);
1982059b2d50Sdrh }
1983059b2d50Sdrh 
1984ab31a845Sdan 
1985ab31a845Sdan /*
1986ab31a845Sdan ** sqlite3WalkExpr() callback used by sqlite3ExprIsConstantOrGroupBy().
1987ab31a845Sdan */
1988ab31a845Sdan static int exprNodeIsConstantOrGroupBy(Walker *pWalker, Expr *pExpr){
1989ab31a845Sdan   ExprList *pGroupBy = pWalker->u.pGroupBy;
1990ab31a845Sdan   int i;
1991ab31a845Sdan 
1992ab31a845Sdan   /* Check if pExpr is identical to any GROUP BY term. If so, consider
1993ab31a845Sdan   ** it constant.  */
1994ab31a845Sdan   for(i=0; i<pGroupBy->nExpr; i++){
1995ab31a845Sdan     Expr *p = pGroupBy->a[i].pExpr;
19965aa550cfSdan     if( sqlite3ExprCompare(0, pExpr, p, -1)<2 ){
199770efa84dSdrh       CollSeq *pColl = sqlite3ExprNNCollSeq(pWalker->pParse, p);
1998efad2e23Sdrh       if( sqlite3IsBinary(pColl) ){
1999ab31a845Sdan         return WRC_Prune;
2000ab31a845Sdan       }
2001ab31a845Sdan     }
2002ab31a845Sdan   }
2003ab31a845Sdan 
2004ab31a845Sdan   /* Check if pExpr is a sub-select. If so, consider it variable. */
2005ab31a845Sdan   if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2006ab31a845Sdan     pWalker->eCode = 0;
2007ab31a845Sdan     return WRC_Abort;
2008ab31a845Sdan   }
2009ab31a845Sdan 
2010ab31a845Sdan   return exprNodeIsConstant(pWalker, pExpr);
2011ab31a845Sdan }
2012ab31a845Sdan 
2013ab31a845Sdan /*
2014ab31a845Sdan ** Walk the expression tree passed as the first argument. Return non-zero
2015ab31a845Sdan ** if the expression consists entirely of constants or copies of terms
2016ab31a845Sdan ** in pGroupBy that sort with the BINARY collation sequence.
2017ab314001Sdrh **
2018ab314001Sdrh ** This routine is used to determine if a term of the HAVING clause can
2019ab314001Sdrh ** be promoted into the WHERE clause.  In order for such a promotion to work,
2020ab314001Sdrh ** the value of the HAVING clause term must be the same for all members of
2021ab314001Sdrh ** a "group".  The requirement that the GROUP BY term must be BINARY
2022ab314001Sdrh ** assumes that no other collating sequence will have a finer-grained
2023ab314001Sdrh ** grouping than binary.  In other words (A=B COLLATE binary) implies
2024ab314001Sdrh ** A=B in every other collating sequence.  The requirement that the
2025ab314001Sdrh ** GROUP BY be BINARY is stricter than necessary.  It would also work
2026ab314001Sdrh ** to promote HAVING clauses that use the same alternative collating
2027ab314001Sdrh ** sequence as the GROUP BY term, but that is much harder to check,
2028ab314001Sdrh ** alternative collating sequences are uncommon, and this is only an
2029ab314001Sdrh ** optimization, so we take the easy way out and simply require the
2030ab314001Sdrh ** GROUP BY to use the BINARY collating sequence.
2031ab31a845Sdan */
2032ab31a845Sdan int sqlite3ExprIsConstantOrGroupBy(Parse *pParse, Expr *p, ExprList *pGroupBy){
2033ab31a845Sdan   Walker w;
2034ab31a845Sdan   w.eCode = 1;
2035ab31a845Sdan   w.xExprCallback = exprNodeIsConstantOrGroupBy;
2036979dd1beSdrh   w.xSelectCallback = 0;
2037ab31a845Sdan   w.u.pGroupBy = pGroupBy;
2038ab31a845Sdan   w.pParse = pParse;
2039ab31a845Sdan   sqlite3WalkExpr(&w, p);
2040ab31a845Sdan   return w.eCode;
2041ab31a845Sdan }
2042ab31a845Sdan 
2043059b2d50Sdrh /*
2044059b2d50Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
2045eb55bd2fSdrh ** or a function call with constant arguments.  Return and 0 if there
2046eb55bd2fSdrh ** are any variables.
2047eb55bd2fSdrh **
2048eb55bd2fSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
2049eb55bd2fSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
2050eb55bd2fSdrh ** a constant.
2051eb55bd2fSdrh */
2052feada2dfSdrh int sqlite3ExprIsConstantOrFunction(Expr *p, u8 isInit){
2053feada2dfSdrh   assert( isInit==0 || isInit==1 );
2054059b2d50Sdrh   return exprIsConst(p, 4+isInit, 0);
2055eb55bd2fSdrh }
2056eb55bd2fSdrh 
20575b88bc4bSdrh #ifdef SQLITE_ENABLE_CURSOR_HINTS
20585b88bc4bSdrh /*
20595b88bc4bSdrh ** Walk an expression tree.  Return 1 if the expression contains a
20605b88bc4bSdrh ** subquery of some kind.  Return 0 if there are no subqueries.
20615b88bc4bSdrh */
20625b88bc4bSdrh int sqlite3ExprContainsSubquery(Expr *p){
20635b88bc4bSdrh   Walker w;
2064bec2476aSdrh   w.eCode = 1;
20655b88bc4bSdrh   w.xExprCallback = sqlite3ExprWalkNoop;
20667e6f980bSdrh   w.xSelectCallback = sqlite3SelectWalkFail;
2067979dd1beSdrh #ifdef SQLITE_DEBUG
2068979dd1beSdrh   w.xSelectCallback2 = sqlite3SelectWalkAssert2;
2069979dd1beSdrh #endif
20705b88bc4bSdrh   sqlite3WalkExpr(&w, p);
207107194bffSdrh   return w.eCode==0;
20725b88bc4bSdrh }
20735b88bc4bSdrh #endif
20745b88bc4bSdrh 
2075eb55bd2fSdrh /*
207673b211abSdrh ** If the expression p codes a constant integer that is small enough
2077202b2df7Sdrh ** to fit in a 32-bit integer, return 1 and put the value of the integer
2078202b2df7Sdrh ** in *pValue.  If the expression is not an integer or if it is too big
2079202b2df7Sdrh ** to fit in a signed 32-bit integer, return 0 and leave *pValue unchanged.
2080e4de1febSdrh */
20814adee20fSdanielk1977 int sqlite3ExprIsInteger(Expr *p, int *pValue){
208292b01d53Sdrh   int rc = 0;
2083ba28b5abSdrh   if( p==0 ) return 0;  /* Can only happen following on OOM */
2084cd92e84dSdrh 
2085cd92e84dSdrh   /* If an expression is an integer literal that fits in a signed 32-bit
2086cd92e84dSdrh   ** integer, then the EP_IntValue flag will have already been set */
2087cd92e84dSdrh   assert( p->op!=TK_INTEGER || (p->flags & EP_IntValue)!=0
2088cd92e84dSdrh            || sqlite3GetInt32(p->u.zToken, &rc)==0 );
2089cd92e84dSdrh 
209092b01d53Sdrh   if( p->flags & EP_IntValue ){
209133e619fcSdrh     *pValue = p->u.iValue;
2092e4de1febSdrh     return 1;
2093e4de1febSdrh   }
209492b01d53Sdrh   switch( p->op ){
20954b59ab5eSdrh     case TK_UPLUS: {
209692b01d53Sdrh       rc = sqlite3ExprIsInteger(p->pLeft, pValue);
2097f6e369a1Sdrh       break;
20984b59ab5eSdrh     }
2099e4de1febSdrh     case TK_UMINUS: {
2100e4de1febSdrh       int v;
21014adee20fSdanielk1977       if( sqlite3ExprIsInteger(p->pLeft, &v) ){
2102f6418891Smistachkin         assert( v!=(-2147483647-1) );
2103e4de1febSdrh         *pValue = -v;
210492b01d53Sdrh         rc = 1;
2105e4de1febSdrh       }
2106e4de1febSdrh       break;
2107e4de1febSdrh     }
2108e4de1febSdrh     default: break;
2109e4de1febSdrh   }
211092b01d53Sdrh   return rc;
2111e4de1febSdrh }
2112e4de1febSdrh 
2113e4de1febSdrh /*
2114039fc32eSdrh ** Return FALSE if there is no chance that the expression can be NULL.
2115039fc32eSdrh **
2116039fc32eSdrh ** If the expression might be NULL or if the expression is too complex
2117039fc32eSdrh ** to tell return TRUE.
2118039fc32eSdrh **
2119039fc32eSdrh ** This routine is used as an optimization, to skip OP_IsNull opcodes
2120039fc32eSdrh ** when we know that a value cannot be NULL.  Hence, a false positive
2121039fc32eSdrh ** (returning TRUE when in fact the expression can never be NULL) might
2122039fc32eSdrh ** be a small performance hit but is otherwise harmless.  On the other
2123039fc32eSdrh ** hand, a false negative (returning FALSE when the result could be NULL)
2124039fc32eSdrh ** will likely result in an incorrect answer.  So when in doubt, return
2125039fc32eSdrh ** TRUE.
2126039fc32eSdrh */
2127039fc32eSdrh int sqlite3ExprCanBeNull(const Expr *p){
2128039fc32eSdrh   u8 op;
21299bfb0794Sdrh   while( p->op==TK_UPLUS || p->op==TK_UMINUS ){
21309bfb0794Sdrh     p = p->pLeft;
21319bfb0794Sdrh   }
2132039fc32eSdrh   op = p->op;
2133039fc32eSdrh   if( op==TK_REGISTER ) op = p->op2;
2134039fc32eSdrh   switch( op ){
2135039fc32eSdrh     case TK_INTEGER:
2136039fc32eSdrh     case TK_STRING:
2137039fc32eSdrh     case TK_FLOAT:
2138039fc32eSdrh     case TK_BLOB:
2139039fc32eSdrh       return 0;
21407248a8b2Sdrh     case TK_COLUMN:
214172673a24Sdrh       return ExprHasProperty(p, EP_CanBeNull) ||
2142eda079cdSdrh              p->y.pTab==0 ||  /* Reference to column of index on expression */
2143eda079cdSdrh              (p->iColumn>=0 && p->y.pTab->aCol[p->iColumn].notNull==0);
2144039fc32eSdrh     default:
2145039fc32eSdrh       return 1;
2146039fc32eSdrh   }
2147039fc32eSdrh }
2148039fc32eSdrh 
2149039fc32eSdrh /*
2150039fc32eSdrh ** Return TRUE if the given expression is a constant which would be
2151039fc32eSdrh ** unchanged by OP_Affinity with the affinity given in the second
2152039fc32eSdrh ** argument.
2153039fc32eSdrh **
2154039fc32eSdrh ** This routine is used to determine if the OP_Affinity operation
2155039fc32eSdrh ** can be omitted.  When in doubt return FALSE.  A false negative
2156039fc32eSdrh ** is harmless.  A false positive, however, can result in the wrong
2157039fc32eSdrh ** answer.
2158039fc32eSdrh */
2159039fc32eSdrh int sqlite3ExprNeedsNoAffinityChange(const Expr *p, char aff){
2160039fc32eSdrh   u8 op;
216105883a34Sdrh   if( aff==SQLITE_AFF_BLOB ) return 1;
2162cd7f457eSdrh   while( p->op==TK_UPLUS || p->op==TK_UMINUS ){ p = p->pLeft; }
2163039fc32eSdrh   op = p->op;
2164039fc32eSdrh   if( op==TK_REGISTER ) op = p->op2;
2165039fc32eSdrh   switch( op ){
2166039fc32eSdrh     case TK_INTEGER: {
2167039fc32eSdrh       return aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC;
2168039fc32eSdrh     }
2169039fc32eSdrh     case TK_FLOAT: {
2170039fc32eSdrh       return aff==SQLITE_AFF_REAL || aff==SQLITE_AFF_NUMERIC;
2171039fc32eSdrh     }
2172039fc32eSdrh     case TK_STRING: {
2173039fc32eSdrh       return aff==SQLITE_AFF_TEXT;
2174039fc32eSdrh     }
2175039fc32eSdrh     case TK_BLOB: {
2176039fc32eSdrh       return 1;
2177039fc32eSdrh     }
21782f2855b6Sdrh     case TK_COLUMN: {
217988376ca7Sdrh       assert( p->iTable>=0 );  /* p cannot be part of a CHECK constraint */
218088376ca7Sdrh       return p->iColumn<0
21812f2855b6Sdrh           && (aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC);
21822f2855b6Sdrh     }
2183039fc32eSdrh     default: {
2184039fc32eSdrh       return 0;
2185039fc32eSdrh     }
2186039fc32eSdrh   }
2187039fc32eSdrh }
2188039fc32eSdrh 
2189039fc32eSdrh /*
2190c4a3c779Sdrh ** Return TRUE if the given string is a row-id column name.
2191c4a3c779Sdrh */
21924adee20fSdanielk1977 int sqlite3IsRowid(const char *z){
21934adee20fSdanielk1977   if( sqlite3StrICmp(z, "_ROWID_")==0 ) return 1;
21944adee20fSdanielk1977   if( sqlite3StrICmp(z, "ROWID")==0 ) return 1;
21954adee20fSdanielk1977   if( sqlite3StrICmp(z, "OID")==0 ) return 1;
2196c4a3c779Sdrh   return 0;
2197c4a3c779Sdrh }
2198c4a3c779Sdrh 
21999a96b668Sdanielk1977 /*
220069c355bdSdrh ** pX is the RHS of an IN operator.  If pX is a SELECT statement
220169c355bdSdrh ** that can be simplified to a direct table access, then return
220269c355bdSdrh ** a pointer to the SELECT statement.  If pX is not a SELECT statement,
220369c355bdSdrh ** or if the SELECT statement needs to be manifested into a transient
220469c355bdSdrh ** table, then return NULL.
2205b287f4b6Sdrh */
2206b287f4b6Sdrh #ifndef SQLITE_OMIT_SUBQUERY
22077b35a77bSdan static Select *isCandidateForInOpt(Expr *pX){
220869c355bdSdrh   Select *p;
2209b287f4b6Sdrh   SrcList *pSrc;
2210b287f4b6Sdrh   ExprList *pEList;
2211b287f4b6Sdrh   Table *pTab;
2212cfbb5e82Sdan   int i;
221369c355bdSdrh   if( !ExprHasProperty(pX, EP_xIsSelect) ) return 0;  /* Not a subquery */
221469c355bdSdrh   if( ExprHasProperty(pX, EP_VarSelect)  ) return 0;  /* Correlated subq */
221569c355bdSdrh   p = pX->x.pSelect;
2216b287f4b6Sdrh   if( p->pPrior ) return 0;              /* Not a compound SELECT */
22177d10d5a6Sdrh   if( p->selFlags & (SF_Distinct|SF_Aggregate) ){
2218b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
2219b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
22207d10d5a6Sdrh     return 0; /* No DISTINCT keyword and no aggregate functions */
22217d10d5a6Sdrh   }
2222b74b1017Sdrh   assert( p->pGroupBy==0 );              /* Has no GROUP BY clause */
2223b287f4b6Sdrh   if( p->pLimit ) return 0;              /* Has no LIMIT clause */
2224b287f4b6Sdrh   if( p->pWhere ) return 0;              /* Has no WHERE clause */
2225b287f4b6Sdrh   pSrc = p->pSrc;
2226d1fa7bcaSdrh   assert( pSrc!=0 );
2227d1fa7bcaSdrh   if( pSrc->nSrc!=1 ) return 0;          /* Single term in FROM clause */
2228b74b1017Sdrh   if( pSrc->a[0].pSelect ) return 0;     /* FROM is not a subquery or view */
2229b287f4b6Sdrh   pTab = pSrc->a[0].pTab;
223069c355bdSdrh   assert( pTab!=0 );
2231b74b1017Sdrh   assert( pTab->pSelect==0 );            /* FROM clause is not a view */
2232b287f4b6Sdrh   if( IsVirtual(pTab) ) return 0;        /* FROM clause not a virtual table */
2233b287f4b6Sdrh   pEList = p->pEList;
2234ac6b47d1Sdrh   assert( pEList!=0 );
22357b35a77bSdan   /* All SELECT results must be columns. */
2236cfbb5e82Sdan   for(i=0; i<pEList->nExpr; i++){
2237cfbb5e82Sdan     Expr *pRes = pEList->a[i].pExpr;
2238cfbb5e82Sdan     if( pRes->op!=TK_COLUMN ) return 0;
223969c355bdSdrh     assert( pRes->iTable==pSrc->a[0].iCursor );  /* Not a correlated subquery */
2240cfbb5e82Sdan   }
224169c355bdSdrh   return p;
2242b287f4b6Sdrh }
2243b287f4b6Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
2244b287f4b6Sdrh 
2245f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
22461d8cb21fSdan /*
22474c259e9fSdrh ** Generate code that checks the left-most column of index table iCur to see if
22484c259e9fSdrh ** it contains any NULL entries.  Cause the register at regHasNull to be set
22496be515ebSdrh ** to a non-NULL value if iCur contains no NULLs.  Cause register regHasNull
22506be515ebSdrh ** to be set to NULL if iCur contains one or more NULL values.
22516be515ebSdrh */
22526be515ebSdrh static void sqlite3SetHasNullFlag(Vdbe *v, int iCur, int regHasNull){
2253728e0f91Sdrh   int addr1;
22546be515ebSdrh   sqlite3VdbeAddOp2(v, OP_Integer, 0, regHasNull);
2255728e0f91Sdrh   addr1 = sqlite3VdbeAddOp1(v, OP_Rewind, iCur); VdbeCoverage(v);
22566be515ebSdrh   sqlite3VdbeAddOp3(v, OP_Column, iCur, 0, regHasNull);
22576be515ebSdrh   sqlite3VdbeChangeP5(v, OPFLAG_TYPEOFARG);
22584c259e9fSdrh   VdbeComment((v, "first_entry_in(%d)", iCur));
2259728e0f91Sdrh   sqlite3VdbeJumpHere(v, addr1);
22606be515ebSdrh }
2261f9b2e05cSdan #endif
22626be515ebSdrh 
2263bb53ecb1Sdrh 
2264bb53ecb1Sdrh #ifndef SQLITE_OMIT_SUBQUERY
2265bb53ecb1Sdrh /*
2266bb53ecb1Sdrh ** The argument is an IN operator with a list (not a subquery) on the
2267bb53ecb1Sdrh ** right-hand side.  Return TRUE if that list is constant.
2268bb53ecb1Sdrh */
2269bb53ecb1Sdrh static int sqlite3InRhsIsConstant(Expr *pIn){
2270bb53ecb1Sdrh   Expr *pLHS;
2271bb53ecb1Sdrh   int res;
2272bb53ecb1Sdrh   assert( !ExprHasProperty(pIn, EP_xIsSelect) );
2273bb53ecb1Sdrh   pLHS = pIn->pLeft;
2274bb53ecb1Sdrh   pIn->pLeft = 0;
2275bb53ecb1Sdrh   res = sqlite3ExprIsConstant(pIn);
2276bb53ecb1Sdrh   pIn->pLeft = pLHS;
2277bb53ecb1Sdrh   return res;
2278bb53ecb1Sdrh }
2279bb53ecb1Sdrh #endif
2280bb53ecb1Sdrh 
22816be515ebSdrh /*
22829a96b668Sdanielk1977 ** This function is used by the implementation of the IN (...) operator.
2283d4305ca6Sdrh ** The pX parameter is the expression on the RHS of the IN operator, which
2284d4305ca6Sdrh ** might be either a list of expressions or a subquery.
22859a96b668Sdanielk1977 **
2286d4305ca6Sdrh ** The job of this routine is to find or create a b-tree object that can
2287d4305ca6Sdrh ** be used either to test for membership in the RHS set or to iterate through
2288d4305ca6Sdrh ** all members of the RHS set, skipping duplicates.
2289d4305ca6Sdrh **
22903a85625dSdrh ** A cursor is opened on the b-tree object that is the RHS of the IN operator
2291d4305ca6Sdrh ** and pX->iTable is set to the index of that cursor.
2292d4305ca6Sdrh **
2293b74b1017Sdrh ** The returned value of this function indicates the b-tree type, as follows:
22949a96b668Sdanielk1977 **
22959a96b668Sdanielk1977 **   IN_INDEX_ROWID      - The cursor was opened on a database table.
22961ccce449Sdrh **   IN_INDEX_INDEX_ASC  - The cursor was opened on an ascending index.
22971ccce449Sdrh **   IN_INDEX_INDEX_DESC - The cursor was opened on a descending index.
22989a96b668Sdanielk1977 **   IN_INDEX_EPH        - The cursor was opened on a specially created and
22999a96b668Sdanielk1977 **                         populated epheremal table.
2300bb53ecb1Sdrh **   IN_INDEX_NOOP       - No cursor was allocated.  The IN operator must be
2301bb53ecb1Sdrh **                         implemented as a sequence of comparisons.
23029a96b668Sdanielk1977 **
2303d4305ca6Sdrh ** An existing b-tree might be used if the RHS expression pX is a simple
2304d4305ca6Sdrh ** subquery such as:
23059a96b668Sdanielk1977 **
2306553168c7Sdan **     SELECT <column1>, <column2>... FROM <table>
23079a96b668Sdanielk1977 **
2308d4305ca6Sdrh ** If the RHS of the IN operator is a list or a more complex subquery, then
2309d4305ca6Sdrh ** an ephemeral table might need to be generated from the RHS and then
231060ec914cSpeter.d.reid ** pX->iTable made to point to the ephemeral table instead of an
2311d4305ca6Sdrh ** existing table.
2312d4305ca6Sdrh **
23137fc0ba0fSdrh ** The inFlags parameter must contain, at a minimum, one of the bits
23147fc0ba0fSdrh ** IN_INDEX_MEMBERSHIP or IN_INDEX_LOOP but not both.  If inFlags contains
23157fc0ba0fSdrh ** IN_INDEX_MEMBERSHIP, then the generated table will be used for a fast
23167fc0ba0fSdrh ** membership test.  When the IN_INDEX_LOOP bit is set, the IN index will
23177fc0ba0fSdrh ** be used to loop over all values of the RHS of the IN operator.
23183a85625dSdrh **
23193a85625dSdrh ** When IN_INDEX_LOOP is used (and the b-tree will be used to iterate
23203a85625dSdrh ** through the set members) then the b-tree must not contain duplicates.
23217fc0ba0fSdrh ** An epheremal table will be created unless the selected columns are guaranteed
2322553168c7Sdan ** to be unique - either because it is an INTEGER PRIMARY KEY or due to
2323553168c7Sdan ** a UNIQUE constraint or index.
23240cdc022eSdanielk1977 **
23253a85625dSdrh ** When IN_INDEX_MEMBERSHIP is used (and the b-tree will be used
23263a85625dSdrh ** for fast set membership tests) then an epheremal table must
2327553168c7Sdan ** be used unless <columns> is a single INTEGER PRIMARY KEY column or an
2328553168c7Sdan ** index can be found with the specified <columns> as its left-most.
23290cdc022eSdanielk1977 **
2330bb53ecb1Sdrh ** If the IN_INDEX_NOOP_OK and IN_INDEX_MEMBERSHIP are both set and
2331bb53ecb1Sdrh ** if the RHS of the IN operator is a list (not a subquery) then this
2332bb53ecb1Sdrh ** routine might decide that creating an ephemeral b-tree for membership
2333bb53ecb1Sdrh ** testing is too expensive and return IN_INDEX_NOOP.  In that case, the
2334bb53ecb1Sdrh ** calling routine should implement the IN operator using a sequence
2335bb53ecb1Sdrh ** of Eq or Ne comparison operations.
2336bb53ecb1Sdrh **
2337b74b1017Sdrh ** When the b-tree is being used for membership tests, the calling function
23383a85625dSdrh ** might need to know whether or not the RHS side of the IN operator
2339e21a6e1dSdrh ** contains a NULL.  If prRhsHasNull is not a NULL pointer and
23403a85625dSdrh ** if there is any chance that the (...) might contain a NULL value at
23410cdc022eSdanielk1977 ** runtime, then a register is allocated and the register number written
2342e21a6e1dSdrh ** to *prRhsHasNull. If there is no chance that the (...) contains a
2343e21a6e1dSdrh ** NULL value, then *prRhsHasNull is left unchanged.
23440cdc022eSdanielk1977 **
2345e21a6e1dSdrh ** If a register is allocated and its location stored in *prRhsHasNull, then
23466be515ebSdrh ** the value in that register will be NULL if the b-tree contains one or more
23476be515ebSdrh ** NULL values, and it will be some non-NULL value if the b-tree contains no
23486be515ebSdrh ** NULL values.
2349553168c7Sdan **
2350553168c7Sdan ** If the aiMap parameter is not NULL, it must point to an array containing
2351553168c7Sdan ** one element for each column returned by the SELECT statement on the RHS
2352553168c7Sdan ** of the IN(...) operator. The i'th entry of the array is populated with the
2353553168c7Sdan ** offset of the index column that matches the i'th column returned by the
2354553168c7Sdan ** SELECT. For example, if the expression and selected index are:
2355553168c7Sdan **
2356553168c7Sdan **   (?,?,?) IN (SELECT a, b, c FROM t1)
2357553168c7Sdan **   CREATE INDEX i1 ON t1(b, c, a);
2358553168c7Sdan **
2359553168c7Sdan ** then aiMap[] is populated with {2, 0, 1}.
23609a96b668Sdanielk1977 */
2361284f4acaSdanielk1977 #ifndef SQLITE_OMIT_SUBQUERY
2362ba00e30aSdan int sqlite3FindInIndex(
23636fc8f364Sdrh   Parse *pParse,             /* Parsing context */
23646fc8f364Sdrh   Expr *pX,                  /* The right-hand side (RHS) of the IN operator */
23656fc8f364Sdrh   u32 inFlags,               /* IN_INDEX_LOOP, _MEMBERSHIP, and/or _NOOP_OK */
23666fc8f364Sdrh   int *prRhsHasNull,         /* Register holding NULL status.  See notes */
23672c04131cSdrh   int *aiMap,                /* Mapping from Index fields to RHS fields */
23682c04131cSdrh   int *piTab                 /* OUT: index to use */
2369ba00e30aSdan ){
2370b74b1017Sdrh   Select *p;                            /* SELECT to the right of IN operator */
2371b74b1017Sdrh   int eType = 0;                        /* Type of RHS table. IN_INDEX_* */
2372b74b1017Sdrh   int iTab = pParse->nTab++;            /* Cursor of the RHS table */
23733a85625dSdrh   int mustBeUnique;                     /* True if RHS must be unique */
2374b8475df8Sdrh   Vdbe *v = sqlite3GetVdbe(pParse);     /* Virtual machine being coded */
23759a96b668Sdanielk1977 
23761450bc6eSdrh   assert( pX->op==TK_IN );
23773a85625dSdrh   mustBeUnique = (inFlags & IN_INDEX_LOOP)!=0;
23781450bc6eSdrh 
23797b35a77bSdan   /* If the RHS of this IN(...) operator is a SELECT, and if it matters
23807b35a77bSdan   ** whether or not the SELECT result contains NULL values, check whether
2381870a0705Sdan   ** or not NULL is actually possible (it may not be, for example, due
23827b35a77bSdan   ** to NOT NULL constraints in the schema). If no NULL values are possible,
2383870a0705Sdan   ** set prRhsHasNull to 0 before continuing.  */
23847b35a77bSdan   if( prRhsHasNull && (pX->flags & EP_xIsSelect) ){
23857b35a77bSdan     int i;
23867b35a77bSdan     ExprList *pEList = pX->x.pSelect->pEList;
23877b35a77bSdan     for(i=0; i<pEList->nExpr; i++){
23887b35a77bSdan       if( sqlite3ExprCanBeNull(pEList->a[i].pExpr) ) break;
23897b35a77bSdan     }
23907b35a77bSdan     if( i==pEList->nExpr ){
23917b35a77bSdan       prRhsHasNull = 0;
23927b35a77bSdan     }
23937b35a77bSdan   }
23947b35a77bSdan 
2395b74b1017Sdrh   /* Check to see if an existing table or index can be used to
2396b74b1017Sdrh   ** satisfy the query.  This is preferable to generating a new
23977b35a77bSdan   ** ephemeral table.  */
23987b35a77bSdan   if( pParse->nErr==0 && (p = isCandidateForInOpt(pX))!=0 ){
2399e1fb65a0Sdanielk1977     sqlite3 *db = pParse->db;              /* Database connection */
2400b07028f7Sdrh     Table *pTab;                           /* Table <table>. */
2401ba00e30aSdan     i16 iDb;                               /* Database idx for pTab */
2402cfbb5e82Sdan     ExprList *pEList = p->pEList;
2403cfbb5e82Sdan     int nExpr = pEList->nExpr;
2404e1fb65a0Sdanielk1977 
2405b07028f7Sdrh     assert( p->pEList!=0 );             /* Because of isCandidateForInOpt(p) */
2406b07028f7Sdrh     assert( p->pEList->a[0].pExpr!=0 ); /* Because of isCandidateForInOpt(p) */
2407b07028f7Sdrh     assert( p->pSrc!=0 );               /* Because of isCandidateForInOpt(p) */
2408b07028f7Sdrh     pTab = p->pSrc->a[0].pTab;
2409b07028f7Sdrh 
2410b22f7c83Sdrh     /* Code an OP_Transaction and OP_TableLock for <table>. */
2411e1fb65a0Sdanielk1977     iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
2412e1fb65a0Sdanielk1977     sqlite3CodeVerifySchema(pParse, iDb);
2413e1fb65a0Sdanielk1977     sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
24149a96b668Sdanielk1977 
2415a84a283dSdrh     assert(v);  /* sqlite3GetVdbe() has always been previously called */
2416cfbb5e82Sdan     if( nExpr==1 && pEList->a[0].pExpr->iColumn<0 ){
241762659b2aSdrh       /* The "x IN (SELECT rowid FROM table)" case */
2418511f9e8dSdrh       int iAddr = sqlite3VdbeAddOp0(v, OP_Once);
24197d176105Sdrh       VdbeCoverage(v);
24209a96b668Sdanielk1977 
24219a96b668Sdanielk1977       sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
24229a96b668Sdanielk1977       eType = IN_INDEX_ROWID;
2423d8852095Sdrh       ExplainQueryPlan((pParse, 0,
2424d8852095Sdrh             "USING ROWID SEARCH ON TABLE %s FOR IN-OPERATOR",pTab->zName));
24259a96b668Sdanielk1977       sqlite3VdbeJumpHere(v, iAddr);
24269a96b668Sdanielk1977     }else{
2427e1fb65a0Sdanielk1977       Index *pIdx;                         /* Iterator variable */
2428cfbb5e82Sdan       int affinity_ok = 1;
2429cfbb5e82Sdan       int i;
2430cfbb5e82Sdan 
2431cfbb5e82Sdan       /* Check that the affinity that will be used to perform each
243262659b2aSdrh       ** comparison is the same as the affinity of each column in table
243362659b2aSdrh       ** on the RHS of the IN operator.  If it not, it is not possible to
243462659b2aSdrh       ** use any index of the RHS table.  */
2435cfbb5e82Sdan       for(i=0; i<nExpr && affinity_ok; i++){
2436fc7f27b9Sdrh         Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2437cfbb5e82Sdan         int iCol = pEList->a[i].pExpr->iColumn;
24380dfa4f6fSdrh         char idxaff = sqlite3TableColumnAffinity(pTab,iCol); /* RHS table */
2439cfbb5e82Sdan         char cmpaff = sqlite3CompareAffinity(pLhs, idxaff);
244062659b2aSdrh         testcase( cmpaff==SQLITE_AFF_BLOB );
244162659b2aSdrh         testcase( cmpaff==SQLITE_AFF_TEXT );
2442cfbb5e82Sdan         switch( cmpaff ){
2443cfbb5e82Sdan           case SQLITE_AFF_BLOB:
2444cfbb5e82Sdan             break;
2445cfbb5e82Sdan           case SQLITE_AFF_TEXT:
244662659b2aSdrh             /* sqlite3CompareAffinity() only returns TEXT if one side or the
244762659b2aSdrh             ** other has no affinity and the other side is TEXT.  Hence,
244862659b2aSdrh             ** the only way for cmpaff to be TEXT is for idxaff to be TEXT
244962659b2aSdrh             ** and for the term on the LHS of the IN to have no affinity. */
245062659b2aSdrh             assert( idxaff==SQLITE_AFF_TEXT );
2451cfbb5e82Sdan             break;
2452cfbb5e82Sdan           default:
2453cfbb5e82Sdan             affinity_ok = sqlite3IsNumericAffinity(idxaff);
2454cfbb5e82Sdan         }
2455cfbb5e82Sdan       }
2456e1fb65a0Sdanielk1977 
2457a84a283dSdrh       if( affinity_ok ){
2458a84a283dSdrh         /* Search for an existing index that will work for this IN operator */
2459a84a283dSdrh         for(pIdx=pTab->pIndex; pIdx && eType==0; pIdx=pIdx->pNext){
2460a84a283dSdrh           Bitmask colUsed;      /* Columns of the index used */
2461a84a283dSdrh           Bitmask mCol;         /* Mask for the current column */
24626fc8f364Sdrh           if( pIdx->nColumn<nExpr ) continue;
2463d4a4a361Sdrh           if( pIdx->pPartIdxWhere!=0 ) continue;
2464a84a283dSdrh           /* Maximum nColumn is BMS-2, not BMS-1, so that we can compute
2465a84a283dSdrh           ** BITMASK(nExpr) without overflowing */
2466a84a283dSdrh           testcase( pIdx->nColumn==BMS-2 );
2467a84a283dSdrh           testcase( pIdx->nColumn==BMS-1 );
2468a84a283dSdrh           if( pIdx->nColumn>=BMS-1 ) continue;
24696fc8f364Sdrh           if( mustBeUnique ){
24706fc8f364Sdrh             if( pIdx->nKeyCol>nExpr
24716fc8f364Sdrh              ||(pIdx->nColumn>nExpr && !IsUniqueIndex(pIdx))
24726fc8f364Sdrh             ){
2473a84a283dSdrh               continue;  /* This index is not unique over the IN RHS columns */
2474cfbb5e82Sdan             }
24756fc8f364Sdrh           }
2476cfbb5e82Sdan 
2477a84a283dSdrh           colUsed = 0;   /* Columns of index used so far */
2478cfbb5e82Sdan           for(i=0; i<nExpr; i++){
2479fc7f27b9Sdrh             Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2480cfbb5e82Sdan             Expr *pRhs = pEList->a[i].pExpr;
2481cfbb5e82Sdan             CollSeq *pReq = sqlite3BinaryCompareCollSeq(pParse, pLhs, pRhs);
2482cfbb5e82Sdan             int j;
2483cfbb5e82Sdan 
24846fc8f364Sdrh             assert( pReq!=0 || pRhs->iColumn==XN_ROWID || pParse->nErr );
2485cfbb5e82Sdan             for(j=0; j<nExpr; j++){
2486cfbb5e82Sdan               if( pIdx->aiColumn[j]!=pRhs->iColumn ) continue;
2487cfbb5e82Sdan               assert( pIdx->azColl[j] );
2488106526e1Sdrh               if( pReq!=0 && sqlite3StrICmp(pReq->zName, pIdx->azColl[j])!=0 ){
2489106526e1Sdrh                 continue;
2490106526e1Sdrh               }
2491cfbb5e82Sdan               break;
2492cfbb5e82Sdan             }
2493cfbb5e82Sdan             if( j==nExpr ) break;
2494a84a283dSdrh             mCol = MASKBIT(j);
2495a84a283dSdrh             if( mCol & colUsed ) break; /* Each column used only once */
2496a84a283dSdrh             colUsed |= mCol;
2497ba00e30aSdan             if( aiMap ) aiMap[i] = j;
2498cfbb5e82Sdan           }
2499cfbb5e82Sdan 
2500a84a283dSdrh           assert( i==nExpr || colUsed!=(MASKBIT(nExpr)-1) );
2501a84a283dSdrh           if( colUsed==(MASKBIT(nExpr)-1) ){
2502a84a283dSdrh             /* If we reach this point, that means the index pIdx is usable */
2503511f9e8dSdrh             int iAddr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
2504e2ca99c9Sdrh             ExplainQueryPlan((pParse, 0,
2505e2ca99c9Sdrh                               "USING INDEX %s FOR IN-OPERATOR",pIdx->zName));
25062ec2fb22Sdrh             sqlite3VdbeAddOp3(v, OP_OpenRead, iTab, pIdx->tnum, iDb);
25072ec2fb22Sdrh             sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
2508207872a4Sdanielk1977             VdbeComment((v, "%s", pIdx->zName));
25091ccce449Sdrh             assert( IN_INDEX_INDEX_DESC == IN_INDEX_INDEX_ASC+1 );
25101ccce449Sdrh             eType = IN_INDEX_INDEX_ASC + pIdx->aSortOrder[0];
25119a96b668Sdanielk1977 
25127b35a77bSdan             if( prRhsHasNull ){
25133480bfdaSdan #ifdef SQLITE_ENABLE_COLUMN_USED_MASK
2514cfbb5e82Sdan               i64 mask = (1<<nExpr)-1;
25153480bfdaSdan               sqlite3VdbeAddOp4Dup8(v, OP_ColumnsUsed,
2516cfbb5e82Sdan                   iTab, 0, 0, (u8*)&mask, P4_INT64);
25173480bfdaSdan #endif
2518b80dbdc2Sdrh               *prRhsHasNull = ++pParse->nMem;
25197b35a77bSdan               if( nExpr==1 ){
25206be515ebSdrh                 sqlite3SetHasNullFlag(v, iTab, *prRhsHasNull);
25210cdc022eSdanielk1977               }
25227b35a77bSdan             }
2523552fd454Sdrh             sqlite3VdbeJumpHere(v, iAddr);
25249a96b668Sdanielk1977           }
2525a84a283dSdrh         } /* End loop over indexes */
2526a84a283dSdrh       } /* End if( affinity_ok ) */
2527a84a283dSdrh     } /* End if not an rowid index */
2528a84a283dSdrh   } /* End attempt to optimize using an index */
25299a96b668Sdanielk1977 
2530bb53ecb1Sdrh   /* If no preexisting index is available for the IN clause
2531bb53ecb1Sdrh   ** and IN_INDEX_NOOP is an allowed reply
2532bb53ecb1Sdrh   ** and the RHS of the IN operator is a list, not a subquery
253371c57db0Sdan   ** and the RHS is not constant or has two or fewer terms,
253460ec914cSpeter.d.reid   ** then it is not worth creating an ephemeral table to evaluate
2535bb53ecb1Sdrh   ** the IN operator so return IN_INDEX_NOOP.
2536bb53ecb1Sdrh   */
2537bb53ecb1Sdrh   if( eType==0
2538bb53ecb1Sdrh    && (inFlags & IN_INDEX_NOOP_OK)
2539bb53ecb1Sdrh    && !ExprHasProperty(pX, EP_xIsSelect)
2540bb53ecb1Sdrh    && (!sqlite3InRhsIsConstant(pX) || pX->x.pList->nExpr<=2)
2541bb53ecb1Sdrh   ){
2542bb53ecb1Sdrh     eType = IN_INDEX_NOOP;
2543bb53ecb1Sdrh   }
2544bb53ecb1Sdrh 
25459a96b668Sdanielk1977   if( eType==0 ){
25464387006cSdrh     /* Could not find an existing table or index to use as the RHS b-tree.
2547b74b1017Sdrh     ** We will have to generate an ephemeral table to do the job.
2548b74b1017Sdrh     */
25498e23daf3Sdrh     u32 savedNQueryLoop = pParse->nQueryLoop;
25500cdc022eSdanielk1977     int rMayHaveNull = 0;
255141a05b7bSdanielk1977     eType = IN_INDEX_EPH;
25523a85625dSdrh     if( inFlags & IN_INDEX_LOOP ){
25534a5acf8eSdrh       pParse->nQueryLoop = 0;
2554c5cd1249Sdrh       if( pX->pLeft->iColumn<0 && !ExprHasProperty(pX, EP_xIsSelect) ){
255541a05b7bSdanielk1977         eType = IN_INDEX_ROWID;
25560cdc022eSdanielk1977       }
2557e21a6e1dSdrh     }else if( prRhsHasNull ){
2558e21a6e1dSdrh       *prRhsHasNull = rMayHaveNull = ++pParse->nMem;
2559cf4d38aaSdrh     }
256085bcdce2Sdrh     assert( pX->op==TK_IN );
25612c04131cSdrh     sqlite3CodeRhsOfIN(pParse, pX, iTab, eType==IN_INDEX_ROWID);
256285bcdce2Sdrh     if( rMayHaveNull ){
25632c04131cSdrh       sqlite3SetHasNullFlag(v, iTab, rMayHaveNull);
256485bcdce2Sdrh     }
2565cf4d38aaSdrh     pParse->nQueryLoop = savedNQueryLoop;
25669a96b668Sdanielk1977   }
2567ba00e30aSdan 
2568ba00e30aSdan   if( aiMap && eType!=IN_INDEX_INDEX_ASC && eType!=IN_INDEX_INDEX_DESC ){
2569ba00e30aSdan     int i, n;
2570ba00e30aSdan     n = sqlite3ExprVectorSize(pX->pLeft);
2571ba00e30aSdan     for(i=0; i<n; i++) aiMap[i] = i;
2572ba00e30aSdan   }
25732c04131cSdrh   *piTab = iTab;
25749a96b668Sdanielk1977   return eType;
25759a96b668Sdanielk1977 }
2576284f4acaSdanielk1977 #endif
2577626a879aSdrh 
2578f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
2579553168c7Sdan /*
2580553168c7Sdan ** Argument pExpr is an (?, ?...) IN(...) expression. This
2581553168c7Sdan ** function allocates and returns a nul-terminated string containing
2582553168c7Sdan ** the affinities to be used for each column of the comparison.
2583553168c7Sdan **
2584553168c7Sdan ** It is the responsibility of the caller to ensure that the returned
2585553168c7Sdan ** string is eventually freed using sqlite3DbFree().
2586553168c7Sdan */
258771c57db0Sdan static char *exprINAffinity(Parse *pParse, Expr *pExpr){
258871c57db0Sdan   Expr *pLeft = pExpr->pLeft;
258971c57db0Sdan   int nVal = sqlite3ExprVectorSize(pLeft);
2590553168c7Sdan   Select *pSelect = (pExpr->flags & EP_xIsSelect) ? pExpr->x.pSelect : 0;
259171c57db0Sdan   char *zRet;
259271c57db0Sdan 
2593553168c7Sdan   assert( pExpr->op==TK_IN );
25945c258dc1Sdrh   zRet = sqlite3DbMallocRaw(pParse->db, nVal+1);
259571c57db0Sdan   if( zRet ){
259671c57db0Sdan     int i;
259771c57db0Sdan     for(i=0; i<nVal; i++){
2598fc7f27b9Sdrh       Expr *pA = sqlite3VectorFieldSubexpr(pLeft, i);
2599553168c7Sdan       char a = sqlite3ExprAffinity(pA);
2600553168c7Sdan       if( pSelect ){
2601553168c7Sdan         zRet[i] = sqlite3CompareAffinity(pSelect->pEList->a[i].pExpr, a);
260271c57db0Sdan       }else{
2603553168c7Sdan         zRet[i] = a;
260471c57db0Sdan       }
260571c57db0Sdan     }
260671c57db0Sdan     zRet[nVal] = '\0';
260771c57db0Sdan   }
260871c57db0Sdan   return zRet;
260971c57db0Sdan }
2610f9b2e05cSdan #endif
261171c57db0Sdan 
26128da209b1Sdan #ifndef SQLITE_OMIT_SUBQUERY
26138da209b1Sdan /*
26148da209b1Sdan ** Load the Parse object passed as the first argument with an error
26158da209b1Sdan ** message of the form:
26168da209b1Sdan **
26178da209b1Sdan **   "sub-select returns N columns - expected M"
26188da209b1Sdan */
26198da209b1Sdan void sqlite3SubselectError(Parse *pParse, int nActual, int nExpect){
26208da209b1Sdan   const char *zFmt = "sub-select returns %d columns - expected %d";
26218da209b1Sdan   sqlite3ErrorMsg(pParse, zFmt, nActual, nExpect);
26228da209b1Sdan }
26238da209b1Sdan #endif
26248da209b1Sdan 
2625626a879aSdrh /*
262644c5604cSdan ** Expression pExpr is a vector that has been used in a context where
262744c5604cSdan ** it is not permitted. If pExpr is a sub-select vector, this routine
262844c5604cSdan ** loads the Parse object with a message of the form:
262944c5604cSdan **
263044c5604cSdan **   "sub-select returns N columns - expected 1"
263144c5604cSdan **
263244c5604cSdan ** Or, if it is a regular scalar vector:
263344c5604cSdan **
263444c5604cSdan **   "row value misused"
263544c5604cSdan */
263644c5604cSdan void sqlite3VectorErrorMsg(Parse *pParse, Expr *pExpr){
263744c5604cSdan #ifndef SQLITE_OMIT_SUBQUERY
263844c5604cSdan   if( pExpr->flags & EP_xIsSelect ){
263944c5604cSdan     sqlite3SubselectError(pParse, pExpr->x.pSelect->pEList->nExpr, 1);
264044c5604cSdan   }else
264144c5604cSdan #endif
264244c5604cSdan   {
264344c5604cSdan     sqlite3ErrorMsg(pParse, "row value misused");
264444c5604cSdan   }
264544c5604cSdan }
264644c5604cSdan 
264785bcdce2Sdrh #ifndef SQLITE_OMIT_SUBQUERY
264844c5604cSdan /*
264985bcdce2Sdrh ** Generate code that will construct an ephemeral table containing all terms
265085bcdce2Sdrh ** in the RHS of an IN operator.  The IN operator can be in either of two
265185bcdce2Sdrh ** forms:
2652626a879aSdrh **
26539cbe6352Sdrh **     x IN (4,5,11)              -- IN operator with list on right-hand side
26549cbe6352Sdrh **     x IN (SELECT a FROM b)     -- IN operator with subquery on the right
2655fef5208cSdrh **
26562c04131cSdrh ** The pExpr parameter is the IN operator.  The cursor number for the
26572c04131cSdrh ** constructed ephermeral table is returned.  The first time the ephemeral
26582c04131cSdrh ** table is computed, the cursor number is also stored in pExpr->iTable,
26592c04131cSdrh ** however the cursor number returned might not be the same, as it might
26602c04131cSdrh ** have been duplicated using OP_OpenDup.
266141a05b7bSdanielk1977 **
266285bcdce2Sdrh ** If parameter isRowid is non-zero, then LHS of the IN operator is guaranteed
266385bcdce2Sdrh ** to be a non-null integer. In this case, the ephemeral table can be an
266485bcdce2Sdrh ** table B-Tree that keyed by only integers.  The more general cases uses
266585bcdce2Sdrh ** an index B-Tree which can have arbitrary keys, but is slower to both
266685bcdce2Sdrh ** read and write.
2667fd773cf9Sdrh **
266885bcdce2Sdrh ** If the LHS expression ("x" in the examples) is a column value, or
266985bcdce2Sdrh ** the SELECT statement returns a column value, then the affinity of that
267085bcdce2Sdrh ** column is used to build the index keys. If both 'x' and the
267185bcdce2Sdrh ** SELECT... statement are columns, then numeric affinity is used
267285bcdce2Sdrh ** if either column has NUMERIC or INTEGER affinity. If neither
267385bcdce2Sdrh ** 'x' nor the SELECT... statement are columns, then numeric affinity
267485bcdce2Sdrh ** is used.
2675cce7d176Sdrh */
267685bcdce2Sdrh void sqlite3CodeRhsOfIN(
2677fd773cf9Sdrh   Parse *pParse,          /* Parsing context */
267885bcdce2Sdrh   Expr *pExpr,            /* The IN operator */
26792c04131cSdrh   int iTab,               /* Use this cursor number */
268085bcdce2Sdrh   int isRowid             /* If true, LHS is a rowid */
268141a05b7bSdanielk1977 ){
26822c04131cSdrh   int addrOnce = 0;           /* Address of the OP_Once instruction at top */
268385bcdce2Sdrh   int addr;                   /* Address of OP_OpenEphemeral instruction */
268485bcdce2Sdrh   Expr *pLeft;                /* the LHS of the IN operator */
268585bcdce2Sdrh   KeyInfo *pKeyInfo = 0;      /* Key information */
268685bcdce2Sdrh   int nVal;                   /* Size of vector pLeft */
268785bcdce2Sdrh   Vdbe *v;                    /* The prepared statement under construction */
2688fc976065Sdanielk1977 
26892c04131cSdrh   v = pParse->pVdbe;
269085bcdce2Sdrh   assert( v!=0 );
269185bcdce2Sdrh 
26922c04131cSdrh   /* The evaluation of the IN must be repeated every time it
269339a11819Sdrh   ** is encountered if any of the following is true:
269457dbd7b3Sdrh   **
269557dbd7b3Sdrh   **    *  The right-hand side is a correlated subquery
269657dbd7b3Sdrh   **    *  The right-hand side is an expression list containing variables
269757dbd7b3Sdrh   **    *  We are inside a trigger
269857dbd7b3Sdrh   **
26992c04131cSdrh   ** If all of the above are false, then we can compute the RHS just once
27002c04131cSdrh   ** and reuse it many names.
2701b3bce662Sdanielk1977   */
2702efb699fcSdrh   if( !ExprHasProperty(pExpr, EP_VarSelect) && pParse->iSelfTab==0 ){
27032c04131cSdrh     /* Reuse of the RHS is allowed */
27042c04131cSdrh     /* If this routine has already been coded, but the previous code
27052c04131cSdrh     ** might not have been invoked yet, so invoke it now as a subroutine.
27062c04131cSdrh     */
27072c04131cSdrh     if( ExprHasProperty(pExpr, EP_Subrtn) ){
2708f9231c34Sdrh       addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
2709bd462bccSdrh       if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2710bd462bccSdrh         ExplainQueryPlan((pParse, 0, "REUSE LIST SUBQUERY %d",
2711bd462bccSdrh               pExpr->x.pSelect->selId));
2712bd462bccSdrh       }
27132c04131cSdrh       sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
27142c04131cSdrh                         pExpr->y.sub.iAddr);
27152c04131cSdrh       sqlite3VdbeAddOp2(v, OP_OpenDup, iTab, pExpr->iTable);
2716f9231c34Sdrh       sqlite3VdbeJumpHere(v, addrOnce);
27172c04131cSdrh       return;
27182c04131cSdrh     }
27192c04131cSdrh 
27202c04131cSdrh     /* Begin coding the subroutine */
27212c04131cSdrh     ExprSetProperty(pExpr, EP_Subrtn);
27222c04131cSdrh     pExpr->y.sub.regReturn = ++pParse->nMem;
27232c04131cSdrh     pExpr->y.sub.iAddr =
27242c04131cSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 0, pExpr->y.sub.regReturn) + 1;
27252c04131cSdrh     VdbeComment((v, "return address"));
27262c04131cSdrh 
27272c04131cSdrh     addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
2728b3bce662Sdanielk1977   }
2729b3bce662Sdanielk1977 
273085bcdce2Sdrh   /* Check to see if this is a vector IN operator */
273185bcdce2Sdrh   pLeft = pExpr->pLeft;
273271c57db0Sdan   nVal = sqlite3ExprVectorSize(pLeft);
2733553168c7Sdan   assert( !isRowid || nVal==1 );
2734e014a838Sdanielk1977 
273585bcdce2Sdrh   /* Construct the ephemeral table that will contain the content of
273685bcdce2Sdrh   ** RHS of the IN operator.
2737fef5208cSdrh   */
27382c04131cSdrh   pExpr->iTable = iTab;
273971c57db0Sdan   addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral,
274071c57db0Sdan       pExpr->iTable, (isRowid?0:nVal));
27412c04131cSdrh #ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
27422c04131cSdrh   if( ExprHasProperty(pExpr, EP_xIsSelect) ){
27432c04131cSdrh     VdbeComment((v, "Result of SELECT %u", pExpr->x.pSelect->selId));
27442c04131cSdrh   }else{
27452c04131cSdrh     VdbeComment((v, "RHS of IN operator"));
27462c04131cSdrh   }
27472c04131cSdrh #endif
274871c57db0Sdan   pKeyInfo = isRowid ? 0 : sqlite3KeyInfoAlloc(pParse->db, nVal, 1);
2749e014a838Sdanielk1977 
27506ab3a2ecSdanielk1977   if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2751e014a838Sdanielk1977     /* Case 1:     expr IN (SELECT ...)
2752e014a838Sdanielk1977     **
2753e014a838Sdanielk1977     ** Generate code to write the results of the select into the temporary
2754e014a838Sdanielk1977     ** table allocated and opened above.
2755e014a838Sdanielk1977     */
27564387006cSdrh     Select *pSelect = pExpr->x.pSelect;
275771c57db0Sdan     ExprList *pEList = pSelect->pEList;
27581013c932Sdrh 
27592c04131cSdrh     ExplainQueryPlan((pParse, 1, "%sLIST SUBQUERY %d",
27602c04131cSdrh         addrOnce?"":"CORRELATED ", pSelect->selId
2761e2ca99c9Sdrh     ));
276241a05b7bSdanielk1977     assert( !isRowid );
276364bcb8cfSdrh     /* If the LHS and RHS of the IN operator do not match, that
276464bcb8cfSdrh     ** error will have been caught long before we reach this point. */
276564bcb8cfSdrh     if( ALWAYS(pEList->nExpr==nVal) ){
276671c57db0Sdan       SelectDest dest;
276771c57db0Sdan       int i;
2768bd462bccSdrh       sqlite3SelectDestInit(&dest, SRT_Set, iTab);
276971c57db0Sdan       dest.zAffSdst = exprINAffinity(pParse, pExpr);
27704387006cSdrh       pSelect->iLimit = 0;
27714387006cSdrh       testcase( pSelect->selFlags & SF_Distinct );
2772812ea833Sdrh       testcase( pKeyInfo==0 ); /* Caused by OOM in sqlite3KeyInfoAlloc() */
27734387006cSdrh       if( sqlite3Select(pParse, pSelect, &dest) ){
277471c57db0Sdan         sqlite3DbFree(pParse->db, dest.zAffSdst);
27752ec2fb22Sdrh         sqlite3KeyInfoUnref(pKeyInfo);
277685bcdce2Sdrh         return;
277794ccde58Sdrh       }
277871c57db0Sdan       sqlite3DbFree(pParse->db, dest.zAffSdst);
2779812ea833Sdrh       assert( pKeyInfo!=0 ); /* OOM will cause exit after sqlite3Select() */
27803535ec3eSdrh       assert( pEList!=0 );
27813535ec3eSdrh       assert( pEList->nExpr>0 );
27822ec2fb22Sdrh       assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
278371c57db0Sdan       for(i=0; i<nVal; i++){
2784773d3afaSdan         Expr *p = sqlite3VectorFieldSubexpr(pLeft, i);
278571c57db0Sdan         pKeyInfo->aColl[i] = sqlite3BinaryCompareCollSeq(
278671c57db0Sdan             pParse, p, pEList->a[i].pExpr
278771c57db0Sdan         );
278871c57db0Sdan       }
278971c57db0Sdan     }
2790a7d2db17Sdrh   }else if( ALWAYS(pExpr->x.pList!=0) ){
2791fef5208cSdrh     /* Case 2:     expr IN (exprlist)
2792fef5208cSdrh     **
2793e014a838Sdanielk1977     ** For each expression, build an index key from the evaluation and
2794e014a838Sdanielk1977     ** store it in the temporary table. If <expr> is a column, then use
2795e014a838Sdanielk1977     ** that columns affinity when building index keys. If <expr> is not
2796e014a838Sdanielk1977     ** a column, use numeric affinity.
2797fef5208cSdrh     */
279871c57db0Sdan     char affinity;            /* Affinity of the LHS of the IN */
2799e014a838Sdanielk1977     int i;
28006ab3a2ecSdanielk1977     ExprList *pList = pExpr->x.pList;
280157dbd7b3Sdrh     struct ExprList_item *pItem;
2802ecc31805Sdrh     int r1, r2, r3;
280371c57db0Sdan     affinity = sqlite3ExprAffinity(pLeft);
2804e014a838Sdanielk1977     if( !affinity ){
280505883a34Sdrh       affinity = SQLITE_AFF_BLOB;
2806e014a838Sdanielk1977     }
2807323df790Sdrh     if( pKeyInfo ){
28082ec2fb22Sdrh       assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
2809323df790Sdrh       pKeyInfo->aColl[0] = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
2810323df790Sdrh     }
2811e014a838Sdanielk1977 
2812e014a838Sdanielk1977     /* Loop through each expression in <exprlist>. */
28132d401ab8Sdrh     r1 = sqlite3GetTempReg(pParse);
28142d401ab8Sdrh     r2 = sqlite3GetTempReg(pParse);
281521cd29abSdan     if( isRowid ) sqlite3VdbeAddOp4(v, OP_Blob, 0, r2, 0, "", P4_STATIC);
281657dbd7b3Sdrh     for(i=pList->nExpr, pItem=pList->a; i>0; i--, pItem++){
281757dbd7b3Sdrh       Expr *pE2 = pItem->pExpr;
2818e05c929bSdrh       int iValToIns;
2819e014a838Sdanielk1977 
282057dbd7b3Sdrh       /* If the expression is not constant then we will need to
282157dbd7b3Sdrh       ** disable the test that was generated above that makes sure
282257dbd7b3Sdrh       ** this code only executes once.  Because for a non-constant
282357dbd7b3Sdrh       ** expression we need to rerun this code each time.
282457dbd7b3Sdrh       */
28252c04131cSdrh       if( addrOnce && !sqlite3ExprIsConstant(pE2) ){
28262c04131cSdrh         sqlite3VdbeChangeToNoop(v, addrOnce);
28272c04131cSdrh         addrOnce = 0;
28284794b980Sdrh       }
2829e014a838Sdanielk1977 
2830e014a838Sdanielk1977       /* Evaluate the expression and insert it into the temp table */
2831e05c929bSdrh       if( isRowid && sqlite3ExprIsInteger(pE2, &iValToIns) ){
2832bd462bccSdrh         sqlite3VdbeAddOp3(v, OP_InsertInt, iTab, r2, iValToIns);
2833e05c929bSdrh       }else{
2834ecc31805Sdrh         r3 = sqlite3ExprCodeTarget(pParse, pE2, r1);
283541a05b7bSdanielk1977         if( isRowid ){
2836e05c929bSdrh           sqlite3VdbeAddOp2(v, OP_MustBeInt, r3,
2837e05c929bSdrh                             sqlite3VdbeCurrentAddr(v)+2);
2838688852abSdrh           VdbeCoverage(v);
2839bd462bccSdrh           sqlite3VdbeAddOp3(v, OP_Insert, iTab, r2, r3);
284041a05b7bSdanielk1977         }else{
2841ecc31805Sdrh           sqlite3VdbeAddOp4(v, OP_MakeRecord, r3, 1, r2, &affinity, 1);
2842bd462bccSdrh           sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iTab, r2, r3, 1);
2843fef5208cSdrh         }
284441a05b7bSdanielk1977       }
2845e05c929bSdrh     }
28462d401ab8Sdrh     sqlite3ReleaseTempReg(pParse, r1);
28472d401ab8Sdrh     sqlite3ReleaseTempReg(pParse, r2);
2848fef5208cSdrh   }
2849323df790Sdrh   if( pKeyInfo ){
28502ec2fb22Sdrh     sqlite3VdbeChangeP4(v, addr, (void *)pKeyInfo, P4_KEYINFO);
285141a05b7bSdanielk1977   }
28522c04131cSdrh   if( addrOnce ){
28532c04131cSdrh     sqlite3VdbeJumpHere(v, addrOnce);
28542c04131cSdrh     /* Subroutine return */
28552c04131cSdrh     sqlite3VdbeAddOp1(v, OP_Return, pExpr->y.sub.regReturn);
28562c04131cSdrh     sqlite3VdbeChangeP1(v, pExpr->y.sub.iAddr-1, sqlite3VdbeCurrentAddr(v)-1);
285785bcdce2Sdrh   }
285885bcdce2Sdrh }
285985bcdce2Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
286085bcdce2Sdrh 
286185bcdce2Sdrh /*
286285bcdce2Sdrh ** Generate code for scalar subqueries used as a subquery expression
286385bcdce2Sdrh ** or EXISTS operator:
286485bcdce2Sdrh **
286585bcdce2Sdrh **     (SELECT a FROM b)          -- subquery
286685bcdce2Sdrh **     EXISTS (SELECT a FROM b)   -- EXISTS subquery
286785bcdce2Sdrh **
286885bcdce2Sdrh ** The pExpr parameter is the SELECT or EXISTS operator to be coded.
286985bcdce2Sdrh **
287085bcdce2Sdrh ** The register that holds the result.  For a multi-column SELECT,
287185bcdce2Sdrh ** the result is stored in a contiguous array of registers and the
287285bcdce2Sdrh ** return value is the register of the left-most result column.
287385bcdce2Sdrh ** Return 0 if an error occurs.
287485bcdce2Sdrh */
287585bcdce2Sdrh #ifndef SQLITE_OMIT_SUBQUERY
287685bcdce2Sdrh int sqlite3CodeSubselect(Parse *pParse, Expr *pExpr){
28772c04131cSdrh   int addrOnce = 0;           /* Address of OP_Once at top of subroutine */
287885bcdce2Sdrh   int rReg = 0;               /* Register storing resulting */
287985bcdce2Sdrh   Select *pSel;               /* SELECT statement to encode */
288085bcdce2Sdrh   SelectDest dest;            /* How to deal with SELECT result */
288185bcdce2Sdrh   int nReg;                   /* Registers to allocate */
288285bcdce2Sdrh   Expr *pLimit;               /* New limit expression */
28832c04131cSdrh 
28842c04131cSdrh   Vdbe *v = pParse->pVdbe;
288585bcdce2Sdrh   assert( v!=0 );
2886bd462bccSdrh   testcase( pExpr->op==TK_EXISTS );
2887bd462bccSdrh   testcase( pExpr->op==TK_SELECT );
2888bd462bccSdrh   assert( pExpr->op==TK_EXISTS || pExpr->op==TK_SELECT );
2889bd462bccSdrh   assert( ExprHasProperty(pExpr, EP_xIsSelect) );
2890bd462bccSdrh   pSel = pExpr->x.pSelect;
289185bcdce2Sdrh 
28925198ff57Sdrh   /* The evaluation of the EXISTS/SELECT must be repeated every time it
289385bcdce2Sdrh   ** is encountered if any of the following is true:
289485bcdce2Sdrh   **
289585bcdce2Sdrh   **    *  The right-hand side is a correlated subquery
289685bcdce2Sdrh   **    *  The right-hand side is an expression list containing variables
289785bcdce2Sdrh   **    *  We are inside a trigger
289885bcdce2Sdrh   **
289985bcdce2Sdrh   ** If all of the above are false, then we can run this code just once
290085bcdce2Sdrh   ** save the results, and reuse the same result on subsequent invocations.
290185bcdce2Sdrh   */
290285bcdce2Sdrh   if( !ExprHasProperty(pExpr, EP_VarSelect) ){
29035198ff57Sdrh     /* If this routine has already been coded, then invoke it as a
29045198ff57Sdrh     ** subroutine. */
29055198ff57Sdrh     if( ExprHasProperty(pExpr, EP_Subrtn) ){
2906bd462bccSdrh       ExplainQueryPlan((pParse, 0, "REUSE SUBQUERY %d", pSel->selId));
29075198ff57Sdrh       sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
29085198ff57Sdrh                         pExpr->y.sub.iAddr);
29095198ff57Sdrh       return pExpr->iTable;
29105198ff57Sdrh     }
29115198ff57Sdrh 
29125198ff57Sdrh     /* Begin coding the subroutine */
29135198ff57Sdrh     ExprSetProperty(pExpr, EP_Subrtn);
29145198ff57Sdrh     pExpr->y.sub.regReturn = ++pParse->nMem;
29155198ff57Sdrh     pExpr->y.sub.iAddr =
29165198ff57Sdrh       sqlite3VdbeAddOp2(v, OP_Integer, 0, pExpr->y.sub.regReturn) + 1;
29175198ff57Sdrh     VdbeComment((v, "return address"));
29185198ff57Sdrh 
29192c04131cSdrh     addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
2920fef5208cSdrh   }
2921fef5208cSdrh 
292285bcdce2Sdrh   /* For a SELECT, generate code to put the values for all columns of
292339a11819Sdrh   ** the first row into an array of registers and return the index of
292439a11819Sdrh   ** the first register.
292539a11819Sdrh   **
292639a11819Sdrh   ** If this is an EXISTS, write an integer 0 (not exists) or 1 (exists)
292739a11819Sdrh   ** into a register and return that register number.
292839a11819Sdrh   **
292939a11819Sdrh   ** In both cases, the query is augmented with "LIMIT 1".  Any
293039a11819Sdrh   ** preexisting limit is discarded in place of the new LIMIT 1.
2931fef5208cSdrh   */
2932bd462bccSdrh   ExplainQueryPlan((pParse, 1, "%sSCALAR SUBQUERY %d",
2933bd462bccSdrh         addrOnce?"":"CORRELATED ", pSel->selId));
293471c57db0Sdan   nReg = pExpr->op==TK_SELECT ? pSel->pEList->nExpr : 1;
293571c57db0Sdan   sqlite3SelectDestInit(&dest, 0, pParse->nMem+1);
293671c57db0Sdan   pParse->nMem += nReg;
293751522cd3Sdrh   if( pExpr->op==TK_SELECT ){
29386c8c8ce0Sdanielk1977     dest.eDest = SRT_Mem;
293953932ce8Sdrh     dest.iSdst = dest.iSDParm;
294071c57db0Sdan     dest.nSdst = nReg;
294171c57db0Sdan     sqlite3VdbeAddOp3(v, OP_Null, 0, dest.iSDParm, dest.iSDParm+nReg-1);
2942d4e70ebdSdrh     VdbeComment((v, "Init subquery result"));
294351522cd3Sdrh   }else{
29446c8c8ce0Sdanielk1977     dest.eDest = SRT_Exists;
29452b596da8Sdrh     sqlite3VdbeAddOp2(v, OP_Integer, 0, dest.iSDParm);
2946d4e70ebdSdrh     VdbeComment((v, "Init EXISTS result"));
294751522cd3Sdrh   }
29488c0833fbSdrh   pLimit = sqlite3ExprAlloc(pParse->db, TK_INTEGER,&sqlite3IntTokens[1], 0);
29498c0833fbSdrh   if( pSel->pLimit ){
29508c0833fbSdrh     sqlite3ExprDelete(pParse->db, pSel->pLimit->pLeft);
29518c0833fbSdrh     pSel->pLimit->pLeft = pLimit;
29528c0833fbSdrh   }else{
29538c0833fbSdrh     pSel->pLimit = sqlite3PExpr(pParse, TK_LIMIT, pLimit, 0);
29548c0833fbSdrh   }
295548b5b041Sdrh   pSel->iLimit = 0;
29567d10d5a6Sdrh   if( sqlite3Select(pParse, pSel, &dest) ){
29571450bc6eSdrh     return 0;
295894ccde58Sdrh   }
29592c04131cSdrh   pExpr->iTable = rReg = dest.iSDParm;
2960ebb6a65dSdrh   ExprSetVVAProperty(pExpr, EP_NoReduce);
29612c04131cSdrh   if( addrOnce ){
29622c04131cSdrh     sqlite3VdbeJumpHere(v, addrOnce);
2963fc976065Sdanielk1977 
29642c04131cSdrh     /* Subroutine return */
29652c04131cSdrh     sqlite3VdbeAddOp1(v, OP_Return, pExpr->y.sub.regReturn);
29662c04131cSdrh     sqlite3VdbeChangeP1(v, pExpr->y.sub.iAddr-1, sqlite3VdbeCurrentAddr(v)-1);
29675198ff57Sdrh   }
29682c04131cSdrh 
29691450bc6eSdrh   return rReg;
2970cce7d176Sdrh }
297151522cd3Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
2972cce7d176Sdrh 
2973e3365e6cSdrh #ifndef SQLITE_OMIT_SUBQUERY
2974e3365e6cSdrh /*
29757b35a77bSdan ** Expr pIn is an IN(...) expression. This function checks that the
29767b35a77bSdan ** sub-select on the RHS of the IN() operator has the same number of
29777b35a77bSdan ** columns as the vector on the LHS. Or, if the RHS of the IN() is not
29787b35a77bSdan ** a sub-query, that the LHS is a vector of size 1.
29797b35a77bSdan */
29807b35a77bSdan int sqlite3ExprCheckIN(Parse *pParse, Expr *pIn){
29817b35a77bSdan   int nVector = sqlite3ExprVectorSize(pIn->pLeft);
29827b35a77bSdan   if( (pIn->flags & EP_xIsSelect) ){
29837b35a77bSdan     if( nVector!=pIn->x.pSelect->pEList->nExpr ){
29847b35a77bSdan       sqlite3SubselectError(pParse, pIn->x.pSelect->pEList->nExpr, nVector);
29857b35a77bSdan       return 1;
29867b35a77bSdan     }
29877b35a77bSdan   }else if( nVector!=1 ){
298844c5604cSdan     sqlite3VectorErrorMsg(pParse, pIn->pLeft);
29897b35a77bSdan     return 1;
29907b35a77bSdan   }
29917b35a77bSdan   return 0;
29927b35a77bSdan }
29937b35a77bSdan #endif
29947b35a77bSdan 
29957b35a77bSdan #ifndef SQLITE_OMIT_SUBQUERY
29967b35a77bSdan /*
2997e3365e6cSdrh ** Generate code for an IN expression.
2998e3365e6cSdrh **
2999e3365e6cSdrh **      x IN (SELECT ...)
3000e3365e6cSdrh **      x IN (value, value, ...)
3001e3365e6cSdrh **
3002ecb87ac8Sdrh ** The left-hand side (LHS) is a scalar or vector expression.  The
3003e347d3e8Sdrh ** right-hand side (RHS) is an array of zero or more scalar values, or a
3004e347d3e8Sdrh ** subquery.  If the RHS is a subquery, the number of result columns must
3005e347d3e8Sdrh ** match the number of columns in the vector on the LHS.  If the RHS is
3006e347d3e8Sdrh ** a list of values, the LHS must be a scalar.
3007e347d3e8Sdrh **
3008e347d3e8Sdrh ** The IN operator is true if the LHS value is contained within the RHS.
3009e347d3e8Sdrh ** The result is false if the LHS is definitely not in the RHS.  The
3010e347d3e8Sdrh ** result is NULL if the presence of the LHS in the RHS cannot be
3011e347d3e8Sdrh ** determined due to NULLs.
3012e3365e6cSdrh **
30136be515ebSdrh ** This routine generates code that jumps to destIfFalse if the LHS is not
3014e3365e6cSdrh ** contained within the RHS.  If due to NULLs we cannot determine if the LHS
3015e3365e6cSdrh ** is contained in the RHS then jump to destIfNull.  If the LHS is contained
3016e3365e6cSdrh ** within the RHS then fall through.
3017ecb87ac8Sdrh **
3018ecb87ac8Sdrh ** See the separate in-operator.md documentation file in the canonical
3019ecb87ac8Sdrh ** SQLite source tree for additional information.
3020e3365e6cSdrh */
3021e3365e6cSdrh static void sqlite3ExprCodeIN(
3022e3365e6cSdrh   Parse *pParse,        /* Parsing and code generating context */
3023e3365e6cSdrh   Expr *pExpr,          /* The IN expression */
3024e3365e6cSdrh   int destIfFalse,      /* Jump here if LHS is not contained in the RHS */
3025e3365e6cSdrh   int destIfNull        /* Jump here if the results are unknown due to NULLs */
3026e3365e6cSdrh ){
3027e3365e6cSdrh   int rRhsHasNull = 0;  /* Register that is true if RHS contains NULL values */
3028e3365e6cSdrh   int eType;            /* Type of the RHS */
3029e347d3e8Sdrh   int rLhs;             /* Register(s) holding the LHS values */
3030e347d3e8Sdrh   int rLhsOrig;         /* LHS values prior to reordering by aiMap[] */
3031e3365e6cSdrh   Vdbe *v;              /* Statement under construction */
3032ba00e30aSdan   int *aiMap = 0;       /* Map from vector field to index column */
3033ba00e30aSdan   char *zAff = 0;       /* Affinity string for comparisons */
3034ecb87ac8Sdrh   int nVector;          /* Size of vectors for this IN operator */
303512abf408Sdrh   int iDummy;           /* Dummy parameter to exprCodeVector() */
3036e347d3e8Sdrh   Expr *pLeft;          /* The LHS of the IN operator */
3037ecb87ac8Sdrh   int i;                /* loop counter */
3038e347d3e8Sdrh   int destStep2;        /* Where to jump when NULLs seen in step 2 */
3039e347d3e8Sdrh   int destStep6 = 0;    /* Start of code for Step 6 */
3040e347d3e8Sdrh   int addrTruthOp;      /* Address of opcode that determines the IN is true */
3041e347d3e8Sdrh   int destNotNull;      /* Jump here if a comparison is not true in step 6 */
3042e347d3e8Sdrh   int addrTop;          /* Top of the step-6 loop */
30432c04131cSdrh   int iTab = 0;         /* Index to use */
3044e3365e6cSdrh 
3045e347d3e8Sdrh   pLeft = pExpr->pLeft;
30467b35a77bSdan   if( sqlite3ExprCheckIN(pParse, pExpr) ) return;
3047553168c7Sdan   zAff = exprINAffinity(pParse, pExpr);
3048ba00e30aSdan   nVector = sqlite3ExprVectorSize(pExpr->pLeft);
3049ba00e30aSdan   aiMap = (int*)sqlite3DbMallocZero(
3050ba00e30aSdan       pParse->db, nVector*(sizeof(int) + sizeof(char)) + 1
3051ba00e30aSdan   );
3052e347d3e8Sdrh   if( pParse->db->mallocFailed ) goto sqlite3ExprCodeIN_oom_error;
30537b35a77bSdan 
3054ba00e30aSdan   /* Attempt to compute the RHS. After this step, if anything other than
30552c04131cSdrh   ** IN_INDEX_NOOP is returned, the table opened with cursor iTab
3056ba00e30aSdan   ** contains the values that make up the RHS. If IN_INDEX_NOOP is returned,
3057ba00e30aSdan   ** the RHS has not yet been coded.  */
3058e3365e6cSdrh   v = pParse->pVdbe;
3059e3365e6cSdrh   assert( v!=0 );       /* OOM detected prior to this routine */
3060e3365e6cSdrh   VdbeNoopComment((v, "begin IN expr"));
3061bb53ecb1Sdrh   eType = sqlite3FindInIndex(pParse, pExpr,
3062bb53ecb1Sdrh                              IN_INDEX_MEMBERSHIP | IN_INDEX_NOOP_OK,
30632c04131cSdrh                              destIfFalse==destIfNull ? 0 : &rRhsHasNull,
30642c04131cSdrh                              aiMap, &iTab);
3065e3365e6cSdrh 
3066ba00e30aSdan   assert( pParse->nErr || nVector==1 || eType==IN_INDEX_EPH
3067ba00e30aSdan        || eType==IN_INDEX_INDEX_ASC || eType==IN_INDEX_INDEX_DESC
3068ba00e30aSdan   );
3069ecb87ac8Sdrh #ifdef SQLITE_DEBUG
3070ecb87ac8Sdrh   /* Confirm that aiMap[] contains nVector integer values between 0 and
3071ecb87ac8Sdrh   ** nVector-1. */
3072ecb87ac8Sdrh   for(i=0; i<nVector; i++){
3073ecb87ac8Sdrh     int j, cnt;
3074ecb87ac8Sdrh     for(cnt=j=0; j<nVector; j++) if( aiMap[j]==i ) cnt++;
3075ecb87ac8Sdrh     assert( cnt==1 );
3076ecb87ac8Sdrh   }
3077ecb87ac8Sdrh #endif
3078e3365e6cSdrh 
3079ba00e30aSdan   /* Code the LHS, the <expr> from "<expr> IN (...)". If the LHS is a
3080ba00e30aSdan   ** vector, then it is stored in an array of nVector registers starting
3081ba00e30aSdan   ** at r1.
3082e347d3e8Sdrh   **
3083e347d3e8Sdrh   ** sqlite3FindInIndex() might have reordered the fields of the LHS vector
3084e347d3e8Sdrh   ** so that the fields are in the same order as an existing index.   The
3085e347d3e8Sdrh   ** aiMap[] array contains a mapping from the original LHS field order to
3086e347d3e8Sdrh   ** the field order that matches the RHS index.
3087e3365e6cSdrh   */
3088e347d3e8Sdrh   rLhsOrig = exprCodeVector(pParse, pLeft, &iDummy);
3089e347d3e8Sdrh   for(i=0; i<nVector && aiMap[i]==i; i++){} /* Are LHS fields reordered? */
3090ecb87ac8Sdrh   if( i==nVector ){
3091e347d3e8Sdrh     /* LHS fields are not reordered */
3092e347d3e8Sdrh     rLhs = rLhsOrig;
3093ecb87ac8Sdrh   }else{
3094ecb87ac8Sdrh     /* Need to reorder the LHS fields according to aiMap */
3095e347d3e8Sdrh     rLhs = sqlite3GetTempRange(pParse, nVector);
3096ba00e30aSdan     for(i=0; i<nVector; i++){
3097e347d3e8Sdrh       sqlite3VdbeAddOp3(v, OP_Copy, rLhsOrig+i, rLhs+aiMap[i], 0);
3098ba00e30aSdan     }
3099ecb87ac8Sdrh   }
3100e3365e6cSdrh 
3101bb53ecb1Sdrh   /* If sqlite3FindInIndex() did not find or create an index that is
3102bb53ecb1Sdrh   ** suitable for evaluating the IN operator, then evaluate using a
3103bb53ecb1Sdrh   ** sequence of comparisons.
3104e347d3e8Sdrh   **
3105e347d3e8Sdrh   ** This is step (1) in the in-operator.md optimized algorithm.
3106bb53ecb1Sdrh   */
3107bb53ecb1Sdrh   if( eType==IN_INDEX_NOOP ){
3108bb53ecb1Sdrh     ExprList *pList = pExpr->x.pList;
3109bb53ecb1Sdrh     CollSeq *pColl = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
3110ec4ccdbcSdrh     int labelOk = sqlite3VdbeMakeLabel(pParse);
3111bb53ecb1Sdrh     int r2, regToFree;
3112bb53ecb1Sdrh     int regCkNull = 0;
3113bb53ecb1Sdrh     int ii;
3114bb53ecb1Sdrh     assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
3115bb53ecb1Sdrh     if( destIfNull!=destIfFalse ){
3116bb53ecb1Sdrh       regCkNull = sqlite3GetTempReg(pParse);
3117e347d3e8Sdrh       sqlite3VdbeAddOp3(v, OP_BitAnd, rLhs, rLhs, regCkNull);
3118bb53ecb1Sdrh     }
3119bb53ecb1Sdrh     for(ii=0; ii<pList->nExpr; ii++){
3120bb53ecb1Sdrh       r2 = sqlite3ExprCodeTemp(pParse, pList->a[ii].pExpr, &regToFree);
3121a976979bSdrh       if( regCkNull && sqlite3ExprCanBeNull(pList->a[ii].pExpr) ){
3122bb53ecb1Sdrh         sqlite3VdbeAddOp3(v, OP_BitAnd, regCkNull, r2, regCkNull);
3123bb53ecb1Sdrh       }
3124bb53ecb1Sdrh       if( ii<pList->nExpr-1 || destIfNull!=destIfFalse ){
3125e347d3e8Sdrh         sqlite3VdbeAddOp4(v, OP_Eq, rLhs, labelOk, r2,
31264336b0e6Sdrh                           (void*)pColl, P4_COLLSEQ);
31274336b0e6Sdrh         VdbeCoverageIf(v, ii<pList->nExpr-1);
31284336b0e6Sdrh         VdbeCoverageIf(v, ii==pList->nExpr-1);
3129ba00e30aSdan         sqlite3VdbeChangeP5(v, zAff[0]);
3130bb53ecb1Sdrh       }else{
3131bb53ecb1Sdrh         assert( destIfNull==destIfFalse );
3132e347d3e8Sdrh         sqlite3VdbeAddOp4(v, OP_Ne, rLhs, destIfFalse, r2,
3133bb53ecb1Sdrh                           (void*)pColl, P4_COLLSEQ); VdbeCoverage(v);
3134ba00e30aSdan         sqlite3VdbeChangeP5(v, zAff[0] | SQLITE_JUMPIFNULL);
3135bb53ecb1Sdrh       }
3136bb53ecb1Sdrh       sqlite3ReleaseTempReg(pParse, regToFree);
3137bb53ecb1Sdrh     }
3138bb53ecb1Sdrh     if( regCkNull ){
3139bb53ecb1Sdrh       sqlite3VdbeAddOp2(v, OP_IsNull, regCkNull, destIfNull); VdbeCoverage(v);
3140076e85f5Sdrh       sqlite3VdbeGoto(v, destIfFalse);
3141bb53ecb1Sdrh     }
3142bb53ecb1Sdrh     sqlite3VdbeResolveLabel(v, labelOk);
3143bb53ecb1Sdrh     sqlite3ReleaseTempReg(pParse, regCkNull);
3144e347d3e8Sdrh     goto sqlite3ExprCodeIN_finished;
3145e347d3e8Sdrh   }
3146bb53ecb1Sdrh 
3147e347d3e8Sdrh   /* Step 2: Check to see if the LHS contains any NULL columns.  If the
3148e347d3e8Sdrh   ** LHS does contain NULLs then the result must be either FALSE or NULL.
3149e347d3e8Sdrh   ** We will then skip the binary search of the RHS.
3150e347d3e8Sdrh   */
3151094430ebSdrh   if( destIfNull==destIfFalse ){
3152e347d3e8Sdrh     destStep2 = destIfFalse;
3153e347d3e8Sdrh   }else{
3154ec4ccdbcSdrh     destStep2 = destStep6 = sqlite3VdbeMakeLabel(pParse);
3155e347d3e8Sdrh   }
3156d49fd4e8Sdan   for(i=0; i<nVector; i++){
3157fc7f27b9Sdrh     Expr *p = sqlite3VectorFieldSubexpr(pExpr->pLeft, i);
3158d49fd4e8Sdan     if( sqlite3ExprCanBeNull(p) ){
3159e347d3e8Sdrh       sqlite3VdbeAddOp2(v, OP_IsNull, rLhs+i, destStep2);
3160471b4b92Sdrh       VdbeCoverage(v);
3161d49fd4e8Sdan     }
3162d49fd4e8Sdan   }
3163e3365e6cSdrh 
3164e347d3e8Sdrh   /* Step 3.  The LHS is now known to be non-NULL.  Do the binary search
3165e347d3e8Sdrh   ** of the RHS using the LHS as a probe.  If found, the result is
3166e347d3e8Sdrh   ** true.
3167e347d3e8Sdrh   */
3168e3365e6cSdrh   if( eType==IN_INDEX_ROWID ){
3169e347d3e8Sdrh     /* In this case, the RHS is the ROWID of table b-tree and so we also
3170e347d3e8Sdrh     ** know that the RHS is non-NULL.  Hence, we combine steps 3 and 4
3171e347d3e8Sdrh     ** into a single opcode. */
31722c04131cSdrh     sqlite3VdbeAddOp3(v, OP_SeekRowid, iTab, destIfFalse, rLhs);
3173688852abSdrh     VdbeCoverage(v);
3174e347d3e8Sdrh     addrTruthOp = sqlite3VdbeAddOp0(v, OP_Goto);  /* Return True */
31757b35a77bSdan   }else{
3176e347d3e8Sdrh     sqlite3VdbeAddOp4(v, OP_Affinity, rLhs, nVector, 0, zAff, nVector);
3177e347d3e8Sdrh     if( destIfFalse==destIfNull ){
3178e347d3e8Sdrh       /* Combine Step 3 and Step 5 into a single opcode */
31792c04131cSdrh       sqlite3VdbeAddOp4Int(v, OP_NotFound, iTab, destIfFalse,
3180e347d3e8Sdrh                            rLhs, nVector); VdbeCoverage(v);
3181e347d3e8Sdrh       goto sqlite3ExprCodeIN_finished;
3182e347d3e8Sdrh     }
3183e347d3e8Sdrh     /* Ordinary Step 3, for the case where FALSE and NULL are distinct */
31842c04131cSdrh     addrTruthOp = sqlite3VdbeAddOp4Int(v, OP_Found, iTab, 0,
3185e347d3e8Sdrh                                       rLhs, nVector); VdbeCoverage(v);
3186e347d3e8Sdrh   }
3187ba00e30aSdan 
3188e347d3e8Sdrh   /* Step 4.  If the RHS is known to be non-NULL and we did not find
3189e347d3e8Sdrh   ** an match on the search above, then the result must be FALSE.
3190e347d3e8Sdrh   */
3191e347d3e8Sdrh   if( rRhsHasNull && nVector==1 ){
3192e347d3e8Sdrh     sqlite3VdbeAddOp2(v, OP_NotNull, rRhsHasNull, destIfFalse);
3193471b4b92Sdrh     VdbeCoverage(v);
3194e347d3e8Sdrh   }
31957b35a77bSdan 
3196e347d3e8Sdrh   /* Step 5.  If we do not care about the difference between NULL and
3197e347d3e8Sdrh   ** FALSE, then just return false.
3198e347d3e8Sdrh   */
3199e347d3e8Sdrh   if( destIfFalse==destIfNull ) sqlite3VdbeGoto(v, destIfFalse);
3200e347d3e8Sdrh 
3201e347d3e8Sdrh   /* Step 6: Loop through rows of the RHS.  Compare each row to the LHS.
3202e347d3e8Sdrh   ** If any comparison is NULL, then the result is NULL.  If all
3203e347d3e8Sdrh   ** comparisons are FALSE then the final result is FALSE.
3204e347d3e8Sdrh   **
3205e347d3e8Sdrh   ** For a scalar LHS, it is sufficient to check just the first row
3206e347d3e8Sdrh   ** of the RHS.
3207e347d3e8Sdrh   */
3208e347d3e8Sdrh   if( destStep6 ) sqlite3VdbeResolveLabel(v, destStep6);
32092c04131cSdrh   addrTop = sqlite3VdbeAddOp2(v, OP_Rewind, iTab, destIfFalse);
3210471b4b92Sdrh   VdbeCoverage(v);
3211e347d3e8Sdrh   if( nVector>1 ){
3212ec4ccdbcSdrh     destNotNull = sqlite3VdbeMakeLabel(pParse);
3213e347d3e8Sdrh   }else{
3214e347d3e8Sdrh     /* For nVector==1, combine steps 6 and 7 by immediately returning
3215e347d3e8Sdrh     ** FALSE if the first comparison is not NULL */
3216e347d3e8Sdrh     destNotNull = destIfFalse;
3217e347d3e8Sdrh   }
3218ba00e30aSdan   for(i=0; i<nVector; i++){
3219ba00e30aSdan     Expr *p;
3220ba00e30aSdan     CollSeq *pColl;
3221e347d3e8Sdrh     int r3 = sqlite3GetTempReg(pParse);
3222fc7f27b9Sdrh     p = sqlite3VectorFieldSubexpr(pLeft, i);
3223ba00e30aSdan     pColl = sqlite3ExprCollSeq(pParse, p);
32242c04131cSdrh     sqlite3VdbeAddOp3(v, OP_Column, iTab, i, r3);
3225e347d3e8Sdrh     sqlite3VdbeAddOp4(v, OP_Ne, rLhs+i, destNotNull, r3,
322618016ad2Sdrh                       (void*)pColl, P4_COLLSEQ);
3227471b4b92Sdrh     VdbeCoverage(v);
3228e347d3e8Sdrh     sqlite3ReleaseTempReg(pParse, r3);
32297b35a77bSdan   }
32307b35a77bSdan   sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfNull);
3231e347d3e8Sdrh   if( nVector>1 ){
3232e347d3e8Sdrh     sqlite3VdbeResolveLabel(v, destNotNull);
32332c04131cSdrh     sqlite3VdbeAddOp2(v, OP_Next, iTab, addrTop+1);
323418016ad2Sdrh     VdbeCoverage(v);
3235e347d3e8Sdrh 
3236e347d3e8Sdrh     /* Step 7:  If we reach this point, we know that the result must
3237e347d3e8Sdrh     ** be false. */
323818016ad2Sdrh     sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfFalse);
32397b35a77bSdan   }
32407b35a77bSdan 
3241e347d3e8Sdrh   /* Jumps here in order to return true. */
3242e347d3e8Sdrh   sqlite3VdbeJumpHere(v, addrTruthOp);
3243e3365e6cSdrh 
3244e347d3e8Sdrh sqlite3ExprCodeIN_finished:
3245e347d3e8Sdrh   if( rLhs!=rLhsOrig ) sqlite3ReleaseTempReg(pParse, rLhs);
3246ecb87ac8Sdrh   VdbeComment((v, "end IN expr"));
3247e347d3e8Sdrh sqlite3ExprCodeIN_oom_error:
3248ba00e30aSdan   sqlite3DbFree(pParse->db, aiMap);
3249553168c7Sdan   sqlite3DbFree(pParse->db, zAff);
3250e3365e6cSdrh }
3251e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
3252e3365e6cSdrh 
325313573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
3254598f1340Sdrh /*
3255598f1340Sdrh ** Generate an instruction that will put the floating point
32569cbf3425Sdrh ** value described by z[0..n-1] into register iMem.
32570cf19ed8Sdrh **
32580cf19ed8Sdrh ** The z[] string will probably not be zero-terminated.  But the
32590cf19ed8Sdrh ** z[n] character is guaranteed to be something that does not look
32600cf19ed8Sdrh ** like the continuation of the number.
3261598f1340Sdrh */
3262b7916a78Sdrh static void codeReal(Vdbe *v, const char *z, int negateFlag, int iMem){
3263fd773cf9Sdrh   if( ALWAYS(z!=0) ){
3264598f1340Sdrh     double value;
32659339da1fSdrh     sqlite3AtoF(z, &value, sqlite3Strlen30(z), SQLITE_UTF8);
3266d0015161Sdrh     assert( !sqlite3IsNaN(value) ); /* The new AtoF never returns NaN */
3267598f1340Sdrh     if( negateFlag ) value = -value;
326897bae794Sdrh     sqlite3VdbeAddOp4Dup8(v, OP_Real, 0, iMem, 0, (u8*)&value, P4_REAL);
3269598f1340Sdrh   }
3270598f1340Sdrh }
327113573c71Sdrh #endif
3272598f1340Sdrh 
3273598f1340Sdrh 
3274598f1340Sdrh /*
3275fec19aadSdrh ** Generate an instruction that will put the integer describe by
32769cbf3425Sdrh ** text z[0..n-1] into register iMem.
32770cf19ed8Sdrh **
32785f1d6b61Sshaneh ** Expr.u.zToken is always UTF8 and zero-terminated.
3279fec19aadSdrh */
328013573c71Sdrh static void codeInteger(Parse *pParse, Expr *pExpr, int negFlag, int iMem){
328113573c71Sdrh   Vdbe *v = pParse->pVdbe;
328292b01d53Sdrh   if( pExpr->flags & EP_IntValue ){
328333e619fcSdrh     int i = pExpr->u.iValue;
3284d50ffc41Sdrh     assert( i>=0 );
328592b01d53Sdrh     if( negFlag ) i = -i;
328692b01d53Sdrh     sqlite3VdbeAddOp2(v, OP_Integer, i, iMem);
3287fd773cf9Sdrh   }else{
32885f1d6b61Sshaneh     int c;
32895f1d6b61Sshaneh     i64 value;
3290fd773cf9Sdrh     const char *z = pExpr->u.zToken;
3291fd773cf9Sdrh     assert( z!=0 );
32929296c18aSdrh     c = sqlite3DecOrHexToI64(z, &value);
329384d4f1a3Sdrh     if( (c==3 && !negFlag) || (c==2) || (negFlag && value==SMALLEST_INT64)){
329413573c71Sdrh #ifdef SQLITE_OMIT_FLOATING_POINT
329513573c71Sdrh       sqlite3ErrorMsg(pParse, "oversized integer: %s%s", negFlag ? "-" : "", z);
329613573c71Sdrh #else
32971b7ddc59Sdrh #ifndef SQLITE_OMIT_HEX_INTEGER
32989296c18aSdrh       if( sqlite3_strnicmp(z,"0x",2)==0 ){
329977320ea4Sdrh         sqlite3ErrorMsg(pParse, "hex literal too big: %s%s", negFlag?"-":"",z);
33001b7ddc59Sdrh       }else
33011b7ddc59Sdrh #endif
33021b7ddc59Sdrh       {
3303b7916a78Sdrh         codeReal(v, z, negFlag, iMem);
33049296c18aSdrh       }
330513573c71Sdrh #endif
330677320ea4Sdrh     }else{
330784d4f1a3Sdrh       if( negFlag ){ value = c==3 ? SMALLEST_INT64 : -value; }
330877320ea4Sdrh       sqlite3VdbeAddOp4Dup8(v, OP_Int64, 0, iMem, 0, (u8*)&value, P4_INT64);
3309fec19aadSdrh     }
3310fec19aadSdrh   }
3311c9cf901dSdanielk1977 }
3312fec19aadSdrh 
33135cd79239Sdrh 
33141f9ca2c8Sdrh /* Generate code that will load into register regOut a value that is
33151f9ca2c8Sdrh ** appropriate for the iIdxCol-th column of index pIdx.
33161f9ca2c8Sdrh */
33171f9ca2c8Sdrh void sqlite3ExprCodeLoadIndexColumn(
33181f9ca2c8Sdrh   Parse *pParse,  /* The parsing context */
33191f9ca2c8Sdrh   Index *pIdx,    /* The index whose column is to be loaded */
33201f9ca2c8Sdrh   int iTabCur,    /* Cursor pointing to a table row */
33211f9ca2c8Sdrh   int iIdxCol,    /* The column of the index to be loaded */
33221f9ca2c8Sdrh   int regOut      /* Store the index column value in this register */
33231f9ca2c8Sdrh ){
33241f9ca2c8Sdrh   i16 iTabCol = pIdx->aiColumn[iIdxCol];
33254b92f98cSdrh   if( iTabCol==XN_EXPR ){
33261f9ca2c8Sdrh     assert( pIdx->aColExpr );
33271f9ca2c8Sdrh     assert( pIdx->aColExpr->nExpr>iIdxCol );
33283e34eabcSdrh     pParse->iSelfTab = iTabCur + 1;
33291c75c9d7Sdrh     sqlite3ExprCodeCopy(pParse, pIdx->aColExpr->a[iIdxCol].pExpr, regOut);
33303e34eabcSdrh     pParse->iSelfTab = 0;
33314b92f98cSdrh   }else{
33324b92f98cSdrh     sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pIdx->pTable, iTabCur,
33334b92f98cSdrh                                     iTabCol, regOut);
33344b92f98cSdrh   }
33351f9ca2c8Sdrh }
33361f9ca2c8Sdrh 
33375cd79239Sdrh /*
33385c092e8aSdrh ** Generate code to extract the value of the iCol-th column of a table.
33395c092e8aSdrh */
33405c092e8aSdrh void sqlite3ExprCodeGetColumnOfTable(
33415c092e8aSdrh   Vdbe *v,        /* The VDBE under construction */
33425c092e8aSdrh   Table *pTab,    /* The table containing the value */
3343313619f5Sdrh   int iTabCur,    /* The table cursor.  Or the PK cursor for WITHOUT ROWID */
33445c092e8aSdrh   int iCol,       /* Index of the column to extract */
3345313619f5Sdrh   int regOut      /* Extract the value into this register */
33465c092e8aSdrh ){
3347aca19e19Sdrh   if( pTab==0 ){
3348aca19e19Sdrh     sqlite3VdbeAddOp3(v, OP_Column, iTabCur, iCol, regOut);
3349aca19e19Sdrh     return;
3350aca19e19Sdrh   }
33515c092e8aSdrh   if( iCol<0 || iCol==pTab->iPKey ){
33525c092e8aSdrh     sqlite3VdbeAddOp2(v, OP_Rowid, iTabCur, regOut);
33535c092e8aSdrh   }else{
33545c092e8aSdrh     int op = IsVirtual(pTab) ? OP_VColumn : OP_Column;
3355ee0ec8e1Sdrh     int x = iCol;
335635db31b2Sdrh     if( !HasRowid(pTab) && !IsVirtual(pTab) ){
3357ee0ec8e1Sdrh       x = sqlite3ColumnOfIndex(sqlite3PrimaryKeyIndex(pTab), iCol);
3358ee0ec8e1Sdrh     }
3359ee0ec8e1Sdrh     sqlite3VdbeAddOp3(v, op, iTabCur, x, regOut);
33605c092e8aSdrh   }
33615c092e8aSdrh   if( iCol>=0 ){
33625c092e8aSdrh     sqlite3ColumnDefault(v, pTab, iCol, regOut);
33635c092e8aSdrh   }
33645c092e8aSdrh }
33655c092e8aSdrh 
33665c092e8aSdrh /*
3367945498f3Sdrh ** Generate code that will extract the iColumn-th column from
33688c607191Sdrh ** table pTab and store the column value in register iReg.
3369e55cbd72Sdrh **
3370e55cbd72Sdrh ** There must be an open cursor to pTab in iTable when this routine
3371e55cbd72Sdrh ** is called.  If iColumn<0 then code is generated that extracts the rowid.
3372945498f3Sdrh */
3373e55cbd72Sdrh int sqlite3ExprCodeGetColumn(
3374e55cbd72Sdrh   Parse *pParse,   /* Parsing and code generating context */
33752133d822Sdrh   Table *pTab,     /* Description of the table we are reading from */
33762133d822Sdrh   int iColumn,     /* Index of the table column */
33772133d822Sdrh   int iTable,      /* The cursor pointing to the table */
3378a748fdccSdrh   int iReg,        /* Store results here */
3379ce78bc6eSdrh   u8 p5            /* P5 value for OP_Column + FLAGS */
33802133d822Sdrh ){
3381e55cbd72Sdrh   Vdbe *v = pParse->pVdbe;
3382e55cbd72Sdrh   assert( v!=0 );
33835c092e8aSdrh   sqlite3ExprCodeGetColumnOfTable(v, pTab, iTable, iColumn, iReg);
3384a748fdccSdrh   if( p5 ){
3385a748fdccSdrh     sqlite3VdbeChangeP5(v, p5);
3386a748fdccSdrh   }
3387e55cbd72Sdrh   return iReg;
3388e55cbd72Sdrh }
3389e55cbd72Sdrh 
3390e55cbd72Sdrh /*
3391b21e7c70Sdrh ** Generate code to move content from registers iFrom...iFrom+nReg-1
339236a5d88dSdrh ** over to iTo..iTo+nReg-1.
3393e55cbd72Sdrh */
3394b21e7c70Sdrh void sqlite3ExprCodeMove(Parse *pParse, int iFrom, int iTo, int nReg){
3395e8e4af76Sdrh   assert( iFrom>=iTo+nReg || iFrom+nReg<=iTo );
3396079a3072Sdrh   sqlite3VdbeAddOp3(pParse->pVdbe, OP_Move, iFrom, iTo, nReg);
3397945498f3Sdrh }
3398945498f3Sdrh 
3399652fbf55Sdrh /*
340012abf408Sdrh ** Convert a scalar expression node to a TK_REGISTER referencing
340112abf408Sdrh ** register iReg.  The caller must ensure that iReg already contains
340212abf408Sdrh ** the correct value for the expression.
3403a4c3c87eSdrh */
3404a4c3c87eSdrh static void exprToRegister(Expr *p, int iReg){
3405a4c3c87eSdrh   p->op2 = p->op;
3406a4c3c87eSdrh   p->op = TK_REGISTER;
3407a4c3c87eSdrh   p->iTable = iReg;
3408a4c3c87eSdrh   ExprClearProperty(p, EP_Skip);
3409a4c3c87eSdrh }
3410a4c3c87eSdrh 
341112abf408Sdrh /*
341212abf408Sdrh ** Evaluate an expression (either a vector or a scalar expression) and store
341312abf408Sdrh ** the result in continguous temporary registers.  Return the index of
341412abf408Sdrh ** the first register used to store the result.
341512abf408Sdrh **
341612abf408Sdrh ** If the returned result register is a temporary scalar, then also write
341712abf408Sdrh ** that register number into *piFreeable.  If the returned result register
341812abf408Sdrh ** is not a temporary or if the expression is a vector set *piFreeable
341912abf408Sdrh ** to 0.
342012abf408Sdrh */
342112abf408Sdrh static int exprCodeVector(Parse *pParse, Expr *p, int *piFreeable){
342212abf408Sdrh   int iResult;
342312abf408Sdrh   int nResult = sqlite3ExprVectorSize(p);
342412abf408Sdrh   if( nResult==1 ){
342512abf408Sdrh     iResult = sqlite3ExprCodeTemp(pParse, p, piFreeable);
342612abf408Sdrh   }else{
342712abf408Sdrh     *piFreeable = 0;
342812abf408Sdrh     if( p->op==TK_SELECT ){
3429dd1bb43aSdrh #if SQLITE_OMIT_SUBQUERY
3430dd1bb43aSdrh       iResult = 0;
3431dd1bb43aSdrh #else
343285bcdce2Sdrh       iResult = sqlite3CodeSubselect(pParse, p);
3433dd1bb43aSdrh #endif
343412abf408Sdrh     }else{
343512abf408Sdrh       int i;
343612abf408Sdrh       iResult = pParse->nMem+1;
343712abf408Sdrh       pParse->nMem += nResult;
343812abf408Sdrh       for(i=0; i<nResult; i++){
34394b725240Sdan         sqlite3ExprCodeFactorable(pParse, p->x.pList->a[i].pExpr, i+iResult);
344012abf408Sdrh       }
344112abf408Sdrh     }
344212abf408Sdrh   }
344312abf408Sdrh   return iResult;
344412abf408Sdrh }
344512abf408Sdrh 
344671c57db0Sdan 
3447a4c3c87eSdrh /*
3448cce7d176Sdrh ** Generate code into the current Vdbe to evaluate the given
34492dcef11bSdrh ** expression.  Attempt to store the results in register "target".
34502dcef11bSdrh ** Return the register where results are stored.
3451389a1adbSdrh **
34528b213899Sdrh ** With this routine, there is no guarantee that results will
34532dcef11bSdrh ** be stored in target.  The result might be stored in some other
34542dcef11bSdrh ** register if it is convenient to do so.  The calling function
34552dcef11bSdrh ** must check the return code and move the results to the desired
34562dcef11bSdrh ** register.
3457cce7d176Sdrh */
3458678ccce8Sdrh int sqlite3ExprCodeTarget(Parse *pParse, Expr *pExpr, int target){
34592dcef11bSdrh   Vdbe *v = pParse->pVdbe;  /* The VM under construction */
34602dcef11bSdrh   int op;                   /* The opcode being coded */
34612dcef11bSdrh   int inReg = target;       /* Results stored in register inReg */
34622dcef11bSdrh   int regFree1 = 0;         /* If non-zero free this temporary register */
34632dcef11bSdrh   int regFree2 = 0;         /* If non-zero free this temporary register */
34647b35a77bSdan   int r1, r2;               /* Various register numbers */
346510d1edf0Sdrh   Expr tempX;               /* Temporary expression node */
346671c57db0Sdan   int p5 = 0;
3467ffe07b2dSdrh 
34689cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
346920411ea7Sdrh   if( v==0 ){
347020411ea7Sdrh     assert( pParse->db->mallocFailed );
347120411ea7Sdrh     return 0;
347220411ea7Sdrh   }
3473389a1adbSdrh 
34741efa8023Sdrh expr_code_doover:
3475389a1adbSdrh   if( pExpr==0 ){
3476389a1adbSdrh     op = TK_NULL;
3477389a1adbSdrh   }else{
3478f2bc013cSdrh     op = pExpr->op;
3479389a1adbSdrh   }
3480f2bc013cSdrh   switch( op ){
348113449892Sdrh     case TK_AGG_COLUMN: {
348213449892Sdrh       AggInfo *pAggInfo = pExpr->pAggInfo;
348313449892Sdrh       struct AggInfo_col *pCol = &pAggInfo->aCol[pExpr->iAgg];
348413449892Sdrh       if( !pAggInfo->directMode ){
34859de221dfSdrh         assert( pCol->iMem>0 );
3486c332cc30Sdrh         return pCol->iMem;
348713449892Sdrh       }else if( pAggInfo->useSortingIdx ){
34885134d135Sdan         sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdxPTab,
3489389a1adbSdrh                               pCol->iSorterColumn, target);
3490c332cc30Sdrh         return target;
349113449892Sdrh       }
349213449892Sdrh       /* Otherwise, fall thru into the TK_COLUMN case */
349313449892Sdrh     }
3494967e8b73Sdrh     case TK_COLUMN: {
3495b2b9d3d7Sdrh       int iTab = pExpr->iTable;
3496efad2e23Sdrh       if( ExprHasProperty(pExpr, EP_FixedCol) ){
3497d98f5324Sdrh         /* This COLUMN expression is really a constant due to WHERE clause
3498d98f5324Sdrh         ** constraints, and that constant is coded by the pExpr->pLeft
3499d98f5324Sdrh         ** expresssion.  However, make sure the constant has the correct
3500d98f5324Sdrh         ** datatype by applying the Affinity of the table column to the
3501d98f5324Sdrh         ** constant.
3502d98f5324Sdrh         */
3503d98f5324Sdrh         int iReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft,target);
3504eda079cdSdrh         int aff = sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
3505d98f5324Sdrh         if( aff!=SQLITE_AFF_BLOB ){
3506d98f5324Sdrh           static const char zAff[] = "B\000C\000D\000E";
3507d98f5324Sdrh           assert( SQLITE_AFF_BLOB=='A' );
3508d98f5324Sdrh           assert( SQLITE_AFF_TEXT=='B' );
3509d98f5324Sdrh           if( iReg!=target ){
3510d98f5324Sdrh             sqlite3VdbeAddOp2(v, OP_SCopy, iReg, target);
3511d98f5324Sdrh             iReg = target;
3512d98f5324Sdrh           }
3513d98f5324Sdrh           sqlite3VdbeAddOp4(v, OP_Affinity, iReg, 1, 0,
3514d98f5324Sdrh                             &zAff[(aff-'B')*2], P4_STATIC);
3515d98f5324Sdrh         }
3516d98f5324Sdrh         return iReg;
3517efad2e23Sdrh       }
3518b2b9d3d7Sdrh       if( iTab<0 ){
35196e97f8ecSdrh         if( pParse->iSelfTab<0 ){
3520b2b9d3d7Sdrh           /* Generating CHECK constraints or inserting into partial index */
35216e97f8ecSdrh           return pExpr->iColumn - pParse->iSelfTab;
3522c4a3c779Sdrh         }else{
35231f9ca2c8Sdrh           /* Coding an expression that is part of an index where column names
35241f9ca2c8Sdrh           ** in the index refer to the table to which the index belongs */
35253e34eabcSdrh           iTab = pParse->iSelfTab - 1;
35262282792aSdrh         }
3527b2b9d3d7Sdrh       }
3528eda079cdSdrh       return sqlite3ExprCodeGetColumn(pParse, pExpr->y.pTab,
3529b2b9d3d7Sdrh                                pExpr->iColumn, iTab, target,
3530b2b9d3d7Sdrh                                pExpr->op2);
3531cce7d176Sdrh     }
3532cce7d176Sdrh     case TK_INTEGER: {
353313573c71Sdrh       codeInteger(pParse, pExpr, 0, target);
3534c332cc30Sdrh       return target;
353551e9a445Sdrh     }
35368abed7b9Sdrh     case TK_TRUEFALSE: {
353796acafbeSdrh       sqlite3VdbeAddOp2(v, OP_Integer, sqlite3ExprTruthValue(pExpr), target);
3538007c843bSdrh       return target;
3539007c843bSdrh     }
354013573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
3541598f1340Sdrh     case TK_FLOAT: {
354233e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
354333e619fcSdrh       codeReal(v, pExpr->u.zToken, 0, target);
3544c332cc30Sdrh       return target;
3545598f1340Sdrh     }
354613573c71Sdrh #endif
3547fec19aadSdrh     case TK_STRING: {
354833e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
3549076e85f5Sdrh       sqlite3VdbeLoadString(v, target, pExpr->u.zToken);
3550c332cc30Sdrh       return target;
3551cce7d176Sdrh     }
3552f0863fe5Sdrh     case TK_NULL: {
35539de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3554c332cc30Sdrh       return target;
3555f0863fe5Sdrh     }
35565338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_BLOB_LITERAL
3557c572ef7fSdanielk1977     case TK_BLOB: {
35586c8c6cecSdrh       int n;
35596c8c6cecSdrh       const char *z;
3560ca48c90fSdrh       char *zBlob;
356133e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
356233e619fcSdrh       assert( pExpr->u.zToken[0]=='x' || pExpr->u.zToken[0]=='X' );
356333e619fcSdrh       assert( pExpr->u.zToken[1]=='\'' );
356433e619fcSdrh       z = &pExpr->u.zToken[2];
3565b7916a78Sdrh       n = sqlite3Strlen30(z) - 1;
3566b7916a78Sdrh       assert( z[n]=='\'' );
3567ca48c90fSdrh       zBlob = sqlite3HexToBlob(sqlite3VdbeDb(v), z, n);
3568ca48c90fSdrh       sqlite3VdbeAddOp4(v, OP_Blob, n/2, target, 0, zBlob, P4_DYNAMIC);
3569c332cc30Sdrh       return target;
3570c572ef7fSdanielk1977     }
35715338a5f7Sdanielk1977 #endif
357250457896Sdrh     case TK_VARIABLE: {
357333e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
357433e619fcSdrh       assert( pExpr->u.zToken!=0 );
357533e619fcSdrh       assert( pExpr->u.zToken[0]!=0 );
3576eaf52d88Sdrh       sqlite3VdbeAddOp2(v, OP_Variable, pExpr->iColumn, target);
357733e619fcSdrh       if( pExpr->u.zToken[1]!=0 ){
35789bf755ccSdrh         const char *z = sqlite3VListNumToName(pParse->pVList, pExpr->iColumn);
35799bf755ccSdrh         assert( pExpr->u.zToken[0]=='?' || strcmp(pExpr->u.zToken, z)==0 );
3580ce1bbe51Sdrh         pParse->pVList[0] = 0; /* Indicate VList may no longer be enlarged */
35819bf755ccSdrh         sqlite3VdbeAppendP4(v, (char*)z, P4_STATIC);
35829bf755ccSdrh       }
3583c332cc30Sdrh       return target;
358450457896Sdrh     }
35854e0cff60Sdrh     case TK_REGISTER: {
3586c332cc30Sdrh       return pExpr->iTable;
35874e0cff60Sdrh     }
3588487e262fSdrh #ifndef SQLITE_OMIT_CAST
3589487e262fSdrh     case TK_CAST: {
3590487e262fSdrh       /* Expressions of the form:   CAST(pLeft AS token) */
35912dcef11bSdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
35921735fa88Sdrh       if( inReg!=target ){
35931735fa88Sdrh         sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
35941735fa88Sdrh         inReg = target;
35951735fa88Sdrh       }
35964169e430Sdrh       sqlite3VdbeAddOp2(v, OP_Cast, target,
35974169e430Sdrh                         sqlite3AffinityType(pExpr->u.zToken, 0));
3598c332cc30Sdrh       return inReg;
3599487e262fSdrh     }
3600487e262fSdrh #endif /* SQLITE_OMIT_CAST */
360171c57db0Sdan     case TK_IS:
360271c57db0Sdan     case TK_ISNOT:
360371c57db0Sdan       op = (op==TK_IS) ? TK_EQ : TK_NE;
360471c57db0Sdan       p5 = SQLITE_NULLEQ;
360571c57db0Sdan       /* fall-through */
3606c9b84a1fSdrh     case TK_LT:
3607c9b84a1fSdrh     case TK_LE:
3608c9b84a1fSdrh     case TK_GT:
3609c9b84a1fSdrh     case TK_GE:
3610c9b84a1fSdrh     case TK_NE:
3611c9b84a1fSdrh     case TK_EQ: {
361271c57db0Sdan       Expr *pLeft = pExpr->pLeft;
3613625015e0Sdan       if( sqlite3ExprIsVector(pLeft) ){
361479752b6eSdrh         codeVectorCompare(pParse, pExpr, target, op, p5);
361571c57db0Sdan       }else{
361671c57db0Sdan         r1 = sqlite3ExprCodeTemp(pParse, pLeft, &regFree1);
3617b6da74ebSdrh         r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
361871c57db0Sdan         codeCompare(pParse, pLeft, pExpr->pRight, op,
361971c57db0Sdan             r1, r2, inReg, SQLITE_STOREP2 | p5);
36207d176105Sdrh         assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
36217d176105Sdrh         assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
36227d176105Sdrh         assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
36237d176105Sdrh         assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
36247d176105Sdrh         assert(TK_EQ==OP_Eq); testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
36257d176105Sdrh         assert(TK_NE==OP_Ne); testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
3626c5499befSdrh         testcase( regFree1==0 );
3627c5499befSdrh         testcase( regFree2==0 );
3628c9b84a1fSdrh       }
36296a2fe093Sdrh       break;
36306a2fe093Sdrh     }
3631cce7d176Sdrh     case TK_AND:
3632cce7d176Sdrh     case TK_OR:
3633cce7d176Sdrh     case TK_PLUS:
3634cce7d176Sdrh     case TK_STAR:
3635cce7d176Sdrh     case TK_MINUS:
3636bf4133cbSdrh     case TK_REM:
3637bf4133cbSdrh     case TK_BITAND:
3638bf4133cbSdrh     case TK_BITOR:
363917c40294Sdrh     case TK_SLASH:
3640bf4133cbSdrh     case TK_LSHIFT:
3641855eb1cfSdrh     case TK_RSHIFT:
36420040077dSdrh     case TK_CONCAT: {
36437d176105Sdrh       assert( TK_AND==OP_And );            testcase( op==TK_AND );
36447d176105Sdrh       assert( TK_OR==OP_Or );              testcase( op==TK_OR );
36457d176105Sdrh       assert( TK_PLUS==OP_Add );           testcase( op==TK_PLUS );
36467d176105Sdrh       assert( TK_MINUS==OP_Subtract );     testcase( op==TK_MINUS );
36477d176105Sdrh       assert( TK_REM==OP_Remainder );      testcase( op==TK_REM );
36487d176105Sdrh       assert( TK_BITAND==OP_BitAnd );      testcase( op==TK_BITAND );
36497d176105Sdrh       assert( TK_BITOR==OP_BitOr );        testcase( op==TK_BITOR );
36507d176105Sdrh       assert( TK_SLASH==OP_Divide );       testcase( op==TK_SLASH );
36517d176105Sdrh       assert( TK_LSHIFT==OP_ShiftLeft );   testcase( op==TK_LSHIFT );
36527d176105Sdrh       assert( TK_RSHIFT==OP_ShiftRight );  testcase( op==TK_RSHIFT );
36537d176105Sdrh       assert( TK_CONCAT==OP_Concat );      testcase( op==TK_CONCAT );
36542dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
36552dcef11bSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
36565b6afba9Sdrh       sqlite3VdbeAddOp3(v, op, r2, r1, target);
3657c5499befSdrh       testcase( regFree1==0 );
3658c5499befSdrh       testcase( regFree2==0 );
36590040077dSdrh       break;
36600040077dSdrh     }
3661cce7d176Sdrh     case TK_UMINUS: {
3662fec19aadSdrh       Expr *pLeft = pExpr->pLeft;
3663fec19aadSdrh       assert( pLeft );
366413573c71Sdrh       if( pLeft->op==TK_INTEGER ){
366513573c71Sdrh         codeInteger(pParse, pLeft, 1, target);
3666c332cc30Sdrh         return target;
366713573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
366813573c71Sdrh       }else if( pLeft->op==TK_FLOAT ){
366933e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
367033e619fcSdrh         codeReal(v, pLeft->u.zToken, 1, target);
3671c332cc30Sdrh         return target;
367213573c71Sdrh #endif
36733c84ddffSdrh       }else{
367410d1edf0Sdrh         tempX.op = TK_INTEGER;
367510d1edf0Sdrh         tempX.flags = EP_IntValue|EP_TokenOnly;
367610d1edf0Sdrh         tempX.u.iValue = 0;
367710d1edf0Sdrh         r1 = sqlite3ExprCodeTemp(pParse, &tempX, &regFree1);
3678e55cbd72Sdrh         r2 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree2);
36792dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_Subtract, r2, r1, target);
3680c5499befSdrh         testcase( regFree2==0 );
36813c84ddffSdrh       }
36826e142f54Sdrh       break;
36836e142f54Sdrh     }
3684bf4133cbSdrh     case TK_BITNOT:
36856e142f54Sdrh     case TK_NOT: {
36867d176105Sdrh       assert( TK_BITNOT==OP_BitNot );   testcase( op==TK_BITNOT );
36877d176105Sdrh       assert( TK_NOT==OP_Not );         testcase( op==TK_NOT );
3688e99fa2afSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3689e99fa2afSdrh       testcase( regFree1==0 );
3690e99fa2afSdrh       sqlite3VdbeAddOp2(v, op, r1, inReg);
3691cce7d176Sdrh       break;
3692cce7d176Sdrh     }
36938abed7b9Sdrh     case TK_TRUTH: {
369496acafbeSdrh       int isTrue;    /* IS TRUE or IS NOT TRUE */
369596acafbeSdrh       int bNormal;   /* IS TRUE or IS FALSE */
3696007c843bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3697007c843bSdrh       testcase( regFree1==0 );
369896acafbeSdrh       isTrue = sqlite3ExprTruthValue(pExpr->pRight);
369996acafbeSdrh       bNormal = pExpr->op2==TK_IS;
370096acafbeSdrh       testcase( isTrue && bNormal);
370196acafbeSdrh       testcase( !isTrue && bNormal);
370296acafbeSdrh       sqlite3VdbeAddOp4Int(v, OP_IsTrue, r1, inReg, !isTrue, isTrue ^ bNormal);
3703007c843bSdrh       break;
3704007c843bSdrh     }
3705cce7d176Sdrh     case TK_ISNULL:
3706cce7d176Sdrh     case TK_NOTNULL: {
37076a288a33Sdrh       int addr;
37087d176105Sdrh       assert( TK_ISNULL==OP_IsNull );   testcase( op==TK_ISNULL );
37097d176105Sdrh       assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
37109de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
37112dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3712c5499befSdrh       testcase( regFree1==0 );
37132dcef11bSdrh       addr = sqlite3VdbeAddOp1(v, op, r1);
37147d176105Sdrh       VdbeCoverageIf(v, op==TK_ISNULL);
37157d176105Sdrh       VdbeCoverageIf(v, op==TK_NOTNULL);
3716a976979bSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 0, target);
37176a288a33Sdrh       sqlite3VdbeJumpHere(v, addr);
3718a37cdde0Sdanielk1977       break;
3719f2bc013cSdrh     }
37202282792aSdrh     case TK_AGG_FUNCTION: {
372113449892Sdrh       AggInfo *pInfo = pExpr->pAggInfo;
37227e56e711Sdrh       if( pInfo==0 ){
372333e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
372433e619fcSdrh         sqlite3ErrorMsg(pParse, "misuse of aggregate: %s()", pExpr->u.zToken);
37257e56e711Sdrh       }else{
3726c332cc30Sdrh         return pInfo->aFunc[pExpr->iAgg].iMem;
37277e56e711Sdrh       }
37282282792aSdrh       break;
37292282792aSdrh     }
3730cce7d176Sdrh     case TK_FUNCTION: {
373112ffee8cSdrh       ExprList *pFarg;       /* List of function arguments */
373212ffee8cSdrh       int nFarg;             /* Number of function arguments */
373312ffee8cSdrh       FuncDef *pDef;         /* The function definition object */
373412ffee8cSdrh       const char *zId;       /* The function name */
3735693e6719Sdrh       u32 constMask = 0;     /* Mask of function arguments that are constant */
373612ffee8cSdrh       int i;                 /* Loop counter */
3737c332cc30Sdrh       sqlite3 *db = pParse->db;  /* The database connection */
373812ffee8cSdrh       u8 enc = ENC(db);      /* The text encoding used by this database */
373912ffee8cSdrh       CollSeq *pColl = 0;    /* A collating sequence */
374017435752Sdrh 
374167a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
3742eda079cdSdrh       if( ExprHasProperty(pExpr, EP_WinFunc) ){
3743eda079cdSdrh         return pExpr->y.pWin->regResult;
374486fb6e17Sdan       }
374567a9b8edSdan #endif
374686fb6e17Sdan 
37471e9b53f9Sdrh       if( ConstFactorOk(pParse) && sqlite3ExprIsConstantNotJoin(pExpr) ){
374849c5ab24Sdrh         /* SQL functions can be expensive. So try to move constant functions
3749ad879ffdSdrh         ** out of the inner loop, even if that means an extra OP_Copy. */
3750ad879ffdSdrh         return sqlite3ExprCodeAtInit(pParse, pExpr, -1);
37511e9b53f9Sdrh       }
37526ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
3753c5cd1249Sdrh       if( ExprHasProperty(pExpr, EP_TokenOnly) ){
375412ffee8cSdrh         pFarg = 0;
375512ffee8cSdrh       }else{
375612ffee8cSdrh         pFarg = pExpr->x.pList;
375712ffee8cSdrh       }
375812ffee8cSdrh       nFarg = pFarg ? pFarg->nExpr : 0;
375933e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
376033e619fcSdrh       zId = pExpr->u.zToken;
376180738d9cSdrh       pDef = sqlite3FindFunction(db, zId, nFarg, enc, 0);
3762cc15313cSdrh #ifdef SQLITE_ENABLE_UNKNOWN_SQL_FUNCTION
3763cc15313cSdrh       if( pDef==0 && pParse->explain ){
3764cc15313cSdrh         pDef = sqlite3FindFunction(db, "unknown", nFarg, enc, 0);
3765cc15313cSdrh       }
3766cc15313cSdrh #endif
3767b6e9f7a4Sdan       if( pDef==0 || pDef->xFinalize!=0 ){
376880738d9cSdrh         sqlite3ErrorMsg(pParse, "unknown function: %s()", zId);
3769feb306f5Sdrh         break;
3770feb306f5Sdrh       }
3771ae6bb957Sdrh 
3772ae6bb957Sdrh       /* Attempt a direct implementation of the built-in COALESCE() and
377360ec914cSpeter.d.reid       ** IFNULL() functions.  This avoids unnecessary evaluation of
3774ae6bb957Sdrh       ** arguments past the first non-NULL argument.
3775ae6bb957Sdrh       */
3776d36e1041Sdrh       if( pDef->funcFlags & SQLITE_FUNC_COALESCE ){
3777ec4ccdbcSdrh         int endCoalesce = sqlite3VdbeMakeLabel(pParse);
3778ae6bb957Sdrh         assert( nFarg>=2 );
3779ae6bb957Sdrh         sqlite3ExprCode(pParse, pFarg->a[0].pExpr, target);
3780ae6bb957Sdrh         for(i=1; i<nFarg; i++){
3781ae6bb957Sdrh           sqlite3VdbeAddOp2(v, OP_NotNull, target, endCoalesce);
3782688852abSdrh           VdbeCoverage(v);
3783ae6bb957Sdrh           sqlite3ExprCode(pParse, pFarg->a[i].pExpr, target);
3784ae6bb957Sdrh         }
3785ae6bb957Sdrh         sqlite3VdbeResolveLabel(v, endCoalesce);
3786ae6bb957Sdrh         break;
3787ae6bb957Sdrh       }
3788ae6bb957Sdrh 
3789cca9f3d2Sdrh       /* The UNLIKELY() function is a no-op.  The result is the value
3790cca9f3d2Sdrh       ** of the first argument.
3791cca9f3d2Sdrh       */
3792cca9f3d2Sdrh       if( pDef->funcFlags & SQLITE_FUNC_UNLIKELY ){
3793cca9f3d2Sdrh         assert( nFarg>=1 );
3794c332cc30Sdrh         return sqlite3ExprCodeTarget(pParse, pFarg->a[0].pExpr, target);
3795cca9f3d2Sdrh       }
3796ae6bb957Sdrh 
379754240751Sdrh #ifdef SQLITE_DEBUG
3798a1a523a5Sdrh       /* The AFFINITY() function evaluates to a string that describes
3799a1a523a5Sdrh       ** the type affinity of the argument.  This is used for testing of
3800a1a523a5Sdrh       ** the SQLite type logic.
3801a1a523a5Sdrh       */
3802a1a523a5Sdrh       if( pDef->funcFlags & SQLITE_FUNC_AFFINITY ){
3803a1a523a5Sdrh         const char *azAff[] = { "blob", "text", "numeric", "integer", "real" };
3804a1a523a5Sdrh         char aff;
3805a1a523a5Sdrh         assert( nFarg==1 );
3806a1a523a5Sdrh         aff = sqlite3ExprAffinity(pFarg->a[0].pExpr);
3807a1a523a5Sdrh         sqlite3VdbeLoadString(v, target,
3808a1a523a5Sdrh                               aff ? azAff[aff-SQLITE_AFF_BLOB] : "none");
3809a1a523a5Sdrh         return target;
3810a1a523a5Sdrh       }
381154240751Sdrh #endif
3812a1a523a5Sdrh 
3813d1a01edaSdrh       for(i=0; i<nFarg; i++){
3814d1a01edaSdrh         if( i<32 && sqlite3ExprIsConstant(pFarg->a[i].pExpr) ){
3815693e6719Sdrh           testcase( i==31 );
3816693e6719Sdrh           constMask |= MASKBIT32(i);
3817d1a01edaSdrh         }
3818d1a01edaSdrh         if( (pDef->funcFlags & SQLITE_FUNC_NEEDCOLL)!=0 && !pColl ){
3819d1a01edaSdrh           pColl = sqlite3ExprCollSeq(pParse, pFarg->a[i].pExpr);
3820d1a01edaSdrh         }
3821d1a01edaSdrh       }
382212ffee8cSdrh       if( pFarg ){
3823d1a01edaSdrh         if( constMask ){
3824d1a01edaSdrh           r1 = pParse->nMem+1;
3825d1a01edaSdrh           pParse->nMem += nFarg;
3826d1a01edaSdrh         }else{
382712ffee8cSdrh           r1 = sqlite3GetTempRange(pParse, nFarg);
3828d1a01edaSdrh         }
3829a748fdccSdrh 
3830a748fdccSdrh         /* For length() and typeof() functions with a column argument,
3831a748fdccSdrh         ** set the P5 parameter to the OP_Column opcode to OPFLAG_LENGTHARG
3832a748fdccSdrh         ** or OPFLAG_TYPEOFARG respectively, to avoid unnecessary data
3833a748fdccSdrh         ** loading.
3834a748fdccSdrh         */
3835d36e1041Sdrh         if( (pDef->funcFlags & (SQLITE_FUNC_LENGTH|SQLITE_FUNC_TYPEOF))!=0 ){
38364e245a4cSdrh           u8 exprOp;
3837a748fdccSdrh           assert( nFarg==1 );
3838a748fdccSdrh           assert( pFarg->a[0].pExpr!=0 );
38394e245a4cSdrh           exprOp = pFarg->a[0].pExpr->op;
38404e245a4cSdrh           if( exprOp==TK_COLUMN || exprOp==TK_AGG_COLUMN ){
3841a748fdccSdrh             assert( SQLITE_FUNC_LENGTH==OPFLAG_LENGTHARG );
3842a748fdccSdrh             assert( SQLITE_FUNC_TYPEOF==OPFLAG_TYPEOFARG );
3843b1fba286Sdrh             testcase( pDef->funcFlags & OPFLAG_LENGTHARG );
3844b1fba286Sdrh             pFarg->a[0].pExpr->op2 =
3845b1fba286Sdrh                   pDef->funcFlags & (OPFLAG_LENGTHARG|OPFLAG_TYPEOFARG);
3846a748fdccSdrh           }
3847a748fdccSdrh         }
3848a748fdccSdrh 
38495579d59fSdrh         sqlite3ExprCodeExprList(pParse, pFarg, r1, 0,
3850d1a01edaSdrh                                 SQLITE_ECEL_DUP|SQLITE_ECEL_FACTOR);
3851892d3179Sdrh       }else{
385212ffee8cSdrh         r1 = 0;
3853892d3179Sdrh       }
3854b7f6f68fSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
3855a43fa227Sdrh       /* Possibly overload the function if the first argument is
3856a43fa227Sdrh       ** a virtual table column.
3857a43fa227Sdrh       **
3858a43fa227Sdrh       ** For infix functions (LIKE, GLOB, REGEXP, and MATCH) use the
3859a43fa227Sdrh       ** second argument, not the first, as the argument to test to
3860a43fa227Sdrh       ** see if it is a column in a virtual table.  This is done because
3861a43fa227Sdrh       ** the left operand of infix functions (the operand we want to
3862a43fa227Sdrh       ** control overloading) ends up as the second argument to the
3863a43fa227Sdrh       ** function.  The expression "A glob B" is equivalent to
3864a43fa227Sdrh       ** "glob(B,A).  We want to use the A in "A glob B" to test
3865a43fa227Sdrh       ** for function overloading.  But we use the B term in "glob(B,A)".
3866a43fa227Sdrh       */
386759155065Sdrh       if( nFarg>=2 && ExprHasProperty(pExpr, EP_InfixFunc) ){
386812ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[1].pExpr);
386912ffee8cSdrh       }else if( nFarg>0 ){
387012ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[0].pExpr);
3871b7f6f68fSdrh       }
3872b7f6f68fSdrh #endif
3873d36e1041Sdrh       if( pDef->funcFlags & SQLITE_FUNC_NEEDCOLL ){
38748b213899Sdrh         if( !pColl ) pColl = db->pDfltColl;
387566a5167bSdrh         sqlite3VdbeAddOp4(v, OP_CollSeq, 0, 0, 0, (char *)pColl, P4_COLLSEQ);
3876682f68b0Sdanielk1977       }
3877092457b1Sdrh #ifdef SQLITE_ENABLE_OFFSET_SQL_FUNC
3878092457b1Sdrh       if( pDef->funcFlags & SQLITE_FUNC_OFFSET ){
38792fc865c1Sdrh         Expr *pArg = pFarg->a[0].pExpr;
38802fc865c1Sdrh         if( pArg->op==TK_COLUMN ){
3881092457b1Sdrh           sqlite3VdbeAddOp3(v, OP_Offset, pArg->iTable, pArg->iColumn, target);
38822fc865c1Sdrh         }else{
38832fc865c1Sdrh           sqlite3VdbeAddOp2(v, OP_Null, 0, target);
38842fc865c1Sdrh         }
3885092457b1Sdrh       }else
3886092457b1Sdrh #endif
3887092457b1Sdrh       {
38883e34eabcSdrh         sqlite3VdbeAddOp4(v, pParse->iSelfTab ? OP_PureFunc0 : OP_Function0,
38893e34eabcSdrh                           constMask, r1, target, (char*)pDef, P4_FUNCDEF);
389012ffee8cSdrh         sqlite3VdbeChangeP5(v, (u8)nFarg);
38912fc865c1Sdrh       }
3892d1a01edaSdrh       if( nFarg && constMask==0 ){
389312ffee8cSdrh         sqlite3ReleaseTempRange(pParse, r1, nFarg);
38942dcef11bSdrh       }
3895c332cc30Sdrh       return target;
38966ec2733bSdrh     }
3897fe2093d7Sdrh #ifndef SQLITE_OMIT_SUBQUERY
3898fe2093d7Sdrh     case TK_EXISTS:
389919a775c2Sdrh     case TK_SELECT: {
39008da209b1Sdan       int nCol;
3901c5499befSdrh       testcase( op==TK_EXISTS );
3902c5499befSdrh       testcase( op==TK_SELECT );
39038da209b1Sdan       if( op==TK_SELECT && (nCol = pExpr->x.pSelect->pEList->nExpr)!=1 ){
39048da209b1Sdan         sqlite3SubselectError(pParse, nCol, 1);
39058da209b1Sdan       }else{
390685bcdce2Sdrh         return sqlite3CodeSubselect(pParse, pExpr);
39078da209b1Sdan       }
390819a775c2Sdrh       break;
390919a775c2Sdrh     }
3910fc7f27b9Sdrh     case TK_SELECT_COLUMN: {
3911966e2911Sdrh       int n;
3912fc7f27b9Sdrh       if( pExpr->pLeft->iTable==0 ){
391385bcdce2Sdrh         pExpr->pLeft->iTable = sqlite3CodeSubselect(pParse, pExpr->pLeft);
3914fc7f27b9Sdrh       }
3915966e2911Sdrh       assert( pExpr->iTable==0 || pExpr->pLeft->op==TK_SELECT );
3916966e2911Sdrh       if( pExpr->iTable
3917966e2911Sdrh        && pExpr->iTable!=(n = sqlite3ExprVectorSize(pExpr->pLeft))
3918966e2911Sdrh       ){
3919966e2911Sdrh         sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
3920966e2911Sdrh                                 pExpr->iTable, n);
3921966e2911Sdrh       }
3922c332cc30Sdrh       return pExpr->pLeft->iTable + pExpr->iColumn;
3923fc7f27b9Sdrh     }
3924fef5208cSdrh     case TK_IN: {
3925ec4ccdbcSdrh       int destIfFalse = sqlite3VdbeMakeLabel(pParse);
3926ec4ccdbcSdrh       int destIfNull = sqlite3VdbeMakeLabel(pParse);
3927e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3928e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
392966ba23ceSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
3930e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
3931e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_AddImm, target, 0);
3932e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfNull);
3933c332cc30Sdrh       return target;
3934fef5208cSdrh     }
3935e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
3936e3365e6cSdrh 
3937e3365e6cSdrh 
39382dcef11bSdrh     /*
39392dcef11bSdrh     **    x BETWEEN y AND z
39402dcef11bSdrh     **
39412dcef11bSdrh     ** This is equivalent to
39422dcef11bSdrh     **
39432dcef11bSdrh     **    x>=y AND x<=z
39442dcef11bSdrh     **
39452dcef11bSdrh     ** X is stored in pExpr->pLeft.
39462dcef11bSdrh     ** Y is stored in pExpr->pList->a[0].pExpr.
39472dcef11bSdrh     ** Z is stored in pExpr->pList->a[1].pExpr.
39482dcef11bSdrh     */
3949fef5208cSdrh     case TK_BETWEEN: {
395071c57db0Sdan       exprCodeBetween(pParse, pExpr, target, 0, 0);
3951c332cc30Sdrh       return target;
3952fef5208cSdrh     }
395394fa9c41Sdrh     case TK_SPAN:
3954ae80ddeaSdrh     case TK_COLLATE:
39554f07e5fbSdrh     case TK_UPLUS: {
39561efa8023Sdrh       pExpr = pExpr->pLeft;
395759ee43a7Sdrh       goto expr_code_doover; /* 2018-04-28: Prevent deep recursion. OSSFuzz. */
3958a2e00042Sdrh     }
39592dcef11bSdrh 
3960165921a7Sdan     case TK_TRIGGER: {
396165a7cd16Sdan       /* If the opcode is TK_TRIGGER, then the expression is a reference
396265a7cd16Sdan       ** to a column in the new.* or old.* pseudo-tables available to
396365a7cd16Sdan       ** trigger programs. In this case Expr.iTable is set to 1 for the
396465a7cd16Sdan       ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
396565a7cd16Sdan       ** is set to the column of the pseudo-table to read, or to -1 to
396665a7cd16Sdan       ** read the rowid field.
396765a7cd16Sdan       **
396865a7cd16Sdan       ** The expression is implemented using an OP_Param opcode. The p1
396965a7cd16Sdan       ** parameter is set to 0 for an old.rowid reference, or to (i+1)
397065a7cd16Sdan       ** to reference another column of the old.* pseudo-table, where
397165a7cd16Sdan       ** i is the index of the column. For a new.rowid reference, p1 is
397265a7cd16Sdan       ** set to (n+1), where n is the number of columns in each pseudo-table.
397365a7cd16Sdan       ** For a reference to any other column in the new.* pseudo-table, p1
397465a7cd16Sdan       ** is set to (n+2+i), where n and i are as defined previously. For
397565a7cd16Sdan       ** example, if the table on which triggers are being fired is
397665a7cd16Sdan       ** declared as:
397765a7cd16Sdan       **
397865a7cd16Sdan       **   CREATE TABLE t1(a, b);
397965a7cd16Sdan       **
398065a7cd16Sdan       ** Then p1 is interpreted as follows:
398165a7cd16Sdan       **
398265a7cd16Sdan       **   p1==0   ->    old.rowid     p1==3   ->    new.rowid
398365a7cd16Sdan       **   p1==1   ->    old.a         p1==4   ->    new.a
398465a7cd16Sdan       **   p1==2   ->    old.b         p1==5   ->    new.b
398565a7cd16Sdan       */
3986eda079cdSdrh       Table *pTab = pExpr->y.pTab;
398765a7cd16Sdan       int p1 = pExpr->iTable * (pTab->nCol+1) + 1 + pExpr->iColumn;
398865a7cd16Sdan 
398965a7cd16Sdan       assert( pExpr->iTable==0 || pExpr->iTable==1 );
399065a7cd16Sdan       assert( pExpr->iColumn>=-1 && pExpr->iColumn<pTab->nCol );
399165a7cd16Sdan       assert( pTab->iPKey<0 || pExpr->iColumn!=pTab->iPKey );
399265a7cd16Sdan       assert( p1>=0 && p1<(pTab->nCol*2+2) );
399365a7cd16Sdan 
399465a7cd16Sdan       sqlite3VdbeAddOp2(v, OP_Param, p1, target);
3995896494e8Sdrh       VdbeComment((v, "r[%d]=%s.%s", target,
3996165921a7Sdan         (pExpr->iTable ? "new" : "old"),
3997eda079cdSdrh         (pExpr->iColumn<0 ? "rowid" : pExpr->y.pTab->aCol[pExpr->iColumn].zName)
3998165921a7Sdan       ));
399965a7cd16Sdan 
400044dbca83Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
400165a7cd16Sdan       /* If the column has REAL affinity, it may currently be stored as an
4002113762a2Sdrh       ** integer. Use OP_RealAffinity to make sure it is really real.
4003113762a2Sdrh       **
4004113762a2Sdrh       ** EVIDENCE-OF: R-60985-57662 SQLite will convert the value back to
4005113762a2Sdrh       ** floating point when extracting it from the record.  */
40062832ad42Sdan       if( pExpr->iColumn>=0
40072832ad42Sdan        && pTab->aCol[pExpr->iColumn].affinity==SQLITE_AFF_REAL
40082832ad42Sdan       ){
40092832ad42Sdan         sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
40102832ad42Sdan       }
401144dbca83Sdrh #endif
4012165921a7Sdan       break;
4013165921a7Sdan     }
4014165921a7Sdan 
401571c57db0Sdan     case TK_VECTOR: {
4016e835bc12Sdrh       sqlite3ErrorMsg(pParse, "row value misused");
401771c57db0Sdan       break;
401871c57db0Sdan     }
401971c57db0Sdan 
402031d6fd55Sdrh     case TK_IF_NULL_ROW: {
402131d6fd55Sdrh       int addrINR;
402231d6fd55Sdrh       addrINR = sqlite3VdbeAddOp1(v, OP_IfNullRow, pExpr->iTable);
402331d6fd55Sdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
402431d6fd55Sdrh       sqlite3VdbeJumpHere(v, addrINR);
402531d6fd55Sdrh       sqlite3VdbeChangeP3(v, addrINR, inReg);
402631d6fd55Sdrh       break;
402731d6fd55Sdrh     }
402831d6fd55Sdrh 
40292dcef11bSdrh     /*
40302dcef11bSdrh     ** Form A:
40312dcef11bSdrh     **   CASE x WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
40322dcef11bSdrh     **
40332dcef11bSdrh     ** Form B:
40342dcef11bSdrh     **   CASE WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
40352dcef11bSdrh     **
40362dcef11bSdrh     ** Form A is can be transformed into the equivalent form B as follows:
40372dcef11bSdrh     **   CASE WHEN x=e1 THEN r1 WHEN x=e2 THEN r2 ...
40382dcef11bSdrh     **        WHEN x=eN THEN rN ELSE y END
40392dcef11bSdrh     **
40402dcef11bSdrh     ** X (if it exists) is in pExpr->pLeft.
4041c5cd1249Sdrh     ** Y is in the last element of pExpr->x.pList if pExpr->x.pList->nExpr is
4042c5cd1249Sdrh     ** odd.  The Y is also optional.  If the number of elements in x.pList
4043c5cd1249Sdrh     ** is even, then Y is omitted and the "otherwise" result is NULL.
40442dcef11bSdrh     ** Ei is in pExpr->pList->a[i*2] and Ri is pExpr->pList->a[i*2+1].
40452dcef11bSdrh     **
40462dcef11bSdrh     ** The result of the expression is the Ri for the first matching Ei,
40472dcef11bSdrh     ** or if there is no matching Ei, the ELSE term Y, or if there is
40482dcef11bSdrh     ** no ELSE term, NULL.
40492dcef11bSdrh     */
405033cd4909Sdrh     default: assert( op==TK_CASE ); {
40512dcef11bSdrh       int endLabel;                     /* GOTO label for end of CASE stmt */
40522dcef11bSdrh       int nextCase;                     /* GOTO label for next WHEN clause */
40532dcef11bSdrh       int nExpr;                        /* 2x number of WHEN terms */
40542dcef11bSdrh       int i;                            /* Loop counter */
40552dcef11bSdrh       ExprList *pEList;                 /* List of WHEN terms */
40562dcef11bSdrh       struct ExprList_item *aListelem;  /* Array of WHEN terms */
40572dcef11bSdrh       Expr opCompare;                   /* The X==Ei expression */
40582dcef11bSdrh       Expr *pX;                         /* The X expression */
40591bd10f8aSdrh       Expr *pTest = 0;                  /* X==Ei (form A) or just Ei (form B) */
406017a7f8ddSdrh 
40616ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) && pExpr->x.pList );
40626ab3a2ecSdanielk1977       assert(pExpr->x.pList->nExpr > 0);
40636ab3a2ecSdanielk1977       pEList = pExpr->x.pList;
4064be5c89acSdrh       aListelem = pEList->a;
4065be5c89acSdrh       nExpr = pEList->nExpr;
4066ec4ccdbcSdrh       endLabel = sqlite3VdbeMakeLabel(pParse);
40672dcef11bSdrh       if( (pX = pExpr->pLeft)!=0 ){
4068a8e05761Sdrh         exprNodeCopy(&tempX, pX);
406933cd4909Sdrh         testcase( pX->op==TK_COLUMN );
407012abf408Sdrh         exprToRegister(&tempX, exprCodeVector(pParse, &tempX, &regFree1));
4071c5499befSdrh         testcase( regFree1==0 );
4072abb9d5f1Sdrh         memset(&opCompare, 0, sizeof(opCompare));
40732dcef11bSdrh         opCompare.op = TK_EQ;
407410d1edf0Sdrh         opCompare.pLeft = &tempX;
40752dcef11bSdrh         pTest = &opCompare;
40768b1db07fSdrh         /* Ticket b351d95f9cd5ef17e9d9dbae18f5ca8611190001:
40778b1db07fSdrh         ** The value in regFree1 might get SCopy-ed into the file result.
40788b1db07fSdrh         ** So make sure that the regFree1 register is not reused for other
40798b1db07fSdrh         ** purposes and possibly overwritten.  */
40808b1db07fSdrh         regFree1 = 0;
4081cce7d176Sdrh       }
4082c5cd1249Sdrh       for(i=0; i<nExpr-1; i=i+2){
40832dcef11bSdrh         if( pX ){
40841bd10f8aSdrh           assert( pTest!=0 );
40852dcef11bSdrh           opCompare.pRight = aListelem[i].pExpr;
4086f5905aa7Sdrh         }else{
40872dcef11bSdrh           pTest = aListelem[i].pExpr;
408817a7f8ddSdrh         }
4089ec4ccdbcSdrh         nextCase = sqlite3VdbeMakeLabel(pParse);
409033cd4909Sdrh         testcase( pTest->op==TK_COLUMN );
40912dcef11bSdrh         sqlite3ExprIfFalse(pParse, pTest, nextCase, SQLITE_JUMPIFNULL);
4092c5499befSdrh         testcase( aListelem[i+1].pExpr->op==TK_COLUMN );
40939de221dfSdrh         sqlite3ExprCode(pParse, aListelem[i+1].pExpr, target);
4094076e85f5Sdrh         sqlite3VdbeGoto(v, endLabel);
40952dcef11bSdrh         sqlite3VdbeResolveLabel(v, nextCase);
4096f570f011Sdrh       }
4097c5cd1249Sdrh       if( (nExpr&1)!=0 ){
4098c5cd1249Sdrh         sqlite3ExprCode(pParse, pEList->a[nExpr-1].pExpr, target);
409917a7f8ddSdrh       }else{
41009de221dfSdrh         sqlite3VdbeAddOp2(v, OP_Null, 0, target);
410117a7f8ddSdrh       }
41022dcef11bSdrh       sqlite3VdbeResolveLabel(v, endLabel);
41036f34903eSdanielk1977       break;
41046f34903eSdanielk1977     }
41055338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_TRIGGER
41066f34903eSdanielk1977     case TK_RAISE: {
4107165921a7Sdan       assert( pExpr->affinity==OE_Rollback
4108165921a7Sdan            || pExpr->affinity==OE_Abort
4109165921a7Sdan            || pExpr->affinity==OE_Fail
4110165921a7Sdan            || pExpr->affinity==OE_Ignore
4111165921a7Sdan       );
4112e0af83acSdan       if( !pParse->pTriggerTab ){
4113e0af83acSdan         sqlite3ErrorMsg(pParse,
4114e0af83acSdan                        "RAISE() may only be used within a trigger-program");
4115e0af83acSdan         return 0;
4116e0af83acSdan       }
4117e0af83acSdan       if( pExpr->affinity==OE_Abort ){
4118e0af83acSdan         sqlite3MayAbort(pParse);
4119e0af83acSdan       }
412033e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
4121e0af83acSdan       if( pExpr->affinity==OE_Ignore ){
4122e0af83acSdan         sqlite3VdbeAddOp4(
4123e0af83acSdan             v, OP_Halt, SQLITE_OK, OE_Ignore, 0, pExpr->u.zToken,0);
4124688852abSdrh         VdbeCoverage(v);
4125e0af83acSdan       }else{
4126433dccfbSdrh         sqlite3HaltConstraint(pParse, SQLITE_CONSTRAINT_TRIGGER,
4127f9c8ce3cSdrh                               pExpr->affinity, pExpr->u.zToken, 0, 0);
4128e0af83acSdan       }
4129e0af83acSdan 
4130ffe07b2dSdrh       break;
413117a7f8ddSdrh     }
41325338a5f7Sdanielk1977 #endif
4133ffe07b2dSdrh   }
41342dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
41352dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
41362dcef11bSdrh   return inReg;
41375b6afba9Sdrh }
41382dcef11bSdrh 
41392dcef11bSdrh /*
4140d1a01edaSdrh ** Factor out the code of the given expression to initialization time.
41411e9b53f9Sdrh **
4142ad879ffdSdrh ** If regDest>=0 then the result is always stored in that register and the
4143ad879ffdSdrh ** result is not reusable.  If regDest<0 then this routine is free to
4144ad879ffdSdrh ** store the value whereever it wants.  The register where the expression
4145ad879ffdSdrh ** is stored is returned.  When regDest<0, two identical expressions will
4146ad879ffdSdrh ** code to the same register.
4147d1a01edaSdrh */
41481e9b53f9Sdrh int sqlite3ExprCodeAtInit(
4149d673cddaSdrh   Parse *pParse,    /* Parsing context */
4150d673cddaSdrh   Expr *pExpr,      /* The expression to code when the VDBE initializes */
4151ad879ffdSdrh   int regDest       /* Store the value in this register */
4152d673cddaSdrh ){
4153d1a01edaSdrh   ExprList *p;
4154d9f158e7Sdrh   assert( ConstFactorOk(pParse) );
4155d1a01edaSdrh   p = pParse->pConstExpr;
4156ad879ffdSdrh   if( regDest<0 && p ){
41571e9b53f9Sdrh     struct ExprList_item *pItem;
41581e9b53f9Sdrh     int i;
41591e9b53f9Sdrh     for(pItem=p->a, i=p->nExpr; i>0; pItem++, i--){
41605aa550cfSdan       if( pItem->reusable && sqlite3ExprCompare(0,pItem->pExpr,pExpr,-1)==0 ){
41611e9b53f9Sdrh         return pItem->u.iConstExprReg;
41621e9b53f9Sdrh       }
41631e9b53f9Sdrh     }
41641e9b53f9Sdrh   }
4165d1a01edaSdrh   pExpr = sqlite3ExprDup(pParse->db, pExpr, 0);
4166d1a01edaSdrh   p = sqlite3ExprListAppend(pParse, p, pExpr);
4167d673cddaSdrh   if( p ){
4168d673cddaSdrh      struct ExprList_item *pItem = &p->a[p->nExpr-1];
4169ad879ffdSdrh      pItem->reusable = regDest<0;
4170ad879ffdSdrh      if( regDest<0 ) regDest = ++pParse->nMem;
4171d673cddaSdrh      pItem->u.iConstExprReg = regDest;
4172d673cddaSdrh   }
4173d1a01edaSdrh   pParse->pConstExpr = p;
41741e9b53f9Sdrh   return regDest;
4175d1a01edaSdrh }
4176d1a01edaSdrh 
4177d1a01edaSdrh /*
41782dcef11bSdrh ** Generate code to evaluate an expression and store the results
41792dcef11bSdrh ** into a register.  Return the register number where the results
41802dcef11bSdrh ** are stored.
41812dcef11bSdrh **
41822dcef11bSdrh ** If the register is a temporary register that can be deallocated,
4183678ccce8Sdrh ** then write its number into *pReg.  If the result register is not
41842dcef11bSdrh ** a temporary, then set *pReg to zero.
4185f30a969bSdrh **
4186f30a969bSdrh ** If pExpr is a constant, then this routine might generate this
4187f30a969bSdrh ** code to fill the register in the initialization section of the
4188f30a969bSdrh ** VDBE program, in order to factor it out of the evaluation loop.
41892dcef11bSdrh */
41902dcef11bSdrh int sqlite3ExprCodeTemp(Parse *pParse, Expr *pExpr, int *pReg){
4191f30a969bSdrh   int r2;
4192f30a969bSdrh   pExpr = sqlite3ExprSkipCollate(pExpr);
4193d9f158e7Sdrh   if( ConstFactorOk(pParse)
4194f30a969bSdrh    && pExpr->op!=TK_REGISTER
4195f30a969bSdrh    && sqlite3ExprIsConstantNotJoin(pExpr)
4196f30a969bSdrh   ){
4197f30a969bSdrh     *pReg  = 0;
4198ad879ffdSdrh     r2 = sqlite3ExprCodeAtInit(pParse, pExpr, -1);
4199f30a969bSdrh   }else{
42002dcef11bSdrh     int r1 = sqlite3GetTempReg(pParse);
4201f30a969bSdrh     r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
42022dcef11bSdrh     if( r2==r1 ){
42032dcef11bSdrh       *pReg = r1;
42042dcef11bSdrh     }else{
42052dcef11bSdrh       sqlite3ReleaseTempReg(pParse, r1);
42062dcef11bSdrh       *pReg = 0;
42072dcef11bSdrh     }
4208f30a969bSdrh   }
42092dcef11bSdrh   return r2;
42102dcef11bSdrh }
42112dcef11bSdrh 
42122dcef11bSdrh /*
42132dcef11bSdrh ** Generate code that will evaluate expression pExpr and store the
42142dcef11bSdrh ** results in register target.  The results are guaranteed to appear
42152dcef11bSdrh ** in register target.
42162dcef11bSdrh */
421705a86c5cSdrh void sqlite3ExprCode(Parse *pParse, Expr *pExpr, int target){
42189cbf3425Sdrh   int inReg;
42199cbf3425Sdrh 
42209cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
4221ebc16717Sdrh   if( pExpr && pExpr->op==TK_REGISTER ){
4222ebc16717Sdrh     sqlite3VdbeAddOp2(pParse->pVdbe, OP_Copy, pExpr->iTable, target);
4223ebc16717Sdrh   }else{
42249cbf3425Sdrh     inReg = sqlite3ExprCodeTarget(pParse, pExpr, target);
42251c75c9d7Sdrh     assert( pParse->pVdbe!=0 || pParse->db->mallocFailed );
42260e359b30Sdrh     if( inReg!=target && pParse->pVdbe ){
42279cbf3425Sdrh       sqlite3VdbeAddOp2(pParse->pVdbe, OP_SCopy, inReg, target);
422817a7f8ddSdrh     }
4229ebc16717Sdrh   }
4230cce7d176Sdrh }
4231cce7d176Sdrh 
4232cce7d176Sdrh /*
42331c75c9d7Sdrh ** Make a transient copy of expression pExpr and then code it using
42341c75c9d7Sdrh ** sqlite3ExprCode().  This routine works just like sqlite3ExprCode()
42351c75c9d7Sdrh ** except that the input expression is guaranteed to be unchanged.
42361c75c9d7Sdrh */
42371c75c9d7Sdrh void sqlite3ExprCodeCopy(Parse *pParse, Expr *pExpr, int target){
42381c75c9d7Sdrh   sqlite3 *db = pParse->db;
42391c75c9d7Sdrh   pExpr = sqlite3ExprDup(db, pExpr, 0);
42401c75c9d7Sdrh   if( !db->mallocFailed ) sqlite3ExprCode(pParse, pExpr, target);
42411c75c9d7Sdrh   sqlite3ExprDelete(db, pExpr);
42421c75c9d7Sdrh }
42431c75c9d7Sdrh 
42441c75c9d7Sdrh /*
424505a86c5cSdrh ** Generate code that will evaluate expression pExpr and store the
424605a86c5cSdrh ** results in register target.  The results are guaranteed to appear
424705a86c5cSdrh ** in register target.  If the expression is constant, then this routine
424805a86c5cSdrh ** might choose to code the expression at initialization time.
424905a86c5cSdrh */
425005a86c5cSdrh void sqlite3ExprCodeFactorable(Parse *pParse, Expr *pExpr, int target){
4251b8b06690Sdrh   if( pParse->okConstFactor && sqlite3ExprIsConstantNotJoin(pExpr) ){
4252ad879ffdSdrh     sqlite3ExprCodeAtInit(pParse, pExpr, target);
425305a86c5cSdrh   }else{
425405a86c5cSdrh     sqlite3ExprCode(pParse, pExpr, target);
425505a86c5cSdrh   }
4256cce7d176Sdrh }
4257cce7d176Sdrh 
4258cce7d176Sdrh /*
425960ec914cSpeter.d.reid ** Generate code that evaluates the given expression and puts the result
4260de4fcfddSdrh ** in register target.
426125303780Sdrh **
42622dcef11bSdrh ** Also make a copy of the expression results into another "cache" register
42632dcef11bSdrh ** and modify the expression so that the next time it is evaluated,
42642dcef11bSdrh ** the result is a copy of the cache register.
42652dcef11bSdrh **
42662dcef11bSdrh ** This routine is used for expressions that are used multiple
42672dcef11bSdrh ** times.  They are evaluated once and the results of the expression
42682dcef11bSdrh ** are reused.
426925303780Sdrh */
427005a86c5cSdrh void sqlite3ExprCodeAndCache(Parse *pParse, Expr *pExpr, int target){
427125303780Sdrh   Vdbe *v = pParse->pVdbe;
427225303780Sdrh   int iMem;
427305a86c5cSdrh 
427405a86c5cSdrh   assert( target>0 );
427505a86c5cSdrh   assert( pExpr->op!=TK_REGISTER );
427605a86c5cSdrh   sqlite3ExprCode(pParse, pExpr, target);
42772dcef11bSdrh   iMem = ++pParse->nMem;
427805a86c5cSdrh   sqlite3VdbeAddOp2(v, OP_Copy, target, iMem);
4279a4c3c87eSdrh   exprToRegister(pExpr, iMem);
428025303780Sdrh }
42817e02e5e6Sdrh 
4282678ccce8Sdrh /*
4283268380caSdrh ** Generate code that pushes the value of every element of the given
42849cbf3425Sdrh ** expression list into a sequence of registers beginning at target.
4285268380caSdrh **
42863df6c3b1Sdrh ** Return the number of elements evaluated.  The number returned will
42873df6c3b1Sdrh ** usually be pList->nExpr but might be reduced if SQLITE_ECEL_OMITREF
42883df6c3b1Sdrh ** is defined.
4289d1a01edaSdrh **
4290d1a01edaSdrh ** The SQLITE_ECEL_DUP flag prevents the arguments from being
4291d1a01edaSdrh ** filled using OP_SCopy.  OP_Copy must be used instead.
4292d1a01edaSdrh **
4293d1a01edaSdrh ** The SQLITE_ECEL_FACTOR argument allows constant arguments to be
4294d1a01edaSdrh ** factored out into initialization code.
4295b0df9634Sdrh **
4296b0df9634Sdrh ** The SQLITE_ECEL_REF flag means that expressions in the list with
4297b0df9634Sdrh ** ExprList.a[].u.x.iOrderByCol>0 have already been evaluated and stored
4298b0df9634Sdrh ** in registers at srcReg, and so the value can be copied from there.
42993df6c3b1Sdrh ** If SQLITE_ECEL_OMITREF is also set, then the values with u.x.iOrderByCol>0
43003df6c3b1Sdrh ** are simply omitted rather than being copied from srcReg.
4301268380caSdrh */
43024adee20fSdanielk1977 int sqlite3ExprCodeExprList(
4303268380caSdrh   Parse *pParse,     /* Parsing context */
4304389a1adbSdrh   ExprList *pList,   /* The expression list to be coded */
4305191b54cbSdrh   int target,        /* Where to write results */
43065579d59fSdrh   int srcReg,        /* Source registers if SQLITE_ECEL_REF */
4307d1a01edaSdrh   u8 flags           /* SQLITE_ECEL_* flags */
4308268380caSdrh ){
4309268380caSdrh   struct ExprList_item *pItem;
43105579d59fSdrh   int i, j, n;
4311d1a01edaSdrh   u8 copyOp = (flags & SQLITE_ECEL_DUP) ? OP_Copy : OP_SCopy;
43125579d59fSdrh   Vdbe *v = pParse->pVdbe;
43139d8b3072Sdrh   assert( pList!=0 );
43149cbf3425Sdrh   assert( target>0 );
4315d81a142bSdrh   assert( pParse->pVdbe!=0 );  /* Never gets this far otherwise */
4316268380caSdrh   n = pList->nExpr;
4317d9f158e7Sdrh   if( !ConstFactorOk(pParse) ) flags &= ~SQLITE_ECEL_FACTOR;
4318191b54cbSdrh   for(pItem=pList->a, i=0; i<n; i++, pItem++){
43197445ffe2Sdrh     Expr *pExpr = pItem->pExpr;
432024e25d32Sdan #ifdef SQLITE_ENABLE_SORTER_REFERENCES
432124e25d32Sdan     if( pItem->bSorterRef ){
432224e25d32Sdan       i--;
432324e25d32Sdan       n--;
432424e25d32Sdan     }else
432524e25d32Sdan #endif
4326257c13faSdan     if( (flags & SQLITE_ECEL_REF)!=0 && (j = pItem->u.x.iOrderByCol)>0 ){
4327257c13faSdan       if( flags & SQLITE_ECEL_OMITREF ){
4328257c13faSdan         i--;
4329257c13faSdan         n--;
4330257c13faSdan       }else{
43315579d59fSdrh         sqlite3VdbeAddOp2(v, copyOp, j+srcReg-1, target+i);
4332257c13faSdan       }
4333b8b06690Sdrh     }else if( (flags & SQLITE_ECEL_FACTOR)!=0
4334b8b06690Sdrh            && sqlite3ExprIsConstantNotJoin(pExpr)
4335b8b06690Sdrh     ){
4336ad879ffdSdrh       sqlite3ExprCodeAtInit(pParse, pExpr, target+i);
4337d1a01edaSdrh     }else{
43387445ffe2Sdrh       int inReg = sqlite3ExprCodeTarget(pParse, pExpr, target+i);
4339746fd9ccSdrh       if( inReg!=target+i ){
43404eded604Sdrh         VdbeOp *pOp;
43414eded604Sdrh         if( copyOp==OP_Copy
43424eded604Sdrh          && (pOp=sqlite3VdbeGetOp(v, -1))->opcode==OP_Copy
43434eded604Sdrh          && pOp->p1+pOp->p3+1==inReg
43444eded604Sdrh          && pOp->p2+pOp->p3+1==target+i
43454eded604Sdrh         ){
43464eded604Sdrh           pOp->p3++;
43474eded604Sdrh         }else{
43484eded604Sdrh           sqlite3VdbeAddOp2(v, copyOp, inReg, target+i);
43494eded604Sdrh         }
4350d1a01edaSdrh       }
4351d176611bSdrh     }
4352268380caSdrh   }
4353f9b596ebSdrh   return n;
4354268380caSdrh }
4355268380caSdrh 
4356268380caSdrh /*
435736c563a2Sdrh ** Generate code for a BETWEEN operator.
435836c563a2Sdrh **
435936c563a2Sdrh **    x BETWEEN y AND z
436036c563a2Sdrh **
436136c563a2Sdrh ** The above is equivalent to
436236c563a2Sdrh **
436336c563a2Sdrh **    x>=y AND x<=z
436436c563a2Sdrh **
436536c563a2Sdrh ** Code it as such, taking care to do the common subexpression
436660ec914cSpeter.d.reid ** elimination of x.
436784b19a3dSdrh **
436884b19a3dSdrh ** The xJumpIf parameter determines details:
436984b19a3dSdrh **
437084b19a3dSdrh **    NULL:                   Store the boolean result in reg[dest]
437184b19a3dSdrh **    sqlite3ExprIfTrue:      Jump to dest if true
437284b19a3dSdrh **    sqlite3ExprIfFalse:     Jump to dest if false
437384b19a3dSdrh **
437484b19a3dSdrh ** The jumpIfNull parameter is ignored if xJumpIf is NULL.
437536c563a2Sdrh */
437636c563a2Sdrh static void exprCodeBetween(
437736c563a2Sdrh   Parse *pParse,    /* Parsing and code generating context */
437836c563a2Sdrh   Expr *pExpr,      /* The BETWEEN expression */
437984b19a3dSdrh   int dest,         /* Jump destination or storage location */
438084b19a3dSdrh   void (*xJump)(Parse*,Expr*,int,int), /* Action to take */
438136c563a2Sdrh   int jumpIfNull    /* Take the jump if the BETWEEN is NULL */
438236c563a2Sdrh ){
438336c563a2Sdrh  Expr exprAnd;     /* The AND operator in  x>=y AND x<=z  */
438436c563a2Sdrh   Expr compLeft;    /* The  x>=y  term */
438536c563a2Sdrh   Expr compRight;   /* The  x<=z  term */
4386db45bd5eSdrh   Expr exprX;       /* The  x  subexpression */
4387db45bd5eSdrh   int regFree1 = 0; /* Temporary use register */
438884b19a3dSdrh 
438971c57db0Sdan   memset(&compLeft, 0, sizeof(Expr));
439071c57db0Sdan   memset(&compRight, 0, sizeof(Expr));
439171c57db0Sdan   memset(&exprAnd, 0, sizeof(Expr));
4392db45bd5eSdrh 
4393db45bd5eSdrh   assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
4394a8e05761Sdrh   exprNodeCopy(&exprX, pExpr->pLeft);
439536c563a2Sdrh   exprAnd.op = TK_AND;
439636c563a2Sdrh   exprAnd.pLeft = &compLeft;
439736c563a2Sdrh   exprAnd.pRight = &compRight;
439836c563a2Sdrh   compLeft.op = TK_GE;
4399db45bd5eSdrh   compLeft.pLeft = &exprX;
440036c563a2Sdrh   compLeft.pRight = pExpr->x.pList->a[0].pExpr;
440136c563a2Sdrh   compRight.op = TK_LE;
4402db45bd5eSdrh   compRight.pLeft = &exprX;
440336c563a2Sdrh   compRight.pRight = pExpr->x.pList->a[1].pExpr;
440412abf408Sdrh   exprToRegister(&exprX, exprCodeVector(pParse, &exprX, &regFree1));
440584b19a3dSdrh   if( xJump ){
440684b19a3dSdrh     xJump(pParse, &exprAnd, dest, jumpIfNull);
440736c563a2Sdrh   }else{
440836fd41e5Sdrh     /* Mark the expression is being from the ON or USING clause of a join
440936fd41e5Sdrh     ** so that the sqlite3ExprCodeTarget() routine will not attempt to move
441036fd41e5Sdrh     ** it into the Parse.pConstExpr list.  We should use a new bit for this,
441136fd41e5Sdrh     ** for clarity, but we are out of bits in the Expr.flags field so we
441236fd41e5Sdrh     ** have to reuse the EP_FromJoin bit.  Bummer. */
4413db45bd5eSdrh     exprX.flags |= EP_FromJoin;
441471c57db0Sdan     sqlite3ExprCodeTarget(pParse, &exprAnd, dest);
441536c563a2Sdrh   }
4416db45bd5eSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
441736c563a2Sdrh 
441836c563a2Sdrh   /* Ensure adequate test coverage */
4419db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull==0 && regFree1==0 );
4420db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull==0 && regFree1!=0 );
4421db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull!=0 && regFree1==0 );
4422db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull!=0 && regFree1!=0 );
4423db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1==0 );
4424db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1!=0 );
4425db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1==0 );
4426db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1!=0 );
442784b19a3dSdrh   testcase( xJump==0 );
442836c563a2Sdrh }
442936c563a2Sdrh 
443036c563a2Sdrh /*
4431cce7d176Sdrh ** Generate code for a boolean expression such that a jump is made
4432cce7d176Sdrh ** to the label "dest" if the expression is true but execution
4433cce7d176Sdrh ** continues straight thru if the expression is false.
4434f5905aa7Sdrh **
4435f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false), then
443635573356Sdrh ** take the jump if the jumpIfNull flag is SQLITE_JUMPIFNULL.
4437f2bc013cSdrh **
4438f2bc013cSdrh ** This code depends on the fact that certain token values (ex: TK_EQ)
4439f2bc013cSdrh ** are the same as opcode values (ex: OP_Eq) that implement the corresponding
4440f2bc013cSdrh ** operation.  Special comments in vdbe.c and the mkopcodeh.awk script in
4441f2bc013cSdrh ** the make process cause these values to align.  Assert()s in the code
4442f2bc013cSdrh ** below verify that the numbers are aligned correctly.
4443cce7d176Sdrh */
44444adee20fSdanielk1977 void sqlite3ExprIfTrue(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
4445cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
4446cce7d176Sdrh   int op = 0;
44472dcef11bSdrh   int regFree1 = 0;
44482dcef11bSdrh   int regFree2 = 0;
44492dcef11bSdrh   int r1, r2;
44502dcef11bSdrh 
445135573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
445248864df9Smistachkin   if( NEVER(v==0) )     return;  /* Existence of VDBE checked by caller */
445333cd4909Sdrh   if( NEVER(pExpr==0) ) return;  /* No way this can happen */
4454f2bc013cSdrh   op = pExpr->op;
44557b35a77bSdan   switch( op ){
4456cce7d176Sdrh     case TK_AND: {
4457ec4ccdbcSdrh       int d2 = sqlite3VdbeMakeLabel(pParse);
4458c5499befSdrh       testcase( jumpIfNull==0 );
445935573356Sdrh       sqlite3ExprIfFalse(pParse, pExpr->pLeft, d2,jumpIfNull^SQLITE_JUMPIFNULL);
44604adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
44614adee20fSdanielk1977       sqlite3VdbeResolveLabel(v, d2);
4462cce7d176Sdrh       break;
4463cce7d176Sdrh     }
4464cce7d176Sdrh     case TK_OR: {
4465c5499befSdrh       testcase( jumpIfNull==0 );
44664adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
44674adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
4468cce7d176Sdrh       break;
4469cce7d176Sdrh     }
4470cce7d176Sdrh     case TK_NOT: {
4471c5499befSdrh       testcase( jumpIfNull==0 );
44724adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
4473cce7d176Sdrh       break;
4474cce7d176Sdrh     }
44758abed7b9Sdrh     case TK_TRUTH: {
447696acafbeSdrh       int isNot;      /* IS NOT TRUE or IS NOT FALSE */
447796acafbeSdrh       int isTrue;     /* IS TRUE or IS NOT TRUE */
4478007c843bSdrh       testcase( jumpIfNull==0 );
44798abed7b9Sdrh       isNot = pExpr->op2==TK_ISNOT;
448096acafbeSdrh       isTrue = sqlite3ExprTruthValue(pExpr->pRight);
448143c4ac8bSdrh       testcase( isTrue && isNot );
448296acafbeSdrh       testcase( !isTrue && isNot );
448343c4ac8bSdrh       if( isTrue ^ isNot ){
44848abed7b9Sdrh         sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
44858abed7b9Sdrh                           isNot ? SQLITE_JUMPIFNULL : 0);
44868abed7b9Sdrh       }else{
44878abed7b9Sdrh         sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
44888abed7b9Sdrh                            isNot ? SQLITE_JUMPIFNULL : 0);
44898abed7b9Sdrh       }
4490007c843bSdrh       break;
4491007c843bSdrh     }
4492de845c2fSdrh     case TK_IS:
4493de845c2fSdrh     case TK_ISNOT:
4494de845c2fSdrh       testcase( op==TK_IS );
4495de845c2fSdrh       testcase( op==TK_ISNOT );
4496de845c2fSdrh       op = (op==TK_IS) ? TK_EQ : TK_NE;
4497de845c2fSdrh       jumpIfNull = SQLITE_NULLEQ;
4498de845c2fSdrh       /* Fall thru */
4499cce7d176Sdrh     case TK_LT:
4500cce7d176Sdrh     case TK_LE:
4501cce7d176Sdrh     case TK_GT:
4502cce7d176Sdrh     case TK_GE:
4503cce7d176Sdrh     case TK_NE:
45040ac65892Sdrh     case TK_EQ: {
4505625015e0Sdan       if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
4506c5499befSdrh       testcase( jumpIfNull==0 );
4507b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4508b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
450935573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
45102dcef11bSdrh                   r1, r2, dest, jumpIfNull);
45117d176105Sdrh       assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
45127d176105Sdrh       assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
45137d176105Sdrh       assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
45147d176105Sdrh       assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
4515de845c2fSdrh       assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4516de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4517de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4518de845c2fSdrh       assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4519de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
4520de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
45216a2fe093Sdrh       testcase( regFree1==0 );
45226a2fe093Sdrh       testcase( regFree2==0 );
45236a2fe093Sdrh       break;
45246a2fe093Sdrh     }
4525cce7d176Sdrh     case TK_ISNULL:
4526cce7d176Sdrh     case TK_NOTNULL: {
45277d176105Sdrh       assert( TK_ISNULL==OP_IsNull );   testcase( op==TK_ISNULL );
45287d176105Sdrh       assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
45292dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
45302dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
45317d176105Sdrh       VdbeCoverageIf(v, op==TK_ISNULL);
45327d176105Sdrh       VdbeCoverageIf(v, op==TK_NOTNULL);
4533c5499befSdrh       testcase( regFree1==0 );
4534cce7d176Sdrh       break;
4535cce7d176Sdrh     }
4536fef5208cSdrh     case TK_BETWEEN: {
45375c03f30aSdrh       testcase( jumpIfNull==0 );
453871c57db0Sdan       exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfTrue, jumpIfNull);
4539fef5208cSdrh       break;
4540fef5208cSdrh     }
4541bb201344Sshaneh #ifndef SQLITE_OMIT_SUBQUERY
4542e3365e6cSdrh     case TK_IN: {
4543ec4ccdbcSdrh       int destIfFalse = sqlite3VdbeMakeLabel(pParse);
4544e3365e6cSdrh       int destIfNull = jumpIfNull ? dest : destIfFalse;
4545e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
4546076e85f5Sdrh       sqlite3VdbeGoto(v, dest);
4547e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
4548e3365e6cSdrh       break;
4549e3365e6cSdrh     }
4550bb201344Sshaneh #endif
4551cce7d176Sdrh     default: {
45527b35a77bSdan     default_expr:
4553991a1985Sdrh       if( exprAlwaysTrue(pExpr) ){
4554076e85f5Sdrh         sqlite3VdbeGoto(v, dest);
4555991a1985Sdrh       }else if( exprAlwaysFalse(pExpr) ){
4556991a1985Sdrh         /* No-op */
4557991a1985Sdrh       }else{
45582dcef11bSdrh         r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
45592dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_If, r1, dest, jumpIfNull!=0);
4560688852abSdrh         VdbeCoverage(v);
4561c5499befSdrh         testcase( regFree1==0 );
4562c5499befSdrh         testcase( jumpIfNull==0 );
4563991a1985Sdrh       }
4564cce7d176Sdrh       break;
4565cce7d176Sdrh     }
4566cce7d176Sdrh   }
45672dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
45682dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
4569cce7d176Sdrh }
4570cce7d176Sdrh 
4571cce7d176Sdrh /*
457266b89c8fSdrh ** Generate code for a boolean expression such that a jump is made
4573cce7d176Sdrh ** to the label "dest" if the expression is false but execution
4574cce7d176Sdrh ** continues straight thru if the expression is true.
4575f5905aa7Sdrh **
4576f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false) then
457735573356Sdrh ** jump if jumpIfNull is SQLITE_JUMPIFNULL or fall through if jumpIfNull
457835573356Sdrh ** is 0.
4579cce7d176Sdrh */
45804adee20fSdanielk1977 void sqlite3ExprIfFalse(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
4581cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
4582cce7d176Sdrh   int op = 0;
45832dcef11bSdrh   int regFree1 = 0;
45842dcef11bSdrh   int regFree2 = 0;
45852dcef11bSdrh   int r1, r2;
45862dcef11bSdrh 
458735573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
458848864df9Smistachkin   if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
458933cd4909Sdrh   if( pExpr==0 )    return;
4590f2bc013cSdrh 
4591f2bc013cSdrh   /* The value of pExpr->op and op are related as follows:
4592f2bc013cSdrh   **
4593f2bc013cSdrh   **       pExpr->op            op
4594f2bc013cSdrh   **       ---------          ----------
4595f2bc013cSdrh   **       TK_ISNULL          OP_NotNull
4596f2bc013cSdrh   **       TK_NOTNULL         OP_IsNull
4597f2bc013cSdrh   **       TK_NE              OP_Eq
4598f2bc013cSdrh   **       TK_EQ              OP_Ne
4599f2bc013cSdrh   **       TK_GT              OP_Le
4600f2bc013cSdrh   **       TK_LE              OP_Gt
4601f2bc013cSdrh   **       TK_GE              OP_Lt
4602f2bc013cSdrh   **       TK_LT              OP_Ge
4603f2bc013cSdrh   **
4604f2bc013cSdrh   ** For other values of pExpr->op, op is undefined and unused.
4605f2bc013cSdrh   ** The value of TK_ and OP_ constants are arranged such that we
4606f2bc013cSdrh   ** can compute the mapping above using the following expression.
4607f2bc013cSdrh   ** Assert()s verify that the computation is correct.
4608f2bc013cSdrh   */
4609f2bc013cSdrh   op = ((pExpr->op+(TK_ISNULL&1))^1)-(TK_ISNULL&1);
4610f2bc013cSdrh 
4611f2bc013cSdrh   /* Verify correct alignment of TK_ and OP_ constants
4612f2bc013cSdrh   */
4613f2bc013cSdrh   assert( pExpr->op!=TK_ISNULL || op==OP_NotNull );
4614f2bc013cSdrh   assert( pExpr->op!=TK_NOTNULL || op==OP_IsNull );
4615f2bc013cSdrh   assert( pExpr->op!=TK_NE || op==OP_Eq );
4616f2bc013cSdrh   assert( pExpr->op!=TK_EQ || op==OP_Ne );
4617f2bc013cSdrh   assert( pExpr->op!=TK_LT || op==OP_Ge );
4618f2bc013cSdrh   assert( pExpr->op!=TK_LE || op==OP_Gt );
4619f2bc013cSdrh   assert( pExpr->op!=TK_GT || op==OP_Le );
4620f2bc013cSdrh   assert( pExpr->op!=TK_GE || op==OP_Lt );
4621f2bc013cSdrh 
4622ba00e30aSdan   switch( pExpr->op ){
4623cce7d176Sdrh     case TK_AND: {
4624c5499befSdrh       testcase( jumpIfNull==0 );
46254adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
46264adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
4627cce7d176Sdrh       break;
4628cce7d176Sdrh     }
4629cce7d176Sdrh     case TK_OR: {
4630ec4ccdbcSdrh       int d2 = sqlite3VdbeMakeLabel(pParse);
4631c5499befSdrh       testcase( jumpIfNull==0 );
463235573356Sdrh       sqlite3ExprIfTrue(pParse, pExpr->pLeft, d2, jumpIfNull^SQLITE_JUMPIFNULL);
46334adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
46344adee20fSdanielk1977       sqlite3VdbeResolveLabel(v, d2);
4635cce7d176Sdrh       break;
4636cce7d176Sdrh     }
4637cce7d176Sdrh     case TK_NOT: {
46385c03f30aSdrh       testcase( jumpIfNull==0 );
46394adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
4640cce7d176Sdrh       break;
4641cce7d176Sdrh     }
46428abed7b9Sdrh     case TK_TRUTH: {
464396acafbeSdrh       int isNot;   /* IS NOT TRUE or IS NOT FALSE */
464496acafbeSdrh       int isTrue;  /* IS TRUE or IS NOT TRUE */
46458abed7b9Sdrh       testcase( jumpIfNull==0 );
46468abed7b9Sdrh       isNot = pExpr->op2==TK_ISNOT;
464796acafbeSdrh       isTrue = sqlite3ExprTruthValue(pExpr->pRight);
464843c4ac8bSdrh       testcase( isTrue && isNot );
464996acafbeSdrh       testcase( !isTrue && isNot );
465043c4ac8bSdrh       if( isTrue ^ isNot ){
46518abed7b9Sdrh         /* IS TRUE and IS NOT FALSE */
46528abed7b9Sdrh         sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
46538abed7b9Sdrh                            isNot ? 0 : SQLITE_JUMPIFNULL);
46548abed7b9Sdrh 
46558abed7b9Sdrh       }else{
46568abed7b9Sdrh         /* IS FALSE and IS NOT TRUE */
46578abed7b9Sdrh         sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
46588abed7b9Sdrh                           isNot ? 0 : SQLITE_JUMPIFNULL);
46598abed7b9Sdrh       }
4660007c843bSdrh       break;
4661007c843bSdrh     }
4662de845c2fSdrh     case TK_IS:
4663de845c2fSdrh     case TK_ISNOT:
4664de845c2fSdrh       testcase( pExpr->op==TK_IS );
4665de845c2fSdrh       testcase( pExpr->op==TK_ISNOT );
4666de845c2fSdrh       op = (pExpr->op==TK_IS) ? TK_NE : TK_EQ;
4667de845c2fSdrh       jumpIfNull = SQLITE_NULLEQ;
4668de845c2fSdrh       /* Fall thru */
4669cce7d176Sdrh     case TK_LT:
4670cce7d176Sdrh     case TK_LE:
4671cce7d176Sdrh     case TK_GT:
4672cce7d176Sdrh     case TK_GE:
4673cce7d176Sdrh     case TK_NE:
4674cce7d176Sdrh     case TK_EQ: {
4675625015e0Sdan       if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
4676c5499befSdrh       testcase( jumpIfNull==0 );
4677b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4678b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
467935573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
46802dcef11bSdrh                   r1, r2, dest, jumpIfNull);
46817d176105Sdrh       assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
46827d176105Sdrh       assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
46837d176105Sdrh       assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
46847d176105Sdrh       assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
4685de845c2fSdrh       assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4686de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4687de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4688de845c2fSdrh       assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4689de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
4690de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
46916a2fe093Sdrh       testcase( regFree1==0 );
46926a2fe093Sdrh       testcase( regFree2==0 );
46936a2fe093Sdrh       break;
46946a2fe093Sdrh     }
4695cce7d176Sdrh     case TK_ISNULL:
4696cce7d176Sdrh     case TK_NOTNULL: {
46972dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
46982dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
46997d176105Sdrh       testcase( op==TK_ISNULL );   VdbeCoverageIf(v, op==TK_ISNULL);
47007d176105Sdrh       testcase( op==TK_NOTNULL );  VdbeCoverageIf(v, op==TK_NOTNULL);
4701c5499befSdrh       testcase( regFree1==0 );
4702cce7d176Sdrh       break;
4703cce7d176Sdrh     }
4704fef5208cSdrh     case TK_BETWEEN: {
47055c03f30aSdrh       testcase( jumpIfNull==0 );
470671c57db0Sdan       exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfFalse, jumpIfNull);
4707fef5208cSdrh       break;
4708fef5208cSdrh     }
4709bb201344Sshaneh #ifndef SQLITE_OMIT_SUBQUERY
4710e3365e6cSdrh     case TK_IN: {
4711e3365e6cSdrh       if( jumpIfNull ){
4712e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, dest);
4713e3365e6cSdrh       }else{
4714ec4ccdbcSdrh         int destIfNull = sqlite3VdbeMakeLabel(pParse);
4715e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, destIfNull);
4716e3365e6cSdrh         sqlite3VdbeResolveLabel(v, destIfNull);
4717e3365e6cSdrh       }
4718e3365e6cSdrh       break;
4719e3365e6cSdrh     }
4720bb201344Sshaneh #endif
4721cce7d176Sdrh     default: {
4722ba00e30aSdan     default_expr:
4723991a1985Sdrh       if( exprAlwaysFalse(pExpr) ){
4724076e85f5Sdrh         sqlite3VdbeGoto(v, dest);
4725991a1985Sdrh       }else if( exprAlwaysTrue(pExpr) ){
4726991a1985Sdrh         /* no-op */
4727991a1985Sdrh       }else{
47282dcef11bSdrh         r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
47292dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_IfNot, r1, dest, jumpIfNull!=0);
4730688852abSdrh         VdbeCoverage(v);
4731c5499befSdrh         testcase( regFree1==0 );
4732c5499befSdrh         testcase( jumpIfNull==0 );
4733991a1985Sdrh       }
4734cce7d176Sdrh       break;
4735cce7d176Sdrh     }
4736cce7d176Sdrh   }
47372dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
47382dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
4739cce7d176Sdrh }
47402282792aSdrh 
47412282792aSdrh /*
474272bc8208Sdrh ** Like sqlite3ExprIfFalse() except that a copy is made of pExpr before
474372bc8208Sdrh ** code generation, and that copy is deleted after code generation. This
474472bc8208Sdrh ** ensures that the original pExpr is unchanged.
474572bc8208Sdrh */
474672bc8208Sdrh void sqlite3ExprIfFalseDup(Parse *pParse, Expr *pExpr, int dest,int jumpIfNull){
474772bc8208Sdrh   sqlite3 *db = pParse->db;
474872bc8208Sdrh   Expr *pCopy = sqlite3ExprDup(db, pExpr, 0);
474972bc8208Sdrh   if( db->mallocFailed==0 ){
475072bc8208Sdrh     sqlite3ExprIfFalse(pParse, pCopy, dest, jumpIfNull);
475172bc8208Sdrh   }
475272bc8208Sdrh   sqlite3ExprDelete(db, pCopy);
475372bc8208Sdrh }
475472bc8208Sdrh 
47555aa550cfSdan /*
47565aa550cfSdan ** Expression pVar is guaranteed to be an SQL variable. pExpr may be any
47575aa550cfSdan ** type of expression.
47585aa550cfSdan **
47595aa550cfSdan ** If pExpr is a simple SQL value - an integer, real, string, blob
47605aa550cfSdan ** or NULL value - then the VDBE currently being prepared is configured
47615aa550cfSdan ** to re-prepare each time a new value is bound to variable pVar.
47625aa550cfSdan **
47635aa550cfSdan ** Additionally, if pExpr is a simple SQL value and the value is the
47645aa550cfSdan ** same as that currently bound to variable pVar, non-zero is returned.
47655aa550cfSdan ** Otherwise, if the values are not the same or if pExpr is not a simple
47665aa550cfSdan ** SQL value, zero is returned.
47675aa550cfSdan */
47685aa550cfSdan static int exprCompareVariable(Parse *pParse, Expr *pVar, Expr *pExpr){
47695aa550cfSdan   int res = 0;
4770c0804226Sdrh   int iVar;
4771c0804226Sdrh   sqlite3_value *pL, *pR = 0;
47725aa550cfSdan 
47735aa550cfSdan   sqlite3ValueFromExpr(pParse->db, pExpr, SQLITE_UTF8, SQLITE_AFF_BLOB, &pR);
4774c0804226Sdrh   if( pR ){
4775c0804226Sdrh     iVar = pVar->iColumn;
4776c0804226Sdrh     sqlite3VdbeSetVarmask(pParse->pVdbe, iVar);
4777c0804226Sdrh     pL = sqlite3VdbeGetBoundValue(pParse->pReprepare, iVar, SQLITE_AFF_BLOB);
47785aa307e2Sdrh     if( pL ){
47795aa307e2Sdrh       if( sqlite3_value_type(pL)==SQLITE_TEXT ){
47805aa307e2Sdrh         sqlite3_value_text(pL); /* Make sure the encoding is UTF-8 */
47815aa307e2Sdrh       }
47825aa307e2Sdrh       res =  0==sqlite3MemCompare(pL, pR, 0);
47835aa550cfSdan     }
47845aa550cfSdan     sqlite3ValueFree(pR);
47855aa550cfSdan     sqlite3ValueFree(pL);
47865aa550cfSdan   }
47875aa550cfSdan 
47885aa550cfSdan   return res;
47895aa550cfSdan }
479072bc8208Sdrh 
479172bc8208Sdrh /*
47921d9da70aSdrh ** Do a deep comparison of two expression trees.  Return 0 if the two
47931d9da70aSdrh ** expressions are completely identical.  Return 1 if they differ only
47941d9da70aSdrh ** by a COLLATE operator at the top level.  Return 2 if there are differences
47951d9da70aSdrh ** other than the top-level COLLATE operator.
4796d40aab0eSdrh **
4797619a1305Sdrh ** If any subelement of pB has Expr.iTable==(-1) then it is allowed
4798619a1305Sdrh ** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
4799619a1305Sdrh **
480066518ca7Sdrh ** The pA side might be using TK_REGISTER.  If that is the case and pB is
480166518ca7Sdrh ** not using TK_REGISTER but is otherwise equivalent, then still return 0.
480266518ca7Sdrh **
48031d9da70aSdrh ** Sometimes this routine will return 2 even if the two expressions
4804d40aab0eSdrh ** really are equivalent.  If we cannot prove that the expressions are
48051d9da70aSdrh ** identical, we return 2 just to be safe.  So if this routine
48061d9da70aSdrh ** returns 2, then you do not really know for certain if the two
48071d9da70aSdrh ** expressions are the same.  But if you get a 0 or 1 return, then you
4808d40aab0eSdrh ** can be sure the expressions are the same.  In the places where
48091d9da70aSdrh ** this routine is used, it does not hurt to get an extra 2 - that
4810d40aab0eSdrh ** just might result in some slightly slower code.  But returning
48111d9da70aSdrh ** an incorrect 0 or 1 could lead to a malfunction.
48125aa550cfSdan **
4813c0804226Sdrh ** If pParse is not NULL then TK_VARIABLE terms in pA with bindings in
4814c0804226Sdrh ** pParse->pReprepare can be matched against literals in pB.  The
4815c0804226Sdrh ** pParse->pVdbe->expmask bitmask is updated for each variable referenced.
4816c0804226Sdrh ** If pParse is NULL (the normal case) then any TK_VARIABLE term in
4817c0804226Sdrh ** Argument pParse should normally be NULL. If it is not NULL and pA or
4818c0804226Sdrh ** pB causes a return value of 2.
48192282792aSdrh */
48205aa550cfSdan int sqlite3ExprCompare(Parse *pParse, Expr *pA, Expr *pB, int iTab){
482110d1edf0Sdrh   u32 combinedFlags;
48224b202ae2Sdanielk1977   if( pA==0 || pB==0 ){
48231d9da70aSdrh     return pB==pA ? 0 : 2;
48242282792aSdrh   }
48255aa550cfSdan   if( pParse && pA->op==TK_VARIABLE && exprCompareVariable(pParse, pA, pB) ){
48265aa550cfSdan     return 0;
48275aa550cfSdan   }
482810d1edf0Sdrh   combinedFlags = pA->flags | pB->flags;
482910d1edf0Sdrh   if( combinedFlags & EP_IntValue ){
483010d1edf0Sdrh     if( (pA->flags&pB->flags&EP_IntValue)!=0 && pA->u.iValue==pB->u.iValue ){
483110d1edf0Sdrh       return 0;
483210d1edf0Sdrh     }
48331d9da70aSdrh     return 2;
48346ab3a2ecSdanielk1977   }
483516dd3985Sdan   if( pA->op!=pB->op || pA->op==TK_RAISE ){
48365aa550cfSdan     if( pA->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA->pLeft,pB,iTab)<2 ){
4837ae80ddeaSdrh       return 1;
4838ae80ddeaSdrh     }
48395aa550cfSdan     if( pB->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA,pB->pLeft,iTab)<2 ){
4840ae80ddeaSdrh       return 1;
4841ae80ddeaSdrh     }
4842ae80ddeaSdrh     return 2;
4843ae80ddeaSdrh   }
48442edc5fd7Sdrh   if( pA->op!=TK_COLUMN && pA->op!=TK_AGG_COLUMN && pA->u.zToken ){
4845390b88a4Sdrh     if( pA->op==TK_FUNCTION ){
4846390b88a4Sdrh       if( sqlite3StrICmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
4847eda079cdSdrh #ifndef SQLITE_OMIT_WINDOWFUNC
4848eda079cdSdrh       /* Justification for the assert():
4849eda079cdSdrh       ** window functions have p->op==TK_FUNCTION but aggregate functions
4850eda079cdSdrh       ** have p->op==TK_AGG_FUNCTION.  So any comparison between an aggregate
4851eda079cdSdrh       ** function and a window function should have failed before reaching
4852eda079cdSdrh       ** this point.  And, it is not possible to have a window function and
4853eda079cdSdrh       ** a scalar function with the same name and number of arguments.  So
4854eda079cdSdrh       ** if we reach this point, either A and B both window functions or
4855eda079cdSdrh       ** neither are a window functions. */
4856eda079cdSdrh       assert( ExprHasProperty(pA,EP_WinFunc)==ExprHasProperty(pB,EP_WinFunc) );
4857eda079cdSdrh       if( ExprHasProperty(pA,EP_WinFunc) ){
4858eda079cdSdrh         if( sqlite3WindowCompare(pParse,pA->y.pWin,pB->y.pWin)!=0 ) return 2;
4859eda079cdSdrh       }
4860eda079cdSdrh #endif
4861*f20bbc5fSdrh     }else if( pA->op==TK_NULL ){
4862*f20bbc5fSdrh       return 0;
4863d5af5420Sdrh     }else if( pA->op==TK_COLLATE ){
4864e79f6299Sdrh       if( sqlite3_stricmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
4865*f20bbc5fSdrh     }else if( ALWAYS(pB->u.zToken!=0) && strcmp(pA->u.zToken,pB->u.zToken)!=0 ){
4866d5af5420Sdrh       return 2;
486710d1edf0Sdrh     }
486810d1edf0Sdrh   }
486910d1edf0Sdrh   if( (pA->flags & EP_Distinct)!=(pB->flags & EP_Distinct) ) return 2;
487089b6de03Sdrh   if( (combinedFlags & EP_TokenOnly)==0 ){
487110d1edf0Sdrh     if( combinedFlags & EP_xIsSelect ) return 2;
4872efad2e23Sdrh     if( (combinedFlags & EP_FixedCol)==0
4873efad2e23Sdrh      && sqlite3ExprCompare(pParse, pA->pLeft, pB->pLeft, iTab) ) return 2;
48745aa550cfSdan     if( sqlite3ExprCompare(pParse, pA->pRight, pB->pRight, iTab) ) return 2;
4875619a1305Sdrh     if( sqlite3ExprListCompare(pA->x.pList, pB->x.pList, iTab) ) return 2;
487603c5c213Sdrh     if( pA->op!=TK_STRING
487703c5c213Sdrh      && pA->op!=TK_TRUEFALSE
487803c5c213Sdrh      && (combinedFlags & EP_Reduced)==0
487903c5c213Sdrh     ){
4880619a1305Sdrh       if( pA->iColumn!=pB->iColumn ) return 2;
488166518ca7Sdrh       if( pA->iTable!=pB->iTable
488285f8aa79Sdrh        && (pA->iTable!=iTab || NEVER(pB->iTable>=0)) ) return 2;
48831d9da70aSdrh     }
48841d9da70aSdrh   }
48852646da7eSdrh   return 0;
48862646da7eSdrh }
48872282792aSdrh 
48888c6f666bSdrh /*
48898c6f666bSdrh ** Compare two ExprList objects.  Return 0 if they are identical and
48908c6f666bSdrh ** non-zero if they differ in any way.
48918c6f666bSdrh **
4892619a1305Sdrh ** If any subelement of pB has Expr.iTable==(-1) then it is allowed
4893619a1305Sdrh ** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
4894619a1305Sdrh **
48958c6f666bSdrh ** This routine might return non-zero for equivalent ExprLists.  The
48968c6f666bSdrh ** only consequence will be disabled optimizations.  But this routine
48978c6f666bSdrh ** must never return 0 if the two ExprList objects are different, or
48988c6f666bSdrh ** a malfunction will result.
48998c6f666bSdrh **
49008c6f666bSdrh ** Two NULL pointers are considered to be the same.  But a NULL pointer
49018c6f666bSdrh ** always differs from a non-NULL pointer.
49028c6f666bSdrh */
4903619a1305Sdrh int sqlite3ExprListCompare(ExprList *pA, ExprList *pB, int iTab){
49048c6f666bSdrh   int i;
49058c6f666bSdrh   if( pA==0 && pB==0 ) return 0;
49068c6f666bSdrh   if( pA==0 || pB==0 ) return 1;
49078c6f666bSdrh   if( pA->nExpr!=pB->nExpr ) return 1;
49088c6f666bSdrh   for(i=0; i<pA->nExpr; i++){
49098c6f666bSdrh     Expr *pExprA = pA->a[i].pExpr;
49108c6f666bSdrh     Expr *pExprB = pB->a[i].pExpr;
49118c6f666bSdrh     if( pA->a[i].sortOrder!=pB->a[i].sortOrder ) return 1;
49125aa550cfSdan     if( sqlite3ExprCompare(0, pExprA, pExprB, iTab) ) return 1;
49138c6f666bSdrh   }
49148c6f666bSdrh   return 0;
49158c6f666bSdrh }
491613449892Sdrh 
49172282792aSdrh /*
4918f9463dfbSdrh ** Like sqlite3ExprCompare() except COLLATE operators at the top-level
4919f9463dfbSdrh ** are ignored.
4920f9463dfbSdrh */
4921f9463dfbSdrh int sqlite3ExprCompareSkip(Expr *pA, Expr *pB, int iTab){
49225aa550cfSdan   return sqlite3ExprCompare(0,
4923f9463dfbSdrh              sqlite3ExprSkipCollate(pA),
4924f9463dfbSdrh              sqlite3ExprSkipCollate(pB),
4925f9463dfbSdrh              iTab);
4926f9463dfbSdrh }
4927f9463dfbSdrh 
4928f9463dfbSdrh /*
49294bd5f73fSdrh ** Return true if we can prove the pE2 will always be true if pE1 is
49304bd5f73fSdrh ** true.  Return false if we cannot complete the proof or if pE2 might
49314bd5f73fSdrh ** be false.  Examples:
49324bd5f73fSdrh **
4933619a1305Sdrh **     pE1: x==5       pE2: x==5             Result: true
49344bd5f73fSdrh **     pE1: x>0        pE2: x==5             Result: false
4935619a1305Sdrh **     pE1: x=21       pE2: x=21 OR y=43     Result: true
49364bd5f73fSdrh **     pE1: x!=123     pE2: x IS NOT NULL    Result: true
4937619a1305Sdrh **     pE1: x!=?1      pE2: x IS NOT NULL    Result: true
4938619a1305Sdrh **     pE1: x IS NULL  pE2: x IS NOT NULL    Result: false
4939619a1305Sdrh **     pE1: x IS ?2    pE2: x IS NOT NULL    Reuslt: false
49404bd5f73fSdrh **
49414bd5f73fSdrh ** When comparing TK_COLUMN nodes between pE1 and pE2, if pE2 has
49424bd5f73fSdrh ** Expr.iTable<0 then assume a table number given by iTab.
49434bd5f73fSdrh **
4944c0804226Sdrh ** If pParse is not NULL, then the values of bound variables in pE1 are
4945c0804226Sdrh ** compared against literal values in pE2 and pParse->pVdbe->expmask is
4946c0804226Sdrh ** modified to record which bound variables are referenced.  If pParse
4947c0804226Sdrh ** is NULL, then false will be returned if pE1 contains any bound variables.
4948c0804226Sdrh **
49494bd5f73fSdrh ** When in doubt, return false.  Returning true might give a performance
49504bd5f73fSdrh ** improvement.  Returning false might cause a performance reduction, but
49514bd5f73fSdrh ** it will always give the correct answer and is hence always safe.
49524bd5f73fSdrh */
49535aa550cfSdan int sqlite3ExprImpliesExpr(Parse *pParse, Expr *pE1, Expr *pE2, int iTab){
49545aa550cfSdan   if( sqlite3ExprCompare(pParse, pE1, pE2, iTab)==0 ){
4955619a1305Sdrh     return 1;
4956619a1305Sdrh   }
4957619a1305Sdrh   if( pE2->op==TK_OR
49585aa550cfSdan    && (sqlite3ExprImpliesExpr(pParse, pE1, pE2->pLeft, iTab)
49595aa550cfSdan              || sqlite3ExprImpliesExpr(pParse, pE1, pE2->pRight, iTab) )
4960619a1305Sdrh   ){
4961619a1305Sdrh     return 1;
4962619a1305Sdrh   }
49631ad93a00Sdrh   if( pE2->op==TK_NOTNULL && pE1->op!=TK_ISNULL && pE1->op!=TK_IS ){
49641ad93a00Sdrh     Expr *pX = sqlite3ExprSkipCollate(pE1->pLeft);
49651ad93a00Sdrh     testcase( pX!=pE1->pLeft );
49665aa550cfSdan     if( sqlite3ExprCompare(pParse, pX, pE2->pLeft, iTab)==0 ) return 1;
4967619a1305Sdrh   }
4968619a1305Sdrh   return 0;
49694bd5f73fSdrh }
49704bd5f73fSdrh 
49714bd5f73fSdrh /*
49722589787cSdrh ** This is the Expr node callback for sqlite3ExprImpliesNotNullRow().
49732589787cSdrh ** If the expression node requires that the table at pWalker->iCur
4974f8937f90Sdrh ** have one or more non-NULL column, then set pWalker->eCode to 1 and abort.
4975f8937f90Sdrh **
4976f8937f90Sdrh ** This routine controls an optimization.  False positives (setting
4977f8937f90Sdrh ** pWalker->eCode to 1 when it should not be) are deadly, but false-negatives
4978f8937f90Sdrh ** (never setting pWalker->eCode) is a harmless missed optimization.
49792589787cSdrh */
49802589787cSdrh static int impliesNotNullRow(Walker *pWalker, Expr *pExpr){
4981f8937f90Sdrh   testcase( pExpr->op==TK_AGG_COLUMN );
4982821b610bSdrh   testcase( pExpr->op==TK_AGG_FUNCTION );
49832589787cSdrh   if( ExprHasProperty(pExpr, EP_FromJoin) ) return WRC_Prune;
49842589787cSdrh   switch( pExpr->op ){
49850493222fSdan     case TK_ISNOT:
4986a1054dccSdan     case TK_NOT:
49872589787cSdrh     case TK_ISNULL:
49882589787cSdrh     case TK_IS:
49892589787cSdrh     case TK_OR:
49902c492061Sdrh     case TK_CASE:
4991e3eff266Sdrh     case TK_IN:
49922589787cSdrh     case TK_FUNCTION:
49930493222fSdan       testcase( pExpr->op==TK_ISNOT );
49940493222fSdan       testcase( pExpr->op==TK_NOT );
4995821b610bSdrh       testcase( pExpr->op==TK_ISNULL );
4996821b610bSdrh       testcase( pExpr->op==TK_IS );
4997821b610bSdrh       testcase( pExpr->op==TK_OR );
4998821b610bSdrh       testcase( pExpr->op==TK_CASE );
4999821b610bSdrh       testcase( pExpr->op==TK_IN );
5000821b610bSdrh       testcase( pExpr->op==TK_FUNCTION );
50012589787cSdrh       return WRC_Prune;
50022589787cSdrh     case TK_COLUMN:
50032589787cSdrh       if( pWalker->u.iCur==pExpr->iTable ){
50042589787cSdrh         pWalker->eCode = 1;
50052589787cSdrh         return WRC_Abort;
50062589787cSdrh       }
50072589787cSdrh       return WRC_Prune;
50089881155dSdrh 
50099881155dSdrh     /* Virtual tables are allowed to use constraints like x=NULL.  So
50109881155dSdrh     ** a term of the form x=y does not prove that y is not null if x
50119881155dSdrh     ** is the column of a virtual table */
50129881155dSdrh     case TK_EQ:
50139881155dSdrh     case TK_NE:
50149881155dSdrh     case TK_LT:
50159881155dSdrh     case TK_LE:
50169881155dSdrh     case TK_GT:
50179881155dSdrh     case TK_GE:
50189881155dSdrh       testcase( pExpr->op==TK_EQ );
50199881155dSdrh       testcase( pExpr->op==TK_NE );
50209881155dSdrh       testcase( pExpr->op==TK_LT );
50219881155dSdrh       testcase( pExpr->op==TK_LE );
50229881155dSdrh       testcase( pExpr->op==TK_GT );
50239881155dSdrh       testcase( pExpr->op==TK_GE );
5024eda079cdSdrh       if( (pExpr->pLeft->op==TK_COLUMN && IsVirtual(pExpr->pLeft->y.pTab))
5025eda079cdSdrh        || (pExpr->pRight->op==TK_COLUMN && IsVirtual(pExpr->pRight->y.pTab))
50269881155dSdrh       ){
50279881155dSdrh        return WRC_Prune;
50289881155dSdrh       }
50292589787cSdrh     default:
50302589787cSdrh       return WRC_Continue;
50312589787cSdrh   }
50322589787cSdrh }
50332589787cSdrh 
50342589787cSdrh /*
50352589787cSdrh ** Return true (non-zero) if expression p can only be true if at least
50362589787cSdrh ** one column of table iTab is non-null.  In other words, return true
50372589787cSdrh ** if expression p will always be NULL or false if every column of iTab
50382589787cSdrh ** is NULL.
50392589787cSdrh **
5040821b610bSdrh ** False negatives are acceptable.  In other words, it is ok to return
5041821b610bSdrh ** zero even if expression p will never be true of every column of iTab
5042821b610bSdrh ** is NULL.  A false negative is merely a missed optimization opportunity.
5043821b610bSdrh **
5044821b610bSdrh ** False positives are not allowed, however.  A false positive may result
5045821b610bSdrh ** in an incorrect answer.
5046821b610bSdrh **
50472589787cSdrh ** Terms of p that are marked with EP_FromJoin (and hence that come from
50482589787cSdrh ** the ON or USING clauses of LEFT JOINS) are excluded from the analysis.
50492589787cSdrh **
50502589787cSdrh ** This routine is used to check if a LEFT JOIN can be converted into
50512589787cSdrh ** an ordinary JOIN.  The p argument is the WHERE clause.  If the WHERE
50522589787cSdrh ** clause requires that some column of the right table of the LEFT JOIN
50532589787cSdrh ** be non-NULL, then the LEFT JOIN can be safely converted into an
50542589787cSdrh ** ordinary join.
50552589787cSdrh */
50562589787cSdrh int sqlite3ExprImpliesNonNullRow(Expr *p, int iTab){
50572589787cSdrh   Walker w;
50582589787cSdrh   w.xExprCallback = impliesNotNullRow;
50592589787cSdrh   w.xSelectCallback = 0;
50602589787cSdrh   w.xSelectCallback2 = 0;
50612589787cSdrh   w.eCode = 0;
50622589787cSdrh   w.u.iCur = iTab;
50632589787cSdrh   sqlite3WalkExpr(&w, p);
50642589787cSdrh   return w.eCode;
50652589787cSdrh }
50662589787cSdrh 
50672589787cSdrh /*
5068030796dfSdrh ** An instance of the following structure is used by the tree walker
50692409f8a1Sdrh ** to determine if an expression can be evaluated by reference to the
50702409f8a1Sdrh ** index only, without having to do a search for the corresponding
50712409f8a1Sdrh ** table entry.  The IdxCover.pIdx field is the index.  IdxCover.iCur
50722409f8a1Sdrh ** is the cursor for the table.
50732409f8a1Sdrh */
50742409f8a1Sdrh struct IdxCover {
50752409f8a1Sdrh   Index *pIdx;     /* The index to be tested for coverage */
50762409f8a1Sdrh   int iCur;        /* Cursor number for the table corresponding to the index */
50772409f8a1Sdrh };
50782409f8a1Sdrh 
50792409f8a1Sdrh /*
50802409f8a1Sdrh ** Check to see if there are references to columns in table
50812409f8a1Sdrh ** pWalker->u.pIdxCover->iCur can be satisfied using the index
50822409f8a1Sdrh ** pWalker->u.pIdxCover->pIdx.
50832409f8a1Sdrh */
50842409f8a1Sdrh static int exprIdxCover(Walker *pWalker, Expr *pExpr){
50852409f8a1Sdrh   if( pExpr->op==TK_COLUMN
50862409f8a1Sdrh    && pExpr->iTable==pWalker->u.pIdxCover->iCur
50872409f8a1Sdrh    && sqlite3ColumnOfIndex(pWalker->u.pIdxCover->pIdx, pExpr->iColumn)<0
50882409f8a1Sdrh   ){
50892409f8a1Sdrh     pWalker->eCode = 1;
50902409f8a1Sdrh     return WRC_Abort;
50912409f8a1Sdrh   }
50922409f8a1Sdrh   return WRC_Continue;
50932409f8a1Sdrh }
50942409f8a1Sdrh 
50952409f8a1Sdrh /*
5096e604ec0bSdrh ** Determine if an index pIdx on table with cursor iCur contains will
5097e604ec0bSdrh ** the expression pExpr.  Return true if the index does cover the
5098e604ec0bSdrh ** expression and false if the pExpr expression references table columns
5099e604ec0bSdrh ** that are not found in the index pIdx.
51002409f8a1Sdrh **
51012409f8a1Sdrh ** An index covering an expression means that the expression can be
51022409f8a1Sdrh ** evaluated using only the index and without having to lookup the
51032409f8a1Sdrh ** corresponding table entry.
51042409f8a1Sdrh */
51052409f8a1Sdrh int sqlite3ExprCoveredByIndex(
51062409f8a1Sdrh   Expr *pExpr,        /* The index to be tested */
51072409f8a1Sdrh   int iCur,           /* The cursor number for the corresponding table */
51082409f8a1Sdrh   Index *pIdx         /* The index that might be used for coverage */
51092409f8a1Sdrh ){
51102409f8a1Sdrh   Walker w;
51112409f8a1Sdrh   struct IdxCover xcov;
51122409f8a1Sdrh   memset(&w, 0, sizeof(w));
51132409f8a1Sdrh   xcov.iCur = iCur;
51142409f8a1Sdrh   xcov.pIdx = pIdx;
51152409f8a1Sdrh   w.xExprCallback = exprIdxCover;
51162409f8a1Sdrh   w.u.pIdxCover = &xcov;
51172409f8a1Sdrh   sqlite3WalkExpr(&w, pExpr);
51182409f8a1Sdrh   return !w.eCode;
51192409f8a1Sdrh }
51202409f8a1Sdrh 
51212409f8a1Sdrh 
51222409f8a1Sdrh /*
51232409f8a1Sdrh ** An instance of the following structure is used by the tree walker
5124030796dfSdrh ** to count references to table columns in the arguments of an
5125ed551b95Sdrh ** aggregate function, in order to implement the
5126ed551b95Sdrh ** sqlite3FunctionThisSrc() routine.
5127374fdce4Sdrh */
5128030796dfSdrh struct SrcCount {
5129030796dfSdrh   SrcList *pSrc;   /* One particular FROM clause in a nested query */
5130030796dfSdrh   int nThis;       /* Number of references to columns in pSrcList */
5131030796dfSdrh   int nOther;      /* Number of references to columns in other FROM clauses */
5132030796dfSdrh };
5133030796dfSdrh 
5134030796dfSdrh /*
5135030796dfSdrh ** Count the number of references to columns.
5136030796dfSdrh */
5137030796dfSdrh static int exprSrcCount(Walker *pWalker, Expr *pExpr){
5138fb0a6081Sdrh   /* The NEVER() on the second term is because sqlite3FunctionUsesThisSrc()
5139fb0a6081Sdrh   ** is always called before sqlite3ExprAnalyzeAggregates() and so the
5140fb0a6081Sdrh   ** TK_COLUMNs have not yet been converted into TK_AGG_COLUMN.  If
5141fb0a6081Sdrh   ** sqlite3FunctionUsesThisSrc() is used differently in the future, the
5142fb0a6081Sdrh   ** NEVER() will need to be removed. */
5143fb0a6081Sdrh   if( pExpr->op==TK_COLUMN || NEVER(pExpr->op==TK_AGG_COLUMN) ){
5144374fdce4Sdrh     int i;
5145030796dfSdrh     struct SrcCount *p = pWalker->u.pSrcCount;
5146030796dfSdrh     SrcList *pSrc = p->pSrc;
5147655814d2Sdrh     int nSrc = pSrc ? pSrc->nSrc : 0;
5148655814d2Sdrh     for(i=0; i<nSrc; i++){
5149030796dfSdrh       if( pExpr->iTable==pSrc->a[i].iCursor ) break;
5150374fdce4Sdrh     }
5151655814d2Sdrh     if( i<nSrc ){
5152030796dfSdrh       p->nThis++;
5153374fdce4Sdrh     }else{
5154030796dfSdrh       p->nOther++;
5155374fdce4Sdrh     }
5156374fdce4Sdrh   }
5157030796dfSdrh   return WRC_Continue;
5158030796dfSdrh }
5159374fdce4Sdrh 
5160374fdce4Sdrh /*
5161030796dfSdrh ** Determine if any of the arguments to the pExpr Function reference
5162030796dfSdrh ** pSrcList.  Return true if they do.  Also return true if the function
5163030796dfSdrh ** has no arguments or has only constant arguments.  Return false if pExpr
5164030796dfSdrh ** references columns but not columns of tables found in pSrcList.
5165374fdce4Sdrh */
5166030796dfSdrh int sqlite3FunctionUsesThisSrc(Expr *pExpr, SrcList *pSrcList){
5167374fdce4Sdrh   Walker w;
5168030796dfSdrh   struct SrcCount cnt;
5169374fdce4Sdrh   assert( pExpr->op==TK_AGG_FUNCTION );
5170030796dfSdrh   w.xExprCallback = exprSrcCount;
5171979dd1beSdrh   w.xSelectCallback = 0;
5172030796dfSdrh   w.u.pSrcCount = &cnt;
5173030796dfSdrh   cnt.pSrc = pSrcList;
5174030796dfSdrh   cnt.nThis = 0;
5175030796dfSdrh   cnt.nOther = 0;
5176030796dfSdrh   sqlite3WalkExprList(&w, pExpr->x.pList);
5177030796dfSdrh   return cnt.nThis>0 || cnt.nOther==0;
5178374fdce4Sdrh }
5179374fdce4Sdrh 
5180374fdce4Sdrh /*
518113449892Sdrh ** Add a new element to the pAggInfo->aCol[] array.  Return the index of
518213449892Sdrh ** the new element.  Return a negative number if malloc fails.
51832282792aSdrh */
518417435752Sdrh static int addAggInfoColumn(sqlite3 *db, AggInfo *pInfo){
518513449892Sdrh   int i;
5186cf643729Sdrh   pInfo->aCol = sqlite3ArrayAllocate(
518717435752Sdrh        db,
5188cf643729Sdrh        pInfo->aCol,
5189cf643729Sdrh        sizeof(pInfo->aCol[0]),
5190cf643729Sdrh        &pInfo->nColumn,
5191cf643729Sdrh        &i
5192cf643729Sdrh   );
519313449892Sdrh   return i;
51942282792aSdrh }
519513449892Sdrh 
519613449892Sdrh /*
519713449892Sdrh ** Add a new element to the pAggInfo->aFunc[] array.  Return the index of
519813449892Sdrh ** the new element.  Return a negative number if malloc fails.
519913449892Sdrh */
520017435752Sdrh static int addAggInfoFunc(sqlite3 *db, AggInfo *pInfo){
520113449892Sdrh   int i;
5202cf643729Sdrh   pInfo->aFunc = sqlite3ArrayAllocate(
520317435752Sdrh        db,
5204cf643729Sdrh        pInfo->aFunc,
5205cf643729Sdrh        sizeof(pInfo->aFunc[0]),
5206cf643729Sdrh        &pInfo->nFunc,
5207cf643729Sdrh        &i
5208cf643729Sdrh   );
520913449892Sdrh   return i;
52102282792aSdrh }
52112282792aSdrh 
52122282792aSdrh /*
52137d10d5a6Sdrh ** This is the xExprCallback for a tree walker.  It is used to
52147d10d5a6Sdrh ** implement sqlite3ExprAnalyzeAggregates().  See sqlite3ExprAnalyzeAggregates
5215626a879aSdrh ** for additional information.
52162282792aSdrh */
52177d10d5a6Sdrh static int analyzeAggregate(Walker *pWalker, Expr *pExpr){
52182282792aSdrh   int i;
52197d10d5a6Sdrh   NameContext *pNC = pWalker->u.pNC;
5220a58fdfb1Sdanielk1977   Parse *pParse = pNC->pParse;
5221a58fdfb1Sdanielk1977   SrcList *pSrcList = pNC->pSrcList;
522225c3b8caSdrh   AggInfo *pAggInfo = pNC->uNC.pAggInfo;
522313449892Sdrh 
522425c3b8caSdrh   assert( pNC->ncFlags & NC_UAggInfo );
52252282792aSdrh   switch( pExpr->op ){
522689c69d00Sdrh     case TK_AGG_COLUMN:
5227967e8b73Sdrh     case TK_COLUMN: {
52288b213899Sdrh       testcase( pExpr->op==TK_AGG_COLUMN );
52298b213899Sdrh       testcase( pExpr->op==TK_COLUMN );
523013449892Sdrh       /* Check to see if the column is in one of the tables in the FROM
523113449892Sdrh       ** clause of the aggregate query */
523220bc393cSdrh       if( ALWAYS(pSrcList!=0) ){
523313449892Sdrh         struct SrcList_item *pItem = pSrcList->a;
523413449892Sdrh         for(i=0; i<pSrcList->nSrc; i++, pItem++){
523513449892Sdrh           struct AggInfo_col *pCol;
5236c5cd1249Sdrh           assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
523713449892Sdrh           if( pExpr->iTable==pItem->iCursor ){
523813449892Sdrh             /* If we reach this point, it means that pExpr refers to a table
523913449892Sdrh             ** that is in the FROM clause of the aggregate query.
524013449892Sdrh             **
524113449892Sdrh             ** Make an entry for the column in pAggInfo->aCol[] if there
524213449892Sdrh             ** is not an entry there already.
524313449892Sdrh             */
52447f906d63Sdrh             int k;
524513449892Sdrh             pCol = pAggInfo->aCol;
52467f906d63Sdrh             for(k=0; k<pAggInfo->nColumn; k++, pCol++){
524713449892Sdrh               if( pCol->iTable==pExpr->iTable &&
524813449892Sdrh                   pCol->iColumn==pExpr->iColumn ){
52492282792aSdrh                 break;
52502282792aSdrh               }
52512282792aSdrh             }
52521e536953Sdanielk1977             if( (k>=pAggInfo->nColumn)
52531e536953Sdanielk1977              && (k = addAggInfoColumn(pParse->db, pAggInfo))>=0
52541e536953Sdanielk1977             ){
52557f906d63Sdrh               pCol = &pAggInfo->aCol[k];
5256eda079cdSdrh               pCol->pTab = pExpr->y.pTab;
525713449892Sdrh               pCol->iTable = pExpr->iTable;
525813449892Sdrh               pCol->iColumn = pExpr->iColumn;
52590a07c107Sdrh               pCol->iMem = ++pParse->nMem;
526013449892Sdrh               pCol->iSorterColumn = -1;
52615774b806Sdrh               pCol->pExpr = pExpr;
526213449892Sdrh               if( pAggInfo->pGroupBy ){
526313449892Sdrh                 int j, n;
526413449892Sdrh                 ExprList *pGB = pAggInfo->pGroupBy;
526513449892Sdrh                 struct ExprList_item *pTerm = pGB->a;
526613449892Sdrh                 n = pGB->nExpr;
526713449892Sdrh                 for(j=0; j<n; j++, pTerm++){
526813449892Sdrh                   Expr *pE = pTerm->pExpr;
526913449892Sdrh                   if( pE->op==TK_COLUMN && pE->iTable==pExpr->iTable &&
527013449892Sdrh                       pE->iColumn==pExpr->iColumn ){
527113449892Sdrh                     pCol->iSorterColumn = j;
527213449892Sdrh                     break;
52732282792aSdrh                   }
527413449892Sdrh                 }
527513449892Sdrh               }
527613449892Sdrh               if( pCol->iSorterColumn<0 ){
527713449892Sdrh                 pCol->iSorterColumn = pAggInfo->nSortingColumn++;
527813449892Sdrh               }
527913449892Sdrh             }
528013449892Sdrh             /* There is now an entry for pExpr in pAggInfo->aCol[] (either
528113449892Sdrh             ** because it was there before or because we just created it).
528213449892Sdrh             ** Convert the pExpr to be a TK_AGG_COLUMN referring to that
528313449892Sdrh             ** pAggInfo->aCol[] entry.
528413449892Sdrh             */
5285ebb6a65dSdrh             ExprSetVVAProperty(pExpr, EP_NoReduce);
528613449892Sdrh             pExpr->pAggInfo = pAggInfo;
528713449892Sdrh             pExpr->op = TK_AGG_COLUMN;
5288cf697396Sshane             pExpr->iAgg = (i16)k;
528913449892Sdrh             break;
529013449892Sdrh           } /* endif pExpr->iTable==pItem->iCursor */
529113449892Sdrh         } /* end loop over pSrcList */
5292a58fdfb1Sdanielk1977       }
52937d10d5a6Sdrh       return WRC_Prune;
52942282792aSdrh     }
52952282792aSdrh     case TK_AGG_FUNCTION: {
52963a8c4be7Sdrh       if( (pNC->ncFlags & NC_InAggFunc)==0
5297ed551b95Sdrh        && pWalker->walkerDepth==pExpr->op2
52983a8c4be7Sdrh       ){
529913449892Sdrh         /* Check to see if pExpr is a duplicate of another aggregate
530013449892Sdrh         ** function that is already in the pAggInfo structure
530113449892Sdrh         */
530213449892Sdrh         struct AggInfo_func *pItem = pAggInfo->aFunc;
530313449892Sdrh         for(i=0; i<pAggInfo->nFunc; i++, pItem++){
53045aa550cfSdan           if( sqlite3ExprCompare(0, pItem->pExpr, pExpr, -1)==0 ){
53052282792aSdrh             break;
53062282792aSdrh           }
53072282792aSdrh         }
530813449892Sdrh         if( i>=pAggInfo->nFunc ){
530913449892Sdrh           /* pExpr is original.  Make a new entry in pAggInfo->aFunc[]
531013449892Sdrh           */
531114db2665Sdanielk1977           u8 enc = ENC(pParse->db);
53121e536953Sdanielk1977           i = addAggInfoFunc(pParse->db, pAggInfo);
531313449892Sdrh           if( i>=0 ){
53146ab3a2ecSdanielk1977             assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
531513449892Sdrh             pItem = &pAggInfo->aFunc[i];
531613449892Sdrh             pItem->pExpr = pExpr;
53170a07c107Sdrh             pItem->iMem = ++pParse->nMem;
531833e619fcSdrh             assert( !ExprHasProperty(pExpr, EP_IntValue) );
531913449892Sdrh             pItem->pFunc = sqlite3FindFunction(pParse->db,
532080738d9cSdrh                    pExpr->u.zToken,
53216ab3a2ecSdanielk1977                    pExpr->x.pList ? pExpr->x.pList->nExpr : 0, enc, 0);
5322fd357974Sdrh             if( pExpr->flags & EP_Distinct ){
5323fd357974Sdrh               pItem->iDistinct = pParse->nTab++;
5324fd357974Sdrh             }else{
5325fd357974Sdrh               pItem->iDistinct = -1;
5326fd357974Sdrh             }
53272282792aSdrh           }
532813449892Sdrh         }
532913449892Sdrh         /* Make pExpr point to the appropriate pAggInfo->aFunc[] entry
533013449892Sdrh         */
5331c5cd1249Sdrh         assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
5332ebb6a65dSdrh         ExprSetVVAProperty(pExpr, EP_NoReduce);
5333cf697396Sshane         pExpr->iAgg = (i16)i;
533413449892Sdrh         pExpr->pAggInfo = pAggInfo;
53353a8c4be7Sdrh         return WRC_Prune;
53366e83a57fSdrh       }else{
53376e83a57fSdrh         return WRC_Continue;
53386e83a57fSdrh       }
53392282792aSdrh     }
5340a58fdfb1Sdanielk1977   }
53417d10d5a6Sdrh   return WRC_Continue;
53427d10d5a6Sdrh }
53437d10d5a6Sdrh static int analyzeAggregatesInSelect(Walker *pWalker, Select *pSelect){
5344d5a336efSdrh   UNUSED_PARAMETER(pSelect);
5345979dd1beSdrh   pWalker->walkerDepth++;
53467d10d5a6Sdrh   return WRC_Continue;
5347a58fdfb1Sdanielk1977 }
5348979dd1beSdrh static void analyzeAggregatesInSelectEnd(Walker *pWalker, Select *pSelect){
5349979dd1beSdrh   UNUSED_PARAMETER(pSelect);
5350979dd1beSdrh   pWalker->walkerDepth--;
5351979dd1beSdrh }
5352626a879aSdrh 
5353626a879aSdrh /*
5354e8abb4caSdrh ** Analyze the pExpr expression looking for aggregate functions and
5355e8abb4caSdrh ** for variables that need to be added to AggInfo object that pNC->pAggInfo
5356e8abb4caSdrh ** points to.  Additional entries are made on the AggInfo object as
5357e8abb4caSdrh ** necessary.
5358626a879aSdrh **
5359626a879aSdrh ** This routine should only be called after the expression has been
53607d10d5a6Sdrh ** analyzed by sqlite3ResolveExprNames().
5361626a879aSdrh */
5362d2b3e23bSdrh void sqlite3ExprAnalyzeAggregates(NameContext *pNC, Expr *pExpr){
53637d10d5a6Sdrh   Walker w;
53647d10d5a6Sdrh   w.xExprCallback = analyzeAggregate;
53657d10d5a6Sdrh   w.xSelectCallback = analyzeAggregatesInSelect;
5366979dd1beSdrh   w.xSelectCallback2 = analyzeAggregatesInSelectEnd;
5367979dd1beSdrh   w.walkerDepth = 0;
53687d10d5a6Sdrh   w.u.pNC = pNC;
536920bc393cSdrh   assert( pNC->pSrcList!=0 );
53707d10d5a6Sdrh   sqlite3WalkExpr(&w, pExpr);
53712282792aSdrh }
53725d9a4af9Sdrh 
53735d9a4af9Sdrh /*
53745d9a4af9Sdrh ** Call sqlite3ExprAnalyzeAggregates() for every expression in an
53755d9a4af9Sdrh ** expression list.  Return the number of errors.
53765d9a4af9Sdrh **
53775d9a4af9Sdrh ** If an error is found, the analysis is cut short.
53785d9a4af9Sdrh */
5379d2b3e23bSdrh void sqlite3ExprAnalyzeAggList(NameContext *pNC, ExprList *pList){
53805d9a4af9Sdrh   struct ExprList_item *pItem;
53815d9a4af9Sdrh   int i;
53825d9a4af9Sdrh   if( pList ){
5383d2b3e23bSdrh     for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
5384d2b3e23bSdrh       sqlite3ExprAnalyzeAggregates(pNC, pItem->pExpr);
53855d9a4af9Sdrh     }
53865d9a4af9Sdrh   }
53875d9a4af9Sdrh }
5388892d3179Sdrh 
5389892d3179Sdrh /*
5390ceea3321Sdrh ** Allocate a single new register for use to hold some intermediate result.
5391892d3179Sdrh */
5392892d3179Sdrh int sqlite3GetTempReg(Parse *pParse){
5393e55cbd72Sdrh   if( pParse->nTempReg==0 ){
5394892d3179Sdrh     return ++pParse->nMem;
5395892d3179Sdrh   }
53962f425f6bSdanielk1977   return pParse->aTempReg[--pParse->nTempReg];
5397892d3179Sdrh }
5398ceea3321Sdrh 
5399ceea3321Sdrh /*
5400ceea3321Sdrh ** Deallocate a register, making available for reuse for some other
5401ceea3321Sdrh ** purpose.
5402ceea3321Sdrh */
5403892d3179Sdrh void sqlite3ReleaseTempReg(Parse *pParse, int iReg){
54042dcef11bSdrh   if( iReg && pParse->nTempReg<ArraySize(pParse->aTempReg) ){
5405892d3179Sdrh     pParse->aTempReg[pParse->nTempReg++] = iReg;
5406892d3179Sdrh   }
5407892d3179Sdrh }
5408892d3179Sdrh 
5409892d3179Sdrh /*
5410ed24da4bSdrh ** Allocate or deallocate a block of nReg consecutive registers.
5411892d3179Sdrh */
5412892d3179Sdrh int sqlite3GetTempRange(Parse *pParse, int nReg){
5413e55cbd72Sdrh   int i, n;
5414ed24da4bSdrh   if( nReg==1 ) return sqlite3GetTempReg(pParse);
5415892d3179Sdrh   i = pParse->iRangeReg;
5416e55cbd72Sdrh   n = pParse->nRangeReg;
5417f49f3523Sdrh   if( nReg<=n ){
5418892d3179Sdrh     pParse->iRangeReg += nReg;
5419892d3179Sdrh     pParse->nRangeReg -= nReg;
5420892d3179Sdrh   }else{
5421892d3179Sdrh     i = pParse->nMem+1;
5422892d3179Sdrh     pParse->nMem += nReg;
5423892d3179Sdrh   }
5424892d3179Sdrh   return i;
5425892d3179Sdrh }
5426892d3179Sdrh void sqlite3ReleaseTempRange(Parse *pParse, int iReg, int nReg){
5427ed24da4bSdrh   if( nReg==1 ){
5428ed24da4bSdrh     sqlite3ReleaseTempReg(pParse, iReg);
5429ed24da4bSdrh     return;
5430ed24da4bSdrh   }
5431892d3179Sdrh   if( nReg>pParse->nRangeReg ){
5432892d3179Sdrh     pParse->nRangeReg = nReg;
5433892d3179Sdrh     pParse->iRangeReg = iReg;
5434892d3179Sdrh   }
5435892d3179Sdrh }
5436cdc69557Sdrh 
5437cdc69557Sdrh /*
5438cdc69557Sdrh ** Mark all temporary registers as being unavailable for reuse.
5439cdc69557Sdrh */
5440cdc69557Sdrh void sqlite3ClearTempRegCache(Parse *pParse){
5441cdc69557Sdrh   pParse->nTempReg = 0;
5442cdc69557Sdrh   pParse->nRangeReg = 0;
5443cdc69557Sdrh }
5444bb9b5f26Sdrh 
5445bb9b5f26Sdrh /*
5446bb9b5f26Sdrh ** Validate that no temporary register falls within the range of
5447bb9b5f26Sdrh ** iFirst..iLast, inclusive.  This routine is only call from within assert()
5448bb9b5f26Sdrh ** statements.
5449bb9b5f26Sdrh */
5450bb9b5f26Sdrh #ifdef SQLITE_DEBUG
5451bb9b5f26Sdrh int sqlite3NoTempsInRange(Parse *pParse, int iFirst, int iLast){
5452bb9b5f26Sdrh   int i;
5453bb9b5f26Sdrh   if( pParse->nRangeReg>0
54543963e584Sdrh    && pParse->iRangeReg+pParse->nRangeReg > iFirst
54553963e584Sdrh    && pParse->iRangeReg <= iLast
5456bb9b5f26Sdrh   ){
5457bb9b5f26Sdrh      return 0;
5458bb9b5f26Sdrh   }
5459bb9b5f26Sdrh   for(i=0; i<pParse->nTempReg; i++){
5460bb9b5f26Sdrh     if( pParse->aTempReg[i]>=iFirst && pParse->aTempReg[i]<=iLast ){
5461bb9b5f26Sdrh       return 0;
5462bb9b5f26Sdrh     }
5463bb9b5f26Sdrh   }
5464bb9b5f26Sdrh   return 1;
5465bb9b5f26Sdrh }
5466bb9b5f26Sdrh #endif /* SQLITE_DEBUG */
5467