xref: /sqlite-3.40.0/src/wherecode.c (revision 7348ca4e)
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";
32cf9d36d1Sdrh   return pIdx->pTable->aCol[i].zCnName;
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   {
1327601294aSdrh     SrcItem *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);
151a979993bSdrh     str.printfFlags = SQLITE_PRINTF_INTERNAL;
1522f2091b1Sdrh     sqlite3_str_appendf(&str, "%s %S", isSearch ? "SEARCH" : "SCAN", pItem);
1536f82e85aSdrh     if( (flags & (WHERE_IPK|WHERE_VIRTUALTABLE))==0 ){
1546f82e85aSdrh       const char *zFmt = 0;
1556f82e85aSdrh       Index *pIdx;
1566f82e85aSdrh 
1576f82e85aSdrh       assert( pLoop->u.btree.pIndex!=0 );
1586f82e85aSdrh       pIdx = pLoop->u.btree.pIndex;
1596f82e85aSdrh       assert( !(flags&WHERE_AUTO_INDEX) || (flags&WHERE_IDX_ONLY) );
1606f82e85aSdrh       if( !HasRowid(pItem->pTab) && IsPrimaryKeyIndex(pIdx) ){
1616f82e85aSdrh         if( isSearch ){
1626f82e85aSdrh           zFmt = "PRIMARY KEY";
1636f82e85aSdrh         }
1646f82e85aSdrh       }else if( flags & WHERE_PARTIALIDX ){
1656f82e85aSdrh         zFmt = "AUTOMATIC PARTIAL COVERING INDEX";
1666f82e85aSdrh       }else if( flags & WHERE_AUTO_INDEX ){
1676f82e85aSdrh         zFmt = "AUTOMATIC COVERING INDEX";
1686f82e85aSdrh       }else if( flags & WHERE_IDX_ONLY ){
1696f82e85aSdrh         zFmt = "COVERING INDEX %s";
1706f82e85aSdrh       }else{
1716f82e85aSdrh         zFmt = "INDEX %s";
1726f82e85aSdrh       }
1736f82e85aSdrh       if( zFmt ){
1740cdbe1aeSdrh         sqlite3_str_append(&str, " USING ", 7);
1750cdbe1aeSdrh         sqlite3_str_appendf(&str, zFmt, pIdx->zName);
1768faee877Sdrh         explainIndexRange(&str, pLoop);
1776f82e85aSdrh       }
1786f82e85aSdrh     }else if( (flags & WHERE_IPK)!=0 && (flags & WHERE_CONSTRAINT)!=0 ){
1793bd7cd73Sdrh       char cRangeOp;
1803bd7cd73Sdrh #if 0  /* Better output, but breaks many tests */
1813bd7cd73Sdrh       const Table *pTab = pItem->pTab;
1823bd7cd73Sdrh       const char *zRowid = pTab->iPKey>=0 ? pTab->aCol[pTab->iPKey].zCnName:
1833bd7cd73Sdrh                               "rowid";
1843bd7cd73Sdrh #else
1853bd7cd73Sdrh       const char *zRowid = "rowid";
1863bd7cd73Sdrh #endif
1873bd7cd73Sdrh       sqlite3_str_appendf(&str, " USING INTEGER PRIMARY KEY (%s", zRowid);
1886f82e85aSdrh       if( flags&(WHERE_COLUMN_EQ|WHERE_COLUMN_IN) ){
1893bd7cd73Sdrh         cRangeOp = '=';
1906f82e85aSdrh       }else if( (flags&WHERE_BOTH_LIMIT)==WHERE_BOTH_LIMIT ){
1913bd7cd73Sdrh         sqlite3_str_appendf(&str, ">? AND %s", zRowid);
1923bd7cd73Sdrh         cRangeOp = '<';
1936f82e85aSdrh       }else if( flags&WHERE_BTM_LIMIT ){
1943bd7cd73Sdrh         cRangeOp = '>';
1956f82e85aSdrh       }else{
1966f82e85aSdrh         assert( flags&WHERE_TOP_LIMIT);
1973bd7cd73Sdrh         cRangeOp = '<';
1986f82e85aSdrh       }
1993bd7cd73Sdrh       sqlite3_str_appendf(&str, "%c?)", cRangeOp);
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
207c583719bSdrh     if( pItem->fg.jointype & JT_LEFT ){
208c583719bSdrh       sqlite3_str_appendf(&str, " LEFT-JOIN");
209c583719bSdrh     }
2106f82e85aSdrh #ifdef SQLITE_EXPLAIN_ESTIMATED_ROWS
2116f82e85aSdrh     if( pLoop->nOut>=10 ){
2120cdbe1aeSdrh       sqlite3_str_appendf(&str, " (~%llu rows)",
2130cdbe1aeSdrh              sqlite3LogEstToInt(pLoop->nOut));
2146f82e85aSdrh     }else{
2150cdbe1aeSdrh       sqlite3_str_append(&str, " (~1 row)", 9);
2166f82e85aSdrh     }
2176f82e85aSdrh #endif
2186f82e85aSdrh     zMsg = sqlite3StrAccumFinish(&str);
219bd462bccSdrh     sqlite3ExplainBreakpoint("",zMsg);
220e2ca99c9Sdrh     ret = sqlite3VdbeAddOp4(v, OP_Explain, sqlite3VdbeCurrentAddr(v),
221e2ca99c9Sdrh                             pParse->addrExplain, 0, zMsg,P4_DYNAMIC);
2226f82e85aSdrh   }
2236f82e85aSdrh   return ret;
2246f82e85aSdrh }
2256ae49e67Sdrh 
2266ae49e67Sdrh /*
2276ae49e67Sdrh ** Add a single OP_Explain opcode that describes a Bloom filter.
2286ae49e67Sdrh **
2296ae49e67Sdrh ** Or if not processing EXPLAIN QUERY PLAN and not in a SQLITE_DEBUG and/or
2306ae49e67Sdrh ** SQLITE_ENABLE_STMT_SCANSTATUS build, then OP_Explain opcodes are not
2316ae49e67Sdrh ** required and this routine is a no-op.
2326ae49e67Sdrh **
2336ae49e67Sdrh ** If an OP_Explain opcode is added to the VM, its address is returned.
2346ae49e67Sdrh ** Otherwise, if no OP_Explain is coded, zero is returned.
2356ae49e67Sdrh */
2366ae49e67Sdrh int sqlite3WhereExplainBloomFilter(
2376ae49e67Sdrh   const Parse *pParse,               /* Parse context */
2386ae49e67Sdrh   const WhereInfo *pWInfo,           /* WHERE clause */
2396ae49e67Sdrh   const WhereLevel *pLevel           /* Bloom filter on this level */
2406ae49e67Sdrh ){
2416ae49e67Sdrh   int ret = 0;
2426ae49e67Sdrh   SrcItem *pItem = &pWInfo->pTabList->a[pLevel->iFrom];
2436ae49e67Sdrh   Vdbe *v = pParse->pVdbe;      /* VM being constructed */
2446ae49e67Sdrh   sqlite3 *db = pParse->db;     /* Database handle */
2456ae49e67Sdrh   char *zMsg;                   /* Text to add to EQP output */
2466ae49e67Sdrh   int i;                        /* Loop counter */
2476ae49e67Sdrh   WhereLoop *pLoop;             /* The where loop */
2486ae49e67Sdrh   StrAccum str;                 /* EQP output string */
2496ae49e67Sdrh   char zBuf[100];               /* Initial space for EQP output string */
2506ae49e67Sdrh 
2516ae49e67Sdrh   sqlite3StrAccumInit(&str, db, zBuf, sizeof(zBuf), SQLITE_MAX_LENGTH);
2526ae49e67Sdrh   str.printfFlags = SQLITE_PRINTF_INTERNAL;
2536ae49e67Sdrh   sqlite3_str_appendf(&str, "BLOOM FILTER ON %S (", pItem);
2546ae49e67Sdrh   pLoop = pLevel->pWLoop;
2553bd7cd73Sdrh   if( pLoop->wsFlags & WHERE_IPK ){
2563bd7cd73Sdrh     const Table *pTab = pItem->pTab;
2573bd7cd73Sdrh     if( pTab->iPKey>=0 ){
2583bd7cd73Sdrh       sqlite3_str_appendf(&str, "%s=?", pTab->aCol[pTab->iPKey].zCnName);
2593bd7cd73Sdrh     }else{
2603bd7cd73Sdrh       sqlite3_str_appendf(&str, "rowid=?");
2613bd7cd73Sdrh     }
2623bd7cd73Sdrh   }else{
2636ae49e67Sdrh     for(i=pLoop->nSkip; i<pLoop->u.btree.nEq; i++){
2643bd7cd73Sdrh       const char *z = explainIndexColumnName(pLoop->u.btree.pIndex, i);
2656ae49e67Sdrh       if( i>pLoop->nSkip ) sqlite3_str_append(&str, " AND ", 5);
2666ae49e67Sdrh       sqlite3_str_appendf(&str, "%s=?", z);
2676ae49e67Sdrh     }
2683bd7cd73Sdrh   }
2696ae49e67Sdrh   sqlite3_str_append(&str, ")", 1);
2706ae49e67Sdrh   zMsg = sqlite3StrAccumFinish(&str);
2716ae49e67Sdrh   ret = sqlite3VdbeAddOp4(v, OP_Explain, sqlite3VdbeCurrentAddr(v),
2726ae49e67Sdrh                           pParse->addrExplain, 0, zMsg,P4_DYNAMIC);
2736ae49e67Sdrh   return ret;
2746ae49e67Sdrh }
2756f82e85aSdrh #endif /* SQLITE_OMIT_EXPLAIN */
2766f82e85aSdrh 
2776f82e85aSdrh #ifdef SQLITE_ENABLE_STMT_SCANSTATUS
2786f82e85aSdrh /*
2796f82e85aSdrh ** Configure the VM passed as the first argument with an
2806f82e85aSdrh ** sqlite3_stmt_scanstatus() entry corresponding to the scan used to
2816f82e85aSdrh ** implement level pLvl. Argument pSrclist is a pointer to the FROM
2826f82e85aSdrh ** clause that the scan reads data from.
2836f82e85aSdrh **
2846f82e85aSdrh ** If argument addrExplain is not 0, it must be the address of an
2856f82e85aSdrh ** OP_Explain instruction that describes the same loop.
2866f82e85aSdrh */
2876f82e85aSdrh void sqlite3WhereAddScanStatus(
2886f82e85aSdrh   Vdbe *v,                        /* Vdbe to add scanstatus entry to */
2896f82e85aSdrh   SrcList *pSrclist,              /* FROM clause pLvl reads data from */
2906f82e85aSdrh   WhereLevel *pLvl,               /* Level to add scanstatus() entry for */
2916f82e85aSdrh   int addrExplain                 /* Address of OP_Explain (or 0) */
2926f82e85aSdrh ){
2936f82e85aSdrh   const char *zObj = 0;
2946f82e85aSdrh   WhereLoop *pLoop = pLvl->pWLoop;
2956f82e85aSdrh   if( (pLoop->wsFlags & WHERE_VIRTUALTABLE)==0  &&  pLoop->u.btree.pIndex!=0 ){
2966f82e85aSdrh     zObj = pLoop->u.btree.pIndex->zName;
2976f82e85aSdrh   }else{
2986f82e85aSdrh     zObj = pSrclist->a[pLvl->iFrom].zName;
2996f82e85aSdrh   }
3006f82e85aSdrh   sqlite3VdbeScanStatus(
3016f82e85aSdrh       v, addrExplain, pLvl->addrBody, pLvl->addrVisit, pLoop->nOut, zObj
3026f82e85aSdrh   );
3036f82e85aSdrh }
3046f82e85aSdrh #endif
3056f82e85aSdrh 
3066f82e85aSdrh 
3076f82e85aSdrh /*
3086f82e85aSdrh ** Disable a term in the WHERE clause.  Except, do not disable the term
3096f82e85aSdrh ** if it controls a LEFT OUTER JOIN and it did not originate in the ON
3106f82e85aSdrh ** or USING clause of that join.
3116f82e85aSdrh **
3126f82e85aSdrh ** Consider the term t2.z='ok' in the following queries:
3136f82e85aSdrh **
3146f82e85aSdrh **   (1)  SELECT * FROM t1 LEFT JOIN t2 ON t1.a=t2.x WHERE t2.z='ok'
3156f82e85aSdrh **   (2)  SELECT * FROM t1 LEFT JOIN t2 ON t1.a=t2.x AND t2.z='ok'
3166f82e85aSdrh **   (3)  SELECT * FROM t1, t2 WHERE t1.a=t2.x AND t2.z='ok'
3176f82e85aSdrh **
3186f82e85aSdrh ** The t2.z='ok' is disabled in the in (2) because it originates
3196f82e85aSdrh ** in the ON clause.  The term is disabled in (3) because it is not part
3206f82e85aSdrh ** of a LEFT OUTER JOIN.  In (1), the term is not disabled.
3216f82e85aSdrh **
3226f82e85aSdrh ** Disabling a term causes that term to not be tested in the inner loop
3236f82e85aSdrh ** of the join.  Disabling is an optimization.  When terms are satisfied
3246f82e85aSdrh ** by indices, we disable them to prevent redundant tests in the inner
3256f82e85aSdrh ** loop.  We would get the correct results if nothing were ever disabled,
3266f82e85aSdrh ** but joins might run a little slower.  The trick is to disable as much
3276f82e85aSdrh ** as we can without disabling too much.  If we disabled in (1), we'd get
3286f82e85aSdrh ** the wrong answer.  See ticket #813.
3296f82e85aSdrh **
3306f82e85aSdrh ** If all the children of a term are disabled, then that term is also
3316f82e85aSdrh ** automatically disabled.  In this way, terms get disabled if derived
3326f82e85aSdrh ** virtual terms are tested first.  For example:
3336f82e85aSdrh **
3346f82e85aSdrh **      x GLOB 'abc*' AND x>='abc' AND x<'acd'
3356f82e85aSdrh **      \___________/     \______/     \_____/
3366f82e85aSdrh **         parent          child1       child2
3376f82e85aSdrh **
3386f82e85aSdrh ** Only the parent term was in the original WHERE clause.  The child1
3396f82e85aSdrh ** and child2 terms were added by the LIKE optimization.  If both of
3406f82e85aSdrh ** the virtual child terms are valid, then testing of the parent can be
3416f82e85aSdrh ** skipped.
3426f82e85aSdrh **
3436f82e85aSdrh ** Usually the parent term is marked as TERM_CODED.  But if the parent
3446f82e85aSdrh ** term was originally TERM_LIKE, then the parent gets TERM_LIKECOND instead.
3456f82e85aSdrh ** The TERM_LIKECOND marking indicates that the term should be coded inside
3466f82e85aSdrh ** a conditional such that is only evaluated on the second pass of a
3476f82e85aSdrh ** LIKE-optimization loop, when scanning BLOBs instead of strings.
3486f82e85aSdrh */
3496f82e85aSdrh static void disableTerm(WhereLevel *pLevel, WhereTerm *pTerm){
3506f82e85aSdrh   int nLoop = 0;
3519d9c41e2Sdrh   assert( pTerm!=0 );
3529d9c41e2Sdrh   while( (pTerm->wtFlags & TERM_CODED)==0
3536f82e85aSdrh       && (pLevel->iLeftJoin==0 || ExprHasProperty(pTerm->pExpr, EP_FromJoin))
3546f82e85aSdrh       && (pLevel->notReady & pTerm->prereqAll)==0
3556f82e85aSdrh   ){
3566f82e85aSdrh     if( nLoop && (pTerm->wtFlags & TERM_LIKE)!=0 ){
3576f82e85aSdrh       pTerm->wtFlags |= TERM_LIKECOND;
3586f82e85aSdrh     }else{
3596f82e85aSdrh       pTerm->wtFlags |= TERM_CODED;
3606f82e85aSdrh     }
36123634898Sdrh #ifdef WHERETRACE_ENABLED
36223634898Sdrh     if( sqlite3WhereTrace & 0x20000 ){
36323634898Sdrh       sqlite3DebugPrintf("DISABLE-");
36423634898Sdrh       sqlite3WhereTermPrint(pTerm, (int)(pTerm - (pTerm->pWC->a)));
36523634898Sdrh     }
36623634898Sdrh #endif
3676f82e85aSdrh     if( pTerm->iParent<0 ) break;
3686f82e85aSdrh     pTerm = &pTerm->pWC->a[pTerm->iParent];
3699d9c41e2Sdrh     assert( pTerm!=0 );
3706f82e85aSdrh     pTerm->nChild--;
3716f82e85aSdrh     if( pTerm->nChild!=0 ) break;
3726f82e85aSdrh     nLoop++;
3736f82e85aSdrh   }
3746f82e85aSdrh }
3756f82e85aSdrh 
3766f82e85aSdrh /*
3776f82e85aSdrh ** Code an OP_Affinity opcode to apply the column affinity string zAff
3786f82e85aSdrh ** to the n registers starting at base.
3796f82e85aSdrh **
38096fb16eeSdrh ** As an optimization, SQLITE_AFF_BLOB and SQLITE_AFF_NONE entries (which
38196fb16eeSdrh ** are no-ops) at the beginning and end of zAff are ignored.  If all entries
38296fb16eeSdrh ** in zAff are SQLITE_AFF_BLOB or SQLITE_AFF_NONE, then no code gets generated.
3836f82e85aSdrh **
3846f82e85aSdrh ** This routine makes its own copy of zAff so that the caller is free
3856f82e85aSdrh ** to modify zAff after this routine returns.
3866f82e85aSdrh */
3876f82e85aSdrh static void codeApplyAffinity(Parse *pParse, int base, int n, char *zAff){
3886f82e85aSdrh   Vdbe *v = pParse->pVdbe;
3896f82e85aSdrh   if( zAff==0 ){
3906f82e85aSdrh     assert( pParse->db->mallocFailed );
3916f82e85aSdrh     return;
3926f82e85aSdrh   }
3936f82e85aSdrh   assert( v!=0 );
3946f82e85aSdrh 
39596fb16eeSdrh   /* Adjust base and n to skip over SQLITE_AFF_BLOB and SQLITE_AFF_NONE
39696fb16eeSdrh   ** entries at the beginning and end of the affinity string.
3976f82e85aSdrh   */
39896fb16eeSdrh   assert( SQLITE_AFF_NONE<SQLITE_AFF_BLOB );
39996fb16eeSdrh   while( n>0 && zAff[0]<=SQLITE_AFF_BLOB ){
4006f82e85aSdrh     n--;
4016f82e85aSdrh     base++;
4026f82e85aSdrh     zAff++;
4036f82e85aSdrh   }
40496fb16eeSdrh   while( n>1 && zAff[n-1]<=SQLITE_AFF_BLOB ){
4056f82e85aSdrh     n--;
4066f82e85aSdrh   }
4076f82e85aSdrh 
4086f82e85aSdrh   /* Code the OP_Affinity opcode if there is anything left to do. */
4096f82e85aSdrh   if( n>0 ){
4109b34abeeSdrh     sqlite3VdbeAddOp4(v, OP_Affinity, base, n, 0, zAff, n);
4116f82e85aSdrh   }
4126f82e85aSdrh }
4136f82e85aSdrh 
414b7ca2177Sdan /*
415b7ca2177Sdan ** Expression pRight, which is the RHS of a comparison operation, is
416b7ca2177Sdan ** either a vector of n elements or, if n==1, a scalar expression.
417b7ca2177Sdan ** Before the comparison operation, affinity zAff is to be applied
418b7ca2177Sdan ** to the pRight values. This function modifies characters within the
419b7ca2177Sdan ** affinity string to SQLITE_AFF_BLOB if either:
420b7ca2177Sdan **
421b7ca2177Sdan **   * the comparison will be performed with no affinity, or
422b7ca2177Sdan **   * the affinity change in zAff is guaranteed not to change the value.
423b7ca2177Sdan */
424b7ca2177Sdan static void updateRangeAffinityStr(
425b7ca2177Sdan   Expr *pRight,                   /* RHS of comparison */
426b7ca2177Sdan   int n,                          /* Number of vector elements in comparison */
427b7ca2177Sdan   char *zAff                      /* Affinity string to modify */
428b7ca2177Sdan ){
429b7ca2177Sdan   int i;
430b7ca2177Sdan   for(i=0; i<n; i++){
431b7ca2177Sdan     Expr *p = sqlite3VectorFieldSubexpr(pRight, i);
432b7ca2177Sdan     if( sqlite3CompareAffinity(p, zAff[i])==SQLITE_AFF_BLOB
433b7ca2177Sdan      || sqlite3ExprNeedsNoAffinityChange(p, zAff[i])
434b7ca2177Sdan     ){
435b7ca2177Sdan       zAff[i] = SQLITE_AFF_BLOB;
436b7ca2177Sdan     }
437b7ca2177Sdan   }
438b7ca2177Sdan }
4396f82e85aSdrh 
4402410243eSdrh 
4412410243eSdrh /*
4422410243eSdrh ** pX is an expression of the form:  (vector) IN (SELECT ...)
4432410243eSdrh ** In other words, it is a vector IN operator with a SELECT clause on the
4442410243eSdrh ** LHS.  But not all terms in the vector are indexable and the terms might
4452410243eSdrh ** not be in the correct order for indexing.
4469b1ecb67Sdrh **
4472410243eSdrh ** This routine makes a copy of the input pX expression and then adjusts
4482410243eSdrh ** the vector on the LHS with corresponding changes to the SELECT so that
4492410243eSdrh ** the vector contains only index terms and those terms are in the correct
4502410243eSdrh ** order.  The modified IN expression is returned.  The caller is responsible
4512410243eSdrh ** for deleting the returned expression.
4522410243eSdrh **
4532410243eSdrh ** Example:
4542410243eSdrh **
4552410243eSdrh **    CREATE TABLE t1(a,b,c,d,e,f);
4562410243eSdrh **    CREATE INDEX t1x1 ON t1(e,c);
4572410243eSdrh **    SELECT * FROM t1 WHERE (a,b,c,d,e) IN (SELECT v,w,x,y,z FROM t2)
4582410243eSdrh **                           \_______________________________________/
4592410243eSdrh **                                     The pX expression
4602410243eSdrh **
4612410243eSdrh ** Since only columns e and c can be used with the index, in that order,
4622410243eSdrh ** the modified IN expression that is returned will be:
4632410243eSdrh **
4642410243eSdrh **        (e,c) IN (SELECT z,x FROM t2)
4652410243eSdrh **
4662410243eSdrh ** The reduced pX is different from the original (obviously) and thus is
4672410243eSdrh ** only used for indexing, to improve performance.  The original unaltered
4682410243eSdrh ** IN expression must also be run on each output row for correctness.
4699b1ecb67Sdrh */
4702410243eSdrh static Expr *removeUnindexableInClauseTerms(
4712410243eSdrh   Parse *pParse,        /* The parsing context */
4722410243eSdrh   int iEq,              /* Look at loop terms starting here */
4732410243eSdrh   WhereLoop *pLoop,     /* The current loop */
4742410243eSdrh   Expr *pX              /* The IN expression to be reduced */
4752410243eSdrh ){
4762410243eSdrh   sqlite3 *db = pParse->db;
47769843342Sdan   Expr *pNew;
47869843342Sdan   pNew = sqlite3ExprDup(db, pX, 0);
4792410243eSdrh   if( db->mallocFailed==0 ){
480a4eeccdfSdrh     ExprList *pOrigRhs;         /* Original unmodified RHS */
481a4eeccdfSdrh     ExprList *pOrigLhs;         /* Original unmodified LHS */
4822410243eSdrh     ExprList *pRhs = 0;         /* New RHS after modifications */
4832410243eSdrh     ExprList *pLhs = 0;         /* New LHS after mods */
4842410243eSdrh     int i;                      /* Loop counter */
4852410243eSdrh     Select *pSelect;            /* Pointer to the SELECT on the RHS */
4862410243eSdrh 
487a4eeccdfSdrh     assert( ExprUseXSelect(pNew) );
488a4eeccdfSdrh     pOrigRhs = pNew->x.pSelect->pEList;
489a4eeccdfSdrh     assert( pNew->pLeft!=0 );
490a4eeccdfSdrh     assert( ExprUseXList(pNew->pLeft) );
491a4eeccdfSdrh     pOrigLhs = pNew->pLeft->x.pList;
4922410243eSdrh     for(i=iEq; i<pLoop->nLTerm; i++){
4932410243eSdrh       if( pLoop->aLTerm[i]->pExpr==pX ){
494220f0d6fSdrh         int iField;
495220f0d6fSdrh         assert( (pLoop->aLTerm[i]->eOperator & (WO_OR|WO_AND))==0 );
496220f0d6fSdrh         iField = pLoop->aLTerm[i]->u.x.iField - 1;
497c6e519f3Sdrh         if( pOrigRhs->a[iField].pExpr==0 ) continue; /* Duplicate PK column */
4982410243eSdrh         pRhs = sqlite3ExprListAppend(pParse, pRhs, pOrigRhs->a[iField].pExpr);
4992410243eSdrh         pOrigRhs->a[iField].pExpr = 0;
5002410243eSdrh         assert( pOrigLhs->a[iField].pExpr!=0 );
5012410243eSdrh         pLhs = sqlite3ExprListAppend(pParse, pLhs, pOrigLhs->a[iField].pExpr);
5022410243eSdrh         pOrigLhs->a[iField].pExpr = 0;
5039b1ecb67Sdrh       }
5049b1ecb67Sdrh     }
5052410243eSdrh     sqlite3ExprListDelete(db, pOrigRhs);
5062410243eSdrh     sqlite3ExprListDelete(db, pOrigLhs);
5072410243eSdrh     pNew->pLeft->x.pList = pLhs;
5082410243eSdrh     pNew->x.pSelect->pEList = pRhs;
5092410243eSdrh     if( pLhs && pLhs->nExpr==1 ){
5102410243eSdrh       /* Take care here not to generate a TK_VECTOR containing only a
5112410243eSdrh       ** single value. Since the parser never creates such a vector, some
5122410243eSdrh       ** of the subroutines do not handle this case.  */
5132410243eSdrh       Expr *p = pLhs->a[0].pExpr;
5142410243eSdrh       pLhs->a[0].pExpr = 0;
5152410243eSdrh       sqlite3ExprDelete(db, pNew->pLeft);
5162410243eSdrh       pNew->pLeft = p;
5179b1ecb67Sdrh     }
5182410243eSdrh     pSelect = pNew->x.pSelect;
5192410243eSdrh     if( pSelect->pOrderBy ){
5202410243eSdrh       /* If the SELECT statement has an ORDER BY clause, zero the
5212410243eSdrh       ** iOrderByCol variables. These are set to non-zero when an
5222410243eSdrh       ** ORDER BY term exactly matches one of the terms of the
5232410243eSdrh       ** result-set. Since the result-set of the SELECT statement may
5242410243eSdrh       ** have been modified or reordered, these variables are no longer
5252410243eSdrh       ** set correctly.  Since setting them is just an optimization,
5262410243eSdrh       ** it's easiest just to zero them here.  */
5272410243eSdrh       ExprList *pOrderBy = pSelect->pOrderBy;
5282410243eSdrh       for(i=0; i<pOrderBy->nExpr; i++){
5292410243eSdrh         pOrderBy->a[i].u.x.iOrderByCol = 0;
5302410243eSdrh       }
5312410243eSdrh     }
5322410243eSdrh 
5332410243eSdrh #if 0
5342410243eSdrh     printf("For indexing, change the IN expr:\n");
5352410243eSdrh     sqlite3TreeViewExpr(0, pX, 0);
5362410243eSdrh     printf("Into:\n");
5372410243eSdrh     sqlite3TreeViewExpr(0, pNew, 0);
5382410243eSdrh #endif
5392410243eSdrh   }
5402410243eSdrh   return pNew;
5412410243eSdrh }
5429b1ecb67Sdrh 
5439b1ecb67Sdrh 
5446f82e85aSdrh /*
5456f82e85aSdrh ** Generate code for a single equality term of the WHERE clause.  An equality
5466f82e85aSdrh ** term can be either X=expr or X IN (...).   pTerm is the term to be
5476f82e85aSdrh ** coded.
5486f82e85aSdrh **
549099a0f5fSdrh ** The current value for the constraint is left in a register, the index
550099a0f5fSdrh ** of which is returned.  An attempt is made store the result in iTarget but
551099a0f5fSdrh ** this is only guaranteed for TK_ISNULL and TK_IN constraints.  If the
552099a0f5fSdrh ** constraint is a TK_EQ or TK_IS, then the current value might be left in
553099a0f5fSdrh ** some other register and it is the caller's responsibility to compensate.
5546f82e85aSdrh **
5554602b8e8Sdrh ** For a constraint of the form X=expr, the expression is evaluated in
5564602b8e8Sdrh ** straight-line code.  For constraints of the form X IN (...)
5576f82e85aSdrh ** this routine sets up a loop that will iterate over all values of X.
5586f82e85aSdrh */
5596f82e85aSdrh static int codeEqualityTerm(
5606f82e85aSdrh   Parse *pParse,      /* The parsing context */
5616f82e85aSdrh   WhereTerm *pTerm,   /* The term of the WHERE clause to be coded */
5626f82e85aSdrh   WhereLevel *pLevel, /* The level of the FROM clause we are working on */
5636f82e85aSdrh   int iEq,            /* Index of the equality term within this level */
5646f82e85aSdrh   int bRev,           /* True for reverse-order IN operations */
5656f82e85aSdrh   int iTarget         /* Attempt to leave results in this register */
5666f82e85aSdrh ){
5676f82e85aSdrh   Expr *pX = pTerm->pExpr;
5686f82e85aSdrh   Vdbe *v = pParse->pVdbe;
5696f82e85aSdrh   int iReg;                  /* Register holding results */
5706f82e85aSdrh 
5718da209b1Sdan   assert( pLevel->pWLoop->aLTerm[iEq]==pTerm );
5726f82e85aSdrh   assert( iTarget>0 );
5736f82e85aSdrh   if( pX->op==TK_EQ || pX->op==TK_IS ){
574fc7f27b9Sdrh     iReg = sqlite3ExprCodeTarget(pParse, pX->pRight, iTarget);
5756f82e85aSdrh   }else if( pX->op==TK_ISNULL ){
5766f82e85aSdrh     iReg = iTarget;
5776f82e85aSdrh     sqlite3VdbeAddOp2(v, OP_Null, 0, iReg);
5786f82e85aSdrh #ifndef SQLITE_OMIT_SUBQUERY
5796f82e85aSdrh   }else{
580ac6b47d1Sdrh     int eType = IN_INDEX_NOOP;
5816f82e85aSdrh     int iTab;
5826f82e85aSdrh     struct InLoop *pIn;
5836f82e85aSdrh     WhereLoop *pLoop = pLevel->pWLoop;
5848da209b1Sdan     int i;
5858da209b1Sdan     int nEq = 0;
5868da209b1Sdan     int *aiMap = 0;
5876f82e85aSdrh 
5886f82e85aSdrh     if( (pLoop->wsFlags & WHERE_VIRTUALTABLE)==0
5896f82e85aSdrh       && pLoop->u.btree.pIndex!=0
5906f82e85aSdrh       && pLoop->u.btree.pIndex->aSortOrder[iEq]
5916f82e85aSdrh     ){
5926f82e85aSdrh       testcase( iEq==0 );
5936f82e85aSdrh       testcase( bRev );
5946f82e85aSdrh       bRev = !bRev;
5956f82e85aSdrh     }
5966f82e85aSdrh     assert( pX->op==TK_IN );
5976f82e85aSdrh     iReg = iTarget;
5988da209b1Sdan 
5998da209b1Sdan     for(i=0; i<iEq; i++){
6008da209b1Sdan       if( pLoop->aLTerm[i] && pLoop->aLTerm[i]->pExpr==pX ){
6018da209b1Sdan         disableTerm(pLevel, pTerm);
6028da209b1Sdan         return iTarget;
6038da209b1Sdan       }
6048da209b1Sdan     }
6058da209b1Sdan     for(i=iEq;i<pLoop->nLTerm; i++){
6062410243eSdrh       assert( pLoop->aLTerm[i]!=0 );
6072410243eSdrh       if( pLoop->aLTerm[i]->pExpr==pX ) nEq++;
6088da209b1Sdan     }
6098da209b1Sdan 
6102c04131cSdrh     iTab = 0;
611a4eeccdfSdrh     if( !ExprUseXSelect(pX) || pX->x.pSelect->pEList->nExpr==1 ){
6122c04131cSdrh       eType = sqlite3FindInIndex(pParse, pX, IN_INDEX_LOOP, 0, 0, &iTab);
6138da209b1Sdan     }else{
6148da209b1Sdan       sqlite3 *db = pParse->db;
6152410243eSdrh       pX = removeUnindexableInClauseTerms(pParse, iEq, pLoop, pX);
6169b1ecb67Sdrh 
617ac6b47d1Sdrh       if( !db->mallocFailed ){
618c7a77ae1Sdrh         aiMap = (int*)sqlite3DbMallocZero(pParse->db, sizeof(int)*nEq);
6192c04131cSdrh         eType = sqlite3FindInIndex(pParse, pX, IN_INDEX_LOOP, 0, aiMap, &iTab);
6202c04131cSdrh         pTerm->pExpr->iTable = iTab;
621ac6b47d1Sdrh       }
6222410243eSdrh       sqlite3ExprDelete(db, pX);
6232410243eSdrh       pX = pTerm->pExpr;
6248da209b1Sdan     }
6258da209b1Sdan 
6266f82e85aSdrh     if( eType==IN_INDEX_INDEX_DESC ){
6276f82e85aSdrh       testcase( bRev );
6286f82e85aSdrh       bRev = !bRev;
6296f82e85aSdrh     }
6306f82e85aSdrh     sqlite3VdbeAddOp2(v, bRev ? OP_Last : OP_Rewind, iTab, 0);
6316f82e85aSdrh     VdbeCoverageIf(v, bRev);
6326f82e85aSdrh     VdbeCoverageIf(v, !bRev);
6338da209b1Sdan 
6340475629dSdrh     assert( (pLoop->wsFlags & WHERE_MULTI_OR)==0 );
6356f82e85aSdrh     pLoop->wsFlags |= WHERE_IN_ABLE;
6366f82e85aSdrh     if( pLevel->u.in.nIn==0 ){
637ec4ccdbcSdrh       pLevel->addrNxt = sqlite3VdbeMakeLabel(pParse);
6386f82e85aSdrh     }
63946f0f4e5Sdrh     if( iEq>0 && (pLoop->wsFlags & WHERE_IN_SEEKSCAN)==0 ){
640fa17e134Sdrh       pLoop->wsFlags |= WHERE_IN_EARLYOUT;
641fa17e134Sdrh     }
6428da209b1Sdan 
6438da209b1Sdan     i = pLevel->u.in.nIn;
6448da209b1Sdan     pLevel->u.in.nIn += nEq;
6456f82e85aSdrh     pLevel->u.in.aInLoop =
646f8bdcfa3Sdrh        sqlite3WhereRealloc(pTerm->pWC->pWInfo,
647f8bdcfa3Sdrh                            pLevel->u.in.aInLoop,
6486f82e85aSdrh                            sizeof(pLevel->u.in.aInLoop[0])*pLevel->u.in.nIn);
6496f82e85aSdrh     pIn = pLevel->u.in.aInLoop;
6506f82e85aSdrh     if( pIn ){
6518da209b1Sdan       int iMap = 0;               /* Index in aiMap[] */
6528da209b1Sdan       pIn += i;
6537887d7f2Sdan       for(i=iEq;i<pLoop->nLTerm; i++){
6548da209b1Sdan         if( pLoop->aLTerm[i]->pExpr==pX ){
655edc3537cSdan           int iOut = iReg + i - iEq;
6566f82e85aSdrh           if( eType==IN_INDEX_ROWID ){
657edc3537cSdan             pIn->addrInTop = sqlite3VdbeAddOp2(v, OP_Rowid, iTab, iOut);
6586f82e85aSdrh           }else{
6598da209b1Sdan             int iCol = aiMap ? aiMap[iMap++] : 0;
6608da209b1Sdan             pIn->addrInTop = sqlite3VdbeAddOp3(v,OP_Column,iTab, iCol, iOut);
6616f82e85aSdrh           }
66203181c8cSdrh           sqlite3VdbeAddOp1(v, OP_IsNull, iOut); VdbeCoverage(v);
6638da209b1Sdan           if( i==iEq ){
6648da209b1Sdan             pIn->iCur = iTab;
665f1949b66Sdrh             pIn->eEndLoopOp = bRev ? OP_Prev : OP_Next;
66674ebaadcSdan             if( iEq>0 ){
667a0368d93Sdrh               pIn->iBase = iReg - i;
668a0368d93Sdrh               pIn->nPrefix = i;
6698da209b1Sdan             }else{
67086d0ea75Sdrh               pIn->nPrefix = 0;
67186d0ea75Sdrh             }
67286d0ea75Sdrh           }else{
6738da209b1Sdan             pIn->eEndLoopOp = OP_Noop;
6748da209b1Sdan           }
6757887d7f2Sdan           pIn++;
6768da209b1Sdan         }
6778da209b1Sdan       }
67867306cb3Sdrh       testcase( iEq>0
67967306cb3Sdrh                 && (pLoop->wsFlags & WHERE_IN_SEEKSCAN)==0
68067306cb3Sdrh                 && (pLoop->wsFlags & WHERE_VIRTUALTABLE)!=0 );
68167306cb3Sdrh       if( iEq>0
68267306cb3Sdrh        && (pLoop->wsFlags & (WHERE_IN_SEEKSCAN|WHERE_VIRTUALTABLE))==0
68367306cb3Sdrh       ){
684fa17e134Sdrh         sqlite3VdbeAddOp3(v, OP_SeekHit, pLevel->iIdxCur, 0, iEq);
685fa17e134Sdrh       }
6866f82e85aSdrh     }else{
6876f82e85aSdrh       pLevel->u.in.nIn = 0;
6886f82e85aSdrh     }
6898da209b1Sdan     sqlite3DbFree(pParse->db, aiMap);
6906f82e85aSdrh #endif
6916f82e85aSdrh   }
69267656ac7Sdrh 
69367656ac7Sdrh   /* As an optimization, try to disable the WHERE clause term that is
69467656ac7Sdrh   ** driving the index as it will always be true.  The correct answer is
69567656ac7Sdrh   ** obtained regardless, but we might get the answer with fewer CPU cycles
69667656ac7Sdrh   ** by omitting the term.
69767656ac7Sdrh   **
69867656ac7Sdrh   ** But do not disable the term unless we are certain that the term is
69967656ac7Sdrh   ** not a transitive constraint.  For an example of where that does not
70067656ac7Sdrh   ** work, see https://sqlite.org/forum/forumpost/eb8613976a (2021-05-04)
70167656ac7Sdrh   */
70267656ac7Sdrh   if( (pLevel->pWLoop->wsFlags & WHERE_TRANSCONS)==0
70367656ac7Sdrh    || (pTerm->eOperator & WO_EQUIV)==0
70467656ac7Sdrh   ){
7056f82e85aSdrh     disableTerm(pLevel, pTerm);
70667656ac7Sdrh   }
70767656ac7Sdrh 
7086f82e85aSdrh   return iReg;
7096f82e85aSdrh }
7106f82e85aSdrh 
7116f82e85aSdrh /*
7126f82e85aSdrh ** Generate code that will evaluate all == and IN constraints for an
7136f82e85aSdrh ** index scan.
7146f82e85aSdrh **
7156f82e85aSdrh ** For example, consider table t1(a,b,c,d,e,f) with index i1(a,b,c).
7166f82e85aSdrh ** Suppose the WHERE clause is this:  a==5 AND b IN (1,2,3) AND c>5 AND c<10
7176f82e85aSdrh ** The index has as many as three equality constraints, but in this
7186f82e85aSdrh ** example, the third "c" value is an inequality.  So only two
7196f82e85aSdrh ** constraints are coded.  This routine will generate code to evaluate
7206f82e85aSdrh ** a==5 and b IN (1,2,3).  The current values for a and b will be stored
7216f82e85aSdrh ** in consecutive registers and the index of the first register is returned.
7226f82e85aSdrh **
7236f82e85aSdrh ** In the example above nEq==2.  But this subroutine works for any value
7246f82e85aSdrh ** of nEq including 0.  If nEq==0, this routine is nearly a no-op.
7256f82e85aSdrh ** The only thing it does is allocate the pLevel->iMem memory cell and
7266f82e85aSdrh ** compute the affinity string.
7276f82e85aSdrh **
7286f82e85aSdrh ** The nExtraReg parameter is 0 or 1.  It is 0 if all WHERE clause constraints
7296f82e85aSdrh ** are == or IN and are covered by the nEq.  nExtraReg is 1 if there is
7306f82e85aSdrh ** an inequality constraint (such as the "c>=5 AND c<10" in the example) that
7316f82e85aSdrh ** occurs after the nEq quality constraints.
7326f82e85aSdrh **
7336f82e85aSdrh ** This routine allocates a range of nEq+nExtraReg memory cells and returns
7346f82e85aSdrh ** the index of the first memory cell in that range. The code that
7356f82e85aSdrh ** calls this routine will use that memory range to store keys for
7366f82e85aSdrh ** start and termination conditions of the loop.
7376f82e85aSdrh ** key value of the loop.  If one or more IN operators appear, then
7386f82e85aSdrh ** this routine allocates an additional nEq memory cells for internal
7396f82e85aSdrh ** use.
7406f82e85aSdrh **
7416f82e85aSdrh ** Before returning, *pzAff is set to point to a buffer containing a
7426f82e85aSdrh ** copy of the column affinity string of the index allocated using
7436f82e85aSdrh ** sqlite3DbMalloc(). Except, entries in the copy of the string associated
7446f82e85aSdrh ** with equality constraints that use BLOB or NONE affinity are set to
7456f82e85aSdrh ** SQLITE_AFF_BLOB. This is to deal with SQL such as the following:
7466f82e85aSdrh **
7476f82e85aSdrh **   CREATE TABLE t1(a TEXT PRIMARY KEY, b);
7486f82e85aSdrh **   SELECT ... FROM t1 AS t2, t1 WHERE t1.a = t2.b;
7496f82e85aSdrh **
7506f82e85aSdrh ** In the example above, the index on t1(a) has TEXT affinity. But since
7516f82e85aSdrh ** the right hand side of the equality constraint (t2.b) has BLOB/NONE affinity,
7526f82e85aSdrh ** no conversion should be attempted before using a t2.b value as part of
7536f82e85aSdrh ** a key to search the index. Hence the first byte in the returned affinity
7546f82e85aSdrh ** string in this example would be set to SQLITE_AFF_BLOB.
7556f82e85aSdrh */
7566f82e85aSdrh static int codeAllEqualityTerms(
7576f82e85aSdrh   Parse *pParse,        /* Parsing context */
7586f82e85aSdrh   WhereLevel *pLevel,   /* Which nested loop of the FROM we are coding */
7596f82e85aSdrh   int bRev,             /* Reverse the order of IN operators */
7606f82e85aSdrh   int nExtraReg,        /* Number of extra registers to allocate */
7616f82e85aSdrh   char **pzAff          /* OUT: Set to point to affinity string */
7626f82e85aSdrh ){
7636f82e85aSdrh   u16 nEq;                      /* The number of == or IN constraints to code */
7646f82e85aSdrh   u16 nSkip;                    /* Number of left-most columns to skip */
7656f82e85aSdrh   Vdbe *v = pParse->pVdbe;      /* The vm under construction */
7666f82e85aSdrh   Index *pIdx;                  /* The index being used for this loop */
7676f82e85aSdrh   WhereTerm *pTerm;             /* A single constraint term */
7686f82e85aSdrh   WhereLoop *pLoop;             /* The WhereLoop object */
7696f82e85aSdrh   int j;                        /* Loop counter */
7706f82e85aSdrh   int regBase;                  /* Base register */
7716f82e85aSdrh   int nReg;                     /* Number of registers to allocate */
7726f82e85aSdrh   char *zAff;                   /* Affinity string to return */
7736f82e85aSdrh 
7746f82e85aSdrh   /* This module is only called on query plans that use an index. */
7756f82e85aSdrh   pLoop = pLevel->pWLoop;
7766f82e85aSdrh   assert( (pLoop->wsFlags & WHERE_VIRTUALTABLE)==0 );
7776f82e85aSdrh   nEq = pLoop->u.btree.nEq;
7786f82e85aSdrh   nSkip = pLoop->nSkip;
7796f82e85aSdrh   pIdx = pLoop->u.btree.pIndex;
7806f82e85aSdrh   assert( pIdx!=0 );
7816f82e85aSdrh 
7826f82e85aSdrh   /* Figure out how many memory cells we will need then allocate them.
7836f82e85aSdrh   */
7846f82e85aSdrh   regBase = pParse->nMem + 1;
7856f82e85aSdrh   nReg = pLoop->u.btree.nEq + nExtraReg;
7866f82e85aSdrh   pParse->nMem += nReg;
7876f82e85aSdrh 
788e9107698Sdrh   zAff = sqlite3DbStrDup(pParse->db,sqlite3IndexAffinityStr(pParse->db,pIdx));
7894df86af3Sdrh   assert( zAff!=0 || pParse->db->mallocFailed );
7906f82e85aSdrh 
7916f82e85aSdrh   if( nSkip ){
7926f82e85aSdrh     int iIdxCur = pLevel->iIdxCur;
79331536304Sdrh     sqlite3VdbeAddOp3(v, OP_Null, 0, regBase, regBase+nSkip-1);
7946f82e85aSdrh     sqlite3VdbeAddOp1(v, (bRev?OP_Last:OP_Rewind), iIdxCur);
7956f82e85aSdrh     VdbeCoverageIf(v, bRev==0);
7966f82e85aSdrh     VdbeCoverageIf(v, bRev!=0);
7976f82e85aSdrh     VdbeComment((v, "begin skip-scan on %s", pIdx->zName));
7986f82e85aSdrh     j = sqlite3VdbeAddOp0(v, OP_Goto);
79956945695Sdrh     assert( pLevel->addrSkip==0 );
8006f82e85aSdrh     pLevel->addrSkip = sqlite3VdbeAddOp4Int(v, (bRev?OP_SeekLT:OP_SeekGT),
8016f82e85aSdrh                             iIdxCur, 0, regBase, nSkip);
8026f82e85aSdrh     VdbeCoverageIf(v, bRev==0);
8036f82e85aSdrh     VdbeCoverageIf(v, bRev!=0);
8046f82e85aSdrh     sqlite3VdbeJumpHere(v, j);
8056f82e85aSdrh     for(j=0; j<nSkip; j++){
8066f82e85aSdrh       sqlite3VdbeAddOp3(v, OP_Column, iIdxCur, j, regBase+j);
8074b92f98cSdrh       testcase( pIdx->aiColumn[j]==XN_EXPR );
808e63e8a6cSdrh       VdbeComment((v, "%s", explainIndexColumnName(pIdx, j)));
8096f82e85aSdrh     }
8106f82e85aSdrh   }
8116f82e85aSdrh 
8126f82e85aSdrh   /* Evaluate the equality constraints
8136f82e85aSdrh   */
8146f82e85aSdrh   assert( zAff==0 || (int)strlen(zAff)>=nEq );
8156f82e85aSdrh   for(j=nSkip; j<nEq; j++){
8166f82e85aSdrh     int r1;
8176f82e85aSdrh     pTerm = pLoop->aLTerm[j];
8186f82e85aSdrh     assert( pTerm!=0 );
8196f82e85aSdrh     /* The following testcase is true for indices with redundant columns.
8206f82e85aSdrh     ** Ex: CREATE INDEX i1 ON t1(a,b,a); SELECT * FROM t1 WHERE a=0 AND b=0; */
8216f82e85aSdrh     testcase( (pTerm->wtFlags & TERM_CODED)!=0 );
8226f82e85aSdrh     testcase( pTerm->wtFlags & TERM_VIRTUAL );
8236f82e85aSdrh     r1 = codeEqualityTerm(pParse, pTerm, pLevel, j, bRev, regBase+j);
8246f82e85aSdrh     if( r1!=regBase+j ){
8256f82e85aSdrh       if( nReg==1 ){
8266f82e85aSdrh         sqlite3ReleaseTempReg(pParse, regBase);
8276f82e85aSdrh         regBase = r1;
8286f82e85aSdrh       }else{
829e9de6520Sdrh         sqlite3VdbeAddOp2(v, OP_Copy, r1, regBase+j);
8306f82e85aSdrh       }
8316f82e85aSdrh     }
832e482fde6Sdrh   }
833e482fde6Sdrh   for(j=nSkip; j<nEq; j++){
834e482fde6Sdrh     pTerm = pLoop->aLTerm[j];
83527189603Sdan     if( pTerm->eOperator & WO_IN ){
83627189603Sdan       if( pTerm->pExpr->flags & EP_xIsSelect ){
8371c12657fSdan         /* No affinity ever needs to be (or should be) applied to a value
8381c12657fSdan         ** from the RHS of an "? IN (SELECT ...)" expression. The
8391c12657fSdan         ** sqlite3FindInIndex() routine has already ensured that the
8401c12657fSdan         ** affinity of the comparison has been applied to the value.  */
841aaf8a064Sdrh         if( zAff ) zAff[j] = SQLITE_AFF_BLOB;
84227189603Sdan       }
843c097e122Sdrh     }else if( (pTerm->eOperator & WO_ISNULL)==0 ){
8441c12657fSdan       Expr *pRight = pTerm->pExpr->pRight;
8456f82e85aSdrh       if( (pTerm->wtFlags & TERM_IS)==0 && sqlite3ExprCanBeNull(pRight) ){
8466f82e85aSdrh         sqlite3VdbeAddOp2(v, OP_IsNull, regBase+j, pLevel->addrBrk);
8476f82e85aSdrh         VdbeCoverage(v);
8486f82e85aSdrh       }
8490c7d3d39Sdrh       if( pParse->nErr==0 ){
8500c7d3d39Sdrh         assert( pParse->db->mallocFailed==0 );
8516f82e85aSdrh         if( sqlite3CompareAffinity(pRight, zAff[j])==SQLITE_AFF_BLOB ){
8526f82e85aSdrh           zAff[j] = SQLITE_AFF_BLOB;
8536f82e85aSdrh         }
8546f82e85aSdrh         if( sqlite3ExprNeedsNoAffinityChange(pRight, zAff[j]) ){
8556f82e85aSdrh           zAff[j] = SQLITE_AFF_BLOB;
8566f82e85aSdrh         }
8576f82e85aSdrh       }
8586f82e85aSdrh     }
8596f82e85aSdrh   }
8606f82e85aSdrh   *pzAff = zAff;
8616f82e85aSdrh   return regBase;
8626f82e85aSdrh }
8636f82e85aSdrh 
86441d2e66eSdrh #ifndef SQLITE_LIKE_DOESNT_MATCH_BLOBS
8656f82e85aSdrh /*
86644aebff2Sdrh ** If the most recently coded instruction is a constant range constraint
86744aebff2Sdrh ** (a string literal) that originated from the LIKE optimization, then
86844aebff2Sdrh ** set P3 and P5 on the OP_String opcode so that the string will be cast
86944aebff2Sdrh ** to a BLOB at appropriate times.
8706f82e85aSdrh **
8716f82e85aSdrh ** The LIKE optimization trys to evaluate "x LIKE 'abc%'" as a range
8726f82e85aSdrh ** expression: "x>='ABC' AND x<'abd'".  But this requires that the range
8736f82e85aSdrh ** scan loop run twice, once for strings and a second time for BLOBs.
8746f82e85aSdrh ** The OP_String opcodes on the second pass convert the upper and lower
875e234cfd1Smistachkin ** bound string constants to blobs.  This routine makes the necessary changes
8766f82e85aSdrh ** to the OP_String opcodes for that to happen.
87741d2e66eSdrh **
87841d2e66eSdrh ** Except, of course, if SQLITE_LIKE_DOESNT_MATCH_BLOBS is defined, then
87941d2e66eSdrh ** only the one pass through the string space is required, so this routine
88041d2e66eSdrh ** becomes a no-op.
8816f82e85aSdrh */
8826f82e85aSdrh static void whereLikeOptimizationStringFixup(
8836f82e85aSdrh   Vdbe *v,                /* prepared statement under construction */
8846f82e85aSdrh   WhereLevel *pLevel,     /* The loop that contains the LIKE operator */
8856f82e85aSdrh   WhereTerm *pTerm        /* The upper or lower bound just coded */
8866f82e85aSdrh ){
8876f82e85aSdrh   if( pTerm->wtFlags & TERM_LIKEOPT ){
8886f82e85aSdrh     VdbeOp *pOp;
8896f82e85aSdrh     assert( pLevel->iLikeRepCntr>0 );
8906f82e85aSdrh     pOp = sqlite3VdbeGetOp(v, -1);
8916f82e85aSdrh     assert( pOp!=0 );
8926f82e85aSdrh     assert( pOp->opcode==OP_String8
8936f82e85aSdrh             || pTerm->pWC->pWInfo->pParse->db->mallocFailed );
89444aebff2Sdrh     pOp->p3 = (int)(pLevel->iLikeRepCntr>>1);  /* Register holding counter */
89544aebff2Sdrh     pOp->p5 = (u8)(pLevel->iLikeRepCntr&1);    /* ASC or DESC */
8966f82e85aSdrh   }
8976f82e85aSdrh }
89841d2e66eSdrh #else
89941d2e66eSdrh # define whereLikeOptimizationStringFixup(A,B,C)
90041d2e66eSdrh #endif
9016f82e85aSdrh 
902bec2476aSdrh #ifdef SQLITE_ENABLE_CURSOR_HINTS
9032f2b0278Sdrh /*
9042f2b0278Sdrh ** Information is passed from codeCursorHint() down to individual nodes of
9052f2b0278Sdrh ** the expression tree (by sqlite3WalkExpr()) using an instance of this
9062f2b0278Sdrh ** structure.
9072f2b0278Sdrh */
9082f2b0278Sdrh struct CCurHint {
9092f2b0278Sdrh   int iTabCur;    /* Cursor for the main table */
9102f2b0278Sdrh   int iIdxCur;    /* Cursor for the index, if pIdx!=0.  Unused otherwise */
9112f2b0278Sdrh   Index *pIdx;    /* The index used to access the table */
9122f2b0278Sdrh };
9132f2b0278Sdrh 
9142f2b0278Sdrh /*
9152f2b0278Sdrh ** This function is called for every node of an expression that is a candidate
9162f2b0278Sdrh ** for a cursor hint on an index cursor.  For TK_COLUMN nodes that reference
9172f2b0278Sdrh ** the table CCurHint.iTabCur, verify that the same column can be
9182f2b0278Sdrh ** accessed through the index.  If it cannot, then set pWalker->eCode to 1.
9192f2b0278Sdrh */
9202f2b0278Sdrh static int codeCursorHintCheckExpr(Walker *pWalker, Expr *pExpr){
9212f2b0278Sdrh   struct CCurHint *pHint = pWalker->u.pCCurHint;
9222f2b0278Sdrh   assert( pHint->pIdx!=0 );
9232f2b0278Sdrh   if( pExpr->op==TK_COLUMN
9242f2b0278Sdrh    && pExpr->iTable==pHint->iTabCur
925b9bcf7caSdrh    && sqlite3TableColumnToIndex(pHint->pIdx, pExpr->iColumn)<0
9262f2b0278Sdrh   ){
9272f2b0278Sdrh     pWalker->eCode = 1;
9282f2b0278Sdrh   }
9292f2b0278Sdrh   return WRC_Continue;
9302f2b0278Sdrh }
9312f2b0278Sdrh 
932e6912fd8Sdan /*
933e6912fd8Sdan ** Test whether or not expression pExpr, which was part of a WHERE clause,
934e6912fd8Sdan ** should be included in the cursor-hint for a table that is on the rhs
935e6912fd8Sdan ** of a LEFT JOIN. Set Walker.eCode to non-zero before returning if the
936e6912fd8Sdan ** expression is not suitable.
937e6912fd8Sdan **
938e6912fd8Sdan ** An expression is unsuitable if it might evaluate to non NULL even if
939e6912fd8Sdan ** a TK_COLUMN node that does affect the value of the expression is set
940e6912fd8Sdan ** to NULL. For example:
941e6912fd8Sdan **
942e6912fd8Sdan **   col IS NULL
943e6912fd8Sdan **   col IS NOT NULL
944e6912fd8Sdan **   coalesce(col, 1)
945e6912fd8Sdan **   CASE WHEN col THEN 0 ELSE 1 END
946e6912fd8Sdan */
947e6912fd8Sdan static int codeCursorHintIsOrFunction(Walker *pWalker, Expr *pExpr){
9482b693d63Sdan   if( pExpr->op==TK_IS
949e6912fd8Sdan    || pExpr->op==TK_ISNULL || pExpr->op==TK_ISNOT
950e6912fd8Sdan    || pExpr->op==TK_NOTNULL || pExpr->op==TK_CASE
951e6912fd8Sdan   ){
952e6912fd8Sdan     pWalker->eCode = 1;
9532b693d63Sdan   }else if( pExpr->op==TK_FUNCTION ){
9542b693d63Sdan     int d1;
9551d42ea71Sdrh     char d2[4];
9562b693d63Sdan     if( 0==sqlite3IsLikeFunction(pWalker->pParse->db, pExpr, &d1, d2) ){
9572b693d63Sdan       pWalker->eCode = 1;
958e6912fd8Sdan     }
9592b693d63Sdan   }
9602b693d63Sdan 
961e6912fd8Sdan   return WRC_Continue;
962e6912fd8Sdan }
963e6912fd8Sdan 
964bec2476aSdrh 
965bec2476aSdrh /*
966bec2476aSdrh ** This function is called on every node of an expression tree used as an
967bec2476aSdrh ** argument to the OP_CursorHint instruction. If the node is a TK_COLUMN
9682f2b0278Sdrh ** that accesses any table other than the one identified by
9692f2b0278Sdrh ** CCurHint.iTabCur, then do the following:
970bec2476aSdrh **
971bec2476aSdrh **   1) allocate a register and code an OP_Column instruction to read
972bec2476aSdrh **      the specified column into the new register, and
973bec2476aSdrh **
974bec2476aSdrh **   2) transform the expression node to a TK_REGISTER node that reads
975bec2476aSdrh **      from the newly populated register.
9762f2b0278Sdrh **
9772f2b0278Sdrh ** Also, if the node is a TK_COLUMN that does access the table idenified
9782f2b0278Sdrh ** by pCCurHint.iTabCur, and an index is being used (which we will
9792f2b0278Sdrh ** know because CCurHint.pIdx!=0) then transform the TK_COLUMN into
9802f2b0278Sdrh ** an access of the index rather than the original table.
981bec2476aSdrh */
982bec2476aSdrh static int codeCursorHintFixExpr(Walker *pWalker, Expr *pExpr){
983bec2476aSdrh   int rc = WRC_Continue;
9842f2b0278Sdrh   struct CCurHint *pHint = pWalker->u.pCCurHint;
985be312ae9Sdan   if( pExpr->op==TK_COLUMN ){
9862f2b0278Sdrh     if( pExpr->iTable!=pHint->iTabCur ){
987bec2476aSdrh       int reg = ++pWalker->pParse->nMem;   /* Register for column value */
988e3e79213Sdan       sqlite3ExprCode(pWalker->pParse, pExpr, reg);
989bec2476aSdrh       pExpr->op = TK_REGISTER;
990bec2476aSdrh       pExpr->iTable = reg;
9912f2b0278Sdrh     }else if( pHint->pIdx!=0 ){
9922f2b0278Sdrh       pExpr->iTable = pHint->iIdxCur;
993b9bcf7caSdrh       pExpr->iColumn = sqlite3TableColumnToIndex(pHint->pIdx, pExpr->iColumn);
9942f2b0278Sdrh       assert( pExpr->iColumn>=0 );
9952f2b0278Sdrh     }
996bec2476aSdrh   }else if( pExpr->op==TK_AGG_FUNCTION ){
997bec2476aSdrh     /* An aggregate function in the WHERE clause of a query means this must
998bec2476aSdrh     ** be a correlated sub-query, and expression pExpr is an aggregate from
999bec2476aSdrh     ** the parent context. Do not walk the function arguments in this case.
1000bec2476aSdrh     **
1001bec2476aSdrh     ** todo: It should be possible to replace this node with a TK_REGISTER
1002bec2476aSdrh     ** expression, as the result of the expression must be stored in a
1003bec2476aSdrh     ** register at this point. The same holds for TK_AGG_COLUMN nodes. */
1004bec2476aSdrh     rc = WRC_Prune;
1005bec2476aSdrh   }
1006bec2476aSdrh   return rc;
1007bec2476aSdrh }
1008bec2476aSdrh 
1009bec2476aSdrh /*
1010bec2476aSdrh ** Insert an OP_CursorHint instruction if it is appropriate to do so.
1011bec2476aSdrh */
1012bec2476aSdrh static void codeCursorHint(
10137601294aSdrh   SrcItem *pTabItem,  /* FROM clause item */
1014b413a546Sdrh   WhereInfo *pWInfo,    /* The where clause */
1015b413a546Sdrh   WhereLevel *pLevel,   /* Which loop to provide hints for */
1016b413a546Sdrh   WhereTerm *pEndRange  /* Hint this end-of-scan boundary term if not NULL */
1017bec2476aSdrh ){
1018bec2476aSdrh   Parse *pParse = pWInfo->pParse;
1019bec2476aSdrh   sqlite3 *db = pParse->db;
1020bec2476aSdrh   Vdbe *v = pParse->pVdbe;
1021bec2476aSdrh   Expr *pExpr = 0;
10222f2b0278Sdrh   WhereLoop *pLoop = pLevel->pWLoop;
1023bec2476aSdrh   int iCur;
1024bec2476aSdrh   WhereClause *pWC;
1025bec2476aSdrh   WhereTerm *pTerm;
1026b413a546Sdrh   int i, j;
10272f2b0278Sdrh   struct CCurHint sHint;
10282f2b0278Sdrh   Walker sWalker;
1029bec2476aSdrh 
1030bec2476aSdrh   if( OptimizationDisabled(db, SQLITE_CursorHints) ) return;
10312f2b0278Sdrh   iCur = pLevel->iTabCur;
10322f2b0278Sdrh   assert( iCur==pWInfo->pTabList->a[pLevel->iFrom].iCursor );
10332f2b0278Sdrh   sHint.iTabCur = iCur;
10342f2b0278Sdrh   sHint.iIdxCur = pLevel->iIdxCur;
10352f2b0278Sdrh   sHint.pIdx = pLoop->u.btree.pIndex;
10362f2b0278Sdrh   memset(&sWalker, 0, sizeof(sWalker));
10372f2b0278Sdrh   sWalker.pParse = pParse;
10382f2b0278Sdrh   sWalker.u.pCCurHint = &sHint;
1039bec2476aSdrh   pWC = &pWInfo->sWC;
1040132f96fcSdrh   for(i=0; i<pWC->nBase; i++){
1041bec2476aSdrh     pTerm = &pWC->a[i];
1042bec2476aSdrh     if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
1043bec2476aSdrh     if( pTerm->prereqAll & pLevel->notReady ) continue;
1044b324cf75Sdan 
1045b324cf75Sdan     /* Any terms specified as part of the ON(...) clause for any LEFT
1046b324cf75Sdan     ** JOIN for which the current table is not the rhs are omitted
1047b324cf75Sdan     ** from the cursor-hint.
1048b324cf75Sdan     **
1049e6912fd8Sdan     ** If this table is the rhs of a LEFT JOIN, "IS" or "IS NULL" terms
1050e6912fd8Sdan     ** that were specified as part of the WHERE clause must be excluded.
1051e6912fd8Sdan     ** This is to address the following:
1052b324cf75Sdan     **
1053b324cf75Sdan     **   SELECT ... t1 LEFT JOIN t2 ON (t1.a=t2.b) WHERE t2.c IS NULL;
1054b324cf75Sdan     **
1055e6912fd8Sdan     ** Say there is a single row in t2 that matches (t1.a=t2.b), but its
1056e6912fd8Sdan     ** t2.c values is not NULL. If the (t2.c IS NULL) constraint is
1057e6912fd8Sdan     ** pushed down to the cursor, this row is filtered out, causing
1058e6912fd8Sdan     ** SQLite to synthesize a row of NULL values. Which does match the
1059e6912fd8Sdan     ** WHERE clause, and so the query returns a row. Which is incorrect.
1060e6912fd8Sdan     **
1061e6912fd8Sdan     ** For the same reason, WHERE terms such as:
1062e6912fd8Sdan     **
1063e6912fd8Sdan     **   WHERE 1 = (t2.c IS NULL)
1064e6912fd8Sdan     **
1065e6912fd8Sdan     ** are also excluded. See codeCursorHintIsOrFunction() for details.
1066b324cf75Sdan     */
1067b324cf75Sdan     if( pTabItem->fg.jointype & JT_LEFT ){
1068e6912fd8Sdan       Expr *pExpr = pTerm->pExpr;
1069e6912fd8Sdan       if( !ExprHasProperty(pExpr, EP_FromJoin)
1070d1985262Sdrh        || pExpr->w.iJoin!=pTabItem->iCursor
1071b324cf75Sdan       ){
1072e6912fd8Sdan         sWalker.eCode = 0;
1073e6912fd8Sdan         sWalker.xExprCallback = codeCursorHintIsOrFunction;
1074e6912fd8Sdan         sqlite3WalkExpr(&sWalker, pTerm->pExpr);
1075e6912fd8Sdan         if( sWalker.eCode ) continue;
1076b324cf75Sdan       }
1077b324cf75Sdan     }else{
1078bec2476aSdrh       if( ExprHasProperty(pTerm->pExpr, EP_FromJoin) ) continue;
1079b324cf75Sdan     }
1080b413a546Sdrh 
1081b413a546Sdrh     /* All terms in pWLoop->aLTerm[] except pEndRange are used to initialize
1082bcf40a7fSdrh     ** the cursor.  These terms are not needed as hints for a pure range
1083bcf40a7fSdrh     ** scan (that has no == terms) so omit them. */
1084bcf40a7fSdrh     if( pLoop->u.btree.nEq==0 && pTerm!=pEndRange ){
1085bcf40a7fSdrh       for(j=0; j<pLoop->nLTerm && pLoop->aLTerm[j]!=pTerm; j++){}
1086bcf40a7fSdrh       if( j<pLoop->nLTerm ) continue;
1087b413a546Sdrh     }
1088b413a546Sdrh 
1089b413a546Sdrh     /* No subqueries or non-deterministic functions allowed */
1090bec2476aSdrh     if( sqlite3ExprContainsSubquery(pTerm->pExpr) ) continue;
1091b413a546Sdrh 
1092b413a546Sdrh     /* For an index scan, make sure referenced columns are actually in
1093b413a546Sdrh     ** the index. */
10942f2b0278Sdrh     if( sHint.pIdx!=0 ){
10952f2b0278Sdrh       sWalker.eCode = 0;
10962f2b0278Sdrh       sWalker.xExprCallback = codeCursorHintCheckExpr;
10972f2b0278Sdrh       sqlite3WalkExpr(&sWalker, pTerm->pExpr);
10982f2b0278Sdrh       if( sWalker.eCode ) continue;
10992f2b0278Sdrh     }
1100b413a546Sdrh 
1101b413a546Sdrh     /* If we survive all prior tests, that means this term is worth hinting */
1102d5c851c1Sdrh     pExpr = sqlite3ExprAnd(pParse, pExpr, sqlite3ExprDup(db, pTerm->pExpr, 0));
1103bec2476aSdrh   }
1104bec2476aSdrh   if( pExpr!=0 ){
1105bec2476aSdrh     sWalker.xExprCallback = codeCursorHintFixExpr;
1106bec2476aSdrh     sqlite3WalkExpr(&sWalker, pExpr);
11072f2b0278Sdrh     sqlite3VdbeAddOp4(v, OP_CursorHint,
11082f2b0278Sdrh                       (sHint.pIdx ? sHint.iIdxCur : sHint.iTabCur), 0, 0,
11092f2b0278Sdrh                       (const char*)pExpr, P4_EXPR);
1110bec2476aSdrh   }
1111bec2476aSdrh }
1112bec2476aSdrh #else
1113b324cf75Sdan # define codeCursorHint(A,B,C,D)  /* No-op */
1114bec2476aSdrh #endif /* SQLITE_ENABLE_CURSOR_HINTS */
11156f82e85aSdrh 
11166f82e85aSdrh /*
1117de892d96Sdan ** Cursor iCur is open on an intkey b-tree (a table). Register iRowid contains
1118de892d96Sdan ** a rowid value just read from cursor iIdxCur, open on index pIdx. This
1119de892d96Sdan ** function generates code to do a deferred seek of cursor iCur to the
1120de892d96Sdan ** rowid stored in register iRowid.
1121de892d96Sdan **
1122de892d96Sdan ** Normally, this is just:
1123de892d96Sdan **
1124170ad68aSdrh **   OP_DeferredSeek $iCur $iRowid
1125de892d96Sdan **
11267fd6a776Sdrh ** Which causes a seek on $iCur to the row with rowid $iRowid.
11277fd6a776Sdrh **
1128de892d96Sdan ** However, if the scan currently being coded is a branch of an OR-loop and
11297fd6a776Sdrh ** the statement currently being coded is a SELECT, then additional information
11307fd6a776Sdrh ** is added that might allow OP_Column to omit the seek and instead do its
11317fd6a776Sdrh ** lookup on the index, thus avoiding an expensive seek operation.  To
11327fd6a776Sdrh ** enable this optimization, the P3 of OP_DeferredSeek is set to iIdxCur
11337fd6a776Sdrh ** and P4 is set to an array of integers containing one entry for each column
11347fd6a776Sdrh ** in the table.  For each table column, if the column is the i'th
11357fd6a776Sdrh ** column of the index, then the corresponding array entry is set to (i+1).
11367fd6a776Sdrh ** If the column does not appear in the index at all, the array entry is set
11377fd6a776Sdrh ** to 0.  The OP_Column opcode can check this array to see if the column it
11387fd6a776Sdrh ** wants is in the index and if it is, it will substitute the index cursor
11397fd6a776Sdrh ** and column number and continue with those new values, rather than seeking
11407fd6a776Sdrh ** the table cursor.
1141de892d96Sdan */
1142de892d96Sdan static void codeDeferredSeek(
1143de892d96Sdan   WhereInfo *pWInfo,              /* Where clause context */
1144de892d96Sdan   Index *pIdx,                    /* Index scan is using */
1145de892d96Sdan   int iCur,                       /* Cursor for IPK b-tree */
1146de892d96Sdan   int iIdxCur                     /* Index cursor */
1147de892d96Sdan ){
1148de892d96Sdan   Parse *pParse = pWInfo->pParse; /* Parse context */
1149de892d96Sdan   Vdbe *v = pParse->pVdbe;        /* Vdbe to generate code within */
1150de892d96Sdan 
1151de892d96Sdan   assert( iIdxCur>0 );
1152de892d96Sdan   assert( pIdx->aiColumn[pIdx->nColumn-1]==-1 );
1153de892d96Sdan 
1154be3da241Sdrh   pWInfo->bDeferredSeek = 1;
1155170ad68aSdrh   sqlite3VdbeAddOp3(v, OP_DeferredSeek, iIdxCur, 0, iCur);
1156c583719bSdrh   if( (pWInfo->wctrlFlags & (WHERE_OR_SUBCLAUSE|WHERE_RIGHT_JOIN))
1157cddb6ba0Sdan    && DbMaskAllZero(sqlite3ParseToplevel(pParse)->writeMask)
1158de892d96Sdan   ){
1159de892d96Sdan     int i;
1160de892d96Sdan     Table *pTab = pIdx->pTable;
1161abc38158Sdrh     u32 *ai = (u32*)sqlite3DbMallocZero(pParse->db, sizeof(u32)*(pTab->nCol+1));
1162de892d96Sdan     if( ai ){
1163b1702026Sdrh       ai[0] = pTab->nCol;
1164de892d96Sdan       for(i=0; i<pIdx->nColumn-1; i++){
11654fb24c82Sdrh         int x1, x2;
1166de892d96Sdan         assert( pIdx->aiColumn[i]<pTab->nCol );
11674fb24c82Sdrh         x1 = pIdx->aiColumn[i];
11684fb24c82Sdrh         x2 = sqlite3TableColumnToStorage(pTab, x1);
11694fb24c82Sdrh         testcase( x1!=x2 );
1170bde3a4f6Smistachkin         if( x1>=0 ) ai[x2+1] = i+1;
1171de892d96Sdan       }
1172de892d96Sdan       sqlite3VdbeChangeP4(v, -1, (char*)ai, P4_INTARRAY);
1173de892d96Sdan     }
1174de892d96Sdan   }
1175de892d96Sdan }
1176de892d96Sdan 
1177553168c7Sdan /*
1178553168c7Sdan ** If the expression passed as the second argument is a vector, generate
1179553168c7Sdan ** code to write the first nReg elements of the vector into an array
1180553168c7Sdan ** of registers starting with iReg.
1181553168c7Sdan **
1182553168c7Sdan ** If the expression is not a vector, then nReg must be passed 1. In
1183553168c7Sdan ** this case, generate code to evaluate the expression and leave the
1184553168c7Sdan ** result in register iReg.
1185553168c7Sdan */
118671c57db0Sdan static void codeExprOrVector(Parse *pParse, Expr *p, int iReg, int nReg){
118771c57db0Sdan   assert( nReg>0 );
1188d03024d8Sdan   if( p && sqlite3ExprIsVector(p) ){
1189f9b2e05cSdan #ifndef SQLITE_OMIT_SUBQUERY
1190a4eeccdfSdrh     if( ExprUseXSelect(p) ){
1191f9b2e05cSdan       Vdbe *v = pParse->pVdbe;
119285bcdce2Sdrh       int iSelect;
119385bcdce2Sdrh       assert( p->op==TK_SELECT );
119485bcdce2Sdrh       iSelect = sqlite3CodeSubselect(pParse, p);
1195f9b2e05cSdan       sqlite3VdbeAddOp3(v, OP_Copy, iSelect, iReg, nReg-1);
1196f9b2e05cSdan     }else
1197f9b2e05cSdan #endif
1198f9b2e05cSdan     {
119971c57db0Sdan       int i;
1200a4eeccdfSdrh       const ExprList *pList;
1201a4eeccdfSdrh       assert( ExprUseXList(p) );
1202a4eeccdfSdrh       pList = p->x.pList;
120371c57db0Sdan       assert( nReg<=pList->nExpr );
120471c57db0Sdan       for(i=0; i<nReg; i++){
120571c57db0Sdan         sqlite3ExprCode(pParse, pList->a[i].pExpr, iReg+i);
120671c57db0Sdan       }
120771c57db0Sdan     }
120871c57db0Sdan   }else{
1209151446e7Sdan     assert( nReg==1 || pParse->nErr );
121071c57db0Sdan     sqlite3ExprCode(pParse, p, iReg);
121171c57db0Sdan   }
121271c57db0Sdan }
121371c57db0Sdan 
1214eac5fc04Sdrh /* An instance of the IdxExprTrans object carries information about a
1215eac5fc04Sdrh ** mapping from an expression on table columns into a column in an index
1216eac5fc04Sdrh ** down through the Walker.
1217eac5fc04Sdrh */
1218aca19e19Sdrh typedef struct IdxExprTrans {
1219aca19e19Sdrh   Expr *pIdxExpr;    /* The index expression */
1220aca19e19Sdrh   int iTabCur;       /* The cursor of the corresponding table */
1221aca19e19Sdrh   int iIdxCur;       /* The cursor for the index */
1222aca19e19Sdrh   int iIdxCol;       /* The column for the index */
1223c7476735Sdrh   int iTabCol;       /* The column for the table */
122436e678bcSdrh   WhereInfo *pWInfo; /* Complete WHERE clause information */
122536e678bcSdrh   sqlite3 *db;       /* Database connection (for malloc()) */
1226aca19e19Sdrh } IdxExprTrans;
1227aca19e19Sdrh 
122836e678bcSdrh /*
122936e678bcSdrh ** Preserve pExpr on the WhereETrans list of the WhereInfo.
123036e678bcSdrh */
123136e678bcSdrh static void preserveExpr(IdxExprTrans *pTrans, Expr *pExpr){
123236e678bcSdrh   WhereExprMod *pNew;
123336e678bcSdrh   pNew = sqlite3DbMallocRaw(pTrans->db, sizeof(*pNew));
123436e678bcSdrh   if( pNew==0 ) return;
123536e678bcSdrh   pNew->pNext = pTrans->pWInfo->pExprMods;
123636e678bcSdrh   pTrans->pWInfo->pExprMods = pNew;
123736e678bcSdrh   pNew->pExpr = pExpr;
123836e678bcSdrh   memcpy(&pNew->orig, pExpr, sizeof(*pExpr));
123936e678bcSdrh }
124036e678bcSdrh 
1241eac5fc04Sdrh /* The walker node callback used to transform matching expressions into
1242eac5fc04Sdrh ** a reference to an index column for an index on an expression.
1243eac5fc04Sdrh **
1244eac5fc04Sdrh ** If pExpr matches, then transform it into a reference to the index column
1245eac5fc04Sdrh ** that contains the value of pExpr.
1246eac5fc04Sdrh */
1247aca19e19Sdrh static int whereIndexExprTransNode(Walker *p, Expr *pExpr){
1248aca19e19Sdrh   IdxExprTrans *pX = p->u.pIdxTrans;
12495aa550cfSdan   if( sqlite3ExprCompare(0, pExpr, pX->pIdxExpr, pX->iTabCur)==0 ){
125036e678bcSdrh     preserveExpr(pX, pExpr);
1251b6ce71bdSdan     pExpr->affExpr = sqlite3ExprAffinity(pExpr);
1252aca19e19Sdrh     pExpr->op = TK_COLUMN;
1253aca19e19Sdrh     pExpr->iTable = pX->iIdxCur;
1254aca19e19Sdrh     pExpr->iColumn = pX->iIdxCol;
12556c1c85caSdrh     testcase( ExprHasProperty(pExpr, EP_Skip) );
12566c1c85caSdrh     testcase( ExprHasProperty(pExpr, EP_Unlikely) );
1257477572b9Sdrh     ExprClearProperty(pExpr, EP_Skip|EP_Unlikely|EP_WinFunc|EP_Subrtn);
1258477572b9Sdrh     pExpr->y.pTab = 0;
1259aca19e19Sdrh     return WRC_Prune;
1260aca19e19Sdrh   }else{
1261aca19e19Sdrh     return WRC_Continue;
1262aca19e19Sdrh   }
1263aca19e19Sdrh }
1264aca19e19Sdrh 
1265c7476735Sdrh #ifndef SQLITE_OMIT_GENERATED_COLUMNS
1266c7476735Sdrh /* A walker node callback that translates a column reference to a table
1267c7476735Sdrh ** into a corresponding column reference of an index.
1268c7476735Sdrh */
1269c7476735Sdrh static int whereIndexExprTransColumn(Walker *p, Expr *pExpr){
1270c7476735Sdrh   if( pExpr->op==TK_COLUMN ){
1271c7476735Sdrh     IdxExprTrans *pX = p->u.pIdxTrans;
1272c7476735Sdrh     if( pExpr->iTable==pX->iTabCur && pExpr->iColumn==pX->iTabCol ){
1273477572b9Sdrh       assert( ExprUseYTab(pExpr) && pExpr->y.pTab!=0 );
127436e678bcSdrh       preserveExpr(pX, pExpr);
127557f7ece7Sdrh       pExpr->affExpr = sqlite3TableColumnAffinity(pExpr->y.pTab,pExpr->iColumn);
1276c7476735Sdrh       pExpr->iTable = pX->iIdxCur;
1277c7476735Sdrh       pExpr->iColumn = pX->iIdxCol;
12784485ac1aSdrh       pExpr->y.pTab = 0;
1279c7476735Sdrh     }
1280c7476735Sdrh   }
1281c7476735Sdrh   return WRC_Continue;
1282c7476735Sdrh }
1283c7476735Sdrh #endif /* SQLITE_OMIT_GENERATED_COLUMNS */
1284c7476735Sdrh 
1285aca19e19Sdrh /*
1286f49759bfSdrh ** For an indexes on expression X, locate every instance of expression X
1287f49759bfSdrh ** in pExpr and change that subexpression into a reference to the appropriate
1288f49759bfSdrh ** column of the index.
1289c7476735Sdrh **
1290c7476735Sdrh ** 2019-10-24: Updated to also translate references to a VIRTUAL column in
1291c7476735Sdrh ** the table into references to the corresponding (stored) column of the
1292c7476735Sdrh ** index.
1293aca19e19Sdrh */
1294aca19e19Sdrh static void whereIndexExprTrans(
1295aca19e19Sdrh   Index *pIdx,      /* The Index */
1296aca19e19Sdrh   int iTabCur,      /* Cursor of the table that is being indexed */
1297aca19e19Sdrh   int iIdxCur,      /* Cursor of the index itself */
1298aca19e19Sdrh   WhereInfo *pWInfo /* Transform expressions in this WHERE clause */
1299aca19e19Sdrh ){
1300aca19e19Sdrh   int iIdxCol;               /* Column number of the index */
1301aca19e19Sdrh   ExprList *aColExpr;        /* Expressions that are indexed */
1302c7476735Sdrh   Table *pTab;
1303aca19e19Sdrh   Walker w;
1304aca19e19Sdrh   IdxExprTrans x;
1305aca19e19Sdrh   aColExpr = pIdx->aColExpr;
1306c7476735Sdrh   if( aColExpr==0 && !pIdx->bHasVCol ){
1307c7476735Sdrh     /* The index does not reference any expressions or virtual columns
1308c7476735Sdrh     ** so no translations are needed. */
1309c7476735Sdrh     return;
1310c7476735Sdrh   }
1311c7476735Sdrh   pTab = pIdx->pTable;
1312aca19e19Sdrh   memset(&w, 0, sizeof(w));
1313aca19e19Sdrh   w.u.pIdxTrans = &x;
1314aca19e19Sdrh   x.iTabCur = iTabCur;
1315aca19e19Sdrh   x.iIdxCur = iIdxCur;
131636e678bcSdrh   x.pWInfo = pWInfo;
131736e678bcSdrh   x.db = pWInfo->pParse->db;
1318c7476735Sdrh   for(iIdxCol=0; iIdxCol<pIdx->nColumn; iIdxCol++){
1319c7476735Sdrh     i16 iRef = pIdx->aiColumn[iIdxCol];
1320c7476735Sdrh     if( iRef==XN_EXPR ){
13217d4c94bcSdrh       assert( aColExpr!=0 && aColExpr->a[iIdxCol].pExpr!=0 );
1322aca19e19Sdrh       x.pIdxExpr = aColExpr->a[iIdxCol].pExpr;
1323e86f3402Sdrh       if( sqlite3ExprIsConstant(x.pIdxExpr) ) continue;
1324c7476735Sdrh       w.xExprCallback = whereIndexExprTransNode;
1325c7476735Sdrh #ifndef SQLITE_OMIT_GENERATED_COLUMNS
1326ed0c3485Sdrh     }else if( iRef>=0
1327ed0c3485Sdrh        && (pTab->aCol[iRef].colFlags & COLFLAG_VIRTUAL)!=0
132865b40093Sdrh        && ((pTab->aCol[iRef].colFlags & COLFLAG_HASCOLL)==0
132965b40093Sdrh            || sqlite3StrICmp(sqlite3ColumnColl(&pTab->aCol[iRef]),
133065b40093Sdrh                                                sqlite3StrBINARY)==0)
1331ed0c3485Sdrh     ){
1332ed0c3485Sdrh       /* Check to see if there are direct references to generated columns
1333ed0c3485Sdrh       ** that are contained in the index.  Pulling the generated column
1334ed0c3485Sdrh       ** out of the index is an optimization only - the main table is always
1335ed0c3485Sdrh       ** available if the index cannot be used.  To avoid unnecessary
1336ed0c3485Sdrh       ** complication, omit this optimization if the collating sequence for
1337ed0c3485Sdrh       ** the column is non-standard */
1338c7476735Sdrh       x.iTabCol = iRef;
1339c7476735Sdrh       w.xExprCallback = whereIndexExprTransColumn;
1340c7476735Sdrh #endif /* SQLITE_OMIT_GENERATED_COLUMNS */
1341c7476735Sdrh     }else{
1342c7476735Sdrh       continue;
1343c7476735Sdrh     }
1344c7476735Sdrh     x.iIdxCol = iIdxCol;
1345aca19e19Sdrh     sqlite3WalkExpr(&w, pWInfo->pWhere);
1346aca19e19Sdrh     sqlite3WalkExprList(&w, pWInfo->pOrderBy);
1347aca19e19Sdrh     sqlite3WalkExprList(&w, pWInfo->pResultSet);
1348aca19e19Sdrh   }
1349aca19e19Sdrh }
1350aca19e19Sdrh 
1351de892d96Sdan /*
1352610f11deSdrh ** The pTruth expression is always true because it is the WHERE clause
1353b531aa8fSdrh ** a partial index that is driving a query loop.  Look through all of the
1354b531aa8fSdrh ** WHERE clause terms on the query, and if any of those terms must be
1355b531aa8fSdrh ** true because pTruth is true, then mark those WHERE clause terms as
1356b531aa8fSdrh ** coded.
1357b531aa8fSdrh */
1358b531aa8fSdrh static void whereApplyPartialIndexConstraints(
1359b531aa8fSdrh   Expr *pTruth,
1360b531aa8fSdrh   int iTabCur,
1361b531aa8fSdrh   WhereClause *pWC
1362b531aa8fSdrh ){
1363b531aa8fSdrh   int i;
1364b531aa8fSdrh   WhereTerm *pTerm;
1365b531aa8fSdrh   while( pTruth->op==TK_AND ){
1366b531aa8fSdrh     whereApplyPartialIndexConstraints(pTruth->pLeft, iTabCur, pWC);
1367b531aa8fSdrh     pTruth = pTruth->pRight;
1368b531aa8fSdrh   }
1369b531aa8fSdrh   for(i=0, pTerm=pWC->a; i<pWC->nTerm; i++, pTerm++){
1370b531aa8fSdrh     Expr *pExpr;
1371b531aa8fSdrh     if( pTerm->wtFlags & TERM_CODED ) continue;
1372b531aa8fSdrh     pExpr = pTerm->pExpr;
1373b531aa8fSdrh     if( sqlite3ExprCompare(0, pExpr, pTruth, iTabCur)==0 ){
1374b531aa8fSdrh       pTerm->wtFlags |= TERM_CODED;
1375b531aa8fSdrh     }
1376b531aa8fSdrh   }
1377b531aa8fSdrh }
1378b531aa8fSdrh 
137935685d3eSdrh /*
13806ae49e67Sdrh ** This routine is called right after An OP_Filter has been generated and
13816ae49e67Sdrh ** before the corresponding index search has been performed.  This routine
13826ae49e67Sdrh ** checks to see if there are additional Bloom filters in inner loops that
13836ae49e67Sdrh ** can be checked prior to doing the index lookup.  If there are available
13846ae49e67Sdrh ** inner-loop Bloom filters, then evaluate those filters now, before the
13856ae49e67Sdrh ** index lookup.  The idea is that a Bloom filter check is way faster than
13866ae49e67Sdrh ** an index lookup, and the Bloom filter might return false, meaning that
13876ae49e67Sdrh ** the index lookup can be skipped.
13886ae49e67Sdrh **
13896ae49e67Sdrh ** We know that an inner loop uses a Bloom filter because it has the
13906ae49e67Sdrh ** WhereLevel.regFilter set.  If an inner-loop Bloom filter is checked,
13915a4ac1ccSdrh ** then clear the WhereLevel.regFilter value to prevent the Bloom filter
13926ae49e67Sdrh ** from being checked a second time when the inner loop is evaluated.
139335685d3eSdrh */
139435685d3eSdrh static SQLITE_NOINLINE void filterPullDown(
139535685d3eSdrh   Parse *pParse,       /* Parsing context */
139635685d3eSdrh   WhereInfo *pWInfo,   /* Complete information about the WHERE clause */
139735685d3eSdrh   int iLevel,          /* Which level of pWInfo->a[] should be coded */
139835685d3eSdrh   int addrNxt,         /* Jump here to bypass inner loops */
139935685d3eSdrh   Bitmask notReady     /* Loops that are not ready */
140035685d3eSdrh ){
140135685d3eSdrh   while( ++iLevel < pWInfo->nLevel ){
140235685d3eSdrh     WhereLevel *pLevel = &pWInfo->a[iLevel];
140335685d3eSdrh     WhereLoop *pLoop = pLevel->pWLoop;
14046ae49e67Sdrh     if( pLevel->regFilter==0 ) continue;
140556945695Sdrh     if( pLevel->pWLoop->nSkip ) continue;
140627a9e1f6Sdrh     /*         ,--- Because sqlite3ConstructBloomFilter() has will not have set
1407a11c5e22Sdrh     **  vvvvv--'    pLevel->regFilter if this were true. */
1408a11c5e22Sdrh     if( NEVER(pLoop->prereq & notReady) ) continue;
140935685d3eSdrh     if( pLoop->wsFlags & WHERE_IPK ){
141035685d3eSdrh       WhereTerm *pTerm = pLoop->aLTerm[0];
14117e910f64Sdrh       int regRowid;
141235685d3eSdrh       assert( pTerm!=0 );
141335685d3eSdrh       assert( pTerm->pExpr!=0 );
141435685d3eSdrh       testcase( pTerm->wtFlags & TERM_VIRTUAL );
14157e910f64Sdrh       regRowid = sqlite3GetTempReg(pParse);
14167e910f64Sdrh       regRowid = codeEqualityTerm(pParse, pTerm, pLevel, 0, 0, regRowid);
141735685d3eSdrh       sqlite3VdbeAddOp4Int(pParse->pVdbe, OP_Filter, pLevel->regFilter,
141835685d3eSdrh                            addrNxt, regRowid, 1);
141935685d3eSdrh       VdbeCoverage(pParse->pVdbe);
142035685d3eSdrh     }else{
142135685d3eSdrh       u16 nEq = pLoop->u.btree.nEq;
142235685d3eSdrh       int r1;
142335685d3eSdrh       char *zStartAff;
142435685d3eSdrh 
142535685d3eSdrh       assert( pLoop->wsFlags & WHERE_INDEXED );
1426dc56dc93Sdrh       assert( (pLoop->wsFlags & WHERE_COLUMN_IN)==0 );
142735685d3eSdrh       r1 = codeAllEqualityTerms(pParse,pLevel,0,0,&zStartAff);
142835685d3eSdrh       codeApplyAffinity(pParse, r1, nEq, zStartAff);
142935685d3eSdrh       sqlite3DbFree(pParse->db, zStartAff);
143035685d3eSdrh       sqlite3VdbeAddOp4Int(pParse->pVdbe, OP_Filter, pLevel->regFilter,
143135685d3eSdrh                            addrNxt, r1, nEq);
143235685d3eSdrh       VdbeCoverage(pParse->pVdbe);
143335685d3eSdrh     }
14346ae49e67Sdrh     pLevel->regFilter = 0;
143535685d3eSdrh   }
143635685d3eSdrh }
143735685d3eSdrh 
1438b531aa8fSdrh /*
14396f82e85aSdrh ** Generate code for the start of the iLevel-th loop in the WHERE clause
14406f82e85aSdrh ** implementation described by pWInfo.
14416f82e85aSdrh */
14426f82e85aSdrh Bitmask sqlite3WhereCodeOneLoopStart(
144347df8a2cSdrh   Parse *pParse,       /* Parsing context */
144447df8a2cSdrh   Vdbe *v,             /* Prepared statement under construction */
14456f82e85aSdrh   WhereInfo *pWInfo,   /* Complete information about the WHERE clause */
14466f82e85aSdrh   int iLevel,          /* Which level of pWInfo->a[] should be coded */
144747df8a2cSdrh   WhereLevel *pLevel,  /* The current level pointer */
14486f82e85aSdrh   Bitmask notReady     /* Which tables are currently available */
14496f82e85aSdrh ){
14506f82e85aSdrh   int j, k;            /* Loop counters */
14516f82e85aSdrh   int iCur;            /* The VDBE cursor for the table */
14526f82e85aSdrh   int addrNxt;         /* Where to jump to continue with the next IN case */
14536f82e85aSdrh   int bRev;            /* True if we need to scan in reverse order */
14546f82e85aSdrh   WhereLoop *pLoop;    /* The WhereLoop object being coded */
14556f82e85aSdrh   WhereClause *pWC;    /* Decomposition of the entire WHERE clause */
14566f82e85aSdrh   WhereTerm *pTerm;               /* A WHERE clause term */
14576f82e85aSdrh   sqlite3 *db;                    /* Database connection */
14587601294aSdrh   SrcItem *pTabItem;              /* FROM clause term being coded */
14596f82e85aSdrh   int addrBrk;                    /* Jump here to break out of the loop */
14603a3b420aSdrh   int addrHalt;                   /* addrBrk for the outermost loop */
14616f82e85aSdrh   int addrCont;                   /* Jump here to continue with next cycle */
14626f82e85aSdrh   int iRowidReg = 0;        /* Rowid is stored in this register, if not zero */
14636f82e85aSdrh   int iReleaseReg = 0;      /* Temp register to free before returning */
14646f654a40Sdan   Index *pIdx = 0;          /* Index used by loop (if any) */
1465ebc63013Sdan   int iLoop;                /* Iteration of constraint generator loop */
14666f82e85aSdrh 
14676f82e85aSdrh   pWC = &pWInfo->sWC;
14686f82e85aSdrh   db = pParse->db;
14696f82e85aSdrh   pLoop = pLevel->pWLoop;
14706f82e85aSdrh   pTabItem = &pWInfo->pTabList->a[pLevel->iFrom];
14716f82e85aSdrh   iCur = pTabItem->iCursor;
14726f82e85aSdrh   pLevel->notReady = notReady & ~sqlite3WhereGetMask(&pWInfo->sMaskSet, iCur);
14736f82e85aSdrh   bRev = (pWInfo->revMask>>iLevel)&1;
14746f82e85aSdrh   VdbeModuleComment((v, "Begin WHERE-loop%d: %s",iLevel,pTabItem->pTab->zName));
1475118efd16Sdrh #if WHERETRACE_ENABLED /* 0x20800 */
1476118efd16Sdrh   if( sqlite3WhereTrace & 0x800 ){
1477a4b2df5cSdrh     sqlite3DebugPrintf("Coding level %d of %d:  notReady=%llx  iFrom=%d\n",
1478a4b2df5cSdrh        iLevel, pWInfo->nLevel, (u64)notReady, pLevel->iFrom);
1479118efd16Sdrh     sqlite3WhereLoopPrint(pLoop, pWC);
1480118efd16Sdrh   }
1481118efd16Sdrh   if( sqlite3WhereTrace & 0x20000 ){
1482f1bb31e2Sdrh     if( iLevel==0 ){
1483f1bb31e2Sdrh       sqlite3DebugPrintf("WHERE clause being coded:\n");
1484f1bb31e2Sdrh       sqlite3TreeViewExpr(0, pWInfo->pWhere, 0);
1485f1bb31e2Sdrh     }
1486f1bb31e2Sdrh     sqlite3DebugPrintf("All WHERE-clause terms before coding:\n");
1487118efd16Sdrh     sqlite3WhereClausePrint(pWC);
1488118efd16Sdrh   }
1489118efd16Sdrh #endif
14906f82e85aSdrh 
14916f82e85aSdrh   /* Create labels for the "break" and "continue" instructions
14926f82e85aSdrh   ** for the current loop.  Jump to addrBrk to break out of a loop.
14936f82e85aSdrh   ** Jump to cont to go immediately to the next iteration of the
14946f82e85aSdrh   ** loop.
14956f82e85aSdrh   **
14966f82e85aSdrh   ** When there is an IN operator, we also have a "addrNxt" label that
14976f82e85aSdrh   ** means to continue with the next IN value combination.  When
14986f82e85aSdrh   ** there are no IN operators in the constraints, the "addrNxt" label
14996f82e85aSdrh   ** is the same as "addrBrk".
15006f82e85aSdrh   */
1501ec4ccdbcSdrh   addrBrk = pLevel->addrBrk = pLevel->addrNxt = sqlite3VdbeMakeLabel(pParse);
1502ec4ccdbcSdrh   addrCont = pLevel->addrCont = sqlite3VdbeMakeLabel(pParse);
15036f82e85aSdrh 
15046f82e85aSdrh   /* If this is the right table of a LEFT OUTER JOIN, allocate and
15056f82e85aSdrh   ** initialize a memory cell that records if this table matches any
15066f82e85aSdrh   ** row of the left table of the join.
15076f82e85aSdrh   */
1508c583719bSdrh   assert( (pWInfo->wctrlFlags & (WHERE_OR_SUBCLAUSE|WHERE_RIGHT_JOIN))
1509820fcd2cSdan        || pLevel->iFrom>0 || (pTabItem[0].fg.jointype & JT_LEFT)==0
1510820fcd2cSdan   );
15118a48b9c0Sdrh   if( pLevel->iFrom>0 && (pTabItem[0].fg.jointype & JT_LEFT)!=0 ){
15126f82e85aSdrh     pLevel->iLeftJoin = ++pParse->nMem;
15136f82e85aSdrh     sqlite3VdbeAddOp2(v, OP_Integer, 0, pLevel->iLeftJoin);
15146f82e85aSdrh     VdbeComment((v, "init LEFT JOIN no-match flag"));
15156f82e85aSdrh   }
15166f82e85aSdrh 
15173a3b420aSdrh   /* Compute a safe address to jump to if we discover that the table for
15183a3b420aSdrh   ** this loop is empty and can never contribute content. */
1519d875c7eeSdrh   for(j=iLevel; j>0; j--){
1520d875c7eeSdrh     if( pWInfo->a[j].iLeftJoin ) break;
1521d875c7eeSdrh     if( pWInfo->a[j].pRJ ) break;
1522d875c7eeSdrh   }
15233a3b420aSdrh   addrHalt = pWInfo->a[j].addrBrk;
15243a3b420aSdrh 
15256f82e85aSdrh   /* Special case of a FROM clause subquery implemented as a co-routine */
15268a48b9c0Sdrh   if( pTabItem->fg.viaCoroutine ){
15276f82e85aSdrh     int regYield = pTabItem->regReturn;
15286f82e85aSdrh     sqlite3VdbeAddOp3(v, OP_InitCoroutine, regYield, 0, pTabItem->addrFillSub);
15296f82e85aSdrh     pLevel->p2 =  sqlite3VdbeAddOp2(v, OP_Yield, regYield, addrBrk);
15306f82e85aSdrh     VdbeCoverage(v);
1531fef37760Sdrh     VdbeComment((v, "next row of %s", pTabItem->pTab->zName));
15326f82e85aSdrh     pLevel->op = OP_Goto;
15336f82e85aSdrh   }else
15346f82e85aSdrh 
15356f82e85aSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
15366f82e85aSdrh   if(  (pLoop->wsFlags & WHERE_VIRTUALTABLE)!=0 ){
15376f82e85aSdrh     /* Case 1:  The table is a virtual-table.  Use the VFilter and VNext
15386f82e85aSdrh     **          to access the data.
15396f82e85aSdrh     */
15406f82e85aSdrh     int iReg;   /* P3 Value for OP_VFilter */
15416f82e85aSdrh     int addrNotFound;
15426f82e85aSdrh     int nConstraint = pLoop->nLTerm;
15436f82e85aSdrh 
15446f82e85aSdrh     iReg = sqlite3GetTempRange(pParse, nConstraint+2);
15456f82e85aSdrh     addrNotFound = pLevel->addrBrk;
15466f82e85aSdrh     for(j=0; j<nConstraint; j++){
15476f82e85aSdrh       int iTarget = iReg+j+2;
15486f82e85aSdrh       pTerm = pLoop->aLTerm[j];
1549599d5764Sdrh       if( NEVER(pTerm==0) ) continue;
15506f82e85aSdrh       if( pTerm->eOperator & WO_IN ){
15510fe7e7d9Sdrh         if( SMASKBIT32(j) & pLoop->u.vtab.mHandleIn ){
15520fe7e7d9Sdrh           int iTab = pParse->nTab++;
15530fe7e7d9Sdrh           int iCache = ++pParse->nMem;
15540fe7e7d9Sdrh           sqlite3CodeRhsOfIN(pParse, pTerm->pExpr, iTab);
15550fe7e7d9Sdrh           sqlite3VdbeAddOp3(v, OP_VInitIn, iTab, iTarget, iCache);
15560fe7e7d9Sdrh         }else{
15576f82e85aSdrh           codeEqualityTerm(pParse, pTerm, pLevel, j, bRev, iTarget);
15586f82e85aSdrh           addrNotFound = pLevel->addrNxt;
15590fe7e7d9Sdrh         }
15606f82e85aSdrh       }else{
15616256c1c2Sdan         Expr *pRight = pTerm->pExpr->pRight;
15626256c1c2Sdan         codeExprOrVector(pParse, pRight, iTarget, 1);
15638f2c0b59Sdrh         if( pTerm->eMatchOp==SQLITE_INDEX_CONSTRAINT_OFFSET
15648f2c0b59Sdrh          && pLoop->u.vtab.bOmitOffset
15658f2c0b59Sdrh         ){
15668f2c0b59Sdrh           assert( pTerm->eOperator==WO_AUX );
15678f2c0b59Sdrh           assert( pWInfo->pLimit!=0 );
15688f2c0b59Sdrh           assert( pWInfo->pLimit->iOffset>0 );
15698f2c0b59Sdrh           sqlite3VdbeAddOp2(v, OP_Integer, 0, pWInfo->pLimit->iOffset);
15708f2c0b59Sdrh           VdbeComment((v,"Zero OFFSET counter"));
15718f2c0b59Sdrh         }
15726256c1c2Sdan       }
15736f82e85aSdrh     }
15746f82e85aSdrh     sqlite3VdbeAddOp2(v, OP_Integer, pLoop->u.vtab.idxNum, iReg);
15756f82e85aSdrh     sqlite3VdbeAddOp2(v, OP_Integer, nConstraint, iReg+1);
15766f82e85aSdrh     sqlite3VdbeAddOp4(v, OP_VFilter, iCur, addrNotFound, iReg,
15776f82e85aSdrh                       pLoop->u.vtab.idxStr,
1578861b1307Sdrh                       pLoop->u.vtab.needFree ? P4_DYNAMIC : P4_STATIC);
15796f82e85aSdrh     VdbeCoverage(v);
15806f82e85aSdrh     pLoop->u.vtab.needFree = 0;
1581bc2e9514Sdrh     /* An OOM inside of AddOp4(OP_VFilter) instruction above might have freed
1582bc2e9514Sdrh     ** the u.vtab.idxStr.  NULL it out to prevent a use-after-free */
1583bc2e9514Sdrh     if( db->mallocFailed ) pLoop->u.vtab.idxStr = 0;
15846f82e85aSdrh     pLevel->p1 = iCur;
1585354474adSdan     pLevel->op = pWInfo->eOnePass ? OP_Noop : OP_VNext;
15866f82e85aSdrh     pLevel->p2 = sqlite3VdbeCurrentAddr(v);
15870475629dSdrh     assert( (pLoop->wsFlags & WHERE_MULTI_OR)==0 );
15886d6ea42aSdrh 
15896d6ea42aSdrh     for(j=0; j<nConstraint; j++){
1590dbc49161Sdrh       pTerm = pLoop->aLTerm[j];
1591dbc49161Sdrh       if( j<16 && (pLoop->u.vtab.omitMask>>j)&1 ){
1592dbc49161Sdrh         disableTerm(pLevel, pTerm);
15936d6ea42aSdrh         continue;
15946d6ea42aSdrh       }
15956d6ea42aSdrh       if( (pTerm->eOperator & WO_IN)!=0
15966d6ea42aSdrh        && (SMASKBIT32(j) & pLoop->u.vtab.mHandleIn)==0
15976d6ea42aSdrh        && !db->mallocFailed
15986d6ea42aSdrh       ){
1599dbc49161Sdrh         Expr *pCompare;  /* The comparison operator */
1600dbc49161Sdrh         Expr *pRight;    /* RHS of the comparison */
1601dbc49161Sdrh         VdbeOp *pOp;     /* Opcode to access the value of the IN constraint */
16026d6ea42aSdrh         int iIn;         /* IN loop corresponding to the j-th constraint */
1603dbc49161Sdrh 
1604dbc49161Sdrh         /* Reload the constraint value into reg[iReg+j+2].  The same value
1605dbc49161Sdrh         ** was loaded into the same register prior to the OP_VFilter, but
1606dbc49161Sdrh         ** the xFilter implementation might have changed the datatype or
16076d6ea42aSdrh         ** encoding of the value in the register, so it *must* be reloaded.
16086d6ea42aSdrh         */
16096d6ea42aSdrh         for(iIn=0; ALWAYS(iIn<pLevel->u.in.nIn); iIn++){
161068748ec5Sdrh           pOp = sqlite3VdbeGetOp(v, pLevel->u.in.aInLoop[iIn].addrInTop);
16116d6ea42aSdrh           if( (pOp->opcode==OP_Column && pOp->p3==iReg+j+2)
16126d6ea42aSdrh            || (pOp->opcode==OP_Rowid && pOp->p2==iReg+j+2)
16136d6ea42aSdrh           ){
1614dbc49161Sdrh             testcase( pOp->opcode==OP_Rowid );
1615dbc49161Sdrh             sqlite3VdbeAddOp3(v, pOp->opcode, pOp->p1, pOp->p2, pOp->p3);
16166d6ea42aSdrh             break;
16176d6ea42aSdrh           }
1618dbc49161Sdrh         }
1619dbc49161Sdrh 
1620dbc49161Sdrh         /* Generate code that will continue to the next row if
16216d6ea42aSdrh         ** the IN constraint is not satisfied
16226d6ea42aSdrh         */
1623abfd35eaSdrh         pCompare = sqlite3PExpr(pParse, TK_EQ, 0, 0);
16246d6ea42aSdrh         if( !db->mallocFailed ){
16256d6ea42aSdrh           int iFld = pTerm->u.x.iField;
16266d6ea42aSdrh           Expr *pLeft = pTerm->pExpr->pLeft;
16276d6ea42aSdrh           assert( pLeft!=0 );
16286d6ea42aSdrh           if( iFld>0 ){
16296d6ea42aSdrh             assert( pLeft->op==TK_VECTOR );
16306d6ea42aSdrh             assert( ExprUseXList(pLeft) );
16316d6ea42aSdrh             assert( iFld<=pLeft->x.pList->nExpr );
16326d6ea42aSdrh             pCompare->pLeft = pLeft->x.pList->a[iFld-1].pExpr;
16336d6ea42aSdrh           }else{
16346d6ea42aSdrh             pCompare->pLeft = pLeft;
16356d6ea42aSdrh           }
1636dbc49161Sdrh           pCompare->pRight = pRight = sqlite3Expr(db, TK_REGISTER, 0);
1637237b2b71Sdrh           if( pRight ){
1638237b2b71Sdrh             pRight->iTable = iReg+j+2;
1639d03f77aeSdan             sqlite3ExprIfFalse(
1640d03f77aeSdan                 pParse, pCompare, pLevel->addrCont, SQLITE_JUMPIFNULL
1641d03f77aeSdan             );
1642237b2b71Sdrh           }
1643dbc49161Sdrh           pCompare->pLeft = 0;
16446d6ea42aSdrh         }
1645dbc49161Sdrh         sqlite3ExprDelete(db, pCompare);
1646dbc49161Sdrh       }
1647dbc49161Sdrh     }
16486d6ea42aSdrh 
1649ba26faa3Sdrh     /* These registers need to be preserved in case there is an IN operator
1650ba26faa3Sdrh     ** loop.  So we could deallocate the registers here (and potentially
1651ba26faa3Sdrh     ** reuse them later) if (pLoop->wsFlags & WHERE_IN_ABLE)==0.  But it seems
1652ba26faa3Sdrh     ** simpler and safer to simply not reuse the registers.
1653ba26faa3Sdrh     **
1654ba26faa3Sdrh     **    sqlite3ReleaseTempRange(pParse, iReg, nConstraint+2);
1655ba26faa3Sdrh     */
16566f82e85aSdrh   }else
16576f82e85aSdrh #endif /* SQLITE_OMIT_VIRTUALTABLE */
16586f82e85aSdrh 
16596f82e85aSdrh   if( (pLoop->wsFlags & WHERE_IPK)!=0
16606f82e85aSdrh    && (pLoop->wsFlags & (WHERE_COLUMN_IN|WHERE_COLUMN_EQ))!=0
16616f82e85aSdrh   ){
16626f82e85aSdrh     /* Case 2:  We can directly reference a single row using an
16636f82e85aSdrh     **          equality comparison against the ROWID field.  Or
16646f82e85aSdrh     **          we reference multiple rows using a "rowid IN (...)"
16656f82e85aSdrh     **          construct.
16666f82e85aSdrh     */
16676f82e85aSdrh     assert( pLoop->u.btree.nEq==1 );
16686f82e85aSdrh     pTerm = pLoop->aLTerm[0];
16696f82e85aSdrh     assert( pTerm!=0 );
16706f82e85aSdrh     assert( pTerm->pExpr!=0 );
16716f82e85aSdrh     testcase( pTerm->wtFlags & TERM_VIRTUAL );
16726f82e85aSdrh     iReleaseReg = ++pParse->nMem;
16736f82e85aSdrh     iRowidReg = codeEqualityTerm(pParse, pTerm, pLevel, 0, bRev, iReleaseReg);
16746f82e85aSdrh     if( iRowidReg!=iReleaseReg ) sqlite3ReleaseTempReg(pParse, iReleaseReg);
16756f82e85aSdrh     addrNxt = pLevel->addrNxt;
16762db144c3Sdrh     if( pLevel->regFilter ){
16772db144c3Sdrh       sqlite3VdbeAddOp4Int(v, OP_Filter, pLevel->regFilter, addrNxt,
16782db144c3Sdrh                            iRowidReg, 1);
1679067c60cfSdrh       VdbeCoverage(v);
168035685d3eSdrh       filterPullDown(pParse, pWInfo, iLevel, addrNxt, notReady);
16812db144c3Sdrh     }
1682eeb9565aSdrh     sqlite3VdbeAddOp3(v, OP_SeekRowid, iCur, addrNxt, iRowidReg);
16836f82e85aSdrh     VdbeCoverage(v);
16846f82e85aSdrh     pLevel->op = OP_Noop;
16856f82e85aSdrh   }else if( (pLoop->wsFlags & WHERE_IPK)!=0
16866f82e85aSdrh          && (pLoop->wsFlags & WHERE_COLUMN_RANGE)!=0
16876f82e85aSdrh   ){
16886f82e85aSdrh     /* Case 3:  We have an inequality comparison against the ROWID field.
16896f82e85aSdrh     */
16906f82e85aSdrh     int testOp = OP_Noop;
16916f82e85aSdrh     int start;
16926f82e85aSdrh     int memEndValue = 0;
16936f82e85aSdrh     WhereTerm *pStart, *pEnd;
16946f82e85aSdrh 
16956f82e85aSdrh     j = 0;
16966f82e85aSdrh     pStart = pEnd = 0;
16976f82e85aSdrh     if( pLoop->wsFlags & WHERE_BTM_LIMIT ) pStart = pLoop->aLTerm[j++];
16986f82e85aSdrh     if( pLoop->wsFlags & WHERE_TOP_LIMIT ) pEnd = pLoop->aLTerm[j++];
16996f82e85aSdrh     assert( pStart!=0 || pEnd!=0 );
17006f82e85aSdrh     if( bRev ){
17016f82e85aSdrh       pTerm = pStart;
17026f82e85aSdrh       pStart = pEnd;
17036f82e85aSdrh       pEnd = pTerm;
17046f82e85aSdrh     }
1705b324cf75Sdan     codeCursorHint(pTabItem, pWInfo, pLevel, pEnd);
17066f82e85aSdrh     if( pStart ){
17076f82e85aSdrh       Expr *pX;             /* The expression that defines the start bound */
17086f82e85aSdrh       int r1, rTemp;        /* Registers for holding the start boundary */
170919ff12ddSdan       int op;               /* Cursor seek operation */
17106f82e85aSdrh 
17116f82e85aSdrh       /* The following constant maps TK_xx codes into corresponding
17126f82e85aSdrh       ** seek opcodes.  It depends on a particular ordering of TK_xx
17136f82e85aSdrh       */
17146f82e85aSdrh       const u8 aMoveOp[] = {
17156f82e85aSdrh            /* TK_GT */  OP_SeekGT,
17166f82e85aSdrh            /* TK_LE */  OP_SeekLE,
17176f82e85aSdrh            /* TK_LT */  OP_SeekLT,
17186f82e85aSdrh            /* TK_GE */  OP_SeekGE
17196f82e85aSdrh       };
17206f82e85aSdrh       assert( TK_LE==TK_GT+1 );      /* Make sure the ordering.. */
17216f82e85aSdrh       assert( TK_LT==TK_GT+2 );      /*  ... of the TK_xx values... */
17226f82e85aSdrh       assert( TK_GE==TK_GT+3 );      /*  ... is correcct. */
17236f82e85aSdrh 
17246f82e85aSdrh       assert( (pStart->wtFlags & TERM_VNULL)==0 );
17256f82e85aSdrh       testcase( pStart->wtFlags & TERM_VIRTUAL );
17266f82e85aSdrh       pX = pStart->pExpr;
17276f82e85aSdrh       assert( pX!=0 );
17286f82e85aSdrh       testcase( pStart->leftCursor!=iCur ); /* transitive constraints */
1729625015e0Sdan       if( sqlite3ExprIsVector(pX->pRight) ){
173019ff12ddSdan         r1 = rTemp = sqlite3GetTempReg(pParse);
173119ff12ddSdan         codeExprOrVector(pParse, pX->pRight, r1, 1);
17324d1c6845Sdrh         testcase( pX->op==TK_GT );
17334d1c6845Sdrh         testcase( pX->op==TK_GE );
17344d1c6845Sdrh         testcase( pX->op==TK_LT );
17354d1c6845Sdrh         testcase( pX->op==TK_LE );
17364d1c6845Sdrh         op = aMoveOp[((pX->op - TK_GT - 1) & 0x3) | 0x1];
17374d1c6845Sdrh         assert( pX->op!=TK_GT || op==OP_SeekGE );
17384d1c6845Sdrh         assert( pX->op!=TK_GE || op==OP_SeekGE );
17394d1c6845Sdrh         assert( pX->op!=TK_LT || op==OP_SeekLE );
17404d1c6845Sdrh         assert( pX->op!=TK_LE || op==OP_SeekLE );
174119ff12ddSdan       }else{
17426f82e85aSdrh         r1 = sqlite3ExprCodeTemp(pParse, pX->pRight, &rTemp);
174319ff12ddSdan         disableTerm(pLevel, pStart);
174419ff12ddSdan         op = aMoveOp[(pX->op - TK_GT)];
174519ff12ddSdan       }
174619ff12ddSdan       sqlite3VdbeAddOp3(v, op, iCur, addrBrk, r1);
17476f82e85aSdrh       VdbeComment((v, "pk"));
17486f82e85aSdrh       VdbeCoverageIf(v, pX->op==TK_GT);
17496f82e85aSdrh       VdbeCoverageIf(v, pX->op==TK_LE);
17506f82e85aSdrh       VdbeCoverageIf(v, pX->op==TK_LT);
17516f82e85aSdrh       VdbeCoverageIf(v, pX->op==TK_GE);
17526f82e85aSdrh       sqlite3ReleaseTempReg(pParse, rTemp);
17536f82e85aSdrh     }else{
17543a3b420aSdrh       sqlite3VdbeAddOp2(v, bRev ? OP_Last : OP_Rewind, iCur, addrHalt);
17556f82e85aSdrh       VdbeCoverageIf(v, bRev==0);
17566f82e85aSdrh       VdbeCoverageIf(v, bRev!=0);
17576f82e85aSdrh     }
17586f82e85aSdrh     if( pEnd ){
17596f82e85aSdrh       Expr *pX;
17606f82e85aSdrh       pX = pEnd->pExpr;
17616f82e85aSdrh       assert( pX!=0 );
17626f82e85aSdrh       assert( (pEnd->wtFlags & TERM_VNULL)==0 );
17636f82e85aSdrh       testcase( pEnd->leftCursor!=iCur ); /* Transitive constraints */
17646f82e85aSdrh       testcase( pEnd->wtFlags & TERM_VIRTUAL );
17656f82e85aSdrh       memEndValue = ++pParse->nMem;
176619ff12ddSdan       codeExprOrVector(pParse, pX->pRight, memEndValue, 1);
1767625015e0Sdan       if( 0==sqlite3ExprIsVector(pX->pRight)
1768625015e0Sdan        && (pX->op==TK_LT || pX->op==TK_GT)
1769625015e0Sdan       ){
17706f82e85aSdrh         testOp = bRev ? OP_Le : OP_Ge;
17716f82e85aSdrh       }else{
17726f82e85aSdrh         testOp = bRev ? OP_Lt : OP_Gt;
17736f82e85aSdrh       }
1774553168c7Sdan       if( 0==sqlite3ExprIsVector(pX->pRight) ){
17756f82e85aSdrh         disableTerm(pLevel, pEnd);
17766f82e85aSdrh       }
1777553168c7Sdan     }
17786f82e85aSdrh     start = sqlite3VdbeCurrentAddr(v);
17796f82e85aSdrh     pLevel->op = bRev ? OP_Prev : OP_Next;
17806f82e85aSdrh     pLevel->p1 = iCur;
17816f82e85aSdrh     pLevel->p2 = start;
17826f82e85aSdrh     assert( pLevel->p5==0 );
17836f82e85aSdrh     if( testOp!=OP_Noop ){
17846f82e85aSdrh       iRowidReg = ++pParse->nMem;
17856f82e85aSdrh       sqlite3VdbeAddOp2(v, OP_Rowid, iCur, iRowidReg);
17866f82e85aSdrh       sqlite3VdbeAddOp3(v, testOp, memEndValue, addrBrk, iRowidReg);
17876f82e85aSdrh       VdbeCoverageIf(v, testOp==OP_Le);
17886f82e85aSdrh       VdbeCoverageIf(v, testOp==OP_Lt);
17896f82e85aSdrh       VdbeCoverageIf(v, testOp==OP_Ge);
17906f82e85aSdrh       VdbeCoverageIf(v, testOp==OP_Gt);
17916f82e85aSdrh       sqlite3VdbeChangeP5(v, SQLITE_AFF_NUMERIC | SQLITE_JUMPIFNULL);
17926f82e85aSdrh     }
17936f82e85aSdrh   }else if( pLoop->wsFlags & WHERE_INDEXED ){
17946f82e85aSdrh     /* Case 4: A scan using an index.
17956f82e85aSdrh     **
17966f82e85aSdrh     **         The WHERE clause may contain zero or more equality
17976f82e85aSdrh     **         terms ("==" or "IN" operators) that refer to the N
17986f82e85aSdrh     **         left-most columns of the index. It may also contain
17996f82e85aSdrh     **         inequality constraints (>, <, >= or <=) on the indexed
18006f82e85aSdrh     **         column that immediately follows the N equalities. Only
18016f82e85aSdrh     **         the right-most column can be an inequality - the rest must
18026f82e85aSdrh     **         use the "==" and "IN" operators. For example, if the
18036f82e85aSdrh     **         index is on (x,y,z), then the following clauses are all
18046f82e85aSdrh     **         optimized:
18056f82e85aSdrh     **
18066f82e85aSdrh     **            x=5
18076f82e85aSdrh     **            x=5 AND y=10
18086f82e85aSdrh     **            x=5 AND y<10
18096f82e85aSdrh     **            x=5 AND y>5 AND y<10
18106f82e85aSdrh     **            x=5 AND y=5 AND z<=10
18116f82e85aSdrh     **
18126f82e85aSdrh     **         The z<10 term of the following cannot be used, only
18136f82e85aSdrh     **         the x=5 term:
18146f82e85aSdrh     **
18156f82e85aSdrh     **            x=5 AND z<10
18166f82e85aSdrh     **
18176f82e85aSdrh     **         N may be zero if there are inequality constraints.
18186f82e85aSdrh     **         If there are no inequality constraints, then N is at
18196f82e85aSdrh     **         least one.
18206f82e85aSdrh     **
18216f82e85aSdrh     **         This case is also used when there are no WHERE clause
18226f82e85aSdrh     **         constraints but an index is selected anyway, in order
18236f82e85aSdrh     **         to force the output order to conform to an ORDER BY.
18246f82e85aSdrh     */
18256f82e85aSdrh     static const u8 aStartOp[] = {
18266f82e85aSdrh       0,
18276f82e85aSdrh       0,
18286f82e85aSdrh       OP_Rewind,           /* 2: (!start_constraints && startEq &&  !bRev) */
18296f82e85aSdrh       OP_Last,             /* 3: (!start_constraints && startEq &&   bRev) */
18306f82e85aSdrh       OP_SeekGT,           /* 4: (start_constraints  && !startEq && !bRev) */
18316f82e85aSdrh       OP_SeekLT,           /* 5: (start_constraints  && !startEq &&  bRev) */
18326f82e85aSdrh       OP_SeekGE,           /* 6: (start_constraints  &&  startEq && !bRev) */
18336f82e85aSdrh       OP_SeekLE            /* 7: (start_constraints  &&  startEq &&  bRev) */
18346f82e85aSdrh     };
18356f82e85aSdrh     static const u8 aEndOp[] = {
18366f82e85aSdrh       OP_IdxGE,            /* 0: (end_constraints && !bRev && !endEq) */
18376f82e85aSdrh       OP_IdxGT,            /* 1: (end_constraints && !bRev &&  endEq) */
18386f82e85aSdrh       OP_IdxLE,            /* 2: (end_constraints &&  bRev && !endEq) */
18396f82e85aSdrh       OP_IdxLT,            /* 3: (end_constraints &&  bRev &&  endEq) */
18406f82e85aSdrh     };
18416f82e85aSdrh     u16 nEq = pLoop->u.btree.nEq;     /* Number of == or IN terms */
184271c57db0Sdan     u16 nBtm = pLoop->u.btree.nBtm;   /* Length of BTM vector */
184371c57db0Sdan     u16 nTop = pLoop->u.btree.nTop;   /* Length of TOP vector */
18446f82e85aSdrh     int regBase;                 /* Base register holding constraint values */
18456f82e85aSdrh     WhereTerm *pRangeStart = 0;  /* Inequality constraint at range start */
18466f82e85aSdrh     WhereTerm *pRangeEnd = 0;    /* Inequality constraint at range end */
18476f82e85aSdrh     int startEq;                 /* True if range start uses ==, >= or <= */
18486f82e85aSdrh     int endEq;                   /* True if range end uses ==, >= or <= */
18496f82e85aSdrh     int start_constraints;       /* Start of range is constrained */
18506f82e85aSdrh     int nConstraint;             /* Number of constraint terms */
18516f82e85aSdrh     int iIdxCur;                 /* The VDBE cursor for the index */
18526f82e85aSdrh     int nExtraReg = 0;           /* Number of extra registers needed */
18536f82e85aSdrh     int op;                      /* Instruction opcode */
18546f82e85aSdrh     char *zStartAff;             /* Affinity for start of range constraint */
1855b7ca2177Sdan     char *zEndAff = 0;           /* Affinity for end of range constraint */
18566f82e85aSdrh     u8 bSeekPastNull = 0;        /* True to seek past initial nulls */
18576f82e85aSdrh     u8 bStopAtNull = 0;          /* Add condition to terminate at NULLs */
185847df8a2cSdrh     int omitTable;               /* True if we use the index only */
185974e1b861Sdrh     int regBignull = 0;          /* big-null flag register */
186004e70ce0Sdrh     int addrSeekScan = 0;        /* Opcode of the OP_SeekScan, if any */
18616f82e85aSdrh 
18626f82e85aSdrh     pIdx = pLoop->u.btree.pIndex;
18636f82e85aSdrh     iIdxCur = pLevel->iIdxCur;
18646f82e85aSdrh     assert( nEq>=pLoop->nSkip );
18656f82e85aSdrh 
18666f82e85aSdrh     /* Find any inequality constraint terms for the start and end
18676f82e85aSdrh     ** of the range.
18686f82e85aSdrh     */
18696f82e85aSdrh     j = nEq;
18706f82e85aSdrh     if( pLoop->wsFlags & WHERE_BTM_LIMIT ){
18716f82e85aSdrh       pRangeStart = pLoop->aLTerm[j++];
187271c57db0Sdan       nExtraReg = MAX(nExtraReg, pLoop->u.btree.nBtm);
18736f82e85aSdrh       /* Like optimization range constraints always occur in pairs */
18746f82e85aSdrh       assert( (pRangeStart->wtFlags & TERM_LIKEOPT)==0 ||
18756f82e85aSdrh               (pLoop->wsFlags & WHERE_TOP_LIMIT)!=0 );
18766f82e85aSdrh     }
18776f82e85aSdrh     if( pLoop->wsFlags & WHERE_TOP_LIMIT ){
18786f82e85aSdrh       pRangeEnd = pLoop->aLTerm[j++];
187971c57db0Sdan       nExtraReg = MAX(nExtraReg, pLoop->u.btree.nTop);
188041d2e66eSdrh #ifndef SQLITE_LIKE_DOESNT_MATCH_BLOBS
18816f82e85aSdrh       if( (pRangeEnd->wtFlags & TERM_LIKEOPT)!=0 ){
18826f82e85aSdrh         assert( pRangeStart!=0 );                     /* LIKE opt constraints */
18836f82e85aSdrh         assert( pRangeStart->wtFlags & TERM_LIKEOPT );   /* occur in pairs */
188444aebff2Sdrh         pLevel->iLikeRepCntr = (u32)++pParse->nMem;
188544aebff2Sdrh         sqlite3VdbeAddOp2(v, OP_Integer, 1, (int)pLevel->iLikeRepCntr);
18866f82e85aSdrh         VdbeComment((v, "LIKE loop counter"));
18876f82e85aSdrh         pLevel->addrLikeRep = sqlite3VdbeCurrentAddr(v);
188844aebff2Sdrh         /* iLikeRepCntr actually stores 2x the counter register number.  The
188944aebff2Sdrh         ** bottom bit indicates whether the search order is ASC or DESC. */
189044aebff2Sdrh         testcase( bRev );
189144aebff2Sdrh         testcase( pIdx->aSortOrder[nEq]==SQLITE_SO_DESC );
189244aebff2Sdrh         assert( (bRev & ~1)==0 );
189344aebff2Sdrh         pLevel->iLikeRepCntr <<=1;
189444aebff2Sdrh         pLevel->iLikeRepCntr |= bRev ^ (pIdx->aSortOrder[nEq]==SQLITE_SO_DESC);
18956f82e85aSdrh       }
189641d2e66eSdrh #endif
189748590fcbSdrh       if( pRangeStart==0 ){
189848590fcbSdrh         j = pIdx->aiColumn[nEq];
189948590fcbSdrh         if( (j>=0 && pIdx->pTable->aCol[j].notNull==0) || j==XN_EXPR ){
19006f82e85aSdrh           bSeekPastNull = 1;
19016f82e85aSdrh         }
19026f82e85aSdrh       }
190348590fcbSdrh     }
19046f82e85aSdrh     assert( pRangeEnd==0 || (pRangeEnd->wtFlags & TERM_VNULL)==0 );
19056f82e85aSdrh 
190615750a26Sdan     /* If the WHERE_BIGNULL_SORT flag is set, then index column nEq uses
190715750a26Sdan     ** a non-default "big-null" sort (either ASC NULLS LAST or DESC NULLS
190815750a26Sdan     ** FIRST). In both cases separate ordered scans are made of those
190915750a26Sdan     ** index entries for which the column is null and for those for which
191015750a26Sdan     ** it is not. For an ASC sort, the non-NULL entries are scanned first.
191115750a26Sdan     ** For DESC, NULL entries are scanned first.
191215750a26Sdan     */
191315750a26Sdan     if( (pLoop->wsFlags & (WHERE_TOP_LIMIT|WHERE_BTM_LIMIT))==0
191415750a26Sdan      && (pLoop->wsFlags & WHERE_BIGNULL_SORT)!=0
191515750a26Sdan     ){
191615750a26Sdan       assert( bSeekPastNull==0 && nExtraReg==0 && nBtm==0 && nTop==0 );
191715750a26Sdan       assert( pRangeEnd==0 && pRangeStart==0 );
19184adb1d00Sdan       testcase( pLoop->nSkip>0 );
191915750a26Sdan       nExtraReg = 1;
192015750a26Sdan       bSeekPastNull = 1;
192115750a26Sdan       pLevel->regBignull = regBignull = ++pParse->nMem;
19227f05d52cSdrh       if( pLevel->iLeftJoin ){
19237f05d52cSdrh         sqlite3VdbeAddOp2(v, OP_Integer, 0, regBignull);
19247f05d52cSdrh       }
1925cc491f4bSdan       pLevel->addrBignull = sqlite3VdbeMakeLabel(pParse);
192615750a26Sdan     }
192715750a26Sdan 
19286f82e85aSdrh     /* If we are doing a reverse order scan on an ascending index, or
19296f82e85aSdrh     ** a forward order scan on a descending index, interchange the
19306f82e85aSdrh     ** start and end terms (pRangeStart and pRangeEnd).
19316f82e85aSdrh     */
19327ffb16b4Sdrh     if( (nEq<pIdx->nColumn && bRev==(pIdx->aSortOrder[nEq]==SQLITE_SO_ASC)) ){
19336f82e85aSdrh       SWAP(WhereTerm *, pRangeEnd, pRangeStart);
19346f82e85aSdrh       SWAP(u8, bSeekPastNull, bStopAtNull);
193571c57db0Sdan       SWAP(u8, nBtm, nTop);
19366f82e85aSdrh     }
19376f82e85aSdrh 
1938df1b52e7Sdan     if( iLevel>0 && (pLoop->wsFlags & WHERE_IN_SEEKSCAN)!=0 ){
1939df1b52e7Sdan       /* In case OP_SeekScan is used, ensure that the index cursor does not
1940df1b52e7Sdan       ** point to a valid row for the first iteration of this loop. */
1941df1b52e7Sdan       sqlite3VdbeAddOp1(v, OP_NullRow, iIdxCur);
1942df1b52e7Sdan     }
1943df1b52e7Sdan 
1944bcf40a7fSdrh     /* Generate code to evaluate all constraint terms using == or IN
1945bcf40a7fSdrh     ** and store the values of those terms in an array of registers
1946bcf40a7fSdrh     ** starting at regBase.
1947bcf40a7fSdrh     */
1948b324cf75Sdan     codeCursorHint(pTabItem, pWInfo, pLevel, pRangeEnd);
1949bcf40a7fSdrh     regBase = codeAllEqualityTerms(pParse,pLevel,bRev,nExtraReg,&zStartAff);
1950bcf40a7fSdrh     assert( zStartAff==0 || sqlite3Strlen30(zStartAff)>=nEq );
1951b7ca2177Sdan     if( zStartAff && nTop ){
1952b7ca2177Sdan       zEndAff = sqlite3DbStrDup(db, &zStartAff[nEq]);
1953b7ca2177Sdan     }
1954cc491f4bSdan     addrNxt = (regBignull ? pLevel->addrBignull : pLevel->addrNxt);
1955bcf40a7fSdrh 
19566f82e85aSdrh     testcase( pRangeStart && (pRangeStart->eOperator & WO_LE)!=0 );
19576f82e85aSdrh     testcase( pRangeStart && (pRangeStart->eOperator & WO_GE)!=0 );
19586f82e85aSdrh     testcase( pRangeEnd && (pRangeEnd->eOperator & WO_LE)!=0 );
19596f82e85aSdrh     testcase( pRangeEnd && (pRangeEnd->eOperator & WO_GE)!=0 );
19606f82e85aSdrh     startEq = !pRangeStart || pRangeStart->eOperator & (WO_LE|WO_GE);
19616f82e85aSdrh     endEq =   !pRangeEnd || pRangeEnd->eOperator & (WO_LE|WO_GE);
19626f82e85aSdrh     start_constraints = pRangeStart || nEq>0;
19636f82e85aSdrh 
19646f82e85aSdrh     /* Seek the index cursor to the start of the range. */
19656f82e85aSdrh     nConstraint = nEq;
19666f82e85aSdrh     if( pRangeStart ){
19676f82e85aSdrh       Expr *pRight = pRangeStart->pExpr->pRight;
196871c57db0Sdan       codeExprOrVector(pParse, pRight, regBase+nEq, nBtm);
19696f82e85aSdrh       whereLikeOptimizationStringFixup(v, pLevel, pRangeStart);
1970395a60daSdrh       if( (pRangeStart->wtFlags & TERM_VNULL)==0
19716f82e85aSdrh        && sqlite3ExprCanBeNull(pRight)
19726f82e85aSdrh       ){
19736f82e85aSdrh         sqlite3VdbeAddOp2(v, OP_IsNull, regBase+nEq, addrNxt);
19746f82e85aSdrh         VdbeCoverage(v);
19756f82e85aSdrh       }
19766f82e85aSdrh       if( zStartAff ){
1977e3c6b61cSdrh         updateRangeAffinityStr(pRight, nBtm, &zStartAff[nEq]);
19786f82e85aSdrh       }
197971c57db0Sdan       nConstraint += nBtm;
19806f82e85aSdrh       testcase( pRangeStart->wtFlags & TERM_VIRTUAL );
1981625015e0Sdan       if( sqlite3ExprIsVector(pRight)==0 ){
198271c57db0Sdan         disableTerm(pLevel, pRangeStart);
198371c57db0Sdan       }else{
198471c57db0Sdan         startEq = 1;
198571c57db0Sdan       }
1986426f4ab0Sdrh       bSeekPastNull = 0;
19876f82e85aSdrh     }else if( bSeekPastNull ){
19886f82e85aSdrh       startEq = 0;
19890086e078Sdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, regBase+nEq);
19906f82e85aSdrh       start_constraints = 1;
19910086e078Sdrh       nConstraint++;
199215750a26Sdan     }else if( regBignull ){
199315750a26Sdan       sqlite3VdbeAddOp2(v, OP_Null, 0, regBase+nEq);
199415750a26Sdan       start_constraints = 1;
199515750a26Sdan       nConstraint++;
19966f82e85aSdrh     }
19976f82e85aSdrh     codeApplyAffinity(pParse, regBase, nConstraint - bSeekPastNull, zStartAff);
19980bf2ad6aSdrh     if( pLoop->nSkip>0 && nConstraint==pLoop->nSkip ){
19990bf2ad6aSdrh       /* The skip-scan logic inside the call to codeAllEqualityConstraints()
20000bf2ad6aSdrh       ** above has already left the cursor sitting on the correct row,
20010bf2ad6aSdrh       ** so no further seeking is needed */
20020bf2ad6aSdrh     }else{
200315750a26Sdan       if( regBignull ){
2004ec3dda5bSdrh         sqlite3VdbeAddOp2(v, OP_Integer, 1, regBignull);
2005a31d3554Sdrh         VdbeComment((v, "NULL-scan pass ctr"));
200615750a26Sdan       }
20072db144c3Sdrh       if( pLevel->regFilter ){
20082db144c3Sdrh         sqlite3VdbeAddOp4Int(v, OP_Filter, pLevel->regFilter, addrNxt,
2009770dade2Sdrh                              regBase, nEq);
2010067c60cfSdrh         VdbeCoverage(v);
201135685d3eSdrh         filterPullDown(pParse, pWInfo, iLevel, addrNxt, notReady);
20122db144c3Sdrh       }
201315750a26Sdan 
20146f82e85aSdrh       op = aStartOp[(start_constraints<<2) + (startEq<<1) + bRev];
20156f82e85aSdrh       assert( op!=0 );
20167d14ffe4Sdrh       if( (pLoop->wsFlags & WHERE_IN_SEEKSCAN)!=0 && op==OP_SeekGE ){
201768cf0aceSdrh         assert( regBignull==0 );
20184f65b3bbSdrh         /* TUNING:  The OP_SeekScan opcode seeks to reduce the number
20194f65b3bbSdrh         ** of expensive seek operations by replacing a single seek with
20204f65b3bbSdrh         ** 1 or more step operations.  The question is, how many steps
20214f65b3bbSdrh         ** should we try before giving up and going with a seek.  The cost
20224f65b3bbSdrh         ** of a seek is proportional to the logarithm of the of the number
20234f65b3bbSdrh         ** of entries in the tree, so basing the number of steps to try
20244f65b3bbSdrh         ** on the estimated number of rows in the btree seems like a good
20254f65b3bbSdrh         ** guess. */
202604e70ce0Sdrh         addrSeekScan = sqlite3VdbeAddOp1(v, OP_SeekScan,
202704e70ce0Sdrh                                          (pIdx->aiRowLogEst[0]+9)/10);
20284f65b3bbSdrh         VdbeCoverage(v);
202968cf0aceSdrh       }
20306f82e85aSdrh       sqlite3VdbeAddOp4Int(v, op, iIdxCur, addrNxt, regBase, nConstraint);
20316f82e85aSdrh       VdbeCoverage(v);
20326f82e85aSdrh       VdbeCoverageIf(v, op==OP_Rewind);  testcase( op==OP_Rewind );
20336f82e85aSdrh       VdbeCoverageIf(v, op==OP_Last);    testcase( op==OP_Last );
20346f82e85aSdrh       VdbeCoverageIf(v, op==OP_SeekGT);  testcase( op==OP_SeekGT );
20356f82e85aSdrh       VdbeCoverageIf(v, op==OP_SeekGE);  testcase( op==OP_SeekGE );
20366f82e85aSdrh       VdbeCoverageIf(v, op==OP_SeekLE);  testcase( op==OP_SeekLE );
20376f82e85aSdrh       VdbeCoverageIf(v, op==OP_SeekLT);  testcase( op==OP_SeekLT );
2038ddd7421cSdan 
20390086e078Sdrh       assert( bSeekPastNull==0 || bStopAtNull==0 );
204015750a26Sdan       if( regBignull ){
20410086e078Sdrh         assert( bSeekPastNull==1 || bStopAtNull==1 );
20425f6a4ea2Sdrh         assert( bSeekPastNull==!bStopAtNull );
20430086e078Sdrh         assert( bStopAtNull==startEq );
2044ddd7421cSdan         sqlite3VdbeAddOp2(v, OP_Goto, 0, sqlite3VdbeCurrentAddr(v)+2);
20450086e078Sdrh         op = aStartOp[(nConstraint>1)*4 + 2 + bRev];
20460086e078Sdrh         sqlite3VdbeAddOp4Int(v, op, iIdxCur, addrNxt, regBase,
20470086e078Sdrh                              nConstraint-startEq);
2048505ae9deSdrh         VdbeCoverage(v);
2049505ae9deSdrh         VdbeCoverageIf(v, op==OP_Rewind);  testcase( op==OP_Rewind );
2050505ae9deSdrh         VdbeCoverageIf(v, op==OP_Last);    testcase( op==OP_Last );
2051505ae9deSdrh         VdbeCoverageIf(v, op==OP_SeekGE);  testcase( op==OP_SeekGE );
2052505ae9deSdrh         VdbeCoverageIf(v, op==OP_SeekLE);  testcase( op==OP_SeekLE );
20530086e078Sdrh         assert( op==OP_Rewind || op==OP_Last || op==OP_SeekGE || op==OP_SeekLE);
2054ddd7421cSdan       }
2055a6d2f8ebSdrh     }
20566f82e85aSdrh 
20576f82e85aSdrh     /* Load the value for the inequality constraint at the end of the
20586f82e85aSdrh     ** range (if any).
20596f82e85aSdrh     */
20606f82e85aSdrh     nConstraint = nEq;
20615d742e39Sdrh     assert( pLevel->p2==0 );
20626f82e85aSdrh     if( pRangeEnd ){
20636f82e85aSdrh       Expr *pRight = pRangeEnd->pExpr->pRight;
20645d742e39Sdrh       if( addrSeekScan ){
20655d742e39Sdrh         /* For a seek-scan that has a range on the lowest term of the index,
20665d742e39Sdrh         ** we have to make the top of the loop be code that sets the end
20675d742e39Sdrh         ** condition of the range.  Otherwise, the OP_SeekScan might jump
20685d742e39Sdrh         ** over that initialization, leaving the range-end value set to the
20695d742e39Sdrh         ** range-start value, resulting in a wrong answer.
20705d742e39Sdrh         ** See ticket 5981a8c041a3c2f3 (2021-11-02).
20715d742e39Sdrh         */
20725d742e39Sdrh         pLevel->p2 = sqlite3VdbeCurrentAddr(v);
20735d742e39Sdrh       }
207471c57db0Sdan       codeExprOrVector(pParse, pRight, regBase+nEq, nTop);
20756f82e85aSdrh       whereLikeOptimizationStringFixup(v, pLevel, pRangeEnd);
2076395a60daSdrh       if( (pRangeEnd->wtFlags & TERM_VNULL)==0
20776f82e85aSdrh        && sqlite3ExprCanBeNull(pRight)
20786f82e85aSdrh       ){
20796f82e85aSdrh         sqlite3VdbeAddOp2(v, OP_IsNull, regBase+nEq, addrNxt);
20806f82e85aSdrh         VdbeCoverage(v);
20816f82e85aSdrh       }
20820c36fca0Sdrh       if( zEndAff ){
2083e3c6b61cSdrh         updateRangeAffinityStr(pRight, nTop, zEndAff);
2084b7ca2177Sdan         codeApplyAffinity(pParse, regBase+nEq, nTop, zEndAff);
20850c36fca0Sdrh       }else{
20860c36fca0Sdrh         assert( pParse->db->mallocFailed );
20870c36fca0Sdrh       }
208871c57db0Sdan       nConstraint += nTop;
20896f82e85aSdrh       testcase( pRangeEnd->wtFlags & TERM_VIRTUAL );
209071c57db0Sdan 
2091625015e0Sdan       if( sqlite3ExprIsVector(pRight)==0 ){
209271c57db0Sdan         disableTerm(pLevel, pRangeEnd);
209371c57db0Sdan       }else{
209471c57db0Sdan         endEq = 1;
209571c57db0Sdan       }
20966f82e85aSdrh     }else if( bStopAtNull ){
209715750a26Sdan       if( regBignull==0 ){
20986f82e85aSdrh         sqlite3VdbeAddOp2(v, OP_Null, 0, regBase+nEq);
20996f82e85aSdrh         endEq = 0;
210015750a26Sdan       }
21016f82e85aSdrh       nConstraint++;
21026f82e85aSdrh     }
21036f82e85aSdrh     sqlite3DbFree(db, zStartAff);
2104b7ca2177Sdan     sqlite3DbFree(db, zEndAff);
21056f82e85aSdrh 
21066f82e85aSdrh     /* Top of the loop body */
21075d742e39Sdrh     if( pLevel->p2==0 ) pLevel->p2 = sqlite3VdbeCurrentAddr(v);
21086f82e85aSdrh 
21096f82e85aSdrh     /* Check if the index cursor is past the end of the range. */
21106f82e85aSdrh     if( nConstraint ){
211115750a26Sdan       if( regBignull ){
21125f6a4ea2Sdrh         /* Except, skip the end-of-range check while doing the NULL-scan */
2113ec3dda5bSdrh         sqlite3VdbeAddOp2(v, OP_IfNot, regBignull, sqlite3VdbeCurrentAddr(v)+3);
2114a31d3554Sdrh         VdbeComment((v, "If NULL-scan 2nd pass"));
2115505ae9deSdrh         VdbeCoverage(v);
211615750a26Sdan       }
21176f82e85aSdrh       op = aEndOp[bRev*2 + endEq];
21186f82e85aSdrh       sqlite3VdbeAddOp4Int(v, op, iIdxCur, addrNxt, regBase, nConstraint);
21196f82e85aSdrh       testcase( op==OP_IdxGT );  VdbeCoverageIf(v, op==OP_IdxGT );
21206f82e85aSdrh       testcase( op==OP_IdxGE );  VdbeCoverageIf(v, op==OP_IdxGE );
21216f82e85aSdrh       testcase( op==OP_IdxLT );  VdbeCoverageIf(v, op==OP_IdxLT );
21226f82e85aSdrh       testcase( op==OP_IdxLE );  VdbeCoverageIf(v, op==OP_IdxLE );
212304e70ce0Sdrh       if( addrSeekScan ) sqlite3VdbeJumpHere(v, addrSeekScan);
21246f82e85aSdrh     }
212515750a26Sdan     if( regBignull ){
21265f6a4ea2Sdrh       /* During a NULL-scan, check to see if we have reached the end of
21275f6a4ea2Sdrh       ** the NULLs */
21285f6a4ea2Sdrh       assert( bSeekPastNull==!bStopAtNull );
21295f6a4ea2Sdrh       assert( bSeekPastNull+bStopAtNull==1 );
21305f6a4ea2Sdrh       assert( nConstraint+bSeekPastNull>0 );
2131ec3dda5bSdrh       sqlite3VdbeAddOp2(v, OP_If, regBignull, sqlite3VdbeCurrentAddr(v)+2);
2132a31d3554Sdrh       VdbeComment((v, "If NULL-scan 1st pass"));
2133505ae9deSdrh       VdbeCoverage(v);
21345f6a4ea2Sdrh       op = aEndOp[bRev*2 + bSeekPastNull];
21355f6a4ea2Sdrh       sqlite3VdbeAddOp4Int(v, op, iIdxCur, addrNxt, regBase,
21365f6a4ea2Sdrh                            nConstraint+bSeekPastNull);
2137505ae9deSdrh       testcase( op==OP_IdxGT );  VdbeCoverageIf(v, op==OP_IdxGT );
2138505ae9deSdrh       testcase( op==OP_IdxGE );  VdbeCoverageIf(v, op==OP_IdxGE );
2139505ae9deSdrh       testcase( op==OP_IdxLT );  VdbeCoverageIf(v, op==OP_IdxLT );
2140505ae9deSdrh       testcase( op==OP_IdxLE );  VdbeCoverageIf(v, op==OP_IdxLE );
214115750a26Sdan     }
21426f82e85aSdrh 
2143f761d937Sdrh     if( (pLoop->wsFlags & WHERE_IN_EARLYOUT)!=0 ){
2144fa17e134Sdrh       sqlite3VdbeAddOp3(v, OP_SeekHit, iIdxCur, nEq, nEq);
21458c2b6d78Sdrh     }
21468c2b6d78Sdrh 
21476f82e85aSdrh     /* Seek the table cursor, if required */
214847df8a2cSdrh     omitTable = (pLoop->wsFlags & WHERE_IDX_ONLY)!=0
2149c583719bSdrh            && (pWInfo->wctrlFlags & (WHERE_OR_SUBCLAUSE|WHERE_RIGHT_JOIN))==0;
21506f82e85aSdrh     if( omitTable ){
21516f82e85aSdrh       /* pIdx is a covering index.  No need to access the main table. */
21526f82e85aSdrh     }else if( HasRowid(pIdx->pTable) ){
2153784c1b93Sdrh       codeDeferredSeek(pWInfo, pIdx, iCur, iIdxCur);
21546f82e85aSdrh     }else if( iCur!=iIdxCur ){
21556f82e85aSdrh       Index *pPk = sqlite3PrimaryKeyIndex(pIdx->pTable);
21566f82e85aSdrh       iRowidReg = sqlite3GetTempRange(pParse, pPk->nKeyCol);
21576f82e85aSdrh       for(j=0; j<pPk->nKeyCol; j++){
2158b9bcf7caSdrh         k = sqlite3TableColumnToIndex(pIdx, pPk->aiColumn[j]);
21596f82e85aSdrh         sqlite3VdbeAddOp3(v, OP_Column, iIdxCur, k, iRowidReg+j);
21606f82e85aSdrh       }
21616f82e85aSdrh       sqlite3VdbeAddOp4Int(v, OP_NotFound, iCur, addrCont,
21626f82e85aSdrh                            iRowidReg, pPk->nKeyCol); VdbeCoverage(v);
21636f82e85aSdrh     }
21646f82e85aSdrh 
2165db535390Sdrh     if( pLevel->iLeftJoin==0 ){
2166eac5fc04Sdrh       /* If pIdx is an index on one or more expressions, then look through
2167eac5fc04Sdrh       ** all the expressions in pWInfo and try to transform matching expressions
2168c7476735Sdrh       ** into reference to index columns.  Also attempt to translate references
2169c7476735Sdrh       ** to virtual columns in the table into references to (stored) columns
2170c7476735Sdrh       ** of the index.
21714da04f78Sdan       **
21724da04f78Sdan       ** Do not do this for the RHS of a LEFT JOIN. This is because the
21734da04f78Sdan       ** expression may be evaluated after OP_NullRow has been executed on
21744da04f78Sdan       ** the cursor. In this case it is important to do the full evaluation,
21754da04f78Sdan       ** as the result of the expression may not be NULL, even if all table
21765776c139Sdrh       ** column values are.  https://www.sqlite.org/src/info/7fa8049685b50b5a
21778851e100Sdrh       **
21788851e100Sdrh       ** Also, do not do this when processing one index an a multi-index
21798851e100Sdrh       ** OR clause, since the transformation will become invalid once we
21808851e100Sdrh       ** move forward to the next index.
21818851e100Sdrh       ** https://sqlite.org/src/info/4e8e4857d32d401f
2182eac5fc04Sdrh       */
2183c583719bSdrh       if( (pWInfo->wctrlFlags & (WHERE_OR_SUBCLAUSE|WHERE_RIGHT_JOIN))==0 ){
2184aca19e19Sdrh         whereIndexExprTrans(pIdx, iCur, iIdxCur, pWInfo);
21854da04f78Sdan       }
2186aca19e19Sdrh 
2187b531aa8fSdrh       /* If a partial index is driving the loop, try to eliminate WHERE clause
2188b531aa8fSdrh       ** terms from the query that must be true due to the WHERE clause of
2189db535390Sdrh       ** the partial index.
2190db535390Sdrh       **
2191db535390Sdrh       ** 2019-11-02 ticket 623eff57e76d45f6: This optimization does not work
2192db535390Sdrh       ** for a LEFT JOIN.
2193b531aa8fSdrh       */
2194b531aa8fSdrh       if( pIdx->pPartIdxWhere ){
2195b531aa8fSdrh         whereApplyPartialIndexConstraints(pIdx->pPartIdxWhere, iCur, pWC);
2196b531aa8fSdrh       }
2197db535390Sdrh     }else{
2198db535390Sdrh       testcase( pIdx->pPartIdxWhere );
219906fc2455Sdrh       /* The following assert() is not a requirement, merely an observation:
220006fc2455Sdrh       ** The OR-optimization doesn't work for the right hand table of
220106fc2455Sdrh       ** a LEFT JOIN: */
2202c583719bSdrh       assert( (pWInfo->wctrlFlags & (WHERE_OR_SUBCLAUSE|WHERE_RIGHT_JOIN))==0 );
2203db535390Sdrh     }
2204b531aa8fSdrh 
220571c57db0Sdan     /* Record the instruction used to terminate the loop. */
22066f82e85aSdrh     if( pLoop->wsFlags & WHERE_ONEROW ){
22076f82e85aSdrh       pLevel->op = OP_Noop;
22086f82e85aSdrh     }else if( bRev ){
22096f82e85aSdrh       pLevel->op = OP_Prev;
22106f82e85aSdrh     }else{
22116f82e85aSdrh       pLevel->op = OP_Next;
22126f82e85aSdrh     }
22136f82e85aSdrh     pLevel->p1 = iIdxCur;
22146f82e85aSdrh     pLevel->p3 = (pLoop->wsFlags&WHERE_UNQ_WANTED)!=0 ? 1:0;
22156f82e85aSdrh     if( (pLoop->wsFlags & WHERE_CONSTRAINT)==0 ){
22166f82e85aSdrh       pLevel->p5 = SQLITE_STMTSTATUS_FULLSCAN_STEP;
22176f82e85aSdrh     }else{
22186f82e85aSdrh       assert( pLevel->p5==0 );
22196f82e85aSdrh     }
22206f654a40Sdan     if( omitTable ) pIdx = 0;
22216f82e85aSdrh   }else
22226f82e85aSdrh 
22236f82e85aSdrh #ifndef SQLITE_OMIT_OR_OPTIMIZATION
22246f82e85aSdrh   if( pLoop->wsFlags & WHERE_MULTI_OR ){
22256f82e85aSdrh     /* Case 5:  Two or more separately indexed terms connected by OR
22266f82e85aSdrh     **
22276f82e85aSdrh     ** Example:
22286f82e85aSdrh     **
22296f82e85aSdrh     **   CREATE TABLE t1(a,b,c,d);
22306f82e85aSdrh     **   CREATE INDEX i1 ON t1(a);
22316f82e85aSdrh     **   CREATE INDEX i2 ON t1(b);
22326f82e85aSdrh     **   CREATE INDEX i3 ON t1(c);
22336f82e85aSdrh     **
22346f82e85aSdrh     **   SELECT * FROM t1 WHERE a=5 OR b=7 OR (c=11 AND d=13)
22356f82e85aSdrh     **
22366f82e85aSdrh     ** In the example, there are three indexed terms connected by OR.
22376f82e85aSdrh     ** The top of the loop looks like this:
22386f82e85aSdrh     **
22396f82e85aSdrh     **          Null       1                # Zero the rowset in reg 1
22406f82e85aSdrh     **
22416f82e85aSdrh     ** Then, for each indexed term, the following. The arguments to
22426f82e85aSdrh     ** RowSetTest are such that the rowid of the current row is inserted
22436f82e85aSdrh     ** into the RowSet. If it is already present, control skips the
22446f82e85aSdrh     ** Gosub opcode and jumps straight to the code generated by WhereEnd().
22456f82e85aSdrh     **
22466f82e85aSdrh     **        sqlite3WhereBegin(<term>)
22476f82e85aSdrh     **          RowSetTest                  # Insert rowid into rowset
22486f82e85aSdrh     **          Gosub      2 A
22496f82e85aSdrh     **        sqlite3WhereEnd()
22506f82e85aSdrh     **
22516f82e85aSdrh     ** Following the above, code to terminate the loop. Label A, the target
22526f82e85aSdrh     ** of the Gosub above, jumps to the instruction right after the Goto.
22536f82e85aSdrh     **
22546f82e85aSdrh     **          Null       1                # Zero the rowset in reg 1
22556f82e85aSdrh     **          Goto       B                # The loop is finished.
22566f82e85aSdrh     **
22576f82e85aSdrh     **       A: <loop body>                 # Return data, whatever.
22586f82e85aSdrh     **
22596f82e85aSdrh     **          Return     2                # Jump back to the Gosub
22606f82e85aSdrh     **
22616f82e85aSdrh     **       B: <after the loop>
22626f82e85aSdrh     **
22636f82e85aSdrh     ** Added 2014-05-26: If the table is a WITHOUT ROWID table, then
22646f82e85aSdrh     ** use an ephemeral index instead of a RowSet to record the primary
22656f82e85aSdrh     ** keys of the rows we have already seen.
22666f82e85aSdrh     **
22676f82e85aSdrh     */
22686f82e85aSdrh     WhereClause *pOrWc;    /* The OR-clause broken out into subterms */
22696f82e85aSdrh     SrcList *pOrTab;       /* Shortened table list or OR-clause generation */
22706f82e85aSdrh     Index *pCov = 0;             /* Potential covering index (or NULL) */
22716f82e85aSdrh     int iCovCur = pParse->nTab++;  /* Cursor used for index scans (if any) */
22726f82e85aSdrh 
22736f82e85aSdrh     int regReturn = ++pParse->nMem;           /* Register used with OP_Gosub */
22746f82e85aSdrh     int regRowset = 0;                        /* Register for RowSet object */
22756f82e85aSdrh     int regRowid = 0;                         /* Register holding rowid */
2276ec4ccdbcSdrh     int iLoopBody = sqlite3VdbeMakeLabel(pParse);/* Start of loop body */
22776f82e85aSdrh     int iRetInit;                             /* Address of regReturn init */
22786f82e85aSdrh     int untestedTerms = 0;             /* Some terms not completely tested */
22796f82e85aSdrh     int ii;                            /* Loop counter */
22806f82e85aSdrh     Expr *pAndExpr = 0;                /* An ".. AND (...)" expression */
22816f82e85aSdrh     Table *pTab = pTabItem->pTab;
22826f82e85aSdrh 
22836f82e85aSdrh     pTerm = pLoop->aLTerm[0];
22846f82e85aSdrh     assert( pTerm!=0 );
22856f82e85aSdrh     assert( pTerm->eOperator & WO_OR );
22866f82e85aSdrh     assert( (pTerm->wtFlags & TERM_ORINFO)!=0 );
22876f82e85aSdrh     pOrWc = &pTerm->u.pOrInfo->wc;
22886f82e85aSdrh     pLevel->op = OP_Return;
22896f82e85aSdrh     pLevel->p1 = regReturn;
22906f82e85aSdrh 
22916f82e85aSdrh     /* Set up a new SrcList in pOrTab containing the table being scanned
22926f82e85aSdrh     ** by this loop in the a[0] slot and all notReady tables in a[1..] slots.
22936f82e85aSdrh     ** This becomes the SrcList in the recursive call to sqlite3WhereBegin().
22946f82e85aSdrh     */
22956f82e85aSdrh     if( pWInfo->nLevel>1 ){
22966f82e85aSdrh       int nNotReady;                 /* The number of notReady tables */
22977601294aSdrh       SrcItem *origSrc;              /* Original list of tables */
22986f82e85aSdrh       nNotReady = pWInfo->nLevel - iLevel - 1;
22996f82e85aSdrh       pOrTab = sqlite3StackAllocRaw(db,
23006f82e85aSdrh                             sizeof(*pOrTab)+ nNotReady*sizeof(pOrTab->a[0]));
23016f82e85aSdrh       if( pOrTab==0 ) return notReady;
23026f82e85aSdrh       pOrTab->nAlloc = (u8)(nNotReady + 1);
23036f82e85aSdrh       pOrTab->nSrc = pOrTab->nAlloc;
23046f82e85aSdrh       memcpy(pOrTab->a, pTabItem, sizeof(*pTabItem));
23056f82e85aSdrh       origSrc = pWInfo->pTabList->a;
23066f82e85aSdrh       for(k=1; k<=nNotReady; k++){
23076f82e85aSdrh         memcpy(&pOrTab->a[k], &origSrc[pLevel[k].iFrom], sizeof(pOrTab->a[k]));
23086f82e85aSdrh       }
23096f82e85aSdrh     }else{
23106f82e85aSdrh       pOrTab = pWInfo->pTabList;
23116f82e85aSdrh     }
23126f82e85aSdrh 
23136f82e85aSdrh     /* Initialize the rowset register to contain NULL. An SQL NULL is
23146f82e85aSdrh     ** equivalent to an empty rowset.  Or, create an ephemeral index
23156f82e85aSdrh     ** capable of holding primary keys in the case of a WITHOUT ROWID.
23166f82e85aSdrh     **
23176f82e85aSdrh     ** Also initialize regReturn to contain the address of the instruction
23186f82e85aSdrh     ** immediately following the OP_Return at the bottom of the loop. This
23196f82e85aSdrh     ** is required in a few obscure LEFT JOIN cases where control jumps
23206f82e85aSdrh     ** over the top of the loop into the body of it. In this case the
23216f82e85aSdrh     ** correct response for the end-of-loop code (the OP_Return) is to
23226f82e85aSdrh     ** fall through to the next instruction, just as an OP_Next does if
23236f82e85aSdrh     ** called on an uninitialized cursor.
23246f82e85aSdrh     */
23256f82e85aSdrh     if( (pWInfo->wctrlFlags & WHERE_DUPLICATES_OK)==0 ){
23266f82e85aSdrh       if( HasRowid(pTab) ){
23276f82e85aSdrh         regRowset = ++pParse->nMem;
23286f82e85aSdrh         sqlite3VdbeAddOp2(v, OP_Null, 0, regRowset);
23296f82e85aSdrh       }else{
23306f82e85aSdrh         Index *pPk = sqlite3PrimaryKeyIndex(pTab);
23316f82e85aSdrh         regRowset = pParse->nTab++;
23326f82e85aSdrh         sqlite3VdbeAddOp2(v, OP_OpenEphemeral, regRowset, pPk->nKeyCol);
23336f82e85aSdrh         sqlite3VdbeSetP4KeyInfo(pParse, pPk);
23346f82e85aSdrh       }
23356f82e85aSdrh       regRowid = ++pParse->nMem;
23366f82e85aSdrh     }
23376f82e85aSdrh     iRetInit = sqlite3VdbeAddOp2(v, OP_Integer, 0, regReturn);
23386f82e85aSdrh 
23396f82e85aSdrh     /* If the original WHERE clause is z of the form:  (x1 OR x2 OR ...) AND y
234002e3e041Sdrh     ** Then for every term xN, evaluate as the subexpression: xN AND y
23416f82e85aSdrh     ** That way, terms in y that are factored into the disjunction will
23426f82e85aSdrh     ** be picked up by the recursive calls to sqlite3WhereBegin() below.
23436f82e85aSdrh     **
23446f82e85aSdrh     ** Actually, each subexpression is converted to "xN AND w" where w is
23456f82e85aSdrh     ** the "interesting" terms of z - terms that did not originate in the
23466f82e85aSdrh     ** ON or USING clause of a LEFT JOIN, and terms that are usable as
23476f82e85aSdrh     ** indices.
23486f82e85aSdrh     **
23496f82e85aSdrh     ** This optimization also only applies if the (x1 OR x2 OR ...) term
23506f82e85aSdrh     ** is not contained in the ON clause of a LEFT JOIN.
23516f82e85aSdrh     ** See ticket http://www.sqlite.org/src/info/f2369304e4
235202e3e041Sdrh     **
235302e3e041Sdrh     ** 2022-02-04:  Do not push down slices of a row-value comparison.
235402e3e041Sdrh     ** In other words, "w" or "y" may not be a slice of a vector.  Otherwise,
235502e3e041Sdrh     ** the initialization of the right-hand operand of the vector comparison
235602e3e041Sdrh     ** might not occur, or might occur only in an OR branch that is not
235702e3e041Sdrh     ** taken.  dbsqlfuzz 80a9fade844b4fb43564efc972bcb2c68270f5d1.
2358c9bcc5aaSdrh     **
2359c9bcc5aaSdrh     ** 2022-03-03:  Do not push down expressions that involve subqueries.
2360c9bcc5aaSdrh     ** The subquery might get coded as a subroutine.  Any table-references
2361c9bcc5aaSdrh     ** in the subquery might be resolved to index-references for the index on
2362c9bcc5aaSdrh     ** the OR branch in which the subroutine is coded.  But if the subroutine
2363c9bcc5aaSdrh     ** is invoked from a different OR branch that uses a different index, such
2364c9bcc5aaSdrh     ** index-references will not work.  tag-20220303a
2365c9bcc5aaSdrh     ** https://sqlite.org/forum/forumpost/36937b197273d403
23666f82e85aSdrh     */
23676f82e85aSdrh     if( pWC->nTerm>1 ){
23686f82e85aSdrh       int iTerm;
23696f82e85aSdrh       for(iTerm=0; iTerm<pWC->nTerm; iTerm++){
23706f82e85aSdrh         Expr *pExpr = pWC->a[iTerm].pExpr;
23716f82e85aSdrh         if( &pWC->a[iTerm] == pTerm ) continue;
23723b83f0cdSdrh         testcase( pWC->a[iTerm].wtFlags & TERM_VIRTUAL );
23733b83f0cdSdrh         testcase( pWC->a[iTerm].wtFlags & TERM_CODED );
237402e3e041Sdrh         testcase( pWC->a[iTerm].wtFlags & TERM_SLICE );
237502e3e041Sdrh         if( (pWC->a[iTerm].wtFlags & (TERM_VIRTUAL|TERM_CODED|TERM_SLICE))!=0 ){
237602e3e041Sdrh           continue;
237702e3e041Sdrh         }
237807559b27Sdrh         if( (pWC->a[iTerm].eOperator & WO_ALL)==0 ) continue;
2379c9bcc5aaSdrh         if( ExprHasProperty(pExpr, EP_Subquery) ) continue;  /* tag-20220303a */
23806f82e85aSdrh         pExpr = sqlite3ExprDup(db, pExpr, 0);
2381d5c851c1Sdrh         pAndExpr = sqlite3ExprAnd(pParse, pAndExpr, pExpr);
23826f82e85aSdrh       }
23836f82e85aSdrh       if( pAndExpr ){
2384f1722baaSdrh         /* The extra 0x10000 bit on the opcode is masked off and does not
2385f1722baaSdrh         ** become part of the new Expr.op.  However, it does make the
2386f1722baaSdrh         ** op==TK_AND comparison inside of sqlite3PExpr() false, and this
238793ffb50fSdrh         ** prevents sqlite3PExpr() from applying the AND short-circuit
2388f1722baaSdrh         ** optimization, which we do not want here. */
2389f1722baaSdrh         pAndExpr = sqlite3PExpr(pParse, TK_AND|0x10000, 0, pAndExpr);
23906f82e85aSdrh       }
23916f82e85aSdrh     }
23926f82e85aSdrh 
23936f82e85aSdrh     /* Run a separate WHERE clause for each term of the OR clause.  After
23946f82e85aSdrh     ** eliminating duplicates from other WHERE clauses, the action for each
23956f82e85aSdrh     ** sub-WHERE clause is to to invoke the main loop body as a subroutine.
23966f82e85aSdrh     */
23975d72d924Sdrh     ExplainQueryPlan((pParse, 1, "MULTI-INDEX OR"));
23986f82e85aSdrh     for(ii=0; ii<pOrWc->nTerm; ii++){
23996f82e85aSdrh       WhereTerm *pOrTerm = &pOrWc->a[ii];
24006f82e85aSdrh       if( pOrTerm->leftCursor==iCur || (pOrTerm->eOperator & WO_AND)!=0 ){
24016f82e85aSdrh         WhereInfo *pSubWInfo;           /* Info for single OR-term scan */
24026f82e85aSdrh         Expr *pOrExpr = pOrTerm->pExpr; /* Current OR clause term */
240393ffb50fSdrh         Expr *pDelete;                  /* Local copy of OR clause term */
2404728e0f91Sdrh         int jmp1 = 0;                   /* Address of jump operation */
24053b8eb08bSdrh         testcase( (pTabItem[0].fg.jointype & JT_LEFT)!=0
24063b8eb08bSdrh                && !ExprHasProperty(pOrExpr, EP_FromJoin)
24073b8eb08bSdrh         ); /* See TH3 vtab25.400 and ticket 614b25314c766238 */
240893ffb50fSdrh         pDelete = pOrExpr = sqlite3ExprDup(db, pOrExpr, 0);
240993ffb50fSdrh         if( db->mallocFailed ){
241093ffb50fSdrh           sqlite3ExprDelete(db, pDelete);
241193ffb50fSdrh           continue;
241293ffb50fSdrh         }
2413820fcd2cSdan         if( pAndExpr ){
24146f82e85aSdrh           pAndExpr->pLeft = pOrExpr;
24156f82e85aSdrh           pOrExpr = pAndExpr;
24166f82e85aSdrh         }
24176f82e85aSdrh         /* Loop through table entries that match term pOrTerm. */
2418bd462bccSdrh         ExplainQueryPlan((pParse, 1, "INDEX %d", ii+1));
24196f82e85aSdrh         WHERETRACE(0xffff, ("Subplan for OR-clause:\n"));
2420895bab33Sdrh         pSubWInfo = sqlite3WhereBegin(pParse, pOrTab, pOrExpr, 0, 0, 0,
242168c0c710Sdrh                                       WHERE_OR_SUBCLAUSE, iCovCur);
24220c7d3d39Sdrh         assert( pSubWInfo || pParse->nErr );
24236f82e85aSdrh         if( pSubWInfo ){
24246f82e85aSdrh           WhereLoop *pSubLoop;
24256f82e85aSdrh           int addrExplain = sqlite3WhereExplainOneScan(
2426e2188f0bSdrh               pParse, pOrTab, &pSubWInfo->a[0], 0
24276f82e85aSdrh           );
24286f82e85aSdrh           sqlite3WhereAddScanStatus(v, pOrTab, &pSubWInfo->a[0], addrExplain);
24296f82e85aSdrh 
24306f82e85aSdrh           /* This is the sub-WHERE clause body.  First skip over
24316f82e85aSdrh           ** duplicate rows from prior sub-WHERE clauses, and record the
24326f82e85aSdrh           ** rowid (or PRIMARY KEY) for the current row so that the same
24336f82e85aSdrh           ** row will be skipped in subsequent sub-WHERE clauses.
24346f82e85aSdrh           */
24356f82e85aSdrh           if( (pWInfo->wctrlFlags & WHERE_DUPLICATES_OK)==0 ){
24366f82e85aSdrh             int iSet = ((ii==pOrWc->nTerm-1)?-1:ii);
24376f82e85aSdrh             if( HasRowid(pTab) ){
24386df9c4b9Sdrh               sqlite3ExprCodeGetColumnOfTable(v, pTab, iCur, -1, regRowid);
2439728e0f91Sdrh               jmp1 = sqlite3VdbeAddOp4Int(v, OP_RowSetTest, regRowset, 0,
24408c607191Sdrh                                           regRowid, iSet);
24416f82e85aSdrh               VdbeCoverage(v);
24426f82e85aSdrh             }else{
24436f82e85aSdrh               Index *pPk = sqlite3PrimaryKeyIndex(pTab);
24446f82e85aSdrh               int nPk = pPk->nKeyCol;
24456f82e85aSdrh               int iPk;
24468c607191Sdrh               int r;
24476f82e85aSdrh 
24486f82e85aSdrh               /* Read the PK into an array of temp registers. */
24496f82e85aSdrh               r = sqlite3GetTempRange(pParse, nPk);
24506f82e85aSdrh               for(iPk=0; iPk<nPk; iPk++){
24516f82e85aSdrh                 int iCol = pPk->aiColumn[iPk];
24526df9c4b9Sdrh                 sqlite3ExprCodeGetColumnOfTable(v, pTab, iCur, iCol,r+iPk);
24536f82e85aSdrh               }
24546f82e85aSdrh 
24556f82e85aSdrh               /* Check if the temp table already contains this key. If so,
24566f82e85aSdrh               ** the row has already been included in the result set and
24576f82e85aSdrh               ** can be ignored (by jumping past the Gosub below). Otherwise,
24586f82e85aSdrh               ** insert the key into the temp table and proceed with processing
24596f82e85aSdrh               ** the row.
24606f82e85aSdrh               **
24616f82e85aSdrh               ** Use some of the same optimizations as OP_RowSetTest: If iSet
24626f82e85aSdrh               ** is zero, assume that the key cannot already be present in
24636f82e85aSdrh               ** the temp table. And if iSet is -1, assume that there is no
24646f82e85aSdrh               ** need to insert the key into the temp table, as it will never
24656f82e85aSdrh               ** be tested for.  */
24666f82e85aSdrh               if( iSet ){
2467728e0f91Sdrh                 jmp1 = sqlite3VdbeAddOp4Int(v, OP_Found, regRowset, 0, r, nPk);
24686f82e85aSdrh                 VdbeCoverage(v);
24696f82e85aSdrh               }
24706f82e85aSdrh               if( iSet>=0 ){
24716f82e85aSdrh                 sqlite3VdbeAddOp3(v, OP_MakeRecord, r, nPk, regRowid);
24729b4eaebcSdrh                 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, regRowset, regRowid,
24739b4eaebcSdrh                                      r, nPk);
24746f82e85aSdrh                 if( iSet ) sqlite3VdbeChangeP5(v, OPFLAG_USESEEKRESULT);
24756f82e85aSdrh               }
24766f82e85aSdrh 
24776f82e85aSdrh               /* Release the array of temp registers */
24786f82e85aSdrh               sqlite3ReleaseTempRange(pParse, r, nPk);
24796f82e85aSdrh             }
24806f82e85aSdrh           }
24816f82e85aSdrh 
24826f82e85aSdrh           /* Invoke the main loop body as a subroutine */
24836f82e85aSdrh           sqlite3VdbeAddOp2(v, OP_Gosub, regReturn, iLoopBody);
24846f82e85aSdrh 
24856f82e85aSdrh           /* Jump here (skipping the main loop body subroutine) if the
24866f82e85aSdrh           ** current sub-WHERE row is a duplicate from prior sub-WHEREs. */
2487728e0f91Sdrh           if( jmp1 ) sqlite3VdbeJumpHere(v, jmp1);
24886f82e85aSdrh 
24896f82e85aSdrh           /* The pSubWInfo->untestedTerms flag means that this OR term
24906f82e85aSdrh           ** contained one or more AND term from a notReady table.  The
24916f82e85aSdrh           ** terms from the notReady table could not be tested and will
24926f82e85aSdrh           ** need to be tested later.
24936f82e85aSdrh           */
24946f82e85aSdrh           if( pSubWInfo->untestedTerms ) untestedTerms = 1;
24956f82e85aSdrh 
24966f82e85aSdrh           /* If all of the OR-connected terms are optimized using the same
24976f82e85aSdrh           ** index, and the index is opened using the same cursor number
24986f82e85aSdrh           ** by each call to sqlite3WhereBegin() made by this loop, it may
24996f82e85aSdrh           ** be possible to use that index as a covering index.
25006f82e85aSdrh           **
25016f82e85aSdrh           ** If the call to sqlite3WhereBegin() above resulted in a scan that
25026f82e85aSdrh           ** uses an index, and this is either the first OR-connected term
25036f82e85aSdrh           ** processed or the index is the same as that used by all previous
25046f82e85aSdrh           ** terms, set pCov to the candidate covering index. Otherwise, set
25056f82e85aSdrh           ** pCov to NULL to indicate that no candidate covering index will
25066f82e85aSdrh           ** be available.
25076f82e85aSdrh           */
25086f82e85aSdrh           pSubLoop = pSubWInfo->a[0].pWLoop;
25096f82e85aSdrh           assert( (pSubLoop->wsFlags & WHERE_AUTO_INDEX)==0 );
25106f82e85aSdrh           if( (pSubLoop->wsFlags & WHERE_INDEXED)!=0
25116f82e85aSdrh            && (ii==0 || pSubLoop->u.btree.pIndex==pCov)
25126f82e85aSdrh            && (HasRowid(pTab) || !IsPrimaryKeyIndex(pSubLoop->u.btree.pIndex))
25136f82e85aSdrh           ){
25146f82e85aSdrh             assert( pSubWInfo->a[0].iIdxCur==iCovCur );
25156f82e85aSdrh             pCov = pSubLoop->u.btree.pIndex;
25166f82e85aSdrh           }else{
25176f82e85aSdrh             pCov = 0;
25186f82e85aSdrh           }
251968c0c710Sdrh           if( sqlite3WhereUsesDeferredSeek(pSubWInfo) ){
252068c0c710Sdrh             pWInfo->bDeferredSeek = 1;
252168c0c710Sdrh           }
25226f82e85aSdrh 
25236f82e85aSdrh           /* Finish the loop through table entries that match term pOrTerm. */
25246f82e85aSdrh           sqlite3WhereEnd(pSubWInfo);
2525bd462bccSdrh           ExplainQueryPlanPop(pParse);
25266f82e85aSdrh         }
252793ffb50fSdrh         sqlite3ExprDelete(db, pDelete);
25286f82e85aSdrh       }
25296f82e85aSdrh     }
25305d72d924Sdrh     ExplainQueryPlanPop(pParse);
25310475629dSdrh     assert( pLevel->pWLoop==pLoop );
25320475629dSdrh     assert( (pLoop->wsFlags & WHERE_MULTI_OR)!=0 );
25330475629dSdrh     assert( (pLoop->wsFlags & WHERE_IN_ABLE)==0 );
25340475629dSdrh     pLevel->u.pCoveringIdx = pCov;
25356f82e85aSdrh     if( pCov ) pLevel->iIdxCur = iCovCur;
25366f82e85aSdrh     if( pAndExpr ){
25376f82e85aSdrh       pAndExpr->pLeft = 0;
25386f82e85aSdrh       sqlite3ExprDelete(db, pAndExpr);
25396f82e85aSdrh     }
25406f82e85aSdrh     sqlite3VdbeChangeP1(v, iRetInit, sqlite3VdbeCurrentAddr(v));
2541076e85f5Sdrh     sqlite3VdbeGoto(v, pLevel->addrBrk);
25426f82e85aSdrh     sqlite3VdbeResolveLabel(v, iLoopBody);
25436f82e85aSdrh 
2544e603ab00Sdrh     /* Set the P2 operand of the OP_Return opcode that will end the current
2545e603ab00Sdrh     ** loop to point to this spot, which is the top of the next containing
2546e603ab00Sdrh     ** loop.  The byte-code formatter will use that P2 value as a hint to
2547e603ab00Sdrh     ** indent everything in between the this point and the final OP_Return.
2548e603ab00Sdrh     ** See tag-20220407a in vdbe.c and shell.c */
2549e603ab00Sdrh     assert( pLevel->op==OP_Return );
2550e603ab00Sdrh     pLevel->p2 = sqlite3VdbeCurrentAddr(v);
2551e603ab00Sdrh 
2552dd2d9a3dSdrh     if( pWInfo->nLevel>1 ){ sqlite3StackFree(db, pOrTab); }
25536f82e85aSdrh     if( !untestedTerms ) disableTerm(pLevel, pTerm);
25546f82e85aSdrh   }else
25556f82e85aSdrh #endif /* SQLITE_OMIT_OR_OPTIMIZATION */
25566f82e85aSdrh 
25576f82e85aSdrh   {
25586f82e85aSdrh     /* Case 6:  There is no usable index.  We must do a complete
25596f82e85aSdrh     **          scan of the entire table.
25606f82e85aSdrh     */
25616f82e85aSdrh     static const u8 aStep[] = { OP_Next, OP_Prev };
25626f82e85aSdrh     static const u8 aStart[] = { OP_Rewind, OP_Last };
25636f82e85aSdrh     assert( bRev==0 || bRev==1 );
25648a48b9c0Sdrh     if( pTabItem->fg.isRecursive ){
25656f82e85aSdrh       /* Tables marked isRecursive have only a single row that is stored in
25666f82e85aSdrh       ** a pseudo-cursor.  No need to Rewind or Next such cursors. */
25676f82e85aSdrh       pLevel->op = OP_Noop;
25686f82e85aSdrh     }else{
2569b324cf75Sdan       codeCursorHint(pTabItem, pWInfo, pLevel, 0);
25706f82e85aSdrh       pLevel->op = aStep[bRev];
25716f82e85aSdrh       pLevel->p1 = iCur;
25723a3b420aSdrh       pLevel->p2 = 1 + sqlite3VdbeAddOp2(v, aStart[bRev], iCur, addrHalt);
25736f82e85aSdrh       VdbeCoverageIf(v, bRev==0);
25746f82e85aSdrh       VdbeCoverageIf(v, bRev!=0);
25756f82e85aSdrh       pLevel->p5 = SQLITE_STMTSTATUS_FULLSCAN_STEP;
25766f82e85aSdrh     }
25776f82e85aSdrh   }
25786f82e85aSdrh 
25796f82e85aSdrh #ifdef SQLITE_ENABLE_STMT_SCANSTATUS
25806f82e85aSdrh   pLevel->addrVisit = sqlite3VdbeCurrentAddr(v);
25816f82e85aSdrh #endif
25826f82e85aSdrh 
25836f82e85aSdrh   /* Insert code to test every subexpression that can be completely
25846f82e85aSdrh   ** computed using the current set of tables.
25856f654a40Sdan   **
2586ebc63013Sdan   ** This loop may run between one and three times, depending on the
2587ebc63013Sdan   ** constraints to be generated. The value of stack variable iLoop
2588ebc63013Sdan   ** determines the constraints coded by each iteration, as follows:
2589ebc63013Sdan   **
2590ebc63013Sdan   ** iLoop==1: Code only expressions that are entirely covered by pIdx.
2591ebc63013Sdan   ** iLoop==2: Code remaining expressions that do not contain correlated
2592ebc63013Sdan   **           sub-queries.
2593ebc63013Sdan   ** iLoop==3: Code all remaining expressions.
2594ebc63013Sdan   **
2595ebc63013Sdan   ** An effort is made to skip unnecessary iterations of the loop.
25966ab3eb5dSdrh   */
2597ebc63013Sdan   iLoop = (pIdx ? 1 : 2);
25986ab3eb5dSdrh   do{
2599ebc63013Sdan     int iNext = 0;                /* Next value for iLoop */
26006f82e85aSdrh     for(pTerm=pWC->a, j=pWC->nTerm; j>0; j--, pTerm++){
26016f82e85aSdrh       Expr *pE;
26026f82e85aSdrh       int skipLikeAddr = 0;
26036f82e85aSdrh       testcase( pTerm->wtFlags & TERM_VIRTUAL );
26046f82e85aSdrh       testcase( pTerm->wtFlags & TERM_CODED );
26056f82e85aSdrh       if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
26066f82e85aSdrh       if( (pTerm->prereqAll & pLevel->notReady)!=0 ){
26076f82e85aSdrh         testcase( pWInfo->untestedTerms==0
2608ce943bc8Sdrh             && (pWInfo->wctrlFlags & WHERE_OR_SUBCLAUSE)!=0 );
26096f82e85aSdrh         pWInfo->untestedTerms = 1;
26106f82e85aSdrh         continue;
26116f82e85aSdrh       }
26126f82e85aSdrh       pE = pTerm->pExpr;
26136f82e85aSdrh       assert( pE!=0 );
2614a76ac88aSdrh       if( (pTabItem->fg.jointype & (JT_LEFT|JT_LTORJ))
2615a76ac88aSdrh        && !ExprHasProperty(pE,EP_FromJoin)
2616a76ac88aSdrh       ){
26176f654a40Sdan         continue;
26186f654a40Sdan       }
2619ebc63013Sdan 
26208674ec5aSdan       if( iLoop==1 && !sqlite3ExprCoveredByIndex(pE, pLevel->iTabCur, pIdx) ){
2621ebc63013Sdan         iNext = 2;
26226f82e85aSdrh         continue;
26236f82e85aSdrh       }
2624d3930b12Sdan       if( iLoop<3 && (pTerm->wtFlags & TERM_VARSELECT) ){
2625ebc63013Sdan         if( iNext==0 ) iNext = 3;
2626ebc63013Sdan         continue;
2627ebc63013Sdan       }
2628ebc63013Sdan 
26294de3353dSdrh       if( (pTerm->wtFlags & TERM_LIKECOND)!=0 ){
263044aebff2Sdrh         /* If the TERM_LIKECOND flag is set, that means that the range search
263144aebff2Sdrh         ** is sufficient to guarantee that the LIKE operator is true, so we
263244aebff2Sdrh         ** can skip the call to the like(A,B) function.  But this only works
263344aebff2Sdrh         ** for strings.  So do not skip the call to the function on the pass
263444aebff2Sdrh         ** that compares BLOBs. */
263541d2e66eSdrh #ifdef SQLITE_LIKE_DOESNT_MATCH_BLOBS
263641d2e66eSdrh         continue;
263741d2e66eSdrh #else
263844aebff2Sdrh         u32 x = pLevel->iLikeRepCntr;
26394de3353dSdrh         if( x>0 ){
264044aebff2Sdrh           skipLikeAddr = sqlite3VdbeAddOp1(v, (x&1)?OP_IfNot:OP_If,(int)(x>>1));
26416f88359dSdrh           VdbeCoverageIf(v, (x&1)==1);
26426f88359dSdrh           VdbeCoverageIf(v, (x&1)==0);
26434de3353dSdrh         }
264441d2e66eSdrh #endif
26456f82e85aSdrh       }
264666a0bf31Sdrh #ifdef WHERETRACE_ENABLED /* 0xffff */
264766a0bf31Sdrh       if( sqlite3WhereTrace ){
264866a0bf31Sdrh         VdbeNoopComment((v, "WhereTerm[%d] (%p) priority=%d",
264966a0bf31Sdrh                          pWC->nTerm-j, pTerm, iLoop));
265066a0bf31Sdrh       }
2651118efd16Sdrh       if( sqlite3WhereTrace & 0x800 ){
2652118efd16Sdrh         sqlite3DebugPrintf("Coding auxiliary constraint:\n");
2653118efd16Sdrh         sqlite3WhereTermPrint(pTerm, pWC->nTerm-j);
2654118efd16Sdrh       }
265566a0bf31Sdrh #endif
26566f82e85aSdrh       sqlite3ExprIfFalse(pParse, pE, addrCont, SQLITE_JUMPIFNULL);
26576f82e85aSdrh       if( skipLikeAddr ) sqlite3VdbeJumpHere(v, skipLikeAddr);
26586f82e85aSdrh       pTerm->wtFlags |= TERM_CODED;
26596f82e85aSdrh     }
2660ebc63013Sdan     iLoop = iNext;
2661ebc63013Sdan   }while( iLoop>0 );
26626f82e85aSdrh 
26636f82e85aSdrh   /* Insert code to test for implied constraints based on transitivity
26646f82e85aSdrh   ** of the "==" operator.
26656f82e85aSdrh   **
26666f82e85aSdrh   ** Example: If the WHERE clause contains "t1.a=t2.b" and "t2.b=123"
26676f82e85aSdrh   ** and we are coding the t1 loop and the t2 loop has not yet coded,
26686f82e85aSdrh   ** then we cannot use the "t1.a=t2.b" constraint, but we can code
26696f82e85aSdrh   ** the implied "t1.a=123" constraint.
26706f82e85aSdrh   */
2671132f96fcSdrh   for(pTerm=pWC->a, j=pWC->nBase; j>0; j--, pTerm++){
2672cb43a937Sdrh     Expr *pE, sEAlt;
26736f82e85aSdrh     WhereTerm *pAlt;
26746f82e85aSdrh     if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
26756f82e85aSdrh     if( (pTerm->eOperator & (WO_EQ|WO_IS))==0 ) continue;
26766f82e85aSdrh     if( (pTerm->eOperator & WO_EQUIV)==0 ) continue;
26776f82e85aSdrh     if( pTerm->leftCursor!=iCur ) continue;
2678a76ac88aSdrh     if( pTabItem->fg.jointype & (JT_LEFT|JT_LTORJ) ) continue;
26796f82e85aSdrh     pE = pTerm->pExpr;
2680118efd16Sdrh #ifdef WHERETRACE_ENABLED /* 0x800 */
2681118efd16Sdrh     if( sqlite3WhereTrace & 0x800 ){
2682118efd16Sdrh       sqlite3DebugPrintf("Coding transitive constraint:\n");
2683118efd16Sdrh       sqlite3WhereTermPrint(pTerm, pWC->nTerm-j);
2684118efd16Sdrh     }
2685118efd16Sdrh #endif
2686f1bb31e2Sdrh     assert( !ExprHasProperty(pE, EP_FromJoin) );
26876f82e85aSdrh     assert( (pTerm->prereqRight & pLevel->notReady)!=0 );
2688220f0d6fSdrh     assert( (pTerm->eOperator & (WO_OR|WO_AND))==0 );
268975fa2663Sdrh     pAlt = sqlite3WhereFindTerm(pWC, iCur, pTerm->u.x.leftColumn, notReady,
26906f82e85aSdrh                     WO_EQ|WO_IN|WO_IS, 0);
26916f82e85aSdrh     if( pAlt==0 ) continue;
26926f82e85aSdrh     if( pAlt->wtFlags & (TERM_CODED) ) continue;
2693a916b570Sdan     if( (pAlt->eOperator & WO_IN)
2694a4eeccdfSdrh      && ExprUseXSelect(pAlt->pExpr)
2695a599e150Sdrh      && (pAlt->pExpr->x.pSelect->pEList->nExpr>1)
2696a916b570Sdan     ){
2697a916b570Sdan       continue;
2698a916b570Sdan     }
26996f82e85aSdrh     testcase( pAlt->eOperator & WO_EQ );
27006f82e85aSdrh     testcase( pAlt->eOperator & WO_IS );
27016f82e85aSdrh     testcase( pAlt->eOperator & WO_IN );
27026f82e85aSdrh     VdbeModuleComment((v, "begin transitive constraint"));
2703cb43a937Sdrh     sEAlt = *pAlt->pExpr;
2704cb43a937Sdrh     sEAlt.pLeft = pE->pLeft;
2705cb43a937Sdrh     sqlite3ExprIfFalse(pParse, &sEAlt, addrCont, SQLITE_JUMPIFNULL);
2706240e36c0Sdan     pAlt->wtFlags |= TERM_CODED;
27076f82e85aSdrh   }
27086f82e85aSdrh 
2709c2308ad2Sdrh   /* For a RIGHT OUTER JOIN, record the fact that the current row has
2710c2308ad2Sdrh   ** been matched at least once.
2711c2308ad2Sdrh   */
27127c1734b0Sdrh   if( pLevel->pRJ ){
2713c2308ad2Sdrh     Table *pTab;
2714c2308ad2Sdrh     int nPk;
2715c2308ad2Sdrh     int r;
2716c2308ad2Sdrh     int jmp1 = 0;
27177c1734b0Sdrh     WhereRightJoin *pRJ = pLevel->pRJ;
2718c2308ad2Sdrh 
27197c1734b0Sdrh     /* pTab is the right-hand table of the RIGHT JOIN.  Generate code that
27207c1734b0Sdrh     ** will record that the current row of that table has been matched at
27217c1734b0Sdrh     ** least once.  This is accomplished by storing the PK for the row in
27227c1734b0Sdrh     ** both the iMatch index and the regBloom Bloom filter.
27237c1734b0Sdrh     */
2724c2308ad2Sdrh     pTab = pWInfo->pTabList->a[pLevel->iFrom].pTab;
2725c2308ad2Sdrh     if( HasRowid(pTab) ){
2726c2308ad2Sdrh       r = sqlite3GetTempRange(pParse, 2);
2727c2308ad2Sdrh       sqlite3ExprCodeGetColumnOfTable(v, pTab, pLevel->iTabCur, -1, r+1);
2728c2308ad2Sdrh       nPk = 1;
2729c2308ad2Sdrh     }else{
2730c2308ad2Sdrh       int iPk;
2731c2308ad2Sdrh       Index *pPk = sqlite3PrimaryKeyIndex(pTab);
2732c2308ad2Sdrh       nPk = pPk->nKeyCol;
2733c2308ad2Sdrh       r = sqlite3GetTempRange(pParse, nPk+1);
2734c2308ad2Sdrh       for(iPk=0; iPk<nPk; iPk++){
2735c2308ad2Sdrh         int iCol = pPk->aiColumn[iPk];
2736c2308ad2Sdrh         sqlite3ExprCodeGetColumnOfTable(v, pTab, iCur, iCol,r+1+iPk);
2737c2308ad2Sdrh       }
2738c2308ad2Sdrh     }
27397c1734b0Sdrh     jmp1 = sqlite3VdbeAddOp4Int(v, OP_Found, pRJ->iMatch, 0, r+1, nPk);
2740c2308ad2Sdrh     VdbeCoverage(v);
27412e1bcc9dSdrh     VdbeComment((v, "match against %s", pTab->zName));
2742c2308ad2Sdrh     sqlite3VdbeAddOp3(v, OP_MakeRecord, r+1, nPk, r);
27437c1734b0Sdrh     sqlite3VdbeAddOp4Int(v, OP_IdxInsert, pRJ->iMatch, r, r+1, nPk);
27447c1734b0Sdrh     sqlite3VdbeAddOp4Int(v, OP_FilterAdd, pRJ->regBloom, 0, r+1, nPk);
2745c2308ad2Sdrh     sqlite3VdbeChangeP5(v, OPFLAG_USESEEKRESULT);
2746c2308ad2Sdrh     sqlite3VdbeJumpHere(v, jmp1);
2747c2308ad2Sdrh     sqlite3ReleaseTempRange(pParse, r, nPk+1);
27482e1bcc9dSdrh   }
27497c1734b0Sdrh 
27502e1bcc9dSdrh   /* For a LEFT OUTER JOIN, generate code that will record the fact that
27512e1bcc9dSdrh   ** at least one row of the right table has matched the left table.
27522e1bcc9dSdrh   */
27532e1bcc9dSdrh   if( pLevel->iLeftJoin ){
27542e1bcc9dSdrh     pLevel->addrFirst = sqlite3VdbeCurrentAddr(v);
27552e1bcc9dSdrh     sqlite3VdbeAddOp2(v, OP_Integer, 1, pLevel->iLeftJoin);
27562e1bcc9dSdrh     VdbeComment((v, "record LEFT JOIN hit"));
27572e1bcc9dSdrh     for(pTerm=pWC->a, j=0; j<pWC->nBase; j++, pTerm++){
27582e1bcc9dSdrh       testcase( pTerm->wtFlags & TERM_VIRTUAL );
27592e1bcc9dSdrh       testcase( pTerm->wtFlags & TERM_CODED );
27602e1bcc9dSdrh       if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
27612e1bcc9dSdrh       if( (pTerm->prereqAll & pLevel->notReady)!=0 ){
27622e1bcc9dSdrh         assert( pWInfo->untestedTerms );
27632e1bcc9dSdrh         continue;
27642e1bcc9dSdrh       }
27652e1bcc9dSdrh       if( pTabItem->fg.jointype & JT_LTORJ ) continue;
27662e1bcc9dSdrh       assert( pTerm->pExpr );
27672e1bcc9dSdrh       sqlite3ExprIfFalse(pParse, pTerm->pExpr, addrCont, SQLITE_JUMPIFNULL);
27682e1bcc9dSdrh       pTerm->wtFlags |= TERM_CODED;
27692e1bcc9dSdrh     }
27702e1bcc9dSdrh   }
27712e1bcc9dSdrh 
27722e1bcc9dSdrh   if( pLevel->pRJ ){
27737c1734b0Sdrh     /* Create a subroutine used to process all interior loops and code
27747c1734b0Sdrh     ** of the RIGHT JOIN.  During normal operation, the subroutine will
27757c1734b0Sdrh     ** be in-line with the rest of the code.  But at the end, a separate
27767c1734b0Sdrh     ** loop will run that invokes this subroutine for unmatched rows
27777c1734b0Sdrh     ** of pTab, with all tables to left begin set to NULL.
27787c1734b0Sdrh     */
27792e1bcc9dSdrh     WhereRightJoin *pRJ = pLevel->pRJ;
27807c1734b0Sdrh     sqlite3VdbeAddOp2(v, OP_BeginSubrtn, 0, pRJ->regReturn);
27817c1734b0Sdrh     pRJ->addrSubrtn = sqlite3VdbeCurrentAddr(v);
27822c31c00bSdrh     assert( pParse->withinRJSubrtn < 255 );
27832c31c00bSdrh     pParse->withinRJSubrtn++;
2784c2308ad2Sdrh   }
2785c2308ad2Sdrh 
2786118efd16Sdrh #if WHERETRACE_ENABLED /* 0x20800 */
2787118efd16Sdrh   if( sqlite3WhereTrace & 0x20000 ){
2788f1bb31e2Sdrh     sqlite3DebugPrintf("All WHERE-clause terms after coding level %d:\n",
2789f1bb31e2Sdrh                        iLevel);
2790118efd16Sdrh     sqlite3WhereClausePrint(pWC);
2791118efd16Sdrh   }
2792118efd16Sdrh   if( sqlite3WhereTrace & 0x800 ){
2793118efd16Sdrh     sqlite3DebugPrintf("End Coding level %d:  notReady=%llx\n",
2794118efd16Sdrh        iLevel, (u64)pLevel->notReady);
2795118efd16Sdrh   }
2796118efd16Sdrh #endif
27976f82e85aSdrh   return pLevel->notReady;
27986f82e85aSdrh }
2799949e2ab4Sdrh 
2800949e2ab4Sdrh /*
2801949e2ab4Sdrh ** Generate the code for the loop that finds all non-matched terms
2802949e2ab4Sdrh ** for a RIGHT JOIN.
2803949e2ab4Sdrh */
2804949e2ab4Sdrh SQLITE_NOINLINE void sqlite3WhereRightJoinLoop(
2805949e2ab4Sdrh   WhereInfo *pWInfo,
2806949e2ab4Sdrh   int iLevel,
2807949e2ab4Sdrh   WhereLevel *pLevel
2808949e2ab4Sdrh ){
2809949e2ab4Sdrh   Parse *pParse = pWInfo->pParse;
2810949e2ab4Sdrh   Vdbe *v = pParse->pVdbe;
2811949e2ab4Sdrh   WhereRightJoin *pRJ = pLevel->pRJ;
2812949e2ab4Sdrh   Expr *pSubWhere = 0;
2813949e2ab4Sdrh   WhereClause *pWC = &pWInfo->sWC;
2814949e2ab4Sdrh   WhereInfo *pSubWInfo;
2815949e2ab4Sdrh   WhereLoop *pLoop = pLevel->pWLoop;
2816949e2ab4Sdrh   SrcItem *pTabItem = &pWInfo->pTabList->a[pLevel->iFrom];
2817949e2ab4Sdrh   SrcList sFrom;
2818949e2ab4Sdrh   Bitmask mAll = 0;
2819949e2ab4Sdrh   int k;
2820949e2ab4Sdrh 
2821f7ecd956Sdrh   ExplainQueryPlan((pParse, 1, "RIGHT-JOIN %s", pTabItem->pTab->zName));
2822949e2ab4Sdrh   for(k=0; k<iLevel; k++){
2823949e2ab4Sdrh     int iIdxCur;
2824949e2ab4Sdrh     mAll |= pWInfo->a[k].pWLoop->maskSelf;
2825949e2ab4Sdrh     sqlite3VdbeAddOp1(v, OP_NullRow, pWInfo->a[k].iTabCur);
2826949e2ab4Sdrh     iIdxCur = pWInfo->a[k].iIdxCur;
2827949e2ab4Sdrh     if( iIdxCur ){
2828949e2ab4Sdrh       sqlite3VdbeAddOp1(v, OP_NullRow, iIdxCur);
2829949e2ab4Sdrh     }
2830949e2ab4Sdrh   }
2831*7348ca4eSdrh   if( (pTabItem->fg.jointype & JT_LTORJ)==0 ){
2832949e2ab4Sdrh     mAll |= pLoop->maskSelf;
2833949e2ab4Sdrh     for(k=0; k<pWC->nTerm; k++){
2834949e2ab4Sdrh       WhereTerm *pTerm = &pWC->a[k];
2835949e2ab4Sdrh       if( pTerm->wtFlags & TERM_VIRTUAL ) break;
2836949e2ab4Sdrh       if( pTerm->prereqAll & ~mAll ) continue;
2837949e2ab4Sdrh       if( ExprHasProperty(pTerm->pExpr, EP_FromJoin|EP_InnerJoin) ) continue;
2838949e2ab4Sdrh       pSubWhere = sqlite3ExprAnd(pParse, pSubWhere,
2839949e2ab4Sdrh                                  sqlite3ExprDup(pParse->db, pTerm->pExpr, 0));
2840949e2ab4Sdrh     }
28412e1bcc9dSdrh   }
2842949e2ab4Sdrh   sFrom.nSrc = 1;
2843949e2ab4Sdrh   sFrom.nAlloc = 1;
2844949e2ab4Sdrh   memcpy(&sFrom.a[0], pTabItem, sizeof(SrcItem));
2845949e2ab4Sdrh   sFrom.a[0].fg.jointype = 0;
2846949e2ab4Sdrh   pSubWInfo = sqlite3WhereBegin(pParse, &sFrom, pSubWhere, 0, 0, 0,
2847949e2ab4Sdrh                                 WHERE_RIGHT_JOIN, 0);
2848949e2ab4Sdrh   if( pSubWInfo ){
2849949e2ab4Sdrh     int iCur = pLevel->iTabCur;
2850949e2ab4Sdrh     int r = ++pParse->nMem;
2851949e2ab4Sdrh     int nPk;
2852949e2ab4Sdrh     int jmp;
2853949e2ab4Sdrh     int addrCont = sqlite3WhereContinueLabel(pSubWInfo);
2854949e2ab4Sdrh     Table *pTab = pTabItem->pTab;
2855949e2ab4Sdrh     if( HasRowid(pTab) ){
2856949e2ab4Sdrh       sqlite3ExprCodeGetColumnOfTable(v, pTab, iCur, -1, r);
2857949e2ab4Sdrh       nPk = 1;
2858949e2ab4Sdrh     }else{
2859949e2ab4Sdrh       int iPk;
2860949e2ab4Sdrh       Index *pPk = sqlite3PrimaryKeyIndex(pTab);
2861949e2ab4Sdrh       nPk = pPk->nKeyCol;
2862949e2ab4Sdrh       pParse->nMem += nPk - 1;
2863949e2ab4Sdrh       for(iPk=0; iPk<nPk; iPk++){
2864949e2ab4Sdrh         int iCol = pPk->aiColumn[iPk];
2865949e2ab4Sdrh         sqlite3ExprCodeGetColumnOfTable(v, pTab, iCur, iCol,r+iPk);
2866949e2ab4Sdrh       }
2867949e2ab4Sdrh     }
2868949e2ab4Sdrh     jmp = sqlite3VdbeAddOp4Int(v, OP_Filter, pRJ->regBloom, 0, r, nPk);
2869146e64d2Sdrh     VdbeCoverage(v);
2870949e2ab4Sdrh     sqlite3VdbeAddOp4Int(v, OP_Found, pRJ->iMatch, addrCont, r, nPk);
2871146e64d2Sdrh     VdbeCoverage(v);
2872949e2ab4Sdrh     sqlite3VdbeJumpHere(v, jmp);
2873949e2ab4Sdrh     sqlite3VdbeAddOp2(v, OP_Gosub, pRJ->regReturn, pRJ->addrSubrtn);
2874949e2ab4Sdrh     sqlite3WhereEnd(pSubWInfo);
2875949e2ab4Sdrh   }
2876949e2ab4Sdrh   sqlite3ExprDelete(pParse->db, pSubWhere);
2877949e2ab4Sdrh   ExplainQueryPlanPop(pParse);
2878949e2ab4Sdrh }
2879