blob: 2fbcba17e93e42c697bafe458dcc9e8c416fc030 [file] [log] [blame]
drh6f82e852015-06-06 20:12:09 +00001/*
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
dan1d9bc9b2016-08-08 18:42:08 +000024
25/*
26** Return the name of the i-th column of the pIdx index.
27*/
28static 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].zName;
33}
34
drh6f82e852015-06-06 20:12:09 +000035/*
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*/
43static void explainAppendTerm(
44 StrAccum *pStr, /* The text expression being built */
dan1d9bc9b2016-08-08 18:42:08 +000045 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 " */
drh6f82e852015-06-06 20:12:09 +000049 const char *zOp /* Name of the operator */
50){
dan1d9bc9b2016-08-08 18:42:08 +000051 int i;
drh6f82e852015-06-06 20:12:09 +000052
dan1d9bc9b2016-08-08 18:42:08 +000053 assert( nTerm>=1 );
drh0cdbe1a2018-05-09 13:46:26 +000054 if( bAnd ) sqlite3_str_append(pStr, " AND ", 5);
dan1d9bc9b2016-08-08 18:42:08 +000055
drh0cdbe1a2018-05-09 13:46:26 +000056 if( nTerm>1 ) sqlite3_str_append(pStr, "(", 1);
dan1d9bc9b2016-08-08 18:42:08 +000057 for(i=0; i<nTerm; i++){
drh0cdbe1a2018-05-09 13:46:26 +000058 if( i ) sqlite3_str_append(pStr, ",", 1);
59 sqlite3_str_appendall(pStr, explainIndexColumnName(pIdx, iTerm+i));
dan1d9bc9b2016-08-08 18:42:08 +000060 }
drh0cdbe1a2018-05-09 13:46:26 +000061 if( nTerm>1 ) sqlite3_str_append(pStr, ")", 1);
dan1d9bc9b2016-08-08 18:42:08 +000062
drh0cdbe1a2018-05-09 13:46:26 +000063 sqlite3_str_append(pStr, zOp, 1);
dan1d9bc9b2016-08-08 18:42:08 +000064
drh0cdbe1a2018-05-09 13:46:26 +000065 if( nTerm>1 ) sqlite3_str_append(pStr, "(", 1);
dan1d9bc9b2016-08-08 18:42:08 +000066 for(i=0; i<nTerm; i++){
drh0cdbe1a2018-05-09 13:46:26 +000067 if( i ) sqlite3_str_append(pStr, ",", 1);
68 sqlite3_str_append(pStr, "?", 1);
dan1d9bc9b2016-08-08 18:42:08 +000069 }
drh0cdbe1a2018-05-09 13:46:26 +000070 if( nTerm>1 ) sqlite3_str_append(pStr, ")", 1);
drhc7c46802015-08-27 20:33:38 +000071}
72
73/*
drh6f82e852015-06-06 20:12:09 +000074** 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*/
drh8faee872015-09-19 18:08:13 +000087static void explainIndexRange(StrAccum *pStr, WhereLoop *pLoop){
drh6f82e852015-06-06 20:12:09 +000088 Index *pIndex = pLoop->u.btree.pIndex;
89 u16 nEq = pLoop->u.btree.nEq;
90 u16 nSkip = pLoop->nSkip;
91 int i, j;
drh6f82e852015-06-06 20:12:09 +000092
93 if( nEq==0 && (pLoop->wsFlags&(WHERE_BTM_LIMIT|WHERE_TOP_LIMIT))==0 ) return;
drh0cdbe1a2018-05-09 13:46:26 +000094 sqlite3_str_append(pStr, " (", 2);
drh6f82e852015-06-06 20:12:09 +000095 for(i=0; i<nEq; i++){
drhc7c46802015-08-27 20:33:38 +000096 const char *z = explainIndexColumnName(pIndex, i);
drh0cdbe1a2018-05-09 13:46:26 +000097 if( i ) sqlite3_str_append(pStr, " AND ", 5);
98 sqlite3_str_appendf(pStr, i>=nSkip ? "%s=?" : "ANY(%s)", z);
drh6f82e852015-06-06 20:12:09 +000099 }
100
101 j = i;
102 if( pLoop->wsFlags&WHERE_BTM_LIMIT ){
dan1d9bc9b2016-08-08 18:42:08 +0000103 explainAppendTerm(pStr, pIndex, pLoop->u.btree.nBtm, j, i, ">");
104 i = 1;
drh6f82e852015-06-06 20:12:09 +0000105 }
106 if( pLoop->wsFlags&WHERE_TOP_LIMIT ){
dan1d9bc9b2016-08-08 18:42:08 +0000107 explainAppendTerm(pStr, pIndex, pLoop->u.btree.nTop, j, i, "<");
drh6f82e852015-06-06 20:12:09 +0000108 }
drh0cdbe1a2018-05-09 13:46:26 +0000109 sqlite3_str_append(pStr, ")", 1);
drh6f82e852015-06-06 20:12:09 +0000110}
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*/
121int 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 */
drh6f82e852015-06-06 20:12:09 +0000125 u16 wctrlFlags /* Flags passed to sqlite3WhereBegin() */
126){
127 int ret = 0;
128#if !defined(SQLITE_DEBUG) && !defined(SQLITE_ENABLE_STMT_SCANSTATUS)
drhef7231b2017-12-21 21:41:13 +0000129 if( sqlite3ParseToplevel(pParse)->explain==2 )
drh6f82e852015-06-06 20:12:09 +0000130#endif
131 {
132 struct SrcList_item *pItem = &pTabList->a[pLevel->iFrom];
133 Vdbe *v = pParse->pVdbe; /* VM being constructed */
134 sqlite3 *db = pParse->db; /* Database handle */
drh6f82e852015-06-06 20:12:09 +0000135 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;
drhce943bc2016-05-19 18:56:33 +0000144 if( (flags&WHERE_MULTI_OR) || (wctrlFlags&WHERE_OR_SUBCLAUSE) ) return 0;
drh6f82e852015-06-06 20:12:09 +0000145
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);
drh0cdbe1a2018-05-09 13:46:26 +0000151 sqlite3_str_appendall(&str, isSearch ? "SEARCH" : "SCAN");
drh6f82e852015-06-06 20:12:09 +0000152 if( pItem->pSelect ){
drhfef37762018-07-10 19:48:35 +0000153 sqlite3_str_appendf(&str, " SUBQUERY %u", pItem->pSelect->selId);
drh6f82e852015-06-06 20:12:09 +0000154 }else{
drh0cdbe1a2018-05-09 13:46:26 +0000155 sqlite3_str_appendf(&str, " TABLE %s", pItem->zName);
drh6f82e852015-06-06 20:12:09 +0000156 }
157
158 if( pItem->zAlias ){
drh0cdbe1a2018-05-09 13:46:26 +0000159 sqlite3_str_appendf(&str, " AS %s", pItem->zAlias);
drh6f82e852015-06-06 20:12:09 +0000160 }
161 if( (flags & (WHERE_IPK|WHERE_VIRTUALTABLE))==0 ){
162 const char *zFmt = 0;
163 Index *pIdx;
164
165 assert( pLoop->u.btree.pIndex!=0 );
166 pIdx = pLoop->u.btree.pIndex;
167 assert( !(flags&WHERE_AUTO_INDEX) || (flags&WHERE_IDX_ONLY) );
168 if( !HasRowid(pItem->pTab) && IsPrimaryKeyIndex(pIdx) ){
169 if( isSearch ){
170 zFmt = "PRIMARY KEY";
171 }
172 }else if( flags & WHERE_PARTIALIDX ){
173 zFmt = "AUTOMATIC PARTIAL COVERING INDEX";
174 }else if( flags & WHERE_AUTO_INDEX ){
175 zFmt = "AUTOMATIC COVERING INDEX";
176 }else if( flags & WHERE_IDX_ONLY ){
177 zFmt = "COVERING INDEX %s";
178 }else{
179 zFmt = "INDEX %s";
180 }
181 if( zFmt ){
drh0cdbe1a2018-05-09 13:46:26 +0000182 sqlite3_str_append(&str, " USING ", 7);
183 sqlite3_str_appendf(&str, zFmt, pIdx->zName);
drh8faee872015-09-19 18:08:13 +0000184 explainIndexRange(&str, pLoop);
drh6f82e852015-06-06 20:12:09 +0000185 }
186 }else if( (flags & WHERE_IPK)!=0 && (flags & WHERE_CONSTRAINT)!=0 ){
drhd37bea52015-09-02 15:37:50 +0000187 const char *zRangeOp;
drh6f82e852015-06-06 20:12:09 +0000188 if( flags&(WHERE_COLUMN_EQ|WHERE_COLUMN_IN) ){
drhd37bea52015-09-02 15:37:50 +0000189 zRangeOp = "=";
drh6f82e852015-06-06 20:12:09 +0000190 }else if( (flags&WHERE_BOTH_LIMIT)==WHERE_BOTH_LIMIT ){
drhd37bea52015-09-02 15:37:50 +0000191 zRangeOp = ">? AND rowid<";
drh6f82e852015-06-06 20:12:09 +0000192 }else if( flags&WHERE_BTM_LIMIT ){
drhd37bea52015-09-02 15:37:50 +0000193 zRangeOp = ">";
drh6f82e852015-06-06 20:12:09 +0000194 }else{
195 assert( flags&WHERE_TOP_LIMIT);
drhd37bea52015-09-02 15:37:50 +0000196 zRangeOp = "<";
drh6f82e852015-06-06 20:12:09 +0000197 }
drh0cdbe1a2018-05-09 13:46:26 +0000198 sqlite3_str_appendf(&str,
199 " USING INTEGER PRIMARY KEY (rowid%s?)",zRangeOp);
drh6f82e852015-06-06 20:12:09 +0000200 }
201#ifndef SQLITE_OMIT_VIRTUALTABLE
202 else if( (flags & WHERE_VIRTUALTABLE)!=0 ){
drh0cdbe1a2018-05-09 13:46:26 +0000203 sqlite3_str_appendf(&str, " VIRTUAL TABLE INDEX %d:%s",
drh6f82e852015-06-06 20:12:09 +0000204 pLoop->u.vtab.idxNum, pLoop->u.vtab.idxStr);
205 }
206#endif
207#ifdef SQLITE_EXPLAIN_ESTIMATED_ROWS
208 if( pLoop->nOut>=10 ){
drh0cdbe1a2018-05-09 13:46:26 +0000209 sqlite3_str_appendf(&str, " (~%llu rows)",
210 sqlite3LogEstToInt(pLoop->nOut));
drh6f82e852015-06-06 20:12:09 +0000211 }else{
drh0cdbe1a2018-05-09 13:46:26 +0000212 sqlite3_str_append(&str, " (~1 row)", 9);
drh6f82e852015-06-06 20:12:09 +0000213 }
214#endif
215 zMsg = sqlite3StrAccumFinish(&str);
drhbd462bc2018-12-24 20:21:06 +0000216 sqlite3ExplainBreakpoint("",zMsg);
drhe2ca99c2018-05-02 00:33:43 +0000217 ret = sqlite3VdbeAddOp4(v, OP_Explain, sqlite3VdbeCurrentAddr(v),
218 pParse->addrExplain, 0, zMsg,P4_DYNAMIC);
drh6f82e852015-06-06 20:12:09 +0000219 }
220 return ret;
221}
222#endif /* SQLITE_OMIT_EXPLAIN */
223
224#ifdef SQLITE_ENABLE_STMT_SCANSTATUS
225/*
226** Configure the VM passed as the first argument with an
227** sqlite3_stmt_scanstatus() entry corresponding to the scan used to
228** implement level pLvl. Argument pSrclist is a pointer to the FROM
229** clause that the scan reads data from.
230**
231** If argument addrExplain is not 0, it must be the address of an
232** OP_Explain instruction that describes the same loop.
233*/
234void sqlite3WhereAddScanStatus(
235 Vdbe *v, /* Vdbe to add scanstatus entry to */
236 SrcList *pSrclist, /* FROM clause pLvl reads data from */
237 WhereLevel *pLvl, /* Level to add scanstatus() entry for */
238 int addrExplain /* Address of OP_Explain (or 0) */
239){
240 const char *zObj = 0;
241 WhereLoop *pLoop = pLvl->pWLoop;
242 if( (pLoop->wsFlags & WHERE_VIRTUALTABLE)==0 && pLoop->u.btree.pIndex!=0 ){
243 zObj = pLoop->u.btree.pIndex->zName;
244 }else{
245 zObj = pSrclist->a[pLvl->iFrom].zName;
246 }
247 sqlite3VdbeScanStatus(
248 v, addrExplain, pLvl->addrBody, pLvl->addrVisit, pLoop->nOut, zObj
249 );
250}
251#endif
252
253
254/*
255** Disable a term in the WHERE clause. Except, do not disable the term
256** if it controls a LEFT OUTER JOIN and it did not originate in the ON
257** or USING clause of that join.
258**
259** Consider the term t2.z='ok' in the following queries:
260**
261** (1) SELECT * FROM t1 LEFT JOIN t2 ON t1.a=t2.x WHERE t2.z='ok'
262** (2) SELECT * FROM t1 LEFT JOIN t2 ON t1.a=t2.x AND t2.z='ok'
263** (3) SELECT * FROM t1, t2 WHERE t1.a=t2.x AND t2.z='ok'
264**
265** The t2.z='ok' is disabled in the in (2) because it originates
266** in the ON clause. The term is disabled in (3) because it is not part
267** of a LEFT OUTER JOIN. In (1), the term is not disabled.
268**
269** Disabling a term causes that term to not be tested in the inner loop
270** of the join. Disabling is an optimization. When terms are satisfied
271** by indices, we disable them to prevent redundant tests in the inner
272** loop. We would get the correct results if nothing were ever disabled,
273** but joins might run a little slower. The trick is to disable as much
274** as we can without disabling too much. If we disabled in (1), we'd get
275** the wrong answer. See ticket #813.
276**
277** If all the children of a term are disabled, then that term is also
278** automatically disabled. In this way, terms get disabled if derived
279** virtual terms are tested first. For example:
280**
281** x GLOB 'abc*' AND x>='abc' AND x<'acd'
282** \___________/ \______/ \_____/
283** parent child1 child2
284**
285** Only the parent term was in the original WHERE clause. The child1
286** and child2 terms were added by the LIKE optimization. If both of
287** the virtual child terms are valid, then testing of the parent can be
288** skipped.
289**
290** Usually the parent term is marked as TERM_CODED. But if the parent
291** term was originally TERM_LIKE, then the parent gets TERM_LIKECOND instead.
292** The TERM_LIKECOND marking indicates that the term should be coded inside
293** a conditional such that is only evaluated on the second pass of a
294** LIKE-optimization loop, when scanning BLOBs instead of strings.
295*/
296static void disableTerm(WhereLevel *pLevel, WhereTerm *pTerm){
297 int nLoop = 0;
drh9d9c41e2017-10-31 03:40:15 +0000298 assert( pTerm!=0 );
299 while( (pTerm->wtFlags & TERM_CODED)==0
drh6f82e852015-06-06 20:12:09 +0000300 && (pLevel->iLeftJoin==0 || ExprHasProperty(pTerm->pExpr, EP_FromJoin))
301 && (pLevel->notReady & pTerm->prereqAll)==0
302 ){
303 if( nLoop && (pTerm->wtFlags & TERM_LIKE)!=0 ){
304 pTerm->wtFlags |= TERM_LIKECOND;
305 }else{
306 pTerm->wtFlags |= TERM_CODED;
307 }
308 if( pTerm->iParent<0 ) break;
309 pTerm = &pTerm->pWC->a[pTerm->iParent];
drh9d9c41e2017-10-31 03:40:15 +0000310 assert( pTerm!=0 );
drh6f82e852015-06-06 20:12:09 +0000311 pTerm->nChild--;
312 if( pTerm->nChild!=0 ) break;
313 nLoop++;
314 }
315}
316
317/*
318** Code an OP_Affinity opcode to apply the column affinity string zAff
319** to the n registers starting at base.
320**
drh96fb16e2019-08-06 14:37:24 +0000321** As an optimization, SQLITE_AFF_BLOB and SQLITE_AFF_NONE entries (which
322** are no-ops) at the beginning and end of zAff are ignored. If all entries
323** in zAff are SQLITE_AFF_BLOB or SQLITE_AFF_NONE, then no code gets generated.
drh6f82e852015-06-06 20:12:09 +0000324**
325** This routine makes its own copy of zAff so that the caller is free
326** to modify zAff after this routine returns.
327*/
328static void codeApplyAffinity(Parse *pParse, int base, int n, char *zAff){
329 Vdbe *v = pParse->pVdbe;
330 if( zAff==0 ){
331 assert( pParse->db->mallocFailed );
332 return;
333 }
334 assert( v!=0 );
335
drh96fb16e2019-08-06 14:37:24 +0000336 /* Adjust base and n to skip over SQLITE_AFF_BLOB and SQLITE_AFF_NONE
337 ** entries at the beginning and end of the affinity string.
drh6f82e852015-06-06 20:12:09 +0000338 */
drh96fb16e2019-08-06 14:37:24 +0000339 assert( SQLITE_AFF_NONE<SQLITE_AFF_BLOB );
340 while( n>0 && zAff[0]<=SQLITE_AFF_BLOB ){
drh6f82e852015-06-06 20:12:09 +0000341 n--;
342 base++;
343 zAff++;
344 }
drh96fb16e2019-08-06 14:37:24 +0000345 while( n>1 && zAff[n-1]<=SQLITE_AFF_BLOB ){
drh6f82e852015-06-06 20:12:09 +0000346 n--;
347 }
348
349 /* Code the OP_Affinity opcode if there is anything left to do. */
350 if( n>0 ){
drh9b34abe2016-01-16 15:12:35 +0000351 sqlite3VdbeAddOp4(v, OP_Affinity, base, n, 0, zAff, n);
drh6f82e852015-06-06 20:12:09 +0000352 }
353}
354
danb7ca2172016-08-26 17:54:46 +0000355/*
356** Expression pRight, which is the RHS of a comparison operation, is
357** either a vector of n elements or, if n==1, a scalar expression.
358** Before the comparison operation, affinity zAff is to be applied
359** to the pRight values. This function modifies characters within the
360** affinity string to SQLITE_AFF_BLOB if either:
361**
362** * the comparison will be performed with no affinity, or
363** * the affinity change in zAff is guaranteed not to change the value.
364*/
365static void updateRangeAffinityStr(
danb7ca2172016-08-26 17:54:46 +0000366 Expr *pRight, /* RHS of comparison */
367 int n, /* Number of vector elements in comparison */
368 char *zAff /* Affinity string to modify */
369){
370 int i;
371 for(i=0; i<n; i++){
372 Expr *p = sqlite3VectorFieldSubexpr(pRight, i);
373 if( sqlite3CompareAffinity(p, zAff[i])==SQLITE_AFF_BLOB
374 || sqlite3ExprNeedsNoAffinityChange(p, zAff[i])
375 ){
376 zAff[i] = SQLITE_AFF_BLOB;
377 }
378 }
379}
drh6f82e852015-06-06 20:12:09 +0000380
drh24102432017-11-17 21:01:04 +0000381
382/*
383** pX is an expression of the form: (vector) IN (SELECT ...)
384** In other words, it is a vector IN operator with a SELECT clause on the
385** LHS. But not all terms in the vector are indexable and the terms might
386** not be in the correct order for indexing.
drh9b1ecb62017-11-17 17:32:40 +0000387**
drh24102432017-11-17 21:01:04 +0000388** This routine makes a copy of the input pX expression and then adjusts
389** the vector on the LHS with corresponding changes to the SELECT so that
390** the vector contains only index terms and those terms are in the correct
391** order. The modified IN expression is returned. The caller is responsible
392** for deleting the returned expression.
393**
394** Example:
395**
396** CREATE TABLE t1(a,b,c,d,e,f);
397** CREATE INDEX t1x1 ON t1(e,c);
398** SELECT * FROM t1 WHERE (a,b,c,d,e) IN (SELECT v,w,x,y,z FROM t2)
399** \_______________________________________/
400** The pX expression
401**
402** Since only columns e and c can be used with the index, in that order,
403** the modified IN expression that is returned will be:
404**
405** (e,c) IN (SELECT z,x FROM t2)
406**
407** The reduced pX is different from the original (obviously) and thus is
408** only used for indexing, to improve performance. The original unaltered
409** IN expression must also be run on each output row for correctness.
drh9b1ecb62017-11-17 17:32:40 +0000410*/
drh24102432017-11-17 21:01:04 +0000411static Expr *removeUnindexableInClauseTerms(
412 Parse *pParse, /* The parsing context */
413 int iEq, /* Look at loop terms starting here */
414 WhereLoop *pLoop, /* The current loop */
415 Expr *pX /* The IN expression to be reduced */
416){
417 sqlite3 *db = pParse->db;
418 Expr *pNew = sqlite3ExprDup(db, pX, 0);
419 if( db->mallocFailed==0 ){
420 ExprList *pOrigRhs = pNew->x.pSelect->pEList; /* Original unmodified RHS */
421 ExprList *pOrigLhs = pNew->pLeft->x.pList; /* Original unmodified LHS */
422 ExprList *pRhs = 0; /* New RHS after modifications */
423 ExprList *pLhs = 0; /* New LHS after mods */
424 int i; /* Loop counter */
425 Select *pSelect; /* Pointer to the SELECT on the RHS */
426
427 for(i=iEq; i<pLoop->nLTerm; i++){
428 if( pLoop->aLTerm[i]->pExpr==pX ){
429 int iField = pLoop->aLTerm[i]->iField - 1;
drhc6e519f2018-11-03 13:11:24 +0000430 if( pOrigRhs->a[iField].pExpr==0 ) continue; /* Duplicate PK column */
drh24102432017-11-17 21:01:04 +0000431 pRhs = sqlite3ExprListAppend(pParse, pRhs, pOrigRhs->a[iField].pExpr);
432 pOrigRhs->a[iField].pExpr = 0;
433 assert( pOrigLhs->a[iField].pExpr!=0 );
434 pLhs = sqlite3ExprListAppend(pParse, pLhs, pOrigLhs->a[iField].pExpr);
435 pOrigLhs->a[iField].pExpr = 0;
436 }
drh9b1ecb62017-11-17 17:32:40 +0000437 }
drh24102432017-11-17 21:01:04 +0000438 sqlite3ExprListDelete(db, pOrigRhs);
439 sqlite3ExprListDelete(db, pOrigLhs);
440 pNew->pLeft->x.pList = pLhs;
441 pNew->x.pSelect->pEList = pRhs;
442 if( pLhs && pLhs->nExpr==1 ){
443 /* Take care here not to generate a TK_VECTOR containing only a
444 ** single value. Since the parser never creates such a vector, some
445 ** of the subroutines do not handle this case. */
446 Expr *p = pLhs->a[0].pExpr;
447 pLhs->a[0].pExpr = 0;
448 sqlite3ExprDelete(db, pNew->pLeft);
449 pNew->pLeft = p;
450 }
451 pSelect = pNew->x.pSelect;
452 if( pSelect->pOrderBy ){
453 /* If the SELECT statement has an ORDER BY clause, zero the
454 ** iOrderByCol variables. These are set to non-zero when an
455 ** ORDER BY term exactly matches one of the terms of the
456 ** result-set. Since the result-set of the SELECT statement may
457 ** have been modified or reordered, these variables are no longer
458 ** set correctly. Since setting them is just an optimization,
459 ** it's easiest just to zero them here. */
460 ExprList *pOrderBy = pSelect->pOrderBy;
461 for(i=0; i<pOrderBy->nExpr; i++){
462 pOrderBy->a[i].u.x.iOrderByCol = 0;
463 }
464 }
465
466#if 0
467 printf("For indexing, change the IN expr:\n");
468 sqlite3TreeViewExpr(0, pX, 0);
469 printf("Into:\n");
470 sqlite3TreeViewExpr(0, pNew, 0);
471#endif
drh9b1ecb62017-11-17 17:32:40 +0000472 }
drh24102432017-11-17 21:01:04 +0000473 return pNew;
drh9b1ecb62017-11-17 17:32:40 +0000474}
drh9b1ecb62017-11-17 17:32:40 +0000475
476
drh6f82e852015-06-06 20:12:09 +0000477/*
478** Generate code for a single equality term of the WHERE clause. An equality
479** term can be either X=expr or X IN (...). pTerm is the term to be
480** coded.
481**
drh099a0f52016-09-06 15:25:53 +0000482** The current value for the constraint is left in a register, the index
483** of which is returned. An attempt is made store the result in iTarget but
484** this is only guaranteed for TK_ISNULL and TK_IN constraints. If the
485** constraint is a TK_EQ or TK_IS, then the current value might be left in
486** some other register and it is the caller's responsibility to compensate.
drh6f82e852015-06-06 20:12:09 +0000487**
drh4602b8e2016-08-19 18:28:00 +0000488** For a constraint of the form X=expr, the expression is evaluated in
489** straight-line code. For constraints of the form X IN (...)
drh6f82e852015-06-06 20:12:09 +0000490** this routine sets up a loop that will iterate over all values of X.
491*/
492static int codeEqualityTerm(
493 Parse *pParse, /* The parsing context */
494 WhereTerm *pTerm, /* The term of the WHERE clause to be coded */
495 WhereLevel *pLevel, /* The level of the FROM clause we are working on */
496 int iEq, /* Index of the equality term within this level */
497 int bRev, /* True for reverse-order IN operations */
498 int iTarget /* Attempt to leave results in this register */
499){
500 Expr *pX = pTerm->pExpr;
501 Vdbe *v = pParse->pVdbe;
502 int iReg; /* Register holding results */
503
dan8da209b2016-07-26 18:06:08 +0000504 assert( pLevel->pWLoop->aLTerm[iEq]==pTerm );
drh6f82e852015-06-06 20:12:09 +0000505 assert( iTarget>0 );
506 if( pX->op==TK_EQ || pX->op==TK_IS ){
drhfc7f27b2016-08-20 00:07:01 +0000507 iReg = sqlite3ExprCodeTarget(pParse, pX->pRight, iTarget);
drh6f82e852015-06-06 20:12:09 +0000508 }else if( pX->op==TK_ISNULL ){
509 iReg = iTarget;
510 sqlite3VdbeAddOp2(v, OP_Null, 0, iReg);
511#ifndef SQLITE_OMIT_SUBQUERY
512 }else{
drhac6b47d2016-08-24 00:51:48 +0000513 int eType = IN_INDEX_NOOP;
drh6f82e852015-06-06 20:12:09 +0000514 int iTab;
515 struct InLoop *pIn;
516 WhereLoop *pLoop = pLevel->pWLoop;
dan8da209b2016-07-26 18:06:08 +0000517 int i;
518 int nEq = 0;
519 int *aiMap = 0;
drh6f82e852015-06-06 20:12:09 +0000520
521 if( (pLoop->wsFlags & WHERE_VIRTUALTABLE)==0
522 && pLoop->u.btree.pIndex!=0
523 && pLoop->u.btree.pIndex->aSortOrder[iEq]
524 ){
525 testcase( iEq==0 );
526 testcase( bRev );
527 bRev = !bRev;
528 }
529 assert( pX->op==TK_IN );
530 iReg = iTarget;
dan8da209b2016-07-26 18:06:08 +0000531
532 for(i=0; i<iEq; i++){
533 if( pLoop->aLTerm[i] && pLoop->aLTerm[i]->pExpr==pX ){
534 disableTerm(pLevel, pTerm);
535 return iTarget;
536 }
537 }
538 for(i=iEq;i<pLoop->nLTerm; i++){
drh24102432017-11-17 21:01:04 +0000539 assert( pLoop->aLTerm[i]!=0 );
540 if( pLoop->aLTerm[i]->pExpr==pX ) nEq++;
dan8da209b2016-07-26 18:06:08 +0000541 }
542
drh2c041312018-12-24 02:34:49 +0000543 iTab = 0;
dan8da209b2016-07-26 18:06:08 +0000544 if( (pX->flags & EP_xIsSelect)==0 || pX->x.pSelect->pEList->nExpr==1 ){
drh2c041312018-12-24 02:34:49 +0000545 eType = sqlite3FindInIndex(pParse, pX, IN_INDEX_LOOP, 0, 0, &iTab);
dan8da209b2016-07-26 18:06:08 +0000546 }else{
547 sqlite3 *db = pParse->db;
drh24102432017-11-17 21:01:04 +0000548 pX = removeUnindexableInClauseTerms(pParse, iEq, pLoop, pX);
drh9b1ecb62017-11-17 17:32:40 +0000549
drhac6b47d2016-08-24 00:51:48 +0000550 if( !db->mallocFailed ){
drh24102432017-11-17 21:01:04 +0000551 aiMap = (int*)sqlite3DbMallocZero(pParse->db, sizeof(int)*nEq);
drh2c041312018-12-24 02:34:49 +0000552 eType = sqlite3FindInIndex(pParse, pX, IN_INDEX_LOOP, 0, aiMap, &iTab);
553 pTerm->pExpr->iTable = iTab;
drhac6b47d2016-08-24 00:51:48 +0000554 }
drh24102432017-11-17 21:01:04 +0000555 sqlite3ExprDelete(db, pX);
556 pX = pTerm->pExpr;
dan8da209b2016-07-26 18:06:08 +0000557 }
558
drh6f82e852015-06-06 20:12:09 +0000559 if( eType==IN_INDEX_INDEX_DESC ){
560 testcase( bRev );
561 bRev = !bRev;
562 }
drh6f82e852015-06-06 20:12:09 +0000563 sqlite3VdbeAddOp2(v, bRev ? OP_Last : OP_Rewind, iTab, 0);
564 VdbeCoverageIf(v, bRev);
565 VdbeCoverageIf(v, !bRev);
566 assert( (pLoop->wsFlags & WHERE_MULTI_OR)==0 );
dan8da209b2016-07-26 18:06:08 +0000567
drh6f82e852015-06-06 20:12:09 +0000568 pLoop->wsFlags |= WHERE_IN_ABLE;
569 if( pLevel->u.in.nIn==0 ){
drhec4ccdb2018-12-29 02:26:59 +0000570 pLevel->addrNxt = sqlite3VdbeMakeLabel(pParse);
drh6f82e852015-06-06 20:12:09 +0000571 }
dan8da209b2016-07-26 18:06:08 +0000572
573 i = pLevel->u.in.nIn;
574 pLevel->u.in.nIn += nEq;
drh6f82e852015-06-06 20:12:09 +0000575 pLevel->u.in.aInLoop =
576 sqlite3DbReallocOrFree(pParse->db, pLevel->u.in.aInLoop,
577 sizeof(pLevel->u.in.aInLoop[0])*pLevel->u.in.nIn);
578 pIn = pLevel->u.in.aInLoop;
579 if( pIn ){
dan8da209b2016-07-26 18:06:08 +0000580 int iMap = 0; /* Index in aiMap[] */
581 pIn += i;
dan7887d7f2016-08-24 12:22:17 +0000582 for(i=iEq;i<pLoop->nLTerm; i++){
dan8da209b2016-07-26 18:06:08 +0000583 if( pLoop->aLTerm[i]->pExpr==pX ){
danedc35372016-09-16 16:30:57 +0000584 int iOut = iReg + i - iEq;
dan8da209b2016-07-26 18:06:08 +0000585 if( eType==IN_INDEX_ROWID ){
danedc35372016-09-16 16:30:57 +0000586 pIn->addrInTop = sqlite3VdbeAddOp2(v, OP_Rowid, iTab, iOut);
dan8da209b2016-07-26 18:06:08 +0000587 }else{
588 int iCol = aiMap ? aiMap[iMap++] : 0;
dan8da209b2016-07-26 18:06:08 +0000589 pIn->addrInTop = sqlite3VdbeAddOp3(v,OP_Column,iTab, iCol, iOut);
590 }
drh03181c82016-08-18 19:04:57 +0000591 sqlite3VdbeAddOp1(v, OP_IsNull, iOut); VdbeCoverage(v);
dan8da209b2016-07-26 18:06:08 +0000592 if( i==iEq ){
593 pIn->iCur = iTab;
drhf1949b62018-06-07 17:32:59 +0000594 pIn->eEndLoopOp = bRev ? OP_Prev : OP_Next;
drh056f5392018-06-07 16:07:00 +0000595 if( iEq>0 && (pLoop->wsFlags & WHERE_VIRTUALTABLE)==0 ){
drh86d0ea72018-06-05 15:16:25 +0000596 pIn->iBase = iReg - i;
597 pIn->nPrefix = i;
drhf7b0a5f2018-06-07 14:59:22 +0000598 pLoop->wsFlags |= WHERE_IN_EARLYOUT;
drh86d0ea72018-06-05 15:16:25 +0000599 }else{
600 pIn->nPrefix = 0;
601 }
dan8da209b2016-07-26 18:06:08 +0000602 }else{
603 pIn->eEndLoopOp = OP_Noop;
604 }
dan7887d7f2016-08-24 12:22:17 +0000605 pIn++;
dan8da209b2016-07-26 18:06:08 +0000606 }
drh6f82e852015-06-06 20:12:09 +0000607 }
drh6f82e852015-06-06 20:12:09 +0000608 }else{
609 pLevel->u.in.nIn = 0;
610 }
dan8da209b2016-07-26 18:06:08 +0000611 sqlite3DbFree(pParse->db, aiMap);
drh6f82e852015-06-06 20:12:09 +0000612#endif
613 }
614 disableTerm(pLevel, pTerm);
615 return iReg;
616}
617
618/*
619** Generate code that will evaluate all == and IN constraints for an
620** index scan.
621**
622** For example, consider table t1(a,b,c,d,e,f) with index i1(a,b,c).
623** Suppose the WHERE clause is this: a==5 AND b IN (1,2,3) AND c>5 AND c<10
624** The index has as many as three equality constraints, but in this
625** example, the third "c" value is an inequality. So only two
626** constraints are coded. This routine will generate code to evaluate
627** a==5 and b IN (1,2,3). The current values for a and b will be stored
628** in consecutive registers and the index of the first register is returned.
629**
630** In the example above nEq==2. But this subroutine works for any value
631** of nEq including 0. If nEq==0, this routine is nearly a no-op.
632** The only thing it does is allocate the pLevel->iMem memory cell and
633** compute the affinity string.
634**
635** The nExtraReg parameter is 0 or 1. It is 0 if all WHERE clause constraints
636** are == or IN and are covered by the nEq. nExtraReg is 1 if there is
637** an inequality constraint (such as the "c>=5 AND c<10" in the example) that
638** occurs after the nEq quality constraints.
639**
640** This routine allocates a range of nEq+nExtraReg memory cells and returns
641** the index of the first memory cell in that range. The code that
642** calls this routine will use that memory range to store keys for
643** start and termination conditions of the loop.
644** key value of the loop. If one or more IN operators appear, then
645** this routine allocates an additional nEq memory cells for internal
646** use.
647**
648** Before returning, *pzAff is set to point to a buffer containing a
649** copy of the column affinity string of the index allocated using
650** sqlite3DbMalloc(). Except, entries in the copy of the string associated
651** with equality constraints that use BLOB or NONE affinity are set to
652** SQLITE_AFF_BLOB. This is to deal with SQL such as the following:
653**
654** CREATE TABLE t1(a TEXT PRIMARY KEY, b);
655** SELECT ... FROM t1 AS t2, t1 WHERE t1.a = t2.b;
656**
657** In the example above, the index on t1(a) has TEXT affinity. But since
658** the right hand side of the equality constraint (t2.b) has BLOB/NONE affinity,
659** no conversion should be attempted before using a t2.b value as part of
660** a key to search the index. Hence the first byte in the returned affinity
661** string in this example would be set to SQLITE_AFF_BLOB.
662*/
663static int codeAllEqualityTerms(
664 Parse *pParse, /* Parsing context */
665 WhereLevel *pLevel, /* Which nested loop of the FROM we are coding */
666 int bRev, /* Reverse the order of IN operators */
667 int nExtraReg, /* Number of extra registers to allocate */
668 char **pzAff /* OUT: Set to point to affinity string */
669){
670 u16 nEq; /* The number of == or IN constraints to code */
671 u16 nSkip; /* Number of left-most columns to skip */
672 Vdbe *v = pParse->pVdbe; /* The vm under construction */
673 Index *pIdx; /* The index being used for this loop */
674 WhereTerm *pTerm; /* A single constraint term */
675 WhereLoop *pLoop; /* The WhereLoop object */
676 int j; /* Loop counter */
677 int regBase; /* Base register */
678 int nReg; /* Number of registers to allocate */
679 char *zAff; /* Affinity string to return */
680
681 /* This module is only called on query plans that use an index. */
682 pLoop = pLevel->pWLoop;
683 assert( (pLoop->wsFlags & WHERE_VIRTUALTABLE)==0 );
684 nEq = pLoop->u.btree.nEq;
685 nSkip = pLoop->nSkip;
686 pIdx = pLoop->u.btree.pIndex;
687 assert( pIdx!=0 );
688
689 /* Figure out how many memory cells we will need then allocate them.
690 */
691 regBase = pParse->nMem + 1;
692 nReg = pLoop->u.btree.nEq + nExtraReg;
693 pParse->nMem += nReg;
694
drhe9107692015-08-25 19:20:04 +0000695 zAff = sqlite3DbStrDup(pParse->db,sqlite3IndexAffinityStr(pParse->db,pIdx));
drh4df86af2016-02-04 11:48:00 +0000696 assert( zAff!=0 || pParse->db->mallocFailed );
drh6f82e852015-06-06 20:12:09 +0000697
698 if( nSkip ){
699 int iIdxCur = pLevel->iIdxCur;
700 sqlite3VdbeAddOp1(v, (bRev?OP_Last:OP_Rewind), iIdxCur);
701 VdbeCoverageIf(v, bRev==0);
702 VdbeCoverageIf(v, bRev!=0);
703 VdbeComment((v, "begin skip-scan on %s", pIdx->zName));
704 j = sqlite3VdbeAddOp0(v, OP_Goto);
705 pLevel->addrSkip = sqlite3VdbeAddOp4Int(v, (bRev?OP_SeekLT:OP_SeekGT),
706 iIdxCur, 0, regBase, nSkip);
707 VdbeCoverageIf(v, bRev==0);
708 VdbeCoverageIf(v, bRev!=0);
709 sqlite3VdbeJumpHere(v, j);
710 for(j=0; j<nSkip; j++){
711 sqlite3VdbeAddOp3(v, OP_Column, iIdxCur, j, regBase+j);
drh4b92f982015-09-29 17:20:14 +0000712 testcase( pIdx->aiColumn[j]==XN_EXPR );
drhe63e8a62015-09-18 18:09:28 +0000713 VdbeComment((v, "%s", explainIndexColumnName(pIdx, j)));
drh6f82e852015-06-06 20:12:09 +0000714 }
715 }
716
717 /* Evaluate the equality constraints
718 */
719 assert( zAff==0 || (int)strlen(zAff)>=nEq );
720 for(j=nSkip; j<nEq; j++){
721 int r1;
722 pTerm = pLoop->aLTerm[j];
723 assert( pTerm!=0 );
724 /* The following testcase is true for indices with redundant columns.
725 ** Ex: CREATE INDEX i1 ON t1(a,b,a); SELECT * FROM t1 WHERE a=0 AND b=0; */
726 testcase( (pTerm->wtFlags & TERM_CODED)!=0 );
727 testcase( pTerm->wtFlags & TERM_VIRTUAL );
728 r1 = codeEqualityTerm(pParse, pTerm, pLevel, j, bRev, regBase+j);
729 if( r1!=regBase+j ){
730 if( nReg==1 ){
731 sqlite3ReleaseTempReg(pParse, regBase);
732 regBase = r1;
733 }else{
734 sqlite3VdbeAddOp2(v, OP_SCopy, r1, regBase+j);
735 }
736 }
drhc097e122016-09-07 13:30:40 +0000737 if( pTerm->eOperator & WO_IN ){
738 if( pTerm->pExpr->flags & EP_xIsSelect ){
739 /* No affinity ever needs to be (or should be) applied to a value
740 ** from the RHS of an "? IN (SELECT ...)" expression. The
741 ** sqlite3FindInIndex() routine has already ensured that the
742 ** affinity of the comparison has been applied to the value. */
743 if( zAff ) zAff[j] = SQLITE_AFF_BLOB;
744 }
745 }else if( (pTerm->eOperator & WO_ISNULL)==0 ){
746 Expr *pRight = pTerm->pExpr->pRight;
747 if( (pTerm->wtFlags & TERM_IS)==0 && sqlite3ExprCanBeNull(pRight) ){
748 sqlite3VdbeAddOp2(v, OP_IsNull, regBase+j, pLevel->addrBrk);
749 VdbeCoverage(v);
750 }
751 if( zAff ){
752 if( sqlite3CompareAffinity(pRight, zAff[j])==SQLITE_AFF_BLOB ){
753 zAff[j] = SQLITE_AFF_BLOB;
dan27189602016-09-03 15:31:20 +0000754 }
drhc097e122016-09-07 13:30:40 +0000755 if( sqlite3ExprNeedsNoAffinityChange(pRight, zAff[j]) ){
756 zAff[j] = SQLITE_AFF_BLOB;
drh6f82e852015-06-06 20:12:09 +0000757 }
758 }
759 }
760 }
761 *pzAff = zAff;
762 return regBase;
763}
764
drh41d2e662015-12-01 21:23:07 +0000765#ifndef SQLITE_LIKE_DOESNT_MATCH_BLOBS
drh6f82e852015-06-06 20:12:09 +0000766/*
drh44aebff2016-05-02 10:25:42 +0000767** If the most recently coded instruction is a constant range constraint
768** (a string literal) that originated from the LIKE optimization, then
769** set P3 and P5 on the OP_String opcode so that the string will be cast
770** to a BLOB at appropriate times.
drh6f82e852015-06-06 20:12:09 +0000771**
772** The LIKE optimization trys to evaluate "x LIKE 'abc%'" as a range
773** expression: "x>='ABC' AND x<'abd'". But this requires that the range
774** scan loop run twice, once for strings and a second time for BLOBs.
775** The OP_String opcodes on the second pass convert the upper and lower
mistachkine234cfd2016-07-10 19:35:10 +0000776** bound string constants to blobs. This routine makes the necessary changes
drh6f82e852015-06-06 20:12:09 +0000777** to the OP_String opcodes for that to happen.
drh41d2e662015-12-01 21:23:07 +0000778**
779** Except, of course, if SQLITE_LIKE_DOESNT_MATCH_BLOBS is defined, then
780** only the one pass through the string space is required, so this routine
781** becomes a no-op.
drh6f82e852015-06-06 20:12:09 +0000782*/
783static void whereLikeOptimizationStringFixup(
784 Vdbe *v, /* prepared statement under construction */
785 WhereLevel *pLevel, /* The loop that contains the LIKE operator */
786 WhereTerm *pTerm /* The upper or lower bound just coded */
787){
788 if( pTerm->wtFlags & TERM_LIKEOPT ){
789 VdbeOp *pOp;
790 assert( pLevel->iLikeRepCntr>0 );
791 pOp = sqlite3VdbeGetOp(v, -1);
792 assert( pOp!=0 );
793 assert( pOp->opcode==OP_String8
794 || pTerm->pWC->pWInfo->pParse->db->mallocFailed );
drh44aebff2016-05-02 10:25:42 +0000795 pOp->p3 = (int)(pLevel->iLikeRepCntr>>1); /* Register holding counter */
796 pOp->p5 = (u8)(pLevel->iLikeRepCntr&1); /* ASC or DESC */
drh6f82e852015-06-06 20:12:09 +0000797 }
798}
drh41d2e662015-12-01 21:23:07 +0000799#else
800# define whereLikeOptimizationStringFixup(A,B,C)
801#endif
drh6f82e852015-06-06 20:12:09 +0000802
drhbec24762015-08-13 20:07:13 +0000803#ifdef SQLITE_ENABLE_CURSOR_HINTS
drh2f2b0272015-08-14 18:50:04 +0000804/*
805** Information is passed from codeCursorHint() down to individual nodes of
806** the expression tree (by sqlite3WalkExpr()) using an instance of this
807** structure.
808*/
809struct CCurHint {
810 int iTabCur; /* Cursor for the main table */
811 int iIdxCur; /* Cursor for the index, if pIdx!=0. Unused otherwise */
812 Index *pIdx; /* The index used to access the table */
813};
814
815/*
816** This function is called for every node of an expression that is a candidate
817** for a cursor hint on an index cursor. For TK_COLUMN nodes that reference
818** the table CCurHint.iTabCur, verify that the same column can be
819** accessed through the index. If it cannot, then set pWalker->eCode to 1.
820*/
821static int codeCursorHintCheckExpr(Walker *pWalker, Expr *pExpr){
822 struct CCurHint *pHint = pWalker->u.pCCurHint;
823 assert( pHint->pIdx!=0 );
824 if( pExpr->op==TK_COLUMN
825 && pExpr->iTable==pHint->iTabCur
826 && sqlite3ColumnOfIndex(pHint->pIdx, pExpr->iColumn)<0
827 ){
828 pWalker->eCode = 1;
829 }
830 return WRC_Continue;
831}
832
dane6912fd2016-06-17 19:27:13 +0000833/*
834** Test whether or not expression pExpr, which was part of a WHERE clause,
835** should be included in the cursor-hint for a table that is on the rhs
836** of a LEFT JOIN. Set Walker.eCode to non-zero before returning if the
837** expression is not suitable.
838**
839** An expression is unsuitable if it might evaluate to non NULL even if
840** a TK_COLUMN node that does affect the value of the expression is set
841** to NULL. For example:
842**
843** col IS NULL
844** col IS NOT NULL
845** coalesce(col, 1)
846** CASE WHEN col THEN 0 ELSE 1 END
847*/
848static int codeCursorHintIsOrFunction(Walker *pWalker, Expr *pExpr){
dan2b693d62016-06-20 17:22:06 +0000849 if( pExpr->op==TK_IS
dane6912fd2016-06-17 19:27:13 +0000850 || pExpr->op==TK_ISNULL || pExpr->op==TK_ISNOT
851 || pExpr->op==TK_NOTNULL || pExpr->op==TK_CASE
852 ){
853 pWalker->eCode = 1;
dan2b693d62016-06-20 17:22:06 +0000854 }else if( pExpr->op==TK_FUNCTION ){
855 int d1;
drh1d42ea72017-07-27 20:24:29 +0000856 char d2[4];
dan2b693d62016-06-20 17:22:06 +0000857 if( 0==sqlite3IsLikeFunction(pWalker->pParse->db, pExpr, &d1, d2) ){
858 pWalker->eCode = 1;
859 }
dane6912fd2016-06-17 19:27:13 +0000860 }
dan2b693d62016-06-20 17:22:06 +0000861
dane6912fd2016-06-17 19:27:13 +0000862 return WRC_Continue;
863}
864
drhbec24762015-08-13 20:07:13 +0000865
866/*
867** This function is called on every node of an expression tree used as an
868** argument to the OP_CursorHint instruction. If the node is a TK_COLUMN
drh2f2b0272015-08-14 18:50:04 +0000869** that accesses any table other than the one identified by
870** CCurHint.iTabCur, then do the following:
drhbec24762015-08-13 20:07:13 +0000871**
872** 1) allocate a register and code an OP_Column instruction to read
873** the specified column into the new register, and
874**
875** 2) transform the expression node to a TK_REGISTER node that reads
876** from the newly populated register.
drh2f2b0272015-08-14 18:50:04 +0000877**
878** Also, if the node is a TK_COLUMN that does access the table idenified
879** by pCCurHint.iTabCur, and an index is being used (which we will
880** know because CCurHint.pIdx!=0) then transform the TK_COLUMN into
881** an access of the index rather than the original table.
drhbec24762015-08-13 20:07:13 +0000882*/
883static int codeCursorHintFixExpr(Walker *pWalker, Expr *pExpr){
884 int rc = WRC_Continue;
drh2f2b0272015-08-14 18:50:04 +0000885 struct CCurHint *pHint = pWalker->u.pCCurHint;
danbe312ae2018-09-10 19:27:12 +0000886 if( pExpr->op==TK_COLUMN ){
drh2f2b0272015-08-14 18:50:04 +0000887 if( pExpr->iTable!=pHint->iTabCur ){
drh2f2b0272015-08-14 18:50:04 +0000888 int reg = ++pWalker->pParse->nMem; /* Register for column value */
dane3e79212018-09-11 13:38:35 +0000889 sqlite3ExprCode(pWalker->pParse, pExpr, reg);
drh2f2b0272015-08-14 18:50:04 +0000890 pExpr->op = TK_REGISTER;
891 pExpr->iTable = reg;
892 }else if( pHint->pIdx!=0 ){
893 pExpr->iTable = pHint->iIdxCur;
894 pExpr->iColumn = sqlite3ColumnOfIndex(pHint->pIdx, pExpr->iColumn);
895 assert( pExpr->iColumn>=0 );
896 }
drhbec24762015-08-13 20:07:13 +0000897 }else if( pExpr->op==TK_AGG_FUNCTION ){
898 /* An aggregate function in the WHERE clause of a query means this must
899 ** be a correlated sub-query, and expression pExpr is an aggregate from
900 ** the parent context. Do not walk the function arguments in this case.
901 **
902 ** todo: It should be possible to replace this node with a TK_REGISTER
903 ** expression, as the result of the expression must be stored in a
904 ** register at this point. The same holds for TK_AGG_COLUMN nodes. */
905 rc = WRC_Prune;
906 }
907 return rc;
908}
909
910/*
911** Insert an OP_CursorHint instruction if it is appropriate to do so.
912*/
913static void codeCursorHint(
danb324cf72016-06-17 14:33:32 +0000914 struct SrcList_item *pTabItem, /* FROM clause item */
drhb413a542015-08-17 17:19:28 +0000915 WhereInfo *pWInfo, /* The where clause */
916 WhereLevel *pLevel, /* Which loop to provide hints for */
917 WhereTerm *pEndRange /* Hint this end-of-scan boundary term if not NULL */
drhbec24762015-08-13 20:07:13 +0000918){
919 Parse *pParse = pWInfo->pParse;
920 sqlite3 *db = pParse->db;
921 Vdbe *v = pParse->pVdbe;
drhbec24762015-08-13 20:07:13 +0000922 Expr *pExpr = 0;
drh2f2b0272015-08-14 18:50:04 +0000923 WhereLoop *pLoop = pLevel->pWLoop;
drhbec24762015-08-13 20:07:13 +0000924 int iCur;
925 WhereClause *pWC;
926 WhereTerm *pTerm;
drhb413a542015-08-17 17:19:28 +0000927 int i, j;
drh2f2b0272015-08-14 18:50:04 +0000928 struct CCurHint sHint;
929 Walker sWalker;
drhbec24762015-08-13 20:07:13 +0000930
931 if( OptimizationDisabled(db, SQLITE_CursorHints) ) return;
drh2f2b0272015-08-14 18:50:04 +0000932 iCur = pLevel->iTabCur;
933 assert( iCur==pWInfo->pTabList->a[pLevel->iFrom].iCursor );
934 sHint.iTabCur = iCur;
935 sHint.iIdxCur = pLevel->iIdxCur;
936 sHint.pIdx = pLoop->u.btree.pIndex;
937 memset(&sWalker, 0, sizeof(sWalker));
938 sWalker.pParse = pParse;
939 sWalker.u.pCCurHint = &sHint;
drhbec24762015-08-13 20:07:13 +0000940 pWC = &pWInfo->sWC;
941 for(i=0; i<pWC->nTerm; i++){
942 pTerm = &pWC->a[i];
943 if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
944 if( pTerm->prereqAll & pLevel->notReady ) continue;
danb324cf72016-06-17 14:33:32 +0000945
946 /* Any terms specified as part of the ON(...) clause for any LEFT
947 ** JOIN for which the current table is not the rhs are omitted
948 ** from the cursor-hint.
949 **
dane6912fd2016-06-17 19:27:13 +0000950 ** If this table is the rhs of a LEFT JOIN, "IS" or "IS NULL" terms
951 ** that were specified as part of the WHERE clause must be excluded.
952 ** This is to address the following:
danb324cf72016-06-17 14:33:32 +0000953 **
954 ** SELECT ... t1 LEFT JOIN t2 ON (t1.a=t2.b) WHERE t2.c IS NULL;
955 **
dane6912fd2016-06-17 19:27:13 +0000956 ** Say there is a single row in t2 that matches (t1.a=t2.b), but its
957 ** t2.c values is not NULL. If the (t2.c IS NULL) constraint is
958 ** pushed down to the cursor, this row is filtered out, causing
959 ** SQLite to synthesize a row of NULL values. Which does match the
960 ** WHERE clause, and so the query returns a row. Which is incorrect.
961 **
962 ** For the same reason, WHERE terms such as:
963 **
964 ** WHERE 1 = (t2.c IS NULL)
965 **
966 ** are also excluded. See codeCursorHintIsOrFunction() for details.
danb324cf72016-06-17 14:33:32 +0000967 */
968 if( pTabItem->fg.jointype & JT_LEFT ){
dane6912fd2016-06-17 19:27:13 +0000969 Expr *pExpr = pTerm->pExpr;
970 if( !ExprHasProperty(pExpr, EP_FromJoin)
971 || pExpr->iRightJoinTable!=pTabItem->iCursor
danb324cf72016-06-17 14:33:32 +0000972 ){
dane6912fd2016-06-17 19:27:13 +0000973 sWalker.eCode = 0;
974 sWalker.xExprCallback = codeCursorHintIsOrFunction;
975 sqlite3WalkExpr(&sWalker, pTerm->pExpr);
976 if( sWalker.eCode ) continue;
danb324cf72016-06-17 14:33:32 +0000977 }
978 }else{
979 if( ExprHasProperty(pTerm->pExpr, EP_FromJoin) ) continue;
980 }
drhb413a542015-08-17 17:19:28 +0000981
982 /* All terms in pWLoop->aLTerm[] except pEndRange are used to initialize
drhbcf40a72015-08-18 15:58:05 +0000983 ** the cursor. These terms are not needed as hints for a pure range
984 ** scan (that has no == terms) so omit them. */
985 if( pLoop->u.btree.nEq==0 && pTerm!=pEndRange ){
986 for(j=0; j<pLoop->nLTerm && pLoop->aLTerm[j]!=pTerm; j++){}
987 if( j<pLoop->nLTerm ) continue;
drhb413a542015-08-17 17:19:28 +0000988 }
989
990 /* No subqueries or non-deterministic functions allowed */
drhbec24762015-08-13 20:07:13 +0000991 if( sqlite3ExprContainsSubquery(pTerm->pExpr) ) continue;
drhb413a542015-08-17 17:19:28 +0000992
993 /* For an index scan, make sure referenced columns are actually in
994 ** the index. */
drh2f2b0272015-08-14 18:50:04 +0000995 if( sHint.pIdx!=0 ){
996 sWalker.eCode = 0;
997 sWalker.xExprCallback = codeCursorHintCheckExpr;
998 sqlite3WalkExpr(&sWalker, pTerm->pExpr);
999 if( sWalker.eCode ) continue;
1000 }
drhb413a542015-08-17 17:19:28 +00001001
1002 /* If we survive all prior tests, that means this term is worth hinting */
drhd5c851c2019-04-19 13:38:34 +00001003 pExpr = sqlite3ExprAnd(pParse, pExpr, sqlite3ExprDup(db, pTerm->pExpr, 0));
drhbec24762015-08-13 20:07:13 +00001004 }
1005 if( pExpr!=0 ){
drhbec24762015-08-13 20:07:13 +00001006 sWalker.xExprCallback = codeCursorHintFixExpr;
drhbec24762015-08-13 20:07:13 +00001007 sqlite3WalkExpr(&sWalker, pExpr);
drh2f2b0272015-08-14 18:50:04 +00001008 sqlite3VdbeAddOp4(v, OP_CursorHint,
1009 (sHint.pIdx ? sHint.iIdxCur : sHint.iTabCur), 0, 0,
1010 (const char*)pExpr, P4_EXPR);
drhbec24762015-08-13 20:07:13 +00001011 }
1012}
1013#else
danb324cf72016-06-17 14:33:32 +00001014# define codeCursorHint(A,B,C,D) /* No-op */
drhbec24762015-08-13 20:07:13 +00001015#endif /* SQLITE_ENABLE_CURSOR_HINTS */
drh6f82e852015-06-06 20:12:09 +00001016
1017/*
dande892d92016-01-29 19:29:45 +00001018** Cursor iCur is open on an intkey b-tree (a table). Register iRowid contains
1019** a rowid value just read from cursor iIdxCur, open on index pIdx. This
1020** function generates code to do a deferred seek of cursor iCur to the
1021** rowid stored in register iRowid.
1022**
1023** Normally, this is just:
1024**
drh170ad682017-06-02 15:44:22 +00001025** OP_DeferredSeek $iCur $iRowid
dande892d92016-01-29 19:29:45 +00001026**
1027** However, if the scan currently being coded is a branch of an OR-loop and
drh170ad682017-06-02 15:44:22 +00001028** the statement currently being coded is a SELECT, then P3 of OP_DeferredSeek
dande892d92016-01-29 19:29:45 +00001029** is set to iIdxCur and P4 is set to point to an array of integers
1030** containing one entry for each column of the table cursor iCur is open
1031** on. For each table column, if the column is the i'th column of the
1032** index, then the corresponding array entry is set to (i+1). If the column
1033** does not appear in the index at all, the array entry is set to 0.
1034*/
1035static void codeDeferredSeek(
1036 WhereInfo *pWInfo, /* Where clause context */
1037 Index *pIdx, /* Index scan is using */
1038 int iCur, /* Cursor for IPK b-tree */
dande892d92016-01-29 19:29:45 +00001039 int iIdxCur /* Index cursor */
1040){
1041 Parse *pParse = pWInfo->pParse; /* Parse context */
1042 Vdbe *v = pParse->pVdbe; /* Vdbe to generate code within */
1043
1044 assert( iIdxCur>0 );
1045 assert( pIdx->aiColumn[pIdx->nColumn-1]==-1 );
1046
drh170ad682017-06-02 15:44:22 +00001047 sqlite3VdbeAddOp3(v, OP_DeferredSeek, iIdxCur, 0, iCur);
drhce943bc2016-05-19 18:56:33 +00001048 if( (pWInfo->wctrlFlags & WHERE_OR_SUBCLAUSE)
dancddb6ba2016-02-01 13:58:56 +00001049 && DbMaskAllZero(sqlite3ParseToplevel(pParse)->writeMask)
dande892d92016-01-29 19:29:45 +00001050 ){
1051 int i;
1052 Table *pTab = pIdx->pTable;
drhb1702022016-01-30 00:45:18 +00001053 int *ai = (int*)sqlite3DbMallocZero(pParse->db, sizeof(int)*(pTab->nCol+1));
dande892d92016-01-29 19:29:45 +00001054 if( ai ){
drhb1702022016-01-30 00:45:18 +00001055 ai[0] = pTab->nCol;
dande892d92016-01-29 19:29:45 +00001056 for(i=0; i<pIdx->nColumn-1; i++){
1057 assert( pIdx->aiColumn[i]<pTab->nCol );
drhb1702022016-01-30 00:45:18 +00001058 if( pIdx->aiColumn[i]>=0 ) ai[pIdx->aiColumn[i]+1] = i+1;
dande892d92016-01-29 19:29:45 +00001059 }
1060 sqlite3VdbeChangeP4(v, -1, (char*)ai, P4_INTARRAY);
1061 }
1062 }
1063}
1064
dan553168c2016-08-01 20:14:31 +00001065/*
1066** If the expression passed as the second argument is a vector, generate
1067** code to write the first nReg elements of the vector into an array
1068** of registers starting with iReg.
1069**
1070** If the expression is not a vector, then nReg must be passed 1. In
1071** this case, generate code to evaluate the expression and leave the
1072** result in register iReg.
1073*/
dan71c57db2016-07-09 20:23:55 +00001074static void codeExprOrVector(Parse *pParse, Expr *p, int iReg, int nReg){
1075 assert( nReg>0 );
dand03024d2017-09-09 19:41:12 +00001076 if( p && sqlite3ExprIsVector(p) ){
danf9b2e052016-08-02 17:45:00 +00001077#ifndef SQLITE_OMIT_SUBQUERY
1078 if( (p->flags & EP_xIsSelect) ){
1079 Vdbe *v = pParse->pVdbe;
drh85bcdce2018-12-23 21:27:29 +00001080 int iSelect;
1081 assert( p->op==TK_SELECT );
1082 iSelect = sqlite3CodeSubselect(pParse, p);
danf9b2e052016-08-02 17:45:00 +00001083 sqlite3VdbeAddOp3(v, OP_Copy, iSelect, iReg, nReg-1);
1084 }else
1085#endif
1086 {
1087 int i;
dan71c57db2016-07-09 20:23:55 +00001088 ExprList *pList = p->x.pList;
1089 assert( nReg<=pList->nExpr );
1090 for(i=0; i<nReg; i++){
1091 sqlite3ExprCode(pParse, pList->a[i].pExpr, iReg+i);
1092 }
dan71c57db2016-07-09 20:23:55 +00001093 }
1094 }else{
1095 assert( nReg==1 );
1096 sqlite3ExprCode(pParse, p, iReg);
1097 }
1098}
1099
drheac5fc02017-04-11 01:01:27 +00001100/* An instance of the IdxExprTrans object carries information about a
1101** mapping from an expression on table columns into a column in an index
1102** down through the Walker.
1103*/
drhaca19e12017-04-07 19:41:31 +00001104typedef struct IdxExprTrans {
1105 Expr *pIdxExpr; /* The index expression */
1106 int iTabCur; /* The cursor of the corresponding table */
1107 int iIdxCur; /* The cursor for the index */
1108 int iIdxCol; /* The column for the index */
1109} IdxExprTrans;
1110
drheac5fc02017-04-11 01:01:27 +00001111/* The walker node callback used to transform matching expressions into
1112** a reference to an index column for an index on an expression.
1113**
1114** If pExpr matches, then transform it into a reference to the index column
1115** that contains the value of pExpr.
1116*/
drhaca19e12017-04-07 19:41:31 +00001117static int whereIndexExprTransNode(Walker *p, Expr *pExpr){
1118 IdxExprTrans *pX = p->u.pIdxTrans;
dan5aa550c2017-06-24 18:10:29 +00001119 if( sqlite3ExprCompare(0, pExpr, pX->pIdxExpr, pX->iTabCur)==0 ){
danb6ce71b2019-08-20 11:43:44 +00001120 pExpr->affExpr = sqlite3ExprAffinity(pExpr);
drhaca19e12017-04-07 19:41:31 +00001121 pExpr->op = TK_COLUMN;
1122 pExpr->iTable = pX->iIdxCur;
1123 pExpr->iColumn = pX->iIdxCol;
drheda079c2018-09-20 19:02:15 +00001124 pExpr->y.pTab = 0;
drhaca19e12017-04-07 19:41:31 +00001125 return WRC_Prune;
1126 }else{
1127 return WRC_Continue;
1128 }
1129}
1130
1131/*
drhf49759b2017-08-25 19:51:51 +00001132** For an indexes on expression X, locate every instance of expression X
1133** in pExpr and change that subexpression into a reference to the appropriate
1134** column of the index.
drhaca19e12017-04-07 19:41:31 +00001135*/
1136static void whereIndexExprTrans(
1137 Index *pIdx, /* The Index */
1138 int iTabCur, /* Cursor of the table that is being indexed */
1139 int iIdxCur, /* Cursor of the index itself */
1140 WhereInfo *pWInfo /* Transform expressions in this WHERE clause */
1141){
1142 int iIdxCol; /* Column number of the index */
1143 ExprList *aColExpr; /* Expressions that are indexed */
1144 Walker w;
1145 IdxExprTrans x;
1146 aColExpr = pIdx->aColExpr;
1147 if( aColExpr==0 ) return; /* Not an index on expressions */
1148 memset(&w, 0, sizeof(w));
1149 w.xExprCallback = whereIndexExprTransNode;
1150 w.u.pIdxTrans = &x;
1151 x.iTabCur = iTabCur;
1152 x.iIdxCur = iIdxCur;
1153 for(iIdxCol=0; iIdxCol<aColExpr->nExpr; iIdxCol++){
1154 if( pIdx->aiColumn[iIdxCol]!=XN_EXPR ) continue;
1155 assert( aColExpr->a[iIdxCol].pExpr!=0 );
1156 x.iIdxCol = iIdxCol;
1157 x.pIdxExpr = aColExpr->a[iIdxCol].pExpr;
1158 sqlite3WalkExpr(&w, pWInfo->pWhere);
1159 sqlite3WalkExprList(&w, pWInfo->pOrderBy);
1160 sqlite3WalkExprList(&w, pWInfo->pResultSet);
1161 }
1162}
drhaca19e12017-04-07 19:41:31 +00001163
dande892d92016-01-29 19:29:45 +00001164/*
drh610f11d2019-03-18 10:30:00 +00001165** The pTruth expression is always true because it is the WHERE clause
drhb531aa82019-03-01 18:07:05 +00001166** a partial index that is driving a query loop. Look through all of the
1167** WHERE clause terms on the query, and if any of those terms must be
1168** true because pTruth is true, then mark those WHERE clause terms as
1169** coded.
1170*/
1171static void whereApplyPartialIndexConstraints(
1172 Expr *pTruth,
1173 int iTabCur,
1174 WhereClause *pWC
1175){
1176 int i;
1177 WhereTerm *pTerm;
1178 while( pTruth->op==TK_AND ){
1179 whereApplyPartialIndexConstraints(pTruth->pLeft, iTabCur, pWC);
1180 pTruth = pTruth->pRight;
1181 }
1182 for(i=0, pTerm=pWC->a; i<pWC->nTerm; i++, pTerm++){
1183 Expr *pExpr;
1184 if( pTerm->wtFlags & TERM_CODED ) continue;
1185 pExpr = pTerm->pExpr;
1186 if( sqlite3ExprCompare(0, pExpr, pTruth, iTabCur)==0 ){
1187 pTerm->wtFlags |= TERM_CODED;
1188 }
1189 }
1190}
1191
1192/*
drh6f82e852015-06-06 20:12:09 +00001193** Generate code for the start of the iLevel-th loop in the WHERE clause
1194** implementation described by pWInfo.
1195*/
1196Bitmask sqlite3WhereCodeOneLoopStart(
drh47df8a22018-12-25 00:15:37 +00001197 Parse *pParse, /* Parsing context */
1198 Vdbe *v, /* Prepared statement under construction */
drh6f82e852015-06-06 20:12:09 +00001199 WhereInfo *pWInfo, /* Complete information about the WHERE clause */
1200 int iLevel, /* Which level of pWInfo->a[] should be coded */
drh47df8a22018-12-25 00:15:37 +00001201 WhereLevel *pLevel, /* The current level pointer */
drh6f82e852015-06-06 20:12:09 +00001202 Bitmask notReady /* Which tables are currently available */
1203){
1204 int j, k; /* Loop counters */
1205 int iCur; /* The VDBE cursor for the table */
1206 int addrNxt; /* Where to jump to continue with the next IN case */
drh6f82e852015-06-06 20:12:09 +00001207 int bRev; /* True if we need to scan in reverse order */
drh6f82e852015-06-06 20:12:09 +00001208 WhereLoop *pLoop; /* The WhereLoop object being coded */
1209 WhereClause *pWC; /* Decomposition of the entire WHERE clause */
1210 WhereTerm *pTerm; /* A WHERE clause term */
drh6f82e852015-06-06 20:12:09 +00001211 sqlite3 *db; /* Database connection */
drh6f82e852015-06-06 20:12:09 +00001212 struct SrcList_item *pTabItem; /* FROM clause term being coded */
1213 int addrBrk; /* Jump here to break out of the loop */
drh3a3b4202017-02-15 22:36:15 +00001214 int addrHalt; /* addrBrk for the outermost loop */
drh6f82e852015-06-06 20:12:09 +00001215 int addrCont; /* Jump here to continue with next cycle */
1216 int iRowidReg = 0; /* Rowid is stored in this register, if not zero */
1217 int iReleaseReg = 0; /* Temp register to free before returning */
dan6f654a42017-04-28 19:59:55 +00001218 Index *pIdx = 0; /* Index used by loop (if any) */
danebc63012017-07-10 14:33:00 +00001219 int iLoop; /* Iteration of constraint generator loop */
drh6f82e852015-06-06 20:12:09 +00001220
drh6f82e852015-06-06 20:12:09 +00001221 pWC = &pWInfo->sWC;
1222 db = pParse->db;
drh6f82e852015-06-06 20:12:09 +00001223 pLoop = pLevel->pWLoop;
1224 pTabItem = &pWInfo->pTabList->a[pLevel->iFrom];
1225 iCur = pTabItem->iCursor;
1226 pLevel->notReady = notReady & ~sqlite3WhereGetMask(&pWInfo->sMaskSet, iCur);
1227 bRev = (pWInfo->revMask>>iLevel)&1;
drh6f82e852015-06-06 20:12:09 +00001228 VdbeModuleComment((v, "Begin WHERE-loop%d: %s",iLevel,pTabItem->pTab->zName));
1229
1230 /* Create labels for the "break" and "continue" instructions
1231 ** for the current loop. Jump to addrBrk to break out of a loop.
1232 ** Jump to cont to go immediately to the next iteration of the
1233 ** loop.
1234 **
1235 ** When there is an IN operator, we also have a "addrNxt" label that
1236 ** means to continue with the next IN value combination. When
1237 ** there are no IN operators in the constraints, the "addrNxt" label
1238 ** is the same as "addrBrk".
1239 */
drhec4ccdb2018-12-29 02:26:59 +00001240 addrBrk = pLevel->addrBrk = pLevel->addrNxt = sqlite3VdbeMakeLabel(pParse);
1241 addrCont = pLevel->addrCont = sqlite3VdbeMakeLabel(pParse);
drh6f82e852015-06-06 20:12:09 +00001242
1243 /* If this is the right table of a LEFT OUTER JOIN, allocate and
1244 ** initialize a memory cell that records if this table matches any
1245 ** row of the left table of the join.
1246 */
dan820fcd22018-04-24 18:53:24 +00001247 assert( (pWInfo->wctrlFlags & WHERE_OR_SUBCLAUSE)
1248 || pLevel->iFrom>0 || (pTabItem[0].fg.jointype & JT_LEFT)==0
1249 );
drh8a48b9c2015-08-19 15:20:00 +00001250 if( pLevel->iFrom>0 && (pTabItem[0].fg.jointype & JT_LEFT)!=0 ){
drh6f82e852015-06-06 20:12:09 +00001251 pLevel->iLeftJoin = ++pParse->nMem;
1252 sqlite3VdbeAddOp2(v, OP_Integer, 0, pLevel->iLeftJoin);
1253 VdbeComment((v, "init LEFT JOIN no-match flag"));
1254 }
1255
drh3a3b4202017-02-15 22:36:15 +00001256 /* Compute a safe address to jump to if we discover that the table for
1257 ** this loop is empty and can never contribute content. */
1258 for(j=iLevel; j>0 && pWInfo->a[j].iLeftJoin==0; j--){}
1259 addrHalt = pWInfo->a[j].addrBrk;
1260
drh6f82e852015-06-06 20:12:09 +00001261 /* Special case of a FROM clause subquery implemented as a co-routine */
drh8a48b9c2015-08-19 15:20:00 +00001262 if( pTabItem->fg.viaCoroutine ){
drh6f82e852015-06-06 20:12:09 +00001263 int regYield = pTabItem->regReturn;
1264 sqlite3VdbeAddOp3(v, OP_InitCoroutine, regYield, 0, pTabItem->addrFillSub);
1265 pLevel->p2 = sqlite3VdbeAddOp2(v, OP_Yield, regYield, addrBrk);
1266 VdbeCoverage(v);
drhfef37762018-07-10 19:48:35 +00001267 VdbeComment((v, "next row of %s", pTabItem->pTab->zName));
drh6f82e852015-06-06 20:12:09 +00001268 pLevel->op = OP_Goto;
1269 }else
1270
1271#ifndef SQLITE_OMIT_VIRTUALTABLE
1272 if( (pLoop->wsFlags & WHERE_VIRTUALTABLE)!=0 ){
1273 /* Case 1: The table is a virtual-table. Use the VFilter and VNext
1274 ** to access the data.
1275 */
1276 int iReg; /* P3 Value for OP_VFilter */
1277 int addrNotFound;
1278 int nConstraint = pLoop->nLTerm;
drhdbc49162016-03-02 03:28:07 +00001279 int iIn; /* Counter for IN constraints */
drh6f82e852015-06-06 20:12:09 +00001280
drh6f82e852015-06-06 20:12:09 +00001281 iReg = sqlite3GetTempRange(pParse, nConstraint+2);
1282 addrNotFound = pLevel->addrBrk;
1283 for(j=0; j<nConstraint; j++){
1284 int iTarget = iReg+j+2;
1285 pTerm = pLoop->aLTerm[j];
drh599d5762016-03-08 01:11:51 +00001286 if( NEVER(pTerm==0) ) continue;
drh6f82e852015-06-06 20:12:09 +00001287 if( pTerm->eOperator & WO_IN ){
1288 codeEqualityTerm(pParse, pTerm, pLevel, j, bRev, iTarget);
1289 addrNotFound = pLevel->addrNxt;
1290 }else{
dan6256c1c2016-08-08 20:15:41 +00001291 Expr *pRight = pTerm->pExpr->pRight;
drhfc7f27b2016-08-20 00:07:01 +00001292 codeExprOrVector(pParse, pRight, iTarget, 1);
drh6f82e852015-06-06 20:12:09 +00001293 }
1294 }
1295 sqlite3VdbeAddOp2(v, OP_Integer, pLoop->u.vtab.idxNum, iReg);
1296 sqlite3VdbeAddOp2(v, OP_Integer, nConstraint, iReg+1);
1297 sqlite3VdbeAddOp4(v, OP_VFilter, iCur, addrNotFound, iReg,
1298 pLoop->u.vtab.idxStr,
drh861b1302016-12-07 20:22:31 +00001299 pLoop->u.vtab.needFree ? P4_DYNAMIC : P4_STATIC);
drh6f82e852015-06-06 20:12:09 +00001300 VdbeCoverage(v);
1301 pLoop->u.vtab.needFree = 0;
drh6f82e852015-06-06 20:12:09 +00001302 pLevel->p1 = iCur;
dan354474a2015-09-29 10:11:26 +00001303 pLevel->op = pWInfo->eOnePass ? OP_Noop : OP_VNext;
drh6f82e852015-06-06 20:12:09 +00001304 pLevel->p2 = sqlite3VdbeCurrentAddr(v);
drhdbc49162016-03-02 03:28:07 +00001305 iIn = pLevel->u.in.nIn;
1306 for(j=nConstraint-1; j>=0; j--){
1307 pTerm = pLoop->aLTerm[j];
1308 if( j<16 && (pLoop->u.vtab.omitMask>>j)&1 ){
1309 disableTerm(pLevel, pTerm);
1310 }else if( (pTerm->eOperator & WO_IN)!=0 ){
1311 Expr *pCompare; /* The comparison operator */
1312 Expr *pRight; /* RHS of the comparison */
1313 VdbeOp *pOp; /* Opcode to access the value of the IN constraint */
1314
1315 /* Reload the constraint value into reg[iReg+j+2]. The same value
1316 ** was loaded into the same register prior to the OP_VFilter, but
1317 ** the xFilter implementation might have changed the datatype or
1318 ** encoding of the value in the register, so it *must* be reloaded. */
1319 assert( pLevel->u.in.aInLoop!=0 || db->mallocFailed );
drhfb826b82016-03-08 00:39:58 +00001320 if( !db->mallocFailed ){
drhdbc49162016-03-02 03:28:07 +00001321 assert( iIn>0 );
1322 pOp = sqlite3VdbeGetOp(v, pLevel->u.in.aInLoop[--iIn].addrInTop);
1323 assert( pOp->opcode==OP_Column || pOp->opcode==OP_Rowid );
1324 assert( pOp->opcode!=OP_Column || pOp->p3==iReg+j+2 );
1325 assert( pOp->opcode!=OP_Rowid || pOp->p2==iReg+j+2 );
1326 testcase( pOp->opcode==OP_Rowid );
1327 sqlite3VdbeAddOp3(v, pOp->opcode, pOp->p1, pOp->p2, pOp->p3);
1328 }
1329
1330 /* Generate code that will continue to the next row if
1331 ** the IN constraint is not satisfied */
drhabfd35e2016-12-06 22:47:23 +00001332 pCompare = sqlite3PExpr(pParse, TK_EQ, 0, 0);
drhdbc49162016-03-02 03:28:07 +00001333 assert( pCompare!=0 || db->mallocFailed );
1334 if( pCompare ){
1335 pCompare->pLeft = pTerm->pExpr->pLeft;
1336 pCompare->pRight = pRight = sqlite3Expr(db, TK_REGISTER, 0);
drh237b2b72016-03-07 19:08:27 +00001337 if( pRight ){
1338 pRight->iTable = iReg+j+2;
1339 sqlite3ExprIfFalse(pParse, pCompare, pLevel->addrCont, 0);
1340 }
drhdbc49162016-03-02 03:28:07 +00001341 pCompare->pLeft = 0;
1342 sqlite3ExprDelete(db, pCompare);
1343 }
1344 }
1345 }
drhba26faa2016-04-09 18:04:28 +00001346 /* These registers need to be preserved in case there is an IN operator
1347 ** loop. So we could deallocate the registers here (and potentially
1348 ** reuse them later) if (pLoop->wsFlags & WHERE_IN_ABLE)==0. But it seems
1349 ** simpler and safer to simply not reuse the registers.
1350 **
1351 ** sqlite3ReleaseTempRange(pParse, iReg, nConstraint+2);
1352 */
drh6f82e852015-06-06 20:12:09 +00001353 }else
1354#endif /* SQLITE_OMIT_VIRTUALTABLE */
1355
1356 if( (pLoop->wsFlags & WHERE_IPK)!=0
1357 && (pLoop->wsFlags & (WHERE_COLUMN_IN|WHERE_COLUMN_EQ))!=0
1358 ){
1359 /* Case 2: We can directly reference a single row using an
1360 ** equality comparison against the ROWID field. Or
1361 ** we reference multiple rows using a "rowid IN (...)"
1362 ** construct.
1363 */
1364 assert( pLoop->u.btree.nEq==1 );
1365 pTerm = pLoop->aLTerm[0];
1366 assert( pTerm!=0 );
1367 assert( pTerm->pExpr!=0 );
drh6f82e852015-06-06 20:12:09 +00001368 testcase( pTerm->wtFlags & TERM_VIRTUAL );
1369 iReleaseReg = ++pParse->nMem;
1370 iRowidReg = codeEqualityTerm(pParse, pTerm, pLevel, 0, bRev, iReleaseReg);
1371 if( iRowidReg!=iReleaseReg ) sqlite3ReleaseTempReg(pParse, iReleaseReg);
1372 addrNxt = pLevel->addrNxt;
drheeb95652016-05-26 20:56:38 +00001373 sqlite3VdbeAddOp3(v, OP_SeekRowid, iCur, addrNxt, iRowidReg);
drh6f82e852015-06-06 20:12:09 +00001374 VdbeCoverage(v);
drh6f82e852015-06-06 20:12:09 +00001375 pLevel->op = OP_Noop;
drhbc0a55c2019-02-22 21:33:56 +00001376 if( (pTerm->prereqAll & pLevel->notReady)==0 ){
1377 pTerm->wtFlags |= TERM_CODED;
1378 }
drh6f82e852015-06-06 20:12:09 +00001379 }else if( (pLoop->wsFlags & WHERE_IPK)!=0
1380 && (pLoop->wsFlags & WHERE_COLUMN_RANGE)!=0
1381 ){
1382 /* Case 3: We have an inequality comparison against the ROWID field.
1383 */
1384 int testOp = OP_Noop;
1385 int start;
1386 int memEndValue = 0;
1387 WhereTerm *pStart, *pEnd;
1388
drh6f82e852015-06-06 20:12:09 +00001389 j = 0;
1390 pStart = pEnd = 0;
1391 if( pLoop->wsFlags & WHERE_BTM_LIMIT ) pStart = pLoop->aLTerm[j++];
1392 if( pLoop->wsFlags & WHERE_TOP_LIMIT ) pEnd = pLoop->aLTerm[j++];
1393 assert( pStart!=0 || pEnd!=0 );
1394 if( bRev ){
1395 pTerm = pStart;
1396 pStart = pEnd;
1397 pEnd = pTerm;
1398 }
danb324cf72016-06-17 14:33:32 +00001399 codeCursorHint(pTabItem, pWInfo, pLevel, pEnd);
drh6f82e852015-06-06 20:12:09 +00001400 if( pStart ){
1401 Expr *pX; /* The expression that defines the start bound */
1402 int r1, rTemp; /* Registers for holding the start boundary */
dan19ff12d2016-07-29 20:58:19 +00001403 int op; /* Cursor seek operation */
drh6f82e852015-06-06 20:12:09 +00001404
1405 /* The following constant maps TK_xx codes into corresponding
1406 ** seek opcodes. It depends on a particular ordering of TK_xx
1407 */
1408 const u8 aMoveOp[] = {
1409 /* TK_GT */ OP_SeekGT,
1410 /* TK_LE */ OP_SeekLE,
1411 /* TK_LT */ OP_SeekLT,
1412 /* TK_GE */ OP_SeekGE
1413 };
1414 assert( TK_LE==TK_GT+1 ); /* Make sure the ordering.. */
1415 assert( TK_LT==TK_GT+2 ); /* ... of the TK_xx values... */
1416 assert( TK_GE==TK_GT+3 ); /* ... is correcct. */
1417
1418 assert( (pStart->wtFlags & TERM_VNULL)==0 );
1419 testcase( pStart->wtFlags & TERM_VIRTUAL );
1420 pX = pStart->pExpr;
1421 assert( pX!=0 );
1422 testcase( pStart->leftCursor!=iCur ); /* transitive constraints */
dan625015e2016-07-30 16:39:28 +00001423 if( sqlite3ExprIsVector(pX->pRight) ){
dan19ff12d2016-07-29 20:58:19 +00001424 r1 = rTemp = sqlite3GetTempReg(pParse);
1425 codeExprOrVector(pParse, pX->pRight, r1, 1);
drh4d1c6842018-02-13 18:48:08 +00001426 testcase( pX->op==TK_GT );
1427 testcase( pX->op==TK_GE );
1428 testcase( pX->op==TK_LT );
1429 testcase( pX->op==TK_LE );
1430 op = aMoveOp[((pX->op - TK_GT - 1) & 0x3) | 0x1];
1431 assert( pX->op!=TK_GT || op==OP_SeekGE );
1432 assert( pX->op!=TK_GE || op==OP_SeekGE );
1433 assert( pX->op!=TK_LT || op==OP_SeekLE );
1434 assert( pX->op!=TK_LE || op==OP_SeekLE );
dan19ff12d2016-07-29 20:58:19 +00001435 }else{
1436 r1 = sqlite3ExprCodeTemp(pParse, pX->pRight, &rTemp);
1437 disableTerm(pLevel, pStart);
1438 op = aMoveOp[(pX->op - TK_GT)];
1439 }
1440 sqlite3VdbeAddOp3(v, op, iCur, addrBrk, r1);
drh6f82e852015-06-06 20:12:09 +00001441 VdbeComment((v, "pk"));
1442 VdbeCoverageIf(v, pX->op==TK_GT);
1443 VdbeCoverageIf(v, pX->op==TK_LE);
1444 VdbeCoverageIf(v, pX->op==TK_LT);
1445 VdbeCoverageIf(v, pX->op==TK_GE);
drh6f82e852015-06-06 20:12:09 +00001446 sqlite3ReleaseTempReg(pParse, rTemp);
drh6f82e852015-06-06 20:12:09 +00001447 }else{
drh3a3b4202017-02-15 22:36:15 +00001448 sqlite3VdbeAddOp2(v, bRev ? OP_Last : OP_Rewind, iCur, addrHalt);
drh6f82e852015-06-06 20:12:09 +00001449 VdbeCoverageIf(v, bRev==0);
1450 VdbeCoverageIf(v, bRev!=0);
1451 }
1452 if( pEnd ){
1453 Expr *pX;
1454 pX = pEnd->pExpr;
1455 assert( pX!=0 );
1456 assert( (pEnd->wtFlags & TERM_VNULL)==0 );
1457 testcase( pEnd->leftCursor!=iCur ); /* Transitive constraints */
1458 testcase( pEnd->wtFlags & TERM_VIRTUAL );
1459 memEndValue = ++pParse->nMem;
dan19ff12d2016-07-29 20:58:19 +00001460 codeExprOrVector(pParse, pX->pRight, memEndValue, 1);
dan625015e2016-07-30 16:39:28 +00001461 if( 0==sqlite3ExprIsVector(pX->pRight)
1462 && (pX->op==TK_LT || pX->op==TK_GT)
1463 ){
drh6f82e852015-06-06 20:12:09 +00001464 testOp = bRev ? OP_Le : OP_Ge;
1465 }else{
1466 testOp = bRev ? OP_Lt : OP_Gt;
1467 }
dan553168c2016-08-01 20:14:31 +00001468 if( 0==sqlite3ExprIsVector(pX->pRight) ){
1469 disableTerm(pLevel, pEnd);
1470 }
drh6f82e852015-06-06 20:12:09 +00001471 }
1472 start = sqlite3VdbeCurrentAddr(v);
1473 pLevel->op = bRev ? OP_Prev : OP_Next;
1474 pLevel->p1 = iCur;
1475 pLevel->p2 = start;
1476 assert( pLevel->p5==0 );
1477 if( testOp!=OP_Noop ){
1478 iRowidReg = ++pParse->nMem;
1479 sqlite3VdbeAddOp2(v, OP_Rowid, iCur, iRowidReg);
drh6f82e852015-06-06 20:12:09 +00001480 sqlite3VdbeAddOp3(v, testOp, memEndValue, addrBrk, iRowidReg);
1481 VdbeCoverageIf(v, testOp==OP_Le);
1482 VdbeCoverageIf(v, testOp==OP_Lt);
1483 VdbeCoverageIf(v, testOp==OP_Ge);
1484 VdbeCoverageIf(v, testOp==OP_Gt);
1485 sqlite3VdbeChangeP5(v, SQLITE_AFF_NUMERIC | SQLITE_JUMPIFNULL);
1486 }
1487 }else if( pLoop->wsFlags & WHERE_INDEXED ){
1488 /* Case 4: A scan using an index.
1489 **
1490 ** The WHERE clause may contain zero or more equality
1491 ** terms ("==" or "IN" operators) that refer to the N
1492 ** left-most columns of the index. It may also contain
1493 ** inequality constraints (>, <, >= or <=) on the indexed
1494 ** column that immediately follows the N equalities. Only
1495 ** the right-most column can be an inequality - the rest must
1496 ** use the "==" and "IN" operators. For example, if the
1497 ** index is on (x,y,z), then the following clauses are all
1498 ** optimized:
1499 **
1500 ** x=5
1501 ** x=5 AND y=10
1502 ** x=5 AND y<10
1503 ** x=5 AND y>5 AND y<10
1504 ** x=5 AND y=5 AND z<=10
1505 **
1506 ** The z<10 term of the following cannot be used, only
1507 ** the x=5 term:
1508 **
1509 ** x=5 AND z<10
1510 **
1511 ** N may be zero if there are inequality constraints.
1512 ** If there are no inequality constraints, then N is at
1513 ** least one.
1514 **
1515 ** This case is also used when there are no WHERE clause
1516 ** constraints but an index is selected anyway, in order
1517 ** to force the output order to conform to an ORDER BY.
1518 */
1519 static const u8 aStartOp[] = {
1520 0,
1521 0,
1522 OP_Rewind, /* 2: (!start_constraints && startEq && !bRev) */
1523 OP_Last, /* 3: (!start_constraints && startEq && bRev) */
1524 OP_SeekGT, /* 4: (start_constraints && !startEq && !bRev) */
1525 OP_SeekLT, /* 5: (start_constraints && !startEq && bRev) */
1526 OP_SeekGE, /* 6: (start_constraints && startEq && !bRev) */
1527 OP_SeekLE /* 7: (start_constraints && startEq && bRev) */
1528 };
1529 static const u8 aEndOp[] = {
1530 OP_IdxGE, /* 0: (end_constraints && !bRev && !endEq) */
1531 OP_IdxGT, /* 1: (end_constraints && !bRev && endEq) */
1532 OP_IdxLE, /* 2: (end_constraints && bRev && !endEq) */
1533 OP_IdxLT, /* 3: (end_constraints && bRev && endEq) */
1534 };
1535 u16 nEq = pLoop->u.btree.nEq; /* Number of == or IN terms */
dan71c57db2016-07-09 20:23:55 +00001536 u16 nBtm = pLoop->u.btree.nBtm; /* Length of BTM vector */
1537 u16 nTop = pLoop->u.btree.nTop; /* Length of TOP vector */
drh6f82e852015-06-06 20:12:09 +00001538 int regBase; /* Base register holding constraint values */
1539 WhereTerm *pRangeStart = 0; /* Inequality constraint at range start */
1540 WhereTerm *pRangeEnd = 0; /* Inequality constraint at range end */
1541 int startEq; /* True if range start uses ==, >= or <= */
1542 int endEq; /* True if range end uses ==, >= or <= */
1543 int start_constraints; /* Start of range is constrained */
1544 int nConstraint; /* Number of constraint terms */
drh6f82e852015-06-06 20:12:09 +00001545 int iIdxCur; /* The VDBE cursor for the index */
1546 int nExtraReg = 0; /* Number of extra registers needed */
1547 int op; /* Instruction opcode */
1548 char *zStartAff; /* Affinity for start of range constraint */
danb7ca2172016-08-26 17:54:46 +00001549 char *zEndAff = 0; /* Affinity for end of range constraint */
drh6f82e852015-06-06 20:12:09 +00001550 u8 bSeekPastNull = 0; /* True to seek past initial nulls */
1551 u8 bStopAtNull = 0; /* Add condition to terminate at NULLs */
drh47df8a22018-12-25 00:15:37 +00001552 int omitTable; /* True if we use the index only */
drh74e1b862019-08-23 13:08:49 +00001553 int regBignull = 0; /* big-null flag register */
drh6f82e852015-06-06 20:12:09 +00001554
1555 pIdx = pLoop->u.btree.pIndex;
1556 iIdxCur = pLevel->iIdxCur;
1557 assert( nEq>=pLoop->nSkip );
1558
drh6f82e852015-06-06 20:12:09 +00001559 /* Find any inequality constraint terms for the start and end
1560 ** of the range.
1561 */
1562 j = nEq;
1563 if( pLoop->wsFlags & WHERE_BTM_LIMIT ){
1564 pRangeStart = pLoop->aLTerm[j++];
dan71c57db2016-07-09 20:23:55 +00001565 nExtraReg = MAX(nExtraReg, pLoop->u.btree.nBtm);
drh6f82e852015-06-06 20:12:09 +00001566 /* Like optimization range constraints always occur in pairs */
1567 assert( (pRangeStart->wtFlags & TERM_LIKEOPT)==0 ||
1568 (pLoop->wsFlags & WHERE_TOP_LIMIT)!=0 );
1569 }
1570 if( pLoop->wsFlags & WHERE_TOP_LIMIT ){
1571 pRangeEnd = pLoop->aLTerm[j++];
dan71c57db2016-07-09 20:23:55 +00001572 nExtraReg = MAX(nExtraReg, pLoop->u.btree.nTop);
drh41d2e662015-12-01 21:23:07 +00001573#ifndef SQLITE_LIKE_DOESNT_MATCH_BLOBS
drh6f82e852015-06-06 20:12:09 +00001574 if( (pRangeEnd->wtFlags & TERM_LIKEOPT)!=0 ){
1575 assert( pRangeStart!=0 ); /* LIKE opt constraints */
1576 assert( pRangeStart->wtFlags & TERM_LIKEOPT ); /* occur in pairs */
drh44aebff2016-05-02 10:25:42 +00001577 pLevel->iLikeRepCntr = (u32)++pParse->nMem;
1578 sqlite3VdbeAddOp2(v, OP_Integer, 1, (int)pLevel->iLikeRepCntr);
drh6f82e852015-06-06 20:12:09 +00001579 VdbeComment((v, "LIKE loop counter"));
1580 pLevel->addrLikeRep = sqlite3VdbeCurrentAddr(v);
drh44aebff2016-05-02 10:25:42 +00001581 /* iLikeRepCntr actually stores 2x the counter register number. The
1582 ** bottom bit indicates whether the search order is ASC or DESC. */
1583 testcase( bRev );
1584 testcase( pIdx->aSortOrder[nEq]==SQLITE_SO_DESC );
1585 assert( (bRev & ~1)==0 );
1586 pLevel->iLikeRepCntr <<=1;
1587 pLevel->iLikeRepCntr |= bRev ^ (pIdx->aSortOrder[nEq]==SQLITE_SO_DESC);
drh6f82e852015-06-06 20:12:09 +00001588 }
drh41d2e662015-12-01 21:23:07 +00001589#endif
drh48590fc2016-10-10 13:29:15 +00001590 if( pRangeStart==0 ){
1591 j = pIdx->aiColumn[nEq];
1592 if( (j>=0 && pIdx->pTable->aCol[j].notNull==0) || j==XN_EXPR ){
1593 bSeekPastNull = 1;
1594 }
drh6f82e852015-06-06 20:12:09 +00001595 }
1596 }
1597 assert( pRangeEnd==0 || (pRangeEnd->wtFlags & TERM_VNULL)==0 );
1598
dan15750a22019-08-16 21:07:19 +00001599 /* If the WHERE_BIGNULL_SORT flag is set, then index column nEq uses
1600 ** a non-default "big-null" sort (either ASC NULLS LAST or DESC NULLS
1601 ** FIRST). In both cases separate ordered scans are made of those
1602 ** index entries for which the column is null and for those for which
1603 ** it is not. For an ASC sort, the non-NULL entries are scanned first.
1604 ** For DESC, NULL entries are scanned first.
1605 */
dan15750a22019-08-16 21:07:19 +00001606 if( (pLoop->wsFlags & (WHERE_TOP_LIMIT|WHERE_BTM_LIMIT))==0
1607 && (pLoop->wsFlags & WHERE_BIGNULL_SORT)!=0
1608 ){
1609 assert( bSeekPastNull==0 && nExtraReg==0 && nBtm==0 && nTop==0 );
1610 assert( pRangeEnd==0 && pRangeStart==0 );
1611 assert( pLoop->nSkip==0 );
1612 nExtraReg = 1;
1613 bSeekPastNull = 1;
1614 pLevel->regBignull = regBignull = ++pParse->nMem;
dancc491f42019-08-17 17:55:54 +00001615 pLevel->addrBignull = sqlite3VdbeMakeLabel(pParse);
dan15750a22019-08-16 21:07:19 +00001616 }
1617
drh6f82e852015-06-06 20:12:09 +00001618 /* If we are doing a reverse order scan on an ascending index, or
1619 ** a forward order scan on a descending index, interchange the
1620 ** start and end terms (pRangeStart and pRangeEnd).
1621 */
1622 if( (nEq<pIdx->nKeyCol && bRev==(pIdx->aSortOrder[nEq]==SQLITE_SO_ASC))
1623 || (bRev && pIdx->nKeyCol==nEq)
1624 ){
1625 SWAP(WhereTerm *, pRangeEnd, pRangeStart);
1626 SWAP(u8, bSeekPastNull, bStopAtNull);
dan71c57db2016-07-09 20:23:55 +00001627 SWAP(u8, nBtm, nTop);
drh6f82e852015-06-06 20:12:09 +00001628 }
1629
drhbcf40a72015-08-18 15:58:05 +00001630 /* Generate code to evaluate all constraint terms using == or IN
1631 ** and store the values of those terms in an array of registers
1632 ** starting at regBase.
1633 */
danb324cf72016-06-17 14:33:32 +00001634 codeCursorHint(pTabItem, pWInfo, pLevel, pRangeEnd);
drhbcf40a72015-08-18 15:58:05 +00001635 regBase = codeAllEqualityTerms(pParse,pLevel,bRev,nExtraReg,&zStartAff);
1636 assert( zStartAff==0 || sqlite3Strlen30(zStartAff)>=nEq );
danb7ca2172016-08-26 17:54:46 +00001637 if( zStartAff && nTop ){
1638 zEndAff = sqlite3DbStrDup(db, &zStartAff[nEq]);
1639 }
dancc491f42019-08-17 17:55:54 +00001640 addrNxt = (regBignull ? pLevel->addrBignull : pLevel->addrNxt);
drhbcf40a72015-08-18 15:58:05 +00001641
drh6f82e852015-06-06 20:12:09 +00001642 testcase( pRangeStart && (pRangeStart->eOperator & WO_LE)!=0 );
1643 testcase( pRangeStart && (pRangeStart->eOperator & WO_GE)!=0 );
1644 testcase( pRangeEnd && (pRangeEnd->eOperator & WO_LE)!=0 );
1645 testcase( pRangeEnd && (pRangeEnd->eOperator & WO_GE)!=0 );
1646 startEq = !pRangeStart || pRangeStart->eOperator & (WO_LE|WO_GE);
1647 endEq = !pRangeEnd || pRangeEnd->eOperator & (WO_LE|WO_GE);
1648 start_constraints = pRangeStart || nEq>0;
1649
1650 /* Seek the index cursor to the start of the range. */
1651 nConstraint = nEq;
1652 if( pRangeStart ){
1653 Expr *pRight = pRangeStart->pExpr->pRight;
dan71c57db2016-07-09 20:23:55 +00001654 codeExprOrVector(pParse, pRight, regBase+nEq, nBtm);
drh6f82e852015-06-06 20:12:09 +00001655 whereLikeOptimizationStringFixup(v, pLevel, pRangeStart);
1656 if( (pRangeStart->wtFlags & TERM_VNULL)==0
1657 && sqlite3ExprCanBeNull(pRight)
1658 ){
1659 sqlite3VdbeAddOp2(v, OP_IsNull, regBase+nEq, addrNxt);
1660 VdbeCoverage(v);
1661 }
1662 if( zStartAff ){
drhe3c6b612016-10-05 20:10:32 +00001663 updateRangeAffinityStr(pRight, nBtm, &zStartAff[nEq]);
drh6f82e852015-06-06 20:12:09 +00001664 }
dan71c57db2016-07-09 20:23:55 +00001665 nConstraint += nBtm;
drh6f82e852015-06-06 20:12:09 +00001666 testcase( pRangeStart->wtFlags & TERM_VIRTUAL );
dan625015e2016-07-30 16:39:28 +00001667 if( sqlite3ExprIsVector(pRight)==0 ){
dan71c57db2016-07-09 20:23:55 +00001668 disableTerm(pLevel, pRangeStart);
1669 }else{
1670 startEq = 1;
1671 }
drh426f4ab2016-07-26 04:31:14 +00001672 bSeekPastNull = 0;
drh6f82e852015-06-06 20:12:09 +00001673 }else if( bSeekPastNull ){
drh6f82e852015-06-06 20:12:09 +00001674 startEq = 0;
drh0086e072019-08-23 16:12:20 +00001675 sqlite3VdbeAddOp2(v, OP_Null, 0, regBase+nEq);
drh6f82e852015-06-06 20:12:09 +00001676 start_constraints = 1;
drh0086e072019-08-23 16:12:20 +00001677 nConstraint++;
dan15750a22019-08-16 21:07:19 +00001678 }else if( regBignull ){
1679 sqlite3VdbeAddOp2(v, OP_Null, 0, regBase+nEq);
1680 start_constraints = 1;
1681 nConstraint++;
drh6f82e852015-06-06 20:12:09 +00001682 }
1683 codeApplyAffinity(pParse, regBase, nConstraint - bSeekPastNull, zStartAff);
drh0bf2ad62016-02-22 21:19:54 +00001684 if( pLoop->nSkip>0 && nConstraint==pLoop->nSkip ){
1685 /* The skip-scan logic inside the call to codeAllEqualityConstraints()
1686 ** above has already left the cursor sitting on the correct row,
1687 ** so no further seeking is needed */
1688 }else{
drhf7b0a5f2018-06-07 14:59:22 +00001689 if( pLoop->wsFlags & WHERE_IN_EARLYOUT ){
drh8c2b6d72018-06-05 20:45:20 +00001690 sqlite3VdbeAddOp1(v, OP_SeekHit, iIdxCur);
1691 }
dan15750a22019-08-16 21:07:19 +00001692 if( regBignull ){
drhec3dda52019-08-23 13:32:03 +00001693 sqlite3VdbeAddOp2(v, OP_Integer, 1, regBignull);
drha31d3552019-08-23 17:09:02 +00001694 VdbeComment((v, "NULL-scan pass ctr"));
dan15750a22019-08-16 21:07:19 +00001695 }
1696
drha6d2f8e2016-02-22 20:52:26 +00001697 op = aStartOp[(start_constraints<<2) + (startEq<<1) + bRev];
1698 assert( op!=0 );
1699 sqlite3VdbeAddOp4Int(v, op, iIdxCur, addrNxt, regBase, nConstraint);
1700 VdbeCoverage(v);
1701 VdbeCoverageIf(v, op==OP_Rewind); testcase( op==OP_Rewind );
1702 VdbeCoverageIf(v, op==OP_Last); testcase( op==OP_Last );
1703 VdbeCoverageIf(v, op==OP_SeekGT); testcase( op==OP_SeekGT );
1704 VdbeCoverageIf(v, op==OP_SeekGE); testcase( op==OP_SeekGE );
1705 VdbeCoverageIf(v, op==OP_SeekLE); testcase( op==OP_SeekLE );
1706 VdbeCoverageIf(v, op==OP_SeekLT); testcase( op==OP_SeekLT );
danddd74212019-08-02 18:43:59 +00001707
drh0086e072019-08-23 16:12:20 +00001708 assert( bSeekPastNull==0 || bStopAtNull==0 );
dan15750a22019-08-16 21:07:19 +00001709 if( regBignull ){
drh0086e072019-08-23 16:12:20 +00001710 assert( bSeekPastNull==1 || bStopAtNull==1 );
drh5f6a4ea2019-08-23 17:00:22 +00001711 assert( bSeekPastNull==!bStopAtNull );
drh0086e072019-08-23 16:12:20 +00001712 assert( bStopAtNull==startEq );
danddd74212019-08-02 18:43:59 +00001713 sqlite3VdbeAddOp2(v, OP_Goto, 0, sqlite3VdbeCurrentAddr(v)+2);
drh0086e072019-08-23 16:12:20 +00001714 op = aStartOp[(nConstraint>1)*4 + 2 + bRev];
1715 sqlite3VdbeAddOp4Int(v, op, iIdxCur, addrNxt, regBase,
1716 nConstraint-startEq);
1717 VdbeCoverage(v);
1718 VdbeCoverageIf(v, op==OP_Rewind); testcase( op==OP_Rewind );
1719 VdbeCoverageIf(v, op==OP_Last); testcase( op==OP_Last );
1720 VdbeCoverageIf(v, op==OP_SeekGE); testcase( op==OP_SeekGE );
1721 VdbeCoverageIf(v, op==OP_SeekLE); testcase( op==OP_SeekLE );
1722 assert( op==OP_Rewind || op==OP_Last || op==OP_SeekGE || op==OP_SeekLE);
danddd74212019-08-02 18:43:59 +00001723 }
drha6d2f8e2016-02-22 20:52:26 +00001724 }
drh0bf2ad62016-02-22 21:19:54 +00001725
drh6f82e852015-06-06 20:12:09 +00001726 /* Load the value for the inequality constraint at the end of the
1727 ** range (if any).
1728 */
1729 nConstraint = nEq;
1730 if( pRangeEnd ){
1731 Expr *pRight = pRangeEnd->pExpr->pRight;
dan71c57db2016-07-09 20:23:55 +00001732 codeExprOrVector(pParse, pRight, regBase+nEq, nTop);
drh6f82e852015-06-06 20:12:09 +00001733 whereLikeOptimizationStringFixup(v, pLevel, pRangeEnd);
1734 if( (pRangeEnd->wtFlags & TERM_VNULL)==0
1735 && sqlite3ExprCanBeNull(pRight)
1736 ){
1737 sqlite3VdbeAddOp2(v, OP_IsNull, regBase+nEq, addrNxt);
1738 VdbeCoverage(v);
1739 }
drh0c36fca2016-08-26 18:17:08 +00001740 if( zEndAff ){
drhe3c6b612016-10-05 20:10:32 +00001741 updateRangeAffinityStr(pRight, nTop, zEndAff);
drh0c36fca2016-08-26 18:17:08 +00001742 codeApplyAffinity(pParse, regBase+nEq, nTop, zEndAff);
1743 }else{
1744 assert( pParse->db->mallocFailed );
1745 }
dan71c57db2016-07-09 20:23:55 +00001746 nConstraint += nTop;
drh6f82e852015-06-06 20:12:09 +00001747 testcase( pRangeEnd->wtFlags & TERM_VIRTUAL );
dan71c57db2016-07-09 20:23:55 +00001748
dan625015e2016-07-30 16:39:28 +00001749 if( sqlite3ExprIsVector(pRight)==0 ){
dan71c57db2016-07-09 20:23:55 +00001750 disableTerm(pLevel, pRangeEnd);
1751 }else{
1752 endEq = 1;
1753 }
drh6f82e852015-06-06 20:12:09 +00001754 }else if( bStopAtNull ){
dan15750a22019-08-16 21:07:19 +00001755 if( regBignull==0 ){
1756 sqlite3VdbeAddOp2(v, OP_Null, 0, regBase+nEq);
1757 endEq = 0;
1758 }
drh6f82e852015-06-06 20:12:09 +00001759 nConstraint++;
1760 }
1761 sqlite3DbFree(db, zStartAff);
danb7ca2172016-08-26 17:54:46 +00001762 sqlite3DbFree(db, zEndAff);
drh6f82e852015-06-06 20:12:09 +00001763
1764 /* Top of the loop body */
1765 pLevel->p2 = sqlite3VdbeCurrentAddr(v);
1766
1767 /* Check if the index cursor is past the end of the range. */
1768 if( nConstraint ){
dan15750a22019-08-16 21:07:19 +00001769 if( regBignull ){
drh5f6a4ea2019-08-23 17:00:22 +00001770 /* Except, skip the end-of-range check while doing the NULL-scan */
drhec3dda52019-08-23 13:32:03 +00001771 sqlite3VdbeAddOp2(v, OP_IfNot, regBignull, sqlite3VdbeCurrentAddr(v)+3);
drha31d3552019-08-23 17:09:02 +00001772 VdbeComment((v, "If NULL-scan 2nd pass"));
drh505ae9d2019-08-22 21:13:56 +00001773 VdbeCoverage(v);
dan15750a22019-08-16 21:07:19 +00001774 }
drh6f82e852015-06-06 20:12:09 +00001775 op = aEndOp[bRev*2 + endEq];
1776 sqlite3VdbeAddOp4Int(v, op, iIdxCur, addrNxt, regBase, nConstraint);
1777 testcase( op==OP_IdxGT ); VdbeCoverageIf(v, op==OP_IdxGT );
1778 testcase( op==OP_IdxGE ); VdbeCoverageIf(v, op==OP_IdxGE );
1779 testcase( op==OP_IdxLT ); VdbeCoverageIf(v, op==OP_IdxLT );
1780 testcase( op==OP_IdxLE ); VdbeCoverageIf(v, op==OP_IdxLE );
1781 }
dan15750a22019-08-16 21:07:19 +00001782 if( regBignull ){
drh5f6a4ea2019-08-23 17:00:22 +00001783 /* During a NULL-scan, check to see if we have reached the end of
1784 ** the NULLs */
1785 assert( bSeekPastNull==!bStopAtNull );
1786 assert( bSeekPastNull+bStopAtNull==1 );
1787 assert( nConstraint+bSeekPastNull>0 );
drhec3dda52019-08-23 13:32:03 +00001788 sqlite3VdbeAddOp2(v, OP_If, regBignull, sqlite3VdbeCurrentAddr(v)+2);
drha31d3552019-08-23 17:09:02 +00001789 VdbeComment((v, "If NULL-scan 1st pass"));
drh505ae9d2019-08-22 21:13:56 +00001790 VdbeCoverage(v);
drh5f6a4ea2019-08-23 17:00:22 +00001791 op = aEndOp[bRev*2 + bSeekPastNull];
1792 sqlite3VdbeAddOp4Int(v, op, iIdxCur, addrNxt, regBase,
1793 nConstraint+bSeekPastNull);
1794 testcase( op==OP_IdxGT ); VdbeCoverageIf(v, op==OP_IdxGT );
1795 testcase( op==OP_IdxGE ); VdbeCoverageIf(v, op==OP_IdxGE );
1796 testcase( op==OP_IdxLT ); VdbeCoverageIf(v, op==OP_IdxLT );
1797 testcase( op==OP_IdxLE ); VdbeCoverageIf(v, op==OP_IdxLE );
dan15750a22019-08-16 21:07:19 +00001798 }
drh6f82e852015-06-06 20:12:09 +00001799
drhf7b0a5f2018-06-07 14:59:22 +00001800 if( pLoop->wsFlags & WHERE_IN_EARLYOUT ){
drh8c2b6d72018-06-05 20:45:20 +00001801 sqlite3VdbeAddOp2(v, OP_SeekHit, iIdxCur, 1);
1802 }
1803
drh6f82e852015-06-06 20:12:09 +00001804 /* Seek the table cursor, if required */
drh47df8a22018-12-25 00:15:37 +00001805 omitTable = (pLoop->wsFlags & WHERE_IDX_ONLY)!=0
1806 && (pWInfo->wctrlFlags & WHERE_OR_SUBCLAUSE)==0;
drh6f82e852015-06-06 20:12:09 +00001807 if( omitTable ){
1808 /* pIdx is a covering index. No need to access the main table. */
1809 }else if( HasRowid(pIdx->pTable) ){
danf64ece12017-01-28 19:45:34 +00001810 if( (pWInfo->wctrlFlags & WHERE_SEEK_TABLE) || (
1811 (pWInfo->wctrlFlags & WHERE_SEEK_UNIQ_TABLE)
1812 && (pWInfo->eOnePass==ONEPASS_SINGLE)
1813 )){
drh784c1b92016-01-30 16:59:56 +00001814 iRowidReg = ++pParse->nMem;
1815 sqlite3VdbeAddOp2(v, OP_IdxRowid, iIdxCur, iRowidReg);
danc6157e12015-09-14 09:23:47 +00001816 sqlite3VdbeAddOp3(v, OP_NotExists, iCur, 0, iRowidReg);
drh66336f32015-09-14 14:08:25 +00001817 VdbeCoverage(v);
danc6157e12015-09-14 09:23:47 +00001818 }else{
drh784c1b92016-01-30 16:59:56 +00001819 codeDeferredSeek(pWInfo, pIdx, iCur, iIdxCur);
danc6157e12015-09-14 09:23:47 +00001820 }
drh6f82e852015-06-06 20:12:09 +00001821 }else if( iCur!=iIdxCur ){
1822 Index *pPk = sqlite3PrimaryKeyIndex(pIdx->pTable);
1823 iRowidReg = sqlite3GetTempRange(pParse, pPk->nKeyCol);
1824 for(j=0; j<pPk->nKeyCol; j++){
1825 k = sqlite3ColumnOfIndex(pIdx, pPk->aiColumn[j]);
1826 sqlite3VdbeAddOp3(v, OP_Column, iIdxCur, k, iRowidReg+j);
1827 }
1828 sqlite3VdbeAddOp4Int(v, OP_NotFound, iCur, addrCont,
1829 iRowidReg, pPk->nKeyCol); VdbeCoverage(v);
1830 }
1831
drheac5fc02017-04-11 01:01:27 +00001832 /* If pIdx is an index on one or more expressions, then look through
1833 ** all the expressions in pWInfo and try to transform matching expressions
1834 ** into reference to index columns.
dan4da04f72018-04-24 14:05:14 +00001835 **
1836 ** Do not do this for the RHS of a LEFT JOIN. This is because the
1837 ** expression may be evaluated after OP_NullRow has been executed on
1838 ** the cursor. In this case it is important to do the full evaluation,
1839 ** as the result of the expression may not be NULL, even if all table
drh5776c132018-04-24 14:18:49 +00001840 ** column values are. https://www.sqlite.org/src/info/7fa8049685b50b5a
drh8851e102019-02-08 04:15:19 +00001841 **
1842 ** Also, do not do this when processing one index an a multi-index
1843 ** OR clause, since the transformation will become invalid once we
1844 ** move forward to the next index.
1845 ** https://sqlite.org/src/info/4e8e4857d32d401f
drheac5fc02017-04-11 01:01:27 +00001846 */
drh8851e102019-02-08 04:15:19 +00001847 if( pLevel->iLeftJoin==0 && (pWInfo->wctrlFlags & WHERE_OR_SUBCLAUSE)==0 ){
dan4da04f72018-04-24 14:05:14 +00001848 whereIndexExprTrans(pIdx, iCur, iIdxCur, pWInfo);
1849 }
drhaca19e12017-04-07 19:41:31 +00001850
drhb531aa82019-03-01 18:07:05 +00001851 /* If a partial index is driving the loop, try to eliminate WHERE clause
1852 ** terms from the query that must be true due to the WHERE clause of
1853 ** the partial index
1854 */
1855 if( pIdx->pPartIdxWhere ){
1856 whereApplyPartialIndexConstraints(pIdx->pPartIdxWhere, iCur, pWC);
1857 }
1858
dan71c57db2016-07-09 20:23:55 +00001859 /* Record the instruction used to terminate the loop. */
drh6f82e852015-06-06 20:12:09 +00001860 if( pLoop->wsFlags & WHERE_ONEROW ){
1861 pLevel->op = OP_Noop;
1862 }else if( bRev ){
1863 pLevel->op = OP_Prev;
1864 }else{
1865 pLevel->op = OP_Next;
1866 }
1867 pLevel->p1 = iIdxCur;
1868 pLevel->p3 = (pLoop->wsFlags&WHERE_UNQ_WANTED)!=0 ? 1:0;
1869 if( (pLoop->wsFlags & WHERE_CONSTRAINT)==0 ){
1870 pLevel->p5 = SQLITE_STMTSTATUS_FULLSCAN_STEP;
1871 }else{
1872 assert( pLevel->p5==0 );
1873 }
dan6f654a42017-04-28 19:59:55 +00001874 if( omitTable ) pIdx = 0;
drh6f82e852015-06-06 20:12:09 +00001875 }else
1876
1877#ifndef SQLITE_OMIT_OR_OPTIMIZATION
1878 if( pLoop->wsFlags & WHERE_MULTI_OR ){
1879 /* Case 5: Two or more separately indexed terms connected by OR
1880 **
1881 ** Example:
1882 **
1883 ** CREATE TABLE t1(a,b,c,d);
1884 ** CREATE INDEX i1 ON t1(a);
1885 ** CREATE INDEX i2 ON t1(b);
1886 ** CREATE INDEX i3 ON t1(c);
1887 **
1888 ** SELECT * FROM t1 WHERE a=5 OR b=7 OR (c=11 AND d=13)
1889 **
1890 ** In the example, there are three indexed terms connected by OR.
1891 ** The top of the loop looks like this:
1892 **
1893 ** Null 1 # Zero the rowset in reg 1
1894 **
1895 ** Then, for each indexed term, the following. The arguments to
1896 ** RowSetTest are such that the rowid of the current row is inserted
1897 ** into the RowSet. If it is already present, control skips the
1898 ** Gosub opcode and jumps straight to the code generated by WhereEnd().
1899 **
1900 ** sqlite3WhereBegin(<term>)
1901 ** RowSetTest # Insert rowid into rowset
1902 ** Gosub 2 A
1903 ** sqlite3WhereEnd()
1904 **
1905 ** Following the above, code to terminate the loop. Label A, the target
1906 ** of the Gosub above, jumps to the instruction right after the Goto.
1907 **
1908 ** Null 1 # Zero the rowset in reg 1
1909 ** Goto B # The loop is finished.
1910 **
1911 ** A: <loop body> # Return data, whatever.
1912 **
1913 ** Return 2 # Jump back to the Gosub
1914 **
1915 ** B: <after the loop>
1916 **
1917 ** Added 2014-05-26: If the table is a WITHOUT ROWID table, then
1918 ** use an ephemeral index instead of a RowSet to record the primary
1919 ** keys of the rows we have already seen.
1920 **
1921 */
1922 WhereClause *pOrWc; /* The OR-clause broken out into subterms */
1923 SrcList *pOrTab; /* Shortened table list or OR-clause generation */
1924 Index *pCov = 0; /* Potential covering index (or NULL) */
1925 int iCovCur = pParse->nTab++; /* Cursor used for index scans (if any) */
1926
1927 int regReturn = ++pParse->nMem; /* Register used with OP_Gosub */
1928 int regRowset = 0; /* Register for RowSet object */
1929 int regRowid = 0; /* Register holding rowid */
drhec4ccdb2018-12-29 02:26:59 +00001930 int iLoopBody = sqlite3VdbeMakeLabel(pParse);/* Start of loop body */
drh6f82e852015-06-06 20:12:09 +00001931 int iRetInit; /* Address of regReturn init */
1932 int untestedTerms = 0; /* Some terms not completely tested */
1933 int ii; /* Loop counter */
1934 u16 wctrlFlags; /* Flags for sub-WHERE clause */
1935 Expr *pAndExpr = 0; /* An ".. AND (...)" expression */
1936 Table *pTab = pTabItem->pTab;
dan145b4ea2016-07-29 18:12:12 +00001937
drh6f82e852015-06-06 20:12:09 +00001938 pTerm = pLoop->aLTerm[0];
1939 assert( pTerm!=0 );
1940 assert( pTerm->eOperator & WO_OR );
1941 assert( (pTerm->wtFlags & TERM_ORINFO)!=0 );
1942 pOrWc = &pTerm->u.pOrInfo->wc;
1943 pLevel->op = OP_Return;
1944 pLevel->p1 = regReturn;
1945
1946 /* Set up a new SrcList in pOrTab containing the table being scanned
1947 ** by this loop in the a[0] slot and all notReady tables in a[1..] slots.
1948 ** This becomes the SrcList in the recursive call to sqlite3WhereBegin().
1949 */
1950 if( pWInfo->nLevel>1 ){
1951 int nNotReady; /* The number of notReady tables */
1952 struct SrcList_item *origSrc; /* Original list of tables */
1953 nNotReady = pWInfo->nLevel - iLevel - 1;
1954 pOrTab = sqlite3StackAllocRaw(db,
1955 sizeof(*pOrTab)+ nNotReady*sizeof(pOrTab->a[0]));
1956 if( pOrTab==0 ) return notReady;
1957 pOrTab->nAlloc = (u8)(nNotReady + 1);
1958 pOrTab->nSrc = pOrTab->nAlloc;
1959 memcpy(pOrTab->a, pTabItem, sizeof(*pTabItem));
1960 origSrc = pWInfo->pTabList->a;
1961 for(k=1; k<=nNotReady; k++){
1962 memcpy(&pOrTab->a[k], &origSrc[pLevel[k].iFrom], sizeof(pOrTab->a[k]));
1963 }
1964 }else{
1965 pOrTab = pWInfo->pTabList;
1966 }
1967
1968 /* Initialize the rowset register to contain NULL. An SQL NULL is
1969 ** equivalent to an empty rowset. Or, create an ephemeral index
1970 ** capable of holding primary keys in the case of a WITHOUT ROWID.
1971 **
1972 ** Also initialize regReturn to contain the address of the instruction
1973 ** immediately following the OP_Return at the bottom of the loop. This
1974 ** is required in a few obscure LEFT JOIN cases where control jumps
1975 ** over the top of the loop into the body of it. In this case the
1976 ** correct response for the end-of-loop code (the OP_Return) is to
1977 ** fall through to the next instruction, just as an OP_Next does if
1978 ** called on an uninitialized cursor.
1979 */
1980 if( (pWInfo->wctrlFlags & WHERE_DUPLICATES_OK)==0 ){
1981 if( HasRowid(pTab) ){
1982 regRowset = ++pParse->nMem;
1983 sqlite3VdbeAddOp2(v, OP_Null, 0, regRowset);
1984 }else{
1985 Index *pPk = sqlite3PrimaryKeyIndex(pTab);
1986 regRowset = pParse->nTab++;
1987 sqlite3VdbeAddOp2(v, OP_OpenEphemeral, regRowset, pPk->nKeyCol);
1988 sqlite3VdbeSetP4KeyInfo(pParse, pPk);
1989 }
1990 regRowid = ++pParse->nMem;
1991 }
1992 iRetInit = sqlite3VdbeAddOp2(v, OP_Integer, 0, regReturn);
1993
1994 /* If the original WHERE clause is z of the form: (x1 OR x2 OR ...) AND y
1995 ** Then for every term xN, evaluate as the subexpression: xN AND z
1996 ** That way, terms in y that are factored into the disjunction will
1997 ** be picked up by the recursive calls to sqlite3WhereBegin() below.
1998 **
1999 ** Actually, each subexpression is converted to "xN AND w" where w is
2000 ** the "interesting" terms of z - terms that did not originate in the
2001 ** ON or USING clause of a LEFT JOIN, and terms that are usable as
2002 ** indices.
2003 **
2004 ** This optimization also only applies if the (x1 OR x2 OR ...) term
2005 ** is not contained in the ON clause of a LEFT JOIN.
2006 ** See ticket http://www.sqlite.org/src/info/f2369304e4
2007 */
2008 if( pWC->nTerm>1 ){
2009 int iTerm;
2010 for(iTerm=0; iTerm<pWC->nTerm; iTerm++){
2011 Expr *pExpr = pWC->a[iTerm].pExpr;
2012 if( &pWC->a[iTerm] == pTerm ) continue;
drh3b83f0c2016-01-29 16:57:06 +00002013 testcase( pWC->a[iTerm].wtFlags & TERM_VIRTUAL );
2014 testcase( pWC->a[iTerm].wtFlags & TERM_CODED );
2015 if( (pWC->a[iTerm].wtFlags & (TERM_VIRTUAL|TERM_CODED))!=0 ) continue;
drh6f82e852015-06-06 20:12:09 +00002016 if( (pWC->a[iTerm].eOperator & WO_ALL)==0 ) continue;
2017 testcase( pWC->a[iTerm].wtFlags & TERM_ORINFO );
2018 pExpr = sqlite3ExprDup(db, pExpr, 0);
drhd5c851c2019-04-19 13:38:34 +00002019 pAndExpr = sqlite3ExprAnd(pParse, pAndExpr, pExpr);
drh6f82e852015-06-06 20:12:09 +00002020 }
2021 if( pAndExpr ){
drhf1722ba2019-04-05 20:56:46 +00002022 /* The extra 0x10000 bit on the opcode is masked off and does not
2023 ** become part of the new Expr.op. However, it does make the
2024 ** op==TK_AND comparison inside of sqlite3PExpr() false, and this
2025 ** prevents sqlite3PExpr() from implementing AND short-circuit
2026 ** optimization, which we do not want here. */
2027 pAndExpr = sqlite3PExpr(pParse, TK_AND|0x10000, 0, pAndExpr);
drh6f82e852015-06-06 20:12:09 +00002028 }
2029 }
2030
2031 /* Run a separate WHERE clause for each term of the OR clause. After
2032 ** eliminating duplicates from other WHERE clauses, the action for each
2033 ** sub-WHERE clause is to to invoke the main loop body as a subroutine.
2034 */
drhce943bc2016-05-19 18:56:33 +00002035 wctrlFlags = WHERE_OR_SUBCLAUSE | (pWInfo->wctrlFlags & WHERE_SEEK_TABLE);
drh5d72d922018-05-04 00:39:43 +00002036 ExplainQueryPlan((pParse, 1, "MULTI-INDEX OR"));
drh6f82e852015-06-06 20:12:09 +00002037 for(ii=0; ii<pOrWc->nTerm; ii++){
2038 WhereTerm *pOrTerm = &pOrWc->a[ii];
2039 if( pOrTerm->leftCursor==iCur || (pOrTerm->eOperator & WO_AND)!=0 ){
2040 WhereInfo *pSubWInfo; /* Info for single OR-term scan */
2041 Expr *pOrExpr = pOrTerm->pExpr; /* Current OR clause term */
drh728e0f92015-10-10 14:41:28 +00002042 int jmp1 = 0; /* Address of jump operation */
dan820fcd22018-04-24 18:53:24 +00002043 assert( (pTabItem[0].fg.jointype & JT_LEFT)==0
2044 || ExprHasProperty(pOrExpr, EP_FromJoin)
2045 );
2046 if( pAndExpr ){
drh6f82e852015-06-06 20:12:09 +00002047 pAndExpr->pLeft = pOrExpr;
2048 pOrExpr = pAndExpr;
2049 }
2050 /* Loop through table entries that match term pOrTerm. */
drhbd462bc2018-12-24 20:21:06 +00002051 ExplainQueryPlan((pParse, 1, "INDEX %d", ii+1));
drh6f82e852015-06-06 20:12:09 +00002052 WHERETRACE(0xffff, ("Subplan for OR-clause:\n"));
2053 pSubWInfo = sqlite3WhereBegin(pParse, pOrTab, pOrExpr, 0, 0,
2054 wctrlFlags, iCovCur);
2055 assert( pSubWInfo || pParse->nErr || db->mallocFailed );
2056 if( pSubWInfo ){
2057 WhereLoop *pSubLoop;
2058 int addrExplain = sqlite3WhereExplainOneScan(
drhe2188f02018-05-07 11:37:34 +00002059 pParse, pOrTab, &pSubWInfo->a[0], 0
drh6f82e852015-06-06 20:12:09 +00002060 );
2061 sqlite3WhereAddScanStatus(v, pOrTab, &pSubWInfo->a[0], addrExplain);
2062
2063 /* This is the sub-WHERE clause body. First skip over
2064 ** duplicate rows from prior sub-WHERE clauses, and record the
2065 ** rowid (or PRIMARY KEY) for the current row so that the same
2066 ** row will be skipped in subsequent sub-WHERE clauses.
2067 */
2068 if( (pWInfo->wctrlFlags & WHERE_DUPLICATES_OK)==0 ){
drh6f82e852015-06-06 20:12:09 +00002069 int iSet = ((ii==pOrWc->nTerm-1)?-1:ii);
2070 if( HasRowid(pTab) ){
drh8c607192018-08-04 15:53:55 +00002071 sqlite3ExprCodeGetColumnOfTable(v, pTab, iCur, -1, regRowid);
drh728e0f92015-10-10 14:41:28 +00002072 jmp1 = sqlite3VdbeAddOp4Int(v, OP_RowSetTest, regRowset, 0,
drh8c607192018-08-04 15:53:55 +00002073 regRowid, iSet);
drh6f82e852015-06-06 20:12:09 +00002074 VdbeCoverage(v);
2075 }else{
2076 Index *pPk = sqlite3PrimaryKeyIndex(pTab);
2077 int nPk = pPk->nKeyCol;
2078 int iPk;
drh8c607192018-08-04 15:53:55 +00002079 int r;
drh6f82e852015-06-06 20:12:09 +00002080
2081 /* Read the PK into an array of temp registers. */
2082 r = sqlite3GetTempRange(pParse, nPk);
2083 for(iPk=0; iPk<nPk; iPk++){
2084 int iCol = pPk->aiColumn[iPk];
drh8c607192018-08-04 15:53:55 +00002085 sqlite3ExprCodeGetColumnOfTable(v, pTab, iCur, iCol, r+iPk);
drh6f82e852015-06-06 20:12:09 +00002086 }
2087
2088 /* Check if the temp table already contains this key. If so,
2089 ** the row has already been included in the result set and
2090 ** can be ignored (by jumping past the Gosub below). Otherwise,
2091 ** insert the key into the temp table and proceed with processing
2092 ** the row.
2093 **
2094 ** Use some of the same optimizations as OP_RowSetTest: If iSet
2095 ** is zero, assume that the key cannot already be present in
2096 ** the temp table. And if iSet is -1, assume that there is no
2097 ** need to insert the key into the temp table, as it will never
2098 ** be tested for. */
2099 if( iSet ){
drh728e0f92015-10-10 14:41:28 +00002100 jmp1 = sqlite3VdbeAddOp4Int(v, OP_Found, regRowset, 0, r, nPk);
drh6f82e852015-06-06 20:12:09 +00002101 VdbeCoverage(v);
2102 }
2103 if( iSet>=0 ){
2104 sqlite3VdbeAddOp3(v, OP_MakeRecord, r, nPk, regRowid);
drh9b4eaeb2016-11-09 00:10:33 +00002105 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, regRowset, regRowid,
2106 r, nPk);
drh6f82e852015-06-06 20:12:09 +00002107 if( iSet ) sqlite3VdbeChangeP5(v, OPFLAG_USESEEKRESULT);
2108 }
2109
2110 /* Release the array of temp registers */
2111 sqlite3ReleaseTempRange(pParse, r, nPk);
2112 }
2113 }
2114
2115 /* Invoke the main loop body as a subroutine */
2116 sqlite3VdbeAddOp2(v, OP_Gosub, regReturn, iLoopBody);
2117
2118 /* Jump here (skipping the main loop body subroutine) if the
2119 ** current sub-WHERE row is a duplicate from prior sub-WHEREs. */
drh728e0f92015-10-10 14:41:28 +00002120 if( jmp1 ) sqlite3VdbeJumpHere(v, jmp1);
drh6f82e852015-06-06 20:12:09 +00002121
2122 /* The pSubWInfo->untestedTerms flag means that this OR term
2123 ** contained one or more AND term from a notReady table. The
2124 ** terms from the notReady table could not be tested and will
2125 ** need to be tested later.
2126 */
2127 if( pSubWInfo->untestedTerms ) untestedTerms = 1;
2128
2129 /* If all of the OR-connected terms are optimized using the same
2130 ** index, and the index is opened using the same cursor number
2131 ** by each call to sqlite3WhereBegin() made by this loop, it may
2132 ** be possible to use that index as a covering index.
2133 **
2134 ** If the call to sqlite3WhereBegin() above resulted in a scan that
2135 ** uses an index, and this is either the first OR-connected term
2136 ** processed or the index is the same as that used by all previous
2137 ** terms, set pCov to the candidate covering index. Otherwise, set
2138 ** pCov to NULL to indicate that no candidate covering index will
2139 ** be available.
2140 */
2141 pSubLoop = pSubWInfo->a[0].pWLoop;
2142 assert( (pSubLoop->wsFlags & WHERE_AUTO_INDEX)==0 );
2143 if( (pSubLoop->wsFlags & WHERE_INDEXED)!=0
2144 && (ii==0 || pSubLoop->u.btree.pIndex==pCov)
2145 && (HasRowid(pTab) || !IsPrimaryKeyIndex(pSubLoop->u.btree.pIndex))
2146 ){
2147 assert( pSubWInfo->a[0].iIdxCur==iCovCur );
2148 pCov = pSubLoop->u.btree.pIndex;
drh6f82e852015-06-06 20:12:09 +00002149 }else{
2150 pCov = 0;
2151 }
2152
2153 /* Finish the loop through table entries that match term pOrTerm. */
2154 sqlite3WhereEnd(pSubWInfo);
drhbd462bc2018-12-24 20:21:06 +00002155 ExplainQueryPlanPop(pParse);
drh6f82e852015-06-06 20:12:09 +00002156 }
2157 }
2158 }
drh5d72d922018-05-04 00:39:43 +00002159 ExplainQueryPlanPop(pParse);
drh6f82e852015-06-06 20:12:09 +00002160 pLevel->u.pCovidx = pCov;
2161 if( pCov ) pLevel->iIdxCur = iCovCur;
2162 if( pAndExpr ){
2163 pAndExpr->pLeft = 0;
2164 sqlite3ExprDelete(db, pAndExpr);
2165 }
2166 sqlite3VdbeChangeP1(v, iRetInit, sqlite3VdbeCurrentAddr(v));
drh076e85f2015-09-03 13:46:12 +00002167 sqlite3VdbeGoto(v, pLevel->addrBrk);
drh6f82e852015-06-06 20:12:09 +00002168 sqlite3VdbeResolveLabel(v, iLoopBody);
2169
drhdd2d9a32019-05-07 17:47:43 +00002170 if( pWInfo->nLevel>1 ){ sqlite3StackFree(db, pOrTab); }
drh6f82e852015-06-06 20:12:09 +00002171 if( !untestedTerms ) disableTerm(pLevel, pTerm);
2172 }else
2173#endif /* SQLITE_OMIT_OR_OPTIMIZATION */
2174
2175 {
2176 /* Case 6: There is no usable index. We must do a complete
2177 ** scan of the entire table.
2178 */
2179 static const u8 aStep[] = { OP_Next, OP_Prev };
2180 static const u8 aStart[] = { OP_Rewind, OP_Last };
2181 assert( bRev==0 || bRev==1 );
drh8a48b9c2015-08-19 15:20:00 +00002182 if( pTabItem->fg.isRecursive ){
drh6f82e852015-06-06 20:12:09 +00002183 /* Tables marked isRecursive have only a single row that is stored in
2184 ** a pseudo-cursor. No need to Rewind or Next such cursors. */
2185 pLevel->op = OP_Noop;
2186 }else{
danb324cf72016-06-17 14:33:32 +00002187 codeCursorHint(pTabItem, pWInfo, pLevel, 0);
drh6f82e852015-06-06 20:12:09 +00002188 pLevel->op = aStep[bRev];
2189 pLevel->p1 = iCur;
drh3a3b4202017-02-15 22:36:15 +00002190 pLevel->p2 = 1 + sqlite3VdbeAddOp2(v, aStart[bRev], iCur, addrHalt);
drh6f82e852015-06-06 20:12:09 +00002191 VdbeCoverageIf(v, bRev==0);
2192 VdbeCoverageIf(v, bRev!=0);
2193 pLevel->p5 = SQLITE_STMTSTATUS_FULLSCAN_STEP;
2194 }
2195 }
2196
2197#ifdef SQLITE_ENABLE_STMT_SCANSTATUS
2198 pLevel->addrVisit = sqlite3VdbeCurrentAddr(v);
2199#endif
2200
2201 /* Insert code to test every subexpression that can be completely
2202 ** computed using the current set of tables.
dan6f654a42017-04-28 19:59:55 +00002203 **
danebc63012017-07-10 14:33:00 +00002204 ** This loop may run between one and three times, depending on the
2205 ** constraints to be generated. The value of stack variable iLoop
2206 ** determines the constraints coded by each iteration, as follows:
2207 **
2208 ** iLoop==1: Code only expressions that are entirely covered by pIdx.
2209 ** iLoop==2: Code remaining expressions that do not contain correlated
2210 ** sub-queries.
2211 ** iLoop==3: Code all remaining expressions.
2212 **
2213 ** An effort is made to skip unnecessary iterations of the loop.
drh6ab3eb52017-04-29 14:56:55 +00002214 */
danebc63012017-07-10 14:33:00 +00002215 iLoop = (pIdx ? 1 : 2);
drh6ab3eb52017-04-29 14:56:55 +00002216 do{
danebc63012017-07-10 14:33:00 +00002217 int iNext = 0; /* Next value for iLoop */
dan6f654a42017-04-28 19:59:55 +00002218 for(pTerm=pWC->a, j=pWC->nTerm; j>0; j--, pTerm++){
2219 Expr *pE;
2220 int skipLikeAddr = 0;
2221 testcase( pTerm->wtFlags & TERM_VIRTUAL );
2222 testcase( pTerm->wtFlags & TERM_CODED );
2223 if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
2224 if( (pTerm->prereqAll & pLevel->notReady)!=0 ){
2225 testcase( pWInfo->untestedTerms==0
2226 && (pWInfo->wctrlFlags & WHERE_OR_SUBCLAUSE)!=0 );
2227 pWInfo->untestedTerms = 1;
2228 continue;
2229 }
2230 pE = pTerm->pExpr;
2231 assert( pE!=0 );
dan820fcd22018-04-24 18:53:24 +00002232 if( (pTabItem->fg.jointype&JT_LEFT) && !ExprHasProperty(pE,EP_FromJoin) ){
dan6f654a42017-04-28 19:59:55 +00002233 continue;
2234 }
danebc63012017-07-10 14:33:00 +00002235
dan8674ec52017-07-10 14:39:42 +00002236 if( iLoop==1 && !sqlite3ExprCoveredByIndex(pE, pLevel->iTabCur, pIdx) ){
danebc63012017-07-10 14:33:00 +00002237 iNext = 2;
dan6f654a42017-04-28 19:59:55 +00002238 continue;
2239 }
dand3930b12017-07-10 15:17:30 +00002240 if( iLoop<3 && (pTerm->wtFlags & TERM_VARSELECT) ){
danebc63012017-07-10 14:33:00 +00002241 if( iNext==0 ) iNext = 3;
2242 continue;
2243 }
2244
drh4de33532018-04-02 00:16:36 +00002245 if( (pTerm->wtFlags & TERM_LIKECOND)!=0 ){
dan6f654a42017-04-28 19:59:55 +00002246 /* If the TERM_LIKECOND flag is set, that means that the range search
2247 ** is sufficient to guarantee that the LIKE operator is true, so we
2248 ** can skip the call to the like(A,B) function. But this only works
2249 ** for strings. So do not skip the call to the function on the pass
2250 ** that compares BLOBs. */
drh41d2e662015-12-01 21:23:07 +00002251#ifdef SQLITE_LIKE_DOESNT_MATCH_BLOBS
dan6f654a42017-04-28 19:59:55 +00002252 continue;
drh41d2e662015-12-01 21:23:07 +00002253#else
dan6f654a42017-04-28 19:59:55 +00002254 u32 x = pLevel->iLikeRepCntr;
drh4de33532018-04-02 00:16:36 +00002255 if( x>0 ){
2256 skipLikeAddr = sqlite3VdbeAddOp1(v, (x&1)?OP_IfNot:OP_If,(int)(x>>1));
drh6f883592019-03-30 20:37:04 +00002257 VdbeCoverageIf(v, (x&1)==1);
2258 VdbeCoverageIf(v, (x&1)==0);
drh4de33532018-04-02 00:16:36 +00002259 }
drh41d2e662015-12-01 21:23:07 +00002260#endif
dan6f654a42017-04-28 19:59:55 +00002261 }
drh66a0bf32017-07-10 16:38:14 +00002262#ifdef WHERETRACE_ENABLED /* 0xffff */
2263 if( sqlite3WhereTrace ){
2264 VdbeNoopComment((v, "WhereTerm[%d] (%p) priority=%d",
2265 pWC->nTerm-j, pTerm, iLoop));
2266 }
2267#endif
dan6f654a42017-04-28 19:59:55 +00002268 sqlite3ExprIfFalse(pParse, pE, addrCont, SQLITE_JUMPIFNULL);
2269 if( skipLikeAddr ) sqlite3VdbeJumpHere(v, skipLikeAddr);
2270 pTerm->wtFlags |= TERM_CODED;
drh6f82e852015-06-06 20:12:09 +00002271 }
danebc63012017-07-10 14:33:00 +00002272 iLoop = iNext;
2273 }while( iLoop>0 );
drh6f82e852015-06-06 20:12:09 +00002274
2275 /* Insert code to test for implied constraints based on transitivity
2276 ** of the "==" operator.
2277 **
2278 ** Example: If the WHERE clause contains "t1.a=t2.b" and "t2.b=123"
2279 ** and we are coding the t1 loop and the t2 loop has not yet coded,
2280 ** then we cannot use the "t1.a=t2.b" constraint, but we can code
2281 ** the implied "t1.a=123" constraint.
2282 */
2283 for(pTerm=pWC->a, j=pWC->nTerm; j>0; j--, pTerm++){
drhcb43a932016-10-03 01:21:51 +00002284 Expr *pE, sEAlt;
drh6f82e852015-06-06 20:12:09 +00002285 WhereTerm *pAlt;
2286 if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
2287 if( (pTerm->eOperator & (WO_EQ|WO_IS))==0 ) continue;
2288 if( (pTerm->eOperator & WO_EQUIV)==0 ) continue;
2289 if( pTerm->leftCursor!=iCur ) continue;
2290 if( pLevel->iLeftJoin ) continue;
2291 pE = pTerm->pExpr;
2292 assert( !ExprHasProperty(pE, EP_FromJoin) );
2293 assert( (pTerm->prereqRight & pLevel->notReady)!=0 );
2294 pAlt = sqlite3WhereFindTerm(pWC, iCur, pTerm->u.leftColumn, notReady,
2295 WO_EQ|WO_IN|WO_IS, 0);
2296 if( pAlt==0 ) continue;
2297 if( pAlt->wtFlags & (TERM_CODED) ) continue;
dana916b572018-01-23 16:38:57 +00002298 if( (pAlt->eOperator & WO_IN)
2299 && (pAlt->pExpr->flags & EP_xIsSelect)
drha599e152018-12-24 14:30:11 +00002300 && (pAlt->pExpr->x.pSelect->pEList->nExpr>1)
dana916b572018-01-23 16:38:57 +00002301 ){
2302 continue;
2303 }
drh6f82e852015-06-06 20:12:09 +00002304 testcase( pAlt->eOperator & WO_EQ );
2305 testcase( pAlt->eOperator & WO_IS );
2306 testcase( pAlt->eOperator & WO_IN );
2307 VdbeModuleComment((v, "begin transitive constraint"));
drhcb43a932016-10-03 01:21:51 +00002308 sEAlt = *pAlt->pExpr;
2309 sEAlt.pLeft = pE->pLeft;
2310 sqlite3ExprIfFalse(pParse, &sEAlt, addrCont, SQLITE_JUMPIFNULL);
drh6f82e852015-06-06 20:12:09 +00002311 }
2312
2313 /* For a LEFT OUTER JOIN, generate code that will record the fact that
2314 ** at least one row of the right table has matched the left table.
2315 */
2316 if( pLevel->iLeftJoin ){
2317 pLevel->addrFirst = sqlite3VdbeCurrentAddr(v);
2318 sqlite3VdbeAddOp2(v, OP_Integer, 1, pLevel->iLeftJoin);
2319 VdbeComment((v, "record LEFT JOIN hit"));
drh6f82e852015-06-06 20:12:09 +00002320 for(pTerm=pWC->a, j=0; j<pWC->nTerm; j++, pTerm++){
2321 testcase( pTerm->wtFlags & TERM_VIRTUAL );
2322 testcase( pTerm->wtFlags & TERM_CODED );
2323 if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
2324 if( (pTerm->prereqAll & pLevel->notReady)!=0 ){
2325 assert( pWInfo->untestedTerms );
2326 continue;
2327 }
2328 assert( pTerm->pExpr );
2329 sqlite3ExprIfFalse(pParse, pTerm->pExpr, addrCont, SQLITE_JUMPIFNULL);
2330 pTerm->wtFlags |= TERM_CODED;
2331 }
2332 }
2333
2334 return pLevel->notReady;
2335}