xref: /sqlite-3.40.0/src/expr.c (revision 85f2c76c)
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 */
45e7375bfaSdrh char sqlite3ExprAffinity(const 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   }
73db36e255Sdrh   if( op==TK_VECTOR ){
74db36e255Sdrh     return sqlite3ExprAffinity(pExpr->x.pList->a[0].pExpr);
75db36e255Sdrh   }
761194904bSdrh   return pExpr->affExpr;
77a37cdde0Sdanielk1977 }
78a37cdde0Sdanielk1977 
7953db1458Sdrh /*
808b4c40d8Sdrh ** Set the collating sequence for expression pExpr to be the collating
81ae80ddeaSdrh ** sequence named by pToken.   Return a pointer to a new Expr node that
82ae80ddeaSdrh ** implements the COLLATE operator.
830a8a406eSdrh **
840a8a406eSdrh ** If a memory allocation error occurs, that fact is recorded in pParse->db
850a8a406eSdrh ** and the pExpr parameter is returned unchanged.
868b4c40d8Sdrh */
874ef7efadSdrh Expr *sqlite3ExprAddCollateToken(
884ef7efadSdrh   Parse *pParse,           /* Parsing context */
894ef7efadSdrh   Expr *pExpr,             /* Add the "COLLATE" clause to this expression */
9080103fc6Sdan   const Token *pCollName,  /* Name of collating sequence */
9180103fc6Sdan   int dequote              /* True to dequote pCollName */
924ef7efadSdrh ){
930a8a406eSdrh   if( pCollName->n>0 ){
9480103fc6Sdan     Expr *pNew = sqlite3ExprAlloc(pParse->db, TK_COLLATE, pCollName, dequote);
95ae80ddeaSdrh     if( pNew ){
96ae80ddeaSdrh       pNew->pLeft = pExpr;
97a4c3c87eSdrh       pNew->flags |= EP_Collate|EP_Skip;
980a8a406eSdrh       pExpr = pNew;
99ae80ddeaSdrh     }
1000a8a406eSdrh   }
1010a8a406eSdrh   return pExpr;
1020a8a406eSdrh }
1030a8a406eSdrh Expr *sqlite3ExprAddCollateString(Parse *pParse, Expr *pExpr, const char *zC){
1040a8a406eSdrh   Token s;
105261d8a51Sdrh   assert( zC!=0 );
10640aced5cSdrh   sqlite3TokenInit(&s, (char*)zC);
10780103fc6Sdan   return sqlite3ExprAddCollateToken(pParse, pExpr, &s, 0);
1080a8a406eSdrh }
1090a8a406eSdrh 
1100a8a406eSdrh /*
1110d950af3Sdrh ** Skip over any TK_COLLATE operators.
1120a8a406eSdrh */
1130a8a406eSdrh Expr *sqlite3ExprSkipCollate(Expr *pExpr){
1140d950af3Sdrh   while( pExpr && ExprHasProperty(pExpr, EP_Skip) ){
1150d950af3Sdrh     assert( pExpr->op==TK_COLLATE );
1160d950af3Sdrh     pExpr = pExpr->pLeft;
1170d950af3Sdrh   }
1180d950af3Sdrh   return pExpr;
1190d950af3Sdrh }
1200d950af3Sdrh 
1210d950af3Sdrh /*
1220d950af3Sdrh ** Skip over any TK_COLLATE operators and/or any unlikely()
1230d950af3Sdrh ** or likelihood() or likely() functions at the root of an
1240d950af3Sdrh ** expression.
1250d950af3Sdrh */
1260d950af3Sdrh Expr *sqlite3ExprSkipCollateAndLikely(Expr *pExpr){
127a7d6db6aSdrh   while( pExpr && ExprHasProperty(pExpr, EP_Skip|EP_Unlikely) ){
128a4c3c87eSdrh     if( ExprHasProperty(pExpr, EP_Unlikely) ){
129cca9f3d2Sdrh       assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
130cca9f3d2Sdrh       assert( pExpr->x.pList->nExpr>0 );
131a4c3c87eSdrh       assert( pExpr->op==TK_FUNCTION );
132cca9f3d2Sdrh       pExpr = pExpr->x.pList->a[0].pExpr;
133cca9f3d2Sdrh     }else{
1340b8d255cSdrh       assert( pExpr->op==TK_COLLATE );
135d91eba96Sdrh       pExpr = pExpr->pLeft;
136cca9f3d2Sdrh     }
137d91eba96Sdrh   }
1380a8a406eSdrh   return pExpr;
1398b4c40d8Sdrh }
1408b4c40d8Sdrh 
1418b4c40d8Sdrh /*
142ae80ddeaSdrh ** Return the collation sequence for the expression pExpr. If
143ae80ddeaSdrh ** there is no defined collating sequence, return NULL.
144ae80ddeaSdrh **
14570efa84dSdrh ** See also: sqlite3ExprNNCollSeq()
14670efa84dSdrh **
14770efa84dSdrh ** The sqlite3ExprNNCollSeq() works the same exact that it returns the
14870efa84dSdrh ** default collation if pExpr has no defined collation.
14970efa84dSdrh **
150ae80ddeaSdrh ** The collating sequence might be determined by a COLLATE operator
151ae80ddeaSdrh ** or by the presence of a column with a defined collating sequence.
152ae80ddeaSdrh ** COLLATE operators take first precedence.  Left operands take
153ae80ddeaSdrh ** precedence over right operands.
1540202b29eSdanielk1977 */
155e7375bfaSdrh CollSeq *sqlite3ExprCollSeq(Parse *pParse, const Expr *pExpr){
156ae80ddeaSdrh   sqlite3 *db = pParse->db;
1577cedc8d4Sdanielk1977   CollSeq *pColl = 0;
158e7375bfaSdrh   const Expr *p = pExpr;
159261d8a51Sdrh   while( p ){
160ae80ddeaSdrh     int op = p->op;
161cb0e04f9Sdrh     if( op==TK_REGISTER ) op = p->op2;
162cb0e04f9Sdrh     if( (op==TK_AGG_COLUMN || op==TK_COLUMN || op==TK_TRIGGER)
163eda079cdSdrh      && p->y.pTab!=0
164ae80ddeaSdrh     ){
165eda079cdSdrh       /* op==TK_REGISTER && p->y.pTab!=0 happens when pExpr was originally
1667d10d5a6Sdrh       ** a TK_COLUMN but was previously evaluated and cached in a register */
1677d10d5a6Sdrh       int j = p->iColumn;
1687d10d5a6Sdrh       if( j>=0 ){
169eda079cdSdrh         const char *zColl = p->y.pTab->aCol[j].zColl;
170c4a64facSdrh         pColl = sqlite3FindCollSeq(db, ENC(db), zColl, 0);
1710202b29eSdanielk1977       }
1727d10d5a6Sdrh       break;
1737d10d5a6Sdrh     }
174e081d73cSdrh     if( op==TK_CAST || op==TK_UPLUS ){
175e081d73cSdrh       p = p->pLeft;
176e081d73cSdrh       continue;
177e081d73cSdrh     }
178269d322dSdrh     if( op==TK_VECTOR ){
179269d322dSdrh       p = p->x.pList->a[0].pExpr;
180269d322dSdrh       continue;
181269d322dSdrh     }
182cb0e04f9Sdrh     if( op==TK_COLLATE ){
183e081d73cSdrh       pColl = sqlite3GetCollSeq(pParse, ENC(db), 0, p->u.zToken);
184e081d73cSdrh       break;
185e081d73cSdrh     }
186ae80ddeaSdrh     if( p->flags & EP_Collate ){
1872308ed38Sdrh       if( p->pLeft && (p->pLeft->flags & EP_Collate)!=0 ){
1887d10d5a6Sdrh         p = p->pLeft;
189ae80ddeaSdrh       }else{
1902308ed38Sdrh         Expr *pNext  = p->pRight;
1916728cd91Sdrh         /* The Expr.x union is never used at the same time as Expr.pRight */
1926728cd91Sdrh         assert( p->x.pList==0 || p->pRight==0 );
19392a2824cSdrh         if( p->x.pList!=0
19492a2824cSdrh          && !db->mallocFailed
19592a2824cSdrh          && ALWAYS(!ExprHasProperty(p, EP_xIsSelect))
19692a2824cSdrh         ){
1972308ed38Sdrh           int i;
1989576802dSdrh           for(i=0; i<p->x.pList->nExpr; i++){
1992308ed38Sdrh             if( ExprHasProperty(p->x.pList->a[i].pExpr, EP_Collate) ){
2002308ed38Sdrh               pNext = p->x.pList->a[i].pExpr;
2012308ed38Sdrh               break;
2022308ed38Sdrh             }
2032308ed38Sdrh           }
2042308ed38Sdrh         }
2052308ed38Sdrh         p = pNext;
206ae80ddeaSdrh       }
207ae80ddeaSdrh     }else{
208ae80ddeaSdrh       break;
209ae80ddeaSdrh     }
2100202b29eSdanielk1977   }
2117cedc8d4Sdanielk1977   if( sqlite3CheckCollSeq(pParse, pColl) ){
2127cedc8d4Sdanielk1977     pColl = 0;
2137cedc8d4Sdanielk1977   }
2147cedc8d4Sdanielk1977   return pColl;
2150202b29eSdanielk1977 }
2160202b29eSdanielk1977 
2170202b29eSdanielk1977 /*
21870efa84dSdrh ** Return the collation sequence for the expression pExpr. If
21970efa84dSdrh ** there is no defined collating sequence, return a pointer to the
22070efa84dSdrh ** defautl collation sequence.
22170efa84dSdrh **
22270efa84dSdrh ** See also: sqlite3ExprCollSeq()
22370efa84dSdrh **
22470efa84dSdrh ** The sqlite3ExprCollSeq() routine works the same except that it
22570efa84dSdrh ** returns NULL if there is no defined collation.
22670efa84dSdrh */
227e7375bfaSdrh CollSeq *sqlite3ExprNNCollSeq(Parse *pParse, const Expr *pExpr){
22870efa84dSdrh   CollSeq *p = sqlite3ExprCollSeq(pParse, pExpr);
22970efa84dSdrh   if( p==0 ) p = pParse->db->pDfltColl;
23070efa84dSdrh   assert( p!=0 );
23170efa84dSdrh   return p;
23270efa84dSdrh }
23370efa84dSdrh 
23470efa84dSdrh /*
23570efa84dSdrh ** Return TRUE if the two expressions have equivalent collating sequences.
23670efa84dSdrh */
237e7375bfaSdrh int sqlite3ExprCollSeqMatch(Parse *pParse, const Expr *pE1, const Expr *pE2){
23870efa84dSdrh   CollSeq *pColl1 = sqlite3ExprNNCollSeq(pParse, pE1);
23970efa84dSdrh   CollSeq *pColl2 = sqlite3ExprNNCollSeq(pParse, pE2);
24070efa84dSdrh   return sqlite3StrICmp(pColl1->zName, pColl2->zName)==0;
24170efa84dSdrh }
24270efa84dSdrh 
24370efa84dSdrh /*
244626a879aSdrh ** pExpr is an operand of a comparison operator.  aff2 is the
245626a879aSdrh ** type affinity of the other operand.  This routine returns the
24653db1458Sdrh ** type affinity that should be used for the comparison operator.
24753db1458Sdrh */
248e7375bfaSdrh char sqlite3CompareAffinity(const Expr *pExpr, char aff2){
249bf3b721fSdanielk1977   char aff1 = sqlite3ExprAffinity(pExpr);
25096fb16eeSdrh   if( aff1>SQLITE_AFF_NONE && aff2>SQLITE_AFF_NONE ){
2518df447f0Sdrh     /* Both sides of the comparison are columns. If one has numeric
2528df447f0Sdrh     ** affinity, use that. Otherwise use no affinity.
253e014a838Sdanielk1977     */
2548a51256cSdrh     if( sqlite3IsNumericAffinity(aff1) || sqlite3IsNumericAffinity(aff2) ){
255e014a838Sdanielk1977       return SQLITE_AFF_NUMERIC;
256e014a838Sdanielk1977     }else{
25705883a34Sdrh       return SQLITE_AFF_BLOB;
258e014a838Sdanielk1977     }
259e014a838Sdanielk1977   }else{
260e014a838Sdanielk1977     /* One side is a column, the other is not. Use the columns affinity. */
26196fb16eeSdrh     assert( aff1<=SQLITE_AFF_NONE || aff2<=SQLITE_AFF_NONE );
26296fb16eeSdrh     return (aff1<=SQLITE_AFF_NONE ? aff2 : aff1) | SQLITE_AFF_NONE;
263e014a838Sdanielk1977   }
264e014a838Sdanielk1977 }
265e014a838Sdanielk1977 
26653db1458Sdrh /*
26753db1458Sdrh ** pExpr is a comparison operator.  Return the type affinity that should
26853db1458Sdrh ** be applied to both operands prior to doing the comparison.
26953db1458Sdrh */
270e7375bfaSdrh static char comparisonAffinity(const Expr *pExpr){
271e014a838Sdanielk1977   char aff;
272e014a838Sdanielk1977   assert( pExpr->op==TK_EQ || pExpr->op==TK_IN || pExpr->op==TK_LT ||
273e014a838Sdanielk1977           pExpr->op==TK_GT || pExpr->op==TK_GE || pExpr->op==TK_LE ||
2746a2fe093Sdrh           pExpr->op==TK_NE || pExpr->op==TK_IS || pExpr->op==TK_ISNOT );
275e014a838Sdanielk1977   assert( pExpr->pLeft );
276bf3b721fSdanielk1977   aff = sqlite3ExprAffinity(pExpr->pLeft);
277e014a838Sdanielk1977   if( pExpr->pRight ){
278e014a838Sdanielk1977     aff = sqlite3CompareAffinity(pExpr->pRight, aff);
2796ab3a2ecSdanielk1977   }else if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2806ab3a2ecSdanielk1977     aff = sqlite3CompareAffinity(pExpr->x.pSelect->pEList->a[0].pExpr, aff);
28113ac46eeSdrh   }else if( aff==0 ){
28205883a34Sdrh     aff = SQLITE_AFF_BLOB;
283e014a838Sdanielk1977   }
284e014a838Sdanielk1977   return aff;
285e014a838Sdanielk1977 }
286e014a838Sdanielk1977 
287e014a838Sdanielk1977 /*
288e014a838Sdanielk1977 ** pExpr is a comparison expression, eg. '=', '<', IN(...) etc.
289e014a838Sdanielk1977 ** idx_affinity is the affinity of an indexed column. Return true
290e014a838Sdanielk1977 ** if the index with affinity idx_affinity may be used to implement
291e014a838Sdanielk1977 ** the comparison in pExpr.
292e014a838Sdanielk1977 */
293e7375bfaSdrh int sqlite3IndexAffinityOk(const Expr *pExpr, char idx_affinity){
294e014a838Sdanielk1977   char aff = comparisonAffinity(pExpr);
295915e434cSdrh   if( aff<SQLITE_AFF_TEXT ){
2968a51256cSdrh     return 1;
2978a51256cSdrh   }
298915e434cSdrh   if( aff==SQLITE_AFF_TEXT ){
299915e434cSdrh     return idx_affinity==SQLITE_AFF_TEXT;
300915e434cSdrh   }
301915e434cSdrh   return sqlite3IsNumericAffinity(idx_affinity);
302e014a838Sdanielk1977 }
303e014a838Sdanielk1977 
304a37cdde0Sdanielk1977 /*
30535573356Sdrh ** Return the P5 value that should be used for a binary comparison
306a37cdde0Sdanielk1977 ** opcode (OP_Eq, OP_Ge etc.) used to compare pExpr1 and pExpr2.
307a37cdde0Sdanielk1977 */
308e7375bfaSdrh static u8 binaryCompareP5(
309e7375bfaSdrh   const Expr *pExpr1,   /* Left operand */
310e7375bfaSdrh   const Expr *pExpr2,   /* Right operand */
311e7375bfaSdrh   int jumpIfNull        /* Extra flags added to P5 */
312e7375bfaSdrh ){
31335573356Sdrh   u8 aff = (char)sqlite3ExprAffinity(pExpr2);
3141bd10f8aSdrh   aff = (u8)sqlite3CompareAffinity(pExpr1, aff) | (u8)jumpIfNull;
31535573356Sdrh   return aff;
316a37cdde0Sdanielk1977 }
317a37cdde0Sdanielk1977 
318a2e00042Sdrh /*
3190202b29eSdanielk1977 ** Return a pointer to the collation sequence that should be used by
3200202b29eSdanielk1977 ** a binary comparison operator comparing pLeft and pRight.
3210202b29eSdanielk1977 **
3220202b29eSdanielk1977 ** If the left hand expression has a collating sequence type, then it is
3230202b29eSdanielk1977 ** used. Otherwise the collation sequence for the right hand expression
3240202b29eSdanielk1977 ** is used, or the default (BINARY) if neither expression has a collating
3250202b29eSdanielk1977 ** type.
326bcbb04e5Sdanielk1977 **
327bcbb04e5Sdanielk1977 ** Argument pRight (but not pLeft) may be a null pointer. In this case,
328bcbb04e5Sdanielk1977 ** it is not considered.
3290202b29eSdanielk1977 */
330bcbb04e5Sdanielk1977 CollSeq *sqlite3BinaryCompareCollSeq(
331bcbb04e5Sdanielk1977   Parse *pParse,
332e7375bfaSdrh   const Expr *pLeft,
333e7375bfaSdrh   const Expr *pRight
334bcbb04e5Sdanielk1977 ){
335ec41ddacSdrh   CollSeq *pColl;
336ec41ddacSdrh   assert( pLeft );
337ae80ddeaSdrh   if( pLeft->flags & EP_Collate ){
338ae80ddeaSdrh     pColl = sqlite3ExprCollSeq(pParse, pLeft);
339ae80ddeaSdrh   }else if( pRight && (pRight->flags & EP_Collate)!=0 ){
340ae80ddeaSdrh     pColl = sqlite3ExprCollSeq(pParse, pRight);
341ec41ddacSdrh   }else{
342ec41ddacSdrh     pColl = sqlite3ExprCollSeq(pParse, pLeft);
3430202b29eSdanielk1977     if( !pColl ){
3447cedc8d4Sdanielk1977       pColl = sqlite3ExprCollSeq(pParse, pRight);
3450202b29eSdanielk1977     }
346ec41ddacSdrh   }
3470202b29eSdanielk1977   return pColl;
3480202b29eSdanielk1977 }
3490202b29eSdanielk1977 
350898c527eSdrh /* Expresssion p is a comparison operator.  Return a collation sequence
351898c527eSdrh ** appropriate for the comparison operator.
352898c527eSdrh **
353898c527eSdrh ** This is normally just a wrapper around sqlite3BinaryCompareCollSeq().
354898c527eSdrh ** However, if the OP_Commuted flag is set, then the order of the operands
355898c527eSdrh ** is reversed in the sqlite3BinaryCompareCollSeq() call so that the
356898c527eSdrh ** correct collating sequence is found.
357898c527eSdrh */
358e7375bfaSdrh CollSeq *sqlite3ExprCompareCollSeq(Parse *pParse, const Expr *p){
359898c527eSdrh   if( ExprHasProperty(p, EP_Commuted) ){
360898c527eSdrh     return sqlite3BinaryCompareCollSeq(pParse, p->pRight, p->pLeft);
361898c527eSdrh   }else{
362898c527eSdrh     return sqlite3BinaryCompareCollSeq(pParse, p->pLeft, p->pRight);
363898c527eSdrh   }
364898c527eSdrh }
365898c527eSdrh 
3660202b29eSdanielk1977 /*
367be5c89acSdrh ** Generate code for a comparison operator.
368be5c89acSdrh */
369be5c89acSdrh static int codeCompare(
370be5c89acSdrh   Parse *pParse,    /* The parsing (and code generating) context */
371be5c89acSdrh   Expr *pLeft,      /* The left operand */
372be5c89acSdrh   Expr *pRight,     /* The right operand */
373be5c89acSdrh   int opcode,       /* The comparison opcode */
37435573356Sdrh   int in1, int in2, /* Register holding operands */
375be5c89acSdrh   int dest,         /* Jump here if true.  */
376898c527eSdrh   int jumpIfNull,   /* If true, jump if either operand is NULL */
377898c527eSdrh   int isCommuted    /* The comparison has been commuted */
378be5c89acSdrh ){
37935573356Sdrh   int p5;
38035573356Sdrh   int addr;
38135573356Sdrh   CollSeq *p4;
38235573356Sdrh 
3838654186bSdrh   if( pParse->nErr ) return 0;
384898c527eSdrh   if( isCommuted ){
385898c527eSdrh     p4 = sqlite3BinaryCompareCollSeq(pParse, pRight, pLeft);
386898c527eSdrh   }else{
38735573356Sdrh     p4 = sqlite3BinaryCompareCollSeq(pParse, pLeft, pRight);
388898c527eSdrh   }
38935573356Sdrh   p5 = binaryCompareP5(pLeft, pRight, jumpIfNull);
39035573356Sdrh   addr = sqlite3VdbeAddOp4(pParse->pVdbe, opcode, in2, dest, in1,
39135573356Sdrh                            (void*)p4, P4_COLLSEQ);
3921bd10f8aSdrh   sqlite3VdbeChangeP5(pParse->pVdbe, (u8)p5);
39335573356Sdrh   return addr;
394be5c89acSdrh }
395be5c89acSdrh 
396cfbb5e82Sdan /*
397870a0705Sdan ** Return true if expression pExpr is a vector, or false otherwise.
398d832da7fSdrh **
399d832da7fSdrh ** A vector is defined as any expression that results in two or more
400d832da7fSdrh ** columns of result.  Every TK_VECTOR node is an vector because the
401d832da7fSdrh ** parser will not generate a TK_VECTOR with fewer than two entries.
402d832da7fSdrh ** But a TK_SELECT might be either a vector or a scalar. It is only
403d832da7fSdrh ** considered a vector if it has two or more result columns.
404870a0705Sdan */
405870a0705Sdan int sqlite3ExprIsVector(Expr *pExpr){
40676dbe7a8Sdrh   return sqlite3ExprVectorSize(pExpr)>1;
407870a0705Sdan }
408870a0705Sdan 
409870a0705Sdan /*
410cfbb5e82Sdan ** If the expression passed as the only argument is of type TK_VECTOR
411cfbb5e82Sdan ** return the number of expressions in the vector. Or, if the expression
412cfbb5e82Sdan ** is a sub-select, return the number of columns in the sub-select. For
413cfbb5e82Sdan ** any other type of expression, return 1.
414cfbb5e82Sdan */
41571c57db0Sdan int sqlite3ExprVectorSize(Expr *pExpr){
41612abf408Sdrh   u8 op = pExpr->op;
41712abf408Sdrh   if( op==TK_REGISTER ) op = pExpr->op2;
41812abf408Sdrh   if( op==TK_VECTOR ){
41971c57db0Sdan     return pExpr->x.pList->nExpr;
42012abf408Sdrh   }else if( op==TK_SELECT ){
42176dbe7a8Sdrh     return pExpr->x.pSelect->pEList->nExpr;
42276dbe7a8Sdrh   }else{
42376dbe7a8Sdrh     return 1;
42476dbe7a8Sdrh   }
42571c57db0Sdan }
42671c57db0Sdan 
427ba00e30aSdan /*
428fc7f27b9Sdrh ** Return a pointer to a subexpression of pVector that is the i-th
429fc7f27b9Sdrh ** column of the vector (numbered starting with 0).  The caller must
430fc7f27b9Sdrh ** ensure that i is within range.
431fc7f27b9Sdrh **
43276dbe7a8Sdrh ** If pVector is really a scalar (and "scalar" here includes subqueries
43376dbe7a8Sdrh ** that return a single column!) then return pVector unmodified.
43476dbe7a8Sdrh **
435fc7f27b9Sdrh ** pVector retains ownership of the returned subexpression.
436fc7f27b9Sdrh **
437fc7f27b9Sdrh ** If the vector is a (SELECT ...) then the expression returned is
43876dbe7a8Sdrh ** just the expression for the i-th term of the result set, and may
43976dbe7a8Sdrh ** not be ready for evaluation because the table cursor has not yet
44076dbe7a8Sdrh ** been positioned.
441ba00e30aSdan */
442fc7f27b9Sdrh Expr *sqlite3VectorFieldSubexpr(Expr *pVector, int i){
443870a0705Sdan   assert( i<sqlite3ExprVectorSize(pVector) );
444870a0705Sdan   if( sqlite3ExprIsVector(pVector) ){
4459f24b53dSdrh     assert( pVector->op2==0 || pVector->op==TK_REGISTER );
4469f24b53dSdrh     if( pVector->op==TK_SELECT || pVector->op2==TK_SELECT ){
44771c57db0Sdan       return pVector->x.pSelect->pEList->a[i].pExpr;
448870a0705Sdan     }else{
44971c57db0Sdan       return pVector->x.pList->a[i].pExpr;
45071c57db0Sdan     }
451870a0705Sdan   }
452870a0705Sdan   return pVector;
453870a0705Sdan }
454fc7f27b9Sdrh 
455fc7f27b9Sdrh /*
456fc7f27b9Sdrh ** Compute and return a new Expr object which when passed to
457fc7f27b9Sdrh ** sqlite3ExprCode() will generate all necessary code to compute
458fc7f27b9Sdrh ** the iField-th column of the vector expression pVector.
459fc7f27b9Sdrh **
4608762ec19Sdrh ** It is ok for pVector to be a scalar (as long as iField==0).
4618762ec19Sdrh ** In that case, this routine works like sqlite3ExprDup().
4628762ec19Sdrh **
463fc7f27b9Sdrh ** The caller owns the returned Expr object and is responsible for
464fc7f27b9Sdrh ** ensuring that the returned value eventually gets freed.
465fc7f27b9Sdrh **
4668762ec19Sdrh ** The caller retains ownership of pVector.  If pVector is a TK_SELECT,
467fad0e70cSdan ** then the returned object will reference pVector and so pVector must remain
4688762ec19Sdrh ** valid for the life of the returned object.  If pVector is a TK_VECTOR
4698762ec19Sdrh ** or a scalar expression, then it can be deleted as soon as this routine
47076dbe7a8Sdrh ** returns.
4718762ec19Sdrh **
4728762ec19Sdrh ** A trick to cause a TK_SELECT pVector to be deleted together with
4738762ec19Sdrh ** the returned Expr object is to attach the pVector to the pRight field
4748762ec19Sdrh ** of the returned TK_SELECT_COLUMN Expr object.
475fc7f27b9Sdrh */
476fc7f27b9Sdrh Expr *sqlite3ExprForVectorField(
477fc7f27b9Sdrh   Parse *pParse,       /* Parsing context */
478fc7f27b9Sdrh   Expr *pVector,       /* The vector.  List of expressions or a sub-SELECT */
479a1251bc4Sdrh   int iField           /* Which column of the vector to return */
480fc7f27b9Sdrh ){
481fc7f27b9Sdrh   Expr *pRet;
482a1251bc4Sdrh   if( pVector->op==TK_SELECT ){
483a1251bc4Sdrh     assert( pVector->flags & EP_xIsSelect );
484fc7f27b9Sdrh     /* The TK_SELECT_COLUMN Expr node:
485fc7f27b9Sdrh     **
486966e2911Sdrh     ** pLeft:           pVector containing TK_SELECT.  Not deleted.
4878762ec19Sdrh     ** pRight:          not used.  But recursively deleted.
488fc7f27b9Sdrh     ** iColumn:         Index of a column in pVector
489966e2911Sdrh     ** iTable:          0 or the number of columns on the LHS of an assignment
490fc7f27b9Sdrh     ** pLeft->iTable:   First in an array of register holding result, or 0
491fc7f27b9Sdrh     **                  if the result is not yet computed.
492fc7f27b9Sdrh     **
493fc7f27b9Sdrh     ** sqlite3ExprDelete() specifically skips the recursive delete of
494fc7f27b9Sdrh     ** pLeft on TK_SELECT_COLUMN nodes.  But pRight is followed, so pVector
4958762ec19Sdrh     ** can be attached to pRight to cause this node to take ownership of
4968762ec19Sdrh     ** pVector.  Typically there will be multiple TK_SELECT_COLUMN nodes
4978762ec19Sdrh     ** with the same pLeft pointer to the pVector, but only one of them
4988762ec19Sdrh     ** will own the pVector.
499fc7f27b9Sdrh     */
500abfd35eaSdrh     pRet = sqlite3PExpr(pParse, TK_SELECT_COLUMN, 0, 0);
5018bd0d58eSdrh     if( pRet ){
5028bd0d58eSdrh       pRet->iColumn = iField;
5038bd0d58eSdrh       pRet->pLeft = pVector;
5048bd0d58eSdrh     }
505fc7f27b9Sdrh     assert( pRet==0 || pRet->iTable==0 );
506fc7f27b9Sdrh   }else{
507a1251bc4Sdrh     if( pVector->op==TK_VECTOR ) pVector = pVector->x.pList->a[iField].pExpr;
508a1251bc4Sdrh     pRet = sqlite3ExprDup(pParse->db, pVector, 0);
509dfb5c963Sdan     sqlite3RenameTokenRemap(pParse, pRet, pVector);
510fc7f27b9Sdrh   }
511fc7f27b9Sdrh   return pRet;
512fc7f27b9Sdrh }
51371c57db0Sdan 
5145c288b92Sdan /*
5155c288b92Sdan ** If expression pExpr is of type TK_SELECT, generate code to evaluate
5165c288b92Sdan ** it. Return the register in which the result is stored (or, if the
5175c288b92Sdan ** sub-select returns more than one column, the first in an array
5185c288b92Sdan ** of registers in which the result is stored).
5195c288b92Sdan **
5205c288b92Sdan ** If pExpr is not a TK_SELECT expression, return 0.
5215c288b92Sdan */
5225c288b92Sdan static int exprCodeSubselect(Parse *pParse, Expr *pExpr){
5238da209b1Sdan   int reg = 0;
524f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
5255c288b92Sdan   if( pExpr->op==TK_SELECT ){
52685bcdce2Sdrh     reg = sqlite3CodeSubselect(pParse, pExpr);
5278da209b1Sdan   }
528f9b2e05cSdan #endif
5298da209b1Sdan   return reg;
5308da209b1Sdan }
5318da209b1Sdan 
5325c288b92Sdan /*
5335c288b92Sdan ** Argument pVector points to a vector expression - either a TK_VECTOR
534870a0705Sdan ** or TK_SELECT that returns more than one column. This function returns
535870a0705Sdan ** the register number of a register that contains the value of
536870a0705Sdan ** element iField of the vector.
537870a0705Sdan **
538870a0705Sdan ** If pVector is a TK_SELECT expression, then code for it must have
539870a0705Sdan ** already been generated using the exprCodeSubselect() routine. In this
540870a0705Sdan ** case parameter regSelect should be the first in an array of registers
541870a0705Sdan ** containing the results of the sub-select.
542870a0705Sdan **
543870a0705Sdan ** If pVector is of type TK_VECTOR, then code for the requested field
544870a0705Sdan ** is generated. In this case (*pRegFree) may be set to the number of
545870a0705Sdan ** a temporary register to be freed by the caller before returning.
5465c288b92Sdan **
5475c288b92Sdan ** Before returning, output parameter (*ppExpr) is set to point to the
5485c288b92Sdan ** Expr object corresponding to element iElem of the vector.
5495c288b92Sdan */
5505c288b92Sdan static int exprVectorRegister(
5515c288b92Sdan   Parse *pParse,                  /* Parse context */
5525c288b92Sdan   Expr *pVector,                  /* Vector to extract element from */
553870a0705Sdan   int iField,                     /* Field to extract from pVector */
5545c288b92Sdan   int regSelect,                  /* First in array of registers */
5555c288b92Sdan   Expr **ppExpr,                  /* OUT: Expression element */
5565c288b92Sdan   int *pRegFree                   /* OUT: Temp register to free */
5575c288b92Sdan ){
55812abf408Sdrh   u8 op = pVector->op;
559c1bcd9ccSdrh   assert( op==TK_VECTOR || op==TK_REGISTER || op==TK_SELECT );
56012abf408Sdrh   if( op==TK_REGISTER ){
56112abf408Sdrh     *ppExpr = sqlite3VectorFieldSubexpr(pVector, iField);
56212abf408Sdrh     return pVector->iTable+iField;
56312abf408Sdrh   }
56412abf408Sdrh   if( op==TK_SELECT ){
565870a0705Sdan     *ppExpr = pVector->x.pSelect->pEList->a[iField].pExpr;
566870a0705Sdan      return regSelect+iField;
5675c288b92Sdan   }
568870a0705Sdan   *ppExpr = pVector->x.pList->a[iField].pExpr;
5695c288b92Sdan   return sqlite3ExprCodeTemp(pParse, *ppExpr, pRegFree);
5705c288b92Sdan }
5715c288b92Sdan 
5725c288b92Sdan /*
5735c288b92Sdan ** Expression pExpr is a comparison between two vector values. Compute
57479752b6eSdrh ** the result of the comparison (1, 0, or NULL) and write that
57579752b6eSdrh ** result into register dest.
57679752b6eSdrh **
57779752b6eSdrh ** The caller must satisfy the following preconditions:
57879752b6eSdrh **
57979752b6eSdrh **    if pExpr->op==TK_IS:      op==TK_EQ and p5==SQLITE_NULLEQ
58079752b6eSdrh **    if pExpr->op==TK_ISNOT:   op==TK_NE and p5==SQLITE_NULLEQ
58179752b6eSdrh **    otherwise:                op==pExpr->op and p5==0
5825c288b92Sdan */
58379752b6eSdrh static void codeVectorCompare(
58479752b6eSdrh   Parse *pParse,        /* Code generator context */
58579752b6eSdrh   Expr *pExpr,          /* The comparison operation */
58679752b6eSdrh   int dest,             /* Write results into this register */
58779752b6eSdrh   u8 op,                /* Comparison operator */
58879752b6eSdrh   u8 p5                 /* SQLITE_NULLEQ or zero */
58979752b6eSdrh ){
59071c57db0Sdan   Vdbe *v = pParse->pVdbe;
59171c57db0Sdan   Expr *pLeft = pExpr->pLeft;
59271c57db0Sdan   Expr *pRight = pExpr->pRight;
59371c57db0Sdan   int nLeft = sqlite3ExprVectorSize(pLeft);
59471c57db0Sdan   int i;
59571c57db0Sdan   int regLeft = 0;
59671c57db0Sdan   int regRight = 0;
59779752b6eSdrh   u8 opx = op;
598ec4ccdbcSdrh   int addrDone = sqlite3VdbeMakeLabel(pParse);
599898c527eSdrh   int isCommuted = ExprHasProperty(pExpr,EP_Commuted);
60071c57db0Sdan 
601e7375bfaSdrh   assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
60270d6b832Sdrh   if( pParse->nErr ) return;
603245ce62eSdrh   if( nLeft!=sqlite3ExprVectorSize(pRight) ){
604245ce62eSdrh     sqlite3ErrorMsg(pParse, "row value misused");
605245ce62eSdrh     return;
606245ce62eSdrh   }
60771c57db0Sdan   assert( pExpr->op==TK_EQ || pExpr->op==TK_NE
60871c57db0Sdan        || pExpr->op==TK_IS || pExpr->op==TK_ISNOT
60971c57db0Sdan        || pExpr->op==TK_LT || pExpr->op==TK_GT
61071c57db0Sdan        || pExpr->op==TK_LE || pExpr->op==TK_GE
61171c57db0Sdan   );
61279752b6eSdrh   assert( pExpr->op==op || (pExpr->op==TK_IS && op==TK_EQ)
61379752b6eSdrh             || (pExpr->op==TK_ISNOT && op==TK_NE) );
61479752b6eSdrh   assert( p5==0 || pExpr->op!=op );
61579752b6eSdrh   assert( p5==SQLITE_NULLEQ || pExpr->op==op );
61671c57db0Sdan 
61779752b6eSdrh   p5 |= SQLITE_STOREP2;
61879752b6eSdrh   if( opx==TK_LE ) opx = TK_LT;
61979752b6eSdrh   if( opx==TK_GE ) opx = TK_GT;
6205c288b92Sdan 
6215c288b92Sdan   regLeft = exprCodeSubselect(pParse, pLeft);
6225c288b92Sdan   regRight = exprCodeSubselect(pParse, pRight);
6235c288b92Sdan 
624321e828dSdrh   for(i=0; 1 /*Loop exits by "break"*/; i++){
6255c288b92Sdan     int regFree1 = 0, regFree2 = 0;
6265c288b92Sdan     Expr *pL, *pR;
6275c288b92Sdan     int r1, r2;
628321e828dSdrh     assert( i>=0 && i<nLeft );
6295c288b92Sdan     r1 = exprVectorRegister(pParse, pLeft, i, regLeft, &pL, &regFree1);
6305c288b92Sdan     r2 = exprVectorRegister(pParse, pRight, i, regRight, &pR, &regFree2);
631898c527eSdrh     codeCompare(pParse, pL, pR, opx, r1, r2, dest, p5, isCommuted);
63279752b6eSdrh     testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
63379752b6eSdrh     testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
63479752b6eSdrh     testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
63579752b6eSdrh     testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
63679752b6eSdrh     testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
63779752b6eSdrh     testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
63871c57db0Sdan     sqlite3ReleaseTempReg(pParse, regFree1);
63971c57db0Sdan     sqlite3ReleaseTempReg(pParse, regFree2);
64079752b6eSdrh     if( i==nLeft-1 ){
64179752b6eSdrh       break;
64271c57db0Sdan     }
64379752b6eSdrh     if( opx==TK_EQ ){
64479752b6eSdrh       sqlite3VdbeAddOp2(v, OP_IfNot, dest, addrDone); VdbeCoverage(v);
64579752b6eSdrh       p5 |= SQLITE_KEEPNULL;
64679752b6eSdrh     }else if( opx==TK_NE ){
64779752b6eSdrh       sqlite3VdbeAddOp2(v, OP_If, dest, addrDone); VdbeCoverage(v);
64879752b6eSdrh       p5 |= SQLITE_KEEPNULL;
649a2f62925Sdrh     }else{
650a2f62925Sdrh       assert( op==TK_LT || op==TK_GT || op==TK_LE || op==TK_GE );
651a2f62925Sdrh       sqlite3VdbeAddOp2(v, OP_ElseNotEq, 0, addrDone);
65279752b6eSdrh       VdbeCoverageIf(v, op==TK_LT);
65379752b6eSdrh       VdbeCoverageIf(v, op==TK_GT);
65479752b6eSdrh       VdbeCoverageIf(v, op==TK_LE);
65579752b6eSdrh       VdbeCoverageIf(v, op==TK_GE);
65679752b6eSdrh       if( i==nLeft-2 ) opx = op;
65771c57db0Sdan     }
65879752b6eSdrh   }
65979752b6eSdrh   sqlite3VdbeResolveLabel(v, addrDone);
66079752b6eSdrh }
66171c57db0Sdan 
6624b5255acSdanielk1977 #if SQLITE_MAX_EXPR_DEPTH>0
6634b5255acSdanielk1977 /*
6644b5255acSdanielk1977 ** Check that argument nHeight is less than or equal to the maximum
6654b5255acSdanielk1977 ** expression depth allowed. If it is not, leave an error message in
6664b5255acSdanielk1977 ** pParse.
6674b5255acSdanielk1977 */
6687d10d5a6Sdrh int sqlite3ExprCheckHeight(Parse *pParse, int nHeight){
6694b5255acSdanielk1977   int rc = SQLITE_OK;
6704b5255acSdanielk1977   int mxHeight = pParse->db->aLimit[SQLITE_LIMIT_EXPR_DEPTH];
6714b5255acSdanielk1977   if( nHeight>mxHeight ){
6724b5255acSdanielk1977     sqlite3ErrorMsg(pParse,
6734b5255acSdanielk1977        "Expression tree is too large (maximum depth %d)", mxHeight
6744b5255acSdanielk1977     );
6754b5255acSdanielk1977     rc = SQLITE_ERROR;
6764b5255acSdanielk1977   }
6774b5255acSdanielk1977   return rc;
6784b5255acSdanielk1977 }
6794b5255acSdanielk1977 
6804b5255acSdanielk1977 /* The following three functions, heightOfExpr(), heightOfExprList()
6814b5255acSdanielk1977 ** and heightOfSelect(), are used to determine the maximum height
6824b5255acSdanielk1977 ** of any expression tree referenced by the structure passed as the
6834b5255acSdanielk1977 ** first argument.
6844b5255acSdanielk1977 **
6854b5255acSdanielk1977 ** If this maximum height is greater than the current value pointed
6864b5255acSdanielk1977 ** to by pnHeight, the second parameter, then set *pnHeight to that
6874b5255acSdanielk1977 ** value.
6884b5255acSdanielk1977 */
6894b5255acSdanielk1977 static void heightOfExpr(Expr *p, int *pnHeight){
6904b5255acSdanielk1977   if( p ){
6914b5255acSdanielk1977     if( p->nHeight>*pnHeight ){
6924b5255acSdanielk1977       *pnHeight = p->nHeight;
6934b5255acSdanielk1977     }
6944b5255acSdanielk1977   }
6954b5255acSdanielk1977 }
6964b5255acSdanielk1977 static void heightOfExprList(ExprList *p, int *pnHeight){
6974b5255acSdanielk1977   if( p ){
6984b5255acSdanielk1977     int i;
6994b5255acSdanielk1977     for(i=0; i<p->nExpr; i++){
7004b5255acSdanielk1977       heightOfExpr(p->a[i].pExpr, pnHeight);
7014b5255acSdanielk1977     }
7024b5255acSdanielk1977   }
7034b5255acSdanielk1977 }
7041a3a3086Sdan static void heightOfSelect(Select *pSelect, int *pnHeight){
7051a3a3086Sdan   Select *p;
7061a3a3086Sdan   for(p=pSelect; p; p=p->pPrior){
7074b5255acSdanielk1977     heightOfExpr(p->pWhere, pnHeight);
7084b5255acSdanielk1977     heightOfExpr(p->pHaving, pnHeight);
7094b5255acSdanielk1977     heightOfExpr(p->pLimit, pnHeight);
7104b5255acSdanielk1977     heightOfExprList(p->pEList, pnHeight);
7114b5255acSdanielk1977     heightOfExprList(p->pGroupBy, pnHeight);
7124b5255acSdanielk1977     heightOfExprList(p->pOrderBy, pnHeight);
7134b5255acSdanielk1977   }
7144b5255acSdanielk1977 }
7154b5255acSdanielk1977 
7164b5255acSdanielk1977 /*
7174b5255acSdanielk1977 ** Set the Expr.nHeight variable in the structure passed as an
7184b5255acSdanielk1977 ** argument. An expression with no children, Expr.pList or
7194b5255acSdanielk1977 ** Expr.pSelect member has a height of 1. Any other expression
7204b5255acSdanielk1977 ** has a height equal to the maximum height of any other
7214b5255acSdanielk1977 ** referenced Expr plus one.
7222308ed38Sdrh **
7232308ed38Sdrh ** Also propagate EP_Propagate flags up from Expr.x.pList to Expr.flags,
7242308ed38Sdrh ** if appropriate.
7254b5255acSdanielk1977 */
7264b5255acSdanielk1977 static void exprSetHeight(Expr *p){
7274b5255acSdanielk1977   int nHeight = 0;
7284b5255acSdanielk1977   heightOfExpr(p->pLeft, &nHeight);
7294b5255acSdanielk1977   heightOfExpr(p->pRight, &nHeight);
7306ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_xIsSelect) ){
7316ab3a2ecSdanielk1977     heightOfSelect(p->x.pSelect, &nHeight);
7322308ed38Sdrh   }else if( p->x.pList ){
7336ab3a2ecSdanielk1977     heightOfExprList(p->x.pList, &nHeight);
7342308ed38Sdrh     p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
7356ab3a2ecSdanielk1977   }
7364b5255acSdanielk1977   p->nHeight = nHeight + 1;
7374b5255acSdanielk1977 }
7384b5255acSdanielk1977 
7394b5255acSdanielk1977 /*
7404b5255acSdanielk1977 ** Set the Expr.nHeight variable using the exprSetHeight() function. If
7414b5255acSdanielk1977 ** the height is greater than the maximum allowed expression depth,
7424b5255acSdanielk1977 ** leave an error in pParse.
7432308ed38Sdrh **
7442308ed38Sdrh ** Also propagate all EP_Propagate flags from the Expr.x.pList into
7452308ed38Sdrh ** Expr.flags.
7464b5255acSdanielk1977 */
7472308ed38Sdrh void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
74874893a4cSdrh   if( pParse->nErr ) return;
7494b5255acSdanielk1977   exprSetHeight(p);
7507d10d5a6Sdrh   sqlite3ExprCheckHeight(pParse, p->nHeight);
7514b5255acSdanielk1977 }
7524b5255acSdanielk1977 
7534b5255acSdanielk1977 /*
7544b5255acSdanielk1977 ** Return the maximum height of any expression tree referenced
7554b5255acSdanielk1977 ** by the select statement passed as an argument.
7564b5255acSdanielk1977 */
7574b5255acSdanielk1977 int sqlite3SelectExprHeight(Select *p){
7584b5255acSdanielk1977   int nHeight = 0;
7594b5255acSdanielk1977   heightOfSelect(p, &nHeight);
7604b5255acSdanielk1977   return nHeight;
7614b5255acSdanielk1977 }
7622308ed38Sdrh #else /* ABOVE:  Height enforcement enabled.  BELOW: Height enforcement off */
7632308ed38Sdrh /*
7642308ed38Sdrh ** Propagate all EP_Propagate flags from the Expr.x.pList into
7652308ed38Sdrh ** Expr.flags.
7662308ed38Sdrh */
7672308ed38Sdrh void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
7682308ed38Sdrh   if( p && p->x.pList && !ExprHasProperty(p, EP_xIsSelect) ){
7692308ed38Sdrh     p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
7702308ed38Sdrh   }
7712308ed38Sdrh }
7724b5255acSdanielk1977 #define exprSetHeight(y)
7734b5255acSdanielk1977 #endif /* SQLITE_MAX_EXPR_DEPTH>0 */
7744b5255acSdanielk1977 
775be5c89acSdrh /*
776b7916a78Sdrh ** This routine is the core allocator for Expr nodes.
777b7916a78Sdrh **
778a76b5dfcSdrh ** Construct a new expression node and return a pointer to it.  Memory
779b7916a78Sdrh ** for this node and for the pToken argument is a single allocation
780b7916a78Sdrh ** obtained from sqlite3DbMalloc().  The calling function
781a76b5dfcSdrh ** is responsible for making sure the node eventually gets freed.
782b7916a78Sdrh **
783b7916a78Sdrh ** If dequote is true, then the token (if it exists) is dequoted.
784e792b5b4Sdrh ** If dequote is false, no dequoting is performed.  The deQuote
785b7916a78Sdrh ** parameter is ignored if pToken is NULL or if the token does not
786b7916a78Sdrh ** appear to be quoted.  If the quotes were of the form "..." (double-quotes)
787b7916a78Sdrh ** then the EP_DblQuoted flag is set on the expression node.
78833e619fcSdrh **
78933e619fcSdrh ** Special case:  If op==TK_INTEGER and pToken points to a string that
79033e619fcSdrh ** can be translated into a 32-bit integer, then the token is not
79133e619fcSdrh ** stored in u.zToken.  Instead, the integer values is written
79233e619fcSdrh ** into u.iValue and the EP_IntValue flag is set.  No extra storage
79333e619fcSdrh ** is allocated to hold the integer text and the dequote flag is ignored.
794a76b5dfcSdrh */
795b7916a78Sdrh Expr *sqlite3ExprAlloc(
796cca8a4adSdrh   sqlite3 *db,            /* Handle for sqlite3DbMallocRawNN() */
79717435752Sdrh   int op,                 /* Expression opcode */
798b7916a78Sdrh   const Token *pToken,    /* Token argument.  Might be NULL */
799b7916a78Sdrh   int dequote             /* True to dequote */
80017435752Sdrh ){
801a76b5dfcSdrh   Expr *pNew;
80233e619fcSdrh   int nExtra = 0;
803cf697396Sshane   int iValue = 0;
804b7916a78Sdrh 
805575fad65Sdrh   assert( db!=0 );
806b7916a78Sdrh   if( pToken ){
80733e619fcSdrh     if( op!=TK_INTEGER || pToken->z==0
80833e619fcSdrh           || sqlite3GetInt32(pToken->z, &iValue)==0 ){
809b7916a78Sdrh       nExtra = pToken->n+1;
810d50ffc41Sdrh       assert( iValue>=0 );
81133e619fcSdrh     }
812a76b5dfcSdrh   }
813575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, sizeof(Expr)+nExtra);
814b7916a78Sdrh   if( pNew ){
815ca3862dcSdrh     memset(pNew, 0, sizeof(Expr));
8161bd10f8aSdrh     pNew->op = (u8)op;
817a58fdfb1Sdanielk1977     pNew->iAgg = -1;
818a76b5dfcSdrh     if( pToken ){
81933e619fcSdrh       if( nExtra==0 ){
820ad31727fSdrh         pNew->flags |= EP_IntValue|EP_Leaf|(iValue?EP_IsTrue:EP_IsFalse);
82133e619fcSdrh         pNew->u.iValue = iValue;
82233e619fcSdrh       }else{
82333e619fcSdrh         pNew->u.zToken = (char*)&pNew[1];
824b07028f7Sdrh         assert( pToken->z!=0 || pToken->n==0 );
825b07028f7Sdrh         if( pToken->n ) memcpy(pNew->u.zToken, pToken->z, pToken->n);
82633e619fcSdrh         pNew->u.zToken[pToken->n] = 0;
827244b9d6eSdrh         if( dequote && sqlite3Isquote(pNew->u.zToken[0]) ){
82851d35b0fSdrh           sqlite3DequoteExpr(pNew);
829a34001c9Sdrh         }
830a34001c9Sdrh       }
83133e619fcSdrh     }
832b7916a78Sdrh #if SQLITE_MAX_EXPR_DEPTH>0
833b7916a78Sdrh     pNew->nHeight = 1;
834b7916a78Sdrh #endif
835a34001c9Sdrh   }
836a76b5dfcSdrh   return pNew;
837a76b5dfcSdrh }
838a76b5dfcSdrh 
839a76b5dfcSdrh /*
840b7916a78Sdrh ** Allocate a new expression node from a zero-terminated token that has
841b7916a78Sdrh ** already been dequoted.
842b7916a78Sdrh */
843b7916a78Sdrh Expr *sqlite3Expr(
844b7916a78Sdrh   sqlite3 *db,            /* Handle for sqlite3DbMallocZero() (may be null) */
845b7916a78Sdrh   int op,                 /* Expression opcode */
846b7916a78Sdrh   const char *zToken      /* Token argument.  Might be NULL */
847b7916a78Sdrh ){
848b7916a78Sdrh   Token x;
849b7916a78Sdrh   x.z = zToken;
850b40f06c6Sdrh   x.n = sqlite3Strlen30(zToken);
851b7916a78Sdrh   return sqlite3ExprAlloc(db, op, &x, 0);
852b7916a78Sdrh }
853b7916a78Sdrh 
854b7916a78Sdrh /*
855b7916a78Sdrh ** Attach subtrees pLeft and pRight to the Expr node pRoot.
856b7916a78Sdrh **
857b7916a78Sdrh ** If pRoot==NULL that means that a memory allocation error has occurred.
858b7916a78Sdrh ** In that case, delete the subtrees pLeft and pRight.
859b7916a78Sdrh */
860b7916a78Sdrh void sqlite3ExprAttachSubtrees(
861b7916a78Sdrh   sqlite3 *db,
862b7916a78Sdrh   Expr *pRoot,
863b7916a78Sdrh   Expr *pLeft,
864b7916a78Sdrh   Expr *pRight
865b7916a78Sdrh ){
866b7916a78Sdrh   if( pRoot==0 ){
867b7916a78Sdrh     assert( db->mallocFailed );
868b7916a78Sdrh     sqlite3ExprDelete(db, pLeft);
869b7916a78Sdrh     sqlite3ExprDelete(db, pRight);
870b7916a78Sdrh   }else{
871b7916a78Sdrh     if( pRight ){
872b7916a78Sdrh       pRoot->pRight = pRight;
873885a5b03Sdrh       pRoot->flags |= EP_Propagate & pRight->flags;
874b7916a78Sdrh     }
875b7916a78Sdrh     if( pLeft ){
876b7916a78Sdrh       pRoot->pLeft = pLeft;
877885a5b03Sdrh       pRoot->flags |= EP_Propagate & pLeft->flags;
878b7916a78Sdrh     }
879b7916a78Sdrh     exprSetHeight(pRoot);
880b7916a78Sdrh   }
881b7916a78Sdrh }
882b7916a78Sdrh 
883b7916a78Sdrh /*
88460ec914cSpeter.d.reid ** Allocate an Expr node which joins as many as two subtrees.
885b7916a78Sdrh **
886bf664469Sdrh ** One or both of the subtrees can be NULL.  Return a pointer to the new
887bf664469Sdrh ** Expr node.  Or, if an OOM error occurs, set pParse->db->mallocFailed,
888bf664469Sdrh ** free the subtrees and return NULL.
889206f3d96Sdrh */
89017435752Sdrh Expr *sqlite3PExpr(
89117435752Sdrh   Parse *pParse,          /* Parsing context */
89217435752Sdrh   int op,                 /* Expression opcode */
89317435752Sdrh   Expr *pLeft,            /* Left operand */
894abfd35eaSdrh   Expr *pRight            /* Right operand */
89517435752Sdrh ){
8965fb52caaSdrh   Expr *p;
897abfd35eaSdrh   p = sqlite3DbMallocRawNN(pParse->db, sizeof(Expr));
898abfd35eaSdrh   if( p ){
899abfd35eaSdrh     memset(p, 0, sizeof(Expr));
900f1722baaSdrh     p->op = op & 0xff;
901abfd35eaSdrh     p->iAgg = -1;
902b7916a78Sdrh     sqlite3ExprAttachSubtrees(pParse->db, p, pLeft, pRight);
9032b359bdbSdan     sqlite3ExprCheckHeight(pParse, p->nHeight);
904d5c851c1Sdrh   }else{
905d5c851c1Sdrh     sqlite3ExprDelete(pParse->db, pLeft);
906d5c851c1Sdrh     sqlite3ExprDelete(pParse->db, pRight);
9072b359bdbSdan   }
9084e0cff60Sdrh   return p;
9094e0cff60Sdrh }
9104e0cff60Sdrh 
9114e0cff60Sdrh /*
91208de4f79Sdrh ** Add pSelect to the Expr.x.pSelect field.  Or, if pExpr is NULL (due
91308de4f79Sdrh ** do a memory allocation failure) then delete the pSelect object.
91408de4f79Sdrh */
91508de4f79Sdrh void sqlite3PExprAddSelect(Parse *pParse, Expr *pExpr, Select *pSelect){
91608de4f79Sdrh   if( pExpr ){
91708de4f79Sdrh     pExpr->x.pSelect = pSelect;
91808de4f79Sdrh     ExprSetProperty(pExpr, EP_xIsSelect|EP_Subquery);
91908de4f79Sdrh     sqlite3ExprSetHeightAndFlags(pParse, pExpr);
92008de4f79Sdrh   }else{
92108de4f79Sdrh     assert( pParse->db->mallocFailed );
92208de4f79Sdrh     sqlite3SelectDelete(pParse->db, pSelect);
92308de4f79Sdrh   }
92408de4f79Sdrh }
92508de4f79Sdrh 
92608de4f79Sdrh 
92708de4f79Sdrh /*
92891bb0eedSdrh ** Join two expressions using an AND operator.  If either expression is
92991bb0eedSdrh ** NULL, then just return the other expression.
9305fb52caaSdrh **
9315fb52caaSdrh ** If one side or the other of the AND is known to be false, then instead
9325fb52caaSdrh ** of returning an AND expression, just return a constant expression with
9335fb52caaSdrh ** a value of false.
93491bb0eedSdrh */
935d5c851c1Sdrh Expr *sqlite3ExprAnd(Parse *pParse, Expr *pLeft, Expr *pRight){
936d5c851c1Sdrh   sqlite3 *db = pParse->db;
93791bb0eedSdrh   if( pLeft==0  ){
93891bb0eedSdrh     return pRight;
93991bb0eedSdrh   }else if( pRight==0 ){
94091bb0eedSdrh     return pLeft;
9412b6e670fSdan   }else if( (ExprAlwaysFalse(pLeft) || ExprAlwaysFalse(pRight))
9422b6e670fSdan          && !IN_RENAME_OBJECT
9432b6e670fSdan   ){
9442b6e670fSdan     sqlite3ExprDelete(db, pLeft);
9452b6e670fSdan     sqlite3ExprDelete(db, pRight);
9465776ee5cSdrh     return sqlite3Expr(db, TK_INTEGER, "0");
94791bb0eedSdrh   }else{
948d5c851c1Sdrh     return sqlite3PExpr(pParse, TK_AND, pLeft, pRight);
949a76b5dfcSdrh   }
950a76b5dfcSdrh }
951a76b5dfcSdrh 
952a76b5dfcSdrh /*
953a76b5dfcSdrh ** Construct a new expression node for a function with multiple
954a76b5dfcSdrh ** arguments.
955a76b5dfcSdrh */
956954733b3Sdrh Expr *sqlite3ExprFunction(
957954733b3Sdrh   Parse *pParse,        /* Parsing context */
958954733b3Sdrh   ExprList *pList,      /* Argument list */
959954733b3Sdrh   Token *pToken,        /* Name of the function */
960954733b3Sdrh   int eDistinct         /* SF_Distinct or SF_ALL or 0 */
961954733b3Sdrh ){
962a76b5dfcSdrh   Expr *pNew;
963633e6d57Sdrh   sqlite3 *db = pParse->db;
9644b202ae2Sdanielk1977   assert( pToken );
965b7916a78Sdrh   pNew = sqlite3ExprAlloc(db, TK_FUNCTION, pToken, 1);
966a76b5dfcSdrh   if( pNew==0 ){
967d9da78a2Sdrh     sqlite3ExprListDelete(db, pList); /* Avoid memory leak when malloc fails */
968a76b5dfcSdrh     return 0;
969a76b5dfcSdrh   }
970954733b3Sdrh   if( pList && pList->nExpr > pParse->db->aLimit[SQLITE_LIMIT_FUNCTION_ARG] ){
971954733b3Sdrh     sqlite3ErrorMsg(pParse, "too many arguments on function %T", pToken);
972954733b3Sdrh   }
9736ab3a2ecSdanielk1977   pNew->x.pList = pList;
974fca23557Sdrh   ExprSetProperty(pNew, EP_HasFunc);
9756ab3a2ecSdanielk1977   assert( !ExprHasProperty(pNew, EP_xIsSelect) );
9762308ed38Sdrh   sqlite3ExprSetHeightAndFlags(pParse, pNew);
977954733b3Sdrh   if( eDistinct==SF_Distinct ) ExprSetProperty(pNew, EP_Distinct);
978a76b5dfcSdrh   return pNew;
979a76b5dfcSdrh }
980a76b5dfcSdrh 
981a76b5dfcSdrh /*
9820dfa5255Sdrh ** Check to see if a function is usable according to current access
9830dfa5255Sdrh ** rules:
9840dfa5255Sdrh **
9850dfa5255Sdrh **    SQLITE_FUNC_DIRECT    -     Only usable from top-level SQL
9860dfa5255Sdrh **
9870dfa5255Sdrh **    SQLITE_FUNC_UNSAFE    -     Usable if TRUSTED_SCHEMA or from
9880dfa5255Sdrh **                                top-level SQL
9890dfa5255Sdrh **
9900dfa5255Sdrh ** If the function is not usable, create an error.
9910dfa5255Sdrh */
9920dfa5255Sdrh void sqlite3ExprFunctionUsable(
9930dfa5255Sdrh   Parse *pParse,         /* Parsing and code generating context */
9940dfa5255Sdrh   Expr *pExpr,           /* The function invocation */
9950dfa5255Sdrh   FuncDef *pDef          /* The function being invoked */
9960dfa5255Sdrh ){
9970dfa5255Sdrh   assert( !IN_RENAME_OBJECT );
9982eeca204Sdrh   assert( (pDef->funcFlags & (SQLITE_FUNC_DIRECT|SQLITE_FUNC_UNSAFE))!=0 );
9992eeca204Sdrh   if( ExprHasProperty(pExpr, EP_FromDDL) ){
10000dfa5255Sdrh     if( (pDef->funcFlags & SQLITE_FUNC_DIRECT)!=0
10010dfa5255Sdrh      || (pParse->db->flags & SQLITE_TrustedSchema)==0
10020dfa5255Sdrh     ){
10030dfa5255Sdrh       /* Functions prohibited in triggers and views if:
10040dfa5255Sdrh       **     (1) tagged with SQLITE_DIRECTONLY
10050dfa5255Sdrh       **     (2) not tagged with SQLITE_INNOCUOUS (which means it
10060dfa5255Sdrh       **         is tagged with SQLITE_FUNC_UNSAFE) and
10070dfa5255Sdrh       **         SQLITE_DBCONFIG_TRUSTED_SCHEMA is off (meaning
10080dfa5255Sdrh       **         that the schema is possibly tainted).
10090dfa5255Sdrh       */
10100dfa5255Sdrh       sqlite3ErrorMsg(pParse, "unsafe use of %s()", pDef->zName);
10110dfa5255Sdrh     }
10120dfa5255Sdrh   }
10130dfa5255Sdrh }
10140dfa5255Sdrh 
10150dfa5255Sdrh /*
1016fa6bc000Sdrh ** Assign a variable number to an expression that encodes a wildcard
1017fa6bc000Sdrh ** in the original SQL statement.
1018fa6bc000Sdrh **
1019fa6bc000Sdrh ** Wildcards consisting of a single "?" are assigned the next sequential
1020fa6bc000Sdrh ** variable number.
1021fa6bc000Sdrh **
1022fa6bc000Sdrh ** Wildcards of the form "?nnn" are assigned the number "nnn".  We make
10239bf755ccSdrh ** sure "nnn" is not too big to avoid a denial of service attack when
1024fa6bc000Sdrh ** the SQL statement comes from an external source.
1025fa6bc000Sdrh **
102651f49f17Sdrh ** Wildcards of the form ":aaa", "@aaa", or "$aaa" are assigned the same number
1027fa6bc000Sdrh ** as the previous instance of the same wildcard.  Or if this is the first
102860ec914cSpeter.d.reid ** instance of the wildcard, the next sequential variable number is
1029fa6bc000Sdrh ** assigned.
1030fa6bc000Sdrh */
1031de25a88cSdrh void sqlite3ExprAssignVarNumber(Parse *pParse, Expr *pExpr, u32 n){
103217435752Sdrh   sqlite3 *db = pParse->db;
1033b7916a78Sdrh   const char *z;
1034f326d66dSdrh   ynVar x;
103517435752Sdrh 
1036fa6bc000Sdrh   if( pExpr==0 ) return;
1037c5cd1249Sdrh   assert( !ExprHasProperty(pExpr, EP_IntValue|EP_Reduced|EP_TokenOnly) );
103833e619fcSdrh   z = pExpr->u.zToken;
1039b7916a78Sdrh   assert( z!=0 );
1040b7916a78Sdrh   assert( z[0]!=0 );
1041b1ed717fSmistachkin   assert( n==(u32)sqlite3Strlen30(z) );
1042b7916a78Sdrh   if( z[1]==0 ){
1043fa6bc000Sdrh     /* Wildcard of the form "?".  Assign the next variable number */
1044b7916a78Sdrh     assert( z[0]=='?' );
1045f326d66dSdrh     x = (ynVar)(++pParse->nVar);
1046124c0b49Sdrh   }else{
1047f326d66dSdrh     int doAdd = 0;
1048124c0b49Sdrh     if( z[0]=='?' ){
1049fa6bc000Sdrh       /* Wildcard of the form "?nnn".  Convert "nnn" to an integer and
1050fa6bc000Sdrh       ** use it as the variable number */
1051c8d735aeSdan       i64 i;
105218814dfbSdrh       int bOk;
105318814dfbSdrh       if( n==2 ){ /*OPTIMIZATION-IF-TRUE*/
105418814dfbSdrh         i = z[1]-'0';  /* The common case of ?N for a single digit N */
105518814dfbSdrh         bOk = 1;
105618814dfbSdrh       }else{
105718814dfbSdrh         bOk = 0==sqlite3Atoi64(&z[1], &i, n-1, SQLITE_UTF8);
105818814dfbSdrh       }
1059c5499befSdrh       testcase( i==0 );
1060c5499befSdrh       testcase( i==1 );
1061c5499befSdrh       testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]-1 );
1062c5499befSdrh       testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] );
1063c8d735aeSdan       if( bOk==0 || i<1 || i>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
1064fa6bc000Sdrh         sqlite3ErrorMsg(pParse, "variable number must be between ?1 and ?%d",
1065bb4957f8Sdrh             db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]);
1066c9b39288Sdrh         return;
1067fa6bc000Sdrh       }
10688e74e7baSdrh       x = (ynVar)i;
1069f326d66dSdrh       if( x>pParse->nVar ){
1070f326d66dSdrh         pParse->nVar = (int)x;
1071f326d66dSdrh         doAdd = 1;
1072f326d66dSdrh       }else if( sqlite3VListNumToName(pParse->pVList, x)==0 ){
1073f326d66dSdrh         doAdd = 1;
1074fa6bc000Sdrh       }
1075fa6bc000Sdrh     }else{
107651f49f17Sdrh       /* Wildcards like ":aaa", "$aaa" or "@aaa".  Reuse the same variable
1077fa6bc000Sdrh       ** number as the prior appearance of the same name, or if the name
1078fa6bc000Sdrh       ** has never appeared before, reuse the same variable number
1079fa6bc000Sdrh       */
10809bf755ccSdrh       x = (ynVar)sqlite3VListNameToNum(pParse->pVList, z, n);
10819bf755ccSdrh       if( x==0 ){
10829bf755ccSdrh         x = (ynVar)(++pParse->nVar);
1083f326d66dSdrh         doAdd = 1;
1084f326d66dSdrh       }
1085f326d66dSdrh     }
1086f326d66dSdrh     if( doAdd ){
10879bf755ccSdrh       pParse->pVList = sqlite3VListAdd(db, pParse->pVList, z, n, x);
1088fa6bc000Sdrh     }
1089fa6bc000Sdrh   }
1090c9b39288Sdrh   pExpr->iColumn = x;
1091f326d66dSdrh   if( x>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
1092832b2664Sdanielk1977     sqlite3ErrorMsg(pParse, "too many SQL variables");
1093832b2664Sdanielk1977   }
1094fa6bc000Sdrh }
1095fa6bc000Sdrh 
1096fa6bc000Sdrh /*
1097f6963f99Sdan ** Recursively delete an expression tree.
1098a2e00042Sdrh */
10994f0010b1Sdrh static SQLITE_NOINLINE void sqlite3ExprDeleteNN(sqlite3 *db, Expr *p){
11004f0010b1Sdrh   assert( p!=0 );
1101d50ffc41Sdrh   /* Sanity check: Assert that the IntValue is non-negative if it exists */
1102d50ffc41Sdrh   assert( !ExprHasProperty(p, EP_IntValue) || p->u.iValue>=0 );
1103eda079cdSdrh 
1104eda079cdSdrh   assert( !ExprHasProperty(p, EP_WinFunc) || p->y.pWin!=0 || db->mallocFailed );
1105eda079cdSdrh   assert( p->op!=TK_FUNCTION || ExprHasProperty(p, EP_TokenOnly|EP_Reduced)
11064f9adee2Sdan           || p->y.pWin==0 || ExprHasProperty(p, EP_WinFunc) );
1107209bc522Sdrh #ifdef SQLITE_DEBUG
1108209bc522Sdrh   if( ExprHasProperty(p, EP_Leaf) && !ExprHasProperty(p, EP_TokenOnly) ){
1109209bc522Sdrh     assert( p->pLeft==0 );
1110209bc522Sdrh     assert( p->pRight==0 );
1111209bc522Sdrh     assert( p->x.pSelect==0 );
1112209bc522Sdrh   }
1113209bc522Sdrh #endif
1114209bc522Sdrh   if( !ExprHasProperty(p, (EP_TokenOnly|EP_Leaf)) ){
1115c5cd1249Sdrh     /* The Expr.x union is never used at the same time as Expr.pRight */
1116c5cd1249Sdrh     assert( p->x.pList==0 || p->pRight==0 );
11174910a76dSdrh     if( p->pLeft && p->op!=TK_SELECT_COLUMN ) sqlite3ExprDeleteNN(db, p->pLeft);
1118d1086679Sdrh     if( p->pRight ){
11194f9adee2Sdan       assert( !ExprHasProperty(p, EP_WinFunc) );
1120d1086679Sdrh       sqlite3ExprDeleteNN(db, p->pRight);
1121d1086679Sdrh     }else if( ExprHasProperty(p, EP_xIsSelect) ){
11224f9adee2Sdan       assert( !ExprHasProperty(p, EP_WinFunc) );
11236ab3a2ecSdanielk1977       sqlite3SelectDelete(db, p->x.pSelect);
11246ab3a2ecSdanielk1977     }else{
11256ab3a2ecSdanielk1977       sqlite3ExprListDelete(db, p->x.pList);
11266ba7ab0dSdan #ifndef SQLITE_OMIT_WINDOWFUNC
1127eda079cdSdrh       if( ExprHasProperty(p, EP_WinFunc) ){
1128eda079cdSdrh         sqlite3WindowDelete(db, p->y.pWin);
112986fb6e17Sdan       }
11306ba7ab0dSdan #endif
11316ab3a2ecSdanielk1977     }
11328117f113Sdan   }
1133209bc522Sdrh   if( ExprHasProperty(p, EP_MemToken) ) sqlite3DbFree(db, p->u.zToken);
113433e619fcSdrh   if( !ExprHasProperty(p, EP_Static) ){
1135dbd6a7dcSdrh     sqlite3DbFreeNN(db, p);
1136a2e00042Sdrh   }
113733e619fcSdrh }
11384f0010b1Sdrh void sqlite3ExprDelete(sqlite3 *db, Expr *p){
11394f0010b1Sdrh   if( p ) sqlite3ExprDeleteNN(db, p);
11404f0010b1Sdrh }
1141a2e00042Sdrh 
11428e34e406Sdrh /* Invoke sqlite3RenameExprUnmap() and sqlite3ExprDelete() on the
11438e34e406Sdrh ** expression.
11448e34e406Sdrh */
11458e34e406Sdrh void sqlite3ExprUnmapAndDelete(Parse *pParse, Expr *p){
11468e34e406Sdrh   if( p ){
11478e34e406Sdrh     if( IN_RENAME_OBJECT ){
11488e34e406Sdrh       sqlite3RenameExprUnmap(pParse, p);
11498e34e406Sdrh     }
11508e34e406Sdrh     sqlite3ExprDeleteNN(pParse->db, p);
11518e34e406Sdrh   }
11528e34e406Sdrh }
11538e34e406Sdrh 
1154d2687b77Sdrh /*
11556ab3a2ecSdanielk1977 ** Return the number of bytes allocated for the expression structure
11566ab3a2ecSdanielk1977 ** passed as the first argument. This is always one of EXPR_FULLSIZE,
11576ab3a2ecSdanielk1977 ** EXPR_REDUCEDSIZE or EXPR_TOKENONLYSIZE.
11586ab3a2ecSdanielk1977 */
11596ab3a2ecSdanielk1977 static int exprStructSize(Expr *p){
11606ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_TokenOnly) ) return EXPR_TOKENONLYSIZE;
11616ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_Reduced) ) return EXPR_REDUCEDSIZE;
11626ab3a2ecSdanielk1977   return EXPR_FULLSIZE;
11636ab3a2ecSdanielk1977 }
11646ab3a2ecSdanielk1977 
11656ab3a2ecSdanielk1977 /*
116633e619fcSdrh ** The dupedExpr*Size() routines each return the number of bytes required
116733e619fcSdrh ** to store a copy of an expression or expression tree.  They differ in
116833e619fcSdrh ** how much of the tree is measured.
116933e619fcSdrh **
117033e619fcSdrh **     dupedExprStructSize()     Size of only the Expr structure
117133e619fcSdrh **     dupedExprNodeSize()       Size of Expr + space for token
117233e619fcSdrh **     dupedExprSize()           Expr + token + subtree components
117333e619fcSdrh **
117433e619fcSdrh ***************************************************************************
117533e619fcSdrh **
117633e619fcSdrh ** The dupedExprStructSize() function returns two values OR-ed together:
117733e619fcSdrh ** (1) the space required for a copy of the Expr structure only and
117833e619fcSdrh ** (2) the EP_xxx flags that indicate what the structure size should be.
117933e619fcSdrh ** The return values is always one of:
118033e619fcSdrh **
118133e619fcSdrh **      EXPR_FULLSIZE
118233e619fcSdrh **      EXPR_REDUCEDSIZE   | EP_Reduced
118333e619fcSdrh **      EXPR_TOKENONLYSIZE | EP_TokenOnly
118433e619fcSdrh **
118533e619fcSdrh ** The size of the structure can be found by masking the return value
118633e619fcSdrh ** of this routine with 0xfff.  The flags can be found by masking the
118733e619fcSdrh ** return value with EP_Reduced|EP_TokenOnly.
118833e619fcSdrh **
118933e619fcSdrh ** Note that with flags==EXPRDUP_REDUCE, this routines works on full-size
119033e619fcSdrh ** (unreduced) Expr objects as they or originally constructed by the parser.
119133e619fcSdrh ** During expression analysis, extra information is computed and moved into
1192c95f38d4Sdan ** later parts of the Expr object and that extra information might get chopped
119333e619fcSdrh ** off if the expression is reduced.  Note also that it does not work to
119460ec914cSpeter.d.reid ** make an EXPRDUP_REDUCE copy of a reduced expression.  It is only legal
119533e619fcSdrh ** to reduce a pristine expression tree from the parser.  The implementation
119633e619fcSdrh ** of dupedExprStructSize() contain multiple assert() statements that attempt
119733e619fcSdrh ** to enforce this constraint.
11986ab3a2ecSdanielk1977 */
11996ab3a2ecSdanielk1977 static int dupedExprStructSize(Expr *p, int flags){
12006ab3a2ecSdanielk1977   int nSize;
120133e619fcSdrh   assert( flags==EXPRDUP_REDUCE || flags==0 ); /* Only one flag value allowed */
1202aecd8021Sdrh   assert( EXPR_FULLSIZE<=0xfff );
1203aecd8021Sdrh   assert( (0xfff & (EP_Reduced|EP_TokenOnly))==0 );
120467a9b8edSdan   if( 0==flags || p->op==TK_SELECT_COLUMN
120567a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
1206eda079cdSdrh    || ExprHasProperty(p, EP_WinFunc)
120767a9b8edSdan #endif
120867a9b8edSdan   ){
12096ab3a2ecSdanielk1977     nSize = EXPR_FULLSIZE;
12106ab3a2ecSdanielk1977   }else{
1211c5cd1249Sdrh     assert( !ExprHasProperty(p, EP_TokenOnly|EP_Reduced) );
121233e619fcSdrh     assert( !ExprHasProperty(p, EP_FromJoin) );
1213c5cd1249Sdrh     assert( !ExprHasProperty(p, EP_MemToken) );
1214e7375bfaSdrh     assert( !ExprHasVVAProperty(p, EP_NoReduce) );
1215aecd8021Sdrh     if( p->pLeft || p->x.pList ){
121633e619fcSdrh       nSize = EXPR_REDUCEDSIZE | EP_Reduced;
121733e619fcSdrh     }else{
1218aecd8021Sdrh       assert( p->pRight==0 );
121933e619fcSdrh       nSize = EXPR_TOKENONLYSIZE | EP_TokenOnly;
122033e619fcSdrh     }
12216ab3a2ecSdanielk1977   }
12226ab3a2ecSdanielk1977   return nSize;
12236ab3a2ecSdanielk1977 }
12246ab3a2ecSdanielk1977 
12256ab3a2ecSdanielk1977 /*
122633e619fcSdrh ** This function returns the space in bytes required to store the copy
122733e619fcSdrh ** of the Expr structure and a copy of the Expr.u.zToken string (if that
122833e619fcSdrh ** string is defined.)
12296ab3a2ecSdanielk1977 */
12306ab3a2ecSdanielk1977 static int dupedExprNodeSize(Expr *p, int flags){
123133e619fcSdrh   int nByte = dupedExprStructSize(p, flags) & 0xfff;
123233e619fcSdrh   if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
12337301e774Sdrh     nByte += sqlite3Strlen30NN(p->u.zToken)+1;
12346ab3a2ecSdanielk1977   }
1235bc73971dSdanielk1977   return ROUND8(nByte);
12366ab3a2ecSdanielk1977 }
12376ab3a2ecSdanielk1977 
12386ab3a2ecSdanielk1977 /*
12396ab3a2ecSdanielk1977 ** Return the number of bytes required to create a duplicate of the
12406ab3a2ecSdanielk1977 ** expression passed as the first argument. The second argument is a
12416ab3a2ecSdanielk1977 ** mask containing EXPRDUP_XXX flags.
12426ab3a2ecSdanielk1977 **
12436ab3a2ecSdanielk1977 ** The value returned includes space to create a copy of the Expr struct
124433e619fcSdrh ** itself and the buffer referred to by Expr.u.zToken, if any.
12456ab3a2ecSdanielk1977 **
12466ab3a2ecSdanielk1977 ** If the EXPRDUP_REDUCE flag is set, then the return value includes
12476ab3a2ecSdanielk1977 ** space to duplicate all Expr nodes in the tree formed by Expr.pLeft
12486ab3a2ecSdanielk1977 ** and Expr.pRight variables (but not for any structures pointed to or
12496ab3a2ecSdanielk1977 ** descended from the Expr.x.pList or Expr.x.pSelect variables).
12506ab3a2ecSdanielk1977 */
12516ab3a2ecSdanielk1977 static int dupedExprSize(Expr *p, int flags){
12526ab3a2ecSdanielk1977   int nByte = 0;
12536ab3a2ecSdanielk1977   if( p ){
12546ab3a2ecSdanielk1977     nByte = dupedExprNodeSize(p, flags);
12556ab3a2ecSdanielk1977     if( flags&EXPRDUP_REDUCE ){
1256b7916a78Sdrh       nByte += dupedExprSize(p->pLeft, flags) + dupedExprSize(p->pRight, flags);
12576ab3a2ecSdanielk1977     }
12586ab3a2ecSdanielk1977   }
12596ab3a2ecSdanielk1977   return nByte;
12606ab3a2ecSdanielk1977 }
12616ab3a2ecSdanielk1977 
12626ab3a2ecSdanielk1977 /*
12636ab3a2ecSdanielk1977 ** This function is similar to sqlite3ExprDup(), except that if pzBuffer
12646ab3a2ecSdanielk1977 ** is not NULL then *pzBuffer is assumed to point to a buffer large enough
126533e619fcSdrh ** to store the copy of expression p, the copies of p->u.zToken
12666ab3a2ecSdanielk1977 ** (if applicable), and the copies of the p->pLeft and p->pRight expressions,
126760ec914cSpeter.d.reid ** if any. Before returning, *pzBuffer is set to the first byte past the
12686ab3a2ecSdanielk1977 ** portion of the buffer copied into by this function.
12696ab3a2ecSdanielk1977 */
12703c19469cSdrh static Expr *exprDup(sqlite3 *db, Expr *p, int dupFlags, u8 **pzBuffer){
12713c19469cSdrh   Expr *pNew;           /* Value to return */
12723c19469cSdrh   u8 *zAlloc;           /* Memory space from which to build Expr object */
12733c19469cSdrh   u32 staticFlag;       /* EP_Static if space not obtained from malloc */
12746ab3a2ecSdanielk1977 
12753c19469cSdrh   assert( db!=0 );
12763c19469cSdrh   assert( p );
12773c19469cSdrh   assert( dupFlags==0 || dupFlags==EXPRDUP_REDUCE );
12783c19469cSdrh   assert( pzBuffer==0 || dupFlags==EXPRDUP_REDUCE );
12796ab3a2ecSdanielk1977 
12806ab3a2ecSdanielk1977   /* Figure out where to write the new Expr structure. */
12816ab3a2ecSdanielk1977   if( pzBuffer ){
12826ab3a2ecSdanielk1977     zAlloc = *pzBuffer;
128333e619fcSdrh     staticFlag = EP_Static;
12846ab3a2ecSdanielk1977   }else{
12853c19469cSdrh     zAlloc = sqlite3DbMallocRawNN(db, dupedExprSize(p, dupFlags));
12863c19469cSdrh     staticFlag = 0;
12876ab3a2ecSdanielk1977   }
12886ab3a2ecSdanielk1977   pNew = (Expr *)zAlloc;
12896ab3a2ecSdanielk1977 
12906ab3a2ecSdanielk1977   if( pNew ){
12916ab3a2ecSdanielk1977     /* Set nNewSize to the size allocated for the structure pointed to
12926ab3a2ecSdanielk1977     ** by pNew. This is either EXPR_FULLSIZE, EXPR_REDUCEDSIZE or
12936ab3a2ecSdanielk1977     ** EXPR_TOKENONLYSIZE. nToken is set to the number of bytes consumed
129433e619fcSdrh     ** by the copy of the p->u.zToken string (if any).
12956ab3a2ecSdanielk1977     */
12963c19469cSdrh     const unsigned nStructSize = dupedExprStructSize(p, dupFlags);
129733e619fcSdrh     const int nNewSize = nStructSize & 0xfff;
129833e619fcSdrh     int nToken;
129933e619fcSdrh     if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
130033e619fcSdrh       nToken = sqlite3Strlen30(p->u.zToken) + 1;
130133e619fcSdrh     }else{
130233e619fcSdrh       nToken = 0;
130333e619fcSdrh     }
13043c19469cSdrh     if( dupFlags ){
13056ab3a2ecSdanielk1977       assert( ExprHasProperty(p, EP_Reduced)==0 );
13066ab3a2ecSdanielk1977       memcpy(zAlloc, p, nNewSize);
13076ab3a2ecSdanielk1977     }else{
13083e6a1411Sdan       u32 nSize = (u32)exprStructSize(p);
13096ab3a2ecSdanielk1977       memcpy(zAlloc, p, nSize);
131072ea29d7Sdrh       if( nSize<EXPR_FULLSIZE ){
13116ab3a2ecSdanielk1977         memset(&zAlloc[nSize], 0, EXPR_FULLSIZE-nSize);
13126ab3a2ecSdanielk1977       }
131372ea29d7Sdrh     }
13146ab3a2ecSdanielk1977 
131533e619fcSdrh     /* Set the EP_Reduced, EP_TokenOnly, and EP_Static flags appropriately. */
1316c5cd1249Sdrh     pNew->flags &= ~(EP_Reduced|EP_TokenOnly|EP_Static|EP_MemToken);
131733e619fcSdrh     pNew->flags |= nStructSize & (EP_Reduced|EP_TokenOnly);
131833e619fcSdrh     pNew->flags |= staticFlag;
1319e7375bfaSdrh     ExprClearVVAProperties(pNew);
1320e7375bfaSdrh     if( dupFlags ){
1321e7375bfaSdrh       ExprSetVVAProperty(pNew, EP_Immutable);
1322e7375bfaSdrh     }
13236ab3a2ecSdanielk1977 
132433e619fcSdrh     /* Copy the p->u.zToken string, if any. */
13256ab3a2ecSdanielk1977     if( nToken ){
132633e619fcSdrh       char *zToken = pNew->u.zToken = (char*)&zAlloc[nNewSize];
132733e619fcSdrh       memcpy(zToken, p->u.zToken, nToken);
13286ab3a2ecSdanielk1977     }
13296ab3a2ecSdanielk1977 
1330209bc522Sdrh     if( 0==((p->flags|pNew->flags) & (EP_TokenOnly|EP_Leaf)) ){
13316ab3a2ecSdanielk1977       /* Fill in the pNew->x.pSelect or pNew->x.pList member. */
13326ab3a2ecSdanielk1977       if( ExprHasProperty(p, EP_xIsSelect) ){
13333c19469cSdrh         pNew->x.pSelect = sqlite3SelectDup(db, p->x.pSelect, dupFlags);
13346ab3a2ecSdanielk1977       }else{
13353c19469cSdrh         pNew->x.pList = sqlite3ExprListDup(db, p->x.pList, dupFlags);
13366ab3a2ecSdanielk1977       }
13376ab3a2ecSdanielk1977     }
13386ab3a2ecSdanielk1977 
13396ab3a2ecSdanielk1977     /* Fill in pNew->pLeft and pNew->pRight. */
13404f9adee2Sdan     if( ExprHasProperty(pNew, EP_Reduced|EP_TokenOnly|EP_WinFunc) ){
13413c19469cSdrh       zAlloc += dupedExprNodeSize(p, dupFlags);
1342209bc522Sdrh       if( !ExprHasProperty(pNew, EP_TokenOnly|EP_Leaf) ){
13433c19469cSdrh         pNew->pLeft = p->pLeft ?
13443c19469cSdrh                       exprDup(db, p->pLeft, EXPRDUP_REDUCE, &zAlloc) : 0;
13453c19469cSdrh         pNew->pRight = p->pRight ?
13463c19469cSdrh                        exprDup(db, p->pRight, EXPRDUP_REDUCE, &zAlloc) : 0;
13476ab3a2ecSdanielk1977       }
134867a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
1349eda079cdSdrh       if( ExprHasProperty(p, EP_WinFunc) ){
1350eda079cdSdrh         pNew->y.pWin = sqlite3WindowDup(db, pNew, p->y.pWin);
1351eda079cdSdrh         assert( ExprHasProperty(pNew, EP_WinFunc) );
1352e2f781b9Sdan       }
135367a9b8edSdan #endif /* SQLITE_OMIT_WINDOWFUNC */
135453988068Sdrh       if( pzBuffer ){
135553988068Sdrh         *pzBuffer = zAlloc;
135653988068Sdrh       }
135753988068Sdrh     }else{
1358209bc522Sdrh       if( !ExprHasProperty(p, EP_TokenOnly|EP_Leaf) ){
13599854260bSdrh         if( pNew->op==TK_SELECT_COLUMN ){
13609854260bSdrh           pNew->pLeft = p->pLeft;
136147073f62Sdrh           assert( p->iColumn==0 || p->pRight==0 );
136247073f62Sdrh           assert( p->pRight==0  || p->pRight==p->pLeft );
13639854260bSdrh         }else{
13646ab3a2ecSdanielk1977           pNew->pLeft = sqlite3ExprDup(db, p->pLeft, 0);
13659854260bSdrh         }
13666ab3a2ecSdanielk1977         pNew->pRight = sqlite3ExprDup(db, p->pRight, 0);
13676ab3a2ecSdanielk1977       }
13686ab3a2ecSdanielk1977     }
13696ab3a2ecSdanielk1977   }
13706ab3a2ecSdanielk1977   return pNew;
13716ab3a2ecSdanielk1977 }
13726ab3a2ecSdanielk1977 
13736ab3a2ecSdanielk1977 /*
1374bfe31e7fSdan ** Create and return a deep copy of the object passed as the second
1375bfe31e7fSdan ** argument. If an OOM condition is encountered, NULL is returned
1376bfe31e7fSdan ** and the db->mallocFailed flag set.
1377bfe31e7fSdan */
1378eede6a53Sdan #ifndef SQLITE_OMIT_CTE
1379bfe31e7fSdan static With *withDup(sqlite3 *db, With *p){
13804e9119d9Sdan   With *pRet = 0;
13814e9119d9Sdan   if( p ){
1382d4de9f7bSdrh     sqlite3_int64 nByte = sizeof(*p) + sizeof(p->a[0]) * (p->nCte-1);
13834e9119d9Sdan     pRet = sqlite3DbMallocZero(db, nByte);
13844e9119d9Sdan     if( pRet ){
13854e9119d9Sdan       int i;
13864e9119d9Sdan       pRet->nCte = p->nCte;
13874e9119d9Sdan       for(i=0; i<p->nCte; i++){
13884e9119d9Sdan         pRet->a[i].pSelect = sqlite3SelectDup(db, p->a[i].pSelect, 0);
13894e9119d9Sdan         pRet->a[i].pCols = sqlite3ExprListDup(db, p->a[i].pCols, 0);
13904e9119d9Sdan         pRet->a[i].zName = sqlite3DbStrDup(db, p->a[i].zName);
13914e9119d9Sdan       }
13924e9119d9Sdan     }
13934e9119d9Sdan   }
13944e9119d9Sdan   return pRet;
13954e9119d9Sdan }
1396eede6a53Sdan #else
1397eede6a53Sdan # define withDup(x,y) 0
1398eede6a53Sdan #endif
13994e9119d9Sdan 
1400a8389975Sdrh #ifndef SQLITE_OMIT_WINDOWFUNC
1401a8389975Sdrh /*
1402a8389975Sdrh ** The gatherSelectWindows() procedure and its helper routine
1403a8389975Sdrh ** gatherSelectWindowsCallback() are used to scan all the expressions
1404a8389975Sdrh ** an a newly duplicated SELECT statement and gather all of the Window
1405a8389975Sdrh ** objects found there, assembling them onto the linked list at Select->pWin.
1406a8389975Sdrh */
1407a8389975Sdrh static int gatherSelectWindowsCallback(Walker *pWalker, Expr *pExpr){
14086ba7ab0dSdan   if( pExpr->op==TK_FUNCTION && ExprHasProperty(pExpr, EP_WinFunc) ){
140975b0821eSdan     Select *pSelect = pWalker->u.pSelect;
141075b0821eSdan     Window *pWin = pExpr->y.pWin;
141175b0821eSdan     assert( pWin );
14124f9adee2Sdan     assert( IsWindowFunc(pExpr) );
1413e0ae3f69Sdan     assert( pWin->ppThis==0 );
1414a3fcc000Sdan     sqlite3WindowLink(pSelect, pWin);
1415a8389975Sdrh   }
1416a8389975Sdrh   return WRC_Continue;
1417a8389975Sdrh }
1418a37b6a5eSdrh static int gatherSelectWindowsSelectCallback(Walker *pWalker, Select *p){
1419a37b6a5eSdrh   return p==pWalker->u.pSelect ? WRC_Continue : WRC_Prune;
1420a37b6a5eSdrh }
1421a8389975Sdrh static void gatherSelectWindows(Select *p){
1422a8389975Sdrh   Walker w;
1423a8389975Sdrh   w.xExprCallback = gatherSelectWindowsCallback;
1424a37b6a5eSdrh   w.xSelectCallback = gatherSelectWindowsSelectCallback;
1425a37b6a5eSdrh   w.xSelectCallback2 = 0;
14269c46c66cSdrh   w.pParse = 0;
1427a8389975Sdrh   w.u.pSelect = p;
1428a37b6a5eSdrh   sqlite3WalkSelect(&w, p);
1429a8389975Sdrh }
1430a8389975Sdrh #endif
1431a8389975Sdrh 
1432a8389975Sdrh 
1433a76b5dfcSdrh /*
1434ff78bd2fSdrh ** The following group of routines make deep copies of expressions,
1435ff78bd2fSdrh ** expression lists, ID lists, and select statements.  The copies can
1436ff78bd2fSdrh ** be deleted (by being passed to their respective ...Delete() routines)
1437ff78bd2fSdrh ** without effecting the originals.
1438ff78bd2fSdrh **
14394adee20fSdanielk1977 ** The expression list, ID, and source lists return by sqlite3ExprListDup(),
14404adee20fSdanielk1977 ** sqlite3IdListDup(), and sqlite3SrcListDup() can not be further expanded
1441ad3cab52Sdrh ** by subsequent calls to sqlite*ListAppend() routines.
1442ff78bd2fSdrh **
1443ad3cab52Sdrh ** Any tables that the SrcList might point to are not duplicated.
14446ab3a2ecSdanielk1977 **
1445b7916a78Sdrh ** The flags parameter contains a combination of the EXPRDUP_XXX flags.
14466ab3a2ecSdanielk1977 ** If the EXPRDUP_REDUCE flag is set, then the structure returned is a
14476ab3a2ecSdanielk1977 ** truncated version of the usual Expr structure that will be stored as
14486ab3a2ecSdanielk1977 ** part of the in-memory representation of the database schema.
1449ff78bd2fSdrh */
14506ab3a2ecSdanielk1977 Expr *sqlite3ExprDup(sqlite3 *db, Expr *p, int flags){
145172ea29d7Sdrh   assert( flags==0 || flags==EXPRDUP_REDUCE );
14523c19469cSdrh   return p ? exprDup(db, p, flags, 0) : 0;
1453ff78bd2fSdrh }
14546ab3a2ecSdanielk1977 ExprList *sqlite3ExprListDup(sqlite3 *db, ExprList *p, int flags){
1455ff78bd2fSdrh   ExprList *pNew;
1456145716b3Sdrh   struct ExprList_item *pItem, *pOldItem;
1457ff78bd2fSdrh   int i;
1458b163748eSdrh   Expr *pPriorSelectCol = 0;
1459575fad65Sdrh   assert( db!=0 );
1460ff78bd2fSdrh   if( p==0 ) return 0;
146197258194Sdrh   pNew = sqlite3DbMallocRawNN(db, sqlite3DbMallocSize(db, p));
1462ff78bd2fSdrh   if( pNew==0 ) return 0;
1463a19543feSdrh   pNew->nExpr = p->nExpr;
146443606175Sdrh   pItem = pNew->a;
1465145716b3Sdrh   pOldItem = p->a;
1466145716b3Sdrh   for(i=0; i<p->nExpr; i++, pItem++, pOldItem++){
14676ab3a2ecSdanielk1977     Expr *pOldExpr = pOldItem->pExpr;
146847073f62Sdrh     Expr *pNewExpr;
1469b5526ea6Sdrh     pItem->pExpr = sqlite3ExprDup(db, pOldExpr, flags);
147047073f62Sdrh     if( pOldExpr
147147073f62Sdrh      && pOldExpr->op==TK_SELECT_COLUMN
147247073f62Sdrh      && (pNewExpr = pItem->pExpr)!=0
147347073f62Sdrh     ){
147447073f62Sdrh       assert( pNewExpr->iColumn==0 || i>0 );
147547073f62Sdrh       if( pNewExpr->iColumn==0 ){
147647073f62Sdrh         assert( pOldExpr->pLeft==pOldExpr->pRight );
1477b163748eSdrh         pPriorSelectCol = pNewExpr->pLeft = pNewExpr->pRight;
1478b163748eSdrh       }else{
1479b163748eSdrh         assert( i>0 );
1480b163748eSdrh         assert( pItem[-1].pExpr!=0 );
1481b163748eSdrh         assert( pNewExpr->iColumn==pItem[-1].pExpr->iColumn+1 );
1482b163748eSdrh         assert( pPriorSelectCol==pItem[-1].pExpr->pLeft );
1483b163748eSdrh         pNewExpr->pLeft = pPriorSelectCol;
148447073f62Sdrh       }
148547073f62Sdrh     }
148641cee668Sdrh     pItem->zEName = sqlite3DbStrDup(db, pOldItem->zEName);
14876e11892dSdan     pItem->sortFlags = pOldItem->sortFlags;
1488cbb9da33Sdrh     pItem->eEName = pOldItem->eEName;
14893e7bc9caSdrh     pItem->done = 0;
1490ae8e45cbSdan     pItem->bNulls = pOldItem->bNulls;
149124e25d32Sdan     pItem->bSorterRef = pOldItem->bSorterRef;
1492c2acc4e4Sdrh     pItem->u = pOldItem->u;
1493ff78bd2fSdrh   }
1494ff78bd2fSdrh   return pNew;
1495ff78bd2fSdrh }
149693758c8dSdanielk1977 
149793758c8dSdanielk1977 /*
149893758c8dSdanielk1977 ** If cursors, triggers, views and subqueries are all omitted from
149993758c8dSdanielk1977 ** the build, then none of the following routines, except for
150093758c8dSdanielk1977 ** sqlite3SelectDup(), can be called. sqlite3SelectDup() is sometimes
150193758c8dSdanielk1977 ** called with a NULL argument.
150293758c8dSdanielk1977 */
15036a67fe8eSdanielk1977 #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_TRIGGER) \
15046a67fe8eSdanielk1977  || !defined(SQLITE_OMIT_SUBQUERY)
15056ab3a2ecSdanielk1977 SrcList *sqlite3SrcListDup(sqlite3 *db, SrcList *p, int flags){
1506ad3cab52Sdrh   SrcList *pNew;
1507ad3cab52Sdrh   int i;
1508113088ecSdrh   int nByte;
1509575fad65Sdrh   assert( db!=0 );
1510ad3cab52Sdrh   if( p==0 ) return 0;
1511113088ecSdrh   nByte = sizeof(*p) + (p->nSrc>0 ? sizeof(p->a[0]) * (p->nSrc-1) : 0);
1512575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, nByte );
1513ad3cab52Sdrh   if( pNew==0 ) return 0;
15144305d103Sdrh   pNew->nSrc = pNew->nAlloc = p->nSrc;
1515ad3cab52Sdrh   for(i=0; i<p->nSrc; i++){
15164efc4754Sdrh     struct SrcList_item *pNewItem = &pNew->a[i];
15174efc4754Sdrh     struct SrcList_item *pOldItem = &p->a[i];
1518ed8a3bb1Sdrh     Table *pTab;
151941fb5cd1Sdan     pNewItem->pSchema = pOldItem->pSchema;
152017435752Sdrh     pNewItem->zDatabase = sqlite3DbStrDup(db, pOldItem->zDatabase);
152117435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
152217435752Sdrh     pNewItem->zAlias = sqlite3DbStrDup(db, pOldItem->zAlias);
15238a48b9c0Sdrh     pNewItem->fg = pOldItem->fg;
15244efc4754Sdrh     pNewItem->iCursor = pOldItem->iCursor;
15255b6a9ed4Sdrh     pNewItem->addrFillSub = pOldItem->addrFillSub;
15265b6a9ed4Sdrh     pNewItem->regReturn = pOldItem->regReturn;
15278a48b9c0Sdrh     if( pNewItem->fg.isIndexedBy ){
15288a48b9c0Sdrh       pNewItem->u1.zIndexedBy = sqlite3DbStrDup(db, pOldItem->u1.zIndexedBy);
15298a48b9c0Sdrh     }
15308a48b9c0Sdrh     pNewItem->pIBIndex = pOldItem->pIBIndex;
15318a48b9c0Sdrh     if( pNewItem->fg.isTabFunc ){
15328a48b9c0Sdrh       pNewItem->u1.pFuncArg =
15338a48b9c0Sdrh           sqlite3ExprListDup(db, pOldItem->u1.pFuncArg, flags);
15348a48b9c0Sdrh     }
1535ed8a3bb1Sdrh     pTab = pNewItem->pTab = pOldItem->pTab;
1536ed8a3bb1Sdrh     if( pTab ){
153779df7782Sdrh       pTab->nTabRef++;
1538a1cb183dSdanielk1977     }
15396ab3a2ecSdanielk1977     pNewItem->pSelect = sqlite3SelectDup(db, pOldItem->pSelect, flags);
15406ab3a2ecSdanielk1977     pNewItem->pOn = sqlite3ExprDup(db, pOldItem->pOn, flags);
154117435752Sdrh     pNewItem->pUsing = sqlite3IdListDup(db, pOldItem->pUsing);
15426c18b6e0Sdanielk1977     pNewItem->colUsed = pOldItem->colUsed;
1543ad3cab52Sdrh   }
1544ad3cab52Sdrh   return pNew;
1545ad3cab52Sdrh }
154617435752Sdrh IdList *sqlite3IdListDup(sqlite3 *db, IdList *p){
1547ff78bd2fSdrh   IdList *pNew;
1548ff78bd2fSdrh   int i;
1549575fad65Sdrh   assert( db!=0 );
1550ff78bd2fSdrh   if( p==0 ) return 0;
1551575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, sizeof(*pNew) );
1552ff78bd2fSdrh   if( pNew==0 ) return 0;
15536c535158Sdrh   pNew->nId = p->nId;
1554575fad65Sdrh   pNew->a = sqlite3DbMallocRawNN(db, p->nId*sizeof(p->a[0]) );
1555d5d56523Sdanielk1977   if( pNew->a==0 ){
1556dbd6a7dcSdrh     sqlite3DbFreeNN(db, pNew);
1557d5d56523Sdanielk1977     return 0;
1558d5d56523Sdanielk1977   }
15596c535158Sdrh   /* Note that because the size of the allocation for p->a[] is not
15606c535158Sdrh   ** necessarily a power of two, sqlite3IdListAppend() may not be called
15616c535158Sdrh   ** on the duplicate created by this function. */
1562ff78bd2fSdrh   for(i=0; i<p->nId; i++){
15634efc4754Sdrh     struct IdList_item *pNewItem = &pNew->a[i];
15644efc4754Sdrh     struct IdList_item *pOldItem = &p->a[i];
156517435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
15664efc4754Sdrh     pNewItem->idx = pOldItem->idx;
1567ff78bd2fSdrh   }
1568ff78bd2fSdrh   return pNew;
1569ff78bd2fSdrh }
1570a7466205Sdan Select *sqlite3SelectDup(sqlite3 *db, Select *pDup, int flags){
1571a7466205Sdan   Select *pRet = 0;
1572a7466205Sdan   Select *pNext = 0;
1573a7466205Sdan   Select **pp = &pRet;
1574a7466205Sdan   Select *p;
1575a7466205Sdan 
1576575fad65Sdrh   assert( db!=0 );
1577a7466205Sdan   for(p=pDup; p; p=p->pPrior){
1578a7466205Sdan     Select *pNew = sqlite3DbMallocRawNN(db, sizeof(*p) );
1579a7466205Sdan     if( pNew==0 ) break;
1580b7916a78Sdrh     pNew->pEList = sqlite3ExprListDup(db, p->pEList, flags);
15816ab3a2ecSdanielk1977     pNew->pSrc = sqlite3SrcListDup(db, p->pSrc, flags);
15826ab3a2ecSdanielk1977     pNew->pWhere = sqlite3ExprDup(db, p->pWhere, flags);
15836ab3a2ecSdanielk1977     pNew->pGroupBy = sqlite3ExprListDup(db, p->pGroupBy, flags);
15846ab3a2ecSdanielk1977     pNew->pHaving = sqlite3ExprDup(db, p->pHaving, flags);
15856ab3a2ecSdanielk1977     pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, flags);
1586ff78bd2fSdrh     pNew->op = p->op;
1587a7466205Sdan     pNew->pNext = pNext;
1588a7466205Sdan     pNew->pPrior = 0;
15896ab3a2ecSdanielk1977     pNew->pLimit = sqlite3ExprDup(db, p->pLimit, flags);
159092b01d53Sdrh     pNew->iLimit = 0;
159192b01d53Sdrh     pNew->iOffset = 0;
15927d10d5a6Sdrh     pNew->selFlags = p->selFlags & ~SF_UsesEphemeral;
1593b9bb7c18Sdrh     pNew->addrOpenEphm[0] = -1;
1594b9bb7c18Sdrh     pNew->addrOpenEphm[1] = -1;
1595ec2da854Sdrh     pNew->nSelectRow = p->nSelectRow;
15964e9119d9Sdan     pNew->pWith = withDup(db, p->pWith);
159767a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
15982e362f97Sdan     pNew->pWin = 0;
1599c95f38d4Sdan     pNew->pWinDefn = sqlite3WindowListDup(db, p->pWinDefn);
16004780b9adSdan     if( p->pWin && db->mallocFailed==0 ) gatherSelectWindows(pNew);
160167a9b8edSdan #endif
1602fef37760Sdrh     pNew->selId = p->selId;
1603a7466205Sdan     *pp = pNew;
1604a7466205Sdan     pp = &pNew->pPrior;
1605a7466205Sdan     pNext = pNew;
1606a7466205Sdan   }
1607a7466205Sdan 
1608a7466205Sdan   return pRet;
1609ff78bd2fSdrh }
161093758c8dSdanielk1977 #else
16116ab3a2ecSdanielk1977 Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
161293758c8dSdanielk1977   assert( p==0 );
161393758c8dSdanielk1977   return 0;
161493758c8dSdanielk1977 }
161593758c8dSdanielk1977 #endif
1616ff78bd2fSdrh 
1617ff78bd2fSdrh 
1618ff78bd2fSdrh /*
1619a76b5dfcSdrh ** Add a new element to the end of an expression list.  If pList is
1620a76b5dfcSdrh ** initially NULL, then create a new expression list.
1621b7916a78Sdrh **
1622a19543feSdrh ** The pList argument must be either NULL or a pointer to an ExprList
1623a19543feSdrh ** obtained from a prior call to sqlite3ExprListAppend().  This routine
1624a19543feSdrh ** may not be used with an ExprList obtained from sqlite3ExprListDup().
1625a19543feSdrh ** Reason:  This routine assumes that the number of slots in pList->a[]
1626a19543feSdrh ** is a power of two.  That is true for sqlite3ExprListAppend() returns
1627a19543feSdrh ** but is not necessarily true from the return value of sqlite3ExprListDup().
1628a19543feSdrh **
1629b7916a78Sdrh ** If a memory allocation error occurs, the entire list is freed and
1630b7916a78Sdrh ** NULL is returned.  If non-NULL is returned, then it is guaranteed
1631b7916a78Sdrh ** that the new entry was successfully appended.
1632a76b5dfcSdrh */
163317435752Sdrh ExprList *sqlite3ExprListAppend(
163417435752Sdrh   Parse *pParse,          /* Parsing context */
163517435752Sdrh   ExprList *pList,        /* List to which to append. Might be NULL */
1636b7916a78Sdrh   Expr *pExpr             /* Expression to be appended. Might be NULL */
163717435752Sdrh ){
163843606175Sdrh   struct ExprList_item *pItem;
163917435752Sdrh   sqlite3 *db = pParse->db;
1640575fad65Sdrh   assert( db!=0 );
1641a76b5dfcSdrh   if( pList==0 ){
1642575fad65Sdrh     pList = sqlite3DbMallocRawNN(db, sizeof(ExprList) );
1643a76b5dfcSdrh     if( pList==0 ){
1644d5d56523Sdanielk1977       goto no_mem;
1645a76b5dfcSdrh     }
1646c263f7c4Sdrh     pList->nExpr = 0;
1647a19543feSdrh   }else if( (pList->nExpr & (pList->nExpr-1))==0 ){
164843606175Sdrh     ExprList *pNew;
164943606175Sdrh     pNew = sqlite3DbRealloc(db, pList,
16500aa3231fSdrh          sizeof(*pList)+(2*(sqlite3_int64)pList->nExpr-1)*sizeof(pList->a[0]));
165143606175Sdrh     if( pNew==0 ){
1652d5d56523Sdanielk1977       goto no_mem;
1653a76b5dfcSdrh     }
165443606175Sdrh     pList = pNew;
1655a76b5dfcSdrh   }
165643606175Sdrh   pItem = &pList->a[pList->nExpr++];
165741cee668Sdrh   assert( offsetof(struct ExprList_item,zEName)==sizeof(pItem->pExpr) );
1658a8b9793cSdrh   assert( offsetof(struct ExprList_item,pExpr)==0 );
165941cee668Sdrh   memset(&pItem->zEName,0,sizeof(*pItem)-offsetof(struct ExprList_item,zEName));
1660e94ddc9eSdanielk1977   pItem->pExpr = pExpr;
1661a76b5dfcSdrh   return pList;
1662d5d56523Sdanielk1977 
1663d5d56523Sdanielk1977 no_mem:
1664d5d56523Sdanielk1977   /* Avoid leaking memory if malloc has failed. */
1665633e6d57Sdrh   sqlite3ExprDelete(db, pExpr);
1666633e6d57Sdrh   sqlite3ExprListDelete(db, pList);
1667d5d56523Sdanielk1977   return 0;
1668a76b5dfcSdrh }
1669a76b5dfcSdrh 
1670a76b5dfcSdrh /*
16718762ec19Sdrh ** pColumns and pExpr form a vector assignment which is part of the SET
16728762ec19Sdrh ** clause of an UPDATE statement.  Like this:
1673a1251bc4Sdrh **
1674a1251bc4Sdrh **        (a,b,c) = (expr1,expr2,expr3)
1675a1251bc4Sdrh ** Or:    (a,b,c) = (SELECT x,y,z FROM ....)
1676a1251bc4Sdrh **
1677a1251bc4Sdrh ** For each term of the vector assignment, append new entries to the
1678b67343d0Sdrh ** expression list pList.  In the case of a subquery on the RHS, append
1679a1251bc4Sdrh ** TK_SELECT_COLUMN expressions.
1680a1251bc4Sdrh */
1681a1251bc4Sdrh ExprList *sqlite3ExprListAppendVector(
1682a1251bc4Sdrh   Parse *pParse,         /* Parsing context */
1683a1251bc4Sdrh   ExprList *pList,       /* List to which to append. Might be NULL */
1684a1251bc4Sdrh   IdList *pColumns,      /* List of names of LHS of the assignment */
1685a1251bc4Sdrh   Expr *pExpr            /* Vector expression to be appended. Might be NULL */
1686a1251bc4Sdrh ){
1687a1251bc4Sdrh   sqlite3 *db = pParse->db;
1688a1251bc4Sdrh   int n;
1689a1251bc4Sdrh   int i;
169066860af3Sdrh   int iFirst = pList ? pList->nExpr : 0;
1691321e828dSdrh   /* pColumns can only be NULL due to an OOM but an OOM will cause an
1692321e828dSdrh   ** exit prior to this routine being invoked */
1693321e828dSdrh   if( NEVER(pColumns==0) ) goto vector_append_error;
1694a1251bc4Sdrh   if( pExpr==0 ) goto vector_append_error;
1695966e2911Sdrh 
1696966e2911Sdrh   /* If the RHS is a vector, then we can immediately check to see that
1697966e2911Sdrh   ** the size of the RHS and LHS match.  But if the RHS is a SELECT,
1698966e2911Sdrh   ** wildcards ("*") in the result set of the SELECT must be expanded before
1699966e2911Sdrh   ** we can do the size check, so defer the size check until code generation.
1700966e2911Sdrh   */
1701966e2911Sdrh   if( pExpr->op!=TK_SELECT && pColumns->nId!=(n=sqlite3ExprVectorSize(pExpr)) ){
1702a1251bc4Sdrh     sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
1703a1251bc4Sdrh                     pColumns->nId, n);
1704a1251bc4Sdrh     goto vector_append_error;
1705a1251bc4Sdrh   }
1706966e2911Sdrh 
1707966e2911Sdrh   for(i=0; i<pColumns->nId; i++){
1708a1251bc4Sdrh     Expr *pSubExpr = sqlite3ExprForVectorField(pParse, pExpr, i);
1709554a9dc7Sdrh     assert( pSubExpr!=0 || db->mallocFailed );
1710554a9dc7Sdrh     assert( pSubExpr==0 || pSubExpr->iTable==0 );
1711554a9dc7Sdrh     if( pSubExpr==0 ) continue;
1712554a9dc7Sdrh     pSubExpr->iTable = pColumns->nId;
1713a1251bc4Sdrh     pList = sqlite3ExprListAppend(pParse, pList, pSubExpr);
1714a1251bc4Sdrh     if( pList ){
171566860af3Sdrh       assert( pList->nExpr==iFirst+i+1 );
171641cee668Sdrh       pList->a[pList->nExpr-1].zEName = pColumns->a[i].zName;
1717a1251bc4Sdrh       pColumns->a[i].zName = 0;
1718a1251bc4Sdrh     }
1719a1251bc4Sdrh   }
1720966e2911Sdrh 
1721ffe28059Sdrh   if( !db->mallocFailed && pExpr->op==TK_SELECT && ALWAYS(pList!=0) ){
1722966e2911Sdrh     Expr *pFirst = pList->a[iFirst].pExpr;
1723f4dd26c5Sdrh     assert( pFirst!=0 );
1724966e2911Sdrh     assert( pFirst->op==TK_SELECT_COLUMN );
1725966e2911Sdrh 
1726966e2911Sdrh     /* Store the SELECT statement in pRight so it will be deleted when
1727966e2911Sdrh     ** sqlite3ExprListDelete() is called */
1728966e2911Sdrh     pFirst->pRight = pExpr;
1729a1251bc4Sdrh     pExpr = 0;
1730966e2911Sdrh 
1731966e2911Sdrh     /* Remember the size of the LHS in iTable so that we can check that
1732966e2911Sdrh     ** the RHS and LHS sizes match during code generation. */
1733966e2911Sdrh     pFirst->iTable = pColumns->nId;
1734a1251bc4Sdrh   }
1735a1251bc4Sdrh 
1736a1251bc4Sdrh vector_append_error:
17378e34e406Sdrh   sqlite3ExprUnmapAndDelete(pParse, pExpr);
1738a1251bc4Sdrh   sqlite3IdListDelete(db, pColumns);
1739a1251bc4Sdrh   return pList;
1740a1251bc4Sdrh }
1741a1251bc4Sdrh 
1742a1251bc4Sdrh /*
1743bc622bc0Sdrh ** Set the sort order for the last element on the given ExprList.
1744bc622bc0Sdrh */
17456e11892dSdan void sqlite3ExprListSetSortOrder(ExprList *p, int iSortOrder, int eNulls){
17469105fd51Sdan   struct ExprList_item *pItem;
1747bc622bc0Sdrh   if( p==0 ) return;
1748bc622bc0Sdrh   assert( p->nExpr>0 );
17496e11892dSdan 
17506e11892dSdan   assert( SQLITE_SO_UNDEFINED<0 && SQLITE_SO_ASC==0 && SQLITE_SO_DESC>0 );
17516e11892dSdan   assert( iSortOrder==SQLITE_SO_UNDEFINED
17526e11892dSdan        || iSortOrder==SQLITE_SO_ASC
17536e11892dSdan        || iSortOrder==SQLITE_SO_DESC
17546e11892dSdan   );
17556e11892dSdan   assert( eNulls==SQLITE_SO_UNDEFINED
17566e11892dSdan        || eNulls==SQLITE_SO_ASC
17576e11892dSdan        || eNulls==SQLITE_SO_DESC
17586e11892dSdan   );
17596e11892dSdan 
17609105fd51Sdan   pItem = &p->a[p->nExpr-1];
17619105fd51Sdan   assert( pItem->bNulls==0 );
17629105fd51Sdan   if( iSortOrder==SQLITE_SO_UNDEFINED ){
17639105fd51Sdan     iSortOrder = SQLITE_SO_ASC;
1764bc622bc0Sdrh   }
17659105fd51Sdan   pItem->sortFlags = (u8)iSortOrder;
17669105fd51Sdan 
17679105fd51Sdan   if( eNulls!=SQLITE_SO_UNDEFINED ){
17689105fd51Sdan     pItem->bNulls = 1;
17699105fd51Sdan     if( iSortOrder!=eNulls ){
17709105fd51Sdan       pItem->sortFlags |= KEYINFO_ORDER_BIGNULL;
17719105fd51Sdan     }
1772bc622bc0Sdrh   }
1773bc622bc0Sdrh }
1774bc622bc0Sdrh 
1775bc622bc0Sdrh /*
177641cee668Sdrh ** Set the ExprList.a[].zEName element of the most recently added item
1777b7916a78Sdrh ** on the expression list.
1778b7916a78Sdrh **
1779b7916a78Sdrh ** pList might be NULL following an OOM error.  But pName should never be
1780b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1781b7916a78Sdrh ** is set.
1782b7916a78Sdrh */
1783b7916a78Sdrh void sqlite3ExprListSetName(
1784b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1785b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
1786b7916a78Sdrh   Token *pName,           /* Name to be added */
1787b7916a78Sdrh   int dequote             /* True to cause the name to be dequoted */
1788b7916a78Sdrh ){
1789b7916a78Sdrh   assert( pList!=0 || pParse->db->mallocFailed!=0 );
1790b7916a78Sdrh   if( pList ){
1791b7916a78Sdrh     struct ExprList_item *pItem;
1792b7916a78Sdrh     assert( pList->nExpr>0 );
1793b7916a78Sdrh     pItem = &pList->a[pList->nExpr-1];
179441cee668Sdrh     assert( pItem->zEName==0 );
1795c4938ea2Sdrh     assert( pItem->eEName==ENAME_NAME );
179641cee668Sdrh     pItem->zEName = sqlite3DbStrNDup(pParse->db, pName->z, pName->n);
1797*85f2c76cSdan     if( dequote ){
1798*85f2c76cSdan       /* If dequote==0, then pName->z does not point to part of a DDL
1799*85f2c76cSdan       ** statement handled by the parser. And so no token need be added
1800*85f2c76cSdan       ** to the token-map.  */
1801*85f2c76cSdan       sqlite3Dequote(pItem->zEName);
1802c9461eccSdan       if( IN_RENAME_OBJECT ){
180341cee668Sdrh         sqlite3RenameTokenMap(pParse, (void*)pItem->zEName, pName);
18045be60c55Sdan       }
1805b7916a78Sdrh     }
1806b7916a78Sdrh   }
1807*85f2c76cSdan }
1808b7916a78Sdrh 
1809b7916a78Sdrh /*
1810b7916a78Sdrh ** Set the ExprList.a[].zSpan element of the most recently added item
1811b7916a78Sdrh ** on the expression list.
1812b7916a78Sdrh **
1813b7916a78Sdrh ** pList might be NULL following an OOM error.  But pSpan should never be
1814b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1815b7916a78Sdrh ** is set.
1816b7916a78Sdrh */
1817b7916a78Sdrh void sqlite3ExprListSetSpan(
1818b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1819b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
18201be266baSdrh   const char *zStart,     /* Start of the span */
18211be266baSdrh   const char *zEnd        /* End of the span */
1822b7916a78Sdrh ){
1823b7916a78Sdrh   sqlite3 *db = pParse->db;
1824b7916a78Sdrh   assert( pList!=0 || db->mallocFailed!=0 );
1825b7916a78Sdrh   if( pList ){
1826b7916a78Sdrh     struct ExprList_item *pItem = &pList->a[pList->nExpr-1];
1827b7916a78Sdrh     assert( pList->nExpr>0 );
1828cbb9da33Sdrh     if( pItem->zEName==0 ){
1829cbb9da33Sdrh       pItem->zEName = sqlite3DbSpanDup(db, zStart, zEnd);
1830cbb9da33Sdrh       pItem->eEName = ENAME_SPAN;
1831cbb9da33Sdrh     }
1832b7916a78Sdrh   }
1833b7916a78Sdrh }
1834b7916a78Sdrh 
1835b7916a78Sdrh /*
18367a15a4beSdanielk1977 ** If the expression list pEList contains more than iLimit elements,
18377a15a4beSdanielk1977 ** leave an error message in pParse.
18387a15a4beSdanielk1977 */
18397a15a4beSdanielk1977 void sqlite3ExprListCheckLength(
18407a15a4beSdanielk1977   Parse *pParse,
18417a15a4beSdanielk1977   ExprList *pEList,
18427a15a4beSdanielk1977   const char *zObject
18437a15a4beSdanielk1977 ){
1844b1a6c3c1Sdrh   int mx = pParse->db->aLimit[SQLITE_LIMIT_COLUMN];
1845c5499befSdrh   testcase( pEList && pEList->nExpr==mx );
1846c5499befSdrh   testcase( pEList && pEList->nExpr==mx+1 );
1847b1a6c3c1Sdrh   if( pEList && pEList->nExpr>mx ){
18487a15a4beSdanielk1977     sqlite3ErrorMsg(pParse, "too many columns in %s", zObject);
18497a15a4beSdanielk1977   }
18507a15a4beSdanielk1977 }
18517a15a4beSdanielk1977 
18527a15a4beSdanielk1977 /*
1853a76b5dfcSdrh ** Delete an entire expression list.
1854a76b5dfcSdrh */
1855affa855cSdrh static SQLITE_NOINLINE void exprListDeleteNN(sqlite3 *db, ExprList *pList){
1856ac48b751Sdrh   int i = pList->nExpr;
1857ac48b751Sdrh   struct ExprList_item *pItem =  pList->a;
1858ac48b751Sdrh   assert( pList->nExpr>0 );
1859ac48b751Sdrh   do{
1860633e6d57Sdrh     sqlite3ExprDelete(db, pItem->pExpr);
186141cee668Sdrh     sqlite3DbFree(db, pItem->zEName);
1862ac48b751Sdrh     pItem++;
1863ac48b751Sdrh   }while( --i>0 );
1864dbd6a7dcSdrh   sqlite3DbFreeNN(db, pList);
1865a76b5dfcSdrh }
1866affa855cSdrh void sqlite3ExprListDelete(sqlite3 *db, ExprList *pList){
1867affa855cSdrh   if( pList ) exprListDeleteNN(db, pList);
1868affa855cSdrh }
1869a76b5dfcSdrh 
1870a76b5dfcSdrh /*
18712308ed38Sdrh ** Return the bitwise-OR of all Expr.flags fields in the given
18722308ed38Sdrh ** ExprList.
1873885a5b03Sdrh */
18742308ed38Sdrh u32 sqlite3ExprListFlags(const ExprList *pList){
1875885a5b03Sdrh   int i;
18762308ed38Sdrh   u32 m = 0;
1877508e2d00Sdrh   assert( pList!=0 );
1878885a5b03Sdrh   for(i=0; i<pList->nExpr; i++){
1879d0c73053Sdrh      Expr *pExpr = pList->a[i].pExpr;
1880de845c2fSdrh      assert( pExpr!=0 );
1881de845c2fSdrh      m |= pExpr->flags;
1882885a5b03Sdrh   }
18832308ed38Sdrh   return m;
1884885a5b03Sdrh }
1885885a5b03Sdrh 
1886885a5b03Sdrh /*
18877e6f980bSdrh ** This is a SELECT-node callback for the expression walker that
18887e6f980bSdrh ** always "fails".  By "fail" in this case, we mean set
18897e6f980bSdrh ** pWalker->eCode to zero and abort.
18907e6f980bSdrh **
18917e6f980bSdrh ** This callback is used by multiple expression walkers.
18927e6f980bSdrh */
18937e6f980bSdrh int sqlite3SelectWalkFail(Walker *pWalker, Select *NotUsed){
18947e6f980bSdrh   UNUSED_PARAMETER(NotUsed);
18957e6f980bSdrh   pWalker->eCode = 0;
18967e6f980bSdrh   return WRC_Abort;
18977e6f980bSdrh }
18987e6f980bSdrh 
18997e6f980bSdrh /*
19000cbec59cSdrh ** Check the input string to see if it is "true" or "false" (in any case).
19010cbec59cSdrh **
19020cbec59cSdrh **       If the string is....           Return
19030cbec59cSdrh **         "true"                         EP_IsTrue
19040cbec59cSdrh **         "false"                        EP_IsFalse
19050cbec59cSdrh **         anything else                  0
19060cbec59cSdrh */
19070cbec59cSdrh u32 sqlite3IsTrueOrFalse(const char *zIn){
19080cbec59cSdrh   if( sqlite3StrICmp(zIn, "true")==0  ) return EP_IsTrue;
19090cbec59cSdrh   if( sqlite3StrICmp(zIn, "false")==0 ) return EP_IsFalse;
19100cbec59cSdrh   return 0;
19110cbec59cSdrh }
19120cbec59cSdrh 
19130cbec59cSdrh 
19140cbec59cSdrh /*
1915171d16bbSdrh ** If the input expression is an ID with the name "true" or "false"
191696acafbeSdrh ** then convert it into an TK_TRUEFALSE term.  Return non-zero if
191796acafbeSdrh ** the conversion happened, and zero if the expression is unaltered.
1918171d16bbSdrh */
1919171d16bbSdrh int sqlite3ExprIdToTrueFalse(Expr *pExpr){
19200cbec59cSdrh   u32 v;
1921171d16bbSdrh   assert( pExpr->op==TK_ID || pExpr->op==TK_STRING );
192251d35b0fSdrh   if( !ExprHasProperty(pExpr, EP_Quoted)
19230cbec59cSdrh    && (v = sqlite3IsTrueOrFalse(pExpr->u.zToken))!=0
1924171d16bbSdrh   ){
1925171d16bbSdrh     pExpr->op = TK_TRUEFALSE;
19260cbec59cSdrh     ExprSetProperty(pExpr, v);
1927171d16bbSdrh     return 1;
1928171d16bbSdrh   }
1929171d16bbSdrh   return 0;
1930171d16bbSdrh }
1931171d16bbSdrh 
193243c4ac8bSdrh /*
193396acafbeSdrh ** The argument must be a TK_TRUEFALSE Expr node.  Return 1 if it is TRUE
193443c4ac8bSdrh ** and 0 if it is FALSE.
193543c4ac8bSdrh */
193696acafbeSdrh int sqlite3ExprTruthValue(const Expr *pExpr){
19376ece353fSdan   pExpr = sqlite3ExprSkipCollate((Expr*)pExpr);
193843c4ac8bSdrh   assert( pExpr->op==TK_TRUEFALSE );
193943c4ac8bSdrh   assert( sqlite3StrICmp(pExpr->u.zToken,"true")==0
194043c4ac8bSdrh        || sqlite3StrICmp(pExpr->u.zToken,"false")==0 );
194143c4ac8bSdrh   return pExpr->u.zToken[4]==0;
194243c4ac8bSdrh }
194343c4ac8bSdrh 
194417180fcaSdrh /*
194517180fcaSdrh ** If pExpr is an AND or OR expression, try to simplify it by eliminating
194617180fcaSdrh ** terms that are always true or false.  Return the simplified expression.
194717180fcaSdrh ** Or return the original expression if no simplification is possible.
194817180fcaSdrh **
194917180fcaSdrh ** Examples:
195017180fcaSdrh **
195117180fcaSdrh **     (x<10) AND true                =>   (x<10)
195217180fcaSdrh **     (x<10) AND false               =>   false
195317180fcaSdrh **     (x<10) AND (y=22 OR false)     =>   (x<10) AND (y=22)
195417180fcaSdrh **     (x<10) AND (y=22 OR true)      =>   (x<10)
195517180fcaSdrh **     (y=22) OR true                 =>   true
195617180fcaSdrh */
195717180fcaSdrh Expr *sqlite3ExprSimplifiedAndOr(Expr *pExpr){
195817180fcaSdrh   assert( pExpr!=0 );
195917180fcaSdrh   if( pExpr->op==TK_AND || pExpr->op==TK_OR ){
196017180fcaSdrh     Expr *pRight = sqlite3ExprSimplifiedAndOr(pExpr->pRight);
196117180fcaSdrh     Expr *pLeft = sqlite3ExprSimplifiedAndOr(pExpr->pLeft);
196217180fcaSdrh     if( ExprAlwaysTrue(pLeft) || ExprAlwaysFalse(pRight) ){
196317180fcaSdrh       pExpr = pExpr->op==TK_AND ? pRight : pLeft;
196417180fcaSdrh     }else if( ExprAlwaysTrue(pRight) || ExprAlwaysFalse(pLeft) ){
196517180fcaSdrh       pExpr = pExpr->op==TK_AND ? pLeft : pRight;
196617180fcaSdrh     }
196717180fcaSdrh   }
196817180fcaSdrh   return pExpr;
196917180fcaSdrh }
197017180fcaSdrh 
1971171d16bbSdrh 
1972171d16bbSdrh /*
1973059b2d50Sdrh ** These routines are Walker callbacks used to check expressions to
1974059b2d50Sdrh ** see if they are "constant" for some definition of constant.  The
1975059b2d50Sdrh ** Walker.eCode value determines the type of "constant" we are looking
1976059b2d50Sdrh ** for.
197773b211abSdrh **
19787d10d5a6Sdrh ** These callback routines are used to implement the following:
1979626a879aSdrh **
1980059b2d50Sdrh **     sqlite3ExprIsConstant()                  pWalker->eCode==1
1981059b2d50Sdrh **     sqlite3ExprIsConstantNotJoin()           pWalker->eCode==2
1982fcb9f4f3Sdrh **     sqlite3ExprIsTableConstant()             pWalker->eCode==3
1983059b2d50Sdrh **     sqlite3ExprIsConstantOrFunction()        pWalker->eCode==4 or 5
198487abf5c0Sdrh **
1985059b2d50Sdrh ** In all cases, the callbacks set Walker.eCode=0 and abort if the expression
1986059b2d50Sdrh ** is found to not be a constant.
198787abf5c0Sdrh **
1988014fff20Sdrh ** The sqlite3ExprIsConstantOrFunction() is used for evaluating DEFAULT
1989014fff20Sdrh ** expressions in a CREATE TABLE statement.  The Walker.eCode value is 5
1990014fff20Sdrh ** when parsing an existing schema out of the sqlite_master table and 4
1991014fff20Sdrh ** when processing a new CREATE TABLE statement.  A bound parameter raises
1992014fff20Sdrh ** an error for new statements, but is silently converted
1993feada2dfSdrh ** to NULL for existing schemas.  This allows sqlite_master tables that
1994feada2dfSdrh ** contain a bound parameter because they were generated by older versions
1995feada2dfSdrh ** of SQLite to be parsed by newer versions of SQLite without raising a
1996feada2dfSdrh ** malformed schema error.
1997626a879aSdrh */
19987d10d5a6Sdrh static int exprNodeIsConstant(Walker *pWalker, Expr *pExpr){
1999626a879aSdrh 
2000059b2d50Sdrh   /* If pWalker->eCode is 2 then any term of the expression that comes from
2001059b2d50Sdrh   ** the ON or USING clauses of a left join disqualifies the expression
20020a168377Sdrh   ** from being considered constant. */
2003059b2d50Sdrh   if( pWalker->eCode==2 && ExprHasProperty(pExpr, EP_FromJoin) ){
2004059b2d50Sdrh     pWalker->eCode = 0;
20057d10d5a6Sdrh     return WRC_Abort;
20060a168377Sdrh   }
20070a168377Sdrh 
2008626a879aSdrh   switch( pExpr->op ){
2009eb55bd2fSdrh     /* Consider functions to be constant if all their arguments are constant
2010059b2d50Sdrh     ** and either pWalker->eCode==4 or 5 or the function has the
2011059b2d50Sdrh     ** SQLITE_FUNC_CONST flag. */
2012eb55bd2fSdrh     case TK_FUNCTION:
2013a634c9e6Sdrh       if( (pWalker->eCode>=4 || ExprHasProperty(pExpr,EP_ConstFunc))
2014a634c9e6Sdrh        && !ExprHasProperty(pExpr, EP_WinFunc)
2015a634c9e6Sdrh       ){
2016014fff20Sdrh         if( pWalker->eCode==5 ) ExprSetProperty(pExpr, EP_FromDDL);
2017b1fba286Sdrh         return WRC_Continue;
2018059b2d50Sdrh       }else{
2019059b2d50Sdrh         pWalker->eCode = 0;
2020059b2d50Sdrh         return WRC_Abort;
2021b1fba286Sdrh       }
2022626a879aSdrh     case TK_ID:
2023171d16bbSdrh       /* Convert "true" or "false" in a DEFAULT clause into the
2024171d16bbSdrh       ** appropriate TK_TRUEFALSE operator */
2025e39ef31cSdrh       if( sqlite3ExprIdToTrueFalse(pExpr) ){
2026171d16bbSdrh         return WRC_Prune;
2027171d16bbSdrh       }
2028171d16bbSdrh       /* Fall thru */
2029626a879aSdrh     case TK_COLUMN:
2030626a879aSdrh     case TK_AGG_FUNCTION:
203113449892Sdrh     case TK_AGG_COLUMN:
2032c5499befSdrh       testcase( pExpr->op==TK_ID );
2033c5499befSdrh       testcase( pExpr->op==TK_COLUMN );
2034c5499befSdrh       testcase( pExpr->op==TK_AGG_FUNCTION );
2035c5499befSdrh       testcase( pExpr->op==TK_AGG_COLUMN );
203607aded63Sdrh       if( ExprHasProperty(pExpr, EP_FixedCol) && pWalker->eCode!=2 ){
2037efad2e23Sdrh         return WRC_Continue;
2038efad2e23Sdrh       }
2039059b2d50Sdrh       if( pWalker->eCode==3 && pExpr->iTable==pWalker->u.iCur ){
2040059b2d50Sdrh         return WRC_Continue;
2041f43ce0b4Sdrh       }
2042f43ce0b4Sdrh       /* Fall through */
2043f43ce0b4Sdrh     case TK_IF_NULL_ROW:
20446e341b93Sdrh     case TK_REGISTER:
20459916048bSdrh       testcase( pExpr->op==TK_REGISTER );
2046f43ce0b4Sdrh       testcase( pExpr->op==TK_IF_NULL_ROW );
2047059b2d50Sdrh       pWalker->eCode = 0;
20487d10d5a6Sdrh       return WRC_Abort;
2049feada2dfSdrh     case TK_VARIABLE:
2050059b2d50Sdrh       if( pWalker->eCode==5 ){
2051feada2dfSdrh         /* Silently convert bound parameters that appear inside of CREATE
2052feada2dfSdrh         ** statements into a NULL when parsing the CREATE statement text out
2053feada2dfSdrh         ** of the sqlite_master table */
2054feada2dfSdrh         pExpr->op = TK_NULL;
2055059b2d50Sdrh       }else if( pWalker->eCode==4 ){
2056feada2dfSdrh         /* A bound parameter in a CREATE statement that originates from
2057feada2dfSdrh         ** sqlite3_prepare() causes an error */
2058059b2d50Sdrh         pWalker->eCode = 0;
2059feada2dfSdrh         return WRC_Abort;
2060feada2dfSdrh       }
2061feada2dfSdrh       /* Fall through */
2062626a879aSdrh     default:
20636e341b93Sdrh       testcase( pExpr->op==TK_SELECT ); /* sqlite3SelectWalkFail() disallows */
20646e341b93Sdrh       testcase( pExpr->op==TK_EXISTS ); /* sqlite3SelectWalkFail() disallows */
20657d10d5a6Sdrh       return WRC_Continue;
2066626a879aSdrh   }
2067626a879aSdrh }
2068059b2d50Sdrh static int exprIsConst(Expr *p, int initFlag, int iCur){
20697d10d5a6Sdrh   Walker w;
2070059b2d50Sdrh   w.eCode = initFlag;
20717d10d5a6Sdrh   w.xExprCallback = exprNodeIsConstant;
20727e6f980bSdrh   w.xSelectCallback = sqlite3SelectWalkFail;
2073979dd1beSdrh #ifdef SQLITE_DEBUG
2074979dd1beSdrh   w.xSelectCallback2 = sqlite3SelectWalkAssert2;
2075979dd1beSdrh #endif
2076059b2d50Sdrh   w.u.iCur = iCur;
20777d10d5a6Sdrh   sqlite3WalkExpr(&w, p);
2078059b2d50Sdrh   return w.eCode;
20797d10d5a6Sdrh }
2080626a879aSdrh 
2081626a879aSdrh /*
2082059b2d50Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
2083eb55bd2fSdrh ** and 0 if it involves variables or function calls.
20842398937bSdrh **
20852398937bSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
20862398937bSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
20872398937bSdrh ** a constant.
2088fef5208cSdrh */
20894adee20fSdanielk1977 int sqlite3ExprIsConstant(Expr *p){
2090059b2d50Sdrh   return exprIsConst(p, 1, 0);
2091fef5208cSdrh }
2092fef5208cSdrh 
2093fef5208cSdrh /*
209407aded63Sdrh ** Walk an expression tree.  Return non-zero if
209507aded63Sdrh **
209607aded63Sdrh **   (1) the expression is constant, and
209707aded63Sdrh **   (2) the expression does originate in the ON or USING clause
209807aded63Sdrh **       of a LEFT JOIN, and
209907aded63Sdrh **   (3) the expression does not contain any EP_FixedCol TK_COLUMN
210007aded63Sdrh **       operands created by the constant propagation optimization.
210107aded63Sdrh **
210207aded63Sdrh ** When this routine returns true, it indicates that the expression
210307aded63Sdrh ** can be added to the pParse->pConstExpr list and evaluated once when
21049b258c54Sdrh ** the prepared statement starts up.  See sqlite3ExprCodeRunJustOnce().
21050a168377Sdrh */
21060a168377Sdrh int sqlite3ExprIsConstantNotJoin(Expr *p){
2107059b2d50Sdrh   return exprIsConst(p, 2, 0);
21080a168377Sdrh }
21090a168377Sdrh 
21100a168377Sdrh /*
2111fcb9f4f3Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
2112059b2d50Sdrh ** for any single row of the table with cursor iCur.  In other words, the
2113059b2d50Sdrh ** expression must not refer to any non-deterministic function nor any
2114059b2d50Sdrh ** table other than iCur.
2115059b2d50Sdrh */
2116059b2d50Sdrh int sqlite3ExprIsTableConstant(Expr *p, int iCur){
2117059b2d50Sdrh   return exprIsConst(p, 3, iCur);
2118059b2d50Sdrh }
2119059b2d50Sdrh 
2120ab31a845Sdan 
2121ab31a845Sdan /*
2122ab31a845Sdan ** sqlite3WalkExpr() callback used by sqlite3ExprIsConstantOrGroupBy().
2123ab31a845Sdan */
2124ab31a845Sdan static int exprNodeIsConstantOrGroupBy(Walker *pWalker, Expr *pExpr){
2125ab31a845Sdan   ExprList *pGroupBy = pWalker->u.pGroupBy;
2126ab31a845Sdan   int i;
2127ab31a845Sdan 
2128ab31a845Sdan   /* Check if pExpr is identical to any GROUP BY term. If so, consider
2129ab31a845Sdan   ** it constant.  */
2130ab31a845Sdan   for(i=0; i<pGroupBy->nExpr; i++){
2131ab31a845Sdan     Expr *p = pGroupBy->a[i].pExpr;
21325aa550cfSdan     if( sqlite3ExprCompare(0, pExpr, p, -1)<2 ){
213370efa84dSdrh       CollSeq *pColl = sqlite3ExprNNCollSeq(pWalker->pParse, p);
2134efad2e23Sdrh       if( sqlite3IsBinary(pColl) ){
2135ab31a845Sdan         return WRC_Prune;
2136ab31a845Sdan       }
2137ab31a845Sdan     }
2138ab31a845Sdan   }
2139ab31a845Sdan 
2140ab31a845Sdan   /* Check if pExpr is a sub-select. If so, consider it variable. */
2141ab31a845Sdan   if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2142ab31a845Sdan     pWalker->eCode = 0;
2143ab31a845Sdan     return WRC_Abort;
2144ab31a845Sdan   }
2145ab31a845Sdan 
2146ab31a845Sdan   return exprNodeIsConstant(pWalker, pExpr);
2147ab31a845Sdan }
2148ab31a845Sdan 
2149ab31a845Sdan /*
2150ab31a845Sdan ** Walk the expression tree passed as the first argument. Return non-zero
2151ab31a845Sdan ** if the expression consists entirely of constants or copies of terms
2152ab31a845Sdan ** in pGroupBy that sort with the BINARY collation sequence.
2153ab314001Sdrh **
2154ab314001Sdrh ** This routine is used to determine if a term of the HAVING clause can
2155ab314001Sdrh ** be promoted into the WHERE clause.  In order for such a promotion to work,
2156ab314001Sdrh ** the value of the HAVING clause term must be the same for all members of
2157ab314001Sdrh ** a "group".  The requirement that the GROUP BY term must be BINARY
2158ab314001Sdrh ** assumes that no other collating sequence will have a finer-grained
2159ab314001Sdrh ** grouping than binary.  In other words (A=B COLLATE binary) implies
2160ab314001Sdrh ** A=B in every other collating sequence.  The requirement that the
2161ab314001Sdrh ** GROUP BY be BINARY is stricter than necessary.  It would also work
2162ab314001Sdrh ** to promote HAVING clauses that use the same alternative collating
2163ab314001Sdrh ** sequence as the GROUP BY term, but that is much harder to check,
2164ab314001Sdrh ** alternative collating sequences are uncommon, and this is only an
2165ab314001Sdrh ** optimization, so we take the easy way out and simply require the
2166ab314001Sdrh ** GROUP BY to use the BINARY collating sequence.
2167ab31a845Sdan */
2168ab31a845Sdan int sqlite3ExprIsConstantOrGroupBy(Parse *pParse, Expr *p, ExprList *pGroupBy){
2169ab31a845Sdan   Walker w;
2170ab31a845Sdan   w.eCode = 1;
2171ab31a845Sdan   w.xExprCallback = exprNodeIsConstantOrGroupBy;
2172979dd1beSdrh   w.xSelectCallback = 0;
2173ab31a845Sdan   w.u.pGroupBy = pGroupBy;
2174ab31a845Sdan   w.pParse = pParse;
2175ab31a845Sdan   sqlite3WalkExpr(&w, p);
2176ab31a845Sdan   return w.eCode;
2177ab31a845Sdan }
2178ab31a845Sdan 
2179059b2d50Sdrh /*
2180014fff20Sdrh ** Walk an expression tree for the DEFAULT field of a column definition
2181014fff20Sdrh ** in a CREATE TABLE statement.  Return non-zero if the expression is
2182014fff20Sdrh ** acceptable for use as a DEFAULT.  That is to say, return non-zero if
2183014fff20Sdrh ** the expression is constant or a function call with constant arguments.
2184014fff20Sdrh ** Return and 0 if there are any variables.
2185014fff20Sdrh **
2186014fff20Sdrh ** isInit is true when parsing from sqlite_master.  isInit is false when
2187014fff20Sdrh ** processing a new CREATE TABLE statement.  When isInit is true, parameters
2188014fff20Sdrh ** (such as ? or $abc) in the expression are converted into NULL.  When
2189014fff20Sdrh ** isInit is false, parameters raise an error.  Parameters should not be
2190014fff20Sdrh ** allowed in a CREATE TABLE statement, but some legacy versions of SQLite
2191014fff20Sdrh ** allowed it, so we need to support it when reading sqlite_master for
2192014fff20Sdrh ** backwards compatibility.
2193014fff20Sdrh **
2194014fff20Sdrh ** If isInit is true, set EP_FromDDL on every TK_FUNCTION node.
2195eb55bd2fSdrh **
2196eb55bd2fSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
2197eb55bd2fSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
2198eb55bd2fSdrh ** a constant.
2199eb55bd2fSdrh */
2200feada2dfSdrh int sqlite3ExprIsConstantOrFunction(Expr *p, u8 isInit){
2201feada2dfSdrh   assert( isInit==0 || isInit==1 );
2202059b2d50Sdrh   return exprIsConst(p, 4+isInit, 0);
2203eb55bd2fSdrh }
2204eb55bd2fSdrh 
22055b88bc4bSdrh #ifdef SQLITE_ENABLE_CURSOR_HINTS
22065b88bc4bSdrh /*
22075b88bc4bSdrh ** Walk an expression tree.  Return 1 if the expression contains a
22085b88bc4bSdrh ** subquery of some kind.  Return 0 if there are no subqueries.
22095b88bc4bSdrh */
22105b88bc4bSdrh int sqlite3ExprContainsSubquery(Expr *p){
22115b88bc4bSdrh   Walker w;
2212bec2476aSdrh   w.eCode = 1;
22135b88bc4bSdrh   w.xExprCallback = sqlite3ExprWalkNoop;
22147e6f980bSdrh   w.xSelectCallback = sqlite3SelectWalkFail;
2215979dd1beSdrh #ifdef SQLITE_DEBUG
2216979dd1beSdrh   w.xSelectCallback2 = sqlite3SelectWalkAssert2;
2217979dd1beSdrh #endif
22185b88bc4bSdrh   sqlite3WalkExpr(&w, p);
221907194bffSdrh   return w.eCode==0;
22205b88bc4bSdrh }
22215b88bc4bSdrh #endif
22225b88bc4bSdrh 
2223eb55bd2fSdrh /*
222473b211abSdrh ** If the expression p codes a constant integer that is small enough
2225202b2df7Sdrh ** to fit in a 32-bit integer, return 1 and put the value of the integer
2226202b2df7Sdrh ** in *pValue.  If the expression is not an integer or if it is too big
2227202b2df7Sdrh ** to fit in a signed 32-bit integer, return 0 and leave *pValue unchanged.
2228e4de1febSdrh */
22294adee20fSdanielk1977 int sqlite3ExprIsInteger(Expr *p, int *pValue){
223092b01d53Sdrh   int rc = 0;
22311d2d71a0Sdrh   if( NEVER(p==0) ) return 0;  /* Used to only happen following on OOM */
2232cd92e84dSdrh 
2233cd92e84dSdrh   /* If an expression is an integer literal that fits in a signed 32-bit
2234cd92e84dSdrh   ** integer, then the EP_IntValue flag will have already been set */
2235cd92e84dSdrh   assert( p->op!=TK_INTEGER || (p->flags & EP_IntValue)!=0
2236cd92e84dSdrh            || sqlite3GetInt32(p->u.zToken, &rc)==0 );
2237cd92e84dSdrh 
223892b01d53Sdrh   if( p->flags & EP_IntValue ){
223933e619fcSdrh     *pValue = p->u.iValue;
2240e4de1febSdrh     return 1;
2241e4de1febSdrh   }
224292b01d53Sdrh   switch( p->op ){
22434b59ab5eSdrh     case TK_UPLUS: {
224492b01d53Sdrh       rc = sqlite3ExprIsInteger(p->pLeft, pValue);
2245f6e369a1Sdrh       break;
22464b59ab5eSdrh     }
2247e4de1febSdrh     case TK_UMINUS: {
2248e4de1febSdrh       int v;
22494adee20fSdanielk1977       if( sqlite3ExprIsInteger(p->pLeft, &v) ){
2250f6418891Smistachkin         assert( v!=(-2147483647-1) );
2251e4de1febSdrh         *pValue = -v;
225292b01d53Sdrh         rc = 1;
2253e4de1febSdrh       }
2254e4de1febSdrh       break;
2255e4de1febSdrh     }
2256e4de1febSdrh     default: break;
2257e4de1febSdrh   }
225892b01d53Sdrh   return rc;
2259e4de1febSdrh }
2260e4de1febSdrh 
2261e4de1febSdrh /*
2262039fc32eSdrh ** Return FALSE if there is no chance that the expression can be NULL.
2263039fc32eSdrh **
2264039fc32eSdrh ** If the expression might be NULL or if the expression is too complex
2265039fc32eSdrh ** to tell return TRUE.
2266039fc32eSdrh **
2267039fc32eSdrh ** This routine is used as an optimization, to skip OP_IsNull opcodes
2268039fc32eSdrh ** when we know that a value cannot be NULL.  Hence, a false positive
2269039fc32eSdrh ** (returning TRUE when in fact the expression can never be NULL) might
2270039fc32eSdrh ** be a small performance hit but is otherwise harmless.  On the other
2271039fc32eSdrh ** hand, a false negative (returning FALSE when the result could be NULL)
2272039fc32eSdrh ** will likely result in an incorrect answer.  So when in doubt, return
2273039fc32eSdrh ** TRUE.
2274039fc32eSdrh */
2275039fc32eSdrh int sqlite3ExprCanBeNull(const Expr *p){
2276039fc32eSdrh   u8 op;
22779bfb0794Sdrh   while( p->op==TK_UPLUS || p->op==TK_UMINUS ){
22789bfb0794Sdrh     p = p->pLeft;
22799bfb0794Sdrh   }
2280039fc32eSdrh   op = p->op;
2281039fc32eSdrh   if( op==TK_REGISTER ) op = p->op2;
2282039fc32eSdrh   switch( op ){
2283039fc32eSdrh     case TK_INTEGER:
2284039fc32eSdrh     case TK_STRING:
2285039fc32eSdrh     case TK_FLOAT:
2286039fc32eSdrh     case TK_BLOB:
2287039fc32eSdrh       return 0;
22887248a8b2Sdrh     case TK_COLUMN:
228972673a24Sdrh       return ExprHasProperty(p, EP_CanBeNull) ||
2290eda079cdSdrh              p->y.pTab==0 ||  /* Reference to column of index on expression */
22914eac5f04Sdrh              (p->iColumn>=0
22924eac5f04Sdrh               && ALWAYS(p->y.pTab->aCol!=0) /* Defense against OOM problems */
22934eac5f04Sdrh               && p->y.pTab->aCol[p->iColumn].notNull==0);
2294039fc32eSdrh     default:
2295039fc32eSdrh       return 1;
2296039fc32eSdrh   }
2297039fc32eSdrh }
2298039fc32eSdrh 
2299039fc32eSdrh /*
2300039fc32eSdrh ** Return TRUE if the given expression is a constant which would be
2301039fc32eSdrh ** unchanged by OP_Affinity with the affinity given in the second
2302039fc32eSdrh ** argument.
2303039fc32eSdrh **
2304039fc32eSdrh ** This routine is used to determine if the OP_Affinity operation
2305039fc32eSdrh ** can be omitted.  When in doubt return FALSE.  A false negative
2306039fc32eSdrh ** is harmless.  A false positive, however, can result in the wrong
2307039fc32eSdrh ** answer.
2308039fc32eSdrh */
2309039fc32eSdrh int sqlite3ExprNeedsNoAffinityChange(const Expr *p, char aff){
2310039fc32eSdrh   u8 op;
2311af866402Sdrh   int unaryMinus = 0;
231205883a34Sdrh   if( aff==SQLITE_AFF_BLOB ) return 1;
2313af866402Sdrh   while( p->op==TK_UPLUS || p->op==TK_UMINUS ){
2314af866402Sdrh     if( p->op==TK_UMINUS ) unaryMinus = 1;
2315af866402Sdrh     p = p->pLeft;
2316af866402Sdrh   }
2317039fc32eSdrh   op = p->op;
2318039fc32eSdrh   if( op==TK_REGISTER ) op = p->op2;
2319039fc32eSdrh   switch( op ){
2320039fc32eSdrh     case TK_INTEGER: {
23216a19865fSdrh       return aff>=SQLITE_AFF_NUMERIC;
2322039fc32eSdrh     }
2323039fc32eSdrh     case TK_FLOAT: {
23246a19865fSdrh       return aff>=SQLITE_AFF_NUMERIC;
2325039fc32eSdrh     }
2326039fc32eSdrh     case TK_STRING: {
2327af866402Sdrh       return !unaryMinus && aff==SQLITE_AFF_TEXT;
2328039fc32eSdrh     }
2329039fc32eSdrh     case TK_BLOB: {
2330af866402Sdrh       return !unaryMinus;
2331039fc32eSdrh     }
23322f2855b6Sdrh     case TK_COLUMN: {
233388376ca7Sdrh       assert( p->iTable>=0 );  /* p cannot be part of a CHECK constraint */
23346a19865fSdrh       return aff>=SQLITE_AFF_NUMERIC && p->iColumn<0;
23352f2855b6Sdrh     }
2336039fc32eSdrh     default: {
2337039fc32eSdrh       return 0;
2338039fc32eSdrh     }
2339039fc32eSdrh   }
2340039fc32eSdrh }
2341039fc32eSdrh 
2342039fc32eSdrh /*
2343c4a3c779Sdrh ** Return TRUE if the given string is a row-id column name.
2344c4a3c779Sdrh */
23454adee20fSdanielk1977 int sqlite3IsRowid(const char *z){
23464adee20fSdanielk1977   if( sqlite3StrICmp(z, "_ROWID_")==0 ) return 1;
23474adee20fSdanielk1977   if( sqlite3StrICmp(z, "ROWID")==0 ) return 1;
23484adee20fSdanielk1977   if( sqlite3StrICmp(z, "OID")==0 ) return 1;
2349c4a3c779Sdrh   return 0;
2350c4a3c779Sdrh }
2351c4a3c779Sdrh 
23529a96b668Sdanielk1977 /*
235369c355bdSdrh ** pX is the RHS of an IN operator.  If pX is a SELECT statement
235469c355bdSdrh ** that can be simplified to a direct table access, then return
235569c355bdSdrh ** a pointer to the SELECT statement.  If pX is not a SELECT statement,
235669c355bdSdrh ** or if the SELECT statement needs to be manifested into a transient
235769c355bdSdrh ** table, then return NULL.
2358b287f4b6Sdrh */
2359b287f4b6Sdrh #ifndef SQLITE_OMIT_SUBQUERY
23607b35a77bSdan static Select *isCandidateForInOpt(Expr *pX){
236169c355bdSdrh   Select *p;
2362b287f4b6Sdrh   SrcList *pSrc;
2363b287f4b6Sdrh   ExprList *pEList;
2364b287f4b6Sdrh   Table *pTab;
2365cfbb5e82Sdan   int i;
236669c355bdSdrh   if( !ExprHasProperty(pX, EP_xIsSelect) ) return 0;  /* Not a subquery */
236769c355bdSdrh   if( ExprHasProperty(pX, EP_VarSelect)  ) return 0;  /* Correlated subq */
236869c355bdSdrh   p = pX->x.pSelect;
2369b287f4b6Sdrh   if( p->pPrior ) return 0;              /* Not a compound SELECT */
23707d10d5a6Sdrh   if( p->selFlags & (SF_Distinct|SF_Aggregate) ){
2371b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
2372b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
23737d10d5a6Sdrh     return 0; /* No DISTINCT keyword and no aggregate functions */
23747d10d5a6Sdrh   }
23752e26a602Sdrh   assert( p->pGroupBy==0 );              /* Has no GROUP BY clause */
2376b287f4b6Sdrh   if( p->pLimit ) return 0;              /* Has no LIMIT clause */
2377b287f4b6Sdrh   if( p->pWhere ) return 0;              /* Has no WHERE clause */
2378b287f4b6Sdrh   pSrc = p->pSrc;
2379d1fa7bcaSdrh   assert( pSrc!=0 );
2380d1fa7bcaSdrh   if( pSrc->nSrc!=1 ) return 0;          /* Single term in FROM clause */
2381b74b1017Sdrh   if( pSrc->a[0].pSelect ) return 0;     /* FROM is not a subquery or view */
2382b287f4b6Sdrh   pTab = pSrc->a[0].pTab;
238369c355bdSdrh   assert( pTab!=0 );
2384b74b1017Sdrh   assert( pTab->pSelect==0 );            /* FROM clause is not a view */
2385b287f4b6Sdrh   if( IsVirtual(pTab) ) return 0;        /* FROM clause not a virtual table */
2386b287f4b6Sdrh   pEList = p->pEList;
2387ac6b47d1Sdrh   assert( pEList!=0 );
23887b35a77bSdan   /* All SELECT results must be columns. */
2389cfbb5e82Sdan   for(i=0; i<pEList->nExpr; i++){
2390cfbb5e82Sdan     Expr *pRes = pEList->a[i].pExpr;
2391cfbb5e82Sdan     if( pRes->op!=TK_COLUMN ) return 0;
239269c355bdSdrh     assert( pRes->iTable==pSrc->a[0].iCursor );  /* Not a correlated subquery */
2393cfbb5e82Sdan   }
239469c355bdSdrh   return p;
2395b287f4b6Sdrh }
2396b287f4b6Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
2397b287f4b6Sdrh 
2398f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
23991d8cb21fSdan /*
24004c259e9fSdrh ** Generate code that checks the left-most column of index table iCur to see if
24014c259e9fSdrh ** it contains any NULL entries.  Cause the register at regHasNull to be set
24026be515ebSdrh ** to a non-NULL value if iCur contains no NULLs.  Cause register regHasNull
24036be515ebSdrh ** to be set to NULL if iCur contains one or more NULL values.
24046be515ebSdrh */
24056be515ebSdrh static void sqlite3SetHasNullFlag(Vdbe *v, int iCur, int regHasNull){
2406728e0f91Sdrh   int addr1;
24076be515ebSdrh   sqlite3VdbeAddOp2(v, OP_Integer, 0, regHasNull);
2408728e0f91Sdrh   addr1 = sqlite3VdbeAddOp1(v, OP_Rewind, iCur); VdbeCoverage(v);
24096be515ebSdrh   sqlite3VdbeAddOp3(v, OP_Column, iCur, 0, regHasNull);
24106be515ebSdrh   sqlite3VdbeChangeP5(v, OPFLAG_TYPEOFARG);
24114c259e9fSdrh   VdbeComment((v, "first_entry_in(%d)", iCur));
2412728e0f91Sdrh   sqlite3VdbeJumpHere(v, addr1);
24136be515ebSdrh }
2414f9b2e05cSdan #endif
24156be515ebSdrh 
2416bb53ecb1Sdrh 
2417bb53ecb1Sdrh #ifndef SQLITE_OMIT_SUBQUERY
2418bb53ecb1Sdrh /*
2419bb53ecb1Sdrh ** The argument is an IN operator with a list (not a subquery) on the
2420bb53ecb1Sdrh ** right-hand side.  Return TRUE if that list is constant.
2421bb53ecb1Sdrh */
2422bb53ecb1Sdrh static int sqlite3InRhsIsConstant(Expr *pIn){
2423bb53ecb1Sdrh   Expr *pLHS;
2424bb53ecb1Sdrh   int res;
2425bb53ecb1Sdrh   assert( !ExprHasProperty(pIn, EP_xIsSelect) );
2426bb53ecb1Sdrh   pLHS = pIn->pLeft;
2427bb53ecb1Sdrh   pIn->pLeft = 0;
2428bb53ecb1Sdrh   res = sqlite3ExprIsConstant(pIn);
2429bb53ecb1Sdrh   pIn->pLeft = pLHS;
2430bb53ecb1Sdrh   return res;
2431bb53ecb1Sdrh }
2432bb53ecb1Sdrh #endif
2433bb53ecb1Sdrh 
24346be515ebSdrh /*
24359a96b668Sdanielk1977 ** This function is used by the implementation of the IN (...) operator.
2436d4305ca6Sdrh ** The pX parameter is the expression on the RHS of the IN operator, which
2437d4305ca6Sdrh ** might be either a list of expressions or a subquery.
24389a96b668Sdanielk1977 **
2439d4305ca6Sdrh ** The job of this routine is to find or create a b-tree object that can
2440d4305ca6Sdrh ** be used either to test for membership in the RHS set or to iterate through
2441d4305ca6Sdrh ** all members of the RHS set, skipping duplicates.
2442d4305ca6Sdrh **
24433a85625dSdrh ** A cursor is opened on the b-tree object that is the RHS of the IN operator
2444d4305ca6Sdrh ** and pX->iTable is set to the index of that cursor.
2445d4305ca6Sdrh **
2446b74b1017Sdrh ** The returned value of this function indicates the b-tree type, as follows:
24479a96b668Sdanielk1977 **
24489a96b668Sdanielk1977 **   IN_INDEX_ROWID      - The cursor was opened on a database table.
24491ccce449Sdrh **   IN_INDEX_INDEX_ASC  - The cursor was opened on an ascending index.
24501ccce449Sdrh **   IN_INDEX_INDEX_DESC - The cursor was opened on a descending index.
24519a96b668Sdanielk1977 **   IN_INDEX_EPH        - The cursor was opened on a specially created and
24529a96b668Sdanielk1977 **                         populated epheremal table.
2453bb53ecb1Sdrh **   IN_INDEX_NOOP       - No cursor was allocated.  The IN operator must be
2454bb53ecb1Sdrh **                         implemented as a sequence of comparisons.
24559a96b668Sdanielk1977 **
2456d4305ca6Sdrh ** An existing b-tree might be used if the RHS expression pX is a simple
2457d4305ca6Sdrh ** subquery such as:
24589a96b668Sdanielk1977 **
2459553168c7Sdan **     SELECT <column1>, <column2>... FROM <table>
24609a96b668Sdanielk1977 **
2461d4305ca6Sdrh ** If the RHS of the IN operator is a list or a more complex subquery, then
2462d4305ca6Sdrh ** an ephemeral table might need to be generated from the RHS and then
246360ec914cSpeter.d.reid ** pX->iTable made to point to the ephemeral table instead of an
2464d4305ca6Sdrh ** existing table.
2465d4305ca6Sdrh **
24667fc0ba0fSdrh ** The inFlags parameter must contain, at a minimum, one of the bits
24677fc0ba0fSdrh ** IN_INDEX_MEMBERSHIP or IN_INDEX_LOOP but not both.  If inFlags contains
24687fc0ba0fSdrh ** IN_INDEX_MEMBERSHIP, then the generated table will be used for a fast
24697fc0ba0fSdrh ** membership test.  When the IN_INDEX_LOOP bit is set, the IN index will
24707fc0ba0fSdrh ** be used to loop over all values of the RHS of the IN operator.
24713a85625dSdrh **
24723a85625dSdrh ** When IN_INDEX_LOOP is used (and the b-tree will be used to iterate
24733a85625dSdrh ** through the set members) then the b-tree must not contain duplicates.
24747fc0ba0fSdrh ** An epheremal table will be created unless the selected columns are guaranteed
2475553168c7Sdan ** to be unique - either because it is an INTEGER PRIMARY KEY or due to
2476553168c7Sdan ** a UNIQUE constraint or index.
24770cdc022eSdanielk1977 **
24783a85625dSdrh ** When IN_INDEX_MEMBERSHIP is used (and the b-tree will be used
24793a85625dSdrh ** for fast set membership tests) then an epheremal table must
2480553168c7Sdan ** be used unless <columns> is a single INTEGER PRIMARY KEY column or an
2481553168c7Sdan ** index can be found with the specified <columns> as its left-most.
24820cdc022eSdanielk1977 **
2483bb53ecb1Sdrh ** If the IN_INDEX_NOOP_OK and IN_INDEX_MEMBERSHIP are both set and
2484bb53ecb1Sdrh ** if the RHS of the IN operator is a list (not a subquery) then this
2485bb53ecb1Sdrh ** routine might decide that creating an ephemeral b-tree for membership
2486bb53ecb1Sdrh ** testing is too expensive and return IN_INDEX_NOOP.  In that case, the
2487bb53ecb1Sdrh ** calling routine should implement the IN operator using a sequence
2488bb53ecb1Sdrh ** of Eq or Ne comparison operations.
2489bb53ecb1Sdrh **
2490b74b1017Sdrh ** When the b-tree is being used for membership tests, the calling function
24913a85625dSdrh ** might need to know whether or not the RHS side of the IN operator
2492e21a6e1dSdrh ** contains a NULL.  If prRhsHasNull is not a NULL pointer and
24933a85625dSdrh ** if there is any chance that the (...) might contain a NULL value at
24940cdc022eSdanielk1977 ** runtime, then a register is allocated and the register number written
2495e21a6e1dSdrh ** to *prRhsHasNull. If there is no chance that the (...) contains a
2496e21a6e1dSdrh ** NULL value, then *prRhsHasNull is left unchanged.
24970cdc022eSdanielk1977 **
2498e21a6e1dSdrh ** If a register is allocated and its location stored in *prRhsHasNull, then
24996be515ebSdrh ** the value in that register will be NULL if the b-tree contains one or more
25006be515ebSdrh ** NULL values, and it will be some non-NULL value if the b-tree contains no
25016be515ebSdrh ** NULL values.
2502553168c7Sdan **
2503553168c7Sdan ** If the aiMap parameter is not NULL, it must point to an array containing
2504553168c7Sdan ** one element for each column returned by the SELECT statement on the RHS
2505553168c7Sdan ** of the IN(...) operator. The i'th entry of the array is populated with the
2506553168c7Sdan ** offset of the index column that matches the i'th column returned by the
2507553168c7Sdan ** SELECT. For example, if the expression and selected index are:
2508553168c7Sdan **
2509553168c7Sdan **   (?,?,?) IN (SELECT a, b, c FROM t1)
2510553168c7Sdan **   CREATE INDEX i1 ON t1(b, c, a);
2511553168c7Sdan **
2512553168c7Sdan ** then aiMap[] is populated with {2, 0, 1}.
25139a96b668Sdanielk1977 */
2514284f4acaSdanielk1977 #ifndef SQLITE_OMIT_SUBQUERY
2515ba00e30aSdan int sqlite3FindInIndex(
25166fc8f364Sdrh   Parse *pParse,             /* Parsing context */
25170167ef20Sdrh   Expr *pX,                  /* The IN expression */
25186fc8f364Sdrh   u32 inFlags,               /* IN_INDEX_LOOP, _MEMBERSHIP, and/or _NOOP_OK */
25196fc8f364Sdrh   int *prRhsHasNull,         /* Register holding NULL status.  See notes */
25202c04131cSdrh   int *aiMap,                /* Mapping from Index fields to RHS fields */
25212c04131cSdrh   int *piTab                 /* OUT: index to use */
2522ba00e30aSdan ){
2523b74b1017Sdrh   Select *p;                            /* SELECT to the right of IN operator */
2524b74b1017Sdrh   int eType = 0;                        /* Type of RHS table. IN_INDEX_* */
2525b74b1017Sdrh   int iTab = pParse->nTab++;            /* Cursor of the RHS table */
25263a85625dSdrh   int mustBeUnique;                     /* True if RHS must be unique */
2527b8475df8Sdrh   Vdbe *v = sqlite3GetVdbe(pParse);     /* Virtual machine being coded */
25289a96b668Sdanielk1977 
25291450bc6eSdrh   assert( pX->op==TK_IN );
25303a85625dSdrh   mustBeUnique = (inFlags & IN_INDEX_LOOP)!=0;
25311450bc6eSdrh 
25327b35a77bSdan   /* If the RHS of this IN(...) operator is a SELECT, and if it matters
25337b35a77bSdan   ** whether or not the SELECT result contains NULL values, check whether
2534870a0705Sdan   ** or not NULL is actually possible (it may not be, for example, due
25357b35a77bSdan   ** to NOT NULL constraints in the schema). If no NULL values are possible,
2536870a0705Sdan   ** set prRhsHasNull to 0 before continuing.  */
25377b35a77bSdan   if( prRhsHasNull && (pX->flags & EP_xIsSelect) ){
25387b35a77bSdan     int i;
25397b35a77bSdan     ExprList *pEList = pX->x.pSelect->pEList;
25407b35a77bSdan     for(i=0; i<pEList->nExpr; i++){
25417b35a77bSdan       if( sqlite3ExprCanBeNull(pEList->a[i].pExpr) ) break;
25427b35a77bSdan     }
25437b35a77bSdan     if( i==pEList->nExpr ){
25447b35a77bSdan       prRhsHasNull = 0;
25457b35a77bSdan     }
25467b35a77bSdan   }
25477b35a77bSdan 
2548b74b1017Sdrh   /* Check to see if an existing table or index can be used to
2549b74b1017Sdrh   ** satisfy the query.  This is preferable to generating a new
25507b35a77bSdan   ** ephemeral table.  */
25517b35a77bSdan   if( pParse->nErr==0 && (p = isCandidateForInOpt(pX))!=0 ){
2552e1fb65a0Sdanielk1977     sqlite3 *db = pParse->db;              /* Database connection */
2553b07028f7Sdrh     Table *pTab;                           /* Table <table>. */
2554ba00e30aSdan     i16 iDb;                               /* Database idx for pTab */
2555cfbb5e82Sdan     ExprList *pEList = p->pEList;
2556cfbb5e82Sdan     int nExpr = pEList->nExpr;
2557e1fb65a0Sdanielk1977 
2558b07028f7Sdrh     assert( p->pEList!=0 );             /* Because of isCandidateForInOpt(p) */
2559b07028f7Sdrh     assert( p->pEList->a[0].pExpr!=0 ); /* Because of isCandidateForInOpt(p) */
2560b07028f7Sdrh     assert( p->pSrc!=0 );               /* Because of isCandidateForInOpt(p) */
2561b07028f7Sdrh     pTab = p->pSrc->a[0].pTab;
2562b07028f7Sdrh 
2563b22f7c83Sdrh     /* Code an OP_Transaction and OP_TableLock for <table>. */
2564e1fb65a0Sdanielk1977     iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
2565e1fb65a0Sdanielk1977     sqlite3CodeVerifySchema(pParse, iDb);
2566e1fb65a0Sdanielk1977     sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
25679a96b668Sdanielk1977 
2568a84a283dSdrh     assert(v);  /* sqlite3GetVdbe() has always been previously called */
2569cfbb5e82Sdan     if( nExpr==1 && pEList->a[0].pExpr->iColumn<0 ){
257062659b2aSdrh       /* The "x IN (SELECT rowid FROM table)" case */
2571511f9e8dSdrh       int iAddr = sqlite3VdbeAddOp0(v, OP_Once);
25727d176105Sdrh       VdbeCoverage(v);
25739a96b668Sdanielk1977 
25749a96b668Sdanielk1977       sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
25759a96b668Sdanielk1977       eType = IN_INDEX_ROWID;
2576d8852095Sdrh       ExplainQueryPlan((pParse, 0,
2577d8852095Sdrh             "USING ROWID SEARCH ON TABLE %s FOR IN-OPERATOR",pTab->zName));
25789a96b668Sdanielk1977       sqlite3VdbeJumpHere(v, iAddr);
25799a96b668Sdanielk1977     }else{
2580e1fb65a0Sdanielk1977       Index *pIdx;                         /* Iterator variable */
2581cfbb5e82Sdan       int affinity_ok = 1;
2582cfbb5e82Sdan       int i;
2583cfbb5e82Sdan 
2584cfbb5e82Sdan       /* Check that the affinity that will be used to perform each
258562659b2aSdrh       ** comparison is the same as the affinity of each column in table
258662659b2aSdrh       ** on the RHS of the IN operator.  If it not, it is not possible to
258762659b2aSdrh       ** use any index of the RHS table.  */
2588cfbb5e82Sdan       for(i=0; i<nExpr && affinity_ok; i++){
2589fc7f27b9Sdrh         Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2590cfbb5e82Sdan         int iCol = pEList->a[i].pExpr->iColumn;
25910dfa4f6fSdrh         char idxaff = sqlite3TableColumnAffinity(pTab,iCol); /* RHS table */
2592cfbb5e82Sdan         char cmpaff = sqlite3CompareAffinity(pLhs, idxaff);
259362659b2aSdrh         testcase( cmpaff==SQLITE_AFF_BLOB );
259462659b2aSdrh         testcase( cmpaff==SQLITE_AFF_TEXT );
2595cfbb5e82Sdan         switch( cmpaff ){
2596cfbb5e82Sdan           case SQLITE_AFF_BLOB:
2597cfbb5e82Sdan             break;
2598cfbb5e82Sdan           case SQLITE_AFF_TEXT:
259962659b2aSdrh             /* sqlite3CompareAffinity() only returns TEXT if one side or the
260062659b2aSdrh             ** other has no affinity and the other side is TEXT.  Hence,
260162659b2aSdrh             ** the only way for cmpaff to be TEXT is for idxaff to be TEXT
260262659b2aSdrh             ** and for the term on the LHS of the IN to have no affinity. */
260362659b2aSdrh             assert( idxaff==SQLITE_AFF_TEXT );
2604cfbb5e82Sdan             break;
2605cfbb5e82Sdan           default:
2606cfbb5e82Sdan             affinity_ok = sqlite3IsNumericAffinity(idxaff);
2607cfbb5e82Sdan         }
2608cfbb5e82Sdan       }
2609e1fb65a0Sdanielk1977 
2610a84a283dSdrh       if( affinity_ok ){
2611a84a283dSdrh         /* Search for an existing index that will work for this IN operator */
2612a84a283dSdrh         for(pIdx=pTab->pIndex; pIdx && eType==0; pIdx=pIdx->pNext){
2613a84a283dSdrh           Bitmask colUsed;      /* Columns of the index used */
2614a84a283dSdrh           Bitmask mCol;         /* Mask for the current column */
26156fc8f364Sdrh           if( pIdx->nColumn<nExpr ) continue;
2616d4a4a361Sdrh           if( pIdx->pPartIdxWhere!=0 ) continue;
2617a84a283dSdrh           /* Maximum nColumn is BMS-2, not BMS-1, so that we can compute
2618a84a283dSdrh           ** BITMASK(nExpr) without overflowing */
2619a84a283dSdrh           testcase( pIdx->nColumn==BMS-2 );
2620a84a283dSdrh           testcase( pIdx->nColumn==BMS-1 );
2621a84a283dSdrh           if( pIdx->nColumn>=BMS-1 ) continue;
26226fc8f364Sdrh           if( mustBeUnique ){
26236fc8f364Sdrh             if( pIdx->nKeyCol>nExpr
26246fc8f364Sdrh              ||(pIdx->nColumn>nExpr && !IsUniqueIndex(pIdx))
26256fc8f364Sdrh             ){
2626a84a283dSdrh               continue;  /* This index is not unique over the IN RHS columns */
2627cfbb5e82Sdan             }
26286fc8f364Sdrh           }
2629cfbb5e82Sdan 
2630a84a283dSdrh           colUsed = 0;   /* Columns of index used so far */
2631cfbb5e82Sdan           for(i=0; i<nExpr; i++){
2632fc7f27b9Sdrh             Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2633cfbb5e82Sdan             Expr *pRhs = pEList->a[i].pExpr;
2634cfbb5e82Sdan             CollSeq *pReq = sqlite3BinaryCompareCollSeq(pParse, pLhs, pRhs);
2635cfbb5e82Sdan             int j;
2636cfbb5e82Sdan 
26376fc8f364Sdrh             assert( pReq!=0 || pRhs->iColumn==XN_ROWID || pParse->nErr );
2638cfbb5e82Sdan             for(j=0; j<nExpr; j++){
2639cfbb5e82Sdan               if( pIdx->aiColumn[j]!=pRhs->iColumn ) continue;
2640cfbb5e82Sdan               assert( pIdx->azColl[j] );
2641106526e1Sdrh               if( pReq!=0 && sqlite3StrICmp(pReq->zName, pIdx->azColl[j])!=0 ){
2642106526e1Sdrh                 continue;
2643106526e1Sdrh               }
2644cfbb5e82Sdan               break;
2645cfbb5e82Sdan             }
2646cfbb5e82Sdan             if( j==nExpr ) break;
2647a84a283dSdrh             mCol = MASKBIT(j);
2648a84a283dSdrh             if( mCol & colUsed ) break; /* Each column used only once */
2649a84a283dSdrh             colUsed |= mCol;
2650ba00e30aSdan             if( aiMap ) aiMap[i] = j;
2651cfbb5e82Sdan           }
2652cfbb5e82Sdan 
2653a84a283dSdrh           assert( i==nExpr || colUsed!=(MASKBIT(nExpr)-1) );
2654a84a283dSdrh           if( colUsed==(MASKBIT(nExpr)-1) ){
2655a84a283dSdrh             /* If we reach this point, that means the index pIdx is usable */
2656511f9e8dSdrh             int iAddr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
2657e2ca99c9Sdrh             ExplainQueryPlan((pParse, 0,
2658e2ca99c9Sdrh                               "USING INDEX %s FOR IN-OPERATOR",pIdx->zName));
26592ec2fb22Sdrh             sqlite3VdbeAddOp3(v, OP_OpenRead, iTab, pIdx->tnum, iDb);
26602ec2fb22Sdrh             sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
2661207872a4Sdanielk1977             VdbeComment((v, "%s", pIdx->zName));
26621ccce449Sdrh             assert( IN_INDEX_INDEX_DESC == IN_INDEX_INDEX_ASC+1 );
26631ccce449Sdrh             eType = IN_INDEX_INDEX_ASC + pIdx->aSortOrder[0];
26649a96b668Sdanielk1977 
26657b35a77bSdan             if( prRhsHasNull ){
26663480bfdaSdan #ifdef SQLITE_ENABLE_COLUMN_USED_MASK
2667cfbb5e82Sdan               i64 mask = (1<<nExpr)-1;
26683480bfdaSdan               sqlite3VdbeAddOp4Dup8(v, OP_ColumnsUsed,
2669cfbb5e82Sdan                   iTab, 0, 0, (u8*)&mask, P4_INT64);
26703480bfdaSdan #endif
2671b80dbdc2Sdrh               *prRhsHasNull = ++pParse->nMem;
26727b35a77bSdan               if( nExpr==1 ){
26736be515ebSdrh                 sqlite3SetHasNullFlag(v, iTab, *prRhsHasNull);
26740cdc022eSdanielk1977               }
26757b35a77bSdan             }
2676552fd454Sdrh             sqlite3VdbeJumpHere(v, iAddr);
26779a96b668Sdanielk1977           }
2678a84a283dSdrh         } /* End loop over indexes */
2679a84a283dSdrh       } /* End if( affinity_ok ) */
2680a84a283dSdrh     } /* End if not an rowid index */
2681a84a283dSdrh   } /* End attempt to optimize using an index */
26829a96b668Sdanielk1977 
2683bb53ecb1Sdrh   /* If no preexisting index is available for the IN clause
2684bb53ecb1Sdrh   ** and IN_INDEX_NOOP is an allowed reply
2685bb53ecb1Sdrh   ** and the RHS of the IN operator is a list, not a subquery
268671c57db0Sdan   ** and the RHS is not constant or has two or fewer terms,
268760ec914cSpeter.d.reid   ** then it is not worth creating an ephemeral table to evaluate
2688bb53ecb1Sdrh   ** the IN operator so return IN_INDEX_NOOP.
2689bb53ecb1Sdrh   */
2690bb53ecb1Sdrh   if( eType==0
2691bb53ecb1Sdrh    && (inFlags & IN_INDEX_NOOP_OK)
2692bb53ecb1Sdrh    && !ExprHasProperty(pX, EP_xIsSelect)
2693bb53ecb1Sdrh    && (!sqlite3InRhsIsConstant(pX) || pX->x.pList->nExpr<=2)
2694bb53ecb1Sdrh   ){
2695bb53ecb1Sdrh     eType = IN_INDEX_NOOP;
2696bb53ecb1Sdrh   }
2697bb53ecb1Sdrh 
26989a96b668Sdanielk1977   if( eType==0 ){
26994387006cSdrh     /* Could not find an existing table or index to use as the RHS b-tree.
2700b74b1017Sdrh     ** We will have to generate an ephemeral table to do the job.
2701b74b1017Sdrh     */
27028e23daf3Sdrh     u32 savedNQueryLoop = pParse->nQueryLoop;
27030cdc022eSdanielk1977     int rMayHaveNull = 0;
270441a05b7bSdanielk1977     eType = IN_INDEX_EPH;
27053a85625dSdrh     if( inFlags & IN_INDEX_LOOP ){
27064a5acf8eSdrh       pParse->nQueryLoop = 0;
2707e21a6e1dSdrh     }else if( prRhsHasNull ){
2708e21a6e1dSdrh       *prRhsHasNull = rMayHaveNull = ++pParse->nMem;
2709cf4d38aaSdrh     }
271085bcdce2Sdrh     assert( pX->op==TK_IN );
271150ef6716Sdrh     sqlite3CodeRhsOfIN(pParse, pX, iTab);
271285bcdce2Sdrh     if( rMayHaveNull ){
27132c04131cSdrh       sqlite3SetHasNullFlag(v, iTab, rMayHaveNull);
271485bcdce2Sdrh     }
2715cf4d38aaSdrh     pParse->nQueryLoop = savedNQueryLoop;
27169a96b668Sdanielk1977   }
2717ba00e30aSdan 
2718ba00e30aSdan   if( aiMap && eType!=IN_INDEX_INDEX_ASC && eType!=IN_INDEX_INDEX_DESC ){
2719ba00e30aSdan     int i, n;
2720ba00e30aSdan     n = sqlite3ExprVectorSize(pX->pLeft);
2721ba00e30aSdan     for(i=0; i<n; i++) aiMap[i] = i;
2722ba00e30aSdan   }
27232c04131cSdrh   *piTab = iTab;
27249a96b668Sdanielk1977   return eType;
27259a96b668Sdanielk1977 }
2726284f4acaSdanielk1977 #endif
2727626a879aSdrh 
2728f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
2729553168c7Sdan /*
2730553168c7Sdan ** Argument pExpr is an (?, ?...) IN(...) expression. This
2731553168c7Sdan ** function allocates and returns a nul-terminated string containing
2732553168c7Sdan ** the affinities to be used for each column of the comparison.
2733553168c7Sdan **
2734553168c7Sdan ** It is the responsibility of the caller to ensure that the returned
2735553168c7Sdan ** string is eventually freed using sqlite3DbFree().
2736553168c7Sdan */
273771c57db0Sdan static char *exprINAffinity(Parse *pParse, Expr *pExpr){
273871c57db0Sdan   Expr *pLeft = pExpr->pLeft;
273971c57db0Sdan   int nVal = sqlite3ExprVectorSize(pLeft);
2740553168c7Sdan   Select *pSelect = (pExpr->flags & EP_xIsSelect) ? pExpr->x.pSelect : 0;
274171c57db0Sdan   char *zRet;
274271c57db0Sdan 
2743553168c7Sdan   assert( pExpr->op==TK_IN );
27445c258dc1Sdrh   zRet = sqlite3DbMallocRaw(pParse->db, nVal+1);
274571c57db0Sdan   if( zRet ){
274671c57db0Sdan     int i;
274771c57db0Sdan     for(i=0; i<nVal; i++){
2748fc7f27b9Sdrh       Expr *pA = sqlite3VectorFieldSubexpr(pLeft, i);
2749553168c7Sdan       char a = sqlite3ExprAffinity(pA);
2750553168c7Sdan       if( pSelect ){
2751553168c7Sdan         zRet[i] = sqlite3CompareAffinity(pSelect->pEList->a[i].pExpr, a);
275271c57db0Sdan       }else{
2753553168c7Sdan         zRet[i] = a;
275471c57db0Sdan       }
275571c57db0Sdan     }
275671c57db0Sdan     zRet[nVal] = '\0';
275771c57db0Sdan   }
275871c57db0Sdan   return zRet;
275971c57db0Sdan }
2760f9b2e05cSdan #endif
276171c57db0Sdan 
27628da209b1Sdan #ifndef SQLITE_OMIT_SUBQUERY
27638da209b1Sdan /*
27648da209b1Sdan ** Load the Parse object passed as the first argument with an error
27658da209b1Sdan ** message of the form:
27668da209b1Sdan **
27678da209b1Sdan **   "sub-select returns N columns - expected M"
27688da209b1Sdan */
27698da209b1Sdan void sqlite3SubselectError(Parse *pParse, int nActual, int nExpect){
2770a9ebfe20Sdrh   if( pParse->nErr==0 ){
27718da209b1Sdan     const char *zFmt = "sub-select returns %d columns - expected %d";
27728da209b1Sdan     sqlite3ErrorMsg(pParse, zFmt, nActual, nExpect);
27738da209b1Sdan   }
2774a9ebfe20Sdrh }
27758da209b1Sdan #endif
27768da209b1Sdan 
2777626a879aSdrh /*
277844c5604cSdan ** Expression pExpr is a vector that has been used in a context where
277944c5604cSdan ** it is not permitted. If pExpr is a sub-select vector, this routine
278044c5604cSdan ** loads the Parse object with a message of the form:
278144c5604cSdan **
278244c5604cSdan **   "sub-select returns N columns - expected 1"
278344c5604cSdan **
278444c5604cSdan ** Or, if it is a regular scalar vector:
278544c5604cSdan **
278644c5604cSdan **   "row value misused"
278744c5604cSdan */
278844c5604cSdan void sqlite3VectorErrorMsg(Parse *pParse, Expr *pExpr){
278944c5604cSdan #ifndef SQLITE_OMIT_SUBQUERY
279044c5604cSdan   if( pExpr->flags & EP_xIsSelect ){
279144c5604cSdan     sqlite3SubselectError(pParse, pExpr->x.pSelect->pEList->nExpr, 1);
279244c5604cSdan   }else
279344c5604cSdan #endif
279444c5604cSdan   {
279544c5604cSdan     sqlite3ErrorMsg(pParse, "row value misused");
279644c5604cSdan   }
279744c5604cSdan }
279844c5604cSdan 
279985bcdce2Sdrh #ifndef SQLITE_OMIT_SUBQUERY
280044c5604cSdan /*
280185bcdce2Sdrh ** Generate code that will construct an ephemeral table containing all terms
280285bcdce2Sdrh ** in the RHS of an IN operator.  The IN operator can be in either of two
280385bcdce2Sdrh ** forms:
2804626a879aSdrh **
28059cbe6352Sdrh **     x IN (4,5,11)              -- IN operator with list on right-hand side
28069cbe6352Sdrh **     x IN (SELECT a FROM b)     -- IN operator with subquery on the right
2807fef5208cSdrh **
28082c04131cSdrh ** The pExpr parameter is the IN operator.  The cursor number for the
28092c04131cSdrh ** constructed ephermeral table is returned.  The first time the ephemeral
28102c04131cSdrh ** table is computed, the cursor number is also stored in pExpr->iTable,
28112c04131cSdrh ** however the cursor number returned might not be the same, as it might
28122c04131cSdrh ** have been duplicated using OP_OpenDup.
281341a05b7bSdanielk1977 **
281485bcdce2Sdrh ** If the LHS expression ("x" in the examples) is a column value, or
281585bcdce2Sdrh ** the SELECT statement returns a column value, then the affinity of that
281685bcdce2Sdrh ** column is used to build the index keys. If both 'x' and the
281785bcdce2Sdrh ** SELECT... statement are columns, then numeric affinity is used
281885bcdce2Sdrh ** if either column has NUMERIC or INTEGER affinity. If neither
281985bcdce2Sdrh ** 'x' nor the SELECT... statement are columns, then numeric affinity
282085bcdce2Sdrh ** is used.
2821cce7d176Sdrh */
282285bcdce2Sdrh void sqlite3CodeRhsOfIN(
2823fd773cf9Sdrh   Parse *pParse,          /* Parsing context */
282485bcdce2Sdrh   Expr *pExpr,            /* The IN operator */
282550ef6716Sdrh   int iTab                /* Use this cursor number */
282641a05b7bSdanielk1977 ){
28272c04131cSdrh   int addrOnce = 0;           /* Address of the OP_Once instruction at top */
282885bcdce2Sdrh   int addr;                   /* Address of OP_OpenEphemeral instruction */
282985bcdce2Sdrh   Expr *pLeft;                /* the LHS of the IN operator */
283085bcdce2Sdrh   KeyInfo *pKeyInfo = 0;      /* Key information */
283185bcdce2Sdrh   int nVal;                   /* Size of vector pLeft */
283285bcdce2Sdrh   Vdbe *v;                    /* The prepared statement under construction */
2833fc976065Sdanielk1977 
28342c04131cSdrh   v = pParse->pVdbe;
283585bcdce2Sdrh   assert( v!=0 );
283685bcdce2Sdrh 
28372c04131cSdrh   /* The evaluation of the IN must be repeated every time it
283839a11819Sdrh   ** is encountered if any of the following is true:
283957dbd7b3Sdrh   **
284057dbd7b3Sdrh   **    *  The right-hand side is a correlated subquery
284157dbd7b3Sdrh   **    *  The right-hand side is an expression list containing variables
284257dbd7b3Sdrh   **    *  We are inside a trigger
284357dbd7b3Sdrh   **
28442c04131cSdrh   ** If all of the above are false, then we can compute the RHS just once
28452c04131cSdrh   ** and reuse it many names.
2846b3bce662Sdanielk1977   */
2847efb699fcSdrh   if( !ExprHasProperty(pExpr, EP_VarSelect) && pParse->iSelfTab==0 ){
28482c04131cSdrh     /* Reuse of the RHS is allowed */
28492c04131cSdrh     /* If this routine has already been coded, but the previous code
28502c04131cSdrh     ** might not have been invoked yet, so invoke it now as a subroutine.
28512c04131cSdrh     */
28522c04131cSdrh     if( ExprHasProperty(pExpr, EP_Subrtn) ){
2853f9231c34Sdrh       addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
2854bd462bccSdrh       if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2855bd462bccSdrh         ExplainQueryPlan((pParse, 0, "REUSE LIST SUBQUERY %d",
2856bd462bccSdrh               pExpr->x.pSelect->selId));
2857bd462bccSdrh       }
28582c04131cSdrh       sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
28592c04131cSdrh                         pExpr->y.sub.iAddr);
28602c04131cSdrh       sqlite3VdbeAddOp2(v, OP_OpenDup, iTab, pExpr->iTable);
2861f9231c34Sdrh       sqlite3VdbeJumpHere(v, addrOnce);
28622c04131cSdrh       return;
28632c04131cSdrh     }
28642c04131cSdrh 
28652c04131cSdrh     /* Begin coding the subroutine */
28662c04131cSdrh     ExprSetProperty(pExpr, EP_Subrtn);
2867088489e8Sdrh     assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
28682c04131cSdrh     pExpr->y.sub.regReturn = ++pParse->nMem;
28692c04131cSdrh     pExpr->y.sub.iAddr =
28702c04131cSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 0, pExpr->y.sub.regReturn) + 1;
28712c04131cSdrh     VdbeComment((v, "return address"));
28722c04131cSdrh 
28732c04131cSdrh     addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
2874b3bce662Sdanielk1977   }
2875b3bce662Sdanielk1977 
287685bcdce2Sdrh   /* Check to see if this is a vector IN operator */
287785bcdce2Sdrh   pLeft = pExpr->pLeft;
287871c57db0Sdan   nVal = sqlite3ExprVectorSize(pLeft);
2879e014a838Sdanielk1977 
288085bcdce2Sdrh   /* Construct the ephemeral table that will contain the content of
288185bcdce2Sdrh   ** RHS of the IN operator.
2882fef5208cSdrh   */
28832c04131cSdrh   pExpr->iTable = iTab;
288450ef6716Sdrh   addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, pExpr->iTable, nVal);
28852c04131cSdrh #ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
28862c04131cSdrh   if( ExprHasProperty(pExpr, EP_xIsSelect) ){
28872c04131cSdrh     VdbeComment((v, "Result of SELECT %u", pExpr->x.pSelect->selId));
28882c04131cSdrh   }else{
28892c04131cSdrh     VdbeComment((v, "RHS of IN operator"));
28902c04131cSdrh   }
28912c04131cSdrh #endif
289250ef6716Sdrh   pKeyInfo = sqlite3KeyInfoAlloc(pParse->db, nVal, 1);
2893e014a838Sdanielk1977 
28946ab3a2ecSdanielk1977   if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2895e014a838Sdanielk1977     /* Case 1:     expr IN (SELECT ...)
2896e014a838Sdanielk1977     **
2897e014a838Sdanielk1977     ** Generate code to write the results of the select into the temporary
2898e014a838Sdanielk1977     ** table allocated and opened above.
2899e014a838Sdanielk1977     */
29004387006cSdrh     Select *pSelect = pExpr->x.pSelect;
290171c57db0Sdan     ExprList *pEList = pSelect->pEList;
29021013c932Sdrh 
29032c04131cSdrh     ExplainQueryPlan((pParse, 1, "%sLIST SUBQUERY %d",
29042c04131cSdrh         addrOnce?"":"CORRELATED ", pSelect->selId
2905e2ca99c9Sdrh     ));
290664bcb8cfSdrh     /* If the LHS and RHS of the IN operator do not match, that
290764bcb8cfSdrh     ** error will have been caught long before we reach this point. */
290864bcb8cfSdrh     if( ALWAYS(pEList->nExpr==nVal) ){
290971c57db0Sdan       SelectDest dest;
291071c57db0Sdan       int i;
2911bd462bccSdrh       sqlite3SelectDestInit(&dest, SRT_Set, iTab);
291271c57db0Sdan       dest.zAffSdst = exprINAffinity(pParse, pExpr);
29134387006cSdrh       pSelect->iLimit = 0;
29144387006cSdrh       testcase( pSelect->selFlags & SF_Distinct );
2915812ea833Sdrh       testcase( pKeyInfo==0 ); /* Caused by OOM in sqlite3KeyInfoAlloc() */
29164387006cSdrh       if( sqlite3Select(pParse, pSelect, &dest) ){
291771c57db0Sdan         sqlite3DbFree(pParse->db, dest.zAffSdst);
29182ec2fb22Sdrh         sqlite3KeyInfoUnref(pKeyInfo);
291985bcdce2Sdrh         return;
292094ccde58Sdrh       }
292171c57db0Sdan       sqlite3DbFree(pParse->db, dest.zAffSdst);
2922812ea833Sdrh       assert( pKeyInfo!=0 ); /* OOM will cause exit after sqlite3Select() */
29233535ec3eSdrh       assert( pEList!=0 );
29243535ec3eSdrh       assert( pEList->nExpr>0 );
29252ec2fb22Sdrh       assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
292671c57db0Sdan       for(i=0; i<nVal; i++){
2927773d3afaSdan         Expr *p = sqlite3VectorFieldSubexpr(pLeft, i);
292871c57db0Sdan         pKeyInfo->aColl[i] = sqlite3BinaryCompareCollSeq(
292971c57db0Sdan             pParse, p, pEList->a[i].pExpr
293071c57db0Sdan         );
293171c57db0Sdan       }
293271c57db0Sdan     }
2933a7d2db17Sdrh   }else if( ALWAYS(pExpr->x.pList!=0) ){
2934fef5208cSdrh     /* Case 2:     expr IN (exprlist)
2935fef5208cSdrh     **
2936e014a838Sdanielk1977     ** For each expression, build an index key from the evaluation and
2937e014a838Sdanielk1977     ** store it in the temporary table. If <expr> is a column, then use
2938e014a838Sdanielk1977     ** that columns affinity when building index keys. If <expr> is not
2939e014a838Sdanielk1977     ** a column, use numeric affinity.
2940fef5208cSdrh     */
294171c57db0Sdan     char affinity;            /* Affinity of the LHS of the IN */
2942e014a838Sdanielk1977     int i;
29436ab3a2ecSdanielk1977     ExprList *pList = pExpr->x.pList;
294457dbd7b3Sdrh     struct ExprList_item *pItem;
2945c324d446Sdan     int r1, r2;
294671c57db0Sdan     affinity = sqlite3ExprAffinity(pLeft);
294796fb16eeSdrh     if( affinity<=SQLITE_AFF_NONE ){
294805883a34Sdrh       affinity = SQLITE_AFF_BLOB;
294995b39590Sdrh     }else if( affinity==SQLITE_AFF_REAL ){
295095b39590Sdrh       affinity = SQLITE_AFF_NUMERIC;
2951e014a838Sdanielk1977     }
2952323df790Sdrh     if( pKeyInfo ){
29532ec2fb22Sdrh       assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
2954323df790Sdrh       pKeyInfo->aColl[0] = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
2955323df790Sdrh     }
2956e014a838Sdanielk1977 
2957e014a838Sdanielk1977     /* Loop through each expression in <exprlist>. */
29582d401ab8Sdrh     r1 = sqlite3GetTempReg(pParse);
29592d401ab8Sdrh     r2 = sqlite3GetTempReg(pParse);
296057dbd7b3Sdrh     for(i=pList->nExpr, pItem=pList->a; i>0; i--, pItem++){
296157dbd7b3Sdrh       Expr *pE2 = pItem->pExpr;
2962e014a838Sdanielk1977 
296357dbd7b3Sdrh       /* If the expression is not constant then we will need to
296457dbd7b3Sdrh       ** disable the test that was generated above that makes sure
296557dbd7b3Sdrh       ** this code only executes once.  Because for a non-constant
296657dbd7b3Sdrh       ** expression we need to rerun this code each time.
296757dbd7b3Sdrh       */
29682c04131cSdrh       if( addrOnce && !sqlite3ExprIsConstant(pE2) ){
29692c04131cSdrh         sqlite3VdbeChangeToNoop(v, addrOnce);
29707ac0e562Sdan         ExprClearProperty(pExpr, EP_Subrtn);
29712c04131cSdrh         addrOnce = 0;
29724794b980Sdrh       }
2973e014a838Sdanielk1977 
2974e014a838Sdanielk1977       /* Evaluate the expression and insert it into the temp table */
2975c324d446Sdan       sqlite3ExprCode(pParse, pE2, r1);
2976c324d446Sdan       sqlite3VdbeAddOp4(v, OP_MakeRecord, r1, 1, r2, &affinity, 1);
2977c324d446Sdan       sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iTab, r2, r1, 1);
2978fef5208cSdrh     }
29792d401ab8Sdrh     sqlite3ReleaseTempReg(pParse, r1);
29802d401ab8Sdrh     sqlite3ReleaseTempReg(pParse, r2);
2981fef5208cSdrh   }
2982323df790Sdrh   if( pKeyInfo ){
29832ec2fb22Sdrh     sqlite3VdbeChangeP4(v, addr, (void *)pKeyInfo, P4_KEYINFO);
298441a05b7bSdanielk1977   }
29852c04131cSdrh   if( addrOnce ){
29862c04131cSdrh     sqlite3VdbeJumpHere(v, addrOnce);
29872c04131cSdrh     /* Subroutine return */
29882c04131cSdrh     sqlite3VdbeAddOp1(v, OP_Return, pExpr->y.sub.regReturn);
29892c04131cSdrh     sqlite3VdbeChangeP1(v, pExpr->y.sub.iAddr-1, sqlite3VdbeCurrentAddr(v)-1);
29906d2566dfSdrh     sqlite3ClearTempRegCache(pParse);
299185bcdce2Sdrh   }
299285bcdce2Sdrh }
299385bcdce2Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
299485bcdce2Sdrh 
299585bcdce2Sdrh /*
299685bcdce2Sdrh ** Generate code for scalar subqueries used as a subquery expression
299785bcdce2Sdrh ** or EXISTS operator:
299885bcdce2Sdrh **
299985bcdce2Sdrh **     (SELECT a FROM b)          -- subquery
300085bcdce2Sdrh **     EXISTS (SELECT a FROM b)   -- EXISTS subquery
300185bcdce2Sdrh **
300285bcdce2Sdrh ** The pExpr parameter is the SELECT or EXISTS operator to be coded.
300385bcdce2Sdrh **
3004d86fe44aSdrh ** Return the register that holds the result.  For a multi-column SELECT,
300585bcdce2Sdrh ** the result is stored in a contiguous array of registers and the
300685bcdce2Sdrh ** return value is the register of the left-most result column.
300785bcdce2Sdrh ** Return 0 if an error occurs.
300885bcdce2Sdrh */
300985bcdce2Sdrh #ifndef SQLITE_OMIT_SUBQUERY
301085bcdce2Sdrh int sqlite3CodeSubselect(Parse *pParse, Expr *pExpr){
30112c04131cSdrh   int addrOnce = 0;           /* Address of OP_Once at top of subroutine */
301285bcdce2Sdrh   int rReg = 0;               /* Register storing resulting */
301385bcdce2Sdrh   Select *pSel;               /* SELECT statement to encode */
301485bcdce2Sdrh   SelectDest dest;            /* How to deal with SELECT result */
301585bcdce2Sdrh   int nReg;                   /* Registers to allocate */
301685bcdce2Sdrh   Expr *pLimit;               /* New limit expression */
30172c04131cSdrh 
30182c04131cSdrh   Vdbe *v = pParse->pVdbe;
301985bcdce2Sdrh   assert( v!=0 );
3020bd462bccSdrh   testcase( pExpr->op==TK_EXISTS );
3021bd462bccSdrh   testcase( pExpr->op==TK_SELECT );
3022bd462bccSdrh   assert( pExpr->op==TK_EXISTS || pExpr->op==TK_SELECT );
3023bd462bccSdrh   assert( ExprHasProperty(pExpr, EP_xIsSelect) );
3024bd462bccSdrh   pSel = pExpr->x.pSelect;
302585bcdce2Sdrh 
30265198ff57Sdrh   /* The evaluation of the EXISTS/SELECT must be repeated every time it
302785bcdce2Sdrh   ** is encountered if any of the following is true:
302885bcdce2Sdrh   **
302985bcdce2Sdrh   **    *  The right-hand side is a correlated subquery
303085bcdce2Sdrh   **    *  The right-hand side is an expression list containing variables
303185bcdce2Sdrh   **    *  We are inside a trigger
303285bcdce2Sdrh   **
303385bcdce2Sdrh   ** If all of the above are false, then we can run this code just once
303485bcdce2Sdrh   ** save the results, and reuse the same result on subsequent invocations.
303585bcdce2Sdrh   */
303685bcdce2Sdrh   if( !ExprHasProperty(pExpr, EP_VarSelect) ){
30375198ff57Sdrh     /* If this routine has already been coded, then invoke it as a
30385198ff57Sdrh     ** subroutine. */
30395198ff57Sdrh     if( ExprHasProperty(pExpr, EP_Subrtn) ){
3040bd462bccSdrh       ExplainQueryPlan((pParse, 0, "REUSE SUBQUERY %d", pSel->selId));
30415198ff57Sdrh       sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
30425198ff57Sdrh                         pExpr->y.sub.iAddr);
30435198ff57Sdrh       return pExpr->iTable;
30445198ff57Sdrh     }
30455198ff57Sdrh 
30465198ff57Sdrh     /* Begin coding the subroutine */
30475198ff57Sdrh     ExprSetProperty(pExpr, EP_Subrtn);
30485198ff57Sdrh     pExpr->y.sub.regReturn = ++pParse->nMem;
30495198ff57Sdrh     pExpr->y.sub.iAddr =
30505198ff57Sdrh       sqlite3VdbeAddOp2(v, OP_Integer, 0, pExpr->y.sub.regReturn) + 1;
30515198ff57Sdrh     VdbeComment((v, "return address"));
30525198ff57Sdrh 
30532c04131cSdrh     addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
3054fef5208cSdrh   }
3055fef5208cSdrh 
305685bcdce2Sdrh   /* For a SELECT, generate code to put the values for all columns of
305739a11819Sdrh   ** the first row into an array of registers and return the index of
305839a11819Sdrh   ** the first register.
305939a11819Sdrh   **
306039a11819Sdrh   ** If this is an EXISTS, write an integer 0 (not exists) or 1 (exists)
306139a11819Sdrh   ** into a register and return that register number.
306239a11819Sdrh   **
306339a11819Sdrh   ** In both cases, the query is augmented with "LIMIT 1".  Any
306439a11819Sdrh   ** preexisting limit is discarded in place of the new LIMIT 1.
3065fef5208cSdrh   */
3066bd462bccSdrh   ExplainQueryPlan((pParse, 1, "%sSCALAR SUBQUERY %d",
3067bd462bccSdrh         addrOnce?"":"CORRELATED ", pSel->selId));
306871c57db0Sdan   nReg = pExpr->op==TK_SELECT ? pSel->pEList->nExpr : 1;
306971c57db0Sdan   sqlite3SelectDestInit(&dest, 0, pParse->nMem+1);
307071c57db0Sdan   pParse->nMem += nReg;
307151522cd3Sdrh   if( pExpr->op==TK_SELECT ){
30726c8c8ce0Sdanielk1977     dest.eDest = SRT_Mem;
307353932ce8Sdrh     dest.iSdst = dest.iSDParm;
307471c57db0Sdan     dest.nSdst = nReg;
307571c57db0Sdan     sqlite3VdbeAddOp3(v, OP_Null, 0, dest.iSDParm, dest.iSDParm+nReg-1);
3076d4e70ebdSdrh     VdbeComment((v, "Init subquery result"));
307751522cd3Sdrh   }else{
30786c8c8ce0Sdanielk1977     dest.eDest = SRT_Exists;
30792b596da8Sdrh     sqlite3VdbeAddOp2(v, OP_Integer, 0, dest.iSDParm);
3080d4e70ebdSdrh     VdbeComment((v, "Init EXISTS result"));
308151522cd3Sdrh   }
30828c0833fbSdrh   if( pSel->pLimit ){
30837ca1347fSdrh     /* The subquery already has a limit.  If the pre-existing limit is X
30847ca1347fSdrh     ** then make the new limit X<>0 so that the new limit is either 1 or 0 */
30857ca1347fSdrh     sqlite3 *db = pParse->db;
30865776ee5cSdrh     pLimit = sqlite3Expr(db, TK_INTEGER, "0");
30877ca1347fSdrh     if( pLimit ){
30887ca1347fSdrh       pLimit->affExpr = SQLITE_AFF_NUMERIC;
30897ca1347fSdrh       pLimit = sqlite3PExpr(pParse, TK_NE,
30907ca1347fSdrh                             sqlite3ExprDup(db, pSel->pLimit->pLeft, 0), pLimit);
30917ca1347fSdrh     }
30927ca1347fSdrh     sqlite3ExprDelete(db, pSel->pLimit->pLeft);
30938c0833fbSdrh     pSel->pLimit->pLeft = pLimit;
30948c0833fbSdrh   }else{
30957ca1347fSdrh     /* If there is no pre-existing limit add a limit of 1 */
30965776ee5cSdrh     pLimit = sqlite3Expr(pParse->db, TK_INTEGER, "1");
30978c0833fbSdrh     pSel->pLimit = sqlite3PExpr(pParse, TK_LIMIT, pLimit, 0);
30988c0833fbSdrh   }
309948b5b041Sdrh   pSel->iLimit = 0;
31007d10d5a6Sdrh   if( sqlite3Select(pParse, pSel, &dest) ){
31011450bc6eSdrh     return 0;
310294ccde58Sdrh   }
31032c04131cSdrh   pExpr->iTable = rReg = dest.iSDParm;
3104ebb6a65dSdrh   ExprSetVVAProperty(pExpr, EP_NoReduce);
31052c04131cSdrh   if( addrOnce ){
31062c04131cSdrh     sqlite3VdbeJumpHere(v, addrOnce);
3107fc976065Sdanielk1977 
31082c04131cSdrh     /* Subroutine return */
31092c04131cSdrh     sqlite3VdbeAddOp1(v, OP_Return, pExpr->y.sub.regReturn);
31102c04131cSdrh     sqlite3VdbeChangeP1(v, pExpr->y.sub.iAddr-1, sqlite3VdbeCurrentAddr(v)-1);
31116d2566dfSdrh     sqlite3ClearTempRegCache(pParse);
31125198ff57Sdrh   }
31132c04131cSdrh 
31141450bc6eSdrh   return rReg;
3115cce7d176Sdrh }
311651522cd3Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
3117cce7d176Sdrh 
3118e3365e6cSdrh #ifndef SQLITE_OMIT_SUBQUERY
3119e3365e6cSdrh /*
31207b35a77bSdan ** Expr pIn is an IN(...) expression. This function checks that the
31217b35a77bSdan ** sub-select on the RHS of the IN() operator has the same number of
31227b35a77bSdan ** columns as the vector on the LHS. Or, if the RHS of the IN() is not
31237b35a77bSdan ** a sub-query, that the LHS is a vector of size 1.
31247b35a77bSdan */
31257b35a77bSdan int sqlite3ExprCheckIN(Parse *pParse, Expr *pIn){
31267b35a77bSdan   int nVector = sqlite3ExprVectorSize(pIn->pLeft);
31277b35a77bSdan   if( (pIn->flags & EP_xIsSelect) ){
31287b35a77bSdan     if( nVector!=pIn->x.pSelect->pEList->nExpr ){
31297b35a77bSdan       sqlite3SubselectError(pParse, pIn->x.pSelect->pEList->nExpr, nVector);
31307b35a77bSdan       return 1;
31317b35a77bSdan     }
31327b35a77bSdan   }else if( nVector!=1 ){
313344c5604cSdan     sqlite3VectorErrorMsg(pParse, pIn->pLeft);
31347b35a77bSdan     return 1;
31357b35a77bSdan   }
31367b35a77bSdan   return 0;
31377b35a77bSdan }
31387b35a77bSdan #endif
31397b35a77bSdan 
31407b35a77bSdan #ifndef SQLITE_OMIT_SUBQUERY
31417b35a77bSdan /*
3142e3365e6cSdrh ** Generate code for an IN expression.
3143e3365e6cSdrh **
3144e3365e6cSdrh **      x IN (SELECT ...)
3145e3365e6cSdrh **      x IN (value, value, ...)
3146e3365e6cSdrh **
3147ecb87ac8Sdrh ** The left-hand side (LHS) is a scalar or vector expression.  The
3148e347d3e8Sdrh ** right-hand side (RHS) is an array of zero or more scalar values, or a
3149e347d3e8Sdrh ** subquery.  If the RHS is a subquery, the number of result columns must
3150e347d3e8Sdrh ** match the number of columns in the vector on the LHS.  If the RHS is
3151e347d3e8Sdrh ** a list of values, the LHS must be a scalar.
3152e347d3e8Sdrh **
3153e347d3e8Sdrh ** The IN operator is true if the LHS value is contained within the RHS.
3154e347d3e8Sdrh ** The result is false if the LHS is definitely not in the RHS.  The
3155e347d3e8Sdrh ** result is NULL if the presence of the LHS in the RHS cannot be
3156e347d3e8Sdrh ** determined due to NULLs.
3157e3365e6cSdrh **
31586be515ebSdrh ** This routine generates code that jumps to destIfFalse if the LHS is not
3159e3365e6cSdrh ** contained within the RHS.  If due to NULLs we cannot determine if the LHS
3160e3365e6cSdrh ** is contained in the RHS then jump to destIfNull.  If the LHS is contained
3161e3365e6cSdrh ** within the RHS then fall through.
3162ecb87ac8Sdrh **
3163ecb87ac8Sdrh ** See the separate in-operator.md documentation file in the canonical
3164ecb87ac8Sdrh ** SQLite source tree for additional information.
3165e3365e6cSdrh */
3166e3365e6cSdrh static void sqlite3ExprCodeIN(
3167e3365e6cSdrh   Parse *pParse,        /* Parsing and code generating context */
3168e3365e6cSdrh   Expr *pExpr,          /* The IN expression */
3169e3365e6cSdrh   int destIfFalse,      /* Jump here if LHS is not contained in the RHS */
3170e3365e6cSdrh   int destIfNull        /* Jump here if the results are unknown due to NULLs */
3171e3365e6cSdrh ){
3172e3365e6cSdrh   int rRhsHasNull = 0;  /* Register that is true if RHS contains NULL values */
3173e3365e6cSdrh   int eType;            /* Type of the RHS */
3174e347d3e8Sdrh   int rLhs;             /* Register(s) holding the LHS values */
3175e347d3e8Sdrh   int rLhsOrig;         /* LHS values prior to reordering by aiMap[] */
3176e3365e6cSdrh   Vdbe *v;              /* Statement under construction */
3177ba00e30aSdan   int *aiMap = 0;       /* Map from vector field to index column */
3178ba00e30aSdan   char *zAff = 0;       /* Affinity string for comparisons */
3179ecb87ac8Sdrh   int nVector;          /* Size of vectors for this IN operator */
318012abf408Sdrh   int iDummy;           /* Dummy parameter to exprCodeVector() */
3181e347d3e8Sdrh   Expr *pLeft;          /* The LHS of the IN operator */
3182ecb87ac8Sdrh   int i;                /* loop counter */
3183e347d3e8Sdrh   int destStep2;        /* Where to jump when NULLs seen in step 2 */
3184e347d3e8Sdrh   int destStep6 = 0;    /* Start of code for Step 6 */
3185e347d3e8Sdrh   int addrTruthOp;      /* Address of opcode that determines the IN is true */
3186e347d3e8Sdrh   int destNotNull;      /* Jump here if a comparison is not true in step 6 */
3187e347d3e8Sdrh   int addrTop;          /* Top of the step-6 loop */
31882c04131cSdrh   int iTab = 0;         /* Index to use */
3189c59b4acfSdan   u8 okConstFactor = pParse->okConstFactor;
3190e3365e6cSdrh 
3191e7375bfaSdrh   assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
3192e347d3e8Sdrh   pLeft = pExpr->pLeft;
31937b35a77bSdan   if( sqlite3ExprCheckIN(pParse, pExpr) ) return;
3194553168c7Sdan   zAff = exprINAffinity(pParse, pExpr);
3195ba00e30aSdan   nVector = sqlite3ExprVectorSize(pExpr->pLeft);
3196ba00e30aSdan   aiMap = (int*)sqlite3DbMallocZero(
3197ba00e30aSdan       pParse->db, nVector*(sizeof(int) + sizeof(char)) + 1
3198ba00e30aSdan   );
3199e347d3e8Sdrh   if( pParse->db->mallocFailed ) goto sqlite3ExprCodeIN_oom_error;
32007b35a77bSdan 
3201ba00e30aSdan   /* Attempt to compute the RHS. After this step, if anything other than
32022c04131cSdrh   ** IN_INDEX_NOOP is returned, the table opened with cursor iTab
3203ba00e30aSdan   ** contains the values that make up the RHS. If IN_INDEX_NOOP is returned,
3204ba00e30aSdan   ** the RHS has not yet been coded.  */
3205e3365e6cSdrh   v = pParse->pVdbe;
3206e3365e6cSdrh   assert( v!=0 );       /* OOM detected prior to this routine */
3207e3365e6cSdrh   VdbeNoopComment((v, "begin IN expr"));
3208bb53ecb1Sdrh   eType = sqlite3FindInIndex(pParse, pExpr,
3209bb53ecb1Sdrh                              IN_INDEX_MEMBERSHIP | IN_INDEX_NOOP_OK,
32102c04131cSdrh                              destIfFalse==destIfNull ? 0 : &rRhsHasNull,
32112c04131cSdrh                              aiMap, &iTab);
3212e3365e6cSdrh 
3213ba00e30aSdan   assert( pParse->nErr || nVector==1 || eType==IN_INDEX_EPH
3214ba00e30aSdan        || eType==IN_INDEX_INDEX_ASC || eType==IN_INDEX_INDEX_DESC
3215ba00e30aSdan   );
3216ecb87ac8Sdrh #ifdef SQLITE_DEBUG
3217ecb87ac8Sdrh   /* Confirm that aiMap[] contains nVector integer values between 0 and
3218ecb87ac8Sdrh   ** nVector-1. */
3219ecb87ac8Sdrh   for(i=0; i<nVector; i++){
3220ecb87ac8Sdrh     int j, cnt;
3221ecb87ac8Sdrh     for(cnt=j=0; j<nVector; j++) if( aiMap[j]==i ) cnt++;
3222ecb87ac8Sdrh     assert( cnt==1 );
3223ecb87ac8Sdrh   }
3224ecb87ac8Sdrh #endif
3225e3365e6cSdrh 
3226ba00e30aSdan   /* Code the LHS, the <expr> from "<expr> IN (...)". If the LHS is a
3227ba00e30aSdan   ** vector, then it is stored in an array of nVector registers starting
3228ba00e30aSdan   ** at r1.
3229e347d3e8Sdrh   **
3230e347d3e8Sdrh   ** sqlite3FindInIndex() might have reordered the fields of the LHS vector
3231e347d3e8Sdrh   ** so that the fields are in the same order as an existing index.   The
3232e347d3e8Sdrh   ** aiMap[] array contains a mapping from the original LHS field order to
3233e347d3e8Sdrh   ** the field order that matches the RHS index.
3234c59b4acfSdan   **
3235c59b4acfSdan   ** Avoid factoring the LHS of the IN(...) expression out of the loop,
3236c59b4acfSdan   ** even if it is constant, as OP_Affinity may be used on the register
3237c59b4acfSdan   ** by code generated below.  */
3238c59b4acfSdan   assert( pParse->okConstFactor==okConstFactor );
3239c59b4acfSdan   pParse->okConstFactor = 0;
3240e347d3e8Sdrh   rLhsOrig = exprCodeVector(pParse, pLeft, &iDummy);
3241c59b4acfSdan   pParse->okConstFactor = okConstFactor;
3242e347d3e8Sdrh   for(i=0; i<nVector && aiMap[i]==i; i++){} /* Are LHS fields reordered? */
3243ecb87ac8Sdrh   if( i==nVector ){
3244e347d3e8Sdrh     /* LHS fields are not reordered */
3245e347d3e8Sdrh     rLhs = rLhsOrig;
3246ecb87ac8Sdrh   }else{
3247ecb87ac8Sdrh     /* Need to reorder the LHS fields according to aiMap */
3248e347d3e8Sdrh     rLhs = sqlite3GetTempRange(pParse, nVector);
3249ba00e30aSdan     for(i=0; i<nVector; i++){
3250e347d3e8Sdrh       sqlite3VdbeAddOp3(v, OP_Copy, rLhsOrig+i, rLhs+aiMap[i], 0);
3251ba00e30aSdan     }
3252ecb87ac8Sdrh   }
3253e3365e6cSdrh 
3254bb53ecb1Sdrh   /* If sqlite3FindInIndex() did not find or create an index that is
3255bb53ecb1Sdrh   ** suitable for evaluating the IN operator, then evaluate using a
3256bb53ecb1Sdrh   ** sequence of comparisons.
3257e347d3e8Sdrh   **
3258e347d3e8Sdrh   ** This is step (1) in the in-operator.md optimized algorithm.
3259bb53ecb1Sdrh   */
3260bb53ecb1Sdrh   if( eType==IN_INDEX_NOOP ){
3261bb53ecb1Sdrh     ExprList *pList = pExpr->x.pList;
3262bb53ecb1Sdrh     CollSeq *pColl = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
3263ec4ccdbcSdrh     int labelOk = sqlite3VdbeMakeLabel(pParse);
3264bb53ecb1Sdrh     int r2, regToFree;
3265bb53ecb1Sdrh     int regCkNull = 0;
3266bb53ecb1Sdrh     int ii;
3267bb53ecb1Sdrh     assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
3268bb53ecb1Sdrh     if( destIfNull!=destIfFalse ){
3269bb53ecb1Sdrh       regCkNull = sqlite3GetTempReg(pParse);
3270e347d3e8Sdrh       sqlite3VdbeAddOp3(v, OP_BitAnd, rLhs, rLhs, regCkNull);
3271bb53ecb1Sdrh     }
3272bb53ecb1Sdrh     for(ii=0; ii<pList->nExpr; ii++){
32734fc83654Sdrh       r2 = sqlite3ExprCodeTemp(pParse, pList->a[ii].pExpr, &regToFree);
3274a976979bSdrh       if( regCkNull && sqlite3ExprCanBeNull(pList->a[ii].pExpr) ){
3275bb53ecb1Sdrh         sqlite3VdbeAddOp3(v, OP_BitAnd, regCkNull, r2, regCkNull);
3276bb53ecb1Sdrh       }
3277f6ea97eaSdrh       sqlite3ReleaseTempReg(pParse, regToFree);
3278bb53ecb1Sdrh       if( ii<pList->nExpr-1 || destIfNull!=destIfFalse ){
32794799488eSdrh         int op = rLhs!=r2 ? OP_Eq : OP_NotNull;
32804799488eSdrh         sqlite3VdbeAddOp4(v, op, rLhs, labelOk, r2,
32814336b0e6Sdrh                           (void*)pColl, P4_COLLSEQ);
32824799488eSdrh         VdbeCoverageIf(v, ii<pList->nExpr-1 && op==OP_Eq);
32834799488eSdrh         VdbeCoverageIf(v, ii==pList->nExpr-1 && op==OP_Eq);
32844799488eSdrh         VdbeCoverageIf(v, ii<pList->nExpr-1 && op==OP_NotNull);
32854799488eSdrh         VdbeCoverageIf(v, ii==pList->nExpr-1 && op==OP_NotNull);
3286ba00e30aSdan         sqlite3VdbeChangeP5(v, zAff[0]);
3287bb53ecb1Sdrh       }else{
32884799488eSdrh         int op = rLhs!=r2 ? OP_Ne : OP_IsNull;
3289bb53ecb1Sdrh         assert( destIfNull==destIfFalse );
32904799488eSdrh         sqlite3VdbeAddOp4(v, op, rLhs, destIfFalse, r2,
32914799488eSdrh                           (void*)pColl, P4_COLLSEQ);
32924799488eSdrh         VdbeCoverageIf(v, op==OP_Ne);
32934799488eSdrh         VdbeCoverageIf(v, op==OP_IsNull);
3294ba00e30aSdan         sqlite3VdbeChangeP5(v, zAff[0] | SQLITE_JUMPIFNULL);
3295bb53ecb1Sdrh       }
3296bb53ecb1Sdrh     }
3297bb53ecb1Sdrh     if( regCkNull ){
3298bb53ecb1Sdrh       sqlite3VdbeAddOp2(v, OP_IsNull, regCkNull, destIfNull); VdbeCoverage(v);
3299076e85f5Sdrh       sqlite3VdbeGoto(v, destIfFalse);
3300bb53ecb1Sdrh     }
3301bb53ecb1Sdrh     sqlite3VdbeResolveLabel(v, labelOk);
3302bb53ecb1Sdrh     sqlite3ReleaseTempReg(pParse, regCkNull);
3303e347d3e8Sdrh     goto sqlite3ExprCodeIN_finished;
3304e347d3e8Sdrh   }
3305bb53ecb1Sdrh 
3306e347d3e8Sdrh   /* Step 2: Check to see if the LHS contains any NULL columns.  If the
3307e347d3e8Sdrh   ** LHS does contain NULLs then the result must be either FALSE or NULL.
3308e347d3e8Sdrh   ** We will then skip the binary search of the RHS.
3309e347d3e8Sdrh   */
3310094430ebSdrh   if( destIfNull==destIfFalse ){
3311e347d3e8Sdrh     destStep2 = destIfFalse;
3312e347d3e8Sdrh   }else{
3313ec4ccdbcSdrh     destStep2 = destStep6 = sqlite3VdbeMakeLabel(pParse);
3314e347d3e8Sdrh   }
33154eac5f04Sdrh   if( pParse->nErr ) goto sqlite3ExprCodeIN_finished;
3316d49fd4e8Sdan   for(i=0; i<nVector; i++){
3317fc7f27b9Sdrh     Expr *p = sqlite3VectorFieldSubexpr(pExpr->pLeft, i);
3318d49fd4e8Sdan     if( sqlite3ExprCanBeNull(p) ){
3319e347d3e8Sdrh       sqlite3VdbeAddOp2(v, OP_IsNull, rLhs+i, destStep2);
3320471b4b92Sdrh       VdbeCoverage(v);
3321d49fd4e8Sdan     }
3322d49fd4e8Sdan   }
3323e3365e6cSdrh 
3324e347d3e8Sdrh   /* Step 3.  The LHS is now known to be non-NULL.  Do the binary search
3325e347d3e8Sdrh   ** of the RHS using the LHS as a probe.  If found, the result is
3326e347d3e8Sdrh   ** true.
3327e347d3e8Sdrh   */
3328e3365e6cSdrh   if( eType==IN_INDEX_ROWID ){
3329e347d3e8Sdrh     /* In this case, the RHS is the ROWID of table b-tree and so we also
3330e347d3e8Sdrh     ** know that the RHS is non-NULL.  Hence, we combine steps 3 and 4
3331e347d3e8Sdrh     ** into a single opcode. */
33322c04131cSdrh     sqlite3VdbeAddOp3(v, OP_SeekRowid, iTab, destIfFalse, rLhs);
3333688852abSdrh     VdbeCoverage(v);
3334e347d3e8Sdrh     addrTruthOp = sqlite3VdbeAddOp0(v, OP_Goto);  /* Return True */
33357b35a77bSdan   }else{
3336e347d3e8Sdrh     sqlite3VdbeAddOp4(v, OP_Affinity, rLhs, nVector, 0, zAff, nVector);
3337e347d3e8Sdrh     if( destIfFalse==destIfNull ){
3338e347d3e8Sdrh       /* Combine Step 3 and Step 5 into a single opcode */
33392c04131cSdrh       sqlite3VdbeAddOp4Int(v, OP_NotFound, iTab, destIfFalse,
3340e347d3e8Sdrh                            rLhs, nVector); VdbeCoverage(v);
3341e347d3e8Sdrh       goto sqlite3ExprCodeIN_finished;
3342e347d3e8Sdrh     }
3343e347d3e8Sdrh     /* Ordinary Step 3, for the case where FALSE and NULL are distinct */
33442c04131cSdrh     addrTruthOp = sqlite3VdbeAddOp4Int(v, OP_Found, iTab, 0,
3345e347d3e8Sdrh                                       rLhs, nVector); VdbeCoverage(v);
3346e347d3e8Sdrh   }
3347ba00e30aSdan 
3348e347d3e8Sdrh   /* Step 4.  If the RHS is known to be non-NULL and we did not find
3349e347d3e8Sdrh   ** an match on the search above, then the result must be FALSE.
3350e347d3e8Sdrh   */
3351e347d3e8Sdrh   if( rRhsHasNull && nVector==1 ){
3352e347d3e8Sdrh     sqlite3VdbeAddOp2(v, OP_NotNull, rRhsHasNull, destIfFalse);
3353471b4b92Sdrh     VdbeCoverage(v);
3354e347d3e8Sdrh   }
33557b35a77bSdan 
3356e347d3e8Sdrh   /* Step 5.  If we do not care about the difference between NULL and
3357e347d3e8Sdrh   ** FALSE, then just return false.
3358e347d3e8Sdrh   */
3359e347d3e8Sdrh   if( destIfFalse==destIfNull ) sqlite3VdbeGoto(v, destIfFalse);
3360e347d3e8Sdrh 
3361e347d3e8Sdrh   /* Step 6: Loop through rows of the RHS.  Compare each row to the LHS.
3362e347d3e8Sdrh   ** If any comparison is NULL, then the result is NULL.  If all
3363e347d3e8Sdrh   ** comparisons are FALSE then the final result is FALSE.
3364e347d3e8Sdrh   **
3365e347d3e8Sdrh   ** For a scalar LHS, it is sufficient to check just the first row
3366e347d3e8Sdrh   ** of the RHS.
3367e347d3e8Sdrh   */
3368e347d3e8Sdrh   if( destStep6 ) sqlite3VdbeResolveLabel(v, destStep6);
33692c04131cSdrh   addrTop = sqlite3VdbeAddOp2(v, OP_Rewind, iTab, destIfFalse);
3370471b4b92Sdrh   VdbeCoverage(v);
3371e347d3e8Sdrh   if( nVector>1 ){
3372ec4ccdbcSdrh     destNotNull = sqlite3VdbeMakeLabel(pParse);
3373e347d3e8Sdrh   }else{
3374e347d3e8Sdrh     /* For nVector==1, combine steps 6 and 7 by immediately returning
3375e347d3e8Sdrh     ** FALSE if the first comparison is not NULL */
3376e347d3e8Sdrh     destNotNull = destIfFalse;
3377e347d3e8Sdrh   }
3378ba00e30aSdan   for(i=0; i<nVector; i++){
3379ba00e30aSdan     Expr *p;
3380ba00e30aSdan     CollSeq *pColl;
3381e347d3e8Sdrh     int r3 = sqlite3GetTempReg(pParse);
3382fc7f27b9Sdrh     p = sqlite3VectorFieldSubexpr(pLeft, i);
3383ba00e30aSdan     pColl = sqlite3ExprCollSeq(pParse, p);
33842c04131cSdrh     sqlite3VdbeAddOp3(v, OP_Column, iTab, i, r3);
3385e347d3e8Sdrh     sqlite3VdbeAddOp4(v, OP_Ne, rLhs+i, destNotNull, r3,
338618016ad2Sdrh                       (void*)pColl, P4_COLLSEQ);
3387471b4b92Sdrh     VdbeCoverage(v);
3388e347d3e8Sdrh     sqlite3ReleaseTempReg(pParse, r3);
33897b35a77bSdan   }
33907b35a77bSdan   sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfNull);
3391e347d3e8Sdrh   if( nVector>1 ){
3392e347d3e8Sdrh     sqlite3VdbeResolveLabel(v, destNotNull);
33932c04131cSdrh     sqlite3VdbeAddOp2(v, OP_Next, iTab, addrTop+1);
339418016ad2Sdrh     VdbeCoverage(v);
3395e347d3e8Sdrh 
3396e347d3e8Sdrh     /* Step 7:  If we reach this point, we know that the result must
3397e347d3e8Sdrh     ** be false. */
339818016ad2Sdrh     sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfFalse);
33997b35a77bSdan   }
34007b35a77bSdan 
3401e347d3e8Sdrh   /* Jumps here in order to return true. */
3402e347d3e8Sdrh   sqlite3VdbeJumpHere(v, addrTruthOp);
3403e3365e6cSdrh 
3404e347d3e8Sdrh sqlite3ExprCodeIN_finished:
3405e347d3e8Sdrh   if( rLhs!=rLhsOrig ) sqlite3ReleaseTempReg(pParse, rLhs);
3406ecb87ac8Sdrh   VdbeComment((v, "end IN expr"));
3407e347d3e8Sdrh sqlite3ExprCodeIN_oom_error:
3408ba00e30aSdan   sqlite3DbFree(pParse->db, aiMap);
3409553168c7Sdan   sqlite3DbFree(pParse->db, zAff);
3410e3365e6cSdrh }
3411e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
3412e3365e6cSdrh 
341313573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
3414598f1340Sdrh /*
3415598f1340Sdrh ** Generate an instruction that will put the floating point
34169cbf3425Sdrh ** value described by z[0..n-1] into register iMem.
34170cf19ed8Sdrh **
34180cf19ed8Sdrh ** The z[] string will probably not be zero-terminated.  But the
34190cf19ed8Sdrh ** z[n] character is guaranteed to be something that does not look
34200cf19ed8Sdrh ** like the continuation of the number.
3421598f1340Sdrh */
3422b7916a78Sdrh static void codeReal(Vdbe *v, const char *z, int negateFlag, int iMem){
3423fd773cf9Sdrh   if( ALWAYS(z!=0) ){
3424598f1340Sdrh     double value;
34259339da1fSdrh     sqlite3AtoF(z, &value, sqlite3Strlen30(z), SQLITE_UTF8);
3426d0015161Sdrh     assert( !sqlite3IsNaN(value) ); /* The new AtoF never returns NaN */
3427598f1340Sdrh     if( negateFlag ) value = -value;
342897bae794Sdrh     sqlite3VdbeAddOp4Dup8(v, OP_Real, 0, iMem, 0, (u8*)&value, P4_REAL);
3429598f1340Sdrh   }
3430598f1340Sdrh }
343113573c71Sdrh #endif
3432598f1340Sdrh 
3433598f1340Sdrh 
3434598f1340Sdrh /*
3435fec19aadSdrh ** Generate an instruction that will put the integer describe by
34369cbf3425Sdrh ** text z[0..n-1] into register iMem.
34370cf19ed8Sdrh **
34385f1d6b61Sshaneh ** Expr.u.zToken is always UTF8 and zero-terminated.
3439fec19aadSdrh */
344013573c71Sdrh static void codeInteger(Parse *pParse, Expr *pExpr, int negFlag, int iMem){
344113573c71Sdrh   Vdbe *v = pParse->pVdbe;
344292b01d53Sdrh   if( pExpr->flags & EP_IntValue ){
344333e619fcSdrh     int i = pExpr->u.iValue;
3444d50ffc41Sdrh     assert( i>=0 );
344592b01d53Sdrh     if( negFlag ) i = -i;
344692b01d53Sdrh     sqlite3VdbeAddOp2(v, OP_Integer, i, iMem);
3447fd773cf9Sdrh   }else{
34485f1d6b61Sshaneh     int c;
34495f1d6b61Sshaneh     i64 value;
3450fd773cf9Sdrh     const char *z = pExpr->u.zToken;
3451fd773cf9Sdrh     assert( z!=0 );
34529296c18aSdrh     c = sqlite3DecOrHexToI64(z, &value);
345384d4f1a3Sdrh     if( (c==3 && !negFlag) || (c==2) || (negFlag && value==SMALLEST_INT64)){
345413573c71Sdrh #ifdef SQLITE_OMIT_FLOATING_POINT
345513573c71Sdrh       sqlite3ErrorMsg(pParse, "oversized integer: %s%s", negFlag ? "-" : "", z);
345613573c71Sdrh #else
34571b7ddc59Sdrh #ifndef SQLITE_OMIT_HEX_INTEGER
34589296c18aSdrh       if( sqlite3_strnicmp(z,"0x",2)==0 ){
345977320ea4Sdrh         sqlite3ErrorMsg(pParse, "hex literal too big: %s%s", negFlag?"-":"",z);
34601b7ddc59Sdrh       }else
34611b7ddc59Sdrh #endif
34621b7ddc59Sdrh       {
3463b7916a78Sdrh         codeReal(v, z, negFlag, iMem);
34649296c18aSdrh       }
346513573c71Sdrh #endif
346677320ea4Sdrh     }else{
346784d4f1a3Sdrh       if( negFlag ){ value = c==3 ? SMALLEST_INT64 : -value; }
346877320ea4Sdrh       sqlite3VdbeAddOp4Dup8(v, OP_Int64, 0, iMem, 0, (u8*)&value, P4_INT64);
3469fec19aadSdrh     }
3470fec19aadSdrh   }
3471c9cf901dSdanielk1977 }
3472fec19aadSdrh 
34735cd79239Sdrh 
34741f9ca2c8Sdrh /* Generate code that will load into register regOut a value that is
34751f9ca2c8Sdrh ** appropriate for the iIdxCol-th column of index pIdx.
34761f9ca2c8Sdrh */
34771f9ca2c8Sdrh void sqlite3ExprCodeLoadIndexColumn(
34781f9ca2c8Sdrh   Parse *pParse,  /* The parsing context */
34791f9ca2c8Sdrh   Index *pIdx,    /* The index whose column is to be loaded */
34801f9ca2c8Sdrh   int iTabCur,    /* Cursor pointing to a table row */
34811f9ca2c8Sdrh   int iIdxCol,    /* The column of the index to be loaded */
34821f9ca2c8Sdrh   int regOut      /* Store the index column value in this register */
34831f9ca2c8Sdrh ){
34841f9ca2c8Sdrh   i16 iTabCol = pIdx->aiColumn[iIdxCol];
34854b92f98cSdrh   if( iTabCol==XN_EXPR ){
34861f9ca2c8Sdrh     assert( pIdx->aColExpr );
34871f9ca2c8Sdrh     assert( pIdx->aColExpr->nExpr>iIdxCol );
34883e34eabcSdrh     pParse->iSelfTab = iTabCur + 1;
34891c75c9d7Sdrh     sqlite3ExprCodeCopy(pParse, pIdx->aColExpr->a[iIdxCol].pExpr, regOut);
34903e34eabcSdrh     pParse->iSelfTab = 0;
34914b92f98cSdrh   }else{
34926df9c4b9Sdrh     sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pIdx->pTable, iTabCur,
34934b92f98cSdrh                                     iTabCol, regOut);
34944b92f98cSdrh   }
34951f9ca2c8Sdrh }
34961f9ca2c8Sdrh 
3497e70fa7feSdrh #ifndef SQLITE_OMIT_GENERATED_COLUMNS
3498e70fa7feSdrh /*
3499e70fa7feSdrh ** Generate code that will compute the value of generated column pCol
3500e70fa7feSdrh ** and store the result in register regOut
3501e70fa7feSdrh */
3502e70fa7feSdrh void sqlite3ExprCodeGeneratedColumn(
3503e70fa7feSdrh   Parse *pParse,
3504e70fa7feSdrh   Column *pCol,
3505e70fa7feSdrh   int regOut
3506e70fa7feSdrh ){
35074dad7ed5Sdrh   int iAddr;
35084dad7ed5Sdrh   Vdbe *v = pParse->pVdbe;
35094dad7ed5Sdrh   assert( v!=0 );
35104dad7ed5Sdrh   assert( pParse->iSelfTab!=0 );
35114dad7ed5Sdrh   if( pParse->iSelfTab>0 ){
35124dad7ed5Sdrh     iAddr = sqlite3VdbeAddOp3(v, OP_IfNullRow, pParse->iSelfTab-1, 0, regOut);
35134dad7ed5Sdrh   }else{
35144dad7ed5Sdrh     iAddr = 0;
35154dad7ed5Sdrh   }
351624e39903Sdrh   sqlite3ExprCodeCopy(pParse, pCol->pDflt, regOut);
3517e70fa7feSdrh   if( pCol->affinity>=SQLITE_AFF_TEXT ){
35184dad7ed5Sdrh     sqlite3VdbeAddOp4(v, OP_Affinity, regOut, 1, 0, &pCol->affinity, 1);
3519e70fa7feSdrh   }
35204dad7ed5Sdrh   if( iAddr ) sqlite3VdbeJumpHere(v, iAddr);
3521e70fa7feSdrh }
3522e70fa7feSdrh #endif /* SQLITE_OMIT_GENERATED_COLUMNS */
3523e70fa7feSdrh 
35245cd79239Sdrh /*
35255c092e8aSdrh ** Generate code to extract the value of the iCol-th column of a table.
35265c092e8aSdrh */
35275c092e8aSdrh void sqlite3ExprCodeGetColumnOfTable(
35286df9c4b9Sdrh   Vdbe *v,        /* Parsing context */
35295c092e8aSdrh   Table *pTab,    /* The table containing the value */
3530313619f5Sdrh   int iTabCur,    /* The table cursor.  Or the PK cursor for WITHOUT ROWID */
35315c092e8aSdrh   int iCol,       /* Index of the column to extract */
3532313619f5Sdrh   int regOut      /* Extract the value into this register */
35335c092e8aSdrh ){
3534ab45fc04Sdrh   Column *pCol;
353581f7b372Sdrh   assert( v!=0 );
3536aca19e19Sdrh   if( pTab==0 ){
3537aca19e19Sdrh     sqlite3VdbeAddOp3(v, OP_Column, iTabCur, iCol, regOut);
3538aca19e19Sdrh     return;
3539aca19e19Sdrh   }
35405c092e8aSdrh   if( iCol<0 || iCol==pTab->iPKey ){
35415c092e8aSdrh     sqlite3VdbeAddOp2(v, OP_Rowid, iTabCur, regOut);
35425c092e8aSdrh   }else{
354381f7b372Sdrh     int op;
354481f7b372Sdrh     int x;
354581f7b372Sdrh     if( IsVirtual(pTab) ){
354681f7b372Sdrh       op = OP_VColumn;
354781f7b372Sdrh       x = iCol;
354881f7b372Sdrh #ifndef SQLITE_OMIT_GENERATED_COLUMNS
3549ab45fc04Sdrh     }else if( (pCol = &pTab->aCol[iCol])->colFlags & COLFLAG_VIRTUAL ){
35506df9c4b9Sdrh       Parse *pParse = sqlite3VdbeParser(v);
3551ab45fc04Sdrh       if( pCol->colFlags & COLFLAG_BUSY ){
3552ab45fc04Sdrh         sqlite3ErrorMsg(pParse, "generated column loop on \"%s\"", pCol->zName);
3553ab45fc04Sdrh       }else{
355481f7b372Sdrh         int savedSelfTab = pParse->iSelfTab;
3555ab45fc04Sdrh         pCol->colFlags |= COLFLAG_BUSY;
355681f7b372Sdrh         pParse->iSelfTab = iTabCur+1;
3557e70fa7feSdrh         sqlite3ExprCodeGeneratedColumn(pParse, pCol, regOut);
355881f7b372Sdrh         pParse->iSelfTab = savedSelfTab;
3559ab45fc04Sdrh         pCol->colFlags &= ~COLFLAG_BUSY;
3560ab45fc04Sdrh       }
356181f7b372Sdrh       return;
356281f7b372Sdrh #endif
356381f7b372Sdrh     }else if( !HasRowid(pTab) ){
3564c5f808d8Sdrh       testcase( iCol!=sqlite3TableColumnToStorage(pTab, iCol) );
3565b9bcf7caSdrh       x = sqlite3TableColumnToIndex(sqlite3PrimaryKeyIndex(pTab), iCol);
356681f7b372Sdrh       op = OP_Column;
356781f7b372Sdrh     }else{
3568b9bcf7caSdrh       x = sqlite3TableColumnToStorage(pTab,iCol);
3569c5f808d8Sdrh       testcase( x!=iCol );
357081f7b372Sdrh       op = OP_Column;
3571ee0ec8e1Sdrh     }
3572ee0ec8e1Sdrh     sqlite3VdbeAddOp3(v, op, iTabCur, x, regOut);
35735c092e8aSdrh     sqlite3ColumnDefault(v, pTab, iCol, regOut);
35745c092e8aSdrh   }
35755c092e8aSdrh }
35765c092e8aSdrh 
35775c092e8aSdrh /*
3578945498f3Sdrh ** Generate code that will extract the iColumn-th column from
35798c607191Sdrh ** table pTab and store the column value in register iReg.
3580e55cbd72Sdrh **
3581e55cbd72Sdrh ** There must be an open cursor to pTab in iTable when this routine
3582e55cbd72Sdrh ** is called.  If iColumn<0 then code is generated that extracts the rowid.
3583945498f3Sdrh */
3584e55cbd72Sdrh int sqlite3ExprCodeGetColumn(
3585e55cbd72Sdrh   Parse *pParse,   /* Parsing and code generating context */
35862133d822Sdrh   Table *pTab,     /* Description of the table we are reading from */
35872133d822Sdrh   int iColumn,     /* Index of the table column */
35882133d822Sdrh   int iTable,      /* The cursor pointing to the table */
3589a748fdccSdrh   int iReg,        /* Store results here */
3590ce78bc6eSdrh   u8 p5            /* P5 value for OP_Column + FLAGS */
35912133d822Sdrh ){
359281f7b372Sdrh   assert( pParse->pVdbe!=0 );
35936df9c4b9Sdrh   sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pTab, iTable, iColumn, iReg);
3594a748fdccSdrh   if( p5 ){
359599670abbSdrh     VdbeOp *pOp = sqlite3VdbeGetOp(pParse->pVdbe,-1);
359699670abbSdrh     if( pOp->opcode==OP_Column ) pOp->p5 = p5;
3597a748fdccSdrh   }
3598e55cbd72Sdrh   return iReg;
3599e55cbd72Sdrh }
3600e55cbd72Sdrh 
3601e55cbd72Sdrh /*
3602b21e7c70Sdrh ** Generate code to move content from registers iFrom...iFrom+nReg-1
360336a5d88dSdrh ** over to iTo..iTo+nReg-1.
3604e55cbd72Sdrh */
3605b21e7c70Sdrh void sqlite3ExprCodeMove(Parse *pParse, int iFrom, int iTo, int nReg){
3606079a3072Sdrh   sqlite3VdbeAddOp3(pParse->pVdbe, OP_Move, iFrom, iTo, nReg);
3607945498f3Sdrh }
3608945498f3Sdrh 
3609652fbf55Sdrh /*
361012abf408Sdrh ** Convert a scalar expression node to a TK_REGISTER referencing
361112abf408Sdrh ** register iReg.  The caller must ensure that iReg already contains
361212abf408Sdrh ** the correct value for the expression.
3613a4c3c87eSdrh */
3614069d1b1fSdan static void exprToRegister(Expr *pExpr, int iReg){
36150d950af3Sdrh   Expr *p = sqlite3ExprSkipCollateAndLikely(pExpr);
3616a4c3c87eSdrh   p->op2 = p->op;
3617a4c3c87eSdrh   p->op = TK_REGISTER;
3618a4c3c87eSdrh   p->iTable = iReg;
3619a4c3c87eSdrh   ExprClearProperty(p, EP_Skip);
3620a4c3c87eSdrh }
3621a4c3c87eSdrh 
362212abf408Sdrh /*
362312abf408Sdrh ** Evaluate an expression (either a vector or a scalar expression) and store
362412abf408Sdrh ** the result in continguous temporary registers.  Return the index of
362512abf408Sdrh ** the first register used to store the result.
362612abf408Sdrh **
362712abf408Sdrh ** If the returned result register is a temporary scalar, then also write
362812abf408Sdrh ** that register number into *piFreeable.  If the returned result register
362912abf408Sdrh ** is not a temporary or if the expression is a vector set *piFreeable
363012abf408Sdrh ** to 0.
363112abf408Sdrh */
363212abf408Sdrh static int exprCodeVector(Parse *pParse, Expr *p, int *piFreeable){
363312abf408Sdrh   int iResult;
363412abf408Sdrh   int nResult = sqlite3ExprVectorSize(p);
363512abf408Sdrh   if( nResult==1 ){
363612abf408Sdrh     iResult = sqlite3ExprCodeTemp(pParse, p, piFreeable);
363712abf408Sdrh   }else{
363812abf408Sdrh     *piFreeable = 0;
363912abf408Sdrh     if( p->op==TK_SELECT ){
3640dd1bb43aSdrh #if SQLITE_OMIT_SUBQUERY
3641dd1bb43aSdrh       iResult = 0;
3642dd1bb43aSdrh #else
364385bcdce2Sdrh       iResult = sqlite3CodeSubselect(pParse, p);
3644dd1bb43aSdrh #endif
364512abf408Sdrh     }else{
364612abf408Sdrh       int i;
364712abf408Sdrh       iResult = pParse->nMem+1;
364812abf408Sdrh       pParse->nMem += nResult;
364912abf408Sdrh       for(i=0; i<nResult; i++){
36504b725240Sdan         sqlite3ExprCodeFactorable(pParse, p->x.pList->a[i].pExpr, i+iResult);
365112abf408Sdrh       }
365212abf408Sdrh     }
365312abf408Sdrh   }
365412abf408Sdrh   return iResult;
365512abf408Sdrh }
365612abf408Sdrh 
365725c4296bSdrh /*
365892a27f7bSdrh ** If the last opcode is a OP_Copy, then set the do-not-merge flag (p5)
365992a27f7bSdrh ** so that a subsequent copy will not be merged into this one.
366092a27f7bSdrh */
366192a27f7bSdrh static void setDoNotMergeFlagOnCopy(Vdbe *v){
366292a27f7bSdrh   if( sqlite3VdbeGetOp(v, -1)->opcode==OP_Copy ){
366392a27f7bSdrh     sqlite3VdbeChangeP5(v, 1);  /* Tag trailing OP_Copy as not mergable */
366492a27f7bSdrh   }
366592a27f7bSdrh }
366692a27f7bSdrh 
366792a27f7bSdrh /*
366825c4296bSdrh ** Generate code to implement special SQL functions that are implemented
366925c4296bSdrh ** in-line rather than by using the usual callbacks.
367025c4296bSdrh */
367125c4296bSdrh static int exprCodeInlineFunction(
367225c4296bSdrh   Parse *pParse,        /* Parsing context */
367325c4296bSdrh   ExprList *pFarg,      /* List of function arguments */
367425c4296bSdrh   int iFuncId,          /* Function ID.  One of the INTFUNC_... values */
367525c4296bSdrh   int target            /* Store function result in this register */
367625c4296bSdrh ){
367725c4296bSdrh   int nFarg;
367825c4296bSdrh   Vdbe *v = pParse->pVdbe;
367925c4296bSdrh   assert( v!=0 );
368025c4296bSdrh   assert( pFarg!=0 );
368125c4296bSdrh   nFarg = pFarg->nExpr;
368225c4296bSdrh   assert( nFarg>0 );  /* All in-line functions have at least one argument */
368325c4296bSdrh   switch( iFuncId ){
368425c4296bSdrh     case INLINEFUNC_coalesce: {
368525c4296bSdrh       /* Attempt a direct implementation of the built-in COALESCE() and
368625c4296bSdrh       ** IFNULL() functions.  This avoids unnecessary evaluation of
368725c4296bSdrh       ** arguments past the first non-NULL argument.
368825c4296bSdrh       */
368925c4296bSdrh       int endCoalesce = sqlite3VdbeMakeLabel(pParse);
369025c4296bSdrh       int i;
369125c4296bSdrh       assert( nFarg>=2 );
369225c4296bSdrh       sqlite3ExprCode(pParse, pFarg->a[0].pExpr, target);
369325c4296bSdrh       for(i=1; i<nFarg; i++){
369425c4296bSdrh         sqlite3VdbeAddOp2(v, OP_NotNull, target, endCoalesce);
369525c4296bSdrh         VdbeCoverage(v);
369625c4296bSdrh         sqlite3ExprCode(pParse, pFarg->a[i].pExpr, target);
369725c4296bSdrh       }
369892a27f7bSdrh       setDoNotMergeFlagOnCopy(v);
369925c4296bSdrh       sqlite3VdbeResolveLabel(v, endCoalesce);
370025c4296bSdrh       break;
370125c4296bSdrh     }
370225c4296bSdrh 
3703171c50ecSdrh     default: {
370425c4296bSdrh       /* The UNLIKELY() function is a no-op.  The result is the value
370525c4296bSdrh       ** of the first argument.
370625c4296bSdrh       */
3707171c50ecSdrh       assert( nFarg==1 || nFarg==2 );
370825c4296bSdrh       target = sqlite3ExprCodeTarget(pParse, pFarg->a[0].pExpr, target);
370925c4296bSdrh       break;
371025c4296bSdrh     }
371125c4296bSdrh 
3712171c50ecSdrh   /***********************************************************************
3713171c50ecSdrh   ** Test-only SQL functions that are only usable if enabled
3714171c50ecSdrh   ** via SQLITE_TESTCTRL_INTERNAL_FUNCTIONS
3715171c50ecSdrh   */
3716171c50ecSdrh     case INLINEFUNC_expr_compare: {
3717171c50ecSdrh       /* Compare two expressions using sqlite3ExprCompare() */
3718171c50ecSdrh       assert( nFarg==2 );
3719171c50ecSdrh       sqlite3VdbeAddOp2(v, OP_Integer,
3720171c50ecSdrh          sqlite3ExprCompare(0,pFarg->a[0].pExpr, pFarg->a[1].pExpr,-1),
3721171c50ecSdrh          target);
3722171c50ecSdrh       break;
3723171c50ecSdrh     }
3724171c50ecSdrh 
3725171c50ecSdrh     case INLINEFUNC_expr_implies_expr: {
3726171c50ecSdrh       /* Compare two expressions using sqlite3ExprImpliesExpr() */
3727171c50ecSdrh       assert( nFarg==2 );
3728171c50ecSdrh       sqlite3VdbeAddOp2(v, OP_Integer,
3729171c50ecSdrh          sqlite3ExprImpliesExpr(pParse,pFarg->a[0].pExpr, pFarg->a[1].pExpr,-1),
3730171c50ecSdrh          target);
3731171c50ecSdrh       break;
3732171c50ecSdrh     }
3733171c50ecSdrh 
3734171c50ecSdrh     case INLINEFUNC_implies_nonnull_row: {
3735171c50ecSdrh       /* REsult of sqlite3ExprImpliesNonNullRow() */
3736171c50ecSdrh       Expr *pA1;
3737171c50ecSdrh       assert( nFarg==2 );
3738171c50ecSdrh       pA1 = pFarg->a[1].pExpr;
3739171c50ecSdrh       if( pA1->op==TK_COLUMN ){
3740171c50ecSdrh         sqlite3VdbeAddOp2(v, OP_Integer,
3741171c50ecSdrh            sqlite3ExprImpliesNonNullRow(pFarg->a[0].pExpr,pA1->iTable),
3742171c50ecSdrh            target);
3743171c50ecSdrh       }else{
3744171c50ecSdrh         sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3745171c50ecSdrh       }
3746171c50ecSdrh       break;
3747171c50ecSdrh     }
3748171c50ecSdrh 
374925c4296bSdrh #ifdef SQLITE_DEBUG
375025c4296bSdrh     case INLINEFUNC_affinity: {
375125c4296bSdrh       /* The AFFINITY() function evaluates to a string that describes
375225c4296bSdrh       ** the type affinity of the argument.  This is used for testing of
375325c4296bSdrh       ** the SQLite type logic.
375425c4296bSdrh       */
375525c4296bSdrh       const char *azAff[] = { "blob", "text", "numeric", "integer", "real" };
375625c4296bSdrh       char aff;
375725c4296bSdrh       assert( nFarg==1 );
375825c4296bSdrh       aff = sqlite3ExprAffinity(pFarg->a[0].pExpr);
375925c4296bSdrh       sqlite3VdbeLoadString(v, target,
376025c4296bSdrh               (aff<=SQLITE_AFF_NONE) ? "none" : azAff[aff-SQLITE_AFF_BLOB]);
376125c4296bSdrh       break;
376225c4296bSdrh     }
376325c4296bSdrh #endif
376425c4296bSdrh   }
376525c4296bSdrh   return target;
376625c4296bSdrh }
376725c4296bSdrh 
376871c57db0Sdan 
3769a4c3c87eSdrh /*
3770cce7d176Sdrh ** Generate code into the current Vdbe to evaluate the given
37712dcef11bSdrh ** expression.  Attempt to store the results in register "target".
37722dcef11bSdrh ** Return the register where results are stored.
3773389a1adbSdrh **
37748b213899Sdrh ** With this routine, there is no guarantee that results will
37752dcef11bSdrh ** be stored in target.  The result might be stored in some other
37762dcef11bSdrh ** register if it is convenient to do so.  The calling function
37772dcef11bSdrh ** must check the return code and move the results to the desired
37782dcef11bSdrh ** register.
3779cce7d176Sdrh */
3780678ccce8Sdrh int sqlite3ExprCodeTarget(Parse *pParse, Expr *pExpr, int target){
37812dcef11bSdrh   Vdbe *v = pParse->pVdbe;  /* The VM under construction */
37822dcef11bSdrh   int op;                   /* The opcode being coded */
37832dcef11bSdrh   int inReg = target;       /* Results stored in register inReg */
37842dcef11bSdrh   int regFree1 = 0;         /* If non-zero free this temporary register */
37852dcef11bSdrh   int regFree2 = 0;         /* If non-zero free this temporary register */
37867b35a77bSdan   int r1, r2;               /* Various register numbers */
378710d1edf0Sdrh   Expr tempX;               /* Temporary expression node */
378871c57db0Sdan   int p5 = 0;
3789ffe07b2dSdrh 
37909cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
379120411ea7Sdrh   if( v==0 ){
379220411ea7Sdrh     assert( pParse->db->mallocFailed );
379320411ea7Sdrh     return 0;
379420411ea7Sdrh   }
3795389a1adbSdrh 
37961efa8023Sdrh expr_code_doover:
3797389a1adbSdrh   if( pExpr==0 ){
3798389a1adbSdrh     op = TK_NULL;
3799389a1adbSdrh   }else{
3800e7375bfaSdrh     assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
3801f2bc013cSdrh     op = pExpr->op;
3802389a1adbSdrh   }
3803f2bc013cSdrh   switch( op ){
380413449892Sdrh     case TK_AGG_COLUMN: {
380513449892Sdrh       AggInfo *pAggInfo = pExpr->pAggInfo;
380613449892Sdrh       struct AggInfo_col *pCol = &pAggInfo->aCol[pExpr->iAgg];
380713449892Sdrh       if( !pAggInfo->directMode ){
38089de221dfSdrh         assert( pCol->iMem>0 );
3809c332cc30Sdrh         return pCol->iMem;
381013449892Sdrh       }else if( pAggInfo->useSortingIdx ){
38110c76e892Sdrh         Table *pTab = pCol->pTab;
38125134d135Sdan         sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdxPTab,
3813389a1adbSdrh                               pCol->iSorterColumn, target);
38148d5cea6bSdrh         if( pCol->iColumn<0 ){
38158d5cea6bSdrh           VdbeComment((v,"%s.rowid",pTab->zName));
38168d5cea6bSdrh         }else{
38178d5cea6bSdrh           VdbeComment((v,"%s.%s",pTab->zName,pTab->aCol[pCol->iColumn].zName));
38188d5cea6bSdrh           if( pTab->aCol[pCol->iColumn].affinity==SQLITE_AFF_REAL ){
38198d5cea6bSdrh             sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
38208d5cea6bSdrh           }
38210c76e892Sdrh         }
3822c332cc30Sdrh         return target;
382313449892Sdrh       }
382413449892Sdrh       /* Otherwise, fall thru into the TK_COLUMN case */
382513449892Sdrh     }
3826967e8b73Sdrh     case TK_COLUMN: {
3827b2b9d3d7Sdrh       int iTab = pExpr->iTable;
382867b9ba17Sdrh       int iReg;
3829efad2e23Sdrh       if( ExprHasProperty(pExpr, EP_FixedCol) ){
3830d98f5324Sdrh         /* This COLUMN expression is really a constant due to WHERE clause
3831d98f5324Sdrh         ** constraints, and that constant is coded by the pExpr->pLeft
3832d98f5324Sdrh         ** expresssion.  However, make sure the constant has the correct
3833d98f5324Sdrh         ** datatype by applying the Affinity of the table column to the
3834d98f5324Sdrh         ** constant.
3835d98f5324Sdrh         */
383657f7ece7Sdrh         int aff;
383767b9ba17Sdrh         iReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft,target);
383857f7ece7Sdrh         if( pExpr->y.pTab ){
383957f7ece7Sdrh           aff = sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
384057f7ece7Sdrh         }else{
384157f7ece7Sdrh           aff = pExpr->affExpr;
384257f7ece7Sdrh         }
384396fb16eeSdrh         if( aff>SQLITE_AFF_BLOB ){
3844d98f5324Sdrh           static const char zAff[] = "B\000C\000D\000E";
3845d98f5324Sdrh           assert( SQLITE_AFF_BLOB=='A' );
3846d98f5324Sdrh           assert( SQLITE_AFF_TEXT=='B' );
3847d98f5324Sdrh           if( iReg!=target ){
3848d98f5324Sdrh             sqlite3VdbeAddOp2(v, OP_SCopy, iReg, target);
3849d98f5324Sdrh             iReg = target;
3850d98f5324Sdrh           }
3851d98f5324Sdrh           sqlite3VdbeAddOp4(v, OP_Affinity, iReg, 1, 0,
3852d98f5324Sdrh                             &zAff[(aff-'B')*2], P4_STATIC);
3853d98f5324Sdrh         }
3854d98f5324Sdrh         return iReg;
3855efad2e23Sdrh       }
3856b2b9d3d7Sdrh       if( iTab<0 ){
38576e97f8ecSdrh         if( pParse->iSelfTab<0 ){
38589942ef0dSdrh           /* Other columns in the same row for CHECK constraints or
38599942ef0dSdrh           ** generated columns or for inserting into partial index.
38609942ef0dSdrh           ** The row is unpacked into registers beginning at
38619942ef0dSdrh           ** 0-(pParse->iSelfTab).  The rowid (if any) is in a register
38629942ef0dSdrh           ** immediately prior to the first column.
38639942ef0dSdrh           */
38649942ef0dSdrh           Column *pCol;
38659942ef0dSdrh           Table *pTab = pExpr->y.pTab;
38669942ef0dSdrh           int iSrc;
3867c5f808d8Sdrh           int iCol = pExpr->iColumn;
38689942ef0dSdrh           assert( pTab!=0 );
3869c5f808d8Sdrh           assert( iCol>=XN_ROWID );
3870b0cbcd0eSdrh           assert( iCol<pTab->nCol );
3871c5f808d8Sdrh           if( iCol<0 ){
38729942ef0dSdrh             return -1-pParse->iSelfTab;
38739942ef0dSdrh           }
3874c5f808d8Sdrh           pCol = pTab->aCol + iCol;
3875c5f808d8Sdrh           testcase( iCol!=sqlite3TableColumnToStorage(pTab,iCol) );
3876c5f808d8Sdrh           iSrc = sqlite3TableColumnToStorage(pTab, iCol) - pParse->iSelfTab;
38779942ef0dSdrh #ifndef SQLITE_OMIT_GENERATED_COLUMNS
38789942ef0dSdrh           if( pCol->colFlags & COLFLAG_GENERATED ){
38794e8e533bSdrh             if( pCol->colFlags & COLFLAG_BUSY ){
38804e8e533bSdrh               sqlite3ErrorMsg(pParse, "generated column loop on \"%s\"",
38814e8e533bSdrh                               pCol->zName);
38824e8e533bSdrh               return 0;
38834e8e533bSdrh             }
38844e8e533bSdrh             pCol->colFlags |= COLFLAG_BUSY;
38854e8e533bSdrh             if( pCol->colFlags & COLFLAG_NOTAVAIL ){
3886e70fa7feSdrh               sqlite3ExprCodeGeneratedColumn(pParse, pCol, iSrc);
38874e8e533bSdrh             }
38884e8e533bSdrh             pCol->colFlags &= ~(COLFLAG_BUSY|COLFLAG_NOTAVAIL);
3889dd6cc9b5Sdrh             return iSrc;
38909942ef0dSdrh           }else
38919942ef0dSdrh #endif /* SQLITE_OMIT_GENERATED_COLUMNS */
38929942ef0dSdrh           if( pCol->affinity==SQLITE_AFF_REAL ){
38939942ef0dSdrh             sqlite3VdbeAddOp2(v, OP_SCopy, iSrc, target);
3894bffdd636Sdrh             sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
3895bffdd636Sdrh             return target;
3896bffdd636Sdrh           }else{
38979942ef0dSdrh             return iSrc;
3898bffdd636Sdrh           }
3899c4a3c779Sdrh         }else{
39001f9ca2c8Sdrh           /* Coding an expression that is part of an index where column names
39011f9ca2c8Sdrh           ** in the index refer to the table to which the index belongs */
39023e34eabcSdrh           iTab = pParse->iSelfTab - 1;
39032282792aSdrh         }
3904b2b9d3d7Sdrh       }
390567b9ba17Sdrh       iReg = sqlite3ExprCodeGetColumn(pParse, pExpr->y.pTab,
3906b2b9d3d7Sdrh                                pExpr->iColumn, iTab, target,
3907b2b9d3d7Sdrh                                pExpr->op2);
390867b9ba17Sdrh       if( pExpr->y.pTab==0 && pExpr->affExpr==SQLITE_AFF_REAL ){
390967b9ba17Sdrh         sqlite3VdbeAddOp1(v, OP_RealAffinity, iReg);
391067b9ba17Sdrh       }
391167b9ba17Sdrh       return iReg;
3912cce7d176Sdrh     }
3913cce7d176Sdrh     case TK_INTEGER: {
391413573c71Sdrh       codeInteger(pParse, pExpr, 0, target);
3915c332cc30Sdrh       return target;
391651e9a445Sdrh     }
39178abed7b9Sdrh     case TK_TRUEFALSE: {
391896acafbeSdrh       sqlite3VdbeAddOp2(v, OP_Integer, sqlite3ExprTruthValue(pExpr), target);
3919007c843bSdrh       return target;
3920007c843bSdrh     }
392113573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
3922598f1340Sdrh     case TK_FLOAT: {
392333e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
392433e619fcSdrh       codeReal(v, pExpr->u.zToken, 0, target);
3925c332cc30Sdrh       return target;
3926598f1340Sdrh     }
392713573c71Sdrh #endif
3928fec19aadSdrh     case TK_STRING: {
392933e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
3930076e85f5Sdrh       sqlite3VdbeLoadString(v, target, pExpr->u.zToken);
3931c332cc30Sdrh       return target;
3932cce7d176Sdrh     }
3933aac30f9bSdrh     default: {
3934c29af653Sdrh       /* Make NULL the default case so that if a bug causes an illegal
3935c29af653Sdrh       ** Expr node to be passed into this function, it will be handled
39369524a7eaSdrh       ** sanely and not crash.  But keep the assert() to bring the problem
39379524a7eaSdrh       ** to the attention of the developers. */
39389524a7eaSdrh       assert( op==TK_NULL );
39399de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3940c332cc30Sdrh       return target;
3941f0863fe5Sdrh     }
39425338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_BLOB_LITERAL
3943c572ef7fSdanielk1977     case TK_BLOB: {
39446c8c6cecSdrh       int n;
39456c8c6cecSdrh       const char *z;
3946ca48c90fSdrh       char *zBlob;
394733e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
394833e619fcSdrh       assert( pExpr->u.zToken[0]=='x' || pExpr->u.zToken[0]=='X' );
394933e619fcSdrh       assert( pExpr->u.zToken[1]=='\'' );
395033e619fcSdrh       z = &pExpr->u.zToken[2];
3951b7916a78Sdrh       n = sqlite3Strlen30(z) - 1;
3952b7916a78Sdrh       assert( z[n]=='\'' );
3953ca48c90fSdrh       zBlob = sqlite3HexToBlob(sqlite3VdbeDb(v), z, n);
3954ca48c90fSdrh       sqlite3VdbeAddOp4(v, OP_Blob, n/2, target, 0, zBlob, P4_DYNAMIC);
3955c332cc30Sdrh       return target;
3956c572ef7fSdanielk1977     }
39575338a5f7Sdanielk1977 #endif
395850457896Sdrh     case TK_VARIABLE: {
395933e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
396033e619fcSdrh       assert( pExpr->u.zToken!=0 );
396133e619fcSdrh       assert( pExpr->u.zToken[0]!=0 );
3962eaf52d88Sdrh       sqlite3VdbeAddOp2(v, OP_Variable, pExpr->iColumn, target);
396333e619fcSdrh       if( pExpr->u.zToken[1]!=0 ){
39649bf755ccSdrh         const char *z = sqlite3VListNumToName(pParse->pVList, pExpr->iColumn);
39659524a7eaSdrh         assert( pExpr->u.zToken[0]=='?' || (z && !strcmp(pExpr->u.zToken, z)) );
3966ce1bbe51Sdrh         pParse->pVList[0] = 0; /* Indicate VList may no longer be enlarged */
39679bf755ccSdrh         sqlite3VdbeAppendP4(v, (char*)z, P4_STATIC);
39689bf755ccSdrh       }
3969c332cc30Sdrh       return target;
397050457896Sdrh     }
39714e0cff60Sdrh     case TK_REGISTER: {
3972c332cc30Sdrh       return pExpr->iTable;
39734e0cff60Sdrh     }
3974487e262fSdrh #ifndef SQLITE_OMIT_CAST
3975487e262fSdrh     case TK_CAST: {
3976487e262fSdrh       /* Expressions of the form:   CAST(pLeft AS token) */
39772dcef11bSdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
39781735fa88Sdrh       if( inReg!=target ){
39791735fa88Sdrh         sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
39801735fa88Sdrh         inReg = target;
39811735fa88Sdrh       }
39824169e430Sdrh       sqlite3VdbeAddOp2(v, OP_Cast, target,
39834169e430Sdrh                         sqlite3AffinityType(pExpr->u.zToken, 0));
3984c332cc30Sdrh       return inReg;
3985487e262fSdrh     }
3986487e262fSdrh #endif /* SQLITE_OMIT_CAST */
398771c57db0Sdan     case TK_IS:
398871c57db0Sdan     case TK_ISNOT:
398971c57db0Sdan       op = (op==TK_IS) ? TK_EQ : TK_NE;
399071c57db0Sdan       p5 = SQLITE_NULLEQ;
399171c57db0Sdan       /* fall-through */
3992c9b84a1fSdrh     case TK_LT:
3993c9b84a1fSdrh     case TK_LE:
3994c9b84a1fSdrh     case TK_GT:
3995c9b84a1fSdrh     case TK_GE:
3996c9b84a1fSdrh     case TK_NE:
3997c9b84a1fSdrh     case TK_EQ: {
399871c57db0Sdan       Expr *pLeft = pExpr->pLeft;
3999625015e0Sdan       if( sqlite3ExprIsVector(pLeft) ){
400079752b6eSdrh         codeVectorCompare(pParse, pExpr, target, op, p5);
400171c57db0Sdan       }else{
400271c57db0Sdan         r1 = sqlite3ExprCodeTemp(pParse, pLeft, &regFree1);
4003b6da74ebSdrh         r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
400471c57db0Sdan         codeCompare(pParse, pLeft, pExpr->pRight, op,
4005898c527eSdrh             r1, r2, inReg, SQLITE_STOREP2 | p5,
4006898c527eSdrh             ExprHasProperty(pExpr,EP_Commuted));
40077d176105Sdrh         assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
40087d176105Sdrh         assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
40097d176105Sdrh         assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
40107d176105Sdrh         assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
40117d176105Sdrh         assert(TK_EQ==OP_Eq); testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
40127d176105Sdrh         assert(TK_NE==OP_Ne); testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
4013c5499befSdrh         testcase( regFree1==0 );
4014c5499befSdrh         testcase( regFree2==0 );
4015c9b84a1fSdrh       }
40166a2fe093Sdrh       break;
40176a2fe093Sdrh     }
4018cce7d176Sdrh     case TK_AND:
4019cce7d176Sdrh     case TK_OR:
4020cce7d176Sdrh     case TK_PLUS:
4021cce7d176Sdrh     case TK_STAR:
4022cce7d176Sdrh     case TK_MINUS:
4023bf4133cbSdrh     case TK_REM:
4024bf4133cbSdrh     case TK_BITAND:
4025bf4133cbSdrh     case TK_BITOR:
402617c40294Sdrh     case TK_SLASH:
4027bf4133cbSdrh     case TK_LSHIFT:
4028855eb1cfSdrh     case TK_RSHIFT:
40290040077dSdrh     case TK_CONCAT: {
40307d176105Sdrh       assert( TK_AND==OP_And );            testcase( op==TK_AND );
40317d176105Sdrh       assert( TK_OR==OP_Or );              testcase( op==TK_OR );
40327d176105Sdrh       assert( TK_PLUS==OP_Add );           testcase( op==TK_PLUS );
40337d176105Sdrh       assert( TK_MINUS==OP_Subtract );     testcase( op==TK_MINUS );
40347d176105Sdrh       assert( TK_REM==OP_Remainder );      testcase( op==TK_REM );
40357d176105Sdrh       assert( TK_BITAND==OP_BitAnd );      testcase( op==TK_BITAND );
40367d176105Sdrh       assert( TK_BITOR==OP_BitOr );        testcase( op==TK_BITOR );
40377d176105Sdrh       assert( TK_SLASH==OP_Divide );       testcase( op==TK_SLASH );
40387d176105Sdrh       assert( TK_LSHIFT==OP_ShiftLeft );   testcase( op==TK_LSHIFT );
40397d176105Sdrh       assert( TK_RSHIFT==OP_ShiftRight );  testcase( op==TK_RSHIFT );
40407d176105Sdrh       assert( TK_CONCAT==OP_Concat );      testcase( op==TK_CONCAT );
40412dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
40422dcef11bSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
40435b6afba9Sdrh       sqlite3VdbeAddOp3(v, op, r2, r1, target);
4044c5499befSdrh       testcase( regFree1==0 );
4045c5499befSdrh       testcase( regFree2==0 );
40460040077dSdrh       break;
40470040077dSdrh     }
4048cce7d176Sdrh     case TK_UMINUS: {
4049fec19aadSdrh       Expr *pLeft = pExpr->pLeft;
4050fec19aadSdrh       assert( pLeft );
405113573c71Sdrh       if( pLeft->op==TK_INTEGER ){
405213573c71Sdrh         codeInteger(pParse, pLeft, 1, target);
4053c332cc30Sdrh         return target;
405413573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
405513573c71Sdrh       }else if( pLeft->op==TK_FLOAT ){
405633e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
405733e619fcSdrh         codeReal(v, pLeft->u.zToken, 1, target);
4058c332cc30Sdrh         return target;
405913573c71Sdrh #endif
40603c84ddffSdrh       }else{
406110d1edf0Sdrh         tempX.op = TK_INTEGER;
406210d1edf0Sdrh         tempX.flags = EP_IntValue|EP_TokenOnly;
406310d1edf0Sdrh         tempX.u.iValue = 0;
4064e7375bfaSdrh         ExprClearVVAProperties(&tempX);
406510d1edf0Sdrh         r1 = sqlite3ExprCodeTemp(pParse, &tempX, &regFree1);
4066e55cbd72Sdrh         r2 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree2);
40672dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_Subtract, r2, r1, target);
4068c5499befSdrh         testcase( regFree2==0 );
40693c84ddffSdrh       }
40706e142f54Sdrh       break;
40716e142f54Sdrh     }
4072bf4133cbSdrh     case TK_BITNOT:
40736e142f54Sdrh     case TK_NOT: {
40747d176105Sdrh       assert( TK_BITNOT==OP_BitNot );   testcase( op==TK_BITNOT );
40757d176105Sdrh       assert( TK_NOT==OP_Not );         testcase( op==TK_NOT );
4076e99fa2afSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4077e99fa2afSdrh       testcase( regFree1==0 );
4078e99fa2afSdrh       sqlite3VdbeAddOp2(v, op, r1, inReg);
4079cce7d176Sdrh       break;
4080cce7d176Sdrh     }
40818abed7b9Sdrh     case TK_TRUTH: {
408296acafbeSdrh       int isTrue;    /* IS TRUE or IS NOT TRUE */
408396acafbeSdrh       int bNormal;   /* IS TRUE or IS FALSE */
4084007c843bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4085007c843bSdrh       testcase( regFree1==0 );
408696acafbeSdrh       isTrue = sqlite3ExprTruthValue(pExpr->pRight);
408796acafbeSdrh       bNormal = pExpr->op2==TK_IS;
408896acafbeSdrh       testcase( isTrue && bNormal);
408996acafbeSdrh       testcase( !isTrue && bNormal);
409096acafbeSdrh       sqlite3VdbeAddOp4Int(v, OP_IsTrue, r1, inReg, !isTrue, isTrue ^ bNormal);
4091007c843bSdrh       break;
4092007c843bSdrh     }
4093cce7d176Sdrh     case TK_ISNULL:
4094cce7d176Sdrh     case TK_NOTNULL: {
40956a288a33Sdrh       int addr;
40967d176105Sdrh       assert( TK_ISNULL==OP_IsNull );   testcase( op==TK_ISNULL );
40977d176105Sdrh       assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
40989de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
40992dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4100c5499befSdrh       testcase( regFree1==0 );
41012dcef11bSdrh       addr = sqlite3VdbeAddOp1(v, op, r1);
41027d176105Sdrh       VdbeCoverageIf(v, op==TK_ISNULL);
41037d176105Sdrh       VdbeCoverageIf(v, op==TK_NOTNULL);
4104a976979bSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 0, target);
41056a288a33Sdrh       sqlite3VdbeJumpHere(v, addr);
4106a37cdde0Sdanielk1977       break;
4107f2bc013cSdrh     }
41082282792aSdrh     case TK_AGG_FUNCTION: {
410913449892Sdrh       AggInfo *pInfo = pExpr->pAggInfo;
41107e56e711Sdrh       if( pInfo==0 ){
411133e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
411233e619fcSdrh         sqlite3ErrorMsg(pParse, "misuse of aggregate: %s()", pExpr->u.zToken);
41137e56e711Sdrh       }else{
4114c332cc30Sdrh         return pInfo->aFunc[pExpr->iAgg].iMem;
41157e56e711Sdrh       }
41162282792aSdrh       break;
41172282792aSdrh     }
4118cce7d176Sdrh     case TK_FUNCTION: {
411912ffee8cSdrh       ExprList *pFarg;       /* List of function arguments */
412012ffee8cSdrh       int nFarg;             /* Number of function arguments */
412112ffee8cSdrh       FuncDef *pDef;         /* The function definition object */
412212ffee8cSdrh       const char *zId;       /* The function name */
4123693e6719Sdrh       u32 constMask = 0;     /* Mask of function arguments that are constant */
412412ffee8cSdrh       int i;                 /* Loop counter */
4125c332cc30Sdrh       sqlite3 *db = pParse->db;  /* The database connection */
412612ffee8cSdrh       u8 enc = ENC(db);      /* The text encoding used by this database */
412712ffee8cSdrh       CollSeq *pColl = 0;    /* A collating sequence */
412817435752Sdrh 
412967a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
4130eda079cdSdrh       if( ExprHasProperty(pExpr, EP_WinFunc) ){
4131eda079cdSdrh         return pExpr->y.pWin->regResult;
413286fb6e17Sdan       }
413367a9b8edSdan #endif
413486fb6e17Sdan 
41351e9b53f9Sdrh       if( ConstFactorOk(pParse) && sqlite3ExprIsConstantNotJoin(pExpr) ){
41369b258c54Sdrh         /* SQL functions can be expensive. So try to avoid running them
41379b258c54Sdrh         ** multiple times if we know they always give the same result */
41389b258c54Sdrh         return sqlite3ExprCodeRunJustOnce(pParse, pExpr, -1);
41391e9b53f9Sdrh       }
41406ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
4141e7375bfaSdrh       assert( !ExprHasProperty(pExpr, EP_TokenOnly) );
414212ffee8cSdrh       pFarg = pExpr->x.pList;
414312ffee8cSdrh       nFarg = pFarg ? pFarg->nExpr : 0;
414433e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
414533e619fcSdrh       zId = pExpr->u.zToken;
414680738d9cSdrh       pDef = sqlite3FindFunction(db, zId, nFarg, enc, 0);
4147cc15313cSdrh #ifdef SQLITE_ENABLE_UNKNOWN_SQL_FUNCTION
4148cc15313cSdrh       if( pDef==0 && pParse->explain ){
4149cc15313cSdrh         pDef = sqlite3FindFunction(db, "unknown", nFarg, enc, 0);
4150cc15313cSdrh       }
4151cc15313cSdrh #endif
4152b6e9f7a4Sdan       if( pDef==0 || pDef->xFinalize!=0 ){
415380738d9cSdrh         sqlite3ErrorMsg(pParse, "unknown function: %s()", zId);
4154feb306f5Sdrh         break;
4155feb306f5Sdrh       }
415625c4296bSdrh       if( pDef->funcFlags & SQLITE_FUNC_INLINE ){
41570dfa5255Sdrh         assert( (pDef->funcFlags & SQLITE_FUNC_UNSAFE)==0 );
41580dfa5255Sdrh         assert( (pDef->funcFlags & SQLITE_FUNC_DIRECT)==0 );
415925c4296bSdrh         return exprCodeInlineFunction(pParse, pFarg,
416025c4296bSdrh              SQLITE_PTR_TO_INT(pDef->pUserData), target);
41612eeca204Sdrh       }else if( pDef->funcFlags & (SQLITE_FUNC_DIRECT|SQLITE_FUNC_UNSAFE) ){
41620dfa5255Sdrh         sqlite3ExprFunctionUsable(pParse, pExpr, pDef);
4163ae6bb957Sdrh       }
4164a1a523a5Sdrh 
4165d1a01edaSdrh       for(i=0; i<nFarg; i++){
4166d1a01edaSdrh         if( i<32 && sqlite3ExprIsConstant(pFarg->a[i].pExpr) ){
4167693e6719Sdrh           testcase( i==31 );
4168693e6719Sdrh           constMask |= MASKBIT32(i);
4169d1a01edaSdrh         }
4170d1a01edaSdrh         if( (pDef->funcFlags & SQLITE_FUNC_NEEDCOLL)!=0 && !pColl ){
4171d1a01edaSdrh           pColl = sqlite3ExprCollSeq(pParse, pFarg->a[i].pExpr);
4172d1a01edaSdrh         }
4173d1a01edaSdrh       }
417412ffee8cSdrh       if( pFarg ){
4175d1a01edaSdrh         if( constMask ){
4176d1a01edaSdrh           r1 = pParse->nMem+1;
4177d1a01edaSdrh           pParse->nMem += nFarg;
4178d1a01edaSdrh         }else{
417912ffee8cSdrh           r1 = sqlite3GetTempRange(pParse, nFarg);
4180d1a01edaSdrh         }
4181a748fdccSdrh 
4182a748fdccSdrh         /* For length() and typeof() functions with a column argument,
4183a748fdccSdrh         ** set the P5 parameter to the OP_Column opcode to OPFLAG_LENGTHARG
4184a748fdccSdrh         ** or OPFLAG_TYPEOFARG respectively, to avoid unnecessary data
4185a748fdccSdrh         ** loading.
4186a748fdccSdrh         */
4187d36e1041Sdrh         if( (pDef->funcFlags & (SQLITE_FUNC_LENGTH|SQLITE_FUNC_TYPEOF))!=0 ){
41884e245a4cSdrh           u8 exprOp;
4189a748fdccSdrh           assert( nFarg==1 );
4190a748fdccSdrh           assert( pFarg->a[0].pExpr!=0 );
41914e245a4cSdrh           exprOp = pFarg->a[0].pExpr->op;
41924e245a4cSdrh           if( exprOp==TK_COLUMN || exprOp==TK_AGG_COLUMN ){
4193a748fdccSdrh             assert( SQLITE_FUNC_LENGTH==OPFLAG_LENGTHARG );
4194a748fdccSdrh             assert( SQLITE_FUNC_TYPEOF==OPFLAG_TYPEOFARG );
4195b1fba286Sdrh             testcase( pDef->funcFlags & OPFLAG_LENGTHARG );
4196b1fba286Sdrh             pFarg->a[0].pExpr->op2 =
4197b1fba286Sdrh                   pDef->funcFlags & (OPFLAG_LENGTHARG|OPFLAG_TYPEOFARG);
4198a748fdccSdrh           }
4199a748fdccSdrh         }
4200a748fdccSdrh 
42015579d59fSdrh         sqlite3ExprCodeExprList(pParse, pFarg, r1, 0,
4202d1a01edaSdrh                                 SQLITE_ECEL_DUP|SQLITE_ECEL_FACTOR);
4203892d3179Sdrh       }else{
420412ffee8cSdrh         r1 = 0;
4205892d3179Sdrh       }
4206b7f6f68fSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
4207a43fa227Sdrh       /* Possibly overload the function if the first argument is
4208a43fa227Sdrh       ** a virtual table column.
4209a43fa227Sdrh       **
4210a43fa227Sdrh       ** For infix functions (LIKE, GLOB, REGEXP, and MATCH) use the
4211a43fa227Sdrh       ** second argument, not the first, as the argument to test to
4212a43fa227Sdrh       ** see if it is a column in a virtual table.  This is done because
4213a43fa227Sdrh       ** the left operand of infix functions (the operand we want to
4214a43fa227Sdrh       ** control overloading) ends up as the second argument to the
4215a43fa227Sdrh       ** function.  The expression "A glob B" is equivalent to
4216a43fa227Sdrh       ** "glob(B,A).  We want to use the A in "A glob B" to test
4217a43fa227Sdrh       ** for function overloading.  But we use the B term in "glob(B,A)".
4218a43fa227Sdrh       */
421959155065Sdrh       if( nFarg>=2 && ExprHasProperty(pExpr, EP_InfixFunc) ){
422012ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[1].pExpr);
422112ffee8cSdrh       }else if( nFarg>0 ){
422212ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[0].pExpr);
4223b7f6f68fSdrh       }
4224b7f6f68fSdrh #endif
4225d36e1041Sdrh       if( pDef->funcFlags & SQLITE_FUNC_NEEDCOLL ){
42268b213899Sdrh         if( !pColl ) pColl = db->pDfltColl;
422766a5167bSdrh         sqlite3VdbeAddOp4(v, OP_CollSeq, 0, 0, 0, (char *)pColl, P4_COLLSEQ);
4228682f68b0Sdanielk1977       }
4229092457b1Sdrh #ifdef SQLITE_ENABLE_OFFSET_SQL_FUNC
4230092457b1Sdrh       if( pDef->funcFlags & SQLITE_FUNC_OFFSET ){
42312fc865c1Sdrh         Expr *pArg = pFarg->a[0].pExpr;
42322fc865c1Sdrh         if( pArg->op==TK_COLUMN ){
4233092457b1Sdrh           sqlite3VdbeAddOp3(v, OP_Offset, pArg->iTable, pArg->iColumn, target);
42342fc865c1Sdrh         }else{
42352fc865c1Sdrh           sqlite3VdbeAddOp2(v, OP_Null, 0, target);
42362fc865c1Sdrh         }
4237092457b1Sdrh       }else
4238092457b1Sdrh #endif
4239092457b1Sdrh       {
4240920cf596Sdrh         sqlite3VdbeAddFunctionCall(pParse, constMask, r1, target, nFarg,
424120cee7d0Sdrh                                    pDef, pExpr->op2);
42422fc865c1Sdrh       }
424313d79502Sdrh       if( nFarg ){
424413d79502Sdrh         if( constMask==0 ){
424512ffee8cSdrh           sqlite3ReleaseTempRange(pParse, r1, nFarg);
424613d79502Sdrh         }else{
42473aef2fb1Sdrh           sqlite3VdbeReleaseRegisters(pParse, r1, nFarg, constMask, 1);
424813d79502Sdrh         }
42492dcef11bSdrh       }
4250c332cc30Sdrh       return target;
42516ec2733bSdrh     }
4252fe2093d7Sdrh #ifndef SQLITE_OMIT_SUBQUERY
4253fe2093d7Sdrh     case TK_EXISTS:
425419a775c2Sdrh     case TK_SELECT: {
42558da209b1Sdan       int nCol;
4256c5499befSdrh       testcase( op==TK_EXISTS );
4257c5499befSdrh       testcase( op==TK_SELECT );
42588da209b1Sdan       if( op==TK_SELECT && (nCol = pExpr->x.pSelect->pEList->nExpr)!=1 ){
42598da209b1Sdan         sqlite3SubselectError(pParse, nCol, 1);
42608da209b1Sdan       }else{
426185bcdce2Sdrh         return sqlite3CodeSubselect(pParse, pExpr);
42628da209b1Sdan       }
426319a775c2Sdrh       break;
426419a775c2Sdrh     }
4265fc7f27b9Sdrh     case TK_SELECT_COLUMN: {
4266966e2911Sdrh       int n;
4267fc7f27b9Sdrh       if( pExpr->pLeft->iTable==0 ){
426885bcdce2Sdrh         pExpr->pLeft->iTable = sqlite3CodeSubselect(pParse, pExpr->pLeft);
4269fc7f27b9Sdrh       }
4270966e2911Sdrh       assert( pExpr->iTable==0 || pExpr->pLeft->op==TK_SELECT );
4271554a9dc7Sdrh       if( pExpr->iTable!=0
4272966e2911Sdrh        && pExpr->iTable!=(n = sqlite3ExprVectorSize(pExpr->pLeft))
4273966e2911Sdrh       ){
4274966e2911Sdrh         sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
4275966e2911Sdrh                                 pExpr->iTable, n);
4276966e2911Sdrh       }
4277c332cc30Sdrh       return pExpr->pLeft->iTable + pExpr->iColumn;
4278fc7f27b9Sdrh     }
4279fef5208cSdrh     case TK_IN: {
4280ec4ccdbcSdrh       int destIfFalse = sqlite3VdbeMakeLabel(pParse);
4281ec4ccdbcSdrh       int destIfNull = sqlite3VdbeMakeLabel(pParse);
4282e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
4283e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
428466ba23ceSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
4285e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
4286e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_AddImm, target, 0);
4287e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfNull);
4288c332cc30Sdrh       return target;
4289fef5208cSdrh     }
4290e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
4291e3365e6cSdrh 
4292e3365e6cSdrh 
42932dcef11bSdrh     /*
42942dcef11bSdrh     **    x BETWEEN y AND z
42952dcef11bSdrh     **
42962dcef11bSdrh     ** This is equivalent to
42972dcef11bSdrh     **
42982dcef11bSdrh     **    x>=y AND x<=z
42992dcef11bSdrh     **
43002dcef11bSdrh     ** X is stored in pExpr->pLeft.
43012dcef11bSdrh     ** Y is stored in pExpr->pList->a[0].pExpr.
43022dcef11bSdrh     ** Z is stored in pExpr->pList->a[1].pExpr.
43032dcef11bSdrh     */
4304fef5208cSdrh     case TK_BETWEEN: {
430571c57db0Sdan       exprCodeBetween(pParse, pExpr, target, 0, 0);
4306c332cc30Sdrh       return target;
4307fef5208cSdrh     }
430894fa9c41Sdrh     case TK_SPAN:
4309ae80ddeaSdrh     case TK_COLLATE:
43104f07e5fbSdrh     case TK_UPLUS: {
43111efa8023Sdrh       pExpr = pExpr->pLeft;
431259ee43a7Sdrh       goto expr_code_doover; /* 2018-04-28: Prevent deep recursion. OSSFuzz. */
4313a2e00042Sdrh     }
43142dcef11bSdrh 
4315165921a7Sdan     case TK_TRIGGER: {
431665a7cd16Sdan       /* If the opcode is TK_TRIGGER, then the expression is a reference
431765a7cd16Sdan       ** to a column in the new.* or old.* pseudo-tables available to
431865a7cd16Sdan       ** trigger programs. In this case Expr.iTable is set to 1 for the
431965a7cd16Sdan       ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
432065a7cd16Sdan       ** is set to the column of the pseudo-table to read, or to -1 to
432165a7cd16Sdan       ** read the rowid field.
432265a7cd16Sdan       **
432365a7cd16Sdan       ** The expression is implemented using an OP_Param opcode. The p1
432465a7cd16Sdan       ** parameter is set to 0 for an old.rowid reference, or to (i+1)
432565a7cd16Sdan       ** to reference another column of the old.* pseudo-table, where
432665a7cd16Sdan       ** i is the index of the column. For a new.rowid reference, p1 is
432765a7cd16Sdan       ** set to (n+1), where n is the number of columns in each pseudo-table.
432865a7cd16Sdan       ** For a reference to any other column in the new.* pseudo-table, p1
432965a7cd16Sdan       ** is set to (n+2+i), where n and i are as defined previously. For
433065a7cd16Sdan       ** example, if the table on which triggers are being fired is
433165a7cd16Sdan       ** declared as:
433265a7cd16Sdan       **
433365a7cd16Sdan       **   CREATE TABLE t1(a, b);
433465a7cd16Sdan       **
433565a7cd16Sdan       ** Then p1 is interpreted as follows:
433665a7cd16Sdan       **
433765a7cd16Sdan       **   p1==0   ->    old.rowid     p1==3   ->    new.rowid
433865a7cd16Sdan       **   p1==1   ->    old.a         p1==4   ->    new.a
433965a7cd16Sdan       **   p1==2   ->    old.b         p1==5   ->    new.b
434065a7cd16Sdan       */
4341eda079cdSdrh       Table *pTab = pExpr->y.pTab;
4342dd6cc9b5Sdrh       int iCol = pExpr->iColumn;
4343dd6cc9b5Sdrh       int p1 = pExpr->iTable * (pTab->nCol+1) + 1
43447fe2fc0dSdrh                      + sqlite3TableColumnToStorage(pTab, iCol);
434565a7cd16Sdan 
434665a7cd16Sdan       assert( pExpr->iTable==0 || pExpr->iTable==1 );
4347dd6cc9b5Sdrh       assert( iCol>=-1 && iCol<pTab->nCol );
4348dd6cc9b5Sdrh       assert( pTab->iPKey<0 || iCol!=pTab->iPKey );
434965a7cd16Sdan       assert( p1>=0 && p1<(pTab->nCol*2+2) );
435065a7cd16Sdan 
435165a7cd16Sdan       sqlite3VdbeAddOp2(v, OP_Param, p1, target);
4352896494e8Sdrh       VdbeComment((v, "r[%d]=%s.%s", target,
4353165921a7Sdan         (pExpr->iTable ? "new" : "old"),
4354dd6cc9b5Sdrh         (pExpr->iColumn<0 ? "rowid" : pExpr->y.pTab->aCol[iCol].zName)
4355165921a7Sdan       ));
435665a7cd16Sdan 
435744dbca83Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
435865a7cd16Sdan       /* If the column has REAL affinity, it may currently be stored as an
4359113762a2Sdrh       ** integer. Use OP_RealAffinity to make sure it is really real.
4360113762a2Sdrh       **
4361113762a2Sdrh       ** EVIDENCE-OF: R-60985-57662 SQLite will convert the value back to
4362113762a2Sdrh       ** floating point when extracting it from the record.  */
4363dd6cc9b5Sdrh       if( iCol>=0 && pTab->aCol[iCol].affinity==SQLITE_AFF_REAL ){
43642832ad42Sdan         sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
43652832ad42Sdan       }
436644dbca83Sdrh #endif
4367165921a7Sdan       break;
4368165921a7Sdan     }
4369165921a7Sdan 
437071c57db0Sdan     case TK_VECTOR: {
4371e835bc12Sdrh       sqlite3ErrorMsg(pParse, "row value misused");
437271c57db0Sdan       break;
437371c57db0Sdan     }
437471c57db0Sdan 
43759e9a67adSdrh     /* TK_IF_NULL_ROW Expr nodes are inserted ahead of expressions
43769e9a67adSdrh     ** that derive from the right-hand table of a LEFT JOIN.  The
43779e9a67adSdrh     ** Expr.iTable value is the table number for the right-hand table.
43789e9a67adSdrh     ** The expression is only evaluated if that table is not currently
43799e9a67adSdrh     ** on a LEFT JOIN NULL row.
43809e9a67adSdrh     */
438131d6fd55Sdrh     case TK_IF_NULL_ROW: {
438231d6fd55Sdrh       int addrINR;
43839e9a67adSdrh       u8 okConstFactor = pParse->okConstFactor;
438431d6fd55Sdrh       addrINR = sqlite3VdbeAddOp1(v, OP_IfNullRow, pExpr->iTable);
43859e9a67adSdrh       /* Temporarily disable factoring of constant expressions, since
43869e9a67adSdrh       ** even though expressions may appear to be constant, they are not
43879e9a67adSdrh       ** really constant because they originate from the right-hand side
43889e9a67adSdrh       ** of a LEFT JOIN. */
43899e9a67adSdrh       pParse->okConstFactor = 0;
439031d6fd55Sdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
43919e9a67adSdrh       pParse->okConstFactor = okConstFactor;
439231d6fd55Sdrh       sqlite3VdbeJumpHere(v, addrINR);
439331d6fd55Sdrh       sqlite3VdbeChangeP3(v, addrINR, inReg);
439431d6fd55Sdrh       break;
439531d6fd55Sdrh     }
439631d6fd55Sdrh 
43972dcef11bSdrh     /*
43982dcef11bSdrh     ** Form A:
43992dcef11bSdrh     **   CASE x WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
44002dcef11bSdrh     **
44012dcef11bSdrh     ** Form B:
44022dcef11bSdrh     **   CASE WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
44032dcef11bSdrh     **
44042dcef11bSdrh     ** Form A is can be transformed into the equivalent form B as follows:
44052dcef11bSdrh     **   CASE WHEN x=e1 THEN r1 WHEN x=e2 THEN r2 ...
44062dcef11bSdrh     **        WHEN x=eN THEN rN ELSE y END
44072dcef11bSdrh     **
44082dcef11bSdrh     ** X (if it exists) is in pExpr->pLeft.
4409c5cd1249Sdrh     ** Y is in the last element of pExpr->x.pList if pExpr->x.pList->nExpr is
4410c5cd1249Sdrh     ** odd.  The Y is also optional.  If the number of elements in x.pList
4411c5cd1249Sdrh     ** is even, then Y is omitted and the "otherwise" result is NULL.
44122dcef11bSdrh     ** Ei is in pExpr->pList->a[i*2] and Ri is pExpr->pList->a[i*2+1].
44132dcef11bSdrh     **
44142dcef11bSdrh     ** The result of the expression is the Ri for the first matching Ei,
44152dcef11bSdrh     ** or if there is no matching Ei, the ELSE term Y, or if there is
44162dcef11bSdrh     ** no ELSE term, NULL.
44172dcef11bSdrh     */
4418aac30f9bSdrh     case TK_CASE: {
44192dcef11bSdrh       int endLabel;                     /* GOTO label for end of CASE stmt */
44202dcef11bSdrh       int nextCase;                     /* GOTO label for next WHEN clause */
44212dcef11bSdrh       int nExpr;                        /* 2x number of WHEN terms */
44222dcef11bSdrh       int i;                            /* Loop counter */
44232dcef11bSdrh       ExprList *pEList;                 /* List of WHEN terms */
44242dcef11bSdrh       struct ExprList_item *aListelem;  /* Array of WHEN terms */
44252dcef11bSdrh       Expr opCompare;                   /* The X==Ei expression */
44262dcef11bSdrh       Expr *pX;                         /* The X expression */
44271bd10f8aSdrh       Expr *pTest = 0;                  /* X==Ei (form A) or just Ei (form B) */
44288b65e591Sdan       Expr *pDel = 0;
44298b65e591Sdan       sqlite3 *db = pParse->db;
443017a7f8ddSdrh 
44316ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) && pExpr->x.pList );
44326ab3a2ecSdanielk1977       assert(pExpr->x.pList->nExpr > 0);
44336ab3a2ecSdanielk1977       pEList = pExpr->x.pList;
4434be5c89acSdrh       aListelem = pEList->a;
4435be5c89acSdrh       nExpr = pEList->nExpr;
4436ec4ccdbcSdrh       endLabel = sqlite3VdbeMakeLabel(pParse);
44372dcef11bSdrh       if( (pX = pExpr->pLeft)!=0 ){
44388b65e591Sdan         pDel = sqlite3ExprDup(db, pX, 0);
44398b65e591Sdan         if( db->mallocFailed ){
44408b65e591Sdan           sqlite3ExprDelete(db, pDel);
44418b65e591Sdan           break;
44428b65e591Sdan         }
444333cd4909Sdrh         testcase( pX->op==TK_COLUMN );
44448b65e591Sdan         exprToRegister(pDel, exprCodeVector(pParse, pDel, &regFree1));
4445c5499befSdrh         testcase( regFree1==0 );
4446abb9d5f1Sdrh         memset(&opCompare, 0, sizeof(opCompare));
44472dcef11bSdrh         opCompare.op = TK_EQ;
44488b65e591Sdan         opCompare.pLeft = pDel;
44492dcef11bSdrh         pTest = &opCompare;
44508b1db07fSdrh         /* Ticket b351d95f9cd5ef17e9d9dbae18f5ca8611190001:
44518b1db07fSdrh         ** The value in regFree1 might get SCopy-ed into the file result.
44528b1db07fSdrh         ** So make sure that the regFree1 register is not reused for other
44538b1db07fSdrh         ** purposes and possibly overwritten.  */
44548b1db07fSdrh         regFree1 = 0;
4455cce7d176Sdrh       }
4456c5cd1249Sdrh       for(i=0; i<nExpr-1; i=i+2){
44572dcef11bSdrh         if( pX ){
44581bd10f8aSdrh           assert( pTest!=0 );
44592dcef11bSdrh           opCompare.pRight = aListelem[i].pExpr;
4460f5905aa7Sdrh         }else{
44612dcef11bSdrh           pTest = aListelem[i].pExpr;
446217a7f8ddSdrh         }
4463ec4ccdbcSdrh         nextCase = sqlite3VdbeMakeLabel(pParse);
446433cd4909Sdrh         testcase( pTest->op==TK_COLUMN );
44652dcef11bSdrh         sqlite3ExprIfFalse(pParse, pTest, nextCase, SQLITE_JUMPIFNULL);
4466c5499befSdrh         testcase( aListelem[i+1].pExpr->op==TK_COLUMN );
44679de221dfSdrh         sqlite3ExprCode(pParse, aListelem[i+1].pExpr, target);
4468076e85f5Sdrh         sqlite3VdbeGoto(v, endLabel);
44692dcef11bSdrh         sqlite3VdbeResolveLabel(v, nextCase);
4470f570f011Sdrh       }
4471c5cd1249Sdrh       if( (nExpr&1)!=0 ){
4472c5cd1249Sdrh         sqlite3ExprCode(pParse, pEList->a[nExpr-1].pExpr, target);
447317a7f8ddSdrh       }else{
44749de221dfSdrh         sqlite3VdbeAddOp2(v, OP_Null, 0, target);
447517a7f8ddSdrh       }
44768b65e591Sdan       sqlite3ExprDelete(db, pDel);
447792a27f7bSdrh       setDoNotMergeFlagOnCopy(v);
44782dcef11bSdrh       sqlite3VdbeResolveLabel(v, endLabel);
44796f34903eSdanielk1977       break;
44806f34903eSdanielk1977     }
44815338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_TRIGGER
44826f34903eSdanielk1977     case TK_RAISE: {
44831194904bSdrh       assert( pExpr->affExpr==OE_Rollback
44841194904bSdrh            || pExpr->affExpr==OE_Abort
44851194904bSdrh            || pExpr->affExpr==OE_Fail
44861194904bSdrh            || pExpr->affExpr==OE_Ignore
4487165921a7Sdan       );
4488e0af83acSdan       if( !pParse->pTriggerTab ){
4489e0af83acSdan         sqlite3ErrorMsg(pParse,
4490e0af83acSdan                        "RAISE() may only be used within a trigger-program");
4491e0af83acSdan         return 0;
4492e0af83acSdan       }
44931194904bSdrh       if( pExpr->affExpr==OE_Abort ){
4494e0af83acSdan         sqlite3MayAbort(pParse);
4495e0af83acSdan       }
449633e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
44971194904bSdrh       if( pExpr->affExpr==OE_Ignore ){
4498e0af83acSdan         sqlite3VdbeAddOp4(
4499e0af83acSdan             v, OP_Halt, SQLITE_OK, OE_Ignore, 0, pExpr->u.zToken,0);
4500688852abSdrh         VdbeCoverage(v);
4501e0af83acSdan       }else{
4502433dccfbSdrh         sqlite3HaltConstraint(pParse, SQLITE_CONSTRAINT_TRIGGER,
45031194904bSdrh                               pExpr->affExpr, pExpr->u.zToken, 0, 0);
4504e0af83acSdan       }
4505e0af83acSdan 
4506ffe07b2dSdrh       break;
450717a7f8ddSdrh     }
45085338a5f7Sdanielk1977 #endif
4509ffe07b2dSdrh   }
45102dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
45112dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
45122dcef11bSdrh   return inReg;
45135b6afba9Sdrh }
45142dcef11bSdrh 
45152dcef11bSdrh /*
45169b258c54Sdrh ** Generate code that will evaluate expression pExpr just one time
45179b258c54Sdrh ** per prepared statement execution.
45189b258c54Sdrh **
45199b258c54Sdrh ** If the expression uses functions (that might throw an exception) then
45209b258c54Sdrh ** guard them with an OP_Once opcode to ensure that the code is only executed
45219b258c54Sdrh ** once. If no functions are involved, then factor the code out and put it at
45229b258c54Sdrh ** the end of the prepared statement in the initialization section.
45231e9b53f9Sdrh **
4524ad879ffdSdrh ** If regDest>=0 then the result is always stored in that register and the
4525ad879ffdSdrh ** result is not reusable.  If regDest<0 then this routine is free to
4526ad879ffdSdrh ** store the value whereever it wants.  The register where the expression
45279b258c54Sdrh ** is stored is returned.  When regDest<0, two identical expressions might
45289b258c54Sdrh ** code to the same register, if they do not contain function calls and hence
45299b258c54Sdrh ** are factored out into the initialization section at the end of the
45309b258c54Sdrh ** prepared statement.
4531d1a01edaSdrh */
45329b258c54Sdrh int sqlite3ExprCodeRunJustOnce(
4533d673cddaSdrh   Parse *pParse,    /* Parsing context */
4534d673cddaSdrh   Expr *pExpr,      /* The expression to code when the VDBE initializes */
4535ad879ffdSdrh   int regDest       /* Store the value in this register */
4536d673cddaSdrh ){
4537d1a01edaSdrh   ExprList *p;
4538d9f158e7Sdrh   assert( ConstFactorOk(pParse) );
4539d1a01edaSdrh   p = pParse->pConstExpr;
4540ad879ffdSdrh   if( regDest<0 && p ){
45411e9b53f9Sdrh     struct ExprList_item *pItem;
45421e9b53f9Sdrh     int i;
45431e9b53f9Sdrh     for(pItem=p->a, i=p->nExpr; i>0; pItem++, i--){
45445aa550cfSdan       if( pItem->reusable && sqlite3ExprCompare(0,pItem->pExpr,pExpr,-1)==0 ){
45451e9b53f9Sdrh         return pItem->u.iConstExprReg;
45461e9b53f9Sdrh       }
45471e9b53f9Sdrh     }
45481e9b53f9Sdrh   }
4549d1a01edaSdrh   pExpr = sqlite3ExprDup(pParse->db, pExpr, 0);
455038dfbdaeSdrh   if( pExpr!=0 && ExprHasProperty(pExpr, EP_HasFunc) ){
455138dfbdaeSdrh     Vdbe *v = pParse->pVdbe;
455238dfbdaeSdrh     int addr;
455338dfbdaeSdrh     assert( v );
455438dfbdaeSdrh     addr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
455538dfbdaeSdrh     pParse->okConstFactor = 0;
455638dfbdaeSdrh     if( !pParse->db->mallocFailed ){
45579b258c54Sdrh       if( regDest<0 ) regDest = ++pParse->nMem;
455838dfbdaeSdrh       sqlite3ExprCode(pParse, pExpr, regDest);
455938dfbdaeSdrh     }
456038dfbdaeSdrh     pParse->okConstFactor = 1;
456138dfbdaeSdrh     sqlite3ExprDelete(pParse->db, pExpr);
456238dfbdaeSdrh     sqlite3VdbeJumpHere(v, addr);
456338dfbdaeSdrh   }else{
4564d1a01edaSdrh     p = sqlite3ExprListAppend(pParse, p, pExpr);
4565d673cddaSdrh     if( p ){
4566d673cddaSdrh        struct ExprList_item *pItem = &p->a[p->nExpr-1];
4567ad879ffdSdrh        pItem->reusable = regDest<0;
45689b258c54Sdrh        if( regDest<0 ) regDest = ++pParse->nMem;
4569d673cddaSdrh        pItem->u.iConstExprReg = regDest;
4570d673cddaSdrh     }
4571d1a01edaSdrh     pParse->pConstExpr = p;
457238dfbdaeSdrh   }
45731e9b53f9Sdrh   return regDest;
4574d1a01edaSdrh }
4575d1a01edaSdrh 
4576d1a01edaSdrh /*
45772dcef11bSdrh ** Generate code to evaluate an expression and store the results
45782dcef11bSdrh ** into a register.  Return the register number where the results
45792dcef11bSdrh ** are stored.
45802dcef11bSdrh **
45812dcef11bSdrh ** If the register is a temporary register that can be deallocated,
4582678ccce8Sdrh ** then write its number into *pReg.  If the result register is not
45832dcef11bSdrh ** a temporary, then set *pReg to zero.
4584f30a969bSdrh **
4585f30a969bSdrh ** If pExpr is a constant, then this routine might generate this
4586f30a969bSdrh ** code to fill the register in the initialization section of the
4587f30a969bSdrh ** VDBE program, in order to factor it out of the evaluation loop.
45882dcef11bSdrh */
45892dcef11bSdrh int sqlite3ExprCodeTemp(Parse *pParse, Expr *pExpr, int *pReg){
4590f30a969bSdrh   int r2;
45910d950af3Sdrh   pExpr = sqlite3ExprSkipCollateAndLikely(pExpr);
4592d9f158e7Sdrh   if( ConstFactorOk(pParse)
4593f30a969bSdrh    && pExpr->op!=TK_REGISTER
4594f30a969bSdrh    && sqlite3ExprIsConstantNotJoin(pExpr)
4595f30a969bSdrh   ){
4596f30a969bSdrh     *pReg  = 0;
45979b258c54Sdrh     r2 = sqlite3ExprCodeRunJustOnce(pParse, pExpr, -1);
4598f30a969bSdrh   }else{
45992dcef11bSdrh     int r1 = sqlite3GetTempReg(pParse);
4600f30a969bSdrh     r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
46012dcef11bSdrh     if( r2==r1 ){
46022dcef11bSdrh       *pReg = r1;
46032dcef11bSdrh     }else{
46042dcef11bSdrh       sqlite3ReleaseTempReg(pParse, r1);
46052dcef11bSdrh       *pReg = 0;
46062dcef11bSdrh     }
4607f30a969bSdrh   }
46082dcef11bSdrh   return r2;
46092dcef11bSdrh }
46102dcef11bSdrh 
46112dcef11bSdrh /*
46122dcef11bSdrh ** Generate code that will evaluate expression pExpr and store the
46132dcef11bSdrh ** results in register target.  The results are guaranteed to appear
46142dcef11bSdrh ** in register target.
46152dcef11bSdrh */
461605a86c5cSdrh void sqlite3ExprCode(Parse *pParse, Expr *pExpr, int target){
46179cbf3425Sdrh   int inReg;
46189cbf3425Sdrh 
4619e7375bfaSdrh   assert( pExpr==0 || !ExprHasVVAProperty(pExpr,EP_Immutable) );
46209cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
46219cbf3425Sdrh   inReg = sqlite3ExprCodeTarget(pParse, pExpr, target);
46221c75c9d7Sdrh   assert( pParse->pVdbe!=0 || pParse->db->mallocFailed );
46230e359b30Sdrh   if( inReg!=target && pParse->pVdbe ){
4624629b88c6Sdrh     u8 op;
4625629b88c6Sdrh     if( ExprHasProperty(pExpr,EP_Subquery) ){
4626629b88c6Sdrh       op = OP_Copy;
4627629b88c6Sdrh     }else{
4628629b88c6Sdrh       op = OP_SCopy;
4629629b88c6Sdrh     }
4630629b88c6Sdrh     sqlite3VdbeAddOp2(pParse->pVdbe, op, inReg, target);
463117a7f8ddSdrh   }
4632ebc16717Sdrh }
4633cce7d176Sdrh 
4634cce7d176Sdrh /*
46351c75c9d7Sdrh ** Make a transient copy of expression pExpr and then code it using
46361c75c9d7Sdrh ** sqlite3ExprCode().  This routine works just like sqlite3ExprCode()
46371c75c9d7Sdrh ** except that the input expression is guaranteed to be unchanged.
46381c75c9d7Sdrh */
46391c75c9d7Sdrh void sqlite3ExprCodeCopy(Parse *pParse, Expr *pExpr, int target){
46401c75c9d7Sdrh   sqlite3 *db = pParse->db;
46411c75c9d7Sdrh   pExpr = sqlite3ExprDup(db, pExpr, 0);
46421c75c9d7Sdrh   if( !db->mallocFailed ) sqlite3ExprCode(pParse, pExpr, target);
46431c75c9d7Sdrh   sqlite3ExprDelete(db, pExpr);
46441c75c9d7Sdrh }
46451c75c9d7Sdrh 
46461c75c9d7Sdrh /*
464705a86c5cSdrh ** Generate code that will evaluate expression pExpr and store the
464805a86c5cSdrh ** results in register target.  The results are guaranteed to appear
464905a86c5cSdrh ** in register target.  If the expression is constant, then this routine
465005a86c5cSdrh ** might choose to code the expression at initialization time.
465105a86c5cSdrh */
465205a86c5cSdrh void sqlite3ExprCodeFactorable(Parse *pParse, Expr *pExpr, int target){
4653b8b06690Sdrh   if( pParse->okConstFactor && sqlite3ExprIsConstantNotJoin(pExpr) ){
46549b258c54Sdrh     sqlite3ExprCodeRunJustOnce(pParse, pExpr, target);
465505a86c5cSdrh   }else{
4656088489e8Sdrh     sqlite3ExprCodeCopy(pParse, pExpr, target);
465705a86c5cSdrh   }
4658cce7d176Sdrh }
4659cce7d176Sdrh 
4660cce7d176Sdrh /*
4661268380caSdrh ** Generate code that pushes the value of every element of the given
46629cbf3425Sdrh ** expression list into a sequence of registers beginning at target.
4663268380caSdrh **
46643df6c3b1Sdrh ** Return the number of elements evaluated.  The number returned will
46653df6c3b1Sdrh ** usually be pList->nExpr but might be reduced if SQLITE_ECEL_OMITREF
46663df6c3b1Sdrh ** is defined.
4667d1a01edaSdrh **
4668d1a01edaSdrh ** The SQLITE_ECEL_DUP flag prevents the arguments from being
4669d1a01edaSdrh ** filled using OP_SCopy.  OP_Copy must be used instead.
4670d1a01edaSdrh **
4671d1a01edaSdrh ** The SQLITE_ECEL_FACTOR argument allows constant arguments to be
4672d1a01edaSdrh ** factored out into initialization code.
4673b0df9634Sdrh **
4674b0df9634Sdrh ** The SQLITE_ECEL_REF flag means that expressions in the list with
4675b0df9634Sdrh ** ExprList.a[].u.x.iOrderByCol>0 have already been evaluated and stored
4676b0df9634Sdrh ** in registers at srcReg, and so the value can be copied from there.
46773df6c3b1Sdrh ** If SQLITE_ECEL_OMITREF is also set, then the values with u.x.iOrderByCol>0
46783df6c3b1Sdrh ** are simply omitted rather than being copied from srcReg.
4679268380caSdrh */
46804adee20fSdanielk1977 int sqlite3ExprCodeExprList(
4681268380caSdrh   Parse *pParse,     /* Parsing context */
4682389a1adbSdrh   ExprList *pList,   /* The expression list to be coded */
4683191b54cbSdrh   int target,        /* Where to write results */
46845579d59fSdrh   int srcReg,        /* Source registers if SQLITE_ECEL_REF */
4685d1a01edaSdrh   u8 flags           /* SQLITE_ECEL_* flags */
4686268380caSdrh ){
4687268380caSdrh   struct ExprList_item *pItem;
46885579d59fSdrh   int i, j, n;
4689d1a01edaSdrh   u8 copyOp = (flags & SQLITE_ECEL_DUP) ? OP_Copy : OP_SCopy;
46905579d59fSdrh   Vdbe *v = pParse->pVdbe;
46919d8b3072Sdrh   assert( pList!=0 );
46929cbf3425Sdrh   assert( target>0 );
4693d81a142bSdrh   assert( pParse->pVdbe!=0 );  /* Never gets this far otherwise */
4694268380caSdrh   n = pList->nExpr;
4695d9f158e7Sdrh   if( !ConstFactorOk(pParse) ) flags &= ~SQLITE_ECEL_FACTOR;
4696191b54cbSdrh   for(pItem=pList->a, i=0; i<n; i++, pItem++){
46977445ffe2Sdrh     Expr *pExpr = pItem->pExpr;
469824e25d32Sdan #ifdef SQLITE_ENABLE_SORTER_REFERENCES
469924e25d32Sdan     if( pItem->bSorterRef ){
470024e25d32Sdan       i--;
470124e25d32Sdan       n--;
470224e25d32Sdan     }else
470324e25d32Sdan #endif
4704257c13faSdan     if( (flags & SQLITE_ECEL_REF)!=0 && (j = pItem->u.x.iOrderByCol)>0 ){
4705257c13faSdan       if( flags & SQLITE_ECEL_OMITREF ){
4706257c13faSdan         i--;
4707257c13faSdan         n--;
4708257c13faSdan       }else{
47095579d59fSdrh         sqlite3VdbeAddOp2(v, copyOp, j+srcReg-1, target+i);
4710257c13faSdan       }
4711b8b06690Sdrh     }else if( (flags & SQLITE_ECEL_FACTOR)!=0
4712b8b06690Sdrh            && sqlite3ExprIsConstantNotJoin(pExpr)
4713b8b06690Sdrh     ){
47149b258c54Sdrh       sqlite3ExprCodeRunJustOnce(pParse, pExpr, target+i);
4715d1a01edaSdrh     }else{
47167445ffe2Sdrh       int inReg = sqlite3ExprCodeTarget(pParse, pExpr, target+i);
4717746fd9ccSdrh       if( inReg!=target+i ){
47184eded604Sdrh         VdbeOp *pOp;
47194eded604Sdrh         if( copyOp==OP_Copy
47204eded604Sdrh          && (pOp=sqlite3VdbeGetOp(v, -1))->opcode==OP_Copy
47214eded604Sdrh          && pOp->p1+pOp->p3+1==inReg
47224eded604Sdrh          && pOp->p2+pOp->p3+1==target+i
472390996885Sdrh          && pOp->p5==0  /* The do-not-merge flag must be clear */
47244eded604Sdrh         ){
47254eded604Sdrh           pOp->p3++;
47264eded604Sdrh         }else{
47274eded604Sdrh           sqlite3VdbeAddOp2(v, copyOp, inReg, target+i);
47284eded604Sdrh         }
4729d1a01edaSdrh       }
4730d176611bSdrh     }
4731268380caSdrh   }
4732f9b596ebSdrh   return n;
4733268380caSdrh }
4734268380caSdrh 
4735268380caSdrh /*
473636c563a2Sdrh ** Generate code for a BETWEEN operator.
473736c563a2Sdrh **
473836c563a2Sdrh **    x BETWEEN y AND z
473936c563a2Sdrh **
474036c563a2Sdrh ** The above is equivalent to
474136c563a2Sdrh **
474236c563a2Sdrh **    x>=y AND x<=z
474336c563a2Sdrh **
474436c563a2Sdrh ** Code it as such, taking care to do the common subexpression
474560ec914cSpeter.d.reid ** elimination of x.
474684b19a3dSdrh **
474784b19a3dSdrh ** The xJumpIf parameter determines details:
474884b19a3dSdrh **
474984b19a3dSdrh **    NULL:                   Store the boolean result in reg[dest]
475084b19a3dSdrh **    sqlite3ExprIfTrue:      Jump to dest if true
475184b19a3dSdrh **    sqlite3ExprIfFalse:     Jump to dest if false
475284b19a3dSdrh **
475384b19a3dSdrh ** The jumpIfNull parameter is ignored if xJumpIf is NULL.
475436c563a2Sdrh */
475536c563a2Sdrh static void exprCodeBetween(
475636c563a2Sdrh   Parse *pParse,    /* Parsing and code generating context */
475736c563a2Sdrh   Expr *pExpr,      /* The BETWEEN expression */
475884b19a3dSdrh   int dest,         /* Jump destination or storage location */
475984b19a3dSdrh   void (*xJump)(Parse*,Expr*,int,int), /* Action to take */
476036c563a2Sdrh   int jumpIfNull    /* Take the jump if the BETWEEN is NULL */
476136c563a2Sdrh ){
476236c563a2Sdrh   Expr exprAnd;     /* The AND operator in  x>=y AND x<=z  */
476336c563a2Sdrh   Expr compLeft;    /* The  x>=y  term */
476436c563a2Sdrh   Expr compRight;   /* The  x<=z  term */
4765db45bd5eSdrh   int regFree1 = 0; /* Temporary use register */
47668b65e591Sdan   Expr *pDel = 0;
47678b65e591Sdan   sqlite3 *db = pParse->db;
476884b19a3dSdrh 
476971c57db0Sdan   memset(&compLeft, 0, sizeof(Expr));
477071c57db0Sdan   memset(&compRight, 0, sizeof(Expr));
477171c57db0Sdan   memset(&exprAnd, 0, sizeof(Expr));
4772db45bd5eSdrh 
4773db45bd5eSdrh   assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
47748b65e591Sdan   pDel = sqlite3ExprDup(db, pExpr->pLeft, 0);
47758b65e591Sdan   if( db->mallocFailed==0 ){
477636c563a2Sdrh     exprAnd.op = TK_AND;
477736c563a2Sdrh     exprAnd.pLeft = &compLeft;
477836c563a2Sdrh     exprAnd.pRight = &compRight;
477936c563a2Sdrh     compLeft.op = TK_GE;
47808b65e591Sdan     compLeft.pLeft = pDel;
478136c563a2Sdrh     compLeft.pRight = pExpr->x.pList->a[0].pExpr;
478236c563a2Sdrh     compRight.op = TK_LE;
47838b65e591Sdan     compRight.pLeft = pDel;
478436c563a2Sdrh     compRight.pRight = pExpr->x.pList->a[1].pExpr;
47858b65e591Sdan     exprToRegister(pDel, exprCodeVector(pParse, pDel, &regFree1));
478684b19a3dSdrh     if( xJump ){
478784b19a3dSdrh       xJump(pParse, &exprAnd, dest, jumpIfNull);
478836c563a2Sdrh     }else{
478936fd41e5Sdrh       /* Mark the expression is being from the ON or USING clause of a join
479036fd41e5Sdrh       ** so that the sqlite3ExprCodeTarget() routine will not attempt to move
479136fd41e5Sdrh       ** it into the Parse.pConstExpr list.  We should use a new bit for this,
479236fd41e5Sdrh       ** for clarity, but we are out of bits in the Expr.flags field so we
479336fd41e5Sdrh       ** have to reuse the EP_FromJoin bit.  Bummer. */
47948b65e591Sdan       pDel->flags |= EP_FromJoin;
479571c57db0Sdan       sqlite3ExprCodeTarget(pParse, &exprAnd, dest);
479636c563a2Sdrh     }
4797db45bd5eSdrh     sqlite3ReleaseTempReg(pParse, regFree1);
47988b65e591Sdan   }
47998b65e591Sdan   sqlite3ExprDelete(db, pDel);
480036c563a2Sdrh 
480136c563a2Sdrh   /* Ensure adequate test coverage */
4802db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull==0 && regFree1==0 );
4803db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull==0 && regFree1!=0 );
4804db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull!=0 && regFree1==0 );
4805db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull!=0 && regFree1!=0 );
4806db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1==0 );
4807db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1!=0 );
4808db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1==0 );
4809db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1!=0 );
481084b19a3dSdrh   testcase( xJump==0 );
481136c563a2Sdrh }
481236c563a2Sdrh 
481336c563a2Sdrh /*
4814cce7d176Sdrh ** Generate code for a boolean expression such that a jump is made
4815cce7d176Sdrh ** to the label "dest" if the expression is true but execution
4816cce7d176Sdrh ** continues straight thru if the expression is false.
4817f5905aa7Sdrh **
4818f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false), then
481935573356Sdrh ** take the jump if the jumpIfNull flag is SQLITE_JUMPIFNULL.
4820f2bc013cSdrh **
4821f2bc013cSdrh ** This code depends on the fact that certain token values (ex: TK_EQ)
4822f2bc013cSdrh ** are the same as opcode values (ex: OP_Eq) that implement the corresponding
4823f2bc013cSdrh ** operation.  Special comments in vdbe.c and the mkopcodeh.awk script in
4824f2bc013cSdrh ** the make process cause these values to align.  Assert()s in the code
4825f2bc013cSdrh ** below verify that the numbers are aligned correctly.
4826cce7d176Sdrh */
48274adee20fSdanielk1977 void sqlite3ExprIfTrue(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
4828cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
4829cce7d176Sdrh   int op = 0;
48302dcef11bSdrh   int regFree1 = 0;
48312dcef11bSdrh   int regFree2 = 0;
48322dcef11bSdrh   int r1, r2;
48332dcef11bSdrh 
483435573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
483548864df9Smistachkin   if( NEVER(v==0) )     return;  /* Existence of VDBE checked by caller */
483633cd4909Sdrh   if( NEVER(pExpr==0) ) return;  /* No way this can happen */
4837e7375bfaSdrh   assert( !ExprHasVVAProperty(pExpr, EP_Immutable) );
4838f2bc013cSdrh   op = pExpr->op;
48397b35a77bSdan   switch( op ){
484017180fcaSdrh     case TK_AND:
484117180fcaSdrh     case TK_OR: {
484217180fcaSdrh       Expr *pAlt = sqlite3ExprSimplifiedAndOr(pExpr);
484317180fcaSdrh       if( pAlt!=pExpr ){
484417180fcaSdrh         sqlite3ExprIfTrue(pParse, pAlt, dest, jumpIfNull);
484517180fcaSdrh       }else if( op==TK_AND ){
4846ec4ccdbcSdrh         int d2 = sqlite3VdbeMakeLabel(pParse);
4847c5499befSdrh         testcase( jumpIfNull==0 );
484817180fcaSdrh         sqlite3ExprIfFalse(pParse, pExpr->pLeft, d2,
484917180fcaSdrh                            jumpIfNull^SQLITE_JUMPIFNULL);
48504adee20fSdanielk1977         sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
48514adee20fSdanielk1977         sqlite3VdbeResolveLabel(v, d2);
485217180fcaSdrh       }else{
4853c5499befSdrh         testcase( jumpIfNull==0 );
48544adee20fSdanielk1977         sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
48554adee20fSdanielk1977         sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
485617180fcaSdrh       }
4857cce7d176Sdrh       break;
4858cce7d176Sdrh     }
4859cce7d176Sdrh     case TK_NOT: {
4860c5499befSdrh       testcase( jumpIfNull==0 );
48614adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
4862cce7d176Sdrh       break;
4863cce7d176Sdrh     }
48648abed7b9Sdrh     case TK_TRUTH: {
486596acafbeSdrh       int isNot;      /* IS NOT TRUE or IS NOT FALSE */
486696acafbeSdrh       int isTrue;     /* IS TRUE or IS NOT TRUE */
4867007c843bSdrh       testcase( jumpIfNull==0 );
48688abed7b9Sdrh       isNot = pExpr->op2==TK_ISNOT;
486996acafbeSdrh       isTrue = sqlite3ExprTruthValue(pExpr->pRight);
487043c4ac8bSdrh       testcase( isTrue && isNot );
487196acafbeSdrh       testcase( !isTrue && isNot );
487243c4ac8bSdrh       if( isTrue ^ isNot ){
48738abed7b9Sdrh         sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
48748abed7b9Sdrh                           isNot ? SQLITE_JUMPIFNULL : 0);
48758abed7b9Sdrh       }else{
48768abed7b9Sdrh         sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
48778abed7b9Sdrh                            isNot ? SQLITE_JUMPIFNULL : 0);
48788abed7b9Sdrh       }
4879007c843bSdrh       break;
4880007c843bSdrh     }
4881de845c2fSdrh     case TK_IS:
4882de845c2fSdrh     case TK_ISNOT:
4883de845c2fSdrh       testcase( op==TK_IS );
4884de845c2fSdrh       testcase( op==TK_ISNOT );
4885de845c2fSdrh       op = (op==TK_IS) ? TK_EQ : TK_NE;
4886de845c2fSdrh       jumpIfNull = SQLITE_NULLEQ;
4887de845c2fSdrh       /* Fall thru */
4888cce7d176Sdrh     case TK_LT:
4889cce7d176Sdrh     case TK_LE:
4890cce7d176Sdrh     case TK_GT:
4891cce7d176Sdrh     case TK_GE:
4892cce7d176Sdrh     case TK_NE:
48930ac65892Sdrh     case TK_EQ: {
4894625015e0Sdan       if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
4895c5499befSdrh       testcase( jumpIfNull==0 );
4896b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4897b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
489835573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
4899898c527eSdrh                   r1, r2, dest, jumpIfNull, ExprHasProperty(pExpr,EP_Commuted));
49007d176105Sdrh       assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
49017d176105Sdrh       assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
49027d176105Sdrh       assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
49037d176105Sdrh       assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
4904de845c2fSdrh       assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4905de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4906de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4907de845c2fSdrh       assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4908de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
4909de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
49106a2fe093Sdrh       testcase( regFree1==0 );
49116a2fe093Sdrh       testcase( regFree2==0 );
49126a2fe093Sdrh       break;
49136a2fe093Sdrh     }
4914cce7d176Sdrh     case TK_ISNULL:
4915cce7d176Sdrh     case TK_NOTNULL: {
49167d176105Sdrh       assert( TK_ISNULL==OP_IsNull );   testcase( op==TK_ISNULL );
49177d176105Sdrh       assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
49182dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
49192dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
49207d176105Sdrh       VdbeCoverageIf(v, op==TK_ISNULL);
49217d176105Sdrh       VdbeCoverageIf(v, op==TK_NOTNULL);
4922c5499befSdrh       testcase( regFree1==0 );
4923cce7d176Sdrh       break;
4924cce7d176Sdrh     }
4925fef5208cSdrh     case TK_BETWEEN: {
49265c03f30aSdrh       testcase( jumpIfNull==0 );
492771c57db0Sdan       exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfTrue, jumpIfNull);
4928fef5208cSdrh       break;
4929fef5208cSdrh     }
4930bb201344Sshaneh #ifndef SQLITE_OMIT_SUBQUERY
4931e3365e6cSdrh     case TK_IN: {
4932ec4ccdbcSdrh       int destIfFalse = sqlite3VdbeMakeLabel(pParse);
4933e3365e6cSdrh       int destIfNull = jumpIfNull ? dest : destIfFalse;
4934e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
4935076e85f5Sdrh       sqlite3VdbeGoto(v, dest);
4936e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
4937e3365e6cSdrh       break;
4938e3365e6cSdrh     }
4939bb201344Sshaneh #endif
4940cce7d176Sdrh     default: {
49417b35a77bSdan     default_expr:
4942ad31727fSdrh       if( ExprAlwaysTrue(pExpr) ){
4943076e85f5Sdrh         sqlite3VdbeGoto(v, dest);
4944ad31727fSdrh       }else if( ExprAlwaysFalse(pExpr) ){
4945991a1985Sdrh         /* No-op */
4946991a1985Sdrh       }else{
49472dcef11bSdrh         r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
49482dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_If, r1, dest, jumpIfNull!=0);
4949688852abSdrh         VdbeCoverage(v);
4950c5499befSdrh         testcase( regFree1==0 );
4951c5499befSdrh         testcase( jumpIfNull==0 );
4952991a1985Sdrh       }
4953cce7d176Sdrh       break;
4954cce7d176Sdrh     }
4955cce7d176Sdrh   }
49562dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
49572dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
4958cce7d176Sdrh }
4959cce7d176Sdrh 
4960cce7d176Sdrh /*
496166b89c8fSdrh ** Generate code for a boolean expression such that a jump is made
4962cce7d176Sdrh ** to the label "dest" if the expression is false but execution
4963cce7d176Sdrh ** continues straight thru if the expression is true.
4964f5905aa7Sdrh **
4965f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false) then
496635573356Sdrh ** jump if jumpIfNull is SQLITE_JUMPIFNULL or fall through if jumpIfNull
496735573356Sdrh ** is 0.
4968cce7d176Sdrh */
49694adee20fSdanielk1977 void sqlite3ExprIfFalse(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
4970cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
4971cce7d176Sdrh   int op = 0;
49722dcef11bSdrh   int regFree1 = 0;
49732dcef11bSdrh   int regFree2 = 0;
49742dcef11bSdrh   int r1, r2;
49752dcef11bSdrh 
497635573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
497748864df9Smistachkin   if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
497833cd4909Sdrh   if( pExpr==0 )    return;
4979e7375bfaSdrh   assert( !ExprHasVVAProperty(pExpr,EP_Immutable) );
4980f2bc013cSdrh 
4981f2bc013cSdrh   /* The value of pExpr->op and op are related as follows:
4982f2bc013cSdrh   **
4983f2bc013cSdrh   **       pExpr->op            op
4984f2bc013cSdrh   **       ---------          ----------
4985f2bc013cSdrh   **       TK_ISNULL          OP_NotNull
4986f2bc013cSdrh   **       TK_NOTNULL         OP_IsNull
4987f2bc013cSdrh   **       TK_NE              OP_Eq
4988f2bc013cSdrh   **       TK_EQ              OP_Ne
4989f2bc013cSdrh   **       TK_GT              OP_Le
4990f2bc013cSdrh   **       TK_LE              OP_Gt
4991f2bc013cSdrh   **       TK_GE              OP_Lt
4992f2bc013cSdrh   **       TK_LT              OP_Ge
4993f2bc013cSdrh   **
4994f2bc013cSdrh   ** For other values of pExpr->op, op is undefined and unused.
4995f2bc013cSdrh   ** The value of TK_ and OP_ constants are arranged such that we
4996f2bc013cSdrh   ** can compute the mapping above using the following expression.
4997f2bc013cSdrh   ** Assert()s verify that the computation is correct.
4998f2bc013cSdrh   */
4999f2bc013cSdrh   op = ((pExpr->op+(TK_ISNULL&1))^1)-(TK_ISNULL&1);
5000f2bc013cSdrh 
5001f2bc013cSdrh   /* Verify correct alignment of TK_ and OP_ constants
5002f2bc013cSdrh   */
5003f2bc013cSdrh   assert( pExpr->op!=TK_ISNULL || op==OP_NotNull );
5004f2bc013cSdrh   assert( pExpr->op!=TK_NOTNULL || op==OP_IsNull );
5005f2bc013cSdrh   assert( pExpr->op!=TK_NE || op==OP_Eq );
5006f2bc013cSdrh   assert( pExpr->op!=TK_EQ || op==OP_Ne );
5007f2bc013cSdrh   assert( pExpr->op!=TK_LT || op==OP_Ge );
5008f2bc013cSdrh   assert( pExpr->op!=TK_LE || op==OP_Gt );
5009f2bc013cSdrh   assert( pExpr->op!=TK_GT || op==OP_Le );
5010f2bc013cSdrh   assert( pExpr->op!=TK_GE || op==OP_Lt );
5011f2bc013cSdrh 
5012ba00e30aSdan   switch( pExpr->op ){
501317180fcaSdrh     case TK_AND:
501417180fcaSdrh     case TK_OR: {
501517180fcaSdrh       Expr *pAlt = sqlite3ExprSimplifiedAndOr(pExpr);
501617180fcaSdrh       if( pAlt!=pExpr ){
501717180fcaSdrh         sqlite3ExprIfFalse(pParse, pAlt, dest, jumpIfNull);
501817180fcaSdrh       }else if( pExpr->op==TK_AND ){
5019c5499befSdrh         testcase( jumpIfNull==0 );
50204adee20fSdanielk1977         sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
50214adee20fSdanielk1977         sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
502217180fcaSdrh       }else{
5023ec4ccdbcSdrh         int d2 = sqlite3VdbeMakeLabel(pParse);
5024c5499befSdrh         testcase( jumpIfNull==0 );
502517180fcaSdrh         sqlite3ExprIfTrue(pParse, pExpr->pLeft, d2,
502617180fcaSdrh                           jumpIfNull^SQLITE_JUMPIFNULL);
50274adee20fSdanielk1977         sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
50284adee20fSdanielk1977         sqlite3VdbeResolveLabel(v, d2);
502917180fcaSdrh       }
5030cce7d176Sdrh       break;
5031cce7d176Sdrh     }
5032cce7d176Sdrh     case TK_NOT: {
50335c03f30aSdrh       testcase( jumpIfNull==0 );
50344adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
5035cce7d176Sdrh       break;
5036cce7d176Sdrh     }
50378abed7b9Sdrh     case TK_TRUTH: {
503896acafbeSdrh       int isNot;   /* IS NOT TRUE or IS NOT FALSE */
503996acafbeSdrh       int isTrue;  /* IS TRUE or IS NOT TRUE */
50408abed7b9Sdrh       testcase( jumpIfNull==0 );
50418abed7b9Sdrh       isNot = pExpr->op2==TK_ISNOT;
504296acafbeSdrh       isTrue = sqlite3ExprTruthValue(pExpr->pRight);
504343c4ac8bSdrh       testcase( isTrue && isNot );
504496acafbeSdrh       testcase( !isTrue && isNot );
504543c4ac8bSdrh       if( isTrue ^ isNot ){
50468abed7b9Sdrh         /* IS TRUE and IS NOT FALSE */
50478abed7b9Sdrh         sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
50488abed7b9Sdrh                            isNot ? 0 : SQLITE_JUMPIFNULL);
50498abed7b9Sdrh 
50508abed7b9Sdrh       }else{
50518abed7b9Sdrh         /* IS FALSE and IS NOT TRUE */
50528abed7b9Sdrh         sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
50538abed7b9Sdrh                           isNot ? 0 : SQLITE_JUMPIFNULL);
50548abed7b9Sdrh       }
5055007c843bSdrh       break;
5056007c843bSdrh     }
5057de845c2fSdrh     case TK_IS:
5058de845c2fSdrh     case TK_ISNOT:
5059de845c2fSdrh       testcase( pExpr->op==TK_IS );
5060de845c2fSdrh       testcase( pExpr->op==TK_ISNOT );
5061de845c2fSdrh       op = (pExpr->op==TK_IS) ? TK_NE : TK_EQ;
5062de845c2fSdrh       jumpIfNull = SQLITE_NULLEQ;
5063de845c2fSdrh       /* Fall thru */
5064cce7d176Sdrh     case TK_LT:
5065cce7d176Sdrh     case TK_LE:
5066cce7d176Sdrh     case TK_GT:
5067cce7d176Sdrh     case TK_GE:
5068cce7d176Sdrh     case TK_NE:
5069cce7d176Sdrh     case TK_EQ: {
5070625015e0Sdan       if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
5071c5499befSdrh       testcase( jumpIfNull==0 );
5072b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
5073b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
507435573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
5075898c527eSdrh                   r1, r2, dest, jumpIfNull,ExprHasProperty(pExpr,EP_Commuted));
50767d176105Sdrh       assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
50777d176105Sdrh       assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
50787d176105Sdrh       assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
50797d176105Sdrh       assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
5080de845c2fSdrh       assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
5081de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
5082de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
5083de845c2fSdrh       assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
5084de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
5085de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
50866a2fe093Sdrh       testcase( regFree1==0 );
50876a2fe093Sdrh       testcase( regFree2==0 );
50886a2fe093Sdrh       break;
50896a2fe093Sdrh     }
5090cce7d176Sdrh     case TK_ISNULL:
5091cce7d176Sdrh     case TK_NOTNULL: {
50922dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
50932dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
50947d176105Sdrh       testcase( op==TK_ISNULL );   VdbeCoverageIf(v, op==TK_ISNULL);
50957d176105Sdrh       testcase( op==TK_NOTNULL );  VdbeCoverageIf(v, op==TK_NOTNULL);
5096c5499befSdrh       testcase( regFree1==0 );
5097cce7d176Sdrh       break;
5098cce7d176Sdrh     }
5099fef5208cSdrh     case TK_BETWEEN: {
51005c03f30aSdrh       testcase( jumpIfNull==0 );
510171c57db0Sdan       exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfFalse, jumpIfNull);
5102fef5208cSdrh       break;
5103fef5208cSdrh     }
5104bb201344Sshaneh #ifndef SQLITE_OMIT_SUBQUERY
5105e3365e6cSdrh     case TK_IN: {
5106e3365e6cSdrh       if( jumpIfNull ){
5107e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, dest);
5108e3365e6cSdrh       }else{
5109ec4ccdbcSdrh         int destIfNull = sqlite3VdbeMakeLabel(pParse);
5110e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, destIfNull);
5111e3365e6cSdrh         sqlite3VdbeResolveLabel(v, destIfNull);
5112e3365e6cSdrh       }
5113e3365e6cSdrh       break;
5114e3365e6cSdrh     }
5115bb201344Sshaneh #endif
5116cce7d176Sdrh     default: {
5117ba00e30aSdan     default_expr:
5118ad31727fSdrh       if( ExprAlwaysFalse(pExpr) ){
5119076e85f5Sdrh         sqlite3VdbeGoto(v, dest);
5120ad31727fSdrh       }else if( ExprAlwaysTrue(pExpr) ){
5121991a1985Sdrh         /* no-op */
5122991a1985Sdrh       }else{
51232dcef11bSdrh         r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
51242dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_IfNot, r1, dest, jumpIfNull!=0);
5125688852abSdrh         VdbeCoverage(v);
5126c5499befSdrh         testcase( regFree1==0 );
5127c5499befSdrh         testcase( jumpIfNull==0 );
5128991a1985Sdrh       }
5129cce7d176Sdrh       break;
5130cce7d176Sdrh     }
5131cce7d176Sdrh   }
51322dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
51332dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
5134cce7d176Sdrh }
51352282792aSdrh 
51362282792aSdrh /*
513772bc8208Sdrh ** Like sqlite3ExprIfFalse() except that a copy is made of pExpr before
513872bc8208Sdrh ** code generation, and that copy is deleted after code generation. This
513972bc8208Sdrh ** ensures that the original pExpr is unchanged.
514072bc8208Sdrh */
514172bc8208Sdrh void sqlite3ExprIfFalseDup(Parse *pParse, Expr *pExpr, int dest,int jumpIfNull){
514272bc8208Sdrh   sqlite3 *db = pParse->db;
514372bc8208Sdrh   Expr *pCopy = sqlite3ExprDup(db, pExpr, 0);
514472bc8208Sdrh   if( db->mallocFailed==0 ){
514572bc8208Sdrh     sqlite3ExprIfFalse(pParse, pCopy, dest, jumpIfNull);
514672bc8208Sdrh   }
514772bc8208Sdrh   sqlite3ExprDelete(db, pCopy);
514872bc8208Sdrh }
514972bc8208Sdrh 
51505aa550cfSdan /*
51515aa550cfSdan ** Expression pVar is guaranteed to be an SQL variable. pExpr may be any
51525aa550cfSdan ** type of expression.
51535aa550cfSdan **
51545aa550cfSdan ** If pExpr is a simple SQL value - an integer, real, string, blob
51555aa550cfSdan ** or NULL value - then the VDBE currently being prepared is configured
51565aa550cfSdan ** to re-prepare each time a new value is bound to variable pVar.
51575aa550cfSdan **
51585aa550cfSdan ** Additionally, if pExpr is a simple SQL value and the value is the
51595aa550cfSdan ** same as that currently bound to variable pVar, non-zero is returned.
51605aa550cfSdan ** Otherwise, if the values are not the same or if pExpr is not a simple
51615aa550cfSdan ** SQL value, zero is returned.
51625aa550cfSdan */
51635aa550cfSdan static int exprCompareVariable(Parse *pParse, Expr *pVar, Expr *pExpr){
51645aa550cfSdan   int res = 0;
5165c0804226Sdrh   int iVar;
5166c0804226Sdrh   sqlite3_value *pL, *pR = 0;
51675aa550cfSdan 
51685aa550cfSdan   sqlite3ValueFromExpr(pParse->db, pExpr, SQLITE_UTF8, SQLITE_AFF_BLOB, &pR);
5169c0804226Sdrh   if( pR ){
5170c0804226Sdrh     iVar = pVar->iColumn;
5171c0804226Sdrh     sqlite3VdbeSetVarmask(pParse->pVdbe, iVar);
5172c0804226Sdrh     pL = sqlite3VdbeGetBoundValue(pParse->pReprepare, iVar, SQLITE_AFF_BLOB);
51735aa307e2Sdrh     if( pL ){
51745aa307e2Sdrh       if( sqlite3_value_type(pL)==SQLITE_TEXT ){
51755aa307e2Sdrh         sqlite3_value_text(pL); /* Make sure the encoding is UTF-8 */
51765aa307e2Sdrh       }
51775aa307e2Sdrh       res =  0==sqlite3MemCompare(pL, pR, 0);
51785aa550cfSdan     }
51795aa550cfSdan     sqlite3ValueFree(pR);
51805aa550cfSdan     sqlite3ValueFree(pL);
51815aa550cfSdan   }
51825aa550cfSdan 
51835aa550cfSdan   return res;
51845aa550cfSdan }
518572bc8208Sdrh 
518672bc8208Sdrh /*
51871d9da70aSdrh ** Do a deep comparison of two expression trees.  Return 0 if the two
51881d9da70aSdrh ** expressions are completely identical.  Return 1 if they differ only
51891d9da70aSdrh ** by a COLLATE operator at the top level.  Return 2 if there are differences
51901d9da70aSdrh ** other than the top-level COLLATE operator.
5191d40aab0eSdrh **
5192619a1305Sdrh ** If any subelement of pB has Expr.iTable==(-1) then it is allowed
5193619a1305Sdrh ** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
5194619a1305Sdrh **
519566518ca7Sdrh ** The pA side might be using TK_REGISTER.  If that is the case and pB is
519666518ca7Sdrh ** not using TK_REGISTER but is otherwise equivalent, then still return 0.
519766518ca7Sdrh **
51981d9da70aSdrh ** Sometimes this routine will return 2 even if the two expressions
5199d40aab0eSdrh ** really are equivalent.  If we cannot prove that the expressions are
52001d9da70aSdrh ** identical, we return 2 just to be safe.  So if this routine
52011d9da70aSdrh ** returns 2, then you do not really know for certain if the two
52021d9da70aSdrh ** expressions are the same.  But if you get a 0 or 1 return, then you
5203d40aab0eSdrh ** can be sure the expressions are the same.  In the places where
52041d9da70aSdrh ** this routine is used, it does not hurt to get an extra 2 - that
5205d40aab0eSdrh ** just might result in some slightly slower code.  But returning
52061d9da70aSdrh ** an incorrect 0 or 1 could lead to a malfunction.
52075aa550cfSdan **
5208c0804226Sdrh ** If pParse is not NULL then TK_VARIABLE terms in pA with bindings in
5209c0804226Sdrh ** pParse->pReprepare can be matched against literals in pB.  The
5210c0804226Sdrh ** pParse->pVdbe->expmask bitmask is updated for each variable referenced.
5211c0804226Sdrh ** If pParse is NULL (the normal case) then any TK_VARIABLE term in
5212c0804226Sdrh ** Argument pParse should normally be NULL. If it is not NULL and pA or
5213c0804226Sdrh ** pB causes a return value of 2.
52142282792aSdrh */
52155aa550cfSdan int sqlite3ExprCompare(Parse *pParse, Expr *pA, Expr *pB, int iTab){
521610d1edf0Sdrh   u32 combinedFlags;
52174b202ae2Sdanielk1977   if( pA==0 || pB==0 ){
52181d9da70aSdrh     return pB==pA ? 0 : 2;
52192282792aSdrh   }
52205aa550cfSdan   if( pParse && pA->op==TK_VARIABLE && exprCompareVariable(pParse, pA, pB) ){
52215aa550cfSdan     return 0;
52225aa550cfSdan   }
522310d1edf0Sdrh   combinedFlags = pA->flags | pB->flags;
522410d1edf0Sdrh   if( combinedFlags & EP_IntValue ){
522510d1edf0Sdrh     if( (pA->flags&pB->flags&EP_IntValue)!=0 && pA->u.iValue==pB->u.iValue ){
522610d1edf0Sdrh       return 0;
522710d1edf0Sdrh     }
52281d9da70aSdrh     return 2;
52296ab3a2ecSdanielk1977   }
523016dd3985Sdan   if( pA->op!=pB->op || pA->op==TK_RAISE ){
52315aa550cfSdan     if( pA->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA->pLeft,pB,iTab)<2 ){
5232ae80ddeaSdrh       return 1;
5233ae80ddeaSdrh     }
52345aa550cfSdan     if( pB->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA,pB->pLeft,iTab)<2 ){
5235ae80ddeaSdrh       return 1;
5236ae80ddeaSdrh     }
5237ae80ddeaSdrh     return 2;
5238ae80ddeaSdrh   }
52392edc5fd7Sdrh   if( pA->op!=TK_COLUMN && pA->op!=TK_AGG_COLUMN && pA->u.zToken ){
52404f9adee2Sdan     if( pA->op==TK_FUNCTION || pA->op==TK_AGG_FUNCTION ){
5241390b88a4Sdrh       if( sqlite3StrICmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
5242eda079cdSdrh #ifndef SQLITE_OMIT_WINDOWFUNC
52434f9adee2Sdan       assert( pA->op==pB->op );
52444f9adee2Sdan       if( ExprHasProperty(pA,EP_WinFunc)!=ExprHasProperty(pB,EP_WinFunc) ){
52454f9adee2Sdan         return 2;
52464f9adee2Sdan       }
5247eda079cdSdrh       if( ExprHasProperty(pA,EP_WinFunc) ){
52484f9adee2Sdan         if( sqlite3WindowCompare(pParse, pA->y.pWin, pB->y.pWin, 1)!=0 ){
52494f9adee2Sdan           return 2;
52504f9adee2Sdan         }
5251eda079cdSdrh       }
5252eda079cdSdrh #endif
5253f20bbc5fSdrh     }else if( pA->op==TK_NULL ){
5254f20bbc5fSdrh       return 0;
5255d5af5420Sdrh     }else if( pA->op==TK_COLLATE ){
5256e79f6299Sdrh       if( sqlite3_stricmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
5257f20bbc5fSdrh     }else if( ALWAYS(pB->u.zToken!=0) && strcmp(pA->u.zToken,pB->u.zToken)!=0 ){
5258d5af5420Sdrh       return 2;
525910d1edf0Sdrh     }
526010d1edf0Sdrh   }
5261898c527eSdrh   if( (pA->flags & (EP_Distinct|EP_Commuted))
5262898c527eSdrh      != (pB->flags & (EP_Distinct|EP_Commuted)) ) return 2;
5263e7375bfaSdrh   if( ALWAYS((combinedFlags & EP_TokenOnly)==0) ){
526410d1edf0Sdrh     if( combinedFlags & EP_xIsSelect ) return 2;
5265efad2e23Sdrh     if( (combinedFlags & EP_FixedCol)==0
5266efad2e23Sdrh      && sqlite3ExprCompare(pParse, pA->pLeft, pB->pLeft, iTab) ) return 2;
52675aa550cfSdan     if( sqlite3ExprCompare(pParse, pA->pRight, pB->pRight, iTab) ) return 2;
5268619a1305Sdrh     if( sqlite3ExprListCompare(pA->x.pList, pB->x.pList, iTab) ) return 2;
526903c5c213Sdrh     if( pA->op!=TK_STRING
527003c5c213Sdrh      && pA->op!=TK_TRUEFALSE
5271e7375bfaSdrh      && ALWAYS((combinedFlags & EP_Reduced)==0)
527203c5c213Sdrh     ){
5273619a1305Sdrh       if( pA->iColumn!=pB->iColumn ) return 2;
52749b258c54Sdrh       if( pA->op2!=pB->op2 && pA->op==TK_TRUTH ) return 2;
52750f28e1bdSdrh       if( pA->op!=TK_IN && pA->iTable!=pB->iTable && pA->iTable!=iTab ){
52760f28e1bdSdrh         return 2;
52770f28e1bdSdrh       }
52781d9da70aSdrh     }
52791d9da70aSdrh   }
52802646da7eSdrh   return 0;
52812646da7eSdrh }
52822282792aSdrh 
52838c6f666bSdrh /*
5284fbb6e9ffSdan ** Compare two ExprList objects.  Return 0 if they are identical, 1
5285fbb6e9ffSdan ** if they are certainly different, or 2 if it is not possible to
5286fbb6e9ffSdan ** determine if they are identical or not.
52878c6f666bSdrh **
5288619a1305Sdrh ** If any subelement of pB has Expr.iTable==(-1) then it is allowed
5289619a1305Sdrh ** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
5290619a1305Sdrh **
52918c6f666bSdrh ** This routine might return non-zero for equivalent ExprLists.  The
52928c6f666bSdrh ** only consequence will be disabled optimizations.  But this routine
52938c6f666bSdrh ** must never return 0 if the two ExprList objects are different, or
52948c6f666bSdrh ** a malfunction will result.
52958c6f666bSdrh **
52968c6f666bSdrh ** Two NULL pointers are considered to be the same.  But a NULL pointer
52978c6f666bSdrh ** always differs from a non-NULL pointer.
52988c6f666bSdrh */
5299619a1305Sdrh int sqlite3ExprListCompare(ExprList *pA, ExprList *pB, int iTab){
53008c6f666bSdrh   int i;
53018c6f666bSdrh   if( pA==0 && pB==0 ) return 0;
53028c6f666bSdrh   if( pA==0 || pB==0 ) return 1;
53038c6f666bSdrh   if( pA->nExpr!=pB->nExpr ) return 1;
53048c6f666bSdrh   for(i=0; i<pA->nExpr; i++){
5305fbb6e9ffSdan     int res;
53068c6f666bSdrh     Expr *pExprA = pA->a[i].pExpr;
53078c6f666bSdrh     Expr *pExprB = pB->a[i].pExpr;
53086e11892dSdan     if( pA->a[i].sortFlags!=pB->a[i].sortFlags ) return 1;
5309fbb6e9ffSdan     if( (res = sqlite3ExprCompare(0, pExprA, pExprB, iTab)) ) return res;
53108c6f666bSdrh   }
53118c6f666bSdrh   return 0;
53128c6f666bSdrh }
531313449892Sdrh 
53142282792aSdrh /*
5315f9463dfbSdrh ** Like sqlite3ExprCompare() except COLLATE operators at the top-level
5316f9463dfbSdrh ** are ignored.
5317f9463dfbSdrh */
5318f9463dfbSdrh int sqlite3ExprCompareSkip(Expr *pA, Expr *pB, int iTab){
53195aa550cfSdan   return sqlite3ExprCompare(0,
53200d950af3Sdrh              sqlite3ExprSkipCollateAndLikely(pA),
53210d950af3Sdrh              sqlite3ExprSkipCollateAndLikely(pB),
5322f9463dfbSdrh              iTab);
5323f9463dfbSdrh }
5324f9463dfbSdrh 
5325f9463dfbSdrh /*
5326c51cf864Sdrh ** Return non-zero if Expr p can only be true if pNN is not NULL.
53277a231b49Sdrh **
53287a231b49Sdrh ** Or if seenNot is true, return non-zero if Expr p can only be
53297a231b49Sdrh ** non-NULL if pNN is not NULL
5330c51cf864Sdrh */
5331c51cf864Sdrh static int exprImpliesNotNull(
5332c51cf864Sdrh   Parse *pParse,      /* Parsing context */
5333c51cf864Sdrh   Expr *p,            /* The expression to be checked */
5334c51cf864Sdrh   Expr *pNN,          /* The expression that is NOT NULL */
5335c51cf864Sdrh   int iTab,           /* Table being evaluated */
53367a231b49Sdrh   int seenNot         /* Return true only if p can be any non-NULL value */
5337c51cf864Sdrh ){
5338c51cf864Sdrh   assert( p );
5339c51cf864Sdrh   assert( pNN );
534014c865e8Sdrh   if( sqlite3ExprCompare(pParse, p, pNN, iTab)==0 ){
534114c865e8Sdrh     return pNN->op!=TK_NULL;
534214c865e8Sdrh   }
5343c51cf864Sdrh   switch( p->op ){
5344c51cf864Sdrh     case TK_IN: {
5345c51cf864Sdrh       if( seenNot && ExprHasProperty(p, EP_xIsSelect) ) return 0;
5346c51cf864Sdrh       assert( ExprHasProperty(p,EP_xIsSelect)
5347c51cf864Sdrh            || (p->x.pList!=0 && p->x.pList->nExpr>0) );
5348ae144a1cSdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
5349c51cf864Sdrh     }
5350c51cf864Sdrh     case TK_BETWEEN: {
5351c51cf864Sdrh       ExprList *pList = p->x.pList;
5352c51cf864Sdrh       assert( pList!=0 );
5353c51cf864Sdrh       assert( pList->nExpr==2 );
5354c51cf864Sdrh       if( seenNot ) return 0;
53557a231b49Sdrh       if( exprImpliesNotNull(pParse, pList->a[0].pExpr, pNN, iTab, 1)
53567a231b49Sdrh        || exprImpliesNotNull(pParse, pList->a[1].pExpr, pNN, iTab, 1)
5357c51cf864Sdrh       ){
5358c51cf864Sdrh         return 1;
5359c51cf864Sdrh       }
53607a231b49Sdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
5361c51cf864Sdrh     }
5362c51cf864Sdrh     case TK_EQ:
5363c51cf864Sdrh     case TK_NE:
5364c51cf864Sdrh     case TK_LT:
5365c51cf864Sdrh     case TK_LE:
5366c51cf864Sdrh     case TK_GT:
5367c51cf864Sdrh     case TK_GE:
5368c51cf864Sdrh     case TK_PLUS:
5369c51cf864Sdrh     case TK_MINUS:
53709d23ea74Sdan     case TK_BITOR:
53719d23ea74Sdan     case TK_LSHIFT:
53729d23ea74Sdan     case TK_RSHIFT:
53739d23ea74Sdan     case TK_CONCAT:
53749d23ea74Sdan       seenNot = 1;
53759d23ea74Sdan       /* Fall thru */
5376c51cf864Sdrh     case TK_STAR:
5377c51cf864Sdrh     case TK_REM:
5378c51cf864Sdrh     case TK_BITAND:
53799d23ea74Sdan     case TK_SLASH: {
5380c51cf864Sdrh       if( exprImpliesNotNull(pParse, p->pRight, pNN, iTab, seenNot) ) return 1;
5381c51cf864Sdrh       /* Fall thru into the next case */
5382c51cf864Sdrh     }
5383c51cf864Sdrh     case TK_SPAN:
5384c51cf864Sdrh     case TK_COLLATE:
5385c51cf864Sdrh     case TK_UPLUS:
5386c51cf864Sdrh     case TK_UMINUS: {
5387c51cf864Sdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, seenNot);
5388c51cf864Sdrh     }
5389c51cf864Sdrh     case TK_TRUTH: {
5390c51cf864Sdrh       if( seenNot ) return 0;
5391c51cf864Sdrh       if( p->op2!=TK_IS ) return 0;
539238cefc83Sdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
5393c51cf864Sdrh     }
53941cd382e3Sdan     case TK_BITNOT:
5395c51cf864Sdrh     case TK_NOT: {
5396c51cf864Sdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
5397c51cf864Sdrh     }
5398c51cf864Sdrh   }
5399c51cf864Sdrh   return 0;
5400c51cf864Sdrh }
5401c51cf864Sdrh 
5402c51cf864Sdrh /*
54034bd5f73fSdrh ** Return true if we can prove the pE2 will always be true if pE1 is
54044bd5f73fSdrh ** true.  Return false if we cannot complete the proof or if pE2 might
54054bd5f73fSdrh ** be false.  Examples:
54064bd5f73fSdrh **
5407619a1305Sdrh **     pE1: x==5       pE2: x==5             Result: true
54084bd5f73fSdrh **     pE1: x>0        pE2: x==5             Result: false
5409619a1305Sdrh **     pE1: x=21       pE2: x=21 OR y=43     Result: true
54104bd5f73fSdrh **     pE1: x!=123     pE2: x IS NOT NULL    Result: true
5411619a1305Sdrh **     pE1: x!=?1      pE2: x IS NOT NULL    Result: true
5412619a1305Sdrh **     pE1: x IS NULL  pE2: x IS NOT NULL    Result: false
5413619a1305Sdrh **     pE1: x IS ?2    pE2: x IS NOT NULL    Reuslt: false
54144bd5f73fSdrh **
54154bd5f73fSdrh ** When comparing TK_COLUMN nodes between pE1 and pE2, if pE2 has
54164bd5f73fSdrh ** Expr.iTable<0 then assume a table number given by iTab.
54174bd5f73fSdrh **
5418c0804226Sdrh ** If pParse is not NULL, then the values of bound variables in pE1 are
5419c0804226Sdrh ** compared against literal values in pE2 and pParse->pVdbe->expmask is
5420c0804226Sdrh ** modified to record which bound variables are referenced.  If pParse
5421c0804226Sdrh ** is NULL, then false will be returned if pE1 contains any bound variables.
5422c0804226Sdrh **
54234bd5f73fSdrh ** When in doubt, return false.  Returning true might give a performance
54244bd5f73fSdrh ** improvement.  Returning false might cause a performance reduction, but
54254bd5f73fSdrh ** it will always give the correct answer and is hence always safe.
54264bd5f73fSdrh */
54275aa550cfSdan int sqlite3ExprImpliesExpr(Parse *pParse, Expr *pE1, Expr *pE2, int iTab){
54285aa550cfSdan   if( sqlite3ExprCompare(pParse, pE1, pE2, iTab)==0 ){
5429619a1305Sdrh     return 1;
5430619a1305Sdrh   }
5431619a1305Sdrh   if( pE2->op==TK_OR
54325aa550cfSdan    && (sqlite3ExprImpliesExpr(pParse, pE1, pE2->pLeft, iTab)
54335aa550cfSdan              || sqlite3ExprImpliesExpr(pParse, pE1, pE2->pRight, iTab) )
5434619a1305Sdrh   ){
5435619a1305Sdrh     return 1;
5436619a1305Sdrh   }
5437664d6d13Sdrh   if( pE2->op==TK_NOTNULL
5438c51cf864Sdrh    && exprImpliesNotNull(pParse, pE1, pE2->pLeft, iTab, 0)
5439664d6d13Sdrh   ){
5440c51cf864Sdrh     return 1;
5441619a1305Sdrh   }
5442619a1305Sdrh   return 0;
54434bd5f73fSdrh }
54444bd5f73fSdrh 
54454bd5f73fSdrh /*
54466c68d759Sdrh ** This is the Expr node callback for sqlite3ExprImpliesNonNullRow().
54472589787cSdrh ** If the expression node requires that the table at pWalker->iCur
5448f8937f90Sdrh ** have one or more non-NULL column, then set pWalker->eCode to 1 and abort.
5449f8937f90Sdrh **
5450f8937f90Sdrh ** This routine controls an optimization.  False positives (setting
5451f8937f90Sdrh ** pWalker->eCode to 1 when it should not be) are deadly, but false-negatives
5452f8937f90Sdrh ** (never setting pWalker->eCode) is a harmless missed optimization.
54532589787cSdrh */
54542589787cSdrh static int impliesNotNullRow(Walker *pWalker, Expr *pExpr){
5455f8937f90Sdrh   testcase( pExpr->op==TK_AGG_COLUMN );
5456821b610bSdrh   testcase( pExpr->op==TK_AGG_FUNCTION );
54572589787cSdrh   if( ExprHasProperty(pExpr, EP_FromJoin) ) return WRC_Prune;
54582589787cSdrh   switch( pExpr->op ){
54590493222fSdan     case TK_ISNOT:
54602589787cSdrh     case TK_ISNULL:
5461d5793672Sdrh     case TK_NOTNULL:
54622589787cSdrh     case TK_IS:
54632589787cSdrh     case TK_OR:
54646c68d759Sdrh     case TK_VECTOR:
54652c492061Sdrh     case TK_CASE:
5466e3eff266Sdrh     case TK_IN:
54672589787cSdrh     case TK_FUNCTION:
5468da03c1e6Sdan     case TK_TRUTH:
54690493222fSdan       testcase( pExpr->op==TK_ISNOT );
5470821b610bSdrh       testcase( pExpr->op==TK_ISNULL );
5471d5793672Sdrh       testcase( pExpr->op==TK_NOTNULL );
5472821b610bSdrh       testcase( pExpr->op==TK_IS );
5473821b610bSdrh       testcase( pExpr->op==TK_OR );
54746c68d759Sdrh       testcase( pExpr->op==TK_VECTOR );
5475821b610bSdrh       testcase( pExpr->op==TK_CASE );
5476821b610bSdrh       testcase( pExpr->op==TK_IN );
5477821b610bSdrh       testcase( pExpr->op==TK_FUNCTION );
5478da03c1e6Sdan       testcase( pExpr->op==TK_TRUTH );
54792589787cSdrh       return WRC_Prune;
54802589787cSdrh     case TK_COLUMN:
54812589787cSdrh       if( pWalker->u.iCur==pExpr->iTable ){
54822589787cSdrh         pWalker->eCode = 1;
54832589787cSdrh         return WRC_Abort;
54842589787cSdrh       }
54852589787cSdrh       return WRC_Prune;
54869881155dSdrh 
54879d23ea74Sdan     case TK_AND:
5488aef81674Sdrh       if( pWalker->eCode==0 ){
54890287c951Sdan         sqlite3WalkExpr(pWalker, pExpr->pLeft);
54900287c951Sdan         if( pWalker->eCode ){
54910287c951Sdan           pWalker->eCode = 0;
54920287c951Sdan           sqlite3WalkExpr(pWalker, pExpr->pRight);
54939d23ea74Sdan         }
5494aef81674Sdrh       }
54959d23ea74Sdan       return WRC_Prune;
54969d23ea74Sdan 
54979d23ea74Sdan     case TK_BETWEEN:
54981d24a531Sdan       if( sqlite3WalkExpr(pWalker, pExpr->pLeft)==WRC_Abort ){
54991d24a531Sdan         assert( pWalker->eCode );
55001d24a531Sdan         return WRC_Abort;
55011d24a531Sdan       }
55029d23ea74Sdan       return WRC_Prune;
55039d23ea74Sdan 
55049881155dSdrh     /* Virtual tables are allowed to use constraints like x=NULL.  So
55059881155dSdrh     ** a term of the form x=y does not prove that y is not null if x
55069881155dSdrh     ** is the column of a virtual table */
55079881155dSdrh     case TK_EQ:
55089881155dSdrh     case TK_NE:
55099881155dSdrh     case TK_LT:
55109881155dSdrh     case TK_LE:
55119881155dSdrh     case TK_GT:
551278d1d225Sdrh     case TK_GE: {
551378d1d225Sdrh       Expr *pLeft = pExpr->pLeft;
551478d1d225Sdrh       Expr *pRight = pExpr->pRight;
55159881155dSdrh       testcase( pExpr->op==TK_EQ );
55169881155dSdrh       testcase( pExpr->op==TK_NE );
55179881155dSdrh       testcase( pExpr->op==TK_LT );
55189881155dSdrh       testcase( pExpr->op==TK_LE );
55199881155dSdrh       testcase( pExpr->op==TK_GT );
55209881155dSdrh       testcase( pExpr->op==TK_GE );
552178d1d225Sdrh       /* The y.pTab=0 assignment in wherecode.c always happens after the
552278d1d225Sdrh       ** impliesNotNullRow() test */
552378d1d225Sdrh       if( (pLeft->op==TK_COLUMN && ALWAYS(pLeft->y.pTab!=0)
552478d1d225Sdrh                                && IsVirtual(pLeft->y.pTab))
552578d1d225Sdrh        || (pRight->op==TK_COLUMN && ALWAYS(pRight->y.pTab!=0)
552678d1d225Sdrh                                && IsVirtual(pRight->y.pTab))
55279881155dSdrh       ){
55289881155dSdrh         return WRC_Prune;
55299881155dSdrh       }
553078d1d225Sdrh     }
55312589787cSdrh     default:
55322589787cSdrh       return WRC_Continue;
55332589787cSdrh   }
55342589787cSdrh }
55352589787cSdrh 
55362589787cSdrh /*
55372589787cSdrh ** Return true (non-zero) if expression p can only be true if at least
55382589787cSdrh ** one column of table iTab is non-null.  In other words, return true
55392589787cSdrh ** if expression p will always be NULL or false if every column of iTab
55402589787cSdrh ** is NULL.
55412589787cSdrh **
5542821b610bSdrh ** False negatives are acceptable.  In other words, it is ok to return
5543821b610bSdrh ** zero even if expression p will never be true of every column of iTab
5544821b610bSdrh ** is NULL.  A false negative is merely a missed optimization opportunity.
5545821b610bSdrh **
5546821b610bSdrh ** False positives are not allowed, however.  A false positive may result
5547821b610bSdrh ** in an incorrect answer.
5548821b610bSdrh **
55492589787cSdrh ** Terms of p that are marked with EP_FromJoin (and hence that come from
55502589787cSdrh ** the ON or USING clauses of LEFT JOINS) are excluded from the analysis.
55512589787cSdrh **
55522589787cSdrh ** This routine is used to check if a LEFT JOIN can be converted into
55532589787cSdrh ** an ordinary JOIN.  The p argument is the WHERE clause.  If the WHERE
55542589787cSdrh ** clause requires that some column of the right table of the LEFT JOIN
55552589787cSdrh ** be non-NULL, then the LEFT JOIN can be safely converted into an
55562589787cSdrh ** ordinary join.
55572589787cSdrh */
55582589787cSdrh int sqlite3ExprImpliesNonNullRow(Expr *p, int iTab){
55592589787cSdrh   Walker w;
55600d950af3Sdrh   p = sqlite3ExprSkipCollateAndLikely(p);
55614a254f98Sdrh   if( p==0 ) return 0;
55624a254f98Sdrh   if( p->op==TK_NOTNULL ){
5563d6db6598Sdrh     p = p->pLeft;
5564a1698993Sdrh   }else{
5565a1698993Sdrh     while( p->op==TK_AND ){
55664a254f98Sdrh       if( sqlite3ExprImpliesNonNullRow(p->pLeft, iTab) ) return 1;
55674a254f98Sdrh       p = p->pRight;
5568d6db6598Sdrh     }
5569a1698993Sdrh   }
55702589787cSdrh   w.xExprCallback = impliesNotNullRow;
55712589787cSdrh   w.xSelectCallback = 0;
55722589787cSdrh   w.xSelectCallback2 = 0;
55732589787cSdrh   w.eCode = 0;
55742589787cSdrh   w.u.iCur = iTab;
55752589787cSdrh   sqlite3WalkExpr(&w, p);
55762589787cSdrh   return w.eCode;
55772589787cSdrh }
55782589787cSdrh 
55792589787cSdrh /*
5580030796dfSdrh ** An instance of the following structure is used by the tree walker
55812409f8a1Sdrh ** to determine if an expression can be evaluated by reference to the
55822409f8a1Sdrh ** index only, without having to do a search for the corresponding
55832409f8a1Sdrh ** table entry.  The IdxCover.pIdx field is the index.  IdxCover.iCur
55842409f8a1Sdrh ** is the cursor for the table.
55852409f8a1Sdrh */
55862409f8a1Sdrh struct IdxCover {
55872409f8a1Sdrh   Index *pIdx;     /* The index to be tested for coverage */
55882409f8a1Sdrh   int iCur;        /* Cursor number for the table corresponding to the index */
55892409f8a1Sdrh };
55902409f8a1Sdrh 
55912409f8a1Sdrh /*
55922409f8a1Sdrh ** Check to see if there are references to columns in table
55932409f8a1Sdrh ** pWalker->u.pIdxCover->iCur can be satisfied using the index
55942409f8a1Sdrh ** pWalker->u.pIdxCover->pIdx.
55952409f8a1Sdrh */
55962409f8a1Sdrh static int exprIdxCover(Walker *pWalker, Expr *pExpr){
55972409f8a1Sdrh   if( pExpr->op==TK_COLUMN
55982409f8a1Sdrh    && pExpr->iTable==pWalker->u.pIdxCover->iCur
5599b9bcf7caSdrh    && sqlite3TableColumnToIndex(pWalker->u.pIdxCover->pIdx, pExpr->iColumn)<0
56002409f8a1Sdrh   ){
56012409f8a1Sdrh     pWalker->eCode = 1;
56022409f8a1Sdrh     return WRC_Abort;
56032409f8a1Sdrh   }
56042409f8a1Sdrh   return WRC_Continue;
56052409f8a1Sdrh }
56062409f8a1Sdrh 
56072409f8a1Sdrh /*
5608e604ec0bSdrh ** Determine if an index pIdx on table with cursor iCur contains will
5609e604ec0bSdrh ** the expression pExpr.  Return true if the index does cover the
5610e604ec0bSdrh ** expression and false if the pExpr expression references table columns
5611e604ec0bSdrh ** that are not found in the index pIdx.
56122409f8a1Sdrh **
56132409f8a1Sdrh ** An index covering an expression means that the expression can be
56142409f8a1Sdrh ** evaluated using only the index and without having to lookup the
56152409f8a1Sdrh ** corresponding table entry.
56162409f8a1Sdrh */
56172409f8a1Sdrh int sqlite3ExprCoveredByIndex(
56182409f8a1Sdrh   Expr *pExpr,        /* The index to be tested */
56192409f8a1Sdrh   int iCur,           /* The cursor number for the corresponding table */
56202409f8a1Sdrh   Index *pIdx         /* The index that might be used for coverage */
56212409f8a1Sdrh ){
56222409f8a1Sdrh   Walker w;
56232409f8a1Sdrh   struct IdxCover xcov;
56242409f8a1Sdrh   memset(&w, 0, sizeof(w));
56252409f8a1Sdrh   xcov.iCur = iCur;
56262409f8a1Sdrh   xcov.pIdx = pIdx;
56272409f8a1Sdrh   w.xExprCallback = exprIdxCover;
56282409f8a1Sdrh   w.u.pIdxCover = &xcov;
56292409f8a1Sdrh   sqlite3WalkExpr(&w, pExpr);
56302409f8a1Sdrh   return !w.eCode;
56312409f8a1Sdrh }
56322409f8a1Sdrh 
56332409f8a1Sdrh 
56342409f8a1Sdrh /*
56352409f8a1Sdrh ** An instance of the following structure is used by the tree walker
5636030796dfSdrh ** to count references to table columns in the arguments of an
5637ed551b95Sdrh ** aggregate function, in order to implement the
5638ed551b95Sdrh ** sqlite3FunctionThisSrc() routine.
5639374fdce4Sdrh */
5640030796dfSdrh struct SrcCount {
5641030796dfSdrh   SrcList *pSrc;   /* One particular FROM clause in a nested query */
5642030796dfSdrh   int nThis;       /* Number of references to columns in pSrcList */
5643030796dfSdrh   int nOther;      /* Number of references to columns in other FROM clauses */
5644030796dfSdrh };
5645030796dfSdrh 
5646030796dfSdrh /*
5647030796dfSdrh ** Count the number of references to columns.
5648030796dfSdrh */
5649030796dfSdrh static int exprSrcCount(Walker *pWalker, Expr *pExpr){
5650b4b36306Sdan   /* There was once a NEVER() on the second term on the grounds that
5651b4b36306Sdan   ** sqlite3FunctionUsesThisSrc() was always called before
5652b4b36306Sdan   ** sqlite3ExprAnalyzeAggregates() and so the TK_COLUMNs have not yet
5653b4b36306Sdan   ** been converted into TK_AGG_COLUMN. But this is no longer true due
5654b4b36306Sdan   ** to window functions - sqlite3WindowRewrite() may now indirectly call
5655b4b36306Sdan   ** FunctionUsesThisSrc() when creating a new sub-select. */
5656b4b36306Sdan   if( pExpr->op==TK_COLUMN || pExpr->op==TK_AGG_COLUMN ){
5657374fdce4Sdrh     int i;
5658030796dfSdrh     struct SrcCount *p = pWalker->u.pSrcCount;
5659030796dfSdrh     SrcList *pSrc = p->pSrc;
5660655814d2Sdrh     int nSrc = pSrc ? pSrc->nSrc : 0;
5661655814d2Sdrh     for(i=0; i<nSrc; i++){
5662030796dfSdrh       if( pExpr->iTable==pSrc->a[i].iCursor ) break;
5663374fdce4Sdrh     }
5664655814d2Sdrh     if( i<nSrc ){
5665030796dfSdrh       p->nThis++;
566680f6bfc0Sdrh     }else if( nSrc==0 || pExpr->iTable<pSrc->a[0].iCursor ){
566780f6bfc0Sdrh       /* In a well-formed parse tree (no name resolution errors),
566835a38e08Sdrh       ** TK_COLUMN nodes with smaller Expr.iTable values are in an
566980f6bfc0Sdrh       ** outer context.  Those are the only ones to count as "other" */
5670030796dfSdrh       p->nOther++;
5671374fdce4Sdrh     }
5672374fdce4Sdrh   }
5673030796dfSdrh   return WRC_Continue;
5674030796dfSdrh }
5675374fdce4Sdrh 
5676374fdce4Sdrh /*
5677030796dfSdrh ** Determine if any of the arguments to the pExpr Function reference
5678030796dfSdrh ** pSrcList.  Return true if they do.  Also return true if the function
5679030796dfSdrh ** has no arguments or has only constant arguments.  Return false if pExpr
5680030796dfSdrh ** references columns but not columns of tables found in pSrcList.
5681374fdce4Sdrh */
5682030796dfSdrh int sqlite3FunctionUsesThisSrc(Expr *pExpr, SrcList *pSrcList){
5683374fdce4Sdrh   Walker w;
5684030796dfSdrh   struct SrcCount cnt;
5685374fdce4Sdrh   assert( pExpr->op==TK_AGG_FUNCTION );
568680f6bfc0Sdrh   memset(&w, 0, sizeof(w));
5687030796dfSdrh   w.xExprCallback = exprSrcCount;
568880f6bfc0Sdrh   w.xSelectCallback = sqlite3SelectWalkNoop;
5689030796dfSdrh   w.u.pSrcCount = &cnt;
5690030796dfSdrh   cnt.pSrc = pSrcList;
5691030796dfSdrh   cnt.nThis = 0;
5692030796dfSdrh   cnt.nOther = 0;
5693030796dfSdrh   sqlite3WalkExprList(&w, pExpr->x.pList);
56945e484cb3Sdan #ifndef SQLITE_OMIT_WINDOWFUNC
56955e484cb3Sdan   if( ExprHasProperty(pExpr, EP_WinFunc) ){
56965e484cb3Sdan     sqlite3WalkExpr(&w, pExpr->y.pWin->pFilter);
56975e484cb3Sdan   }
56985e484cb3Sdan #endif
5699030796dfSdrh   return cnt.nThis>0 || cnt.nOther==0;
5700374fdce4Sdrh }
5701374fdce4Sdrh 
5702374fdce4Sdrh /*
570313449892Sdrh ** Add a new element to the pAggInfo->aCol[] array.  Return the index of
570413449892Sdrh ** the new element.  Return a negative number if malloc fails.
57052282792aSdrh */
570617435752Sdrh static int addAggInfoColumn(sqlite3 *db, AggInfo *pInfo){
570713449892Sdrh   int i;
5708cf643729Sdrh   pInfo->aCol = sqlite3ArrayAllocate(
570917435752Sdrh        db,
5710cf643729Sdrh        pInfo->aCol,
5711cf643729Sdrh        sizeof(pInfo->aCol[0]),
5712cf643729Sdrh        &pInfo->nColumn,
5713cf643729Sdrh        &i
5714cf643729Sdrh   );
571513449892Sdrh   return i;
57162282792aSdrh }
571713449892Sdrh 
571813449892Sdrh /*
571913449892Sdrh ** Add a new element to the pAggInfo->aFunc[] array.  Return the index of
572013449892Sdrh ** the new element.  Return a negative number if malloc fails.
572113449892Sdrh */
572217435752Sdrh static int addAggInfoFunc(sqlite3 *db, AggInfo *pInfo){
572313449892Sdrh   int i;
5724cf643729Sdrh   pInfo->aFunc = sqlite3ArrayAllocate(
572517435752Sdrh        db,
5726cf643729Sdrh        pInfo->aFunc,
5727cf643729Sdrh        sizeof(pInfo->aFunc[0]),
5728cf643729Sdrh        &pInfo->nFunc,
5729cf643729Sdrh        &i
5730cf643729Sdrh   );
573113449892Sdrh   return i;
57322282792aSdrh }
57332282792aSdrh 
57342282792aSdrh /*
57357d10d5a6Sdrh ** This is the xExprCallback for a tree walker.  It is used to
57367d10d5a6Sdrh ** implement sqlite3ExprAnalyzeAggregates().  See sqlite3ExprAnalyzeAggregates
5737626a879aSdrh ** for additional information.
57382282792aSdrh */
57397d10d5a6Sdrh static int analyzeAggregate(Walker *pWalker, Expr *pExpr){
57402282792aSdrh   int i;
57417d10d5a6Sdrh   NameContext *pNC = pWalker->u.pNC;
5742a58fdfb1Sdanielk1977   Parse *pParse = pNC->pParse;
5743a58fdfb1Sdanielk1977   SrcList *pSrcList = pNC->pSrcList;
574425c3b8caSdrh   AggInfo *pAggInfo = pNC->uNC.pAggInfo;
574513449892Sdrh 
574625c3b8caSdrh   assert( pNC->ncFlags & NC_UAggInfo );
57472282792aSdrh   switch( pExpr->op ){
574889c69d00Sdrh     case TK_AGG_COLUMN:
5749967e8b73Sdrh     case TK_COLUMN: {
57508b213899Sdrh       testcase( pExpr->op==TK_AGG_COLUMN );
57518b213899Sdrh       testcase( pExpr->op==TK_COLUMN );
575213449892Sdrh       /* Check to see if the column is in one of the tables in the FROM
575313449892Sdrh       ** clause of the aggregate query */
575420bc393cSdrh       if( ALWAYS(pSrcList!=0) ){
575513449892Sdrh         struct SrcList_item *pItem = pSrcList->a;
575613449892Sdrh         for(i=0; i<pSrcList->nSrc; i++, pItem++){
575713449892Sdrh           struct AggInfo_col *pCol;
5758c5cd1249Sdrh           assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
575913449892Sdrh           if( pExpr->iTable==pItem->iCursor ){
576013449892Sdrh             /* If we reach this point, it means that pExpr refers to a table
576113449892Sdrh             ** that is in the FROM clause of the aggregate query.
576213449892Sdrh             **
576313449892Sdrh             ** Make an entry for the column in pAggInfo->aCol[] if there
576413449892Sdrh             ** is not an entry there already.
576513449892Sdrh             */
57667f906d63Sdrh             int k;
576713449892Sdrh             pCol = pAggInfo->aCol;
57687f906d63Sdrh             for(k=0; k<pAggInfo->nColumn; k++, pCol++){
576913449892Sdrh               if( pCol->iTable==pExpr->iTable &&
577013449892Sdrh                   pCol->iColumn==pExpr->iColumn ){
57712282792aSdrh                 break;
57722282792aSdrh               }
57732282792aSdrh             }
57741e536953Sdanielk1977             if( (k>=pAggInfo->nColumn)
57751e536953Sdanielk1977              && (k = addAggInfoColumn(pParse->db, pAggInfo))>=0
57761e536953Sdanielk1977             ){
57777f906d63Sdrh               pCol = &pAggInfo->aCol[k];
5778eda079cdSdrh               pCol->pTab = pExpr->y.pTab;
577913449892Sdrh               pCol->iTable = pExpr->iTable;
578013449892Sdrh               pCol->iColumn = pExpr->iColumn;
57810a07c107Sdrh               pCol->iMem = ++pParse->nMem;
578213449892Sdrh               pCol->iSorterColumn = -1;
57835774b806Sdrh               pCol->pExpr = pExpr;
578413449892Sdrh               if( pAggInfo->pGroupBy ){
578513449892Sdrh                 int j, n;
578613449892Sdrh                 ExprList *pGB = pAggInfo->pGroupBy;
578713449892Sdrh                 struct ExprList_item *pTerm = pGB->a;
578813449892Sdrh                 n = pGB->nExpr;
578913449892Sdrh                 for(j=0; j<n; j++, pTerm++){
579013449892Sdrh                   Expr *pE = pTerm->pExpr;
579113449892Sdrh                   if( pE->op==TK_COLUMN && pE->iTable==pExpr->iTable &&
579213449892Sdrh                       pE->iColumn==pExpr->iColumn ){
579313449892Sdrh                     pCol->iSorterColumn = j;
579413449892Sdrh                     break;
57952282792aSdrh                   }
579613449892Sdrh                 }
579713449892Sdrh               }
579813449892Sdrh               if( pCol->iSorterColumn<0 ){
579913449892Sdrh                 pCol->iSorterColumn = pAggInfo->nSortingColumn++;
580013449892Sdrh               }
580113449892Sdrh             }
580213449892Sdrh             /* There is now an entry for pExpr in pAggInfo->aCol[] (either
580313449892Sdrh             ** because it was there before or because we just created it).
580413449892Sdrh             ** Convert the pExpr to be a TK_AGG_COLUMN referring to that
580513449892Sdrh             ** pAggInfo->aCol[] entry.
580613449892Sdrh             */
5807ebb6a65dSdrh             ExprSetVVAProperty(pExpr, EP_NoReduce);
580813449892Sdrh             pExpr->pAggInfo = pAggInfo;
580913449892Sdrh             pExpr->op = TK_AGG_COLUMN;
5810cf697396Sshane             pExpr->iAgg = (i16)k;
581113449892Sdrh             break;
581213449892Sdrh           } /* endif pExpr->iTable==pItem->iCursor */
581313449892Sdrh         } /* end loop over pSrcList */
5814a58fdfb1Sdanielk1977       }
58157d10d5a6Sdrh       return WRC_Prune;
58162282792aSdrh     }
58172282792aSdrh     case TK_AGG_FUNCTION: {
58183a8c4be7Sdrh       if( (pNC->ncFlags & NC_InAggFunc)==0
5819ed551b95Sdrh        && pWalker->walkerDepth==pExpr->op2
58203a8c4be7Sdrh       ){
582113449892Sdrh         /* Check to see if pExpr is a duplicate of another aggregate
582213449892Sdrh         ** function that is already in the pAggInfo structure
582313449892Sdrh         */
582413449892Sdrh         struct AggInfo_func *pItem = pAggInfo->aFunc;
582513449892Sdrh         for(i=0; i<pAggInfo->nFunc; i++, pItem++){
58265aa550cfSdan           if( sqlite3ExprCompare(0, pItem->pExpr, pExpr, -1)==0 ){
58272282792aSdrh             break;
58282282792aSdrh           }
58292282792aSdrh         }
583013449892Sdrh         if( i>=pAggInfo->nFunc ){
583113449892Sdrh           /* pExpr is original.  Make a new entry in pAggInfo->aFunc[]
583213449892Sdrh           */
583314db2665Sdanielk1977           u8 enc = ENC(pParse->db);
58341e536953Sdanielk1977           i = addAggInfoFunc(pParse->db, pAggInfo);
583513449892Sdrh           if( i>=0 ){
58366ab3a2ecSdanielk1977             assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
583713449892Sdrh             pItem = &pAggInfo->aFunc[i];
583813449892Sdrh             pItem->pExpr = pExpr;
58390a07c107Sdrh             pItem->iMem = ++pParse->nMem;
584033e619fcSdrh             assert( !ExprHasProperty(pExpr, EP_IntValue) );
584113449892Sdrh             pItem->pFunc = sqlite3FindFunction(pParse->db,
584280738d9cSdrh                    pExpr->u.zToken,
58436ab3a2ecSdanielk1977                    pExpr->x.pList ? pExpr->x.pList->nExpr : 0, enc, 0);
5844fd357974Sdrh             if( pExpr->flags & EP_Distinct ){
5845fd357974Sdrh               pItem->iDistinct = pParse->nTab++;
5846fd357974Sdrh             }else{
5847fd357974Sdrh               pItem->iDistinct = -1;
5848fd357974Sdrh             }
58492282792aSdrh           }
585013449892Sdrh         }
585113449892Sdrh         /* Make pExpr point to the appropriate pAggInfo->aFunc[] entry
585213449892Sdrh         */
5853c5cd1249Sdrh         assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
5854ebb6a65dSdrh         ExprSetVVAProperty(pExpr, EP_NoReduce);
5855cf697396Sshane         pExpr->iAgg = (i16)i;
585613449892Sdrh         pExpr->pAggInfo = pAggInfo;
58573a8c4be7Sdrh         return WRC_Prune;
58586e83a57fSdrh       }else{
58596e83a57fSdrh         return WRC_Continue;
58606e83a57fSdrh       }
58612282792aSdrh     }
5862a58fdfb1Sdanielk1977   }
58637d10d5a6Sdrh   return WRC_Continue;
58647d10d5a6Sdrh }
58657d10d5a6Sdrh static int analyzeAggregatesInSelect(Walker *pWalker, Select *pSelect){
5866d5a336efSdrh   UNUSED_PARAMETER(pSelect);
5867979dd1beSdrh   pWalker->walkerDepth++;
58687d10d5a6Sdrh   return WRC_Continue;
5869a58fdfb1Sdanielk1977 }
5870979dd1beSdrh static void analyzeAggregatesInSelectEnd(Walker *pWalker, Select *pSelect){
5871979dd1beSdrh   UNUSED_PARAMETER(pSelect);
5872979dd1beSdrh   pWalker->walkerDepth--;
5873979dd1beSdrh }
5874626a879aSdrh 
5875626a879aSdrh /*
5876e8abb4caSdrh ** Analyze the pExpr expression looking for aggregate functions and
5877e8abb4caSdrh ** for variables that need to be added to AggInfo object that pNC->pAggInfo
5878e8abb4caSdrh ** points to.  Additional entries are made on the AggInfo object as
5879e8abb4caSdrh ** necessary.
5880626a879aSdrh **
5881626a879aSdrh ** This routine should only be called after the expression has been
58827d10d5a6Sdrh ** analyzed by sqlite3ResolveExprNames().
5883626a879aSdrh */
5884d2b3e23bSdrh void sqlite3ExprAnalyzeAggregates(NameContext *pNC, Expr *pExpr){
58857d10d5a6Sdrh   Walker w;
58867d10d5a6Sdrh   w.xExprCallback = analyzeAggregate;
58877d10d5a6Sdrh   w.xSelectCallback = analyzeAggregatesInSelect;
5888979dd1beSdrh   w.xSelectCallback2 = analyzeAggregatesInSelectEnd;
5889979dd1beSdrh   w.walkerDepth = 0;
58907d10d5a6Sdrh   w.u.pNC = pNC;
5891d9995031Sdan   w.pParse = 0;
589220bc393cSdrh   assert( pNC->pSrcList!=0 );
58937d10d5a6Sdrh   sqlite3WalkExpr(&w, pExpr);
58942282792aSdrh }
58955d9a4af9Sdrh 
58965d9a4af9Sdrh /*
58975d9a4af9Sdrh ** Call sqlite3ExprAnalyzeAggregates() for every expression in an
58985d9a4af9Sdrh ** expression list.  Return the number of errors.
58995d9a4af9Sdrh **
59005d9a4af9Sdrh ** If an error is found, the analysis is cut short.
59015d9a4af9Sdrh */
5902d2b3e23bSdrh void sqlite3ExprAnalyzeAggList(NameContext *pNC, ExprList *pList){
59035d9a4af9Sdrh   struct ExprList_item *pItem;
59045d9a4af9Sdrh   int i;
59055d9a4af9Sdrh   if( pList ){
5906d2b3e23bSdrh     for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
5907d2b3e23bSdrh       sqlite3ExprAnalyzeAggregates(pNC, pItem->pExpr);
59085d9a4af9Sdrh     }
59095d9a4af9Sdrh   }
59105d9a4af9Sdrh }
5911892d3179Sdrh 
5912892d3179Sdrh /*
5913ceea3321Sdrh ** Allocate a single new register for use to hold some intermediate result.
5914892d3179Sdrh */
5915892d3179Sdrh int sqlite3GetTempReg(Parse *pParse){
5916e55cbd72Sdrh   if( pParse->nTempReg==0 ){
5917892d3179Sdrh     return ++pParse->nMem;
5918892d3179Sdrh   }
59192f425f6bSdanielk1977   return pParse->aTempReg[--pParse->nTempReg];
5920892d3179Sdrh }
5921ceea3321Sdrh 
5922ceea3321Sdrh /*
5923ceea3321Sdrh ** Deallocate a register, making available for reuse for some other
5924ceea3321Sdrh ** purpose.
5925ceea3321Sdrh */
5926892d3179Sdrh void sqlite3ReleaseTempReg(Parse *pParse, int iReg){
592713d79502Sdrh   if( iReg ){
59283aef2fb1Sdrh     sqlite3VdbeReleaseRegisters(pParse, iReg, 1, 0, 0);
592913d79502Sdrh     if( pParse->nTempReg<ArraySize(pParse->aTempReg) ){
5930892d3179Sdrh       pParse->aTempReg[pParse->nTempReg++] = iReg;
5931892d3179Sdrh     }
5932892d3179Sdrh   }
593313d79502Sdrh }
5934892d3179Sdrh 
5935892d3179Sdrh /*
5936ed24da4bSdrh ** Allocate or deallocate a block of nReg consecutive registers.
5937892d3179Sdrh */
5938892d3179Sdrh int sqlite3GetTempRange(Parse *pParse, int nReg){
5939e55cbd72Sdrh   int i, n;
5940ed24da4bSdrh   if( nReg==1 ) return sqlite3GetTempReg(pParse);
5941892d3179Sdrh   i = pParse->iRangeReg;
5942e55cbd72Sdrh   n = pParse->nRangeReg;
5943f49f3523Sdrh   if( nReg<=n ){
5944892d3179Sdrh     pParse->iRangeReg += nReg;
5945892d3179Sdrh     pParse->nRangeReg -= nReg;
5946892d3179Sdrh   }else{
5947892d3179Sdrh     i = pParse->nMem+1;
5948892d3179Sdrh     pParse->nMem += nReg;
5949892d3179Sdrh   }
5950892d3179Sdrh   return i;
5951892d3179Sdrh }
5952892d3179Sdrh void sqlite3ReleaseTempRange(Parse *pParse, int iReg, int nReg){
5953ed24da4bSdrh   if( nReg==1 ){
5954ed24da4bSdrh     sqlite3ReleaseTempReg(pParse, iReg);
5955ed24da4bSdrh     return;
5956ed24da4bSdrh   }
59573aef2fb1Sdrh   sqlite3VdbeReleaseRegisters(pParse, iReg, nReg, 0, 0);
5958892d3179Sdrh   if( nReg>pParse->nRangeReg ){
5959892d3179Sdrh     pParse->nRangeReg = nReg;
5960892d3179Sdrh     pParse->iRangeReg = iReg;
5961892d3179Sdrh   }
5962892d3179Sdrh }
5963cdc69557Sdrh 
5964cdc69557Sdrh /*
5965cdc69557Sdrh ** Mark all temporary registers as being unavailable for reuse.
59666d2566dfSdrh **
59676d2566dfSdrh ** Always invoke this procedure after coding a subroutine or co-routine
59686d2566dfSdrh ** that might be invoked from other parts of the code, to ensure that
59696d2566dfSdrh ** the sub/co-routine does not use registers in common with the code that
59706d2566dfSdrh ** invokes the sub/co-routine.
5971cdc69557Sdrh */
5972cdc69557Sdrh void sqlite3ClearTempRegCache(Parse *pParse){
5973cdc69557Sdrh   pParse->nTempReg = 0;
5974cdc69557Sdrh   pParse->nRangeReg = 0;
5975cdc69557Sdrh }
5976bb9b5f26Sdrh 
5977bb9b5f26Sdrh /*
5978bb9b5f26Sdrh ** Validate that no temporary register falls within the range of
5979bb9b5f26Sdrh ** iFirst..iLast, inclusive.  This routine is only call from within assert()
5980bb9b5f26Sdrh ** statements.
5981bb9b5f26Sdrh */
5982bb9b5f26Sdrh #ifdef SQLITE_DEBUG
5983bb9b5f26Sdrh int sqlite3NoTempsInRange(Parse *pParse, int iFirst, int iLast){
5984bb9b5f26Sdrh   int i;
5985bb9b5f26Sdrh   if( pParse->nRangeReg>0
59863963e584Sdrh    && pParse->iRangeReg+pParse->nRangeReg > iFirst
59873963e584Sdrh    && pParse->iRangeReg <= iLast
5988bb9b5f26Sdrh   ){
5989bb9b5f26Sdrh      return 0;
5990bb9b5f26Sdrh   }
5991bb9b5f26Sdrh   for(i=0; i<pParse->nTempReg; i++){
5992bb9b5f26Sdrh     if( pParse->aTempReg[i]>=iFirst && pParse->aTempReg[i]<=iLast ){
5993bb9b5f26Sdrh       return 0;
5994bb9b5f26Sdrh     }
5995bb9b5f26Sdrh   }
5996bb9b5f26Sdrh   return 1;
5997bb9b5f26Sdrh }
5998bb9b5f26Sdrh #endif /* SQLITE_DEBUG */
5999