xref: /sqlite-3.40.0/src/wherecode.c (revision 2b5fbb28)
1 /*
2 ** 2015-06-06
3 **
4 ** The author disclaims copyright to this source code.  In place of
5 ** a legal notice, here is a blessing:
6 **
7 **    May you do good and not evil.
8 **    May you find forgiveness for yourself and forgive others.
9 **    May you share freely, never taking more than you give.
10 **
11 *************************************************************************
12 ** This module contains C code that generates VDBE code used to process
13 ** the WHERE clause of SQL statements.
14 **
15 ** This file was split off from where.c on 2015-06-06 in order to reduce the
16 ** size of where.c and make it easier to edit.  This file contains the routines
17 ** that actually generate the bulk of the WHERE loop code.  The original where.c
18 ** file retains the code that does query planning and analysis.
19 */
20 #include "sqliteInt.h"
21 #include "whereInt.h"
22 
23 #ifndef SQLITE_OMIT_EXPLAIN
24 
25 /*
26 ** Return the name of the i-th column of the pIdx index.
27 */
28 static const char *explainIndexColumnName(Index *pIdx, int i){
29   i = pIdx->aiColumn[i];
30   if( i==XN_EXPR ) return "<expr>";
31   if( i==XN_ROWID ) return "rowid";
32   return pIdx->pTable->aCol[i].zCnName;
33 }
34 
35 /*
36 ** This routine is a helper for explainIndexRange() below
37 **
38 ** pStr holds the text of an expression that we are building up one term
39 ** at a time.  This routine adds a new term to the end of the expression.
40 ** Terms are separated by AND so add the "AND" text for second and subsequent
41 ** terms only.
42 */
43 static void explainAppendTerm(
44   StrAccum *pStr,             /* The text expression being built */
45   Index *pIdx,                /* Index to read column names from */
46   int nTerm,                  /* Number of terms */
47   int iTerm,                  /* Zero-based index of first term. */
48   int bAnd,                   /* Non-zero to append " AND " */
49   const char *zOp             /* Name of the operator */
50 ){
51   int i;
52 
53   assert( nTerm>=1 );
54   if( bAnd ) sqlite3_str_append(pStr, " AND ", 5);
55 
56   if( nTerm>1 ) sqlite3_str_append(pStr, "(", 1);
57   for(i=0; i<nTerm; i++){
58     if( i ) sqlite3_str_append(pStr, ",", 1);
59     sqlite3_str_appendall(pStr, explainIndexColumnName(pIdx, iTerm+i));
60   }
61   if( nTerm>1 ) sqlite3_str_append(pStr, ")", 1);
62 
63   sqlite3_str_append(pStr, zOp, 1);
64 
65   if( nTerm>1 ) sqlite3_str_append(pStr, "(", 1);
66   for(i=0; i<nTerm; i++){
67     if( i ) sqlite3_str_append(pStr, ",", 1);
68     sqlite3_str_append(pStr, "?", 1);
69   }
70   if( nTerm>1 ) sqlite3_str_append(pStr, ")", 1);
71 }
72 
73 /*
74 ** Argument pLevel describes a strategy for scanning table pTab. This
75 ** function appends text to pStr that describes the subset of table
76 ** rows scanned by the strategy in the form of an SQL expression.
77 **
78 ** For example, if the query:
79 **
80 **   SELECT * FROM t1 WHERE a=1 AND b>2;
81 **
82 ** is run and there is an index on (a, b), then this function returns a
83 ** string similar to:
84 **
85 **   "a=? AND b>?"
86 */
87 static void explainIndexRange(StrAccum *pStr, WhereLoop *pLoop){
88   Index *pIndex = pLoop->u.btree.pIndex;
89   u16 nEq = pLoop->u.btree.nEq;
90   u16 nSkip = pLoop->nSkip;
91   int i, j;
92 
93   if( nEq==0 && (pLoop->wsFlags&(WHERE_BTM_LIMIT|WHERE_TOP_LIMIT))==0 ) return;
94   sqlite3_str_append(pStr, " (", 2);
95   for(i=0; i<nEq; i++){
96     const char *z = explainIndexColumnName(pIndex, i);
97     if( i ) sqlite3_str_append(pStr, " AND ", 5);
98     sqlite3_str_appendf(pStr, i>=nSkip ? "%s=?" : "ANY(%s)", z);
99   }
100 
101   j = i;
102   if( pLoop->wsFlags&WHERE_BTM_LIMIT ){
103     explainAppendTerm(pStr, pIndex, pLoop->u.btree.nBtm, j, i, ">");
104     i = 1;
105   }
106   if( pLoop->wsFlags&WHERE_TOP_LIMIT ){
107     explainAppendTerm(pStr, pIndex, pLoop->u.btree.nTop, j, i, "<");
108   }
109   sqlite3_str_append(pStr, ")", 1);
110 }
111 
112 /*
113 ** This function is a no-op unless currently processing an EXPLAIN QUERY PLAN
114 ** command, or if either SQLITE_DEBUG or SQLITE_ENABLE_STMT_SCANSTATUS was
115 ** defined at compile-time. If it is not a no-op, a single OP_Explain opcode
116 ** is added to the output to describe the table scan strategy in pLevel.
117 **
118 ** If an OP_Explain opcode is added to the VM, its address is returned.
119 ** Otherwise, if no OP_Explain is coded, zero is returned.
120 */
121 int sqlite3WhereExplainOneScan(
122   Parse *pParse,                  /* Parse context */
123   SrcList *pTabList,              /* Table list this loop refers to */
124   WhereLevel *pLevel,             /* Scan to write OP_Explain opcode for */
125   u16 wctrlFlags                  /* Flags passed to sqlite3WhereBegin() */
126 ){
127   int ret = 0;
128 #if !defined(SQLITE_DEBUG) && !defined(SQLITE_ENABLE_STMT_SCANSTATUS)
129   if( sqlite3ParseToplevel(pParse)->explain==2 )
130 #endif
131   {
132     SrcItem *pItem = &pTabList->a[pLevel->iFrom];
133     Vdbe *v = pParse->pVdbe;      /* VM being constructed */
134     sqlite3 *db = pParse->db;     /* Database handle */
135     int isSearch;                 /* True for a SEARCH. False for SCAN. */
136     WhereLoop *pLoop;             /* The controlling WhereLoop object */
137     u32 flags;                    /* Flags that describe this loop */
138     char *zMsg;                   /* Text to add to EQP output */
139     StrAccum str;                 /* EQP output string */
140     char zBuf[100];               /* Initial space for EQP output string */
141 
142     pLoop = pLevel->pWLoop;
143     flags = pLoop->wsFlags;
144     if( (flags&WHERE_MULTI_OR) || (wctrlFlags&WHERE_OR_SUBCLAUSE) ) return 0;
145 
146     isSearch = (flags&(WHERE_BTM_LIMIT|WHERE_TOP_LIMIT))!=0
147             || ((flags&WHERE_VIRTUALTABLE)==0 && (pLoop->u.btree.nEq>0))
148             || (wctrlFlags&(WHERE_ORDERBY_MIN|WHERE_ORDERBY_MAX));
149 
150     sqlite3StrAccumInit(&str, db, zBuf, sizeof(zBuf), SQLITE_MAX_LENGTH);
151     str.printfFlags = SQLITE_PRINTF_INTERNAL;
152     sqlite3_str_appendf(&str, "%s %S", isSearch ? "SEARCH" : "SCAN", pItem);
153     if( (flags & (WHERE_IPK|WHERE_VIRTUALTABLE))==0 ){
154       const char *zFmt = 0;
155       Index *pIdx;
156 
157       assert( pLoop->u.btree.pIndex!=0 );
158       pIdx = pLoop->u.btree.pIndex;
159       assert( !(flags&WHERE_AUTO_INDEX) || (flags&WHERE_IDX_ONLY) );
160       if( !HasRowid(pItem->pTab) && IsPrimaryKeyIndex(pIdx) ){
161         if( isSearch ){
162           zFmt = "PRIMARY KEY";
163         }
164       }else if( flags & WHERE_PARTIALIDX ){
165         zFmt = "AUTOMATIC PARTIAL COVERING INDEX";
166       }else if( flags & WHERE_AUTO_INDEX ){
167         zFmt = "AUTOMATIC COVERING INDEX";
168       }else if( flags & WHERE_IDX_ONLY ){
169         zFmt = "COVERING INDEX %s";
170       }else{
171         zFmt = "INDEX %s";
172       }
173       if( zFmt ){
174         sqlite3_str_append(&str, " USING ", 7);
175         sqlite3_str_appendf(&str, zFmt, pIdx->zName);
176         explainIndexRange(&str, pLoop);
177       }
178     }else if( (flags & WHERE_IPK)!=0 && (flags & WHERE_CONSTRAINT)!=0 ){
179       char cRangeOp;
180 #if 0  /* Better output, but breaks many tests */
181       const Table *pTab = pItem->pTab;
182       const char *zRowid = pTab->iPKey>=0 ? pTab->aCol[pTab->iPKey].zCnName:
183                               "rowid";
184 #else
185       const char *zRowid = "rowid";
186 #endif
187       sqlite3_str_appendf(&str, " USING INTEGER PRIMARY KEY (%s", zRowid);
188       if( flags&(WHERE_COLUMN_EQ|WHERE_COLUMN_IN) ){
189         cRangeOp = '=';
190       }else if( (flags&WHERE_BOTH_LIMIT)==WHERE_BOTH_LIMIT ){
191         sqlite3_str_appendf(&str, ">? AND %s", zRowid);
192         cRangeOp = '<';
193       }else if( flags&WHERE_BTM_LIMIT ){
194         cRangeOp = '>';
195       }else{
196         assert( flags&WHERE_TOP_LIMIT);
197         cRangeOp = '<';
198       }
199       sqlite3_str_appendf(&str, "%c?)", cRangeOp);
200     }
201 #ifndef SQLITE_OMIT_VIRTUALTABLE
202     else if( (flags & WHERE_VIRTUALTABLE)!=0 ){
203       sqlite3_str_appendf(&str, " VIRTUAL TABLE INDEX %d:%s",
204                   pLoop->u.vtab.idxNum, pLoop->u.vtab.idxStr);
205     }
206 #endif
207 #ifdef SQLITE_EXPLAIN_ESTIMATED_ROWS
208     if( pLoop->nOut>=10 ){
209       sqlite3_str_appendf(&str, " (~%llu rows)",
210              sqlite3LogEstToInt(pLoop->nOut));
211     }else{
212       sqlite3_str_append(&str, " (~1 row)", 9);
213     }
214 #endif
215     zMsg = sqlite3StrAccumFinish(&str);
216     sqlite3ExplainBreakpoint("",zMsg);
217     ret = sqlite3VdbeAddOp4(v, OP_Explain, sqlite3VdbeCurrentAddr(v),
218                             pParse->addrExplain, 0, zMsg,P4_DYNAMIC);
219   }
220   return ret;
221 }
222 
223 /*
224 ** Add a single OP_Explain opcode that describes a Bloom filter.
225 **
226 ** Or if not processing EXPLAIN QUERY PLAN and not in a SQLITE_DEBUG and/or
227 ** SQLITE_ENABLE_STMT_SCANSTATUS build, then OP_Explain opcodes are not
228 ** required and this routine is a no-op.
229 **
230 ** If an OP_Explain opcode is added to the VM, its address is returned.
231 ** Otherwise, if no OP_Explain is coded, zero is returned.
232 */
233 int sqlite3WhereExplainBloomFilter(
234   const Parse *pParse,               /* Parse context */
235   const WhereInfo *pWInfo,           /* WHERE clause */
236   const WhereLevel *pLevel           /* Bloom filter on this level */
237 ){
238   int ret = 0;
239   SrcItem *pItem = &pWInfo->pTabList->a[pLevel->iFrom];
240   Vdbe *v = pParse->pVdbe;      /* VM being constructed */
241   sqlite3 *db = pParse->db;     /* Database handle */
242   char *zMsg;                   /* Text to add to EQP output */
243   int i;                        /* Loop counter */
244   WhereLoop *pLoop;             /* The where loop */
245   StrAccum str;                 /* EQP output string */
246   char zBuf[100];               /* Initial space for EQP output string */
247 
248   sqlite3StrAccumInit(&str, db, zBuf, sizeof(zBuf), SQLITE_MAX_LENGTH);
249   str.printfFlags = SQLITE_PRINTF_INTERNAL;
250   sqlite3_str_appendf(&str, "BLOOM FILTER ON %S (", pItem);
251   pLoop = pLevel->pWLoop;
252   if( pLoop->wsFlags & WHERE_IPK ){
253     const Table *pTab = pItem->pTab;
254     if( pTab->iPKey>=0 ){
255       sqlite3_str_appendf(&str, "%s=?", pTab->aCol[pTab->iPKey].zCnName);
256     }else{
257       sqlite3_str_appendf(&str, "rowid=?");
258     }
259   }else{
260     for(i=pLoop->nSkip; i<pLoop->u.btree.nEq; i++){
261       const char *z = explainIndexColumnName(pLoop->u.btree.pIndex, i);
262       if( i>pLoop->nSkip ) sqlite3_str_append(&str, " AND ", 5);
263       sqlite3_str_appendf(&str, "%s=?", z);
264     }
265   }
266   sqlite3_str_append(&str, ")", 1);
267   zMsg = sqlite3StrAccumFinish(&str);
268   ret = sqlite3VdbeAddOp4(v, OP_Explain, sqlite3VdbeCurrentAddr(v),
269                           pParse->addrExplain, 0, zMsg,P4_DYNAMIC);
270   return ret;
271 }
272 #endif /* SQLITE_OMIT_EXPLAIN */
273 
274 #ifdef SQLITE_ENABLE_STMT_SCANSTATUS
275 /*
276 ** Configure the VM passed as the first argument with an
277 ** sqlite3_stmt_scanstatus() entry corresponding to the scan used to
278 ** implement level pLvl. Argument pSrclist is a pointer to the FROM
279 ** clause that the scan reads data from.
280 **
281 ** If argument addrExplain is not 0, it must be the address of an
282 ** OP_Explain instruction that describes the same loop.
283 */
284 void sqlite3WhereAddScanStatus(
285   Vdbe *v,                        /* Vdbe to add scanstatus entry to */
286   SrcList *pSrclist,              /* FROM clause pLvl reads data from */
287   WhereLevel *pLvl,               /* Level to add scanstatus() entry for */
288   int addrExplain                 /* Address of OP_Explain (or 0) */
289 ){
290   const char *zObj = 0;
291   WhereLoop *pLoop = pLvl->pWLoop;
292   if( (pLoop->wsFlags & WHERE_VIRTUALTABLE)==0  &&  pLoop->u.btree.pIndex!=0 ){
293     zObj = pLoop->u.btree.pIndex->zName;
294   }else{
295     zObj = pSrclist->a[pLvl->iFrom].zName;
296   }
297   sqlite3VdbeScanStatus(
298       v, addrExplain, pLvl->addrBody, pLvl->addrVisit, pLoop->nOut, zObj
299   );
300 }
301 #endif
302 
303 
304 /*
305 ** Disable a term in the WHERE clause.  Except, do not disable the term
306 ** if it controls a LEFT OUTER JOIN and it did not originate in the ON
307 ** or USING clause of that join.
308 **
309 ** Consider the term t2.z='ok' in the following queries:
310 **
311 **   (1)  SELECT * FROM t1 LEFT JOIN t2 ON t1.a=t2.x WHERE t2.z='ok'
312 **   (2)  SELECT * FROM t1 LEFT JOIN t2 ON t1.a=t2.x AND t2.z='ok'
313 **   (3)  SELECT * FROM t1, t2 WHERE t1.a=t2.x AND t2.z='ok'
314 **
315 ** The t2.z='ok' is disabled in the in (2) because it originates
316 ** in the ON clause.  The term is disabled in (3) because it is not part
317 ** of a LEFT OUTER JOIN.  In (1), the term is not disabled.
318 **
319 ** Disabling a term causes that term to not be tested in the inner loop
320 ** of the join.  Disabling is an optimization.  When terms are satisfied
321 ** by indices, we disable them to prevent redundant tests in the inner
322 ** loop.  We would get the correct results if nothing were ever disabled,
323 ** but joins might run a little slower.  The trick is to disable as much
324 ** as we can without disabling too much.  If we disabled in (1), we'd get
325 ** the wrong answer.  See ticket #813.
326 **
327 ** If all the children of a term are disabled, then that term is also
328 ** automatically disabled.  In this way, terms get disabled if derived
329 ** virtual terms are tested first.  For example:
330 **
331 **      x GLOB 'abc*' AND x>='abc' AND x<'acd'
332 **      \___________/     \______/     \_____/
333 **         parent          child1       child2
334 **
335 ** Only the parent term was in the original WHERE clause.  The child1
336 ** and child2 terms were added by the LIKE optimization.  If both of
337 ** the virtual child terms are valid, then testing of the parent can be
338 ** skipped.
339 **
340 ** Usually the parent term is marked as TERM_CODED.  But if the parent
341 ** term was originally TERM_LIKE, then the parent gets TERM_LIKECOND instead.
342 ** The TERM_LIKECOND marking indicates that the term should be coded inside
343 ** a conditional such that is only evaluated on the second pass of a
344 ** LIKE-optimization loop, when scanning BLOBs instead of strings.
345 */
346 static void disableTerm(WhereLevel *pLevel, WhereTerm *pTerm){
347   int nLoop = 0;
348   assert( pTerm!=0 );
349   while( (pTerm->wtFlags & TERM_CODED)==0
350       && (pLevel->iLeftJoin==0 || ExprHasProperty(pTerm->pExpr, EP_FromJoin))
351       && (pLevel->notReady & pTerm->prereqAll)==0
352   ){
353     if( nLoop && (pTerm->wtFlags & TERM_LIKE)!=0 ){
354       pTerm->wtFlags |= TERM_LIKECOND;
355     }else{
356       pTerm->wtFlags |= TERM_CODED;
357     }
358 #ifdef WHERETRACE_ENABLED
359     if( sqlite3WhereTrace & 0x20000 ){
360       sqlite3DebugPrintf("DISABLE-");
361       sqlite3WhereTermPrint(pTerm, (int)(pTerm - (pTerm->pWC->a)));
362     }
363 #endif
364     if( pTerm->iParent<0 ) break;
365     pTerm = &pTerm->pWC->a[pTerm->iParent];
366     assert( pTerm!=0 );
367     pTerm->nChild--;
368     if( pTerm->nChild!=0 ) break;
369     nLoop++;
370   }
371 }
372 
373 /*
374 ** Code an OP_Affinity opcode to apply the column affinity string zAff
375 ** to the n registers starting at base.
376 **
377 ** As an optimization, SQLITE_AFF_BLOB and SQLITE_AFF_NONE entries (which
378 ** are no-ops) at the beginning and end of zAff are ignored.  If all entries
379 ** in zAff are SQLITE_AFF_BLOB or SQLITE_AFF_NONE, then no code gets generated.
380 **
381 ** This routine makes its own copy of zAff so that the caller is free
382 ** to modify zAff after this routine returns.
383 */
384 static void codeApplyAffinity(Parse *pParse, int base, int n, char *zAff){
385   Vdbe *v = pParse->pVdbe;
386   if( zAff==0 ){
387     assert( pParse->db->mallocFailed );
388     return;
389   }
390   assert( v!=0 );
391 
392   /* Adjust base and n to skip over SQLITE_AFF_BLOB and SQLITE_AFF_NONE
393   ** entries at the beginning and end of the affinity string.
394   */
395   assert( SQLITE_AFF_NONE<SQLITE_AFF_BLOB );
396   while( n>0 && zAff[0]<=SQLITE_AFF_BLOB ){
397     n--;
398     base++;
399     zAff++;
400   }
401   while( n>1 && zAff[n-1]<=SQLITE_AFF_BLOB ){
402     n--;
403   }
404 
405   /* Code the OP_Affinity opcode if there is anything left to do. */
406   if( n>0 ){
407     sqlite3VdbeAddOp4(v, OP_Affinity, base, n, 0, zAff, n);
408   }
409 }
410 
411 /*
412 ** Expression pRight, which is the RHS of a comparison operation, is
413 ** either a vector of n elements or, if n==1, a scalar expression.
414 ** Before the comparison operation, affinity zAff is to be applied
415 ** to the pRight values. This function modifies characters within the
416 ** affinity string to SQLITE_AFF_BLOB if either:
417 **
418 **   * the comparison will be performed with no affinity, or
419 **   * the affinity change in zAff is guaranteed not to change the value.
420 */
421 static void updateRangeAffinityStr(
422   Expr *pRight,                   /* RHS of comparison */
423   int n,                          /* Number of vector elements in comparison */
424   char *zAff                      /* Affinity string to modify */
425 ){
426   int i;
427   for(i=0; i<n; i++){
428     Expr *p = sqlite3VectorFieldSubexpr(pRight, i);
429     if( sqlite3CompareAffinity(p, zAff[i])==SQLITE_AFF_BLOB
430      || sqlite3ExprNeedsNoAffinityChange(p, zAff[i])
431     ){
432       zAff[i] = SQLITE_AFF_BLOB;
433     }
434   }
435 }
436 
437 
438 /*
439 ** pX is an expression of the form:  (vector) IN (SELECT ...)
440 ** In other words, it is a vector IN operator with a SELECT clause on the
441 ** LHS.  But not all terms in the vector are indexable and the terms might
442 ** not be in the correct order for indexing.
443 **
444 ** This routine makes a copy of the input pX expression and then adjusts
445 ** the vector on the LHS with corresponding changes to the SELECT so that
446 ** the vector contains only index terms and those terms are in the correct
447 ** order.  The modified IN expression is returned.  The caller is responsible
448 ** for deleting the returned expression.
449 **
450 ** Example:
451 **
452 **    CREATE TABLE t1(a,b,c,d,e,f);
453 **    CREATE INDEX t1x1 ON t1(e,c);
454 **    SELECT * FROM t1 WHERE (a,b,c,d,e) IN (SELECT v,w,x,y,z FROM t2)
455 **                           \_______________________________________/
456 **                                     The pX expression
457 **
458 ** Since only columns e and c can be used with the index, in that order,
459 ** the modified IN expression that is returned will be:
460 **
461 **        (e,c) IN (SELECT z,x FROM t2)
462 **
463 ** The reduced pX is different from the original (obviously) and thus is
464 ** only used for indexing, to improve performance.  The original unaltered
465 ** IN expression must also be run on each output row for correctness.
466 */
467 static Expr *removeUnindexableInClauseTerms(
468   Parse *pParse,        /* The parsing context */
469   int iEq,              /* Look at loop terms starting here */
470   WhereLoop *pLoop,     /* The current loop */
471   Expr *pX              /* The IN expression to be reduced */
472 ){
473   sqlite3 *db = pParse->db;
474   Expr *pNew;
475   pNew = sqlite3ExprDup(db, pX, 0);
476   if( db->mallocFailed==0 ){
477     ExprList *pOrigRhs;         /* Original unmodified RHS */
478     ExprList *pOrigLhs;         /* Original unmodified LHS */
479     ExprList *pRhs = 0;         /* New RHS after modifications */
480     ExprList *pLhs = 0;         /* New LHS after mods */
481     int i;                      /* Loop counter */
482     Select *pSelect;            /* Pointer to the SELECT on the RHS */
483 
484     assert( ExprUseXSelect(pNew) );
485     pOrigRhs = pNew->x.pSelect->pEList;
486     assert( pNew->pLeft!=0 );
487     assert( ExprUseXList(pNew->pLeft) );
488     pOrigLhs = pNew->pLeft->x.pList;
489     for(i=iEq; i<pLoop->nLTerm; i++){
490       if( pLoop->aLTerm[i]->pExpr==pX ){
491         int iField;
492         assert( (pLoop->aLTerm[i]->eOperator & (WO_OR|WO_AND))==0 );
493         iField = pLoop->aLTerm[i]->u.x.iField - 1;
494         if( pOrigRhs->a[iField].pExpr==0 ) continue; /* Duplicate PK column */
495         pRhs = sqlite3ExprListAppend(pParse, pRhs, pOrigRhs->a[iField].pExpr);
496         pOrigRhs->a[iField].pExpr = 0;
497         assert( pOrigLhs->a[iField].pExpr!=0 );
498         pLhs = sqlite3ExprListAppend(pParse, pLhs, pOrigLhs->a[iField].pExpr);
499         pOrigLhs->a[iField].pExpr = 0;
500       }
501     }
502     sqlite3ExprListDelete(db, pOrigRhs);
503     sqlite3ExprListDelete(db, pOrigLhs);
504     pNew->pLeft->x.pList = pLhs;
505     pNew->x.pSelect->pEList = pRhs;
506     if( pLhs && pLhs->nExpr==1 ){
507       /* Take care here not to generate a TK_VECTOR containing only a
508       ** single value. Since the parser never creates such a vector, some
509       ** of the subroutines do not handle this case.  */
510       Expr *p = pLhs->a[0].pExpr;
511       pLhs->a[0].pExpr = 0;
512       sqlite3ExprDelete(db, pNew->pLeft);
513       pNew->pLeft = p;
514     }
515     pSelect = pNew->x.pSelect;
516     if( pSelect->pOrderBy ){
517       /* If the SELECT statement has an ORDER BY clause, zero the
518       ** iOrderByCol variables. These are set to non-zero when an
519       ** ORDER BY term exactly matches one of the terms of the
520       ** result-set. Since the result-set of the SELECT statement may
521       ** have been modified or reordered, these variables are no longer
522       ** set correctly.  Since setting them is just an optimization,
523       ** it's easiest just to zero them here.  */
524       ExprList *pOrderBy = pSelect->pOrderBy;
525       for(i=0; i<pOrderBy->nExpr; i++){
526         pOrderBy->a[i].u.x.iOrderByCol = 0;
527       }
528     }
529 
530 #if 0
531     printf("For indexing, change the IN expr:\n");
532     sqlite3TreeViewExpr(0, pX, 0);
533     printf("Into:\n");
534     sqlite3TreeViewExpr(0, pNew, 0);
535 #endif
536   }
537   return pNew;
538 }
539 
540 
541 /*
542 ** Generate code for a single equality term of the WHERE clause.  An equality
543 ** term can be either X=expr or X IN (...).   pTerm is the term to be
544 ** coded.
545 **
546 ** The current value for the constraint is left in a register, the index
547 ** of which is returned.  An attempt is made store the result in iTarget but
548 ** this is only guaranteed for TK_ISNULL and TK_IN constraints.  If the
549 ** constraint is a TK_EQ or TK_IS, then the current value might be left in
550 ** some other register and it is the caller's responsibility to compensate.
551 **
552 ** For a constraint of the form X=expr, the expression is evaluated in
553 ** straight-line code.  For constraints of the form X IN (...)
554 ** this routine sets up a loop that will iterate over all values of X.
555 */
556 static int codeEqualityTerm(
557   Parse *pParse,      /* The parsing context */
558   WhereTerm *pTerm,   /* The term of the WHERE clause to be coded */
559   WhereLevel *pLevel, /* The level of the FROM clause we are working on */
560   int iEq,            /* Index of the equality term within this level */
561   int bRev,           /* True for reverse-order IN operations */
562   int iTarget         /* Attempt to leave results in this register */
563 ){
564   Expr *pX = pTerm->pExpr;
565   Vdbe *v = pParse->pVdbe;
566   int iReg;                  /* Register holding results */
567 
568   assert( pLevel->pWLoop->aLTerm[iEq]==pTerm );
569   assert( iTarget>0 );
570   if( pX->op==TK_EQ || pX->op==TK_IS ){
571     iReg = sqlite3ExprCodeTarget(pParse, pX->pRight, iTarget);
572   }else if( pX->op==TK_ISNULL ){
573     iReg = iTarget;
574     sqlite3VdbeAddOp2(v, OP_Null, 0, iReg);
575 #ifndef SQLITE_OMIT_SUBQUERY
576   }else{
577     int eType = IN_INDEX_NOOP;
578     int iTab;
579     struct InLoop *pIn;
580     WhereLoop *pLoop = pLevel->pWLoop;
581     int i;
582     int nEq = 0;
583     int *aiMap = 0;
584 
585     if( (pLoop->wsFlags & WHERE_VIRTUALTABLE)==0
586       && pLoop->u.btree.pIndex!=0
587       && pLoop->u.btree.pIndex->aSortOrder[iEq]
588     ){
589       testcase( iEq==0 );
590       testcase( bRev );
591       bRev = !bRev;
592     }
593     assert( pX->op==TK_IN );
594     iReg = iTarget;
595 
596     for(i=0; i<iEq; i++){
597       if( pLoop->aLTerm[i] && pLoop->aLTerm[i]->pExpr==pX ){
598         disableTerm(pLevel, pTerm);
599         return iTarget;
600       }
601     }
602     for(i=iEq;i<pLoop->nLTerm; i++){
603       assert( pLoop->aLTerm[i]!=0 );
604       if( pLoop->aLTerm[i]->pExpr==pX ) nEq++;
605     }
606 
607     iTab = 0;
608     if( !ExprUseXSelect(pX) || pX->x.pSelect->pEList->nExpr==1 ){
609       eType = sqlite3FindInIndex(pParse, pX, IN_INDEX_LOOP, 0, 0, &iTab);
610     }else{
611       sqlite3 *db = pParse->db;
612       pX = removeUnindexableInClauseTerms(pParse, iEq, pLoop, pX);
613 
614       if( !db->mallocFailed ){
615         aiMap = (int*)sqlite3DbMallocZero(pParse->db, sizeof(int)*nEq);
616         eType = sqlite3FindInIndex(pParse, pX, IN_INDEX_LOOP, 0, aiMap, &iTab);
617         pTerm->pExpr->iTable = iTab;
618       }
619       sqlite3ExprDelete(db, pX);
620       pX = pTerm->pExpr;
621     }
622 
623     if( eType==IN_INDEX_INDEX_DESC ){
624       testcase( bRev );
625       bRev = !bRev;
626     }
627     sqlite3VdbeAddOp2(v, bRev ? OP_Last : OP_Rewind, iTab, 0);
628     VdbeCoverageIf(v, bRev);
629     VdbeCoverageIf(v, !bRev);
630 
631     assert( (pLoop->wsFlags & WHERE_MULTI_OR)==0 );
632     pLoop->wsFlags |= WHERE_IN_ABLE;
633     if( pLevel->u.in.nIn==0 ){
634       pLevel->addrNxt = sqlite3VdbeMakeLabel(pParse);
635     }
636     if( iEq>0 && (pLoop->wsFlags & WHERE_IN_SEEKSCAN)==0 ){
637       pLoop->wsFlags |= WHERE_IN_EARLYOUT;
638     }
639 
640     i = pLevel->u.in.nIn;
641     pLevel->u.in.nIn += nEq;
642     pLevel->u.in.aInLoop =
643        sqlite3DbReallocOrFree(pParse->db, pLevel->u.in.aInLoop,
644                               sizeof(pLevel->u.in.aInLoop[0])*pLevel->u.in.nIn);
645     pIn = pLevel->u.in.aInLoop;
646     if( pIn ){
647       int iMap = 0;               /* Index in aiMap[] */
648       pIn += i;
649       for(i=iEq;i<pLoop->nLTerm; i++){
650         if( pLoop->aLTerm[i]->pExpr==pX ){
651           int iOut = iReg + i - iEq;
652           if( eType==IN_INDEX_ROWID ){
653             pIn->addrInTop = sqlite3VdbeAddOp2(v, OP_Rowid, iTab, iOut);
654           }else{
655             int iCol = aiMap ? aiMap[iMap++] : 0;
656             pIn->addrInTop = sqlite3VdbeAddOp3(v,OP_Column,iTab, iCol, iOut);
657           }
658           sqlite3VdbeAddOp1(v, OP_IsNull, iOut); VdbeCoverage(v);
659           if( i==iEq ){
660             pIn->iCur = iTab;
661             pIn->eEndLoopOp = bRev ? OP_Prev : OP_Next;
662             if( iEq>0 ){
663               pIn->iBase = iReg - i;
664               pIn->nPrefix = i;
665             }else{
666               pIn->nPrefix = 0;
667             }
668           }else{
669             pIn->eEndLoopOp = OP_Noop;
670           }
671           pIn++;
672         }
673       }
674       testcase( iEq>0
675                 && (pLoop->wsFlags & WHERE_IN_SEEKSCAN)==0
676                 && (pLoop->wsFlags & WHERE_VIRTUALTABLE)!=0 );
677       if( iEq>0
678        && (pLoop->wsFlags & (WHERE_IN_SEEKSCAN|WHERE_VIRTUALTABLE))==0
679       ){
680         sqlite3VdbeAddOp3(v, OP_SeekHit, pLevel->iIdxCur, 0, iEq);
681       }
682     }else{
683       pLevel->u.in.nIn = 0;
684     }
685     sqlite3DbFree(pParse->db, aiMap);
686 #endif
687   }
688 
689   /* As an optimization, try to disable the WHERE clause term that is
690   ** driving the index as it will always be true.  The correct answer is
691   ** obtained regardless, but we might get the answer with fewer CPU cycles
692   ** by omitting the term.
693   **
694   ** But do not disable the term unless we are certain that the term is
695   ** not a transitive constraint.  For an example of where that does not
696   ** work, see https://sqlite.org/forum/forumpost/eb8613976a (2021-05-04)
697   */
698   if( (pLevel->pWLoop->wsFlags & WHERE_TRANSCONS)==0
699    || (pTerm->eOperator & WO_EQUIV)==0
700   ){
701     disableTerm(pLevel, pTerm);
702   }
703 
704   return iReg;
705 }
706 
707 /*
708 ** Generate code that will evaluate all == and IN constraints for an
709 ** index scan.
710 **
711 ** For example, consider table t1(a,b,c,d,e,f) with index i1(a,b,c).
712 ** Suppose the WHERE clause is this:  a==5 AND b IN (1,2,3) AND c>5 AND c<10
713 ** The index has as many as three equality constraints, but in this
714 ** example, the third "c" value is an inequality.  So only two
715 ** constraints are coded.  This routine will generate code to evaluate
716 ** a==5 and b IN (1,2,3).  The current values for a and b will be stored
717 ** in consecutive registers and the index of the first register is returned.
718 **
719 ** In the example above nEq==2.  But this subroutine works for any value
720 ** of nEq including 0.  If nEq==0, this routine is nearly a no-op.
721 ** The only thing it does is allocate the pLevel->iMem memory cell and
722 ** compute the affinity string.
723 **
724 ** The nExtraReg parameter is 0 or 1.  It is 0 if all WHERE clause constraints
725 ** are == or IN and are covered by the nEq.  nExtraReg is 1 if there is
726 ** an inequality constraint (such as the "c>=5 AND c<10" in the example) that
727 ** occurs after the nEq quality constraints.
728 **
729 ** This routine allocates a range of nEq+nExtraReg memory cells and returns
730 ** the index of the first memory cell in that range. The code that
731 ** calls this routine will use that memory range to store keys for
732 ** start and termination conditions of the loop.
733 ** key value of the loop.  If one or more IN operators appear, then
734 ** this routine allocates an additional nEq memory cells for internal
735 ** use.
736 **
737 ** Before returning, *pzAff is set to point to a buffer containing a
738 ** copy of the column affinity string of the index allocated using
739 ** sqlite3DbMalloc(). Except, entries in the copy of the string associated
740 ** with equality constraints that use BLOB or NONE affinity are set to
741 ** SQLITE_AFF_BLOB. This is to deal with SQL such as the following:
742 **
743 **   CREATE TABLE t1(a TEXT PRIMARY KEY, b);
744 **   SELECT ... FROM t1 AS t2, t1 WHERE t1.a = t2.b;
745 **
746 ** In the example above, the index on t1(a) has TEXT affinity. But since
747 ** the right hand side of the equality constraint (t2.b) has BLOB/NONE affinity,
748 ** no conversion should be attempted before using a t2.b value as part of
749 ** a key to search the index. Hence the first byte in the returned affinity
750 ** string in this example would be set to SQLITE_AFF_BLOB.
751 */
752 static int codeAllEqualityTerms(
753   Parse *pParse,        /* Parsing context */
754   WhereLevel *pLevel,   /* Which nested loop of the FROM we are coding */
755   int bRev,             /* Reverse the order of IN operators */
756   int nExtraReg,        /* Number of extra registers to allocate */
757   char **pzAff          /* OUT: Set to point to affinity string */
758 ){
759   u16 nEq;                      /* The number of == or IN constraints to code */
760   u16 nSkip;                    /* Number of left-most columns to skip */
761   Vdbe *v = pParse->pVdbe;      /* The vm under construction */
762   Index *pIdx;                  /* The index being used for this loop */
763   WhereTerm *pTerm;             /* A single constraint term */
764   WhereLoop *pLoop;             /* The WhereLoop object */
765   int j;                        /* Loop counter */
766   int regBase;                  /* Base register */
767   int nReg;                     /* Number of registers to allocate */
768   char *zAff;                   /* Affinity string to return */
769 
770   /* This module is only called on query plans that use an index. */
771   pLoop = pLevel->pWLoop;
772   assert( (pLoop->wsFlags & WHERE_VIRTUALTABLE)==0 );
773   nEq = pLoop->u.btree.nEq;
774   nSkip = pLoop->nSkip;
775   pIdx = pLoop->u.btree.pIndex;
776   assert( pIdx!=0 );
777 
778   /* Figure out how many memory cells we will need then allocate them.
779   */
780   regBase = pParse->nMem + 1;
781   nReg = pLoop->u.btree.nEq + nExtraReg;
782   pParse->nMem += nReg;
783 
784   zAff = sqlite3DbStrDup(pParse->db,sqlite3IndexAffinityStr(pParse->db,pIdx));
785   assert( zAff!=0 || pParse->db->mallocFailed );
786 
787   if( nSkip ){
788     int iIdxCur = pLevel->iIdxCur;
789     sqlite3VdbeAddOp3(v, OP_Null, 0, regBase, regBase+nSkip-1);
790     sqlite3VdbeAddOp1(v, (bRev?OP_Last:OP_Rewind), iIdxCur);
791     VdbeCoverageIf(v, bRev==0);
792     VdbeCoverageIf(v, bRev!=0);
793     VdbeComment((v, "begin skip-scan on %s", pIdx->zName));
794     j = sqlite3VdbeAddOp0(v, OP_Goto);
795     pLevel->addrSkip = sqlite3VdbeAddOp4Int(v, (bRev?OP_SeekLT:OP_SeekGT),
796                             iIdxCur, 0, regBase, nSkip);
797     VdbeCoverageIf(v, bRev==0);
798     VdbeCoverageIf(v, bRev!=0);
799     sqlite3VdbeJumpHere(v, j);
800     for(j=0; j<nSkip; j++){
801       sqlite3VdbeAddOp3(v, OP_Column, iIdxCur, j, regBase+j);
802       testcase( pIdx->aiColumn[j]==XN_EXPR );
803       VdbeComment((v, "%s", explainIndexColumnName(pIdx, j)));
804     }
805   }
806 
807   /* Evaluate the equality constraints
808   */
809   assert( zAff==0 || (int)strlen(zAff)>=nEq );
810   for(j=nSkip; j<nEq; j++){
811     int r1;
812     pTerm = pLoop->aLTerm[j];
813     assert( pTerm!=0 );
814     /* The following testcase is true for indices with redundant columns.
815     ** Ex: CREATE INDEX i1 ON t1(a,b,a); SELECT * FROM t1 WHERE a=0 AND b=0; */
816     testcase( (pTerm->wtFlags & TERM_CODED)!=0 );
817     testcase( pTerm->wtFlags & TERM_VIRTUAL );
818     r1 = codeEqualityTerm(pParse, pTerm, pLevel, j, bRev, regBase+j);
819     if( r1!=regBase+j ){
820       if( nReg==1 ){
821         sqlite3ReleaseTempReg(pParse, regBase);
822         regBase = r1;
823       }else{
824         sqlite3VdbeAddOp2(v, OP_Copy, r1, regBase+j);
825       }
826     }
827     if( pTerm->eOperator & WO_IN ){
828       if( pTerm->pExpr->flags & EP_xIsSelect ){
829         /* No affinity ever needs to be (or should be) applied to a value
830         ** from the RHS of an "? IN (SELECT ...)" expression. The
831         ** sqlite3FindInIndex() routine has already ensured that the
832         ** affinity of the comparison has been applied to the value.  */
833         if( zAff ) zAff[j] = SQLITE_AFF_BLOB;
834       }
835     }else if( (pTerm->eOperator & WO_ISNULL)==0 ){
836       Expr *pRight = pTerm->pExpr->pRight;
837       if( (pTerm->wtFlags & TERM_IS)==0 && sqlite3ExprCanBeNull(pRight) ){
838         sqlite3VdbeAddOp2(v, OP_IsNull, regBase+j, pLevel->addrBrk);
839         VdbeCoverage(v);
840       }
841       if( pParse->db->mallocFailed==0 && pParse->nErr==0 ){
842         if( sqlite3CompareAffinity(pRight, zAff[j])==SQLITE_AFF_BLOB ){
843           zAff[j] = SQLITE_AFF_BLOB;
844         }
845         if( sqlite3ExprNeedsNoAffinityChange(pRight, zAff[j]) ){
846           zAff[j] = SQLITE_AFF_BLOB;
847         }
848       }
849     }
850   }
851   *pzAff = zAff;
852   return regBase;
853 }
854 
855 #ifndef SQLITE_LIKE_DOESNT_MATCH_BLOBS
856 /*
857 ** If the most recently coded instruction is a constant range constraint
858 ** (a string literal) that originated from the LIKE optimization, then
859 ** set P3 and P5 on the OP_String opcode so that the string will be cast
860 ** to a BLOB at appropriate times.
861 **
862 ** The LIKE optimization trys to evaluate "x LIKE 'abc%'" as a range
863 ** expression: "x>='ABC' AND x<'abd'".  But this requires that the range
864 ** scan loop run twice, once for strings and a second time for BLOBs.
865 ** The OP_String opcodes on the second pass convert the upper and lower
866 ** bound string constants to blobs.  This routine makes the necessary changes
867 ** to the OP_String opcodes for that to happen.
868 **
869 ** Except, of course, if SQLITE_LIKE_DOESNT_MATCH_BLOBS is defined, then
870 ** only the one pass through the string space is required, so this routine
871 ** becomes a no-op.
872 */
873 static void whereLikeOptimizationStringFixup(
874   Vdbe *v,                /* prepared statement under construction */
875   WhereLevel *pLevel,     /* The loop that contains the LIKE operator */
876   WhereTerm *pTerm        /* The upper or lower bound just coded */
877 ){
878   if( pTerm->wtFlags & TERM_LIKEOPT ){
879     VdbeOp *pOp;
880     assert( pLevel->iLikeRepCntr>0 );
881     pOp = sqlite3VdbeGetOp(v, -1);
882     assert( pOp!=0 );
883     assert( pOp->opcode==OP_String8
884             || pTerm->pWC->pWInfo->pParse->db->mallocFailed );
885     pOp->p3 = (int)(pLevel->iLikeRepCntr>>1);  /* Register holding counter */
886     pOp->p5 = (u8)(pLevel->iLikeRepCntr&1);    /* ASC or DESC */
887   }
888 }
889 #else
890 # define whereLikeOptimizationStringFixup(A,B,C)
891 #endif
892 
893 #ifdef SQLITE_ENABLE_CURSOR_HINTS
894 /*
895 ** Information is passed from codeCursorHint() down to individual nodes of
896 ** the expression tree (by sqlite3WalkExpr()) using an instance of this
897 ** structure.
898 */
899 struct CCurHint {
900   int iTabCur;    /* Cursor for the main table */
901   int iIdxCur;    /* Cursor for the index, if pIdx!=0.  Unused otherwise */
902   Index *pIdx;    /* The index used to access the table */
903 };
904 
905 /*
906 ** This function is called for every node of an expression that is a candidate
907 ** for a cursor hint on an index cursor.  For TK_COLUMN nodes that reference
908 ** the table CCurHint.iTabCur, verify that the same column can be
909 ** accessed through the index.  If it cannot, then set pWalker->eCode to 1.
910 */
911 static int codeCursorHintCheckExpr(Walker *pWalker, Expr *pExpr){
912   struct CCurHint *pHint = pWalker->u.pCCurHint;
913   assert( pHint->pIdx!=0 );
914   if( pExpr->op==TK_COLUMN
915    && pExpr->iTable==pHint->iTabCur
916    && sqlite3TableColumnToIndex(pHint->pIdx, pExpr->iColumn)<0
917   ){
918     pWalker->eCode = 1;
919   }
920   return WRC_Continue;
921 }
922 
923 /*
924 ** Test whether or not expression pExpr, which was part of a WHERE clause,
925 ** should be included in the cursor-hint for a table that is on the rhs
926 ** of a LEFT JOIN. Set Walker.eCode to non-zero before returning if the
927 ** expression is not suitable.
928 **
929 ** An expression is unsuitable if it might evaluate to non NULL even if
930 ** a TK_COLUMN node that does affect the value of the expression is set
931 ** to NULL. For example:
932 **
933 **   col IS NULL
934 **   col IS NOT NULL
935 **   coalesce(col, 1)
936 **   CASE WHEN col THEN 0 ELSE 1 END
937 */
938 static int codeCursorHintIsOrFunction(Walker *pWalker, Expr *pExpr){
939   if( pExpr->op==TK_IS
940    || pExpr->op==TK_ISNULL || pExpr->op==TK_ISNOT
941    || pExpr->op==TK_NOTNULL || pExpr->op==TK_CASE
942   ){
943     pWalker->eCode = 1;
944   }else if( pExpr->op==TK_FUNCTION ){
945     int d1;
946     char d2[4];
947     if( 0==sqlite3IsLikeFunction(pWalker->pParse->db, pExpr, &d1, d2) ){
948       pWalker->eCode = 1;
949     }
950   }
951 
952   return WRC_Continue;
953 }
954 
955 
956 /*
957 ** This function is called on every node of an expression tree used as an
958 ** argument to the OP_CursorHint instruction. If the node is a TK_COLUMN
959 ** that accesses any table other than the one identified by
960 ** CCurHint.iTabCur, then do the following:
961 **
962 **   1) allocate a register and code an OP_Column instruction to read
963 **      the specified column into the new register, and
964 **
965 **   2) transform the expression node to a TK_REGISTER node that reads
966 **      from the newly populated register.
967 **
968 ** Also, if the node is a TK_COLUMN that does access the table idenified
969 ** by pCCurHint.iTabCur, and an index is being used (which we will
970 ** know because CCurHint.pIdx!=0) then transform the TK_COLUMN into
971 ** an access of the index rather than the original table.
972 */
973 static int codeCursorHintFixExpr(Walker *pWalker, Expr *pExpr){
974   int rc = WRC_Continue;
975   struct CCurHint *pHint = pWalker->u.pCCurHint;
976   if( pExpr->op==TK_COLUMN ){
977     if( pExpr->iTable!=pHint->iTabCur ){
978       int reg = ++pWalker->pParse->nMem;   /* Register for column value */
979       sqlite3ExprCode(pWalker->pParse, pExpr, reg);
980       pExpr->op = TK_REGISTER;
981       pExpr->iTable = reg;
982     }else if( pHint->pIdx!=0 ){
983       pExpr->iTable = pHint->iIdxCur;
984       pExpr->iColumn = sqlite3TableColumnToIndex(pHint->pIdx, pExpr->iColumn);
985       assert( pExpr->iColumn>=0 );
986     }
987   }else if( pExpr->op==TK_AGG_FUNCTION ){
988     /* An aggregate function in the WHERE clause of a query means this must
989     ** be a correlated sub-query, and expression pExpr is an aggregate from
990     ** the parent context. Do not walk the function arguments in this case.
991     **
992     ** todo: It should be possible to replace this node with a TK_REGISTER
993     ** expression, as the result of the expression must be stored in a
994     ** register at this point. The same holds for TK_AGG_COLUMN nodes. */
995     rc = WRC_Prune;
996   }
997   return rc;
998 }
999 
1000 /*
1001 ** Insert an OP_CursorHint instruction if it is appropriate to do so.
1002 */
1003 static void codeCursorHint(
1004   SrcItem *pTabItem,  /* FROM clause item */
1005   WhereInfo *pWInfo,    /* The where clause */
1006   WhereLevel *pLevel,   /* Which loop to provide hints for */
1007   WhereTerm *pEndRange  /* Hint this end-of-scan boundary term if not NULL */
1008 ){
1009   Parse *pParse = pWInfo->pParse;
1010   sqlite3 *db = pParse->db;
1011   Vdbe *v = pParse->pVdbe;
1012   Expr *pExpr = 0;
1013   WhereLoop *pLoop = pLevel->pWLoop;
1014   int iCur;
1015   WhereClause *pWC;
1016   WhereTerm *pTerm;
1017   int i, j;
1018   struct CCurHint sHint;
1019   Walker sWalker;
1020 
1021   if( OptimizationDisabled(db, SQLITE_CursorHints) ) return;
1022   iCur = pLevel->iTabCur;
1023   assert( iCur==pWInfo->pTabList->a[pLevel->iFrom].iCursor );
1024   sHint.iTabCur = iCur;
1025   sHint.iIdxCur = pLevel->iIdxCur;
1026   sHint.pIdx = pLoop->u.btree.pIndex;
1027   memset(&sWalker, 0, sizeof(sWalker));
1028   sWalker.pParse = pParse;
1029   sWalker.u.pCCurHint = &sHint;
1030   pWC = &pWInfo->sWC;
1031   for(i=0; i<pWC->nBase; i++){
1032     pTerm = &pWC->a[i];
1033     if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
1034     if( pTerm->prereqAll & pLevel->notReady ) continue;
1035 
1036     /* Any terms specified as part of the ON(...) clause for any LEFT
1037     ** JOIN for which the current table is not the rhs are omitted
1038     ** from the cursor-hint.
1039     **
1040     ** If this table is the rhs of a LEFT JOIN, "IS" or "IS NULL" terms
1041     ** that were specified as part of the WHERE clause must be excluded.
1042     ** This is to address the following:
1043     **
1044     **   SELECT ... t1 LEFT JOIN t2 ON (t1.a=t2.b) WHERE t2.c IS NULL;
1045     **
1046     ** Say there is a single row in t2 that matches (t1.a=t2.b), but its
1047     ** t2.c values is not NULL. If the (t2.c IS NULL) constraint is
1048     ** pushed down to the cursor, this row is filtered out, causing
1049     ** SQLite to synthesize a row of NULL values. Which does match the
1050     ** WHERE clause, and so the query returns a row. Which is incorrect.
1051     **
1052     ** For the same reason, WHERE terms such as:
1053     **
1054     **   WHERE 1 = (t2.c IS NULL)
1055     **
1056     ** are also excluded. See codeCursorHintIsOrFunction() for details.
1057     */
1058     if( pTabItem->fg.jointype & JT_LEFT ){
1059       Expr *pExpr = pTerm->pExpr;
1060       if( !ExprHasProperty(pExpr, EP_FromJoin)
1061        || pExpr->iRightJoinTable!=pTabItem->iCursor
1062       ){
1063         sWalker.eCode = 0;
1064         sWalker.xExprCallback = codeCursorHintIsOrFunction;
1065         sqlite3WalkExpr(&sWalker, pTerm->pExpr);
1066         if( sWalker.eCode ) continue;
1067       }
1068     }else{
1069       if( ExprHasProperty(pTerm->pExpr, EP_FromJoin) ) continue;
1070     }
1071 
1072     /* All terms in pWLoop->aLTerm[] except pEndRange are used to initialize
1073     ** the cursor.  These terms are not needed as hints for a pure range
1074     ** scan (that has no == terms) so omit them. */
1075     if( pLoop->u.btree.nEq==0 && pTerm!=pEndRange ){
1076       for(j=0; j<pLoop->nLTerm && pLoop->aLTerm[j]!=pTerm; j++){}
1077       if( j<pLoop->nLTerm ) continue;
1078     }
1079 
1080     /* No subqueries or non-deterministic functions allowed */
1081     if( sqlite3ExprContainsSubquery(pTerm->pExpr) ) continue;
1082 
1083     /* For an index scan, make sure referenced columns are actually in
1084     ** the index. */
1085     if( sHint.pIdx!=0 ){
1086       sWalker.eCode = 0;
1087       sWalker.xExprCallback = codeCursorHintCheckExpr;
1088       sqlite3WalkExpr(&sWalker, pTerm->pExpr);
1089       if( sWalker.eCode ) continue;
1090     }
1091 
1092     /* If we survive all prior tests, that means this term is worth hinting */
1093     pExpr = sqlite3ExprAnd(pParse, pExpr, sqlite3ExprDup(db, pTerm->pExpr, 0));
1094   }
1095   if( pExpr!=0 ){
1096     sWalker.xExprCallback = codeCursorHintFixExpr;
1097     sqlite3WalkExpr(&sWalker, pExpr);
1098     sqlite3VdbeAddOp4(v, OP_CursorHint,
1099                       (sHint.pIdx ? sHint.iIdxCur : sHint.iTabCur), 0, 0,
1100                       (const char*)pExpr, P4_EXPR);
1101   }
1102 }
1103 #else
1104 # define codeCursorHint(A,B,C,D)  /* No-op */
1105 #endif /* SQLITE_ENABLE_CURSOR_HINTS */
1106 
1107 /*
1108 ** Cursor iCur is open on an intkey b-tree (a table). Register iRowid contains
1109 ** a rowid value just read from cursor iIdxCur, open on index pIdx. This
1110 ** function generates code to do a deferred seek of cursor iCur to the
1111 ** rowid stored in register iRowid.
1112 **
1113 ** Normally, this is just:
1114 **
1115 **   OP_DeferredSeek $iCur $iRowid
1116 **
1117 ** However, if the scan currently being coded is a branch of an OR-loop and
1118 ** the statement currently being coded is a SELECT, then P3 of OP_DeferredSeek
1119 ** is set to iIdxCur and P4 is set to point to an array of integers
1120 ** containing one entry for each column of the table cursor iCur is open
1121 ** on. For each table column, if the column is the i'th column of the
1122 ** index, then the corresponding array entry is set to (i+1). If the column
1123 ** does not appear in the index at all, the array entry is set to 0.
1124 */
1125 static void codeDeferredSeek(
1126   WhereInfo *pWInfo,              /* Where clause context */
1127   Index *pIdx,                    /* Index scan is using */
1128   int iCur,                       /* Cursor for IPK b-tree */
1129   int iIdxCur                     /* Index cursor */
1130 ){
1131   Parse *pParse = pWInfo->pParse; /* Parse context */
1132   Vdbe *v = pParse->pVdbe;        /* Vdbe to generate code within */
1133 
1134   assert( iIdxCur>0 );
1135   assert( pIdx->aiColumn[pIdx->nColumn-1]==-1 );
1136 
1137   pWInfo->bDeferredSeek = 1;
1138   sqlite3VdbeAddOp3(v, OP_DeferredSeek, iIdxCur, 0, iCur);
1139   if( (pWInfo->wctrlFlags & WHERE_OR_SUBCLAUSE)
1140    && DbMaskAllZero(sqlite3ParseToplevel(pParse)->writeMask)
1141   ){
1142     int i;
1143     Table *pTab = pIdx->pTable;
1144     u32 *ai = (u32*)sqlite3DbMallocZero(pParse->db, sizeof(u32)*(pTab->nCol+1));
1145     if( ai ){
1146       ai[0] = pTab->nCol;
1147       for(i=0; i<pIdx->nColumn-1; i++){
1148         int x1, x2;
1149         assert( pIdx->aiColumn[i]<pTab->nCol );
1150         x1 = pIdx->aiColumn[i];
1151         x2 = sqlite3TableColumnToStorage(pTab, x1);
1152         testcase( x1!=x2 );
1153         if( x1>=0 ) ai[x2+1] = i+1;
1154       }
1155       sqlite3VdbeChangeP4(v, -1, (char*)ai, P4_INTARRAY);
1156     }
1157   }
1158 }
1159 
1160 /*
1161 ** If the expression passed as the second argument is a vector, generate
1162 ** code to write the first nReg elements of the vector into an array
1163 ** of registers starting with iReg.
1164 **
1165 ** If the expression is not a vector, then nReg must be passed 1. In
1166 ** this case, generate code to evaluate the expression and leave the
1167 ** result in register iReg.
1168 */
1169 static void codeExprOrVector(Parse *pParse, Expr *p, int iReg, int nReg){
1170   assert( nReg>0 );
1171   if( p && sqlite3ExprIsVector(p) ){
1172 #ifndef SQLITE_OMIT_SUBQUERY
1173     if( ExprUseXSelect(p) ){
1174       Vdbe *v = pParse->pVdbe;
1175       int iSelect;
1176       assert( p->op==TK_SELECT );
1177       iSelect = sqlite3CodeSubselect(pParse, p);
1178       sqlite3VdbeAddOp3(v, OP_Copy, iSelect, iReg, nReg-1);
1179     }else
1180 #endif
1181     {
1182       int i;
1183       const ExprList *pList;
1184       assert( ExprUseXList(p) );
1185       pList = p->x.pList;
1186       assert( nReg<=pList->nExpr );
1187       for(i=0; i<nReg; i++){
1188         sqlite3ExprCode(pParse, pList->a[i].pExpr, iReg+i);
1189       }
1190     }
1191   }else{
1192     assert( nReg==1 || pParse->nErr );
1193     sqlite3ExprCode(pParse, p, iReg);
1194   }
1195 }
1196 
1197 /* An instance of the IdxExprTrans object carries information about a
1198 ** mapping from an expression on table columns into a column in an index
1199 ** down through the Walker.
1200 */
1201 typedef struct IdxExprTrans {
1202   Expr *pIdxExpr;    /* The index expression */
1203   int iTabCur;       /* The cursor of the corresponding table */
1204   int iIdxCur;       /* The cursor for the index */
1205   int iIdxCol;       /* The column for the index */
1206   int iTabCol;       /* The column for the table */
1207   WhereInfo *pWInfo; /* Complete WHERE clause information */
1208   sqlite3 *db;       /* Database connection (for malloc()) */
1209 } IdxExprTrans;
1210 
1211 /*
1212 ** Preserve pExpr on the WhereETrans list of the WhereInfo.
1213 */
1214 static void preserveExpr(IdxExprTrans *pTrans, Expr *pExpr){
1215   WhereExprMod *pNew;
1216   pNew = sqlite3DbMallocRaw(pTrans->db, sizeof(*pNew));
1217   if( pNew==0 ) return;
1218   pNew->pNext = pTrans->pWInfo->pExprMods;
1219   pTrans->pWInfo->pExprMods = pNew;
1220   pNew->pExpr = pExpr;
1221   memcpy(&pNew->orig, pExpr, sizeof(*pExpr));
1222 }
1223 
1224 /* The walker node callback used to transform matching expressions into
1225 ** a reference to an index column for an index on an expression.
1226 **
1227 ** If pExpr matches, then transform it into a reference to the index column
1228 ** that contains the value of pExpr.
1229 */
1230 static int whereIndexExprTransNode(Walker *p, Expr *pExpr){
1231   IdxExprTrans *pX = p->u.pIdxTrans;
1232   if( sqlite3ExprCompare(0, pExpr, pX->pIdxExpr, pX->iTabCur)==0 ){
1233     preserveExpr(pX, pExpr);
1234     pExpr->affExpr = sqlite3ExprAffinity(pExpr);
1235     pExpr->op = TK_COLUMN;
1236     pExpr->iTable = pX->iIdxCur;
1237     pExpr->iColumn = pX->iIdxCol;
1238     testcase( ExprHasProperty(pExpr, EP_Skip) );
1239     testcase( ExprHasProperty(pExpr, EP_Unlikely) );
1240     ExprClearProperty(pExpr, EP_Skip|EP_Unlikely|EP_WinFunc|EP_Subrtn);
1241     pExpr->y.pTab = 0;
1242     return WRC_Prune;
1243   }else{
1244     return WRC_Continue;
1245   }
1246 }
1247 
1248 #ifndef SQLITE_OMIT_GENERATED_COLUMNS
1249 /* A walker node callback that translates a column reference to a table
1250 ** into a corresponding column reference of an index.
1251 */
1252 static int whereIndexExprTransColumn(Walker *p, Expr *pExpr){
1253   if( pExpr->op==TK_COLUMN ){
1254     IdxExprTrans *pX = p->u.pIdxTrans;
1255     if( pExpr->iTable==pX->iTabCur && pExpr->iColumn==pX->iTabCol ){
1256       assert( ExprUseYTab(pExpr) && pExpr->y.pTab!=0 );
1257       preserveExpr(pX, pExpr);
1258       pExpr->affExpr = sqlite3TableColumnAffinity(pExpr->y.pTab,pExpr->iColumn);
1259       pExpr->iTable = pX->iIdxCur;
1260       pExpr->iColumn = pX->iIdxCol;
1261       pExpr->y.pTab = 0;
1262     }
1263   }
1264   return WRC_Continue;
1265 }
1266 #endif /* SQLITE_OMIT_GENERATED_COLUMNS */
1267 
1268 /*
1269 ** For an indexes on expression X, locate every instance of expression X
1270 ** in pExpr and change that subexpression into a reference to the appropriate
1271 ** column of the index.
1272 **
1273 ** 2019-10-24: Updated to also translate references to a VIRTUAL column in
1274 ** the table into references to the corresponding (stored) column of the
1275 ** index.
1276 */
1277 static void whereIndexExprTrans(
1278   Index *pIdx,      /* The Index */
1279   int iTabCur,      /* Cursor of the table that is being indexed */
1280   int iIdxCur,      /* Cursor of the index itself */
1281   WhereInfo *pWInfo /* Transform expressions in this WHERE clause */
1282 ){
1283   int iIdxCol;               /* Column number of the index */
1284   ExprList *aColExpr;        /* Expressions that are indexed */
1285   Table *pTab;
1286   Walker w;
1287   IdxExprTrans x;
1288   aColExpr = pIdx->aColExpr;
1289   if( aColExpr==0 && !pIdx->bHasVCol ){
1290     /* The index does not reference any expressions or virtual columns
1291     ** so no translations are needed. */
1292     return;
1293   }
1294   pTab = pIdx->pTable;
1295   memset(&w, 0, sizeof(w));
1296   w.u.pIdxTrans = &x;
1297   x.iTabCur = iTabCur;
1298   x.iIdxCur = iIdxCur;
1299   x.pWInfo = pWInfo;
1300   x.db = pWInfo->pParse->db;
1301   for(iIdxCol=0; iIdxCol<pIdx->nColumn; iIdxCol++){
1302     i16 iRef = pIdx->aiColumn[iIdxCol];
1303     if( iRef==XN_EXPR ){
1304       assert( aColExpr!=0 && aColExpr->a[iIdxCol].pExpr!=0 );
1305       x.pIdxExpr = aColExpr->a[iIdxCol].pExpr;
1306       if( sqlite3ExprIsConstant(x.pIdxExpr) ) continue;
1307       w.xExprCallback = whereIndexExprTransNode;
1308 #ifndef SQLITE_OMIT_GENERATED_COLUMNS
1309     }else if( iRef>=0
1310        && (pTab->aCol[iRef].colFlags & COLFLAG_VIRTUAL)!=0
1311        && ((pTab->aCol[iRef].colFlags & COLFLAG_HASCOLL)==0
1312            || sqlite3StrICmp(sqlite3ColumnColl(&pTab->aCol[iRef]),
1313                                                sqlite3StrBINARY)==0)
1314     ){
1315       /* Check to see if there are direct references to generated columns
1316       ** that are contained in the index.  Pulling the generated column
1317       ** out of the index is an optimization only - the main table is always
1318       ** available if the index cannot be used.  To avoid unnecessary
1319       ** complication, omit this optimization if the collating sequence for
1320       ** the column is non-standard */
1321       x.iTabCol = iRef;
1322       w.xExprCallback = whereIndexExprTransColumn;
1323 #endif /* SQLITE_OMIT_GENERATED_COLUMNS */
1324     }else{
1325       continue;
1326     }
1327     x.iIdxCol = iIdxCol;
1328     sqlite3WalkExpr(&w, pWInfo->pWhere);
1329     sqlite3WalkExprList(&w, pWInfo->pOrderBy);
1330     sqlite3WalkExprList(&w, pWInfo->pResultSet);
1331   }
1332 }
1333 
1334 /*
1335 ** The pTruth expression is always true because it is the WHERE clause
1336 ** a partial index that is driving a query loop.  Look through all of the
1337 ** WHERE clause terms on the query, and if any of those terms must be
1338 ** true because pTruth is true, then mark those WHERE clause terms as
1339 ** coded.
1340 */
1341 static void whereApplyPartialIndexConstraints(
1342   Expr *pTruth,
1343   int iTabCur,
1344   WhereClause *pWC
1345 ){
1346   int i;
1347   WhereTerm *pTerm;
1348   while( pTruth->op==TK_AND ){
1349     whereApplyPartialIndexConstraints(pTruth->pLeft, iTabCur, pWC);
1350     pTruth = pTruth->pRight;
1351   }
1352   for(i=0, pTerm=pWC->a; i<pWC->nTerm; i++, pTerm++){
1353     Expr *pExpr;
1354     if( pTerm->wtFlags & TERM_CODED ) continue;
1355     pExpr = pTerm->pExpr;
1356     if( sqlite3ExprCompare(0, pExpr, pTruth, iTabCur)==0 ){
1357       pTerm->wtFlags |= TERM_CODED;
1358     }
1359   }
1360 }
1361 
1362 /*
1363 ** This routine is called right after An OP_Filter has been generated and
1364 ** before the corresponding index search has been performed.  This routine
1365 ** checks to see if there are additional Bloom filters in inner loops that
1366 ** can be checked prior to doing the index lookup.  If there are available
1367 ** inner-loop Bloom filters, then evaluate those filters now, before the
1368 ** index lookup.  The idea is that a Bloom filter check is way faster than
1369 ** an index lookup, and the Bloom filter might return false, meaning that
1370 ** the index lookup can be skipped.
1371 **
1372 ** We know that an inner loop uses a Bloom filter because it has the
1373 ** WhereLevel.regFilter set.  If an inner-loop Bloom filter is checked,
1374 ** then clear the WhereLevel.regFilter value to prevent the Bloom filter
1375 ** from being checked a second time when the inner loop is evaluated.
1376 */
1377 static SQLITE_NOINLINE void filterPullDown(
1378   Parse *pParse,       /* Parsing context */
1379   WhereInfo *pWInfo,   /* Complete information about the WHERE clause */
1380   int iLevel,          /* Which level of pWInfo->a[] should be coded */
1381   int addrNxt,         /* Jump here to bypass inner loops */
1382   Bitmask notReady     /* Loops that are not ready */
1383 ){
1384   while( ++iLevel < pWInfo->nLevel ){
1385     WhereLevel *pLevel = &pWInfo->a[iLevel];
1386     WhereLoop *pLoop = pLevel->pWLoop;
1387     if( pLevel->regFilter==0 ) continue;
1388     /*         ,--- Because sqlite3ConstructBloomFilter() has will not have set
1389     **  vvvvv--'    pLevel->regFilter if this were true. */
1390     if( NEVER(pLoop->prereq & notReady) ) continue;
1391     if( pLoop->wsFlags & WHERE_IPK ){
1392       WhereTerm *pTerm = pLoop->aLTerm[0];
1393       int regRowid;
1394       assert( pTerm!=0 );
1395       assert( pTerm->pExpr!=0 );
1396       testcase( pTerm->wtFlags & TERM_VIRTUAL );
1397       regRowid = sqlite3GetTempReg(pParse);
1398       regRowid = codeEqualityTerm(pParse, pTerm, pLevel, 0, 0, regRowid);
1399       sqlite3VdbeAddOp4Int(pParse->pVdbe, OP_Filter, pLevel->regFilter,
1400                            addrNxt, regRowid, 1);
1401       VdbeCoverage(pParse->pVdbe);
1402     }else{
1403       u16 nEq = pLoop->u.btree.nEq;
1404       int r1;
1405       char *zStartAff;
1406 
1407       assert( pLoop->wsFlags & WHERE_INDEXED );
1408       assert( (pLoop->wsFlags & WHERE_COLUMN_IN)==0 );
1409       r1 = codeAllEqualityTerms(pParse,pLevel,0,0,&zStartAff);
1410       codeApplyAffinity(pParse, r1, nEq, zStartAff);
1411       sqlite3DbFree(pParse->db, zStartAff);
1412       sqlite3VdbeAddOp4Int(pParse->pVdbe, OP_Filter, pLevel->regFilter,
1413                            addrNxt, r1, nEq);
1414       VdbeCoverage(pParse->pVdbe);
1415     }
1416     pLevel->regFilter = 0;
1417   }
1418 }
1419 
1420 /*
1421 ** Generate code for the start of the iLevel-th loop in the WHERE clause
1422 ** implementation described by pWInfo.
1423 */
1424 Bitmask sqlite3WhereCodeOneLoopStart(
1425   Parse *pParse,       /* Parsing context */
1426   Vdbe *v,             /* Prepared statement under construction */
1427   WhereInfo *pWInfo,   /* Complete information about the WHERE clause */
1428   int iLevel,          /* Which level of pWInfo->a[] should be coded */
1429   WhereLevel *pLevel,  /* The current level pointer */
1430   Bitmask notReady     /* Which tables are currently available */
1431 ){
1432   int j, k;            /* Loop counters */
1433   int iCur;            /* The VDBE cursor for the table */
1434   int addrNxt;         /* Where to jump to continue with the next IN case */
1435   int bRev;            /* True if we need to scan in reverse order */
1436   WhereLoop *pLoop;    /* The WhereLoop object being coded */
1437   WhereClause *pWC;    /* Decomposition of the entire WHERE clause */
1438   WhereTerm *pTerm;               /* A WHERE clause term */
1439   sqlite3 *db;                    /* Database connection */
1440   SrcItem *pTabItem;              /* FROM clause term being coded */
1441   int addrBrk;                    /* Jump here to break out of the loop */
1442   int addrHalt;                   /* addrBrk for the outermost loop */
1443   int addrCont;                   /* Jump here to continue with next cycle */
1444   int iRowidReg = 0;        /* Rowid is stored in this register, if not zero */
1445   int iReleaseReg = 0;      /* Temp register to free before returning */
1446   Index *pIdx = 0;          /* Index used by loop (if any) */
1447   int iLoop;                /* Iteration of constraint generator loop */
1448 
1449   pWC = &pWInfo->sWC;
1450   db = pParse->db;
1451   pLoop = pLevel->pWLoop;
1452   pTabItem = &pWInfo->pTabList->a[pLevel->iFrom];
1453   iCur = pTabItem->iCursor;
1454   pLevel->notReady = notReady & ~sqlite3WhereGetMask(&pWInfo->sMaskSet, iCur);
1455   bRev = (pWInfo->revMask>>iLevel)&1;
1456   VdbeModuleComment((v, "Begin WHERE-loop%d: %s",iLevel,pTabItem->pTab->zName));
1457 #if WHERETRACE_ENABLED /* 0x20800 */
1458   if( sqlite3WhereTrace & 0x800 ){
1459     sqlite3DebugPrintf("Coding level %d of %d:  notReady=%llx  iFrom=%d\n",
1460        iLevel, pWInfo->nLevel, (u64)notReady, pLevel->iFrom);
1461     sqlite3WhereLoopPrint(pLoop, pWC);
1462   }
1463   if( sqlite3WhereTrace & 0x20000 ){
1464     if( iLevel==0 ){
1465       sqlite3DebugPrintf("WHERE clause being coded:\n");
1466       sqlite3TreeViewExpr(0, pWInfo->pWhere, 0);
1467     }
1468     sqlite3DebugPrintf("All WHERE-clause terms before coding:\n");
1469     sqlite3WhereClausePrint(pWC);
1470   }
1471 #endif
1472 
1473   /* Create labels for the "break" and "continue" instructions
1474   ** for the current loop.  Jump to addrBrk to break out of a loop.
1475   ** Jump to cont to go immediately to the next iteration of the
1476   ** loop.
1477   **
1478   ** When there is an IN operator, we also have a "addrNxt" label that
1479   ** means to continue with the next IN value combination.  When
1480   ** there are no IN operators in the constraints, the "addrNxt" label
1481   ** is the same as "addrBrk".
1482   */
1483   addrBrk = pLevel->addrBrk = pLevel->addrNxt = sqlite3VdbeMakeLabel(pParse);
1484   addrCont = pLevel->addrCont = sqlite3VdbeMakeLabel(pParse);
1485 
1486   /* If this is the right table of a LEFT OUTER JOIN, allocate and
1487   ** initialize a memory cell that records if this table matches any
1488   ** row of the left table of the join.
1489   */
1490   assert( (pWInfo->wctrlFlags & WHERE_OR_SUBCLAUSE)
1491        || pLevel->iFrom>0 || (pTabItem[0].fg.jointype & JT_LEFT)==0
1492   );
1493   if( pLevel->iFrom>0 && (pTabItem[0].fg.jointype & JT_LEFT)!=0 ){
1494     pLevel->iLeftJoin = ++pParse->nMem;
1495     sqlite3VdbeAddOp2(v, OP_Integer, 0, pLevel->iLeftJoin);
1496     VdbeComment((v, "init LEFT JOIN no-match flag"));
1497   }
1498 
1499   /* Compute a safe address to jump to if we discover that the table for
1500   ** this loop is empty and can never contribute content. */
1501   for(j=iLevel; j>0 && pWInfo->a[j].iLeftJoin==0; j--){}
1502   addrHalt = pWInfo->a[j].addrBrk;
1503 
1504   /* Special case of a FROM clause subquery implemented as a co-routine */
1505   if( pTabItem->fg.viaCoroutine ){
1506     int regYield = pTabItem->regReturn;
1507     sqlite3VdbeAddOp3(v, OP_InitCoroutine, regYield, 0, pTabItem->addrFillSub);
1508     pLevel->p2 =  sqlite3VdbeAddOp2(v, OP_Yield, regYield, addrBrk);
1509     VdbeCoverage(v);
1510     VdbeComment((v, "next row of %s", pTabItem->pTab->zName));
1511     pLevel->op = OP_Goto;
1512   }else
1513 
1514 #ifndef SQLITE_OMIT_VIRTUALTABLE
1515   if(  (pLoop->wsFlags & WHERE_VIRTUALTABLE)!=0 ){
1516     /* Case 1:  The table is a virtual-table.  Use the VFilter and VNext
1517     **          to access the data.
1518     */
1519     int iReg;   /* P3 Value for OP_VFilter */
1520     int addrNotFound;
1521     int nConstraint = pLoop->nLTerm;
1522     int iIn;    /* Counter for IN constraints */
1523 
1524     iReg = sqlite3GetTempRange(pParse, nConstraint+2);
1525     addrNotFound = pLevel->addrBrk;
1526     for(j=0; j<nConstraint; j++){
1527       int iTarget = iReg+j+2;
1528       pTerm = pLoop->aLTerm[j];
1529       if( NEVER(pTerm==0) ) continue;
1530       if( pTerm->eOperator & WO_IN ){
1531         codeEqualityTerm(pParse, pTerm, pLevel, j, bRev, iTarget);
1532         addrNotFound = pLevel->addrNxt;
1533       }else{
1534         Expr *pRight = pTerm->pExpr->pRight;
1535         codeExprOrVector(pParse, pRight, iTarget, 1);
1536       }
1537     }
1538     sqlite3VdbeAddOp2(v, OP_Integer, pLoop->u.vtab.idxNum, iReg);
1539     sqlite3VdbeAddOp2(v, OP_Integer, nConstraint, iReg+1);
1540     sqlite3VdbeAddOp4(v, OP_VFilter, iCur, addrNotFound, iReg,
1541                       pLoop->u.vtab.idxStr,
1542                       pLoop->u.vtab.needFree ? P4_DYNAMIC : P4_STATIC);
1543     VdbeCoverage(v);
1544     pLoop->u.vtab.needFree = 0;
1545     /* An OOM inside of AddOp4(OP_VFilter) instruction above might have freed
1546     ** the u.vtab.idxStr.  NULL it out to prevent a use-after-free */
1547     if( db->mallocFailed ) pLoop->u.vtab.idxStr = 0;
1548     pLevel->p1 = iCur;
1549     pLevel->op = pWInfo->eOnePass ? OP_Noop : OP_VNext;
1550     pLevel->p2 = sqlite3VdbeCurrentAddr(v);
1551     assert( (pLoop->wsFlags & WHERE_MULTI_OR)==0 );
1552     if( pLoop->wsFlags & WHERE_IN_ABLE ){
1553       iIn = pLevel->u.in.nIn;
1554     }else{
1555       iIn = 0;
1556     }
1557     for(j=nConstraint-1; j>=0; j--){
1558       pTerm = pLoop->aLTerm[j];
1559       if( (pTerm->eOperator & WO_IN)!=0 ) iIn--;
1560       if( j<16 && (pLoop->u.vtab.omitMask>>j)&1 ){
1561         disableTerm(pLevel, pTerm);
1562       }else if( (pTerm->eOperator & WO_IN)!=0
1563         && sqlite3ExprVectorSize(pTerm->pExpr->pLeft)==1
1564       ){
1565         Expr *pCompare;  /* The comparison operator */
1566         Expr *pRight;    /* RHS of the comparison */
1567         VdbeOp *pOp;     /* Opcode to access the value of the IN constraint */
1568 
1569         /* Reload the constraint value into reg[iReg+j+2].  The same value
1570         ** was loaded into the same register prior to the OP_VFilter, but
1571         ** the xFilter implementation might have changed the datatype or
1572         ** encoding of the value in the register, so it *must* be reloaded. */
1573         assert( pLevel->u.in.aInLoop!=0 || db->mallocFailed );
1574         if( !db->mallocFailed ){
1575           assert( iIn>=0 && iIn<pLevel->u.in.nIn );
1576           pOp = sqlite3VdbeGetOp(v, pLevel->u.in.aInLoop[iIn].addrInTop);
1577           assert( pOp->opcode==OP_Column || pOp->opcode==OP_Rowid );
1578           assert( pOp->opcode!=OP_Column || pOp->p3==iReg+j+2 );
1579           assert( pOp->opcode!=OP_Rowid || pOp->p2==iReg+j+2 );
1580           testcase( pOp->opcode==OP_Rowid );
1581           sqlite3VdbeAddOp3(v, pOp->opcode, pOp->p1, pOp->p2, pOp->p3);
1582         }
1583 
1584         /* Generate code that will continue to the next row if
1585         ** the IN constraint is not satisfied */
1586         pCompare = sqlite3PExpr(pParse, TK_EQ, 0, 0);
1587         assert( pCompare!=0 || db->mallocFailed );
1588         if( pCompare ){
1589           pCompare->pLeft = pTerm->pExpr->pLeft;
1590           pCompare->pRight = pRight = sqlite3Expr(db, TK_REGISTER, 0);
1591           if( pRight ){
1592             pRight->iTable = iReg+j+2;
1593             sqlite3ExprIfFalse(
1594                 pParse, pCompare, pLevel->addrCont, SQLITE_JUMPIFNULL
1595             );
1596           }
1597           pCompare->pLeft = 0;
1598           sqlite3ExprDelete(db, pCompare);
1599         }
1600       }
1601     }
1602     assert( iIn==0 || db->mallocFailed );
1603     /* These registers need to be preserved in case there is an IN operator
1604     ** loop.  So we could deallocate the registers here (and potentially
1605     ** reuse them later) if (pLoop->wsFlags & WHERE_IN_ABLE)==0.  But it seems
1606     ** simpler and safer to simply not reuse the registers.
1607     **
1608     **    sqlite3ReleaseTempRange(pParse, iReg, nConstraint+2);
1609     */
1610   }else
1611 #endif /* SQLITE_OMIT_VIRTUALTABLE */
1612 
1613   if( (pLoop->wsFlags & WHERE_IPK)!=0
1614    && (pLoop->wsFlags & (WHERE_COLUMN_IN|WHERE_COLUMN_EQ))!=0
1615   ){
1616     /* Case 2:  We can directly reference a single row using an
1617     **          equality comparison against the ROWID field.  Or
1618     **          we reference multiple rows using a "rowid IN (...)"
1619     **          construct.
1620     */
1621     assert( pLoop->u.btree.nEq==1 );
1622     pTerm = pLoop->aLTerm[0];
1623     assert( pTerm!=0 );
1624     assert( pTerm->pExpr!=0 );
1625     testcase( pTerm->wtFlags & TERM_VIRTUAL );
1626     iReleaseReg = ++pParse->nMem;
1627     iRowidReg = codeEqualityTerm(pParse, pTerm, pLevel, 0, bRev, iReleaseReg);
1628     if( iRowidReg!=iReleaseReg ) sqlite3ReleaseTempReg(pParse, iReleaseReg);
1629     addrNxt = pLevel->addrNxt;
1630     if( pLevel->regFilter ){
1631       sqlite3VdbeAddOp4Int(v, OP_Filter, pLevel->regFilter, addrNxt,
1632                            iRowidReg, 1);
1633       VdbeCoverage(v);
1634       filterPullDown(pParse, pWInfo, iLevel, addrNxt, notReady);
1635     }
1636     sqlite3VdbeAddOp3(v, OP_SeekRowid, iCur, addrNxt, iRowidReg);
1637     VdbeCoverage(v);
1638     pLevel->op = OP_Noop;
1639   }else if( (pLoop->wsFlags & WHERE_IPK)!=0
1640          && (pLoop->wsFlags & WHERE_COLUMN_RANGE)!=0
1641   ){
1642     /* Case 3:  We have an inequality comparison against the ROWID field.
1643     */
1644     int testOp = OP_Noop;
1645     int start;
1646     int memEndValue = 0;
1647     WhereTerm *pStart, *pEnd;
1648 
1649     j = 0;
1650     pStart = pEnd = 0;
1651     if( pLoop->wsFlags & WHERE_BTM_LIMIT ) pStart = pLoop->aLTerm[j++];
1652     if( pLoop->wsFlags & WHERE_TOP_LIMIT ) pEnd = pLoop->aLTerm[j++];
1653     assert( pStart!=0 || pEnd!=0 );
1654     if( bRev ){
1655       pTerm = pStart;
1656       pStart = pEnd;
1657       pEnd = pTerm;
1658     }
1659     codeCursorHint(pTabItem, pWInfo, pLevel, pEnd);
1660     if( pStart ){
1661       Expr *pX;             /* The expression that defines the start bound */
1662       int r1, rTemp;        /* Registers for holding the start boundary */
1663       int op;               /* Cursor seek operation */
1664 
1665       /* The following constant maps TK_xx codes into corresponding
1666       ** seek opcodes.  It depends on a particular ordering of TK_xx
1667       */
1668       const u8 aMoveOp[] = {
1669            /* TK_GT */  OP_SeekGT,
1670            /* TK_LE */  OP_SeekLE,
1671            /* TK_LT */  OP_SeekLT,
1672            /* TK_GE */  OP_SeekGE
1673       };
1674       assert( TK_LE==TK_GT+1 );      /* Make sure the ordering.. */
1675       assert( TK_LT==TK_GT+2 );      /*  ... of the TK_xx values... */
1676       assert( TK_GE==TK_GT+3 );      /*  ... is correcct. */
1677 
1678       assert( (pStart->wtFlags & TERM_VNULL)==0 );
1679       testcase( pStart->wtFlags & TERM_VIRTUAL );
1680       pX = pStart->pExpr;
1681       assert( pX!=0 );
1682       testcase( pStart->leftCursor!=iCur ); /* transitive constraints */
1683       if( sqlite3ExprIsVector(pX->pRight) ){
1684         r1 = rTemp = sqlite3GetTempReg(pParse);
1685         codeExprOrVector(pParse, pX->pRight, r1, 1);
1686         testcase( pX->op==TK_GT );
1687         testcase( pX->op==TK_GE );
1688         testcase( pX->op==TK_LT );
1689         testcase( pX->op==TK_LE );
1690         op = aMoveOp[((pX->op - TK_GT - 1) & 0x3) | 0x1];
1691         assert( pX->op!=TK_GT || op==OP_SeekGE );
1692         assert( pX->op!=TK_GE || op==OP_SeekGE );
1693         assert( pX->op!=TK_LT || op==OP_SeekLE );
1694         assert( pX->op!=TK_LE || op==OP_SeekLE );
1695       }else{
1696         r1 = sqlite3ExprCodeTemp(pParse, pX->pRight, &rTemp);
1697         disableTerm(pLevel, pStart);
1698         op = aMoveOp[(pX->op - TK_GT)];
1699       }
1700       sqlite3VdbeAddOp3(v, op, iCur, addrBrk, r1);
1701       VdbeComment((v, "pk"));
1702       VdbeCoverageIf(v, pX->op==TK_GT);
1703       VdbeCoverageIf(v, pX->op==TK_LE);
1704       VdbeCoverageIf(v, pX->op==TK_LT);
1705       VdbeCoverageIf(v, pX->op==TK_GE);
1706       sqlite3ReleaseTempReg(pParse, rTemp);
1707     }else{
1708       sqlite3VdbeAddOp2(v, bRev ? OP_Last : OP_Rewind, iCur, addrHalt);
1709       VdbeCoverageIf(v, bRev==0);
1710       VdbeCoverageIf(v, bRev!=0);
1711     }
1712     if( pEnd ){
1713       Expr *pX;
1714       pX = pEnd->pExpr;
1715       assert( pX!=0 );
1716       assert( (pEnd->wtFlags & TERM_VNULL)==0 );
1717       testcase( pEnd->leftCursor!=iCur ); /* Transitive constraints */
1718       testcase( pEnd->wtFlags & TERM_VIRTUAL );
1719       memEndValue = ++pParse->nMem;
1720       codeExprOrVector(pParse, pX->pRight, memEndValue, 1);
1721       if( 0==sqlite3ExprIsVector(pX->pRight)
1722        && (pX->op==TK_LT || pX->op==TK_GT)
1723       ){
1724         testOp = bRev ? OP_Le : OP_Ge;
1725       }else{
1726         testOp = bRev ? OP_Lt : OP_Gt;
1727       }
1728       if( 0==sqlite3ExprIsVector(pX->pRight) ){
1729         disableTerm(pLevel, pEnd);
1730       }
1731     }
1732     start = sqlite3VdbeCurrentAddr(v);
1733     pLevel->op = bRev ? OP_Prev : OP_Next;
1734     pLevel->p1 = iCur;
1735     pLevel->p2 = start;
1736     assert( pLevel->p5==0 );
1737     if( testOp!=OP_Noop ){
1738       iRowidReg = ++pParse->nMem;
1739       sqlite3VdbeAddOp2(v, OP_Rowid, iCur, iRowidReg);
1740       sqlite3VdbeAddOp3(v, testOp, memEndValue, addrBrk, iRowidReg);
1741       VdbeCoverageIf(v, testOp==OP_Le);
1742       VdbeCoverageIf(v, testOp==OP_Lt);
1743       VdbeCoverageIf(v, testOp==OP_Ge);
1744       VdbeCoverageIf(v, testOp==OP_Gt);
1745       sqlite3VdbeChangeP5(v, SQLITE_AFF_NUMERIC | SQLITE_JUMPIFNULL);
1746     }
1747   }else if( pLoop->wsFlags & WHERE_INDEXED ){
1748     /* Case 4: A scan using an index.
1749     **
1750     **         The WHERE clause may contain zero or more equality
1751     **         terms ("==" or "IN" operators) that refer to the N
1752     **         left-most columns of the index. It may also contain
1753     **         inequality constraints (>, <, >= or <=) on the indexed
1754     **         column that immediately follows the N equalities. Only
1755     **         the right-most column can be an inequality - the rest must
1756     **         use the "==" and "IN" operators. For example, if the
1757     **         index is on (x,y,z), then the following clauses are all
1758     **         optimized:
1759     **
1760     **            x=5
1761     **            x=5 AND y=10
1762     **            x=5 AND y<10
1763     **            x=5 AND y>5 AND y<10
1764     **            x=5 AND y=5 AND z<=10
1765     **
1766     **         The z<10 term of the following cannot be used, only
1767     **         the x=5 term:
1768     **
1769     **            x=5 AND z<10
1770     **
1771     **         N may be zero if there are inequality constraints.
1772     **         If there are no inequality constraints, then N is at
1773     **         least one.
1774     **
1775     **         This case is also used when there are no WHERE clause
1776     **         constraints but an index is selected anyway, in order
1777     **         to force the output order to conform to an ORDER BY.
1778     */
1779     static const u8 aStartOp[] = {
1780       0,
1781       0,
1782       OP_Rewind,           /* 2: (!start_constraints && startEq &&  !bRev) */
1783       OP_Last,             /* 3: (!start_constraints && startEq &&   bRev) */
1784       OP_SeekGT,           /* 4: (start_constraints  && !startEq && !bRev) */
1785       OP_SeekLT,           /* 5: (start_constraints  && !startEq &&  bRev) */
1786       OP_SeekGE,           /* 6: (start_constraints  &&  startEq && !bRev) */
1787       OP_SeekLE            /* 7: (start_constraints  &&  startEq &&  bRev) */
1788     };
1789     static const u8 aEndOp[] = {
1790       OP_IdxGE,            /* 0: (end_constraints && !bRev && !endEq) */
1791       OP_IdxGT,            /* 1: (end_constraints && !bRev &&  endEq) */
1792       OP_IdxLE,            /* 2: (end_constraints &&  bRev && !endEq) */
1793       OP_IdxLT,            /* 3: (end_constraints &&  bRev &&  endEq) */
1794     };
1795     u16 nEq = pLoop->u.btree.nEq;     /* Number of == or IN terms */
1796     u16 nBtm = pLoop->u.btree.nBtm;   /* Length of BTM vector */
1797     u16 nTop = pLoop->u.btree.nTop;   /* Length of TOP vector */
1798     int regBase;                 /* Base register holding constraint values */
1799     WhereTerm *pRangeStart = 0;  /* Inequality constraint at range start */
1800     WhereTerm *pRangeEnd = 0;    /* Inequality constraint at range end */
1801     int startEq;                 /* True if range start uses ==, >= or <= */
1802     int endEq;                   /* True if range end uses ==, >= or <= */
1803     int start_constraints;       /* Start of range is constrained */
1804     int nConstraint;             /* Number of constraint terms */
1805     int iIdxCur;                 /* The VDBE cursor for the index */
1806     int nExtraReg = 0;           /* Number of extra registers needed */
1807     int op;                      /* Instruction opcode */
1808     char *zStartAff;             /* Affinity for start of range constraint */
1809     char *zEndAff = 0;           /* Affinity for end of range constraint */
1810     u8 bSeekPastNull = 0;        /* True to seek past initial nulls */
1811     u8 bStopAtNull = 0;          /* Add condition to terminate at NULLs */
1812     int omitTable;               /* True if we use the index only */
1813     int regBignull = 0;          /* big-null flag register */
1814     int addrSeekScan = 0;        /* Opcode of the OP_SeekScan, if any */
1815 
1816     pIdx = pLoop->u.btree.pIndex;
1817     iIdxCur = pLevel->iIdxCur;
1818     assert( nEq>=pLoop->nSkip );
1819 
1820     /* Find any inequality constraint terms for the start and end
1821     ** of the range.
1822     */
1823     j = nEq;
1824     if( pLoop->wsFlags & WHERE_BTM_LIMIT ){
1825       pRangeStart = pLoop->aLTerm[j++];
1826       nExtraReg = MAX(nExtraReg, pLoop->u.btree.nBtm);
1827       /* Like optimization range constraints always occur in pairs */
1828       assert( (pRangeStart->wtFlags & TERM_LIKEOPT)==0 ||
1829               (pLoop->wsFlags & WHERE_TOP_LIMIT)!=0 );
1830     }
1831     if( pLoop->wsFlags & WHERE_TOP_LIMIT ){
1832       pRangeEnd = pLoop->aLTerm[j++];
1833       nExtraReg = MAX(nExtraReg, pLoop->u.btree.nTop);
1834 #ifndef SQLITE_LIKE_DOESNT_MATCH_BLOBS
1835       if( (pRangeEnd->wtFlags & TERM_LIKEOPT)!=0 ){
1836         assert( pRangeStart!=0 );                     /* LIKE opt constraints */
1837         assert( pRangeStart->wtFlags & TERM_LIKEOPT );   /* occur in pairs */
1838         pLevel->iLikeRepCntr = (u32)++pParse->nMem;
1839         sqlite3VdbeAddOp2(v, OP_Integer, 1, (int)pLevel->iLikeRepCntr);
1840         VdbeComment((v, "LIKE loop counter"));
1841         pLevel->addrLikeRep = sqlite3VdbeCurrentAddr(v);
1842         /* iLikeRepCntr actually stores 2x the counter register number.  The
1843         ** bottom bit indicates whether the search order is ASC or DESC. */
1844         testcase( bRev );
1845         testcase( pIdx->aSortOrder[nEq]==SQLITE_SO_DESC );
1846         assert( (bRev & ~1)==0 );
1847         pLevel->iLikeRepCntr <<=1;
1848         pLevel->iLikeRepCntr |= bRev ^ (pIdx->aSortOrder[nEq]==SQLITE_SO_DESC);
1849       }
1850 #endif
1851       if( pRangeStart==0 ){
1852         j = pIdx->aiColumn[nEq];
1853         if( (j>=0 && pIdx->pTable->aCol[j].notNull==0) || j==XN_EXPR ){
1854           bSeekPastNull = 1;
1855         }
1856       }
1857     }
1858     assert( pRangeEnd==0 || (pRangeEnd->wtFlags & TERM_VNULL)==0 );
1859 
1860     /* If the WHERE_BIGNULL_SORT flag is set, then index column nEq uses
1861     ** a non-default "big-null" sort (either ASC NULLS LAST or DESC NULLS
1862     ** FIRST). In both cases separate ordered scans are made of those
1863     ** index entries for which the column is null and for those for which
1864     ** it is not. For an ASC sort, the non-NULL entries are scanned first.
1865     ** For DESC, NULL entries are scanned first.
1866     */
1867     if( (pLoop->wsFlags & (WHERE_TOP_LIMIT|WHERE_BTM_LIMIT))==0
1868      && (pLoop->wsFlags & WHERE_BIGNULL_SORT)!=0
1869     ){
1870       assert( bSeekPastNull==0 && nExtraReg==0 && nBtm==0 && nTop==0 );
1871       assert( pRangeEnd==0 && pRangeStart==0 );
1872       testcase( pLoop->nSkip>0 );
1873       nExtraReg = 1;
1874       bSeekPastNull = 1;
1875       pLevel->regBignull = regBignull = ++pParse->nMem;
1876       if( pLevel->iLeftJoin ){
1877         sqlite3VdbeAddOp2(v, OP_Integer, 0, regBignull);
1878       }
1879       pLevel->addrBignull = sqlite3VdbeMakeLabel(pParse);
1880     }
1881 
1882     /* If we are doing a reverse order scan on an ascending index, or
1883     ** a forward order scan on a descending index, interchange the
1884     ** start and end terms (pRangeStart and pRangeEnd).
1885     */
1886     if( (nEq<pIdx->nColumn && bRev==(pIdx->aSortOrder[nEq]==SQLITE_SO_ASC)) ){
1887       SWAP(WhereTerm *, pRangeEnd, pRangeStart);
1888       SWAP(u8, bSeekPastNull, bStopAtNull);
1889       SWAP(u8, nBtm, nTop);
1890     }
1891 
1892     if( iLevel>0 && (pLoop->wsFlags & WHERE_IN_SEEKSCAN)!=0 ){
1893       /* In case OP_SeekScan is used, ensure that the index cursor does not
1894       ** point to a valid row for the first iteration of this loop. */
1895       sqlite3VdbeAddOp1(v, OP_NullRow, iIdxCur);
1896     }
1897 
1898     /* Generate code to evaluate all constraint terms using == or IN
1899     ** and store the values of those terms in an array of registers
1900     ** starting at regBase.
1901     */
1902     codeCursorHint(pTabItem, pWInfo, pLevel, pRangeEnd);
1903     regBase = codeAllEqualityTerms(pParse,pLevel,bRev,nExtraReg,&zStartAff);
1904     assert( zStartAff==0 || sqlite3Strlen30(zStartAff)>=nEq );
1905     if( zStartAff && nTop ){
1906       zEndAff = sqlite3DbStrDup(db, &zStartAff[nEq]);
1907     }
1908     addrNxt = (regBignull ? pLevel->addrBignull : pLevel->addrNxt);
1909 
1910     testcase( pRangeStart && (pRangeStart->eOperator & WO_LE)!=0 );
1911     testcase( pRangeStart && (pRangeStart->eOperator & WO_GE)!=0 );
1912     testcase( pRangeEnd && (pRangeEnd->eOperator & WO_LE)!=0 );
1913     testcase( pRangeEnd && (pRangeEnd->eOperator & WO_GE)!=0 );
1914     startEq = !pRangeStart || pRangeStart->eOperator & (WO_LE|WO_GE);
1915     endEq =   !pRangeEnd || pRangeEnd->eOperator & (WO_LE|WO_GE);
1916     start_constraints = pRangeStart || nEq>0;
1917 
1918     /* Seek the index cursor to the start of the range. */
1919     nConstraint = nEq;
1920     if( pRangeStart ){
1921       Expr *pRight = pRangeStart->pExpr->pRight;
1922       codeExprOrVector(pParse, pRight, regBase+nEq, nBtm);
1923       whereLikeOptimizationStringFixup(v, pLevel, pRangeStart);
1924       if( (pRangeStart->wtFlags & TERM_VNULL)==0
1925        && sqlite3ExprCanBeNull(pRight)
1926       ){
1927         sqlite3VdbeAddOp2(v, OP_IsNull, regBase+nEq, addrNxt);
1928         VdbeCoverage(v);
1929       }
1930       if( zStartAff ){
1931         updateRangeAffinityStr(pRight, nBtm, &zStartAff[nEq]);
1932       }
1933       nConstraint += nBtm;
1934       testcase( pRangeStart->wtFlags & TERM_VIRTUAL );
1935       if( sqlite3ExprIsVector(pRight)==0 ){
1936         disableTerm(pLevel, pRangeStart);
1937       }else{
1938         startEq = 1;
1939       }
1940       bSeekPastNull = 0;
1941     }else if( bSeekPastNull ){
1942       startEq = 0;
1943       sqlite3VdbeAddOp2(v, OP_Null, 0, regBase+nEq);
1944       start_constraints = 1;
1945       nConstraint++;
1946     }else if( regBignull ){
1947       sqlite3VdbeAddOp2(v, OP_Null, 0, regBase+nEq);
1948       start_constraints = 1;
1949       nConstraint++;
1950     }
1951     codeApplyAffinity(pParse, regBase, nConstraint - bSeekPastNull, zStartAff);
1952     if( pLoop->nSkip>0 && nConstraint==pLoop->nSkip ){
1953       /* The skip-scan logic inside the call to codeAllEqualityConstraints()
1954       ** above has already left the cursor sitting on the correct row,
1955       ** so no further seeking is needed */
1956     }else{
1957       if( regBignull ){
1958         sqlite3VdbeAddOp2(v, OP_Integer, 1, regBignull);
1959         VdbeComment((v, "NULL-scan pass ctr"));
1960       }
1961       if( pLevel->regFilter ){
1962         sqlite3VdbeAddOp4Int(v, OP_Filter, pLevel->regFilter, addrNxt,
1963                              regBase, nEq);
1964         VdbeCoverage(v);
1965         filterPullDown(pParse, pWInfo, iLevel, addrNxt, notReady);
1966       }
1967 
1968       op = aStartOp[(start_constraints<<2) + (startEq<<1) + bRev];
1969       assert( op!=0 );
1970       if( (pLoop->wsFlags & WHERE_IN_SEEKSCAN)!=0 && op==OP_SeekGE ){
1971         assert( regBignull==0 );
1972         /* TUNING:  The OP_SeekScan opcode seeks to reduce the number
1973         ** of expensive seek operations by replacing a single seek with
1974         ** 1 or more step operations.  The question is, how many steps
1975         ** should we try before giving up and going with a seek.  The cost
1976         ** of a seek is proportional to the logarithm of the of the number
1977         ** of entries in the tree, so basing the number of steps to try
1978         ** on the estimated number of rows in the btree seems like a good
1979         ** guess. */
1980         addrSeekScan = sqlite3VdbeAddOp1(v, OP_SeekScan,
1981                                          (pIdx->aiRowLogEst[0]+9)/10);
1982         VdbeCoverage(v);
1983       }
1984       sqlite3VdbeAddOp4Int(v, op, iIdxCur, addrNxt, regBase, nConstraint);
1985       VdbeCoverage(v);
1986       VdbeCoverageIf(v, op==OP_Rewind);  testcase( op==OP_Rewind );
1987       VdbeCoverageIf(v, op==OP_Last);    testcase( op==OP_Last );
1988       VdbeCoverageIf(v, op==OP_SeekGT);  testcase( op==OP_SeekGT );
1989       VdbeCoverageIf(v, op==OP_SeekGE);  testcase( op==OP_SeekGE );
1990       VdbeCoverageIf(v, op==OP_SeekLE);  testcase( op==OP_SeekLE );
1991       VdbeCoverageIf(v, op==OP_SeekLT);  testcase( op==OP_SeekLT );
1992 
1993       assert( bSeekPastNull==0 || bStopAtNull==0 );
1994       if( regBignull ){
1995         assert( bSeekPastNull==1 || bStopAtNull==1 );
1996         assert( bSeekPastNull==!bStopAtNull );
1997         assert( bStopAtNull==startEq );
1998         sqlite3VdbeAddOp2(v, OP_Goto, 0, sqlite3VdbeCurrentAddr(v)+2);
1999         op = aStartOp[(nConstraint>1)*4 + 2 + bRev];
2000         sqlite3VdbeAddOp4Int(v, op, iIdxCur, addrNxt, regBase,
2001                              nConstraint-startEq);
2002         VdbeCoverage(v);
2003         VdbeCoverageIf(v, op==OP_Rewind);  testcase( op==OP_Rewind );
2004         VdbeCoverageIf(v, op==OP_Last);    testcase( op==OP_Last );
2005         VdbeCoverageIf(v, op==OP_SeekGE);  testcase( op==OP_SeekGE );
2006         VdbeCoverageIf(v, op==OP_SeekLE);  testcase( op==OP_SeekLE );
2007         assert( op==OP_Rewind || op==OP_Last || op==OP_SeekGE || op==OP_SeekLE);
2008       }
2009     }
2010 
2011     /* Load the value for the inequality constraint at the end of the
2012     ** range (if any).
2013     */
2014     nConstraint = nEq;
2015     assert( pLevel->p2==0 );
2016     if( pRangeEnd ){
2017       Expr *pRight = pRangeEnd->pExpr->pRight;
2018       if( addrSeekScan ){
2019         /* For a seek-scan that has a range on the lowest term of the index,
2020         ** we have to make the top of the loop be code that sets the end
2021         ** condition of the range.  Otherwise, the OP_SeekScan might jump
2022         ** over that initialization, leaving the range-end value set to the
2023         ** range-start value, resulting in a wrong answer.
2024         ** See ticket 5981a8c041a3c2f3 (2021-11-02).
2025         */
2026         pLevel->p2 = sqlite3VdbeCurrentAddr(v);
2027       }
2028       codeExprOrVector(pParse, pRight, regBase+nEq, nTop);
2029       whereLikeOptimizationStringFixup(v, pLevel, pRangeEnd);
2030       if( (pRangeEnd->wtFlags & TERM_VNULL)==0
2031        && sqlite3ExprCanBeNull(pRight)
2032       ){
2033         sqlite3VdbeAddOp2(v, OP_IsNull, regBase+nEq, addrNxt);
2034         VdbeCoverage(v);
2035       }
2036       if( zEndAff ){
2037         updateRangeAffinityStr(pRight, nTop, zEndAff);
2038         codeApplyAffinity(pParse, regBase+nEq, nTop, zEndAff);
2039       }else{
2040         assert( pParse->db->mallocFailed );
2041       }
2042       nConstraint += nTop;
2043       testcase( pRangeEnd->wtFlags & TERM_VIRTUAL );
2044 
2045       if( sqlite3ExprIsVector(pRight)==0 ){
2046         disableTerm(pLevel, pRangeEnd);
2047       }else{
2048         endEq = 1;
2049       }
2050     }else if( bStopAtNull ){
2051       if( regBignull==0 ){
2052         sqlite3VdbeAddOp2(v, OP_Null, 0, regBase+nEq);
2053         endEq = 0;
2054       }
2055       nConstraint++;
2056     }
2057     sqlite3DbFree(db, zStartAff);
2058     sqlite3DbFree(db, zEndAff);
2059 
2060     /* Top of the loop body */
2061     if( pLevel->p2==0 ) pLevel->p2 = sqlite3VdbeCurrentAddr(v);
2062 
2063     /* Check if the index cursor is past the end of the range. */
2064     if( nConstraint ){
2065       if( regBignull ){
2066         /* Except, skip the end-of-range check while doing the NULL-scan */
2067         sqlite3VdbeAddOp2(v, OP_IfNot, regBignull, sqlite3VdbeCurrentAddr(v)+3);
2068         VdbeComment((v, "If NULL-scan 2nd pass"));
2069         VdbeCoverage(v);
2070       }
2071       op = aEndOp[bRev*2 + endEq];
2072       sqlite3VdbeAddOp4Int(v, op, iIdxCur, addrNxt, regBase, nConstraint);
2073       testcase( op==OP_IdxGT );  VdbeCoverageIf(v, op==OP_IdxGT );
2074       testcase( op==OP_IdxGE );  VdbeCoverageIf(v, op==OP_IdxGE );
2075       testcase( op==OP_IdxLT );  VdbeCoverageIf(v, op==OP_IdxLT );
2076       testcase( op==OP_IdxLE );  VdbeCoverageIf(v, op==OP_IdxLE );
2077       if( addrSeekScan ) sqlite3VdbeJumpHere(v, addrSeekScan);
2078     }
2079     if( regBignull ){
2080       /* During a NULL-scan, check to see if we have reached the end of
2081       ** the NULLs */
2082       assert( bSeekPastNull==!bStopAtNull );
2083       assert( bSeekPastNull+bStopAtNull==1 );
2084       assert( nConstraint+bSeekPastNull>0 );
2085       sqlite3VdbeAddOp2(v, OP_If, regBignull, sqlite3VdbeCurrentAddr(v)+2);
2086       VdbeComment((v, "If NULL-scan 1st pass"));
2087       VdbeCoverage(v);
2088       op = aEndOp[bRev*2 + bSeekPastNull];
2089       sqlite3VdbeAddOp4Int(v, op, iIdxCur, addrNxt, regBase,
2090                            nConstraint+bSeekPastNull);
2091       testcase( op==OP_IdxGT );  VdbeCoverageIf(v, op==OP_IdxGT );
2092       testcase( op==OP_IdxGE );  VdbeCoverageIf(v, op==OP_IdxGE );
2093       testcase( op==OP_IdxLT );  VdbeCoverageIf(v, op==OP_IdxLT );
2094       testcase( op==OP_IdxLE );  VdbeCoverageIf(v, op==OP_IdxLE );
2095     }
2096 
2097     if( (pLoop->wsFlags & WHERE_IN_EARLYOUT)!=0 ){
2098       sqlite3VdbeAddOp3(v, OP_SeekHit, iIdxCur, nEq, nEq);
2099     }
2100 
2101     /* Seek the table cursor, if required */
2102     omitTable = (pLoop->wsFlags & WHERE_IDX_ONLY)!=0
2103            && (pWInfo->wctrlFlags & WHERE_OR_SUBCLAUSE)==0;
2104     if( omitTable ){
2105       /* pIdx is a covering index.  No need to access the main table. */
2106     }else if( HasRowid(pIdx->pTable) ){
2107       codeDeferredSeek(pWInfo, pIdx, iCur, iIdxCur);
2108     }else if( iCur!=iIdxCur ){
2109       Index *pPk = sqlite3PrimaryKeyIndex(pIdx->pTable);
2110       iRowidReg = sqlite3GetTempRange(pParse, pPk->nKeyCol);
2111       for(j=0; j<pPk->nKeyCol; j++){
2112         k = sqlite3TableColumnToIndex(pIdx, pPk->aiColumn[j]);
2113         sqlite3VdbeAddOp3(v, OP_Column, iIdxCur, k, iRowidReg+j);
2114       }
2115       sqlite3VdbeAddOp4Int(v, OP_NotFound, iCur, addrCont,
2116                            iRowidReg, pPk->nKeyCol); VdbeCoverage(v);
2117     }
2118 
2119     if( pLevel->iLeftJoin==0 ){
2120       /* If pIdx is an index on one or more expressions, then look through
2121       ** all the expressions in pWInfo and try to transform matching expressions
2122       ** into reference to index columns.  Also attempt to translate references
2123       ** to virtual columns in the table into references to (stored) columns
2124       ** of the index.
2125       **
2126       ** Do not do this for the RHS of a LEFT JOIN. This is because the
2127       ** expression may be evaluated after OP_NullRow has been executed on
2128       ** the cursor. In this case it is important to do the full evaluation,
2129       ** as the result of the expression may not be NULL, even if all table
2130       ** column values are.  https://www.sqlite.org/src/info/7fa8049685b50b5a
2131       **
2132       ** Also, do not do this when processing one index an a multi-index
2133       ** OR clause, since the transformation will become invalid once we
2134       ** move forward to the next index.
2135       ** https://sqlite.org/src/info/4e8e4857d32d401f
2136       */
2137       if( (pWInfo->wctrlFlags & WHERE_OR_SUBCLAUSE)==0 ){
2138         whereIndexExprTrans(pIdx, iCur, iIdxCur, pWInfo);
2139       }
2140 
2141       /* If a partial index is driving the loop, try to eliminate WHERE clause
2142       ** terms from the query that must be true due to the WHERE clause of
2143       ** the partial index.
2144       **
2145       ** 2019-11-02 ticket 623eff57e76d45f6: This optimization does not work
2146       ** for a LEFT JOIN.
2147       */
2148       if( pIdx->pPartIdxWhere ){
2149         whereApplyPartialIndexConstraints(pIdx->pPartIdxWhere, iCur, pWC);
2150       }
2151     }else{
2152       testcase( pIdx->pPartIdxWhere );
2153       /* The following assert() is not a requirement, merely an observation:
2154       ** The OR-optimization doesn't work for the right hand table of
2155       ** a LEFT JOIN: */
2156       assert( (pWInfo->wctrlFlags & WHERE_OR_SUBCLAUSE)==0 );
2157     }
2158 
2159     /* Record the instruction used to terminate the loop. */
2160     if( pLoop->wsFlags & WHERE_ONEROW ){
2161       pLevel->op = OP_Noop;
2162     }else if( bRev ){
2163       pLevel->op = OP_Prev;
2164     }else{
2165       pLevel->op = OP_Next;
2166     }
2167     pLevel->p1 = iIdxCur;
2168     pLevel->p3 = (pLoop->wsFlags&WHERE_UNQ_WANTED)!=0 ? 1:0;
2169     if( (pLoop->wsFlags & WHERE_CONSTRAINT)==0 ){
2170       pLevel->p5 = SQLITE_STMTSTATUS_FULLSCAN_STEP;
2171     }else{
2172       assert( pLevel->p5==0 );
2173     }
2174     if( omitTable ) pIdx = 0;
2175   }else
2176 
2177 #ifndef SQLITE_OMIT_OR_OPTIMIZATION
2178   if( pLoop->wsFlags & WHERE_MULTI_OR ){
2179     /* Case 5:  Two or more separately indexed terms connected by OR
2180     **
2181     ** Example:
2182     **
2183     **   CREATE TABLE t1(a,b,c,d);
2184     **   CREATE INDEX i1 ON t1(a);
2185     **   CREATE INDEX i2 ON t1(b);
2186     **   CREATE INDEX i3 ON t1(c);
2187     **
2188     **   SELECT * FROM t1 WHERE a=5 OR b=7 OR (c=11 AND d=13)
2189     **
2190     ** In the example, there are three indexed terms connected by OR.
2191     ** The top of the loop looks like this:
2192     **
2193     **          Null       1                # Zero the rowset in reg 1
2194     **
2195     ** Then, for each indexed term, the following. The arguments to
2196     ** RowSetTest are such that the rowid of the current row is inserted
2197     ** into the RowSet. If it is already present, control skips the
2198     ** Gosub opcode and jumps straight to the code generated by WhereEnd().
2199     **
2200     **        sqlite3WhereBegin(<term>)
2201     **          RowSetTest                  # Insert rowid into rowset
2202     **          Gosub      2 A
2203     **        sqlite3WhereEnd()
2204     **
2205     ** Following the above, code to terminate the loop. Label A, the target
2206     ** of the Gosub above, jumps to the instruction right after the Goto.
2207     **
2208     **          Null       1                # Zero the rowset in reg 1
2209     **          Goto       B                # The loop is finished.
2210     **
2211     **       A: <loop body>                 # Return data, whatever.
2212     **
2213     **          Return     2                # Jump back to the Gosub
2214     **
2215     **       B: <after the loop>
2216     **
2217     ** Added 2014-05-26: If the table is a WITHOUT ROWID table, then
2218     ** use an ephemeral index instead of a RowSet to record the primary
2219     ** keys of the rows we have already seen.
2220     **
2221     */
2222     WhereClause *pOrWc;    /* The OR-clause broken out into subterms */
2223     SrcList *pOrTab;       /* Shortened table list or OR-clause generation */
2224     Index *pCov = 0;             /* Potential covering index (or NULL) */
2225     int iCovCur = pParse->nTab++;  /* Cursor used for index scans (if any) */
2226 
2227     int regReturn = ++pParse->nMem;           /* Register used with OP_Gosub */
2228     int regRowset = 0;                        /* Register for RowSet object */
2229     int regRowid = 0;                         /* Register holding rowid */
2230     int iLoopBody = sqlite3VdbeMakeLabel(pParse);/* Start of loop body */
2231     int iRetInit;                             /* Address of regReturn init */
2232     int untestedTerms = 0;             /* Some terms not completely tested */
2233     int ii;                            /* Loop counter */
2234     Expr *pAndExpr = 0;                /* An ".. AND (...)" expression */
2235     Table *pTab = pTabItem->pTab;
2236 
2237     pTerm = pLoop->aLTerm[0];
2238     assert( pTerm!=0 );
2239     assert( pTerm->eOperator & WO_OR );
2240     assert( (pTerm->wtFlags & TERM_ORINFO)!=0 );
2241     pOrWc = &pTerm->u.pOrInfo->wc;
2242     pLevel->op = OP_Return;
2243     pLevel->p1 = regReturn;
2244 
2245     /* Set up a new SrcList in pOrTab containing the table being scanned
2246     ** by this loop in the a[0] slot and all notReady tables in a[1..] slots.
2247     ** This becomes the SrcList in the recursive call to sqlite3WhereBegin().
2248     */
2249     if( pWInfo->nLevel>1 ){
2250       int nNotReady;                 /* The number of notReady tables */
2251       SrcItem *origSrc;              /* Original list of tables */
2252       nNotReady = pWInfo->nLevel - iLevel - 1;
2253       pOrTab = sqlite3StackAllocRaw(db,
2254                             sizeof(*pOrTab)+ nNotReady*sizeof(pOrTab->a[0]));
2255       if( pOrTab==0 ) return notReady;
2256       pOrTab->nAlloc = (u8)(nNotReady + 1);
2257       pOrTab->nSrc = pOrTab->nAlloc;
2258       memcpy(pOrTab->a, pTabItem, sizeof(*pTabItem));
2259       origSrc = pWInfo->pTabList->a;
2260       for(k=1; k<=nNotReady; k++){
2261         memcpy(&pOrTab->a[k], &origSrc[pLevel[k].iFrom], sizeof(pOrTab->a[k]));
2262       }
2263     }else{
2264       pOrTab = pWInfo->pTabList;
2265     }
2266 
2267     /* Initialize the rowset register to contain NULL. An SQL NULL is
2268     ** equivalent to an empty rowset.  Or, create an ephemeral index
2269     ** capable of holding primary keys in the case of a WITHOUT ROWID.
2270     **
2271     ** Also initialize regReturn to contain the address of the instruction
2272     ** immediately following the OP_Return at the bottom of the loop. This
2273     ** is required in a few obscure LEFT JOIN cases where control jumps
2274     ** over the top of the loop into the body of it. In this case the
2275     ** correct response for the end-of-loop code (the OP_Return) is to
2276     ** fall through to the next instruction, just as an OP_Next does if
2277     ** called on an uninitialized cursor.
2278     */
2279     if( (pWInfo->wctrlFlags & WHERE_DUPLICATES_OK)==0 ){
2280       if( HasRowid(pTab) ){
2281         regRowset = ++pParse->nMem;
2282         sqlite3VdbeAddOp2(v, OP_Null, 0, regRowset);
2283       }else{
2284         Index *pPk = sqlite3PrimaryKeyIndex(pTab);
2285         regRowset = pParse->nTab++;
2286         sqlite3VdbeAddOp2(v, OP_OpenEphemeral, regRowset, pPk->nKeyCol);
2287         sqlite3VdbeSetP4KeyInfo(pParse, pPk);
2288       }
2289       regRowid = ++pParse->nMem;
2290     }
2291     iRetInit = sqlite3VdbeAddOp2(v, OP_Integer, 0, regReturn);
2292 
2293     /* If the original WHERE clause is z of the form:  (x1 OR x2 OR ...) AND y
2294     ** Then for every term xN, evaluate as the subexpression: xN AND z
2295     ** That way, terms in y that are factored into the disjunction will
2296     ** be picked up by the recursive calls to sqlite3WhereBegin() below.
2297     **
2298     ** Actually, each subexpression is converted to "xN AND w" where w is
2299     ** the "interesting" terms of z - terms that did not originate in the
2300     ** ON or USING clause of a LEFT JOIN, and terms that are usable as
2301     ** indices.
2302     **
2303     ** This optimization also only applies if the (x1 OR x2 OR ...) term
2304     ** is not contained in the ON clause of a LEFT JOIN.
2305     ** See ticket http://www.sqlite.org/src/info/f2369304e4
2306     */
2307     if( pWC->nTerm>1 ){
2308       int iTerm;
2309       for(iTerm=0; iTerm<pWC->nTerm; iTerm++){
2310         Expr *pExpr = pWC->a[iTerm].pExpr;
2311         if( &pWC->a[iTerm] == pTerm ) continue;
2312         testcase( pWC->a[iTerm].wtFlags & TERM_VIRTUAL );
2313         testcase( pWC->a[iTerm].wtFlags & TERM_CODED );
2314         if( (pWC->a[iTerm].wtFlags & (TERM_VIRTUAL|TERM_CODED))!=0 ) continue;
2315         if( (pWC->a[iTerm].eOperator & WO_ALL)==0 ) continue;
2316         testcase( pWC->a[iTerm].wtFlags & TERM_ORINFO );
2317         pExpr = sqlite3ExprDup(db, pExpr, 0);
2318         pAndExpr = sqlite3ExprAnd(pParse, pAndExpr, pExpr);
2319       }
2320       if( pAndExpr ){
2321         /* The extra 0x10000 bit on the opcode is masked off and does not
2322         ** become part of the new Expr.op.  However, it does make the
2323         ** op==TK_AND comparison inside of sqlite3PExpr() false, and this
2324         ** prevents sqlite3PExpr() from applying the AND short-circuit
2325         ** optimization, which we do not want here. */
2326         pAndExpr = sqlite3PExpr(pParse, TK_AND|0x10000, 0, pAndExpr);
2327       }
2328     }
2329 
2330     /* Run a separate WHERE clause for each term of the OR clause.  After
2331     ** eliminating duplicates from other WHERE clauses, the action for each
2332     ** sub-WHERE clause is to to invoke the main loop body as a subroutine.
2333     */
2334     ExplainQueryPlan((pParse, 1, "MULTI-INDEX OR"));
2335     for(ii=0; ii<pOrWc->nTerm; ii++){
2336       WhereTerm *pOrTerm = &pOrWc->a[ii];
2337       if( pOrTerm->leftCursor==iCur || (pOrTerm->eOperator & WO_AND)!=0 ){
2338         WhereInfo *pSubWInfo;           /* Info for single OR-term scan */
2339         Expr *pOrExpr = pOrTerm->pExpr; /* Current OR clause term */
2340         Expr *pDelete;                  /* Local copy of OR clause term */
2341         int jmp1 = 0;                   /* Address of jump operation */
2342         testcase( (pTabItem[0].fg.jointype & JT_LEFT)!=0
2343                && !ExprHasProperty(pOrExpr, EP_FromJoin)
2344         ); /* See TH3 vtab25.400 and ticket 614b25314c766238 */
2345         pDelete = pOrExpr = sqlite3ExprDup(db, pOrExpr, 0);
2346         if( db->mallocFailed ){
2347           sqlite3ExprDelete(db, pDelete);
2348           continue;
2349         }
2350         if( pAndExpr ){
2351           pAndExpr->pLeft = pOrExpr;
2352           pOrExpr = pAndExpr;
2353         }
2354         /* Loop through table entries that match term pOrTerm. */
2355         ExplainQueryPlan((pParse, 1, "INDEX %d", ii+1));
2356         WHERETRACE(0xffff, ("Subplan for OR-clause:\n"));
2357         pSubWInfo = sqlite3WhereBegin(pParse, pOrTab, pOrExpr, 0, 0,
2358                                       WHERE_OR_SUBCLAUSE, iCovCur);
2359         assert( pSubWInfo || pParse->nErr || db->mallocFailed );
2360         if( pSubWInfo ){
2361           WhereLoop *pSubLoop;
2362           int addrExplain = sqlite3WhereExplainOneScan(
2363               pParse, pOrTab, &pSubWInfo->a[0], 0
2364           );
2365           sqlite3WhereAddScanStatus(v, pOrTab, &pSubWInfo->a[0], addrExplain);
2366 
2367           /* This is the sub-WHERE clause body.  First skip over
2368           ** duplicate rows from prior sub-WHERE clauses, and record the
2369           ** rowid (or PRIMARY KEY) for the current row so that the same
2370           ** row will be skipped in subsequent sub-WHERE clauses.
2371           */
2372           if( (pWInfo->wctrlFlags & WHERE_DUPLICATES_OK)==0 ){
2373             int iSet = ((ii==pOrWc->nTerm-1)?-1:ii);
2374             if( HasRowid(pTab) ){
2375               sqlite3ExprCodeGetColumnOfTable(v, pTab, iCur, -1, regRowid);
2376               jmp1 = sqlite3VdbeAddOp4Int(v, OP_RowSetTest, regRowset, 0,
2377                                           regRowid, iSet);
2378               VdbeCoverage(v);
2379             }else{
2380               Index *pPk = sqlite3PrimaryKeyIndex(pTab);
2381               int nPk = pPk->nKeyCol;
2382               int iPk;
2383               int r;
2384 
2385               /* Read the PK into an array of temp registers. */
2386               r = sqlite3GetTempRange(pParse, nPk);
2387               for(iPk=0; iPk<nPk; iPk++){
2388                 int iCol = pPk->aiColumn[iPk];
2389                 sqlite3ExprCodeGetColumnOfTable(v, pTab, iCur, iCol,r+iPk);
2390               }
2391 
2392               /* Check if the temp table already contains this key. If so,
2393               ** the row has already been included in the result set and
2394               ** can be ignored (by jumping past the Gosub below). Otherwise,
2395               ** insert the key into the temp table and proceed with processing
2396               ** the row.
2397               **
2398               ** Use some of the same optimizations as OP_RowSetTest: If iSet
2399               ** is zero, assume that the key cannot already be present in
2400               ** the temp table. And if iSet is -1, assume that there is no
2401               ** need to insert the key into the temp table, as it will never
2402               ** be tested for.  */
2403               if( iSet ){
2404                 jmp1 = sqlite3VdbeAddOp4Int(v, OP_Found, regRowset, 0, r, nPk);
2405                 VdbeCoverage(v);
2406               }
2407               if( iSet>=0 ){
2408                 sqlite3VdbeAddOp3(v, OP_MakeRecord, r, nPk, regRowid);
2409                 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, regRowset, regRowid,
2410                                      r, nPk);
2411                 if( iSet ) sqlite3VdbeChangeP5(v, OPFLAG_USESEEKRESULT);
2412               }
2413 
2414               /* Release the array of temp registers */
2415               sqlite3ReleaseTempRange(pParse, r, nPk);
2416             }
2417           }
2418 
2419           /* Invoke the main loop body as a subroutine */
2420           sqlite3VdbeAddOp2(v, OP_Gosub, regReturn, iLoopBody);
2421 
2422           /* Jump here (skipping the main loop body subroutine) if the
2423           ** current sub-WHERE row is a duplicate from prior sub-WHEREs. */
2424           if( jmp1 ) sqlite3VdbeJumpHere(v, jmp1);
2425 
2426           /* The pSubWInfo->untestedTerms flag means that this OR term
2427           ** contained one or more AND term from a notReady table.  The
2428           ** terms from the notReady table could not be tested and will
2429           ** need to be tested later.
2430           */
2431           if( pSubWInfo->untestedTerms ) untestedTerms = 1;
2432 
2433           /* If all of the OR-connected terms are optimized using the same
2434           ** index, and the index is opened using the same cursor number
2435           ** by each call to sqlite3WhereBegin() made by this loop, it may
2436           ** be possible to use that index as a covering index.
2437           **
2438           ** If the call to sqlite3WhereBegin() above resulted in a scan that
2439           ** uses an index, and this is either the first OR-connected term
2440           ** processed or the index is the same as that used by all previous
2441           ** terms, set pCov to the candidate covering index. Otherwise, set
2442           ** pCov to NULL to indicate that no candidate covering index will
2443           ** be available.
2444           */
2445           pSubLoop = pSubWInfo->a[0].pWLoop;
2446           assert( (pSubLoop->wsFlags & WHERE_AUTO_INDEX)==0 );
2447           if( (pSubLoop->wsFlags & WHERE_INDEXED)!=0
2448            && (ii==0 || pSubLoop->u.btree.pIndex==pCov)
2449            && (HasRowid(pTab) || !IsPrimaryKeyIndex(pSubLoop->u.btree.pIndex))
2450           ){
2451             assert( pSubWInfo->a[0].iIdxCur==iCovCur );
2452             pCov = pSubLoop->u.btree.pIndex;
2453           }else{
2454             pCov = 0;
2455           }
2456           if( sqlite3WhereUsesDeferredSeek(pSubWInfo) ){
2457             pWInfo->bDeferredSeek = 1;
2458           }
2459 
2460           /* Finish the loop through table entries that match term pOrTerm. */
2461           sqlite3WhereEnd(pSubWInfo);
2462           ExplainQueryPlanPop(pParse);
2463         }
2464         sqlite3ExprDelete(db, pDelete);
2465       }
2466     }
2467     ExplainQueryPlanPop(pParse);
2468     assert( pLevel->pWLoop==pLoop );
2469     assert( (pLoop->wsFlags & WHERE_MULTI_OR)!=0 );
2470     assert( (pLoop->wsFlags & WHERE_IN_ABLE)==0 );
2471     pLevel->u.pCoveringIdx = pCov;
2472     if( pCov ) pLevel->iIdxCur = iCovCur;
2473     if( pAndExpr ){
2474       pAndExpr->pLeft = 0;
2475       sqlite3ExprDelete(db, pAndExpr);
2476     }
2477     sqlite3VdbeChangeP1(v, iRetInit, sqlite3VdbeCurrentAddr(v));
2478     sqlite3VdbeGoto(v, pLevel->addrBrk);
2479     sqlite3VdbeResolveLabel(v, iLoopBody);
2480 
2481     if( pWInfo->nLevel>1 ){ sqlite3StackFree(db, pOrTab); }
2482     if( !untestedTerms ) disableTerm(pLevel, pTerm);
2483   }else
2484 #endif /* SQLITE_OMIT_OR_OPTIMIZATION */
2485 
2486   {
2487     /* Case 6:  There is no usable index.  We must do a complete
2488     **          scan of the entire table.
2489     */
2490     static const u8 aStep[] = { OP_Next, OP_Prev };
2491     static const u8 aStart[] = { OP_Rewind, OP_Last };
2492     assert( bRev==0 || bRev==1 );
2493     if( pTabItem->fg.isRecursive ){
2494       /* Tables marked isRecursive have only a single row that is stored in
2495       ** a pseudo-cursor.  No need to Rewind or Next such cursors. */
2496       pLevel->op = OP_Noop;
2497     }else{
2498       codeCursorHint(pTabItem, pWInfo, pLevel, 0);
2499       pLevel->op = aStep[bRev];
2500       pLevel->p1 = iCur;
2501       pLevel->p2 = 1 + sqlite3VdbeAddOp2(v, aStart[bRev], iCur, addrHalt);
2502       VdbeCoverageIf(v, bRev==0);
2503       VdbeCoverageIf(v, bRev!=0);
2504       pLevel->p5 = SQLITE_STMTSTATUS_FULLSCAN_STEP;
2505     }
2506   }
2507 
2508 #ifdef SQLITE_ENABLE_STMT_SCANSTATUS
2509   pLevel->addrVisit = sqlite3VdbeCurrentAddr(v);
2510 #endif
2511 
2512   /* Insert code to test every subexpression that can be completely
2513   ** computed using the current set of tables.
2514   **
2515   ** This loop may run between one and three times, depending on the
2516   ** constraints to be generated. The value of stack variable iLoop
2517   ** determines the constraints coded by each iteration, as follows:
2518   **
2519   ** iLoop==1: Code only expressions that are entirely covered by pIdx.
2520   ** iLoop==2: Code remaining expressions that do not contain correlated
2521   **           sub-queries.
2522   ** iLoop==3: Code all remaining expressions.
2523   **
2524   ** An effort is made to skip unnecessary iterations of the loop.
2525   */
2526   iLoop = (pIdx ? 1 : 2);
2527   do{
2528     int iNext = 0;                /* Next value for iLoop */
2529     for(pTerm=pWC->a, j=pWC->nTerm; j>0; j--, pTerm++){
2530       Expr *pE;
2531       int skipLikeAddr = 0;
2532       testcase( pTerm->wtFlags & TERM_VIRTUAL );
2533       testcase( pTerm->wtFlags & TERM_CODED );
2534       if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
2535       if( (pTerm->prereqAll & pLevel->notReady)!=0 ){
2536         testcase( pWInfo->untestedTerms==0
2537             && (pWInfo->wctrlFlags & WHERE_OR_SUBCLAUSE)!=0 );
2538         pWInfo->untestedTerms = 1;
2539         continue;
2540       }
2541       pE = pTerm->pExpr;
2542       assert( pE!=0 );
2543       if( (pTabItem->fg.jointype&JT_LEFT) && !ExprHasProperty(pE,EP_FromJoin) ){
2544         continue;
2545       }
2546 
2547       if( iLoop==1 && !sqlite3ExprCoveredByIndex(pE, pLevel->iTabCur, pIdx) ){
2548         iNext = 2;
2549         continue;
2550       }
2551       if( iLoop<3 && (pTerm->wtFlags & TERM_VARSELECT) ){
2552         if( iNext==0 ) iNext = 3;
2553         continue;
2554       }
2555 
2556       if( (pTerm->wtFlags & TERM_LIKECOND)!=0 ){
2557         /* If the TERM_LIKECOND flag is set, that means that the range search
2558         ** is sufficient to guarantee that the LIKE operator is true, so we
2559         ** can skip the call to the like(A,B) function.  But this only works
2560         ** for strings.  So do not skip the call to the function on the pass
2561         ** that compares BLOBs. */
2562 #ifdef SQLITE_LIKE_DOESNT_MATCH_BLOBS
2563         continue;
2564 #else
2565         u32 x = pLevel->iLikeRepCntr;
2566         if( x>0 ){
2567           skipLikeAddr = sqlite3VdbeAddOp1(v, (x&1)?OP_IfNot:OP_If,(int)(x>>1));
2568           VdbeCoverageIf(v, (x&1)==1);
2569           VdbeCoverageIf(v, (x&1)==0);
2570         }
2571 #endif
2572       }
2573 #ifdef WHERETRACE_ENABLED /* 0xffff */
2574       if( sqlite3WhereTrace ){
2575         VdbeNoopComment((v, "WhereTerm[%d] (%p) priority=%d",
2576                          pWC->nTerm-j, pTerm, iLoop));
2577       }
2578       if( sqlite3WhereTrace & 0x800 ){
2579         sqlite3DebugPrintf("Coding auxiliary constraint:\n");
2580         sqlite3WhereTermPrint(pTerm, pWC->nTerm-j);
2581       }
2582 #endif
2583       sqlite3ExprIfFalse(pParse, pE, addrCont, SQLITE_JUMPIFNULL);
2584       if( skipLikeAddr ) sqlite3VdbeJumpHere(v, skipLikeAddr);
2585       pTerm->wtFlags |= TERM_CODED;
2586     }
2587     iLoop = iNext;
2588   }while( iLoop>0 );
2589 
2590   /* Insert code to test for implied constraints based on transitivity
2591   ** of the "==" operator.
2592   **
2593   ** Example: If the WHERE clause contains "t1.a=t2.b" and "t2.b=123"
2594   ** and we are coding the t1 loop and the t2 loop has not yet coded,
2595   ** then we cannot use the "t1.a=t2.b" constraint, but we can code
2596   ** the implied "t1.a=123" constraint.
2597   */
2598   for(pTerm=pWC->a, j=pWC->nBase; j>0; j--, pTerm++){
2599     Expr *pE, sEAlt;
2600     WhereTerm *pAlt;
2601     if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
2602     if( (pTerm->eOperator & (WO_EQ|WO_IS))==0 ) continue;
2603     if( (pTerm->eOperator & WO_EQUIV)==0 ) continue;
2604     if( pTerm->leftCursor!=iCur ) continue;
2605     if( pTabItem->fg.jointype & JT_LEFT ) continue;
2606     pE = pTerm->pExpr;
2607 #ifdef WHERETRACE_ENABLED /* 0x800 */
2608     if( sqlite3WhereTrace & 0x800 ){
2609       sqlite3DebugPrintf("Coding transitive constraint:\n");
2610       sqlite3WhereTermPrint(pTerm, pWC->nTerm-j);
2611     }
2612 #endif
2613     assert( !ExprHasProperty(pE, EP_FromJoin) );
2614     assert( (pTerm->prereqRight & pLevel->notReady)!=0 );
2615     assert( (pTerm->eOperator & (WO_OR|WO_AND))==0 );
2616     pAlt = sqlite3WhereFindTerm(pWC, iCur, pTerm->u.x.leftColumn, notReady,
2617                     WO_EQ|WO_IN|WO_IS, 0);
2618     if( pAlt==0 ) continue;
2619     if( pAlt->wtFlags & (TERM_CODED) ) continue;
2620     if( (pAlt->eOperator & WO_IN)
2621      && ExprUseXSelect(pAlt->pExpr)
2622      && (pAlt->pExpr->x.pSelect->pEList->nExpr>1)
2623     ){
2624       continue;
2625     }
2626     testcase( pAlt->eOperator & WO_EQ );
2627     testcase( pAlt->eOperator & WO_IS );
2628     testcase( pAlt->eOperator & WO_IN );
2629     VdbeModuleComment((v, "begin transitive constraint"));
2630     sEAlt = *pAlt->pExpr;
2631     sEAlt.pLeft = pE->pLeft;
2632     sqlite3ExprIfFalse(pParse, &sEAlt, addrCont, SQLITE_JUMPIFNULL);
2633     pAlt->wtFlags |= TERM_CODED;
2634   }
2635 
2636   /* For a LEFT OUTER JOIN, generate code that will record the fact that
2637   ** at least one row of the right table has matched the left table.
2638   */
2639   if( pLevel->iLeftJoin ){
2640     pLevel->addrFirst = sqlite3VdbeCurrentAddr(v);
2641     sqlite3VdbeAddOp2(v, OP_Integer, 1, pLevel->iLeftJoin);
2642     VdbeComment((v, "record LEFT JOIN hit"));
2643     for(pTerm=pWC->a, j=0; j<pWC->nBase; j++, pTerm++){
2644       testcase( pTerm->wtFlags & TERM_VIRTUAL );
2645       testcase( pTerm->wtFlags & TERM_CODED );
2646       if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
2647       if( (pTerm->prereqAll & pLevel->notReady)!=0 ){
2648         assert( pWInfo->untestedTerms );
2649         continue;
2650       }
2651       assert( pTerm->pExpr );
2652       sqlite3ExprIfFalse(pParse, pTerm->pExpr, addrCont, SQLITE_JUMPIFNULL);
2653       pTerm->wtFlags |= TERM_CODED;
2654     }
2655   }
2656 
2657 #if WHERETRACE_ENABLED /* 0x20800 */
2658   if( sqlite3WhereTrace & 0x20000 ){
2659     sqlite3DebugPrintf("All WHERE-clause terms after coding level %d:\n",
2660                        iLevel);
2661     sqlite3WhereClausePrint(pWC);
2662   }
2663   if( sqlite3WhereTrace & 0x800 ){
2664     sqlite3DebugPrintf("End Coding level %d:  notReady=%llx\n",
2665        iLevel, (u64)pLevel->notReady);
2666   }
2667 #endif
2668   return pLevel->notReady;
2669 }
2670