xref: /sqlite-3.40.0/src/expr.c (revision d86fe44a)
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;
479bec6fb3Smistachkin   if( pExpr->flags & EP_Generic ) return 0;
48a7d6db6aSdrh   while( ExprHasProperty(pExpr, EP_Skip) ){
49a7d6db6aSdrh     assert( pExpr->op==TK_COLLATE );
50a7d6db6aSdrh     pExpr = pExpr->pLeft;
51a7d6db6aSdrh     assert( pExpr!=0 );
52a7d6db6aSdrh   }
53580c8c18Sdrh   op = pExpr->op;
54487e262fSdrh   if( op==TK_SELECT ){
556ab3a2ecSdanielk1977     assert( pExpr->flags&EP_xIsSelect );
566ab3a2ecSdanielk1977     return sqlite3ExprAffinity(pExpr->x.pSelect->pEList->a[0].pExpr);
57a37cdde0Sdanielk1977   }
58db45bd5eSdrh   if( op==TK_REGISTER ) op = pExpr->op2;
59487e262fSdrh #ifndef SQLITE_OMIT_CAST
60487e262fSdrh   if( op==TK_CAST ){
6133e619fcSdrh     assert( !ExprHasProperty(pExpr, EP_IntValue) );
62fdaac671Sdrh     return sqlite3AffinityType(pExpr->u.zToken, 0);
63487e262fSdrh   }
64487e262fSdrh #endif
65eda079cdSdrh   if( (op==TK_AGG_COLUMN || op==TK_COLUMN) && pExpr->y.pTab ){
66eda079cdSdrh     return sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
677d10d5a6Sdrh   }
6880aa5453Sdan   if( op==TK_SELECT_COLUMN ){
6980aa5453Sdan     assert( pExpr->pLeft->flags&EP_xIsSelect );
7080aa5453Sdan     return sqlite3ExprAffinity(
7180aa5453Sdan         pExpr->pLeft->x.pSelect->pEList->a[pExpr->iColumn].pExpr
7280aa5453Sdan     );
7380aa5453Sdan   }
741194904bSdrh   return pExpr->affExpr;
75a37cdde0Sdanielk1977 }
76a37cdde0Sdanielk1977 
7753db1458Sdrh /*
788b4c40d8Sdrh ** Set the collating sequence for expression pExpr to be the collating
79ae80ddeaSdrh ** sequence named by pToken.   Return a pointer to a new Expr node that
80ae80ddeaSdrh ** implements the COLLATE operator.
810a8a406eSdrh **
820a8a406eSdrh ** If a memory allocation error occurs, that fact is recorded in pParse->db
830a8a406eSdrh ** and the pExpr parameter is returned unchanged.
848b4c40d8Sdrh */
854ef7efadSdrh Expr *sqlite3ExprAddCollateToken(
864ef7efadSdrh   Parse *pParse,           /* Parsing context */
874ef7efadSdrh   Expr *pExpr,             /* Add the "COLLATE" clause to this expression */
8880103fc6Sdan   const Token *pCollName,  /* Name of collating sequence */
8980103fc6Sdan   int dequote              /* True to dequote pCollName */
904ef7efadSdrh ){
910a8a406eSdrh   if( pCollName->n>0 ){
9280103fc6Sdan     Expr *pNew = sqlite3ExprAlloc(pParse->db, TK_COLLATE, pCollName, dequote);
93ae80ddeaSdrh     if( pNew ){
94ae80ddeaSdrh       pNew->pLeft = pExpr;
95a4c3c87eSdrh       pNew->flags |= EP_Collate|EP_Skip;
960a8a406eSdrh       pExpr = pNew;
97ae80ddeaSdrh     }
980a8a406eSdrh   }
990a8a406eSdrh   return pExpr;
1000a8a406eSdrh }
1010a8a406eSdrh Expr *sqlite3ExprAddCollateString(Parse *pParse, Expr *pExpr, const char *zC){
1020a8a406eSdrh   Token s;
103261d8a51Sdrh   assert( zC!=0 );
10440aced5cSdrh   sqlite3TokenInit(&s, (char*)zC);
10580103fc6Sdan   return sqlite3ExprAddCollateToken(pParse, pExpr, &s, 0);
1060a8a406eSdrh }
1070a8a406eSdrh 
1080a8a406eSdrh /*
1090d950af3Sdrh ** Skip over any TK_COLLATE operators.
1100a8a406eSdrh */
1110a8a406eSdrh Expr *sqlite3ExprSkipCollate(Expr *pExpr){
1120d950af3Sdrh   while( pExpr && ExprHasProperty(pExpr, EP_Skip) ){
1130d950af3Sdrh     assert( pExpr->op==TK_COLLATE );
1140d950af3Sdrh     pExpr = pExpr->pLeft;
1150d950af3Sdrh   }
1160d950af3Sdrh   return pExpr;
1170d950af3Sdrh }
1180d950af3Sdrh 
1190d950af3Sdrh /*
1200d950af3Sdrh ** Skip over any TK_COLLATE operators and/or any unlikely()
1210d950af3Sdrh ** or likelihood() or likely() functions at the root of an
1220d950af3Sdrh ** expression.
1230d950af3Sdrh */
1240d950af3Sdrh Expr *sqlite3ExprSkipCollateAndLikely(Expr *pExpr){
125a7d6db6aSdrh   while( pExpr && ExprHasProperty(pExpr, EP_Skip|EP_Unlikely) ){
126a4c3c87eSdrh     if( ExprHasProperty(pExpr, EP_Unlikely) ){
127cca9f3d2Sdrh       assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
128cca9f3d2Sdrh       assert( pExpr->x.pList->nExpr>0 );
129a4c3c87eSdrh       assert( pExpr->op==TK_FUNCTION );
130cca9f3d2Sdrh       pExpr = pExpr->x.pList->a[0].pExpr;
131cca9f3d2Sdrh     }else{
1320b8d255cSdrh       assert( pExpr->op==TK_COLLATE );
133d91eba96Sdrh       pExpr = pExpr->pLeft;
134cca9f3d2Sdrh     }
135d91eba96Sdrh   }
1360a8a406eSdrh   return pExpr;
1378b4c40d8Sdrh }
1388b4c40d8Sdrh 
1398b4c40d8Sdrh /*
140ae80ddeaSdrh ** Return the collation sequence for the expression pExpr. If
141ae80ddeaSdrh ** there is no defined collating sequence, return NULL.
142ae80ddeaSdrh **
14370efa84dSdrh ** See also: sqlite3ExprNNCollSeq()
14470efa84dSdrh **
14570efa84dSdrh ** The sqlite3ExprNNCollSeq() works the same exact that it returns the
14670efa84dSdrh ** default collation if pExpr has no defined collation.
14770efa84dSdrh **
148ae80ddeaSdrh ** The collating sequence might be determined by a COLLATE operator
149ae80ddeaSdrh ** or by the presence of a column with a defined collating sequence.
150ae80ddeaSdrh ** COLLATE operators take first precedence.  Left operands take
151ae80ddeaSdrh ** precedence over right operands.
1520202b29eSdanielk1977 */
1537cedc8d4Sdanielk1977 CollSeq *sqlite3ExprCollSeq(Parse *pParse, Expr *pExpr){
154ae80ddeaSdrh   sqlite3 *db = pParse->db;
1557cedc8d4Sdanielk1977   CollSeq *pColl = 0;
1567d10d5a6Sdrh   Expr *p = pExpr;
157261d8a51Sdrh   while( p ){
158ae80ddeaSdrh     int op = p->op;
159fbb24d10Sdrh     if( p->flags & EP_Generic ) break;
160cb0e04f9Sdrh     if( op==TK_REGISTER ) op = p->op2;
161cb0e04f9Sdrh     if( (op==TK_AGG_COLUMN || op==TK_COLUMN || op==TK_TRIGGER)
162eda079cdSdrh      && p->y.pTab!=0
163ae80ddeaSdrh     ){
164eda079cdSdrh       /* op==TK_REGISTER && p->y.pTab!=0 happens when pExpr was originally
1657d10d5a6Sdrh       ** a TK_COLUMN but was previously evaluated and cached in a register */
1667d10d5a6Sdrh       int j = p->iColumn;
1677d10d5a6Sdrh       if( j>=0 ){
168eda079cdSdrh         const char *zColl = p->y.pTab->aCol[j].zColl;
169c4a64facSdrh         pColl = sqlite3FindCollSeq(db, ENC(db), zColl, 0);
1700202b29eSdanielk1977       }
1717d10d5a6Sdrh       break;
1727d10d5a6Sdrh     }
173e081d73cSdrh     if( op==TK_CAST || op==TK_UPLUS ){
174e081d73cSdrh       p = p->pLeft;
175e081d73cSdrh       continue;
176e081d73cSdrh     }
177cb0e04f9Sdrh     if( op==TK_COLLATE ){
178e081d73cSdrh       pColl = sqlite3GetCollSeq(pParse, ENC(db), 0, p->u.zToken);
179e081d73cSdrh       break;
180e081d73cSdrh     }
181ae80ddeaSdrh     if( p->flags & EP_Collate ){
1822308ed38Sdrh       if( p->pLeft && (p->pLeft->flags & EP_Collate)!=0 ){
1837d10d5a6Sdrh         p = p->pLeft;
184ae80ddeaSdrh       }else{
1852308ed38Sdrh         Expr *pNext  = p->pRight;
1866728cd91Sdrh         /* The Expr.x union is never used at the same time as Expr.pRight */
1876728cd91Sdrh         assert( p->x.pList==0 || p->pRight==0 );
1886728cd91Sdrh         /* p->flags holds EP_Collate and p->pLeft->flags does not.  And
1896728cd91Sdrh         ** p->x.pSelect cannot.  So if p->x.pLeft exists, it must hold at
1906728cd91Sdrh         ** least one EP_Collate. Thus the following two ALWAYS. */
1916728cd91Sdrh         if( p->x.pList!=0 && ALWAYS(!ExprHasProperty(p, EP_xIsSelect)) ){
1922308ed38Sdrh           int i;
1936728cd91Sdrh           for(i=0; ALWAYS(i<p->x.pList->nExpr); i++){
1942308ed38Sdrh             if( ExprHasProperty(p->x.pList->a[i].pExpr, EP_Collate) ){
1952308ed38Sdrh               pNext = p->x.pList->a[i].pExpr;
1962308ed38Sdrh               break;
1972308ed38Sdrh             }
1982308ed38Sdrh           }
1992308ed38Sdrh         }
2002308ed38Sdrh         p = pNext;
201ae80ddeaSdrh       }
202ae80ddeaSdrh     }else{
203ae80ddeaSdrh       break;
204ae80ddeaSdrh     }
2050202b29eSdanielk1977   }
2067cedc8d4Sdanielk1977   if( sqlite3CheckCollSeq(pParse, pColl) ){
2077cedc8d4Sdanielk1977     pColl = 0;
2087cedc8d4Sdanielk1977   }
2097cedc8d4Sdanielk1977   return pColl;
2100202b29eSdanielk1977 }
2110202b29eSdanielk1977 
2120202b29eSdanielk1977 /*
21370efa84dSdrh ** Return the collation sequence for the expression pExpr. If
21470efa84dSdrh ** there is no defined collating sequence, return a pointer to the
21570efa84dSdrh ** defautl collation sequence.
21670efa84dSdrh **
21770efa84dSdrh ** See also: sqlite3ExprCollSeq()
21870efa84dSdrh **
21970efa84dSdrh ** The sqlite3ExprCollSeq() routine works the same except that it
22070efa84dSdrh ** returns NULL if there is no defined collation.
22170efa84dSdrh */
22270efa84dSdrh CollSeq *sqlite3ExprNNCollSeq(Parse *pParse, Expr *pExpr){
22370efa84dSdrh   CollSeq *p = sqlite3ExprCollSeq(pParse, pExpr);
22470efa84dSdrh   if( p==0 ) p = pParse->db->pDfltColl;
22570efa84dSdrh   assert( p!=0 );
22670efa84dSdrh   return p;
22770efa84dSdrh }
22870efa84dSdrh 
22970efa84dSdrh /*
23070efa84dSdrh ** Return TRUE if the two expressions have equivalent collating sequences.
23170efa84dSdrh */
23270efa84dSdrh int sqlite3ExprCollSeqMatch(Parse *pParse, Expr *pE1, Expr *pE2){
23370efa84dSdrh   CollSeq *pColl1 = sqlite3ExprNNCollSeq(pParse, pE1);
23470efa84dSdrh   CollSeq *pColl2 = sqlite3ExprNNCollSeq(pParse, pE2);
23570efa84dSdrh   return sqlite3StrICmp(pColl1->zName, pColl2->zName)==0;
23670efa84dSdrh }
23770efa84dSdrh 
23870efa84dSdrh /*
239626a879aSdrh ** pExpr is an operand of a comparison operator.  aff2 is the
240626a879aSdrh ** type affinity of the other operand.  This routine returns the
24153db1458Sdrh ** type affinity that should be used for the comparison operator.
24253db1458Sdrh */
243e014a838Sdanielk1977 char sqlite3CompareAffinity(Expr *pExpr, char aff2){
244bf3b721fSdanielk1977   char aff1 = sqlite3ExprAffinity(pExpr);
24596fb16eeSdrh   if( aff1>SQLITE_AFF_NONE && aff2>SQLITE_AFF_NONE ){
2468df447f0Sdrh     /* Both sides of the comparison are columns. If one has numeric
2478df447f0Sdrh     ** affinity, use that. Otherwise use no affinity.
248e014a838Sdanielk1977     */
2498a51256cSdrh     if( sqlite3IsNumericAffinity(aff1) || sqlite3IsNumericAffinity(aff2) ){
250e014a838Sdanielk1977       return SQLITE_AFF_NUMERIC;
251e014a838Sdanielk1977     }else{
25205883a34Sdrh       return SQLITE_AFF_BLOB;
253e014a838Sdanielk1977     }
254e014a838Sdanielk1977   }else{
255e014a838Sdanielk1977     /* One side is a column, the other is not. Use the columns affinity. */
25696fb16eeSdrh     assert( aff1<=SQLITE_AFF_NONE || aff2<=SQLITE_AFF_NONE );
25796fb16eeSdrh     return (aff1<=SQLITE_AFF_NONE ? aff2 : aff1) | SQLITE_AFF_NONE;
258e014a838Sdanielk1977   }
259e014a838Sdanielk1977 }
260e014a838Sdanielk1977 
26153db1458Sdrh /*
26253db1458Sdrh ** pExpr is a comparison operator.  Return the type affinity that should
26353db1458Sdrh ** be applied to both operands prior to doing the comparison.
26453db1458Sdrh */
265e014a838Sdanielk1977 static char comparisonAffinity(Expr *pExpr){
266e014a838Sdanielk1977   char aff;
267e014a838Sdanielk1977   assert( pExpr->op==TK_EQ || pExpr->op==TK_IN || pExpr->op==TK_LT ||
268e014a838Sdanielk1977           pExpr->op==TK_GT || pExpr->op==TK_GE || pExpr->op==TK_LE ||
2696a2fe093Sdrh           pExpr->op==TK_NE || pExpr->op==TK_IS || pExpr->op==TK_ISNOT );
270e014a838Sdanielk1977   assert( pExpr->pLeft );
271bf3b721fSdanielk1977   aff = sqlite3ExprAffinity(pExpr->pLeft);
272e014a838Sdanielk1977   if( pExpr->pRight ){
273e014a838Sdanielk1977     aff = sqlite3CompareAffinity(pExpr->pRight, aff);
2746ab3a2ecSdanielk1977   }else if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2756ab3a2ecSdanielk1977     aff = sqlite3CompareAffinity(pExpr->x.pSelect->pEList->a[0].pExpr, aff);
27613ac46eeSdrh   }else if( aff==0 ){
27705883a34Sdrh     aff = SQLITE_AFF_BLOB;
278e014a838Sdanielk1977   }
279e014a838Sdanielk1977   return aff;
280e014a838Sdanielk1977 }
281e014a838Sdanielk1977 
282e014a838Sdanielk1977 /*
283e014a838Sdanielk1977 ** pExpr is a comparison expression, eg. '=', '<', IN(...) etc.
284e014a838Sdanielk1977 ** idx_affinity is the affinity of an indexed column. Return true
285e014a838Sdanielk1977 ** if the index with affinity idx_affinity may be used to implement
286e014a838Sdanielk1977 ** the comparison in pExpr.
287e014a838Sdanielk1977 */
288e014a838Sdanielk1977 int sqlite3IndexAffinityOk(Expr *pExpr, char idx_affinity){
289e014a838Sdanielk1977   char aff = comparisonAffinity(pExpr);
290915e434cSdrh   if( aff<SQLITE_AFF_TEXT ){
2918a51256cSdrh     return 1;
2928a51256cSdrh   }
293915e434cSdrh   if( aff==SQLITE_AFF_TEXT ){
294915e434cSdrh     return idx_affinity==SQLITE_AFF_TEXT;
295915e434cSdrh   }
296915e434cSdrh   return sqlite3IsNumericAffinity(idx_affinity);
297e014a838Sdanielk1977 }
298e014a838Sdanielk1977 
299a37cdde0Sdanielk1977 /*
30035573356Sdrh ** Return the P5 value that should be used for a binary comparison
301a37cdde0Sdanielk1977 ** opcode (OP_Eq, OP_Ge etc.) used to compare pExpr1 and pExpr2.
302a37cdde0Sdanielk1977 */
30335573356Sdrh static u8 binaryCompareP5(Expr *pExpr1, Expr *pExpr2, int jumpIfNull){
30435573356Sdrh   u8 aff = (char)sqlite3ExprAffinity(pExpr2);
3051bd10f8aSdrh   aff = (u8)sqlite3CompareAffinity(pExpr1, aff) | (u8)jumpIfNull;
30635573356Sdrh   return aff;
307a37cdde0Sdanielk1977 }
308a37cdde0Sdanielk1977 
309a2e00042Sdrh /*
3100202b29eSdanielk1977 ** Return a pointer to the collation sequence that should be used by
3110202b29eSdanielk1977 ** a binary comparison operator comparing pLeft and pRight.
3120202b29eSdanielk1977 **
3130202b29eSdanielk1977 ** If the left hand expression has a collating sequence type, then it is
3140202b29eSdanielk1977 ** used. Otherwise the collation sequence for the right hand expression
3150202b29eSdanielk1977 ** is used, or the default (BINARY) if neither expression has a collating
3160202b29eSdanielk1977 ** type.
317bcbb04e5Sdanielk1977 **
318bcbb04e5Sdanielk1977 ** Argument pRight (but not pLeft) may be a null pointer. In this case,
319bcbb04e5Sdanielk1977 ** it is not considered.
3200202b29eSdanielk1977 */
321bcbb04e5Sdanielk1977 CollSeq *sqlite3BinaryCompareCollSeq(
322bcbb04e5Sdanielk1977   Parse *pParse,
323bcbb04e5Sdanielk1977   Expr *pLeft,
324bcbb04e5Sdanielk1977   Expr *pRight
325bcbb04e5Sdanielk1977 ){
326ec41ddacSdrh   CollSeq *pColl;
327ec41ddacSdrh   assert( pLeft );
328ae80ddeaSdrh   if( pLeft->flags & EP_Collate ){
329ae80ddeaSdrh     pColl = sqlite3ExprCollSeq(pParse, pLeft);
330ae80ddeaSdrh   }else if( pRight && (pRight->flags & EP_Collate)!=0 ){
331ae80ddeaSdrh     pColl = sqlite3ExprCollSeq(pParse, pRight);
332ec41ddacSdrh   }else{
333ec41ddacSdrh     pColl = sqlite3ExprCollSeq(pParse, pLeft);
3340202b29eSdanielk1977     if( !pColl ){
3357cedc8d4Sdanielk1977       pColl = sqlite3ExprCollSeq(pParse, pRight);
3360202b29eSdanielk1977     }
337ec41ddacSdrh   }
3380202b29eSdanielk1977   return pColl;
3390202b29eSdanielk1977 }
3400202b29eSdanielk1977 
3410202b29eSdanielk1977 /*
342be5c89acSdrh ** Generate code for a comparison operator.
343be5c89acSdrh */
344be5c89acSdrh static int codeCompare(
345be5c89acSdrh   Parse *pParse,    /* The parsing (and code generating) context */
346be5c89acSdrh   Expr *pLeft,      /* The left operand */
347be5c89acSdrh   Expr *pRight,     /* The right operand */
348be5c89acSdrh   int opcode,       /* The comparison opcode */
34935573356Sdrh   int in1, int in2, /* Register holding operands */
350be5c89acSdrh   int dest,         /* Jump here if true.  */
351be5c89acSdrh   int jumpIfNull    /* If true, jump if either operand is NULL */
352be5c89acSdrh ){
35335573356Sdrh   int p5;
35435573356Sdrh   int addr;
35535573356Sdrh   CollSeq *p4;
35635573356Sdrh 
35735573356Sdrh   p4 = sqlite3BinaryCompareCollSeq(pParse, pLeft, pRight);
35835573356Sdrh   p5 = binaryCompareP5(pLeft, pRight, jumpIfNull);
35935573356Sdrh   addr = sqlite3VdbeAddOp4(pParse->pVdbe, opcode, in2, dest, in1,
36035573356Sdrh                            (void*)p4, P4_COLLSEQ);
3611bd10f8aSdrh   sqlite3VdbeChangeP5(pParse->pVdbe, (u8)p5);
36235573356Sdrh   return addr;
363be5c89acSdrh }
364be5c89acSdrh 
365cfbb5e82Sdan /*
366870a0705Sdan ** Return true if expression pExpr is a vector, or false otherwise.
367d832da7fSdrh **
368d832da7fSdrh ** A vector is defined as any expression that results in two or more
369d832da7fSdrh ** columns of result.  Every TK_VECTOR node is an vector because the
370d832da7fSdrh ** parser will not generate a TK_VECTOR with fewer than two entries.
371d832da7fSdrh ** But a TK_SELECT might be either a vector or a scalar. It is only
372d832da7fSdrh ** considered a vector if it has two or more result columns.
373870a0705Sdan */
374870a0705Sdan int sqlite3ExprIsVector(Expr *pExpr){
37576dbe7a8Sdrh   return sqlite3ExprVectorSize(pExpr)>1;
376870a0705Sdan }
377870a0705Sdan 
378870a0705Sdan /*
379cfbb5e82Sdan ** If the expression passed as the only argument is of type TK_VECTOR
380cfbb5e82Sdan ** return the number of expressions in the vector. Or, if the expression
381cfbb5e82Sdan ** is a sub-select, return the number of columns in the sub-select. For
382cfbb5e82Sdan ** any other type of expression, return 1.
383cfbb5e82Sdan */
38471c57db0Sdan int sqlite3ExprVectorSize(Expr *pExpr){
38512abf408Sdrh   u8 op = pExpr->op;
38612abf408Sdrh   if( op==TK_REGISTER ) op = pExpr->op2;
38712abf408Sdrh   if( op==TK_VECTOR ){
38871c57db0Sdan     return pExpr->x.pList->nExpr;
38912abf408Sdrh   }else if( op==TK_SELECT ){
39076dbe7a8Sdrh     return pExpr->x.pSelect->pEList->nExpr;
39176dbe7a8Sdrh   }else{
39276dbe7a8Sdrh     return 1;
39376dbe7a8Sdrh   }
39471c57db0Sdan }
39571c57db0Sdan 
396ba00e30aSdan /*
397fc7f27b9Sdrh ** Return a pointer to a subexpression of pVector that is the i-th
398fc7f27b9Sdrh ** column of the vector (numbered starting with 0).  The caller must
399fc7f27b9Sdrh ** ensure that i is within range.
400fc7f27b9Sdrh **
40176dbe7a8Sdrh ** If pVector is really a scalar (and "scalar" here includes subqueries
40276dbe7a8Sdrh ** that return a single column!) then return pVector unmodified.
40376dbe7a8Sdrh **
404fc7f27b9Sdrh ** pVector retains ownership of the returned subexpression.
405fc7f27b9Sdrh **
406fc7f27b9Sdrh ** If the vector is a (SELECT ...) then the expression returned is
40776dbe7a8Sdrh ** just the expression for the i-th term of the result set, and may
40876dbe7a8Sdrh ** not be ready for evaluation because the table cursor has not yet
40976dbe7a8Sdrh ** been positioned.
410ba00e30aSdan */
411fc7f27b9Sdrh Expr *sqlite3VectorFieldSubexpr(Expr *pVector, int i){
412870a0705Sdan   assert( i<sqlite3ExprVectorSize(pVector) );
413870a0705Sdan   if( sqlite3ExprIsVector(pVector) ){
4149f24b53dSdrh     assert( pVector->op2==0 || pVector->op==TK_REGISTER );
4159f24b53dSdrh     if( pVector->op==TK_SELECT || pVector->op2==TK_SELECT ){
41671c57db0Sdan       return pVector->x.pSelect->pEList->a[i].pExpr;
417870a0705Sdan     }else{
41871c57db0Sdan       return pVector->x.pList->a[i].pExpr;
41971c57db0Sdan     }
420870a0705Sdan   }
421870a0705Sdan   return pVector;
422870a0705Sdan }
423fc7f27b9Sdrh 
424fc7f27b9Sdrh /*
425fc7f27b9Sdrh ** Compute and return a new Expr object which when passed to
426fc7f27b9Sdrh ** sqlite3ExprCode() will generate all necessary code to compute
427fc7f27b9Sdrh ** the iField-th column of the vector expression pVector.
428fc7f27b9Sdrh **
4298762ec19Sdrh ** It is ok for pVector to be a scalar (as long as iField==0).
4308762ec19Sdrh ** In that case, this routine works like sqlite3ExprDup().
4318762ec19Sdrh **
432fc7f27b9Sdrh ** The caller owns the returned Expr object and is responsible for
433fc7f27b9Sdrh ** ensuring that the returned value eventually gets freed.
434fc7f27b9Sdrh **
4358762ec19Sdrh ** The caller retains ownership of pVector.  If pVector is a TK_SELECT,
436fad0e70cSdan ** then the returned object will reference pVector and so pVector must remain
4378762ec19Sdrh ** valid for the life of the returned object.  If pVector is a TK_VECTOR
4388762ec19Sdrh ** or a scalar expression, then it can be deleted as soon as this routine
43976dbe7a8Sdrh ** returns.
4408762ec19Sdrh **
4418762ec19Sdrh ** A trick to cause a TK_SELECT pVector to be deleted together with
4428762ec19Sdrh ** the returned Expr object is to attach the pVector to the pRight field
4438762ec19Sdrh ** of the returned TK_SELECT_COLUMN Expr object.
444fc7f27b9Sdrh */
445fc7f27b9Sdrh Expr *sqlite3ExprForVectorField(
446fc7f27b9Sdrh   Parse *pParse,       /* Parsing context */
447fc7f27b9Sdrh   Expr *pVector,       /* The vector.  List of expressions or a sub-SELECT */
448a1251bc4Sdrh   int iField           /* Which column of the vector to return */
449fc7f27b9Sdrh ){
450fc7f27b9Sdrh   Expr *pRet;
451a1251bc4Sdrh   if( pVector->op==TK_SELECT ){
452a1251bc4Sdrh     assert( pVector->flags & EP_xIsSelect );
453fc7f27b9Sdrh     /* The TK_SELECT_COLUMN Expr node:
454fc7f27b9Sdrh     **
455966e2911Sdrh     ** pLeft:           pVector containing TK_SELECT.  Not deleted.
4568762ec19Sdrh     ** pRight:          not used.  But recursively deleted.
457fc7f27b9Sdrh     ** iColumn:         Index of a column in pVector
458966e2911Sdrh     ** iTable:          0 or the number of columns on the LHS of an assignment
459fc7f27b9Sdrh     ** pLeft->iTable:   First in an array of register holding result, or 0
460fc7f27b9Sdrh     **                  if the result is not yet computed.
461fc7f27b9Sdrh     **
462fc7f27b9Sdrh     ** sqlite3ExprDelete() specifically skips the recursive delete of
463fc7f27b9Sdrh     ** pLeft on TK_SELECT_COLUMN nodes.  But pRight is followed, so pVector
4648762ec19Sdrh     ** can be attached to pRight to cause this node to take ownership of
4658762ec19Sdrh     ** pVector.  Typically there will be multiple TK_SELECT_COLUMN nodes
4668762ec19Sdrh     ** with the same pLeft pointer to the pVector, but only one of them
4678762ec19Sdrh     ** will own the pVector.
468fc7f27b9Sdrh     */
469abfd35eaSdrh     pRet = sqlite3PExpr(pParse, TK_SELECT_COLUMN, 0, 0);
4708bd0d58eSdrh     if( pRet ){
4718bd0d58eSdrh       pRet->iColumn = iField;
4728bd0d58eSdrh       pRet->pLeft = pVector;
4738bd0d58eSdrh     }
474fc7f27b9Sdrh     assert( pRet==0 || pRet->iTable==0 );
475fc7f27b9Sdrh   }else{
476a1251bc4Sdrh     if( pVector->op==TK_VECTOR ) pVector = pVector->x.pList->a[iField].pExpr;
477a1251bc4Sdrh     pRet = sqlite3ExprDup(pParse->db, pVector, 0);
478dfb5c963Sdan     sqlite3RenameTokenRemap(pParse, pRet, pVector);
479fc7f27b9Sdrh   }
480fc7f27b9Sdrh   return pRet;
481fc7f27b9Sdrh }
48271c57db0Sdan 
4835c288b92Sdan /*
4845c288b92Sdan ** If expression pExpr is of type TK_SELECT, generate code to evaluate
4855c288b92Sdan ** it. Return the register in which the result is stored (or, if the
4865c288b92Sdan ** sub-select returns more than one column, the first in an array
4875c288b92Sdan ** of registers in which the result is stored).
4885c288b92Sdan **
4895c288b92Sdan ** If pExpr is not a TK_SELECT expression, return 0.
4905c288b92Sdan */
4915c288b92Sdan static int exprCodeSubselect(Parse *pParse, Expr *pExpr){
4928da209b1Sdan   int reg = 0;
493f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
4945c288b92Sdan   if( pExpr->op==TK_SELECT ){
49585bcdce2Sdrh     reg = sqlite3CodeSubselect(pParse, pExpr);
4968da209b1Sdan   }
497f9b2e05cSdan #endif
4988da209b1Sdan   return reg;
4998da209b1Sdan }
5008da209b1Sdan 
5015c288b92Sdan /*
5025c288b92Sdan ** Argument pVector points to a vector expression - either a TK_VECTOR
503870a0705Sdan ** or TK_SELECT that returns more than one column. This function returns
504870a0705Sdan ** the register number of a register that contains the value of
505870a0705Sdan ** element iField of the vector.
506870a0705Sdan **
507870a0705Sdan ** If pVector is a TK_SELECT expression, then code for it must have
508870a0705Sdan ** already been generated using the exprCodeSubselect() routine. In this
509870a0705Sdan ** case parameter regSelect should be the first in an array of registers
510870a0705Sdan ** containing the results of the sub-select.
511870a0705Sdan **
512870a0705Sdan ** If pVector is of type TK_VECTOR, then code for the requested field
513870a0705Sdan ** is generated. In this case (*pRegFree) may be set to the number of
514870a0705Sdan ** a temporary register to be freed by the caller before returning.
5155c288b92Sdan **
5165c288b92Sdan ** Before returning, output parameter (*ppExpr) is set to point to the
5175c288b92Sdan ** Expr object corresponding to element iElem of the vector.
5185c288b92Sdan */
5195c288b92Sdan static int exprVectorRegister(
5205c288b92Sdan   Parse *pParse,                  /* Parse context */
5215c288b92Sdan   Expr *pVector,                  /* Vector to extract element from */
522870a0705Sdan   int iField,                     /* Field to extract from pVector */
5235c288b92Sdan   int regSelect,                  /* First in array of registers */
5245c288b92Sdan   Expr **ppExpr,                  /* OUT: Expression element */
5255c288b92Sdan   int *pRegFree                   /* OUT: Temp register to free */
5265c288b92Sdan ){
52712abf408Sdrh   u8 op = pVector->op;
528c1bcd9ccSdrh   assert( op==TK_VECTOR || op==TK_REGISTER || op==TK_SELECT );
52912abf408Sdrh   if( op==TK_REGISTER ){
53012abf408Sdrh     *ppExpr = sqlite3VectorFieldSubexpr(pVector, iField);
53112abf408Sdrh     return pVector->iTable+iField;
53212abf408Sdrh   }
53312abf408Sdrh   if( op==TK_SELECT ){
534870a0705Sdan     *ppExpr = pVector->x.pSelect->pEList->a[iField].pExpr;
535870a0705Sdan      return regSelect+iField;
5365c288b92Sdan   }
537870a0705Sdan   *ppExpr = pVector->x.pList->a[iField].pExpr;
5385c288b92Sdan   return sqlite3ExprCodeTemp(pParse, *ppExpr, pRegFree);
5395c288b92Sdan }
5405c288b92Sdan 
5415c288b92Sdan /*
5425c288b92Sdan ** Expression pExpr is a comparison between two vector values. Compute
54379752b6eSdrh ** the result of the comparison (1, 0, or NULL) and write that
54479752b6eSdrh ** result into register dest.
54579752b6eSdrh **
54679752b6eSdrh ** The caller must satisfy the following preconditions:
54779752b6eSdrh **
54879752b6eSdrh **    if pExpr->op==TK_IS:      op==TK_EQ and p5==SQLITE_NULLEQ
54979752b6eSdrh **    if pExpr->op==TK_ISNOT:   op==TK_NE and p5==SQLITE_NULLEQ
55079752b6eSdrh **    otherwise:                op==pExpr->op and p5==0
5515c288b92Sdan */
55279752b6eSdrh static void codeVectorCompare(
55379752b6eSdrh   Parse *pParse,        /* Code generator context */
55479752b6eSdrh   Expr *pExpr,          /* The comparison operation */
55579752b6eSdrh   int dest,             /* Write results into this register */
55679752b6eSdrh   u8 op,                /* Comparison operator */
55779752b6eSdrh   u8 p5                 /* SQLITE_NULLEQ or zero */
55879752b6eSdrh ){
55971c57db0Sdan   Vdbe *v = pParse->pVdbe;
56071c57db0Sdan   Expr *pLeft = pExpr->pLeft;
56171c57db0Sdan   Expr *pRight = pExpr->pRight;
56271c57db0Sdan   int nLeft = sqlite3ExprVectorSize(pLeft);
56371c57db0Sdan   int i;
56471c57db0Sdan   int regLeft = 0;
56571c57db0Sdan   int regRight = 0;
56679752b6eSdrh   u8 opx = op;
567ec4ccdbcSdrh   int addrDone = sqlite3VdbeMakeLabel(pParse);
56871c57db0Sdan 
569245ce62eSdrh   if( nLeft!=sqlite3ExprVectorSize(pRight) ){
570245ce62eSdrh     sqlite3ErrorMsg(pParse, "row value misused");
571245ce62eSdrh     return;
572245ce62eSdrh   }
57371c57db0Sdan   assert( pExpr->op==TK_EQ || pExpr->op==TK_NE
57471c57db0Sdan        || pExpr->op==TK_IS || pExpr->op==TK_ISNOT
57571c57db0Sdan        || pExpr->op==TK_LT || pExpr->op==TK_GT
57671c57db0Sdan        || pExpr->op==TK_LE || pExpr->op==TK_GE
57771c57db0Sdan   );
57879752b6eSdrh   assert( pExpr->op==op || (pExpr->op==TK_IS && op==TK_EQ)
57979752b6eSdrh             || (pExpr->op==TK_ISNOT && op==TK_NE) );
58079752b6eSdrh   assert( p5==0 || pExpr->op!=op );
58179752b6eSdrh   assert( p5==SQLITE_NULLEQ || pExpr->op==op );
58271c57db0Sdan 
58379752b6eSdrh   p5 |= SQLITE_STOREP2;
58479752b6eSdrh   if( opx==TK_LE ) opx = TK_LT;
58579752b6eSdrh   if( opx==TK_GE ) opx = TK_GT;
5865c288b92Sdan 
5875c288b92Sdan   regLeft = exprCodeSubselect(pParse, pLeft);
5885c288b92Sdan   regRight = exprCodeSubselect(pParse, pRight);
5895c288b92Sdan 
590321e828dSdrh   for(i=0; 1 /*Loop exits by "break"*/; i++){
5915c288b92Sdan     int regFree1 = 0, regFree2 = 0;
5925c288b92Sdan     Expr *pL, *pR;
5935c288b92Sdan     int r1, r2;
594321e828dSdrh     assert( i>=0 && i<nLeft );
5955c288b92Sdan     r1 = exprVectorRegister(pParse, pLeft, i, regLeft, &pL, &regFree1);
5965c288b92Sdan     r2 = exprVectorRegister(pParse, pRight, i, regRight, &pR, &regFree2);
59779752b6eSdrh     codeCompare(pParse, pL, pR, opx, r1, r2, dest, p5);
59879752b6eSdrh     testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
59979752b6eSdrh     testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
60079752b6eSdrh     testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
60179752b6eSdrh     testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
60279752b6eSdrh     testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
60379752b6eSdrh     testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
60471c57db0Sdan     sqlite3ReleaseTempReg(pParse, regFree1);
60571c57db0Sdan     sqlite3ReleaseTempReg(pParse, regFree2);
60679752b6eSdrh     if( i==nLeft-1 ){
60779752b6eSdrh       break;
60871c57db0Sdan     }
60979752b6eSdrh     if( opx==TK_EQ ){
61079752b6eSdrh       sqlite3VdbeAddOp2(v, OP_IfNot, dest, addrDone); VdbeCoverage(v);
61179752b6eSdrh       p5 |= SQLITE_KEEPNULL;
61279752b6eSdrh     }else if( opx==TK_NE ){
61379752b6eSdrh       sqlite3VdbeAddOp2(v, OP_If, dest, addrDone); VdbeCoverage(v);
61479752b6eSdrh       p5 |= SQLITE_KEEPNULL;
615a2f62925Sdrh     }else{
616a2f62925Sdrh       assert( op==TK_LT || op==TK_GT || op==TK_LE || op==TK_GE );
617a2f62925Sdrh       sqlite3VdbeAddOp2(v, OP_ElseNotEq, 0, addrDone);
61879752b6eSdrh       VdbeCoverageIf(v, op==TK_LT);
61979752b6eSdrh       VdbeCoverageIf(v, op==TK_GT);
62079752b6eSdrh       VdbeCoverageIf(v, op==TK_LE);
62179752b6eSdrh       VdbeCoverageIf(v, op==TK_GE);
62279752b6eSdrh       if( i==nLeft-2 ) opx = op;
62371c57db0Sdan     }
62479752b6eSdrh   }
62579752b6eSdrh   sqlite3VdbeResolveLabel(v, addrDone);
62679752b6eSdrh }
62771c57db0Sdan 
6284b5255acSdanielk1977 #if SQLITE_MAX_EXPR_DEPTH>0
6294b5255acSdanielk1977 /*
6304b5255acSdanielk1977 ** Check that argument nHeight is less than or equal to the maximum
6314b5255acSdanielk1977 ** expression depth allowed. If it is not, leave an error message in
6324b5255acSdanielk1977 ** pParse.
6334b5255acSdanielk1977 */
6347d10d5a6Sdrh int sqlite3ExprCheckHeight(Parse *pParse, int nHeight){
6354b5255acSdanielk1977   int rc = SQLITE_OK;
6364b5255acSdanielk1977   int mxHeight = pParse->db->aLimit[SQLITE_LIMIT_EXPR_DEPTH];
6374b5255acSdanielk1977   if( nHeight>mxHeight ){
6384b5255acSdanielk1977     sqlite3ErrorMsg(pParse,
6394b5255acSdanielk1977        "Expression tree is too large (maximum depth %d)", mxHeight
6404b5255acSdanielk1977     );
6414b5255acSdanielk1977     rc = SQLITE_ERROR;
6424b5255acSdanielk1977   }
6434b5255acSdanielk1977   return rc;
6444b5255acSdanielk1977 }
6454b5255acSdanielk1977 
6464b5255acSdanielk1977 /* The following three functions, heightOfExpr(), heightOfExprList()
6474b5255acSdanielk1977 ** and heightOfSelect(), are used to determine the maximum height
6484b5255acSdanielk1977 ** of any expression tree referenced by the structure passed as the
6494b5255acSdanielk1977 ** first argument.
6504b5255acSdanielk1977 **
6514b5255acSdanielk1977 ** If this maximum height is greater than the current value pointed
6524b5255acSdanielk1977 ** to by pnHeight, the second parameter, then set *pnHeight to that
6534b5255acSdanielk1977 ** value.
6544b5255acSdanielk1977 */
6554b5255acSdanielk1977 static void heightOfExpr(Expr *p, int *pnHeight){
6564b5255acSdanielk1977   if( p ){
6574b5255acSdanielk1977     if( p->nHeight>*pnHeight ){
6584b5255acSdanielk1977       *pnHeight = p->nHeight;
6594b5255acSdanielk1977     }
6604b5255acSdanielk1977   }
6614b5255acSdanielk1977 }
6624b5255acSdanielk1977 static void heightOfExprList(ExprList *p, int *pnHeight){
6634b5255acSdanielk1977   if( p ){
6644b5255acSdanielk1977     int i;
6654b5255acSdanielk1977     for(i=0; i<p->nExpr; i++){
6664b5255acSdanielk1977       heightOfExpr(p->a[i].pExpr, pnHeight);
6674b5255acSdanielk1977     }
6684b5255acSdanielk1977   }
6694b5255acSdanielk1977 }
6701a3a3086Sdan static void heightOfSelect(Select *pSelect, int *pnHeight){
6711a3a3086Sdan   Select *p;
6721a3a3086Sdan   for(p=pSelect; p; p=p->pPrior){
6734b5255acSdanielk1977     heightOfExpr(p->pWhere, pnHeight);
6744b5255acSdanielk1977     heightOfExpr(p->pHaving, pnHeight);
6754b5255acSdanielk1977     heightOfExpr(p->pLimit, pnHeight);
6764b5255acSdanielk1977     heightOfExprList(p->pEList, pnHeight);
6774b5255acSdanielk1977     heightOfExprList(p->pGroupBy, pnHeight);
6784b5255acSdanielk1977     heightOfExprList(p->pOrderBy, pnHeight);
6794b5255acSdanielk1977   }
6804b5255acSdanielk1977 }
6814b5255acSdanielk1977 
6824b5255acSdanielk1977 /*
6834b5255acSdanielk1977 ** Set the Expr.nHeight variable in the structure passed as an
6844b5255acSdanielk1977 ** argument. An expression with no children, Expr.pList or
6854b5255acSdanielk1977 ** Expr.pSelect member has a height of 1. Any other expression
6864b5255acSdanielk1977 ** has a height equal to the maximum height of any other
6874b5255acSdanielk1977 ** referenced Expr plus one.
6882308ed38Sdrh **
6892308ed38Sdrh ** Also propagate EP_Propagate flags up from Expr.x.pList to Expr.flags,
6902308ed38Sdrh ** if appropriate.
6914b5255acSdanielk1977 */
6924b5255acSdanielk1977 static void exprSetHeight(Expr *p){
6934b5255acSdanielk1977   int nHeight = 0;
6944b5255acSdanielk1977   heightOfExpr(p->pLeft, &nHeight);
6954b5255acSdanielk1977   heightOfExpr(p->pRight, &nHeight);
6966ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_xIsSelect) ){
6976ab3a2ecSdanielk1977     heightOfSelect(p->x.pSelect, &nHeight);
6982308ed38Sdrh   }else if( p->x.pList ){
6996ab3a2ecSdanielk1977     heightOfExprList(p->x.pList, &nHeight);
7002308ed38Sdrh     p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
7016ab3a2ecSdanielk1977   }
7024b5255acSdanielk1977   p->nHeight = nHeight + 1;
7034b5255acSdanielk1977 }
7044b5255acSdanielk1977 
7054b5255acSdanielk1977 /*
7064b5255acSdanielk1977 ** Set the Expr.nHeight variable using the exprSetHeight() function. If
7074b5255acSdanielk1977 ** the height is greater than the maximum allowed expression depth,
7084b5255acSdanielk1977 ** leave an error in pParse.
7092308ed38Sdrh **
7102308ed38Sdrh ** Also propagate all EP_Propagate flags from the Expr.x.pList into
7112308ed38Sdrh ** Expr.flags.
7124b5255acSdanielk1977 */
7132308ed38Sdrh void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
71474893a4cSdrh   if( pParse->nErr ) return;
7154b5255acSdanielk1977   exprSetHeight(p);
7167d10d5a6Sdrh   sqlite3ExprCheckHeight(pParse, p->nHeight);
7174b5255acSdanielk1977 }
7184b5255acSdanielk1977 
7194b5255acSdanielk1977 /*
7204b5255acSdanielk1977 ** Return the maximum height of any expression tree referenced
7214b5255acSdanielk1977 ** by the select statement passed as an argument.
7224b5255acSdanielk1977 */
7234b5255acSdanielk1977 int sqlite3SelectExprHeight(Select *p){
7244b5255acSdanielk1977   int nHeight = 0;
7254b5255acSdanielk1977   heightOfSelect(p, &nHeight);
7264b5255acSdanielk1977   return nHeight;
7274b5255acSdanielk1977 }
7282308ed38Sdrh #else /* ABOVE:  Height enforcement enabled.  BELOW: Height enforcement off */
7292308ed38Sdrh /*
7302308ed38Sdrh ** Propagate all EP_Propagate flags from the Expr.x.pList into
7312308ed38Sdrh ** Expr.flags.
7322308ed38Sdrh */
7332308ed38Sdrh void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
7342308ed38Sdrh   if( p && p->x.pList && !ExprHasProperty(p, EP_xIsSelect) ){
7352308ed38Sdrh     p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
7362308ed38Sdrh   }
7372308ed38Sdrh }
7384b5255acSdanielk1977 #define exprSetHeight(y)
7394b5255acSdanielk1977 #endif /* SQLITE_MAX_EXPR_DEPTH>0 */
7404b5255acSdanielk1977 
741be5c89acSdrh /*
742b7916a78Sdrh ** This routine is the core allocator for Expr nodes.
743b7916a78Sdrh **
744a76b5dfcSdrh ** Construct a new expression node and return a pointer to it.  Memory
745b7916a78Sdrh ** for this node and for the pToken argument is a single allocation
746b7916a78Sdrh ** obtained from sqlite3DbMalloc().  The calling function
747a76b5dfcSdrh ** is responsible for making sure the node eventually gets freed.
748b7916a78Sdrh **
749b7916a78Sdrh ** If dequote is true, then the token (if it exists) is dequoted.
750e792b5b4Sdrh ** If dequote is false, no dequoting is performed.  The deQuote
751b7916a78Sdrh ** parameter is ignored if pToken is NULL or if the token does not
752b7916a78Sdrh ** appear to be quoted.  If the quotes were of the form "..." (double-quotes)
753b7916a78Sdrh ** then the EP_DblQuoted flag is set on the expression node.
75433e619fcSdrh **
75533e619fcSdrh ** Special case:  If op==TK_INTEGER and pToken points to a string that
75633e619fcSdrh ** can be translated into a 32-bit integer, then the token is not
75733e619fcSdrh ** stored in u.zToken.  Instead, the integer values is written
75833e619fcSdrh ** into u.iValue and the EP_IntValue flag is set.  No extra storage
75933e619fcSdrh ** is allocated to hold the integer text and the dequote flag is ignored.
760a76b5dfcSdrh */
761b7916a78Sdrh Expr *sqlite3ExprAlloc(
762cca8a4adSdrh   sqlite3 *db,            /* Handle for sqlite3DbMallocRawNN() */
76317435752Sdrh   int op,                 /* Expression opcode */
764b7916a78Sdrh   const Token *pToken,    /* Token argument.  Might be NULL */
765b7916a78Sdrh   int dequote             /* True to dequote */
76617435752Sdrh ){
767a76b5dfcSdrh   Expr *pNew;
76833e619fcSdrh   int nExtra = 0;
769cf697396Sshane   int iValue = 0;
770b7916a78Sdrh 
771575fad65Sdrh   assert( db!=0 );
772b7916a78Sdrh   if( pToken ){
77333e619fcSdrh     if( op!=TK_INTEGER || pToken->z==0
77433e619fcSdrh           || sqlite3GetInt32(pToken->z, &iValue)==0 ){
775b7916a78Sdrh       nExtra = pToken->n+1;
776d50ffc41Sdrh       assert( iValue>=0 );
77733e619fcSdrh     }
778a76b5dfcSdrh   }
779575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, sizeof(Expr)+nExtra);
780b7916a78Sdrh   if( pNew ){
781ca3862dcSdrh     memset(pNew, 0, sizeof(Expr));
7821bd10f8aSdrh     pNew->op = (u8)op;
783a58fdfb1Sdanielk1977     pNew->iAgg = -1;
784a76b5dfcSdrh     if( pToken ){
78533e619fcSdrh       if( nExtra==0 ){
786ad31727fSdrh         pNew->flags |= EP_IntValue|EP_Leaf|(iValue?EP_IsTrue:EP_IsFalse);
78733e619fcSdrh         pNew->u.iValue = iValue;
78833e619fcSdrh       }else{
78933e619fcSdrh         pNew->u.zToken = (char*)&pNew[1];
790b07028f7Sdrh         assert( pToken->z!=0 || pToken->n==0 );
791b07028f7Sdrh         if( pToken->n ) memcpy(pNew->u.zToken, pToken->z, pToken->n);
79233e619fcSdrh         pNew->u.zToken[pToken->n] = 0;
793244b9d6eSdrh         if( dequote && sqlite3Isquote(pNew->u.zToken[0]) ){
79451d35b0fSdrh           sqlite3DequoteExpr(pNew);
795a34001c9Sdrh         }
796a34001c9Sdrh       }
79733e619fcSdrh     }
798b7916a78Sdrh #if SQLITE_MAX_EXPR_DEPTH>0
799b7916a78Sdrh     pNew->nHeight = 1;
800b7916a78Sdrh #endif
801a34001c9Sdrh   }
802a76b5dfcSdrh   return pNew;
803a76b5dfcSdrh }
804a76b5dfcSdrh 
805a76b5dfcSdrh /*
806b7916a78Sdrh ** Allocate a new expression node from a zero-terminated token that has
807b7916a78Sdrh ** already been dequoted.
808b7916a78Sdrh */
809b7916a78Sdrh Expr *sqlite3Expr(
810b7916a78Sdrh   sqlite3 *db,            /* Handle for sqlite3DbMallocZero() (may be null) */
811b7916a78Sdrh   int op,                 /* Expression opcode */
812b7916a78Sdrh   const char *zToken      /* Token argument.  Might be NULL */
813b7916a78Sdrh ){
814b7916a78Sdrh   Token x;
815b7916a78Sdrh   x.z = zToken;
816b40f06c6Sdrh   x.n = sqlite3Strlen30(zToken);
817b7916a78Sdrh   return sqlite3ExprAlloc(db, op, &x, 0);
818b7916a78Sdrh }
819b7916a78Sdrh 
820b7916a78Sdrh /*
821b7916a78Sdrh ** Attach subtrees pLeft and pRight to the Expr node pRoot.
822b7916a78Sdrh **
823b7916a78Sdrh ** If pRoot==NULL that means that a memory allocation error has occurred.
824b7916a78Sdrh ** In that case, delete the subtrees pLeft and pRight.
825b7916a78Sdrh */
826b7916a78Sdrh void sqlite3ExprAttachSubtrees(
827b7916a78Sdrh   sqlite3 *db,
828b7916a78Sdrh   Expr *pRoot,
829b7916a78Sdrh   Expr *pLeft,
830b7916a78Sdrh   Expr *pRight
831b7916a78Sdrh ){
832b7916a78Sdrh   if( pRoot==0 ){
833b7916a78Sdrh     assert( db->mallocFailed );
834b7916a78Sdrh     sqlite3ExprDelete(db, pLeft);
835b7916a78Sdrh     sqlite3ExprDelete(db, pRight);
836b7916a78Sdrh   }else{
837b7916a78Sdrh     if( pRight ){
838b7916a78Sdrh       pRoot->pRight = pRight;
839885a5b03Sdrh       pRoot->flags |= EP_Propagate & pRight->flags;
840b7916a78Sdrh     }
841b7916a78Sdrh     if( pLeft ){
842b7916a78Sdrh       pRoot->pLeft = pLeft;
843885a5b03Sdrh       pRoot->flags |= EP_Propagate & pLeft->flags;
844b7916a78Sdrh     }
845b7916a78Sdrh     exprSetHeight(pRoot);
846b7916a78Sdrh   }
847b7916a78Sdrh }
848b7916a78Sdrh 
849b7916a78Sdrh /*
85060ec914cSpeter.d.reid ** Allocate an Expr node which joins as many as two subtrees.
851b7916a78Sdrh **
852bf664469Sdrh ** One or both of the subtrees can be NULL.  Return a pointer to the new
853bf664469Sdrh ** Expr node.  Or, if an OOM error occurs, set pParse->db->mallocFailed,
854bf664469Sdrh ** free the subtrees and return NULL.
855206f3d96Sdrh */
85617435752Sdrh Expr *sqlite3PExpr(
85717435752Sdrh   Parse *pParse,          /* Parsing context */
85817435752Sdrh   int op,                 /* Expression opcode */
85917435752Sdrh   Expr *pLeft,            /* Left operand */
860abfd35eaSdrh   Expr *pRight            /* Right operand */
86117435752Sdrh ){
8625fb52caaSdrh   Expr *p;
863abfd35eaSdrh   p = sqlite3DbMallocRawNN(pParse->db, sizeof(Expr));
864abfd35eaSdrh   if( p ){
865abfd35eaSdrh     memset(p, 0, sizeof(Expr));
866f1722baaSdrh     p->op = op & 0xff;
867abfd35eaSdrh     p->iAgg = -1;
868b7916a78Sdrh     sqlite3ExprAttachSubtrees(pParse->db, p, pLeft, pRight);
8692b359bdbSdan     sqlite3ExprCheckHeight(pParse, p->nHeight);
870d5c851c1Sdrh   }else{
871d5c851c1Sdrh     sqlite3ExprDelete(pParse->db, pLeft);
872d5c851c1Sdrh     sqlite3ExprDelete(pParse->db, pRight);
8732b359bdbSdan   }
8744e0cff60Sdrh   return p;
8754e0cff60Sdrh }
8764e0cff60Sdrh 
8774e0cff60Sdrh /*
87808de4f79Sdrh ** Add pSelect to the Expr.x.pSelect field.  Or, if pExpr is NULL (due
87908de4f79Sdrh ** do a memory allocation failure) then delete the pSelect object.
88008de4f79Sdrh */
88108de4f79Sdrh void sqlite3PExprAddSelect(Parse *pParse, Expr *pExpr, Select *pSelect){
88208de4f79Sdrh   if( pExpr ){
88308de4f79Sdrh     pExpr->x.pSelect = pSelect;
88408de4f79Sdrh     ExprSetProperty(pExpr, EP_xIsSelect|EP_Subquery);
88508de4f79Sdrh     sqlite3ExprSetHeightAndFlags(pParse, pExpr);
88608de4f79Sdrh   }else{
88708de4f79Sdrh     assert( pParse->db->mallocFailed );
88808de4f79Sdrh     sqlite3SelectDelete(pParse->db, pSelect);
88908de4f79Sdrh   }
89008de4f79Sdrh }
89108de4f79Sdrh 
89208de4f79Sdrh 
89308de4f79Sdrh /*
89491bb0eedSdrh ** Join two expressions using an AND operator.  If either expression is
89591bb0eedSdrh ** NULL, then just return the other expression.
8965fb52caaSdrh **
8975fb52caaSdrh ** If one side or the other of the AND is known to be false, then instead
8985fb52caaSdrh ** of returning an AND expression, just return a constant expression with
8995fb52caaSdrh ** a value of false.
90091bb0eedSdrh */
901d5c851c1Sdrh Expr *sqlite3ExprAnd(Parse *pParse, Expr *pLeft, Expr *pRight){
902d5c851c1Sdrh   sqlite3 *db = pParse->db;
90391bb0eedSdrh   if( pLeft==0  ){
90491bb0eedSdrh     return pRight;
90591bb0eedSdrh   }else if( pRight==0 ){
90691bb0eedSdrh     return pLeft;
907ad31727fSdrh   }else if( ExprAlwaysFalse(pLeft) || ExprAlwaysFalse(pRight) ){
9088e34e406Sdrh     sqlite3ExprUnmapAndDelete(pParse, pLeft);
9098e34e406Sdrh     sqlite3ExprUnmapAndDelete(pParse, pRight);
9105fb52caaSdrh     return sqlite3ExprAlloc(db, TK_INTEGER, &sqlite3IntTokens[0], 0);
91191bb0eedSdrh   }else{
912d5c851c1Sdrh     return sqlite3PExpr(pParse, TK_AND, pLeft, pRight);
913a76b5dfcSdrh   }
914a76b5dfcSdrh }
915a76b5dfcSdrh 
916a76b5dfcSdrh /*
917a76b5dfcSdrh ** Construct a new expression node for a function with multiple
918a76b5dfcSdrh ** arguments.
919a76b5dfcSdrh */
920954733b3Sdrh Expr *sqlite3ExprFunction(
921954733b3Sdrh   Parse *pParse,        /* Parsing context */
922954733b3Sdrh   ExprList *pList,      /* Argument list */
923954733b3Sdrh   Token *pToken,        /* Name of the function */
924954733b3Sdrh   int eDistinct         /* SF_Distinct or SF_ALL or 0 */
925954733b3Sdrh ){
926a76b5dfcSdrh   Expr *pNew;
927633e6d57Sdrh   sqlite3 *db = pParse->db;
9284b202ae2Sdanielk1977   assert( pToken );
929b7916a78Sdrh   pNew = sqlite3ExprAlloc(db, TK_FUNCTION, pToken, 1);
930a76b5dfcSdrh   if( pNew==0 ){
931d9da78a2Sdrh     sqlite3ExprListDelete(db, pList); /* Avoid memory leak when malloc fails */
932a76b5dfcSdrh     return 0;
933a76b5dfcSdrh   }
934954733b3Sdrh   if( pList && pList->nExpr > pParse->db->aLimit[SQLITE_LIMIT_FUNCTION_ARG] ){
935954733b3Sdrh     sqlite3ErrorMsg(pParse, "too many arguments on function %T", pToken);
936954733b3Sdrh   }
9376ab3a2ecSdanielk1977   pNew->x.pList = pList;
938fca23557Sdrh   ExprSetProperty(pNew, EP_HasFunc);
9396ab3a2ecSdanielk1977   assert( !ExprHasProperty(pNew, EP_xIsSelect) );
9402308ed38Sdrh   sqlite3ExprSetHeightAndFlags(pParse, pNew);
941954733b3Sdrh   if( eDistinct==SF_Distinct ) ExprSetProperty(pNew, EP_Distinct);
942a76b5dfcSdrh   return pNew;
943a76b5dfcSdrh }
944a76b5dfcSdrh 
945a76b5dfcSdrh /*
946fa6bc000Sdrh ** Assign a variable number to an expression that encodes a wildcard
947fa6bc000Sdrh ** in the original SQL statement.
948fa6bc000Sdrh **
949fa6bc000Sdrh ** Wildcards consisting of a single "?" are assigned the next sequential
950fa6bc000Sdrh ** variable number.
951fa6bc000Sdrh **
952fa6bc000Sdrh ** Wildcards of the form "?nnn" are assigned the number "nnn".  We make
9539bf755ccSdrh ** sure "nnn" is not too big to avoid a denial of service attack when
954fa6bc000Sdrh ** the SQL statement comes from an external source.
955fa6bc000Sdrh **
95651f49f17Sdrh ** Wildcards of the form ":aaa", "@aaa", or "$aaa" are assigned the same number
957fa6bc000Sdrh ** as the previous instance of the same wildcard.  Or if this is the first
95860ec914cSpeter.d.reid ** instance of the wildcard, the next sequential variable number is
959fa6bc000Sdrh ** assigned.
960fa6bc000Sdrh */
961de25a88cSdrh void sqlite3ExprAssignVarNumber(Parse *pParse, Expr *pExpr, u32 n){
96217435752Sdrh   sqlite3 *db = pParse->db;
963b7916a78Sdrh   const char *z;
964f326d66dSdrh   ynVar x;
96517435752Sdrh 
966fa6bc000Sdrh   if( pExpr==0 ) return;
967c5cd1249Sdrh   assert( !ExprHasProperty(pExpr, EP_IntValue|EP_Reduced|EP_TokenOnly) );
96833e619fcSdrh   z = pExpr->u.zToken;
969b7916a78Sdrh   assert( z!=0 );
970b7916a78Sdrh   assert( z[0]!=0 );
971b1ed717fSmistachkin   assert( n==(u32)sqlite3Strlen30(z) );
972b7916a78Sdrh   if( z[1]==0 ){
973fa6bc000Sdrh     /* Wildcard of the form "?".  Assign the next variable number */
974b7916a78Sdrh     assert( z[0]=='?' );
975f326d66dSdrh     x = (ynVar)(++pParse->nVar);
976124c0b49Sdrh   }else{
977f326d66dSdrh     int doAdd = 0;
978124c0b49Sdrh     if( z[0]=='?' ){
979fa6bc000Sdrh       /* Wildcard of the form "?nnn".  Convert "nnn" to an integer and
980fa6bc000Sdrh       ** use it as the variable number */
981c8d735aeSdan       i64 i;
98218814dfbSdrh       int bOk;
98318814dfbSdrh       if( n==2 ){ /*OPTIMIZATION-IF-TRUE*/
98418814dfbSdrh         i = z[1]-'0';  /* The common case of ?N for a single digit N */
98518814dfbSdrh         bOk = 1;
98618814dfbSdrh       }else{
98718814dfbSdrh         bOk = 0==sqlite3Atoi64(&z[1], &i, n-1, SQLITE_UTF8);
98818814dfbSdrh       }
989c5499befSdrh       testcase( i==0 );
990c5499befSdrh       testcase( i==1 );
991c5499befSdrh       testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]-1 );
992c5499befSdrh       testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] );
993c8d735aeSdan       if( bOk==0 || i<1 || i>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
994fa6bc000Sdrh         sqlite3ErrorMsg(pParse, "variable number must be between ?1 and ?%d",
995bb4957f8Sdrh             db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]);
996c9b39288Sdrh         return;
997fa6bc000Sdrh       }
9988e74e7baSdrh       x = (ynVar)i;
999f326d66dSdrh       if( x>pParse->nVar ){
1000f326d66dSdrh         pParse->nVar = (int)x;
1001f326d66dSdrh         doAdd = 1;
1002f326d66dSdrh       }else if( sqlite3VListNumToName(pParse->pVList, x)==0 ){
1003f326d66dSdrh         doAdd = 1;
1004fa6bc000Sdrh       }
1005fa6bc000Sdrh     }else{
100651f49f17Sdrh       /* Wildcards like ":aaa", "$aaa" or "@aaa".  Reuse the same variable
1007fa6bc000Sdrh       ** number as the prior appearance of the same name, or if the name
1008fa6bc000Sdrh       ** has never appeared before, reuse the same variable number
1009fa6bc000Sdrh       */
10109bf755ccSdrh       x = (ynVar)sqlite3VListNameToNum(pParse->pVList, z, n);
10119bf755ccSdrh       if( x==0 ){
10129bf755ccSdrh         x = (ynVar)(++pParse->nVar);
1013f326d66dSdrh         doAdd = 1;
1014f326d66dSdrh       }
1015f326d66dSdrh     }
1016f326d66dSdrh     if( doAdd ){
10179bf755ccSdrh       pParse->pVList = sqlite3VListAdd(db, pParse->pVList, z, n, x);
1018fa6bc000Sdrh     }
1019fa6bc000Sdrh   }
1020c9b39288Sdrh   pExpr->iColumn = x;
1021f326d66dSdrh   if( x>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
1022832b2664Sdanielk1977     sqlite3ErrorMsg(pParse, "too many SQL variables");
1023832b2664Sdanielk1977   }
1024fa6bc000Sdrh }
1025fa6bc000Sdrh 
1026fa6bc000Sdrh /*
1027f6963f99Sdan ** Recursively delete an expression tree.
1028a2e00042Sdrh */
10294f0010b1Sdrh static SQLITE_NOINLINE void sqlite3ExprDeleteNN(sqlite3 *db, Expr *p){
10304f0010b1Sdrh   assert( p!=0 );
1031d50ffc41Sdrh   /* Sanity check: Assert that the IntValue is non-negative if it exists */
1032d50ffc41Sdrh   assert( !ExprHasProperty(p, EP_IntValue) || p->u.iValue>=0 );
1033eda079cdSdrh 
1034eda079cdSdrh   assert( !ExprHasProperty(p, EP_WinFunc) || p->y.pWin!=0 || db->mallocFailed );
1035eda079cdSdrh   assert( p->op!=TK_FUNCTION || ExprHasProperty(p, EP_TokenOnly|EP_Reduced)
10364f9adee2Sdan           || p->y.pWin==0 || ExprHasProperty(p, EP_WinFunc) );
1037209bc522Sdrh #ifdef SQLITE_DEBUG
1038209bc522Sdrh   if( ExprHasProperty(p, EP_Leaf) && !ExprHasProperty(p, EP_TokenOnly) ){
1039209bc522Sdrh     assert( p->pLeft==0 );
1040209bc522Sdrh     assert( p->pRight==0 );
1041209bc522Sdrh     assert( p->x.pSelect==0 );
1042209bc522Sdrh   }
1043209bc522Sdrh #endif
1044209bc522Sdrh   if( !ExprHasProperty(p, (EP_TokenOnly|EP_Leaf)) ){
1045c5cd1249Sdrh     /* The Expr.x union is never used at the same time as Expr.pRight */
1046c5cd1249Sdrh     assert( p->x.pList==0 || p->pRight==0 );
10474910a76dSdrh     if( p->pLeft && p->op!=TK_SELECT_COLUMN ) sqlite3ExprDeleteNN(db, p->pLeft);
1048d1086679Sdrh     if( p->pRight ){
10494f9adee2Sdan       assert( !ExprHasProperty(p, EP_WinFunc) );
1050d1086679Sdrh       sqlite3ExprDeleteNN(db, p->pRight);
1051d1086679Sdrh     }else if( ExprHasProperty(p, EP_xIsSelect) ){
10524f9adee2Sdan       assert( !ExprHasProperty(p, EP_WinFunc) );
10536ab3a2ecSdanielk1977       sqlite3SelectDelete(db, p->x.pSelect);
10546ab3a2ecSdanielk1977     }else{
10556ab3a2ecSdanielk1977       sqlite3ExprListDelete(db, p->x.pList);
10566ba7ab0dSdan #ifndef SQLITE_OMIT_WINDOWFUNC
1057eda079cdSdrh       if( ExprHasProperty(p, EP_WinFunc) ){
1058eda079cdSdrh         sqlite3WindowDelete(db, p->y.pWin);
105986fb6e17Sdan       }
10606ba7ab0dSdan #endif
10616ab3a2ecSdanielk1977     }
10628117f113Sdan   }
1063209bc522Sdrh   if( ExprHasProperty(p, EP_MemToken) ) sqlite3DbFree(db, p->u.zToken);
106433e619fcSdrh   if( !ExprHasProperty(p, EP_Static) ){
1065dbd6a7dcSdrh     sqlite3DbFreeNN(db, p);
1066a2e00042Sdrh   }
106733e619fcSdrh }
10684f0010b1Sdrh void sqlite3ExprDelete(sqlite3 *db, Expr *p){
10694f0010b1Sdrh   if( p ) sqlite3ExprDeleteNN(db, p);
10704f0010b1Sdrh }
1071a2e00042Sdrh 
10728e34e406Sdrh /* Invoke sqlite3RenameExprUnmap() and sqlite3ExprDelete() on the
10738e34e406Sdrh ** expression.
10748e34e406Sdrh */
10758e34e406Sdrh void sqlite3ExprUnmapAndDelete(Parse *pParse, Expr *p){
10768e34e406Sdrh   if( p ){
10778e34e406Sdrh     if( IN_RENAME_OBJECT ){
10788e34e406Sdrh       sqlite3RenameExprUnmap(pParse, p);
10798e34e406Sdrh     }
10808e34e406Sdrh     sqlite3ExprDeleteNN(pParse->db, p);
10818e34e406Sdrh   }
10828e34e406Sdrh }
10838e34e406Sdrh 
1084d2687b77Sdrh /*
10856ab3a2ecSdanielk1977 ** Return the number of bytes allocated for the expression structure
10866ab3a2ecSdanielk1977 ** passed as the first argument. This is always one of EXPR_FULLSIZE,
10876ab3a2ecSdanielk1977 ** EXPR_REDUCEDSIZE or EXPR_TOKENONLYSIZE.
10886ab3a2ecSdanielk1977 */
10896ab3a2ecSdanielk1977 static int exprStructSize(Expr *p){
10906ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_TokenOnly) ) return EXPR_TOKENONLYSIZE;
10916ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_Reduced) ) return EXPR_REDUCEDSIZE;
10926ab3a2ecSdanielk1977   return EXPR_FULLSIZE;
10936ab3a2ecSdanielk1977 }
10946ab3a2ecSdanielk1977 
10956ab3a2ecSdanielk1977 /*
109633e619fcSdrh ** The dupedExpr*Size() routines each return the number of bytes required
109733e619fcSdrh ** to store a copy of an expression or expression tree.  They differ in
109833e619fcSdrh ** how much of the tree is measured.
109933e619fcSdrh **
110033e619fcSdrh **     dupedExprStructSize()     Size of only the Expr structure
110133e619fcSdrh **     dupedExprNodeSize()       Size of Expr + space for token
110233e619fcSdrh **     dupedExprSize()           Expr + token + subtree components
110333e619fcSdrh **
110433e619fcSdrh ***************************************************************************
110533e619fcSdrh **
110633e619fcSdrh ** The dupedExprStructSize() function returns two values OR-ed together:
110733e619fcSdrh ** (1) the space required for a copy of the Expr structure only and
110833e619fcSdrh ** (2) the EP_xxx flags that indicate what the structure size should be.
110933e619fcSdrh ** The return values is always one of:
111033e619fcSdrh **
111133e619fcSdrh **      EXPR_FULLSIZE
111233e619fcSdrh **      EXPR_REDUCEDSIZE   | EP_Reduced
111333e619fcSdrh **      EXPR_TOKENONLYSIZE | EP_TokenOnly
111433e619fcSdrh **
111533e619fcSdrh ** The size of the structure can be found by masking the return value
111633e619fcSdrh ** of this routine with 0xfff.  The flags can be found by masking the
111733e619fcSdrh ** return value with EP_Reduced|EP_TokenOnly.
111833e619fcSdrh **
111933e619fcSdrh ** Note that with flags==EXPRDUP_REDUCE, this routines works on full-size
112033e619fcSdrh ** (unreduced) Expr objects as they or originally constructed by the parser.
112133e619fcSdrh ** During expression analysis, extra information is computed and moved into
1122c95f38d4Sdan ** later parts of the Expr object and that extra information might get chopped
112333e619fcSdrh ** off if the expression is reduced.  Note also that it does not work to
112460ec914cSpeter.d.reid ** make an EXPRDUP_REDUCE copy of a reduced expression.  It is only legal
112533e619fcSdrh ** to reduce a pristine expression tree from the parser.  The implementation
112633e619fcSdrh ** of dupedExprStructSize() contain multiple assert() statements that attempt
112733e619fcSdrh ** to enforce this constraint.
11286ab3a2ecSdanielk1977 */
11296ab3a2ecSdanielk1977 static int dupedExprStructSize(Expr *p, int flags){
11306ab3a2ecSdanielk1977   int nSize;
113133e619fcSdrh   assert( flags==EXPRDUP_REDUCE || flags==0 ); /* Only one flag value allowed */
1132aecd8021Sdrh   assert( EXPR_FULLSIZE<=0xfff );
1133aecd8021Sdrh   assert( (0xfff & (EP_Reduced|EP_TokenOnly))==0 );
113467a9b8edSdan   if( 0==flags || p->op==TK_SELECT_COLUMN
113567a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
1136eda079cdSdrh    || ExprHasProperty(p, EP_WinFunc)
113767a9b8edSdan #endif
113867a9b8edSdan   ){
11396ab3a2ecSdanielk1977     nSize = EXPR_FULLSIZE;
11406ab3a2ecSdanielk1977   }else{
1141c5cd1249Sdrh     assert( !ExprHasProperty(p, EP_TokenOnly|EP_Reduced) );
114233e619fcSdrh     assert( !ExprHasProperty(p, EP_FromJoin) );
1143c5cd1249Sdrh     assert( !ExprHasProperty(p, EP_MemToken) );
1144ebb6a65dSdrh     assert( !ExprHasProperty(p, EP_NoReduce) );
1145aecd8021Sdrh     if( p->pLeft || p->x.pList ){
114633e619fcSdrh       nSize = EXPR_REDUCEDSIZE | EP_Reduced;
114733e619fcSdrh     }else{
1148aecd8021Sdrh       assert( p->pRight==0 );
114933e619fcSdrh       nSize = EXPR_TOKENONLYSIZE | EP_TokenOnly;
115033e619fcSdrh     }
11516ab3a2ecSdanielk1977   }
11526ab3a2ecSdanielk1977   return nSize;
11536ab3a2ecSdanielk1977 }
11546ab3a2ecSdanielk1977 
11556ab3a2ecSdanielk1977 /*
115633e619fcSdrh ** This function returns the space in bytes required to store the copy
115733e619fcSdrh ** of the Expr structure and a copy of the Expr.u.zToken string (if that
115833e619fcSdrh ** string is defined.)
11596ab3a2ecSdanielk1977 */
11606ab3a2ecSdanielk1977 static int dupedExprNodeSize(Expr *p, int flags){
116133e619fcSdrh   int nByte = dupedExprStructSize(p, flags) & 0xfff;
116233e619fcSdrh   if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
11637301e774Sdrh     nByte += sqlite3Strlen30NN(p->u.zToken)+1;
11646ab3a2ecSdanielk1977   }
1165bc73971dSdanielk1977   return ROUND8(nByte);
11666ab3a2ecSdanielk1977 }
11676ab3a2ecSdanielk1977 
11686ab3a2ecSdanielk1977 /*
11696ab3a2ecSdanielk1977 ** Return the number of bytes required to create a duplicate of the
11706ab3a2ecSdanielk1977 ** expression passed as the first argument. The second argument is a
11716ab3a2ecSdanielk1977 ** mask containing EXPRDUP_XXX flags.
11726ab3a2ecSdanielk1977 **
11736ab3a2ecSdanielk1977 ** The value returned includes space to create a copy of the Expr struct
117433e619fcSdrh ** itself and the buffer referred to by Expr.u.zToken, if any.
11756ab3a2ecSdanielk1977 **
11766ab3a2ecSdanielk1977 ** If the EXPRDUP_REDUCE flag is set, then the return value includes
11776ab3a2ecSdanielk1977 ** space to duplicate all Expr nodes in the tree formed by Expr.pLeft
11786ab3a2ecSdanielk1977 ** and Expr.pRight variables (but not for any structures pointed to or
11796ab3a2ecSdanielk1977 ** descended from the Expr.x.pList or Expr.x.pSelect variables).
11806ab3a2ecSdanielk1977 */
11816ab3a2ecSdanielk1977 static int dupedExprSize(Expr *p, int flags){
11826ab3a2ecSdanielk1977   int nByte = 0;
11836ab3a2ecSdanielk1977   if( p ){
11846ab3a2ecSdanielk1977     nByte = dupedExprNodeSize(p, flags);
11856ab3a2ecSdanielk1977     if( flags&EXPRDUP_REDUCE ){
1186b7916a78Sdrh       nByte += dupedExprSize(p->pLeft, flags) + dupedExprSize(p->pRight, flags);
11876ab3a2ecSdanielk1977     }
11886ab3a2ecSdanielk1977   }
11896ab3a2ecSdanielk1977   return nByte;
11906ab3a2ecSdanielk1977 }
11916ab3a2ecSdanielk1977 
11926ab3a2ecSdanielk1977 /*
11936ab3a2ecSdanielk1977 ** This function is similar to sqlite3ExprDup(), except that if pzBuffer
11946ab3a2ecSdanielk1977 ** is not NULL then *pzBuffer is assumed to point to a buffer large enough
119533e619fcSdrh ** to store the copy of expression p, the copies of p->u.zToken
11966ab3a2ecSdanielk1977 ** (if applicable), and the copies of the p->pLeft and p->pRight expressions,
119760ec914cSpeter.d.reid ** if any. Before returning, *pzBuffer is set to the first byte past the
11986ab3a2ecSdanielk1977 ** portion of the buffer copied into by this function.
11996ab3a2ecSdanielk1977 */
12003c19469cSdrh static Expr *exprDup(sqlite3 *db, Expr *p, int dupFlags, u8 **pzBuffer){
12013c19469cSdrh   Expr *pNew;           /* Value to return */
12023c19469cSdrh   u8 *zAlloc;           /* Memory space from which to build Expr object */
12033c19469cSdrh   u32 staticFlag;       /* EP_Static if space not obtained from malloc */
12046ab3a2ecSdanielk1977 
12053c19469cSdrh   assert( db!=0 );
12063c19469cSdrh   assert( p );
12073c19469cSdrh   assert( dupFlags==0 || dupFlags==EXPRDUP_REDUCE );
12083c19469cSdrh   assert( pzBuffer==0 || dupFlags==EXPRDUP_REDUCE );
12096ab3a2ecSdanielk1977 
12106ab3a2ecSdanielk1977   /* Figure out where to write the new Expr structure. */
12116ab3a2ecSdanielk1977   if( pzBuffer ){
12126ab3a2ecSdanielk1977     zAlloc = *pzBuffer;
121333e619fcSdrh     staticFlag = EP_Static;
12146ab3a2ecSdanielk1977   }else{
12153c19469cSdrh     zAlloc = sqlite3DbMallocRawNN(db, dupedExprSize(p, dupFlags));
12163c19469cSdrh     staticFlag = 0;
12176ab3a2ecSdanielk1977   }
12186ab3a2ecSdanielk1977   pNew = (Expr *)zAlloc;
12196ab3a2ecSdanielk1977 
12206ab3a2ecSdanielk1977   if( pNew ){
12216ab3a2ecSdanielk1977     /* Set nNewSize to the size allocated for the structure pointed to
12226ab3a2ecSdanielk1977     ** by pNew. This is either EXPR_FULLSIZE, EXPR_REDUCEDSIZE or
12236ab3a2ecSdanielk1977     ** EXPR_TOKENONLYSIZE. nToken is set to the number of bytes consumed
122433e619fcSdrh     ** by the copy of the p->u.zToken string (if any).
12256ab3a2ecSdanielk1977     */
12263c19469cSdrh     const unsigned nStructSize = dupedExprStructSize(p, dupFlags);
122733e619fcSdrh     const int nNewSize = nStructSize & 0xfff;
122833e619fcSdrh     int nToken;
122933e619fcSdrh     if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
123033e619fcSdrh       nToken = sqlite3Strlen30(p->u.zToken) + 1;
123133e619fcSdrh     }else{
123233e619fcSdrh       nToken = 0;
123333e619fcSdrh     }
12343c19469cSdrh     if( dupFlags ){
12356ab3a2ecSdanielk1977       assert( ExprHasProperty(p, EP_Reduced)==0 );
12366ab3a2ecSdanielk1977       memcpy(zAlloc, p, nNewSize);
12376ab3a2ecSdanielk1977     }else{
12383e6a1411Sdan       u32 nSize = (u32)exprStructSize(p);
12396ab3a2ecSdanielk1977       memcpy(zAlloc, p, nSize);
124072ea29d7Sdrh       if( nSize<EXPR_FULLSIZE ){
12416ab3a2ecSdanielk1977         memset(&zAlloc[nSize], 0, EXPR_FULLSIZE-nSize);
12426ab3a2ecSdanielk1977       }
124372ea29d7Sdrh     }
12446ab3a2ecSdanielk1977 
124533e619fcSdrh     /* Set the EP_Reduced, EP_TokenOnly, and EP_Static flags appropriately. */
1246c5cd1249Sdrh     pNew->flags &= ~(EP_Reduced|EP_TokenOnly|EP_Static|EP_MemToken);
124733e619fcSdrh     pNew->flags |= nStructSize & (EP_Reduced|EP_TokenOnly);
124833e619fcSdrh     pNew->flags |= staticFlag;
12496ab3a2ecSdanielk1977 
125033e619fcSdrh     /* Copy the p->u.zToken string, if any. */
12516ab3a2ecSdanielk1977     if( nToken ){
125233e619fcSdrh       char *zToken = pNew->u.zToken = (char*)&zAlloc[nNewSize];
125333e619fcSdrh       memcpy(zToken, p->u.zToken, nToken);
12546ab3a2ecSdanielk1977     }
12556ab3a2ecSdanielk1977 
1256209bc522Sdrh     if( 0==((p->flags|pNew->flags) & (EP_TokenOnly|EP_Leaf)) ){
12576ab3a2ecSdanielk1977       /* Fill in the pNew->x.pSelect or pNew->x.pList member. */
12586ab3a2ecSdanielk1977       if( ExprHasProperty(p, EP_xIsSelect) ){
12593c19469cSdrh         pNew->x.pSelect = sqlite3SelectDup(db, p->x.pSelect, dupFlags);
12606ab3a2ecSdanielk1977       }else{
12613c19469cSdrh         pNew->x.pList = sqlite3ExprListDup(db, p->x.pList, dupFlags);
12626ab3a2ecSdanielk1977       }
12636ab3a2ecSdanielk1977     }
12646ab3a2ecSdanielk1977 
12656ab3a2ecSdanielk1977     /* Fill in pNew->pLeft and pNew->pRight. */
12664f9adee2Sdan     if( ExprHasProperty(pNew, EP_Reduced|EP_TokenOnly|EP_WinFunc) ){
12673c19469cSdrh       zAlloc += dupedExprNodeSize(p, dupFlags);
1268209bc522Sdrh       if( !ExprHasProperty(pNew, EP_TokenOnly|EP_Leaf) ){
12693c19469cSdrh         pNew->pLeft = p->pLeft ?
12703c19469cSdrh                       exprDup(db, p->pLeft, EXPRDUP_REDUCE, &zAlloc) : 0;
12713c19469cSdrh         pNew->pRight = p->pRight ?
12723c19469cSdrh                        exprDup(db, p->pRight, EXPRDUP_REDUCE, &zAlloc) : 0;
12736ab3a2ecSdanielk1977       }
127467a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
1275eda079cdSdrh       if( ExprHasProperty(p, EP_WinFunc) ){
1276eda079cdSdrh         pNew->y.pWin = sqlite3WindowDup(db, pNew, p->y.pWin);
1277eda079cdSdrh         assert( ExprHasProperty(pNew, EP_WinFunc) );
1278e2f781b9Sdan       }
127967a9b8edSdan #endif /* SQLITE_OMIT_WINDOWFUNC */
128053988068Sdrh       if( pzBuffer ){
128153988068Sdrh         *pzBuffer = zAlloc;
128253988068Sdrh       }
128353988068Sdrh     }else{
1284209bc522Sdrh       if( !ExprHasProperty(p, EP_TokenOnly|EP_Leaf) ){
12859854260bSdrh         if( pNew->op==TK_SELECT_COLUMN ){
12869854260bSdrh           pNew->pLeft = p->pLeft;
128747073f62Sdrh           assert( p->iColumn==0 || p->pRight==0 );
128847073f62Sdrh           assert( p->pRight==0  || p->pRight==p->pLeft );
12899854260bSdrh         }else{
12906ab3a2ecSdanielk1977           pNew->pLeft = sqlite3ExprDup(db, p->pLeft, 0);
12919854260bSdrh         }
12926ab3a2ecSdanielk1977         pNew->pRight = sqlite3ExprDup(db, p->pRight, 0);
12936ab3a2ecSdanielk1977       }
12946ab3a2ecSdanielk1977     }
12956ab3a2ecSdanielk1977   }
12966ab3a2ecSdanielk1977   return pNew;
12976ab3a2ecSdanielk1977 }
12986ab3a2ecSdanielk1977 
12996ab3a2ecSdanielk1977 /*
1300bfe31e7fSdan ** Create and return a deep copy of the object passed as the second
1301bfe31e7fSdan ** argument. If an OOM condition is encountered, NULL is returned
1302bfe31e7fSdan ** and the db->mallocFailed flag set.
1303bfe31e7fSdan */
1304eede6a53Sdan #ifndef SQLITE_OMIT_CTE
1305bfe31e7fSdan static With *withDup(sqlite3 *db, With *p){
13064e9119d9Sdan   With *pRet = 0;
13074e9119d9Sdan   if( p ){
1308d4de9f7bSdrh     sqlite3_int64 nByte = sizeof(*p) + sizeof(p->a[0]) * (p->nCte-1);
13094e9119d9Sdan     pRet = sqlite3DbMallocZero(db, nByte);
13104e9119d9Sdan     if( pRet ){
13114e9119d9Sdan       int i;
13124e9119d9Sdan       pRet->nCte = p->nCte;
13134e9119d9Sdan       for(i=0; i<p->nCte; i++){
13144e9119d9Sdan         pRet->a[i].pSelect = sqlite3SelectDup(db, p->a[i].pSelect, 0);
13154e9119d9Sdan         pRet->a[i].pCols = sqlite3ExprListDup(db, p->a[i].pCols, 0);
13164e9119d9Sdan         pRet->a[i].zName = sqlite3DbStrDup(db, p->a[i].zName);
13174e9119d9Sdan       }
13184e9119d9Sdan     }
13194e9119d9Sdan   }
13204e9119d9Sdan   return pRet;
13214e9119d9Sdan }
1322eede6a53Sdan #else
1323eede6a53Sdan # define withDup(x,y) 0
1324eede6a53Sdan #endif
13254e9119d9Sdan 
1326a8389975Sdrh #ifndef SQLITE_OMIT_WINDOWFUNC
1327a8389975Sdrh /*
1328a8389975Sdrh ** The gatherSelectWindows() procedure and its helper routine
1329a8389975Sdrh ** gatherSelectWindowsCallback() are used to scan all the expressions
1330a8389975Sdrh ** an a newly duplicated SELECT statement and gather all of the Window
1331a8389975Sdrh ** objects found there, assembling them onto the linked list at Select->pWin.
1332a8389975Sdrh */
1333a8389975Sdrh static int gatherSelectWindowsCallback(Walker *pWalker, Expr *pExpr){
13346ba7ab0dSdan   if( pExpr->op==TK_FUNCTION && ExprHasProperty(pExpr, EP_WinFunc) ){
133575b0821eSdan     Select *pSelect = pWalker->u.pSelect;
133675b0821eSdan     Window *pWin = pExpr->y.pWin;
133775b0821eSdan     assert( pWin );
13384f9adee2Sdan     assert( IsWindowFunc(pExpr) );
1339e0ae3f69Sdan     assert( pWin->ppThis==0 );
1340a3fcc000Sdan     sqlite3WindowLink(pSelect, pWin);
1341a8389975Sdrh   }
1342a8389975Sdrh   return WRC_Continue;
1343a8389975Sdrh }
1344a37b6a5eSdrh static int gatherSelectWindowsSelectCallback(Walker *pWalker, Select *p){
1345a37b6a5eSdrh   return p==pWalker->u.pSelect ? WRC_Continue : WRC_Prune;
1346a37b6a5eSdrh }
1347a8389975Sdrh static void gatherSelectWindows(Select *p){
1348a8389975Sdrh   Walker w;
1349a8389975Sdrh   w.xExprCallback = gatherSelectWindowsCallback;
1350a37b6a5eSdrh   w.xSelectCallback = gatherSelectWindowsSelectCallback;
1351a37b6a5eSdrh   w.xSelectCallback2 = 0;
13529c46c66cSdrh   w.pParse = 0;
1353a8389975Sdrh   w.u.pSelect = p;
1354a37b6a5eSdrh   sqlite3WalkSelect(&w, p);
1355a8389975Sdrh }
1356a8389975Sdrh #endif
1357a8389975Sdrh 
1358a8389975Sdrh 
1359a76b5dfcSdrh /*
1360ff78bd2fSdrh ** The following group of routines make deep copies of expressions,
1361ff78bd2fSdrh ** expression lists, ID lists, and select statements.  The copies can
1362ff78bd2fSdrh ** be deleted (by being passed to their respective ...Delete() routines)
1363ff78bd2fSdrh ** without effecting the originals.
1364ff78bd2fSdrh **
13654adee20fSdanielk1977 ** The expression list, ID, and source lists return by sqlite3ExprListDup(),
13664adee20fSdanielk1977 ** sqlite3IdListDup(), and sqlite3SrcListDup() can not be further expanded
1367ad3cab52Sdrh ** by subsequent calls to sqlite*ListAppend() routines.
1368ff78bd2fSdrh **
1369ad3cab52Sdrh ** Any tables that the SrcList might point to are not duplicated.
13706ab3a2ecSdanielk1977 **
1371b7916a78Sdrh ** The flags parameter contains a combination of the EXPRDUP_XXX flags.
13726ab3a2ecSdanielk1977 ** If the EXPRDUP_REDUCE flag is set, then the structure returned is a
13736ab3a2ecSdanielk1977 ** truncated version of the usual Expr structure that will be stored as
13746ab3a2ecSdanielk1977 ** part of the in-memory representation of the database schema.
1375ff78bd2fSdrh */
13766ab3a2ecSdanielk1977 Expr *sqlite3ExprDup(sqlite3 *db, Expr *p, int flags){
137772ea29d7Sdrh   assert( flags==0 || flags==EXPRDUP_REDUCE );
13783c19469cSdrh   return p ? exprDup(db, p, flags, 0) : 0;
1379ff78bd2fSdrh }
13806ab3a2ecSdanielk1977 ExprList *sqlite3ExprListDup(sqlite3 *db, ExprList *p, int flags){
1381ff78bd2fSdrh   ExprList *pNew;
1382145716b3Sdrh   struct ExprList_item *pItem, *pOldItem;
1383ff78bd2fSdrh   int i;
1384b163748eSdrh   Expr *pPriorSelectCol = 0;
1385575fad65Sdrh   assert( db!=0 );
1386ff78bd2fSdrh   if( p==0 ) return 0;
138797258194Sdrh   pNew = sqlite3DbMallocRawNN(db, sqlite3DbMallocSize(db, p));
1388ff78bd2fSdrh   if( pNew==0 ) return 0;
1389a19543feSdrh   pNew->nExpr = p->nExpr;
139043606175Sdrh   pItem = pNew->a;
1391145716b3Sdrh   pOldItem = p->a;
1392145716b3Sdrh   for(i=0; i<p->nExpr; i++, pItem++, pOldItem++){
13936ab3a2ecSdanielk1977     Expr *pOldExpr = pOldItem->pExpr;
139447073f62Sdrh     Expr *pNewExpr;
1395b5526ea6Sdrh     pItem->pExpr = sqlite3ExprDup(db, pOldExpr, flags);
139647073f62Sdrh     if( pOldExpr
139747073f62Sdrh      && pOldExpr->op==TK_SELECT_COLUMN
139847073f62Sdrh      && (pNewExpr = pItem->pExpr)!=0
139947073f62Sdrh     ){
140047073f62Sdrh       assert( pNewExpr->iColumn==0 || i>0 );
140147073f62Sdrh       if( pNewExpr->iColumn==0 ){
140247073f62Sdrh         assert( pOldExpr->pLeft==pOldExpr->pRight );
1403b163748eSdrh         pPriorSelectCol = pNewExpr->pLeft = pNewExpr->pRight;
1404b163748eSdrh       }else{
1405b163748eSdrh         assert( i>0 );
1406b163748eSdrh         assert( pItem[-1].pExpr!=0 );
1407b163748eSdrh         assert( pNewExpr->iColumn==pItem[-1].pExpr->iColumn+1 );
1408b163748eSdrh         assert( pPriorSelectCol==pItem[-1].pExpr->pLeft );
1409b163748eSdrh         pNewExpr->pLeft = pPriorSelectCol;
141047073f62Sdrh       }
141147073f62Sdrh     }
141217435752Sdrh     pItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
1413b7916a78Sdrh     pItem->zSpan = sqlite3DbStrDup(db, pOldItem->zSpan);
1414145716b3Sdrh     pItem->sortOrder = pOldItem->sortOrder;
14153e7bc9caSdrh     pItem->done = 0;
14162c036cffSdrh     pItem->bSpanIsTab = pOldItem->bSpanIsTab;
141724e25d32Sdan     pItem->bSorterRef = pOldItem->bSorterRef;
1418c2acc4e4Sdrh     pItem->u = pOldItem->u;
1419ff78bd2fSdrh   }
1420ff78bd2fSdrh   return pNew;
1421ff78bd2fSdrh }
142293758c8dSdanielk1977 
142393758c8dSdanielk1977 /*
142493758c8dSdanielk1977 ** If cursors, triggers, views and subqueries are all omitted from
142593758c8dSdanielk1977 ** the build, then none of the following routines, except for
142693758c8dSdanielk1977 ** sqlite3SelectDup(), can be called. sqlite3SelectDup() is sometimes
142793758c8dSdanielk1977 ** called with a NULL argument.
142893758c8dSdanielk1977 */
14296a67fe8eSdanielk1977 #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_TRIGGER) \
14306a67fe8eSdanielk1977  || !defined(SQLITE_OMIT_SUBQUERY)
14316ab3a2ecSdanielk1977 SrcList *sqlite3SrcListDup(sqlite3 *db, SrcList *p, int flags){
1432ad3cab52Sdrh   SrcList *pNew;
1433ad3cab52Sdrh   int i;
1434113088ecSdrh   int nByte;
1435575fad65Sdrh   assert( db!=0 );
1436ad3cab52Sdrh   if( p==0 ) return 0;
1437113088ecSdrh   nByte = sizeof(*p) + (p->nSrc>0 ? sizeof(p->a[0]) * (p->nSrc-1) : 0);
1438575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, nByte );
1439ad3cab52Sdrh   if( pNew==0 ) return 0;
14404305d103Sdrh   pNew->nSrc = pNew->nAlloc = p->nSrc;
1441ad3cab52Sdrh   for(i=0; i<p->nSrc; i++){
14424efc4754Sdrh     struct SrcList_item *pNewItem = &pNew->a[i];
14434efc4754Sdrh     struct SrcList_item *pOldItem = &p->a[i];
1444ed8a3bb1Sdrh     Table *pTab;
144541fb5cd1Sdan     pNewItem->pSchema = pOldItem->pSchema;
144617435752Sdrh     pNewItem->zDatabase = sqlite3DbStrDup(db, pOldItem->zDatabase);
144717435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
144817435752Sdrh     pNewItem->zAlias = sqlite3DbStrDup(db, pOldItem->zAlias);
14498a48b9c0Sdrh     pNewItem->fg = pOldItem->fg;
14504efc4754Sdrh     pNewItem->iCursor = pOldItem->iCursor;
14515b6a9ed4Sdrh     pNewItem->addrFillSub = pOldItem->addrFillSub;
14525b6a9ed4Sdrh     pNewItem->regReturn = pOldItem->regReturn;
14538a48b9c0Sdrh     if( pNewItem->fg.isIndexedBy ){
14548a48b9c0Sdrh       pNewItem->u1.zIndexedBy = sqlite3DbStrDup(db, pOldItem->u1.zIndexedBy);
14558a48b9c0Sdrh     }
14568a48b9c0Sdrh     pNewItem->pIBIndex = pOldItem->pIBIndex;
14578a48b9c0Sdrh     if( pNewItem->fg.isTabFunc ){
14588a48b9c0Sdrh       pNewItem->u1.pFuncArg =
14598a48b9c0Sdrh           sqlite3ExprListDup(db, pOldItem->u1.pFuncArg, flags);
14608a48b9c0Sdrh     }
1461ed8a3bb1Sdrh     pTab = pNewItem->pTab = pOldItem->pTab;
1462ed8a3bb1Sdrh     if( pTab ){
146379df7782Sdrh       pTab->nTabRef++;
1464a1cb183dSdanielk1977     }
14656ab3a2ecSdanielk1977     pNewItem->pSelect = sqlite3SelectDup(db, pOldItem->pSelect, flags);
14666ab3a2ecSdanielk1977     pNewItem->pOn = sqlite3ExprDup(db, pOldItem->pOn, flags);
146717435752Sdrh     pNewItem->pUsing = sqlite3IdListDup(db, pOldItem->pUsing);
14686c18b6e0Sdanielk1977     pNewItem->colUsed = pOldItem->colUsed;
1469ad3cab52Sdrh   }
1470ad3cab52Sdrh   return pNew;
1471ad3cab52Sdrh }
147217435752Sdrh IdList *sqlite3IdListDup(sqlite3 *db, IdList *p){
1473ff78bd2fSdrh   IdList *pNew;
1474ff78bd2fSdrh   int i;
1475575fad65Sdrh   assert( db!=0 );
1476ff78bd2fSdrh   if( p==0 ) return 0;
1477575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, sizeof(*pNew) );
1478ff78bd2fSdrh   if( pNew==0 ) return 0;
14796c535158Sdrh   pNew->nId = p->nId;
1480575fad65Sdrh   pNew->a = sqlite3DbMallocRawNN(db, p->nId*sizeof(p->a[0]) );
1481d5d56523Sdanielk1977   if( pNew->a==0 ){
1482dbd6a7dcSdrh     sqlite3DbFreeNN(db, pNew);
1483d5d56523Sdanielk1977     return 0;
1484d5d56523Sdanielk1977   }
14856c535158Sdrh   /* Note that because the size of the allocation for p->a[] is not
14866c535158Sdrh   ** necessarily a power of two, sqlite3IdListAppend() may not be called
14876c535158Sdrh   ** on the duplicate created by this function. */
1488ff78bd2fSdrh   for(i=0; i<p->nId; i++){
14894efc4754Sdrh     struct IdList_item *pNewItem = &pNew->a[i];
14904efc4754Sdrh     struct IdList_item *pOldItem = &p->a[i];
149117435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
14924efc4754Sdrh     pNewItem->idx = pOldItem->idx;
1493ff78bd2fSdrh   }
1494ff78bd2fSdrh   return pNew;
1495ff78bd2fSdrh }
1496a7466205Sdan Select *sqlite3SelectDup(sqlite3 *db, Select *pDup, int flags){
1497a7466205Sdan   Select *pRet = 0;
1498a7466205Sdan   Select *pNext = 0;
1499a7466205Sdan   Select **pp = &pRet;
1500a7466205Sdan   Select *p;
1501a7466205Sdan 
1502575fad65Sdrh   assert( db!=0 );
1503a7466205Sdan   for(p=pDup; p; p=p->pPrior){
1504a7466205Sdan     Select *pNew = sqlite3DbMallocRawNN(db, sizeof(*p) );
1505a7466205Sdan     if( pNew==0 ) break;
1506b7916a78Sdrh     pNew->pEList = sqlite3ExprListDup(db, p->pEList, flags);
15076ab3a2ecSdanielk1977     pNew->pSrc = sqlite3SrcListDup(db, p->pSrc, flags);
15086ab3a2ecSdanielk1977     pNew->pWhere = sqlite3ExprDup(db, p->pWhere, flags);
15096ab3a2ecSdanielk1977     pNew->pGroupBy = sqlite3ExprListDup(db, p->pGroupBy, flags);
15106ab3a2ecSdanielk1977     pNew->pHaving = sqlite3ExprDup(db, p->pHaving, flags);
15116ab3a2ecSdanielk1977     pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, flags);
1512ff78bd2fSdrh     pNew->op = p->op;
1513a7466205Sdan     pNew->pNext = pNext;
1514a7466205Sdan     pNew->pPrior = 0;
15156ab3a2ecSdanielk1977     pNew->pLimit = sqlite3ExprDup(db, p->pLimit, flags);
151692b01d53Sdrh     pNew->iLimit = 0;
151792b01d53Sdrh     pNew->iOffset = 0;
15187d10d5a6Sdrh     pNew->selFlags = p->selFlags & ~SF_UsesEphemeral;
1519b9bb7c18Sdrh     pNew->addrOpenEphm[0] = -1;
1520b9bb7c18Sdrh     pNew->addrOpenEphm[1] = -1;
1521ec2da854Sdrh     pNew->nSelectRow = p->nSelectRow;
15224e9119d9Sdan     pNew->pWith = withDup(db, p->pWith);
152367a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
15242e362f97Sdan     pNew->pWin = 0;
1525c95f38d4Sdan     pNew->pWinDefn = sqlite3WindowListDup(db, p->pWinDefn);
15264780b9adSdan     if( p->pWin && db->mallocFailed==0 ) gatherSelectWindows(pNew);
152767a9b8edSdan #endif
1528fef37760Sdrh     pNew->selId = p->selId;
1529a7466205Sdan     *pp = pNew;
1530a7466205Sdan     pp = &pNew->pPrior;
1531a7466205Sdan     pNext = pNew;
1532a7466205Sdan   }
1533a7466205Sdan 
1534a7466205Sdan   return pRet;
1535ff78bd2fSdrh }
153693758c8dSdanielk1977 #else
15376ab3a2ecSdanielk1977 Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
153893758c8dSdanielk1977   assert( p==0 );
153993758c8dSdanielk1977   return 0;
154093758c8dSdanielk1977 }
154193758c8dSdanielk1977 #endif
1542ff78bd2fSdrh 
1543ff78bd2fSdrh 
1544ff78bd2fSdrh /*
1545a76b5dfcSdrh ** Add a new element to the end of an expression list.  If pList is
1546a76b5dfcSdrh ** initially NULL, then create a new expression list.
1547b7916a78Sdrh **
1548a19543feSdrh ** The pList argument must be either NULL or a pointer to an ExprList
1549a19543feSdrh ** obtained from a prior call to sqlite3ExprListAppend().  This routine
1550a19543feSdrh ** may not be used with an ExprList obtained from sqlite3ExprListDup().
1551a19543feSdrh ** Reason:  This routine assumes that the number of slots in pList->a[]
1552a19543feSdrh ** is a power of two.  That is true for sqlite3ExprListAppend() returns
1553a19543feSdrh ** but is not necessarily true from the return value of sqlite3ExprListDup().
1554a19543feSdrh **
1555b7916a78Sdrh ** If a memory allocation error occurs, the entire list is freed and
1556b7916a78Sdrh ** NULL is returned.  If non-NULL is returned, then it is guaranteed
1557b7916a78Sdrh ** that the new entry was successfully appended.
1558a76b5dfcSdrh */
155917435752Sdrh ExprList *sqlite3ExprListAppend(
156017435752Sdrh   Parse *pParse,          /* Parsing context */
156117435752Sdrh   ExprList *pList,        /* List to which to append. Might be NULL */
1562b7916a78Sdrh   Expr *pExpr             /* Expression to be appended. Might be NULL */
156317435752Sdrh ){
156443606175Sdrh   struct ExprList_item *pItem;
156517435752Sdrh   sqlite3 *db = pParse->db;
1566575fad65Sdrh   assert( db!=0 );
1567a76b5dfcSdrh   if( pList==0 ){
1568575fad65Sdrh     pList = sqlite3DbMallocRawNN(db, sizeof(ExprList) );
1569a76b5dfcSdrh     if( pList==0 ){
1570d5d56523Sdanielk1977       goto no_mem;
1571a76b5dfcSdrh     }
1572c263f7c4Sdrh     pList->nExpr = 0;
1573a19543feSdrh   }else if( (pList->nExpr & (pList->nExpr-1))==0 ){
157443606175Sdrh     ExprList *pNew;
157543606175Sdrh     pNew = sqlite3DbRealloc(db, pList,
15760aa3231fSdrh          sizeof(*pList)+(2*(sqlite3_int64)pList->nExpr-1)*sizeof(pList->a[0]));
157743606175Sdrh     if( pNew==0 ){
1578d5d56523Sdanielk1977       goto no_mem;
1579a76b5dfcSdrh     }
158043606175Sdrh     pList = pNew;
1581a76b5dfcSdrh   }
158243606175Sdrh   pItem = &pList->a[pList->nExpr++];
1583a8b9793cSdrh   assert( offsetof(struct ExprList_item,zName)==sizeof(pItem->pExpr) );
1584a8b9793cSdrh   assert( offsetof(struct ExprList_item,pExpr)==0 );
1585a8b9793cSdrh   memset(&pItem->zName,0,sizeof(*pItem)-offsetof(struct ExprList_item,zName));
1586e94ddc9eSdanielk1977   pItem->pExpr = pExpr;
1587a76b5dfcSdrh   return pList;
1588d5d56523Sdanielk1977 
1589d5d56523Sdanielk1977 no_mem:
1590d5d56523Sdanielk1977   /* Avoid leaking memory if malloc has failed. */
1591633e6d57Sdrh   sqlite3ExprDelete(db, pExpr);
1592633e6d57Sdrh   sqlite3ExprListDelete(db, pList);
1593d5d56523Sdanielk1977   return 0;
1594a76b5dfcSdrh }
1595a76b5dfcSdrh 
1596a76b5dfcSdrh /*
15978762ec19Sdrh ** pColumns and pExpr form a vector assignment which is part of the SET
15988762ec19Sdrh ** clause of an UPDATE statement.  Like this:
1599a1251bc4Sdrh **
1600a1251bc4Sdrh **        (a,b,c) = (expr1,expr2,expr3)
1601a1251bc4Sdrh ** Or:    (a,b,c) = (SELECT x,y,z FROM ....)
1602a1251bc4Sdrh **
1603a1251bc4Sdrh ** For each term of the vector assignment, append new entries to the
1604b67343d0Sdrh ** expression list pList.  In the case of a subquery on the RHS, append
1605a1251bc4Sdrh ** TK_SELECT_COLUMN expressions.
1606a1251bc4Sdrh */
1607a1251bc4Sdrh ExprList *sqlite3ExprListAppendVector(
1608a1251bc4Sdrh   Parse *pParse,         /* Parsing context */
1609a1251bc4Sdrh   ExprList *pList,       /* List to which to append. Might be NULL */
1610a1251bc4Sdrh   IdList *pColumns,      /* List of names of LHS of the assignment */
1611a1251bc4Sdrh   Expr *pExpr            /* Vector expression to be appended. Might be NULL */
1612a1251bc4Sdrh ){
1613a1251bc4Sdrh   sqlite3 *db = pParse->db;
1614a1251bc4Sdrh   int n;
1615a1251bc4Sdrh   int i;
161666860af3Sdrh   int iFirst = pList ? pList->nExpr : 0;
1617321e828dSdrh   /* pColumns can only be NULL due to an OOM but an OOM will cause an
1618321e828dSdrh   ** exit prior to this routine being invoked */
1619321e828dSdrh   if( NEVER(pColumns==0) ) goto vector_append_error;
1620a1251bc4Sdrh   if( pExpr==0 ) goto vector_append_error;
1621966e2911Sdrh 
1622966e2911Sdrh   /* If the RHS is a vector, then we can immediately check to see that
1623966e2911Sdrh   ** the size of the RHS and LHS match.  But if the RHS is a SELECT,
1624966e2911Sdrh   ** wildcards ("*") in the result set of the SELECT must be expanded before
1625966e2911Sdrh   ** we can do the size check, so defer the size check until code generation.
1626966e2911Sdrh   */
1627966e2911Sdrh   if( pExpr->op!=TK_SELECT && pColumns->nId!=(n=sqlite3ExprVectorSize(pExpr)) ){
1628a1251bc4Sdrh     sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
1629a1251bc4Sdrh                     pColumns->nId, n);
1630a1251bc4Sdrh     goto vector_append_error;
1631a1251bc4Sdrh   }
1632966e2911Sdrh 
1633966e2911Sdrh   for(i=0; i<pColumns->nId; i++){
1634a1251bc4Sdrh     Expr *pSubExpr = sqlite3ExprForVectorField(pParse, pExpr, i);
1635a1251bc4Sdrh     pList = sqlite3ExprListAppend(pParse, pList, pSubExpr);
1636a1251bc4Sdrh     if( pList ){
163766860af3Sdrh       assert( pList->nExpr==iFirst+i+1 );
1638a1251bc4Sdrh       pList->a[pList->nExpr-1].zName = pColumns->a[i].zName;
1639a1251bc4Sdrh       pColumns->a[i].zName = 0;
1640a1251bc4Sdrh     }
1641a1251bc4Sdrh   }
1642966e2911Sdrh 
1643ffe28059Sdrh   if( !db->mallocFailed && pExpr->op==TK_SELECT && ALWAYS(pList!=0) ){
1644966e2911Sdrh     Expr *pFirst = pList->a[iFirst].pExpr;
1645f4dd26c5Sdrh     assert( pFirst!=0 );
1646966e2911Sdrh     assert( pFirst->op==TK_SELECT_COLUMN );
1647966e2911Sdrh 
1648966e2911Sdrh     /* Store the SELECT statement in pRight so it will be deleted when
1649966e2911Sdrh     ** sqlite3ExprListDelete() is called */
1650966e2911Sdrh     pFirst->pRight = pExpr;
1651a1251bc4Sdrh     pExpr = 0;
1652966e2911Sdrh 
1653966e2911Sdrh     /* Remember the size of the LHS in iTable so that we can check that
1654966e2911Sdrh     ** the RHS and LHS sizes match during code generation. */
1655966e2911Sdrh     pFirst->iTable = pColumns->nId;
1656a1251bc4Sdrh   }
1657a1251bc4Sdrh 
1658a1251bc4Sdrh vector_append_error:
16598e34e406Sdrh   sqlite3ExprUnmapAndDelete(pParse, pExpr);
1660a1251bc4Sdrh   sqlite3IdListDelete(db, pColumns);
1661a1251bc4Sdrh   return pList;
1662a1251bc4Sdrh }
1663a1251bc4Sdrh 
1664a1251bc4Sdrh /*
1665bc622bc0Sdrh ** Set the sort order for the last element on the given ExprList.
1666bc622bc0Sdrh */
1667bc622bc0Sdrh void sqlite3ExprListSetSortOrder(ExprList *p, int iSortOrder){
1668bc622bc0Sdrh   if( p==0 ) return;
1669bc622bc0Sdrh   assert( SQLITE_SO_UNDEFINED<0 && SQLITE_SO_ASC>=0 && SQLITE_SO_DESC>0 );
1670bc622bc0Sdrh   assert( p->nExpr>0 );
1671bc622bc0Sdrh   if( iSortOrder<0 ){
1672bc622bc0Sdrh     assert( p->a[p->nExpr-1].sortOrder==SQLITE_SO_ASC );
1673bc622bc0Sdrh     return;
1674bc622bc0Sdrh   }
1675bc622bc0Sdrh   p->a[p->nExpr-1].sortOrder = (u8)iSortOrder;
1676bc622bc0Sdrh }
1677bc622bc0Sdrh 
1678bc622bc0Sdrh /*
1679b7916a78Sdrh ** Set the ExprList.a[].zName element of the most recently added item
1680b7916a78Sdrh ** on the expression list.
1681b7916a78Sdrh **
1682b7916a78Sdrh ** pList might be NULL following an OOM error.  But pName should never be
1683b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1684b7916a78Sdrh ** is set.
1685b7916a78Sdrh */
1686b7916a78Sdrh void sqlite3ExprListSetName(
1687b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1688b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
1689b7916a78Sdrh   Token *pName,           /* Name to be added */
1690b7916a78Sdrh   int dequote             /* True to cause the name to be dequoted */
1691b7916a78Sdrh ){
1692b7916a78Sdrh   assert( pList!=0 || pParse->db->mallocFailed!=0 );
1693b7916a78Sdrh   if( pList ){
1694b7916a78Sdrh     struct ExprList_item *pItem;
1695b7916a78Sdrh     assert( pList->nExpr>0 );
1696b7916a78Sdrh     pItem = &pList->a[pList->nExpr-1];
1697b7916a78Sdrh     assert( pItem->zName==0 );
1698b7916a78Sdrh     pItem->zName = sqlite3DbStrNDup(pParse->db, pName->z, pName->n);
1699244b9d6eSdrh     if( dequote ) sqlite3Dequote(pItem->zName);
1700c9461eccSdan     if( IN_RENAME_OBJECT ){
170107e95233Sdan       sqlite3RenameTokenMap(pParse, (void*)pItem->zName, pName);
17025be60c55Sdan     }
1703b7916a78Sdrh   }
1704b7916a78Sdrh }
1705b7916a78Sdrh 
1706b7916a78Sdrh /*
1707b7916a78Sdrh ** Set the ExprList.a[].zSpan element of the most recently added item
1708b7916a78Sdrh ** on the expression list.
1709b7916a78Sdrh **
1710b7916a78Sdrh ** pList might be NULL following an OOM error.  But pSpan should never be
1711b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1712b7916a78Sdrh ** is set.
1713b7916a78Sdrh */
1714b7916a78Sdrh void sqlite3ExprListSetSpan(
1715b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1716b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
17171be266baSdrh   const char *zStart,     /* Start of the span */
17181be266baSdrh   const char *zEnd        /* End of the span */
1719b7916a78Sdrh ){
1720b7916a78Sdrh   sqlite3 *db = pParse->db;
1721b7916a78Sdrh   assert( pList!=0 || db->mallocFailed!=0 );
1722b7916a78Sdrh   if( pList ){
1723b7916a78Sdrh     struct ExprList_item *pItem = &pList->a[pList->nExpr-1];
1724b7916a78Sdrh     assert( pList->nExpr>0 );
1725b7916a78Sdrh     sqlite3DbFree(db, pItem->zSpan);
17269b2e0435Sdrh     pItem->zSpan = sqlite3DbSpanDup(db, zStart, zEnd);
1727b7916a78Sdrh   }
1728b7916a78Sdrh }
1729b7916a78Sdrh 
1730b7916a78Sdrh /*
17317a15a4beSdanielk1977 ** If the expression list pEList contains more than iLimit elements,
17327a15a4beSdanielk1977 ** leave an error message in pParse.
17337a15a4beSdanielk1977 */
17347a15a4beSdanielk1977 void sqlite3ExprListCheckLength(
17357a15a4beSdanielk1977   Parse *pParse,
17367a15a4beSdanielk1977   ExprList *pEList,
17377a15a4beSdanielk1977   const char *zObject
17387a15a4beSdanielk1977 ){
1739b1a6c3c1Sdrh   int mx = pParse->db->aLimit[SQLITE_LIMIT_COLUMN];
1740c5499befSdrh   testcase( pEList && pEList->nExpr==mx );
1741c5499befSdrh   testcase( pEList && pEList->nExpr==mx+1 );
1742b1a6c3c1Sdrh   if( pEList && pEList->nExpr>mx ){
17437a15a4beSdanielk1977     sqlite3ErrorMsg(pParse, "too many columns in %s", zObject);
17447a15a4beSdanielk1977   }
17457a15a4beSdanielk1977 }
17467a15a4beSdanielk1977 
17477a15a4beSdanielk1977 /*
1748a76b5dfcSdrh ** Delete an entire expression list.
1749a76b5dfcSdrh */
1750affa855cSdrh static SQLITE_NOINLINE void exprListDeleteNN(sqlite3 *db, ExprList *pList){
1751ac48b751Sdrh   int i = pList->nExpr;
1752ac48b751Sdrh   struct ExprList_item *pItem =  pList->a;
1753ac48b751Sdrh   assert( pList->nExpr>0 );
1754ac48b751Sdrh   do{
1755633e6d57Sdrh     sqlite3ExprDelete(db, pItem->pExpr);
1756633e6d57Sdrh     sqlite3DbFree(db, pItem->zName);
1757b7916a78Sdrh     sqlite3DbFree(db, pItem->zSpan);
1758ac48b751Sdrh     pItem++;
1759ac48b751Sdrh   }while( --i>0 );
1760dbd6a7dcSdrh   sqlite3DbFreeNN(db, pList);
1761a76b5dfcSdrh }
1762affa855cSdrh void sqlite3ExprListDelete(sqlite3 *db, ExprList *pList){
1763affa855cSdrh   if( pList ) exprListDeleteNN(db, pList);
1764affa855cSdrh }
1765a76b5dfcSdrh 
1766a76b5dfcSdrh /*
17672308ed38Sdrh ** Return the bitwise-OR of all Expr.flags fields in the given
17682308ed38Sdrh ** ExprList.
1769885a5b03Sdrh */
17702308ed38Sdrh u32 sqlite3ExprListFlags(const ExprList *pList){
1771885a5b03Sdrh   int i;
17722308ed38Sdrh   u32 m = 0;
1773508e2d00Sdrh   assert( pList!=0 );
1774885a5b03Sdrh   for(i=0; i<pList->nExpr; i++){
1775d0c73053Sdrh      Expr *pExpr = pList->a[i].pExpr;
1776de845c2fSdrh      assert( pExpr!=0 );
1777de845c2fSdrh      m |= pExpr->flags;
1778885a5b03Sdrh   }
17792308ed38Sdrh   return m;
1780885a5b03Sdrh }
1781885a5b03Sdrh 
1782885a5b03Sdrh /*
17837e6f980bSdrh ** This is a SELECT-node callback for the expression walker that
17847e6f980bSdrh ** always "fails".  By "fail" in this case, we mean set
17857e6f980bSdrh ** pWalker->eCode to zero and abort.
17867e6f980bSdrh **
17877e6f980bSdrh ** This callback is used by multiple expression walkers.
17887e6f980bSdrh */
17897e6f980bSdrh int sqlite3SelectWalkFail(Walker *pWalker, Select *NotUsed){
17907e6f980bSdrh   UNUSED_PARAMETER(NotUsed);
17917e6f980bSdrh   pWalker->eCode = 0;
17927e6f980bSdrh   return WRC_Abort;
17937e6f980bSdrh }
17947e6f980bSdrh 
17957e6f980bSdrh /*
1796171d16bbSdrh ** If the input expression is an ID with the name "true" or "false"
179796acafbeSdrh ** then convert it into an TK_TRUEFALSE term.  Return non-zero if
179896acafbeSdrh ** the conversion happened, and zero if the expression is unaltered.
1799171d16bbSdrh */
1800171d16bbSdrh int sqlite3ExprIdToTrueFalse(Expr *pExpr){
1801171d16bbSdrh   assert( pExpr->op==TK_ID || pExpr->op==TK_STRING );
180251d35b0fSdrh   if( !ExprHasProperty(pExpr, EP_Quoted)
180351d35b0fSdrh    && (sqlite3StrICmp(pExpr->u.zToken, "true")==0
180451d35b0fSdrh        || sqlite3StrICmp(pExpr->u.zToken, "false")==0)
1805171d16bbSdrh   ){
1806171d16bbSdrh     pExpr->op = TK_TRUEFALSE;
1807ad31727fSdrh     ExprSetProperty(pExpr, pExpr->u.zToken[4]==0 ? EP_IsTrue : EP_IsFalse);
1808171d16bbSdrh     return 1;
1809171d16bbSdrh   }
1810171d16bbSdrh   return 0;
1811171d16bbSdrh }
1812171d16bbSdrh 
181343c4ac8bSdrh /*
181496acafbeSdrh ** The argument must be a TK_TRUEFALSE Expr node.  Return 1 if it is TRUE
181543c4ac8bSdrh ** and 0 if it is FALSE.
181643c4ac8bSdrh */
181796acafbeSdrh int sqlite3ExprTruthValue(const Expr *pExpr){
18186ece353fSdan   pExpr = sqlite3ExprSkipCollate((Expr*)pExpr);
181943c4ac8bSdrh   assert( pExpr->op==TK_TRUEFALSE );
182043c4ac8bSdrh   assert( sqlite3StrICmp(pExpr->u.zToken,"true")==0
182143c4ac8bSdrh        || sqlite3StrICmp(pExpr->u.zToken,"false")==0 );
182243c4ac8bSdrh   return pExpr->u.zToken[4]==0;
182343c4ac8bSdrh }
182443c4ac8bSdrh 
182517180fcaSdrh /*
182617180fcaSdrh ** If pExpr is an AND or OR expression, try to simplify it by eliminating
182717180fcaSdrh ** terms that are always true or false.  Return the simplified expression.
182817180fcaSdrh ** Or return the original expression if no simplification is possible.
182917180fcaSdrh **
183017180fcaSdrh ** Examples:
183117180fcaSdrh **
183217180fcaSdrh **     (x<10) AND true                =>   (x<10)
183317180fcaSdrh **     (x<10) AND false               =>   false
183417180fcaSdrh **     (x<10) AND (y=22 OR false)     =>   (x<10) AND (y=22)
183517180fcaSdrh **     (x<10) AND (y=22 OR true)      =>   (x<10)
183617180fcaSdrh **     (y=22) OR true                 =>   true
183717180fcaSdrh */
183817180fcaSdrh Expr *sqlite3ExprSimplifiedAndOr(Expr *pExpr){
183917180fcaSdrh   assert( pExpr!=0 );
184017180fcaSdrh   if( pExpr->op==TK_AND || pExpr->op==TK_OR ){
184117180fcaSdrh     Expr *pRight = sqlite3ExprSimplifiedAndOr(pExpr->pRight);
184217180fcaSdrh     Expr *pLeft = sqlite3ExprSimplifiedAndOr(pExpr->pLeft);
184317180fcaSdrh     if( ExprAlwaysTrue(pLeft) || ExprAlwaysFalse(pRight) ){
184417180fcaSdrh       pExpr = pExpr->op==TK_AND ? pRight : pLeft;
184517180fcaSdrh     }else if( ExprAlwaysTrue(pRight) || ExprAlwaysFalse(pLeft) ){
184617180fcaSdrh       pExpr = pExpr->op==TK_AND ? pLeft : pRight;
184717180fcaSdrh     }
184817180fcaSdrh   }
184917180fcaSdrh   return pExpr;
185017180fcaSdrh }
185117180fcaSdrh 
1852171d16bbSdrh 
1853171d16bbSdrh /*
1854059b2d50Sdrh ** These routines are Walker callbacks used to check expressions to
1855059b2d50Sdrh ** see if they are "constant" for some definition of constant.  The
1856059b2d50Sdrh ** Walker.eCode value determines the type of "constant" we are looking
1857059b2d50Sdrh ** for.
185873b211abSdrh **
18597d10d5a6Sdrh ** These callback routines are used to implement the following:
1860626a879aSdrh **
1861059b2d50Sdrh **     sqlite3ExprIsConstant()                  pWalker->eCode==1
1862059b2d50Sdrh **     sqlite3ExprIsConstantNotJoin()           pWalker->eCode==2
1863fcb9f4f3Sdrh **     sqlite3ExprIsTableConstant()             pWalker->eCode==3
1864059b2d50Sdrh **     sqlite3ExprIsConstantOrFunction()        pWalker->eCode==4 or 5
186587abf5c0Sdrh **
1866059b2d50Sdrh ** In all cases, the callbacks set Walker.eCode=0 and abort if the expression
1867059b2d50Sdrh ** is found to not be a constant.
186887abf5c0Sdrh **
1869feada2dfSdrh ** The sqlite3ExprIsConstantOrFunction() is used for evaluating expressions
1870059b2d50Sdrh ** in a CREATE TABLE statement.  The Walker.eCode value is 5 when parsing
1871059b2d50Sdrh ** an existing schema and 4 when processing a new statement.  A bound
1872feada2dfSdrh ** parameter raises an error for new statements, but is silently converted
1873feada2dfSdrh ** to NULL for existing schemas.  This allows sqlite_master tables that
1874feada2dfSdrh ** contain a bound parameter because they were generated by older versions
1875feada2dfSdrh ** of SQLite to be parsed by newer versions of SQLite without raising a
1876feada2dfSdrh ** malformed schema error.
1877626a879aSdrh */
18787d10d5a6Sdrh static int exprNodeIsConstant(Walker *pWalker, Expr *pExpr){
1879626a879aSdrh 
1880059b2d50Sdrh   /* If pWalker->eCode is 2 then any term of the expression that comes from
1881059b2d50Sdrh   ** the ON or USING clauses of a left join disqualifies the expression
18820a168377Sdrh   ** from being considered constant. */
1883059b2d50Sdrh   if( pWalker->eCode==2 && ExprHasProperty(pExpr, EP_FromJoin) ){
1884059b2d50Sdrh     pWalker->eCode = 0;
18857d10d5a6Sdrh     return WRC_Abort;
18860a168377Sdrh   }
18870a168377Sdrh 
1888626a879aSdrh   switch( pExpr->op ){
1889eb55bd2fSdrh     /* Consider functions to be constant if all their arguments are constant
1890059b2d50Sdrh     ** and either pWalker->eCode==4 or 5 or the function has the
1891059b2d50Sdrh     ** SQLITE_FUNC_CONST flag. */
1892eb55bd2fSdrh     case TK_FUNCTION:
189363f84573Sdrh       if( pWalker->eCode>=4 || ExprHasProperty(pExpr,EP_ConstFunc) ){
1894b1fba286Sdrh         return WRC_Continue;
1895059b2d50Sdrh       }else{
1896059b2d50Sdrh         pWalker->eCode = 0;
1897059b2d50Sdrh         return WRC_Abort;
1898b1fba286Sdrh       }
1899626a879aSdrh     case TK_ID:
1900171d16bbSdrh       /* Convert "true" or "false" in a DEFAULT clause into the
1901171d16bbSdrh       ** appropriate TK_TRUEFALSE operator */
1902e39ef31cSdrh       if( sqlite3ExprIdToTrueFalse(pExpr) ){
1903171d16bbSdrh         return WRC_Prune;
1904171d16bbSdrh       }
1905171d16bbSdrh       /* Fall thru */
1906626a879aSdrh     case TK_COLUMN:
1907626a879aSdrh     case TK_AGG_FUNCTION:
190813449892Sdrh     case TK_AGG_COLUMN:
1909c5499befSdrh       testcase( pExpr->op==TK_ID );
1910c5499befSdrh       testcase( pExpr->op==TK_COLUMN );
1911c5499befSdrh       testcase( pExpr->op==TK_AGG_FUNCTION );
1912c5499befSdrh       testcase( pExpr->op==TK_AGG_COLUMN );
191307aded63Sdrh       if( ExprHasProperty(pExpr, EP_FixedCol) && pWalker->eCode!=2 ){
1914efad2e23Sdrh         return WRC_Continue;
1915efad2e23Sdrh       }
1916059b2d50Sdrh       if( pWalker->eCode==3 && pExpr->iTable==pWalker->u.iCur ){
1917059b2d50Sdrh         return WRC_Continue;
1918f43ce0b4Sdrh       }
1919f43ce0b4Sdrh       /* Fall through */
1920f43ce0b4Sdrh     case TK_IF_NULL_ROW:
19216e341b93Sdrh     case TK_REGISTER:
19229916048bSdrh       testcase( pExpr->op==TK_REGISTER );
1923f43ce0b4Sdrh       testcase( pExpr->op==TK_IF_NULL_ROW );
1924059b2d50Sdrh       pWalker->eCode = 0;
19257d10d5a6Sdrh       return WRC_Abort;
1926feada2dfSdrh     case TK_VARIABLE:
1927059b2d50Sdrh       if( pWalker->eCode==5 ){
1928feada2dfSdrh         /* Silently convert bound parameters that appear inside of CREATE
1929feada2dfSdrh         ** statements into a NULL when parsing the CREATE statement text out
1930feada2dfSdrh         ** of the sqlite_master table */
1931feada2dfSdrh         pExpr->op = TK_NULL;
1932059b2d50Sdrh       }else if( pWalker->eCode==4 ){
1933feada2dfSdrh         /* A bound parameter in a CREATE statement that originates from
1934feada2dfSdrh         ** sqlite3_prepare() causes an error */
1935059b2d50Sdrh         pWalker->eCode = 0;
1936feada2dfSdrh         return WRC_Abort;
1937feada2dfSdrh       }
1938feada2dfSdrh       /* Fall through */
1939626a879aSdrh     default:
19406e341b93Sdrh       testcase( pExpr->op==TK_SELECT ); /* sqlite3SelectWalkFail() disallows */
19416e341b93Sdrh       testcase( pExpr->op==TK_EXISTS ); /* sqlite3SelectWalkFail() disallows */
19427d10d5a6Sdrh       return WRC_Continue;
1943626a879aSdrh   }
1944626a879aSdrh }
1945059b2d50Sdrh static int exprIsConst(Expr *p, int initFlag, int iCur){
19467d10d5a6Sdrh   Walker w;
1947059b2d50Sdrh   w.eCode = initFlag;
19487d10d5a6Sdrh   w.xExprCallback = exprNodeIsConstant;
19497e6f980bSdrh   w.xSelectCallback = sqlite3SelectWalkFail;
1950979dd1beSdrh #ifdef SQLITE_DEBUG
1951979dd1beSdrh   w.xSelectCallback2 = sqlite3SelectWalkAssert2;
1952979dd1beSdrh #endif
1953059b2d50Sdrh   w.u.iCur = iCur;
19547d10d5a6Sdrh   sqlite3WalkExpr(&w, p);
1955059b2d50Sdrh   return w.eCode;
19567d10d5a6Sdrh }
1957626a879aSdrh 
1958626a879aSdrh /*
1959059b2d50Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
1960eb55bd2fSdrh ** and 0 if it involves variables or function calls.
19612398937bSdrh **
19622398937bSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
19632398937bSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
19642398937bSdrh ** a constant.
1965fef5208cSdrh */
19664adee20fSdanielk1977 int sqlite3ExprIsConstant(Expr *p){
1967059b2d50Sdrh   return exprIsConst(p, 1, 0);
1968fef5208cSdrh }
1969fef5208cSdrh 
1970fef5208cSdrh /*
197107aded63Sdrh ** Walk an expression tree.  Return non-zero if
197207aded63Sdrh **
197307aded63Sdrh **   (1) the expression is constant, and
197407aded63Sdrh **   (2) the expression does originate in the ON or USING clause
197507aded63Sdrh **       of a LEFT JOIN, and
197607aded63Sdrh **   (3) the expression does not contain any EP_FixedCol TK_COLUMN
197707aded63Sdrh **       operands created by the constant propagation optimization.
197807aded63Sdrh **
197907aded63Sdrh ** When this routine returns true, it indicates that the expression
198007aded63Sdrh ** can be added to the pParse->pConstExpr list and evaluated once when
198107aded63Sdrh ** the prepared statement starts up.  See sqlite3ExprCodeAtInit().
19820a168377Sdrh */
19830a168377Sdrh int sqlite3ExprIsConstantNotJoin(Expr *p){
1984059b2d50Sdrh   return exprIsConst(p, 2, 0);
19850a168377Sdrh }
19860a168377Sdrh 
19870a168377Sdrh /*
1988fcb9f4f3Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
1989059b2d50Sdrh ** for any single row of the table with cursor iCur.  In other words, the
1990059b2d50Sdrh ** expression must not refer to any non-deterministic function nor any
1991059b2d50Sdrh ** table other than iCur.
1992059b2d50Sdrh */
1993059b2d50Sdrh int sqlite3ExprIsTableConstant(Expr *p, int iCur){
1994059b2d50Sdrh   return exprIsConst(p, 3, iCur);
1995059b2d50Sdrh }
1996059b2d50Sdrh 
1997ab31a845Sdan 
1998ab31a845Sdan /*
1999ab31a845Sdan ** sqlite3WalkExpr() callback used by sqlite3ExprIsConstantOrGroupBy().
2000ab31a845Sdan */
2001ab31a845Sdan static int exprNodeIsConstantOrGroupBy(Walker *pWalker, Expr *pExpr){
2002ab31a845Sdan   ExprList *pGroupBy = pWalker->u.pGroupBy;
2003ab31a845Sdan   int i;
2004ab31a845Sdan 
2005ab31a845Sdan   /* Check if pExpr is identical to any GROUP BY term. If so, consider
2006ab31a845Sdan   ** it constant.  */
2007ab31a845Sdan   for(i=0; i<pGroupBy->nExpr; i++){
2008ab31a845Sdan     Expr *p = pGroupBy->a[i].pExpr;
20095aa550cfSdan     if( sqlite3ExprCompare(0, pExpr, p, -1)<2 ){
201070efa84dSdrh       CollSeq *pColl = sqlite3ExprNNCollSeq(pWalker->pParse, p);
2011efad2e23Sdrh       if( sqlite3IsBinary(pColl) ){
2012ab31a845Sdan         return WRC_Prune;
2013ab31a845Sdan       }
2014ab31a845Sdan     }
2015ab31a845Sdan   }
2016ab31a845Sdan 
2017ab31a845Sdan   /* Check if pExpr is a sub-select. If so, consider it variable. */
2018ab31a845Sdan   if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2019ab31a845Sdan     pWalker->eCode = 0;
2020ab31a845Sdan     return WRC_Abort;
2021ab31a845Sdan   }
2022ab31a845Sdan 
2023ab31a845Sdan   return exprNodeIsConstant(pWalker, pExpr);
2024ab31a845Sdan }
2025ab31a845Sdan 
2026ab31a845Sdan /*
2027ab31a845Sdan ** Walk the expression tree passed as the first argument. Return non-zero
2028ab31a845Sdan ** if the expression consists entirely of constants or copies of terms
2029ab31a845Sdan ** in pGroupBy that sort with the BINARY collation sequence.
2030ab314001Sdrh **
2031ab314001Sdrh ** This routine is used to determine if a term of the HAVING clause can
2032ab314001Sdrh ** be promoted into the WHERE clause.  In order for such a promotion to work,
2033ab314001Sdrh ** the value of the HAVING clause term must be the same for all members of
2034ab314001Sdrh ** a "group".  The requirement that the GROUP BY term must be BINARY
2035ab314001Sdrh ** assumes that no other collating sequence will have a finer-grained
2036ab314001Sdrh ** grouping than binary.  In other words (A=B COLLATE binary) implies
2037ab314001Sdrh ** A=B in every other collating sequence.  The requirement that the
2038ab314001Sdrh ** GROUP BY be BINARY is stricter than necessary.  It would also work
2039ab314001Sdrh ** to promote HAVING clauses that use the same alternative collating
2040ab314001Sdrh ** sequence as the GROUP BY term, but that is much harder to check,
2041ab314001Sdrh ** alternative collating sequences are uncommon, and this is only an
2042ab314001Sdrh ** optimization, so we take the easy way out and simply require the
2043ab314001Sdrh ** GROUP BY to use the BINARY collating sequence.
2044ab31a845Sdan */
2045ab31a845Sdan int sqlite3ExprIsConstantOrGroupBy(Parse *pParse, Expr *p, ExprList *pGroupBy){
2046ab31a845Sdan   Walker w;
2047ab31a845Sdan   w.eCode = 1;
2048ab31a845Sdan   w.xExprCallback = exprNodeIsConstantOrGroupBy;
2049979dd1beSdrh   w.xSelectCallback = 0;
2050ab31a845Sdan   w.u.pGroupBy = pGroupBy;
2051ab31a845Sdan   w.pParse = pParse;
2052ab31a845Sdan   sqlite3WalkExpr(&w, p);
2053ab31a845Sdan   return w.eCode;
2054ab31a845Sdan }
2055ab31a845Sdan 
2056059b2d50Sdrh /*
2057059b2d50Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
2058eb55bd2fSdrh ** or a function call with constant arguments.  Return and 0 if there
2059eb55bd2fSdrh ** are any variables.
2060eb55bd2fSdrh **
2061eb55bd2fSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
2062eb55bd2fSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
2063eb55bd2fSdrh ** a constant.
2064eb55bd2fSdrh */
2065feada2dfSdrh int sqlite3ExprIsConstantOrFunction(Expr *p, u8 isInit){
2066feada2dfSdrh   assert( isInit==0 || isInit==1 );
2067059b2d50Sdrh   return exprIsConst(p, 4+isInit, 0);
2068eb55bd2fSdrh }
2069eb55bd2fSdrh 
20705b88bc4bSdrh #ifdef SQLITE_ENABLE_CURSOR_HINTS
20715b88bc4bSdrh /*
20725b88bc4bSdrh ** Walk an expression tree.  Return 1 if the expression contains a
20735b88bc4bSdrh ** subquery of some kind.  Return 0 if there are no subqueries.
20745b88bc4bSdrh */
20755b88bc4bSdrh int sqlite3ExprContainsSubquery(Expr *p){
20765b88bc4bSdrh   Walker w;
2077bec2476aSdrh   w.eCode = 1;
20785b88bc4bSdrh   w.xExprCallback = sqlite3ExprWalkNoop;
20797e6f980bSdrh   w.xSelectCallback = sqlite3SelectWalkFail;
2080979dd1beSdrh #ifdef SQLITE_DEBUG
2081979dd1beSdrh   w.xSelectCallback2 = sqlite3SelectWalkAssert2;
2082979dd1beSdrh #endif
20835b88bc4bSdrh   sqlite3WalkExpr(&w, p);
208407194bffSdrh   return w.eCode==0;
20855b88bc4bSdrh }
20865b88bc4bSdrh #endif
20875b88bc4bSdrh 
2088eb55bd2fSdrh /*
208973b211abSdrh ** If the expression p codes a constant integer that is small enough
2090202b2df7Sdrh ** to fit in a 32-bit integer, return 1 and put the value of the integer
2091202b2df7Sdrh ** in *pValue.  If the expression is not an integer or if it is too big
2092202b2df7Sdrh ** to fit in a signed 32-bit integer, return 0 and leave *pValue unchanged.
2093e4de1febSdrh */
20944adee20fSdanielk1977 int sqlite3ExprIsInteger(Expr *p, int *pValue){
209592b01d53Sdrh   int rc = 0;
20961d2d71a0Sdrh   if( NEVER(p==0) ) return 0;  /* Used to only happen following on OOM */
2097cd92e84dSdrh 
2098cd92e84dSdrh   /* If an expression is an integer literal that fits in a signed 32-bit
2099cd92e84dSdrh   ** integer, then the EP_IntValue flag will have already been set */
2100cd92e84dSdrh   assert( p->op!=TK_INTEGER || (p->flags & EP_IntValue)!=0
2101cd92e84dSdrh            || sqlite3GetInt32(p->u.zToken, &rc)==0 );
2102cd92e84dSdrh 
210392b01d53Sdrh   if( p->flags & EP_IntValue ){
210433e619fcSdrh     *pValue = p->u.iValue;
2105e4de1febSdrh     return 1;
2106e4de1febSdrh   }
210792b01d53Sdrh   switch( p->op ){
21084b59ab5eSdrh     case TK_UPLUS: {
210992b01d53Sdrh       rc = sqlite3ExprIsInteger(p->pLeft, pValue);
2110f6e369a1Sdrh       break;
21114b59ab5eSdrh     }
2112e4de1febSdrh     case TK_UMINUS: {
2113e4de1febSdrh       int v;
21144adee20fSdanielk1977       if( sqlite3ExprIsInteger(p->pLeft, &v) ){
2115f6418891Smistachkin         assert( v!=(-2147483647-1) );
2116e4de1febSdrh         *pValue = -v;
211792b01d53Sdrh         rc = 1;
2118e4de1febSdrh       }
2119e4de1febSdrh       break;
2120e4de1febSdrh     }
2121e4de1febSdrh     default: break;
2122e4de1febSdrh   }
212392b01d53Sdrh   return rc;
2124e4de1febSdrh }
2125e4de1febSdrh 
2126e4de1febSdrh /*
2127039fc32eSdrh ** Return FALSE if there is no chance that the expression can be NULL.
2128039fc32eSdrh **
2129039fc32eSdrh ** If the expression might be NULL or if the expression is too complex
2130039fc32eSdrh ** to tell return TRUE.
2131039fc32eSdrh **
2132039fc32eSdrh ** This routine is used as an optimization, to skip OP_IsNull opcodes
2133039fc32eSdrh ** when we know that a value cannot be NULL.  Hence, a false positive
2134039fc32eSdrh ** (returning TRUE when in fact the expression can never be NULL) might
2135039fc32eSdrh ** be a small performance hit but is otherwise harmless.  On the other
2136039fc32eSdrh ** hand, a false negative (returning FALSE when the result could be NULL)
2137039fc32eSdrh ** will likely result in an incorrect answer.  So when in doubt, return
2138039fc32eSdrh ** TRUE.
2139039fc32eSdrh */
2140039fc32eSdrh int sqlite3ExprCanBeNull(const Expr *p){
2141039fc32eSdrh   u8 op;
21429bfb0794Sdrh   while( p->op==TK_UPLUS || p->op==TK_UMINUS ){
21439bfb0794Sdrh     p = p->pLeft;
21449bfb0794Sdrh   }
2145039fc32eSdrh   op = p->op;
2146039fc32eSdrh   if( op==TK_REGISTER ) op = p->op2;
2147039fc32eSdrh   switch( op ){
2148039fc32eSdrh     case TK_INTEGER:
2149039fc32eSdrh     case TK_STRING:
2150039fc32eSdrh     case TK_FLOAT:
2151039fc32eSdrh     case TK_BLOB:
2152039fc32eSdrh       return 0;
21537248a8b2Sdrh     case TK_COLUMN:
215472673a24Sdrh       return ExprHasProperty(p, EP_CanBeNull) ||
2155eda079cdSdrh              p->y.pTab==0 ||  /* Reference to column of index on expression */
2156eda079cdSdrh              (p->iColumn>=0 && p->y.pTab->aCol[p->iColumn].notNull==0);
2157039fc32eSdrh     default:
2158039fc32eSdrh       return 1;
2159039fc32eSdrh   }
2160039fc32eSdrh }
2161039fc32eSdrh 
2162039fc32eSdrh /*
2163039fc32eSdrh ** Return TRUE if the given expression is a constant which would be
2164039fc32eSdrh ** unchanged by OP_Affinity with the affinity given in the second
2165039fc32eSdrh ** argument.
2166039fc32eSdrh **
2167039fc32eSdrh ** This routine is used to determine if the OP_Affinity operation
2168039fc32eSdrh ** can be omitted.  When in doubt return FALSE.  A false negative
2169039fc32eSdrh ** is harmless.  A false positive, however, can result in the wrong
2170039fc32eSdrh ** answer.
2171039fc32eSdrh */
2172039fc32eSdrh int sqlite3ExprNeedsNoAffinityChange(const Expr *p, char aff){
2173039fc32eSdrh   u8 op;
2174af866402Sdrh   int unaryMinus = 0;
217505883a34Sdrh   if( aff==SQLITE_AFF_BLOB ) return 1;
2176af866402Sdrh   while( p->op==TK_UPLUS || p->op==TK_UMINUS ){
2177af866402Sdrh     if( p->op==TK_UMINUS ) unaryMinus = 1;
2178af866402Sdrh     p = p->pLeft;
2179af866402Sdrh   }
2180039fc32eSdrh   op = p->op;
2181039fc32eSdrh   if( op==TK_REGISTER ) op = p->op2;
2182039fc32eSdrh   switch( op ){
2183039fc32eSdrh     case TK_INTEGER: {
2184039fc32eSdrh       return aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC;
2185039fc32eSdrh     }
2186039fc32eSdrh     case TK_FLOAT: {
2187039fc32eSdrh       return aff==SQLITE_AFF_REAL || aff==SQLITE_AFF_NUMERIC;
2188039fc32eSdrh     }
2189039fc32eSdrh     case TK_STRING: {
2190af866402Sdrh       return !unaryMinus && aff==SQLITE_AFF_TEXT;
2191039fc32eSdrh     }
2192039fc32eSdrh     case TK_BLOB: {
2193af866402Sdrh       return !unaryMinus;
2194039fc32eSdrh     }
21952f2855b6Sdrh     case TK_COLUMN: {
219688376ca7Sdrh       assert( p->iTable>=0 );  /* p cannot be part of a CHECK constraint */
219788376ca7Sdrh       return p->iColumn<0
21982f2855b6Sdrh           && (aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC);
21992f2855b6Sdrh     }
2200039fc32eSdrh     default: {
2201039fc32eSdrh       return 0;
2202039fc32eSdrh     }
2203039fc32eSdrh   }
2204039fc32eSdrh }
2205039fc32eSdrh 
2206039fc32eSdrh /*
2207c4a3c779Sdrh ** Return TRUE if the given string is a row-id column name.
2208c4a3c779Sdrh */
22094adee20fSdanielk1977 int sqlite3IsRowid(const char *z){
22104adee20fSdanielk1977   if( sqlite3StrICmp(z, "_ROWID_")==0 ) return 1;
22114adee20fSdanielk1977   if( sqlite3StrICmp(z, "ROWID")==0 ) return 1;
22124adee20fSdanielk1977   if( sqlite3StrICmp(z, "OID")==0 ) return 1;
2213c4a3c779Sdrh   return 0;
2214c4a3c779Sdrh }
2215c4a3c779Sdrh 
22169a96b668Sdanielk1977 /*
221769c355bdSdrh ** pX is the RHS of an IN operator.  If pX is a SELECT statement
221869c355bdSdrh ** that can be simplified to a direct table access, then return
221969c355bdSdrh ** a pointer to the SELECT statement.  If pX is not a SELECT statement,
222069c355bdSdrh ** or if the SELECT statement needs to be manifested into a transient
222169c355bdSdrh ** table, then return NULL.
2222b287f4b6Sdrh */
2223b287f4b6Sdrh #ifndef SQLITE_OMIT_SUBQUERY
22247b35a77bSdan static Select *isCandidateForInOpt(Expr *pX){
222569c355bdSdrh   Select *p;
2226b287f4b6Sdrh   SrcList *pSrc;
2227b287f4b6Sdrh   ExprList *pEList;
2228b287f4b6Sdrh   Table *pTab;
2229cfbb5e82Sdan   int i;
223069c355bdSdrh   if( !ExprHasProperty(pX, EP_xIsSelect) ) return 0;  /* Not a subquery */
223169c355bdSdrh   if( ExprHasProperty(pX, EP_VarSelect)  ) return 0;  /* Correlated subq */
223269c355bdSdrh   p = pX->x.pSelect;
2233b287f4b6Sdrh   if( p->pPrior ) return 0;              /* Not a compound SELECT */
22347d10d5a6Sdrh   if( p->selFlags & (SF_Distinct|SF_Aggregate) ){
2235b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
2236b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
22377d10d5a6Sdrh     return 0; /* No DISTINCT keyword and no aggregate functions */
22387d10d5a6Sdrh   }
2239b74b1017Sdrh   assert( p->pGroupBy==0 );              /* Has no GROUP BY clause */
2240b287f4b6Sdrh   if( p->pLimit ) return 0;              /* Has no LIMIT clause */
2241b287f4b6Sdrh   if( p->pWhere ) return 0;              /* Has no WHERE clause */
2242b287f4b6Sdrh   pSrc = p->pSrc;
2243d1fa7bcaSdrh   assert( pSrc!=0 );
2244d1fa7bcaSdrh   if( pSrc->nSrc!=1 ) return 0;          /* Single term in FROM clause */
2245b74b1017Sdrh   if( pSrc->a[0].pSelect ) return 0;     /* FROM is not a subquery or view */
2246b287f4b6Sdrh   pTab = pSrc->a[0].pTab;
224769c355bdSdrh   assert( pTab!=0 );
2248b74b1017Sdrh   assert( pTab->pSelect==0 );            /* FROM clause is not a view */
2249b287f4b6Sdrh   if( IsVirtual(pTab) ) return 0;        /* FROM clause not a virtual table */
2250b287f4b6Sdrh   pEList = p->pEList;
2251ac6b47d1Sdrh   assert( pEList!=0 );
22527b35a77bSdan   /* All SELECT results must be columns. */
2253cfbb5e82Sdan   for(i=0; i<pEList->nExpr; i++){
2254cfbb5e82Sdan     Expr *pRes = pEList->a[i].pExpr;
2255cfbb5e82Sdan     if( pRes->op!=TK_COLUMN ) return 0;
225669c355bdSdrh     assert( pRes->iTable==pSrc->a[0].iCursor );  /* Not a correlated subquery */
2257cfbb5e82Sdan   }
225869c355bdSdrh   return p;
2259b287f4b6Sdrh }
2260b287f4b6Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
2261b287f4b6Sdrh 
2262f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
22631d8cb21fSdan /*
22644c259e9fSdrh ** Generate code that checks the left-most column of index table iCur to see if
22654c259e9fSdrh ** it contains any NULL entries.  Cause the register at regHasNull to be set
22666be515ebSdrh ** to a non-NULL value if iCur contains no NULLs.  Cause register regHasNull
22676be515ebSdrh ** to be set to NULL if iCur contains one or more NULL values.
22686be515ebSdrh */
22696be515ebSdrh static void sqlite3SetHasNullFlag(Vdbe *v, int iCur, int regHasNull){
2270728e0f91Sdrh   int addr1;
22716be515ebSdrh   sqlite3VdbeAddOp2(v, OP_Integer, 0, regHasNull);
2272728e0f91Sdrh   addr1 = sqlite3VdbeAddOp1(v, OP_Rewind, iCur); VdbeCoverage(v);
22736be515ebSdrh   sqlite3VdbeAddOp3(v, OP_Column, iCur, 0, regHasNull);
22746be515ebSdrh   sqlite3VdbeChangeP5(v, OPFLAG_TYPEOFARG);
22754c259e9fSdrh   VdbeComment((v, "first_entry_in(%d)", iCur));
2276728e0f91Sdrh   sqlite3VdbeJumpHere(v, addr1);
22776be515ebSdrh }
2278f9b2e05cSdan #endif
22796be515ebSdrh 
2280bb53ecb1Sdrh 
2281bb53ecb1Sdrh #ifndef SQLITE_OMIT_SUBQUERY
2282bb53ecb1Sdrh /*
2283bb53ecb1Sdrh ** The argument is an IN operator with a list (not a subquery) on the
2284bb53ecb1Sdrh ** right-hand side.  Return TRUE if that list is constant.
2285bb53ecb1Sdrh */
2286bb53ecb1Sdrh static int sqlite3InRhsIsConstant(Expr *pIn){
2287bb53ecb1Sdrh   Expr *pLHS;
2288bb53ecb1Sdrh   int res;
2289bb53ecb1Sdrh   assert( !ExprHasProperty(pIn, EP_xIsSelect) );
2290bb53ecb1Sdrh   pLHS = pIn->pLeft;
2291bb53ecb1Sdrh   pIn->pLeft = 0;
2292bb53ecb1Sdrh   res = sqlite3ExprIsConstant(pIn);
2293bb53ecb1Sdrh   pIn->pLeft = pLHS;
2294bb53ecb1Sdrh   return res;
2295bb53ecb1Sdrh }
2296bb53ecb1Sdrh #endif
2297bb53ecb1Sdrh 
22986be515ebSdrh /*
22999a96b668Sdanielk1977 ** This function is used by the implementation of the IN (...) operator.
2300d4305ca6Sdrh ** The pX parameter is the expression on the RHS of the IN operator, which
2301d4305ca6Sdrh ** might be either a list of expressions or a subquery.
23029a96b668Sdanielk1977 **
2303d4305ca6Sdrh ** The job of this routine is to find or create a b-tree object that can
2304d4305ca6Sdrh ** be used either to test for membership in the RHS set or to iterate through
2305d4305ca6Sdrh ** all members of the RHS set, skipping duplicates.
2306d4305ca6Sdrh **
23073a85625dSdrh ** A cursor is opened on the b-tree object that is the RHS of the IN operator
2308d4305ca6Sdrh ** and pX->iTable is set to the index of that cursor.
2309d4305ca6Sdrh **
2310b74b1017Sdrh ** The returned value of this function indicates the b-tree type, as follows:
23119a96b668Sdanielk1977 **
23129a96b668Sdanielk1977 **   IN_INDEX_ROWID      - The cursor was opened on a database table.
23131ccce449Sdrh **   IN_INDEX_INDEX_ASC  - The cursor was opened on an ascending index.
23141ccce449Sdrh **   IN_INDEX_INDEX_DESC - The cursor was opened on a descending index.
23159a96b668Sdanielk1977 **   IN_INDEX_EPH        - The cursor was opened on a specially created and
23169a96b668Sdanielk1977 **                         populated epheremal table.
2317bb53ecb1Sdrh **   IN_INDEX_NOOP       - No cursor was allocated.  The IN operator must be
2318bb53ecb1Sdrh **                         implemented as a sequence of comparisons.
23199a96b668Sdanielk1977 **
2320d4305ca6Sdrh ** An existing b-tree might be used if the RHS expression pX is a simple
2321d4305ca6Sdrh ** subquery such as:
23229a96b668Sdanielk1977 **
2323553168c7Sdan **     SELECT <column1>, <column2>... FROM <table>
23249a96b668Sdanielk1977 **
2325d4305ca6Sdrh ** If the RHS of the IN operator is a list or a more complex subquery, then
2326d4305ca6Sdrh ** an ephemeral table might need to be generated from the RHS and then
232760ec914cSpeter.d.reid ** pX->iTable made to point to the ephemeral table instead of an
2328d4305ca6Sdrh ** existing table.
2329d4305ca6Sdrh **
23307fc0ba0fSdrh ** The inFlags parameter must contain, at a minimum, one of the bits
23317fc0ba0fSdrh ** IN_INDEX_MEMBERSHIP or IN_INDEX_LOOP but not both.  If inFlags contains
23327fc0ba0fSdrh ** IN_INDEX_MEMBERSHIP, then the generated table will be used for a fast
23337fc0ba0fSdrh ** membership test.  When the IN_INDEX_LOOP bit is set, the IN index will
23347fc0ba0fSdrh ** be used to loop over all values of the RHS of the IN operator.
23353a85625dSdrh **
23363a85625dSdrh ** When IN_INDEX_LOOP is used (and the b-tree will be used to iterate
23373a85625dSdrh ** through the set members) then the b-tree must not contain duplicates.
23387fc0ba0fSdrh ** An epheremal table will be created unless the selected columns are guaranteed
2339553168c7Sdan ** to be unique - either because it is an INTEGER PRIMARY KEY or due to
2340553168c7Sdan ** a UNIQUE constraint or index.
23410cdc022eSdanielk1977 **
23423a85625dSdrh ** When IN_INDEX_MEMBERSHIP is used (and the b-tree will be used
23433a85625dSdrh ** for fast set membership tests) then an epheremal table must
2344553168c7Sdan ** be used unless <columns> is a single INTEGER PRIMARY KEY column or an
2345553168c7Sdan ** index can be found with the specified <columns> as its left-most.
23460cdc022eSdanielk1977 **
2347bb53ecb1Sdrh ** If the IN_INDEX_NOOP_OK and IN_INDEX_MEMBERSHIP are both set and
2348bb53ecb1Sdrh ** if the RHS of the IN operator is a list (not a subquery) then this
2349bb53ecb1Sdrh ** routine might decide that creating an ephemeral b-tree for membership
2350bb53ecb1Sdrh ** testing is too expensive and return IN_INDEX_NOOP.  In that case, the
2351bb53ecb1Sdrh ** calling routine should implement the IN operator using a sequence
2352bb53ecb1Sdrh ** of Eq or Ne comparison operations.
2353bb53ecb1Sdrh **
2354b74b1017Sdrh ** When the b-tree is being used for membership tests, the calling function
23553a85625dSdrh ** might need to know whether or not the RHS side of the IN operator
2356e21a6e1dSdrh ** contains a NULL.  If prRhsHasNull is not a NULL pointer and
23573a85625dSdrh ** if there is any chance that the (...) might contain a NULL value at
23580cdc022eSdanielk1977 ** runtime, then a register is allocated and the register number written
2359e21a6e1dSdrh ** to *prRhsHasNull. If there is no chance that the (...) contains a
2360e21a6e1dSdrh ** NULL value, then *prRhsHasNull is left unchanged.
23610cdc022eSdanielk1977 **
2362e21a6e1dSdrh ** If a register is allocated and its location stored in *prRhsHasNull, then
23636be515ebSdrh ** the value in that register will be NULL if the b-tree contains one or more
23646be515ebSdrh ** NULL values, and it will be some non-NULL value if the b-tree contains no
23656be515ebSdrh ** NULL values.
2366553168c7Sdan **
2367553168c7Sdan ** If the aiMap parameter is not NULL, it must point to an array containing
2368553168c7Sdan ** one element for each column returned by the SELECT statement on the RHS
2369553168c7Sdan ** of the IN(...) operator. The i'th entry of the array is populated with the
2370553168c7Sdan ** offset of the index column that matches the i'th column returned by the
2371553168c7Sdan ** SELECT. For example, if the expression and selected index are:
2372553168c7Sdan **
2373553168c7Sdan **   (?,?,?) IN (SELECT a, b, c FROM t1)
2374553168c7Sdan **   CREATE INDEX i1 ON t1(b, c, a);
2375553168c7Sdan **
2376553168c7Sdan ** then aiMap[] is populated with {2, 0, 1}.
23779a96b668Sdanielk1977 */
2378284f4acaSdanielk1977 #ifndef SQLITE_OMIT_SUBQUERY
2379ba00e30aSdan int sqlite3FindInIndex(
23806fc8f364Sdrh   Parse *pParse,             /* Parsing context */
23816fc8f364Sdrh   Expr *pX,                  /* The right-hand side (RHS) of the IN operator */
23826fc8f364Sdrh   u32 inFlags,               /* IN_INDEX_LOOP, _MEMBERSHIP, and/or _NOOP_OK */
23836fc8f364Sdrh   int *prRhsHasNull,         /* Register holding NULL status.  See notes */
23842c04131cSdrh   int *aiMap,                /* Mapping from Index fields to RHS fields */
23852c04131cSdrh   int *piTab                 /* OUT: index to use */
2386ba00e30aSdan ){
2387b74b1017Sdrh   Select *p;                            /* SELECT to the right of IN operator */
2388b74b1017Sdrh   int eType = 0;                        /* Type of RHS table. IN_INDEX_* */
2389b74b1017Sdrh   int iTab = pParse->nTab++;            /* Cursor of the RHS table */
23903a85625dSdrh   int mustBeUnique;                     /* True if RHS must be unique */
2391b8475df8Sdrh   Vdbe *v = sqlite3GetVdbe(pParse);     /* Virtual machine being coded */
23929a96b668Sdanielk1977 
23931450bc6eSdrh   assert( pX->op==TK_IN );
23943a85625dSdrh   mustBeUnique = (inFlags & IN_INDEX_LOOP)!=0;
23951450bc6eSdrh 
23967b35a77bSdan   /* If the RHS of this IN(...) operator is a SELECT, and if it matters
23977b35a77bSdan   ** whether or not the SELECT result contains NULL values, check whether
2398870a0705Sdan   ** or not NULL is actually possible (it may not be, for example, due
23997b35a77bSdan   ** to NOT NULL constraints in the schema). If no NULL values are possible,
2400870a0705Sdan   ** set prRhsHasNull to 0 before continuing.  */
24017b35a77bSdan   if( prRhsHasNull && (pX->flags & EP_xIsSelect) ){
24027b35a77bSdan     int i;
24037b35a77bSdan     ExprList *pEList = pX->x.pSelect->pEList;
24047b35a77bSdan     for(i=0; i<pEList->nExpr; i++){
24057b35a77bSdan       if( sqlite3ExprCanBeNull(pEList->a[i].pExpr) ) break;
24067b35a77bSdan     }
24077b35a77bSdan     if( i==pEList->nExpr ){
24087b35a77bSdan       prRhsHasNull = 0;
24097b35a77bSdan     }
24107b35a77bSdan   }
24117b35a77bSdan 
2412b74b1017Sdrh   /* Check to see if an existing table or index can be used to
2413b74b1017Sdrh   ** satisfy the query.  This is preferable to generating a new
24147b35a77bSdan   ** ephemeral table.  */
24157b35a77bSdan   if( pParse->nErr==0 && (p = isCandidateForInOpt(pX))!=0 ){
2416e1fb65a0Sdanielk1977     sqlite3 *db = pParse->db;              /* Database connection */
2417b07028f7Sdrh     Table *pTab;                           /* Table <table>. */
2418ba00e30aSdan     i16 iDb;                               /* Database idx for pTab */
2419cfbb5e82Sdan     ExprList *pEList = p->pEList;
2420cfbb5e82Sdan     int nExpr = pEList->nExpr;
2421e1fb65a0Sdanielk1977 
2422b07028f7Sdrh     assert( p->pEList!=0 );             /* Because of isCandidateForInOpt(p) */
2423b07028f7Sdrh     assert( p->pEList->a[0].pExpr!=0 ); /* Because of isCandidateForInOpt(p) */
2424b07028f7Sdrh     assert( p->pSrc!=0 );               /* Because of isCandidateForInOpt(p) */
2425b07028f7Sdrh     pTab = p->pSrc->a[0].pTab;
2426b07028f7Sdrh 
2427b22f7c83Sdrh     /* Code an OP_Transaction and OP_TableLock for <table>. */
2428e1fb65a0Sdanielk1977     iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
2429e1fb65a0Sdanielk1977     sqlite3CodeVerifySchema(pParse, iDb);
2430e1fb65a0Sdanielk1977     sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
24319a96b668Sdanielk1977 
2432a84a283dSdrh     assert(v);  /* sqlite3GetVdbe() has always been previously called */
2433cfbb5e82Sdan     if( nExpr==1 && pEList->a[0].pExpr->iColumn<0 ){
243462659b2aSdrh       /* The "x IN (SELECT rowid FROM table)" case */
2435511f9e8dSdrh       int iAddr = sqlite3VdbeAddOp0(v, OP_Once);
24367d176105Sdrh       VdbeCoverage(v);
24379a96b668Sdanielk1977 
24389a96b668Sdanielk1977       sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
24399a96b668Sdanielk1977       eType = IN_INDEX_ROWID;
2440d8852095Sdrh       ExplainQueryPlan((pParse, 0,
2441d8852095Sdrh             "USING ROWID SEARCH ON TABLE %s FOR IN-OPERATOR",pTab->zName));
24429a96b668Sdanielk1977       sqlite3VdbeJumpHere(v, iAddr);
24439a96b668Sdanielk1977     }else{
2444e1fb65a0Sdanielk1977       Index *pIdx;                         /* Iterator variable */
2445cfbb5e82Sdan       int affinity_ok = 1;
2446cfbb5e82Sdan       int i;
2447cfbb5e82Sdan 
2448cfbb5e82Sdan       /* Check that the affinity that will be used to perform each
244962659b2aSdrh       ** comparison is the same as the affinity of each column in table
245062659b2aSdrh       ** on the RHS of the IN operator.  If it not, it is not possible to
245162659b2aSdrh       ** use any index of the RHS table.  */
2452cfbb5e82Sdan       for(i=0; i<nExpr && affinity_ok; i++){
2453fc7f27b9Sdrh         Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2454cfbb5e82Sdan         int iCol = pEList->a[i].pExpr->iColumn;
24550dfa4f6fSdrh         char idxaff = sqlite3TableColumnAffinity(pTab,iCol); /* RHS table */
2456cfbb5e82Sdan         char cmpaff = sqlite3CompareAffinity(pLhs, idxaff);
245762659b2aSdrh         testcase( cmpaff==SQLITE_AFF_BLOB );
245862659b2aSdrh         testcase( cmpaff==SQLITE_AFF_TEXT );
2459cfbb5e82Sdan         switch( cmpaff ){
2460cfbb5e82Sdan           case SQLITE_AFF_BLOB:
2461cfbb5e82Sdan             break;
2462cfbb5e82Sdan           case SQLITE_AFF_TEXT:
246362659b2aSdrh             /* sqlite3CompareAffinity() only returns TEXT if one side or the
246462659b2aSdrh             ** other has no affinity and the other side is TEXT.  Hence,
246562659b2aSdrh             ** the only way for cmpaff to be TEXT is for idxaff to be TEXT
246662659b2aSdrh             ** and for the term on the LHS of the IN to have no affinity. */
246762659b2aSdrh             assert( idxaff==SQLITE_AFF_TEXT );
2468cfbb5e82Sdan             break;
2469cfbb5e82Sdan           default:
2470cfbb5e82Sdan             affinity_ok = sqlite3IsNumericAffinity(idxaff);
2471cfbb5e82Sdan         }
2472cfbb5e82Sdan       }
2473e1fb65a0Sdanielk1977 
2474a84a283dSdrh       if( affinity_ok ){
2475a84a283dSdrh         /* Search for an existing index that will work for this IN operator */
2476a84a283dSdrh         for(pIdx=pTab->pIndex; pIdx && eType==0; pIdx=pIdx->pNext){
2477a84a283dSdrh           Bitmask colUsed;      /* Columns of the index used */
2478a84a283dSdrh           Bitmask mCol;         /* Mask for the current column */
24796fc8f364Sdrh           if( pIdx->nColumn<nExpr ) continue;
2480d4a4a361Sdrh           if( pIdx->pPartIdxWhere!=0 ) continue;
2481a84a283dSdrh           /* Maximum nColumn is BMS-2, not BMS-1, so that we can compute
2482a84a283dSdrh           ** BITMASK(nExpr) without overflowing */
2483a84a283dSdrh           testcase( pIdx->nColumn==BMS-2 );
2484a84a283dSdrh           testcase( pIdx->nColumn==BMS-1 );
2485a84a283dSdrh           if( pIdx->nColumn>=BMS-1 ) continue;
24866fc8f364Sdrh           if( mustBeUnique ){
24876fc8f364Sdrh             if( pIdx->nKeyCol>nExpr
24886fc8f364Sdrh              ||(pIdx->nColumn>nExpr && !IsUniqueIndex(pIdx))
24896fc8f364Sdrh             ){
2490a84a283dSdrh               continue;  /* This index is not unique over the IN RHS columns */
2491cfbb5e82Sdan             }
24926fc8f364Sdrh           }
2493cfbb5e82Sdan 
2494a84a283dSdrh           colUsed = 0;   /* Columns of index used so far */
2495cfbb5e82Sdan           for(i=0; i<nExpr; i++){
2496fc7f27b9Sdrh             Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2497cfbb5e82Sdan             Expr *pRhs = pEList->a[i].pExpr;
2498cfbb5e82Sdan             CollSeq *pReq = sqlite3BinaryCompareCollSeq(pParse, pLhs, pRhs);
2499cfbb5e82Sdan             int j;
2500cfbb5e82Sdan 
25016fc8f364Sdrh             assert( pReq!=0 || pRhs->iColumn==XN_ROWID || pParse->nErr );
2502cfbb5e82Sdan             for(j=0; j<nExpr; j++){
2503cfbb5e82Sdan               if( pIdx->aiColumn[j]!=pRhs->iColumn ) continue;
2504cfbb5e82Sdan               assert( pIdx->azColl[j] );
2505106526e1Sdrh               if( pReq!=0 && sqlite3StrICmp(pReq->zName, pIdx->azColl[j])!=0 ){
2506106526e1Sdrh                 continue;
2507106526e1Sdrh               }
2508cfbb5e82Sdan               break;
2509cfbb5e82Sdan             }
2510cfbb5e82Sdan             if( j==nExpr ) break;
2511a84a283dSdrh             mCol = MASKBIT(j);
2512a84a283dSdrh             if( mCol & colUsed ) break; /* Each column used only once */
2513a84a283dSdrh             colUsed |= mCol;
2514ba00e30aSdan             if( aiMap ) aiMap[i] = j;
2515cfbb5e82Sdan           }
2516cfbb5e82Sdan 
2517a84a283dSdrh           assert( i==nExpr || colUsed!=(MASKBIT(nExpr)-1) );
2518a84a283dSdrh           if( colUsed==(MASKBIT(nExpr)-1) ){
2519a84a283dSdrh             /* If we reach this point, that means the index pIdx is usable */
2520511f9e8dSdrh             int iAddr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
2521e2ca99c9Sdrh             ExplainQueryPlan((pParse, 0,
2522e2ca99c9Sdrh                               "USING INDEX %s FOR IN-OPERATOR",pIdx->zName));
25232ec2fb22Sdrh             sqlite3VdbeAddOp3(v, OP_OpenRead, iTab, pIdx->tnum, iDb);
25242ec2fb22Sdrh             sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
2525207872a4Sdanielk1977             VdbeComment((v, "%s", pIdx->zName));
25261ccce449Sdrh             assert( IN_INDEX_INDEX_DESC == IN_INDEX_INDEX_ASC+1 );
25271ccce449Sdrh             eType = IN_INDEX_INDEX_ASC + pIdx->aSortOrder[0];
25289a96b668Sdanielk1977 
25297b35a77bSdan             if( prRhsHasNull ){
25303480bfdaSdan #ifdef SQLITE_ENABLE_COLUMN_USED_MASK
2531cfbb5e82Sdan               i64 mask = (1<<nExpr)-1;
25323480bfdaSdan               sqlite3VdbeAddOp4Dup8(v, OP_ColumnsUsed,
2533cfbb5e82Sdan                   iTab, 0, 0, (u8*)&mask, P4_INT64);
25343480bfdaSdan #endif
2535b80dbdc2Sdrh               *prRhsHasNull = ++pParse->nMem;
25367b35a77bSdan               if( nExpr==1 ){
25376be515ebSdrh                 sqlite3SetHasNullFlag(v, iTab, *prRhsHasNull);
25380cdc022eSdanielk1977               }
25397b35a77bSdan             }
2540552fd454Sdrh             sqlite3VdbeJumpHere(v, iAddr);
25419a96b668Sdanielk1977           }
2542a84a283dSdrh         } /* End loop over indexes */
2543a84a283dSdrh       } /* End if( affinity_ok ) */
2544a84a283dSdrh     } /* End if not an rowid index */
2545a84a283dSdrh   } /* End attempt to optimize using an index */
25469a96b668Sdanielk1977 
2547bb53ecb1Sdrh   /* If no preexisting index is available for the IN clause
2548bb53ecb1Sdrh   ** and IN_INDEX_NOOP is an allowed reply
2549bb53ecb1Sdrh   ** and the RHS of the IN operator is a list, not a subquery
255071c57db0Sdan   ** and the RHS is not constant or has two or fewer terms,
255160ec914cSpeter.d.reid   ** then it is not worth creating an ephemeral table to evaluate
2552bb53ecb1Sdrh   ** the IN operator so return IN_INDEX_NOOP.
2553bb53ecb1Sdrh   */
2554bb53ecb1Sdrh   if( eType==0
2555bb53ecb1Sdrh    && (inFlags & IN_INDEX_NOOP_OK)
2556bb53ecb1Sdrh    && !ExprHasProperty(pX, EP_xIsSelect)
2557bb53ecb1Sdrh    && (!sqlite3InRhsIsConstant(pX) || pX->x.pList->nExpr<=2)
2558bb53ecb1Sdrh   ){
2559bb53ecb1Sdrh     eType = IN_INDEX_NOOP;
2560bb53ecb1Sdrh   }
2561bb53ecb1Sdrh 
25629a96b668Sdanielk1977   if( eType==0 ){
25634387006cSdrh     /* Could not find an existing table or index to use as the RHS b-tree.
2564b74b1017Sdrh     ** We will have to generate an ephemeral table to do the job.
2565b74b1017Sdrh     */
25668e23daf3Sdrh     u32 savedNQueryLoop = pParse->nQueryLoop;
25670cdc022eSdanielk1977     int rMayHaveNull = 0;
256841a05b7bSdanielk1977     eType = IN_INDEX_EPH;
25693a85625dSdrh     if( inFlags & IN_INDEX_LOOP ){
25704a5acf8eSdrh       pParse->nQueryLoop = 0;
2571e21a6e1dSdrh     }else if( prRhsHasNull ){
2572e21a6e1dSdrh       *prRhsHasNull = rMayHaveNull = ++pParse->nMem;
2573cf4d38aaSdrh     }
257485bcdce2Sdrh     assert( pX->op==TK_IN );
257550ef6716Sdrh     sqlite3CodeRhsOfIN(pParse, pX, iTab);
257685bcdce2Sdrh     if( rMayHaveNull ){
25772c04131cSdrh       sqlite3SetHasNullFlag(v, iTab, rMayHaveNull);
257885bcdce2Sdrh     }
2579cf4d38aaSdrh     pParse->nQueryLoop = savedNQueryLoop;
25809a96b668Sdanielk1977   }
2581ba00e30aSdan 
2582ba00e30aSdan   if( aiMap && eType!=IN_INDEX_INDEX_ASC && eType!=IN_INDEX_INDEX_DESC ){
2583ba00e30aSdan     int i, n;
2584ba00e30aSdan     n = sqlite3ExprVectorSize(pX->pLeft);
2585ba00e30aSdan     for(i=0; i<n; i++) aiMap[i] = i;
2586ba00e30aSdan   }
25872c04131cSdrh   *piTab = iTab;
25889a96b668Sdanielk1977   return eType;
25899a96b668Sdanielk1977 }
2590284f4acaSdanielk1977 #endif
2591626a879aSdrh 
2592f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
2593553168c7Sdan /*
2594553168c7Sdan ** Argument pExpr is an (?, ?...) IN(...) expression. This
2595553168c7Sdan ** function allocates and returns a nul-terminated string containing
2596553168c7Sdan ** the affinities to be used for each column of the comparison.
2597553168c7Sdan **
2598553168c7Sdan ** It is the responsibility of the caller to ensure that the returned
2599553168c7Sdan ** string is eventually freed using sqlite3DbFree().
2600553168c7Sdan */
260171c57db0Sdan static char *exprINAffinity(Parse *pParse, Expr *pExpr){
260271c57db0Sdan   Expr *pLeft = pExpr->pLeft;
260371c57db0Sdan   int nVal = sqlite3ExprVectorSize(pLeft);
2604553168c7Sdan   Select *pSelect = (pExpr->flags & EP_xIsSelect) ? pExpr->x.pSelect : 0;
260571c57db0Sdan   char *zRet;
260671c57db0Sdan 
2607553168c7Sdan   assert( pExpr->op==TK_IN );
26085c258dc1Sdrh   zRet = sqlite3DbMallocRaw(pParse->db, nVal+1);
260971c57db0Sdan   if( zRet ){
261071c57db0Sdan     int i;
261171c57db0Sdan     for(i=0; i<nVal; i++){
2612fc7f27b9Sdrh       Expr *pA = sqlite3VectorFieldSubexpr(pLeft, i);
2613553168c7Sdan       char a = sqlite3ExprAffinity(pA);
2614553168c7Sdan       if( pSelect ){
2615553168c7Sdan         zRet[i] = sqlite3CompareAffinity(pSelect->pEList->a[i].pExpr, a);
261671c57db0Sdan       }else{
2617553168c7Sdan         zRet[i] = a;
261871c57db0Sdan       }
261971c57db0Sdan     }
262071c57db0Sdan     zRet[nVal] = '\0';
262171c57db0Sdan   }
262271c57db0Sdan   return zRet;
262371c57db0Sdan }
2624f9b2e05cSdan #endif
262571c57db0Sdan 
26268da209b1Sdan #ifndef SQLITE_OMIT_SUBQUERY
26278da209b1Sdan /*
26288da209b1Sdan ** Load the Parse object passed as the first argument with an error
26298da209b1Sdan ** message of the form:
26308da209b1Sdan **
26318da209b1Sdan **   "sub-select returns N columns - expected M"
26328da209b1Sdan */
26338da209b1Sdan void sqlite3SubselectError(Parse *pParse, int nActual, int nExpect){
26348da209b1Sdan   const char *zFmt = "sub-select returns %d columns - expected %d";
26358da209b1Sdan   sqlite3ErrorMsg(pParse, zFmt, nActual, nExpect);
26368da209b1Sdan }
26378da209b1Sdan #endif
26388da209b1Sdan 
2639626a879aSdrh /*
264044c5604cSdan ** Expression pExpr is a vector that has been used in a context where
264144c5604cSdan ** it is not permitted. If pExpr is a sub-select vector, this routine
264244c5604cSdan ** loads the Parse object with a message of the form:
264344c5604cSdan **
264444c5604cSdan **   "sub-select returns N columns - expected 1"
264544c5604cSdan **
264644c5604cSdan ** Or, if it is a regular scalar vector:
264744c5604cSdan **
264844c5604cSdan **   "row value misused"
264944c5604cSdan */
265044c5604cSdan void sqlite3VectorErrorMsg(Parse *pParse, Expr *pExpr){
265144c5604cSdan #ifndef SQLITE_OMIT_SUBQUERY
265244c5604cSdan   if( pExpr->flags & EP_xIsSelect ){
265344c5604cSdan     sqlite3SubselectError(pParse, pExpr->x.pSelect->pEList->nExpr, 1);
265444c5604cSdan   }else
265544c5604cSdan #endif
265644c5604cSdan   {
265744c5604cSdan     sqlite3ErrorMsg(pParse, "row value misused");
265844c5604cSdan   }
265944c5604cSdan }
266044c5604cSdan 
266185bcdce2Sdrh #ifndef SQLITE_OMIT_SUBQUERY
266244c5604cSdan /*
266385bcdce2Sdrh ** Generate code that will construct an ephemeral table containing all terms
266485bcdce2Sdrh ** in the RHS of an IN operator.  The IN operator can be in either of two
266585bcdce2Sdrh ** forms:
2666626a879aSdrh **
26679cbe6352Sdrh **     x IN (4,5,11)              -- IN operator with list on right-hand side
26689cbe6352Sdrh **     x IN (SELECT a FROM b)     -- IN operator with subquery on the right
2669fef5208cSdrh **
26702c04131cSdrh ** The pExpr parameter is the IN operator.  The cursor number for the
26712c04131cSdrh ** constructed ephermeral table is returned.  The first time the ephemeral
26722c04131cSdrh ** table is computed, the cursor number is also stored in pExpr->iTable,
26732c04131cSdrh ** however the cursor number returned might not be the same, as it might
26742c04131cSdrh ** have been duplicated using OP_OpenDup.
267541a05b7bSdanielk1977 **
267685bcdce2Sdrh ** If the LHS expression ("x" in the examples) is a column value, or
267785bcdce2Sdrh ** the SELECT statement returns a column value, then the affinity of that
267885bcdce2Sdrh ** column is used to build the index keys. If both 'x' and the
267985bcdce2Sdrh ** SELECT... statement are columns, then numeric affinity is used
268085bcdce2Sdrh ** if either column has NUMERIC or INTEGER affinity. If neither
268185bcdce2Sdrh ** 'x' nor the SELECT... statement are columns, then numeric affinity
268285bcdce2Sdrh ** is used.
2683cce7d176Sdrh */
268485bcdce2Sdrh void sqlite3CodeRhsOfIN(
2685fd773cf9Sdrh   Parse *pParse,          /* Parsing context */
268685bcdce2Sdrh   Expr *pExpr,            /* The IN operator */
268750ef6716Sdrh   int iTab                /* Use this cursor number */
268841a05b7bSdanielk1977 ){
26892c04131cSdrh   int addrOnce = 0;           /* Address of the OP_Once instruction at top */
269085bcdce2Sdrh   int addr;                   /* Address of OP_OpenEphemeral instruction */
269185bcdce2Sdrh   Expr *pLeft;                /* the LHS of the IN operator */
269285bcdce2Sdrh   KeyInfo *pKeyInfo = 0;      /* Key information */
269385bcdce2Sdrh   int nVal;                   /* Size of vector pLeft */
269485bcdce2Sdrh   Vdbe *v;                    /* The prepared statement under construction */
2695fc976065Sdanielk1977 
26962c04131cSdrh   v = pParse->pVdbe;
269785bcdce2Sdrh   assert( v!=0 );
269885bcdce2Sdrh 
26992c04131cSdrh   /* The evaluation of the IN must be repeated every time it
270039a11819Sdrh   ** is encountered if any of the following is true:
270157dbd7b3Sdrh   **
270257dbd7b3Sdrh   **    *  The right-hand side is a correlated subquery
270357dbd7b3Sdrh   **    *  The right-hand side is an expression list containing variables
270457dbd7b3Sdrh   **    *  We are inside a trigger
270557dbd7b3Sdrh   **
27062c04131cSdrh   ** If all of the above are false, then we can compute the RHS just once
27072c04131cSdrh   ** and reuse it many names.
2708b3bce662Sdanielk1977   */
2709efb699fcSdrh   if( !ExprHasProperty(pExpr, EP_VarSelect) && pParse->iSelfTab==0 ){
27102c04131cSdrh     /* Reuse of the RHS is allowed */
27112c04131cSdrh     /* If this routine has already been coded, but the previous code
27122c04131cSdrh     ** might not have been invoked yet, so invoke it now as a subroutine.
27132c04131cSdrh     */
27142c04131cSdrh     if( ExprHasProperty(pExpr, EP_Subrtn) ){
2715f9231c34Sdrh       addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
2716bd462bccSdrh       if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2717bd462bccSdrh         ExplainQueryPlan((pParse, 0, "REUSE LIST SUBQUERY %d",
2718bd462bccSdrh               pExpr->x.pSelect->selId));
2719bd462bccSdrh       }
27202c04131cSdrh       sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
27212c04131cSdrh                         pExpr->y.sub.iAddr);
27222c04131cSdrh       sqlite3VdbeAddOp2(v, OP_OpenDup, iTab, pExpr->iTable);
2723f9231c34Sdrh       sqlite3VdbeJumpHere(v, addrOnce);
27242c04131cSdrh       return;
27252c04131cSdrh     }
27262c04131cSdrh 
27272c04131cSdrh     /* Begin coding the subroutine */
27282c04131cSdrh     ExprSetProperty(pExpr, EP_Subrtn);
27292c04131cSdrh     pExpr->y.sub.regReturn = ++pParse->nMem;
27302c04131cSdrh     pExpr->y.sub.iAddr =
27312c04131cSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 0, pExpr->y.sub.regReturn) + 1;
27322c04131cSdrh     VdbeComment((v, "return address"));
27332c04131cSdrh 
27342c04131cSdrh     addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
2735b3bce662Sdanielk1977   }
2736b3bce662Sdanielk1977 
273785bcdce2Sdrh   /* Check to see if this is a vector IN operator */
273885bcdce2Sdrh   pLeft = pExpr->pLeft;
273971c57db0Sdan   nVal = sqlite3ExprVectorSize(pLeft);
2740e014a838Sdanielk1977 
274185bcdce2Sdrh   /* Construct the ephemeral table that will contain the content of
274285bcdce2Sdrh   ** RHS of the IN operator.
2743fef5208cSdrh   */
27442c04131cSdrh   pExpr->iTable = iTab;
274550ef6716Sdrh   addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, pExpr->iTable, nVal);
27462c04131cSdrh #ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
27472c04131cSdrh   if( ExprHasProperty(pExpr, EP_xIsSelect) ){
27482c04131cSdrh     VdbeComment((v, "Result of SELECT %u", pExpr->x.pSelect->selId));
27492c04131cSdrh   }else{
27502c04131cSdrh     VdbeComment((v, "RHS of IN operator"));
27512c04131cSdrh   }
27522c04131cSdrh #endif
275350ef6716Sdrh   pKeyInfo = sqlite3KeyInfoAlloc(pParse->db, nVal, 1);
2754e014a838Sdanielk1977 
27556ab3a2ecSdanielk1977   if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2756e014a838Sdanielk1977     /* Case 1:     expr IN (SELECT ...)
2757e014a838Sdanielk1977     **
2758e014a838Sdanielk1977     ** Generate code to write the results of the select into the temporary
2759e014a838Sdanielk1977     ** table allocated and opened above.
2760e014a838Sdanielk1977     */
27614387006cSdrh     Select *pSelect = pExpr->x.pSelect;
276271c57db0Sdan     ExprList *pEList = pSelect->pEList;
27631013c932Sdrh 
27642c04131cSdrh     ExplainQueryPlan((pParse, 1, "%sLIST SUBQUERY %d",
27652c04131cSdrh         addrOnce?"":"CORRELATED ", pSelect->selId
2766e2ca99c9Sdrh     ));
276764bcb8cfSdrh     /* If the LHS and RHS of the IN operator do not match, that
276864bcb8cfSdrh     ** error will have been caught long before we reach this point. */
276964bcb8cfSdrh     if( ALWAYS(pEList->nExpr==nVal) ){
277071c57db0Sdan       SelectDest dest;
277171c57db0Sdan       int i;
2772bd462bccSdrh       sqlite3SelectDestInit(&dest, SRT_Set, iTab);
277371c57db0Sdan       dest.zAffSdst = exprINAffinity(pParse, pExpr);
27744387006cSdrh       pSelect->iLimit = 0;
27754387006cSdrh       testcase( pSelect->selFlags & SF_Distinct );
2776812ea833Sdrh       testcase( pKeyInfo==0 ); /* Caused by OOM in sqlite3KeyInfoAlloc() */
27774387006cSdrh       if( sqlite3Select(pParse, pSelect, &dest) ){
277871c57db0Sdan         sqlite3DbFree(pParse->db, dest.zAffSdst);
27792ec2fb22Sdrh         sqlite3KeyInfoUnref(pKeyInfo);
278085bcdce2Sdrh         return;
278194ccde58Sdrh       }
278271c57db0Sdan       sqlite3DbFree(pParse->db, dest.zAffSdst);
2783812ea833Sdrh       assert( pKeyInfo!=0 ); /* OOM will cause exit after sqlite3Select() */
27843535ec3eSdrh       assert( pEList!=0 );
27853535ec3eSdrh       assert( pEList->nExpr>0 );
27862ec2fb22Sdrh       assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
278771c57db0Sdan       for(i=0; i<nVal; i++){
2788773d3afaSdan         Expr *p = sqlite3VectorFieldSubexpr(pLeft, i);
278971c57db0Sdan         pKeyInfo->aColl[i] = sqlite3BinaryCompareCollSeq(
279071c57db0Sdan             pParse, p, pEList->a[i].pExpr
279171c57db0Sdan         );
279271c57db0Sdan       }
279371c57db0Sdan     }
2794a7d2db17Sdrh   }else if( ALWAYS(pExpr->x.pList!=0) ){
2795fef5208cSdrh     /* Case 2:     expr IN (exprlist)
2796fef5208cSdrh     **
2797e014a838Sdanielk1977     ** For each expression, build an index key from the evaluation and
2798e014a838Sdanielk1977     ** store it in the temporary table. If <expr> is a column, then use
2799e014a838Sdanielk1977     ** that columns affinity when building index keys. If <expr> is not
2800e014a838Sdanielk1977     ** a column, use numeric affinity.
2801fef5208cSdrh     */
280271c57db0Sdan     char affinity;            /* Affinity of the LHS of the IN */
2803e014a838Sdanielk1977     int i;
28046ab3a2ecSdanielk1977     ExprList *pList = pExpr->x.pList;
280557dbd7b3Sdrh     struct ExprList_item *pItem;
2806c324d446Sdan     int r1, r2;
280771c57db0Sdan     affinity = sqlite3ExprAffinity(pLeft);
280896fb16eeSdrh     if( affinity<=SQLITE_AFF_NONE ){
280905883a34Sdrh       affinity = SQLITE_AFF_BLOB;
2810e014a838Sdanielk1977     }
2811323df790Sdrh     if( pKeyInfo ){
28122ec2fb22Sdrh       assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
2813323df790Sdrh       pKeyInfo->aColl[0] = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
2814323df790Sdrh     }
2815e014a838Sdanielk1977 
2816e014a838Sdanielk1977     /* Loop through each expression in <exprlist>. */
28172d401ab8Sdrh     r1 = sqlite3GetTempReg(pParse);
28182d401ab8Sdrh     r2 = sqlite3GetTempReg(pParse);
281957dbd7b3Sdrh     for(i=pList->nExpr, pItem=pList->a; i>0; i--, pItem++){
282057dbd7b3Sdrh       Expr *pE2 = pItem->pExpr;
2821e014a838Sdanielk1977 
282257dbd7b3Sdrh       /* If the expression is not constant then we will need to
282357dbd7b3Sdrh       ** disable the test that was generated above that makes sure
282457dbd7b3Sdrh       ** this code only executes once.  Because for a non-constant
282557dbd7b3Sdrh       ** expression we need to rerun this code each time.
282657dbd7b3Sdrh       */
28272c04131cSdrh       if( addrOnce && !sqlite3ExprIsConstant(pE2) ){
28282c04131cSdrh         sqlite3VdbeChangeToNoop(v, addrOnce);
28297ac0e562Sdan         ExprClearProperty(pExpr, EP_Subrtn);
28302c04131cSdrh         addrOnce = 0;
28314794b980Sdrh       }
2832e014a838Sdanielk1977 
2833e014a838Sdanielk1977       /* Evaluate the expression and insert it into the temp table */
2834c324d446Sdan       sqlite3ExprCode(pParse, pE2, r1);
2835c324d446Sdan       sqlite3VdbeAddOp4(v, OP_MakeRecord, r1, 1, r2, &affinity, 1);
2836c324d446Sdan       sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iTab, r2, r1, 1);
2837fef5208cSdrh     }
28382d401ab8Sdrh     sqlite3ReleaseTempReg(pParse, r1);
28392d401ab8Sdrh     sqlite3ReleaseTempReg(pParse, r2);
2840fef5208cSdrh   }
2841323df790Sdrh   if( pKeyInfo ){
28422ec2fb22Sdrh     sqlite3VdbeChangeP4(v, addr, (void *)pKeyInfo, P4_KEYINFO);
284341a05b7bSdanielk1977   }
28442c04131cSdrh   if( addrOnce ){
28452c04131cSdrh     sqlite3VdbeJumpHere(v, addrOnce);
28462c04131cSdrh     /* Subroutine return */
28472c04131cSdrh     sqlite3VdbeAddOp1(v, OP_Return, pExpr->y.sub.regReturn);
28482c04131cSdrh     sqlite3VdbeChangeP1(v, pExpr->y.sub.iAddr-1, sqlite3VdbeCurrentAddr(v)-1);
284985bcdce2Sdrh   }
285085bcdce2Sdrh }
285185bcdce2Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
285285bcdce2Sdrh 
285385bcdce2Sdrh /*
285485bcdce2Sdrh ** Generate code for scalar subqueries used as a subquery expression
285585bcdce2Sdrh ** or EXISTS operator:
285685bcdce2Sdrh **
285785bcdce2Sdrh **     (SELECT a FROM b)          -- subquery
285885bcdce2Sdrh **     EXISTS (SELECT a FROM b)   -- EXISTS subquery
285985bcdce2Sdrh **
286085bcdce2Sdrh ** The pExpr parameter is the SELECT or EXISTS operator to be coded.
286185bcdce2Sdrh **
2862*d86fe44aSdrh ** Return the register that holds the result.  For a multi-column SELECT,
286385bcdce2Sdrh ** the result is stored in a contiguous array of registers and the
286485bcdce2Sdrh ** return value is the register of the left-most result column.
286585bcdce2Sdrh ** Return 0 if an error occurs.
286685bcdce2Sdrh */
286785bcdce2Sdrh #ifndef SQLITE_OMIT_SUBQUERY
286885bcdce2Sdrh int sqlite3CodeSubselect(Parse *pParse, Expr *pExpr){
28692c04131cSdrh   int addrOnce = 0;           /* Address of OP_Once at top of subroutine */
287085bcdce2Sdrh   int rReg = 0;               /* Register storing resulting */
287185bcdce2Sdrh   Select *pSel;               /* SELECT statement to encode */
287285bcdce2Sdrh   SelectDest dest;            /* How to deal with SELECT result */
287385bcdce2Sdrh   int nReg;                   /* Registers to allocate */
287485bcdce2Sdrh   Expr *pLimit;               /* New limit expression */
28752c04131cSdrh 
28762c04131cSdrh   Vdbe *v = pParse->pVdbe;
287785bcdce2Sdrh   assert( v!=0 );
2878bd462bccSdrh   testcase( pExpr->op==TK_EXISTS );
2879bd462bccSdrh   testcase( pExpr->op==TK_SELECT );
2880bd462bccSdrh   assert( pExpr->op==TK_EXISTS || pExpr->op==TK_SELECT );
2881bd462bccSdrh   assert( ExprHasProperty(pExpr, EP_xIsSelect) );
2882bd462bccSdrh   pSel = pExpr->x.pSelect;
288385bcdce2Sdrh 
28845198ff57Sdrh   /* The evaluation of the EXISTS/SELECT must be repeated every time it
288585bcdce2Sdrh   ** is encountered if any of the following is true:
288685bcdce2Sdrh   **
288785bcdce2Sdrh   **    *  The right-hand side is a correlated subquery
288885bcdce2Sdrh   **    *  The right-hand side is an expression list containing variables
288985bcdce2Sdrh   **    *  We are inside a trigger
289085bcdce2Sdrh   **
289185bcdce2Sdrh   ** If all of the above are false, then we can run this code just once
289285bcdce2Sdrh   ** save the results, and reuse the same result on subsequent invocations.
289385bcdce2Sdrh   */
289485bcdce2Sdrh   if( !ExprHasProperty(pExpr, EP_VarSelect) ){
28955198ff57Sdrh     /* If this routine has already been coded, then invoke it as a
28965198ff57Sdrh     ** subroutine. */
28975198ff57Sdrh     if( ExprHasProperty(pExpr, EP_Subrtn) ){
2898bd462bccSdrh       ExplainQueryPlan((pParse, 0, "REUSE SUBQUERY %d", pSel->selId));
28995198ff57Sdrh       sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
29005198ff57Sdrh                         pExpr->y.sub.iAddr);
29015198ff57Sdrh       return pExpr->iTable;
29025198ff57Sdrh     }
29035198ff57Sdrh 
29045198ff57Sdrh     /* Begin coding the subroutine */
29055198ff57Sdrh     ExprSetProperty(pExpr, EP_Subrtn);
29065198ff57Sdrh     pExpr->y.sub.regReturn = ++pParse->nMem;
29075198ff57Sdrh     pExpr->y.sub.iAddr =
29085198ff57Sdrh       sqlite3VdbeAddOp2(v, OP_Integer, 0, pExpr->y.sub.regReturn) + 1;
29095198ff57Sdrh     VdbeComment((v, "return address"));
29105198ff57Sdrh 
29112c04131cSdrh     addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
2912fef5208cSdrh   }
2913fef5208cSdrh 
291485bcdce2Sdrh   /* For a SELECT, generate code to put the values for all columns of
291539a11819Sdrh   ** the first row into an array of registers and return the index of
291639a11819Sdrh   ** the first register.
291739a11819Sdrh   **
291839a11819Sdrh   ** If this is an EXISTS, write an integer 0 (not exists) or 1 (exists)
291939a11819Sdrh   ** into a register and return that register number.
292039a11819Sdrh   **
292139a11819Sdrh   ** In both cases, the query is augmented with "LIMIT 1".  Any
292239a11819Sdrh   ** preexisting limit is discarded in place of the new LIMIT 1.
2923fef5208cSdrh   */
2924bd462bccSdrh   ExplainQueryPlan((pParse, 1, "%sSCALAR SUBQUERY %d",
2925bd462bccSdrh         addrOnce?"":"CORRELATED ", pSel->selId));
292671c57db0Sdan   nReg = pExpr->op==TK_SELECT ? pSel->pEList->nExpr : 1;
292771c57db0Sdan   sqlite3SelectDestInit(&dest, 0, pParse->nMem+1);
292871c57db0Sdan   pParse->nMem += nReg;
292951522cd3Sdrh   if( pExpr->op==TK_SELECT ){
29306c8c8ce0Sdanielk1977     dest.eDest = SRT_Mem;
293153932ce8Sdrh     dest.iSdst = dest.iSDParm;
293271c57db0Sdan     dest.nSdst = nReg;
293371c57db0Sdan     sqlite3VdbeAddOp3(v, OP_Null, 0, dest.iSDParm, dest.iSDParm+nReg-1);
2934d4e70ebdSdrh     VdbeComment((v, "Init subquery result"));
293551522cd3Sdrh   }else{
29366c8c8ce0Sdanielk1977     dest.eDest = SRT_Exists;
29372b596da8Sdrh     sqlite3VdbeAddOp2(v, OP_Integer, 0, dest.iSDParm);
2938d4e70ebdSdrh     VdbeComment((v, "Init EXISTS result"));
293951522cd3Sdrh   }
29408c0833fbSdrh   pLimit = sqlite3ExprAlloc(pParse->db, TK_INTEGER,&sqlite3IntTokens[1], 0);
29418c0833fbSdrh   if( pSel->pLimit ){
29428c0833fbSdrh     sqlite3ExprDelete(pParse->db, pSel->pLimit->pLeft);
29438c0833fbSdrh     pSel->pLimit->pLeft = pLimit;
29448c0833fbSdrh   }else{
29458c0833fbSdrh     pSel->pLimit = sqlite3PExpr(pParse, TK_LIMIT, pLimit, 0);
29468c0833fbSdrh   }
294748b5b041Sdrh   pSel->iLimit = 0;
29487d10d5a6Sdrh   if( sqlite3Select(pParse, pSel, &dest) ){
29491450bc6eSdrh     return 0;
295094ccde58Sdrh   }
29512c04131cSdrh   pExpr->iTable = rReg = dest.iSDParm;
2952ebb6a65dSdrh   ExprSetVVAProperty(pExpr, EP_NoReduce);
29532c04131cSdrh   if( addrOnce ){
29542c04131cSdrh     sqlite3VdbeJumpHere(v, addrOnce);
2955fc976065Sdanielk1977 
29562c04131cSdrh     /* Subroutine return */
29572c04131cSdrh     sqlite3VdbeAddOp1(v, OP_Return, pExpr->y.sub.regReturn);
29582c04131cSdrh     sqlite3VdbeChangeP1(v, pExpr->y.sub.iAddr-1, sqlite3VdbeCurrentAddr(v)-1);
29595198ff57Sdrh   }
29602c04131cSdrh 
29611450bc6eSdrh   return rReg;
2962cce7d176Sdrh }
296351522cd3Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
2964cce7d176Sdrh 
2965e3365e6cSdrh #ifndef SQLITE_OMIT_SUBQUERY
2966e3365e6cSdrh /*
29677b35a77bSdan ** Expr pIn is an IN(...) expression. This function checks that the
29687b35a77bSdan ** sub-select on the RHS of the IN() operator has the same number of
29697b35a77bSdan ** columns as the vector on the LHS. Or, if the RHS of the IN() is not
29707b35a77bSdan ** a sub-query, that the LHS is a vector of size 1.
29717b35a77bSdan */
29727b35a77bSdan int sqlite3ExprCheckIN(Parse *pParse, Expr *pIn){
29737b35a77bSdan   int nVector = sqlite3ExprVectorSize(pIn->pLeft);
29747b35a77bSdan   if( (pIn->flags & EP_xIsSelect) ){
29757b35a77bSdan     if( nVector!=pIn->x.pSelect->pEList->nExpr ){
29767b35a77bSdan       sqlite3SubselectError(pParse, pIn->x.pSelect->pEList->nExpr, nVector);
29777b35a77bSdan       return 1;
29787b35a77bSdan     }
29797b35a77bSdan   }else if( nVector!=1 ){
298044c5604cSdan     sqlite3VectorErrorMsg(pParse, pIn->pLeft);
29817b35a77bSdan     return 1;
29827b35a77bSdan   }
29837b35a77bSdan   return 0;
29847b35a77bSdan }
29857b35a77bSdan #endif
29867b35a77bSdan 
29877b35a77bSdan #ifndef SQLITE_OMIT_SUBQUERY
29887b35a77bSdan /*
2989e3365e6cSdrh ** Generate code for an IN expression.
2990e3365e6cSdrh **
2991e3365e6cSdrh **      x IN (SELECT ...)
2992e3365e6cSdrh **      x IN (value, value, ...)
2993e3365e6cSdrh **
2994ecb87ac8Sdrh ** The left-hand side (LHS) is a scalar or vector expression.  The
2995e347d3e8Sdrh ** right-hand side (RHS) is an array of zero or more scalar values, or a
2996e347d3e8Sdrh ** subquery.  If the RHS is a subquery, the number of result columns must
2997e347d3e8Sdrh ** match the number of columns in the vector on the LHS.  If the RHS is
2998e347d3e8Sdrh ** a list of values, the LHS must be a scalar.
2999e347d3e8Sdrh **
3000e347d3e8Sdrh ** The IN operator is true if the LHS value is contained within the RHS.
3001e347d3e8Sdrh ** The result is false if the LHS is definitely not in the RHS.  The
3002e347d3e8Sdrh ** result is NULL if the presence of the LHS in the RHS cannot be
3003e347d3e8Sdrh ** determined due to NULLs.
3004e3365e6cSdrh **
30056be515ebSdrh ** This routine generates code that jumps to destIfFalse if the LHS is not
3006e3365e6cSdrh ** contained within the RHS.  If due to NULLs we cannot determine if the LHS
3007e3365e6cSdrh ** is contained in the RHS then jump to destIfNull.  If the LHS is contained
3008e3365e6cSdrh ** within the RHS then fall through.
3009ecb87ac8Sdrh **
3010ecb87ac8Sdrh ** See the separate in-operator.md documentation file in the canonical
3011ecb87ac8Sdrh ** SQLite source tree for additional information.
3012e3365e6cSdrh */
3013e3365e6cSdrh static void sqlite3ExprCodeIN(
3014e3365e6cSdrh   Parse *pParse,        /* Parsing and code generating context */
3015e3365e6cSdrh   Expr *pExpr,          /* The IN expression */
3016e3365e6cSdrh   int destIfFalse,      /* Jump here if LHS is not contained in the RHS */
3017e3365e6cSdrh   int destIfNull        /* Jump here if the results are unknown due to NULLs */
3018e3365e6cSdrh ){
3019e3365e6cSdrh   int rRhsHasNull = 0;  /* Register that is true if RHS contains NULL values */
3020e3365e6cSdrh   int eType;            /* Type of the RHS */
3021e347d3e8Sdrh   int rLhs;             /* Register(s) holding the LHS values */
3022e347d3e8Sdrh   int rLhsOrig;         /* LHS values prior to reordering by aiMap[] */
3023e3365e6cSdrh   Vdbe *v;              /* Statement under construction */
3024ba00e30aSdan   int *aiMap = 0;       /* Map from vector field to index column */
3025ba00e30aSdan   char *zAff = 0;       /* Affinity string for comparisons */
3026ecb87ac8Sdrh   int nVector;          /* Size of vectors for this IN operator */
302712abf408Sdrh   int iDummy;           /* Dummy parameter to exprCodeVector() */
3028e347d3e8Sdrh   Expr *pLeft;          /* The LHS of the IN operator */
3029ecb87ac8Sdrh   int i;                /* loop counter */
3030e347d3e8Sdrh   int destStep2;        /* Where to jump when NULLs seen in step 2 */
3031e347d3e8Sdrh   int destStep6 = 0;    /* Start of code for Step 6 */
3032e347d3e8Sdrh   int addrTruthOp;      /* Address of opcode that determines the IN is true */
3033e347d3e8Sdrh   int destNotNull;      /* Jump here if a comparison is not true in step 6 */
3034e347d3e8Sdrh   int addrTop;          /* Top of the step-6 loop */
30352c04131cSdrh   int iTab = 0;         /* Index to use */
3036e3365e6cSdrh 
3037e347d3e8Sdrh   pLeft = pExpr->pLeft;
30387b35a77bSdan   if( sqlite3ExprCheckIN(pParse, pExpr) ) return;
3039553168c7Sdan   zAff = exprINAffinity(pParse, pExpr);
3040ba00e30aSdan   nVector = sqlite3ExprVectorSize(pExpr->pLeft);
3041ba00e30aSdan   aiMap = (int*)sqlite3DbMallocZero(
3042ba00e30aSdan       pParse->db, nVector*(sizeof(int) + sizeof(char)) + 1
3043ba00e30aSdan   );
3044e347d3e8Sdrh   if( pParse->db->mallocFailed ) goto sqlite3ExprCodeIN_oom_error;
30457b35a77bSdan 
3046ba00e30aSdan   /* Attempt to compute the RHS. After this step, if anything other than
30472c04131cSdrh   ** IN_INDEX_NOOP is returned, the table opened with cursor iTab
3048ba00e30aSdan   ** contains the values that make up the RHS. If IN_INDEX_NOOP is returned,
3049ba00e30aSdan   ** the RHS has not yet been coded.  */
3050e3365e6cSdrh   v = pParse->pVdbe;
3051e3365e6cSdrh   assert( v!=0 );       /* OOM detected prior to this routine */
3052e3365e6cSdrh   VdbeNoopComment((v, "begin IN expr"));
3053bb53ecb1Sdrh   eType = sqlite3FindInIndex(pParse, pExpr,
3054bb53ecb1Sdrh                              IN_INDEX_MEMBERSHIP | IN_INDEX_NOOP_OK,
30552c04131cSdrh                              destIfFalse==destIfNull ? 0 : &rRhsHasNull,
30562c04131cSdrh                              aiMap, &iTab);
3057e3365e6cSdrh 
3058ba00e30aSdan   assert( pParse->nErr || nVector==1 || eType==IN_INDEX_EPH
3059ba00e30aSdan        || eType==IN_INDEX_INDEX_ASC || eType==IN_INDEX_INDEX_DESC
3060ba00e30aSdan   );
3061ecb87ac8Sdrh #ifdef SQLITE_DEBUG
3062ecb87ac8Sdrh   /* Confirm that aiMap[] contains nVector integer values between 0 and
3063ecb87ac8Sdrh   ** nVector-1. */
3064ecb87ac8Sdrh   for(i=0; i<nVector; i++){
3065ecb87ac8Sdrh     int j, cnt;
3066ecb87ac8Sdrh     for(cnt=j=0; j<nVector; j++) if( aiMap[j]==i ) cnt++;
3067ecb87ac8Sdrh     assert( cnt==1 );
3068ecb87ac8Sdrh   }
3069ecb87ac8Sdrh #endif
3070e3365e6cSdrh 
3071ba00e30aSdan   /* Code the LHS, the <expr> from "<expr> IN (...)". If the LHS is a
3072ba00e30aSdan   ** vector, then it is stored in an array of nVector registers starting
3073ba00e30aSdan   ** at r1.
3074e347d3e8Sdrh   **
3075e347d3e8Sdrh   ** sqlite3FindInIndex() might have reordered the fields of the LHS vector
3076e347d3e8Sdrh   ** so that the fields are in the same order as an existing index.   The
3077e347d3e8Sdrh   ** aiMap[] array contains a mapping from the original LHS field order to
3078e347d3e8Sdrh   ** the field order that matches the RHS index.
3079e3365e6cSdrh   */
3080e347d3e8Sdrh   rLhsOrig = exprCodeVector(pParse, pLeft, &iDummy);
3081e347d3e8Sdrh   for(i=0; i<nVector && aiMap[i]==i; i++){} /* Are LHS fields reordered? */
3082ecb87ac8Sdrh   if( i==nVector ){
3083e347d3e8Sdrh     /* LHS fields are not reordered */
3084e347d3e8Sdrh     rLhs = rLhsOrig;
3085ecb87ac8Sdrh   }else{
3086ecb87ac8Sdrh     /* Need to reorder the LHS fields according to aiMap */
3087e347d3e8Sdrh     rLhs = sqlite3GetTempRange(pParse, nVector);
3088ba00e30aSdan     for(i=0; i<nVector; i++){
3089e347d3e8Sdrh       sqlite3VdbeAddOp3(v, OP_Copy, rLhsOrig+i, rLhs+aiMap[i], 0);
3090ba00e30aSdan     }
3091ecb87ac8Sdrh   }
3092e3365e6cSdrh 
3093bb53ecb1Sdrh   /* If sqlite3FindInIndex() did not find or create an index that is
3094bb53ecb1Sdrh   ** suitable for evaluating the IN operator, then evaluate using a
3095bb53ecb1Sdrh   ** sequence of comparisons.
3096e347d3e8Sdrh   **
3097e347d3e8Sdrh   ** This is step (1) in the in-operator.md optimized algorithm.
3098bb53ecb1Sdrh   */
3099bb53ecb1Sdrh   if( eType==IN_INDEX_NOOP ){
3100bb53ecb1Sdrh     ExprList *pList = pExpr->x.pList;
3101bb53ecb1Sdrh     CollSeq *pColl = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
3102ec4ccdbcSdrh     int labelOk = sqlite3VdbeMakeLabel(pParse);
3103bb53ecb1Sdrh     int r2, regToFree;
3104bb53ecb1Sdrh     int regCkNull = 0;
3105bb53ecb1Sdrh     int ii;
3106bb53ecb1Sdrh     assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
3107bb53ecb1Sdrh     if( destIfNull!=destIfFalse ){
3108bb53ecb1Sdrh       regCkNull = sqlite3GetTempReg(pParse);
3109e347d3e8Sdrh       sqlite3VdbeAddOp3(v, OP_BitAnd, rLhs, rLhs, regCkNull);
3110bb53ecb1Sdrh     }
3111bb53ecb1Sdrh     for(ii=0; ii<pList->nExpr; ii++){
3112bb53ecb1Sdrh       r2 = sqlite3ExprCodeTemp(pParse, pList->a[ii].pExpr, &regToFree);
3113a976979bSdrh       if( regCkNull && sqlite3ExprCanBeNull(pList->a[ii].pExpr) ){
3114bb53ecb1Sdrh         sqlite3VdbeAddOp3(v, OP_BitAnd, regCkNull, r2, regCkNull);
3115bb53ecb1Sdrh       }
3116bb53ecb1Sdrh       if( ii<pList->nExpr-1 || destIfNull!=destIfFalse ){
3117e347d3e8Sdrh         sqlite3VdbeAddOp4(v, OP_Eq, rLhs, labelOk, r2,
31184336b0e6Sdrh                           (void*)pColl, P4_COLLSEQ);
31194336b0e6Sdrh         VdbeCoverageIf(v, ii<pList->nExpr-1);
31204336b0e6Sdrh         VdbeCoverageIf(v, ii==pList->nExpr-1);
3121ba00e30aSdan         sqlite3VdbeChangeP5(v, zAff[0]);
3122bb53ecb1Sdrh       }else{
3123bb53ecb1Sdrh         assert( destIfNull==destIfFalse );
3124e347d3e8Sdrh         sqlite3VdbeAddOp4(v, OP_Ne, rLhs, destIfFalse, r2,
3125bb53ecb1Sdrh                           (void*)pColl, P4_COLLSEQ); VdbeCoverage(v);
3126ba00e30aSdan         sqlite3VdbeChangeP5(v, zAff[0] | SQLITE_JUMPIFNULL);
3127bb53ecb1Sdrh       }
3128bb53ecb1Sdrh       sqlite3ReleaseTempReg(pParse, regToFree);
3129bb53ecb1Sdrh     }
3130bb53ecb1Sdrh     if( regCkNull ){
3131bb53ecb1Sdrh       sqlite3VdbeAddOp2(v, OP_IsNull, regCkNull, destIfNull); VdbeCoverage(v);
3132076e85f5Sdrh       sqlite3VdbeGoto(v, destIfFalse);
3133bb53ecb1Sdrh     }
3134bb53ecb1Sdrh     sqlite3VdbeResolveLabel(v, labelOk);
3135bb53ecb1Sdrh     sqlite3ReleaseTempReg(pParse, regCkNull);
3136e347d3e8Sdrh     goto sqlite3ExprCodeIN_finished;
3137e347d3e8Sdrh   }
3138bb53ecb1Sdrh 
3139e347d3e8Sdrh   /* Step 2: Check to see if the LHS contains any NULL columns.  If the
3140e347d3e8Sdrh   ** LHS does contain NULLs then the result must be either FALSE or NULL.
3141e347d3e8Sdrh   ** We will then skip the binary search of the RHS.
3142e347d3e8Sdrh   */
3143094430ebSdrh   if( destIfNull==destIfFalse ){
3144e347d3e8Sdrh     destStep2 = destIfFalse;
3145e347d3e8Sdrh   }else{
3146ec4ccdbcSdrh     destStep2 = destStep6 = sqlite3VdbeMakeLabel(pParse);
3147e347d3e8Sdrh   }
3148d49fd4e8Sdan   for(i=0; i<nVector; i++){
3149fc7f27b9Sdrh     Expr *p = sqlite3VectorFieldSubexpr(pExpr->pLeft, i);
3150d49fd4e8Sdan     if( sqlite3ExprCanBeNull(p) ){
3151e347d3e8Sdrh       sqlite3VdbeAddOp2(v, OP_IsNull, rLhs+i, destStep2);
3152471b4b92Sdrh       VdbeCoverage(v);
3153d49fd4e8Sdan     }
3154d49fd4e8Sdan   }
3155e3365e6cSdrh 
3156e347d3e8Sdrh   /* Step 3.  The LHS is now known to be non-NULL.  Do the binary search
3157e347d3e8Sdrh   ** of the RHS using the LHS as a probe.  If found, the result is
3158e347d3e8Sdrh   ** true.
3159e347d3e8Sdrh   */
3160e3365e6cSdrh   if( eType==IN_INDEX_ROWID ){
3161e347d3e8Sdrh     /* In this case, the RHS is the ROWID of table b-tree and so we also
3162e347d3e8Sdrh     ** know that the RHS is non-NULL.  Hence, we combine steps 3 and 4
3163e347d3e8Sdrh     ** into a single opcode. */
31642c04131cSdrh     sqlite3VdbeAddOp3(v, OP_SeekRowid, iTab, destIfFalse, rLhs);
3165688852abSdrh     VdbeCoverage(v);
3166e347d3e8Sdrh     addrTruthOp = sqlite3VdbeAddOp0(v, OP_Goto);  /* Return True */
31677b35a77bSdan   }else{
3168e347d3e8Sdrh     sqlite3VdbeAddOp4(v, OP_Affinity, rLhs, nVector, 0, zAff, nVector);
3169e347d3e8Sdrh     if( destIfFalse==destIfNull ){
3170e347d3e8Sdrh       /* Combine Step 3 and Step 5 into a single opcode */
31712c04131cSdrh       sqlite3VdbeAddOp4Int(v, OP_NotFound, iTab, destIfFalse,
3172e347d3e8Sdrh                            rLhs, nVector); VdbeCoverage(v);
3173e347d3e8Sdrh       goto sqlite3ExprCodeIN_finished;
3174e347d3e8Sdrh     }
3175e347d3e8Sdrh     /* Ordinary Step 3, for the case where FALSE and NULL are distinct */
31762c04131cSdrh     addrTruthOp = sqlite3VdbeAddOp4Int(v, OP_Found, iTab, 0,
3177e347d3e8Sdrh                                       rLhs, nVector); VdbeCoverage(v);
3178e347d3e8Sdrh   }
3179ba00e30aSdan 
3180e347d3e8Sdrh   /* Step 4.  If the RHS is known to be non-NULL and we did not find
3181e347d3e8Sdrh   ** an match on the search above, then the result must be FALSE.
3182e347d3e8Sdrh   */
3183e347d3e8Sdrh   if( rRhsHasNull && nVector==1 ){
3184e347d3e8Sdrh     sqlite3VdbeAddOp2(v, OP_NotNull, rRhsHasNull, destIfFalse);
3185471b4b92Sdrh     VdbeCoverage(v);
3186e347d3e8Sdrh   }
31877b35a77bSdan 
3188e347d3e8Sdrh   /* Step 5.  If we do not care about the difference between NULL and
3189e347d3e8Sdrh   ** FALSE, then just return false.
3190e347d3e8Sdrh   */
3191e347d3e8Sdrh   if( destIfFalse==destIfNull ) sqlite3VdbeGoto(v, destIfFalse);
3192e347d3e8Sdrh 
3193e347d3e8Sdrh   /* Step 6: Loop through rows of the RHS.  Compare each row to the LHS.
3194e347d3e8Sdrh   ** If any comparison is NULL, then the result is NULL.  If all
3195e347d3e8Sdrh   ** comparisons are FALSE then the final result is FALSE.
3196e347d3e8Sdrh   **
3197e347d3e8Sdrh   ** For a scalar LHS, it is sufficient to check just the first row
3198e347d3e8Sdrh   ** of the RHS.
3199e347d3e8Sdrh   */
3200e347d3e8Sdrh   if( destStep6 ) sqlite3VdbeResolveLabel(v, destStep6);
32012c04131cSdrh   addrTop = sqlite3VdbeAddOp2(v, OP_Rewind, iTab, destIfFalse);
3202471b4b92Sdrh   VdbeCoverage(v);
3203e347d3e8Sdrh   if( nVector>1 ){
3204ec4ccdbcSdrh     destNotNull = sqlite3VdbeMakeLabel(pParse);
3205e347d3e8Sdrh   }else{
3206e347d3e8Sdrh     /* For nVector==1, combine steps 6 and 7 by immediately returning
3207e347d3e8Sdrh     ** FALSE if the first comparison is not NULL */
3208e347d3e8Sdrh     destNotNull = destIfFalse;
3209e347d3e8Sdrh   }
3210ba00e30aSdan   for(i=0; i<nVector; i++){
3211ba00e30aSdan     Expr *p;
3212ba00e30aSdan     CollSeq *pColl;
3213e347d3e8Sdrh     int r3 = sqlite3GetTempReg(pParse);
3214fc7f27b9Sdrh     p = sqlite3VectorFieldSubexpr(pLeft, i);
3215ba00e30aSdan     pColl = sqlite3ExprCollSeq(pParse, p);
32162c04131cSdrh     sqlite3VdbeAddOp3(v, OP_Column, iTab, i, r3);
3217e347d3e8Sdrh     sqlite3VdbeAddOp4(v, OP_Ne, rLhs+i, destNotNull, r3,
321818016ad2Sdrh                       (void*)pColl, P4_COLLSEQ);
3219471b4b92Sdrh     VdbeCoverage(v);
3220e347d3e8Sdrh     sqlite3ReleaseTempReg(pParse, r3);
32217b35a77bSdan   }
32227b35a77bSdan   sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfNull);
3223e347d3e8Sdrh   if( nVector>1 ){
3224e347d3e8Sdrh     sqlite3VdbeResolveLabel(v, destNotNull);
32252c04131cSdrh     sqlite3VdbeAddOp2(v, OP_Next, iTab, addrTop+1);
322618016ad2Sdrh     VdbeCoverage(v);
3227e347d3e8Sdrh 
3228e347d3e8Sdrh     /* Step 7:  If we reach this point, we know that the result must
3229e347d3e8Sdrh     ** be false. */
323018016ad2Sdrh     sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfFalse);
32317b35a77bSdan   }
32327b35a77bSdan 
3233e347d3e8Sdrh   /* Jumps here in order to return true. */
3234e347d3e8Sdrh   sqlite3VdbeJumpHere(v, addrTruthOp);
3235e3365e6cSdrh 
3236e347d3e8Sdrh sqlite3ExprCodeIN_finished:
3237e347d3e8Sdrh   if( rLhs!=rLhsOrig ) sqlite3ReleaseTempReg(pParse, rLhs);
3238ecb87ac8Sdrh   VdbeComment((v, "end IN expr"));
3239e347d3e8Sdrh sqlite3ExprCodeIN_oom_error:
3240ba00e30aSdan   sqlite3DbFree(pParse->db, aiMap);
3241553168c7Sdan   sqlite3DbFree(pParse->db, zAff);
3242e3365e6cSdrh }
3243e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
3244e3365e6cSdrh 
324513573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
3246598f1340Sdrh /*
3247598f1340Sdrh ** Generate an instruction that will put the floating point
32489cbf3425Sdrh ** value described by z[0..n-1] into register iMem.
32490cf19ed8Sdrh **
32500cf19ed8Sdrh ** The z[] string will probably not be zero-terminated.  But the
32510cf19ed8Sdrh ** z[n] character is guaranteed to be something that does not look
32520cf19ed8Sdrh ** like the continuation of the number.
3253598f1340Sdrh */
3254b7916a78Sdrh static void codeReal(Vdbe *v, const char *z, int negateFlag, int iMem){
3255fd773cf9Sdrh   if( ALWAYS(z!=0) ){
3256598f1340Sdrh     double value;
32579339da1fSdrh     sqlite3AtoF(z, &value, sqlite3Strlen30(z), SQLITE_UTF8);
3258d0015161Sdrh     assert( !sqlite3IsNaN(value) ); /* The new AtoF never returns NaN */
3259598f1340Sdrh     if( negateFlag ) value = -value;
326097bae794Sdrh     sqlite3VdbeAddOp4Dup8(v, OP_Real, 0, iMem, 0, (u8*)&value, P4_REAL);
3261598f1340Sdrh   }
3262598f1340Sdrh }
326313573c71Sdrh #endif
3264598f1340Sdrh 
3265598f1340Sdrh 
3266598f1340Sdrh /*
3267fec19aadSdrh ** Generate an instruction that will put the integer describe by
32689cbf3425Sdrh ** text z[0..n-1] into register iMem.
32690cf19ed8Sdrh **
32705f1d6b61Sshaneh ** Expr.u.zToken is always UTF8 and zero-terminated.
3271fec19aadSdrh */
327213573c71Sdrh static void codeInteger(Parse *pParse, Expr *pExpr, int negFlag, int iMem){
327313573c71Sdrh   Vdbe *v = pParse->pVdbe;
327492b01d53Sdrh   if( pExpr->flags & EP_IntValue ){
327533e619fcSdrh     int i = pExpr->u.iValue;
3276d50ffc41Sdrh     assert( i>=0 );
327792b01d53Sdrh     if( negFlag ) i = -i;
327892b01d53Sdrh     sqlite3VdbeAddOp2(v, OP_Integer, i, iMem);
3279fd773cf9Sdrh   }else{
32805f1d6b61Sshaneh     int c;
32815f1d6b61Sshaneh     i64 value;
3282fd773cf9Sdrh     const char *z = pExpr->u.zToken;
3283fd773cf9Sdrh     assert( z!=0 );
32849296c18aSdrh     c = sqlite3DecOrHexToI64(z, &value);
328584d4f1a3Sdrh     if( (c==3 && !negFlag) || (c==2) || (negFlag && value==SMALLEST_INT64)){
328613573c71Sdrh #ifdef SQLITE_OMIT_FLOATING_POINT
328713573c71Sdrh       sqlite3ErrorMsg(pParse, "oversized integer: %s%s", negFlag ? "-" : "", z);
328813573c71Sdrh #else
32891b7ddc59Sdrh #ifndef SQLITE_OMIT_HEX_INTEGER
32909296c18aSdrh       if( sqlite3_strnicmp(z,"0x",2)==0 ){
329177320ea4Sdrh         sqlite3ErrorMsg(pParse, "hex literal too big: %s%s", negFlag?"-":"",z);
32921b7ddc59Sdrh       }else
32931b7ddc59Sdrh #endif
32941b7ddc59Sdrh       {
3295b7916a78Sdrh         codeReal(v, z, negFlag, iMem);
32969296c18aSdrh       }
329713573c71Sdrh #endif
329877320ea4Sdrh     }else{
329984d4f1a3Sdrh       if( negFlag ){ value = c==3 ? SMALLEST_INT64 : -value; }
330077320ea4Sdrh       sqlite3VdbeAddOp4Dup8(v, OP_Int64, 0, iMem, 0, (u8*)&value, P4_INT64);
3301fec19aadSdrh     }
3302fec19aadSdrh   }
3303c9cf901dSdanielk1977 }
3304fec19aadSdrh 
33055cd79239Sdrh 
33061f9ca2c8Sdrh /* Generate code that will load into register regOut a value that is
33071f9ca2c8Sdrh ** appropriate for the iIdxCol-th column of index pIdx.
33081f9ca2c8Sdrh */
33091f9ca2c8Sdrh void sqlite3ExprCodeLoadIndexColumn(
33101f9ca2c8Sdrh   Parse *pParse,  /* The parsing context */
33111f9ca2c8Sdrh   Index *pIdx,    /* The index whose column is to be loaded */
33121f9ca2c8Sdrh   int iTabCur,    /* Cursor pointing to a table row */
33131f9ca2c8Sdrh   int iIdxCol,    /* The column of the index to be loaded */
33141f9ca2c8Sdrh   int regOut      /* Store the index column value in this register */
33151f9ca2c8Sdrh ){
33161f9ca2c8Sdrh   i16 iTabCol = pIdx->aiColumn[iIdxCol];
33174b92f98cSdrh   if( iTabCol==XN_EXPR ){
33181f9ca2c8Sdrh     assert( pIdx->aColExpr );
33191f9ca2c8Sdrh     assert( pIdx->aColExpr->nExpr>iIdxCol );
33203e34eabcSdrh     pParse->iSelfTab = iTabCur + 1;
33211c75c9d7Sdrh     sqlite3ExprCodeCopy(pParse, pIdx->aColExpr->a[iIdxCol].pExpr, regOut);
33223e34eabcSdrh     pParse->iSelfTab = 0;
33234b92f98cSdrh   }else{
33244b92f98cSdrh     sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pIdx->pTable, iTabCur,
33254b92f98cSdrh                                     iTabCol, regOut);
33264b92f98cSdrh   }
33271f9ca2c8Sdrh }
33281f9ca2c8Sdrh 
33295cd79239Sdrh /*
33305c092e8aSdrh ** Generate code to extract the value of the iCol-th column of a table.
33315c092e8aSdrh */
33325c092e8aSdrh void sqlite3ExprCodeGetColumnOfTable(
33335c092e8aSdrh   Vdbe *v,        /* The VDBE under construction */
33345c092e8aSdrh   Table *pTab,    /* The table containing the value */
3335313619f5Sdrh   int iTabCur,    /* The table cursor.  Or the PK cursor for WITHOUT ROWID */
33365c092e8aSdrh   int iCol,       /* Index of the column to extract */
3337313619f5Sdrh   int regOut      /* Extract the value into this register */
33385c092e8aSdrh ){
3339aca19e19Sdrh   if( pTab==0 ){
3340aca19e19Sdrh     sqlite3VdbeAddOp3(v, OP_Column, iTabCur, iCol, regOut);
3341aca19e19Sdrh     return;
3342aca19e19Sdrh   }
33435c092e8aSdrh   if( iCol<0 || iCol==pTab->iPKey ){
33445c092e8aSdrh     sqlite3VdbeAddOp2(v, OP_Rowid, iTabCur, regOut);
33455c092e8aSdrh   }else{
33465c092e8aSdrh     int op = IsVirtual(pTab) ? OP_VColumn : OP_Column;
3347ee0ec8e1Sdrh     int x = iCol;
334835db31b2Sdrh     if( !HasRowid(pTab) && !IsVirtual(pTab) ){
3349ee0ec8e1Sdrh       x = sqlite3ColumnOfIndex(sqlite3PrimaryKeyIndex(pTab), iCol);
3350ee0ec8e1Sdrh     }
3351ee0ec8e1Sdrh     sqlite3VdbeAddOp3(v, op, iTabCur, x, regOut);
33525c092e8aSdrh   }
33535c092e8aSdrh   if( iCol>=0 ){
33545c092e8aSdrh     sqlite3ColumnDefault(v, pTab, iCol, regOut);
33555c092e8aSdrh   }
33565c092e8aSdrh }
33575c092e8aSdrh 
33585c092e8aSdrh /*
3359945498f3Sdrh ** Generate code that will extract the iColumn-th column from
33608c607191Sdrh ** table pTab and store the column value in register iReg.
3361e55cbd72Sdrh **
3362e55cbd72Sdrh ** There must be an open cursor to pTab in iTable when this routine
3363e55cbd72Sdrh ** is called.  If iColumn<0 then code is generated that extracts the rowid.
3364945498f3Sdrh */
3365e55cbd72Sdrh int sqlite3ExprCodeGetColumn(
3366e55cbd72Sdrh   Parse *pParse,   /* Parsing and code generating context */
33672133d822Sdrh   Table *pTab,     /* Description of the table we are reading from */
33682133d822Sdrh   int iColumn,     /* Index of the table column */
33692133d822Sdrh   int iTable,      /* The cursor pointing to the table */
3370a748fdccSdrh   int iReg,        /* Store results here */
3371ce78bc6eSdrh   u8 p5            /* P5 value for OP_Column + FLAGS */
33722133d822Sdrh ){
3373e55cbd72Sdrh   Vdbe *v = pParse->pVdbe;
3374e55cbd72Sdrh   assert( v!=0 );
33755c092e8aSdrh   sqlite3ExprCodeGetColumnOfTable(v, pTab, iTable, iColumn, iReg);
3376a748fdccSdrh   if( p5 ){
3377a748fdccSdrh     sqlite3VdbeChangeP5(v, p5);
3378a748fdccSdrh   }
3379e55cbd72Sdrh   return iReg;
3380e55cbd72Sdrh }
3381e55cbd72Sdrh 
3382e55cbd72Sdrh /*
3383b21e7c70Sdrh ** Generate code to move content from registers iFrom...iFrom+nReg-1
338436a5d88dSdrh ** over to iTo..iTo+nReg-1.
3385e55cbd72Sdrh */
3386b21e7c70Sdrh void sqlite3ExprCodeMove(Parse *pParse, int iFrom, int iTo, int nReg){
3387e8e4af76Sdrh   assert( iFrom>=iTo+nReg || iFrom+nReg<=iTo );
3388079a3072Sdrh   sqlite3VdbeAddOp3(pParse->pVdbe, OP_Move, iFrom, iTo, nReg);
3389945498f3Sdrh }
3390945498f3Sdrh 
3391652fbf55Sdrh /*
339212abf408Sdrh ** Convert a scalar expression node to a TK_REGISTER referencing
339312abf408Sdrh ** register iReg.  The caller must ensure that iReg already contains
339412abf408Sdrh ** the correct value for the expression.
3395a4c3c87eSdrh */
3396069d1b1fSdan static void exprToRegister(Expr *pExpr, int iReg){
33970d950af3Sdrh   Expr *p = sqlite3ExprSkipCollateAndLikely(pExpr);
3398a4c3c87eSdrh   p->op2 = p->op;
3399a4c3c87eSdrh   p->op = TK_REGISTER;
3400a4c3c87eSdrh   p->iTable = iReg;
3401a4c3c87eSdrh   ExprClearProperty(p, EP_Skip);
3402a4c3c87eSdrh }
3403a4c3c87eSdrh 
340412abf408Sdrh /*
340512abf408Sdrh ** Evaluate an expression (either a vector or a scalar expression) and store
340612abf408Sdrh ** the result in continguous temporary registers.  Return the index of
340712abf408Sdrh ** the first register used to store the result.
340812abf408Sdrh **
340912abf408Sdrh ** If the returned result register is a temporary scalar, then also write
341012abf408Sdrh ** that register number into *piFreeable.  If the returned result register
341112abf408Sdrh ** is not a temporary or if the expression is a vector set *piFreeable
341212abf408Sdrh ** to 0.
341312abf408Sdrh */
341412abf408Sdrh static int exprCodeVector(Parse *pParse, Expr *p, int *piFreeable){
341512abf408Sdrh   int iResult;
341612abf408Sdrh   int nResult = sqlite3ExprVectorSize(p);
341712abf408Sdrh   if( nResult==1 ){
341812abf408Sdrh     iResult = sqlite3ExprCodeTemp(pParse, p, piFreeable);
341912abf408Sdrh   }else{
342012abf408Sdrh     *piFreeable = 0;
342112abf408Sdrh     if( p->op==TK_SELECT ){
3422dd1bb43aSdrh #if SQLITE_OMIT_SUBQUERY
3423dd1bb43aSdrh       iResult = 0;
3424dd1bb43aSdrh #else
342585bcdce2Sdrh       iResult = sqlite3CodeSubselect(pParse, p);
3426dd1bb43aSdrh #endif
342712abf408Sdrh     }else{
342812abf408Sdrh       int i;
342912abf408Sdrh       iResult = pParse->nMem+1;
343012abf408Sdrh       pParse->nMem += nResult;
343112abf408Sdrh       for(i=0; i<nResult; i++){
34324b725240Sdan         sqlite3ExprCodeFactorable(pParse, p->x.pList->a[i].pExpr, i+iResult);
343312abf408Sdrh       }
343412abf408Sdrh     }
343512abf408Sdrh   }
343612abf408Sdrh   return iResult;
343712abf408Sdrh }
343812abf408Sdrh 
343971c57db0Sdan 
3440a4c3c87eSdrh /*
3441cce7d176Sdrh ** Generate code into the current Vdbe to evaluate the given
34422dcef11bSdrh ** expression.  Attempt to store the results in register "target".
34432dcef11bSdrh ** Return the register where results are stored.
3444389a1adbSdrh **
34458b213899Sdrh ** With this routine, there is no guarantee that results will
34462dcef11bSdrh ** be stored in target.  The result might be stored in some other
34472dcef11bSdrh ** register if it is convenient to do so.  The calling function
34482dcef11bSdrh ** must check the return code and move the results to the desired
34492dcef11bSdrh ** register.
3450cce7d176Sdrh */
3451678ccce8Sdrh int sqlite3ExprCodeTarget(Parse *pParse, Expr *pExpr, int target){
34522dcef11bSdrh   Vdbe *v = pParse->pVdbe;  /* The VM under construction */
34532dcef11bSdrh   int op;                   /* The opcode being coded */
34542dcef11bSdrh   int inReg = target;       /* Results stored in register inReg */
34552dcef11bSdrh   int regFree1 = 0;         /* If non-zero free this temporary register */
34562dcef11bSdrh   int regFree2 = 0;         /* If non-zero free this temporary register */
34577b35a77bSdan   int r1, r2;               /* Various register numbers */
345810d1edf0Sdrh   Expr tempX;               /* Temporary expression node */
345971c57db0Sdan   int p5 = 0;
3460ffe07b2dSdrh 
34619cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
346220411ea7Sdrh   if( v==0 ){
346320411ea7Sdrh     assert( pParse->db->mallocFailed );
346420411ea7Sdrh     return 0;
346520411ea7Sdrh   }
3466389a1adbSdrh 
34671efa8023Sdrh expr_code_doover:
3468389a1adbSdrh   if( pExpr==0 ){
3469389a1adbSdrh     op = TK_NULL;
3470389a1adbSdrh   }else{
3471f2bc013cSdrh     op = pExpr->op;
3472389a1adbSdrh   }
3473f2bc013cSdrh   switch( op ){
347413449892Sdrh     case TK_AGG_COLUMN: {
347513449892Sdrh       AggInfo *pAggInfo = pExpr->pAggInfo;
347613449892Sdrh       struct AggInfo_col *pCol = &pAggInfo->aCol[pExpr->iAgg];
347713449892Sdrh       if( !pAggInfo->directMode ){
34789de221dfSdrh         assert( pCol->iMem>0 );
3479c332cc30Sdrh         return pCol->iMem;
348013449892Sdrh       }else if( pAggInfo->useSortingIdx ){
34815134d135Sdan         sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdxPTab,
3482389a1adbSdrh                               pCol->iSorterColumn, target);
3483c332cc30Sdrh         return target;
348413449892Sdrh       }
348513449892Sdrh       /* Otherwise, fall thru into the TK_COLUMN case */
348613449892Sdrh     }
3487967e8b73Sdrh     case TK_COLUMN: {
3488b2b9d3d7Sdrh       int iTab = pExpr->iTable;
3489efad2e23Sdrh       if( ExprHasProperty(pExpr, EP_FixedCol) ){
3490d98f5324Sdrh         /* This COLUMN expression is really a constant due to WHERE clause
3491d98f5324Sdrh         ** constraints, and that constant is coded by the pExpr->pLeft
3492d98f5324Sdrh         ** expresssion.  However, make sure the constant has the correct
3493d98f5324Sdrh         ** datatype by applying the Affinity of the table column to the
3494d98f5324Sdrh         ** constant.
3495d98f5324Sdrh         */
3496d98f5324Sdrh         int iReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft,target);
3497eda079cdSdrh         int aff = sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
349896fb16eeSdrh         if( aff>SQLITE_AFF_BLOB ){
3499d98f5324Sdrh           static const char zAff[] = "B\000C\000D\000E";
3500d98f5324Sdrh           assert( SQLITE_AFF_BLOB=='A' );
3501d98f5324Sdrh           assert( SQLITE_AFF_TEXT=='B' );
3502d98f5324Sdrh           if( iReg!=target ){
3503d98f5324Sdrh             sqlite3VdbeAddOp2(v, OP_SCopy, iReg, target);
3504d98f5324Sdrh             iReg = target;
3505d98f5324Sdrh           }
3506d98f5324Sdrh           sqlite3VdbeAddOp4(v, OP_Affinity, iReg, 1, 0,
3507d98f5324Sdrh                             &zAff[(aff-'B')*2], P4_STATIC);
3508d98f5324Sdrh         }
3509d98f5324Sdrh         return iReg;
3510efad2e23Sdrh       }
3511b2b9d3d7Sdrh       if( iTab<0 ){
35126e97f8ecSdrh         if( pParse->iSelfTab<0 ){
3513b2b9d3d7Sdrh           /* Generating CHECK constraints or inserting into partial index */
35146e97f8ecSdrh           return pExpr->iColumn - pParse->iSelfTab;
3515c4a3c779Sdrh         }else{
35161f9ca2c8Sdrh           /* Coding an expression that is part of an index where column names
35171f9ca2c8Sdrh           ** in the index refer to the table to which the index belongs */
35183e34eabcSdrh           iTab = pParse->iSelfTab - 1;
35192282792aSdrh         }
3520b2b9d3d7Sdrh       }
3521eda079cdSdrh       return sqlite3ExprCodeGetColumn(pParse, pExpr->y.pTab,
3522b2b9d3d7Sdrh                                pExpr->iColumn, iTab, target,
3523b2b9d3d7Sdrh                                pExpr->op2);
3524cce7d176Sdrh     }
3525cce7d176Sdrh     case TK_INTEGER: {
352613573c71Sdrh       codeInteger(pParse, pExpr, 0, target);
3527c332cc30Sdrh       return target;
352851e9a445Sdrh     }
35298abed7b9Sdrh     case TK_TRUEFALSE: {
353096acafbeSdrh       sqlite3VdbeAddOp2(v, OP_Integer, sqlite3ExprTruthValue(pExpr), target);
3531007c843bSdrh       return target;
3532007c843bSdrh     }
353313573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
3534598f1340Sdrh     case TK_FLOAT: {
353533e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
353633e619fcSdrh       codeReal(v, pExpr->u.zToken, 0, target);
3537c332cc30Sdrh       return target;
3538598f1340Sdrh     }
353913573c71Sdrh #endif
3540fec19aadSdrh     case TK_STRING: {
354133e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
3542076e85f5Sdrh       sqlite3VdbeLoadString(v, target, pExpr->u.zToken);
3543c332cc30Sdrh       return target;
3544cce7d176Sdrh     }
3545f0863fe5Sdrh     case TK_NULL: {
35469de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3547c332cc30Sdrh       return target;
3548f0863fe5Sdrh     }
35495338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_BLOB_LITERAL
3550c572ef7fSdanielk1977     case TK_BLOB: {
35516c8c6cecSdrh       int n;
35526c8c6cecSdrh       const char *z;
3553ca48c90fSdrh       char *zBlob;
355433e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
355533e619fcSdrh       assert( pExpr->u.zToken[0]=='x' || pExpr->u.zToken[0]=='X' );
355633e619fcSdrh       assert( pExpr->u.zToken[1]=='\'' );
355733e619fcSdrh       z = &pExpr->u.zToken[2];
3558b7916a78Sdrh       n = sqlite3Strlen30(z) - 1;
3559b7916a78Sdrh       assert( z[n]=='\'' );
3560ca48c90fSdrh       zBlob = sqlite3HexToBlob(sqlite3VdbeDb(v), z, n);
3561ca48c90fSdrh       sqlite3VdbeAddOp4(v, OP_Blob, n/2, target, 0, zBlob, P4_DYNAMIC);
3562c332cc30Sdrh       return target;
3563c572ef7fSdanielk1977     }
35645338a5f7Sdanielk1977 #endif
356550457896Sdrh     case TK_VARIABLE: {
356633e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
356733e619fcSdrh       assert( pExpr->u.zToken!=0 );
356833e619fcSdrh       assert( pExpr->u.zToken[0]!=0 );
3569eaf52d88Sdrh       sqlite3VdbeAddOp2(v, OP_Variable, pExpr->iColumn, target);
357033e619fcSdrh       if( pExpr->u.zToken[1]!=0 ){
35719bf755ccSdrh         const char *z = sqlite3VListNumToName(pParse->pVList, pExpr->iColumn);
35729bf755ccSdrh         assert( pExpr->u.zToken[0]=='?' || strcmp(pExpr->u.zToken, z)==0 );
3573ce1bbe51Sdrh         pParse->pVList[0] = 0; /* Indicate VList may no longer be enlarged */
35749bf755ccSdrh         sqlite3VdbeAppendP4(v, (char*)z, P4_STATIC);
35759bf755ccSdrh       }
3576c332cc30Sdrh       return target;
357750457896Sdrh     }
35784e0cff60Sdrh     case TK_REGISTER: {
3579c332cc30Sdrh       return pExpr->iTable;
35804e0cff60Sdrh     }
3581487e262fSdrh #ifndef SQLITE_OMIT_CAST
3582487e262fSdrh     case TK_CAST: {
3583487e262fSdrh       /* Expressions of the form:   CAST(pLeft AS token) */
35842dcef11bSdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
35851735fa88Sdrh       if( inReg!=target ){
35861735fa88Sdrh         sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
35871735fa88Sdrh         inReg = target;
35881735fa88Sdrh       }
35894169e430Sdrh       sqlite3VdbeAddOp2(v, OP_Cast, target,
35904169e430Sdrh                         sqlite3AffinityType(pExpr->u.zToken, 0));
3591c332cc30Sdrh       return inReg;
3592487e262fSdrh     }
3593487e262fSdrh #endif /* SQLITE_OMIT_CAST */
359471c57db0Sdan     case TK_IS:
359571c57db0Sdan     case TK_ISNOT:
359671c57db0Sdan       op = (op==TK_IS) ? TK_EQ : TK_NE;
359771c57db0Sdan       p5 = SQLITE_NULLEQ;
359871c57db0Sdan       /* fall-through */
3599c9b84a1fSdrh     case TK_LT:
3600c9b84a1fSdrh     case TK_LE:
3601c9b84a1fSdrh     case TK_GT:
3602c9b84a1fSdrh     case TK_GE:
3603c9b84a1fSdrh     case TK_NE:
3604c9b84a1fSdrh     case TK_EQ: {
360571c57db0Sdan       Expr *pLeft = pExpr->pLeft;
3606625015e0Sdan       if( sqlite3ExprIsVector(pLeft) ){
360779752b6eSdrh         codeVectorCompare(pParse, pExpr, target, op, p5);
360871c57db0Sdan       }else{
360971c57db0Sdan         r1 = sqlite3ExprCodeTemp(pParse, pLeft, &regFree1);
3610b6da74ebSdrh         r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
361171c57db0Sdan         codeCompare(pParse, pLeft, pExpr->pRight, op,
361271c57db0Sdan             r1, r2, inReg, SQLITE_STOREP2 | p5);
36137d176105Sdrh         assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
36147d176105Sdrh         assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
36157d176105Sdrh         assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
36167d176105Sdrh         assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
36177d176105Sdrh         assert(TK_EQ==OP_Eq); testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
36187d176105Sdrh         assert(TK_NE==OP_Ne); testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
3619c5499befSdrh         testcase( regFree1==0 );
3620c5499befSdrh         testcase( regFree2==0 );
3621c9b84a1fSdrh       }
36226a2fe093Sdrh       break;
36236a2fe093Sdrh     }
3624cce7d176Sdrh     case TK_AND:
3625cce7d176Sdrh     case TK_OR:
3626cce7d176Sdrh     case TK_PLUS:
3627cce7d176Sdrh     case TK_STAR:
3628cce7d176Sdrh     case TK_MINUS:
3629bf4133cbSdrh     case TK_REM:
3630bf4133cbSdrh     case TK_BITAND:
3631bf4133cbSdrh     case TK_BITOR:
363217c40294Sdrh     case TK_SLASH:
3633bf4133cbSdrh     case TK_LSHIFT:
3634855eb1cfSdrh     case TK_RSHIFT:
36350040077dSdrh     case TK_CONCAT: {
36367d176105Sdrh       assert( TK_AND==OP_And );            testcase( op==TK_AND );
36377d176105Sdrh       assert( TK_OR==OP_Or );              testcase( op==TK_OR );
36387d176105Sdrh       assert( TK_PLUS==OP_Add );           testcase( op==TK_PLUS );
36397d176105Sdrh       assert( TK_MINUS==OP_Subtract );     testcase( op==TK_MINUS );
36407d176105Sdrh       assert( TK_REM==OP_Remainder );      testcase( op==TK_REM );
36417d176105Sdrh       assert( TK_BITAND==OP_BitAnd );      testcase( op==TK_BITAND );
36427d176105Sdrh       assert( TK_BITOR==OP_BitOr );        testcase( op==TK_BITOR );
36437d176105Sdrh       assert( TK_SLASH==OP_Divide );       testcase( op==TK_SLASH );
36447d176105Sdrh       assert( TK_LSHIFT==OP_ShiftLeft );   testcase( op==TK_LSHIFT );
36457d176105Sdrh       assert( TK_RSHIFT==OP_ShiftRight );  testcase( op==TK_RSHIFT );
36467d176105Sdrh       assert( TK_CONCAT==OP_Concat );      testcase( op==TK_CONCAT );
36472dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
36482dcef11bSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
36495b6afba9Sdrh       sqlite3VdbeAddOp3(v, op, r2, r1, target);
3650c5499befSdrh       testcase( regFree1==0 );
3651c5499befSdrh       testcase( regFree2==0 );
36520040077dSdrh       break;
36530040077dSdrh     }
3654cce7d176Sdrh     case TK_UMINUS: {
3655fec19aadSdrh       Expr *pLeft = pExpr->pLeft;
3656fec19aadSdrh       assert( pLeft );
365713573c71Sdrh       if( pLeft->op==TK_INTEGER ){
365813573c71Sdrh         codeInteger(pParse, pLeft, 1, target);
3659c332cc30Sdrh         return target;
366013573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
366113573c71Sdrh       }else if( pLeft->op==TK_FLOAT ){
366233e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
366333e619fcSdrh         codeReal(v, pLeft->u.zToken, 1, target);
3664c332cc30Sdrh         return target;
366513573c71Sdrh #endif
36663c84ddffSdrh       }else{
366710d1edf0Sdrh         tempX.op = TK_INTEGER;
366810d1edf0Sdrh         tempX.flags = EP_IntValue|EP_TokenOnly;
366910d1edf0Sdrh         tempX.u.iValue = 0;
367010d1edf0Sdrh         r1 = sqlite3ExprCodeTemp(pParse, &tempX, &regFree1);
3671e55cbd72Sdrh         r2 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree2);
36722dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_Subtract, r2, r1, target);
3673c5499befSdrh         testcase( regFree2==0 );
36743c84ddffSdrh       }
36756e142f54Sdrh       break;
36766e142f54Sdrh     }
3677bf4133cbSdrh     case TK_BITNOT:
36786e142f54Sdrh     case TK_NOT: {
36797d176105Sdrh       assert( TK_BITNOT==OP_BitNot );   testcase( op==TK_BITNOT );
36807d176105Sdrh       assert( TK_NOT==OP_Not );         testcase( op==TK_NOT );
3681e99fa2afSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3682e99fa2afSdrh       testcase( regFree1==0 );
3683e99fa2afSdrh       sqlite3VdbeAddOp2(v, op, r1, inReg);
3684cce7d176Sdrh       break;
3685cce7d176Sdrh     }
36868abed7b9Sdrh     case TK_TRUTH: {
368796acafbeSdrh       int isTrue;    /* IS TRUE or IS NOT TRUE */
368896acafbeSdrh       int bNormal;   /* IS TRUE or IS FALSE */
3689007c843bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3690007c843bSdrh       testcase( regFree1==0 );
369196acafbeSdrh       isTrue = sqlite3ExprTruthValue(pExpr->pRight);
369296acafbeSdrh       bNormal = pExpr->op2==TK_IS;
369396acafbeSdrh       testcase( isTrue && bNormal);
369496acafbeSdrh       testcase( !isTrue && bNormal);
369596acafbeSdrh       sqlite3VdbeAddOp4Int(v, OP_IsTrue, r1, inReg, !isTrue, isTrue ^ bNormal);
3696007c843bSdrh       break;
3697007c843bSdrh     }
3698cce7d176Sdrh     case TK_ISNULL:
3699cce7d176Sdrh     case TK_NOTNULL: {
37006a288a33Sdrh       int addr;
37017d176105Sdrh       assert( TK_ISNULL==OP_IsNull );   testcase( op==TK_ISNULL );
37027d176105Sdrh       assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
37039de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
37042dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3705c5499befSdrh       testcase( regFree1==0 );
37062dcef11bSdrh       addr = sqlite3VdbeAddOp1(v, op, r1);
37077d176105Sdrh       VdbeCoverageIf(v, op==TK_ISNULL);
37087d176105Sdrh       VdbeCoverageIf(v, op==TK_NOTNULL);
3709a976979bSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 0, target);
37106a288a33Sdrh       sqlite3VdbeJumpHere(v, addr);
3711a37cdde0Sdanielk1977       break;
3712f2bc013cSdrh     }
37132282792aSdrh     case TK_AGG_FUNCTION: {
371413449892Sdrh       AggInfo *pInfo = pExpr->pAggInfo;
37157e56e711Sdrh       if( pInfo==0 ){
371633e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
371733e619fcSdrh         sqlite3ErrorMsg(pParse, "misuse of aggregate: %s()", pExpr->u.zToken);
37187e56e711Sdrh       }else{
3719c332cc30Sdrh         return pInfo->aFunc[pExpr->iAgg].iMem;
37207e56e711Sdrh       }
37212282792aSdrh       break;
37222282792aSdrh     }
3723cce7d176Sdrh     case TK_FUNCTION: {
372412ffee8cSdrh       ExprList *pFarg;       /* List of function arguments */
372512ffee8cSdrh       int nFarg;             /* Number of function arguments */
372612ffee8cSdrh       FuncDef *pDef;         /* The function definition object */
372712ffee8cSdrh       const char *zId;       /* The function name */
3728693e6719Sdrh       u32 constMask = 0;     /* Mask of function arguments that are constant */
372912ffee8cSdrh       int i;                 /* Loop counter */
3730c332cc30Sdrh       sqlite3 *db = pParse->db;  /* The database connection */
373112ffee8cSdrh       u8 enc = ENC(db);      /* The text encoding used by this database */
373212ffee8cSdrh       CollSeq *pColl = 0;    /* A collating sequence */
373317435752Sdrh 
373467a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
3735eda079cdSdrh       if( ExprHasProperty(pExpr, EP_WinFunc) ){
3736eda079cdSdrh         return pExpr->y.pWin->regResult;
373786fb6e17Sdan       }
373867a9b8edSdan #endif
373986fb6e17Sdan 
37401e9b53f9Sdrh       if( ConstFactorOk(pParse) && sqlite3ExprIsConstantNotJoin(pExpr) ){
374149c5ab24Sdrh         /* SQL functions can be expensive. So try to move constant functions
3742ad879ffdSdrh         ** out of the inner loop, even if that means an extra OP_Copy. */
3743ad879ffdSdrh         return sqlite3ExprCodeAtInit(pParse, pExpr, -1);
37441e9b53f9Sdrh       }
37456ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
3746c5cd1249Sdrh       if( ExprHasProperty(pExpr, EP_TokenOnly) ){
374712ffee8cSdrh         pFarg = 0;
374812ffee8cSdrh       }else{
374912ffee8cSdrh         pFarg = pExpr->x.pList;
375012ffee8cSdrh       }
375112ffee8cSdrh       nFarg = pFarg ? pFarg->nExpr : 0;
375233e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
375333e619fcSdrh       zId = pExpr->u.zToken;
375480738d9cSdrh       pDef = sqlite3FindFunction(db, zId, nFarg, enc, 0);
3755cc15313cSdrh #ifdef SQLITE_ENABLE_UNKNOWN_SQL_FUNCTION
3756cc15313cSdrh       if( pDef==0 && pParse->explain ){
3757cc15313cSdrh         pDef = sqlite3FindFunction(db, "unknown", nFarg, enc, 0);
3758cc15313cSdrh       }
3759cc15313cSdrh #endif
3760b6e9f7a4Sdan       if( pDef==0 || pDef->xFinalize!=0 ){
376180738d9cSdrh         sqlite3ErrorMsg(pParse, "unknown function: %s()", zId);
3762feb306f5Sdrh         break;
3763feb306f5Sdrh       }
3764ae6bb957Sdrh 
3765ae6bb957Sdrh       /* Attempt a direct implementation of the built-in COALESCE() and
376660ec914cSpeter.d.reid       ** IFNULL() functions.  This avoids unnecessary evaluation of
3767ae6bb957Sdrh       ** arguments past the first non-NULL argument.
3768ae6bb957Sdrh       */
3769d36e1041Sdrh       if( pDef->funcFlags & SQLITE_FUNC_COALESCE ){
3770ec4ccdbcSdrh         int endCoalesce = sqlite3VdbeMakeLabel(pParse);
3771ae6bb957Sdrh         assert( nFarg>=2 );
3772ae6bb957Sdrh         sqlite3ExprCode(pParse, pFarg->a[0].pExpr, target);
3773ae6bb957Sdrh         for(i=1; i<nFarg; i++){
3774ae6bb957Sdrh           sqlite3VdbeAddOp2(v, OP_NotNull, target, endCoalesce);
3775688852abSdrh           VdbeCoverage(v);
3776ae6bb957Sdrh           sqlite3ExprCode(pParse, pFarg->a[i].pExpr, target);
3777ae6bb957Sdrh         }
3778ae6bb957Sdrh         sqlite3VdbeResolveLabel(v, endCoalesce);
3779ae6bb957Sdrh         break;
3780ae6bb957Sdrh       }
3781ae6bb957Sdrh 
3782cca9f3d2Sdrh       /* The UNLIKELY() function is a no-op.  The result is the value
3783cca9f3d2Sdrh       ** of the first argument.
3784cca9f3d2Sdrh       */
3785cca9f3d2Sdrh       if( pDef->funcFlags & SQLITE_FUNC_UNLIKELY ){
3786cca9f3d2Sdrh         assert( nFarg>=1 );
3787c332cc30Sdrh         return sqlite3ExprCodeTarget(pParse, pFarg->a[0].pExpr, target);
3788cca9f3d2Sdrh       }
3789ae6bb957Sdrh 
379054240751Sdrh #ifdef SQLITE_DEBUG
3791a1a523a5Sdrh       /* The AFFINITY() function evaluates to a string that describes
3792a1a523a5Sdrh       ** the type affinity of the argument.  This is used for testing of
3793a1a523a5Sdrh       ** the SQLite type logic.
3794a1a523a5Sdrh       */
3795a1a523a5Sdrh       if( pDef->funcFlags & SQLITE_FUNC_AFFINITY ){
3796a1a523a5Sdrh         const char *azAff[] = { "blob", "text", "numeric", "integer", "real" };
3797a1a523a5Sdrh         char aff;
3798a1a523a5Sdrh         assert( nFarg==1 );
3799a1a523a5Sdrh         aff = sqlite3ExprAffinity(pFarg->a[0].pExpr);
3800a1a523a5Sdrh         sqlite3VdbeLoadString(v, target,
380196fb16eeSdrh                 (aff<=SQLITE_AFF_NONE) ? "none" : azAff[aff-SQLITE_AFF_BLOB]);
3802a1a523a5Sdrh         return target;
3803a1a523a5Sdrh       }
380454240751Sdrh #endif
3805a1a523a5Sdrh 
3806d1a01edaSdrh       for(i=0; i<nFarg; i++){
3807d1a01edaSdrh         if( i<32 && sqlite3ExprIsConstant(pFarg->a[i].pExpr) ){
3808693e6719Sdrh           testcase( i==31 );
3809693e6719Sdrh           constMask |= MASKBIT32(i);
3810d1a01edaSdrh         }
3811d1a01edaSdrh         if( (pDef->funcFlags & SQLITE_FUNC_NEEDCOLL)!=0 && !pColl ){
3812d1a01edaSdrh           pColl = sqlite3ExprCollSeq(pParse, pFarg->a[i].pExpr);
3813d1a01edaSdrh         }
3814d1a01edaSdrh       }
381512ffee8cSdrh       if( pFarg ){
3816d1a01edaSdrh         if( constMask ){
3817d1a01edaSdrh           r1 = pParse->nMem+1;
3818d1a01edaSdrh           pParse->nMem += nFarg;
3819d1a01edaSdrh         }else{
382012ffee8cSdrh           r1 = sqlite3GetTempRange(pParse, nFarg);
3821d1a01edaSdrh         }
3822a748fdccSdrh 
3823a748fdccSdrh         /* For length() and typeof() functions with a column argument,
3824a748fdccSdrh         ** set the P5 parameter to the OP_Column opcode to OPFLAG_LENGTHARG
3825a748fdccSdrh         ** or OPFLAG_TYPEOFARG respectively, to avoid unnecessary data
3826a748fdccSdrh         ** loading.
3827a748fdccSdrh         */
3828d36e1041Sdrh         if( (pDef->funcFlags & (SQLITE_FUNC_LENGTH|SQLITE_FUNC_TYPEOF))!=0 ){
38294e245a4cSdrh           u8 exprOp;
3830a748fdccSdrh           assert( nFarg==1 );
3831a748fdccSdrh           assert( pFarg->a[0].pExpr!=0 );
38324e245a4cSdrh           exprOp = pFarg->a[0].pExpr->op;
38334e245a4cSdrh           if( exprOp==TK_COLUMN || exprOp==TK_AGG_COLUMN ){
3834a748fdccSdrh             assert( SQLITE_FUNC_LENGTH==OPFLAG_LENGTHARG );
3835a748fdccSdrh             assert( SQLITE_FUNC_TYPEOF==OPFLAG_TYPEOFARG );
3836b1fba286Sdrh             testcase( pDef->funcFlags & OPFLAG_LENGTHARG );
3837b1fba286Sdrh             pFarg->a[0].pExpr->op2 =
3838b1fba286Sdrh                   pDef->funcFlags & (OPFLAG_LENGTHARG|OPFLAG_TYPEOFARG);
3839a748fdccSdrh           }
3840a748fdccSdrh         }
3841a748fdccSdrh 
38425579d59fSdrh         sqlite3ExprCodeExprList(pParse, pFarg, r1, 0,
3843d1a01edaSdrh                                 SQLITE_ECEL_DUP|SQLITE_ECEL_FACTOR);
3844892d3179Sdrh       }else{
384512ffee8cSdrh         r1 = 0;
3846892d3179Sdrh       }
3847b7f6f68fSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
3848a43fa227Sdrh       /* Possibly overload the function if the first argument is
3849a43fa227Sdrh       ** a virtual table column.
3850a43fa227Sdrh       **
3851a43fa227Sdrh       ** For infix functions (LIKE, GLOB, REGEXP, and MATCH) use the
3852a43fa227Sdrh       ** second argument, not the first, as the argument to test to
3853a43fa227Sdrh       ** see if it is a column in a virtual table.  This is done because
3854a43fa227Sdrh       ** the left operand of infix functions (the operand we want to
3855a43fa227Sdrh       ** control overloading) ends up as the second argument to the
3856a43fa227Sdrh       ** function.  The expression "A glob B" is equivalent to
3857a43fa227Sdrh       ** "glob(B,A).  We want to use the A in "A glob B" to test
3858a43fa227Sdrh       ** for function overloading.  But we use the B term in "glob(B,A)".
3859a43fa227Sdrh       */
386059155065Sdrh       if( nFarg>=2 && ExprHasProperty(pExpr, EP_InfixFunc) ){
386112ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[1].pExpr);
386212ffee8cSdrh       }else if( nFarg>0 ){
386312ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[0].pExpr);
3864b7f6f68fSdrh       }
3865b7f6f68fSdrh #endif
3866d36e1041Sdrh       if( pDef->funcFlags & SQLITE_FUNC_NEEDCOLL ){
38678b213899Sdrh         if( !pColl ) pColl = db->pDfltColl;
386866a5167bSdrh         sqlite3VdbeAddOp4(v, OP_CollSeq, 0, 0, 0, (char *)pColl, P4_COLLSEQ);
3869682f68b0Sdanielk1977       }
3870092457b1Sdrh #ifdef SQLITE_ENABLE_OFFSET_SQL_FUNC
3871092457b1Sdrh       if( pDef->funcFlags & SQLITE_FUNC_OFFSET ){
38722fc865c1Sdrh         Expr *pArg = pFarg->a[0].pExpr;
38732fc865c1Sdrh         if( pArg->op==TK_COLUMN ){
3874092457b1Sdrh           sqlite3VdbeAddOp3(v, OP_Offset, pArg->iTable, pArg->iColumn, target);
38752fc865c1Sdrh         }else{
38762fc865c1Sdrh           sqlite3VdbeAddOp2(v, OP_Null, 0, target);
38772fc865c1Sdrh         }
3878092457b1Sdrh       }else
3879092457b1Sdrh #endif
3880092457b1Sdrh       {
38813e34eabcSdrh         sqlite3VdbeAddOp4(v, pParse->iSelfTab ? OP_PureFunc0 : OP_Function0,
38823e34eabcSdrh                           constMask, r1, target, (char*)pDef, P4_FUNCDEF);
388312ffee8cSdrh         sqlite3VdbeChangeP5(v, (u8)nFarg);
38842fc865c1Sdrh       }
3885d1a01edaSdrh       if( nFarg && constMask==0 ){
388612ffee8cSdrh         sqlite3ReleaseTempRange(pParse, r1, nFarg);
38872dcef11bSdrh       }
3888c332cc30Sdrh       return target;
38896ec2733bSdrh     }
3890fe2093d7Sdrh #ifndef SQLITE_OMIT_SUBQUERY
3891fe2093d7Sdrh     case TK_EXISTS:
389219a775c2Sdrh     case TK_SELECT: {
38938da209b1Sdan       int nCol;
3894c5499befSdrh       testcase( op==TK_EXISTS );
3895c5499befSdrh       testcase( op==TK_SELECT );
38968da209b1Sdan       if( op==TK_SELECT && (nCol = pExpr->x.pSelect->pEList->nExpr)!=1 ){
38978da209b1Sdan         sqlite3SubselectError(pParse, nCol, 1);
38988da209b1Sdan       }else{
389985bcdce2Sdrh         return sqlite3CodeSubselect(pParse, pExpr);
39008da209b1Sdan       }
390119a775c2Sdrh       break;
390219a775c2Sdrh     }
3903fc7f27b9Sdrh     case TK_SELECT_COLUMN: {
3904966e2911Sdrh       int n;
3905fc7f27b9Sdrh       if( pExpr->pLeft->iTable==0 ){
390685bcdce2Sdrh         pExpr->pLeft->iTable = sqlite3CodeSubselect(pParse, pExpr->pLeft);
3907fc7f27b9Sdrh       }
3908966e2911Sdrh       assert( pExpr->iTable==0 || pExpr->pLeft->op==TK_SELECT );
3909966e2911Sdrh       if( pExpr->iTable
3910966e2911Sdrh        && pExpr->iTable!=(n = sqlite3ExprVectorSize(pExpr->pLeft))
3911966e2911Sdrh       ){
3912966e2911Sdrh         sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
3913966e2911Sdrh                                 pExpr->iTable, n);
3914966e2911Sdrh       }
3915c332cc30Sdrh       return pExpr->pLeft->iTable + pExpr->iColumn;
3916fc7f27b9Sdrh     }
3917fef5208cSdrh     case TK_IN: {
3918ec4ccdbcSdrh       int destIfFalse = sqlite3VdbeMakeLabel(pParse);
3919ec4ccdbcSdrh       int destIfNull = sqlite3VdbeMakeLabel(pParse);
3920e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3921e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
392266ba23ceSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
3923e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
3924e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_AddImm, target, 0);
3925e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfNull);
3926c332cc30Sdrh       return target;
3927fef5208cSdrh     }
3928e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
3929e3365e6cSdrh 
3930e3365e6cSdrh 
39312dcef11bSdrh     /*
39322dcef11bSdrh     **    x BETWEEN y AND z
39332dcef11bSdrh     **
39342dcef11bSdrh     ** This is equivalent to
39352dcef11bSdrh     **
39362dcef11bSdrh     **    x>=y AND x<=z
39372dcef11bSdrh     **
39382dcef11bSdrh     ** X is stored in pExpr->pLeft.
39392dcef11bSdrh     ** Y is stored in pExpr->pList->a[0].pExpr.
39402dcef11bSdrh     ** Z is stored in pExpr->pList->a[1].pExpr.
39412dcef11bSdrh     */
3942fef5208cSdrh     case TK_BETWEEN: {
394371c57db0Sdan       exprCodeBetween(pParse, pExpr, target, 0, 0);
3944c332cc30Sdrh       return target;
3945fef5208cSdrh     }
394694fa9c41Sdrh     case TK_SPAN:
3947ae80ddeaSdrh     case TK_COLLATE:
39484f07e5fbSdrh     case TK_UPLUS: {
39491efa8023Sdrh       pExpr = pExpr->pLeft;
395059ee43a7Sdrh       goto expr_code_doover; /* 2018-04-28: Prevent deep recursion. OSSFuzz. */
3951a2e00042Sdrh     }
39522dcef11bSdrh 
3953165921a7Sdan     case TK_TRIGGER: {
395465a7cd16Sdan       /* If the opcode is TK_TRIGGER, then the expression is a reference
395565a7cd16Sdan       ** to a column in the new.* or old.* pseudo-tables available to
395665a7cd16Sdan       ** trigger programs. In this case Expr.iTable is set to 1 for the
395765a7cd16Sdan       ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
395865a7cd16Sdan       ** is set to the column of the pseudo-table to read, or to -1 to
395965a7cd16Sdan       ** read the rowid field.
396065a7cd16Sdan       **
396165a7cd16Sdan       ** The expression is implemented using an OP_Param opcode. The p1
396265a7cd16Sdan       ** parameter is set to 0 for an old.rowid reference, or to (i+1)
396365a7cd16Sdan       ** to reference another column of the old.* pseudo-table, where
396465a7cd16Sdan       ** i is the index of the column. For a new.rowid reference, p1 is
396565a7cd16Sdan       ** set to (n+1), where n is the number of columns in each pseudo-table.
396665a7cd16Sdan       ** For a reference to any other column in the new.* pseudo-table, p1
396765a7cd16Sdan       ** is set to (n+2+i), where n and i are as defined previously. For
396865a7cd16Sdan       ** example, if the table on which triggers are being fired is
396965a7cd16Sdan       ** declared as:
397065a7cd16Sdan       **
397165a7cd16Sdan       **   CREATE TABLE t1(a, b);
397265a7cd16Sdan       **
397365a7cd16Sdan       ** Then p1 is interpreted as follows:
397465a7cd16Sdan       **
397565a7cd16Sdan       **   p1==0   ->    old.rowid     p1==3   ->    new.rowid
397665a7cd16Sdan       **   p1==1   ->    old.a         p1==4   ->    new.a
397765a7cd16Sdan       **   p1==2   ->    old.b         p1==5   ->    new.b
397865a7cd16Sdan       */
3979eda079cdSdrh       Table *pTab = pExpr->y.pTab;
398065a7cd16Sdan       int p1 = pExpr->iTable * (pTab->nCol+1) + 1 + pExpr->iColumn;
398165a7cd16Sdan 
398265a7cd16Sdan       assert( pExpr->iTable==0 || pExpr->iTable==1 );
398365a7cd16Sdan       assert( pExpr->iColumn>=-1 && pExpr->iColumn<pTab->nCol );
398465a7cd16Sdan       assert( pTab->iPKey<0 || pExpr->iColumn!=pTab->iPKey );
398565a7cd16Sdan       assert( p1>=0 && p1<(pTab->nCol*2+2) );
398665a7cd16Sdan 
398765a7cd16Sdan       sqlite3VdbeAddOp2(v, OP_Param, p1, target);
3988896494e8Sdrh       VdbeComment((v, "r[%d]=%s.%s", target,
3989165921a7Sdan         (pExpr->iTable ? "new" : "old"),
3990eda079cdSdrh         (pExpr->iColumn<0 ? "rowid" : pExpr->y.pTab->aCol[pExpr->iColumn].zName)
3991165921a7Sdan       ));
399265a7cd16Sdan 
399344dbca83Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
399465a7cd16Sdan       /* If the column has REAL affinity, it may currently be stored as an
3995113762a2Sdrh       ** integer. Use OP_RealAffinity to make sure it is really real.
3996113762a2Sdrh       **
3997113762a2Sdrh       ** EVIDENCE-OF: R-60985-57662 SQLite will convert the value back to
3998113762a2Sdrh       ** floating point when extracting it from the record.  */
39992832ad42Sdan       if( pExpr->iColumn>=0
40002832ad42Sdan        && pTab->aCol[pExpr->iColumn].affinity==SQLITE_AFF_REAL
40012832ad42Sdan       ){
40022832ad42Sdan         sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
40032832ad42Sdan       }
400444dbca83Sdrh #endif
4005165921a7Sdan       break;
4006165921a7Sdan     }
4007165921a7Sdan 
400871c57db0Sdan     case TK_VECTOR: {
4009e835bc12Sdrh       sqlite3ErrorMsg(pParse, "row value misused");
401071c57db0Sdan       break;
401171c57db0Sdan     }
401271c57db0Sdan 
40139e9a67adSdrh     /* TK_IF_NULL_ROW Expr nodes are inserted ahead of expressions
40149e9a67adSdrh     ** that derive from the right-hand table of a LEFT JOIN.  The
40159e9a67adSdrh     ** Expr.iTable value is the table number for the right-hand table.
40169e9a67adSdrh     ** The expression is only evaluated if that table is not currently
40179e9a67adSdrh     ** on a LEFT JOIN NULL row.
40189e9a67adSdrh     */
401931d6fd55Sdrh     case TK_IF_NULL_ROW: {
402031d6fd55Sdrh       int addrINR;
40219e9a67adSdrh       u8 okConstFactor = pParse->okConstFactor;
402231d6fd55Sdrh       addrINR = sqlite3VdbeAddOp1(v, OP_IfNullRow, pExpr->iTable);
40239e9a67adSdrh       /* Temporarily disable factoring of constant expressions, since
40249e9a67adSdrh       ** even though expressions may appear to be constant, they are not
40259e9a67adSdrh       ** really constant because they originate from the right-hand side
40269e9a67adSdrh       ** of a LEFT JOIN. */
40279e9a67adSdrh       pParse->okConstFactor = 0;
402831d6fd55Sdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
40299e9a67adSdrh       pParse->okConstFactor = okConstFactor;
403031d6fd55Sdrh       sqlite3VdbeJumpHere(v, addrINR);
403131d6fd55Sdrh       sqlite3VdbeChangeP3(v, addrINR, inReg);
403231d6fd55Sdrh       break;
403331d6fd55Sdrh     }
403431d6fd55Sdrh 
40352dcef11bSdrh     /*
40362dcef11bSdrh     ** Form A:
40372dcef11bSdrh     **   CASE x WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
40382dcef11bSdrh     **
40392dcef11bSdrh     ** Form B:
40402dcef11bSdrh     **   CASE WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
40412dcef11bSdrh     **
40422dcef11bSdrh     ** Form A is can be transformed into the equivalent form B as follows:
40432dcef11bSdrh     **   CASE WHEN x=e1 THEN r1 WHEN x=e2 THEN r2 ...
40442dcef11bSdrh     **        WHEN x=eN THEN rN ELSE y END
40452dcef11bSdrh     **
40462dcef11bSdrh     ** X (if it exists) is in pExpr->pLeft.
4047c5cd1249Sdrh     ** Y is in the last element of pExpr->x.pList if pExpr->x.pList->nExpr is
4048c5cd1249Sdrh     ** odd.  The Y is also optional.  If the number of elements in x.pList
4049c5cd1249Sdrh     ** is even, then Y is omitted and the "otherwise" result is NULL.
40502dcef11bSdrh     ** Ei is in pExpr->pList->a[i*2] and Ri is pExpr->pList->a[i*2+1].
40512dcef11bSdrh     **
40522dcef11bSdrh     ** The result of the expression is the Ri for the first matching Ei,
40532dcef11bSdrh     ** or if there is no matching Ei, the ELSE term Y, or if there is
40542dcef11bSdrh     ** no ELSE term, NULL.
40552dcef11bSdrh     */
405633cd4909Sdrh     default: assert( op==TK_CASE ); {
40572dcef11bSdrh       int endLabel;                     /* GOTO label for end of CASE stmt */
40582dcef11bSdrh       int nextCase;                     /* GOTO label for next WHEN clause */
40592dcef11bSdrh       int nExpr;                        /* 2x number of WHEN terms */
40602dcef11bSdrh       int i;                            /* Loop counter */
40612dcef11bSdrh       ExprList *pEList;                 /* List of WHEN terms */
40622dcef11bSdrh       struct ExprList_item *aListelem;  /* Array of WHEN terms */
40632dcef11bSdrh       Expr opCompare;                   /* The X==Ei expression */
40642dcef11bSdrh       Expr *pX;                         /* The X expression */
40651bd10f8aSdrh       Expr *pTest = 0;                  /* X==Ei (form A) or just Ei (form B) */
40668b65e591Sdan       Expr *pDel = 0;
40678b65e591Sdan       sqlite3 *db = pParse->db;
406817a7f8ddSdrh 
40696ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) && pExpr->x.pList );
40706ab3a2ecSdanielk1977       assert(pExpr->x.pList->nExpr > 0);
40716ab3a2ecSdanielk1977       pEList = pExpr->x.pList;
4072be5c89acSdrh       aListelem = pEList->a;
4073be5c89acSdrh       nExpr = pEList->nExpr;
4074ec4ccdbcSdrh       endLabel = sqlite3VdbeMakeLabel(pParse);
40752dcef11bSdrh       if( (pX = pExpr->pLeft)!=0 ){
40768b65e591Sdan         pDel = sqlite3ExprDup(db, pX, 0);
40778b65e591Sdan         if( db->mallocFailed ){
40788b65e591Sdan           sqlite3ExprDelete(db, pDel);
40798b65e591Sdan           break;
40808b65e591Sdan         }
408133cd4909Sdrh         testcase( pX->op==TK_COLUMN );
40828b65e591Sdan         exprToRegister(pDel, exprCodeVector(pParse, pDel, &regFree1));
4083c5499befSdrh         testcase( regFree1==0 );
4084abb9d5f1Sdrh         memset(&opCompare, 0, sizeof(opCompare));
40852dcef11bSdrh         opCompare.op = TK_EQ;
40868b65e591Sdan         opCompare.pLeft = pDel;
40872dcef11bSdrh         pTest = &opCompare;
40888b1db07fSdrh         /* Ticket b351d95f9cd5ef17e9d9dbae18f5ca8611190001:
40898b1db07fSdrh         ** The value in regFree1 might get SCopy-ed into the file result.
40908b1db07fSdrh         ** So make sure that the regFree1 register is not reused for other
40918b1db07fSdrh         ** purposes and possibly overwritten.  */
40928b1db07fSdrh         regFree1 = 0;
4093cce7d176Sdrh       }
4094c5cd1249Sdrh       for(i=0; i<nExpr-1; i=i+2){
40952dcef11bSdrh         if( pX ){
40961bd10f8aSdrh           assert( pTest!=0 );
40972dcef11bSdrh           opCompare.pRight = aListelem[i].pExpr;
4098f5905aa7Sdrh         }else{
40992dcef11bSdrh           pTest = aListelem[i].pExpr;
410017a7f8ddSdrh         }
4101ec4ccdbcSdrh         nextCase = sqlite3VdbeMakeLabel(pParse);
410233cd4909Sdrh         testcase( pTest->op==TK_COLUMN );
41032dcef11bSdrh         sqlite3ExprIfFalse(pParse, pTest, nextCase, SQLITE_JUMPIFNULL);
4104c5499befSdrh         testcase( aListelem[i+1].pExpr->op==TK_COLUMN );
41059de221dfSdrh         sqlite3ExprCode(pParse, aListelem[i+1].pExpr, target);
4106076e85f5Sdrh         sqlite3VdbeGoto(v, endLabel);
41072dcef11bSdrh         sqlite3VdbeResolveLabel(v, nextCase);
4108f570f011Sdrh       }
4109c5cd1249Sdrh       if( (nExpr&1)!=0 ){
4110c5cd1249Sdrh         sqlite3ExprCode(pParse, pEList->a[nExpr-1].pExpr, target);
411117a7f8ddSdrh       }else{
41129de221dfSdrh         sqlite3VdbeAddOp2(v, OP_Null, 0, target);
411317a7f8ddSdrh       }
41148b65e591Sdan       sqlite3ExprDelete(db, pDel);
41152dcef11bSdrh       sqlite3VdbeResolveLabel(v, endLabel);
41166f34903eSdanielk1977       break;
41176f34903eSdanielk1977     }
41185338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_TRIGGER
41196f34903eSdanielk1977     case TK_RAISE: {
41201194904bSdrh       assert( pExpr->affExpr==OE_Rollback
41211194904bSdrh            || pExpr->affExpr==OE_Abort
41221194904bSdrh            || pExpr->affExpr==OE_Fail
41231194904bSdrh            || pExpr->affExpr==OE_Ignore
4124165921a7Sdan       );
4125e0af83acSdan       if( !pParse->pTriggerTab ){
4126e0af83acSdan         sqlite3ErrorMsg(pParse,
4127e0af83acSdan                        "RAISE() may only be used within a trigger-program");
4128e0af83acSdan         return 0;
4129e0af83acSdan       }
41301194904bSdrh       if( pExpr->affExpr==OE_Abort ){
4131e0af83acSdan         sqlite3MayAbort(pParse);
4132e0af83acSdan       }
413333e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
41341194904bSdrh       if( pExpr->affExpr==OE_Ignore ){
4135e0af83acSdan         sqlite3VdbeAddOp4(
4136e0af83acSdan             v, OP_Halt, SQLITE_OK, OE_Ignore, 0, pExpr->u.zToken,0);
4137688852abSdrh         VdbeCoverage(v);
4138e0af83acSdan       }else{
4139433dccfbSdrh         sqlite3HaltConstraint(pParse, SQLITE_CONSTRAINT_TRIGGER,
41401194904bSdrh                               pExpr->affExpr, pExpr->u.zToken, 0, 0);
4141e0af83acSdan       }
4142e0af83acSdan 
4143ffe07b2dSdrh       break;
414417a7f8ddSdrh     }
41455338a5f7Sdanielk1977 #endif
4146ffe07b2dSdrh   }
41472dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
41482dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
41492dcef11bSdrh   return inReg;
41505b6afba9Sdrh }
41512dcef11bSdrh 
41522dcef11bSdrh /*
4153d1a01edaSdrh ** Factor out the code of the given expression to initialization time.
41541e9b53f9Sdrh **
4155ad879ffdSdrh ** If regDest>=0 then the result is always stored in that register and the
4156ad879ffdSdrh ** result is not reusable.  If regDest<0 then this routine is free to
4157ad879ffdSdrh ** store the value whereever it wants.  The register where the expression
4158ad879ffdSdrh ** is stored is returned.  When regDest<0, two identical expressions will
4159ad879ffdSdrh ** code to the same register.
4160d1a01edaSdrh */
41611e9b53f9Sdrh int sqlite3ExprCodeAtInit(
4162d673cddaSdrh   Parse *pParse,    /* Parsing context */
4163d673cddaSdrh   Expr *pExpr,      /* The expression to code when the VDBE initializes */
4164ad879ffdSdrh   int regDest       /* Store the value in this register */
4165d673cddaSdrh ){
4166d1a01edaSdrh   ExprList *p;
4167d9f158e7Sdrh   assert( ConstFactorOk(pParse) );
4168d1a01edaSdrh   p = pParse->pConstExpr;
4169ad879ffdSdrh   if( regDest<0 && p ){
41701e9b53f9Sdrh     struct ExprList_item *pItem;
41711e9b53f9Sdrh     int i;
41721e9b53f9Sdrh     for(pItem=p->a, i=p->nExpr; i>0; pItem++, i--){
41735aa550cfSdan       if( pItem->reusable && sqlite3ExprCompare(0,pItem->pExpr,pExpr,-1)==0 ){
41741e9b53f9Sdrh         return pItem->u.iConstExprReg;
41751e9b53f9Sdrh       }
41761e9b53f9Sdrh     }
41771e9b53f9Sdrh   }
4178d1a01edaSdrh   pExpr = sqlite3ExprDup(pParse->db, pExpr, 0);
4179d1a01edaSdrh   p = sqlite3ExprListAppend(pParse, p, pExpr);
4180d673cddaSdrh   if( p ){
4181d673cddaSdrh      struct ExprList_item *pItem = &p->a[p->nExpr-1];
4182ad879ffdSdrh      pItem->reusable = regDest<0;
4183ad879ffdSdrh      if( regDest<0 ) regDest = ++pParse->nMem;
4184d673cddaSdrh      pItem->u.iConstExprReg = regDest;
4185d673cddaSdrh   }
4186d1a01edaSdrh   pParse->pConstExpr = p;
41871e9b53f9Sdrh   return regDest;
4188d1a01edaSdrh }
4189d1a01edaSdrh 
4190d1a01edaSdrh /*
41912dcef11bSdrh ** Generate code to evaluate an expression and store the results
41922dcef11bSdrh ** into a register.  Return the register number where the results
41932dcef11bSdrh ** are stored.
41942dcef11bSdrh **
41952dcef11bSdrh ** If the register is a temporary register that can be deallocated,
4196678ccce8Sdrh ** then write its number into *pReg.  If the result register is not
41972dcef11bSdrh ** a temporary, then set *pReg to zero.
4198f30a969bSdrh **
4199f30a969bSdrh ** If pExpr is a constant, then this routine might generate this
4200f30a969bSdrh ** code to fill the register in the initialization section of the
4201f30a969bSdrh ** VDBE program, in order to factor it out of the evaluation loop.
42022dcef11bSdrh */
42032dcef11bSdrh int sqlite3ExprCodeTemp(Parse *pParse, Expr *pExpr, int *pReg){
4204f30a969bSdrh   int r2;
42050d950af3Sdrh   pExpr = sqlite3ExprSkipCollateAndLikely(pExpr);
4206d9f158e7Sdrh   if( ConstFactorOk(pParse)
4207f30a969bSdrh    && pExpr->op!=TK_REGISTER
4208f30a969bSdrh    && sqlite3ExprIsConstantNotJoin(pExpr)
4209f30a969bSdrh   ){
4210f30a969bSdrh     *pReg  = 0;
4211ad879ffdSdrh     r2 = sqlite3ExprCodeAtInit(pParse, pExpr, -1);
4212f30a969bSdrh   }else{
42132dcef11bSdrh     int r1 = sqlite3GetTempReg(pParse);
4214f30a969bSdrh     r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
42152dcef11bSdrh     if( r2==r1 ){
42162dcef11bSdrh       *pReg = r1;
42172dcef11bSdrh     }else{
42182dcef11bSdrh       sqlite3ReleaseTempReg(pParse, r1);
42192dcef11bSdrh       *pReg = 0;
42202dcef11bSdrh     }
4221f30a969bSdrh   }
42222dcef11bSdrh   return r2;
42232dcef11bSdrh }
42242dcef11bSdrh 
42252dcef11bSdrh /*
42262dcef11bSdrh ** Generate code that will evaluate expression pExpr and store the
42272dcef11bSdrh ** results in register target.  The results are guaranteed to appear
42282dcef11bSdrh ** in register target.
42292dcef11bSdrh */
423005a86c5cSdrh void sqlite3ExprCode(Parse *pParse, Expr *pExpr, int target){
42319cbf3425Sdrh   int inReg;
42329cbf3425Sdrh 
42339cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
4234ebc16717Sdrh   if( pExpr && pExpr->op==TK_REGISTER ){
4235ebc16717Sdrh     sqlite3VdbeAddOp2(pParse->pVdbe, OP_Copy, pExpr->iTable, target);
4236ebc16717Sdrh   }else{
42379cbf3425Sdrh     inReg = sqlite3ExprCodeTarget(pParse, pExpr, target);
42381c75c9d7Sdrh     assert( pParse->pVdbe!=0 || pParse->db->mallocFailed );
42390e359b30Sdrh     if( inReg!=target && pParse->pVdbe ){
42409cbf3425Sdrh       sqlite3VdbeAddOp2(pParse->pVdbe, OP_SCopy, inReg, target);
424117a7f8ddSdrh     }
4242ebc16717Sdrh   }
4243cce7d176Sdrh }
4244cce7d176Sdrh 
4245cce7d176Sdrh /*
42461c75c9d7Sdrh ** Make a transient copy of expression pExpr and then code it using
42471c75c9d7Sdrh ** sqlite3ExprCode().  This routine works just like sqlite3ExprCode()
42481c75c9d7Sdrh ** except that the input expression is guaranteed to be unchanged.
42491c75c9d7Sdrh */
42501c75c9d7Sdrh void sqlite3ExprCodeCopy(Parse *pParse, Expr *pExpr, int target){
42511c75c9d7Sdrh   sqlite3 *db = pParse->db;
42521c75c9d7Sdrh   pExpr = sqlite3ExprDup(db, pExpr, 0);
42531c75c9d7Sdrh   if( !db->mallocFailed ) sqlite3ExprCode(pParse, pExpr, target);
42541c75c9d7Sdrh   sqlite3ExprDelete(db, pExpr);
42551c75c9d7Sdrh }
42561c75c9d7Sdrh 
42571c75c9d7Sdrh /*
425805a86c5cSdrh ** Generate code that will evaluate expression pExpr and store the
425905a86c5cSdrh ** results in register target.  The results are guaranteed to appear
426005a86c5cSdrh ** in register target.  If the expression is constant, then this routine
426105a86c5cSdrh ** might choose to code the expression at initialization time.
426205a86c5cSdrh */
426305a86c5cSdrh void sqlite3ExprCodeFactorable(Parse *pParse, Expr *pExpr, int target){
4264b8b06690Sdrh   if( pParse->okConstFactor && sqlite3ExprIsConstantNotJoin(pExpr) ){
4265ad879ffdSdrh     sqlite3ExprCodeAtInit(pParse, pExpr, target);
426605a86c5cSdrh   }else{
426705a86c5cSdrh     sqlite3ExprCode(pParse, pExpr, target);
426805a86c5cSdrh   }
4269cce7d176Sdrh }
4270cce7d176Sdrh 
4271cce7d176Sdrh /*
427260ec914cSpeter.d.reid ** Generate code that evaluates the given expression and puts the result
4273de4fcfddSdrh ** in register target.
427425303780Sdrh **
42752dcef11bSdrh ** Also make a copy of the expression results into another "cache" register
42762dcef11bSdrh ** and modify the expression so that the next time it is evaluated,
42772dcef11bSdrh ** the result is a copy of the cache register.
42782dcef11bSdrh **
42792dcef11bSdrh ** This routine is used for expressions that are used multiple
42802dcef11bSdrh ** times.  They are evaluated once and the results of the expression
42812dcef11bSdrh ** are reused.
428225303780Sdrh */
428305a86c5cSdrh void sqlite3ExprCodeAndCache(Parse *pParse, Expr *pExpr, int target){
428425303780Sdrh   Vdbe *v = pParse->pVdbe;
428525303780Sdrh   int iMem;
428605a86c5cSdrh 
428705a86c5cSdrh   assert( target>0 );
428805a86c5cSdrh   assert( pExpr->op!=TK_REGISTER );
428905a86c5cSdrh   sqlite3ExprCode(pParse, pExpr, target);
42902dcef11bSdrh   iMem = ++pParse->nMem;
429105a86c5cSdrh   sqlite3VdbeAddOp2(v, OP_Copy, target, iMem);
4292a4c3c87eSdrh   exprToRegister(pExpr, iMem);
429325303780Sdrh }
42947e02e5e6Sdrh 
4295678ccce8Sdrh /*
4296268380caSdrh ** Generate code that pushes the value of every element of the given
42979cbf3425Sdrh ** expression list into a sequence of registers beginning at target.
4298268380caSdrh **
42993df6c3b1Sdrh ** Return the number of elements evaluated.  The number returned will
43003df6c3b1Sdrh ** usually be pList->nExpr but might be reduced if SQLITE_ECEL_OMITREF
43013df6c3b1Sdrh ** is defined.
4302d1a01edaSdrh **
4303d1a01edaSdrh ** The SQLITE_ECEL_DUP flag prevents the arguments from being
4304d1a01edaSdrh ** filled using OP_SCopy.  OP_Copy must be used instead.
4305d1a01edaSdrh **
4306d1a01edaSdrh ** The SQLITE_ECEL_FACTOR argument allows constant arguments to be
4307d1a01edaSdrh ** factored out into initialization code.
4308b0df9634Sdrh **
4309b0df9634Sdrh ** The SQLITE_ECEL_REF flag means that expressions in the list with
4310b0df9634Sdrh ** ExprList.a[].u.x.iOrderByCol>0 have already been evaluated and stored
4311b0df9634Sdrh ** in registers at srcReg, and so the value can be copied from there.
43123df6c3b1Sdrh ** If SQLITE_ECEL_OMITREF is also set, then the values with u.x.iOrderByCol>0
43133df6c3b1Sdrh ** are simply omitted rather than being copied from srcReg.
4314268380caSdrh */
43154adee20fSdanielk1977 int sqlite3ExprCodeExprList(
4316268380caSdrh   Parse *pParse,     /* Parsing context */
4317389a1adbSdrh   ExprList *pList,   /* The expression list to be coded */
4318191b54cbSdrh   int target,        /* Where to write results */
43195579d59fSdrh   int srcReg,        /* Source registers if SQLITE_ECEL_REF */
4320d1a01edaSdrh   u8 flags           /* SQLITE_ECEL_* flags */
4321268380caSdrh ){
4322268380caSdrh   struct ExprList_item *pItem;
43235579d59fSdrh   int i, j, n;
4324d1a01edaSdrh   u8 copyOp = (flags & SQLITE_ECEL_DUP) ? OP_Copy : OP_SCopy;
43255579d59fSdrh   Vdbe *v = pParse->pVdbe;
43269d8b3072Sdrh   assert( pList!=0 );
43279cbf3425Sdrh   assert( target>0 );
4328d81a142bSdrh   assert( pParse->pVdbe!=0 );  /* Never gets this far otherwise */
4329268380caSdrh   n = pList->nExpr;
4330d9f158e7Sdrh   if( !ConstFactorOk(pParse) ) flags &= ~SQLITE_ECEL_FACTOR;
4331191b54cbSdrh   for(pItem=pList->a, i=0; i<n; i++, pItem++){
43327445ffe2Sdrh     Expr *pExpr = pItem->pExpr;
433324e25d32Sdan #ifdef SQLITE_ENABLE_SORTER_REFERENCES
433424e25d32Sdan     if( pItem->bSorterRef ){
433524e25d32Sdan       i--;
433624e25d32Sdan       n--;
433724e25d32Sdan     }else
433824e25d32Sdan #endif
4339257c13faSdan     if( (flags & SQLITE_ECEL_REF)!=0 && (j = pItem->u.x.iOrderByCol)>0 ){
4340257c13faSdan       if( flags & SQLITE_ECEL_OMITREF ){
4341257c13faSdan         i--;
4342257c13faSdan         n--;
4343257c13faSdan       }else{
43445579d59fSdrh         sqlite3VdbeAddOp2(v, copyOp, j+srcReg-1, target+i);
4345257c13faSdan       }
4346b8b06690Sdrh     }else if( (flags & SQLITE_ECEL_FACTOR)!=0
4347b8b06690Sdrh            && sqlite3ExprIsConstantNotJoin(pExpr)
4348b8b06690Sdrh     ){
4349ad879ffdSdrh       sqlite3ExprCodeAtInit(pParse, pExpr, target+i);
4350d1a01edaSdrh     }else{
43517445ffe2Sdrh       int inReg = sqlite3ExprCodeTarget(pParse, pExpr, target+i);
4352746fd9ccSdrh       if( inReg!=target+i ){
43534eded604Sdrh         VdbeOp *pOp;
43544eded604Sdrh         if( copyOp==OP_Copy
43554eded604Sdrh          && (pOp=sqlite3VdbeGetOp(v, -1))->opcode==OP_Copy
43564eded604Sdrh          && pOp->p1+pOp->p3+1==inReg
43574eded604Sdrh          && pOp->p2+pOp->p3+1==target+i
43584eded604Sdrh         ){
43594eded604Sdrh           pOp->p3++;
43604eded604Sdrh         }else{
43614eded604Sdrh           sqlite3VdbeAddOp2(v, copyOp, inReg, target+i);
43624eded604Sdrh         }
4363d1a01edaSdrh       }
4364d176611bSdrh     }
4365268380caSdrh   }
4366f9b596ebSdrh   return n;
4367268380caSdrh }
4368268380caSdrh 
4369268380caSdrh /*
437036c563a2Sdrh ** Generate code for a BETWEEN operator.
437136c563a2Sdrh **
437236c563a2Sdrh **    x BETWEEN y AND z
437336c563a2Sdrh **
437436c563a2Sdrh ** The above is equivalent to
437536c563a2Sdrh **
437636c563a2Sdrh **    x>=y AND x<=z
437736c563a2Sdrh **
437836c563a2Sdrh ** Code it as such, taking care to do the common subexpression
437960ec914cSpeter.d.reid ** elimination of x.
438084b19a3dSdrh **
438184b19a3dSdrh ** The xJumpIf parameter determines details:
438284b19a3dSdrh **
438384b19a3dSdrh **    NULL:                   Store the boolean result in reg[dest]
438484b19a3dSdrh **    sqlite3ExprIfTrue:      Jump to dest if true
438584b19a3dSdrh **    sqlite3ExprIfFalse:     Jump to dest if false
438684b19a3dSdrh **
438784b19a3dSdrh ** The jumpIfNull parameter is ignored if xJumpIf is NULL.
438836c563a2Sdrh */
438936c563a2Sdrh static void exprCodeBetween(
439036c563a2Sdrh   Parse *pParse,    /* Parsing and code generating context */
439136c563a2Sdrh   Expr *pExpr,      /* The BETWEEN expression */
439284b19a3dSdrh   int dest,         /* Jump destination or storage location */
439384b19a3dSdrh   void (*xJump)(Parse*,Expr*,int,int), /* Action to take */
439436c563a2Sdrh   int jumpIfNull    /* Take the jump if the BETWEEN is NULL */
439536c563a2Sdrh ){
439636c563a2Sdrh   Expr exprAnd;     /* The AND operator in  x>=y AND x<=z  */
439736c563a2Sdrh   Expr compLeft;    /* The  x>=y  term */
439836c563a2Sdrh   Expr compRight;   /* The  x<=z  term */
4399db45bd5eSdrh   int regFree1 = 0; /* Temporary use register */
44008b65e591Sdan   Expr *pDel = 0;
44018b65e591Sdan   sqlite3 *db = pParse->db;
440284b19a3dSdrh 
440371c57db0Sdan   memset(&compLeft, 0, sizeof(Expr));
440471c57db0Sdan   memset(&compRight, 0, sizeof(Expr));
440571c57db0Sdan   memset(&exprAnd, 0, sizeof(Expr));
4406db45bd5eSdrh 
4407db45bd5eSdrh   assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
44088b65e591Sdan   pDel = sqlite3ExprDup(db, pExpr->pLeft, 0);
44098b65e591Sdan   if( db->mallocFailed==0 ){
441036c563a2Sdrh     exprAnd.op = TK_AND;
441136c563a2Sdrh     exprAnd.pLeft = &compLeft;
441236c563a2Sdrh     exprAnd.pRight = &compRight;
441336c563a2Sdrh     compLeft.op = TK_GE;
44148b65e591Sdan     compLeft.pLeft = pDel;
441536c563a2Sdrh     compLeft.pRight = pExpr->x.pList->a[0].pExpr;
441636c563a2Sdrh     compRight.op = TK_LE;
44178b65e591Sdan     compRight.pLeft = pDel;
441836c563a2Sdrh     compRight.pRight = pExpr->x.pList->a[1].pExpr;
44198b65e591Sdan     exprToRegister(pDel, exprCodeVector(pParse, pDel, &regFree1));
442084b19a3dSdrh     if( xJump ){
442184b19a3dSdrh       xJump(pParse, &exprAnd, dest, jumpIfNull);
442236c563a2Sdrh     }else{
442336fd41e5Sdrh       /* Mark the expression is being from the ON or USING clause of a join
442436fd41e5Sdrh       ** so that the sqlite3ExprCodeTarget() routine will not attempt to move
442536fd41e5Sdrh       ** it into the Parse.pConstExpr list.  We should use a new bit for this,
442636fd41e5Sdrh       ** for clarity, but we are out of bits in the Expr.flags field so we
442736fd41e5Sdrh       ** have to reuse the EP_FromJoin bit.  Bummer. */
44288b65e591Sdan       pDel->flags |= EP_FromJoin;
442971c57db0Sdan       sqlite3ExprCodeTarget(pParse, &exprAnd, dest);
443036c563a2Sdrh     }
4431db45bd5eSdrh     sqlite3ReleaseTempReg(pParse, regFree1);
44328b65e591Sdan   }
44338b65e591Sdan   sqlite3ExprDelete(db, pDel);
443436c563a2Sdrh 
443536c563a2Sdrh   /* Ensure adequate test coverage */
4436db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull==0 && regFree1==0 );
4437db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull==0 && regFree1!=0 );
4438db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull!=0 && regFree1==0 );
4439db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull!=0 && regFree1!=0 );
4440db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1==0 );
4441db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1!=0 );
4442db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1==0 );
4443db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1!=0 );
444484b19a3dSdrh   testcase( xJump==0 );
444536c563a2Sdrh }
444636c563a2Sdrh 
444736c563a2Sdrh /*
4448cce7d176Sdrh ** Generate code for a boolean expression such that a jump is made
4449cce7d176Sdrh ** to the label "dest" if the expression is true but execution
4450cce7d176Sdrh ** continues straight thru if the expression is false.
4451f5905aa7Sdrh **
4452f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false), then
445335573356Sdrh ** take the jump if the jumpIfNull flag is SQLITE_JUMPIFNULL.
4454f2bc013cSdrh **
4455f2bc013cSdrh ** This code depends on the fact that certain token values (ex: TK_EQ)
4456f2bc013cSdrh ** are the same as opcode values (ex: OP_Eq) that implement the corresponding
4457f2bc013cSdrh ** operation.  Special comments in vdbe.c and the mkopcodeh.awk script in
4458f2bc013cSdrh ** the make process cause these values to align.  Assert()s in the code
4459f2bc013cSdrh ** below verify that the numbers are aligned correctly.
4460cce7d176Sdrh */
44614adee20fSdanielk1977 void sqlite3ExprIfTrue(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
4462cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
4463cce7d176Sdrh   int op = 0;
44642dcef11bSdrh   int regFree1 = 0;
44652dcef11bSdrh   int regFree2 = 0;
44662dcef11bSdrh   int r1, r2;
44672dcef11bSdrh 
446835573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
446948864df9Smistachkin   if( NEVER(v==0) )     return;  /* Existence of VDBE checked by caller */
447033cd4909Sdrh   if( NEVER(pExpr==0) ) return;  /* No way this can happen */
4471f2bc013cSdrh   op = pExpr->op;
44727b35a77bSdan   switch( op ){
447317180fcaSdrh     case TK_AND:
447417180fcaSdrh     case TK_OR: {
447517180fcaSdrh       Expr *pAlt = sqlite3ExprSimplifiedAndOr(pExpr);
447617180fcaSdrh       if( pAlt!=pExpr ){
447717180fcaSdrh         sqlite3ExprIfTrue(pParse, pAlt, dest, jumpIfNull);
447817180fcaSdrh       }else if( op==TK_AND ){
4479ec4ccdbcSdrh         int d2 = sqlite3VdbeMakeLabel(pParse);
4480c5499befSdrh         testcase( jumpIfNull==0 );
448117180fcaSdrh         sqlite3ExprIfFalse(pParse, pExpr->pLeft, d2,
448217180fcaSdrh                            jumpIfNull^SQLITE_JUMPIFNULL);
44834adee20fSdanielk1977         sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
44844adee20fSdanielk1977         sqlite3VdbeResolveLabel(v, d2);
448517180fcaSdrh       }else{
4486c5499befSdrh         testcase( jumpIfNull==0 );
44874adee20fSdanielk1977         sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
44884adee20fSdanielk1977         sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
448917180fcaSdrh       }
4490cce7d176Sdrh       break;
4491cce7d176Sdrh     }
4492cce7d176Sdrh     case TK_NOT: {
4493c5499befSdrh       testcase( jumpIfNull==0 );
44944adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
4495cce7d176Sdrh       break;
4496cce7d176Sdrh     }
44978abed7b9Sdrh     case TK_TRUTH: {
449896acafbeSdrh       int isNot;      /* IS NOT TRUE or IS NOT FALSE */
449996acafbeSdrh       int isTrue;     /* IS TRUE or IS NOT TRUE */
4500007c843bSdrh       testcase( jumpIfNull==0 );
45018abed7b9Sdrh       isNot = pExpr->op2==TK_ISNOT;
450296acafbeSdrh       isTrue = sqlite3ExprTruthValue(pExpr->pRight);
450343c4ac8bSdrh       testcase( isTrue && isNot );
450496acafbeSdrh       testcase( !isTrue && isNot );
450543c4ac8bSdrh       if( isTrue ^ isNot ){
45068abed7b9Sdrh         sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
45078abed7b9Sdrh                           isNot ? SQLITE_JUMPIFNULL : 0);
45088abed7b9Sdrh       }else{
45098abed7b9Sdrh         sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
45108abed7b9Sdrh                            isNot ? SQLITE_JUMPIFNULL : 0);
45118abed7b9Sdrh       }
4512007c843bSdrh       break;
4513007c843bSdrh     }
4514de845c2fSdrh     case TK_IS:
4515de845c2fSdrh     case TK_ISNOT:
4516de845c2fSdrh       testcase( op==TK_IS );
4517de845c2fSdrh       testcase( op==TK_ISNOT );
4518de845c2fSdrh       op = (op==TK_IS) ? TK_EQ : TK_NE;
4519de845c2fSdrh       jumpIfNull = SQLITE_NULLEQ;
4520de845c2fSdrh       /* Fall thru */
4521cce7d176Sdrh     case TK_LT:
4522cce7d176Sdrh     case TK_LE:
4523cce7d176Sdrh     case TK_GT:
4524cce7d176Sdrh     case TK_GE:
4525cce7d176Sdrh     case TK_NE:
45260ac65892Sdrh     case TK_EQ: {
4527625015e0Sdan       if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
4528c5499befSdrh       testcase( jumpIfNull==0 );
4529b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4530b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
453135573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
45322dcef11bSdrh                   r1, r2, dest, jumpIfNull);
45337d176105Sdrh       assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
45347d176105Sdrh       assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
45357d176105Sdrh       assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
45367d176105Sdrh       assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
4537de845c2fSdrh       assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4538de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4539de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4540de845c2fSdrh       assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4541de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
4542de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
45436a2fe093Sdrh       testcase( regFree1==0 );
45446a2fe093Sdrh       testcase( regFree2==0 );
45456a2fe093Sdrh       break;
45466a2fe093Sdrh     }
4547cce7d176Sdrh     case TK_ISNULL:
4548cce7d176Sdrh     case TK_NOTNULL: {
45497d176105Sdrh       assert( TK_ISNULL==OP_IsNull );   testcase( op==TK_ISNULL );
45507d176105Sdrh       assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
45512dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
45522dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
45537d176105Sdrh       VdbeCoverageIf(v, op==TK_ISNULL);
45547d176105Sdrh       VdbeCoverageIf(v, op==TK_NOTNULL);
4555c5499befSdrh       testcase( regFree1==0 );
4556cce7d176Sdrh       break;
4557cce7d176Sdrh     }
4558fef5208cSdrh     case TK_BETWEEN: {
45595c03f30aSdrh       testcase( jumpIfNull==0 );
456071c57db0Sdan       exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfTrue, jumpIfNull);
4561fef5208cSdrh       break;
4562fef5208cSdrh     }
4563bb201344Sshaneh #ifndef SQLITE_OMIT_SUBQUERY
4564e3365e6cSdrh     case TK_IN: {
4565ec4ccdbcSdrh       int destIfFalse = sqlite3VdbeMakeLabel(pParse);
4566e3365e6cSdrh       int destIfNull = jumpIfNull ? dest : destIfFalse;
4567e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
4568076e85f5Sdrh       sqlite3VdbeGoto(v, dest);
4569e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
4570e3365e6cSdrh       break;
4571e3365e6cSdrh     }
4572bb201344Sshaneh #endif
4573cce7d176Sdrh     default: {
45747b35a77bSdan     default_expr:
4575ad31727fSdrh       if( ExprAlwaysTrue(pExpr) ){
4576076e85f5Sdrh         sqlite3VdbeGoto(v, dest);
4577ad31727fSdrh       }else if( ExprAlwaysFalse(pExpr) ){
4578991a1985Sdrh         /* No-op */
4579991a1985Sdrh       }else{
45802dcef11bSdrh         r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
45812dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_If, r1, dest, jumpIfNull!=0);
4582688852abSdrh         VdbeCoverage(v);
4583c5499befSdrh         testcase( regFree1==0 );
4584c5499befSdrh         testcase( jumpIfNull==0 );
4585991a1985Sdrh       }
4586cce7d176Sdrh       break;
4587cce7d176Sdrh     }
4588cce7d176Sdrh   }
45892dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
45902dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
4591cce7d176Sdrh }
4592cce7d176Sdrh 
4593cce7d176Sdrh /*
459466b89c8fSdrh ** Generate code for a boolean expression such that a jump is made
4595cce7d176Sdrh ** to the label "dest" if the expression is false but execution
4596cce7d176Sdrh ** continues straight thru if the expression is true.
4597f5905aa7Sdrh **
4598f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false) then
459935573356Sdrh ** jump if jumpIfNull is SQLITE_JUMPIFNULL or fall through if jumpIfNull
460035573356Sdrh ** is 0.
4601cce7d176Sdrh */
46024adee20fSdanielk1977 void sqlite3ExprIfFalse(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
4603cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
4604cce7d176Sdrh   int op = 0;
46052dcef11bSdrh   int regFree1 = 0;
46062dcef11bSdrh   int regFree2 = 0;
46072dcef11bSdrh   int r1, r2;
46082dcef11bSdrh 
460935573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
461048864df9Smistachkin   if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
461133cd4909Sdrh   if( pExpr==0 )    return;
4612f2bc013cSdrh 
4613f2bc013cSdrh   /* The value of pExpr->op and op are related as follows:
4614f2bc013cSdrh   **
4615f2bc013cSdrh   **       pExpr->op            op
4616f2bc013cSdrh   **       ---------          ----------
4617f2bc013cSdrh   **       TK_ISNULL          OP_NotNull
4618f2bc013cSdrh   **       TK_NOTNULL         OP_IsNull
4619f2bc013cSdrh   **       TK_NE              OP_Eq
4620f2bc013cSdrh   **       TK_EQ              OP_Ne
4621f2bc013cSdrh   **       TK_GT              OP_Le
4622f2bc013cSdrh   **       TK_LE              OP_Gt
4623f2bc013cSdrh   **       TK_GE              OP_Lt
4624f2bc013cSdrh   **       TK_LT              OP_Ge
4625f2bc013cSdrh   **
4626f2bc013cSdrh   ** For other values of pExpr->op, op is undefined and unused.
4627f2bc013cSdrh   ** The value of TK_ and OP_ constants are arranged such that we
4628f2bc013cSdrh   ** can compute the mapping above using the following expression.
4629f2bc013cSdrh   ** Assert()s verify that the computation is correct.
4630f2bc013cSdrh   */
4631f2bc013cSdrh   op = ((pExpr->op+(TK_ISNULL&1))^1)-(TK_ISNULL&1);
4632f2bc013cSdrh 
4633f2bc013cSdrh   /* Verify correct alignment of TK_ and OP_ constants
4634f2bc013cSdrh   */
4635f2bc013cSdrh   assert( pExpr->op!=TK_ISNULL || op==OP_NotNull );
4636f2bc013cSdrh   assert( pExpr->op!=TK_NOTNULL || op==OP_IsNull );
4637f2bc013cSdrh   assert( pExpr->op!=TK_NE || op==OP_Eq );
4638f2bc013cSdrh   assert( pExpr->op!=TK_EQ || op==OP_Ne );
4639f2bc013cSdrh   assert( pExpr->op!=TK_LT || op==OP_Ge );
4640f2bc013cSdrh   assert( pExpr->op!=TK_LE || op==OP_Gt );
4641f2bc013cSdrh   assert( pExpr->op!=TK_GT || op==OP_Le );
4642f2bc013cSdrh   assert( pExpr->op!=TK_GE || op==OP_Lt );
4643f2bc013cSdrh 
4644ba00e30aSdan   switch( pExpr->op ){
464517180fcaSdrh     case TK_AND:
464617180fcaSdrh     case TK_OR: {
464717180fcaSdrh       Expr *pAlt = sqlite3ExprSimplifiedAndOr(pExpr);
464817180fcaSdrh       if( pAlt!=pExpr ){
464917180fcaSdrh         sqlite3ExprIfFalse(pParse, pAlt, dest, jumpIfNull);
465017180fcaSdrh       }else if( pExpr->op==TK_AND ){
4651c5499befSdrh         testcase( jumpIfNull==0 );
46524adee20fSdanielk1977         sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
46534adee20fSdanielk1977         sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
465417180fcaSdrh       }else{
4655ec4ccdbcSdrh         int d2 = sqlite3VdbeMakeLabel(pParse);
4656c5499befSdrh         testcase( jumpIfNull==0 );
465717180fcaSdrh         sqlite3ExprIfTrue(pParse, pExpr->pLeft, d2,
465817180fcaSdrh                           jumpIfNull^SQLITE_JUMPIFNULL);
46594adee20fSdanielk1977         sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
46604adee20fSdanielk1977         sqlite3VdbeResolveLabel(v, d2);
466117180fcaSdrh       }
4662cce7d176Sdrh       break;
4663cce7d176Sdrh     }
4664cce7d176Sdrh     case TK_NOT: {
46655c03f30aSdrh       testcase( jumpIfNull==0 );
46664adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
4667cce7d176Sdrh       break;
4668cce7d176Sdrh     }
46698abed7b9Sdrh     case TK_TRUTH: {
467096acafbeSdrh       int isNot;   /* IS NOT TRUE or IS NOT FALSE */
467196acafbeSdrh       int isTrue;  /* IS TRUE or IS NOT TRUE */
46728abed7b9Sdrh       testcase( jumpIfNull==0 );
46738abed7b9Sdrh       isNot = pExpr->op2==TK_ISNOT;
467496acafbeSdrh       isTrue = sqlite3ExprTruthValue(pExpr->pRight);
467543c4ac8bSdrh       testcase( isTrue && isNot );
467696acafbeSdrh       testcase( !isTrue && isNot );
467743c4ac8bSdrh       if( isTrue ^ isNot ){
46788abed7b9Sdrh         /* IS TRUE and IS NOT FALSE */
46798abed7b9Sdrh         sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
46808abed7b9Sdrh                            isNot ? 0 : SQLITE_JUMPIFNULL);
46818abed7b9Sdrh 
46828abed7b9Sdrh       }else{
46838abed7b9Sdrh         /* IS FALSE and IS NOT TRUE */
46848abed7b9Sdrh         sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
46858abed7b9Sdrh                           isNot ? 0 : SQLITE_JUMPIFNULL);
46868abed7b9Sdrh       }
4687007c843bSdrh       break;
4688007c843bSdrh     }
4689de845c2fSdrh     case TK_IS:
4690de845c2fSdrh     case TK_ISNOT:
4691de845c2fSdrh       testcase( pExpr->op==TK_IS );
4692de845c2fSdrh       testcase( pExpr->op==TK_ISNOT );
4693de845c2fSdrh       op = (pExpr->op==TK_IS) ? TK_NE : TK_EQ;
4694de845c2fSdrh       jumpIfNull = SQLITE_NULLEQ;
4695de845c2fSdrh       /* Fall thru */
4696cce7d176Sdrh     case TK_LT:
4697cce7d176Sdrh     case TK_LE:
4698cce7d176Sdrh     case TK_GT:
4699cce7d176Sdrh     case TK_GE:
4700cce7d176Sdrh     case TK_NE:
4701cce7d176Sdrh     case TK_EQ: {
4702625015e0Sdan       if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
4703c5499befSdrh       testcase( jumpIfNull==0 );
4704b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4705b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
470635573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
47072dcef11bSdrh                   r1, r2, dest, jumpIfNull);
47087d176105Sdrh       assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
47097d176105Sdrh       assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
47107d176105Sdrh       assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
47117d176105Sdrh       assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
4712de845c2fSdrh       assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4713de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4714de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4715de845c2fSdrh       assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4716de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
4717de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
47186a2fe093Sdrh       testcase( regFree1==0 );
47196a2fe093Sdrh       testcase( regFree2==0 );
47206a2fe093Sdrh       break;
47216a2fe093Sdrh     }
4722cce7d176Sdrh     case TK_ISNULL:
4723cce7d176Sdrh     case TK_NOTNULL: {
47242dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
47252dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
47267d176105Sdrh       testcase( op==TK_ISNULL );   VdbeCoverageIf(v, op==TK_ISNULL);
47277d176105Sdrh       testcase( op==TK_NOTNULL );  VdbeCoverageIf(v, op==TK_NOTNULL);
4728c5499befSdrh       testcase( regFree1==0 );
4729cce7d176Sdrh       break;
4730cce7d176Sdrh     }
4731fef5208cSdrh     case TK_BETWEEN: {
47325c03f30aSdrh       testcase( jumpIfNull==0 );
473371c57db0Sdan       exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfFalse, jumpIfNull);
4734fef5208cSdrh       break;
4735fef5208cSdrh     }
4736bb201344Sshaneh #ifndef SQLITE_OMIT_SUBQUERY
4737e3365e6cSdrh     case TK_IN: {
4738e3365e6cSdrh       if( jumpIfNull ){
4739e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, dest);
4740e3365e6cSdrh       }else{
4741ec4ccdbcSdrh         int destIfNull = sqlite3VdbeMakeLabel(pParse);
4742e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, destIfNull);
4743e3365e6cSdrh         sqlite3VdbeResolveLabel(v, destIfNull);
4744e3365e6cSdrh       }
4745e3365e6cSdrh       break;
4746e3365e6cSdrh     }
4747bb201344Sshaneh #endif
4748cce7d176Sdrh     default: {
4749ba00e30aSdan     default_expr:
4750ad31727fSdrh       if( ExprAlwaysFalse(pExpr) ){
4751076e85f5Sdrh         sqlite3VdbeGoto(v, dest);
4752ad31727fSdrh       }else if( ExprAlwaysTrue(pExpr) ){
4753991a1985Sdrh         /* no-op */
4754991a1985Sdrh       }else{
47552dcef11bSdrh         r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
47562dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_IfNot, r1, dest, jumpIfNull!=0);
4757688852abSdrh         VdbeCoverage(v);
4758c5499befSdrh         testcase( regFree1==0 );
4759c5499befSdrh         testcase( jumpIfNull==0 );
4760991a1985Sdrh       }
4761cce7d176Sdrh       break;
4762cce7d176Sdrh     }
4763cce7d176Sdrh   }
47642dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
47652dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
4766cce7d176Sdrh }
47672282792aSdrh 
47682282792aSdrh /*
476972bc8208Sdrh ** Like sqlite3ExprIfFalse() except that a copy is made of pExpr before
477072bc8208Sdrh ** code generation, and that copy is deleted after code generation. This
477172bc8208Sdrh ** ensures that the original pExpr is unchanged.
477272bc8208Sdrh */
477372bc8208Sdrh void sqlite3ExprIfFalseDup(Parse *pParse, Expr *pExpr, int dest,int jumpIfNull){
477472bc8208Sdrh   sqlite3 *db = pParse->db;
477572bc8208Sdrh   Expr *pCopy = sqlite3ExprDup(db, pExpr, 0);
477672bc8208Sdrh   if( db->mallocFailed==0 ){
477772bc8208Sdrh     sqlite3ExprIfFalse(pParse, pCopy, dest, jumpIfNull);
477872bc8208Sdrh   }
477972bc8208Sdrh   sqlite3ExprDelete(db, pCopy);
478072bc8208Sdrh }
478172bc8208Sdrh 
47825aa550cfSdan /*
47835aa550cfSdan ** Expression pVar is guaranteed to be an SQL variable. pExpr may be any
47845aa550cfSdan ** type of expression.
47855aa550cfSdan **
47865aa550cfSdan ** If pExpr is a simple SQL value - an integer, real, string, blob
47875aa550cfSdan ** or NULL value - then the VDBE currently being prepared is configured
47885aa550cfSdan ** to re-prepare each time a new value is bound to variable pVar.
47895aa550cfSdan **
47905aa550cfSdan ** Additionally, if pExpr is a simple SQL value and the value is the
47915aa550cfSdan ** same as that currently bound to variable pVar, non-zero is returned.
47925aa550cfSdan ** Otherwise, if the values are not the same or if pExpr is not a simple
47935aa550cfSdan ** SQL value, zero is returned.
47945aa550cfSdan */
47955aa550cfSdan static int exprCompareVariable(Parse *pParse, Expr *pVar, Expr *pExpr){
47965aa550cfSdan   int res = 0;
4797c0804226Sdrh   int iVar;
4798c0804226Sdrh   sqlite3_value *pL, *pR = 0;
47995aa550cfSdan 
48005aa550cfSdan   sqlite3ValueFromExpr(pParse->db, pExpr, SQLITE_UTF8, SQLITE_AFF_BLOB, &pR);
4801c0804226Sdrh   if( pR ){
4802c0804226Sdrh     iVar = pVar->iColumn;
4803c0804226Sdrh     sqlite3VdbeSetVarmask(pParse->pVdbe, iVar);
4804c0804226Sdrh     pL = sqlite3VdbeGetBoundValue(pParse->pReprepare, iVar, SQLITE_AFF_BLOB);
48055aa307e2Sdrh     if( pL ){
48065aa307e2Sdrh       if( sqlite3_value_type(pL)==SQLITE_TEXT ){
48075aa307e2Sdrh         sqlite3_value_text(pL); /* Make sure the encoding is UTF-8 */
48085aa307e2Sdrh       }
48095aa307e2Sdrh       res =  0==sqlite3MemCompare(pL, pR, 0);
48105aa550cfSdan     }
48115aa550cfSdan     sqlite3ValueFree(pR);
48125aa550cfSdan     sqlite3ValueFree(pL);
48135aa550cfSdan   }
48145aa550cfSdan 
48155aa550cfSdan   return res;
48165aa550cfSdan }
481772bc8208Sdrh 
481872bc8208Sdrh /*
48191d9da70aSdrh ** Do a deep comparison of two expression trees.  Return 0 if the two
48201d9da70aSdrh ** expressions are completely identical.  Return 1 if they differ only
48211d9da70aSdrh ** by a COLLATE operator at the top level.  Return 2 if there are differences
48221d9da70aSdrh ** other than the top-level COLLATE operator.
4823d40aab0eSdrh **
4824619a1305Sdrh ** If any subelement of pB has Expr.iTable==(-1) then it is allowed
4825619a1305Sdrh ** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
4826619a1305Sdrh **
482766518ca7Sdrh ** The pA side might be using TK_REGISTER.  If that is the case and pB is
482866518ca7Sdrh ** not using TK_REGISTER but is otherwise equivalent, then still return 0.
482966518ca7Sdrh **
48301d9da70aSdrh ** Sometimes this routine will return 2 even if the two expressions
4831d40aab0eSdrh ** really are equivalent.  If we cannot prove that the expressions are
48321d9da70aSdrh ** identical, we return 2 just to be safe.  So if this routine
48331d9da70aSdrh ** returns 2, then you do not really know for certain if the two
48341d9da70aSdrh ** expressions are the same.  But if you get a 0 or 1 return, then you
4835d40aab0eSdrh ** can be sure the expressions are the same.  In the places where
48361d9da70aSdrh ** this routine is used, it does not hurt to get an extra 2 - that
4837d40aab0eSdrh ** just might result in some slightly slower code.  But returning
48381d9da70aSdrh ** an incorrect 0 or 1 could lead to a malfunction.
48395aa550cfSdan **
4840c0804226Sdrh ** If pParse is not NULL then TK_VARIABLE terms in pA with bindings in
4841c0804226Sdrh ** pParse->pReprepare can be matched against literals in pB.  The
4842c0804226Sdrh ** pParse->pVdbe->expmask bitmask is updated for each variable referenced.
4843c0804226Sdrh ** If pParse is NULL (the normal case) then any TK_VARIABLE term in
4844c0804226Sdrh ** Argument pParse should normally be NULL. If it is not NULL and pA or
4845c0804226Sdrh ** pB causes a return value of 2.
48462282792aSdrh */
48475aa550cfSdan int sqlite3ExprCompare(Parse *pParse, Expr *pA, Expr *pB, int iTab){
484810d1edf0Sdrh   u32 combinedFlags;
48494b202ae2Sdanielk1977   if( pA==0 || pB==0 ){
48501d9da70aSdrh     return pB==pA ? 0 : 2;
48512282792aSdrh   }
48525aa550cfSdan   if( pParse && pA->op==TK_VARIABLE && exprCompareVariable(pParse, pA, pB) ){
48535aa550cfSdan     return 0;
48545aa550cfSdan   }
485510d1edf0Sdrh   combinedFlags = pA->flags | pB->flags;
485610d1edf0Sdrh   if( combinedFlags & EP_IntValue ){
485710d1edf0Sdrh     if( (pA->flags&pB->flags&EP_IntValue)!=0 && pA->u.iValue==pB->u.iValue ){
485810d1edf0Sdrh       return 0;
485910d1edf0Sdrh     }
48601d9da70aSdrh     return 2;
48616ab3a2ecSdanielk1977   }
486216dd3985Sdan   if( pA->op!=pB->op || pA->op==TK_RAISE ){
48635aa550cfSdan     if( pA->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA->pLeft,pB,iTab)<2 ){
4864ae80ddeaSdrh       return 1;
4865ae80ddeaSdrh     }
48665aa550cfSdan     if( pB->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA,pB->pLeft,iTab)<2 ){
4867ae80ddeaSdrh       return 1;
4868ae80ddeaSdrh     }
4869ae80ddeaSdrh     return 2;
4870ae80ddeaSdrh   }
48712edc5fd7Sdrh   if( pA->op!=TK_COLUMN && pA->op!=TK_AGG_COLUMN && pA->u.zToken ){
48724f9adee2Sdan     if( pA->op==TK_FUNCTION || pA->op==TK_AGG_FUNCTION ){
4873390b88a4Sdrh       if( sqlite3StrICmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
4874eda079cdSdrh #ifndef SQLITE_OMIT_WINDOWFUNC
48754f9adee2Sdan       assert( pA->op==pB->op );
48764f9adee2Sdan       if( ExprHasProperty(pA,EP_WinFunc)!=ExprHasProperty(pB,EP_WinFunc) ){
48774f9adee2Sdan         return 2;
48784f9adee2Sdan       }
4879eda079cdSdrh       if( ExprHasProperty(pA,EP_WinFunc) ){
48804f9adee2Sdan         if( sqlite3WindowCompare(pParse, pA->y.pWin, pB->y.pWin, 1)!=0 ){
48814f9adee2Sdan           return 2;
48824f9adee2Sdan         }
4883eda079cdSdrh       }
4884eda079cdSdrh #endif
4885f20bbc5fSdrh     }else if( pA->op==TK_NULL ){
4886f20bbc5fSdrh       return 0;
4887d5af5420Sdrh     }else if( pA->op==TK_COLLATE ){
4888e79f6299Sdrh       if( sqlite3_stricmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
4889f20bbc5fSdrh     }else if( ALWAYS(pB->u.zToken!=0) && strcmp(pA->u.zToken,pB->u.zToken)!=0 ){
4890d5af5420Sdrh       return 2;
489110d1edf0Sdrh     }
489210d1edf0Sdrh   }
489310d1edf0Sdrh   if( (pA->flags & EP_Distinct)!=(pB->flags & EP_Distinct) ) return 2;
489489b6de03Sdrh   if( (combinedFlags & EP_TokenOnly)==0 ){
489510d1edf0Sdrh     if( combinedFlags & EP_xIsSelect ) return 2;
4896efad2e23Sdrh     if( (combinedFlags & EP_FixedCol)==0
4897efad2e23Sdrh      && sqlite3ExprCompare(pParse, pA->pLeft, pB->pLeft, iTab) ) return 2;
48985aa550cfSdan     if( sqlite3ExprCompare(pParse, pA->pRight, pB->pRight, iTab) ) return 2;
4899619a1305Sdrh     if( sqlite3ExprListCompare(pA->x.pList, pB->x.pList, iTab) ) return 2;
490003c5c213Sdrh     if( pA->op!=TK_STRING
490103c5c213Sdrh      && pA->op!=TK_TRUEFALSE
490203c5c213Sdrh      && (combinedFlags & EP_Reduced)==0
490303c5c213Sdrh     ){
4904619a1305Sdrh       if( pA->iColumn!=pB->iColumn ) return 2;
49058ac02a94Sdan       if( pA->op2!=pB->op2 ) return 2;
490666518ca7Sdrh       if( pA->iTable!=pB->iTable
490785f8aa79Sdrh        && (pA->iTable!=iTab || NEVER(pB->iTable>=0)) ) return 2;
49081d9da70aSdrh     }
49091d9da70aSdrh   }
49102646da7eSdrh   return 0;
49112646da7eSdrh }
49122282792aSdrh 
49138c6f666bSdrh /*
49148c6f666bSdrh ** Compare two ExprList objects.  Return 0 if they are identical and
49158c6f666bSdrh ** non-zero if they differ in any way.
49168c6f666bSdrh **
4917619a1305Sdrh ** If any subelement of pB has Expr.iTable==(-1) then it is allowed
4918619a1305Sdrh ** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
4919619a1305Sdrh **
49208c6f666bSdrh ** This routine might return non-zero for equivalent ExprLists.  The
49218c6f666bSdrh ** only consequence will be disabled optimizations.  But this routine
49228c6f666bSdrh ** must never return 0 if the two ExprList objects are different, or
49238c6f666bSdrh ** a malfunction will result.
49248c6f666bSdrh **
49258c6f666bSdrh ** Two NULL pointers are considered to be the same.  But a NULL pointer
49268c6f666bSdrh ** always differs from a non-NULL pointer.
49278c6f666bSdrh */
4928619a1305Sdrh int sqlite3ExprListCompare(ExprList *pA, ExprList *pB, int iTab){
49298c6f666bSdrh   int i;
49308c6f666bSdrh   if( pA==0 && pB==0 ) return 0;
49318c6f666bSdrh   if( pA==0 || pB==0 ) return 1;
49328c6f666bSdrh   if( pA->nExpr!=pB->nExpr ) return 1;
49338c6f666bSdrh   for(i=0; i<pA->nExpr; i++){
49348c6f666bSdrh     Expr *pExprA = pA->a[i].pExpr;
49358c6f666bSdrh     Expr *pExprB = pB->a[i].pExpr;
49368c6f666bSdrh     if( pA->a[i].sortOrder!=pB->a[i].sortOrder ) return 1;
49375aa550cfSdan     if( sqlite3ExprCompare(0, pExprA, pExprB, iTab) ) return 1;
49388c6f666bSdrh   }
49398c6f666bSdrh   return 0;
49408c6f666bSdrh }
494113449892Sdrh 
49422282792aSdrh /*
4943f9463dfbSdrh ** Like sqlite3ExprCompare() except COLLATE operators at the top-level
4944f9463dfbSdrh ** are ignored.
4945f9463dfbSdrh */
4946f9463dfbSdrh int sqlite3ExprCompareSkip(Expr *pA, Expr *pB, int iTab){
49475aa550cfSdan   return sqlite3ExprCompare(0,
49480d950af3Sdrh              sqlite3ExprSkipCollateAndLikely(pA),
49490d950af3Sdrh              sqlite3ExprSkipCollateAndLikely(pB),
4950f9463dfbSdrh              iTab);
4951f9463dfbSdrh }
4952f9463dfbSdrh 
4953f9463dfbSdrh /*
4954c51cf864Sdrh ** Return non-zero if Expr p can only be true if pNN is not NULL.
4955c51cf864Sdrh */
4956c51cf864Sdrh static int exprImpliesNotNull(
4957c51cf864Sdrh   Parse *pParse,      /* Parsing context */
4958c51cf864Sdrh   Expr *p,            /* The expression to be checked */
4959c51cf864Sdrh   Expr *pNN,          /* The expression that is NOT NULL */
4960c51cf864Sdrh   int iTab,           /* Table being evaluated */
4961c51cf864Sdrh   int seenNot         /* True if p is an operand of NOT */
4962c51cf864Sdrh ){
4963c51cf864Sdrh   assert( p );
4964c51cf864Sdrh   assert( pNN );
496514c865e8Sdrh   if( sqlite3ExprCompare(pParse, p, pNN, iTab)==0 ){
496614c865e8Sdrh     return pNN->op!=TK_NULL;
496714c865e8Sdrh   }
4968c51cf864Sdrh   switch( p->op ){
4969c51cf864Sdrh     case TK_IN: {
4970c51cf864Sdrh       if( seenNot && ExprHasProperty(p, EP_xIsSelect) ) return 0;
4971c51cf864Sdrh       assert( ExprHasProperty(p,EP_xIsSelect)
4972c51cf864Sdrh            || (p->x.pList!=0 && p->x.pList->nExpr>0) );
4973c51cf864Sdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, seenNot);
4974c51cf864Sdrh     }
4975c51cf864Sdrh     case TK_BETWEEN: {
4976c51cf864Sdrh       ExprList *pList = p->x.pList;
4977c51cf864Sdrh       assert( pList!=0 );
4978c51cf864Sdrh       assert( pList->nExpr==2 );
4979c51cf864Sdrh       if( seenNot ) return 0;
4980c51cf864Sdrh       if( exprImpliesNotNull(pParse, pList->a[0].pExpr, pNN, iTab, seenNot)
4981c51cf864Sdrh        || exprImpliesNotNull(pParse, pList->a[1].pExpr, pNN, iTab, seenNot)
4982c51cf864Sdrh       ){
4983c51cf864Sdrh         return 1;
4984c51cf864Sdrh       }
4985c51cf864Sdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, seenNot);
4986c51cf864Sdrh     }
4987c51cf864Sdrh     case TK_EQ:
4988c51cf864Sdrh     case TK_NE:
4989c51cf864Sdrh     case TK_LT:
4990c51cf864Sdrh     case TK_LE:
4991c51cf864Sdrh     case TK_GT:
4992c51cf864Sdrh     case TK_GE:
4993c51cf864Sdrh     case TK_PLUS:
4994c51cf864Sdrh     case TK_MINUS:
4995c51cf864Sdrh     case TK_STAR:
4996c51cf864Sdrh     case TK_REM:
4997c51cf864Sdrh     case TK_BITAND:
4998c51cf864Sdrh     case TK_BITOR:
4999c51cf864Sdrh     case TK_SLASH:
5000c51cf864Sdrh     case TK_LSHIFT:
5001c51cf864Sdrh     case TK_RSHIFT:
5002c51cf864Sdrh     case TK_CONCAT: {
5003c51cf864Sdrh       if( exprImpliesNotNull(pParse, p->pRight, pNN, iTab, seenNot) ) return 1;
5004c51cf864Sdrh       /* Fall thru into the next case */
5005c51cf864Sdrh     }
5006c51cf864Sdrh     case TK_SPAN:
5007c51cf864Sdrh     case TK_COLLATE:
5008c51cf864Sdrh     case TK_BITNOT:
5009c51cf864Sdrh     case TK_UPLUS:
5010c51cf864Sdrh     case TK_UMINUS: {
5011c51cf864Sdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, seenNot);
5012c51cf864Sdrh     }
5013c51cf864Sdrh     case TK_TRUTH: {
5014c51cf864Sdrh       if( seenNot ) return 0;
5015c51cf864Sdrh       if( p->op2!=TK_IS ) return 0;
5016c51cf864Sdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, seenNot);
5017c51cf864Sdrh     }
5018c51cf864Sdrh     case TK_NOT: {
5019c51cf864Sdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
5020c51cf864Sdrh     }
5021c51cf864Sdrh   }
5022c51cf864Sdrh   return 0;
5023c51cf864Sdrh }
5024c51cf864Sdrh 
5025c51cf864Sdrh /*
50264bd5f73fSdrh ** Return true if we can prove the pE2 will always be true if pE1 is
50274bd5f73fSdrh ** true.  Return false if we cannot complete the proof or if pE2 might
50284bd5f73fSdrh ** be false.  Examples:
50294bd5f73fSdrh **
5030619a1305Sdrh **     pE1: x==5       pE2: x==5             Result: true
50314bd5f73fSdrh **     pE1: x>0        pE2: x==5             Result: false
5032619a1305Sdrh **     pE1: x=21       pE2: x=21 OR y=43     Result: true
50334bd5f73fSdrh **     pE1: x!=123     pE2: x IS NOT NULL    Result: true
5034619a1305Sdrh **     pE1: x!=?1      pE2: x IS NOT NULL    Result: true
5035619a1305Sdrh **     pE1: x IS NULL  pE2: x IS NOT NULL    Result: false
5036619a1305Sdrh **     pE1: x IS ?2    pE2: x IS NOT NULL    Reuslt: false
50374bd5f73fSdrh **
50384bd5f73fSdrh ** When comparing TK_COLUMN nodes between pE1 and pE2, if pE2 has
50394bd5f73fSdrh ** Expr.iTable<0 then assume a table number given by iTab.
50404bd5f73fSdrh **
5041c0804226Sdrh ** If pParse is not NULL, then the values of bound variables in pE1 are
5042c0804226Sdrh ** compared against literal values in pE2 and pParse->pVdbe->expmask is
5043c0804226Sdrh ** modified to record which bound variables are referenced.  If pParse
5044c0804226Sdrh ** is NULL, then false will be returned if pE1 contains any bound variables.
5045c0804226Sdrh **
50464bd5f73fSdrh ** When in doubt, return false.  Returning true might give a performance
50474bd5f73fSdrh ** improvement.  Returning false might cause a performance reduction, but
50484bd5f73fSdrh ** it will always give the correct answer and is hence always safe.
50494bd5f73fSdrh */
50505aa550cfSdan int sqlite3ExprImpliesExpr(Parse *pParse, Expr *pE1, Expr *pE2, int iTab){
50515aa550cfSdan   if( sqlite3ExprCompare(pParse, pE1, pE2, iTab)==0 ){
5052619a1305Sdrh     return 1;
5053619a1305Sdrh   }
5054619a1305Sdrh   if( pE2->op==TK_OR
50555aa550cfSdan    && (sqlite3ExprImpliesExpr(pParse, pE1, pE2->pLeft, iTab)
50565aa550cfSdan              || sqlite3ExprImpliesExpr(pParse, pE1, pE2->pRight, iTab) )
5057619a1305Sdrh   ){
5058619a1305Sdrh     return 1;
5059619a1305Sdrh   }
5060664d6d13Sdrh   if( pE2->op==TK_NOTNULL
5061c51cf864Sdrh    && exprImpliesNotNull(pParse, pE1, pE2->pLeft, iTab, 0)
5062664d6d13Sdrh   ){
5063c51cf864Sdrh     return 1;
5064619a1305Sdrh   }
5065619a1305Sdrh   return 0;
50664bd5f73fSdrh }
50674bd5f73fSdrh 
50684bd5f73fSdrh /*
50692589787cSdrh ** This is the Expr node callback for sqlite3ExprImpliesNotNullRow().
50702589787cSdrh ** If the expression node requires that the table at pWalker->iCur
5071f8937f90Sdrh ** have one or more non-NULL column, then set pWalker->eCode to 1 and abort.
5072f8937f90Sdrh **
5073f8937f90Sdrh ** This routine controls an optimization.  False positives (setting
5074f8937f90Sdrh ** pWalker->eCode to 1 when it should not be) are deadly, but false-negatives
5075f8937f90Sdrh ** (never setting pWalker->eCode) is a harmless missed optimization.
50762589787cSdrh */
50772589787cSdrh static int impliesNotNullRow(Walker *pWalker, Expr *pExpr){
5078f8937f90Sdrh   testcase( pExpr->op==TK_AGG_COLUMN );
5079821b610bSdrh   testcase( pExpr->op==TK_AGG_FUNCTION );
50802589787cSdrh   if( ExprHasProperty(pExpr, EP_FromJoin) ) return WRC_Prune;
50812589787cSdrh   switch( pExpr->op ){
50820493222fSdan     case TK_ISNOT:
5083a1054dccSdan     case TK_NOT:
50842589787cSdrh     case TK_ISNULL:
5085d5793672Sdrh     case TK_NOTNULL:
50862589787cSdrh     case TK_IS:
50872589787cSdrh     case TK_OR:
50882c492061Sdrh     case TK_CASE:
5089e3eff266Sdrh     case TK_IN:
50902589787cSdrh     case TK_FUNCTION:
50910493222fSdan       testcase( pExpr->op==TK_ISNOT );
50920493222fSdan       testcase( pExpr->op==TK_NOT );
5093821b610bSdrh       testcase( pExpr->op==TK_ISNULL );
5094d5793672Sdrh       testcase( pExpr->op==TK_NOTNULL );
5095821b610bSdrh       testcase( pExpr->op==TK_IS );
5096821b610bSdrh       testcase( pExpr->op==TK_OR );
5097821b610bSdrh       testcase( pExpr->op==TK_CASE );
5098821b610bSdrh       testcase( pExpr->op==TK_IN );
5099821b610bSdrh       testcase( pExpr->op==TK_FUNCTION );
51002589787cSdrh       return WRC_Prune;
51012589787cSdrh     case TK_COLUMN:
51022589787cSdrh       if( pWalker->u.iCur==pExpr->iTable ){
51032589787cSdrh         pWalker->eCode = 1;
51042589787cSdrh         return WRC_Abort;
51052589787cSdrh       }
51062589787cSdrh       return WRC_Prune;
51079881155dSdrh 
51089881155dSdrh     /* Virtual tables are allowed to use constraints like x=NULL.  So
51099881155dSdrh     ** a term of the form x=y does not prove that y is not null if x
51109881155dSdrh     ** is the column of a virtual table */
51119881155dSdrh     case TK_EQ:
51129881155dSdrh     case TK_NE:
51139881155dSdrh     case TK_LT:
51149881155dSdrh     case TK_LE:
51159881155dSdrh     case TK_GT:
51169881155dSdrh     case TK_GE:
51179881155dSdrh       testcase( pExpr->op==TK_EQ );
51189881155dSdrh       testcase( pExpr->op==TK_NE );
51199881155dSdrh       testcase( pExpr->op==TK_LT );
51209881155dSdrh       testcase( pExpr->op==TK_LE );
51219881155dSdrh       testcase( pExpr->op==TK_GT );
51229881155dSdrh       testcase( pExpr->op==TK_GE );
5123eda079cdSdrh       if( (pExpr->pLeft->op==TK_COLUMN && IsVirtual(pExpr->pLeft->y.pTab))
5124eda079cdSdrh        || (pExpr->pRight->op==TK_COLUMN && IsVirtual(pExpr->pRight->y.pTab))
51259881155dSdrh       ){
51269881155dSdrh        return WRC_Prune;
51279881155dSdrh       }
51282589787cSdrh     default:
51292589787cSdrh       return WRC_Continue;
51302589787cSdrh   }
51312589787cSdrh }
51322589787cSdrh 
51332589787cSdrh /*
51342589787cSdrh ** Return true (non-zero) if expression p can only be true if at least
51352589787cSdrh ** one column of table iTab is non-null.  In other words, return true
51362589787cSdrh ** if expression p will always be NULL or false if every column of iTab
51372589787cSdrh ** is NULL.
51382589787cSdrh **
5139821b610bSdrh ** False negatives are acceptable.  In other words, it is ok to return
5140821b610bSdrh ** zero even if expression p will never be true of every column of iTab
5141821b610bSdrh ** is NULL.  A false negative is merely a missed optimization opportunity.
5142821b610bSdrh **
5143821b610bSdrh ** False positives are not allowed, however.  A false positive may result
5144821b610bSdrh ** in an incorrect answer.
5145821b610bSdrh **
51462589787cSdrh ** Terms of p that are marked with EP_FromJoin (and hence that come from
51472589787cSdrh ** the ON or USING clauses of LEFT JOINS) are excluded from the analysis.
51482589787cSdrh **
51492589787cSdrh ** This routine is used to check if a LEFT JOIN can be converted into
51502589787cSdrh ** an ordinary JOIN.  The p argument is the WHERE clause.  If the WHERE
51512589787cSdrh ** clause requires that some column of the right table of the LEFT JOIN
51522589787cSdrh ** be non-NULL, then the LEFT JOIN can be safely converted into an
51532589787cSdrh ** ordinary join.
51542589787cSdrh */
51552589787cSdrh int sqlite3ExprImpliesNonNullRow(Expr *p, int iTab){
51562589787cSdrh   Walker w;
51570d950af3Sdrh   p = sqlite3ExprSkipCollateAndLikely(p);
5158d6db6598Sdrh   while( p ){
5159d6db6598Sdrh     if( p->op==TK_NOTNULL ){
5160d6db6598Sdrh       p = p->pLeft;
5161d6db6598Sdrh     }else if( p->op==TK_AND ){
5162d6db6598Sdrh       if( sqlite3ExprImpliesNonNullRow(p->pLeft, iTab) ) return 1;
5163d6db6598Sdrh       p = p->pRight;
5164d6db6598Sdrh     }else{
5165d6db6598Sdrh       break;
5166d6db6598Sdrh     }
5167d6db6598Sdrh   }
51682589787cSdrh   w.xExprCallback = impliesNotNullRow;
51692589787cSdrh   w.xSelectCallback = 0;
51702589787cSdrh   w.xSelectCallback2 = 0;
51712589787cSdrh   w.eCode = 0;
51722589787cSdrh   w.u.iCur = iTab;
51732589787cSdrh   sqlite3WalkExpr(&w, p);
51742589787cSdrh   return w.eCode;
51752589787cSdrh }
51762589787cSdrh 
51772589787cSdrh /*
5178030796dfSdrh ** An instance of the following structure is used by the tree walker
51792409f8a1Sdrh ** to determine if an expression can be evaluated by reference to the
51802409f8a1Sdrh ** index only, without having to do a search for the corresponding
51812409f8a1Sdrh ** table entry.  The IdxCover.pIdx field is the index.  IdxCover.iCur
51822409f8a1Sdrh ** is the cursor for the table.
51832409f8a1Sdrh */
51842409f8a1Sdrh struct IdxCover {
51852409f8a1Sdrh   Index *pIdx;     /* The index to be tested for coverage */
51862409f8a1Sdrh   int iCur;        /* Cursor number for the table corresponding to the index */
51872409f8a1Sdrh };
51882409f8a1Sdrh 
51892409f8a1Sdrh /*
51902409f8a1Sdrh ** Check to see if there are references to columns in table
51912409f8a1Sdrh ** pWalker->u.pIdxCover->iCur can be satisfied using the index
51922409f8a1Sdrh ** pWalker->u.pIdxCover->pIdx.
51932409f8a1Sdrh */
51942409f8a1Sdrh static int exprIdxCover(Walker *pWalker, Expr *pExpr){
51952409f8a1Sdrh   if( pExpr->op==TK_COLUMN
51962409f8a1Sdrh    && pExpr->iTable==pWalker->u.pIdxCover->iCur
51972409f8a1Sdrh    && sqlite3ColumnOfIndex(pWalker->u.pIdxCover->pIdx, pExpr->iColumn)<0
51982409f8a1Sdrh   ){
51992409f8a1Sdrh     pWalker->eCode = 1;
52002409f8a1Sdrh     return WRC_Abort;
52012409f8a1Sdrh   }
52022409f8a1Sdrh   return WRC_Continue;
52032409f8a1Sdrh }
52042409f8a1Sdrh 
52052409f8a1Sdrh /*
5206e604ec0bSdrh ** Determine if an index pIdx on table with cursor iCur contains will
5207e604ec0bSdrh ** the expression pExpr.  Return true if the index does cover the
5208e604ec0bSdrh ** expression and false if the pExpr expression references table columns
5209e604ec0bSdrh ** that are not found in the index pIdx.
52102409f8a1Sdrh **
52112409f8a1Sdrh ** An index covering an expression means that the expression can be
52122409f8a1Sdrh ** evaluated using only the index and without having to lookup the
52132409f8a1Sdrh ** corresponding table entry.
52142409f8a1Sdrh */
52152409f8a1Sdrh int sqlite3ExprCoveredByIndex(
52162409f8a1Sdrh   Expr *pExpr,        /* The index to be tested */
52172409f8a1Sdrh   int iCur,           /* The cursor number for the corresponding table */
52182409f8a1Sdrh   Index *pIdx         /* The index that might be used for coverage */
52192409f8a1Sdrh ){
52202409f8a1Sdrh   Walker w;
52212409f8a1Sdrh   struct IdxCover xcov;
52222409f8a1Sdrh   memset(&w, 0, sizeof(w));
52232409f8a1Sdrh   xcov.iCur = iCur;
52242409f8a1Sdrh   xcov.pIdx = pIdx;
52252409f8a1Sdrh   w.xExprCallback = exprIdxCover;
52262409f8a1Sdrh   w.u.pIdxCover = &xcov;
52272409f8a1Sdrh   sqlite3WalkExpr(&w, pExpr);
52282409f8a1Sdrh   return !w.eCode;
52292409f8a1Sdrh }
52302409f8a1Sdrh 
52312409f8a1Sdrh 
52322409f8a1Sdrh /*
52332409f8a1Sdrh ** An instance of the following structure is used by the tree walker
5234030796dfSdrh ** to count references to table columns in the arguments of an
5235ed551b95Sdrh ** aggregate function, in order to implement the
5236ed551b95Sdrh ** sqlite3FunctionThisSrc() routine.
5237374fdce4Sdrh */
5238030796dfSdrh struct SrcCount {
5239030796dfSdrh   SrcList *pSrc;   /* One particular FROM clause in a nested query */
5240030796dfSdrh   int nThis;       /* Number of references to columns in pSrcList */
5241030796dfSdrh   int nOther;      /* Number of references to columns in other FROM clauses */
5242030796dfSdrh };
5243030796dfSdrh 
5244030796dfSdrh /*
5245030796dfSdrh ** Count the number of references to columns.
5246030796dfSdrh */
5247030796dfSdrh static int exprSrcCount(Walker *pWalker, Expr *pExpr){
5248fb0a6081Sdrh   /* The NEVER() on the second term is because sqlite3FunctionUsesThisSrc()
5249fb0a6081Sdrh   ** is always called before sqlite3ExprAnalyzeAggregates() and so the
5250fb0a6081Sdrh   ** TK_COLUMNs have not yet been converted into TK_AGG_COLUMN.  If
5251fb0a6081Sdrh   ** sqlite3FunctionUsesThisSrc() is used differently in the future, the
5252fb0a6081Sdrh   ** NEVER() will need to be removed. */
5253fb0a6081Sdrh   if( pExpr->op==TK_COLUMN || NEVER(pExpr->op==TK_AGG_COLUMN) ){
5254374fdce4Sdrh     int i;
5255030796dfSdrh     struct SrcCount *p = pWalker->u.pSrcCount;
5256030796dfSdrh     SrcList *pSrc = p->pSrc;
5257655814d2Sdrh     int nSrc = pSrc ? pSrc->nSrc : 0;
5258655814d2Sdrh     for(i=0; i<nSrc; i++){
5259030796dfSdrh       if( pExpr->iTable==pSrc->a[i].iCursor ) break;
5260374fdce4Sdrh     }
5261655814d2Sdrh     if( i<nSrc ){
5262030796dfSdrh       p->nThis++;
5263374fdce4Sdrh     }else{
5264030796dfSdrh       p->nOther++;
5265374fdce4Sdrh     }
5266374fdce4Sdrh   }
5267030796dfSdrh   return WRC_Continue;
5268030796dfSdrh }
5269374fdce4Sdrh 
5270374fdce4Sdrh /*
5271030796dfSdrh ** Determine if any of the arguments to the pExpr Function reference
5272030796dfSdrh ** pSrcList.  Return true if they do.  Also return true if the function
5273030796dfSdrh ** has no arguments or has only constant arguments.  Return false if pExpr
5274030796dfSdrh ** references columns but not columns of tables found in pSrcList.
5275374fdce4Sdrh */
5276030796dfSdrh int sqlite3FunctionUsesThisSrc(Expr *pExpr, SrcList *pSrcList){
5277374fdce4Sdrh   Walker w;
5278030796dfSdrh   struct SrcCount cnt;
5279374fdce4Sdrh   assert( pExpr->op==TK_AGG_FUNCTION );
5280030796dfSdrh   w.xExprCallback = exprSrcCount;
5281979dd1beSdrh   w.xSelectCallback = 0;
5282030796dfSdrh   w.u.pSrcCount = &cnt;
5283030796dfSdrh   cnt.pSrc = pSrcList;
5284030796dfSdrh   cnt.nThis = 0;
5285030796dfSdrh   cnt.nOther = 0;
5286030796dfSdrh   sqlite3WalkExprList(&w, pExpr->x.pList);
5287030796dfSdrh   return cnt.nThis>0 || cnt.nOther==0;
5288374fdce4Sdrh }
5289374fdce4Sdrh 
5290374fdce4Sdrh /*
529113449892Sdrh ** Add a new element to the pAggInfo->aCol[] array.  Return the index of
529213449892Sdrh ** the new element.  Return a negative number if malloc fails.
52932282792aSdrh */
529417435752Sdrh static int addAggInfoColumn(sqlite3 *db, AggInfo *pInfo){
529513449892Sdrh   int i;
5296cf643729Sdrh   pInfo->aCol = sqlite3ArrayAllocate(
529717435752Sdrh        db,
5298cf643729Sdrh        pInfo->aCol,
5299cf643729Sdrh        sizeof(pInfo->aCol[0]),
5300cf643729Sdrh        &pInfo->nColumn,
5301cf643729Sdrh        &i
5302cf643729Sdrh   );
530313449892Sdrh   return i;
53042282792aSdrh }
530513449892Sdrh 
530613449892Sdrh /*
530713449892Sdrh ** Add a new element to the pAggInfo->aFunc[] array.  Return the index of
530813449892Sdrh ** the new element.  Return a negative number if malloc fails.
530913449892Sdrh */
531017435752Sdrh static int addAggInfoFunc(sqlite3 *db, AggInfo *pInfo){
531113449892Sdrh   int i;
5312cf643729Sdrh   pInfo->aFunc = sqlite3ArrayAllocate(
531317435752Sdrh        db,
5314cf643729Sdrh        pInfo->aFunc,
5315cf643729Sdrh        sizeof(pInfo->aFunc[0]),
5316cf643729Sdrh        &pInfo->nFunc,
5317cf643729Sdrh        &i
5318cf643729Sdrh   );
531913449892Sdrh   return i;
53202282792aSdrh }
53212282792aSdrh 
53222282792aSdrh /*
53237d10d5a6Sdrh ** This is the xExprCallback for a tree walker.  It is used to
53247d10d5a6Sdrh ** implement sqlite3ExprAnalyzeAggregates().  See sqlite3ExprAnalyzeAggregates
5325626a879aSdrh ** for additional information.
53262282792aSdrh */
53277d10d5a6Sdrh static int analyzeAggregate(Walker *pWalker, Expr *pExpr){
53282282792aSdrh   int i;
53297d10d5a6Sdrh   NameContext *pNC = pWalker->u.pNC;
5330a58fdfb1Sdanielk1977   Parse *pParse = pNC->pParse;
5331a58fdfb1Sdanielk1977   SrcList *pSrcList = pNC->pSrcList;
533225c3b8caSdrh   AggInfo *pAggInfo = pNC->uNC.pAggInfo;
533313449892Sdrh 
533425c3b8caSdrh   assert( pNC->ncFlags & NC_UAggInfo );
53352282792aSdrh   switch( pExpr->op ){
533689c69d00Sdrh     case TK_AGG_COLUMN:
5337967e8b73Sdrh     case TK_COLUMN: {
53388b213899Sdrh       testcase( pExpr->op==TK_AGG_COLUMN );
53398b213899Sdrh       testcase( pExpr->op==TK_COLUMN );
534013449892Sdrh       /* Check to see if the column is in one of the tables in the FROM
534113449892Sdrh       ** clause of the aggregate query */
534220bc393cSdrh       if( ALWAYS(pSrcList!=0) ){
534313449892Sdrh         struct SrcList_item *pItem = pSrcList->a;
534413449892Sdrh         for(i=0; i<pSrcList->nSrc; i++, pItem++){
534513449892Sdrh           struct AggInfo_col *pCol;
5346c5cd1249Sdrh           assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
534713449892Sdrh           if( pExpr->iTable==pItem->iCursor ){
534813449892Sdrh             /* If we reach this point, it means that pExpr refers to a table
534913449892Sdrh             ** that is in the FROM clause of the aggregate query.
535013449892Sdrh             **
535113449892Sdrh             ** Make an entry for the column in pAggInfo->aCol[] if there
535213449892Sdrh             ** is not an entry there already.
535313449892Sdrh             */
53547f906d63Sdrh             int k;
535513449892Sdrh             pCol = pAggInfo->aCol;
53567f906d63Sdrh             for(k=0; k<pAggInfo->nColumn; k++, pCol++){
535713449892Sdrh               if( pCol->iTable==pExpr->iTable &&
535813449892Sdrh                   pCol->iColumn==pExpr->iColumn ){
53592282792aSdrh                 break;
53602282792aSdrh               }
53612282792aSdrh             }
53621e536953Sdanielk1977             if( (k>=pAggInfo->nColumn)
53631e536953Sdanielk1977              && (k = addAggInfoColumn(pParse->db, pAggInfo))>=0
53641e536953Sdanielk1977             ){
53657f906d63Sdrh               pCol = &pAggInfo->aCol[k];
5366eda079cdSdrh               pCol->pTab = pExpr->y.pTab;
536713449892Sdrh               pCol->iTable = pExpr->iTable;
536813449892Sdrh               pCol->iColumn = pExpr->iColumn;
53690a07c107Sdrh               pCol->iMem = ++pParse->nMem;
537013449892Sdrh               pCol->iSorterColumn = -1;
53715774b806Sdrh               pCol->pExpr = pExpr;
537213449892Sdrh               if( pAggInfo->pGroupBy ){
537313449892Sdrh                 int j, n;
537413449892Sdrh                 ExprList *pGB = pAggInfo->pGroupBy;
537513449892Sdrh                 struct ExprList_item *pTerm = pGB->a;
537613449892Sdrh                 n = pGB->nExpr;
537713449892Sdrh                 for(j=0; j<n; j++, pTerm++){
537813449892Sdrh                   Expr *pE = pTerm->pExpr;
537913449892Sdrh                   if( pE->op==TK_COLUMN && pE->iTable==pExpr->iTable &&
538013449892Sdrh                       pE->iColumn==pExpr->iColumn ){
538113449892Sdrh                     pCol->iSorterColumn = j;
538213449892Sdrh                     break;
53832282792aSdrh                   }
538413449892Sdrh                 }
538513449892Sdrh               }
538613449892Sdrh               if( pCol->iSorterColumn<0 ){
538713449892Sdrh                 pCol->iSorterColumn = pAggInfo->nSortingColumn++;
538813449892Sdrh               }
538913449892Sdrh             }
539013449892Sdrh             /* There is now an entry for pExpr in pAggInfo->aCol[] (either
539113449892Sdrh             ** because it was there before or because we just created it).
539213449892Sdrh             ** Convert the pExpr to be a TK_AGG_COLUMN referring to that
539313449892Sdrh             ** pAggInfo->aCol[] entry.
539413449892Sdrh             */
5395ebb6a65dSdrh             ExprSetVVAProperty(pExpr, EP_NoReduce);
539613449892Sdrh             pExpr->pAggInfo = pAggInfo;
539713449892Sdrh             pExpr->op = TK_AGG_COLUMN;
5398cf697396Sshane             pExpr->iAgg = (i16)k;
539913449892Sdrh             break;
540013449892Sdrh           } /* endif pExpr->iTable==pItem->iCursor */
540113449892Sdrh         } /* end loop over pSrcList */
5402a58fdfb1Sdanielk1977       }
54037d10d5a6Sdrh       return WRC_Prune;
54042282792aSdrh     }
54052282792aSdrh     case TK_AGG_FUNCTION: {
54063a8c4be7Sdrh       if( (pNC->ncFlags & NC_InAggFunc)==0
5407ed551b95Sdrh        && pWalker->walkerDepth==pExpr->op2
54083a8c4be7Sdrh       ){
540913449892Sdrh         /* Check to see if pExpr is a duplicate of another aggregate
541013449892Sdrh         ** function that is already in the pAggInfo structure
541113449892Sdrh         */
541213449892Sdrh         struct AggInfo_func *pItem = pAggInfo->aFunc;
541313449892Sdrh         for(i=0; i<pAggInfo->nFunc; i++, pItem++){
54145aa550cfSdan           if( sqlite3ExprCompare(0, pItem->pExpr, pExpr, -1)==0 ){
54152282792aSdrh             break;
54162282792aSdrh           }
54172282792aSdrh         }
541813449892Sdrh         if( i>=pAggInfo->nFunc ){
541913449892Sdrh           /* pExpr is original.  Make a new entry in pAggInfo->aFunc[]
542013449892Sdrh           */
542114db2665Sdanielk1977           u8 enc = ENC(pParse->db);
54221e536953Sdanielk1977           i = addAggInfoFunc(pParse->db, pAggInfo);
542313449892Sdrh           if( i>=0 ){
54246ab3a2ecSdanielk1977             assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
542513449892Sdrh             pItem = &pAggInfo->aFunc[i];
542613449892Sdrh             pItem->pExpr = pExpr;
54270a07c107Sdrh             pItem->iMem = ++pParse->nMem;
542833e619fcSdrh             assert( !ExprHasProperty(pExpr, EP_IntValue) );
542913449892Sdrh             pItem->pFunc = sqlite3FindFunction(pParse->db,
543080738d9cSdrh                    pExpr->u.zToken,
54316ab3a2ecSdanielk1977                    pExpr->x.pList ? pExpr->x.pList->nExpr : 0, enc, 0);
5432fd357974Sdrh             if( pExpr->flags & EP_Distinct ){
5433fd357974Sdrh               pItem->iDistinct = pParse->nTab++;
5434fd357974Sdrh             }else{
5435fd357974Sdrh               pItem->iDistinct = -1;
5436fd357974Sdrh             }
54372282792aSdrh           }
543813449892Sdrh         }
543913449892Sdrh         /* Make pExpr point to the appropriate pAggInfo->aFunc[] entry
544013449892Sdrh         */
5441c5cd1249Sdrh         assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
5442ebb6a65dSdrh         ExprSetVVAProperty(pExpr, EP_NoReduce);
5443cf697396Sshane         pExpr->iAgg = (i16)i;
544413449892Sdrh         pExpr->pAggInfo = pAggInfo;
54453a8c4be7Sdrh         return WRC_Prune;
54466e83a57fSdrh       }else{
54476e83a57fSdrh         return WRC_Continue;
54486e83a57fSdrh       }
54492282792aSdrh     }
5450a58fdfb1Sdanielk1977   }
54517d10d5a6Sdrh   return WRC_Continue;
54527d10d5a6Sdrh }
54537d10d5a6Sdrh static int analyzeAggregatesInSelect(Walker *pWalker, Select *pSelect){
5454d5a336efSdrh   UNUSED_PARAMETER(pSelect);
5455979dd1beSdrh   pWalker->walkerDepth++;
54567d10d5a6Sdrh   return WRC_Continue;
5457a58fdfb1Sdanielk1977 }
5458979dd1beSdrh static void analyzeAggregatesInSelectEnd(Walker *pWalker, Select *pSelect){
5459979dd1beSdrh   UNUSED_PARAMETER(pSelect);
5460979dd1beSdrh   pWalker->walkerDepth--;
5461979dd1beSdrh }
5462626a879aSdrh 
5463626a879aSdrh /*
5464e8abb4caSdrh ** Analyze the pExpr expression looking for aggregate functions and
5465e8abb4caSdrh ** for variables that need to be added to AggInfo object that pNC->pAggInfo
5466e8abb4caSdrh ** points to.  Additional entries are made on the AggInfo object as
5467e8abb4caSdrh ** necessary.
5468626a879aSdrh **
5469626a879aSdrh ** This routine should only be called after the expression has been
54707d10d5a6Sdrh ** analyzed by sqlite3ResolveExprNames().
5471626a879aSdrh */
5472d2b3e23bSdrh void sqlite3ExprAnalyzeAggregates(NameContext *pNC, Expr *pExpr){
54737d10d5a6Sdrh   Walker w;
54747d10d5a6Sdrh   w.xExprCallback = analyzeAggregate;
54757d10d5a6Sdrh   w.xSelectCallback = analyzeAggregatesInSelect;
5476979dd1beSdrh   w.xSelectCallback2 = analyzeAggregatesInSelectEnd;
5477979dd1beSdrh   w.walkerDepth = 0;
54787d10d5a6Sdrh   w.u.pNC = pNC;
5479d9995031Sdan   w.pParse = 0;
548020bc393cSdrh   assert( pNC->pSrcList!=0 );
54817d10d5a6Sdrh   sqlite3WalkExpr(&w, pExpr);
54822282792aSdrh }
54835d9a4af9Sdrh 
54845d9a4af9Sdrh /*
54855d9a4af9Sdrh ** Call sqlite3ExprAnalyzeAggregates() for every expression in an
54865d9a4af9Sdrh ** expression list.  Return the number of errors.
54875d9a4af9Sdrh **
54885d9a4af9Sdrh ** If an error is found, the analysis is cut short.
54895d9a4af9Sdrh */
5490d2b3e23bSdrh void sqlite3ExprAnalyzeAggList(NameContext *pNC, ExprList *pList){
54915d9a4af9Sdrh   struct ExprList_item *pItem;
54925d9a4af9Sdrh   int i;
54935d9a4af9Sdrh   if( pList ){
5494d2b3e23bSdrh     for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
5495d2b3e23bSdrh       sqlite3ExprAnalyzeAggregates(pNC, pItem->pExpr);
54965d9a4af9Sdrh     }
54975d9a4af9Sdrh   }
54985d9a4af9Sdrh }
5499892d3179Sdrh 
5500892d3179Sdrh /*
5501ceea3321Sdrh ** Allocate a single new register for use to hold some intermediate result.
5502892d3179Sdrh */
5503892d3179Sdrh int sqlite3GetTempReg(Parse *pParse){
5504e55cbd72Sdrh   if( pParse->nTempReg==0 ){
5505892d3179Sdrh     return ++pParse->nMem;
5506892d3179Sdrh   }
55072f425f6bSdanielk1977   return pParse->aTempReg[--pParse->nTempReg];
5508892d3179Sdrh }
5509ceea3321Sdrh 
5510ceea3321Sdrh /*
5511ceea3321Sdrh ** Deallocate a register, making available for reuse for some other
5512ceea3321Sdrh ** purpose.
5513ceea3321Sdrh */
5514892d3179Sdrh void sqlite3ReleaseTempReg(Parse *pParse, int iReg){
55152dcef11bSdrh   if( iReg && pParse->nTempReg<ArraySize(pParse->aTempReg) ){
5516892d3179Sdrh     pParse->aTempReg[pParse->nTempReg++] = iReg;
5517892d3179Sdrh   }
5518892d3179Sdrh }
5519892d3179Sdrh 
5520892d3179Sdrh /*
5521ed24da4bSdrh ** Allocate or deallocate a block of nReg consecutive registers.
5522892d3179Sdrh */
5523892d3179Sdrh int sqlite3GetTempRange(Parse *pParse, int nReg){
5524e55cbd72Sdrh   int i, n;
5525ed24da4bSdrh   if( nReg==1 ) return sqlite3GetTempReg(pParse);
5526892d3179Sdrh   i = pParse->iRangeReg;
5527e55cbd72Sdrh   n = pParse->nRangeReg;
5528f49f3523Sdrh   if( nReg<=n ){
5529892d3179Sdrh     pParse->iRangeReg += nReg;
5530892d3179Sdrh     pParse->nRangeReg -= nReg;
5531892d3179Sdrh   }else{
5532892d3179Sdrh     i = pParse->nMem+1;
5533892d3179Sdrh     pParse->nMem += nReg;
5534892d3179Sdrh   }
5535892d3179Sdrh   return i;
5536892d3179Sdrh }
5537892d3179Sdrh void sqlite3ReleaseTempRange(Parse *pParse, int iReg, int nReg){
5538ed24da4bSdrh   if( nReg==1 ){
5539ed24da4bSdrh     sqlite3ReleaseTempReg(pParse, iReg);
5540ed24da4bSdrh     return;
5541ed24da4bSdrh   }
5542892d3179Sdrh   if( nReg>pParse->nRangeReg ){
5543892d3179Sdrh     pParse->nRangeReg = nReg;
5544892d3179Sdrh     pParse->iRangeReg = iReg;
5545892d3179Sdrh   }
5546892d3179Sdrh }
5547cdc69557Sdrh 
5548cdc69557Sdrh /*
5549cdc69557Sdrh ** Mark all temporary registers as being unavailable for reuse.
5550cdc69557Sdrh */
5551cdc69557Sdrh void sqlite3ClearTempRegCache(Parse *pParse){
5552cdc69557Sdrh   pParse->nTempReg = 0;
5553cdc69557Sdrh   pParse->nRangeReg = 0;
5554cdc69557Sdrh }
5555bb9b5f26Sdrh 
5556bb9b5f26Sdrh /*
5557bb9b5f26Sdrh ** Validate that no temporary register falls within the range of
5558bb9b5f26Sdrh ** iFirst..iLast, inclusive.  This routine is only call from within assert()
5559bb9b5f26Sdrh ** statements.
5560bb9b5f26Sdrh */
5561bb9b5f26Sdrh #ifdef SQLITE_DEBUG
5562bb9b5f26Sdrh int sqlite3NoTempsInRange(Parse *pParse, int iFirst, int iLast){
5563bb9b5f26Sdrh   int i;
5564bb9b5f26Sdrh   if( pParse->nRangeReg>0
55653963e584Sdrh    && pParse->iRangeReg+pParse->nRangeReg > iFirst
55663963e584Sdrh    && pParse->iRangeReg <= iLast
5567bb9b5f26Sdrh   ){
5568bb9b5f26Sdrh      return 0;
5569bb9b5f26Sdrh   }
5570bb9b5f26Sdrh   for(i=0; i<pParse->nTempReg; i++){
5571bb9b5f26Sdrh     if( pParse->aTempReg[i]>=iFirst && pParse->aTempReg[i]<=iLast ){
5572bb9b5f26Sdrh       return 0;
5573bb9b5f26Sdrh     }
5574bb9b5f26Sdrh   }
5575bb9b5f26Sdrh   return 1;
5576bb9b5f26Sdrh }
5577bb9b5f26Sdrh #endif /* SQLITE_DEBUG */
5578