blob: 4c22e5dd61e6440c368d6cebcd71a9ac88b63615 [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";
drhcf9d36d2021-08-02 18:03:43 +000032 return pIdx->pTable->aCol[i].zCnName;
dan1d9bc9b2016-08-08 18:42:08 +000033}
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 {
drh76012942021-02-21 21:04:54 +0000132 SrcItem *pItem = &pTabList->a[pLevel->iFrom];
drh6f82e852015-06-06 20:12:09 +0000133 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);
drha9799932021-03-19 13:00:28 +0000151 str.printfFlags = SQLITE_PRINTF_INTERNAL;
drh2f2091b2021-03-20 15:46:01 +0000152 sqlite3_str_appendf(&str, "%s %S", isSearch ? "SEARCH" : "SCAN", pItem);
drh6f82e852015-06-06 20:12:09 +0000153 if( (flags & (WHERE_IPK|WHERE_VIRTUALTABLE))==0 ){
154 const char *zFmt = 0;
155 Index *pIdx;
156
157 assert( pLoop->u.btree.pIndex!=0 );
158 pIdx = pLoop->u.btree.pIndex;
159 assert( !(flags&WHERE_AUTO_INDEX) || (flags&WHERE_IDX_ONLY) );
160 if( !HasRowid(pItem->pTab) && IsPrimaryKeyIndex(pIdx) ){
161 if( isSearch ){
162 zFmt = "PRIMARY KEY";
163 }
164 }else if( flags & WHERE_PARTIALIDX ){
165 zFmt = "AUTOMATIC PARTIAL COVERING INDEX";
166 }else if( flags & WHERE_AUTO_INDEX ){
167 zFmt = "AUTOMATIC COVERING INDEX";
168 }else if( flags & WHERE_IDX_ONLY ){
169 zFmt = "COVERING INDEX %s";
170 }else{
171 zFmt = "INDEX %s";
172 }
173 if( zFmt ){
drh0cdbe1a2018-05-09 13:46:26 +0000174 sqlite3_str_append(&str, " USING ", 7);
175 sqlite3_str_appendf(&str, zFmt, pIdx->zName);
drh8faee872015-09-19 18:08:13 +0000176 explainIndexRange(&str, pLoop);
drh6f82e852015-06-06 20:12:09 +0000177 }
178 }else if( (flags & WHERE_IPK)!=0 && (flags & WHERE_CONSTRAINT)!=0 ){
drh3bd7cd72021-12-06 23:07:59 +0000179 char cRangeOp;
180#if 0 /* Better output, but breaks many tests */
181 const Table *pTab = pItem->pTab;
182 const char *zRowid = pTab->iPKey>=0 ? pTab->aCol[pTab->iPKey].zCnName:
183 "rowid";
184#else
185 const char *zRowid = "rowid";
186#endif
187 sqlite3_str_appendf(&str, " USING INTEGER PRIMARY KEY (%s", zRowid);
drh6f82e852015-06-06 20:12:09 +0000188 if( flags&(WHERE_COLUMN_EQ|WHERE_COLUMN_IN) ){
drh3bd7cd72021-12-06 23:07:59 +0000189 cRangeOp = '=';
drh6f82e852015-06-06 20:12:09 +0000190 }else if( (flags&WHERE_BOTH_LIMIT)==WHERE_BOTH_LIMIT ){
drh3bd7cd72021-12-06 23:07:59 +0000191 sqlite3_str_appendf(&str, ">? AND %s", zRowid);
192 cRangeOp = '<';
drh6f82e852015-06-06 20:12:09 +0000193 }else if( flags&WHERE_BTM_LIMIT ){
drh3bd7cd72021-12-06 23:07:59 +0000194 cRangeOp = '>';
drh6f82e852015-06-06 20:12:09 +0000195 }else{
196 assert( flags&WHERE_TOP_LIMIT);
drh3bd7cd72021-12-06 23:07:59 +0000197 cRangeOp = '<';
drh6f82e852015-06-06 20:12:09 +0000198 }
drh3bd7cd72021-12-06 23:07:59 +0000199 sqlite3_str_appendf(&str, "%c?)", cRangeOp);
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
drhc5837192022-04-11 14:26:37 +0000207 if( pItem->fg.jointype & JT_LEFT ){
208 sqlite3_str_appendf(&str, " LEFT-JOIN");
209 }
drh6f82e852015-06-06 20:12:09 +0000210#ifdef SQLITE_EXPLAIN_ESTIMATED_ROWS
211 if( pLoop->nOut>=10 ){
drh0cdbe1a2018-05-09 13:46:26 +0000212 sqlite3_str_appendf(&str, " (~%llu rows)",
213 sqlite3LogEstToInt(pLoop->nOut));
drh6f82e852015-06-06 20:12:09 +0000214 }else{
drh0cdbe1a2018-05-09 13:46:26 +0000215 sqlite3_str_append(&str, " (~1 row)", 9);
drh6f82e852015-06-06 20:12:09 +0000216 }
217#endif
218 zMsg = sqlite3StrAccumFinish(&str);
drhbd462bc2018-12-24 20:21:06 +0000219 sqlite3ExplainBreakpoint("",zMsg);
drhe2ca99c2018-05-02 00:33:43 +0000220 ret = sqlite3VdbeAddOp4(v, OP_Explain, sqlite3VdbeCurrentAddr(v),
221 pParse->addrExplain, 0, zMsg,P4_DYNAMIC);
drh6f82e852015-06-06 20:12:09 +0000222 }
223 return ret;
224}
drh6ae49e62021-12-05 20:19:47 +0000225
226/*
227** Add a single OP_Explain opcode that describes a Bloom filter.
228**
229** Or if not processing EXPLAIN QUERY PLAN and not in a SQLITE_DEBUG and/or
230** SQLITE_ENABLE_STMT_SCANSTATUS build, then OP_Explain opcodes are not
231** required and this routine is a no-op.
232**
233** If an OP_Explain opcode is added to the VM, its address is returned.
234** Otherwise, if no OP_Explain is coded, zero is returned.
235*/
236int sqlite3WhereExplainBloomFilter(
237 const Parse *pParse, /* Parse context */
238 const WhereInfo *pWInfo, /* WHERE clause */
239 const WhereLevel *pLevel /* Bloom filter on this level */
240){
241 int ret = 0;
drha11c5e22021-12-09 18:44:03 +0000242 SrcItem *pItem = &pWInfo->pTabList->a[pLevel->iFrom];
243 Vdbe *v = pParse->pVdbe; /* VM being constructed */
244 sqlite3 *db = pParse->db; /* Database handle */
245 char *zMsg; /* Text to add to EQP output */
246 int i; /* Loop counter */
247 WhereLoop *pLoop; /* The where loop */
248 StrAccum str; /* EQP output string */
249 char zBuf[100]; /* Initial space for EQP output string */
drh6ae49e62021-12-05 20:19:47 +0000250
drha11c5e22021-12-09 18:44:03 +0000251 sqlite3StrAccumInit(&str, db, zBuf, sizeof(zBuf), SQLITE_MAX_LENGTH);
252 str.printfFlags = SQLITE_PRINTF_INTERNAL;
253 sqlite3_str_appendf(&str, "BLOOM FILTER ON %S (", pItem);
254 pLoop = pLevel->pWLoop;
255 if( pLoop->wsFlags & WHERE_IPK ){
256 const Table *pTab = pItem->pTab;
257 if( pTab->iPKey>=0 ){
258 sqlite3_str_appendf(&str, "%s=?", pTab->aCol[pTab->iPKey].zCnName);
drh3bd7cd72021-12-06 23:07:59 +0000259 }else{
drha11c5e22021-12-09 18:44:03 +0000260 sqlite3_str_appendf(&str, "rowid=?");
drh6ae49e62021-12-05 20:19:47 +0000261 }
drha11c5e22021-12-09 18:44:03 +0000262 }else{
263 for(i=pLoop->nSkip; i<pLoop->u.btree.nEq; i++){
264 const char *z = explainIndexColumnName(pLoop->u.btree.pIndex, i);
265 if( i>pLoop->nSkip ) sqlite3_str_append(&str, " AND ", 5);
266 sqlite3_str_appendf(&str, "%s=?", z);
267 }
drh6ae49e62021-12-05 20:19:47 +0000268 }
drha11c5e22021-12-09 18:44:03 +0000269 sqlite3_str_append(&str, ")", 1);
270 zMsg = sqlite3StrAccumFinish(&str);
271 ret = sqlite3VdbeAddOp4(v, OP_Explain, sqlite3VdbeCurrentAddr(v),
272 pParse->addrExplain, 0, zMsg,P4_DYNAMIC);
dan231ff4b2022-12-02 20:32:22 +0000273
274 sqlite3VdbeScanStatus(v, sqlite3VdbeCurrentAddr(v)-1, 0, 0, 0, 0);
drh6ae49e62021-12-05 20:19:47 +0000275 return ret;
276}
drh6f82e852015-06-06 20:12:09 +0000277#endif /* SQLITE_OMIT_EXPLAIN */
278
279#ifdef SQLITE_ENABLE_STMT_SCANSTATUS
280/*
281** Configure the VM passed as the first argument with an
282** sqlite3_stmt_scanstatus() entry corresponding to the scan used to
283** implement level pLvl. Argument pSrclist is a pointer to the FROM
284** clause that the scan reads data from.
285**
286** If argument addrExplain is not 0, it must be the address of an
287** OP_Explain instruction that describes the same loop.
288*/
289void sqlite3WhereAddScanStatus(
290 Vdbe *v, /* Vdbe to add scanstatus entry to */
291 SrcList *pSrclist, /* FROM clause pLvl reads data from */
292 WhereLevel *pLvl, /* Level to add scanstatus() entry for */
293 int addrExplain /* Address of OP_Explain (or 0) */
294){
295 const char *zObj = 0;
296 WhereLoop *pLoop = pLvl->pWLoop;
dan2adb3092022-12-06 18:48:06 +0000297 int wsFlags = pLoop->wsFlags;
298 int viaCoroutine = 0;
299
300 if( (wsFlags & WHERE_VIRTUALTABLE)==0 && pLoop->u.btree.pIndex!=0 ){
drh6f82e852015-06-06 20:12:09 +0000301 zObj = pLoop->u.btree.pIndex->zName;
302 }else{
303 zObj = pSrclist->a[pLvl->iFrom].zName;
dan2adb3092022-12-06 18:48:06 +0000304 viaCoroutine = pSrclist->a[pLvl->iFrom].fg.viaCoroutine;
drh6f82e852015-06-06 20:12:09 +0000305 }
306 sqlite3VdbeScanStatus(
307 v, addrExplain, pLvl->addrBody, pLvl->addrVisit, pLoop->nOut, zObj
308 );
dan2adb3092022-12-06 18:48:06 +0000309
310 if( viaCoroutine==0 ){
311 if( (wsFlags & (WHERE_MULTI_OR|WHERE_AUTO_INDEX))==0 ){
312 sqlite3VdbeScanStatusRange(v, addrExplain, -1, pLvl->iTabCur);
313 }
314 if( wsFlags & WHERE_INDEXED ){
315 sqlite3VdbeScanStatusRange(v, addrExplain, -1, pLvl->iIdxCur);
316 }
danad23a472022-12-03 21:24:26 +0000317 }
drh6f82e852015-06-06 20:12:09 +0000318}
319#endif
320
321
322/*
323** Disable a term in the WHERE clause. Except, do not disable the term
324** if it controls a LEFT OUTER JOIN and it did not originate in the ON
325** or USING clause of that join.
326**
327** Consider the term t2.z='ok' in the following queries:
328**
329** (1) SELECT * FROM t1 LEFT JOIN t2 ON t1.a=t2.x WHERE t2.z='ok'
330** (2) SELECT * FROM t1 LEFT JOIN t2 ON t1.a=t2.x AND t2.z='ok'
331** (3) SELECT * FROM t1, t2 WHERE t1.a=t2.x AND t2.z='ok'
332**
333** The t2.z='ok' is disabled in the in (2) because it originates
334** in the ON clause. The term is disabled in (3) because it is not part
335** of a LEFT OUTER JOIN. In (1), the term is not disabled.
336**
337** Disabling a term causes that term to not be tested in the inner loop
338** of the join. Disabling is an optimization. When terms are satisfied
339** by indices, we disable them to prevent redundant tests in the inner
340** loop. We would get the correct results if nothing were ever disabled,
341** but joins might run a little slower. The trick is to disable as much
342** as we can without disabling too much. If we disabled in (1), we'd get
343** the wrong answer. See ticket #813.
344**
345** If all the children of a term are disabled, then that term is also
346** automatically disabled. In this way, terms get disabled if derived
347** virtual terms are tested first. For example:
348**
349** x GLOB 'abc*' AND x>='abc' AND x<'acd'
350** \___________/ \______/ \_____/
351** parent child1 child2
352**
353** Only the parent term was in the original WHERE clause. The child1
354** and child2 terms were added by the LIKE optimization. If both of
355** the virtual child terms are valid, then testing of the parent can be
356** skipped.
357**
358** Usually the parent term is marked as TERM_CODED. But if the parent
359** term was originally TERM_LIKE, then the parent gets TERM_LIKECOND instead.
360** The TERM_LIKECOND marking indicates that the term should be coded inside
361** a conditional such that is only evaluated on the second pass of a
362** LIKE-optimization loop, when scanning BLOBs instead of strings.
363*/
364static void disableTerm(WhereLevel *pLevel, WhereTerm *pTerm){
365 int nLoop = 0;
drh9d9c41e2017-10-31 03:40:15 +0000366 assert( pTerm!=0 );
367 while( (pTerm->wtFlags & TERM_CODED)==0
drh67a99db2022-05-13 14:52:04 +0000368 && (pLevel->iLeftJoin==0 || ExprHasProperty(pTerm->pExpr, EP_OuterON))
drh6f82e852015-06-06 20:12:09 +0000369 && (pLevel->notReady & pTerm->prereqAll)==0
370 ){
371 if( nLoop && (pTerm->wtFlags & TERM_LIKE)!=0 ){
372 pTerm->wtFlags |= TERM_LIKECOND;
373 }else{
374 pTerm->wtFlags |= TERM_CODED;
375 }
drh23634892021-05-04 18:24:56 +0000376#ifdef WHERETRACE_ENABLED
drh2a757652022-11-30 19:11:31 +0000377 if( (sqlite3WhereTrace & 0x4001)==0x4001 ){
drh23634892021-05-04 18:24:56 +0000378 sqlite3DebugPrintf("DISABLE-");
379 sqlite3WhereTermPrint(pTerm, (int)(pTerm - (pTerm->pWC->a)));
380 }
381#endif
drh6f82e852015-06-06 20:12:09 +0000382 if( pTerm->iParent<0 ) break;
383 pTerm = &pTerm->pWC->a[pTerm->iParent];
drh9d9c41e2017-10-31 03:40:15 +0000384 assert( pTerm!=0 );
drh6f82e852015-06-06 20:12:09 +0000385 pTerm->nChild--;
386 if( pTerm->nChild!=0 ) break;
387 nLoop++;
388 }
389}
390
391/*
392** Code an OP_Affinity opcode to apply the column affinity string zAff
393** to the n registers starting at base.
394**
drh96fb16e2019-08-06 14:37:24 +0000395** As an optimization, SQLITE_AFF_BLOB and SQLITE_AFF_NONE entries (which
396** are no-ops) at the beginning and end of zAff are ignored. If all entries
397** in zAff are SQLITE_AFF_BLOB or SQLITE_AFF_NONE, then no code gets generated.
drh6f82e852015-06-06 20:12:09 +0000398**
399** This routine makes its own copy of zAff so that the caller is free
400** to modify zAff after this routine returns.
401*/
402static void codeApplyAffinity(Parse *pParse, int base, int n, char *zAff){
403 Vdbe *v = pParse->pVdbe;
404 if( zAff==0 ){
405 assert( pParse->db->mallocFailed );
406 return;
407 }
408 assert( v!=0 );
409
drh96fb16e2019-08-06 14:37:24 +0000410 /* Adjust base and n to skip over SQLITE_AFF_BLOB and SQLITE_AFF_NONE
411 ** entries at the beginning and end of the affinity string.
drh6f82e852015-06-06 20:12:09 +0000412 */
drh96fb16e2019-08-06 14:37:24 +0000413 assert( SQLITE_AFF_NONE<SQLITE_AFF_BLOB );
414 while( n>0 && zAff[0]<=SQLITE_AFF_BLOB ){
drh6f82e852015-06-06 20:12:09 +0000415 n--;
416 base++;
417 zAff++;
418 }
drh96fb16e2019-08-06 14:37:24 +0000419 while( n>1 && zAff[n-1]<=SQLITE_AFF_BLOB ){
drh6f82e852015-06-06 20:12:09 +0000420 n--;
421 }
422
423 /* Code the OP_Affinity opcode if there is anything left to do. */
424 if( n>0 ){
drh9b34abe2016-01-16 15:12:35 +0000425 sqlite3VdbeAddOp4(v, OP_Affinity, base, n, 0, zAff, n);
drh6f82e852015-06-06 20:12:09 +0000426 }
427}
428
danb7ca2172016-08-26 17:54:46 +0000429/*
430** Expression pRight, which is the RHS of a comparison operation, is
431** either a vector of n elements or, if n==1, a scalar expression.
432** Before the comparison operation, affinity zAff is to be applied
433** to the pRight values. This function modifies characters within the
434** affinity string to SQLITE_AFF_BLOB if either:
435**
436** * the comparison will be performed with no affinity, or
437** * the affinity change in zAff is guaranteed not to change the value.
438*/
439static void updateRangeAffinityStr(
danb7ca2172016-08-26 17:54:46 +0000440 Expr *pRight, /* RHS of comparison */
441 int n, /* Number of vector elements in comparison */
442 char *zAff /* Affinity string to modify */
443){
444 int i;
445 for(i=0; i<n; i++){
446 Expr *p = sqlite3VectorFieldSubexpr(pRight, i);
447 if( sqlite3CompareAffinity(p, zAff[i])==SQLITE_AFF_BLOB
448 || sqlite3ExprNeedsNoAffinityChange(p, zAff[i])
449 ){
450 zAff[i] = SQLITE_AFF_BLOB;
451 }
452 }
453}
drh6f82e852015-06-06 20:12:09 +0000454
drh24102432017-11-17 21:01:04 +0000455
456/*
457** pX is an expression of the form: (vector) IN (SELECT ...)
458** In other words, it is a vector IN operator with a SELECT clause on the
459** LHS. But not all terms in the vector are indexable and the terms might
460** not be in the correct order for indexing.
drh9b1ecb62017-11-17 17:32:40 +0000461**
drh24102432017-11-17 21:01:04 +0000462** This routine makes a copy of the input pX expression and then adjusts
463** the vector on the LHS with corresponding changes to the SELECT so that
464** the vector contains only index terms and those terms are in the correct
465** order. The modified IN expression is returned. The caller is responsible
466** for deleting the returned expression.
467**
468** Example:
469**
470** CREATE TABLE t1(a,b,c,d,e,f);
471** CREATE INDEX t1x1 ON t1(e,c);
472** SELECT * FROM t1 WHERE (a,b,c,d,e) IN (SELECT v,w,x,y,z FROM t2)
473** \_______________________________________/
474** The pX expression
475**
476** Since only columns e and c can be used with the index, in that order,
477** the modified IN expression that is returned will be:
478**
479** (e,c) IN (SELECT z,x FROM t2)
480**
481** The reduced pX is different from the original (obviously) and thus is
482** only used for indexing, to improve performance. The original unaltered
483** IN expression must also be run on each output row for correctness.
drh9b1ecb62017-11-17 17:32:40 +0000484*/
drh24102432017-11-17 21:01:04 +0000485static Expr *removeUnindexableInClauseTerms(
486 Parse *pParse, /* The parsing context */
487 int iEq, /* Look at loop terms starting here */
488 WhereLoop *pLoop, /* The current loop */
489 Expr *pX /* The IN expression to be reduced */
490){
491 sqlite3 *db = pParse->db;
dan69843342019-12-22 17:32:25 +0000492 Expr *pNew;
dan69843342019-12-22 17:32:25 +0000493 pNew = sqlite3ExprDup(db, pX, 0);
drh24102432017-11-17 21:01:04 +0000494 if( db->mallocFailed==0 ){
drha4eeccd2021-10-07 17:43:30 +0000495 ExprList *pOrigRhs; /* Original unmodified RHS */
496 ExprList *pOrigLhs; /* Original unmodified LHS */
drh24102432017-11-17 21:01:04 +0000497 ExprList *pRhs = 0; /* New RHS after modifications */
498 ExprList *pLhs = 0; /* New LHS after mods */
499 int i; /* Loop counter */
500 Select *pSelect; /* Pointer to the SELECT on the RHS */
501
drha4eeccd2021-10-07 17:43:30 +0000502 assert( ExprUseXSelect(pNew) );
503 pOrigRhs = pNew->x.pSelect->pEList;
504 assert( pNew->pLeft!=0 );
505 assert( ExprUseXList(pNew->pLeft) );
506 pOrigLhs = pNew->pLeft->x.pList;
drh24102432017-11-17 21:01:04 +0000507 for(i=iEq; i<pLoop->nLTerm; i++){
508 if( pLoop->aLTerm[i]->pExpr==pX ){
drh220f0d62021-10-15 17:06:16 +0000509 int iField;
510 assert( (pLoop->aLTerm[i]->eOperator & (WO_OR|WO_AND))==0 );
511 iField = pLoop->aLTerm[i]->u.x.iField - 1;
drhc6e519f2018-11-03 13:11:24 +0000512 if( pOrigRhs->a[iField].pExpr==0 ) continue; /* Duplicate PK column */
drh24102432017-11-17 21:01:04 +0000513 pRhs = sqlite3ExprListAppend(pParse, pRhs, pOrigRhs->a[iField].pExpr);
514 pOrigRhs->a[iField].pExpr = 0;
515 assert( pOrigLhs->a[iField].pExpr!=0 );
516 pLhs = sqlite3ExprListAppend(pParse, pLhs, pOrigLhs->a[iField].pExpr);
517 pOrigLhs->a[iField].pExpr = 0;
518 }
drh9b1ecb62017-11-17 17:32:40 +0000519 }
drh24102432017-11-17 21:01:04 +0000520 sqlite3ExprListDelete(db, pOrigRhs);
521 sqlite3ExprListDelete(db, pOrigLhs);
522 pNew->pLeft->x.pList = pLhs;
523 pNew->x.pSelect->pEList = pRhs;
524 if( pLhs && pLhs->nExpr==1 ){
525 /* Take care here not to generate a TK_VECTOR containing only a
526 ** single value. Since the parser never creates such a vector, some
527 ** of the subroutines do not handle this case. */
528 Expr *p = pLhs->a[0].pExpr;
529 pLhs->a[0].pExpr = 0;
530 sqlite3ExprDelete(db, pNew->pLeft);
531 pNew->pLeft = p;
532 }
533 pSelect = pNew->x.pSelect;
534 if( pSelect->pOrderBy ){
535 /* If the SELECT statement has an ORDER BY clause, zero the
536 ** iOrderByCol variables. These are set to non-zero when an
537 ** ORDER BY term exactly matches one of the terms of the
538 ** result-set. Since the result-set of the SELECT statement may
539 ** have been modified or reordered, these variables are no longer
540 ** set correctly. Since setting them is just an optimization,
541 ** it's easiest just to zero them here. */
542 ExprList *pOrderBy = pSelect->pOrderBy;
543 for(i=0; i<pOrderBy->nExpr; i++){
544 pOrderBy->a[i].u.x.iOrderByCol = 0;
545 }
546 }
547
548#if 0
549 printf("For indexing, change the IN expr:\n");
550 sqlite3TreeViewExpr(0, pX, 0);
551 printf("Into:\n");
552 sqlite3TreeViewExpr(0, pNew, 0);
553#endif
drh9b1ecb62017-11-17 17:32:40 +0000554 }
drh24102432017-11-17 21:01:04 +0000555 return pNew;
drh9b1ecb62017-11-17 17:32:40 +0000556}
drh9b1ecb62017-11-17 17:32:40 +0000557
558
drh6f82e852015-06-06 20:12:09 +0000559/*
560** Generate code for a single equality term of the WHERE clause. An equality
561** term can be either X=expr or X IN (...). pTerm is the term to be
562** coded.
563**
drh099a0f52016-09-06 15:25:53 +0000564** The current value for the constraint is left in a register, the index
565** of which is returned. An attempt is made store the result in iTarget but
566** this is only guaranteed for TK_ISNULL and TK_IN constraints. If the
567** constraint is a TK_EQ or TK_IS, then the current value might be left in
568** some other register and it is the caller's responsibility to compensate.
drh6f82e852015-06-06 20:12:09 +0000569**
drh4602b8e2016-08-19 18:28:00 +0000570** For a constraint of the form X=expr, the expression is evaluated in
571** straight-line code. For constraints of the form X IN (...)
drh6f82e852015-06-06 20:12:09 +0000572** this routine sets up a loop that will iterate over all values of X.
573*/
574static int codeEqualityTerm(
575 Parse *pParse, /* The parsing context */
576 WhereTerm *pTerm, /* The term of the WHERE clause to be coded */
577 WhereLevel *pLevel, /* The level of the FROM clause we are working on */
578 int iEq, /* Index of the equality term within this level */
579 int bRev, /* True for reverse-order IN operations */
580 int iTarget /* Attempt to leave results in this register */
581){
582 Expr *pX = pTerm->pExpr;
583 Vdbe *v = pParse->pVdbe;
584 int iReg; /* Register holding results */
585
dan8da209b2016-07-26 18:06:08 +0000586 assert( pLevel->pWLoop->aLTerm[iEq]==pTerm );
drh6f82e852015-06-06 20:12:09 +0000587 assert( iTarget>0 );
588 if( pX->op==TK_EQ || pX->op==TK_IS ){
drhfc7f27b2016-08-20 00:07:01 +0000589 iReg = sqlite3ExprCodeTarget(pParse, pX->pRight, iTarget);
drh6f82e852015-06-06 20:12:09 +0000590 }else if( pX->op==TK_ISNULL ){
591 iReg = iTarget;
592 sqlite3VdbeAddOp2(v, OP_Null, 0, iReg);
593#ifndef SQLITE_OMIT_SUBQUERY
594 }else{
drhac6b47d2016-08-24 00:51:48 +0000595 int eType = IN_INDEX_NOOP;
drh6f82e852015-06-06 20:12:09 +0000596 int iTab;
597 struct InLoop *pIn;
598 WhereLoop *pLoop = pLevel->pWLoop;
dan8da209b2016-07-26 18:06:08 +0000599 int i;
600 int nEq = 0;
601 int *aiMap = 0;
drh6f82e852015-06-06 20:12:09 +0000602
603 if( (pLoop->wsFlags & WHERE_VIRTUALTABLE)==0
604 && pLoop->u.btree.pIndex!=0
605 && pLoop->u.btree.pIndex->aSortOrder[iEq]
606 ){
607 testcase( iEq==0 );
608 testcase( bRev );
609 bRev = !bRev;
610 }
611 assert( pX->op==TK_IN );
612 iReg = iTarget;
dan8da209b2016-07-26 18:06:08 +0000613
614 for(i=0; i<iEq; i++){
615 if( pLoop->aLTerm[i] && pLoop->aLTerm[i]->pExpr==pX ){
616 disableTerm(pLevel, pTerm);
617 return iTarget;
618 }
619 }
620 for(i=iEq;i<pLoop->nLTerm; i++){
drh24102432017-11-17 21:01:04 +0000621 assert( pLoop->aLTerm[i]!=0 );
622 if( pLoop->aLTerm[i]->pExpr==pX ) nEq++;
dan8da209b2016-07-26 18:06:08 +0000623 }
624
drh2c041312018-12-24 02:34:49 +0000625 iTab = 0;
drha4eeccd2021-10-07 17:43:30 +0000626 if( !ExprUseXSelect(pX) || pX->x.pSelect->pEList->nExpr==1 ){
drh2c041312018-12-24 02:34:49 +0000627 eType = sqlite3FindInIndex(pParse, pX, IN_INDEX_LOOP, 0, 0, &iTab);
drha25bbaf2022-04-30 00:06:52 +0000628 }else{
629 Expr *pExpr = pTerm->pExpr;
drh3a45d302022-05-02 14:32:56 +0000630 if( pExpr->iTable==0 || !ExprHasProperty(pExpr, EP_Subrtn) ){
drha25bbaf2022-04-30 00:06:52 +0000631 sqlite3 *db = pParse->db;
632 pX = removeUnindexableInClauseTerms(pParse, iEq, pLoop, pX);
633 if( !db->mallocFailed ){
634 aiMap = (int*)sqlite3DbMallocZero(pParse->db, sizeof(int)*nEq);
635 eType = sqlite3FindInIndex(pParse, pX, IN_INDEX_LOOP, 0, aiMap,&iTab);
636 pExpr->iTable = iTab;
drha25bbaf2022-04-30 00:06:52 +0000637 }
638 sqlite3ExprDelete(db, pX);
639 }else{
drh3a17e2e2022-08-03 17:26:32 +0000640 int n = sqlite3ExprVectorSize(pX->pLeft);
641 aiMap = (int*)sqlite3DbMallocZero(pParse->db, sizeof(int)*MAX(nEq,n));
drhf69dad82022-05-13 19:50:29 +0000642 eType = sqlite3FindInIndex(pParse, pX, IN_INDEX_LOOP, 0, aiMap, &iTab);
drhac6b47d2016-08-24 00:51:48 +0000643 }
drha25bbaf2022-04-30 00:06:52 +0000644 pX = pExpr;
dan8da209b2016-07-26 18:06:08 +0000645 }
646
drh6f82e852015-06-06 20:12:09 +0000647 if( eType==IN_INDEX_INDEX_DESC ){
648 testcase( bRev );
649 bRev = !bRev;
650 }
drh6f82e852015-06-06 20:12:09 +0000651 sqlite3VdbeAddOp2(v, bRev ? OP_Last : OP_Rewind, iTab, 0);
652 VdbeCoverageIf(v, bRev);
653 VdbeCoverageIf(v, !bRev);
dan8da209b2016-07-26 18:06:08 +0000654
drh04756292021-10-14 19:28:28 +0000655 assert( (pLoop->wsFlags & WHERE_MULTI_OR)==0 );
drh6f82e852015-06-06 20:12:09 +0000656 pLoop->wsFlags |= WHERE_IN_ABLE;
657 if( pLevel->u.in.nIn==0 ){
drhec4ccdb2018-12-29 02:26:59 +0000658 pLevel->addrNxt = sqlite3VdbeMakeLabel(pParse);
drh6f82e852015-06-06 20:12:09 +0000659 }
drh46f0f4e2020-09-29 15:32:54 +0000660 if( iEq>0 && (pLoop->wsFlags & WHERE_IN_SEEKSCAN)==0 ){
drhfa17e132020-09-01 01:52:03 +0000661 pLoop->wsFlags |= WHERE_IN_EARLYOUT;
662 }
dan8da209b2016-07-26 18:06:08 +0000663
664 i = pLevel->u.in.nIn;
665 pLevel->u.in.nIn += nEq;
drh6f82e852015-06-06 20:12:09 +0000666 pLevel->u.in.aInLoop =
drhf8bdcfa2022-04-09 03:06:01 +0000667 sqlite3WhereRealloc(pTerm->pWC->pWInfo,
668 pLevel->u.in.aInLoop,
669 sizeof(pLevel->u.in.aInLoop[0])*pLevel->u.in.nIn);
drh6f82e852015-06-06 20:12:09 +0000670 pIn = pLevel->u.in.aInLoop;
671 if( pIn ){
dan8da209b2016-07-26 18:06:08 +0000672 int iMap = 0; /* Index in aiMap[] */
673 pIn += i;
dan7887d7f2016-08-24 12:22:17 +0000674 for(i=iEq;i<pLoop->nLTerm; i++){
dan8da209b2016-07-26 18:06:08 +0000675 if( pLoop->aLTerm[i]->pExpr==pX ){
danedc35372016-09-16 16:30:57 +0000676 int iOut = iReg + i - iEq;
dan8da209b2016-07-26 18:06:08 +0000677 if( eType==IN_INDEX_ROWID ){
danedc35372016-09-16 16:30:57 +0000678 pIn->addrInTop = sqlite3VdbeAddOp2(v, OP_Rowid, iTab, iOut);
dan8da209b2016-07-26 18:06:08 +0000679 }else{
680 int iCol = aiMap ? aiMap[iMap++] : 0;
dan8da209b2016-07-26 18:06:08 +0000681 pIn->addrInTop = sqlite3VdbeAddOp3(v,OP_Column,iTab, iCol, iOut);
682 }
drh03181c82016-08-18 19:04:57 +0000683 sqlite3VdbeAddOp1(v, OP_IsNull, iOut); VdbeCoverage(v);
dan8da209b2016-07-26 18:06:08 +0000684 if( i==iEq ){
685 pIn->iCur = iTab;
drhf1949b62018-06-07 17:32:59 +0000686 pIn->eEndLoopOp = bRev ? OP_Prev : OP_Next;
dan74ebaad2020-01-04 16:55:57 +0000687 if( iEq>0 ){
drh86d0ea72018-06-05 15:16:25 +0000688 pIn->iBase = iReg - i;
689 pIn->nPrefix = i;
690 }else{
691 pIn->nPrefix = 0;
692 }
dan8da209b2016-07-26 18:06:08 +0000693 }else{
694 pIn->eEndLoopOp = OP_Noop;
695 }
dan7887d7f2016-08-24 12:22:17 +0000696 pIn++;
dan8da209b2016-07-26 18:06:08 +0000697 }
drh6f82e852015-06-06 20:12:09 +0000698 }
drh67306cb2020-10-01 14:36:15 +0000699 testcase( iEq>0
700 && (pLoop->wsFlags & WHERE_IN_SEEKSCAN)==0
701 && (pLoop->wsFlags & WHERE_VIRTUALTABLE)!=0 );
702 if( iEq>0
703 && (pLoop->wsFlags & (WHERE_IN_SEEKSCAN|WHERE_VIRTUALTABLE))==0
704 ){
drhfa17e132020-09-01 01:52:03 +0000705 sqlite3VdbeAddOp3(v, OP_SeekHit, pLevel->iIdxCur, 0, iEq);
706 }
drh6f82e852015-06-06 20:12:09 +0000707 }else{
708 pLevel->u.in.nIn = 0;
709 }
dan8da209b2016-07-26 18:06:08 +0000710 sqlite3DbFree(pParse->db, aiMap);
drh6f82e852015-06-06 20:12:09 +0000711#endif
712 }
drh67656ac2021-05-04 23:21:35 +0000713
714 /* As an optimization, try to disable the WHERE clause term that is
715 ** driving the index as it will always be true. The correct answer is
716 ** obtained regardless, but we might get the answer with fewer CPU cycles
717 ** by omitting the term.
718 **
719 ** But do not disable the term unless we are certain that the term is
720 ** not a transitive constraint. For an example of where that does not
721 ** work, see https://sqlite.org/forum/forumpost/eb8613976a (2021-05-04)
722 */
723 if( (pLevel->pWLoop->wsFlags & WHERE_TRANSCONS)==0
724 || (pTerm->eOperator & WO_EQUIV)==0
725 ){
726 disableTerm(pLevel, pTerm);
727 }
728
drh6f82e852015-06-06 20:12:09 +0000729 return iReg;
730}
731
732/*
733** Generate code that will evaluate all == and IN constraints for an
734** index scan.
735**
736** For example, consider table t1(a,b,c,d,e,f) with index i1(a,b,c).
737** Suppose the WHERE clause is this: a==5 AND b IN (1,2,3) AND c>5 AND c<10
738** The index has as many as three equality constraints, but in this
739** example, the third "c" value is an inequality. So only two
740** constraints are coded. This routine will generate code to evaluate
741** a==5 and b IN (1,2,3). The current values for a and b will be stored
742** in consecutive registers and the index of the first register is returned.
743**
744** In the example above nEq==2. But this subroutine works for any value
745** of nEq including 0. If nEq==0, this routine is nearly a no-op.
746** The only thing it does is allocate the pLevel->iMem memory cell and
747** compute the affinity string.
748**
749** The nExtraReg parameter is 0 or 1. It is 0 if all WHERE clause constraints
750** are == or IN and are covered by the nEq. nExtraReg is 1 if there is
751** an inequality constraint (such as the "c>=5 AND c<10" in the example) that
752** occurs after the nEq quality constraints.
753**
754** This routine allocates a range of nEq+nExtraReg memory cells and returns
755** the index of the first memory cell in that range. The code that
756** calls this routine will use that memory range to store keys for
757** start and termination conditions of the loop.
758** key value of the loop. If one or more IN operators appear, then
759** this routine allocates an additional nEq memory cells for internal
760** use.
761**
762** Before returning, *pzAff is set to point to a buffer containing a
763** copy of the column affinity string of the index allocated using
764** sqlite3DbMalloc(). Except, entries in the copy of the string associated
765** with equality constraints that use BLOB or NONE affinity are set to
766** SQLITE_AFF_BLOB. This is to deal with SQL such as the following:
767**
768** CREATE TABLE t1(a TEXT PRIMARY KEY, b);
769** SELECT ... FROM t1 AS t2, t1 WHERE t1.a = t2.b;
770**
771** In the example above, the index on t1(a) has TEXT affinity. But since
772** the right hand side of the equality constraint (t2.b) has BLOB/NONE affinity,
773** no conversion should be attempted before using a t2.b value as part of
774** a key to search the index. Hence the first byte in the returned affinity
775** string in this example would be set to SQLITE_AFF_BLOB.
776*/
777static int codeAllEqualityTerms(
778 Parse *pParse, /* Parsing context */
779 WhereLevel *pLevel, /* Which nested loop of the FROM we are coding */
780 int bRev, /* Reverse the order of IN operators */
781 int nExtraReg, /* Number of extra registers to allocate */
782 char **pzAff /* OUT: Set to point to affinity string */
783){
784 u16 nEq; /* The number of == or IN constraints to code */
785 u16 nSkip; /* Number of left-most columns to skip */
786 Vdbe *v = pParse->pVdbe; /* The vm under construction */
787 Index *pIdx; /* The index being used for this loop */
788 WhereTerm *pTerm; /* A single constraint term */
789 WhereLoop *pLoop; /* The WhereLoop object */
790 int j; /* Loop counter */
791 int regBase; /* Base register */
792 int nReg; /* Number of registers to allocate */
793 char *zAff; /* Affinity string to return */
794
795 /* This module is only called on query plans that use an index. */
796 pLoop = pLevel->pWLoop;
797 assert( (pLoop->wsFlags & WHERE_VIRTUALTABLE)==0 );
798 nEq = pLoop->u.btree.nEq;
799 nSkip = pLoop->nSkip;
800 pIdx = pLoop->u.btree.pIndex;
801 assert( pIdx!=0 );
802
803 /* Figure out how many memory cells we will need then allocate them.
804 */
805 regBase = pParse->nMem + 1;
806 nReg = pLoop->u.btree.nEq + nExtraReg;
807 pParse->nMem += nReg;
808
drhe9107692015-08-25 19:20:04 +0000809 zAff = sqlite3DbStrDup(pParse->db,sqlite3IndexAffinityStr(pParse->db,pIdx));
drh4df86af2016-02-04 11:48:00 +0000810 assert( zAff!=0 || pParse->db->mallocFailed );
drh6f82e852015-06-06 20:12:09 +0000811
812 if( nSkip ){
813 int iIdxCur = pLevel->iIdxCur;
drh31536302021-04-21 23:13:26 +0000814 sqlite3VdbeAddOp3(v, OP_Null, 0, regBase, regBase+nSkip-1);
drh6f82e852015-06-06 20:12:09 +0000815 sqlite3VdbeAddOp1(v, (bRev?OP_Last:OP_Rewind), iIdxCur);
816 VdbeCoverageIf(v, bRev==0);
817 VdbeCoverageIf(v, bRev!=0);
818 VdbeComment((v, "begin skip-scan on %s", pIdx->zName));
819 j = sqlite3VdbeAddOp0(v, OP_Goto);
drh56945692022-03-02 21:04:10 +0000820 assert( pLevel->addrSkip==0 );
drh6f82e852015-06-06 20:12:09 +0000821 pLevel->addrSkip = sqlite3VdbeAddOp4Int(v, (bRev?OP_SeekLT:OP_SeekGT),
822 iIdxCur, 0, regBase, nSkip);
823 VdbeCoverageIf(v, bRev==0);
824 VdbeCoverageIf(v, bRev!=0);
825 sqlite3VdbeJumpHere(v, j);
826 for(j=0; j<nSkip; j++){
827 sqlite3VdbeAddOp3(v, OP_Column, iIdxCur, j, regBase+j);
drh4b92f982015-09-29 17:20:14 +0000828 testcase( pIdx->aiColumn[j]==XN_EXPR );
drhe63e8a62015-09-18 18:09:28 +0000829 VdbeComment((v, "%s", explainIndexColumnName(pIdx, j)));
drh6f82e852015-06-06 20:12:09 +0000830 }
831 }
832
833 /* Evaluate the equality constraints
834 */
835 assert( zAff==0 || (int)strlen(zAff)>=nEq );
836 for(j=nSkip; j<nEq; j++){
837 int r1;
838 pTerm = pLoop->aLTerm[j];
839 assert( pTerm!=0 );
840 /* The following testcase is true for indices with redundant columns.
841 ** Ex: CREATE INDEX i1 ON t1(a,b,a); SELECT * FROM t1 WHERE a=0 AND b=0; */
842 testcase( (pTerm->wtFlags & TERM_CODED)!=0 );
843 testcase( pTerm->wtFlags & TERM_VIRTUAL );
844 r1 = codeEqualityTerm(pParse, pTerm, pLevel, j, bRev, regBase+j);
845 if( r1!=regBase+j ){
846 if( nReg==1 ){
847 sqlite3ReleaseTempReg(pParse, regBase);
848 regBase = r1;
849 }else{
drhe9de6522021-05-28 12:48:31 +0000850 sqlite3VdbeAddOp2(v, OP_Copy, r1, regBase+j);
drh6f82e852015-06-06 20:12:09 +0000851 }
852 }
drhe482fde2022-01-21 16:41:11 +0000853 }
854 for(j=nSkip; j<nEq; j++){
855 pTerm = pLoop->aLTerm[j];
drhc097e122016-09-07 13:30:40 +0000856 if( pTerm->eOperator & WO_IN ){
857 if( pTerm->pExpr->flags & EP_xIsSelect ){
858 /* No affinity ever needs to be (or should be) applied to a value
859 ** from the RHS of an "? IN (SELECT ...)" expression. The
860 ** sqlite3FindInIndex() routine has already ensured that the
861 ** affinity of the comparison has been applied to the value. */
862 if( zAff ) zAff[j] = SQLITE_AFF_BLOB;
863 }
864 }else if( (pTerm->eOperator & WO_ISNULL)==0 ){
865 Expr *pRight = pTerm->pExpr->pRight;
866 if( (pTerm->wtFlags & TERM_IS)==0 && sqlite3ExprCanBeNull(pRight) ){
867 sqlite3VdbeAddOp2(v, OP_IsNull, regBase+j, pLevel->addrBrk);
868 VdbeCoverage(v);
869 }
drh0c7d3d32022-01-24 16:47:12 +0000870 if( pParse->nErr==0 ){
871 assert( pParse->db->mallocFailed==0 );
drhc097e122016-09-07 13:30:40 +0000872 if( sqlite3CompareAffinity(pRight, zAff[j])==SQLITE_AFF_BLOB ){
873 zAff[j] = SQLITE_AFF_BLOB;
dan27189602016-09-03 15:31:20 +0000874 }
drhc097e122016-09-07 13:30:40 +0000875 if( sqlite3ExprNeedsNoAffinityChange(pRight, zAff[j]) ){
876 zAff[j] = SQLITE_AFF_BLOB;
drh6f82e852015-06-06 20:12:09 +0000877 }
878 }
879 }
880 }
881 *pzAff = zAff;
882 return regBase;
883}
884
drh41d2e662015-12-01 21:23:07 +0000885#ifndef SQLITE_LIKE_DOESNT_MATCH_BLOBS
drh6f82e852015-06-06 20:12:09 +0000886/*
drh44aebff2016-05-02 10:25:42 +0000887** If the most recently coded instruction is a constant range constraint
888** (a string literal) that originated from the LIKE optimization, then
889** set P3 and P5 on the OP_String opcode so that the string will be cast
890** to a BLOB at appropriate times.
drh6f82e852015-06-06 20:12:09 +0000891**
892** The LIKE optimization trys to evaluate "x LIKE 'abc%'" as a range
893** expression: "x>='ABC' AND x<'abd'". But this requires that the range
894** scan loop run twice, once for strings and a second time for BLOBs.
895** The OP_String opcodes on the second pass convert the upper and lower
mistachkine234cfd2016-07-10 19:35:10 +0000896** bound string constants to blobs. This routine makes the necessary changes
drh6f82e852015-06-06 20:12:09 +0000897** to the OP_String opcodes for that to happen.
drh41d2e662015-12-01 21:23:07 +0000898**
899** Except, of course, if SQLITE_LIKE_DOESNT_MATCH_BLOBS is defined, then
900** only the one pass through the string space is required, so this routine
901** becomes a no-op.
drh6f82e852015-06-06 20:12:09 +0000902*/
903static void whereLikeOptimizationStringFixup(
904 Vdbe *v, /* prepared statement under construction */
905 WhereLevel *pLevel, /* The loop that contains the LIKE operator */
906 WhereTerm *pTerm /* The upper or lower bound just coded */
907){
908 if( pTerm->wtFlags & TERM_LIKEOPT ){
909 VdbeOp *pOp;
910 assert( pLevel->iLikeRepCntr>0 );
drh058e9952022-07-25 19:05:24 +0000911 pOp = sqlite3VdbeGetLastOp(v);
drh6f82e852015-06-06 20:12:09 +0000912 assert( pOp!=0 );
913 assert( pOp->opcode==OP_String8
914 || pTerm->pWC->pWInfo->pParse->db->mallocFailed );
drh44aebff2016-05-02 10:25:42 +0000915 pOp->p3 = (int)(pLevel->iLikeRepCntr>>1); /* Register holding counter */
916 pOp->p5 = (u8)(pLevel->iLikeRepCntr&1); /* ASC or DESC */
drh6f82e852015-06-06 20:12:09 +0000917 }
918}
drh41d2e662015-12-01 21:23:07 +0000919#else
920# define whereLikeOptimizationStringFixup(A,B,C)
921#endif
drh6f82e852015-06-06 20:12:09 +0000922
drhbec24762015-08-13 20:07:13 +0000923#ifdef SQLITE_ENABLE_CURSOR_HINTS
drh2f2b0272015-08-14 18:50:04 +0000924/*
925** Information is passed from codeCursorHint() down to individual nodes of
926** the expression tree (by sqlite3WalkExpr()) using an instance of this
927** structure.
928*/
929struct CCurHint {
930 int iTabCur; /* Cursor for the main table */
931 int iIdxCur; /* Cursor for the index, if pIdx!=0. Unused otherwise */
932 Index *pIdx; /* The index used to access the table */
933};
934
935/*
936** This function is called for every node of an expression that is a candidate
937** for a cursor hint on an index cursor. For TK_COLUMN nodes that reference
938** the table CCurHint.iTabCur, verify that the same column can be
939** accessed through the index. If it cannot, then set pWalker->eCode to 1.
940*/
941static int codeCursorHintCheckExpr(Walker *pWalker, Expr *pExpr){
942 struct CCurHint *pHint = pWalker->u.pCCurHint;
943 assert( pHint->pIdx!=0 );
944 if( pExpr->op==TK_COLUMN
945 && pExpr->iTable==pHint->iTabCur
drhb9bcf7c2019-10-19 13:29:10 +0000946 && sqlite3TableColumnToIndex(pHint->pIdx, pExpr->iColumn)<0
drh2f2b0272015-08-14 18:50:04 +0000947 ){
948 pWalker->eCode = 1;
949 }
950 return WRC_Continue;
951}
952
dane6912fd2016-06-17 19:27:13 +0000953/*
954** Test whether or not expression pExpr, which was part of a WHERE clause,
955** should be included in the cursor-hint for a table that is on the rhs
956** of a LEFT JOIN. Set Walker.eCode to non-zero before returning if the
957** expression is not suitable.
958**
959** An expression is unsuitable if it might evaluate to non NULL even if
960** a TK_COLUMN node that does affect the value of the expression is set
961** to NULL. For example:
962**
963** col IS NULL
964** col IS NOT NULL
965** coalesce(col, 1)
966** CASE WHEN col THEN 0 ELSE 1 END
967*/
968static int codeCursorHintIsOrFunction(Walker *pWalker, Expr *pExpr){
dan2b693d62016-06-20 17:22:06 +0000969 if( pExpr->op==TK_IS
dane6912fd2016-06-17 19:27:13 +0000970 || pExpr->op==TK_ISNULL || pExpr->op==TK_ISNOT
971 || pExpr->op==TK_NOTNULL || pExpr->op==TK_CASE
972 ){
973 pWalker->eCode = 1;
dan2b693d62016-06-20 17:22:06 +0000974 }else if( pExpr->op==TK_FUNCTION ){
975 int d1;
drh1d42ea72017-07-27 20:24:29 +0000976 char d2[4];
dan2b693d62016-06-20 17:22:06 +0000977 if( 0==sqlite3IsLikeFunction(pWalker->pParse->db, pExpr, &d1, d2) ){
978 pWalker->eCode = 1;
979 }
dane6912fd2016-06-17 19:27:13 +0000980 }
dan2b693d62016-06-20 17:22:06 +0000981
dane6912fd2016-06-17 19:27:13 +0000982 return WRC_Continue;
983}
984
drhbec24762015-08-13 20:07:13 +0000985
986/*
987** This function is called on every node of an expression tree used as an
988** argument to the OP_CursorHint instruction. If the node is a TK_COLUMN
drh2f2b0272015-08-14 18:50:04 +0000989** that accesses any table other than the one identified by
990** CCurHint.iTabCur, then do the following:
drhbec24762015-08-13 20:07:13 +0000991**
992** 1) allocate a register and code an OP_Column instruction to read
993** the specified column into the new register, and
994**
995** 2) transform the expression node to a TK_REGISTER node that reads
996** from the newly populated register.
drh2f2b0272015-08-14 18:50:04 +0000997**
998** Also, if the node is a TK_COLUMN that does access the table idenified
999** by pCCurHint.iTabCur, and an index is being used (which we will
1000** know because CCurHint.pIdx!=0) then transform the TK_COLUMN into
1001** an access of the index rather than the original table.
drhbec24762015-08-13 20:07:13 +00001002*/
1003static int codeCursorHintFixExpr(Walker *pWalker, Expr *pExpr){
1004 int rc = WRC_Continue;
drh2f2b0272015-08-14 18:50:04 +00001005 struct CCurHint *pHint = pWalker->u.pCCurHint;
danbe312ae2018-09-10 19:27:12 +00001006 if( pExpr->op==TK_COLUMN ){
drh2f2b0272015-08-14 18:50:04 +00001007 if( pExpr->iTable!=pHint->iTabCur ){
drh2f2b0272015-08-14 18:50:04 +00001008 int reg = ++pWalker->pParse->nMem; /* Register for column value */
dane3e79212018-09-11 13:38:35 +00001009 sqlite3ExprCode(pWalker->pParse, pExpr, reg);
drh2f2b0272015-08-14 18:50:04 +00001010 pExpr->op = TK_REGISTER;
1011 pExpr->iTable = reg;
1012 }else if( pHint->pIdx!=0 ){
1013 pExpr->iTable = pHint->iIdxCur;
drhb9bcf7c2019-10-19 13:29:10 +00001014 pExpr->iColumn = sqlite3TableColumnToIndex(pHint->pIdx, pExpr->iColumn);
drh2f2b0272015-08-14 18:50:04 +00001015 assert( pExpr->iColumn>=0 );
1016 }
drhbec24762015-08-13 20:07:13 +00001017 }else if( pExpr->op==TK_AGG_FUNCTION ){
1018 /* An aggregate function in the WHERE clause of a query means this must
1019 ** be a correlated sub-query, and expression pExpr is an aggregate from
1020 ** the parent context. Do not walk the function arguments in this case.
1021 **
1022 ** todo: It should be possible to replace this node with a TK_REGISTER
1023 ** expression, as the result of the expression must be stored in a
1024 ** register at this point. The same holds for TK_AGG_COLUMN nodes. */
1025 rc = WRC_Prune;
1026 }
1027 return rc;
1028}
1029
1030/*
1031** Insert an OP_CursorHint instruction if it is appropriate to do so.
1032*/
1033static void codeCursorHint(
drh76012942021-02-21 21:04:54 +00001034 SrcItem *pTabItem, /* FROM clause item */
drhb413a542015-08-17 17:19:28 +00001035 WhereInfo *pWInfo, /* The where clause */
1036 WhereLevel *pLevel, /* Which loop to provide hints for */
1037 WhereTerm *pEndRange /* Hint this end-of-scan boundary term if not NULL */
drhbec24762015-08-13 20:07:13 +00001038){
1039 Parse *pParse = pWInfo->pParse;
1040 sqlite3 *db = pParse->db;
1041 Vdbe *v = pParse->pVdbe;
drhbec24762015-08-13 20:07:13 +00001042 Expr *pExpr = 0;
drh2f2b0272015-08-14 18:50:04 +00001043 WhereLoop *pLoop = pLevel->pWLoop;
drhbec24762015-08-13 20:07:13 +00001044 int iCur;
1045 WhereClause *pWC;
1046 WhereTerm *pTerm;
drhb413a542015-08-17 17:19:28 +00001047 int i, j;
drh2f2b0272015-08-14 18:50:04 +00001048 struct CCurHint sHint;
1049 Walker sWalker;
drhbec24762015-08-13 20:07:13 +00001050
1051 if( OptimizationDisabled(db, SQLITE_CursorHints) ) return;
drh2f2b0272015-08-14 18:50:04 +00001052 iCur = pLevel->iTabCur;
1053 assert( iCur==pWInfo->pTabList->a[pLevel->iFrom].iCursor );
1054 sHint.iTabCur = iCur;
1055 sHint.iIdxCur = pLevel->iIdxCur;
1056 sHint.pIdx = pLoop->u.btree.pIndex;
1057 memset(&sWalker, 0, sizeof(sWalker));
1058 sWalker.pParse = pParse;
1059 sWalker.u.pCCurHint = &sHint;
drhbec24762015-08-13 20:07:13 +00001060 pWC = &pWInfo->sWC;
drh132f96f2021-12-08 16:07:22 +00001061 for(i=0; i<pWC->nBase; i++){
drhbec24762015-08-13 20:07:13 +00001062 pTerm = &pWC->a[i];
1063 if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
1064 if( pTerm->prereqAll & pLevel->notReady ) continue;
danb324cf72016-06-17 14:33:32 +00001065
1066 /* Any terms specified as part of the ON(...) clause for any LEFT
1067 ** JOIN for which the current table is not the rhs are omitted
1068 ** from the cursor-hint.
1069 **
dane6912fd2016-06-17 19:27:13 +00001070 ** If this table is the rhs of a LEFT JOIN, "IS" or "IS NULL" terms
1071 ** that were specified as part of the WHERE clause must be excluded.
1072 ** This is to address the following:
danb324cf72016-06-17 14:33:32 +00001073 **
1074 ** SELECT ... t1 LEFT JOIN t2 ON (t1.a=t2.b) WHERE t2.c IS NULL;
1075 **
dane6912fd2016-06-17 19:27:13 +00001076 ** Say there is a single row in t2 that matches (t1.a=t2.b), but its
1077 ** t2.c values is not NULL. If the (t2.c IS NULL) constraint is
1078 ** pushed down to the cursor, this row is filtered out, causing
1079 ** SQLite to synthesize a row of NULL values. Which does match the
1080 ** WHERE clause, and so the query returns a row. Which is incorrect.
1081 **
1082 ** For the same reason, WHERE terms such as:
1083 **
1084 ** WHERE 1 = (t2.c IS NULL)
1085 **
1086 ** are also excluded. See codeCursorHintIsOrFunction() for details.
danb324cf72016-06-17 14:33:32 +00001087 */
1088 if( pTabItem->fg.jointype & JT_LEFT ){
dane6912fd2016-06-17 19:27:13 +00001089 Expr *pExpr = pTerm->pExpr;
drh67a99db2022-05-13 14:52:04 +00001090 if( !ExprHasProperty(pExpr, EP_OuterON)
drhd1985262022-04-11 11:25:28 +00001091 || pExpr->w.iJoin!=pTabItem->iCursor
danb324cf72016-06-17 14:33:32 +00001092 ){
dane6912fd2016-06-17 19:27:13 +00001093 sWalker.eCode = 0;
1094 sWalker.xExprCallback = codeCursorHintIsOrFunction;
1095 sqlite3WalkExpr(&sWalker, pTerm->pExpr);
1096 if( sWalker.eCode ) continue;
danb324cf72016-06-17 14:33:32 +00001097 }
1098 }else{
drh67a99db2022-05-13 14:52:04 +00001099 if( ExprHasProperty(pTerm->pExpr, EP_OuterON) ) continue;
danb324cf72016-06-17 14:33:32 +00001100 }
drhb413a542015-08-17 17:19:28 +00001101
1102 /* All terms in pWLoop->aLTerm[] except pEndRange are used to initialize
drhbcf40a72015-08-18 15:58:05 +00001103 ** the cursor. These terms are not needed as hints for a pure range
1104 ** scan (that has no == terms) so omit them. */
1105 if( pLoop->u.btree.nEq==0 && pTerm!=pEndRange ){
1106 for(j=0; j<pLoop->nLTerm && pLoop->aLTerm[j]!=pTerm; j++){}
1107 if( j<pLoop->nLTerm ) continue;
drhb413a542015-08-17 17:19:28 +00001108 }
1109
1110 /* No subqueries or non-deterministic functions allowed */
drhbec24762015-08-13 20:07:13 +00001111 if( sqlite3ExprContainsSubquery(pTerm->pExpr) ) continue;
drhb413a542015-08-17 17:19:28 +00001112
1113 /* For an index scan, make sure referenced columns are actually in
1114 ** the index. */
drh2f2b0272015-08-14 18:50:04 +00001115 if( sHint.pIdx!=0 ){
1116 sWalker.eCode = 0;
1117 sWalker.xExprCallback = codeCursorHintCheckExpr;
1118 sqlite3WalkExpr(&sWalker, pTerm->pExpr);
1119 if( sWalker.eCode ) continue;
1120 }
drhb413a542015-08-17 17:19:28 +00001121
1122 /* If we survive all prior tests, that means this term is worth hinting */
drhd5c851c2019-04-19 13:38:34 +00001123 pExpr = sqlite3ExprAnd(pParse, pExpr, sqlite3ExprDup(db, pTerm->pExpr, 0));
drhbec24762015-08-13 20:07:13 +00001124 }
1125 if( pExpr!=0 ){
drhbec24762015-08-13 20:07:13 +00001126 sWalker.xExprCallback = codeCursorHintFixExpr;
drhbec24762015-08-13 20:07:13 +00001127 sqlite3WalkExpr(&sWalker, pExpr);
drh2f2b0272015-08-14 18:50:04 +00001128 sqlite3VdbeAddOp4(v, OP_CursorHint,
1129 (sHint.pIdx ? sHint.iIdxCur : sHint.iTabCur), 0, 0,
1130 (const char*)pExpr, P4_EXPR);
drhbec24762015-08-13 20:07:13 +00001131 }
1132}
1133#else
danb324cf72016-06-17 14:33:32 +00001134# define codeCursorHint(A,B,C,D) /* No-op */
drhbec24762015-08-13 20:07:13 +00001135#endif /* SQLITE_ENABLE_CURSOR_HINTS */
drh6f82e852015-06-06 20:12:09 +00001136
1137/*
dande892d92016-01-29 19:29:45 +00001138** Cursor iCur is open on an intkey b-tree (a table). Register iRowid contains
1139** a rowid value just read from cursor iIdxCur, open on index pIdx. This
1140** function generates code to do a deferred seek of cursor iCur to the
1141** rowid stored in register iRowid.
1142**
1143** Normally, this is just:
1144**
drh170ad682017-06-02 15:44:22 +00001145** OP_DeferredSeek $iCur $iRowid
dande892d92016-01-29 19:29:45 +00001146**
drh7fd6a772022-02-25 13:29:56 +00001147** Which causes a seek on $iCur to the row with rowid $iRowid.
1148**
dande892d92016-01-29 19:29:45 +00001149** However, if the scan currently being coded is a branch of an OR-loop and
drh7fd6a772022-02-25 13:29:56 +00001150** the statement currently being coded is a SELECT, then additional information
1151** is added that might allow OP_Column to omit the seek and instead do its
1152** lookup on the index, thus avoiding an expensive seek operation. To
1153** enable this optimization, the P3 of OP_DeferredSeek is set to iIdxCur
1154** and P4 is set to an array of integers containing one entry for each column
1155** in the table. For each table column, if the column is the i'th
1156** column of the index, then the corresponding array entry is set to (i+1).
1157** If the column does not appear in the index at all, the array entry is set
1158** to 0. The OP_Column opcode can check this array to see if the column it
1159** wants is in the index and if it is, it will substitute the index cursor
1160** and column number and continue with those new values, rather than seeking
1161** the table cursor.
dande892d92016-01-29 19:29:45 +00001162*/
1163static void codeDeferredSeek(
1164 WhereInfo *pWInfo, /* Where clause context */
1165 Index *pIdx, /* Index scan is using */
1166 int iCur, /* Cursor for IPK b-tree */
dande892d92016-01-29 19:29:45 +00001167 int iIdxCur /* Index cursor */
1168){
1169 Parse *pParse = pWInfo->pParse; /* Parse context */
1170 Vdbe *v = pParse->pVdbe; /* Vdbe to generate code within */
1171
1172 assert( iIdxCur>0 );
1173 assert( pIdx->aiColumn[pIdx->nColumn-1]==-1 );
1174
drhbe3da242019-12-29 00:52:41 +00001175 pWInfo->bDeferredSeek = 1;
drh170ad682017-06-02 15:44:22 +00001176 sqlite3VdbeAddOp3(v, OP_DeferredSeek, iIdxCur, 0, iCur);
drhc5837192022-04-11 14:26:37 +00001177 if( (pWInfo->wctrlFlags & (WHERE_OR_SUBCLAUSE|WHERE_RIGHT_JOIN))
dancddb6ba2016-02-01 13:58:56 +00001178 && DbMaskAllZero(sqlite3ParseToplevel(pParse)->writeMask)
dande892d92016-01-29 19:29:45 +00001179 ){
1180 int i;
1181 Table *pTab = pIdx->pTable;
drhabc38152020-07-22 13:38:04 +00001182 u32 *ai = (u32*)sqlite3DbMallocZero(pParse->db, sizeof(u32)*(pTab->nCol+1));
dande892d92016-01-29 19:29:45 +00001183 if( ai ){
drhb1702022016-01-30 00:45:18 +00001184 ai[0] = pTab->nCol;
dande892d92016-01-29 19:29:45 +00001185 for(i=0; i<pIdx->nColumn-1; i++){
drh4fb24c82019-11-06 17:31:18 +00001186 int x1, x2;
dande892d92016-01-29 19:29:45 +00001187 assert( pIdx->aiColumn[i]<pTab->nCol );
drh4fb24c82019-11-06 17:31:18 +00001188 x1 = pIdx->aiColumn[i];
1189 x2 = sqlite3TableColumnToStorage(pTab, x1);
1190 testcase( x1!=x2 );
mistachkinbde3a4f2019-11-06 19:25:45 +00001191 if( x1>=0 ) ai[x2+1] = i+1;
dande892d92016-01-29 19:29:45 +00001192 }
1193 sqlite3VdbeChangeP4(v, -1, (char*)ai, P4_INTARRAY);
1194 }
1195 }
1196}
1197
dan553168c2016-08-01 20:14:31 +00001198/*
1199** If the expression passed as the second argument is a vector, generate
1200** code to write the first nReg elements of the vector into an array
1201** of registers starting with iReg.
1202**
1203** If the expression is not a vector, then nReg must be passed 1. In
1204** this case, generate code to evaluate the expression and leave the
1205** result in register iReg.
1206*/
dan71c57db2016-07-09 20:23:55 +00001207static void codeExprOrVector(Parse *pParse, Expr *p, int iReg, int nReg){
1208 assert( nReg>0 );
dand03024d2017-09-09 19:41:12 +00001209 if( p && sqlite3ExprIsVector(p) ){
danf9b2e052016-08-02 17:45:00 +00001210#ifndef SQLITE_OMIT_SUBQUERY
drha4eeccd2021-10-07 17:43:30 +00001211 if( ExprUseXSelect(p) ){
danf9b2e052016-08-02 17:45:00 +00001212 Vdbe *v = pParse->pVdbe;
drh85bcdce2018-12-23 21:27:29 +00001213 int iSelect;
1214 assert( p->op==TK_SELECT );
1215 iSelect = sqlite3CodeSubselect(pParse, p);
danf9b2e052016-08-02 17:45:00 +00001216 sqlite3VdbeAddOp3(v, OP_Copy, iSelect, iReg, nReg-1);
1217 }else
1218#endif
1219 {
1220 int i;
drha4eeccd2021-10-07 17:43:30 +00001221 const ExprList *pList;
1222 assert( ExprUseXList(p) );
1223 pList = p->x.pList;
dan71c57db2016-07-09 20:23:55 +00001224 assert( nReg<=pList->nExpr );
1225 for(i=0; i<nReg; i++){
1226 sqlite3ExprCode(pParse, pList->a[i].pExpr, iReg+i);
1227 }
dan71c57db2016-07-09 20:23:55 +00001228 }
1229 }else{
dan151446e2021-05-26 14:32:33 +00001230 assert( nReg==1 || pParse->nErr );
dan71c57db2016-07-09 20:23:55 +00001231 sqlite3ExprCode(pParse, p, iReg);
1232 }
1233}
1234
dande892d92016-01-29 19:29:45 +00001235/*
drh610f11d2019-03-18 10:30:00 +00001236** The pTruth expression is always true because it is the WHERE clause
drhb531aa82019-03-01 18:07:05 +00001237** a partial index that is driving a query loop. Look through all of the
1238** WHERE clause terms on the query, and if any of those terms must be
1239** true because pTruth is true, then mark those WHERE clause terms as
1240** coded.
1241*/
1242static void whereApplyPartialIndexConstraints(
1243 Expr *pTruth,
1244 int iTabCur,
1245 WhereClause *pWC
1246){
1247 int i;
1248 WhereTerm *pTerm;
1249 while( pTruth->op==TK_AND ){
1250 whereApplyPartialIndexConstraints(pTruth->pLeft, iTabCur, pWC);
1251 pTruth = pTruth->pRight;
1252 }
1253 for(i=0, pTerm=pWC->a; i<pWC->nTerm; i++, pTerm++){
1254 Expr *pExpr;
1255 if( pTerm->wtFlags & TERM_CODED ) continue;
1256 pExpr = pTerm->pExpr;
1257 if( sqlite3ExprCompare(0, pExpr, pTruth, iTabCur)==0 ){
1258 pTerm->wtFlags |= TERM_CODED;
1259 }
1260 }
1261}
1262
drh35685d32021-12-05 00:45:55 +00001263/*
drh6ae49e62021-12-05 20:19:47 +00001264** This routine is called right after An OP_Filter has been generated and
1265** before the corresponding index search has been performed. This routine
1266** checks to see if there are additional Bloom filters in inner loops that
1267** can be checked prior to doing the index lookup. If there are available
1268** inner-loop Bloom filters, then evaluate those filters now, before the
1269** index lookup. The idea is that a Bloom filter check is way faster than
1270** an index lookup, and the Bloom filter might return false, meaning that
1271** the index lookup can be skipped.
1272**
1273** We know that an inner loop uses a Bloom filter because it has the
1274** WhereLevel.regFilter set. If an inner-loop Bloom filter is checked,
drh5a4ac1c2021-12-09 19:42:52 +00001275** then clear the WhereLevel.regFilter value to prevent the Bloom filter
drh6ae49e62021-12-05 20:19:47 +00001276** from being checked a second time when the inner loop is evaluated.
drh35685d32021-12-05 00:45:55 +00001277*/
1278static SQLITE_NOINLINE void filterPullDown(
1279 Parse *pParse, /* Parsing context */
1280 WhereInfo *pWInfo, /* Complete information about the WHERE clause */
1281 int iLevel, /* Which level of pWInfo->a[] should be coded */
1282 int addrNxt, /* Jump here to bypass inner loops */
1283 Bitmask notReady /* Loops that are not ready */
1284){
1285 while( ++iLevel < pWInfo->nLevel ){
1286 WhereLevel *pLevel = &pWInfo->a[iLevel];
1287 WhereLoop *pLoop = pLevel->pWLoop;
drh6ae49e62021-12-05 20:19:47 +00001288 if( pLevel->regFilter==0 ) continue;
drh56945692022-03-02 21:04:10 +00001289 if( pLevel->pWLoop->nSkip ) continue;
drh27a9e1f2021-12-10 17:36:16 +00001290 /* ,--- Because sqlite3ConstructBloomFilter() has will not have set
drha11c5e22021-12-09 18:44:03 +00001291 ** vvvvv--' pLevel->regFilter if this were true. */
1292 if( NEVER(pLoop->prereq & notReady) ) continue;
drh8aa7f4d2022-05-03 14:01:48 +00001293 assert( pLevel->addrBrk==0 );
1294 pLevel->addrBrk = addrNxt;
drh35685d32021-12-05 00:45:55 +00001295 if( pLoop->wsFlags & WHERE_IPK ){
1296 WhereTerm *pTerm = pLoop->aLTerm[0];
drh7e910f62021-12-09 01:28:15 +00001297 int regRowid;
drh35685d32021-12-05 00:45:55 +00001298 assert( pTerm!=0 );
1299 assert( pTerm->pExpr!=0 );
1300 testcase( pTerm->wtFlags & TERM_VIRTUAL );
drh7e910f62021-12-09 01:28:15 +00001301 regRowid = sqlite3GetTempReg(pParse);
1302 regRowid = codeEqualityTerm(pParse, pTerm, pLevel, 0, 0, regRowid);
dan73ac9582022-10-06 14:10:11 +00001303 sqlite3VdbeAddOp2(pParse->pVdbe, OP_MustBeInt, regRowid, addrNxt);
1304 VdbeCoverage(pParse->pVdbe);
drh35685d32021-12-05 00:45:55 +00001305 sqlite3VdbeAddOp4Int(pParse->pVdbe, OP_Filter, pLevel->regFilter,
1306 addrNxt, regRowid, 1);
1307 VdbeCoverage(pParse->pVdbe);
1308 }else{
1309 u16 nEq = pLoop->u.btree.nEq;
1310 int r1;
1311 char *zStartAff;
1312
1313 assert( pLoop->wsFlags & WHERE_INDEXED );
drhdc56dc92021-12-11 17:10:58 +00001314 assert( (pLoop->wsFlags & WHERE_COLUMN_IN)==0 );
drh35685d32021-12-05 00:45:55 +00001315 r1 = codeAllEqualityTerms(pParse,pLevel,0,0,&zStartAff);
1316 codeApplyAffinity(pParse, r1, nEq, zStartAff);
1317 sqlite3DbFree(pParse->db, zStartAff);
1318 sqlite3VdbeAddOp4Int(pParse->pVdbe, OP_Filter, pLevel->regFilter,
1319 addrNxt, r1, nEq);
1320 VdbeCoverage(pParse->pVdbe);
1321 }
drh6ae49e62021-12-05 20:19:47 +00001322 pLevel->regFilter = 0;
drh8aa7f4d2022-05-03 14:01:48 +00001323 pLevel->addrBrk = 0;
drh35685d32021-12-05 00:45:55 +00001324 }
1325}
drh35685d32021-12-05 00:45:55 +00001326
drhb531aa82019-03-01 18:07:05 +00001327/*
drh6f82e852015-06-06 20:12:09 +00001328** Generate code for the start of the iLevel-th loop in the WHERE clause
1329** implementation described by pWInfo.
1330*/
1331Bitmask sqlite3WhereCodeOneLoopStart(
drh47df8a22018-12-25 00:15:37 +00001332 Parse *pParse, /* Parsing context */
1333 Vdbe *v, /* Prepared statement under construction */
drh6f82e852015-06-06 20:12:09 +00001334 WhereInfo *pWInfo, /* Complete information about the WHERE clause */
1335 int iLevel, /* Which level of pWInfo->a[] should be coded */
drh47df8a22018-12-25 00:15:37 +00001336 WhereLevel *pLevel, /* The current level pointer */
drh6f82e852015-06-06 20:12:09 +00001337 Bitmask notReady /* Which tables are currently available */
1338){
1339 int j, k; /* Loop counters */
1340 int iCur; /* The VDBE cursor for the table */
1341 int addrNxt; /* Where to jump to continue with the next IN case */
drh6f82e852015-06-06 20:12:09 +00001342 int bRev; /* True if we need to scan in reverse order */
drh6f82e852015-06-06 20:12:09 +00001343 WhereLoop *pLoop; /* The WhereLoop object being coded */
1344 WhereClause *pWC; /* Decomposition of the entire WHERE clause */
1345 WhereTerm *pTerm; /* A WHERE clause term */
drh6f82e852015-06-06 20:12:09 +00001346 sqlite3 *db; /* Database connection */
drh76012942021-02-21 21:04:54 +00001347 SrcItem *pTabItem; /* FROM clause term being coded */
drh6f82e852015-06-06 20:12:09 +00001348 int addrBrk; /* Jump here to break out of the loop */
drh3a3b4202017-02-15 22:36:15 +00001349 int addrHalt; /* addrBrk for the outermost loop */
drh6f82e852015-06-06 20:12:09 +00001350 int addrCont; /* Jump here to continue with next cycle */
1351 int iRowidReg = 0; /* Rowid is stored in this register, if not zero */
1352 int iReleaseReg = 0; /* Temp register to free before returning */
dan6f654a42017-04-28 19:59:55 +00001353 Index *pIdx = 0; /* Index used by loop (if any) */
danebc63012017-07-10 14:33:00 +00001354 int iLoop; /* Iteration of constraint generator loop */
drh6f82e852015-06-06 20:12:09 +00001355
drh6f82e852015-06-06 20:12:09 +00001356 pWC = &pWInfo->sWC;
1357 db = pParse->db;
drh6f82e852015-06-06 20:12:09 +00001358 pLoop = pLevel->pWLoop;
1359 pTabItem = &pWInfo->pTabList->a[pLevel->iFrom];
1360 iCur = pTabItem->iCursor;
1361 pLevel->notReady = notReady & ~sqlite3WhereGetMask(&pWInfo->sMaskSet, iCur);
1362 bRev = (pWInfo->revMask>>iLevel)&1;
drh6f82e852015-06-06 20:12:09 +00001363 VdbeModuleComment((v, "Begin WHERE-loop%d: %s",iLevel,pTabItem->pTab->zName));
drh2a757652022-11-30 19:11:31 +00001364#if WHERETRACE_ENABLED /* 0x4001 */
1365 if( sqlite3WhereTrace & 0x1 ){
drha4b2df52019-12-28 16:20:23 +00001366 sqlite3DebugPrintf("Coding level %d of %d: notReady=%llx iFrom=%d\n",
1367 iLevel, pWInfo->nLevel, (u64)notReady, pLevel->iFrom);
drh2a757652022-11-30 19:11:31 +00001368 if( sqlite3WhereTrace & 0x1000 ){
1369 sqlite3WhereLoopPrint(pLoop, pWC);
1370 }
drh118efd12019-12-28 14:07:22 +00001371 }
drh2a757652022-11-30 19:11:31 +00001372 if( (sqlite3WhereTrace & 0x4001)==0x4001 ){
drhf1bb31e2019-12-28 14:33:26 +00001373 if( iLevel==0 ){
1374 sqlite3DebugPrintf("WHERE clause being coded:\n");
1375 sqlite3TreeViewExpr(0, pWInfo->pWhere, 0);
1376 }
1377 sqlite3DebugPrintf("All WHERE-clause terms before coding:\n");
drh118efd12019-12-28 14:07:22 +00001378 sqlite3WhereClausePrint(pWC);
1379 }
1380#endif
drh6f82e852015-06-06 20:12:09 +00001381
1382 /* Create labels for the "break" and "continue" instructions
1383 ** for the current loop. Jump to addrBrk to break out of a loop.
1384 ** Jump to cont to go immediately to the next iteration of the
1385 ** loop.
1386 **
1387 ** When there is an IN operator, we also have a "addrNxt" label that
1388 ** means to continue with the next IN value combination. When
1389 ** there are no IN operators in the constraints, the "addrNxt" label
1390 ** is the same as "addrBrk".
1391 */
drhec4ccdb2018-12-29 02:26:59 +00001392 addrBrk = pLevel->addrBrk = pLevel->addrNxt = sqlite3VdbeMakeLabel(pParse);
1393 addrCont = pLevel->addrCont = sqlite3VdbeMakeLabel(pParse);
drh6f82e852015-06-06 20:12:09 +00001394
1395 /* If this is the right table of a LEFT OUTER JOIN, allocate and
1396 ** initialize a memory cell that records if this table matches any
1397 ** row of the left table of the join.
1398 */
drhc5837192022-04-11 14:26:37 +00001399 assert( (pWInfo->wctrlFlags & (WHERE_OR_SUBCLAUSE|WHERE_RIGHT_JOIN))
dan820fcd22018-04-24 18:53:24 +00001400 || pLevel->iFrom>0 || (pTabItem[0].fg.jointype & JT_LEFT)==0
1401 );
drh8a48b9c2015-08-19 15:20:00 +00001402 if( pLevel->iFrom>0 && (pTabItem[0].fg.jointype & JT_LEFT)!=0 ){
drh6f82e852015-06-06 20:12:09 +00001403 pLevel->iLeftJoin = ++pParse->nMem;
1404 sqlite3VdbeAddOp2(v, OP_Integer, 0, pLevel->iLeftJoin);
1405 VdbeComment((v, "init LEFT JOIN no-match flag"));
1406 }
1407
drh3a3b4202017-02-15 22:36:15 +00001408 /* Compute a safe address to jump to if we discover that the table for
1409 ** this loop is empty and can never contribute content. */
drhd875c7e2022-04-18 10:26:50 +00001410 for(j=iLevel; j>0; j--){
1411 if( pWInfo->a[j].iLeftJoin ) break;
1412 if( pWInfo->a[j].pRJ ) break;
1413 }
drh3a3b4202017-02-15 22:36:15 +00001414 addrHalt = pWInfo->a[j].addrBrk;
1415
drh6f82e852015-06-06 20:12:09 +00001416 /* Special case of a FROM clause subquery implemented as a co-routine */
drh8a48b9c2015-08-19 15:20:00 +00001417 if( pTabItem->fg.viaCoroutine ){
drh6f82e852015-06-06 20:12:09 +00001418 int regYield = pTabItem->regReturn;
1419 sqlite3VdbeAddOp3(v, OP_InitCoroutine, regYield, 0, pTabItem->addrFillSub);
1420 pLevel->p2 = sqlite3VdbeAddOp2(v, OP_Yield, regYield, addrBrk);
1421 VdbeCoverage(v);
drhfef37762018-07-10 19:48:35 +00001422 VdbeComment((v, "next row of %s", pTabItem->pTab->zName));
drh6f82e852015-06-06 20:12:09 +00001423 pLevel->op = OP_Goto;
1424 }else
1425
1426#ifndef SQLITE_OMIT_VIRTUALTABLE
1427 if( (pLoop->wsFlags & WHERE_VIRTUALTABLE)!=0 ){
1428 /* Case 1: The table is a virtual-table. Use the VFilter and VNext
1429 ** to access the data.
1430 */
1431 int iReg; /* P3 Value for OP_VFilter */
1432 int addrNotFound;
1433 int nConstraint = pLoop->nLTerm;
1434
drh6f82e852015-06-06 20:12:09 +00001435 iReg = sqlite3GetTempRange(pParse, nConstraint+2);
1436 addrNotFound = pLevel->addrBrk;
1437 for(j=0; j<nConstraint; j++){
1438 int iTarget = iReg+j+2;
1439 pTerm = pLoop->aLTerm[j];
drh599d5762016-03-08 01:11:51 +00001440 if( NEVER(pTerm==0) ) continue;
drh6f82e852015-06-06 20:12:09 +00001441 if( pTerm->eOperator & WO_IN ){
drh0fe7e7d2022-02-01 14:58:29 +00001442 if( SMASKBIT32(j) & pLoop->u.vtab.mHandleIn ){
1443 int iTab = pParse->nTab++;
1444 int iCache = ++pParse->nMem;
1445 sqlite3CodeRhsOfIN(pParse, pTerm->pExpr, iTab);
1446 sqlite3VdbeAddOp3(v, OP_VInitIn, iTab, iTarget, iCache);
1447 }else{
1448 codeEqualityTerm(pParse, pTerm, pLevel, j, bRev, iTarget);
1449 addrNotFound = pLevel->addrNxt;
1450 }
drh6f82e852015-06-06 20:12:09 +00001451 }else{
dan6256c1c2016-08-08 20:15:41 +00001452 Expr *pRight = pTerm->pExpr->pRight;
drhfc7f27b2016-08-20 00:07:01 +00001453 codeExprOrVector(pParse, pRight, iTarget, 1);
drh8f2c0b52022-01-27 21:18:14 +00001454 if( pTerm->eMatchOp==SQLITE_INDEX_CONSTRAINT_OFFSET
1455 && pLoop->u.vtab.bOmitOffset
1456 ){
1457 assert( pTerm->eOperator==WO_AUX );
drhf55a7da2022-10-22 14:16:02 +00001458 assert( pWInfo->pSelect!=0 );
1459 assert( pWInfo->pSelect->iOffset>0 );
1460 sqlite3VdbeAddOp2(v, OP_Integer, 0, pWInfo->pSelect->iOffset);
drh8f2c0b52022-01-27 21:18:14 +00001461 VdbeComment((v,"Zero OFFSET counter"));
1462 }
drh6f82e852015-06-06 20:12:09 +00001463 }
1464 }
1465 sqlite3VdbeAddOp2(v, OP_Integer, pLoop->u.vtab.idxNum, iReg);
1466 sqlite3VdbeAddOp2(v, OP_Integer, nConstraint, iReg+1);
1467 sqlite3VdbeAddOp4(v, OP_VFilter, iCur, addrNotFound, iReg,
1468 pLoop->u.vtab.idxStr,
drh861b1302016-12-07 20:22:31 +00001469 pLoop->u.vtab.needFree ? P4_DYNAMIC : P4_STATIC);
drh6f82e852015-06-06 20:12:09 +00001470 VdbeCoverage(v);
1471 pLoop->u.vtab.needFree = 0;
drhbc2e9512020-09-17 11:32:14 +00001472 /* An OOM inside of AddOp4(OP_VFilter) instruction above might have freed
1473 ** the u.vtab.idxStr. NULL it out to prevent a use-after-free */
1474 if( db->mallocFailed ) pLoop->u.vtab.idxStr = 0;
drh6f82e852015-06-06 20:12:09 +00001475 pLevel->p1 = iCur;
dan354474a2015-09-29 10:11:26 +00001476 pLevel->op = pWInfo->eOnePass ? OP_Noop : OP_VNext;
drh6f82e852015-06-06 20:12:09 +00001477 pLevel->p2 = sqlite3VdbeCurrentAddr(v);
drh04756292021-10-14 19:28:28 +00001478 assert( (pLoop->wsFlags & WHERE_MULTI_OR)==0 );
drh6d6ea422022-03-07 14:51:29 +00001479
1480 for(j=0; j<nConstraint; j++){
drhdbc49162016-03-02 03:28:07 +00001481 pTerm = pLoop->aLTerm[j];
1482 if( j<16 && (pLoop->u.vtab.omitMask>>j)&1 ){
1483 disableTerm(pLevel, pTerm);
drh6d6ea422022-03-07 14:51:29 +00001484 continue;
1485 }
1486 if( (pTerm->eOperator & WO_IN)!=0
1487 && (SMASKBIT32(j) & pLoop->u.vtab.mHandleIn)==0
1488 && !db->mallocFailed
1489 ){
drhdbc49162016-03-02 03:28:07 +00001490 Expr *pCompare; /* The comparison operator */
1491 Expr *pRight; /* RHS of the comparison */
1492 VdbeOp *pOp; /* Opcode to access the value of the IN constraint */
drh6d6ea422022-03-07 14:51:29 +00001493 int iIn; /* IN loop corresponding to the j-th constraint */
drhdbc49162016-03-02 03:28:07 +00001494
1495 /* Reload the constraint value into reg[iReg+j+2]. The same value
1496 ** was loaded into the same register prior to the OP_VFilter, but
1497 ** the xFilter implementation might have changed the datatype or
drh6d6ea422022-03-07 14:51:29 +00001498 ** encoding of the value in the register, so it *must* be reloaded.
1499 */
1500 for(iIn=0; ALWAYS(iIn<pLevel->u.in.nIn); iIn++){
drh68748ec2019-10-14 20:32:31 +00001501 pOp = sqlite3VdbeGetOp(v, pLevel->u.in.aInLoop[iIn].addrInTop);
drh6d6ea422022-03-07 14:51:29 +00001502 if( (pOp->opcode==OP_Column && pOp->p3==iReg+j+2)
1503 || (pOp->opcode==OP_Rowid && pOp->p2==iReg+j+2)
1504 ){
1505 testcase( pOp->opcode==OP_Rowid );
1506 sqlite3VdbeAddOp3(v, pOp->opcode, pOp->p1, pOp->p2, pOp->p3);
1507 break;
1508 }
drhdbc49162016-03-02 03:28:07 +00001509 }
1510
1511 /* Generate code that will continue to the next row if
drh6d6ea422022-03-07 14:51:29 +00001512 ** the IN constraint is not satisfied
1513 */
drhabfd35e2016-12-06 22:47:23 +00001514 pCompare = sqlite3PExpr(pParse, TK_EQ, 0, 0);
drh6d6ea422022-03-07 14:51:29 +00001515 if( !db->mallocFailed ){
1516 int iFld = pTerm->u.x.iField;
1517 Expr *pLeft = pTerm->pExpr->pLeft;
1518 assert( pLeft!=0 );
1519 if( iFld>0 ){
1520 assert( pLeft->op==TK_VECTOR );
1521 assert( ExprUseXList(pLeft) );
1522 assert( iFld<=pLeft->x.pList->nExpr );
1523 pCompare->pLeft = pLeft->x.pList->a[iFld-1].pExpr;
1524 }else{
1525 pCompare->pLeft = pLeft;
1526 }
drhdbc49162016-03-02 03:28:07 +00001527 pCompare->pRight = pRight = sqlite3Expr(db, TK_REGISTER, 0);
drh237b2b72016-03-07 19:08:27 +00001528 if( pRight ){
1529 pRight->iTable = iReg+j+2;
dand03f77a2020-01-29 15:03:01 +00001530 sqlite3ExprIfFalse(
1531 pParse, pCompare, pLevel->addrCont, SQLITE_JUMPIFNULL
1532 );
drh237b2b72016-03-07 19:08:27 +00001533 }
drhdbc49162016-03-02 03:28:07 +00001534 pCompare->pLeft = 0;
drhdbc49162016-03-02 03:28:07 +00001535 }
drh6d6ea422022-03-07 14:51:29 +00001536 sqlite3ExprDelete(db, pCompare);
drhdbc49162016-03-02 03:28:07 +00001537 }
1538 }
drh6d6ea422022-03-07 14:51:29 +00001539
drhba26faa2016-04-09 18:04:28 +00001540 /* These registers need to be preserved in case there is an IN operator
1541 ** loop. So we could deallocate the registers here (and potentially
1542 ** reuse them later) if (pLoop->wsFlags & WHERE_IN_ABLE)==0. But it seems
1543 ** simpler and safer to simply not reuse the registers.
1544 **
1545 ** sqlite3ReleaseTempRange(pParse, iReg, nConstraint+2);
1546 */
drh6f82e852015-06-06 20:12:09 +00001547 }else
1548#endif /* SQLITE_OMIT_VIRTUALTABLE */
1549
1550 if( (pLoop->wsFlags & WHERE_IPK)!=0
1551 && (pLoop->wsFlags & (WHERE_COLUMN_IN|WHERE_COLUMN_EQ))!=0
1552 ){
1553 /* Case 2: We can directly reference a single row using an
1554 ** equality comparison against the ROWID field. Or
1555 ** we reference multiple rows using a "rowid IN (...)"
1556 ** construct.
1557 */
1558 assert( pLoop->u.btree.nEq==1 );
1559 pTerm = pLoop->aLTerm[0];
1560 assert( pTerm!=0 );
1561 assert( pTerm->pExpr!=0 );
drh6f82e852015-06-06 20:12:09 +00001562 testcase( pTerm->wtFlags & TERM_VIRTUAL );
1563 iReleaseReg = ++pParse->nMem;
1564 iRowidReg = codeEqualityTerm(pParse, pTerm, pLevel, 0, bRev, iReleaseReg);
1565 if( iRowidReg!=iReleaseReg ) sqlite3ReleaseTempReg(pParse, iReleaseReg);
1566 addrNxt = pLevel->addrNxt;
drh2db144c2021-12-01 16:31:02 +00001567 if( pLevel->regFilter ){
dan73ac9582022-10-06 14:10:11 +00001568 sqlite3VdbeAddOp2(v, OP_MustBeInt, iRowidReg, addrNxt);
1569 VdbeCoverage(v);
drh2db144c2021-12-01 16:31:02 +00001570 sqlite3VdbeAddOp4Int(v, OP_Filter, pLevel->regFilter, addrNxt,
1571 iRowidReg, 1);
drh067c60c2021-12-04 18:45:08 +00001572 VdbeCoverage(v);
drh35685d32021-12-05 00:45:55 +00001573 filterPullDown(pParse, pWInfo, iLevel, addrNxt, notReady);
drh2db144c2021-12-01 16:31:02 +00001574 }
drheeb95652016-05-26 20:56:38 +00001575 sqlite3VdbeAddOp3(v, OP_SeekRowid, iCur, addrNxt, iRowidReg);
drh6f82e852015-06-06 20:12:09 +00001576 VdbeCoverage(v);
drh6f82e852015-06-06 20:12:09 +00001577 pLevel->op = OP_Noop;
1578 }else if( (pLoop->wsFlags & WHERE_IPK)!=0
1579 && (pLoop->wsFlags & WHERE_COLUMN_RANGE)!=0
1580 ){
1581 /* Case 3: We have an inequality comparison against the ROWID field.
1582 */
1583 int testOp = OP_Noop;
1584 int start;
1585 int memEndValue = 0;
1586 WhereTerm *pStart, *pEnd;
1587
drh6f82e852015-06-06 20:12:09 +00001588 j = 0;
1589 pStart = pEnd = 0;
1590 if( pLoop->wsFlags & WHERE_BTM_LIMIT ) pStart = pLoop->aLTerm[j++];
1591 if( pLoop->wsFlags & WHERE_TOP_LIMIT ) pEnd = pLoop->aLTerm[j++];
1592 assert( pStart!=0 || pEnd!=0 );
1593 if( bRev ){
1594 pTerm = pStart;
1595 pStart = pEnd;
1596 pEnd = pTerm;
1597 }
danb324cf72016-06-17 14:33:32 +00001598 codeCursorHint(pTabItem, pWInfo, pLevel, pEnd);
drh6f82e852015-06-06 20:12:09 +00001599 if( pStart ){
1600 Expr *pX; /* The expression that defines the start bound */
1601 int r1, rTemp; /* Registers for holding the start boundary */
dan19ff12d2016-07-29 20:58:19 +00001602 int op; /* Cursor seek operation */
drh6f82e852015-06-06 20:12:09 +00001603
1604 /* The following constant maps TK_xx codes into corresponding
1605 ** seek opcodes. It depends on a particular ordering of TK_xx
1606 */
1607 const u8 aMoveOp[] = {
1608 /* TK_GT */ OP_SeekGT,
1609 /* TK_LE */ OP_SeekLE,
1610 /* TK_LT */ OP_SeekLT,
1611 /* TK_GE */ OP_SeekGE
1612 };
1613 assert( TK_LE==TK_GT+1 ); /* Make sure the ordering.. */
1614 assert( TK_LT==TK_GT+2 ); /* ... of the TK_xx values... */
1615 assert( TK_GE==TK_GT+3 ); /* ... is correcct. */
1616
1617 assert( (pStart->wtFlags & TERM_VNULL)==0 );
1618 testcase( pStart->wtFlags & TERM_VIRTUAL );
1619 pX = pStart->pExpr;
1620 assert( pX!=0 );
1621 testcase( pStart->leftCursor!=iCur ); /* transitive constraints */
dan625015e2016-07-30 16:39:28 +00001622 if( sqlite3ExprIsVector(pX->pRight) ){
dan19ff12d2016-07-29 20:58:19 +00001623 r1 = rTemp = sqlite3GetTempReg(pParse);
1624 codeExprOrVector(pParse, pX->pRight, r1, 1);
drh4d1c6842018-02-13 18:48:08 +00001625 testcase( pX->op==TK_GT );
1626 testcase( pX->op==TK_GE );
1627 testcase( pX->op==TK_LT );
1628 testcase( pX->op==TK_LE );
1629 op = aMoveOp[((pX->op - TK_GT - 1) & 0x3) | 0x1];
1630 assert( pX->op!=TK_GT || op==OP_SeekGE );
1631 assert( pX->op!=TK_GE || op==OP_SeekGE );
1632 assert( pX->op!=TK_LT || op==OP_SeekLE );
1633 assert( pX->op!=TK_LE || op==OP_SeekLE );
dan19ff12d2016-07-29 20:58:19 +00001634 }else{
1635 r1 = sqlite3ExprCodeTemp(pParse, pX->pRight, &rTemp);
1636 disableTerm(pLevel, pStart);
1637 op = aMoveOp[(pX->op - TK_GT)];
1638 }
1639 sqlite3VdbeAddOp3(v, op, iCur, addrBrk, r1);
drh6f82e852015-06-06 20:12:09 +00001640 VdbeComment((v, "pk"));
1641 VdbeCoverageIf(v, pX->op==TK_GT);
1642 VdbeCoverageIf(v, pX->op==TK_LE);
1643 VdbeCoverageIf(v, pX->op==TK_LT);
1644 VdbeCoverageIf(v, pX->op==TK_GE);
drh6f82e852015-06-06 20:12:09 +00001645 sqlite3ReleaseTempReg(pParse, rTemp);
drh6f82e852015-06-06 20:12:09 +00001646 }else{
drh3a3b4202017-02-15 22:36:15 +00001647 sqlite3VdbeAddOp2(v, bRev ? OP_Last : OP_Rewind, iCur, addrHalt);
drh6f82e852015-06-06 20:12:09 +00001648 VdbeCoverageIf(v, bRev==0);
1649 VdbeCoverageIf(v, bRev!=0);
1650 }
1651 if( pEnd ){
1652 Expr *pX;
1653 pX = pEnd->pExpr;
1654 assert( pX!=0 );
1655 assert( (pEnd->wtFlags & TERM_VNULL)==0 );
1656 testcase( pEnd->leftCursor!=iCur ); /* Transitive constraints */
1657 testcase( pEnd->wtFlags & TERM_VIRTUAL );
1658 memEndValue = ++pParse->nMem;
dan19ff12d2016-07-29 20:58:19 +00001659 codeExprOrVector(pParse, pX->pRight, memEndValue, 1);
dan625015e2016-07-30 16:39:28 +00001660 if( 0==sqlite3ExprIsVector(pX->pRight)
1661 && (pX->op==TK_LT || pX->op==TK_GT)
1662 ){
drh6f82e852015-06-06 20:12:09 +00001663 testOp = bRev ? OP_Le : OP_Ge;
1664 }else{
1665 testOp = bRev ? OP_Lt : OP_Gt;
1666 }
dan553168c2016-08-01 20:14:31 +00001667 if( 0==sqlite3ExprIsVector(pX->pRight) ){
1668 disableTerm(pLevel, pEnd);
1669 }
drh6f82e852015-06-06 20:12:09 +00001670 }
1671 start = sqlite3VdbeCurrentAddr(v);
1672 pLevel->op = bRev ? OP_Prev : OP_Next;
1673 pLevel->p1 = iCur;
1674 pLevel->p2 = start;
1675 assert( pLevel->p5==0 );
1676 if( testOp!=OP_Noop ){
1677 iRowidReg = ++pParse->nMem;
1678 sqlite3VdbeAddOp2(v, OP_Rowid, iCur, iRowidReg);
drh6f82e852015-06-06 20:12:09 +00001679 sqlite3VdbeAddOp3(v, testOp, memEndValue, addrBrk, iRowidReg);
1680 VdbeCoverageIf(v, testOp==OP_Le);
1681 VdbeCoverageIf(v, testOp==OP_Lt);
1682 VdbeCoverageIf(v, testOp==OP_Ge);
1683 VdbeCoverageIf(v, testOp==OP_Gt);
1684 sqlite3VdbeChangeP5(v, SQLITE_AFF_NUMERIC | SQLITE_JUMPIFNULL);
1685 }
1686 }else if( pLoop->wsFlags & WHERE_INDEXED ){
1687 /* Case 4: A scan using an index.
1688 **
1689 ** The WHERE clause may contain zero or more equality
1690 ** terms ("==" or "IN" operators) that refer to the N
1691 ** left-most columns of the index. It may also contain
1692 ** inequality constraints (>, <, >= or <=) on the indexed
1693 ** column that immediately follows the N equalities. Only
1694 ** the right-most column can be an inequality - the rest must
1695 ** use the "==" and "IN" operators. For example, if the
1696 ** index is on (x,y,z), then the following clauses are all
1697 ** optimized:
1698 **
1699 ** x=5
1700 ** x=5 AND y=10
1701 ** x=5 AND y<10
1702 ** x=5 AND y>5 AND y<10
1703 ** x=5 AND y=5 AND z<=10
1704 **
1705 ** The z<10 term of the following cannot be used, only
1706 ** the x=5 term:
1707 **
1708 ** x=5 AND z<10
1709 **
1710 ** N may be zero if there are inequality constraints.
1711 ** If there are no inequality constraints, then N is at
1712 ** least one.
1713 **
1714 ** This case is also used when there are no WHERE clause
1715 ** constraints but an index is selected anyway, in order
1716 ** to force the output order to conform to an ORDER BY.
1717 */
1718 static const u8 aStartOp[] = {
1719 0,
1720 0,
1721 OP_Rewind, /* 2: (!start_constraints && startEq && !bRev) */
1722 OP_Last, /* 3: (!start_constraints && startEq && bRev) */
1723 OP_SeekGT, /* 4: (start_constraints && !startEq && !bRev) */
1724 OP_SeekLT, /* 5: (start_constraints && !startEq && bRev) */
1725 OP_SeekGE, /* 6: (start_constraints && startEq && !bRev) */
1726 OP_SeekLE /* 7: (start_constraints && startEq && bRev) */
1727 };
1728 static const u8 aEndOp[] = {
1729 OP_IdxGE, /* 0: (end_constraints && !bRev && !endEq) */
1730 OP_IdxGT, /* 1: (end_constraints && !bRev && endEq) */
1731 OP_IdxLE, /* 2: (end_constraints && bRev && !endEq) */
1732 OP_IdxLT, /* 3: (end_constraints && bRev && endEq) */
1733 };
1734 u16 nEq = pLoop->u.btree.nEq; /* Number of == or IN terms */
dan71c57db2016-07-09 20:23:55 +00001735 u16 nBtm = pLoop->u.btree.nBtm; /* Length of BTM vector */
1736 u16 nTop = pLoop->u.btree.nTop; /* Length of TOP vector */
drh6f82e852015-06-06 20:12:09 +00001737 int regBase; /* Base register holding constraint values */
1738 WhereTerm *pRangeStart = 0; /* Inequality constraint at range start */
1739 WhereTerm *pRangeEnd = 0; /* Inequality constraint at range end */
1740 int startEq; /* True if range start uses ==, >= or <= */
1741 int endEq; /* True if range end uses ==, >= or <= */
1742 int start_constraints; /* Start of range is constrained */
1743 int nConstraint; /* Number of constraint terms */
drh6f82e852015-06-06 20:12:09 +00001744 int iIdxCur; /* The VDBE cursor for the index */
1745 int nExtraReg = 0; /* Number of extra registers needed */
1746 int op; /* Instruction opcode */
1747 char *zStartAff; /* Affinity for start of range constraint */
danb7ca2172016-08-26 17:54:46 +00001748 char *zEndAff = 0; /* Affinity for end of range constraint */
drh6f82e852015-06-06 20:12:09 +00001749 u8 bSeekPastNull = 0; /* True to seek past initial nulls */
1750 u8 bStopAtNull = 0; /* Add condition to terminate at NULLs */
drh47df8a22018-12-25 00:15:37 +00001751 int omitTable; /* True if we use the index only */
drh74e1b862019-08-23 13:08:49 +00001752 int regBignull = 0; /* big-null flag register */
drh04e70ce2020-10-02 11:55:07 +00001753 int addrSeekScan = 0; /* Opcode of the OP_SeekScan, if any */
drh6f82e852015-06-06 20:12:09 +00001754
1755 pIdx = pLoop->u.btree.pIndex;
1756 iIdxCur = pLevel->iIdxCur;
1757 assert( nEq>=pLoop->nSkip );
1758
drh6f82e852015-06-06 20:12:09 +00001759 /* Find any inequality constraint terms for the start and end
1760 ** of the range.
1761 */
1762 j = nEq;
1763 if( pLoop->wsFlags & WHERE_BTM_LIMIT ){
1764 pRangeStart = pLoop->aLTerm[j++];
dan71c57db2016-07-09 20:23:55 +00001765 nExtraReg = MAX(nExtraReg, pLoop->u.btree.nBtm);
drh6f82e852015-06-06 20:12:09 +00001766 /* Like optimization range constraints always occur in pairs */
1767 assert( (pRangeStart->wtFlags & TERM_LIKEOPT)==0 ||
1768 (pLoop->wsFlags & WHERE_TOP_LIMIT)!=0 );
1769 }
1770 if( pLoop->wsFlags & WHERE_TOP_LIMIT ){
1771 pRangeEnd = pLoop->aLTerm[j++];
dan71c57db2016-07-09 20:23:55 +00001772 nExtraReg = MAX(nExtraReg, pLoop->u.btree.nTop);
drh41d2e662015-12-01 21:23:07 +00001773#ifndef SQLITE_LIKE_DOESNT_MATCH_BLOBS
drh6f82e852015-06-06 20:12:09 +00001774 if( (pRangeEnd->wtFlags & TERM_LIKEOPT)!=0 ){
1775 assert( pRangeStart!=0 ); /* LIKE opt constraints */
1776 assert( pRangeStart->wtFlags & TERM_LIKEOPT ); /* occur in pairs */
drh44aebff2016-05-02 10:25:42 +00001777 pLevel->iLikeRepCntr = (u32)++pParse->nMem;
1778 sqlite3VdbeAddOp2(v, OP_Integer, 1, (int)pLevel->iLikeRepCntr);
drh6f82e852015-06-06 20:12:09 +00001779 VdbeComment((v, "LIKE loop counter"));
1780 pLevel->addrLikeRep = sqlite3VdbeCurrentAddr(v);
drh44aebff2016-05-02 10:25:42 +00001781 /* iLikeRepCntr actually stores 2x the counter register number. The
1782 ** bottom bit indicates whether the search order is ASC or DESC. */
1783 testcase( bRev );
1784 testcase( pIdx->aSortOrder[nEq]==SQLITE_SO_DESC );
1785 assert( (bRev & ~1)==0 );
1786 pLevel->iLikeRepCntr <<=1;
1787 pLevel->iLikeRepCntr |= bRev ^ (pIdx->aSortOrder[nEq]==SQLITE_SO_DESC);
drh6f82e852015-06-06 20:12:09 +00001788 }
drh41d2e662015-12-01 21:23:07 +00001789#endif
drh48590fc2016-10-10 13:29:15 +00001790 if( pRangeStart==0 ){
1791 j = pIdx->aiColumn[nEq];
1792 if( (j>=0 && pIdx->pTable->aCol[j].notNull==0) || j==XN_EXPR ){
1793 bSeekPastNull = 1;
1794 }
drh6f82e852015-06-06 20:12:09 +00001795 }
1796 }
1797 assert( pRangeEnd==0 || (pRangeEnd->wtFlags & TERM_VNULL)==0 );
1798
dan15750a22019-08-16 21:07:19 +00001799 /* If the WHERE_BIGNULL_SORT flag is set, then index column nEq uses
1800 ** a non-default "big-null" sort (either ASC NULLS LAST or DESC NULLS
1801 ** FIRST). In both cases separate ordered scans are made of those
1802 ** index entries for which the column is null and for those for which
1803 ** it is not. For an ASC sort, the non-NULL entries are scanned first.
1804 ** For DESC, NULL entries are scanned first.
1805 */
dan15750a22019-08-16 21:07:19 +00001806 if( (pLoop->wsFlags & (WHERE_TOP_LIMIT|WHERE_BTM_LIMIT))==0
1807 && (pLoop->wsFlags & WHERE_BIGNULL_SORT)!=0
1808 ){
1809 assert( bSeekPastNull==0 && nExtraReg==0 && nBtm==0 && nTop==0 );
1810 assert( pRangeEnd==0 && pRangeStart==0 );
dan4adb1d02019-12-28 18:08:39 +00001811 testcase( pLoop->nSkip>0 );
dan15750a22019-08-16 21:07:19 +00001812 nExtraReg = 1;
1813 bSeekPastNull = 1;
1814 pLevel->regBignull = regBignull = ++pParse->nMem;
drh7f05d522020-03-02 01:16:33 +00001815 if( pLevel->iLeftJoin ){
1816 sqlite3VdbeAddOp2(v, OP_Integer, 0, regBignull);
1817 }
dancc491f42019-08-17 17:55:54 +00001818 pLevel->addrBignull = sqlite3VdbeMakeLabel(pParse);
dan15750a22019-08-16 21:07:19 +00001819 }
1820
drh6f82e852015-06-06 20:12:09 +00001821 /* If we are doing a reverse order scan on an ascending index, or
1822 ** a forward order scan on a descending index, interchange the
1823 ** start and end terms (pRangeStart and pRangeEnd).
1824 */
drh7ffb16b2021-05-12 22:15:44 +00001825 if( (nEq<pIdx->nColumn && bRev==(pIdx->aSortOrder[nEq]==SQLITE_SO_ASC)) ){
drh6f82e852015-06-06 20:12:09 +00001826 SWAP(WhereTerm *, pRangeEnd, pRangeStart);
1827 SWAP(u8, bSeekPastNull, bStopAtNull);
dan71c57db2016-07-09 20:23:55 +00001828 SWAP(u8, nBtm, nTop);
drh6f82e852015-06-06 20:12:09 +00001829 }
1830
dandf1b52e2021-01-27 17:15:06 +00001831 if( iLevel>0 && (pLoop->wsFlags & WHERE_IN_SEEKSCAN)!=0 ){
1832 /* In case OP_SeekScan is used, ensure that the index cursor does not
1833 ** point to a valid row for the first iteration of this loop. */
1834 sqlite3VdbeAddOp1(v, OP_NullRow, iIdxCur);
1835 }
1836
drhbcf40a72015-08-18 15:58:05 +00001837 /* Generate code to evaluate all constraint terms using == or IN
1838 ** and store the values of those terms in an array of registers
1839 ** starting at regBase.
1840 */
danb324cf72016-06-17 14:33:32 +00001841 codeCursorHint(pTabItem, pWInfo, pLevel, pRangeEnd);
drhbcf40a72015-08-18 15:58:05 +00001842 regBase = codeAllEqualityTerms(pParse,pLevel,bRev,nExtraReg,&zStartAff);
1843 assert( zStartAff==0 || sqlite3Strlen30(zStartAff)>=nEq );
danb7ca2172016-08-26 17:54:46 +00001844 if( zStartAff && nTop ){
1845 zEndAff = sqlite3DbStrDup(db, &zStartAff[nEq]);
1846 }
dancc491f42019-08-17 17:55:54 +00001847 addrNxt = (regBignull ? pLevel->addrBignull : pLevel->addrNxt);
drhbcf40a72015-08-18 15:58:05 +00001848
drh6f82e852015-06-06 20:12:09 +00001849 testcase( pRangeStart && (pRangeStart->eOperator & WO_LE)!=0 );
1850 testcase( pRangeStart && (pRangeStart->eOperator & WO_GE)!=0 );
1851 testcase( pRangeEnd && (pRangeEnd->eOperator & WO_LE)!=0 );
1852 testcase( pRangeEnd && (pRangeEnd->eOperator & WO_GE)!=0 );
1853 startEq = !pRangeStart || pRangeStart->eOperator & (WO_LE|WO_GE);
1854 endEq = !pRangeEnd || pRangeEnd->eOperator & (WO_LE|WO_GE);
1855 start_constraints = pRangeStart || nEq>0;
1856
1857 /* Seek the index cursor to the start of the range. */
1858 nConstraint = nEq;
1859 if( pRangeStart ){
1860 Expr *pRight = pRangeStart->pExpr->pRight;
dan71c57db2016-07-09 20:23:55 +00001861 codeExprOrVector(pParse, pRight, regBase+nEq, nBtm);
drh6f82e852015-06-06 20:12:09 +00001862 whereLikeOptimizationStringFixup(v, pLevel, pRangeStart);
drh395a60d2020-09-30 17:32:22 +00001863 if( (pRangeStart->wtFlags & TERM_VNULL)==0
drh6f82e852015-06-06 20:12:09 +00001864 && sqlite3ExprCanBeNull(pRight)
1865 ){
1866 sqlite3VdbeAddOp2(v, OP_IsNull, regBase+nEq, addrNxt);
1867 VdbeCoverage(v);
1868 }
1869 if( zStartAff ){
drhe3c6b612016-10-05 20:10:32 +00001870 updateRangeAffinityStr(pRight, nBtm, &zStartAff[nEq]);
drh6f82e852015-06-06 20:12:09 +00001871 }
dan71c57db2016-07-09 20:23:55 +00001872 nConstraint += nBtm;
drh6f82e852015-06-06 20:12:09 +00001873 testcase( pRangeStart->wtFlags & TERM_VIRTUAL );
dan625015e2016-07-30 16:39:28 +00001874 if( sqlite3ExprIsVector(pRight)==0 ){
dan71c57db2016-07-09 20:23:55 +00001875 disableTerm(pLevel, pRangeStart);
1876 }else{
1877 startEq = 1;
1878 }
drh426f4ab2016-07-26 04:31:14 +00001879 bSeekPastNull = 0;
drh6f82e852015-06-06 20:12:09 +00001880 }else if( bSeekPastNull ){
drh6f82e852015-06-06 20:12:09 +00001881 startEq = 0;
drh0086e072019-08-23 16:12:20 +00001882 sqlite3VdbeAddOp2(v, OP_Null, 0, regBase+nEq);
drh6f82e852015-06-06 20:12:09 +00001883 start_constraints = 1;
drh0086e072019-08-23 16:12:20 +00001884 nConstraint++;
dan15750a22019-08-16 21:07:19 +00001885 }else if( regBignull ){
1886 sqlite3VdbeAddOp2(v, OP_Null, 0, regBase+nEq);
1887 start_constraints = 1;
1888 nConstraint++;
drh6f82e852015-06-06 20:12:09 +00001889 }
1890 codeApplyAffinity(pParse, regBase, nConstraint - bSeekPastNull, zStartAff);
drh0bf2ad62016-02-22 21:19:54 +00001891 if( pLoop->nSkip>0 && nConstraint==pLoop->nSkip ){
1892 /* The skip-scan logic inside the call to codeAllEqualityConstraints()
1893 ** above has already left the cursor sitting on the correct row,
1894 ** so no further seeking is needed */
1895 }else{
dan15750a22019-08-16 21:07:19 +00001896 if( regBignull ){
drhec3dda52019-08-23 13:32:03 +00001897 sqlite3VdbeAddOp2(v, OP_Integer, 1, regBignull);
drha31d3552019-08-23 17:09:02 +00001898 VdbeComment((v, "NULL-scan pass ctr"));
dan15750a22019-08-16 21:07:19 +00001899 }
drh2db144c2021-12-01 16:31:02 +00001900 if( pLevel->regFilter ){
1901 sqlite3VdbeAddOp4Int(v, OP_Filter, pLevel->regFilter, addrNxt,
drh770dade2021-12-04 14:24:30 +00001902 regBase, nEq);
drh067c60c2021-12-04 18:45:08 +00001903 VdbeCoverage(v);
drh35685d32021-12-05 00:45:55 +00001904 filterPullDown(pParse, pWInfo, iLevel, addrNxt, notReady);
drh2db144c2021-12-01 16:31:02 +00001905 }
dan15750a22019-08-16 21:07:19 +00001906
drha6d2f8e2016-02-22 20:52:26 +00001907 op = aStartOp[(start_constraints<<2) + (startEq<<1) + bRev];
1908 assert( op!=0 );
drh7d14ffe2020-10-02 13:48:57 +00001909 if( (pLoop->wsFlags & WHERE_IN_SEEKSCAN)!=0 && op==OP_SeekGE ){
drh68cf0ac2020-09-28 19:51:54 +00001910 assert( regBignull==0 );
drh4f65b3b2020-09-30 18:03:22 +00001911 /* TUNING: The OP_SeekScan opcode seeks to reduce the number
1912 ** of expensive seek operations by replacing a single seek with
1913 ** 1 or more step operations. The question is, how many steps
1914 ** should we try before giving up and going with a seek. The cost
1915 ** of a seek is proportional to the logarithm of the of the number
1916 ** of entries in the tree, so basing the number of steps to try
1917 ** on the estimated number of rows in the btree seems like a good
1918 ** guess. */
drh04e70ce2020-10-02 11:55:07 +00001919 addrSeekScan = sqlite3VdbeAddOp1(v, OP_SeekScan,
1920 (pIdx->aiRowLogEst[0]+9)/10);
dan73c586b2022-10-07 18:57:15 +00001921 if( pRangeStart ){
1922 sqlite3VdbeChangeP5(v, 1);
1923 sqlite3VdbeChangeP2(v, addrSeekScan, sqlite3VdbeCurrentAddr(v)+1);
1924 addrSeekScan = 0;
1925 }
drh4f65b3b2020-09-30 18:03:22 +00001926 VdbeCoverage(v);
drh68cf0ac2020-09-28 19:51:54 +00001927 }
drha6d2f8e2016-02-22 20:52:26 +00001928 sqlite3VdbeAddOp4Int(v, op, iIdxCur, addrNxt, regBase, nConstraint);
1929 VdbeCoverage(v);
1930 VdbeCoverageIf(v, op==OP_Rewind); testcase( op==OP_Rewind );
1931 VdbeCoverageIf(v, op==OP_Last); testcase( op==OP_Last );
1932 VdbeCoverageIf(v, op==OP_SeekGT); testcase( op==OP_SeekGT );
1933 VdbeCoverageIf(v, op==OP_SeekGE); testcase( op==OP_SeekGE );
1934 VdbeCoverageIf(v, op==OP_SeekLE); testcase( op==OP_SeekLE );
1935 VdbeCoverageIf(v, op==OP_SeekLT); testcase( op==OP_SeekLT );
danddd74212019-08-02 18:43:59 +00001936
drh0086e072019-08-23 16:12:20 +00001937 assert( bSeekPastNull==0 || bStopAtNull==0 );
dan15750a22019-08-16 21:07:19 +00001938 if( regBignull ){
drh0086e072019-08-23 16:12:20 +00001939 assert( bSeekPastNull==1 || bStopAtNull==1 );
drh5f6a4ea2019-08-23 17:00:22 +00001940 assert( bSeekPastNull==!bStopAtNull );
drh0086e072019-08-23 16:12:20 +00001941 assert( bStopAtNull==startEq );
danddd74212019-08-02 18:43:59 +00001942 sqlite3VdbeAddOp2(v, OP_Goto, 0, sqlite3VdbeCurrentAddr(v)+2);
drh0086e072019-08-23 16:12:20 +00001943 op = aStartOp[(nConstraint>1)*4 + 2 + bRev];
1944 sqlite3VdbeAddOp4Int(v, op, iIdxCur, addrNxt, regBase,
1945 nConstraint-startEq);
1946 VdbeCoverage(v);
1947 VdbeCoverageIf(v, op==OP_Rewind); testcase( op==OP_Rewind );
1948 VdbeCoverageIf(v, op==OP_Last); testcase( op==OP_Last );
1949 VdbeCoverageIf(v, op==OP_SeekGE); testcase( op==OP_SeekGE );
1950 VdbeCoverageIf(v, op==OP_SeekLE); testcase( op==OP_SeekLE );
1951 assert( op==OP_Rewind || op==OP_Last || op==OP_SeekGE || op==OP_SeekLE);
danddd74212019-08-02 18:43:59 +00001952 }
drha6d2f8e2016-02-22 20:52:26 +00001953 }
drh0bf2ad62016-02-22 21:19:54 +00001954
drh6f82e852015-06-06 20:12:09 +00001955 /* Load the value for the inequality constraint at the end of the
1956 ** range (if any).
1957 */
1958 nConstraint = nEq;
drh5d742e32021-11-02 20:52:20 +00001959 assert( pLevel->p2==0 );
drh6f82e852015-06-06 20:12:09 +00001960 if( pRangeEnd ){
1961 Expr *pRight = pRangeEnd->pExpr->pRight;
drh5d742e32021-11-02 20:52:20 +00001962 if( addrSeekScan ){
1963 /* For a seek-scan that has a range on the lowest term of the index,
1964 ** we have to make the top of the loop be code that sets the end
1965 ** condition of the range. Otherwise, the OP_SeekScan might jump
1966 ** over that initialization, leaving the range-end value set to the
1967 ** range-start value, resulting in a wrong answer.
1968 ** See ticket 5981a8c041a3c2f3 (2021-11-02).
1969 */
1970 pLevel->p2 = sqlite3VdbeCurrentAddr(v);
1971 }
dan71c57db2016-07-09 20:23:55 +00001972 codeExprOrVector(pParse, pRight, regBase+nEq, nTop);
drh6f82e852015-06-06 20:12:09 +00001973 whereLikeOptimizationStringFixup(v, pLevel, pRangeEnd);
drh395a60d2020-09-30 17:32:22 +00001974 if( (pRangeEnd->wtFlags & TERM_VNULL)==0
drh6f82e852015-06-06 20:12:09 +00001975 && sqlite3ExprCanBeNull(pRight)
1976 ){
1977 sqlite3VdbeAddOp2(v, OP_IsNull, regBase+nEq, addrNxt);
1978 VdbeCoverage(v);
1979 }
drh0c36fca2016-08-26 18:17:08 +00001980 if( zEndAff ){
drhe3c6b612016-10-05 20:10:32 +00001981 updateRangeAffinityStr(pRight, nTop, zEndAff);
drh0c36fca2016-08-26 18:17:08 +00001982 codeApplyAffinity(pParse, regBase+nEq, nTop, zEndAff);
1983 }else{
1984 assert( pParse->db->mallocFailed );
1985 }
dan71c57db2016-07-09 20:23:55 +00001986 nConstraint += nTop;
drh6f82e852015-06-06 20:12:09 +00001987 testcase( pRangeEnd->wtFlags & TERM_VIRTUAL );
dan71c57db2016-07-09 20:23:55 +00001988
dan625015e2016-07-30 16:39:28 +00001989 if( sqlite3ExprIsVector(pRight)==0 ){
dan71c57db2016-07-09 20:23:55 +00001990 disableTerm(pLevel, pRangeEnd);
1991 }else{
1992 endEq = 1;
1993 }
drh6f82e852015-06-06 20:12:09 +00001994 }else if( bStopAtNull ){
dan15750a22019-08-16 21:07:19 +00001995 if( regBignull==0 ){
1996 sqlite3VdbeAddOp2(v, OP_Null, 0, regBase+nEq);
1997 endEq = 0;
1998 }
drh6f82e852015-06-06 20:12:09 +00001999 nConstraint++;
2000 }
drh41ce47c2022-08-22 02:00:26 +00002001 if( zStartAff ) sqlite3DbNNFreeNN(db, zStartAff);
2002 if( zEndAff ) sqlite3DbNNFreeNN(db, zEndAff);
drh6f82e852015-06-06 20:12:09 +00002003
2004 /* Top of the loop body */
drh5d742e32021-11-02 20:52:20 +00002005 if( pLevel->p2==0 ) pLevel->p2 = sqlite3VdbeCurrentAddr(v);
drh6f82e852015-06-06 20:12:09 +00002006
2007 /* Check if the index cursor is past the end of the range. */
2008 if( nConstraint ){
dan15750a22019-08-16 21:07:19 +00002009 if( regBignull ){
drh5f6a4ea2019-08-23 17:00:22 +00002010 /* Except, skip the end-of-range check while doing the NULL-scan */
drhec3dda52019-08-23 13:32:03 +00002011 sqlite3VdbeAddOp2(v, OP_IfNot, regBignull, sqlite3VdbeCurrentAddr(v)+3);
drha31d3552019-08-23 17:09:02 +00002012 VdbeComment((v, "If NULL-scan 2nd pass"));
drh505ae9d2019-08-22 21:13:56 +00002013 VdbeCoverage(v);
dan15750a22019-08-16 21:07:19 +00002014 }
drh6f82e852015-06-06 20:12:09 +00002015 op = aEndOp[bRev*2 + endEq];
2016 sqlite3VdbeAddOp4Int(v, op, iIdxCur, addrNxt, regBase, nConstraint);
2017 testcase( op==OP_IdxGT ); VdbeCoverageIf(v, op==OP_IdxGT );
2018 testcase( op==OP_IdxGE ); VdbeCoverageIf(v, op==OP_IdxGE );
2019 testcase( op==OP_IdxLT ); VdbeCoverageIf(v, op==OP_IdxLT );
2020 testcase( op==OP_IdxLE ); VdbeCoverageIf(v, op==OP_IdxLE );
drh04e70ce2020-10-02 11:55:07 +00002021 if( addrSeekScan ) sqlite3VdbeJumpHere(v, addrSeekScan);
drh6f82e852015-06-06 20:12:09 +00002022 }
dan15750a22019-08-16 21:07:19 +00002023 if( regBignull ){
drh5f6a4ea2019-08-23 17:00:22 +00002024 /* During a NULL-scan, check to see if we have reached the end of
2025 ** the NULLs */
2026 assert( bSeekPastNull==!bStopAtNull );
2027 assert( bSeekPastNull+bStopAtNull==1 );
2028 assert( nConstraint+bSeekPastNull>0 );
drhec3dda52019-08-23 13:32:03 +00002029 sqlite3VdbeAddOp2(v, OP_If, regBignull, sqlite3VdbeCurrentAddr(v)+2);
drha31d3552019-08-23 17:09:02 +00002030 VdbeComment((v, "If NULL-scan 1st pass"));
drh505ae9d2019-08-22 21:13:56 +00002031 VdbeCoverage(v);
drh5f6a4ea2019-08-23 17:00:22 +00002032 op = aEndOp[bRev*2 + bSeekPastNull];
2033 sqlite3VdbeAddOp4Int(v, op, iIdxCur, addrNxt, regBase,
2034 nConstraint+bSeekPastNull);
2035 testcase( op==OP_IdxGT ); VdbeCoverageIf(v, op==OP_IdxGT );
2036 testcase( op==OP_IdxGE ); VdbeCoverageIf(v, op==OP_IdxGE );
2037 testcase( op==OP_IdxLT ); VdbeCoverageIf(v, op==OP_IdxLT );
2038 testcase( op==OP_IdxLE ); VdbeCoverageIf(v, op==OP_IdxLE );
dan15750a22019-08-16 21:07:19 +00002039 }
drh6f82e852015-06-06 20:12:09 +00002040
drhf761d932020-09-29 01:48:46 +00002041 if( (pLoop->wsFlags & WHERE_IN_EARLYOUT)!=0 ){
drhfa17e132020-09-01 01:52:03 +00002042 sqlite3VdbeAddOp3(v, OP_SeekHit, iIdxCur, nEq, nEq);
drh8c2b6d72018-06-05 20:45:20 +00002043 }
2044
drh6f82e852015-06-06 20:12:09 +00002045 /* Seek the table cursor, if required */
drh47df8a22018-12-25 00:15:37 +00002046 omitTable = (pLoop->wsFlags & WHERE_IDX_ONLY)!=0
drhc5837192022-04-11 14:26:37 +00002047 && (pWInfo->wctrlFlags & (WHERE_OR_SUBCLAUSE|WHERE_RIGHT_JOIN))==0;
drh6f82e852015-06-06 20:12:09 +00002048 if( omitTable ){
2049 /* pIdx is a covering index. No need to access the main table. */
2050 }else if( HasRowid(pIdx->pTable) ){
drh68c0c712020-08-14 20:04:26 +00002051 codeDeferredSeek(pWInfo, pIdx, iCur, iIdxCur);
drh6f82e852015-06-06 20:12:09 +00002052 }else if( iCur!=iIdxCur ){
2053 Index *pPk = sqlite3PrimaryKeyIndex(pIdx->pTable);
2054 iRowidReg = sqlite3GetTempRange(pParse, pPk->nKeyCol);
2055 for(j=0; j<pPk->nKeyCol; j++){
drhb9bcf7c2019-10-19 13:29:10 +00002056 k = sqlite3TableColumnToIndex(pIdx, pPk->aiColumn[j]);
drh6f82e852015-06-06 20:12:09 +00002057 sqlite3VdbeAddOp3(v, OP_Column, iIdxCur, k, iRowidReg+j);
2058 }
2059 sqlite3VdbeAddOp4Int(v, OP_NotFound, iCur, addrCont,
2060 iRowidReg, pPk->nKeyCol); VdbeCoverage(v);
2061 }
2062
drhdb535392019-11-03 00:07:41 +00002063 if( pLevel->iLeftJoin==0 ){
drhdb535392019-11-03 00:07:41 +00002064 /* If a partial index is driving the loop, try to eliminate WHERE clause
2065 ** terms from the query that must be true due to the WHERE clause of
2066 ** the partial index.
2067 **
2068 ** 2019-11-02 ticket 623eff57e76d45f6: This optimization does not work
2069 ** for a LEFT JOIN.
2070 */
2071 if( pIdx->pPartIdxWhere ){
2072 whereApplyPartialIndexConstraints(pIdx->pPartIdxWhere, iCur, pWC);
2073 }
2074 }else{
drhdb535392019-11-03 00:07:41 +00002075 testcase( pIdx->pPartIdxWhere );
drh06fc2452019-11-04 12:49:15 +00002076 /* The following assert() is not a requirement, merely an observation:
2077 ** The OR-optimization doesn't work for the right hand table of
2078 ** a LEFT JOIN: */
drhc5837192022-04-11 14:26:37 +00002079 assert( (pWInfo->wctrlFlags & (WHERE_OR_SUBCLAUSE|WHERE_RIGHT_JOIN))==0 );
dan4da04f72018-04-24 14:05:14 +00002080 }
drhdb535392019-11-03 00:07:41 +00002081
dan71c57db2016-07-09 20:23:55 +00002082 /* Record the instruction used to terminate the loop. */
drh6f82e852015-06-06 20:12:09 +00002083 if( pLoop->wsFlags & WHERE_ONEROW ){
2084 pLevel->op = OP_Noop;
2085 }else if( bRev ){
2086 pLevel->op = OP_Prev;
2087 }else{
2088 pLevel->op = OP_Next;
2089 }
2090 pLevel->p1 = iIdxCur;
2091 pLevel->p3 = (pLoop->wsFlags&WHERE_UNQ_WANTED)!=0 ? 1:0;
2092 if( (pLoop->wsFlags & WHERE_CONSTRAINT)==0 ){
2093 pLevel->p5 = SQLITE_STMTSTATUS_FULLSCAN_STEP;
2094 }else{
2095 assert( pLevel->p5==0 );
2096 }
dan6f654a42017-04-28 19:59:55 +00002097 if( omitTable ) pIdx = 0;
drh6f82e852015-06-06 20:12:09 +00002098 }else
2099
2100#ifndef SQLITE_OMIT_OR_OPTIMIZATION
2101 if( pLoop->wsFlags & WHERE_MULTI_OR ){
2102 /* Case 5: Two or more separately indexed terms connected by OR
2103 **
2104 ** Example:
2105 **
2106 ** CREATE TABLE t1(a,b,c,d);
2107 ** CREATE INDEX i1 ON t1(a);
2108 ** CREATE INDEX i2 ON t1(b);
2109 ** CREATE INDEX i3 ON t1(c);
2110 **
2111 ** SELECT * FROM t1 WHERE a=5 OR b=7 OR (c=11 AND d=13)
2112 **
2113 ** In the example, there are three indexed terms connected by OR.
2114 ** The top of the loop looks like this:
2115 **
2116 ** Null 1 # Zero the rowset in reg 1
2117 **
2118 ** Then, for each indexed term, the following. The arguments to
2119 ** RowSetTest are such that the rowid of the current row is inserted
2120 ** into the RowSet. If it is already present, control skips the
2121 ** Gosub opcode and jumps straight to the code generated by WhereEnd().
2122 **
2123 ** sqlite3WhereBegin(<term>)
2124 ** RowSetTest # Insert rowid into rowset
2125 ** Gosub 2 A
2126 ** sqlite3WhereEnd()
2127 **
2128 ** Following the above, code to terminate the loop. Label A, the target
2129 ** of the Gosub above, jumps to the instruction right after the Goto.
2130 **
2131 ** Null 1 # Zero the rowset in reg 1
2132 ** Goto B # The loop is finished.
2133 **
2134 ** A: <loop body> # Return data, whatever.
2135 **
2136 ** Return 2 # Jump back to the Gosub
2137 **
2138 ** B: <after the loop>
2139 **
2140 ** Added 2014-05-26: If the table is a WITHOUT ROWID table, then
2141 ** use an ephemeral index instead of a RowSet to record the primary
2142 ** keys of the rows we have already seen.
2143 **
2144 */
2145 WhereClause *pOrWc; /* The OR-clause broken out into subterms */
2146 SrcList *pOrTab; /* Shortened table list or OR-clause generation */
2147 Index *pCov = 0; /* Potential covering index (or NULL) */
2148 int iCovCur = pParse->nTab++; /* Cursor used for index scans (if any) */
2149
2150 int regReturn = ++pParse->nMem; /* Register used with OP_Gosub */
2151 int regRowset = 0; /* Register for RowSet object */
2152 int regRowid = 0; /* Register holding rowid */
drhec4ccdb2018-12-29 02:26:59 +00002153 int iLoopBody = sqlite3VdbeMakeLabel(pParse);/* Start of loop body */
drh6f82e852015-06-06 20:12:09 +00002154 int iRetInit; /* Address of regReturn init */
2155 int untestedTerms = 0; /* Some terms not completely tested */
2156 int ii; /* Loop counter */
drh6f82e852015-06-06 20:12:09 +00002157 Expr *pAndExpr = 0; /* An ".. AND (...)" expression */
2158 Table *pTab = pTabItem->pTab;
dan145b4ea2016-07-29 18:12:12 +00002159
drh6f82e852015-06-06 20:12:09 +00002160 pTerm = pLoop->aLTerm[0];
2161 assert( pTerm!=0 );
2162 assert( pTerm->eOperator & WO_OR );
2163 assert( (pTerm->wtFlags & TERM_ORINFO)!=0 );
2164 pOrWc = &pTerm->u.pOrInfo->wc;
2165 pLevel->op = OP_Return;
2166 pLevel->p1 = regReturn;
2167
2168 /* Set up a new SrcList in pOrTab containing the table being scanned
2169 ** by this loop in the a[0] slot and all notReady tables in a[1..] slots.
2170 ** This becomes the SrcList in the recursive call to sqlite3WhereBegin().
2171 */
2172 if( pWInfo->nLevel>1 ){
2173 int nNotReady; /* The number of notReady tables */
drh76012942021-02-21 21:04:54 +00002174 SrcItem *origSrc; /* Original list of tables */
drh6f82e852015-06-06 20:12:09 +00002175 nNotReady = pWInfo->nLevel - iLevel - 1;
drh135c9ff2022-10-17 09:56:51 +00002176 pOrTab = sqlite3DbMallocRawNN(db,
drh6f82e852015-06-06 20:12:09 +00002177 sizeof(*pOrTab)+ nNotReady*sizeof(pOrTab->a[0]));
2178 if( pOrTab==0 ) return notReady;
2179 pOrTab->nAlloc = (u8)(nNotReady + 1);
2180 pOrTab->nSrc = pOrTab->nAlloc;
2181 memcpy(pOrTab->a, pTabItem, sizeof(*pTabItem));
2182 origSrc = pWInfo->pTabList->a;
2183 for(k=1; k<=nNotReady; k++){
2184 memcpy(&pOrTab->a[k], &origSrc[pLevel[k].iFrom], sizeof(pOrTab->a[k]));
2185 }
2186 }else{
2187 pOrTab = pWInfo->pTabList;
2188 }
2189
2190 /* Initialize the rowset register to contain NULL. An SQL NULL is
2191 ** equivalent to an empty rowset. Or, create an ephemeral index
2192 ** capable of holding primary keys in the case of a WITHOUT ROWID.
2193 **
2194 ** Also initialize regReturn to contain the address of the instruction
2195 ** immediately following the OP_Return at the bottom of the loop. This
2196 ** is required in a few obscure LEFT JOIN cases where control jumps
2197 ** over the top of the loop into the body of it. In this case the
2198 ** correct response for the end-of-loop code (the OP_Return) is to
2199 ** fall through to the next instruction, just as an OP_Next does if
2200 ** called on an uninitialized cursor.
2201 */
2202 if( (pWInfo->wctrlFlags & WHERE_DUPLICATES_OK)==0 ){
2203 if( HasRowid(pTab) ){
2204 regRowset = ++pParse->nMem;
2205 sqlite3VdbeAddOp2(v, OP_Null, 0, regRowset);
2206 }else{
2207 Index *pPk = sqlite3PrimaryKeyIndex(pTab);
2208 regRowset = pParse->nTab++;
2209 sqlite3VdbeAddOp2(v, OP_OpenEphemeral, regRowset, pPk->nKeyCol);
2210 sqlite3VdbeSetP4KeyInfo(pParse, pPk);
2211 }
2212 regRowid = ++pParse->nMem;
2213 }
2214 iRetInit = sqlite3VdbeAddOp2(v, OP_Integer, 0, regReturn);
2215
2216 /* If the original WHERE clause is z of the form: (x1 OR x2 OR ...) AND y
drh02e3e042022-02-04 13:05:29 +00002217 ** Then for every term xN, evaluate as the subexpression: xN AND y
drh6f82e852015-06-06 20:12:09 +00002218 ** That way, terms in y that are factored into the disjunction will
2219 ** be picked up by the recursive calls to sqlite3WhereBegin() below.
2220 **
2221 ** Actually, each subexpression is converted to "xN AND w" where w is
2222 ** the "interesting" terms of z - terms that did not originate in the
2223 ** ON or USING clause of a LEFT JOIN, and terms that are usable as
2224 ** indices.
2225 **
2226 ** This optimization also only applies if the (x1 OR x2 OR ...) term
2227 ** is not contained in the ON clause of a LEFT JOIN.
2228 ** See ticket http://www.sqlite.org/src/info/f2369304e4
drh02e3e042022-02-04 13:05:29 +00002229 **
2230 ** 2022-02-04: Do not push down slices of a row-value comparison.
2231 ** In other words, "w" or "y" may not be a slice of a vector. Otherwise,
2232 ** the initialization of the right-hand operand of the vector comparison
2233 ** might not occur, or might occur only in an OR branch that is not
2234 ** taken. dbsqlfuzz 80a9fade844b4fb43564efc972bcb2c68270f5d1.
drhc9bcc5a2022-03-03 15:59:22 +00002235 **
2236 ** 2022-03-03: Do not push down expressions that involve subqueries.
2237 ** The subquery might get coded as a subroutine. Any table-references
2238 ** in the subquery might be resolved to index-references for the index on
2239 ** the OR branch in which the subroutine is coded. But if the subroutine
2240 ** is invoked from a different OR branch that uses a different index, such
2241 ** index-references will not work. tag-20220303a
2242 ** https://sqlite.org/forum/forumpost/36937b197273d403
drh6f82e852015-06-06 20:12:09 +00002243 */
2244 if( pWC->nTerm>1 ){
2245 int iTerm;
2246 for(iTerm=0; iTerm<pWC->nTerm; iTerm++){
2247 Expr *pExpr = pWC->a[iTerm].pExpr;
2248 if( &pWC->a[iTerm] == pTerm ) continue;
drh3b83f0c2016-01-29 16:57:06 +00002249 testcase( pWC->a[iTerm].wtFlags & TERM_VIRTUAL );
2250 testcase( pWC->a[iTerm].wtFlags & TERM_CODED );
drh02e3e042022-02-04 13:05:29 +00002251 testcase( pWC->a[iTerm].wtFlags & TERM_SLICE );
2252 if( (pWC->a[iTerm].wtFlags & (TERM_VIRTUAL|TERM_CODED|TERM_SLICE))!=0 ){
2253 continue;
2254 }
drh07559b22022-03-03 19:40:21 +00002255 if( (pWC->a[iTerm].eOperator & WO_ALL)==0 ) continue;
drhc9bcc5a2022-03-03 15:59:22 +00002256 if( ExprHasProperty(pExpr, EP_Subquery) ) continue; /* tag-20220303a */
drh6f82e852015-06-06 20:12:09 +00002257 pExpr = sqlite3ExprDup(db, pExpr, 0);
drhd5c851c2019-04-19 13:38:34 +00002258 pAndExpr = sqlite3ExprAnd(pParse, pAndExpr, pExpr);
drh6f82e852015-06-06 20:12:09 +00002259 }
2260 if( pAndExpr ){
drhf1722ba2019-04-05 20:56:46 +00002261 /* The extra 0x10000 bit on the opcode is masked off and does not
2262 ** become part of the new Expr.op. However, it does make the
2263 ** op==TK_AND comparison inside of sqlite3PExpr() false, and this
drh93ffb502021-05-18 19:10:10 +00002264 ** prevents sqlite3PExpr() from applying the AND short-circuit
drhf1722ba2019-04-05 20:56:46 +00002265 ** optimization, which we do not want here. */
2266 pAndExpr = sqlite3PExpr(pParse, TK_AND|0x10000, 0, pAndExpr);
drh6f82e852015-06-06 20:12:09 +00002267 }
2268 }
2269
2270 /* Run a separate WHERE clause for each term of the OR clause. After
2271 ** eliminating duplicates from other WHERE clauses, the action for each
2272 ** sub-WHERE clause is to to invoke the main loop body as a subroutine.
2273 */
drh5d72d922018-05-04 00:39:43 +00002274 ExplainQueryPlan((pParse, 1, "MULTI-INDEX OR"));
drh6f82e852015-06-06 20:12:09 +00002275 for(ii=0; ii<pOrWc->nTerm; ii++){
2276 WhereTerm *pOrTerm = &pOrWc->a[ii];
2277 if( pOrTerm->leftCursor==iCur || (pOrTerm->eOperator & WO_AND)!=0 ){
2278 WhereInfo *pSubWInfo; /* Info for single OR-term scan */
2279 Expr *pOrExpr = pOrTerm->pExpr; /* Current OR clause term */
drh93ffb502021-05-18 19:10:10 +00002280 Expr *pDelete; /* Local copy of OR clause term */
drh728e0f92015-10-10 14:41:28 +00002281 int jmp1 = 0; /* Address of jump operation */
drh3b8eb082020-01-12 22:38:17 +00002282 testcase( (pTabItem[0].fg.jointype & JT_LEFT)!=0
drh67a99db2022-05-13 14:52:04 +00002283 && !ExprHasProperty(pOrExpr, EP_OuterON)
drh3b8eb082020-01-12 22:38:17 +00002284 ); /* See TH3 vtab25.400 and ticket 614b25314c766238 */
drh93ffb502021-05-18 19:10:10 +00002285 pDelete = pOrExpr = sqlite3ExprDup(db, pOrExpr, 0);
2286 if( db->mallocFailed ){
2287 sqlite3ExprDelete(db, pDelete);
2288 continue;
2289 }
dan820fcd22018-04-24 18:53:24 +00002290 if( pAndExpr ){
drh6f82e852015-06-06 20:12:09 +00002291 pAndExpr->pLeft = pOrExpr;
2292 pOrExpr = pAndExpr;
2293 }
2294 /* Loop through table entries that match term pOrTerm. */
drhbd462bc2018-12-24 20:21:06 +00002295 ExplainQueryPlan((pParse, 1, "INDEX %d", ii+1));
drh2a757652022-11-30 19:11:31 +00002296 WHERETRACE(0xffffffff, ("Subplan for OR-clause:\n"));
drh895bab32022-01-27 16:14:50 +00002297 pSubWInfo = sqlite3WhereBegin(pParse, pOrTab, pOrExpr, 0, 0, 0,
drh68c0c712020-08-14 20:04:26 +00002298 WHERE_OR_SUBCLAUSE, iCovCur);
drh0c7d3d32022-01-24 16:47:12 +00002299 assert( pSubWInfo || pParse->nErr );
drh6f82e852015-06-06 20:12:09 +00002300 if( pSubWInfo ){
2301 WhereLoop *pSubLoop;
2302 int addrExplain = sqlite3WhereExplainOneScan(
drhe2188f02018-05-07 11:37:34 +00002303 pParse, pOrTab, &pSubWInfo->a[0], 0
drh6f82e852015-06-06 20:12:09 +00002304 );
2305 sqlite3WhereAddScanStatus(v, pOrTab, &pSubWInfo->a[0], addrExplain);
2306
2307 /* This is the sub-WHERE clause body. First skip over
2308 ** duplicate rows from prior sub-WHERE clauses, and record the
2309 ** rowid (or PRIMARY KEY) for the current row so that the same
2310 ** row will be skipped in subsequent sub-WHERE clauses.
2311 */
2312 if( (pWInfo->wctrlFlags & WHERE_DUPLICATES_OK)==0 ){
drh6f82e852015-06-06 20:12:09 +00002313 int iSet = ((ii==pOrWc->nTerm-1)?-1:ii);
2314 if( HasRowid(pTab) ){
drh6df9c4b2019-10-18 12:52:08 +00002315 sqlite3ExprCodeGetColumnOfTable(v, pTab, iCur, -1, regRowid);
drh728e0f92015-10-10 14:41:28 +00002316 jmp1 = sqlite3VdbeAddOp4Int(v, OP_RowSetTest, regRowset, 0,
drh8c607192018-08-04 15:53:55 +00002317 regRowid, iSet);
drh6f82e852015-06-06 20:12:09 +00002318 VdbeCoverage(v);
2319 }else{
2320 Index *pPk = sqlite3PrimaryKeyIndex(pTab);
2321 int nPk = pPk->nKeyCol;
2322 int iPk;
drh8c607192018-08-04 15:53:55 +00002323 int r;
drh6f82e852015-06-06 20:12:09 +00002324
2325 /* Read the PK into an array of temp registers. */
2326 r = sqlite3GetTempRange(pParse, nPk);
2327 for(iPk=0; iPk<nPk; iPk++){
2328 int iCol = pPk->aiColumn[iPk];
drh6df9c4b2019-10-18 12:52:08 +00002329 sqlite3ExprCodeGetColumnOfTable(v, pTab, iCur, iCol,r+iPk);
drh6f82e852015-06-06 20:12:09 +00002330 }
2331
2332 /* Check if the temp table already contains this key. If so,
2333 ** the row has already been included in the result set and
2334 ** can be ignored (by jumping past the Gosub below). Otherwise,
2335 ** insert the key into the temp table and proceed with processing
2336 ** the row.
2337 **
2338 ** Use some of the same optimizations as OP_RowSetTest: If iSet
2339 ** is zero, assume that the key cannot already be present in
2340 ** the temp table. And if iSet is -1, assume that there is no
2341 ** need to insert the key into the temp table, as it will never
2342 ** be tested for. */
2343 if( iSet ){
drh728e0f92015-10-10 14:41:28 +00002344 jmp1 = sqlite3VdbeAddOp4Int(v, OP_Found, regRowset, 0, r, nPk);
drh6f82e852015-06-06 20:12:09 +00002345 VdbeCoverage(v);
2346 }
2347 if( iSet>=0 ){
2348 sqlite3VdbeAddOp3(v, OP_MakeRecord, r, nPk, regRowid);
drh9b4eaeb2016-11-09 00:10:33 +00002349 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, regRowset, regRowid,
2350 r, nPk);
drh6f82e852015-06-06 20:12:09 +00002351 if( iSet ) sqlite3VdbeChangeP5(v, OPFLAG_USESEEKRESULT);
2352 }
2353
2354 /* Release the array of temp registers */
2355 sqlite3ReleaseTempRange(pParse, r, nPk);
2356 }
2357 }
2358
2359 /* Invoke the main loop body as a subroutine */
2360 sqlite3VdbeAddOp2(v, OP_Gosub, regReturn, iLoopBody);
2361
2362 /* Jump here (skipping the main loop body subroutine) if the
2363 ** current sub-WHERE row is a duplicate from prior sub-WHEREs. */
drh728e0f92015-10-10 14:41:28 +00002364 if( jmp1 ) sqlite3VdbeJumpHere(v, jmp1);
drh6f82e852015-06-06 20:12:09 +00002365
2366 /* The pSubWInfo->untestedTerms flag means that this OR term
2367 ** contained one or more AND term from a notReady table. The
2368 ** terms from the notReady table could not be tested and will
2369 ** need to be tested later.
2370 */
2371 if( pSubWInfo->untestedTerms ) untestedTerms = 1;
2372
2373 /* If all of the OR-connected terms are optimized using the same
2374 ** index, and the index is opened using the same cursor number
2375 ** by each call to sqlite3WhereBegin() made by this loop, it may
2376 ** be possible to use that index as a covering index.
2377 **
2378 ** If the call to sqlite3WhereBegin() above resulted in a scan that
2379 ** uses an index, and this is either the first OR-connected term
2380 ** processed or the index is the same as that used by all previous
2381 ** terms, set pCov to the candidate covering index. Otherwise, set
2382 ** pCov to NULL to indicate that no candidate covering index will
2383 ** be available.
2384 */
2385 pSubLoop = pSubWInfo->a[0].pWLoop;
2386 assert( (pSubLoop->wsFlags & WHERE_AUTO_INDEX)==0 );
2387 if( (pSubLoop->wsFlags & WHERE_INDEXED)!=0
2388 && (ii==0 || pSubLoop->u.btree.pIndex==pCov)
2389 && (HasRowid(pTab) || !IsPrimaryKeyIndex(pSubLoop->u.btree.pIndex))
2390 ){
2391 assert( pSubWInfo->a[0].iIdxCur==iCovCur );
2392 pCov = pSubLoop->u.btree.pIndex;
drh6f82e852015-06-06 20:12:09 +00002393 }else{
2394 pCov = 0;
2395 }
drh68c0c712020-08-14 20:04:26 +00002396 if( sqlite3WhereUsesDeferredSeek(pSubWInfo) ){
2397 pWInfo->bDeferredSeek = 1;
2398 }
drh6f82e852015-06-06 20:12:09 +00002399
2400 /* Finish the loop through table entries that match term pOrTerm. */
2401 sqlite3WhereEnd(pSubWInfo);
drhbd462bc2018-12-24 20:21:06 +00002402 ExplainQueryPlanPop(pParse);
drh6f82e852015-06-06 20:12:09 +00002403 }
drh93ffb502021-05-18 19:10:10 +00002404 sqlite3ExprDelete(db, pDelete);
drh6f82e852015-06-06 20:12:09 +00002405 }
2406 }
drh5d72d922018-05-04 00:39:43 +00002407 ExplainQueryPlanPop(pParse);
drh04756292021-10-14 19:28:28 +00002408 assert( pLevel->pWLoop==pLoop );
2409 assert( (pLoop->wsFlags & WHERE_MULTI_OR)!=0 );
2410 assert( (pLoop->wsFlags & WHERE_IN_ABLE)==0 );
2411 pLevel->u.pCoveringIdx = pCov;
drh6f82e852015-06-06 20:12:09 +00002412 if( pCov ) pLevel->iIdxCur = iCovCur;
2413 if( pAndExpr ){
2414 pAndExpr->pLeft = 0;
2415 sqlite3ExprDelete(db, pAndExpr);
2416 }
2417 sqlite3VdbeChangeP1(v, iRetInit, sqlite3VdbeCurrentAddr(v));
drh076e85f2015-09-03 13:46:12 +00002418 sqlite3VdbeGoto(v, pLevel->addrBrk);
drh6f82e852015-06-06 20:12:09 +00002419 sqlite3VdbeResolveLabel(v, iLoopBody);
2420
drhe603ab02022-04-07 19:06:31 +00002421 /* Set the P2 operand of the OP_Return opcode that will end the current
2422 ** loop to point to this spot, which is the top of the next containing
2423 ** loop. The byte-code formatter will use that P2 value as a hint to
2424 ** indent everything in between the this point and the final OP_Return.
2425 ** See tag-20220407a in vdbe.c and shell.c */
2426 assert( pLevel->op==OP_Return );
2427 pLevel->p2 = sqlite3VdbeCurrentAddr(v);
2428
drh135c9ff2022-10-17 09:56:51 +00002429 if( pWInfo->nLevel>1 ){ sqlite3DbFreeNN(db, pOrTab); }
drh6f82e852015-06-06 20:12:09 +00002430 if( !untestedTerms ) disableTerm(pLevel, pTerm);
2431 }else
2432#endif /* SQLITE_OMIT_OR_OPTIMIZATION */
2433
2434 {
2435 /* Case 6: There is no usable index. We must do a complete
2436 ** scan of the entire table.
2437 */
2438 static const u8 aStep[] = { OP_Next, OP_Prev };
2439 static const u8 aStart[] = { OP_Rewind, OP_Last };
2440 assert( bRev==0 || bRev==1 );
drh8a48b9c2015-08-19 15:20:00 +00002441 if( pTabItem->fg.isRecursive ){
drh6f82e852015-06-06 20:12:09 +00002442 /* Tables marked isRecursive have only a single row that is stored in
2443 ** a pseudo-cursor. No need to Rewind or Next such cursors. */
2444 pLevel->op = OP_Noop;
2445 }else{
danb324cf72016-06-17 14:33:32 +00002446 codeCursorHint(pTabItem, pWInfo, pLevel, 0);
drh6f82e852015-06-06 20:12:09 +00002447 pLevel->op = aStep[bRev];
2448 pLevel->p1 = iCur;
drh3a3b4202017-02-15 22:36:15 +00002449 pLevel->p2 = 1 + sqlite3VdbeAddOp2(v, aStart[bRev], iCur, addrHalt);
drh6f82e852015-06-06 20:12:09 +00002450 VdbeCoverageIf(v, bRev==0);
2451 VdbeCoverageIf(v, bRev!=0);
2452 pLevel->p5 = SQLITE_STMTSTATUS_FULLSCAN_STEP;
2453 }
2454 }
2455
2456#ifdef SQLITE_ENABLE_STMT_SCANSTATUS
2457 pLevel->addrVisit = sqlite3VdbeCurrentAddr(v);
2458#endif
2459
2460 /* Insert code to test every subexpression that can be completely
2461 ** computed using the current set of tables.
dan6f654a42017-04-28 19:59:55 +00002462 **
danebc63012017-07-10 14:33:00 +00002463 ** This loop may run between one and three times, depending on the
2464 ** constraints to be generated. The value of stack variable iLoop
2465 ** determines the constraints coded by each iteration, as follows:
2466 **
2467 ** iLoop==1: Code only expressions that are entirely covered by pIdx.
2468 ** iLoop==2: Code remaining expressions that do not contain correlated
2469 ** sub-queries.
2470 ** iLoop==3: Code all remaining expressions.
2471 **
2472 ** An effort is made to skip unnecessary iterations of the loop.
drh6ab3eb52017-04-29 14:56:55 +00002473 */
danebc63012017-07-10 14:33:00 +00002474 iLoop = (pIdx ? 1 : 2);
drh6ab3eb52017-04-29 14:56:55 +00002475 do{
danebc63012017-07-10 14:33:00 +00002476 int iNext = 0; /* Next value for iLoop */
dan6f654a42017-04-28 19:59:55 +00002477 for(pTerm=pWC->a, j=pWC->nTerm; j>0; j--, pTerm++){
2478 Expr *pE;
2479 int skipLikeAddr = 0;
2480 testcase( pTerm->wtFlags & TERM_VIRTUAL );
2481 testcase( pTerm->wtFlags & TERM_CODED );
2482 if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
2483 if( (pTerm->prereqAll & pLevel->notReady)!=0 ){
2484 testcase( pWInfo->untestedTerms==0
2485 && (pWInfo->wctrlFlags & WHERE_OR_SUBCLAUSE)!=0 );
2486 pWInfo->untestedTerms = 1;
2487 continue;
2488 }
2489 pE = pTerm->pExpr;
2490 assert( pE!=0 );
drhc93bf1d2022-05-14 15:59:42 +00002491 if( pTabItem->fg.jointype & (JT_LEFT|JT_LTORJ|JT_RIGHT) ){
2492 if( !ExprHasProperty(pE,EP_OuterON|EP_InnerON) ){
2493 /* Defer processing WHERE clause constraints until after outer
2494 ** join processing. tag-20220513a */
2495 continue;
drh404bf6b2022-05-30 17:33:22 +00002496 }else if( (pTabItem->fg.jointype & JT_LEFT)==JT_LEFT
2497 && !ExprHasProperty(pE,EP_OuterON) ){
2498 continue;
drhc9dfe2b2022-05-31 11:13:55 +00002499 }else{
2500 Bitmask m = sqlite3WhereGetMask(&pWInfo->sMaskSet, pE->w.iJoin);
2501 if( m & pLevel->notReady ){
2502 /* An ON clause that is not ripe */
2503 continue;
2504 }
drhc93bf1d2022-05-14 15:59:42 +00002505 }
dan6f654a42017-04-28 19:59:55 +00002506 }
dan8674ec52017-07-10 14:39:42 +00002507 if( iLoop==1 && !sqlite3ExprCoveredByIndex(pE, pLevel->iTabCur, pIdx) ){
danebc63012017-07-10 14:33:00 +00002508 iNext = 2;
dan6f654a42017-04-28 19:59:55 +00002509 continue;
2510 }
dand3930b12017-07-10 15:17:30 +00002511 if( iLoop<3 && (pTerm->wtFlags & TERM_VARSELECT) ){
danebc63012017-07-10 14:33:00 +00002512 if( iNext==0 ) iNext = 3;
2513 continue;
2514 }
2515
drh4de33532018-04-02 00:16:36 +00002516 if( (pTerm->wtFlags & TERM_LIKECOND)!=0 ){
dan6f654a42017-04-28 19:59:55 +00002517 /* If the TERM_LIKECOND flag is set, that means that the range search
2518 ** is sufficient to guarantee that the LIKE operator is true, so we
2519 ** can skip the call to the like(A,B) function. But this only works
2520 ** for strings. So do not skip the call to the function on the pass
2521 ** that compares BLOBs. */
drh41d2e662015-12-01 21:23:07 +00002522#ifdef SQLITE_LIKE_DOESNT_MATCH_BLOBS
dan6f654a42017-04-28 19:59:55 +00002523 continue;
drh41d2e662015-12-01 21:23:07 +00002524#else
dan6f654a42017-04-28 19:59:55 +00002525 u32 x = pLevel->iLikeRepCntr;
drh4de33532018-04-02 00:16:36 +00002526 if( x>0 ){
2527 skipLikeAddr = sqlite3VdbeAddOp1(v, (x&1)?OP_IfNot:OP_If,(int)(x>>1));
drh6f883592019-03-30 20:37:04 +00002528 VdbeCoverageIf(v, (x&1)==1);
2529 VdbeCoverageIf(v, (x&1)==0);
drh4de33532018-04-02 00:16:36 +00002530 }
drh41d2e662015-12-01 21:23:07 +00002531#endif
dan6f654a42017-04-28 19:59:55 +00002532 }
drh2a757652022-11-30 19:11:31 +00002533#ifdef WHERETRACE_ENABLED /* 0xffffffff */
drh66a0bf32017-07-10 16:38:14 +00002534 if( sqlite3WhereTrace ){
2535 VdbeNoopComment((v, "WhereTerm[%d] (%p) priority=%d",
2536 pWC->nTerm-j, pTerm, iLoop));
2537 }
drh2a757652022-11-30 19:11:31 +00002538 if( sqlite3WhereTrace & 0x4000 ){
drh118efd12019-12-28 14:07:22 +00002539 sqlite3DebugPrintf("Coding auxiliary constraint:\n");
2540 sqlite3WhereTermPrint(pTerm, pWC->nTerm-j);
2541 }
drh66a0bf32017-07-10 16:38:14 +00002542#endif
dan6f654a42017-04-28 19:59:55 +00002543 sqlite3ExprIfFalse(pParse, pE, addrCont, SQLITE_JUMPIFNULL);
2544 if( skipLikeAddr ) sqlite3VdbeJumpHere(v, skipLikeAddr);
2545 pTerm->wtFlags |= TERM_CODED;
drh6f82e852015-06-06 20:12:09 +00002546 }
danebc63012017-07-10 14:33:00 +00002547 iLoop = iNext;
2548 }while( iLoop>0 );
drh6f82e852015-06-06 20:12:09 +00002549
2550 /* Insert code to test for implied constraints based on transitivity
2551 ** of the "==" operator.
2552 **
2553 ** Example: If the WHERE clause contains "t1.a=t2.b" and "t2.b=123"
2554 ** and we are coding the t1 loop and the t2 loop has not yet coded,
2555 ** then we cannot use the "t1.a=t2.b" constraint, but we can code
2556 ** the implied "t1.a=123" constraint.
2557 */
drh132f96f2021-12-08 16:07:22 +00002558 for(pTerm=pWC->a, j=pWC->nBase; j>0; j--, pTerm++){
drhcb43a932016-10-03 01:21:51 +00002559 Expr *pE, sEAlt;
drh6f82e852015-06-06 20:12:09 +00002560 WhereTerm *pAlt;
2561 if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
2562 if( (pTerm->eOperator & (WO_EQ|WO_IS))==0 ) continue;
2563 if( (pTerm->eOperator & WO_EQUIV)==0 ) continue;
2564 if( pTerm->leftCursor!=iCur ) continue;
drh556527a2022-05-13 20:11:32 +00002565 if( pTabItem->fg.jointype & (JT_LEFT|JT_LTORJ|JT_RIGHT) ) continue;
drh6f82e852015-06-06 20:12:09 +00002566 pE = pTerm->pExpr;
drh2a757652022-11-30 19:11:31 +00002567#ifdef WHERETRACE_ENABLED /* 0x4001 */
2568 if( (sqlite3WhereTrace & 0x4001)==0x4001 ){
drh118efd12019-12-28 14:07:22 +00002569 sqlite3DebugPrintf("Coding transitive constraint:\n");
2570 sqlite3WhereTermPrint(pTerm, pWC->nTerm-j);
2571 }
2572#endif
drh67a99db2022-05-13 14:52:04 +00002573 assert( !ExprHasProperty(pE, EP_OuterON) );
drh6f82e852015-06-06 20:12:09 +00002574 assert( (pTerm->prereqRight & pLevel->notReady)!=0 );
drh220f0d62021-10-15 17:06:16 +00002575 assert( (pTerm->eOperator & (WO_OR|WO_AND))==0 );
drh75fa2662020-09-28 15:49:43 +00002576 pAlt = sqlite3WhereFindTerm(pWC, iCur, pTerm->u.x.leftColumn, notReady,
drh6f82e852015-06-06 20:12:09 +00002577 WO_EQ|WO_IN|WO_IS, 0);
2578 if( pAlt==0 ) continue;
2579 if( pAlt->wtFlags & (TERM_CODED) ) continue;
dana916b572018-01-23 16:38:57 +00002580 if( (pAlt->eOperator & WO_IN)
drha4eeccd2021-10-07 17:43:30 +00002581 && ExprUseXSelect(pAlt->pExpr)
drha599e152018-12-24 14:30:11 +00002582 && (pAlt->pExpr->x.pSelect->pEList->nExpr>1)
dana916b572018-01-23 16:38:57 +00002583 ){
2584 continue;
2585 }
drh6f82e852015-06-06 20:12:09 +00002586 testcase( pAlt->eOperator & WO_EQ );
2587 testcase( pAlt->eOperator & WO_IS );
2588 testcase( pAlt->eOperator & WO_IN );
2589 VdbeModuleComment((v, "begin transitive constraint"));
drhcb43a932016-10-03 01:21:51 +00002590 sEAlt = *pAlt->pExpr;
2591 sEAlt.pLeft = pE->pLeft;
2592 sqlite3ExprIfFalse(pParse, &sEAlt, addrCont, SQLITE_JUMPIFNULL);
dan240e36c2021-04-05 16:20:59 +00002593 pAlt->wtFlags |= TERM_CODED;
drh6f82e852015-06-06 20:12:09 +00002594 }
2595
drhc2308ad2022-04-09 03:16:26 +00002596 /* For a RIGHT OUTER JOIN, record the fact that the current row has
2597 ** been matched at least once.
2598 */
drh7c1734b2022-04-09 12:27:20 +00002599 if( pLevel->pRJ ){
drhc2308ad2022-04-09 03:16:26 +00002600 Table *pTab;
2601 int nPk;
2602 int r;
2603 int jmp1 = 0;
drh7c1734b2022-04-09 12:27:20 +00002604 WhereRightJoin *pRJ = pLevel->pRJ;
drhc2308ad2022-04-09 03:16:26 +00002605
drh7c1734b2022-04-09 12:27:20 +00002606 /* pTab is the right-hand table of the RIGHT JOIN. Generate code that
2607 ** will record that the current row of that table has been matched at
2608 ** least once. This is accomplished by storing the PK for the row in
2609 ** both the iMatch index and the regBloom Bloom filter.
2610 */
drhc2308ad2022-04-09 03:16:26 +00002611 pTab = pWInfo->pTabList->a[pLevel->iFrom].pTab;
2612 if( HasRowid(pTab) ){
2613 r = sqlite3GetTempRange(pParse, 2);
2614 sqlite3ExprCodeGetColumnOfTable(v, pTab, pLevel->iTabCur, -1, r+1);
2615 nPk = 1;
2616 }else{
2617 int iPk;
2618 Index *pPk = sqlite3PrimaryKeyIndex(pTab);
2619 nPk = pPk->nKeyCol;
2620 r = sqlite3GetTempRange(pParse, nPk+1);
2621 for(iPk=0; iPk<nPk; iPk++){
2622 int iCol = pPk->aiColumn[iPk];
2623 sqlite3ExprCodeGetColumnOfTable(v, pTab, iCur, iCol,r+1+iPk);
2624 }
2625 }
drh7c1734b2022-04-09 12:27:20 +00002626 jmp1 = sqlite3VdbeAddOp4Int(v, OP_Found, pRJ->iMatch, 0, r+1, nPk);
drhc2308ad2022-04-09 03:16:26 +00002627 VdbeCoverage(v);
drh2e1bcc92022-04-18 16:10:07 +00002628 VdbeComment((v, "match against %s", pTab->zName));
drhc2308ad2022-04-09 03:16:26 +00002629 sqlite3VdbeAddOp3(v, OP_MakeRecord, r+1, nPk, r);
drh7c1734b2022-04-09 12:27:20 +00002630 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, pRJ->iMatch, r, r+1, nPk);
2631 sqlite3VdbeAddOp4Int(v, OP_FilterAdd, pRJ->regBloom, 0, r+1, nPk);
drhc2308ad2022-04-09 03:16:26 +00002632 sqlite3VdbeChangeP5(v, OPFLAG_USESEEKRESULT);
2633 sqlite3VdbeJumpHere(v, jmp1);
drhc2308ad2022-04-09 03:16:26 +00002634 sqlite3ReleaseTempRange(pParse, r, nPk+1);
drh2e1bcc92022-04-18 16:10:07 +00002635 }
drh7c1734b2022-04-09 12:27:20 +00002636
drh2e1bcc92022-04-18 16:10:07 +00002637 /* For a LEFT OUTER JOIN, generate code that will record the fact that
2638 ** at least one row of the right table has matched the left table.
2639 */
2640 if( pLevel->iLeftJoin ){
2641 pLevel->addrFirst = sqlite3VdbeCurrentAddr(v);
2642 sqlite3VdbeAddOp2(v, OP_Integer, 1, pLevel->iLeftJoin);
2643 VdbeComment((v, "record LEFT JOIN hit"));
drh767bc8d2022-05-13 17:45:52 +00002644 if( pLevel->pRJ==0 ){
2645 goto code_outer_join_constraints; /* WHERE clause constraints */
drh2e1bcc92022-04-18 16:10:07 +00002646 }
2647 }
2648
2649 if( pLevel->pRJ ){
drh7c1734b2022-04-09 12:27:20 +00002650 /* Create a subroutine used to process all interior loops and code
2651 ** of the RIGHT JOIN. During normal operation, the subroutine will
2652 ** be in-line with the rest of the code. But at the end, a separate
2653 ** loop will run that invokes this subroutine for unmatched rows
2654 ** of pTab, with all tables to left begin set to NULL.
2655 */
drh2e1bcc92022-04-18 16:10:07 +00002656 WhereRightJoin *pRJ = pLevel->pRJ;
drh7c1734b2022-04-09 12:27:20 +00002657 sqlite3VdbeAddOp2(v, OP_BeginSubrtn, 0, pRJ->regReturn);
2658 pRJ->addrSubrtn = sqlite3VdbeCurrentAddr(v);
drh2c31c002022-04-14 16:34:07 +00002659 assert( pParse->withinRJSubrtn < 255 );
2660 pParse->withinRJSubrtn++;
drh767bc8d2022-05-13 17:45:52 +00002661
2662 /* WHERE clause constraints must be deferred until after outer join
2663 ** row elimination has completed, since WHERE clause constraints apply
2664 ** to the results of the OUTER JOIN. The following loop generates the
2665 ** appropriate WHERE clause constraint checks. tag-20220513a.
2666 */
2667 code_outer_join_constraints:
2668 for(pTerm=pWC->a, j=0; j<pWC->nBase; j++, pTerm++){
2669 testcase( pTerm->wtFlags & TERM_VIRTUAL );
2670 testcase( pTerm->wtFlags & TERM_CODED );
2671 if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
2672 if( (pTerm->prereqAll & pLevel->notReady)!=0 ){
2673 assert( pWInfo->untestedTerms );
2674 continue;
2675 }
2676 if( pTabItem->fg.jointype & JT_LTORJ ) continue;
2677 assert( pTerm->pExpr );
2678 sqlite3ExprIfFalse(pParse, pTerm->pExpr, addrCont, SQLITE_JUMPIFNULL);
2679 pTerm->wtFlags |= TERM_CODED;
2680 }
drhc2308ad2022-04-09 03:16:26 +00002681 }
2682
drh2a757652022-11-30 19:11:31 +00002683#if WHERETRACE_ENABLED /* 0x4001 */
2684 if( sqlite3WhereTrace & 0x4000 ){
drhf1bb31e2019-12-28 14:33:26 +00002685 sqlite3DebugPrintf("All WHERE-clause terms after coding level %d:\n",
2686 iLevel);
drh118efd12019-12-28 14:07:22 +00002687 sqlite3WhereClausePrint(pWC);
2688 }
drh2a757652022-11-30 19:11:31 +00002689 if( sqlite3WhereTrace & 0x1 ){
drh118efd12019-12-28 14:07:22 +00002690 sqlite3DebugPrintf("End Coding level %d: notReady=%llx\n",
2691 iLevel, (u64)pLevel->notReady);
2692 }
2693#endif
drh6f82e852015-06-06 20:12:09 +00002694 return pLevel->notReady;
2695}
drh949e2ab2022-04-12 18:04:29 +00002696
2697/*
2698** Generate the code for the loop that finds all non-matched terms
2699** for a RIGHT JOIN.
2700*/
2701SQLITE_NOINLINE void sqlite3WhereRightJoinLoop(
2702 WhereInfo *pWInfo,
2703 int iLevel,
2704 WhereLevel *pLevel
2705){
2706 Parse *pParse = pWInfo->pParse;
2707 Vdbe *v = pParse->pVdbe;
2708 WhereRightJoin *pRJ = pLevel->pRJ;
2709 Expr *pSubWhere = 0;
2710 WhereClause *pWC = &pWInfo->sWC;
2711 WhereInfo *pSubWInfo;
2712 WhereLoop *pLoop = pLevel->pWLoop;
2713 SrcItem *pTabItem = &pWInfo->pTabList->a[pLevel->iFrom];
2714 SrcList sFrom;
2715 Bitmask mAll = 0;
2716 int k;
2717
drhf7ecd952022-04-13 16:46:35 +00002718 ExplainQueryPlan((pParse, 1, "RIGHT-JOIN %s", pTabItem->pTab->zName));
drhb77c3122022-04-23 18:04:31 +00002719 sqlite3VdbeNoJumpsOutsideSubrtn(v, pRJ->addrSubrtn, pRJ->endSubrtn,
2720 pRJ->regReturn);
drh7348ca42022-04-18 16:20:59 +00002721 for(k=0; k<iLevel; k++){
2722 int iIdxCur;
2723 mAll |= pWInfo->a[k].pWLoop->maskSelf;
2724 sqlite3VdbeAddOp1(v, OP_NullRow, pWInfo->a[k].iTabCur);
2725 iIdxCur = pWInfo->a[k].iIdxCur;
2726 if( iIdxCur ){
2727 sqlite3VdbeAddOp1(v, OP_NullRow, iIdxCur);
drh949e2ab2022-04-12 18:04:29 +00002728 }
drh7348ca42022-04-18 16:20:59 +00002729 }
2730 if( (pTabItem->fg.jointype & JT_LTORJ)==0 ){
drh2e1bcc92022-04-18 16:10:07 +00002731 mAll |= pLoop->maskSelf;
2732 for(k=0; k<pWC->nTerm; k++){
2733 WhereTerm *pTerm = &pWC->a[k];
drh0f4b5342022-06-01 13:32:47 +00002734 if( (pTerm->wtFlags & (TERM_VIRTUAL|TERM_SLICE))!=0
2735 && pTerm->eOperator!=WO_ROWVAL
2736 ){
2737 break;
2738 }
drh2e1bcc92022-04-18 16:10:07 +00002739 if( pTerm->prereqAll & ~mAll ) continue;
drh67a99db2022-05-13 14:52:04 +00002740 if( ExprHasProperty(pTerm->pExpr, EP_OuterON|EP_InnerON) ) continue;
drh2e1bcc92022-04-18 16:10:07 +00002741 pSubWhere = sqlite3ExprAnd(pParse, pSubWhere,
2742 sqlite3ExprDup(pParse->db, pTerm->pExpr, 0));
2743 }
drh949e2ab2022-04-12 18:04:29 +00002744 }
2745 sFrom.nSrc = 1;
2746 sFrom.nAlloc = 1;
2747 memcpy(&sFrom.a[0], pTabItem, sizeof(SrcItem));
2748 sFrom.a[0].fg.jointype = 0;
drh503ad9c2022-04-21 14:48:40 +00002749 assert( pParse->withinRJSubrtn < 100 );
2750 pParse->withinRJSubrtn++;
drh949e2ab2022-04-12 18:04:29 +00002751 pSubWInfo = sqlite3WhereBegin(pParse, &sFrom, pSubWhere, 0, 0, 0,
2752 WHERE_RIGHT_JOIN, 0);
2753 if( pSubWInfo ){
2754 int iCur = pLevel->iTabCur;
2755 int r = ++pParse->nMem;
2756 int nPk;
2757 int jmp;
2758 int addrCont = sqlite3WhereContinueLabel(pSubWInfo);
2759 Table *pTab = pTabItem->pTab;
2760 if( HasRowid(pTab) ){
2761 sqlite3ExprCodeGetColumnOfTable(v, pTab, iCur, -1, r);
2762 nPk = 1;
2763 }else{
2764 int iPk;
2765 Index *pPk = sqlite3PrimaryKeyIndex(pTab);
2766 nPk = pPk->nKeyCol;
2767 pParse->nMem += nPk - 1;
2768 for(iPk=0; iPk<nPk; iPk++){
2769 int iCol = pPk->aiColumn[iPk];
2770 sqlite3ExprCodeGetColumnOfTable(v, pTab, iCur, iCol,r+iPk);
2771 }
2772 }
2773 jmp = sqlite3VdbeAddOp4Int(v, OP_Filter, pRJ->regBloom, 0, r, nPk);
drh146e64d2022-04-13 01:52:32 +00002774 VdbeCoverage(v);
drh949e2ab2022-04-12 18:04:29 +00002775 sqlite3VdbeAddOp4Int(v, OP_Found, pRJ->iMatch, addrCont, r, nPk);
drh146e64d2022-04-13 01:52:32 +00002776 VdbeCoverage(v);
drh949e2ab2022-04-12 18:04:29 +00002777 sqlite3VdbeJumpHere(v, jmp);
2778 sqlite3VdbeAddOp2(v, OP_Gosub, pRJ->regReturn, pRJ->addrSubrtn);
2779 sqlite3WhereEnd(pSubWInfo);
2780 }
2781 sqlite3ExprDelete(pParse->db, pSubWhere);
2782 ExplainQueryPlanPop(pParse);
drh503ad9c2022-04-21 14:48:40 +00002783 assert( pParse->withinRJSubrtn>0 );
2784 pParse->withinRJSubrtn--;
drh949e2ab2022-04-12 18:04:29 +00002785}