xref: /sqlite-3.40.0/src/wherecode.c (revision 697c50b9)
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   }
828   for(j=nSkip; j<nEq; j++){
829     pTerm = pLoop->aLTerm[j];
830     if( pTerm->eOperator & WO_IN ){
831       if( pTerm->pExpr->flags & EP_xIsSelect ){
832         /* No affinity ever needs to be (or should be) applied to a value
833         ** from the RHS of an "? IN (SELECT ...)" expression. The
834         ** sqlite3FindInIndex() routine has already ensured that the
835         ** affinity of the comparison has been applied to the value.  */
836         if( zAff ) zAff[j] = SQLITE_AFF_BLOB;
837       }
838     }else if( (pTerm->eOperator & WO_ISNULL)==0 ){
839       Expr *pRight = pTerm->pExpr->pRight;
840       if( (pTerm->wtFlags & TERM_IS)==0 && sqlite3ExprCanBeNull(pRight) ){
841         sqlite3VdbeAddOp2(v, OP_IsNull, regBase+j, pLevel->addrBrk);
842         VdbeCoverage(v);
843       }
844       if( pParse->nErr==0 ){
845         assert( pParse->db->mallocFailed==0 );
846         if( sqlite3CompareAffinity(pRight, zAff[j])==SQLITE_AFF_BLOB ){
847           zAff[j] = SQLITE_AFF_BLOB;
848         }
849         if( sqlite3ExprNeedsNoAffinityChange(pRight, zAff[j]) ){
850           zAff[j] = SQLITE_AFF_BLOB;
851         }
852       }
853     }
854   }
855   *pzAff = zAff;
856   return regBase;
857 }
858 
859 #ifndef SQLITE_LIKE_DOESNT_MATCH_BLOBS
860 /*
861 ** If the most recently coded instruction is a constant range constraint
862 ** (a string literal) that originated from the LIKE optimization, then
863 ** set P3 and P5 on the OP_String opcode so that the string will be cast
864 ** to a BLOB at appropriate times.
865 **
866 ** The LIKE optimization trys to evaluate "x LIKE 'abc%'" as a range
867 ** expression: "x>='ABC' AND x<'abd'".  But this requires that the range
868 ** scan loop run twice, once for strings and a second time for BLOBs.
869 ** The OP_String opcodes on the second pass convert the upper and lower
870 ** bound string constants to blobs.  This routine makes the necessary changes
871 ** to the OP_String opcodes for that to happen.
872 **
873 ** Except, of course, if SQLITE_LIKE_DOESNT_MATCH_BLOBS is defined, then
874 ** only the one pass through the string space is required, so this routine
875 ** becomes a no-op.
876 */
877 static void whereLikeOptimizationStringFixup(
878   Vdbe *v,                /* prepared statement under construction */
879   WhereLevel *pLevel,     /* The loop that contains the LIKE operator */
880   WhereTerm *pTerm        /* The upper or lower bound just coded */
881 ){
882   if( pTerm->wtFlags & TERM_LIKEOPT ){
883     VdbeOp *pOp;
884     assert( pLevel->iLikeRepCntr>0 );
885     pOp = sqlite3VdbeGetOp(v, -1);
886     assert( pOp!=0 );
887     assert( pOp->opcode==OP_String8
888             || pTerm->pWC->pWInfo->pParse->db->mallocFailed );
889     pOp->p3 = (int)(pLevel->iLikeRepCntr>>1);  /* Register holding counter */
890     pOp->p5 = (u8)(pLevel->iLikeRepCntr&1);    /* ASC or DESC */
891   }
892 }
893 #else
894 # define whereLikeOptimizationStringFixup(A,B,C)
895 #endif
896 
897 #ifdef SQLITE_ENABLE_CURSOR_HINTS
898 /*
899 ** Information is passed from codeCursorHint() down to individual nodes of
900 ** the expression tree (by sqlite3WalkExpr()) using an instance of this
901 ** structure.
902 */
903 struct CCurHint {
904   int iTabCur;    /* Cursor for the main table */
905   int iIdxCur;    /* Cursor for the index, if pIdx!=0.  Unused otherwise */
906   Index *pIdx;    /* The index used to access the table */
907 };
908 
909 /*
910 ** This function is called for every node of an expression that is a candidate
911 ** for a cursor hint on an index cursor.  For TK_COLUMN nodes that reference
912 ** the table CCurHint.iTabCur, verify that the same column can be
913 ** accessed through the index.  If it cannot, then set pWalker->eCode to 1.
914 */
915 static int codeCursorHintCheckExpr(Walker *pWalker, Expr *pExpr){
916   struct CCurHint *pHint = pWalker->u.pCCurHint;
917   assert( pHint->pIdx!=0 );
918   if( pExpr->op==TK_COLUMN
919    && pExpr->iTable==pHint->iTabCur
920    && sqlite3TableColumnToIndex(pHint->pIdx, pExpr->iColumn)<0
921   ){
922     pWalker->eCode = 1;
923   }
924   return WRC_Continue;
925 }
926 
927 /*
928 ** Test whether or not expression pExpr, which was part of a WHERE clause,
929 ** should be included in the cursor-hint for a table that is on the rhs
930 ** of a LEFT JOIN. Set Walker.eCode to non-zero before returning if the
931 ** expression is not suitable.
932 **
933 ** An expression is unsuitable if it might evaluate to non NULL even if
934 ** a TK_COLUMN node that does affect the value of the expression is set
935 ** to NULL. For example:
936 **
937 **   col IS NULL
938 **   col IS NOT NULL
939 **   coalesce(col, 1)
940 **   CASE WHEN col THEN 0 ELSE 1 END
941 */
942 static int codeCursorHintIsOrFunction(Walker *pWalker, Expr *pExpr){
943   if( pExpr->op==TK_IS
944    || pExpr->op==TK_ISNULL || pExpr->op==TK_ISNOT
945    || pExpr->op==TK_NOTNULL || pExpr->op==TK_CASE
946   ){
947     pWalker->eCode = 1;
948   }else if( pExpr->op==TK_FUNCTION ){
949     int d1;
950     char d2[4];
951     if( 0==sqlite3IsLikeFunction(pWalker->pParse->db, pExpr, &d1, d2) ){
952       pWalker->eCode = 1;
953     }
954   }
955 
956   return WRC_Continue;
957 }
958 
959 
960 /*
961 ** This function is called on every node of an expression tree used as an
962 ** argument to the OP_CursorHint instruction. If the node is a TK_COLUMN
963 ** that accesses any table other than the one identified by
964 ** CCurHint.iTabCur, then do the following:
965 **
966 **   1) allocate a register and code an OP_Column instruction to read
967 **      the specified column into the new register, and
968 **
969 **   2) transform the expression node to a TK_REGISTER node that reads
970 **      from the newly populated register.
971 **
972 ** Also, if the node is a TK_COLUMN that does access the table idenified
973 ** by pCCurHint.iTabCur, and an index is being used (which we will
974 ** know because CCurHint.pIdx!=0) then transform the TK_COLUMN into
975 ** an access of the index rather than the original table.
976 */
977 static int codeCursorHintFixExpr(Walker *pWalker, Expr *pExpr){
978   int rc = WRC_Continue;
979   struct CCurHint *pHint = pWalker->u.pCCurHint;
980   if( pExpr->op==TK_COLUMN ){
981     if( pExpr->iTable!=pHint->iTabCur ){
982       int reg = ++pWalker->pParse->nMem;   /* Register for column value */
983       sqlite3ExprCode(pWalker->pParse, pExpr, reg);
984       pExpr->op = TK_REGISTER;
985       pExpr->iTable = reg;
986     }else if( pHint->pIdx!=0 ){
987       pExpr->iTable = pHint->iIdxCur;
988       pExpr->iColumn = sqlite3TableColumnToIndex(pHint->pIdx, pExpr->iColumn);
989       assert( pExpr->iColumn>=0 );
990     }
991   }else if( pExpr->op==TK_AGG_FUNCTION ){
992     /* An aggregate function in the WHERE clause of a query means this must
993     ** be a correlated sub-query, and expression pExpr is an aggregate from
994     ** the parent context. Do not walk the function arguments in this case.
995     **
996     ** todo: It should be possible to replace this node with a TK_REGISTER
997     ** expression, as the result of the expression must be stored in a
998     ** register at this point. The same holds for TK_AGG_COLUMN nodes. */
999     rc = WRC_Prune;
1000   }
1001   return rc;
1002 }
1003 
1004 /*
1005 ** Insert an OP_CursorHint instruction if it is appropriate to do so.
1006 */
1007 static void codeCursorHint(
1008   SrcItem *pTabItem,  /* FROM clause item */
1009   WhereInfo *pWInfo,    /* The where clause */
1010   WhereLevel *pLevel,   /* Which loop to provide hints for */
1011   WhereTerm *pEndRange  /* Hint this end-of-scan boundary term if not NULL */
1012 ){
1013   Parse *pParse = pWInfo->pParse;
1014   sqlite3 *db = pParse->db;
1015   Vdbe *v = pParse->pVdbe;
1016   Expr *pExpr = 0;
1017   WhereLoop *pLoop = pLevel->pWLoop;
1018   int iCur;
1019   WhereClause *pWC;
1020   WhereTerm *pTerm;
1021   int i, j;
1022   struct CCurHint sHint;
1023   Walker sWalker;
1024 
1025   if( OptimizationDisabled(db, SQLITE_CursorHints) ) return;
1026   iCur = pLevel->iTabCur;
1027   assert( iCur==pWInfo->pTabList->a[pLevel->iFrom].iCursor );
1028   sHint.iTabCur = iCur;
1029   sHint.iIdxCur = pLevel->iIdxCur;
1030   sHint.pIdx = pLoop->u.btree.pIndex;
1031   memset(&sWalker, 0, sizeof(sWalker));
1032   sWalker.pParse = pParse;
1033   sWalker.u.pCCurHint = &sHint;
1034   pWC = &pWInfo->sWC;
1035   for(i=0; i<pWC->nBase; i++){
1036     pTerm = &pWC->a[i];
1037     if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
1038     if( pTerm->prereqAll & pLevel->notReady ) continue;
1039 
1040     /* Any terms specified as part of the ON(...) clause for any LEFT
1041     ** JOIN for which the current table is not the rhs are omitted
1042     ** from the cursor-hint.
1043     **
1044     ** If this table is the rhs of a LEFT JOIN, "IS" or "IS NULL" terms
1045     ** that were specified as part of the WHERE clause must be excluded.
1046     ** This is to address the following:
1047     **
1048     **   SELECT ... t1 LEFT JOIN t2 ON (t1.a=t2.b) WHERE t2.c IS NULL;
1049     **
1050     ** Say there is a single row in t2 that matches (t1.a=t2.b), but its
1051     ** t2.c values is not NULL. If the (t2.c IS NULL) constraint is
1052     ** pushed down to the cursor, this row is filtered out, causing
1053     ** SQLite to synthesize a row of NULL values. Which does match the
1054     ** WHERE clause, and so the query returns a row. Which is incorrect.
1055     **
1056     ** For the same reason, WHERE terms such as:
1057     **
1058     **   WHERE 1 = (t2.c IS NULL)
1059     **
1060     ** are also excluded. See codeCursorHintIsOrFunction() for details.
1061     */
1062     if( pTabItem->fg.jointype & JT_LEFT ){
1063       Expr *pExpr = pTerm->pExpr;
1064       if( !ExprHasProperty(pExpr, EP_FromJoin)
1065        || pExpr->iRightJoinTable!=pTabItem->iCursor
1066       ){
1067         sWalker.eCode = 0;
1068         sWalker.xExprCallback = codeCursorHintIsOrFunction;
1069         sqlite3WalkExpr(&sWalker, pTerm->pExpr);
1070         if( sWalker.eCode ) continue;
1071       }
1072     }else{
1073       if( ExprHasProperty(pTerm->pExpr, EP_FromJoin) ) continue;
1074     }
1075 
1076     /* All terms in pWLoop->aLTerm[] except pEndRange are used to initialize
1077     ** the cursor.  These terms are not needed as hints for a pure range
1078     ** scan (that has no == terms) so omit them. */
1079     if( pLoop->u.btree.nEq==0 && pTerm!=pEndRange ){
1080       for(j=0; j<pLoop->nLTerm && pLoop->aLTerm[j]!=pTerm; j++){}
1081       if( j<pLoop->nLTerm ) continue;
1082     }
1083 
1084     /* No subqueries or non-deterministic functions allowed */
1085     if( sqlite3ExprContainsSubquery(pTerm->pExpr) ) continue;
1086 
1087     /* For an index scan, make sure referenced columns are actually in
1088     ** the index. */
1089     if( sHint.pIdx!=0 ){
1090       sWalker.eCode = 0;
1091       sWalker.xExprCallback = codeCursorHintCheckExpr;
1092       sqlite3WalkExpr(&sWalker, pTerm->pExpr);
1093       if( sWalker.eCode ) continue;
1094     }
1095 
1096     /* If we survive all prior tests, that means this term is worth hinting */
1097     pExpr = sqlite3ExprAnd(pParse, pExpr, sqlite3ExprDup(db, pTerm->pExpr, 0));
1098   }
1099   if( pExpr!=0 ){
1100     sWalker.xExprCallback = codeCursorHintFixExpr;
1101     sqlite3WalkExpr(&sWalker, pExpr);
1102     sqlite3VdbeAddOp4(v, OP_CursorHint,
1103                       (sHint.pIdx ? sHint.iIdxCur : sHint.iTabCur), 0, 0,
1104                       (const char*)pExpr, P4_EXPR);
1105   }
1106 }
1107 #else
1108 # define codeCursorHint(A,B,C,D)  /* No-op */
1109 #endif /* SQLITE_ENABLE_CURSOR_HINTS */
1110 
1111 /*
1112 ** Cursor iCur is open on an intkey b-tree (a table). Register iRowid contains
1113 ** a rowid value just read from cursor iIdxCur, open on index pIdx. This
1114 ** function generates code to do a deferred seek of cursor iCur to the
1115 ** rowid stored in register iRowid.
1116 **
1117 ** Normally, this is just:
1118 **
1119 **   OP_DeferredSeek $iCur $iRowid
1120 **
1121 ** However, if the scan currently being coded is a branch of an OR-loop and
1122 ** the statement currently being coded is a SELECT, then P3 of OP_DeferredSeek
1123 ** is set to iIdxCur and P4 is set to point to an array of integers
1124 ** containing one entry for each column of the table cursor iCur is open
1125 ** on. For each table column, if the column is the i'th column of the
1126 ** index, then the corresponding array entry is set to (i+1). If the column
1127 ** does not appear in the index at all, the array entry is set to 0.
1128 */
1129 static void codeDeferredSeek(
1130   WhereInfo *pWInfo,              /* Where clause context */
1131   Index *pIdx,                    /* Index scan is using */
1132   int iCur,                       /* Cursor for IPK b-tree */
1133   int iIdxCur                     /* Index cursor */
1134 ){
1135   Parse *pParse = pWInfo->pParse; /* Parse context */
1136   Vdbe *v = pParse->pVdbe;        /* Vdbe to generate code within */
1137 
1138   assert( iIdxCur>0 );
1139   assert( pIdx->aiColumn[pIdx->nColumn-1]==-1 );
1140 
1141   pWInfo->bDeferredSeek = 1;
1142   sqlite3VdbeAddOp3(v, OP_DeferredSeek, iIdxCur, 0, iCur);
1143   if( (pWInfo->wctrlFlags & WHERE_OR_SUBCLAUSE)
1144    && DbMaskAllZero(sqlite3ParseToplevel(pParse)->writeMask)
1145   ){
1146     int i;
1147     Table *pTab = pIdx->pTable;
1148     u32 *ai = (u32*)sqlite3DbMallocZero(pParse->db, sizeof(u32)*(pTab->nCol+1));
1149     if( ai ){
1150       ai[0] = pTab->nCol;
1151       for(i=0; i<pIdx->nColumn-1; i++){
1152         int x1, x2;
1153         assert( pIdx->aiColumn[i]<pTab->nCol );
1154         x1 = pIdx->aiColumn[i];
1155         x2 = sqlite3TableColumnToStorage(pTab, x1);
1156         testcase( x1!=x2 );
1157         if( x1>=0 ) ai[x2+1] = i+1;
1158       }
1159       sqlite3VdbeChangeP4(v, -1, (char*)ai, P4_INTARRAY);
1160     }
1161   }
1162 }
1163 
1164 /*
1165 ** If the expression passed as the second argument is a vector, generate
1166 ** code to write the first nReg elements of the vector into an array
1167 ** of registers starting with iReg.
1168 **
1169 ** If the expression is not a vector, then nReg must be passed 1. In
1170 ** this case, generate code to evaluate the expression and leave the
1171 ** result in register iReg.
1172 */
1173 static void codeExprOrVector(Parse *pParse, Expr *p, int iReg, int nReg){
1174   assert( nReg>0 );
1175   if( p && sqlite3ExprIsVector(p) ){
1176 #ifndef SQLITE_OMIT_SUBQUERY
1177     if( ExprUseXSelect(p) ){
1178       Vdbe *v = pParse->pVdbe;
1179       int iSelect;
1180       assert( p->op==TK_SELECT );
1181       iSelect = sqlite3CodeSubselect(pParse, p);
1182       sqlite3VdbeAddOp3(v, OP_Copy, iSelect, iReg, nReg-1);
1183     }else
1184 #endif
1185     {
1186       int i;
1187       const ExprList *pList;
1188       assert( ExprUseXList(p) );
1189       pList = p->x.pList;
1190       assert( nReg<=pList->nExpr );
1191       for(i=0; i<nReg; i++){
1192         sqlite3ExprCode(pParse, pList->a[i].pExpr, iReg+i);
1193       }
1194     }
1195   }else{
1196     assert( nReg==1 || pParse->nErr );
1197     sqlite3ExprCode(pParse, p, iReg);
1198   }
1199 }
1200 
1201 /* An instance of the IdxExprTrans object carries information about a
1202 ** mapping from an expression on table columns into a column in an index
1203 ** down through the Walker.
1204 */
1205 typedef struct IdxExprTrans {
1206   Expr *pIdxExpr;    /* The index expression */
1207   int iTabCur;       /* The cursor of the corresponding table */
1208   int iIdxCur;       /* The cursor for the index */
1209   int iIdxCol;       /* The column for the index */
1210   int iTabCol;       /* The column for the table */
1211   WhereInfo *pWInfo; /* Complete WHERE clause information */
1212   sqlite3 *db;       /* Database connection (for malloc()) */
1213 } IdxExprTrans;
1214 
1215 /*
1216 ** Preserve pExpr on the WhereETrans list of the WhereInfo.
1217 */
1218 static void preserveExpr(IdxExprTrans *pTrans, Expr *pExpr){
1219   WhereExprMod *pNew;
1220   pNew = sqlite3DbMallocRaw(pTrans->db, sizeof(*pNew));
1221   if( pNew==0 ) return;
1222   pNew->pNext = pTrans->pWInfo->pExprMods;
1223   pTrans->pWInfo->pExprMods = pNew;
1224   pNew->pExpr = pExpr;
1225   memcpy(&pNew->orig, pExpr, sizeof(*pExpr));
1226 }
1227 
1228 /* The walker node callback used to transform matching expressions into
1229 ** a reference to an index column for an index on an expression.
1230 **
1231 ** If pExpr matches, then transform it into a reference to the index column
1232 ** that contains the value of pExpr.
1233 */
1234 static int whereIndexExprTransNode(Walker *p, Expr *pExpr){
1235   IdxExprTrans *pX = p->u.pIdxTrans;
1236   if( sqlite3ExprCompare(0, pExpr, pX->pIdxExpr, pX->iTabCur)==0 ){
1237     preserveExpr(pX, pExpr);
1238     pExpr->affExpr = sqlite3ExprAffinity(pExpr);
1239     pExpr->op = TK_COLUMN;
1240     pExpr->iTable = pX->iIdxCur;
1241     pExpr->iColumn = pX->iIdxCol;
1242     testcase( ExprHasProperty(pExpr, EP_Skip) );
1243     testcase( ExprHasProperty(pExpr, EP_Unlikely) );
1244     ExprClearProperty(pExpr, EP_Skip|EP_Unlikely|EP_WinFunc|EP_Subrtn);
1245     pExpr->y.pTab = 0;
1246     return WRC_Prune;
1247   }else{
1248     return WRC_Continue;
1249   }
1250 }
1251 
1252 #ifndef SQLITE_OMIT_GENERATED_COLUMNS
1253 /* A walker node callback that translates a column reference to a table
1254 ** into a corresponding column reference of an index.
1255 */
1256 static int whereIndexExprTransColumn(Walker *p, Expr *pExpr){
1257   if( pExpr->op==TK_COLUMN ){
1258     IdxExprTrans *pX = p->u.pIdxTrans;
1259     if( pExpr->iTable==pX->iTabCur && pExpr->iColumn==pX->iTabCol ){
1260       assert( ExprUseYTab(pExpr) && pExpr->y.pTab!=0 );
1261       preserveExpr(pX, pExpr);
1262       pExpr->affExpr = sqlite3TableColumnAffinity(pExpr->y.pTab,pExpr->iColumn);
1263       pExpr->iTable = pX->iIdxCur;
1264       pExpr->iColumn = pX->iIdxCol;
1265       pExpr->y.pTab = 0;
1266     }
1267   }
1268   return WRC_Continue;
1269 }
1270 #endif /* SQLITE_OMIT_GENERATED_COLUMNS */
1271 
1272 /*
1273 ** For an indexes on expression X, locate every instance of expression X
1274 ** in pExpr and change that subexpression into a reference to the appropriate
1275 ** column of the index.
1276 **
1277 ** 2019-10-24: Updated to also translate references to a VIRTUAL column in
1278 ** the table into references to the corresponding (stored) column of the
1279 ** index.
1280 */
1281 static void whereIndexExprTrans(
1282   Index *pIdx,      /* The Index */
1283   int iTabCur,      /* Cursor of the table that is being indexed */
1284   int iIdxCur,      /* Cursor of the index itself */
1285   WhereInfo *pWInfo /* Transform expressions in this WHERE clause */
1286 ){
1287   int iIdxCol;               /* Column number of the index */
1288   ExprList *aColExpr;        /* Expressions that are indexed */
1289   Table *pTab;
1290   Walker w;
1291   IdxExprTrans x;
1292   aColExpr = pIdx->aColExpr;
1293   if( aColExpr==0 && !pIdx->bHasVCol ){
1294     /* The index does not reference any expressions or virtual columns
1295     ** so no translations are needed. */
1296     return;
1297   }
1298   pTab = pIdx->pTable;
1299   memset(&w, 0, sizeof(w));
1300   w.u.pIdxTrans = &x;
1301   x.iTabCur = iTabCur;
1302   x.iIdxCur = iIdxCur;
1303   x.pWInfo = pWInfo;
1304   x.db = pWInfo->pParse->db;
1305   for(iIdxCol=0; iIdxCol<pIdx->nColumn; iIdxCol++){
1306     i16 iRef = pIdx->aiColumn[iIdxCol];
1307     if( iRef==XN_EXPR ){
1308       assert( aColExpr!=0 && aColExpr->a[iIdxCol].pExpr!=0 );
1309       x.pIdxExpr = aColExpr->a[iIdxCol].pExpr;
1310       if( sqlite3ExprIsConstant(x.pIdxExpr) ) continue;
1311       w.xExprCallback = whereIndexExprTransNode;
1312 #ifndef SQLITE_OMIT_GENERATED_COLUMNS
1313     }else if( iRef>=0
1314        && (pTab->aCol[iRef].colFlags & COLFLAG_VIRTUAL)!=0
1315        && ((pTab->aCol[iRef].colFlags & COLFLAG_HASCOLL)==0
1316            || sqlite3StrICmp(sqlite3ColumnColl(&pTab->aCol[iRef]),
1317                                                sqlite3StrBINARY)==0)
1318     ){
1319       /* Check to see if there are direct references to generated columns
1320       ** that are contained in the index.  Pulling the generated column
1321       ** out of the index is an optimization only - the main table is always
1322       ** available if the index cannot be used.  To avoid unnecessary
1323       ** complication, omit this optimization if the collating sequence for
1324       ** the column is non-standard */
1325       x.iTabCol = iRef;
1326       w.xExprCallback = whereIndexExprTransColumn;
1327 #endif /* SQLITE_OMIT_GENERATED_COLUMNS */
1328     }else{
1329       continue;
1330     }
1331     x.iIdxCol = iIdxCol;
1332     sqlite3WalkExpr(&w, pWInfo->pWhere);
1333     sqlite3WalkExprList(&w, pWInfo->pOrderBy);
1334     sqlite3WalkExprList(&w, pWInfo->pResultSet);
1335   }
1336 }
1337 
1338 /*
1339 ** The pTruth expression is always true because it is the WHERE clause
1340 ** a partial index that is driving a query loop.  Look through all of the
1341 ** WHERE clause terms on the query, and if any of those terms must be
1342 ** true because pTruth is true, then mark those WHERE clause terms as
1343 ** coded.
1344 */
1345 static void whereApplyPartialIndexConstraints(
1346   Expr *pTruth,
1347   int iTabCur,
1348   WhereClause *pWC
1349 ){
1350   int i;
1351   WhereTerm *pTerm;
1352   while( pTruth->op==TK_AND ){
1353     whereApplyPartialIndexConstraints(pTruth->pLeft, iTabCur, pWC);
1354     pTruth = pTruth->pRight;
1355   }
1356   for(i=0, pTerm=pWC->a; i<pWC->nTerm; i++, pTerm++){
1357     Expr *pExpr;
1358     if( pTerm->wtFlags & TERM_CODED ) continue;
1359     pExpr = pTerm->pExpr;
1360     if( sqlite3ExprCompare(0, pExpr, pTruth, iTabCur)==0 ){
1361       pTerm->wtFlags |= TERM_CODED;
1362     }
1363   }
1364 }
1365 
1366 /*
1367 ** This routine is called right after An OP_Filter has been generated and
1368 ** before the corresponding index search has been performed.  This routine
1369 ** checks to see if there are additional Bloom filters in inner loops that
1370 ** can be checked prior to doing the index lookup.  If there are available
1371 ** inner-loop Bloom filters, then evaluate those filters now, before the
1372 ** index lookup.  The idea is that a Bloom filter check is way faster than
1373 ** an index lookup, and the Bloom filter might return false, meaning that
1374 ** the index lookup can be skipped.
1375 **
1376 ** We know that an inner loop uses a Bloom filter because it has the
1377 ** WhereLevel.regFilter set.  If an inner-loop Bloom filter is checked,
1378 ** then clear the WhereLevel.regFilter value to prevent the Bloom filter
1379 ** from being checked a second time when the inner loop is evaluated.
1380 */
1381 static SQLITE_NOINLINE void filterPullDown(
1382   Parse *pParse,       /* Parsing context */
1383   WhereInfo *pWInfo,   /* Complete information about the WHERE clause */
1384   int iLevel,          /* Which level of pWInfo->a[] should be coded */
1385   int addrNxt,         /* Jump here to bypass inner loops */
1386   Bitmask notReady     /* Loops that are not ready */
1387 ){
1388   while( ++iLevel < pWInfo->nLevel ){
1389     WhereLevel *pLevel = &pWInfo->a[iLevel];
1390     WhereLoop *pLoop = pLevel->pWLoop;
1391     if( pLevel->regFilter==0 ) continue;
1392     /*         ,--- Because sqlite3ConstructBloomFilter() has will not have set
1393     **  vvvvv--'    pLevel->regFilter if this were true. */
1394     if( NEVER(pLoop->prereq & notReady) ) continue;
1395     if( pLoop->wsFlags & WHERE_IPK ){
1396       WhereTerm *pTerm = pLoop->aLTerm[0];
1397       int regRowid;
1398       assert( pTerm!=0 );
1399       assert( pTerm->pExpr!=0 );
1400       testcase( pTerm->wtFlags & TERM_VIRTUAL );
1401       regRowid = sqlite3GetTempReg(pParse);
1402       regRowid = codeEqualityTerm(pParse, pTerm, pLevel, 0, 0, regRowid);
1403       sqlite3VdbeAddOp4Int(pParse->pVdbe, OP_Filter, pLevel->regFilter,
1404                            addrNxt, regRowid, 1);
1405       VdbeCoverage(pParse->pVdbe);
1406     }else{
1407       u16 nEq = pLoop->u.btree.nEq;
1408       int r1;
1409       char *zStartAff;
1410 
1411       assert( pLoop->wsFlags & WHERE_INDEXED );
1412       assert( (pLoop->wsFlags & WHERE_COLUMN_IN)==0 );
1413       r1 = codeAllEqualityTerms(pParse,pLevel,0,0,&zStartAff);
1414       codeApplyAffinity(pParse, r1, nEq, zStartAff);
1415       sqlite3DbFree(pParse->db, zStartAff);
1416       sqlite3VdbeAddOp4Int(pParse->pVdbe, OP_Filter, pLevel->regFilter,
1417                            addrNxt, r1, nEq);
1418       VdbeCoverage(pParse->pVdbe);
1419     }
1420     pLevel->regFilter = 0;
1421   }
1422 }
1423 
1424 /*
1425 ** Generate code for the start of the iLevel-th loop in the WHERE clause
1426 ** implementation described by pWInfo.
1427 */
1428 Bitmask sqlite3WhereCodeOneLoopStart(
1429   Parse *pParse,       /* Parsing context */
1430   Vdbe *v,             /* Prepared statement under construction */
1431   WhereInfo *pWInfo,   /* Complete information about the WHERE clause */
1432   int iLevel,          /* Which level of pWInfo->a[] should be coded */
1433   WhereLevel *pLevel,  /* The current level pointer */
1434   Bitmask notReady     /* Which tables are currently available */
1435 ){
1436   int j, k;            /* Loop counters */
1437   int iCur;            /* The VDBE cursor for the table */
1438   int addrNxt;         /* Where to jump to continue with the next IN case */
1439   int bRev;            /* True if we need to scan in reverse order */
1440   WhereLoop *pLoop;    /* The WhereLoop object being coded */
1441   WhereClause *pWC;    /* Decomposition of the entire WHERE clause */
1442   WhereTerm *pTerm;               /* A WHERE clause term */
1443   sqlite3 *db;                    /* Database connection */
1444   SrcItem *pTabItem;              /* FROM clause term being coded */
1445   int addrBrk;                    /* Jump here to break out of the loop */
1446   int addrHalt;                   /* addrBrk for the outermost loop */
1447   int addrCont;                   /* Jump here to continue with next cycle */
1448   int iRowidReg = 0;        /* Rowid is stored in this register, if not zero */
1449   int iReleaseReg = 0;      /* Temp register to free before returning */
1450   Index *pIdx = 0;          /* Index used by loop (if any) */
1451   int iLoop;                /* Iteration of constraint generator loop */
1452 
1453   pWC = &pWInfo->sWC;
1454   db = pParse->db;
1455   pLoop = pLevel->pWLoop;
1456   pTabItem = &pWInfo->pTabList->a[pLevel->iFrom];
1457   iCur = pTabItem->iCursor;
1458   pLevel->notReady = notReady & ~sqlite3WhereGetMask(&pWInfo->sMaskSet, iCur);
1459   bRev = (pWInfo->revMask>>iLevel)&1;
1460   VdbeModuleComment((v, "Begin WHERE-loop%d: %s",iLevel,pTabItem->pTab->zName));
1461 #if WHERETRACE_ENABLED /* 0x20800 */
1462   if( sqlite3WhereTrace & 0x800 ){
1463     sqlite3DebugPrintf("Coding level %d of %d:  notReady=%llx  iFrom=%d\n",
1464        iLevel, pWInfo->nLevel, (u64)notReady, pLevel->iFrom);
1465     sqlite3WhereLoopPrint(pLoop, pWC);
1466   }
1467   if( sqlite3WhereTrace & 0x20000 ){
1468     if( iLevel==0 ){
1469       sqlite3DebugPrintf("WHERE clause being coded:\n");
1470       sqlite3TreeViewExpr(0, pWInfo->pWhere, 0);
1471     }
1472     sqlite3DebugPrintf("All WHERE-clause terms before coding:\n");
1473     sqlite3WhereClausePrint(pWC);
1474   }
1475 #endif
1476 
1477   /* Create labels for the "break" and "continue" instructions
1478   ** for the current loop.  Jump to addrBrk to break out of a loop.
1479   ** Jump to cont to go immediately to the next iteration of the
1480   ** loop.
1481   **
1482   ** When there is an IN operator, we also have a "addrNxt" label that
1483   ** means to continue with the next IN value combination.  When
1484   ** there are no IN operators in the constraints, the "addrNxt" label
1485   ** is the same as "addrBrk".
1486   */
1487   addrBrk = pLevel->addrBrk = pLevel->addrNxt = sqlite3VdbeMakeLabel(pParse);
1488   addrCont = pLevel->addrCont = sqlite3VdbeMakeLabel(pParse);
1489 
1490   /* If this is the right table of a LEFT OUTER JOIN, allocate and
1491   ** initialize a memory cell that records if this table matches any
1492   ** row of the left table of the join.
1493   */
1494   assert( (pWInfo->wctrlFlags & WHERE_OR_SUBCLAUSE)
1495        || pLevel->iFrom>0 || (pTabItem[0].fg.jointype & JT_LEFT)==0
1496   );
1497   if( pLevel->iFrom>0 && (pTabItem[0].fg.jointype & JT_LEFT)!=0 ){
1498     pLevel->iLeftJoin = ++pParse->nMem;
1499     sqlite3VdbeAddOp2(v, OP_Integer, 0, pLevel->iLeftJoin);
1500     VdbeComment((v, "init LEFT JOIN no-match flag"));
1501   }
1502 
1503   /* Compute a safe address to jump to if we discover that the table for
1504   ** this loop is empty and can never contribute content. */
1505   for(j=iLevel; j>0 && pWInfo->a[j].iLeftJoin==0; j--){}
1506   addrHalt = pWInfo->a[j].addrBrk;
1507 
1508   /* Special case of a FROM clause subquery implemented as a co-routine */
1509   if( pTabItem->fg.viaCoroutine ){
1510     int regYield = pTabItem->regReturn;
1511     sqlite3VdbeAddOp3(v, OP_InitCoroutine, regYield, 0, pTabItem->addrFillSub);
1512     pLevel->p2 =  sqlite3VdbeAddOp2(v, OP_Yield, regYield, addrBrk);
1513     VdbeCoverage(v);
1514     VdbeComment((v, "next row of %s", pTabItem->pTab->zName));
1515     pLevel->op = OP_Goto;
1516   }else
1517 
1518 #ifndef SQLITE_OMIT_VIRTUALTABLE
1519   if(  (pLoop->wsFlags & WHERE_VIRTUALTABLE)!=0 ){
1520     /* Case 1:  The table is a virtual-table.  Use the VFilter and VNext
1521     **          to access the data.
1522     */
1523     int iReg;   /* P3 Value for OP_VFilter */
1524     int addrNotFound;
1525     int nConstraint = pLoop->nLTerm;
1526     int iIn;    /* Counter for IN constraints */
1527 
1528     iReg = sqlite3GetTempRange(pParse, nConstraint+2);
1529     addrNotFound = pLevel->addrBrk;
1530     for(j=0; j<nConstraint; j++){
1531       int iTarget = iReg+j+2;
1532       pTerm = pLoop->aLTerm[j];
1533       if( NEVER(pTerm==0) ) continue;
1534       if( pTerm->eOperator & WO_IN ){
1535         if( SMASKBIT32(j) & pLoop->u.vtab.mHandleIn ){
1536           int iTab = pParse->nTab++;
1537           int iCache = ++pParse->nMem;
1538           sqlite3CodeRhsOfIN(pParse, pTerm->pExpr, iTab);
1539           sqlite3VdbeAddOp3(v, OP_VInitIn, iTab, iTarget, iCache);
1540         }else{
1541           codeEqualityTerm(pParse, pTerm, pLevel, j, bRev, iTarget);
1542           addrNotFound = pLevel->addrNxt;
1543         }
1544       }else{
1545         Expr *pRight = pTerm->pExpr->pRight;
1546         codeExprOrVector(pParse, pRight, iTarget, 1);
1547         if( pTerm->eMatchOp==SQLITE_INDEX_CONSTRAINT_OFFSET
1548          && pLoop->u.vtab.bOmitOffset
1549         ){
1550           assert( pTerm->eOperator==WO_AUX );
1551           assert( pWInfo->pLimit!=0 );
1552           assert( pWInfo->pLimit->iOffset>0 );
1553           sqlite3VdbeAddOp2(v, OP_Integer, 0, pWInfo->pLimit->iOffset);
1554           VdbeComment((v,"Zero OFFSET counter"));
1555         }
1556       }
1557     }
1558     sqlite3VdbeAddOp2(v, OP_Integer, pLoop->u.vtab.idxNum, iReg);
1559     sqlite3VdbeAddOp2(v, OP_Integer, nConstraint, iReg+1);
1560     sqlite3VdbeAddOp4(v, OP_VFilter, iCur, addrNotFound, iReg,
1561                       pLoop->u.vtab.idxStr,
1562                       pLoop->u.vtab.needFree ? P4_DYNAMIC : P4_STATIC);
1563     VdbeCoverage(v);
1564     pLoop->u.vtab.needFree = 0;
1565     /* An OOM inside of AddOp4(OP_VFilter) instruction above might have freed
1566     ** the u.vtab.idxStr.  NULL it out to prevent a use-after-free */
1567     if( db->mallocFailed ) pLoop->u.vtab.idxStr = 0;
1568     pLevel->p1 = iCur;
1569     pLevel->op = pWInfo->eOnePass ? OP_Noop : OP_VNext;
1570     pLevel->p2 = sqlite3VdbeCurrentAddr(v);
1571     assert( (pLoop->wsFlags & WHERE_MULTI_OR)==0 );
1572     if( pLoop->wsFlags & WHERE_IN_ABLE ){
1573       iIn = pLevel->u.in.nIn;
1574     }else{
1575       iIn = 0;
1576     }
1577     for(j=nConstraint-1; j>=0; j--){
1578       int bIn;     /* True to generate byte code to loop over RHS IN values */
1579       pTerm = pLoop->aLTerm[j];
1580       if( (pTerm->eOperator & WO_IN)!=0
1581        && (SMASKBIT32(j) & pLoop->u.vtab.mHandleIn)==0
1582       ){
1583         bIn = 1;
1584       }else{
1585         bIn = 0;
1586       }
1587       if( bIn ) iIn--;
1588       if( j<16 && (pLoop->u.vtab.omitMask>>j)&1 ){
1589         disableTerm(pLevel, pTerm);
1590       }else if( bIn && sqlite3ExprVectorSize(pTerm->pExpr->pLeft)==1 ){
1591         Expr *pCompare;  /* The comparison operator */
1592         Expr *pRight;    /* RHS of the comparison */
1593         VdbeOp *pOp;     /* Opcode to access the value of the IN constraint */
1594 
1595         /* Reload the constraint value into reg[iReg+j+2].  The same value
1596         ** was loaded into the same register prior to the OP_VFilter, but
1597         ** the xFilter implementation might have changed the datatype or
1598         ** encoding of the value in the register, so it *must* be reloaded. */
1599         assert( pLevel->u.in.aInLoop!=0 || db->mallocFailed );
1600         if( !db->mallocFailed ){
1601           assert( iIn>=0 && iIn<pLevel->u.in.nIn );
1602           pOp = sqlite3VdbeGetOp(v, pLevel->u.in.aInLoop[iIn].addrInTop);
1603           assert( pOp->opcode==OP_Column || pOp->opcode==OP_Rowid );
1604           assert( pOp->opcode!=OP_Column || pOp->p3==iReg+j+2 );
1605           assert( pOp->opcode!=OP_Rowid || pOp->p2==iReg+j+2 );
1606           testcase( pOp->opcode==OP_Rowid );
1607           sqlite3VdbeAddOp3(v, pOp->opcode, pOp->p1, pOp->p2, pOp->p3);
1608         }
1609 
1610         /* Generate code that will continue to the next row if
1611         ** the IN constraint is not satisfied */
1612         pCompare = sqlite3PExpr(pParse, TK_EQ, 0, 0);
1613         assert( pCompare!=0 || db->mallocFailed );
1614         if( pCompare ){
1615           pCompare->pLeft = pTerm->pExpr->pLeft;
1616           pCompare->pRight = pRight = sqlite3Expr(db, TK_REGISTER, 0);
1617           if( pRight ){
1618             pRight->iTable = iReg+j+2;
1619             sqlite3ExprIfFalse(
1620                 pParse, pCompare, pLevel->addrCont, SQLITE_JUMPIFNULL
1621             );
1622           }
1623           pCompare->pLeft = 0;
1624           sqlite3ExprDelete(db, pCompare);
1625         }
1626       }
1627     }
1628     assert( iIn==0 || db->mallocFailed );
1629     /* These registers need to be preserved in case there is an IN operator
1630     ** loop.  So we could deallocate the registers here (and potentially
1631     ** reuse them later) if (pLoop->wsFlags & WHERE_IN_ABLE)==0.  But it seems
1632     ** simpler and safer to simply not reuse the registers.
1633     **
1634     **    sqlite3ReleaseTempRange(pParse, iReg, nConstraint+2);
1635     */
1636   }else
1637 #endif /* SQLITE_OMIT_VIRTUALTABLE */
1638 
1639   if( (pLoop->wsFlags & WHERE_IPK)!=0
1640    && (pLoop->wsFlags & (WHERE_COLUMN_IN|WHERE_COLUMN_EQ))!=0
1641   ){
1642     /* Case 2:  We can directly reference a single row using an
1643     **          equality comparison against the ROWID field.  Or
1644     **          we reference multiple rows using a "rowid IN (...)"
1645     **          construct.
1646     */
1647     assert( pLoop->u.btree.nEq==1 );
1648     pTerm = pLoop->aLTerm[0];
1649     assert( pTerm!=0 );
1650     assert( pTerm->pExpr!=0 );
1651     testcase( pTerm->wtFlags & TERM_VIRTUAL );
1652     iReleaseReg = ++pParse->nMem;
1653     iRowidReg = codeEqualityTerm(pParse, pTerm, pLevel, 0, bRev, iReleaseReg);
1654     if( iRowidReg!=iReleaseReg ) sqlite3ReleaseTempReg(pParse, iReleaseReg);
1655     addrNxt = pLevel->addrNxt;
1656     if( pLevel->regFilter ){
1657       sqlite3VdbeAddOp4Int(v, OP_Filter, pLevel->regFilter, addrNxt,
1658                            iRowidReg, 1);
1659       VdbeCoverage(v);
1660       filterPullDown(pParse, pWInfo, iLevel, addrNxt, notReady);
1661     }
1662     sqlite3VdbeAddOp3(v, OP_SeekRowid, iCur, addrNxt, iRowidReg);
1663     VdbeCoverage(v);
1664     pLevel->op = OP_Noop;
1665   }else if( (pLoop->wsFlags & WHERE_IPK)!=0
1666          && (pLoop->wsFlags & WHERE_COLUMN_RANGE)!=0
1667   ){
1668     /* Case 3:  We have an inequality comparison against the ROWID field.
1669     */
1670     int testOp = OP_Noop;
1671     int start;
1672     int memEndValue = 0;
1673     WhereTerm *pStart, *pEnd;
1674 
1675     j = 0;
1676     pStart = pEnd = 0;
1677     if( pLoop->wsFlags & WHERE_BTM_LIMIT ) pStart = pLoop->aLTerm[j++];
1678     if( pLoop->wsFlags & WHERE_TOP_LIMIT ) pEnd = pLoop->aLTerm[j++];
1679     assert( pStart!=0 || pEnd!=0 );
1680     if( bRev ){
1681       pTerm = pStart;
1682       pStart = pEnd;
1683       pEnd = pTerm;
1684     }
1685     codeCursorHint(pTabItem, pWInfo, pLevel, pEnd);
1686     if( pStart ){
1687       Expr *pX;             /* The expression that defines the start bound */
1688       int r1, rTemp;        /* Registers for holding the start boundary */
1689       int op;               /* Cursor seek operation */
1690 
1691       /* The following constant maps TK_xx codes into corresponding
1692       ** seek opcodes.  It depends on a particular ordering of TK_xx
1693       */
1694       const u8 aMoveOp[] = {
1695            /* TK_GT */  OP_SeekGT,
1696            /* TK_LE */  OP_SeekLE,
1697            /* TK_LT */  OP_SeekLT,
1698            /* TK_GE */  OP_SeekGE
1699       };
1700       assert( TK_LE==TK_GT+1 );      /* Make sure the ordering.. */
1701       assert( TK_LT==TK_GT+2 );      /*  ... of the TK_xx values... */
1702       assert( TK_GE==TK_GT+3 );      /*  ... is correcct. */
1703 
1704       assert( (pStart->wtFlags & TERM_VNULL)==0 );
1705       testcase( pStart->wtFlags & TERM_VIRTUAL );
1706       pX = pStart->pExpr;
1707       assert( pX!=0 );
1708       testcase( pStart->leftCursor!=iCur ); /* transitive constraints */
1709       if( sqlite3ExprIsVector(pX->pRight) ){
1710         r1 = rTemp = sqlite3GetTempReg(pParse);
1711         codeExprOrVector(pParse, pX->pRight, r1, 1);
1712         testcase( pX->op==TK_GT );
1713         testcase( pX->op==TK_GE );
1714         testcase( pX->op==TK_LT );
1715         testcase( pX->op==TK_LE );
1716         op = aMoveOp[((pX->op - TK_GT - 1) & 0x3) | 0x1];
1717         assert( pX->op!=TK_GT || op==OP_SeekGE );
1718         assert( pX->op!=TK_GE || op==OP_SeekGE );
1719         assert( pX->op!=TK_LT || op==OP_SeekLE );
1720         assert( pX->op!=TK_LE || op==OP_SeekLE );
1721       }else{
1722         r1 = sqlite3ExprCodeTemp(pParse, pX->pRight, &rTemp);
1723         disableTerm(pLevel, pStart);
1724         op = aMoveOp[(pX->op - TK_GT)];
1725       }
1726       sqlite3VdbeAddOp3(v, op, iCur, addrBrk, r1);
1727       VdbeComment((v, "pk"));
1728       VdbeCoverageIf(v, pX->op==TK_GT);
1729       VdbeCoverageIf(v, pX->op==TK_LE);
1730       VdbeCoverageIf(v, pX->op==TK_LT);
1731       VdbeCoverageIf(v, pX->op==TK_GE);
1732       sqlite3ReleaseTempReg(pParse, rTemp);
1733     }else{
1734       sqlite3VdbeAddOp2(v, bRev ? OP_Last : OP_Rewind, iCur, addrHalt);
1735       VdbeCoverageIf(v, bRev==0);
1736       VdbeCoverageIf(v, bRev!=0);
1737     }
1738     if( pEnd ){
1739       Expr *pX;
1740       pX = pEnd->pExpr;
1741       assert( pX!=0 );
1742       assert( (pEnd->wtFlags & TERM_VNULL)==0 );
1743       testcase( pEnd->leftCursor!=iCur ); /* Transitive constraints */
1744       testcase( pEnd->wtFlags & TERM_VIRTUAL );
1745       memEndValue = ++pParse->nMem;
1746       codeExprOrVector(pParse, pX->pRight, memEndValue, 1);
1747       if( 0==sqlite3ExprIsVector(pX->pRight)
1748        && (pX->op==TK_LT || pX->op==TK_GT)
1749       ){
1750         testOp = bRev ? OP_Le : OP_Ge;
1751       }else{
1752         testOp = bRev ? OP_Lt : OP_Gt;
1753       }
1754       if( 0==sqlite3ExprIsVector(pX->pRight) ){
1755         disableTerm(pLevel, pEnd);
1756       }
1757     }
1758     start = sqlite3VdbeCurrentAddr(v);
1759     pLevel->op = bRev ? OP_Prev : OP_Next;
1760     pLevel->p1 = iCur;
1761     pLevel->p2 = start;
1762     assert( pLevel->p5==0 );
1763     if( testOp!=OP_Noop ){
1764       iRowidReg = ++pParse->nMem;
1765       sqlite3VdbeAddOp2(v, OP_Rowid, iCur, iRowidReg);
1766       sqlite3VdbeAddOp3(v, testOp, memEndValue, addrBrk, iRowidReg);
1767       VdbeCoverageIf(v, testOp==OP_Le);
1768       VdbeCoverageIf(v, testOp==OP_Lt);
1769       VdbeCoverageIf(v, testOp==OP_Ge);
1770       VdbeCoverageIf(v, testOp==OP_Gt);
1771       sqlite3VdbeChangeP5(v, SQLITE_AFF_NUMERIC | SQLITE_JUMPIFNULL);
1772     }
1773   }else if( pLoop->wsFlags & WHERE_INDEXED ){
1774     /* Case 4: A scan using an index.
1775     **
1776     **         The WHERE clause may contain zero or more equality
1777     **         terms ("==" or "IN" operators) that refer to the N
1778     **         left-most columns of the index. It may also contain
1779     **         inequality constraints (>, <, >= or <=) on the indexed
1780     **         column that immediately follows the N equalities. Only
1781     **         the right-most column can be an inequality - the rest must
1782     **         use the "==" and "IN" operators. For example, if the
1783     **         index is on (x,y,z), then the following clauses are all
1784     **         optimized:
1785     **
1786     **            x=5
1787     **            x=5 AND y=10
1788     **            x=5 AND y<10
1789     **            x=5 AND y>5 AND y<10
1790     **            x=5 AND y=5 AND z<=10
1791     **
1792     **         The z<10 term of the following cannot be used, only
1793     **         the x=5 term:
1794     **
1795     **            x=5 AND z<10
1796     **
1797     **         N may be zero if there are inequality constraints.
1798     **         If there are no inequality constraints, then N is at
1799     **         least one.
1800     **
1801     **         This case is also used when there are no WHERE clause
1802     **         constraints but an index is selected anyway, in order
1803     **         to force the output order to conform to an ORDER BY.
1804     */
1805     static const u8 aStartOp[] = {
1806       0,
1807       0,
1808       OP_Rewind,           /* 2: (!start_constraints && startEq &&  !bRev) */
1809       OP_Last,             /* 3: (!start_constraints && startEq &&   bRev) */
1810       OP_SeekGT,           /* 4: (start_constraints  && !startEq && !bRev) */
1811       OP_SeekLT,           /* 5: (start_constraints  && !startEq &&  bRev) */
1812       OP_SeekGE,           /* 6: (start_constraints  &&  startEq && !bRev) */
1813       OP_SeekLE            /* 7: (start_constraints  &&  startEq &&  bRev) */
1814     };
1815     static const u8 aEndOp[] = {
1816       OP_IdxGE,            /* 0: (end_constraints && !bRev && !endEq) */
1817       OP_IdxGT,            /* 1: (end_constraints && !bRev &&  endEq) */
1818       OP_IdxLE,            /* 2: (end_constraints &&  bRev && !endEq) */
1819       OP_IdxLT,            /* 3: (end_constraints &&  bRev &&  endEq) */
1820     };
1821     u16 nEq = pLoop->u.btree.nEq;     /* Number of == or IN terms */
1822     u16 nBtm = pLoop->u.btree.nBtm;   /* Length of BTM vector */
1823     u16 nTop = pLoop->u.btree.nTop;   /* Length of TOP vector */
1824     int regBase;                 /* Base register holding constraint values */
1825     WhereTerm *pRangeStart = 0;  /* Inequality constraint at range start */
1826     WhereTerm *pRangeEnd = 0;    /* Inequality constraint at range end */
1827     int startEq;                 /* True if range start uses ==, >= or <= */
1828     int endEq;                   /* True if range end uses ==, >= or <= */
1829     int start_constraints;       /* Start of range is constrained */
1830     int nConstraint;             /* Number of constraint terms */
1831     int iIdxCur;                 /* The VDBE cursor for the index */
1832     int nExtraReg = 0;           /* Number of extra registers needed */
1833     int op;                      /* Instruction opcode */
1834     char *zStartAff;             /* Affinity for start of range constraint */
1835     char *zEndAff = 0;           /* Affinity for end of range constraint */
1836     u8 bSeekPastNull = 0;        /* True to seek past initial nulls */
1837     u8 bStopAtNull = 0;          /* Add condition to terminate at NULLs */
1838     int omitTable;               /* True if we use the index only */
1839     int regBignull = 0;          /* big-null flag register */
1840     int addrSeekScan = 0;        /* Opcode of the OP_SeekScan, if any */
1841 
1842     pIdx = pLoop->u.btree.pIndex;
1843     iIdxCur = pLevel->iIdxCur;
1844     assert( nEq>=pLoop->nSkip );
1845 
1846     /* Find any inequality constraint terms for the start and end
1847     ** of the range.
1848     */
1849     j = nEq;
1850     if( pLoop->wsFlags & WHERE_BTM_LIMIT ){
1851       pRangeStart = pLoop->aLTerm[j++];
1852       nExtraReg = MAX(nExtraReg, pLoop->u.btree.nBtm);
1853       /* Like optimization range constraints always occur in pairs */
1854       assert( (pRangeStart->wtFlags & TERM_LIKEOPT)==0 ||
1855               (pLoop->wsFlags & WHERE_TOP_LIMIT)!=0 );
1856     }
1857     if( pLoop->wsFlags & WHERE_TOP_LIMIT ){
1858       pRangeEnd = pLoop->aLTerm[j++];
1859       nExtraReg = MAX(nExtraReg, pLoop->u.btree.nTop);
1860 #ifndef SQLITE_LIKE_DOESNT_MATCH_BLOBS
1861       if( (pRangeEnd->wtFlags & TERM_LIKEOPT)!=0 ){
1862         assert( pRangeStart!=0 );                     /* LIKE opt constraints */
1863         assert( pRangeStart->wtFlags & TERM_LIKEOPT );   /* occur in pairs */
1864         pLevel->iLikeRepCntr = (u32)++pParse->nMem;
1865         sqlite3VdbeAddOp2(v, OP_Integer, 1, (int)pLevel->iLikeRepCntr);
1866         VdbeComment((v, "LIKE loop counter"));
1867         pLevel->addrLikeRep = sqlite3VdbeCurrentAddr(v);
1868         /* iLikeRepCntr actually stores 2x the counter register number.  The
1869         ** bottom bit indicates whether the search order is ASC or DESC. */
1870         testcase( bRev );
1871         testcase( pIdx->aSortOrder[nEq]==SQLITE_SO_DESC );
1872         assert( (bRev & ~1)==0 );
1873         pLevel->iLikeRepCntr <<=1;
1874         pLevel->iLikeRepCntr |= bRev ^ (pIdx->aSortOrder[nEq]==SQLITE_SO_DESC);
1875       }
1876 #endif
1877       if( pRangeStart==0 ){
1878         j = pIdx->aiColumn[nEq];
1879         if( (j>=0 && pIdx->pTable->aCol[j].notNull==0) || j==XN_EXPR ){
1880           bSeekPastNull = 1;
1881         }
1882       }
1883     }
1884     assert( pRangeEnd==0 || (pRangeEnd->wtFlags & TERM_VNULL)==0 );
1885 
1886     /* If the WHERE_BIGNULL_SORT flag is set, then index column nEq uses
1887     ** a non-default "big-null" sort (either ASC NULLS LAST or DESC NULLS
1888     ** FIRST). In both cases separate ordered scans are made of those
1889     ** index entries for which the column is null and for those for which
1890     ** it is not. For an ASC sort, the non-NULL entries are scanned first.
1891     ** For DESC, NULL entries are scanned first.
1892     */
1893     if( (pLoop->wsFlags & (WHERE_TOP_LIMIT|WHERE_BTM_LIMIT))==0
1894      && (pLoop->wsFlags & WHERE_BIGNULL_SORT)!=0
1895     ){
1896       assert( bSeekPastNull==0 && nExtraReg==0 && nBtm==0 && nTop==0 );
1897       assert( pRangeEnd==0 && pRangeStart==0 );
1898       testcase( pLoop->nSkip>0 );
1899       nExtraReg = 1;
1900       bSeekPastNull = 1;
1901       pLevel->regBignull = regBignull = ++pParse->nMem;
1902       if( pLevel->iLeftJoin ){
1903         sqlite3VdbeAddOp2(v, OP_Integer, 0, regBignull);
1904       }
1905       pLevel->addrBignull = sqlite3VdbeMakeLabel(pParse);
1906     }
1907 
1908     /* If we are doing a reverse order scan on an ascending index, or
1909     ** a forward order scan on a descending index, interchange the
1910     ** start and end terms (pRangeStart and pRangeEnd).
1911     */
1912     if( (nEq<pIdx->nColumn && bRev==(pIdx->aSortOrder[nEq]==SQLITE_SO_ASC)) ){
1913       SWAP(WhereTerm *, pRangeEnd, pRangeStart);
1914       SWAP(u8, bSeekPastNull, bStopAtNull);
1915       SWAP(u8, nBtm, nTop);
1916     }
1917 
1918     if( iLevel>0 && (pLoop->wsFlags & WHERE_IN_SEEKSCAN)!=0 ){
1919       /* In case OP_SeekScan is used, ensure that the index cursor does not
1920       ** point to a valid row for the first iteration of this loop. */
1921       sqlite3VdbeAddOp1(v, OP_NullRow, iIdxCur);
1922     }
1923 
1924     /* Generate code to evaluate all constraint terms using == or IN
1925     ** and store the values of those terms in an array of registers
1926     ** starting at regBase.
1927     */
1928     codeCursorHint(pTabItem, pWInfo, pLevel, pRangeEnd);
1929     regBase = codeAllEqualityTerms(pParse,pLevel,bRev,nExtraReg,&zStartAff);
1930     assert( zStartAff==0 || sqlite3Strlen30(zStartAff)>=nEq );
1931     if( zStartAff && nTop ){
1932       zEndAff = sqlite3DbStrDup(db, &zStartAff[nEq]);
1933     }
1934     addrNxt = (regBignull ? pLevel->addrBignull : pLevel->addrNxt);
1935 
1936     testcase( pRangeStart && (pRangeStart->eOperator & WO_LE)!=0 );
1937     testcase( pRangeStart && (pRangeStart->eOperator & WO_GE)!=0 );
1938     testcase( pRangeEnd && (pRangeEnd->eOperator & WO_LE)!=0 );
1939     testcase( pRangeEnd && (pRangeEnd->eOperator & WO_GE)!=0 );
1940     startEq = !pRangeStart || pRangeStart->eOperator & (WO_LE|WO_GE);
1941     endEq =   !pRangeEnd || pRangeEnd->eOperator & (WO_LE|WO_GE);
1942     start_constraints = pRangeStart || nEq>0;
1943 
1944     /* Seek the index cursor to the start of the range. */
1945     nConstraint = nEq;
1946     if( pRangeStart ){
1947       Expr *pRight = pRangeStart->pExpr->pRight;
1948       codeExprOrVector(pParse, pRight, regBase+nEq, nBtm);
1949       whereLikeOptimizationStringFixup(v, pLevel, pRangeStart);
1950       if( (pRangeStart->wtFlags & TERM_VNULL)==0
1951        && sqlite3ExprCanBeNull(pRight)
1952       ){
1953         sqlite3VdbeAddOp2(v, OP_IsNull, regBase+nEq, addrNxt);
1954         VdbeCoverage(v);
1955       }
1956       if( zStartAff ){
1957         updateRangeAffinityStr(pRight, nBtm, &zStartAff[nEq]);
1958       }
1959       nConstraint += nBtm;
1960       testcase( pRangeStart->wtFlags & TERM_VIRTUAL );
1961       if( sqlite3ExprIsVector(pRight)==0 ){
1962         disableTerm(pLevel, pRangeStart);
1963       }else{
1964         startEq = 1;
1965       }
1966       bSeekPastNull = 0;
1967     }else if( bSeekPastNull ){
1968       startEq = 0;
1969       sqlite3VdbeAddOp2(v, OP_Null, 0, regBase+nEq);
1970       start_constraints = 1;
1971       nConstraint++;
1972     }else if( regBignull ){
1973       sqlite3VdbeAddOp2(v, OP_Null, 0, regBase+nEq);
1974       start_constraints = 1;
1975       nConstraint++;
1976     }
1977     codeApplyAffinity(pParse, regBase, nConstraint - bSeekPastNull, zStartAff);
1978     if( pLoop->nSkip>0 && nConstraint==pLoop->nSkip ){
1979       /* The skip-scan logic inside the call to codeAllEqualityConstraints()
1980       ** above has already left the cursor sitting on the correct row,
1981       ** so no further seeking is needed */
1982     }else{
1983       if( regBignull ){
1984         sqlite3VdbeAddOp2(v, OP_Integer, 1, regBignull);
1985         VdbeComment((v, "NULL-scan pass ctr"));
1986       }
1987       if( pLevel->regFilter ){
1988         sqlite3VdbeAddOp4Int(v, OP_Filter, pLevel->regFilter, addrNxt,
1989                              regBase, nEq);
1990         VdbeCoverage(v);
1991         filterPullDown(pParse, pWInfo, iLevel, addrNxt, notReady);
1992       }
1993 
1994       op = aStartOp[(start_constraints<<2) + (startEq<<1) + bRev];
1995       assert( op!=0 );
1996       if( (pLoop->wsFlags & WHERE_IN_SEEKSCAN)!=0 && op==OP_SeekGE ){
1997         assert( regBignull==0 );
1998         /* TUNING:  The OP_SeekScan opcode seeks to reduce the number
1999         ** of expensive seek operations by replacing a single seek with
2000         ** 1 or more step operations.  The question is, how many steps
2001         ** should we try before giving up and going with a seek.  The cost
2002         ** of a seek is proportional to the logarithm of the of the number
2003         ** of entries in the tree, so basing the number of steps to try
2004         ** on the estimated number of rows in the btree seems like a good
2005         ** guess. */
2006         addrSeekScan = sqlite3VdbeAddOp1(v, OP_SeekScan,
2007                                          (pIdx->aiRowLogEst[0]+9)/10);
2008         VdbeCoverage(v);
2009       }
2010       sqlite3VdbeAddOp4Int(v, op, iIdxCur, addrNxt, regBase, nConstraint);
2011       VdbeCoverage(v);
2012       VdbeCoverageIf(v, op==OP_Rewind);  testcase( op==OP_Rewind );
2013       VdbeCoverageIf(v, op==OP_Last);    testcase( op==OP_Last );
2014       VdbeCoverageIf(v, op==OP_SeekGT);  testcase( op==OP_SeekGT );
2015       VdbeCoverageIf(v, op==OP_SeekGE);  testcase( op==OP_SeekGE );
2016       VdbeCoverageIf(v, op==OP_SeekLE);  testcase( op==OP_SeekLE );
2017       VdbeCoverageIf(v, op==OP_SeekLT);  testcase( op==OP_SeekLT );
2018 
2019       assert( bSeekPastNull==0 || bStopAtNull==0 );
2020       if( regBignull ){
2021         assert( bSeekPastNull==1 || bStopAtNull==1 );
2022         assert( bSeekPastNull==!bStopAtNull );
2023         assert( bStopAtNull==startEq );
2024         sqlite3VdbeAddOp2(v, OP_Goto, 0, sqlite3VdbeCurrentAddr(v)+2);
2025         op = aStartOp[(nConstraint>1)*4 + 2 + bRev];
2026         sqlite3VdbeAddOp4Int(v, op, iIdxCur, addrNxt, regBase,
2027                              nConstraint-startEq);
2028         VdbeCoverage(v);
2029         VdbeCoverageIf(v, op==OP_Rewind);  testcase( op==OP_Rewind );
2030         VdbeCoverageIf(v, op==OP_Last);    testcase( op==OP_Last );
2031         VdbeCoverageIf(v, op==OP_SeekGE);  testcase( op==OP_SeekGE );
2032         VdbeCoverageIf(v, op==OP_SeekLE);  testcase( op==OP_SeekLE );
2033         assert( op==OP_Rewind || op==OP_Last || op==OP_SeekGE || op==OP_SeekLE);
2034       }
2035     }
2036 
2037     /* Load the value for the inequality constraint at the end of the
2038     ** range (if any).
2039     */
2040     nConstraint = nEq;
2041     assert( pLevel->p2==0 );
2042     if( pRangeEnd ){
2043       Expr *pRight = pRangeEnd->pExpr->pRight;
2044       if( addrSeekScan ){
2045         /* For a seek-scan that has a range on the lowest term of the index,
2046         ** we have to make the top of the loop be code that sets the end
2047         ** condition of the range.  Otherwise, the OP_SeekScan might jump
2048         ** over that initialization, leaving the range-end value set to the
2049         ** range-start value, resulting in a wrong answer.
2050         ** See ticket 5981a8c041a3c2f3 (2021-11-02).
2051         */
2052         pLevel->p2 = sqlite3VdbeCurrentAddr(v);
2053       }
2054       codeExprOrVector(pParse, pRight, regBase+nEq, nTop);
2055       whereLikeOptimizationStringFixup(v, pLevel, pRangeEnd);
2056       if( (pRangeEnd->wtFlags & TERM_VNULL)==0
2057        && sqlite3ExprCanBeNull(pRight)
2058       ){
2059         sqlite3VdbeAddOp2(v, OP_IsNull, regBase+nEq, addrNxt);
2060         VdbeCoverage(v);
2061       }
2062       if( zEndAff ){
2063         updateRangeAffinityStr(pRight, nTop, zEndAff);
2064         codeApplyAffinity(pParse, regBase+nEq, nTop, zEndAff);
2065       }else{
2066         assert( pParse->db->mallocFailed );
2067       }
2068       nConstraint += nTop;
2069       testcase( pRangeEnd->wtFlags & TERM_VIRTUAL );
2070 
2071       if( sqlite3ExprIsVector(pRight)==0 ){
2072         disableTerm(pLevel, pRangeEnd);
2073       }else{
2074         endEq = 1;
2075       }
2076     }else if( bStopAtNull ){
2077       if( regBignull==0 ){
2078         sqlite3VdbeAddOp2(v, OP_Null, 0, regBase+nEq);
2079         endEq = 0;
2080       }
2081       nConstraint++;
2082     }
2083     sqlite3DbFree(db, zStartAff);
2084     sqlite3DbFree(db, zEndAff);
2085 
2086     /* Top of the loop body */
2087     if( pLevel->p2==0 ) pLevel->p2 = sqlite3VdbeCurrentAddr(v);
2088 
2089     /* Check if the index cursor is past the end of the range. */
2090     if( nConstraint ){
2091       if( regBignull ){
2092         /* Except, skip the end-of-range check while doing the NULL-scan */
2093         sqlite3VdbeAddOp2(v, OP_IfNot, regBignull, sqlite3VdbeCurrentAddr(v)+3);
2094         VdbeComment((v, "If NULL-scan 2nd pass"));
2095         VdbeCoverage(v);
2096       }
2097       op = aEndOp[bRev*2 + endEq];
2098       sqlite3VdbeAddOp4Int(v, op, iIdxCur, addrNxt, regBase, nConstraint);
2099       testcase( op==OP_IdxGT );  VdbeCoverageIf(v, op==OP_IdxGT );
2100       testcase( op==OP_IdxGE );  VdbeCoverageIf(v, op==OP_IdxGE );
2101       testcase( op==OP_IdxLT );  VdbeCoverageIf(v, op==OP_IdxLT );
2102       testcase( op==OP_IdxLE );  VdbeCoverageIf(v, op==OP_IdxLE );
2103       if( addrSeekScan ) sqlite3VdbeJumpHere(v, addrSeekScan);
2104     }
2105     if( regBignull ){
2106       /* During a NULL-scan, check to see if we have reached the end of
2107       ** the NULLs */
2108       assert( bSeekPastNull==!bStopAtNull );
2109       assert( bSeekPastNull+bStopAtNull==1 );
2110       assert( nConstraint+bSeekPastNull>0 );
2111       sqlite3VdbeAddOp2(v, OP_If, regBignull, sqlite3VdbeCurrentAddr(v)+2);
2112       VdbeComment((v, "If NULL-scan 1st pass"));
2113       VdbeCoverage(v);
2114       op = aEndOp[bRev*2 + bSeekPastNull];
2115       sqlite3VdbeAddOp4Int(v, op, iIdxCur, addrNxt, regBase,
2116                            nConstraint+bSeekPastNull);
2117       testcase( op==OP_IdxGT );  VdbeCoverageIf(v, op==OP_IdxGT );
2118       testcase( op==OP_IdxGE );  VdbeCoverageIf(v, op==OP_IdxGE );
2119       testcase( op==OP_IdxLT );  VdbeCoverageIf(v, op==OP_IdxLT );
2120       testcase( op==OP_IdxLE );  VdbeCoverageIf(v, op==OP_IdxLE );
2121     }
2122 
2123     if( (pLoop->wsFlags & WHERE_IN_EARLYOUT)!=0 ){
2124       sqlite3VdbeAddOp3(v, OP_SeekHit, iIdxCur, nEq, nEq);
2125     }
2126 
2127     /* Seek the table cursor, if required */
2128     omitTable = (pLoop->wsFlags & WHERE_IDX_ONLY)!=0
2129            && (pWInfo->wctrlFlags & WHERE_OR_SUBCLAUSE)==0;
2130     if( omitTable ){
2131       /* pIdx is a covering index.  No need to access the main table. */
2132     }else if( HasRowid(pIdx->pTable) ){
2133       codeDeferredSeek(pWInfo, pIdx, iCur, iIdxCur);
2134     }else if( iCur!=iIdxCur ){
2135       Index *pPk = sqlite3PrimaryKeyIndex(pIdx->pTable);
2136       iRowidReg = sqlite3GetTempRange(pParse, pPk->nKeyCol);
2137       for(j=0; j<pPk->nKeyCol; j++){
2138         k = sqlite3TableColumnToIndex(pIdx, pPk->aiColumn[j]);
2139         sqlite3VdbeAddOp3(v, OP_Column, iIdxCur, k, iRowidReg+j);
2140       }
2141       sqlite3VdbeAddOp4Int(v, OP_NotFound, iCur, addrCont,
2142                            iRowidReg, pPk->nKeyCol); VdbeCoverage(v);
2143     }
2144 
2145     if( pLevel->iLeftJoin==0 ){
2146       /* If pIdx is an index on one or more expressions, then look through
2147       ** all the expressions in pWInfo and try to transform matching expressions
2148       ** into reference to index columns.  Also attempt to translate references
2149       ** to virtual columns in the table into references to (stored) columns
2150       ** of the index.
2151       **
2152       ** Do not do this for the RHS of a LEFT JOIN. This is because the
2153       ** expression may be evaluated after OP_NullRow has been executed on
2154       ** the cursor. In this case it is important to do the full evaluation,
2155       ** as the result of the expression may not be NULL, even if all table
2156       ** column values are.  https://www.sqlite.org/src/info/7fa8049685b50b5a
2157       **
2158       ** Also, do not do this when processing one index an a multi-index
2159       ** OR clause, since the transformation will become invalid once we
2160       ** move forward to the next index.
2161       ** https://sqlite.org/src/info/4e8e4857d32d401f
2162       */
2163       if( (pWInfo->wctrlFlags & WHERE_OR_SUBCLAUSE)==0 ){
2164         whereIndexExprTrans(pIdx, iCur, iIdxCur, pWInfo);
2165       }
2166 
2167       /* If a partial index is driving the loop, try to eliminate WHERE clause
2168       ** terms from the query that must be true due to the WHERE clause of
2169       ** the partial index.
2170       **
2171       ** 2019-11-02 ticket 623eff57e76d45f6: This optimization does not work
2172       ** for a LEFT JOIN.
2173       */
2174       if( pIdx->pPartIdxWhere ){
2175         whereApplyPartialIndexConstraints(pIdx->pPartIdxWhere, iCur, pWC);
2176       }
2177     }else{
2178       testcase( pIdx->pPartIdxWhere );
2179       /* The following assert() is not a requirement, merely an observation:
2180       ** The OR-optimization doesn't work for the right hand table of
2181       ** a LEFT JOIN: */
2182       assert( (pWInfo->wctrlFlags & WHERE_OR_SUBCLAUSE)==0 );
2183     }
2184 
2185     /* Record the instruction used to terminate the loop. */
2186     if( pLoop->wsFlags & WHERE_ONEROW ){
2187       pLevel->op = OP_Noop;
2188     }else if( bRev ){
2189       pLevel->op = OP_Prev;
2190     }else{
2191       pLevel->op = OP_Next;
2192     }
2193     pLevel->p1 = iIdxCur;
2194     pLevel->p3 = (pLoop->wsFlags&WHERE_UNQ_WANTED)!=0 ? 1:0;
2195     if( (pLoop->wsFlags & WHERE_CONSTRAINT)==0 ){
2196       pLevel->p5 = SQLITE_STMTSTATUS_FULLSCAN_STEP;
2197     }else{
2198       assert( pLevel->p5==0 );
2199     }
2200     if( omitTable ) pIdx = 0;
2201   }else
2202 
2203 #ifndef SQLITE_OMIT_OR_OPTIMIZATION
2204   if( pLoop->wsFlags & WHERE_MULTI_OR ){
2205     /* Case 5:  Two or more separately indexed terms connected by OR
2206     **
2207     ** Example:
2208     **
2209     **   CREATE TABLE t1(a,b,c,d);
2210     **   CREATE INDEX i1 ON t1(a);
2211     **   CREATE INDEX i2 ON t1(b);
2212     **   CREATE INDEX i3 ON t1(c);
2213     **
2214     **   SELECT * FROM t1 WHERE a=5 OR b=7 OR (c=11 AND d=13)
2215     **
2216     ** In the example, there are three indexed terms connected by OR.
2217     ** The top of the loop looks like this:
2218     **
2219     **          Null       1                # Zero the rowset in reg 1
2220     **
2221     ** Then, for each indexed term, the following. The arguments to
2222     ** RowSetTest are such that the rowid of the current row is inserted
2223     ** into the RowSet. If it is already present, control skips the
2224     ** Gosub opcode and jumps straight to the code generated by WhereEnd().
2225     **
2226     **        sqlite3WhereBegin(<term>)
2227     **          RowSetTest                  # Insert rowid into rowset
2228     **          Gosub      2 A
2229     **        sqlite3WhereEnd()
2230     **
2231     ** Following the above, code to terminate the loop. Label A, the target
2232     ** of the Gosub above, jumps to the instruction right after the Goto.
2233     **
2234     **          Null       1                # Zero the rowset in reg 1
2235     **          Goto       B                # The loop is finished.
2236     **
2237     **       A: <loop body>                 # Return data, whatever.
2238     **
2239     **          Return     2                # Jump back to the Gosub
2240     **
2241     **       B: <after the loop>
2242     **
2243     ** Added 2014-05-26: If the table is a WITHOUT ROWID table, then
2244     ** use an ephemeral index instead of a RowSet to record the primary
2245     ** keys of the rows we have already seen.
2246     **
2247     */
2248     WhereClause *pOrWc;    /* The OR-clause broken out into subterms */
2249     SrcList *pOrTab;       /* Shortened table list or OR-clause generation */
2250     Index *pCov = 0;             /* Potential covering index (or NULL) */
2251     int iCovCur = pParse->nTab++;  /* Cursor used for index scans (if any) */
2252 
2253     int regReturn = ++pParse->nMem;           /* Register used with OP_Gosub */
2254     int regRowset = 0;                        /* Register for RowSet object */
2255     int regRowid = 0;                         /* Register holding rowid */
2256     int iLoopBody = sqlite3VdbeMakeLabel(pParse);/* Start of loop body */
2257     int iRetInit;                             /* Address of regReturn init */
2258     int untestedTerms = 0;             /* Some terms not completely tested */
2259     int ii;                            /* Loop counter */
2260     Expr *pAndExpr = 0;                /* An ".. AND (...)" expression */
2261     Table *pTab = pTabItem->pTab;
2262 
2263     pTerm = pLoop->aLTerm[0];
2264     assert( pTerm!=0 );
2265     assert( pTerm->eOperator & WO_OR );
2266     assert( (pTerm->wtFlags & TERM_ORINFO)!=0 );
2267     pOrWc = &pTerm->u.pOrInfo->wc;
2268     pLevel->op = OP_Return;
2269     pLevel->p1 = regReturn;
2270 
2271     /* Set up a new SrcList in pOrTab containing the table being scanned
2272     ** by this loop in the a[0] slot and all notReady tables in a[1..] slots.
2273     ** This becomes the SrcList in the recursive call to sqlite3WhereBegin().
2274     */
2275     if( pWInfo->nLevel>1 ){
2276       int nNotReady;                 /* The number of notReady tables */
2277       SrcItem *origSrc;              /* Original list of tables */
2278       nNotReady = pWInfo->nLevel - iLevel - 1;
2279       pOrTab = sqlite3StackAllocRaw(db,
2280                             sizeof(*pOrTab)+ nNotReady*sizeof(pOrTab->a[0]));
2281       if( pOrTab==0 ) return notReady;
2282       pOrTab->nAlloc = (u8)(nNotReady + 1);
2283       pOrTab->nSrc = pOrTab->nAlloc;
2284       memcpy(pOrTab->a, pTabItem, sizeof(*pTabItem));
2285       origSrc = pWInfo->pTabList->a;
2286       for(k=1; k<=nNotReady; k++){
2287         memcpy(&pOrTab->a[k], &origSrc[pLevel[k].iFrom], sizeof(pOrTab->a[k]));
2288       }
2289     }else{
2290       pOrTab = pWInfo->pTabList;
2291     }
2292 
2293     /* Initialize the rowset register to contain NULL. An SQL NULL is
2294     ** equivalent to an empty rowset.  Or, create an ephemeral index
2295     ** capable of holding primary keys in the case of a WITHOUT ROWID.
2296     **
2297     ** Also initialize regReturn to contain the address of the instruction
2298     ** immediately following the OP_Return at the bottom of the loop. This
2299     ** is required in a few obscure LEFT JOIN cases where control jumps
2300     ** over the top of the loop into the body of it. In this case the
2301     ** correct response for the end-of-loop code (the OP_Return) is to
2302     ** fall through to the next instruction, just as an OP_Next does if
2303     ** called on an uninitialized cursor.
2304     */
2305     if( (pWInfo->wctrlFlags & WHERE_DUPLICATES_OK)==0 ){
2306       if( HasRowid(pTab) ){
2307         regRowset = ++pParse->nMem;
2308         sqlite3VdbeAddOp2(v, OP_Null, 0, regRowset);
2309       }else{
2310         Index *pPk = sqlite3PrimaryKeyIndex(pTab);
2311         regRowset = pParse->nTab++;
2312         sqlite3VdbeAddOp2(v, OP_OpenEphemeral, regRowset, pPk->nKeyCol);
2313         sqlite3VdbeSetP4KeyInfo(pParse, pPk);
2314       }
2315       regRowid = ++pParse->nMem;
2316     }
2317     iRetInit = sqlite3VdbeAddOp2(v, OP_Integer, 0, regReturn);
2318 
2319     /* If the original WHERE clause is z of the form:  (x1 OR x2 OR ...) AND y
2320     ** Then for every term xN, evaluate as the subexpression: xN AND z
2321     ** That way, terms in y that are factored into the disjunction will
2322     ** be picked up by the recursive calls to sqlite3WhereBegin() below.
2323     **
2324     ** Actually, each subexpression is converted to "xN AND w" where w is
2325     ** the "interesting" terms of z - terms that did not originate in the
2326     ** ON or USING clause of a LEFT JOIN, and terms that are usable as
2327     ** indices.
2328     **
2329     ** This optimization also only applies if the (x1 OR x2 OR ...) term
2330     ** is not contained in the ON clause of a LEFT JOIN.
2331     ** See ticket http://www.sqlite.org/src/info/f2369304e4
2332     */
2333     if( pWC->nTerm>1 ){
2334       int iTerm;
2335       for(iTerm=0; iTerm<pWC->nTerm; iTerm++){
2336         Expr *pExpr = pWC->a[iTerm].pExpr;
2337         if( &pWC->a[iTerm] == pTerm ) continue;
2338         testcase( pWC->a[iTerm].wtFlags & TERM_VIRTUAL );
2339         testcase( pWC->a[iTerm].wtFlags & TERM_CODED );
2340         if( (pWC->a[iTerm].wtFlags & (TERM_VIRTUAL|TERM_CODED))!=0 ) continue;
2341         if( (pWC->a[iTerm].eOperator & WO_ALL)==0 ) continue;
2342         testcase( pWC->a[iTerm].wtFlags & TERM_ORINFO );
2343         pExpr = sqlite3ExprDup(db, pExpr, 0);
2344         pAndExpr = sqlite3ExprAnd(pParse, pAndExpr, pExpr);
2345       }
2346       if( pAndExpr ){
2347         /* The extra 0x10000 bit on the opcode is masked off and does not
2348         ** become part of the new Expr.op.  However, it does make the
2349         ** op==TK_AND comparison inside of sqlite3PExpr() false, and this
2350         ** prevents sqlite3PExpr() from applying the AND short-circuit
2351         ** optimization, which we do not want here. */
2352         pAndExpr = sqlite3PExpr(pParse, TK_AND|0x10000, 0, pAndExpr);
2353       }
2354     }
2355 
2356     /* Run a separate WHERE clause for each term of the OR clause.  After
2357     ** eliminating duplicates from other WHERE clauses, the action for each
2358     ** sub-WHERE clause is to to invoke the main loop body as a subroutine.
2359     */
2360     ExplainQueryPlan((pParse, 1, "MULTI-INDEX OR"));
2361     for(ii=0; ii<pOrWc->nTerm; ii++){
2362       WhereTerm *pOrTerm = &pOrWc->a[ii];
2363       if( pOrTerm->leftCursor==iCur || (pOrTerm->eOperator & WO_AND)!=0 ){
2364         WhereInfo *pSubWInfo;           /* Info for single OR-term scan */
2365         Expr *pOrExpr = pOrTerm->pExpr; /* Current OR clause term */
2366         Expr *pDelete;                  /* Local copy of OR clause term */
2367         int jmp1 = 0;                   /* Address of jump operation */
2368         testcase( (pTabItem[0].fg.jointype & JT_LEFT)!=0
2369                && !ExprHasProperty(pOrExpr, EP_FromJoin)
2370         ); /* See TH3 vtab25.400 and ticket 614b25314c766238 */
2371         pDelete = pOrExpr = sqlite3ExprDup(db, pOrExpr, 0);
2372         if( db->mallocFailed ){
2373           sqlite3ExprDelete(db, pDelete);
2374           continue;
2375         }
2376         if( pAndExpr ){
2377           pAndExpr->pLeft = pOrExpr;
2378           pOrExpr = pAndExpr;
2379         }
2380         /* Loop through table entries that match term pOrTerm. */
2381         ExplainQueryPlan((pParse, 1, "INDEX %d", ii+1));
2382         WHERETRACE(0xffff, ("Subplan for OR-clause:\n"));
2383         pSubWInfo = sqlite3WhereBegin(pParse, pOrTab, pOrExpr, 0, 0, 0,
2384                                       WHERE_OR_SUBCLAUSE, iCovCur);
2385         assert( pSubWInfo || pParse->nErr );
2386         if( pSubWInfo ){
2387           WhereLoop *pSubLoop;
2388           int addrExplain = sqlite3WhereExplainOneScan(
2389               pParse, pOrTab, &pSubWInfo->a[0], 0
2390           );
2391           sqlite3WhereAddScanStatus(v, pOrTab, &pSubWInfo->a[0], addrExplain);
2392 
2393           /* This is the sub-WHERE clause body.  First skip over
2394           ** duplicate rows from prior sub-WHERE clauses, and record the
2395           ** rowid (or PRIMARY KEY) for the current row so that the same
2396           ** row will be skipped in subsequent sub-WHERE clauses.
2397           */
2398           if( (pWInfo->wctrlFlags & WHERE_DUPLICATES_OK)==0 ){
2399             int iSet = ((ii==pOrWc->nTerm-1)?-1:ii);
2400             if( HasRowid(pTab) ){
2401               sqlite3ExprCodeGetColumnOfTable(v, pTab, iCur, -1, regRowid);
2402               jmp1 = sqlite3VdbeAddOp4Int(v, OP_RowSetTest, regRowset, 0,
2403                                           regRowid, iSet);
2404               VdbeCoverage(v);
2405             }else{
2406               Index *pPk = sqlite3PrimaryKeyIndex(pTab);
2407               int nPk = pPk->nKeyCol;
2408               int iPk;
2409               int r;
2410 
2411               /* Read the PK into an array of temp registers. */
2412               r = sqlite3GetTempRange(pParse, nPk);
2413               for(iPk=0; iPk<nPk; iPk++){
2414                 int iCol = pPk->aiColumn[iPk];
2415                 sqlite3ExprCodeGetColumnOfTable(v, pTab, iCur, iCol,r+iPk);
2416               }
2417 
2418               /* Check if the temp table already contains this key. If so,
2419               ** the row has already been included in the result set and
2420               ** can be ignored (by jumping past the Gosub below). Otherwise,
2421               ** insert the key into the temp table and proceed with processing
2422               ** the row.
2423               **
2424               ** Use some of the same optimizations as OP_RowSetTest: If iSet
2425               ** is zero, assume that the key cannot already be present in
2426               ** the temp table. And if iSet is -1, assume that there is no
2427               ** need to insert the key into the temp table, as it will never
2428               ** be tested for.  */
2429               if( iSet ){
2430                 jmp1 = sqlite3VdbeAddOp4Int(v, OP_Found, regRowset, 0, r, nPk);
2431                 VdbeCoverage(v);
2432               }
2433               if( iSet>=0 ){
2434                 sqlite3VdbeAddOp3(v, OP_MakeRecord, r, nPk, regRowid);
2435                 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, regRowset, regRowid,
2436                                      r, nPk);
2437                 if( iSet ) sqlite3VdbeChangeP5(v, OPFLAG_USESEEKRESULT);
2438               }
2439 
2440               /* Release the array of temp registers */
2441               sqlite3ReleaseTempRange(pParse, r, nPk);
2442             }
2443           }
2444 
2445           /* Invoke the main loop body as a subroutine */
2446           sqlite3VdbeAddOp2(v, OP_Gosub, regReturn, iLoopBody);
2447 
2448           /* Jump here (skipping the main loop body subroutine) if the
2449           ** current sub-WHERE row is a duplicate from prior sub-WHEREs. */
2450           if( jmp1 ) sqlite3VdbeJumpHere(v, jmp1);
2451 
2452           /* The pSubWInfo->untestedTerms flag means that this OR term
2453           ** contained one or more AND term from a notReady table.  The
2454           ** terms from the notReady table could not be tested and will
2455           ** need to be tested later.
2456           */
2457           if( pSubWInfo->untestedTerms ) untestedTerms = 1;
2458 
2459           /* If all of the OR-connected terms are optimized using the same
2460           ** index, and the index is opened using the same cursor number
2461           ** by each call to sqlite3WhereBegin() made by this loop, it may
2462           ** be possible to use that index as a covering index.
2463           **
2464           ** If the call to sqlite3WhereBegin() above resulted in a scan that
2465           ** uses an index, and this is either the first OR-connected term
2466           ** processed or the index is the same as that used by all previous
2467           ** terms, set pCov to the candidate covering index. Otherwise, set
2468           ** pCov to NULL to indicate that no candidate covering index will
2469           ** be available.
2470           */
2471           pSubLoop = pSubWInfo->a[0].pWLoop;
2472           assert( (pSubLoop->wsFlags & WHERE_AUTO_INDEX)==0 );
2473           if( (pSubLoop->wsFlags & WHERE_INDEXED)!=0
2474            && (ii==0 || pSubLoop->u.btree.pIndex==pCov)
2475            && (HasRowid(pTab) || !IsPrimaryKeyIndex(pSubLoop->u.btree.pIndex))
2476           ){
2477             assert( pSubWInfo->a[0].iIdxCur==iCovCur );
2478             pCov = pSubLoop->u.btree.pIndex;
2479           }else{
2480             pCov = 0;
2481           }
2482           if( sqlite3WhereUsesDeferredSeek(pSubWInfo) ){
2483             pWInfo->bDeferredSeek = 1;
2484           }
2485 
2486           /* Finish the loop through table entries that match term pOrTerm. */
2487           sqlite3WhereEnd(pSubWInfo);
2488           ExplainQueryPlanPop(pParse);
2489         }
2490         sqlite3ExprDelete(db, pDelete);
2491       }
2492     }
2493     ExplainQueryPlanPop(pParse);
2494     assert( pLevel->pWLoop==pLoop );
2495     assert( (pLoop->wsFlags & WHERE_MULTI_OR)!=0 );
2496     assert( (pLoop->wsFlags & WHERE_IN_ABLE)==0 );
2497     pLevel->u.pCoveringIdx = pCov;
2498     if( pCov ) pLevel->iIdxCur = iCovCur;
2499     if( pAndExpr ){
2500       pAndExpr->pLeft = 0;
2501       sqlite3ExprDelete(db, pAndExpr);
2502     }
2503     sqlite3VdbeChangeP1(v, iRetInit, sqlite3VdbeCurrentAddr(v));
2504     sqlite3VdbeGoto(v, pLevel->addrBrk);
2505     sqlite3VdbeResolveLabel(v, iLoopBody);
2506 
2507     if( pWInfo->nLevel>1 ){ sqlite3StackFree(db, pOrTab); }
2508     if( !untestedTerms ) disableTerm(pLevel, pTerm);
2509   }else
2510 #endif /* SQLITE_OMIT_OR_OPTIMIZATION */
2511 
2512   {
2513     /* Case 6:  There is no usable index.  We must do a complete
2514     **          scan of the entire table.
2515     */
2516     static const u8 aStep[] = { OP_Next, OP_Prev };
2517     static const u8 aStart[] = { OP_Rewind, OP_Last };
2518     assert( bRev==0 || bRev==1 );
2519     if( pTabItem->fg.isRecursive ){
2520       /* Tables marked isRecursive have only a single row that is stored in
2521       ** a pseudo-cursor.  No need to Rewind or Next such cursors. */
2522       pLevel->op = OP_Noop;
2523     }else{
2524       codeCursorHint(pTabItem, pWInfo, pLevel, 0);
2525       pLevel->op = aStep[bRev];
2526       pLevel->p1 = iCur;
2527       pLevel->p2 = 1 + sqlite3VdbeAddOp2(v, aStart[bRev], iCur, addrHalt);
2528       VdbeCoverageIf(v, bRev==0);
2529       VdbeCoverageIf(v, bRev!=0);
2530       pLevel->p5 = SQLITE_STMTSTATUS_FULLSCAN_STEP;
2531     }
2532   }
2533 
2534 #ifdef SQLITE_ENABLE_STMT_SCANSTATUS
2535   pLevel->addrVisit = sqlite3VdbeCurrentAddr(v);
2536 #endif
2537 
2538   /* Insert code to test every subexpression that can be completely
2539   ** computed using the current set of tables.
2540   **
2541   ** This loop may run between one and three times, depending on the
2542   ** constraints to be generated. The value of stack variable iLoop
2543   ** determines the constraints coded by each iteration, as follows:
2544   **
2545   ** iLoop==1: Code only expressions that are entirely covered by pIdx.
2546   ** iLoop==2: Code remaining expressions that do not contain correlated
2547   **           sub-queries.
2548   ** iLoop==3: Code all remaining expressions.
2549   **
2550   ** An effort is made to skip unnecessary iterations of the loop.
2551   */
2552   iLoop = (pIdx ? 1 : 2);
2553   do{
2554     int iNext = 0;                /* Next value for iLoop */
2555     for(pTerm=pWC->a, j=pWC->nTerm; j>0; j--, pTerm++){
2556       Expr *pE;
2557       int skipLikeAddr = 0;
2558       testcase( pTerm->wtFlags & TERM_VIRTUAL );
2559       testcase( pTerm->wtFlags & TERM_CODED );
2560       if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
2561       if( (pTerm->prereqAll & pLevel->notReady)!=0 ){
2562         testcase( pWInfo->untestedTerms==0
2563             && (pWInfo->wctrlFlags & WHERE_OR_SUBCLAUSE)!=0 );
2564         pWInfo->untestedTerms = 1;
2565         continue;
2566       }
2567       pE = pTerm->pExpr;
2568       assert( pE!=0 );
2569       if( (pTabItem->fg.jointype&JT_LEFT) && !ExprHasProperty(pE,EP_FromJoin) ){
2570         continue;
2571       }
2572 
2573       if( iLoop==1 && !sqlite3ExprCoveredByIndex(pE, pLevel->iTabCur, pIdx) ){
2574         iNext = 2;
2575         continue;
2576       }
2577       if( iLoop<3 && (pTerm->wtFlags & TERM_VARSELECT) ){
2578         if( iNext==0 ) iNext = 3;
2579         continue;
2580       }
2581 
2582       if( (pTerm->wtFlags & TERM_LIKECOND)!=0 ){
2583         /* If the TERM_LIKECOND flag is set, that means that the range search
2584         ** is sufficient to guarantee that the LIKE operator is true, so we
2585         ** can skip the call to the like(A,B) function.  But this only works
2586         ** for strings.  So do not skip the call to the function on the pass
2587         ** that compares BLOBs. */
2588 #ifdef SQLITE_LIKE_DOESNT_MATCH_BLOBS
2589         continue;
2590 #else
2591         u32 x = pLevel->iLikeRepCntr;
2592         if( x>0 ){
2593           skipLikeAddr = sqlite3VdbeAddOp1(v, (x&1)?OP_IfNot:OP_If,(int)(x>>1));
2594           VdbeCoverageIf(v, (x&1)==1);
2595           VdbeCoverageIf(v, (x&1)==0);
2596         }
2597 #endif
2598       }
2599 #ifdef WHERETRACE_ENABLED /* 0xffff */
2600       if( sqlite3WhereTrace ){
2601         VdbeNoopComment((v, "WhereTerm[%d] (%p) priority=%d",
2602                          pWC->nTerm-j, pTerm, iLoop));
2603       }
2604       if( sqlite3WhereTrace & 0x800 ){
2605         sqlite3DebugPrintf("Coding auxiliary constraint:\n");
2606         sqlite3WhereTermPrint(pTerm, pWC->nTerm-j);
2607       }
2608 #endif
2609       sqlite3ExprIfFalse(pParse, pE, addrCont, SQLITE_JUMPIFNULL);
2610       if( skipLikeAddr ) sqlite3VdbeJumpHere(v, skipLikeAddr);
2611       pTerm->wtFlags |= TERM_CODED;
2612     }
2613     iLoop = iNext;
2614   }while( iLoop>0 );
2615 
2616   /* Insert code to test for implied constraints based on transitivity
2617   ** of the "==" operator.
2618   **
2619   ** Example: If the WHERE clause contains "t1.a=t2.b" and "t2.b=123"
2620   ** and we are coding the t1 loop and the t2 loop has not yet coded,
2621   ** then we cannot use the "t1.a=t2.b" constraint, but we can code
2622   ** the implied "t1.a=123" constraint.
2623   */
2624   for(pTerm=pWC->a, j=pWC->nBase; j>0; j--, pTerm++){
2625     Expr *pE, sEAlt;
2626     WhereTerm *pAlt;
2627     if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
2628     if( (pTerm->eOperator & (WO_EQ|WO_IS))==0 ) continue;
2629     if( (pTerm->eOperator & WO_EQUIV)==0 ) continue;
2630     if( pTerm->leftCursor!=iCur ) continue;
2631     if( pTabItem->fg.jointype & JT_LEFT ) continue;
2632     pE = pTerm->pExpr;
2633 #ifdef WHERETRACE_ENABLED /* 0x800 */
2634     if( sqlite3WhereTrace & 0x800 ){
2635       sqlite3DebugPrintf("Coding transitive constraint:\n");
2636       sqlite3WhereTermPrint(pTerm, pWC->nTerm-j);
2637     }
2638 #endif
2639     assert( !ExprHasProperty(pE, EP_FromJoin) );
2640     assert( (pTerm->prereqRight & pLevel->notReady)!=0 );
2641     assert( (pTerm->eOperator & (WO_OR|WO_AND))==0 );
2642     pAlt = sqlite3WhereFindTerm(pWC, iCur, pTerm->u.x.leftColumn, notReady,
2643                     WO_EQ|WO_IN|WO_IS, 0);
2644     if( pAlt==0 ) continue;
2645     if( pAlt->wtFlags & (TERM_CODED) ) continue;
2646     if( (pAlt->eOperator & WO_IN)
2647      && ExprUseXSelect(pAlt->pExpr)
2648      && (pAlt->pExpr->x.pSelect->pEList->nExpr>1)
2649     ){
2650       continue;
2651     }
2652     testcase( pAlt->eOperator & WO_EQ );
2653     testcase( pAlt->eOperator & WO_IS );
2654     testcase( pAlt->eOperator & WO_IN );
2655     VdbeModuleComment((v, "begin transitive constraint"));
2656     sEAlt = *pAlt->pExpr;
2657     sEAlt.pLeft = pE->pLeft;
2658     sqlite3ExprIfFalse(pParse, &sEAlt, addrCont, SQLITE_JUMPIFNULL);
2659     pAlt->wtFlags |= TERM_CODED;
2660   }
2661 
2662   /* For a LEFT OUTER JOIN, generate code that will record the fact that
2663   ** at least one row of the right table has matched the left table.
2664   */
2665   if( pLevel->iLeftJoin ){
2666     pLevel->addrFirst = sqlite3VdbeCurrentAddr(v);
2667     sqlite3VdbeAddOp2(v, OP_Integer, 1, pLevel->iLeftJoin);
2668     VdbeComment((v, "record LEFT JOIN hit"));
2669     for(pTerm=pWC->a, j=0; j<pWC->nBase; j++, pTerm++){
2670       testcase( pTerm->wtFlags & TERM_VIRTUAL );
2671       testcase( pTerm->wtFlags & TERM_CODED );
2672       if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
2673       if( (pTerm->prereqAll & pLevel->notReady)!=0 ){
2674         assert( pWInfo->untestedTerms );
2675         continue;
2676       }
2677       assert( pTerm->pExpr );
2678       sqlite3ExprIfFalse(pParse, pTerm->pExpr, addrCont, SQLITE_JUMPIFNULL);
2679       pTerm->wtFlags |= TERM_CODED;
2680     }
2681   }
2682 
2683 #if WHERETRACE_ENABLED /* 0x20800 */
2684   if( sqlite3WhereTrace & 0x20000 ){
2685     sqlite3DebugPrintf("All WHERE-clause terms after coding level %d:\n",
2686                        iLevel);
2687     sqlite3WhereClausePrint(pWC);
2688   }
2689   if( sqlite3WhereTrace & 0x800 ){
2690     sqlite3DebugPrintf("End Coding level %d:  notReady=%llx\n",
2691        iLevel, (u64)pLevel->notReady);
2692   }
2693 #endif
2694   return pLevel->notReady;
2695 }
2696