xref: /sqlite-3.40.0/src/expr.c (revision 2eeca204)
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 );
19392a2824cSdrh         if( p->x.pList!=0
19492a2824cSdrh          && !db->mallocFailed
19592a2824cSdrh          && ALWAYS(!ExprHasProperty(p, EP_xIsSelect))
19692a2824cSdrh         ){
1972308ed38Sdrh           int i;
1989576802dSdrh           for(i=0; i<p->x.pList->nExpr; i++){
1992308ed38Sdrh             if( ExprHasProperty(p->x.pList->a[i].pExpr, EP_Collate) ){
2002308ed38Sdrh               pNext = p->x.pList->a[i].pExpr;
2012308ed38Sdrh               break;
2022308ed38Sdrh             }
2032308ed38Sdrh           }
2042308ed38Sdrh         }
2052308ed38Sdrh         p = pNext;
206ae80ddeaSdrh       }
207ae80ddeaSdrh     }else{
208ae80ddeaSdrh       break;
209ae80ddeaSdrh     }
2100202b29eSdanielk1977   }
2117cedc8d4Sdanielk1977   if( sqlite3CheckCollSeq(pParse, pColl) ){
2127cedc8d4Sdanielk1977     pColl = 0;
2137cedc8d4Sdanielk1977   }
2147cedc8d4Sdanielk1977   return pColl;
2150202b29eSdanielk1977 }
2160202b29eSdanielk1977 
2170202b29eSdanielk1977 /*
21870efa84dSdrh ** Return the collation sequence for the expression pExpr. If
21970efa84dSdrh ** there is no defined collating sequence, return a pointer to the
22070efa84dSdrh ** defautl collation sequence.
22170efa84dSdrh **
22270efa84dSdrh ** See also: sqlite3ExprCollSeq()
22370efa84dSdrh **
22470efa84dSdrh ** The sqlite3ExprCollSeq() routine works the same except that it
22570efa84dSdrh ** returns NULL if there is no defined collation.
22670efa84dSdrh */
22770efa84dSdrh CollSeq *sqlite3ExprNNCollSeq(Parse *pParse, Expr *pExpr){
22870efa84dSdrh   CollSeq *p = sqlite3ExprCollSeq(pParse, pExpr);
22970efa84dSdrh   if( p==0 ) p = pParse->db->pDfltColl;
23070efa84dSdrh   assert( p!=0 );
23170efa84dSdrh   return p;
23270efa84dSdrh }
23370efa84dSdrh 
23470efa84dSdrh /*
23570efa84dSdrh ** Return TRUE if the two expressions have equivalent collating sequences.
23670efa84dSdrh */
23770efa84dSdrh int sqlite3ExprCollSeqMatch(Parse *pParse, Expr *pE1, Expr *pE2){
23870efa84dSdrh   CollSeq *pColl1 = sqlite3ExprNNCollSeq(pParse, pE1);
23970efa84dSdrh   CollSeq *pColl2 = sqlite3ExprNNCollSeq(pParse, pE2);
24070efa84dSdrh   return sqlite3StrICmp(pColl1->zName, pColl2->zName)==0;
24170efa84dSdrh }
24270efa84dSdrh 
24370efa84dSdrh /*
244626a879aSdrh ** pExpr is an operand of a comparison operator.  aff2 is the
245626a879aSdrh ** type affinity of the other operand.  This routine returns the
24653db1458Sdrh ** type affinity that should be used for the comparison operator.
24753db1458Sdrh */
248e014a838Sdanielk1977 char sqlite3CompareAffinity(Expr *pExpr, char aff2){
249bf3b721fSdanielk1977   char aff1 = sqlite3ExprAffinity(pExpr);
25096fb16eeSdrh   if( aff1>SQLITE_AFF_NONE && aff2>SQLITE_AFF_NONE ){
2518df447f0Sdrh     /* Both sides of the comparison are columns. If one has numeric
2528df447f0Sdrh     ** affinity, use that. Otherwise use no affinity.
253e014a838Sdanielk1977     */
2548a51256cSdrh     if( sqlite3IsNumericAffinity(aff1) || sqlite3IsNumericAffinity(aff2) ){
255e014a838Sdanielk1977       return SQLITE_AFF_NUMERIC;
256e014a838Sdanielk1977     }else{
25705883a34Sdrh       return SQLITE_AFF_BLOB;
258e014a838Sdanielk1977     }
259e014a838Sdanielk1977   }else{
260e014a838Sdanielk1977     /* One side is a column, the other is not. Use the columns affinity. */
26196fb16eeSdrh     assert( aff1<=SQLITE_AFF_NONE || aff2<=SQLITE_AFF_NONE );
26296fb16eeSdrh     return (aff1<=SQLITE_AFF_NONE ? aff2 : aff1) | SQLITE_AFF_NONE;
263e014a838Sdanielk1977   }
264e014a838Sdanielk1977 }
265e014a838Sdanielk1977 
26653db1458Sdrh /*
26753db1458Sdrh ** pExpr is a comparison operator.  Return the type affinity that should
26853db1458Sdrh ** be applied to both operands prior to doing the comparison.
26953db1458Sdrh */
270e014a838Sdanielk1977 static char comparisonAffinity(Expr *pExpr){
271e014a838Sdanielk1977   char aff;
272e014a838Sdanielk1977   assert( pExpr->op==TK_EQ || pExpr->op==TK_IN || pExpr->op==TK_LT ||
273e014a838Sdanielk1977           pExpr->op==TK_GT || pExpr->op==TK_GE || pExpr->op==TK_LE ||
2746a2fe093Sdrh           pExpr->op==TK_NE || pExpr->op==TK_IS || pExpr->op==TK_ISNOT );
275e014a838Sdanielk1977   assert( pExpr->pLeft );
276bf3b721fSdanielk1977   aff = sqlite3ExprAffinity(pExpr->pLeft);
277e014a838Sdanielk1977   if( pExpr->pRight ){
278e014a838Sdanielk1977     aff = sqlite3CompareAffinity(pExpr->pRight, aff);
2796ab3a2ecSdanielk1977   }else if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2806ab3a2ecSdanielk1977     aff = sqlite3CompareAffinity(pExpr->x.pSelect->pEList->a[0].pExpr, aff);
28113ac46eeSdrh   }else if( aff==0 ){
28205883a34Sdrh     aff = SQLITE_AFF_BLOB;
283e014a838Sdanielk1977   }
284e014a838Sdanielk1977   return aff;
285e014a838Sdanielk1977 }
286e014a838Sdanielk1977 
287e014a838Sdanielk1977 /*
288e014a838Sdanielk1977 ** pExpr is a comparison expression, eg. '=', '<', IN(...) etc.
289e014a838Sdanielk1977 ** idx_affinity is the affinity of an indexed column. Return true
290e014a838Sdanielk1977 ** if the index with affinity idx_affinity may be used to implement
291e014a838Sdanielk1977 ** the comparison in pExpr.
292e014a838Sdanielk1977 */
293e014a838Sdanielk1977 int sqlite3IndexAffinityOk(Expr *pExpr, char idx_affinity){
294e014a838Sdanielk1977   char aff = comparisonAffinity(pExpr);
295915e434cSdrh   if( aff<SQLITE_AFF_TEXT ){
2968a51256cSdrh     return 1;
2978a51256cSdrh   }
298915e434cSdrh   if( aff==SQLITE_AFF_TEXT ){
299915e434cSdrh     return idx_affinity==SQLITE_AFF_TEXT;
300915e434cSdrh   }
301915e434cSdrh   return sqlite3IsNumericAffinity(idx_affinity);
302e014a838Sdanielk1977 }
303e014a838Sdanielk1977 
304a37cdde0Sdanielk1977 /*
30535573356Sdrh ** Return the P5 value that should be used for a binary comparison
306a37cdde0Sdanielk1977 ** opcode (OP_Eq, OP_Ge etc.) used to compare pExpr1 and pExpr2.
307a37cdde0Sdanielk1977 */
30835573356Sdrh static u8 binaryCompareP5(Expr *pExpr1, Expr *pExpr2, int jumpIfNull){
30935573356Sdrh   u8 aff = (char)sqlite3ExprAffinity(pExpr2);
3101bd10f8aSdrh   aff = (u8)sqlite3CompareAffinity(pExpr1, aff) | (u8)jumpIfNull;
31135573356Sdrh   return aff;
312a37cdde0Sdanielk1977 }
313a37cdde0Sdanielk1977 
314a2e00042Sdrh /*
3150202b29eSdanielk1977 ** Return a pointer to the collation sequence that should be used by
3160202b29eSdanielk1977 ** a binary comparison operator comparing pLeft and pRight.
3170202b29eSdanielk1977 **
3180202b29eSdanielk1977 ** If the left hand expression has a collating sequence type, then it is
3190202b29eSdanielk1977 ** used. Otherwise the collation sequence for the right hand expression
3200202b29eSdanielk1977 ** is used, or the default (BINARY) if neither expression has a collating
3210202b29eSdanielk1977 ** type.
322bcbb04e5Sdanielk1977 **
323bcbb04e5Sdanielk1977 ** Argument pRight (but not pLeft) may be a null pointer. In this case,
324bcbb04e5Sdanielk1977 ** it is not considered.
3250202b29eSdanielk1977 */
326bcbb04e5Sdanielk1977 CollSeq *sqlite3BinaryCompareCollSeq(
327bcbb04e5Sdanielk1977   Parse *pParse,
328bcbb04e5Sdanielk1977   Expr *pLeft,
329bcbb04e5Sdanielk1977   Expr *pRight
330bcbb04e5Sdanielk1977 ){
331ec41ddacSdrh   CollSeq *pColl;
332ec41ddacSdrh   assert( pLeft );
333ae80ddeaSdrh   if( pLeft->flags & EP_Collate ){
334ae80ddeaSdrh     pColl = sqlite3ExprCollSeq(pParse, pLeft);
335ae80ddeaSdrh   }else if( pRight && (pRight->flags & EP_Collate)!=0 ){
336ae80ddeaSdrh     pColl = sqlite3ExprCollSeq(pParse, pRight);
337ec41ddacSdrh   }else{
338ec41ddacSdrh     pColl = sqlite3ExprCollSeq(pParse, pLeft);
3390202b29eSdanielk1977     if( !pColl ){
3407cedc8d4Sdanielk1977       pColl = sqlite3ExprCollSeq(pParse, pRight);
3410202b29eSdanielk1977     }
342ec41ddacSdrh   }
3430202b29eSdanielk1977   return pColl;
3440202b29eSdanielk1977 }
3450202b29eSdanielk1977 
346898c527eSdrh /* Expresssion p is a comparison operator.  Return a collation sequence
347898c527eSdrh ** appropriate for the comparison operator.
348898c527eSdrh **
349898c527eSdrh ** This is normally just a wrapper around sqlite3BinaryCompareCollSeq().
350898c527eSdrh ** However, if the OP_Commuted flag is set, then the order of the operands
351898c527eSdrh ** is reversed in the sqlite3BinaryCompareCollSeq() call so that the
352898c527eSdrh ** correct collating sequence is found.
353898c527eSdrh */
354898c527eSdrh CollSeq *sqlite3ExprCompareCollSeq(Parse *pParse, Expr *p){
355898c527eSdrh   if( ExprHasProperty(p, EP_Commuted) ){
356898c527eSdrh     return sqlite3BinaryCompareCollSeq(pParse, p->pRight, p->pLeft);
357898c527eSdrh   }else{
358898c527eSdrh     return sqlite3BinaryCompareCollSeq(pParse, p->pLeft, p->pRight);
359898c527eSdrh   }
360898c527eSdrh }
361898c527eSdrh 
3620202b29eSdanielk1977 /*
363be5c89acSdrh ** Generate code for a comparison operator.
364be5c89acSdrh */
365be5c89acSdrh static int codeCompare(
366be5c89acSdrh   Parse *pParse,    /* The parsing (and code generating) context */
367be5c89acSdrh   Expr *pLeft,      /* The left operand */
368be5c89acSdrh   Expr *pRight,     /* The right operand */
369be5c89acSdrh   int opcode,       /* The comparison opcode */
37035573356Sdrh   int in1, int in2, /* Register holding operands */
371be5c89acSdrh   int dest,         /* Jump here if true.  */
372898c527eSdrh   int jumpIfNull,   /* If true, jump if either operand is NULL */
373898c527eSdrh   int isCommuted    /* The comparison has been commuted */
374be5c89acSdrh ){
37535573356Sdrh   int p5;
37635573356Sdrh   int addr;
37735573356Sdrh   CollSeq *p4;
37835573356Sdrh 
3798654186bSdrh   if( pParse->nErr ) return 0;
380898c527eSdrh   if( isCommuted ){
381898c527eSdrh     p4 = sqlite3BinaryCompareCollSeq(pParse, pRight, pLeft);
382898c527eSdrh   }else{
38335573356Sdrh     p4 = sqlite3BinaryCompareCollSeq(pParse, pLeft, pRight);
384898c527eSdrh   }
38535573356Sdrh   p5 = binaryCompareP5(pLeft, pRight, jumpIfNull);
38635573356Sdrh   addr = sqlite3VdbeAddOp4(pParse->pVdbe, opcode, in2, dest, in1,
38735573356Sdrh                            (void*)p4, P4_COLLSEQ);
3881bd10f8aSdrh   sqlite3VdbeChangeP5(pParse->pVdbe, (u8)p5);
38935573356Sdrh   return addr;
390be5c89acSdrh }
391be5c89acSdrh 
392cfbb5e82Sdan /*
393870a0705Sdan ** Return true if expression pExpr is a vector, or false otherwise.
394d832da7fSdrh **
395d832da7fSdrh ** A vector is defined as any expression that results in two or more
396d832da7fSdrh ** columns of result.  Every TK_VECTOR node is an vector because the
397d832da7fSdrh ** parser will not generate a TK_VECTOR with fewer than two entries.
398d832da7fSdrh ** But a TK_SELECT might be either a vector or a scalar. It is only
399d832da7fSdrh ** considered a vector if it has two or more result columns.
400870a0705Sdan */
401870a0705Sdan int sqlite3ExprIsVector(Expr *pExpr){
40276dbe7a8Sdrh   return sqlite3ExprVectorSize(pExpr)>1;
403870a0705Sdan }
404870a0705Sdan 
405870a0705Sdan /*
406cfbb5e82Sdan ** If the expression passed as the only argument is of type TK_VECTOR
407cfbb5e82Sdan ** return the number of expressions in the vector. Or, if the expression
408cfbb5e82Sdan ** is a sub-select, return the number of columns in the sub-select. For
409cfbb5e82Sdan ** any other type of expression, return 1.
410cfbb5e82Sdan */
41171c57db0Sdan int sqlite3ExprVectorSize(Expr *pExpr){
41212abf408Sdrh   u8 op = pExpr->op;
41312abf408Sdrh   if( op==TK_REGISTER ) op = pExpr->op2;
41412abf408Sdrh   if( op==TK_VECTOR ){
41571c57db0Sdan     return pExpr->x.pList->nExpr;
41612abf408Sdrh   }else if( op==TK_SELECT ){
41776dbe7a8Sdrh     return pExpr->x.pSelect->pEList->nExpr;
41876dbe7a8Sdrh   }else{
41976dbe7a8Sdrh     return 1;
42076dbe7a8Sdrh   }
42171c57db0Sdan }
42271c57db0Sdan 
423ba00e30aSdan /*
424fc7f27b9Sdrh ** Return a pointer to a subexpression of pVector that is the i-th
425fc7f27b9Sdrh ** column of the vector (numbered starting with 0).  The caller must
426fc7f27b9Sdrh ** ensure that i is within range.
427fc7f27b9Sdrh **
42876dbe7a8Sdrh ** If pVector is really a scalar (and "scalar" here includes subqueries
42976dbe7a8Sdrh ** that return a single column!) then return pVector unmodified.
43076dbe7a8Sdrh **
431fc7f27b9Sdrh ** pVector retains ownership of the returned subexpression.
432fc7f27b9Sdrh **
433fc7f27b9Sdrh ** If the vector is a (SELECT ...) then the expression returned is
43476dbe7a8Sdrh ** just the expression for the i-th term of the result set, and may
43576dbe7a8Sdrh ** not be ready for evaluation because the table cursor has not yet
43676dbe7a8Sdrh ** been positioned.
437ba00e30aSdan */
438fc7f27b9Sdrh Expr *sqlite3VectorFieldSubexpr(Expr *pVector, int i){
439870a0705Sdan   assert( i<sqlite3ExprVectorSize(pVector) );
440870a0705Sdan   if( sqlite3ExprIsVector(pVector) ){
4419f24b53dSdrh     assert( pVector->op2==0 || pVector->op==TK_REGISTER );
4429f24b53dSdrh     if( pVector->op==TK_SELECT || pVector->op2==TK_SELECT ){
44371c57db0Sdan       return pVector->x.pSelect->pEList->a[i].pExpr;
444870a0705Sdan     }else{
44571c57db0Sdan       return pVector->x.pList->a[i].pExpr;
44671c57db0Sdan     }
447870a0705Sdan   }
448870a0705Sdan   return pVector;
449870a0705Sdan }
450fc7f27b9Sdrh 
451fc7f27b9Sdrh /*
452fc7f27b9Sdrh ** Compute and return a new Expr object which when passed to
453fc7f27b9Sdrh ** sqlite3ExprCode() will generate all necessary code to compute
454fc7f27b9Sdrh ** the iField-th column of the vector expression pVector.
455fc7f27b9Sdrh **
4568762ec19Sdrh ** It is ok for pVector to be a scalar (as long as iField==0).
4578762ec19Sdrh ** In that case, this routine works like sqlite3ExprDup().
4588762ec19Sdrh **
459fc7f27b9Sdrh ** The caller owns the returned Expr object and is responsible for
460fc7f27b9Sdrh ** ensuring that the returned value eventually gets freed.
461fc7f27b9Sdrh **
4628762ec19Sdrh ** The caller retains ownership of pVector.  If pVector is a TK_SELECT,
463fad0e70cSdan ** then the returned object will reference pVector and so pVector must remain
4648762ec19Sdrh ** valid for the life of the returned object.  If pVector is a TK_VECTOR
4658762ec19Sdrh ** or a scalar expression, then it can be deleted as soon as this routine
46676dbe7a8Sdrh ** returns.
4678762ec19Sdrh **
4688762ec19Sdrh ** A trick to cause a TK_SELECT pVector to be deleted together with
4698762ec19Sdrh ** the returned Expr object is to attach the pVector to the pRight field
4708762ec19Sdrh ** of the returned TK_SELECT_COLUMN Expr object.
471fc7f27b9Sdrh */
472fc7f27b9Sdrh Expr *sqlite3ExprForVectorField(
473fc7f27b9Sdrh   Parse *pParse,       /* Parsing context */
474fc7f27b9Sdrh   Expr *pVector,       /* The vector.  List of expressions or a sub-SELECT */
475a1251bc4Sdrh   int iField           /* Which column of the vector to return */
476fc7f27b9Sdrh ){
477fc7f27b9Sdrh   Expr *pRet;
478a1251bc4Sdrh   if( pVector->op==TK_SELECT ){
479a1251bc4Sdrh     assert( pVector->flags & EP_xIsSelect );
480fc7f27b9Sdrh     /* The TK_SELECT_COLUMN Expr node:
481fc7f27b9Sdrh     **
482966e2911Sdrh     ** pLeft:           pVector containing TK_SELECT.  Not deleted.
4838762ec19Sdrh     ** pRight:          not used.  But recursively deleted.
484fc7f27b9Sdrh     ** iColumn:         Index of a column in pVector
485966e2911Sdrh     ** iTable:          0 or the number of columns on the LHS of an assignment
486fc7f27b9Sdrh     ** pLeft->iTable:   First in an array of register holding result, or 0
487fc7f27b9Sdrh     **                  if the result is not yet computed.
488fc7f27b9Sdrh     **
489fc7f27b9Sdrh     ** sqlite3ExprDelete() specifically skips the recursive delete of
490fc7f27b9Sdrh     ** pLeft on TK_SELECT_COLUMN nodes.  But pRight is followed, so pVector
4918762ec19Sdrh     ** can be attached to pRight to cause this node to take ownership of
4928762ec19Sdrh     ** pVector.  Typically there will be multiple TK_SELECT_COLUMN nodes
4938762ec19Sdrh     ** with the same pLeft pointer to the pVector, but only one of them
4948762ec19Sdrh     ** will own the pVector.
495fc7f27b9Sdrh     */
496abfd35eaSdrh     pRet = sqlite3PExpr(pParse, TK_SELECT_COLUMN, 0, 0);
4978bd0d58eSdrh     if( pRet ){
4988bd0d58eSdrh       pRet->iColumn = iField;
4998bd0d58eSdrh       pRet->pLeft = pVector;
5008bd0d58eSdrh     }
501fc7f27b9Sdrh     assert( pRet==0 || pRet->iTable==0 );
502fc7f27b9Sdrh   }else{
503a1251bc4Sdrh     if( pVector->op==TK_VECTOR ) pVector = pVector->x.pList->a[iField].pExpr;
504a1251bc4Sdrh     pRet = sqlite3ExprDup(pParse->db, pVector, 0);
505dfb5c963Sdan     sqlite3RenameTokenRemap(pParse, pRet, pVector);
506fc7f27b9Sdrh   }
507fc7f27b9Sdrh   return pRet;
508fc7f27b9Sdrh }
50971c57db0Sdan 
5105c288b92Sdan /*
5115c288b92Sdan ** If expression pExpr is of type TK_SELECT, generate code to evaluate
5125c288b92Sdan ** it. Return the register in which the result is stored (or, if the
5135c288b92Sdan ** sub-select returns more than one column, the first in an array
5145c288b92Sdan ** of registers in which the result is stored).
5155c288b92Sdan **
5165c288b92Sdan ** If pExpr is not a TK_SELECT expression, return 0.
5175c288b92Sdan */
5185c288b92Sdan static int exprCodeSubselect(Parse *pParse, Expr *pExpr){
5198da209b1Sdan   int reg = 0;
520f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
5215c288b92Sdan   if( pExpr->op==TK_SELECT ){
52285bcdce2Sdrh     reg = sqlite3CodeSubselect(pParse, pExpr);
5238da209b1Sdan   }
524f9b2e05cSdan #endif
5258da209b1Sdan   return reg;
5268da209b1Sdan }
5278da209b1Sdan 
5285c288b92Sdan /*
5295c288b92Sdan ** Argument pVector points to a vector expression - either a TK_VECTOR
530870a0705Sdan ** or TK_SELECT that returns more than one column. This function returns
531870a0705Sdan ** the register number of a register that contains the value of
532870a0705Sdan ** element iField of the vector.
533870a0705Sdan **
534870a0705Sdan ** If pVector is a TK_SELECT expression, then code for it must have
535870a0705Sdan ** already been generated using the exprCodeSubselect() routine. In this
536870a0705Sdan ** case parameter regSelect should be the first in an array of registers
537870a0705Sdan ** containing the results of the sub-select.
538870a0705Sdan **
539870a0705Sdan ** If pVector is of type TK_VECTOR, then code for the requested field
540870a0705Sdan ** is generated. In this case (*pRegFree) may be set to the number of
541870a0705Sdan ** a temporary register to be freed by the caller before returning.
5425c288b92Sdan **
5435c288b92Sdan ** Before returning, output parameter (*ppExpr) is set to point to the
5445c288b92Sdan ** Expr object corresponding to element iElem of the vector.
5455c288b92Sdan */
5465c288b92Sdan static int exprVectorRegister(
5475c288b92Sdan   Parse *pParse,                  /* Parse context */
5485c288b92Sdan   Expr *pVector,                  /* Vector to extract element from */
549870a0705Sdan   int iField,                     /* Field to extract from pVector */
5505c288b92Sdan   int regSelect,                  /* First in array of registers */
5515c288b92Sdan   Expr **ppExpr,                  /* OUT: Expression element */
5525c288b92Sdan   int *pRegFree                   /* OUT: Temp register to free */
5535c288b92Sdan ){
55412abf408Sdrh   u8 op = pVector->op;
555c1bcd9ccSdrh   assert( op==TK_VECTOR || op==TK_REGISTER || op==TK_SELECT );
55612abf408Sdrh   if( op==TK_REGISTER ){
55712abf408Sdrh     *ppExpr = sqlite3VectorFieldSubexpr(pVector, iField);
55812abf408Sdrh     return pVector->iTable+iField;
55912abf408Sdrh   }
56012abf408Sdrh   if( op==TK_SELECT ){
561870a0705Sdan     *ppExpr = pVector->x.pSelect->pEList->a[iField].pExpr;
562870a0705Sdan      return regSelect+iField;
5635c288b92Sdan   }
564870a0705Sdan   *ppExpr = pVector->x.pList->a[iField].pExpr;
5655c288b92Sdan   return sqlite3ExprCodeTemp(pParse, *ppExpr, pRegFree);
5665c288b92Sdan }
5675c288b92Sdan 
5685c288b92Sdan /*
5695c288b92Sdan ** Expression pExpr is a comparison between two vector values. Compute
57079752b6eSdrh ** the result of the comparison (1, 0, or NULL) and write that
57179752b6eSdrh ** result into register dest.
57279752b6eSdrh **
57379752b6eSdrh ** The caller must satisfy the following preconditions:
57479752b6eSdrh **
57579752b6eSdrh **    if pExpr->op==TK_IS:      op==TK_EQ and p5==SQLITE_NULLEQ
57679752b6eSdrh **    if pExpr->op==TK_ISNOT:   op==TK_NE and p5==SQLITE_NULLEQ
57779752b6eSdrh **    otherwise:                op==pExpr->op and p5==0
5785c288b92Sdan */
57979752b6eSdrh static void codeVectorCompare(
58079752b6eSdrh   Parse *pParse,        /* Code generator context */
58179752b6eSdrh   Expr *pExpr,          /* The comparison operation */
58279752b6eSdrh   int dest,             /* Write results into this register */
58379752b6eSdrh   u8 op,                /* Comparison operator */
58479752b6eSdrh   u8 p5                 /* SQLITE_NULLEQ or zero */
58579752b6eSdrh ){
58671c57db0Sdan   Vdbe *v = pParse->pVdbe;
58771c57db0Sdan   Expr *pLeft = pExpr->pLeft;
58871c57db0Sdan   Expr *pRight = pExpr->pRight;
58971c57db0Sdan   int nLeft = sqlite3ExprVectorSize(pLeft);
59071c57db0Sdan   int i;
59171c57db0Sdan   int regLeft = 0;
59271c57db0Sdan   int regRight = 0;
59379752b6eSdrh   u8 opx = op;
594ec4ccdbcSdrh   int addrDone = sqlite3VdbeMakeLabel(pParse);
595898c527eSdrh   int isCommuted = ExprHasProperty(pExpr,EP_Commuted);
59671c57db0Sdan 
59770d6b832Sdrh   if( pParse->nErr ) return;
598245ce62eSdrh   if( nLeft!=sqlite3ExprVectorSize(pRight) ){
599245ce62eSdrh     sqlite3ErrorMsg(pParse, "row value misused");
600245ce62eSdrh     return;
601245ce62eSdrh   }
60271c57db0Sdan   assert( pExpr->op==TK_EQ || pExpr->op==TK_NE
60371c57db0Sdan        || pExpr->op==TK_IS || pExpr->op==TK_ISNOT
60471c57db0Sdan        || pExpr->op==TK_LT || pExpr->op==TK_GT
60571c57db0Sdan        || pExpr->op==TK_LE || pExpr->op==TK_GE
60671c57db0Sdan   );
60779752b6eSdrh   assert( pExpr->op==op || (pExpr->op==TK_IS && op==TK_EQ)
60879752b6eSdrh             || (pExpr->op==TK_ISNOT && op==TK_NE) );
60979752b6eSdrh   assert( p5==0 || pExpr->op!=op );
61079752b6eSdrh   assert( p5==SQLITE_NULLEQ || pExpr->op==op );
61171c57db0Sdan 
61279752b6eSdrh   p5 |= SQLITE_STOREP2;
61379752b6eSdrh   if( opx==TK_LE ) opx = TK_LT;
61479752b6eSdrh   if( opx==TK_GE ) opx = TK_GT;
6155c288b92Sdan 
6165c288b92Sdan   regLeft = exprCodeSubselect(pParse, pLeft);
6175c288b92Sdan   regRight = exprCodeSubselect(pParse, pRight);
6185c288b92Sdan 
619321e828dSdrh   for(i=0; 1 /*Loop exits by "break"*/; i++){
6205c288b92Sdan     int regFree1 = 0, regFree2 = 0;
6215c288b92Sdan     Expr *pL, *pR;
6225c288b92Sdan     int r1, r2;
623321e828dSdrh     assert( i>=0 && i<nLeft );
6245c288b92Sdan     r1 = exprVectorRegister(pParse, pLeft, i, regLeft, &pL, &regFree1);
6255c288b92Sdan     r2 = exprVectorRegister(pParse, pRight, i, regRight, &pR, &regFree2);
626898c527eSdrh     codeCompare(pParse, pL, pR, opx, r1, r2, dest, p5, isCommuted);
62779752b6eSdrh     testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
62879752b6eSdrh     testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
62979752b6eSdrh     testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
63079752b6eSdrh     testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
63179752b6eSdrh     testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
63279752b6eSdrh     testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
63371c57db0Sdan     sqlite3ReleaseTempReg(pParse, regFree1);
63471c57db0Sdan     sqlite3ReleaseTempReg(pParse, regFree2);
63579752b6eSdrh     if( i==nLeft-1 ){
63679752b6eSdrh       break;
63771c57db0Sdan     }
63879752b6eSdrh     if( opx==TK_EQ ){
63979752b6eSdrh       sqlite3VdbeAddOp2(v, OP_IfNot, dest, addrDone); VdbeCoverage(v);
64079752b6eSdrh       p5 |= SQLITE_KEEPNULL;
64179752b6eSdrh     }else if( opx==TK_NE ){
64279752b6eSdrh       sqlite3VdbeAddOp2(v, OP_If, dest, addrDone); VdbeCoverage(v);
64379752b6eSdrh       p5 |= SQLITE_KEEPNULL;
644a2f62925Sdrh     }else{
645a2f62925Sdrh       assert( op==TK_LT || op==TK_GT || op==TK_LE || op==TK_GE );
646a2f62925Sdrh       sqlite3VdbeAddOp2(v, OP_ElseNotEq, 0, addrDone);
64779752b6eSdrh       VdbeCoverageIf(v, op==TK_LT);
64879752b6eSdrh       VdbeCoverageIf(v, op==TK_GT);
64979752b6eSdrh       VdbeCoverageIf(v, op==TK_LE);
65079752b6eSdrh       VdbeCoverageIf(v, op==TK_GE);
65179752b6eSdrh       if( i==nLeft-2 ) opx = op;
65271c57db0Sdan     }
65379752b6eSdrh   }
65479752b6eSdrh   sqlite3VdbeResolveLabel(v, addrDone);
65579752b6eSdrh }
65671c57db0Sdan 
6574b5255acSdanielk1977 #if SQLITE_MAX_EXPR_DEPTH>0
6584b5255acSdanielk1977 /*
6594b5255acSdanielk1977 ** Check that argument nHeight is less than or equal to the maximum
6604b5255acSdanielk1977 ** expression depth allowed. If it is not, leave an error message in
6614b5255acSdanielk1977 ** pParse.
6624b5255acSdanielk1977 */
6637d10d5a6Sdrh int sqlite3ExprCheckHeight(Parse *pParse, int nHeight){
6644b5255acSdanielk1977   int rc = SQLITE_OK;
6654b5255acSdanielk1977   int mxHeight = pParse->db->aLimit[SQLITE_LIMIT_EXPR_DEPTH];
6664b5255acSdanielk1977   if( nHeight>mxHeight ){
6674b5255acSdanielk1977     sqlite3ErrorMsg(pParse,
6684b5255acSdanielk1977        "Expression tree is too large (maximum depth %d)", mxHeight
6694b5255acSdanielk1977     );
6704b5255acSdanielk1977     rc = SQLITE_ERROR;
6714b5255acSdanielk1977   }
6724b5255acSdanielk1977   return rc;
6734b5255acSdanielk1977 }
6744b5255acSdanielk1977 
6754b5255acSdanielk1977 /* The following three functions, heightOfExpr(), heightOfExprList()
6764b5255acSdanielk1977 ** and heightOfSelect(), are used to determine the maximum height
6774b5255acSdanielk1977 ** of any expression tree referenced by the structure passed as the
6784b5255acSdanielk1977 ** first argument.
6794b5255acSdanielk1977 **
6804b5255acSdanielk1977 ** If this maximum height is greater than the current value pointed
6814b5255acSdanielk1977 ** to by pnHeight, the second parameter, then set *pnHeight to that
6824b5255acSdanielk1977 ** value.
6834b5255acSdanielk1977 */
6844b5255acSdanielk1977 static void heightOfExpr(Expr *p, int *pnHeight){
6854b5255acSdanielk1977   if( p ){
6864b5255acSdanielk1977     if( p->nHeight>*pnHeight ){
6874b5255acSdanielk1977       *pnHeight = p->nHeight;
6884b5255acSdanielk1977     }
6894b5255acSdanielk1977   }
6904b5255acSdanielk1977 }
6914b5255acSdanielk1977 static void heightOfExprList(ExprList *p, int *pnHeight){
6924b5255acSdanielk1977   if( p ){
6934b5255acSdanielk1977     int i;
6944b5255acSdanielk1977     for(i=0; i<p->nExpr; i++){
6954b5255acSdanielk1977       heightOfExpr(p->a[i].pExpr, pnHeight);
6964b5255acSdanielk1977     }
6974b5255acSdanielk1977   }
6984b5255acSdanielk1977 }
6991a3a3086Sdan static void heightOfSelect(Select *pSelect, int *pnHeight){
7001a3a3086Sdan   Select *p;
7011a3a3086Sdan   for(p=pSelect; p; p=p->pPrior){
7024b5255acSdanielk1977     heightOfExpr(p->pWhere, pnHeight);
7034b5255acSdanielk1977     heightOfExpr(p->pHaving, pnHeight);
7044b5255acSdanielk1977     heightOfExpr(p->pLimit, pnHeight);
7054b5255acSdanielk1977     heightOfExprList(p->pEList, pnHeight);
7064b5255acSdanielk1977     heightOfExprList(p->pGroupBy, pnHeight);
7074b5255acSdanielk1977     heightOfExprList(p->pOrderBy, pnHeight);
7084b5255acSdanielk1977   }
7094b5255acSdanielk1977 }
7104b5255acSdanielk1977 
7114b5255acSdanielk1977 /*
7124b5255acSdanielk1977 ** Set the Expr.nHeight variable in the structure passed as an
7134b5255acSdanielk1977 ** argument. An expression with no children, Expr.pList or
7144b5255acSdanielk1977 ** Expr.pSelect member has a height of 1. Any other expression
7154b5255acSdanielk1977 ** has a height equal to the maximum height of any other
7164b5255acSdanielk1977 ** referenced Expr plus one.
7172308ed38Sdrh **
7182308ed38Sdrh ** Also propagate EP_Propagate flags up from Expr.x.pList to Expr.flags,
7192308ed38Sdrh ** if appropriate.
7204b5255acSdanielk1977 */
7214b5255acSdanielk1977 static void exprSetHeight(Expr *p){
7224b5255acSdanielk1977   int nHeight = 0;
7234b5255acSdanielk1977   heightOfExpr(p->pLeft, &nHeight);
7244b5255acSdanielk1977   heightOfExpr(p->pRight, &nHeight);
7256ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_xIsSelect) ){
7266ab3a2ecSdanielk1977     heightOfSelect(p->x.pSelect, &nHeight);
7272308ed38Sdrh   }else if( p->x.pList ){
7286ab3a2ecSdanielk1977     heightOfExprList(p->x.pList, &nHeight);
7292308ed38Sdrh     p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
7306ab3a2ecSdanielk1977   }
7314b5255acSdanielk1977   p->nHeight = nHeight + 1;
7324b5255acSdanielk1977 }
7334b5255acSdanielk1977 
7344b5255acSdanielk1977 /*
7354b5255acSdanielk1977 ** Set the Expr.nHeight variable using the exprSetHeight() function. If
7364b5255acSdanielk1977 ** the height is greater than the maximum allowed expression depth,
7374b5255acSdanielk1977 ** leave an error in pParse.
7382308ed38Sdrh **
7392308ed38Sdrh ** Also propagate all EP_Propagate flags from the Expr.x.pList into
7402308ed38Sdrh ** Expr.flags.
7414b5255acSdanielk1977 */
7422308ed38Sdrh void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
74374893a4cSdrh   if( pParse->nErr ) return;
7444b5255acSdanielk1977   exprSetHeight(p);
7457d10d5a6Sdrh   sqlite3ExprCheckHeight(pParse, p->nHeight);
7464b5255acSdanielk1977 }
7474b5255acSdanielk1977 
7484b5255acSdanielk1977 /*
7494b5255acSdanielk1977 ** Return the maximum height of any expression tree referenced
7504b5255acSdanielk1977 ** by the select statement passed as an argument.
7514b5255acSdanielk1977 */
7524b5255acSdanielk1977 int sqlite3SelectExprHeight(Select *p){
7534b5255acSdanielk1977   int nHeight = 0;
7544b5255acSdanielk1977   heightOfSelect(p, &nHeight);
7554b5255acSdanielk1977   return nHeight;
7564b5255acSdanielk1977 }
7572308ed38Sdrh #else /* ABOVE:  Height enforcement enabled.  BELOW: Height enforcement off */
7582308ed38Sdrh /*
7592308ed38Sdrh ** Propagate all EP_Propagate flags from the Expr.x.pList into
7602308ed38Sdrh ** Expr.flags.
7612308ed38Sdrh */
7622308ed38Sdrh void sqlite3ExprSetHeightAndFlags(Parse *pParse, Expr *p){
7632308ed38Sdrh   if( p && p->x.pList && !ExprHasProperty(p, EP_xIsSelect) ){
7642308ed38Sdrh     p->flags |= EP_Propagate & sqlite3ExprListFlags(p->x.pList);
7652308ed38Sdrh   }
7662308ed38Sdrh }
7674b5255acSdanielk1977 #define exprSetHeight(y)
7684b5255acSdanielk1977 #endif /* SQLITE_MAX_EXPR_DEPTH>0 */
7694b5255acSdanielk1977 
770be5c89acSdrh /*
771b7916a78Sdrh ** This routine is the core allocator for Expr nodes.
772b7916a78Sdrh **
773a76b5dfcSdrh ** Construct a new expression node and return a pointer to it.  Memory
774b7916a78Sdrh ** for this node and for the pToken argument is a single allocation
775b7916a78Sdrh ** obtained from sqlite3DbMalloc().  The calling function
776a76b5dfcSdrh ** is responsible for making sure the node eventually gets freed.
777b7916a78Sdrh **
778b7916a78Sdrh ** If dequote is true, then the token (if it exists) is dequoted.
779e792b5b4Sdrh ** If dequote is false, no dequoting is performed.  The deQuote
780b7916a78Sdrh ** parameter is ignored if pToken is NULL or if the token does not
781b7916a78Sdrh ** appear to be quoted.  If the quotes were of the form "..." (double-quotes)
782b7916a78Sdrh ** then the EP_DblQuoted flag is set on the expression node.
78333e619fcSdrh **
78433e619fcSdrh ** Special case:  If op==TK_INTEGER and pToken points to a string that
78533e619fcSdrh ** can be translated into a 32-bit integer, then the token is not
78633e619fcSdrh ** stored in u.zToken.  Instead, the integer values is written
78733e619fcSdrh ** into u.iValue and the EP_IntValue flag is set.  No extra storage
78833e619fcSdrh ** is allocated to hold the integer text and the dequote flag is ignored.
789a76b5dfcSdrh */
790b7916a78Sdrh Expr *sqlite3ExprAlloc(
791cca8a4adSdrh   sqlite3 *db,            /* Handle for sqlite3DbMallocRawNN() */
79217435752Sdrh   int op,                 /* Expression opcode */
793b7916a78Sdrh   const Token *pToken,    /* Token argument.  Might be NULL */
794b7916a78Sdrh   int dequote             /* True to dequote */
79517435752Sdrh ){
796a76b5dfcSdrh   Expr *pNew;
79733e619fcSdrh   int nExtra = 0;
798cf697396Sshane   int iValue = 0;
799b7916a78Sdrh 
800575fad65Sdrh   assert( db!=0 );
801b7916a78Sdrh   if( pToken ){
80233e619fcSdrh     if( op!=TK_INTEGER || pToken->z==0
80333e619fcSdrh           || sqlite3GetInt32(pToken->z, &iValue)==0 ){
804b7916a78Sdrh       nExtra = pToken->n+1;
805d50ffc41Sdrh       assert( iValue>=0 );
80633e619fcSdrh     }
807a76b5dfcSdrh   }
808575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, sizeof(Expr)+nExtra);
809b7916a78Sdrh   if( pNew ){
810ca3862dcSdrh     memset(pNew, 0, sizeof(Expr));
8111bd10f8aSdrh     pNew->op = (u8)op;
812a58fdfb1Sdanielk1977     pNew->iAgg = -1;
813a76b5dfcSdrh     if( pToken ){
81433e619fcSdrh       if( nExtra==0 ){
815ad31727fSdrh         pNew->flags |= EP_IntValue|EP_Leaf|(iValue?EP_IsTrue:EP_IsFalse);
81633e619fcSdrh         pNew->u.iValue = iValue;
81733e619fcSdrh       }else{
81833e619fcSdrh         pNew->u.zToken = (char*)&pNew[1];
819b07028f7Sdrh         assert( pToken->z!=0 || pToken->n==0 );
820b07028f7Sdrh         if( pToken->n ) memcpy(pNew->u.zToken, pToken->z, pToken->n);
82133e619fcSdrh         pNew->u.zToken[pToken->n] = 0;
822244b9d6eSdrh         if( dequote && sqlite3Isquote(pNew->u.zToken[0]) ){
82351d35b0fSdrh           sqlite3DequoteExpr(pNew);
824a34001c9Sdrh         }
825a34001c9Sdrh       }
82633e619fcSdrh     }
827b7916a78Sdrh #if SQLITE_MAX_EXPR_DEPTH>0
828b7916a78Sdrh     pNew->nHeight = 1;
829b7916a78Sdrh #endif
830a34001c9Sdrh   }
831a76b5dfcSdrh   return pNew;
832a76b5dfcSdrh }
833a76b5dfcSdrh 
834a76b5dfcSdrh /*
835b7916a78Sdrh ** Allocate a new expression node from a zero-terminated token that has
836b7916a78Sdrh ** already been dequoted.
837b7916a78Sdrh */
838b7916a78Sdrh Expr *sqlite3Expr(
839b7916a78Sdrh   sqlite3 *db,            /* Handle for sqlite3DbMallocZero() (may be null) */
840b7916a78Sdrh   int op,                 /* Expression opcode */
841b7916a78Sdrh   const char *zToken      /* Token argument.  Might be NULL */
842b7916a78Sdrh ){
843b7916a78Sdrh   Token x;
844b7916a78Sdrh   x.z = zToken;
845b40f06c6Sdrh   x.n = sqlite3Strlen30(zToken);
846b7916a78Sdrh   return sqlite3ExprAlloc(db, op, &x, 0);
847b7916a78Sdrh }
848b7916a78Sdrh 
849b7916a78Sdrh /*
850b7916a78Sdrh ** Attach subtrees pLeft and pRight to the Expr node pRoot.
851b7916a78Sdrh **
852b7916a78Sdrh ** If pRoot==NULL that means that a memory allocation error has occurred.
853b7916a78Sdrh ** In that case, delete the subtrees pLeft and pRight.
854b7916a78Sdrh */
855b7916a78Sdrh void sqlite3ExprAttachSubtrees(
856b7916a78Sdrh   sqlite3 *db,
857b7916a78Sdrh   Expr *pRoot,
858b7916a78Sdrh   Expr *pLeft,
859b7916a78Sdrh   Expr *pRight
860b7916a78Sdrh ){
861b7916a78Sdrh   if( pRoot==0 ){
862b7916a78Sdrh     assert( db->mallocFailed );
863b7916a78Sdrh     sqlite3ExprDelete(db, pLeft);
864b7916a78Sdrh     sqlite3ExprDelete(db, pRight);
865b7916a78Sdrh   }else{
866b7916a78Sdrh     if( pRight ){
867b7916a78Sdrh       pRoot->pRight = pRight;
868885a5b03Sdrh       pRoot->flags |= EP_Propagate & pRight->flags;
869b7916a78Sdrh     }
870b7916a78Sdrh     if( pLeft ){
871b7916a78Sdrh       pRoot->pLeft = pLeft;
872885a5b03Sdrh       pRoot->flags |= EP_Propagate & pLeft->flags;
873b7916a78Sdrh     }
874b7916a78Sdrh     exprSetHeight(pRoot);
875b7916a78Sdrh   }
876b7916a78Sdrh }
877b7916a78Sdrh 
878b7916a78Sdrh /*
87960ec914cSpeter.d.reid ** Allocate an Expr node which joins as many as two subtrees.
880b7916a78Sdrh **
881bf664469Sdrh ** One or both of the subtrees can be NULL.  Return a pointer to the new
882bf664469Sdrh ** Expr node.  Or, if an OOM error occurs, set pParse->db->mallocFailed,
883bf664469Sdrh ** free the subtrees and return NULL.
884206f3d96Sdrh */
88517435752Sdrh Expr *sqlite3PExpr(
88617435752Sdrh   Parse *pParse,          /* Parsing context */
88717435752Sdrh   int op,                 /* Expression opcode */
88817435752Sdrh   Expr *pLeft,            /* Left operand */
889abfd35eaSdrh   Expr *pRight            /* Right operand */
89017435752Sdrh ){
8915fb52caaSdrh   Expr *p;
892abfd35eaSdrh   p = sqlite3DbMallocRawNN(pParse->db, sizeof(Expr));
893abfd35eaSdrh   if( p ){
894abfd35eaSdrh     memset(p, 0, sizeof(Expr));
895f1722baaSdrh     p->op = op & 0xff;
896abfd35eaSdrh     p->iAgg = -1;
897b7916a78Sdrh     sqlite3ExprAttachSubtrees(pParse->db, p, pLeft, pRight);
8982b359bdbSdan     sqlite3ExprCheckHeight(pParse, p->nHeight);
899d5c851c1Sdrh   }else{
900d5c851c1Sdrh     sqlite3ExprDelete(pParse->db, pLeft);
901d5c851c1Sdrh     sqlite3ExprDelete(pParse->db, pRight);
9022b359bdbSdan   }
9034e0cff60Sdrh   return p;
9044e0cff60Sdrh }
9054e0cff60Sdrh 
9064e0cff60Sdrh /*
90708de4f79Sdrh ** Add pSelect to the Expr.x.pSelect field.  Or, if pExpr is NULL (due
90808de4f79Sdrh ** do a memory allocation failure) then delete the pSelect object.
90908de4f79Sdrh */
91008de4f79Sdrh void sqlite3PExprAddSelect(Parse *pParse, Expr *pExpr, Select *pSelect){
91108de4f79Sdrh   if( pExpr ){
91208de4f79Sdrh     pExpr->x.pSelect = pSelect;
91308de4f79Sdrh     ExprSetProperty(pExpr, EP_xIsSelect|EP_Subquery);
91408de4f79Sdrh     sqlite3ExprSetHeightAndFlags(pParse, pExpr);
91508de4f79Sdrh   }else{
91608de4f79Sdrh     assert( pParse->db->mallocFailed );
91708de4f79Sdrh     sqlite3SelectDelete(pParse->db, pSelect);
91808de4f79Sdrh   }
91908de4f79Sdrh }
92008de4f79Sdrh 
92108de4f79Sdrh 
92208de4f79Sdrh /*
92391bb0eedSdrh ** Join two expressions using an AND operator.  If either expression is
92491bb0eedSdrh ** NULL, then just return the other expression.
9255fb52caaSdrh **
9265fb52caaSdrh ** If one side or the other of the AND is known to be false, then instead
9275fb52caaSdrh ** of returning an AND expression, just return a constant expression with
9285fb52caaSdrh ** a value of false.
92991bb0eedSdrh */
930d5c851c1Sdrh Expr *sqlite3ExprAnd(Parse *pParse, Expr *pLeft, Expr *pRight){
931d5c851c1Sdrh   sqlite3 *db = pParse->db;
93291bb0eedSdrh   if( pLeft==0  ){
93391bb0eedSdrh     return pRight;
93491bb0eedSdrh   }else if( pRight==0 ){
93591bb0eedSdrh     return pLeft;
9362b6e670fSdan   }else if( (ExprAlwaysFalse(pLeft) || ExprAlwaysFalse(pRight))
9372b6e670fSdan          && !IN_RENAME_OBJECT
9382b6e670fSdan   ){
9392b6e670fSdan     sqlite3ExprDelete(db, pLeft);
9402b6e670fSdan     sqlite3ExprDelete(db, pRight);
9415776ee5cSdrh     return sqlite3Expr(db, TK_INTEGER, "0");
94291bb0eedSdrh   }else{
943d5c851c1Sdrh     return sqlite3PExpr(pParse, TK_AND, pLeft, pRight);
944a76b5dfcSdrh   }
945a76b5dfcSdrh }
946a76b5dfcSdrh 
947a76b5dfcSdrh /*
948a76b5dfcSdrh ** Construct a new expression node for a function with multiple
949a76b5dfcSdrh ** arguments.
950a76b5dfcSdrh */
951954733b3Sdrh Expr *sqlite3ExprFunction(
952954733b3Sdrh   Parse *pParse,        /* Parsing context */
953954733b3Sdrh   ExprList *pList,      /* Argument list */
954954733b3Sdrh   Token *pToken,        /* Name of the function */
955954733b3Sdrh   int eDistinct         /* SF_Distinct or SF_ALL or 0 */
956954733b3Sdrh ){
957a76b5dfcSdrh   Expr *pNew;
958633e6d57Sdrh   sqlite3 *db = pParse->db;
9594b202ae2Sdanielk1977   assert( pToken );
960b7916a78Sdrh   pNew = sqlite3ExprAlloc(db, TK_FUNCTION, pToken, 1);
961a76b5dfcSdrh   if( pNew==0 ){
962d9da78a2Sdrh     sqlite3ExprListDelete(db, pList); /* Avoid memory leak when malloc fails */
963a76b5dfcSdrh     return 0;
964a76b5dfcSdrh   }
965954733b3Sdrh   if( pList && pList->nExpr > pParse->db->aLimit[SQLITE_LIMIT_FUNCTION_ARG] ){
966954733b3Sdrh     sqlite3ErrorMsg(pParse, "too many arguments on function %T", pToken);
967954733b3Sdrh   }
9686ab3a2ecSdanielk1977   pNew->x.pList = pList;
969fca23557Sdrh   ExprSetProperty(pNew, EP_HasFunc);
9706ab3a2ecSdanielk1977   assert( !ExprHasProperty(pNew, EP_xIsSelect) );
9712308ed38Sdrh   sqlite3ExprSetHeightAndFlags(pParse, pNew);
972954733b3Sdrh   if( eDistinct==SF_Distinct ) ExprSetProperty(pNew, EP_Distinct);
973a76b5dfcSdrh   return pNew;
974a76b5dfcSdrh }
975a76b5dfcSdrh 
976a76b5dfcSdrh /*
9770dfa5255Sdrh ** Check to see if a function is usable according to current access
9780dfa5255Sdrh ** rules:
9790dfa5255Sdrh **
9800dfa5255Sdrh **    SQLITE_FUNC_DIRECT    -     Only usable from top-level SQL
9810dfa5255Sdrh **
9820dfa5255Sdrh **    SQLITE_FUNC_UNSAFE    -     Usable if TRUSTED_SCHEMA or from
9830dfa5255Sdrh **                                top-level SQL
9840dfa5255Sdrh **
9850dfa5255Sdrh ** If the function is not usable, create an error.
9860dfa5255Sdrh */
9870dfa5255Sdrh void sqlite3ExprFunctionUsable(
9880dfa5255Sdrh   Parse *pParse,         /* Parsing and code generating context */
9890dfa5255Sdrh   Expr *pExpr,           /* The function invocation */
9900dfa5255Sdrh   FuncDef *pDef          /* The function being invoked */
9910dfa5255Sdrh ){
9920dfa5255Sdrh   assert( !IN_RENAME_OBJECT );
993*2eeca204Sdrh   assert( (pDef->funcFlags & (SQLITE_FUNC_DIRECT|SQLITE_FUNC_UNSAFE))!=0 );
994*2eeca204Sdrh   if( ExprHasProperty(pExpr, EP_FromDDL) ){
9950dfa5255Sdrh     if( (pDef->funcFlags & SQLITE_FUNC_DIRECT)!=0
9960dfa5255Sdrh      || (pParse->db->flags & SQLITE_TrustedSchema)==0
9970dfa5255Sdrh     ){
9980dfa5255Sdrh       /* Functions prohibited in triggers and views if:
9990dfa5255Sdrh       **     (1) tagged with SQLITE_DIRECTONLY
10000dfa5255Sdrh       **     (2) not tagged with SQLITE_INNOCUOUS (which means it
10010dfa5255Sdrh       **         is tagged with SQLITE_FUNC_UNSAFE) and
10020dfa5255Sdrh       **         SQLITE_DBCONFIG_TRUSTED_SCHEMA is off (meaning
10030dfa5255Sdrh       **         that the schema is possibly tainted).
10040dfa5255Sdrh       */
10050dfa5255Sdrh       sqlite3ErrorMsg(pParse, "unsafe use of %s()", pDef->zName);
10060dfa5255Sdrh     }
10070dfa5255Sdrh   }
10080dfa5255Sdrh }
10090dfa5255Sdrh 
10100dfa5255Sdrh /*
1011fa6bc000Sdrh ** Assign a variable number to an expression that encodes a wildcard
1012fa6bc000Sdrh ** in the original SQL statement.
1013fa6bc000Sdrh **
1014fa6bc000Sdrh ** Wildcards consisting of a single "?" are assigned the next sequential
1015fa6bc000Sdrh ** variable number.
1016fa6bc000Sdrh **
1017fa6bc000Sdrh ** Wildcards of the form "?nnn" are assigned the number "nnn".  We make
10189bf755ccSdrh ** sure "nnn" is not too big to avoid a denial of service attack when
1019fa6bc000Sdrh ** the SQL statement comes from an external source.
1020fa6bc000Sdrh **
102151f49f17Sdrh ** Wildcards of the form ":aaa", "@aaa", or "$aaa" are assigned the same number
1022fa6bc000Sdrh ** as the previous instance of the same wildcard.  Or if this is the first
102360ec914cSpeter.d.reid ** instance of the wildcard, the next sequential variable number is
1024fa6bc000Sdrh ** assigned.
1025fa6bc000Sdrh */
1026de25a88cSdrh void sqlite3ExprAssignVarNumber(Parse *pParse, Expr *pExpr, u32 n){
102717435752Sdrh   sqlite3 *db = pParse->db;
1028b7916a78Sdrh   const char *z;
1029f326d66dSdrh   ynVar x;
103017435752Sdrh 
1031fa6bc000Sdrh   if( pExpr==0 ) return;
1032c5cd1249Sdrh   assert( !ExprHasProperty(pExpr, EP_IntValue|EP_Reduced|EP_TokenOnly) );
103333e619fcSdrh   z = pExpr->u.zToken;
1034b7916a78Sdrh   assert( z!=0 );
1035b7916a78Sdrh   assert( z[0]!=0 );
1036b1ed717fSmistachkin   assert( n==(u32)sqlite3Strlen30(z) );
1037b7916a78Sdrh   if( z[1]==0 ){
1038fa6bc000Sdrh     /* Wildcard of the form "?".  Assign the next variable number */
1039b7916a78Sdrh     assert( z[0]=='?' );
1040f326d66dSdrh     x = (ynVar)(++pParse->nVar);
1041124c0b49Sdrh   }else{
1042f326d66dSdrh     int doAdd = 0;
1043124c0b49Sdrh     if( z[0]=='?' ){
1044fa6bc000Sdrh       /* Wildcard of the form "?nnn".  Convert "nnn" to an integer and
1045fa6bc000Sdrh       ** use it as the variable number */
1046c8d735aeSdan       i64 i;
104718814dfbSdrh       int bOk;
104818814dfbSdrh       if( n==2 ){ /*OPTIMIZATION-IF-TRUE*/
104918814dfbSdrh         i = z[1]-'0';  /* The common case of ?N for a single digit N */
105018814dfbSdrh         bOk = 1;
105118814dfbSdrh       }else{
105218814dfbSdrh         bOk = 0==sqlite3Atoi64(&z[1], &i, n-1, SQLITE_UTF8);
105318814dfbSdrh       }
1054c5499befSdrh       testcase( i==0 );
1055c5499befSdrh       testcase( i==1 );
1056c5499befSdrh       testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]-1 );
1057c5499befSdrh       testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] );
1058c8d735aeSdan       if( bOk==0 || i<1 || i>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
1059fa6bc000Sdrh         sqlite3ErrorMsg(pParse, "variable number must be between ?1 and ?%d",
1060bb4957f8Sdrh             db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]);
1061c9b39288Sdrh         return;
1062fa6bc000Sdrh       }
10638e74e7baSdrh       x = (ynVar)i;
1064f326d66dSdrh       if( x>pParse->nVar ){
1065f326d66dSdrh         pParse->nVar = (int)x;
1066f326d66dSdrh         doAdd = 1;
1067f326d66dSdrh       }else if( sqlite3VListNumToName(pParse->pVList, x)==0 ){
1068f326d66dSdrh         doAdd = 1;
1069fa6bc000Sdrh       }
1070fa6bc000Sdrh     }else{
107151f49f17Sdrh       /* Wildcards like ":aaa", "$aaa" or "@aaa".  Reuse the same variable
1072fa6bc000Sdrh       ** number as the prior appearance of the same name, or if the name
1073fa6bc000Sdrh       ** has never appeared before, reuse the same variable number
1074fa6bc000Sdrh       */
10759bf755ccSdrh       x = (ynVar)sqlite3VListNameToNum(pParse->pVList, z, n);
10769bf755ccSdrh       if( x==0 ){
10779bf755ccSdrh         x = (ynVar)(++pParse->nVar);
1078f326d66dSdrh         doAdd = 1;
1079f326d66dSdrh       }
1080f326d66dSdrh     }
1081f326d66dSdrh     if( doAdd ){
10829bf755ccSdrh       pParse->pVList = sqlite3VListAdd(db, pParse->pVList, z, n, x);
1083fa6bc000Sdrh     }
1084fa6bc000Sdrh   }
1085c9b39288Sdrh   pExpr->iColumn = x;
1086f326d66dSdrh   if( x>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
1087832b2664Sdanielk1977     sqlite3ErrorMsg(pParse, "too many SQL variables");
1088832b2664Sdanielk1977   }
1089fa6bc000Sdrh }
1090fa6bc000Sdrh 
1091fa6bc000Sdrh /*
1092f6963f99Sdan ** Recursively delete an expression tree.
1093a2e00042Sdrh */
10944f0010b1Sdrh static SQLITE_NOINLINE void sqlite3ExprDeleteNN(sqlite3 *db, Expr *p){
10954f0010b1Sdrh   assert( p!=0 );
1096d50ffc41Sdrh   /* Sanity check: Assert that the IntValue is non-negative if it exists */
1097d50ffc41Sdrh   assert( !ExprHasProperty(p, EP_IntValue) || p->u.iValue>=0 );
1098eda079cdSdrh 
1099eda079cdSdrh   assert( !ExprHasProperty(p, EP_WinFunc) || p->y.pWin!=0 || db->mallocFailed );
1100eda079cdSdrh   assert( p->op!=TK_FUNCTION || ExprHasProperty(p, EP_TokenOnly|EP_Reduced)
11014f9adee2Sdan           || p->y.pWin==0 || ExprHasProperty(p, EP_WinFunc) );
1102209bc522Sdrh #ifdef SQLITE_DEBUG
1103209bc522Sdrh   if( ExprHasProperty(p, EP_Leaf) && !ExprHasProperty(p, EP_TokenOnly) ){
1104209bc522Sdrh     assert( p->pLeft==0 );
1105209bc522Sdrh     assert( p->pRight==0 );
1106209bc522Sdrh     assert( p->x.pSelect==0 );
1107209bc522Sdrh   }
1108209bc522Sdrh #endif
1109209bc522Sdrh   if( !ExprHasProperty(p, (EP_TokenOnly|EP_Leaf)) ){
1110c5cd1249Sdrh     /* The Expr.x union is never used at the same time as Expr.pRight */
1111c5cd1249Sdrh     assert( p->x.pList==0 || p->pRight==0 );
11124910a76dSdrh     if( p->pLeft && p->op!=TK_SELECT_COLUMN ) sqlite3ExprDeleteNN(db, p->pLeft);
1113d1086679Sdrh     if( p->pRight ){
11144f9adee2Sdan       assert( !ExprHasProperty(p, EP_WinFunc) );
1115d1086679Sdrh       sqlite3ExprDeleteNN(db, p->pRight);
1116d1086679Sdrh     }else if( ExprHasProperty(p, EP_xIsSelect) ){
11174f9adee2Sdan       assert( !ExprHasProperty(p, EP_WinFunc) );
11186ab3a2ecSdanielk1977       sqlite3SelectDelete(db, p->x.pSelect);
11196ab3a2ecSdanielk1977     }else{
11206ab3a2ecSdanielk1977       sqlite3ExprListDelete(db, p->x.pList);
11216ba7ab0dSdan #ifndef SQLITE_OMIT_WINDOWFUNC
1122eda079cdSdrh       if( ExprHasProperty(p, EP_WinFunc) ){
1123eda079cdSdrh         sqlite3WindowDelete(db, p->y.pWin);
112486fb6e17Sdan       }
11256ba7ab0dSdan #endif
11266ab3a2ecSdanielk1977     }
11278117f113Sdan   }
1128209bc522Sdrh   if( ExprHasProperty(p, EP_MemToken) ) sqlite3DbFree(db, p->u.zToken);
112933e619fcSdrh   if( !ExprHasProperty(p, EP_Static) ){
1130dbd6a7dcSdrh     sqlite3DbFreeNN(db, p);
1131a2e00042Sdrh   }
113233e619fcSdrh }
11334f0010b1Sdrh void sqlite3ExprDelete(sqlite3 *db, Expr *p){
11344f0010b1Sdrh   if( p ) sqlite3ExprDeleteNN(db, p);
11354f0010b1Sdrh }
1136a2e00042Sdrh 
11378e34e406Sdrh /* Invoke sqlite3RenameExprUnmap() and sqlite3ExprDelete() on the
11388e34e406Sdrh ** expression.
11398e34e406Sdrh */
11408e34e406Sdrh void sqlite3ExprUnmapAndDelete(Parse *pParse, Expr *p){
11418e34e406Sdrh   if( p ){
11428e34e406Sdrh     if( IN_RENAME_OBJECT ){
11438e34e406Sdrh       sqlite3RenameExprUnmap(pParse, p);
11448e34e406Sdrh     }
11458e34e406Sdrh     sqlite3ExprDeleteNN(pParse->db, p);
11468e34e406Sdrh   }
11478e34e406Sdrh }
11488e34e406Sdrh 
1149d2687b77Sdrh /*
11506ab3a2ecSdanielk1977 ** Return the number of bytes allocated for the expression structure
11516ab3a2ecSdanielk1977 ** passed as the first argument. This is always one of EXPR_FULLSIZE,
11526ab3a2ecSdanielk1977 ** EXPR_REDUCEDSIZE or EXPR_TOKENONLYSIZE.
11536ab3a2ecSdanielk1977 */
11546ab3a2ecSdanielk1977 static int exprStructSize(Expr *p){
11556ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_TokenOnly) ) return EXPR_TOKENONLYSIZE;
11566ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_Reduced) ) return EXPR_REDUCEDSIZE;
11576ab3a2ecSdanielk1977   return EXPR_FULLSIZE;
11586ab3a2ecSdanielk1977 }
11596ab3a2ecSdanielk1977 
11606ab3a2ecSdanielk1977 /*
116133e619fcSdrh ** The dupedExpr*Size() routines each return the number of bytes required
116233e619fcSdrh ** to store a copy of an expression or expression tree.  They differ in
116333e619fcSdrh ** how much of the tree is measured.
116433e619fcSdrh **
116533e619fcSdrh **     dupedExprStructSize()     Size of only the Expr structure
116633e619fcSdrh **     dupedExprNodeSize()       Size of Expr + space for token
116733e619fcSdrh **     dupedExprSize()           Expr + token + subtree components
116833e619fcSdrh **
116933e619fcSdrh ***************************************************************************
117033e619fcSdrh **
117133e619fcSdrh ** The dupedExprStructSize() function returns two values OR-ed together:
117233e619fcSdrh ** (1) the space required for a copy of the Expr structure only and
117333e619fcSdrh ** (2) the EP_xxx flags that indicate what the structure size should be.
117433e619fcSdrh ** The return values is always one of:
117533e619fcSdrh **
117633e619fcSdrh **      EXPR_FULLSIZE
117733e619fcSdrh **      EXPR_REDUCEDSIZE   | EP_Reduced
117833e619fcSdrh **      EXPR_TOKENONLYSIZE | EP_TokenOnly
117933e619fcSdrh **
118033e619fcSdrh ** The size of the structure can be found by masking the return value
118133e619fcSdrh ** of this routine with 0xfff.  The flags can be found by masking the
118233e619fcSdrh ** return value with EP_Reduced|EP_TokenOnly.
118333e619fcSdrh **
118433e619fcSdrh ** Note that with flags==EXPRDUP_REDUCE, this routines works on full-size
118533e619fcSdrh ** (unreduced) Expr objects as they or originally constructed by the parser.
118633e619fcSdrh ** During expression analysis, extra information is computed and moved into
1187c95f38d4Sdan ** later parts of the Expr object and that extra information might get chopped
118833e619fcSdrh ** off if the expression is reduced.  Note also that it does not work to
118960ec914cSpeter.d.reid ** make an EXPRDUP_REDUCE copy of a reduced expression.  It is only legal
119033e619fcSdrh ** to reduce a pristine expression tree from the parser.  The implementation
119133e619fcSdrh ** of dupedExprStructSize() contain multiple assert() statements that attempt
119233e619fcSdrh ** to enforce this constraint.
11936ab3a2ecSdanielk1977 */
11946ab3a2ecSdanielk1977 static int dupedExprStructSize(Expr *p, int flags){
11956ab3a2ecSdanielk1977   int nSize;
119633e619fcSdrh   assert( flags==EXPRDUP_REDUCE || flags==0 ); /* Only one flag value allowed */
1197aecd8021Sdrh   assert( EXPR_FULLSIZE<=0xfff );
1198aecd8021Sdrh   assert( (0xfff & (EP_Reduced|EP_TokenOnly))==0 );
119967a9b8edSdan   if( 0==flags || p->op==TK_SELECT_COLUMN
120067a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
1201eda079cdSdrh    || ExprHasProperty(p, EP_WinFunc)
120267a9b8edSdan #endif
120367a9b8edSdan   ){
12046ab3a2ecSdanielk1977     nSize = EXPR_FULLSIZE;
12056ab3a2ecSdanielk1977   }else{
1206c5cd1249Sdrh     assert( !ExprHasProperty(p, EP_TokenOnly|EP_Reduced) );
120733e619fcSdrh     assert( !ExprHasProperty(p, EP_FromJoin) );
1208c5cd1249Sdrh     assert( !ExprHasProperty(p, EP_MemToken) );
1209ebb6a65dSdrh     assert( !ExprHasProperty(p, EP_NoReduce) );
1210aecd8021Sdrh     if( p->pLeft || p->x.pList ){
121133e619fcSdrh       nSize = EXPR_REDUCEDSIZE | EP_Reduced;
121233e619fcSdrh     }else{
1213aecd8021Sdrh       assert( p->pRight==0 );
121433e619fcSdrh       nSize = EXPR_TOKENONLYSIZE | EP_TokenOnly;
121533e619fcSdrh     }
12166ab3a2ecSdanielk1977   }
12176ab3a2ecSdanielk1977   return nSize;
12186ab3a2ecSdanielk1977 }
12196ab3a2ecSdanielk1977 
12206ab3a2ecSdanielk1977 /*
122133e619fcSdrh ** This function returns the space in bytes required to store the copy
122233e619fcSdrh ** of the Expr structure and a copy of the Expr.u.zToken string (if that
122333e619fcSdrh ** string is defined.)
12246ab3a2ecSdanielk1977 */
12256ab3a2ecSdanielk1977 static int dupedExprNodeSize(Expr *p, int flags){
122633e619fcSdrh   int nByte = dupedExprStructSize(p, flags) & 0xfff;
122733e619fcSdrh   if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
12287301e774Sdrh     nByte += sqlite3Strlen30NN(p->u.zToken)+1;
12296ab3a2ecSdanielk1977   }
1230bc73971dSdanielk1977   return ROUND8(nByte);
12316ab3a2ecSdanielk1977 }
12326ab3a2ecSdanielk1977 
12336ab3a2ecSdanielk1977 /*
12346ab3a2ecSdanielk1977 ** Return the number of bytes required to create a duplicate of the
12356ab3a2ecSdanielk1977 ** expression passed as the first argument. The second argument is a
12366ab3a2ecSdanielk1977 ** mask containing EXPRDUP_XXX flags.
12376ab3a2ecSdanielk1977 **
12386ab3a2ecSdanielk1977 ** The value returned includes space to create a copy of the Expr struct
123933e619fcSdrh ** itself and the buffer referred to by Expr.u.zToken, if any.
12406ab3a2ecSdanielk1977 **
12416ab3a2ecSdanielk1977 ** If the EXPRDUP_REDUCE flag is set, then the return value includes
12426ab3a2ecSdanielk1977 ** space to duplicate all Expr nodes in the tree formed by Expr.pLeft
12436ab3a2ecSdanielk1977 ** and Expr.pRight variables (but not for any structures pointed to or
12446ab3a2ecSdanielk1977 ** descended from the Expr.x.pList or Expr.x.pSelect variables).
12456ab3a2ecSdanielk1977 */
12466ab3a2ecSdanielk1977 static int dupedExprSize(Expr *p, int flags){
12476ab3a2ecSdanielk1977   int nByte = 0;
12486ab3a2ecSdanielk1977   if( p ){
12496ab3a2ecSdanielk1977     nByte = dupedExprNodeSize(p, flags);
12506ab3a2ecSdanielk1977     if( flags&EXPRDUP_REDUCE ){
1251b7916a78Sdrh       nByte += dupedExprSize(p->pLeft, flags) + dupedExprSize(p->pRight, flags);
12526ab3a2ecSdanielk1977     }
12536ab3a2ecSdanielk1977   }
12546ab3a2ecSdanielk1977   return nByte;
12556ab3a2ecSdanielk1977 }
12566ab3a2ecSdanielk1977 
12576ab3a2ecSdanielk1977 /*
12586ab3a2ecSdanielk1977 ** This function is similar to sqlite3ExprDup(), except that if pzBuffer
12596ab3a2ecSdanielk1977 ** is not NULL then *pzBuffer is assumed to point to a buffer large enough
126033e619fcSdrh ** to store the copy of expression p, the copies of p->u.zToken
12616ab3a2ecSdanielk1977 ** (if applicable), and the copies of the p->pLeft and p->pRight expressions,
126260ec914cSpeter.d.reid ** if any. Before returning, *pzBuffer is set to the first byte past the
12636ab3a2ecSdanielk1977 ** portion of the buffer copied into by this function.
12646ab3a2ecSdanielk1977 */
12653c19469cSdrh static Expr *exprDup(sqlite3 *db, Expr *p, int dupFlags, u8 **pzBuffer){
12663c19469cSdrh   Expr *pNew;           /* Value to return */
12673c19469cSdrh   u8 *zAlloc;           /* Memory space from which to build Expr object */
12683c19469cSdrh   u32 staticFlag;       /* EP_Static if space not obtained from malloc */
12696ab3a2ecSdanielk1977 
12703c19469cSdrh   assert( db!=0 );
12713c19469cSdrh   assert( p );
12723c19469cSdrh   assert( dupFlags==0 || dupFlags==EXPRDUP_REDUCE );
12733c19469cSdrh   assert( pzBuffer==0 || dupFlags==EXPRDUP_REDUCE );
12746ab3a2ecSdanielk1977 
12756ab3a2ecSdanielk1977   /* Figure out where to write the new Expr structure. */
12766ab3a2ecSdanielk1977   if( pzBuffer ){
12776ab3a2ecSdanielk1977     zAlloc = *pzBuffer;
127833e619fcSdrh     staticFlag = EP_Static;
12796ab3a2ecSdanielk1977   }else{
12803c19469cSdrh     zAlloc = sqlite3DbMallocRawNN(db, dupedExprSize(p, dupFlags));
12813c19469cSdrh     staticFlag = 0;
12826ab3a2ecSdanielk1977   }
12836ab3a2ecSdanielk1977   pNew = (Expr *)zAlloc;
12846ab3a2ecSdanielk1977 
12856ab3a2ecSdanielk1977   if( pNew ){
12866ab3a2ecSdanielk1977     /* Set nNewSize to the size allocated for the structure pointed to
12876ab3a2ecSdanielk1977     ** by pNew. This is either EXPR_FULLSIZE, EXPR_REDUCEDSIZE or
12886ab3a2ecSdanielk1977     ** EXPR_TOKENONLYSIZE. nToken is set to the number of bytes consumed
128933e619fcSdrh     ** by the copy of the p->u.zToken string (if any).
12906ab3a2ecSdanielk1977     */
12913c19469cSdrh     const unsigned nStructSize = dupedExprStructSize(p, dupFlags);
129233e619fcSdrh     const int nNewSize = nStructSize & 0xfff;
129333e619fcSdrh     int nToken;
129433e619fcSdrh     if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
129533e619fcSdrh       nToken = sqlite3Strlen30(p->u.zToken) + 1;
129633e619fcSdrh     }else{
129733e619fcSdrh       nToken = 0;
129833e619fcSdrh     }
12993c19469cSdrh     if( dupFlags ){
13006ab3a2ecSdanielk1977       assert( ExprHasProperty(p, EP_Reduced)==0 );
13016ab3a2ecSdanielk1977       memcpy(zAlloc, p, nNewSize);
13026ab3a2ecSdanielk1977     }else{
13033e6a1411Sdan       u32 nSize = (u32)exprStructSize(p);
13046ab3a2ecSdanielk1977       memcpy(zAlloc, p, nSize);
130572ea29d7Sdrh       if( nSize<EXPR_FULLSIZE ){
13066ab3a2ecSdanielk1977         memset(&zAlloc[nSize], 0, EXPR_FULLSIZE-nSize);
13076ab3a2ecSdanielk1977       }
130872ea29d7Sdrh     }
13096ab3a2ecSdanielk1977 
131033e619fcSdrh     /* Set the EP_Reduced, EP_TokenOnly, and EP_Static flags appropriately. */
1311c5cd1249Sdrh     pNew->flags &= ~(EP_Reduced|EP_TokenOnly|EP_Static|EP_MemToken);
131233e619fcSdrh     pNew->flags |= nStructSize & (EP_Reduced|EP_TokenOnly);
131333e619fcSdrh     pNew->flags |= staticFlag;
13146ab3a2ecSdanielk1977 
131533e619fcSdrh     /* Copy the p->u.zToken string, if any. */
13166ab3a2ecSdanielk1977     if( nToken ){
131733e619fcSdrh       char *zToken = pNew->u.zToken = (char*)&zAlloc[nNewSize];
131833e619fcSdrh       memcpy(zToken, p->u.zToken, nToken);
13196ab3a2ecSdanielk1977     }
13206ab3a2ecSdanielk1977 
1321209bc522Sdrh     if( 0==((p->flags|pNew->flags) & (EP_TokenOnly|EP_Leaf)) ){
13226ab3a2ecSdanielk1977       /* Fill in the pNew->x.pSelect or pNew->x.pList member. */
13236ab3a2ecSdanielk1977       if( ExprHasProperty(p, EP_xIsSelect) ){
13243c19469cSdrh         pNew->x.pSelect = sqlite3SelectDup(db, p->x.pSelect, dupFlags);
13256ab3a2ecSdanielk1977       }else{
13263c19469cSdrh         pNew->x.pList = sqlite3ExprListDup(db, p->x.pList, dupFlags);
13276ab3a2ecSdanielk1977       }
13286ab3a2ecSdanielk1977     }
13296ab3a2ecSdanielk1977 
13306ab3a2ecSdanielk1977     /* Fill in pNew->pLeft and pNew->pRight. */
13314f9adee2Sdan     if( ExprHasProperty(pNew, EP_Reduced|EP_TokenOnly|EP_WinFunc) ){
13323c19469cSdrh       zAlloc += dupedExprNodeSize(p, dupFlags);
1333209bc522Sdrh       if( !ExprHasProperty(pNew, EP_TokenOnly|EP_Leaf) ){
13343c19469cSdrh         pNew->pLeft = p->pLeft ?
13353c19469cSdrh                       exprDup(db, p->pLeft, EXPRDUP_REDUCE, &zAlloc) : 0;
13363c19469cSdrh         pNew->pRight = p->pRight ?
13373c19469cSdrh                        exprDup(db, p->pRight, EXPRDUP_REDUCE, &zAlloc) : 0;
13386ab3a2ecSdanielk1977       }
133967a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
1340eda079cdSdrh       if( ExprHasProperty(p, EP_WinFunc) ){
1341eda079cdSdrh         pNew->y.pWin = sqlite3WindowDup(db, pNew, p->y.pWin);
1342eda079cdSdrh         assert( ExprHasProperty(pNew, EP_WinFunc) );
1343e2f781b9Sdan       }
134467a9b8edSdan #endif /* SQLITE_OMIT_WINDOWFUNC */
134553988068Sdrh       if( pzBuffer ){
134653988068Sdrh         *pzBuffer = zAlloc;
134753988068Sdrh       }
134853988068Sdrh     }else{
1349209bc522Sdrh       if( !ExprHasProperty(p, EP_TokenOnly|EP_Leaf) ){
13509854260bSdrh         if( pNew->op==TK_SELECT_COLUMN ){
13519854260bSdrh           pNew->pLeft = p->pLeft;
135247073f62Sdrh           assert( p->iColumn==0 || p->pRight==0 );
135347073f62Sdrh           assert( p->pRight==0  || p->pRight==p->pLeft );
13549854260bSdrh         }else{
13556ab3a2ecSdanielk1977           pNew->pLeft = sqlite3ExprDup(db, p->pLeft, 0);
13569854260bSdrh         }
13576ab3a2ecSdanielk1977         pNew->pRight = sqlite3ExprDup(db, p->pRight, 0);
13586ab3a2ecSdanielk1977       }
13596ab3a2ecSdanielk1977     }
13606ab3a2ecSdanielk1977   }
13616ab3a2ecSdanielk1977   return pNew;
13626ab3a2ecSdanielk1977 }
13636ab3a2ecSdanielk1977 
13646ab3a2ecSdanielk1977 /*
1365bfe31e7fSdan ** Create and return a deep copy of the object passed as the second
1366bfe31e7fSdan ** argument. If an OOM condition is encountered, NULL is returned
1367bfe31e7fSdan ** and the db->mallocFailed flag set.
1368bfe31e7fSdan */
1369eede6a53Sdan #ifndef SQLITE_OMIT_CTE
1370bfe31e7fSdan static With *withDup(sqlite3 *db, With *p){
13714e9119d9Sdan   With *pRet = 0;
13724e9119d9Sdan   if( p ){
1373d4de9f7bSdrh     sqlite3_int64 nByte = sizeof(*p) + sizeof(p->a[0]) * (p->nCte-1);
13744e9119d9Sdan     pRet = sqlite3DbMallocZero(db, nByte);
13754e9119d9Sdan     if( pRet ){
13764e9119d9Sdan       int i;
13774e9119d9Sdan       pRet->nCte = p->nCte;
13784e9119d9Sdan       for(i=0; i<p->nCte; i++){
13794e9119d9Sdan         pRet->a[i].pSelect = sqlite3SelectDup(db, p->a[i].pSelect, 0);
13804e9119d9Sdan         pRet->a[i].pCols = sqlite3ExprListDup(db, p->a[i].pCols, 0);
13814e9119d9Sdan         pRet->a[i].zName = sqlite3DbStrDup(db, p->a[i].zName);
13824e9119d9Sdan       }
13834e9119d9Sdan     }
13844e9119d9Sdan   }
13854e9119d9Sdan   return pRet;
13864e9119d9Sdan }
1387eede6a53Sdan #else
1388eede6a53Sdan # define withDup(x,y) 0
1389eede6a53Sdan #endif
13904e9119d9Sdan 
1391a8389975Sdrh #ifndef SQLITE_OMIT_WINDOWFUNC
1392a8389975Sdrh /*
1393a8389975Sdrh ** The gatherSelectWindows() procedure and its helper routine
1394a8389975Sdrh ** gatherSelectWindowsCallback() are used to scan all the expressions
1395a8389975Sdrh ** an a newly duplicated SELECT statement and gather all of the Window
1396a8389975Sdrh ** objects found there, assembling them onto the linked list at Select->pWin.
1397a8389975Sdrh */
1398a8389975Sdrh static int gatherSelectWindowsCallback(Walker *pWalker, Expr *pExpr){
13996ba7ab0dSdan   if( pExpr->op==TK_FUNCTION && ExprHasProperty(pExpr, EP_WinFunc) ){
140075b0821eSdan     Select *pSelect = pWalker->u.pSelect;
140175b0821eSdan     Window *pWin = pExpr->y.pWin;
140275b0821eSdan     assert( pWin );
14034f9adee2Sdan     assert( IsWindowFunc(pExpr) );
1404e0ae3f69Sdan     assert( pWin->ppThis==0 );
1405a3fcc000Sdan     sqlite3WindowLink(pSelect, pWin);
1406a8389975Sdrh   }
1407a8389975Sdrh   return WRC_Continue;
1408a8389975Sdrh }
1409a37b6a5eSdrh static int gatherSelectWindowsSelectCallback(Walker *pWalker, Select *p){
1410a37b6a5eSdrh   return p==pWalker->u.pSelect ? WRC_Continue : WRC_Prune;
1411a37b6a5eSdrh }
1412a8389975Sdrh static void gatherSelectWindows(Select *p){
1413a8389975Sdrh   Walker w;
1414a8389975Sdrh   w.xExprCallback = gatherSelectWindowsCallback;
1415a37b6a5eSdrh   w.xSelectCallback = gatherSelectWindowsSelectCallback;
1416a37b6a5eSdrh   w.xSelectCallback2 = 0;
14179c46c66cSdrh   w.pParse = 0;
1418a8389975Sdrh   w.u.pSelect = p;
1419a37b6a5eSdrh   sqlite3WalkSelect(&w, p);
1420a8389975Sdrh }
1421a8389975Sdrh #endif
1422a8389975Sdrh 
1423a8389975Sdrh 
1424a76b5dfcSdrh /*
1425ff78bd2fSdrh ** The following group of routines make deep copies of expressions,
1426ff78bd2fSdrh ** expression lists, ID lists, and select statements.  The copies can
1427ff78bd2fSdrh ** be deleted (by being passed to their respective ...Delete() routines)
1428ff78bd2fSdrh ** without effecting the originals.
1429ff78bd2fSdrh **
14304adee20fSdanielk1977 ** The expression list, ID, and source lists return by sqlite3ExprListDup(),
14314adee20fSdanielk1977 ** sqlite3IdListDup(), and sqlite3SrcListDup() can not be further expanded
1432ad3cab52Sdrh ** by subsequent calls to sqlite*ListAppend() routines.
1433ff78bd2fSdrh **
1434ad3cab52Sdrh ** Any tables that the SrcList might point to are not duplicated.
14356ab3a2ecSdanielk1977 **
1436b7916a78Sdrh ** The flags parameter contains a combination of the EXPRDUP_XXX flags.
14376ab3a2ecSdanielk1977 ** If the EXPRDUP_REDUCE flag is set, then the structure returned is a
14386ab3a2ecSdanielk1977 ** truncated version of the usual Expr structure that will be stored as
14396ab3a2ecSdanielk1977 ** part of the in-memory representation of the database schema.
1440ff78bd2fSdrh */
14416ab3a2ecSdanielk1977 Expr *sqlite3ExprDup(sqlite3 *db, Expr *p, int flags){
144272ea29d7Sdrh   assert( flags==0 || flags==EXPRDUP_REDUCE );
14433c19469cSdrh   return p ? exprDup(db, p, flags, 0) : 0;
1444ff78bd2fSdrh }
14456ab3a2ecSdanielk1977 ExprList *sqlite3ExprListDup(sqlite3 *db, ExprList *p, int flags){
1446ff78bd2fSdrh   ExprList *pNew;
1447145716b3Sdrh   struct ExprList_item *pItem, *pOldItem;
1448ff78bd2fSdrh   int i;
1449b163748eSdrh   Expr *pPriorSelectCol = 0;
1450575fad65Sdrh   assert( db!=0 );
1451ff78bd2fSdrh   if( p==0 ) return 0;
145297258194Sdrh   pNew = sqlite3DbMallocRawNN(db, sqlite3DbMallocSize(db, p));
1453ff78bd2fSdrh   if( pNew==0 ) return 0;
1454a19543feSdrh   pNew->nExpr = p->nExpr;
145543606175Sdrh   pItem = pNew->a;
1456145716b3Sdrh   pOldItem = p->a;
1457145716b3Sdrh   for(i=0; i<p->nExpr; i++, pItem++, pOldItem++){
14586ab3a2ecSdanielk1977     Expr *pOldExpr = pOldItem->pExpr;
145947073f62Sdrh     Expr *pNewExpr;
1460b5526ea6Sdrh     pItem->pExpr = sqlite3ExprDup(db, pOldExpr, flags);
146147073f62Sdrh     if( pOldExpr
146247073f62Sdrh      && pOldExpr->op==TK_SELECT_COLUMN
146347073f62Sdrh      && (pNewExpr = pItem->pExpr)!=0
146447073f62Sdrh     ){
146547073f62Sdrh       assert( pNewExpr->iColumn==0 || i>0 );
146647073f62Sdrh       if( pNewExpr->iColumn==0 ){
146747073f62Sdrh         assert( pOldExpr->pLeft==pOldExpr->pRight );
1468b163748eSdrh         pPriorSelectCol = pNewExpr->pLeft = pNewExpr->pRight;
1469b163748eSdrh       }else{
1470b163748eSdrh         assert( i>0 );
1471b163748eSdrh         assert( pItem[-1].pExpr!=0 );
1472b163748eSdrh         assert( pNewExpr->iColumn==pItem[-1].pExpr->iColumn+1 );
1473b163748eSdrh         assert( pPriorSelectCol==pItem[-1].pExpr->pLeft );
1474b163748eSdrh         pNewExpr->pLeft = pPriorSelectCol;
147547073f62Sdrh       }
147647073f62Sdrh     }
147741cee668Sdrh     pItem->zEName = sqlite3DbStrDup(db, pOldItem->zEName);
14786e11892dSdan     pItem->sortFlags = pOldItem->sortFlags;
1479cbb9da33Sdrh     pItem->eEName = pOldItem->eEName;
14803e7bc9caSdrh     pItem->done = 0;
1481ae8e45cbSdan     pItem->bNulls = pOldItem->bNulls;
148224e25d32Sdan     pItem->bSorterRef = pOldItem->bSorterRef;
1483c2acc4e4Sdrh     pItem->u = pOldItem->u;
1484ff78bd2fSdrh   }
1485ff78bd2fSdrh   return pNew;
1486ff78bd2fSdrh }
148793758c8dSdanielk1977 
148893758c8dSdanielk1977 /*
148993758c8dSdanielk1977 ** If cursors, triggers, views and subqueries are all omitted from
149093758c8dSdanielk1977 ** the build, then none of the following routines, except for
149193758c8dSdanielk1977 ** sqlite3SelectDup(), can be called. sqlite3SelectDup() is sometimes
149293758c8dSdanielk1977 ** called with a NULL argument.
149393758c8dSdanielk1977 */
14946a67fe8eSdanielk1977 #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_TRIGGER) \
14956a67fe8eSdanielk1977  || !defined(SQLITE_OMIT_SUBQUERY)
14966ab3a2ecSdanielk1977 SrcList *sqlite3SrcListDup(sqlite3 *db, SrcList *p, int flags){
1497ad3cab52Sdrh   SrcList *pNew;
1498ad3cab52Sdrh   int i;
1499113088ecSdrh   int nByte;
1500575fad65Sdrh   assert( db!=0 );
1501ad3cab52Sdrh   if( p==0 ) return 0;
1502113088ecSdrh   nByte = sizeof(*p) + (p->nSrc>0 ? sizeof(p->a[0]) * (p->nSrc-1) : 0);
1503575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, nByte );
1504ad3cab52Sdrh   if( pNew==0 ) return 0;
15054305d103Sdrh   pNew->nSrc = pNew->nAlloc = p->nSrc;
1506ad3cab52Sdrh   for(i=0; i<p->nSrc; i++){
15074efc4754Sdrh     struct SrcList_item *pNewItem = &pNew->a[i];
15084efc4754Sdrh     struct SrcList_item *pOldItem = &p->a[i];
1509ed8a3bb1Sdrh     Table *pTab;
151041fb5cd1Sdan     pNewItem->pSchema = pOldItem->pSchema;
151117435752Sdrh     pNewItem->zDatabase = sqlite3DbStrDup(db, pOldItem->zDatabase);
151217435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
151317435752Sdrh     pNewItem->zAlias = sqlite3DbStrDup(db, pOldItem->zAlias);
15148a48b9c0Sdrh     pNewItem->fg = pOldItem->fg;
15154efc4754Sdrh     pNewItem->iCursor = pOldItem->iCursor;
15165b6a9ed4Sdrh     pNewItem->addrFillSub = pOldItem->addrFillSub;
15175b6a9ed4Sdrh     pNewItem->regReturn = pOldItem->regReturn;
15188a48b9c0Sdrh     if( pNewItem->fg.isIndexedBy ){
15198a48b9c0Sdrh       pNewItem->u1.zIndexedBy = sqlite3DbStrDup(db, pOldItem->u1.zIndexedBy);
15208a48b9c0Sdrh     }
15218a48b9c0Sdrh     pNewItem->pIBIndex = pOldItem->pIBIndex;
15228a48b9c0Sdrh     if( pNewItem->fg.isTabFunc ){
15238a48b9c0Sdrh       pNewItem->u1.pFuncArg =
15248a48b9c0Sdrh           sqlite3ExprListDup(db, pOldItem->u1.pFuncArg, flags);
15258a48b9c0Sdrh     }
1526ed8a3bb1Sdrh     pTab = pNewItem->pTab = pOldItem->pTab;
1527ed8a3bb1Sdrh     if( pTab ){
152879df7782Sdrh       pTab->nTabRef++;
1529a1cb183dSdanielk1977     }
15306ab3a2ecSdanielk1977     pNewItem->pSelect = sqlite3SelectDup(db, pOldItem->pSelect, flags);
15316ab3a2ecSdanielk1977     pNewItem->pOn = sqlite3ExprDup(db, pOldItem->pOn, flags);
153217435752Sdrh     pNewItem->pUsing = sqlite3IdListDup(db, pOldItem->pUsing);
15336c18b6e0Sdanielk1977     pNewItem->colUsed = pOldItem->colUsed;
1534ad3cab52Sdrh   }
1535ad3cab52Sdrh   return pNew;
1536ad3cab52Sdrh }
153717435752Sdrh IdList *sqlite3IdListDup(sqlite3 *db, IdList *p){
1538ff78bd2fSdrh   IdList *pNew;
1539ff78bd2fSdrh   int i;
1540575fad65Sdrh   assert( db!=0 );
1541ff78bd2fSdrh   if( p==0 ) return 0;
1542575fad65Sdrh   pNew = sqlite3DbMallocRawNN(db, sizeof(*pNew) );
1543ff78bd2fSdrh   if( pNew==0 ) return 0;
15446c535158Sdrh   pNew->nId = p->nId;
1545575fad65Sdrh   pNew->a = sqlite3DbMallocRawNN(db, p->nId*sizeof(p->a[0]) );
1546d5d56523Sdanielk1977   if( pNew->a==0 ){
1547dbd6a7dcSdrh     sqlite3DbFreeNN(db, pNew);
1548d5d56523Sdanielk1977     return 0;
1549d5d56523Sdanielk1977   }
15506c535158Sdrh   /* Note that because the size of the allocation for p->a[] is not
15516c535158Sdrh   ** necessarily a power of two, sqlite3IdListAppend() may not be called
15526c535158Sdrh   ** on the duplicate created by this function. */
1553ff78bd2fSdrh   for(i=0; i<p->nId; i++){
15544efc4754Sdrh     struct IdList_item *pNewItem = &pNew->a[i];
15554efc4754Sdrh     struct IdList_item *pOldItem = &p->a[i];
155617435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
15574efc4754Sdrh     pNewItem->idx = pOldItem->idx;
1558ff78bd2fSdrh   }
1559ff78bd2fSdrh   return pNew;
1560ff78bd2fSdrh }
1561a7466205Sdan Select *sqlite3SelectDup(sqlite3 *db, Select *pDup, int flags){
1562a7466205Sdan   Select *pRet = 0;
1563a7466205Sdan   Select *pNext = 0;
1564a7466205Sdan   Select **pp = &pRet;
1565a7466205Sdan   Select *p;
1566a7466205Sdan 
1567575fad65Sdrh   assert( db!=0 );
1568a7466205Sdan   for(p=pDup; p; p=p->pPrior){
1569a7466205Sdan     Select *pNew = sqlite3DbMallocRawNN(db, sizeof(*p) );
1570a7466205Sdan     if( pNew==0 ) break;
1571b7916a78Sdrh     pNew->pEList = sqlite3ExprListDup(db, p->pEList, flags);
15726ab3a2ecSdanielk1977     pNew->pSrc = sqlite3SrcListDup(db, p->pSrc, flags);
15736ab3a2ecSdanielk1977     pNew->pWhere = sqlite3ExprDup(db, p->pWhere, flags);
15746ab3a2ecSdanielk1977     pNew->pGroupBy = sqlite3ExprListDup(db, p->pGroupBy, flags);
15756ab3a2ecSdanielk1977     pNew->pHaving = sqlite3ExprDup(db, p->pHaving, flags);
15766ab3a2ecSdanielk1977     pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, flags);
1577ff78bd2fSdrh     pNew->op = p->op;
1578a7466205Sdan     pNew->pNext = pNext;
1579a7466205Sdan     pNew->pPrior = 0;
15806ab3a2ecSdanielk1977     pNew->pLimit = sqlite3ExprDup(db, p->pLimit, flags);
158192b01d53Sdrh     pNew->iLimit = 0;
158292b01d53Sdrh     pNew->iOffset = 0;
15837d10d5a6Sdrh     pNew->selFlags = p->selFlags & ~SF_UsesEphemeral;
1584b9bb7c18Sdrh     pNew->addrOpenEphm[0] = -1;
1585b9bb7c18Sdrh     pNew->addrOpenEphm[1] = -1;
1586ec2da854Sdrh     pNew->nSelectRow = p->nSelectRow;
15874e9119d9Sdan     pNew->pWith = withDup(db, p->pWith);
158867a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
15892e362f97Sdan     pNew->pWin = 0;
1590c95f38d4Sdan     pNew->pWinDefn = sqlite3WindowListDup(db, p->pWinDefn);
15914780b9adSdan     if( p->pWin && db->mallocFailed==0 ) gatherSelectWindows(pNew);
159267a9b8edSdan #endif
1593fef37760Sdrh     pNew->selId = p->selId;
1594a7466205Sdan     *pp = pNew;
1595a7466205Sdan     pp = &pNew->pPrior;
1596a7466205Sdan     pNext = pNew;
1597a7466205Sdan   }
1598a7466205Sdan 
1599a7466205Sdan   return pRet;
1600ff78bd2fSdrh }
160193758c8dSdanielk1977 #else
16026ab3a2ecSdanielk1977 Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
160393758c8dSdanielk1977   assert( p==0 );
160493758c8dSdanielk1977   return 0;
160593758c8dSdanielk1977 }
160693758c8dSdanielk1977 #endif
1607ff78bd2fSdrh 
1608ff78bd2fSdrh 
1609ff78bd2fSdrh /*
1610a76b5dfcSdrh ** Add a new element to the end of an expression list.  If pList is
1611a76b5dfcSdrh ** initially NULL, then create a new expression list.
1612b7916a78Sdrh **
1613a19543feSdrh ** The pList argument must be either NULL or a pointer to an ExprList
1614a19543feSdrh ** obtained from a prior call to sqlite3ExprListAppend().  This routine
1615a19543feSdrh ** may not be used with an ExprList obtained from sqlite3ExprListDup().
1616a19543feSdrh ** Reason:  This routine assumes that the number of slots in pList->a[]
1617a19543feSdrh ** is a power of two.  That is true for sqlite3ExprListAppend() returns
1618a19543feSdrh ** but is not necessarily true from the return value of sqlite3ExprListDup().
1619a19543feSdrh **
1620b7916a78Sdrh ** If a memory allocation error occurs, the entire list is freed and
1621b7916a78Sdrh ** NULL is returned.  If non-NULL is returned, then it is guaranteed
1622b7916a78Sdrh ** that the new entry was successfully appended.
1623a76b5dfcSdrh */
162417435752Sdrh ExprList *sqlite3ExprListAppend(
162517435752Sdrh   Parse *pParse,          /* Parsing context */
162617435752Sdrh   ExprList *pList,        /* List to which to append. Might be NULL */
1627b7916a78Sdrh   Expr *pExpr             /* Expression to be appended. Might be NULL */
162817435752Sdrh ){
162943606175Sdrh   struct ExprList_item *pItem;
163017435752Sdrh   sqlite3 *db = pParse->db;
1631575fad65Sdrh   assert( db!=0 );
1632a76b5dfcSdrh   if( pList==0 ){
1633575fad65Sdrh     pList = sqlite3DbMallocRawNN(db, sizeof(ExprList) );
1634a76b5dfcSdrh     if( pList==0 ){
1635d5d56523Sdanielk1977       goto no_mem;
1636a76b5dfcSdrh     }
1637c263f7c4Sdrh     pList->nExpr = 0;
1638a19543feSdrh   }else if( (pList->nExpr & (pList->nExpr-1))==0 ){
163943606175Sdrh     ExprList *pNew;
164043606175Sdrh     pNew = sqlite3DbRealloc(db, pList,
16410aa3231fSdrh          sizeof(*pList)+(2*(sqlite3_int64)pList->nExpr-1)*sizeof(pList->a[0]));
164243606175Sdrh     if( pNew==0 ){
1643d5d56523Sdanielk1977       goto no_mem;
1644a76b5dfcSdrh     }
164543606175Sdrh     pList = pNew;
1646a76b5dfcSdrh   }
164743606175Sdrh   pItem = &pList->a[pList->nExpr++];
164841cee668Sdrh   assert( offsetof(struct ExprList_item,zEName)==sizeof(pItem->pExpr) );
1649a8b9793cSdrh   assert( offsetof(struct ExprList_item,pExpr)==0 );
165041cee668Sdrh   memset(&pItem->zEName,0,sizeof(*pItem)-offsetof(struct ExprList_item,zEName));
1651e94ddc9eSdanielk1977   pItem->pExpr = pExpr;
1652a76b5dfcSdrh   return pList;
1653d5d56523Sdanielk1977 
1654d5d56523Sdanielk1977 no_mem:
1655d5d56523Sdanielk1977   /* Avoid leaking memory if malloc has failed. */
1656633e6d57Sdrh   sqlite3ExprDelete(db, pExpr);
1657633e6d57Sdrh   sqlite3ExprListDelete(db, pList);
1658d5d56523Sdanielk1977   return 0;
1659a76b5dfcSdrh }
1660a76b5dfcSdrh 
1661a76b5dfcSdrh /*
16628762ec19Sdrh ** pColumns and pExpr form a vector assignment which is part of the SET
16638762ec19Sdrh ** clause of an UPDATE statement.  Like this:
1664a1251bc4Sdrh **
1665a1251bc4Sdrh **        (a,b,c) = (expr1,expr2,expr3)
1666a1251bc4Sdrh ** Or:    (a,b,c) = (SELECT x,y,z FROM ....)
1667a1251bc4Sdrh **
1668a1251bc4Sdrh ** For each term of the vector assignment, append new entries to the
1669b67343d0Sdrh ** expression list pList.  In the case of a subquery on the RHS, append
1670a1251bc4Sdrh ** TK_SELECT_COLUMN expressions.
1671a1251bc4Sdrh */
1672a1251bc4Sdrh ExprList *sqlite3ExprListAppendVector(
1673a1251bc4Sdrh   Parse *pParse,         /* Parsing context */
1674a1251bc4Sdrh   ExprList *pList,       /* List to which to append. Might be NULL */
1675a1251bc4Sdrh   IdList *pColumns,      /* List of names of LHS of the assignment */
1676a1251bc4Sdrh   Expr *pExpr            /* Vector expression to be appended. Might be NULL */
1677a1251bc4Sdrh ){
1678a1251bc4Sdrh   sqlite3 *db = pParse->db;
1679a1251bc4Sdrh   int n;
1680a1251bc4Sdrh   int i;
168166860af3Sdrh   int iFirst = pList ? pList->nExpr : 0;
1682321e828dSdrh   /* pColumns can only be NULL due to an OOM but an OOM will cause an
1683321e828dSdrh   ** exit prior to this routine being invoked */
1684321e828dSdrh   if( NEVER(pColumns==0) ) goto vector_append_error;
1685a1251bc4Sdrh   if( pExpr==0 ) goto vector_append_error;
1686966e2911Sdrh 
1687966e2911Sdrh   /* If the RHS is a vector, then we can immediately check to see that
1688966e2911Sdrh   ** the size of the RHS and LHS match.  But if the RHS is a SELECT,
1689966e2911Sdrh   ** wildcards ("*") in the result set of the SELECT must be expanded before
1690966e2911Sdrh   ** we can do the size check, so defer the size check until code generation.
1691966e2911Sdrh   */
1692966e2911Sdrh   if( pExpr->op!=TK_SELECT && pColumns->nId!=(n=sqlite3ExprVectorSize(pExpr)) ){
1693a1251bc4Sdrh     sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
1694a1251bc4Sdrh                     pColumns->nId, n);
1695a1251bc4Sdrh     goto vector_append_error;
1696a1251bc4Sdrh   }
1697966e2911Sdrh 
1698966e2911Sdrh   for(i=0; i<pColumns->nId; i++){
1699a1251bc4Sdrh     Expr *pSubExpr = sqlite3ExprForVectorField(pParse, pExpr, i);
1700554a9dc7Sdrh     assert( pSubExpr!=0 || db->mallocFailed );
1701554a9dc7Sdrh     assert( pSubExpr==0 || pSubExpr->iTable==0 );
1702554a9dc7Sdrh     if( pSubExpr==0 ) continue;
1703554a9dc7Sdrh     pSubExpr->iTable = pColumns->nId;
1704a1251bc4Sdrh     pList = sqlite3ExprListAppend(pParse, pList, pSubExpr);
1705a1251bc4Sdrh     if( pList ){
170666860af3Sdrh       assert( pList->nExpr==iFirst+i+1 );
170741cee668Sdrh       pList->a[pList->nExpr-1].zEName = pColumns->a[i].zName;
1708a1251bc4Sdrh       pColumns->a[i].zName = 0;
1709a1251bc4Sdrh     }
1710a1251bc4Sdrh   }
1711966e2911Sdrh 
1712ffe28059Sdrh   if( !db->mallocFailed && pExpr->op==TK_SELECT && ALWAYS(pList!=0) ){
1713966e2911Sdrh     Expr *pFirst = pList->a[iFirst].pExpr;
1714f4dd26c5Sdrh     assert( pFirst!=0 );
1715966e2911Sdrh     assert( pFirst->op==TK_SELECT_COLUMN );
1716966e2911Sdrh 
1717966e2911Sdrh     /* Store the SELECT statement in pRight so it will be deleted when
1718966e2911Sdrh     ** sqlite3ExprListDelete() is called */
1719966e2911Sdrh     pFirst->pRight = pExpr;
1720a1251bc4Sdrh     pExpr = 0;
1721966e2911Sdrh 
1722966e2911Sdrh     /* Remember the size of the LHS in iTable so that we can check that
1723966e2911Sdrh     ** the RHS and LHS sizes match during code generation. */
1724966e2911Sdrh     pFirst->iTable = pColumns->nId;
1725a1251bc4Sdrh   }
1726a1251bc4Sdrh 
1727a1251bc4Sdrh vector_append_error:
17288e34e406Sdrh   sqlite3ExprUnmapAndDelete(pParse, pExpr);
1729a1251bc4Sdrh   sqlite3IdListDelete(db, pColumns);
1730a1251bc4Sdrh   return pList;
1731a1251bc4Sdrh }
1732a1251bc4Sdrh 
1733a1251bc4Sdrh /*
1734bc622bc0Sdrh ** Set the sort order for the last element on the given ExprList.
1735bc622bc0Sdrh */
17366e11892dSdan void sqlite3ExprListSetSortOrder(ExprList *p, int iSortOrder, int eNulls){
17379105fd51Sdan   struct ExprList_item *pItem;
1738bc622bc0Sdrh   if( p==0 ) return;
1739bc622bc0Sdrh   assert( p->nExpr>0 );
17406e11892dSdan 
17416e11892dSdan   assert( SQLITE_SO_UNDEFINED<0 && SQLITE_SO_ASC==0 && SQLITE_SO_DESC>0 );
17426e11892dSdan   assert( iSortOrder==SQLITE_SO_UNDEFINED
17436e11892dSdan        || iSortOrder==SQLITE_SO_ASC
17446e11892dSdan        || iSortOrder==SQLITE_SO_DESC
17456e11892dSdan   );
17466e11892dSdan   assert( eNulls==SQLITE_SO_UNDEFINED
17476e11892dSdan        || eNulls==SQLITE_SO_ASC
17486e11892dSdan        || eNulls==SQLITE_SO_DESC
17496e11892dSdan   );
17506e11892dSdan 
17519105fd51Sdan   pItem = &p->a[p->nExpr-1];
17529105fd51Sdan   assert( pItem->bNulls==0 );
17539105fd51Sdan   if( iSortOrder==SQLITE_SO_UNDEFINED ){
17549105fd51Sdan     iSortOrder = SQLITE_SO_ASC;
1755bc622bc0Sdrh   }
17569105fd51Sdan   pItem->sortFlags = (u8)iSortOrder;
17579105fd51Sdan 
17589105fd51Sdan   if( eNulls!=SQLITE_SO_UNDEFINED ){
17599105fd51Sdan     pItem->bNulls = 1;
17609105fd51Sdan     if( iSortOrder!=eNulls ){
17619105fd51Sdan       pItem->sortFlags |= KEYINFO_ORDER_BIGNULL;
17629105fd51Sdan     }
1763bc622bc0Sdrh   }
1764bc622bc0Sdrh }
1765bc622bc0Sdrh 
1766bc622bc0Sdrh /*
176741cee668Sdrh ** Set the ExprList.a[].zEName element of the most recently added item
1768b7916a78Sdrh ** on the expression list.
1769b7916a78Sdrh **
1770b7916a78Sdrh ** pList might be NULL following an OOM error.  But pName should never be
1771b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1772b7916a78Sdrh ** is set.
1773b7916a78Sdrh */
1774b7916a78Sdrh void sqlite3ExprListSetName(
1775b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1776b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
1777b7916a78Sdrh   Token *pName,           /* Name to be added */
1778b7916a78Sdrh   int dequote             /* True to cause the name to be dequoted */
1779b7916a78Sdrh ){
1780b7916a78Sdrh   assert( pList!=0 || pParse->db->mallocFailed!=0 );
1781b7916a78Sdrh   if( pList ){
1782b7916a78Sdrh     struct ExprList_item *pItem;
1783b7916a78Sdrh     assert( pList->nExpr>0 );
1784b7916a78Sdrh     pItem = &pList->a[pList->nExpr-1];
178541cee668Sdrh     assert( pItem->zEName==0 );
1786c4938ea2Sdrh     assert( pItem->eEName==ENAME_NAME );
178741cee668Sdrh     pItem->zEName = sqlite3DbStrNDup(pParse->db, pName->z, pName->n);
178841cee668Sdrh     if( dequote ) sqlite3Dequote(pItem->zEName);
1789c9461eccSdan     if( IN_RENAME_OBJECT ){
179041cee668Sdrh       sqlite3RenameTokenMap(pParse, (void*)pItem->zEName, pName);
17915be60c55Sdan     }
1792b7916a78Sdrh   }
1793b7916a78Sdrh }
1794b7916a78Sdrh 
1795b7916a78Sdrh /*
1796b7916a78Sdrh ** Set the ExprList.a[].zSpan element of the most recently added item
1797b7916a78Sdrh ** on the expression list.
1798b7916a78Sdrh **
1799b7916a78Sdrh ** pList might be NULL following an OOM error.  But pSpan should never be
1800b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1801b7916a78Sdrh ** is set.
1802b7916a78Sdrh */
1803b7916a78Sdrh void sqlite3ExprListSetSpan(
1804b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1805b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
18061be266baSdrh   const char *zStart,     /* Start of the span */
18071be266baSdrh   const char *zEnd        /* End of the span */
1808b7916a78Sdrh ){
1809b7916a78Sdrh   sqlite3 *db = pParse->db;
1810b7916a78Sdrh   assert( pList!=0 || db->mallocFailed!=0 );
1811b7916a78Sdrh   if( pList ){
1812b7916a78Sdrh     struct ExprList_item *pItem = &pList->a[pList->nExpr-1];
1813b7916a78Sdrh     assert( pList->nExpr>0 );
1814cbb9da33Sdrh     if( pItem->zEName==0 ){
1815cbb9da33Sdrh       pItem->zEName = sqlite3DbSpanDup(db, zStart, zEnd);
1816cbb9da33Sdrh       pItem->eEName = ENAME_SPAN;
1817cbb9da33Sdrh     }
1818b7916a78Sdrh   }
1819b7916a78Sdrh }
1820b7916a78Sdrh 
1821b7916a78Sdrh /*
18227a15a4beSdanielk1977 ** If the expression list pEList contains more than iLimit elements,
18237a15a4beSdanielk1977 ** leave an error message in pParse.
18247a15a4beSdanielk1977 */
18257a15a4beSdanielk1977 void sqlite3ExprListCheckLength(
18267a15a4beSdanielk1977   Parse *pParse,
18277a15a4beSdanielk1977   ExprList *pEList,
18287a15a4beSdanielk1977   const char *zObject
18297a15a4beSdanielk1977 ){
1830b1a6c3c1Sdrh   int mx = pParse->db->aLimit[SQLITE_LIMIT_COLUMN];
1831c5499befSdrh   testcase( pEList && pEList->nExpr==mx );
1832c5499befSdrh   testcase( pEList && pEList->nExpr==mx+1 );
1833b1a6c3c1Sdrh   if( pEList && pEList->nExpr>mx ){
18347a15a4beSdanielk1977     sqlite3ErrorMsg(pParse, "too many columns in %s", zObject);
18357a15a4beSdanielk1977   }
18367a15a4beSdanielk1977 }
18377a15a4beSdanielk1977 
18387a15a4beSdanielk1977 /*
1839a76b5dfcSdrh ** Delete an entire expression list.
1840a76b5dfcSdrh */
1841affa855cSdrh static SQLITE_NOINLINE void exprListDeleteNN(sqlite3 *db, ExprList *pList){
1842ac48b751Sdrh   int i = pList->nExpr;
1843ac48b751Sdrh   struct ExprList_item *pItem =  pList->a;
1844ac48b751Sdrh   assert( pList->nExpr>0 );
1845ac48b751Sdrh   do{
1846633e6d57Sdrh     sqlite3ExprDelete(db, pItem->pExpr);
184741cee668Sdrh     sqlite3DbFree(db, pItem->zEName);
1848ac48b751Sdrh     pItem++;
1849ac48b751Sdrh   }while( --i>0 );
1850dbd6a7dcSdrh   sqlite3DbFreeNN(db, pList);
1851a76b5dfcSdrh }
1852affa855cSdrh void sqlite3ExprListDelete(sqlite3 *db, ExprList *pList){
1853affa855cSdrh   if( pList ) exprListDeleteNN(db, pList);
1854affa855cSdrh }
1855a76b5dfcSdrh 
1856a76b5dfcSdrh /*
18572308ed38Sdrh ** Return the bitwise-OR of all Expr.flags fields in the given
18582308ed38Sdrh ** ExprList.
1859885a5b03Sdrh */
18602308ed38Sdrh u32 sqlite3ExprListFlags(const ExprList *pList){
1861885a5b03Sdrh   int i;
18622308ed38Sdrh   u32 m = 0;
1863508e2d00Sdrh   assert( pList!=0 );
1864885a5b03Sdrh   for(i=0; i<pList->nExpr; i++){
1865d0c73053Sdrh      Expr *pExpr = pList->a[i].pExpr;
1866de845c2fSdrh      assert( pExpr!=0 );
1867de845c2fSdrh      m |= pExpr->flags;
1868885a5b03Sdrh   }
18692308ed38Sdrh   return m;
1870885a5b03Sdrh }
1871885a5b03Sdrh 
1872885a5b03Sdrh /*
18737e6f980bSdrh ** This is a SELECT-node callback for the expression walker that
18747e6f980bSdrh ** always "fails".  By "fail" in this case, we mean set
18757e6f980bSdrh ** pWalker->eCode to zero and abort.
18767e6f980bSdrh **
18777e6f980bSdrh ** This callback is used by multiple expression walkers.
18787e6f980bSdrh */
18797e6f980bSdrh int sqlite3SelectWalkFail(Walker *pWalker, Select *NotUsed){
18807e6f980bSdrh   UNUSED_PARAMETER(NotUsed);
18817e6f980bSdrh   pWalker->eCode = 0;
18827e6f980bSdrh   return WRC_Abort;
18837e6f980bSdrh }
18847e6f980bSdrh 
18857e6f980bSdrh /*
18860cbec59cSdrh ** Check the input string to see if it is "true" or "false" (in any case).
18870cbec59cSdrh **
18880cbec59cSdrh **       If the string is....           Return
18890cbec59cSdrh **         "true"                         EP_IsTrue
18900cbec59cSdrh **         "false"                        EP_IsFalse
18910cbec59cSdrh **         anything else                  0
18920cbec59cSdrh */
18930cbec59cSdrh u32 sqlite3IsTrueOrFalse(const char *zIn){
18940cbec59cSdrh   if( sqlite3StrICmp(zIn, "true")==0  ) return EP_IsTrue;
18950cbec59cSdrh   if( sqlite3StrICmp(zIn, "false")==0 ) return EP_IsFalse;
18960cbec59cSdrh   return 0;
18970cbec59cSdrh }
18980cbec59cSdrh 
18990cbec59cSdrh 
19000cbec59cSdrh /*
1901171d16bbSdrh ** If the input expression is an ID with the name "true" or "false"
190296acafbeSdrh ** then convert it into an TK_TRUEFALSE term.  Return non-zero if
190396acafbeSdrh ** the conversion happened, and zero if the expression is unaltered.
1904171d16bbSdrh */
1905171d16bbSdrh int sqlite3ExprIdToTrueFalse(Expr *pExpr){
19060cbec59cSdrh   u32 v;
1907171d16bbSdrh   assert( pExpr->op==TK_ID || pExpr->op==TK_STRING );
190851d35b0fSdrh   if( !ExprHasProperty(pExpr, EP_Quoted)
19090cbec59cSdrh    && (v = sqlite3IsTrueOrFalse(pExpr->u.zToken))!=0
1910171d16bbSdrh   ){
1911171d16bbSdrh     pExpr->op = TK_TRUEFALSE;
19120cbec59cSdrh     ExprSetProperty(pExpr, v);
1913171d16bbSdrh     return 1;
1914171d16bbSdrh   }
1915171d16bbSdrh   return 0;
1916171d16bbSdrh }
1917171d16bbSdrh 
191843c4ac8bSdrh /*
191996acafbeSdrh ** The argument must be a TK_TRUEFALSE Expr node.  Return 1 if it is TRUE
192043c4ac8bSdrh ** and 0 if it is FALSE.
192143c4ac8bSdrh */
192296acafbeSdrh int sqlite3ExprTruthValue(const Expr *pExpr){
19236ece353fSdan   pExpr = sqlite3ExprSkipCollate((Expr*)pExpr);
192443c4ac8bSdrh   assert( pExpr->op==TK_TRUEFALSE );
192543c4ac8bSdrh   assert( sqlite3StrICmp(pExpr->u.zToken,"true")==0
192643c4ac8bSdrh        || sqlite3StrICmp(pExpr->u.zToken,"false")==0 );
192743c4ac8bSdrh   return pExpr->u.zToken[4]==0;
192843c4ac8bSdrh }
192943c4ac8bSdrh 
193017180fcaSdrh /*
193117180fcaSdrh ** If pExpr is an AND or OR expression, try to simplify it by eliminating
193217180fcaSdrh ** terms that are always true or false.  Return the simplified expression.
193317180fcaSdrh ** Or return the original expression if no simplification is possible.
193417180fcaSdrh **
193517180fcaSdrh ** Examples:
193617180fcaSdrh **
193717180fcaSdrh **     (x<10) AND true                =>   (x<10)
193817180fcaSdrh **     (x<10) AND false               =>   false
193917180fcaSdrh **     (x<10) AND (y=22 OR false)     =>   (x<10) AND (y=22)
194017180fcaSdrh **     (x<10) AND (y=22 OR true)      =>   (x<10)
194117180fcaSdrh **     (y=22) OR true                 =>   true
194217180fcaSdrh */
194317180fcaSdrh Expr *sqlite3ExprSimplifiedAndOr(Expr *pExpr){
194417180fcaSdrh   assert( pExpr!=0 );
194517180fcaSdrh   if( pExpr->op==TK_AND || pExpr->op==TK_OR ){
194617180fcaSdrh     Expr *pRight = sqlite3ExprSimplifiedAndOr(pExpr->pRight);
194717180fcaSdrh     Expr *pLeft = sqlite3ExprSimplifiedAndOr(pExpr->pLeft);
194817180fcaSdrh     if( ExprAlwaysTrue(pLeft) || ExprAlwaysFalse(pRight) ){
194917180fcaSdrh       pExpr = pExpr->op==TK_AND ? pRight : pLeft;
195017180fcaSdrh     }else if( ExprAlwaysTrue(pRight) || ExprAlwaysFalse(pLeft) ){
195117180fcaSdrh       pExpr = pExpr->op==TK_AND ? pLeft : pRight;
195217180fcaSdrh     }
195317180fcaSdrh   }
195417180fcaSdrh   return pExpr;
195517180fcaSdrh }
195617180fcaSdrh 
1957171d16bbSdrh 
1958171d16bbSdrh /*
1959059b2d50Sdrh ** These routines are Walker callbacks used to check expressions to
1960059b2d50Sdrh ** see if they are "constant" for some definition of constant.  The
1961059b2d50Sdrh ** Walker.eCode value determines the type of "constant" we are looking
1962059b2d50Sdrh ** for.
196373b211abSdrh **
19647d10d5a6Sdrh ** These callback routines are used to implement the following:
1965626a879aSdrh **
1966059b2d50Sdrh **     sqlite3ExprIsConstant()                  pWalker->eCode==1
1967059b2d50Sdrh **     sqlite3ExprIsConstantNotJoin()           pWalker->eCode==2
1968fcb9f4f3Sdrh **     sqlite3ExprIsTableConstant()             pWalker->eCode==3
1969059b2d50Sdrh **     sqlite3ExprIsConstantOrFunction()        pWalker->eCode==4 or 5
197087abf5c0Sdrh **
1971059b2d50Sdrh ** In all cases, the callbacks set Walker.eCode=0 and abort if the expression
1972059b2d50Sdrh ** is found to not be a constant.
197387abf5c0Sdrh **
1974feada2dfSdrh ** The sqlite3ExprIsConstantOrFunction() is used for evaluating expressions
1975059b2d50Sdrh ** in a CREATE TABLE statement.  The Walker.eCode value is 5 when parsing
1976059b2d50Sdrh ** an existing schema and 4 when processing a new statement.  A bound
1977feada2dfSdrh ** parameter raises an error for new statements, but is silently converted
1978feada2dfSdrh ** to NULL for existing schemas.  This allows sqlite_master tables that
1979feada2dfSdrh ** contain a bound parameter because they were generated by older versions
1980feada2dfSdrh ** of SQLite to be parsed by newer versions of SQLite without raising a
1981feada2dfSdrh ** malformed schema error.
1982626a879aSdrh */
19837d10d5a6Sdrh static int exprNodeIsConstant(Walker *pWalker, Expr *pExpr){
1984626a879aSdrh 
1985059b2d50Sdrh   /* If pWalker->eCode is 2 then any term of the expression that comes from
1986059b2d50Sdrh   ** the ON or USING clauses of a left join disqualifies the expression
19870a168377Sdrh   ** from being considered constant. */
1988059b2d50Sdrh   if( pWalker->eCode==2 && ExprHasProperty(pExpr, EP_FromJoin) ){
1989059b2d50Sdrh     pWalker->eCode = 0;
19907d10d5a6Sdrh     return WRC_Abort;
19910a168377Sdrh   }
19920a168377Sdrh 
1993626a879aSdrh   switch( pExpr->op ){
1994eb55bd2fSdrh     /* Consider functions to be constant if all their arguments are constant
1995059b2d50Sdrh     ** and either pWalker->eCode==4 or 5 or the function has the
1996059b2d50Sdrh     ** SQLITE_FUNC_CONST flag. */
1997eb55bd2fSdrh     case TK_FUNCTION:
1998a634c9e6Sdrh       if( (pWalker->eCode>=4 || ExprHasProperty(pExpr,EP_ConstFunc))
1999a634c9e6Sdrh        && !ExprHasProperty(pExpr, EP_WinFunc)
2000a634c9e6Sdrh       ){
2001b1fba286Sdrh         return WRC_Continue;
2002059b2d50Sdrh       }else{
2003059b2d50Sdrh         pWalker->eCode = 0;
2004059b2d50Sdrh         return WRC_Abort;
2005b1fba286Sdrh       }
2006626a879aSdrh     case TK_ID:
2007171d16bbSdrh       /* Convert "true" or "false" in a DEFAULT clause into the
2008171d16bbSdrh       ** appropriate TK_TRUEFALSE operator */
2009e39ef31cSdrh       if( sqlite3ExprIdToTrueFalse(pExpr) ){
2010171d16bbSdrh         return WRC_Prune;
2011171d16bbSdrh       }
2012171d16bbSdrh       /* Fall thru */
2013626a879aSdrh     case TK_COLUMN:
2014626a879aSdrh     case TK_AGG_FUNCTION:
201513449892Sdrh     case TK_AGG_COLUMN:
2016c5499befSdrh       testcase( pExpr->op==TK_ID );
2017c5499befSdrh       testcase( pExpr->op==TK_COLUMN );
2018c5499befSdrh       testcase( pExpr->op==TK_AGG_FUNCTION );
2019c5499befSdrh       testcase( pExpr->op==TK_AGG_COLUMN );
202007aded63Sdrh       if( ExprHasProperty(pExpr, EP_FixedCol) && pWalker->eCode!=2 ){
2021efad2e23Sdrh         return WRC_Continue;
2022efad2e23Sdrh       }
2023059b2d50Sdrh       if( pWalker->eCode==3 && pExpr->iTable==pWalker->u.iCur ){
2024059b2d50Sdrh         return WRC_Continue;
2025f43ce0b4Sdrh       }
2026f43ce0b4Sdrh       /* Fall through */
2027f43ce0b4Sdrh     case TK_IF_NULL_ROW:
20286e341b93Sdrh     case TK_REGISTER:
20299916048bSdrh       testcase( pExpr->op==TK_REGISTER );
2030f43ce0b4Sdrh       testcase( pExpr->op==TK_IF_NULL_ROW );
2031059b2d50Sdrh       pWalker->eCode = 0;
20327d10d5a6Sdrh       return WRC_Abort;
2033feada2dfSdrh     case TK_VARIABLE:
2034059b2d50Sdrh       if( pWalker->eCode==5 ){
2035feada2dfSdrh         /* Silently convert bound parameters that appear inside of CREATE
2036feada2dfSdrh         ** statements into a NULL when parsing the CREATE statement text out
2037feada2dfSdrh         ** of the sqlite_master table */
2038feada2dfSdrh         pExpr->op = TK_NULL;
2039059b2d50Sdrh       }else if( pWalker->eCode==4 ){
2040feada2dfSdrh         /* A bound parameter in a CREATE statement that originates from
2041feada2dfSdrh         ** sqlite3_prepare() causes an error */
2042059b2d50Sdrh         pWalker->eCode = 0;
2043feada2dfSdrh         return WRC_Abort;
2044feada2dfSdrh       }
2045feada2dfSdrh       /* Fall through */
2046626a879aSdrh     default:
20476e341b93Sdrh       testcase( pExpr->op==TK_SELECT ); /* sqlite3SelectWalkFail() disallows */
20486e341b93Sdrh       testcase( pExpr->op==TK_EXISTS ); /* sqlite3SelectWalkFail() disallows */
20497d10d5a6Sdrh       return WRC_Continue;
2050626a879aSdrh   }
2051626a879aSdrh }
2052059b2d50Sdrh static int exprIsConst(Expr *p, int initFlag, int iCur){
20537d10d5a6Sdrh   Walker w;
2054059b2d50Sdrh   w.eCode = initFlag;
20557d10d5a6Sdrh   w.xExprCallback = exprNodeIsConstant;
20567e6f980bSdrh   w.xSelectCallback = sqlite3SelectWalkFail;
2057979dd1beSdrh #ifdef SQLITE_DEBUG
2058979dd1beSdrh   w.xSelectCallback2 = sqlite3SelectWalkAssert2;
2059979dd1beSdrh #endif
2060059b2d50Sdrh   w.u.iCur = iCur;
20617d10d5a6Sdrh   sqlite3WalkExpr(&w, p);
2062059b2d50Sdrh   return w.eCode;
20637d10d5a6Sdrh }
2064626a879aSdrh 
2065626a879aSdrh /*
2066059b2d50Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
2067eb55bd2fSdrh ** and 0 if it involves variables or function calls.
20682398937bSdrh **
20692398937bSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
20702398937bSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
20712398937bSdrh ** a constant.
2072fef5208cSdrh */
20734adee20fSdanielk1977 int sqlite3ExprIsConstant(Expr *p){
2074059b2d50Sdrh   return exprIsConst(p, 1, 0);
2075fef5208cSdrh }
2076fef5208cSdrh 
2077fef5208cSdrh /*
207807aded63Sdrh ** Walk an expression tree.  Return non-zero if
207907aded63Sdrh **
208007aded63Sdrh **   (1) the expression is constant, and
208107aded63Sdrh **   (2) the expression does originate in the ON or USING clause
208207aded63Sdrh **       of a LEFT JOIN, and
208307aded63Sdrh **   (3) the expression does not contain any EP_FixedCol TK_COLUMN
208407aded63Sdrh **       operands created by the constant propagation optimization.
208507aded63Sdrh **
208607aded63Sdrh ** When this routine returns true, it indicates that the expression
208707aded63Sdrh ** can be added to the pParse->pConstExpr list and evaluated once when
208807aded63Sdrh ** the prepared statement starts up.  See sqlite3ExprCodeAtInit().
20890a168377Sdrh */
20900a168377Sdrh int sqlite3ExprIsConstantNotJoin(Expr *p){
2091059b2d50Sdrh   return exprIsConst(p, 2, 0);
20920a168377Sdrh }
20930a168377Sdrh 
20940a168377Sdrh /*
2095fcb9f4f3Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
2096059b2d50Sdrh ** for any single row of the table with cursor iCur.  In other words, the
2097059b2d50Sdrh ** expression must not refer to any non-deterministic function nor any
2098059b2d50Sdrh ** table other than iCur.
2099059b2d50Sdrh */
2100059b2d50Sdrh int sqlite3ExprIsTableConstant(Expr *p, int iCur){
2101059b2d50Sdrh   return exprIsConst(p, 3, iCur);
2102059b2d50Sdrh }
2103059b2d50Sdrh 
2104ab31a845Sdan 
2105ab31a845Sdan /*
2106ab31a845Sdan ** sqlite3WalkExpr() callback used by sqlite3ExprIsConstantOrGroupBy().
2107ab31a845Sdan */
2108ab31a845Sdan static int exprNodeIsConstantOrGroupBy(Walker *pWalker, Expr *pExpr){
2109ab31a845Sdan   ExprList *pGroupBy = pWalker->u.pGroupBy;
2110ab31a845Sdan   int i;
2111ab31a845Sdan 
2112ab31a845Sdan   /* Check if pExpr is identical to any GROUP BY term. If so, consider
2113ab31a845Sdan   ** it constant.  */
2114ab31a845Sdan   for(i=0; i<pGroupBy->nExpr; i++){
2115ab31a845Sdan     Expr *p = pGroupBy->a[i].pExpr;
21165aa550cfSdan     if( sqlite3ExprCompare(0, pExpr, p, -1)<2 ){
211770efa84dSdrh       CollSeq *pColl = sqlite3ExprNNCollSeq(pWalker->pParse, p);
2118efad2e23Sdrh       if( sqlite3IsBinary(pColl) ){
2119ab31a845Sdan         return WRC_Prune;
2120ab31a845Sdan       }
2121ab31a845Sdan     }
2122ab31a845Sdan   }
2123ab31a845Sdan 
2124ab31a845Sdan   /* Check if pExpr is a sub-select. If so, consider it variable. */
2125ab31a845Sdan   if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2126ab31a845Sdan     pWalker->eCode = 0;
2127ab31a845Sdan     return WRC_Abort;
2128ab31a845Sdan   }
2129ab31a845Sdan 
2130ab31a845Sdan   return exprNodeIsConstant(pWalker, pExpr);
2131ab31a845Sdan }
2132ab31a845Sdan 
2133ab31a845Sdan /*
2134ab31a845Sdan ** Walk the expression tree passed as the first argument. Return non-zero
2135ab31a845Sdan ** if the expression consists entirely of constants or copies of terms
2136ab31a845Sdan ** in pGroupBy that sort with the BINARY collation sequence.
2137ab314001Sdrh **
2138ab314001Sdrh ** This routine is used to determine if a term of the HAVING clause can
2139ab314001Sdrh ** be promoted into the WHERE clause.  In order for such a promotion to work,
2140ab314001Sdrh ** the value of the HAVING clause term must be the same for all members of
2141ab314001Sdrh ** a "group".  The requirement that the GROUP BY term must be BINARY
2142ab314001Sdrh ** assumes that no other collating sequence will have a finer-grained
2143ab314001Sdrh ** grouping than binary.  In other words (A=B COLLATE binary) implies
2144ab314001Sdrh ** A=B in every other collating sequence.  The requirement that the
2145ab314001Sdrh ** GROUP BY be BINARY is stricter than necessary.  It would also work
2146ab314001Sdrh ** to promote HAVING clauses that use the same alternative collating
2147ab314001Sdrh ** sequence as the GROUP BY term, but that is much harder to check,
2148ab314001Sdrh ** alternative collating sequences are uncommon, and this is only an
2149ab314001Sdrh ** optimization, so we take the easy way out and simply require the
2150ab314001Sdrh ** GROUP BY to use the BINARY collating sequence.
2151ab31a845Sdan */
2152ab31a845Sdan int sqlite3ExprIsConstantOrGroupBy(Parse *pParse, Expr *p, ExprList *pGroupBy){
2153ab31a845Sdan   Walker w;
2154ab31a845Sdan   w.eCode = 1;
2155ab31a845Sdan   w.xExprCallback = exprNodeIsConstantOrGroupBy;
2156979dd1beSdrh   w.xSelectCallback = 0;
2157ab31a845Sdan   w.u.pGroupBy = pGroupBy;
2158ab31a845Sdan   w.pParse = pParse;
2159ab31a845Sdan   sqlite3WalkExpr(&w, p);
2160ab31a845Sdan   return w.eCode;
2161ab31a845Sdan }
2162ab31a845Sdan 
2163059b2d50Sdrh /*
2164059b2d50Sdrh ** Walk an expression tree.  Return non-zero if the expression is constant
2165eb55bd2fSdrh ** or a function call with constant arguments.  Return and 0 if there
2166eb55bd2fSdrh ** are any variables.
2167eb55bd2fSdrh **
2168eb55bd2fSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
2169eb55bd2fSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
2170eb55bd2fSdrh ** a constant.
2171eb55bd2fSdrh */
2172feada2dfSdrh int sqlite3ExprIsConstantOrFunction(Expr *p, u8 isInit){
2173feada2dfSdrh   assert( isInit==0 || isInit==1 );
2174059b2d50Sdrh   return exprIsConst(p, 4+isInit, 0);
2175eb55bd2fSdrh }
2176eb55bd2fSdrh 
21775b88bc4bSdrh #ifdef SQLITE_ENABLE_CURSOR_HINTS
21785b88bc4bSdrh /*
21795b88bc4bSdrh ** Walk an expression tree.  Return 1 if the expression contains a
21805b88bc4bSdrh ** subquery of some kind.  Return 0 if there are no subqueries.
21815b88bc4bSdrh */
21825b88bc4bSdrh int sqlite3ExprContainsSubquery(Expr *p){
21835b88bc4bSdrh   Walker w;
2184bec2476aSdrh   w.eCode = 1;
21855b88bc4bSdrh   w.xExprCallback = sqlite3ExprWalkNoop;
21867e6f980bSdrh   w.xSelectCallback = sqlite3SelectWalkFail;
2187979dd1beSdrh #ifdef SQLITE_DEBUG
2188979dd1beSdrh   w.xSelectCallback2 = sqlite3SelectWalkAssert2;
2189979dd1beSdrh #endif
21905b88bc4bSdrh   sqlite3WalkExpr(&w, p);
219107194bffSdrh   return w.eCode==0;
21925b88bc4bSdrh }
21935b88bc4bSdrh #endif
21945b88bc4bSdrh 
2195eb55bd2fSdrh /*
219673b211abSdrh ** If the expression p codes a constant integer that is small enough
2197202b2df7Sdrh ** to fit in a 32-bit integer, return 1 and put the value of the integer
2198202b2df7Sdrh ** in *pValue.  If the expression is not an integer or if it is too big
2199202b2df7Sdrh ** to fit in a signed 32-bit integer, return 0 and leave *pValue unchanged.
2200e4de1febSdrh */
22014adee20fSdanielk1977 int sqlite3ExprIsInteger(Expr *p, int *pValue){
220292b01d53Sdrh   int rc = 0;
22031d2d71a0Sdrh   if( NEVER(p==0) ) return 0;  /* Used to only happen following on OOM */
2204cd92e84dSdrh 
2205cd92e84dSdrh   /* If an expression is an integer literal that fits in a signed 32-bit
2206cd92e84dSdrh   ** integer, then the EP_IntValue flag will have already been set */
2207cd92e84dSdrh   assert( p->op!=TK_INTEGER || (p->flags & EP_IntValue)!=0
2208cd92e84dSdrh            || sqlite3GetInt32(p->u.zToken, &rc)==0 );
2209cd92e84dSdrh 
221092b01d53Sdrh   if( p->flags & EP_IntValue ){
221133e619fcSdrh     *pValue = p->u.iValue;
2212e4de1febSdrh     return 1;
2213e4de1febSdrh   }
221492b01d53Sdrh   switch( p->op ){
22154b59ab5eSdrh     case TK_UPLUS: {
221692b01d53Sdrh       rc = sqlite3ExprIsInteger(p->pLeft, pValue);
2217f6e369a1Sdrh       break;
22184b59ab5eSdrh     }
2219e4de1febSdrh     case TK_UMINUS: {
2220e4de1febSdrh       int v;
22214adee20fSdanielk1977       if( sqlite3ExprIsInteger(p->pLeft, &v) ){
2222f6418891Smistachkin         assert( v!=(-2147483647-1) );
2223e4de1febSdrh         *pValue = -v;
222492b01d53Sdrh         rc = 1;
2225e4de1febSdrh       }
2226e4de1febSdrh       break;
2227e4de1febSdrh     }
2228e4de1febSdrh     default: break;
2229e4de1febSdrh   }
223092b01d53Sdrh   return rc;
2231e4de1febSdrh }
2232e4de1febSdrh 
2233e4de1febSdrh /*
2234039fc32eSdrh ** Return FALSE if there is no chance that the expression can be NULL.
2235039fc32eSdrh **
2236039fc32eSdrh ** If the expression might be NULL or if the expression is too complex
2237039fc32eSdrh ** to tell return TRUE.
2238039fc32eSdrh **
2239039fc32eSdrh ** This routine is used as an optimization, to skip OP_IsNull opcodes
2240039fc32eSdrh ** when we know that a value cannot be NULL.  Hence, a false positive
2241039fc32eSdrh ** (returning TRUE when in fact the expression can never be NULL) might
2242039fc32eSdrh ** be a small performance hit but is otherwise harmless.  On the other
2243039fc32eSdrh ** hand, a false negative (returning FALSE when the result could be NULL)
2244039fc32eSdrh ** will likely result in an incorrect answer.  So when in doubt, return
2245039fc32eSdrh ** TRUE.
2246039fc32eSdrh */
2247039fc32eSdrh int sqlite3ExprCanBeNull(const Expr *p){
2248039fc32eSdrh   u8 op;
22499bfb0794Sdrh   while( p->op==TK_UPLUS || p->op==TK_UMINUS ){
22509bfb0794Sdrh     p = p->pLeft;
22519bfb0794Sdrh   }
2252039fc32eSdrh   op = p->op;
2253039fc32eSdrh   if( op==TK_REGISTER ) op = p->op2;
2254039fc32eSdrh   switch( op ){
2255039fc32eSdrh     case TK_INTEGER:
2256039fc32eSdrh     case TK_STRING:
2257039fc32eSdrh     case TK_FLOAT:
2258039fc32eSdrh     case TK_BLOB:
2259039fc32eSdrh       return 0;
22607248a8b2Sdrh     case TK_COLUMN:
226172673a24Sdrh       return ExprHasProperty(p, EP_CanBeNull) ||
2262eda079cdSdrh              p->y.pTab==0 ||  /* Reference to column of index on expression */
22634eac5f04Sdrh              (p->iColumn>=0
22644eac5f04Sdrh               && ALWAYS(p->y.pTab->aCol!=0) /* Defense against OOM problems */
22654eac5f04Sdrh               && p->y.pTab->aCol[p->iColumn].notNull==0);
2266039fc32eSdrh     default:
2267039fc32eSdrh       return 1;
2268039fc32eSdrh   }
2269039fc32eSdrh }
2270039fc32eSdrh 
2271039fc32eSdrh /*
2272039fc32eSdrh ** Return TRUE if the given expression is a constant which would be
2273039fc32eSdrh ** unchanged by OP_Affinity with the affinity given in the second
2274039fc32eSdrh ** argument.
2275039fc32eSdrh **
2276039fc32eSdrh ** This routine is used to determine if the OP_Affinity operation
2277039fc32eSdrh ** can be omitted.  When in doubt return FALSE.  A false negative
2278039fc32eSdrh ** is harmless.  A false positive, however, can result in the wrong
2279039fc32eSdrh ** answer.
2280039fc32eSdrh */
2281039fc32eSdrh int sqlite3ExprNeedsNoAffinityChange(const Expr *p, char aff){
2282039fc32eSdrh   u8 op;
2283af866402Sdrh   int unaryMinus = 0;
228405883a34Sdrh   if( aff==SQLITE_AFF_BLOB ) return 1;
2285af866402Sdrh   while( p->op==TK_UPLUS || p->op==TK_UMINUS ){
2286af866402Sdrh     if( p->op==TK_UMINUS ) unaryMinus = 1;
2287af866402Sdrh     p = p->pLeft;
2288af866402Sdrh   }
2289039fc32eSdrh   op = p->op;
2290039fc32eSdrh   if( op==TK_REGISTER ) op = p->op2;
2291039fc32eSdrh   switch( op ){
2292039fc32eSdrh     case TK_INTEGER: {
22936a19865fSdrh       return aff>=SQLITE_AFF_NUMERIC;
2294039fc32eSdrh     }
2295039fc32eSdrh     case TK_FLOAT: {
22966a19865fSdrh       return aff>=SQLITE_AFF_NUMERIC;
2297039fc32eSdrh     }
2298039fc32eSdrh     case TK_STRING: {
2299af866402Sdrh       return !unaryMinus && aff==SQLITE_AFF_TEXT;
2300039fc32eSdrh     }
2301039fc32eSdrh     case TK_BLOB: {
2302af866402Sdrh       return !unaryMinus;
2303039fc32eSdrh     }
23042f2855b6Sdrh     case TK_COLUMN: {
230588376ca7Sdrh       assert( p->iTable>=0 );  /* p cannot be part of a CHECK constraint */
23066a19865fSdrh       return aff>=SQLITE_AFF_NUMERIC && p->iColumn<0;
23072f2855b6Sdrh     }
2308039fc32eSdrh     default: {
2309039fc32eSdrh       return 0;
2310039fc32eSdrh     }
2311039fc32eSdrh   }
2312039fc32eSdrh }
2313039fc32eSdrh 
2314039fc32eSdrh /*
2315c4a3c779Sdrh ** Return TRUE if the given string is a row-id column name.
2316c4a3c779Sdrh */
23174adee20fSdanielk1977 int sqlite3IsRowid(const char *z){
23184adee20fSdanielk1977   if( sqlite3StrICmp(z, "_ROWID_")==0 ) return 1;
23194adee20fSdanielk1977   if( sqlite3StrICmp(z, "ROWID")==0 ) return 1;
23204adee20fSdanielk1977   if( sqlite3StrICmp(z, "OID")==0 ) return 1;
2321c4a3c779Sdrh   return 0;
2322c4a3c779Sdrh }
2323c4a3c779Sdrh 
23249a96b668Sdanielk1977 /*
232569c355bdSdrh ** pX is the RHS of an IN operator.  If pX is a SELECT statement
232669c355bdSdrh ** that can be simplified to a direct table access, then return
232769c355bdSdrh ** a pointer to the SELECT statement.  If pX is not a SELECT statement,
232869c355bdSdrh ** or if the SELECT statement needs to be manifested into a transient
232969c355bdSdrh ** table, then return NULL.
2330b287f4b6Sdrh */
2331b287f4b6Sdrh #ifndef SQLITE_OMIT_SUBQUERY
23327b35a77bSdan static Select *isCandidateForInOpt(Expr *pX){
233369c355bdSdrh   Select *p;
2334b287f4b6Sdrh   SrcList *pSrc;
2335b287f4b6Sdrh   ExprList *pEList;
2336b287f4b6Sdrh   Table *pTab;
2337cfbb5e82Sdan   int i;
233869c355bdSdrh   if( !ExprHasProperty(pX, EP_xIsSelect) ) return 0;  /* Not a subquery */
233969c355bdSdrh   if( ExprHasProperty(pX, EP_VarSelect)  ) return 0;  /* Correlated subq */
234069c355bdSdrh   p = pX->x.pSelect;
2341b287f4b6Sdrh   if( p->pPrior ) return 0;              /* Not a compound SELECT */
23427d10d5a6Sdrh   if( p->selFlags & (SF_Distinct|SF_Aggregate) ){
2343b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
2344b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
23457d10d5a6Sdrh     return 0; /* No DISTINCT keyword and no aggregate functions */
23467d10d5a6Sdrh   }
23472e26a602Sdrh   assert( p->pGroupBy==0 );              /* Has no GROUP BY clause */
2348b287f4b6Sdrh   if( p->pLimit ) return 0;              /* Has no LIMIT clause */
2349b287f4b6Sdrh   if( p->pWhere ) return 0;              /* Has no WHERE clause */
2350b287f4b6Sdrh   pSrc = p->pSrc;
2351d1fa7bcaSdrh   assert( pSrc!=0 );
2352d1fa7bcaSdrh   if( pSrc->nSrc!=1 ) return 0;          /* Single term in FROM clause */
2353b74b1017Sdrh   if( pSrc->a[0].pSelect ) return 0;     /* FROM is not a subquery or view */
2354b287f4b6Sdrh   pTab = pSrc->a[0].pTab;
235569c355bdSdrh   assert( pTab!=0 );
2356b74b1017Sdrh   assert( pTab->pSelect==0 );            /* FROM clause is not a view */
2357b287f4b6Sdrh   if( IsVirtual(pTab) ) return 0;        /* FROM clause not a virtual table */
2358b287f4b6Sdrh   pEList = p->pEList;
2359ac6b47d1Sdrh   assert( pEList!=0 );
23607b35a77bSdan   /* All SELECT results must be columns. */
2361cfbb5e82Sdan   for(i=0; i<pEList->nExpr; i++){
2362cfbb5e82Sdan     Expr *pRes = pEList->a[i].pExpr;
2363cfbb5e82Sdan     if( pRes->op!=TK_COLUMN ) return 0;
236469c355bdSdrh     assert( pRes->iTable==pSrc->a[0].iCursor );  /* Not a correlated subquery */
2365cfbb5e82Sdan   }
236669c355bdSdrh   return p;
2367b287f4b6Sdrh }
2368b287f4b6Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
2369b287f4b6Sdrh 
2370f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
23711d8cb21fSdan /*
23724c259e9fSdrh ** Generate code that checks the left-most column of index table iCur to see if
23734c259e9fSdrh ** it contains any NULL entries.  Cause the register at regHasNull to be set
23746be515ebSdrh ** to a non-NULL value if iCur contains no NULLs.  Cause register regHasNull
23756be515ebSdrh ** to be set to NULL if iCur contains one or more NULL values.
23766be515ebSdrh */
23776be515ebSdrh static void sqlite3SetHasNullFlag(Vdbe *v, int iCur, int regHasNull){
2378728e0f91Sdrh   int addr1;
23796be515ebSdrh   sqlite3VdbeAddOp2(v, OP_Integer, 0, regHasNull);
2380728e0f91Sdrh   addr1 = sqlite3VdbeAddOp1(v, OP_Rewind, iCur); VdbeCoverage(v);
23816be515ebSdrh   sqlite3VdbeAddOp3(v, OP_Column, iCur, 0, regHasNull);
23826be515ebSdrh   sqlite3VdbeChangeP5(v, OPFLAG_TYPEOFARG);
23834c259e9fSdrh   VdbeComment((v, "first_entry_in(%d)", iCur));
2384728e0f91Sdrh   sqlite3VdbeJumpHere(v, addr1);
23856be515ebSdrh }
2386f9b2e05cSdan #endif
23876be515ebSdrh 
2388bb53ecb1Sdrh 
2389bb53ecb1Sdrh #ifndef SQLITE_OMIT_SUBQUERY
2390bb53ecb1Sdrh /*
2391bb53ecb1Sdrh ** The argument is an IN operator with a list (not a subquery) on the
2392bb53ecb1Sdrh ** right-hand side.  Return TRUE if that list is constant.
2393bb53ecb1Sdrh */
2394bb53ecb1Sdrh static int sqlite3InRhsIsConstant(Expr *pIn){
2395bb53ecb1Sdrh   Expr *pLHS;
2396bb53ecb1Sdrh   int res;
2397bb53ecb1Sdrh   assert( !ExprHasProperty(pIn, EP_xIsSelect) );
2398bb53ecb1Sdrh   pLHS = pIn->pLeft;
2399bb53ecb1Sdrh   pIn->pLeft = 0;
2400bb53ecb1Sdrh   res = sqlite3ExprIsConstant(pIn);
2401bb53ecb1Sdrh   pIn->pLeft = pLHS;
2402bb53ecb1Sdrh   return res;
2403bb53ecb1Sdrh }
2404bb53ecb1Sdrh #endif
2405bb53ecb1Sdrh 
24066be515ebSdrh /*
24079a96b668Sdanielk1977 ** This function is used by the implementation of the IN (...) operator.
2408d4305ca6Sdrh ** The pX parameter is the expression on the RHS of the IN operator, which
2409d4305ca6Sdrh ** might be either a list of expressions or a subquery.
24109a96b668Sdanielk1977 **
2411d4305ca6Sdrh ** The job of this routine is to find or create a b-tree object that can
2412d4305ca6Sdrh ** be used either to test for membership in the RHS set or to iterate through
2413d4305ca6Sdrh ** all members of the RHS set, skipping duplicates.
2414d4305ca6Sdrh **
24153a85625dSdrh ** A cursor is opened on the b-tree object that is the RHS of the IN operator
2416d4305ca6Sdrh ** and pX->iTable is set to the index of that cursor.
2417d4305ca6Sdrh **
2418b74b1017Sdrh ** The returned value of this function indicates the b-tree type, as follows:
24199a96b668Sdanielk1977 **
24209a96b668Sdanielk1977 **   IN_INDEX_ROWID      - The cursor was opened on a database table.
24211ccce449Sdrh **   IN_INDEX_INDEX_ASC  - The cursor was opened on an ascending index.
24221ccce449Sdrh **   IN_INDEX_INDEX_DESC - The cursor was opened on a descending index.
24239a96b668Sdanielk1977 **   IN_INDEX_EPH        - The cursor was opened on a specially created and
24249a96b668Sdanielk1977 **                         populated epheremal table.
2425bb53ecb1Sdrh **   IN_INDEX_NOOP       - No cursor was allocated.  The IN operator must be
2426bb53ecb1Sdrh **                         implemented as a sequence of comparisons.
24279a96b668Sdanielk1977 **
2428d4305ca6Sdrh ** An existing b-tree might be used if the RHS expression pX is a simple
2429d4305ca6Sdrh ** subquery such as:
24309a96b668Sdanielk1977 **
2431553168c7Sdan **     SELECT <column1>, <column2>... FROM <table>
24329a96b668Sdanielk1977 **
2433d4305ca6Sdrh ** If the RHS of the IN operator is a list or a more complex subquery, then
2434d4305ca6Sdrh ** an ephemeral table might need to be generated from the RHS and then
243560ec914cSpeter.d.reid ** pX->iTable made to point to the ephemeral table instead of an
2436d4305ca6Sdrh ** existing table.
2437d4305ca6Sdrh **
24387fc0ba0fSdrh ** The inFlags parameter must contain, at a minimum, one of the bits
24397fc0ba0fSdrh ** IN_INDEX_MEMBERSHIP or IN_INDEX_LOOP but not both.  If inFlags contains
24407fc0ba0fSdrh ** IN_INDEX_MEMBERSHIP, then the generated table will be used for a fast
24417fc0ba0fSdrh ** membership test.  When the IN_INDEX_LOOP bit is set, the IN index will
24427fc0ba0fSdrh ** be used to loop over all values of the RHS of the IN operator.
24433a85625dSdrh **
24443a85625dSdrh ** When IN_INDEX_LOOP is used (and the b-tree will be used to iterate
24453a85625dSdrh ** through the set members) then the b-tree must not contain duplicates.
24467fc0ba0fSdrh ** An epheremal table will be created unless the selected columns are guaranteed
2447553168c7Sdan ** to be unique - either because it is an INTEGER PRIMARY KEY or due to
2448553168c7Sdan ** a UNIQUE constraint or index.
24490cdc022eSdanielk1977 **
24503a85625dSdrh ** When IN_INDEX_MEMBERSHIP is used (and the b-tree will be used
24513a85625dSdrh ** for fast set membership tests) then an epheremal table must
2452553168c7Sdan ** be used unless <columns> is a single INTEGER PRIMARY KEY column or an
2453553168c7Sdan ** index can be found with the specified <columns> as its left-most.
24540cdc022eSdanielk1977 **
2455bb53ecb1Sdrh ** If the IN_INDEX_NOOP_OK and IN_INDEX_MEMBERSHIP are both set and
2456bb53ecb1Sdrh ** if the RHS of the IN operator is a list (not a subquery) then this
2457bb53ecb1Sdrh ** routine might decide that creating an ephemeral b-tree for membership
2458bb53ecb1Sdrh ** testing is too expensive and return IN_INDEX_NOOP.  In that case, the
2459bb53ecb1Sdrh ** calling routine should implement the IN operator using a sequence
2460bb53ecb1Sdrh ** of Eq or Ne comparison operations.
2461bb53ecb1Sdrh **
2462b74b1017Sdrh ** When the b-tree is being used for membership tests, the calling function
24633a85625dSdrh ** might need to know whether or not the RHS side of the IN operator
2464e21a6e1dSdrh ** contains a NULL.  If prRhsHasNull is not a NULL pointer and
24653a85625dSdrh ** if there is any chance that the (...) might contain a NULL value at
24660cdc022eSdanielk1977 ** runtime, then a register is allocated and the register number written
2467e21a6e1dSdrh ** to *prRhsHasNull. If there is no chance that the (...) contains a
2468e21a6e1dSdrh ** NULL value, then *prRhsHasNull is left unchanged.
24690cdc022eSdanielk1977 **
2470e21a6e1dSdrh ** If a register is allocated and its location stored in *prRhsHasNull, then
24716be515ebSdrh ** the value in that register will be NULL if the b-tree contains one or more
24726be515ebSdrh ** NULL values, and it will be some non-NULL value if the b-tree contains no
24736be515ebSdrh ** NULL values.
2474553168c7Sdan **
2475553168c7Sdan ** If the aiMap parameter is not NULL, it must point to an array containing
2476553168c7Sdan ** one element for each column returned by the SELECT statement on the RHS
2477553168c7Sdan ** of the IN(...) operator. The i'th entry of the array is populated with the
2478553168c7Sdan ** offset of the index column that matches the i'th column returned by the
2479553168c7Sdan ** SELECT. For example, if the expression and selected index are:
2480553168c7Sdan **
2481553168c7Sdan **   (?,?,?) IN (SELECT a, b, c FROM t1)
2482553168c7Sdan **   CREATE INDEX i1 ON t1(b, c, a);
2483553168c7Sdan **
2484553168c7Sdan ** then aiMap[] is populated with {2, 0, 1}.
24859a96b668Sdanielk1977 */
2486284f4acaSdanielk1977 #ifndef SQLITE_OMIT_SUBQUERY
2487ba00e30aSdan int sqlite3FindInIndex(
24886fc8f364Sdrh   Parse *pParse,             /* Parsing context */
24890167ef20Sdrh   Expr *pX,                  /* The IN expression */
24906fc8f364Sdrh   u32 inFlags,               /* IN_INDEX_LOOP, _MEMBERSHIP, and/or _NOOP_OK */
24916fc8f364Sdrh   int *prRhsHasNull,         /* Register holding NULL status.  See notes */
24922c04131cSdrh   int *aiMap,                /* Mapping from Index fields to RHS fields */
24932c04131cSdrh   int *piTab                 /* OUT: index to use */
2494ba00e30aSdan ){
2495b74b1017Sdrh   Select *p;                            /* SELECT to the right of IN operator */
2496b74b1017Sdrh   int eType = 0;                        /* Type of RHS table. IN_INDEX_* */
2497b74b1017Sdrh   int iTab = pParse->nTab++;            /* Cursor of the RHS table */
24983a85625dSdrh   int mustBeUnique;                     /* True if RHS must be unique */
2499b8475df8Sdrh   Vdbe *v = sqlite3GetVdbe(pParse);     /* Virtual machine being coded */
25009a96b668Sdanielk1977 
25011450bc6eSdrh   assert( pX->op==TK_IN );
25023a85625dSdrh   mustBeUnique = (inFlags & IN_INDEX_LOOP)!=0;
25031450bc6eSdrh 
25047b35a77bSdan   /* If the RHS of this IN(...) operator is a SELECT, and if it matters
25057b35a77bSdan   ** whether or not the SELECT result contains NULL values, check whether
2506870a0705Sdan   ** or not NULL is actually possible (it may not be, for example, due
25077b35a77bSdan   ** to NOT NULL constraints in the schema). If no NULL values are possible,
2508870a0705Sdan   ** set prRhsHasNull to 0 before continuing.  */
25097b35a77bSdan   if( prRhsHasNull && (pX->flags & EP_xIsSelect) ){
25107b35a77bSdan     int i;
25117b35a77bSdan     ExprList *pEList = pX->x.pSelect->pEList;
25127b35a77bSdan     for(i=0; i<pEList->nExpr; i++){
25137b35a77bSdan       if( sqlite3ExprCanBeNull(pEList->a[i].pExpr) ) break;
25147b35a77bSdan     }
25157b35a77bSdan     if( i==pEList->nExpr ){
25167b35a77bSdan       prRhsHasNull = 0;
25177b35a77bSdan     }
25187b35a77bSdan   }
25197b35a77bSdan 
2520b74b1017Sdrh   /* Check to see if an existing table or index can be used to
2521b74b1017Sdrh   ** satisfy the query.  This is preferable to generating a new
25227b35a77bSdan   ** ephemeral table.  */
25237b35a77bSdan   if( pParse->nErr==0 && (p = isCandidateForInOpt(pX))!=0 ){
2524e1fb65a0Sdanielk1977     sqlite3 *db = pParse->db;              /* Database connection */
2525b07028f7Sdrh     Table *pTab;                           /* Table <table>. */
2526ba00e30aSdan     i16 iDb;                               /* Database idx for pTab */
2527cfbb5e82Sdan     ExprList *pEList = p->pEList;
2528cfbb5e82Sdan     int nExpr = pEList->nExpr;
2529e1fb65a0Sdanielk1977 
2530b07028f7Sdrh     assert( p->pEList!=0 );             /* Because of isCandidateForInOpt(p) */
2531b07028f7Sdrh     assert( p->pEList->a[0].pExpr!=0 ); /* Because of isCandidateForInOpt(p) */
2532b07028f7Sdrh     assert( p->pSrc!=0 );               /* Because of isCandidateForInOpt(p) */
2533b07028f7Sdrh     pTab = p->pSrc->a[0].pTab;
2534b07028f7Sdrh 
2535b22f7c83Sdrh     /* Code an OP_Transaction and OP_TableLock for <table>. */
2536e1fb65a0Sdanielk1977     iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
2537e1fb65a0Sdanielk1977     sqlite3CodeVerifySchema(pParse, iDb);
2538e1fb65a0Sdanielk1977     sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
25399a96b668Sdanielk1977 
2540a84a283dSdrh     assert(v);  /* sqlite3GetVdbe() has always been previously called */
2541cfbb5e82Sdan     if( nExpr==1 && pEList->a[0].pExpr->iColumn<0 ){
254262659b2aSdrh       /* The "x IN (SELECT rowid FROM table)" case */
2543511f9e8dSdrh       int iAddr = sqlite3VdbeAddOp0(v, OP_Once);
25447d176105Sdrh       VdbeCoverage(v);
25459a96b668Sdanielk1977 
25469a96b668Sdanielk1977       sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
25479a96b668Sdanielk1977       eType = IN_INDEX_ROWID;
2548d8852095Sdrh       ExplainQueryPlan((pParse, 0,
2549d8852095Sdrh             "USING ROWID SEARCH ON TABLE %s FOR IN-OPERATOR",pTab->zName));
25509a96b668Sdanielk1977       sqlite3VdbeJumpHere(v, iAddr);
25519a96b668Sdanielk1977     }else{
2552e1fb65a0Sdanielk1977       Index *pIdx;                         /* Iterator variable */
2553cfbb5e82Sdan       int affinity_ok = 1;
2554cfbb5e82Sdan       int i;
2555cfbb5e82Sdan 
2556cfbb5e82Sdan       /* Check that the affinity that will be used to perform each
255762659b2aSdrh       ** comparison is the same as the affinity of each column in table
255862659b2aSdrh       ** on the RHS of the IN operator.  If it not, it is not possible to
255962659b2aSdrh       ** use any index of the RHS table.  */
2560cfbb5e82Sdan       for(i=0; i<nExpr && affinity_ok; i++){
2561fc7f27b9Sdrh         Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2562cfbb5e82Sdan         int iCol = pEList->a[i].pExpr->iColumn;
25630dfa4f6fSdrh         char idxaff = sqlite3TableColumnAffinity(pTab,iCol); /* RHS table */
2564cfbb5e82Sdan         char cmpaff = sqlite3CompareAffinity(pLhs, idxaff);
256562659b2aSdrh         testcase( cmpaff==SQLITE_AFF_BLOB );
256662659b2aSdrh         testcase( cmpaff==SQLITE_AFF_TEXT );
2567cfbb5e82Sdan         switch( cmpaff ){
2568cfbb5e82Sdan           case SQLITE_AFF_BLOB:
2569cfbb5e82Sdan             break;
2570cfbb5e82Sdan           case SQLITE_AFF_TEXT:
257162659b2aSdrh             /* sqlite3CompareAffinity() only returns TEXT if one side or the
257262659b2aSdrh             ** other has no affinity and the other side is TEXT.  Hence,
257362659b2aSdrh             ** the only way for cmpaff to be TEXT is for idxaff to be TEXT
257462659b2aSdrh             ** and for the term on the LHS of the IN to have no affinity. */
257562659b2aSdrh             assert( idxaff==SQLITE_AFF_TEXT );
2576cfbb5e82Sdan             break;
2577cfbb5e82Sdan           default:
2578cfbb5e82Sdan             affinity_ok = sqlite3IsNumericAffinity(idxaff);
2579cfbb5e82Sdan         }
2580cfbb5e82Sdan       }
2581e1fb65a0Sdanielk1977 
2582a84a283dSdrh       if( affinity_ok ){
2583a84a283dSdrh         /* Search for an existing index that will work for this IN operator */
2584a84a283dSdrh         for(pIdx=pTab->pIndex; pIdx && eType==0; pIdx=pIdx->pNext){
2585a84a283dSdrh           Bitmask colUsed;      /* Columns of the index used */
2586a84a283dSdrh           Bitmask mCol;         /* Mask for the current column */
25876fc8f364Sdrh           if( pIdx->nColumn<nExpr ) continue;
2588d4a4a361Sdrh           if( pIdx->pPartIdxWhere!=0 ) continue;
2589a84a283dSdrh           /* Maximum nColumn is BMS-2, not BMS-1, so that we can compute
2590a84a283dSdrh           ** BITMASK(nExpr) without overflowing */
2591a84a283dSdrh           testcase( pIdx->nColumn==BMS-2 );
2592a84a283dSdrh           testcase( pIdx->nColumn==BMS-1 );
2593a84a283dSdrh           if( pIdx->nColumn>=BMS-1 ) continue;
25946fc8f364Sdrh           if( mustBeUnique ){
25956fc8f364Sdrh             if( pIdx->nKeyCol>nExpr
25966fc8f364Sdrh              ||(pIdx->nColumn>nExpr && !IsUniqueIndex(pIdx))
25976fc8f364Sdrh             ){
2598a84a283dSdrh               continue;  /* This index is not unique over the IN RHS columns */
2599cfbb5e82Sdan             }
26006fc8f364Sdrh           }
2601cfbb5e82Sdan 
2602a84a283dSdrh           colUsed = 0;   /* Columns of index used so far */
2603cfbb5e82Sdan           for(i=0; i<nExpr; i++){
2604fc7f27b9Sdrh             Expr *pLhs = sqlite3VectorFieldSubexpr(pX->pLeft, i);
2605cfbb5e82Sdan             Expr *pRhs = pEList->a[i].pExpr;
2606cfbb5e82Sdan             CollSeq *pReq = sqlite3BinaryCompareCollSeq(pParse, pLhs, pRhs);
2607cfbb5e82Sdan             int j;
2608cfbb5e82Sdan 
26096fc8f364Sdrh             assert( pReq!=0 || pRhs->iColumn==XN_ROWID || pParse->nErr );
2610cfbb5e82Sdan             for(j=0; j<nExpr; j++){
2611cfbb5e82Sdan               if( pIdx->aiColumn[j]!=pRhs->iColumn ) continue;
2612cfbb5e82Sdan               assert( pIdx->azColl[j] );
2613106526e1Sdrh               if( pReq!=0 && sqlite3StrICmp(pReq->zName, pIdx->azColl[j])!=0 ){
2614106526e1Sdrh                 continue;
2615106526e1Sdrh               }
2616cfbb5e82Sdan               break;
2617cfbb5e82Sdan             }
2618cfbb5e82Sdan             if( j==nExpr ) break;
2619a84a283dSdrh             mCol = MASKBIT(j);
2620a84a283dSdrh             if( mCol & colUsed ) break; /* Each column used only once */
2621a84a283dSdrh             colUsed |= mCol;
2622ba00e30aSdan             if( aiMap ) aiMap[i] = j;
2623cfbb5e82Sdan           }
2624cfbb5e82Sdan 
2625a84a283dSdrh           assert( i==nExpr || colUsed!=(MASKBIT(nExpr)-1) );
2626a84a283dSdrh           if( colUsed==(MASKBIT(nExpr)-1) ){
2627a84a283dSdrh             /* If we reach this point, that means the index pIdx is usable */
2628511f9e8dSdrh             int iAddr = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
2629e2ca99c9Sdrh             ExplainQueryPlan((pParse, 0,
2630e2ca99c9Sdrh                               "USING INDEX %s FOR IN-OPERATOR",pIdx->zName));
26312ec2fb22Sdrh             sqlite3VdbeAddOp3(v, OP_OpenRead, iTab, pIdx->tnum, iDb);
26322ec2fb22Sdrh             sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
2633207872a4Sdanielk1977             VdbeComment((v, "%s", pIdx->zName));
26341ccce449Sdrh             assert( IN_INDEX_INDEX_DESC == IN_INDEX_INDEX_ASC+1 );
26351ccce449Sdrh             eType = IN_INDEX_INDEX_ASC + pIdx->aSortOrder[0];
26369a96b668Sdanielk1977 
26377b35a77bSdan             if( prRhsHasNull ){
26383480bfdaSdan #ifdef SQLITE_ENABLE_COLUMN_USED_MASK
2639cfbb5e82Sdan               i64 mask = (1<<nExpr)-1;
26403480bfdaSdan               sqlite3VdbeAddOp4Dup8(v, OP_ColumnsUsed,
2641cfbb5e82Sdan                   iTab, 0, 0, (u8*)&mask, P4_INT64);
26423480bfdaSdan #endif
2643b80dbdc2Sdrh               *prRhsHasNull = ++pParse->nMem;
26447b35a77bSdan               if( nExpr==1 ){
26456be515ebSdrh                 sqlite3SetHasNullFlag(v, iTab, *prRhsHasNull);
26460cdc022eSdanielk1977               }
26477b35a77bSdan             }
2648552fd454Sdrh             sqlite3VdbeJumpHere(v, iAddr);
26499a96b668Sdanielk1977           }
2650a84a283dSdrh         } /* End loop over indexes */
2651a84a283dSdrh       } /* End if( affinity_ok ) */
2652a84a283dSdrh     } /* End if not an rowid index */
2653a84a283dSdrh   } /* End attempt to optimize using an index */
26549a96b668Sdanielk1977 
2655bb53ecb1Sdrh   /* If no preexisting index is available for the IN clause
2656bb53ecb1Sdrh   ** and IN_INDEX_NOOP is an allowed reply
2657bb53ecb1Sdrh   ** and the RHS of the IN operator is a list, not a subquery
265871c57db0Sdan   ** and the RHS is not constant or has two or fewer terms,
265960ec914cSpeter.d.reid   ** then it is not worth creating an ephemeral table to evaluate
2660bb53ecb1Sdrh   ** the IN operator so return IN_INDEX_NOOP.
2661bb53ecb1Sdrh   */
2662bb53ecb1Sdrh   if( eType==0
2663bb53ecb1Sdrh    && (inFlags & IN_INDEX_NOOP_OK)
2664bb53ecb1Sdrh    && !ExprHasProperty(pX, EP_xIsSelect)
2665bb53ecb1Sdrh    && (!sqlite3InRhsIsConstant(pX) || pX->x.pList->nExpr<=2)
2666bb53ecb1Sdrh   ){
2667bb53ecb1Sdrh     eType = IN_INDEX_NOOP;
2668bb53ecb1Sdrh   }
2669bb53ecb1Sdrh 
26709a96b668Sdanielk1977   if( eType==0 ){
26714387006cSdrh     /* Could not find an existing table or index to use as the RHS b-tree.
2672b74b1017Sdrh     ** We will have to generate an ephemeral table to do the job.
2673b74b1017Sdrh     */
26748e23daf3Sdrh     u32 savedNQueryLoop = pParse->nQueryLoop;
26750cdc022eSdanielk1977     int rMayHaveNull = 0;
267641a05b7bSdanielk1977     eType = IN_INDEX_EPH;
26773a85625dSdrh     if( inFlags & IN_INDEX_LOOP ){
26784a5acf8eSdrh       pParse->nQueryLoop = 0;
2679e21a6e1dSdrh     }else if( prRhsHasNull ){
2680e21a6e1dSdrh       *prRhsHasNull = rMayHaveNull = ++pParse->nMem;
2681cf4d38aaSdrh     }
268285bcdce2Sdrh     assert( pX->op==TK_IN );
268350ef6716Sdrh     sqlite3CodeRhsOfIN(pParse, pX, iTab);
268485bcdce2Sdrh     if( rMayHaveNull ){
26852c04131cSdrh       sqlite3SetHasNullFlag(v, iTab, rMayHaveNull);
268685bcdce2Sdrh     }
2687cf4d38aaSdrh     pParse->nQueryLoop = savedNQueryLoop;
26889a96b668Sdanielk1977   }
2689ba00e30aSdan 
2690ba00e30aSdan   if( aiMap && eType!=IN_INDEX_INDEX_ASC && eType!=IN_INDEX_INDEX_DESC ){
2691ba00e30aSdan     int i, n;
2692ba00e30aSdan     n = sqlite3ExprVectorSize(pX->pLeft);
2693ba00e30aSdan     for(i=0; i<n; i++) aiMap[i] = i;
2694ba00e30aSdan   }
26952c04131cSdrh   *piTab = iTab;
26969a96b668Sdanielk1977   return eType;
26979a96b668Sdanielk1977 }
2698284f4acaSdanielk1977 #endif
2699626a879aSdrh 
2700f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
2701553168c7Sdan /*
2702553168c7Sdan ** Argument pExpr is an (?, ?...) IN(...) expression. This
2703553168c7Sdan ** function allocates and returns a nul-terminated string containing
2704553168c7Sdan ** the affinities to be used for each column of the comparison.
2705553168c7Sdan **
2706553168c7Sdan ** It is the responsibility of the caller to ensure that the returned
2707553168c7Sdan ** string is eventually freed using sqlite3DbFree().
2708553168c7Sdan */
270971c57db0Sdan static char *exprINAffinity(Parse *pParse, Expr *pExpr){
271071c57db0Sdan   Expr *pLeft = pExpr->pLeft;
271171c57db0Sdan   int nVal = sqlite3ExprVectorSize(pLeft);
2712553168c7Sdan   Select *pSelect = (pExpr->flags & EP_xIsSelect) ? pExpr->x.pSelect : 0;
271371c57db0Sdan   char *zRet;
271471c57db0Sdan 
2715553168c7Sdan   assert( pExpr->op==TK_IN );
27165c258dc1Sdrh   zRet = sqlite3DbMallocRaw(pParse->db, nVal+1);
271771c57db0Sdan   if( zRet ){
271871c57db0Sdan     int i;
271971c57db0Sdan     for(i=0; i<nVal; i++){
2720fc7f27b9Sdrh       Expr *pA = sqlite3VectorFieldSubexpr(pLeft, i);
2721553168c7Sdan       char a = sqlite3ExprAffinity(pA);
2722553168c7Sdan       if( pSelect ){
2723553168c7Sdan         zRet[i] = sqlite3CompareAffinity(pSelect->pEList->a[i].pExpr, a);
272471c57db0Sdan       }else{
2725553168c7Sdan         zRet[i] = a;
272671c57db0Sdan       }
272771c57db0Sdan     }
272871c57db0Sdan     zRet[nVal] = '\0';
272971c57db0Sdan   }
273071c57db0Sdan   return zRet;
273171c57db0Sdan }
2732f9b2e05cSdan #endif
273371c57db0Sdan 
27348da209b1Sdan #ifndef SQLITE_OMIT_SUBQUERY
27358da209b1Sdan /*
27368da209b1Sdan ** Load the Parse object passed as the first argument with an error
27378da209b1Sdan ** message of the form:
27388da209b1Sdan **
27398da209b1Sdan **   "sub-select returns N columns - expected M"
27408da209b1Sdan */
27418da209b1Sdan void sqlite3SubselectError(Parse *pParse, int nActual, int nExpect){
2742a9ebfe20Sdrh   if( pParse->nErr==0 ){
27438da209b1Sdan     const char *zFmt = "sub-select returns %d columns - expected %d";
27448da209b1Sdan     sqlite3ErrorMsg(pParse, zFmt, nActual, nExpect);
27458da209b1Sdan   }
2746a9ebfe20Sdrh }
27478da209b1Sdan #endif
27488da209b1Sdan 
2749626a879aSdrh /*
275044c5604cSdan ** Expression pExpr is a vector that has been used in a context where
275144c5604cSdan ** it is not permitted. If pExpr is a sub-select vector, this routine
275244c5604cSdan ** loads the Parse object with a message of the form:
275344c5604cSdan **
275444c5604cSdan **   "sub-select returns N columns - expected 1"
275544c5604cSdan **
275644c5604cSdan ** Or, if it is a regular scalar vector:
275744c5604cSdan **
275844c5604cSdan **   "row value misused"
275944c5604cSdan */
276044c5604cSdan void sqlite3VectorErrorMsg(Parse *pParse, Expr *pExpr){
276144c5604cSdan #ifndef SQLITE_OMIT_SUBQUERY
276244c5604cSdan   if( pExpr->flags & EP_xIsSelect ){
276344c5604cSdan     sqlite3SubselectError(pParse, pExpr->x.pSelect->pEList->nExpr, 1);
276444c5604cSdan   }else
276544c5604cSdan #endif
276644c5604cSdan   {
276744c5604cSdan     sqlite3ErrorMsg(pParse, "row value misused");
276844c5604cSdan   }
276944c5604cSdan }
277044c5604cSdan 
277185bcdce2Sdrh #ifndef SQLITE_OMIT_SUBQUERY
277244c5604cSdan /*
277385bcdce2Sdrh ** Generate code that will construct an ephemeral table containing all terms
277485bcdce2Sdrh ** in the RHS of an IN operator.  The IN operator can be in either of two
277585bcdce2Sdrh ** forms:
2776626a879aSdrh **
27779cbe6352Sdrh **     x IN (4,5,11)              -- IN operator with list on right-hand side
27789cbe6352Sdrh **     x IN (SELECT a FROM b)     -- IN operator with subquery on the right
2779fef5208cSdrh **
27802c04131cSdrh ** The pExpr parameter is the IN operator.  The cursor number for the
27812c04131cSdrh ** constructed ephermeral table is returned.  The first time the ephemeral
27822c04131cSdrh ** table is computed, the cursor number is also stored in pExpr->iTable,
27832c04131cSdrh ** however the cursor number returned might not be the same, as it might
27842c04131cSdrh ** have been duplicated using OP_OpenDup.
278541a05b7bSdanielk1977 **
278685bcdce2Sdrh ** If the LHS expression ("x" in the examples) is a column value, or
278785bcdce2Sdrh ** the SELECT statement returns a column value, then the affinity of that
278885bcdce2Sdrh ** column is used to build the index keys. If both 'x' and the
278985bcdce2Sdrh ** SELECT... statement are columns, then numeric affinity is used
279085bcdce2Sdrh ** if either column has NUMERIC or INTEGER affinity. If neither
279185bcdce2Sdrh ** 'x' nor the SELECT... statement are columns, then numeric affinity
279285bcdce2Sdrh ** is used.
2793cce7d176Sdrh */
279485bcdce2Sdrh void sqlite3CodeRhsOfIN(
2795fd773cf9Sdrh   Parse *pParse,          /* Parsing context */
279685bcdce2Sdrh   Expr *pExpr,            /* The IN operator */
279750ef6716Sdrh   int iTab                /* Use this cursor number */
279841a05b7bSdanielk1977 ){
27992c04131cSdrh   int addrOnce = 0;           /* Address of the OP_Once instruction at top */
280085bcdce2Sdrh   int addr;                   /* Address of OP_OpenEphemeral instruction */
280185bcdce2Sdrh   Expr *pLeft;                /* the LHS of the IN operator */
280285bcdce2Sdrh   KeyInfo *pKeyInfo = 0;      /* Key information */
280385bcdce2Sdrh   int nVal;                   /* Size of vector pLeft */
280485bcdce2Sdrh   Vdbe *v;                    /* The prepared statement under construction */
2805fc976065Sdanielk1977 
28062c04131cSdrh   v = pParse->pVdbe;
280785bcdce2Sdrh   assert( v!=0 );
280885bcdce2Sdrh 
28092c04131cSdrh   /* The evaluation of the IN must be repeated every time it
281039a11819Sdrh   ** is encountered if any of the following is true:
281157dbd7b3Sdrh   **
281257dbd7b3Sdrh   **    *  The right-hand side is a correlated subquery
281357dbd7b3Sdrh   **    *  The right-hand side is an expression list containing variables
281457dbd7b3Sdrh   **    *  We are inside a trigger
281557dbd7b3Sdrh   **
28162c04131cSdrh   ** If all of the above are false, then we can compute the RHS just once
28172c04131cSdrh   ** and reuse it many names.
2818b3bce662Sdanielk1977   */
2819efb699fcSdrh   if( !ExprHasProperty(pExpr, EP_VarSelect) && pParse->iSelfTab==0 ){
28202c04131cSdrh     /* Reuse of the RHS is allowed */
28212c04131cSdrh     /* If this routine has already been coded, but the previous code
28222c04131cSdrh     ** might not have been invoked yet, so invoke it now as a subroutine.
28232c04131cSdrh     */
28242c04131cSdrh     if( ExprHasProperty(pExpr, EP_Subrtn) ){
2825f9231c34Sdrh       addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
2826bd462bccSdrh       if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2827bd462bccSdrh         ExplainQueryPlan((pParse, 0, "REUSE LIST SUBQUERY %d",
2828bd462bccSdrh               pExpr->x.pSelect->selId));
2829bd462bccSdrh       }
28302c04131cSdrh       sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
28312c04131cSdrh                         pExpr->y.sub.iAddr);
28322c04131cSdrh       sqlite3VdbeAddOp2(v, OP_OpenDup, iTab, pExpr->iTable);
2833f9231c34Sdrh       sqlite3VdbeJumpHere(v, addrOnce);
28342c04131cSdrh       return;
28352c04131cSdrh     }
28362c04131cSdrh 
28372c04131cSdrh     /* Begin coding the subroutine */
28382c04131cSdrh     ExprSetProperty(pExpr, EP_Subrtn);
28392c04131cSdrh     pExpr->y.sub.regReturn = ++pParse->nMem;
28402c04131cSdrh     pExpr->y.sub.iAddr =
28412c04131cSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 0, pExpr->y.sub.regReturn) + 1;
28422c04131cSdrh     VdbeComment((v, "return address"));
28432c04131cSdrh 
28442c04131cSdrh     addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
2845b3bce662Sdanielk1977   }
2846b3bce662Sdanielk1977 
284785bcdce2Sdrh   /* Check to see if this is a vector IN operator */
284885bcdce2Sdrh   pLeft = pExpr->pLeft;
284971c57db0Sdan   nVal = sqlite3ExprVectorSize(pLeft);
2850e014a838Sdanielk1977 
285185bcdce2Sdrh   /* Construct the ephemeral table that will contain the content of
285285bcdce2Sdrh   ** RHS of the IN operator.
2853fef5208cSdrh   */
28542c04131cSdrh   pExpr->iTable = iTab;
285550ef6716Sdrh   addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, pExpr->iTable, nVal);
28562c04131cSdrh #ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
28572c04131cSdrh   if( ExprHasProperty(pExpr, EP_xIsSelect) ){
28582c04131cSdrh     VdbeComment((v, "Result of SELECT %u", pExpr->x.pSelect->selId));
28592c04131cSdrh   }else{
28602c04131cSdrh     VdbeComment((v, "RHS of IN operator"));
28612c04131cSdrh   }
28622c04131cSdrh #endif
286350ef6716Sdrh   pKeyInfo = sqlite3KeyInfoAlloc(pParse->db, nVal, 1);
2864e014a838Sdanielk1977 
28656ab3a2ecSdanielk1977   if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2866e014a838Sdanielk1977     /* Case 1:     expr IN (SELECT ...)
2867e014a838Sdanielk1977     **
2868e014a838Sdanielk1977     ** Generate code to write the results of the select into the temporary
2869e014a838Sdanielk1977     ** table allocated and opened above.
2870e014a838Sdanielk1977     */
28714387006cSdrh     Select *pSelect = pExpr->x.pSelect;
287271c57db0Sdan     ExprList *pEList = pSelect->pEList;
28731013c932Sdrh 
28742c04131cSdrh     ExplainQueryPlan((pParse, 1, "%sLIST SUBQUERY %d",
28752c04131cSdrh         addrOnce?"":"CORRELATED ", pSelect->selId
2876e2ca99c9Sdrh     ));
287764bcb8cfSdrh     /* If the LHS and RHS of the IN operator do not match, that
287864bcb8cfSdrh     ** error will have been caught long before we reach this point. */
287964bcb8cfSdrh     if( ALWAYS(pEList->nExpr==nVal) ){
288071c57db0Sdan       SelectDest dest;
288171c57db0Sdan       int i;
2882bd462bccSdrh       sqlite3SelectDestInit(&dest, SRT_Set, iTab);
288371c57db0Sdan       dest.zAffSdst = exprINAffinity(pParse, pExpr);
28844387006cSdrh       pSelect->iLimit = 0;
28854387006cSdrh       testcase( pSelect->selFlags & SF_Distinct );
2886812ea833Sdrh       testcase( pKeyInfo==0 ); /* Caused by OOM in sqlite3KeyInfoAlloc() */
28874387006cSdrh       if( sqlite3Select(pParse, pSelect, &dest) ){
288871c57db0Sdan         sqlite3DbFree(pParse->db, dest.zAffSdst);
28892ec2fb22Sdrh         sqlite3KeyInfoUnref(pKeyInfo);
289085bcdce2Sdrh         return;
289194ccde58Sdrh       }
289271c57db0Sdan       sqlite3DbFree(pParse->db, dest.zAffSdst);
2893812ea833Sdrh       assert( pKeyInfo!=0 ); /* OOM will cause exit after sqlite3Select() */
28943535ec3eSdrh       assert( pEList!=0 );
28953535ec3eSdrh       assert( pEList->nExpr>0 );
28962ec2fb22Sdrh       assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
289771c57db0Sdan       for(i=0; i<nVal; i++){
2898773d3afaSdan         Expr *p = sqlite3VectorFieldSubexpr(pLeft, i);
289971c57db0Sdan         pKeyInfo->aColl[i] = sqlite3BinaryCompareCollSeq(
290071c57db0Sdan             pParse, p, pEList->a[i].pExpr
290171c57db0Sdan         );
290271c57db0Sdan       }
290371c57db0Sdan     }
2904a7d2db17Sdrh   }else if( ALWAYS(pExpr->x.pList!=0) ){
2905fef5208cSdrh     /* Case 2:     expr IN (exprlist)
2906fef5208cSdrh     **
2907e014a838Sdanielk1977     ** For each expression, build an index key from the evaluation and
2908e014a838Sdanielk1977     ** store it in the temporary table. If <expr> is a column, then use
2909e014a838Sdanielk1977     ** that columns affinity when building index keys. If <expr> is not
2910e014a838Sdanielk1977     ** a column, use numeric affinity.
2911fef5208cSdrh     */
291271c57db0Sdan     char affinity;            /* Affinity of the LHS of the IN */
2913e014a838Sdanielk1977     int i;
29146ab3a2ecSdanielk1977     ExprList *pList = pExpr->x.pList;
291557dbd7b3Sdrh     struct ExprList_item *pItem;
2916c324d446Sdan     int r1, r2;
291771c57db0Sdan     affinity = sqlite3ExprAffinity(pLeft);
291896fb16eeSdrh     if( affinity<=SQLITE_AFF_NONE ){
291905883a34Sdrh       affinity = SQLITE_AFF_BLOB;
2920e014a838Sdanielk1977     }
2921323df790Sdrh     if( pKeyInfo ){
29222ec2fb22Sdrh       assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
2923323df790Sdrh       pKeyInfo->aColl[0] = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
2924323df790Sdrh     }
2925e014a838Sdanielk1977 
2926e014a838Sdanielk1977     /* Loop through each expression in <exprlist>. */
29272d401ab8Sdrh     r1 = sqlite3GetTempReg(pParse);
29282d401ab8Sdrh     r2 = sqlite3GetTempReg(pParse);
292957dbd7b3Sdrh     for(i=pList->nExpr, pItem=pList->a; i>0; i--, pItem++){
293057dbd7b3Sdrh       Expr *pE2 = pItem->pExpr;
2931e014a838Sdanielk1977 
293257dbd7b3Sdrh       /* If the expression is not constant then we will need to
293357dbd7b3Sdrh       ** disable the test that was generated above that makes sure
293457dbd7b3Sdrh       ** this code only executes once.  Because for a non-constant
293557dbd7b3Sdrh       ** expression we need to rerun this code each time.
293657dbd7b3Sdrh       */
29372c04131cSdrh       if( addrOnce && !sqlite3ExprIsConstant(pE2) ){
29382c04131cSdrh         sqlite3VdbeChangeToNoop(v, addrOnce);
29397ac0e562Sdan         ExprClearProperty(pExpr, EP_Subrtn);
29402c04131cSdrh         addrOnce = 0;
29414794b980Sdrh       }
2942e014a838Sdanielk1977 
2943e014a838Sdanielk1977       /* Evaluate the expression and insert it into the temp table */
2944c324d446Sdan       sqlite3ExprCode(pParse, pE2, r1);
2945c324d446Sdan       sqlite3VdbeAddOp4(v, OP_MakeRecord, r1, 1, r2, &affinity, 1);
2946c324d446Sdan       sqlite3VdbeAddOp4Int(v, OP_IdxInsert, iTab, r2, r1, 1);
2947fef5208cSdrh     }
29482d401ab8Sdrh     sqlite3ReleaseTempReg(pParse, r1);
29492d401ab8Sdrh     sqlite3ReleaseTempReg(pParse, r2);
2950fef5208cSdrh   }
2951323df790Sdrh   if( pKeyInfo ){
29522ec2fb22Sdrh     sqlite3VdbeChangeP4(v, addr, (void *)pKeyInfo, P4_KEYINFO);
295341a05b7bSdanielk1977   }
29542c04131cSdrh   if( addrOnce ){
29552c04131cSdrh     sqlite3VdbeJumpHere(v, addrOnce);
29562c04131cSdrh     /* Subroutine return */
29572c04131cSdrh     sqlite3VdbeAddOp1(v, OP_Return, pExpr->y.sub.regReturn);
29582c04131cSdrh     sqlite3VdbeChangeP1(v, pExpr->y.sub.iAddr-1, sqlite3VdbeCurrentAddr(v)-1);
29596d2566dfSdrh     sqlite3ClearTempRegCache(pParse);
296085bcdce2Sdrh   }
296185bcdce2Sdrh }
296285bcdce2Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
296385bcdce2Sdrh 
296485bcdce2Sdrh /*
296585bcdce2Sdrh ** Generate code for scalar subqueries used as a subquery expression
296685bcdce2Sdrh ** or EXISTS operator:
296785bcdce2Sdrh **
296885bcdce2Sdrh **     (SELECT a FROM b)          -- subquery
296985bcdce2Sdrh **     EXISTS (SELECT a FROM b)   -- EXISTS subquery
297085bcdce2Sdrh **
297185bcdce2Sdrh ** The pExpr parameter is the SELECT or EXISTS operator to be coded.
297285bcdce2Sdrh **
2973d86fe44aSdrh ** Return the register that holds the result.  For a multi-column SELECT,
297485bcdce2Sdrh ** the result is stored in a contiguous array of registers and the
297585bcdce2Sdrh ** return value is the register of the left-most result column.
297685bcdce2Sdrh ** Return 0 if an error occurs.
297785bcdce2Sdrh */
297885bcdce2Sdrh #ifndef SQLITE_OMIT_SUBQUERY
297985bcdce2Sdrh int sqlite3CodeSubselect(Parse *pParse, Expr *pExpr){
29802c04131cSdrh   int addrOnce = 0;           /* Address of OP_Once at top of subroutine */
298185bcdce2Sdrh   int rReg = 0;               /* Register storing resulting */
298285bcdce2Sdrh   Select *pSel;               /* SELECT statement to encode */
298385bcdce2Sdrh   SelectDest dest;            /* How to deal with SELECT result */
298485bcdce2Sdrh   int nReg;                   /* Registers to allocate */
298585bcdce2Sdrh   Expr *pLimit;               /* New limit expression */
29862c04131cSdrh 
29872c04131cSdrh   Vdbe *v = pParse->pVdbe;
298885bcdce2Sdrh   assert( v!=0 );
2989bd462bccSdrh   testcase( pExpr->op==TK_EXISTS );
2990bd462bccSdrh   testcase( pExpr->op==TK_SELECT );
2991bd462bccSdrh   assert( pExpr->op==TK_EXISTS || pExpr->op==TK_SELECT );
2992bd462bccSdrh   assert( ExprHasProperty(pExpr, EP_xIsSelect) );
2993bd462bccSdrh   pSel = pExpr->x.pSelect;
299485bcdce2Sdrh 
29955198ff57Sdrh   /* The evaluation of the EXISTS/SELECT must be repeated every time it
299685bcdce2Sdrh   ** is encountered if any of the following is true:
299785bcdce2Sdrh   **
299885bcdce2Sdrh   **    *  The right-hand side is a correlated subquery
299985bcdce2Sdrh   **    *  The right-hand side is an expression list containing variables
300085bcdce2Sdrh   **    *  We are inside a trigger
300185bcdce2Sdrh   **
300285bcdce2Sdrh   ** If all of the above are false, then we can run this code just once
300385bcdce2Sdrh   ** save the results, and reuse the same result on subsequent invocations.
300485bcdce2Sdrh   */
300585bcdce2Sdrh   if( !ExprHasProperty(pExpr, EP_VarSelect) ){
30065198ff57Sdrh     /* If this routine has already been coded, then invoke it as a
30075198ff57Sdrh     ** subroutine. */
30085198ff57Sdrh     if( ExprHasProperty(pExpr, EP_Subrtn) ){
3009bd462bccSdrh       ExplainQueryPlan((pParse, 0, "REUSE SUBQUERY %d", pSel->selId));
30105198ff57Sdrh       sqlite3VdbeAddOp2(v, OP_Gosub, pExpr->y.sub.regReturn,
30115198ff57Sdrh                         pExpr->y.sub.iAddr);
30125198ff57Sdrh       return pExpr->iTable;
30135198ff57Sdrh     }
30145198ff57Sdrh 
30155198ff57Sdrh     /* Begin coding the subroutine */
30165198ff57Sdrh     ExprSetProperty(pExpr, EP_Subrtn);
30175198ff57Sdrh     pExpr->y.sub.regReturn = ++pParse->nMem;
30185198ff57Sdrh     pExpr->y.sub.iAddr =
30195198ff57Sdrh       sqlite3VdbeAddOp2(v, OP_Integer, 0, pExpr->y.sub.regReturn) + 1;
30205198ff57Sdrh     VdbeComment((v, "return address"));
30215198ff57Sdrh 
30222c04131cSdrh     addrOnce = sqlite3VdbeAddOp0(v, OP_Once); VdbeCoverage(v);
3023fef5208cSdrh   }
3024fef5208cSdrh 
302585bcdce2Sdrh   /* For a SELECT, generate code to put the values for all columns of
302639a11819Sdrh   ** the first row into an array of registers and return the index of
302739a11819Sdrh   ** the first register.
302839a11819Sdrh   **
302939a11819Sdrh   ** If this is an EXISTS, write an integer 0 (not exists) or 1 (exists)
303039a11819Sdrh   ** into a register and return that register number.
303139a11819Sdrh   **
303239a11819Sdrh   ** In both cases, the query is augmented with "LIMIT 1".  Any
303339a11819Sdrh   ** preexisting limit is discarded in place of the new LIMIT 1.
3034fef5208cSdrh   */
3035bd462bccSdrh   ExplainQueryPlan((pParse, 1, "%sSCALAR SUBQUERY %d",
3036bd462bccSdrh         addrOnce?"":"CORRELATED ", pSel->selId));
303771c57db0Sdan   nReg = pExpr->op==TK_SELECT ? pSel->pEList->nExpr : 1;
303871c57db0Sdan   sqlite3SelectDestInit(&dest, 0, pParse->nMem+1);
303971c57db0Sdan   pParse->nMem += nReg;
304051522cd3Sdrh   if( pExpr->op==TK_SELECT ){
30416c8c8ce0Sdanielk1977     dest.eDest = SRT_Mem;
304253932ce8Sdrh     dest.iSdst = dest.iSDParm;
304371c57db0Sdan     dest.nSdst = nReg;
304471c57db0Sdan     sqlite3VdbeAddOp3(v, OP_Null, 0, dest.iSDParm, dest.iSDParm+nReg-1);
3045d4e70ebdSdrh     VdbeComment((v, "Init subquery result"));
304651522cd3Sdrh   }else{
30476c8c8ce0Sdanielk1977     dest.eDest = SRT_Exists;
30482b596da8Sdrh     sqlite3VdbeAddOp2(v, OP_Integer, 0, dest.iSDParm);
3049d4e70ebdSdrh     VdbeComment((v, "Init EXISTS result"));
305051522cd3Sdrh   }
30518c0833fbSdrh   if( pSel->pLimit ){
30527ca1347fSdrh     /* The subquery already has a limit.  If the pre-existing limit is X
30537ca1347fSdrh     ** then make the new limit X<>0 so that the new limit is either 1 or 0 */
30547ca1347fSdrh     sqlite3 *db = pParse->db;
30555776ee5cSdrh     pLimit = sqlite3Expr(db, TK_INTEGER, "0");
30567ca1347fSdrh     if( pLimit ){
30577ca1347fSdrh       pLimit->affExpr = SQLITE_AFF_NUMERIC;
30587ca1347fSdrh       pLimit = sqlite3PExpr(pParse, TK_NE,
30597ca1347fSdrh                             sqlite3ExprDup(db, pSel->pLimit->pLeft, 0), pLimit);
30607ca1347fSdrh     }
30617ca1347fSdrh     sqlite3ExprDelete(db, pSel->pLimit->pLeft);
30628c0833fbSdrh     pSel->pLimit->pLeft = pLimit;
30638c0833fbSdrh   }else{
30647ca1347fSdrh     /* If there is no pre-existing limit add a limit of 1 */
30655776ee5cSdrh     pLimit = sqlite3Expr(pParse->db, TK_INTEGER, "1");
30668c0833fbSdrh     pSel->pLimit = sqlite3PExpr(pParse, TK_LIMIT, pLimit, 0);
30678c0833fbSdrh   }
306848b5b041Sdrh   pSel->iLimit = 0;
30697d10d5a6Sdrh   if( sqlite3Select(pParse, pSel, &dest) ){
30701450bc6eSdrh     return 0;
307194ccde58Sdrh   }
30722c04131cSdrh   pExpr->iTable = rReg = dest.iSDParm;
3073ebb6a65dSdrh   ExprSetVVAProperty(pExpr, EP_NoReduce);
30742c04131cSdrh   if( addrOnce ){
30752c04131cSdrh     sqlite3VdbeJumpHere(v, addrOnce);
3076fc976065Sdanielk1977 
30772c04131cSdrh     /* Subroutine return */
30782c04131cSdrh     sqlite3VdbeAddOp1(v, OP_Return, pExpr->y.sub.regReturn);
30792c04131cSdrh     sqlite3VdbeChangeP1(v, pExpr->y.sub.iAddr-1, sqlite3VdbeCurrentAddr(v)-1);
30806d2566dfSdrh     sqlite3ClearTempRegCache(pParse);
30815198ff57Sdrh   }
30822c04131cSdrh 
30831450bc6eSdrh   return rReg;
3084cce7d176Sdrh }
308551522cd3Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
3086cce7d176Sdrh 
3087e3365e6cSdrh #ifndef SQLITE_OMIT_SUBQUERY
3088e3365e6cSdrh /*
30897b35a77bSdan ** Expr pIn is an IN(...) expression. This function checks that the
30907b35a77bSdan ** sub-select on the RHS of the IN() operator has the same number of
30917b35a77bSdan ** columns as the vector on the LHS. Or, if the RHS of the IN() is not
30927b35a77bSdan ** a sub-query, that the LHS is a vector of size 1.
30937b35a77bSdan */
30947b35a77bSdan int sqlite3ExprCheckIN(Parse *pParse, Expr *pIn){
30957b35a77bSdan   int nVector = sqlite3ExprVectorSize(pIn->pLeft);
30967b35a77bSdan   if( (pIn->flags & EP_xIsSelect) ){
30977b35a77bSdan     if( nVector!=pIn->x.pSelect->pEList->nExpr ){
30987b35a77bSdan       sqlite3SubselectError(pParse, pIn->x.pSelect->pEList->nExpr, nVector);
30997b35a77bSdan       return 1;
31007b35a77bSdan     }
31017b35a77bSdan   }else if( nVector!=1 ){
310244c5604cSdan     sqlite3VectorErrorMsg(pParse, pIn->pLeft);
31037b35a77bSdan     return 1;
31047b35a77bSdan   }
31057b35a77bSdan   return 0;
31067b35a77bSdan }
31077b35a77bSdan #endif
31087b35a77bSdan 
31097b35a77bSdan #ifndef SQLITE_OMIT_SUBQUERY
31107b35a77bSdan /*
3111e3365e6cSdrh ** Generate code for an IN expression.
3112e3365e6cSdrh **
3113e3365e6cSdrh **      x IN (SELECT ...)
3114e3365e6cSdrh **      x IN (value, value, ...)
3115e3365e6cSdrh **
3116ecb87ac8Sdrh ** The left-hand side (LHS) is a scalar or vector expression.  The
3117e347d3e8Sdrh ** right-hand side (RHS) is an array of zero or more scalar values, or a
3118e347d3e8Sdrh ** subquery.  If the RHS is a subquery, the number of result columns must
3119e347d3e8Sdrh ** match the number of columns in the vector on the LHS.  If the RHS is
3120e347d3e8Sdrh ** a list of values, the LHS must be a scalar.
3121e347d3e8Sdrh **
3122e347d3e8Sdrh ** The IN operator is true if the LHS value is contained within the RHS.
3123e347d3e8Sdrh ** The result is false if the LHS is definitely not in the RHS.  The
3124e347d3e8Sdrh ** result is NULL if the presence of the LHS in the RHS cannot be
3125e347d3e8Sdrh ** determined due to NULLs.
3126e3365e6cSdrh **
31276be515ebSdrh ** This routine generates code that jumps to destIfFalse if the LHS is not
3128e3365e6cSdrh ** contained within the RHS.  If due to NULLs we cannot determine if the LHS
3129e3365e6cSdrh ** is contained in the RHS then jump to destIfNull.  If the LHS is contained
3130e3365e6cSdrh ** within the RHS then fall through.
3131ecb87ac8Sdrh **
3132ecb87ac8Sdrh ** See the separate in-operator.md documentation file in the canonical
3133ecb87ac8Sdrh ** SQLite source tree for additional information.
3134e3365e6cSdrh */
3135e3365e6cSdrh static void sqlite3ExprCodeIN(
3136e3365e6cSdrh   Parse *pParse,        /* Parsing and code generating context */
3137e3365e6cSdrh   Expr *pExpr,          /* The IN expression */
3138e3365e6cSdrh   int destIfFalse,      /* Jump here if LHS is not contained in the RHS */
3139e3365e6cSdrh   int destIfNull        /* Jump here if the results are unknown due to NULLs */
3140e3365e6cSdrh ){
3141e3365e6cSdrh   int rRhsHasNull = 0;  /* Register that is true if RHS contains NULL values */
3142e3365e6cSdrh   int eType;            /* Type of the RHS */
3143e347d3e8Sdrh   int rLhs;             /* Register(s) holding the LHS values */
3144e347d3e8Sdrh   int rLhsOrig;         /* LHS values prior to reordering by aiMap[] */
3145e3365e6cSdrh   Vdbe *v;              /* Statement under construction */
3146ba00e30aSdan   int *aiMap = 0;       /* Map from vector field to index column */
3147ba00e30aSdan   char *zAff = 0;       /* Affinity string for comparisons */
3148ecb87ac8Sdrh   int nVector;          /* Size of vectors for this IN operator */
314912abf408Sdrh   int iDummy;           /* Dummy parameter to exprCodeVector() */
3150e347d3e8Sdrh   Expr *pLeft;          /* The LHS of the IN operator */
3151ecb87ac8Sdrh   int i;                /* loop counter */
3152e347d3e8Sdrh   int destStep2;        /* Where to jump when NULLs seen in step 2 */
3153e347d3e8Sdrh   int destStep6 = 0;    /* Start of code for Step 6 */
3154e347d3e8Sdrh   int addrTruthOp;      /* Address of opcode that determines the IN is true */
3155e347d3e8Sdrh   int destNotNull;      /* Jump here if a comparison is not true in step 6 */
3156e347d3e8Sdrh   int addrTop;          /* Top of the step-6 loop */
31572c04131cSdrh   int iTab = 0;         /* Index to use */
3158e3365e6cSdrh 
3159e347d3e8Sdrh   pLeft = pExpr->pLeft;
31607b35a77bSdan   if( sqlite3ExprCheckIN(pParse, pExpr) ) return;
3161553168c7Sdan   zAff = exprINAffinity(pParse, pExpr);
3162ba00e30aSdan   nVector = sqlite3ExprVectorSize(pExpr->pLeft);
3163ba00e30aSdan   aiMap = (int*)sqlite3DbMallocZero(
3164ba00e30aSdan       pParse->db, nVector*(sizeof(int) + sizeof(char)) + 1
3165ba00e30aSdan   );
3166e347d3e8Sdrh   if( pParse->db->mallocFailed ) goto sqlite3ExprCodeIN_oom_error;
31677b35a77bSdan 
3168ba00e30aSdan   /* Attempt to compute the RHS. After this step, if anything other than
31692c04131cSdrh   ** IN_INDEX_NOOP is returned, the table opened with cursor iTab
3170ba00e30aSdan   ** contains the values that make up the RHS. If IN_INDEX_NOOP is returned,
3171ba00e30aSdan   ** the RHS has not yet been coded.  */
3172e3365e6cSdrh   v = pParse->pVdbe;
3173e3365e6cSdrh   assert( v!=0 );       /* OOM detected prior to this routine */
3174e3365e6cSdrh   VdbeNoopComment((v, "begin IN expr"));
3175bb53ecb1Sdrh   eType = sqlite3FindInIndex(pParse, pExpr,
3176bb53ecb1Sdrh                              IN_INDEX_MEMBERSHIP | IN_INDEX_NOOP_OK,
31772c04131cSdrh                              destIfFalse==destIfNull ? 0 : &rRhsHasNull,
31782c04131cSdrh                              aiMap, &iTab);
3179e3365e6cSdrh 
3180ba00e30aSdan   assert( pParse->nErr || nVector==1 || eType==IN_INDEX_EPH
3181ba00e30aSdan        || eType==IN_INDEX_INDEX_ASC || eType==IN_INDEX_INDEX_DESC
3182ba00e30aSdan   );
3183ecb87ac8Sdrh #ifdef SQLITE_DEBUG
3184ecb87ac8Sdrh   /* Confirm that aiMap[] contains nVector integer values between 0 and
3185ecb87ac8Sdrh   ** nVector-1. */
3186ecb87ac8Sdrh   for(i=0; i<nVector; i++){
3187ecb87ac8Sdrh     int j, cnt;
3188ecb87ac8Sdrh     for(cnt=j=0; j<nVector; j++) if( aiMap[j]==i ) cnt++;
3189ecb87ac8Sdrh     assert( cnt==1 );
3190ecb87ac8Sdrh   }
3191ecb87ac8Sdrh #endif
3192e3365e6cSdrh 
3193ba00e30aSdan   /* Code the LHS, the <expr> from "<expr> IN (...)". If the LHS is a
3194ba00e30aSdan   ** vector, then it is stored in an array of nVector registers starting
3195ba00e30aSdan   ** at r1.
3196e347d3e8Sdrh   **
3197e347d3e8Sdrh   ** sqlite3FindInIndex() might have reordered the fields of the LHS vector
3198e347d3e8Sdrh   ** so that the fields are in the same order as an existing index.   The
3199e347d3e8Sdrh   ** aiMap[] array contains a mapping from the original LHS field order to
3200e347d3e8Sdrh   ** the field order that matches the RHS index.
3201e3365e6cSdrh   */
3202e347d3e8Sdrh   rLhsOrig = exprCodeVector(pParse, pLeft, &iDummy);
3203e347d3e8Sdrh   for(i=0; i<nVector && aiMap[i]==i; i++){} /* Are LHS fields reordered? */
3204ecb87ac8Sdrh   if( i==nVector ){
3205e347d3e8Sdrh     /* LHS fields are not reordered */
3206e347d3e8Sdrh     rLhs = rLhsOrig;
3207ecb87ac8Sdrh   }else{
3208ecb87ac8Sdrh     /* Need to reorder the LHS fields according to aiMap */
3209e347d3e8Sdrh     rLhs = sqlite3GetTempRange(pParse, nVector);
3210ba00e30aSdan     for(i=0; i<nVector; i++){
3211e347d3e8Sdrh       sqlite3VdbeAddOp3(v, OP_Copy, rLhsOrig+i, rLhs+aiMap[i], 0);
3212ba00e30aSdan     }
3213ecb87ac8Sdrh   }
3214e3365e6cSdrh 
3215bb53ecb1Sdrh   /* If sqlite3FindInIndex() did not find or create an index that is
3216bb53ecb1Sdrh   ** suitable for evaluating the IN operator, then evaluate using a
3217bb53ecb1Sdrh   ** sequence of comparisons.
3218e347d3e8Sdrh   **
3219e347d3e8Sdrh   ** This is step (1) in the in-operator.md optimized algorithm.
3220bb53ecb1Sdrh   */
3221bb53ecb1Sdrh   if( eType==IN_INDEX_NOOP ){
3222bb53ecb1Sdrh     ExprList *pList = pExpr->x.pList;
3223bb53ecb1Sdrh     CollSeq *pColl = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
3224ec4ccdbcSdrh     int labelOk = sqlite3VdbeMakeLabel(pParse);
3225bb53ecb1Sdrh     int r2, regToFree;
3226bb53ecb1Sdrh     int regCkNull = 0;
3227bb53ecb1Sdrh     int ii;
3228dd668c26Sdrh     int bLhsReal;  /* True if the LHS of the IN has REAL affinity */
3229bb53ecb1Sdrh     assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
3230bb53ecb1Sdrh     if( destIfNull!=destIfFalse ){
3231bb53ecb1Sdrh       regCkNull = sqlite3GetTempReg(pParse);
3232e347d3e8Sdrh       sqlite3VdbeAddOp3(v, OP_BitAnd, rLhs, rLhs, regCkNull);
3233bb53ecb1Sdrh     }
3234dd668c26Sdrh     bLhsReal = sqlite3ExprAffinity(pExpr->pLeft)==SQLITE_AFF_REAL;
3235bb53ecb1Sdrh     for(ii=0; ii<pList->nExpr; ii++){
3236dd668c26Sdrh       if( bLhsReal ){
32374fc83654Sdrh         r2 = regToFree = sqlite3GetTempReg(pParse);
32384fc83654Sdrh         sqlite3ExprCode(pParse, pList->a[ii].pExpr, r2);
3239dd668c26Sdrh         sqlite3VdbeAddOp4(v, OP_Affinity, r2, 1, 0, "E", P4_STATIC);
32404fc83654Sdrh       }else{
32414fc83654Sdrh         r2 = sqlite3ExprCodeTemp(pParse, pList->a[ii].pExpr, &regToFree);
3242dd668c26Sdrh       }
3243a976979bSdrh       if( regCkNull && sqlite3ExprCanBeNull(pList->a[ii].pExpr) ){
3244bb53ecb1Sdrh         sqlite3VdbeAddOp3(v, OP_BitAnd, regCkNull, r2, regCkNull);
3245bb53ecb1Sdrh       }
3246f6ea97eaSdrh       sqlite3ReleaseTempReg(pParse, regToFree);
3247bb53ecb1Sdrh       if( ii<pList->nExpr-1 || destIfNull!=destIfFalse ){
32484799488eSdrh         int op = rLhs!=r2 ? OP_Eq : OP_NotNull;
32494799488eSdrh         sqlite3VdbeAddOp4(v, op, rLhs, labelOk, r2,
32504336b0e6Sdrh                           (void*)pColl, P4_COLLSEQ);
32514799488eSdrh         VdbeCoverageIf(v, ii<pList->nExpr-1 && op==OP_Eq);
32524799488eSdrh         VdbeCoverageIf(v, ii==pList->nExpr-1 && op==OP_Eq);
32534799488eSdrh         VdbeCoverageIf(v, ii<pList->nExpr-1 && op==OP_NotNull);
32544799488eSdrh         VdbeCoverageIf(v, ii==pList->nExpr-1 && op==OP_NotNull);
3255ba00e30aSdan         sqlite3VdbeChangeP5(v, zAff[0]);
3256bb53ecb1Sdrh       }else{
32574799488eSdrh         int op = rLhs!=r2 ? OP_Ne : OP_IsNull;
3258bb53ecb1Sdrh         assert( destIfNull==destIfFalse );
32594799488eSdrh         sqlite3VdbeAddOp4(v, op, rLhs, destIfFalse, r2,
32604799488eSdrh                           (void*)pColl, P4_COLLSEQ);
32614799488eSdrh         VdbeCoverageIf(v, op==OP_Ne);
32624799488eSdrh         VdbeCoverageIf(v, op==OP_IsNull);
3263ba00e30aSdan         sqlite3VdbeChangeP5(v, zAff[0] | SQLITE_JUMPIFNULL);
3264bb53ecb1Sdrh       }
3265bb53ecb1Sdrh     }
3266bb53ecb1Sdrh     if( regCkNull ){
3267bb53ecb1Sdrh       sqlite3VdbeAddOp2(v, OP_IsNull, regCkNull, destIfNull); VdbeCoverage(v);
3268076e85f5Sdrh       sqlite3VdbeGoto(v, destIfFalse);
3269bb53ecb1Sdrh     }
3270bb53ecb1Sdrh     sqlite3VdbeResolveLabel(v, labelOk);
3271bb53ecb1Sdrh     sqlite3ReleaseTempReg(pParse, regCkNull);
3272e347d3e8Sdrh     goto sqlite3ExprCodeIN_finished;
3273e347d3e8Sdrh   }
3274bb53ecb1Sdrh 
3275e347d3e8Sdrh   /* Step 2: Check to see if the LHS contains any NULL columns.  If the
3276e347d3e8Sdrh   ** LHS does contain NULLs then the result must be either FALSE or NULL.
3277e347d3e8Sdrh   ** We will then skip the binary search of the RHS.
3278e347d3e8Sdrh   */
3279094430ebSdrh   if( destIfNull==destIfFalse ){
3280e347d3e8Sdrh     destStep2 = destIfFalse;
3281e347d3e8Sdrh   }else{
3282ec4ccdbcSdrh     destStep2 = destStep6 = sqlite3VdbeMakeLabel(pParse);
3283e347d3e8Sdrh   }
32844eac5f04Sdrh   if( pParse->nErr ) goto sqlite3ExprCodeIN_finished;
3285d49fd4e8Sdan   for(i=0; i<nVector; i++){
3286fc7f27b9Sdrh     Expr *p = sqlite3VectorFieldSubexpr(pExpr->pLeft, i);
3287d49fd4e8Sdan     if( sqlite3ExprCanBeNull(p) ){
3288e347d3e8Sdrh       sqlite3VdbeAddOp2(v, OP_IsNull, rLhs+i, destStep2);
3289471b4b92Sdrh       VdbeCoverage(v);
3290d49fd4e8Sdan     }
3291d49fd4e8Sdan   }
3292e3365e6cSdrh 
3293e347d3e8Sdrh   /* Step 3.  The LHS is now known to be non-NULL.  Do the binary search
3294e347d3e8Sdrh   ** of the RHS using the LHS as a probe.  If found, the result is
3295e347d3e8Sdrh   ** true.
3296e347d3e8Sdrh   */
3297e3365e6cSdrh   if( eType==IN_INDEX_ROWID ){
3298e347d3e8Sdrh     /* In this case, the RHS is the ROWID of table b-tree and so we also
3299e347d3e8Sdrh     ** know that the RHS is non-NULL.  Hence, we combine steps 3 and 4
3300e347d3e8Sdrh     ** into a single opcode. */
33012c04131cSdrh     sqlite3VdbeAddOp3(v, OP_SeekRowid, iTab, destIfFalse, rLhs);
3302688852abSdrh     VdbeCoverage(v);
3303e347d3e8Sdrh     addrTruthOp = sqlite3VdbeAddOp0(v, OP_Goto);  /* Return True */
33047b35a77bSdan   }else{
3305e347d3e8Sdrh     sqlite3VdbeAddOp4(v, OP_Affinity, rLhs, nVector, 0, zAff, nVector);
3306e347d3e8Sdrh     if( destIfFalse==destIfNull ){
3307e347d3e8Sdrh       /* Combine Step 3 and Step 5 into a single opcode */
33082c04131cSdrh       sqlite3VdbeAddOp4Int(v, OP_NotFound, iTab, destIfFalse,
3309e347d3e8Sdrh                            rLhs, nVector); VdbeCoverage(v);
3310e347d3e8Sdrh       goto sqlite3ExprCodeIN_finished;
3311e347d3e8Sdrh     }
3312e347d3e8Sdrh     /* Ordinary Step 3, for the case where FALSE and NULL are distinct */
33132c04131cSdrh     addrTruthOp = sqlite3VdbeAddOp4Int(v, OP_Found, iTab, 0,
3314e347d3e8Sdrh                                       rLhs, nVector); VdbeCoverage(v);
3315e347d3e8Sdrh   }
3316ba00e30aSdan 
3317e347d3e8Sdrh   /* Step 4.  If the RHS is known to be non-NULL and we did not find
3318e347d3e8Sdrh   ** an match on the search above, then the result must be FALSE.
3319e347d3e8Sdrh   */
3320e347d3e8Sdrh   if( rRhsHasNull && nVector==1 ){
3321e347d3e8Sdrh     sqlite3VdbeAddOp2(v, OP_NotNull, rRhsHasNull, destIfFalse);
3322471b4b92Sdrh     VdbeCoverage(v);
3323e347d3e8Sdrh   }
33247b35a77bSdan 
3325e347d3e8Sdrh   /* Step 5.  If we do not care about the difference between NULL and
3326e347d3e8Sdrh   ** FALSE, then just return false.
3327e347d3e8Sdrh   */
3328e347d3e8Sdrh   if( destIfFalse==destIfNull ) sqlite3VdbeGoto(v, destIfFalse);
3329e347d3e8Sdrh 
3330e347d3e8Sdrh   /* Step 6: Loop through rows of the RHS.  Compare each row to the LHS.
3331e347d3e8Sdrh   ** If any comparison is NULL, then the result is NULL.  If all
3332e347d3e8Sdrh   ** comparisons are FALSE then the final result is FALSE.
3333e347d3e8Sdrh   **
3334e347d3e8Sdrh   ** For a scalar LHS, it is sufficient to check just the first row
3335e347d3e8Sdrh   ** of the RHS.
3336e347d3e8Sdrh   */
3337e347d3e8Sdrh   if( destStep6 ) sqlite3VdbeResolveLabel(v, destStep6);
33382c04131cSdrh   addrTop = sqlite3VdbeAddOp2(v, OP_Rewind, iTab, destIfFalse);
3339471b4b92Sdrh   VdbeCoverage(v);
3340e347d3e8Sdrh   if( nVector>1 ){
3341ec4ccdbcSdrh     destNotNull = sqlite3VdbeMakeLabel(pParse);
3342e347d3e8Sdrh   }else{
3343e347d3e8Sdrh     /* For nVector==1, combine steps 6 and 7 by immediately returning
3344e347d3e8Sdrh     ** FALSE if the first comparison is not NULL */
3345e347d3e8Sdrh     destNotNull = destIfFalse;
3346e347d3e8Sdrh   }
3347ba00e30aSdan   for(i=0; i<nVector; i++){
3348ba00e30aSdan     Expr *p;
3349ba00e30aSdan     CollSeq *pColl;
3350e347d3e8Sdrh     int r3 = sqlite3GetTempReg(pParse);
3351fc7f27b9Sdrh     p = sqlite3VectorFieldSubexpr(pLeft, i);
3352ba00e30aSdan     pColl = sqlite3ExprCollSeq(pParse, p);
33532c04131cSdrh     sqlite3VdbeAddOp3(v, OP_Column, iTab, i, r3);
3354e347d3e8Sdrh     sqlite3VdbeAddOp4(v, OP_Ne, rLhs+i, destNotNull, r3,
335518016ad2Sdrh                       (void*)pColl, P4_COLLSEQ);
3356471b4b92Sdrh     VdbeCoverage(v);
3357e347d3e8Sdrh     sqlite3ReleaseTempReg(pParse, r3);
33587b35a77bSdan   }
33597b35a77bSdan   sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfNull);
3360e347d3e8Sdrh   if( nVector>1 ){
3361e347d3e8Sdrh     sqlite3VdbeResolveLabel(v, destNotNull);
33622c04131cSdrh     sqlite3VdbeAddOp2(v, OP_Next, iTab, addrTop+1);
336318016ad2Sdrh     VdbeCoverage(v);
3364e347d3e8Sdrh 
3365e347d3e8Sdrh     /* Step 7:  If we reach this point, we know that the result must
3366e347d3e8Sdrh     ** be false. */
336718016ad2Sdrh     sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfFalse);
33687b35a77bSdan   }
33697b35a77bSdan 
3370e347d3e8Sdrh   /* Jumps here in order to return true. */
3371e347d3e8Sdrh   sqlite3VdbeJumpHere(v, addrTruthOp);
3372e3365e6cSdrh 
3373e347d3e8Sdrh sqlite3ExprCodeIN_finished:
3374e347d3e8Sdrh   if( rLhs!=rLhsOrig ) sqlite3ReleaseTempReg(pParse, rLhs);
3375ecb87ac8Sdrh   VdbeComment((v, "end IN expr"));
3376e347d3e8Sdrh sqlite3ExprCodeIN_oom_error:
3377ba00e30aSdan   sqlite3DbFree(pParse->db, aiMap);
3378553168c7Sdan   sqlite3DbFree(pParse->db, zAff);
3379e3365e6cSdrh }
3380e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
3381e3365e6cSdrh 
338213573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
3383598f1340Sdrh /*
3384598f1340Sdrh ** Generate an instruction that will put the floating point
33859cbf3425Sdrh ** value described by z[0..n-1] into register iMem.
33860cf19ed8Sdrh **
33870cf19ed8Sdrh ** The z[] string will probably not be zero-terminated.  But the
33880cf19ed8Sdrh ** z[n] character is guaranteed to be something that does not look
33890cf19ed8Sdrh ** like the continuation of the number.
3390598f1340Sdrh */
3391b7916a78Sdrh static void codeReal(Vdbe *v, const char *z, int negateFlag, int iMem){
3392fd773cf9Sdrh   if( ALWAYS(z!=0) ){
3393598f1340Sdrh     double value;
33949339da1fSdrh     sqlite3AtoF(z, &value, sqlite3Strlen30(z), SQLITE_UTF8);
3395d0015161Sdrh     assert( !sqlite3IsNaN(value) ); /* The new AtoF never returns NaN */
3396598f1340Sdrh     if( negateFlag ) value = -value;
339797bae794Sdrh     sqlite3VdbeAddOp4Dup8(v, OP_Real, 0, iMem, 0, (u8*)&value, P4_REAL);
3398598f1340Sdrh   }
3399598f1340Sdrh }
340013573c71Sdrh #endif
3401598f1340Sdrh 
3402598f1340Sdrh 
3403598f1340Sdrh /*
3404fec19aadSdrh ** Generate an instruction that will put the integer describe by
34059cbf3425Sdrh ** text z[0..n-1] into register iMem.
34060cf19ed8Sdrh **
34075f1d6b61Sshaneh ** Expr.u.zToken is always UTF8 and zero-terminated.
3408fec19aadSdrh */
340913573c71Sdrh static void codeInteger(Parse *pParse, Expr *pExpr, int negFlag, int iMem){
341013573c71Sdrh   Vdbe *v = pParse->pVdbe;
341192b01d53Sdrh   if( pExpr->flags & EP_IntValue ){
341233e619fcSdrh     int i = pExpr->u.iValue;
3413d50ffc41Sdrh     assert( i>=0 );
341492b01d53Sdrh     if( negFlag ) i = -i;
341592b01d53Sdrh     sqlite3VdbeAddOp2(v, OP_Integer, i, iMem);
3416fd773cf9Sdrh   }else{
34175f1d6b61Sshaneh     int c;
34185f1d6b61Sshaneh     i64 value;
3419fd773cf9Sdrh     const char *z = pExpr->u.zToken;
3420fd773cf9Sdrh     assert( z!=0 );
34219296c18aSdrh     c = sqlite3DecOrHexToI64(z, &value);
342284d4f1a3Sdrh     if( (c==3 && !negFlag) || (c==2) || (negFlag && value==SMALLEST_INT64)){
342313573c71Sdrh #ifdef SQLITE_OMIT_FLOATING_POINT
342413573c71Sdrh       sqlite3ErrorMsg(pParse, "oversized integer: %s%s", negFlag ? "-" : "", z);
342513573c71Sdrh #else
34261b7ddc59Sdrh #ifndef SQLITE_OMIT_HEX_INTEGER
34279296c18aSdrh       if( sqlite3_strnicmp(z,"0x",2)==0 ){
342877320ea4Sdrh         sqlite3ErrorMsg(pParse, "hex literal too big: %s%s", negFlag?"-":"",z);
34291b7ddc59Sdrh       }else
34301b7ddc59Sdrh #endif
34311b7ddc59Sdrh       {
3432b7916a78Sdrh         codeReal(v, z, negFlag, iMem);
34339296c18aSdrh       }
343413573c71Sdrh #endif
343577320ea4Sdrh     }else{
343684d4f1a3Sdrh       if( negFlag ){ value = c==3 ? SMALLEST_INT64 : -value; }
343777320ea4Sdrh       sqlite3VdbeAddOp4Dup8(v, OP_Int64, 0, iMem, 0, (u8*)&value, P4_INT64);
3438fec19aadSdrh     }
3439fec19aadSdrh   }
3440c9cf901dSdanielk1977 }
3441fec19aadSdrh 
34425cd79239Sdrh 
34431f9ca2c8Sdrh /* Generate code that will load into register regOut a value that is
34441f9ca2c8Sdrh ** appropriate for the iIdxCol-th column of index pIdx.
34451f9ca2c8Sdrh */
34461f9ca2c8Sdrh void sqlite3ExprCodeLoadIndexColumn(
34471f9ca2c8Sdrh   Parse *pParse,  /* The parsing context */
34481f9ca2c8Sdrh   Index *pIdx,    /* The index whose column is to be loaded */
34491f9ca2c8Sdrh   int iTabCur,    /* Cursor pointing to a table row */
34501f9ca2c8Sdrh   int iIdxCol,    /* The column of the index to be loaded */
34511f9ca2c8Sdrh   int regOut      /* Store the index column value in this register */
34521f9ca2c8Sdrh ){
34531f9ca2c8Sdrh   i16 iTabCol = pIdx->aiColumn[iIdxCol];
34544b92f98cSdrh   if( iTabCol==XN_EXPR ){
34551f9ca2c8Sdrh     assert( pIdx->aColExpr );
34561f9ca2c8Sdrh     assert( pIdx->aColExpr->nExpr>iIdxCol );
34573e34eabcSdrh     pParse->iSelfTab = iTabCur + 1;
34581c75c9d7Sdrh     sqlite3ExprCodeCopy(pParse, pIdx->aColExpr->a[iIdxCol].pExpr, regOut);
34593e34eabcSdrh     pParse->iSelfTab = 0;
34604b92f98cSdrh   }else{
34616df9c4b9Sdrh     sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pIdx->pTable, iTabCur,
34624b92f98cSdrh                                     iTabCol, regOut);
34634b92f98cSdrh   }
34641f9ca2c8Sdrh }
34651f9ca2c8Sdrh 
3466e70fa7feSdrh #ifndef SQLITE_OMIT_GENERATED_COLUMNS
3467e70fa7feSdrh /*
3468e70fa7feSdrh ** Generate code that will compute the value of generated column pCol
3469e70fa7feSdrh ** and store the result in register regOut
3470e70fa7feSdrh */
3471e70fa7feSdrh void sqlite3ExprCodeGeneratedColumn(
3472e70fa7feSdrh   Parse *pParse,
3473e70fa7feSdrh   Column *pCol,
3474e70fa7feSdrh   int regOut
3475e70fa7feSdrh ){
34764dad7ed5Sdrh   int iAddr;
34774dad7ed5Sdrh   Vdbe *v = pParse->pVdbe;
34784dad7ed5Sdrh   assert( v!=0 );
34794dad7ed5Sdrh   assert( pParse->iSelfTab!=0 );
34804dad7ed5Sdrh   if( pParse->iSelfTab>0 ){
34814dad7ed5Sdrh     iAddr = sqlite3VdbeAddOp3(v, OP_IfNullRow, pParse->iSelfTab-1, 0, regOut);
34824dad7ed5Sdrh   }else{
34834dad7ed5Sdrh     iAddr = 0;
34844dad7ed5Sdrh   }
3485e70fa7feSdrh   sqlite3ExprCode(pParse, pCol->pDflt, regOut);
3486e70fa7feSdrh   if( pCol->affinity>=SQLITE_AFF_TEXT ){
34874dad7ed5Sdrh     sqlite3VdbeAddOp4(v, OP_Affinity, regOut, 1, 0, &pCol->affinity, 1);
3488e70fa7feSdrh   }
34894dad7ed5Sdrh   if( iAddr ) sqlite3VdbeJumpHere(v, iAddr);
3490e70fa7feSdrh }
3491e70fa7feSdrh #endif /* SQLITE_OMIT_GENERATED_COLUMNS */
3492e70fa7feSdrh 
34935cd79239Sdrh /*
34945c092e8aSdrh ** Generate code to extract the value of the iCol-th column of a table.
34955c092e8aSdrh */
34965c092e8aSdrh void sqlite3ExprCodeGetColumnOfTable(
34976df9c4b9Sdrh   Vdbe *v,        /* Parsing context */
34985c092e8aSdrh   Table *pTab,    /* The table containing the value */
3499313619f5Sdrh   int iTabCur,    /* The table cursor.  Or the PK cursor for WITHOUT ROWID */
35005c092e8aSdrh   int iCol,       /* Index of the column to extract */
3501313619f5Sdrh   int regOut      /* Extract the value into this register */
35025c092e8aSdrh ){
3503ab45fc04Sdrh   Column *pCol;
350481f7b372Sdrh   assert( v!=0 );
3505aca19e19Sdrh   if( pTab==0 ){
3506aca19e19Sdrh     sqlite3VdbeAddOp3(v, OP_Column, iTabCur, iCol, regOut);
3507aca19e19Sdrh     return;
3508aca19e19Sdrh   }
35095c092e8aSdrh   if( iCol<0 || iCol==pTab->iPKey ){
35105c092e8aSdrh     sqlite3VdbeAddOp2(v, OP_Rowid, iTabCur, regOut);
35115c092e8aSdrh   }else{
351281f7b372Sdrh     int op;
351381f7b372Sdrh     int x;
351481f7b372Sdrh     if( IsVirtual(pTab) ){
351581f7b372Sdrh       op = OP_VColumn;
351681f7b372Sdrh       x = iCol;
351781f7b372Sdrh #ifndef SQLITE_OMIT_GENERATED_COLUMNS
3518ab45fc04Sdrh     }else if( (pCol = &pTab->aCol[iCol])->colFlags & COLFLAG_VIRTUAL ){
35196df9c4b9Sdrh       Parse *pParse = sqlite3VdbeParser(v);
3520ab45fc04Sdrh       if( pCol->colFlags & COLFLAG_BUSY ){
3521ab45fc04Sdrh         sqlite3ErrorMsg(pParse, "generated column loop on \"%s\"", pCol->zName);
3522ab45fc04Sdrh       }else{
352381f7b372Sdrh         int savedSelfTab = pParse->iSelfTab;
3524ab45fc04Sdrh         pCol->colFlags |= COLFLAG_BUSY;
352581f7b372Sdrh         pParse->iSelfTab = iTabCur+1;
3526e70fa7feSdrh         sqlite3ExprCodeGeneratedColumn(pParse, pCol, regOut);
352781f7b372Sdrh         pParse->iSelfTab = savedSelfTab;
3528ab45fc04Sdrh         pCol->colFlags &= ~COLFLAG_BUSY;
3529ab45fc04Sdrh       }
353081f7b372Sdrh       return;
353181f7b372Sdrh #endif
353281f7b372Sdrh     }else if( !HasRowid(pTab) ){
3533c5f808d8Sdrh       testcase( iCol!=sqlite3TableColumnToStorage(pTab, iCol) );
3534b9bcf7caSdrh       x = sqlite3TableColumnToIndex(sqlite3PrimaryKeyIndex(pTab), iCol);
353581f7b372Sdrh       op = OP_Column;
353681f7b372Sdrh     }else{
3537b9bcf7caSdrh       x = sqlite3TableColumnToStorage(pTab,iCol);
3538c5f808d8Sdrh       testcase( x!=iCol );
353981f7b372Sdrh       op = OP_Column;
3540ee0ec8e1Sdrh     }
3541ee0ec8e1Sdrh     sqlite3VdbeAddOp3(v, op, iTabCur, x, regOut);
35425c092e8aSdrh     sqlite3ColumnDefault(v, pTab, iCol, regOut);
35435c092e8aSdrh   }
35445c092e8aSdrh }
35455c092e8aSdrh 
35465c092e8aSdrh /*
3547945498f3Sdrh ** Generate code that will extract the iColumn-th column from
35488c607191Sdrh ** table pTab and store the column value in register iReg.
3549e55cbd72Sdrh **
3550e55cbd72Sdrh ** There must be an open cursor to pTab in iTable when this routine
3551e55cbd72Sdrh ** is called.  If iColumn<0 then code is generated that extracts the rowid.
3552945498f3Sdrh */
3553e55cbd72Sdrh int sqlite3ExprCodeGetColumn(
3554e55cbd72Sdrh   Parse *pParse,   /* Parsing and code generating context */
35552133d822Sdrh   Table *pTab,     /* Description of the table we are reading from */
35562133d822Sdrh   int iColumn,     /* Index of the table column */
35572133d822Sdrh   int iTable,      /* The cursor pointing to the table */
3558a748fdccSdrh   int iReg,        /* Store results here */
3559ce78bc6eSdrh   u8 p5            /* P5 value for OP_Column + FLAGS */
35602133d822Sdrh ){
356181f7b372Sdrh   assert( pParse->pVdbe!=0 );
35626df9c4b9Sdrh   sqlite3ExprCodeGetColumnOfTable(pParse->pVdbe, pTab, iTable, iColumn, iReg);
3563a748fdccSdrh   if( p5 ){
356499670abbSdrh     VdbeOp *pOp = sqlite3VdbeGetOp(pParse->pVdbe,-1);
356599670abbSdrh     if( pOp->opcode==OP_Column ) pOp->p5 = p5;
3566a748fdccSdrh   }
3567e55cbd72Sdrh   return iReg;
3568e55cbd72Sdrh }
3569e55cbd72Sdrh 
3570e55cbd72Sdrh /*
3571b21e7c70Sdrh ** Generate code to move content from registers iFrom...iFrom+nReg-1
357236a5d88dSdrh ** over to iTo..iTo+nReg-1.
3573e55cbd72Sdrh */
3574b21e7c70Sdrh void sqlite3ExprCodeMove(Parse *pParse, int iFrom, int iTo, int nReg){
3575079a3072Sdrh   sqlite3VdbeAddOp3(pParse->pVdbe, OP_Move, iFrom, iTo, nReg);
3576945498f3Sdrh }
3577945498f3Sdrh 
3578652fbf55Sdrh /*
357912abf408Sdrh ** Convert a scalar expression node to a TK_REGISTER referencing
358012abf408Sdrh ** register iReg.  The caller must ensure that iReg already contains
358112abf408Sdrh ** the correct value for the expression.
3582a4c3c87eSdrh */
3583069d1b1fSdan static void exprToRegister(Expr *pExpr, int iReg){
35840d950af3Sdrh   Expr *p = sqlite3ExprSkipCollateAndLikely(pExpr);
3585a4c3c87eSdrh   p->op2 = p->op;
3586a4c3c87eSdrh   p->op = TK_REGISTER;
3587a4c3c87eSdrh   p->iTable = iReg;
3588a4c3c87eSdrh   ExprClearProperty(p, EP_Skip);
3589a4c3c87eSdrh }
3590a4c3c87eSdrh 
359112abf408Sdrh /*
359212abf408Sdrh ** Evaluate an expression (either a vector or a scalar expression) and store
359312abf408Sdrh ** the result in continguous temporary registers.  Return the index of
359412abf408Sdrh ** the first register used to store the result.
359512abf408Sdrh **
359612abf408Sdrh ** If the returned result register is a temporary scalar, then also write
359712abf408Sdrh ** that register number into *piFreeable.  If the returned result register
359812abf408Sdrh ** is not a temporary or if the expression is a vector set *piFreeable
359912abf408Sdrh ** to 0.
360012abf408Sdrh */
360112abf408Sdrh static int exprCodeVector(Parse *pParse, Expr *p, int *piFreeable){
360212abf408Sdrh   int iResult;
360312abf408Sdrh   int nResult = sqlite3ExprVectorSize(p);
360412abf408Sdrh   if( nResult==1 ){
360512abf408Sdrh     iResult = sqlite3ExprCodeTemp(pParse, p, piFreeable);
360612abf408Sdrh   }else{
360712abf408Sdrh     *piFreeable = 0;
360812abf408Sdrh     if( p->op==TK_SELECT ){
3609dd1bb43aSdrh #if SQLITE_OMIT_SUBQUERY
3610dd1bb43aSdrh       iResult = 0;
3611dd1bb43aSdrh #else
361285bcdce2Sdrh       iResult = sqlite3CodeSubselect(pParse, p);
3613dd1bb43aSdrh #endif
361412abf408Sdrh     }else{
361512abf408Sdrh       int i;
361612abf408Sdrh       iResult = pParse->nMem+1;
361712abf408Sdrh       pParse->nMem += nResult;
361812abf408Sdrh       for(i=0; i<nResult; i++){
36194b725240Sdan         sqlite3ExprCodeFactorable(pParse, p->x.pList->a[i].pExpr, i+iResult);
362012abf408Sdrh       }
362112abf408Sdrh     }
362212abf408Sdrh   }
362312abf408Sdrh   return iResult;
362412abf408Sdrh }
362512abf408Sdrh 
362625c4296bSdrh /*
362725c4296bSdrh ** Generate code to implement special SQL functions that are implemented
362825c4296bSdrh ** in-line rather than by using the usual callbacks.
362925c4296bSdrh */
363025c4296bSdrh static int exprCodeInlineFunction(
363125c4296bSdrh   Parse *pParse,        /* Parsing context */
363225c4296bSdrh   ExprList *pFarg,      /* List of function arguments */
363325c4296bSdrh   int iFuncId,          /* Function ID.  One of the INTFUNC_... values */
363425c4296bSdrh   int target            /* Store function result in this register */
363525c4296bSdrh ){
363625c4296bSdrh   int nFarg;
363725c4296bSdrh   Vdbe *v = pParse->pVdbe;
363825c4296bSdrh   assert( v!=0 );
363925c4296bSdrh   assert( pFarg!=0 );
364025c4296bSdrh   nFarg = pFarg->nExpr;
364125c4296bSdrh   assert( nFarg>0 );  /* All in-line functions have at least one argument */
364225c4296bSdrh   switch( iFuncId ){
364325c4296bSdrh     case INLINEFUNC_coalesce: {
364425c4296bSdrh       /* Attempt a direct implementation of the built-in COALESCE() and
364525c4296bSdrh       ** IFNULL() functions.  This avoids unnecessary evaluation of
364625c4296bSdrh       ** arguments past the first non-NULL argument.
364725c4296bSdrh       */
364825c4296bSdrh       int endCoalesce = sqlite3VdbeMakeLabel(pParse);
364925c4296bSdrh       int i;
365025c4296bSdrh       assert( nFarg>=2 );
365125c4296bSdrh       sqlite3ExprCode(pParse, pFarg->a[0].pExpr, target);
365225c4296bSdrh       for(i=1; i<nFarg; i++){
365325c4296bSdrh         sqlite3VdbeAddOp2(v, OP_NotNull, target, endCoalesce);
365425c4296bSdrh         VdbeCoverage(v);
365525c4296bSdrh         sqlite3ExprCode(pParse, pFarg->a[i].pExpr, target);
365625c4296bSdrh       }
365790996885Sdrh       if( sqlite3VdbeGetOp(v, -1)->opcode==OP_Copy ){
365890996885Sdrh         sqlite3VdbeChangeP5(v, 1);  /* Tag trailing OP_Copy as not mergable */
365990996885Sdrh       }
366025c4296bSdrh       sqlite3VdbeResolveLabel(v, endCoalesce);
366125c4296bSdrh       break;
366225c4296bSdrh     }
366325c4296bSdrh 
3664171c50ecSdrh     default: {
366525c4296bSdrh       /* The UNLIKELY() function is a no-op.  The result is the value
366625c4296bSdrh       ** of the first argument.
366725c4296bSdrh       */
3668171c50ecSdrh       assert( nFarg==1 || nFarg==2 );
366925c4296bSdrh       target = sqlite3ExprCodeTarget(pParse, pFarg->a[0].pExpr, target);
367025c4296bSdrh       break;
367125c4296bSdrh     }
367225c4296bSdrh 
3673171c50ecSdrh   /***********************************************************************
3674171c50ecSdrh   ** Test-only SQL functions that are only usable if enabled
3675171c50ecSdrh   ** via SQLITE_TESTCTRL_INTERNAL_FUNCTIONS
3676171c50ecSdrh   */
3677171c50ecSdrh     case INLINEFUNC_expr_compare: {
3678171c50ecSdrh       /* Compare two expressions using sqlite3ExprCompare() */
3679171c50ecSdrh       assert( nFarg==2 );
3680171c50ecSdrh       sqlite3VdbeAddOp2(v, OP_Integer,
3681171c50ecSdrh          sqlite3ExprCompare(0,pFarg->a[0].pExpr, pFarg->a[1].pExpr,-1),
3682171c50ecSdrh          target);
3683171c50ecSdrh       break;
3684171c50ecSdrh     }
3685171c50ecSdrh 
3686171c50ecSdrh     case INLINEFUNC_expr_implies_expr: {
3687171c50ecSdrh       /* Compare two expressions using sqlite3ExprImpliesExpr() */
3688171c50ecSdrh       assert( nFarg==2 );
3689171c50ecSdrh       sqlite3VdbeAddOp2(v, OP_Integer,
3690171c50ecSdrh          sqlite3ExprImpliesExpr(pParse,pFarg->a[0].pExpr, pFarg->a[1].pExpr,-1),
3691171c50ecSdrh          target);
3692171c50ecSdrh       break;
3693171c50ecSdrh     }
3694171c50ecSdrh 
3695171c50ecSdrh     case INLINEFUNC_implies_nonnull_row: {
3696171c50ecSdrh       /* REsult of sqlite3ExprImpliesNonNullRow() */
3697171c50ecSdrh       Expr *pA1;
3698171c50ecSdrh       assert( nFarg==2 );
3699171c50ecSdrh       pA1 = pFarg->a[1].pExpr;
3700171c50ecSdrh       if( pA1->op==TK_COLUMN ){
3701171c50ecSdrh         sqlite3VdbeAddOp2(v, OP_Integer,
3702171c50ecSdrh            sqlite3ExprImpliesNonNullRow(pFarg->a[0].pExpr,pA1->iTable),
3703171c50ecSdrh            target);
3704171c50ecSdrh       }else{
3705171c50ecSdrh         sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3706171c50ecSdrh       }
3707171c50ecSdrh       break;
3708171c50ecSdrh     }
3709171c50ecSdrh 
371025c4296bSdrh #ifdef SQLITE_DEBUG
371125c4296bSdrh     case INLINEFUNC_affinity: {
371225c4296bSdrh       /* The AFFINITY() function evaluates to a string that describes
371325c4296bSdrh       ** the type affinity of the argument.  This is used for testing of
371425c4296bSdrh       ** the SQLite type logic.
371525c4296bSdrh       */
371625c4296bSdrh       const char *azAff[] = { "blob", "text", "numeric", "integer", "real" };
371725c4296bSdrh       char aff;
371825c4296bSdrh       assert( nFarg==1 );
371925c4296bSdrh       aff = sqlite3ExprAffinity(pFarg->a[0].pExpr);
372025c4296bSdrh       sqlite3VdbeLoadString(v, target,
372125c4296bSdrh               (aff<=SQLITE_AFF_NONE) ? "none" : azAff[aff-SQLITE_AFF_BLOB]);
372225c4296bSdrh       break;
372325c4296bSdrh     }
372425c4296bSdrh #endif
372525c4296bSdrh   }
372625c4296bSdrh   return target;
372725c4296bSdrh }
372825c4296bSdrh 
372971c57db0Sdan 
3730a4c3c87eSdrh /*
3731cce7d176Sdrh ** Generate code into the current Vdbe to evaluate the given
37322dcef11bSdrh ** expression.  Attempt to store the results in register "target".
37332dcef11bSdrh ** Return the register where results are stored.
3734389a1adbSdrh **
37358b213899Sdrh ** With this routine, there is no guarantee that results will
37362dcef11bSdrh ** be stored in target.  The result might be stored in some other
37372dcef11bSdrh ** register if it is convenient to do so.  The calling function
37382dcef11bSdrh ** must check the return code and move the results to the desired
37392dcef11bSdrh ** register.
3740cce7d176Sdrh */
3741678ccce8Sdrh int sqlite3ExprCodeTarget(Parse *pParse, Expr *pExpr, int target){
37422dcef11bSdrh   Vdbe *v = pParse->pVdbe;  /* The VM under construction */
37432dcef11bSdrh   int op;                   /* The opcode being coded */
37442dcef11bSdrh   int inReg = target;       /* Results stored in register inReg */
37452dcef11bSdrh   int regFree1 = 0;         /* If non-zero free this temporary register */
37462dcef11bSdrh   int regFree2 = 0;         /* If non-zero free this temporary register */
37477b35a77bSdan   int r1, r2;               /* Various register numbers */
374810d1edf0Sdrh   Expr tempX;               /* Temporary expression node */
374971c57db0Sdan   int p5 = 0;
3750ffe07b2dSdrh 
37519cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
375220411ea7Sdrh   if( v==0 ){
375320411ea7Sdrh     assert( pParse->db->mallocFailed );
375420411ea7Sdrh     return 0;
375520411ea7Sdrh   }
3756389a1adbSdrh 
37571efa8023Sdrh expr_code_doover:
3758389a1adbSdrh   if( pExpr==0 ){
3759389a1adbSdrh     op = TK_NULL;
3760389a1adbSdrh   }else{
3761f2bc013cSdrh     op = pExpr->op;
3762389a1adbSdrh   }
3763f2bc013cSdrh   switch( op ){
376413449892Sdrh     case TK_AGG_COLUMN: {
376513449892Sdrh       AggInfo *pAggInfo = pExpr->pAggInfo;
376613449892Sdrh       struct AggInfo_col *pCol = &pAggInfo->aCol[pExpr->iAgg];
376713449892Sdrh       if( !pAggInfo->directMode ){
37689de221dfSdrh         assert( pCol->iMem>0 );
3769c332cc30Sdrh         return pCol->iMem;
377013449892Sdrh       }else if( pAggInfo->useSortingIdx ){
37715134d135Sdan         sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdxPTab,
3772389a1adbSdrh                               pCol->iSorterColumn, target);
3773c332cc30Sdrh         return target;
377413449892Sdrh       }
377513449892Sdrh       /* Otherwise, fall thru into the TK_COLUMN case */
377613449892Sdrh     }
3777967e8b73Sdrh     case TK_COLUMN: {
3778b2b9d3d7Sdrh       int iTab = pExpr->iTable;
377967b9ba17Sdrh       int iReg;
3780efad2e23Sdrh       if( ExprHasProperty(pExpr, EP_FixedCol) ){
3781d98f5324Sdrh         /* This COLUMN expression is really a constant due to WHERE clause
3782d98f5324Sdrh         ** constraints, and that constant is coded by the pExpr->pLeft
3783d98f5324Sdrh         ** expresssion.  However, make sure the constant has the correct
3784d98f5324Sdrh         ** datatype by applying the Affinity of the table column to the
3785d98f5324Sdrh         ** constant.
3786d98f5324Sdrh         */
378757f7ece7Sdrh         int aff;
378867b9ba17Sdrh         iReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft,target);
378957f7ece7Sdrh         if( pExpr->y.pTab ){
379057f7ece7Sdrh           aff = sqlite3TableColumnAffinity(pExpr->y.pTab, pExpr->iColumn);
379157f7ece7Sdrh         }else{
379257f7ece7Sdrh           aff = pExpr->affExpr;
379357f7ece7Sdrh         }
379496fb16eeSdrh         if( aff>SQLITE_AFF_BLOB ){
3795d98f5324Sdrh           static const char zAff[] = "B\000C\000D\000E";
3796d98f5324Sdrh           assert( SQLITE_AFF_BLOB=='A' );
3797d98f5324Sdrh           assert( SQLITE_AFF_TEXT=='B' );
3798d98f5324Sdrh           if( iReg!=target ){
3799d98f5324Sdrh             sqlite3VdbeAddOp2(v, OP_SCopy, iReg, target);
3800d98f5324Sdrh             iReg = target;
3801d98f5324Sdrh           }
3802d98f5324Sdrh           sqlite3VdbeAddOp4(v, OP_Affinity, iReg, 1, 0,
3803d98f5324Sdrh                             &zAff[(aff-'B')*2], P4_STATIC);
3804d98f5324Sdrh         }
3805d98f5324Sdrh         return iReg;
3806efad2e23Sdrh       }
3807b2b9d3d7Sdrh       if( iTab<0 ){
38086e97f8ecSdrh         if( pParse->iSelfTab<0 ){
38099942ef0dSdrh           /* Other columns in the same row for CHECK constraints or
38109942ef0dSdrh           ** generated columns or for inserting into partial index.
38119942ef0dSdrh           ** The row is unpacked into registers beginning at
38129942ef0dSdrh           ** 0-(pParse->iSelfTab).  The rowid (if any) is in a register
38139942ef0dSdrh           ** immediately prior to the first column.
38149942ef0dSdrh           */
38159942ef0dSdrh           Column *pCol;
38169942ef0dSdrh           Table *pTab = pExpr->y.pTab;
38179942ef0dSdrh           int iSrc;
3818c5f808d8Sdrh           int iCol = pExpr->iColumn;
38199942ef0dSdrh           assert( pTab!=0 );
3820c5f808d8Sdrh           assert( iCol>=XN_ROWID );
3821b0cbcd0eSdrh           assert( iCol<pTab->nCol );
3822c5f808d8Sdrh           if( iCol<0 ){
38239942ef0dSdrh             return -1-pParse->iSelfTab;
38249942ef0dSdrh           }
3825c5f808d8Sdrh           pCol = pTab->aCol + iCol;
3826c5f808d8Sdrh           testcase( iCol!=sqlite3TableColumnToStorage(pTab,iCol) );
3827c5f808d8Sdrh           iSrc = sqlite3TableColumnToStorage(pTab, iCol) - pParse->iSelfTab;
38289942ef0dSdrh #ifndef SQLITE_OMIT_GENERATED_COLUMNS
38299942ef0dSdrh           if( pCol->colFlags & COLFLAG_GENERATED ){
38304e8e533bSdrh             if( pCol->colFlags & COLFLAG_BUSY ){
38314e8e533bSdrh               sqlite3ErrorMsg(pParse, "generated column loop on \"%s\"",
38324e8e533bSdrh                               pCol->zName);
38334e8e533bSdrh               return 0;
38344e8e533bSdrh             }
38354e8e533bSdrh             pCol->colFlags |= COLFLAG_BUSY;
38364e8e533bSdrh             if( pCol->colFlags & COLFLAG_NOTAVAIL ){
3837e70fa7feSdrh               sqlite3ExprCodeGeneratedColumn(pParse, pCol, iSrc);
38384e8e533bSdrh             }
38394e8e533bSdrh             pCol->colFlags &= ~(COLFLAG_BUSY|COLFLAG_NOTAVAIL);
3840dd6cc9b5Sdrh             return iSrc;
38419942ef0dSdrh           }else
38429942ef0dSdrh #endif /* SQLITE_OMIT_GENERATED_COLUMNS */
38439942ef0dSdrh           if( pCol->affinity==SQLITE_AFF_REAL ){
38449942ef0dSdrh             sqlite3VdbeAddOp2(v, OP_SCopy, iSrc, target);
3845bffdd636Sdrh             sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
3846bffdd636Sdrh             return target;
3847bffdd636Sdrh           }else{
38489942ef0dSdrh             return iSrc;
3849bffdd636Sdrh           }
3850c4a3c779Sdrh         }else{
38511f9ca2c8Sdrh           /* Coding an expression that is part of an index where column names
38521f9ca2c8Sdrh           ** in the index refer to the table to which the index belongs */
38533e34eabcSdrh           iTab = pParse->iSelfTab - 1;
38542282792aSdrh         }
3855b2b9d3d7Sdrh       }
385667b9ba17Sdrh       iReg = sqlite3ExprCodeGetColumn(pParse, pExpr->y.pTab,
3857b2b9d3d7Sdrh                                pExpr->iColumn, iTab, target,
3858b2b9d3d7Sdrh                                pExpr->op2);
385967b9ba17Sdrh       if( pExpr->y.pTab==0 && pExpr->affExpr==SQLITE_AFF_REAL ){
386067b9ba17Sdrh         sqlite3VdbeAddOp1(v, OP_RealAffinity, iReg);
386167b9ba17Sdrh       }
386267b9ba17Sdrh       return iReg;
3863cce7d176Sdrh     }
3864cce7d176Sdrh     case TK_INTEGER: {
386513573c71Sdrh       codeInteger(pParse, pExpr, 0, target);
3866c332cc30Sdrh       return target;
386751e9a445Sdrh     }
38688abed7b9Sdrh     case TK_TRUEFALSE: {
386996acafbeSdrh       sqlite3VdbeAddOp2(v, OP_Integer, sqlite3ExprTruthValue(pExpr), target);
3870007c843bSdrh       return target;
3871007c843bSdrh     }
387213573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
3873598f1340Sdrh     case TK_FLOAT: {
387433e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
387533e619fcSdrh       codeReal(v, pExpr->u.zToken, 0, target);
3876c332cc30Sdrh       return target;
3877598f1340Sdrh     }
387813573c71Sdrh #endif
3879fec19aadSdrh     case TK_STRING: {
388033e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
3881076e85f5Sdrh       sqlite3VdbeLoadString(v, target, pExpr->u.zToken);
3882c332cc30Sdrh       return target;
3883cce7d176Sdrh     }
3884aac30f9bSdrh     default: {
3885c29af653Sdrh       /* Make NULL the default case so that if a bug causes an illegal
3886c29af653Sdrh       ** Expr node to be passed into this function, it will be handled
38879524a7eaSdrh       ** sanely and not crash.  But keep the assert() to bring the problem
38889524a7eaSdrh       ** to the attention of the developers. */
38899524a7eaSdrh       assert( op==TK_NULL );
38909de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
3891c332cc30Sdrh       return target;
3892f0863fe5Sdrh     }
38935338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_BLOB_LITERAL
3894c572ef7fSdanielk1977     case TK_BLOB: {
38956c8c6cecSdrh       int n;
38966c8c6cecSdrh       const char *z;
3897ca48c90fSdrh       char *zBlob;
389833e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
389933e619fcSdrh       assert( pExpr->u.zToken[0]=='x' || pExpr->u.zToken[0]=='X' );
390033e619fcSdrh       assert( pExpr->u.zToken[1]=='\'' );
390133e619fcSdrh       z = &pExpr->u.zToken[2];
3902b7916a78Sdrh       n = sqlite3Strlen30(z) - 1;
3903b7916a78Sdrh       assert( z[n]=='\'' );
3904ca48c90fSdrh       zBlob = sqlite3HexToBlob(sqlite3VdbeDb(v), z, n);
3905ca48c90fSdrh       sqlite3VdbeAddOp4(v, OP_Blob, n/2, target, 0, zBlob, P4_DYNAMIC);
3906c332cc30Sdrh       return target;
3907c572ef7fSdanielk1977     }
39085338a5f7Sdanielk1977 #endif
390950457896Sdrh     case TK_VARIABLE: {
391033e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
391133e619fcSdrh       assert( pExpr->u.zToken!=0 );
391233e619fcSdrh       assert( pExpr->u.zToken[0]!=0 );
3913eaf52d88Sdrh       sqlite3VdbeAddOp2(v, OP_Variable, pExpr->iColumn, target);
391433e619fcSdrh       if( pExpr->u.zToken[1]!=0 ){
39159bf755ccSdrh         const char *z = sqlite3VListNumToName(pParse->pVList, pExpr->iColumn);
39169524a7eaSdrh         assert( pExpr->u.zToken[0]=='?' || (z && !strcmp(pExpr->u.zToken, z)) );
3917ce1bbe51Sdrh         pParse->pVList[0] = 0; /* Indicate VList may no longer be enlarged */
39189bf755ccSdrh         sqlite3VdbeAppendP4(v, (char*)z, P4_STATIC);
39199bf755ccSdrh       }
3920c332cc30Sdrh       return target;
392150457896Sdrh     }
39224e0cff60Sdrh     case TK_REGISTER: {
3923c332cc30Sdrh       return pExpr->iTable;
39244e0cff60Sdrh     }
3925487e262fSdrh #ifndef SQLITE_OMIT_CAST
3926487e262fSdrh     case TK_CAST: {
3927487e262fSdrh       /* Expressions of the form:   CAST(pLeft AS token) */
39282dcef11bSdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
39291735fa88Sdrh       if( inReg!=target ){
39301735fa88Sdrh         sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
39311735fa88Sdrh         inReg = target;
39321735fa88Sdrh       }
39334169e430Sdrh       sqlite3VdbeAddOp2(v, OP_Cast, target,
39344169e430Sdrh                         sqlite3AffinityType(pExpr->u.zToken, 0));
3935c332cc30Sdrh       return inReg;
3936487e262fSdrh     }
3937487e262fSdrh #endif /* SQLITE_OMIT_CAST */
393871c57db0Sdan     case TK_IS:
393971c57db0Sdan     case TK_ISNOT:
394071c57db0Sdan       op = (op==TK_IS) ? TK_EQ : TK_NE;
394171c57db0Sdan       p5 = SQLITE_NULLEQ;
394271c57db0Sdan       /* fall-through */
3943c9b84a1fSdrh     case TK_LT:
3944c9b84a1fSdrh     case TK_LE:
3945c9b84a1fSdrh     case TK_GT:
3946c9b84a1fSdrh     case TK_GE:
3947c9b84a1fSdrh     case TK_NE:
3948c9b84a1fSdrh     case TK_EQ: {
394971c57db0Sdan       Expr *pLeft = pExpr->pLeft;
3950625015e0Sdan       if( sqlite3ExprIsVector(pLeft) ){
395179752b6eSdrh         codeVectorCompare(pParse, pExpr, target, op, p5);
395271c57db0Sdan       }else{
395371c57db0Sdan         r1 = sqlite3ExprCodeTemp(pParse, pLeft, &regFree1);
3954b6da74ebSdrh         r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
395571c57db0Sdan         codeCompare(pParse, pLeft, pExpr->pRight, op,
3956898c527eSdrh             r1, r2, inReg, SQLITE_STOREP2 | p5,
3957898c527eSdrh             ExprHasProperty(pExpr,EP_Commuted));
39587d176105Sdrh         assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
39597d176105Sdrh         assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
39607d176105Sdrh         assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
39617d176105Sdrh         assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
39627d176105Sdrh         assert(TK_EQ==OP_Eq); testcase(op==OP_Eq); VdbeCoverageIf(v,op==OP_Eq);
39637d176105Sdrh         assert(TK_NE==OP_Ne); testcase(op==OP_Ne); VdbeCoverageIf(v,op==OP_Ne);
3964c5499befSdrh         testcase( regFree1==0 );
3965c5499befSdrh         testcase( regFree2==0 );
3966c9b84a1fSdrh       }
39676a2fe093Sdrh       break;
39686a2fe093Sdrh     }
3969cce7d176Sdrh     case TK_AND:
3970cce7d176Sdrh     case TK_OR:
3971cce7d176Sdrh     case TK_PLUS:
3972cce7d176Sdrh     case TK_STAR:
3973cce7d176Sdrh     case TK_MINUS:
3974bf4133cbSdrh     case TK_REM:
3975bf4133cbSdrh     case TK_BITAND:
3976bf4133cbSdrh     case TK_BITOR:
397717c40294Sdrh     case TK_SLASH:
3978bf4133cbSdrh     case TK_LSHIFT:
3979855eb1cfSdrh     case TK_RSHIFT:
39800040077dSdrh     case TK_CONCAT: {
39817d176105Sdrh       assert( TK_AND==OP_And );            testcase( op==TK_AND );
39827d176105Sdrh       assert( TK_OR==OP_Or );              testcase( op==TK_OR );
39837d176105Sdrh       assert( TK_PLUS==OP_Add );           testcase( op==TK_PLUS );
39847d176105Sdrh       assert( TK_MINUS==OP_Subtract );     testcase( op==TK_MINUS );
39857d176105Sdrh       assert( TK_REM==OP_Remainder );      testcase( op==TK_REM );
39867d176105Sdrh       assert( TK_BITAND==OP_BitAnd );      testcase( op==TK_BITAND );
39877d176105Sdrh       assert( TK_BITOR==OP_BitOr );        testcase( op==TK_BITOR );
39887d176105Sdrh       assert( TK_SLASH==OP_Divide );       testcase( op==TK_SLASH );
39897d176105Sdrh       assert( TK_LSHIFT==OP_ShiftLeft );   testcase( op==TK_LSHIFT );
39907d176105Sdrh       assert( TK_RSHIFT==OP_ShiftRight );  testcase( op==TK_RSHIFT );
39917d176105Sdrh       assert( TK_CONCAT==OP_Concat );      testcase( op==TK_CONCAT );
39922dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
39932dcef11bSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
39945b6afba9Sdrh       sqlite3VdbeAddOp3(v, op, r2, r1, target);
3995c5499befSdrh       testcase( regFree1==0 );
3996c5499befSdrh       testcase( regFree2==0 );
39970040077dSdrh       break;
39980040077dSdrh     }
3999cce7d176Sdrh     case TK_UMINUS: {
4000fec19aadSdrh       Expr *pLeft = pExpr->pLeft;
4001fec19aadSdrh       assert( pLeft );
400213573c71Sdrh       if( pLeft->op==TK_INTEGER ){
400313573c71Sdrh         codeInteger(pParse, pLeft, 1, target);
4004c332cc30Sdrh         return target;
400513573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
400613573c71Sdrh       }else if( pLeft->op==TK_FLOAT ){
400733e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
400833e619fcSdrh         codeReal(v, pLeft->u.zToken, 1, target);
4009c332cc30Sdrh         return target;
401013573c71Sdrh #endif
40113c84ddffSdrh       }else{
401210d1edf0Sdrh         tempX.op = TK_INTEGER;
401310d1edf0Sdrh         tempX.flags = EP_IntValue|EP_TokenOnly;
401410d1edf0Sdrh         tempX.u.iValue = 0;
401510d1edf0Sdrh         r1 = sqlite3ExprCodeTemp(pParse, &tempX, &regFree1);
4016e55cbd72Sdrh         r2 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree2);
40172dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_Subtract, r2, r1, target);
4018c5499befSdrh         testcase( regFree2==0 );
40193c84ddffSdrh       }
40206e142f54Sdrh       break;
40216e142f54Sdrh     }
4022bf4133cbSdrh     case TK_BITNOT:
40236e142f54Sdrh     case TK_NOT: {
40247d176105Sdrh       assert( TK_BITNOT==OP_BitNot );   testcase( op==TK_BITNOT );
40257d176105Sdrh       assert( TK_NOT==OP_Not );         testcase( op==TK_NOT );
4026e99fa2afSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4027e99fa2afSdrh       testcase( regFree1==0 );
4028e99fa2afSdrh       sqlite3VdbeAddOp2(v, op, r1, inReg);
4029cce7d176Sdrh       break;
4030cce7d176Sdrh     }
40318abed7b9Sdrh     case TK_TRUTH: {
403296acafbeSdrh       int isTrue;    /* IS TRUE or IS NOT TRUE */
403396acafbeSdrh       int bNormal;   /* IS TRUE or IS FALSE */
4034007c843bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4035007c843bSdrh       testcase( regFree1==0 );
403696acafbeSdrh       isTrue = sqlite3ExprTruthValue(pExpr->pRight);
403796acafbeSdrh       bNormal = pExpr->op2==TK_IS;
403896acafbeSdrh       testcase( isTrue && bNormal);
403996acafbeSdrh       testcase( !isTrue && bNormal);
404096acafbeSdrh       sqlite3VdbeAddOp4Int(v, OP_IsTrue, r1, inReg, !isTrue, isTrue ^ bNormal);
4041007c843bSdrh       break;
4042007c843bSdrh     }
4043cce7d176Sdrh     case TK_ISNULL:
4044cce7d176Sdrh     case TK_NOTNULL: {
40456a288a33Sdrh       int addr;
40467d176105Sdrh       assert( TK_ISNULL==OP_IsNull );   testcase( op==TK_ISNULL );
40477d176105Sdrh       assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
40489de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
40492dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4050c5499befSdrh       testcase( regFree1==0 );
40512dcef11bSdrh       addr = sqlite3VdbeAddOp1(v, op, r1);
40527d176105Sdrh       VdbeCoverageIf(v, op==TK_ISNULL);
40537d176105Sdrh       VdbeCoverageIf(v, op==TK_NOTNULL);
4054a976979bSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 0, target);
40556a288a33Sdrh       sqlite3VdbeJumpHere(v, addr);
4056a37cdde0Sdanielk1977       break;
4057f2bc013cSdrh     }
40582282792aSdrh     case TK_AGG_FUNCTION: {
405913449892Sdrh       AggInfo *pInfo = pExpr->pAggInfo;
40607e56e711Sdrh       if( pInfo==0 ){
406133e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
406233e619fcSdrh         sqlite3ErrorMsg(pParse, "misuse of aggregate: %s()", pExpr->u.zToken);
40637e56e711Sdrh       }else{
4064c332cc30Sdrh         return pInfo->aFunc[pExpr->iAgg].iMem;
40657e56e711Sdrh       }
40662282792aSdrh       break;
40672282792aSdrh     }
4068cce7d176Sdrh     case TK_FUNCTION: {
406912ffee8cSdrh       ExprList *pFarg;       /* List of function arguments */
407012ffee8cSdrh       int nFarg;             /* Number of function arguments */
407112ffee8cSdrh       FuncDef *pDef;         /* The function definition object */
407212ffee8cSdrh       const char *zId;       /* The function name */
4073693e6719Sdrh       u32 constMask = 0;     /* Mask of function arguments that are constant */
407412ffee8cSdrh       int i;                 /* Loop counter */
4075c332cc30Sdrh       sqlite3 *db = pParse->db;  /* The database connection */
407612ffee8cSdrh       u8 enc = ENC(db);      /* The text encoding used by this database */
407712ffee8cSdrh       CollSeq *pColl = 0;    /* A collating sequence */
407817435752Sdrh 
407967a9b8edSdan #ifndef SQLITE_OMIT_WINDOWFUNC
4080eda079cdSdrh       if( ExprHasProperty(pExpr, EP_WinFunc) ){
4081eda079cdSdrh         return pExpr->y.pWin->regResult;
408286fb6e17Sdan       }
408367a9b8edSdan #endif
408486fb6e17Sdan 
40851e9b53f9Sdrh       if( ConstFactorOk(pParse) && sqlite3ExprIsConstantNotJoin(pExpr) ){
408649c5ab24Sdrh         /* SQL functions can be expensive. So try to move constant functions
4087ad879ffdSdrh         ** out of the inner loop, even if that means an extra OP_Copy. */
4088ad879ffdSdrh         return sqlite3ExprCodeAtInit(pParse, pExpr, -1);
40891e9b53f9Sdrh       }
40906ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
4091c5cd1249Sdrh       if( ExprHasProperty(pExpr, EP_TokenOnly) ){
409212ffee8cSdrh         pFarg = 0;
409312ffee8cSdrh       }else{
409412ffee8cSdrh         pFarg = pExpr->x.pList;
409512ffee8cSdrh       }
409612ffee8cSdrh       nFarg = pFarg ? pFarg->nExpr : 0;
409733e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
409833e619fcSdrh       zId = pExpr->u.zToken;
409980738d9cSdrh       pDef = sqlite3FindFunction(db, zId, nFarg, enc, 0);
4100cc15313cSdrh #ifdef SQLITE_ENABLE_UNKNOWN_SQL_FUNCTION
4101cc15313cSdrh       if( pDef==0 && pParse->explain ){
4102cc15313cSdrh         pDef = sqlite3FindFunction(db, "unknown", nFarg, enc, 0);
4103cc15313cSdrh       }
4104cc15313cSdrh #endif
4105b6e9f7a4Sdan       if( pDef==0 || pDef->xFinalize!=0 ){
410680738d9cSdrh         sqlite3ErrorMsg(pParse, "unknown function: %s()", zId);
4107feb306f5Sdrh         break;
4108feb306f5Sdrh       }
410925c4296bSdrh       if( pDef->funcFlags & SQLITE_FUNC_INLINE ){
41100dfa5255Sdrh         assert( (pDef->funcFlags & SQLITE_FUNC_UNSAFE)==0 );
41110dfa5255Sdrh         assert( (pDef->funcFlags & SQLITE_FUNC_DIRECT)==0 );
411225c4296bSdrh         return exprCodeInlineFunction(pParse, pFarg,
411325c4296bSdrh              SQLITE_PTR_TO_INT(pDef->pUserData), target);
4114*2eeca204Sdrh       }else if( pDef->funcFlags & (SQLITE_FUNC_DIRECT|SQLITE_FUNC_UNSAFE) ){
41150dfa5255Sdrh         sqlite3ExprFunctionUsable(pParse, pExpr, pDef);
4116*2eeca204Sdrh       }
4117a1a523a5Sdrh 
4118d1a01edaSdrh       for(i=0; i<nFarg; i++){
4119d1a01edaSdrh         if( i<32 && sqlite3ExprIsConstant(pFarg->a[i].pExpr) ){
4120693e6719Sdrh           testcase( i==31 );
4121693e6719Sdrh           constMask |= MASKBIT32(i);
4122d1a01edaSdrh         }
4123d1a01edaSdrh         if( (pDef->funcFlags & SQLITE_FUNC_NEEDCOLL)!=0 && !pColl ){
4124d1a01edaSdrh           pColl = sqlite3ExprCollSeq(pParse, pFarg->a[i].pExpr);
4125d1a01edaSdrh         }
4126d1a01edaSdrh       }
412712ffee8cSdrh       if( pFarg ){
4128d1a01edaSdrh         if( constMask ){
4129d1a01edaSdrh           r1 = pParse->nMem+1;
4130d1a01edaSdrh           pParse->nMem += nFarg;
4131d1a01edaSdrh         }else{
413212ffee8cSdrh           r1 = sqlite3GetTempRange(pParse, nFarg);
4133d1a01edaSdrh         }
4134a748fdccSdrh 
4135a748fdccSdrh         /* For length() and typeof() functions with a column argument,
4136a748fdccSdrh         ** set the P5 parameter to the OP_Column opcode to OPFLAG_LENGTHARG
4137a748fdccSdrh         ** or OPFLAG_TYPEOFARG respectively, to avoid unnecessary data
4138a748fdccSdrh         ** loading.
4139a748fdccSdrh         */
4140d36e1041Sdrh         if( (pDef->funcFlags & (SQLITE_FUNC_LENGTH|SQLITE_FUNC_TYPEOF))!=0 ){
41414e245a4cSdrh           u8 exprOp;
4142a748fdccSdrh           assert( nFarg==1 );
4143a748fdccSdrh           assert( pFarg->a[0].pExpr!=0 );
41444e245a4cSdrh           exprOp = pFarg->a[0].pExpr->op;
41454e245a4cSdrh           if( exprOp==TK_COLUMN || exprOp==TK_AGG_COLUMN ){
4146a748fdccSdrh             assert( SQLITE_FUNC_LENGTH==OPFLAG_LENGTHARG );
4147a748fdccSdrh             assert( SQLITE_FUNC_TYPEOF==OPFLAG_TYPEOFARG );
4148b1fba286Sdrh             testcase( pDef->funcFlags & OPFLAG_LENGTHARG );
4149b1fba286Sdrh             pFarg->a[0].pExpr->op2 =
4150b1fba286Sdrh                   pDef->funcFlags & (OPFLAG_LENGTHARG|OPFLAG_TYPEOFARG);
4151a748fdccSdrh           }
4152a748fdccSdrh         }
4153a748fdccSdrh 
41545579d59fSdrh         sqlite3ExprCodeExprList(pParse, pFarg, r1, 0,
4155d1a01edaSdrh                                 SQLITE_ECEL_DUP|SQLITE_ECEL_FACTOR);
4156892d3179Sdrh       }else{
415712ffee8cSdrh         r1 = 0;
4158892d3179Sdrh       }
4159b7f6f68fSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
4160a43fa227Sdrh       /* Possibly overload the function if the first argument is
4161a43fa227Sdrh       ** a virtual table column.
4162a43fa227Sdrh       **
4163a43fa227Sdrh       ** For infix functions (LIKE, GLOB, REGEXP, and MATCH) use the
4164a43fa227Sdrh       ** second argument, not the first, as the argument to test to
4165a43fa227Sdrh       ** see if it is a column in a virtual table.  This is done because
4166a43fa227Sdrh       ** the left operand of infix functions (the operand we want to
4167a43fa227Sdrh       ** control overloading) ends up as the second argument to the
4168a43fa227Sdrh       ** function.  The expression "A glob B" is equivalent to
4169a43fa227Sdrh       ** "glob(B,A).  We want to use the A in "A glob B" to test
4170a43fa227Sdrh       ** for function overloading.  But we use the B term in "glob(B,A)".
4171a43fa227Sdrh       */
417259155065Sdrh       if( nFarg>=2 && ExprHasProperty(pExpr, EP_InfixFunc) ){
417312ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[1].pExpr);
417412ffee8cSdrh       }else if( nFarg>0 ){
417512ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[0].pExpr);
4176b7f6f68fSdrh       }
4177b7f6f68fSdrh #endif
4178d36e1041Sdrh       if( pDef->funcFlags & SQLITE_FUNC_NEEDCOLL ){
41798b213899Sdrh         if( !pColl ) pColl = db->pDfltColl;
418066a5167bSdrh         sqlite3VdbeAddOp4(v, OP_CollSeq, 0, 0, 0, (char *)pColl, P4_COLLSEQ);
4181682f68b0Sdanielk1977       }
4182092457b1Sdrh #ifdef SQLITE_ENABLE_OFFSET_SQL_FUNC
4183092457b1Sdrh       if( pDef->funcFlags & SQLITE_FUNC_OFFSET ){
41842fc865c1Sdrh         Expr *pArg = pFarg->a[0].pExpr;
41852fc865c1Sdrh         if( pArg->op==TK_COLUMN ){
4186092457b1Sdrh           sqlite3VdbeAddOp3(v, OP_Offset, pArg->iTable, pArg->iColumn, target);
41872fc865c1Sdrh         }else{
41882fc865c1Sdrh           sqlite3VdbeAddOp2(v, OP_Null, 0, target);
41892fc865c1Sdrh         }
4190092457b1Sdrh       }else
4191092457b1Sdrh #endif
4192092457b1Sdrh       {
4193920cf596Sdrh         sqlite3VdbeAddFunctionCall(pParse, constMask, r1, target, nFarg,
419420cee7d0Sdrh                                    pDef, pExpr->op2);
41952fc865c1Sdrh       }
419613d79502Sdrh       if( nFarg ){
419713d79502Sdrh         if( constMask==0 ){
419812ffee8cSdrh           sqlite3ReleaseTempRange(pParse, r1, nFarg);
419913d79502Sdrh         }else{
42003aef2fb1Sdrh           sqlite3VdbeReleaseRegisters(pParse, r1, nFarg, constMask, 1);
420113d79502Sdrh         }
42022dcef11bSdrh       }
4203c332cc30Sdrh       return target;
42046ec2733bSdrh     }
4205fe2093d7Sdrh #ifndef SQLITE_OMIT_SUBQUERY
4206fe2093d7Sdrh     case TK_EXISTS:
420719a775c2Sdrh     case TK_SELECT: {
42088da209b1Sdan       int nCol;
4209c5499befSdrh       testcase( op==TK_EXISTS );
4210c5499befSdrh       testcase( op==TK_SELECT );
42118da209b1Sdan       if( op==TK_SELECT && (nCol = pExpr->x.pSelect->pEList->nExpr)!=1 ){
42128da209b1Sdan         sqlite3SubselectError(pParse, nCol, 1);
42138da209b1Sdan       }else{
421485bcdce2Sdrh         return sqlite3CodeSubselect(pParse, pExpr);
42158da209b1Sdan       }
421619a775c2Sdrh       break;
421719a775c2Sdrh     }
4218fc7f27b9Sdrh     case TK_SELECT_COLUMN: {
4219966e2911Sdrh       int n;
4220fc7f27b9Sdrh       if( pExpr->pLeft->iTable==0 ){
422185bcdce2Sdrh         pExpr->pLeft->iTable = sqlite3CodeSubselect(pParse, pExpr->pLeft);
4222fc7f27b9Sdrh       }
4223966e2911Sdrh       assert( pExpr->iTable==0 || pExpr->pLeft->op==TK_SELECT );
4224554a9dc7Sdrh       if( pExpr->iTable!=0
4225966e2911Sdrh        && pExpr->iTable!=(n = sqlite3ExprVectorSize(pExpr->pLeft))
4226966e2911Sdrh       ){
4227966e2911Sdrh         sqlite3ErrorMsg(pParse, "%d columns assigned %d values",
4228966e2911Sdrh                                 pExpr->iTable, n);
4229966e2911Sdrh       }
4230c332cc30Sdrh       return pExpr->pLeft->iTable + pExpr->iColumn;
4231fc7f27b9Sdrh     }
4232fef5208cSdrh     case TK_IN: {
4233ec4ccdbcSdrh       int destIfFalse = sqlite3VdbeMakeLabel(pParse);
4234ec4ccdbcSdrh       int destIfNull = sqlite3VdbeMakeLabel(pParse);
4235e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
4236e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
423766ba23ceSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
4238e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
4239e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_AddImm, target, 0);
4240e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfNull);
4241c332cc30Sdrh       return target;
4242fef5208cSdrh     }
4243e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
4244e3365e6cSdrh 
4245e3365e6cSdrh 
42462dcef11bSdrh     /*
42472dcef11bSdrh     **    x BETWEEN y AND z
42482dcef11bSdrh     **
42492dcef11bSdrh     ** This is equivalent to
42502dcef11bSdrh     **
42512dcef11bSdrh     **    x>=y AND x<=z
42522dcef11bSdrh     **
42532dcef11bSdrh     ** X is stored in pExpr->pLeft.
42542dcef11bSdrh     ** Y is stored in pExpr->pList->a[0].pExpr.
42552dcef11bSdrh     ** Z is stored in pExpr->pList->a[1].pExpr.
42562dcef11bSdrh     */
4257fef5208cSdrh     case TK_BETWEEN: {
425871c57db0Sdan       exprCodeBetween(pParse, pExpr, target, 0, 0);
4259c332cc30Sdrh       return target;
4260fef5208cSdrh     }
426194fa9c41Sdrh     case TK_SPAN:
4262ae80ddeaSdrh     case TK_COLLATE:
42634f07e5fbSdrh     case TK_UPLUS: {
42641efa8023Sdrh       pExpr = pExpr->pLeft;
426559ee43a7Sdrh       goto expr_code_doover; /* 2018-04-28: Prevent deep recursion. OSSFuzz. */
4266a2e00042Sdrh     }
42672dcef11bSdrh 
4268165921a7Sdan     case TK_TRIGGER: {
426965a7cd16Sdan       /* If the opcode is TK_TRIGGER, then the expression is a reference
427065a7cd16Sdan       ** to a column in the new.* or old.* pseudo-tables available to
427165a7cd16Sdan       ** trigger programs. In this case Expr.iTable is set to 1 for the
427265a7cd16Sdan       ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
427365a7cd16Sdan       ** is set to the column of the pseudo-table to read, or to -1 to
427465a7cd16Sdan       ** read the rowid field.
427565a7cd16Sdan       **
427665a7cd16Sdan       ** The expression is implemented using an OP_Param opcode. The p1
427765a7cd16Sdan       ** parameter is set to 0 for an old.rowid reference, or to (i+1)
427865a7cd16Sdan       ** to reference another column of the old.* pseudo-table, where
427965a7cd16Sdan       ** i is the index of the column. For a new.rowid reference, p1 is
428065a7cd16Sdan       ** set to (n+1), where n is the number of columns in each pseudo-table.
428165a7cd16Sdan       ** For a reference to any other column in the new.* pseudo-table, p1
428265a7cd16Sdan       ** is set to (n+2+i), where n and i are as defined previously. For
428365a7cd16Sdan       ** example, if the table on which triggers are being fired is
428465a7cd16Sdan       ** declared as:
428565a7cd16Sdan       **
428665a7cd16Sdan       **   CREATE TABLE t1(a, b);
428765a7cd16Sdan       **
428865a7cd16Sdan       ** Then p1 is interpreted as follows:
428965a7cd16Sdan       **
429065a7cd16Sdan       **   p1==0   ->    old.rowid     p1==3   ->    new.rowid
429165a7cd16Sdan       **   p1==1   ->    old.a         p1==4   ->    new.a
429265a7cd16Sdan       **   p1==2   ->    old.b         p1==5   ->    new.b
429365a7cd16Sdan       */
4294eda079cdSdrh       Table *pTab = pExpr->y.pTab;
4295dd6cc9b5Sdrh       int iCol = pExpr->iColumn;
4296dd6cc9b5Sdrh       int p1 = pExpr->iTable * (pTab->nCol+1) + 1
42977fe2fc0dSdrh                      + sqlite3TableColumnToStorage(pTab, iCol);
429865a7cd16Sdan 
429965a7cd16Sdan       assert( pExpr->iTable==0 || pExpr->iTable==1 );
4300dd6cc9b5Sdrh       assert( iCol>=-1 && iCol<pTab->nCol );
4301dd6cc9b5Sdrh       assert( pTab->iPKey<0 || iCol!=pTab->iPKey );
430265a7cd16Sdan       assert( p1>=0 && p1<(pTab->nCol*2+2) );
430365a7cd16Sdan 
430465a7cd16Sdan       sqlite3VdbeAddOp2(v, OP_Param, p1, target);
4305896494e8Sdrh       VdbeComment((v, "r[%d]=%s.%s", target,
4306165921a7Sdan         (pExpr->iTable ? "new" : "old"),
4307dd6cc9b5Sdrh         (pExpr->iColumn<0 ? "rowid" : pExpr->y.pTab->aCol[iCol].zName)
4308165921a7Sdan       ));
430965a7cd16Sdan 
431044dbca83Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
431165a7cd16Sdan       /* If the column has REAL affinity, it may currently be stored as an
4312113762a2Sdrh       ** integer. Use OP_RealAffinity to make sure it is really real.
4313113762a2Sdrh       **
4314113762a2Sdrh       ** EVIDENCE-OF: R-60985-57662 SQLite will convert the value back to
4315113762a2Sdrh       ** floating point when extracting it from the record.  */
4316dd6cc9b5Sdrh       if( iCol>=0 && pTab->aCol[iCol].affinity==SQLITE_AFF_REAL ){
43172832ad42Sdan         sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
43182832ad42Sdan       }
431944dbca83Sdrh #endif
4320165921a7Sdan       break;
4321165921a7Sdan     }
4322165921a7Sdan 
432371c57db0Sdan     case TK_VECTOR: {
4324e835bc12Sdrh       sqlite3ErrorMsg(pParse, "row value misused");
432571c57db0Sdan       break;
432671c57db0Sdan     }
432771c57db0Sdan 
43289e9a67adSdrh     /* TK_IF_NULL_ROW Expr nodes are inserted ahead of expressions
43299e9a67adSdrh     ** that derive from the right-hand table of a LEFT JOIN.  The
43309e9a67adSdrh     ** Expr.iTable value is the table number for the right-hand table.
43319e9a67adSdrh     ** The expression is only evaluated if that table is not currently
43329e9a67adSdrh     ** on a LEFT JOIN NULL row.
43339e9a67adSdrh     */
433431d6fd55Sdrh     case TK_IF_NULL_ROW: {
433531d6fd55Sdrh       int addrINR;
43369e9a67adSdrh       u8 okConstFactor = pParse->okConstFactor;
433731d6fd55Sdrh       addrINR = sqlite3VdbeAddOp1(v, OP_IfNullRow, pExpr->iTable);
43389e9a67adSdrh       /* Temporarily disable factoring of constant expressions, since
43399e9a67adSdrh       ** even though expressions may appear to be constant, they are not
43409e9a67adSdrh       ** really constant because they originate from the right-hand side
43419e9a67adSdrh       ** of a LEFT JOIN. */
43429e9a67adSdrh       pParse->okConstFactor = 0;
434331d6fd55Sdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
43449e9a67adSdrh       pParse->okConstFactor = okConstFactor;
434531d6fd55Sdrh       sqlite3VdbeJumpHere(v, addrINR);
434631d6fd55Sdrh       sqlite3VdbeChangeP3(v, addrINR, inReg);
434731d6fd55Sdrh       break;
434831d6fd55Sdrh     }
434931d6fd55Sdrh 
43502dcef11bSdrh     /*
43512dcef11bSdrh     ** Form A:
43522dcef11bSdrh     **   CASE x WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
43532dcef11bSdrh     **
43542dcef11bSdrh     ** Form B:
43552dcef11bSdrh     **   CASE WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
43562dcef11bSdrh     **
43572dcef11bSdrh     ** Form A is can be transformed into the equivalent form B as follows:
43582dcef11bSdrh     **   CASE WHEN x=e1 THEN r1 WHEN x=e2 THEN r2 ...
43592dcef11bSdrh     **        WHEN x=eN THEN rN ELSE y END
43602dcef11bSdrh     **
43612dcef11bSdrh     ** X (if it exists) is in pExpr->pLeft.
4362c5cd1249Sdrh     ** Y is in the last element of pExpr->x.pList if pExpr->x.pList->nExpr is
4363c5cd1249Sdrh     ** odd.  The Y is also optional.  If the number of elements in x.pList
4364c5cd1249Sdrh     ** is even, then Y is omitted and the "otherwise" result is NULL.
43652dcef11bSdrh     ** Ei is in pExpr->pList->a[i*2] and Ri is pExpr->pList->a[i*2+1].
43662dcef11bSdrh     **
43672dcef11bSdrh     ** The result of the expression is the Ri for the first matching Ei,
43682dcef11bSdrh     ** or if there is no matching Ei, the ELSE term Y, or if there is
43692dcef11bSdrh     ** no ELSE term, NULL.
43702dcef11bSdrh     */
4371aac30f9bSdrh     case TK_CASE: {
43722dcef11bSdrh       int endLabel;                     /* GOTO label for end of CASE stmt */
43732dcef11bSdrh       int nextCase;                     /* GOTO label for next WHEN clause */
43742dcef11bSdrh       int nExpr;                        /* 2x number of WHEN terms */
43752dcef11bSdrh       int i;                            /* Loop counter */
43762dcef11bSdrh       ExprList *pEList;                 /* List of WHEN terms */
43772dcef11bSdrh       struct ExprList_item *aListelem;  /* Array of WHEN terms */
43782dcef11bSdrh       Expr opCompare;                   /* The X==Ei expression */
43792dcef11bSdrh       Expr *pX;                         /* The X expression */
43801bd10f8aSdrh       Expr *pTest = 0;                  /* X==Ei (form A) or just Ei (form B) */
43818b65e591Sdan       Expr *pDel = 0;
43828b65e591Sdan       sqlite3 *db = pParse->db;
438317a7f8ddSdrh 
43846ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) && pExpr->x.pList );
43856ab3a2ecSdanielk1977       assert(pExpr->x.pList->nExpr > 0);
43866ab3a2ecSdanielk1977       pEList = pExpr->x.pList;
4387be5c89acSdrh       aListelem = pEList->a;
4388be5c89acSdrh       nExpr = pEList->nExpr;
4389ec4ccdbcSdrh       endLabel = sqlite3VdbeMakeLabel(pParse);
43902dcef11bSdrh       if( (pX = pExpr->pLeft)!=0 ){
43918b65e591Sdan         pDel = sqlite3ExprDup(db, pX, 0);
43928b65e591Sdan         if( db->mallocFailed ){
43938b65e591Sdan           sqlite3ExprDelete(db, pDel);
43948b65e591Sdan           break;
43958b65e591Sdan         }
439633cd4909Sdrh         testcase( pX->op==TK_COLUMN );
43978b65e591Sdan         exprToRegister(pDel, exprCodeVector(pParse, pDel, &regFree1));
4398c5499befSdrh         testcase( regFree1==0 );
4399abb9d5f1Sdrh         memset(&opCompare, 0, sizeof(opCompare));
44002dcef11bSdrh         opCompare.op = TK_EQ;
44018b65e591Sdan         opCompare.pLeft = pDel;
44022dcef11bSdrh         pTest = &opCompare;
44038b1db07fSdrh         /* Ticket b351d95f9cd5ef17e9d9dbae18f5ca8611190001:
44048b1db07fSdrh         ** The value in regFree1 might get SCopy-ed into the file result.
44058b1db07fSdrh         ** So make sure that the regFree1 register is not reused for other
44068b1db07fSdrh         ** purposes and possibly overwritten.  */
44078b1db07fSdrh         regFree1 = 0;
4408cce7d176Sdrh       }
4409c5cd1249Sdrh       for(i=0; i<nExpr-1; i=i+2){
44102dcef11bSdrh         if( pX ){
44111bd10f8aSdrh           assert( pTest!=0 );
44122dcef11bSdrh           opCompare.pRight = aListelem[i].pExpr;
4413f5905aa7Sdrh         }else{
44142dcef11bSdrh           pTest = aListelem[i].pExpr;
441517a7f8ddSdrh         }
4416ec4ccdbcSdrh         nextCase = sqlite3VdbeMakeLabel(pParse);
441733cd4909Sdrh         testcase( pTest->op==TK_COLUMN );
44182dcef11bSdrh         sqlite3ExprIfFalse(pParse, pTest, nextCase, SQLITE_JUMPIFNULL);
4419c5499befSdrh         testcase( aListelem[i+1].pExpr->op==TK_COLUMN );
44209de221dfSdrh         sqlite3ExprCode(pParse, aListelem[i+1].pExpr, target);
4421076e85f5Sdrh         sqlite3VdbeGoto(v, endLabel);
44222dcef11bSdrh         sqlite3VdbeResolveLabel(v, nextCase);
4423f570f011Sdrh       }
4424c5cd1249Sdrh       if( (nExpr&1)!=0 ){
4425c5cd1249Sdrh         sqlite3ExprCode(pParse, pEList->a[nExpr-1].pExpr, target);
442617a7f8ddSdrh       }else{
44279de221dfSdrh         sqlite3VdbeAddOp2(v, OP_Null, 0, target);
442817a7f8ddSdrh       }
44298b65e591Sdan       sqlite3ExprDelete(db, pDel);
44302dcef11bSdrh       sqlite3VdbeResolveLabel(v, endLabel);
44316f34903eSdanielk1977       break;
44326f34903eSdanielk1977     }
44335338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_TRIGGER
44346f34903eSdanielk1977     case TK_RAISE: {
44351194904bSdrh       assert( pExpr->affExpr==OE_Rollback
44361194904bSdrh            || pExpr->affExpr==OE_Abort
44371194904bSdrh            || pExpr->affExpr==OE_Fail
44381194904bSdrh            || pExpr->affExpr==OE_Ignore
4439165921a7Sdan       );
4440e0af83acSdan       if( !pParse->pTriggerTab ){
4441e0af83acSdan         sqlite3ErrorMsg(pParse,
4442e0af83acSdan                        "RAISE() may only be used within a trigger-program");
4443e0af83acSdan         return 0;
4444e0af83acSdan       }
44451194904bSdrh       if( pExpr->affExpr==OE_Abort ){
4446e0af83acSdan         sqlite3MayAbort(pParse);
4447e0af83acSdan       }
444833e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
44491194904bSdrh       if( pExpr->affExpr==OE_Ignore ){
4450e0af83acSdan         sqlite3VdbeAddOp4(
4451e0af83acSdan             v, OP_Halt, SQLITE_OK, OE_Ignore, 0, pExpr->u.zToken,0);
4452688852abSdrh         VdbeCoverage(v);
4453e0af83acSdan       }else{
4454433dccfbSdrh         sqlite3HaltConstraint(pParse, SQLITE_CONSTRAINT_TRIGGER,
44551194904bSdrh                               pExpr->affExpr, pExpr->u.zToken, 0, 0);
4456e0af83acSdan       }
4457e0af83acSdan 
4458ffe07b2dSdrh       break;
445917a7f8ddSdrh     }
44605338a5f7Sdanielk1977 #endif
4461ffe07b2dSdrh   }
44622dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
44632dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
44642dcef11bSdrh   return inReg;
44655b6afba9Sdrh }
44662dcef11bSdrh 
44672dcef11bSdrh /*
4468d1a01edaSdrh ** Factor out the code of the given expression to initialization time.
44691e9b53f9Sdrh **
4470ad879ffdSdrh ** If regDest>=0 then the result is always stored in that register and the
4471ad879ffdSdrh ** result is not reusable.  If regDest<0 then this routine is free to
4472ad879ffdSdrh ** store the value whereever it wants.  The register where the expression
4473ad879ffdSdrh ** is stored is returned.  When regDest<0, two identical expressions will
4474ad879ffdSdrh ** code to the same register.
4475d1a01edaSdrh */
44761e9b53f9Sdrh int sqlite3ExprCodeAtInit(
4477d673cddaSdrh   Parse *pParse,    /* Parsing context */
4478d673cddaSdrh   Expr *pExpr,      /* The expression to code when the VDBE initializes */
4479ad879ffdSdrh   int regDest       /* Store the value in this register */
4480d673cddaSdrh ){
4481d1a01edaSdrh   ExprList *p;
4482d9f158e7Sdrh   assert( ConstFactorOk(pParse) );
4483d1a01edaSdrh   p = pParse->pConstExpr;
4484ad879ffdSdrh   if( regDest<0 && p ){
44851e9b53f9Sdrh     struct ExprList_item *pItem;
44861e9b53f9Sdrh     int i;
44871e9b53f9Sdrh     for(pItem=p->a, i=p->nExpr; i>0; pItem++, i--){
44885aa550cfSdan       if( pItem->reusable && sqlite3ExprCompare(0,pItem->pExpr,pExpr,-1)==0 ){
44891e9b53f9Sdrh         return pItem->u.iConstExprReg;
44901e9b53f9Sdrh       }
44911e9b53f9Sdrh     }
44921e9b53f9Sdrh   }
4493d1a01edaSdrh   pExpr = sqlite3ExprDup(pParse->db, pExpr, 0);
4494d1a01edaSdrh   p = sqlite3ExprListAppend(pParse, p, pExpr);
4495d673cddaSdrh   if( p ){
4496d673cddaSdrh      struct ExprList_item *pItem = &p->a[p->nExpr-1];
4497ad879ffdSdrh      pItem->reusable = regDest<0;
4498ad879ffdSdrh      if( regDest<0 ) regDest = ++pParse->nMem;
4499d673cddaSdrh      pItem->u.iConstExprReg = regDest;
4500d673cddaSdrh   }
4501d1a01edaSdrh   pParse->pConstExpr = p;
45021e9b53f9Sdrh   return regDest;
4503d1a01edaSdrh }
4504d1a01edaSdrh 
4505d1a01edaSdrh /*
45062dcef11bSdrh ** Generate code to evaluate an expression and store the results
45072dcef11bSdrh ** into a register.  Return the register number where the results
45082dcef11bSdrh ** are stored.
45092dcef11bSdrh **
45102dcef11bSdrh ** If the register is a temporary register that can be deallocated,
4511678ccce8Sdrh ** then write its number into *pReg.  If the result register is not
45122dcef11bSdrh ** a temporary, then set *pReg to zero.
4513f30a969bSdrh **
4514f30a969bSdrh ** If pExpr is a constant, then this routine might generate this
4515f30a969bSdrh ** code to fill the register in the initialization section of the
4516f30a969bSdrh ** VDBE program, in order to factor it out of the evaluation loop.
45172dcef11bSdrh */
45182dcef11bSdrh int sqlite3ExprCodeTemp(Parse *pParse, Expr *pExpr, int *pReg){
4519f30a969bSdrh   int r2;
45200d950af3Sdrh   pExpr = sqlite3ExprSkipCollateAndLikely(pExpr);
4521d9f158e7Sdrh   if( ConstFactorOk(pParse)
4522f30a969bSdrh    && pExpr->op!=TK_REGISTER
4523f30a969bSdrh    && sqlite3ExprIsConstantNotJoin(pExpr)
4524f30a969bSdrh   ){
4525f30a969bSdrh     *pReg  = 0;
4526ad879ffdSdrh     r2 = sqlite3ExprCodeAtInit(pParse, pExpr, -1);
4527f30a969bSdrh   }else{
45282dcef11bSdrh     int r1 = sqlite3GetTempReg(pParse);
4529f30a969bSdrh     r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
45302dcef11bSdrh     if( r2==r1 ){
45312dcef11bSdrh       *pReg = r1;
45322dcef11bSdrh     }else{
45332dcef11bSdrh       sqlite3ReleaseTempReg(pParse, r1);
45342dcef11bSdrh       *pReg = 0;
45352dcef11bSdrh     }
4536f30a969bSdrh   }
45372dcef11bSdrh   return r2;
45382dcef11bSdrh }
45392dcef11bSdrh 
45402dcef11bSdrh /*
45412dcef11bSdrh ** Generate code that will evaluate expression pExpr and store the
45422dcef11bSdrh ** results in register target.  The results are guaranteed to appear
45432dcef11bSdrh ** in register target.
45442dcef11bSdrh */
454505a86c5cSdrh void sqlite3ExprCode(Parse *pParse, Expr *pExpr, int target){
45469cbf3425Sdrh   int inReg;
45479cbf3425Sdrh 
45489cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
45499cbf3425Sdrh   inReg = sqlite3ExprCodeTarget(pParse, pExpr, target);
45501c75c9d7Sdrh   assert( pParse->pVdbe!=0 || pParse->db->mallocFailed );
45510e359b30Sdrh   if( inReg!=target && pParse->pVdbe ){
4552629b88c6Sdrh     u8 op;
4553629b88c6Sdrh     if( ExprHasProperty(pExpr,EP_Subquery) ){
4554629b88c6Sdrh       op = OP_Copy;
4555629b88c6Sdrh     }else{
4556629b88c6Sdrh       op = OP_SCopy;
4557629b88c6Sdrh     }
4558629b88c6Sdrh     sqlite3VdbeAddOp2(pParse->pVdbe, op, inReg, target);
455917a7f8ddSdrh   }
4560ebc16717Sdrh }
4561cce7d176Sdrh 
4562cce7d176Sdrh /*
45631c75c9d7Sdrh ** Make a transient copy of expression pExpr and then code it using
45641c75c9d7Sdrh ** sqlite3ExprCode().  This routine works just like sqlite3ExprCode()
45651c75c9d7Sdrh ** except that the input expression is guaranteed to be unchanged.
45661c75c9d7Sdrh */
45671c75c9d7Sdrh void sqlite3ExprCodeCopy(Parse *pParse, Expr *pExpr, int target){
45681c75c9d7Sdrh   sqlite3 *db = pParse->db;
45691c75c9d7Sdrh   pExpr = sqlite3ExprDup(db, pExpr, 0);
45701c75c9d7Sdrh   if( !db->mallocFailed ) sqlite3ExprCode(pParse, pExpr, target);
45711c75c9d7Sdrh   sqlite3ExprDelete(db, pExpr);
45721c75c9d7Sdrh }
45731c75c9d7Sdrh 
45741c75c9d7Sdrh /*
457505a86c5cSdrh ** Generate code that will evaluate expression pExpr and store the
457605a86c5cSdrh ** results in register target.  The results are guaranteed to appear
457705a86c5cSdrh ** in register target.  If the expression is constant, then this routine
457805a86c5cSdrh ** might choose to code the expression at initialization time.
457905a86c5cSdrh */
458005a86c5cSdrh void sqlite3ExprCodeFactorable(Parse *pParse, Expr *pExpr, int target){
4581b8b06690Sdrh   if( pParse->okConstFactor && sqlite3ExprIsConstantNotJoin(pExpr) ){
4582ad879ffdSdrh     sqlite3ExprCodeAtInit(pParse, pExpr, target);
458305a86c5cSdrh   }else{
458405a86c5cSdrh     sqlite3ExprCode(pParse, pExpr, target);
458505a86c5cSdrh   }
4586cce7d176Sdrh }
4587cce7d176Sdrh 
4588cce7d176Sdrh /*
4589268380caSdrh ** Generate code that pushes the value of every element of the given
45909cbf3425Sdrh ** expression list into a sequence of registers beginning at target.
4591268380caSdrh **
45923df6c3b1Sdrh ** Return the number of elements evaluated.  The number returned will
45933df6c3b1Sdrh ** usually be pList->nExpr but might be reduced if SQLITE_ECEL_OMITREF
45943df6c3b1Sdrh ** is defined.
4595d1a01edaSdrh **
4596d1a01edaSdrh ** The SQLITE_ECEL_DUP flag prevents the arguments from being
4597d1a01edaSdrh ** filled using OP_SCopy.  OP_Copy must be used instead.
4598d1a01edaSdrh **
4599d1a01edaSdrh ** The SQLITE_ECEL_FACTOR argument allows constant arguments to be
4600d1a01edaSdrh ** factored out into initialization code.
4601b0df9634Sdrh **
4602b0df9634Sdrh ** The SQLITE_ECEL_REF flag means that expressions in the list with
4603b0df9634Sdrh ** ExprList.a[].u.x.iOrderByCol>0 have already been evaluated and stored
4604b0df9634Sdrh ** in registers at srcReg, and so the value can be copied from there.
46053df6c3b1Sdrh ** If SQLITE_ECEL_OMITREF is also set, then the values with u.x.iOrderByCol>0
46063df6c3b1Sdrh ** are simply omitted rather than being copied from srcReg.
4607268380caSdrh */
46084adee20fSdanielk1977 int sqlite3ExprCodeExprList(
4609268380caSdrh   Parse *pParse,     /* Parsing context */
4610389a1adbSdrh   ExprList *pList,   /* The expression list to be coded */
4611191b54cbSdrh   int target,        /* Where to write results */
46125579d59fSdrh   int srcReg,        /* Source registers if SQLITE_ECEL_REF */
4613d1a01edaSdrh   u8 flags           /* SQLITE_ECEL_* flags */
4614268380caSdrh ){
4615268380caSdrh   struct ExprList_item *pItem;
46165579d59fSdrh   int i, j, n;
4617d1a01edaSdrh   u8 copyOp = (flags & SQLITE_ECEL_DUP) ? OP_Copy : OP_SCopy;
46185579d59fSdrh   Vdbe *v = pParse->pVdbe;
46199d8b3072Sdrh   assert( pList!=0 );
46209cbf3425Sdrh   assert( target>0 );
4621d81a142bSdrh   assert( pParse->pVdbe!=0 );  /* Never gets this far otherwise */
4622268380caSdrh   n = pList->nExpr;
4623d9f158e7Sdrh   if( !ConstFactorOk(pParse) ) flags &= ~SQLITE_ECEL_FACTOR;
4624191b54cbSdrh   for(pItem=pList->a, i=0; i<n; i++, pItem++){
46257445ffe2Sdrh     Expr *pExpr = pItem->pExpr;
462624e25d32Sdan #ifdef SQLITE_ENABLE_SORTER_REFERENCES
462724e25d32Sdan     if( pItem->bSorterRef ){
462824e25d32Sdan       i--;
462924e25d32Sdan       n--;
463024e25d32Sdan     }else
463124e25d32Sdan #endif
4632257c13faSdan     if( (flags & SQLITE_ECEL_REF)!=0 && (j = pItem->u.x.iOrderByCol)>0 ){
4633257c13faSdan       if( flags & SQLITE_ECEL_OMITREF ){
4634257c13faSdan         i--;
4635257c13faSdan         n--;
4636257c13faSdan       }else{
46375579d59fSdrh         sqlite3VdbeAddOp2(v, copyOp, j+srcReg-1, target+i);
4638257c13faSdan       }
4639b8b06690Sdrh     }else if( (flags & SQLITE_ECEL_FACTOR)!=0
4640b8b06690Sdrh            && sqlite3ExprIsConstantNotJoin(pExpr)
4641b8b06690Sdrh     ){
4642ad879ffdSdrh       sqlite3ExprCodeAtInit(pParse, pExpr, target+i);
4643d1a01edaSdrh     }else{
46447445ffe2Sdrh       int inReg = sqlite3ExprCodeTarget(pParse, pExpr, target+i);
4645746fd9ccSdrh       if( inReg!=target+i ){
46464eded604Sdrh         VdbeOp *pOp;
46474eded604Sdrh         if( copyOp==OP_Copy
46484eded604Sdrh          && (pOp=sqlite3VdbeGetOp(v, -1))->opcode==OP_Copy
46494eded604Sdrh          && pOp->p1+pOp->p3+1==inReg
46504eded604Sdrh          && pOp->p2+pOp->p3+1==target+i
465190996885Sdrh          && pOp->p5==0  /* The do-not-merge flag must be clear */
46524eded604Sdrh         ){
46534eded604Sdrh           pOp->p3++;
46544eded604Sdrh         }else{
46554eded604Sdrh           sqlite3VdbeAddOp2(v, copyOp, inReg, target+i);
46564eded604Sdrh         }
4657d1a01edaSdrh       }
4658d176611bSdrh     }
4659268380caSdrh   }
4660f9b596ebSdrh   return n;
4661268380caSdrh }
4662268380caSdrh 
4663268380caSdrh /*
466436c563a2Sdrh ** Generate code for a BETWEEN operator.
466536c563a2Sdrh **
466636c563a2Sdrh **    x BETWEEN y AND z
466736c563a2Sdrh **
466836c563a2Sdrh ** The above is equivalent to
466936c563a2Sdrh **
467036c563a2Sdrh **    x>=y AND x<=z
467136c563a2Sdrh **
467236c563a2Sdrh ** Code it as such, taking care to do the common subexpression
467360ec914cSpeter.d.reid ** elimination of x.
467484b19a3dSdrh **
467584b19a3dSdrh ** The xJumpIf parameter determines details:
467684b19a3dSdrh **
467784b19a3dSdrh **    NULL:                   Store the boolean result in reg[dest]
467884b19a3dSdrh **    sqlite3ExprIfTrue:      Jump to dest if true
467984b19a3dSdrh **    sqlite3ExprIfFalse:     Jump to dest if false
468084b19a3dSdrh **
468184b19a3dSdrh ** The jumpIfNull parameter is ignored if xJumpIf is NULL.
468236c563a2Sdrh */
468336c563a2Sdrh static void exprCodeBetween(
468436c563a2Sdrh   Parse *pParse,    /* Parsing and code generating context */
468536c563a2Sdrh   Expr *pExpr,      /* The BETWEEN expression */
468684b19a3dSdrh   int dest,         /* Jump destination or storage location */
468784b19a3dSdrh   void (*xJump)(Parse*,Expr*,int,int), /* Action to take */
468836c563a2Sdrh   int jumpIfNull    /* Take the jump if the BETWEEN is NULL */
468936c563a2Sdrh ){
469036c563a2Sdrh   Expr exprAnd;     /* The AND operator in  x>=y AND x<=z  */
469136c563a2Sdrh   Expr compLeft;    /* The  x>=y  term */
469236c563a2Sdrh   Expr compRight;   /* The  x<=z  term */
4693db45bd5eSdrh   int regFree1 = 0; /* Temporary use register */
46948b65e591Sdan   Expr *pDel = 0;
46958b65e591Sdan   sqlite3 *db = pParse->db;
469684b19a3dSdrh 
469771c57db0Sdan   memset(&compLeft, 0, sizeof(Expr));
469871c57db0Sdan   memset(&compRight, 0, sizeof(Expr));
469971c57db0Sdan   memset(&exprAnd, 0, sizeof(Expr));
4700db45bd5eSdrh 
4701db45bd5eSdrh   assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
47028b65e591Sdan   pDel = sqlite3ExprDup(db, pExpr->pLeft, 0);
47038b65e591Sdan   if( db->mallocFailed==0 ){
470436c563a2Sdrh     exprAnd.op = TK_AND;
470536c563a2Sdrh     exprAnd.pLeft = &compLeft;
470636c563a2Sdrh     exprAnd.pRight = &compRight;
470736c563a2Sdrh     compLeft.op = TK_GE;
47088b65e591Sdan     compLeft.pLeft = pDel;
470936c563a2Sdrh     compLeft.pRight = pExpr->x.pList->a[0].pExpr;
471036c563a2Sdrh     compRight.op = TK_LE;
47118b65e591Sdan     compRight.pLeft = pDel;
471236c563a2Sdrh     compRight.pRight = pExpr->x.pList->a[1].pExpr;
47138b65e591Sdan     exprToRegister(pDel, exprCodeVector(pParse, pDel, &regFree1));
471484b19a3dSdrh     if( xJump ){
471584b19a3dSdrh       xJump(pParse, &exprAnd, dest, jumpIfNull);
471636c563a2Sdrh     }else{
471736fd41e5Sdrh       /* Mark the expression is being from the ON or USING clause of a join
471836fd41e5Sdrh       ** so that the sqlite3ExprCodeTarget() routine will not attempt to move
471936fd41e5Sdrh       ** it into the Parse.pConstExpr list.  We should use a new bit for this,
472036fd41e5Sdrh       ** for clarity, but we are out of bits in the Expr.flags field so we
472136fd41e5Sdrh       ** have to reuse the EP_FromJoin bit.  Bummer. */
47228b65e591Sdan       pDel->flags |= EP_FromJoin;
472371c57db0Sdan       sqlite3ExprCodeTarget(pParse, &exprAnd, dest);
472436c563a2Sdrh     }
4725db45bd5eSdrh     sqlite3ReleaseTempReg(pParse, regFree1);
47268b65e591Sdan   }
47278b65e591Sdan   sqlite3ExprDelete(db, pDel);
472836c563a2Sdrh 
472936c563a2Sdrh   /* Ensure adequate test coverage */
4730db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull==0 && regFree1==0 );
4731db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull==0 && regFree1!=0 );
4732db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull!=0 && regFree1==0 );
4733db45bd5eSdrh   testcase( xJump==sqlite3ExprIfTrue  && jumpIfNull!=0 && regFree1!=0 );
4734db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1==0 );
4735db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull==0 && regFree1!=0 );
4736db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1==0 );
4737db45bd5eSdrh   testcase( xJump==sqlite3ExprIfFalse && jumpIfNull!=0 && regFree1!=0 );
473884b19a3dSdrh   testcase( xJump==0 );
473936c563a2Sdrh }
474036c563a2Sdrh 
474136c563a2Sdrh /*
4742cce7d176Sdrh ** Generate code for a boolean expression such that a jump is made
4743cce7d176Sdrh ** to the label "dest" if the expression is true but execution
4744cce7d176Sdrh ** continues straight thru if the expression is false.
4745f5905aa7Sdrh **
4746f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false), then
474735573356Sdrh ** take the jump if the jumpIfNull flag is SQLITE_JUMPIFNULL.
4748f2bc013cSdrh **
4749f2bc013cSdrh ** This code depends on the fact that certain token values (ex: TK_EQ)
4750f2bc013cSdrh ** are the same as opcode values (ex: OP_Eq) that implement the corresponding
4751f2bc013cSdrh ** operation.  Special comments in vdbe.c and the mkopcodeh.awk script in
4752f2bc013cSdrh ** the make process cause these values to align.  Assert()s in the code
4753f2bc013cSdrh ** below verify that the numbers are aligned correctly.
4754cce7d176Sdrh */
47554adee20fSdanielk1977 void sqlite3ExprIfTrue(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
4756cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
4757cce7d176Sdrh   int op = 0;
47582dcef11bSdrh   int regFree1 = 0;
47592dcef11bSdrh   int regFree2 = 0;
47602dcef11bSdrh   int r1, r2;
47612dcef11bSdrh 
476235573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
476348864df9Smistachkin   if( NEVER(v==0) )     return;  /* Existence of VDBE checked by caller */
476433cd4909Sdrh   if( NEVER(pExpr==0) ) return;  /* No way this can happen */
4765f2bc013cSdrh   op = pExpr->op;
47667b35a77bSdan   switch( op ){
476717180fcaSdrh     case TK_AND:
476817180fcaSdrh     case TK_OR: {
476917180fcaSdrh       Expr *pAlt = sqlite3ExprSimplifiedAndOr(pExpr);
477017180fcaSdrh       if( pAlt!=pExpr ){
477117180fcaSdrh         sqlite3ExprIfTrue(pParse, pAlt, dest, jumpIfNull);
477217180fcaSdrh       }else if( op==TK_AND ){
4773ec4ccdbcSdrh         int d2 = sqlite3VdbeMakeLabel(pParse);
4774c5499befSdrh         testcase( jumpIfNull==0 );
477517180fcaSdrh         sqlite3ExprIfFalse(pParse, pExpr->pLeft, d2,
477617180fcaSdrh                            jumpIfNull^SQLITE_JUMPIFNULL);
47774adee20fSdanielk1977         sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
47784adee20fSdanielk1977         sqlite3VdbeResolveLabel(v, d2);
477917180fcaSdrh       }else{
4780c5499befSdrh         testcase( jumpIfNull==0 );
47814adee20fSdanielk1977         sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
47824adee20fSdanielk1977         sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
478317180fcaSdrh       }
4784cce7d176Sdrh       break;
4785cce7d176Sdrh     }
4786cce7d176Sdrh     case TK_NOT: {
4787c5499befSdrh       testcase( jumpIfNull==0 );
47884adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
4789cce7d176Sdrh       break;
4790cce7d176Sdrh     }
47918abed7b9Sdrh     case TK_TRUTH: {
479296acafbeSdrh       int isNot;      /* IS NOT TRUE or IS NOT FALSE */
479396acafbeSdrh       int isTrue;     /* IS TRUE or IS NOT TRUE */
4794007c843bSdrh       testcase( jumpIfNull==0 );
47958abed7b9Sdrh       isNot = pExpr->op2==TK_ISNOT;
479696acafbeSdrh       isTrue = sqlite3ExprTruthValue(pExpr->pRight);
479743c4ac8bSdrh       testcase( isTrue && isNot );
479896acafbeSdrh       testcase( !isTrue && isNot );
479943c4ac8bSdrh       if( isTrue ^ isNot ){
48008abed7b9Sdrh         sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
48018abed7b9Sdrh                           isNot ? SQLITE_JUMPIFNULL : 0);
48028abed7b9Sdrh       }else{
48038abed7b9Sdrh         sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
48048abed7b9Sdrh                            isNot ? SQLITE_JUMPIFNULL : 0);
48058abed7b9Sdrh       }
4806007c843bSdrh       break;
4807007c843bSdrh     }
4808de845c2fSdrh     case TK_IS:
4809de845c2fSdrh     case TK_ISNOT:
4810de845c2fSdrh       testcase( op==TK_IS );
4811de845c2fSdrh       testcase( op==TK_ISNOT );
4812de845c2fSdrh       op = (op==TK_IS) ? TK_EQ : TK_NE;
4813de845c2fSdrh       jumpIfNull = SQLITE_NULLEQ;
4814de845c2fSdrh       /* Fall thru */
4815cce7d176Sdrh     case TK_LT:
4816cce7d176Sdrh     case TK_LE:
4817cce7d176Sdrh     case TK_GT:
4818cce7d176Sdrh     case TK_GE:
4819cce7d176Sdrh     case TK_NE:
48200ac65892Sdrh     case TK_EQ: {
4821625015e0Sdan       if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
4822c5499befSdrh       testcase( jumpIfNull==0 );
4823b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4824b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
482535573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
4826898c527eSdrh                   r1, r2, dest, jumpIfNull, ExprHasProperty(pExpr,EP_Commuted));
48277d176105Sdrh       assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
48287d176105Sdrh       assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
48297d176105Sdrh       assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
48307d176105Sdrh       assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
4831de845c2fSdrh       assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
4832de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
4833de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
4834de845c2fSdrh       assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
4835de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
4836de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
48376a2fe093Sdrh       testcase( regFree1==0 );
48386a2fe093Sdrh       testcase( regFree2==0 );
48396a2fe093Sdrh       break;
48406a2fe093Sdrh     }
4841cce7d176Sdrh     case TK_ISNULL:
4842cce7d176Sdrh     case TK_NOTNULL: {
48437d176105Sdrh       assert( TK_ISNULL==OP_IsNull );   testcase( op==TK_ISNULL );
48447d176105Sdrh       assert( TK_NOTNULL==OP_NotNull ); testcase( op==TK_NOTNULL );
48452dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
48462dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
48477d176105Sdrh       VdbeCoverageIf(v, op==TK_ISNULL);
48487d176105Sdrh       VdbeCoverageIf(v, op==TK_NOTNULL);
4849c5499befSdrh       testcase( regFree1==0 );
4850cce7d176Sdrh       break;
4851cce7d176Sdrh     }
4852fef5208cSdrh     case TK_BETWEEN: {
48535c03f30aSdrh       testcase( jumpIfNull==0 );
485471c57db0Sdan       exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfTrue, jumpIfNull);
4855fef5208cSdrh       break;
4856fef5208cSdrh     }
4857bb201344Sshaneh #ifndef SQLITE_OMIT_SUBQUERY
4858e3365e6cSdrh     case TK_IN: {
4859ec4ccdbcSdrh       int destIfFalse = sqlite3VdbeMakeLabel(pParse);
4860e3365e6cSdrh       int destIfNull = jumpIfNull ? dest : destIfFalse;
4861e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
4862076e85f5Sdrh       sqlite3VdbeGoto(v, dest);
4863e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
4864e3365e6cSdrh       break;
4865e3365e6cSdrh     }
4866bb201344Sshaneh #endif
4867cce7d176Sdrh     default: {
48687b35a77bSdan     default_expr:
4869ad31727fSdrh       if( ExprAlwaysTrue(pExpr) ){
4870076e85f5Sdrh         sqlite3VdbeGoto(v, dest);
4871ad31727fSdrh       }else if( ExprAlwaysFalse(pExpr) ){
4872991a1985Sdrh         /* No-op */
4873991a1985Sdrh       }else{
48742dcef11bSdrh         r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
48752dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_If, r1, dest, jumpIfNull!=0);
4876688852abSdrh         VdbeCoverage(v);
4877c5499befSdrh         testcase( regFree1==0 );
4878c5499befSdrh         testcase( jumpIfNull==0 );
4879991a1985Sdrh       }
4880cce7d176Sdrh       break;
4881cce7d176Sdrh     }
4882cce7d176Sdrh   }
48832dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
48842dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
4885cce7d176Sdrh }
4886cce7d176Sdrh 
4887cce7d176Sdrh /*
488866b89c8fSdrh ** Generate code for a boolean expression such that a jump is made
4889cce7d176Sdrh ** to the label "dest" if the expression is false but execution
4890cce7d176Sdrh ** continues straight thru if the expression is true.
4891f5905aa7Sdrh **
4892f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false) then
489335573356Sdrh ** jump if jumpIfNull is SQLITE_JUMPIFNULL or fall through if jumpIfNull
489435573356Sdrh ** is 0.
4895cce7d176Sdrh */
48964adee20fSdanielk1977 void sqlite3ExprIfFalse(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
4897cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
4898cce7d176Sdrh   int op = 0;
48992dcef11bSdrh   int regFree1 = 0;
49002dcef11bSdrh   int regFree2 = 0;
49012dcef11bSdrh   int r1, r2;
49022dcef11bSdrh 
490335573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
490448864df9Smistachkin   if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
490533cd4909Sdrh   if( pExpr==0 )    return;
4906f2bc013cSdrh 
4907f2bc013cSdrh   /* The value of pExpr->op and op are related as follows:
4908f2bc013cSdrh   **
4909f2bc013cSdrh   **       pExpr->op            op
4910f2bc013cSdrh   **       ---------          ----------
4911f2bc013cSdrh   **       TK_ISNULL          OP_NotNull
4912f2bc013cSdrh   **       TK_NOTNULL         OP_IsNull
4913f2bc013cSdrh   **       TK_NE              OP_Eq
4914f2bc013cSdrh   **       TK_EQ              OP_Ne
4915f2bc013cSdrh   **       TK_GT              OP_Le
4916f2bc013cSdrh   **       TK_LE              OP_Gt
4917f2bc013cSdrh   **       TK_GE              OP_Lt
4918f2bc013cSdrh   **       TK_LT              OP_Ge
4919f2bc013cSdrh   **
4920f2bc013cSdrh   ** For other values of pExpr->op, op is undefined and unused.
4921f2bc013cSdrh   ** The value of TK_ and OP_ constants are arranged such that we
4922f2bc013cSdrh   ** can compute the mapping above using the following expression.
4923f2bc013cSdrh   ** Assert()s verify that the computation is correct.
4924f2bc013cSdrh   */
4925f2bc013cSdrh   op = ((pExpr->op+(TK_ISNULL&1))^1)-(TK_ISNULL&1);
4926f2bc013cSdrh 
4927f2bc013cSdrh   /* Verify correct alignment of TK_ and OP_ constants
4928f2bc013cSdrh   */
4929f2bc013cSdrh   assert( pExpr->op!=TK_ISNULL || op==OP_NotNull );
4930f2bc013cSdrh   assert( pExpr->op!=TK_NOTNULL || op==OP_IsNull );
4931f2bc013cSdrh   assert( pExpr->op!=TK_NE || op==OP_Eq );
4932f2bc013cSdrh   assert( pExpr->op!=TK_EQ || op==OP_Ne );
4933f2bc013cSdrh   assert( pExpr->op!=TK_LT || op==OP_Ge );
4934f2bc013cSdrh   assert( pExpr->op!=TK_LE || op==OP_Gt );
4935f2bc013cSdrh   assert( pExpr->op!=TK_GT || op==OP_Le );
4936f2bc013cSdrh   assert( pExpr->op!=TK_GE || op==OP_Lt );
4937f2bc013cSdrh 
4938ba00e30aSdan   switch( pExpr->op ){
493917180fcaSdrh     case TK_AND:
494017180fcaSdrh     case TK_OR: {
494117180fcaSdrh       Expr *pAlt = sqlite3ExprSimplifiedAndOr(pExpr);
494217180fcaSdrh       if( pAlt!=pExpr ){
494317180fcaSdrh         sqlite3ExprIfFalse(pParse, pAlt, dest, jumpIfNull);
494417180fcaSdrh       }else if( pExpr->op==TK_AND ){
4945c5499befSdrh         testcase( jumpIfNull==0 );
49464adee20fSdanielk1977         sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
49474adee20fSdanielk1977         sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
494817180fcaSdrh       }else{
4949ec4ccdbcSdrh         int d2 = sqlite3VdbeMakeLabel(pParse);
4950c5499befSdrh         testcase( jumpIfNull==0 );
495117180fcaSdrh         sqlite3ExprIfTrue(pParse, pExpr->pLeft, d2,
495217180fcaSdrh                           jumpIfNull^SQLITE_JUMPIFNULL);
49534adee20fSdanielk1977         sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
49544adee20fSdanielk1977         sqlite3VdbeResolveLabel(v, d2);
495517180fcaSdrh       }
4956cce7d176Sdrh       break;
4957cce7d176Sdrh     }
4958cce7d176Sdrh     case TK_NOT: {
49595c03f30aSdrh       testcase( jumpIfNull==0 );
49604adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
4961cce7d176Sdrh       break;
4962cce7d176Sdrh     }
49638abed7b9Sdrh     case TK_TRUTH: {
496496acafbeSdrh       int isNot;   /* IS NOT TRUE or IS NOT FALSE */
496596acafbeSdrh       int isTrue;  /* IS TRUE or IS NOT TRUE */
49668abed7b9Sdrh       testcase( jumpIfNull==0 );
49678abed7b9Sdrh       isNot = pExpr->op2==TK_ISNOT;
496896acafbeSdrh       isTrue = sqlite3ExprTruthValue(pExpr->pRight);
496943c4ac8bSdrh       testcase( isTrue && isNot );
497096acafbeSdrh       testcase( !isTrue && isNot );
497143c4ac8bSdrh       if( isTrue ^ isNot ){
49728abed7b9Sdrh         /* IS TRUE and IS NOT FALSE */
49738abed7b9Sdrh         sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest,
49748abed7b9Sdrh                            isNot ? 0 : SQLITE_JUMPIFNULL);
49758abed7b9Sdrh 
49768abed7b9Sdrh       }else{
49778abed7b9Sdrh         /* IS FALSE and IS NOT TRUE */
49788abed7b9Sdrh         sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest,
49798abed7b9Sdrh                           isNot ? 0 : SQLITE_JUMPIFNULL);
49808abed7b9Sdrh       }
4981007c843bSdrh       break;
4982007c843bSdrh     }
4983de845c2fSdrh     case TK_IS:
4984de845c2fSdrh     case TK_ISNOT:
4985de845c2fSdrh       testcase( pExpr->op==TK_IS );
4986de845c2fSdrh       testcase( pExpr->op==TK_ISNOT );
4987de845c2fSdrh       op = (pExpr->op==TK_IS) ? TK_NE : TK_EQ;
4988de845c2fSdrh       jumpIfNull = SQLITE_NULLEQ;
4989de845c2fSdrh       /* Fall thru */
4990cce7d176Sdrh     case TK_LT:
4991cce7d176Sdrh     case TK_LE:
4992cce7d176Sdrh     case TK_GT:
4993cce7d176Sdrh     case TK_GE:
4994cce7d176Sdrh     case TK_NE:
4995cce7d176Sdrh     case TK_EQ: {
4996625015e0Sdan       if( sqlite3ExprIsVector(pExpr->pLeft) ) goto default_expr;
4997c5499befSdrh       testcase( jumpIfNull==0 );
4998b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
4999b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
500035573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
5001898c527eSdrh                   r1, r2, dest, jumpIfNull,ExprHasProperty(pExpr,EP_Commuted));
50027d176105Sdrh       assert(TK_LT==OP_Lt); testcase(op==OP_Lt); VdbeCoverageIf(v,op==OP_Lt);
50037d176105Sdrh       assert(TK_LE==OP_Le); testcase(op==OP_Le); VdbeCoverageIf(v,op==OP_Le);
50047d176105Sdrh       assert(TK_GT==OP_Gt); testcase(op==OP_Gt); VdbeCoverageIf(v,op==OP_Gt);
50057d176105Sdrh       assert(TK_GE==OP_Ge); testcase(op==OP_Ge); VdbeCoverageIf(v,op==OP_Ge);
5006de845c2fSdrh       assert(TK_EQ==OP_Eq); testcase(op==OP_Eq);
5007de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull!=SQLITE_NULLEQ);
5008de845c2fSdrh       VdbeCoverageIf(v, op==OP_Eq && jumpIfNull==SQLITE_NULLEQ);
5009de845c2fSdrh       assert(TK_NE==OP_Ne); testcase(op==OP_Ne);
5010de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull!=SQLITE_NULLEQ);
5011de845c2fSdrh       VdbeCoverageIf(v, op==OP_Ne && jumpIfNull==SQLITE_NULLEQ);
50126a2fe093Sdrh       testcase( regFree1==0 );
50136a2fe093Sdrh       testcase( regFree2==0 );
50146a2fe093Sdrh       break;
50156a2fe093Sdrh     }
5016cce7d176Sdrh     case TK_ISNULL:
5017cce7d176Sdrh     case TK_NOTNULL: {
50182dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
50192dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
50207d176105Sdrh       testcase( op==TK_ISNULL );   VdbeCoverageIf(v, op==TK_ISNULL);
50217d176105Sdrh       testcase( op==TK_NOTNULL );  VdbeCoverageIf(v, op==TK_NOTNULL);
5022c5499befSdrh       testcase( regFree1==0 );
5023cce7d176Sdrh       break;
5024cce7d176Sdrh     }
5025fef5208cSdrh     case TK_BETWEEN: {
50265c03f30aSdrh       testcase( jumpIfNull==0 );
502771c57db0Sdan       exprCodeBetween(pParse, pExpr, dest, sqlite3ExprIfFalse, jumpIfNull);
5028fef5208cSdrh       break;
5029fef5208cSdrh     }
5030bb201344Sshaneh #ifndef SQLITE_OMIT_SUBQUERY
5031e3365e6cSdrh     case TK_IN: {
5032e3365e6cSdrh       if( jumpIfNull ){
5033e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, dest);
5034e3365e6cSdrh       }else{
5035ec4ccdbcSdrh         int destIfNull = sqlite3VdbeMakeLabel(pParse);
5036e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, destIfNull);
5037e3365e6cSdrh         sqlite3VdbeResolveLabel(v, destIfNull);
5038e3365e6cSdrh       }
5039e3365e6cSdrh       break;
5040e3365e6cSdrh     }
5041bb201344Sshaneh #endif
5042cce7d176Sdrh     default: {
5043ba00e30aSdan     default_expr:
5044ad31727fSdrh       if( ExprAlwaysFalse(pExpr) ){
5045076e85f5Sdrh         sqlite3VdbeGoto(v, dest);
5046ad31727fSdrh       }else if( ExprAlwaysTrue(pExpr) ){
5047991a1985Sdrh         /* no-op */
5048991a1985Sdrh       }else{
50492dcef11bSdrh         r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
50502dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_IfNot, r1, dest, jumpIfNull!=0);
5051688852abSdrh         VdbeCoverage(v);
5052c5499befSdrh         testcase( regFree1==0 );
5053c5499befSdrh         testcase( jumpIfNull==0 );
5054991a1985Sdrh       }
5055cce7d176Sdrh       break;
5056cce7d176Sdrh     }
5057cce7d176Sdrh   }
50582dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
50592dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
5060cce7d176Sdrh }
50612282792aSdrh 
50622282792aSdrh /*
506372bc8208Sdrh ** Like sqlite3ExprIfFalse() except that a copy is made of pExpr before
506472bc8208Sdrh ** code generation, and that copy is deleted after code generation. This
506572bc8208Sdrh ** ensures that the original pExpr is unchanged.
506672bc8208Sdrh */
506772bc8208Sdrh void sqlite3ExprIfFalseDup(Parse *pParse, Expr *pExpr, int dest,int jumpIfNull){
506872bc8208Sdrh   sqlite3 *db = pParse->db;
506972bc8208Sdrh   Expr *pCopy = sqlite3ExprDup(db, pExpr, 0);
507072bc8208Sdrh   if( db->mallocFailed==0 ){
507172bc8208Sdrh     sqlite3ExprIfFalse(pParse, pCopy, dest, jumpIfNull);
507272bc8208Sdrh   }
507372bc8208Sdrh   sqlite3ExprDelete(db, pCopy);
507472bc8208Sdrh }
507572bc8208Sdrh 
50765aa550cfSdan /*
50775aa550cfSdan ** Expression pVar is guaranteed to be an SQL variable. pExpr may be any
50785aa550cfSdan ** type of expression.
50795aa550cfSdan **
50805aa550cfSdan ** If pExpr is a simple SQL value - an integer, real, string, blob
50815aa550cfSdan ** or NULL value - then the VDBE currently being prepared is configured
50825aa550cfSdan ** to re-prepare each time a new value is bound to variable pVar.
50835aa550cfSdan **
50845aa550cfSdan ** Additionally, if pExpr is a simple SQL value and the value is the
50855aa550cfSdan ** same as that currently bound to variable pVar, non-zero is returned.
50865aa550cfSdan ** Otherwise, if the values are not the same or if pExpr is not a simple
50875aa550cfSdan ** SQL value, zero is returned.
50885aa550cfSdan */
50895aa550cfSdan static int exprCompareVariable(Parse *pParse, Expr *pVar, Expr *pExpr){
50905aa550cfSdan   int res = 0;
5091c0804226Sdrh   int iVar;
5092c0804226Sdrh   sqlite3_value *pL, *pR = 0;
50935aa550cfSdan 
50945aa550cfSdan   sqlite3ValueFromExpr(pParse->db, pExpr, SQLITE_UTF8, SQLITE_AFF_BLOB, &pR);
5095c0804226Sdrh   if( pR ){
5096c0804226Sdrh     iVar = pVar->iColumn;
5097c0804226Sdrh     sqlite3VdbeSetVarmask(pParse->pVdbe, iVar);
5098c0804226Sdrh     pL = sqlite3VdbeGetBoundValue(pParse->pReprepare, iVar, SQLITE_AFF_BLOB);
50995aa307e2Sdrh     if( pL ){
51005aa307e2Sdrh       if( sqlite3_value_type(pL)==SQLITE_TEXT ){
51015aa307e2Sdrh         sqlite3_value_text(pL); /* Make sure the encoding is UTF-8 */
51025aa307e2Sdrh       }
51035aa307e2Sdrh       res =  0==sqlite3MemCompare(pL, pR, 0);
51045aa550cfSdan     }
51055aa550cfSdan     sqlite3ValueFree(pR);
51065aa550cfSdan     sqlite3ValueFree(pL);
51075aa550cfSdan   }
51085aa550cfSdan 
51095aa550cfSdan   return res;
51105aa550cfSdan }
511172bc8208Sdrh 
511272bc8208Sdrh /*
51131d9da70aSdrh ** Do a deep comparison of two expression trees.  Return 0 if the two
51141d9da70aSdrh ** expressions are completely identical.  Return 1 if they differ only
51151d9da70aSdrh ** by a COLLATE operator at the top level.  Return 2 if there are differences
51161d9da70aSdrh ** other than the top-level COLLATE operator.
5117d40aab0eSdrh **
5118619a1305Sdrh ** If any subelement of pB has Expr.iTable==(-1) then it is allowed
5119619a1305Sdrh ** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
5120619a1305Sdrh **
512166518ca7Sdrh ** The pA side might be using TK_REGISTER.  If that is the case and pB is
512266518ca7Sdrh ** not using TK_REGISTER but is otherwise equivalent, then still return 0.
512366518ca7Sdrh **
51241d9da70aSdrh ** Sometimes this routine will return 2 even if the two expressions
5125d40aab0eSdrh ** really are equivalent.  If we cannot prove that the expressions are
51261d9da70aSdrh ** identical, we return 2 just to be safe.  So if this routine
51271d9da70aSdrh ** returns 2, then you do not really know for certain if the two
51281d9da70aSdrh ** expressions are the same.  But if you get a 0 or 1 return, then you
5129d40aab0eSdrh ** can be sure the expressions are the same.  In the places where
51301d9da70aSdrh ** this routine is used, it does not hurt to get an extra 2 - that
5131d40aab0eSdrh ** just might result in some slightly slower code.  But returning
51321d9da70aSdrh ** an incorrect 0 or 1 could lead to a malfunction.
51335aa550cfSdan **
5134c0804226Sdrh ** If pParse is not NULL then TK_VARIABLE terms in pA with bindings in
5135c0804226Sdrh ** pParse->pReprepare can be matched against literals in pB.  The
5136c0804226Sdrh ** pParse->pVdbe->expmask bitmask is updated for each variable referenced.
5137c0804226Sdrh ** If pParse is NULL (the normal case) then any TK_VARIABLE term in
5138c0804226Sdrh ** Argument pParse should normally be NULL. If it is not NULL and pA or
5139c0804226Sdrh ** pB causes a return value of 2.
51402282792aSdrh */
51415aa550cfSdan int sqlite3ExprCompare(Parse *pParse, Expr *pA, Expr *pB, int iTab){
514210d1edf0Sdrh   u32 combinedFlags;
51434b202ae2Sdanielk1977   if( pA==0 || pB==0 ){
51441d9da70aSdrh     return pB==pA ? 0 : 2;
51452282792aSdrh   }
51465aa550cfSdan   if( pParse && pA->op==TK_VARIABLE && exprCompareVariable(pParse, pA, pB) ){
51475aa550cfSdan     return 0;
51485aa550cfSdan   }
514910d1edf0Sdrh   combinedFlags = pA->flags | pB->flags;
515010d1edf0Sdrh   if( combinedFlags & EP_IntValue ){
515110d1edf0Sdrh     if( (pA->flags&pB->flags&EP_IntValue)!=0 && pA->u.iValue==pB->u.iValue ){
515210d1edf0Sdrh       return 0;
515310d1edf0Sdrh     }
51541d9da70aSdrh     return 2;
51556ab3a2ecSdanielk1977   }
515616dd3985Sdan   if( pA->op!=pB->op || pA->op==TK_RAISE ){
51575aa550cfSdan     if( pA->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA->pLeft,pB,iTab)<2 ){
5158ae80ddeaSdrh       return 1;
5159ae80ddeaSdrh     }
51605aa550cfSdan     if( pB->op==TK_COLLATE && sqlite3ExprCompare(pParse, pA,pB->pLeft,iTab)<2 ){
5161ae80ddeaSdrh       return 1;
5162ae80ddeaSdrh     }
5163ae80ddeaSdrh     return 2;
5164ae80ddeaSdrh   }
51652edc5fd7Sdrh   if( pA->op!=TK_COLUMN && pA->op!=TK_AGG_COLUMN && pA->u.zToken ){
51664f9adee2Sdan     if( pA->op==TK_FUNCTION || pA->op==TK_AGG_FUNCTION ){
5167390b88a4Sdrh       if( sqlite3StrICmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
5168eda079cdSdrh #ifndef SQLITE_OMIT_WINDOWFUNC
51694f9adee2Sdan       assert( pA->op==pB->op );
51704f9adee2Sdan       if( ExprHasProperty(pA,EP_WinFunc)!=ExprHasProperty(pB,EP_WinFunc) ){
51714f9adee2Sdan         return 2;
51724f9adee2Sdan       }
5173eda079cdSdrh       if( ExprHasProperty(pA,EP_WinFunc) ){
51744f9adee2Sdan         if( sqlite3WindowCompare(pParse, pA->y.pWin, pB->y.pWin, 1)!=0 ){
51754f9adee2Sdan           return 2;
51764f9adee2Sdan         }
5177eda079cdSdrh       }
5178eda079cdSdrh #endif
5179f20bbc5fSdrh     }else if( pA->op==TK_NULL ){
5180f20bbc5fSdrh       return 0;
5181d5af5420Sdrh     }else if( pA->op==TK_COLLATE ){
5182e79f6299Sdrh       if( sqlite3_stricmp(pA->u.zToken,pB->u.zToken)!=0 ) return 2;
5183f20bbc5fSdrh     }else if( ALWAYS(pB->u.zToken!=0) && strcmp(pA->u.zToken,pB->u.zToken)!=0 ){
5184d5af5420Sdrh       return 2;
518510d1edf0Sdrh     }
518610d1edf0Sdrh   }
5187898c527eSdrh   if( (pA->flags & (EP_Distinct|EP_Commuted))
5188898c527eSdrh      != (pB->flags & (EP_Distinct|EP_Commuted)) ) return 2;
518989b6de03Sdrh   if( (combinedFlags & EP_TokenOnly)==0 ){
519010d1edf0Sdrh     if( combinedFlags & EP_xIsSelect ) return 2;
5191efad2e23Sdrh     if( (combinedFlags & EP_FixedCol)==0
5192efad2e23Sdrh      && sqlite3ExprCompare(pParse, pA->pLeft, pB->pLeft, iTab) ) return 2;
51935aa550cfSdan     if( sqlite3ExprCompare(pParse, pA->pRight, pB->pRight, iTab) ) return 2;
5194619a1305Sdrh     if( sqlite3ExprListCompare(pA->x.pList, pB->x.pList, iTab) ) return 2;
519503c5c213Sdrh     if( pA->op!=TK_STRING
519603c5c213Sdrh      && pA->op!=TK_TRUEFALSE
519703c5c213Sdrh      && (combinedFlags & EP_Reduced)==0
519803c5c213Sdrh     ){
5199619a1305Sdrh       if( pA->iColumn!=pB->iColumn ) return 2;
520004307c8aSdrh       if( pA->op2!=pB->op2 ){
520104307c8aSdrh         if( pA->op==TK_TRUTH ) return 2;
520204307c8aSdrh         if( pA->op==TK_FUNCTION && iTab<0 ){
520304307c8aSdrh           /* Ex: CREATE TABLE t1(a CHECK( a<julianday('now') ));
520404307c8aSdrh           **     INSERT INTO t1(a) VALUES(julianday('now')+10);
520504307c8aSdrh           ** Without this test, sqlite3ExprCodeAtInit() will run on the
520604307c8aSdrh           ** the julianday() of INSERT first, and remember that expression.
520704307c8aSdrh           ** Then sqlite3ExprCodeInit() will see the julianday() in the CHECK
520804307c8aSdrh           ** constraint as redundant, reusing the one from the INSERT, even
520904307c8aSdrh           ** though the julianday() in INSERT lacks the critical NC_IsCheck
521004307c8aSdrh           ** flag.  See ticket [830277d9db6c3ba1] (2019-10-30)
521104307c8aSdrh           */
521204307c8aSdrh           return 2;
521304307c8aSdrh         }
521404307c8aSdrh       }
52150f28e1bdSdrh       if( pA->op!=TK_IN && pA->iTable!=pB->iTable && pA->iTable!=iTab ){
52160f28e1bdSdrh         return 2;
52170f28e1bdSdrh       }
52181d9da70aSdrh     }
52191d9da70aSdrh   }
52202646da7eSdrh   return 0;
52212646da7eSdrh }
52222282792aSdrh 
52238c6f666bSdrh /*
52248c6f666bSdrh ** Compare two ExprList objects.  Return 0 if they are identical and
52258c6f666bSdrh ** non-zero if they differ in any way.
52268c6f666bSdrh **
5227619a1305Sdrh ** If any subelement of pB has Expr.iTable==(-1) then it is allowed
5228619a1305Sdrh ** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
5229619a1305Sdrh **
52308c6f666bSdrh ** This routine might return non-zero for equivalent ExprLists.  The
52318c6f666bSdrh ** only consequence will be disabled optimizations.  But this routine
52328c6f666bSdrh ** must never return 0 if the two ExprList objects are different, or
52338c6f666bSdrh ** a malfunction will result.
52348c6f666bSdrh **
52358c6f666bSdrh ** Two NULL pointers are considered to be the same.  But a NULL pointer
52368c6f666bSdrh ** always differs from a non-NULL pointer.
52378c6f666bSdrh */
5238619a1305Sdrh int sqlite3ExprListCompare(ExprList *pA, ExprList *pB, int iTab){
52398c6f666bSdrh   int i;
52408c6f666bSdrh   if( pA==0 && pB==0 ) return 0;
52418c6f666bSdrh   if( pA==0 || pB==0 ) return 1;
52428c6f666bSdrh   if( pA->nExpr!=pB->nExpr ) return 1;
52438c6f666bSdrh   for(i=0; i<pA->nExpr; i++){
52448c6f666bSdrh     Expr *pExprA = pA->a[i].pExpr;
52458c6f666bSdrh     Expr *pExprB = pB->a[i].pExpr;
52466e11892dSdan     if( pA->a[i].sortFlags!=pB->a[i].sortFlags ) return 1;
52475aa550cfSdan     if( sqlite3ExprCompare(0, pExprA, pExprB, iTab) ) return 1;
52488c6f666bSdrh   }
52498c6f666bSdrh   return 0;
52508c6f666bSdrh }
525113449892Sdrh 
52522282792aSdrh /*
5253f9463dfbSdrh ** Like sqlite3ExprCompare() except COLLATE operators at the top-level
5254f9463dfbSdrh ** are ignored.
5255f9463dfbSdrh */
5256f9463dfbSdrh int sqlite3ExprCompareSkip(Expr *pA, Expr *pB, int iTab){
52575aa550cfSdan   return sqlite3ExprCompare(0,
52580d950af3Sdrh              sqlite3ExprSkipCollateAndLikely(pA),
52590d950af3Sdrh              sqlite3ExprSkipCollateAndLikely(pB),
5260f9463dfbSdrh              iTab);
5261f9463dfbSdrh }
5262f9463dfbSdrh 
5263f9463dfbSdrh /*
5264c51cf864Sdrh ** Return non-zero if Expr p can only be true if pNN is not NULL.
52657a231b49Sdrh **
52667a231b49Sdrh ** Or if seenNot is true, return non-zero if Expr p can only be
52677a231b49Sdrh ** non-NULL if pNN is not NULL
5268c51cf864Sdrh */
5269c51cf864Sdrh static int exprImpliesNotNull(
5270c51cf864Sdrh   Parse *pParse,      /* Parsing context */
5271c51cf864Sdrh   Expr *p,            /* The expression to be checked */
5272c51cf864Sdrh   Expr *pNN,          /* The expression that is NOT NULL */
5273c51cf864Sdrh   int iTab,           /* Table being evaluated */
52747a231b49Sdrh   int seenNot         /* Return true only if p can be any non-NULL value */
5275c51cf864Sdrh ){
5276c51cf864Sdrh   assert( p );
5277c51cf864Sdrh   assert( pNN );
527814c865e8Sdrh   if( sqlite3ExprCompare(pParse, p, pNN, iTab)==0 ){
527914c865e8Sdrh     return pNN->op!=TK_NULL;
528014c865e8Sdrh   }
5281c51cf864Sdrh   switch( p->op ){
5282c51cf864Sdrh     case TK_IN: {
5283c51cf864Sdrh       if( seenNot && ExprHasProperty(p, EP_xIsSelect) ) return 0;
5284c51cf864Sdrh       assert( ExprHasProperty(p,EP_xIsSelect)
5285c51cf864Sdrh            || (p->x.pList!=0 && p->x.pList->nExpr>0) );
5286ae144a1cSdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
5287c51cf864Sdrh     }
5288c51cf864Sdrh     case TK_BETWEEN: {
5289c51cf864Sdrh       ExprList *pList = p->x.pList;
5290c51cf864Sdrh       assert( pList!=0 );
5291c51cf864Sdrh       assert( pList->nExpr==2 );
5292c51cf864Sdrh       if( seenNot ) return 0;
52937a231b49Sdrh       if( exprImpliesNotNull(pParse, pList->a[0].pExpr, pNN, iTab, 1)
52947a231b49Sdrh        || exprImpliesNotNull(pParse, pList->a[1].pExpr, pNN, iTab, 1)
5295c51cf864Sdrh       ){
5296c51cf864Sdrh         return 1;
5297c51cf864Sdrh       }
52987a231b49Sdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
5299c51cf864Sdrh     }
5300c51cf864Sdrh     case TK_EQ:
5301c51cf864Sdrh     case TK_NE:
5302c51cf864Sdrh     case TK_LT:
5303c51cf864Sdrh     case TK_LE:
5304c51cf864Sdrh     case TK_GT:
5305c51cf864Sdrh     case TK_GE:
5306c51cf864Sdrh     case TK_PLUS:
5307c51cf864Sdrh     case TK_MINUS:
53089d23ea74Sdan     case TK_BITOR:
53099d23ea74Sdan     case TK_LSHIFT:
53109d23ea74Sdan     case TK_RSHIFT:
53119d23ea74Sdan     case TK_CONCAT:
53129d23ea74Sdan       seenNot = 1;
53139d23ea74Sdan       /* Fall thru */
5314c51cf864Sdrh     case TK_STAR:
5315c51cf864Sdrh     case TK_REM:
5316c51cf864Sdrh     case TK_BITAND:
53179d23ea74Sdan     case TK_SLASH: {
5318c51cf864Sdrh       if( exprImpliesNotNull(pParse, p->pRight, pNN, iTab, seenNot) ) return 1;
5319c51cf864Sdrh       /* Fall thru into the next case */
5320c51cf864Sdrh     }
5321c51cf864Sdrh     case TK_SPAN:
5322c51cf864Sdrh     case TK_COLLATE:
5323c51cf864Sdrh     case TK_UPLUS:
5324c51cf864Sdrh     case TK_UMINUS: {
5325c51cf864Sdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, seenNot);
5326c51cf864Sdrh     }
5327c51cf864Sdrh     case TK_TRUTH: {
5328c51cf864Sdrh       if( seenNot ) return 0;
5329c51cf864Sdrh       if( p->op2!=TK_IS ) return 0;
533038cefc83Sdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
5331c51cf864Sdrh     }
53321cd382e3Sdan     case TK_BITNOT:
5333c51cf864Sdrh     case TK_NOT: {
5334c51cf864Sdrh       return exprImpliesNotNull(pParse, p->pLeft, pNN, iTab, 1);
5335c51cf864Sdrh     }
5336c51cf864Sdrh   }
5337c51cf864Sdrh   return 0;
5338c51cf864Sdrh }
5339c51cf864Sdrh 
5340c51cf864Sdrh /*
53414bd5f73fSdrh ** Return true if we can prove the pE2 will always be true if pE1 is
53424bd5f73fSdrh ** true.  Return false if we cannot complete the proof or if pE2 might
53434bd5f73fSdrh ** be false.  Examples:
53444bd5f73fSdrh **
5345619a1305Sdrh **     pE1: x==5       pE2: x==5             Result: true
53464bd5f73fSdrh **     pE1: x>0        pE2: x==5             Result: false
5347619a1305Sdrh **     pE1: x=21       pE2: x=21 OR y=43     Result: true
53484bd5f73fSdrh **     pE1: x!=123     pE2: x IS NOT NULL    Result: true
5349619a1305Sdrh **     pE1: x!=?1      pE2: x IS NOT NULL    Result: true
5350619a1305Sdrh **     pE1: x IS NULL  pE2: x IS NOT NULL    Result: false
5351619a1305Sdrh **     pE1: x IS ?2    pE2: x IS NOT NULL    Reuslt: false
53524bd5f73fSdrh **
53534bd5f73fSdrh ** When comparing TK_COLUMN nodes between pE1 and pE2, if pE2 has
53544bd5f73fSdrh ** Expr.iTable<0 then assume a table number given by iTab.
53554bd5f73fSdrh **
5356c0804226Sdrh ** If pParse is not NULL, then the values of bound variables in pE1 are
5357c0804226Sdrh ** compared against literal values in pE2 and pParse->pVdbe->expmask is
5358c0804226Sdrh ** modified to record which bound variables are referenced.  If pParse
5359c0804226Sdrh ** is NULL, then false will be returned if pE1 contains any bound variables.
5360c0804226Sdrh **
53614bd5f73fSdrh ** When in doubt, return false.  Returning true might give a performance
53624bd5f73fSdrh ** improvement.  Returning false might cause a performance reduction, but
53634bd5f73fSdrh ** it will always give the correct answer and is hence always safe.
53644bd5f73fSdrh */
53655aa550cfSdan int sqlite3ExprImpliesExpr(Parse *pParse, Expr *pE1, Expr *pE2, int iTab){
53665aa550cfSdan   if( sqlite3ExprCompare(pParse, pE1, pE2, iTab)==0 ){
5367619a1305Sdrh     return 1;
5368619a1305Sdrh   }
5369619a1305Sdrh   if( pE2->op==TK_OR
53705aa550cfSdan    && (sqlite3ExprImpliesExpr(pParse, pE1, pE2->pLeft, iTab)
53715aa550cfSdan              || sqlite3ExprImpliesExpr(pParse, pE1, pE2->pRight, iTab) )
5372619a1305Sdrh   ){
5373619a1305Sdrh     return 1;
5374619a1305Sdrh   }
5375664d6d13Sdrh   if( pE2->op==TK_NOTNULL
5376c51cf864Sdrh    && exprImpliesNotNull(pParse, pE1, pE2->pLeft, iTab, 0)
5377664d6d13Sdrh   ){
5378c51cf864Sdrh     return 1;
5379619a1305Sdrh   }
5380619a1305Sdrh   return 0;
53814bd5f73fSdrh }
53824bd5f73fSdrh 
53834bd5f73fSdrh /*
53846c68d759Sdrh ** This is the Expr node callback for sqlite3ExprImpliesNonNullRow().
53852589787cSdrh ** If the expression node requires that the table at pWalker->iCur
5386f8937f90Sdrh ** have one or more non-NULL column, then set pWalker->eCode to 1 and abort.
5387f8937f90Sdrh **
5388f8937f90Sdrh ** This routine controls an optimization.  False positives (setting
5389f8937f90Sdrh ** pWalker->eCode to 1 when it should not be) are deadly, but false-negatives
5390f8937f90Sdrh ** (never setting pWalker->eCode) is a harmless missed optimization.
53912589787cSdrh */
53922589787cSdrh static int impliesNotNullRow(Walker *pWalker, Expr *pExpr){
5393f8937f90Sdrh   testcase( pExpr->op==TK_AGG_COLUMN );
5394821b610bSdrh   testcase( pExpr->op==TK_AGG_FUNCTION );
53952589787cSdrh   if( ExprHasProperty(pExpr, EP_FromJoin) ) return WRC_Prune;
53962589787cSdrh   switch( pExpr->op ){
53970493222fSdan     case TK_ISNOT:
53982589787cSdrh     case TK_ISNULL:
5399d5793672Sdrh     case TK_NOTNULL:
54002589787cSdrh     case TK_IS:
54012589787cSdrh     case TK_OR:
54026c68d759Sdrh     case TK_VECTOR:
54032c492061Sdrh     case TK_CASE:
5404e3eff266Sdrh     case TK_IN:
54052589787cSdrh     case TK_FUNCTION:
5406da03c1e6Sdan     case TK_TRUTH:
54070493222fSdan       testcase( pExpr->op==TK_ISNOT );
5408821b610bSdrh       testcase( pExpr->op==TK_ISNULL );
5409d5793672Sdrh       testcase( pExpr->op==TK_NOTNULL );
5410821b610bSdrh       testcase( pExpr->op==TK_IS );
5411821b610bSdrh       testcase( pExpr->op==TK_OR );
54126c68d759Sdrh       testcase( pExpr->op==TK_VECTOR );
5413821b610bSdrh       testcase( pExpr->op==TK_CASE );
5414821b610bSdrh       testcase( pExpr->op==TK_IN );
5415821b610bSdrh       testcase( pExpr->op==TK_FUNCTION );
5416da03c1e6Sdan       testcase( pExpr->op==TK_TRUTH );
54172589787cSdrh       return WRC_Prune;
54182589787cSdrh     case TK_COLUMN:
54192589787cSdrh       if( pWalker->u.iCur==pExpr->iTable ){
54202589787cSdrh         pWalker->eCode = 1;
54212589787cSdrh         return WRC_Abort;
54222589787cSdrh       }
54232589787cSdrh       return WRC_Prune;
54249881155dSdrh 
54259d23ea74Sdan     case TK_AND:
5426aef81674Sdrh       if( pWalker->eCode==0 ){
54270287c951Sdan         sqlite3WalkExpr(pWalker, pExpr->pLeft);
54280287c951Sdan         if( pWalker->eCode ){
54290287c951Sdan           pWalker->eCode = 0;
54300287c951Sdan           sqlite3WalkExpr(pWalker, pExpr->pRight);
54319d23ea74Sdan         }
5432aef81674Sdrh       }
54339d23ea74Sdan       return WRC_Prune;
54349d23ea74Sdan 
54359d23ea74Sdan     case TK_BETWEEN:
54361d24a531Sdan       if( sqlite3WalkExpr(pWalker, pExpr->pLeft)==WRC_Abort ){
54371d24a531Sdan         assert( pWalker->eCode );
54381d24a531Sdan         return WRC_Abort;
54391d24a531Sdan       }
54409d23ea74Sdan       return WRC_Prune;
54419d23ea74Sdan 
54429881155dSdrh     /* Virtual tables are allowed to use constraints like x=NULL.  So
54439881155dSdrh     ** a term of the form x=y does not prove that y is not null if x
54449881155dSdrh     ** is the column of a virtual table */
54459881155dSdrh     case TK_EQ:
54469881155dSdrh     case TK_NE:
54479881155dSdrh     case TK_LT:
54489881155dSdrh     case TK_LE:
54499881155dSdrh     case TK_GT:
54509881155dSdrh     case TK_GE:
54519881155dSdrh       testcase( pExpr->op==TK_EQ );
54529881155dSdrh       testcase( pExpr->op==TK_NE );
54539881155dSdrh       testcase( pExpr->op==TK_LT );
54549881155dSdrh       testcase( pExpr->op==TK_LE );
54559881155dSdrh       testcase( pExpr->op==TK_GT );
54569881155dSdrh       testcase( pExpr->op==TK_GE );
5457eda079cdSdrh       if( (pExpr->pLeft->op==TK_COLUMN && IsVirtual(pExpr->pLeft->y.pTab))
5458eda079cdSdrh        || (pExpr->pRight->op==TK_COLUMN && IsVirtual(pExpr->pRight->y.pTab))
54599881155dSdrh       ){
54609881155dSdrh        return WRC_Prune;
54619881155dSdrh       }
54629d23ea74Sdan 
54632589787cSdrh     default:
54642589787cSdrh       return WRC_Continue;
54652589787cSdrh   }
54662589787cSdrh }
54672589787cSdrh 
54682589787cSdrh /*
54692589787cSdrh ** Return true (non-zero) if expression p can only be true if at least
54702589787cSdrh ** one column of table iTab is non-null.  In other words, return true
54712589787cSdrh ** if expression p will always be NULL or false if every column of iTab
54722589787cSdrh ** is NULL.
54732589787cSdrh **
5474821b610bSdrh ** False negatives are acceptable.  In other words, it is ok to return
5475821b610bSdrh ** zero even if expression p will never be true of every column of iTab
5476821b610bSdrh ** is NULL.  A false negative is merely a missed optimization opportunity.
5477821b610bSdrh **
5478821b610bSdrh ** False positives are not allowed, however.  A false positive may result
5479821b610bSdrh ** in an incorrect answer.
5480821b610bSdrh **
54812589787cSdrh ** Terms of p that are marked with EP_FromJoin (and hence that come from
54822589787cSdrh ** the ON or USING clauses of LEFT JOINS) are excluded from the analysis.
54832589787cSdrh **
54842589787cSdrh ** This routine is used to check if a LEFT JOIN can be converted into
54852589787cSdrh ** an ordinary JOIN.  The p argument is the WHERE clause.  If the WHERE
54862589787cSdrh ** clause requires that some column of the right table of the LEFT JOIN
54872589787cSdrh ** be non-NULL, then the LEFT JOIN can be safely converted into an
54882589787cSdrh ** ordinary join.
54892589787cSdrh */
54902589787cSdrh int sqlite3ExprImpliesNonNullRow(Expr *p, int iTab){
54912589787cSdrh   Walker w;
54920d950af3Sdrh   p = sqlite3ExprSkipCollateAndLikely(p);
54934a254f98Sdrh   if( p==0 ) return 0;
54944a254f98Sdrh   if( p->op==TK_NOTNULL ){
5495d6db6598Sdrh     p = p->pLeft;
5496a1698993Sdrh   }else{
5497a1698993Sdrh     while( p->op==TK_AND ){
54984a254f98Sdrh       if( sqlite3ExprImpliesNonNullRow(p->pLeft, iTab) ) return 1;
54994a254f98Sdrh       p = p->pRight;
5500d6db6598Sdrh     }
5501a1698993Sdrh   }
55022589787cSdrh   w.xExprCallback = impliesNotNullRow;
55032589787cSdrh   w.xSelectCallback = 0;
55042589787cSdrh   w.xSelectCallback2 = 0;
55052589787cSdrh   w.eCode = 0;
55062589787cSdrh   w.u.iCur = iTab;
55072589787cSdrh   sqlite3WalkExpr(&w, p);
55082589787cSdrh   return w.eCode;
55092589787cSdrh }
55102589787cSdrh 
55112589787cSdrh /*
5512030796dfSdrh ** An instance of the following structure is used by the tree walker
55132409f8a1Sdrh ** to determine if an expression can be evaluated by reference to the
55142409f8a1Sdrh ** index only, without having to do a search for the corresponding
55152409f8a1Sdrh ** table entry.  The IdxCover.pIdx field is the index.  IdxCover.iCur
55162409f8a1Sdrh ** is the cursor for the table.
55172409f8a1Sdrh */
55182409f8a1Sdrh struct IdxCover {
55192409f8a1Sdrh   Index *pIdx;     /* The index to be tested for coverage */
55202409f8a1Sdrh   int iCur;        /* Cursor number for the table corresponding to the index */
55212409f8a1Sdrh };
55222409f8a1Sdrh 
55232409f8a1Sdrh /*
55242409f8a1Sdrh ** Check to see if there are references to columns in table
55252409f8a1Sdrh ** pWalker->u.pIdxCover->iCur can be satisfied using the index
55262409f8a1Sdrh ** pWalker->u.pIdxCover->pIdx.
55272409f8a1Sdrh */
55282409f8a1Sdrh static int exprIdxCover(Walker *pWalker, Expr *pExpr){
55292409f8a1Sdrh   if( pExpr->op==TK_COLUMN
55302409f8a1Sdrh    && pExpr->iTable==pWalker->u.pIdxCover->iCur
5531b9bcf7caSdrh    && sqlite3TableColumnToIndex(pWalker->u.pIdxCover->pIdx, pExpr->iColumn)<0
55322409f8a1Sdrh   ){
55332409f8a1Sdrh     pWalker->eCode = 1;
55342409f8a1Sdrh     return WRC_Abort;
55352409f8a1Sdrh   }
55362409f8a1Sdrh   return WRC_Continue;
55372409f8a1Sdrh }
55382409f8a1Sdrh 
55392409f8a1Sdrh /*
5540e604ec0bSdrh ** Determine if an index pIdx on table with cursor iCur contains will
5541e604ec0bSdrh ** the expression pExpr.  Return true if the index does cover the
5542e604ec0bSdrh ** expression and false if the pExpr expression references table columns
5543e604ec0bSdrh ** that are not found in the index pIdx.
55442409f8a1Sdrh **
55452409f8a1Sdrh ** An index covering an expression means that the expression can be
55462409f8a1Sdrh ** evaluated using only the index and without having to lookup the
55472409f8a1Sdrh ** corresponding table entry.
55482409f8a1Sdrh */
55492409f8a1Sdrh int sqlite3ExprCoveredByIndex(
55502409f8a1Sdrh   Expr *pExpr,        /* The index to be tested */
55512409f8a1Sdrh   int iCur,           /* The cursor number for the corresponding table */
55522409f8a1Sdrh   Index *pIdx         /* The index that might be used for coverage */
55532409f8a1Sdrh ){
55542409f8a1Sdrh   Walker w;
55552409f8a1Sdrh   struct IdxCover xcov;
55562409f8a1Sdrh   memset(&w, 0, sizeof(w));
55572409f8a1Sdrh   xcov.iCur = iCur;
55582409f8a1Sdrh   xcov.pIdx = pIdx;
55592409f8a1Sdrh   w.xExprCallback = exprIdxCover;
55602409f8a1Sdrh   w.u.pIdxCover = &xcov;
55612409f8a1Sdrh   sqlite3WalkExpr(&w, pExpr);
55622409f8a1Sdrh   return !w.eCode;
55632409f8a1Sdrh }
55642409f8a1Sdrh 
55652409f8a1Sdrh 
55662409f8a1Sdrh /*
55672409f8a1Sdrh ** An instance of the following structure is used by the tree walker
5568030796dfSdrh ** to count references to table columns in the arguments of an
5569ed551b95Sdrh ** aggregate function, in order to implement the
5570ed551b95Sdrh ** sqlite3FunctionThisSrc() routine.
5571374fdce4Sdrh */
5572030796dfSdrh struct SrcCount {
5573030796dfSdrh   SrcList *pSrc;   /* One particular FROM clause in a nested query */
5574030796dfSdrh   int nThis;       /* Number of references to columns in pSrcList */
5575030796dfSdrh   int nOther;      /* Number of references to columns in other FROM clauses */
5576030796dfSdrh };
5577030796dfSdrh 
5578030796dfSdrh /*
5579030796dfSdrh ** Count the number of references to columns.
5580030796dfSdrh */
5581030796dfSdrh static int exprSrcCount(Walker *pWalker, Expr *pExpr){
5582b4b36306Sdan   /* There was once a NEVER() on the second term on the grounds that
5583b4b36306Sdan   ** sqlite3FunctionUsesThisSrc() was always called before
5584b4b36306Sdan   ** sqlite3ExprAnalyzeAggregates() and so the TK_COLUMNs have not yet
5585b4b36306Sdan   ** been converted into TK_AGG_COLUMN. But this is no longer true due
5586b4b36306Sdan   ** to window functions - sqlite3WindowRewrite() may now indirectly call
5587b4b36306Sdan   ** FunctionUsesThisSrc() when creating a new sub-select. */
5588b4b36306Sdan   if( pExpr->op==TK_COLUMN || pExpr->op==TK_AGG_COLUMN ){
5589374fdce4Sdrh     int i;
5590030796dfSdrh     struct SrcCount *p = pWalker->u.pSrcCount;
5591030796dfSdrh     SrcList *pSrc = p->pSrc;
5592655814d2Sdrh     int nSrc = pSrc ? pSrc->nSrc : 0;
5593655814d2Sdrh     for(i=0; i<nSrc; i++){
5594030796dfSdrh       if( pExpr->iTable==pSrc->a[i].iCursor ) break;
5595374fdce4Sdrh     }
5596655814d2Sdrh     if( i<nSrc ){
5597030796dfSdrh       p->nThis++;
559880f6bfc0Sdrh     }else if( nSrc==0 || pExpr->iTable<pSrc->a[0].iCursor ){
559980f6bfc0Sdrh       /* In a well-formed parse tree (no name resolution errors),
560035a38e08Sdrh       ** TK_COLUMN nodes with smaller Expr.iTable values are in an
560180f6bfc0Sdrh       ** outer context.  Those are the only ones to count as "other" */
5602030796dfSdrh       p->nOther++;
5603374fdce4Sdrh     }
5604374fdce4Sdrh   }
5605030796dfSdrh   return WRC_Continue;
5606030796dfSdrh }
5607374fdce4Sdrh 
5608374fdce4Sdrh /*
5609030796dfSdrh ** Determine if any of the arguments to the pExpr Function reference
5610030796dfSdrh ** pSrcList.  Return true if they do.  Also return true if the function
5611030796dfSdrh ** has no arguments or has only constant arguments.  Return false if pExpr
5612030796dfSdrh ** references columns but not columns of tables found in pSrcList.
5613374fdce4Sdrh */
5614030796dfSdrh int sqlite3FunctionUsesThisSrc(Expr *pExpr, SrcList *pSrcList){
5615374fdce4Sdrh   Walker w;
5616030796dfSdrh   struct SrcCount cnt;
5617374fdce4Sdrh   assert( pExpr->op==TK_AGG_FUNCTION );
561880f6bfc0Sdrh   memset(&w, 0, sizeof(w));
5619030796dfSdrh   w.xExprCallback = exprSrcCount;
562080f6bfc0Sdrh   w.xSelectCallback = sqlite3SelectWalkNoop;
5621030796dfSdrh   w.u.pSrcCount = &cnt;
5622030796dfSdrh   cnt.pSrc = pSrcList;
5623030796dfSdrh   cnt.nThis = 0;
5624030796dfSdrh   cnt.nOther = 0;
5625030796dfSdrh   sqlite3WalkExprList(&w, pExpr->x.pList);
56265e484cb3Sdan #ifndef SQLITE_OMIT_WINDOWFUNC
56275e484cb3Sdan   if( ExprHasProperty(pExpr, EP_WinFunc) ){
56285e484cb3Sdan     sqlite3WalkExpr(&w, pExpr->y.pWin->pFilter);
56295e484cb3Sdan   }
56305e484cb3Sdan #endif
5631030796dfSdrh   return cnt.nThis>0 || cnt.nOther==0;
5632374fdce4Sdrh }
5633374fdce4Sdrh 
5634374fdce4Sdrh /*
563513449892Sdrh ** Add a new element to the pAggInfo->aCol[] array.  Return the index of
563613449892Sdrh ** the new element.  Return a negative number if malloc fails.
56372282792aSdrh */
563817435752Sdrh static int addAggInfoColumn(sqlite3 *db, AggInfo *pInfo){
563913449892Sdrh   int i;
5640cf643729Sdrh   pInfo->aCol = sqlite3ArrayAllocate(
564117435752Sdrh        db,
5642cf643729Sdrh        pInfo->aCol,
5643cf643729Sdrh        sizeof(pInfo->aCol[0]),
5644cf643729Sdrh        &pInfo->nColumn,
5645cf643729Sdrh        &i
5646cf643729Sdrh   );
564713449892Sdrh   return i;
56482282792aSdrh }
564913449892Sdrh 
565013449892Sdrh /*
565113449892Sdrh ** Add a new element to the pAggInfo->aFunc[] array.  Return the index of
565213449892Sdrh ** the new element.  Return a negative number if malloc fails.
565313449892Sdrh */
565417435752Sdrh static int addAggInfoFunc(sqlite3 *db, AggInfo *pInfo){
565513449892Sdrh   int i;
5656cf643729Sdrh   pInfo->aFunc = sqlite3ArrayAllocate(
565717435752Sdrh        db,
5658cf643729Sdrh        pInfo->aFunc,
5659cf643729Sdrh        sizeof(pInfo->aFunc[0]),
5660cf643729Sdrh        &pInfo->nFunc,
5661cf643729Sdrh        &i
5662cf643729Sdrh   );
566313449892Sdrh   return i;
56642282792aSdrh }
56652282792aSdrh 
56662282792aSdrh /*
56677d10d5a6Sdrh ** This is the xExprCallback for a tree walker.  It is used to
56687d10d5a6Sdrh ** implement sqlite3ExprAnalyzeAggregates().  See sqlite3ExprAnalyzeAggregates
5669626a879aSdrh ** for additional information.
56702282792aSdrh */
56717d10d5a6Sdrh static int analyzeAggregate(Walker *pWalker, Expr *pExpr){
56722282792aSdrh   int i;
56737d10d5a6Sdrh   NameContext *pNC = pWalker->u.pNC;
5674a58fdfb1Sdanielk1977   Parse *pParse = pNC->pParse;
5675a58fdfb1Sdanielk1977   SrcList *pSrcList = pNC->pSrcList;
567625c3b8caSdrh   AggInfo *pAggInfo = pNC->uNC.pAggInfo;
567713449892Sdrh 
567825c3b8caSdrh   assert( pNC->ncFlags & NC_UAggInfo );
56792282792aSdrh   switch( pExpr->op ){
568089c69d00Sdrh     case TK_AGG_COLUMN:
5681967e8b73Sdrh     case TK_COLUMN: {
56828b213899Sdrh       testcase( pExpr->op==TK_AGG_COLUMN );
56838b213899Sdrh       testcase( pExpr->op==TK_COLUMN );
568413449892Sdrh       /* Check to see if the column is in one of the tables in the FROM
568513449892Sdrh       ** clause of the aggregate query */
568620bc393cSdrh       if( ALWAYS(pSrcList!=0) ){
568713449892Sdrh         struct SrcList_item *pItem = pSrcList->a;
568813449892Sdrh         for(i=0; i<pSrcList->nSrc; i++, pItem++){
568913449892Sdrh           struct AggInfo_col *pCol;
5690c5cd1249Sdrh           assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
569113449892Sdrh           if( pExpr->iTable==pItem->iCursor ){
569213449892Sdrh             /* If we reach this point, it means that pExpr refers to a table
569313449892Sdrh             ** that is in the FROM clause of the aggregate query.
569413449892Sdrh             **
569513449892Sdrh             ** Make an entry for the column in pAggInfo->aCol[] if there
569613449892Sdrh             ** is not an entry there already.
569713449892Sdrh             */
56987f906d63Sdrh             int k;
569913449892Sdrh             pCol = pAggInfo->aCol;
57007f906d63Sdrh             for(k=0; k<pAggInfo->nColumn; k++, pCol++){
570113449892Sdrh               if( pCol->iTable==pExpr->iTable &&
570213449892Sdrh                   pCol->iColumn==pExpr->iColumn ){
57032282792aSdrh                 break;
57042282792aSdrh               }
57052282792aSdrh             }
57061e536953Sdanielk1977             if( (k>=pAggInfo->nColumn)
57071e536953Sdanielk1977              && (k = addAggInfoColumn(pParse->db, pAggInfo))>=0
57081e536953Sdanielk1977             ){
57097f906d63Sdrh               pCol = &pAggInfo->aCol[k];
5710eda079cdSdrh               pCol->pTab = pExpr->y.pTab;
571113449892Sdrh               pCol->iTable = pExpr->iTable;
571213449892Sdrh               pCol->iColumn = pExpr->iColumn;
57130a07c107Sdrh               pCol->iMem = ++pParse->nMem;
571413449892Sdrh               pCol->iSorterColumn = -1;
57155774b806Sdrh               pCol->pExpr = pExpr;
571613449892Sdrh               if( pAggInfo->pGroupBy ){
571713449892Sdrh                 int j, n;
571813449892Sdrh                 ExprList *pGB = pAggInfo->pGroupBy;
571913449892Sdrh                 struct ExprList_item *pTerm = pGB->a;
572013449892Sdrh                 n = pGB->nExpr;
572113449892Sdrh                 for(j=0; j<n; j++, pTerm++){
572213449892Sdrh                   Expr *pE = pTerm->pExpr;
572313449892Sdrh                   if( pE->op==TK_COLUMN && pE->iTable==pExpr->iTable &&
572413449892Sdrh                       pE->iColumn==pExpr->iColumn ){
572513449892Sdrh                     pCol->iSorterColumn = j;
572613449892Sdrh                     break;
57272282792aSdrh                   }
572813449892Sdrh                 }
572913449892Sdrh               }
573013449892Sdrh               if( pCol->iSorterColumn<0 ){
573113449892Sdrh                 pCol->iSorterColumn = pAggInfo->nSortingColumn++;
573213449892Sdrh               }
573313449892Sdrh             }
573413449892Sdrh             /* There is now an entry for pExpr in pAggInfo->aCol[] (either
573513449892Sdrh             ** because it was there before or because we just created it).
573613449892Sdrh             ** Convert the pExpr to be a TK_AGG_COLUMN referring to that
573713449892Sdrh             ** pAggInfo->aCol[] entry.
573813449892Sdrh             */
5739ebb6a65dSdrh             ExprSetVVAProperty(pExpr, EP_NoReduce);
574013449892Sdrh             pExpr->pAggInfo = pAggInfo;
574113449892Sdrh             pExpr->op = TK_AGG_COLUMN;
5742cf697396Sshane             pExpr->iAgg = (i16)k;
574313449892Sdrh             break;
574413449892Sdrh           } /* endif pExpr->iTable==pItem->iCursor */
574513449892Sdrh         } /* end loop over pSrcList */
5746a58fdfb1Sdanielk1977       }
57477d10d5a6Sdrh       return WRC_Prune;
57482282792aSdrh     }
57492282792aSdrh     case TK_AGG_FUNCTION: {
57503a8c4be7Sdrh       if( (pNC->ncFlags & NC_InAggFunc)==0
5751ed551b95Sdrh        && pWalker->walkerDepth==pExpr->op2
57523a8c4be7Sdrh       ){
575313449892Sdrh         /* Check to see if pExpr is a duplicate of another aggregate
575413449892Sdrh         ** function that is already in the pAggInfo structure
575513449892Sdrh         */
575613449892Sdrh         struct AggInfo_func *pItem = pAggInfo->aFunc;
575713449892Sdrh         for(i=0; i<pAggInfo->nFunc; i++, pItem++){
57585aa550cfSdan           if( sqlite3ExprCompare(0, pItem->pExpr, pExpr, -1)==0 ){
57592282792aSdrh             break;
57602282792aSdrh           }
57612282792aSdrh         }
576213449892Sdrh         if( i>=pAggInfo->nFunc ){
576313449892Sdrh           /* pExpr is original.  Make a new entry in pAggInfo->aFunc[]
576413449892Sdrh           */
576514db2665Sdanielk1977           u8 enc = ENC(pParse->db);
57661e536953Sdanielk1977           i = addAggInfoFunc(pParse->db, pAggInfo);
576713449892Sdrh           if( i>=0 ){
57686ab3a2ecSdanielk1977             assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
576913449892Sdrh             pItem = &pAggInfo->aFunc[i];
577013449892Sdrh             pItem->pExpr = pExpr;
57710a07c107Sdrh             pItem->iMem = ++pParse->nMem;
577233e619fcSdrh             assert( !ExprHasProperty(pExpr, EP_IntValue) );
577313449892Sdrh             pItem->pFunc = sqlite3FindFunction(pParse->db,
577480738d9cSdrh                    pExpr->u.zToken,
57756ab3a2ecSdanielk1977                    pExpr->x.pList ? pExpr->x.pList->nExpr : 0, enc, 0);
5776fd357974Sdrh             if( pExpr->flags & EP_Distinct ){
5777fd357974Sdrh               pItem->iDistinct = pParse->nTab++;
5778fd357974Sdrh             }else{
5779fd357974Sdrh               pItem->iDistinct = -1;
5780fd357974Sdrh             }
57812282792aSdrh           }
578213449892Sdrh         }
578313449892Sdrh         /* Make pExpr point to the appropriate pAggInfo->aFunc[] entry
578413449892Sdrh         */
5785c5cd1249Sdrh         assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
5786ebb6a65dSdrh         ExprSetVVAProperty(pExpr, EP_NoReduce);
5787cf697396Sshane         pExpr->iAgg = (i16)i;
578813449892Sdrh         pExpr->pAggInfo = pAggInfo;
57893a8c4be7Sdrh         return WRC_Prune;
57906e83a57fSdrh       }else{
57916e83a57fSdrh         return WRC_Continue;
57926e83a57fSdrh       }
57932282792aSdrh     }
5794a58fdfb1Sdanielk1977   }
57957d10d5a6Sdrh   return WRC_Continue;
57967d10d5a6Sdrh }
57977d10d5a6Sdrh static int analyzeAggregatesInSelect(Walker *pWalker, Select *pSelect){
5798d5a336efSdrh   UNUSED_PARAMETER(pSelect);
5799979dd1beSdrh   pWalker->walkerDepth++;
58007d10d5a6Sdrh   return WRC_Continue;
5801a58fdfb1Sdanielk1977 }
5802979dd1beSdrh static void analyzeAggregatesInSelectEnd(Walker *pWalker, Select *pSelect){
5803979dd1beSdrh   UNUSED_PARAMETER(pSelect);
5804979dd1beSdrh   pWalker->walkerDepth--;
5805979dd1beSdrh }
5806626a879aSdrh 
5807626a879aSdrh /*
5808e8abb4caSdrh ** Analyze the pExpr expression looking for aggregate functions and
5809e8abb4caSdrh ** for variables that need to be added to AggInfo object that pNC->pAggInfo
5810e8abb4caSdrh ** points to.  Additional entries are made on the AggInfo object as
5811e8abb4caSdrh ** necessary.
5812626a879aSdrh **
5813626a879aSdrh ** This routine should only be called after the expression has been
58147d10d5a6Sdrh ** analyzed by sqlite3ResolveExprNames().
5815626a879aSdrh */
5816d2b3e23bSdrh void sqlite3ExprAnalyzeAggregates(NameContext *pNC, Expr *pExpr){
58177d10d5a6Sdrh   Walker w;
58187d10d5a6Sdrh   w.xExprCallback = analyzeAggregate;
58197d10d5a6Sdrh   w.xSelectCallback = analyzeAggregatesInSelect;
5820979dd1beSdrh   w.xSelectCallback2 = analyzeAggregatesInSelectEnd;
5821979dd1beSdrh   w.walkerDepth = 0;
58227d10d5a6Sdrh   w.u.pNC = pNC;
5823d9995031Sdan   w.pParse = 0;
582420bc393cSdrh   assert( pNC->pSrcList!=0 );
58257d10d5a6Sdrh   sqlite3WalkExpr(&w, pExpr);
58262282792aSdrh }
58275d9a4af9Sdrh 
58285d9a4af9Sdrh /*
58295d9a4af9Sdrh ** Call sqlite3ExprAnalyzeAggregates() for every expression in an
58305d9a4af9Sdrh ** expression list.  Return the number of errors.
58315d9a4af9Sdrh **
58325d9a4af9Sdrh ** If an error is found, the analysis is cut short.
58335d9a4af9Sdrh */
5834d2b3e23bSdrh void sqlite3ExprAnalyzeAggList(NameContext *pNC, ExprList *pList){
58355d9a4af9Sdrh   struct ExprList_item *pItem;
58365d9a4af9Sdrh   int i;
58375d9a4af9Sdrh   if( pList ){
5838d2b3e23bSdrh     for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
5839d2b3e23bSdrh       sqlite3ExprAnalyzeAggregates(pNC, pItem->pExpr);
58405d9a4af9Sdrh     }
58415d9a4af9Sdrh   }
58425d9a4af9Sdrh }
5843892d3179Sdrh 
5844892d3179Sdrh /*
5845ceea3321Sdrh ** Allocate a single new register for use to hold some intermediate result.
5846892d3179Sdrh */
5847892d3179Sdrh int sqlite3GetTempReg(Parse *pParse){
5848e55cbd72Sdrh   if( pParse->nTempReg==0 ){
5849892d3179Sdrh     return ++pParse->nMem;
5850892d3179Sdrh   }
58512f425f6bSdanielk1977   return pParse->aTempReg[--pParse->nTempReg];
5852892d3179Sdrh }
5853ceea3321Sdrh 
5854ceea3321Sdrh /*
5855ceea3321Sdrh ** Deallocate a register, making available for reuse for some other
5856ceea3321Sdrh ** purpose.
5857ceea3321Sdrh */
5858892d3179Sdrh void sqlite3ReleaseTempReg(Parse *pParse, int iReg){
585913d79502Sdrh   if( iReg ){
58603aef2fb1Sdrh     sqlite3VdbeReleaseRegisters(pParse, iReg, 1, 0, 0);
586113d79502Sdrh     if( pParse->nTempReg<ArraySize(pParse->aTempReg) ){
5862892d3179Sdrh       pParse->aTempReg[pParse->nTempReg++] = iReg;
5863892d3179Sdrh     }
5864892d3179Sdrh   }
586513d79502Sdrh }
5866892d3179Sdrh 
5867892d3179Sdrh /*
5868ed24da4bSdrh ** Allocate or deallocate a block of nReg consecutive registers.
5869892d3179Sdrh */
5870892d3179Sdrh int sqlite3GetTempRange(Parse *pParse, int nReg){
5871e55cbd72Sdrh   int i, n;
5872ed24da4bSdrh   if( nReg==1 ) return sqlite3GetTempReg(pParse);
5873892d3179Sdrh   i = pParse->iRangeReg;
5874e55cbd72Sdrh   n = pParse->nRangeReg;
5875f49f3523Sdrh   if( nReg<=n ){
5876892d3179Sdrh     pParse->iRangeReg += nReg;
5877892d3179Sdrh     pParse->nRangeReg -= nReg;
5878892d3179Sdrh   }else{
5879892d3179Sdrh     i = pParse->nMem+1;
5880892d3179Sdrh     pParse->nMem += nReg;
5881892d3179Sdrh   }
5882892d3179Sdrh   return i;
5883892d3179Sdrh }
5884892d3179Sdrh void sqlite3ReleaseTempRange(Parse *pParse, int iReg, int nReg){
5885ed24da4bSdrh   if( nReg==1 ){
5886ed24da4bSdrh     sqlite3ReleaseTempReg(pParse, iReg);
5887ed24da4bSdrh     return;
5888ed24da4bSdrh   }
58893aef2fb1Sdrh   sqlite3VdbeReleaseRegisters(pParse, iReg, nReg, 0, 0);
5890892d3179Sdrh   if( nReg>pParse->nRangeReg ){
5891892d3179Sdrh     pParse->nRangeReg = nReg;
5892892d3179Sdrh     pParse->iRangeReg = iReg;
5893892d3179Sdrh   }
5894892d3179Sdrh }
5895cdc69557Sdrh 
5896cdc69557Sdrh /*
5897cdc69557Sdrh ** Mark all temporary registers as being unavailable for reuse.
58986d2566dfSdrh **
58996d2566dfSdrh ** Always invoke this procedure after coding a subroutine or co-routine
59006d2566dfSdrh ** that might be invoked from other parts of the code, to ensure that
59016d2566dfSdrh ** the sub/co-routine does not use registers in common with the code that
59026d2566dfSdrh ** invokes the sub/co-routine.
5903cdc69557Sdrh */
5904cdc69557Sdrh void sqlite3ClearTempRegCache(Parse *pParse){
5905cdc69557Sdrh   pParse->nTempReg = 0;
5906cdc69557Sdrh   pParse->nRangeReg = 0;
5907cdc69557Sdrh }
5908bb9b5f26Sdrh 
5909bb9b5f26Sdrh /*
5910bb9b5f26Sdrh ** Validate that no temporary register falls within the range of
5911bb9b5f26Sdrh ** iFirst..iLast, inclusive.  This routine is only call from within assert()
5912bb9b5f26Sdrh ** statements.
5913bb9b5f26Sdrh */
5914bb9b5f26Sdrh #ifdef SQLITE_DEBUG
5915bb9b5f26Sdrh int sqlite3NoTempsInRange(Parse *pParse, int iFirst, int iLast){
5916bb9b5f26Sdrh   int i;
5917bb9b5f26Sdrh   if( pParse->nRangeReg>0
59183963e584Sdrh    && pParse->iRangeReg+pParse->nRangeReg > iFirst
59193963e584Sdrh    && pParse->iRangeReg <= iLast
5920bb9b5f26Sdrh   ){
5921bb9b5f26Sdrh      return 0;
5922bb9b5f26Sdrh   }
5923bb9b5f26Sdrh   for(i=0; i<pParse->nTempReg; i++){
5924bb9b5f26Sdrh     if( pParse->aTempReg[i]>=iFirst && pParse->aTempReg[i]<=iLast ){
5925bb9b5f26Sdrh       return 0;
5926bb9b5f26Sdrh     }
5927bb9b5f26Sdrh   }
5928bb9b5f26Sdrh   return 1;
5929bb9b5f26Sdrh }
5930bb9b5f26Sdrh #endif /* SQLITE_DEBUG */
5931