xref: /sqlite-3.40.0/src/wherecode.c (revision eda079cd)
16f82e85aSdrh /*
26f82e85aSdrh ** 2015-06-06
36f82e85aSdrh **
46f82e85aSdrh ** The author disclaims copyright to this source code.  In place of
56f82e85aSdrh ** a legal notice, here is a blessing:
66f82e85aSdrh **
76f82e85aSdrh **    May you do good and not evil.
86f82e85aSdrh **    May you find forgiveness for yourself and forgive others.
96f82e85aSdrh **    May you share freely, never taking more than you give.
106f82e85aSdrh **
116f82e85aSdrh *************************************************************************
126f82e85aSdrh ** This module contains C code that generates VDBE code used to process
136f82e85aSdrh ** the WHERE clause of SQL statements.
146f82e85aSdrh **
156f82e85aSdrh ** This file was split off from where.c on 2015-06-06 in order to reduce the
166f82e85aSdrh ** size of where.c and make it easier to edit.  This file contains the routines
176f82e85aSdrh ** that actually generate the bulk of the WHERE loop code.  The original where.c
186f82e85aSdrh ** file retains the code that does query planning and analysis.
196f82e85aSdrh */
206f82e85aSdrh #include "sqliteInt.h"
216f82e85aSdrh #include "whereInt.h"
226f82e85aSdrh 
236f82e85aSdrh #ifndef SQLITE_OMIT_EXPLAIN
241d9bc9b7Sdan 
251d9bc9b7Sdan /*
261d9bc9b7Sdan ** Return the name of the i-th column of the pIdx index.
271d9bc9b7Sdan */
281d9bc9b7Sdan static const char *explainIndexColumnName(Index *pIdx, int i){
291d9bc9b7Sdan   i = pIdx->aiColumn[i];
301d9bc9b7Sdan   if( i==XN_EXPR ) return "<expr>";
311d9bc9b7Sdan   if( i==XN_ROWID ) return "rowid";
321d9bc9b7Sdan   return pIdx->pTable->aCol[i].zName;
331d9bc9b7Sdan }
341d9bc9b7Sdan 
356f82e85aSdrh /*
366f82e85aSdrh ** This routine is a helper for explainIndexRange() below
376f82e85aSdrh **
386f82e85aSdrh ** pStr holds the text of an expression that we are building up one term
396f82e85aSdrh ** at a time.  This routine adds a new term to the end of the expression.
406f82e85aSdrh ** Terms are separated by AND so add the "AND" text for second and subsequent
416f82e85aSdrh ** terms only.
426f82e85aSdrh */
436f82e85aSdrh static void explainAppendTerm(
446f82e85aSdrh   StrAccum *pStr,             /* The text expression being built */
451d9bc9b7Sdan   Index *pIdx,                /* Index to read column names from */
461d9bc9b7Sdan   int nTerm,                  /* Number of terms */
471d9bc9b7Sdan   int iTerm,                  /* Zero-based index of first term. */
481d9bc9b7Sdan   int bAnd,                   /* Non-zero to append " AND " */
496f82e85aSdrh   const char *zOp             /* Name of the operator */
506f82e85aSdrh ){
511d9bc9b7Sdan   int i;
521d9bc9b7Sdan 
531d9bc9b7Sdan   assert( nTerm>=1 );
540cdbe1aeSdrh   if( bAnd ) sqlite3_str_append(pStr, " AND ", 5);
551d9bc9b7Sdan 
560cdbe1aeSdrh   if( nTerm>1 ) sqlite3_str_append(pStr, "(", 1);
571d9bc9b7Sdan   for(i=0; i<nTerm; i++){
580cdbe1aeSdrh     if( i ) sqlite3_str_append(pStr, ",", 1);
590cdbe1aeSdrh     sqlite3_str_appendall(pStr, explainIndexColumnName(pIdx, iTerm+i));
601d9bc9b7Sdan   }
610cdbe1aeSdrh   if( nTerm>1 ) sqlite3_str_append(pStr, ")", 1);
621d9bc9b7Sdan 
630cdbe1aeSdrh   sqlite3_str_append(pStr, zOp, 1);
641d9bc9b7Sdan 
650cdbe1aeSdrh   if( nTerm>1 ) sqlite3_str_append(pStr, "(", 1);
661d9bc9b7Sdan   for(i=0; i<nTerm; i++){
670cdbe1aeSdrh     if( i ) sqlite3_str_append(pStr, ",", 1);
680cdbe1aeSdrh     sqlite3_str_append(pStr, "?", 1);
696f82e85aSdrh   }
700cdbe1aeSdrh   if( nTerm>1 ) sqlite3_str_append(pStr, ")", 1);
71c7c4680fSdrh }
72c7c4680fSdrh 
73c7c4680fSdrh /*
746f82e85aSdrh ** Argument pLevel describes a strategy for scanning table pTab. This
756f82e85aSdrh ** function appends text to pStr that describes the subset of table
766f82e85aSdrh ** rows scanned by the strategy in the form of an SQL expression.
776f82e85aSdrh **
786f82e85aSdrh ** For example, if the query:
796f82e85aSdrh **
806f82e85aSdrh **   SELECT * FROM t1 WHERE a=1 AND b>2;
816f82e85aSdrh **
826f82e85aSdrh ** is run and there is an index on (a, b), then this function returns a
836f82e85aSdrh ** string similar to:
846f82e85aSdrh **
856f82e85aSdrh **   "a=? AND b>?"
866f82e85aSdrh */
878faee877Sdrh static void explainIndexRange(StrAccum *pStr, WhereLoop *pLoop){
886f82e85aSdrh   Index *pIndex = pLoop->u.btree.pIndex;
896f82e85aSdrh   u16 nEq = pLoop->u.btree.nEq;
906f82e85aSdrh   u16 nSkip = pLoop->nSkip;
916f82e85aSdrh   int i, j;
926f82e85aSdrh 
936f82e85aSdrh   if( nEq==0 && (pLoop->wsFlags&(WHERE_BTM_LIMIT|WHERE_TOP_LIMIT))==0 ) return;
940cdbe1aeSdrh   sqlite3_str_append(pStr, " (", 2);
956f82e85aSdrh   for(i=0; i<nEq; i++){
96c7c4680fSdrh     const char *z = explainIndexColumnName(pIndex, i);
970cdbe1aeSdrh     if( i ) sqlite3_str_append(pStr, " AND ", 5);
980cdbe1aeSdrh     sqlite3_str_appendf(pStr, i>=nSkip ? "%s=?" : "ANY(%s)", z);
996f82e85aSdrh   }
1006f82e85aSdrh 
1016f82e85aSdrh   j = i;
1026f82e85aSdrh   if( pLoop->wsFlags&WHERE_BTM_LIMIT ){
1031d9bc9b7Sdan     explainAppendTerm(pStr, pIndex, pLoop->u.btree.nBtm, j, i, ">");
1041d9bc9b7Sdan     i = 1;
1056f82e85aSdrh   }
1066f82e85aSdrh   if( pLoop->wsFlags&WHERE_TOP_LIMIT ){
1071d9bc9b7Sdan     explainAppendTerm(pStr, pIndex, pLoop->u.btree.nTop, j, i, "<");
1086f82e85aSdrh   }
1090cdbe1aeSdrh   sqlite3_str_append(pStr, ")", 1);
1106f82e85aSdrh }
1116f82e85aSdrh 
1126f82e85aSdrh /*
1136f82e85aSdrh ** This function is a no-op unless currently processing an EXPLAIN QUERY PLAN
1146f82e85aSdrh ** command, or if either SQLITE_DEBUG or SQLITE_ENABLE_STMT_SCANSTATUS was
1156f82e85aSdrh ** defined at compile-time. If it is not a no-op, a single OP_Explain opcode
1166f82e85aSdrh ** is added to the output to describe the table scan strategy in pLevel.
1176f82e85aSdrh **
1186f82e85aSdrh ** If an OP_Explain opcode is added to the VM, its address is returned.
1196f82e85aSdrh ** Otherwise, if no OP_Explain is coded, zero is returned.
1206f82e85aSdrh */
1216f82e85aSdrh int sqlite3WhereExplainOneScan(
1226f82e85aSdrh   Parse *pParse,                  /* Parse context */
1236f82e85aSdrh   SrcList *pTabList,              /* Table list this loop refers to */
1246f82e85aSdrh   WhereLevel *pLevel,             /* Scan to write OP_Explain opcode for */
1256f82e85aSdrh   u16 wctrlFlags                  /* Flags passed to sqlite3WhereBegin() */
1266f82e85aSdrh ){
1276f82e85aSdrh   int ret = 0;
1286f82e85aSdrh #if !defined(SQLITE_DEBUG) && !defined(SQLITE_ENABLE_STMT_SCANSTATUS)
129ef7231b8Sdrh   if( sqlite3ParseToplevel(pParse)->explain==2 )
1306f82e85aSdrh #endif
1316f82e85aSdrh   {
1326f82e85aSdrh     struct SrcList_item *pItem = &pTabList->a[pLevel->iFrom];
1336f82e85aSdrh     Vdbe *v = pParse->pVdbe;      /* VM being constructed */
1346f82e85aSdrh     sqlite3 *db = pParse->db;     /* Database handle */
1356f82e85aSdrh     int isSearch;                 /* True for a SEARCH. False for SCAN. */
1366f82e85aSdrh     WhereLoop *pLoop;             /* The controlling WhereLoop object */
1376f82e85aSdrh     u32 flags;                    /* Flags that describe this loop */
1386f82e85aSdrh     char *zMsg;                   /* Text to add to EQP output */
1396f82e85aSdrh     StrAccum str;                 /* EQP output string */
1406f82e85aSdrh     char zBuf[100];               /* Initial space for EQP output string */
1416f82e85aSdrh 
1426f82e85aSdrh     pLoop = pLevel->pWLoop;
1436f82e85aSdrh     flags = pLoop->wsFlags;
144ce943bc8Sdrh     if( (flags&WHERE_MULTI_OR) || (wctrlFlags&WHERE_OR_SUBCLAUSE) ) return 0;
1456f82e85aSdrh 
1466f82e85aSdrh     isSearch = (flags&(WHERE_BTM_LIMIT|WHERE_TOP_LIMIT))!=0
1476f82e85aSdrh             || ((flags&WHERE_VIRTUALTABLE)==0 && (pLoop->u.btree.nEq>0))
1486f82e85aSdrh             || (wctrlFlags&(WHERE_ORDERBY_MIN|WHERE_ORDERBY_MAX));
1496f82e85aSdrh 
1506f82e85aSdrh     sqlite3StrAccumInit(&str, db, zBuf, sizeof(zBuf), SQLITE_MAX_LENGTH);
1510cdbe1aeSdrh     sqlite3_str_appendall(&str, isSearch ? "SEARCH" : "SCAN");
1526f82e85aSdrh     if( pItem->pSelect ){
153fef37760Sdrh       sqlite3_str_appendf(&str, " SUBQUERY %u", pItem->pSelect->selId);
1546f82e85aSdrh     }else{
1550cdbe1aeSdrh       sqlite3_str_appendf(&str, " TABLE %s", pItem->zName);
1566f82e85aSdrh     }
1576f82e85aSdrh 
1586f82e85aSdrh     if( pItem->zAlias ){
1590cdbe1aeSdrh       sqlite3_str_appendf(&str, " AS %s", pItem->zAlias);
1606f82e85aSdrh     }
1616f82e85aSdrh     if( (flags & (WHERE_IPK|WHERE_VIRTUALTABLE))==0 ){
1626f82e85aSdrh       const char *zFmt = 0;
1636f82e85aSdrh       Index *pIdx;
1646f82e85aSdrh 
1656f82e85aSdrh       assert( pLoop->u.btree.pIndex!=0 );
1666f82e85aSdrh       pIdx = pLoop->u.btree.pIndex;
1676f82e85aSdrh       assert( !(flags&WHERE_AUTO_INDEX) || (flags&WHERE_IDX_ONLY) );
1686f82e85aSdrh       if( !HasRowid(pItem->pTab) && IsPrimaryKeyIndex(pIdx) ){
1696f82e85aSdrh         if( isSearch ){
1706f82e85aSdrh           zFmt = "PRIMARY KEY";
1716f82e85aSdrh         }
1726f82e85aSdrh       }else if( flags & WHERE_PARTIALIDX ){
1736f82e85aSdrh         zFmt = "AUTOMATIC PARTIAL COVERING INDEX";
1746f82e85aSdrh       }else if( flags & WHERE_AUTO_INDEX ){
1756f82e85aSdrh         zFmt = "AUTOMATIC COVERING INDEX";
1766f82e85aSdrh       }else if( flags & WHERE_IDX_ONLY ){
1776f82e85aSdrh         zFmt = "COVERING INDEX %s";
1786f82e85aSdrh       }else{
1796f82e85aSdrh         zFmt = "INDEX %s";
1806f82e85aSdrh       }
1816f82e85aSdrh       if( zFmt ){
1820cdbe1aeSdrh         sqlite3_str_append(&str, " USING ", 7);
1830cdbe1aeSdrh         sqlite3_str_appendf(&str, zFmt, pIdx->zName);
1848faee877Sdrh         explainIndexRange(&str, pLoop);
1856f82e85aSdrh       }
1866f82e85aSdrh     }else if( (flags & WHERE_IPK)!=0 && (flags & WHERE_CONSTRAINT)!=0 ){
187d37bea5bSdrh       const char *zRangeOp;
1886f82e85aSdrh       if( flags&(WHERE_COLUMN_EQ|WHERE_COLUMN_IN) ){
189d37bea5bSdrh         zRangeOp = "=";
1906f82e85aSdrh       }else if( (flags&WHERE_BOTH_LIMIT)==WHERE_BOTH_LIMIT ){
191d37bea5bSdrh         zRangeOp = ">? AND rowid<";
1926f82e85aSdrh       }else if( flags&WHERE_BTM_LIMIT ){
193d37bea5bSdrh         zRangeOp = ">";
1946f82e85aSdrh       }else{
1956f82e85aSdrh         assert( flags&WHERE_TOP_LIMIT);
196d37bea5bSdrh         zRangeOp = "<";
1976f82e85aSdrh       }
1980cdbe1aeSdrh       sqlite3_str_appendf(&str,
1990cdbe1aeSdrh           " USING INTEGER PRIMARY KEY (rowid%s?)",zRangeOp);
2006f82e85aSdrh     }
2016f82e85aSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
2026f82e85aSdrh     else if( (flags & WHERE_VIRTUALTABLE)!=0 ){
2030cdbe1aeSdrh       sqlite3_str_appendf(&str, " VIRTUAL TABLE INDEX %d:%s",
2046f82e85aSdrh                   pLoop->u.vtab.idxNum, pLoop->u.vtab.idxStr);
2056f82e85aSdrh     }
2066f82e85aSdrh #endif
2076f82e85aSdrh #ifdef SQLITE_EXPLAIN_ESTIMATED_ROWS
2086f82e85aSdrh     if( pLoop->nOut>=10 ){
2090cdbe1aeSdrh       sqlite3_str_appendf(&str, " (~%llu rows)",
2100cdbe1aeSdrh              sqlite3LogEstToInt(pLoop->nOut));
2116f82e85aSdrh     }else{
2120cdbe1aeSdrh       sqlite3_str_append(&str, " (~1 row)", 9);
2136f82e85aSdrh     }
2146f82e85aSdrh #endif
2156f82e85aSdrh     zMsg = sqlite3StrAccumFinish(&str);
216e2ca99c9Sdrh     ret = sqlite3VdbeAddOp4(v, OP_Explain, sqlite3VdbeCurrentAddr(v),
217e2ca99c9Sdrh                             pParse->addrExplain, 0, zMsg,P4_DYNAMIC);
2186f82e85aSdrh   }
2196f82e85aSdrh   return ret;
2206f82e85aSdrh }
2216f82e85aSdrh #endif /* SQLITE_OMIT_EXPLAIN */
2226f82e85aSdrh 
2236f82e85aSdrh #ifdef SQLITE_ENABLE_STMT_SCANSTATUS
2246f82e85aSdrh /*
2256f82e85aSdrh ** Configure the VM passed as the first argument with an
2266f82e85aSdrh ** sqlite3_stmt_scanstatus() entry corresponding to the scan used to
2276f82e85aSdrh ** implement level pLvl. Argument pSrclist is a pointer to the FROM
2286f82e85aSdrh ** clause that the scan reads data from.
2296f82e85aSdrh **
2306f82e85aSdrh ** If argument addrExplain is not 0, it must be the address of an
2316f82e85aSdrh ** OP_Explain instruction that describes the same loop.
2326f82e85aSdrh */
2336f82e85aSdrh void sqlite3WhereAddScanStatus(
2346f82e85aSdrh   Vdbe *v,                        /* Vdbe to add scanstatus entry to */
2356f82e85aSdrh   SrcList *pSrclist,              /* FROM clause pLvl reads data from */
2366f82e85aSdrh   WhereLevel *pLvl,               /* Level to add scanstatus() entry for */
2376f82e85aSdrh   int addrExplain                 /* Address of OP_Explain (or 0) */
2386f82e85aSdrh ){
2396f82e85aSdrh   const char *zObj = 0;
2406f82e85aSdrh   WhereLoop *pLoop = pLvl->pWLoop;
2416f82e85aSdrh   if( (pLoop->wsFlags & WHERE_VIRTUALTABLE)==0  &&  pLoop->u.btree.pIndex!=0 ){
2426f82e85aSdrh     zObj = pLoop->u.btree.pIndex->zName;
2436f82e85aSdrh   }else{
2446f82e85aSdrh     zObj = pSrclist->a[pLvl->iFrom].zName;
2456f82e85aSdrh   }
2466f82e85aSdrh   sqlite3VdbeScanStatus(
2476f82e85aSdrh       v, addrExplain, pLvl->addrBody, pLvl->addrVisit, pLoop->nOut, zObj
2486f82e85aSdrh   );
2496f82e85aSdrh }
2506f82e85aSdrh #endif
2516f82e85aSdrh 
2526f82e85aSdrh 
2536f82e85aSdrh /*
2546f82e85aSdrh ** Disable a term in the WHERE clause.  Except, do not disable the term
2556f82e85aSdrh ** if it controls a LEFT OUTER JOIN and it did not originate in the ON
2566f82e85aSdrh ** or USING clause of that join.
2576f82e85aSdrh **
2586f82e85aSdrh ** Consider the term t2.z='ok' in the following queries:
2596f82e85aSdrh **
2606f82e85aSdrh **   (1)  SELECT * FROM t1 LEFT JOIN t2 ON t1.a=t2.x WHERE t2.z='ok'
2616f82e85aSdrh **   (2)  SELECT * FROM t1 LEFT JOIN t2 ON t1.a=t2.x AND t2.z='ok'
2626f82e85aSdrh **   (3)  SELECT * FROM t1, t2 WHERE t1.a=t2.x AND t2.z='ok'
2636f82e85aSdrh **
2646f82e85aSdrh ** The t2.z='ok' is disabled in the in (2) because it originates
2656f82e85aSdrh ** in the ON clause.  The term is disabled in (3) because it is not part
2666f82e85aSdrh ** of a LEFT OUTER JOIN.  In (1), the term is not disabled.
2676f82e85aSdrh **
2686f82e85aSdrh ** Disabling a term causes that term to not be tested in the inner loop
2696f82e85aSdrh ** of the join.  Disabling is an optimization.  When terms are satisfied
2706f82e85aSdrh ** by indices, we disable them to prevent redundant tests in the inner
2716f82e85aSdrh ** loop.  We would get the correct results if nothing were ever disabled,
2726f82e85aSdrh ** but joins might run a little slower.  The trick is to disable as much
2736f82e85aSdrh ** as we can without disabling too much.  If we disabled in (1), we'd get
2746f82e85aSdrh ** the wrong answer.  See ticket #813.
2756f82e85aSdrh **
2766f82e85aSdrh ** If all the children of a term are disabled, then that term is also
2776f82e85aSdrh ** automatically disabled.  In this way, terms get disabled if derived
2786f82e85aSdrh ** virtual terms are tested first.  For example:
2796f82e85aSdrh **
2806f82e85aSdrh **      x GLOB 'abc*' AND x>='abc' AND x<'acd'
2816f82e85aSdrh **      \___________/     \______/     \_____/
2826f82e85aSdrh **         parent          child1       child2
2836f82e85aSdrh **
2846f82e85aSdrh ** Only the parent term was in the original WHERE clause.  The child1
2856f82e85aSdrh ** and child2 terms were added by the LIKE optimization.  If both of
2866f82e85aSdrh ** the virtual child terms are valid, then testing of the parent can be
2876f82e85aSdrh ** skipped.
2886f82e85aSdrh **
2896f82e85aSdrh ** Usually the parent term is marked as TERM_CODED.  But if the parent
2906f82e85aSdrh ** term was originally TERM_LIKE, then the parent gets TERM_LIKECOND instead.
2916f82e85aSdrh ** The TERM_LIKECOND marking indicates that the term should be coded inside
2926f82e85aSdrh ** a conditional such that is only evaluated on the second pass of a
2936f82e85aSdrh ** LIKE-optimization loop, when scanning BLOBs instead of strings.
2946f82e85aSdrh */
2956f82e85aSdrh static void disableTerm(WhereLevel *pLevel, WhereTerm *pTerm){
2966f82e85aSdrh   int nLoop = 0;
2979d9c41e2Sdrh   assert( pTerm!=0 );
2989d9c41e2Sdrh   while( (pTerm->wtFlags & TERM_CODED)==0
2996f82e85aSdrh       && (pLevel->iLeftJoin==0 || ExprHasProperty(pTerm->pExpr, EP_FromJoin))
3006f82e85aSdrh       && (pLevel->notReady & pTerm->prereqAll)==0
3016f82e85aSdrh   ){
3026f82e85aSdrh     if( nLoop && (pTerm->wtFlags & TERM_LIKE)!=0 ){
3036f82e85aSdrh       pTerm->wtFlags |= TERM_LIKECOND;
3046f82e85aSdrh     }else{
3056f82e85aSdrh       pTerm->wtFlags |= TERM_CODED;
3066f82e85aSdrh     }
3076f82e85aSdrh     if( pTerm->iParent<0 ) break;
3086f82e85aSdrh     pTerm = &pTerm->pWC->a[pTerm->iParent];
3099d9c41e2Sdrh     assert( pTerm!=0 );
3106f82e85aSdrh     pTerm->nChild--;
3116f82e85aSdrh     if( pTerm->nChild!=0 ) break;
3126f82e85aSdrh     nLoop++;
3136f82e85aSdrh   }
3146f82e85aSdrh }
3156f82e85aSdrh 
3166f82e85aSdrh /*
3176f82e85aSdrh ** Code an OP_Affinity opcode to apply the column affinity string zAff
3186f82e85aSdrh ** to the n registers starting at base.
3196f82e85aSdrh **
3206f82e85aSdrh ** As an optimization, SQLITE_AFF_BLOB entries (which are no-ops) at the
3216f82e85aSdrh ** beginning and end of zAff are ignored.  If all entries in zAff are
3226f82e85aSdrh ** SQLITE_AFF_BLOB, then no code gets generated.
3236f82e85aSdrh **
3246f82e85aSdrh ** This routine makes its own copy of zAff so that the caller is free
3256f82e85aSdrh ** to modify zAff after this routine returns.
3266f82e85aSdrh */
3276f82e85aSdrh static void codeApplyAffinity(Parse *pParse, int base, int n, char *zAff){
3286f82e85aSdrh   Vdbe *v = pParse->pVdbe;
3296f82e85aSdrh   if( zAff==0 ){
3306f82e85aSdrh     assert( pParse->db->mallocFailed );
3316f82e85aSdrh     return;
3326f82e85aSdrh   }
3336f82e85aSdrh   assert( v!=0 );
3346f82e85aSdrh 
3356f82e85aSdrh   /* Adjust base and n to skip over SQLITE_AFF_BLOB entries at the beginning
3366f82e85aSdrh   ** and end of the affinity string.
3376f82e85aSdrh   */
3386f82e85aSdrh   while( n>0 && zAff[0]==SQLITE_AFF_BLOB ){
3396f82e85aSdrh     n--;
3406f82e85aSdrh     base++;
3416f82e85aSdrh     zAff++;
3426f82e85aSdrh   }
3436f82e85aSdrh   while( n>1 && zAff[n-1]==SQLITE_AFF_BLOB ){
3446f82e85aSdrh     n--;
3456f82e85aSdrh   }
3466f82e85aSdrh 
3476f82e85aSdrh   /* Code the OP_Affinity opcode if there is anything left to do. */
3486f82e85aSdrh   if( n>0 ){
3499b34abeeSdrh     sqlite3VdbeAddOp4(v, OP_Affinity, base, n, 0, zAff, n);
3506f82e85aSdrh   }
3516f82e85aSdrh }
3526f82e85aSdrh 
353b7ca2177Sdan /*
354b7ca2177Sdan ** Expression pRight, which is the RHS of a comparison operation, is
355b7ca2177Sdan ** either a vector of n elements or, if n==1, a scalar expression.
356b7ca2177Sdan ** Before the comparison operation, affinity zAff is to be applied
357b7ca2177Sdan ** to the pRight values. This function modifies characters within the
358b7ca2177Sdan ** affinity string to SQLITE_AFF_BLOB if either:
359b7ca2177Sdan **
360b7ca2177Sdan **   * the comparison will be performed with no affinity, or
361b7ca2177Sdan **   * the affinity change in zAff is guaranteed not to change the value.
362b7ca2177Sdan */
363b7ca2177Sdan static void updateRangeAffinityStr(
364b7ca2177Sdan   Expr *pRight,                   /* RHS of comparison */
365b7ca2177Sdan   int n,                          /* Number of vector elements in comparison */
366b7ca2177Sdan   char *zAff                      /* Affinity string to modify */
367b7ca2177Sdan ){
368b7ca2177Sdan   int i;
369b7ca2177Sdan   for(i=0; i<n; i++){
370b7ca2177Sdan     Expr *p = sqlite3VectorFieldSubexpr(pRight, i);
371b7ca2177Sdan     if( sqlite3CompareAffinity(p, zAff[i])==SQLITE_AFF_BLOB
372b7ca2177Sdan      || sqlite3ExprNeedsNoAffinityChange(p, zAff[i])
373b7ca2177Sdan     ){
374b7ca2177Sdan       zAff[i] = SQLITE_AFF_BLOB;
375b7ca2177Sdan     }
376b7ca2177Sdan   }
377b7ca2177Sdan }
3786f82e85aSdrh 
3792410243eSdrh 
3802410243eSdrh /*
3812410243eSdrh ** pX is an expression of the form:  (vector) IN (SELECT ...)
3822410243eSdrh ** In other words, it is a vector IN operator with a SELECT clause on the
3832410243eSdrh ** LHS.  But not all terms in the vector are indexable and the terms might
3842410243eSdrh ** not be in the correct order for indexing.
3859b1ecb67Sdrh **
3862410243eSdrh ** This routine makes a copy of the input pX expression and then adjusts
3872410243eSdrh ** the vector on the LHS with corresponding changes to the SELECT so that
3882410243eSdrh ** the vector contains only index terms and those terms are in the correct
3892410243eSdrh ** order.  The modified IN expression is returned.  The caller is responsible
3902410243eSdrh ** for deleting the returned expression.
3912410243eSdrh **
3922410243eSdrh ** Example:
3932410243eSdrh **
3942410243eSdrh **    CREATE TABLE t1(a,b,c,d,e,f);
3952410243eSdrh **    CREATE INDEX t1x1 ON t1(e,c);
3962410243eSdrh **    SELECT * FROM t1 WHERE (a,b,c,d,e) IN (SELECT v,w,x,y,z FROM t2)
3972410243eSdrh **                           \_______________________________________/
3982410243eSdrh **                                     The pX expression
3992410243eSdrh **
4002410243eSdrh ** Since only columns e and c can be used with the index, in that order,
4012410243eSdrh ** the modified IN expression that is returned will be:
4022410243eSdrh **
4032410243eSdrh **        (e,c) IN (SELECT z,x FROM t2)
4042410243eSdrh **
4052410243eSdrh ** The reduced pX is different from the original (obviously) and thus is
4062410243eSdrh ** only used for indexing, to improve performance.  The original unaltered
4072410243eSdrh ** IN expression must also be run on each output row for correctness.
4089b1ecb67Sdrh */
4092410243eSdrh static Expr *removeUnindexableInClauseTerms(
4102410243eSdrh   Parse *pParse,        /* The parsing context */
4112410243eSdrh   int iEq,              /* Look at loop terms starting here */
4122410243eSdrh   WhereLoop *pLoop,     /* The current loop */
4132410243eSdrh   Expr *pX              /* The IN expression to be reduced */
4142410243eSdrh ){
4152410243eSdrh   sqlite3 *db = pParse->db;
4162410243eSdrh   Expr *pNew = sqlite3ExprDup(db, pX, 0);
4172410243eSdrh   if( db->mallocFailed==0 ){
4182410243eSdrh     ExprList *pOrigRhs = pNew->x.pSelect->pEList;  /* Original unmodified RHS */
4192410243eSdrh     ExprList *pOrigLhs = pNew->pLeft->x.pList;     /* Original unmodified LHS */
4202410243eSdrh     ExprList *pRhs = 0;         /* New RHS after modifications */
4212410243eSdrh     ExprList *pLhs = 0;         /* New LHS after mods */
4222410243eSdrh     int i;                      /* Loop counter */
4232410243eSdrh     Select *pSelect;            /* Pointer to the SELECT on the RHS */
4242410243eSdrh 
4252410243eSdrh     for(i=iEq; i<pLoop->nLTerm; i++){
4262410243eSdrh       if( pLoop->aLTerm[i]->pExpr==pX ){
4272410243eSdrh         int iField = pLoop->aLTerm[i]->iField - 1;
4282410243eSdrh         assert( pOrigRhs->a[iField].pExpr!=0 );
4292410243eSdrh         pRhs = sqlite3ExprListAppend(pParse, pRhs, pOrigRhs->a[iField].pExpr);
4302410243eSdrh         pOrigRhs->a[iField].pExpr = 0;
4312410243eSdrh         assert( pOrigLhs->a[iField].pExpr!=0 );
4322410243eSdrh         pLhs = sqlite3ExprListAppend(pParse, pLhs, pOrigLhs->a[iField].pExpr);
4332410243eSdrh         pOrigLhs->a[iField].pExpr = 0;
4349b1ecb67Sdrh       }
4359b1ecb67Sdrh     }
4362410243eSdrh     sqlite3ExprListDelete(db, pOrigRhs);
4372410243eSdrh     sqlite3ExprListDelete(db, pOrigLhs);
4382410243eSdrh     pNew->pLeft->x.pList = pLhs;
4392410243eSdrh     pNew->x.pSelect->pEList = pRhs;
4402410243eSdrh     if( pLhs && pLhs->nExpr==1 ){
4412410243eSdrh       /* Take care here not to generate a TK_VECTOR containing only a
4422410243eSdrh       ** single value. Since the parser never creates such a vector, some
4432410243eSdrh       ** of the subroutines do not handle this case.  */
4442410243eSdrh       Expr *p = pLhs->a[0].pExpr;
4452410243eSdrh       pLhs->a[0].pExpr = 0;
4462410243eSdrh       sqlite3ExprDelete(db, pNew->pLeft);
4472410243eSdrh       pNew->pLeft = p;
4489b1ecb67Sdrh     }
4492410243eSdrh     pSelect = pNew->x.pSelect;
4502410243eSdrh     if( pSelect->pOrderBy ){
4512410243eSdrh       /* If the SELECT statement has an ORDER BY clause, zero the
4522410243eSdrh       ** iOrderByCol variables. These are set to non-zero when an
4532410243eSdrh       ** ORDER BY term exactly matches one of the terms of the
4542410243eSdrh       ** result-set. Since the result-set of the SELECT statement may
4552410243eSdrh       ** have been modified or reordered, these variables are no longer
4562410243eSdrh       ** set correctly.  Since setting them is just an optimization,
4572410243eSdrh       ** it's easiest just to zero them here.  */
4582410243eSdrh       ExprList *pOrderBy = pSelect->pOrderBy;
4592410243eSdrh       for(i=0; i<pOrderBy->nExpr; i++){
4602410243eSdrh         pOrderBy->a[i].u.x.iOrderByCol = 0;
4612410243eSdrh       }
4622410243eSdrh     }
4632410243eSdrh 
4642410243eSdrh #if 0
4652410243eSdrh     printf("For indexing, change the IN expr:\n");
4662410243eSdrh     sqlite3TreeViewExpr(0, pX, 0);
4672410243eSdrh     printf("Into:\n");
4682410243eSdrh     sqlite3TreeViewExpr(0, pNew, 0);
4692410243eSdrh #endif
4702410243eSdrh   }
4712410243eSdrh   return pNew;
4722410243eSdrh }
4739b1ecb67Sdrh 
4749b1ecb67Sdrh 
4756f82e85aSdrh /*
4766f82e85aSdrh ** Generate code for a single equality term of the WHERE clause.  An equality
4776f82e85aSdrh ** term can be either X=expr or X IN (...).   pTerm is the term to be
4786f82e85aSdrh ** coded.
4796f82e85aSdrh **
480099a0f5fSdrh ** The current value for the constraint is left in a register, the index
481099a0f5fSdrh ** of which is returned.  An attempt is made store the result in iTarget but
482099a0f5fSdrh ** this is only guaranteed for TK_ISNULL and TK_IN constraints.  If the
483099a0f5fSdrh ** constraint is a TK_EQ or TK_IS, then the current value might be left in
484099a0f5fSdrh ** some other register and it is the caller's responsibility to compensate.
4856f82e85aSdrh **
4864602b8e8Sdrh ** For a constraint of the form X=expr, the expression is evaluated in
4874602b8e8Sdrh ** straight-line code.  For constraints of the form X IN (...)
4886f82e85aSdrh ** this routine sets up a loop that will iterate over all values of X.
4896f82e85aSdrh */
4906f82e85aSdrh static int codeEqualityTerm(
4916f82e85aSdrh   Parse *pParse,      /* The parsing context */
4926f82e85aSdrh   WhereTerm *pTerm,   /* The term of the WHERE clause to be coded */
4936f82e85aSdrh   WhereLevel *pLevel, /* The level of the FROM clause we are working on */
4946f82e85aSdrh   int iEq,            /* Index of the equality term within this level */
4956f82e85aSdrh   int bRev,           /* True for reverse-order IN operations */
4966f82e85aSdrh   int iTarget         /* Attempt to leave results in this register */
4976f82e85aSdrh ){
4986f82e85aSdrh   Expr *pX = pTerm->pExpr;
4996f82e85aSdrh   Vdbe *v = pParse->pVdbe;
5006f82e85aSdrh   int iReg;                  /* Register holding results */
5016f82e85aSdrh 
5028da209b1Sdan   assert( pLevel->pWLoop->aLTerm[iEq]==pTerm );
5036f82e85aSdrh   assert( iTarget>0 );
5046f82e85aSdrh   if( pX->op==TK_EQ || pX->op==TK_IS ){
505fc7f27b9Sdrh     iReg = sqlite3ExprCodeTarget(pParse, pX->pRight, iTarget);
5066f82e85aSdrh   }else if( pX->op==TK_ISNULL ){
5076f82e85aSdrh     iReg = iTarget;
5086f82e85aSdrh     sqlite3VdbeAddOp2(v, OP_Null, 0, iReg);
5096f82e85aSdrh #ifndef SQLITE_OMIT_SUBQUERY
5106f82e85aSdrh   }else{
511ac6b47d1Sdrh     int eType = IN_INDEX_NOOP;
5126f82e85aSdrh     int iTab;
5136f82e85aSdrh     struct InLoop *pIn;
5146f82e85aSdrh     WhereLoop *pLoop = pLevel->pWLoop;
5158da209b1Sdan     int i;
5168da209b1Sdan     int nEq = 0;
5178da209b1Sdan     int *aiMap = 0;
5186f82e85aSdrh 
5196f82e85aSdrh     if( (pLoop->wsFlags & WHERE_VIRTUALTABLE)==0
5206f82e85aSdrh       && pLoop->u.btree.pIndex!=0
5216f82e85aSdrh       && pLoop->u.btree.pIndex->aSortOrder[iEq]
5226f82e85aSdrh     ){
5236f82e85aSdrh       testcase( iEq==0 );
5246f82e85aSdrh       testcase( bRev );
5256f82e85aSdrh       bRev = !bRev;
5266f82e85aSdrh     }
5276f82e85aSdrh     assert( pX->op==TK_IN );
5286f82e85aSdrh     iReg = iTarget;
5298da209b1Sdan 
5308da209b1Sdan     for(i=0; i<iEq; i++){
5318da209b1Sdan       if( pLoop->aLTerm[i] && pLoop->aLTerm[i]->pExpr==pX ){
5328da209b1Sdan         disableTerm(pLevel, pTerm);
5338da209b1Sdan         return iTarget;
5348da209b1Sdan       }
5358da209b1Sdan     }
5368da209b1Sdan     for(i=iEq;i<pLoop->nLTerm; i++){
5372410243eSdrh       assert( pLoop->aLTerm[i]!=0 );
5382410243eSdrh       if( pLoop->aLTerm[i]->pExpr==pX ) nEq++;
5398da209b1Sdan     }
5408da209b1Sdan 
5418da209b1Sdan     if( (pX->flags & EP_xIsSelect)==0 || pX->x.pSelect->pEList->nExpr==1 ){
542ba00e30aSdan       eType = sqlite3FindInIndex(pParse, pX, IN_INDEX_LOOP, 0, 0);
5438da209b1Sdan     }else{
5448da209b1Sdan       sqlite3 *db = pParse->db;
5452410243eSdrh       pX = removeUnindexableInClauseTerms(pParse, iEq, pLoop, pX);
5469b1ecb67Sdrh 
547ac6b47d1Sdrh       if( !db->mallocFailed ){
548c7a77ae1Sdrh         aiMap = (int*)sqlite3DbMallocZero(pParse->db, sizeof(int)*nEq);
5498da209b1Sdan         eType = sqlite3FindInIndex(pParse, pX, IN_INDEX_LOOP, 0, aiMap);
5502410243eSdrh         pTerm->pExpr->iTable = pX->iTable;
551ac6b47d1Sdrh       }
5522410243eSdrh       sqlite3ExprDelete(db, pX);
5532410243eSdrh       pX = pTerm->pExpr;
5548da209b1Sdan     }
5558da209b1Sdan 
5566f82e85aSdrh     if( eType==IN_INDEX_INDEX_DESC ){
5576f82e85aSdrh       testcase( bRev );
5586f82e85aSdrh       bRev = !bRev;
5596f82e85aSdrh     }
5606f82e85aSdrh     iTab = pX->iTable;
5616f82e85aSdrh     sqlite3VdbeAddOp2(v, bRev ? OP_Last : OP_Rewind, iTab, 0);
5626f82e85aSdrh     VdbeCoverageIf(v, bRev);
5636f82e85aSdrh     VdbeCoverageIf(v, !bRev);
5646f82e85aSdrh     assert( (pLoop->wsFlags & WHERE_MULTI_OR)==0 );
5658da209b1Sdan 
5666f82e85aSdrh     pLoop->wsFlags |= WHERE_IN_ABLE;
5676f82e85aSdrh     if( pLevel->u.in.nIn==0 ){
5686f82e85aSdrh       pLevel->addrNxt = sqlite3VdbeMakeLabel(v);
5696f82e85aSdrh     }
5708da209b1Sdan 
5718da209b1Sdan     i = pLevel->u.in.nIn;
5728da209b1Sdan     pLevel->u.in.nIn += nEq;
5736f82e85aSdrh     pLevel->u.in.aInLoop =
5746f82e85aSdrh        sqlite3DbReallocOrFree(pParse->db, pLevel->u.in.aInLoop,
5756f82e85aSdrh                               sizeof(pLevel->u.in.aInLoop[0])*pLevel->u.in.nIn);
5766f82e85aSdrh     pIn = pLevel->u.in.aInLoop;
5776f82e85aSdrh     if( pIn ){
5788da209b1Sdan       int iMap = 0;               /* Index in aiMap[] */
5798da209b1Sdan       pIn += i;
5807887d7f2Sdan       for(i=iEq;i<pLoop->nLTerm; i++){
5818da209b1Sdan         if( pLoop->aLTerm[i]->pExpr==pX ){
582edc3537cSdan           int iOut = iReg + i - iEq;
5836f82e85aSdrh           if( eType==IN_INDEX_ROWID ){
58472d5003eSdrh             testcase( nEq>1 );  /* Happens with a UNIQUE index on ROWID */
585edc3537cSdan             pIn->addrInTop = sqlite3VdbeAddOp2(v, OP_Rowid, iTab, iOut);
5866f82e85aSdrh           }else{
5878da209b1Sdan             int iCol = aiMap ? aiMap[iMap++] : 0;
5888da209b1Sdan             pIn->addrInTop = sqlite3VdbeAddOp3(v,OP_Column,iTab, iCol, iOut);
5896f82e85aSdrh           }
59003181c8cSdrh           sqlite3VdbeAddOp1(v, OP_IsNull, iOut); VdbeCoverage(v);
5918da209b1Sdan           if( i==iEq ){
5928da209b1Sdan             pIn->iCur = iTab;
593f1949b66Sdrh             pIn->eEndLoopOp = bRev ? OP_Prev : OP_Next;
594056f5396Sdrh             if( iEq>0 && (pLoop->wsFlags & WHERE_VIRTUALTABLE)==0 ){
595a0368d93Sdrh               pIn->iBase = iReg - i;
596a0368d93Sdrh               pIn->nPrefix = i;
597f7b0a5f3Sdrh               pLoop->wsFlags |= WHERE_IN_EARLYOUT;
5988da209b1Sdan             }else{
59986d0ea75Sdrh               pIn->nPrefix = 0;
60086d0ea75Sdrh             }
60186d0ea75Sdrh           }else{
6028da209b1Sdan             pIn->eEndLoopOp = OP_Noop;
6038da209b1Sdan           }
6047887d7f2Sdan           pIn++;
6058da209b1Sdan         }
6068da209b1Sdan       }
6076f82e85aSdrh     }else{
6086f82e85aSdrh       pLevel->u.in.nIn = 0;
6096f82e85aSdrh     }
6108da209b1Sdan     sqlite3DbFree(pParse->db, aiMap);
6116f82e85aSdrh #endif
6126f82e85aSdrh   }
6136f82e85aSdrh   disableTerm(pLevel, pTerm);
6146f82e85aSdrh   return iReg;
6156f82e85aSdrh }
6166f82e85aSdrh 
6176f82e85aSdrh /*
6186f82e85aSdrh ** Generate code that will evaluate all == and IN constraints for an
6196f82e85aSdrh ** index scan.
6206f82e85aSdrh **
6216f82e85aSdrh ** For example, consider table t1(a,b,c,d,e,f) with index i1(a,b,c).
6226f82e85aSdrh ** Suppose the WHERE clause is this:  a==5 AND b IN (1,2,3) AND c>5 AND c<10
6236f82e85aSdrh ** The index has as many as three equality constraints, but in this
6246f82e85aSdrh ** example, the third "c" value is an inequality.  So only two
6256f82e85aSdrh ** constraints are coded.  This routine will generate code to evaluate
6266f82e85aSdrh ** a==5 and b IN (1,2,3).  The current values for a and b will be stored
6276f82e85aSdrh ** in consecutive registers and the index of the first register is returned.
6286f82e85aSdrh **
6296f82e85aSdrh ** In the example above nEq==2.  But this subroutine works for any value
6306f82e85aSdrh ** of nEq including 0.  If nEq==0, this routine is nearly a no-op.
6316f82e85aSdrh ** The only thing it does is allocate the pLevel->iMem memory cell and
6326f82e85aSdrh ** compute the affinity string.
6336f82e85aSdrh **
6346f82e85aSdrh ** The nExtraReg parameter is 0 or 1.  It is 0 if all WHERE clause constraints
6356f82e85aSdrh ** are == or IN and are covered by the nEq.  nExtraReg is 1 if there is
6366f82e85aSdrh ** an inequality constraint (such as the "c>=5 AND c<10" in the example) that
6376f82e85aSdrh ** occurs after the nEq quality constraints.
6386f82e85aSdrh **
6396f82e85aSdrh ** This routine allocates a range of nEq+nExtraReg memory cells and returns
6406f82e85aSdrh ** the index of the first memory cell in that range. The code that
6416f82e85aSdrh ** calls this routine will use that memory range to store keys for
6426f82e85aSdrh ** start and termination conditions of the loop.
6436f82e85aSdrh ** key value of the loop.  If one or more IN operators appear, then
6446f82e85aSdrh ** this routine allocates an additional nEq memory cells for internal
6456f82e85aSdrh ** use.
6466f82e85aSdrh **
6476f82e85aSdrh ** Before returning, *pzAff is set to point to a buffer containing a
6486f82e85aSdrh ** copy of the column affinity string of the index allocated using
6496f82e85aSdrh ** sqlite3DbMalloc(). Except, entries in the copy of the string associated
6506f82e85aSdrh ** with equality constraints that use BLOB or NONE affinity are set to
6516f82e85aSdrh ** SQLITE_AFF_BLOB. This is to deal with SQL such as the following:
6526f82e85aSdrh **
6536f82e85aSdrh **   CREATE TABLE t1(a TEXT PRIMARY KEY, b);
6546f82e85aSdrh **   SELECT ... FROM t1 AS t2, t1 WHERE t1.a = t2.b;
6556f82e85aSdrh **
6566f82e85aSdrh ** In the example above, the index on t1(a) has TEXT affinity. But since
6576f82e85aSdrh ** the right hand side of the equality constraint (t2.b) has BLOB/NONE affinity,
6586f82e85aSdrh ** no conversion should be attempted before using a t2.b value as part of
6596f82e85aSdrh ** a key to search the index. Hence the first byte in the returned affinity
6606f82e85aSdrh ** string in this example would be set to SQLITE_AFF_BLOB.
6616f82e85aSdrh */
6626f82e85aSdrh static int codeAllEqualityTerms(
6636f82e85aSdrh   Parse *pParse,        /* Parsing context */
6646f82e85aSdrh   WhereLevel *pLevel,   /* Which nested loop of the FROM we are coding */
6656f82e85aSdrh   int bRev,             /* Reverse the order of IN operators */
6666f82e85aSdrh   int nExtraReg,        /* Number of extra registers to allocate */
6676f82e85aSdrh   char **pzAff          /* OUT: Set to point to affinity string */
6686f82e85aSdrh ){
6696f82e85aSdrh   u16 nEq;                      /* The number of == or IN constraints to code */
6706f82e85aSdrh   u16 nSkip;                    /* Number of left-most columns to skip */
6716f82e85aSdrh   Vdbe *v = pParse->pVdbe;      /* The vm under construction */
6726f82e85aSdrh   Index *pIdx;                  /* The index being used for this loop */
6736f82e85aSdrh   WhereTerm *pTerm;             /* A single constraint term */
6746f82e85aSdrh   WhereLoop *pLoop;             /* The WhereLoop object */
6756f82e85aSdrh   int j;                        /* Loop counter */
6766f82e85aSdrh   int regBase;                  /* Base register */
6776f82e85aSdrh   int nReg;                     /* Number of registers to allocate */
6786f82e85aSdrh   char *zAff;                   /* Affinity string to return */
6796f82e85aSdrh 
6806f82e85aSdrh   /* This module is only called on query plans that use an index. */
6816f82e85aSdrh   pLoop = pLevel->pWLoop;
6826f82e85aSdrh   assert( (pLoop->wsFlags & WHERE_VIRTUALTABLE)==0 );
6836f82e85aSdrh   nEq = pLoop->u.btree.nEq;
6846f82e85aSdrh   nSkip = pLoop->nSkip;
6856f82e85aSdrh   pIdx = pLoop->u.btree.pIndex;
6866f82e85aSdrh   assert( pIdx!=0 );
6876f82e85aSdrh 
6886f82e85aSdrh   /* Figure out how many memory cells we will need then allocate them.
6896f82e85aSdrh   */
6906f82e85aSdrh   regBase = pParse->nMem + 1;
6916f82e85aSdrh   nReg = pLoop->u.btree.nEq + nExtraReg;
6926f82e85aSdrh   pParse->nMem += nReg;
6936f82e85aSdrh 
694e9107698Sdrh   zAff = sqlite3DbStrDup(pParse->db,sqlite3IndexAffinityStr(pParse->db,pIdx));
6954df86af3Sdrh   assert( zAff!=0 || pParse->db->mallocFailed );
6966f82e85aSdrh 
6976f82e85aSdrh   if( nSkip ){
6986f82e85aSdrh     int iIdxCur = pLevel->iIdxCur;
6996f82e85aSdrh     sqlite3VdbeAddOp1(v, (bRev?OP_Last:OP_Rewind), iIdxCur);
7006f82e85aSdrh     VdbeCoverageIf(v, bRev==0);
7016f82e85aSdrh     VdbeCoverageIf(v, bRev!=0);
7026f82e85aSdrh     VdbeComment((v, "begin skip-scan on %s", pIdx->zName));
7036f82e85aSdrh     j = sqlite3VdbeAddOp0(v, OP_Goto);
7046f82e85aSdrh     pLevel->addrSkip = sqlite3VdbeAddOp4Int(v, (bRev?OP_SeekLT:OP_SeekGT),
7056f82e85aSdrh                             iIdxCur, 0, regBase, nSkip);
7066f82e85aSdrh     VdbeCoverageIf(v, bRev==0);
7076f82e85aSdrh     VdbeCoverageIf(v, bRev!=0);
7086f82e85aSdrh     sqlite3VdbeJumpHere(v, j);
7096f82e85aSdrh     for(j=0; j<nSkip; j++){
7106f82e85aSdrh       sqlite3VdbeAddOp3(v, OP_Column, iIdxCur, j, regBase+j);
7114b92f98cSdrh       testcase( pIdx->aiColumn[j]==XN_EXPR );
712e63e8a6cSdrh       VdbeComment((v, "%s", explainIndexColumnName(pIdx, j)));
7136f82e85aSdrh     }
7146f82e85aSdrh   }
7156f82e85aSdrh 
7166f82e85aSdrh   /* Evaluate the equality constraints
7176f82e85aSdrh   */
7186f82e85aSdrh   assert( zAff==0 || (int)strlen(zAff)>=nEq );
7196f82e85aSdrh   for(j=nSkip; j<nEq; j++){
7206f82e85aSdrh     int r1;
7216f82e85aSdrh     pTerm = pLoop->aLTerm[j];
7226f82e85aSdrh     assert( pTerm!=0 );
7236f82e85aSdrh     /* The following testcase is true for indices with redundant columns.
7246f82e85aSdrh     ** Ex: CREATE INDEX i1 ON t1(a,b,a); SELECT * FROM t1 WHERE a=0 AND b=0; */
7256f82e85aSdrh     testcase( (pTerm->wtFlags & TERM_CODED)!=0 );
7266f82e85aSdrh     testcase( pTerm->wtFlags & TERM_VIRTUAL );
7276f82e85aSdrh     r1 = codeEqualityTerm(pParse, pTerm, pLevel, j, bRev, regBase+j);
7286f82e85aSdrh     if( r1!=regBase+j ){
7296f82e85aSdrh       if( nReg==1 ){
7306f82e85aSdrh         sqlite3ReleaseTempReg(pParse, regBase);
7316f82e85aSdrh         regBase = r1;
7326f82e85aSdrh       }else{
7336f82e85aSdrh         sqlite3VdbeAddOp2(v, OP_SCopy, r1, regBase+j);
7346f82e85aSdrh       }
7356f82e85aSdrh     }
73627189603Sdan     if( pTerm->eOperator & WO_IN ){
73727189603Sdan       if( pTerm->pExpr->flags & EP_xIsSelect ){
7381c12657fSdan         /* No affinity ever needs to be (or should be) applied to a value
7391c12657fSdan         ** from the RHS of an "? IN (SELECT ...)" expression. The
7401c12657fSdan         ** sqlite3FindInIndex() routine has already ensured that the
7411c12657fSdan         ** affinity of the comparison has been applied to the value.  */
742aaf8a064Sdrh         if( zAff ) zAff[j] = SQLITE_AFF_BLOB;
74327189603Sdan       }
744c097e122Sdrh     }else if( (pTerm->eOperator & WO_ISNULL)==0 ){
7451c12657fSdan       Expr *pRight = pTerm->pExpr->pRight;
7466f82e85aSdrh       if( (pTerm->wtFlags & TERM_IS)==0 && sqlite3ExprCanBeNull(pRight) ){
7476f82e85aSdrh         sqlite3VdbeAddOp2(v, OP_IsNull, regBase+j, pLevel->addrBrk);
7486f82e85aSdrh         VdbeCoverage(v);
7496f82e85aSdrh       }
7501c12657fSdan       if( zAff ){
7516f82e85aSdrh         if( sqlite3CompareAffinity(pRight, zAff[j])==SQLITE_AFF_BLOB ){
7526f82e85aSdrh           zAff[j] = SQLITE_AFF_BLOB;
7536f82e85aSdrh         }
7546f82e85aSdrh         if( sqlite3ExprNeedsNoAffinityChange(pRight, zAff[j]) ){
7556f82e85aSdrh           zAff[j] = SQLITE_AFF_BLOB;
7566f82e85aSdrh         }
7576f82e85aSdrh       }
7586f82e85aSdrh     }
7596f82e85aSdrh   }
7606f82e85aSdrh   *pzAff = zAff;
7616f82e85aSdrh   return regBase;
7626f82e85aSdrh }
7636f82e85aSdrh 
76441d2e66eSdrh #ifndef SQLITE_LIKE_DOESNT_MATCH_BLOBS
7656f82e85aSdrh /*
76644aebff2Sdrh ** If the most recently coded instruction is a constant range constraint
76744aebff2Sdrh ** (a string literal) that originated from the LIKE optimization, then
76844aebff2Sdrh ** set P3 and P5 on the OP_String opcode so that the string will be cast
76944aebff2Sdrh ** to a BLOB at appropriate times.
7706f82e85aSdrh **
7716f82e85aSdrh ** The LIKE optimization trys to evaluate "x LIKE 'abc%'" as a range
7726f82e85aSdrh ** expression: "x>='ABC' AND x<'abd'".  But this requires that the range
7736f82e85aSdrh ** scan loop run twice, once for strings and a second time for BLOBs.
7746f82e85aSdrh ** The OP_String opcodes on the second pass convert the upper and lower
775e234cfd1Smistachkin ** bound string constants to blobs.  This routine makes the necessary changes
7766f82e85aSdrh ** to the OP_String opcodes for that to happen.
77741d2e66eSdrh **
77841d2e66eSdrh ** Except, of course, if SQLITE_LIKE_DOESNT_MATCH_BLOBS is defined, then
77941d2e66eSdrh ** only the one pass through the string space is required, so this routine
78041d2e66eSdrh ** becomes a no-op.
7816f82e85aSdrh */
7826f82e85aSdrh static void whereLikeOptimizationStringFixup(
7836f82e85aSdrh   Vdbe *v,                /* prepared statement under construction */
7846f82e85aSdrh   WhereLevel *pLevel,     /* The loop that contains the LIKE operator */
7856f82e85aSdrh   WhereTerm *pTerm        /* The upper or lower bound just coded */
7866f82e85aSdrh ){
7876f82e85aSdrh   if( pTerm->wtFlags & TERM_LIKEOPT ){
7886f82e85aSdrh     VdbeOp *pOp;
7896f82e85aSdrh     assert( pLevel->iLikeRepCntr>0 );
7906f82e85aSdrh     pOp = sqlite3VdbeGetOp(v, -1);
7916f82e85aSdrh     assert( pOp!=0 );
7926f82e85aSdrh     assert( pOp->opcode==OP_String8
7936f82e85aSdrh             || pTerm->pWC->pWInfo->pParse->db->mallocFailed );
79444aebff2Sdrh     pOp->p3 = (int)(pLevel->iLikeRepCntr>>1);  /* Register holding counter */
79544aebff2Sdrh     pOp->p5 = (u8)(pLevel->iLikeRepCntr&1);    /* ASC or DESC */
7966f82e85aSdrh   }
7976f82e85aSdrh }
79841d2e66eSdrh #else
79941d2e66eSdrh # define whereLikeOptimizationStringFixup(A,B,C)
80041d2e66eSdrh #endif
8016f82e85aSdrh 
802bec2476aSdrh #ifdef SQLITE_ENABLE_CURSOR_HINTS
8032f2b0278Sdrh /*
8042f2b0278Sdrh ** Information is passed from codeCursorHint() down to individual nodes of
8052f2b0278Sdrh ** the expression tree (by sqlite3WalkExpr()) using an instance of this
8062f2b0278Sdrh ** structure.
8072f2b0278Sdrh */
8082f2b0278Sdrh struct CCurHint {
8092f2b0278Sdrh   int iTabCur;    /* Cursor for the main table */
8102f2b0278Sdrh   int iIdxCur;    /* Cursor for the index, if pIdx!=0.  Unused otherwise */
8112f2b0278Sdrh   Index *pIdx;    /* The index used to access the table */
8122f2b0278Sdrh };
8132f2b0278Sdrh 
8142f2b0278Sdrh /*
8152f2b0278Sdrh ** This function is called for every node of an expression that is a candidate
8162f2b0278Sdrh ** for a cursor hint on an index cursor.  For TK_COLUMN nodes that reference
8172f2b0278Sdrh ** the table CCurHint.iTabCur, verify that the same column can be
8182f2b0278Sdrh ** accessed through the index.  If it cannot, then set pWalker->eCode to 1.
8192f2b0278Sdrh */
8202f2b0278Sdrh static int codeCursorHintCheckExpr(Walker *pWalker, Expr *pExpr){
8212f2b0278Sdrh   struct CCurHint *pHint = pWalker->u.pCCurHint;
8222f2b0278Sdrh   assert( pHint->pIdx!=0 );
8232f2b0278Sdrh   if( pExpr->op==TK_COLUMN
8242f2b0278Sdrh    && pExpr->iTable==pHint->iTabCur
8252f2b0278Sdrh    && sqlite3ColumnOfIndex(pHint->pIdx, pExpr->iColumn)<0
8262f2b0278Sdrh   ){
8272f2b0278Sdrh     pWalker->eCode = 1;
8282f2b0278Sdrh   }
8292f2b0278Sdrh   return WRC_Continue;
8302f2b0278Sdrh }
8312f2b0278Sdrh 
832e6912fd8Sdan /*
833e6912fd8Sdan ** Test whether or not expression pExpr, which was part of a WHERE clause,
834e6912fd8Sdan ** should be included in the cursor-hint for a table that is on the rhs
835e6912fd8Sdan ** of a LEFT JOIN. Set Walker.eCode to non-zero before returning if the
836e6912fd8Sdan ** expression is not suitable.
837e6912fd8Sdan **
838e6912fd8Sdan ** An expression is unsuitable if it might evaluate to non NULL even if
839e6912fd8Sdan ** a TK_COLUMN node that does affect the value of the expression is set
840e6912fd8Sdan ** to NULL. For example:
841e6912fd8Sdan **
842e6912fd8Sdan **   col IS NULL
843e6912fd8Sdan **   col IS NOT NULL
844e6912fd8Sdan **   coalesce(col, 1)
845e6912fd8Sdan **   CASE WHEN col THEN 0 ELSE 1 END
846e6912fd8Sdan */
847e6912fd8Sdan static int codeCursorHintIsOrFunction(Walker *pWalker, Expr *pExpr){
8482b693d63Sdan   if( pExpr->op==TK_IS
849e6912fd8Sdan    || pExpr->op==TK_ISNULL || pExpr->op==TK_ISNOT
850e6912fd8Sdan    || pExpr->op==TK_NOTNULL || pExpr->op==TK_CASE
851e6912fd8Sdan   ){
852e6912fd8Sdan     pWalker->eCode = 1;
8532b693d63Sdan   }else if( pExpr->op==TK_FUNCTION ){
8542b693d63Sdan     int d1;
8551d42ea71Sdrh     char d2[4];
8562b693d63Sdan     if( 0==sqlite3IsLikeFunction(pWalker->pParse->db, pExpr, &d1, d2) ){
8572b693d63Sdan       pWalker->eCode = 1;
858e6912fd8Sdan     }
8592b693d63Sdan   }
8602b693d63Sdan 
861e6912fd8Sdan   return WRC_Continue;
862e6912fd8Sdan }
863e6912fd8Sdan 
864bec2476aSdrh 
865bec2476aSdrh /*
866bec2476aSdrh ** This function is called on every node of an expression tree used as an
867bec2476aSdrh ** argument to the OP_CursorHint instruction. If the node is a TK_COLUMN
8682f2b0278Sdrh ** that accesses any table other than the one identified by
8692f2b0278Sdrh ** CCurHint.iTabCur, then do the following:
870bec2476aSdrh **
871bec2476aSdrh **   1) allocate a register and code an OP_Column instruction to read
872bec2476aSdrh **      the specified column into the new register, and
873bec2476aSdrh **
874bec2476aSdrh **   2) transform the expression node to a TK_REGISTER node that reads
875bec2476aSdrh **      from the newly populated register.
8762f2b0278Sdrh **
8772f2b0278Sdrh ** Also, if the node is a TK_COLUMN that does access the table idenified
8782f2b0278Sdrh ** by pCCurHint.iTabCur, and an index is being used (which we will
8792f2b0278Sdrh ** know because CCurHint.pIdx!=0) then transform the TK_COLUMN into
8802f2b0278Sdrh ** an access of the index rather than the original table.
881bec2476aSdrh */
882bec2476aSdrh static int codeCursorHintFixExpr(Walker *pWalker, Expr *pExpr){
883bec2476aSdrh   int rc = WRC_Continue;
8842f2b0278Sdrh   struct CCurHint *pHint = pWalker->u.pCCurHint;
885be312ae9Sdan   if( pExpr->op==TK_COLUMN ){
8862f2b0278Sdrh     if( pExpr->iTable!=pHint->iTabCur ){
887bec2476aSdrh       int reg = ++pWalker->pParse->nMem;   /* Register for column value */
888e3e79213Sdan       sqlite3ExprCode(pWalker->pParse, pExpr, reg);
889bec2476aSdrh       pExpr->op = TK_REGISTER;
890bec2476aSdrh       pExpr->iTable = reg;
8912f2b0278Sdrh     }else if( pHint->pIdx!=0 ){
8922f2b0278Sdrh       pExpr->iTable = pHint->iIdxCur;
8932f2b0278Sdrh       pExpr->iColumn = sqlite3ColumnOfIndex(pHint->pIdx, pExpr->iColumn);
8942f2b0278Sdrh       assert( pExpr->iColumn>=0 );
8952f2b0278Sdrh     }
896bec2476aSdrh   }else if( pExpr->op==TK_AGG_FUNCTION ){
897bec2476aSdrh     /* An aggregate function in the WHERE clause of a query means this must
898bec2476aSdrh     ** be a correlated sub-query, and expression pExpr is an aggregate from
899bec2476aSdrh     ** the parent context. Do not walk the function arguments in this case.
900bec2476aSdrh     **
901bec2476aSdrh     ** todo: It should be possible to replace this node with a TK_REGISTER
902bec2476aSdrh     ** expression, as the result of the expression must be stored in a
903bec2476aSdrh     ** register at this point. The same holds for TK_AGG_COLUMN nodes. */
904bec2476aSdrh     rc = WRC_Prune;
905bec2476aSdrh   }
906bec2476aSdrh   return rc;
907bec2476aSdrh }
908bec2476aSdrh 
909bec2476aSdrh /*
910bec2476aSdrh ** Insert an OP_CursorHint instruction if it is appropriate to do so.
911bec2476aSdrh */
912bec2476aSdrh static void codeCursorHint(
913b324cf75Sdan   struct SrcList_item *pTabItem,  /* FROM clause item */
914b413a546Sdrh   WhereInfo *pWInfo,    /* The where clause */
915b413a546Sdrh   WhereLevel *pLevel,   /* Which loop to provide hints for */
916b413a546Sdrh   WhereTerm *pEndRange  /* Hint this end-of-scan boundary term if not NULL */
917bec2476aSdrh ){
918bec2476aSdrh   Parse *pParse = pWInfo->pParse;
919bec2476aSdrh   sqlite3 *db = pParse->db;
920bec2476aSdrh   Vdbe *v = pParse->pVdbe;
921bec2476aSdrh   Expr *pExpr = 0;
9222f2b0278Sdrh   WhereLoop *pLoop = pLevel->pWLoop;
923bec2476aSdrh   int iCur;
924bec2476aSdrh   WhereClause *pWC;
925bec2476aSdrh   WhereTerm *pTerm;
926b413a546Sdrh   int i, j;
9272f2b0278Sdrh   struct CCurHint sHint;
9282f2b0278Sdrh   Walker sWalker;
929bec2476aSdrh 
930bec2476aSdrh   if( OptimizationDisabled(db, SQLITE_CursorHints) ) return;
9312f2b0278Sdrh   iCur = pLevel->iTabCur;
9322f2b0278Sdrh   assert( iCur==pWInfo->pTabList->a[pLevel->iFrom].iCursor );
9332f2b0278Sdrh   sHint.iTabCur = iCur;
9342f2b0278Sdrh   sHint.iIdxCur = pLevel->iIdxCur;
9352f2b0278Sdrh   sHint.pIdx = pLoop->u.btree.pIndex;
9362f2b0278Sdrh   memset(&sWalker, 0, sizeof(sWalker));
9372f2b0278Sdrh   sWalker.pParse = pParse;
9382f2b0278Sdrh   sWalker.u.pCCurHint = &sHint;
939bec2476aSdrh   pWC = &pWInfo->sWC;
940bec2476aSdrh   for(i=0; i<pWC->nTerm; i++){
941bec2476aSdrh     pTerm = &pWC->a[i];
942bec2476aSdrh     if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
943bec2476aSdrh     if( pTerm->prereqAll & pLevel->notReady ) continue;
944b324cf75Sdan 
945b324cf75Sdan     /* Any terms specified as part of the ON(...) clause for any LEFT
946b324cf75Sdan     ** JOIN for which the current table is not the rhs are omitted
947b324cf75Sdan     ** from the cursor-hint.
948b324cf75Sdan     **
949e6912fd8Sdan     ** If this table is the rhs of a LEFT JOIN, "IS" or "IS NULL" terms
950e6912fd8Sdan     ** that were specified as part of the WHERE clause must be excluded.
951e6912fd8Sdan     ** This is to address the following:
952b324cf75Sdan     **
953b324cf75Sdan     **   SELECT ... t1 LEFT JOIN t2 ON (t1.a=t2.b) WHERE t2.c IS NULL;
954b324cf75Sdan     **
955e6912fd8Sdan     ** Say there is a single row in t2 that matches (t1.a=t2.b), but its
956e6912fd8Sdan     ** t2.c values is not NULL. If the (t2.c IS NULL) constraint is
957e6912fd8Sdan     ** pushed down to the cursor, this row is filtered out, causing
958e6912fd8Sdan     ** SQLite to synthesize a row of NULL values. Which does match the
959e6912fd8Sdan     ** WHERE clause, and so the query returns a row. Which is incorrect.
960e6912fd8Sdan     **
961e6912fd8Sdan     ** For the same reason, WHERE terms such as:
962e6912fd8Sdan     **
963e6912fd8Sdan     **   WHERE 1 = (t2.c IS NULL)
964e6912fd8Sdan     **
965e6912fd8Sdan     ** are also excluded. See codeCursorHintIsOrFunction() for details.
966b324cf75Sdan     */
967b324cf75Sdan     if( pTabItem->fg.jointype & JT_LEFT ){
968e6912fd8Sdan       Expr *pExpr = pTerm->pExpr;
969e6912fd8Sdan       if( !ExprHasProperty(pExpr, EP_FromJoin)
970e6912fd8Sdan        || pExpr->iRightJoinTable!=pTabItem->iCursor
971b324cf75Sdan       ){
972e6912fd8Sdan         sWalker.eCode = 0;
973e6912fd8Sdan         sWalker.xExprCallback = codeCursorHintIsOrFunction;
974e6912fd8Sdan         sqlite3WalkExpr(&sWalker, pTerm->pExpr);
975e6912fd8Sdan         if( sWalker.eCode ) continue;
976b324cf75Sdan       }
977b324cf75Sdan     }else{
978bec2476aSdrh       if( ExprHasProperty(pTerm->pExpr, EP_FromJoin) ) continue;
979b324cf75Sdan     }
980b413a546Sdrh 
981b413a546Sdrh     /* All terms in pWLoop->aLTerm[] except pEndRange are used to initialize
982bcf40a7fSdrh     ** the cursor.  These terms are not needed as hints for a pure range
983bcf40a7fSdrh     ** scan (that has no == terms) so omit them. */
984bcf40a7fSdrh     if( pLoop->u.btree.nEq==0 && pTerm!=pEndRange ){
985bcf40a7fSdrh       for(j=0; j<pLoop->nLTerm && pLoop->aLTerm[j]!=pTerm; j++){}
986bcf40a7fSdrh       if( j<pLoop->nLTerm ) continue;
987b413a546Sdrh     }
988b413a546Sdrh 
989b413a546Sdrh     /* No subqueries or non-deterministic functions allowed */
990bec2476aSdrh     if( sqlite3ExprContainsSubquery(pTerm->pExpr) ) continue;
991b413a546Sdrh 
992b413a546Sdrh     /* For an index scan, make sure referenced columns are actually in
993b413a546Sdrh     ** the index. */
9942f2b0278Sdrh     if( sHint.pIdx!=0 ){
9952f2b0278Sdrh       sWalker.eCode = 0;
9962f2b0278Sdrh       sWalker.xExprCallback = codeCursorHintCheckExpr;
9972f2b0278Sdrh       sqlite3WalkExpr(&sWalker, pTerm->pExpr);
9982f2b0278Sdrh       if( sWalker.eCode ) continue;
9992f2b0278Sdrh     }
1000b413a546Sdrh 
1001b413a546Sdrh     /* If we survive all prior tests, that means this term is worth hinting */
1002bec2476aSdrh     pExpr = sqlite3ExprAnd(db, pExpr, sqlite3ExprDup(db, pTerm->pExpr, 0));
1003bec2476aSdrh   }
1004bec2476aSdrh   if( pExpr!=0 ){
1005bec2476aSdrh     sWalker.xExprCallback = codeCursorHintFixExpr;
1006bec2476aSdrh     sqlite3WalkExpr(&sWalker, pExpr);
10072f2b0278Sdrh     sqlite3VdbeAddOp4(v, OP_CursorHint,
10082f2b0278Sdrh                       (sHint.pIdx ? sHint.iIdxCur : sHint.iTabCur), 0, 0,
10092f2b0278Sdrh                       (const char*)pExpr, P4_EXPR);
1010bec2476aSdrh   }
1011bec2476aSdrh }
1012bec2476aSdrh #else
1013b324cf75Sdan # define codeCursorHint(A,B,C,D)  /* No-op */
1014bec2476aSdrh #endif /* SQLITE_ENABLE_CURSOR_HINTS */
10156f82e85aSdrh 
10166f82e85aSdrh /*
1017de892d96Sdan ** Cursor iCur is open on an intkey b-tree (a table). Register iRowid contains
1018de892d96Sdan ** a rowid value just read from cursor iIdxCur, open on index pIdx. This
1019de892d96Sdan ** function generates code to do a deferred seek of cursor iCur to the
1020de892d96Sdan ** rowid stored in register iRowid.
1021de892d96Sdan **
1022de892d96Sdan ** Normally, this is just:
1023de892d96Sdan **
1024170ad68aSdrh **   OP_DeferredSeek $iCur $iRowid
1025de892d96Sdan **
1026de892d96Sdan ** However, if the scan currently being coded is a branch of an OR-loop and
1027170ad68aSdrh ** the statement currently being coded is a SELECT, then P3 of OP_DeferredSeek
1028de892d96Sdan ** is set to iIdxCur and P4 is set to point to an array of integers
1029de892d96Sdan ** containing one entry for each column of the table cursor iCur is open
1030de892d96Sdan ** on. For each table column, if the column is the i'th column of the
1031de892d96Sdan ** index, then the corresponding array entry is set to (i+1). If the column
1032de892d96Sdan ** does not appear in the index at all, the array entry is set to 0.
1033de892d96Sdan */
1034de892d96Sdan static void codeDeferredSeek(
1035de892d96Sdan   WhereInfo *pWInfo,              /* Where clause context */
1036de892d96Sdan   Index *pIdx,                    /* Index scan is using */
1037de892d96Sdan   int iCur,                       /* Cursor for IPK b-tree */
1038de892d96Sdan   int iIdxCur                     /* Index cursor */
1039de892d96Sdan ){
1040de892d96Sdan   Parse *pParse = pWInfo->pParse; /* Parse context */
1041de892d96Sdan   Vdbe *v = pParse->pVdbe;        /* Vdbe to generate code within */
1042de892d96Sdan 
1043de892d96Sdan   assert( iIdxCur>0 );
1044de892d96Sdan   assert( pIdx->aiColumn[pIdx->nColumn-1]==-1 );
1045de892d96Sdan 
1046170ad68aSdrh   sqlite3VdbeAddOp3(v, OP_DeferredSeek, iIdxCur, 0, iCur);
1047ce943bc8Sdrh   if( (pWInfo->wctrlFlags & WHERE_OR_SUBCLAUSE)
1048cddb6ba0Sdan    && DbMaskAllZero(sqlite3ParseToplevel(pParse)->writeMask)
1049de892d96Sdan   ){
1050de892d96Sdan     int i;
1051de892d96Sdan     Table *pTab = pIdx->pTable;
1052b1702026Sdrh     int *ai = (int*)sqlite3DbMallocZero(pParse->db, sizeof(int)*(pTab->nCol+1));
1053de892d96Sdan     if( ai ){
1054b1702026Sdrh       ai[0] = pTab->nCol;
1055de892d96Sdan       for(i=0; i<pIdx->nColumn-1; i++){
1056de892d96Sdan         assert( pIdx->aiColumn[i]<pTab->nCol );
1057b1702026Sdrh         if( pIdx->aiColumn[i]>=0 ) ai[pIdx->aiColumn[i]+1] = i+1;
1058de892d96Sdan       }
1059de892d96Sdan       sqlite3VdbeChangeP4(v, -1, (char*)ai, P4_INTARRAY);
1060de892d96Sdan     }
1061de892d96Sdan   }
1062de892d96Sdan }
1063de892d96Sdan 
1064553168c7Sdan /*
1065553168c7Sdan ** If the expression passed as the second argument is a vector, generate
1066553168c7Sdan ** code to write the first nReg elements of the vector into an array
1067553168c7Sdan ** of registers starting with iReg.
1068553168c7Sdan **
1069553168c7Sdan ** If the expression is not a vector, then nReg must be passed 1. In
1070553168c7Sdan ** this case, generate code to evaluate the expression and leave the
1071553168c7Sdan ** result in register iReg.
1072553168c7Sdan */
107371c57db0Sdan static void codeExprOrVector(Parse *pParse, Expr *p, int iReg, int nReg){
107471c57db0Sdan   assert( nReg>0 );
1075d03024d8Sdan   if( p && sqlite3ExprIsVector(p) ){
1076f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
1077f9b2e05cSdan     if( (p->flags & EP_xIsSelect) ){
1078f9b2e05cSdan       Vdbe *v = pParse->pVdbe;
1079f9b2e05cSdan       int iSelect = sqlite3CodeSubselect(pParse, p, 0, 0);
1080f9b2e05cSdan       sqlite3VdbeAddOp3(v, OP_Copy, iSelect, iReg, nReg-1);
1081f9b2e05cSdan     }else
1082f9b2e05cSdan #endif
1083f9b2e05cSdan     {
108471c57db0Sdan       int i;
108571c57db0Sdan       ExprList *pList = p->x.pList;
108671c57db0Sdan       assert( nReg<=pList->nExpr );
108771c57db0Sdan       for(i=0; i<nReg; i++){
108871c57db0Sdan         sqlite3ExprCode(pParse, pList->a[i].pExpr, iReg+i);
108971c57db0Sdan       }
109071c57db0Sdan     }
109171c57db0Sdan   }else{
109271c57db0Sdan     assert( nReg==1 );
109371c57db0Sdan     sqlite3ExprCode(pParse, p, iReg);
109471c57db0Sdan   }
109571c57db0Sdan }
109671c57db0Sdan 
1097eac5fc04Sdrh /* An instance of the IdxExprTrans object carries information about a
1098eac5fc04Sdrh ** mapping from an expression on table columns into a column in an index
1099eac5fc04Sdrh ** down through the Walker.
1100eac5fc04Sdrh */
1101aca19e19Sdrh typedef struct IdxExprTrans {
1102aca19e19Sdrh   Expr *pIdxExpr;    /* The index expression */
1103aca19e19Sdrh   int iTabCur;       /* The cursor of the corresponding table */
1104aca19e19Sdrh   int iIdxCur;       /* The cursor for the index */
1105aca19e19Sdrh   int iIdxCol;       /* The column for the index */
1106aca19e19Sdrh } IdxExprTrans;
1107aca19e19Sdrh 
1108eac5fc04Sdrh /* The walker node callback used to transform matching expressions into
1109eac5fc04Sdrh ** a reference to an index column for an index on an expression.
1110eac5fc04Sdrh **
1111eac5fc04Sdrh ** If pExpr matches, then transform it into a reference to the index column
1112eac5fc04Sdrh ** that contains the value of pExpr.
1113eac5fc04Sdrh */
1114aca19e19Sdrh static int whereIndexExprTransNode(Walker *p, Expr *pExpr){
1115aca19e19Sdrh   IdxExprTrans *pX = p->u.pIdxTrans;
11165aa550cfSdan   if( sqlite3ExprCompare(0, pExpr, pX->pIdxExpr, pX->iTabCur)==0 ){
1117aca19e19Sdrh     pExpr->op = TK_COLUMN;
1118aca19e19Sdrh     pExpr->iTable = pX->iIdxCur;
1119aca19e19Sdrh     pExpr->iColumn = pX->iIdxCol;
1120*eda079cdSdrh     pExpr->y.pTab = 0;
1121aca19e19Sdrh     return WRC_Prune;
1122aca19e19Sdrh   }else{
1123aca19e19Sdrh     return WRC_Continue;
1124aca19e19Sdrh   }
1125aca19e19Sdrh }
1126aca19e19Sdrh 
1127aca19e19Sdrh /*
1128f49759bfSdrh ** For an indexes on expression X, locate every instance of expression X
1129f49759bfSdrh ** in pExpr and change that subexpression into a reference to the appropriate
1130f49759bfSdrh ** column of the index.
1131aca19e19Sdrh */
1132aca19e19Sdrh static void whereIndexExprTrans(
1133aca19e19Sdrh   Index *pIdx,      /* The Index */
1134aca19e19Sdrh   int iTabCur,      /* Cursor of the table that is being indexed */
1135aca19e19Sdrh   int iIdxCur,      /* Cursor of the index itself */
1136aca19e19Sdrh   WhereInfo *pWInfo /* Transform expressions in this WHERE clause */
1137aca19e19Sdrh ){
1138aca19e19Sdrh   int iIdxCol;               /* Column number of the index */
1139aca19e19Sdrh   ExprList *aColExpr;        /* Expressions that are indexed */
1140aca19e19Sdrh   Walker w;
1141aca19e19Sdrh   IdxExprTrans x;
1142aca19e19Sdrh   aColExpr = pIdx->aColExpr;
1143aca19e19Sdrh   if( aColExpr==0 ) return;  /* Not an index on expressions */
1144aca19e19Sdrh   memset(&w, 0, sizeof(w));
1145aca19e19Sdrh   w.xExprCallback = whereIndexExprTransNode;
1146aca19e19Sdrh   w.u.pIdxTrans = &x;
1147aca19e19Sdrh   x.iTabCur = iTabCur;
1148aca19e19Sdrh   x.iIdxCur = iIdxCur;
1149aca19e19Sdrh   for(iIdxCol=0; iIdxCol<aColExpr->nExpr; iIdxCol++){
1150aca19e19Sdrh     if( pIdx->aiColumn[iIdxCol]!=XN_EXPR ) continue;
1151aca19e19Sdrh     assert( aColExpr->a[iIdxCol].pExpr!=0 );
1152aca19e19Sdrh     x.iIdxCol = iIdxCol;
1153aca19e19Sdrh     x.pIdxExpr = aColExpr->a[iIdxCol].pExpr;
1154aca19e19Sdrh     sqlite3WalkExpr(&w, pWInfo->pWhere);
1155aca19e19Sdrh     sqlite3WalkExprList(&w, pWInfo->pOrderBy);
1156aca19e19Sdrh     sqlite3WalkExprList(&w, pWInfo->pResultSet);
1157aca19e19Sdrh   }
1158aca19e19Sdrh }
1159aca19e19Sdrh 
1160de892d96Sdan /*
11616f82e85aSdrh ** Generate code for the start of the iLevel-th loop in the WHERE clause
11626f82e85aSdrh ** implementation described by pWInfo.
11636f82e85aSdrh */
11646f82e85aSdrh Bitmask sqlite3WhereCodeOneLoopStart(
11656f82e85aSdrh   WhereInfo *pWInfo,   /* Complete information about the WHERE clause */
11666f82e85aSdrh   int iLevel,          /* Which level of pWInfo->a[] should be coded */
11676f82e85aSdrh   Bitmask notReady     /* Which tables are currently available */
11686f82e85aSdrh ){
11696f82e85aSdrh   int j, k;            /* Loop counters */
11706f82e85aSdrh   int iCur;            /* The VDBE cursor for the table */
11716f82e85aSdrh   int addrNxt;         /* Where to jump to continue with the next IN case */
11726f82e85aSdrh   int omitTable;       /* True if we use the index only */
11736f82e85aSdrh   int bRev;            /* True if we need to scan in reverse order */
11746f82e85aSdrh   WhereLevel *pLevel;  /* The where level to be coded */
11756f82e85aSdrh   WhereLoop *pLoop;    /* The WhereLoop object being coded */
11766f82e85aSdrh   WhereClause *pWC;    /* Decomposition of the entire WHERE clause */
11776f82e85aSdrh   WhereTerm *pTerm;               /* A WHERE clause term */
11786f82e85aSdrh   Parse *pParse;                  /* Parsing context */
11796f82e85aSdrh   sqlite3 *db;                    /* Database connection */
11806f82e85aSdrh   Vdbe *v;                        /* The prepared stmt under constructions */
11816f82e85aSdrh   struct SrcList_item *pTabItem;  /* FROM clause term being coded */
11826f82e85aSdrh   int addrBrk;                    /* Jump here to break out of the loop */
11833a3b420aSdrh   int addrHalt;                   /* addrBrk for the outermost loop */
11846f82e85aSdrh   int addrCont;                   /* Jump here to continue with next cycle */
11856f82e85aSdrh   int iRowidReg = 0;        /* Rowid is stored in this register, if not zero */
11866f82e85aSdrh   int iReleaseReg = 0;      /* Temp register to free before returning */
11876f654a40Sdan   Index *pIdx = 0;          /* Index used by loop (if any) */
1188ebc63013Sdan   int iLoop;                /* Iteration of constraint generator loop */
11896f82e85aSdrh 
11906f82e85aSdrh   pParse = pWInfo->pParse;
11916f82e85aSdrh   v = pParse->pVdbe;
11926f82e85aSdrh   pWC = &pWInfo->sWC;
11936f82e85aSdrh   db = pParse->db;
11946f82e85aSdrh   pLevel = &pWInfo->a[iLevel];
11956f82e85aSdrh   pLoop = pLevel->pWLoop;
11966f82e85aSdrh   pTabItem = &pWInfo->pTabList->a[pLevel->iFrom];
11976f82e85aSdrh   iCur = pTabItem->iCursor;
11986f82e85aSdrh   pLevel->notReady = notReady & ~sqlite3WhereGetMask(&pWInfo->sMaskSet, iCur);
11996f82e85aSdrh   bRev = (pWInfo->revMask>>iLevel)&1;
12006f82e85aSdrh   omitTable = (pLoop->wsFlags & WHERE_IDX_ONLY)!=0
1201ce943bc8Sdrh            && (pWInfo->wctrlFlags & WHERE_OR_SUBCLAUSE)==0;
12026f82e85aSdrh   VdbeModuleComment((v, "Begin WHERE-loop%d: %s",iLevel,pTabItem->pTab->zName));
12036f82e85aSdrh 
12046f82e85aSdrh   /* Create labels for the "break" and "continue" instructions
12056f82e85aSdrh   ** for the current loop.  Jump to addrBrk to break out of a loop.
12066f82e85aSdrh   ** Jump to cont to go immediately to the next iteration of the
12076f82e85aSdrh   ** loop.
12086f82e85aSdrh   **
12096f82e85aSdrh   ** When there is an IN operator, we also have a "addrNxt" label that
12106f82e85aSdrh   ** means to continue with the next IN value combination.  When
12116f82e85aSdrh   ** there are no IN operators in the constraints, the "addrNxt" label
12126f82e85aSdrh   ** is the same as "addrBrk".
12136f82e85aSdrh   */
12146f82e85aSdrh   addrBrk = pLevel->addrBrk = pLevel->addrNxt = sqlite3VdbeMakeLabel(v);
12156f82e85aSdrh   addrCont = pLevel->addrCont = sqlite3VdbeMakeLabel(v);
12166f82e85aSdrh 
12176f82e85aSdrh   /* If this is the right table of a LEFT OUTER JOIN, allocate and
12186f82e85aSdrh   ** initialize a memory cell that records if this table matches any
12196f82e85aSdrh   ** row of the left table of the join.
12206f82e85aSdrh   */
1221820fcd2cSdan   assert( (pWInfo->wctrlFlags & WHERE_OR_SUBCLAUSE)
1222820fcd2cSdan        || pLevel->iFrom>0 || (pTabItem[0].fg.jointype & JT_LEFT)==0
1223820fcd2cSdan   );
12248a48b9c0Sdrh   if( pLevel->iFrom>0 && (pTabItem[0].fg.jointype & JT_LEFT)!=0 ){
12256f82e85aSdrh     pLevel->iLeftJoin = ++pParse->nMem;
12266f82e85aSdrh     sqlite3VdbeAddOp2(v, OP_Integer, 0, pLevel->iLeftJoin);
12276f82e85aSdrh     VdbeComment((v, "init LEFT JOIN no-match flag"));
12286f82e85aSdrh   }
12296f82e85aSdrh 
12303a3b420aSdrh   /* Compute a safe address to jump to if we discover that the table for
12313a3b420aSdrh   ** this loop is empty and can never contribute content. */
12323a3b420aSdrh   for(j=iLevel; j>0 && pWInfo->a[j].iLeftJoin==0; j--){}
12333a3b420aSdrh   addrHalt = pWInfo->a[j].addrBrk;
12343a3b420aSdrh 
12356f82e85aSdrh   /* Special case of a FROM clause subquery implemented as a co-routine */
12368a48b9c0Sdrh   if( pTabItem->fg.viaCoroutine ){
12376f82e85aSdrh     int regYield = pTabItem->regReturn;
12386f82e85aSdrh     sqlite3VdbeAddOp3(v, OP_InitCoroutine, regYield, 0, pTabItem->addrFillSub);
12396f82e85aSdrh     pLevel->p2 =  sqlite3VdbeAddOp2(v, OP_Yield, regYield, addrBrk);
12406f82e85aSdrh     VdbeCoverage(v);
1241fef37760Sdrh     VdbeComment((v, "next row of %s", pTabItem->pTab->zName));
12426f82e85aSdrh     pLevel->op = OP_Goto;
12436f82e85aSdrh   }else
12446f82e85aSdrh 
12456f82e85aSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
12466f82e85aSdrh   if(  (pLoop->wsFlags & WHERE_VIRTUALTABLE)!=0 ){
12476f82e85aSdrh     /* Case 1:  The table is a virtual-table.  Use the VFilter and VNext
12486f82e85aSdrh     **          to access the data.
12496f82e85aSdrh     */
12506f82e85aSdrh     int iReg;   /* P3 Value for OP_VFilter */
12516f82e85aSdrh     int addrNotFound;
12526f82e85aSdrh     int nConstraint = pLoop->nLTerm;
1253dbc49161Sdrh     int iIn;    /* Counter for IN constraints */
12546f82e85aSdrh 
12556f82e85aSdrh     iReg = sqlite3GetTempRange(pParse, nConstraint+2);
12566f82e85aSdrh     addrNotFound = pLevel->addrBrk;
12576f82e85aSdrh     for(j=0; j<nConstraint; j++){
12586f82e85aSdrh       int iTarget = iReg+j+2;
12596f82e85aSdrh       pTerm = pLoop->aLTerm[j];
1260599d5764Sdrh       if( NEVER(pTerm==0) ) continue;
12616f82e85aSdrh       if( pTerm->eOperator & WO_IN ){
12626f82e85aSdrh         codeEqualityTerm(pParse, pTerm, pLevel, j, bRev, iTarget);
12636f82e85aSdrh         addrNotFound = pLevel->addrNxt;
12646f82e85aSdrh       }else{
12656256c1c2Sdan         Expr *pRight = pTerm->pExpr->pRight;
12666256c1c2Sdan         codeExprOrVector(pParse, pRight, iTarget, 1);
12676256c1c2Sdan       }
12686f82e85aSdrh     }
12696f82e85aSdrh     sqlite3VdbeAddOp2(v, OP_Integer, pLoop->u.vtab.idxNum, iReg);
12706f82e85aSdrh     sqlite3VdbeAddOp2(v, OP_Integer, nConstraint, iReg+1);
12716f82e85aSdrh     sqlite3VdbeAddOp4(v, OP_VFilter, iCur, addrNotFound, iReg,
12726f82e85aSdrh                       pLoop->u.vtab.idxStr,
1273861b1307Sdrh                       pLoop->u.vtab.needFree ? P4_DYNAMIC : P4_STATIC);
12746f82e85aSdrh     VdbeCoverage(v);
12756f82e85aSdrh     pLoop->u.vtab.needFree = 0;
12766f82e85aSdrh     pLevel->p1 = iCur;
1277354474adSdan     pLevel->op = pWInfo->eOnePass ? OP_Noop : OP_VNext;
12786f82e85aSdrh     pLevel->p2 = sqlite3VdbeCurrentAddr(v);
1279dbc49161Sdrh     iIn = pLevel->u.in.nIn;
1280dbc49161Sdrh     for(j=nConstraint-1; j>=0; j--){
1281dbc49161Sdrh       pTerm = pLoop->aLTerm[j];
1282dbc49161Sdrh       if( j<16 && (pLoop->u.vtab.omitMask>>j)&1 ){
1283dbc49161Sdrh         disableTerm(pLevel, pTerm);
1284dbc49161Sdrh       }else if( (pTerm->eOperator & WO_IN)!=0 ){
1285dbc49161Sdrh         Expr *pCompare;  /* The comparison operator */
1286dbc49161Sdrh         Expr *pRight;    /* RHS of the comparison */
1287dbc49161Sdrh         VdbeOp *pOp;     /* Opcode to access the value of the IN constraint */
1288dbc49161Sdrh 
1289dbc49161Sdrh         /* Reload the constraint value into reg[iReg+j+2].  The same value
1290dbc49161Sdrh         ** was loaded into the same register prior to the OP_VFilter, but
1291dbc49161Sdrh         ** the xFilter implementation might have changed the datatype or
1292dbc49161Sdrh         ** encoding of the value in the register, so it *must* be reloaded. */
1293dbc49161Sdrh         assert( pLevel->u.in.aInLoop!=0 || db->mallocFailed );
1294fb826b8cSdrh         if( !db->mallocFailed ){
1295dbc49161Sdrh           assert( iIn>0 );
1296dbc49161Sdrh           pOp = sqlite3VdbeGetOp(v, pLevel->u.in.aInLoop[--iIn].addrInTop);
1297dbc49161Sdrh           assert( pOp->opcode==OP_Column || pOp->opcode==OP_Rowid );
1298dbc49161Sdrh           assert( pOp->opcode!=OP_Column || pOp->p3==iReg+j+2 );
1299dbc49161Sdrh           assert( pOp->opcode!=OP_Rowid || pOp->p2==iReg+j+2 );
1300dbc49161Sdrh           testcase( pOp->opcode==OP_Rowid );
1301dbc49161Sdrh           sqlite3VdbeAddOp3(v, pOp->opcode, pOp->p1, pOp->p2, pOp->p3);
1302dbc49161Sdrh         }
1303dbc49161Sdrh 
1304dbc49161Sdrh         /* Generate code that will continue to the next row if
1305dbc49161Sdrh         ** the IN constraint is not satisfied */
1306abfd35eaSdrh         pCompare = sqlite3PExpr(pParse, TK_EQ, 0, 0);
1307dbc49161Sdrh         assert( pCompare!=0 || db->mallocFailed );
1308dbc49161Sdrh         if( pCompare ){
1309dbc49161Sdrh           pCompare->pLeft = pTerm->pExpr->pLeft;
1310dbc49161Sdrh           pCompare->pRight = pRight = sqlite3Expr(db, TK_REGISTER, 0);
1311237b2b71Sdrh           if( pRight ){
1312237b2b71Sdrh             pRight->iTable = iReg+j+2;
1313dbc49161Sdrh             sqlite3ExprIfFalse(pParse, pCompare, pLevel->addrCont, 0);
1314237b2b71Sdrh           }
1315dbc49161Sdrh           pCompare->pLeft = 0;
1316dbc49161Sdrh           sqlite3ExprDelete(db, pCompare);
1317dbc49161Sdrh         }
1318dbc49161Sdrh       }
1319dbc49161Sdrh     }
1320ba26faa3Sdrh     /* These registers need to be preserved in case there is an IN operator
1321ba26faa3Sdrh     ** loop.  So we could deallocate the registers here (and potentially
1322ba26faa3Sdrh     ** reuse them later) if (pLoop->wsFlags & WHERE_IN_ABLE)==0.  But it seems
1323ba26faa3Sdrh     ** simpler and safer to simply not reuse the registers.
1324ba26faa3Sdrh     **
1325ba26faa3Sdrh     **    sqlite3ReleaseTempRange(pParse, iReg, nConstraint+2);
1326ba26faa3Sdrh     */
13276f82e85aSdrh   }else
13286f82e85aSdrh #endif /* SQLITE_OMIT_VIRTUALTABLE */
13296f82e85aSdrh 
13306f82e85aSdrh   if( (pLoop->wsFlags & WHERE_IPK)!=0
13316f82e85aSdrh    && (pLoop->wsFlags & (WHERE_COLUMN_IN|WHERE_COLUMN_EQ))!=0
13326f82e85aSdrh   ){
13336f82e85aSdrh     /* Case 2:  We can directly reference a single row using an
13346f82e85aSdrh     **          equality comparison against the ROWID field.  Or
13356f82e85aSdrh     **          we reference multiple rows using a "rowid IN (...)"
13366f82e85aSdrh     **          construct.
13376f82e85aSdrh     */
13386f82e85aSdrh     assert( pLoop->u.btree.nEq==1 );
13396f82e85aSdrh     pTerm = pLoop->aLTerm[0];
13406f82e85aSdrh     assert( pTerm!=0 );
13416f82e85aSdrh     assert( pTerm->pExpr!=0 );
13426f82e85aSdrh     assert( omitTable==0 );
13436f82e85aSdrh     testcase( pTerm->wtFlags & TERM_VIRTUAL );
13446f82e85aSdrh     iReleaseReg = ++pParse->nMem;
13456f82e85aSdrh     iRowidReg = codeEqualityTerm(pParse, pTerm, pLevel, 0, bRev, iReleaseReg);
13466f82e85aSdrh     if( iRowidReg!=iReleaseReg ) sqlite3ReleaseTempReg(pParse, iReleaseReg);
13476f82e85aSdrh     addrNxt = pLevel->addrNxt;
1348eeb9565aSdrh     sqlite3VdbeAddOp3(v, OP_SeekRowid, iCur, addrNxt, iRowidReg);
13496f82e85aSdrh     VdbeCoverage(v);
13506f82e85aSdrh     pLevel->op = OP_Noop;
13516f82e85aSdrh   }else if( (pLoop->wsFlags & WHERE_IPK)!=0
13526f82e85aSdrh          && (pLoop->wsFlags & WHERE_COLUMN_RANGE)!=0
13536f82e85aSdrh   ){
13546f82e85aSdrh     /* Case 3:  We have an inequality comparison against the ROWID field.
13556f82e85aSdrh     */
13566f82e85aSdrh     int testOp = OP_Noop;
13576f82e85aSdrh     int start;
13586f82e85aSdrh     int memEndValue = 0;
13596f82e85aSdrh     WhereTerm *pStart, *pEnd;
13606f82e85aSdrh 
13616f82e85aSdrh     assert( omitTable==0 );
13626f82e85aSdrh     j = 0;
13636f82e85aSdrh     pStart = pEnd = 0;
13646f82e85aSdrh     if( pLoop->wsFlags & WHERE_BTM_LIMIT ) pStart = pLoop->aLTerm[j++];
13656f82e85aSdrh     if( pLoop->wsFlags & WHERE_TOP_LIMIT ) pEnd = pLoop->aLTerm[j++];
13666f82e85aSdrh     assert( pStart!=0 || pEnd!=0 );
13676f82e85aSdrh     if( bRev ){
13686f82e85aSdrh       pTerm = pStart;
13696f82e85aSdrh       pStart = pEnd;
13706f82e85aSdrh       pEnd = pTerm;
13716f82e85aSdrh     }
1372b324cf75Sdan     codeCursorHint(pTabItem, pWInfo, pLevel, pEnd);
13736f82e85aSdrh     if( pStart ){
13746f82e85aSdrh       Expr *pX;             /* The expression that defines the start bound */
13756f82e85aSdrh       int r1, rTemp;        /* Registers for holding the start boundary */
137619ff12ddSdan       int op;               /* Cursor seek operation */
13776f82e85aSdrh 
13786f82e85aSdrh       /* The following constant maps TK_xx codes into corresponding
13796f82e85aSdrh       ** seek opcodes.  It depends on a particular ordering of TK_xx
13806f82e85aSdrh       */
13816f82e85aSdrh       const u8 aMoveOp[] = {
13826f82e85aSdrh            /* TK_GT */  OP_SeekGT,
13836f82e85aSdrh            /* TK_LE */  OP_SeekLE,
13846f82e85aSdrh            /* TK_LT */  OP_SeekLT,
13856f82e85aSdrh            /* TK_GE */  OP_SeekGE
13866f82e85aSdrh       };
13876f82e85aSdrh       assert( TK_LE==TK_GT+1 );      /* Make sure the ordering.. */
13886f82e85aSdrh       assert( TK_LT==TK_GT+2 );      /*  ... of the TK_xx values... */
13896f82e85aSdrh       assert( TK_GE==TK_GT+3 );      /*  ... is correcct. */
13906f82e85aSdrh 
13916f82e85aSdrh       assert( (pStart->wtFlags & TERM_VNULL)==0 );
13926f82e85aSdrh       testcase( pStart->wtFlags & TERM_VIRTUAL );
13936f82e85aSdrh       pX = pStart->pExpr;
13946f82e85aSdrh       assert( pX!=0 );
13956f82e85aSdrh       testcase( pStart->leftCursor!=iCur ); /* transitive constraints */
1396625015e0Sdan       if( sqlite3ExprIsVector(pX->pRight) ){
139719ff12ddSdan         r1 = rTemp = sqlite3GetTempReg(pParse);
139819ff12ddSdan         codeExprOrVector(pParse, pX->pRight, r1, 1);
13994d1c6845Sdrh         testcase( pX->op==TK_GT );
14004d1c6845Sdrh         testcase( pX->op==TK_GE );
14014d1c6845Sdrh         testcase( pX->op==TK_LT );
14024d1c6845Sdrh         testcase( pX->op==TK_LE );
14034d1c6845Sdrh         op = aMoveOp[((pX->op - TK_GT - 1) & 0x3) | 0x1];
14044d1c6845Sdrh         assert( pX->op!=TK_GT || op==OP_SeekGE );
14054d1c6845Sdrh         assert( pX->op!=TK_GE || op==OP_SeekGE );
14064d1c6845Sdrh         assert( pX->op!=TK_LT || op==OP_SeekLE );
14074d1c6845Sdrh         assert( pX->op!=TK_LE || op==OP_SeekLE );
140819ff12ddSdan       }else{
14096f82e85aSdrh         r1 = sqlite3ExprCodeTemp(pParse, pX->pRight, &rTemp);
141019ff12ddSdan         disableTerm(pLevel, pStart);
141119ff12ddSdan         op = aMoveOp[(pX->op - TK_GT)];
141219ff12ddSdan       }
141319ff12ddSdan       sqlite3VdbeAddOp3(v, op, iCur, addrBrk, r1);
14146f82e85aSdrh       VdbeComment((v, "pk"));
14156f82e85aSdrh       VdbeCoverageIf(v, pX->op==TK_GT);
14166f82e85aSdrh       VdbeCoverageIf(v, pX->op==TK_LE);
14176f82e85aSdrh       VdbeCoverageIf(v, pX->op==TK_LT);
14186f82e85aSdrh       VdbeCoverageIf(v, pX->op==TK_GE);
14196f82e85aSdrh       sqlite3ReleaseTempReg(pParse, rTemp);
14206f82e85aSdrh     }else{
14213a3b420aSdrh       sqlite3VdbeAddOp2(v, bRev ? OP_Last : OP_Rewind, iCur, addrHalt);
14226f82e85aSdrh       VdbeCoverageIf(v, bRev==0);
14236f82e85aSdrh       VdbeCoverageIf(v, bRev!=0);
14246f82e85aSdrh     }
14256f82e85aSdrh     if( pEnd ){
14266f82e85aSdrh       Expr *pX;
14276f82e85aSdrh       pX = pEnd->pExpr;
14286f82e85aSdrh       assert( pX!=0 );
14296f82e85aSdrh       assert( (pEnd->wtFlags & TERM_VNULL)==0 );
14306f82e85aSdrh       testcase( pEnd->leftCursor!=iCur ); /* Transitive constraints */
14316f82e85aSdrh       testcase( pEnd->wtFlags & TERM_VIRTUAL );
14326f82e85aSdrh       memEndValue = ++pParse->nMem;
143319ff12ddSdan       codeExprOrVector(pParse, pX->pRight, memEndValue, 1);
1434625015e0Sdan       if( 0==sqlite3ExprIsVector(pX->pRight)
1435625015e0Sdan        && (pX->op==TK_LT || pX->op==TK_GT)
1436625015e0Sdan       ){
14376f82e85aSdrh         testOp = bRev ? OP_Le : OP_Ge;
14386f82e85aSdrh       }else{
14396f82e85aSdrh         testOp = bRev ? OP_Lt : OP_Gt;
14406f82e85aSdrh       }
1441553168c7Sdan       if( 0==sqlite3ExprIsVector(pX->pRight) ){
14426f82e85aSdrh         disableTerm(pLevel, pEnd);
14436f82e85aSdrh       }
1444553168c7Sdan     }
14456f82e85aSdrh     start = sqlite3VdbeCurrentAddr(v);
14466f82e85aSdrh     pLevel->op = bRev ? OP_Prev : OP_Next;
14476f82e85aSdrh     pLevel->p1 = iCur;
14486f82e85aSdrh     pLevel->p2 = start;
14496f82e85aSdrh     assert( pLevel->p5==0 );
14506f82e85aSdrh     if( testOp!=OP_Noop ){
14516f82e85aSdrh       iRowidReg = ++pParse->nMem;
14526f82e85aSdrh       sqlite3VdbeAddOp2(v, OP_Rowid, iCur, iRowidReg);
14536f82e85aSdrh       sqlite3VdbeAddOp3(v, testOp, memEndValue, addrBrk, iRowidReg);
14546f82e85aSdrh       VdbeCoverageIf(v, testOp==OP_Le);
14556f82e85aSdrh       VdbeCoverageIf(v, testOp==OP_Lt);
14566f82e85aSdrh       VdbeCoverageIf(v, testOp==OP_Ge);
14576f82e85aSdrh       VdbeCoverageIf(v, testOp==OP_Gt);
14586f82e85aSdrh       sqlite3VdbeChangeP5(v, SQLITE_AFF_NUMERIC | SQLITE_JUMPIFNULL);
14596f82e85aSdrh     }
14606f82e85aSdrh   }else if( pLoop->wsFlags & WHERE_INDEXED ){
14616f82e85aSdrh     /* Case 4: A scan using an index.
14626f82e85aSdrh     **
14636f82e85aSdrh     **         The WHERE clause may contain zero or more equality
14646f82e85aSdrh     **         terms ("==" or "IN" operators) that refer to the N
14656f82e85aSdrh     **         left-most columns of the index. It may also contain
14666f82e85aSdrh     **         inequality constraints (>, <, >= or <=) on the indexed
14676f82e85aSdrh     **         column that immediately follows the N equalities. Only
14686f82e85aSdrh     **         the right-most column can be an inequality - the rest must
14696f82e85aSdrh     **         use the "==" and "IN" operators. For example, if the
14706f82e85aSdrh     **         index is on (x,y,z), then the following clauses are all
14716f82e85aSdrh     **         optimized:
14726f82e85aSdrh     **
14736f82e85aSdrh     **            x=5
14746f82e85aSdrh     **            x=5 AND y=10
14756f82e85aSdrh     **            x=5 AND y<10
14766f82e85aSdrh     **            x=5 AND y>5 AND y<10
14776f82e85aSdrh     **            x=5 AND y=5 AND z<=10
14786f82e85aSdrh     **
14796f82e85aSdrh     **         The z<10 term of the following cannot be used, only
14806f82e85aSdrh     **         the x=5 term:
14816f82e85aSdrh     **
14826f82e85aSdrh     **            x=5 AND z<10
14836f82e85aSdrh     **
14846f82e85aSdrh     **         N may be zero if there are inequality constraints.
14856f82e85aSdrh     **         If there are no inequality constraints, then N is at
14866f82e85aSdrh     **         least one.
14876f82e85aSdrh     **
14886f82e85aSdrh     **         This case is also used when there are no WHERE clause
14896f82e85aSdrh     **         constraints but an index is selected anyway, in order
14906f82e85aSdrh     **         to force the output order to conform to an ORDER BY.
14916f82e85aSdrh     */
14926f82e85aSdrh     static const u8 aStartOp[] = {
14936f82e85aSdrh       0,
14946f82e85aSdrh       0,
14956f82e85aSdrh       OP_Rewind,           /* 2: (!start_constraints && startEq &&  !bRev) */
14966f82e85aSdrh       OP_Last,             /* 3: (!start_constraints && startEq &&   bRev) */
14976f82e85aSdrh       OP_SeekGT,           /* 4: (start_constraints  && !startEq && !bRev) */
14986f82e85aSdrh       OP_SeekLT,           /* 5: (start_constraints  && !startEq &&  bRev) */
14996f82e85aSdrh       OP_SeekGE,           /* 6: (start_constraints  &&  startEq && !bRev) */
15006f82e85aSdrh       OP_SeekLE            /* 7: (start_constraints  &&  startEq &&  bRev) */
15016f82e85aSdrh     };
15026f82e85aSdrh     static const u8 aEndOp[] = {
15036f82e85aSdrh       OP_IdxGE,            /* 0: (end_constraints && !bRev && !endEq) */
15046f82e85aSdrh       OP_IdxGT,            /* 1: (end_constraints && !bRev &&  endEq) */
15056f82e85aSdrh       OP_IdxLE,            /* 2: (end_constraints &&  bRev && !endEq) */
15066f82e85aSdrh       OP_IdxLT,            /* 3: (end_constraints &&  bRev &&  endEq) */
15076f82e85aSdrh     };
15086f82e85aSdrh     u16 nEq = pLoop->u.btree.nEq;     /* Number of == or IN terms */
150971c57db0Sdan     u16 nBtm = pLoop->u.btree.nBtm;   /* Length of BTM vector */
151071c57db0Sdan     u16 nTop = pLoop->u.btree.nTop;   /* Length of TOP vector */
15116f82e85aSdrh     int regBase;                 /* Base register holding constraint values */
15126f82e85aSdrh     WhereTerm *pRangeStart = 0;  /* Inequality constraint at range start */
15136f82e85aSdrh     WhereTerm *pRangeEnd = 0;    /* Inequality constraint at range end */
15146f82e85aSdrh     int startEq;                 /* True if range start uses ==, >= or <= */
15156f82e85aSdrh     int endEq;                   /* True if range end uses ==, >= or <= */
15166f82e85aSdrh     int start_constraints;       /* Start of range is constrained */
15176f82e85aSdrh     int nConstraint;             /* Number of constraint terms */
15186f82e85aSdrh     int iIdxCur;                 /* The VDBE cursor for the index */
15196f82e85aSdrh     int nExtraReg = 0;           /* Number of extra registers needed */
15206f82e85aSdrh     int op;                      /* Instruction opcode */
15216f82e85aSdrh     char *zStartAff;             /* Affinity for start of range constraint */
1522b7ca2177Sdan     char *zEndAff = 0;           /* Affinity for end of range constraint */
15236f82e85aSdrh     u8 bSeekPastNull = 0;        /* True to seek past initial nulls */
15246f82e85aSdrh     u8 bStopAtNull = 0;          /* Add condition to terminate at NULLs */
15256f82e85aSdrh 
15266f82e85aSdrh     pIdx = pLoop->u.btree.pIndex;
15276f82e85aSdrh     iIdxCur = pLevel->iIdxCur;
15286f82e85aSdrh     assert( nEq>=pLoop->nSkip );
15296f82e85aSdrh 
15306f82e85aSdrh     /* If this loop satisfies a sort order (pOrderBy) request that
15316f82e85aSdrh     ** was passed to this function to implement a "SELECT min(x) ..."
15326f82e85aSdrh     ** query, then the caller will only allow the loop to run for
15336f82e85aSdrh     ** a single iteration. This means that the first row returned
15346f82e85aSdrh     ** should not have a NULL value stored in 'x'. If column 'x' is
15356f82e85aSdrh     ** the first one after the nEq equality constraints in the index,
15366f82e85aSdrh     ** this requires some special handling.
15376f82e85aSdrh     */
15386f82e85aSdrh     assert( pWInfo->pOrderBy==0
15396f82e85aSdrh          || pWInfo->pOrderBy->nExpr==1
15406f82e85aSdrh          || (pWInfo->wctrlFlags&WHERE_ORDERBY_MIN)==0 );
15416f82e85aSdrh     if( (pWInfo->wctrlFlags&WHERE_ORDERBY_MIN)!=0
15426f82e85aSdrh      && pWInfo->nOBSat>0
15436f82e85aSdrh      && (pIdx->nKeyCol>nEq)
15446f82e85aSdrh     ){
15456f82e85aSdrh       assert( pLoop->nSkip==0 );
15466f82e85aSdrh       bSeekPastNull = 1;
15476f82e85aSdrh       nExtraReg = 1;
15486f82e85aSdrh     }
15496f82e85aSdrh 
15506f82e85aSdrh     /* Find any inequality constraint terms for the start and end
15516f82e85aSdrh     ** of the range.
15526f82e85aSdrh     */
15536f82e85aSdrh     j = nEq;
15546f82e85aSdrh     if( pLoop->wsFlags & WHERE_BTM_LIMIT ){
15556f82e85aSdrh       pRangeStart = pLoop->aLTerm[j++];
155671c57db0Sdan       nExtraReg = MAX(nExtraReg, pLoop->u.btree.nBtm);
15576f82e85aSdrh       /* Like optimization range constraints always occur in pairs */
15586f82e85aSdrh       assert( (pRangeStart->wtFlags & TERM_LIKEOPT)==0 ||
15596f82e85aSdrh               (pLoop->wsFlags & WHERE_TOP_LIMIT)!=0 );
15606f82e85aSdrh     }
15616f82e85aSdrh     if( pLoop->wsFlags & WHERE_TOP_LIMIT ){
15626f82e85aSdrh       pRangeEnd = pLoop->aLTerm[j++];
156371c57db0Sdan       nExtraReg = MAX(nExtraReg, pLoop->u.btree.nTop);
156441d2e66eSdrh #ifndef SQLITE_LIKE_DOESNT_MATCH_BLOBS
15656f82e85aSdrh       if( (pRangeEnd->wtFlags & TERM_LIKEOPT)!=0 ){
15666f82e85aSdrh         assert( pRangeStart!=0 );                     /* LIKE opt constraints */
15676f82e85aSdrh         assert( pRangeStart->wtFlags & TERM_LIKEOPT );   /* occur in pairs */
156844aebff2Sdrh         pLevel->iLikeRepCntr = (u32)++pParse->nMem;
156944aebff2Sdrh         sqlite3VdbeAddOp2(v, OP_Integer, 1, (int)pLevel->iLikeRepCntr);
15706f82e85aSdrh         VdbeComment((v, "LIKE loop counter"));
15716f82e85aSdrh         pLevel->addrLikeRep = sqlite3VdbeCurrentAddr(v);
157244aebff2Sdrh         /* iLikeRepCntr actually stores 2x the counter register number.  The
157344aebff2Sdrh         ** bottom bit indicates whether the search order is ASC or DESC. */
157444aebff2Sdrh         testcase( bRev );
157544aebff2Sdrh         testcase( pIdx->aSortOrder[nEq]==SQLITE_SO_DESC );
157644aebff2Sdrh         assert( (bRev & ~1)==0 );
157744aebff2Sdrh         pLevel->iLikeRepCntr <<=1;
157844aebff2Sdrh         pLevel->iLikeRepCntr |= bRev ^ (pIdx->aSortOrder[nEq]==SQLITE_SO_DESC);
15796f82e85aSdrh       }
158041d2e66eSdrh #endif
158148590fcbSdrh       if( pRangeStart==0 ){
158248590fcbSdrh         j = pIdx->aiColumn[nEq];
158348590fcbSdrh         if( (j>=0 && pIdx->pTable->aCol[j].notNull==0) || j==XN_EXPR ){
15846f82e85aSdrh           bSeekPastNull = 1;
15856f82e85aSdrh         }
15866f82e85aSdrh       }
158748590fcbSdrh     }
15886f82e85aSdrh     assert( pRangeEnd==0 || (pRangeEnd->wtFlags & TERM_VNULL)==0 );
15896f82e85aSdrh 
15906f82e85aSdrh     /* If we are doing a reverse order scan on an ascending index, or
15916f82e85aSdrh     ** a forward order scan on a descending index, interchange the
15926f82e85aSdrh     ** start and end terms (pRangeStart and pRangeEnd).
15936f82e85aSdrh     */
15946f82e85aSdrh     if( (nEq<pIdx->nKeyCol && bRev==(pIdx->aSortOrder[nEq]==SQLITE_SO_ASC))
15956f82e85aSdrh      || (bRev && pIdx->nKeyCol==nEq)
15966f82e85aSdrh     ){
15976f82e85aSdrh       SWAP(WhereTerm *, pRangeEnd, pRangeStart);
15986f82e85aSdrh       SWAP(u8, bSeekPastNull, bStopAtNull);
159971c57db0Sdan       SWAP(u8, nBtm, nTop);
16006f82e85aSdrh     }
16016f82e85aSdrh 
1602bcf40a7fSdrh     /* Generate code to evaluate all constraint terms using == or IN
1603bcf40a7fSdrh     ** and store the values of those terms in an array of registers
1604bcf40a7fSdrh     ** starting at regBase.
1605bcf40a7fSdrh     */
1606b324cf75Sdan     codeCursorHint(pTabItem, pWInfo, pLevel, pRangeEnd);
1607bcf40a7fSdrh     regBase = codeAllEqualityTerms(pParse,pLevel,bRev,nExtraReg,&zStartAff);
1608bcf40a7fSdrh     assert( zStartAff==0 || sqlite3Strlen30(zStartAff)>=nEq );
1609b7ca2177Sdan     if( zStartAff && nTop ){
1610b7ca2177Sdan       zEndAff = sqlite3DbStrDup(db, &zStartAff[nEq]);
1611b7ca2177Sdan     }
1612bcf40a7fSdrh     addrNxt = pLevel->addrNxt;
1613bcf40a7fSdrh 
16146f82e85aSdrh     testcase( pRangeStart && (pRangeStart->eOperator & WO_LE)!=0 );
16156f82e85aSdrh     testcase( pRangeStart && (pRangeStart->eOperator & WO_GE)!=0 );
16166f82e85aSdrh     testcase( pRangeEnd && (pRangeEnd->eOperator & WO_LE)!=0 );
16176f82e85aSdrh     testcase( pRangeEnd && (pRangeEnd->eOperator & WO_GE)!=0 );
16186f82e85aSdrh     startEq = !pRangeStart || pRangeStart->eOperator & (WO_LE|WO_GE);
16196f82e85aSdrh     endEq =   !pRangeEnd || pRangeEnd->eOperator & (WO_LE|WO_GE);
16206f82e85aSdrh     start_constraints = pRangeStart || nEq>0;
16216f82e85aSdrh 
16226f82e85aSdrh     /* Seek the index cursor to the start of the range. */
16236f82e85aSdrh     nConstraint = nEq;
16246f82e85aSdrh     if( pRangeStart ){
16256f82e85aSdrh       Expr *pRight = pRangeStart->pExpr->pRight;
162671c57db0Sdan       codeExprOrVector(pParse, pRight, regBase+nEq, nBtm);
16276f82e85aSdrh       whereLikeOptimizationStringFixup(v, pLevel, pRangeStart);
16286f82e85aSdrh       if( (pRangeStart->wtFlags & TERM_VNULL)==0
16296f82e85aSdrh        && sqlite3ExprCanBeNull(pRight)
16306f82e85aSdrh       ){
16316f82e85aSdrh         sqlite3VdbeAddOp2(v, OP_IsNull, regBase+nEq, addrNxt);
16326f82e85aSdrh         VdbeCoverage(v);
16336f82e85aSdrh       }
16346f82e85aSdrh       if( zStartAff ){
1635e3c6b61cSdrh         updateRangeAffinityStr(pRight, nBtm, &zStartAff[nEq]);
16366f82e85aSdrh       }
163771c57db0Sdan       nConstraint += nBtm;
16386f82e85aSdrh       testcase( pRangeStart->wtFlags & TERM_VIRTUAL );
1639625015e0Sdan       if( sqlite3ExprIsVector(pRight)==0 ){
164071c57db0Sdan         disableTerm(pLevel, pRangeStart);
164171c57db0Sdan       }else{
164271c57db0Sdan         startEq = 1;
164371c57db0Sdan       }
1644426f4ab0Sdrh       bSeekPastNull = 0;
16456f82e85aSdrh     }else if( bSeekPastNull ){
16466f82e85aSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, regBase+nEq);
16476f82e85aSdrh       nConstraint++;
16486f82e85aSdrh       startEq = 0;
16496f82e85aSdrh       start_constraints = 1;
16506f82e85aSdrh     }
16516f82e85aSdrh     codeApplyAffinity(pParse, regBase, nConstraint - bSeekPastNull, zStartAff);
16520bf2ad6aSdrh     if( pLoop->nSkip>0 && nConstraint==pLoop->nSkip ){
16530bf2ad6aSdrh       /* The skip-scan logic inside the call to codeAllEqualityConstraints()
16540bf2ad6aSdrh       ** above has already left the cursor sitting on the correct row,
16550bf2ad6aSdrh       ** so no further seeking is needed */
16560bf2ad6aSdrh     }else{
1657f7b0a5f3Sdrh       if( pLoop->wsFlags & WHERE_IN_EARLYOUT ){
16588c2b6d78Sdrh         sqlite3VdbeAddOp1(v, OP_SeekHit, iIdxCur);
16598c2b6d78Sdrh       }
16606f82e85aSdrh       op = aStartOp[(start_constraints<<2) + (startEq<<1) + bRev];
16616f82e85aSdrh       assert( op!=0 );
16626f82e85aSdrh       sqlite3VdbeAddOp4Int(v, op, iIdxCur, addrNxt, regBase, nConstraint);
16636f82e85aSdrh       VdbeCoverage(v);
16646f82e85aSdrh       VdbeCoverageIf(v, op==OP_Rewind);  testcase( op==OP_Rewind );
16656f82e85aSdrh       VdbeCoverageIf(v, op==OP_Last);    testcase( op==OP_Last );
16666f82e85aSdrh       VdbeCoverageIf(v, op==OP_SeekGT);  testcase( op==OP_SeekGT );
16676f82e85aSdrh       VdbeCoverageIf(v, op==OP_SeekGE);  testcase( op==OP_SeekGE );
16686f82e85aSdrh       VdbeCoverageIf(v, op==OP_SeekLE);  testcase( op==OP_SeekLE );
16696f82e85aSdrh       VdbeCoverageIf(v, op==OP_SeekLT);  testcase( op==OP_SeekLT );
1670a6d2f8ebSdrh     }
16716f82e85aSdrh 
16726f82e85aSdrh     /* Load the value for the inequality constraint at the end of the
16736f82e85aSdrh     ** range (if any).
16746f82e85aSdrh     */
16756f82e85aSdrh     nConstraint = nEq;
16766f82e85aSdrh     if( pRangeEnd ){
16776f82e85aSdrh       Expr *pRight = pRangeEnd->pExpr->pRight;
167871c57db0Sdan       codeExprOrVector(pParse, pRight, regBase+nEq, nTop);
16796f82e85aSdrh       whereLikeOptimizationStringFixup(v, pLevel, pRangeEnd);
16806f82e85aSdrh       if( (pRangeEnd->wtFlags & TERM_VNULL)==0
16816f82e85aSdrh        && sqlite3ExprCanBeNull(pRight)
16826f82e85aSdrh       ){
16836f82e85aSdrh         sqlite3VdbeAddOp2(v, OP_IsNull, regBase+nEq, addrNxt);
16846f82e85aSdrh         VdbeCoverage(v);
16856f82e85aSdrh       }
16860c36fca0Sdrh       if( zEndAff ){
1687e3c6b61cSdrh         updateRangeAffinityStr(pRight, nTop, zEndAff);
1688b7ca2177Sdan         codeApplyAffinity(pParse, regBase+nEq, nTop, zEndAff);
16890c36fca0Sdrh       }else{
16900c36fca0Sdrh         assert( pParse->db->mallocFailed );
16910c36fca0Sdrh       }
169271c57db0Sdan       nConstraint += nTop;
16936f82e85aSdrh       testcase( pRangeEnd->wtFlags & TERM_VIRTUAL );
169471c57db0Sdan 
1695625015e0Sdan       if( sqlite3ExprIsVector(pRight)==0 ){
169671c57db0Sdan         disableTerm(pLevel, pRangeEnd);
169771c57db0Sdan       }else{
169871c57db0Sdan         endEq = 1;
169971c57db0Sdan       }
17006f82e85aSdrh     }else if( bStopAtNull ){
17016f82e85aSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, regBase+nEq);
17026f82e85aSdrh       endEq = 0;
17036f82e85aSdrh       nConstraint++;
17046f82e85aSdrh     }
17056f82e85aSdrh     sqlite3DbFree(db, zStartAff);
1706b7ca2177Sdan     sqlite3DbFree(db, zEndAff);
17076f82e85aSdrh 
17086f82e85aSdrh     /* Top of the loop body */
17096f82e85aSdrh     pLevel->p2 = sqlite3VdbeCurrentAddr(v);
17106f82e85aSdrh 
17116f82e85aSdrh     /* Check if the index cursor is past the end of the range. */
17126f82e85aSdrh     if( nConstraint ){
17136f82e85aSdrh       op = aEndOp[bRev*2 + endEq];
17146f82e85aSdrh       sqlite3VdbeAddOp4Int(v, op, iIdxCur, addrNxt, regBase, nConstraint);
17156f82e85aSdrh       testcase( op==OP_IdxGT );  VdbeCoverageIf(v, op==OP_IdxGT );
17166f82e85aSdrh       testcase( op==OP_IdxGE );  VdbeCoverageIf(v, op==OP_IdxGE );
17176f82e85aSdrh       testcase( op==OP_IdxLT );  VdbeCoverageIf(v, op==OP_IdxLT );
17186f82e85aSdrh       testcase( op==OP_IdxLE );  VdbeCoverageIf(v, op==OP_IdxLE );
17196f82e85aSdrh     }
17206f82e85aSdrh 
1721f7b0a5f3Sdrh     if( pLoop->wsFlags & WHERE_IN_EARLYOUT ){
17228c2b6d78Sdrh       sqlite3VdbeAddOp2(v, OP_SeekHit, iIdxCur, 1);
17238c2b6d78Sdrh     }
17248c2b6d78Sdrh 
17256f82e85aSdrh     /* Seek the table cursor, if required */
17266f82e85aSdrh     if( omitTable ){
17276f82e85aSdrh       /* pIdx is a covering index.  No need to access the main table. */
17286f82e85aSdrh     }else if( HasRowid(pIdx->pTable) ){
1729f64ece14Sdan       if( (pWInfo->wctrlFlags & WHERE_SEEK_TABLE) || (
1730f64ece14Sdan           (pWInfo->wctrlFlags & WHERE_SEEK_UNIQ_TABLE)
1731f64ece14Sdan        && (pWInfo->eOnePass==ONEPASS_SINGLE)
1732f64ece14Sdan       )){
17336f82e85aSdrh         iRowidReg = ++pParse->nMem;
17346f82e85aSdrh         sqlite3VdbeAddOp2(v, OP_IdxRowid, iIdxCur, iRowidReg);
1735c6157e19Sdan         sqlite3VdbeAddOp3(v, OP_NotExists, iCur, 0, iRowidReg);
173666336f37Sdrh         VdbeCoverage(v);
1737c6157e19Sdan       }else{
1738784c1b93Sdrh         codeDeferredSeek(pWInfo, pIdx, iCur, iIdxCur);
1739c6157e19Sdan       }
17406f82e85aSdrh     }else if( iCur!=iIdxCur ){
17416f82e85aSdrh       Index *pPk = sqlite3PrimaryKeyIndex(pIdx->pTable);
17426f82e85aSdrh       iRowidReg = sqlite3GetTempRange(pParse, pPk->nKeyCol);
17436f82e85aSdrh       for(j=0; j<pPk->nKeyCol; j++){
17446f82e85aSdrh         k = sqlite3ColumnOfIndex(pIdx, pPk->aiColumn[j]);
17456f82e85aSdrh         sqlite3VdbeAddOp3(v, OP_Column, iIdxCur, k, iRowidReg+j);
17466f82e85aSdrh       }
17476f82e85aSdrh       sqlite3VdbeAddOp4Int(v, OP_NotFound, iCur, addrCont,
17486f82e85aSdrh                            iRowidReg, pPk->nKeyCol); VdbeCoverage(v);
17496f82e85aSdrh     }
17506f82e85aSdrh 
1751eac5fc04Sdrh     /* If pIdx is an index on one or more expressions, then look through
1752eac5fc04Sdrh     ** all the expressions in pWInfo and try to transform matching expressions
1753eac5fc04Sdrh     ** into reference to index columns.
17544da04f78Sdan     **
17554da04f78Sdan     ** Do not do this for the RHS of a LEFT JOIN. This is because the
17564da04f78Sdan     ** expression may be evaluated after OP_NullRow has been executed on
17574da04f78Sdan     ** the cursor. In this case it is important to do the full evaluation,
17584da04f78Sdan     ** as the result of the expression may not be NULL, even if all table
17595776c139Sdrh     ** column values are.  https://www.sqlite.org/src/info/7fa8049685b50b5a
1760eac5fc04Sdrh     */
17614da04f78Sdan     if( pLevel->iLeftJoin==0 ){
1762aca19e19Sdrh       whereIndexExprTrans(pIdx, iCur, iIdxCur, pWInfo);
17634da04f78Sdan     }
1764aca19e19Sdrh 
176571c57db0Sdan     /* Record the instruction used to terminate the loop. */
17666f82e85aSdrh     if( pLoop->wsFlags & WHERE_ONEROW ){
17676f82e85aSdrh       pLevel->op = OP_Noop;
17686f82e85aSdrh     }else if( bRev ){
17696f82e85aSdrh       pLevel->op = OP_Prev;
17706f82e85aSdrh     }else{
17716f82e85aSdrh       pLevel->op = OP_Next;
17726f82e85aSdrh     }
17736f82e85aSdrh     pLevel->p1 = iIdxCur;
17746f82e85aSdrh     pLevel->p3 = (pLoop->wsFlags&WHERE_UNQ_WANTED)!=0 ? 1:0;
17756f82e85aSdrh     if( (pLoop->wsFlags & WHERE_CONSTRAINT)==0 ){
17766f82e85aSdrh       pLevel->p5 = SQLITE_STMTSTATUS_FULLSCAN_STEP;
17776f82e85aSdrh     }else{
17786f82e85aSdrh       assert( pLevel->p5==0 );
17796f82e85aSdrh     }
17806f654a40Sdan     if( omitTable ) pIdx = 0;
17816f82e85aSdrh   }else
17826f82e85aSdrh 
17836f82e85aSdrh #ifndef SQLITE_OMIT_OR_OPTIMIZATION
17846f82e85aSdrh   if( pLoop->wsFlags & WHERE_MULTI_OR ){
17856f82e85aSdrh     /* Case 5:  Two or more separately indexed terms connected by OR
17866f82e85aSdrh     **
17876f82e85aSdrh     ** Example:
17886f82e85aSdrh     **
17896f82e85aSdrh     **   CREATE TABLE t1(a,b,c,d);
17906f82e85aSdrh     **   CREATE INDEX i1 ON t1(a);
17916f82e85aSdrh     **   CREATE INDEX i2 ON t1(b);
17926f82e85aSdrh     **   CREATE INDEX i3 ON t1(c);
17936f82e85aSdrh     **
17946f82e85aSdrh     **   SELECT * FROM t1 WHERE a=5 OR b=7 OR (c=11 AND d=13)
17956f82e85aSdrh     **
17966f82e85aSdrh     ** In the example, there are three indexed terms connected by OR.
17976f82e85aSdrh     ** The top of the loop looks like this:
17986f82e85aSdrh     **
17996f82e85aSdrh     **          Null       1                # Zero the rowset in reg 1
18006f82e85aSdrh     **
18016f82e85aSdrh     ** Then, for each indexed term, the following. The arguments to
18026f82e85aSdrh     ** RowSetTest are such that the rowid of the current row is inserted
18036f82e85aSdrh     ** into the RowSet. If it is already present, control skips the
18046f82e85aSdrh     ** Gosub opcode and jumps straight to the code generated by WhereEnd().
18056f82e85aSdrh     **
18066f82e85aSdrh     **        sqlite3WhereBegin(<term>)
18076f82e85aSdrh     **          RowSetTest                  # Insert rowid into rowset
18086f82e85aSdrh     **          Gosub      2 A
18096f82e85aSdrh     **        sqlite3WhereEnd()
18106f82e85aSdrh     **
18116f82e85aSdrh     ** Following the above, code to terminate the loop. Label A, the target
18126f82e85aSdrh     ** of the Gosub above, jumps to the instruction right after the Goto.
18136f82e85aSdrh     **
18146f82e85aSdrh     **          Null       1                # Zero the rowset in reg 1
18156f82e85aSdrh     **          Goto       B                # The loop is finished.
18166f82e85aSdrh     **
18176f82e85aSdrh     **       A: <loop body>                 # Return data, whatever.
18186f82e85aSdrh     **
18196f82e85aSdrh     **          Return     2                # Jump back to the Gosub
18206f82e85aSdrh     **
18216f82e85aSdrh     **       B: <after the loop>
18226f82e85aSdrh     **
18236f82e85aSdrh     ** Added 2014-05-26: If the table is a WITHOUT ROWID table, then
18246f82e85aSdrh     ** use an ephemeral index instead of a RowSet to record the primary
18256f82e85aSdrh     ** keys of the rows we have already seen.
18266f82e85aSdrh     **
18276f82e85aSdrh     */
18286f82e85aSdrh     WhereClause *pOrWc;    /* The OR-clause broken out into subterms */
18296f82e85aSdrh     SrcList *pOrTab;       /* Shortened table list or OR-clause generation */
18306f82e85aSdrh     Index *pCov = 0;             /* Potential covering index (or NULL) */
18316f82e85aSdrh     int iCovCur = pParse->nTab++;  /* Cursor used for index scans (if any) */
18326f82e85aSdrh 
18336f82e85aSdrh     int regReturn = ++pParse->nMem;           /* Register used with OP_Gosub */
18346f82e85aSdrh     int regRowset = 0;                        /* Register for RowSet object */
18356f82e85aSdrh     int regRowid = 0;                         /* Register holding rowid */
18366f82e85aSdrh     int iLoopBody = sqlite3VdbeMakeLabel(v);  /* Start of loop body */
18376f82e85aSdrh     int iRetInit;                             /* Address of regReturn init */
18386f82e85aSdrh     int untestedTerms = 0;             /* Some terms not completely tested */
18396f82e85aSdrh     int ii;                            /* Loop counter */
18406f82e85aSdrh     u16 wctrlFlags;                    /* Flags for sub-WHERE clause */
18416f82e85aSdrh     Expr *pAndExpr = 0;                /* An ".. AND (...)" expression */
18426f82e85aSdrh     Table *pTab = pTabItem->pTab;
18436f82e85aSdrh 
18446f82e85aSdrh     pTerm = pLoop->aLTerm[0];
18456f82e85aSdrh     assert( pTerm!=0 );
18466f82e85aSdrh     assert( pTerm->eOperator & WO_OR );
18476f82e85aSdrh     assert( (pTerm->wtFlags & TERM_ORINFO)!=0 );
18486f82e85aSdrh     pOrWc = &pTerm->u.pOrInfo->wc;
18496f82e85aSdrh     pLevel->op = OP_Return;
18506f82e85aSdrh     pLevel->p1 = regReturn;
18516f82e85aSdrh 
18526f82e85aSdrh     /* Set up a new SrcList in pOrTab containing the table being scanned
18536f82e85aSdrh     ** by this loop in the a[0] slot and all notReady tables in a[1..] slots.
18546f82e85aSdrh     ** This becomes the SrcList in the recursive call to sqlite3WhereBegin().
18556f82e85aSdrh     */
18566f82e85aSdrh     if( pWInfo->nLevel>1 ){
18576f82e85aSdrh       int nNotReady;                 /* The number of notReady tables */
18586f82e85aSdrh       struct SrcList_item *origSrc;     /* Original list of tables */
18596f82e85aSdrh       nNotReady = pWInfo->nLevel - iLevel - 1;
18606f82e85aSdrh       pOrTab = sqlite3StackAllocRaw(db,
18616f82e85aSdrh                             sizeof(*pOrTab)+ nNotReady*sizeof(pOrTab->a[0]));
18626f82e85aSdrh       if( pOrTab==0 ) return notReady;
18636f82e85aSdrh       pOrTab->nAlloc = (u8)(nNotReady + 1);
18646f82e85aSdrh       pOrTab->nSrc = pOrTab->nAlloc;
18656f82e85aSdrh       memcpy(pOrTab->a, pTabItem, sizeof(*pTabItem));
18666f82e85aSdrh       origSrc = pWInfo->pTabList->a;
18676f82e85aSdrh       for(k=1; k<=nNotReady; k++){
18686f82e85aSdrh         memcpy(&pOrTab->a[k], &origSrc[pLevel[k].iFrom], sizeof(pOrTab->a[k]));
18696f82e85aSdrh       }
18706f82e85aSdrh     }else{
18716f82e85aSdrh       pOrTab = pWInfo->pTabList;
18726f82e85aSdrh     }
18736f82e85aSdrh 
18746f82e85aSdrh     /* Initialize the rowset register to contain NULL. An SQL NULL is
18756f82e85aSdrh     ** equivalent to an empty rowset.  Or, create an ephemeral index
18766f82e85aSdrh     ** capable of holding primary keys in the case of a WITHOUT ROWID.
18776f82e85aSdrh     **
18786f82e85aSdrh     ** Also initialize regReturn to contain the address of the instruction
18796f82e85aSdrh     ** immediately following the OP_Return at the bottom of the loop. This
18806f82e85aSdrh     ** is required in a few obscure LEFT JOIN cases where control jumps
18816f82e85aSdrh     ** over the top of the loop into the body of it. In this case the
18826f82e85aSdrh     ** correct response for the end-of-loop code (the OP_Return) is to
18836f82e85aSdrh     ** fall through to the next instruction, just as an OP_Next does if
18846f82e85aSdrh     ** called on an uninitialized cursor.
18856f82e85aSdrh     */
18866f82e85aSdrh     if( (pWInfo->wctrlFlags & WHERE_DUPLICATES_OK)==0 ){
18876f82e85aSdrh       if( HasRowid(pTab) ){
18886f82e85aSdrh         regRowset = ++pParse->nMem;
18896f82e85aSdrh         sqlite3VdbeAddOp2(v, OP_Null, 0, regRowset);
18906f82e85aSdrh       }else{
18916f82e85aSdrh         Index *pPk = sqlite3PrimaryKeyIndex(pTab);
18926f82e85aSdrh         regRowset = pParse->nTab++;
18936f82e85aSdrh         sqlite3VdbeAddOp2(v, OP_OpenEphemeral, regRowset, pPk->nKeyCol);
18946f82e85aSdrh         sqlite3VdbeSetP4KeyInfo(pParse, pPk);
18956f82e85aSdrh       }
18966f82e85aSdrh       regRowid = ++pParse->nMem;
18976f82e85aSdrh     }
18986f82e85aSdrh     iRetInit = sqlite3VdbeAddOp2(v, OP_Integer, 0, regReturn);
18996f82e85aSdrh 
19006f82e85aSdrh     /* If the original WHERE clause is z of the form:  (x1 OR x2 OR ...) AND y
19016f82e85aSdrh     ** Then for every term xN, evaluate as the subexpression: xN AND z
19026f82e85aSdrh     ** That way, terms in y that are factored into the disjunction will
19036f82e85aSdrh     ** be picked up by the recursive calls to sqlite3WhereBegin() below.
19046f82e85aSdrh     **
19056f82e85aSdrh     ** Actually, each subexpression is converted to "xN AND w" where w is
19066f82e85aSdrh     ** the "interesting" terms of z - terms that did not originate in the
19076f82e85aSdrh     ** ON or USING clause of a LEFT JOIN, and terms that are usable as
19086f82e85aSdrh     ** indices.
19096f82e85aSdrh     **
19106f82e85aSdrh     ** This optimization also only applies if the (x1 OR x2 OR ...) term
19116f82e85aSdrh     ** is not contained in the ON clause of a LEFT JOIN.
19126f82e85aSdrh     ** See ticket http://www.sqlite.org/src/info/f2369304e4
19136f82e85aSdrh     */
19146f82e85aSdrh     if( pWC->nTerm>1 ){
19156f82e85aSdrh       int iTerm;
19166f82e85aSdrh       for(iTerm=0; iTerm<pWC->nTerm; iTerm++){
19176f82e85aSdrh         Expr *pExpr = pWC->a[iTerm].pExpr;
19186f82e85aSdrh         if( &pWC->a[iTerm] == pTerm ) continue;
19193b83f0cdSdrh         testcase( pWC->a[iTerm].wtFlags & TERM_VIRTUAL );
19203b83f0cdSdrh         testcase( pWC->a[iTerm].wtFlags & TERM_CODED );
19213b83f0cdSdrh         if( (pWC->a[iTerm].wtFlags & (TERM_VIRTUAL|TERM_CODED))!=0 ) continue;
19226f82e85aSdrh         if( (pWC->a[iTerm].eOperator & WO_ALL)==0 ) continue;
19236f82e85aSdrh         testcase( pWC->a[iTerm].wtFlags & TERM_ORINFO );
19246f82e85aSdrh         pExpr = sqlite3ExprDup(db, pExpr, 0);
19256f82e85aSdrh         pAndExpr = sqlite3ExprAnd(db, pAndExpr, pExpr);
19266f82e85aSdrh       }
19276f82e85aSdrh       if( pAndExpr ){
1928abfd35eaSdrh         pAndExpr = sqlite3PExpr(pParse, TK_AND|TKFLG_DONTFOLD, 0, pAndExpr);
19296f82e85aSdrh       }
19306f82e85aSdrh     }
19316f82e85aSdrh 
19326f82e85aSdrh     /* Run a separate WHERE clause for each term of the OR clause.  After
19336f82e85aSdrh     ** eliminating duplicates from other WHERE clauses, the action for each
19346f82e85aSdrh     ** sub-WHERE clause is to to invoke the main loop body as a subroutine.
19356f82e85aSdrh     */
1936ce943bc8Sdrh     wctrlFlags =  WHERE_OR_SUBCLAUSE | (pWInfo->wctrlFlags & WHERE_SEEK_TABLE);
19375d72d924Sdrh     ExplainQueryPlan((pParse, 1, "MULTI-INDEX OR"));
19386f82e85aSdrh     for(ii=0; ii<pOrWc->nTerm; ii++){
19396f82e85aSdrh       WhereTerm *pOrTerm = &pOrWc->a[ii];
19406f82e85aSdrh       if( pOrTerm->leftCursor==iCur || (pOrTerm->eOperator & WO_AND)!=0 ){
19416f82e85aSdrh         WhereInfo *pSubWInfo;           /* Info for single OR-term scan */
19426f82e85aSdrh         Expr *pOrExpr = pOrTerm->pExpr; /* Current OR clause term */
1943728e0f91Sdrh         int jmp1 = 0;                   /* Address of jump operation */
1944820fcd2cSdan         assert( (pTabItem[0].fg.jointype & JT_LEFT)==0
1945820fcd2cSdan              || ExprHasProperty(pOrExpr, EP_FromJoin)
1946820fcd2cSdan         );
1947820fcd2cSdan         if( pAndExpr ){
19486f82e85aSdrh           pAndExpr->pLeft = pOrExpr;
19496f82e85aSdrh           pOrExpr = pAndExpr;
19506f82e85aSdrh         }
19516f82e85aSdrh         /* Loop through table entries that match term pOrTerm. */
19526f82e85aSdrh         WHERETRACE(0xffff, ("Subplan for OR-clause:\n"));
19536f82e85aSdrh         pSubWInfo = sqlite3WhereBegin(pParse, pOrTab, pOrExpr, 0, 0,
19546f82e85aSdrh                                       wctrlFlags, iCovCur);
19556f82e85aSdrh         assert( pSubWInfo || pParse->nErr || db->mallocFailed );
19566f82e85aSdrh         if( pSubWInfo ){
19576f82e85aSdrh           WhereLoop *pSubLoop;
19586f82e85aSdrh           int addrExplain = sqlite3WhereExplainOneScan(
1959e2188f0bSdrh               pParse, pOrTab, &pSubWInfo->a[0], 0
19606f82e85aSdrh           );
19616f82e85aSdrh           sqlite3WhereAddScanStatus(v, pOrTab, &pSubWInfo->a[0], addrExplain);
19626f82e85aSdrh 
19636f82e85aSdrh           /* This is the sub-WHERE clause body.  First skip over
19646f82e85aSdrh           ** duplicate rows from prior sub-WHERE clauses, and record the
19656f82e85aSdrh           ** rowid (or PRIMARY KEY) for the current row so that the same
19666f82e85aSdrh           ** row will be skipped in subsequent sub-WHERE clauses.
19676f82e85aSdrh           */
19686f82e85aSdrh           if( (pWInfo->wctrlFlags & WHERE_DUPLICATES_OK)==0 ){
19696f82e85aSdrh             int iSet = ((ii==pOrWc->nTerm-1)?-1:ii);
19706f82e85aSdrh             if( HasRowid(pTab) ){
19718c607191Sdrh               sqlite3ExprCodeGetColumnOfTable(v, pTab, iCur, -1, regRowid);
1972728e0f91Sdrh               jmp1 = sqlite3VdbeAddOp4Int(v, OP_RowSetTest, regRowset, 0,
19738c607191Sdrh                                           regRowid, iSet);
19746f82e85aSdrh               VdbeCoverage(v);
19756f82e85aSdrh             }else{
19766f82e85aSdrh               Index *pPk = sqlite3PrimaryKeyIndex(pTab);
19776f82e85aSdrh               int nPk = pPk->nKeyCol;
19786f82e85aSdrh               int iPk;
19798c607191Sdrh               int r;
19806f82e85aSdrh 
19816f82e85aSdrh               /* Read the PK into an array of temp registers. */
19826f82e85aSdrh               r = sqlite3GetTempRange(pParse, nPk);
19836f82e85aSdrh               for(iPk=0; iPk<nPk; iPk++){
19846f82e85aSdrh                 int iCol = pPk->aiColumn[iPk];
19858c607191Sdrh                 sqlite3ExprCodeGetColumnOfTable(v, pTab, iCur, iCol, r+iPk);
19866f82e85aSdrh               }
19876f82e85aSdrh 
19886f82e85aSdrh               /* Check if the temp table already contains this key. If so,
19896f82e85aSdrh               ** the row has already been included in the result set and
19906f82e85aSdrh               ** can be ignored (by jumping past the Gosub below). Otherwise,
19916f82e85aSdrh               ** insert the key into the temp table and proceed with processing
19926f82e85aSdrh               ** the row.
19936f82e85aSdrh               **
19946f82e85aSdrh               ** Use some of the same optimizations as OP_RowSetTest: If iSet
19956f82e85aSdrh               ** is zero, assume that the key cannot already be present in
19966f82e85aSdrh               ** the temp table. And if iSet is -1, assume that there is no
19976f82e85aSdrh               ** need to insert the key into the temp table, as it will never
19986f82e85aSdrh               ** be tested for.  */
19996f82e85aSdrh               if( iSet ){
2000728e0f91Sdrh                 jmp1 = sqlite3VdbeAddOp4Int(v, OP_Found, regRowset, 0, r, nPk);
20016f82e85aSdrh                 VdbeCoverage(v);
20026f82e85aSdrh               }
20036f82e85aSdrh               if( iSet>=0 ){
20046f82e85aSdrh                 sqlite3VdbeAddOp3(v, OP_MakeRecord, r, nPk, regRowid);
20059b4eaebcSdrh                 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, regRowset, regRowid,
20069b4eaebcSdrh                                      r, nPk);
20076f82e85aSdrh                 if( iSet ) sqlite3VdbeChangeP5(v, OPFLAG_USESEEKRESULT);
20086f82e85aSdrh               }
20096f82e85aSdrh 
20106f82e85aSdrh               /* Release the array of temp registers */
20116f82e85aSdrh               sqlite3ReleaseTempRange(pParse, r, nPk);
20126f82e85aSdrh             }
20136f82e85aSdrh           }
20146f82e85aSdrh 
20156f82e85aSdrh           /* Invoke the main loop body as a subroutine */
20166f82e85aSdrh           sqlite3VdbeAddOp2(v, OP_Gosub, regReturn, iLoopBody);
20176f82e85aSdrh 
20186f82e85aSdrh           /* Jump here (skipping the main loop body subroutine) if the
20196f82e85aSdrh           ** current sub-WHERE row is a duplicate from prior sub-WHEREs. */
2020728e0f91Sdrh           if( jmp1 ) sqlite3VdbeJumpHere(v, jmp1);
20216f82e85aSdrh 
20226f82e85aSdrh           /* The pSubWInfo->untestedTerms flag means that this OR term
20236f82e85aSdrh           ** contained one or more AND term from a notReady table.  The
20246f82e85aSdrh           ** terms from the notReady table could not be tested and will
20256f82e85aSdrh           ** need to be tested later.
20266f82e85aSdrh           */
20276f82e85aSdrh           if( pSubWInfo->untestedTerms ) untestedTerms = 1;
20286f82e85aSdrh 
20296f82e85aSdrh           /* If all of the OR-connected terms are optimized using the same
20306f82e85aSdrh           ** index, and the index is opened using the same cursor number
20316f82e85aSdrh           ** by each call to sqlite3WhereBegin() made by this loop, it may
20326f82e85aSdrh           ** be possible to use that index as a covering index.
20336f82e85aSdrh           **
20346f82e85aSdrh           ** If the call to sqlite3WhereBegin() above resulted in a scan that
20356f82e85aSdrh           ** uses an index, and this is either the first OR-connected term
20366f82e85aSdrh           ** processed or the index is the same as that used by all previous
20376f82e85aSdrh           ** terms, set pCov to the candidate covering index. Otherwise, set
20386f82e85aSdrh           ** pCov to NULL to indicate that no candidate covering index will
20396f82e85aSdrh           ** be available.
20406f82e85aSdrh           */
20416f82e85aSdrh           pSubLoop = pSubWInfo->a[0].pWLoop;
20426f82e85aSdrh           assert( (pSubLoop->wsFlags & WHERE_AUTO_INDEX)==0 );
20436f82e85aSdrh           if( (pSubLoop->wsFlags & WHERE_INDEXED)!=0
20446f82e85aSdrh            && (ii==0 || pSubLoop->u.btree.pIndex==pCov)
20456f82e85aSdrh            && (HasRowid(pTab) || !IsPrimaryKeyIndex(pSubLoop->u.btree.pIndex))
20466f82e85aSdrh           ){
20476f82e85aSdrh             assert( pSubWInfo->a[0].iIdxCur==iCovCur );
20486f82e85aSdrh             pCov = pSubLoop->u.btree.pIndex;
20496f82e85aSdrh           }else{
20506f82e85aSdrh             pCov = 0;
20516f82e85aSdrh           }
20526f82e85aSdrh 
20536f82e85aSdrh           /* Finish the loop through table entries that match term pOrTerm. */
20546f82e85aSdrh           sqlite3WhereEnd(pSubWInfo);
20556f82e85aSdrh         }
20566f82e85aSdrh       }
20576f82e85aSdrh     }
20585d72d924Sdrh     ExplainQueryPlanPop(pParse);
20596f82e85aSdrh     pLevel->u.pCovidx = pCov;
20606f82e85aSdrh     if( pCov ) pLevel->iIdxCur = iCovCur;
20616f82e85aSdrh     if( pAndExpr ){
20626f82e85aSdrh       pAndExpr->pLeft = 0;
20636f82e85aSdrh       sqlite3ExprDelete(db, pAndExpr);
20646f82e85aSdrh     }
20656f82e85aSdrh     sqlite3VdbeChangeP1(v, iRetInit, sqlite3VdbeCurrentAddr(v));
2066076e85f5Sdrh     sqlite3VdbeGoto(v, pLevel->addrBrk);
20676f82e85aSdrh     sqlite3VdbeResolveLabel(v, iLoopBody);
20686f82e85aSdrh 
20696f82e85aSdrh     if( pWInfo->nLevel>1 ) sqlite3StackFree(db, pOrTab);
20706f82e85aSdrh     if( !untestedTerms ) disableTerm(pLevel, pTerm);
20716f82e85aSdrh   }else
20726f82e85aSdrh #endif /* SQLITE_OMIT_OR_OPTIMIZATION */
20736f82e85aSdrh 
20746f82e85aSdrh   {
20756f82e85aSdrh     /* Case 6:  There is no usable index.  We must do a complete
20766f82e85aSdrh     **          scan of the entire table.
20776f82e85aSdrh     */
20786f82e85aSdrh     static const u8 aStep[] = { OP_Next, OP_Prev };
20796f82e85aSdrh     static const u8 aStart[] = { OP_Rewind, OP_Last };
20806f82e85aSdrh     assert( bRev==0 || bRev==1 );
20818a48b9c0Sdrh     if( pTabItem->fg.isRecursive ){
20826f82e85aSdrh       /* Tables marked isRecursive have only a single row that is stored in
20836f82e85aSdrh       ** a pseudo-cursor.  No need to Rewind or Next such cursors. */
20846f82e85aSdrh       pLevel->op = OP_Noop;
20856f82e85aSdrh     }else{
2086b324cf75Sdan       codeCursorHint(pTabItem, pWInfo, pLevel, 0);
20876f82e85aSdrh       pLevel->op = aStep[bRev];
20886f82e85aSdrh       pLevel->p1 = iCur;
20893a3b420aSdrh       pLevel->p2 = 1 + sqlite3VdbeAddOp2(v, aStart[bRev], iCur, addrHalt);
20906f82e85aSdrh       VdbeCoverageIf(v, bRev==0);
20916f82e85aSdrh       VdbeCoverageIf(v, bRev!=0);
20926f82e85aSdrh       pLevel->p5 = SQLITE_STMTSTATUS_FULLSCAN_STEP;
20936f82e85aSdrh     }
20946f82e85aSdrh   }
20956f82e85aSdrh 
20966f82e85aSdrh #ifdef SQLITE_ENABLE_STMT_SCANSTATUS
20976f82e85aSdrh   pLevel->addrVisit = sqlite3VdbeCurrentAddr(v);
20986f82e85aSdrh #endif
20996f82e85aSdrh 
21006f82e85aSdrh   /* Insert code to test every subexpression that can be completely
21016f82e85aSdrh   ** computed using the current set of tables.
21026f654a40Sdan   **
2103ebc63013Sdan   ** This loop may run between one and three times, depending on the
2104ebc63013Sdan   ** constraints to be generated. The value of stack variable iLoop
2105ebc63013Sdan   ** determines the constraints coded by each iteration, as follows:
2106ebc63013Sdan   **
2107ebc63013Sdan   ** iLoop==1: Code only expressions that are entirely covered by pIdx.
2108ebc63013Sdan   ** iLoop==2: Code remaining expressions that do not contain correlated
2109ebc63013Sdan   **           sub-queries.
2110ebc63013Sdan   ** iLoop==3: Code all remaining expressions.
2111ebc63013Sdan   **
2112ebc63013Sdan   ** An effort is made to skip unnecessary iterations of the loop.
21136ab3eb5dSdrh   */
2114ebc63013Sdan   iLoop = (pIdx ? 1 : 2);
21156ab3eb5dSdrh   do{
2116ebc63013Sdan     int iNext = 0;                /* Next value for iLoop */
21176f82e85aSdrh     for(pTerm=pWC->a, j=pWC->nTerm; j>0; j--, pTerm++){
21186f82e85aSdrh       Expr *pE;
21196f82e85aSdrh       int skipLikeAddr = 0;
21206f82e85aSdrh       testcase( pTerm->wtFlags & TERM_VIRTUAL );
21216f82e85aSdrh       testcase( pTerm->wtFlags & TERM_CODED );
21226f82e85aSdrh       if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
21236f82e85aSdrh       if( (pTerm->prereqAll & pLevel->notReady)!=0 ){
21246f82e85aSdrh         testcase( pWInfo->untestedTerms==0
2125ce943bc8Sdrh             && (pWInfo->wctrlFlags & WHERE_OR_SUBCLAUSE)!=0 );
21266f82e85aSdrh         pWInfo->untestedTerms = 1;
21276f82e85aSdrh         continue;
21286f82e85aSdrh       }
21296f82e85aSdrh       pE = pTerm->pExpr;
21306f82e85aSdrh       assert( pE!=0 );
2131820fcd2cSdan       if( (pTabItem->fg.jointype&JT_LEFT) && !ExprHasProperty(pE,EP_FromJoin) ){
21326f654a40Sdan         continue;
21336f654a40Sdan       }
2134ebc63013Sdan 
21358674ec5aSdan       if( iLoop==1 && !sqlite3ExprCoveredByIndex(pE, pLevel->iTabCur, pIdx) ){
2136ebc63013Sdan         iNext = 2;
21376f82e85aSdrh         continue;
21386f82e85aSdrh       }
2139d3930b12Sdan       if( iLoop<3 && (pTerm->wtFlags & TERM_VARSELECT) ){
2140ebc63013Sdan         if( iNext==0 ) iNext = 3;
2141ebc63013Sdan         continue;
2142ebc63013Sdan       }
2143ebc63013Sdan 
21444de3353dSdrh       if( (pTerm->wtFlags & TERM_LIKECOND)!=0 ){
214544aebff2Sdrh         /* If the TERM_LIKECOND flag is set, that means that the range search
214644aebff2Sdrh         ** is sufficient to guarantee that the LIKE operator is true, so we
214744aebff2Sdrh         ** can skip the call to the like(A,B) function.  But this only works
214844aebff2Sdrh         ** for strings.  So do not skip the call to the function on the pass
214944aebff2Sdrh         ** that compares BLOBs. */
215041d2e66eSdrh #ifdef SQLITE_LIKE_DOESNT_MATCH_BLOBS
215141d2e66eSdrh         continue;
215241d2e66eSdrh #else
215344aebff2Sdrh         u32 x = pLevel->iLikeRepCntr;
21544de3353dSdrh         if( x>0 ){
215544aebff2Sdrh           skipLikeAddr = sqlite3VdbeAddOp1(v, (x&1)?OP_IfNot:OP_If,(int)(x>>1));
21564de3353dSdrh         }
21576f82e85aSdrh         VdbeCoverage(v);
215841d2e66eSdrh #endif
21596f82e85aSdrh       }
216066a0bf31Sdrh #ifdef WHERETRACE_ENABLED /* 0xffff */
216166a0bf31Sdrh       if( sqlite3WhereTrace ){
216266a0bf31Sdrh         VdbeNoopComment((v, "WhereTerm[%d] (%p) priority=%d",
216366a0bf31Sdrh                          pWC->nTerm-j, pTerm, iLoop));
216466a0bf31Sdrh       }
216566a0bf31Sdrh #endif
21666f82e85aSdrh       sqlite3ExprIfFalse(pParse, pE, addrCont, SQLITE_JUMPIFNULL);
21676f82e85aSdrh       if( skipLikeAddr ) sqlite3VdbeJumpHere(v, skipLikeAddr);
21686f82e85aSdrh       pTerm->wtFlags |= TERM_CODED;
21696f82e85aSdrh     }
2170ebc63013Sdan     iLoop = iNext;
2171ebc63013Sdan   }while( iLoop>0 );
21726f82e85aSdrh 
21736f82e85aSdrh   /* Insert code to test for implied constraints based on transitivity
21746f82e85aSdrh   ** of the "==" operator.
21756f82e85aSdrh   **
21766f82e85aSdrh   ** Example: If the WHERE clause contains "t1.a=t2.b" and "t2.b=123"
21776f82e85aSdrh   ** and we are coding the t1 loop and the t2 loop has not yet coded,
21786f82e85aSdrh   ** then we cannot use the "t1.a=t2.b" constraint, but we can code
21796f82e85aSdrh   ** the implied "t1.a=123" constraint.
21806f82e85aSdrh   */
21816f82e85aSdrh   for(pTerm=pWC->a, j=pWC->nTerm; j>0; j--, pTerm++){
2182cb43a937Sdrh     Expr *pE, sEAlt;
21836f82e85aSdrh     WhereTerm *pAlt;
21846f82e85aSdrh     if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
21856f82e85aSdrh     if( (pTerm->eOperator & (WO_EQ|WO_IS))==0 ) continue;
21866f82e85aSdrh     if( (pTerm->eOperator & WO_EQUIV)==0 ) continue;
21876f82e85aSdrh     if( pTerm->leftCursor!=iCur ) continue;
21886f82e85aSdrh     if( pLevel->iLeftJoin ) continue;
21896f82e85aSdrh     pE = pTerm->pExpr;
21906f82e85aSdrh     assert( !ExprHasProperty(pE, EP_FromJoin) );
21916f82e85aSdrh     assert( (pTerm->prereqRight & pLevel->notReady)!=0 );
21926f82e85aSdrh     pAlt = sqlite3WhereFindTerm(pWC, iCur, pTerm->u.leftColumn, notReady,
21936f82e85aSdrh                     WO_EQ|WO_IN|WO_IS, 0);
21946f82e85aSdrh     if( pAlt==0 ) continue;
21956f82e85aSdrh     if( pAlt->wtFlags & (TERM_CODED) ) continue;
2196a916b570Sdan     if( (pAlt->eOperator & WO_IN)
2197a916b570Sdan      && (pAlt->pExpr->flags & EP_xIsSelect)
2198a916b570Sdan      && (pAlt->pExpr->x.pSelect->pEList->nExpr>1)
2199a916b570Sdan     ){
2200a916b570Sdan       continue;
2201a916b570Sdan     }
22026f82e85aSdrh     testcase( pAlt->eOperator & WO_EQ );
22036f82e85aSdrh     testcase( pAlt->eOperator & WO_IS );
22046f82e85aSdrh     testcase( pAlt->eOperator & WO_IN );
22056f82e85aSdrh     VdbeModuleComment((v, "begin transitive constraint"));
2206cb43a937Sdrh     sEAlt = *pAlt->pExpr;
2207cb43a937Sdrh     sEAlt.pLeft = pE->pLeft;
2208cb43a937Sdrh     sqlite3ExprIfFalse(pParse, &sEAlt, addrCont, SQLITE_JUMPIFNULL);
22096f82e85aSdrh   }
22106f82e85aSdrh 
22116f82e85aSdrh   /* For a LEFT OUTER JOIN, generate code that will record the fact that
22126f82e85aSdrh   ** at least one row of the right table has matched the left table.
22136f82e85aSdrh   */
22146f82e85aSdrh   if( pLevel->iLeftJoin ){
22156f82e85aSdrh     pLevel->addrFirst = sqlite3VdbeCurrentAddr(v);
22166f82e85aSdrh     sqlite3VdbeAddOp2(v, OP_Integer, 1, pLevel->iLeftJoin);
22176f82e85aSdrh     VdbeComment((v, "record LEFT JOIN hit"));
22186f82e85aSdrh     for(pTerm=pWC->a, j=0; j<pWC->nTerm; j++, pTerm++){
22196f82e85aSdrh       testcase( pTerm->wtFlags & TERM_VIRTUAL );
22206f82e85aSdrh       testcase( pTerm->wtFlags & TERM_CODED );
22216f82e85aSdrh       if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
22226f82e85aSdrh       if( (pTerm->prereqAll & pLevel->notReady)!=0 ){
22236f82e85aSdrh         assert( pWInfo->untestedTerms );
22246f82e85aSdrh         continue;
22256f82e85aSdrh       }
22266f82e85aSdrh       assert( pTerm->pExpr );
22276f82e85aSdrh       sqlite3ExprIfFalse(pParse, pTerm->pExpr, addrCont, SQLITE_JUMPIFNULL);
22286f82e85aSdrh       pTerm->wtFlags |= TERM_CODED;
22296f82e85aSdrh     }
22306f82e85aSdrh   }
22316f82e85aSdrh 
22326f82e85aSdrh   return pLevel->notReady;
22336f82e85aSdrh }
2234