xref: /sqlite-3.40.0/src/expr.c (revision 04307c8a)
1cce7d176Sdrh /*
2b19a2bc6Sdrh ** 2001 September 15
3cce7d176Sdrh **
4b19a2bc6Sdrh ** The author disclaims copyright to this source code.  In place of
5b19a2bc6Sdrh ** a legal notice, here is a blessing:
6cce7d176Sdrh **
7b19a2bc6Sdrh **    May you do good and not evil.
8b19a2bc6Sdrh **    May you find forgiveness for yourself and forgive others.
9b19a2bc6Sdrh **    May you share freely, never taking more than you give.
10cce7d176Sdrh **
11cce7d176Sdrh *************************************************************************
121ccde15dSdrh ** This file contains routines used for analyzing expressions and
13b19a2bc6Sdrh ** for generating VDBE code that evaluates expressions in SQLite.
14cce7d176Sdrh */
15cce7d176Sdrh #include "sqliteInt.h"
16a2e00042Sdrh 
1712abf408Sdrh /* Forward declarations */
1812abf408Sdrh static void exprCodeBetween(Parse*,Expr*,int,void(*)(Parse*,Expr*,int,int),int);
1912abf408Sdrh static int exprCodeVector(Parse *pParse, Expr *p, int *piToFree);
2012abf408Sdrh 
210dfa4f6fSdrh /*
220dfa4f6fSdrh ** Return the affinity character for a single column of a table.
230dfa4f6fSdrh */
240dfa4f6fSdrh char sqlite3TableColumnAffinity(Table *pTab, int iCol){
250dfa4f6fSdrh   assert( iCol<pTab->nCol );
260dfa4f6fSdrh   return iCol>=0 ? pTab->aCol[iCol].affinity : SQLITE_AFF_INTEGER;
270dfa4f6fSdrh }
2812abf408Sdrh 
29e014a838Sdanielk1977 /*
30e014a838Sdanielk1977 ** Return the 'affinity' of the expression pExpr if any.
31e014a838Sdanielk1977 **
32e014a838Sdanielk1977 ** If pExpr is a column, a reference to a column via an 'AS' alias,
33e014a838Sdanielk1977 ** or a sub-select with a column as the return value, then the
34e014a838Sdanielk1977 ** affinity of that column is returned. Otherwise, 0x00 is returned,
35e014a838Sdanielk1977 ** indicating no affinity for the expression.
36e014a838Sdanielk1977 **
3760ec914cSpeter.d.reid ** i.e. the WHERE clause expressions in the following statements all
38e014a838Sdanielk1977 ** have an affinity:
39e014a838Sdanielk1977 **
40e014a838Sdanielk1977 ** CREATE TABLE t1(a);
41e014a838Sdanielk1977 ** SELECT * FROM t1 WHERE a;
42e014a838Sdanielk1977 ** SELECT a AS b FROM t1 WHERE b;
43e014a838Sdanielk1977 ** SELECT * FROM t1 WHERE (select a from t1);
44e014a838Sdanielk1977 */
45bf3b721fSdanielk1977 char sqlite3ExprAffinity(Expr *pExpr){
46580c8c18Sdrh   int op;
47a7d6db6aSdrh   while( ExprHasProperty(pExpr, EP_Skip) ){
48a7d6db6aSdrh     assert( pExpr->op==TK_COLLATE );
49a7d6db6aSdrh     pExpr = pExpr->pLeft;
50a7d6db6aSdrh     assert( pExpr!=0 );
51a7d6db6aSdrh   }
52580c8c18Sdrh   op = pExpr->op;
53487e262fSdrh   if( op==TK_SELECT ){
546ab3a2ecSdanielk1977     assert( pExpr->flags&EP_xIsSelect );
556ab3a2ecSdanielk1977     return sqlite3ExprAffinity(pExpr->x.pSelect->pEList->a[0].pExpr);
56a37cdde0Sdanielk1977   }
57db45bd5eSdrh   if( op==TK_REGISTER ) op = pExpr->op2;
58487e262fSdrh #ifndef SQLITE_OMIT_CAST
59487e262fSdrh   if( op==TK_CAST ){
6033e619fcSdrh     assert( !ExprHasProperty(pExpr, EP_IntValue) );
61fdaac671Sdrh     return sqlite3AffinityType(pExpr->u.zToken, 0);
62487e262fSdrh   }
63487e262fSdrh #endif
64eda079cdSdrh   if( (op==TK_AGG_COLUMN || op==TK_COLUMN) && pExpr->y.pTab ){
65eda079cdSdrh     return sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
667d10d5a6Sdrh   }
6780aa5453Sdan   if( op==TK_SELECT_COLUMN ){
6880aa5453Sdan     assert( pExpr->pLeft->flags&EP_xIsSelect );
6980aa5453Sdan     return sqlite3ExprAffinity(
7080aa5453Sdan         pExpr->pLeft->x.pSelect->pEList->a[pExpr->iColumn].pExpr
7180aa5453Sdan     );
7280aa5453Sdan   }
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 */
1557cedc8d4Sdanielk1977 CollSeq *sqlite3ExprCollSeq(Parse *pParse, Expr *pExpr){
156ae80ddeaSdrh   sqlite3 *db = pParse->db;
1577cedc8d4Sdanielk1977   CollSeq *pColl = 0;
1587d10d5a6Sdrh   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 );
1936728cd91Sdrh         /* p->flags holds EP_Collate and p->pLeft->flags does not.  And
1946728cd91Sdrh         ** p->x.pSelect cannot.  So if p->x.pLeft exists, it must hold at
1956728cd91Sdrh         ** least one EP_Collate. Thus the following two ALWAYS. */
19692a2824cSdrh         if( p->x.pList!=0
19792a2824cSdrh          && !db->mallocFailed
19892a2824cSdrh          && ALWAYS(!ExprHasProperty(p, EP_xIsSelect))
19992a2824cSdrh         ){
2002308ed38Sdrh           int i;
2016728cd91Sdrh           for(i=0; ALWAYS(i<p->x.pList->nExpr); i++){
2022308ed38Sdrh             if( ExprHasProperty(p->x.pList->a[i].pExpr, EP_Collate) ){
2032308ed38Sdrh               pNext = p->x.pList->a[i].pExpr;
2042308ed38Sdrh               break;
2052308ed38Sdrh             }
2062308ed38Sdrh           }
2072308ed38Sdrh         }
2082308ed38Sdrh         p = pNext;
209ae80ddeaSdrh       }
210ae80ddeaSdrh     }else{
211ae80ddeaSdrh       break;
212ae80ddeaSdrh     }
2130202b29eSdanielk1977   }
2147cedc8d4Sdanielk1977   if( sqlite3CheckCollSeq(pParse, pColl) ){
2157cedc8d4Sdanielk1977     pColl = 0;
2167cedc8d4Sdanielk1977   }
2177cedc8d4Sdanielk1977   return pColl;
2180202b29eSdanielk1977 }
2190202b29eSdanielk1977 
2200202b29eSdanielk1977 /*
22170efa84dSdrh ** Return the collation sequence for the expression pExpr. If
22270efa84dSdrh ** there is no defined collating sequence, return a pointer to the
22370efa84dSdrh ** defautl collation sequence.
22470efa84dSdrh **
22570efa84dSdrh ** See also: sqlite3ExprCollSeq()
22670efa84dSdrh **
22770efa84dSdrh ** The sqlite3ExprCollSeq() routine works the same except that it
22870efa84dSdrh ** returns NULL if there is no defined collation.
22970efa84dSdrh */
23070efa84dSdrh CollSeq *sqlite3ExprNNCollSeq(Parse *pParse, Expr *pExpr){
23170efa84dSdrh   CollSeq *p = sqlite3ExprCollSeq(pParse, pExpr);
23270efa84dSdrh   if( p==0 ) p = pParse->db->pDfltColl;
23370efa84dSdrh   assert( p!=0 );
23470efa84dSdrh   return p;
23570efa84dSdrh }
23670efa84dSdrh 
23770efa84dSdrh /*
23870efa84dSdrh ** Return TRUE if the two expressions have equivalent collating sequences.
23970efa84dSdrh */
24070efa84dSdrh int sqlite3ExprCollSeqMatch(Parse *pParse, Expr *pE1, Expr *pE2){
24170efa84dSdrh   CollSeq *pColl1 = sqlite3ExprNNCollSeq(pParse, pE1);
24270efa84dSdrh   CollSeq *pColl2 = sqlite3ExprNNCollSeq(pParse, pE2);
24370efa84dSdrh   return sqlite3StrICmp(pColl1->zName, pColl2->zName)==0;
24470efa84dSdrh }
24570efa84dSdrh 
24670efa84dSdrh /*
247626a879aSdrh ** pExpr is an operand of a comparison operator.  aff2 is the
248626a879aSdrh ** type affinity of the other operand.  This routine returns the
24953db1458Sdrh ** type affinity that should be used for the comparison operator.
25053db1458Sdrh */
251e014a838Sdanielk1977 char sqlite3CompareAffinity(Expr *pExpr, char aff2){
252bf3b721fSdanielk1977   char aff1 = sqlite3ExprAffinity(pExpr);
25396fb16eeSdrh   if( aff1>SQLITE_AFF_NONE && aff2>SQLITE_AFF_NONE ){
2548df447f0Sdrh     /* Both sides of the comparison are columns. If one has numeric
2558df447f0Sdrh     ** affinity, use that. Otherwise use no affinity.
256e014a838Sdanielk1977     */
2578a51256cSdrh     if( sqlite3IsNumericAffinity(aff1) || sqlite3IsNumericAffinity(aff2) ){
258e014a838Sdanielk1977       return SQLITE_AFF_NUMERIC;
259e014a838Sdanielk1977     }else{
26005883a34Sdrh       return SQLITE_AFF_BLOB;
261e014a838Sdanielk1977     }
262e014a838Sdanielk1977   }else{
263e014a838Sdanielk1977     /* One side is a column, the other is not. Use the columns affinity. */
26496fb16eeSdrh     assert( aff1<=SQLITE_AFF_NONE || aff2<=SQLITE_AFF_NONE );
26596fb16eeSdrh     return (aff1<=SQLITE_AFF_NONE ? aff2 : aff1) | SQLITE_AFF_NONE;
266e014a838Sdanielk1977   }
267e014a838Sdanielk1977 }
268e014a838Sdanielk1977 
26953db1458Sdrh /*
27053db1458Sdrh ** pExpr is a comparison operator.  Return the type affinity that should
27153db1458Sdrh ** be applied to both operands prior to doing the comparison.
27253db1458Sdrh */
273e014a838Sdanielk1977 static char comparisonAffinity(Expr *pExpr){
274e014a838Sdanielk1977   char aff;
275e014a838Sdanielk1977   assert( pExpr->op==TK_EQ || pExpr->op==TK_IN || pExpr->op==TK_LT ||
276e014a838Sdanielk1977           pExpr->op==TK_GT || pExpr->op==TK_GE || pExpr->op==TK_LE ||
2776a2fe093Sdrh           pExpr->op==TK_NE || pExpr->op==TK_IS || pExpr->op==TK_ISNOT );
278e014a838Sdanielk1977   assert( pExpr->pLeft );
279bf3b721fSdanielk1977   aff = sqlite3ExprAffinity(pExpr->pLeft);
280e014a838Sdanielk1977   if( pExpr->pRight ){
281e014a838Sdanielk1977     aff = sqlite3CompareAffinity(pExpr->pRight, aff);
2826ab3a2ecSdanielk1977   }else if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2836ab3a2ecSdanielk1977     aff = sqlite3CompareAffinity(pExpr->x.pSelect->pEList->a[0].pExpr, aff);
28413ac46eeSdrh   }else if( aff==0 ){
28505883a34Sdrh     aff = SQLITE_AFF_BLOB;
286e014a838Sdanielk1977   }
287e014a838Sdanielk1977   return aff;
288e014a838Sdanielk1977 }
289e014a838Sdanielk1977 
290e014a838Sdanielk1977 /*
291e014a838Sdanielk1977 ** pExpr is a comparison expression, eg. '=', '<', IN(...) etc.
292e014a838Sdanielk1977 ** idx_affinity is the affinity of an indexed column. Return true
293e014a838Sdanielk1977 ** if the index with affinity idx_affinity may be used to implement
294e014a838Sdanielk1977 ** the comparison in pExpr.
295e014a838Sdanielk1977 */
296e014a838Sdanielk1977 int sqlite3IndexAffinityOk(Expr *pExpr, char idx_affinity){
297e014a838Sdanielk1977   char aff = comparisonAffinity(pExpr);
298915e434cSdrh   if( aff<SQLITE_AFF_TEXT ){
2998a51256cSdrh     return 1;
3008a51256cSdrh   }
301915e434cSdrh   if( aff==SQLITE_AFF_TEXT ){
302915e434cSdrh     return idx_affinity==SQLITE_AFF_TEXT;
303915e434cSdrh   }
304915e434cSdrh   return sqlite3IsNumericAffinity(idx_affinity);
305e014a838Sdanielk1977 }
306e014a838Sdanielk1977 
307a37cdde0Sdanielk1977 /*
30835573356Sdrh ** Return the P5 value that should be used for a binary comparison
309a37cdde0Sdanielk1977 ** opcode (OP_Eq, OP_Ge etc.) used to compare pExpr1 and pExpr2.
310a37cdde0Sdanielk1977 */
31135573356Sdrh static u8 binaryCompareP5(Expr *pExpr1, Expr *pExpr2, int jumpIfNull){
31235573356Sdrh   u8 aff = (char)sqlite3ExprAffinity(pExpr2);
3131bd10f8aSdrh   aff = (u8)sqlite3CompareAffinity(pExpr1, aff) | (u8)jumpIfNull;
31435573356Sdrh   return aff;
315a37cdde0Sdanielk1977 }
316a37cdde0Sdanielk1977 
317a2e00042Sdrh /*
3180202b29eSdanielk1977 ** Return a pointer to the collation sequence that should be used by
3190202b29eSdanielk1977 ** a binary comparison operator comparing pLeft and pRight.
3200202b29eSdanielk1977 **
3210202b29eSdanielk1977 ** If the left hand expression has a collating sequence type, then it is
3220202b29eSdanielk1977 ** used. Otherwise the collation sequence for the right hand expression
3230202b29eSdanielk1977 ** is used, or the default (BINARY) if neither expression has a collating
3240202b29eSdanielk1977 ** type.
325bcbb04e5Sdanielk1977 **
326bcbb04e5Sdanielk1977 ** Argument pRight (but not pLeft) may be a null pointer. In this case,
327bcbb04e5Sdanielk1977 ** it is not considered.
3280202b29eSdanielk1977 */
329bcbb04e5Sdanielk1977 CollSeq *sqlite3BinaryCompareCollSeq(
330bcbb04e5Sdanielk1977   Parse *pParse,
331bcbb04e5Sdanielk1977   Expr *pLeft,
332bcbb04e5Sdanielk1977   Expr *pRight
333bcbb04e5Sdanielk1977 ){
334ec41ddacSdrh   CollSeq *pColl;
335ec41ddacSdrh   assert( pLeft );
336ae80ddeaSdrh   if( pLeft->flags & EP_Collate ){
337ae80ddeaSdrh     pColl = sqlite3ExprCollSeq(pParse, pLeft);
338ae80ddeaSdrh   }else if( pRight && (pRight->flags & EP_Collate)!=0 ){
339ae80ddeaSdrh     pColl = sqlite3ExprCollSeq(pParse, pRight);
340ec41ddacSdrh   }else{
341ec41ddacSdrh     pColl = sqlite3ExprCollSeq(pParse, pLeft);
3420202b29eSdanielk1977     if( !pColl ){
3437cedc8d4Sdanielk1977       pColl = sqlite3ExprCollSeq(pParse, pRight);
3440202b29eSdanielk1977     }
345ec41ddacSdrh   }
3460202b29eSdanielk1977   return pColl;
3470202b29eSdanielk1977 }
3480202b29eSdanielk1977 
349898c527eSdrh /* Expresssion p is a comparison operator.  Return a collation sequence
350898c527eSdrh ** appropriate for the comparison operator.
351898c527eSdrh **
352898c527eSdrh ** This is normally just a wrapper around sqlite3BinaryCompareCollSeq().
353898c527eSdrh ** However, if the OP_Commuted flag is set, then the order of the operands
354898c527eSdrh ** is reversed in the sqlite3BinaryCompareCollSeq() call so that the
355898c527eSdrh ** correct collating sequence is found.
356898c527eSdrh */
357898c527eSdrh CollSeq *sqlite3ExprCompareCollSeq(Parse *pParse, Expr *p){
358898c527eSdrh   if( ExprHasProperty(p, EP_Commuted) ){
359898c527eSdrh     return sqlite3BinaryCompareCollSeq(pParse, p->pRight, p->pLeft);
360898c527eSdrh   }else{
361898c527eSdrh     return sqlite3BinaryCompareCollSeq(pParse, p->pLeft, p->pRight);
362898c527eSdrh   }
363898c527eSdrh }
364898c527eSdrh 
3650202b29eSdanielk1977 /*
366be5c89acSdrh ** Generate code for a comparison operator.
367be5c89acSdrh */
368be5c89acSdrh static int codeCompare(
369be5c89acSdrh   Parse *pParse,    /* The parsing (and code generating) context */
370be5c89acSdrh   Expr *pLeft,      /* The left operand */
371be5c89acSdrh   Expr *pRight,     /* The right operand */
372be5c89acSdrh   int opcode,       /* The comparison opcode */
37335573356Sdrh   int in1, int in2, /* Register holding operands */
374be5c89acSdrh   int dest,         /* Jump here if true.  */
375898c527eSdrh   int jumpIfNull,   /* If true, jump if either operand is NULL */
376898c527eSdrh   int isCommuted    /* The comparison has been commuted */
377be5c89acSdrh ){
37835573356Sdrh   int p5;
37935573356Sdrh   int addr;
38035573356Sdrh   CollSeq *p4;
38135573356Sdrh 
382898c527eSdrh   if( isCommuted ){
383898c527eSdrh     p4 = sqlite3BinaryCompareCollSeq(pParse, pRight, pLeft);
384898c527eSdrh   }else{
38535573356Sdrh     p4 = sqlite3BinaryCompareCollSeq(pParse, pLeft, pRight);
386898c527eSdrh   }
38735573356Sdrh   p5 = binaryCompareP5(pLeft, pRight, jumpIfNull);
38835573356Sdrh   addr = sqlite3VdbeAddOp4(pParse->pVdbe, opcode, in2, dest, in1,
38935573356Sdrh                            (void*)p4, P4_COLLSEQ);
3901bd10f8aSdrh   sqlite3VdbeChangeP5(pParse->pVdbe, (u8)p5);
39135573356Sdrh   return addr;
392be5c89acSdrh }
393be5c89acSdrh 
394cfbb5e82Sdan /*
395870a0705Sdan ** Return true if expression pExpr is a vector, or false otherwise.
396d832da7fSdrh **
397d832da7fSdrh ** A vector is defined as any expression that results in two or more
398d832da7fSdrh ** columns of result.  Every TK_VECTOR node is an vector because the
399d832da7fSdrh ** parser will not generate a TK_VECTOR with fewer than two entries.
400d832da7fSdrh ** But a TK_SELECT might be either a vector or a scalar. It is only
401d832da7fSdrh ** considered a vector if it has two or more result columns.
402870a0705Sdan */
403870a0705Sdan int sqlite3ExprIsVector(Expr *pExpr){
40476dbe7a8Sdrh   return sqlite3ExprVectorSize(pExpr)>1;
405870a0705Sdan }
406870a0705Sdan 
407870a0705Sdan /*
408cfbb5e82Sdan ** If the expression passed as the only argument is of type TK_VECTOR
409cfbb5e82Sdan ** return the number of expressions in the vector. Or, if the expression
410cfbb5e82Sdan ** is a sub-select, return the number of columns in the sub-select. For
411cfbb5e82Sdan ** any other type of expression, return 1.
412cfbb5e82Sdan */
41371c57db0Sdan int sqlite3ExprVectorSize(Expr *pExpr){
41412abf408Sdrh   u8 op = pExpr->op;
41512abf408Sdrh   if( op==TK_REGISTER ) op = pExpr->op2;
41612abf408Sdrh   if( op==TK_VECTOR ){
41771c57db0Sdan     return pExpr->x.pList->nExpr;
41812abf408Sdrh   }else if( op==TK_SELECT ){
41976dbe7a8Sdrh     return pExpr->x.pSelect->pEList->nExpr;
42076dbe7a8Sdrh   }else{
42176dbe7a8Sdrh     return 1;
42276dbe7a8Sdrh   }
42371c57db0Sdan }
42471c57db0Sdan 
425ba00e30aSdan /*
426fc7f27b9Sdrh ** Return a pointer to a subexpression of pVector that is the i-th
427fc7f27b9Sdrh ** column of the vector (numbered starting with 0).  The caller must
428fc7f27b9Sdrh ** ensure that i is within range.
429fc7f27b9Sdrh **
43076dbe7a8Sdrh ** If pVector is really a scalar (and "scalar" here includes subqueries
43176dbe7a8Sdrh ** that return a single column!) then return pVector unmodified.
43276dbe7a8Sdrh **
433fc7f27b9Sdrh ** pVector retains ownership of the returned subexpression.
434fc7f27b9Sdrh **
435fc7f27b9Sdrh ** If the vector is a (SELECT ...) then the expression returned is
43676dbe7a8Sdrh ** just the expression for the i-th term of the result set, and may
43776dbe7a8Sdrh ** not be ready for evaluation because the table cursor has not yet
43876dbe7a8Sdrh ** been positioned.
439ba00e30aSdan */
440fc7f27b9Sdrh Expr *sqlite3VectorFieldSubexpr(Expr *pVector, int i){
441870a0705Sdan   assert( i<sqlite3ExprVectorSize(pVector) );
442870a0705Sdan   if( sqlite3ExprIsVector(pVector) ){
4439f24b53dSdrh     assert( pVector->op2==0 || pVector->op==TK_REGISTER );
4449f24b53dSdrh     if( pVector->op==TK_SELECT || pVector->op2==TK_SELECT ){
44571c57db0Sdan       return pVector->x.pSelect->pEList->a[i].pExpr;
446870a0705Sdan     }else{
44771c57db0Sdan       return pVector->x.pList->a[i].pExpr;
44871c57db0Sdan     }
449870a0705Sdan   }
450870a0705Sdan   return pVector;
451870a0705Sdan }
452fc7f27b9Sdrh 
453fc7f27b9Sdrh /*
454fc7f27b9Sdrh ** Compute and return a new Expr object which when passed to
455fc7f27b9Sdrh ** sqlite3ExprCode() will generate all necessary code to compute
456fc7f27b9Sdrh ** the iField-th column of the vector expression pVector.
457fc7f27b9Sdrh **
4588762ec19Sdrh ** It is ok for pVector to be a scalar (as long as iField==0).
4598762ec19Sdrh ** In that case, this routine works like sqlite3ExprDup().
4608762ec19Sdrh **
461fc7f27b9Sdrh ** The caller owns the returned Expr object and is responsible for
462fc7f27b9Sdrh ** ensuring that the returned value eventually gets freed.
463fc7f27b9Sdrh **
4648762ec19Sdrh ** The caller retains ownership of pVector.  If pVector is a TK_SELECT,
465fad0e70cSdan ** then the returned object will reference pVector and so pVector must remain
4668762ec19Sdrh ** valid for the life of the returned object.  If pVector is a TK_VECTOR
4678762ec19Sdrh ** or a scalar expression, then it can be deleted as soon as this routine
46876dbe7a8Sdrh ** returns.
4698762ec19Sdrh **
4708762ec19Sdrh ** A trick to cause a TK_SELECT pVector to be deleted together with
4718762ec19Sdrh ** the returned Expr object is to attach the pVector to the pRight field
4728762ec19Sdrh ** of the returned TK_SELECT_COLUMN Expr object.
473fc7f27b9Sdrh */
474fc7f27b9Sdrh Expr *sqlite3ExprForVectorField(
475fc7f27b9Sdrh   Parse *pParse,       /* Parsing context */
476fc7f27b9Sdrh   Expr *pVector,       /* The vector.  List of expressions or a sub-SELECT */
477a1251bc4Sdrh   int iField           /* Which column of the vector to return */
478fc7f27b9Sdrh ){
479fc7f27b9Sdrh   Expr *pRet;
480a1251bc4Sdrh   if( pVector->op==TK_SELECT ){
481a1251bc4Sdrh     assert( pVector->flags & EP_xIsSelect );
482fc7f27b9Sdrh     /* The TK_SELECT_COLUMN Expr node:
483fc7f27b9Sdrh     **
484966e2911Sdrh     ** pLeft:           pVector containing TK_SELECT.  Not deleted.
4858762ec19Sdrh     ** pRight:          not used.  But recursively deleted.
486fc7f27b9Sdrh     ** iColumn:         Index of a column in pVector
487966e2911Sdrh     ** iTable:          0 or the number of columns on the LHS of an assignment
488fc7f27b9Sdrh     ** pLeft->iTable:   First in an array of register holding result, or 0
489fc7f27b9Sdrh     **                  if the result is not yet computed.
490fc7f27b9Sdrh     **
491fc7f27b9Sdrh     ** sqlite3ExprDelete() specifically skips the recursive delete of
492fc7f27b9Sdrh     ** pLeft on TK_SELECT_COLUMN nodes.  But pRight is followed, so pVector
4938762ec19Sdrh     ** can be attached to pRight to cause this node to take ownership of
4948762ec19Sdrh     ** pVector.  Typically there will be multiple TK_SELECT_COLUMN nodes
4958762ec19Sdrh     ** with the same pLeft pointer to the pVector, but only one of them
4968762ec19Sdrh     ** will own the pVector.
497fc7f27b9Sdrh     */
498abfd35eaSdrh     pRet = sqlite3PExpr(pParse, TK_SELECT_COLUMN, 0, 0);
4998bd0d58eSdrh     if( pRet ){
5008bd0d58eSdrh       pRet->iColumn = iField;
5018bd0d58eSdrh       pRet->pLeft = pVector;
5028bd0d58eSdrh     }
503fc7f27b9Sdrh     assert( pRet==0 || pRet->iTable==0 );
504fc7f27b9Sdrh   }else{
505a1251bc4Sdrh     if( pVector->op==TK_VECTOR ) pVector = pVector->x.pList->a[iField].pExpr;
506a1251bc4Sdrh     pRet = sqlite3ExprDup(pParse->db, pVector, 0);
507dfb5c963Sdan     sqlite3RenameTokenRemap(pParse, pRet, pVector);
508fc7f27b9Sdrh   }
509fc7f27b9Sdrh   return pRet;
510fc7f27b9Sdrh }
51171c57db0Sdan 
5125c288b92Sdan /*
5135c288b92Sdan ** If expression pExpr is of type TK_SELECT, generate code to evaluate
5145c288b92Sdan ** it. Return the register in which the result is stored (or, if the
5155c288b92Sdan ** sub-select returns more than one column, the first in an array
5165c288b92Sdan ** of registers in which the result is stored).
5175c288b92Sdan **
5185c288b92Sdan ** If pExpr is not a TK_SELECT expression, return 0.
5195c288b92Sdan */
5205c288b92Sdan static int exprCodeSubselect(Parse *pParse, Expr *pExpr){
5218da209b1Sdan   int reg = 0;
522f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
5235c288b92Sdan   if( pExpr->op==TK_SELECT ){
52485bcdce2Sdrh     reg = sqlite3CodeSubselect(pParse, pExpr);
5258da209b1Sdan   }
526f9b2e05cSdan #endif
5278da209b1Sdan   return reg;
5288da209b1Sdan }
5298da209b1Sdan 
5305c288b92Sdan /*
5315c288b92Sdan ** Argument pVector points to a vector expression - either a TK_VECTOR
532870a0705Sdan ** or TK_SELECT that returns more than one column. This function returns
533870a0705Sdan ** the register number of a register that contains the value of
534870a0705Sdan ** element iField of the vector.
535870a0705Sdan **
536870a0705Sdan ** If pVector is a TK_SELECT expression, then code for it must have
537870a0705Sdan ** already been generated using the exprCodeSubselect() routine. In this
538870a0705Sdan ** case parameter regSelect should be the first in an array of registers
539870a0705Sdan ** containing the results of the sub-select.
540870a0705Sdan **
541870a0705Sdan ** If pVector is of type TK_VECTOR, then code for the requested field
542870a0705Sdan ** is generated. In this case (*pRegFree) may be set to the number of
543870a0705Sdan ** a temporary register to be freed by the caller before returning.
5445c288b92Sdan **
5455c288b92Sdan ** Before returning, output parameter (*ppExpr) is set to point to the
5465c288b92Sdan ** Expr object corresponding to element iElem of the vector.
5475c288b92Sdan */
5485c288b92Sdan static int exprVectorRegister(
5495c288b92Sdan   Parse *pParse,                  /* Parse context */
5505c288b92Sdan   Expr *pVector,                  /* Vector to extract element from */
551870a0705Sdan   int iField,                     /* Field to extract from pVector */
5525c288b92Sdan   int regSelect,                  /* First in array of registers */
5535c288b92Sdan   Expr **ppExpr,                  /* OUT: Expression element */
5545c288b92Sdan   int *pRegFree                   /* OUT: Temp register to free */
5555c288b92Sdan ){
55612abf408Sdrh   u8 op = pVector->op;
557c1bcd9ccSdrh   assert( op==TK_VECTOR || op==TK_REGISTER || op==TK_SELECT );
55812abf408Sdrh   if( op==TK_REGISTER ){
55912abf408Sdrh     *ppExpr = sqlite3VectorFieldSubexpr(pVector, iField);
56012abf408Sdrh     return pVector->iTable+iField;
56112abf408Sdrh   }
56212abf408Sdrh   if( op==TK_SELECT ){
563870a0705Sdan     *ppExpr = pVector->x.pSelect->pEList->a[iField].pExpr;
564870a0705Sdan      return regSelect+iField;
5655c288b92Sdan   }
566870a0705Sdan   *ppExpr = pVector->x.pList->a[iField].pExpr;
5675c288b92Sdan   return sqlite3ExprCodeTemp(pParse, *ppExpr, pRegFree);
5685c288b92Sdan }
5695c288b92Sdan 
5705c288b92Sdan /*
5715c288b92Sdan ** Expression pExpr is a comparison between two vector values. Compute
57279752b6eSdrh ** the result of the comparison (1, 0, or NULL) and write that
57379752b6eSdrh ** result into register dest.
57479752b6eSdrh **
57579752b6eSdrh ** The caller must satisfy the following preconditions:
57679752b6eSdrh **
57779752b6eSdrh **    if pExpr->op==TK_IS:      op==TK_EQ and p5==SQLITE_NULLEQ
57879752b6eSdrh **    if pExpr->op==TK_ISNOT:   op==TK_NE and p5==SQLITE_NULLEQ
57979752b6eSdrh **    otherwise:                op==pExpr->op and p5==0
5805c288b92Sdan */
58179752b6eSdrh static void codeVectorCompare(
58279752b6eSdrh   Parse *pParse,        /* Code generator context */
58379752b6eSdrh   Expr *pExpr,          /* The comparison operation */
58479752b6eSdrh   int dest,             /* Write results into this register */
58579752b6eSdrh   u8 op,                /* Comparison operator */
58679752b6eSdrh   u8 p5                 /* SQLITE_NULLEQ or zero */
58779752b6eSdrh ){
58871c57db0Sdan   Vdbe *v = pParse->pVdbe;
58971c57db0Sdan   Expr *pLeft = pExpr->pLeft;
59071c57db0Sdan   Expr *pRight = pExpr->pRight;
59171c57db0Sdan   int nLeft = sqlite3ExprVectorSize(pLeft);
59271c57db0Sdan   int i;
59371c57db0Sdan   int regLeft = 0;
59471c57db0Sdan   int regRight = 0;
59579752b6eSdrh   u8 opx = op;
596ec4ccdbcSdrh   int addrDone = sqlite3VdbeMakeLabel(pParse);
597898c527eSdrh   int isCommuted = ExprHasProperty(pExpr,EP_Commuted);
59871c57db0Sdan 
599245ce62eSdrh   if( nLeft!=sqlite3ExprVectorSize(pRight) ){
600245ce62eSdrh     sqlite3ErrorMsg(pParse, "row value misused");
601245ce62eSdrh     return;
602245ce62eSdrh   }
60371c57db0Sdan   assert( pExpr->op==TK_EQ || pExpr->op==TK_NE
60471c57db0Sdan        || pExpr->op==TK_IS || pExpr->op==TK_ISNOT
60571c57db0Sdan        || pExpr->op==TK_LT || pExpr->op==TK_GT
60671c57db0Sdan        || pExpr->op==TK_LE || pExpr->op==TK_GE
60771c57db0Sdan   );
60879752b6eSdrh   assert( pExpr->op==op || (pExpr->op==TK_IS && op==TK_EQ)
60979752b6eSdrh             || (pExpr->op==TK_ISNOT && op==TK_NE) );
61079752b6eSdrh   assert( p5==0 || pExpr->op!=op );
61179752b6eSdrh   assert( p5==SQLITE_NULLEQ || pExpr->op==op );
61271c57db0Sdan 
61379752b6eSdrh   p5 |= SQLITE_STOREP2;
61479752b6eSdrh   if( opx==TK_LE ) opx = TK_LT;
61579752b6eSdrh   if( opx==TK_GE ) opx = TK_GT;
6165c288b92Sdan 
6175c288b92Sdan   regLeft = exprCodeSubselect(pParse, pLeft);
6185c288b92Sdan   regRight = exprCodeSubselect(pParse, pRight);
6195c288b92Sdan 
620321e828dSdrh   for(i=0; 1 /*Loop exits by "break"*/; i++){
6215c288b92Sdan     int regFree1 = 0, regFree2 = 0;
6225c288b92Sdan     Expr *pL, *pR;
6235c288b92Sdan     int r1, r2;
624321e828dSdrh     assert( i>=0 && i<nLeft );
6255c288b92Sdan     r1 = exprVectorRegister(pParse, pLeft, i, regLeft, &pL, &regFree1);
6265c288b92Sdan     r2 = exprVectorRegister(pParse, pRight, i, regRight, &pR, &regFree2);
627898c527eSdrh     codeCompare(pParse, pL, pR, opx, r1, r2, dest, p5, isCommuted);
62879752b6eSdrh     testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
62979752b6eSdrh     testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
63079752b6eSdrh     testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
63179752b6eSdrh     testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
63279752b6eSdrh     testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
63379752b6eSdrh     testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
63471c57db0Sdan     sqlite3ReleaseTempReg(pParse, regFree1);
63571c57db0Sdan     sqlite3ReleaseTempReg(pParse, regFree2);
63679752b6eSdrh     if( i==nLeft-1 ){
63779752b6eSdrh       break;
63871c57db0Sdan     }
63979752b6eSdrh     if( opx==TK_EQ ){
64079752b6eSdrh       sqlite3VdbeAddOp2(v, OP_IfNot, dest, addrDone); VdbeCoverage(v);
64179752b6eSdrh       p5 |= SQLITE_KEEPNULL;
64279752b6eSdrh     }else if( opx==TK_NE ){
64379752b6eSdrh       sqlite3VdbeAddOp2(v, OP_If, dest, addrDone); VdbeCoverage(v);
64479752b6eSdrh       p5 |= SQLITE_KEEPNULL;
645a2f62925Sdrh     }else{
646a2f62925Sdrh       assert( op==TK_LT || op==TK_GT || op==TK_LE || op==TK_GE );
647a2f62925Sdrh       sqlite3VdbeAddOp2(v, OP_ElseNotEq, 0, addrDone);
64879752b6eSdrh       VdbeCoverageIf(v, op==TK_LT);
64979752b6eSdrh       VdbeCoverageIf(v, op==TK_GT);
65079752b6eSdrh       VdbeCoverageIf(v, op==TK_LE);
65179752b6eSdrh       VdbeCoverageIf(v, op==TK_GE);
65279752b6eSdrh       if( i==nLeft-2 ) opx = op;
65371c57db0Sdan     }
65479752b6eSdrh   }
65579752b6eSdrh   sqlite3VdbeResolveLabel(v, addrDone);
65679752b6eSdrh }
65771c57db0Sdan 
6584b5255acSdanielk1977 #if SQLITE_MAX_EXPR_DEPTH>0
6594b5255acSdanielk1977 /*
6604b5255acSdanielk1977 ** Check that argument nHeight is less than or equal to the maximum
6614b5255acSdanielk1977 ** expression depth allowed. If it is not, leave an error message in
6624b5255acSdanielk1977 ** pParse.
6634b5255acSdanielk1977 */
6647d10d5a6Sdrh int sqlite3ExprCheckHeight(Parse *pParse, int nHeight){
6654b5255acSdanielk1977   int rc = SQLITE_OK;
6664b5255acSdanielk1977   int mxHeight = pParse->db->aLimit[SQLITE_LIMIT_EXPR_DEPTH];
6674b5255acSdanielk1977   if( nHeight>mxHeight ){
6684b5255acSdanielk1977     sqlite3ErrorMsg(pParse,
6694b5255acSdanielk1977        "Expression tree is too large (maximum depth %d)", mxHeight
6704b5255acSdanielk1977     );
6714b5255acSdanielk1977     rc = SQLITE_ERROR;
6724b5255acSdanielk1977   }
6734b5255acSdanielk1977   return rc;
6744b5255acSdanielk1977 }
6754b5255acSdanielk1977 
6764b5255acSdanielk1977 /* The following three functions, heightOfExpr(), heightOfExprList()
6774b5255acSdanielk1977 ** and heightOfSelect(), are used to determine the maximum height
6784b5255acSdanielk1977 ** of any expression tree referenced by the structure passed as the
6794b5255acSdanielk1977 ** first argument.
6804b5255acSdanielk1977 **
6814b5255acSdanielk1977 ** If this maximum height is greater than the current value pointed
6824b5255acSdanielk1977 ** to by pnHeight, the second parameter, then set *pnHeight to that
6834b5255acSdanielk1977 ** value.
6844b5255acSdanielk1977 */
6854b5255acSdanielk1977 static void heightOfExpr(Expr *p, int *pnHeight){
6864b5255acSdanielk1977   if( p ){
6874b5255acSdanielk1977     if( p->nHeight>*pnHeight ){
6884b5255acSdanielk1977       *pnHeight = p->nHeight;
6894b5255acSdanielk1977     }
6904b5255acSdanielk1977   }
6914b5255acSdanielk1977 }
6924b5255acSdanielk1977 static void heightOfExprList(ExprList *p, int *pnHeight){
6934b5255acSdanielk1977   if( p ){
6944b5255acSdanielk1977     int i;
6954b5255acSdanielk1977     for(i=0; i<p->nExpr; i++){
6964b5255acSdanielk1977       heightOfExpr(p->a[i].pExpr, pnHeight);
6974b5255acSdanielk1977     }
6984b5255acSdanielk1977   }
6994b5255acSdanielk1977 }
7001a3a3086Sdan static void heightOfSelect(Select *pSelect, int *pnHeight){
7011a3a3086Sdan   Select *p;
7021a3a3086Sdan   for(p=pSelect; p; p=p->pPrior){
7034b5255acSdanielk1977     heightOfExpr(p->pWhere, pnHeight);
7044b5255acSdanielk1977     heightOfExpr(p->pHaving, pnHeight);
7054b5255acSdanielk1977     heightOfExpr(p->pLimit, pnHeight);
7064b5255acSdanielk1977     heightOfExprList(p->pEList, pnHeight);
7074b5255acSdanielk1977     heightOfExprList(p->pGroupBy, pnHeight);
7084b5255acSdanielk1977     heightOfExprList(p->pOrderBy, pnHeight);
7094b5255acSdanielk1977   }
7104b5255acSdanielk1977 }
7114b5255acSdanielk1977 
7124b5255acSdanielk1977 /*
7134b5255acSdanielk1977 ** Set the Expr.nHeight variable in the structure passed as an
7144b5255acSdanielk1977 ** argument. An expression with no children, Expr.pList or
7154b5255acSdanielk1977 ** Expr.pSelect member has a height of 1. Any other expression
7164b5255acSdanielk1977 ** has a height equal to the maximum height of any other
7174b5255acSdanielk1977 ** referenced Expr plus one.
7182308ed38Sdrh **
7192308ed38Sdrh ** Also propagate EP_Propagate flags up from Expr.x.pList to Expr.flags,
7202308ed38Sdrh ** if appropriate.
7214b5255acSdanielk1977 */
7224b5255acSdanielk1977 static void exprSetHeight(Expr *p){
7234b5255acSdanielk1977   int nHeight = 0;
7244b5255acSdanielk1977   heightOfExpr(p->pLeft, &nHeight);
7254b5255acSdanielk1977   heightOfExpr(p->pRight, &nHeight);
7266ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_xIsSelect) ){
7276ab3a2ecSdanielk1977     heightOfSelect(p->x.pSelect, &nHeight);
7282308ed38Sdrh   }else if( p->x.pList ){
7296ab3a2ecSdanielk1977     heightOfExprList(p->x.pList, &nHeight);
7302308ed38Sdrh     p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
7316ab3a2ecSdanielk1977   }
7324b5255acSdanielk1977   p->nHeight = nHeight + 1;
7334b5255acSdanielk1977 }
7344b5255acSdanielk1977 
7354b5255acSdanielk1977 /*
7364b5255acSdanielk1977 ** Set the Expr.nHeight variable using the exprSetHeight() function. If
7374b5255acSdanielk1977 ** the height is greater than the maximum allowed expression depth,
7384b5255acSdanielk1977 ** leave an error in pParse.
7392308ed38Sdrh **
7402308ed38Sdrh ** Also propagate all EP_Propagate flags from the Expr.x.pList into
7412308ed38Sdrh ** Expr.flags.
7424b5255acSdanielk1977 */
7432308ed38Sdrh void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
74474893a4cSdrh   if( pParse->nErr ) return;
7454b5255acSdanielk1977   exprSetHeight(p);
7467d10d5a6Sdrh   sqlite3ExprCheckHeight(pParse, p->nHeight);
7474b5255acSdanielk1977 }
7484b5255acSdanielk1977 
7494b5255acSdanielk1977 /*
7504b5255acSdanielk1977 ** Return the maximum height of any expression tree referenced
7514b5255acSdanielk1977 ** by the select statement passed as an argument.
7524b5255acSdanielk1977 */
7534b5255acSdanielk1977 int sqlite3SelectExprHeight(Select *p){
7544b5255acSdanielk1977   int nHeight = 0;
7554b5255acSdanielk1977   heightOfSelect(p, &nHeight);
7564b5255acSdanielk1977   return nHeight;
7574b5255acSdanielk1977 }
7582308ed38Sdrh #else /* ABOVE:  Height enforcement enabled.  BELOW: Height enforcement off */
7592308ed38Sdrh /*
7602308ed38Sdrh ** Propagate all EP_Propagate flags from the Expr.x.pList into
7612308ed38Sdrh ** Expr.flags.
7622308ed38Sdrh */
7632308ed38Sdrh void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
7642308ed38Sdrh   if( p && p->x.pList && !ExprHasProperty(p, EP_xIsSelect) ){
7652308ed38Sdrh     p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
7662308ed38Sdrh   }
7672308ed38Sdrh }
7684b5255acSdanielk1977 #define exprSetHeight(y)
7694b5255acSdanielk1977 #endif /* SQLITE_MAX_EXPR_DEPTH>0 */
7704b5255acSdanielk1977 
771be5c89acSdrh /*
772b7916a78Sdrh ** This routine is the core allocator for Expr nodes.
773b7916a78Sdrh **
774a76b5dfcSdrh ** Construct a new expression node and return a pointer to it.  Memory
775b7916a78Sdrh ** for this node and for the pToken argument is a single allocation
776b7916a78Sdrh ** obtained from sqlite3DbMalloc().  The calling function
777a76b5dfcSdrh ** is responsible for making sure the node eventually gets freed.
778b7916a78Sdrh **
779b7916a78Sdrh ** If dequote is true, then the token (if it exists) is dequoted.
780e792b5b4Sdrh ** If dequote is false, no dequoting is performed.  The deQuote
781b7916a78Sdrh ** parameter is ignored if pToken is NULL or if the token does not
782b7916a78Sdrh ** appear to be quoted.  If the quotes were of the form "..." (double-quotes)
783b7916a78Sdrh ** then the EP_DblQuoted flag is set on the expression node.
78433e619fcSdrh **
78533e619fcSdrh ** Special case:  If op==TK_INTEGER and pToken points to a string that
78633e619fcSdrh ** can be translated into a 32-bit integer, then the token is not
78733e619fcSdrh ** stored in u.zToken.  Instead, the integer values is written
78833e619fcSdrh ** into u.iValue and the EP_IntValue flag is set.  No extra storage
78933e619fcSdrh ** is allocated to hold the integer text and the dequote flag is ignored.
790a76b5dfcSdrh */
791b7916a78Sdrh Expr *sqlite3ExprAlloc(
792cca8a4adSdrh   sqlite3 *db,            /* Handle for sqlite3DbMallocRawNN() */
79317435752Sdrh   int op,                 /* Expression opcode */
794b7916a78Sdrh   const Token *pToken,    /* Token argument.  Might be NULL */
795b7916a78Sdrh   int dequote             /* True to dequote */
79617435752Sdrh ){
797a76b5dfcSdrh   Expr *pNew;
79833e619fcSdrh   int nExtra = 0;
799cf697396Sshane   int iValue = 0;
800b7916a78Sdrh 
801575fad65Sdrh   assert( db!=0 );
802b7916a78Sdrh   if( pToken ){
80333e619fcSdrh     if( op!=TK_INTEGER || pToken->z==0
80433e619fcSdrh           || sqlite3GetInt32(pToken->z, &iValue)==0 ){
805b7916a78Sdrh       nExtra = pToken->n+1;
806d50ffc41Sdrh       assert( iValue>=0 );
80733e619fcSdrh     }
808a76b5dfcSdrh   }
809575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, sizeof(Expr)+nExtra);
810b7916a78Sdrh   if( pNew ){
811ca3862dcSdrh     memset(pNew, 0, sizeof(Expr));
8121bd10f8aSdrh     pNew->op = (u8)op;
813a58fdfb1Sdanielk1977     pNew->iAgg = -1;
814a76b5dfcSdrh     if( pToken ){
81533e619fcSdrh       if( nExtra==0 ){
816ad31727fSdrh         pNew->flags |= EP_IntValue|EP_Leaf|(iValue?EP_IsTrue:EP_IsFalse);
81733e619fcSdrh         pNew->u.iValue = iValue;
81833e619fcSdrh       }else{
81933e619fcSdrh         pNew->u.zToken = (char*)&pNew[1];
820b07028f7Sdrh         assert( pToken->z!=0 || pToken->n==0 );
821b07028f7Sdrh         if( pToken->n ) memcpy(pNew->u.zToken, pToken->z, pToken->n);
82233e619fcSdrh         pNew->u.zToken[pToken->n] = 0;
823244b9d6eSdrh         if( dequote && sqlite3Isquote(pNew->u.zToken[0]) ){
82451d35b0fSdrh           sqlite3DequoteExpr(pNew);
825a34001c9Sdrh         }
826a34001c9Sdrh       }
82733e619fcSdrh     }
828b7916a78Sdrh #if SQLITE_MAX_EXPR_DEPTH>0
829b7916a78Sdrh     pNew->nHeight = 1;
830b7916a78Sdrh #endif
831a34001c9Sdrh   }
832a76b5dfcSdrh   return pNew;
833a76b5dfcSdrh }
834a76b5dfcSdrh 
835a76b5dfcSdrh /*
836b7916a78Sdrh ** Allocate a new expression node from a zero-terminated token that has
837b7916a78Sdrh ** already been dequoted.
838b7916a78Sdrh */
839b7916a78Sdrh Expr *sqlite3Expr(
840b7916a78Sdrh   sqlite3 *db,            /* Handle for sqlite3DbMallocZero() (may be null) */
841b7916a78Sdrh   int op,                 /* Expression opcode */
842b7916a78Sdrh   const char *zToken      /* Token argument.  Might be NULL */
843b7916a78Sdrh ){
844b7916a78Sdrh   Token x;
845b7916a78Sdrh   x.z = zToken;
846b40f06c6Sdrh   x.n = sqlite3Strlen30(zToken);
847b7916a78Sdrh   return sqlite3ExprAlloc(db, op, &x, 0);
848b7916a78Sdrh }
849b7916a78Sdrh 
850b7916a78Sdrh /*
851b7916a78Sdrh ** Attach subtrees pLeft and pRight to the Expr node pRoot.
852b7916a78Sdrh **
853b7916a78Sdrh ** If pRoot==NULL that means that a memory allocation error has occurred.
854b7916a78Sdrh ** In that case, delete the subtrees pLeft and pRight.
855b7916a78Sdrh */
856b7916a78Sdrh void sqlite3ExprAttachSubtrees(
857b7916a78Sdrh   sqlite3 *db,
858b7916a78Sdrh   Expr *pRoot,
859b7916a78Sdrh   Expr *pLeft,
860b7916a78Sdrh   Expr *pRight
861b7916a78Sdrh ){
862b7916a78Sdrh   if( pRoot==0 ){
863b7916a78Sdrh     assert( db->mallocFailed );
864b7916a78Sdrh     sqlite3ExprDelete(db, pLeft);
865b7916a78Sdrh     sqlite3ExprDelete(db, pRight);
866b7916a78Sdrh   }else{
867b7916a78Sdrh     if( pRight ){
868b7916a78Sdrh       pRoot->pRight = pRight;
869885a5b03Sdrh       pRoot->flags |= EP_Propagate & pRight->flags;
870b7916a78Sdrh     }
871b7916a78Sdrh     if( pLeft ){
872b7916a78Sdrh       pRoot->pLeft = pLeft;
873885a5b03Sdrh       pRoot->flags |= EP_Propagate & pLeft->flags;
874b7916a78Sdrh     }
875b7916a78Sdrh     exprSetHeight(pRoot);
876b7916a78Sdrh   }
877b7916a78Sdrh }
878b7916a78Sdrh 
879b7916a78Sdrh /*
88060ec914cSpeter.d.reid ** Allocate an Expr node which joins as many as two subtrees.
881b7916a78Sdrh **
882bf664469Sdrh ** One or both of the subtrees can be NULL.  Return a pointer to the new
883bf664469Sdrh ** Expr node.  Or, if an OOM error occurs, set pParse->db->mallocFailed,
884bf664469Sdrh ** free the subtrees and return NULL.
885206f3d96Sdrh */
88617435752Sdrh Expr *sqlite3PExpr(
88717435752Sdrh   Parse *pParse,          /* Parsing context */
88817435752Sdrh   int op,                 /* Expression opcode */
88917435752Sdrh   Expr *pLeft,            /* Left operand */
890abfd35eaSdrh   Expr *pRight            /* Right operand */
89117435752Sdrh ){
8925fb52caaSdrh   Expr *p;
893abfd35eaSdrh   p = sqlite3DbMallocRawNN(pParse->db, sizeof(Expr));
894abfd35eaSdrh   if( p ){
895abfd35eaSdrh     memset(p, 0, sizeof(Expr));
896f1722baaSdrh     p->op = op & 0xff;
897abfd35eaSdrh     p->iAgg = -1;
898b7916a78Sdrh     sqlite3ExprAttachSubtrees(pParse->db, p, pLeft, pRight);
8992b359bdbSdan     sqlite3ExprCheckHeight(pParse, p->nHeight);
900d5c851c1Sdrh   }else{
901d5c851c1Sdrh     sqlite3ExprDelete(pParse->db, pLeft);
902d5c851c1Sdrh     sqlite3ExprDelete(pParse->db, pRight);
9032b359bdbSdan   }
9044e0cff60Sdrh   return p;
9054e0cff60Sdrh }
9064e0cff60Sdrh 
9074e0cff60Sdrh /*
90808de4f79Sdrh ** Add pSelect to the Expr.x.pSelect field.  Or, if pExpr is NULL (due
90908de4f79Sdrh ** do a memory allocation failure) then delete the pSelect object.
91008de4f79Sdrh */
91108de4f79Sdrh void sqlite3PExprAddSelect(Parse *pParse, Expr *pExpr, Select *pSelect){
91208de4f79Sdrh   if( pExpr ){
91308de4f79Sdrh     pExpr->x.pSelect = pSelect;
91408de4f79Sdrh     ExprSetProperty(pExpr, EP_xIsSelect|EP_Subquery);
91508de4f79Sdrh     sqlite3ExprSetHeightAndFlags(pParse, pExpr);
91608de4f79Sdrh   }else{
91708de4f79Sdrh     assert( pParse->db->mallocFailed );
91808de4f79Sdrh     sqlite3SelectDelete(pParse->db, pSelect);
91908de4f79Sdrh   }
92008de4f79Sdrh }
92108de4f79Sdrh 
92208de4f79Sdrh 
92308de4f79Sdrh /*
92491bb0eedSdrh ** Join two expressions using an AND operator.  If either expression is
92591bb0eedSdrh ** NULL, then just return the other expression.
9265fb52caaSdrh **
9275fb52caaSdrh ** If one side or the other of the AND is known to be false, then instead
9285fb52caaSdrh ** of returning an AND expression, just return a constant expression with
9295fb52caaSdrh ** a value of false.
93091bb0eedSdrh */
931d5c851c1Sdrh Expr *sqlite3ExprAnd(Parse *pParse, Expr *pLeft, Expr *pRight){
932d5c851c1Sdrh   sqlite3 *db = pParse->db;
93391bb0eedSdrh   if( pLeft==0  ){
93491bb0eedSdrh     return pRight;
93591bb0eedSdrh   }else if( pRight==0 ){
93691bb0eedSdrh     return pLeft;
937ad31727fSdrh   }else if( ExprAlwaysFalse(pLeft) || ExprAlwaysFalse(pRight) ){
9388e34e406Sdrh     sqlite3ExprUnmapAndDelete(pParse, pLeft);
9398e34e406Sdrh     sqlite3ExprUnmapAndDelete(pParse, pRight);
9405776ee5cSdrh     return sqlite3Expr(db, TK_INTEGER, "0");
94191bb0eedSdrh   }else{
942d5c851c1Sdrh     return sqlite3PExpr(pParse, TK_AND, pLeft, pRight);
943a76b5dfcSdrh   }
944a76b5dfcSdrh }
945a76b5dfcSdrh 
946a76b5dfcSdrh /*
947a76b5dfcSdrh ** Construct a new expression node for a function with multiple
948a76b5dfcSdrh ** arguments.
949a76b5dfcSdrh */
950954733b3Sdrh Expr *sqlite3ExprFunction(
951954733b3Sdrh   Parse *pParse,        /* Parsing context */
952954733b3Sdrh   ExprList *pList,      /* Argument list */
953954733b3Sdrh   Token *pToken,        /* Name of the function */
954954733b3Sdrh   int eDistinct         /* SF_Distinct or SF_ALL or 0 */
955954733b3Sdrh ){
956a76b5dfcSdrh   Expr *pNew;
957633e6d57Sdrh   sqlite3 *db = pParse->db;
9584b202ae2Sdanielk1977   assert( pToken );
959b7916a78Sdrh   pNew = sqlite3ExprAlloc(db, TK_FUNCTION, pToken, 1);
960a76b5dfcSdrh   if( pNew==0 ){
961d9da78a2Sdrh     sqlite3ExprListDelete(db, pList); /* Avoid memory leak when malloc fails */
962a76b5dfcSdrh     return 0;
963a76b5dfcSdrh   }
964954733b3Sdrh   if( pList && pList->nExpr > pParse->db->aLimit[SQLITE_LIMIT_FUNCTION_ARG] ){
965954733b3Sdrh     sqlite3ErrorMsg(pParse, "too many arguments on function %T", pToken);
966954733b3Sdrh   }
9676ab3a2ecSdanielk1977   pNew->x.pList = pList;
968fca23557Sdrh   ExprSetProperty(pNew, EP_HasFunc);
9696ab3a2ecSdanielk1977   assert( !ExprHasProperty(pNew, EP_xIsSelect) );
9702308ed38Sdrh   sqlite3ExprSetHeightAndFlags(pParse, pNew);
971954733b3Sdrh   if( eDistinct==SF_Distinct ) ExprSetProperty(pNew, EP_Distinct);
972a76b5dfcSdrh   return pNew;
973a76b5dfcSdrh }
974a76b5dfcSdrh 
975a76b5dfcSdrh /*
976fa6bc000Sdrh ** Assign a variable number to an expression that encodes a wildcard
977fa6bc000Sdrh ** in the original SQL statement.
978fa6bc000Sdrh **
979fa6bc000Sdrh ** Wildcards consisting of a single "?" are assigned the next sequential
980fa6bc000Sdrh ** variable number.
981fa6bc000Sdrh **
982fa6bc000Sdrh ** Wildcards of the form "?nnn" are assigned the number "nnn".  We make
9839bf755ccSdrh ** sure "nnn" is not too big to avoid a denial of service attack when
984fa6bc000Sdrh ** the SQL statement comes from an external source.
985fa6bc000Sdrh **
98651f49f17Sdrh ** Wildcards of the form ":aaa", "@aaa", or "$aaa" are assigned the same number
987fa6bc000Sdrh ** as the previous instance of the same wildcard.  Or if this is the first
98860ec914cSpeter.d.reid ** instance of the wildcard, the next sequential variable number is
989fa6bc000Sdrh ** assigned.
990fa6bc000Sdrh */
991de25a88cSdrh void sqlite3ExprAssignVarNumber(Parse *pParse, Expr *pExpr, u32 n){
99217435752Sdrh   sqlite3 *db = pParse->db;
993b7916a78Sdrh   const char *z;
994f326d66dSdrh   ynVar x;
99517435752Sdrh 
996fa6bc000Sdrh   if( pExpr==0 ) return;
997c5cd1249Sdrh   assert( !ExprHasProperty(pExpr, EP_IntValue|EP_Reduced|EP_TokenOnly) );
99833e619fcSdrh   z = pExpr->u.zToken;
999b7916a78Sdrh   assert( z!=0 );
1000b7916a78Sdrh   assert( z[0]!=0 );
1001b1ed717fSmistachkin   assert( n==(u32)sqlite3Strlen30(z) );
1002b7916a78Sdrh   if( z[1]==0 ){
1003fa6bc000Sdrh     /* Wildcard of the form "?".  Assign the next variable number */
1004b7916a78Sdrh     assert( z[0]=='?' );
1005f326d66dSdrh     x = (ynVar)(++pParse->nVar);
1006124c0b49Sdrh   }else{
1007f326d66dSdrh     int doAdd = 0;
1008124c0b49Sdrh     if( z[0]=='?' ){
1009fa6bc000Sdrh       /* Wildcard of the form "?nnn".  Convert "nnn" to an integer and
1010fa6bc000Sdrh       ** use it as the variable number */
1011c8d735aeSdan       i64 i;
101218814dfbSdrh       int bOk;
101318814dfbSdrh       if( n==2 ){ /*OPTIMIZATION-IF-TRUE*/
101418814dfbSdrh         i = z[1]-'0';  /* The common case of ?N for a single digit N */
101518814dfbSdrh         bOk = 1;
101618814dfbSdrh       }else{
101718814dfbSdrh         bOk = 0==sqlite3Atoi64(&z[1], &i, n-1, SQLITE_UTF8);
101818814dfbSdrh       }
1019c5499befSdrh       testcase( i==0 );
1020c5499befSdrh       testcase( i==1 );
1021c5499befSdrh       testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]-1 );
1022c5499befSdrh       testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] );
1023c8d735aeSdan       if( bOk==0 || i<1 || i>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
1024fa6bc000Sdrh         sqlite3ErrorMsg(pParse, "variable number must be between ?1 and ?%d",
1025bb4957f8Sdrh             db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]);
1026c9b39288Sdrh         return;
1027fa6bc000Sdrh       }
10288e74e7baSdrh       x = (ynVar)i;
1029f326d66dSdrh       if( x>pParse->nVar ){
1030f326d66dSdrh         pParse->nVar = (int)x;
1031f326d66dSdrh         doAdd = 1;
1032f326d66dSdrh       }else if( sqlite3VListNumToName(pParse->pVList, x)==0 ){
1033f326d66dSdrh         doAdd = 1;
1034fa6bc000Sdrh       }
1035fa6bc000Sdrh     }else{
103651f49f17Sdrh       /* Wildcards like ":aaa", "$aaa" or "@aaa".  Reuse the same variable
1037fa6bc000Sdrh       ** number as the prior appearance of the same name, or if the name
1038fa6bc000Sdrh       ** has never appeared before, reuse the same variable number
1039fa6bc000Sdrh       */
10409bf755ccSdrh       x = (ynVar)sqlite3VListNameToNum(pParse->pVList, z, n);
10419bf755ccSdrh       if( x==0 ){
10429bf755ccSdrh         x = (ynVar)(++pParse->nVar);
1043f326d66dSdrh         doAdd = 1;
1044f326d66dSdrh       }
1045f326d66dSdrh     }
1046f326d66dSdrh     if( doAdd ){
10479bf755ccSdrh       pParse->pVList = sqlite3VListAdd(db, pParse->pVList, z, n, x);
1048fa6bc000Sdrh     }
1049fa6bc000Sdrh   }
1050c9b39288Sdrh   pExpr->iColumn = x;
1051f326d66dSdrh   if( x>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
1052832b2664Sdanielk1977     sqlite3ErrorMsg(pParse, "too many SQL variables");
1053832b2664Sdanielk1977   }
1054fa6bc000Sdrh }
1055fa6bc000Sdrh 
1056fa6bc000Sdrh /*
1057f6963f99Sdan ** Recursively delete an expression tree.
1058a2e00042Sdrh */
10594f0010b1Sdrh static SQLITE_NOINLINE void sqlite3ExprDeleteNN(sqlite3 *db, Expr *p){
10604f0010b1Sdrh   assert( p!=0 );
1061d50ffc41Sdrh   /* Sanity check: Assert that the IntValue is non-negative if it exists */
1062d50ffc41Sdrh   assert( !ExprHasProperty(p, EP_IntValue) || p->u.iValue>=0 );
1063eda079cdSdrh 
1064eda079cdSdrh   assert( !ExprHasProperty(p, EP_WinFunc) || p->y.pWin!=0 || db->mallocFailed );
1065eda079cdSdrh   assert( p->op!=TK_FUNCTION || ExprHasProperty(p, EP_TokenOnly|EP_Reduced)
10664f9adee2Sdan           || p->y.pWin==0 || ExprHasProperty(p, EP_WinFunc) );
1067209bc522Sdrh #ifdef SQLITE_DEBUG
1068209bc522Sdrh   if( ExprHasProperty(p, EP_Leaf) && !ExprHasProperty(p, EP_TokenOnly) ){
1069209bc522Sdrh     assert( p->pLeft==0 );
1070209bc522Sdrh     assert( p->pRight==0 );
1071209bc522Sdrh     assert( p->x.pSelect==0 );
1072209bc522Sdrh   }
1073209bc522Sdrh #endif
1074209bc522Sdrh   if( !ExprHasProperty(p, (EP_TokenOnly|EP_Leaf)) ){
1075c5cd1249Sdrh     /* The Expr.x union is never used at the same time as Expr.pRight */
1076c5cd1249Sdrh     assert( p->x.pList==0 || p->pRight==0 );
10774910a76dSdrh     if( p->pLeft && p->op!=TK_SELECT_COLUMN ) sqlite3ExprDeleteNN(db, p->pLeft);
1078d1086679Sdrh     if( p->pRight ){
10794f9adee2Sdan       assert( !ExprHasProperty(p, EP_WinFunc) );
1080d1086679Sdrh       sqlite3ExprDeleteNN(db, p->pRight);
1081d1086679Sdrh     }else if( ExprHasProperty(p, EP_xIsSelect) ){
10824f9adee2Sdan       assert( !ExprHasProperty(p, EP_WinFunc) );
10836ab3a2ecSdanielk1977       sqlite3SelectDelete(db, p->x.pSelect);
10846ab3a2ecSdanielk1977     }else{
10856ab3a2ecSdanielk1977       sqlite3ExprListDelete(db, p->x.pList);
10866ba7ab0dSdan #ifndef SQLITE_OMIT_WINDOWFUNC
1087eda079cdSdrh       if( ExprHasProperty(p, EP_WinFunc) ){
1088eda079cdSdrh         sqlite3WindowDelete(db, p->y.pWin);
108986fb6e17Sdan       }
10906ba7ab0dSdan #endif
10916ab3a2ecSdanielk1977     }
10928117f113Sdan   }
1093209bc522Sdrh   if( ExprHasProperty(p, EP_MemToken) ) sqlite3DbFree(db, p->u.zToken);
109433e619fcSdrh   if( !ExprHasProperty(p, EP_Static) ){
1095dbd6a7dcSdrh     sqlite3DbFreeNN(db, p);
1096a2e00042Sdrh   }
109733e619fcSdrh }
10984f0010b1Sdrh void sqlite3ExprDelete(sqlite3 *db, Expr *p){
10994f0010b1Sdrh   if( p ) sqlite3ExprDeleteNN(db, p);
11004f0010b1Sdrh }
1101a2e00042Sdrh 
11028e34e406Sdrh /* Invoke sqlite3RenameExprUnmap() and sqlite3ExprDelete() on the
11038e34e406Sdrh ** expression.
11048e34e406Sdrh */
11058e34e406Sdrh void sqlite3ExprUnmapAndDelete(Parse *pParse, Expr *p){
11068e34e406Sdrh   if( p ){
11078e34e406Sdrh     if( IN_RENAME_OBJECT ){
11088e34e406Sdrh       sqlite3RenameExprUnmap(pParse, p);
11098e34e406Sdrh     }
11108e34e406Sdrh     sqlite3ExprDeleteNN(pParse->db, p);
11118e34e406Sdrh   }
11128e34e406Sdrh }
11138e34e406Sdrh 
1114d2687b77Sdrh /*
11156ab3a2ecSdanielk1977 ** Return the number of bytes allocated for the expression structure
11166ab3a2ecSdanielk1977 ** passed as the first argument. This is always one of EXPR_FULLSIZE,
11176ab3a2ecSdanielk1977 ** EXPR_REDUCEDSIZE or EXPR_TOKENONLYSIZE.
11186ab3a2ecSdanielk1977 */
11196ab3a2ecSdanielk1977 static int exprStructSize(Expr *p){
11206ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_TokenOnly) ) return EXPR_TOKENONLYSIZE;
11216ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_Reduced) ) return EXPR_REDUCEDSIZE;
11226ab3a2ecSdanielk1977   return EXPR_FULLSIZE;
11236ab3a2ecSdanielk1977 }
11246ab3a2ecSdanielk1977 
11256ab3a2ecSdanielk1977 /*
112633e619fcSdrh ** The dupedExpr*Size() routines each return the number of bytes required
112733e619fcSdrh ** to store a copy of an expression or expression tree.  They differ in
112833e619fcSdrh ** how much of the tree is measured.
112933e619fcSdrh **
113033e619fcSdrh **     dupedExprStructSize()     Size of only the Expr structure
113133e619fcSdrh **     dupedExprNodeSize()       Size of Expr + space for token
113233e619fcSdrh **     dupedExprSize()           Expr + token + subtree components
113333e619fcSdrh **
113433e619fcSdrh ***************************************************************************
113533e619fcSdrh **
113633e619fcSdrh ** The dupedExprStructSize() function returns two values OR-ed together:
113733e619fcSdrh ** (1) the space required for a copy of the Expr structure only and
113833e619fcSdrh ** (2) the EP_xxx flags that indicate what the structure size should be.
113933e619fcSdrh ** The return values is always one of:
114033e619fcSdrh **
114133e619fcSdrh **      EXPR_FULLSIZE
114233e619fcSdrh **      EXPR_REDUCEDSIZE   | EP_Reduced
114333e619fcSdrh **      EXPR_TOKENONLYSIZE | EP_TokenOnly
114433e619fcSdrh **
114533e619fcSdrh ** The size of the structure can be found by masking the return value
114633e619fcSdrh ** of this routine with 0xfff.  The flags can be found by masking the
114733e619fcSdrh ** return value with EP_Reduced|EP_TokenOnly.
114833e619fcSdrh **
114933e619fcSdrh ** Note that with flags==EXPRDUP_REDUCE, this routines works on full-size
115033e619fcSdrh ** (unreduced) Expr objects as they or originally constructed by the parser.
115133e619fcSdrh ** During expression analysis, extra information is computed and moved into
1152c95f38d4Sdan ** later parts of the Expr object and that extra information might get chopped
115333e619fcSdrh ** off if the expression is reduced.  Note also that it does not work to
115460ec914cSpeter.d.reid ** make an EXPRDUP_REDUCE copy of a reduced expression.  It is only legal
115533e619fcSdrh ** to reduce a pristine expression tree from the parser.  The implementation
115633e619fcSdrh ** of dupedExprStructSize() contain multiple assert() statements that attempt
115733e619fcSdrh ** to enforce this constraint.
11586ab3a2ecSdanielk1977 */
11596ab3a2ecSdanielk1977 static int dupedExprStructSize(Expr *p, int flags){
11606ab3a2ecSdanielk1977   int nSize;
116133e619fcSdrh   assert( flags==EXPRDUP_REDUCE || flags==0 ); /* Only one flag value allowed */
1162aecd8021Sdrh   assert( EXPR_FULLSIZE<=0xfff );
1163aecd8021Sdrh   assert( (0xfff & (EP_Reduced|EP_TokenOnly))==0 );
116467a9b8edSdan   if( 0==flags || p->op==TK_SELECT_COLUMN
116567a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
1166eda079cdSdrh    || ExprHasProperty(p, EP_WinFunc)
116767a9b8edSdan #endif
116867a9b8edSdan   ){
11696ab3a2ecSdanielk1977     nSize = EXPR_FULLSIZE;
11706ab3a2ecSdanielk1977   }else{
1171c5cd1249Sdrh     assert( !ExprHasProperty(p, EP_TokenOnly|EP_Reduced) );
117233e619fcSdrh     assert( !ExprHasProperty(p, EP_FromJoin) );
1173c5cd1249Sdrh     assert( !ExprHasProperty(p, EP_MemToken) );
1174ebb6a65dSdrh     assert( !ExprHasProperty(p, EP_NoReduce) );
1175aecd8021Sdrh     if( p->pLeft || p->x.pList ){
117633e619fcSdrh       nSize = EXPR_REDUCEDSIZE | EP_Reduced;
117733e619fcSdrh     }else{
1178aecd8021Sdrh       assert( p->pRight==0 );
117933e619fcSdrh       nSize = EXPR_TOKENONLYSIZE | EP_TokenOnly;
118033e619fcSdrh     }
11816ab3a2ecSdanielk1977   }
11826ab3a2ecSdanielk1977   return nSize;
11836ab3a2ecSdanielk1977 }
11846ab3a2ecSdanielk1977 
11856ab3a2ecSdanielk1977 /*
118633e619fcSdrh ** This function returns the space in bytes required to store the copy
118733e619fcSdrh ** of the Expr structure and a copy of the Expr.u.zToken string (if that
118833e619fcSdrh ** string is defined.)
11896ab3a2ecSdanielk1977 */
11906ab3a2ecSdanielk1977 static int dupedExprNodeSize(Expr *p, int flags){
119133e619fcSdrh   int nByte = dupedExprStructSize(p, flags) & 0xfff;
119233e619fcSdrh   if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
11937301e774Sdrh     nByte += sqlite3Strlen30NN(p->u.zToken)+1;
11946ab3a2ecSdanielk1977   }
1195bc73971dSdanielk1977   return ROUND8(nByte);
11966ab3a2ecSdanielk1977 }
11976ab3a2ecSdanielk1977 
11986ab3a2ecSdanielk1977 /*
11996ab3a2ecSdanielk1977 ** Return the number of bytes required to create a duplicate of the
12006ab3a2ecSdanielk1977 ** expression passed as the first argument. The second argument is a
12016ab3a2ecSdanielk1977 ** mask containing EXPRDUP_XXX flags.
12026ab3a2ecSdanielk1977 **
12036ab3a2ecSdanielk1977 ** The value returned includes space to create a copy of the Expr struct
120433e619fcSdrh ** itself and the buffer referred to by Expr.u.zToken, if any.
12056ab3a2ecSdanielk1977 **
12066ab3a2ecSdanielk1977 ** If the EXPRDUP_REDUCE flag is set, then the return value includes
12076ab3a2ecSdanielk1977 ** space to duplicate all Expr nodes in the tree formed by Expr.pLeft
12086ab3a2ecSdanielk1977 ** and Expr.pRight variables (but not for any structures pointed to or
12096ab3a2ecSdanielk1977 ** descended from the Expr.x.pList or Expr.x.pSelect variables).
12106ab3a2ecSdanielk1977 */
12116ab3a2ecSdanielk1977 static int dupedExprSize(Expr *p, int flags){
12126ab3a2ecSdanielk1977   int nByte = 0;
12136ab3a2ecSdanielk1977   if( p ){
12146ab3a2ecSdanielk1977     nByte = dupedExprNodeSize(p, flags);
12156ab3a2ecSdanielk1977     if( flags&EXPRDUP_REDUCE ){
1216b7916a78Sdrh       nByte += dupedExprSize(p->pLeft, flags) + dupedExprSize(p->pRight, flags);
12176ab3a2ecSdanielk1977     }
12186ab3a2ecSdanielk1977   }
12196ab3a2ecSdanielk1977   return nByte;
12206ab3a2ecSdanielk1977 }
12216ab3a2ecSdanielk1977 
12226ab3a2ecSdanielk1977 /*
12236ab3a2ecSdanielk1977 ** This function is similar to sqlite3ExprDup(), except that if pzBuffer
12246ab3a2ecSdanielk1977 ** is not NULL then *pzBuffer is assumed to point to a buffer large enough
122533e619fcSdrh ** to store the copy of expression p, the copies of p->u.zToken
12266ab3a2ecSdanielk1977 ** (if applicable), and the copies of the p->pLeft and p->pRight expressions,
122760ec914cSpeter.d.reid ** if any. Before returning, *pzBuffer is set to the first byte past the
12286ab3a2ecSdanielk1977 ** portion of the buffer copied into by this function.
12296ab3a2ecSdanielk1977 */
12303c19469cSdrh static Expr *exprDup(sqlite3 *db, Expr *p, int dupFlags, u8 **pzBuffer){
12313c19469cSdrh   Expr *pNew;           /* Value to return */
12323c19469cSdrh   u8 *zAlloc;           /* Memory space from which to build Expr object */
12333c19469cSdrh   u32 staticFlag;       /* EP_Static if space not obtained from malloc */
12346ab3a2ecSdanielk1977 
12353c19469cSdrh   assert( db!=0 );
12363c19469cSdrh   assert( p );
12373c19469cSdrh   assert( dupFlags==0 || dupFlags==EXPRDUP_REDUCE );
12383c19469cSdrh   assert( pzBuffer==0 || dupFlags==EXPRDUP_REDUCE );
12396ab3a2ecSdanielk1977 
12406ab3a2ecSdanielk1977   /* Figure out where to write the new Expr structure. */
12416ab3a2ecSdanielk1977   if( pzBuffer ){
12426ab3a2ecSdanielk1977     zAlloc = *pzBuffer;
124333e619fcSdrh     staticFlag = EP_Static;
12446ab3a2ecSdanielk1977   }else{
12453c19469cSdrh     zAlloc = sqlite3DbMallocRawNN(db, dupedExprSize(p, dupFlags));
12463c19469cSdrh     staticFlag = 0;
12476ab3a2ecSdanielk1977   }
12486ab3a2ecSdanielk1977   pNew = (Expr *)zAlloc;
12496ab3a2ecSdanielk1977 
12506ab3a2ecSdanielk1977   if( pNew ){
12516ab3a2ecSdanielk1977     /* Set nNewSize to the size allocated for the structure pointed to
12526ab3a2ecSdanielk1977     ** by pNew. This is either EXPR_FULLSIZE, EXPR_REDUCEDSIZE or
12536ab3a2ecSdanielk1977     ** EXPR_TOKENONLYSIZE. nToken is set to the number of bytes consumed
125433e619fcSdrh     ** by the copy of the p->u.zToken string (if any).
12556ab3a2ecSdanielk1977     */
12563c19469cSdrh     const unsigned nStructSize = dupedExprStructSize(p, dupFlags);
125733e619fcSdrh     const int nNewSize = nStructSize & 0xfff;
125833e619fcSdrh     int nToken;
125933e619fcSdrh     if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
126033e619fcSdrh       nToken = sqlite3Strlen30(p->u.zToken) + 1;
126133e619fcSdrh     }else{
126233e619fcSdrh       nToken = 0;
126333e619fcSdrh     }
12643c19469cSdrh     if( dupFlags ){
12656ab3a2ecSdanielk1977       assert( ExprHasProperty(p, EP_Reduced)==0 );
12666ab3a2ecSdanielk1977       memcpy(zAlloc, p, nNewSize);
12676ab3a2ecSdanielk1977     }else{
12683e6a1411Sdan       u32 nSize = (u32)exprStructSize(p);
12696ab3a2ecSdanielk1977       memcpy(zAlloc, p, nSize);
127072ea29d7Sdrh       if( nSize<EXPR_FULLSIZE ){
12716ab3a2ecSdanielk1977         memset(&zAlloc[nSize], 0, EXPR_FULLSIZE-nSize);
12726ab3a2ecSdanielk1977       }
127372ea29d7Sdrh     }
12746ab3a2ecSdanielk1977 
127533e619fcSdrh     /* Set the EP_Reduced, EP_TokenOnly, and EP_Static flags appropriately. */
1276c5cd1249Sdrh     pNew->flags &= ~(EP_Reduced|EP_TokenOnly|EP_Static|EP_MemToken);
127733e619fcSdrh     pNew->flags |= nStructSize & (EP_Reduced|EP_TokenOnly);
127833e619fcSdrh     pNew->flags |= staticFlag;
12796ab3a2ecSdanielk1977 
128033e619fcSdrh     /* Copy the p->u.zToken string, if any. */
12816ab3a2ecSdanielk1977     if( nToken ){
128233e619fcSdrh       char *zToken = pNew->u.zToken = (char*)&zAlloc[nNewSize];
128333e619fcSdrh       memcpy(zToken, p->u.zToken, nToken);
12846ab3a2ecSdanielk1977     }
12856ab3a2ecSdanielk1977 
1286209bc522Sdrh     if( 0==((p->flags|pNew->flags) & (EP_TokenOnly|EP_Leaf)) ){
12876ab3a2ecSdanielk1977       /* Fill in the pNew->x.pSelect or pNew->x.pList member. */
12886ab3a2ecSdanielk1977       if( ExprHasProperty(p, EP_xIsSelect) ){
12893c19469cSdrh         pNew->x.pSelect = sqlite3SelectDup(db, p->x.pSelect, dupFlags);
12906ab3a2ecSdanielk1977       }else{
12913c19469cSdrh         pNew->x.pList = sqlite3ExprListDup(db, p->x.pList, dupFlags);
12926ab3a2ecSdanielk1977       }
12936ab3a2ecSdanielk1977     }
12946ab3a2ecSdanielk1977 
12956ab3a2ecSdanielk1977     /* Fill in pNew->pLeft and pNew->pRight. */
12964f9adee2Sdan     if( ExprHasProperty(pNew, EP_Reduced|EP_TokenOnly|EP_WinFunc) ){
12973c19469cSdrh       zAlloc += dupedExprNodeSize(p, dupFlags);
1298209bc522Sdrh       if( !ExprHasProperty(pNew, EP_TokenOnly|EP_Leaf) ){
12993c19469cSdrh         pNew->pLeft = p->pLeft ?
13003c19469cSdrh                       exprDup(db, p->pLeft, EXPRDUP_REDUCE, &zAlloc) : 0;
13013c19469cSdrh         pNew->pRight = p->pRight ?
13023c19469cSdrh                        exprDup(db, p->pRight, EXPRDUP_REDUCE, &zAlloc) : 0;
13036ab3a2ecSdanielk1977       }
130467a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
1305eda079cdSdrh       if( ExprHasProperty(p, EP_WinFunc) ){
1306eda079cdSdrh         pNew->y.pWin = sqlite3WindowDup(db, pNew, p->y.pWin);
1307eda079cdSdrh         assert( ExprHasProperty(pNew, EP_WinFunc) );
1308e2f781b9Sdan       }
130967a9b8edSdan #endif /* SQLITE_OMIT_WINDOWFUNC */
131053988068Sdrh       if( pzBuffer ){
131153988068Sdrh         *pzBuffer = zAlloc;
131253988068Sdrh       }
131353988068Sdrh     }else{
1314209bc522Sdrh       if( !ExprHasProperty(p, EP_TokenOnly|EP_Leaf) ){
13159854260bSdrh         if( pNew->op==TK_SELECT_COLUMN ){
13169854260bSdrh           pNew->pLeft = p->pLeft;
131747073f62Sdrh           assert( p->iColumn==0 || p->pRight==0 );
131847073f62Sdrh           assert( p->pRight==0  || p->pRight==p->pLeft );
13199854260bSdrh         }else{
13206ab3a2ecSdanielk1977           pNew->pLeft = sqlite3ExprDup(db, p->pLeft, 0);
13219854260bSdrh         }
13226ab3a2ecSdanielk1977         pNew->pRight = sqlite3ExprDup(db, p->pRight, 0);
13236ab3a2ecSdanielk1977       }
13246ab3a2ecSdanielk1977     }
13256ab3a2ecSdanielk1977   }
13266ab3a2ecSdanielk1977   return pNew;
13276ab3a2ecSdanielk1977 }
13286ab3a2ecSdanielk1977 
13296ab3a2ecSdanielk1977 /*
1330bfe31e7fSdan ** Create and return a deep copy of the object passed as the second
1331bfe31e7fSdan ** argument. If an OOM condition is encountered, NULL is returned
1332bfe31e7fSdan ** and the db->mallocFailed flag set.
1333bfe31e7fSdan */
1334eede6a53Sdan #ifndef SQLITE_OMIT_CTE
1335bfe31e7fSdan static With *withDup(sqlite3 *db, With *p){
13364e9119d9Sdan   With *pRet = 0;
13374e9119d9Sdan   if( p ){
1338d4de9f7bSdrh     sqlite3_int64 nByte = sizeof(*p) + sizeof(p->a[0]) * (p->nCte-1);
13394e9119d9Sdan     pRet = sqlite3DbMallocZero(db, nByte);
13404e9119d9Sdan     if( pRet ){
13414e9119d9Sdan       int i;
13424e9119d9Sdan       pRet->nCte = p->nCte;
13434e9119d9Sdan       for(i=0; i<p->nCte; i++){
13444e9119d9Sdan         pRet->a[i].pSelect = sqlite3SelectDup(db, p->a[i].pSelect, 0);
13454e9119d9Sdan         pRet->a[i].pCols = sqlite3ExprListDup(db, p->a[i].pCols, 0);
13464e9119d9Sdan         pRet->a[i].zName = sqlite3DbStrDup(db, p->a[i].zName);
13474e9119d9Sdan       }
13484e9119d9Sdan     }
13494e9119d9Sdan   }
13504e9119d9Sdan   return pRet;
13514e9119d9Sdan }
1352eede6a53Sdan #else
1353eede6a53Sdan # define withDup(x,y) 0
1354eede6a53Sdan #endif
13554e9119d9Sdan 
1356a8389975Sdrh #ifndef SQLITE_OMIT_WINDOWFUNC
1357a8389975Sdrh /*
1358a8389975Sdrh ** The gatherSelectWindows() procedure and its helper routine
1359a8389975Sdrh ** gatherSelectWindowsCallback() are used to scan all the expressions
1360a8389975Sdrh ** an a newly duplicated SELECT statement and gather all of the Window
1361a8389975Sdrh ** objects found there, assembling them onto the linked list at Select->pWin.
1362a8389975Sdrh */
1363a8389975Sdrh static int gatherSelectWindowsCallback(Walker *pWalker, Expr *pExpr){
13646ba7ab0dSdan   if( pExpr->op==TK_FUNCTION && ExprHasProperty(pExpr, EP_WinFunc) ){
136575b0821eSdan     Select *pSelect = pWalker->u.pSelect;
136675b0821eSdan     Window *pWin = pExpr->y.pWin;
136775b0821eSdan     assert( pWin );
13684f9adee2Sdan     assert( IsWindowFunc(pExpr) );
1369e0ae3f69Sdan     assert( pWin->ppThis==0 );
1370a3fcc000Sdan     sqlite3WindowLink(pSelect, pWin);
1371a8389975Sdrh   }
1372a8389975Sdrh   return WRC_Continue;
1373a8389975Sdrh }
1374a37b6a5eSdrh static int gatherSelectWindowsSelectCallback(Walker *pWalker, Select *p){
1375a37b6a5eSdrh   return p==pWalker->u.pSelect ? WRC_Continue : WRC_Prune;
1376a37b6a5eSdrh }
1377a8389975Sdrh static void gatherSelectWindows(Select *p){
1378a8389975Sdrh   Walker w;
1379a8389975Sdrh   w.xExprCallback = gatherSelectWindowsCallback;
1380a37b6a5eSdrh   w.xSelectCallback = gatherSelectWindowsSelectCallback;
1381a37b6a5eSdrh   w.xSelectCallback2 = 0;
13829c46c66cSdrh   w.pParse = 0;
1383a8389975Sdrh   w.u.pSelect = p;
1384a37b6a5eSdrh   sqlite3WalkSelect(&w, p);
1385a8389975Sdrh }
1386a8389975Sdrh #endif
1387a8389975Sdrh 
1388a8389975Sdrh 
1389a76b5dfcSdrh /*
1390ff78bd2fSdrh ** The following group of routines make deep copies of expressions,
1391ff78bd2fSdrh ** expression lists, ID lists, and select statements.  The copies can
1392ff78bd2fSdrh ** be deleted (by being passed to their respective ...Delete() routines)
1393ff78bd2fSdrh ** without effecting the originals.
1394ff78bd2fSdrh **
13954adee20fSdanielk1977 ** The expression list, ID, and source lists return by sqlite3ExprListDup(),
13964adee20fSdanielk1977 ** sqlite3IdListDup(), and sqlite3SrcListDup() can not be further expanded
1397ad3cab52Sdrh ** by subsequent calls to sqlite*ListAppend() routines.
1398ff78bd2fSdrh **
1399ad3cab52Sdrh ** Any tables that the SrcList might point to are not duplicated.
14006ab3a2ecSdanielk1977 **
1401b7916a78Sdrh ** The flags parameter contains a combination of the EXPRDUP_XXX flags.
14026ab3a2ecSdanielk1977 ** If the EXPRDUP_REDUCE flag is set, then the structure returned is a
14036ab3a2ecSdanielk1977 ** truncated version of the usual Expr structure that will be stored as
14046ab3a2ecSdanielk1977 ** part of the in-memory representation of the database schema.
1405ff78bd2fSdrh */
14066ab3a2ecSdanielk1977 Expr *sqlite3ExprDup(sqlite3 *db, Expr *p, int flags){
140772ea29d7Sdrh   assert( flags==0 || flags==EXPRDUP_REDUCE );
14083c19469cSdrh   return p ? exprDup(db, p, flags, 0) : 0;
1409ff78bd2fSdrh }
14106ab3a2ecSdanielk1977 ExprList *sqlite3ExprListDup(sqlite3 *db, ExprList *p, int flags){
1411ff78bd2fSdrh   ExprList *pNew;
1412145716b3Sdrh   struct ExprList_item *pItem, *pOldItem;
1413ff78bd2fSdrh   int i;
1414b163748eSdrh   Expr *pPriorSelectCol = 0;
1415575fad65Sdrh   assert( db!=0 );
1416ff78bd2fSdrh   if( p==0 ) return 0;
141797258194Sdrh   pNew = sqlite3DbMallocRawNN(db, sqlite3DbMallocSize(db, p));
1418ff78bd2fSdrh   if( pNew==0 ) return 0;
1419a19543feSdrh   pNew->nExpr = p->nExpr;
142043606175Sdrh   pItem = pNew->a;
1421145716b3Sdrh   pOldItem = p->a;
1422145716b3Sdrh   for(i=0; i<p->nExpr; i++, pItem++, pOldItem++){
14236ab3a2ecSdanielk1977     Expr *pOldExpr = pOldItem->pExpr;
142447073f62Sdrh     Expr *pNewExpr;
1425b5526ea6Sdrh     pItem->pExpr = sqlite3ExprDup(db, pOldExpr, flags);
142647073f62Sdrh     if( pOldExpr
142747073f62Sdrh      && pOldExpr->op==TK_SELECT_COLUMN
142847073f62Sdrh      && (pNewExpr = pItem->pExpr)!=0
142947073f62Sdrh     ){
143047073f62Sdrh       assert( pNewExpr->iColumn==0 || i>0 );
143147073f62Sdrh       if( pNewExpr->iColumn==0 ){
143247073f62Sdrh         assert( pOldExpr->pLeft==pOldExpr->pRight );
1433b163748eSdrh         pPriorSelectCol = pNewExpr->pLeft = pNewExpr->pRight;
1434b163748eSdrh       }else{
1435b163748eSdrh         assert( i>0 );
1436b163748eSdrh         assert( pItem[-1].pExpr!=0 );
1437b163748eSdrh         assert( pNewExpr->iColumn==pItem[-1].pExpr->iColumn+1 );
1438b163748eSdrh         assert( pPriorSelectCol==pItem[-1].pExpr->pLeft );
1439b163748eSdrh         pNewExpr->pLeft = pPriorSelectCol;
144047073f62Sdrh       }
144147073f62Sdrh     }
144217435752Sdrh     pItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
1443b7916a78Sdrh     pItem->zSpan = sqlite3DbStrDup(db, pOldItem->zSpan);
14446e11892dSdan     pItem->sortFlags = pOldItem->sortFlags;
14453e7bc9caSdrh     pItem->done = 0;
1446ae8e45cbSdan     pItem->bNulls = pOldItem->bNulls;
14472c036cffSdrh     pItem->bSpanIsTab = pOldItem->bSpanIsTab;
144824e25d32Sdan     pItem->bSorterRef = pOldItem->bSorterRef;
1449c2acc4e4Sdrh     pItem->u = pOldItem->u;
1450ff78bd2fSdrh   }
1451ff78bd2fSdrh   return pNew;
1452ff78bd2fSdrh }
145393758c8dSdanielk1977 
145493758c8dSdanielk1977 /*
145593758c8dSdanielk1977 ** If cursors, triggers, views and subqueries are all omitted from
145693758c8dSdanielk1977 ** the build, then none of the following routines, except for
145793758c8dSdanielk1977 ** sqlite3SelectDup(), can be called. sqlite3SelectDup() is sometimes
145893758c8dSdanielk1977 ** called with a NULL argument.
145993758c8dSdanielk1977 */
14606a67fe8eSdanielk1977 #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_TRIGGER) \
14616a67fe8eSdanielk1977  || !defined(SQLITE_OMIT_SUBQUERY)
14626ab3a2ecSdanielk1977 SrcList *sqlite3SrcListDup(sqlite3 *db, SrcList *p, int flags){
1463ad3cab52Sdrh   SrcList *pNew;
1464ad3cab52Sdrh   int i;
1465113088ecSdrh   int nByte;
1466575fad65Sdrh   assert( db!=0 );
1467ad3cab52Sdrh   if( p==0 ) return 0;
1468113088ecSdrh   nByte = sizeof(*p) + (p->nSrc>0 ? sizeof(p->a[0]) * (p->nSrc-1) : 0);
1469575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, nByte );
1470ad3cab52Sdrh   if( pNew==0 ) return 0;
14714305d103Sdrh   pNew->nSrc = pNew->nAlloc = p->nSrc;
1472ad3cab52Sdrh   for(i=0; i<p->nSrc; i++){
14734efc4754Sdrh     struct SrcList_item *pNewItem = &pNew->a[i];
14744efc4754Sdrh     struct SrcList_item *pOldItem = &p->a[i];
1475ed8a3bb1Sdrh     Table *pTab;
147641fb5cd1Sdan     pNewItem->pSchema = pOldItem->pSchema;
147717435752Sdrh     pNewItem->zDatabase = sqlite3DbStrDup(db, pOldItem->zDatabase);
147817435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
147917435752Sdrh     pNewItem->zAlias = sqlite3DbStrDup(db, pOldItem->zAlias);
14808a48b9c0Sdrh     pNewItem->fg = pOldItem->fg;
14814efc4754Sdrh     pNewItem->iCursor = pOldItem->iCursor;
14825b6a9ed4Sdrh     pNewItem->addrFillSub = pOldItem->addrFillSub;
14835b6a9ed4Sdrh     pNewItem->regReturn = pOldItem->regReturn;
14848a48b9c0Sdrh     if( pNewItem->fg.isIndexedBy ){
14858a48b9c0Sdrh       pNewItem->u1.zIndexedBy = sqlite3DbStrDup(db, pOldItem->u1.zIndexedBy);
14868a48b9c0Sdrh     }
14878a48b9c0Sdrh     pNewItem->pIBIndex = pOldItem->pIBIndex;
14888a48b9c0Sdrh     if( pNewItem->fg.isTabFunc ){
14898a48b9c0Sdrh       pNewItem->u1.pFuncArg =
14908a48b9c0Sdrh           sqlite3ExprListDup(db, pOldItem->u1.pFuncArg, flags);
14918a48b9c0Sdrh     }
1492ed8a3bb1Sdrh     pTab = pNewItem->pTab = pOldItem->pTab;
1493ed8a3bb1Sdrh     if( pTab ){
149479df7782Sdrh       pTab->nTabRef++;
1495a1cb183dSdanielk1977     }
14966ab3a2ecSdanielk1977     pNewItem->pSelect = sqlite3SelectDup(db, pOldItem->pSelect, flags);
14976ab3a2ecSdanielk1977     pNewItem->pOn = sqlite3ExprDup(db, pOldItem->pOn, flags);
149817435752Sdrh     pNewItem->pUsing = sqlite3IdListDup(db, pOldItem->pUsing);
14996c18b6e0Sdanielk1977     pNewItem->colUsed = pOldItem->colUsed;
1500ad3cab52Sdrh   }
1501ad3cab52Sdrh   return pNew;
1502ad3cab52Sdrh }
150317435752Sdrh IdList *sqlite3IdListDup(sqlite3 *db, IdList *p){
1504ff78bd2fSdrh   IdList *pNew;
1505ff78bd2fSdrh   int i;
1506575fad65Sdrh   assert( db!=0 );
1507ff78bd2fSdrh   if( p==0 ) return 0;
1508575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, sizeof(*pNew) );
1509ff78bd2fSdrh   if( pNew==0 ) return 0;
15106c535158Sdrh   pNew->nId = p->nId;
1511575fad65Sdrh   pNew->a = sqlite3DbMallocRawNN(db, p->nId*sizeof(p->a[0]) );
1512d5d56523Sdanielk1977   if( pNew->a==0 ){
1513dbd6a7dcSdrh     sqlite3DbFreeNN(db, pNew);
1514d5d56523Sdanielk1977     return 0;
1515d5d56523Sdanielk1977   }
15166c535158Sdrh   /* Note that because the size of the allocation for p->a[] is not
15176c535158Sdrh   ** necessarily a power of two, sqlite3IdListAppend() may not be called
15186c535158Sdrh   ** on the duplicate created by this function. */
1519ff78bd2fSdrh   for(i=0; i<p->nId; i++){
15204efc4754Sdrh     struct IdList_item *pNewItem = &pNew->a[i];
15214efc4754Sdrh     struct IdList_item *pOldItem = &p->a[i];
152217435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
15234efc4754Sdrh     pNewItem->idx = pOldItem->idx;
1524ff78bd2fSdrh   }
1525ff78bd2fSdrh   return pNew;
1526ff78bd2fSdrh }
1527a7466205Sdan Select *sqlite3SelectDup(sqlite3 *db, Select *pDup, int flags){
1528a7466205Sdan   Select *pRet = 0;
1529a7466205Sdan   Select *pNext = 0;
1530a7466205Sdan   Select **pp = &pRet;
1531a7466205Sdan   Select *p;
1532a7466205Sdan 
1533575fad65Sdrh   assert( db!=0 );
1534a7466205Sdan   for(p=pDup; p; p=p->pPrior){
1535a7466205Sdan     Select *pNew = sqlite3DbMallocRawNN(db, sizeof(*p) );
1536a7466205Sdan     if( pNew==0 ) break;
1537b7916a78Sdrh     pNew->pEList = sqlite3ExprListDup(db, p->pEList, flags);
15386ab3a2ecSdanielk1977     pNew->pSrc = sqlite3SrcListDup(db, p->pSrc, flags);
15396ab3a2ecSdanielk1977     pNew->pWhere = sqlite3ExprDup(db, p->pWhere, flags);
15406ab3a2ecSdanielk1977     pNew->pGroupBy = sqlite3ExprListDup(db, p->pGroupBy, flags);
15416ab3a2ecSdanielk1977     pNew->pHaving = sqlite3ExprDup(db, p->pHaving, flags);
15426ab3a2ecSdanielk1977     pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, flags);
1543ff78bd2fSdrh     pNew->op = p->op;
1544a7466205Sdan     pNew->pNext = pNext;
1545a7466205Sdan     pNew->pPrior = 0;
15466ab3a2ecSdanielk1977     pNew->pLimit = sqlite3ExprDup(db, p->pLimit, flags);
154792b01d53Sdrh     pNew->iLimit = 0;
154892b01d53Sdrh     pNew->iOffset = 0;
15497d10d5a6Sdrh     pNew->selFlags = p->selFlags & ~SF_UsesEphemeral;
1550b9bb7c18Sdrh     pNew->addrOpenEphm[0] = -1;
1551b9bb7c18Sdrh     pNew->addrOpenEphm[1] = -1;
1552ec2da854Sdrh     pNew->nSelectRow = p->nSelectRow;
15534e9119d9Sdan     pNew->pWith = withDup(db, p->pWith);
155467a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
15552e362f97Sdan     pNew->pWin = 0;
1556c95f38d4Sdan     pNew->pWinDefn = sqlite3WindowListDup(db, p->pWinDefn);
15574780b9adSdan     if( p->pWin && db->mallocFailed==0 ) gatherSelectWindows(pNew);
155867a9b8edSdan #endif
1559fef37760Sdrh     pNew->selId = p->selId;
1560a7466205Sdan     *pp = pNew;
1561a7466205Sdan     pp = &pNew->pPrior;
1562a7466205Sdan     pNext = pNew;
1563a7466205Sdan   }
1564a7466205Sdan 
1565a7466205Sdan   return pRet;
1566ff78bd2fSdrh }
156793758c8dSdanielk1977 #else
15686ab3a2ecSdanielk1977 Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
156993758c8dSdanielk1977   assert( p==0 );
157093758c8dSdanielk1977   return 0;
157193758c8dSdanielk1977 }
157293758c8dSdanielk1977 #endif
1573ff78bd2fSdrh 
1574ff78bd2fSdrh 
1575ff78bd2fSdrh /*
1576a76b5dfcSdrh ** Add a new element to the end of an expression list.  If pList is
1577a76b5dfcSdrh ** initially NULL, then create a new expression list.
1578b7916a78Sdrh **
1579a19543feSdrh ** The pList argument must be either NULL or a pointer to an ExprList
1580a19543feSdrh ** obtained from a prior call to sqlite3ExprListAppend().  This routine
1581a19543feSdrh ** may not be used with an ExprList obtained from sqlite3ExprListDup().
1582a19543feSdrh ** Reason:  This routine assumes that the number of slots in pList->a[]
1583a19543feSdrh ** is a power of two.  That is true for sqlite3ExprListAppend() returns
1584a19543feSdrh ** but is not necessarily true from the return value of sqlite3ExprListDup().
1585a19543feSdrh **
1586b7916a78Sdrh ** If a memory allocation error occurs, the entire list is freed and
1587b7916a78Sdrh ** NULL is returned.  If non-NULL is returned, then it is guaranteed
1588b7916a78Sdrh ** that the new entry was successfully appended.
1589a76b5dfcSdrh */
159017435752Sdrh ExprList *sqlite3ExprListAppend(
159117435752Sdrh   Parse *pParse,          /* Parsing context */
159217435752Sdrh   ExprList *pList,        /* List to which to append. Might be NULL */
1593b7916a78Sdrh   Expr *pExpr             /* Expression to be appended. Might be NULL */
159417435752Sdrh ){
159543606175Sdrh   struct ExprList_item *pItem;
159617435752Sdrh   sqlite3 *db = pParse->db;
1597575fad65Sdrh   assert( db!=0 );
1598a76b5dfcSdrh   if( pList==0 ){
1599575fad65Sdrh     pList = sqlite3DbMallocRawNN(db, sizeof(ExprList) );
1600a76b5dfcSdrh     if( pList==0 ){
1601d5d56523Sdanielk1977       goto no_mem;
1602a76b5dfcSdrh     }
1603c263f7c4Sdrh     pList->nExpr = 0;
1604a19543feSdrh   }else if( (pList->nExpr & (pList->nExpr-1))==0 ){
160543606175Sdrh     ExprList *pNew;
160643606175Sdrh     pNew = sqlite3DbRealloc(db, pList,
16070aa3231fSdrh          sizeof(*pList)+(2*(sqlite3_int64)pList->nExpr-1)*sizeof(pList->a[0]));
160843606175Sdrh     if( pNew==0 ){
1609d5d56523Sdanielk1977       goto no_mem;
1610a76b5dfcSdrh     }
161143606175Sdrh     pList = pNew;
1612a76b5dfcSdrh   }
161343606175Sdrh   pItem = &pList->a[pList->nExpr++];
1614a8b9793cSdrh   assert( offsetof(struct ExprList_item,zName)==sizeof(pItem->pExpr) );
1615a8b9793cSdrh   assert( offsetof(struct ExprList_item,pExpr)==0 );
1616a8b9793cSdrh   memset(&pItem->zName,0,sizeof(*pItem)-offsetof(struct ExprList_item,zName));
1617e94ddc9eSdanielk1977   pItem->pExpr = pExpr;
1618a76b5dfcSdrh   return pList;
1619d5d56523Sdanielk1977 
1620d5d56523Sdanielk1977 no_mem:
1621d5d56523Sdanielk1977   /* Avoid leaking memory if malloc has failed. */
1622633e6d57Sdrh   sqlite3ExprDelete(db, pExpr);
1623633e6d57Sdrh   sqlite3ExprListDelete(db, pList);
1624d5d56523Sdanielk1977   return 0;
1625a76b5dfcSdrh }
1626a76b5dfcSdrh 
1627a76b5dfcSdrh /*
16288762ec19Sdrh ** pColumns and pExpr form a vector assignment which is part of the SET
16298762ec19Sdrh ** clause of an UPDATE statement.  Like this:
1630a1251bc4Sdrh **
1631a1251bc4Sdrh **        (a,b,c) = (expr1,expr2,expr3)
1632a1251bc4Sdrh ** Or:    (a,b,c) = (SELECT x,y,z FROM ....)
1633a1251bc4Sdrh **
1634a1251bc4Sdrh ** For each term of the vector assignment, append new entries to the
1635b67343d0Sdrh ** expression list pList.  In the case of a subquery on the RHS, append
1636a1251bc4Sdrh ** TK_SELECT_COLUMN expressions.
1637a1251bc4Sdrh */
1638a1251bc4Sdrh ExprList *sqlite3ExprListAppendVector(
1639a1251bc4Sdrh   Parse *pParse,         /* Parsing context */
1640a1251bc4Sdrh   ExprList *pList,       /* List to which to append. Might be NULL */
1641a1251bc4Sdrh   IdList *pColumns,      /* List of names of LHS of the assignment */
1642a1251bc4Sdrh   Expr *pExpr            /* Vector expression to be appended. Might be NULL */
1643a1251bc4Sdrh ){
1644a1251bc4Sdrh   sqlite3 *db = pParse->db;
1645a1251bc4Sdrh   int n;
1646a1251bc4Sdrh   int i;
164766860af3Sdrh   int iFirst = pList ? pList->nExpr : 0;
1648321e828dSdrh   /* pColumns can only be NULL due to an OOM but an OOM will cause an
1649321e828dSdrh   ** exit prior to this routine being invoked */
1650321e828dSdrh   if( NEVER(pColumns==0) ) goto vector_append_error;
1651a1251bc4Sdrh   if( pExpr==0 ) goto vector_append_error;
1652966e2911Sdrh 
1653966e2911Sdrh   /* If the RHS is a vector, then we can immediately check to see that
1654966e2911Sdrh   ** the size of the RHS and LHS match.  But if the RHS is a SELECT,
1655966e2911Sdrh   ** wildcards ("*") in the result set of the SELECT must be expanded before
1656966e2911Sdrh   ** we can do the size check, so defer the size check until code generation.
1657966e2911Sdrh   */
1658966e2911Sdrh   if( pExpr->op!=TK_SELECT && pColumns->nId!=(n=sqlite3ExprVectorSize(pExpr)) ){
1659a1251bc4Sdrh     sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
1660a1251bc4Sdrh                     pColumns->nId, n);
1661a1251bc4Sdrh     goto vector_append_error;
1662a1251bc4Sdrh   }
1663966e2911Sdrh 
1664966e2911Sdrh   for(i=0; i<pColumns->nId; i++){
1665a1251bc4Sdrh     Expr *pSubExpr = sqlite3ExprForVectorField(pParse, pExpr, i);
1666554a9dc7Sdrh     assert( pSubExpr!=0 || db->mallocFailed );
1667554a9dc7Sdrh     assert( pSubExpr==0 || pSubExpr->iTable==0 );
1668554a9dc7Sdrh     if( pSubExpr==0 ) continue;
1669554a9dc7Sdrh     pSubExpr->iTable = pColumns->nId;
1670a1251bc4Sdrh     pList = sqlite3ExprListAppend(pParse, pList, pSubExpr);
1671a1251bc4Sdrh     if( pList ){
167266860af3Sdrh       assert( pList->nExpr==iFirst+i+1 );
1673a1251bc4Sdrh       pList->a[pList->nExpr-1].zName = pColumns->a[i].zName;
1674a1251bc4Sdrh       pColumns->a[i].zName = 0;
1675a1251bc4Sdrh     }
1676a1251bc4Sdrh   }
1677966e2911Sdrh 
1678ffe28059Sdrh   if( !db->mallocFailed && pExpr->op==TK_SELECT && ALWAYS(pList!=0) ){
1679966e2911Sdrh     Expr *pFirst = pList->a[iFirst].pExpr;
1680f4dd26c5Sdrh     assert( pFirst!=0 );
1681966e2911Sdrh     assert( pFirst->op==TK_SELECT_COLUMN );
1682966e2911Sdrh 
1683966e2911Sdrh     /* Store the SELECT statement in pRight so it will be deleted when
1684966e2911Sdrh     ** sqlite3ExprListDelete() is called */
1685966e2911Sdrh     pFirst->pRight = pExpr;
1686a1251bc4Sdrh     pExpr = 0;
1687966e2911Sdrh 
1688966e2911Sdrh     /* Remember the size of the LHS in iTable so that we can check that
1689966e2911Sdrh     ** the RHS and LHS sizes match during code generation. */
1690966e2911Sdrh     pFirst->iTable = pColumns->nId;
1691a1251bc4Sdrh   }
1692a1251bc4Sdrh 
1693a1251bc4Sdrh vector_append_error:
16948e34e406Sdrh   sqlite3ExprUnmapAndDelete(pParse, pExpr);
1695a1251bc4Sdrh   sqlite3IdListDelete(db, pColumns);
1696a1251bc4Sdrh   return pList;
1697a1251bc4Sdrh }
1698a1251bc4Sdrh 
1699a1251bc4Sdrh /*
1700bc622bc0Sdrh ** Set the sort order for the last element on the given ExprList.
1701bc622bc0Sdrh */
17026e11892dSdan void sqlite3ExprListSetSortOrder(ExprList *p, int iSortOrder, int eNulls){
17039105fd51Sdan   struct ExprList_item *pItem;
1704bc622bc0Sdrh   if( p==0 ) return;
1705bc622bc0Sdrh   assert( p->nExpr>0 );
17066e11892dSdan 
17076e11892dSdan   assert( SQLITE_SO_UNDEFINED<0 && SQLITE_SO_ASC==0 && SQLITE_SO_DESC>0 );
17086e11892dSdan   assert( iSortOrder==SQLITE_SO_UNDEFINED
17096e11892dSdan        || iSortOrder==SQLITE_SO_ASC
17106e11892dSdan        || iSortOrder==SQLITE_SO_DESC
17116e11892dSdan   );
17126e11892dSdan   assert( eNulls==SQLITE_SO_UNDEFINED
17136e11892dSdan        || eNulls==SQLITE_SO_ASC
17146e11892dSdan        || eNulls==SQLITE_SO_DESC
17156e11892dSdan   );
17166e11892dSdan 
17179105fd51Sdan   pItem = &p->a[p->nExpr-1];
17189105fd51Sdan   assert( pItem->bNulls==0 );
17199105fd51Sdan   if( iSortOrder==SQLITE_SO_UNDEFINED ){
17209105fd51Sdan     iSortOrder = SQLITE_SO_ASC;
1721bc622bc0Sdrh   }
17229105fd51Sdan   pItem->sortFlags = (u8)iSortOrder;
17239105fd51Sdan 
17249105fd51Sdan   if( eNulls!=SQLITE_SO_UNDEFINED ){
17259105fd51Sdan     pItem->bNulls = 1;
17269105fd51Sdan     if( iSortOrder!=eNulls ){
17279105fd51Sdan       pItem->sortFlags |= KEYINFO_ORDER_BIGNULL;
17289105fd51Sdan     }
1729bc622bc0Sdrh   }
1730bc622bc0Sdrh }
1731bc622bc0Sdrh 
1732bc622bc0Sdrh /*
1733b7916a78Sdrh ** Set the ExprList.a[].zName element of the most recently added item
1734b7916a78Sdrh ** on the expression list.
1735b7916a78Sdrh **
1736b7916a78Sdrh ** pList might be NULL following an OOM error.  But pName should never be
1737b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1738b7916a78Sdrh ** is set.
1739b7916a78Sdrh */
1740b7916a78Sdrh void sqlite3ExprListSetName(
1741b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1742b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
1743b7916a78Sdrh   Token *pName,           /* Name to be added */
1744b7916a78Sdrh   int dequote             /* True to cause the name to be dequoted */
1745b7916a78Sdrh ){
1746b7916a78Sdrh   assert( pList!=0 || pParse->db->mallocFailed!=0 );
1747b7916a78Sdrh   if( pList ){
1748b7916a78Sdrh     struct ExprList_item *pItem;
1749b7916a78Sdrh     assert( pList->nExpr>0 );
1750b7916a78Sdrh     pItem = &pList->a[pList->nExpr-1];
1751b7916a78Sdrh     assert( pItem->zName==0 );
1752b7916a78Sdrh     pItem->zName = sqlite3DbStrNDup(pParse->db, pName->z, pName->n);
1753244b9d6eSdrh     if( dequote ) sqlite3Dequote(pItem->zName);
1754c9461eccSdan     if( IN_RENAME_OBJECT ){
175507e95233Sdan       sqlite3RenameTokenMap(pParse, (void*)pItem->zName, pName);
17565be60c55Sdan     }
1757b7916a78Sdrh   }
1758b7916a78Sdrh }
1759b7916a78Sdrh 
1760b7916a78Sdrh /*
1761b7916a78Sdrh ** Set the ExprList.a[].zSpan element of the most recently added item
1762b7916a78Sdrh ** on the expression list.
1763b7916a78Sdrh **
1764b7916a78Sdrh ** pList might be NULL following an OOM error.  But pSpan should never be
1765b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1766b7916a78Sdrh ** is set.
1767b7916a78Sdrh */
1768b7916a78Sdrh void sqlite3ExprListSetSpan(
1769b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1770b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
17711be266baSdrh   const char *zStart,     /* Start of the span */
17721be266baSdrh   const char *zEnd        /* End of the span */
1773b7916a78Sdrh ){
1774b7916a78Sdrh   sqlite3 *db = pParse->db;
1775b7916a78Sdrh   assert( pList!=0 || db->mallocFailed!=0 );
1776b7916a78Sdrh   if( pList ){
1777b7916a78Sdrh     struct ExprList_item *pItem = &pList->a[pList->nExpr-1];
1778b7916a78Sdrh     assert( pList->nExpr>0 );
1779b7916a78Sdrh     sqlite3DbFree(db, pItem->zSpan);
17809b2e0435Sdrh     pItem->zSpan = sqlite3DbSpanDup(db, zStart, zEnd);
1781b7916a78Sdrh   }
1782b7916a78Sdrh }
1783b7916a78Sdrh 
1784b7916a78Sdrh /*
17857a15a4beSdanielk1977 ** If the expression list pEList contains more than iLimit elements,
17867a15a4beSdanielk1977 ** leave an error message in pParse.
17877a15a4beSdanielk1977 */
17887a15a4beSdanielk1977 void sqlite3ExprListCheckLength(
17897a15a4beSdanielk1977   Parse *pParse,
17907a15a4beSdanielk1977   ExprList *pEList,
17917a15a4beSdanielk1977   const char *zObject
17927a15a4beSdanielk1977 ){
1793b1a6c3c1Sdrh   int mx = pParse->db->aLimit[SQLITE_LIMIT_COLUMN];
1794c5499befSdrh   testcase( pEList && pEList->nExpr==mx );
1795c5499befSdrh   testcase( pEList && pEList->nExpr==mx+1 );
1796b1a6c3c1Sdrh   if( pEList && pEList->nExpr>mx ){
17977a15a4beSdanielk1977     sqlite3ErrorMsg(pParse, "too many columns in %s", zObject);
17987a15a4beSdanielk1977   }
17997a15a4beSdanielk1977 }
18007a15a4beSdanielk1977 
18017a15a4beSdanielk1977 /*
1802a76b5dfcSdrh ** Delete an entire expression list.
1803a76b5dfcSdrh */
1804affa855cSdrh static SQLITE_NOINLINE void exprListDeleteNN(sqlite3 *db, ExprList *pList){
1805ac48b751Sdrh   int i = pList->nExpr;
1806ac48b751Sdrh   struct ExprList_item *pItem =  pList->a;
1807ac48b751Sdrh   assert( pList->nExpr>0 );
1808ac48b751Sdrh   do{
1809633e6d57Sdrh     sqlite3ExprDelete(db, pItem->pExpr);
1810633e6d57Sdrh     sqlite3DbFree(db, pItem->zName);
1811b7916a78Sdrh     sqlite3DbFree(db, pItem->zSpan);
1812ac48b751Sdrh     pItem++;
1813ac48b751Sdrh   }while( --i>0 );
1814dbd6a7dcSdrh   sqlite3DbFreeNN(db, pList);
1815a76b5dfcSdrh }
1816affa855cSdrh void sqlite3ExprListDelete(sqlite3 *db, ExprList *pList){
1817affa855cSdrh   if( pList ) exprListDeleteNN(db, pList);
1818affa855cSdrh }
1819a76b5dfcSdrh 
1820a76b5dfcSdrh /*
18212308ed38Sdrh ** Return the bitwise-OR of all Expr.flags fields in the given
18222308ed38Sdrh ** ExprList.
1823885a5b03Sdrh */
18242308ed38Sdrh u32 sqlite3ExprListFlags(const ExprList *pList){
1825885a5b03Sdrh   int i;
18262308ed38Sdrh   u32 m = 0;
1827508e2d00Sdrh   assert( pList!=0 );
1828885a5b03Sdrh   for(i=0; i<pList->nExpr; i++){
1829d0c73053Sdrh      Expr *pExpr = pList->a[i].pExpr;
1830de845c2fSdrh      assert( pExpr!=0 );
1831de845c2fSdrh      m |= pExpr->flags;
1832885a5b03Sdrh   }
18332308ed38Sdrh   return m;
1834885a5b03Sdrh }
1835885a5b03Sdrh 
1836885a5b03Sdrh /*
18377e6f980bSdrh ** This is a SELECT-node callback for the expression walker that
18387e6f980bSdrh ** always "fails".  By "fail" in this case, we mean set
18397e6f980bSdrh ** pWalker->eCode to zero and abort.
18407e6f980bSdrh **
18417e6f980bSdrh ** This callback is used by multiple expression walkers.
18427e6f980bSdrh */
18437e6f980bSdrh int sqlite3SelectWalkFail(Walker *pWalker, Select *NotUsed){
18447e6f980bSdrh   UNUSED_PARAMETER(NotUsed);
18457e6f980bSdrh   pWalker->eCode = 0;
18467e6f980bSdrh   return WRC_Abort;
18477e6f980bSdrh }
18487e6f980bSdrh 
18497e6f980bSdrh /*
1850171d16bbSdrh ** If the input expression is an ID with the name "true" or "false"
185196acafbeSdrh ** then convert it into an TK_TRUEFALSE term.  Return non-zero if
185296acafbeSdrh ** the conversion happened, and zero if the expression is unaltered.
1853171d16bbSdrh */
1854171d16bbSdrh int sqlite3ExprIdToTrueFalse(Expr *pExpr){
1855171d16bbSdrh   assert( pExpr->op==TK_ID || pExpr->op==TK_STRING );
185651d35b0fSdrh   if( !ExprHasProperty(pExpr, EP_Quoted)
185751d35b0fSdrh    && (sqlite3StrICmp(pExpr->u.zToken, "true")==0
185851d35b0fSdrh        || sqlite3StrICmp(pExpr->u.zToken, "false")==0)
1859171d16bbSdrh   ){
1860171d16bbSdrh     pExpr->op = TK_TRUEFALSE;
1861ad31727fSdrh     ExprSetProperty(pExpr, pExpr->u.zToken[4]==0 ? EP_IsTrue : EP_IsFalse);
1862171d16bbSdrh     return 1;
1863171d16bbSdrh   }
1864171d16bbSdrh   return 0;
1865171d16bbSdrh }
1866171d16bbSdrh 
186743c4ac8bSdrh /*
186896acafbeSdrh ** The argument must be a TK_TRUEFALSE Expr node.  Return 1 if it is TRUE
186943c4ac8bSdrh ** and 0 if it is FALSE.
187043c4ac8bSdrh */
187196acafbeSdrh int sqlite3ExprTruthValue(const Expr *pExpr){
18726ece353fSdan   pExpr = sqlite3ExprSkipCollate((Expr*)pExpr);
187343c4ac8bSdrh   assert( pExpr->op==TK_TRUEFALSE );
187443c4ac8bSdrh   assert( sqlite3StrICmp(pExpr->u.zToken,"true")==0
187543c4ac8bSdrh        || sqlite3StrICmp(pExpr->u.zToken,"false")==0 );
187643c4ac8bSdrh   return pExpr->u.zToken[4]==0;
187743c4ac8bSdrh }
187843c4ac8bSdrh 
187917180fcaSdrh /*
188017180fcaSdrh ** If pExpr is an AND or OR expression, try to simplify it by eliminating
188117180fcaSdrh ** terms that are always true or false.  Return the simplified expression.
188217180fcaSdrh ** Or return the original expression if no simplification is possible.
188317180fcaSdrh **
188417180fcaSdrh ** Examples:
188517180fcaSdrh **
188617180fcaSdrh **     (x<10) AND true                =>   (x<10)
188717180fcaSdrh **     (x<10) AND false               =>   false
188817180fcaSdrh **     (x<10) AND (y=22 OR false)     =>   (x<10) AND (y=22)
188917180fcaSdrh **     (x<10) AND (y=22 OR true)      =>   (x<10)
189017180fcaSdrh **     (y=22) OR true                 =>   true
189117180fcaSdrh */
189217180fcaSdrh Expr *sqlite3ExprSimplifiedAndOr(Expr *pExpr){
189317180fcaSdrh   assert( pExpr!=0 );
189417180fcaSdrh   if( pExpr->op==TK_AND || pExpr->op==TK_OR ){
189517180fcaSdrh     Expr *pRight = sqlite3ExprSimplifiedAndOr(pExpr->pRight);
189617180fcaSdrh     Expr *pLeft = sqlite3ExprSimplifiedAndOr(pExpr->pLeft);
189717180fcaSdrh     if( ExprAlwaysTrue(pLeft) || ExprAlwaysFalse(pRight) ){
189817180fcaSdrh       pExpr = pExpr->op==TK_AND ? pRight : pLeft;
189917180fcaSdrh     }else if( ExprAlwaysTrue(pRight) || ExprAlwaysFalse(pLeft) ){
190017180fcaSdrh       pExpr = pExpr->op==TK_AND ? pLeft : pRight;
190117180fcaSdrh     }
190217180fcaSdrh   }
190317180fcaSdrh   return pExpr;
190417180fcaSdrh }
190517180fcaSdrh 
1906171d16bbSdrh 
1907171d16bbSdrh /*
1908059b2d50Sdrh ** These routines are Walker callbacks used to check expressions to
1909059b2d50Sdrh ** see if they are "constant" for some definition of constant.  The
1910059b2d50Sdrh ** Walker.eCode value determines the type of "constant" we are looking
1911059b2d50Sdrh ** for.
191273b211abSdrh **
19137d10d5a6Sdrh ** These callback routines are used to implement the following:
1914626a879aSdrh **
1915059b2d50Sdrh **     sqlite3ExprIsConstant()                  pWalker->eCode==1
1916059b2d50Sdrh **     sqlite3ExprIsConstantNotJoin()           pWalker->eCode==2
1917fcb9f4f3Sdrh **     sqlite3ExprIsTableConstant()             pWalker->eCode==3
1918059b2d50Sdrh **     sqlite3ExprIsConstantOrFunction()        pWalker->eCode==4 or 5
191987abf5c0Sdrh **
1920059b2d50Sdrh ** In all cases, the callbacks set Walker.eCode=0 and abort if the expression
1921059b2d50Sdrh ** is found to not be a constant.
192287abf5c0Sdrh **
1923feada2dfSdrh ** The sqlite3ExprIsConstantOrFunction() is used for evaluating expressions
1924059b2d50Sdrh ** in a CREATE TABLE statement.  The Walker.eCode value is 5 when parsing
1925059b2d50Sdrh ** an existing schema and 4 when processing a new statement.  A bound
1926feada2dfSdrh ** parameter raises an error for new statements, but is silently converted
1927feada2dfSdrh ** to NULL for existing schemas.  This allows sqlite_master tables that
1928feada2dfSdrh ** contain a bound parameter because they were generated by older versions
1929feada2dfSdrh ** of SQLite to be parsed by newer versions of SQLite without raising a
1930feada2dfSdrh ** malformed schema error.
1931626a879aSdrh */
19327d10d5a6Sdrh static int exprNodeIsConstant(Walker *pWalker, Expr *pExpr){
1933626a879aSdrh 
1934059b2d50Sdrh   /* If pWalker->eCode is 2 then any term of the expression that comes from
1935059b2d50Sdrh   ** the ON or USING clauses of a left join disqualifies the expression
19360a168377Sdrh   ** from being considered constant. */
1937059b2d50Sdrh   if( pWalker->eCode==2 && ExprHasProperty(pExpr, EP_FromJoin) ){
1938059b2d50Sdrh     pWalker->eCode = 0;
19397d10d5a6Sdrh     return WRC_Abort;
19400a168377Sdrh   }
19410a168377Sdrh 
1942626a879aSdrh   switch( pExpr->op ){
1943eb55bd2fSdrh     /* Consider functions to be constant if all their arguments are constant
1944059b2d50Sdrh     ** and either pWalker->eCode==4 or 5 or the function has the
1945059b2d50Sdrh     ** SQLITE_FUNC_CONST flag. */
1946eb55bd2fSdrh     case TK_FUNCTION:
194763f84573Sdrh       if( pWalker->eCode>=4 || ExprHasProperty(pExpr,EP_ConstFunc) ){
1948b1fba286Sdrh         return WRC_Continue;
1949059b2d50Sdrh       }else{
1950059b2d50Sdrh         pWalker->eCode = 0;
1951059b2d50Sdrh         return WRC_Abort;
1952b1fba286Sdrh       }
1953626a879aSdrh     case TK_ID:
1954171d16bbSdrh       /* Convert "true" or "false" in a DEFAULT clause into the
1955171d16bbSdrh       ** appropriate TK_TRUEFALSE operator */
1956e39ef31cSdrh       if( sqlite3ExprIdToTrueFalse(pExpr) ){
1957171d16bbSdrh         return WRC_Prune;
1958171d16bbSdrh       }
1959171d16bbSdrh       /* Fall thru */
1960626a879aSdrh     case TK_COLUMN:
1961626a879aSdrh     case TK_AGG_FUNCTION:
196213449892Sdrh     case TK_AGG_COLUMN:
1963c5499befSdrh       testcase( pExpr->op==TK_ID );
1964c5499befSdrh       testcase( pExpr->op==TK_COLUMN );
1965c5499befSdrh       testcase( pExpr->op==TK_AGG_FUNCTION );
1966c5499befSdrh       testcase( pExpr->op==TK_AGG_COLUMN );
196707aded63Sdrh       if( ExprHasProperty(pExpr, EP_FixedCol) && pWalker->eCode!=2 ){
1968efad2e23Sdrh         return WRC_Continue;
1969efad2e23Sdrh       }
1970059b2d50Sdrh       if( pWalker->eCode==3 && pExpr->iTable==pWalker->u.iCur ){
1971059b2d50Sdrh         return WRC_Continue;
1972f43ce0b4Sdrh       }
1973f43ce0b4Sdrh       /* Fall through */
1974f43ce0b4Sdrh     case TK_IF_NULL_ROW:
19756e341b93Sdrh     case TK_REGISTER:
19769916048bSdrh       testcase( pExpr->op==TK_REGISTER );
1977f43ce0b4Sdrh       testcase( pExpr->op==TK_IF_NULL_ROW );
1978059b2d50Sdrh       pWalker->eCode = 0;
19797d10d5a6Sdrh       return WRC_Abort;
1980feada2dfSdrh     case TK_VARIABLE:
1981059b2d50Sdrh       if( pWalker->eCode==5 ){
1982feada2dfSdrh         /* Silently convert bound parameters that appear inside of CREATE
1983feada2dfSdrh         ** statements into a NULL when parsing the CREATE statement text out
1984feada2dfSdrh         ** of the sqlite_master table */
1985feada2dfSdrh         pExpr->op = TK_NULL;
1986059b2d50Sdrh       }else if( pWalker->eCode==4 ){
1987feada2dfSdrh         /* A bound parameter in a CREATE statement that originates from
1988feada2dfSdrh         ** sqlite3_prepare() causes an error */
1989059b2d50Sdrh         pWalker->eCode = 0;
1990feada2dfSdrh         return WRC_Abort;
1991feada2dfSdrh       }
1992feada2dfSdrh       /* Fall through */
1993626a879aSdrh     default:
19946e341b93Sdrh       testcase( pExpr->op==TK_SELECT ); /* sqlite3SelectWalkFail() disallows */
19956e341b93Sdrh       testcase( pExpr->op==TK_EXISTS ); /* sqlite3SelectWalkFail() disallows */
19967d10d5a6Sdrh       return WRC_Continue;
1997626a879aSdrh   }
1998626a879aSdrh }
1999059b2d50Sdrh static int exprIsConst(Expr *p, int initFlag, int iCur){
20007d10d5a6Sdrh   Walker w;
2001059b2d50Sdrh   w.eCode = initFlag;
20027d10d5a6Sdrh   w.xExprCallback = exprNodeIsConstant;
20037e6f980bSdrh   w.xSelectCallback = sqlite3SelectWalkFail;
2004979dd1beSdrh #ifdef SQLITE_DEBUG
2005979dd1beSdrh   w.xSelectCallback2 = sqlite3SelectWalkAssert2;
2006979dd1beSdrh #endif
2007059b2d50Sdrh   w.u.iCur = iCur;
20087d10d5a6Sdrh   sqlite3WalkExpr(&w, p);
2009059b2d50Sdrh   return w.eCode;
20107d10d5a6Sdrh }
2011626a879aSdrh 
2012626a879aSdrh /*
2013059b2d50Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
2014eb55bd2fSdrh ** and 0 if it involves variables or function calls.
20152398937bSdrh **
20162398937bSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
20172398937bSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
20182398937bSdrh ** a constant.
2019fef5208cSdrh */
20204adee20fSdanielk1977 int sqlite3ExprIsConstant(Expr *p){
2021059b2d50Sdrh   return exprIsConst(p, 1, 0);
2022fef5208cSdrh }
2023fef5208cSdrh 
2024fef5208cSdrh /*
202507aded63Sdrh ** Walk an expression tree.  Return non-zero if
202607aded63Sdrh **
202707aded63Sdrh **   (1) the expression is constant, and
202807aded63Sdrh **   (2) the expression does originate in the ON or USING clause
202907aded63Sdrh **       of a LEFT JOIN, and
203007aded63Sdrh **   (3) the expression does not contain any EP_FixedCol TK_COLUMN
203107aded63Sdrh **       operands created by the constant propagation optimization.
203207aded63Sdrh **
203307aded63Sdrh ** When this routine returns true, it indicates that the expression
203407aded63Sdrh ** can be added to the pParse->pConstExpr list and evaluated once when
203507aded63Sdrh ** the prepared statement starts up.  See sqlite3ExprCodeAtInit().
20360a168377Sdrh */
20370a168377Sdrh int sqlite3ExprIsConstantNotJoin(Expr *p){
2038059b2d50Sdrh   return exprIsConst(p, 2, 0);
20390a168377Sdrh }
20400a168377Sdrh 
20410a168377Sdrh /*
2042fcb9f4f3Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
2043059b2d50Sdrh ** for any single row of the table with cursor iCur.  In other words, the
2044059b2d50Sdrh ** expression must not refer to any non-deterministic function nor any
2045059b2d50Sdrh ** table other than iCur.
2046059b2d50Sdrh */
2047059b2d50Sdrh int sqlite3ExprIsTableConstant(Expr *p, int iCur){
2048059b2d50Sdrh   return exprIsConst(p, 3, iCur);
2049059b2d50Sdrh }
2050059b2d50Sdrh 
2051ab31a845Sdan 
2052ab31a845Sdan /*
2053ab31a845Sdan ** sqlite3WalkExpr() callback used by sqlite3ExprIsConstantOrGroupBy().
2054ab31a845Sdan */
2055ab31a845Sdan static int exprNodeIsConstantOrGroupBy(Walker *pWalker, Expr *pExpr){
2056ab31a845Sdan   ExprList *pGroupBy = pWalker->u.pGroupBy;
2057ab31a845Sdan   int i;
2058ab31a845Sdan 
2059ab31a845Sdan   /* Check if pExpr is identical to any GROUP BY term. If so, consider
2060ab31a845Sdan   ** it constant.  */
2061ab31a845Sdan   for(i=0; i<pGroupBy->nExpr; i++){
2062ab31a845Sdan     Expr *p = pGroupBy->a[i].pExpr;
20635aa550cfSdan     if( sqlite3ExprCompare(0, pExpr, p, -1)<2 ){
206470efa84dSdrh       CollSeq *pColl = sqlite3ExprNNCollSeq(pWalker->pParse, p);
2065efad2e23Sdrh       if( sqlite3IsBinary(pColl) ){
2066ab31a845Sdan         return WRC_Prune;
2067ab31a845Sdan       }
2068ab31a845Sdan     }
2069ab31a845Sdan   }
2070ab31a845Sdan 
2071ab31a845Sdan   /* Check if pExpr is a sub-select. If so, consider it variable. */
2072ab31a845Sdan   if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2073ab31a845Sdan     pWalker->eCode = 0;
2074ab31a845Sdan     return WRC_Abort;
2075ab31a845Sdan   }
2076ab31a845Sdan 
2077ab31a845Sdan   return exprNodeIsConstant(pWalker, pExpr);
2078ab31a845Sdan }
2079ab31a845Sdan 
2080ab31a845Sdan /*
2081ab31a845Sdan ** Walk the expression tree passed as the first argument. Return non-zero
2082ab31a845Sdan ** if the expression consists entirely of constants or copies of terms
2083ab31a845Sdan ** in pGroupBy that sort with the BINARY collation sequence.
2084ab314001Sdrh **
2085ab314001Sdrh ** This routine is used to determine if a term of the HAVING clause can
2086ab314001Sdrh ** be promoted into the WHERE clause.  In order for such a promotion to work,
2087ab314001Sdrh ** the value of the HAVING clause term must be the same for all members of
2088ab314001Sdrh ** a "group".  The requirement that the GROUP BY term must be BINARY
2089ab314001Sdrh ** assumes that no other collating sequence will have a finer-grained
2090ab314001Sdrh ** grouping than binary.  In other words (A=B COLLATE binary) implies
2091ab314001Sdrh ** A=B in every other collating sequence.  The requirement that the
2092ab314001Sdrh ** GROUP BY be BINARY is stricter than necessary.  It would also work
2093ab314001Sdrh ** to promote HAVING clauses that use the same alternative collating
2094ab314001Sdrh ** sequence as the GROUP BY term, but that is much harder to check,
2095ab314001Sdrh ** alternative collating sequences are uncommon, and this is only an
2096ab314001Sdrh ** optimization, so we take the easy way out and simply require the
2097ab314001Sdrh ** GROUP BY to use the BINARY collating sequence.
2098ab31a845Sdan */
2099ab31a845Sdan int sqlite3ExprIsConstantOrGroupBy(Parse *pParse, Expr *p, ExprList *pGroupBy){
2100ab31a845Sdan   Walker w;
2101ab31a845Sdan   w.eCode = 1;
2102ab31a845Sdan   w.xExprCallback = exprNodeIsConstantOrGroupBy;
2103979dd1beSdrh   w.xSelectCallback = 0;
2104ab31a845Sdan   w.u.pGroupBy = pGroupBy;
2105ab31a845Sdan   w.pParse = pParse;
2106ab31a845Sdan   sqlite3WalkExpr(&w, p);
2107ab31a845Sdan   return w.eCode;
2108ab31a845Sdan }
2109ab31a845Sdan 
2110059b2d50Sdrh /*
2111059b2d50Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
2112eb55bd2fSdrh ** or a function call with constant arguments.  Return and 0 if there
2113eb55bd2fSdrh ** are any variables.
2114eb55bd2fSdrh **
2115eb55bd2fSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
2116eb55bd2fSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
2117eb55bd2fSdrh ** a constant.
2118eb55bd2fSdrh */
2119feada2dfSdrh int sqlite3ExprIsConstantOrFunction(Expr *p, u8 isInit){
2120feada2dfSdrh   assert( isInit==0 || isInit==1 );
2121059b2d50Sdrh   return exprIsConst(p, 4+isInit, 0);
2122eb55bd2fSdrh }
2123eb55bd2fSdrh 
21245b88bc4bSdrh #ifdef SQLITE_ENABLE_CURSOR_HINTS
21255b88bc4bSdrh /*
21265b88bc4bSdrh ** Walk an expression tree.  Return 1 if the expression contains a
21275b88bc4bSdrh ** subquery of some kind.  Return 0 if there are no subqueries.
21285b88bc4bSdrh */
21295b88bc4bSdrh int sqlite3ExprContainsSubquery(Expr *p){
21305b88bc4bSdrh   Walker w;
2131bec2476aSdrh   w.eCode = 1;
21325b88bc4bSdrh   w.xExprCallback = sqlite3ExprWalkNoop;
21337e6f980bSdrh   w.xSelectCallback = sqlite3SelectWalkFail;
2134979dd1beSdrh #ifdef SQLITE_DEBUG
2135979dd1beSdrh   w.xSelectCallback2 = sqlite3SelectWalkAssert2;
2136979dd1beSdrh #endif
21375b88bc4bSdrh   sqlite3WalkExpr(&w, p);
213807194bffSdrh   return w.eCode==0;
21395b88bc4bSdrh }
21405b88bc4bSdrh #endif
21415b88bc4bSdrh 
2142eb55bd2fSdrh /*
214373b211abSdrh ** If the expression p codes a constant integer that is small enough
2144202b2df7Sdrh ** to fit in a 32-bit integer, return 1 and put the value of the integer
2145202b2df7Sdrh ** in *pValue.  If the expression is not an integer or if it is too big
2146202b2df7Sdrh ** to fit in a signed 32-bit integer, return 0 and leave *pValue unchanged.
2147e4de1febSdrh */
21484adee20fSdanielk1977 int sqlite3ExprIsInteger(Expr *p, int *pValue){
214992b01d53Sdrh   int rc = 0;
21501d2d71a0Sdrh   if( NEVER(p==0) ) return 0;  /* Used to only happen following on OOM */
2151cd92e84dSdrh 
2152cd92e84dSdrh   /* If an expression is an integer literal that fits in a signed 32-bit
2153cd92e84dSdrh   ** integer, then the EP_IntValue flag will have already been set */
2154cd92e84dSdrh   assert( p->op!=TK_INTEGER || (p->flags & EP_IntValue)!=0
2155cd92e84dSdrh            || sqlite3GetInt32(p->u.zToken, &rc)==0 );
2156cd92e84dSdrh 
215792b01d53Sdrh   if( p->flags & EP_IntValue ){
215833e619fcSdrh     *pValue = p->u.iValue;
2159e4de1febSdrh     return 1;
2160e4de1febSdrh   }
216192b01d53Sdrh   switch( p->op ){
21624b59ab5eSdrh     case TK_UPLUS: {
216392b01d53Sdrh       rc = sqlite3ExprIsInteger(p->pLeft, pValue);
2164f6e369a1Sdrh       break;
21654b59ab5eSdrh     }
2166e4de1febSdrh     case TK_UMINUS: {
2167e4de1febSdrh       int v;
21684adee20fSdanielk1977       if( sqlite3ExprIsInteger(p->pLeft, &v) ){
2169f6418891Smistachkin         assert( v!=(-2147483647-1) );
2170e4de1febSdrh         *pValue = -v;
217192b01d53Sdrh         rc = 1;
2172e4de1febSdrh       }
2173e4de1febSdrh       break;
2174e4de1febSdrh     }
2175e4de1febSdrh     default: break;
2176e4de1febSdrh   }
217792b01d53Sdrh   return rc;
2178e4de1febSdrh }
2179e4de1febSdrh 
2180e4de1febSdrh /*
2181039fc32eSdrh ** Return FALSE if there is no chance that the expression can be NULL.
2182039fc32eSdrh **
2183039fc32eSdrh ** If the expression might be NULL or if the expression is too complex
2184039fc32eSdrh ** to tell return TRUE.
2185039fc32eSdrh **
2186039fc32eSdrh ** This routine is used as an optimization, to skip OP_IsNull opcodes
2187039fc32eSdrh ** when we know that a value cannot be NULL.  Hence, a false positive
2188039fc32eSdrh ** (returning TRUE when in fact the expression can never be NULL) might
2189039fc32eSdrh ** be a small performance hit but is otherwise harmless.  On the other
2190039fc32eSdrh ** hand, a false negative (returning FALSE when the result could be NULL)
2191039fc32eSdrh ** will likely result in an incorrect answer.  So when in doubt, return
2192039fc32eSdrh ** TRUE.
2193039fc32eSdrh */
2194039fc32eSdrh int sqlite3ExprCanBeNull(const Expr *p){
2195039fc32eSdrh   u8 op;
21969bfb0794Sdrh   while( p->op==TK_UPLUS || p->op==TK_UMINUS ){
21979bfb0794Sdrh     p = p->pLeft;
21989bfb0794Sdrh   }
2199039fc32eSdrh   op = p->op;
2200039fc32eSdrh   if( op==TK_REGISTER ) op = p->op2;
2201039fc32eSdrh   switch( op ){
2202039fc32eSdrh     case TK_INTEGER:
2203039fc32eSdrh     case TK_STRING:
2204039fc32eSdrh     case TK_FLOAT:
2205039fc32eSdrh     case TK_BLOB:
2206039fc32eSdrh       return 0;
22077248a8b2Sdrh     case TK_COLUMN:
220872673a24Sdrh       return ExprHasProperty(p, EP_CanBeNull) ||
2209eda079cdSdrh              p->y.pTab==0 ||  /* Reference to column of index on expression */
2210eda079cdSdrh              (p->iColumn>=0 && p->y.pTab->aCol[p->iColumn].notNull==0);
2211039fc32eSdrh     default:
2212039fc32eSdrh       return 1;
2213039fc32eSdrh   }
2214039fc32eSdrh }
2215039fc32eSdrh 
2216039fc32eSdrh /*
2217039fc32eSdrh ** Return TRUE if the given expression is a constant which would be
2218039fc32eSdrh ** unchanged by OP_Affinity with the affinity given in the second
2219039fc32eSdrh ** argument.
2220039fc32eSdrh **
2221039fc32eSdrh ** This routine is used to determine if the OP_Affinity operation
2222039fc32eSdrh ** can be omitted.  When in doubt return FALSE.  A false negative
2223039fc32eSdrh ** is harmless.  A false positive, however, can result in the wrong
2224039fc32eSdrh ** answer.
2225039fc32eSdrh */
2226039fc32eSdrh int sqlite3ExprNeedsNoAffinityChange(const Expr *p, char aff){
2227039fc32eSdrh   u8 op;
2228af866402Sdrh   int unaryMinus = 0;
222905883a34Sdrh   if( aff==SQLITE_AFF_BLOB ) return 1;
2230af866402Sdrh   while( p->op==TK_UPLUS || p->op==TK_UMINUS ){
2231af866402Sdrh     if( p->op==TK_UMINUS ) unaryMinus = 1;
2232af866402Sdrh     p = p->pLeft;
2233af866402Sdrh   }
2234039fc32eSdrh   op = p->op;
2235039fc32eSdrh   if( op==TK_REGISTER ) op = p->op2;
2236039fc32eSdrh   switch( op ){
2237039fc32eSdrh     case TK_INTEGER: {
22386a19865fSdrh       return aff>=SQLITE_AFF_NUMERIC;
2239039fc32eSdrh     }
2240039fc32eSdrh     case TK_FLOAT: {
22416a19865fSdrh       return aff>=SQLITE_AFF_NUMERIC;
2242039fc32eSdrh     }
2243039fc32eSdrh     case TK_STRING: {
2244af866402Sdrh       return !unaryMinus && aff==SQLITE_AFF_TEXT;
2245039fc32eSdrh     }
2246039fc32eSdrh     case TK_BLOB: {
2247af866402Sdrh       return !unaryMinus;
2248039fc32eSdrh     }
22492f2855b6Sdrh     case TK_COLUMN: {
225088376ca7Sdrh       assert( p->iTable>=0 );  /* p cannot be part of a CHECK constraint */
22516a19865fSdrh       return aff>=SQLITE_AFF_NUMERIC && p->iColumn<0;
22522f2855b6Sdrh     }
2253039fc32eSdrh     default: {
2254039fc32eSdrh       return 0;
2255039fc32eSdrh     }
2256039fc32eSdrh   }
2257039fc32eSdrh }
2258039fc32eSdrh 
2259039fc32eSdrh /*
2260c4a3c779Sdrh ** Return TRUE if the given string is a row-id column name.
2261c4a3c779Sdrh */
22624adee20fSdanielk1977 int sqlite3IsRowid(const char *z){
22634adee20fSdanielk1977   if( sqlite3StrICmp(z, "_ROWID_")==0 ) return 1;
22644adee20fSdanielk1977   if( sqlite3StrICmp(z, "ROWID")==0 ) return 1;
22654adee20fSdanielk1977   if( sqlite3StrICmp(z, "OID")==0 ) return 1;
2266c4a3c779Sdrh   return 0;
2267c4a3c779Sdrh }
2268c4a3c779Sdrh 
22699a96b668Sdanielk1977 /*
227069c355bdSdrh ** pX is the RHS of an IN operator.  If pX is a SELECT statement
227169c355bdSdrh ** that can be simplified to a direct table access, then return
227269c355bdSdrh ** a pointer to the SELECT statement.  If pX is not a SELECT statement,
227369c355bdSdrh ** or if the SELECT statement needs to be manifested into a transient
227469c355bdSdrh ** table, then return NULL.
2275b287f4b6Sdrh */
2276b287f4b6Sdrh #ifndef SQLITE_OMIT_SUBQUERY
22777b35a77bSdan static Select *isCandidateForInOpt(Expr *pX){
227869c355bdSdrh   Select *p;
2279b287f4b6Sdrh   SrcList *pSrc;
2280b287f4b6Sdrh   ExprList *pEList;
2281b287f4b6Sdrh   Table *pTab;
2282cfbb5e82Sdan   int i;
228369c355bdSdrh   if( !ExprHasProperty(pX, EP_xIsSelect) ) return 0;  /* Not a subquery */
228469c355bdSdrh   if( ExprHasProperty(pX, EP_VarSelect)  ) return 0;  /* Correlated subq */
228569c355bdSdrh   p = pX->x.pSelect;
2286b287f4b6Sdrh   if( p->pPrior ) return 0;              /* Not a compound SELECT */
22877d10d5a6Sdrh   if( p->selFlags & (SF_Distinct|SF_Aggregate) ){
2288b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
2289b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
22907d10d5a6Sdrh     return 0; /* No DISTINCT keyword and no aggregate functions */
22917d10d5a6Sdrh   }
2292b74b1017Sdrh   assert( p->pGroupBy==0 );              /* Has no GROUP BY clause */
2293b287f4b6Sdrh   if( p->pLimit ) return 0;              /* Has no LIMIT clause */
2294b287f4b6Sdrh   if( p->pWhere ) return 0;              /* Has no WHERE clause */
2295b287f4b6Sdrh   pSrc = p->pSrc;
2296d1fa7bcaSdrh   assert( pSrc!=0 );
2297d1fa7bcaSdrh   if( pSrc->nSrc!=1 ) return 0;          /* Single term in FROM clause */
2298b74b1017Sdrh   if( pSrc->a[0].pSelect ) return 0;     /* FROM is not a subquery or view */
2299b287f4b6Sdrh   pTab = pSrc->a[0].pTab;
230069c355bdSdrh   assert( pTab!=0 );
2301b74b1017Sdrh   assert( pTab->pSelect==0 );            /* FROM clause is not a view */
2302b287f4b6Sdrh   if( IsVirtual(pTab) ) return 0;        /* FROM clause not a virtual table */
2303b287f4b6Sdrh   pEList = p->pEList;
2304ac6b47d1Sdrh   assert( pEList!=0 );
23057b35a77bSdan   /* All SELECT results must be columns. */
2306cfbb5e82Sdan   for(i=0; i<pEList->nExpr; i++){
2307cfbb5e82Sdan     Expr *pRes = pEList->a[i].pExpr;
2308cfbb5e82Sdan     if( pRes->op!=TK_COLUMN ) return 0;
230969c355bdSdrh     assert( pRes->iTable==pSrc->a[0].iCursor );  /* Not a correlated subquery */
2310cfbb5e82Sdan   }
231169c355bdSdrh   return p;
2312b287f4b6Sdrh }
2313b287f4b6Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
2314b287f4b6Sdrh 
2315f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
23161d8cb21fSdan /*
23174c259e9fSdrh ** Generate code that checks the left-most column of index table iCur to see if
23184c259e9fSdrh ** it contains any NULL entries.  Cause the register at regHasNull to be set
23196be515ebSdrh ** to a non-NULL value if iCur contains no NULLs.  Cause register regHasNull
23206be515ebSdrh ** to be set to NULL if iCur contains one or more NULL values.
23216be515ebSdrh */
23226be515ebSdrh static void sqlite3SetHasNullFlag(Vdbe *v, int iCur, int regHasNull){
2323728e0f91Sdrh   int addr1;
23246be515ebSdrh   sqlite3VdbeAddOp2(v, OP_Integer, 0, regHasNull);
2325728e0f91Sdrh   addr1 = sqlite3VdbeAddOp1(v, OP_Rewind, iCur); VdbeCoverage(v);
23266be515ebSdrh   sqlite3VdbeAddOp3(v, OP_Column, iCur, 0, regHasNull);
23276be515ebSdrh   sqlite3VdbeChangeP5(v, OPFLAG_TYPEOFARG);
23284c259e9fSdrh   VdbeComment((v, "first_entry_in(%d)", iCur));
2329728e0f91Sdrh   sqlite3VdbeJumpHere(v, addr1);
23306be515ebSdrh }
2331f9b2e05cSdan #endif
23326be515ebSdrh 
2333bb53ecb1Sdrh 
2334bb53ecb1Sdrh #ifndef SQLITE_OMIT_SUBQUERY
2335bb53ecb1Sdrh /*
2336bb53ecb1Sdrh ** The argument is an IN operator with a list (not a subquery) on the
2337bb53ecb1Sdrh ** right-hand side.  Return TRUE if that list is constant.
2338bb53ecb1Sdrh */
2339bb53ecb1Sdrh static int sqlite3InRhsIsConstant(Expr *pIn){
2340bb53ecb1Sdrh   Expr *pLHS;
2341bb53ecb1Sdrh   int res;
2342bb53ecb1Sdrh   assert( !ExprHasProperty(pIn, EP_xIsSelect) );
2343bb53ecb1Sdrh   pLHS = pIn->pLeft;
2344bb53ecb1Sdrh   pIn->pLeft = 0;
2345bb53ecb1Sdrh   res = sqlite3ExprIsConstant(pIn);
2346bb53ecb1Sdrh   pIn->pLeft = pLHS;
2347bb53ecb1Sdrh   return res;
2348bb53ecb1Sdrh }
2349bb53ecb1Sdrh #endif
2350bb53ecb1Sdrh 
23516be515ebSdrh /*
23529a96b668Sdanielk1977 ** This function is used by the implementation of the IN (...) operator.
2353d4305ca6Sdrh ** The pX parameter is the expression on the RHS of the IN operator, which
2354d4305ca6Sdrh ** might be either a list of expressions or a subquery.
23559a96b668Sdanielk1977 **
2356d4305ca6Sdrh ** The job of this routine is to find or create a b-tree object that can
2357d4305ca6Sdrh ** be used either to test for membership in the RHS set or to iterate through
2358d4305ca6Sdrh ** all members of the RHS set, skipping duplicates.
2359d4305ca6Sdrh **
23603a85625dSdrh ** A cursor is opened on the b-tree object that is the RHS of the IN operator
2361d4305ca6Sdrh ** and pX->iTable is set to the index of that cursor.
2362d4305ca6Sdrh **
2363b74b1017Sdrh ** The returned value of this function indicates the b-tree type, as follows:
23649a96b668Sdanielk1977 **
23659a96b668Sdanielk1977 **   IN_INDEX_ROWID      - The cursor was opened on a database table.
23661ccce449Sdrh **   IN_INDEX_INDEX_ASC  - The cursor was opened on an ascending index.
23671ccce449Sdrh **   IN_INDEX_INDEX_DESC - The cursor was opened on a descending index.
23689a96b668Sdanielk1977 **   IN_INDEX_EPH        - The cursor was opened on a specially created and
23699a96b668Sdanielk1977 **                         populated epheremal table.
2370bb53ecb1Sdrh **   IN_INDEX_NOOP       - No cursor was allocated.  The IN operator must be
2371bb53ecb1Sdrh **                         implemented as a sequence of comparisons.
23729a96b668Sdanielk1977 **
2373d4305ca6Sdrh ** An existing b-tree might be used if the RHS expression pX is a simple
2374d4305ca6Sdrh ** subquery such as:
23759a96b668Sdanielk1977 **
2376553168c7Sdan **     SELECT <column1>, <column2>... FROM <table>
23779a96b668Sdanielk1977 **
2378d4305ca6Sdrh ** If the RHS of the IN operator is a list or a more complex subquery, then
2379d4305ca6Sdrh ** an ephemeral table might need to be generated from the RHS and then
238060ec914cSpeter.d.reid ** pX->iTable made to point to the ephemeral table instead of an
2381d4305ca6Sdrh ** existing table.
2382d4305ca6Sdrh **
23837fc0ba0fSdrh ** The inFlags parameter must contain, at a minimum, one of the bits
23847fc0ba0fSdrh ** IN_INDEX_MEMBERSHIP or IN_INDEX_LOOP but not both.  If inFlags contains
23857fc0ba0fSdrh ** IN_INDEX_MEMBERSHIP, then the generated table will be used for a fast
23867fc0ba0fSdrh ** membership test.  When the IN_INDEX_LOOP bit is set, the IN index will
23877fc0ba0fSdrh ** be used to loop over all values of the RHS of the IN operator.
23883a85625dSdrh **
23893a85625dSdrh ** When IN_INDEX_LOOP is used (and the b-tree will be used to iterate
23903a85625dSdrh ** through the set members) then the b-tree must not contain duplicates.
23917fc0ba0fSdrh ** An epheremal table will be created unless the selected columns are guaranteed
2392553168c7Sdan ** to be unique - either because it is an INTEGER PRIMARY KEY or due to
2393553168c7Sdan ** a UNIQUE constraint or index.
23940cdc022eSdanielk1977 **
23953a85625dSdrh ** When IN_INDEX_MEMBERSHIP is used (and the b-tree will be used
23963a85625dSdrh ** for fast set membership tests) then an epheremal table must
2397553168c7Sdan ** be used unless <columns> is a single INTEGER PRIMARY KEY column or an
2398553168c7Sdan ** index can be found with the specified <columns> as its left-most.
23990cdc022eSdanielk1977 **
2400bb53ecb1Sdrh ** If the IN_INDEX_NOOP_OK and IN_INDEX_MEMBERSHIP are both set and
2401bb53ecb1Sdrh ** if the RHS of the IN operator is a list (not a subquery) then this
2402bb53ecb1Sdrh ** routine might decide that creating an ephemeral b-tree for membership
2403bb53ecb1Sdrh ** testing is too expensive and return IN_INDEX_NOOP.  In that case, the
2404bb53ecb1Sdrh ** calling routine should implement the IN operator using a sequence
2405bb53ecb1Sdrh ** of Eq or Ne comparison operations.
2406bb53ecb1Sdrh **
2407b74b1017Sdrh ** When the b-tree is being used for membership tests, the calling function
24083a85625dSdrh ** might need to know whether or not the RHS side of the IN operator
2409e21a6e1dSdrh ** contains a NULL.  If prRhsHasNull is not a NULL pointer and
24103a85625dSdrh ** if there is any chance that the (...) might contain a NULL value at
24110cdc022eSdanielk1977 ** runtime, then a register is allocated and the register number written
2412e21a6e1dSdrh ** to *prRhsHasNull. If there is no chance that the (...) contains a
2413e21a6e1dSdrh ** NULL value, then *prRhsHasNull is left unchanged.
24140cdc022eSdanielk1977 **
2415e21a6e1dSdrh ** If a register is allocated and its location stored in *prRhsHasNull, then
24166be515ebSdrh ** the value in that register will be NULL if the b-tree contains one or more
24176be515ebSdrh ** NULL values, and it will be some non-NULL value if the b-tree contains no
24186be515ebSdrh ** NULL values.
2419553168c7Sdan **
2420553168c7Sdan ** If the aiMap parameter is not NULL, it must point to an array containing
2421553168c7Sdan ** one element for each column returned by the SELECT statement on the RHS
2422553168c7Sdan ** of the IN(...) operator. The i'th entry of the array is populated with the
2423553168c7Sdan ** offset of the index column that matches the i'th column returned by the
2424553168c7Sdan ** SELECT. For example, if the expression and selected index are:
2425553168c7Sdan **
2426553168c7Sdan **   (?,?,?) IN (SELECT a, b, c FROM t1)
2427553168c7Sdan **   CREATE INDEX i1 ON t1(b, c, a);
2428553168c7Sdan **
2429553168c7Sdan ** then aiMap[] is populated with {2, 0, 1}.
24309a96b668Sdanielk1977 */
2431284f4acaSdanielk1977 #ifndef SQLITE_OMIT_SUBQUERY
2432ba00e30aSdan int sqlite3FindInIndex(
24336fc8f364Sdrh   Parse *pParse,             /* Parsing context */
24340167ef20Sdrh   Expr *pX,                  /* The IN expression */
24356fc8f364Sdrh   u32 inFlags,               /* IN_INDEX_LOOP, _MEMBERSHIP, and/or _NOOP_OK */
24366fc8f364Sdrh   int *prRhsHasNull,         /* Register holding NULL status.  See notes */
24372c04131cSdrh   int *aiMap,                /* Mapping from Index fields to RHS fields */
24382c04131cSdrh   int *piTab                 /* OUT: index to use */
2439ba00e30aSdan ){
2440b74b1017Sdrh   Select *p;                            /* SELECT to the right of IN operator */
2441b74b1017Sdrh   int eType = 0;                        /* Type of RHS table. IN_INDEX_* */
2442b74b1017Sdrh   int iTab = pParse->nTab++;            /* Cursor of the RHS table */
24433a85625dSdrh   int mustBeUnique;                     /* True if RHS must be unique */
2444b8475df8Sdrh   Vdbe *v = sqlite3GetVdbe(pParse);     /* Virtual machine being coded */
24459a96b668Sdanielk1977 
24461450bc6eSdrh   assert( pX->op==TK_IN );
24473a85625dSdrh   mustBeUnique = (inFlags & IN_INDEX_LOOP)!=0;
24481450bc6eSdrh 
24497b35a77bSdan   /* If the RHS of this IN(...) operator is a SELECT, and if it matters
24507b35a77bSdan   ** whether or not the SELECT result contains NULL values, check whether
2451870a0705Sdan   ** or not NULL is actually possible (it may not be, for example, due
24527b35a77bSdan   ** to NOT NULL constraints in the schema). If no NULL values are possible,
2453870a0705Sdan   ** set prRhsHasNull to 0 before continuing.  */
24547b35a77bSdan   if( prRhsHasNull && (pX->flags & EP_xIsSelect) ){
24557b35a77bSdan     int i;
24567b35a77bSdan     ExprList *pEList = pX->x.pSelect->pEList;
24577b35a77bSdan     for(i=0; i<pEList->nExpr; i++){
24587b35a77bSdan       if( sqlite3ExprCanBeNull(pEList->a[i].pExpr) ) break;
24597b35a77bSdan     }
24607b35a77bSdan     if( i==pEList->nExpr ){
24617b35a77bSdan       prRhsHasNull = 0;
24627b35a77bSdan     }
24637b35a77bSdan   }
24647b35a77bSdan 
2465b74b1017Sdrh   /* Check to see if an existing table or index can be used to
2466b74b1017Sdrh   ** satisfy the query.  This is preferable to generating a new
24677b35a77bSdan   ** ephemeral table.  */
24687b35a77bSdan   if( pParse->nErr==0 && (p = isCandidateForInOpt(pX))!=0 ){
2469e1fb65a0Sdanielk1977     sqlite3 *db = pParse->db;              /* Database connection */
2470b07028f7Sdrh     Table *pTab;                           /* Table <table>. */
2471ba00e30aSdan     i16 iDb;                               /* Database idx for pTab */
2472cfbb5e82Sdan     ExprList *pEList = p->pEList;
2473cfbb5e82Sdan     int nExpr = pEList->nExpr;
2474e1fb65a0Sdanielk1977 
2475b07028f7Sdrh     assert( p->pEList!=0 );             /* Because of isCandidateForInOpt(p) */
2476b07028f7Sdrh     assert( p->pEList->a[0].pExpr!=0 ); /* Because of isCandidateForInOpt(p) */
2477b07028f7Sdrh     assert( p->pSrc!=0 );               /* Because of isCandidateForInOpt(p) */
2478b07028f7Sdrh     pTab = p->pSrc->a[0].pTab;
2479b07028f7Sdrh 
2480b22f7c83Sdrh     /* Code an OP_Transaction and OP_TableLock for <table>. */
2481e1fb65a0Sdanielk1977     iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
2482e1fb65a0Sdanielk1977     sqlite3CodeVerifySchema(pParse, iDb);
2483e1fb65a0Sdanielk1977     sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
24849a96b668Sdanielk1977 
2485a84a283dSdrh     assert(v);  /* sqlite3GetVdbe() has always been previously called */
2486cfbb5e82Sdan     if( nExpr==1 && pEList->a[0].pExpr->iColumn<0 ){
248762659b2aSdrh       /* The "x IN (SELECT rowid FROM table)" case */
2488511f9e8dSdrh       int iAddr = sqlite3VdbeAddOp0(v, OP_Once);
24897d176105Sdrh       VdbeCoverage(v);
24909a96b668Sdanielk1977 
24919a96b668Sdanielk1977       sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
24929a96b668Sdanielk1977       eType = IN_INDEX_ROWID;
2493d8852095Sdrh       ExplainQueryPlan((pParse, 0,
2494d8852095Sdrh             "USING ROWID SEARCH ON TABLE %s FOR IN-OPERATOR",pTab->zName));
24959a96b668Sdanielk1977       sqlite3VdbeJumpHere(v, iAddr);
24969a96b668Sdanielk1977     }else{
2497e1fb65a0Sdanielk1977       Index *pIdx;                         /* Iterator variable */
2498cfbb5e82Sdan       int affinity_ok = 1;
2499cfbb5e82Sdan       int i;
2500cfbb5e82Sdan 
2501cfbb5e82Sdan       /* Check that the affinity that will be used to perform each
250262659b2aSdrh       ** comparison is the same as the affinity of each column in table
250362659b2aSdrh       ** on the RHS of the IN operator.  If it not, it is not possible to
250462659b2aSdrh       ** use any index of the RHS table.  */
2505cfbb5e82Sdan       for(i=0; i<nExpr && affinity_ok; i++){
2506fc7f27b9Sdrh         Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2507cfbb5e82Sdan         int iCol = pEList->a[i].pExpr->iColumn;
25080dfa4f6fSdrh         char idxaff = sqlite3TableColumnAffinity(pTab,iCol); /* RHS table */
2509cfbb5e82Sdan         char cmpaff = sqlite3CompareAffinity(pLhs, idxaff);
251062659b2aSdrh         testcase( cmpaff==SQLITE_AFF_BLOB );
251162659b2aSdrh         testcase( cmpaff==SQLITE_AFF_TEXT );
2512cfbb5e82Sdan         switch( cmpaff ){
2513cfbb5e82Sdan           case SQLITE_AFF_BLOB:
2514cfbb5e82Sdan             break;
2515cfbb5e82Sdan           case SQLITE_AFF_TEXT:
251662659b2aSdrh             /* sqlite3CompareAffinity() only returns TEXT if one side or the
251762659b2aSdrh             ** other has no affinity and the other side is TEXT.  Hence,
251862659b2aSdrh             ** the only way for cmpaff to be TEXT is for idxaff to be TEXT
251962659b2aSdrh             ** and for the term on the LHS of the IN to have no affinity. */
252062659b2aSdrh             assert( idxaff==SQLITE_AFF_TEXT );
2521cfbb5e82Sdan             break;
2522cfbb5e82Sdan           default:
2523cfbb5e82Sdan             affinity_ok = sqlite3IsNumericAffinity(idxaff);
2524cfbb5e82Sdan         }
2525cfbb5e82Sdan       }
2526e1fb65a0Sdanielk1977 
2527a84a283dSdrh       if( affinity_ok ){
2528a84a283dSdrh         /* Search for an existing index that will work for this IN operator */
2529a84a283dSdrh         for(pIdx=pTab->pIndex; pIdx && eType==0; pIdx=pIdx->pNext){
2530a84a283dSdrh           Bitmask colUsed;      /* Columns of the index used */
2531a84a283dSdrh           Bitmask mCol;         /* Mask for the current column */
25326fc8f364Sdrh           if( pIdx->nColumn<nExpr ) continue;
2533d4a4a361Sdrh           if( pIdx->pPartIdxWhere!=0 ) continue;
2534a84a283dSdrh           /* Maximum nColumn is BMS-2, not BMS-1, so that we can compute
2535a84a283dSdrh           ** BITMASK(nExpr) without overflowing */
2536a84a283dSdrh           testcase( pIdx->nColumn==BMS-2 );
2537a84a283dSdrh           testcase( pIdx->nColumn==BMS-1 );
2538a84a283dSdrh           if( pIdx->nColumn>=BMS-1 ) continue;
25396fc8f364Sdrh           if( mustBeUnique ){
25406fc8f364Sdrh             if( pIdx->nKeyCol>nExpr
25416fc8f364Sdrh              ||(pIdx->nColumn>nExpr && !IsUniqueIndex(pIdx))
25426fc8f364Sdrh             ){
2543a84a283dSdrh               continue;  /* This index is not unique over the IN RHS columns */
2544cfbb5e82Sdan             }
25456fc8f364Sdrh           }
2546cfbb5e82Sdan 
2547a84a283dSdrh           colUsed = 0;   /* Columns of index used so far */
2548cfbb5e82Sdan           for(i=0; i<nExpr; i++){
2549fc7f27b9Sdrh             Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2550cfbb5e82Sdan             Expr *pRhs = pEList->a[i].pExpr;
2551cfbb5e82Sdan             CollSeq *pReq = sqlite3BinaryCompareCollSeq(pParse, pLhs, pRhs);
2552cfbb5e82Sdan             int j;
2553cfbb5e82Sdan 
25546fc8f364Sdrh             assert( pReq!=0 || pRhs->iColumn==XN_ROWID || pParse->nErr );
2555cfbb5e82Sdan             for(j=0; j<nExpr; j++){
2556cfbb5e82Sdan               if( pIdx->aiColumn[j]!=pRhs->iColumn ) continue;
2557cfbb5e82Sdan               assert( pIdx->azColl[j] );
2558106526e1Sdrh               if( pReq!=0 && sqlite3StrICmp(pReq->zName, pIdx->azColl[j])!=0 ){
2559106526e1Sdrh                 continue;
2560106526e1Sdrh               }
2561cfbb5e82Sdan               break;
2562cfbb5e82Sdan             }
2563cfbb5e82Sdan             if( j==nExpr ) break;
2564a84a283dSdrh             mCol = MASKBIT(j);
2565a84a283dSdrh             if( mCol & colUsed ) break; /* Each column used only once */
2566a84a283dSdrh             colUsed |= mCol;
2567ba00e30aSdan             if( aiMap ) aiMap[i] = j;
2568cfbb5e82Sdan           }
2569cfbb5e82Sdan 
2570a84a283dSdrh           assert( i==nExpr || colUsed!=(MASKBIT(nExpr)-1) );
2571a84a283dSdrh           if( colUsed==(MASKBIT(nExpr)-1) ){
2572a84a283dSdrh             /* If we reach this point, that means the index pIdx is usable */
2573511f9e8dSdrh             int iAddr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
2574e2ca99c9Sdrh             ExplainQueryPlan((pParse, 0,
2575e2ca99c9Sdrh                               "USING INDEX %s FOR IN-OPERATOR",pIdx->zName));
25762ec2fb22Sdrh             sqlite3VdbeAddOp3(v, OP_OpenRead, iTab, pIdx->tnum, iDb);
25772ec2fb22Sdrh             sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
2578207872a4Sdanielk1977             VdbeComment((v, "%s", pIdx->zName));
25791ccce449Sdrh             assert( IN_INDEX_INDEX_DESC == IN_INDEX_INDEX_ASC+1 );
25801ccce449Sdrh             eType = IN_INDEX_INDEX_ASC + pIdx->aSortOrder[0];
25819a96b668Sdanielk1977 
25827b35a77bSdan             if( prRhsHasNull ){
25833480bfdaSdan #ifdef SQLITE_ENABLE_COLUMN_USED_MASK
2584cfbb5e82Sdan               i64 mask = (1<<nExpr)-1;
25853480bfdaSdan               sqlite3VdbeAddOp4Dup8(v, OP_ColumnsUsed,
2586cfbb5e82Sdan                   iTab, 0, 0, (u8*)&mask, P4_INT64);
25873480bfdaSdan #endif
2588b80dbdc2Sdrh               *prRhsHasNull = ++pParse->nMem;
25897b35a77bSdan               if( nExpr==1 ){
25906be515ebSdrh                 sqlite3SetHasNullFlag(v, iTab, *prRhsHasNull);
25910cdc022eSdanielk1977               }
25927b35a77bSdan             }
2593552fd454Sdrh             sqlite3VdbeJumpHere(v, iAddr);
25949a96b668Sdanielk1977           }
2595a84a283dSdrh         } /* End loop over indexes */
2596a84a283dSdrh       } /* End if( affinity_ok ) */
2597a84a283dSdrh     } /* End if not an rowid index */
2598a84a283dSdrh   } /* End attempt to optimize using an index */
25999a96b668Sdanielk1977 
2600bb53ecb1Sdrh   /* If no preexisting index is available for the IN clause
2601bb53ecb1Sdrh   ** and IN_INDEX_NOOP is an allowed reply
2602bb53ecb1Sdrh   ** and the RHS of the IN operator is a list, not a subquery
260371c57db0Sdan   ** and the RHS is not constant or has two or fewer terms,
260460ec914cSpeter.d.reid   ** then it is not worth creating an ephemeral table to evaluate
2605bb53ecb1Sdrh   ** the IN operator so return IN_INDEX_NOOP.
2606bb53ecb1Sdrh   */
2607bb53ecb1Sdrh   if( eType==0
2608bb53ecb1Sdrh    && (inFlags & IN_INDEX_NOOP_OK)
2609bb53ecb1Sdrh    && !ExprHasProperty(pX, EP_xIsSelect)
2610bb53ecb1Sdrh    && (!sqlite3InRhsIsConstant(pX) || pX->x.pList->nExpr<=2)
2611bb53ecb1Sdrh   ){
2612bb53ecb1Sdrh     eType = IN_INDEX_NOOP;
2613bb53ecb1Sdrh   }
2614bb53ecb1Sdrh 
26159a96b668Sdanielk1977   if( eType==0 ){
26164387006cSdrh     /* Could not find an existing table or index to use as the RHS b-tree.
2617b74b1017Sdrh     ** We will have to generate an ephemeral table to do the job.
2618b74b1017Sdrh     */
26198e23daf3Sdrh     u32 savedNQueryLoop = pParse->nQueryLoop;
26200cdc022eSdanielk1977     int rMayHaveNull = 0;
262141a05b7bSdanielk1977     eType = IN_INDEX_EPH;
26223a85625dSdrh     if( inFlags & IN_INDEX_LOOP ){
26234a5acf8eSdrh       pParse->nQueryLoop = 0;
2624e21a6e1dSdrh     }else if( prRhsHasNull ){
2625e21a6e1dSdrh       *prRhsHasNull = rMayHaveNull = ++pParse->nMem;
2626cf4d38aaSdrh     }
262785bcdce2Sdrh     assert( pX->op==TK_IN );
262850ef6716Sdrh     sqlite3CodeRhsOfIN(pParse, pX, iTab);
262985bcdce2Sdrh     if( rMayHaveNull ){
26302c04131cSdrh       sqlite3SetHasNullFlag(v, iTab, rMayHaveNull);
263185bcdce2Sdrh     }
2632cf4d38aaSdrh     pParse->nQueryLoop = savedNQueryLoop;
26339a96b668Sdanielk1977   }
2634ba00e30aSdan 
2635ba00e30aSdan   if( aiMap && eType!=IN_INDEX_INDEX_ASC && eType!=IN_INDEX_INDEX_DESC ){
2636ba00e30aSdan     int i, n;
2637ba00e30aSdan     n = sqlite3ExprVectorSize(pX->pLeft);
2638ba00e30aSdan     for(i=0; i<n; i++) aiMap[i] = i;
2639ba00e30aSdan   }
26402c04131cSdrh   *piTab = iTab;
26419a96b668Sdanielk1977   return eType;
26429a96b668Sdanielk1977 }
2643284f4acaSdanielk1977 #endif
2644626a879aSdrh 
2645f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
2646553168c7Sdan /*
2647553168c7Sdan ** Argument pExpr is an (?, ?...) IN(...) expression. This
2648553168c7Sdan ** function allocates and returns a nul-terminated string containing
2649553168c7Sdan ** the affinities to be used for each column of the comparison.
2650553168c7Sdan **
2651553168c7Sdan ** It is the responsibility of the caller to ensure that the returned
2652553168c7Sdan ** string is eventually freed using sqlite3DbFree().
2653553168c7Sdan */
265471c57db0Sdan static char *exprINAffinity(Parse *pParse, Expr *pExpr){
265571c57db0Sdan   Expr *pLeft = pExpr->pLeft;
265671c57db0Sdan   int nVal = sqlite3ExprVectorSize(pLeft);
2657553168c7Sdan   Select *pSelect = (pExpr->flags & EP_xIsSelect) ? pExpr->x.pSelect : 0;
265871c57db0Sdan   char *zRet;
265971c57db0Sdan 
2660553168c7Sdan   assert( pExpr->op==TK_IN );
26615c258dc1Sdrh   zRet = sqlite3DbMallocRaw(pParse->db, nVal+1);
266271c57db0Sdan   if( zRet ){
266371c57db0Sdan     int i;
266471c57db0Sdan     for(i=0; i<nVal; i++){
2665fc7f27b9Sdrh       Expr *pA = sqlite3VectorFieldSubexpr(pLeft, i);
2666553168c7Sdan       char a = sqlite3ExprAffinity(pA);
2667553168c7Sdan       if( pSelect ){
2668553168c7Sdan         zRet[i] = sqlite3CompareAffinity(pSelect->pEList->a[i].pExpr, a);
266971c57db0Sdan       }else{
2670553168c7Sdan         zRet[i] = a;
267171c57db0Sdan       }
267271c57db0Sdan     }
267371c57db0Sdan     zRet[nVal] = '\0';
267471c57db0Sdan   }
267571c57db0Sdan   return zRet;
267671c57db0Sdan }
2677f9b2e05cSdan #endif
267871c57db0Sdan 
26798da209b1Sdan #ifndef SQLITE_OMIT_SUBQUERY
26808da209b1Sdan /*
26818da209b1Sdan ** Load the Parse object passed as the first argument with an error
26828da209b1Sdan ** message of the form:
26838da209b1Sdan **
26848da209b1Sdan **   "sub-select returns N columns - expected M"
26858da209b1Sdan */
26868da209b1Sdan void sqlite3SubselectError(Parse *pParse, int nActual, int nExpect){
26878da209b1Sdan   const char *zFmt = "sub-select returns %d columns - expected %d";
26888da209b1Sdan   sqlite3ErrorMsg(pParse, zFmt, nActual, nExpect);
26898da209b1Sdan }
26908da209b1Sdan #endif
26918da209b1Sdan 
2692626a879aSdrh /*
269344c5604cSdan ** Expression pExpr is a vector that has been used in a context where
269444c5604cSdan ** it is not permitted. If pExpr is a sub-select vector, this routine
269544c5604cSdan ** loads the Parse object with a message of the form:
269644c5604cSdan **
269744c5604cSdan **   "sub-select returns N columns - expected 1"
269844c5604cSdan **
269944c5604cSdan ** Or, if it is a regular scalar vector:
270044c5604cSdan **
270144c5604cSdan **   "row value misused"
270244c5604cSdan */
270344c5604cSdan void sqlite3VectorErrorMsg(Parse *pParse, Expr *pExpr){
270444c5604cSdan #ifndef SQLITE_OMIT_SUBQUERY
270544c5604cSdan   if( pExpr->flags & EP_xIsSelect ){
270644c5604cSdan     sqlite3SubselectError(pParse, pExpr->x.pSelect->pEList->nExpr, 1);
270744c5604cSdan   }else
270844c5604cSdan #endif
270944c5604cSdan   {
271044c5604cSdan     sqlite3ErrorMsg(pParse, "row value misused");
271144c5604cSdan   }
271244c5604cSdan }
271344c5604cSdan 
271485bcdce2Sdrh #ifndef SQLITE_OMIT_SUBQUERY
271544c5604cSdan /*
271685bcdce2Sdrh ** Generate code that will construct an ephemeral table containing all terms
271785bcdce2Sdrh ** in the RHS of an IN operator.  The IN operator can be in either of two
271885bcdce2Sdrh ** forms:
2719626a879aSdrh **
27209cbe6352Sdrh **     x IN (4,5,11)              -- IN operator with list on right-hand side
27219cbe6352Sdrh **     x IN (SELECT a FROM b)     -- IN operator with subquery on the right
2722fef5208cSdrh **
27232c04131cSdrh ** The pExpr parameter is the IN operator.  The cursor number for the
27242c04131cSdrh ** constructed ephermeral table is returned.  The first time the ephemeral
27252c04131cSdrh ** table is computed, the cursor number is also stored in pExpr->iTable,
27262c04131cSdrh ** however the cursor number returned might not be the same, as it might
27272c04131cSdrh ** have been duplicated using OP_OpenDup.
272841a05b7bSdanielk1977 **
272985bcdce2Sdrh ** If the LHS expression ("x" in the examples) is a column value, or
273085bcdce2Sdrh ** the SELECT statement returns a column value, then the affinity of that
273185bcdce2Sdrh ** column is used to build the index keys. If both 'x' and the
273285bcdce2Sdrh ** SELECT... statement are columns, then numeric affinity is used
273385bcdce2Sdrh ** if either column has NUMERIC or INTEGER affinity. If neither
273485bcdce2Sdrh ** 'x' nor the SELECT... statement are columns, then numeric affinity
273585bcdce2Sdrh ** is used.
2736cce7d176Sdrh */
273785bcdce2Sdrh void sqlite3CodeRhsOfIN(
2738fd773cf9Sdrh   Parse *pParse,          /* Parsing context */
273985bcdce2Sdrh   Expr *pExpr,            /* The IN operator */
274050ef6716Sdrh   int iTab                /* Use this cursor number */
274141a05b7bSdanielk1977 ){
27422c04131cSdrh   int addrOnce = 0;           /* Address of the OP_Once instruction at top */
274385bcdce2Sdrh   int addr;                   /* Address of OP_OpenEphemeral instruction */
274485bcdce2Sdrh   Expr *pLeft;                /* the LHS of the IN operator */
274585bcdce2Sdrh   KeyInfo *pKeyInfo = 0;      /* Key information */
274685bcdce2Sdrh   int nVal;                   /* Size of vector pLeft */
274785bcdce2Sdrh   Vdbe *v;                    /* The prepared statement under construction */
2748fc976065Sdanielk1977 
27492c04131cSdrh   v = pParse->pVdbe;
275085bcdce2Sdrh   assert( v!=0 );
275185bcdce2Sdrh 
27522c04131cSdrh   /* The evaluation of the IN must be repeated every time it
275339a11819Sdrh   ** is encountered if any of the following is true:
275457dbd7b3Sdrh   **
275557dbd7b3Sdrh   **    *  The right-hand side is a correlated subquery
275657dbd7b3Sdrh   **    *  The right-hand side is an expression list containing variables
275757dbd7b3Sdrh   **    *  We are inside a trigger
275857dbd7b3Sdrh   **
27592c04131cSdrh   ** If all of the above are false, then we can compute the RHS just once
27602c04131cSdrh   ** and reuse it many names.
2761b3bce662Sdanielk1977   */
2762efb699fcSdrh   if( !ExprHasProperty(pExpr, EP_VarSelect) && pParse->iSelfTab==0 ){
27632c04131cSdrh     /* Reuse of the RHS is allowed */
27642c04131cSdrh     /* If this routine has already been coded, but the previous code
27652c04131cSdrh     ** might not have been invoked yet, so invoke it now as a subroutine.
27662c04131cSdrh     */
27672c04131cSdrh     if( ExprHasProperty(pExpr, EP_Subrtn) ){
2768f9231c34Sdrh       addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
2769bd462bccSdrh       if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2770bd462bccSdrh         ExplainQueryPlan((pParse, 0, "REUSE LIST SUBQUERY %d",
2771bd462bccSdrh               pExpr->x.pSelect->selId));
2772bd462bccSdrh       }
27732c04131cSdrh       sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
27742c04131cSdrh                         pExpr->y.sub.iAddr);
27752c04131cSdrh       sqlite3VdbeAddOp2(v, OP_OpenDup, iTab, pExpr->iTable);
2776f9231c34Sdrh       sqlite3VdbeJumpHere(v, addrOnce);
27772c04131cSdrh       return;
27782c04131cSdrh     }
27792c04131cSdrh 
27802c04131cSdrh     /* Begin coding the subroutine */
27812c04131cSdrh     ExprSetProperty(pExpr, EP_Subrtn);
27822c04131cSdrh     pExpr->y.sub.regReturn = ++pParse->nMem;
27832c04131cSdrh     pExpr->y.sub.iAddr =
27842c04131cSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 0, pExpr->y.sub.regReturn) + 1;
27852c04131cSdrh     VdbeComment((v, "return address"));
27862c04131cSdrh 
27872c04131cSdrh     addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
2788b3bce662Sdanielk1977   }
2789b3bce662Sdanielk1977 
279085bcdce2Sdrh   /* Check to see if this is a vector IN operator */
279185bcdce2Sdrh   pLeft = pExpr->pLeft;
279271c57db0Sdan   nVal = sqlite3ExprVectorSize(pLeft);
2793e014a838Sdanielk1977 
279485bcdce2Sdrh   /* Construct the ephemeral table that will contain the content of
279585bcdce2Sdrh   ** RHS of the IN operator.
2796fef5208cSdrh   */
27972c04131cSdrh   pExpr->iTable = iTab;
279850ef6716Sdrh   addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, pExpr->iTable, nVal);
27992c04131cSdrh #ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
28002c04131cSdrh   if( ExprHasProperty(pExpr, EP_xIsSelect) ){
28012c04131cSdrh     VdbeComment((v, "Result of SELECT %u", pExpr->x.pSelect->selId));
28022c04131cSdrh   }else{
28032c04131cSdrh     VdbeComment((v, "RHS of IN operator"));
28042c04131cSdrh   }
28052c04131cSdrh #endif
280650ef6716Sdrh   pKeyInfo = sqlite3KeyInfoAlloc(pParse->db, nVal, 1);
2807e014a838Sdanielk1977 
28086ab3a2ecSdanielk1977   if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2809e014a838Sdanielk1977     /* Case 1:     expr IN (SELECT ...)
2810e014a838Sdanielk1977     **
2811e014a838Sdanielk1977     ** Generate code to write the results of the select into the temporary
2812e014a838Sdanielk1977     ** table allocated and opened above.
2813e014a838Sdanielk1977     */
28144387006cSdrh     Select *pSelect = pExpr->x.pSelect;
281571c57db0Sdan     ExprList *pEList = pSelect->pEList;
28161013c932Sdrh 
28172c04131cSdrh     ExplainQueryPlan((pParse, 1, "%sLIST SUBQUERY %d",
28182c04131cSdrh         addrOnce?"":"CORRELATED ", pSelect->selId
2819e2ca99c9Sdrh     ));
282064bcb8cfSdrh     /* If the LHS and RHS of the IN operator do not match, that
282164bcb8cfSdrh     ** error will have been caught long before we reach this point. */
282264bcb8cfSdrh     if( ALWAYS(pEList->nExpr==nVal) ){
282371c57db0Sdan       SelectDest dest;
282471c57db0Sdan       int i;
2825bd462bccSdrh       sqlite3SelectDestInit(&dest, SRT_Set, iTab);
282671c57db0Sdan       dest.zAffSdst = exprINAffinity(pParse, pExpr);
28274387006cSdrh       pSelect->iLimit = 0;
28284387006cSdrh       testcase( pSelect->selFlags & SF_Distinct );
2829812ea833Sdrh       testcase( pKeyInfo==0 ); /* Caused by OOM in sqlite3KeyInfoAlloc() */
28304387006cSdrh       if( sqlite3Select(pParse, pSelect, &dest) ){
283171c57db0Sdan         sqlite3DbFree(pParse->db, dest.zAffSdst);
28322ec2fb22Sdrh         sqlite3KeyInfoUnref(pKeyInfo);
283385bcdce2Sdrh         return;
283494ccde58Sdrh       }
283571c57db0Sdan       sqlite3DbFree(pParse->db, dest.zAffSdst);
2836812ea833Sdrh       assert( pKeyInfo!=0 ); /* OOM will cause exit after sqlite3Select() */
28373535ec3eSdrh       assert( pEList!=0 );
28383535ec3eSdrh       assert( pEList->nExpr>0 );
28392ec2fb22Sdrh       assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
284071c57db0Sdan       for(i=0; i<nVal; i++){
2841773d3afaSdan         Expr *p = sqlite3VectorFieldSubexpr(pLeft, i);
284271c57db0Sdan         pKeyInfo->aColl[i] = sqlite3BinaryCompareCollSeq(
284371c57db0Sdan             pParse, p, pEList->a[i].pExpr
284471c57db0Sdan         );
284571c57db0Sdan       }
284671c57db0Sdan     }
2847a7d2db17Sdrh   }else if( ALWAYS(pExpr->x.pList!=0) ){
2848fef5208cSdrh     /* Case 2:     expr IN (exprlist)
2849fef5208cSdrh     **
2850e014a838Sdanielk1977     ** For each expression, build an index key from the evaluation and
2851e014a838Sdanielk1977     ** store it in the temporary table. If <expr> is a column, then use
2852e014a838Sdanielk1977     ** that columns affinity when building index keys. If <expr> is not
2853e014a838Sdanielk1977     ** a column, use numeric affinity.
2854fef5208cSdrh     */
285571c57db0Sdan     char affinity;            /* Affinity of the LHS of the IN */
2856e014a838Sdanielk1977     int i;
28576ab3a2ecSdanielk1977     ExprList *pList = pExpr->x.pList;
285857dbd7b3Sdrh     struct ExprList_item *pItem;
2859c324d446Sdan     int r1, r2;
286071c57db0Sdan     affinity = sqlite3ExprAffinity(pLeft);
286196fb16eeSdrh     if( affinity<=SQLITE_AFF_NONE ){
286205883a34Sdrh       affinity = SQLITE_AFF_BLOB;
2863e014a838Sdanielk1977     }
2864323df790Sdrh     if( pKeyInfo ){
28652ec2fb22Sdrh       assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
2866323df790Sdrh       pKeyInfo->aColl[0] = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
2867323df790Sdrh     }
2868e014a838Sdanielk1977 
2869e014a838Sdanielk1977     /* Loop through each expression in <exprlist>. */
28702d401ab8Sdrh     r1 = sqlite3GetTempReg(pParse);
28712d401ab8Sdrh     r2 = sqlite3GetTempReg(pParse);
287257dbd7b3Sdrh     for(i=pList->nExpr, pItem=pList->a; i>0; i--, pItem++){
287357dbd7b3Sdrh       Expr *pE2 = pItem->pExpr;
2874e014a838Sdanielk1977 
287557dbd7b3Sdrh       /* If the expression is not constant then we will need to
287657dbd7b3Sdrh       ** disable the test that was generated above that makes sure
287757dbd7b3Sdrh       ** this code only executes once.  Because for a non-constant
287857dbd7b3Sdrh       ** expression we need to rerun this code each time.
287957dbd7b3Sdrh       */
28802c04131cSdrh       if( addrOnce && !sqlite3ExprIsConstant(pE2) ){
28812c04131cSdrh         sqlite3VdbeChangeToNoop(v, addrOnce);
28827ac0e562Sdan         ExprClearProperty(pExpr, EP_Subrtn);
28832c04131cSdrh         addrOnce = 0;
28844794b980Sdrh       }
2885e014a838Sdanielk1977 
2886e014a838Sdanielk1977       /* Evaluate the expression and insert it into the temp table */
2887c324d446Sdan       sqlite3ExprCode(pParse, pE2, r1);
2888c324d446Sdan       sqlite3VdbeAddOp4(v, OP_MakeRecord, r1, 1, r2, &affinity, 1);
2889c324d446Sdan       sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iTab, r2, r1, 1);
2890fef5208cSdrh     }
28912d401ab8Sdrh     sqlite3ReleaseTempReg(pParse, r1);
28922d401ab8Sdrh     sqlite3ReleaseTempReg(pParse, r2);
2893fef5208cSdrh   }
2894323df790Sdrh   if( pKeyInfo ){
28952ec2fb22Sdrh     sqlite3VdbeChangeP4(v, addr, (void *)pKeyInfo, P4_KEYINFO);
289641a05b7bSdanielk1977   }
28972c04131cSdrh   if( addrOnce ){
28982c04131cSdrh     sqlite3VdbeJumpHere(v, addrOnce);
28992c04131cSdrh     /* Subroutine return */
29002c04131cSdrh     sqlite3VdbeAddOp1(v, OP_Return, pExpr->y.sub.regReturn);
29012c04131cSdrh     sqlite3VdbeChangeP1(v, pExpr->y.sub.iAddr-1, sqlite3VdbeCurrentAddr(v)-1);
29026d2566dfSdrh     sqlite3ClearTempRegCache(pParse);
290385bcdce2Sdrh   }
290485bcdce2Sdrh }
290585bcdce2Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
290685bcdce2Sdrh 
290785bcdce2Sdrh /*
290885bcdce2Sdrh ** Generate code for scalar subqueries used as a subquery expression
290985bcdce2Sdrh ** or EXISTS operator:
291085bcdce2Sdrh **
291185bcdce2Sdrh **     (SELECT a FROM b)          -- subquery
291285bcdce2Sdrh **     EXISTS (SELECT a FROM b)   -- EXISTS subquery
291385bcdce2Sdrh **
291485bcdce2Sdrh ** The pExpr parameter is the SELECT or EXISTS operator to be coded.
291585bcdce2Sdrh **
2916d86fe44aSdrh ** Return the register that holds the result.  For a multi-column SELECT,
291785bcdce2Sdrh ** the result is stored in a contiguous array of registers and the
291885bcdce2Sdrh ** return value is the register of the left-most result column.
291985bcdce2Sdrh ** Return 0 if an error occurs.
292085bcdce2Sdrh */
292185bcdce2Sdrh #ifndef SQLITE_OMIT_SUBQUERY
292285bcdce2Sdrh int sqlite3CodeSubselect(Parse *pParse, Expr *pExpr){
29232c04131cSdrh   int addrOnce = 0;           /* Address of OP_Once at top of subroutine */
292485bcdce2Sdrh   int rReg = 0;               /* Register storing resulting */
292585bcdce2Sdrh   Select *pSel;               /* SELECT statement to encode */
292685bcdce2Sdrh   SelectDest dest;            /* How to deal with SELECT result */
292785bcdce2Sdrh   int nReg;                   /* Registers to allocate */
292885bcdce2Sdrh   Expr *pLimit;               /* New limit expression */
29292c04131cSdrh 
29302c04131cSdrh   Vdbe *v = pParse->pVdbe;
293185bcdce2Sdrh   assert( v!=0 );
2932bd462bccSdrh   testcase( pExpr->op==TK_EXISTS );
2933bd462bccSdrh   testcase( pExpr->op==TK_SELECT );
2934bd462bccSdrh   assert( pExpr->op==TK_EXISTS || pExpr->op==TK_SELECT );
2935bd462bccSdrh   assert( ExprHasProperty(pExpr, EP_xIsSelect) );
2936bd462bccSdrh   pSel = pExpr->x.pSelect;
293785bcdce2Sdrh 
29385198ff57Sdrh   /* The evaluation of the EXISTS/SELECT must be repeated every time it
293985bcdce2Sdrh   ** is encountered if any of the following is true:
294085bcdce2Sdrh   **
294185bcdce2Sdrh   **    *  The right-hand side is a correlated subquery
294285bcdce2Sdrh   **    *  The right-hand side is an expression list containing variables
294385bcdce2Sdrh   **    *  We are inside a trigger
294485bcdce2Sdrh   **
294585bcdce2Sdrh   ** If all of the above are false, then we can run this code just once
294685bcdce2Sdrh   ** save the results, and reuse the same result on subsequent invocations.
294785bcdce2Sdrh   */
294885bcdce2Sdrh   if( !ExprHasProperty(pExpr, EP_VarSelect) ){
29495198ff57Sdrh     /* If this routine has already been coded, then invoke it as a
29505198ff57Sdrh     ** subroutine. */
29515198ff57Sdrh     if( ExprHasProperty(pExpr, EP_Subrtn) ){
2952bd462bccSdrh       ExplainQueryPlan((pParse, 0, "REUSE SUBQUERY %d", pSel->selId));
29535198ff57Sdrh       sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
29545198ff57Sdrh                         pExpr->y.sub.iAddr);
29555198ff57Sdrh       return pExpr->iTable;
29565198ff57Sdrh     }
29575198ff57Sdrh 
29585198ff57Sdrh     /* Begin coding the subroutine */
29595198ff57Sdrh     ExprSetProperty(pExpr, EP_Subrtn);
29605198ff57Sdrh     pExpr->y.sub.regReturn = ++pParse->nMem;
29615198ff57Sdrh     pExpr->y.sub.iAddr =
29625198ff57Sdrh       sqlite3VdbeAddOp2(v, OP_Integer, 0, pExpr->y.sub.regReturn) + 1;
29635198ff57Sdrh     VdbeComment((v, "return address"));
29645198ff57Sdrh 
29652c04131cSdrh     addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
2966fef5208cSdrh   }
2967fef5208cSdrh 
296885bcdce2Sdrh   /* For a SELECT, generate code to put the values for all columns of
296939a11819Sdrh   ** the first row into an array of registers and return the index of
297039a11819Sdrh   ** the first register.
297139a11819Sdrh   **
297239a11819Sdrh   ** If this is an EXISTS, write an integer 0 (not exists) or 1 (exists)
297339a11819Sdrh   ** into a register and return that register number.
297439a11819Sdrh   **
297539a11819Sdrh   ** In both cases, the query is augmented with "LIMIT 1".  Any
297639a11819Sdrh   ** preexisting limit is discarded in place of the new LIMIT 1.
2977fef5208cSdrh   */
2978bd462bccSdrh   ExplainQueryPlan((pParse, 1, "%sSCALAR SUBQUERY %d",
2979bd462bccSdrh         addrOnce?"":"CORRELATED ", pSel->selId));
298071c57db0Sdan   nReg = pExpr->op==TK_SELECT ? pSel->pEList->nExpr : 1;
298171c57db0Sdan   sqlite3SelectDestInit(&dest, 0, pParse->nMem+1);
298271c57db0Sdan   pParse->nMem += nReg;
298351522cd3Sdrh   if( pExpr->op==TK_SELECT ){
29846c8c8ce0Sdanielk1977     dest.eDest = SRT_Mem;
298553932ce8Sdrh     dest.iSdst = dest.iSDParm;
298671c57db0Sdan     dest.nSdst = nReg;
298771c57db0Sdan     sqlite3VdbeAddOp3(v, OP_Null, 0, dest.iSDParm, dest.iSDParm+nReg-1);
2988d4e70ebdSdrh     VdbeComment((v, "Init subquery result"));
298951522cd3Sdrh   }else{
29906c8c8ce0Sdanielk1977     dest.eDest = SRT_Exists;
29912b596da8Sdrh     sqlite3VdbeAddOp2(v, OP_Integer, 0, dest.iSDParm);
2992d4e70ebdSdrh     VdbeComment((v, "Init EXISTS result"));
299351522cd3Sdrh   }
29948c0833fbSdrh   if( pSel->pLimit ){
29957ca1347fSdrh     /* The subquery already has a limit.  If the pre-existing limit is X
29967ca1347fSdrh     ** then make the new limit X<>0 so that the new limit is either 1 or 0 */
29977ca1347fSdrh     sqlite3 *db = pParse->db;
29985776ee5cSdrh     pLimit = sqlite3Expr(db, TK_INTEGER, "0");
29997ca1347fSdrh     if( pLimit ){
30007ca1347fSdrh       pLimit->affExpr = SQLITE_AFF_NUMERIC;
30017ca1347fSdrh       pLimit = sqlite3PExpr(pParse, TK_NE,
30027ca1347fSdrh                             sqlite3ExprDup(db, pSel->pLimit->pLeft, 0), pLimit);
30037ca1347fSdrh     }
30047ca1347fSdrh     sqlite3ExprDelete(db, pSel->pLimit->pLeft);
30058c0833fbSdrh     pSel->pLimit->pLeft = pLimit;
30068c0833fbSdrh   }else{
30077ca1347fSdrh     /* If there is no pre-existing limit add a limit of 1 */
30085776ee5cSdrh     pLimit = sqlite3Expr(pParse->db, TK_INTEGER, "1");
30098c0833fbSdrh     pSel->pLimit = sqlite3PExpr(pParse, TK_LIMIT, pLimit, 0);
30108c0833fbSdrh   }
301148b5b041Sdrh   pSel->iLimit = 0;
30127d10d5a6Sdrh   if( sqlite3Select(pParse, pSel, &dest) ){
30131450bc6eSdrh     return 0;
301494ccde58Sdrh   }
30152c04131cSdrh   pExpr->iTable = rReg = dest.iSDParm;
3016ebb6a65dSdrh   ExprSetVVAProperty(pExpr, EP_NoReduce);
30172c04131cSdrh   if( addrOnce ){
30182c04131cSdrh     sqlite3VdbeJumpHere(v, addrOnce);
3019fc976065Sdanielk1977 
30202c04131cSdrh     /* Subroutine return */
30212c04131cSdrh     sqlite3VdbeAddOp1(v, OP_Return, pExpr->y.sub.regReturn);
30222c04131cSdrh     sqlite3VdbeChangeP1(v, pExpr->y.sub.iAddr-1, sqlite3VdbeCurrentAddr(v)-1);
30236d2566dfSdrh     sqlite3ClearTempRegCache(pParse);
30245198ff57Sdrh   }
30252c04131cSdrh 
30261450bc6eSdrh   return rReg;
3027cce7d176Sdrh }
302851522cd3Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
3029cce7d176Sdrh 
3030e3365e6cSdrh #ifndef SQLITE_OMIT_SUBQUERY
3031e3365e6cSdrh /*
30327b35a77bSdan ** Expr pIn is an IN(...) expression. This function checks that the
30337b35a77bSdan ** sub-select on the RHS of the IN() operator has the same number of
30347b35a77bSdan ** columns as the vector on the LHS. Or, if the RHS of the IN() is not
30357b35a77bSdan ** a sub-query, that the LHS is a vector of size 1.
30367b35a77bSdan */
30377b35a77bSdan int sqlite3ExprCheckIN(Parse *pParse, Expr *pIn){
30387b35a77bSdan   int nVector = sqlite3ExprVectorSize(pIn->pLeft);
30397b35a77bSdan   if( (pIn->flags & EP_xIsSelect) ){
30407b35a77bSdan     if( nVector!=pIn->x.pSelect->pEList->nExpr ){
30417b35a77bSdan       sqlite3SubselectError(pParse, pIn->x.pSelect->pEList->nExpr, nVector);
30427b35a77bSdan       return 1;
30437b35a77bSdan     }
30447b35a77bSdan   }else if( nVector!=1 ){
304544c5604cSdan     sqlite3VectorErrorMsg(pParse, pIn->pLeft);
30467b35a77bSdan     return 1;
30477b35a77bSdan   }
30487b35a77bSdan   return 0;
30497b35a77bSdan }
30507b35a77bSdan #endif
30517b35a77bSdan 
30527b35a77bSdan #ifndef SQLITE_OMIT_SUBQUERY
30537b35a77bSdan /*
3054e3365e6cSdrh ** Generate code for an IN expression.
3055e3365e6cSdrh **
3056e3365e6cSdrh **      x IN (SELECT ...)
3057e3365e6cSdrh **      x IN (value, value, ...)
3058e3365e6cSdrh **
3059ecb87ac8Sdrh ** The left-hand side (LHS) is a scalar or vector expression.  The
3060e347d3e8Sdrh ** right-hand side (RHS) is an array of zero or more scalar values, or a
3061e347d3e8Sdrh ** subquery.  If the RHS is a subquery, the number of result columns must
3062e347d3e8Sdrh ** match the number of columns in the vector on the LHS.  If the RHS is
3063e347d3e8Sdrh ** a list of values, the LHS must be a scalar.
3064e347d3e8Sdrh **
3065e347d3e8Sdrh ** The IN operator is true if the LHS value is contained within the RHS.
3066e347d3e8Sdrh ** The result is false if the LHS is definitely not in the RHS.  The
3067e347d3e8Sdrh ** result is NULL if the presence of the LHS in the RHS cannot be
3068e347d3e8Sdrh ** determined due to NULLs.
3069e3365e6cSdrh **
30706be515ebSdrh ** This routine generates code that jumps to destIfFalse if the LHS is not
3071e3365e6cSdrh ** contained within the RHS.  If due to NULLs we cannot determine if the LHS
3072e3365e6cSdrh ** is contained in the RHS then jump to destIfNull.  If the LHS is contained
3073e3365e6cSdrh ** within the RHS then fall through.
3074ecb87ac8Sdrh **
3075ecb87ac8Sdrh ** See the separate in-operator.md documentation file in the canonical
3076ecb87ac8Sdrh ** SQLite source tree for additional information.
3077e3365e6cSdrh */
3078e3365e6cSdrh static void sqlite3ExprCodeIN(
3079e3365e6cSdrh   Parse *pParse,        /* Parsing and code generating context */
3080e3365e6cSdrh   Expr *pExpr,          /* The IN expression */
3081e3365e6cSdrh   int destIfFalse,      /* Jump here if LHS is not contained in the RHS */
3082e3365e6cSdrh   int destIfNull        /* Jump here if the results are unknown due to NULLs */
3083e3365e6cSdrh ){
3084e3365e6cSdrh   int rRhsHasNull = 0;  /* Register that is true if RHS contains NULL values */
3085e3365e6cSdrh   int eType;            /* Type of the RHS */
3086e347d3e8Sdrh   int rLhs;             /* Register(s) holding the LHS values */
3087e347d3e8Sdrh   int rLhsOrig;         /* LHS values prior to reordering by aiMap[] */
3088e3365e6cSdrh   Vdbe *v;              /* Statement under construction */
3089ba00e30aSdan   int *aiMap = 0;       /* Map from vector field to index column */
3090ba00e30aSdan   char *zAff = 0;       /* Affinity string for comparisons */
3091ecb87ac8Sdrh   int nVector;          /* Size of vectors for this IN operator */
309212abf408Sdrh   int iDummy;           /* Dummy parameter to exprCodeVector() */
3093e347d3e8Sdrh   Expr *pLeft;          /* The LHS of the IN operator */
3094ecb87ac8Sdrh   int i;                /* loop counter */
3095e347d3e8Sdrh   int destStep2;        /* Where to jump when NULLs seen in step 2 */
3096e347d3e8Sdrh   int destStep6 = 0;    /* Start of code for Step 6 */
3097e347d3e8Sdrh   int addrTruthOp;      /* Address of opcode that determines the IN is true */
3098e347d3e8Sdrh   int destNotNull;      /* Jump here if a comparison is not true in step 6 */
3099e347d3e8Sdrh   int addrTop;          /* Top of the step-6 loop */
31002c04131cSdrh   int iTab = 0;         /* Index to use */
3101e3365e6cSdrh 
3102e347d3e8Sdrh   pLeft = pExpr->pLeft;
31037b35a77bSdan   if( sqlite3ExprCheckIN(pParse, pExpr) ) return;
3104553168c7Sdan   zAff = exprINAffinity(pParse, pExpr);
3105ba00e30aSdan   nVector = sqlite3ExprVectorSize(pExpr->pLeft);
3106ba00e30aSdan   aiMap = (int*)sqlite3DbMallocZero(
3107ba00e30aSdan       pParse->db, nVector*(sizeof(int) + sizeof(char)) + 1
3108ba00e30aSdan   );
3109e347d3e8Sdrh   if( pParse->db->mallocFailed ) goto sqlite3ExprCodeIN_oom_error;
31107b35a77bSdan 
3111ba00e30aSdan   /* Attempt to compute the RHS. After this step, if anything other than
31122c04131cSdrh   ** IN_INDEX_NOOP is returned, the table opened with cursor iTab
3113ba00e30aSdan   ** contains the values that make up the RHS. If IN_INDEX_NOOP is returned,
3114ba00e30aSdan   ** the RHS has not yet been coded.  */
3115e3365e6cSdrh   v = pParse->pVdbe;
3116e3365e6cSdrh   assert( v!=0 );       /* OOM detected prior to this routine */
3117e3365e6cSdrh   VdbeNoopComment((v, "begin IN expr"));
3118bb53ecb1Sdrh   eType = sqlite3FindInIndex(pParse, pExpr,
3119bb53ecb1Sdrh                              IN_INDEX_MEMBERSHIP | IN_INDEX_NOOP_OK,
31202c04131cSdrh                              destIfFalse==destIfNull ? 0 : &rRhsHasNull,
31212c04131cSdrh                              aiMap, &iTab);
3122e3365e6cSdrh 
3123ba00e30aSdan   assert( pParse->nErr || nVector==1 || eType==IN_INDEX_EPH
3124ba00e30aSdan        || eType==IN_INDEX_INDEX_ASC || eType==IN_INDEX_INDEX_DESC
3125ba00e30aSdan   );
3126ecb87ac8Sdrh #ifdef SQLITE_DEBUG
3127ecb87ac8Sdrh   /* Confirm that aiMap[] contains nVector integer values between 0 and
3128ecb87ac8Sdrh   ** nVector-1. */
3129ecb87ac8Sdrh   for(i=0; i<nVector; i++){
3130ecb87ac8Sdrh     int j, cnt;
3131ecb87ac8Sdrh     for(cnt=j=0; j<nVector; j++) if( aiMap[j]==i ) cnt++;
3132ecb87ac8Sdrh     assert( cnt==1 );
3133ecb87ac8Sdrh   }
3134ecb87ac8Sdrh #endif
3135e3365e6cSdrh 
3136ba00e30aSdan   /* Code the LHS, the <expr> from "<expr> IN (...)". If the LHS is a
3137ba00e30aSdan   ** vector, then it is stored in an array of nVector registers starting
3138ba00e30aSdan   ** at r1.
3139e347d3e8Sdrh   **
3140e347d3e8Sdrh   ** sqlite3FindInIndex() might have reordered the fields of the LHS vector
3141e347d3e8Sdrh   ** so that the fields are in the same order as an existing index.   The
3142e347d3e8Sdrh   ** aiMap[] array contains a mapping from the original LHS field order to
3143e347d3e8Sdrh   ** the field order that matches the RHS index.
3144e3365e6cSdrh   */
3145e347d3e8Sdrh   rLhsOrig = exprCodeVector(pParse, pLeft, &iDummy);
3146e347d3e8Sdrh   for(i=0; i<nVector && aiMap[i]==i; i++){} /* Are LHS fields reordered? */
3147ecb87ac8Sdrh   if( i==nVector ){
3148e347d3e8Sdrh     /* LHS fields are not reordered */
3149e347d3e8Sdrh     rLhs = rLhsOrig;
3150ecb87ac8Sdrh   }else{
3151ecb87ac8Sdrh     /* Need to reorder the LHS fields according to aiMap */
3152e347d3e8Sdrh     rLhs = sqlite3GetTempRange(pParse, nVector);
3153ba00e30aSdan     for(i=0; i<nVector; i++){
3154e347d3e8Sdrh       sqlite3VdbeAddOp3(v, OP_Copy, rLhsOrig+i, rLhs+aiMap[i], 0);
3155ba00e30aSdan     }
3156ecb87ac8Sdrh   }
3157e3365e6cSdrh 
3158bb53ecb1Sdrh   /* If sqlite3FindInIndex() did not find or create an index that is
3159bb53ecb1Sdrh   ** suitable for evaluating the IN operator, then evaluate using a
3160bb53ecb1Sdrh   ** sequence of comparisons.
3161e347d3e8Sdrh   **
3162e347d3e8Sdrh   ** This is step (1) in the in-operator.md optimized algorithm.
3163bb53ecb1Sdrh   */
3164bb53ecb1Sdrh   if( eType==IN_INDEX_NOOP ){
3165bb53ecb1Sdrh     ExprList *pList = pExpr->x.pList;
3166bb53ecb1Sdrh     CollSeq *pColl = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
3167ec4ccdbcSdrh     int labelOk = sqlite3VdbeMakeLabel(pParse);
3168bb53ecb1Sdrh     int r2, regToFree;
3169bb53ecb1Sdrh     int regCkNull = 0;
3170bb53ecb1Sdrh     int ii;
3171dd668c26Sdrh     int bLhsReal;  /* True if the LHS of the IN has REAL affinity */
3172bb53ecb1Sdrh     assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
3173bb53ecb1Sdrh     if( destIfNull!=destIfFalse ){
3174bb53ecb1Sdrh       regCkNull = sqlite3GetTempReg(pParse);
3175e347d3e8Sdrh       sqlite3VdbeAddOp3(v, OP_BitAnd, rLhs, rLhs, regCkNull);
3176bb53ecb1Sdrh     }
3177dd668c26Sdrh     bLhsReal = sqlite3ExprAffinity(pExpr->pLeft)==SQLITE_AFF_REAL;
3178bb53ecb1Sdrh     for(ii=0; ii<pList->nExpr; ii++){
3179dd668c26Sdrh       if( bLhsReal ){
31804fc83654Sdrh         r2 = regToFree = sqlite3GetTempReg(pParse);
31814fc83654Sdrh         sqlite3ExprCode(pParse, pList->a[ii].pExpr, r2);
3182dd668c26Sdrh         sqlite3VdbeAddOp4(v, OP_Affinity, r2, 1, 0, "E", P4_STATIC);
31834fc83654Sdrh       }else{
31844fc83654Sdrh         r2 = sqlite3ExprCodeTemp(pParse, pList->a[ii].pExpr, &regToFree);
3185dd668c26Sdrh       }
3186a976979bSdrh       if( regCkNull && sqlite3ExprCanBeNull(pList->a[ii].pExpr) ){
3187bb53ecb1Sdrh         sqlite3VdbeAddOp3(v, OP_BitAnd, regCkNull, r2, regCkNull);
3188bb53ecb1Sdrh       }
3189bb53ecb1Sdrh       if( ii<pList->nExpr-1 || destIfNull!=destIfFalse ){
3190e347d3e8Sdrh         sqlite3VdbeAddOp4(v, OP_Eq, rLhs, labelOk, r2,
31914336b0e6Sdrh                           (void*)pColl, P4_COLLSEQ);
31924336b0e6Sdrh         VdbeCoverageIf(v, ii<pList->nExpr-1);
31934336b0e6Sdrh         VdbeCoverageIf(v, ii==pList->nExpr-1);
3194ba00e30aSdan         sqlite3VdbeChangeP5(v, zAff[0]);
3195bb53ecb1Sdrh       }else{
3196bb53ecb1Sdrh         assert( destIfNull==destIfFalse );
3197e347d3e8Sdrh         sqlite3VdbeAddOp4(v, OP_Ne, rLhs, destIfFalse, r2,
3198bb53ecb1Sdrh                           (void*)pColl, P4_COLLSEQ); VdbeCoverage(v);
3199ba00e30aSdan         sqlite3VdbeChangeP5(v, zAff[0] | SQLITE_JUMPIFNULL);
3200bb53ecb1Sdrh       }
3201bb53ecb1Sdrh       sqlite3ReleaseTempReg(pParse, regToFree);
3202bb53ecb1Sdrh     }
3203bb53ecb1Sdrh     if( regCkNull ){
3204bb53ecb1Sdrh       sqlite3VdbeAddOp2(v, OP_IsNull, regCkNull, destIfNull); VdbeCoverage(v);
3205076e85f5Sdrh       sqlite3VdbeGoto(v, destIfFalse);
3206bb53ecb1Sdrh     }
3207bb53ecb1Sdrh     sqlite3VdbeResolveLabel(v, labelOk);
3208bb53ecb1Sdrh     sqlite3ReleaseTempReg(pParse, regCkNull);
3209e347d3e8Sdrh     goto sqlite3ExprCodeIN_finished;
3210e347d3e8Sdrh   }
3211bb53ecb1Sdrh 
3212e347d3e8Sdrh   /* Step 2: Check to see if the LHS contains any NULL columns.  If the
3213e347d3e8Sdrh   ** LHS does contain NULLs then the result must be either FALSE or NULL.
3214e347d3e8Sdrh   ** We will then skip the binary search of the RHS.
3215e347d3e8Sdrh   */
3216094430ebSdrh   if( destIfNull==destIfFalse ){
3217e347d3e8Sdrh     destStep2 = destIfFalse;
3218e347d3e8Sdrh   }else{
3219ec4ccdbcSdrh     destStep2 = destStep6 = sqlite3VdbeMakeLabel(pParse);
3220e347d3e8Sdrh   }
3221d49fd4e8Sdan   for(i=0; i<nVector; i++){
3222fc7f27b9Sdrh     Expr *p = sqlite3VectorFieldSubexpr(pExpr->pLeft, i);
3223d49fd4e8Sdan     if( sqlite3ExprCanBeNull(p) ){
3224e347d3e8Sdrh       sqlite3VdbeAddOp2(v, OP_IsNull, rLhs+i, destStep2);
3225471b4b92Sdrh       VdbeCoverage(v);
3226d49fd4e8Sdan     }
3227d49fd4e8Sdan   }
3228e3365e6cSdrh 
3229e347d3e8Sdrh   /* Step 3.  The LHS is now known to be non-NULL.  Do the binary search
3230e347d3e8Sdrh   ** of the RHS using the LHS as a probe.  If found, the result is
3231e347d3e8Sdrh   ** true.
3232e347d3e8Sdrh   */
3233e3365e6cSdrh   if( eType==IN_INDEX_ROWID ){
3234e347d3e8Sdrh     /* In this case, the RHS is the ROWID of table b-tree and so we also
3235e347d3e8Sdrh     ** know that the RHS is non-NULL.  Hence, we combine steps 3 and 4
3236e347d3e8Sdrh     ** into a single opcode. */
32372c04131cSdrh     sqlite3VdbeAddOp3(v, OP_SeekRowid, iTab, destIfFalse, rLhs);
3238688852abSdrh     VdbeCoverage(v);
3239e347d3e8Sdrh     addrTruthOp = sqlite3VdbeAddOp0(v, OP_Goto);  /* Return True */
32407b35a77bSdan   }else{
3241e347d3e8Sdrh     sqlite3VdbeAddOp4(v, OP_Affinity, rLhs, nVector, 0, zAff, nVector);
3242e347d3e8Sdrh     if( destIfFalse==destIfNull ){
3243e347d3e8Sdrh       /* Combine Step 3 and Step 5 into a single opcode */
32442c04131cSdrh       sqlite3VdbeAddOp4Int(v, OP_NotFound, iTab, destIfFalse,
3245e347d3e8Sdrh                            rLhs, nVector); VdbeCoverage(v);
3246e347d3e8Sdrh       goto sqlite3ExprCodeIN_finished;
3247e347d3e8Sdrh     }
3248e347d3e8Sdrh     /* Ordinary Step 3, for the case where FALSE and NULL are distinct */
32492c04131cSdrh     addrTruthOp = sqlite3VdbeAddOp4Int(v, OP_Found, iTab, 0,
3250e347d3e8Sdrh                                       rLhs, nVector); VdbeCoverage(v);
3251e347d3e8Sdrh   }
3252ba00e30aSdan 
3253e347d3e8Sdrh   /* Step 4.  If the RHS is known to be non-NULL and we did not find
3254e347d3e8Sdrh   ** an match on the search above, then the result must be FALSE.
3255e347d3e8Sdrh   */
3256e347d3e8Sdrh   if( rRhsHasNull && nVector==1 ){
3257e347d3e8Sdrh     sqlite3VdbeAddOp2(v, OP_NotNull, rRhsHasNull, destIfFalse);
3258471b4b92Sdrh     VdbeCoverage(v);
3259e347d3e8Sdrh   }
32607b35a77bSdan 
3261e347d3e8Sdrh   /* Step 5.  If we do not care about the difference between NULL and
3262e347d3e8Sdrh   ** FALSE, then just return false.
3263e347d3e8Sdrh   */
3264e347d3e8Sdrh   if( destIfFalse==destIfNull ) sqlite3VdbeGoto(v, destIfFalse);
3265e347d3e8Sdrh 
3266e347d3e8Sdrh   /* Step 6: Loop through rows of the RHS.  Compare each row to the LHS.
3267e347d3e8Sdrh   ** If any comparison is NULL, then the result is NULL.  If all
3268e347d3e8Sdrh   ** comparisons are FALSE then the final result is FALSE.
3269e347d3e8Sdrh   **
3270e347d3e8Sdrh   ** For a scalar LHS, it is sufficient to check just the first row
3271e347d3e8Sdrh   ** of the RHS.
3272e347d3e8Sdrh   */
3273e347d3e8Sdrh   if( destStep6 ) sqlite3VdbeResolveLabel(v, destStep6);
32742c04131cSdrh   addrTop = sqlite3VdbeAddOp2(v, OP_Rewind, iTab, destIfFalse);
3275471b4b92Sdrh   VdbeCoverage(v);
3276e347d3e8Sdrh   if( nVector>1 ){
3277ec4ccdbcSdrh     destNotNull = sqlite3VdbeMakeLabel(pParse);
3278e347d3e8Sdrh   }else{
3279e347d3e8Sdrh     /* For nVector==1, combine steps 6 and 7 by immediately returning
3280e347d3e8Sdrh     ** FALSE if the first comparison is not NULL */
3281e347d3e8Sdrh     destNotNull = destIfFalse;
3282e347d3e8Sdrh   }
3283ba00e30aSdan   for(i=0; i<nVector; i++){
3284ba00e30aSdan     Expr *p;
3285ba00e30aSdan     CollSeq *pColl;
3286e347d3e8Sdrh     int r3 = sqlite3GetTempReg(pParse);
3287fc7f27b9Sdrh     p = sqlite3VectorFieldSubexpr(pLeft, i);
3288ba00e30aSdan     pColl = sqlite3ExprCollSeq(pParse, p);
32892c04131cSdrh     sqlite3VdbeAddOp3(v, OP_Column, iTab, i, r3);
3290e347d3e8Sdrh     sqlite3VdbeAddOp4(v, OP_Ne, rLhs+i, destNotNull, r3,
329118016ad2Sdrh                       (void*)pColl, P4_COLLSEQ);
3292471b4b92Sdrh     VdbeCoverage(v);
3293e347d3e8Sdrh     sqlite3ReleaseTempReg(pParse, r3);
32947b35a77bSdan   }
32957b35a77bSdan   sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfNull);
3296e347d3e8Sdrh   if( nVector>1 ){
3297e347d3e8Sdrh     sqlite3VdbeResolveLabel(v, destNotNull);
32982c04131cSdrh     sqlite3VdbeAddOp2(v, OP_Next, iTab, addrTop+1);
329918016ad2Sdrh     VdbeCoverage(v);
3300e347d3e8Sdrh 
3301e347d3e8Sdrh     /* Step 7:  If we reach this point, we know that the result must
3302e347d3e8Sdrh     ** be false. */
330318016ad2Sdrh     sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfFalse);
33047b35a77bSdan   }
33057b35a77bSdan 
3306e347d3e8Sdrh   /* Jumps here in order to return true. */
3307e347d3e8Sdrh   sqlite3VdbeJumpHere(v, addrTruthOp);
3308e3365e6cSdrh 
3309e347d3e8Sdrh sqlite3ExprCodeIN_finished:
3310e347d3e8Sdrh   if( rLhs!=rLhsOrig ) sqlite3ReleaseTempReg(pParse, rLhs);
3311ecb87ac8Sdrh   VdbeComment((v, "end IN expr"));
3312e347d3e8Sdrh sqlite3ExprCodeIN_oom_error:
3313ba00e30aSdan   sqlite3DbFree(pParse->db, aiMap);
3314553168c7Sdan   sqlite3DbFree(pParse->db, zAff);
3315e3365e6cSdrh }
3316e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
3317e3365e6cSdrh 
331813573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
3319598f1340Sdrh /*
3320598f1340Sdrh ** Generate an instruction that will put the floating point
33219cbf3425Sdrh ** value described by z[0..n-1] into register iMem.
33220cf19ed8Sdrh **
33230cf19ed8Sdrh ** The z[] string will probably not be zero-terminated.  But the
33240cf19ed8Sdrh ** z[n] character is guaranteed to be something that does not look
33250cf19ed8Sdrh ** like the continuation of the number.
3326598f1340Sdrh */
3327b7916a78Sdrh static void codeReal(Vdbe *v, const char *z, int negateFlag, int iMem){
3328fd773cf9Sdrh   if( ALWAYS(z!=0) ){
3329598f1340Sdrh     double value;
33309339da1fSdrh     sqlite3AtoF(z, &value, sqlite3Strlen30(z), SQLITE_UTF8);
3331d0015161Sdrh     assert( !sqlite3IsNaN(value) ); /* The new AtoF never returns NaN */
3332598f1340Sdrh     if( negateFlag ) value = -value;
333397bae794Sdrh     sqlite3VdbeAddOp4Dup8(v, OP_Real, 0, iMem, 0, (u8*)&value, P4_REAL);
3334598f1340Sdrh   }
3335598f1340Sdrh }
333613573c71Sdrh #endif
3337598f1340Sdrh 
3338598f1340Sdrh 
3339598f1340Sdrh /*
3340fec19aadSdrh ** Generate an instruction that will put the integer describe by
33419cbf3425Sdrh ** text z[0..n-1] into register iMem.
33420cf19ed8Sdrh **
33435f1d6b61Sshaneh ** Expr.u.zToken is always UTF8 and zero-terminated.
3344fec19aadSdrh */
334513573c71Sdrh static void codeInteger(Parse *pParse, Expr *pExpr, int negFlag, int iMem){
334613573c71Sdrh   Vdbe *v = pParse->pVdbe;
334792b01d53Sdrh   if( pExpr->flags & EP_IntValue ){
334833e619fcSdrh     int i = pExpr->u.iValue;
3349d50ffc41Sdrh     assert( i>=0 );
335092b01d53Sdrh     if( negFlag ) i = -i;
335192b01d53Sdrh     sqlite3VdbeAddOp2(v, OP_Integer, i, iMem);
3352fd773cf9Sdrh   }else{
33535f1d6b61Sshaneh     int c;
33545f1d6b61Sshaneh     i64 value;
3355fd773cf9Sdrh     const char *z = pExpr->u.zToken;
3356fd773cf9Sdrh     assert( z!=0 );
33579296c18aSdrh     c = sqlite3DecOrHexToI64(z, &value);
335884d4f1a3Sdrh     if( (c==3 && !negFlag) || (c==2) || (negFlag && value==SMALLEST_INT64)){
335913573c71Sdrh #ifdef SQLITE_OMIT_FLOATING_POINT
336013573c71Sdrh       sqlite3ErrorMsg(pParse, "oversized integer: %s%s", negFlag ? "-" : "", z);
336113573c71Sdrh #else
33621b7ddc59Sdrh #ifndef SQLITE_OMIT_HEX_INTEGER
33639296c18aSdrh       if( sqlite3_strnicmp(z,"0x",2)==0 ){
336477320ea4Sdrh         sqlite3ErrorMsg(pParse, "hex literal too big: %s%s", negFlag?"-":"",z);
33651b7ddc59Sdrh       }else
33661b7ddc59Sdrh #endif
33671b7ddc59Sdrh       {
3368b7916a78Sdrh         codeReal(v, z, negFlag, iMem);
33699296c18aSdrh       }
337013573c71Sdrh #endif
337177320ea4Sdrh     }else{
337284d4f1a3Sdrh       if( negFlag ){ value = c==3 ? SMALLEST_INT64 : -value; }
337377320ea4Sdrh       sqlite3VdbeAddOp4Dup8(v, OP_Int64, 0, iMem, 0, (u8*)&value, P4_INT64);
3374fec19aadSdrh     }
3375fec19aadSdrh   }
3376c9cf901dSdanielk1977 }
3377fec19aadSdrh 
33785cd79239Sdrh 
33791f9ca2c8Sdrh /* Generate code that will load into register regOut a value that is
33801f9ca2c8Sdrh ** appropriate for the iIdxCol-th column of index pIdx.
33811f9ca2c8Sdrh */
33821f9ca2c8Sdrh void sqlite3ExprCodeLoadIndexColumn(
33831f9ca2c8Sdrh   Parse *pParse,  /* The parsing context */
33841f9ca2c8Sdrh   Index *pIdx,    /* The index whose column is to be loaded */
33851f9ca2c8Sdrh   int iTabCur,    /* Cursor pointing to a table row */
33861f9ca2c8Sdrh   int iIdxCol,    /* The column of the index to be loaded */
33871f9ca2c8Sdrh   int regOut      /* Store the index column value in this register */
33881f9ca2c8Sdrh ){
33891f9ca2c8Sdrh   i16 iTabCol = pIdx->aiColumn[iIdxCol];
33904b92f98cSdrh   if( iTabCol==XN_EXPR ){
33911f9ca2c8Sdrh     assert( pIdx->aColExpr );
33921f9ca2c8Sdrh     assert( pIdx->aColExpr->nExpr>iIdxCol );
33933e34eabcSdrh     pParse->iSelfTab = iTabCur + 1;
33941c75c9d7Sdrh     sqlite3ExprCodeCopy(pParse, pIdx->aColExpr->a[iIdxCol].pExpr, regOut);
33953e34eabcSdrh     pParse->iSelfTab = 0;
33964b92f98cSdrh   }else{
33976df9c4b9Sdrh     sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pIdx->pTable, iTabCur,
33984b92f98cSdrh                                     iTabCol, regOut);
33994b92f98cSdrh   }
34001f9ca2c8Sdrh }
34011f9ca2c8Sdrh 
3402e70fa7feSdrh #ifndef SQLITE_OMIT_GENERATED_COLUMNS
3403e70fa7feSdrh /*
3404e70fa7feSdrh ** Generate code that will compute the value of generated column pCol
3405e70fa7feSdrh ** and store the result in register regOut
3406e70fa7feSdrh */
3407e70fa7feSdrh void sqlite3ExprCodeGeneratedColumn(
3408e70fa7feSdrh   Parse *pParse,
3409e70fa7feSdrh   Column *pCol,
3410e70fa7feSdrh   int regOut
3411e70fa7feSdrh ){
3412e70fa7feSdrh   sqlite3ExprCode(pParse, pCol->pDflt, regOut);
3413e70fa7feSdrh   if( pCol->affinity>=SQLITE_AFF_TEXT ){
3414e70fa7feSdrh     sqlite3VdbeAddOp4(pParse->pVdbe, OP_Affinity, regOut, 1, 0,
3415e70fa7feSdrh                       &pCol->affinity, 1);
3416e70fa7feSdrh   }
3417e70fa7feSdrh }
3418e70fa7feSdrh #endif /* SQLITE_OMIT_GENERATED_COLUMNS */
3419e70fa7feSdrh 
34205cd79239Sdrh /*
34215c092e8aSdrh ** Generate code to extract the value of the iCol-th column of a table.
34225c092e8aSdrh */
34235c092e8aSdrh void sqlite3ExprCodeGetColumnOfTable(
34246df9c4b9Sdrh   Vdbe *v,        /* Parsing context */
34255c092e8aSdrh   Table *pTab,    /* The table containing the value */
3426313619f5Sdrh   int iTabCur,    /* The table cursor.  Or the PK cursor for WITHOUT ROWID */
34275c092e8aSdrh   int iCol,       /* Index of the column to extract */
3428313619f5Sdrh   int regOut      /* Extract the value into this register */
34295c092e8aSdrh ){
3430ab45fc04Sdrh   Column *pCol;
343181f7b372Sdrh   assert( v!=0 );
3432aca19e19Sdrh   if( pTab==0 ){
3433aca19e19Sdrh     sqlite3VdbeAddOp3(v, OP_Column, iTabCur, iCol, regOut);
3434aca19e19Sdrh     return;
3435aca19e19Sdrh   }
34365c092e8aSdrh   if( iCol<0 || iCol==pTab->iPKey ){
34375c092e8aSdrh     sqlite3VdbeAddOp2(v, OP_Rowid, iTabCur, regOut);
34385c092e8aSdrh   }else{
343981f7b372Sdrh     int op;
344081f7b372Sdrh     int x;
344181f7b372Sdrh     if( IsVirtual(pTab) ){
344281f7b372Sdrh       op = OP_VColumn;
344381f7b372Sdrh       x = iCol;
344481f7b372Sdrh #ifndef SQLITE_OMIT_GENERATED_COLUMNS
3445ab45fc04Sdrh     }else if( (pCol = &pTab->aCol[iCol])->colFlags & COLFLAG_VIRTUAL ){
34466df9c4b9Sdrh       Parse *pParse = sqlite3VdbeParser(v);
3447ab45fc04Sdrh       if( pCol->colFlags & COLFLAG_BUSY ){
3448ab45fc04Sdrh         sqlite3ErrorMsg(pParse, "generated column loop on \"%s\"", pCol->zName);
3449ab45fc04Sdrh       }else{
345081f7b372Sdrh         int savedSelfTab = pParse->iSelfTab;
3451ab45fc04Sdrh         pCol->colFlags |= COLFLAG_BUSY;
345281f7b372Sdrh         pParse->iSelfTab = iTabCur+1;
3453e70fa7feSdrh         sqlite3ExprCodeGeneratedColumn(pParse, pCol, regOut);
345481f7b372Sdrh         pParse->iSelfTab = savedSelfTab;
3455ab45fc04Sdrh         pCol->colFlags &= ~COLFLAG_BUSY;
3456ab45fc04Sdrh       }
345781f7b372Sdrh       return;
345881f7b372Sdrh #endif
345981f7b372Sdrh     }else if( !HasRowid(pTab) ){
3460c5f808d8Sdrh       testcase( iCol!=sqlite3TableColumnToStorage(pTab, iCol) );
3461b9bcf7caSdrh       x = sqlite3TableColumnToIndex(sqlite3PrimaryKeyIndex(pTab), iCol);
346281f7b372Sdrh       op = OP_Column;
346381f7b372Sdrh     }else{
3464b9bcf7caSdrh       x = sqlite3TableColumnToStorage(pTab,iCol);
3465c5f808d8Sdrh       testcase( x!=iCol );
346681f7b372Sdrh       op = OP_Column;
3467ee0ec8e1Sdrh     }
3468ee0ec8e1Sdrh     sqlite3VdbeAddOp3(v, op, iTabCur, x, regOut);
34695c092e8aSdrh     sqlite3ColumnDefault(v, pTab, iCol, regOut);
34705c092e8aSdrh   }
34715c092e8aSdrh }
34725c092e8aSdrh 
34735c092e8aSdrh /*
3474945498f3Sdrh ** Generate code that will extract the iColumn-th column from
34758c607191Sdrh ** table pTab and store the column value in register iReg.
3476e55cbd72Sdrh **
3477e55cbd72Sdrh ** There must be an open cursor to pTab in iTable when this routine
3478e55cbd72Sdrh ** is called.  If iColumn<0 then code is generated that extracts the rowid.
3479945498f3Sdrh */
3480e55cbd72Sdrh int sqlite3ExprCodeGetColumn(
3481e55cbd72Sdrh   Parse *pParse,   /* Parsing and code generating context */
34822133d822Sdrh   Table *pTab,     /* Description of the table we are reading from */
34832133d822Sdrh   int iColumn,     /* Index of the table column */
34842133d822Sdrh   int iTable,      /* The cursor pointing to the table */
3485a748fdccSdrh   int iReg,        /* Store results here */
3486ce78bc6eSdrh   u8 p5            /* P5 value for OP_Column + FLAGS */
34872133d822Sdrh ){
348881f7b372Sdrh   assert( pParse->pVdbe!=0 );
34896df9c4b9Sdrh   sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pTab, iTable, iColumn, iReg);
3490a748fdccSdrh   if( p5 ){
349181f7b372Sdrh     sqlite3VdbeChangeP5(pParse->pVdbe, p5);
3492a748fdccSdrh   }
3493e55cbd72Sdrh   return iReg;
3494e55cbd72Sdrh }
3495e55cbd72Sdrh 
3496e55cbd72Sdrh /*
3497b21e7c70Sdrh ** Generate code to move content from registers iFrom...iFrom+nReg-1
349836a5d88dSdrh ** over to iTo..iTo+nReg-1.
3499e55cbd72Sdrh */
3500b21e7c70Sdrh void sqlite3ExprCodeMove(Parse *pParse, int iFrom, int iTo, int nReg){
3501e8e4af76Sdrh   assert( iFrom>=iTo+nReg || iFrom+nReg<=iTo );
3502079a3072Sdrh   sqlite3VdbeAddOp3(pParse->pVdbe, OP_Move, iFrom, iTo, nReg);
3503945498f3Sdrh }
3504945498f3Sdrh 
3505652fbf55Sdrh /*
350612abf408Sdrh ** Convert a scalar expression node to a TK_REGISTER referencing
350712abf408Sdrh ** register iReg.  The caller must ensure that iReg already contains
350812abf408Sdrh ** the correct value for the expression.
3509a4c3c87eSdrh */
3510069d1b1fSdan static void exprToRegister(Expr *pExpr, int iReg){
35110d950af3Sdrh   Expr *p = sqlite3ExprSkipCollateAndLikely(pExpr);
3512a4c3c87eSdrh   p->op2 = p->op;
3513a4c3c87eSdrh   p->op = TK_REGISTER;
3514a4c3c87eSdrh   p->iTable = iReg;
3515a4c3c87eSdrh   ExprClearProperty(p, EP_Skip);
3516a4c3c87eSdrh }
3517a4c3c87eSdrh 
351812abf408Sdrh /*
351912abf408Sdrh ** Evaluate an expression (either a vector or a scalar expression) and store
352012abf408Sdrh ** the result in continguous temporary registers.  Return the index of
352112abf408Sdrh ** the first register used to store the result.
352212abf408Sdrh **
352312abf408Sdrh ** If the returned result register is a temporary scalar, then also write
352412abf408Sdrh ** that register number into *piFreeable.  If the returned result register
352512abf408Sdrh ** is not a temporary or if the expression is a vector set *piFreeable
352612abf408Sdrh ** to 0.
352712abf408Sdrh */
352812abf408Sdrh static int exprCodeVector(Parse *pParse, Expr *p, int *piFreeable){
352912abf408Sdrh   int iResult;
353012abf408Sdrh   int nResult = sqlite3ExprVectorSize(p);
353112abf408Sdrh   if( nResult==1 ){
353212abf408Sdrh     iResult = sqlite3ExprCodeTemp(pParse, p, piFreeable);
353312abf408Sdrh   }else{
353412abf408Sdrh     *piFreeable = 0;
353512abf408Sdrh     if( p->op==TK_SELECT ){
3536dd1bb43aSdrh #if SQLITE_OMIT_SUBQUERY
3537dd1bb43aSdrh       iResult = 0;
3538dd1bb43aSdrh #else
353985bcdce2Sdrh       iResult = sqlite3CodeSubselect(pParse, p);
3540dd1bb43aSdrh #endif
354112abf408Sdrh     }else{
354212abf408Sdrh       int i;
354312abf408Sdrh       iResult = pParse->nMem+1;
354412abf408Sdrh       pParse->nMem += nResult;
354512abf408Sdrh       for(i=0; i<nResult; i++){
35464b725240Sdan         sqlite3ExprCodeFactorable(pParse, p->x.pList->a[i].pExpr, i+iResult);
354712abf408Sdrh       }
354812abf408Sdrh     }
354912abf408Sdrh   }
355012abf408Sdrh   return iResult;
355112abf408Sdrh }
355212abf408Sdrh 
355371c57db0Sdan 
3554a4c3c87eSdrh /*
3555cce7d176Sdrh ** Generate code into the current Vdbe to evaluate the given
35562dcef11bSdrh ** expression.  Attempt to store the results in register "target".
35572dcef11bSdrh ** Return the register where results are stored.
3558389a1adbSdrh **
35598b213899Sdrh ** With this routine, there is no guarantee that results will
35602dcef11bSdrh ** be stored in target.  The result might be stored in some other
35612dcef11bSdrh ** register if it is convenient to do so.  The calling function
35622dcef11bSdrh ** must check the return code and move the results to the desired
35632dcef11bSdrh ** register.
3564cce7d176Sdrh */
3565678ccce8Sdrh int sqlite3ExprCodeTarget(Parse *pParse, Expr *pExpr, int target){
35662dcef11bSdrh   Vdbe *v = pParse->pVdbe;  /* The VM under construction */
35672dcef11bSdrh   int op;                   /* The opcode being coded */
35682dcef11bSdrh   int inReg = target;       /* Results stored in register inReg */
35692dcef11bSdrh   int regFree1 = 0;         /* If non-zero free this temporary register */
35702dcef11bSdrh   int regFree2 = 0;         /* If non-zero free this temporary register */
35717b35a77bSdan   int r1, r2;               /* Various register numbers */
357210d1edf0Sdrh   Expr tempX;               /* Temporary expression node */
357371c57db0Sdan   int p5 = 0;
3574ffe07b2dSdrh 
35759cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
357620411ea7Sdrh   if( v==0 ){
357720411ea7Sdrh     assert( pParse->db->mallocFailed );
357820411ea7Sdrh     return 0;
357920411ea7Sdrh   }
3580389a1adbSdrh 
35811efa8023Sdrh expr_code_doover:
3582389a1adbSdrh   if( pExpr==0 ){
3583389a1adbSdrh     op = TK_NULL;
3584389a1adbSdrh   }else{
3585f2bc013cSdrh     op = pExpr->op;
3586389a1adbSdrh   }
3587f2bc013cSdrh   switch( op ){
358813449892Sdrh     case TK_AGG_COLUMN: {
358913449892Sdrh       AggInfo *pAggInfo = pExpr->pAggInfo;
359013449892Sdrh       struct AggInfo_col *pCol = &pAggInfo->aCol[pExpr->iAgg];
359113449892Sdrh       if( !pAggInfo->directMode ){
35929de221dfSdrh         assert( pCol->iMem>0 );
3593c332cc30Sdrh         return pCol->iMem;
359413449892Sdrh       }else if( pAggInfo->useSortingIdx ){
35955134d135Sdan         sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdxPTab,
3596389a1adbSdrh                               pCol->iSorterColumn, target);
3597c332cc30Sdrh         return target;
359813449892Sdrh       }
359913449892Sdrh       /* Otherwise, fall thru into the TK_COLUMN case */
360013449892Sdrh     }
3601967e8b73Sdrh     case TK_COLUMN: {
3602b2b9d3d7Sdrh       int iTab = pExpr->iTable;
3603efad2e23Sdrh       if( ExprHasProperty(pExpr, EP_FixedCol) ){
3604d98f5324Sdrh         /* This COLUMN expression is really a constant due to WHERE clause
3605d98f5324Sdrh         ** constraints, and that constant is coded by the pExpr->pLeft
3606d98f5324Sdrh         ** expresssion.  However, make sure the constant has the correct
3607d98f5324Sdrh         ** datatype by applying the Affinity of the table column to the
3608d98f5324Sdrh         ** constant.
3609d98f5324Sdrh         */
3610d98f5324Sdrh         int iReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft,target);
3611eda079cdSdrh         int aff = sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
361296fb16eeSdrh         if( aff>SQLITE_AFF_BLOB ){
3613d98f5324Sdrh           static const char zAff[] = "B\000C\000D\000E";
3614d98f5324Sdrh           assert( SQLITE_AFF_BLOB=='A' );
3615d98f5324Sdrh           assert( SQLITE_AFF_TEXT=='B' );
3616d98f5324Sdrh           if( iReg!=target ){
3617d98f5324Sdrh             sqlite3VdbeAddOp2(v, OP_SCopy, iReg, target);
3618d98f5324Sdrh             iReg = target;
3619d98f5324Sdrh           }
3620d98f5324Sdrh           sqlite3VdbeAddOp4(v, OP_Affinity, iReg, 1, 0,
3621d98f5324Sdrh                             &zAff[(aff-'B')*2], P4_STATIC);
3622d98f5324Sdrh         }
3623d98f5324Sdrh         return iReg;
3624efad2e23Sdrh       }
3625b2b9d3d7Sdrh       if( iTab<0 ){
36266e97f8ecSdrh         if( pParse->iSelfTab<0 ){
36279942ef0dSdrh           /* Other columns in the same row for CHECK constraints or
36289942ef0dSdrh           ** generated columns or for inserting into partial index.
36299942ef0dSdrh           ** The row is unpacked into registers beginning at
36309942ef0dSdrh           ** 0-(pParse->iSelfTab).  The rowid (if any) is in a register
36319942ef0dSdrh           ** immediately prior to the first column.
36329942ef0dSdrh           */
36339942ef0dSdrh           Column *pCol;
36349942ef0dSdrh           Table *pTab = pExpr->y.pTab;
36359942ef0dSdrh           int iSrc;
3636c5f808d8Sdrh           int iCol = pExpr->iColumn;
36379942ef0dSdrh           assert( pTab!=0 );
3638c5f808d8Sdrh           assert( iCol>=XN_ROWID );
3639c5f808d8Sdrh           assert( iCol<pExpr->y.pTab->nCol );
3640c5f808d8Sdrh           if( iCol<0 ){
36419942ef0dSdrh             return -1-pParse->iSelfTab;
36429942ef0dSdrh           }
3643c5f808d8Sdrh           pCol = pTab->aCol + iCol;
3644c5f808d8Sdrh           testcase( iCol!=sqlite3TableColumnToStorage(pTab,iCol) );
3645c5f808d8Sdrh           iSrc = sqlite3TableColumnToStorage(pTab, iCol) - pParse->iSelfTab;
36469942ef0dSdrh #ifndef SQLITE_OMIT_GENERATED_COLUMNS
36479942ef0dSdrh           if( pCol->colFlags & COLFLAG_GENERATED ){
36489942ef0dSdrh             if( pCol->colFlags & COLFLAG_BUSY ){
36499942ef0dSdrh               sqlite3ErrorMsg(pParse, "generated column loop on \"%s\"",
36509942ef0dSdrh                               pCol->zName);
36519942ef0dSdrh               return 0;
36529942ef0dSdrh             }
36539942ef0dSdrh             pCol->colFlags |= COLFLAG_BUSY;
36549942ef0dSdrh             if( pCol->colFlags & COLFLAG_NOTAVAIL ){
3655e70fa7feSdrh               sqlite3ExprCodeGeneratedColumn(pParse, pCol, iSrc);
36569942ef0dSdrh             }
36579942ef0dSdrh             pCol->colFlags &= ~(COLFLAG_BUSY|COLFLAG_NOTAVAIL);
3658dd6cc9b5Sdrh             return iSrc;
36599942ef0dSdrh           }else
36609942ef0dSdrh #endif /* SQLITE_OMIT_GENERATED_COLUMNS */
36619942ef0dSdrh           if( pCol->affinity==SQLITE_AFF_REAL ){
36629942ef0dSdrh             sqlite3VdbeAddOp2(v, OP_SCopy, iSrc, target);
3663bffdd636Sdrh             sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
3664bffdd636Sdrh             return target;
3665bffdd636Sdrh           }else{
36669942ef0dSdrh             return iSrc;
3667bffdd636Sdrh           }
3668c4a3c779Sdrh         }else{
36691f9ca2c8Sdrh           /* Coding an expression that is part of an index where column names
36701f9ca2c8Sdrh           ** in the index refer to the table to which the index belongs */
36713e34eabcSdrh           iTab = pParse->iSelfTab - 1;
36722282792aSdrh         }
3673b2b9d3d7Sdrh       }
3674eda079cdSdrh       return sqlite3ExprCodeGetColumn(pParse, pExpr->y.pTab,
3675b2b9d3d7Sdrh                                pExpr->iColumn, iTab, target,
3676b2b9d3d7Sdrh                                pExpr->op2);
3677cce7d176Sdrh     }
3678cce7d176Sdrh     case TK_INTEGER: {
367913573c71Sdrh       codeInteger(pParse, pExpr, 0, target);
3680c332cc30Sdrh       return target;
368151e9a445Sdrh     }
36828abed7b9Sdrh     case TK_TRUEFALSE: {
368396acafbeSdrh       sqlite3VdbeAddOp2(v, OP_Integer, sqlite3ExprTruthValue(pExpr), target);
3684007c843bSdrh       return target;
3685007c843bSdrh     }
368613573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
3687598f1340Sdrh     case TK_FLOAT: {
368833e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
368933e619fcSdrh       codeReal(v, pExpr->u.zToken, 0, target);
3690c332cc30Sdrh       return target;
3691598f1340Sdrh     }
369213573c71Sdrh #endif
3693fec19aadSdrh     case TK_STRING: {
369433e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
3695076e85f5Sdrh       sqlite3VdbeLoadString(v, target, pExpr->u.zToken);
3696c332cc30Sdrh       return target;
3697cce7d176Sdrh     }
3698f0863fe5Sdrh     case TK_NULL: {
36999de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3700c332cc30Sdrh       return target;
3701f0863fe5Sdrh     }
37025338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_BLOB_LITERAL
3703c572ef7fSdanielk1977     case TK_BLOB: {
37046c8c6cecSdrh       int n;
37056c8c6cecSdrh       const char *z;
3706ca48c90fSdrh       char *zBlob;
370733e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
370833e619fcSdrh       assert( pExpr->u.zToken[0]=='x' || pExpr->u.zToken[0]=='X' );
370933e619fcSdrh       assert( pExpr->u.zToken[1]=='\'' );
371033e619fcSdrh       z = &pExpr->u.zToken[2];
3711b7916a78Sdrh       n = sqlite3Strlen30(z) - 1;
3712b7916a78Sdrh       assert( z[n]=='\'' );
3713ca48c90fSdrh       zBlob = sqlite3HexToBlob(sqlite3VdbeDb(v), z, n);
3714ca48c90fSdrh       sqlite3VdbeAddOp4(v, OP_Blob, n/2, target, 0, zBlob, P4_DYNAMIC);
3715c332cc30Sdrh       return target;
3716c572ef7fSdanielk1977     }
37175338a5f7Sdanielk1977 #endif
371850457896Sdrh     case TK_VARIABLE: {
371933e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
372033e619fcSdrh       assert( pExpr->u.zToken!=0 );
372133e619fcSdrh       assert( pExpr->u.zToken[0]!=0 );
3722eaf52d88Sdrh       sqlite3VdbeAddOp2(v, OP_Variable, pExpr->iColumn, target);
372333e619fcSdrh       if( pExpr->u.zToken[1]!=0 ){
37249bf755ccSdrh         const char *z = sqlite3VListNumToName(pParse->pVList, pExpr->iColumn);
37259bf755ccSdrh         assert( pExpr->u.zToken[0]=='?' || strcmp(pExpr->u.zToken, z)==0 );
3726ce1bbe51Sdrh         pParse->pVList[0] = 0; /* Indicate VList may no longer be enlarged */
37279bf755ccSdrh         sqlite3VdbeAppendP4(v, (char*)z, P4_STATIC);
37289bf755ccSdrh       }
3729c332cc30Sdrh       return target;
373050457896Sdrh     }
37314e0cff60Sdrh     case TK_REGISTER: {
3732c332cc30Sdrh       return pExpr->iTable;
37334e0cff60Sdrh     }
3734487e262fSdrh #ifndef SQLITE_OMIT_CAST
3735487e262fSdrh     case TK_CAST: {
3736487e262fSdrh       /* Expressions of the form:   CAST(pLeft AS token) */
37372dcef11bSdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
37381735fa88Sdrh       if( inReg!=target ){
37391735fa88Sdrh         sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
37401735fa88Sdrh         inReg = target;
37411735fa88Sdrh       }
37424169e430Sdrh       sqlite3VdbeAddOp2(v, OP_Cast, target,
37434169e430Sdrh                         sqlite3AffinityType(pExpr->u.zToken, 0));
3744c332cc30Sdrh       return inReg;
3745487e262fSdrh     }
3746487e262fSdrh #endif /* SQLITE_OMIT_CAST */
374771c57db0Sdan     case TK_IS:
374871c57db0Sdan     case TK_ISNOT:
374971c57db0Sdan       op = (op==TK_IS) ? TK_EQ : TK_NE;
375071c57db0Sdan       p5 = SQLITE_NULLEQ;
375171c57db0Sdan       /* fall-through */
3752c9b84a1fSdrh     case TK_LT:
3753c9b84a1fSdrh     case TK_LE:
3754c9b84a1fSdrh     case TK_GT:
3755c9b84a1fSdrh     case TK_GE:
3756c9b84a1fSdrh     case TK_NE:
3757c9b84a1fSdrh     case TK_EQ: {
375871c57db0Sdan       Expr *pLeft = pExpr->pLeft;
3759625015e0Sdan       if( sqlite3ExprIsVector(pLeft) ){
376079752b6eSdrh         codeVectorCompare(pParse, pExpr, target, op, p5);
376171c57db0Sdan       }else{
376271c57db0Sdan         r1 = sqlite3ExprCodeTemp(pParse, pLeft, &regFree1);
3763b6da74ebSdrh         r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
376471c57db0Sdan         codeCompare(pParse, pLeft, pExpr->pRight, op,
3765898c527eSdrh             r1, r2, inReg, SQLITE_STOREP2 | p5,
3766898c527eSdrh             ExprHasProperty(pExpr,EP_Commuted));
37677d176105Sdrh         assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
37687d176105Sdrh         assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
37697d176105Sdrh         assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
37707d176105Sdrh         assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
37717d176105Sdrh         assert(TK_EQ==OP_Eq); testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
37727d176105Sdrh         assert(TK_NE==OP_Ne); testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
3773c5499befSdrh         testcase( regFree1==0 );
3774c5499befSdrh         testcase( regFree2==0 );
3775c9b84a1fSdrh       }
37766a2fe093Sdrh       break;
37776a2fe093Sdrh     }
3778cce7d176Sdrh     case TK_AND:
3779cce7d176Sdrh     case TK_OR:
3780cce7d176Sdrh     case TK_PLUS:
3781cce7d176Sdrh     case TK_STAR:
3782cce7d176Sdrh     case TK_MINUS:
3783bf4133cbSdrh     case TK_REM:
3784bf4133cbSdrh     case TK_BITAND:
3785bf4133cbSdrh     case TK_BITOR:
378617c40294Sdrh     case TK_SLASH:
3787bf4133cbSdrh     case TK_LSHIFT:
3788855eb1cfSdrh     case TK_RSHIFT:
37890040077dSdrh     case TK_CONCAT: {
37907d176105Sdrh       assert( TK_AND==OP_And );            testcase( op==TK_AND );
37917d176105Sdrh       assert( TK_OR==OP_Or );              testcase( op==TK_OR );
37927d176105Sdrh       assert( TK_PLUS==OP_Add );           testcase( op==TK_PLUS );
37937d176105Sdrh       assert( TK_MINUS==OP_Subtract );     testcase( op==TK_MINUS );
37947d176105Sdrh       assert( TK_REM==OP_Remainder );      testcase( op==TK_REM );
37957d176105Sdrh       assert( TK_BITAND==OP_BitAnd );      testcase( op==TK_BITAND );
37967d176105Sdrh       assert( TK_BITOR==OP_BitOr );        testcase( op==TK_BITOR );
37977d176105Sdrh       assert( TK_SLASH==OP_Divide );       testcase( op==TK_SLASH );
37987d176105Sdrh       assert( TK_LSHIFT==OP_ShiftLeft );   testcase( op==TK_LSHIFT );
37997d176105Sdrh       assert( TK_RSHIFT==OP_ShiftRight );  testcase( op==TK_RSHIFT );
38007d176105Sdrh       assert( TK_CONCAT==OP_Concat );      testcase( op==TK_CONCAT );
38012dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
38022dcef11bSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
38035b6afba9Sdrh       sqlite3VdbeAddOp3(v, op, r2, r1, target);
3804c5499befSdrh       testcase( regFree1==0 );
3805c5499befSdrh       testcase( regFree2==0 );
38060040077dSdrh       break;
38070040077dSdrh     }
3808cce7d176Sdrh     case TK_UMINUS: {
3809fec19aadSdrh       Expr *pLeft = pExpr->pLeft;
3810fec19aadSdrh       assert( pLeft );
381113573c71Sdrh       if( pLeft->op==TK_INTEGER ){
381213573c71Sdrh         codeInteger(pParse, pLeft, 1, target);
3813c332cc30Sdrh         return target;
381413573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
381513573c71Sdrh       }else if( pLeft->op==TK_FLOAT ){
381633e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
381733e619fcSdrh         codeReal(v, pLeft->u.zToken, 1, target);
3818c332cc30Sdrh         return target;
381913573c71Sdrh #endif
38203c84ddffSdrh       }else{
382110d1edf0Sdrh         tempX.op = TK_INTEGER;
382210d1edf0Sdrh         tempX.flags = EP_IntValue|EP_TokenOnly;
382310d1edf0Sdrh         tempX.u.iValue = 0;
382410d1edf0Sdrh         r1 = sqlite3ExprCodeTemp(pParse, &tempX, &regFree1);
3825e55cbd72Sdrh         r2 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree2);
38262dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_Subtract, r2, r1, target);
3827c5499befSdrh         testcase( regFree2==0 );
38283c84ddffSdrh       }
38296e142f54Sdrh       break;
38306e142f54Sdrh     }
3831bf4133cbSdrh     case TK_BITNOT:
38326e142f54Sdrh     case TK_NOT: {
38337d176105Sdrh       assert( TK_BITNOT==OP_BitNot );   testcase( op==TK_BITNOT );
38347d176105Sdrh       assert( TK_NOT==OP_Not );         testcase( op==TK_NOT );
3835e99fa2afSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3836e99fa2afSdrh       testcase( regFree1==0 );
3837e99fa2afSdrh       sqlite3VdbeAddOp2(v, op, r1, inReg);
3838cce7d176Sdrh       break;
3839cce7d176Sdrh     }
38408abed7b9Sdrh     case TK_TRUTH: {
384196acafbeSdrh       int isTrue;    /* IS TRUE or IS NOT TRUE */
384296acafbeSdrh       int bNormal;   /* IS TRUE or IS FALSE */
3843007c843bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3844007c843bSdrh       testcase( regFree1==0 );
384596acafbeSdrh       isTrue = sqlite3ExprTruthValue(pExpr->pRight);
384696acafbeSdrh       bNormal = pExpr->op2==TK_IS;
384796acafbeSdrh       testcase( isTrue && bNormal);
384896acafbeSdrh       testcase( !isTrue && bNormal);
384996acafbeSdrh       sqlite3VdbeAddOp4Int(v, OP_IsTrue, r1, inReg, !isTrue, isTrue ^ bNormal);
3850007c843bSdrh       break;
3851007c843bSdrh     }
3852cce7d176Sdrh     case TK_ISNULL:
3853cce7d176Sdrh     case TK_NOTNULL: {
38546a288a33Sdrh       int addr;
38557d176105Sdrh       assert( TK_ISNULL==OP_IsNull );   testcase( op==TK_ISNULL );
38567d176105Sdrh       assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
38579de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
38582dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3859c5499befSdrh       testcase( regFree1==0 );
38602dcef11bSdrh       addr = sqlite3VdbeAddOp1(v, op, r1);
38617d176105Sdrh       VdbeCoverageIf(v, op==TK_ISNULL);
38627d176105Sdrh       VdbeCoverageIf(v, op==TK_NOTNULL);
3863a976979bSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 0, target);
38646a288a33Sdrh       sqlite3VdbeJumpHere(v, addr);
3865a37cdde0Sdanielk1977       break;
3866f2bc013cSdrh     }
38672282792aSdrh     case TK_AGG_FUNCTION: {
386813449892Sdrh       AggInfo *pInfo = pExpr->pAggInfo;
38697e56e711Sdrh       if( pInfo==0 ){
387033e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
387133e619fcSdrh         sqlite3ErrorMsg(pParse, "misuse of aggregate: %s()", pExpr->u.zToken);
38727e56e711Sdrh       }else{
3873c332cc30Sdrh         return pInfo->aFunc[pExpr->iAgg].iMem;
38747e56e711Sdrh       }
38752282792aSdrh       break;
38762282792aSdrh     }
3877cce7d176Sdrh     case TK_FUNCTION: {
387812ffee8cSdrh       ExprList *pFarg;       /* List of function arguments */
387912ffee8cSdrh       int nFarg;             /* Number of function arguments */
388012ffee8cSdrh       FuncDef *pDef;         /* The function definition object */
388112ffee8cSdrh       const char *zId;       /* The function name */
3882693e6719Sdrh       u32 constMask = 0;     /* Mask of function arguments that are constant */
388312ffee8cSdrh       int i;                 /* Loop counter */
3884c332cc30Sdrh       sqlite3 *db = pParse->db;  /* The database connection */
388512ffee8cSdrh       u8 enc = ENC(db);      /* The text encoding used by this database */
388612ffee8cSdrh       CollSeq *pColl = 0;    /* A collating sequence */
388717435752Sdrh 
388867a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
3889eda079cdSdrh       if( ExprHasProperty(pExpr, EP_WinFunc) ){
3890eda079cdSdrh         return pExpr->y.pWin->regResult;
389186fb6e17Sdan       }
389267a9b8edSdan #endif
389386fb6e17Sdan 
38941e9b53f9Sdrh       if( ConstFactorOk(pParse) && sqlite3ExprIsConstantNotJoin(pExpr) ){
389549c5ab24Sdrh         /* SQL functions can be expensive. So try to move constant functions
3896ad879ffdSdrh         ** out of the inner loop, even if that means an extra OP_Copy. */
3897ad879ffdSdrh         return sqlite3ExprCodeAtInit(pParse, pExpr, -1);
38981e9b53f9Sdrh       }
38996ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
3900c5cd1249Sdrh       if( ExprHasProperty(pExpr, EP_TokenOnly) ){
390112ffee8cSdrh         pFarg = 0;
390212ffee8cSdrh       }else{
390312ffee8cSdrh         pFarg = pExpr->x.pList;
390412ffee8cSdrh       }
390512ffee8cSdrh       nFarg = pFarg ? pFarg->nExpr : 0;
390633e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
390733e619fcSdrh       zId = pExpr->u.zToken;
390880738d9cSdrh       pDef = sqlite3FindFunction(db, zId, nFarg, enc, 0);
3909cc15313cSdrh #ifdef SQLITE_ENABLE_UNKNOWN_SQL_FUNCTION
3910cc15313cSdrh       if( pDef==0 && pParse->explain ){
3911cc15313cSdrh         pDef = sqlite3FindFunction(db, "unknown", nFarg, enc, 0);
3912cc15313cSdrh       }
3913cc15313cSdrh #endif
3914b6e9f7a4Sdan       if( pDef==0 || pDef->xFinalize!=0 ){
391580738d9cSdrh         sqlite3ErrorMsg(pParse, "unknown function: %s()", zId);
3916feb306f5Sdrh         break;
3917feb306f5Sdrh       }
3918ae6bb957Sdrh 
3919ae6bb957Sdrh       /* Attempt a direct implementation of the built-in COALESCE() and
392060ec914cSpeter.d.reid       ** IFNULL() functions.  This avoids unnecessary evaluation of
3921ae6bb957Sdrh       ** arguments past the first non-NULL argument.
3922ae6bb957Sdrh       */
3923d36e1041Sdrh       if( pDef->funcFlags & SQLITE_FUNC_COALESCE ){
3924ec4ccdbcSdrh         int endCoalesce = sqlite3VdbeMakeLabel(pParse);
3925ae6bb957Sdrh         assert( nFarg>=2 );
3926ae6bb957Sdrh         sqlite3ExprCode(pParse, pFarg->a[0].pExpr, target);
3927ae6bb957Sdrh         for(i=1; i<nFarg; i++){
3928ae6bb957Sdrh           sqlite3VdbeAddOp2(v, OP_NotNull, target, endCoalesce);
3929688852abSdrh           VdbeCoverage(v);
3930ae6bb957Sdrh           sqlite3ExprCode(pParse, pFarg->a[i].pExpr, target);
3931ae6bb957Sdrh         }
3932ae6bb957Sdrh         sqlite3VdbeResolveLabel(v, endCoalesce);
3933ae6bb957Sdrh         break;
3934ae6bb957Sdrh       }
3935ae6bb957Sdrh 
3936cca9f3d2Sdrh       /* The UNLIKELY() function is a no-op.  The result is the value
3937cca9f3d2Sdrh       ** of the first argument.
3938cca9f3d2Sdrh       */
3939cca9f3d2Sdrh       if( pDef->funcFlags & SQLITE_FUNC_UNLIKELY ){
3940cca9f3d2Sdrh         assert( nFarg>=1 );
3941c332cc30Sdrh         return sqlite3ExprCodeTarget(pParse, pFarg->a[0].pExpr, target);
3942cca9f3d2Sdrh       }
3943ae6bb957Sdrh 
394454240751Sdrh #ifdef SQLITE_DEBUG
3945a1a523a5Sdrh       /* The AFFINITY() function evaluates to a string that describes
3946a1a523a5Sdrh       ** the type affinity of the argument.  This is used for testing of
3947a1a523a5Sdrh       ** the SQLite type logic.
3948a1a523a5Sdrh       */
3949a1a523a5Sdrh       if( pDef->funcFlags & SQLITE_FUNC_AFFINITY ){
3950a1a523a5Sdrh         const char *azAff[] = { "blob", "text", "numeric", "integer", "real" };
3951a1a523a5Sdrh         char aff;
3952a1a523a5Sdrh         assert( nFarg==1 );
3953a1a523a5Sdrh         aff = sqlite3ExprAffinity(pFarg->a[0].pExpr);
3954a1a523a5Sdrh         sqlite3VdbeLoadString(v, target,
395596fb16eeSdrh                 (aff<=SQLITE_AFF_NONE) ? "none" : azAff[aff-SQLITE_AFF_BLOB]);
3956a1a523a5Sdrh         return target;
3957a1a523a5Sdrh       }
395854240751Sdrh #endif
3959a1a523a5Sdrh 
3960d1a01edaSdrh       for(i=0; i<nFarg; i++){
3961d1a01edaSdrh         if( i<32 && sqlite3ExprIsConstant(pFarg->a[i].pExpr) ){
3962693e6719Sdrh           testcase( i==31 );
3963693e6719Sdrh           constMask |= MASKBIT32(i);
3964d1a01edaSdrh         }
3965d1a01edaSdrh         if( (pDef->funcFlags & SQLITE_FUNC_NEEDCOLL)!=0 && !pColl ){
3966d1a01edaSdrh           pColl = sqlite3ExprCollSeq(pParse, pFarg->a[i].pExpr);
3967d1a01edaSdrh         }
3968d1a01edaSdrh       }
396912ffee8cSdrh       if( pFarg ){
3970d1a01edaSdrh         if( constMask ){
3971d1a01edaSdrh           r1 = pParse->nMem+1;
3972d1a01edaSdrh           pParse->nMem += nFarg;
3973d1a01edaSdrh         }else{
397412ffee8cSdrh           r1 = sqlite3GetTempRange(pParse, nFarg);
3975d1a01edaSdrh         }
3976a748fdccSdrh 
3977a748fdccSdrh         /* For length() and typeof() functions with a column argument,
3978a748fdccSdrh         ** set the P5 parameter to the OP_Column opcode to OPFLAG_LENGTHARG
3979a748fdccSdrh         ** or OPFLAG_TYPEOFARG respectively, to avoid unnecessary data
3980a748fdccSdrh         ** loading.
3981a748fdccSdrh         */
3982d36e1041Sdrh         if( (pDef->funcFlags & (SQLITE_FUNC_LENGTH|SQLITE_FUNC_TYPEOF))!=0 ){
39834e245a4cSdrh           u8 exprOp;
3984a748fdccSdrh           assert( nFarg==1 );
3985a748fdccSdrh           assert( pFarg->a[0].pExpr!=0 );
39864e245a4cSdrh           exprOp = pFarg->a[0].pExpr->op;
39874e245a4cSdrh           if( exprOp==TK_COLUMN || exprOp==TK_AGG_COLUMN ){
3988a748fdccSdrh             assert( SQLITE_FUNC_LENGTH==OPFLAG_LENGTHARG );
3989a748fdccSdrh             assert( SQLITE_FUNC_TYPEOF==OPFLAG_TYPEOFARG );
3990b1fba286Sdrh             testcase( pDef->funcFlags & OPFLAG_LENGTHARG );
3991b1fba286Sdrh             pFarg->a[0].pExpr->op2 =
3992b1fba286Sdrh                   pDef->funcFlags & (OPFLAG_LENGTHARG|OPFLAG_TYPEOFARG);
3993a748fdccSdrh           }
3994a748fdccSdrh         }
3995a748fdccSdrh 
39965579d59fSdrh         sqlite3ExprCodeExprList(pParse, pFarg, r1, 0,
3997d1a01edaSdrh                                 SQLITE_ECEL_DUP|SQLITE_ECEL_FACTOR);
3998892d3179Sdrh       }else{
399912ffee8cSdrh         r1 = 0;
4000892d3179Sdrh       }
4001b7f6f68fSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
4002a43fa227Sdrh       /* Possibly overload the function if the first argument is
4003a43fa227Sdrh       ** a virtual table column.
4004a43fa227Sdrh       **
4005a43fa227Sdrh       ** For infix functions (LIKE, GLOB, REGEXP, and MATCH) use the
4006a43fa227Sdrh       ** second argument, not the first, as the argument to test to
4007a43fa227Sdrh       ** see if it is a column in a virtual table.  This is done because
4008a43fa227Sdrh       ** the left operand of infix functions (the operand we want to
4009a43fa227Sdrh       ** control overloading) ends up as the second argument to the
4010a43fa227Sdrh       ** function.  The expression "A glob B" is equivalent to
4011a43fa227Sdrh       ** "glob(B,A).  We want to use the A in "A glob B" to test
4012a43fa227Sdrh       ** for function overloading.  But we use the B term in "glob(B,A)".
4013a43fa227Sdrh       */
401459155065Sdrh       if( nFarg>=2 && ExprHasProperty(pExpr, EP_InfixFunc) ){
401512ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[1].pExpr);
401612ffee8cSdrh       }else if( nFarg>0 ){
401712ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[0].pExpr);
4018b7f6f68fSdrh       }
4019b7f6f68fSdrh #endif
4020d36e1041Sdrh       if( pDef->funcFlags & SQLITE_FUNC_NEEDCOLL ){
40218b213899Sdrh         if( !pColl ) pColl = db->pDfltColl;
402266a5167bSdrh         sqlite3VdbeAddOp4(v, OP_CollSeq, 0, 0, 0, (char *)pColl, P4_COLLSEQ);
4023682f68b0Sdanielk1977       }
4024092457b1Sdrh #ifdef SQLITE_ENABLE_OFFSET_SQL_FUNC
4025092457b1Sdrh       if( pDef->funcFlags & SQLITE_FUNC_OFFSET ){
40262fc865c1Sdrh         Expr *pArg = pFarg->a[0].pExpr;
40272fc865c1Sdrh         if( pArg->op==TK_COLUMN ){
4028092457b1Sdrh           sqlite3VdbeAddOp3(v, OP_Offset, pArg->iTable, pArg->iColumn, target);
40292fc865c1Sdrh         }else{
40302fc865c1Sdrh           sqlite3VdbeAddOp2(v, OP_Null, 0, target);
40312fc865c1Sdrh         }
4032092457b1Sdrh       }else
4033092457b1Sdrh #endif
4034092457b1Sdrh       {
4035920cf596Sdrh         sqlite3VdbeAddFunctionCall(pParse, constMask, r1, target, nFarg,
403620cee7d0Sdrh                                    pDef, pExpr->op2);
40372fc865c1Sdrh       }
4038d1a01edaSdrh       if( nFarg && constMask==0 ){
403912ffee8cSdrh         sqlite3ReleaseTempRange(pParse, r1, nFarg);
40402dcef11bSdrh       }
4041c332cc30Sdrh       return target;
40426ec2733bSdrh     }
4043fe2093d7Sdrh #ifndef SQLITE_OMIT_SUBQUERY
4044fe2093d7Sdrh     case TK_EXISTS:
404519a775c2Sdrh     case TK_SELECT: {
40468da209b1Sdan       int nCol;
4047c5499befSdrh       testcase( op==TK_EXISTS );
4048c5499befSdrh       testcase( op==TK_SELECT );
40498da209b1Sdan       if( op==TK_SELECT && (nCol = pExpr->x.pSelect->pEList->nExpr)!=1 ){
40508da209b1Sdan         sqlite3SubselectError(pParse, nCol, 1);
40518da209b1Sdan       }else{
405285bcdce2Sdrh         return sqlite3CodeSubselect(pParse, pExpr);
40538da209b1Sdan       }
405419a775c2Sdrh       break;
405519a775c2Sdrh     }
4056fc7f27b9Sdrh     case TK_SELECT_COLUMN: {
4057966e2911Sdrh       int n;
4058fc7f27b9Sdrh       if( pExpr->pLeft->iTable==0 ){
405985bcdce2Sdrh         pExpr->pLeft->iTable = sqlite3CodeSubselect(pParse, pExpr->pLeft);
4060fc7f27b9Sdrh       }
4061966e2911Sdrh       assert( pExpr->iTable==0 || pExpr->pLeft->op==TK_SELECT );
4062554a9dc7Sdrh       if( pExpr->iTable!=0
4063966e2911Sdrh        && pExpr->iTable!=(n = sqlite3ExprVectorSize(pExpr->pLeft))
4064966e2911Sdrh       ){
4065966e2911Sdrh         sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
4066966e2911Sdrh                                 pExpr->iTable, n);
4067966e2911Sdrh       }
4068c332cc30Sdrh       return pExpr->pLeft->iTable + pExpr->iColumn;
4069fc7f27b9Sdrh     }
4070fef5208cSdrh     case TK_IN: {
4071ec4ccdbcSdrh       int destIfFalse = sqlite3VdbeMakeLabel(pParse);
4072ec4ccdbcSdrh       int destIfNull = sqlite3VdbeMakeLabel(pParse);
4073e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
4074e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
407566ba23ceSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
4076e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
4077e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_AddImm, target, 0);
4078e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfNull);
4079c332cc30Sdrh       return target;
4080fef5208cSdrh     }
4081e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
4082e3365e6cSdrh 
4083e3365e6cSdrh 
40842dcef11bSdrh     /*
40852dcef11bSdrh     **    x BETWEEN y AND z
40862dcef11bSdrh     **
40872dcef11bSdrh     ** This is equivalent to
40882dcef11bSdrh     **
40892dcef11bSdrh     **    x>=y AND x<=z
40902dcef11bSdrh     **
40912dcef11bSdrh     ** X is stored in pExpr->pLeft.
40922dcef11bSdrh     ** Y is stored in pExpr->pList->a[0].pExpr.
40932dcef11bSdrh     ** Z is stored in pExpr->pList->a[1].pExpr.
40942dcef11bSdrh     */
4095fef5208cSdrh     case TK_BETWEEN: {
409671c57db0Sdan       exprCodeBetween(pParse, pExpr, target, 0, 0);
4097c332cc30Sdrh       return target;
4098fef5208cSdrh     }
409994fa9c41Sdrh     case TK_SPAN:
4100ae80ddeaSdrh     case TK_COLLATE:
41014f07e5fbSdrh     case TK_UPLUS: {
41021efa8023Sdrh       pExpr = pExpr->pLeft;
410359ee43a7Sdrh       goto expr_code_doover; /* 2018-04-28: Prevent deep recursion. OSSFuzz. */
4104a2e00042Sdrh     }
41052dcef11bSdrh 
4106165921a7Sdan     case TK_TRIGGER: {
410765a7cd16Sdan       /* If the opcode is TK_TRIGGER, then the expression is a reference
410865a7cd16Sdan       ** to a column in the new.* or old.* pseudo-tables available to
410965a7cd16Sdan       ** trigger programs. In this case Expr.iTable is set to 1 for the
411065a7cd16Sdan       ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
411165a7cd16Sdan       ** is set to the column of the pseudo-table to read, or to -1 to
411265a7cd16Sdan       ** read the rowid field.
411365a7cd16Sdan       **
411465a7cd16Sdan       ** The expression is implemented using an OP_Param opcode. The p1
411565a7cd16Sdan       ** parameter is set to 0 for an old.rowid reference, or to (i+1)
411665a7cd16Sdan       ** to reference another column of the old.* pseudo-table, where
411765a7cd16Sdan       ** i is the index of the column. For a new.rowid reference, p1 is
411865a7cd16Sdan       ** set to (n+1), where n is the number of columns in each pseudo-table.
411965a7cd16Sdan       ** For a reference to any other column in the new.* pseudo-table, p1
412065a7cd16Sdan       ** is set to (n+2+i), where n and i are as defined previously. For
412165a7cd16Sdan       ** example, if the table on which triggers are being fired is
412265a7cd16Sdan       ** declared as:
412365a7cd16Sdan       **
412465a7cd16Sdan       **   CREATE TABLE t1(a, b);
412565a7cd16Sdan       **
412665a7cd16Sdan       ** Then p1 is interpreted as follows:
412765a7cd16Sdan       **
412865a7cd16Sdan       **   p1==0   ->    old.rowid     p1==3   ->    new.rowid
412965a7cd16Sdan       **   p1==1   ->    old.a         p1==4   ->    new.a
413065a7cd16Sdan       **   p1==2   ->    old.b         p1==5   ->    new.b
413165a7cd16Sdan       */
4132eda079cdSdrh       Table *pTab = pExpr->y.pTab;
4133dd6cc9b5Sdrh       int iCol = pExpr->iColumn;
4134dd6cc9b5Sdrh       int p1 = pExpr->iTable * (pTab->nCol+1) + 1
4135dd6cc9b5Sdrh                      + (iCol>=0 ? sqlite3TableColumnToStorage(pTab, iCol) : -1);
413665a7cd16Sdan 
413765a7cd16Sdan       assert( pExpr->iTable==0 || pExpr->iTable==1 );
4138dd6cc9b5Sdrh       assert( iCol>=-1 && iCol<pTab->nCol );
4139dd6cc9b5Sdrh       assert( pTab->iPKey<0 || iCol!=pTab->iPKey );
414065a7cd16Sdan       assert( p1>=0 && p1<(pTab->nCol*2+2) );
414165a7cd16Sdan 
414265a7cd16Sdan       sqlite3VdbeAddOp2(v, OP_Param, p1, target);
4143896494e8Sdrh       VdbeComment((v, "r[%d]=%s.%s", target,
4144165921a7Sdan         (pExpr->iTable ? "new" : "old"),
4145dd6cc9b5Sdrh         (pExpr->iColumn<0 ? "rowid" : pExpr->y.pTab->aCol[iCol].zName)
4146165921a7Sdan       ));
414765a7cd16Sdan 
414844dbca83Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
414965a7cd16Sdan       /* If the column has REAL affinity, it may currently be stored as an
4150113762a2Sdrh       ** integer. Use OP_RealAffinity to make sure it is really real.
4151113762a2Sdrh       **
4152113762a2Sdrh       ** EVIDENCE-OF: R-60985-57662 SQLite will convert the value back to
4153113762a2Sdrh       ** floating point when extracting it from the record.  */
4154dd6cc9b5Sdrh       if( iCol>=0 && pTab->aCol[iCol].affinity==SQLITE_AFF_REAL ){
41552832ad42Sdan         sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
41562832ad42Sdan       }
415744dbca83Sdrh #endif
4158165921a7Sdan       break;
4159165921a7Sdan     }
4160165921a7Sdan 
416171c57db0Sdan     case TK_VECTOR: {
4162e835bc12Sdrh       sqlite3ErrorMsg(pParse, "row value misused");
416371c57db0Sdan       break;
416471c57db0Sdan     }
416571c57db0Sdan 
41669e9a67adSdrh     /* TK_IF_NULL_ROW Expr nodes are inserted ahead of expressions
41679e9a67adSdrh     ** that derive from the right-hand table of a LEFT JOIN.  The
41689e9a67adSdrh     ** Expr.iTable value is the table number for the right-hand table.
41699e9a67adSdrh     ** The expression is only evaluated if that table is not currently
41709e9a67adSdrh     ** on a LEFT JOIN NULL row.
41719e9a67adSdrh     */
417231d6fd55Sdrh     case TK_IF_NULL_ROW: {
417331d6fd55Sdrh       int addrINR;
41749e9a67adSdrh       u8 okConstFactor = pParse->okConstFactor;
417531d6fd55Sdrh       addrINR = sqlite3VdbeAddOp1(v, OP_IfNullRow, pExpr->iTable);
41769e9a67adSdrh       /* Temporarily disable factoring of constant expressions, since
41779e9a67adSdrh       ** even though expressions may appear to be constant, they are not
41789e9a67adSdrh       ** really constant because they originate from the right-hand side
41799e9a67adSdrh       ** of a LEFT JOIN. */
41809e9a67adSdrh       pParse->okConstFactor = 0;
418131d6fd55Sdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
41829e9a67adSdrh       pParse->okConstFactor = okConstFactor;
418331d6fd55Sdrh       sqlite3VdbeJumpHere(v, addrINR);
418431d6fd55Sdrh       sqlite3VdbeChangeP3(v, addrINR, inReg);
418531d6fd55Sdrh       break;
418631d6fd55Sdrh     }
418731d6fd55Sdrh 
41882dcef11bSdrh     /*
41892dcef11bSdrh     ** Form A:
41902dcef11bSdrh     **   CASE x WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
41912dcef11bSdrh     **
41922dcef11bSdrh     ** Form B:
41932dcef11bSdrh     **   CASE WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
41942dcef11bSdrh     **
41952dcef11bSdrh     ** Form A is can be transformed into the equivalent form B as follows:
41962dcef11bSdrh     **   CASE WHEN x=e1 THEN r1 WHEN x=e2 THEN r2 ...
41972dcef11bSdrh     **        WHEN x=eN THEN rN ELSE y END
41982dcef11bSdrh     **
41992dcef11bSdrh     ** X (if it exists) is in pExpr->pLeft.
4200c5cd1249Sdrh     ** Y is in the last element of pExpr->x.pList if pExpr->x.pList->nExpr is
4201c5cd1249Sdrh     ** odd.  The Y is also optional.  If the number of elements in x.pList
4202c5cd1249Sdrh     ** is even, then Y is omitted and the "otherwise" result is NULL.
42032dcef11bSdrh     ** Ei is in pExpr->pList->a[i*2] and Ri is pExpr->pList->a[i*2+1].
42042dcef11bSdrh     **
42052dcef11bSdrh     ** The result of the expression is the Ri for the first matching Ei,
42062dcef11bSdrh     ** or if there is no matching Ei, the ELSE term Y, or if there is
42072dcef11bSdrh     ** no ELSE term, NULL.
42082dcef11bSdrh     */
420933cd4909Sdrh     default: assert( op==TK_CASE ); {
42102dcef11bSdrh       int endLabel;                     /* GOTO label for end of CASE stmt */
42112dcef11bSdrh       int nextCase;                     /* GOTO label for next WHEN clause */
42122dcef11bSdrh       int nExpr;                        /* 2x number of WHEN terms */
42132dcef11bSdrh       int i;                            /* Loop counter */
42142dcef11bSdrh       ExprList *pEList;                 /* List of WHEN terms */
42152dcef11bSdrh       struct ExprList_item *aListelem;  /* Array of WHEN terms */
42162dcef11bSdrh       Expr opCompare;                   /* The X==Ei expression */
42172dcef11bSdrh       Expr *pX;                         /* The X expression */
42181bd10f8aSdrh       Expr *pTest = 0;                  /* X==Ei (form A) or just Ei (form B) */
42198b65e591Sdan       Expr *pDel = 0;
42208b65e591Sdan       sqlite3 *db = pParse->db;
422117a7f8ddSdrh 
42226ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) && pExpr->x.pList );
42236ab3a2ecSdanielk1977       assert(pExpr->x.pList->nExpr > 0);
42246ab3a2ecSdanielk1977       pEList = pExpr->x.pList;
4225be5c89acSdrh       aListelem = pEList->a;
4226be5c89acSdrh       nExpr = pEList->nExpr;
4227ec4ccdbcSdrh       endLabel = sqlite3VdbeMakeLabel(pParse);
42282dcef11bSdrh       if( (pX = pExpr->pLeft)!=0 ){
42298b65e591Sdan         pDel = sqlite3ExprDup(db, pX, 0);
42308b65e591Sdan         if( db->mallocFailed ){
42318b65e591Sdan           sqlite3ExprDelete(db, pDel);
42328b65e591Sdan           break;
42338b65e591Sdan         }
423433cd4909Sdrh         testcase( pX->op==TK_COLUMN );
42358b65e591Sdan         exprToRegister(pDel, exprCodeVector(pParse, pDel, &regFree1));
4236c5499befSdrh         testcase( regFree1==0 );
4237abb9d5f1Sdrh         memset(&opCompare, 0, sizeof(opCompare));
42382dcef11bSdrh         opCompare.op = TK_EQ;
42398b65e591Sdan         opCompare.pLeft = pDel;
42402dcef11bSdrh         pTest = &opCompare;
42418b1db07fSdrh         /* Ticket b351d95f9cd5ef17e9d9dbae18f5ca8611190001:
42428b1db07fSdrh         ** The value in regFree1 might get SCopy-ed into the file result.
42438b1db07fSdrh         ** So make sure that the regFree1 register is not reused for other
42448b1db07fSdrh         ** purposes and possibly overwritten.  */
42458b1db07fSdrh         regFree1 = 0;
4246cce7d176Sdrh       }
4247c5cd1249Sdrh       for(i=0; i<nExpr-1; i=i+2){
42482dcef11bSdrh         if( pX ){
42491bd10f8aSdrh           assert( pTest!=0 );
42502dcef11bSdrh           opCompare.pRight = aListelem[i].pExpr;
4251f5905aa7Sdrh         }else{
42522dcef11bSdrh           pTest = aListelem[i].pExpr;
425317a7f8ddSdrh         }
4254ec4ccdbcSdrh         nextCase = sqlite3VdbeMakeLabel(pParse);
425533cd4909Sdrh         testcase( pTest->op==TK_COLUMN );
42562dcef11bSdrh         sqlite3ExprIfFalse(pParse, pTest, nextCase, SQLITE_JUMPIFNULL);
4257c5499befSdrh         testcase( aListelem[i+1].pExpr->op==TK_COLUMN );
42589de221dfSdrh         sqlite3ExprCode(pParse, aListelem[i+1].pExpr, target);
4259076e85f5Sdrh         sqlite3VdbeGoto(v, endLabel);
42602dcef11bSdrh         sqlite3VdbeResolveLabel(v, nextCase);
4261f570f011Sdrh       }
4262c5cd1249Sdrh       if( (nExpr&1)!=0 ){
4263c5cd1249Sdrh         sqlite3ExprCode(pParse, pEList->a[nExpr-1].pExpr, target);
426417a7f8ddSdrh       }else{
42659de221dfSdrh         sqlite3VdbeAddOp2(v, OP_Null, 0, target);
426617a7f8ddSdrh       }
42678b65e591Sdan       sqlite3ExprDelete(db, pDel);
42682dcef11bSdrh       sqlite3VdbeResolveLabel(v, endLabel);
42696f34903eSdanielk1977       break;
42706f34903eSdanielk1977     }
42715338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_TRIGGER
42726f34903eSdanielk1977     case TK_RAISE: {
42731194904bSdrh       assert( pExpr->affExpr==OE_Rollback
42741194904bSdrh            || pExpr->affExpr==OE_Abort
42751194904bSdrh            || pExpr->affExpr==OE_Fail
42761194904bSdrh            || pExpr->affExpr==OE_Ignore
4277165921a7Sdan       );
4278e0af83acSdan       if( !pParse->pTriggerTab ){
4279e0af83acSdan         sqlite3ErrorMsg(pParse,
4280e0af83acSdan                        "RAISE() may only be used within a trigger-program");
4281e0af83acSdan         return 0;
4282e0af83acSdan       }
42831194904bSdrh       if( pExpr->affExpr==OE_Abort ){
4284e0af83acSdan         sqlite3MayAbort(pParse);
4285e0af83acSdan       }
428633e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
42871194904bSdrh       if( pExpr->affExpr==OE_Ignore ){
4288e0af83acSdan         sqlite3VdbeAddOp4(
4289e0af83acSdan             v, OP_Halt, SQLITE_OK, OE_Ignore, 0, pExpr->u.zToken,0);
4290688852abSdrh         VdbeCoverage(v);
4291e0af83acSdan       }else{
4292433dccfbSdrh         sqlite3HaltConstraint(pParse, SQLITE_CONSTRAINT_TRIGGER,
42931194904bSdrh                               pExpr->affExpr, pExpr->u.zToken, 0, 0);
4294e0af83acSdan       }
4295e0af83acSdan 
4296ffe07b2dSdrh       break;
429717a7f8ddSdrh     }
42985338a5f7Sdanielk1977 #endif
4299ffe07b2dSdrh   }
43002dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
43012dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
43022dcef11bSdrh   return inReg;
43035b6afba9Sdrh }
43042dcef11bSdrh 
43052dcef11bSdrh /*
4306d1a01edaSdrh ** Factor out the code of the given expression to initialization time.
43071e9b53f9Sdrh **
4308ad879ffdSdrh ** If regDest>=0 then the result is always stored in that register and the
4309ad879ffdSdrh ** result is not reusable.  If regDest<0 then this routine is free to
4310ad879ffdSdrh ** store the value whereever it wants.  The register where the expression
4311ad879ffdSdrh ** is stored is returned.  When regDest<0, two identical expressions will
4312ad879ffdSdrh ** code to the same register.
4313d1a01edaSdrh */
43141e9b53f9Sdrh int sqlite3ExprCodeAtInit(
4315d673cddaSdrh   Parse *pParse,    /* Parsing context */
4316d673cddaSdrh   Expr *pExpr,      /* The expression to code when the VDBE initializes */
4317ad879ffdSdrh   int regDest       /* Store the value in this register */
4318d673cddaSdrh ){
4319d1a01edaSdrh   ExprList *p;
4320d9f158e7Sdrh   assert( ConstFactorOk(pParse) );
4321d1a01edaSdrh   p = pParse->pConstExpr;
4322ad879ffdSdrh   if( regDest<0 && p ){
43231e9b53f9Sdrh     struct ExprList_item *pItem;
43241e9b53f9Sdrh     int i;
43251e9b53f9Sdrh     for(pItem=p->a, i=p->nExpr; i>0; pItem++, i--){
43265aa550cfSdan       if( pItem->reusable && sqlite3ExprCompare(0,pItem->pExpr,pExpr,-1)==0 ){
43271e9b53f9Sdrh         return pItem->u.iConstExprReg;
43281e9b53f9Sdrh       }
43291e9b53f9Sdrh     }
43301e9b53f9Sdrh   }
4331d1a01edaSdrh   pExpr = sqlite3ExprDup(pParse->db, pExpr, 0);
4332d1a01edaSdrh   p = sqlite3ExprListAppend(pParse, p, pExpr);
4333d673cddaSdrh   if( p ){
4334d673cddaSdrh      struct ExprList_item *pItem = &p->a[p->nExpr-1];
4335ad879ffdSdrh      pItem->reusable = regDest<0;
4336ad879ffdSdrh      if( regDest<0 ) regDest = ++pParse->nMem;
4337d673cddaSdrh      pItem->u.iConstExprReg = regDest;
4338d673cddaSdrh   }
4339d1a01edaSdrh   pParse->pConstExpr = p;
43401e9b53f9Sdrh   return regDest;
4341d1a01edaSdrh }
4342d1a01edaSdrh 
4343d1a01edaSdrh /*
43442dcef11bSdrh ** Generate code to evaluate an expression and store the results
43452dcef11bSdrh ** into a register.  Return the register number where the results
43462dcef11bSdrh ** are stored.
43472dcef11bSdrh **
43482dcef11bSdrh ** If the register is a temporary register that can be deallocated,
4349678ccce8Sdrh ** then write its number into *pReg.  If the result register is not
43502dcef11bSdrh ** a temporary, then set *pReg to zero.
4351f30a969bSdrh **
4352f30a969bSdrh ** If pExpr is a constant, then this routine might generate this
4353f30a969bSdrh ** code to fill the register in the initialization section of the
4354f30a969bSdrh ** VDBE program, in order to factor it out of the evaluation loop.
43552dcef11bSdrh */
43562dcef11bSdrh int sqlite3ExprCodeTemp(Parse *pParse, Expr *pExpr, int *pReg){
4357f30a969bSdrh   int r2;
43580d950af3Sdrh   pExpr = sqlite3ExprSkipCollateAndLikely(pExpr);
4359d9f158e7Sdrh   if( ConstFactorOk(pParse)
4360f30a969bSdrh    && pExpr->op!=TK_REGISTER
4361f30a969bSdrh    && sqlite3ExprIsConstantNotJoin(pExpr)
4362f30a969bSdrh   ){
4363f30a969bSdrh     *pReg  = 0;
4364ad879ffdSdrh     r2 = sqlite3ExprCodeAtInit(pParse, pExpr, -1);
4365f30a969bSdrh   }else{
43662dcef11bSdrh     int r1 = sqlite3GetTempReg(pParse);
4367f30a969bSdrh     r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
43682dcef11bSdrh     if( r2==r1 ){
43692dcef11bSdrh       *pReg = r1;
43702dcef11bSdrh     }else{
43712dcef11bSdrh       sqlite3ReleaseTempReg(pParse, r1);
43722dcef11bSdrh       *pReg = 0;
43732dcef11bSdrh     }
4374f30a969bSdrh   }
43752dcef11bSdrh   return r2;
43762dcef11bSdrh }
43772dcef11bSdrh 
43782dcef11bSdrh /*
43792dcef11bSdrh ** Generate code that will evaluate expression pExpr and store the
43802dcef11bSdrh ** results in register target.  The results are guaranteed to appear
43812dcef11bSdrh ** in register target.
43822dcef11bSdrh */
438305a86c5cSdrh void sqlite3ExprCode(Parse *pParse, Expr *pExpr, int target){
43849cbf3425Sdrh   int inReg;
43859cbf3425Sdrh 
43869cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
43879cbf3425Sdrh   inReg = sqlite3ExprCodeTarget(pParse, pExpr, target);
43881c75c9d7Sdrh   assert( pParse->pVdbe!=0 || pParse->db->mallocFailed );
43890e359b30Sdrh   if( inReg!=target && pParse->pVdbe ){
43909cbf3425Sdrh     sqlite3VdbeAddOp2(pParse->pVdbe, OP_SCopy, inReg, target);
439117a7f8ddSdrh   }
4392ebc16717Sdrh }
4393cce7d176Sdrh 
4394cce7d176Sdrh /*
43951c75c9d7Sdrh ** Make a transient copy of expression pExpr and then code it using
43961c75c9d7Sdrh ** sqlite3ExprCode().  This routine works just like sqlite3ExprCode()
43971c75c9d7Sdrh ** except that the input expression is guaranteed to be unchanged.
43981c75c9d7Sdrh */
43991c75c9d7Sdrh void sqlite3ExprCodeCopy(Parse *pParse, Expr *pExpr, int target){
44001c75c9d7Sdrh   sqlite3 *db = pParse->db;
44011c75c9d7Sdrh   pExpr = sqlite3ExprDup(db, pExpr, 0);
44021c75c9d7Sdrh   if( !db->mallocFailed ) sqlite3ExprCode(pParse, pExpr, target);
44031c75c9d7Sdrh   sqlite3ExprDelete(db, pExpr);
44041c75c9d7Sdrh }
44051c75c9d7Sdrh 
44061c75c9d7Sdrh /*
440705a86c5cSdrh ** Generate code that will evaluate expression pExpr and store the
440805a86c5cSdrh ** results in register target.  The results are guaranteed to appear
440905a86c5cSdrh ** in register target.  If the expression is constant, then this routine
441005a86c5cSdrh ** might choose to code the expression at initialization time.
441105a86c5cSdrh */
441205a86c5cSdrh void sqlite3ExprCodeFactorable(Parse *pParse, Expr *pExpr, int target){
4413b8b06690Sdrh   if( pParse->okConstFactor && sqlite3ExprIsConstantNotJoin(pExpr) ){
4414ad879ffdSdrh     sqlite3ExprCodeAtInit(pParse, pExpr, target);
441505a86c5cSdrh   }else{
441605a86c5cSdrh     sqlite3ExprCode(pParse, pExpr, target);
441705a86c5cSdrh   }
4418cce7d176Sdrh }
4419cce7d176Sdrh 
4420cce7d176Sdrh /*
4421268380caSdrh ** Generate code that pushes the value of every element of the given
44229cbf3425Sdrh ** expression list into a sequence of registers beginning at target.
4423268380caSdrh **
44243df6c3b1Sdrh ** Return the number of elements evaluated.  The number returned will
44253df6c3b1Sdrh ** usually be pList->nExpr but might be reduced if SQLITE_ECEL_OMITREF
44263df6c3b1Sdrh ** is defined.
4427d1a01edaSdrh **
4428d1a01edaSdrh ** The SQLITE_ECEL_DUP flag prevents the arguments from being
4429d1a01edaSdrh ** filled using OP_SCopy.  OP_Copy must be used instead.
4430d1a01edaSdrh **
4431d1a01edaSdrh ** The SQLITE_ECEL_FACTOR argument allows constant arguments to be
4432d1a01edaSdrh ** factored out into initialization code.
4433b0df9634Sdrh **
4434b0df9634Sdrh ** The SQLITE_ECEL_REF flag means that expressions in the list with
4435b0df9634Sdrh ** ExprList.a[].u.x.iOrderByCol>0 have already been evaluated and stored
4436b0df9634Sdrh ** in registers at srcReg, and so the value can be copied from there.
44373df6c3b1Sdrh ** If SQLITE_ECEL_OMITREF is also set, then the values with u.x.iOrderByCol>0
44383df6c3b1Sdrh ** are simply omitted rather than being copied from srcReg.
4439268380caSdrh */
44404adee20fSdanielk1977 int sqlite3ExprCodeExprList(
4441268380caSdrh   Parse *pParse,     /* Parsing context */
4442389a1adbSdrh   ExprList *pList,   /* The expression list to be coded */
4443191b54cbSdrh   int target,        /* Where to write results */
44445579d59fSdrh   int srcReg,        /* Source registers if SQLITE_ECEL_REF */
4445d1a01edaSdrh   u8 flags           /* SQLITE_ECEL_* flags */
4446268380caSdrh ){
4447268380caSdrh   struct ExprList_item *pItem;
44485579d59fSdrh   int i, j, n;
4449d1a01edaSdrh   u8 copyOp = (flags & SQLITE_ECEL_DUP) ? OP_Copy : OP_SCopy;
44505579d59fSdrh   Vdbe *v = pParse->pVdbe;
44519d8b3072Sdrh   assert( pList!=0 );
44529cbf3425Sdrh   assert( target>0 );
4453d81a142bSdrh   assert( pParse->pVdbe!=0 );  /* Never gets this far otherwise */
4454268380caSdrh   n = pList->nExpr;
4455d9f158e7Sdrh   if( !ConstFactorOk(pParse) ) flags &= ~SQLITE_ECEL_FACTOR;
4456191b54cbSdrh   for(pItem=pList->a, i=0; i<n; i++, pItem++){
44577445ffe2Sdrh     Expr *pExpr = pItem->pExpr;
445824e25d32Sdan #ifdef SQLITE_ENABLE_SORTER_REFERENCES
445924e25d32Sdan     if( pItem->bSorterRef ){
446024e25d32Sdan       i--;
446124e25d32Sdan       n--;
446224e25d32Sdan     }else
446324e25d32Sdan #endif
4464257c13faSdan     if( (flags & SQLITE_ECEL_REF)!=0 && (j = pItem->u.x.iOrderByCol)>0 ){
4465257c13faSdan       if( flags & SQLITE_ECEL_OMITREF ){
4466257c13faSdan         i--;
4467257c13faSdan         n--;
4468257c13faSdan       }else{
44695579d59fSdrh         sqlite3VdbeAddOp2(v, copyOp, j+srcReg-1, target+i);
4470257c13faSdan       }
4471b8b06690Sdrh     }else if( (flags & SQLITE_ECEL_FACTOR)!=0
4472b8b06690Sdrh            && sqlite3ExprIsConstantNotJoin(pExpr)
4473b8b06690Sdrh     ){
4474ad879ffdSdrh       sqlite3ExprCodeAtInit(pParse, pExpr, target+i);
4475d1a01edaSdrh     }else{
44767445ffe2Sdrh       int inReg = sqlite3ExprCodeTarget(pParse, pExpr, target+i);
4477746fd9ccSdrh       if( inReg!=target+i ){
44784eded604Sdrh         VdbeOp *pOp;
44794eded604Sdrh         if( copyOp==OP_Copy
44804eded604Sdrh          && (pOp=sqlite3VdbeGetOp(v, -1))->opcode==OP_Copy
44814eded604Sdrh          && pOp->p1+pOp->p3+1==inReg
44824eded604Sdrh          && pOp->p2+pOp->p3+1==target+i
44834eded604Sdrh         ){
44844eded604Sdrh           pOp->p3++;
44854eded604Sdrh         }else{
44864eded604Sdrh           sqlite3VdbeAddOp2(v, copyOp, inReg, target+i);
44874eded604Sdrh         }
4488d1a01edaSdrh       }
4489d176611bSdrh     }
4490268380caSdrh   }
4491f9b596ebSdrh   return n;
4492268380caSdrh }
4493268380caSdrh 
4494268380caSdrh /*
449536c563a2Sdrh ** Generate code for a BETWEEN operator.
449636c563a2Sdrh **
449736c563a2Sdrh **    x BETWEEN y AND z
449836c563a2Sdrh **
449936c563a2Sdrh ** The above is equivalent to
450036c563a2Sdrh **
450136c563a2Sdrh **    x>=y AND x<=z
450236c563a2Sdrh **
450336c563a2Sdrh ** Code it as such, taking care to do the common subexpression
450460ec914cSpeter.d.reid ** elimination of x.
450584b19a3dSdrh **
450684b19a3dSdrh ** The xJumpIf parameter determines details:
450784b19a3dSdrh **
450884b19a3dSdrh **    NULL:                   Store the boolean result in reg[dest]
450984b19a3dSdrh **    sqlite3ExprIfTrue:      Jump to dest if true
451084b19a3dSdrh **    sqlite3ExprIfFalse:     Jump to dest if false
451184b19a3dSdrh **
451284b19a3dSdrh ** The jumpIfNull parameter is ignored if xJumpIf is NULL.
451336c563a2Sdrh */
451436c563a2Sdrh static void exprCodeBetween(
451536c563a2Sdrh   Parse *pParse,    /* Parsing and code generating context */
451636c563a2Sdrh   Expr *pExpr,      /* The BETWEEN expression */
451784b19a3dSdrh   int dest,         /* Jump destination or storage location */
451884b19a3dSdrh   void (*xJump)(Parse*,Expr*,int,int), /* Action to take */
451936c563a2Sdrh   int jumpIfNull    /* Take the jump if the BETWEEN is NULL */
452036c563a2Sdrh ){
452136c563a2Sdrh   Expr exprAnd;     /* The AND operator in  x>=y AND x<=z  */
452236c563a2Sdrh   Expr compLeft;    /* The  x>=y  term */
452336c563a2Sdrh   Expr compRight;   /* The  x<=z  term */
4524db45bd5eSdrh   int regFree1 = 0; /* Temporary use register */
45258b65e591Sdan   Expr *pDel = 0;
45268b65e591Sdan   sqlite3 *db = pParse->db;
452784b19a3dSdrh 
452871c57db0Sdan   memset(&compLeft, 0, sizeof(Expr));
452971c57db0Sdan   memset(&compRight, 0, sizeof(Expr));
453071c57db0Sdan   memset(&exprAnd, 0, sizeof(Expr));
4531db45bd5eSdrh 
4532db45bd5eSdrh   assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
45338b65e591Sdan   pDel = sqlite3ExprDup(db, pExpr->pLeft, 0);
45348b65e591Sdan   if( db->mallocFailed==0 ){
453536c563a2Sdrh     exprAnd.op = TK_AND;
453636c563a2Sdrh     exprAnd.pLeft = &compLeft;
453736c563a2Sdrh     exprAnd.pRight = &compRight;
453836c563a2Sdrh     compLeft.op = TK_GE;
45398b65e591Sdan     compLeft.pLeft = pDel;
454036c563a2Sdrh     compLeft.pRight = pExpr->x.pList->a[0].pExpr;
454136c563a2Sdrh     compRight.op = TK_LE;
45428b65e591Sdan     compRight.pLeft = pDel;
454336c563a2Sdrh     compRight.pRight = pExpr->x.pList->a[1].pExpr;
45448b65e591Sdan     exprToRegister(pDel, exprCodeVector(pParse, pDel, &regFree1));
454584b19a3dSdrh     if( xJump ){
454684b19a3dSdrh       xJump(pParse, &exprAnd, dest, jumpIfNull);
454736c563a2Sdrh     }else{
454836fd41e5Sdrh       /* Mark the expression is being from the ON or USING clause of a join
454936fd41e5Sdrh       ** so that the sqlite3ExprCodeTarget() routine will not attempt to move
455036fd41e5Sdrh       ** it into the Parse.pConstExpr list.  We should use a new bit for this,
455136fd41e5Sdrh       ** for clarity, but we are out of bits in the Expr.flags field so we
455236fd41e5Sdrh       ** have to reuse the EP_FromJoin bit.  Bummer. */
45538b65e591Sdan       pDel->flags |= EP_FromJoin;
455471c57db0Sdan       sqlite3ExprCodeTarget(pParse, &exprAnd, dest);
455536c563a2Sdrh     }
4556db45bd5eSdrh     sqlite3ReleaseTempReg(pParse, regFree1);
45578b65e591Sdan   }
45588b65e591Sdan   sqlite3ExprDelete(db, pDel);
455936c563a2Sdrh 
456036c563a2Sdrh   /* Ensure adequate test coverage */
4561db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull==0 && regFree1==0 );
4562db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull==0 && regFree1!=0 );
4563db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull!=0 && regFree1==0 );
4564db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull!=0 && regFree1!=0 );
4565db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1==0 );
4566db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1!=0 );
4567db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1==0 );
4568db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1!=0 );
456984b19a3dSdrh   testcase( xJump==0 );
457036c563a2Sdrh }
457136c563a2Sdrh 
457236c563a2Sdrh /*
4573cce7d176Sdrh ** Generate code for a boolean expression such that a jump is made
4574cce7d176Sdrh ** to the label "dest" if the expression is true but execution
4575cce7d176Sdrh ** continues straight thru if the expression is false.
4576f5905aa7Sdrh **
4577f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false), then
457835573356Sdrh ** take the jump if the jumpIfNull flag is SQLITE_JUMPIFNULL.
4579f2bc013cSdrh **
4580f2bc013cSdrh ** This code depends on the fact that certain token values (ex: TK_EQ)
4581f2bc013cSdrh ** are the same as opcode values (ex: OP_Eq) that implement the corresponding
4582f2bc013cSdrh ** operation.  Special comments in vdbe.c and the mkopcodeh.awk script in
4583f2bc013cSdrh ** the make process cause these values to align.  Assert()s in the code
4584f2bc013cSdrh ** below verify that the numbers are aligned correctly.
4585cce7d176Sdrh */
45864adee20fSdanielk1977 void sqlite3ExprIfTrue(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
4587cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
4588cce7d176Sdrh   int op = 0;
45892dcef11bSdrh   int regFree1 = 0;
45902dcef11bSdrh   int regFree2 = 0;
45912dcef11bSdrh   int r1, r2;
45922dcef11bSdrh 
459335573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
459448864df9Smistachkin   if( NEVER(v==0) )     return;  /* Existence of VDBE checked by caller */
459533cd4909Sdrh   if( NEVER(pExpr==0) ) return;  /* No way this can happen */
4596f2bc013cSdrh   op = pExpr->op;
45977b35a77bSdan   switch( op ){
459817180fcaSdrh     case TK_AND:
459917180fcaSdrh     case TK_OR: {
460017180fcaSdrh       Expr *pAlt = sqlite3ExprSimplifiedAndOr(pExpr);
460117180fcaSdrh       if( pAlt!=pExpr ){
460217180fcaSdrh         sqlite3ExprIfTrue(pParse, pAlt, dest, jumpIfNull);
460317180fcaSdrh       }else if( op==TK_AND ){
4604ec4ccdbcSdrh         int d2 = sqlite3VdbeMakeLabel(pParse);
4605c5499befSdrh         testcase( jumpIfNull==0 );
460617180fcaSdrh         sqlite3ExprIfFalse(pParse, pExpr->pLeft, d2,
460717180fcaSdrh                            jumpIfNull^SQLITE_JUMPIFNULL);
46084adee20fSdanielk1977         sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
46094adee20fSdanielk1977         sqlite3VdbeResolveLabel(v, d2);
461017180fcaSdrh       }else{
4611c5499befSdrh         testcase( jumpIfNull==0 );
46124adee20fSdanielk1977         sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
46134adee20fSdanielk1977         sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
461417180fcaSdrh       }
4615cce7d176Sdrh       break;
4616cce7d176Sdrh     }
4617cce7d176Sdrh     case TK_NOT: {
4618c5499befSdrh       testcase( jumpIfNull==0 );
46194adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
4620cce7d176Sdrh       break;
4621cce7d176Sdrh     }
46228abed7b9Sdrh     case TK_TRUTH: {
462396acafbeSdrh       int isNot;      /* IS NOT TRUE or IS NOT FALSE */
462496acafbeSdrh       int isTrue;     /* IS TRUE or IS NOT TRUE */
4625007c843bSdrh       testcase( jumpIfNull==0 );
46268abed7b9Sdrh       isNot = pExpr->op2==TK_ISNOT;
462796acafbeSdrh       isTrue = sqlite3ExprTruthValue(pExpr->pRight);
462843c4ac8bSdrh       testcase( isTrue && isNot );
462996acafbeSdrh       testcase( !isTrue && isNot );
463043c4ac8bSdrh       if( isTrue ^ isNot ){
46318abed7b9Sdrh         sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
46328abed7b9Sdrh                           isNot ? SQLITE_JUMPIFNULL : 0);
46338abed7b9Sdrh       }else{
46348abed7b9Sdrh         sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
46358abed7b9Sdrh                            isNot ? SQLITE_JUMPIFNULL : 0);
46368abed7b9Sdrh       }
4637007c843bSdrh       break;
4638007c843bSdrh     }
4639de845c2fSdrh     case TK_IS:
4640de845c2fSdrh     case TK_ISNOT:
4641de845c2fSdrh       testcase( op==TK_IS );
4642de845c2fSdrh       testcase( op==TK_ISNOT );
4643de845c2fSdrh       op = (op==TK_IS) ? TK_EQ : TK_NE;
4644de845c2fSdrh       jumpIfNull = SQLITE_NULLEQ;
4645de845c2fSdrh       /* Fall thru */
4646cce7d176Sdrh     case TK_LT:
4647cce7d176Sdrh     case TK_LE:
4648cce7d176Sdrh     case TK_GT:
4649cce7d176Sdrh     case TK_GE:
4650cce7d176Sdrh     case TK_NE:
46510ac65892Sdrh     case TK_EQ: {
4652625015e0Sdan       if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
4653c5499befSdrh       testcase( jumpIfNull==0 );
4654b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4655b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
465635573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
4657898c527eSdrh                   r1, r2, dest, jumpIfNull, ExprHasProperty(pExpr,EP_Commuted));
46587d176105Sdrh       assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
46597d176105Sdrh       assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
46607d176105Sdrh       assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
46617d176105Sdrh       assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
4662de845c2fSdrh       assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4663de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4664de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4665de845c2fSdrh       assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4666de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
4667de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
46686a2fe093Sdrh       testcase( regFree1==0 );
46696a2fe093Sdrh       testcase( regFree2==0 );
46706a2fe093Sdrh       break;
46716a2fe093Sdrh     }
4672cce7d176Sdrh     case TK_ISNULL:
4673cce7d176Sdrh     case TK_NOTNULL: {
46747d176105Sdrh       assert( TK_ISNULL==OP_IsNull );   testcase( op==TK_ISNULL );
46757d176105Sdrh       assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
46762dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
46772dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
46787d176105Sdrh       VdbeCoverageIf(v, op==TK_ISNULL);
46797d176105Sdrh       VdbeCoverageIf(v, op==TK_NOTNULL);
4680c5499befSdrh       testcase( regFree1==0 );
4681cce7d176Sdrh       break;
4682cce7d176Sdrh     }
4683fef5208cSdrh     case TK_BETWEEN: {
46845c03f30aSdrh       testcase( jumpIfNull==0 );
468571c57db0Sdan       exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfTrue, jumpIfNull);
4686fef5208cSdrh       break;
4687fef5208cSdrh     }
4688bb201344Sshaneh #ifndef SQLITE_OMIT_SUBQUERY
4689e3365e6cSdrh     case TK_IN: {
4690ec4ccdbcSdrh       int destIfFalse = sqlite3VdbeMakeLabel(pParse);
4691e3365e6cSdrh       int destIfNull = jumpIfNull ? dest : destIfFalse;
4692e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
4693076e85f5Sdrh       sqlite3VdbeGoto(v, dest);
4694e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
4695e3365e6cSdrh       break;
4696e3365e6cSdrh     }
4697bb201344Sshaneh #endif
4698cce7d176Sdrh     default: {
46997b35a77bSdan     default_expr:
4700ad31727fSdrh       if( ExprAlwaysTrue(pExpr) ){
4701076e85f5Sdrh         sqlite3VdbeGoto(v, dest);
4702ad31727fSdrh       }else if( ExprAlwaysFalse(pExpr) ){
4703991a1985Sdrh         /* No-op */
4704991a1985Sdrh       }else{
47052dcef11bSdrh         r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
47062dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_If, r1, dest, jumpIfNull!=0);
4707688852abSdrh         VdbeCoverage(v);
4708c5499befSdrh         testcase( regFree1==0 );
4709c5499befSdrh         testcase( jumpIfNull==0 );
4710991a1985Sdrh       }
4711cce7d176Sdrh       break;
4712cce7d176Sdrh     }
4713cce7d176Sdrh   }
47142dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
47152dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
4716cce7d176Sdrh }
4717cce7d176Sdrh 
4718cce7d176Sdrh /*
471966b89c8fSdrh ** Generate code for a boolean expression such that a jump is made
4720cce7d176Sdrh ** to the label "dest" if the expression is false but execution
4721cce7d176Sdrh ** continues straight thru if the expression is true.
4722f5905aa7Sdrh **
4723f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false) then
472435573356Sdrh ** jump if jumpIfNull is SQLITE_JUMPIFNULL or fall through if jumpIfNull
472535573356Sdrh ** is 0.
4726cce7d176Sdrh */
47274adee20fSdanielk1977 void sqlite3ExprIfFalse(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
4728cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
4729cce7d176Sdrh   int op = 0;
47302dcef11bSdrh   int regFree1 = 0;
47312dcef11bSdrh   int regFree2 = 0;
47322dcef11bSdrh   int r1, r2;
47332dcef11bSdrh 
473435573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
473548864df9Smistachkin   if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
473633cd4909Sdrh   if( pExpr==0 )    return;
4737f2bc013cSdrh 
4738f2bc013cSdrh   /* The value of pExpr->op and op are related as follows:
4739f2bc013cSdrh   **
4740f2bc013cSdrh   **       pExpr->op            op
4741f2bc013cSdrh   **       ---------          ----------
4742f2bc013cSdrh   **       TK_ISNULL          OP_NotNull
4743f2bc013cSdrh   **       TK_NOTNULL         OP_IsNull
4744f2bc013cSdrh   **       TK_NE              OP_Eq
4745f2bc013cSdrh   **       TK_EQ              OP_Ne
4746f2bc013cSdrh   **       TK_GT              OP_Le
4747f2bc013cSdrh   **       TK_LE              OP_Gt
4748f2bc013cSdrh   **       TK_GE              OP_Lt
4749f2bc013cSdrh   **       TK_LT              OP_Ge
4750f2bc013cSdrh   **
4751f2bc013cSdrh   ** For other values of pExpr->op, op is undefined and unused.
4752f2bc013cSdrh   ** The value of TK_ and OP_ constants are arranged such that we
4753f2bc013cSdrh   ** can compute the mapping above using the following expression.
4754f2bc013cSdrh   ** Assert()s verify that the computation is correct.
4755f2bc013cSdrh   */
4756f2bc013cSdrh   op = ((pExpr->op+(TK_ISNULL&1))^1)-(TK_ISNULL&1);
4757f2bc013cSdrh 
4758f2bc013cSdrh   /* Verify correct alignment of TK_ and OP_ constants
4759f2bc013cSdrh   */
4760f2bc013cSdrh   assert( pExpr->op!=TK_ISNULL || op==OP_NotNull );
4761f2bc013cSdrh   assert( pExpr->op!=TK_NOTNULL || op==OP_IsNull );
4762f2bc013cSdrh   assert( pExpr->op!=TK_NE || op==OP_Eq );
4763f2bc013cSdrh   assert( pExpr->op!=TK_EQ || op==OP_Ne );
4764f2bc013cSdrh   assert( pExpr->op!=TK_LT || op==OP_Ge );
4765f2bc013cSdrh   assert( pExpr->op!=TK_LE || op==OP_Gt );
4766f2bc013cSdrh   assert( pExpr->op!=TK_GT || op==OP_Le );
4767f2bc013cSdrh   assert( pExpr->op!=TK_GE || op==OP_Lt );
4768f2bc013cSdrh 
4769ba00e30aSdan   switch( pExpr->op ){
477017180fcaSdrh     case TK_AND:
477117180fcaSdrh     case TK_OR: {
477217180fcaSdrh       Expr *pAlt = sqlite3ExprSimplifiedAndOr(pExpr);
477317180fcaSdrh       if( pAlt!=pExpr ){
477417180fcaSdrh         sqlite3ExprIfFalse(pParse, pAlt, dest, jumpIfNull);
477517180fcaSdrh       }else if( pExpr->op==TK_AND ){
4776c5499befSdrh         testcase( jumpIfNull==0 );
47774adee20fSdanielk1977         sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
47784adee20fSdanielk1977         sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
477917180fcaSdrh       }else{
4780ec4ccdbcSdrh         int d2 = sqlite3VdbeMakeLabel(pParse);
4781c5499befSdrh         testcase( jumpIfNull==0 );
478217180fcaSdrh         sqlite3ExprIfTrue(pParse, pExpr->pLeft, d2,
478317180fcaSdrh                           jumpIfNull^SQLITE_JUMPIFNULL);
47844adee20fSdanielk1977         sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
47854adee20fSdanielk1977         sqlite3VdbeResolveLabel(v, d2);
478617180fcaSdrh       }
4787cce7d176Sdrh       break;
4788cce7d176Sdrh     }
4789cce7d176Sdrh     case TK_NOT: {
47905c03f30aSdrh       testcase( jumpIfNull==0 );
47914adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
4792cce7d176Sdrh       break;
4793cce7d176Sdrh     }
47948abed7b9Sdrh     case TK_TRUTH: {
479596acafbeSdrh       int isNot;   /* IS NOT TRUE or IS NOT FALSE */
479696acafbeSdrh       int isTrue;  /* IS TRUE or IS NOT TRUE */
47978abed7b9Sdrh       testcase( jumpIfNull==0 );
47988abed7b9Sdrh       isNot = pExpr->op2==TK_ISNOT;
479996acafbeSdrh       isTrue = sqlite3ExprTruthValue(pExpr->pRight);
480043c4ac8bSdrh       testcase( isTrue && isNot );
480196acafbeSdrh       testcase( !isTrue && isNot );
480243c4ac8bSdrh       if( isTrue ^ isNot ){
48038abed7b9Sdrh         /* IS TRUE and IS NOT FALSE */
48048abed7b9Sdrh         sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
48058abed7b9Sdrh                            isNot ? 0 : SQLITE_JUMPIFNULL);
48068abed7b9Sdrh 
48078abed7b9Sdrh       }else{
48088abed7b9Sdrh         /* IS FALSE and IS NOT TRUE */
48098abed7b9Sdrh         sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
48108abed7b9Sdrh                           isNot ? 0 : SQLITE_JUMPIFNULL);
48118abed7b9Sdrh       }
4812007c843bSdrh       break;
4813007c843bSdrh     }
4814de845c2fSdrh     case TK_IS:
4815de845c2fSdrh     case TK_ISNOT:
4816de845c2fSdrh       testcase( pExpr->op==TK_IS );
4817de845c2fSdrh       testcase( pExpr->op==TK_ISNOT );
4818de845c2fSdrh       op = (pExpr->op==TK_IS) ? TK_NE : TK_EQ;
4819de845c2fSdrh       jumpIfNull = SQLITE_NULLEQ;
4820de845c2fSdrh       /* Fall thru */
4821cce7d176Sdrh     case TK_LT:
4822cce7d176Sdrh     case TK_LE:
4823cce7d176Sdrh     case TK_GT:
4824cce7d176Sdrh     case TK_GE:
4825cce7d176Sdrh     case TK_NE:
4826cce7d176Sdrh     case TK_EQ: {
4827625015e0Sdan       if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
4828c5499befSdrh       testcase( jumpIfNull==0 );
4829b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4830b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
483135573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
4832898c527eSdrh                   r1, r2, dest, jumpIfNull,ExprHasProperty(pExpr,EP_Commuted));
48337d176105Sdrh       assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
48347d176105Sdrh       assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
48357d176105Sdrh       assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
48367d176105Sdrh       assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
4837de845c2fSdrh       assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4838de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4839de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4840de845c2fSdrh       assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4841de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
4842de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
48436a2fe093Sdrh       testcase( regFree1==0 );
48446a2fe093Sdrh       testcase( regFree2==0 );
48456a2fe093Sdrh       break;
48466a2fe093Sdrh     }
4847cce7d176Sdrh     case TK_ISNULL:
4848cce7d176Sdrh     case TK_NOTNULL: {
48492dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
48502dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
48517d176105Sdrh       testcase( op==TK_ISNULL );   VdbeCoverageIf(v, op==TK_ISNULL);
48527d176105Sdrh       testcase( op==TK_NOTNULL );  VdbeCoverageIf(v, op==TK_NOTNULL);
4853c5499befSdrh       testcase( regFree1==0 );
4854cce7d176Sdrh       break;
4855cce7d176Sdrh     }
4856fef5208cSdrh     case TK_BETWEEN: {
48575c03f30aSdrh       testcase( jumpIfNull==0 );
485871c57db0Sdan       exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfFalse, jumpIfNull);
4859fef5208cSdrh       break;
4860fef5208cSdrh     }
4861bb201344Sshaneh #ifndef SQLITE_OMIT_SUBQUERY
4862e3365e6cSdrh     case TK_IN: {
4863e3365e6cSdrh       if( jumpIfNull ){
4864e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, dest);
4865e3365e6cSdrh       }else{
4866ec4ccdbcSdrh         int destIfNull = sqlite3VdbeMakeLabel(pParse);
4867e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, destIfNull);
4868e3365e6cSdrh         sqlite3VdbeResolveLabel(v, destIfNull);
4869e3365e6cSdrh       }
4870e3365e6cSdrh       break;
4871e3365e6cSdrh     }
4872bb201344Sshaneh #endif
4873cce7d176Sdrh     default: {
4874ba00e30aSdan     default_expr:
4875ad31727fSdrh       if( ExprAlwaysFalse(pExpr) ){
4876076e85f5Sdrh         sqlite3VdbeGoto(v, dest);
4877ad31727fSdrh       }else if( ExprAlwaysTrue(pExpr) ){
4878991a1985Sdrh         /* no-op */
4879991a1985Sdrh       }else{
48802dcef11bSdrh         r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
48812dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_IfNot, r1, dest, jumpIfNull!=0);
4882688852abSdrh         VdbeCoverage(v);
4883c5499befSdrh         testcase( regFree1==0 );
4884c5499befSdrh         testcase( jumpIfNull==0 );
4885991a1985Sdrh       }
4886cce7d176Sdrh       break;
4887cce7d176Sdrh     }
4888cce7d176Sdrh   }
48892dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
48902dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
4891cce7d176Sdrh }
48922282792aSdrh 
48932282792aSdrh /*
489472bc8208Sdrh ** Like sqlite3ExprIfFalse() except that a copy is made of pExpr before
489572bc8208Sdrh ** code generation, and that copy is deleted after code generation. This
489672bc8208Sdrh ** ensures that the original pExpr is unchanged.
489772bc8208Sdrh */
489872bc8208Sdrh void sqlite3ExprIfFalseDup(Parse *pParse, Expr *pExpr, int dest,int jumpIfNull){
489972bc8208Sdrh   sqlite3 *db = pParse->db;
490072bc8208Sdrh   Expr *pCopy = sqlite3ExprDup(db, pExpr, 0);
490172bc8208Sdrh   if( db->mallocFailed==0 ){
490272bc8208Sdrh     sqlite3ExprIfFalse(pParse, pCopy, dest, jumpIfNull);
490372bc8208Sdrh   }
490472bc8208Sdrh   sqlite3ExprDelete(db, pCopy);
490572bc8208Sdrh }
490672bc8208Sdrh 
49075aa550cfSdan /*
49085aa550cfSdan ** Expression pVar is guaranteed to be an SQL variable. pExpr may be any
49095aa550cfSdan ** type of expression.
49105aa550cfSdan **
49115aa550cfSdan ** If pExpr is a simple SQL value - an integer, real, string, blob
49125aa550cfSdan ** or NULL value - then the VDBE currently being prepared is configured
49135aa550cfSdan ** to re-prepare each time a new value is bound to variable pVar.
49145aa550cfSdan **
49155aa550cfSdan ** Additionally, if pExpr is a simple SQL value and the value is the
49165aa550cfSdan ** same as that currently bound to variable pVar, non-zero is returned.
49175aa550cfSdan ** Otherwise, if the values are not the same or if pExpr is not a simple
49185aa550cfSdan ** SQL value, zero is returned.
49195aa550cfSdan */
49205aa550cfSdan static int exprCompareVariable(Parse *pParse, Expr *pVar, Expr *pExpr){
49215aa550cfSdan   int res = 0;
4922c0804226Sdrh   int iVar;
4923c0804226Sdrh   sqlite3_value *pL, *pR = 0;
49245aa550cfSdan 
49255aa550cfSdan   sqlite3ValueFromExpr(pParse->db, pExpr, SQLITE_UTF8, SQLITE_AFF_BLOB, &pR);
4926c0804226Sdrh   if( pR ){
4927c0804226Sdrh     iVar = pVar->iColumn;
4928c0804226Sdrh     sqlite3VdbeSetVarmask(pParse->pVdbe, iVar);
4929c0804226Sdrh     pL = sqlite3VdbeGetBoundValue(pParse->pReprepare, iVar, SQLITE_AFF_BLOB);
49305aa307e2Sdrh     if( pL ){
49315aa307e2Sdrh       if( sqlite3_value_type(pL)==SQLITE_TEXT ){
49325aa307e2Sdrh         sqlite3_value_text(pL); /* Make sure the encoding is UTF-8 */
49335aa307e2Sdrh       }
49345aa307e2Sdrh       res =  0==sqlite3MemCompare(pL, pR, 0);
49355aa550cfSdan     }
49365aa550cfSdan     sqlite3ValueFree(pR);
49375aa550cfSdan     sqlite3ValueFree(pL);
49385aa550cfSdan   }
49395aa550cfSdan 
49405aa550cfSdan   return res;
49415aa550cfSdan }
494272bc8208Sdrh 
494372bc8208Sdrh /*
49441d9da70aSdrh ** Do a deep comparison of two expression trees.  Return 0 if the two
49451d9da70aSdrh ** expressions are completely identical.  Return 1 if they differ only
49461d9da70aSdrh ** by a COLLATE operator at the top level.  Return 2 if there are differences
49471d9da70aSdrh ** other than the top-level COLLATE operator.
4948d40aab0eSdrh **
4949619a1305Sdrh ** If any subelement of pB has Expr.iTable==(-1) then it is allowed
4950619a1305Sdrh ** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
4951619a1305Sdrh **
495266518ca7Sdrh ** The pA side might be using TK_REGISTER.  If that is the case and pB is
495366518ca7Sdrh ** not using TK_REGISTER but is otherwise equivalent, then still return 0.
495466518ca7Sdrh **
49551d9da70aSdrh ** Sometimes this routine will return 2 even if the two expressions
4956d40aab0eSdrh ** really are equivalent.  If we cannot prove that the expressions are
49571d9da70aSdrh ** identical, we return 2 just to be safe.  So if this routine
49581d9da70aSdrh ** returns 2, then you do not really know for certain if the two
49591d9da70aSdrh ** expressions are the same.  But if you get a 0 or 1 return, then you
4960d40aab0eSdrh ** can be sure the expressions are the same.  In the places where
49611d9da70aSdrh ** this routine is used, it does not hurt to get an extra 2 - that
4962d40aab0eSdrh ** just might result in some slightly slower code.  But returning
49631d9da70aSdrh ** an incorrect 0 or 1 could lead to a malfunction.
49645aa550cfSdan **
4965c0804226Sdrh ** If pParse is not NULL then TK_VARIABLE terms in pA with bindings in
4966c0804226Sdrh ** pParse->pReprepare can be matched against literals in pB.  The
4967c0804226Sdrh ** pParse->pVdbe->expmask bitmask is updated for each variable referenced.
4968c0804226Sdrh ** If pParse is NULL (the normal case) then any TK_VARIABLE term in
4969c0804226Sdrh ** Argument pParse should normally be NULL. If it is not NULL and pA or
4970c0804226Sdrh ** pB causes a return value of 2.
49712282792aSdrh */
49725aa550cfSdan int sqlite3ExprCompare(Parse *pParse, Expr *pA, Expr *pB, int iTab){
497310d1edf0Sdrh   u32 combinedFlags;
49744b202ae2Sdanielk1977   if( pA==0 || pB==0 ){
49751d9da70aSdrh     return pB==pA ? 0 : 2;
49762282792aSdrh   }
49775aa550cfSdan   if( pParse && pA->op==TK_VARIABLE && exprCompareVariable(pParse, pA, pB) ){
49785aa550cfSdan     return 0;
49795aa550cfSdan   }
498010d1edf0Sdrh   combinedFlags = pA->flags | pB->flags;
498110d1edf0Sdrh   if( combinedFlags & EP_IntValue ){
498210d1edf0Sdrh     if( (pA->flags&pB->flags&EP_IntValue)!=0 && pA->u.iValue==pB->u.iValue ){
498310d1edf0Sdrh       return 0;
498410d1edf0Sdrh     }
49851d9da70aSdrh     return 2;
49866ab3a2ecSdanielk1977   }
498716dd3985Sdan   if( pA->op!=pB->op || pA->op==TK_RAISE ){
49885aa550cfSdan     if( pA->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA->pLeft,pB,iTab)<2 ){
4989ae80ddeaSdrh       return 1;
4990ae80ddeaSdrh     }
49915aa550cfSdan     if( pB->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA,pB->pLeft,iTab)<2 ){
4992ae80ddeaSdrh       return 1;
4993ae80ddeaSdrh     }
4994ae80ddeaSdrh     return 2;
4995ae80ddeaSdrh   }
49962edc5fd7Sdrh   if( pA->op!=TK_COLUMN && pA->op!=TK_AGG_COLUMN && pA->u.zToken ){
49974f9adee2Sdan     if( pA->op==TK_FUNCTION || pA->op==TK_AGG_FUNCTION ){
4998390b88a4Sdrh       if( sqlite3StrICmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
4999eda079cdSdrh #ifndef SQLITE_OMIT_WINDOWFUNC
50004f9adee2Sdan       assert( pA->op==pB->op );
50014f9adee2Sdan       if( ExprHasProperty(pA,EP_WinFunc)!=ExprHasProperty(pB,EP_WinFunc) ){
50024f9adee2Sdan         return 2;
50034f9adee2Sdan       }
5004eda079cdSdrh       if( ExprHasProperty(pA,EP_WinFunc) ){
50054f9adee2Sdan         if( sqlite3WindowCompare(pParse, pA->y.pWin, pB->y.pWin, 1)!=0 ){
50064f9adee2Sdan           return 2;
50074f9adee2Sdan         }
5008eda079cdSdrh       }
5009eda079cdSdrh #endif
5010f20bbc5fSdrh     }else if( pA->op==TK_NULL ){
5011f20bbc5fSdrh       return 0;
5012d5af5420Sdrh     }else if( pA->op==TK_COLLATE ){
5013e79f6299Sdrh       if( sqlite3_stricmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
5014f20bbc5fSdrh     }else if( ALWAYS(pB->u.zToken!=0) && strcmp(pA->u.zToken,pB->u.zToken)!=0 ){
5015d5af5420Sdrh       return 2;
501610d1edf0Sdrh     }
501710d1edf0Sdrh   }
5018898c527eSdrh   if( (pA->flags & (EP_Distinct|EP_Commuted))
5019898c527eSdrh      != (pB->flags & (EP_Distinct|EP_Commuted)) ) return 2;
502089b6de03Sdrh   if( (combinedFlags & EP_TokenOnly)==0 ){
502110d1edf0Sdrh     if( combinedFlags & EP_xIsSelect ) return 2;
5022efad2e23Sdrh     if( (combinedFlags & EP_FixedCol)==0
5023efad2e23Sdrh      && sqlite3ExprCompare(pParse, pA->pLeft, pB->pLeft, iTab) ) return 2;
50245aa550cfSdan     if( sqlite3ExprCompare(pParse, pA->pRight, pB->pRight, iTab) ) return 2;
5025619a1305Sdrh     if( sqlite3ExprListCompare(pA->x.pList, pB->x.pList, iTab) ) return 2;
502603c5c213Sdrh     if( pA->op!=TK_STRING
502703c5c213Sdrh      && pA->op!=TK_TRUEFALSE
502803c5c213Sdrh      && (combinedFlags & EP_Reduced)==0
502903c5c213Sdrh     ){
5030619a1305Sdrh       if( pA->iColumn!=pB->iColumn ) return 2;
5031*04307c8aSdrh       if( pA->op2!=pB->op2 ){
5032*04307c8aSdrh         if( pA->op==TK_TRUTH ) return 2;
5033*04307c8aSdrh         if( pA->op==TK_FUNCTION && iTab<0 ){
5034*04307c8aSdrh           /* Ex: CREATE TABLE t1(a CHECK( a<julianday('now') ));
5035*04307c8aSdrh           **     INSERT INTO t1(a) VALUES(julianday('now')+10);
5036*04307c8aSdrh           ** Without this test, sqlite3ExprCodeAtInit() will run on the
5037*04307c8aSdrh           ** the julianday() of INSERT first, and remember that expression.
5038*04307c8aSdrh           ** Then sqlite3ExprCodeInit() will see the julianday() in the CHECK
5039*04307c8aSdrh           ** constraint as redundant, reusing the one from the INSERT, even
5040*04307c8aSdrh           ** though the julianday() in INSERT lacks the critical NC_IsCheck
5041*04307c8aSdrh           ** flag.  See ticket [830277d9db6c3ba1] (2019-10-30)
5042*04307c8aSdrh           */
5043*04307c8aSdrh           return 2;
5044*04307c8aSdrh         }
5045*04307c8aSdrh       }
50460f28e1bdSdrh       if( pA->op!=TK_IN && pA->iTable!=pB->iTable && pA->iTable!=iTab ){
50470f28e1bdSdrh         return 2;
50480f28e1bdSdrh       }
50491d9da70aSdrh     }
50501d9da70aSdrh   }
50512646da7eSdrh   return 0;
50522646da7eSdrh }
50532282792aSdrh 
50548c6f666bSdrh /*
50558c6f666bSdrh ** Compare two ExprList objects.  Return 0 if they are identical and
50568c6f666bSdrh ** non-zero if they differ in any way.
50578c6f666bSdrh **
5058619a1305Sdrh ** If any subelement of pB has Expr.iTable==(-1) then it is allowed
5059619a1305Sdrh ** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
5060619a1305Sdrh **
50618c6f666bSdrh ** This routine might return non-zero for equivalent ExprLists.  The
50628c6f666bSdrh ** only consequence will be disabled optimizations.  But this routine
50638c6f666bSdrh ** must never return 0 if the two ExprList objects are different, or
50648c6f666bSdrh ** a malfunction will result.
50658c6f666bSdrh **
50668c6f666bSdrh ** Two NULL pointers are considered to be the same.  But a NULL pointer
50678c6f666bSdrh ** always differs from a non-NULL pointer.
50688c6f666bSdrh */
5069619a1305Sdrh int sqlite3ExprListCompare(ExprList *pA, ExprList *pB, int iTab){
50708c6f666bSdrh   int i;
50718c6f666bSdrh   if( pA==0 && pB==0 ) return 0;
50728c6f666bSdrh   if( pA==0 || pB==0 ) return 1;
50738c6f666bSdrh   if( pA->nExpr!=pB->nExpr ) return 1;
50748c6f666bSdrh   for(i=0; i<pA->nExpr; i++){
50758c6f666bSdrh     Expr *pExprA = pA->a[i].pExpr;
50768c6f666bSdrh     Expr *pExprB = pB->a[i].pExpr;
50776e11892dSdan     if( pA->a[i].sortFlags!=pB->a[i].sortFlags ) return 1;
50785aa550cfSdan     if( sqlite3ExprCompare(0, pExprA, pExprB, iTab) ) return 1;
50798c6f666bSdrh   }
50808c6f666bSdrh   return 0;
50818c6f666bSdrh }
508213449892Sdrh 
50832282792aSdrh /*
5084f9463dfbSdrh ** Like sqlite3ExprCompare() except COLLATE operators at the top-level
5085f9463dfbSdrh ** are ignored.
5086f9463dfbSdrh */
5087f9463dfbSdrh int sqlite3ExprCompareSkip(Expr *pA, Expr *pB, int iTab){
50885aa550cfSdan   return sqlite3ExprCompare(0,
50890d950af3Sdrh              sqlite3ExprSkipCollateAndLikely(pA),
50900d950af3Sdrh              sqlite3ExprSkipCollateAndLikely(pB),
5091f9463dfbSdrh              iTab);
5092f9463dfbSdrh }
5093f9463dfbSdrh 
5094f9463dfbSdrh /*
5095c51cf864Sdrh ** Return non-zero if Expr p can only be true if pNN is not NULL.
50967a231b49Sdrh **
50977a231b49Sdrh ** Or if seenNot is true, return non-zero if Expr p can only be
50987a231b49Sdrh ** non-NULL if pNN is not NULL
5099c51cf864Sdrh */
5100c51cf864Sdrh static int exprImpliesNotNull(
5101c51cf864Sdrh   Parse *pParse,      /* Parsing context */
5102c51cf864Sdrh   Expr *p,            /* The expression to be checked */
5103c51cf864Sdrh   Expr *pNN,          /* The expression that is NOT NULL */
5104c51cf864Sdrh   int iTab,           /* Table being evaluated */
51057a231b49Sdrh   int seenNot         /* Return true only if p can be any non-NULL value */
5106c51cf864Sdrh ){
5107c51cf864Sdrh   assert( p );
5108c51cf864Sdrh   assert( pNN );
510914c865e8Sdrh   if( sqlite3ExprCompare(pParse, p, pNN, iTab)==0 ){
511014c865e8Sdrh     return pNN->op!=TK_NULL;
511114c865e8Sdrh   }
5112c51cf864Sdrh   switch( p->op ){
5113c51cf864Sdrh     case TK_IN: {
5114c51cf864Sdrh       if( seenNot && ExprHasProperty(p, EP_xIsSelect) ) return 0;
5115c51cf864Sdrh       assert( ExprHasProperty(p,EP_xIsSelect)
5116c51cf864Sdrh            || (p->x.pList!=0 && p->x.pList->nExpr>0) );
5117ae144a1cSdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
5118c51cf864Sdrh     }
5119c51cf864Sdrh     case TK_BETWEEN: {
5120c51cf864Sdrh       ExprList *pList = p->x.pList;
5121c51cf864Sdrh       assert( pList!=0 );
5122c51cf864Sdrh       assert( pList->nExpr==2 );
5123c51cf864Sdrh       if( seenNot ) return 0;
51247a231b49Sdrh       if( exprImpliesNotNull(pParse, pList->a[0].pExpr, pNN, iTab, 1)
51257a231b49Sdrh        || exprImpliesNotNull(pParse, pList->a[1].pExpr, pNN, iTab, 1)
5126c51cf864Sdrh       ){
5127c51cf864Sdrh         return 1;
5128c51cf864Sdrh       }
51297a231b49Sdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
5130c51cf864Sdrh     }
5131c51cf864Sdrh     case TK_EQ:
5132c51cf864Sdrh     case TK_NE:
5133c51cf864Sdrh     case TK_LT:
5134c51cf864Sdrh     case TK_LE:
5135c51cf864Sdrh     case TK_GT:
5136c51cf864Sdrh     case TK_GE:
5137c51cf864Sdrh     case TK_PLUS:
5138c51cf864Sdrh     case TK_MINUS:
51399d23ea74Sdan     case TK_BITOR:
51409d23ea74Sdan     case TK_LSHIFT:
51419d23ea74Sdan     case TK_RSHIFT:
51429d23ea74Sdan     case TK_CONCAT:
51439d23ea74Sdan       seenNot = 1;
51449d23ea74Sdan       /* Fall thru */
5145c51cf864Sdrh     case TK_STAR:
5146c51cf864Sdrh     case TK_REM:
5147c51cf864Sdrh     case TK_BITAND:
51489d23ea74Sdan     case TK_SLASH: {
5149c51cf864Sdrh       if( exprImpliesNotNull(pParse, p->pRight, pNN, iTab, seenNot) ) return 1;
5150c51cf864Sdrh       /* Fall thru into the next case */
5151c51cf864Sdrh     }
5152c51cf864Sdrh     case TK_SPAN:
5153c51cf864Sdrh     case TK_COLLATE:
5154c51cf864Sdrh     case TK_UPLUS:
5155c51cf864Sdrh     case TK_UMINUS: {
5156c51cf864Sdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, seenNot);
5157c51cf864Sdrh     }
5158c51cf864Sdrh     case TK_TRUTH: {
5159c51cf864Sdrh       if( seenNot ) return 0;
5160c51cf864Sdrh       if( p->op2!=TK_IS ) return 0;
516138cefc83Sdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
5162c51cf864Sdrh     }
51631cd382e3Sdan     case TK_BITNOT:
5164c51cf864Sdrh     case TK_NOT: {
5165c51cf864Sdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
5166c51cf864Sdrh     }
5167c51cf864Sdrh   }
5168c51cf864Sdrh   return 0;
5169c51cf864Sdrh }
5170c51cf864Sdrh 
5171c51cf864Sdrh /*
51724bd5f73fSdrh ** Return true if we can prove the pE2 will always be true if pE1 is
51734bd5f73fSdrh ** true.  Return false if we cannot complete the proof or if pE2 might
51744bd5f73fSdrh ** be false.  Examples:
51754bd5f73fSdrh **
5176619a1305Sdrh **     pE1: x==5       pE2: x==5             Result: true
51774bd5f73fSdrh **     pE1: x>0        pE2: x==5             Result: false
5178619a1305Sdrh **     pE1: x=21       pE2: x=21 OR y=43     Result: true
51794bd5f73fSdrh **     pE1: x!=123     pE2: x IS NOT NULL    Result: true
5180619a1305Sdrh **     pE1: x!=?1      pE2: x IS NOT NULL    Result: true
5181619a1305Sdrh **     pE1: x IS NULL  pE2: x IS NOT NULL    Result: false
5182619a1305Sdrh **     pE1: x IS ?2    pE2: x IS NOT NULL    Reuslt: false
51834bd5f73fSdrh **
51844bd5f73fSdrh ** When comparing TK_COLUMN nodes between pE1 and pE2, if pE2 has
51854bd5f73fSdrh ** Expr.iTable<0 then assume a table number given by iTab.
51864bd5f73fSdrh **
5187c0804226Sdrh ** If pParse is not NULL, then the values of bound variables in pE1 are
5188c0804226Sdrh ** compared against literal values in pE2 and pParse->pVdbe->expmask is
5189c0804226Sdrh ** modified to record which bound variables are referenced.  If pParse
5190c0804226Sdrh ** is NULL, then false will be returned if pE1 contains any bound variables.
5191c0804226Sdrh **
51924bd5f73fSdrh ** When in doubt, return false.  Returning true might give a performance
51934bd5f73fSdrh ** improvement.  Returning false might cause a performance reduction, but
51944bd5f73fSdrh ** it will always give the correct answer and is hence always safe.
51954bd5f73fSdrh */
51965aa550cfSdan int sqlite3ExprImpliesExpr(Parse *pParse, Expr *pE1, Expr *pE2, int iTab){
51975aa550cfSdan   if( sqlite3ExprCompare(pParse, pE1, pE2, iTab)==0 ){
5198619a1305Sdrh     return 1;
5199619a1305Sdrh   }
5200619a1305Sdrh   if( pE2->op==TK_OR
52015aa550cfSdan    && (sqlite3ExprImpliesExpr(pParse, pE1, pE2->pLeft, iTab)
52025aa550cfSdan              || sqlite3ExprImpliesExpr(pParse, pE1, pE2->pRight, iTab) )
5203619a1305Sdrh   ){
5204619a1305Sdrh     return 1;
5205619a1305Sdrh   }
5206664d6d13Sdrh   if( pE2->op==TK_NOTNULL
5207c51cf864Sdrh    && exprImpliesNotNull(pParse, pE1, pE2->pLeft, iTab, 0)
5208664d6d13Sdrh   ){
5209c51cf864Sdrh     return 1;
5210619a1305Sdrh   }
5211619a1305Sdrh   return 0;
52124bd5f73fSdrh }
52134bd5f73fSdrh 
52144bd5f73fSdrh /*
52152589787cSdrh ** This is the Expr node callback for sqlite3ExprImpliesNotNullRow().
52162589787cSdrh ** If the expression node requires that the table at pWalker->iCur
5217f8937f90Sdrh ** have one or more non-NULL column, then set pWalker->eCode to 1 and abort.
5218f8937f90Sdrh **
5219f8937f90Sdrh ** This routine controls an optimization.  False positives (setting
5220f8937f90Sdrh ** pWalker->eCode to 1 when it should not be) are deadly, but false-negatives
5221f8937f90Sdrh ** (never setting pWalker->eCode) is a harmless missed optimization.
52222589787cSdrh */
52232589787cSdrh static int impliesNotNullRow(Walker *pWalker, Expr *pExpr){
5224f8937f90Sdrh   testcase( pExpr->op==TK_AGG_COLUMN );
5225821b610bSdrh   testcase( pExpr->op==TK_AGG_FUNCTION );
52262589787cSdrh   if( ExprHasProperty(pExpr, EP_FromJoin) ) return WRC_Prune;
52272589787cSdrh   switch( pExpr->op ){
52280493222fSdan     case TK_ISNOT:
52292589787cSdrh     case TK_ISNULL:
5230d5793672Sdrh     case TK_NOTNULL:
52312589787cSdrh     case TK_IS:
52322589787cSdrh     case TK_OR:
52332c492061Sdrh     case TK_CASE:
5234e3eff266Sdrh     case TK_IN:
52352589787cSdrh     case TK_FUNCTION:
5236da03c1e6Sdan     case TK_TRUTH:
52370493222fSdan       testcase( pExpr->op==TK_ISNOT );
5238821b610bSdrh       testcase( pExpr->op==TK_ISNULL );
5239d5793672Sdrh       testcase( pExpr->op==TK_NOTNULL );
5240821b610bSdrh       testcase( pExpr->op==TK_IS );
5241821b610bSdrh       testcase( pExpr->op==TK_OR );
5242821b610bSdrh       testcase( pExpr->op==TK_CASE );
5243821b610bSdrh       testcase( pExpr->op==TK_IN );
5244821b610bSdrh       testcase( pExpr->op==TK_FUNCTION );
5245da03c1e6Sdan       testcase( pExpr->op==TK_TRUTH );
52462589787cSdrh       return WRC_Prune;
52472589787cSdrh     case TK_COLUMN:
52482589787cSdrh       if( pWalker->u.iCur==pExpr->iTable ){
52492589787cSdrh         pWalker->eCode = 1;
52502589787cSdrh         return WRC_Abort;
52512589787cSdrh       }
52522589787cSdrh       return WRC_Prune;
52539881155dSdrh 
52549d23ea74Sdan     case TK_AND:
52550287c951Sdan       assert( pWalker->eCode==0 );
52560287c951Sdan       sqlite3WalkExpr(pWalker, pExpr->pLeft);
52570287c951Sdan       if( pWalker->eCode ){
52580287c951Sdan         pWalker->eCode = 0;
52590287c951Sdan         sqlite3WalkExpr(pWalker, pExpr->pRight);
52609d23ea74Sdan       }
52619d23ea74Sdan       return WRC_Prune;
52629d23ea74Sdan 
52639d23ea74Sdan     case TK_BETWEEN:
52649d23ea74Sdan       sqlite3WalkExpr(pWalker, pExpr->pLeft);
52659d23ea74Sdan       return WRC_Prune;
52669d23ea74Sdan 
52679881155dSdrh     /* Virtual tables are allowed to use constraints like x=NULL.  So
52689881155dSdrh     ** a term of the form x=y does not prove that y is not null if x
52699881155dSdrh     ** is the column of a virtual table */
52709881155dSdrh     case TK_EQ:
52719881155dSdrh     case TK_NE:
52729881155dSdrh     case TK_LT:
52739881155dSdrh     case TK_LE:
52749881155dSdrh     case TK_GT:
52759881155dSdrh     case TK_GE:
52769881155dSdrh       testcase( pExpr->op==TK_EQ );
52779881155dSdrh       testcase( pExpr->op==TK_NE );
52789881155dSdrh       testcase( pExpr->op==TK_LT );
52799881155dSdrh       testcase( pExpr->op==TK_LE );
52809881155dSdrh       testcase( pExpr->op==TK_GT );
52819881155dSdrh       testcase( pExpr->op==TK_GE );
5282eda079cdSdrh       if( (pExpr->pLeft->op==TK_COLUMN && IsVirtual(pExpr->pLeft->y.pTab))
5283eda079cdSdrh        || (pExpr->pRight->op==TK_COLUMN && IsVirtual(pExpr->pRight->y.pTab))
52849881155dSdrh       ){
52859881155dSdrh        return WRC_Prune;
52869881155dSdrh       }
52879d23ea74Sdan 
52882589787cSdrh     default:
52892589787cSdrh       return WRC_Continue;
52902589787cSdrh   }
52912589787cSdrh }
52922589787cSdrh 
52932589787cSdrh /*
52942589787cSdrh ** Return true (non-zero) if expression p can only be true if at least
52952589787cSdrh ** one column of table iTab is non-null.  In other words, return true
52962589787cSdrh ** if expression p will always be NULL or false if every column of iTab
52972589787cSdrh ** is NULL.
52982589787cSdrh **
5299821b610bSdrh ** False negatives are acceptable.  In other words, it is ok to return
5300821b610bSdrh ** zero even if expression p will never be true of every column of iTab
5301821b610bSdrh ** is NULL.  A false negative is merely a missed optimization opportunity.
5302821b610bSdrh **
5303821b610bSdrh ** False positives are not allowed, however.  A false positive may result
5304821b610bSdrh ** in an incorrect answer.
5305821b610bSdrh **
53062589787cSdrh ** Terms of p that are marked with EP_FromJoin (and hence that come from
53072589787cSdrh ** the ON or USING clauses of LEFT JOINS) are excluded from the analysis.
53082589787cSdrh **
53092589787cSdrh ** This routine is used to check if a LEFT JOIN can be converted into
53102589787cSdrh ** an ordinary JOIN.  The p argument is the WHERE clause.  If the WHERE
53112589787cSdrh ** clause requires that some column of the right table of the LEFT JOIN
53122589787cSdrh ** be non-NULL, then the LEFT JOIN can be safely converted into an
53132589787cSdrh ** ordinary join.
53142589787cSdrh */
53152589787cSdrh int sqlite3ExprImpliesNonNullRow(Expr *p, int iTab){
53162589787cSdrh   Walker w;
53170d950af3Sdrh   p = sqlite3ExprSkipCollateAndLikely(p);
53184a254f98Sdrh   if( p==0 ) return 0;
53194a254f98Sdrh   if( p->op==TK_NOTNULL ){
5320d6db6598Sdrh     p = p->pLeft;
5321a1698993Sdrh   }else{
5322a1698993Sdrh     while( p->op==TK_AND ){
53234a254f98Sdrh       if( sqlite3ExprImpliesNonNullRow(p->pLeft, iTab) ) return 1;
53244a254f98Sdrh       p = p->pRight;
5325d6db6598Sdrh     }
5326a1698993Sdrh   }
53272589787cSdrh   w.xExprCallback = impliesNotNullRow;
53282589787cSdrh   w.xSelectCallback = 0;
53292589787cSdrh   w.xSelectCallback2 = 0;
53302589787cSdrh   w.eCode = 0;
53312589787cSdrh   w.u.iCur = iTab;
53322589787cSdrh   sqlite3WalkExpr(&w, p);
53332589787cSdrh   return w.eCode;
53342589787cSdrh }
53352589787cSdrh 
53362589787cSdrh /*
5337030796dfSdrh ** An instance of the following structure is used by the tree walker
53382409f8a1Sdrh ** to determine if an expression can be evaluated by reference to the
53392409f8a1Sdrh ** index only, without having to do a search for the corresponding
53402409f8a1Sdrh ** table entry.  The IdxCover.pIdx field is the index.  IdxCover.iCur
53412409f8a1Sdrh ** is the cursor for the table.
53422409f8a1Sdrh */
53432409f8a1Sdrh struct IdxCover {
53442409f8a1Sdrh   Index *pIdx;     /* The index to be tested for coverage */
53452409f8a1Sdrh   int iCur;        /* Cursor number for the table corresponding to the index */
53462409f8a1Sdrh };
53472409f8a1Sdrh 
53482409f8a1Sdrh /*
53492409f8a1Sdrh ** Check to see if there are references to columns in table
53502409f8a1Sdrh ** pWalker->u.pIdxCover->iCur can be satisfied using the index
53512409f8a1Sdrh ** pWalker->u.pIdxCover->pIdx.
53522409f8a1Sdrh */
53532409f8a1Sdrh static int exprIdxCover(Walker *pWalker, Expr *pExpr){
53542409f8a1Sdrh   if( pExpr->op==TK_COLUMN
53552409f8a1Sdrh    && pExpr->iTable==pWalker->u.pIdxCover->iCur
5356b9bcf7caSdrh    && sqlite3TableColumnToIndex(pWalker->u.pIdxCover->pIdx, pExpr->iColumn)<0
53572409f8a1Sdrh   ){
53582409f8a1Sdrh     pWalker->eCode = 1;
53592409f8a1Sdrh     return WRC_Abort;
53602409f8a1Sdrh   }
53612409f8a1Sdrh   return WRC_Continue;
53622409f8a1Sdrh }
53632409f8a1Sdrh 
53642409f8a1Sdrh /*
5365e604ec0bSdrh ** Determine if an index pIdx on table with cursor iCur contains will
5366e604ec0bSdrh ** the expression pExpr.  Return true if the index does cover the
5367e604ec0bSdrh ** expression and false if the pExpr expression references table columns
5368e604ec0bSdrh ** that are not found in the index pIdx.
53692409f8a1Sdrh **
53702409f8a1Sdrh ** An index covering an expression means that the expression can be
53712409f8a1Sdrh ** evaluated using only the index and without having to lookup the
53722409f8a1Sdrh ** corresponding table entry.
53732409f8a1Sdrh */
53742409f8a1Sdrh int sqlite3ExprCoveredByIndex(
53752409f8a1Sdrh   Expr *pExpr,        /* The index to be tested */
53762409f8a1Sdrh   int iCur,           /* The cursor number for the corresponding table */
53772409f8a1Sdrh   Index *pIdx         /* The index that might be used for coverage */
53782409f8a1Sdrh ){
53792409f8a1Sdrh   Walker w;
53802409f8a1Sdrh   struct IdxCover xcov;
53812409f8a1Sdrh   memset(&w, 0, sizeof(w));
53822409f8a1Sdrh   xcov.iCur = iCur;
53832409f8a1Sdrh   xcov.pIdx = pIdx;
53842409f8a1Sdrh   w.xExprCallback = exprIdxCover;
53852409f8a1Sdrh   w.u.pIdxCover = &xcov;
53862409f8a1Sdrh   sqlite3WalkExpr(&w, pExpr);
53872409f8a1Sdrh   return !w.eCode;
53882409f8a1Sdrh }
53892409f8a1Sdrh 
53902409f8a1Sdrh 
53912409f8a1Sdrh /*
53922409f8a1Sdrh ** An instance of the following structure is used by the tree walker
5393030796dfSdrh ** to count references to table columns in the arguments of an
5394ed551b95Sdrh ** aggregate function, in order to implement the
5395ed551b95Sdrh ** sqlite3FunctionThisSrc() routine.
5396374fdce4Sdrh */
5397030796dfSdrh struct SrcCount {
5398030796dfSdrh   SrcList *pSrc;   /* One particular FROM clause in a nested query */
5399030796dfSdrh   int nThis;       /* Number of references to columns in pSrcList */
5400030796dfSdrh   int nOther;      /* Number of references to columns in other FROM clauses */
5401030796dfSdrh };
5402030796dfSdrh 
5403030796dfSdrh /*
5404030796dfSdrh ** Count the number of references to columns.
5405030796dfSdrh */
5406030796dfSdrh static int exprSrcCount(Walker *pWalker, Expr *pExpr){
5407fb0a6081Sdrh   /* The NEVER() on the second term is because sqlite3FunctionUsesThisSrc()
5408fb0a6081Sdrh   ** is always called before sqlite3ExprAnalyzeAggregates() and so the
5409fb0a6081Sdrh   ** TK_COLUMNs have not yet been converted into TK_AGG_COLUMN.  If
5410fb0a6081Sdrh   ** sqlite3FunctionUsesThisSrc() is used differently in the future, the
5411fb0a6081Sdrh   ** NEVER() will need to be removed. */
5412fb0a6081Sdrh   if( pExpr->op==TK_COLUMN || NEVER(pExpr->op==TK_AGG_COLUMN) ){
5413374fdce4Sdrh     int i;
5414030796dfSdrh     struct SrcCount *p = pWalker->u.pSrcCount;
5415030796dfSdrh     SrcList *pSrc = p->pSrc;
5416655814d2Sdrh     int nSrc = pSrc ? pSrc->nSrc : 0;
5417655814d2Sdrh     for(i=0; i<nSrc; i++){
5418030796dfSdrh       if( pExpr->iTable==pSrc->a[i].iCursor ) break;
5419374fdce4Sdrh     }
5420655814d2Sdrh     if( i<nSrc ){
5421030796dfSdrh       p->nThis++;
542280f6bfc0Sdrh     }else if( nSrc==0 || pExpr->iTable<pSrc->a[0].iCursor ){
542380f6bfc0Sdrh       /* In a well-formed parse tree (no name resolution errors),
542435a38e08Sdrh       ** TK_COLUMN nodes with smaller Expr.iTable values are in an
542580f6bfc0Sdrh       ** outer context.  Those are the only ones to count as "other" */
5426030796dfSdrh       p->nOther++;
5427374fdce4Sdrh     }
5428374fdce4Sdrh   }
5429030796dfSdrh   return WRC_Continue;
5430030796dfSdrh }
5431374fdce4Sdrh 
5432374fdce4Sdrh /*
5433030796dfSdrh ** Determine if any of the arguments to the pExpr Function reference
5434030796dfSdrh ** pSrcList.  Return true if they do.  Also return true if the function
5435030796dfSdrh ** has no arguments or has only constant arguments.  Return false if pExpr
5436030796dfSdrh ** references columns but not columns of tables found in pSrcList.
5437374fdce4Sdrh */
5438030796dfSdrh int sqlite3FunctionUsesThisSrc(Expr *pExpr, SrcList *pSrcList){
5439374fdce4Sdrh   Walker w;
5440030796dfSdrh   struct SrcCount cnt;
5441374fdce4Sdrh   assert( pExpr->op==TK_AGG_FUNCTION );
544280f6bfc0Sdrh   memset(&w, 0, sizeof(w));
5443030796dfSdrh   w.xExprCallback = exprSrcCount;
544480f6bfc0Sdrh   w.xSelectCallback = sqlite3SelectWalkNoop;
5445030796dfSdrh   w.u.pSrcCount = &cnt;
5446030796dfSdrh   cnt.pSrc = pSrcList;
5447030796dfSdrh   cnt.nThis = 0;
5448030796dfSdrh   cnt.nOther = 0;
5449030796dfSdrh   sqlite3WalkExprList(&w, pExpr->x.pList);
5450030796dfSdrh   return cnt.nThis>0 || cnt.nOther==0;
5451374fdce4Sdrh }
5452374fdce4Sdrh 
5453374fdce4Sdrh /*
545413449892Sdrh ** Add a new element to the pAggInfo->aCol[] array.  Return the index of
545513449892Sdrh ** the new element.  Return a negative number if malloc fails.
54562282792aSdrh */
545717435752Sdrh static int addAggInfoColumn(sqlite3 *db, AggInfo *pInfo){
545813449892Sdrh   int i;
5459cf643729Sdrh   pInfo->aCol = sqlite3ArrayAllocate(
546017435752Sdrh        db,
5461cf643729Sdrh        pInfo->aCol,
5462cf643729Sdrh        sizeof(pInfo->aCol[0]),
5463cf643729Sdrh        &pInfo->nColumn,
5464cf643729Sdrh        &i
5465cf643729Sdrh   );
546613449892Sdrh   return i;
54672282792aSdrh }
546813449892Sdrh 
546913449892Sdrh /*
547013449892Sdrh ** Add a new element to the pAggInfo->aFunc[] array.  Return the index of
547113449892Sdrh ** the new element.  Return a negative number if malloc fails.
547213449892Sdrh */
547317435752Sdrh static int addAggInfoFunc(sqlite3 *db, AggInfo *pInfo){
547413449892Sdrh   int i;
5475cf643729Sdrh   pInfo->aFunc = sqlite3ArrayAllocate(
547617435752Sdrh        db,
5477cf643729Sdrh        pInfo->aFunc,
5478cf643729Sdrh        sizeof(pInfo->aFunc[0]),
5479cf643729Sdrh        &pInfo->nFunc,
5480cf643729Sdrh        &i
5481cf643729Sdrh   );
548213449892Sdrh   return i;
54832282792aSdrh }
54842282792aSdrh 
54852282792aSdrh /*
54867d10d5a6Sdrh ** This is the xExprCallback for a tree walker.  It is used to
54877d10d5a6Sdrh ** implement sqlite3ExprAnalyzeAggregates().  See sqlite3ExprAnalyzeAggregates
5488626a879aSdrh ** for additional information.
54892282792aSdrh */
54907d10d5a6Sdrh static int analyzeAggregate(Walker *pWalker, Expr *pExpr){
54912282792aSdrh   int i;
54927d10d5a6Sdrh   NameContext *pNC = pWalker->u.pNC;
5493a58fdfb1Sdanielk1977   Parse *pParse = pNC->pParse;
5494a58fdfb1Sdanielk1977   SrcList *pSrcList = pNC->pSrcList;
549525c3b8caSdrh   AggInfo *pAggInfo = pNC->uNC.pAggInfo;
549613449892Sdrh 
549725c3b8caSdrh   assert( pNC->ncFlags & NC_UAggInfo );
54982282792aSdrh   switch( pExpr->op ){
549989c69d00Sdrh     case TK_AGG_COLUMN:
5500967e8b73Sdrh     case TK_COLUMN: {
55018b213899Sdrh       testcase( pExpr->op==TK_AGG_COLUMN );
55028b213899Sdrh       testcase( pExpr->op==TK_COLUMN );
550313449892Sdrh       /* Check to see if the column is in one of the tables in the FROM
550413449892Sdrh       ** clause of the aggregate query */
550520bc393cSdrh       if( ALWAYS(pSrcList!=0) ){
550613449892Sdrh         struct SrcList_item *pItem = pSrcList->a;
550713449892Sdrh         for(i=0; i<pSrcList->nSrc; i++, pItem++){
550813449892Sdrh           struct AggInfo_col *pCol;
5509c5cd1249Sdrh           assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
551013449892Sdrh           if( pExpr->iTable==pItem->iCursor ){
551113449892Sdrh             /* If we reach this point, it means that pExpr refers to a table
551213449892Sdrh             ** that is in the FROM clause of the aggregate query.
551313449892Sdrh             **
551413449892Sdrh             ** Make an entry for the column in pAggInfo->aCol[] if there
551513449892Sdrh             ** is not an entry there already.
551613449892Sdrh             */
55177f906d63Sdrh             int k;
551813449892Sdrh             pCol = pAggInfo->aCol;
55197f906d63Sdrh             for(k=0; k<pAggInfo->nColumn; k++, pCol++){
552013449892Sdrh               if( pCol->iTable==pExpr->iTable &&
552113449892Sdrh                   pCol->iColumn==pExpr->iColumn ){
55222282792aSdrh                 break;
55232282792aSdrh               }
55242282792aSdrh             }
55251e536953Sdanielk1977             if( (k>=pAggInfo->nColumn)
55261e536953Sdanielk1977              && (k = addAggInfoColumn(pParse->db, pAggInfo))>=0
55271e536953Sdanielk1977             ){
55287f906d63Sdrh               pCol = &pAggInfo->aCol[k];
5529eda079cdSdrh               pCol->pTab = pExpr->y.pTab;
553013449892Sdrh               pCol->iTable = pExpr->iTable;
553113449892Sdrh               pCol->iColumn = pExpr->iColumn;
55320a07c107Sdrh               pCol->iMem = ++pParse->nMem;
553313449892Sdrh               pCol->iSorterColumn = -1;
55345774b806Sdrh               pCol->pExpr = pExpr;
553513449892Sdrh               if( pAggInfo->pGroupBy ){
553613449892Sdrh                 int j, n;
553713449892Sdrh                 ExprList *pGB = pAggInfo->pGroupBy;
553813449892Sdrh                 struct ExprList_item *pTerm = pGB->a;
553913449892Sdrh                 n = pGB->nExpr;
554013449892Sdrh                 for(j=0; j<n; j++, pTerm++){
554113449892Sdrh                   Expr *pE = pTerm->pExpr;
554213449892Sdrh                   if( pE->op==TK_COLUMN && pE->iTable==pExpr->iTable &&
554313449892Sdrh                       pE->iColumn==pExpr->iColumn ){
554413449892Sdrh                     pCol->iSorterColumn = j;
554513449892Sdrh                     break;
55462282792aSdrh                   }
554713449892Sdrh                 }
554813449892Sdrh               }
554913449892Sdrh               if( pCol->iSorterColumn<0 ){
555013449892Sdrh                 pCol->iSorterColumn = pAggInfo->nSortingColumn++;
555113449892Sdrh               }
555213449892Sdrh             }
555313449892Sdrh             /* There is now an entry for pExpr in pAggInfo->aCol[] (either
555413449892Sdrh             ** because it was there before or because we just created it).
555513449892Sdrh             ** Convert the pExpr to be a TK_AGG_COLUMN referring to that
555613449892Sdrh             ** pAggInfo->aCol[] entry.
555713449892Sdrh             */
5558ebb6a65dSdrh             ExprSetVVAProperty(pExpr, EP_NoReduce);
555913449892Sdrh             pExpr->pAggInfo = pAggInfo;
556013449892Sdrh             pExpr->op = TK_AGG_COLUMN;
5561cf697396Sshane             pExpr->iAgg = (i16)k;
556213449892Sdrh             break;
556313449892Sdrh           } /* endif pExpr->iTable==pItem->iCursor */
556413449892Sdrh         } /* end loop over pSrcList */
5565a58fdfb1Sdanielk1977       }
55667d10d5a6Sdrh       return WRC_Prune;
55672282792aSdrh     }
55682282792aSdrh     case TK_AGG_FUNCTION: {
55693a8c4be7Sdrh       if( (pNC->ncFlags & NC_InAggFunc)==0
5570ed551b95Sdrh        && pWalker->walkerDepth==pExpr->op2
55713a8c4be7Sdrh       ){
557213449892Sdrh         /* Check to see if pExpr is a duplicate of another aggregate
557313449892Sdrh         ** function that is already in the pAggInfo structure
557413449892Sdrh         */
557513449892Sdrh         struct AggInfo_func *pItem = pAggInfo->aFunc;
557613449892Sdrh         for(i=0; i<pAggInfo->nFunc; i++, pItem++){
55775aa550cfSdan           if( sqlite3ExprCompare(0, pItem->pExpr, pExpr, -1)==0 ){
55782282792aSdrh             break;
55792282792aSdrh           }
55802282792aSdrh         }
558113449892Sdrh         if( i>=pAggInfo->nFunc ){
558213449892Sdrh           /* pExpr is original.  Make a new entry in pAggInfo->aFunc[]
558313449892Sdrh           */
558414db2665Sdanielk1977           u8 enc = ENC(pParse->db);
55851e536953Sdanielk1977           i = addAggInfoFunc(pParse->db, pAggInfo);
558613449892Sdrh           if( i>=0 ){
55876ab3a2ecSdanielk1977             assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
558813449892Sdrh             pItem = &pAggInfo->aFunc[i];
558913449892Sdrh             pItem->pExpr = pExpr;
55900a07c107Sdrh             pItem->iMem = ++pParse->nMem;
559133e619fcSdrh             assert( !ExprHasProperty(pExpr, EP_IntValue) );
559213449892Sdrh             pItem->pFunc = sqlite3FindFunction(pParse->db,
559380738d9cSdrh                    pExpr->u.zToken,
55946ab3a2ecSdanielk1977                    pExpr->x.pList ? pExpr->x.pList->nExpr : 0, enc, 0);
5595fd357974Sdrh             if( pExpr->flags & EP_Distinct ){
5596fd357974Sdrh               pItem->iDistinct = pParse->nTab++;
5597fd357974Sdrh             }else{
5598fd357974Sdrh               pItem->iDistinct = -1;
5599fd357974Sdrh             }
56002282792aSdrh           }
560113449892Sdrh         }
560213449892Sdrh         /* Make pExpr point to the appropriate pAggInfo->aFunc[] entry
560313449892Sdrh         */
5604c5cd1249Sdrh         assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
5605ebb6a65dSdrh         ExprSetVVAProperty(pExpr, EP_NoReduce);
5606cf697396Sshane         pExpr->iAgg = (i16)i;
560713449892Sdrh         pExpr->pAggInfo = pAggInfo;
56083a8c4be7Sdrh         return WRC_Prune;
56096e83a57fSdrh       }else{
56106e83a57fSdrh         return WRC_Continue;
56116e83a57fSdrh       }
56122282792aSdrh     }
5613a58fdfb1Sdanielk1977   }
56147d10d5a6Sdrh   return WRC_Continue;
56157d10d5a6Sdrh }
56167d10d5a6Sdrh static int analyzeAggregatesInSelect(Walker *pWalker, Select *pSelect){
5617d5a336efSdrh   UNUSED_PARAMETER(pSelect);
5618979dd1beSdrh   pWalker->walkerDepth++;
56197d10d5a6Sdrh   return WRC_Continue;
5620a58fdfb1Sdanielk1977 }
5621979dd1beSdrh static void analyzeAggregatesInSelectEnd(Walker *pWalker, Select *pSelect){
5622979dd1beSdrh   UNUSED_PARAMETER(pSelect);
5623979dd1beSdrh   pWalker->walkerDepth--;
5624979dd1beSdrh }
5625626a879aSdrh 
5626626a879aSdrh /*
5627e8abb4caSdrh ** Analyze the pExpr expression looking for aggregate functions and
5628e8abb4caSdrh ** for variables that need to be added to AggInfo object that pNC->pAggInfo
5629e8abb4caSdrh ** points to.  Additional entries are made on the AggInfo object as
5630e8abb4caSdrh ** necessary.
5631626a879aSdrh **
5632626a879aSdrh ** This routine should only be called after the expression has been
56337d10d5a6Sdrh ** analyzed by sqlite3ResolveExprNames().
5634626a879aSdrh */
5635d2b3e23bSdrh void sqlite3ExprAnalyzeAggregates(NameContext *pNC, Expr *pExpr){
56367d10d5a6Sdrh   Walker w;
56377d10d5a6Sdrh   w.xExprCallback = analyzeAggregate;
56387d10d5a6Sdrh   w.xSelectCallback = analyzeAggregatesInSelect;
5639979dd1beSdrh   w.xSelectCallback2 = analyzeAggregatesInSelectEnd;
5640979dd1beSdrh   w.walkerDepth = 0;
56417d10d5a6Sdrh   w.u.pNC = pNC;
5642d9995031Sdan   w.pParse = 0;
564320bc393cSdrh   assert( pNC->pSrcList!=0 );
56447d10d5a6Sdrh   sqlite3WalkExpr(&w, pExpr);
56452282792aSdrh }
56465d9a4af9Sdrh 
56475d9a4af9Sdrh /*
56485d9a4af9Sdrh ** Call sqlite3ExprAnalyzeAggregates() for every expression in an
56495d9a4af9Sdrh ** expression list.  Return the number of errors.
56505d9a4af9Sdrh **
56515d9a4af9Sdrh ** If an error is found, the analysis is cut short.
56525d9a4af9Sdrh */
5653d2b3e23bSdrh void sqlite3ExprAnalyzeAggList(NameContext *pNC, ExprList *pList){
56545d9a4af9Sdrh   struct ExprList_item *pItem;
56555d9a4af9Sdrh   int i;
56565d9a4af9Sdrh   if( pList ){
5657d2b3e23bSdrh     for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
5658d2b3e23bSdrh       sqlite3ExprAnalyzeAggregates(pNC, pItem->pExpr);
56595d9a4af9Sdrh     }
56605d9a4af9Sdrh   }
56615d9a4af9Sdrh }
5662892d3179Sdrh 
5663892d3179Sdrh /*
5664ceea3321Sdrh ** Allocate a single new register for use to hold some intermediate result.
5665892d3179Sdrh */
5666892d3179Sdrh int sqlite3GetTempReg(Parse *pParse){
5667e55cbd72Sdrh   if( pParse->nTempReg==0 ){
5668892d3179Sdrh     return ++pParse->nMem;
5669892d3179Sdrh   }
56702f425f6bSdanielk1977   return pParse->aTempReg[--pParse->nTempReg];
5671892d3179Sdrh }
5672ceea3321Sdrh 
5673ceea3321Sdrh /*
5674ceea3321Sdrh ** Deallocate a register, making available for reuse for some other
5675ceea3321Sdrh ** purpose.
5676ceea3321Sdrh */
5677892d3179Sdrh void sqlite3ReleaseTempReg(Parse *pParse, int iReg){
56782dcef11bSdrh   if( iReg && pParse->nTempReg<ArraySize(pParse->aTempReg) ){
5679892d3179Sdrh     pParse->aTempReg[pParse->nTempReg++] = iReg;
5680892d3179Sdrh   }
5681892d3179Sdrh }
5682892d3179Sdrh 
5683892d3179Sdrh /*
5684ed24da4bSdrh ** Allocate or deallocate a block of nReg consecutive registers.
5685892d3179Sdrh */
5686892d3179Sdrh int sqlite3GetTempRange(Parse *pParse, int nReg){
5687e55cbd72Sdrh   int i, n;
5688ed24da4bSdrh   if( nReg==1 ) return sqlite3GetTempReg(pParse);
5689892d3179Sdrh   i = pParse->iRangeReg;
5690e55cbd72Sdrh   n = pParse->nRangeReg;
5691f49f3523Sdrh   if( nReg<=n ){
5692892d3179Sdrh     pParse->iRangeReg += nReg;
5693892d3179Sdrh     pParse->nRangeReg -= nReg;
5694892d3179Sdrh   }else{
5695892d3179Sdrh     i = pParse->nMem+1;
5696892d3179Sdrh     pParse->nMem += nReg;
5697892d3179Sdrh   }
5698892d3179Sdrh   return i;
5699892d3179Sdrh }
5700892d3179Sdrh void sqlite3ReleaseTempRange(Parse *pParse, int iReg, int nReg){
5701ed24da4bSdrh   if( nReg==1 ){
5702ed24da4bSdrh     sqlite3ReleaseTempReg(pParse, iReg);
5703ed24da4bSdrh     return;
5704ed24da4bSdrh   }
5705892d3179Sdrh   if( nReg>pParse->nRangeReg ){
5706892d3179Sdrh     pParse->nRangeReg = nReg;
5707892d3179Sdrh     pParse->iRangeReg = iReg;
5708892d3179Sdrh   }
5709892d3179Sdrh }
5710cdc69557Sdrh 
5711cdc69557Sdrh /*
5712cdc69557Sdrh ** Mark all temporary registers as being unavailable for reuse.
57136d2566dfSdrh **
57146d2566dfSdrh ** Always invoke this procedure after coding a subroutine or co-routine
57156d2566dfSdrh ** that might be invoked from other parts of the code, to ensure that
57166d2566dfSdrh ** the sub/co-routine does not use registers in common with the code that
57176d2566dfSdrh ** invokes the sub/co-routine.
5718cdc69557Sdrh */
5719cdc69557Sdrh void sqlite3ClearTempRegCache(Parse *pParse){
5720cdc69557Sdrh   pParse->nTempReg = 0;
5721cdc69557Sdrh   pParse->nRangeReg = 0;
5722cdc69557Sdrh }
5723bb9b5f26Sdrh 
5724bb9b5f26Sdrh /*
5725bb9b5f26Sdrh ** Validate that no temporary register falls within the range of
5726bb9b5f26Sdrh ** iFirst..iLast, inclusive.  This routine is only call from within assert()
5727bb9b5f26Sdrh ** statements.
5728bb9b5f26Sdrh */
5729bb9b5f26Sdrh #ifdef SQLITE_DEBUG
5730bb9b5f26Sdrh int sqlite3NoTempsInRange(Parse *pParse, int iFirst, int iLast){
5731bb9b5f26Sdrh   int i;
5732bb9b5f26Sdrh   if( pParse->nRangeReg>0
57333963e584Sdrh    && pParse->iRangeReg+pParse->nRangeReg > iFirst
57343963e584Sdrh    && pParse->iRangeReg <= iLast
5735bb9b5f26Sdrh   ){
5736bb9b5f26Sdrh      return 0;
5737bb9b5f26Sdrh   }
5738bb9b5f26Sdrh   for(i=0; i<pParse->nTempReg; i++){
5739bb9b5f26Sdrh     if( pParse->aTempReg[i]>=iFirst && pParse->aTempReg[i]<=iLast ){
5740bb9b5f26Sdrh       return 0;
5741bb9b5f26Sdrh     }
5742bb9b5f26Sdrh   }
5743bb9b5f26Sdrh   return 1;
5744bb9b5f26Sdrh }
5745bb9b5f26Sdrh #endif /* SQLITE_DEBUG */
5746