xref: /sqlite-3.40.0/src/expr.c (revision 0287c951)
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;
47a7d6db6aSdrh   while( ExprHasProperty(pExpr, EP_Skip) ){
48a7d6db6aSdrh     assert( pExpr->op==TK_COLLATE );
49a7d6db6aSdrh     pExpr = pExpr->pLeft;
50a7d6db6aSdrh     assert( pExpr!=0 );
51a7d6db6aSdrh   }
52580c8c18Sdrh   op = pExpr->op;
53487e262fSdrh   if( op==TK_SELECT ){
546ab3a2ecSdanielk1977     assert( pExpr->flags&EP_xIsSelect );
556ab3a2ecSdanielk1977     return sqlite3ExprAffinity(pExpr->x.pSelect->pEList->a[0].pExpr);
56a37cdde0Sdanielk1977   }
57db45bd5eSdrh   if( op==TK_REGISTER ) op = pExpr->op2;
58487e262fSdrh #ifndef SQLITE_OMIT_CAST
59487e262fSdrh   if( op==TK_CAST ){
6033e619fcSdrh     assert( !ExprHasProperty(pExpr, EP_IntValue) );
61fdaac671Sdrh     return sqlite3AffinityType(pExpr->u.zToken, 0);
62487e262fSdrh   }
63487e262fSdrh #endif
64eda079cdSdrh   if( (op==TK_AGG_COLUMN || op==TK_COLUMN) && pExpr->y.pTab ){
65eda079cdSdrh     return sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
667d10d5a6Sdrh   }
6780aa5453Sdan   if( op==TK_SELECT_COLUMN ){
6880aa5453Sdan     assert( pExpr->pLeft->flags&EP_xIsSelect );
6980aa5453Sdan     return sqlite3ExprAffinity(
7080aa5453Sdan         pExpr->pLeft->x.pSelect->pEList->a[pExpr->iColumn].pExpr
7180aa5453Sdan     );
7280aa5453Sdan   }
731194904bSdrh   return pExpr->affExpr;
74a37cdde0Sdanielk1977 }
75a37cdde0Sdanielk1977 
7653db1458Sdrh /*
778b4c40d8Sdrh ** Set the collating sequence for expression pExpr to be the collating
78ae80ddeaSdrh ** sequence named by pToken.   Return a pointer to a new Expr node that
79ae80ddeaSdrh ** implements the COLLATE operator.
800a8a406eSdrh **
810a8a406eSdrh ** If a memory allocation error occurs, that fact is recorded in pParse->db
820a8a406eSdrh ** and the pExpr parameter is returned unchanged.
838b4c40d8Sdrh */
844ef7efadSdrh Expr *sqlite3ExprAddCollateToken(
854ef7efadSdrh   Parse *pParse,           /* Parsing context */
864ef7efadSdrh   Expr *pExpr,             /* Add the "COLLATE" clause to this expression */
8780103fc6Sdan   const Token *pCollName,  /* Name of collating sequence */
8880103fc6Sdan   int dequote              /* True to dequote pCollName */
894ef7efadSdrh ){
900a8a406eSdrh   if( pCollName->n>0 ){
9180103fc6Sdan     Expr *pNew = sqlite3ExprAlloc(pParse->db, TK_COLLATE, pCollName, dequote);
92ae80ddeaSdrh     if( pNew ){
93ae80ddeaSdrh       pNew->pLeft = pExpr;
94a4c3c87eSdrh       pNew->flags |= EP_Collate|EP_Skip;
950a8a406eSdrh       pExpr = pNew;
96ae80ddeaSdrh     }
970a8a406eSdrh   }
980a8a406eSdrh   return pExpr;
990a8a406eSdrh }
1000a8a406eSdrh Expr *sqlite3ExprAddCollateString(Parse *pParse, Expr *pExpr, const char *zC){
1010a8a406eSdrh   Token s;
102261d8a51Sdrh   assert( zC!=0 );
10340aced5cSdrh   sqlite3TokenInit(&s, (char*)zC);
10480103fc6Sdan   return sqlite3ExprAddCollateToken(pParse, pExpr, &s, 0);
1050a8a406eSdrh }
1060a8a406eSdrh 
1070a8a406eSdrh /*
1080d950af3Sdrh ** Skip over any TK_COLLATE operators.
1090a8a406eSdrh */
1100a8a406eSdrh Expr *sqlite3ExprSkipCollate(Expr *pExpr){
1110d950af3Sdrh   while( pExpr && ExprHasProperty(pExpr, EP_Skip) ){
1120d950af3Sdrh     assert( pExpr->op==TK_COLLATE );
1130d950af3Sdrh     pExpr = pExpr->pLeft;
1140d950af3Sdrh   }
1150d950af3Sdrh   return pExpr;
1160d950af3Sdrh }
1170d950af3Sdrh 
1180d950af3Sdrh /*
1190d950af3Sdrh ** Skip over any TK_COLLATE operators and/or any unlikely()
1200d950af3Sdrh ** or likelihood() or likely() functions at the root of an
1210d950af3Sdrh ** expression.
1220d950af3Sdrh */
1230d950af3Sdrh Expr *sqlite3ExprSkipCollateAndLikely(Expr *pExpr){
124a7d6db6aSdrh   while( pExpr && ExprHasProperty(pExpr, EP_Skip|EP_Unlikely) ){
125a4c3c87eSdrh     if( ExprHasProperty(pExpr, EP_Unlikely) ){
126cca9f3d2Sdrh       assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
127cca9f3d2Sdrh       assert( pExpr->x.pList->nExpr>0 );
128a4c3c87eSdrh       assert( pExpr->op==TK_FUNCTION );
129cca9f3d2Sdrh       pExpr = pExpr->x.pList->a[0].pExpr;
130cca9f3d2Sdrh     }else{
1310b8d255cSdrh       assert( pExpr->op==TK_COLLATE );
132d91eba96Sdrh       pExpr = pExpr->pLeft;
133cca9f3d2Sdrh     }
134d91eba96Sdrh   }
1350a8a406eSdrh   return pExpr;
1368b4c40d8Sdrh }
1378b4c40d8Sdrh 
1388b4c40d8Sdrh /*
139ae80ddeaSdrh ** Return the collation sequence for the expression pExpr. If
140ae80ddeaSdrh ** there is no defined collating sequence, return NULL.
141ae80ddeaSdrh **
14270efa84dSdrh ** See also: sqlite3ExprNNCollSeq()
14370efa84dSdrh **
14470efa84dSdrh ** The sqlite3ExprNNCollSeq() works the same exact that it returns the
14570efa84dSdrh ** default collation if pExpr has no defined collation.
14670efa84dSdrh **
147ae80ddeaSdrh ** The collating sequence might be determined by a COLLATE operator
148ae80ddeaSdrh ** or by the presence of a column with a defined collating sequence.
149ae80ddeaSdrh ** COLLATE operators take first precedence.  Left operands take
150ae80ddeaSdrh ** precedence over right operands.
1510202b29eSdanielk1977 */
1527cedc8d4Sdanielk1977 CollSeq *sqlite3ExprCollSeq(Parse *pParse, Expr *pExpr){
153ae80ddeaSdrh   sqlite3 *db = pParse->db;
1547cedc8d4Sdanielk1977   CollSeq *pColl = 0;
1557d10d5a6Sdrh   Expr *p = pExpr;
156261d8a51Sdrh   while( p ){
157ae80ddeaSdrh     int op = p->op;
158cb0e04f9Sdrh     if( op==TK_REGISTER ) op = p->op2;
159cb0e04f9Sdrh     if( (op==TK_AGG_COLUMN || op==TK_COLUMN || op==TK_TRIGGER)
160eda079cdSdrh      && p->y.pTab!=0
161ae80ddeaSdrh     ){
162eda079cdSdrh       /* op==TK_REGISTER && p->y.pTab!=0 happens when pExpr was originally
1637d10d5a6Sdrh       ** a TK_COLUMN but was previously evaluated and cached in a register */
1647d10d5a6Sdrh       int j = p->iColumn;
1657d10d5a6Sdrh       if( j>=0 ){
166eda079cdSdrh         const char *zColl = p->y.pTab->aCol[j].zColl;
167c4a64facSdrh         pColl = sqlite3FindCollSeq(db, ENC(db), zColl, 0);
1680202b29eSdanielk1977       }
1697d10d5a6Sdrh       break;
1707d10d5a6Sdrh     }
171e081d73cSdrh     if( op==TK_CAST || op==TK_UPLUS ){
172e081d73cSdrh       p = p->pLeft;
173e081d73cSdrh       continue;
174e081d73cSdrh     }
175cb0e04f9Sdrh     if( op==TK_COLLATE ){
176e081d73cSdrh       pColl = sqlite3GetCollSeq(pParse, ENC(db), 0, p->u.zToken);
177e081d73cSdrh       break;
178e081d73cSdrh     }
179ae80ddeaSdrh     if( p->flags & EP_Collate ){
1802308ed38Sdrh       if( p->pLeft && (p->pLeft->flags & EP_Collate)!=0 ){
1817d10d5a6Sdrh         p = p->pLeft;
182ae80ddeaSdrh       }else{
1832308ed38Sdrh         Expr *pNext  = p->pRight;
1846728cd91Sdrh         /* The Expr.x union is never used at the same time as Expr.pRight */
1856728cd91Sdrh         assert( p->x.pList==0 || p->pRight==0 );
1866728cd91Sdrh         /* p->flags holds EP_Collate and p->pLeft->flags does not.  And
1876728cd91Sdrh         ** p->x.pSelect cannot.  So if p->x.pLeft exists, it must hold at
1886728cd91Sdrh         ** least one EP_Collate. Thus the following two ALWAYS. */
18992a2824cSdrh         if( p->x.pList!=0
19092a2824cSdrh          && !db->mallocFailed
19192a2824cSdrh          && ALWAYS(!ExprHasProperty(p, EP_xIsSelect))
19292a2824cSdrh         ){
1932308ed38Sdrh           int i;
1946728cd91Sdrh           for(i=0; ALWAYS(i<p->x.pList->nExpr); i++){
1952308ed38Sdrh             if( ExprHasProperty(p->x.pList->a[i].pExpr, EP_Collate) ){
1962308ed38Sdrh               pNext = p->x.pList->a[i].pExpr;
1972308ed38Sdrh               break;
1982308ed38Sdrh             }
1992308ed38Sdrh           }
2002308ed38Sdrh         }
2012308ed38Sdrh         p = pNext;
202ae80ddeaSdrh       }
203ae80ddeaSdrh     }else{
204ae80ddeaSdrh       break;
205ae80ddeaSdrh     }
2060202b29eSdanielk1977   }
2077cedc8d4Sdanielk1977   if( sqlite3CheckCollSeq(pParse, pColl) ){
2087cedc8d4Sdanielk1977     pColl = 0;
2097cedc8d4Sdanielk1977   }
2107cedc8d4Sdanielk1977   return pColl;
2110202b29eSdanielk1977 }
2120202b29eSdanielk1977 
2130202b29eSdanielk1977 /*
21470efa84dSdrh ** Return the collation sequence for the expression pExpr. If
21570efa84dSdrh ** there is no defined collating sequence, return a pointer to the
21670efa84dSdrh ** defautl collation sequence.
21770efa84dSdrh **
21870efa84dSdrh ** See also: sqlite3ExprCollSeq()
21970efa84dSdrh **
22070efa84dSdrh ** The sqlite3ExprCollSeq() routine works the same except that it
22170efa84dSdrh ** returns NULL if there is no defined collation.
22270efa84dSdrh */
22370efa84dSdrh CollSeq *sqlite3ExprNNCollSeq(Parse *pParse, Expr *pExpr){
22470efa84dSdrh   CollSeq *p = sqlite3ExprCollSeq(pParse, pExpr);
22570efa84dSdrh   if( p==0 ) p = pParse->db->pDfltColl;
22670efa84dSdrh   assert( p!=0 );
22770efa84dSdrh   return p;
22870efa84dSdrh }
22970efa84dSdrh 
23070efa84dSdrh /*
23170efa84dSdrh ** Return TRUE if the two expressions have equivalent collating sequences.
23270efa84dSdrh */
23370efa84dSdrh int sqlite3ExprCollSeqMatch(Parse *pParse, Expr *pE1, Expr *pE2){
23470efa84dSdrh   CollSeq *pColl1 = sqlite3ExprNNCollSeq(pParse, pE1);
23570efa84dSdrh   CollSeq *pColl2 = sqlite3ExprNNCollSeq(pParse, pE2);
23670efa84dSdrh   return sqlite3StrICmp(pColl1->zName, pColl2->zName)==0;
23770efa84dSdrh }
23870efa84dSdrh 
23970efa84dSdrh /*
240626a879aSdrh ** pExpr is an operand of a comparison operator.  aff2 is the
241626a879aSdrh ** type affinity of the other operand.  This routine returns the
24253db1458Sdrh ** type affinity that should be used for the comparison operator.
24353db1458Sdrh */
244e014a838Sdanielk1977 char sqlite3CompareAffinity(Expr *pExpr, char aff2){
245bf3b721fSdanielk1977   char aff1 = sqlite3ExprAffinity(pExpr);
24696fb16eeSdrh   if( aff1>SQLITE_AFF_NONE && aff2>SQLITE_AFF_NONE ){
2478df447f0Sdrh     /* Both sides of the comparison are columns. If one has numeric
2488df447f0Sdrh     ** affinity, use that. Otherwise use no affinity.
249e014a838Sdanielk1977     */
2508a51256cSdrh     if( sqlite3IsNumericAffinity(aff1) || sqlite3IsNumericAffinity(aff2) ){
251e014a838Sdanielk1977       return SQLITE_AFF_NUMERIC;
252e014a838Sdanielk1977     }else{
25305883a34Sdrh       return SQLITE_AFF_BLOB;
254e014a838Sdanielk1977     }
255e014a838Sdanielk1977   }else{
256e014a838Sdanielk1977     /* One side is a column, the other is not. Use the columns affinity. */
25796fb16eeSdrh     assert( aff1<=SQLITE_AFF_NONE || aff2<=SQLITE_AFF_NONE );
25896fb16eeSdrh     return (aff1<=SQLITE_AFF_NONE ? aff2 : aff1) | SQLITE_AFF_NONE;
259e014a838Sdanielk1977   }
260e014a838Sdanielk1977 }
261e014a838Sdanielk1977 
26253db1458Sdrh /*
26353db1458Sdrh ** pExpr is a comparison operator.  Return the type affinity that should
26453db1458Sdrh ** be applied to both operands prior to doing the comparison.
26553db1458Sdrh */
266e014a838Sdanielk1977 static char comparisonAffinity(Expr *pExpr){
267e014a838Sdanielk1977   char aff;
268e014a838Sdanielk1977   assert( pExpr->op==TK_EQ || pExpr->op==TK_IN || pExpr->op==TK_LT ||
269e014a838Sdanielk1977           pExpr->op==TK_GT || pExpr->op==TK_GE || pExpr->op==TK_LE ||
2706a2fe093Sdrh           pExpr->op==TK_NE || pExpr->op==TK_IS || pExpr->op==TK_ISNOT );
271e014a838Sdanielk1977   assert( pExpr->pLeft );
272bf3b721fSdanielk1977   aff = sqlite3ExprAffinity(pExpr->pLeft);
273e014a838Sdanielk1977   if( pExpr->pRight ){
274e014a838Sdanielk1977     aff = sqlite3CompareAffinity(pExpr->pRight, aff);
2756ab3a2ecSdanielk1977   }else if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2766ab3a2ecSdanielk1977     aff = sqlite3CompareAffinity(pExpr->x.pSelect->pEList->a[0].pExpr, aff);
27713ac46eeSdrh   }else if( aff==0 ){
27805883a34Sdrh     aff = SQLITE_AFF_BLOB;
279e014a838Sdanielk1977   }
280e014a838Sdanielk1977   return aff;
281e014a838Sdanielk1977 }
282e014a838Sdanielk1977 
283e014a838Sdanielk1977 /*
284e014a838Sdanielk1977 ** pExpr is a comparison expression, eg. '=', '<', IN(...) etc.
285e014a838Sdanielk1977 ** idx_affinity is the affinity of an indexed column. Return true
286e014a838Sdanielk1977 ** if the index with affinity idx_affinity may be used to implement
287e014a838Sdanielk1977 ** the comparison in pExpr.
288e014a838Sdanielk1977 */
289e014a838Sdanielk1977 int sqlite3IndexAffinityOk(Expr *pExpr, char idx_affinity){
290e014a838Sdanielk1977   char aff = comparisonAffinity(pExpr);
291915e434cSdrh   if( aff<SQLITE_AFF_TEXT ){
2928a51256cSdrh     return 1;
2938a51256cSdrh   }
294915e434cSdrh   if( aff==SQLITE_AFF_TEXT ){
295915e434cSdrh     return idx_affinity==SQLITE_AFF_TEXT;
296915e434cSdrh   }
297915e434cSdrh   return sqlite3IsNumericAffinity(idx_affinity);
298e014a838Sdanielk1977 }
299e014a838Sdanielk1977 
300a37cdde0Sdanielk1977 /*
30135573356Sdrh ** Return the P5 value that should be used for a binary comparison
302a37cdde0Sdanielk1977 ** opcode (OP_Eq, OP_Ge etc.) used to compare pExpr1 and pExpr2.
303a37cdde0Sdanielk1977 */
30435573356Sdrh static u8 binaryCompareP5(Expr *pExpr1, Expr *pExpr2, int jumpIfNull){
30535573356Sdrh   u8 aff = (char)sqlite3ExprAffinity(pExpr2);
3061bd10f8aSdrh   aff = (u8)sqlite3CompareAffinity(pExpr1, aff) | (u8)jumpIfNull;
30735573356Sdrh   return aff;
308a37cdde0Sdanielk1977 }
309a37cdde0Sdanielk1977 
310a2e00042Sdrh /*
3110202b29eSdanielk1977 ** Return a pointer to the collation sequence that should be used by
3120202b29eSdanielk1977 ** a binary comparison operator comparing pLeft and pRight.
3130202b29eSdanielk1977 **
3140202b29eSdanielk1977 ** If the left hand expression has a collating sequence type, then it is
3150202b29eSdanielk1977 ** used. Otherwise the collation sequence for the right hand expression
3160202b29eSdanielk1977 ** is used, or the default (BINARY) if neither expression has a collating
3170202b29eSdanielk1977 ** type.
318bcbb04e5Sdanielk1977 **
319bcbb04e5Sdanielk1977 ** Argument pRight (but not pLeft) may be a null pointer. In this case,
320bcbb04e5Sdanielk1977 ** it is not considered.
3210202b29eSdanielk1977 */
322bcbb04e5Sdanielk1977 CollSeq *sqlite3BinaryCompareCollSeq(
323bcbb04e5Sdanielk1977   Parse *pParse,
324bcbb04e5Sdanielk1977   Expr *pLeft,
325bcbb04e5Sdanielk1977   Expr *pRight
326bcbb04e5Sdanielk1977 ){
327ec41ddacSdrh   CollSeq *pColl;
328ec41ddacSdrh   assert( pLeft );
329ae80ddeaSdrh   if( pLeft->flags & EP_Collate ){
330ae80ddeaSdrh     pColl = sqlite3ExprCollSeq(pParse, pLeft);
331ae80ddeaSdrh   }else if( pRight && (pRight->flags & EP_Collate)!=0 ){
332ae80ddeaSdrh     pColl = sqlite3ExprCollSeq(pParse, pRight);
333ec41ddacSdrh   }else{
334ec41ddacSdrh     pColl = sqlite3ExprCollSeq(pParse, pLeft);
3350202b29eSdanielk1977     if( !pColl ){
3367cedc8d4Sdanielk1977       pColl = sqlite3ExprCollSeq(pParse, pRight);
3370202b29eSdanielk1977     }
338ec41ddacSdrh   }
3390202b29eSdanielk1977   return pColl;
3400202b29eSdanielk1977 }
3410202b29eSdanielk1977 
3420202b29eSdanielk1977 /*
343be5c89acSdrh ** Generate code for a comparison operator.
344be5c89acSdrh */
345be5c89acSdrh static int codeCompare(
346be5c89acSdrh   Parse *pParse,    /* The parsing (and code generating) context */
347be5c89acSdrh   Expr *pLeft,      /* The left operand */
348be5c89acSdrh   Expr *pRight,     /* The right operand */
349be5c89acSdrh   int opcode,       /* The comparison opcode */
35035573356Sdrh   int in1, int in2, /* Register holding operands */
351be5c89acSdrh   int dest,         /* Jump here if true.  */
352be5c89acSdrh   int jumpIfNull    /* If true, jump if either operand is NULL */
353be5c89acSdrh ){
35435573356Sdrh   int p5;
35535573356Sdrh   int addr;
35635573356Sdrh   CollSeq *p4;
35735573356Sdrh 
35835573356Sdrh   p4 = sqlite3BinaryCompareCollSeq(pParse, pLeft, pRight);
35935573356Sdrh   p5 = binaryCompareP5(pLeft, pRight, jumpIfNull);
36035573356Sdrh   addr = sqlite3VdbeAddOp4(pParse->pVdbe, opcode, in2, dest, in1,
36135573356Sdrh                            (void*)p4, P4_COLLSEQ);
3621bd10f8aSdrh   sqlite3VdbeChangeP5(pParse->pVdbe, (u8)p5);
36335573356Sdrh   return addr;
364be5c89acSdrh }
365be5c89acSdrh 
366cfbb5e82Sdan /*
367870a0705Sdan ** Return true if expression pExpr is a vector, or false otherwise.
368d832da7fSdrh **
369d832da7fSdrh ** A vector is defined as any expression that results in two or more
370d832da7fSdrh ** columns of result.  Every TK_VECTOR node is an vector because the
371d832da7fSdrh ** parser will not generate a TK_VECTOR with fewer than two entries.
372d832da7fSdrh ** But a TK_SELECT might be either a vector or a scalar. It is only
373d832da7fSdrh ** considered a vector if it has two or more result columns.
374870a0705Sdan */
375870a0705Sdan int sqlite3ExprIsVector(Expr *pExpr){
37676dbe7a8Sdrh   return sqlite3ExprVectorSize(pExpr)>1;
377870a0705Sdan }
378870a0705Sdan 
379870a0705Sdan /*
380cfbb5e82Sdan ** If the expression passed as the only argument is of type TK_VECTOR
381cfbb5e82Sdan ** return the number of expressions in the vector. Or, if the expression
382cfbb5e82Sdan ** is a sub-select, return the number of columns in the sub-select. For
383cfbb5e82Sdan ** any other type of expression, return 1.
384cfbb5e82Sdan */
38571c57db0Sdan int sqlite3ExprVectorSize(Expr *pExpr){
38612abf408Sdrh   u8 op = pExpr->op;
38712abf408Sdrh   if( op==TK_REGISTER ) op = pExpr->op2;
38812abf408Sdrh   if( op==TK_VECTOR ){
38971c57db0Sdan     return pExpr->x.pList->nExpr;
39012abf408Sdrh   }else if( op==TK_SELECT ){
39176dbe7a8Sdrh     return pExpr->x.pSelect->pEList->nExpr;
39276dbe7a8Sdrh   }else{
39376dbe7a8Sdrh     return 1;
39476dbe7a8Sdrh   }
39571c57db0Sdan }
39671c57db0Sdan 
397ba00e30aSdan /*
398fc7f27b9Sdrh ** Return a pointer to a subexpression of pVector that is the i-th
399fc7f27b9Sdrh ** column of the vector (numbered starting with 0).  The caller must
400fc7f27b9Sdrh ** ensure that i is within range.
401fc7f27b9Sdrh **
40276dbe7a8Sdrh ** If pVector is really a scalar (and "scalar" here includes subqueries
40376dbe7a8Sdrh ** that return a single column!) then return pVector unmodified.
40476dbe7a8Sdrh **
405fc7f27b9Sdrh ** pVector retains ownership of the returned subexpression.
406fc7f27b9Sdrh **
407fc7f27b9Sdrh ** If the vector is a (SELECT ...) then the expression returned is
40876dbe7a8Sdrh ** just the expression for the i-th term of the result set, and may
40976dbe7a8Sdrh ** not be ready for evaluation because the table cursor has not yet
41076dbe7a8Sdrh ** been positioned.
411ba00e30aSdan */
412fc7f27b9Sdrh Expr *sqlite3VectorFieldSubexpr(Expr *pVector, int i){
413870a0705Sdan   assert( i<sqlite3ExprVectorSize(pVector) );
414870a0705Sdan   if( sqlite3ExprIsVector(pVector) ){
4159f24b53dSdrh     assert( pVector->op2==0 || pVector->op==TK_REGISTER );
4169f24b53dSdrh     if( pVector->op==TK_SELECT || pVector->op2==TK_SELECT ){
41771c57db0Sdan       return pVector->x.pSelect->pEList->a[i].pExpr;
418870a0705Sdan     }else{
41971c57db0Sdan       return pVector->x.pList->a[i].pExpr;
42071c57db0Sdan     }
421870a0705Sdan   }
422870a0705Sdan   return pVector;
423870a0705Sdan }
424fc7f27b9Sdrh 
425fc7f27b9Sdrh /*
426fc7f27b9Sdrh ** Compute and return a new Expr object which when passed to
427fc7f27b9Sdrh ** sqlite3ExprCode() will generate all necessary code to compute
428fc7f27b9Sdrh ** the iField-th column of the vector expression pVector.
429fc7f27b9Sdrh **
4308762ec19Sdrh ** It is ok for pVector to be a scalar (as long as iField==0).
4318762ec19Sdrh ** In that case, this routine works like sqlite3ExprDup().
4328762ec19Sdrh **
433fc7f27b9Sdrh ** The caller owns the returned Expr object and is responsible for
434fc7f27b9Sdrh ** ensuring that the returned value eventually gets freed.
435fc7f27b9Sdrh **
4368762ec19Sdrh ** The caller retains ownership of pVector.  If pVector is a TK_SELECT,
437fad0e70cSdan ** then the returned object will reference pVector and so pVector must remain
4388762ec19Sdrh ** valid for the life of the returned object.  If pVector is a TK_VECTOR
4398762ec19Sdrh ** or a scalar expression, then it can be deleted as soon as this routine
44076dbe7a8Sdrh ** returns.
4418762ec19Sdrh **
4428762ec19Sdrh ** A trick to cause a TK_SELECT pVector to be deleted together with
4438762ec19Sdrh ** the returned Expr object is to attach the pVector to the pRight field
4448762ec19Sdrh ** of the returned TK_SELECT_COLUMN Expr object.
445fc7f27b9Sdrh */
446fc7f27b9Sdrh Expr *sqlite3ExprForVectorField(
447fc7f27b9Sdrh   Parse *pParse,       /* Parsing context */
448fc7f27b9Sdrh   Expr *pVector,       /* The vector.  List of expressions or a sub-SELECT */
449a1251bc4Sdrh   int iField           /* Which column of the vector to return */
450fc7f27b9Sdrh ){
451fc7f27b9Sdrh   Expr *pRet;
452a1251bc4Sdrh   if( pVector->op==TK_SELECT ){
453a1251bc4Sdrh     assert( pVector->flags & EP_xIsSelect );
454fc7f27b9Sdrh     /* The TK_SELECT_COLUMN Expr node:
455fc7f27b9Sdrh     **
456966e2911Sdrh     ** pLeft:           pVector containing TK_SELECT.  Not deleted.
4578762ec19Sdrh     ** pRight:          not used.  But recursively deleted.
458fc7f27b9Sdrh     ** iColumn:         Index of a column in pVector
459966e2911Sdrh     ** iTable:          0 or the number of columns on the LHS of an assignment
460fc7f27b9Sdrh     ** pLeft->iTable:   First in an array of register holding result, or 0
461fc7f27b9Sdrh     **                  if the result is not yet computed.
462fc7f27b9Sdrh     **
463fc7f27b9Sdrh     ** sqlite3ExprDelete() specifically skips the recursive delete of
464fc7f27b9Sdrh     ** pLeft on TK_SELECT_COLUMN nodes.  But pRight is followed, so pVector
4658762ec19Sdrh     ** can be attached to pRight to cause this node to take ownership of
4668762ec19Sdrh     ** pVector.  Typically there will be multiple TK_SELECT_COLUMN nodes
4678762ec19Sdrh     ** with the same pLeft pointer to the pVector, but only one of them
4688762ec19Sdrh     ** will own the pVector.
469fc7f27b9Sdrh     */
470abfd35eaSdrh     pRet = sqlite3PExpr(pParse, TK_SELECT_COLUMN, 0, 0);
4718bd0d58eSdrh     if( pRet ){
4728bd0d58eSdrh       pRet->iColumn = iField;
4738bd0d58eSdrh       pRet->pLeft = pVector;
4748bd0d58eSdrh     }
475fc7f27b9Sdrh     assert( pRet==0 || pRet->iTable==0 );
476fc7f27b9Sdrh   }else{
477a1251bc4Sdrh     if( pVector->op==TK_VECTOR ) pVector = pVector->x.pList->a[iField].pExpr;
478a1251bc4Sdrh     pRet = sqlite3ExprDup(pParse->db, pVector, 0);
479dfb5c963Sdan     sqlite3RenameTokenRemap(pParse, pRet, pVector);
480fc7f27b9Sdrh   }
481fc7f27b9Sdrh   return pRet;
482fc7f27b9Sdrh }
48371c57db0Sdan 
4845c288b92Sdan /*
4855c288b92Sdan ** If expression pExpr is of type TK_SELECT, generate code to evaluate
4865c288b92Sdan ** it. Return the register in which the result is stored (or, if the
4875c288b92Sdan ** sub-select returns more than one column, the first in an array
4885c288b92Sdan ** of registers in which the result is stored).
4895c288b92Sdan **
4905c288b92Sdan ** If pExpr is not a TK_SELECT expression, return 0.
4915c288b92Sdan */
4925c288b92Sdan static int exprCodeSubselect(Parse *pParse, Expr *pExpr){
4938da209b1Sdan   int reg = 0;
494f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
4955c288b92Sdan   if( pExpr->op==TK_SELECT ){
49685bcdce2Sdrh     reg = sqlite3CodeSubselect(pParse, pExpr);
4978da209b1Sdan   }
498f9b2e05cSdan #endif
4998da209b1Sdan   return reg;
5008da209b1Sdan }
5018da209b1Sdan 
5025c288b92Sdan /*
5035c288b92Sdan ** Argument pVector points to a vector expression - either a TK_VECTOR
504870a0705Sdan ** or TK_SELECT that returns more than one column. This function returns
505870a0705Sdan ** the register number of a register that contains the value of
506870a0705Sdan ** element iField of the vector.
507870a0705Sdan **
508870a0705Sdan ** If pVector is a TK_SELECT expression, then code for it must have
509870a0705Sdan ** already been generated using the exprCodeSubselect() routine. In this
510870a0705Sdan ** case parameter regSelect should be the first in an array of registers
511870a0705Sdan ** containing the results of the sub-select.
512870a0705Sdan **
513870a0705Sdan ** If pVector is of type TK_VECTOR, then code for the requested field
514870a0705Sdan ** is generated. In this case (*pRegFree) may be set to the number of
515870a0705Sdan ** a temporary register to be freed by the caller before returning.
5165c288b92Sdan **
5175c288b92Sdan ** Before returning, output parameter (*ppExpr) is set to point to the
5185c288b92Sdan ** Expr object corresponding to element iElem of the vector.
5195c288b92Sdan */
5205c288b92Sdan static int exprVectorRegister(
5215c288b92Sdan   Parse *pParse,                  /* Parse context */
5225c288b92Sdan   Expr *pVector,                  /* Vector to extract element from */
523870a0705Sdan   int iField,                     /* Field to extract from pVector */
5245c288b92Sdan   int regSelect,                  /* First in array of registers */
5255c288b92Sdan   Expr **ppExpr,                  /* OUT: Expression element */
5265c288b92Sdan   int *pRegFree                   /* OUT: Temp register to free */
5275c288b92Sdan ){
52812abf408Sdrh   u8 op = pVector->op;
529c1bcd9ccSdrh   assert( op==TK_VECTOR || op==TK_REGISTER || op==TK_SELECT );
53012abf408Sdrh   if( op==TK_REGISTER ){
53112abf408Sdrh     *ppExpr = sqlite3VectorFieldSubexpr(pVector, iField);
53212abf408Sdrh     return pVector->iTable+iField;
53312abf408Sdrh   }
53412abf408Sdrh   if( op==TK_SELECT ){
535870a0705Sdan     *ppExpr = pVector->x.pSelect->pEList->a[iField].pExpr;
536870a0705Sdan      return regSelect+iField;
5375c288b92Sdan   }
538870a0705Sdan   *ppExpr = pVector->x.pList->a[iField].pExpr;
5395c288b92Sdan   return sqlite3ExprCodeTemp(pParse, *ppExpr, pRegFree);
5405c288b92Sdan }
5415c288b92Sdan 
5425c288b92Sdan /*
5435c288b92Sdan ** Expression pExpr is a comparison between two vector values. Compute
54479752b6eSdrh ** the result of the comparison (1, 0, or NULL) and write that
54579752b6eSdrh ** result into register dest.
54679752b6eSdrh **
54779752b6eSdrh ** The caller must satisfy the following preconditions:
54879752b6eSdrh **
54979752b6eSdrh **    if pExpr->op==TK_IS:      op==TK_EQ and p5==SQLITE_NULLEQ
55079752b6eSdrh **    if pExpr->op==TK_ISNOT:   op==TK_NE and p5==SQLITE_NULLEQ
55179752b6eSdrh **    otherwise:                op==pExpr->op and p5==0
5525c288b92Sdan */
55379752b6eSdrh static void codeVectorCompare(
55479752b6eSdrh   Parse *pParse,        /* Code generator context */
55579752b6eSdrh   Expr *pExpr,          /* The comparison operation */
55679752b6eSdrh   int dest,             /* Write results into this register */
55779752b6eSdrh   u8 op,                /* Comparison operator */
55879752b6eSdrh   u8 p5                 /* SQLITE_NULLEQ or zero */
55979752b6eSdrh ){
56071c57db0Sdan   Vdbe *v = pParse->pVdbe;
56171c57db0Sdan   Expr *pLeft = pExpr->pLeft;
56271c57db0Sdan   Expr *pRight = pExpr->pRight;
56371c57db0Sdan   int nLeft = sqlite3ExprVectorSize(pLeft);
56471c57db0Sdan   int i;
56571c57db0Sdan   int regLeft = 0;
56671c57db0Sdan   int regRight = 0;
56779752b6eSdrh   u8 opx = op;
568ec4ccdbcSdrh   int addrDone = sqlite3VdbeMakeLabel(pParse);
56971c57db0Sdan 
570245ce62eSdrh   if( nLeft!=sqlite3ExprVectorSize(pRight) ){
571245ce62eSdrh     sqlite3ErrorMsg(pParse, "row value misused");
572245ce62eSdrh     return;
573245ce62eSdrh   }
57471c57db0Sdan   assert( pExpr->op==TK_EQ || pExpr->op==TK_NE
57571c57db0Sdan        || pExpr->op==TK_IS || pExpr->op==TK_ISNOT
57671c57db0Sdan        || pExpr->op==TK_LT || pExpr->op==TK_GT
57771c57db0Sdan        || pExpr->op==TK_LE || pExpr->op==TK_GE
57871c57db0Sdan   );
57979752b6eSdrh   assert( pExpr->op==op || (pExpr->op==TK_IS && op==TK_EQ)
58079752b6eSdrh             || (pExpr->op==TK_ISNOT && op==TK_NE) );
58179752b6eSdrh   assert( p5==0 || pExpr->op!=op );
58279752b6eSdrh   assert( p5==SQLITE_NULLEQ || pExpr->op==op );
58371c57db0Sdan 
58479752b6eSdrh   p5 |= SQLITE_STOREP2;
58579752b6eSdrh   if( opx==TK_LE ) opx = TK_LT;
58679752b6eSdrh   if( opx==TK_GE ) opx = TK_GT;
5875c288b92Sdan 
5885c288b92Sdan   regLeft = exprCodeSubselect(pParse, pLeft);
5895c288b92Sdan   regRight = exprCodeSubselect(pParse, pRight);
5905c288b92Sdan 
591321e828dSdrh   for(i=0; 1 /*Loop exits by "break"*/; i++){
5925c288b92Sdan     int regFree1 = 0, regFree2 = 0;
5935c288b92Sdan     Expr *pL, *pR;
5945c288b92Sdan     int r1, r2;
595321e828dSdrh     assert( i>=0 && i<nLeft );
5965c288b92Sdan     r1 = exprVectorRegister(pParse, pLeft, i, regLeft, &pL, &regFree1);
5975c288b92Sdan     r2 = exprVectorRegister(pParse, pRight, i, regRight, &pR, &regFree2);
59879752b6eSdrh     codeCompare(pParse, pL, pR, opx, r1, r2, dest, p5);
59979752b6eSdrh     testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
60079752b6eSdrh     testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
60179752b6eSdrh     testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
60279752b6eSdrh     testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
60379752b6eSdrh     testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
60479752b6eSdrh     testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
60571c57db0Sdan     sqlite3ReleaseTempReg(pParse, regFree1);
60671c57db0Sdan     sqlite3ReleaseTempReg(pParse, regFree2);
60779752b6eSdrh     if( i==nLeft-1 ){
60879752b6eSdrh       break;
60971c57db0Sdan     }
61079752b6eSdrh     if( opx==TK_EQ ){
61179752b6eSdrh       sqlite3VdbeAddOp2(v, OP_IfNot, dest, addrDone); VdbeCoverage(v);
61279752b6eSdrh       p5 |= SQLITE_KEEPNULL;
61379752b6eSdrh     }else if( opx==TK_NE ){
61479752b6eSdrh       sqlite3VdbeAddOp2(v, OP_If, dest, addrDone); VdbeCoverage(v);
61579752b6eSdrh       p5 |= SQLITE_KEEPNULL;
616a2f62925Sdrh     }else{
617a2f62925Sdrh       assert( op==TK_LT || op==TK_GT || op==TK_LE || op==TK_GE );
618a2f62925Sdrh       sqlite3VdbeAddOp2(v, OP_ElseNotEq, 0, addrDone);
61979752b6eSdrh       VdbeCoverageIf(v, op==TK_LT);
62079752b6eSdrh       VdbeCoverageIf(v, op==TK_GT);
62179752b6eSdrh       VdbeCoverageIf(v, op==TK_LE);
62279752b6eSdrh       VdbeCoverageIf(v, op==TK_GE);
62379752b6eSdrh       if( i==nLeft-2 ) opx = op;
62471c57db0Sdan     }
62579752b6eSdrh   }
62679752b6eSdrh   sqlite3VdbeResolveLabel(v, addrDone);
62779752b6eSdrh }
62871c57db0Sdan 
6294b5255acSdanielk1977 #if SQLITE_MAX_EXPR_DEPTH>0
6304b5255acSdanielk1977 /*
6314b5255acSdanielk1977 ** Check that argument nHeight is less than or equal to the maximum
6324b5255acSdanielk1977 ** expression depth allowed. If it is not, leave an error message in
6334b5255acSdanielk1977 ** pParse.
6344b5255acSdanielk1977 */
6357d10d5a6Sdrh int sqlite3ExprCheckHeight(Parse *pParse, int nHeight){
6364b5255acSdanielk1977   int rc = SQLITE_OK;
6374b5255acSdanielk1977   int mxHeight = pParse->db->aLimit[SQLITE_LIMIT_EXPR_DEPTH];
6384b5255acSdanielk1977   if( nHeight>mxHeight ){
6394b5255acSdanielk1977     sqlite3ErrorMsg(pParse,
6404b5255acSdanielk1977        "Expression tree is too large (maximum depth %d)", mxHeight
6414b5255acSdanielk1977     );
6424b5255acSdanielk1977     rc = SQLITE_ERROR;
6434b5255acSdanielk1977   }
6444b5255acSdanielk1977   return rc;
6454b5255acSdanielk1977 }
6464b5255acSdanielk1977 
6474b5255acSdanielk1977 /* The following three functions, heightOfExpr(), heightOfExprList()
6484b5255acSdanielk1977 ** and heightOfSelect(), are used to determine the maximum height
6494b5255acSdanielk1977 ** of any expression tree referenced by the structure passed as the
6504b5255acSdanielk1977 ** first argument.
6514b5255acSdanielk1977 **
6524b5255acSdanielk1977 ** If this maximum height is greater than the current value pointed
6534b5255acSdanielk1977 ** to by pnHeight, the second parameter, then set *pnHeight to that
6544b5255acSdanielk1977 ** value.
6554b5255acSdanielk1977 */
6564b5255acSdanielk1977 static void heightOfExpr(Expr *p, int *pnHeight){
6574b5255acSdanielk1977   if( p ){
6584b5255acSdanielk1977     if( p->nHeight>*pnHeight ){
6594b5255acSdanielk1977       *pnHeight = p->nHeight;
6604b5255acSdanielk1977     }
6614b5255acSdanielk1977   }
6624b5255acSdanielk1977 }
6634b5255acSdanielk1977 static void heightOfExprList(ExprList *p, int *pnHeight){
6644b5255acSdanielk1977   if( p ){
6654b5255acSdanielk1977     int i;
6664b5255acSdanielk1977     for(i=0; i<p->nExpr; i++){
6674b5255acSdanielk1977       heightOfExpr(p->a[i].pExpr, pnHeight);
6684b5255acSdanielk1977     }
6694b5255acSdanielk1977   }
6704b5255acSdanielk1977 }
6711a3a3086Sdan static void heightOfSelect(Select *pSelect, int *pnHeight){
6721a3a3086Sdan   Select *p;
6731a3a3086Sdan   for(p=pSelect; p; p=p->pPrior){
6744b5255acSdanielk1977     heightOfExpr(p->pWhere, pnHeight);
6754b5255acSdanielk1977     heightOfExpr(p->pHaving, pnHeight);
6764b5255acSdanielk1977     heightOfExpr(p->pLimit, pnHeight);
6774b5255acSdanielk1977     heightOfExprList(p->pEList, pnHeight);
6784b5255acSdanielk1977     heightOfExprList(p->pGroupBy, pnHeight);
6794b5255acSdanielk1977     heightOfExprList(p->pOrderBy, pnHeight);
6804b5255acSdanielk1977   }
6814b5255acSdanielk1977 }
6824b5255acSdanielk1977 
6834b5255acSdanielk1977 /*
6844b5255acSdanielk1977 ** Set the Expr.nHeight variable in the structure passed as an
6854b5255acSdanielk1977 ** argument. An expression with no children, Expr.pList or
6864b5255acSdanielk1977 ** Expr.pSelect member has a height of 1. Any other expression
6874b5255acSdanielk1977 ** has a height equal to the maximum height of any other
6884b5255acSdanielk1977 ** referenced Expr plus one.
6892308ed38Sdrh **
6902308ed38Sdrh ** Also propagate EP_Propagate flags up from Expr.x.pList to Expr.flags,
6912308ed38Sdrh ** if appropriate.
6924b5255acSdanielk1977 */
6934b5255acSdanielk1977 static void exprSetHeight(Expr *p){
6944b5255acSdanielk1977   int nHeight = 0;
6954b5255acSdanielk1977   heightOfExpr(p->pLeft, &nHeight);
6964b5255acSdanielk1977   heightOfExpr(p->pRight, &nHeight);
6976ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_xIsSelect) ){
6986ab3a2ecSdanielk1977     heightOfSelect(p->x.pSelect, &nHeight);
6992308ed38Sdrh   }else if( p->x.pList ){
7006ab3a2ecSdanielk1977     heightOfExprList(p->x.pList, &nHeight);
7012308ed38Sdrh     p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
7026ab3a2ecSdanielk1977   }
7034b5255acSdanielk1977   p->nHeight = nHeight + 1;
7044b5255acSdanielk1977 }
7054b5255acSdanielk1977 
7064b5255acSdanielk1977 /*
7074b5255acSdanielk1977 ** Set the Expr.nHeight variable using the exprSetHeight() function. If
7084b5255acSdanielk1977 ** the height is greater than the maximum allowed expression depth,
7094b5255acSdanielk1977 ** leave an error in pParse.
7102308ed38Sdrh **
7112308ed38Sdrh ** Also propagate all EP_Propagate flags from the Expr.x.pList into
7122308ed38Sdrh ** Expr.flags.
7134b5255acSdanielk1977 */
7142308ed38Sdrh void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
71574893a4cSdrh   if( pParse->nErr ) return;
7164b5255acSdanielk1977   exprSetHeight(p);
7177d10d5a6Sdrh   sqlite3ExprCheckHeight(pParse, p->nHeight);
7184b5255acSdanielk1977 }
7194b5255acSdanielk1977 
7204b5255acSdanielk1977 /*
7214b5255acSdanielk1977 ** Return the maximum height of any expression tree referenced
7224b5255acSdanielk1977 ** by the select statement passed as an argument.
7234b5255acSdanielk1977 */
7244b5255acSdanielk1977 int sqlite3SelectExprHeight(Select *p){
7254b5255acSdanielk1977   int nHeight = 0;
7264b5255acSdanielk1977   heightOfSelect(p, &nHeight);
7274b5255acSdanielk1977   return nHeight;
7284b5255acSdanielk1977 }
7292308ed38Sdrh #else /* ABOVE:  Height enforcement enabled.  BELOW: Height enforcement off */
7302308ed38Sdrh /*
7312308ed38Sdrh ** Propagate all EP_Propagate flags from the Expr.x.pList into
7322308ed38Sdrh ** Expr.flags.
7332308ed38Sdrh */
7342308ed38Sdrh void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
7352308ed38Sdrh   if( p && p->x.pList && !ExprHasProperty(p, EP_xIsSelect) ){
7362308ed38Sdrh     p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
7372308ed38Sdrh   }
7382308ed38Sdrh }
7394b5255acSdanielk1977 #define exprSetHeight(y)
7404b5255acSdanielk1977 #endif /* SQLITE_MAX_EXPR_DEPTH>0 */
7414b5255acSdanielk1977 
742be5c89acSdrh /*
743b7916a78Sdrh ** This routine is the core allocator for Expr nodes.
744b7916a78Sdrh **
745a76b5dfcSdrh ** Construct a new expression node and return a pointer to it.  Memory
746b7916a78Sdrh ** for this node and for the pToken argument is a single allocation
747b7916a78Sdrh ** obtained from sqlite3DbMalloc().  The calling function
748a76b5dfcSdrh ** is responsible for making sure the node eventually gets freed.
749b7916a78Sdrh **
750b7916a78Sdrh ** If dequote is true, then the token (if it exists) is dequoted.
751e792b5b4Sdrh ** If dequote is false, no dequoting is performed.  The deQuote
752b7916a78Sdrh ** parameter is ignored if pToken is NULL or if the token does not
753b7916a78Sdrh ** appear to be quoted.  If the quotes were of the form "..." (double-quotes)
754b7916a78Sdrh ** then the EP_DblQuoted flag is set on the expression node.
75533e619fcSdrh **
75633e619fcSdrh ** Special case:  If op==TK_INTEGER and pToken points to a string that
75733e619fcSdrh ** can be translated into a 32-bit integer, then the token is not
75833e619fcSdrh ** stored in u.zToken.  Instead, the integer values is written
75933e619fcSdrh ** into u.iValue and the EP_IntValue flag is set.  No extra storage
76033e619fcSdrh ** is allocated to hold the integer text and the dequote flag is ignored.
761a76b5dfcSdrh */
762b7916a78Sdrh Expr *sqlite3ExprAlloc(
763cca8a4adSdrh   sqlite3 *db,            /* Handle for sqlite3DbMallocRawNN() */
76417435752Sdrh   int op,                 /* Expression opcode */
765b7916a78Sdrh   const Token *pToken,    /* Token argument.  Might be NULL */
766b7916a78Sdrh   int dequote             /* True to dequote */
76717435752Sdrh ){
768a76b5dfcSdrh   Expr *pNew;
76933e619fcSdrh   int nExtra = 0;
770cf697396Sshane   int iValue = 0;
771b7916a78Sdrh 
772575fad65Sdrh   assert( db!=0 );
773b7916a78Sdrh   if( pToken ){
77433e619fcSdrh     if( op!=TK_INTEGER || pToken->z==0
77533e619fcSdrh           || sqlite3GetInt32(pToken->z, &iValue)==0 ){
776b7916a78Sdrh       nExtra = pToken->n+1;
777d50ffc41Sdrh       assert( iValue>=0 );
77833e619fcSdrh     }
779a76b5dfcSdrh   }
780575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, sizeof(Expr)+nExtra);
781b7916a78Sdrh   if( pNew ){
782ca3862dcSdrh     memset(pNew, 0, sizeof(Expr));
7831bd10f8aSdrh     pNew->op = (u8)op;
784a58fdfb1Sdanielk1977     pNew->iAgg = -1;
785a76b5dfcSdrh     if( pToken ){
78633e619fcSdrh       if( nExtra==0 ){
787ad31727fSdrh         pNew->flags |= EP_IntValue|EP_Leaf|(iValue?EP_IsTrue:EP_IsFalse);
78833e619fcSdrh         pNew->u.iValue = iValue;
78933e619fcSdrh       }else{
79033e619fcSdrh         pNew->u.zToken = (char*)&pNew[1];
791b07028f7Sdrh         assert( pToken->z!=0 || pToken->n==0 );
792b07028f7Sdrh         if( pToken->n ) memcpy(pNew->u.zToken, pToken->z, pToken->n);
79333e619fcSdrh         pNew->u.zToken[pToken->n] = 0;
794244b9d6eSdrh         if( dequote && sqlite3Isquote(pNew->u.zToken[0]) ){
79551d35b0fSdrh           sqlite3DequoteExpr(pNew);
796a34001c9Sdrh         }
797a34001c9Sdrh       }
79833e619fcSdrh     }
799b7916a78Sdrh #if SQLITE_MAX_EXPR_DEPTH>0
800b7916a78Sdrh     pNew->nHeight = 1;
801b7916a78Sdrh #endif
802a34001c9Sdrh   }
803a76b5dfcSdrh   return pNew;
804a76b5dfcSdrh }
805a76b5dfcSdrh 
806a76b5dfcSdrh /*
807b7916a78Sdrh ** Allocate a new expression node from a zero-terminated token that has
808b7916a78Sdrh ** already been dequoted.
809b7916a78Sdrh */
810b7916a78Sdrh Expr *sqlite3Expr(
811b7916a78Sdrh   sqlite3 *db,            /* Handle for sqlite3DbMallocZero() (may be null) */
812b7916a78Sdrh   int op,                 /* Expression opcode */
813b7916a78Sdrh   const char *zToken      /* Token argument.  Might be NULL */
814b7916a78Sdrh ){
815b7916a78Sdrh   Token x;
816b7916a78Sdrh   x.z = zToken;
817b40f06c6Sdrh   x.n = sqlite3Strlen30(zToken);
818b7916a78Sdrh   return sqlite3ExprAlloc(db, op, &x, 0);
819b7916a78Sdrh }
820b7916a78Sdrh 
821b7916a78Sdrh /*
822b7916a78Sdrh ** Attach subtrees pLeft and pRight to the Expr node pRoot.
823b7916a78Sdrh **
824b7916a78Sdrh ** If pRoot==NULL that means that a memory allocation error has occurred.
825b7916a78Sdrh ** In that case, delete the subtrees pLeft and pRight.
826b7916a78Sdrh */
827b7916a78Sdrh void sqlite3ExprAttachSubtrees(
828b7916a78Sdrh   sqlite3 *db,
829b7916a78Sdrh   Expr *pRoot,
830b7916a78Sdrh   Expr *pLeft,
831b7916a78Sdrh   Expr *pRight
832b7916a78Sdrh ){
833b7916a78Sdrh   if( pRoot==0 ){
834b7916a78Sdrh     assert( db->mallocFailed );
835b7916a78Sdrh     sqlite3ExprDelete(db, pLeft);
836b7916a78Sdrh     sqlite3ExprDelete(db, pRight);
837b7916a78Sdrh   }else{
838b7916a78Sdrh     if( pRight ){
839b7916a78Sdrh       pRoot->pRight = pRight;
840885a5b03Sdrh       pRoot->flags |= EP_Propagate & pRight->flags;
841b7916a78Sdrh     }
842b7916a78Sdrh     if( pLeft ){
843b7916a78Sdrh       pRoot->pLeft = pLeft;
844885a5b03Sdrh       pRoot->flags |= EP_Propagate & pLeft->flags;
845b7916a78Sdrh     }
846b7916a78Sdrh     exprSetHeight(pRoot);
847b7916a78Sdrh   }
848b7916a78Sdrh }
849b7916a78Sdrh 
850b7916a78Sdrh /*
85160ec914cSpeter.d.reid ** Allocate an Expr node which joins as many as two subtrees.
852b7916a78Sdrh **
853bf664469Sdrh ** One or both of the subtrees can be NULL.  Return a pointer to the new
854bf664469Sdrh ** Expr node.  Or, if an OOM error occurs, set pParse->db->mallocFailed,
855bf664469Sdrh ** free the subtrees and return NULL.
856206f3d96Sdrh */
85717435752Sdrh Expr *sqlite3PExpr(
85817435752Sdrh   Parse *pParse,          /* Parsing context */
85917435752Sdrh   int op,                 /* Expression opcode */
86017435752Sdrh   Expr *pLeft,            /* Left operand */
861abfd35eaSdrh   Expr *pRight            /* Right operand */
86217435752Sdrh ){
8635fb52caaSdrh   Expr *p;
864abfd35eaSdrh   p = sqlite3DbMallocRawNN(pParse->db, sizeof(Expr));
865abfd35eaSdrh   if( p ){
866abfd35eaSdrh     memset(p, 0, sizeof(Expr));
867f1722baaSdrh     p->op = op & 0xff;
868abfd35eaSdrh     p->iAgg = -1;
869b7916a78Sdrh     sqlite3ExprAttachSubtrees(pParse->db, p, pLeft, pRight);
8702b359bdbSdan     sqlite3ExprCheckHeight(pParse, p->nHeight);
871d5c851c1Sdrh   }else{
872d5c851c1Sdrh     sqlite3ExprDelete(pParse->db, pLeft);
873d5c851c1Sdrh     sqlite3ExprDelete(pParse->db, pRight);
8742b359bdbSdan   }
8754e0cff60Sdrh   return p;
8764e0cff60Sdrh }
8774e0cff60Sdrh 
8784e0cff60Sdrh /*
87908de4f79Sdrh ** Add pSelect to the Expr.x.pSelect field.  Or, if pExpr is NULL (due
88008de4f79Sdrh ** do a memory allocation failure) then delete the pSelect object.
88108de4f79Sdrh */
88208de4f79Sdrh void sqlite3PExprAddSelect(Parse *pParse, Expr *pExpr, Select *pSelect){
88308de4f79Sdrh   if( pExpr ){
88408de4f79Sdrh     pExpr->x.pSelect = pSelect;
88508de4f79Sdrh     ExprSetProperty(pExpr, EP_xIsSelect|EP_Subquery);
88608de4f79Sdrh     sqlite3ExprSetHeightAndFlags(pParse, pExpr);
88708de4f79Sdrh   }else{
88808de4f79Sdrh     assert( pParse->db->mallocFailed );
88908de4f79Sdrh     sqlite3SelectDelete(pParse->db, pSelect);
89008de4f79Sdrh   }
89108de4f79Sdrh }
89208de4f79Sdrh 
89308de4f79Sdrh 
89408de4f79Sdrh /*
89591bb0eedSdrh ** Join two expressions using an AND operator.  If either expression is
89691bb0eedSdrh ** NULL, then just return the other expression.
8975fb52caaSdrh **
8985fb52caaSdrh ** If one side or the other of the AND is known to be false, then instead
8995fb52caaSdrh ** of returning an AND expression, just return a constant expression with
9005fb52caaSdrh ** a value of false.
90191bb0eedSdrh */
902d5c851c1Sdrh Expr *sqlite3ExprAnd(Parse *pParse, Expr *pLeft, Expr *pRight){
903d5c851c1Sdrh   sqlite3 *db = pParse->db;
90491bb0eedSdrh   if( pLeft==0  ){
90591bb0eedSdrh     return pRight;
90691bb0eedSdrh   }else if( pRight==0 ){
90791bb0eedSdrh     return pLeft;
908ad31727fSdrh   }else if( ExprAlwaysFalse(pLeft) || ExprAlwaysFalse(pRight) ){
9098e34e406Sdrh     sqlite3ExprUnmapAndDelete(pParse, pLeft);
9108e34e406Sdrh     sqlite3ExprUnmapAndDelete(pParse, pRight);
9115776ee5cSdrh     return sqlite3Expr(db, TK_INTEGER, "0");
91291bb0eedSdrh   }else{
913d5c851c1Sdrh     return sqlite3PExpr(pParse, TK_AND, pLeft, pRight);
914a76b5dfcSdrh   }
915a76b5dfcSdrh }
916a76b5dfcSdrh 
917a76b5dfcSdrh /*
918a76b5dfcSdrh ** Construct a new expression node for a function with multiple
919a76b5dfcSdrh ** arguments.
920a76b5dfcSdrh */
921954733b3Sdrh Expr *sqlite3ExprFunction(
922954733b3Sdrh   Parse *pParse,        /* Parsing context */
923954733b3Sdrh   ExprList *pList,      /* Argument list */
924954733b3Sdrh   Token *pToken,        /* Name of the function */
925954733b3Sdrh   int eDistinct         /* SF_Distinct or SF_ALL or 0 */
926954733b3Sdrh ){
927a76b5dfcSdrh   Expr *pNew;
928633e6d57Sdrh   sqlite3 *db = pParse->db;
9294b202ae2Sdanielk1977   assert( pToken );
930b7916a78Sdrh   pNew = sqlite3ExprAlloc(db, TK_FUNCTION, pToken, 1);
931a76b5dfcSdrh   if( pNew==0 ){
932d9da78a2Sdrh     sqlite3ExprListDelete(db, pList); /* Avoid memory leak when malloc fails */
933a76b5dfcSdrh     return 0;
934a76b5dfcSdrh   }
935954733b3Sdrh   if( pList && pList->nExpr > pParse->db->aLimit[SQLITE_LIMIT_FUNCTION_ARG] ){
936954733b3Sdrh     sqlite3ErrorMsg(pParse, "too many arguments on function %T", pToken);
937954733b3Sdrh   }
9386ab3a2ecSdanielk1977   pNew->x.pList = pList;
939fca23557Sdrh   ExprSetProperty(pNew, EP_HasFunc);
9406ab3a2ecSdanielk1977   assert( !ExprHasProperty(pNew, EP_xIsSelect) );
9412308ed38Sdrh   sqlite3ExprSetHeightAndFlags(pParse, pNew);
942954733b3Sdrh   if( eDistinct==SF_Distinct ) ExprSetProperty(pNew, EP_Distinct);
943a76b5dfcSdrh   return pNew;
944a76b5dfcSdrh }
945a76b5dfcSdrh 
946a76b5dfcSdrh /*
947fa6bc000Sdrh ** Assign a variable number to an expression that encodes a wildcard
948fa6bc000Sdrh ** in the original SQL statement.
949fa6bc000Sdrh **
950fa6bc000Sdrh ** Wildcards consisting of a single "?" are assigned the next sequential
951fa6bc000Sdrh ** variable number.
952fa6bc000Sdrh **
953fa6bc000Sdrh ** Wildcards of the form "?nnn" are assigned the number "nnn".  We make
9549bf755ccSdrh ** sure "nnn" is not too big to avoid a denial of service attack when
955fa6bc000Sdrh ** the SQL statement comes from an external source.
956fa6bc000Sdrh **
95751f49f17Sdrh ** Wildcards of the form ":aaa", "@aaa", or "$aaa" are assigned the same number
958fa6bc000Sdrh ** as the previous instance of the same wildcard.  Or if this is the first
95960ec914cSpeter.d.reid ** instance of the wildcard, the next sequential variable number is
960fa6bc000Sdrh ** assigned.
961fa6bc000Sdrh */
962de25a88cSdrh void sqlite3ExprAssignVarNumber(Parse *pParse, Expr *pExpr, u32 n){
96317435752Sdrh   sqlite3 *db = pParse->db;
964b7916a78Sdrh   const char *z;
965f326d66dSdrh   ynVar x;
96617435752Sdrh 
967fa6bc000Sdrh   if( pExpr==0 ) return;
968c5cd1249Sdrh   assert( !ExprHasProperty(pExpr, EP_IntValue|EP_Reduced|EP_TokenOnly) );
96933e619fcSdrh   z = pExpr->u.zToken;
970b7916a78Sdrh   assert( z!=0 );
971b7916a78Sdrh   assert( z[0]!=0 );
972b1ed717fSmistachkin   assert( n==(u32)sqlite3Strlen30(z) );
973b7916a78Sdrh   if( z[1]==0 ){
974fa6bc000Sdrh     /* Wildcard of the form "?".  Assign the next variable number */
975b7916a78Sdrh     assert( z[0]=='?' );
976f326d66dSdrh     x = (ynVar)(++pParse->nVar);
977124c0b49Sdrh   }else{
978f326d66dSdrh     int doAdd = 0;
979124c0b49Sdrh     if( z[0]=='?' ){
980fa6bc000Sdrh       /* Wildcard of the form "?nnn".  Convert "nnn" to an integer and
981fa6bc000Sdrh       ** use it as the variable number */
982c8d735aeSdan       i64 i;
98318814dfbSdrh       int bOk;
98418814dfbSdrh       if( n==2 ){ /*OPTIMIZATION-IF-TRUE*/
98518814dfbSdrh         i = z[1]-'0';  /* The common case of ?N for a single digit N */
98618814dfbSdrh         bOk = 1;
98718814dfbSdrh       }else{
98818814dfbSdrh         bOk = 0==sqlite3Atoi64(&z[1], &i, n-1, SQLITE_UTF8);
98918814dfbSdrh       }
990c5499befSdrh       testcase( i==0 );
991c5499befSdrh       testcase( i==1 );
992c5499befSdrh       testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]-1 );
993c5499befSdrh       testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] );
994c8d735aeSdan       if( bOk==0 || i<1 || i>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
995fa6bc000Sdrh         sqlite3ErrorMsg(pParse, "variable number must be between ?1 and ?%d",
996bb4957f8Sdrh             db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]);
997c9b39288Sdrh         return;
998fa6bc000Sdrh       }
9998e74e7baSdrh       x = (ynVar)i;
1000f326d66dSdrh       if( x>pParse->nVar ){
1001f326d66dSdrh         pParse->nVar = (int)x;
1002f326d66dSdrh         doAdd = 1;
1003f326d66dSdrh       }else if( sqlite3VListNumToName(pParse->pVList, x)==0 ){
1004f326d66dSdrh         doAdd = 1;
1005fa6bc000Sdrh       }
1006fa6bc000Sdrh     }else{
100751f49f17Sdrh       /* Wildcards like ":aaa", "$aaa" or "@aaa".  Reuse the same variable
1008fa6bc000Sdrh       ** number as the prior appearance of the same name, or if the name
1009fa6bc000Sdrh       ** has never appeared before, reuse the same variable number
1010fa6bc000Sdrh       */
10119bf755ccSdrh       x = (ynVar)sqlite3VListNameToNum(pParse->pVList, z, n);
10129bf755ccSdrh       if( x==0 ){
10139bf755ccSdrh         x = (ynVar)(++pParse->nVar);
1014f326d66dSdrh         doAdd = 1;
1015f326d66dSdrh       }
1016f326d66dSdrh     }
1017f326d66dSdrh     if( doAdd ){
10189bf755ccSdrh       pParse->pVList = sqlite3VListAdd(db, pParse->pVList, z, n, x);
1019fa6bc000Sdrh     }
1020fa6bc000Sdrh   }
1021c9b39288Sdrh   pExpr->iColumn = x;
1022f326d66dSdrh   if( x>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
1023832b2664Sdanielk1977     sqlite3ErrorMsg(pParse, "too many SQL variables");
1024832b2664Sdanielk1977   }
1025fa6bc000Sdrh }
1026fa6bc000Sdrh 
1027fa6bc000Sdrh /*
1028f6963f99Sdan ** Recursively delete an expression tree.
1029a2e00042Sdrh */
10304f0010b1Sdrh static SQLITE_NOINLINE void sqlite3ExprDeleteNN(sqlite3 *db, Expr *p){
10314f0010b1Sdrh   assert( p!=0 );
1032d50ffc41Sdrh   /* Sanity check: Assert that the IntValue is non-negative if it exists */
1033d50ffc41Sdrh   assert( !ExprHasProperty(p, EP_IntValue) || p->u.iValue>=0 );
1034eda079cdSdrh 
1035eda079cdSdrh   assert( !ExprHasProperty(p, EP_WinFunc) || p->y.pWin!=0 || db->mallocFailed );
1036eda079cdSdrh   assert( p->op!=TK_FUNCTION || ExprHasProperty(p, EP_TokenOnly|EP_Reduced)
10374f9adee2Sdan           || p->y.pWin==0 || ExprHasProperty(p, EP_WinFunc) );
1038209bc522Sdrh #ifdef SQLITE_DEBUG
1039209bc522Sdrh   if( ExprHasProperty(p, EP_Leaf) && !ExprHasProperty(p, EP_TokenOnly) ){
1040209bc522Sdrh     assert( p->pLeft==0 );
1041209bc522Sdrh     assert( p->pRight==0 );
1042209bc522Sdrh     assert( p->x.pSelect==0 );
1043209bc522Sdrh   }
1044209bc522Sdrh #endif
1045209bc522Sdrh   if( !ExprHasProperty(p, (EP_TokenOnly|EP_Leaf)) ){
1046c5cd1249Sdrh     /* The Expr.x union is never used at the same time as Expr.pRight */
1047c5cd1249Sdrh     assert( p->x.pList==0 || p->pRight==0 );
10484910a76dSdrh     if( p->pLeft && p->op!=TK_SELECT_COLUMN ) sqlite3ExprDeleteNN(db, p->pLeft);
1049d1086679Sdrh     if( p->pRight ){
10504f9adee2Sdan       assert( !ExprHasProperty(p, EP_WinFunc) );
1051d1086679Sdrh       sqlite3ExprDeleteNN(db, p->pRight);
1052d1086679Sdrh     }else if( ExprHasProperty(p, EP_xIsSelect) ){
10534f9adee2Sdan       assert( !ExprHasProperty(p, EP_WinFunc) );
10546ab3a2ecSdanielk1977       sqlite3SelectDelete(db, p->x.pSelect);
10556ab3a2ecSdanielk1977     }else{
10566ab3a2ecSdanielk1977       sqlite3ExprListDelete(db, p->x.pList);
10576ba7ab0dSdan #ifndef SQLITE_OMIT_WINDOWFUNC
1058eda079cdSdrh       if( ExprHasProperty(p, EP_WinFunc) ){
1059eda079cdSdrh         sqlite3WindowDelete(db, p->y.pWin);
106086fb6e17Sdan       }
10616ba7ab0dSdan #endif
10626ab3a2ecSdanielk1977     }
10638117f113Sdan   }
1064209bc522Sdrh   if( ExprHasProperty(p, EP_MemToken) ) sqlite3DbFree(db, p->u.zToken);
106533e619fcSdrh   if( !ExprHasProperty(p, EP_Static) ){
1066dbd6a7dcSdrh     sqlite3DbFreeNN(db, p);
1067a2e00042Sdrh   }
106833e619fcSdrh }
10694f0010b1Sdrh void sqlite3ExprDelete(sqlite3 *db, Expr *p){
10704f0010b1Sdrh   if( p ) sqlite3ExprDeleteNN(db, p);
10714f0010b1Sdrh }
1072a2e00042Sdrh 
10738e34e406Sdrh /* Invoke sqlite3RenameExprUnmap() and sqlite3ExprDelete() on the
10748e34e406Sdrh ** expression.
10758e34e406Sdrh */
10768e34e406Sdrh void sqlite3ExprUnmapAndDelete(Parse *pParse, Expr *p){
10778e34e406Sdrh   if( p ){
10788e34e406Sdrh     if( IN_RENAME_OBJECT ){
10798e34e406Sdrh       sqlite3RenameExprUnmap(pParse, p);
10808e34e406Sdrh     }
10818e34e406Sdrh     sqlite3ExprDeleteNN(pParse->db, p);
10828e34e406Sdrh   }
10838e34e406Sdrh }
10848e34e406Sdrh 
1085d2687b77Sdrh /*
10866ab3a2ecSdanielk1977 ** Return the number of bytes allocated for the expression structure
10876ab3a2ecSdanielk1977 ** passed as the first argument. This is always one of EXPR_FULLSIZE,
10886ab3a2ecSdanielk1977 ** EXPR_REDUCEDSIZE or EXPR_TOKENONLYSIZE.
10896ab3a2ecSdanielk1977 */
10906ab3a2ecSdanielk1977 static int exprStructSize(Expr *p){
10916ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_TokenOnly) ) return EXPR_TOKENONLYSIZE;
10926ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_Reduced) ) return EXPR_REDUCEDSIZE;
10936ab3a2ecSdanielk1977   return EXPR_FULLSIZE;
10946ab3a2ecSdanielk1977 }
10956ab3a2ecSdanielk1977 
10966ab3a2ecSdanielk1977 /*
109733e619fcSdrh ** The dupedExpr*Size() routines each return the number of bytes required
109833e619fcSdrh ** to store a copy of an expression or expression tree.  They differ in
109933e619fcSdrh ** how much of the tree is measured.
110033e619fcSdrh **
110133e619fcSdrh **     dupedExprStructSize()     Size of only the Expr structure
110233e619fcSdrh **     dupedExprNodeSize()       Size of Expr + space for token
110333e619fcSdrh **     dupedExprSize()           Expr + token + subtree components
110433e619fcSdrh **
110533e619fcSdrh ***************************************************************************
110633e619fcSdrh **
110733e619fcSdrh ** The dupedExprStructSize() function returns two values OR-ed together:
110833e619fcSdrh ** (1) the space required for a copy of the Expr structure only and
110933e619fcSdrh ** (2) the EP_xxx flags that indicate what the structure size should be.
111033e619fcSdrh ** The return values is always one of:
111133e619fcSdrh **
111233e619fcSdrh **      EXPR_FULLSIZE
111333e619fcSdrh **      EXPR_REDUCEDSIZE   | EP_Reduced
111433e619fcSdrh **      EXPR_TOKENONLYSIZE | EP_TokenOnly
111533e619fcSdrh **
111633e619fcSdrh ** The size of the structure can be found by masking the return value
111733e619fcSdrh ** of this routine with 0xfff.  The flags can be found by masking the
111833e619fcSdrh ** return value with EP_Reduced|EP_TokenOnly.
111933e619fcSdrh **
112033e619fcSdrh ** Note that with flags==EXPRDUP_REDUCE, this routines works on full-size
112133e619fcSdrh ** (unreduced) Expr objects as they or originally constructed by the parser.
112233e619fcSdrh ** During expression analysis, extra information is computed and moved into
1123c95f38d4Sdan ** later parts of the Expr object and that extra information might get chopped
112433e619fcSdrh ** off if the expression is reduced.  Note also that it does not work to
112560ec914cSpeter.d.reid ** make an EXPRDUP_REDUCE copy of a reduced expression.  It is only legal
112633e619fcSdrh ** to reduce a pristine expression tree from the parser.  The implementation
112733e619fcSdrh ** of dupedExprStructSize() contain multiple assert() statements that attempt
112833e619fcSdrh ** to enforce this constraint.
11296ab3a2ecSdanielk1977 */
11306ab3a2ecSdanielk1977 static int dupedExprStructSize(Expr *p, int flags){
11316ab3a2ecSdanielk1977   int nSize;
113233e619fcSdrh   assert( flags==EXPRDUP_REDUCE || flags==0 ); /* Only one flag value allowed */
1133aecd8021Sdrh   assert( EXPR_FULLSIZE<=0xfff );
1134aecd8021Sdrh   assert( (0xfff & (EP_Reduced|EP_TokenOnly))==0 );
113567a9b8edSdan   if( 0==flags || p->op==TK_SELECT_COLUMN
113667a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
1137eda079cdSdrh    || ExprHasProperty(p, EP_WinFunc)
113867a9b8edSdan #endif
113967a9b8edSdan   ){
11406ab3a2ecSdanielk1977     nSize = EXPR_FULLSIZE;
11416ab3a2ecSdanielk1977   }else{
1142c5cd1249Sdrh     assert( !ExprHasProperty(p, EP_TokenOnly|EP_Reduced) );
114333e619fcSdrh     assert( !ExprHasProperty(p, EP_FromJoin) );
1144c5cd1249Sdrh     assert( !ExprHasProperty(p, EP_MemToken) );
1145ebb6a65dSdrh     assert( !ExprHasProperty(p, EP_NoReduce) );
1146aecd8021Sdrh     if( p->pLeft || p->x.pList ){
114733e619fcSdrh       nSize = EXPR_REDUCEDSIZE | EP_Reduced;
114833e619fcSdrh     }else{
1149aecd8021Sdrh       assert( p->pRight==0 );
115033e619fcSdrh       nSize = EXPR_TOKENONLYSIZE | EP_TokenOnly;
115133e619fcSdrh     }
11526ab3a2ecSdanielk1977   }
11536ab3a2ecSdanielk1977   return nSize;
11546ab3a2ecSdanielk1977 }
11556ab3a2ecSdanielk1977 
11566ab3a2ecSdanielk1977 /*
115733e619fcSdrh ** This function returns the space in bytes required to store the copy
115833e619fcSdrh ** of the Expr structure and a copy of the Expr.u.zToken string (if that
115933e619fcSdrh ** string is defined.)
11606ab3a2ecSdanielk1977 */
11616ab3a2ecSdanielk1977 static int dupedExprNodeSize(Expr *p, int flags){
116233e619fcSdrh   int nByte = dupedExprStructSize(p, flags) & 0xfff;
116333e619fcSdrh   if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
11647301e774Sdrh     nByte += sqlite3Strlen30NN(p->u.zToken)+1;
11656ab3a2ecSdanielk1977   }
1166bc73971dSdanielk1977   return ROUND8(nByte);
11676ab3a2ecSdanielk1977 }
11686ab3a2ecSdanielk1977 
11696ab3a2ecSdanielk1977 /*
11706ab3a2ecSdanielk1977 ** Return the number of bytes required to create a duplicate of the
11716ab3a2ecSdanielk1977 ** expression passed as the first argument. The second argument is a
11726ab3a2ecSdanielk1977 ** mask containing EXPRDUP_XXX flags.
11736ab3a2ecSdanielk1977 **
11746ab3a2ecSdanielk1977 ** The value returned includes space to create a copy of the Expr struct
117533e619fcSdrh ** itself and the buffer referred to by Expr.u.zToken, if any.
11766ab3a2ecSdanielk1977 **
11776ab3a2ecSdanielk1977 ** If the EXPRDUP_REDUCE flag is set, then the return value includes
11786ab3a2ecSdanielk1977 ** space to duplicate all Expr nodes in the tree formed by Expr.pLeft
11796ab3a2ecSdanielk1977 ** and Expr.pRight variables (but not for any structures pointed to or
11806ab3a2ecSdanielk1977 ** descended from the Expr.x.pList or Expr.x.pSelect variables).
11816ab3a2ecSdanielk1977 */
11826ab3a2ecSdanielk1977 static int dupedExprSize(Expr *p, int flags){
11836ab3a2ecSdanielk1977   int nByte = 0;
11846ab3a2ecSdanielk1977   if( p ){
11856ab3a2ecSdanielk1977     nByte = dupedExprNodeSize(p, flags);
11866ab3a2ecSdanielk1977     if( flags&EXPRDUP_REDUCE ){
1187b7916a78Sdrh       nByte += dupedExprSize(p->pLeft, flags) + dupedExprSize(p->pRight, flags);
11886ab3a2ecSdanielk1977     }
11896ab3a2ecSdanielk1977   }
11906ab3a2ecSdanielk1977   return nByte;
11916ab3a2ecSdanielk1977 }
11926ab3a2ecSdanielk1977 
11936ab3a2ecSdanielk1977 /*
11946ab3a2ecSdanielk1977 ** This function is similar to sqlite3ExprDup(), except that if pzBuffer
11956ab3a2ecSdanielk1977 ** is not NULL then *pzBuffer is assumed to point to a buffer large enough
119633e619fcSdrh ** to store the copy of expression p, the copies of p->u.zToken
11976ab3a2ecSdanielk1977 ** (if applicable), and the copies of the p->pLeft and p->pRight expressions,
119860ec914cSpeter.d.reid ** if any. Before returning, *pzBuffer is set to the first byte past the
11996ab3a2ecSdanielk1977 ** portion of the buffer copied into by this function.
12006ab3a2ecSdanielk1977 */
12013c19469cSdrh static Expr *exprDup(sqlite3 *db, Expr *p, int dupFlags, u8 **pzBuffer){
12023c19469cSdrh   Expr *pNew;           /* Value to return */
12033c19469cSdrh   u8 *zAlloc;           /* Memory space from which to build Expr object */
12043c19469cSdrh   u32 staticFlag;       /* EP_Static if space not obtained from malloc */
12056ab3a2ecSdanielk1977 
12063c19469cSdrh   assert( db!=0 );
12073c19469cSdrh   assert( p );
12083c19469cSdrh   assert( dupFlags==0 || dupFlags==EXPRDUP_REDUCE );
12093c19469cSdrh   assert( pzBuffer==0 || dupFlags==EXPRDUP_REDUCE );
12106ab3a2ecSdanielk1977 
12116ab3a2ecSdanielk1977   /* Figure out where to write the new Expr structure. */
12126ab3a2ecSdanielk1977   if( pzBuffer ){
12136ab3a2ecSdanielk1977     zAlloc = *pzBuffer;
121433e619fcSdrh     staticFlag = EP_Static;
12156ab3a2ecSdanielk1977   }else{
12163c19469cSdrh     zAlloc = sqlite3DbMallocRawNN(db, dupedExprSize(p, dupFlags));
12173c19469cSdrh     staticFlag = 0;
12186ab3a2ecSdanielk1977   }
12196ab3a2ecSdanielk1977   pNew = (Expr *)zAlloc;
12206ab3a2ecSdanielk1977 
12216ab3a2ecSdanielk1977   if( pNew ){
12226ab3a2ecSdanielk1977     /* Set nNewSize to the size allocated for the structure pointed to
12236ab3a2ecSdanielk1977     ** by pNew. This is either EXPR_FULLSIZE, EXPR_REDUCEDSIZE or
12246ab3a2ecSdanielk1977     ** EXPR_TOKENONLYSIZE. nToken is set to the number of bytes consumed
122533e619fcSdrh     ** by the copy of the p->u.zToken string (if any).
12266ab3a2ecSdanielk1977     */
12273c19469cSdrh     const unsigned nStructSize = dupedExprStructSize(p, dupFlags);
122833e619fcSdrh     const int nNewSize = nStructSize & 0xfff;
122933e619fcSdrh     int nToken;
123033e619fcSdrh     if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
123133e619fcSdrh       nToken = sqlite3Strlen30(p->u.zToken) + 1;
123233e619fcSdrh     }else{
123333e619fcSdrh       nToken = 0;
123433e619fcSdrh     }
12353c19469cSdrh     if( dupFlags ){
12366ab3a2ecSdanielk1977       assert( ExprHasProperty(p, EP_Reduced)==0 );
12376ab3a2ecSdanielk1977       memcpy(zAlloc, p, nNewSize);
12386ab3a2ecSdanielk1977     }else{
12393e6a1411Sdan       u32 nSize = (u32)exprStructSize(p);
12406ab3a2ecSdanielk1977       memcpy(zAlloc, p, nSize);
124172ea29d7Sdrh       if( nSize<EXPR_FULLSIZE ){
12426ab3a2ecSdanielk1977         memset(&zAlloc[nSize], 0, EXPR_FULLSIZE-nSize);
12436ab3a2ecSdanielk1977       }
124472ea29d7Sdrh     }
12456ab3a2ecSdanielk1977 
124633e619fcSdrh     /* Set the EP_Reduced, EP_TokenOnly, and EP_Static flags appropriately. */
1247c5cd1249Sdrh     pNew->flags &= ~(EP_Reduced|EP_TokenOnly|EP_Static|EP_MemToken);
124833e619fcSdrh     pNew->flags |= nStructSize & (EP_Reduced|EP_TokenOnly);
124933e619fcSdrh     pNew->flags |= staticFlag;
12506ab3a2ecSdanielk1977 
125133e619fcSdrh     /* Copy the p->u.zToken string, if any. */
12526ab3a2ecSdanielk1977     if( nToken ){
125333e619fcSdrh       char *zToken = pNew->u.zToken = (char*)&zAlloc[nNewSize];
125433e619fcSdrh       memcpy(zToken, p->u.zToken, nToken);
12556ab3a2ecSdanielk1977     }
12566ab3a2ecSdanielk1977 
1257209bc522Sdrh     if( 0==((p->flags|pNew->flags) & (EP_TokenOnly|EP_Leaf)) ){
12586ab3a2ecSdanielk1977       /* Fill in the pNew->x.pSelect or pNew->x.pList member. */
12596ab3a2ecSdanielk1977       if( ExprHasProperty(p, EP_xIsSelect) ){
12603c19469cSdrh         pNew->x.pSelect = sqlite3SelectDup(db, p->x.pSelect, dupFlags);
12616ab3a2ecSdanielk1977       }else{
12623c19469cSdrh         pNew->x.pList = sqlite3ExprListDup(db, p->x.pList, dupFlags);
12636ab3a2ecSdanielk1977       }
12646ab3a2ecSdanielk1977     }
12656ab3a2ecSdanielk1977 
12666ab3a2ecSdanielk1977     /* Fill in pNew->pLeft and pNew->pRight. */
12674f9adee2Sdan     if( ExprHasProperty(pNew, EP_Reduced|EP_TokenOnly|EP_WinFunc) ){
12683c19469cSdrh       zAlloc += dupedExprNodeSize(p, dupFlags);
1269209bc522Sdrh       if( !ExprHasProperty(pNew, EP_TokenOnly|EP_Leaf) ){
12703c19469cSdrh         pNew->pLeft = p->pLeft ?
12713c19469cSdrh                       exprDup(db, p->pLeft, EXPRDUP_REDUCE, &zAlloc) : 0;
12723c19469cSdrh         pNew->pRight = p->pRight ?
12733c19469cSdrh                        exprDup(db, p->pRight, EXPRDUP_REDUCE, &zAlloc) : 0;
12746ab3a2ecSdanielk1977       }
127567a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
1276eda079cdSdrh       if( ExprHasProperty(p, EP_WinFunc) ){
1277eda079cdSdrh         pNew->y.pWin = sqlite3WindowDup(db, pNew, p->y.pWin);
1278eda079cdSdrh         assert( ExprHasProperty(pNew, EP_WinFunc) );
1279e2f781b9Sdan       }
128067a9b8edSdan #endif /* SQLITE_OMIT_WINDOWFUNC */
128153988068Sdrh       if( pzBuffer ){
128253988068Sdrh         *pzBuffer = zAlloc;
128353988068Sdrh       }
128453988068Sdrh     }else{
1285209bc522Sdrh       if( !ExprHasProperty(p, EP_TokenOnly|EP_Leaf) ){
12869854260bSdrh         if( pNew->op==TK_SELECT_COLUMN ){
12879854260bSdrh           pNew->pLeft = p->pLeft;
128847073f62Sdrh           assert( p->iColumn==0 || p->pRight==0 );
128947073f62Sdrh           assert( p->pRight==0  || p->pRight==p->pLeft );
12909854260bSdrh         }else{
12916ab3a2ecSdanielk1977           pNew->pLeft = sqlite3ExprDup(db, p->pLeft, 0);
12929854260bSdrh         }
12936ab3a2ecSdanielk1977         pNew->pRight = sqlite3ExprDup(db, p->pRight, 0);
12946ab3a2ecSdanielk1977       }
12956ab3a2ecSdanielk1977     }
12966ab3a2ecSdanielk1977   }
12976ab3a2ecSdanielk1977   return pNew;
12986ab3a2ecSdanielk1977 }
12996ab3a2ecSdanielk1977 
13006ab3a2ecSdanielk1977 /*
1301bfe31e7fSdan ** Create and return a deep copy of the object passed as the second
1302bfe31e7fSdan ** argument. If an OOM condition is encountered, NULL is returned
1303bfe31e7fSdan ** and the db->mallocFailed flag set.
1304bfe31e7fSdan */
1305eede6a53Sdan #ifndef SQLITE_OMIT_CTE
1306bfe31e7fSdan static With *withDup(sqlite3 *db, With *p){
13074e9119d9Sdan   With *pRet = 0;
13084e9119d9Sdan   if( p ){
1309d4de9f7bSdrh     sqlite3_int64 nByte = sizeof(*p) + sizeof(p->a[0]) * (p->nCte-1);
13104e9119d9Sdan     pRet = sqlite3DbMallocZero(db, nByte);
13114e9119d9Sdan     if( pRet ){
13124e9119d9Sdan       int i;
13134e9119d9Sdan       pRet->nCte = p->nCte;
13144e9119d9Sdan       for(i=0; i<p->nCte; i++){
13154e9119d9Sdan         pRet->a[i].pSelect = sqlite3SelectDup(db, p->a[i].pSelect, 0);
13164e9119d9Sdan         pRet->a[i].pCols = sqlite3ExprListDup(db, p->a[i].pCols, 0);
13174e9119d9Sdan         pRet->a[i].zName = sqlite3DbStrDup(db, p->a[i].zName);
13184e9119d9Sdan       }
13194e9119d9Sdan     }
13204e9119d9Sdan   }
13214e9119d9Sdan   return pRet;
13224e9119d9Sdan }
1323eede6a53Sdan #else
1324eede6a53Sdan # define withDup(x,y) 0
1325eede6a53Sdan #endif
13264e9119d9Sdan 
1327a8389975Sdrh #ifndef SQLITE_OMIT_WINDOWFUNC
1328a8389975Sdrh /*
1329a8389975Sdrh ** The gatherSelectWindows() procedure and its helper routine
1330a8389975Sdrh ** gatherSelectWindowsCallback() are used to scan all the expressions
1331a8389975Sdrh ** an a newly duplicated SELECT statement and gather all of the Window
1332a8389975Sdrh ** objects found there, assembling them onto the linked list at Select->pWin.
1333a8389975Sdrh */
1334a8389975Sdrh static int gatherSelectWindowsCallback(Walker *pWalker, Expr *pExpr){
13356ba7ab0dSdan   if( pExpr->op==TK_FUNCTION && ExprHasProperty(pExpr, EP_WinFunc) ){
133675b0821eSdan     Select *pSelect = pWalker->u.pSelect;
133775b0821eSdan     Window *pWin = pExpr->y.pWin;
133875b0821eSdan     assert( pWin );
13394f9adee2Sdan     assert( IsWindowFunc(pExpr) );
1340e0ae3f69Sdan     assert( pWin->ppThis==0 );
1341a3fcc000Sdan     sqlite3WindowLink(pSelect, pWin);
1342a8389975Sdrh   }
1343a8389975Sdrh   return WRC_Continue;
1344a8389975Sdrh }
1345a37b6a5eSdrh static int gatherSelectWindowsSelectCallback(Walker *pWalker, Select *p){
1346a37b6a5eSdrh   return p==pWalker->u.pSelect ? WRC_Continue : WRC_Prune;
1347a37b6a5eSdrh }
1348a8389975Sdrh static void gatherSelectWindows(Select *p){
1349a8389975Sdrh   Walker w;
1350a8389975Sdrh   w.xExprCallback = gatherSelectWindowsCallback;
1351a37b6a5eSdrh   w.xSelectCallback = gatherSelectWindowsSelectCallback;
1352a37b6a5eSdrh   w.xSelectCallback2 = 0;
13539c46c66cSdrh   w.pParse = 0;
1354a8389975Sdrh   w.u.pSelect = p;
1355a37b6a5eSdrh   sqlite3WalkSelect(&w, p);
1356a8389975Sdrh }
1357a8389975Sdrh #endif
1358a8389975Sdrh 
1359a8389975Sdrh 
1360a76b5dfcSdrh /*
1361ff78bd2fSdrh ** The following group of routines make deep copies of expressions,
1362ff78bd2fSdrh ** expression lists, ID lists, and select statements.  The copies can
1363ff78bd2fSdrh ** be deleted (by being passed to their respective ...Delete() routines)
1364ff78bd2fSdrh ** without effecting the originals.
1365ff78bd2fSdrh **
13664adee20fSdanielk1977 ** The expression list, ID, and source lists return by sqlite3ExprListDup(),
13674adee20fSdanielk1977 ** sqlite3IdListDup(), and sqlite3SrcListDup() can not be further expanded
1368ad3cab52Sdrh ** by subsequent calls to sqlite*ListAppend() routines.
1369ff78bd2fSdrh **
1370ad3cab52Sdrh ** Any tables that the SrcList might point to are not duplicated.
13716ab3a2ecSdanielk1977 **
1372b7916a78Sdrh ** The flags parameter contains a combination of the EXPRDUP_XXX flags.
13736ab3a2ecSdanielk1977 ** If the EXPRDUP_REDUCE flag is set, then the structure returned is a
13746ab3a2ecSdanielk1977 ** truncated version of the usual Expr structure that will be stored as
13756ab3a2ecSdanielk1977 ** part of the in-memory representation of the database schema.
1376ff78bd2fSdrh */
13776ab3a2ecSdanielk1977 Expr *sqlite3ExprDup(sqlite3 *db, Expr *p, int flags){
137872ea29d7Sdrh   assert( flags==0 || flags==EXPRDUP_REDUCE );
13793c19469cSdrh   return p ? exprDup(db, p, flags, 0) : 0;
1380ff78bd2fSdrh }
13816ab3a2ecSdanielk1977 ExprList *sqlite3ExprListDup(sqlite3 *db, ExprList *p, int flags){
1382ff78bd2fSdrh   ExprList *pNew;
1383145716b3Sdrh   struct ExprList_item *pItem, *pOldItem;
1384ff78bd2fSdrh   int i;
1385b163748eSdrh   Expr *pPriorSelectCol = 0;
1386575fad65Sdrh   assert( db!=0 );
1387ff78bd2fSdrh   if( p==0 ) return 0;
138897258194Sdrh   pNew = sqlite3DbMallocRawNN(db, sqlite3DbMallocSize(db, p));
1389ff78bd2fSdrh   if( pNew==0 ) return 0;
1390a19543feSdrh   pNew->nExpr = p->nExpr;
139143606175Sdrh   pItem = pNew->a;
1392145716b3Sdrh   pOldItem = p->a;
1393145716b3Sdrh   for(i=0; i<p->nExpr; i++, pItem++, pOldItem++){
13946ab3a2ecSdanielk1977     Expr *pOldExpr = pOldItem->pExpr;
139547073f62Sdrh     Expr *pNewExpr;
1396b5526ea6Sdrh     pItem->pExpr = sqlite3ExprDup(db, pOldExpr, flags);
139747073f62Sdrh     if( pOldExpr
139847073f62Sdrh      && pOldExpr->op==TK_SELECT_COLUMN
139947073f62Sdrh      && (pNewExpr = pItem->pExpr)!=0
140047073f62Sdrh     ){
140147073f62Sdrh       assert( pNewExpr->iColumn==0 || i>0 );
140247073f62Sdrh       if( pNewExpr->iColumn==0 ){
140347073f62Sdrh         assert( pOldExpr->pLeft==pOldExpr->pRight );
1404b163748eSdrh         pPriorSelectCol = pNewExpr->pLeft = pNewExpr->pRight;
1405b163748eSdrh       }else{
1406b163748eSdrh         assert( i>0 );
1407b163748eSdrh         assert( pItem[-1].pExpr!=0 );
1408b163748eSdrh         assert( pNewExpr->iColumn==pItem[-1].pExpr->iColumn+1 );
1409b163748eSdrh         assert( pPriorSelectCol==pItem[-1].pExpr->pLeft );
1410b163748eSdrh         pNewExpr->pLeft = pPriorSelectCol;
141147073f62Sdrh       }
141247073f62Sdrh     }
141317435752Sdrh     pItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
1414b7916a78Sdrh     pItem->zSpan = sqlite3DbStrDup(db, pOldItem->zSpan);
14156e11892dSdan     pItem->sortFlags = pOldItem->sortFlags;
14163e7bc9caSdrh     pItem->done = 0;
1417ae8e45cbSdan     pItem->bNulls = pOldItem->bNulls;
14182c036cffSdrh     pItem->bSpanIsTab = pOldItem->bSpanIsTab;
141924e25d32Sdan     pItem->bSorterRef = pOldItem->bSorterRef;
1420c2acc4e4Sdrh     pItem->u = pOldItem->u;
1421ff78bd2fSdrh   }
1422ff78bd2fSdrh   return pNew;
1423ff78bd2fSdrh }
142493758c8dSdanielk1977 
142593758c8dSdanielk1977 /*
142693758c8dSdanielk1977 ** If cursors, triggers, views and subqueries are all omitted from
142793758c8dSdanielk1977 ** the build, then none of the following routines, except for
142893758c8dSdanielk1977 ** sqlite3SelectDup(), can be called. sqlite3SelectDup() is sometimes
142993758c8dSdanielk1977 ** called with a NULL argument.
143093758c8dSdanielk1977 */
14316a67fe8eSdanielk1977 #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_TRIGGER) \
14326a67fe8eSdanielk1977  || !defined(SQLITE_OMIT_SUBQUERY)
14336ab3a2ecSdanielk1977 SrcList *sqlite3SrcListDup(sqlite3 *db, SrcList *p, int flags){
1434ad3cab52Sdrh   SrcList *pNew;
1435ad3cab52Sdrh   int i;
1436113088ecSdrh   int nByte;
1437575fad65Sdrh   assert( db!=0 );
1438ad3cab52Sdrh   if( p==0 ) return 0;
1439113088ecSdrh   nByte = sizeof(*p) + (p->nSrc>0 ? sizeof(p->a[0]) * (p->nSrc-1) : 0);
1440575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, nByte );
1441ad3cab52Sdrh   if( pNew==0 ) return 0;
14424305d103Sdrh   pNew->nSrc = pNew->nAlloc = p->nSrc;
1443ad3cab52Sdrh   for(i=0; i<p->nSrc; i++){
14444efc4754Sdrh     struct SrcList_item *pNewItem = &pNew->a[i];
14454efc4754Sdrh     struct SrcList_item *pOldItem = &p->a[i];
1446ed8a3bb1Sdrh     Table *pTab;
144741fb5cd1Sdan     pNewItem->pSchema = pOldItem->pSchema;
144817435752Sdrh     pNewItem->zDatabase = sqlite3DbStrDup(db, pOldItem->zDatabase);
144917435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
145017435752Sdrh     pNewItem->zAlias = sqlite3DbStrDup(db, pOldItem->zAlias);
14518a48b9c0Sdrh     pNewItem->fg = pOldItem->fg;
14524efc4754Sdrh     pNewItem->iCursor = pOldItem->iCursor;
14535b6a9ed4Sdrh     pNewItem->addrFillSub = pOldItem->addrFillSub;
14545b6a9ed4Sdrh     pNewItem->regReturn = pOldItem->regReturn;
14558a48b9c0Sdrh     if( pNewItem->fg.isIndexedBy ){
14568a48b9c0Sdrh       pNewItem->u1.zIndexedBy = sqlite3DbStrDup(db, pOldItem->u1.zIndexedBy);
14578a48b9c0Sdrh     }
14588a48b9c0Sdrh     pNewItem->pIBIndex = pOldItem->pIBIndex;
14598a48b9c0Sdrh     if( pNewItem->fg.isTabFunc ){
14608a48b9c0Sdrh       pNewItem->u1.pFuncArg =
14618a48b9c0Sdrh           sqlite3ExprListDup(db, pOldItem->u1.pFuncArg, flags);
14628a48b9c0Sdrh     }
1463ed8a3bb1Sdrh     pTab = pNewItem->pTab = pOldItem->pTab;
1464ed8a3bb1Sdrh     if( pTab ){
146579df7782Sdrh       pTab->nTabRef++;
1466a1cb183dSdanielk1977     }
14676ab3a2ecSdanielk1977     pNewItem->pSelect = sqlite3SelectDup(db, pOldItem->pSelect, flags);
14686ab3a2ecSdanielk1977     pNewItem->pOn = sqlite3ExprDup(db, pOldItem->pOn, flags);
146917435752Sdrh     pNewItem->pUsing = sqlite3IdListDup(db, pOldItem->pUsing);
14706c18b6e0Sdanielk1977     pNewItem->colUsed = pOldItem->colUsed;
1471ad3cab52Sdrh   }
1472ad3cab52Sdrh   return pNew;
1473ad3cab52Sdrh }
147417435752Sdrh IdList *sqlite3IdListDup(sqlite3 *db, IdList *p){
1475ff78bd2fSdrh   IdList *pNew;
1476ff78bd2fSdrh   int i;
1477575fad65Sdrh   assert( db!=0 );
1478ff78bd2fSdrh   if( p==0 ) return 0;
1479575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, sizeof(*pNew) );
1480ff78bd2fSdrh   if( pNew==0 ) return 0;
14816c535158Sdrh   pNew->nId = p->nId;
1482575fad65Sdrh   pNew->a = sqlite3DbMallocRawNN(db, p->nId*sizeof(p->a[0]) );
1483d5d56523Sdanielk1977   if( pNew->a==0 ){
1484dbd6a7dcSdrh     sqlite3DbFreeNN(db, pNew);
1485d5d56523Sdanielk1977     return 0;
1486d5d56523Sdanielk1977   }
14876c535158Sdrh   /* Note that because the size of the allocation for p->a[] is not
14886c535158Sdrh   ** necessarily a power of two, sqlite3IdListAppend() may not be called
14896c535158Sdrh   ** on the duplicate created by this function. */
1490ff78bd2fSdrh   for(i=0; i<p->nId; i++){
14914efc4754Sdrh     struct IdList_item *pNewItem = &pNew->a[i];
14924efc4754Sdrh     struct IdList_item *pOldItem = &p->a[i];
149317435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
14944efc4754Sdrh     pNewItem->idx = pOldItem->idx;
1495ff78bd2fSdrh   }
1496ff78bd2fSdrh   return pNew;
1497ff78bd2fSdrh }
1498a7466205Sdan Select *sqlite3SelectDup(sqlite3 *db, Select *pDup, int flags){
1499a7466205Sdan   Select *pRet = 0;
1500a7466205Sdan   Select *pNext = 0;
1501a7466205Sdan   Select **pp = &pRet;
1502a7466205Sdan   Select *p;
1503a7466205Sdan 
1504575fad65Sdrh   assert( db!=0 );
1505a7466205Sdan   for(p=pDup; p; p=p->pPrior){
1506a7466205Sdan     Select *pNew = sqlite3DbMallocRawNN(db, sizeof(*p) );
1507a7466205Sdan     if( pNew==0 ) break;
1508b7916a78Sdrh     pNew->pEList = sqlite3ExprListDup(db, p->pEList, flags);
15096ab3a2ecSdanielk1977     pNew->pSrc = sqlite3SrcListDup(db, p->pSrc, flags);
15106ab3a2ecSdanielk1977     pNew->pWhere = sqlite3ExprDup(db, p->pWhere, flags);
15116ab3a2ecSdanielk1977     pNew->pGroupBy = sqlite3ExprListDup(db, p->pGroupBy, flags);
15126ab3a2ecSdanielk1977     pNew->pHaving = sqlite3ExprDup(db, p->pHaving, flags);
15136ab3a2ecSdanielk1977     pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, flags);
1514ff78bd2fSdrh     pNew->op = p->op;
1515a7466205Sdan     pNew->pNext = pNext;
1516a7466205Sdan     pNew->pPrior = 0;
15176ab3a2ecSdanielk1977     pNew->pLimit = sqlite3ExprDup(db, p->pLimit, flags);
151892b01d53Sdrh     pNew->iLimit = 0;
151992b01d53Sdrh     pNew->iOffset = 0;
15207d10d5a6Sdrh     pNew->selFlags = p->selFlags & ~SF_UsesEphemeral;
1521b9bb7c18Sdrh     pNew->addrOpenEphm[0] = -1;
1522b9bb7c18Sdrh     pNew->addrOpenEphm[1] = -1;
1523ec2da854Sdrh     pNew->nSelectRow = p->nSelectRow;
15244e9119d9Sdan     pNew->pWith = withDup(db, p->pWith);
152567a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
15262e362f97Sdan     pNew->pWin = 0;
1527c95f38d4Sdan     pNew->pWinDefn = sqlite3WindowListDup(db, p->pWinDefn);
15284780b9adSdan     if( p->pWin && db->mallocFailed==0 ) gatherSelectWindows(pNew);
152967a9b8edSdan #endif
1530fef37760Sdrh     pNew->selId = p->selId;
1531a7466205Sdan     *pp = pNew;
1532a7466205Sdan     pp = &pNew->pPrior;
1533a7466205Sdan     pNext = pNew;
1534a7466205Sdan   }
1535a7466205Sdan 
1536a7466205Sdan   return pRet;
1537ff78bd2fSdrh }
153893758c8dSdanielk1977 #else
15396ab3a2ecSdanielk1977 Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
154093758c8dSdanielk1977   assert( p==0 );
154193758c8dSdanielk1977   return 0;
154293758c8dSdanielk1977 }
154393758c8dSdanielk1977 #endif
1544ff78bd2fSdrh 
1545ff78bd2fSdrh 
1546ff78bd2fSdrh /*
1547a76b5dfcSdrh ** Add a new element to the end of an expression list.  If pList is
1548a76b5dfcSdrh ** initially NULL, then create a new expression list.
1549b7916a78Sdrh **
1550a19543feSdrh ** The pList argument must be either NULL or a pointer to an ExprList
1551a19543feSdrh ** obtained from a prior call to sqlite3ExprListAppend().  This routine
1552a19543feSdrh ** may not be used with an ExprList obtained from sqlite3ExprListDup().
1553a19543feSdrh ** Reason:  This routine assumes that the number of slots in pList->a[]
1554a19543feSdrh ** is a power of two.  That is true for sqlite3ExprListAppend() returns
1555a19543feSdrh ** but is not necessarily true from the return value of sqlite3ExprListDup().
1556a19543feSdrh **
1557b7916a78Sdrh ** If a memory allocation error occurs, the entire list is freed and
1558b7916a78Sdrh ** NULL is returned.  If non-NULL is returned, then it is guaranteed
1559b7916a78Sdrh ** that the new entry was successfully appended.
1560a76b5dfcSdrh */
156117435752Sdrh ExprList *sqlite3ExprListAppend(
156217435752Sdrh   Parse *pParse,          /* Parsing context */
156317435752Sdrh   ExprList *pList,        /* List to which to append. Might be NULL */
1564b7916a78Sdrh   Expr *pExpr             /* Expression to be appended. Might be NULL */
156517435752Sdrh ){
156643606175Sdrh   struct ExprList_item *pItem;
156717435752Sdrh   sqlite3 *db = pParse->db;
1568575fad65Sdrh   assert( db!=0 );
1569a76b5dfcSdrh   if( pList==0 ){
1570575fad65Sdrh     pList = sqlite3DbMallocRawNN(db, sizeof(ExprList) );
1571a76b5dfcSdrh     if( pList==0 ){
1572d5d56523Sdanielk1977       goto no_mem;
1573a76b5dfcSdrh     }
1574c263f7c4Sdrh     pList->nExpr = 0;
1575a19543feSdrh   }else if( (pList->nExpr & (pList->nExpr-1))==0 ){
157643606175Sdrh     ExprList *pNew;
157743606175Sdrh     pNew = sqlite3DbRealloc(db, pList,
15780aa3231fSdrh          sizeof(*pList)+(2*(sqlite3_int64)pList->nExpr-1)*sizeof(pList->a[0]));
157943606175Sdrh     if( pNew==0 ){
1580d5d56523Sdanielk1977       goto no_mem;
1581a76b5dfcSdrh     }
158243606175Sdrh     pList = pNew;
1583a76b5dfcSdrh   }
158443606175Sdrh   pItem = &pList->a[pList->nExpr++];
1585a8b9793cSdrh   assert( offsetof(struct ExprList_item,zName)==sizeof(pItem->pExpr) );
1586a8b9793cSdrh   assert( offsetof(struct ExprList_item,pExpr)==0 );
1587a8b9793cSdrh   memset(&pItem->zName,0,sizeof(*pItem)-offsetof(struct ExprList_item,zName));
1588e94ddc9eSdanielk1977   pItem->pExpr = pExpr;
1589a76b5dfcSdrh   return pList;
1590d5d56523Sdanielk1977 
1591d5d56523Sdanielk1977 no_mem:
1592d5d56523Sdanielk1977   /* Avoid leaking memory if malloc has failed. */
1593633e6d57Sdrh   sqlite3ExprDelete(db, pExpr);
1594633e6d57Sdrh   sqlite3ExprListDelete(db, pList);
1595d5d56523Sdanielk1977   return 0;
1596a76b5dfcSdrh }
1597a76b5dfcSdrh 
1598a76b5dfcSdrh /*
15998762ec19Sdrh ** pColumns and pExpr form a vector assignment which is part of the SET
16008762ec19Sdrh ** clause of an UPDATE statement.  Like this:
1601a1251bc4Sdrh **
1602a1251bc4Sdrh **        (a,b,c) = (expr1,expr2,expr3)
1603a1251bc4Sdrh ** Or:    (a,b,c) = (SELECT x,y,z FROM ....)
1604a1251bc4Sdrh **
1605a1251bc4Sdrh ** For each term of the vector assignment, append new entries to the
1606b67343d0Sdrh ** expression list pList.  In the case of a subquery on the RHS, append
1607a1251bc4Sdrh ** TK_SELECT_COLUMN expressions.
1608a1251bc4Sdrh */
1609a1251bc4Sdrh ExprList *sqlite3ExprListAppendVector(
1610a1251bc4Sdrh   Parse *pParse,         /* Parsing context */
1611a1251bc4Sdrh   ExprList *pList,       /* List to which to append. Might be NULL */
1612a1251bc4Sdrh   IdList *pColumns,      /* List of names of LHS of the assignment */
1613a1251bc4Sdrh   Expr *pExpr            /* Vector expression to be appended. Might be NULL */
1614a1251bc4Sdrh ){
1615a1251bc4Sdrh   sqlite3 *db = pParse->db;
1616a1251bc4Sdrh   int n;
1617a1251bc4Sdrh   int i;
161866860af3Sdrh   int iFirst = pList ? pList->nExpr : 0;
1619321e828dSdrh   /* pColumns can only be NULL due to an OOM but an OOM will cause an
1620321e828dSdrh   ** exit prior to this routine being invoked */
1621321e828dSdrh   if( NEVER(pColumns==0) ) goto vector_append_error;
1622a1251bc4Sdrh   if( pExpr==0 ) goto vector_append_error;
1623966e2911Sdrh 
1624966e2911Sdrh   /* If the RHS is a vector, then we can immediately check to see that
1625966e2911Sdrh   ** the size of the RHS and LHS match.  But if the RHS is a SELECT,
1626966e2911Sdrh   ** wildcards ("*") in the result set of the SELECT must be expanded before
1627966e2911Sdrh   ** we can do the size check, so defer the size check until code generation.
1628966e2911Sdrh   */
1629966e2911Sdrh   if( pExpr->op!=TK_SELECT && pColumns->nId!=(n=sqlite3ExprVectorSize(pExpr)) ){
1630a1251bc4Sdrh     sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
1631a1251bc4Sdrh                     pColumns->nId, n);
1632a1251bc4Sdrh     goto vector_append_error;
1633a1251bc4Sdrh   }
1634966e2911Sdrh 
1635966e2911Sdrh   for(i=0; i<pColumns->nId; i++){
1636a1251bc4Sdrh     Expr *pSubExpr = sqlite3ExprForVectorField(pParse, pExpr, i);
1637554a9dc7Sdrh     assert( pSubExpr!=0 || db->mallocFailed );
1638554a9dc7Sdrh     assert( pSubExpr==0 || pSubExpr->iTable==0 );
1639554a9dc7Sdrh     if( pSubExpr==0 ) continue;
1640554a9dc7Sdrh     pSubExpr->iTable = pColumns->nId;
1641a1251bc4Sdrh     pList = sqlite3ExprListAppend(pParse, pList, pSubExpr);
1642a1251bc4Sdrh     if( pList ){
164366860af3Sdrh       assert( pList->nExpr==iFirst+i+1 );
1644a1251bc4Sdrh       pList->a[pList->nExpr-1].zName = pColumns->a[i].zName;
1645a1251bc4Sdrh       pColumns->a[i].zName = 0;
1646a1251bc4Sdrh     }
1647a1251bc4Sdrh   }
1648966e2911Sdrh 
1649ffe28059Sdrh   if( !db->mallocFailed && pExpr->op==TK_SELECT && ALWAYS(pList!=0) ){
1650966e2911Sdrh     Expr *pFirst = pList->a[iFirst].pExpr;
1651f4dd26c5Sdrh     assert( pFirst!=0 );
1652966e2911Sdrh     assert( pFirst->op==TK_SELECT_COLUMN );
1653966e2911Sdrh 
1654966e2911Sdrh     /* Store the SELECT statement in pRight so it will be deleted when
1655966e2911Sdrh     ** sqlite3ExprListDelete() is called */
1656966e2911Sdrh     pFirst->pRight = pExpr;
1657a1251bc4Sdrh     pExpr = 0;
1658966e2911Sdrh 
1659966e2911Sdrh     /* Remember the size of the LHS in iTable so that we can check that
1660966e2911Sdrh     ** the RHS and LHS sizes match during code generation. */
1661966e2911Sdrh     pFirst->iTable = pColumns->nId;
1662a1251bc4Sdrh   }
1663a1251bc4Sdrh 
1664a1251bc4Sdrh vector_append_error:
16658e34e406Sdrh   sqlite3ExprUnmapAndDelete(pParse, pExpr);
1666a1251bc4Sdrh   sqlite3IdListDelete(db, pColumns);
1667a1251bc4Sdrh   return pList;
1668a1251bc4Sdrh }
1669a1251bc4Sdrh 
1670a1251bc4Sdrh /*
1671bc622bc0Sdrh ** Set the sort order for the last element on the given ExprList.
1672bc622bc0Sdrh */
16736e11892dSdan void sqlite3ExprListSetSortOrder(ExprList *p, int iSortOrder, int eNulls){
16749105fd51Sdan   struct ExprList_item *pItem;
1675bc622bc0Sdrh   if( p==0 ) return;
1676bc622bc0Sdrh   assert( p->nExpr>0 );
16776e11892dSdan 
16786e11892dSdan   assert( SQLITE_SO_UNDEFINED<0 && SQLITE_SO_ASC==0 && SQLITE_SO_DESC>0 );
16796e11892dSdan   assert( iSortOrder==SQLITE_SO_UNDEFINED
16806e11892dSdan        || iSortOrder==SQLITE_SO_ASC
16816e11892dSdan        || iSortOrder==SQLITE_SO_DESC
16826e11892dSdan   );
16836e11892dSdan   assert( eNulls==SQLITE_SO_UNDEFINED
16846e11892dSdan        || eNulls==SQLITE_SO_ASC
16856e11892dSdan        || eNulls==SQLITE_SO_DESC
16866e11892dSdan   );
16876e11892dSdan 
16889105fd51Sdan   pItem = &p->a[p->nExpr-1];
16899105fd51Sdan   assert( pItem->bNulls==0 );
16909105fd51Sdan   if( iSortOrder==SQLITE_SO_UNDEFINED ){
16919105fd51Sdan     iSortOrder = SQLITE_SO_ASC;
1692bc622bc0Sdrh   }
16939105fd51Sdan   pItem->sortFlags = (u8)iSortOrder;
16949105fd51Sdan 
16959105fd51Sdan   if( eNulls!=SQLITE_SO_UNDEFINED ){
16969105fd51Sdan     pItem->bNulls = 1;
16979105fd51Sdan     if( iSortOrder!=eNulls ){
16989105fd51Sdan       pItem->sortFlags |= KEYINFO_ORDER_BIGNULL;
16999105fd51Sdan     }
1700bc622bc0Sdrh   }
1701bc622bc0Sdrh }
1702bc622bc0Sdrh 
1703bc622bc0Sdrh /*
1704b7916a78Sdrh ** Set the ExprList.a[].zName element of the most recently added item
1705b7916a78Sdrh ** on the expression list.
1706b7916a78Sdrh **
1707b7916a78Sdrh ** pList might be NULL following an OOM error.  But pName should never be
1708b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1709b7916a78Sdrh ** is set.
1710b7916a78Sdrh */
1711b7916a78Sdrh void sqlite3ExprListSetName(
1712b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1713b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
1714b7916a78Sdrh   Token *pName,           /* Name to be added */
1715b7916a78Sdrh   int dequote             /* True to cause the name to be dequoted */
1716b7916a78Sdrh ){
1717b7916a78Sdrh   assert( pList!=0 || pParse->db->mallocFailed!=0 );
1718b7916a78Sdrh   if( pList ){
1719b7916a78Sdrh     struct ExprList_item *pItem;
1720b7916a78Sdrh     assert( pList->nExpr>0 );
1721b7916a78Sdrh     pItem = &pList->a[pList->nExpr-1];
1722b7916a78Sdrh     assert( pItem->zName==0 );
1723b7916a78Sdrh     pItem->zName = sqlite3DbStrNDup(pParse->db, pName->z, pName->n);
1724244b9d6eSdrh     if( dequote ) sqlite3Dequote(pItem->zName);
1725c9461eccSdan     if( IN_RENAME_OBJECT ){
172607e95233Sdan       sqlite3RenameTokenMap(pParse, (void*)pItem->zName, pName);
17275be60c55Sdan     }
1728b7916a78Sdrh   }
1729b7916a78Sdrh }
1730b7916a78Sdrh 
1731b7916a78Sdrh /*
1732b7916a78Sdrh ** Set the ExprList.a[].zSpan element of the most recently added item
1733b7916a78Sdrh ** on the expression list.
1734b7916a78Sdrh **
1735b7916a78Sdrh ** pList might be NULL following an OOM error.  But pSpan should never be
1736b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1737b7916a78Sdrh ** is set.
1738b7916a78Sdrh */
1739b7916a78Sdrh void sqlite3ExprListSetSpan(
1740b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1741b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
17421be266baSdrh   const char *zStart,     /* Start of the span */
17431be266baSdrh   const char *zEnd        /* End of the span */
1744b7916a78Sdrh ){
1745b7916a78Sdrh   sqlite3 *db = pParse->db;
1746b7916a78Sdrh   assert( pList!=0 || db->mallocFailed!=0 );
1747b7916a78Sdrh   if( pList ){
1748b7916a78Sdrh     struct ExprList_item *pItem = &pList->a[pList->nExpr-1];
1749b7916a78Sdrh     assert( pList->nExpr>0 );
1750b7916a78Sdrh     sqlite3DbFree(db, pItem->zSpan);
17519b2e0435Sdrh     pItem->zSpan = sqlite3DbSpanDup(db, zStart, zEnd);
1752b7916a78Sdrh   }
1753b7916a78Sdrh }
1754b7916a78Sdrh 
1755b7916a78Sdrh /*
17567a15a4beSdanielk1977 ** If the expression list pEList contains more than iLimit elements,
17577a15a4beSdanielk1977 ** leave an error message in pParse.
17587a15a4beSdanielk1977 */
17597a15a4beSdanielk1977 void sqlite3ExprListCheckLength(
17607a15a4beSdanielk1977   Parse *pParse,
17617a15a4beSdanielk1977   ExprList *pEList,
17627a15a4beSdanielk1977   const char *zObject
17637a15a4beSdanielk1977 ){
1764b1a6c3c1Sdrh   int mx = pParse->db->aLimit[SQLITE_LIMIT_COLUMN];
1765c5499befSdrh   testcase( pEList && pEList->nExpr==mx );
1766c5499befSdrh   testcase( pEList && pEList->nExpr==mx+1 );
1767b1a6c3c1Sdrh   if( pEList && pEList->nExpr>mx ){
17687a15a4beSdanielk1977     sqlite3ErrorMsg(pParse, "too many columns in %s", zObject);
17697a15a4beSdanielk1977   }
17707a15a4beSdanielk1977 }
17717a15a4beSdanielk1977 
17727a15a4beSdanielk1977 /*
1773a76b5dfcSdrh ** Delete an entire expression list.
1774a76b5dfcSdrh */
1775affa855cSdrh static SQLITE_NOINLINE void exprListDeleteNN(sqlite3 *db, ExprList *pList){
1776ac48b751Sdrh   int i = pList->nExpr;
1777ac48b751Sdrh   struct ExprList_item *pItem =  pList->a;
1778ac48b751Sdrh   assert( pList->nExpr>0 );
1779ac48b751Sdrh   do{
1780633e6d57Sdrh     sqlite3ExprDelete(db, pItem->pExpr);
1781633e6d57Sdrh     sqlite3DbFree(db, pItem->zName);
1782b7916a78Sdrh     sqlite3DbFree(db, pItem->zSpan);
1783ac48b751Sdrh     pItem++;
1784ac48b751Sdrh   }while( --i>0 );
1785dbd6a7dcSdrh   sqlite3DbFreeNN(db, pList);
1786a76b5dfcSdrh }
1787affa855cSdrh void sqlite3ExprListDelete(sqlite3 *db, ExprList *pList){
1788affa855cSdrh   if( pList ) exprListDeleteNN(db, pList);
1789affa855cSdrh }
1790a76b5dfcSdrh 
1791a76b5dfcSdrh /*
17922308ed38Sdrh ** Return the bitwise-OR of all Expr.flags fields in the given
17932308ed38Sdrh ** ExprList.
1794885a5b03Sdrh */
17952308ed38Sdrh u32 sqlite3ExprListFlags(const ExprList *pList){
1796885a5b03Sdrh   int i;
17972308ed38Sdrh   u32 m = 0;
1798508e2d00Sdrh   assert( pList!=0 );
1799885a5b03Sdrh   for(i=0; i<pList->nExpr; i++){
1800d0c73053Sdrh      Expr *pExpr = pList->a[i].pExpr;
1801de845c2fSdrh      assert( pExpr!=0 );
1802de845c2fSdrh      m |= pExpr->flags;
1803885a5b03Sdrh   }
18042308ed38Sdrh   return m;
1805885a5b03Sdrh }
1806885a5b03Sdrh 
1807885a5b03Sdrh /*
18087e6f980bSdrh ** This is a SELECT-node callback for the expression walker that
18097e6f980bSdrh ** always "fails".  By "fail" in this case, we mean set
18107e6f980bSdrh ** pWalker->eCode to zero and abort.
18117e6f980bSdrh **
18127e6f980bSdrh ** This callback is used by multiple expression walkers.
18137e6f980bSdrh */
18147e6f980bSdrh int sqlite3SelectWalkFail(Walker *pWalker, Select *NotUsed){
18157e6f980bSdrh   UNUSED_PARAMETER(NotUsed);
18167e6f980bSdrh   pWalker->eCode = 0;
18177e6f980bSdrh   return WRC_Abort;
18187e6f980bSdrh }
18197e6f980bSdrh 
18207e6f980bSdrh /*
1821171d16bbSdrh ** If the input expression is an ID with the name "true" or "false"
182296acafbeSdrh ** then convert it into an TK_TRUEFALSE term.  Return non-zero if
182396acafbeSdrh ** the conversion happened, and zero if the expression is unaltered.
1824171d16bbSdrh */
1825171d16bbSdrh int sqlite3ExprIdToTrueFalse(Expr *pExpr){
1826171d16bbSdrh   assert( pExpr->op==TK_ID || pExpr->op==TK_STRING );
182751d35b0fSdrh   if( !ExprHasProperty(pExpr, EP_Quoted)
182851d35b0fSdrh    && (sqlite3StrICmp(pExpr->u.zToken, "true")==0
182951d35b0fSdrh        || sqlite3StrICmp(pExpr->u.zToken, "false")==0)
1830171d16bbSdrh   ){
1831171d16bbSdrh     pExpr->op = TK_TRUEFALSE;
1832ad31727fSdrh     ExprSetProperty(pExpr, pExpr->u.zToken[4]==0 ? EP_IsTrue : EP_IsFalse);
1833171d16bbSdrh     return 1;
1834171d16bbSdrh   }
1835171d16bbSdrh   return 0;
1836171d16bbSdrh }
1837171d16bbSdrh 
183843c4ac8bSdrh /*
183996acafbeSdrh ** The argument must be a TK_TRUEFALSE Expr node.  Return 1 if it is TRUE
184043c4ac8bSdrh ** and 0 if it is FALSE.
184143c4ac8bSdrh */
184296acafbeSdrh int sqlite3ExprTruthValue(const Expr *pExpr){
18436ece353fSdan   pExpr = sqlite3ExprSkipCollate((Expr*)pExpr);
184443c4ac8bSdrh   assert( pExpr->op==TK_TRUEFALSE );
184543c4ac8bSdrh   assert( sqlite3StrICmp(pExpr->u.zToken,"true")==0
184643c4ac8bSdrh        || sqlite3StrICmp(pExpr->u.zToken,"false")==0 );
184743c4ac8bSdrh   return pExpr->u.zToken[4]==0;
184843c4ac8bSdrh }
184943c4ac8bSdrh 
185017180fcaSdrh /*
185117180fcaSdrh ** If pExpr is an AND or OR expression, try to simplify it by eliminating
185217180fcaSdrh ** terms that are always true or false.  Return the simplified expression.
185317180fcaSdrh ** Or return the original expression if no simplification is possible.
185417180fcaSdrh **
185517180fcaSdrh ** Examples:
185617180fcaSdrh **
185717180fcaSdrh **     (x<10) AND true                =>   (x<10)
185817180fcaSdrh **     (x<10) AND false               =>   false
185917180fcaSdrh **     (x<10) AND (y=22 OR false)     =>   (x<10) AND (y=22)
186017180fcaSdrh **     (x<10) AND (y=22 OR true)      =>   (x<10)
186117180fcaSdrh **     (y=22) OR true                 =>   true
186217180fcaSdrh */
186317180fcaSdrh Expr *sqlite3ExprSimplifiedAndOr(Expr *pExpr){
186417180fcaSdrh   assert( pExpr!=0 );
186517180fcaSdrh   if( pExpr->op==TK_AND || pExpr->op==TK_OR ){
186617180fcaSdrh     Expr *pRight = sqlite3ExprSimplifiedAndOr(pExpr->pRight);
186717180fcaSdrh     Expr *pLeft = sqlite3ExprSimplifiedAndOr(pExpr->pLeft);
186817180fcaSdrh     if( ExprAlwaysTrue(pLeft) || ExprAlwaysFalse(pRight) ){
186917180fcaSdrh       pExpr = pExpr->op==TK_AND ? pRight : pLeft;
187017180fcaSdrh     }else if( ExprAlwaysTrue(pRight) || ExprAlwaysFalse(pLeft) ){
187117180fcaSdrh       pExpr = pExpr->op==TK_AND ? pLeft : pRight;
187217180fcaSdrh     }
187317180fcaSdrh   }
187417180fcaSdrh   return pExpr;
187517180fcaSdrh }
187617180fcaSdrh 
1877171d16bbSdrh 
1878171d16bbSdrh /*
1879059b2d50Sdrh ** These routines are Walker callbacks used to check expressions to
1880059b2d50Sdrh ** see if they are "constant" for some definition of constant.  The
1881059b2d50Sdrh ** Walker.eCode value determines the type of "constant" we are looking
1882059b2d50Sdrh ** for.
188373b211abSdrh **
18847d10d5a6Sdrh ** These callback routines are used to implement the following:
1885626a879aSdrh **
1886059b2d50Sdrh **     sqlite3ExprIsConstant()                  pWalker->eCode==1
1887059b2d50Sdrh **     sqlite3ExprIsConstantNotJoin()           pWalker->eCode==2
1888fcb9f4f3Sdrh **     sqlite3ExprIsTableConstant()             pWalker->eCode==3
1889059b2d50Sdrh **     sqlite3ExprIsConstantOrFunction()        pWalker->eCode==4 or 5
189087abf5c0Sdrh **
1891059b2d50Sdrh ** In all cases, the callbacks set Walker.eCode=0 and abort if the expression
1892059b2d50Sdrh ** is found to not be a constant.
189387abf5c0Sdrh **
1894feada2dfSdrh ** The sqlite3ExprIsConstantOrFunction() is used for evaluating expressions
1895059b2d50Sdrh ** in a CREATE TABLE statement.  The Walker.eCode value is 5 when parsing
1896059b2d50Sdrh ** an existing schema and 4 when processing a new statement.  A bound
1897feada2dfSdrh ** parameter raises an error for new statements, but is silently converted
1898feada2dfSdrh ** to NULL for existing schemas.  This allows sqlite_master tables that
1899feada2dfSdrh ** contain a bound parameter because they were generated by older versions
1900feada2dfSdrh ** of SQLite to be parsed by newer versions of SQLite without raising a
1901feada2dfSdrh ** malformed schema error.
1902626a879aSdrh */
19037d10d5a6Sdrh static int exprNodeIsConstant(Walker *pWalker, Expr *pExpr){
1904626a879aSdrh 
1905059b2d50Sdrh   /* If pWalker->eCode is 2 then any term of the expression that comes from
1906059b2d50Sdrh   ** the ON or USING clauses of a left join disqualifies the expression
19070a168377Sdrh   ** from being considered constant. */
1908059b2d50Sdrh   if( pWalker->eCode==2 && ExprHasProperty(pExpr, EP_FromJoin) ){
1909059b2d50Sdrh     pWalker->eCode = 0;
19107d10d5a6Sdrh     return WRC_Abort;
19110a168377Sdrh   }
19120a168377Sdrh 
1913626a879aSdrh   switch( pExpr->op ){
1914eb55bd2fSdrh     /* Consider functions to be constant if all their arguments are constant
1915059b2d50Sdrh     ** and either pWalker->eCode==4 or 5 or the function has the
1916059b2d50Sdrh     ** SQLITE_FUNC_CONST flag. */
1917eb55bd2fSdrh     case TK_FUNCTION:
191863f84573Sdrh       if( pWalker->eCode>=4 || ExprHasProperty(pExpr,EP_ConstFunc) ){
1919b1fba286Sdrh         return WRC_Continue;
1920059b2d50Sdrh       }else{
1921059b2d50Sdrh         pWalker->eCode = 0;
1922059b2d50Sdrh         return WRC_Abort;
1923b1fba286Sdrh       }
1924626a879aSdrh     case TK_ID:
1925171d16bbSdrh       /* Convert "true" or "false" in a DEFAULT clause into the
1926171d16bbSdrh       ** appropriate TK_TRUEFALSE operator */
1927e39ef31cSdrh       if( sqlite3ExprIdToTrueFalse(pExpr) ){
1928171d16bbSdrh         return WRC_Prune;
1929171d16bbSdrh       }
1930171d16bbSdrh       /* Fall thru */
1931626a879aSdrh     case TK_COLUMN:
1932626a879aSdrh     case TK_AGG_FUNCTION:
193313449892Sdrh     case TK_AGG_COLUMN:
1934c5499befSdrh       testcase( pExpr->op==TK_ID );
1935c5499befSdrh       testcase( pExpr->op==TK_COLUMN );
1936c5499befSdrh       testcase( pExpr->op==TK_AGG_FUNCTION );
1937c5499befSdrh       testcase( pExpr->op==TK_AGG_COLUMN );
193807aded63Sdrh       if( ExprHasProperty(pExpr, EP_FixedCol) && pWalker->eCode!=2 ){
1939efad2e23Sdrh         return WRC_Continue;
1940efad2e23Sdrh       }
1941059b2d50Sdrh       if( pWalker->eCode==3 && pExpr->iTable==pWalker->u.iCur ){
1942059b2d50Sdrh         return WRC_Continue;
1943f43ce0b4Sdrh       }
1944f43ce0b4Sdrh       /* Fall through */
1945f43ce0b4Sdrh     case TK_IF_NULL_ROW:
19466e341b93Sdrh     case TK_REGISTER:
19479916048bSdrh       testcase( pExpr->op==TK_REGISTER );
1948f43ce0b4Sdrh       testcase( pExpr->op==TK_IF_NULL_ROW );
1949059b2d50Sdrh       pWalker->eCode = 0;
19507d10d5a6Sdrh       return WRC_Abort;
1951feada2dfSdrh     case TK_VARIABLE:
1952059b2d50Sdrh       if( pWalker->eCode==5 ){
1953feada2dfSdrh         /* Silently convert bound parameters that appear inside of CREATE
1954feada2dfSdrh         ** statements into a NULL when parsing the CREATE statement text out
1955feada2dfSdrh         ** of the sqlite_master table */
1956feada2dfSdrh         pExpr->op = TK_NULL;
1957059b2d50Sdrh       }else if( pWalker->eCode==4 ){
1958feada2dfSdrh         /* A bound parameter in a CREATE statement that originates from
1959feada2dfSdrh         ** sqlite3_prepare() causes an error */
1960059b2d50Sdrh         pWalker->eCode = 0;
1961feada2dfSdrh         return WRC_Abort;
1962feada2dfSdrh       }
1963feada2dfSdrh       /* Fall through */
1964626a879aSdrh     default:
19656e341b93Sdrh       testcase( pExpr->op==TK_SELECT ); /* sqlite3SelectWalkFail() disallows */
19666e341b93Sdrh       testcase( pExpr->op==TK_EXISTS ); /* sqlite3SelectWalkFail() disallows */
19677d10d5a6Sdrh       return WRC_Continue;
1968626a879aSdrh   }
1969626a879aSdrh }
1970059b2d50Sdrh static int exprIsConst(Expr *p, int initFlag, int iCur){
19717d10d5a6Sdrh   Walker w;
1972059b2d50Sdrh   w.eCode = initFlag;
19737d10d5a6Sdrh   w.xExprCallback = exprNodeIsConstant;
19747e6f980bSdrh   w.xSelectCallback = sqlite3SelectWalkFail;
1975979dd1beSdrh #ifdef SQLITE_DEBUG
1976979dd1beSdrh   w.xSelectCallback2 = sqlite3SelectWalkAssert2;
1977979dd1beSdrh #endif
1978059b2d50Sdrh   w.u.iCur = iCur;
19797d10d5a6Sdrh   sqlite3WalkExpr(&w, p);
1980059b2d50Sdrh   return w.eCode;
19817d10d5a6Sdrh }
1982626a879aSdrh 
1983626a879aSdrh /*
1984059b2d50Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
1985eb55bd2fSdrh ** and 0 if it involves variables or function calls.
19862398937bSdrh **
19872398937bSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
19882398937bSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
19892398937bSdrh ** a constant.
1990fef5208cSdrh */
19914adee20fSdanielk1977 int sqlite3ExprIsConstant(Expr *p){
1992059b2d50Sdrh   return exprIsConst(p, 1, 0);
1993fef5208cSdrh }
1994fef5208cSdrh 
1995fef5208cSdrh /*
199607aded63Sdrh ** Walk an expression tree.  Return non-zero if
199707aded63Sdrh **
199807aded63Sdrh **   (1) the expression is constant, and
199907aded63Sdrh **   (2) the expression does originate in the ON or USING clause
200007aded63Sdrh **       of a LEFT JOIN, and
200107aded63Sdrh **   (3) the expression does not contain any EP_FixedCol TK_COLUMN
200207aded63Sdrh **       operands created by the constant propagation optimization.
200307aded63Sdrh **
200407aded63Sdrh ** When this routine returns true, it indicates that the expression
200507aded63Sdrh ** can be added to the pParse->pConstExpr list and evaluated once when
200607aded63Sdrh ** the prepared statement starts up.  See sqlite3ExprCodeAtInit().
20070a168377Sdrh */
20080a168377Sdrh int sqlite3ExprIsConstantNotJoin(Expr *p){
2009059b2d50Sdrh   return exprIsConst(p, 2, 0);
20100a168377Sdrh }
20110a168377Sdrh 
20120a168377Sdrh /*
2013fcb9f4f3Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
2014059b2d50Sdrh ** for any single row of the table with cursor iCur.  In other words, the
2015059b2d50Sdrh ** expression must not refer to any non-deterministic function nor any
2016059b2d50Sdrh ** table other than iCur.
2017059b2d50Sdrh */
2018059b2d50Sdrh int sqlite3ExprIsTableConstant(Expr *p, int iCur){
2019059b2d50Sdrh   return exprIsConst(p, 3, iCur);
2020059b2d50Sdrh }
2021059b2d50Sdrh 
2022ab31a845Sdan 
2023ab31a845Sdan /*
2024ab31a845Sdan ** sqlite3WalkExpr() callback used by sqlite3ExprIsConstantOrGroupBy().
2025ab31a845Sdan */
2026ab31a845Sdan static int exprNodeIsConstantOrGroupBy(Walker *pWalker, Expr *pExpr){
2027ab31a845Sdan   ExprList *pGroupBy = pWalker->u.pGroupBy;
2028ab31a845Sdan   int i;
2029ab31a845Sdan 
2030ab31a845Sdan   /* Check if pExpr is identical to any GROUP BY term. If so, consider
2031ab31a845Sdan   ** it constant.  */
2032ab31a845Sdan   for(i=0; i<pGroupBy->nExpr; i++){
2033ab31a845Sdan     Expr *p = pGroupBy->a[i].pExpr;
20345aa550cfSdan     if( sqlite3ExprCompare(0, pExpr, p, -1)<2 ){
203570efa84dSdrh       CollSeq *pColl = sqlite3ExprNNCollSeq(pWalker->pParse, p);
2036efad2e23Sdrh       if( sqlite3IsBinary(pColl) ){
2037ab31a845Sdan         return WRC_Prune;
2038ab31a845Sdan       }
2039ab31a845Sdan     }
2040ab31a845Sdan   }
2041ab31a845Sdan 
2042ab31a845Sdan   /* Check if pExpr is a sub-select. If so, consider it variable. */
2043ab31a845Sdan   if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2044ab31a845Sdan     pWalker->eCode = 0;
2045ab31a845Sdan     return WRC_Abort;
2046ab31a845Sdan   }
2047ab31a845Sdan 
2048ab31a845Sdan   return exprNodeIsConstant(pWalker, pExpr);
2049ab31a845Sdan }
2050ab31a845Sdan 
2051ab31a845Sdan /*
2052ab31a845Sdan ** Walk the expression tree passed as the first argument. Return non-zero
2053ab31a845Sdan ** if the expression consists entirely of constants or copies of terms
2054ab31a845Sdan ** in pGroupBy that sort with the BINARY collation sequence.
2055ab314001Sdrh **
2056ab314001Sdrh ** This routine is used to determine if a term of the HAVING clause can
2057ab314001Sdrh ** be promoted into the WHERE clause.  In order for such a promotion to work,
2058ab314001Sdrh ** the value of the HAVING clause term must be the same for all members of
2059ab314001Sdrh ** a "group".  The requirement that the GROUP BY term must be BINARY
2060ab314001Sdrh ** assumes that no other collating sequence will have a finer-grained
2061ab314001Sdrh ** grouping than binary.  In other words (A=B COLLATE binary) implies
2062ab314001Sdrh ** A=B in every other collating sequence.  The requirement that the
2063ab314001Sdrh ** GROUP BY be BINARY is stricter than necessary.  It would also work
2064ab314001Sdrh ** to promote HAVING clauses that use the same alternative collating
2065ab314001Sdrh ** sequence as the GROUP BY term, but that is much harder to check,
2066ab314001Sdrh ** alternative collating sequences are uncommon, and this is only an
2067ab314001Sdrh ** optimization, so we take the easy way out and simply require the
2068ab314001Sdrh ** GROUP BY to use the BINARY collating sequence.
2069ab31a845Sdan */
2070ab31a845Sdan int sqlite3ExprIsConstantOrGroupBy(Parse *pParse, Expr *p, ExprList *pGroupBy){
2071ab31a845Sdan   Walker w;
2072ab31a845Sdan   w.eCode = 1;
2073ab31a845Sdan   w.xExprCallback = exprNodeIsConstantOrGroupBy;
2074979dd1beSdrh   w.xSelectCallback = 0;
2075ab31a845Sdan   w.u.pGroupBy = pGroupBy;
2076ab31a845Sdan   w.pParse = pParse;
2077ab31a845Sdan   sqlite3WalkExpr(&w, p);
2078ab31a845Sdan   return w.eCode;
2079ab31a845Sdan }
2080ab31a845Sdan 
2081059b2d50Sdrh /*
2082059b2d50Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
2083eb55bd2fSdrh ** or a function call with constant arguments.  Return and 0 if there
2084eb55bd2fSdrh ** are any variables.
2085eb55bd2fSdrh **
2086eb55bd2fSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
2087eb55bd2fSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
2088eb55bd2fSdrh ** a constant.
2089eb55bd2fSdrh */
2090feada2dfSdrh int sqlite3ExprIsConstantOrFunction(Expr *p, u8 isInit){
2091feada2dfSdrh   assert( isInit==0 || isInit==1 );
2092059b2d50Sdrh   return exprIsConst(p, 4+isInit, 0);
2093eb55bd2fSdrh }
2094eb55bd2fSdrh 
20955b88bc4bSdrh #ifdef SQLITE_ENABLE_CURSOR_HINTS
20965b88bc4bSdrh /*
20975b88bc4bSdrh ** Walk an expression tree.  Return 1 if the expression contains a
20985b88bc4bSdrh ** subquery of some kind.  Return 0 if there are no subqueries.
20995b88bc4bSdrh */
21005b88bc4bSdrh int sqlite3ExprContainsSubquery(Expr *p){
21015b88bc4bSdrh   Walker w;
2102bec2476aSdrh   w.eCode = 1;
21035b88bc4bSdrh   w.xExprCallback = sqlite3ExprWalkNoop;
21047e6f980bSdrh   w.xSelectCallback = sqlite3SelectWalkFail;
2105979dd1beSdrh #ifdef SQLITE_DEBUG
2106979dd1beSdrh   w.xSelectCallback2 = sqlite3SelectWalkAssert2;
2107979dd1beSdrh #endif
21085b88bc4bSdrh   sqlite3WalkExpr(&w, p);
210907194bffSdrh   return w.eCode==0;
21105b88bc4bSdrh }
21115b88bc4bSdrh #endif
21125b88bc4bSdrh 
2113eb55bd2fSdrh /*
211473b211abSdrh ** If the expression p codes a constant integer that is small enough
2115202b2df7Sdrh ** to fit in a 32-bit integer, return 1 and put the value of the integer
2116202b2df7Sdrh ** in *pValue.  If the expression is not an integer or if it is too big
2117202b2df7Sdrh ** to fit in a signed 32-bit integer, return 0 and leave *pValue unchanged.
2118e4de1febSdrh */
21194adee20fSdanielk1977 int sqlite3ExprIsInteger(Expr *p, int *pValue){
212092b01d53Sdrh   int rc = 0;
21211d2d71a0Sdrh   if( NEVER(p==0) ) return 0;  /* Used to only happen following on OOM */
2122cd92e84dSdrh 
2123cd92e84dSdrh   /* If an expression is an integer literal that fits in a signed 32-bit
2124cd92e84dSdrh   ** integer, then the EP_IntValue flag will have already been set */
2125cd92e84dSdrh   assert( p->op!=TK_INTEGER || (p->flags & EP_IntValue)!=0
2126cd92e84dSdrh            || sqlite3GetInt32(p->u.zToken, &rc)==0 );
2127cd92e84dSdrh 
212892b01d53Sdrh   if( p->flags & EP_IntValue ){
212933e619fcSdrh     *pValue = p->u.iValue;
2130e4de1febSdrh     return 1;
2131e4de1febSdrh   }
213292b01d53Sdrh   switch( p->op ){
21334b59ab5eSdrh     case TK_UPLUS: {
213492b01d53Sdrh       rc = sqlite3ExprIsInteger(p->pLeft, pValue);
2135f6e369a1Sdrh       break;
21364b59ab5eSdrh     }
2137e4de1febSdrh     case TK_UMINUS: {
2138e4de1febSdrh       int v;
21394adee20fSdanielk1977       if( sqlite3ExprIsInteger(p->pLeft, &v) ){
2140f6418891Smistachkin         assert( v!=(-2147483647-1) );
2141e4de1febSdrh         *pValue = -v;
214292b01d53Sdrh         rc = 1;
2143e4de1febSdrh       }
2144e4de1febSdrh       break;
2145e4de1febSdrh     }
2146e4de1febSdrh     default: break;
2147e4de1febSdrh   }
214892b01d53Sdrh   return rc;
2149e4de1febSdrh }
2150e4de1febSdrh 
2151e4de1febSdrh /*
2152039fc32eSdrh ** Return FALSE if there is no chance that the expression can be NULL.
2153039fc32eSdrh **
2154039fc32eSdrh ** If the expression might be NULL or if the expression is too complex
2155039fc32eSdrh ** to tell return TRUE.
2156039fc32eSdrh **
2157039fc32eSdrh ** This routine is used as an optimization, to skip OP_IsNull opcodes
2158039fc32eSdrh ** when we know that a value cannot be NULL.  Hence, a false positive
2159039fc32eSdrh ** (returning TRUE when in fact the expression can never be NULL) might
2160039fc32eSdrh ** be a small performance hit but is otherwise harmless.  On the other
2161039fc32eSdrh ** hand, a false negative (returning FALSE when the result could be NULL)
2162039fc32eSdrh ** will likely result in an incorrect answer.  So when in doubt, return
2163039fc32eSdrh ** TRUE.
2164039fc32eSdrh */
2165039fc32eSdrh int sqlite3ExprCanBeNull(const Expr *p){
2166039fc32eSdrh   u8 op;
21679bfb0794Sdrh   while( p->op==TK_UPLUS || p->op==TK_UMINUS ){
21689bfb0794Sdrh     p = p->pLeft;
21699bfb0794Sdrh   }
2170039fc32eSdrh   op = p->op;
2171039fc32eSdrh   if( op==TK_REGISTER ) op = p->op2;
2172039fc32eSdrh   switch( op ){
2173039fc32eSdrh     case TK_INTEGER:
2174039fc32eSdrh     case TK_STRING:
2175039fc32eSdrh     case TK_FLOAT:
2176039fc32eSdrh     case TK_BLOB:
2177039fc32eSdrh       return 0;
21787248a8b2Sdrh     case TK_COLUMN:
217972673a24Sdrh       return ExprHasProperty(p, EP_CanBeNull) ||
2180eda079cdSdrh              p->y.pTab==0 ||  /* Reference to column of index on expression */
2181eda079cdSdrh              (p->iColumn>=0 && p->y.pTab->aCol[p->iColumn].notNull==0);
2182039fc32eSdrh     default:
2183039fc32eSdrh       return 1;
2184039fc32eSdrh   }
2185039fc32eSdrh }
2186039fc32eSdrh 
2187039fc32eSdrh /*
2188039fc32eSdrh ** Return TRUE if the given expression is a constant which would be
2189039fc32eSdrh ** unchanged by OP_Affinity with the affinity given in the second
2190039fc32eSdrh ** argument.
2191039fc32eSdrh **
2192039fc32eSdrh ** This routine is used to determine if the OP_Affinity operation
2193039fc32eSdrh ** can be omitted.  When in doubt return FALSE.  A false negative
2194039fc32eSdrh ** is harmless.  A false positive, however, can result in the wrong
2195039fc32eSdrh ** answer.
2196039fc32eSdrh */
2197039fc32eSdrh int sqlite3ExprNeedsNoAffinityChange(const Expr *p, char aff){
2198039fc32eSdrh   u8 op;
2199af866402Sdrh   int unaryMinus = 0;
220005883a34Sdrh   if( aff==SQLITE_AFF_BLOB ) return 1;
2201af866402Sdrh   while( p->op==TK_UPLUS || p->op==TK_UMINUS ){
2202af866402Sdrh     if( p->op==TK_UMINUS ) unaryMinus = 1;
2203af866402Sdrh     p = p->pLeft;
2204af866402Sdrh   }
2205039fc32eSdrh   op = p->op;
2206039fc32eSdrh   if( op==TK_REGISTER ) op = p->op2;
2207039fc32eSdrh   switch( op ){
2208039fc32eSdrh     case TK_INTEGER: {
22096a19865fSdrh       return aff>=SQLITE_AFF_NUMERIC;
2210039fc32eSdrh     }
2211039fc32eSdrh     case TK_FLOAT: {
22126a19865fSdrh       return aff>=SQLITE_AFF_NUMERIC;
2213039fc32eSdrh     }
2214039fc32eSdrh     case TK_STRING: {
2215af866402Sdrh       return !unaryMinus && aff==SQLITE_AFF_TEXT;
2216039fc32eSdrh     }
2217039fc32eSdrh     case TK_BLOB: {
2218af866402Sdrh       return !unaryMinus;
2219039fc32eSdrh     }
22202f2855b6Sdrh     case TK_COLUMN: {
222188376ca7Sdrh       assert( p->iTable>=0 );  /* p cannot be part of a CHECK constraint */
22226a19865fSdrh       return aff>=SQLITE_AFF_NUMERIC && p->iColumn<0;
22232f2855b6Sdrh     }
2224039fc32eSdrh     default: {
2225039fc32eSdrh       return 0;
2226039fc32eSdrh     }
2227039fc32eSdrh   }
2228039fc32eSdrh }
2229039fc32eSdrh 
2230039fc32eSdrh /*
2231c4a3c779Sdrh ** Return TRUE if the given string is a row-id column name.
2232c4a3c779Sdrh */
22334adee20fSdanielk1977 int sqlite3IsRowid(const char *z){
22344adee20fSdanielk1977   if( sqlite3StrICmp(z, "_ROWID_")==0 ) return 1;
22354adee20fSdanielk1977   if( sqlite3StrICmp(z, "ROWID")==0 ) return 1;
22364adee20fSdanielk1977   if( sqlite3StrICmp(z, "OID")==0 ) return 1;
2237c4a3c779Sdrh   return 0;
2238c4a3c779Sdrh }
2239c4a3c779Sdrh 
22409a96b668Sdanielk1977 /*
224169c355bdSdrh ** pX is the RHS of an IN operator.  If pX is a SELECT statement
224269c355bdSdrh ** that can be simplified to a direct table access, then return
224369c355bdSdrh ** a pointer to the SELECT statement.  If pX is not a SELECT statement,
224469c355bdSdrh ** or if the SELECT statement needs to be manifested into a transient
224569c355bdSdrh ** table, then return NULL.
2246b287f4b6Sdrh */
2247b287f4b6Sdrh #ifndef SQLITE_OMIT_SUBQUERY
22487b35a77bSdan static Select *isCandidateForInOpt(Expr *pX){
224969c355bdSdrh   Select *p;
2250b287f4b6Sdrh   SrcList *pSrc;
2251b287f4b6Sdrh   ExprList *pEList;
2252b287f4b6Sdrh   Table *pTab;
2253cfbb5e82Sdan   int i;
225469c355bdSdrh   if( !ExprHasProperty(pX, EP_xIsSelect) ) return 0;  /* Not a subquery */
225569c355bdSdrh   if( ExprHasProperty(pX, EP_VarSelect)  ) return 0;  /* Correlated subq */
225669c355bdSdrh   p = pX->x.pSelect;
2257b287f4b6Sdrh   if( p->pPrior ) return 0;              /* Not a compound SELECT */
22587d10d5a6Sdrh   if( p->selFlags & (SF_Distinct|SF_Aggregate) ){
2259b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
2260b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
22617d10d5a6Sdrh     return 0; /* No DISTINCT keyword and no aggregate functions */
22627d10d5a6Sdrh   }
2263b74b1017Sdrh   assert( p->pGroupBy==0 );              /* Has no GROUP BY clause */
2264b287f4b6Sdrh   if( p->pLimit ) return 0;              /* Has no LIMIT clause */
2265b287f4b6Sdrh   if( p->pWhere ) return 0;              /* Has no WHERE clause */
2266b287f4b6Sdrh   pSrc = p->pSrc;
2267d1fa7bcaSdrh   assert( pSrc!=0 );
2268d1fa7bcaSdrh   if( pSrc->nSrc!=1 ) return 0;          /* Single term in FROM clause */
2269b74b1017Sdrh   if( pSrc->a[0].pSelect ) return 0;     /* FROM is not a subquery or view */
2270b287f4b6Sdrh   pTab = pSrc->a[0].pTab;
227169c355bdSdrh   assert( pTab!=0 );
2272b74b1017Sdrh   assert( pTab->pSelect==0 );            /* FROM clause is not a view */
2273b287f4b6Sdrh   if( IsVirtual(pTab) ) return 0;        /* FROM clause not a virtual table */
2274b287f4b6Sdrh   pEList = p->pEList;
2275ac6b47d1Sdrh   assert( pEList!=0 );
22767b35a77bSdan   /* All SELECT results must be columns. */
2277cfbb5e82Sdan   for(i=0; i<pEList->nExpr; i++){
2278cfbb5e82Sdan     Expr *pRes = pEList->a[i].pExpr;
2279cfbb5e82Sdan     if( pRes->op!=TK_COLUMN ) return 0;
228069c355bdSdrh     assert( pRes->iTable==pSrc->a[0].iCursor );  /* Not a correlated subquery */
2281cfbb5e82Sdan   }
228269c355bdSdrh   return p;
2283b287f4b6Sdrh }
2284b287f4b6Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
2285b287f4b6Sdrh 
2286f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
22871d8cb21fSdan /*
22884c259e9fSdrh ** Generate code that checks the left-most column of index table iCur to see if
22894c259e9fSdrh ** it contains any NULL entries.  Cause the register at regHasNull to be set
22906be515ebSdrh ** to a non-NULL value if iCur contains no NULLs.  Cause register regHasNull
22916be515ebSdrh ** to be set to NULL if iCur contains one or more NULL values.
22926be515ebSdrh */
22936be515ebSdrh static void sqlite3SetHasNullFlag(Vdbe *v, int iCur, int regHasNull){
2294728e0f91Sdrh   int addr1;
22956be515ebSdrh   sqlite3VdbeAddOp2(v, OP_Integer, 0, regHasNull);
2296728e0f91Sdrh   addr1 = sqlite3VdbeAddOp1(v, OP_Rewind, iCur); VdbeCoverage(v);
22976be515ebSdrh   sqlite3VdbeAddOp3(v, OP_Column, iCur, 0, regHasNull);
22986be515ebSdrh   sqlite3VdbeChangeP5(v, OPFLAG_TYPEOFARG);
22994c259e9fSdrh   VdbeComment((v, "first_entry_in(%d)", iCur));
2300728e0f91Sdrh   sqlite3VdbeJumpHere(v, addr1);
23016be515ebSdrh }
2302f9b2e05cSdan #endif
23036be515ebSdrh 
2304bb53ecb1Sdrh 
2305bb53ecb1Sdrh #ifndef SQLITE_OMIT_SUBQUERY
2306bb53ecb1Sdrh /*
2307bb53ecb1Sdrh ** The argument is an IN operator with a list (not a subquery) on the
2308bb53ecb1Sdrh ** right-hand side.  Return TRUE if that list is constant.
2309bb53ecb1Sdrh */
2310bb53ecb1Sdrh static int sqlite3InRhsIsConstant(Expr *pIn){
2311bb53ecb1Sdrh   Expr *pLHS;
2312bb53ecb1Sdrh   int res;
2313bb53ecb1Sdrh   assert( !ExprHasProperty(pIn, EP_xIsSelect) );
2314bb53ecb1Sdrh   pLHS = pIn->pLeft;
2315bb53ecb1Sdrh   pIn->pLeft = 0;
2316bb53ecb1Sdrh   res = sqlite3ExprIsConstant(pIn);
2317bb53ecb1Sdrh   pIn->pLeft = pLHS;
2318bb53ecb1Sdrh   return res;
2319bb53ecb1Sdrh }
2320bb53ecb1Sdrh #endif
2321bb53ecb1Sdrh 
23226be515ebSdrh /*
23239a96b668Sdanielk1977 ** This function is used by the implementation of the IN (...) operator.
2324d4305ca6Sdrh ** The pX parameter is the expression on the RHS of the IN operator, which
2325d4305ca6Sdrh ** might be either a list of expressions or a subquery.
23269a96b668Sdanielk1977 **
2327d4305ca6Sdrh ** The job of this routine is to find or create a b-tree object that can
2328d4305ca6Sdrh ** be used either to test for membership in the RHS set or to iterate through
2329d4305ca6Sdrh ** all members of the RHS set, skipping duplicates.
2330d4305ca6Sdrh **
23313a85625dSdrh ** A cursor is opened on the b-tree object that is the RHS of the IN operator
2332d4305ca6Sdrh ** and pX->iTable is set to the index of that cursor.
2333d4305ca6Sdrh **
2334b74b1017Sdrh ** The returned value of this function indicates the b-tree type, as follows:
23359a96b668Sdanielk1977 **
23369a96b668Sdanielk1977 **   IN_INDEX_ROWID      - The cursor was opened on a database table.
23371ccce449Sdrh **   IN_INDEX_INDEX_ASC  - The cursor was opened on an ascending index.
23381ccce449Sdrh **   IN_INDEX_INDEX_DESC - The cursor was opened on a descending index.
23399a96b668Sdanielk1977 **   IN_INDEX_EPH        - The cursor was opened on a specially created and
23409a96b668Sdanielk1977 **                         populated epheremal table.
2341bb53ecb1Sdrh **   IN_INDEX_NOOP       - No cursor was allocated.  The IN operator must be
2342bb53ecb1Sdrh **                         implemented as a sequence of comparisons.
23439a96b668Sdanielk1977 **
2344d4305ca6Sdrh ** An existing b-tree might be used if the RHS expression pX is a simple
2345d4305ca6Sdrh ** subquery such as:
23469a96b668Sdanielk1977 **
2347553168c7Sdan **     SELECT <column1>, <column2>... FROM <table>
23489a96b668Sdanielk1977 **
2349d4305ca6Sdrh ** If the RHS of the IN operator is a list or a more complex subquery, then
2350d4305ca6Sdrh ** an ephemeral table might need to be generated from the RHS and then
235160ec914cSpeter.d.reid ** pX->iTable made to point to the ephemeral table instead of an
2352d4305ca6Sdrh ** existing table.
2353d4305ca6Sdrh **
23547fc0ba0fSdrh ** The inFlags parameter must contain, at a minimum, one of the bits
23557fc0ba0fSdrh ** IN_INDEX_MEMBERSHIP or IN_INDEX_LOOP but not both.  If inFlags contains
23567fc0ba0fSdrh ** IN_INDEX_MEMBERSHIP, then the generated table will be used for a fast
23577fc0ba0fSdrh ** membership test.  When the IN_INDEX_LOOP bit is set, the IN index will
23587fc0ba0fSdrh ** be used to loop over all values of the RHS of the IN operator.
23593a85625dSdrh **
23603a85625dSdrh ** When IN_INDEX_LOOP is used (and the b-tree will be used to iterate
23613a85625dSdrh ** through the set members) then the b-tree must not contain duplicates.
23627fc0ba0fSdrh ** An epheremal table will be created unless the selected columns are guaranteed
2363553168c7Sdan ** to be unique - either because it is an INTEGER PRIMARY KEY or due to
2364553168c7Sdan ** a UNIQUE constraint or index.
23650cdc022eSdanielk1977 **
23663a85625dSdrh ** When IN_INDEX_MEMBERSHIP is used (and the b-tree will be used
23673a85625dSdrh ** for fast set membership tests) then an epheremal table must
2368553168c7Sdan ** be used unless <columns> is a single INTEGER PRIMARY KEY column or an
2369553168c7Sdan ** index can be found with the specified <columns> as its left-most.
23700cdc022eSdanielk1977 **
2371bb53ecb1Sdrh ** If the IN_INDEX_NOOP_OK and IN_INDEX_MEMBERSHIP are both set and
2372bb53ecb1Sdrh ** if the RHS of the IN operator is a list (not a subquery) then this
2373bb53ecb1Sdrh ** routine might decide that creating an ephemeral b-tree for membership
2374bb53ecb1Sdrh ** testing is too expensive and return IN_INDEX_NOOP.  In that case, the
2375bb53ecb1Sdrh ** calling routine should implement the IN operator using a sequence
2376bb53ecb1Sdrh ** of Eq or Ne comparison operations.
2377bb53ecb1Sdrh **
2378b74b1017Sdrh ** When the b-tree is being used for membership tests, the calling function
23793a85625dSdrh ** might need to know whether or not the RHS side of the IN operator
2380e21a6e1dSdrh ** contains a NULL.  If prRhsHasNull is not a NULL pointer and
23813a85625dSdrh ** if there is any chance that the (...) might contain a NULL value at
23820cdc022eSdanielk1977 ** runtime, then a register is allocated and the register number written
2383e21a6e1dSdrh ** to *prRhsHasNull. If there is no chance that the (...) contains a
2384e21a6e1dSdrh ** NULL value, then *prRhsHasNull is left unchanged.
23850cdc022eSdanielk1977 **
2386e21a6e1dSdrh ** If a register is allocated and its location stored in *prRhsHasNull, then
23876be515ebSdrh ** the value in that register will be NULL if the b-tree contains one or more
23886be515ebSdrh ** NULL values, and it will be some non-NULL value if the b-tree contains no
23896be515ebSdrh ** NULL values.
2390553168c7Sdan **
2391553168c7Sdan ** If the aiMap parameter is not NULL, it must point to an array containing
2392553168c7Sdan ** one element for each column returned by the SELECT statement on the RHS
2393553168c7Sdan ** of the IN(...) operator. The i'th entry of the array is populated with the
2394553168c7Sdan ** offset of the index column that matches the i'th column returned by the
2395553168c7Sdan ** SELECT. For example, if the expression and selected index are:
2396553168c7Sdan **
2397553168c7Sdan **   (?,?,?) IN (SELECT a, b, c FROM t1)
2398553168c7Sdan **   CREATE INDEX i1 ON t1(b, c, a);
2399553168c7Sdan **
2400553168c7Sdan ** then aiMap[] is populated with {2, 0, 1}.
24019a96b668Sdanielk1977 */
2402284f4acaSdanielk1977 #ifndef SQLITE_OMIT_SUBQUERY
2403ba00e30aSdan int sqlite3FindInIndex(
24046fc8f364Sdrh   Parse *pParse,             /* Parsing context */
24050167ef20Sdrh   Expr *pX,                  /* The IN expression */
24066fc8f364Sdrh   u32 inFlags,               /* IN_INDEX_LOOP, _MEMBERSHIP, and/or _NOOP_OK */
24076fc8f364Sdrh   int *prRhsHasNull,         /* Register holding NULL status.  See notes */
24082c04131cSdrh   int *aiMap,                /* Mapping from Index fields to RHS fields */
24092c04131cSdrh   int *piTab                 /* OUT: index to use */
2410ba00e30aSdan ){
2411b74b1017Sdrh   Select *p;                            /* SELECT to the right of IN operator */
2412b74b1017Sdrh   int eType = 0;                        /* Type of RHS table. IN_INDEX_* */
2413b74b1017Sdrh   int iTab = pParse->nTab++;            /* Cursor of the RHS table */
24143a85625dSdrh   int mustBeUnique;                     /* True if RHS must be unique */
2415b8475df8Sdrh   Vdbe *v = sqlite3GetVdbe(pParse);     /* Virtual machine being coded */
24169a96b668Sdanielk1977 
24171450bc6eSdrh   assert( pX->op==TK_IN );
24183a85625dSdrh   mustBeUnique = (inFlags & IN_INDEX_LOOP)!=0;
24191450bc6eSdrh 
24207b35a77bSdan   /* If the RHS of this IN(...) operator is a SELECT, and if it matters
24217b35a77bSdan   ** whether or not the SELECT result contains NULL values, check whether
2422870a0705Sdan   ** or not NULL is actually possible (it may not be, for example, due
24237b35a77bSdan   ** to NOT NULL constraints in the schema). If no NULL values are possible,
2424870a0705Sdan   ** set prRhsHasNull to 0 before continuing.  */
24257b35a77bSdan   if( prRhsHasNull && (pX->flags & EP_xIsSelect) ){
24267b35a77bSdan     int i;
24277b35a77bSdan     ExprList *pEList = pX->x.pSelect->pEList;
24287b35a77bSdan     for(i=0; i<pEList->nExpr; i++){
24297b35a77bSdan       if( sqlite3ExprCanBeNull(pEList->a[i].pExpr) ) break;
24307b35a77bSdan     }
24317b35a77bSdan     if( i==pEList->nExpr ){
24327b35a77bSdan       prRhsHasNull = 0;
24337b35a77bSdan     }
24347b35a77bSdan   }
24357b35a77bSdan 
2436b74b1017Sdrh   /* Check to see if an existing table or index can be used to
2437b74b1017Sdrh   ** satisfy the query.  This is preferable to generating a new
24387b35a77bSdan   ** ephemeral table.  */
24397b35a77bSdan   if( pParse->nErr==0 && (p = isCandidateForInOpt(pX))!=0 ){
2440e1fb65a0Sdanielk1977     sqlite3 *db = pParse->db;              /* Database connection */
2441b07028f7Sdrh     Table *pTab;                           /* Table <table>. */
2442ba00e30aSdan     i16 iDb;                               /* Database idx for pTab */
2443cfbb5e82Sdan     ExprList *pEList = p->pEList;
2444cfbb5e82Sdan     int nExpr = pEList->nExpr;
2445e1fb65a0Sdanielk1977 
2446b07028f7Sdrh     assert( p->pEList!=0 );             /* Because of isCandidateForInOpt(p) */
2447b07028f7Sdrh     assert( p->pEList->a[0].pExpr!=0 ); /* Because of isCandidateForInOpt(p) */
2448b07028f7Sdrh     assert( p->pSrc!=0 );               /* Because of isCandidateForInOpt(p) */
2449b07028f7Sdrh     pTab = p->pSrc->a[0].pTab;
2450b07028f7Sdrh 
2451b22f7c83Sdrh     /* Code an OP_Transaction and OP_TableLock for <table>. */
2452e1fb65a0Sdanielk1977     iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
2453e1fb65a0Sdanielk1977     sqlite3CodeVerifySchema(pParse, iDb);
2454e1fb65a0Sdanielk1977     sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
24559a96b668Sdanielk1977 
2456a84a283dSdrh     assert(v);  /* sqlite3GetVdbe() has always been previously called */
2457cfbb5e82Sdan     if( nExpr==1 && pEList->a[0].pExpr->iColumn<0 ){
245862659b2aSdrh       /* The "x IN (SELECT rowid FROM table)" case */
2459511f9e8dSdrh       int iAddr = sqlite3VdbeAddOp0(v, OP_Once);
24607d176105Sdrh       VdbeCoverage(v);
24619a96b668Sdanielk1977 
24629a96b668Sdanielk1977       sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
24639a96b668Sdanielk1977       eType = IN_INDEX_ROWID;
2464d8852095Sdrh       ExplainQueryPlan((pParse, 0,
2465d8852095Sdrh             "USING ROWID SEARCH ON TABLE %s FOR IN-OPERATOR",pTab->zName));
24669a96b668Sdanielk1977       sqlite3VdbeJumpHere(v, iAddr);
24679a96b668Sdanielk1977     }else{
2468e1fb65a0Sdanielk1977       Index *pIdx;                         /* Iterator variable */
2469cfbb5e82Sdan       int affinity_ok = 1;
2470cfbb5e82Sdan       int i;
2471cfbb5e82Sdan 
2472cfbb5e82Sdan       /* Check that the affinity that will be used to perform each
247362659b2aSdrh       ** comparison is the same as the affinity of each column in table
247462659b2aSdrh       ** on the RHS of the IN operator.  If it not, it is not possible to
247562659b2aSdrh       ** use any index of the RHS table.  */
2476cfbb5e82Sdan       for(i=0; i<nExpr && affinity_ok; i++){
2477fc7f27b9Sdrh         Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2478cfbb5e82Sdan         int iCol = pEList->a[i].pExpr->iColumn;
24790dfa4f6fSdrh         char idxaff = sqlite3TableColumnAffinity(pTab,iCol); /* RHS table */
2480cfbb5e82Sdan         char cmpaff = sqlite3CompareAffinity(pLhs, idxaff);
248162659b2aSdrh         testcase( cmpaff==SQLITE_AFF_BLOB );
248262659b2aSdrh         testcase( cmpaff==SQLITE_AFF_TEXT );
2483cfbb5e82Sdan         switch( cmpaff ){
2484cfbb5e82Sdan           case SQLITE_AFF_BLOB:
2485cfbb5e82Sdan             break;
2486cfbb5e82Sdan           case SQLITE_AFF_TEXT:
248762659b2aSdrh             /* sqlite3CompareAffinity() only returns TEXT if one side or the
248862659b2aSdrh             ** other has no affinity and the other side is TEXT.  Hence,
248962659b2aSdrh             ** the only way for cmpaff to be TEXT is for idxaff to be TEXT
249062659b2aSdrh             ** and for the term on the LHS of the IN to have no affinity. */
249162659b2aSdrh             assert( idxaff==SQLITE_AFF_TEXT );
2492cfbb5e82Sdan             break;
2493cfbb5e82Sdan           default:
2494cfbb5e82Sdan             affinity_ok = sqlite3IsNumericAffinity(idxaff);
2495cfbb5e82Sdan         }
2496cfbb5e82Sdan       }
2497e1fb65a0Sdanielk1977 
2498a84a283dSdrh       if( affinity_ok ){
2499a84a283dSdrh         /* Search for an existing index that will work for this IN operator */
2500a84a283dSdrh         for(pIdx=pTab->pIndex; pIdx && eType==0; pIdx=pIdx->pNext){
2501a84a283dSdrh           Bitmask colUsed;      /* Columns of the index used */
2502a84a283dSdrh           Bitmask mCol;         /* Mask for the current column */
25036fc8f364Sdrh           if( pIdx->nColumn<nExpr ) continue;
2504d4a4a361Sdrh           if( pIdx->pPartIdxWhere!=0 ) continue;
2505a84a283dSdrh           /* Maximum nColumn is BMS-2, not BMS-1, so that we can compute
2506a84a283dSdrh           ** BITMASK(nExpr) without overflowing */
2507a84a283dSdrh           testcase( pIdx->nColumn==BMS-2 );
2508a84a283dSdrh           testcase( pIdx->nColumn==BMS-1 );
2509a84a283dSdrh           if( pIdx->nColumn>=BMS-1 ) continue;
25106fc8f364Sdrh           if( mustBeUnique ){
25116fc8f364Sdrh             if( pIdx->nKeyCol>nExpr
25126fc8f364Sdrh              ||(pIdx->nColumn>nExpr && !IsUniqueIndex(pIdx))
25136fc8f364Sdrh             ){
2514a84a283dSdrh               continue;  /* This index is not unique over the IN RHS columns */
2515cfbb5e82Sdan             }
25166fc8f364Sdrh           }
2517cfbb5e82Sdan 
2518a84a283dSdrh           colUsed = 0;   /* Columns of index used so far */
2519cfbb5e82Sdan           for(i=0; i<nExpr; i++){
2520fc7f27b9Sdrh             Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2521cfbb5e82Sdan             Expr *pRhs = pEList->a[i].pExpr;
2522cfbb5e82Sdan             CollSeq *pReq = sqlite3BinaryCompareCollSeq(pParse, pLhs, pRhs);
2523cfbb5e82Sdan             int j;
2524cfbb5e82Sdan 
25256fc8f364Sdrh             assert( pReq!=0 || pRhs->iColumn==XN_ROWID || pParse->nErr );
2526cfbb5e82Sdan             for(j=0; j<nExpr; j++){
2527cfbb5e82Sdan               if( pIdx->aiColumn[j]!=pRhs->iColumn ) continue;
2528cfbb5e82Sdan               assert( pIdx->azColl[j] );
2529106526e1Sdrh               if( pReq!=0 && sqlite3StrICmp(pReq->zName, pIdx->azColl[j])!=0 ){
2530106526e1Sdrh                 continue;
2531106526e1Sdrh               }
2532cfbb5e82Sdan               break;
2533cfbb5e82Sdan             }
2534cfbb5e82Sdan             if( j==nExpr ) break;
2535a84a283dSdrh             mCol = MASKBIT(j);
2536a84a283dSdrh             if( mCol & colUsed ) break; /* Each column used only once */
2537a84a283dSdrh             colUsed |= mCol;
2538ba00e30aSdan             if( aiMap ) aiMap[i] = j;
2539cfbb5e82Sdan           }
2540cfbb5e82Sdan 
2541a84a283dSdrh           assert( i==nExpr || colUsed!=(MASKBIT(nExpr)-1) );
2542a84a283dSdrh           if( colUsed==(MASKBIT(nExpr)-1) ){
2543a84a283dSdrh             /* If we reach this point, that means the index pIdx is usable */
2544511f9e8dSdrh             int iAddr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
2545e2ca99c9Sdrh             ExplainQueryPlan((pParse, 0,
2546e2ca99c9Sdrh                               "USING INDEX %s FOR IN-OPERATOR",pIdx->zName));
25472ec2fb22Sdrh             sqlite3VdbeAddOp3(v, OP_OpenRead, iTab, pIdx->tnum, iDb);
25482ec2fb22Sdrh             sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
2549207872a4Sdanielk1977             VdbeComment((v, "%s", pIdx->zName));
25501ccce449Sdrh             assert( IN_INDEX_INDEX_DESC == IN_INDEX_INDEX_ASC+1 );
25511ccce449Sdrh             eType = IN_INDEX_INDEX_ASC + pIdx->aSortOrder[0];
25529a96b668Sdanielk1977 
25537b35a77bSdan             if( prRhsHasNull ){
25543480bfdaSdan #ifdef SQLITE_ENABLE_COLUMN_USED_MASK
2555cfbb5e82Sdan               i64 mask = (1<<nExpr)-1;
25563480bfdaSdan               sqlite3VdbeAddOp4Dup8(v, OP_ColumnsUsed,
2557cfbb5e82Sdan                   iTab, 0, 0, (u8*)&mask, P4_INT64);
25583480bfdaSdan #endif
2559b80dbdc2Sdrh               *prRhsHasNull = ++pParse->nMem;
25607b35a77bSdan               if( nExpr==1 ){
25616be515ebSdrh                 sqlite3SetHasNullFlag(v, iTab, *prRhsHasNull);
25620cdc022eSdanielk1977               }
25637b35a77bSdan             }
2564552fd454Sdrh             sqlite3VdbeJumpHere(v, iAddr);
25659a96b668Sdanielk1977           }
2566a84a283dSdrh         } /* End loop over indexes */
2567a84a283dSdrh       } /* End if( affinity_ok ) */
2568a84a283dSdrh     } /* End if not an rowid index */
2569a84a283dSdrh   } /* End attempt to optimize using an index */
25709a96b668Sdanielk1977 
2571bb53ecb1Sdrh   /* If no preexisting index is available for the IN clause
2572bb53ecb1Sdrh   ** and IN_INDEX_NOOP is an allowed reply
2573bb53ecb1Sdrh   ** and the RHS of the IN operator is a list, not a subquery
257471c57db0Sdan   ** and the RHS is not constant or has two or fewer terms,
257560ec914cSpeter.d.reid   ** then it is not worth creating an ephemeral table to evaluate
2576bb53ecb1Sdrh   ** the IN operator so return IN_INDEX_NOOP.
2577bb53ecb1Sdrh   */
2578bb53ecb1Sdrh   if( eType==0
2579bb53ecb1Sdrh    && (inFlags & IN_INDEX_NOOP_OK)
2580bb53ecb1Sdrh    && !ExprHasProperty(pX, EP_xIsSelect)
2581bb53ecb1Sdrh    && (!sqlite3InRhsIsConstant(pX) || pX->x.pList->nExpr<=2)
2582bb53ecb1Sdrh   ){
2583bb53ecb1Sdrh     eType = IN_INDEX_NOOP;
2584bb53ecb1Sdrh   }
2585bb53ecb1Sdrh 
25869a96b668Sdanielk1977   if( eType==0 ){
25874387006cSdrh     /* Could not find an existing table or index to use as the RHS b-tree.
2588b74b1017Sdrh     ** We will have to generate an ephemeral table to do the job.
2589b74b1017Sdrh     */
25908e23daf3Sdrh     u32 savedNQueryLoop = pParse->nQueryLoop;
25910cdc022eSdanielk1977     int rMayHaveNull = 0;
259241a05b7bSdanielk1977     eType = IN_INDEX_EPH;
25933a85625dSdrh     if( inFlags & IN_INDEX_LOOP ){
25944a5acf8eSdrh       pParse->nQueryLoop = 0;
2595e21a6e1dSdrh     }else if( prRhsHasNull ){
2596e21a6e1dSdrh       *prRhsHasNull = rMayHaveNull = ++pParse->nMem;
2597cf4d38aaSdrh     }
259885bcdce2Sdrh     assert( pX->op==TK_IN );
259950ef6716Sdrh     sqlite3CodeRhsOfIN(pParse, pX, iTab);
260085bcdce2Sdrh     if( rMayHaveNull ){
26012c04131cSdrh       sqlite3SetHasNullFlag(v, iTab, rMayHaveNull);
260285bcdce2Sdrh     }
2603cf4d38aaSdrh     pParse->nQueryLoop = savedNQueryLoop;
26049a96b668Sdanielk1977   }
2605ba00e30aSdan 
2606ba00e30aSdan   if( aiMap && eType!=IN_INDEX_INDEX_ASC && eType!=IN_INDEX_INDEX_DESC ){
2607ba00e30aSdan     int i, n;
2608ba00e30aSdan     n = sqlite3ExprVectorSize(pX->pLeft);
2609ba00e30aSdan     for(i=0; i<n; i++) aiMap[i] = i;
2610ba00e30aSdan   }
26112c04131cSdrh   *piTab = iTab;
26129a96b668Sdanielk1977   return eType;
26139a96b668Sdanielk1977 }
2614284f4acaSdanielk1977 #endif
2615626a879aSdrh 
2616f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
2617553168c7Sdan /*
2618553168c7Sdan ** Argument pExpr is an (?, ?...) IN(...) expression. This
2619553168c7Sdan ** function allocates and returns a nul-terminated string containing
2620553168c7Sdan ** the affinities to be used for each column of the comparison.
2621553168c7Sdan **
2622553168c7Sdan ** It is the responsibility of the caller to ensure that the returned
2623553168c7Sdan ** string is eventually freed using sqlite3DbFree().
2624553168c7Sdan */
262571c57db0Sdan static char *exprINAffinity(Parse *pParse, Expr *pExpr){
262671c57db0Sdan   Expr *pLeft = pExpr->pLeft;
262771c57db0Sdan   int nVal = sqlite3ExprVectorSize(pLeft);
2628553168c7Sdan   Select *pSelect = (pExpr->flags & EP_xIsSelect) ? pExpr->x.pSelect : 0;
262971c57db0Sdan   char *zRet;
263071c57db0Sdan 
2631553168c7Sdan   assert( pExpr->op==TK_IN );
26325c258dc1Sdrh   zRet = sqlite3DbMallocRaw(pParse->db, nVal+1);
263371c57db0Sdan   if( zRet ){
263471c57db0Sdan     int i;
263571c57db0Sdan     for(i=0; i<nVal; i++){
2636fc7f27b9Sdrh       Expr *pA = sqlite3VectorFieldSubexpr(pLeft, i);
2637553168c7Sdan       char a = sqlite3ExprAffinity(pA);
2638553168c7Sdan       if( pSelect ){
2639553168c7Sdan         zRet[i] = sqlite3CompareAffinity(pSelect->pEList->a[i].pExpr, a);
264071c57db0Sdan       }else{
2641553168c7Sdan         zRet[i] = a;
264271c57db0Sdan       }
264371c57db0Sdan     }
264471c57db0Sdan     zRet[nVal] = '\0';
264571c57db0Sdan   }
264671c57db0Sdan   return zRet;
264771c57db0Sdan }
2648f9b2e05cSdan #endif
264971c57db0Sdan 
26508da209b1Sdan #ifndef SQLITE_OMIT_SUBQUERY
26518da209b1Sdan /*
26528da209b1Sdan ** Load the Parse object passed as the first argument with an error
26538da209b1Sdan ** message of the form:
26548da209b1Sdan **
26558da209b1Sdan **   "sub-select returns N columns - expected M"
26568da209b1Sdan */
26578da209b1Sdan void sqlite3SubselectError(Parse *pParse, int nActual, int nExpect){
26588da209b1Sdan   const char *zFmt = "sub-select returns %d columns - expected %d";
26598da209b1Sdan   sqlite3ErrorMsg(pParse, zFmt, nActual, nExpect);
26608da209b1Sdan }
26618da209b1Sdan #endif
26628da209b1Sdan 
2663626a879aSdrh /*
266444c5604cSdan ** Expression pExpr is a vector that has been used in a context where
266544c5604cSdan ** it is not permitted. If pExpr is a sub-select vector, this routine
266644c5604cSdan ** loads the Parse object with a message of the form:
266744c5604cSdan **
266844c5604cSdan **   "sub-select returns N columns - expected 1"
266944c5604cSdan **
267044c5604cSdan ** Or, if it is a regular scalar vector:
267144c5604cSdan **
267244c5604cSdan **   "row value misused"
267344c5604cSdan */
267444c5604cSdan void sqlite3VectorErrorMsg(Parse *pParse, Expr *pExpr){
267544c5604cSdan #ifndef SQLITE_OMIT_SUBQUERY
267644c5604cSdan   if( pExpr->flags & EP_xIsSelect ){
267744c5604cSdan     sqlite3SubselectError(pParse, pExpr->x.pSelect->pEList->nExpr, 1);
267844c5604cSdan   }else
267944c5604cSdan #endif
268044c5604cSdan   {
268144c5604cSdan     sqlite3ErrorMsg(pParse, "row value misused");
268244c5604cSdan   }
268344c5604cSdan }
268444c5604cSdan 
268585bcdce2Sdrh #ifndef SQLITE_OMIT_SUBQUERY
268644c5604cSdan /*
268785bcdce2Sdrh ** Generate code that will construct an ephemeral table containing all terms
268885bcdce2Sdrh ** in the RHS of an IN operator.  The IN operator can be in either of two
268985bcdce2Sdrh ** forms:
2690626a879aSdrh **
26919cbe6352Sdrh **     x IN (4,5,11)              -- IN operator with list on right-hand side
26929cbe6352Sdrh **     x IN (SELECT a FROM b)     -- IN operator with subquery on the right
2693fef5208cSdrh **
26942c04131cSdrh ** The pExpr parameter is the IN operator.  The cursor number for the
26952c04131cSdrh ** constructed ephermeral table is returned.  The first time the ephemeral
26962c04131cSdrh ** table is computed, the cursor number is also stored in pExpr->iTable,
26972c04131cSdrh ** however the cursor number returned might not be the same, as it might
26982c04131cSdrh ** have been duplicated using OP_OpenDup.
269941a05b7bSdanielk1977 **
270085bcdce2Sdrh ** If the LHS expression ("x" in the examples) is a column value, or
270185bcdce2Sdrh ** the SELECT statement returns a column value, then the affinity of that
270285bcdce2Sdrh ** column is used to build the index keys. If both 'x' and the
270385bcdce2Sdrh ** SELECT... statement are columns, then numeric affinity is used
270485bcdce2Sdrh ** if either column has NUMERIC or INTEGER affinity. If neither
270585bcdce2Sdrh ** 'x' nor the SELECT... statement are columns, then numeric affinity
270685bcdce2Sdrh ** is used.
2707cce7d176Sdrh */
270885bcdce2Sdrh void sqlite3CodeRhsOfIN(
2709fd773cf9Sdrh   Parse *pParse,          /* Parsing context */
271085bcdce2Sdrh   Expr *pExpr,            /* The IN operator */
271150ef6716Sdrh   int iTab                /* Use this cursor number */
271241a05b7bSdanielk1977 ){
27132c04131cSdrh   int addrOnce = 0;           /* Address of the OP_Once instruction at top */
271485bcdce2Sdrh   int addr;                   /* Address of OP_OpenEphemeral instruction */
271585bcdce2Sdrh   Expr *pLeft;                /* the LHS of the IN operator */
271685bcdce2Sdrh   KeyInfo *pKeyInfo = 0;      /* Key information */
271785bcdce2Sdrh   int nVal;                   /* Size of vector pLeft */
271885bcdce2Sdrh   Vdbe *v;                    /* The prepared statement under construction */
2719fc976065Sdanielk1977 
27202c04131cSdrh   v = pParse->pVdbe;
272185bcdce2Sdrh   assert( v!=0 );
272285bcdce2Sdrh 
27232c04131cSdrh   /* The evaluation of the IN must be repeated every time it
272439a11819Sdrh   ** is encountered if any of the following is true:
272557dbd7b3Sdrh   **
272657dbd7b3Sdrh   **    *  The right-hand side is a correlated subquery
272757dbd7b3Sdrh   **    *  The right-hand side is an expression list containing variables
272857dbd7b3Sdrh   **    *  We are inside a trigger
272957dbd7b3Sdrh   **
27302c04131cSdrh   ** If all of the above are false, then we can compute the RHS just once
27312c04131cSdrh   ** and reuse it many names.
2732b3bce662Sdanielk1977   */
2733efb699fcSdrh   if( !ExprHasProperty(pExpr, EP_VarSelect) && pParse->iSelfTab==0 ){
27342c04131cSdrh     /* Reuse of the RHS is allowed */
27352c04131cSdrh     /* If this routine has already been coded, but the previous code
27362c04131cSdrh     ** might not have been invoked yet, so invoke it now as a subroutine.
27372c04131cSdrh     */
27382c04131cSdrh     if( ExprHasProperty(pExpr, EP_Subrtn) ){
2739f9231c34Sdrh       addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
2740bd462bccSdrh       if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2741bd462bccSdrh         ExplainQueryPlan((pParse, 0, "REUSE LIST SUBQUERY %d",
2742bd462bccSdrh               pExpr->x.pSelect->selId));
2743bd462bccSdrh       }
27442c04131cSdrh       sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
27452c04131cSdrh                         pExpr->y.sub.iAddr);
27462c04131cSdrh       sqlite3VdbeAddOp2(v, OP_OpenDup, iTab, pExpr->iTable);
2747f9231c34Sdrh       sqlite3VdbeJumpHere(v, addrOnce);
27482c04131cSdrh       return;
27492c04131cSdrh     }
27502c04131cSdrh 
27512c04131cSdrh     /* Begin coding the subroutine */
27522c04131cSdrh     ExprSetProperty(pExpr, EP_Subrtn);
27532c04131cSdrh     pExpr->y.sub.regReturn = ++pParse->nMem;
27542c04131cSdrh     pExpr->y.sub.iAddr =
27552c04131cSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 0, pExpr->y.sub.regReturn) + 1;
27562c04131cSdrh     VdbeComment((v, "return address"));
27572c04131cSdrh 
27582c04131cSdrh     addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
2759b3bce662Sdanielk1977   }
2760b3bce662Sdanielk1977 
276185bcdce2Sdrh   /* Check to see if this is a vector IN operator */
276285bcdce2Sdrh   pLeft = pExpr->pLeft;
276371c57db0Sdan   nVal = sqlite3ExprVectorSize(pLeft);
2764e014a838Sdanielk1977 
276585bcdce2Sdrh   /* Construct the ephemeral table that will contain the content of
276685bcdce2Sdrh   ** RHS of the IN operator.
2767fef5208cSdrh   */
27682c04131cSdrh   pExpr->iTable = iTab;
276950ef6716Sdrh   addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, pExpr->iTable, nVal);
27702c04131cSdrh #ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
27712c04131cSdrh   if( ExprHasProperty(pExpr, EP_xIsSelect) ){
27722c04131cSdrh     VdbeComment((v, "Result of SELECT %u", pExpr->x.pSelect->selId));
27732c04131cSdrh   }else{
27742c04131cSdrh     VdbeComment((v, "RHS of IN operator"));
27752c04131cSdrh   }
27762c04131cSdrh #endif
277750ef6716Sdrh   pKeyInfo = sqlite3KeyInfoAlloc(pParse->db, nVal, 1);
2778e014a838Sdanielk1977 
27796ab3a2ecSdanielk1977   if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2780e014a838Sdanielk1977     /* Case 1:     expr IN (SELECT ...)
2781e014a838Sdanielk1977     **
2782e014a838Sdanielk1977     ** Generate code to write the results of the select into the temporary
2783e014a838Sdanielk1977     ** table allocated and opened above.
2784e014a838Sdanielk1977     */
27854387006cSdrh     Select *pSelect = pExpr->x.pSelect;
278671c57db0Sdan     ExprList *pEList = pSelect->pEList;
27871013c932Sdrh 
27882c04131cSdrh     ExplainQueryPlan((pParse, 1, "%sLIST SUBQUERY %d",
27892c04131cSdrh         addrOnce?"":"CORRELATED ", pSelect->selId
2790e2ca99c9Sdrh     ));
279164bcb8cfSdrh     /* If the LHS and RHS of the IN operator do not match, that
279264bcb8cfSdrh     ** error will have been caught long before we reach this point. */
279364bcb8cfSdrh     if( ALWAYS(pEList->nExpr==nVal) ){
279471c57db0Sdan       SelectDest dest;
279571c57db0Sdan       int i;
2796bd462bccSdrh       sqlite3SelectDestInit(&dest, SRT_Set, iTab);
279771c57db0Sdan       dest.zAffSdst = exprINAffinity(pParse, pExpr);
27984387006cSdrh       pSelect->iLimit = 0;
27994387006cSdrh       testcase( pSelect->selFlags & SF_Distinct );
2800812ea833Sdrh       testcase( pKeyInfo==0 ); /* Caused by OOM in sqlite3KeyInfoAlloc() */
28014387006cSdrh       if( sqlite3Select(pParse, pSelect, &dest) ){
280271c57db0Sdan         sqlite3DbFree(pParse->db, dest.zAffSdst);
28032ec2fb22Sdrh         sqlite3KeyInfoUnref(pKeyInfo);
280485bcdce2Sdrh         return;
280594ccde58Sdrh       }
280671c57db0Sdan       sqlite3DbFree(pParse->db, dest.zAffSdst);
2807812ea833Sdrh       assert( pKeyInfo!=0 ); /* OOM will cause exit after sqlite3Select() */
28083535ec3eSdrh       assert( pEList!=0 );
28093535ec3eSdrh       assert( pEList->nExpr>0 );
28102ec2fb22Sdrh       assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
281171c57db0Sdan       for(i=0; i<nVal; i++){
2812773d3afaSdan         Expr *p = sqlite3VectorFieldSubexpr(pLeft, i);
281371c57db0Sdan         pKeyInfo->aColl[i] = sqlite3BinaryCompareCollSeq(
281471c57db0Sdan             pParse, p, pEList->a[i].pExpr
281571c57db0Sdan         );
281671c57db0Sdan       }
281771c57db0Sdan     }
2818a7d2db17Sdrh   }else if( ALWAYS(pExpr->x.pList!=0) ){
2819fef5208cSdrh     /* Case 2:     expr IN (exprlist)
2820fef5208cSdrh     **
2821e014a838Sdanielk1977     ** For each expression, build an index key from the evaluation and
2822e014a838Sdanielk1977     ** store it in the temporary table. If <expr> is a column, then use
2823e014a838Sdanielk1977     ** that columns affinity when building index keys. If <expr> is not
2824e014a838Sdanielk1977     ** a column, use numeric affinity.
2825fef5208cSdrh     */
282671c57db0Sdan     char affinity;            /* Affinity of the LHS of the IN */
2827e014a838Sdanielk1977     int i;
28286ab3a2ecSdanielk1977     ExprList *pList = pExpr->x.pList;
282957dbd7b3Sdrh     struct ExprList_item *pItem;
2830c324d446Sdan     int r1, r2;
283171c57db0Sdan     affinity = sqlite3ExprAffinity(pLeft);
283296fb16eeSdrh     if( affinity<=SQLITE_AFF_NONE ){
283305883a34Sdrh       affinity = SQLITE_AFF_BLOB;
2834e014a838Sdanielk1977     }
2835323df790Sdrh     if( pKeyInfo ){
28362ec2fb22Sdrh       assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
2837323df790Sdrh       pKeyInfo->aColl[0] = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
2838323df790Sdrh     }
2839e014a838Sdanielk1977 
2840e014a838Sdanielk1977     /* Loop through each expression in <exprlist>. */
28412d401ab8Sdrh     r1 = sqlite3GetTempReg(pParse);
28422d401ab8Sdrh     r2 = sqlite3GetTempReg(pParse);
284357dbd7b3Sdrh     for(i=pList->nExpr, pItem=pList->a; i>0; i--, pItem++){
284457dbd7b3Sdrh       Expr *pE2 = pItem->pExpr;
2845e014a838Sdanielk1977 
284657dbd7b3Sdrh       /* If the expression is not constant then we will need to
284757dbd7b3Sdrh       ** disable the test that was generated above that makes sure
284857dbd7b3Sdrh       ** this code only executes once.  Because for a non-constant
284957dbd7b3Sdrh       ** expression we need to rerun this code each time.
285057dbd7b3Sdrh       */
28512c04131cSdrh       if( addrOnce && !sqlite3ExprIsConstant(pE2) ){
28522c04131cSdrh         sqlite3VdbeChangeToNoop(v, addrOnce);
28537ac0e562Sdan         ExprClearProperty(pExpr, EP_Subrtn);
28542c04131cSdrh         addrOnce = 0;
28554794b980Sdrh       }
2856e014a838Sdanielk1977 
2857e014a838Sdanielk1977       /* Evaluate the expression and insert it into the temp table */
2858c324d446Sdan       sqlite3ExprCode(pParse, pE2, r1);
2859c324d446Sdan       sqlite3VdbeAddOp4(v, OP_MakeRecord, r1, 1, r2, &affinity, 1);
2860c324d446Sdan       sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iTab, r2, r1, 1);
2861fef5208cSdrh     }
28622d401ab8Sdrh     sqlite3ReleaseTempReg(pParse, r1);
28632d401ab8Sdrh     sqlite3ReleaseTempReg(pParse, r2);
2864fef5208cSdrh   }
2865323df790Sdrh   if( pKeyInfo ){
28662ec2fb22Sdrh     sqlite3VdbeChangeP4(v, addr, (void *)pKeyInfo, P4_KEYINFO);
286741a05b7bSdanielk1977   }
28682c04131cSdrh   if( addrOnce ){
28692c04131cSdrh     sqlite3VdbeJumpHere(v, addrOnce);
28702c04131cSdrh     /* Subroutine return */
28712c04131cSdrh     sqlite3VdbeAddOp1(v, OP_Return, pExpr->y.sub.regReturn);
28722c04131cSdrh     sqlite3VdbeChangeP1(v, pExpr->y.sub.iAddr-1, sqlite3VdbeCurrentAddr(v)-1);
28736d2566dfSdrh     sqlite3ClearTempRegCache(pParse);
287485bcdce2Sdrh   }
287585bcdce2Sdrh }
287685bcdce2Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
287785bcdce2Sdrh 
287885bcdce2Sdrh /*
287985bcdce2Sdrh ** Generate code for scalar subqueries used as a subquery expression
288085bcdce2Sdrh ** or EXISTS operator:
288185bcdce2Sdrh **
288285bcdce2Sdrh **     (SELECT a FROM b)          -- subquery
288385bcdce2Sdrh **     EXISTS (SELECT a FROM b)   -- EXISTS subquery
288485bcdce2Sdrh **
288585bcdce2Sdrh ** The pExpr parameter is the SELECT or EXISTS operator to be coded.
288685bcdce2Sdrh **
2887d86fe44aSdrh ** Return the register that holds the result.  For a multi-column SELECT,
288885bcdce2Sdrh ** the result is stored in a contiguous array of registers and the
288985bcdce2Sdrh ** return value is the register of the left-most result column.
289085bcdce2Sdrh ** Return 0 if an error occurs.
289185bcdce2Sdrh */
289285bcdce2Sdrh #ifndef SQLITE_OMIT_SUBQUERY
289385bcdce2Sdrh int sqlite3CodeSubselect(Parse *pParse, Expr *pExpr){
28942c04131cSdrh   int addrOnce = 0;           /* Address of OP_Once at top of subroutine */
289585bcdce2Sdrh   int rReg = 0;               /* Register storing resulting */
289685bcdce2Sdrh   Select *pSel;               /* SELECT statement to encode */
289785bcdce2Sdrh   SelectDest dest;            /* How to deal with SELECT result */
289885bcdce2Sdrh   int nReg;                   /* Registers to allocate */
289985bcdce2Sdrh   Expr *pLimit;               /* New limit expression */
29002c04131cSdrh 
29012c04131cSdrh   Vdbe *v = pParse->pVdbe;
290285bcdce2Sdrh   assert( v!=0 );
2903bd462bccSdrh   testcase( pExpr->op==TK_EXISTS );
2904bd462bccSdrh   testcase( pExpr->op==TK_SELECT );
2905bd462bccSdrh   assert( pExpr->op==TK_EXISTS || pExpr->op==TK_SELECT );
2906bd462bccSdrh   assert( ExprHasProperty(pExpr, EP_xIsSelect) );
2907bd462bccSdrh   pSel = pExpr->x.pSelect;
290885bcdce2Sdrh 
29095198ff57Sdrh   /* The evaluation of the EXISTS/SELECT must be repeated every time it
291085bcdce2Sdrh   ** is encountered if any of the following is true:
291185bcdce2Sdrh   **
291285bcdce2Sdrh   **    *  The right-hand side is a correlated subquery
291385bcdce2Sdrh   **    *  The right-hand side is an expression list containing variables
291485bcdce2Sdrh   **    *  We are inside a trigger
291585bcdce2Sdrh   **
291685bcdce2Sdrh   ** If all of the above are false, then we can run this code just once
291785bcdce2Sdrh   ** save the results, and reuse the same result on subsequent invocations.
291885bcdce2Sdrh   */
291985bcdce2Sdrh   if( !ExprHasProperty(pExpr, EP_VarSelect) ){
29205198ff57Sdrh     /* If this routine has already been coded, then invoke it as a
29215198ff57Sdrh     ** subroutine. */
29225198ff57Sdrh     if( ExprHasProperty(pExpr, EP_Subrtn) ){
2923bd462bccSdrh       ExplainQueryPlan((pParse, 0, "REUSE SUBQUERY %d", pSel->selId));
29245198ff57Sdrh       sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
29255198ff57Sdrh                         pExpr->y.sub.iAddr);
29265198ff57Sdrh       return pExpr->iTable;
29275198ff57Sdrh     }
29285198ff57Sdrh 
29295198ff57Sdrh     /* Begin coding the subroutine */
29305198ff57Sdrh     ExprSetProperty(pExpr, EP_Subrtn);
29315198ff57Sdrh     pExpr->y.sub.regReturn = ++pParse->nMem;
29325198ff57Sdrh     pExpr->y.sub.iAddr =
29335198ff57Sdrh       sqlite3VdbeAddOp2(v, OP_Integer, 0, pExpr->y.sub.regReturn) + 1;
29345198ff57Sdrh     VdbeComment((v, "return address"));
29355198ff57Sdrh 
29362c04131cSdrh     addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
2937fef5208cSdrh   }
2938fef5208cSdrh 
293985bcdce2Sdrh   /* For a SELECT, generate code to put the values for all columns of
294039a11819Sdrh   ** the first row into an array of registers and return the index of
294139a11819Sdrh   ** the first register.
294239a11819Sdrh   **
294339a11819Sdrh   ** If this is an EXISTS, write an integer 0 (not exists) or 1 (exists)
294439a11819Sdrh   ** into a register and return that register number.
294539a11819Sdrh   **
294639a11819Sdrh   ** In both cases, the query is augmented with "LIMIT 1".  Any
294739a11819Sdrh   ** preexisting limit is discarded in place of the new LIMIT 1.
2948fef5208cSdrh   */
2949bd462bccSdrh   ExplainQueryPlan((pParse, 1, "%sSCALAR SUBQUERY %d",
2950bd462bccSdrh         addrOnce?"":"CORRELATED ", pSel->selId));
295171c57db0Sdan   nReg = pExpr->op==TK_SELECT ? pSel->pEList->nExpr : 1;
295271c57db0Sdan   sqlite3SelectDestInit(&dest, 0, pParse->nMem+1);
295371c57db0Sdan   pParse->nMem += nReg;
295451522cd3Sdrh   if( pExpr->op==TK_SELECT ){
29556c8c8ce0Sdanielk1977     dest.eDest = SRT_Mem;
295653932ce8Sdrh     dest.iSdst = dest.iSDParm;
295771c57db0Sdan     dest.nSdst = nReg;
295871c57db0Sdan     sqlite3VdbeAddOp3(v, OP_Null, 0, dest.iSDParm, dest.iSDParm+nReg-1);
2959d4e70ebdSdrh     VdbeComment((v, "Init subquery result"));
296051522cd3Sdrh   }else{
29616c8c8ce0Sdanielk1977     dest.eDest = SRT_Exists;
29622b596da8Sdrh     sqlite3VdbeAddOp2(v, OP_Integer, 0, dest.iSDParm);
2963d4e70ebdSdrh     VdbeComment((v, "Init EXISTS result"));
296451522cd3Sdrh   }
29658c0833fbSdrh   if( pSel->pLimit ){
29667ca1347fSdrh     /* The subquery already has a limit.  If the pre-existing limit is X
29677ca1347fSdrh     ** then make the new limit X<>0 so that the new limit is either 1 or 0 */
29687ca1347fSdrh     sqlite3 *db = pParse->db;
29695776ee5cSdrh     pLimit = sqlite3Expr(db, TK_INTEGER, "0");
29707ca1347fSdrh     if( pLimit ){
29717ca1347fSdrh       pLimit->affExpr = SQLITE_AFF_NUMERIC;
29727ca1347fSdrh       pLimit = sqlite3PExpr(pParse, TK_NE,
29737ca1347fSdrh                             sqlite3ExprDup(db, pSel->pLimit->pLeft, 0), pLimit);
29747ca1347fSdrh     }
29757ca1347fSdrh     sqlite3ExprDelete(db, pSel->pLimit->pLeft);
29768c0833fbSdrh     pSel->pLimit->pLeft = pLimit;
29778c0833fbSdrh   }else{
29787ca1347fSdrh     /* If there is no pre-existing limit add a limit of 1 */
29795776ee5cSdrh     pLimit = sqlite3Expr(pParse->db, TK_INTEGER, "1");
29808c0833fbSdrh     pSel->pLimit = sqlite3PExpr(pParse, TK_LIMIT, pLimit, 0);
29818c0833fbSdrh   }
298248b5b041Sdrh   pSel->iLimit = 0;
29837d10d5a6Sdrh   if( sqlite3Select(pParse, pSel, &dest) ){
29841450bc6eSdrh     return 0;
298594ccde58Sdrh   }
29862c04131cSdrh   pExpr->iTable = rReg = dest.iSDParm;
2987ebb6a65dSdrh   ExprSetVVAProperty(pExpr, EP_NoReduce);
29882c04131cSdrh   if( addrOnce ){
29892c04131cSdrh     sqlite3VdbeJumpHere(v, addrOnce);
2990fc976065Sdanielk1977 
29912c04131cSdrh     /* Subroutine return */
29922c04131cSdrh     sqlite3VdbeAddOp1(v, OP_Return, pExpr->y.sub.regReturn);
29932c04131cSdrh     sqlite3VdbeChangeP1(v, pExpr->y.sub.iAddr-1, sqlite3VdbeCurrentAddr(v)-1);
29946d2566dfSdrh     sqlite3ClearTempRegCache(pParse);
29955198ff57Sdrh   }
29962c04131cSdrh 
29971450bc6eSdrh   return rReg;
2998cce7d176Sdrh }
299951522cd3Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
3000cce7d176Sdrh 
3001e3365e6cSdrh #ifndef SQLITE_OMIT_SUBQUERY
3002e3365e6cSdrh /*
30037b35a77bSdan ** Expr pIn is an IN(...) expression. This function checks that the
30047b35a77bSdan ** sub-select on the RHS of the IN() operator has the same number of
30057b35a77bSdan ** columns as the vector on the LHS. Or, if the RHS of the IN() is not
30067b35a77bSdan ** a sub-query, that the LHS is a vector of size 1.
30077b35a77bSdan */
30087b35a77bSdan int sqlite3ExprCheckIN(Parse *pParse, Expr *pIn){
30097b35a77bSdan   int nVector = sqlite3ExprVectorSize(pIn->pLeft);
30107b35a77bSdan   if( (pIn->flags & EP_xIsSelect) ){
30117b35a77bSdan     if( nVector!=pIn->x.pSelect->pEList->nExpr ){
30127b35a77bSdan       sqlite3SubselectError(pParse, pIn->x.pSelect->pEList->nExpr, nVector);
30137b35a77bSdan       return 1;
30147b35a77bSdan     }
30157b35a77bSdan   }else if( nVector!=1 ){
301644c5604cSdan     sqlite3VectorErrorMsg(pParse, pIn->pLeft);
30177b35a77bSdan     return 1;
30187b35a77bSdan   }
30197b35a77bSdan   return 0;
30207b35a77bSdan }
30217b35a77bSdan #endif
30227b35a77bSdan 
30237b35a77bSdan #ifndef SQLITE_OMIT_SUBQUERY
30247b35a77bSdan /*
3025e3365e6cSdrh ** Generate code for an IN expression.
3026e3365e6cSdrh **
3027e3365e6cSdrh **      x IN (SELECT ...)
3028e3365e6cSdrh **      x IN (value, value, ...)
3029e3365e6cSdrh **
3030ecb87ac8Sdrh ** The left-hand side (LHS) is a scalar or vector expression.  The
3031e347d3e8Sdrh ** right-hand side (RHS) is an array of zero or more scalar values, or a
3032e347d3e8Sdrh ** subquery.  If the RHS is a subquery, the number of result columns must
3033e347d3e8Sdrh ** match the number of columns in the vector on the LHS.  If the RHS is
3034e347d3e8Sdrh ** a list of values, the LHS must be a scalar.
3035e347d3e8Sdrh **
3036e347d3e8Sdrh ** The IN operator is true if the LHS value is contained within the RHS.
3037e347d3e8Sdrh ** The result is false if the LHS is definitely not in the RHS.  The
3038e347d3e8Sdrh ** result is NULL if the presence of the LHS in the RHS cannot be
3039e347d3e8Sdrh ** determined due to NULLs.
3040e3365e6cSdrh **
30416be515ebSdrh ** This routine generates code that jumps to destIfFalse if the LHS is not
3042e3365e6cSdrh ** contained within the RHS.  If due to NULLs we cannot determine if the LHS
3043e3365e6cSdrh ** is contained in the RHS then jump to destIfNull.  If the LHS is contained
3044e3365e6cSdrh ** within the RHS then fall through.
3045ecb87ac8Sdrh **
3046ecb87ac8Sdrh ** See the separate in-operator.md documentation file in the canonical
3047ecb87ac8Sdrh ** SQLite source tree for additional information.
3048e3365e6cSdrh */
3049e3365e6cSdrh static void sqlite3ExprCodeIN(
3050e3365e6cSdrh   Parse *pParse,        /* Parsing and code generating context */
3051e3365e6cSdrh   Expr *pExpr,          /* The IN expression */
3052e3365e6cSdrh   int destIfFalse,      /* Jump here if LHS is not contained in the RHS */
3053e3365e6cSdrh   int destIfNull        /* Jump here if the results are unknown due to NULLs */
3054e3365e6cSdrh ){
3055e3365e6cSdrh   int rRhsHasNull = 0;  /* Register that is true if RHS contains NULL values */
3056e3365e6cSdrh   int eType;            /* Type of the RHS */
3057e347d3e8Sdrh   int rLhs;             /* Register(s) holding the LHS values */
3058e347d3e8Sdrh   int rLhsOrig;         /* LHS values prior to reordering by aiMap[] */
3059e3365e6cSdrh   Vdbe *v;              /* Statement under construction */
3060ba00e30aSdan   int *aiMap = 0;       /* Map from vector field to index column */
3061ba00e30aSdan   char *zAff = 0;       /* Affinity string for comparisons */
3062ecb87ac8Sdrh   int nVector;          /* Size of vectors for this IN operator */
306312abf408Sdrh   int iDummy;           /* Dummy parameter to exprCodeVector() */
3064e347d3e8Sdrh   Expr *pLeft;          /* The LHS of the IN operator */
3065ecb87ac8Sdrh   int i;                /* loop counter */
3066e347d3e8Sdrh   int destStep2;        /* Where to jump when NULLs seen in step 2 */
3067e347d3e8Sdrh   int destStep6 = 0;    /* Start of code for Step 6 */
3068e347d3e8Sdrh   int addrTruthOp;      /* Address of opcode that determines the IN is true */
3069e347d3e8Sdrh   int destNotNull;      /* Jump here if a comparison is not true in step 6 */
3070e347d3e8Sdrh   int addrTop;          /* Top of the step-6 loop */
30712c04131cSdrh   int iTab = 0;         /* Index to use */
3072e3365e6cSdrh 
3073e347d3e8Sdrh   pLeft = pExpr->pLeft;
30747b35a77bSdan   if( sqlite3ExprCheckIN(pParse, pExpr) ) return;
3075553168c7Sdan   zAff = exprINAffinity(pParse, pExpr);
3076ba00e30aSdan   nVector = sqlite3ExprVectorSize(pExpr->pLeft);
3077ba00e30aSdan   aiMap = (int*)sqlite3DbMallocZero(
3078ba00e30aSdan       pParse->db, nVector*(sizeof(int) + sizeof(char)) + 1
3079ba00e30aSdan   );
3080e347d3e8Sdrh   if( pParse->db->mallocFailed ) goto sqlite3ExprCodeIN_oom_error;
30817b35a77bSdan 
3082ba00e30aSdan   /* Attempt to compute the RHS. After this step, if anything other than
30832c04131cSdrh   ** IN_INDEX_NOOP is returned, the table opened with cursor iTab
3084ba00e30aSdan   ** contains the values that make up the RHS. If IN_INDEX_NOOP is returned,
3085ba00e30aSdan   ** the RHS has not yet been coded.  */
3086e3365e6cSdrh   v = pParse->pVdbe;
3087e3365e6cSdrh   assert( v!=0 );       /* OOM detected prior to this routine */
3088e3365e6cSdrh   VdbeNoopComment((v, "begin IN expr"));
3089bb53ecb1Sdrh   eType = sqlite3FindInIndex(pParse, pExpr,
3090bb53ecb1Sdrh                              IN_INDEX_MEMBERSHIP | IN_INDEX_NOOP_OK,
30912c04131cSdrh                              destIfFalse==destIfNull ? 0 : &rRhsHasNull,
30922c04131cSdrh                              aiMap, &iTab);
3093e3365e6cSdrh 
3094ba00e30aSdan   assert( pParse->nErr || nVector==1 || eType==IN_INDEX_EPH
3095ba00e30aSdan        || eType==IN_INDEX_INDEX_ASC || eType==IN_INDEX_INDEX_DESC
3096ba00e30aSdan   );
3097ecb87ac8Sdrh #ifdef SQLITE_DEBUG
3098ecb87ac8Sdrh   /* Confirm that aiMap[] contains nVector integer values between 0 and
3099ecb87ac8Sdrh   ** nVector-1. */
3100ecb87ac8Sdrh   for(i=0; i<nVector; i++){
3101ecb87ac8Sdrh     int j, cnt;
3102ecb87ac8Sdrh     for(cnt=j=0; j<nVector; j++) if( aiMap[j]==i ) cnt++;
3103ecb87ac8Sdrh     assert( cnt==1 );
3104ecb87ac8Sdrh   }
3105ecb87ac8Sdrh #endif
3106e3365e6cSdrh 
3107ba00e30aSdan   /* Code the LHS, the <expr> from "<expr> IN (...)". If the LHS is a
3108ba00e30aSdan   ** vector, then it is stored in an array of nVector registers starting
3109ba00e30aSdan   ** at r1.
3110e347d3e8Sdrh   **
3111e347d3e8Sdrh   ** sqlite3FindInIndex() might have reordered the fields of the LHS vector
3112e347d3e8Sdrh   ** so that the fields are in the same order as an existing index.   The
3113e347d3e8Sdrh   ** aiMap[] array contains a mapping from the original LHS field order to
3114e347d3e8Sdrh   ** the field order that matches the RHS index.
3115e3365e6cSdrh   */
3116e347d3e8Sdrh   rLhsOrig = exprCodeVector(pParse, pLeft, &iDummy);
3117e347d3e8Sdrh   for(i=0; i<nVector && aiMap[i]==i; i++){} /* Are LHS fields reordered? */
3118ecb87ac8Sdrh   if( i==nVector ){
3119e347d3e8Sdrh     /* LHS fields are not reordered */
3120e347d3e8Sdrh     rLhs = rLhsOrig;
3121ecb87ac8Sdrh   }else{
3122ecb87ac8Sdrh     /* Need to reorder the LHS fields according to aiMap */
3123e347d3e8Sdrh     rLhs = sqlite3GetTempRange(pParse, nVector);
3124ba00e30aSdan     for(i=0; i<nVector; i++){
3125e347d3e8Sdrh       sqlite3VdbeAddOp3(v, OP_Copy, rLhsOrig+i, rLhs+aiMap[i], 0);
3126ba00e30aSdan     }
3127ecb87ac8Sdrh   }
3128e3365e6cSdrh 
3129bb53ecb1Sdrh   /* If sqlite3FindInIndex() did not find or create an index that is
3130bb53ecb1Sdrh   ** suitable for evaluating the IN operator, then evaluate using a
3131bb53ecb1Sdrh   ** sequence of comparisons.
3132e347d3e8Sdrh   **
3133e347d3e8Sdrh   ** This is step (1) in the in-operator.md optimized algorithm.
3134bb53ecb1Sdrh   */
3135bb53ecb1Sdrh   if( eType==IN_INDEX_NOOP ){
3136bb53ecb1Sdrh     ExprList *pList = pExpr->x.pList;
3137bb53ecb1Sdrh     CollSeq *pColl = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
3138ec4ccdbcSdrh     int labelOk = sqlite3VdbeMakeLabel(pParse);
3139bb53ecb1Sdrh     int r2, regToFree;
3140bb53ecb1Sdrh     int regCkNull = 0;
3141bb53ecb1Sdrh     int ii;
3142dd668c26Sdrh     int bLhsReal;  /* True if the LHS of the IN has REAL affinity */
3143bb53ecb1Sdrh     assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
3144bb53ecb1Sdrh     if( destIfNull!=destIfFalse ){
3145bb53ecb1Sdrh       regCkNull = sqlite3GetTempReg(pParse);
3146e347d3e8Sdrh       sqlite3VdbeAddOp3(v, OP_BitAnd, rLhs, rLhs, regCkNull);
3147bb53ecb1Sdrh     }
3148dd668c26Sdrh     bLhsReal = sqlite3ExprAffinity(pExpr->pLeft)==SQLITE_AFF_REAL;
3149bb53ecb1Sdrh     for(ii=0; ii<pList->nExpr; ii++){
3150dd668c26Sdrh       if( bLhsReal ){
31514fc83654Sdrh         r2 = regToFree = sqlite3GetTempReg(pParse);
31524fc83654Sdrh         sqlite3ExprCode(pParse, pList->a[ii].pExpr, r2);
3153dd668c26Sdrh         sqlite3VdbeAddOp4(v, OP_Affinity, r2, 1, 0, "E", P4_STATIC);
31544fc83654Sdrh       }else{
31554fc83654Sdrh         r2 = sqlite3ExprCodeTemp(pParse, pList->a[ii].pExpr, &regToFree);
3156dd668c26Sdrh       }
3157a976979bSdrh       if( regCkNull && sqlite3ExprCanBeNull(pList->a[ii].pExpr) ){
3158bb53ecb1Sdrh         sqlite3VdbeAddOp3(v, OP_BitAnd, regCkNull, r2, regCkNull);
3159bb53ecb1Sdrh       }
3160bb53ecb1Sdrh       if( ii<pList->nExpr-1 || destIfNull!=destIfFalse ){
3161e347d3e8Sdrh         sqlite3VdbeAddOp4(v, OP_Eq, rLhs, labelOk, r2,
31624336b0e6Sdrh                           (void*)pColl, P4_COLLSEQ);
31634336b0e6Sdrh         VdbeCoverageIf(v, ii<pList->nExpr-1);
31644336b0e6Sdrh         VdbeCoverageIf(v, ii==pList->nExpr-1);
3165ba00e30aSdan         sqlite3VdbeChangeP5(v, zAff[0]);
3166bb53ecb1Sdrh       }else{
3167bb53ecb1Sdrh         assert( destIfNull==destIfFalse );
3168e347d3e8Sdrh         sqlite3VdbeAddOp4(v, OP_Ne, rLhs, destIfFalse, r2,
3169bb53ecb1Sdrh                           (void*)pColl, P4_COLLSEQ); VdbeCoverage(v);
3170ba00e30aSdan         sqlite3VdbeChangeP5(v, zAff[0] | SQLITE_JUMPIFNULL);
3171bb53ecb1Sdrh       }
3172bb53ecb1Sdrh       sqlite3ReleaseTempReg(pParse, regToFree);
3173bb53ecb1Sdrh     }
3174bb53ecb1Sdrh     if( regCkNull ){
3175bb53ecb1Sdrh       sqlite3VdbeAddOp2(v, OP_IsNull, regCkNull, destIfNull); VdbeCoverage(v);
3176076e85f5Sdrh       sqlite3VdbeGoto(v, destIfFalse);
3177bb53ecb1Sdrh     }
3178bb53ecb1Sdrh     sqlite3VdbeResolveLabel(v, labelOk);
3179bb53ecb1Sdrh     sqlite3ReleaseTempReg(pParse, regCkNull);
3180e347d3e8Sdrh     goto sqlite3ExprCodeIN_finished;
3181e347d3e8Sdrh   }
3182bb53ecb1Sdrh 
3183e347d3e8Sdrh   /* Step 2: Check to see if the LHS contains any NULL columns.  If the
3184e347d3e8Sdrh   ** LHS does contain NULLs then the result must be either FALSE or NULL.
3185e347d3e8Sdrh   ** We will then skip the binary search of the RHS.
3186e347d3e8Sdrh   */
3187094430ebSdrh   if( destIfNull==destIfFalse ){
3188e347d3e8Sdrh     destStep2 = destIfFalse;
3189e347d3e8Sdrh   }else{
3190ec4ccdbcSdrh     destStep2 = destStep6 = sqlite3VdbeMakeLabel(pParse);
3191e347d3e8Sdrh   }
3192d49fd4e8Sdan   for(i=0; i<nVector; i++){
3193fc7f27b9Sdrh     Expr *p = sqlite3VectorFieldSubexpr(pExpr->pLeft, i);
3194d49fd4e8Sdan     if( sqlite3ExprCanBeNull(p) ){
3195e347d3e8Sdrh       sqlite3VdbeAddOp2(v, OP_IsNull, rLhs+i, destStep2);
3196471b4b92Sdrh       VdbeCoverage(v);
3197d49fd4e8Sdan     }
3198d49fd4e8Sdan   }
3199e3365e6cSdrh 
3200e347d3e8Sdrh   /* Step 3.  The LHS is now known to be non-NULL.  Do the binary search
3201e347d3e8Sdrh   ** of the RHS using the LHS as a probe.  If found, the result is
3202e347d3e8Sdrh   ** true.
3203e347d3e8Sdrh   */
3204e3365e6cSdrh   if( eType==IN_INDEX_ROWID ){
3205e347d3e8Sdrh     /* In this case, the RHS is the ROWID of table b-tree and so we also
3206e347d3e8Sdrh     ** know that the RHS is non-NULL.  Hence, we combine steps 3 and 4
3207e347d3e8Sdrh     ** into a single opcode. */
32082c04131cSdrh     sqlite3VdbeAddOp3(v, OP_SeekRowid, iTab, destIfFalse, rLhs);
3209688852abSdrh     VdbeCoverage(v);
3210e347d3e8Sdrh     addrTruthOp = sqlite3VdbeAddOp0(v, OP_Goto);  /* Return True */
32117b35a77bSdan   }else{
3212e347d3e8Sdrh     sqlite3VdbeAddOp4(v, OP_Affinity, rLhs, nVector, 0, zAff, nVector);
3213e347d3e8Sdrh     if( destIfFalse==destIfNull ){
3214e347d3e8Sdrh       /* Combine Step 3 and Step 5 into a single opcode */
32152c04131cSdrh       sqlite3VdbeAddOp4Int(v, OP_NotFound, iTab, destIfFalse,
3216e347d3e8Sdrh                            rLhs, nVector); VdbeCoverage(v);
3217e347d3e8Sdrh       goto sqlite3ExprCodeIN_finished;
3218e347d3e8Sdrh     }
3219e347d3e8Sdrh     /* Ordinary Step 3, for the case where FALSE and NULL are distinct */
32202c04131cSdrh     addrTruthOp = sqlite3VdbeAddOp4Int(v, OP_Found, iTab, 0,
3221e347d3e8Sdrh                                       rLhs, nVector); VdbeCoverage(v);
3222e347d3e8Sdrh   }
3223ba00e30aSdan 
3224e347d3e8Sdrh   /* Step 4.  If the RHS is known to be non-NULL and we did not find
3225e347d3e8Sdrh   ** an match on the search above, then the result must be FALSE.
3226e347d3e8Sdrh   */
3227e347d3e8Sdrh   if( rRhsHasNull && nVector==1 ){
3228e347d3e8Sdrh     sqlite3VdbeAddOp2(v, OP_NotNull, rRhsHasNull, destIfFalse);
3229471b4b92Sdrh     VdbeCoverage(v);
3230e347d3e8Sdrh   }
32317b35a77bSdan 
3232e347d3e8Sdrh   /* Step 5.  If we do not care about the difference between NULL and
3233e347d3e8Sdrh   ** FALSE, then just return false.
3234e347d3e8Sdrh   */
3235e347d3e8Sdrh   if( destIfFalse==destIfNull ) sqlite3VdbeGoto(v, destIfFalse);
3236e347d3e8Sdrh 
3237e347d3e8Sdrh   /* Step 6: Loop through rows of the RHS.  Compare each row to the LHS.
3238e347d3e8Sdrh   ** If any comparison is NULL, then the result is NULL.  If all
3239e347d3e8Sdrh   ** comparisons are FALSE then the final result is FALSE.
3240e347d3e8Sdrh   **
3241e347d3e8Sdrh   ** For a scalar LHS, it is sufficient to check just the first row
3242e347d3e8Sdrh   ** of the RHS.
3243e347d3e8Sdrh   */
3244e347d3e8Sdrh   if( destStep6 ) sqlite3VdbeResolveLabel(v, destStep6);
32452c04131cSdrh   addrTop = sqlite3VdbeAddOp2(v, OP_Rewind, iTab, destIfFalse);
3246471b4b92Sdrh   VdbeCoverage(v);
3247e347d3e8Sdrh   if( nVector>1 ){
3248ec4ccdbcSdrh     destNotNull = sqlite3VdbeMakeLabel(pParse);
3249e347d3e8Sdrh   }else{
3250e347d3e8Sdrh     /* For nVector==1, combine steps 6 and 7 by immediately returning
3251e347d3e8Sdrh     ** FALSE if the first comparison is not NULL */
3252e347d3e8Sdrh     destNotNull = destIfFalse;
3253e347d3e8Sdrh   }
3254ba00e30aSdan   for(i=0; i<nVector; i++){
3255ba00e30aSdan     Expr *p;
3256ba00e30aSdan     CollSeq *pColl;
3257e347d3e8Sdrh     int r3 = sqlite3GetTempReg(pParse);
3258fc7f27b9Sdrh     p = sqlite3VectorFieldSubexpr(pLeft, i);
3259ba00e30aSdan     pColl = sqlite3ExprCollSeq(pParse, p);
32602c04131cSdrh     sqlite3VdbeAddOp3(v, OP_Column, iTab, i, r3);
3261e347d3e8Sdrh     sqlite3VdbeAddOp4(v, OP_Ne, rLhs+i, destNotNull, r3,
326218016ad2Sdrh                       (void*)pColl, P4_COLLSEQ);
3263471b4b92Sdrh     VdbeCoverage(v);
3264e347d3e8Sdrh     sqlite3ReleaseTempReg(pParse, r3);
32657b35a77bSdan   }
32667b35a77bSdan   sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfNull);
3267e347d3e8Sdrh   if( nVector>1 ){
3268e347d3e8Sdrh     sqlite3VdbeResolveLabel(v, destNotNull);
32692c04131cSdrh     sqlite3VdbeAddOp2(v, OP_Next, iTab, addrTop+1);
327018016ad2Sdrh     VdbeCoverage(v);
3271e347d3e8Sdrh 
3272e347d3e8Sdrh     /* Step 7:  If we reach this point, we know that the result must
3273e347d3e8Sdrh     ** be false. */
327418016ad2Sdrh     sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfFalse);
32757b35a77bSdan   }
32767b35a77bSdan 
3277e347d3e8Sdrh   /* Jumps here in order to return true. */
3278e347d3e8Sdrh   sqlite3VdbeJumpHere(v, addrTruthOp);
3279e3365e6cSdrh 
3280e347d3e8Sdrh sqlite3ExprCodeIN_finished:
3281e347d3e8Sdrh   if( rLhs!=rLhsOrig ) sqlite3ReleaseTempReg(pParse, rLhs);
3282ecb87ac8Sdrh   VdbeComment((v, "end IN expr"));
3283e347d3e8Sdrh sqlite3ExprCodeIN_oom_error:
3284ba00e30aSdan   sqlite3DbFree(pParse->db, aiMap);
3285553168c7Sdan   sqlite3DbFree(pParse->db, zAff);
3286e3365e6cSdrh }
3287e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
3288e3365e6cSdrh 
328913573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
3290598f1340Sdrh /*
3291598f1340Sdrh ** Generate an instruction that will put the floating point
32929cbf3425Sdrh ** value described by z[0..n-1] into register iMem.
32930cf19ed8Sdrh **
32940cf19ed8Sdrh ** The z[] string will probably not be zero-terminated.  But the
32950cf19ed8Sdrh ** z[n] character is guaranteed to be something that does not look
32960cf19ed8Sdrh ** like the continuation of the number.
3297598f1340Sdrh */
3298b7916a78Sdrh static void codeReal(Vdbe *v, const char *z, int negateFlag, int iMem){
3299fd773cf9Sdrh   if( ALWAYS(z!=0) ){
3300598f1340Sdrh     double value;
33019339da1fSdrh     sqlite3AtoF(z, &value, sqlite3Strlen30(z), SQLITE_UTF8);
3302d0015161Sdrh     assert( !sqlite3IsNaN(value) ); /* The new AtoF never returns NaN */
3303598f1340Sdrh     if( negateFlag ) value = -value;
330497bae794Sdrh     sqlite3VdbeAddOp4Dup8(v, OP_Real, 0, iMem, 0, (u8*)&value, P4_REAL);
3305598f1340Sdrh   }
3306598f1340Sdrh }
330713573c71Sdrh #endif
3308598f1340Sdrh 
3309598f1340Sdrh 
3310598f1340Sdrh /*
3311fec19aadSdrh ** Generate an instruction that will put the integer describe by
33129cbf3425Sdrh ** text z[0..n-1] into register iMem.
33130cf19ed8Sdrh **
33145f1d6b61Sshaneh ** Expr.u.zToken is always UTF8 and zero-terminated.
3315fec19aadSdrh */
331613573c71Sdrh static void codeInteger(Parse *pParse, Expr *pExpr, int negFlag, int iMem){
331713573c71Sdrh   Vdbe *v = pParse->pVdbe;
331892b01d53Sdrh   if( pExpr->flags & EP_IntValue ){
331933e619fcSdrh     int i = pExpr->u.iValue;
3320d50ffc41Sdrh     assert( i>=0 );
332192b01d53Sdrh     if( negFlag ) i = -i;
332292b01d53Sdrh     sqlite3VdbeAddOp2(v, OP_Integer, i, iMem);
3323fd773cf9Sdrh   }else{
33245f1d6b61Sshaneh     int c;
33255f1d6b61Sshaneh     i64 value;
3326fd773cf9Sdrh     const char *z = pExpr->u.zToken;
3327fd773cf9Sdrh     assert( z!=0 );
33289296c18aSdrh     c = sqlite3DecOrHexToI64(z, &value);
332984d4f1a3Sdrh     if( (c==3 && !negFlag) || (c==2) || (negFlag && value==SMALLEST_INT64)){
333013573c71Sdrh #ifdef SQLITE_OMIT_FLOATING_POINT
333113573c71Sdrh       sqlite3ErrorMsg(pParse, "oversized integer: %s%s", negFlag ? "-" : "", z);
333213573c71Sdrh #else
33331b7ddc59Sdrh #ifndef SQLITE_OMIT_HEX_INTEGER
33349296c18aSdrh       if( sqlite3_strnicmp(z,"0x",2)==0 ){
333577320ea4Sdrh         sqlite3ErrorMsg(pParse, "hex literal too big: %s%s", negFlag?"-":"",z);
33361b7ddc59Sdrh       }else
33371b7ddc59Sdrh #endif
33381b7ddc59Sdrh       {
3339b7916a78Sdrh         codeReal(v, z, negFlag, iMem);
33409296c18aSdrh       }
334113573c71Sdrh #endif
334277320ea4Sdrh     }else{
334384d4f1a3Sdrh       if( negFlag ){ value = c==3 ? SMALLEST_INT64 : -value; }
334477320ea4Sdrh       sqlite3VdbeAddOp4Dup8(v, OP_Int64, 0, iMem, 0, (u8*)&value, P4_INT64);
3345fec19aadSdrh     }
3346fec19aadSdrh   }
3347c9cf901dSdanielk1977 }
3348fec19aadSdrh 
33495cd79239Sdrh 
33501f9ca2c8Sdrh /* Generate code that will load into register regOut a value that is
33511f9ca2c8Sdrh ** appropriate for the iIdxCol-th column of index pIdx.
33521f9ca2c8Sdrh */
33531f9ca2c8Sdrh void sqlite3ExprCodeLoadIndexColumn(
33541f9ca2c8Sdrh   Parse *pParse,  /* The parsing context */
33551f9ca2c8Sdrh   Index *pIdx,    /* The index whose column is to be loaded */
33561f9ca2c8Sdrh   int iTabCur,    /* Cursor pointing to a table row */
33571f9ca2c8Sdrh   int iIdxCol,    /* The column of the index to be loaded */
33581f9ca2c8Sdrh   int regOut      /* Store the index column value in this register */
33591f9ca2c8Sdrh ){
33601f9ca2c8Sdrh   i16 iTabCol = pIdx->aiColumn[iIdxCol];
33614b92f98cSdrh   if( iTabCol==XN_EXPR ){
33621f9ca2c8Sdrh     assert( pIdx->aColExpr );
33631f9ca2c8Sdrh     assert( pIdx->aColExpr->nExpr>iIdxCol );
33643e34eabcSdrh     pParse->iSelfTab = iTabCur + 1;
33651c75c9d7Sdrh     sqlite3ExprCodeCopy(pParse, pIdx->aColExpr->a[iIdxCol].pExpr, regOut);
33663e34eabcSdrh     pParse->iSelfTab = 0;
33674b92f98cSdrh   }else{
33684b92f98cSdrh     sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pIdx->pTable, iTabCur,
33694b92f98cSdrh                                     iTabCol, regOut);
33704b92f98cSdrh   }
33711f9ca2c8Sdrh }
33721f9ca2c8Sdrh 
33735cd79239Sdrh /*
33745c092e8aSdrh ** Generate code to extract the value of the iCol-th column of a table.
33755c092e8aSdrh */
33765c092e8aSdrh void sqlite3ExprCodeGetColumnOfTable(
33775c092e8aSdrh   Vdbe *v,        /* The VDBE under construction */
33785c092e8aSdrh   Table *pTab,    /* The table containing the value */
3379313619f5Sdrh   int iTabCur,    /* The table cursor.  Or the PK cursor for WITHOUT ROWID */
33805c092e8aSdrh   int iCol,       /* Index of the column to extract */
3381313619f5Sdrh   int regOut      /* Extract the value into this register */
33825c092e8aSdrh ){
3383aca19e19Sdrh   if( pTab==0 ){
3384aca19e19Sdrh     sqlite3VdbeAddOp3(v, OP_Column, iTabCur, iCol, regOut);
3385aca19e19Sdrh     return;
3386aca19e19Sdrh   }
33875c092e8aSdrh   if( iCol<0 || iCol==pTab->iPKey ){
33885c092e8aSdrh     sqlite3VdbeAddOp2(v, OP_Rowid, iTabCur, regOut);
33895c092e8aSdrh   }else{
33905c092e8aSdrh     int op = IsVirtual(pTab) ? OP_VColumn : OP_Column;
3391ee0ec8e1Sdrh     int x = iCol;
339235db31b2Sdrh     if( !HasRowid(pTab) && !IsVirtual(pTab) ){
3393ee0ec8e1Sdrh       x = sqlite3ColumnOfIndex(sqlite3PrimaryKeyIndex(pTab), iCol);
3394ee0ec8e1Sdrh     }
3395ee0ec8e1Sdrh     sqlite3VdbeAddOp3(v, op, iTabCur, x, regOut);
33965c092e8aSdrh   }
33975c092e8aSdrh   if( iCol>=0 ){
33985c092e8aSdrh     sqlite3ColumnDefault(v, pTab, iCol, regOut);
33995c092e8aSdrh   }
34005c092e8aSdrh }
34015c092e8aSdrh 
34025c092e8aSdrh /*
3403945498f3Sdrh ** Generate code that will extract the iColumn-th column from
34048c607191Sdrh ** table pTab and store the column value in register iReg.
3405e55cbd72Sdrh **
3406e55cbd72Sdrh ** There must be an open cursor to pTab in iTable when this routine
3407e55cbd72Sdrh ** is called.  If iColumn<0 then code is generated that extracts the rowid.
3408945498f3Sdrh */
3409e55cbd72Sdrh int sqlite3ExprCodeGetColumn(
3410e55cbd72Sdrh   Parse *pParse,   /* Parsing and code generating context */
34112133d822Sdrh   Table *pTab,     /* Description of the table we are reading from */
34122133d822Sdrh   int iColumn,     /* Index of the table column */
34132133d822Sdrh   int iTable,      /* The cursor pointing to the table */
3414a748fdccSdrh   int iReg,        /* Store results here */
3415ce78bc6eSdrh   u8 p5            /* P5 value for OP_Column + FLAGS */
34162133d822Sdrh ){
3417e55cbd72Sdrh   Vdbe *v = pParse->pVdbe;
3418e55cbd72Sdrh   assert( v!=0 );
34195c092e8aSdrh   sqlite3ExprCodeGetColumnOfTable(v, pTab, iTable, iColumn, iReg);
3420a748fdccSdrh   if( p5 ){
3421a748fdccSdrh     sqlite3VdbeChangeP5(v, p5);
3422a748fdccSdrh   }
3423e55cbd72Sdrh   return iReg;
3424e55cbd72Sdrh }
3425e55cbd72Sdrh 
3426e55cbd72Sdrh /*
3427b21e7c70Sdrh ** Generate code to move content from registers iFrom...iFrom+nReg-1
342836a5d88dSdrh ** over to iTo..iTo+nReg-1.
3429e55cbd72Sdrh */
3430b21e7c70Sdrh void sqlite3ExprCodeMove(Parse *pParse, int iFrom, int iTo, int nReg){
3431e8e4af76Sdrh   assert( iFrom>=iTo+nReg || iFrom+nReg<=iTo );
3432079a3072Sdrh   sqlite3VdbeAddOp3(pParse->pVdbe, OP_Move, iFrom, iTo, nReg);
3433945498f3Sdrh }
3434945498f3Sdrh 
3435652fbf55Sdrh /*
343612abf408Sdrh ** Convert a scalar expression node to a TK_REGISTER referencing
343712abf408Sdrh ** register iReg.  The caller must ensure that iReg already contains
343812abf408Sdrh ** the correct value for the expression.
3439a4c3c87eSdrh */
3440069d1b1fSdan static void exprToRegister(Expr *pExpr, int iReg){
34410d950af3Sdrh   Expr *p = sqlite3ExprSkipCollateAndLikely(pExpr);
3442a4c3c87eSdrh   p->op2 = p->op;
3443a4c3c87eSdrh   p->op = TK_REGISTER;
3444a4c3c87eSdrh   p->iTable = iReg;
3445a4c3c87eSdrh   ExprClearProperty(p, EP_Skip);
3446a4c3c87eSdrh }
3447a4c3c87eSdrh 
344812abf408Sdrh /*
344912abf408Sdrh ** Evaluate an expression (either a vector or a scalar expression) and store
345012abf408Sdrh ** the result in continguous temporary registers.  Return the index of
345112abf408Sdrh ** the first register used to store the result.
345212abf408Sdrh **
345312abf408Sdrh ** If the returned result register is a temporary scalar, then also write
345412abf408Sdrh ** that register number into *piFreeable.  If the returned result register
345512abf408Sdrh ** is not a temporary or if the expression is a vector set *piFreeable
345612abf408Sdrh ** to 0.
345712abf408Sdrh */
345812abf408Sdrh static int exprCodeVector(Parse *pParse, Expr *p, int *piFreeable){
345912abf408Sdrh   int iResult;
346012abf408Sdrh   int nResult = sqlite3ExprVectorSize(p);
346112abf408Sdrh   if( nResult==1 ){
346212abf408Sdrh     iResult = sqlite3ExprCodeTemp(pParse, p, piFreeable);
346312abf408Sdrh   }else{
346412abf408Sdrh     *piFreeable = 0;
346512abf408Sdrh     if( p->op==TK_SELECT ){
3466dd1bb43aSdrh #if SQLITE_OMIT_SUBQUERY
3467dd1bb43aSdrh       iResult = 0;
3468dd1bb43aSdrh #else
346985bcdce2Sdrh       iResult = sqlite3CodeSubselect(pParse, p);
3470dd1bb43aSdrh #endif
347112abf408Sdrh     }else{
347212abf408Sdrh       int i;
347312abf408Sdrh       iResult = pParse->nMem+1;
347412abf408Sdrh       pParse->nMem += nResult;
347512abf408Sdrh       for(i=0; i<nResult; i++){
34764b725240Sdan         sqlite3ExprCodeFactorable(pParse, p->x.pList->a[i].pExpr, i+iResult);
347712abf408Sdrh       }
347812abf408Sdrh     }
347912abf408Sdrh   }
348012abf408Sdrh   return iResult;
348112abf408Sdrh }
348212abf408Sdrh 
348371c57db0Sdan 
3484a4c3c87eSdrh /*
3485cce7d176Sdrh ** Generate code into the current Vdbe to evaluate the given
34862dcef11bSdrh ** expression.  Attempt to store the results in register "target".
34872dcef11bSdrh ** Return the register where results are stored.
3488389a1adbSdrh **
34898b213899Sdrh ** With this routine, there is no guarantee that results will
34902dcef11bSdrh ** be stored in target.  The result might be stored in some other
34912dcef11bSdrh ** register if it is convenient to do so.  The calling function
34922dcef11bSdrh ** must check the return code and move the results to the desired
34932dcef11bSdrh ** register.
3494cce7d176Sdrh */
3495678ccce8Sdrh int sqlite3ExprCodeTarget(Parse *pParse, Expr *pExpr, int target){
34962dcef11bSdrh   Vdbe *v = pParse->pVdbe;  /* The VM under construction */
34972dcef11bSdrh   int op;                   /* The opcode being coded */
34982dcef11bSdrh   int inReg = target;       /* Results stored in register inReg */
34992dcef11bSdrh   int regFree1 = 0;         /* If non-zero free this temporary register */
35002dcef11bSdrh   int regFree2 = 0;         /* If non-zero free this temporary register */
35017b35a77bSdan   int r1, r2;               /* Various register numbers */
350210d1edf0Sdrh   Expr tempX;               /* Temporary expression node */
350371c57db0Sdan   int p5 = 0;
3504ffe07b2dSdrh 
35059cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
350620411ea7Sdrh   if( v==0 ){
350720411ea7Sdrh     assert( pParse->db->mallocFailed );
350820411ea7Sdrh     return 0;
350920411ea7Sdrh   }
3510389a1adbSdrh 
35111efa8023Sdrh expr_code_doover:
3512389a1adbSdrh   if( pExpr==0 ){
3513389a1adbSdrh     op = TK_NULL;
3514389a1adbSdrh   }else{
3515f2bc013cSdrh     op = pExpr->op;
3516389a1adbSdrh   }
3517f2bc013cSdrh   switch( op ){
351813449892Sdrh     case TK_AGG_COLUMN: {
351913449892Sdrh       AggInfo *pAggInfo = pExpr->pAggInfo;
352013449892Sdrh       struct AggInfo_col *pCol = &pAggInfo->aCol[pExpr->iAgg];
352113449892Sdrh       if( !pAggInfo->directMode ){
35229de221dfSdrh         assert( pCol->iMem>0 );
3523c332cc30Sdrh         return pCol->iMem;
352413449892Sdrh       }else if( pAggInfo->useSortingIdx ){
35255134d135Sdan         sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdxPTab,
3526389a1adbSdrh                               pCol->iSorterColumn, target);
3527c332cc30Sdrh         return target;
352813449892Sdrh       }
352913449892Sdrh       /* Otherwise, fall thru into the TK_COLUMN case */
353013449892Sdrh     }
3531967e8b73Sdrh     case TK_COLUMN: {
3532b2b9d3d7Sdrh       int iTab = pExpr->iTable;
3533efad2e23Sdrh       if( ExprHasProperty(pExpr, EP_FixedCol) ){
3534d98f5324Sdrh         /* This COLUMN expression is really a constant due to WHERE clause
3535d98f5324Sdrh         ** constraints, and that constant is coded by the pExpr->pLeft
3536d98f5324Sdrh         ** expresssion.  However, make sure the constant has the correct
3537d98f5324Sdrh         ** datatype by applying the Affinity of the table column to the
3538d98f5324Sdrh         ** constant.
3539d98f5324Sdrh         */
3540d98f5324Sdrh         int iReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft,target);
3541eda079cdSdrh         int aff = sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
354296fb16eeSdrh         if( aff>SQLITE_AFF_BLOB ){
3543d98f5324Sdrh           static const char zAff[] = "B\000C\000D\000E";
3544d98f5324Sdrh           assert( SQLITE_AFF_BLOB=='A' );
3545d98f5324Sdrh           assert( SQLITE_AFF_TEXT=='B' );
3546d98f5324Sdrh           if( iReg!=target ){
3547d98f5324Sdrh             sqlite3VdbeAddOp2(v, OP_SCopy, iReg, target);
3548d98f5324Sdrh             iReg = target;
3549d98f5324Sdrh           }
3550d98f5324Sdrh           sqlite3VdbeAddOp4(v, OP_Affinity, iReg, 1, 0,
3551d98f5324Sdrh                             &zAff[(aff-'B')*2], P4_STATIC);
3552d98f5324Sdrh         }
3553d98f5324Sdrh         return iReg;
3554efad2e23Sdrh       }
3555b2b9d3d7Sdrh       if( iTab<0 ){
35566e97f8ecSdrh         if( pParse->iSelfTab<0 ){
3557b2b9d3d7Sdrh           /* Generating CHECK constraints or inserting into partial index */
3558bffdd636Sdrh           assert( pExpr->y.pTab!=0 );
3559bffdd636Sdrh           assert( pExpr->iColumn>=XN_ROWID );
3560bffdd636Sdrh           assert( pExpr->iColumn<pExpr->y.pTab->nCol );
3561bffdd636Sdrh           if( pExpr->iColumn>=0
3562bffdd636Sdrh             && pExpr->y.pTab->aCol[pExpr->iColumn].affinity==SQLITE_AFF_REAL
3563bffdd636Sdrh           ){
3564bffdd636Sdrh             sqlite3VdbeAddOp2(v, OP_SCopy, pExpr->iColumn - pParse->iSelfTab,
3565bffdd636Sdrh                               target);
3566bffdd636Sdrh             sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
3567bffdd636Sdrh             return target;
3568bffdd636Sdrh           }else{
35696e97f8ecSdrh             return pExpr->iColumn - pParse->iSelfTab;
3570bffdd636Sdrh           }
3571c4a3c779Sdrh         }else{
35721f9ca2c8Sdrh           /* Coding an expression that is part of an index where column names
35731f9ca2c8Sdrh           ** in the index refer to the table to which the index belongs */
35743e34eabcSdrh           iTab = pParse->iSelfTab - 1;
35752282792aSdrh         }
3576b2b9d3d7Sdrh       }
3577eda079cdSdrh       return sqlite3ExprCodeGetColumn(pParse, pExpr->y.pTab,
3578b2b9d3d7Sdrh                                pExpr->iColumn, iTab, target,
3579b2b9d3d7Sdrh                                pExpr->op2);
3580cce7d176Sdrh     }
3581cce7d176Sdrh     case TK_INTEGER: {
358213573c71Sdrh       codeInteger(pParse, pExpr, 0, target);
3583c332cc30Sdrh       return target;
358451e9a445Sdrh     }
35858abed7b9Sdrh     case TK_TRUEFALSE: {
358696acafbeSdrh       sqlite3VdbeAddOp2(v, OP_Integer, sqlite3ExprTruthValue(pExpr), target);
3587007c843bSdrh       return target;
3588007c843bSdrh     }
358913573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
3590598f1340Sdrh     case TK_FLOAT: {
359133e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
359233e619fcSdrh       codeReal(v, pExpr->u.zToken, 0, target);
3593c332cc30Sdrh       return target;
3594598f1340Sdrh     }
359513573c71Sdrh #endif
3596fec19aadSdrh     case TK_STRING: {
359733e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
3598076e85f5Sdrh       sqlite3VdbeLoadString(v, target, pExpr->u.zToken);
3599c332cc30Sdrh       return target;
3600cce7d176Sdrh     }
3601f0863fe5Sdrh     case TK_NULL: {
36029de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3603c332cc30Sdrh       return target;
3604f0863fe5Sdrh     }
36055338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_BLOB_LITERAL
3606c572ef7fSdanielk1977     case TK_BLOB: {
36076c8c6cecSdrh       int n;
36086c8c6cecSdrh       const char *z;
3609ca48c90fSdrh       char *zBlob;
361033e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
361133e619fcSdrh       assert( pExpr->u.zToken[0]=='x' || pExpr->u.zToken[0]=='X' );
361233e619fcSdrh       assert( pExpr->u.zToken[1]=='\'' );
361333e619fcSdrh       z = &pExpr->u.zToken[2];
3614b7916a78Sdrh       n = sqlite3Strlen30(z) - 1;
3615b7916a78Sdrh       assert( z[n]=='\'' );
3616ca48c90fSdrh       zBlob = sqlite3HexToBlob(sqlite3VdbeDb(v), z, n);
3617ca48c90fSdrh       sqlite3VdbeAddOp4(v, OP_Blob, n/2, target, 0, zBlob, P4_DYNAMIC);
3618c332cc30Sdrh       return target;
3619c572ef7fSdanielk1977     }
36205338a5f7Sdanielk1977 #endif
362150457896Sdrh     case TK_VARIABLE: {
362233e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
362333e619fcSdrh       assert( pExpr->u.zToken!=0 );
362433e619fcSdrh       assert( pExpr->u.zToken[0]!=0 );
3625eaf52d88Sdrh       sqlite3VdbeAddOp2(v, OP_Variable, pExpr->iColumn, target);
362633e619fcSdrh       if( pExpr->u.zToken[1]!=0 ){
36279bf755ccSdrh         const char *z = sqlite3VListNumToName(pParse->pVList, pExpr->iColumn);
36289bf755ccSdrh         assert( pExpr->u.zToken[0]=='?' || strcmp(pExpr->u.zToken, z)==0 );
3629ce1bbe51Sdrh         pParse->pVList[0] = 0; /* Indicate VList may no longer be enlarged */
36309bf755ccSdrh         sqlite3VdbeAppendP4(v, (char*)z, P4_STATIC);
36319bf755ccSdrh       }
3632c332cc30Sdrh       return target;
363350457896Sdrh     }
36344e0cff60Sdrh     case TK_REGISTER: {
3635c332cc30Sdrh       return pExpr->iTable;
36364e0cff60Sdrh     }
3637487e262fSdrh #ifndef SQLITE_OMIT_CAST
3638487e262fSdrh     case TK_CAST: {
3639487e262fSdrh       /* Expressions of the form:   CAST(pLeft AS token) */
36402dcef11bSdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
36411735fa88Sdrh       if( inReg!=target ){
36421735fa88Sdrh         sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
36431735fa88Sdrh         inReg = target;
36441735fa88Sdrh       }
36454169e430Sdrh       sqlite3VdbeAddOp2(v, OP_Cast, target,
36464169e430Sdrh                         sqlite3AffinityType(pExpr->u.zToken, 0));
3647c332cc30Sdrh       return inReg;
3648487e262fSdrh     }
3649487e262fSdrh #endif /* SQLITE_OMIT_CAST */
365071c57db0Sdan     case TK_IS:
365171c57db0Sdan     case TK_ISNOT:
365271c57db0Sdan       op = (op==TK_IS) ? TK_EQ : TK_NE;
365371c57db0Sdan       p5 = SQLITE_NULLEQ;
365471c57db0Sdan       /* fall-through */
3655c9b84a1fSdrh     case TK_LT:
3656c9b84a1fSdrh     case TK_LE:
3657c9b84a1fSdrh     case TK_GT:
3658c9b84a1fSdrh     case TK_GE:
3659c9b84a1fSdrh     case TK_NE:
3660c9b84a1fSdrh     case TK_EQ: {
366171c57db0Sdan       Expr *pLeft = pExpr->pLeft;
3662625015e0Sdan       if( sqlite3ExprIsVector(pLeft) ){
366379752b6eSdrh         codeVectorCompare(pParse, pExpr, target, op, p5);
366471c57db0Sdan       }else{
366571c57db0Sdan         r1 = sqlite3ExprCodeTemp(pParse, pLeft, &regFree1);
3666b6da74ebSdrh         r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
366771c57db0Sdan         codeCompare(pParse, pLeft, pExpr->pRight, op,
366871c57db0Sdan             r1, r2, inReg, SQLITE_STOREP2 | p5);
36697d176105Sdrh         assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
36707d176105Sdrh         assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
36717d176105Sdrh         assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
36727d176105Sdrh         assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
36737d176105Sdrh         assert(TK_EQ==OP_Eq); testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
36747d176105Sdrh         assert(TK_NE==OP_Ne); testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
3675c5499befSdrh         testcase( regFree1==0 );
3676c5499befSdrh         testcase( regFree2==0 );
3677c9b84a1fSdrh       }
36786a2fe093Sdrh       break;
36796a2fe093Sdrh     }
3680cce7d176Sdrh     case TK_AND:
3681cce7d176Sdrh     case TK_OR:
3682cce7d176Sdrh     case TK_PLUS:
3683cce7d176Sdrh     case TK_STAR:
3684cce7d176Sdrh     case TK_MINUS:
3685bf4133cbSdrh     case TK_REM:
3686bf4133cbSdrh     case TK_BITAND:
3687bf4133cbSdrh     case TK_BITOR:
368817c40294Sdrh     case TK_SLASH:
3689bf4133cbSdrh     case TK_LSHIFT:
3690855eb1cfSdrh     case TK_RSHIFT:
36910040077dSdrh     case TK_CONCAT: {
36927d176105Sdrh       assert( TK_AND==OP_And );            testcase( op==TK_AND );
36937d176105Sdrh       assert( TK_OR==OP_Or );              testcase( op==TK_OR );
36947d176105Sdrh       assert( TK_PLUS==OP_Add );           testcase( op==TK_PLUS );
36957d176105Sdrh       assert( TK_MINUS==OP_Subtract );     testcase( op==TK_MINUS );
36967d176105Sdrh       assert( TK_REM==OP_Remainder );      testcase( op==TK_REM );
36977d176105Sdrh       assert( TK_BITAND==OP_BitAnd );      testcase( op==TK_BITAND );
36987d176105Sdrh       assert( TK_BITOR==OP_BitOr );        testcase( op==TK_BITOR );
36997d176105Sdrh       assert( TK_SLASH==OP_Divide );       testcase( op==TK_SLASH );
37007d176105Sdrh       assert( TK_LSHIFT==OP_ShiftLeft );   testcase( op==TK_LSHIFT );
37017d176105Sdrh       assert( TK_RSHIFT==OP_ShiftRight );  testcase( op==TK_RSHIFT );
37027d176105Sdrh       assert( TK_CONCAT==OP_Concat );      testcase( op==TK_CONCAT );
37032dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
37042dcef11bSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
37055b6afba9Sdrh       sqlite3VdbeAddOp3(v, op, r2, r1, target);
3706c5499befSdrh       testcase( regFree1==0 );
3707c5499befSdrh       testcase( regFree2==0 );
37080040077dSdrh       break;
37090040077dSdrh     }
3710cce7d176Sdrh     case TK_UMINUS: {
3711fec19aadSdrh       Expr *pLeft = pExpr->pLeft;
3712fec19aadSdrh       assert( pLeft );
371313573c71Sdrh       if( pLeft->op==TK_INTEGER ){
371413573c71Sdrh         codeInteger(pParse, pLeft, 1, target);
3715c332cc30Sdrh         return target;
371613573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
371713573c71Sdrh       }else if( pLeft->op==TK_FLOAT ){
371833e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
371933e619fcSdrh         codeReal(v, pLeft->u.zToken, 1, target);
3720c332cc30Sdrh         return target;
372113573c71Sdrh #endif
37223c84ddffSdrh       }else{
372310d1edf0Sdrh         tempX.op = TK_INTEGER;
372410d1edf0Sdrh         tempX.flags = EP_IntValue|EP_TokenOnly;
372510d1edf0Sdrh         tempX.u.iValue = 0;
372610d1edf0Sdrh         r1 = sqlite3ExprCodeTemp(pParse, &tempX, &regFree1);
3727e55cbd72Sdrh         r2 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree2);
37282dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_Subtract, r2, r1, target);
3729c5499befSdrh         testcase( regFree2==0 );
37303c84ddffSdrh       }
37316e142f54Sdrh       break;
37326e142f54Sdrh     }
3733bf4133cbSdrh     case TK_BITNOT:
37346e142f54Sdrh     case TK_NOT: {
37357d176105Sdrh       assert( TK_BITNOT==OP_BitNot );   testcase( op==TK_BITNOT );
37367d176105Sdrh       assert( TK_NOT==OP_Not );         testcase( op==TK_NOT );
3737e99fa2afSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3738e99fa2afSdrh       testcase( regFree1==0 );
3739e99fa2afSdrh       sqlite3VdbeAddOp2(v, op, r1, inReg);
3740cce7d176Sdrh       break;
3741cce7d176Sdrh     }
37428abed7b9Sdrh     case TK_TRUTH: {
374396acafbeSdrh       int isTrue;    /* IS TRUE or IS NOT TRUE */
374496acafbeSdrh       int bNormal;   /* IS TRUE or IS FALSE */
3745007c843bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3746007c843bSdrh       testcase( regFree1==0 );
374796acafbeSdrh       isTrue = sqlite3ExprTruthValue(pExpr->pRight);
374896acafbeSdrh       bNormal = pExpr->op2==TK_IS;
374996acafbeSdrh       testcase( isTrue && bNormal);
375096acafbeSdrh       testcase( !isTrue && bNormal);
375196acafbeSdrh       sqlite3VdbeAddOp4Int(v, OP_IsTrue, r1, inReg, !isTrue, isTrue ^ bNormal);
3752007c843bSdrh       break;
3753007c843bSdrh     }
3754cce7d176Sdrh     case TK_ISNULL:
3755cce7d176Sdrh     case TK_NOTNULL: {
37566a288a33Sdrh       int addr;
37577d176105Sdrh       assert( TK_ISNULL==OP_IsNull );   testcase( op==TK_ISNULL );
37587d176105Sdrh       assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
37599de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
37602dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3761c5499befSdrh       testcase( regFree1==0 );
37622dcef11bSdrh       addr = sqlite3VdbeAddOp1(v, op, r1);
37637d176105Sdrh       VdbeCoverageIf(v, op==TK_ISNULL);
37647d176105Sdrh       VdbeCoverageIf(v, op==TK_NOTNULL);
3765a976979bSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 0, target);
37666a288a33Sdrh       sqlite3VdbeJumpHere(v, addr);
3767a37cdde0Sdanielk1977       break;
3768f2bc013cSdrh     }
37692282792aSdrh     case TK_AGG_FUNCTION: {
377013449892Sdrh       AggInfo *pInfo = pExpr->pAggInfo;
37717e56e711Sdrh       if( pInfo==0 ){
377233e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
377333e619fcSdrh         sqlite3ErrorMsg(pParse, "misuse of aggregate: %s()", pExpr->u.zToken);
37747e56e711Sdrh       }else{
3775c332cc30Sdrh         return pInfo->aFunc[pExpr->iAgg].iMem;
37767e56e711Sdrh       }
37772282792aSdrh       break;
37782282792aSdrh     }
3779cce7d176Sdrh     case TK_FUNCTION: {
378012ffee8cSdrh       ExprList *pFarg;       /* List of function arguments */
378112ffee8cSdrh       int nFarg;             /* Number of function arguments */
378212ffee8cSdrh       FuncDef *pDef;         /* The function definition object */
378312ffee8cSdrh       const char *zId;       /* The function name */
3784693e6719Sdrh       u32 constMask = 0;     /* Mask of function arguments that are constant */
378512ffee8cSdrh       int i;                 /* Loop counter */
3786c332cc30Sdrh       sqlite3 *db = pParse->db;  /* The database connection */
378712ffee8cSdrh       u8 enc = ENC(db);      /* The text encoding used by this database */
378812ffee8cSdrh       CollSeq *pColl = 0;    /* A collating sequence */
378917435752Sdrh 
379067a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
3791eda079cdSdrh       if( ExprHasProperty(pExpr, EP_WinFunc) ){
3792eda079cdSdrh         return pExpr->y.pWin->regResult;
379386fb6e17Sdan       }
379467a9b8edSdan #endif
379586fb6e17Sdan 
37961e9b53f9Sdrh       if( ConstFactorOk(pParse) && sqlite3ExprIsConstantNotJoin(pExpr) ){
379749c5ab24Sdrh         /* SQL functions can be expensive. So try to move constant functions
3798ad879ffdSdrh         ** out of the inner loop, even if that means an extra OP_Copy. */
3799ad879ffdSdrh         return sqlite3ExprCodeAtInit(pParse, pExpr, -1);
38001e9b53f9Sdrh       }
38016ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
3802c5cd1249Sdrh       if( ExprHasProperty(pExpr, EP_TokenOnly) ){
380312ffee8cSdrh         pFarg = 0;
380412ffee8cSdrh       }else{
380512ffee8cSdrh         pFarg = pExpr->x.pList;
380612ffee8cSdrh       }
380712ffee8cSdrh       nFarg = pFarg ? pFarg->nExpr : 0;
380833e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
380933e619fcSdrh       zId = pExpr->u.zToken;
381080738d9cSdrh       pDef = sqlite3FindFunction(db, zId, nFarg, enc, 0);
3811cc15313cSdrh #ifdef SQLITE_ENABLE_UNKNOWN_SQL_FUNCTION
3812cc15313cSdrh       if( pDef==0 && pParse->explain ){
3813cc15313cSdrh         pDef = sqlite3FindFunction(db, "unknown", nFarg, enc, 0);
3814cc15313cSdrh       }
3815cc15313cSdrh #endif
3816b6e9f7a4Sdan       if( pDef==0 || pDef->xFinalize!=0 ){
381780738d9cSdrh         sqlite3ErrorMsg(pParse, "unknown function: %s()", zId);
3818feb306f5Sdrh         break;
3819feb306f5Sdrh       }
3820ae6bb957Sdrh 
3821ae6bb957Sdrh       /* Attempt a direct implementation of the built-in COALESCE() and
382260ec914cSpeter.d.reid       ** IFNULL() functions.  This avoids unnecessary evaluation of
3823ae6bb957Sdrh       ** arguments past the first non-NULL argument.
3824ae6bb957Sdrh       */
3825d36e1041Sdrh       if( pDef->funcFlags & SQLITE_FUNC_COALESCE ){
3826ec4ccdbcSdrh         int endCoalesce = sqlite3VdbeMakeLabel(pParse);
3827ae6bb957Sdrh         assert( nFarg>=2 );
3828ae6bb957Sdrh         sqlite3ExprCode(pParse, pFarg->a[0].pExpr, target);
3829ae6bb957Sdrh         for(i=1; i<nFarg; i++){
3830ae6bb957Sdrh           sqlite3VdbeAddOp2(v, OP_NotNull, target, endCoalesce);
3831688852abSdrh           VdbeCoverage(v);
3832ae6bb957Sdrh           sqlite3ExprCode(pParse, pFarg->a[i].pExpr, target);
3833ae6bb957Sdrh         }
3834ae6bb957Sdrh         sqlite3VdbeResolveLabel(v, endCoalesce);
3835ae6bb957Sdrh         break;
3836ae6bb957Sdrh       }
3837ae6bb957Sdrh 
3838cca9f3d2Sdrh       /* The UNLIKELY() function is a no-op.  The result is the value
3839cca9f3d2Sdrh       ** of the first argument.
3840cca9f3d2Sdrh       */
3841cca9f3d2Sdrh       if( pDef->funcFlags & SQLITE_FUNC_UNLIKELY ){
3842cca9f3d2Sdrh         assert( nFarg>=1 );
3843c332cc30Sdrh         return sqlite3ExprCodeTarget(pParse, pFarg->a[0].pExpr, target);
3844cca9f3d2Sdrh       }
3845ae6bb957Sdrh 
384654240751Sdrh #ifdef SQLITE_DEBUG
3847a1a523a5Sdrh       /* The AFFINITY() function evaluates to a string that describes
3848a1a523a5Sdrh       ** the type affinity of the argument.  This is used for testing of
3849a1a523a5Sdrh       ** the SQLite type logic.
3850a1a523a5Sdrh       */
3851a1a523a5Sdrh       if( pDef->funcFlags & SQLITE_FUNC_AFFINITY ){
3852a1a523a5Sdrh         const char *azAff[] = { "blob", "text", "numeric", "integer", "real" };
3853a1a523a5Sdrh         char aff;
3854a1a523a5Sdrh         assert( nFarg==1 );
3855a1a523a5Sdrh         aff = sqlite3ExprAffinity(pFarg->a[0].pExpr);
3856a1a523a5Sdrh         sqlite3VdbeLoadString(v, target,
385796fb16eeSdrh                 (aff<=SQLITE_AFF_NONE) ? "none" : azAff[aff-SQLITE_AFF_BLOB]);
3858a1a523a5Sdrh         return target;
3859a1a523a5Sdrh       }
386054240751Sdrh #endif
3861a1a523a5Sdrh 
3862d1a01edaSdrh       for(i=0; i<nFarg; i++){
3863d1a01edaSdrh         if( i<32 && sqlite3ExprIsConstant(pFarg->a[i].pExpr) ){
3864693e6719Sdrh           testcase( i==31 );
3865693e6719Sdrh           constMask |= MASKBIT32(i);
3866d1a01edaSdrh         }
3867d1a01edaSdrh         if( (pDef->funcFlags & SQLITE_FUNC_NEEDCOLL)!=0 && !pColl ){
3868d1a01edaSdrh           pColl = sqlite3ExprCollSeq(pParse, pFarg->a[i].pExpr);
3869d1a01edaSdrh         }
3870d1a01edaSdrh       }
387112ffee8cSdrh       if( pFarg ){
3872d1a01edaSdrh         if( constMask ){
3873d1a01edaSdrh           r1 = pParse->nMem+1;
3874d1a01edaSdrh           pParse->nMem += nFarg;
3875d1a01edaSdrh         }else{
387612ffee8cSdrh           r1 = sqlite3GetTempRange(pParse, nFarg);
3877d1a01edaSdrh         }
3878a748fdccSdrh 
3879a748fdccSdrh         /* For length() and typeof() functions with a column argument,
3880a748fdccSdrh         ** set the P5 parameter to the OP_Column opcode to OPFLAG_LENGTHARG
3881a748fdccSdrh         ** or OPFLAG_TYPEOFARG respectively, to avoid unnecessary data
3882a748fdccSdrh         ** loading.
3883a748fdccSdrh         */
3884d36e1041Sdrh         if( (pDef->funcFlags & (SQLITE_FUNC_LENGTH|SQLITE_FUNC_TYPEOF))!=0 ){
38854e245a4cSdrh           u8 exprOp;
3886a748fdccSdrh           assert( nFarg==1 );
3887a748fdccSdrh           assert( pFarg->a[0].pExpr!=0 );
38884e245a4cSdrh           exprOp = pFarg->a[0].pExpr->op;
38894e245a4cSdrh           if( exprOp==TK_COLUMN || exprOp==TK_AGG_COLUMN ){
3890a748fdccSdrh             assert( SQLITE_FUNC_LENGTH==OPFLAG_LENGTHARG );
3891a748fdccSdrh             assert( SQLITE_FUNC_TYPEOF==OPFLAG_TYPEOFARG );
3892b1fba286Sdrh             testcase( pDef->funcFlags & OPFLAG_LENGTHARG );
3893b1fba286Sdrh             pFarg->a[0].pExpr->op2 =
3894b1fba286Sdrh                   pDef->funcFlags & (OPFLAG_LENGTHARG|OPFLAG_TYPEOFARG);
3895a748fdccSdrh           }
3896a748fdccSdrh         }
3897a748fdccSdrh 
38985579d59fSdrh         sqlite3ExprCodeExprList(pParse, pFarg, r1, 0,
3899d1a01edaSdrh                                 SQLITE_ECEL_DUP|SQLITE_ECEL_FACTOR);
3900892d3179Sdrh       }else{
390112ffee8cSdrh         r1 = 0;
3902892d3179Sdrh       }
3903b7f6f68fSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
3904a43fa227Sdrh       /* Possibly overload the function if the first argument is
3905a43fa227Sdrh       ** a virtual table column.
3906a43fa227Sdrh       **
3907a43fa227Sdrh       ** For infix functions (LIKE, GLOB, REGEXP, and MATCH) use the
3908a43fa227Sdrh       ** second argument, not the first, as the argument to test to
3909a43fa227Sdrh       ** see if it is a column in a virtual table.  This is done because
3910a43fa227Sdrh       ** the left operand of infix functions (the operand we want to
3911a43fa227Sdrh       ** control overloading) ends up as the second argument to the
3912a43fa227Sdrh       ** function.  The expression "A glob B" is equivalent to
3913a43fa227Sdrh       ** "glob(B,A).  We want to use the A in "A glob B" to test
3914a43fa227Sdrh       ** for function overloading.  But we use the B term in "glob(B,A)".
3915a43fa227Sdrh       */
391659155065Sdrh       if( nFarg>=2 && ExprHasProperty(pExpr, EP_InfixFunc) ){
391712ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[1].pExpr);
391812ffee8cSdrh       }else if( nFarg>0 ){
391912ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[0].pExpr);
3920b7f6f68fSdrh       }
3921b7f6f68fSdrh #endif
3922d36e1041Sdrh       if( pDef->funcFlags & SQLITE_FUNC_NEEDCOLL ){
39238b213899Sdrh         if( !pColl ) pColl = db->pDfltColl;
392466a5167bSdrh         sqlite3VdbeAddOp4(v, OP_CollSeq, 0, 0, 0, (char *)pColl, P4_COLLSEQ);
3925682f68b0Sdanielk1977       }
3926092457b1Sdrh #ifdef SQLITE_ENABLE_OFFSET_SQL_FUNC
3927092457b1Sdrh       if( pDef->funcFlags & SQLITE_FUNC_OFFSET ){
39282fc865c1Sdrh         Expr *pArg = pFarg->a[0].pExpr;
39292fc865c1Sdrh         if( pArg->op==TK_COLUMN ){
3930092457b1Sdrh           sqlite3VdbeAddOp3(v, OP_Offset, pArg->iTable, pArg->iColumn, target);
39312fc865c1Sdrh         }else{
39322fc865c1Sdrh           sqlite3VdbeAddOp2(v, OP_Null, 0, target);
39332fc865c1Sdrh         }
3934092457b1Sdrh       }else
3935092457b1Sdrh #endif
3936092457b1Sdrh       {
39373e34eabcSdrh         sqlite3VdbeAddOp4(v, pParse->iSelfTab ? OP_PureFunc0 : OP_Function0,
39383e34eabcSdrh                           constMask, r1, target, (char*)pDef, P4_FUNCDEF);
393912ffee8cSdrh         sqlite3VdbeChangeP5(v, (u8)nFarg);
39402fc865c1Sdrh       }
3941d1a01edaSdrh       if( nFarg && constMask==0 ){
394212ffee8cSdrh         sqlite3ReleaseTempRange(pParse, r1, nFarg);
39432dcef11bSdrh       }
3944c332cc30Sdrh       return target;
39456ec2733bSdrh     }
3946fe2093d7Sdrh #ifndef SQLITE_OMIT_SUBQUERY
3947fe2093d7Sdrh     case TK_EXISTS:
394819a775c2Sdrh     case TK_SELECT: {
39498da209b1Sdan       int nCol;
3950c5499befSdrh       testcase( op==TK_EXISTS );
3951c5499befSdrh       testcase( op==TK_SELECT );
39528da209b1Sdan       if( op==TK_SELECT && (nCol = pExpr->x.pSelect->pEList->nExpr)!=1 ){
39538da209b1Sdan         sqlite3SubselectError(pParse, nCol, 1);
39548da209b1Sdan       }else{
395585bcdce2Sdrh         return sqlite3CodeSubselect(pParse, pExpr);
39568da209b1Sdan       }
395719a775c2Sdrh       break;
395819a775c2Sdrh     }
3959fc7f27b9Sdrh     case TK_SELECT_COLUMN: {
3960966e2911Sdrh       int n;
3961fc7f27b9Sdrh       if( pExpr->pLeft->iTable==0 ){
396285bcdce2Sdrh         pExpr->pLeft->iTable = sqlite3CodeSubselect(pParse, pExpr->pLeft);
3963fc7f27b9Sdrh       }
3964966e2911Sdrh       assert( pExpr->iTable==0 || pExpr->pLeft->op==TK_SELECT );
3965554a9dc7Sdrh       if( pExpr->iTable!=0
3966966e2911Sdrh        && pExpr->iTable!=(n = sqlite3ExprVectorSize(pExpr->pLeft))
3967966e2911Sdrh       ){
3968966e2911Sdrh         sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
3969966e2911Sdrh                                 pExpr->iTable, n);
3970966e2911Sdrh       }
3971c332cc30Sdrh       return pExpr->pLeft->iTable + pExpr->iColumn;
3972fc7f27b9Sdrh     }
3973fef5208cSdrh     case TK_IN: {
3974ec4ccdbcSdrh       int destIfFalse = sqlite3VdbeMakeLabel(pParse);
3975ec4ccdbcSdrh       int destIfNull = sqlite3VdbeMakeLabel(pParse);
3976e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3977e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
397866ba23ceSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
3979e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
3980e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_AddImm, target, 0);
3981e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfNull);
3982c332cc30Sdrh       return target;
3983fef5208cSdrh     }
3984e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
3985e3365e6cSdrh 
3986e3365e6cSdrh 
39872dcef11bSdrh     /*
39882dcef11bSdrh     **    x BETWEEN y AND z
39892dcef11bSdrh     **
39902dcef11bSdrh     ** This is equivalent to
39912dcef11bSdrh     **
39922dcef11bSdrh     **    x>=y AND x<=z
39932dcef11bSdrh     **
39942dcef11bSdrh     ** X is stored in pExpr->pLeft.
39952dcef11bSdrh     ** Y is stored in pExpr->pList->a[0].pExpr.
39962dcef11bSdrh     ** Z is stored in pExpr->pList->a[1].pExpr.
39972dcef11bSdrh     */
3998fef5208cSdrh     case TK_BETWEEN: {
399971c57db0Sdan       exprCodeBetween(pParse, pExpr, target, 0, 0);
4000c332cc30Sdrh       return target;
4001fef5208cSdrh     }
400294fa9c41Sdrh     case TK_SPAN:
4003ae80ddeaSdrh     case TK_COLLATE:
40044f07e5fbSdrh     case TK_UPLUS: {
40051efa8023Sdrh       pExpr = pExpr->pLeft;
400659ee43a7Sdrh       goto expr_code_doover; /* 2018-04-28: Prevent deep recursion. OSSFuzz. */
4007a2e00042Sdrh     }
40082dcef11bSdrh 
4009165921a7Sdan     case TK_TRIGGER: {
401065a7cd16Sdan       /* If the opcode is TK_TRIGGER, then the expression is a reference
401165a7cd16Sdan       ** to a column in the new.* or old.* pseudo-tables available to
401265a7cd16Sdan       ** trigger programs. In this case Expr.iTable is set to 1 for the
401365a7cd16Sdan       ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
401465a7cd16Sdan       ** is set to the column of the pseudo-table to read, or to -1 to
401565a7cd16Sdan       ** read the rowid field.
401665a7cd16Sdan       **
401765a7cd16Sdan       ** The expression is implemented using an OP_Param opcode. The p1
401865a7cd16Sdan       ** parameter is set to 0 for an old.rowid reference, or to (i+1)
401965a7cd16Sdan       ** to reference another column of the old.* pseudo-table, where
402065a7cd16Sdan       ** i is the index of the column. For a new.rowid reference, p1 is
402165a7cd16Sdan       ** set to (n+1), where n is the number of columns in each pseudo-table.
402265a7cd16Sdan       ** For a reference to any other column in the new.* pseudo-table, p1
402365a7cd16Sdan       ** is set to (n+2+i), where n and i are as defined previously. For
402465a7cd16Sdan       ** example, if the table on which triggers are being fired is
402565a7cd16Sdan       ** declared as:
402665a7cd16Sdan       **
402765a7cd16Sdan       **   CREATE TABLE t1(a, b);
402865a7cd16Sdan       **
402965a7cd16Sdan       ** Then p1 is interpreted as follows:
403065a7cd16Sdan       **
403165a7cd16Sdan       **   p1==0   ->    old.rowid     p1==3   ->    new.rowid
403265a7cd16Sdan       **   p1==1   ->    old.a         p1==4   ->    new.a
403365a7cd16Sdan       **   p1==2   ->    old.b         p1==5   ->    new.b
403465a7cd16Sdan       */
4035eda079cdSdrh       Table *pTab = pExpr->y.pTab;
403665a7cd16Sdan       int p1 = pExpr->iTable * (pTab->nCol+1) + 1 + pExpr->iColumn;
403765a7cd16Sdan 
403865a7cd16Sdan       assert( pExpr->iTable==0 || pExpr->iTable==1 );
403965a7cd16Sdan       assert( pExpr->iColumn>=-1 && pExpr->iColumn<pTab->nCol );
404065a7cd16Sdan       assert( pTab->iPKey<0 || pExpr->iColumn!=pTab->iPKey );
404165a7cd16Sdan       assert( p1>=0 && p1<(pTab->nCol*2+2) );
404265a7cd16Sdan 
404365a7cd16Sdan       sqlite3VdbeAddOp2(v, OP_Param, p1, target);
4044896494e8Sdrh       VdbeComment((v, "r[%d]=%s.%s", target,
4045165921a7Sdan         (pExpr->iTable ? "new" : "old"),
4046eda079cdSdrh         (pExpr->iColumn<0 ? "rowid" : pExpr->y.pTab->aCol[pExpr->iColumn].zName)
4047165921a7Sdan       ));
404865a7cd16Sdan 
404944dbca83Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
405065a7cd16Sdan       /* If the column has REAL affinity, it may currently be stored as an
4051113762a2Sdrh       ** integer. Use OP_RealAffinity to make sure it is really real.
4052113762a2Sdrh       **
4053113762a2Sdrh       ** EVIDENCE-OF: R-60985-57662 SQLite will convert the value back to
4054113762a2Sdrh       ** floating point when extracting it from the record.  */
40552832ad42Sdan       if( pExpr->iColumn>=0
40562832ad42Sdan        && pTab->aCol[pExpr->iColumn].affinity==SQLITE_AFF_REAL
40572832ad42Sdan       ){
40582832ad42Sdan         sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
40592832ad42Sdan       }
406044dbca83Sdrh #endif
4061165921a7Sdan       break;
4062165921a7Sdan     }
4063165921a7Sdan 
406471c57db0Sdan     case TK_VECTOR: {
4065e835bc12Sdrh       sqlite3ErrorMsg(pParse, "row value misused");
406671c57db0Sdan       break;
406771c57db0Sdan     }
406871c57db0Sdan 
40699e9a67adSdrh     /* TK_IF_NULL_ROW Expr nodes are inserted ahead of expressions
40709e9a67adSdrh     ** that derive from the right-hand table of a LEFT JOIN.  The
40719e9a67adSdrh     ** Expr.iTable value is the table number for the right-hand table.
40729e9a67adSdrh     ** The expression is only evaluated if that table is not currently
40739e9a67adSdrh     ** on a LEFT JOIN NULL row.
40749e9a67adSdrh     */
407531d6fd55Sdrh     case TK_IF_NULL_ROW: {
407631d6fd55Sdrh       int addrINR;
40779e9a67adSdrh       u8 okConstFactor = pParse->okConstFactor;
407831d6fd55Sdrh       addrINR = sqlite3VdbeAddOp1(v, OP_IfNullRow, pExpr->iTable);
40799e9a67adSdrh       /* Temporarily disable factoring of constant expressions, since
40809e9a67adSdrh       ** even though expressions may appear to be constant, they are not
40819e9a67adSdrh       ** really constant because they originate from the right-hand side
40829e9a67adSdrh       ** of a LEFT JOIN. */
40839e9a67adSdrh       pParse->okConstFactor = 0;
408431d6fd55Sdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
40859e9a67adSdrh       pParse->okConstFactor = okConstFactor;
408631d6fd55Sdrh       sqlite3VdbeJumpHere(v, addrINR);
408731d6fd55Sdrh       sqlite3VdbeChangeP3(v, addrINR, inReg);
408831d6fd55Sdrh       break;
408931d6fd55Sdrh     }
409031d6fd55Sdrh 
40912dcef11bSdrh     /*
40922dcef11bSdrh     ** Form A:
40932dcef11bSdrh     **   CASE x WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
40942dcef11bSdrh     **
40952dcef11bSdrh     ** Form B:
40962dcef11bSdrh     **   CASE WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
40972dcef11bSdrh     **
40982dcef11bSdrh     ** Form A is can be transformed into the equivalent form B as follows:
40992dcef11bSdrh     **   CASE WHEN x=e1 THEN r1 WHEN x=e2 THEN r2 ...
41002dcef11bSdrh     **        WHEN x=eN THEN rN ELSE y END
41012dcef11bSdrh     **
41022dcef11bSdrh     ** X (if it exists) is in pExpr->pLeft.
4103c5cd1249Sdrh     ** Y is in the last element of pExpr->x.pList if pExpr->x.pList->nExpr is
4104c5cd1249Sdrh     ** odd.  The Y is also optional.  If the number of elements in x.pList
4105c5cd1249Sdrh     ** is even, then Y is omitted and the "otherwise" result is NULL.
41062dcef11bSdrh     ** Ei is in pExpr->pList->a[i*2] and Ri is pExpr->pList->a[i*2+1].
41072dcef11bSdrh     **
41082dcef11bSdrh     ** The result of the expression is the Ri for the first matching Ei,
41092dcef11bSdrh     ** or if there is no matching Ei, the ELSE term Y, or if there is
41102dcef11bSdrh     ** no ELSE term, NULL.
41112dcef11bSdrh     */
411233cd4909Sdrh     default: assert( op==TK_CASE ); {
41132dcef11bSdrh       int endLabel;                     /* GOTO label for end of CASE stmt */
41142dcef11bSdrh       int nextCase;                     /* GOTO label for next WHEN clause */
41152dcef11bSdrh       int nExpr;                        /* 2x number of WHEN terms */
41162dcef11bSdrh       int i;                            /* Loop counter */
41172dcef11bSdrh       ExprList *pEList;                 /* List of WHEN terms */
41182dcef11bSdrh       struct ExprList_item *aListelem;  /* Array of WHEN terms */
41192dcef11bSdrh       Expr opCompare;                   /* The X==Ei expression */
41202dcef11bSdrh       Expr *pX;                         /* The X expression */
41211bd10f8aSdrh       Expr *pTest = 0;                  /* X==Ei (form A) or just Ei (form B) */
41228b65e591Sdan       Expr *pDel = 0;
41238b65e591Sdan       sqlite3 *db = pParse->db;
412417a7f8ddSdrh 
41256ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) && pExpr->x.pList );
41266ab3a2ecSdanielk1977       assert(pExpr->x.pList->nExpr > 0);
41276ab3a2ecSdanielk1977       pEList = pExpr->x.pList;
4128be5c89acSdrh       aListelem = pEList->a;
4129be5c89acSdrh       nExpr = pEList->nExpr;
4130ec4ccdbcSdrh       endLabel = sqlite3VdbeMakeLabel(pParse);
41312dcef11bSdrh       if( (pX = pExpr->pLeft)!=0 ){
41328b65e591Sdan         pDel = sqlite3ExprDup(db, pX, 0);
41338b65e591Sdan         if( db->mallocFailed ){
41348b65e591Sdan           sqlite3ExprDelete(db, pDel);
41358b65e591Sdan           break;
41368b65e591Sdan         }
413733cd4909Sdrh         testcase( pX->op==TK_COLUMN );
41388b65e591Sdan         exprToRegister(pDel, exprCodeVector(pParse, pDel, &regFree1));
4139c5499befSdrh         testcase( regFree1==0 );
4140abb9d5f1Sdrh         memset(&opCompare, 0, sizeof(opCompare));
41412dcef11bSdrh         opCompare.op = TK_EQ;
41428b65e591Sdan         opCompare.pLeft = pDel;
41432dcef11bSdrh         pTest = &opCompare;
41448b1db07fSdrh         /* Ticket b351d95f9cd5ef17e9d9dbae18f5ca8611190001:
41458b1db07fSdrh         ** The value in regFree1 might get SCopy-ed into the file result.
41468b1db07fSdrh         ** So make sure that the regFree1 register is not reused for other
41478b1db07fSdrh         ** purposes and possibly overwritten.  */
41488b1db07fSdrh         regFree1 = 0;
4149cce7d176Sdrh       }
4150c5cd1249Sdrh       for(i=0; i<nExpr-1; i=i+2){
41512dcef11bSdrh         if( pX ){
41521bd10f8aSdrh           assert( pTest!=0 );
41532dcef11bSdrh           opCompare.pRight = aListelem[i].pExpr;
4154f5905aa7Sdrh         }else{
41552dcef11bSdrh           pTest = aListelem[i].pExpr;
415617a7f8ddSdrh         }
4157ec4ccdbcSdrh         nextCase = sqlite3VdbeMakeLabel(pParse);
415833cd4909Sdrh         testcase( pTest->op==TK_COLUMN );
41592dcef11bSdrh         sqlite3ExprIfFalse(pParse, pTest, nextCase, SQLITE_JUMPIFNULL);
4160c5499befSdrh         testcase( aListelem[i+1].pExpr->op==TK_COLUMN );
41619de221dfSdrh         sqlite3ExprCode(pParse, aListelem[i+1].pExpr, target);
4162076e85f5Sdrh         sqlite3VdbeGoto(v, endLabel);
41632dcef11bSdrh         sqlite3VdbeResolveLabel(v, nextCase);
4164f570f011Sdrh       }
4165c5cd1249Sdrh       if( (nExpr&1)!=0 ){
4166c5cd1249Sdrh         sqlite3ExprCode(pParse, pEList->a[nExpr-1].pExpr, target);
416717a7f8ddSdrh       }else{
41689de221dfSdrh         sqlite3VdbeAddOp2(v, OP_Null, 0, target);
416917a7f8ddSdrh       }
41708b65e591Sdan       sqlite3ExprDelete(db, pDel);
41712dcef11bSdrh       sqlite3VdbeResolveLabel(v, endLabel);
41726f34903eSdanielk1977       break;
41736f34903eSdanielk1977     }
41745338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_TRIGGER
41756f34903eSdanielk1977     case TK_RAISE: {
41761194904bSdrh       assert( pExpr->affExpr==OE_Rollback
41771194904bSdrh            || pExpr->affExpr==OE_Abort
41781194904bSdrh            || pExpr->affExpr==OE_Fail
41791194904bSdrh            || pExpr->affExpr==OE_Ignore
4180165921a7Sdan       );
4181e0af83acSdan       if( !pParse->pTriggerTab ){
4182e0af83acSdan         sqlite3ErrorMsg(pParse,
4183e0af83acSdan                        "RAISE() may only be used within a trigger-program");
4184e0af83acSdan         return 0;
4185e0af83acSdan       }
41861194904bSdrh       if( pExpr->affExpr==OE_Abort ){
4187e0af83acSdan         sqlite3MayAbort(pParse);
4188e0af83acSdan       }
418933e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
41901194904bSdrh       if( pExpr->affExpr==OE_Ignore ){
4191e0af83acSdan         sqlite3VdbeAddOp4(
4192e0af83acSdan             v, OP_Halt, SQLITE_OK, OE_Ignore, 0, pExpr->u.zToken,0);
4193688852abSdrh         VdbeCoverage(v);
4194e0af83acSdan       }else{
4195433dccfbSdrh         sqlite3HaltConstraint(pParse, SQLITE_CONSTRAINT_TRIGGER,
41961194904bSdrh                               pExpr->affExpr, pExpr->u.zToken, 0, 0);
4197e0af83acSdan       }
4198e0af83acSdan 
4199ffe07b2dSdrh       break;
420017a7f8ddSdrh     }
42015338a5f7Sdanielk1977 #endif
4202ffe07b2dSdrh   }
42032dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
42042dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
42052dcef11bSdrh   return inReg;
42065b6afba9Sdrh }
42072dcef11bSdrh 
42082dcef11bSdrh /*
4209d1a01edaSdrh ** Factor out the code of the given expression to initialization time.
42101e9b53f9Sdrh **
4211ad879ffdSdrh ** If regDest>=0 then the result is always stored in that register and the
4212ad879ffdSdrh ** result is not reusable.  If regDest<0 then this routine is free to
4213ad879ffdSdrh ** store the value whereever it wants.  The register where the expression
4214ad879ffdSdrh ** is stored is returned.  When regDest<0, two identical expressions will
4215ad879ffdSdrh ** code to the same register.
4216d1a01edaSdrh */
42171e9b53f9Sdrh int sqlite3ExprCodeAtInit(
4218d673cddaSdrh   Parse *pParse,    /* Parsing context */
4219d673cddaSdrh   Expr *pExpr,      /* The expression to code when the VDBE initializes */
4220ad879ffdSdrh   int regDest       /* Store the value in this register */
4221d673cddaSdrh ){
4222d1a01edaSdrh   ExprList *p;
4223d9f158e7Sdrh   assert( ConstFactorOk(pParse) );
4224d1a01edaSdrh   p = pParse->pConstExpr;
4225ad879ffdSdrh   if( regDest<0 && p ){
42261e9b53f9Sdrh     struct ExprList_item *pItem;
42271e9b53f9Sdrh     int i;
42281e9b53f9Sdrh     for(pItem=p->a, i=p->nExpr; i>0; pItem++, i--){
42295aa550cfSdan       if( pItem->reusable && sqlite3ExprCompare(0,pItem->pExpr,pExpr,-1)==0 ){
42301e9b53f9Sdrh         return pItem->u.iConstExprReg;
42311e9b53f9Sdrh       }
42321e9b53f9Sdrh     }
42331e9b53f9Sdrh   }
4234d1a01edaSdrh   pExpr = sqlite3ExprDup(pParse->db, pExpr, 0);
4235d1a01edaSdrh   p = sqlite3ExprListAppend(pParse, p, pExpr);
4236d673cddaSdrh   if( p ){
4237d673cddaSdrh      struct ExprList_item *pItem = &p->a[p->nExpr-1];
4238ad879ffdSdrh      pItem->reusable = regDest<0;
4239ad879ffdSdrh      if( regDest<0 ) regDest = ++pParse->nMem;
4240d673cddaSdrh      pItem->u.iConstExprReg = regDest;
4241d673cddaSdrh   }
4242d1a01edaSdrh   pParse->pConstExpr = p;
42431e9b53f9Sdrh   return regDest;
4244d1a01edaSdrh }
4245d1a01edaSdrh 
4246d1a01edaSdrh /*
42472dcef11bSdrh ** Generate code to evaluate an expression and store the results
42482dcef11bSdrh ** into a register.  Return the register number where the results
42492dcef11bSdrh ** are stored.
42502dcef11bSdrh **
42512dcef11bSdrh ** If the register is a temporary register that can be deallocated,
4252678ccce8Sdrh ** then write its number into *pReg.  If the result register is not
42532dcef11bSdrh ** a temporary, then set *pReg to zero.
4254f30a969bSdrh **
4255f30a969bSdrh ** If pExpr is a constant, then this routine might generate this
4256f30a969bSdrh ** code to fill the register in the initialization section of the
4257f30a969bSdrh ** VDBE program, in order to factor it out of the evaluation loop.
42582dcef11bSdrh */
42592dcef11bSdrh int sqlite3ExprCodeTemp(Parse *pParse, Expr *pExpr, int *pReg){
4260f30a969bSdrh   int r2;
42610d950af3Sdrh   pExpr = sqlite3ExprSkipCollateAndLikely(pExpr);
4262d9f158e7Sdrh   if( ConstFactorOk(pParse)
4263f30a969bSdrh    && pExpr->op!=TK_REGISTER
4264f30a969bSdrh    && sqlite3ExprIsConstantNotJoin(pExpr)
4265f30a969bSdrh   ){
4266f30a969bSdrh     *pReg  = 0;
4267ad879ffdSdrh     r2 = sqlite3ExprCodeAtInit(pParse, pExpr, -1);
4268f30a969bSdrh   }else{
42692dcef11bSdrh     int r1 = sqlite3GetTempReg(pParse);
4270f30a969bSdrh     r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
42712dcef11bSdrh     if( r2==r1 ){
42722dcef11bSdrh       *pReg = r1;
42732dcef11bSdrh     }else{
42742dcef11bSdrh       sqlite3ReleaseTempReg(pParse, r1);
42752dcef11bSdrh       *pReg = 0;
42762dcef11bSdrh     }
4277f30a969bSdrh   }
42782dcef11bSdrh   return r2;
42792dcef11bSdrh }
42802dcef11bSdrh 
42812dcef11bSdrh /*
42822dcef11bSdrh ** Generate code that will evaluate expression pExpr and store the
42832dcef11bSdrh ** results in register target.  The results are guaranteed to appear
42842dcef11bSdrh ** in register target.
42852dcef11bSdrh */
428605a86c5cSdrh void sqlite3ExprCode(Parse *pParse, Expr *pExpr, int target){
42879cbf3425Sdrh   int inReg;
42889cbf3425Sdrh 
42899cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
4290ebc16717Sdrh   if( pExpr && pExpr->op==TK_REGISTER ){
4291ebc16717Sdrh     sqlite3VdbeAddOp2(pParse->pVdbe, OP_Copy, pExpr->iTable, target);
4292ebc16717Sdrh   }else{
42939cbf3425Sdrh     inReg = sqlite3ExprCodeTarget(pParse, pExpr, target);
42941c75c9d7Sdrh     assert( pParse->pVdbe!=0 || pParse->db->mallocFailed );
42950e359b30Sdrh     if( inReg!=target && pParse->pVdbe ){
42969cbf3425Sdrh       sqlite3VdbeAddOp2(pParse->pVdbe, OP_SCopy, inReg, target);
429717a7f8ddSdrh     }
4298ebc16717Sdrh   }
4299cce7d176Sdrh }
4300cce7d176Sdrh 
4301cce7d176Sdrh /*
43021c75c9d7Sdrh ** Make a transient copy of expression pExpr and then code it using
43031c75c9d7Sdrh ** sqlite3ExprCode().  This routine works just like sqlite3ExprCode()
43041c75c9d7Sdrh ** except that the input expression is guaranteed to be unchanged.
43051c75c9d7Sdrh */
43061c75c9d7Sdrh void sqlite3ExprCodeCopy(Parse *pParse, Expr *pExpr, int target){
43071c75c9d7Sdrh   sqlite3 *db = pParse->db;
43081c75c9d7Sdrh   pExpr = sqlite3ExprDup(db, pExpr, 0);
43091c75c9d7Sdrh   if( !db->mallocFailed ) sqlite3ExprCode(pParse, pExpr, target);
43101c75c9d7Sdrh   sqlite3ExprDelete(db, pExpr);
43111c75c9d7Sdrh }
43121c75c9d7Sdrh 
43131c75c9d7Sdrh /*
431405a86c5cSdrh ** Generate code that will evaluate expression pExpr and store the
431505a86c5cSdrh ** results in register target.  The results are guaranteed to appear
431605a86c5cSdrh ** in register target.  If the expression is constant, then this routine
431705a86c5cSdrh ** might choose to code the expression at initialization time.
431805a86c5cSdrh */
431905a86c5cSdrh void sqlite3ExprCodeFactorable(Parse *pParse, Expr *pExpr, int target){
4320b8b06690Sdrh   if( pParse->okConstFactor && sqlite3ExprIsConstantNotJoin(pExpr) ){
4321ad879ffdSdrh     sqlite3ExprCodeAtInit(pParse, pExpr, target);
432205a86c5cSdrh   }else{
432305a86c5cSdrh     sqlite3ExprCode(pParse, pExpr, target);
432405a86c5cSdrh   }
4325cce7d176Sdrh }
4326cce7d176Sdrh 
4327cce7d176Sdrh /*
432860ec914cSpeter.d.reid ** Generate code that evaluates the given expression and puts the result
4329de4fcfddSdrh ** in register target.
433025303780Sdrh **
43312dcef11bSdrh ** Also make a copy of the expression results into another "cache" register
43322dcef11bSdrh ** and modify the expression so that the next time it is evaluated,
43332dcef11bSdrh ** the result is a copy of the cache register.
43342dcef11bSdrh **
43352dcef11bSdrh ** This routine is used for expressions that are used multiple
43362dcef11bSdrh ** times.  They are evaluated once and the results of the expression
43372dcef11bSdrh ** are reused.
433825303780Sdrh */
433905a86c5cSdrh void sqlite3ExprCodeAndCache(Parse *pParse, Expr *pExpr, int target){
434025303780Sdrh   Vdbe *v = pParse->pVdbe;
434125303780Sdrh   int iMem;
434205a86c5cSdrh 
434305a86c5cSdrh   assert( target>0 );
434405a86c5cSdrh   assert( pExpr->op!=TK_REGISTER );
434505a86c5cSdrh   sqlite3ExprCode(pParse, pExpr, target);
43462dcef11bSdrh   iMem = ++pParse->nMem;
434705a86c5cSdrh   sqlite3VdbeAddOp2(v, OP_Copy, target, iMem);
4348a4c3c87eSdrh   exprToRegister(pExpr, iMem);
434925303780Sdrh }
43507e02e5e6Sdrh 
4351678ccce8Sdrh /*
4352268380caSdrh ** Generate code that pushes the value of every element of the given
43539cbf3425Sdrh ** expression list into a sequence of registers beginning at target.
4354268380caSdrh **
43553df6c3b1Sdrh ** Return the number of elements evaluated.  The number returned will
43563df6c3b1Sdrh ** usually be pList->nExpr but might be reduced if SQLITE_ECEL_OMITREF
43573df6c3b1Sdrh ** is defined.
4358d1a01edaSdrh **
4359d1a01edaSdrh ** The SQLITE_ECEL_DUP flag prevents the arguments from being
4360d1a01edaSdrh ** filled using OP_SCopy.  OP_Copy must be used instead.
4361d1a01edaSdrh **
4362d1a01edaSdrh ** The SQLITE_ECEL_FACTOR argument allows constant arguments to be
4363d1a01edaSdrh ** factored out into initialization code.
4364b0df9634Sdrh **
4365b0df9634Sdrh ** The SQLITE_ECEL_REF flag means that expressions in the list with
4366b0df9634Sdrh ** ExprList.a[].u.x.iOrderByCol>0 have already been evaluated and stored
4367b0df9634Sdrh ** in registers at srcReg, and so the value can be copied from there.
43683df6c3b1Sdrh ** If SQLITE_ECEL_OMITREF is also set, then the values with u.x.iOrderByCol>0
43693df6c3b1Sdrh ** are simply omitted rather than being copied from srcReg.
4370268380caSdrh */
43714adee20fSdanielk1977 int sqlite3ExprCodeExprList(
4372268380caSdrh   Parse *pParse,     /* Parsing context */
4373389a1adbSdrh   ExprList *pList,   /* The expression list to be coded */
4374191b54cbSdrh   int target,        /* Where to write results */
43755579d59fSdrh   int srcReg,        /* Source registers if SQLITE_ECEL_REF */
4376d1a01edaSdrh   u8 flags           /* SQLITE_ECEL_* flags */
4377268380caSdrh ){
4378268380caSdrh   struct ExprList_item *pItem;
43795579d59fSdrh   int i, j, n;
4380d1a01edaSdrh   u8 copyOp = (flags & SQLITE_ECEL_DUP) ? OP_Copy : OP_SCopy;
43815579d59fSdrh   Vdbe *v = pParse->pVdbe;
43829d8b3072Sdrh   assert( pList!=0 );
43839cbf3425Sdrh   assert( target>0 );
4384d81a142bSdrh   assert( pParse->pVdbe!=0 );  /* Never gets this far otherwise */
4385268380caSdrh   n = pList->nExpr;
4386d9f158e7Sdrh   if( !ConstFactorOk(pParse) ) flags &= ~SQLITE_ECEL_FACTOR;
4387191b54cbSdrh   for(pItem=pList->a, i=0; i<n; i++, pItem++){
43887445ffe2Sdrh     Expr *pExpr = pItem->pExpr;
438924e25d32Sdan #ifdef SQLITE_ENABLE_SORTER_REFERENCES
439024e25d32Sdan     if( pItem->bSorterRef ){
439124e25d32Sdan       i--;
439224e25d32Sdan       n--;
439324e25d32Sdan     }else
439424e25d32Sdan #endif
4395257c13faSdan     if( (flags & SQLITE_ECEL_REF)!=0 && (j = pItem->u.x.iOrderByCol)>0 ){
4396257c13faSdan       if( flags & SQLITE_ECEL_OMITREF ){
4397257c13faSdan         i--;
4398257c13faSdan         n--;
4399257c13faSdan       }else{
44005579d59fSdrh         sqlite3VdbeAddOp2(v, copyOp, j+srcReg-1, target+i);
4401257c13faSdan       }
4402b8b06690Sdrh     }else if( (flags & SQLITE_ECEL_FACTOR)!=0
4403b8b06690Sdrh            && sqlite3ExprIsConstantNotJoin(pExpr)
4404b8b06690Sdrh     ){
4405ad879ffdSdrh       sqlite3ExprCodeAtInit(pParse, pExpr, target+i);
4406d1a01edaSdrh     }else{
44077445ffe2Sdrh       int inReg = sqlite3ExprCodeTarget(pParse, pExpr, target+i);
4408746fd9ccSdrh       if( inReg!=target+i ){
44094eded604Sdrh         VdbeOp *pOp;
44104eded604Sdrh         if( copyOp==OP_Copy
44114eded604Sdrh          && (pOp=sqlite3VdbeGetOp(v, -1))->opcode==OP_Copy
44124eded604Sdrh          && pOp->p1+pOp->p3+1==inReg
44134eded604Sdrh          && pOp->p2+pOp->p3+1==target+i
44144eded604Sdrh         ){
44154eded604Sdrh           pOp->p3++;
44164eded604Sdrh         }else{
44174eded604Sdrh           sqlite3VdbeAddOp2(v, copyOp, inReg, target+i);
44184eded604Sdrh         }
4419d1a01edaSdrh       }
4420d176611bSdrh     }
4421268380caSdrh   }
4422f9b596ebSdrh   return n;
4423268380caSdrh }
4424268380caSdrh 
4425268380caSdrh /*
442636c563a2Sdrh ** Generate code for a BETWEEN operator.
442736c563a2Sdrh **
442836c563a2Sdrh **    x BETWEEN y AND z
442936c563a2Sdrh **
443036c563a2Sdrh ** The above is equivalent to
443136c563a2Sdrh **
443236c563a2Sdrh **    x>=y AND x<=z
443336c563a2Sdrh **
443436c563a2Sdrh ** Code it as such, taking care to do the common subexpression
443560ec914cSpeter.d.reid ** elimination of x.
443684b19a3dSdrh **
443784b19a3dSdrh ** The xJumpIf parameter determines details:
443884b19a3dSdrh **
443984b19a3dSdrh **    NULL:                   Store the boolean result in reg[dest]
444084b19a3dSdrh **    sqlite3ExprIfTrue:      Jump to dest if true
444184b19a3dSdrh **    sqlite3ExprIfFalse:     Jump to dest if false
444284b19a3dSdrh **
444384b19a3dSdrh ** The jumpIfNull parameter is ignored if xJumpIf is NULL.
444436c563a2Sdrh */
444536c563a2Sdrh static void exprCodeBetween(
444636c563a2Sdrh   Parse *pParse,    /* Parsing and code generating context */
444736c563a2Sdrh   Expr *pExpr,      /* The BETWEEN expression */
444884b19a3dSdrh   int dest,         /* Jump destination or storage location */
444984b19a3dSdrh   void (*xJump)(Parse*,Expr*,int,int), /* Action to take */
445036c563a2Sdrh   int jumpIfNull    /* Take the jump if the BETWEEN is NULL */
445136c563a2Sdrh ){
445236c563a2Sdrh   Expr exprAnd;     /* The AND operator in  x>=y AND x<=z  */
445336c563a2Sdrh   Expr compLeft;    /* The  x>=y  term */
445436c563a2Sdrh   Expr compRight;   /* The  x<=z  term */
4455db45bd5eSdrh   int regFree1 = 0; /* Temporary use register */
44568b65e591Sdan   Expr *pDel = 0;
44578b65e591Sdan   sqlite3 *db = pParse->db;
445884b19a3dSdrh 
445971c57db0Sdan   memset(&compLeft, 0, sizeof(Expr));
446071c57db0Sdan   memset(&compRight, 0, sizeof(Expr));
446171c57db0Sdan   memset(&exprAnd, 0, sizeof(Expr));
4462db45bd5eSdrh 
4463db45bd5eSdrh   assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
44648b65e591Sdan   pDel = sqlite3ExprDup(db, pExpr->pLeft, 0);
44658b65e591Sdan   if( db->mallocFailed==0 ){
446636c563a2Sdrh     exprAnd.op = TK_AND;
446736c563a2Sdrh     exprAnd.pLeft = &compLeft;
446836c563a2Sdrh     exprAnd.pRight = &compRight;
446936c563a2Sdrh     compLeft.op = TK_GE;
44708b65e591Sdan     compLeft.pLeft = pDel;
447136c563a2Sdrh     compLeft.pRight = pExpr->x.pList->a[0].pExpr;
447236c563a2Sdrh     compRight.op = TK_LE;
44738b65e591Sdan     compRight.pLeft = pDel;
447436c563a2Sdrh     compRight.pRight = pExpr->x.pList->a[1].pExpr;
44758b65e591Sdan     exprToRegister(pDel, exprCodeVector(pParse, pDel, &regFree1));
447684b19a3dSdrh     if( xJump ){
447784b19a3dSdrh       xJump(pParse, &exprAnd, dest, jumpIfNull);
447836c563a2Sdrh     }else{
447936fd41e5Sdrh       /* Mark the expression is being from the ON or USING clause of a join
448036fd41e5Sdrh       ** so that the sqlite3ExprCodeTarget() routine will not attempt to move
448136fd41e5Sdrh       ** it into the Parse.pConstExpr list.  We should use a new bit for this,
448236fd41e5Sdrh       ** for clarity, but we are out of bits in the Expr.flags field so we
448336fd41e5Sdrh       ** have to reuse the EP_FromJoin bit.  Bummer. */
44848b65e591Sdan       pDel->flags |= EP_FromJoin;
448571c57db0Sdan       sqlite3ExprCodeTarget(pParse, &exprAnd, dest);
448636c563a2Sdrh     }
4487db45bd5eSdrh     sqlite3ReleaseTempReg(pParse, regFree1);
44888b65e591Sdan   }
44898b65e591Sdan   sqlite3ExprDelete(db, pDel);
449036c563a2Sdrh 
449136c563a2Sdrh   /* Ensure adequate test coverage */
4492db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull==0 && regFree1==0 );
4493db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull==0 && regFree1!=0 );
4494db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull!=0 && regFree1==0 );
4495db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull!=0 && regFree1!=0 );
4496db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1==0 );
4497db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1!=0 );
4498db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1==0 );
4499db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1!=0 );
450084b19a3dSdrh   testcase( xJump==0 );
450136c563a2Sdrh }
450236c563a2Sdrh 
450336c563a2Sdrh /*
4504cce7d176Sdrh ** Generate code for a boolean expression such that a jump is made
4505cce7d176Sdrh ** to the label "dest" if the expression is true but execution
4506cce7d176Sdrh ** continues straight thru if the expression is false.
4507f5905aa7Sdrh **
4508f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false), then
450935573356Sdrh ** take the jump if the jumpIfNull flag is SQLITE_JUMPIFNULL.
4510f2bc013cSdrh **
4511f2bc013cSdrh ** This code depends on the fact that certain token values (ex: TK_EQ)
4512f2bc013cSdrh ** are the same as opcode values (ex: OP_Eq) that implement the corresponding
4513f2bc013cSdrh ** operation.  Special comments in vdbe.c and the mkopcodeh.awk script in
4514f2bc013cSdrh ** the make process cause these values to align.  Assert()s in the code
4515f2bc013cSdrh ** below verify that the numbers are aligned correctly.
4516cce7d176Sdrh */
45174adee20fSdanielk1977 void sqlite3ExprIfTrue(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
4518cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
4519cce7d176Sdrh   int op = 0;
45202dcef11bSdrh   int regFree1 = 0;
45212dcef11bSdrh   int regFree2 = 0;
45222dcef11bSdrh   int r1, r2;
45232dcef11bSdrh 
452435573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
452548864df9Smistachkin   if( NEVER(v==0) )     return;  /* Existence of VDBE checked by caller */
452633cd4909Sdrh   if( NEVER(pExpr==0) ) return;  /* No way this can happen */
4527f2bc013cSdrh   op = pExpr->op;
45287b35a77bSdan   switch( op ){
452917180fcaSdrh     case TK_AND:
453017180fcaSdrh     case TK_OR: {
453117180fcaSdrh       Expr *pAlt = sqlite3ExprSimplifiedAndOr(pExpr);
453217180fcaSdrh       if( pAlt!=pExpr ){
453317180fcaSdrh         sqlite3ExprIfTrue(pParse, pAlt, dest, jumpIfNull);
453417180fcaSdrh       }else if( op==TK_AND ){
4535ec4ccdbcSdrh         int d2 = sqlite3VdbeMakeLabel(pParse);
4536c5499befSdrh         testcase( jumpIfNull==0 );
453717180fcaSdrh         sqlite3ExprIfFalse(pParse, pExpr->pLeft, d2,
453817180fcaSdrh                            jumpIfNull^SQLITE_JUMPIFNULL);
45394adee20fSdanielk1977         sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
45404adee20fSdanielk1977         sqlite3VdbeResolveLabel(v, d2);
454117180fcaSdrh       }else{
4542c5499befSdrh         testcase( jumpIfNull==0 );
45434adee20fSdanielk1977         sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
45444adee20fSdanielk1977         sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
454517180fcaSdrh       }
4546cce7d176Sdrh       break;
4547cce7d176Sdrh     }
4548cce7d176Sdrh     case TK_NOT: {
4549c5499befSdrh       testcase( jumpIfNull==0 );
45504adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
4551cce7d176Sdrh       break;
4552cce7d176Sdrh     }
45538abed7b9Sdrh     case TK_TRUTH: {
455496acafbeSdrh       int isNot;      /* IS NOT TRUE or IS NOT FALSE */
455596acafbeSdrh       int isTrue;     /* IS TRUE or IS NOT TRUE */
4556007c843bSdrh       testcase( jumpIfNull==0 );
45578abed7b9Sdrh       isNot = pExpr->op2==TK_ISNOT;
455896acafbeSdrh       isTrue = sqlite3ExprTruthValue(pExpr->pRight);
455943c4ac8bSdrh       testcase( isTrue && isNot );
456096acafbeSdrh       testcase( !isTrue && isNot );
456143c4ac8bSdrh       if( isTrue ^ isNot ){
45628abed7b9Sdrh         sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
45638abed7b9Sdrh                           isNot ? SQLITE_JUMPIFNULL : 0);
45648abed7b9Sdrh       }else{
45658abed7b9Sdrh         sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
45668abed7b9Sdrh                            isNot ? SQLITE_JUMPIFNULL : 0);
45678abed7b9Sdrh       }
4568007c843bSdrh       break;
4569007c843bSdrh     }
4570de845c2fSdrh     case TK_IS:
4571de845c2fSdrh     case TK_ISNOT:
4572de845c2fSdrh       testcase( op==TK_IS );
4573de845c2fSdrh       testcase( op==TK_ISNOT );
4574de845c2fSdrh       op = (op==TK_IS) ? TK_EQ : TK_NE;
4575de845c2fSdrh       jumpIfNull = SQLITE_NULLEQ;
4576de845c2fSdrh       /* Fall thru */
4577cce7d176Sdrh     case TK_LT:
4578cce7d176Sdrh     case TK_LE:
4579cce7d176Sdrh     case TK_GT:
4580cce7d176Sdrh     case TK_GE:
4581cce7d176Sdrh     case TK_NE:
45820ac65892Sdrh     case TK_EQ: {
4583625015e0Sdan       if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
4584c5499befSdrh       testcase( jumpIfNull==0 );
4585b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4586b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
458735573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
45882dcef11bSdrh                   r1, r2, dest, jumpIfNull);
45897d176105Sdrh       assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
45907d176105Sdrh       assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
45917d176105Sdrh       assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
45927d176105Sdrh       assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
4593de845c2fSdrh       assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4594de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4595de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4596de845c2fSdrh       assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4597de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
4598de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
45996a2fe093Sdrh       testcase( regFree1==0 );
46006a2fe093Sdrh       testcase( regFree2==0 );
46016a2fe093Sdrh       break;
46026a2fe093Sdrh     }
4603cce7d176Sdrh     case TK_ISNULL:
4604cce7d176Sdrh     case TK_NOTNULL: {
46057d176105Sdrh       assert( TK_ISNULL==OP_IsNull );   testcase( op==TK_ISNULL );
46067d176105Sdrh       assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
46072dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
46082dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
46097d176105Sdrh       VdbeCoverageIf(v, op==TK_ISNULL);
46107d176105Sdrh       VdbeCoverageIf(v, op==TK_NOTNULL);
4611c5499befSdrh       testcase( regFree1==0 );
4612cce7d176Sdrh       break;
4613cce7d176Sdrh     }
4614fef5208cSdrh     case TK_BETWEEN: {
46155c03f30aSdrh       testcase( jumpIfNull==0 );
461671c57db0Sdan       exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfTrue, jumpIfNull);
4617fef5208cSdrh       break;
4618fef5208cSdrh     }
4619bb201344Sshaneh #ifndef SQLITE_OMIT_SUBQUERY
4620e3365e6cSdrh     case TK_IN: {
4621ec4ccdbcSdrh       int destIfFalse = sqlite3VdbeMakeLabel(pParse);
4622e3365e6cSdrh       int destIfNull = jumpIfNull ? dest : destIfFalse;
4623e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
4624076e85f5Sdrh       sqlite3VdbeGoto(v, dest);
4625e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
4626e3365e6cSdrh       break;
4627e3365e6cSdrh     }
4628bb201344Sshaneh #endif
4629cce7d176Sdrh     default: {
46307b35a77bSdan     default_expr:
4631ad31727fSdrh       if( ExprAlwaysTrue(pExpr) ){
4632076e85f5Sdrh         sqlite3VdbeGoto(v, dest);
4633ad31727fSdrh       }else if( ExprAlwaysFalse(pExpr) ){
4634991a1985Sdrh         /* No-op */
4635991a1985Sdrh       }else{
46362dcef11bSdrh         r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
46372dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_If, r1, dest, jumpIfNull!=0);
4638688852abSdrh         VdbeCoverage(v);
4639c5499befSdrh         testcase( regFree1==0 );
4640c5499befSdrh         testcase( jumpIfNull==0 );
4641991a1985Sdrh       }
4642cce7d176Sdrh       break;
4643cce7d176Sdrh     }
4644cce7d176Sdrh   }
46452dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
46462dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
4647cce7d176Sdrh }
4648cce7d176Sdrh 
4649cce7d176Sdrh /*
465066b89c8fSdrh ** Generate code for a boolean expression such that a jump is made
4651cce7d176Sdrh ** to the label "dest" if the expression is false but execution
4652cce7d176Sdrh ** continues straight thru if the expression is true.
4653f5905aa7Sdrh **
4654f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false) then
465535573356Sdrh ** jump if jumpIfNull is SQLITE_JUMPIFNULL or fall through if jumpIfNull
465635573356Sdrh ** is 0.
4657cce7d176Sdrh */
46584adee20fSdanielk1977 void sqlite3ExprIfFalse(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
4659cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
4660cce7d176Sdrh   int op = 0;
46612dcef11bSdrh   int regFree1 = 0;
46622dcef11bSdrh   int regFree2 = 0;
46632dcef11bSdrh   int r1, r2;
46642dcef11bSdrh 
466535573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
466648864df9Smistachkin   if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
466733cd4909Sdrh   if( pExpr==0 )    return;
4668f2bc013cSdrh 
4669f2bc013cSdrh   /* The value of pExpr->op and op are related as follows:
4670f2bc013cSdrh   **
4671f2bc013cSdrh   **       pExpr->op            op
4672f2bc013cSdrh   **       ---------          ----------
4673f2bc013cSdrh   **       TK_ISNULL          OP_NotNull
4674f2bc013cSdrh   **       TK_NOTNULL         OP_IsNull
4675f2bc013cSdrh   **       TK_NE              OP_Eq
4676f2bc013cSdrh   **       TK_EQ              OP_Ne
4677f2bc013cSdrh   **       TK_GT              OP_Le
4678f2bc013cSdrh   **       TK_LE              OP_Gt
4679f2bc013cSdrh   **       TK_GE              OP_Lt
4680f2bc013cSdrh   **       TK_LT              OP_Ge
4681f2bc013cSdrh   **
4682f2bc013cSdrh   ** For other values of pExpr->op, op is undefined and unused.
4683f2bc013cSdrh   ** The value of TK_ and OP_ constants are arranged such that we
4684f2bc013cSdrh   ** can compute the mapping above using the following expression.
4685f2bc013cSdrh   ** Assert()s verify that the computation is correct.
4686f2bc013cSdrh   */
4687f2bc013cSdrh   op = ((pExpr->op+(TK_ISNULL&1))^1)-(TK_ISNULL&1);
4688f2bc013cSdrh 
4689f2bc013cSdrh   /* Verify correct alignment of TK_ and OP_ constants
4690f2bc013cSdrh   */
4691f2bc013cSdrh   assert( pExpr->op!=TK_ISNULL || op==OP_NotNull );
4692f2bc013cSdrh   assert( pExpr->op!=TK_NOTNULL || op==OP_IsNull );
4693f2bc013cSdrh   assert( pExpr->op!=TK_NE || op==OP_Eq );
4694f2bc013cSdrh   assert( pExpr->op!=TK_EQ || op==OP_Ne );
4695f2bc013cSdrh   assert( pExpr->op!=TK_LT || op==OP_Ge );
4696f2bc013cSdrh   assert( pExpr->op!=TK_LE || op==OP_Gt );
4697f2bc013cSdrh   assert( pExpr->op!=TK_GT || op==OP_Le );
4698f2bc013cSdrh   assert( pExpr->op!=TK_GE || op==OP_Lt );
4699f2bc013cSdrh 
4700ba00e30aSdan   switch( pExpr->op ){
470117180fcaSdrh     case TK_AND:
470217180fcaSdrh     case TK_OR: {
470317180fcaSdrh       Expr *pAlt = sqlite3ExprSimplifiedAndOr(pExpr);
470417180fcaSdrh       if( pAlt!=pExpr ){
470517180fcaSdrh         sqlite3ExprIfFalse(pParse, pAlt, dest, jumpIfNull);
470617180fcaSdrh       }else if( pExpr->op==TK_AND ){
4707c5499befSdrh         testcase( jumpIfNull==0 );
47084adee20fSdanielk1977         sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
47094adee20fSdanielk1977         sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
471017180fcaSdrh       }else{
4711ec4ccdbcSdrh         int d2 = sqlite3VdbeMakeLabel(pParse);
4712c5499befSdrh         testcase( jumpIfNull==0 );
471317180fcaSdrh         sqlite3ExprIfTrue(pParse, pExpr->pLeft, d2,
471417180fcaSdrh                           jumpIfNull^SQLITE_JUMPIFNULL);
47154adee20fSdanielk1977         sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
47164adee20fSdanielk1977         sqlite3VdbeResolveLabel(v, d2);
471717180fcaSdrh       }
4718cce7d176Sdrh       break;
4719cce7d176Sdrh     }
4720cce7d176Sdrh     case TK_NOT: {
47215c03f30aSdrh       testcase( jumpIfNull==0 );
47224adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
4723cce7d176Sdrh       break;
4724cce7d176Sdrh     }
47258abed7b9Sdrh     case TK_TRUTH: {
472696acafbeSdrh       int isNot;   /* IS NOT TRUE or IS NOT FALSE */
472796acafbeSdrh       int isTrue;  /* IS TRUE or IS NOT TRUE */
47288abed7b9Sdrh       testcase( jumpIfNull==0 );
47298abed7b9Sdrh       isNot = pExpr->op2==TK_ISNOT;
473096acafbeSdrh       isTrue = sqlite3ExprTruthValue(pExpr->pRight);
473143c4ac8bSdrh       testcase( isTrue && isNot );
473296acafbeSdrh       testcase( !isTrue && isNot );
473343c4ac8bSdrh       if( isTrue ^ isNot ){
47348abed7b9Sdrh         /* IS TRUE and IS NOT FALSE */
47358abed7b9Sdrh         sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
47368abed7b9Sdrh                            isNot ? 0 : SQLITE_JUMPIFNULL);
47378abed7b9Sdrh 
47388abed7b9Sdrh       }else{
47398abed7b9Sdrh         /* IS FALSE and IS NOT TRUE */
47408abed7b9Sdrh         sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
47418abed7b9Sdrh                           isNot ? 0 : SQLITE_JUMPIFNULL);
47428abed7b9Sdrh       }
4743007c843bSdrh       break;
4744007c843bSdrh     }
4745de845c2fSdrh     case TK_IS:
4746de845c2fSdrh     case TK_ISNOT:
4747de845c2fSdrh       testcase( pExpr->op==TK_IS );
4748de845c2fSdrh       testcase( pExpr->op==TK_ISNOT );
4749de845c2fSdrh       op = (pExpr->op==TK_IS) ? TK_NE : TK_EQ;
4750de845c2fSdrh       jumpIfNull = SQLITE_NULLEQ;
4751de845c2fSdrh       /* Fall thru */
4752cce7d176Sdrh     case TK_LT:
4753cce7d176Sdrh     case TK_LE:
4754cce7d176Sdrh     case TK_GT:
4755cce7d176Sdrh     case TK_GE:
4756cce7d176Sdrh     case TK_NE:
4757cce7d176Sdrh     case TK_EQ: {
4758625015e0Sdan       if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
4759c5499befSdrh       testcase( jumpIfNull==0 );
4760b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4761b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
476235573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
47632dcef11bSdrh                   r1, r2, dest, jumpIfNull);
47647d176105Sdrh       assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
47657d176105Sdrh       assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
47667d176105Sdrh       assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
47677d176105Sdrh       assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
4768de845c2fSdrh       assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4769de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4770de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4771de845c2fSdrh       assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4772de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
4773de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
47746a2fe093Sdrh       testcase( regFree1==0 );
47756a2fe093Sdrh       testcase( regFree2==0 );
47766a2fe093Sdrh       break;
47776a2fe093Sdrh     }
4778cce7d176Sdrh     case TK_ISNULL:
4779cce7d176Sdrh     case TK_NOTNULL: {
47802dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
47812dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
47827d176105Sdrh       testcase( op==TK_ISNULL );   VdbeCoverageIf(v, op==TK_ISNULL);
47837d176105Sdrh       testcase( op==TK_NOTNULL );  VdbeCoverageIf(v, op==TK_NOTNULL);
4784c5499befSdrh       testcase( regFree1==0 );
4785cce7d176Sdrh       break;
4786cce7d176Sdrh     }
4787fef5208cSdrh     case TK_BETWEEN: {
47885c03f30aSdrh       testcase( jumpIfNull==0 );
478971c57db0Sdan       exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfFalse, jumpIfNull);
4790fef5208cSdrh       break;
4791fef5208cSdrh     }
4792bb201344Sshaneh #ifndef SQLITE_OMIT_SUBQUERY
4793e3365e6cSdrh     case TK_IN: {
4794e3365e6cSdrh       if( jumpIfNull ){
4795e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, dest);
4796e3365e6cSdrh       }else{
4797ec4ccdbcSdrh         int destIfNull = sqlite3VdbeMakeLabel(pParse);
4798e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, destIfNull);
4799e3365e6cSdrh         sqlite3VdbeResolveLabel(v, destIfNull);
4800e3365e6cSdrh       }
4801e3365e6cSdrh       break;
4802e3365e6cSdrh     }
4803bb201344Sshaneh #endif
4804cce7d176Sdrh     default: {
4805ba00e30aSdan     default_expr:
4806ad31727fSdrh       if( ExprAlwaysFalse(pExpr) ){
4807076e85f5Sdrh         sqlite3VdbeGoto(v, dest);
4808ad31727fSdrh       }else if( ExprAlwaysTrue(pExpr) ){
4809991a1985Sdrh         /* no-op */
4810991a1985Sdrh       }else{
48112dcef11bSdrh         r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
48122dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_IfNot, r1, dest, jumpIfNull!=0);
4813688852abSdrh         VdbeCoverage(v);
4814c5499befSdrh         testcase( regFree1==0 );
4815c5499befSdrh         testcase( jumpIfNull==0 );
4816991a1985Sdrh       }
4817cce7d176Sdrh       break;
4818cce7d176Sdrh     }
4819cce7d176Sdrh   }
48202dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
48212dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
4822cce7d176Sdrh }
48232282792aSdrh 
48242282792aSdrh /*
482572bc8208Sdrh ** Like sqlite3ExprIfFalse() except that a copy is made of pExpr before
482672bc8208Sdrh ** code generation, and that copy is deleted after code generation. This
482772bc8208Sdrh ** ensures that the original pExpr is unchanged.
482872bc8208Sdrh */
482972bc8208Sdrh void sqlite3ExprIfFalseDup(Parse *pParse, Expr *pExpr, int dest,int jumpIfNull){
483072bc8208Sdrh   sqlite3 *db = pParse->db;
483172bc8208Sdrh   Expr *pCopy = sqlite3ExprDup(db, pExpr, 0);
483272bc8208Sdrh   if( db->mallocFailed==0 ){
483372bc8208Sdrh     sqlite3ExprIfFalse(pParse, pCopy, dest, jumpIfNull);
483472bc8208Sdrh   }
483572bc8208Sdrh   sqlite3ExprDelete(db, pCopy);
483672bc8208Sdrh }
483772bc8208Sdrh 
48385aa550cfSdan /*
48395aa550cfSdan ** Expression pVar is guaranteed to be an SQL variable. pExpr may be any
48405aa550cfSdan ** type of expression.
48415aa550cfSdan **
48425aa550cfSdan ** If pExpr is a simple SQL value - an integer, real, string, blob
48435aa550cfSdan ** or NULL value - then the VDBE currently being prepared is configured
48445aa550cfSdan ** to re-prepare each time a new value is bound to variable pVar.
48455aa550cfSdan **
48465aa550cfSdan ** Additionally, if pExpr is a simple SQL value and the value is the
48475aa550cfSdan ** same as that currently bound to variable pVar, non-zero is returned.
48485aa550cfSdan ** Otherwise, if the values are not the same or if pExpr is not a simple
48495aa550cfSdan ** SQL value, zero is returned.
48505aa550cfSdan */
48515aa550cfSdan static int exprCompareVariable(Parse *pParse, Expr *pVar, Expr *pExpr){
48525aa550cfSdan   int res = 0;
4853c0804226Sdrh   int iVar;
4854c0804226Sdrh   sqlite3_value *pL, *pR = 0;
48555aa550cfSdan 
48565aa550cfSdan   sqlite3ValueFromExpr(pParse->db, pExpr, SQLITE_UTF8, SQLITE_AFF_BLOB, &pR);
4857c0804226Sdrh   if( pR ){
4858c0804226Sdrh     iVar = pVar->iColumn;
4859c0804226Sdrh     sqlite3VdbeSetVarmask(pParse->pVdbe, iVar);
4860c0804226Sdrh     pL = sqlite3VdbeGetBoundValue(pParse->pReprepare, iVar, SQLITE_AFF_BLOB);
48615aa307e2Sdrh     if( pL ){
48625aa307e2Sdrh       if( sqlite3_value_type(pL)==SQLITE_TEXT ){
48635aa307e2Sdrh         sqlite3_value_text(pL); /* Make sure the encoding is UTF-8 */
48645aa307e2Sdrh       }
48655aa307e2Sdrh       res =  0==sqlite3MemCompare(pL, pR, 0);
48665aa550cfSdan     }
48675aa550cfSdan     sqlite3ValueFree(pR);
48685aa550cfSdan     sqlite3ValueFree(pL);
48695aa550cfSdan   }
48705aa550cfSdan 
48715aa550cfSdan   return res;
48725aa550cfSdan }
487372bc8208Sdrh 
487472bc8208Sdrh /*
48751d9da70aSdrh ** Do a deep comparison of two expression trees.  Return 0 if the two
48761d9da70aSdrh ** expressions are completely identical.  Return 1 if they differ only
48771d9da70aSdrh ** by a COLLATE operator at the top level.  Return 2 if there are differences
48781d9da70aSdrh ** other than the top-level COLLATE operator.
4879d40aab0eSdrh **
4880619a1305Sdrh ** If any subelement of pB has Expr.iTable==(-1) then it is allowed
4881619a1305Sdrh ** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
4882619a1305Sdrh **
488366518ca7Sdrh ** The pA side might be using TK_REGISTER.  If that is the case and pB is
488466518ca7Sdrh ** not using TK_REGISTER but is otherwise equivalent, then still return 0.
488566518ca7Sdrh **
48861d9da70aSdrh ** Sometimes this routine will return 2 even if the two expressions
4887d40aab0eSdrh ** really are equivalent.  If we cannot prove that the expressions are
48881d9da70aSdrh ** identical, we return 2 just to be safe.  So if this routine
48891d9da70aSdrh ** returns 2, then you do not really know for certain if the two
48901d9da70aSdrh ** expressions are the same.  But if you get a 0 or 1 return, then you
4891d40aab0eSdrh ** can be sure the expressions are the same.  In the places where
48921d9da70aSdrh ** this routine is used, it does not hurt to get an extra 2 - that
4893d40aab0eSdrh ** just might result in some slightly slower code.  But returning
48941d9da70aSdrh ** an incorrect 0 or 1 could lead to a malfunction.
48955aa550cfSdan **
4896c0804226Sdrh ** If pParse is not NULL then TK_VARIABLE terms in pA with bindings in
4897c0804226Sdrh ** pParse->pReprepare can be matched against literals in pB.  The
4898c0804226Sdrh ** pParse->pVdbe->expmask bitmask is updated for each variable referenced.
4899c0804226Sdrh ** If pParse is NULL (the normal case) then any TK_VARIABLE term in
4900c0804226Sdrh ** Argument pParse should normally be NULL. If it is not NULL and pA or
4901c0804226Sdrh ** pB causes a return value of 2.
49022282792aSdrh */
49035aa550cfSdan int sqlite3ExprCompare(Parse *pParse, Expr *pA, Expr *pB, int iTab){
490410d1edf0Sdrh   u32 combinedFlags;
49054b202ae2Sdanielk1977   if( pA==0 || pB==0 ){
49061d9da70aSdrh     return pB==pA ? 0 : 2;
49072282792aSdrh   }
49085aa550cfSdan   if( pParse && pA->op==TK_VARIABLE && exprCompareVariable(pParse, pA, pB) ){
49095aa550cfSdan     return 0;
49105aa550cfSdan   }
491110d1edf0Sdrh   combinedFlags = pA->flags | pB->flags;
491210d1edf0Sdrh   if( combinedFlags & EP_IntValue ){
491310d1edf0Sdrh     if( (pA->flags&pB->flags&EP_IntValue)!=0 && pA->u.iValue==pB->u.iValue ){
491410d1edf0Sdrh       return 0;
491510d1edf0Sdrh     }
49161d9da70aSdrh     return 2;
49176ab3a2ecSdanielk1977   }
491816dd3985Sdan   if( pA->op!=pB->op || pA->op==TK_RAISE ){
49195aa550cfSdan     if( pA->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA->pLeft,pB,iTab)<2 ){
4920ae80ddeaSdrh       return 1;
4921ae80ddeaSdrh     }
49225aa550cfSdan     if( pB->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA,pB->pLeft,iTab)<2 ){
4923ae80ddeaSdrh       return 1;
4924ae80ddeaSdrh     }
4925ae80ddeaSdrh     return 2;
4926ae80ddeaSdrh   }
49272edc5fd7Sdrh   if( pA->op!=TK_COLUMN && pA->op!=TK_AGG_COLUMN && pA->u.zToken ){
49284f9adee2Sdan     if( pA->op==TK_FUNCTION || pA->op==TK_AGG_FUNCTION ){
4929390b88a4Sdrh       if( sqlite3StrICmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
4930eda079cdSdrh #ifndef SQLITE_OMIT_WINDOWFUNC
49314f9adee2Sdan       assert( pA->op==pB->op );
49324f9adee2Sdan       if( ExprHasProperty(pA,EP_WinFunc)!=ExprHasProperty(pB,EP_WinFunc) ){
49334f9adee2Sdan         return 2;
49344f9adee2Sdan       }
4935eda079cdSdrh       if( ExprHasProperty(pA,EP_WinFunc) ){
49364f9adee2Sdan         if( sqlite3WindowCompare(pParse, pA->y.pWin, pB->y.pWin, 1)!=0 ){
49374f9adee2Sdan           return 2;
49384f9adee2Sdan         }
4939eda079cdSdrh       }
4940eda079cdSdrh #endif
4941f20bbc5fSdrh     }else if( pA->op==TK_NULL ){
4942f20bbc5fSdrh       return 0;
4943d5af5420Sdrh     }else if( pA->op==TK_COLLATE ){
4944e79f6299Sdrh       if( sqlite3_stricmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
4945f20bbc5fSdrh     }else if( ALWAYS(pB->u.zToken!=0) && strcmp(pA->u.zToken,pB->u.zToken)!=0 ){
4946d5af5420Sdrh       return 2;
494710d1edf0Sdrh     }
494810d1edf0Sdrh   }
494910d1edf0Sdrh   if( (pA->flags & EP_Distinct)!=(pB->flags & EP_Distinct) ) return 2;
495089b6de03Sdrh   if( (combinedFlags & EP_TokenOnly)==0 ){
495110d1edf0Sdrh     if( combinedFlags & EP_xIsSelect ) return 2;
4952efad2e23Sdrh     if( (combinedFlags & EP_FixedCol)==0
4953efad2e23Sdrh      && sqlite3ExprCompare(pParse, pA->pLeft, pB->pLeft, iTab) ) return 2;
49545aa550cfSdan     if( sqlite3ExprCompare(pParse, pA->pRight, pB->pRight, iTab) ) return 2;
4955619a1305Sdrh     if( sqlite3ExprListCompare(pA->x.pList, pB->x.pList, iTab) ) return 2;
495603c5c213Sdrh     if( pA->op!=TK_STRING
495703c5c213Sdrh      && pA->op!=TK_TRUEFALSE
495803c5c213Sdrh      && (combinedFlags & EP_Reduced)==0
495903c5c213Sdrh     ){
4960619a1305Sdrh       if( pA->iColumn!=pB->iColumn ) return 2;
49618ac02a94Sdan       if( pA->op2!=pB->op2 ) return 2;
4962ebc64084Sdrh       if( pA->op!=TK_IN
4963ebc64084Sdrh        && pA->iTable!=pB->iTable
496485f8aa79Sdrh        && (pA->iTable!=iTab || NEVER(pB->iTable>=0)) ) return 2;
49651d9da70aSdrh     }
49661d9da70aSdrh   }
49672646da7eSdrh   return 0;
49682646da7eSdrh }
49692282792aSdrh 
49708c6f666bSdrh /*
49718c6f666bSdrh ** Compare two ExprList objects.  Return 0 if they are identical and
49728c6f666bSdrh ** non-zero if they differ in any way.
49738c6f666bSdrh **
4974619a1305Sdrh ** If any subelement of pB has Expr.iTable==(-1) then it is allowed
4975619a1305Sdrh ** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
4976619a1305Sdrh **
49778c6f666bSdrh ** This routine might return non-zero for equivalent ExprLists.  The
49788c6f666bSdrh ** only consequence will be disabled optimizations.  But this routine
49798c6f666bSdrh ** must never return 0 if the two ExprList objects are different, or
49808c6f666bSdrh ** a malfunction will result.
49818c6f666bSdrh **
49828c6f666bSdrh ** Two NULL pointers are considered to be the same.  But a NULL pointer
49838c6f666bSdrh ** always differs from a non-NULL pointer.
49848c6f666bSdrh */
4985619a1305Sdrh int sqlite3ExprListCompare(ExprList *pA, ExprList *pB, int iTab){
49868c6f666bSdrh   int i;
49878c6f666bSdrh   if( pA==0 && pB==0 ) return 0;
49888c6f666bSdrh   if( pA==0 || pB==0 ) return 1;
49898c6f666bSdrh   if( pA->nExpr!=pB->nExpr ) return 1;
49908c6f666bSdrh   for(i=0; i<pA->nExpr; i++){
49918c6f666bSdrh     Expr *pExprA = pA->a[i].pExpr;
49928c6f666bSdrh     Expr *pExprB = pB->a[i].pExpr;
49936e11892dSdan     if( pA->a[i].sortFlags!=pB->a[i].sortFlags ) return 1;
49945aa550cfSdan     if( sqlite3ExprCompare(0, pExprA, pExprB, iTab) ) return 1;
49958c6f666bSdrh   }
49968c6f666bSdrh   return 0;
49978c6f666bSdrh }
499813449892Sdrh 
49992282792aSdrh /*
5000f9463dfbSdrh ** Like sqlite3ExprCompare() except COLLATE operators at the top-level
5001f9463dfbSdrh ** are ignored.
5002f9463dfbSdrh */
5003f9463dfbSdrh int sqlite3ExprCompareSkip(Expr *pA, Expr *pB, int iTab){
50045aa550cfSdan   return sqlite3ExprCompare(0,
50050d950af3Sdrh              sqlite3ExprSkipCollateAndLikely(pA),
50060d950af3Sdrh              sqlite3ExprSkipCollateAndLikely(pB),
5007f9463dfbSdrh              iTab);
5008f9463dfbSdrh }
5009f9463dfbSdrh 
5010f9463dfbSdrh /*
5011c51cf864Sdrh ** Return non-zero if Expr p can only be true if pNN is not NULL.
50127a231b49Sdrh **
50137a231b49Sdrh ** Or if seenNot is true, return non-zero if Expr p can only be
50147a231b49Sdrh ** non-NULL if pNN is not NULL
5015c51cf864Sdrh */
5016c51cf864Sdrh static int exprImpliesNotNull(
5017c51cf864Sdrh   Parse *pParse,      /* Parsing context */
5018c51cf864Sdrh   Expr *p,            /* The expression to be checked */
5019c51cf864Sdrh   Expr *pNN,          /* The expression that is NOT NULL */
5020c51cf864Sdrh   int iTab,           /* Table being evaluated */
50217a231b49Sdrh   int seenNot         /* Return true only if p can be any non-NULL value */
5022c51cf864Sdrh ){
5023c51cf864Sdrh   assert( p );
5024c51cf864Sdrh   assert( pNN );
502514c865e8Sdrh   if( sqlite3ExprCompare(pParse, p, pNN, iTab)==0 ){
502614c865e8Sdrh     return pNN->op!=TK_NULL;
502714c865e8Sdrh   }
5028c51cf864Sdrh   switch( p->op ){
5029c51cf864Sdrh     case TK_IN: {
5030c51cf864Sdrh       if( seenNot && ExprHasProperty(p, EP_xIsSelect) ) return 0;
5031c51cf864Sdrh       assert( ExprHasProperty(p,EP_xIsSelect)
5032c51cf864Sdrh            || (p->x.pList!=0 && p->x.pList->nExpr>0) );
5033ae144a1cSdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
5034c51cf864Sdrh     }
5035c51cf864Sdrh     case TK_BETWEEN: {
5036c51cf864Sdrh       ExprList *pList = p->x.pList;
5037c51cf864Sdrh       assert( pList!=0 );
5038c51cf864Sdrh       assert( pList->nExpr==2 );
5039c51cf864Sdrh       if( seenNot ) return 0;
50407a231b49Sdrh       if( exprImpliesNotNull(pParse, pList->a[0].pExpr, pNN, iTab, 1)
50417a231b49Sdrh        || exprImpliesNotNull(pParse, pList->a[1].pExpr, pNN, iTab, 1)
5042c51cf864Sdrh       ){
5043c51cf864Sdrh         return 1;
5044c51cf864Sdrh       }
50457a231b49Sdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
5046c51cf864Sdrh     }
5047c51cf864Sdrh     case TK_EQ:
5048c51cf864Sdrh     case TK_NE:
5049c51cf864Sdrh     case TK_LT:
5050c51cf864Sdrh     case TK_LE:
5051c51cf864Sdrh     case TK_GT:
5052c51cf864Sdrh     case TK_GE:
5053c51cf864Sdrh     case TK_PLUS:
5054c51cf864Sdrh     case TK_MINUS:
50559d23ea74Sdan     case TK_BITOR:
50569d23ea74Sdan     case TK_LSHIFT:
50579d23ea74Sdan     case TK_RSHIFT:
50589d23ea74Sdan     case TK_CONCAT:
50599d23ea74Sdan       seenNot = 1;
50609d23ea74Sdan       /* Fall thru */
5061c51cf864Sdrh     case TK_STAR:
5062c51cf864Sdrh     case TK_REM:
5063c51cf864Sdrh     case TK_BITAND:
50649d23ea74Sdan     case TK_SLASH: {
5065c51cf864Sdrh       if( exprImpliesNotNull(pParse, p->pRight, pNN, iTab, seenNot) ) return 1;
5066c51cf864Sdrh       /* Fall thru into the next case */
5067c51cf864Sdrh     }
5068c51cf864Sdrh     case TK_SPAN:
5069c51cf864Sdrh     case TK_COLLATE:
5070c51cf864Sdrh     case TK_UPLUS:
5071c51cf864Sdrh     case TK_UMINUS: {
5072c51cf864Sdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, seenNot);
5073c51cf864Sdrh     }
5074c51cf864Sdrh     case TK_TRUTH: {
5075c51cf864Sdrh       if( seenNot ) return 0;
5076c51cf864Sdrh       if( p->op2!=TK_IS ) return 0;
507738cefc83Sdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
5078c51cf864Sdrh     }
50791cd382e3Sdan     case TK_BITNOT:
5080c51cf864Sdrh     case TK_NOT: {
5081c51cf864Sdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
5082c51cf864Sdrh     }
5083c51cf864Sdrh   }
5084c51cf864Sdrh   return 0;
5085c51cf864Sdrh }
5086c51cf864Sdrh 
5087c51cf864Sdrh /*
50884bd5f73fSdrh ** Return true if we can prove the pE2 will always be true if pE1 is
50894bd5f73fSdrh ** true.  Return false if we cannot complete the proof or if pE2 might
50904bd5f73fSdrh ** be false.  Examples:
50914bd5f73fSdrh **
5092619a1305Sdrh **     pE1: x==5       pE2: x==5             Result: true
50934bd5f73fSdrh **     pE1: x>0        pE2: x==5             Result: false
5094619a1305Sdrh **     pE1: x=21       pE2: x=21 OR y=43     Result: true
50954bd5f73fSdrh **     pE1: x!=123     pE2: x IS NOT NULL    Result: true
5096619a1305Sdrh **     pE1: x!=?1      pE2: x IS NOT NULL    Result: true
5097619a1305Sdrh **     pE1: x IS NULL  pE2: x IS NOT NULL    Result: false
5098619a1305Sdrh **     pE1: x IS ?2    pE2: x IS NOT NULL    Reuslt: false
50994bd5f73fSdrh **
51004bd5f73fSdrh ** When comparing TK_COLUMN nodes between pE1 and pE2, if pE2 has
51014bd5f73fSdrh ** Expr.iTable<0 then assume a table number given by iTab.
51024bd5f73fSdrh **
5103c0804226Sdrh ** If pParse is not NULL, then the values of bound variables in pE1 are
5104c0804226Sdrh ** compared against literal values in pE2 and pParse->pVdbe->expmask is
5105c0804226Sdrh ** modified to record which bound variables are referenced.  If pParse
5106c0804226Sdrh ** is NULL, then false will be returned if pE1 contains any bound variables.
5107c0804226Sdrh **
51084bd5f73fSdrh ** When in doubt, return false.  Returning true might give a performance
51094bd5f73fSdrh ** improvement.  Returning false might cause a performance reduction, but
51104bd5f73fSdrh ** it will always give the correct answer and is hence always safe.
51114bd5f73fSdrh */
51125aa550cfSdan int sqlite3ExprImpliesExpr(Parse *pParse, Expr *pE1, Expr *pE2, int iTab){
51135aa550cfSdan   if( sqlite3ExprCompare(pParse, pE1, pE2, iTab)==0 ){
5114619a1305Sdrh     return 1;
5115619a1305Sdrh   }
5116619a1305Sdrh   if( pE2->op==TK_OR
51175aa550cfSdan    && (sqlite3ExprImpliesExpr(pParse, pE1, pE2->pLeft, iTab)
51185aa550cfSdan              || sqlite3ExprImpliesExpr(pParse, pE1, pE2->pRight, iTab) )
5119619a1305Sdrh   ){
5120619a1305Sdrh     return 1;
5121619a1305Sdrh   }
5122664d6d13Sdrh   if( pE2->op==TK_NOTNULL
5123c51cf864Sdrh    && exprImpliesNotNull(pParse, pE1, pE2->pLeft, iTab, 0)
5124664d6d13Sdrh   ){
5125c51cf864Sdrh     return 1;
5126619a1305Sdrh   }
5127619a1305Sdrh   return 0;
51284bd5f73fSdrh }
51294bd5f73fSdrh 
51304bd5f73fSdrh /*
51312589787cSdrh ** This is the Expr node callback for sqlite3ExprImpliesNotNullRow().
51322589787cSdrh ** If the expression node requires that the table at pWalker->iCur
5133f8937f90Sdrh ** have one or more non-NULL column, then set pWalker->eCode to 1 and abort.
5134f8937f90Sdrh **
5135f8937f90Sdrh ** This routine controls an optimization.  False positives (setting
5136f8937f90Sdrh ** pWalker->eCode to 1 when it should not be) are deadly, but false-negatives
5137f8937f90Sdrh ** (never setting pWalker->eCode) is a harmless missed optimization.
51382589787cSdrh */
51392589787cSdrh static int impliesNotNullRow(Walker *pWalker, Expr *pExpr){
5140f8937f90Sdrh   testcase( pExpr->op==TK_AGG_COLUMN );
5141821b610bSdrh   testcase( pExpr->op==TK_AGG_FUNCTION );
51422589787cSdrh   if( ExprHasProperty(pExpr, EP_FromJoin) ) return WRC_Prune;
51432589787cSdrh   switch( pExpr->op ){
51440493222fSdan     case TK_ISNOT:
51452589787cSdrh     case TK_ISNULL:
5146d5793672Sdrh     case TK_NOTNULL:
51472589787cSdrh     case TK_IS:
51482589787cSdrh     case TK_OR:
51492c492061Sdrh     case TK_CASE:
5150e3eff266Sdrh     case TK_IN:
51512589787cSdrh     case TK_FUNCTION:
5152da03c1e6Sdan     case TK_TRUTH:
51530493222fSdan       testcase( pExpr->op==TK_ISNOT );
5154821b610bSdrh       testcase( pExpr->op==TK_ISNULL );
5155d5793672Sdrh       testcase( pExpr->op==TK_NOTNULL );
5156821b610bSdrh       testcase( pExpr->op==TK_IS );
5157821b610bSdrh       testcase( pExpr->op==TK_OR );
5158821b610bSdrh       testcase( pExpr->op==TK_CASE );
5159821b610bSdrh       testcase( pExpr->op==TK_IN );
5160821b610bSdrh       testcase( pExpr->op==TK_FUNCTION );
5161da03c1e6Sdan       testcase( pExpr->op==TK_TRUTH );
51622589787cSdrh       return WRC_Prune;
51632589787cSdrh     case TK_COLUMN:
51642589787cSdrh       if( pWalker->u.iCur==pExpr->iTable ){
51652589787cSdrh         pWalker->eCode = 1;
51662589787cSdrh         return WRC_Abort;
51672589787cSdrh       }
51682589787cSdrh       return WRC_Prune;
51699881155dSdrh 
51709d23ea74Sdan     case TK_AND:
5171*0287c951Sdan       assert( pWalker->eCode==0 );
5172*0287c951Sdan       sqlite3WalkExpr(pWalker, pExpr->pLeft);
5173*0287c951Sdan       if( pWalker->eCode ){
5174*0287c951Sdan         pWalker->eCode = 0;
5175*0287c951Sdan         sqlite3WalkExpr(pWalker, pExpr->pRight);
51769d23ea74Sdan       }
51779d23ea74Sdan       return WRC_Prune;
51789d23ea74Sdan 
51799d23ea74Sdan     case TK_BETWEEN:
51809d23ea74Sdan       sqlite3WalkExpr(pWalker, pExpr->pLeft);
51819d23ea74Sdan       return WRC_Prune;
51829d23ea74Sdan 
51839881155dSdrh     /* Virtual tables are allowed to use constraints like x=NULL.  So
51849881155dSdrh     ** a term of the form x=y does not prove that y is not null if x
51859881155dSdrh     ** is the column of a virtual table */
51869881155dSdrh     case TK_EQ:
51879881155dSdrh     case TK_NE:
51889881155dSdrh     case TK_LT:
51899881155dSdrh     case TK_LE:
51909881155dSdrh     case TK_GT:
51919881155dSdrh     case TK_GE:
51929881155dSdrh       testcase( pExpr->op==TK_EQ );
51939881155dSdrh       testcase( pExpr->op==TK_NE );
51949881155dSdrh       testcase( pExpr->op==TK_LT );
51959881155dSdrh       testcase( pExpr->op==TK_LE );
51969881155dSdrh       testcase( pExpr->op==TK_GT );
51979881155dSdrh       testcase( pExpr->op==TK_GE );
5198eda079cdSdrh       if( (pExpr->pLeft->op==TK_COLUMN && IsVirtual(pExpr->pLeft->y.pTab))
5199eda079cdSdrh        || (pExpr->pRight->op==TK_COLUMN && IsVirtual(pExpr->pRight->y.pTab))
52009881155dSdrh       ){
52019881155dSdrh        return WRC_Prune;
52029881155dSdrh       }
52039d23ea74Sdan 
52042589787cSdrh     default:
52052589787cSdrh       return WRC_Continue;
52062589787cSdrh   }
52072589787cSdrh }
52082589787cSdrh 
52092589787cSdrh /*
52102589787cSdrh ** Return true (non-zero) if expression p can only be true if at least
52112589787cSdrh ** one column of table iTab is non-null.  In other words, return true
52122589787cSdrh ** if expression p will always be NULL or false if every column of iTab
52132589787cSdrh ** is NULL.
52142589787cSdrh **
5215821b610bSdrh ** False negatives are acceptable.  In other words, it is ok to return
5216821b610bSdrh ** zero even if expression p will never be true of every column of iTab
5217821b610bSdrh ** is NULL.  A false negative is merely a missed optimization opportunity.
5218821b610bSdrh **
5219821b610bSdrh ** False positives are not allowed, however.  A false positive may result
5220821b610bSdrh ** in an incorrect answer.
5221821b610bSdrh **
52222589787cSdrh ** Terms of p that are marked with EP_FromJoin (and hence that come from
52232589787cSdrh ** the ON or USING clauses of LEFT JOINS) are excluded from the analysis.
52242589787cSdrh **
52252589787cSdrh ** This routine is used to check if a LEFT JOIN can be converted into
52262589787cSdrh ** an ordinary JOIN.  The p argument is the WHERE clause.  If the WHERE
52272589787cSdrh ** clause requires that some column of the right table of the LEFT JOIN
52282589787cSdrh ** be non-NULL, then the LEFT JOIN can be safely converted into an
52292589787cSdrh ** ordinary join.
52302589787cSdrh */
52312589787cSdrh int sqlite3ExprImpliesNonNullRow(Expr *p, int iTab){
52322589787cSdrh   Walker w;
52330d950af3Sdrh   p = sqlite3ExprSkipCollateAndLikely(p);
5234*0287c951Sdan   if( p && p->op==TK_NOTNULL ){
5235d6db6598Sdrh     p = p->pLeft;
5236d6db6598Sdrh   }
52372589787cSdrh   w.xExprCallback = impliesNotNullRow;
52382589787cSdrh   w.xSelectCallback = 0;
52392589787cSdrh   w.xSelectCallback2 = 0;
52402589787cSdrh   w.eCode = 0;
52412589787cSdrh   w.u.iCur = iTab;
52422589787cSdrh   sqlite3WalkExpr(&w, p);
52432589787cSdrh   return w.eCode;
52442589787cSdrh }
52452589787cSdrh 
52462589787cSdrh /*
5247030796dfSdrh ** An instance of the following structure is used by the tree walker
52482409f8a1Sdrh ** to determine if an expression can be evaluated by reference to the
52492409f8a1Sdrh ** index only, without having to do a search for the corresponding
52502409f8a1Sdrh ** table entry.  The IdxCover.pIdx field is the index.  IdxCover.iCur
52512409f8a1Sdrh ** is the cursor for the table.
52522409f8a1Sdrh */
52532409f8a1Sdrh struct IdxCover {
52542409f8a1Sdrh   Index *pIdx;     /* The index to be tested for coverage */
52552409f8a1Sdrh   int iCur;        /* Cursor number for the table corresponding to the index */
52562409f8a1Sdrh };
52572409f8a1Sdrh 
52582409f8a1Sdrh /*
52592409f8a1Sdrh ** Check to see if there are references to columns in table
52602409f8a1Sdrh ** pWalker->u.pIdxCover->iCur can be satisfied using the index
52612409f8a1Sdrh ** pWalker->u.pIdxCover->pIdx.
52622409f8a1Sdrh */
52632409f8a1Sdrh static int exprIdxCover(Walker *pWalker, Expr *pExpr){
52642409f8a1Sdrh   if( pExpr->op==TK_COLUMN
52652409f8a1Sdrh    && pExpr->iTable==pWalker->u.pIdxCover->iCur
52662409f8a1Sdrh    && sqlite3ColumnOfIndex(pWalker->u.pIdxCover->pIdx, pExpr->iColumn)<0
52672409f8a1Sdrh   ){
52682409f8a1Sdrh     pWalker->eCode = 1;
52692409f8a1Sdrh     return WRC_Abort;
52702409f8a1Sdrh   }
52712409f8a1Sdrh   return WRC_Continue;
52722409f8a1Sdrh }
52732409f8a1Sdrh 
52742409f8a1Sdrh /*
5275e604ec0bSdrh ** Determine if an index pIdx on table with cursor iCur contains will
5276e604ec0bSdrh ** the expression pExpr.  Return true if the index does cover the
5277e604ec0bSdrh ** expression and false if the pExpr expression references table columns
5278e604ec0bSdrh ** that are not found in the index pIdx.
52792409f8a1Sdrh **
52802409f8a1Sdrh ** An index covering an expression means that the expression can be
52812409f8a1Sdrh ** evaluated using only the index and without having to lookup the
52822409f8a1Sdrh ** corresponding table entry.
52832409f8a1Sdrh */
52842409f8a1Sdrh int sqlite3ExprCoveredByIndex(
52852409f8a1Sdrh   Expr *pExpr,        /* The index to be tested */
52862409f8a1Sdrh   int iCur,           /* The cursor number for the corresponding table */
52872409f8a1Sdrh   Index *pIdx         /* The index that might be used for coverage */
52882409f8a1Sdrh ){
52892409f8a1Sdrh   Walker w;
52902409f8a1Sdrh   struct IdxCover xcov;
52912409f8a1Sdrh   memset(&w, 0, sizeof(w));
52922409f8a1Sdrh   xcov.iCur = iCur;
52932409f8a1Sdrh   xcov.pIdx = pIdx;
52942409f8a1Sdrh   w.xExprCallback = exprIdxCover;
52952409f8a1Sdrh   w.u.pIdxCover = &xcov;
52962409f8a1Sdrh   sqlite3WalkExpr(&w, pExpr);
52972409f8a1Sdrh   return !w.eCode;
52982409f8a1Sdrh }
52992409f8a1Sdrh 
53002409f8a1Sdrh 
53012409f8a1Sdrh /*
53022409f8a1Sdrh ** An instance of the following structure is used by the tree walker
5303030796dfSdrh ** to count references to table columns in the arguments of an
5304ed551b95Sdrh ** aggregate function, in order to implement the
5305ed551b95Sdrh ** sqlite3FunctionThisSrc() routine.
5306374fdce4Sdrh */
5307030796dfSdrh struct SrcCount {
5308030796dfSdrh   SrcList *pSrc;   /* One particular FROM clause in a nested query */
5309030796dfSdrh   int nThis;       /* Number of references to columns in pSrcList */
5310030796dfSdrh   int nOther;      /* Number of references to columns in other FROM clauses */
5311030796dfSdrh };
5312030796dfSdrh 
5313030796dfSdrh /*
5314030796dfSdrh ** Count the number of references to columns.
5315030796dfSdrh */
5316030796dfSdrh static int exprSrcCount(Walker *pWalker, Expr *pExpr){
5317fb0a6081Sdrh   /* The NEVER() on the second term is because sqlite3FunctionUsesThisSrc()
5318fb0a6081Sdrh   ** is always called before sqlite3ExprAnalyzeAggregates() and so the
5319fb0a6081Sdrh   ** TK_COLUMNs have not yet been converted into TK_AGG_COLUMN.  If
5320fb0a6081Sdrh   ** sqlite3FunctionUsesThisSrc() is used differently in the future, the
5321fb0a6081Sdrh   ** NEVER() will need to be removed. */
5322fb0a6081Sdrh   if( pExpr->op==TK_COLUMN || NEVER(pExpr->op==TK_AGG_COLUMN) ){
5323374fdce4Sdrh     int i;
5324030796dfSdrh     struct SrcCount *p = pWalker->u.pSrcCount;
5325030796dfSdrh     SrcList *pSrc = p->pSrc;
5326655814d2Sdrh     int nSrc = pSrc ? pSrc->nSrc : 0;
5327655814d2Sdrh     for(i=0; i<nSrc; i++){
5328030796dfSdrh       if( pExpr->iTable==pSrc->a[i].iCursor ) break;
5329374fdce4Sdrh     }
5330655814d2Sdrh     if( i<nSrc ){
5331030796dfSdrh       p->nThis++;
533280f6bfc0Sdrh     }else if( nSrc==0 || pExpr->iTable<pSrc->a[0].iCursor ){
533380f6bfc0Sdrh       /* In a well-formed parse tree (no name resolution errors),
533435a38e08Sdrh       ** TK_COLUMN nodes with smaller Expr.iTable values are in an
533580f6bfc0Sdrh       ** outer context.  Those are the only ones to count as "other" */
5336030796dfSdrh       p->nOther++;
5337374fdce4Sdrh     }
5338374fdce4Sdrh   }
5339030796dfSdrh   return WRC_Continue;
5340030796dfSdrh }
5341374fdce4Sdrh 
5342374fdce4Sdrh /*
5343030796dfSdrh ** Determine if any of the arguments to the pExpr Function reference
5344030796dfSdrh ** pSrcList.  Return true if they do.  Also return true if the function
5345030796dfSdrh ** has no arguments or has only constant arguments.  Return false if pExpr
5346030796dfSdrh ** references columns but not columns of tables found in pSrcList.
5347374fdce4Sdrh */
5348030796dfSdrh int sqlite3FunctionUsesThisSrc(Expr *pExpr, SrcList *pSrcList){
5349374fdce4Sdrh   Walker w;
5350030796dfSdrh   struct SrcCount cnt;
5351374fdce4Sdrh   assert( pExpr->op==TK_AGG_FUNCTION );
535280f6bfc0Sdrh   memset(&w, 0, sizeof(w));
5353030796dfSdrh   w.xExprCallback = exprSrcCount;
535480f6bfc0Sdrh   w.xSelectCallback = sqlite3SelectWalkNoop;
5355030796dfSdrh   w.u.pSrcCount = &cnt;
5356030796dfSdrh   cnt.pSrc = pSrcList;
5357030796dfSdrh   cnt.nThis = 0;
5358030796dfSdrh   cnt.nOther = 0;
5359030796dfSdrh   sqlite3WalkExprList(&w, pExpr->x.pList);
5360030796dfSdrh   return cnt.nThis>0 || cnt.nOther==0;
5361374fdce4Sdrh }
5362374fdce4Sdrh 
5363374fdce4Sdrh /*
536413449892Sdrh ** Add a new element to the pAggInfo->aCol[] array.  Return the index of
536513449892Sdrh ** the new element.  Return a negative number if malloc fails.
53662282792aSdrh */
536717435752Sdrh static int addAggInfoColumn(sqlite3 *db, AggInfo *pInfo){
536813449892Sdrh   int i;
5369cf643729Sdrh   pInfo->aCol = sqlite3ArrayAllocate(
537017435752Sdrh        db,
5371cf643729Sdrh        pInfo->aCol,
5372cf643729Sdrh        sizeof(pInfo->aCol[0]),
5373cf643729Sdrh        &pInfo->nColumn,
5374cf643729Sdrh        &i
5375cf643729Sdrh   );
537613449892Sdrh   return i;
53772282792aSdrh }
537813449892Sdrh 
537913449892Sdrh /*
538013449892Sdrh ** Add a new element to the pAggInfo->aFunc[] array.  Return the index of
538113449892Sdrh ** the new element.  Return a negative number if malloc fails.
538213449892Sdrh */
538317435752Sdrh static int addAggInfoFunc(sqlite3 *db, AggInfo *pInfo){
538413449892Sdrh   int i;
5385cf643729Sdrh   pInfo->aFunc = sqlite3ArrayAllocate(
538617435752Sdrh        db,
5387cf643729Sdrh        pInfo->aFunc,
5388cf643729Sdrh        sizeof(pInfo->aFunc[0]),
5389cf643729Sdrh        &pInfo->nFunc,
5390cf643729Sdrh        &i
5391cf643729Sdrh   );
539213449892Sdrh   return i;
53932282792aSdrh }
53942282792aSdrh 
53952282792aSdrh /*
53967d10d5a6Sdrh ** This is the xExprCallback for a tree walker.  It is used to
53977d10d5a6Sdrh ** implement sqlite3ExprAnalyzeAggregates().  See sqlite3ExprAnalyzeAggregates
5398626a879aSdrh ** for additional information.
53992282792aSdrh */
54007d10d5a6Sdrh static int analyzeAggregate(Walker *pWalker, Expr *pExpr){
54012282792aSdrh   int i;
54027d10d5a6Sdrh   NameContext *pNC = pWalker->u.pNC;
5403a58fdfb1Sdanielk1977   Parse *pParse = pNC->pParse;
5404a58fdfb1Sdanielk1977   SrcList *pSrcList = pNC->pSrcList;
540525c3b8caSdrh   AggInfo *pAggInfo = pNC->uNC.pAggInfo;
540613449892Sdrh 
540725c3b8caSdrh   assert( pNC->ncFlags & NC_UAggInfo );
54082282792aSdrh   switch( pExpr->op ){
540989c69d00Sdrh     case TK_AGG_COLUMN:
5410967e8b73Sdrh     case TK_COLUMN: {
54118b213899Sdrh       testcase( pExpr->op==TK_AGG_COLUMN );
54128b213899Sdrh       testcase( pExpr->op==TK_COLUMN );
541313449892Sdrh       /* Check to see if the column is in one of the tables in the FROM
541413449892Sdrh       ** clause of the aggregate query */
541520bc393cSdrh       if( ALWAYS(pSrcList!=0) ){
541613449892Sdrh         struct SrcList_item *pItem = pSrcList->a;
541713449892Sdrh         for(i=0; i<pSrcList->nSrc; i++, pItem++){
541813449892Sdrh           struct AggInfo_col *pCol;
5419c5cd1249Sdrh           assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
542013449892Sdrh           if( pExpr->iTable==pItem->iCursor ){
542113449892Sdrh             /* If we reach this point, it means that pExpr refers to a table
542213449892Sdrh             ** that is in the FROM clause of the aggregate query.
542313449892Sdrh             **
542413449892Sdrh             ** Make an entry for the column in pAggInfo->aCol[] if there
542513449892Sdrh             ** is not an entry there already.
542613449892Sdrh             */
54277f906d63Sdrh             int k;
542813449892Sdrh             pCol = pAggInfo->aCol;
54297f906d63Sdrh             for(k=0; k<pAggInfo->nColumn; k++, pCol++){
543013449892Sdrh               if( pCol->iTable==pExpr->iTable &&
543113449892Sdrh                   pCol->iColumn==pExpr->iColumn ){
54322282792aSdrh                 break;
54332282792aSdrh               }
54342282792aSdrh             }
54351e536953Sdanielk1977             if( (k>=pAggInfo->nColumn)
54361e536953Sdanielk1977              && (k = addAggInfoColumn(pParse->db, pAggInfo))>=0
54371e536953Sdanielk1977             ){
54387f906d63Sdrh               pCol = &pAggInfo->aCol[k];
5439eda079cdSdrh               pCol->pTab = pExpr->y.pTab;
544013449892Sdrh               pCol->iTable = pExpr->iTable;
544113449892Sdrh               pCol->iColumn = pExpr->iColumn;
54420a07c107Sdrh               pCol->iMem = ++pParse->nMem;
544313449892Sdrh               pCol->iSorterColumn = -1;
54445774b806Sdrh               pCol->pExpr = pExpr;
544513449892Sdrh               if( pAggInfo->pGroupBy ){
544613449892Sdrh                 int j, n;
544713449892Sdrh                 ExprList *pGB = pAggInfo->pGroupBy;
544813449892Sdrh                 struct ExprList_item *pTerm = pGB->a;
544913449892Sdrh                 n = pGB->nExpr;
545013449892Sdrh                 for(j=0; j<n; j++, pTerm++){
545113449892Sdrh                   Expr *pE = pTerm->pExpr;
545213449892Sdrh                   if( pE->op==TK_COLUMN && pE->iTable==pExpr->iTable &&
545313449892Sdrh                       pE->iColumn==pExpr->iColumn ){
545413449892Sdrh                     pCol->iSorterColumn = j;
545513449892Sdrh                     break;
54562282792aSdrh                   }
545713449892Sdrh                 }
545813449892Sdrh               }
545913449892Sdrh               if( pCol->iSorterColumn<0 ){
546013449892Sdrh                 pCol->iSorterColumn = pAggInfo->nSortingColumn++;
546113449892Sdrh               }
546213449892Sdrh             }
546313449892Sdrh             /* There is now an entry for pExpr in pAggInfo->aCol[] (either
546413449892Sdrh             ** because it was there before or because we just created it).
546513449892Sdrh             ** Convert the pExpr to be a TK_AGG_COLUMN referring to that
546613449892Sdrh             ** pAggInfo->aCol[] entry.
546713449892Sdrh             */
5468ebb6a65dSdrh             ExprSetVVAProperty(pExpr, EP_NoReduce);
546913449892Sdrh             pExpr->pAggInfo = pAggInfo;
547013449892Sdrh             pExpr->op = TK_AGG_COLUMN;
5471cf697396Sshane             pExpr->iAgg = (i16)k;
547213449892Sdrh             break;
547313449892Sdrh           } /* endif pExpr->iTable==pItem->iCursor */
547413449892Sdrh         } /* end loop over pSrcList */
5475a58fdfb1Sdanielk1977       }
54767d10d5a6Sdrh       return WRC_Prune;
54772282792aSdrh     }
54782282792aSdrh     case TK_AGG_FUNCTION: {
54793a8c4be7Sdrh       if( (pNC->ncFlags & NC_InAggFunc)==0
5480ed551b95Sdrh        && pWalker->walkerDepth==pExpr->op2
54813a8c4be7Sdrh       ){
548213449892Sdrh         /* Check to see if pExpr is a duplicate of another aggregate
548313449892Sdrh         ** function that is already in the pAggInfo structure
548413449892Sdrh         */
548513449892Sdrh         struct AggInfo_func *pItem = pAggInfo->aFunc;
548613449892Sdrh         for(i=0; i<pAggInfo->nFunc; i++, pItem++){
54875aa550cfSdan           if( sqlite3ExprCompare(0, pItem->pExpr, pExpr, -1)==0 ){
54882282792aSdrh             break;
54892282792aSdrh           }
54902282792aSdrh         }
549113449892Sdrh         if( i>=pAggInfo->nFunc ){
549213449892Sdrh           /* pExpr is original.  Make a new entry in pAggInfo->aFunc[]
549313449892Sdrh           */
549414db2665Sdanielk1977           u8 enc = ENC(pParse->db);
54951e536953Sdanielk1977           i = addAggInfoFunc(pParse->db, pAggInfo);
549613449892Sdrh           if( i>=0 ){
54976ab3a2ecSdanielk1977             assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
549813449892Sdrh             pItem = &pAggInfo->aFunc[i];
549913449892Sdrh             pItem->pExpr = pExpr;
55000a07c107Sdrh             pItem->iMem = ++pParse->nMem;
550133e619fcSdrh             assert( !ExprHasProperty(pExpr, EP_IntValue) );
550213449892Sdrh             pItem->pFunc = sqlite3FindFunction(pParse->db,
550380738d9cSdrh                    pExpr->u.zToken,
55046ab3a2ecSdanielk1977                    pExpr->x.pList ? pExpr->x.pList->nExpr : 0, enc, 0);
5505fd357974Sdrh             if( pExpr->flags & EP_Distinct ){
5506fd357974Sdrh               pItem->iDistinct = pParse->nTab++;
5507fd357974Sdrh             }else{
5508fd357974Sdrh               pItem->iDistinct = -1;
5509fd357974Sdrh             }
55102282792aSdrh           }
551113449892Sdrh         }
551213449892Sdrh         /* Make pExpr point to the appropriate pAggInfo->aFunc[] entry
551313449892Sdrh         */
5514c5cd1249Sdrh         assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
5515ebb6a65dSdrh         ExprSetVVAProperty(pExpr, EP_NoReduce);
5516cf697396Sshane         pExpr->iAgg = (i16)i;
551713449892Sdrh         pExpr->pAggInfo = pAggInfo;
55183a8c4be7Sdrh         return WRC_Prune;
55196e83a57fSdrh       }else{
55206e83a57fSdrh         return WRC_Continue;
55216e83a57fSdrh       }
55222282792aSdrh     }
5523a58fdfb1Sdanielk1977   }
55247d10d5a6Sdrh   return WRC_Continue;
55257d10d5a6Sdrh }
55267d10d5a6Sdrh static int analyzeAggregatesInSelect(Walker *pWalker, Select *pSelect){
5527d5a336efSdrh   UNUSED_PARAMETER(pSelect);
5528979dd1beSdrh   pWalker->walkerDepth++;
55297d10d5a6Sdrh   return WRC_Continue;
5530a58fdfb1Sdanielk1977 }
5531979dd1beSdrh static void analyzeAggregatesInSelectEnd(Walker *pWalker, Select *pSelect){
5532979dd1beSdrh   UNUSED_PARAMETER(pSelect);
5533979dd1beSdrh   pWalker->walkerDepth--;
5534979dd1beSdrh }
5535626a879aSdrh 
5536626a879aSdrh /*
5537e8abb4caSdrh ** Analyze the pExpr expression looking for aggregate functions and
5538e8abb4caSdrh ** for variables that need to be added to AggInfo object that pNC->pAggInfo
5539e8abb4caSdrh ** points to.  Additional entries are made on the AggInfo object as
5540e8abb4caSdrh ** necessary.
5541626a879aSdrh **
5542626a879aSdrh ** This routine should only be called after the expression has been
55437d10d5a6Sdrh ** analyzed by sqlite3ResolveExprNames().
5544626a879aSdrh */
5545d2b3e23bSdrh void sqlite3ExprAnalyzeAggregates(NameContext *pNC, Expr *pExpr){
55467d10d5a6Sdrh   Walker w;
55477d10d5a6Sdrh   w.xExprCallback = analyzeAggregate;
55487d10d5a6Sdrh   w.xSelectCallback = analyzeAggregatesInSelect;
5549979dd1beSdrh   w.xSelectCallback2 = analyzeAggregatesInSelectEnd;
5550979dd1beSdrh   w.walkerDepth = 0;
55517d10d5a6Sdrh   w.u.pNC = pNC;
5552d9995031Sdan   w.pParse = 0;
555320bc393cSdrh   assert( pNC->pSrcList!=0 );
55547d10d5a6Sdrh   sqlite3WalkExpr(&w, pExpr);
55552282792aSdrh }
55565d9a4af9Sdrh 
55575d9a4af9Sdrh /*
55585d9a4af9Sdrh ** Call sqlite3ExprAnalyzeAggregates() for every expression in an
55595d9a4af9Sdrh ** expression list.  Return the number of errors.
55605d9a4af9Sdrh **
55615d9a4af9Sdrh ** If an error is found, the analysis is cut short.
55625d9a4af9Sdrh */
5563d2b3e23bSdrh void sqlite3ExprAnalyzeAggList(NameContext *pNC, ExprList *pList){
55645d9a4af9Sdrh   struct ExprList_item *pItem;
55655d9a4af9Sdrh   int i;
55665d9a4af9Sdrh   if( pList ){
5567d2b3e23bSdrh     for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
5568d2b3e23bSdrh       sqlite3ExprAnalyzeAggregates(pNC, pItem->pExpr);
55695d9a4af9Sdrh     }
55705d9a4af9Sdrh   }
55715d9a4af9Sdrh }
5572892d3179Sdrh 
5573892d3179Sdrh /*
5574ceea3321Sdrh ** Allocate a single new register for use to hold some intermediate result.
5575892d3179Sdrh */
5576892d3179Sdrh int sqlite3GetTempReg(Parse *pParse){
5577e55cbd72Sdrh   if( pParse->nTempReg==0 ){
5578892d3179Sdrh     return ++pParse->nMem;
5579892d3179Sdrh   }
55802f425f6bSdanielk1977   return pParse->aTempReg[--pParse->nTempReg];
5581892d3179Sdrh }
5582ceea3321Sdrh 
5583ceea3321Sdrh /*
5584ceea3321Sdrh ** Deallocate a register, making available for reuse for some other
5585ceea3321Sdrh ** purpose.
5586ceea3321Sdrh */
5587892d3179Sdrh void sqlite3ReleaseTempReg(Parse *pParse, int iReg){
55882dcef11bSdrh   if( iReg && pParse->nTempReg<ArraySize(pParse->aTempReg) ){
5589892d3179Sdrh     pParse->aTempReg[pParse->nTempReg++] = iReg;
5590892d3179Sdrh   }
5591892d3179Sdrh }
5592892d3179Sdrh 
5593892d3179Sdrh /*
5594ed24da4bSdrh ** Allocate or deallocate a block of nReg consecutive registers.
5595892d3179Sdrh */
5596892d3179Sdrh int sqlite3GetTempRange(Parse *pParse, int nReg){
5597e55cbd72Sdrh   int i, n;
5598ed24da4bSdrh   if( nReg==1 ) return sqlite3GetTempReg(pParse);
5599892d3179Sdrh   i = pParse->iRangeReg;
5600e55cbd72Sdrh   n = pParse->nRangeReg;
5601f49f3523Sdrh   if( nReg<=n ){
5602892d3179Sdrh     pParse->iRangeReg += nReg;
5603892d3179Sdrh     pParse->nRangeReg -= nReg;
5604892d3179Sdrh   }else{
5605892d3179Sdrh     i = pParse->nMem+1;
5606892d3179Sdrh     pParse->nMem += nReg;
5607892d3179Sdrh   }
5608892d3179Sdrh   return i;
5609892d3179Sdrh }
5610892d3179Sdrh void sqlite3ReleaseTempRange(Parse *pParse, int iReg, int nReg){
5611ed24da4bSdrh   if( nReg==1 ){
5612ed24da4bSdrh     sqlite3ReleaseTempReg(pParse, iReg);
5613ed24da4bSdrh     return;
5614ed24da4bSdrh   }
5615892d3179Sdrh   if( nReg>pParse->nRangeReg ){
5616892d3179Sdrh     pParse->nRangeReg = nReg;
5617892d3179Sdrh     pParse->iRangeReg = iReg;
5618892d3179Sdrh   }
5619892d3179Sdrh }
5620cdc69557Sdrh 
5621cdc69557Sdrh /*
5622cdc69557Sdrh ** Mark all temporary registers as being unavailable for reuse.
56236d2566dfSdrh **
56246d2566dfSdrh ** Always invoke this procedure after coding a subroutine or co-routine
56256d2566dfSdrh ** that might be invoked from other parts of the code, to ensure that
56266d2566dfSdrh ** the sub/co-routine does not use registers in common with the code that
56276d2566dfSdrh ** invokes the sub/co-routine.
5628cdc69557Sdrh */
5629cdc69557Sdrh void sqlite3ClearTempRegCache(Parse *pParse){
5630cdc69557Sdrh   pParse->nTempReg = 0;
5631cdc69557Sdrh   pParse->nRangeReg = 0;
5632cdc69557Sdrh }
5633bb9b5f26Sdrh 
5634bb9b5f26Sdrh /*
5635bb9b5f26Sdrh ** Validate that no temporary register falls within the range of
5636bb9b5f26Sdrh ** iFirst..iLast, inclusive.  This routine is only call from within assert()
5637bb9b5f26Sdrh ** statements.
5638bb9b5f26Sdrh */
5639bb9b5f26Sdrh #ifdef SQLITE_DEBUG
5640bb9b5f26Sdrh int sqlite3NoTempsInRange(Parse *pParse, int iFirst, int iLast){
5641bb9b5f26Sdrh   int i;
5642bb9b5f26Sdrh   if( pParse->nRangeReg>0
56433963e584Sdrh    && pParse->iRangeReg+pParse->nRangeReg > iFirst
56443963e584Sdrh    && pParse->iRangeReg <= iLast
5645bb9b5f26Sdrh   ){
5646bb9b5f26Sdrh      return 0;
5647bb9b5f26Sdrh   }
5648bb9b5f26Sdrh   for(i=0; i<pParse->nTempReg; i++){
5649bb9b5f26Sdrh     if( pParse->aTempReg[i]>=iFirst && pParse->aTempReg[i]<=iLast ){
5650bb9b5f26Sdrh       return 0;
5651bb9b5f26Sdrh     }
5652bb9b5f26Sdrh   }
5653bb9b5f26Sdrh   return 1;
5654bb9b5f26Sdrh }
5655bb9b5f26Sdrh #endif /* SQLITE_DEBUG */
5656