xref: /sqlite-3.40.0/src/wherecode.c (revision bec2476a)
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
246f82e85aSdrh /*
256f82e85aSdrh ** This routine is a helper for explainIndexRange() below
266f82e85aSdrh **
276f82e85aSdrh ** pStr holds the text of an expression that we are building up one term
286f82e85aSdrh ** at a time.  This routine adds a new term to the end of the expression.
296f82e85aSdrh ** Terms are separated by AND so add the "AND" text for second and subsequent
306f82e85aSdrh ** terms only.
316f82e85aSdrh */
326f82e85aSdrh static void explainAppendTerm(
336f82e85aSdrh   StrAccum *pStr,             /* The text expression being built */
346f82e85aSdrh   int iTerm,                  /* Index of this term.  First is zero */
356f82e85aSdrh   const char *zColumn,        /* Name of the column */
366f82e85aSdrh   const char *zOp             /* Name of the operator */
376f82e85aSdrh ){
386f82e85aSdrh   if( iTerm ) sqlite3StrAccumAppend(pStr, " AND ", 5);
396f82e85aSdrh   sqlite3StrAccumAppendAll(pStr, zColumn);
406f82e85aSdrh   sqlite3StrAccumAppend(pStr, zOp, 1);
416f82e85aSdrh   sqlite3StrAccumAppend(pStr, "?", 1);
426f82e85aSdrh }
436f82e85aSdrh 
446f82e85aSdrh /*
456f82e85aSdrh ** Argument pLevel describes a strategy for scanning table pTab. This
466f82e85aSdrh ** function appends text to pStr that describes the subset of table
476f82e85aSdrh ** rows scanned by the strategy in the form of an SQL expression.
486f82e85aSdrh **
496f82e85aSdrh ** For example, if the query:
506f82e85aSdrh **
516f82e85aSdrh **   SELECT * FROM t1 WHERE a=1 AND b>2;
526f82e85aSdrh **
536f82e85aSdrh ** is run and there is an index on (a, b), then this function returns a
546f82e85aSdrh ** string similar to:
556f82e85aSdrh **
566f82e85aSdrh **   "a=? AND b>?"
576f82e85aSdrh */
586f82e85aSdrh static void explainIndexRange(StrAccum *pStr, WhereLoop *pLoop, Table *pTab){
596f82e85aSdrh   Index *pIndex = pLoop->u.btree.pIndex;
606f82e85aSdrh   u16 nEq = pLoop->u.btree.nEq;
616f82e85aSdrh   u16 nSkip = pLoop->nSkip;
626f82e85aSdrh   int i, j;
636f82e85aSdrh   Column *aCol = pTab->aCol;
646f82e85aSdrh   i16 *aiColumn = pIndex->aiColumn;
656f82e85aSdrh 
666f82e85aSdrh   if( nEq==0 && (pLoop->wsFlags&(WHERE_BTM_LIMIT|WHERE_TOP_LIMIT))==0 ) return;
676f82e85aSdrh   sqlite3StrAccumAppend(pStr, " (", 2);
686f82e85aSdrh   for(i=0; i<nEq; i++){
696f82e85aSdrh     char *z = aiColumn[i] < 0 ? "rowid" : aCol[aiColumn[i]].zName;
706f82e85aSdrh     if( i>=nSkip ){
716f82e85aSdrh       explainAppendTerm(pStr, i, z, "=");
726f82e85aSdrh     }else{
736f82e85aSdrh       if( i ) sqlite3StrAccumAppend(pStr, " AND ", 5);
746f82e85aSdrh       sqlite3XPrintf(pStr, 0, "ANY(%s)", z);
756f82e85aSdrh     }
766f82e85aSdrh   }
776f82e85aSdrh 
786f82e85aSdrh   j = i;
796f82e85aSdrh   if( pLoop->wsFlags&WHERE_BTM_LIMIT ){
806f82e85aSdrh     char *z = aiColumn[j] < 0 ? "rowid" : aCol[aiColumn[j]].zName;
816f82e85aSdrh     explainAppendTerm(pStr, i++, z, ">");
826f82e85aSdrh   }
836f82e85aSdrh   if( pLoop->wsFlags&WHERE_TOP_LIMIT ){
846f82e85aSdrh     char *z = aiColumn[j] < 0 ? "rowid" : aCol[aiColumn[j]].zName;
856f82e85aSdrh     explainAppendTerm(pStr, i, z, "<");
866f82e85aSdrh   }
876f82e85aSdrh   sqlite3StrAccumAppend(pStr, ")", 1);
886f82e85aSdrh }
896f82e85aSdrh 
906f82e85aSdrh /*
916f82e85aSdrh ** This function is a no-op unless currently processing an EXPLAIN QUERY PLAN
926f82e85aSdrh ** command, or if either SQLITE_DEBUG or SQLITE_ENABLE_STMT_SCANSTATUS was
936f82e85aSdrh ** defined at compile-time. If it is not a no-op, a single OP_Explain opcode
946f82e85aSdrh ** is added to the output to describe the table scan strategy in pLevel.
956f82e85aSdrh **
966f82e85aSdrh ** If an OP_Explain opcode is added to the VM, its address is returned.
976f82e85aSdrh ** Otherwise, if no OP_Explain is coded, zero is returned.
986f82e85aSdrh */
996f82e85aSdrh int sqlite3WhereExplainOneScan(
1006f82e85aSdrh   Parse *pParse,                  /* Parse context */
1016f82e85aSdrh   SrcList *pTabList,              /* Table list this loop refers to */
1026f82e85aSdrh   WhereLevel *pLevel,             /* Scan to write OP_Explain opcode for */
1036f82e85aSdrh   int iLevel,                     /* Value for "level" column of output */
1046f82e85aSdrh   int iFrom,                      /* Value for "from" column of output */
1056f82e85aSdrh   u16 wctrlFlags                  /* Flags passed to sqlite3WhereBegin() */
1066f82e85aSdrh ){
1076f82e85aSdrh   int ret = 0;
1086f82e85aSdrh #if !defined(SQLITE_DEBUG) && !defined(SQLITE_ENABLE_STMT_SCANSTATUS)
1096f82e85aSdrh   if( pParse->explain==2 )
1106f82e85aSdrh #endif
1116f82e85aSdrh   {
1126f82e85aSdrh     struct SrcList_item *pItem = &pTabList->a[pLevel->iFrom];
1136f82e85aSdrh     Vdbe *v = pParse->pVdbe;      /* VM being constructed */
1146f82e85aSdrh     sqlite3 *db = pParse->db;     /* Database handle */
1156f82e85aSdrh     int iId = pParse->iSelectId;  /* Select id (left-most output column) */
1166f82e85aSdrh     int isSearch;                 /* True for a SEARCH. False for SCAN. */
1176f82e85aSdrh     WhereLoop *pLoop;             /* The controlling WhereLoop object */
1186f82e85aSdrh     u32 flags;                    /* Flags that describe this loop */
1196f82e85aSdrh     char *zMsg;                   /* Text to add to EQP output */
1206f82e85aSdrh     StrAccum str;                 /* EQP output string */
1216f82e85aSdrh     char zBuf[100];               /* Initial space for EQP output string */
1226f82e85aSdrh 
1236f82e85aSdrh     pLoop = pLevel->pWLoop;
1246f82e85aSdrh     flags = pLoop->wsFlags;
1256f82e85aSdrh     if( (flags&WHERE_MULTI_OR) || (wctrlFlags&WHERE_ONETABLE_ONLY) ) return 0;
1266f82e85aSdrh 
1276f82e85aSdrh     isSearch = (flags&(WHERE_BTM_LIMIT|WHERE_TOP_LIMIT))!=0
1286f82e85aSdrh             || ((flags&WHERE_VIRTUALTABLE)==0 && (pLoop->u.btree.nEq>0))
1296f82e85aSdrh             || (wctrlFlags&(WHERE_ORDERBY_MIN|WHERE_ORDERBY_MAX));
1306f82e85aSdrh 
1316f82e85aSdrh     sqlite3StrAccumInit(&str, db, zBuf, sizeof(zBuf), SQLITE_MAX_LENGTH);
1326f82e85aSdrh     sqlite3StrAccumAppendAll(&str, isSearch ? "SEARCH" : "SCAN");
1336f82e85aSdrh     if( pItem->pSelect ){
1346f82e85aSdrh       sqlite3XPrintf(&str, 0, " SUBQUERY %d", pItem->iSelectId);
1356f82e85aSdrh     }else{
1366f82e85aSdrh       sqlite3XPrintf(&str, 0, " TABLE %s", pItem->zName);
1376f82e85aSdrh     }
1386f82e85aSdrh 
1396f82e85aSdrh     if( pItem->zAlias ){
1406f82e85aSdrh       sqlite3XPrintf(&str, 0, " AS %s", pItem->zAlias);
1416f82e85aSdrh     }
1426f82e85aSdrh     if( (flags & (WHERE_IPK|WHERE_VIRTUALTABLE))==0 ){
1436f82e85aSdrh       const char *zFmt = 0;
1446f82e85aSdrh       Index *pIdx;
1456f82e85aSdrh 
1466f82e85aSdrh       assert( pLoop->u.btree.pIndex!=0 );
1476f82e85aSdrh       pIdx = pLoop->u.btree.pIndex;
1486f82e85aSdrh       assert( !(flags&WHERE_AUTO_INDEX) || (flags&WHERE_IDX_ONLY) );
1496f82e85aSdrh       if( !HasRowid(pItem->pTab) && IsPrimaryKeyIndex(pIdx) ){
1506f82e85aSdrh         if( isSearch ){
1516f82e85aSdrh           zFmt = "PRIMARY KEY";
1526f82e85aSdrh         }
1536f82e85aSdrh       }else if( flags & WHERE_PARTIALIDX ){
1546f82e85aSdrh         zFmt = "AUTOMATIC PARTIAL COVERING INDEX";
1556f82e85aSdrh       }else if( flags & WHERE_AUTO_INDEX ){
1566f82e85aSdrh         zFmt = "AUTOMATIC COVERING INDEX";
1576f82e85aSdrh       }else if( flags & WHERE_IDX_ONLY ){
1586f82e85aSdrh         zFmt = "COVERING INDEX %s";
1596f82e85aSdrh       }else{
1606f82e85aSdrh         zFmt = "INDEX %s";
1616f82e85aSdrh       }
1626f82e85aSdrh       if( zFmt ){
1636f82e85aSdrh         sqlite3StrAccumAppend(&str, " USING ", 7);
1646f82e85aSdrh         sqlite3XPrintf(&str, 0, zFmt, pIdx->zName);
1656f82e85aSdrh         explainIndexRange(&str, pLoop, pItem->pTab);
1666f82e85aSdrh       }
1676f82e85aSdrh     }else if( (flags & WHERE_IPK)!=0 && (flags & WHERE_CONSTRAINT)!=0 ){
1686f82e85aSdrh       const char *zRange;
1696f82e85aSdrh       if( flags&(WHERE_COLUMN_EQ|WHERE_COLUMN_IN) ){
1706f82e85aSdrh         zRange = "(rowid=?)";
1716f82e85aSdrh       }else if( (flags&WHERE_BOTH_LIMIT)==WHERE_BOTH_LIMIT ){
1726f82e85aSdrh         zRange = "(rowid>? AND rowid<?)";
1736f82e85aSdrh       }else if( flags&WHERE_BTM_LIMIT ){
1746f82e85aSdrh         zRange = "(rowid>?)";
1756f82e85aSdrh       }else{
1766f82e85aSdrh         assert( flags&WHERE_TOP_LIMIT);
1776f82e85aSdrh         zRange = "(rowid<?)";
1786f82e85aSdrh       }
1796f82e85aSdrh       sqlite3StrAccumAppendAll(&str, " USING INTEGER PRIMARY KEY ");
1806f82e85aSdrh       sqlite3StrAccumAppendAll(&str, zRange);
1816f82e85aSdrh     }
1826f82e85aSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
1836f82e85aSdrh     else if( (flags & WHERE_VIRTUALTABLE)!=0 ){
1846f82e85aSdrh       sqlite3XPrintf(&str, 0, " VIRTUAL TABLE INDEX %d:%s",
1856f82e85aSdrh                   pLoop->u.vtab.idxNum, pLoop->u.vtab.idxStr);
1866f82e85aSdrh     }
1876f82e85aSdrh #endif
1886f82e85aSdrh #ifdef SQLITE_EXPLAIN_ESTIMATED_ROWS
1896f82e85aSdrh     if( pLoop->nOut>=10 ){
1906f82e85aSdrh       sqlite3XPrintf(&str, 0, " (~%llu rows)", sqlite3LogEstToInt(pLoop->nOut));
1916f82e85aSdrh     }else{
1926f82e85aSdrh       sqlite3StrAccumAppend(&str, " (~1 row)", 9);
1936f82e85aSdrh     }
1946f82e85aSdrh #endif
1956f82e85aSdrh     zMsg = sqlite3StrAccumFinish(&str);
1966f82e85aSdrh     ret = sqlite3VdbeAddOp4(v, OP_Explain, iId, iLevel, iFrom, zMsg,P4_DYNAMIC);
1976f82e85aSdrh   }
1986f82e85aSdrh   return ret;
1996f82e85aSdrh }
2006f82e85aSdrh #endif /* SQLITE_OMIT_EXPLAIN */
2016f82e85aSdrh 
2026f82e85aSdrh #ifdef SQLITE_ENABLE_STMT_SCANSTATUS
2036f82e85aSdrh /*
2046f82e85aSdrh ** Configure the VM passed as the first argument with an
2056f82e85aSdrh ** sqlite3_stmt_scanstatus() entry corresponding to the scan used to
2066f82e85aSdrh ** implement level pLvl. Argument pSrclist is a pointer to the FROM
2076f82e85aSdrh ** clause that the scan reads data from.
2086f82e85aSdrh **
2096f82e85aSdrh ** If argument addrExplain is not 0, it must be the address of an
2106f82e85aSdrh ** OP_Explain instruction that describes the same loop.
2116f82e85aSdrh */
2126f82e85aSdrh void sqlite3WhereAddScanStatus(
2136f82e85aSdrh   Vdbe *v,                        /* Vdbe to add scanstatus entry to */
2146f82e85aSdrh   SrcList *pSrclist,              /* FROM clause pLvl reads data from */
2156f82e85aSdrh   WhereLevel *pLvl,               /* Level to add scanstatus() entry for */
2166f82e85aSdrh   int addrExplain                 /* Address of OP_Explain (or 0) */
2176f82e85aSdrh ){
2186f82e85aSdrh   const char *zObj = 0;
2196f82e85aSdrh   WhereLoop *pLoop = pLvl->pWLoop;
2206f82e85aSdrh   if( (pLoop->wsFlags & WHERE_VIRTUALTABLE)==0  &&  pLoop->u.btree.pIndex!=0 ){
2216f82e85aSdrh     zObj = pLoop->u.btree.pIndex->zName;
2226f82e85aSdrh   }else{
2236f82e85aSdrh     zObj = pSrclist->a[pLvl->iFrom].zName;
2246f82e85aSdrh   }
2256f82e85aSdrh   sqlite3VdbeScanStatus(
2266f82e85aSdrh       v, addrExplain, pLvl->addrBody, pLvl->addrVisit, pLoop->nOut, zObj
2276f82e85aSdrh   );
2286f82e85aSdrh }
2296f82e85aSdrh #endif
2306f82e85aSdrh 
2316f82e85aSdrh 
2326f82e85aSdrh /*
2336f82e85aSdrh ** Disable a term in the WHERE clause.  Except, do not disable the term
2346f82e85aSdrh ** if it controls a LEFT OUTER JOIN and it did not originate in the ON
2356f82e85aSdrh ** or USING clause of that join.
2366f82e85aSdrh **
2376f82e85aSdrh ** Consider the term t2.z='ok' in the following queries:
2386f82e85aSdrh **
2396f82e85aSdrh **   (1)  SELECT * FROM t1 LEFT JOIN t2 ON t1.a=t2.x WHERE t2.z='ok'
2406f82e85aSdrh **   (2)  SELECT * FROM t1 LEFT JOIN t2 ON t1.a=t2.x AND t2.z='ok'
2416f82e85aSdrh **   (3)  SELECT * FROM t1, t2 WHERE t1.a=t2.x AND t2.z='ok'
2426f82e85aSdrh **
2436f82e85aSdrh ** The t2.z='ok' is disabled in the in (2) because it originates
2446f82e85aSdrh ** in the ON clause.  The term is disabled in (3) because it is not part
2456f82e85aSdrh ** of a LEFT OUTER JOIN.  In (1), the term is not disabled.
2466f82e85aSdrh **
2476f82e85aSdrh ** Disabling a term causes that term to not be tested in the inner loop
2486f82e85aSdrh ** of the join.  Disabling is an optimization.  When terms are satisfied
2496f82e85aSdrh ** by indices, we disable them to prevent redundant tests in the inner
2506f82e85aSdrh ** loop.  We would get the correct results if nothing were ever disabled,
2516f82e85aSdrh ** but joins might run a little slower.  The trick is to disable as much
2526f82e85aSdrh ** as we can without disabling too much.  If we disabled in (1), we'd get
2536f82e85aSdrh ** the wrong answer.  See ticket #813.
2546f82e85aSdrh **
2556f82e85aSdrh ** If all the children of a term are disabled, then that term is also
2566f82e85aSdrh ** automatically disabled.  In this way, terms get disabled if derived
2576f82e85aSdrh ** virtual terms are tested first.  For example:
2586f82e85aSdrh **
2596f82e85aSdrh **      x GLOB 'abc*' AND x>='abc' AND x<'acd'
2606f82e85aSdrh **      \___________/     \______/     \_____/
2616f82e85aSdrh **         parent          child1       child2
2626f82e85aSdrh **
2636f82e85aSdrh ** Only the parent term was in the original WHERE clause.  The child1
2646f82e85aSdrh ** and child2 terms were added by the LIKE optimization.  If both of
2656f82e85aSdrh ** the virtual child terms are valid, then testing of the parent can be
2666f82e85aSdrh ** skipped.
2676f82e85aSdrh **
2686f82e85aSdrh ** Usually the parent term is marked as TERM_CODED.  But if the parent
2696f82e85aSdrh ** term was originally TERM_LIKE, then the parent gets TERM_LIKECOND instead.
2706f82e85aSdrh ** The TERM_LIKECOND marking indicates that the term should be coded inside
2716f82e85aSdrh ** a conditional such that is only evaluated on the second pass of a
2726f82e85aSdrh ** LIKE-optimization loop, when scanning BLOBs instead of strings.
2736f82e85aSdrh */
2746f82e85aSdrh static void disableTerm(WhereLevel *pLevel, WhereTerm *pTerm){
2756f82e85aSdrh   int nLoop = 0;
2766f82e85aSdrh   while( pTerm
2776f82e85aSdrh       && (pTerm->wtFlags & TERM_CODED)==0
2786f82e85aSdrh       && (pLevel->iLeftJoin==0 || ExprHasProperty(pTerm->pExpr, EP_FromJoin))
2796f82e85aSdrh       && (pLevel->notReady & pTerm->prereqAll)==0
2806f82e85aSdrh   ){
2816f82e85aSdrh     if( nLoop && (pTerm->wtFlags & TERM_LIKE)!=0 ){
2826f82e85aSdrh       pTerm->wtFlags |= TERM_LIKECOND;
2836f82e85aSdrh     }else{
2846f82e85aSdrh       pTerm->wtFlags |= TERM_CODED;
2856f82e85aSdrh     }
2866f82e85aSdrh     if( pTerm->iParent<0 ) break;
2876f82e85aSdrh     pTerm = &pTerm->pWC->a[pTerm->iParent];
2886f82e85aSdrh     pTerm->nChild--;
2896f82e85aSdrh     if( pTerm->nChild!=0 ) break;
2906f82e85aSdrh     nLoop++;
2916f82e85aSdrh   }
2926f82e85aSdrh }
2936f82e85aSdrh 
2946f82e85aSdrh /*
2956f82e85aSdrh ** Code an OP_Affinity opcode to apply the column affinity string zAff
2966f82e85aSdrh ** to the n registers starting at base.
2976f82e85aSdrh **
2986f82e85aSdrh ** As an optimization, SQLITE_AFF_BLOB entries (which are no-ops) at the
2996f82e85aSdrh ** beginning and end of zAff are ignored.  If all entries in zAff are
3006f82e85aSdrh ** SQLITE_AFF_BLOB, then no code gets generated.
3016f82e85aSdrh **
3026f82e85aSdrh ** This routine makes its own copy of zAff so that the caller is free
3036f82e85aSdrh ** to modify zAff after this routine returns.
3046f82e85aSdrh */
3056f82e85aSdrh static void codeApplyAffinity(Parse *pParse, int base, int n, char *zAff){
3066f82e85aSdrh   Vdbe *v = pParse->pVdbe;
3076f82e85aSdrh   if( zAff==0 ){
3086f82e85aSdrh     assert( pParse->db->mallocFailed );
3096f82e85aSdrh     return;
3106f82e85aSdrh   }
3116f82e85aSdrh   assert( v!=0 );
3126f82e85aSdrh 
3136f82e85aSdrh   /* Adjust base and n to skip over SQLITE_AFF_BLOB entries at the beginning
3146f82e85aSdrh   ** and end of the affinity string.
3156f82e85aSdrh   */
3166f82e85aSdrh   while( n>0 && zAff[0]==SQLITE_AFF_BLOB ){
3176f82e85aSdrh     n--;
3186f82e85aSdrh     base++;
3196f82e85aSdrh     zAff++;
3206f82e85aSdrh   }
3216f82e85aSdrh   while( n>1 && zAff[n-1]==SQLITE_AFF_BLOB ){
3226f82e85aSdrh     n--;
3236f82e85aSdrh   }
3246f82e85aSdrh 
3256f82e85aSdrh   /* Code the OP_Affinity opcode if there is anything left to do. */
3266f82e85aSdrh   if( n>0 ){
3276f82e85aSdrh     sqlite3VdbeAddOp2(v, OP_Affinity, base, n);
3286f82e85aSdrh     sqlite3VdbeChangeP4(v, -1, zAff, n);
3296f82e85aSdrh     sqlite3ExprCacheAffinityChange(pParse, base, n);
3306f82e85aSdrh   }
3316f82e85aSdrh }
3326f82e85aSdrh 
3336f82e85aSdrh 
3346f82e85aSdrh /*
3356f82e85aSdrh ** Generate code for a single equality term of the WHERE clause.  An equality
3366f82e85aSdrh ** term can be either X=expr or X IN (...).   pTerm is the term to be
3376f82e85aSdrh ** coded.
3386f82e85aSdrh **
3396f82e85aSdrh ** The current value for the constraint is left in register iReg.
3406f82e85aSdrh **
3416f82e85aSdrh ** For a constraint of the form X=expr, the expression is evaluated and its
3426f82e85aSdrh ** result is left on the stack.  For constraints of the form X IN (...)
3436f82e85aSdrh ** this routine sets up a loop that will iterate over all values of X.
3446f82e85aSdrh */
3456f82e85aSdrh static int codeEqualityTerm(
3466f82e85aSdrh   Parse *pParse,      /* The parsing context */
3476f82e85aSdrh   WhereTerm *pTerm,   /* The term of the WHERE clause to be coded */
3486f82e85aSdrh   WhereLevel *pLevel, /* The level of the FROM clause we are working on */
3496f82e85aSdrh   int iEq,            /* Index of the equality term within this level */
3506f82e85aSdrh   int bRev,           /* True for reverse-order IN operations */
3516f82e85aSdrh   int iTarget         /* Attempt to leave results in this register */
3526f82e85aSdrh ){
3536f82e85aSdrh   Expr *pX = pTerm->pExpr;
3546f82e85aSdrh   Vdbe *v = pParse->pVdbe;
3556f82e85aSdrh   int iReg;                  /* Register holding results */
3566f82e85aSdrh 
3576f82e85aSdrh   assert( iTarget>0 );
3586f82e85aSdrh   if( pX->op==TK_EQ || pX->op==TK_IS ){
3596f82e85aSdrh     iReg = sqlite3ExprCodeTarget(pParse, pX->pRight, iTarget);
3606f82e85aSdrh   }else if( pX->op==TK_ISNULL ){
3616f82e85aSdrh     iReg = iTarget;
3626f82e85aSdrh     sqlite3VdbeAddOp2(v, OP_Null, 0, iReg);
3636f82e85aSdrh #ifndef SQLITE_OMIT_SUBQUERY
3646f82e85aSdrh   }else{
3656f82e85aSdrh     int eType;
3666f82e85aSdrh     int iTab;
3676f82e85aSdrh     struct InLoop *pIn;
3686f82e85aSdrh     WhereLoop *pLoop = pLevel->pWLoop;
3696f82e85aSdrh 
3706f82e85aSdrh     if( (pLoop->wsFlags & WHERE_VIRTUALTABLE)==0
3716f82e85aSdrh       && pLoop->u.btree.pIndex!=0
3726f82e85aSdrh       && pLoop->u.btree.pIndex->aSortOrder[iEq]
3736f82e85aSdrh     ){
3746f82e85aSdrh       testcase( iEq==0 );
3756f82e85aSdrh       testcase( bRev );
3766f82e85aSdrh       bRev = !bRev;
3776f82e85aSdrh     }
3786f82e85aSdrh     assert( pX->op==TK_IN );
3796f82e85aSdrh     iReg = iTarget;
3806f82e85aSdrh     eType = sqlite3FindInIndex(pParse, pX, IN_INDEX_LOOP, 0);
3816f82e85aSdrh     if( eType==IN_INDEX_INDEX_DESC ){
3826f82e85aSdrh       testcase( bRev );
3836f82e85aSdrh       bRev = !bRev;
3846f82e85aSdrh     }
3856f82e85aSdrh     iTab = pX->iTable;
3866f82e85aSdrh     sqlite3VdbeAddOp2(v, bRev ? OP_Last : OP_Rewind, iTab, 0);
3876f82e85aSdrh     VdbeCoverageIf(v, bRev);
3886f82e85aSdrh     VdbeCoverageIf(v, !bRev);
3896f82e85aSdrh     assert( (pLoop->wsFlags & WHERE_MULTI_OR)==0 );
3906f82e85aSdrh     pLoop->wsFlags |= WHERE_IN_ABLE;
3916f82e85aSdrh     if( pLevel->u.in.nIn==0 ){
3926f82e85aSdrh       pLevel->addrNxt = sqlite3VdbeMakeLabel(v);
3936f82e85aSdrh     }
3946f82e85aSdrh     pLevel->u.in.nIn++;
3956f82e85aSdrh     pLevel->u.in.aInLoop =
3966f82e85aSdrh        sqlite3DbReallocOrFree(pParse->db, pLevel->u.in.aInLoop,
3976f82e85aSdrh                               sizeof(pLevel->u.in.aInLoop[0])*pLevel->u.in.nIn);
3986f82e85aSdrh     pIn = pLevel->u.in.aInLoop;
3996f82e85aSdrh     if( pIn ){
4006f82e85aSdrh       pIn += pLevel->u.in.nIn - 1;
4016f82e85aSdrh       pIn->iCur = iTab;
4026f82e85aSdrh       if( eType==IN_INDEX_ROWID ){
4036f82e85aSdrh         pIn->addrInTop = sqlite3VdbeAddOp2(v, OP_Rowid, iTab, iReg);
4046f82e85aSdrh       }else{
4056f82e85aSdrh         pIn->addrInTop = sqlite3VdbeAddOp3(v, OP_Column, iTab, 0, iReg);
4066f82e85aSdrh       }
4076f82e85aSdrh       pIn->eEndLoopOp = bRev ? OP_PrevIfOpen : OP_NextIfOpen;
4086f82e85aSdrh       sqlite3VdbeAddOp1(v, OP_IsNull, iReg); VdbeCoverage(v);
4096f82e85aSdrh     }else{
4106f82e85aSdrh       pLevel->u.in.nIn = 0;
4116f82e85aSdrh     }
4126f82e85aSdrh #endif
4136f82e85aSdrh   }
4146f82e85aSdrh   disableTerm(pLevel, pTerm);
4156f82e85aSdrh   return iReg;
4166f82e85aSdrh }
4176f82e85aSdrh 
4186f82e85aSdrh /*
4196f82e85aSdrh ** Generate code that will evaluate all == and IN constraints for an
4206f82e85aSdrh ** index scan.
4216f82e85aSdrh **
4226f82e85aSdrh ** For example, consider table t1(a,b,c,d,e,f) with index i1(a,b,c).
4236f82e85aSdrh ** Suppose the WHERE clause is this:  a==5 AND b IN (1,2,3) AND c>5 AND c<10
4246f82e85aSdrh ** The index has as many as three equality constraints, but in this
4256f82e85aSdrh ** example, the third "c" value is an inequality.  So only two
4266f82e85aSdrh ** constraints are coded.  This routine will generate code to evaluate
4276f82e85aSdrh ** a==5 and b IN (1,2,3).  The current values for a and b will be stored
4286f82e85aSdrh ** in consecutive registers and the index of the first register is returned.
4296f82e85aSdrh **
4306f82e85aSdrh ** In the example above nEq==2.  But this subroutine works for any value
4316f82e85aSdrh ** of nEq including 0.  If nEq==0, this routine is nearly a no-op.
4326f82e85aSdrh ** The only thing it does is allocate the pLevel->iMem memory cell and
4336f82e85aSdrh ** compute the affinity string.
4346f82e85aSdrh **
4356f82e85aSdrh ** The nExtraReg parameter is 0 or 1.  It is 0 if all WHERE clause constraints
4366f82e85aSdrh ** are == or IN and are covered by the nEq.  nExtraReg is 1 if there is
4376f82e85aSdrh ** an inequality constraint (such as the "c>=5 AND c<10" in the example) that
4386f82e85aSdrh ** occurs after the nEq quality constraints.
4396f82e85aSdrh **
4406f82e85aSdrh ** This routine allocates a range of nEq+nExtraReg memory cells and returns
4416f82e85aSdrh ** the index of the first memory cell in that range. The code that
4426f82e85aSdrh ** calls this routine will use that memory range to store keys for
4436f82e85aSdrh ** start and termination conditions of the loop.
4446f82e85aSdrh ** key value of the loop.  If one or more IN operators appear, then
4456f82e85aSdrh ** this routine allocates an additional nEq memory cells for internal
4466f82e85aSdrh ** use.
4476f82e85aSdrh **
4486f82e85aSdrh ** Before returning, *pzAff is set to point to a buffer containing a
4496f82e85aSdrh ** copy of the column affinity string of the index allocated using
4506f82e85aSdrh ** sqlite3DbMalloc(). Except, entries in the copy of the string associated
4516f82e85aSdrh ** with equality constraints that use BLOB or NONE affinity are set to
4526f82e85aSdrh ** SQLITE_AFF_BLOB. This is to deal with SQL such as the following:
4536f82e85aSdrh **
4546f82e85aSdrh **   CREATE TABLE t1(a TEXT PRIMARY KEY, b);
4556f82e85aSdrh **   SELECT ... FROM t1 AS t2, t1 WHERE t1.a = t2.b;
4566f82e85aSdrh **
4576f82e85aSdrh ** In the example above, the index on t1(a) has TEXT affinity. But since
4586f82e85aSdrh ** the right hand side of the equality constraint (t2.b) has BLOB/NONE affinity,
4596f82e85aSdrh ** no conversion should be attempted before using a t2.b value as part of
4606f82e85aSdrh ** a key to search the index. Hence the first byte in the returned affinity
4616f82e85aSdrh ** string in this example would be set to SQLITE_AFF_BLOB.
4626f82e85aSdrh */
4636f82e85aSdrh static int codeAllEqualityTerms(
4646f82e85aSdrh   Parse *pParse,        /* Parsing context */
4656f82e85aSdrh   WhereLevel *pLevel,   /* Which nested loop of the FROM we are coding */
4666f82e85aSdrh   int bRev,             /* Reverse the order of IN operators */
4676f82e85aSdrh   int nExtraReg,        /* Number of extra registers to allocate */
4686f82e85aSdrh   char **pzAff          /* OUT: Set to point to affinity string */
4696f82e85aSdrh ){
4706f82e85aSdrh   u16 nEq;                      /* The number of == or IN constraints to code */
4716f82e85aSdrh   u16 nSkip;                    /* Number of left-most columns to skip */
4726f82e85aSdrh   Vdbe *v = pParse->pVdbe;      /* The vm under construction */
4736f82e85aSdrh   Index *pIdx;                  /* The index being used for this loop */
4746f82e85aSdrh   WhereTerm *pTerm;             /* A single constraint term */
4756f82e85aSdrh   WhereLoop *pLoop;             /* The WhereLoop object */
4766f82e85aSdrh   int j;                        /* Loop counter */
4776f82e85aSdrh   int regBase;                  /* Base register */
4786f82e85aSdrh   int nReg;                     /* Number of registers to allocate */
4796f82e85aSdrh   char *zAff;                   /* Affinity string to return */
4806f82e85aSdrh 
4816f82e85aSdrh   /* This module is only called on query plans that use an index. */
4826f82e85aSdrh   pLoop = pLevel->pWLoop;
4836f82e85aSdrh   assert( (pLoop->wsFlags & WHERE_VIRTUALTABLE)==0 );
4846f82e85aSdrh   nEq = pLoop->u.btree.nEq;
4856f82e85aSdrh   nSkip = pLoop->nSkip;
4866f82e85aSdrh   pIdx = pLoop->u.btree.pIndex;
4876f82e85aSdrh   assert( pIdx!=0 );
4886f82e85aSdrh 
4896f82e85aSdrh   /* Figure out how many memory cells we will need then allocate them.
4906f82e85aSdrh   */
4916f82e85aSdrh   regBase = pParse->nMem + 1;
4926f82e85aSdrh   nReg = pLoop->u.btree.nEq + nExtraReg;
4936f82e85aSdrh   pParse->nMem += nReg;
4946f82e85aSdrh 
4956f82e85aSdrh   zAff = sqlite3DbStrDup(pParse->db, sqlite3IndexAffinityStr(v, pIdx));
4966f82e85aSdrh   if( !zAff ){
4976f82e85aSdrh     pParse->db->mallocFailed = 1;
4986f82e85aSdrh   }
4996f82e85aSdrh 
5006f82e85aSdrh   if( nSkip ){
5016f82e85aSdrh     int iIdxCur = pLevel->iIdxCur;
5026f82e85aSdrh     sqlite3VdbeAddOp1(v, (bRev?OP_Last:OP_Rewind), iIdxCur);
5036f82e85aSdrh     VdbeCoverageIf(v, bRev==0);
5046f82e85aSdrh     VdbeCoverageIf(v, bRev!=0);
5056f82e85aSdrh     VdbeComment((v, "begin skip-scan on %s", pIdx->zName));
5066f82e85aSdrh     j = sqlite3VdbeAddOp0(v, OP_Goto);
5076f82e85aSdrh     pLevel->addrSkip = sqlite3VdbeAddOp4Int(v, (bRev?OP_SeekLT:OP_SeekGT),
5086f82e85aSdrh                             iIdxCur, 0, regBase, nSkip);
5096f82e85aSdrh     VdbeCoverageIf(v, bRev==0);
5106f82e85aSdrh     VdbeCoverageIf(v, bRev!=0);
5116f82e85aSdrh     sqlite3VdbeJumpHere(v, j);
5126f82e85aSdrh     for(j=0; j<nSkip; j++){
5136f82e85aSdrh       sqlite3VdbeAddOp3(v, OP_Column, iIdxCur, j, regBase+j);
5146f82e85aSdrh       assert( pIdx->aiColumn[j]>=0 );
5156f82e85aSdrh       VdbeComment((v, "%s", pIdx->pTable->aCol[pIdx->aiColumn[j]].zName));
5166f82e85aSdrh     }
5176f82e85aSdrh   }
5186f82e85aSdrh 
5196f82e85aSdrh   /* Evaluate the equality constraints
5206f82e85aSdrh   */
5216f82e85aSdrh   assert( zAff==0 || (int)strlen(zAff)>=nEq );
5226f82e85aSdrh   for(j=nSkip; j<nEq; j++){
5236f82e85aSdrh     int r1;
5246f82e85aSdrh     pTerm = pLoop->aLTerm[j];
5256f82e85aSdrh     assert( pTerm!=0 );
5266f82e85aSdrh     /* The following testcase is true for indices with redundant columns.
5276f82e85aSdrh     ** Ex: CREATE INDEX i1 ON t1(a,b,a); SELECT * FROM t1 WHERE a=0 AND b=0; */
5286f82e85aSdrh     testcase( (pTerm->wtFlags & TERM_CODED)!=0 );
5296f82e85aSdrh     testcase( pTerm->wtFlags & TERM_VIRTUAL );
5306f82e85aSdrh     r1 = codeEqualityTerm(pParse, pTerm, pLevel, j, bRev, regBase+j);
5316f82e85aSdrh     if( r1!=regBase+j ){
5326f82e85aSdrh       if( nReg==1 ){
5336f82e85aSdrh         sqlite3ReleaseTempReg(pParse, regBase);
5346f82e85aSdrh         regBase = r1;
5356f82e85aSdrh       }else{
5366f82e85aSdrh         sqlite3VdbeAddOp2(v, OP_SCopy, r1, regBase+j);
5376f82e85aSdrh       }
5386f82e85aSdrh     }
5396f82e85aSdrh     testcase( pTerm->eOperator & WO_ISNULL );
5406f82e85aSdrh     testcase( pTerm->eOperator & WO_IN );
5416f82e85aSdrh     if( (pTerm->eOperator & (WO_ISNULL|WO_IN))==0 ){
5426f82e85aSdrh       Expr *pRight = pTerm->pExpr->pRight;
5436f82e85aSdrh       if( (pTerm->wtFlags & TERM_IS)==0 && sqlite3ExprCanBeNull(pRight) ){
5446f82e85aSdrh         sqlite3VdbeAddOp2(v, OP_IsNull, regBase+j, pLevel->addrBrk);
5456f82e85aSdrh         VdbeCoverage(v);
5466f82e85aSdrh       }
5476f82e85aSdrh       if( zAff ){
5486f82e85aSdrh         if( sqlite3CompareAffinity(pRight, zAff[j])==SQLITE_AFF_BLOB ){
5496f82e85aSdrh           zAff[j] = SQLITE_AFF_BLOB;
5506f82e85aSdrh         }
5516f82e85aSdrh         if( sqlite3ExprNeedsNoAffinityChange(pRight, zAff[j]) ){
5526f82e85aSdrh           zAff[j] = SQLITE_AFF_BLOB;
5536f82e85aSdrh         }
5546f82e85aSdrh       }
5556f82e85aSdrh     }
5566f82e85aSdrh   }
5576f82e85aSdrh   *pzAff = zAff;
5586f82e85aSdrh   return regBase;
5596f82e85aSdrh }
5606f82e85aSdrh 
5616f82e85aSdrh /*
5626f82e85aSdrh ** If the most recently coded instruction is a constant range contraint
5636f82e85aSdrh ** that originated from the LIKE optimization, then change the P3 to be
5646f82e85aSdrh ** pLoop->iLikeRepCntr and set P5.
5656f82e85aSdrh **
5666f82e85aSdrh ** The LIKE optimization trys to evaluate "x LIKE 'abc%'" as a range
5676f82e85aSdrh ** expression: "x>='ABC' AND x<'abd'".  But this requires that the range
5686f82e85aSdrh ** scan loop run twice, once for strings and a second time for BLOBs.
5696f82e85aSdrh ** The OP_String opcodes on the second pass convert the upper and lower
5706f82e85aSdrh ** bound string contants to blobs.  This routine makes the necessary changes
5716f82e85aSdrh ** to the OP_String opcodes for that to happen.
5726f82e85aSdrh */
5736f82e85aSdrh static void whereLikeOptimizationStringFixup(
5746f82e85aSdrh   Vdbe *v,                /* prepared statement under construction */
5756f82e85aSdrh   WhereLevel *pLevel,     /* The loop that contains the LIKE operator */
5766f82e85aSdrh   WhereTerm *pTerm        /* The upper or lower bound just coded */
5776f82e85aSdrh ){
5786f82e85aSdrh   if( pTerm->wtFlags & TERM_LIKEOPT ){
5796f82e85aSdrh     VdbeOp *pOp;
5806f82e85aSdrh     assert( pLevel->iLikeRepCntr>0 );
5816f82e85aSdrh     pOp = sqlite3VdbeGetOp(v, -1);
5826f82e85aSdrh     assert( pOp!=0 );
5836f82e85aSdrh     assert( pOp->opcode==OP_String8
5846f82e85aSdrh             || pTerm->pWC->pWInfo->pParse->db->mallocFailed );
5856f82e85aSdrh     pOp->p3 = pLevel->iLikeRepCntr;
5866f82e85aSdrh     pOp->p5 = 1;
5876f82e85aSdrh   }
5886f82e85aSdrh }
5896f82e85aSdrh 
590bec2476aSdrh #ifdef SQLITE_ENABLE_CURSOR_HINTS
591bec2476aSdrh 
592bec2476aSdrh /*
593bec2476aSdrh ** This function is called on every node of an expression tree used as an
594bec2476aSdrh ** argument to the OP_CursorHint instruction. If the node is a TK_COLUMN
595bec2476aSdrh ** that accesses any cursor other than (pWalker->u.i), do the following:
596bec2476aSdrh **
597bec2476aSdrh **   1) allocate a register and code an OP_Column instruction to read
598bec2476aSdrh **      the specified column into the new register, and
599bec2476aSdrh **
600bec2476aSdrh **   2) transform the expression node to a TK_REGISTER node that reads
601bec2476aSdrh **      from the newly populated register.
602bec2476aSdrh */
603bec2476aSdrh static int codeCursorHintFixExpr(Walker *pWalker, Expr *pExpr){
604bec2476aSdrh   int rc = WRC_Continue;
605bec2476aSdrh   if( pExpr->op==TK_COLUMN && pExpr->iTable!=pWalker->u.n ){
606bec2476aSdrh     Vdbe *v = pWalker->pParse->pVdbe;
607bec2476aSdrh     int reg = ++pWalker->pParse->nMem;   /* Register for column value */
608bec2476aSdrh     sqlite3ExprCodeGetColumnOfTable(
609bec2476aSdrh         v, pExpr->pTab, pExpr->iTable, pExpr->iColumn, reg
610bec2476aSdrh     );
611bec2476aSdrh     pExpr->op = TK_REGISTER;
612bec2476aSdrh     pExpr->iTable = reg;
613bec2476aSdrh   }else if( pExpr->op==TK_AGG_FUNCTION ){
614bec2476aSdrh     /* An aggregate function in the WHERE clause of a query means this must
615bec2476aSdrh     ** be a correlated sub-query, and expression pExpr is an aggregate from
616bec2476aSdrh     ** the parent context. Do not walk the function arguments in this case.
617bec2476aSdrh     **
618bec2476aSdrh     ** todo: It should be possible to replace this node with a TK_REGISTER
619bec2476aSdrh     ** expression, as the result of the expression must be stored in a
620bec2476aSdrh     ** register at this point. The same holds for TK_AGG_COLUMN nodes. */
621bec2476aSdrh     rc = WRC_Prune;
622bec2476aSdrh   }
623bec2476aSdrh   return rc;
624bec2476aSdrh }
625bec2476aSdrh 
626bec2476aSdrh /*
627bec2476aSdrh ** Insert an OP_CursorHint instruction if it is appropriate to do so.
628bec2476aSdrh */
629bec2476aSdrh static void codeCursorHint(
630bec2476aSdrh   WhereInfo *pWInfo,
631bec2476aSdrh   int iLevel
632bec2476aSdrh ){
633bec2476aSdrh   Parse *pParse = pWInfo->pParse;
634bec2476aSdrh   sqlite3 *db = pParse->db;
635bec2476aSdrh   Vdbe *v = pParse->pVdbe;
636bec2476aSdrh   WhereLevel *pLevel;
637bec2476aSdrh   Expr *pExpr = 0;
638bec2476aSdrh   int iCur;
639bec2476aSdrh   WhereClause *pWC;
640bec2476aSdrh   WhereTerm *pTerm;
641bec2476aSdrh   WhereLoop *pWLoop;
642bec2476aSdrh   int i, j;
643bec2476aSdrh 
644bec2476aSdrh   if( OptimizationDisabled(db, SQLITE_CursorHints) ) return;
645bec2476aSdrh   pLevel = &pWInfo->a[iLevel];
646bec2476aSdrh   pWLoop = pLevel->pWLoop;
647bec2476aSdrh   iCur = pWInfo->pTabList->a[pLevel->iFrom].iCursor;
648bec2476aSdrh   pWC = &pWInfo->sWC;
649bec2476aSdrh   for(i=0; i<pWC->nTerm; i++){
650bec2476aSdrh     pTerm = &pWC->a[i];
651bec2476aSdrh     if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
652bec2476aSdrh     if( pTerm->prereqAll & pLevel->notReady ) continue;
653bec2476aSdrh     if( ExprHasProperty(pTerm->pExpr, EP_FromJoin) ) continue;
654bec2476aSdrh     if( sqlite3ExprContainsSubquery(pTerm->pExpr) ) continue;
655bec2476aSdrh     for(j=0; j<pWLoop->nLTerm && pWLoop->aLTerm[j]!=pTerm; j++){}
656bec2476aSdrh     if( j<pWLoop->nLTerm ) continue;
657bec2476aSdrh     pExpr = sqlite3ExprAnd(db, pExpr, sqlite3ExprDup(db, pTerm->pExpr, 0));
658bec2476aSdrh   }
659bec2476aSdrh   if( pExpr!=0 ){
660bec2476aSdrh     const char *a = (const char*)pExpr;
661bec2476aSdrh     Walker sWalker;
662bec2476aSdrh     memset(&sWalker, 0, sizeof(sWalker));
663bec2476aSdrh     sWalker.xExprCallback = codeCursorHintFixExpr;
664bec2476aSdrh     sWalker.pParse = pParse;
665bec2476aSdrh     sWalker.u.n = pLevel->iTabCur;
666bec2476aSdrh     sqlite3WalkExpr(&sWalker, pExpr);
667bec2476aSdrh     sqlite3VdbeAddOp4(v, OP_CursorHint, pLevel->iTabCur, iCur, 0, a, P4_EXPR);
668bec2476aSdrh   }
669bec2476aSdrh }
670bec2476aSdrh #else
671bec2476aSdrh # define codeCursorHint(A,B)  /* No-op */
672bec2476aSdrh #endif /* SQLITE_ENABLE_CURSOR_HINTS */
6736f82e85aSdrh 
6746f82e85aSdrh /*
6756f82e85aSdrh ** Generate code for the start of the iLevel-th loop in the WHERE clause
6766f82e85aSdrh ** implementation described by pWInfo.
6776f82e85aSdrh */
6786f82e85aSdrh Bitmask sqlite3WhereCodeOneLoopStart(
6796f82e85aSdrh   WhereInfo *pWInfo,   /* Complete information about the WHERE clause */
6806f82e85aSdrh   int iLevel,          /* Which level of pWInfo->a[] should be coded */
6816f82e85aSdrh   Bitmask notReady     /* Which tables are currently available */
6826f82e85aSdrh ){
6836f82e85aSdrh   int j, k;            /* Loop counters */
6846f82e85aSdrh   int iCur;            /* The VDBE cursor for the table */
6856f82e85aSdrh   int addrNxt;         /* Where to jump to continue with the next IN case */
6866f82e85aSdrh   int omitTable;       /* True if we use the index only */
6876f82e85aSdrh   int bRev;            /* True if we need to scan in reverse order */
6886f82e85aSdrh   WhereLevel *pLevel;  /* The where level to be coded */
6896f82e85aSdrh   WhereLoop *pLoop;    /* The WhereLoop object being coded */
6906f82e85aSdrh   WhereClause *pWC;    /* Decomposition of the entire WHERE clause */
6916f82e85aSdrh   WhereTerm *pTerm;               /* A WHERE clause term */
6926f82e85aSdrh   Parse *pParse;                  /* Parsing context */
6936f82e85aSdrh   sqlite3 *db;                    /* Database connection */
6946f82e85aSdrh   Vdbe *v;                        /* The prepared stmt under constructions */
6956f82e85aSdrh   struct SrcList_item *pTabItem;  /* FROM clause term being coded */
6966f82e85aSdrh   int addrBrk;                    /* Jump here to break out of the loop */
6976f82e85aSdrh   int addrCont;                   /* Jump here to continue with next cycle */
6986f82e85aSdrh   int iRowidReg = 0;        /* Rowid is stored in this register, if not zero */
6996f82e85aSdrh   int iReleaseReg = 0;      /* Temp register to free before returning */
7006f82e85aSdrh 
7016f82e85aSdrh   pParse = pWInfo->pParse;
7026f82e85aSdrh   v = pParse->pVdbe;
7036f82e85aSdrh   pWC = &pWInfo->sWC;
7046f82e85aSdrh   db = pParse->db;
7056f82e85aSdrh   pLevel = &pWInfo->a[iLevel];
7066f82e85aSdrh   pLoop = pLevel->pWLoop;
7076f82e85aSdrh   pTabItem = &pWInfo->pTabList->a[pLevel->iFrom];
7086f82e85aSdrh   iCur = pTabItem->iCursor;
7096f82e85aSdrh   pLevel->notReady = notReady & ~sqlite3WhereGetMask(&pWInfo->sMaskSet, iCur);
7106f82e85aSdrh   bRev = (pWInfo->revMask>>iLevel)&1;
7116f82e85aSdrh   omitTable = (pLoop->wsFlags & WHERE_IDX_ONLY)!=0
7126f82e85aSdrh            && (pWInfo->wctrlFlags & WHERE_FORCE_TABLE)==0;
7136f82e85aSdrh   VdbeModuleComment((v, "Begin WHERE-loop%d: %s",iLevel,pTabItem->pTab->zName));
7146f82e85aSdrh 
7156f82e85aSdrh   /* Create labels for the "break" and "continue" instructions
7166f82e85aSdrh   ** for the current loop.  Jump to addrBrk to break out of a loop.
7176f82e85aSdrh   ** Jump to cont to go immediately to the next iteration of the
7186f82e85aSdrh   ** loop.
7196f82e85aSdrh   **
7206f82e85aSdrh   ** When there is an IN operator, we also have a "addrNxt" label that
7216f82e85aSdrh   ** means to continue with the next IN value combination.  When
7226f82e85aSdrh   ** there are no IN operators in the constraints, the "addrNxt" label
7236f82e85aSdrh   ** is the same as "addrBrk".
7246f82e85aSdrh   */
7256f82e85aSdrh   addrBrk = pLevel->addrBrk = pLevel->addrNxt = sqlite3VdbeMakeLabel(v);
7266f82e85aSdrh   addrCont = pLevel->addrCont = sqlite3VdbeMakeLabel(v);
7276f82e85aSdrh 
7286f82e85aSdrh   /* If this is the right table of a LEFT OUTER JOIN, allocate and
7296f82e85aSdrh   ** initialize a memory cell that records if this table matches any
7306f82e85aSdrh   ** row of the left table of the join.
7316f82e85aSdrh   */
7326f82e85aSdrh   if( pLevel->iFrom>0 && (pTabItem[0].jointype & JT_LEFT)!=0 ){
7336f82e85aSdrh     pLevel->iLeftJoin = ++pParse->nMem;
7346f82e85aSdrh     sqlite3VdbeAddOp2(v, OP_Integer, 0, pLevel->iLeftJoin);
7356f82e85aSdrh     VdbeComment((v, "init LEFT JOIN no-match flag"));
7366f82e85aSdrh   }
7376f82e85aSdrh 
7386f82e85aSdrh   /* Special case of a FROM clause subquery implemented as a co-routine */
7396f82e85aSdrh   if( pTabItem->viaCoroutine ){
7406f82e85aSdrh     int regYield = pTabItem->regReturn;
7416f82e85aSdrh     sqlite3VdbeAddOp3(v, OP_InitCoroutine, regYield, 0, pTabItem->addrFillSub);
7426f82e85aSdrh     pLevel->p2 =  sqlite3VdbeAddOp2(v, OP_Yield, regYield, addrBrk);
7436f82e85aSdrh     VdbeCoverage(v);
7446f82e85aSdrh     VdbeComment((v, "next row of \"%s\"", pTabItem->pTab->zName));
7456f82e85aSdrh     pLevel->op = OP_Goto;
7466f82e85aSdrh   }else
7476f82e85aSdrh 
7486f82e85aSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
7496f82e85aSdrh   if(  (pLoop->wsFlags & WHERE_VIRTUALTABLE)!=0 ){
7506f82e85aSdrh     /* Case 1:  The table is a virtual-table.  Use the VFilter and VNext
7516f82e85aSdrh     **          to access the data.
7526f82e85aSdrh     */
7536f82e85aSdrh     int iReg;   /* P3 Value for OP_VFilter */
7546f82e85aSdrh     int addrNotFound;
7556f82e85aSdrh     int nConstraint = pLoop->nLTerm;
7566f82e85aSdrh 
7576f82e85aSdrh     sqlite3ExprCachePush(pParse);
7586f82e85aSdrh     iReg = sqlite3GetTempRange(pParse, nConstraint+2);
7596f82e85aSdrh     addrNotFound = pLevel->addrBrk;
7606f82e85aSdrh     for(j=0; j<nConstraint; j++){
7616f82e85aSdrh       int iTarget = iReg+j+2;
7626f82e85aSdrh       pTerm = pLoop->aLTerm[j];
7636f82e85aSdrh       if( pTerm==0 ) continue;
7646f82e85aSdrh       if( pTerm->eOperator & WO_IN ){
7656f82e85aSdrh         codeEqualityTerm(pParse, pTerm, pLevel, j, bRev, iTarget);
7666f82e85aSdrh         addrNotFound = pLevel->addrNxt;
7676f82e85aSdrh       }else{
7686f82e85aSdrh         sqlite3ExprCode(pParse, pTerm->pExpr->pRight, iTarget);
7696f82e85aSdrh       }
7706f82e85aSdrh     }
7716f82e85aSdrh     sqlite3VdbeAddOp2(v, OP_Integer, pLoop->u.vtab.idxNum, iReg);
7726f82e85aSdrh     sqlite3VdbeAddOp2(v, OP_Integer, nConstraint, iReg+1);
7736f82e85aSdrh     sqlite3VdbeAddOp4(v, OP_VFilter, iCur, addrNotFound, iReg,
7746f82e85aSdrh                       pLoop->u.vtab.idxStr,
7756f82e85aSdrh                       pLoop->u.vtab.needFree ? P4_MPRINTF : P4_STATIC);
7766f82e85aSdrh     VdbeCoverage(v);
7776f82e85aSdrh     pLoop->u.vtab.needFree = 0;
7786f82e85aSdrh     for(j=0; j<nConstraint && j<16; j++){
7796f82e85aSdrh       if( (pLoop->u.vtab.omitMask>>j)&1 ){
7806f82e85aSdrh         disableTerm(pLevel, pLoop->aLTerm[j]);
7816f82e85aSdrh       }
7826f82e85aSdrh     }
7836f82e85aSdrh     pLevel->op = OP_VNext;
7846f82e85aSdrh     pLevel->p1 = iCur;
7856f82e85aSdrh     pLevel->p2 = sqlite3VdbeCurrentAddr(v);
7866f82e85aSdrh     sqlite3ReleaseTempRange(pParse, iReg, nConstraint+2);
7876f82e85aSdrh     sqlite3ExprCachePop(pParse);
7886f82e85aSdrh   }else
7896f82e85aSdrh #endif /* SQLITE_OMIT_VIRTUALTABLE */
7906f82e85aSdrh 
7916f82e85aSdrh   if( (pLoop->wsFlags & WHERE_IPK)!=0
7926f82e85aSdrh    && (pLoop->wsFlags & (WHERE_COLUMN_IN|WHERE_COLUMN_EQ))!=0
7936f82e85aSdrh   ){
7946f82e85aSdrh     /* Case 2:  We can directly reference a single row using an
7956f82e85aSdrh     **          equality comparison against the ROWID field.  Or
7966f82e85aSdrh     **          we reference multiple rows using a "rowid IN (...)"
7976f82e85aSdrh     **          construct.
7986f82e85aSdrh     */
7996f82e85aSdrh     assert( pLoop->u.btree.nEq==1 );
8006f82e85aSdrh     pTerm = pLoop->aLTerm[0];
8016f82e85aSdrh     assert( pTerm!=0 );
8026f82e85aSdrh     assert( pTerm->pExpr!=0 );
8036f82e85aSdrh     assert( omitTable==0 );
8046f82e85aSdrh     testcase( pTerm->wtFlags & TERM_VIRTUAL );
8056f82e85aSdrh     iReleaseReg = ++pParse->nMem;
8066f82e85aSdrh     iRowidReg = codeEqualityTerm(pParse, pTerm, pLevel, 0, bRev, iReleaseReg);
8076f82e85aSdrh     if( iRowidReg!=iReleaseReg ) sqlite3ReleaseTempReg(pParse, iReleaseReg);
8086f82e85aSdrh     addrNxt = pLevel->addrNxt;
8096f82e85aSdrh     sqlite3VdbeAddOp2(v, OP_MustBeInt, iRowidReg, addrNxt); VdbeCoverage(v);
8106f82e85aSdrh     sqlite3VdbeAddOp3(v, OP_NotExists, iCur, addrNxt, iRowidReg);
8116f82e85aSdrh     VdbeCoverage(v);
8126f82e85aSdrh     sqlite3ExprCacheAffinityChange(pParse, iRowidReg, 1);
8136f82e85aSdrh     sqlite3ExprCacheStore(pParse, iCur, -1, iRowidReg);
8146f82e85aSdrh     VdbeComment((v, "pk"));
8156f82e85aSdrh     pLevel->op = OP_Noop;
8166f82e85aSdrh   }else if( (pLoop->wsFlags & WHERE_IPK)!=0
8176f82e85aSdrh          && (pLoop->wsFlags & WHERE_COLUMN_RANGE)!=0
8186f82e85aSdrh   ){
8196f82e85aSdrh     /* Case 3:  We have an inequality comparison against the ROWID field.
8206f82e85aSdrh     */
8216f82e85aSdrh     int testOp = OP_Noop;
8226f82e85aSdrh     int start;
8236f82e85aSdrh     int memEndValue = 0;
8246f82e85aSdrh     WhereTerm *pStart, *pEnd;
8256f82e85aSdrh 
8266f82e85aSdrh     assert( omitTable==0 );
8276f82e85aSdrh     j = 0;
8286f82e85aSdrh     pStart = pEnd = 0;
8296f82e85aSdrh     if( pLoop->wsFlags & WHERE_BTM_LIMIT ) pStart = pLoop->aLTerm[j++];
8306f82e85aSdrh     if( pLoop->wsFlags & WHERE_TOP_LIMIT ) pEnd = pLoop->aLTerm[j++];
8316f82e85aSdrh     assert( pStart!=0 || pEnd!=0 );
8326f82e85aSdrh     if( bRev ){
8336f82e85aSdrh       pTerm = pStart;
8346f82e85aSdrh       pStart = pEnd;
8356f82e85aSdrh       pEnd = pTerm;
8366f82e85aSdrh     }
837bec2476aSdrh     codeCursorHint(pWInfo, iLevel);
8386f82e85aSdrh     if( pStart ){
8396f82e85aSdrh       Expr *pX;             /* The expression that defines the start bound */
8406f82e85aSdrh       int r1, rTemp;        /* Registers for holding the start boundary */
8416f82e85aSdrh 
8426f82e85aSdrh       /* The following constant maps TK_xx codes into corresponding
8436f82e85aSdrh       ** seek opcodes.  It depends on a particular ordering of TK_xx
8446f82e85aSdrh       */
8456f82e85aSdrh       const u8 aMoveOp[] = {
8466f82e85aSdrh            /* TK_GT */  OP_SeekGT,
8476f82e85aSdrh            /* TK_LE */  OP_SeekLE,
8486f82e85aSdrh            /* TK_LT */  OP_SeekLT,
8496f82e85aSdrh            /* TK_GE */  OP_SeekGE
8506f82e85aSdrh       };
8516f82e85aSdrh       assert( TK_LE==TK_GT+1 );      /* Make sure the ordering.. */
8526f82e85aSdrh       assert( TK_LT==TK_GT+2 );      /*  ... of the TK_xx values... */
8536f82e85aSdrh       assert( TK_GE==TK_GT+3 );      /*  ... is correcct. */
8546f82e85aSdrh 
8556f82e85aSdrh       assert( (pStart->wtFlags & TERM_VNULL)==0 );
8566f82e85aSdrh       testcase( pStart->wtFlags & TERM_VIRTUAL );
8576f82e85aSdrh       pX = pStart->pExpr;
8586f82e85aSdrh       assert( pX!=0 );
8596f82e85aSdrh       testcase( pStart->leftCursor!=iCur ); /* transitive constraints */
8606f82e85aSdrh       r1 = sqlite3ExprCodeTemp(pParse, pX->pRight, &rTemp);
8616f82e85aSdrh       sqlite3VdbeAddOp3(v, aMoveOp[pX->op-TK_GT], iCur, addrBrk, r1);
8626f82e85aSdrh       VdbeComment((v, "pk"));
8636f82e85aSdrh       VdbeCoverageIf(v, pX->op==TK_GT);
8646f82e85aSdrh       VdbeCoverageIf(v, pX->op==TK_LE);
8656f82e85aSdrh       VdbeCoverageIf(v, pX->op==TK_LT);
8666f82e85aSdrh       VdbeCoverageIf(v, pX->op==TK_GE);
8676f82e85aSdrh       sqlite3ExprCacheAffinityChange(pParse, r1, 1);
8686f82e85aSdrh       sqlite3ReleaseTempReg(pParse, rTemp);
8696f82e85aSdrh       disableTerm(pLevel, pStart);
8706f82e85aSdrh     }else{
8716f82e85aSdrh       sqlite3VdbeAddOp2(v, bRev ? OP_Last : OP_Rewind, iCur, addrBrk);
8726f82e85aSdrh       VdbeCoverageIf(v, bRev==0);
8736f82e85aSdrh       VdbeCoverageIf(v, bRev!=0);
8746f82e85aSdrh     }
8756f82e85aSdrh     if( pEnd ){
8766f82e85aSdrh       Expr *pX;
8776f82e85aSdrh       pX = pEnd->pExpr;
8786f82e85aSdrh       assert( pX!=0 );
8796f82e85aSdrh       assert( (pEnd->wtFlags & TERM_VNULL)==0 );
8806f82e85aSdrh       testcase( pEnd->leftCursor!=iCur ); /* Transitive constraints */
8816f82e85aSdrh       testcase( pEnd->wtFlags & TERM_VIRTUAL );
8826f82e85aSdrh       memEndValue = ++pParse->nMem;
8836f82e85aSdrh       sqlite3ExprCode(pParse, pX->pRight, memEndValue);
8846f82e85aSdrh       if( pX->op==TK_LT || pX->op==TK_GT ){
8856f82e85aSdrh         testOp = bRev ? OP_Le : OP_Ge;
8866f82e85aSdrh       }else{
8876f82e85aSdrh         testOp = bRev ? OP_Lt : OP_Gt;
8886f82e85aSdrh       }
8896f82e85aSdrh       disableTerm(pLevel, pEnd);
8906f82e85aSdrh     }
8916f82e85aSdrh     start = sqlite3VdbeCurrentAddr(v);
8926f82e85aSdrh     pLevel->op = bRev ? OP_Prev : OP_Next;
8936f82e85aSdrh     pLevel->p1 = iCur;
8946f82e85aSdrh     pLevel->p2 = start;
8956f82e85aSdrh     assert( pLevel->p5==0 );
8966f82e85aSdrh     if( testOp!=OP_Noop ){
8976f82e85aSdrh       iRowidReg = ++pParse->nMem;
8986f82e85aSdrh       sqlite3VdbeAddOp2(v, OP_Rowid, iCur, iRowidReg);
8996f82e85aSdrh       sqlite3ExprCacheStore(pParse, iCur, -1, iRowidReg);
9006f82e85aSdrh       sqlite3VdbeAddOp3(v, testOp, memEndValue, addrBrk, iRowidReg);
9016f82e85aSdrh       VdbeCoverageIf(v, testOp==OP_Le);
9026f82e85aSdrh       VdbeCoverageIf(v, testOp==OP_Lt);
9036f82e85aSdrh       VdbeCoverageIf(v, testOp==OP_Ge);
9046f82e85aSdrh       VdbeCoverageIf(v, testOp==OP_Gt);
9056f82e85aSdrh       sqlite3VdbeChangeP5(v, SQLITE_AFF_NUMERIC | SQLITE_JUMPIFNULL);
9066f82e85aSdrh     }
9076f82e85aSdrh   }else if( pLoop->wsFlags & WHERE_INDEXED ){
9086f82e85aSdrh     /* Case 4: A scan using an index.
9096f82e85aSdrh     **
9106f82e85aSdrh     **         The WHERE clause may contain zero or more equality
9116f82e85aSdrh     **         terms ("==" or "IN" operators) that refer to the N
9126f82e85aSdrh     **         left-most columns of the index. It may also contain
9136f82e85aSdrh     **         inequality constraints (>, <, >= or <=) on the indexed
9146f82e85aSdrh     **         column that immediately follows the N equalities. Only
9156f82e85aSdrh     **         the right-most column can be an inequality - the rest must
9166f82e85aSdrh     **         use the "==" and "IN" operators. For example, if the
9176f82e85aSdrh     **         index is on (x,y,z), then the following clauses are all
9186f82e85aSdrh     **         optimized:
9196f82e85aSdrh     **
9206f82e85aSdrh     **            x=5
9216f82e85aSdrh     **            x=5 AND y=10
9226f82e85aSdrh     **            x=5 AND y<10
9236f82e85aSdrh     **            x=5 AND y>5 AND y<10
9246f82e85aSdrh     **            x=5 AND y=5 AND z<=10
9256f82e85aSdrh     **
9266f82e85aSdrh     **         The z<10 term of the following cannot be used, only
9276f82e85aSdrh     **         the x=5 term:
9286f82e85aSdrh     **
9296f82e85aSdrh     **            x=5 AND z<10
9306f82e85aSdrh     **
9316f82e85aSdrh     **         N may be zero if there are inequality constraints.
9326f82e85aSdrh     **         If there are no inequality constraints, then N is at
9336f82e85aSdrh     **         least one.
9346f82e85aSdrh     **
9356f82e85aSdrh     **         This case is also used when there are no WHERE clause
9366f82e85aSdrh     **         constraints but an index is selected anyway, in order
9376f82e85aSdrh     **         to force the output order to conform to an ORDER BY.
9386f82e85aSdrh     */
9396f82e85aSdrh     static const u8 aStartOp[] = {
9406f82e85aSdrh       0,
9416f82e85aSdrh       0,
9426f82e85aSdrh       OP_Rewind,           /* 2: (!start_constraints && startEq &&  !bRev) */
9436f82e85aSdrh       OP_Last,             /* 3: (!start_constraints && startEq &&   bRev) */
9446f82e85aSdrh       OP_SeekGT,           /* 4: (start_constraints  && !startEq && !bRev) */
9456f82e85aSdrh       OP_SeekLT,           /* 5: (start_constraints  && !startEq &&  bRev) */
9466f82e85aSdrh       OP_SeekGE,           /* 6: (start_constraints  &&  startEq && !bRev) */
9476f82e85aSdrh       OP_SeekLE            /* 7: (start_constraints  &&  startEq &&  bRev) */
9486f82e85aSdrh     };
9496f82e85aSdrh     static const u8 aEndOp[] = {
9506f82e85aSdrh       OP_IdxGE,            /* 0: (end_constraints && !bRev && !endEq) */
9516f82e85aSdrh       OP_IdxGT,            /* 1: (end_constraints && !bRev &&  endEq) */
9526f82e85aSdrh       OP_IdxLE,            /* 2: (end_constraints &&  bRev && !endEq) */
9536f82e85aSdrh       OP_IdxLT,            /* 3: (end_constraints &&  bRev &&  endEq) */
9546f82e85aSdrh     };
9556f82e85aSdrh     u16 nEq = pLoop->u.btree.nEq;     /* Number of == or IN terms */
9566f82e85aSdrh     int regBase;                 /* Base register holding constraint values */
9576f82e85aSdrh     WhereTerm *pRangeStart = 0;  /* Inequality constraint at range start */
9586f82e85aSdrh     WhereTerm *pRangeEnd = 0;    /* Inequality constraint at range end */
9596f82e85aSdrh     int startEq;                 /* True if range start uses ==, >= or <= */
9606f82e85aSdrh     int endEq;                   /* True if range end uses ==, >= or <= */
9616f82e85aSdrh     int start_constraints;       /* Start of range is constrained */
9626f82e85aSdrh     int nConstraint;             /* Number of constraint terms */
9636f82e85aSdrh     Index *pIdx;                 /* The index we will be using */
9646f82e85aSdrh     int iIdxCur;                 /* The VDBE cursor for the index */
9656f82e85aSdrh     int nExtraReg = 0;           /* Number of extra registers needed */
9666f82e85aSdrh     int op;                      /* Instruction opcode */
9676f82e85aSdrh     char *zStartAff;             /* Affinity for start of range constraint */
9686f82e85aSdrh     char cEndAff = 0;            /* Affinity for end of range constraint */
9696f82e85aSdrh     u8 bSeekPastNull = 0;        /* True to seek past initial nulls */
9706f82e85aSdrh     u8 bStopAtNull = 0;          /* Add condition to terminate at NULLs */
9716f82e85aSdrh 
9726f82e85aSdrh     pIdx = pLoop->u.btree.pIndex;
9736f82e85aSdrh     iIdxCur = pLevel->iIdxCur;
9746f82e85aSdrh     assert( nEq>=pLoop->nSkip );
9756f82e85aSdrh 
9766f82e85aSdrh     /* If this loop satisfies a sort order (pOrderBy) request that
9776f82e85aSdrh     ** was passed to this function to implement a "SELECT min(x) ..."
9786f82e85aSdrh     ** query, then the caller will only allow the loop to run for
9796f82e85aSdrh     ** a single iteration. This means that the first row returned
9806f82e85aSdrh     ** should not have a NULL value stored in 'x'. If column 'x' is
9816f82e85aSdrh     ** the first one after the nEq equality constraints in the index,
9826f82e85aSdrh     ** this requires some special handling.
9836f82e85aSdrh     */
9846f82e85aSdrh     assert( pWInfo->pOrderBy==0
9856f82e85aSdrh          || pWInfo->pOrderBy->nExpr==1
9866f82e85aSdrh          || (pWInfo->wctrlFlags&WHERE_ORDERBY_MIN)==0 );
9876f82e85aSdrh     if( (pWInfo->wctrlFlags&WHERE_ORDERBY_MIN)!=0
9886f82e85aSdrh      && pWInfo->nOBSat>0
9896f82e85aSdrh      && (pIdx->nKeyCol>nEq)
9906f82e85aSdrh     ){
9916f82e85aSdrh       assert( pLoop->nSkip==0 );
9926f82e85aSdrh       bSeekPastNull = 1;
9936f82e85aSdrh       nExtraReg = 1;
9946f82e85aSdrh     }
9956f82e85aSdrh 
9966f82e85aSdrh     /* Find any inequality constraint terms for the start and end
9976f82e85aSdrh     ** of the range.
9986f82e85aSdrh     */
9996f82e85aSdrh     j = nEq;
10006f82e85aSdrh     if( pLoop->wsFlags & WHERE_BTM_LIMIT ){
10016f82e85aSdrh       pRangeStart = pLoop->aLTerm[j++];
10026f82e85aSdrh       nExtraReg = 1;
10036f82e85aSdrh       /* Like optimization range constraints always occur in pairs */
10046f82e85aSdrh       assert( (pRangeStart->wtFlags & TERM_LIKEOPT)==0 ||
10056f82e85aSdrh               (pLoop->wsFlags & WHERE_TOP_LIMIT)!=0 );
10066f82e85aSdrh     }
10076f82e85aSdrh     if( pLoop->wsFlags & WHERE_TOP_LIMIT ){
10086f82e85aSdrh       pRangeEnd = pLoop->aLTerm[j++];
10096f82e85aSdrh       nExtraReg = 1;
10106f82e85aSdrh       if( (pRangeEnd->wtFlags & TERM_LIKEOPT)!=0 ){
10116f82e85aSdrh         assert( pRangeStart!=0 );                     /* LIKE opt constraints */
10126f82e85aSdrh         assert( pRangeStart->wtFlags & TERM_LIKEOPT );   /* occur in pairs */
10136f82e85aSdrh         pLevel->iLikeRepCntr = ++pParse->nMem;
10146f82e85aSdrh         testcase( bRev );
10156f82e85aSdrh         testcase( pIdx->aSortOrder[nEq]==SQLITE_SO_DESC );
10166f82e85aSdrh         sqlite3VdbeAddOp2(v, OP_Integer,
10176f82e85aSdrh                           bRev ^ (pIdx->aSortOrder[nEq]==SQLITE_SO_DESC),
10186f82e85aSdrh                           pLevel->iLikeRepCntr);
10196f82e85aSdrh         VdbeComment((v, "LIKE loop counter"));
10206f82e85aSdrh         pLevel->addrLikeRep = sqlite3VdbeCurrentAddr(v);
10216f82e85aSdrh       }
10226f82e85aSdrh       if( pRangeStart==0
10236f82e85aSdrh        && (j = pIdx->aiColumn[nEq])>=0
10246f82e85aSdrh        && pIdx->pTable->aCol[j].notNull==0
10256f82e85aSdrh       ){
10266f82e85aSdrh         bSeekPastNull = 1;
10276f82e85aSdrh       }
10286f82e85aSdrh     }
10296f82e85aSdrh     assert( pRangeEnd==0 || (pRangeEnd->wtFlags & TERM_VNULL)==0 );
10306f82e85aSdrh 
10316f82e85aSdrh     /* Generate code to evaluate all constraint terms using == or IN
10326f82e85aSdrh     ** and store the values of those terms in an array of registers
10336f82e85aSdrh     ** starting at regBase.
10346f82e85aSdrh     */
10356f82e85aSdrh     regBase = codeAllEqualityTerms(pParse,pLevel,bRev,nExtraReg,&zStartAff);
10366f82e85aSdrh     assert( zStartAff==0 || sqlite3Strlen30(zStartAff)>=nEq );
10376f82e85aSdrh     if( zStartAff ) cEndAff = zStartAff[nEq];
10386f82e85aSdrh     addrNxt = pLevel->addrNxt;
10396f82e85aSdrh 
10406f82e85aSdrh     /* If we are doing a reverse order scan on an ascending index, or
10416f82e85aSdrh     ** a forward order scan on a descending index, interchange the
10426f82e85aSdrh     ** start and end terms (pRangeStart and pRangeEnd).
10436f82e85aSdrh     */
10446f82e85aSdrh     if( (nEq<pIdx->nKeyCol && bRev==(pIdx->aSortOrder[nEq]==SQLITE_SO_ASC))
10456f82e85aSdrh      || (bRev && pIdx->nKeyCol==nEq)
10466f82e85aSdrh     ){
10476f82e85aSdrh       SWAP(WhereTerm *, pRangeEnd, pRangeStart);
10486f82e85aSdrh       SWAP(u8, bSeekPastNull, bStopAtNull);
10496f82e85aSdrh     }
10506f82e85aSdrh 
10516f82e85aSdrh     testcase( pRangeStart && (pRangeStart->eOperator & WO_LE)!=0 );
10526f82e85aSdrh     testcase( pRangeStart && (pRangeStart->eOperator & WO_GE)!=0 );
10536f82e85aSdrh     testcase( pRangeEnd && (pRangeEnd->eOperator & WO_LE)!=0 );
10546f82e85aSdrh     testcase( pRangeEnd && (pRangeEnd->eOperator & WO_GE)!=0 );
10556f82e85aSdrh     startEq = !pRangeStart || pRangeStart->eOperator & (WO_LE|WO_GE);
10566f82e85aSdrh     endEq =   !pRangeEnd || pRangeEnd->eOperator & (WO_LE|WO_GE);
10576f82e85aSdrh     start_constraints = pRangeStart || nEq>0;
10586f82e85aSdrh 
10596f82e85aSdrh     /* Seek the index cursor to the start of the range. */
1060bec2476aSdrh     codeCursorHint(pWInfo, iLevel);
10616f82e85aSdrh     nConstraint = nEq;
10626f82e85aSdrh     if( pRangeStart ){
10636f82e85aSdrh       Expr *pRight = pRangeStart->pExpr->pRight;
10646f82e85aSdrh       sqlite3ExprCode(pParse, pRight, regBase+nEq);
10656f82e85aSdrh       whereLikeOptimizationStringFixup(v, pLevel, pRangeStart);
10666f82e85aSdrh       if( (pRangeStart->wtFlags & TERM_VNULL)==0
10676f82e85aSdrh        && sqlite3ExprCanBeNull(pRight)
10686f82e85aSdrh       ){
10696f82e85aSdrh         sqlite3VdbeAddOp2(v, OP_IsNull, regBase+nEq, addrNxt);
10706f82e85aSdrh         VdbeCoverage(v);
10716f82e85aSdrh       }
10726f82e85aSdrh       if( zStartAff ){
10736f82e85aSdrh         if( sqlite3CompareAffinity(pRight, zStartAff[nEq])==SQLITE_AFF_BLOB){
10746f82e85aSdrh           /* Since the comparison is to be performed with no conversions
10756f82e85aSdrh           ** applied to the operands, set the affinity to apply to pRight to
10766f82e85aSdrh           ** SQLITE_AFF_BLOB.  */
10776f82e85aSdrh           zStartAff[nEq] = SQLITE_AFF_BLOB;
10786f82e85aSdrh         }
10796f82e85aSdrh         if( sqlite3ExprNeedsNoAffinityChange(pRight, zStartAff[nEq]) ){
10806f82e85aSdrh           zStartAff[nEq] = SQLITE_AFF_BLOB;
10816f82e85aSdrh         }
10826f82e85aSdrh       }
10836f82e85aSdrh       nConstraint++;
10846f82e85aSdrh       testcase( pRangeStart->wtFlags & TERM_VIRTUAL );
10856f82e85aSdrh     }else if( bSeekPastNull ){
10866f82e85aSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, regBase+nEq);
10876f82e85aSdrh       nConstraint++;
10886f82e85aSdrh       startEq = 0;
10896f82e85aSdrh       start_constraints = 1;
10906f82e85aSdrh     }
10916f82e85aSdrh     codeApplyAffinity(pParse, regBase, nConstraint - bSeekPastNull, zStartAff);
10926f82e85aSdrh     op = aStartOp[(start_constraints<<2) + (startEq<<1) + bRev];
10936f82e85aSdrh     assert( op!=0 );
10946f82e85aSdrh     sqlite3VdbeAddOp4Int(v, op, iIdxCur, addrNxt, regBase, nConstraint);
10956f82e85aSdrh     VdbeCoverage(v);
10966f82e85aSdrh     VdbeCoverageIf(v, op==OP_Rewind);  testcase( op==OP_Rewind );
10976f82e85aSdrh     VdbeCoverageIf(v, op==OP_Last);    testcase( op==OP_Last );
10986f82e85aSdrh     VdbeCoverageIf(v, op==OP_SeekGT);  testcase( op==OP_SeekGT );
10996f82e85aSdrh     VdbeCoverageIf(v, op==OP_SeekGE);  testcase( op==OP_SeekGE );
11006f82e85aSdrh     VdbeCoverageIf(v, op==OP_SeekLE);  testcase( op==OP_SeekLE );
11016f82e85aSdrh     VdbeCoverageIf(v, op==OP_SeekLT);  testcase( op==OP_SeekLT );
11026f82e85aSdrh 
11036f82e85aSdrh     /* Load the value for the inequality constraint at the end of the
11046f82e85aSdrh     ** range (if any).
11056f82e85aSdrh     */
11066f82e85aSdrh     nConstraint = nEq;
11076f82e85aSdrh     if( pRangeEnd ){
11086f82e85aSdrh       Expr *pRight = pRangeEnd->pExpr->pRight;
11096f82e85aSdrh       sqlite3ExprCacheRemove(pParse, regBase+nEq, 1);
11106f82e85aSdrh       sqlite3ExprCode(pParse, pRight, regBase+nEq);
11116f82e85aSdrh       whereLikeOptimizationStringFixup(v, pLevel, pRangeEnd);
11126f82e85aSdrh       if( (pRangeEnd->wtFlags & TERM_VNULL)==0
11136f82e85aSdrh        && sqlite3ExprCanBeNull(pRight)
11146f82e85aSdrh       ){
11156f82e85aSdrh         sqlite3VdbeAddOp2(v, OP_IsNull, regBase+nEq, addrNxt);
11166f82e85aSdrh         VdbeCoverage(v);
11176f82e85aSdrh       }
11186f82e85aSdrh       if( sqlite3CompareAffinity(pRight, cEndAff)!=SQLITE_AFF_BLOB
11196f82e85aSdrh        && !sqlite3ExprNeedsNoAffinityChange(pRight, cEndAff)
11206f82e85aSdrh       ){
11216f82e85aSdrh         codeApplyAffinity(pParse, regBase+nEq, 1, &cEndAff);
11226f82e85aSdrh       }
11236f82e85aSdrh       nConstraint++;
11246f82e85aSdrh       testcase( pRangeEnd->wtFlags & TERM_VIRTUAL );
11256f82e85aSdrh     }else if( bStopAtNull ){
11266f82e85aSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, regBase+nEq);
11276f82e85aSdrh       endEq = 0;
11286f82e85aSdrh       nConstraint++;
11296f82e85aSdrh     }
11306f82e85aSdrh     sqlite3DbFree(db, zStartAff);
11316f82e85aSdrh 
11326f82e85aSdrh     /* Top of the loop body */
11336f82e85aSdrh     pLevel->p2 = sqlite3VdbeCurrentAddr(v);
11346f82e85aSdrh 
11356f82e85aSdrh     /* Check if the index cursor is past the end of the range. */
11366f82e85aSdrh     if( nConstraint ){
11376f82e85aSdrh       op = aEndOp[bRev*2 + endEq];
11386f82e85aSdrh       sqlite3VdbeAddOp4Int(v, op, iIdxCur, addrNxt, regBase, nConstraint);
11396f82e85aSdrh       testcase( op==OP_IdxGT );  VdbeCoverageIf(v, op==OP_IdxGT );
11406f82e85aSdrh       testcase( op==OP_IdxGE );  VdbeCoverageIf(v, op==OP_IdxGE );
11416f82e85aSdrh       testcase( op==OP_IdxLT );  VdbeCoverageIf(v, op==OP_IdxLT );
11426f82e85aSdrh       testcase( op==OP_IdxLE );  VdbeCoverageIf(v, op==OP_IdxLE );
11436f82e85aSdrh     }
11446f82e85aSdrh 
11456f82e85aSdrh     /* Seek the table cursor, if required */
11466f82e85aSdrh     disableTerm(pLevel, pRangeStart);
11476f82e85aSdrh     disableTerm(pLevel, pRangeEnd);
11486f82e85aSdrh     if( omitTable ){
11496f82e85aSdrh       /* pIdx is a covering index.  No need to access the main table. */
11506f82e85aSdrh     }else if( HasRowid(pIdx->pTable) ){
11516f82e85aSdrh       iRowidReg = ++pParse->nMem;
11526f82e85aSdrh       sqlite3VdbeAddOp2(v, OP_IdxRowid, iIdxCur, iRowidReg);
11536f82e85aSdrh       sqlite3ExprCacheStore(pParse, iCur, -1, iRowidReg);
11546f82e85aSdrh       sqlite3VdbeAddOp2(v, OP_Seek, iCur, iRowidReg);  /* Deferred seek */
11556f82e85aSdrh     }else if( iCur!=iIdxCur ){
11566f82e85aSdrh       Index *pPk = sqlite3PrimaryKeyIndex(pIdx->pTable);
11576f82e85aSdrh       iRowidReg = sqlite3GetTempRange(pParse, pPk->nKeyCol);
11586f82e85aSdrh       for(j=0; j<pPk->nKeyCol; j++){
11596f82e85aSdrh         k = sqlite3ColumnOfIndex(pIdx, pPk->aiColumn[j]);
11606f82e85aSdrh         sqlite3VdbeAddOp3(v, OP_Column, iIdxCur, k, iRowidReg+j);
11616f82e85aSdrh       }
11626f82e85aSdrh       sqlite3VdbeAddOp4Int(v, OP_NotFound, iCur, addrCont,
11636f82e85aSdrh                            iRowidReg, pPk->nKeyCol); VdbeCoverage(v);
11646f82e85aSdrh     }
11656f82e85aSdrh 
11666f82e85aSdrh     /* Record the instruction used to terminate the loop. Disable
11676f82e85aSdrh     ** WHERE clause terms made redundant by the index range scan.
11686f82e85aSdrh     */
11696f82e85aSdrh     if( pLoop->wsFlags & WHERE_ONEROW ){
11706f82e85aSdrh       pLevel->op = OP_Noop;
11716f82e85aSdrh     }else if( bRev ){
11726f82e85aSdrh       pLevel->op = OP_Prev;
11736f82e85aSdrh     }else{
11746f82e85aSdrh       pLevel->op = OP_Next;
11756f82e85aSdrh     }
11766f82e85aSdrh     pLevel->p1 = iIdxCur;
11776f82e85aSdrh     pLevel->p3 = (pLoop->wsFlags&WHERE_UNQ_WANTED)!=0 ? 1:0;
11786f82e85aSdrh     if( (pLoop->wsFlags & WHERE_CONSTRAINT)==0 ){
11796f82e85aSdrh       pLevel->p5 = SQLITE_STMTSTATUS_FULLSCAN_STEP;
11806f82e85aSdrh     }else{
11816f82e85aSdrh       assert( pLevel->p5==0 );
11826f82e85aSdrh     }
11836f82e85aSdrh   }else
11846f82e85aSdrh 
11856f82e85aSdrh #ifndef SQLITE_OMIT_OR_OPTIMIZATION
11866f82e85aSdrh   if( pLoop->wsFlags & WHERE_MULTI_OR ){
11876f82e85aSdrh     /* Case 5:  Two or more separately indexed terms connected by OR
11886f82e85aSdrh     **
11896f82e85aSdrh     ** Example:
11906f82e85aSdrh     **
11916f82e85aSdrh     **   CREATE TABLE t1(a,b,c,d);
11926f82e85aSdrh     **   CREATE INDEX i1 ON t1(a);
11936f82e85aSdrh     **   CREATE INDEX i2 ON t1(b);
11946f82e85aSdrh     **   CREATE INDEX i3 ON t1(c);
11956f82e85aSdrh     **
11966f82e85aSdrh     **   SELECT * FROM t1 WHERE a=5 OR b=7 OR (c=11 AND d=13)
11976f82e85aSdrh     **
11986f82e85aSdrh     ** In the example, there are three indexed terms connected by OR.
11996f82e85aSdrh     ** The top of the loop looks like this:
12006f82e85aSdrh     **
12016f82e85aSdrh     **          Null       1                # Zero the rowset in reg 1
12026f82e85aSdrh     **
12036f82e85aSdrh     ** Then, for each indexed term, the following. The arguments to
12046f82e85aSdrh     ** RowSetTest are such that the rowid of the current row is inserted
12056f82e85aSdrh     ** into the RowSet. If it is already present, control skips the
12066f82e85aSdrh     ** Gosub opcode and jumps straight to the code generated by WhereEnd().
12076f82e85aSdrh     **
12086f82e85aSdrh     **        sqlite3WhereBegin(<term>)
12096f82e85aSdrh     **          RowSetTest                  # Insert rowid into rowset
12106f82e85aSdrh     **          Gosub      2 A
12116f82e85aSdrh     **        sqlite3WhereEnd()
12126f82e85aSdrh     **
12136f82e85aSdrh     ** Following the above, code to terminate the loop. Label A, the target
12146f82e85aSdrh     ** of the Gosub above, jumps to the instruction right after the Goto.
12156f82e85aSdrh     **
12166f82e85aSdrh     **          Null       1                # Zero the rowset in reg 1
12176f82e85aSdrh     **          Goto       B                # The loop is finished.
12186f82e85aSdrh     **
12196f82e85aSdrh     **       A: <loop body>                 # Return data, whatever.
12206f82e85aSdrh     **
12216f82e85aSdrh     **          Return     2                # Jump back to the Gosub
12226f82e85aSdrh     **
12236f82e85aSdrh     **       B: <after the loop>
12246f82e85aSdrh     **
12256f82e85aSdrh     ** Added 2014-05-26: If the table is a WITHOUT ROWID table, then
12266f82e85aSdrh     ** use an ephemeral index instead of a RowSet to record the primary
12276f82e85aSdrh     ** keys of the rows we have already seen.
12286f82e85aSdrh     **
12296f82e85aSdrh     */
12306f82e85aSdrh     WhereClause *pOrWc;    /* The OR-clause broken out into subterms */
12316f82e85aSdrh     SrcList *pOrTab;       /* Shortened table list or OR-clause generation */
12326f82e85aSdrh     Index *pCov = 0;             /* Potential covering index (or NULL) */
12336f82e85aSdrh     int iCovCur = pParse->nTab++;  /* Cursor used for index scans (if any) */
12346f82e85aSdrh 
12356f82e85aSdrh     int regReturn = ++pParse->nMem;           /* Register used with OP_Gosub */
12366f82e85aSdrh     int regRowset = 0;                        /* Register for RowSet object */
12376f82e85aSdrh     int regRowid = 0;                         /* Register holding rowid */
12386f82e85aSdrh     int iLoopBody = sqlite3VdbeMakeLabel(v);  /* Start of loop body */
12396f82e85aSdrh     int iRetInit;                             /* Address of regReturn init */
12406f82e85aSdrh     int untestedTerms = 0;             /* Some terms not completely tested */
12416f82e85aSdrh     int ii;                            /* Loop counter */
12426f82e85aSdrh     u16 wctrlFlags;                    /* Flags for sub-WHERE clause */
12436f82e85aSdrh     Expr *pAndExpr = 0;                /* An ".. AND (...)" expression */
12446f82e85aSdrh     Table *pTab = pTabItem->pTab;
12456f82e85aSdrh 
12466f82e85aSdrh     pTerm = pLoop->aLTerm[0];
12476f82e85aSdrh     assert( pTerm!=0 );
12486f82e85aSdrh     assert( pTerm->eOperator & WO_OR );
12496f82e85aSdrh     assert( (pTerm->wtFlags & TERM_ORINFO)!=0 );
12506f82e85aSdrh     pOrWc = &pTerm->u.pOrInfo->wc;
12516f82e85aSdrh     pLevel->op = OP_Return;
12526f82e85aSdrh     pLevel->p1 = regReturn;
12536f82e85aSdrh 
12546f82e85aSdrh     /* Set up a new SrcList in pOrTab containing the table being scanned
12556f82e85aSdrh     ** by this loop in the a[0] slot and all notReady tables in a[1..] slots.
12566f82e85aSdrh     ** This becomes the SrcList in the recursive call to sqlite3WhereBegin().
12576f82e85aSdrh     */
12586f82e85aSdrh     if( pWInfo->nLevel>1 ){
12596f82e85aSdrh       int nNotReady;                 /* The number of notReady tables */
12606f82e85aSdrh       struct SrcList_item *origSrc;     /* Original list of tables */
12616f82e85aSdrh       nNotReady = pWInfo->nLevel - iLevel - 1;
12626f82e85aSdrh       pOrTab = sqlite3StackAllocRaw(db,
12636f82e85aSdrh                             sizeof(*pOrTab)+ nNotReady*sizeof(pOrTab->a[0]));
12646f82e85aSdrh       if( pOrTab==0 ) return notReady;
12656f82e85aSdrh       pOrTab->nAlloc = (u8)(nNotReady + 1);
12666f82e85aSdrh       pOrTab->nSrc = pOrTab->nAlloc;
12676f82e85aSdrh       memcpy(pOrTab->a, pTabItem, sizeof(*pTabItem));
12686f82e85aSdrh       origSrc = pWInfo->pTabList->a;
12696f82e85aSdrh       for(k=1; k<=nNotReady; k++){
12706f82e85aSdrh         memcpy(&pOrTab->a[k], &origSrc[pLevel[k].iFrom], sizeof(pOrTab->a[k]));
12716f82e85aSdrh       }
12726f82e85aSdrh     }else{
12736f82e85aSdrh       pOrTab = pWInfo->pTabList;
12746f82e85aSdrh     }
12756f82e85aSdrh 
12766f82e85aSdrh     /* Initialize the rowset register to contain NULL. An SQL NULL is
12776f82e85aSdrh     ** equivalent to an empty rowset.  Or, create an ephemeral index
12786f82e85aSdrh     ** capable of holding primary keys in the case of a WITHOUT ROWID.
12796f82e85aSdrh     **
12806f82e85aSdrh     ** Also initialize regReturn to contain the address of the instruction
12816f82e85aSdrh     ** immediately following the OP_Return at the bottom of the loop. This
12826f82e85aSdrh     ** is required in a few obscure LEFT JOIN cases where control jumps
12836f82e85aSdrh     ** over the top of the loop into the body of it. In this case the
12846f82e85aSdrh     ** correct response for the end-of-loop code (the OP_Return) is to
12856f82e85aSdrh     ** fall through to the next instruction, just as an OP_Next does if
12866f82e85aSdrh     ** called on an uninitialized cursor.
12876f82e85aSdrh     */
12886f82e85aSdrh     if( (pWInfo->wctrlFlags & WHERE_DUPLICATES_OK)==0 ){
12896f82e85aSdrh       if( HasRowid(pTab) ){
12906f82e85aSdrh         regRowset = ++pParse->nMem;
12916f82e85aSdrh         sqlite3VdbeAddOp2(v, OP_Null, 0, regRowset);
12926f82e85aSdrh       }else{
12936f82e85aSdrh         Index *pPk = sqlite3PrimaryKeyIndex(pTab);
12946f82e85aSdrh         regRowset = pParse->nTab++;
12956f82e85aSdrh         sqlite3VdbeAddOp2(v, OP_OpenEphemeral, regRowset, pPk->nKeyCol);
12966f82e85aSdrh         sqlite3VdbeSetP4KeyInfo(pParse, pPk);
12976f82e85aSdrh       }
12986f82e85aSdrh       regRowid = ++pParse->nMem;
12996f82e85aSdrh     }
13006f82e85aSdrh     iRetInit = sqlite3VdbeAddOp2(v, OP_Integer, 0, regReturn);
13016f82e85aSdrh 
13026f82e85aSdrh     /* If the original WHERE clause is z of the form:  (x1 OR x2 OR ...) AND y
13036f82e85aSdrh     ** Then for every term xN, evaluate as the subexpression: xN AND z
13046f82e85aSdrh     ** That way, terms in y that are factored into the disjunction will
13056f82e85aSdrh     ** be picked up by the recursive calls to sqlite3WhereBegin() below.
13066f82e85aSdrh     **
13076f82e85aSdrh     ** Actually, each subexpression is converted to "xN AND w" where w is
13086f82e85aSdrh     ** the "interesting" terms of z - terms that did not originate in the
13096f82e85aSdrh     ** ON or USING clause of a LEFT JOIN, and terms that are usable as
13106f82e85aSdrh     ** indices.
13116f82e85aSdrh     **
13126f82e85aSdrh     ** This optimization also only applies if the (x1 OR x2 OR ...) term
13136f82e85aSdrh     ** is not contained in the ON clause of a LEFT JOIN.
13146f82e85aSdrh     ** See ticket http://www.sqlite.org/src/info/f2369304e4
13156f82e85aSdrh     */
13166f82e85aSdrh     if( pWC->nTerm>1 ){
13176f82e85aSdrh       int iTerm;
13186f82e85aSdrh       for(iTerm=0; iTerm<pWC->nTerm; iTerm++){
13196f82e85aSdrh         Expr *pExpr = pWC->a[iTerm].pExpr;
13206f82e85aSdrh         if( &pWC->a[iTerm] == pTerm ) continue;
13216f82e85aSdrh         if( ExprHasProperty(pExpr, EP_FromJoin) ) continue;
13226f82e85aSdrh         if( (pWC->a[iTerm].wtFlags & TERM_VIRTUAL)!=0 ) continue;
13236f82e85aSdrh         if( (pWC->a[iTerm].eOperator & WO_ALL)==0 ) continue;
13246f82e85aSdrh         testcase( pWC->a[iTerm].wtFlags & TERM_ORINFO );
13256f82e85aSdrh         pExpr = sqlite3ExprDup(db, pExpr, 0);
13266f82e85aSdrh         pAndExpr = sqlite3ExprAnd(db, pAndExpr, pExpr);
13276f82e85aSdrh       }
13286f82e85aSdrh       if( pAndExpr ){
13296f82e85aSdrh         pAndExpr = sqlite3PExpr(pParse, TK_AND, 0, pAndExpr, 0);
13306f82e85aSdrh       }
13316f82e85aSdrh     }
13326f82e85aSdrh 
13336f82e85aSdrh     /* Run a separate WHERE clause for each term of the OR clause.  After
13346f82e85aSdrh     ** eliminating duplicates from other WHERE clauses, the action for each
13356f82e85aSdrh     ** sub-WHERE clause is to to invoke the main loop body as a subroutine.
13366f82e85aSdrh     */
13376f82e85aSdrh     wctrlFlags =  WHERE_OMIT_OPEN_CLOSE
13386f82e85aSdrh                 | WHERE_FORCE_TABLE
13396f82e85aSdrh                 | WHERE_ONETABLE_ONLY
13406f82e85aSdrh                 | WHERE_NO_AUTOINDEX;
13416f82e85aSdrh     for(ii=0; ii<pOrWc->nTerm; ii++){
13426f82e85aSdrh       WhereTerm *pOrTerm = &pOrWc->a[ii];
13436f82e85aSdrh       if( pOrTerm->leftCursor==iCur || (pOrTerm->eOperator & WO_AND)!=0 ){
13446f82e85aSdrh         WhereInfo *pSubWInfo;           /* Info for single OR-term scan */
13456f82e85aSdrh         Expr *pOrExpr = pOrTerm->pExpr; /* Current OR clause term */
13466f82e85aSdrh         int j1 = 0;                     /* Address of jump operation */
13476f82e85aSdrh         if( pAndExpr && !ExprHasProperty(pOrExpr, EP_FromJoin) ){
13486f82e85aSdrh           pAndExpr->pLeft = pOrExpr;
13496f82e85aSdrh           pOrExpr = pAndExpr;
13506f82e85aSdrh         }
13516f82e85aSdrh         /* Loop through table entries that match term pOrTerm. */
13526f82e85aSdrh         WHERETRACE(0xffff, ("Subplan for OR-clause:\n"));
13536f82e85aSdrh         pSubWInfo = sqlite3WhereBegin(pParse, pOrTab, pOrExpr, 0, 0,
13546f82e85aSdrh                                       wctrlFlags, iCovCur);
13556f82e85aSdrh         assert( pSubWInfo || pParse->nErr || db->mallocFailed );
13566f82e85aSdrh         if( pSubWInfo ){
13576f82e85aSdrh           WhereLoop *pSubLoop;
13586f82e85aSdrh           int addrExplain = sqlite3WhereExplainOneScan(
13596f82e85aSdrh               pParse, pOrTab, &pSubWInfo->a[0], iLevel, pLevel->iFrom, 0
13606f82e85aSdrh           );
13616f82e85aSdrh           sqlite3WhereAddScanStatus(v, pOrTab, &pSubWInfo->a[0], addrExplain);
13626f82e85aSdrh 
13636f82e85aSdrh           /* This is the sub-WHERE clause body.  First skip over
13646f82e85aSdrh           ** duplicate rows from prior sub-WHERE clauses, and record the
13656f82e85aSdrh           ** rowid (or PRIMARY KEY) for the current row so that the same
13666f82e85aSdrh           ** row will be skipped in subsequent sub-WHERE clauses.
13676f82e85aSdrh           */
13686f82e85aSdrh           if( (pWInfo->wctrlFlags & WHERE_DUPLICATES_OK)==0 ){
13696f82e85aSdrh             int r;
13706f82e85aSdrh             int iSet = ((ii==pOrWc->nTerm-1)?-1:ii);
13716f82e85aSdrh             if( HasRowid(pTab) ){
13726f82e85aSdrh               r = sqlite3ExprCodeGetColumn(pParse, pTab, -1, iCur, regRowid, 0);
13736f82e85aSdrh               j1 = sqlite3VdbeAddOp4Int(v, OP_RowSetTest, regRowset, 0, r,iSet);
13746f82e85aSdrh               VdbeCoverage(v);
13756f82e85aSdrh             }else{
13766f82e85aSdrh               Index *pPk = sqlite3PrimaryKeyIndex(pTab);
13776f82e85aSdrh               int nPk = pPk->nKeyCol;
13786f82e85aSdrh               int iPk;
13796f82e85aSdrh 
13806f82e85aSdrh               /* Read the PK into an array of temp registers. */
13816f82e85aSdrh               r = sqlite3GetTempRange(pParse, nPk);
13826f82e85aSdrh               for(iPk=0; iPk<nPk; iPk++){
13836f82e85aSdrh                 int iCol = pPk->aiColumn[iPk];
1384*d3e3f0b4Sdrh                 int rx;
1385*d3e3f0b4Sdrh                 rx = sqlite3ExprCodeGetColumn(pParse, pTab, iCol, iCur,r+iPk,0);
1386*d3e3f0b4Sdrh                 if( rx!=r+iPk ){
1387*d3e3f0b4Sdrh                   sqlite3VdbeAddOp2(v, OP_SCopy, rx, r+iPk);
1388*d3e3f0b4Sdrh                 }
13896f82e85aSdrh               }
13906f82e85aSdrh 
13916f82e85aSdrh               /* Check if the temp table already contains this key. If so,
13926f82e85aSdrh               ** the row has already been included in the result set and
13936f82e85aSdrh               ** can be ignored (by jumping past the Gosub below). Otherwise,
13946f82e85aSdrh               ** insert the key into the temp table and proceed with processing
13956f82e85aSdrh               ** the row.
13966f82e85aSdrh               **
13976f82e85aSdrh               ** Use some of the same optimizations as OP_RowSetTest: If iSet
13986f82e85aSdrh               ** is zero, assume that the key cannot already be present in
13996f82e85aSdrh               ** the temp table. And if iSet is -1, assume that there is no
14006f82e85aSdrh               ** need to insert the key into the temp table, as it will never
14016f82e85aSdrh               ** be tested for.  */
14026f82e85aSdrh               if( iSet ){
14036f82e85aSdrh                 j1 = sqlite3VdbeAddOp4Int(v, OP_Found, regRowset, 0, r, nPk);
14046f82e85aSdrh                 VdbeCoverage(v);
14056f82e85aSdrh               }
14066f82e85aSdrh               if( iSet>=0 ){
14076f82e85aSdrh                 sqlite3VdbeAddOp3(v, OP_MakeRecord, r, nPk, regRowid);
14086f82e85aSdrh                 sqlite3VdbeAddOp3(v, OP_IdxInsert, regRowset, regRowid, 0);
14096f82e85aSdrh                 if( iSet ) sqlite3VdbeChangeP5(v, OPFLAG_USESEEKRESULT);
14106f82e85aSdrh               }
14116f82e85aSdrh 
14126f82e85aSdrh               /* Release the array of temp registers */
14136f82e85aSdrh               sqlite3ReleaseTempRange(pParse, r, nPk);
14146f82e85aSdrh             }
14156f82e85aSdrh           }
14166f82e85aSdrh 
14176f82e85aSdrh           /* Invoke the main loop body as a subroutine */
14186f82e85aSdrh           sqlite3VdbeAddOp2(v, OP_Gosub, regReturn, iLoopBody);
14196f82e85aSdrh 
14206f82e85aSdrh           /* Jump here (skipping the main loop body subroutine) if the
14216f82e85aSdrh           ** current sub-WHERE row is a duplicate from prior sub-WHEREs. */
14226f82e85aSdrh           if( j1 ) sqlite3VdbeJumpHere(v, j1);
14236f82e85aSdrh 
14246f82e85aSdrh           /* The pSubWInfo->untestedTerms flag means that this OR term
14256f82e85aSdrh           ** contained one or more AND term from a notReady table.  The
14266f82e85aSdrh           ** terms from the notReady table could not be tested and will
14276f82e85aSdrh           ** need to be tested later.
14286f82e85aSdrh           */
14296f82e85aSdrh           if( pSubWInfo->untestedTerms ) untestedTerms = 1;
14306f82e85aSdrh 
14316f82e85aSdrh           /* If all of the OR-connected terms are optimized using the same
14326f82e85aSdrh           ** index, and the index is opened using the same cursor number
14336f82e85aSdrh           ** by each call to sqlite3WhereBegin() made by this loop, it may
14346f82e85aSdrh           ** be possible to use that index as a covering index.
14356f82e85aSdrh           **
14366f82e85aSdrh           ** If the call to sqlite3WhereBegin() above resulted in a scan that
14376f82e85aSdrh           ** uses an index, and this is either the first OR-connected term
14386f82e85aSdrh           ** processed or the index is the same as that used by all previous
14396f82e85aSdrh           ** terms, set pCov to the candidate covering index. Otherwise, set
14406f82e85aSdrh           ** pCov to NULL to indicate that no candidate covering index will
14416f82e85aSdrh           ** be available.
14426f82e85aSdrh           */
14436f82e85aSdrh           pSubLoop = pSubWInfo->a[0].pWLoop;
14446f82e85aSdrh           assert( (pSubLoop->wsFlags & WHERE_AUTO_INDEX)==0 );
14456f82e85aSdrh           if( (pSubLoop->wsFlags & WHERE_INDEXED)!=0
14466f82e85aSdrh            && (ii==0 || pSubLoop->u.btree.pIndex==pCov)
14476f82e85aSdrh            && (HasRowid(pTab) || !IsPrimaryKeyIndex(pSubLoop->u.btree.pIndex))
14486f82e85aSdrh           ){
14496f82e85aSdrh             assert( pSubWInfo->a[0].iIdxCur==iCovCur );
14506f82e85aSdrh             pCov = pSubLoop->u.btree.pIndex;
14516f82e85aSdrh             wctrlFlags |= WHERE_REOPEN_IDX;
14526f82e85aSdrh           }else{
14536f82e85aSdrh             pCov = 0;
14546f82e85aSdrh           }
14556f82e85aSdrh 
14566f82e85aSdrh           /* Finish the loop through table entries that match term pOrTerm. */
14576f82e85aSdrh           sqlite3WhereEnd(pSubWInfo);
14586f82e85aSdrh         }
14596f82e85aSdrh       }
14606f82e85aSdrh     }
14616f82e85aSdrh     pLevel->u.pCovidx = pCov;
14626f82e85aSdrh     if( pCov ) pLevel->iIdxCur = iCovCur;
14636f82e85aSdrh     if( pAndExpr ){
14646f82e85aSdrh       pAndExpr->pLeft = 0;
14656f82e85aSdrh       sqlite3ExprDelete(db, pAndExpr);
14666f82e85aSdrh     }
14676f82e85aSdrh     sqlite3VdbeChangeP1(v, iRetInit, sqlite3VdbeCurrentAddr(v));
14686f82e85aSdrh     sqlite3VdbeAddOp2(v, OP_Goto, 0, pLevel->addrBrk);
14696f82e85aSdrh     sqlite3VdbeResolveLabel(v, iLoopBody);
14706f82e85aSdrh 
14716f82e85aSdrh     if( pWInfo->nLevel>1 ) sqlite3StackFree(db, pOrTab);
14726f82e85aSdrh     if( !untestedTerms ) disableTerm(pLevel, pTerm);
14736f82e85aSdrh   }else
14746f82e85aSdrh #endif /* SQLITE_OMIT_OR_OPTIMIZATION */
14756f82e85aSdrh 
14766f82e85aSdrh   {
14776f82e85aSdrh     /* Case 6:  There is no usable index.  We must do a complete
14786f82e85aSdrh     **          scan of the entire table.
14796f82e85aSdrh     */
14806f82e85aSdrh     static const u8 aStep[] = { OP_Next, OP_Prev };
14816f82e85aSdrh     static const u8 aStart[] = { OP_Rewind, OP_Last };
14826f82e85aSdrh     assert( bRev==0 || bRev==1 );
14836f82e85aSdrh     if( pTabItem->isRecursive ){
14846f82e85aSdrh       /* Tables marked isRecursive have only a single row that is stored in
14856f82e85aSdrh       ** a pseudo-cursor.  No need to Rewind or Next such cursors. */
14866f82e85aSdrh       pLevel->op = OP_Noop;
14876f82e85aSdrh     }else{
1488bec2476aSdrh       codeCursorHint(pWInfo, iLevel);
14896f82e85aSdrh       pLevel->op = aStep[bRev];
14906f82e85aSdrh       pLevel->p1 = iCur;
14916f82e85aSdrh       pLevel->p2 = 1 + sqlite3VdbeAddOp2(v, aStart[bRev], iCur, addrBrk);
14926f82e85aSdrh       VdbeCoverageIf(v, bRev==0);
14936f82e85aSdrh       VdbeCoverageIf(v, bRev!=0);
14946f82e85aSdrh       pLevel->p5 = SQLITE_STMTSTATUS_FULLSCAN_STEP;
14956f82e85aSdrh     }
14966f82e85aSdrh   }
14976f82e85aSdrh 
14986f82e85aSdrh #ifdef SQLITE_ENABLE_STMT_SCANSTATUS
14996f82e85aSdrh   pLevel->addrVisit = sqlite3VdbeCurrentAddr(v);
15006f82e85aSdrh #endif
15016f82e85aSdrh 
15026f82e85aSdrh   /* Insert code to test every subexpression that can be completely
15036f82e85aSdrh   ** computed using the current set of tables.
15046f82e85aSdrh   */
15056f82e85aSdrh   for(pTerm=pWC->a, j=pWC->nTerm; j>0; j--, pTerm++){
15066f82e85aSdrh     Expr *pE;
15076f82e85aSdrh     int skipLikeAddr = 0;
15086f82e85aSdrh     testcase( pTerm->wtFlags & TERM_VIRTUAL );
15096f82e85aSdrh     testcase( pTerm->wtFlags & TERM_CODED );
15106f82e85aSdrh     if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
15116f82e85aSdrh     if( (pTerm->prereqAll & pLevel->notReady)!=0 ){
15126f82e85aSdrh       testcase( pWInfo->untestedTerms==0
15136f82e85aSdrh                && (pWInfo->wctrlFlags & WHERE_ONETABLE_ONLY)!=0 );
15146f82e85aSdrh       pWInfo->untestedTerms = 1;
15156f82e85aSdrh       continue;
15166f82e85aSdrh     }
15176f82e85aSdrh     pE = pTerm->pExpr;
15186f82e85aSdrh     assert( pE!=0 );
15196f82e85aSdrh     if( pLevel->iLeftJoin && !ExprHasProperty(pE, EP_FromJoin) ){
15206f82e85aSdrh       continue;
15216f82e85aSdrh     }
15226f82e85aSdrh     if( pTerm->wtFlags & TERM_LIKECOND ){
15236f82e85aSdrh       assert( pLevel->iLikeRepCntr>0 );
15246f82e85aSdrh       skipLikeAddr = sqlite3VdbeAddOp1(v, OP_IfNot, pLevel->iLikeRepCntr);
15256f82e85aSdrh       VdbeCoverage(v);
15266f82e85aSdrh     }
15276f82e85aSdrh     sqlite3ExprIfFalse(pParse, pE, addrCont, SQLITE_JUMPIFNULL);
15286f82e85aSdrh     if( skipLikeAddr ) sqlite3VdbeJumpHere(v, skipLikeAddr);
15296f82e85aSdrh     pTerm->wtFlags |= TERM_CODED;
15306f82e85aSdrh   }
15316f82e85aSdrh 
15326f82e85aSdrh   /* Insert code to test for implied constraints based on transitivity
15336f82e85aSdrh   ** of the "==" operator.
15346f82e85aSdrh   **
15356f82e85aSdrh   ** Example: If the WHERE clause contains "t1.a=t2.b" and "t2.b=123"
15366f82e85aSdrh   ** and we are coding the t1 loop and the t2 loop has not yet coded,
15376f82e85aSdrh   ** then we cannot use the "t1.a=t2.b" constraint, but we can code
15386f82e85aSdrh   ** the implied "t1.a=123" constraint.
15396f82e85aSdrh   */
15406f82e85aSdrh   for(pTerm=pWC->a, j=pWC->nTerm; j>0; j--, pTerm++){
15416f82e85aSdrh     Expr *pE, *pEAlt;
15426f82e85aSdrh     WhereTerm *pAlt;
15436f82e85aSdrh     if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
15446f82e85aSdrh     if( (pTerm->eOperator & (WO_EQ|WO_IS))==0 ) continue;
15456f82e85aSdrh     if( (pTerm->eOperator & WO_EQUIV)==0 ) continue;
15466f82e85aSdrh     if( pTerm->leftCursor!=iCur ) continue;
15476f82e85aSdrh     if( pLevel->iLeftJoin ) continue;
15486f82e85aSdrh     pE = pTerm->pExpr;
15496f82e85aSdrh     assert( !ExprHasProperty(pE, EP_FromJoin) );
15506f82e85aSdrh     assert( (pTerm->prereqRight & pLevel->notReady)!=0 );
15516f82e85aSdrh     pAlt = sqlite3WhereFindTerm(pWC, iCur, pTerm->u.leftColumn, notReady,
15526f82e85aSdrh                     WO_EQ|WO_IN|WO_IS, 0);
15536f82e85aSdrh     if( pAlt==0 ) continue;
15546f82e85aSdrh     if( pAlt->wtFlags & (TERM_CODED) ) continue;
15556f82e85aSdrh     testcase( pAlt->eOperator & WO_EQ );
15566f82e85aSdrh     testcase( pAlt->eOperator & WO_IS );
15576f82e85aSdrh     testcase( pAlt->eOperator & WO_IN );
15586f82e85aSdrh     VdbeModuleComment((v, "begin transitive constraint"));
15596f82e85aSdrh     pEAlt = sqlite3StackAllocRaw(db, sizeof(*pEAlt));
15606f82e85aSdrh     if( pEAlt ){
15616f82e85aSdrh       *pEAlt = *pAlt->pExpr;
15626f82e85aSdrh       pEAlt->pLeft = pE->pLeft;
15636f82e85aSdrh       sqlite3ExprIfFalse(pParse, pEAlt, addrCont, SQLITE_JUMPIFNULL);
15646f82e85aSdrh       sqlite3StackFree(db, pEAlt);
15656f82e85aSdrh     }
15666f82e85aSdrh   }
15676f82e85aSdrh 
15686f82e85aSdrh   /* For a LEFT OUTER JOIN, generate code that will record the fact that
15696f82e85aSdrh   ** at least one row of the right table has matched the left table.
15706f82e85aSdrh   */
15716f82e85aSdrh   if( pLevel->iLeftJoin ){
15726f82e85aSdrh     pLevel->addrFirst = sqlite3VdbeCurrentAddr(v);
15736f82e85aSdrh     sqlite3VdbeAddOp2(v, OP_Integer, 1, pLevel->iLeftJoin);
15746f82e85aSdrh     VdbeComment((v, "record LEFT JOIN hit"));
15756f82e85aSdrh     sqlite3ExprCacheClear(pParse);
15766f82e85aSdrh     for(pTerm=pWC->a, j=0; j<pWC->nTerm; j++, pTerm++){
15776f82e85aSdrh       testcase( pTerm->wtFlags & TERM_VIRTUAL );
15786f82e85aSdrh       testcase( pTerm->wtFlags & TERM_CODED );
15796f82e85aSdrh       if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
15806f82e85aSdrh       if( (pTerm->prereqAll & pLevel->notReady)!=0 ){
15816f82e85aSdrh         assert( pWInfo->untestedTerms );
15826f82e85aSdrh         continue;
15836f82e85aSdrh       }
15846f82e85aSdrh       assert( pTerm->pExpr );
15856f82e85aSdrh       sqlite3ExprIfFalse(pParse, pTerm->pExpr, addrCont, SQLITE_JUMPIFNULL);
15866f82e85aSdrh       pTerm->wtFlags |= TERM_CODED;
15876f82e85aSdrh     }
15886f82e85aSdrh   }
15896f82e85aSdrh 
15906f82e85aSdrh   return pLevel->notReady;
15916f82e85aSdrh }
1592