blob: 5b8ed8934b332532be6d5f5a747fb16e9a70b89a [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
207#ifdef SQLITE_EXPLAIN_ESTIMATED_ROWS
208 if( pLoop->nOut>=10 ){
drh0cdbe1a2018-05-09 13:46:26 +0000209 sqlite3_str_appendf(&str, " (~%llu rows)",
210 sqlite3LogEstToInt(pLoop->nOut));
drh6f82e852015-06-06 20:12:09 +0000211 }else{
drh0cdbe1a2018-05-09 13:46:26 +0000212 sqlite3_str_append(&str, " (~1 row)", 9);
drh6f82e852015-06-06 20:12:09 +0000213 }
214#endif
215 zMsg = sqlite3StrAccumFinish(&str);
drhbd462bc2018-12-24 20:21:06 +0000216 sqlite3ExplainBreakpoint("",zMsg);
drhe2ca99c2018-05-02 00:33:43 +0000217 ret = sqlite3VdbeAddOp4(v, OP_Explain, sqlite3VdbeCurrentAddr(v),
218 pParse->addrExplain, 0, zMsg,P4_DYNAMIC);
drh6f82e852015-06-06 20:12:09 +0000219 }
220 return ret;
221}
drh6ae49e62021-12-05 20:19:47 +0000222
223/*
224** Add a single OP_Explain opcode that describes a Bloom filter.
225**
226** Or if not processing EXPLAIN QUERY PLAN and not in a SQLITE_DEBUG and/or
227** SQLITE_ENABLE_STMT_SCANSTATUS build, then OP_Explain opcodes are not
228** required and this routine is a no-op.
229**
230** If an OP_Explain opcode is added to the VM, its address is returned.
231** Otherwise, if no OP_Explain is coded, zero is returned.
232*/
233int sqlite3WhereExplainBloomFilter(
234 const Parse *pParse, /* Parse context */
235 const WhereInfo *pWInfo, /* WHERE clause */
236 const WhereLevel *pLevel /* Bloom filter on this level */
237){
238 int ret = 0;
drha11c5e22021-12-09 18:44:03 +0000239 SrcItem *pItem = &pWInfo->pTabList->a[pLevel->iFrom];
240 Vdbe *v = pParse->pVdbe; /* VM being constructed */
241 sqlite3 *db = pParse->db; /* Database handle */
242 char *zMsg; /* Text to add to EQP output */
243 int i; /* Loop counter */
244 WhereLoop *pLoop; /* The where loop */
245 StrAccum str; /* EQP output string */
246 char zBuf[100]; /* Initial space for EQP output string */
drh6ae49e62021-12-05 20:19:47 +0000247
drha11c5e22021-12-09 18:44:03 +0000248 sqlite3StrAccumInit(&str, db, zBuf, sizeof(zBuf), SQLITE_MAX_LENGTH);
249 str.printfFlags = SQLITE_PRINTF_INTERNAL;
250 sqlite3_str_appendf(&str, "BLOOM FILTER ON %S (", pItem);
251 pLoop = pLevel->pWLoop;
252 if( pLoop->wsFlags & WHERE_IPK ){
253 const Table *pTab = pItem->pTab;
254 if( pTab->iPKey>=0 ){
255 sqlite3_str_appendf(&str, "%s=?", pTab->aCol[pTab->iPKey].zCnName);
drh3bd7cd72021-12-06 23:07:59 +0000256 }else{
drha11c5e22021-12-09 18:44:03 +0000257 sqlite3_str_appendf(&str, "rowid=?");
drh6ae49e62021-12-05 20:19:47 +0000258 }
drha11c5e22021-12-09 18:44:03 +0000259 }else{
260 for(i=pLoop->nSkip; i<pLoop->u.btree.nEq; i++){
261 const char *z = explainIndexColumnName(pLoop->u.btree.pIndex, i);
262 if( i>pLoop->nSkip ) sqlite3_str_append(&str, " AND ", 5);
263 sqlite3_str_appendf(&str, "%s=?", z);
264 }
drh6ae49e62021-12-05 20:19:47 +0000265 }
drha11c5e22021-12-09 18:44:03 +0000266 sqlite3_str_append(&str, ")", 1);
267 zMsg = sqlite3StrAccumFinish(&str);
268 ret = sqlite3VdbeAddOp4(v, OP_Explain, sqlite3VdbeCurrentAddr(v),
269 pParse->addrExplain, 0, zMsg,P4_DYNAMIC);
drh6ae49e62021-12-05 20:19:47 +0000270 return ret;
271}
drh6f82e852015-06-06 20:12:09 +0000272#endif /* SQLITE_OMIT_EXPLAIN */
273
274#ifdef SQLITE_ENABLE_STMT_SCANSTATUS
275/*
276** Configure the VM passed as the first argument with an
277** sqlite3_stmt_scanstatus() entry corresponding to the scan used to
278** implement level pLvl. Argument pSrclist is a pointer to the FROM
279** clause that the scan reads data from.
280**
281** If argument addrExplain is not 0, it must be the address of an
282** OP_Explain instruction that describes the same loop.
283*/
284void sqlite3WhereAddScanStatus(
285 Vdbe *v, /* Vdbe to add scanstatus entry to */
286 SrcList *pSrclist, /* FROM clause pLvl reads data from */
287 WhereLevel *pLvl, /* Level to add scanstatus() entry for */
288 int addrExplain /* Address of OP_Explain (or 0) */
289){
290 const char *zObj = 0;
291 WhereLoop *pLoop = pLvl->pWLoop;
292 if( (pLoop->wsFlags & WHERE_VIRTUALTABLE)==0 && pLoop->u.btree.pIndex!=0 ){
293 zObj = pLoop->u.btree.pIndex->zName;
294 }else{
295 zObj = pSrclist->a[pLvl->iFrom].zName;
296 }
297 sqlite3VdbeScanStatus(
298 v, addrExplain, pLvl->addrBody, pLvl->addrVisit, pLoop->nOut, zObj
299 );
300}
301#endif
302
303
304/*
305** Disable a term in the WHERE clause. Except, do not disable the term
306** if it controls a LEFT OUTER JOIN and it did not originate in the ON
307** or USING clause of that join.
308**
309** Consider the term t2.z='ok' in the following queries:
310**
311** (1) SELECT * FROM t1 LEFT JOIN t2 ON t1.a=t2.x WHERE t2.z='ok'
312** (2) SELECT * FROM t1 LEFT JOIN t2 ON t1.a=t2.x AND t2.z='ok'
313** (3) SELECT * FROM t1, t2 WHERE t1.a=t2.x AND t2.z='ok'
314**
315** The t2.z='ok' is disabled in the in (2) because it originates
316** in the ON clause. The term is disabled in (3) because it is not part
317** of a LEFT OUTER JOIN. In (1), the term is not disabled.
318**
319** Disabling a term causes that term to not be tested in the inner loop
320** of the join. Disabling is an optimization. When terms are satisfied
321** by indices, we disable them to prevent redundant tests in the inner
322** loop. We would get the correct results if nothing were ever disabled,
323** but joins might run a little slower. The trick is to disable as much
324** as we can without disabling too much. If we disabled in (1), we'd get
325** the wrong answer. See ticket #813.
326**
327** If all the children of a term are disabled, then that term is also
328** automatically disabled. In this way, terms get disabled if derived
329** virtual terms are tested first. For example:
330**
331** x GLOB 'abc*' AND x>='abc' AND x<'acd'
332** \___________/ \______/ \_____/
333** parent child1 child2
334**
335** Only the parent term was in the original WHERE clause. The child1
336** and child2 terms were added by the LIKE optimization. If both of
337** the virtual child terms are valid, then testing of the parent can be
338** skipped.
339**
340** Usually the parent term is marked as TERM_CODED. But if the parent
341** term was originally TERM_LIKE, then the parent gets TERM_LIKECOND instead.
342** The TERM_LIKECOND marking indicates that the term should be coded inside
343** a conditional such that is only evaluated on the second pass of a
344** LIKE-optimization loop, when scanning BLOBs instead of strings.
345*/
346static void disableTerm(WhereLevel *pLevel, WhereTerm *pTerm){
347 int nLoop = 0;
drh9d9c41e2017-10-31 03:40:15 +0000348 assert( pTerm!=0 );
349 while( (pTerm->wtFlags & TERM_CODED)==0
drh6f82e852015-06-06 20:12:09 +0000350 && (pLevel->iLeftJoin==0 || ExprHasProperty(pTerm->pExpr, EP_FromJoin))
351 && (pLevel->notReady & pTerm->prereqAll)==0
352 ){
353 if( nLoop && (pTerm->wtFlags & TERM_LIKE)!=0 ){
354 pTerm->wtFlags |= TERM_LIKECOND;
355 }else{
356 pTerm->wtFlags |= TERM_CODED;
357 }
drh23634892021-05-04 18:24:56 +0000358#ifdef WHERETRACE_ENABLED
359 if( sqlite3WhereTrace & 0x20000 ){
360 sqlite3DebugPrintf("DISABLE-");
361 sqlite3WhereTermPrint(pTerm, (int)(pTerm - (pTerm->pWC->a)));
362 }
363#endif
drh6f82e852015-06-06 20:12:09 +0000364 if( pTerm->iParent<0 ) break;
365 pTerm = &pTerm->pWC->a[pTerm->iParent];
drh9d9c41e2017-10-31 03:40:15 +0000366 assert( pTerm!=0 );
drh6f82e852015-06-06 20:12:09 +0000367 pTerm->nChild--;
368 if( pTerm->nChild!=0 ) break;
369 nLoop++;
370 }
371}
372
373/*
374** Code an OP_Affinity opcode to apply the column affinity string zAff
375** to the n registers starting at base.
376**
drh96fb16e2019-08-06 14:37:24 +0000377** As an optimization, SQLITE_AFF_BLOB and SQLITE_AFF_NONE entries (which
378** are no-ops) at the beginning and end of zAff are ignored. If all entries
379** in zAff are SQLITE_AFF_BLOB or SQLITE_AFF_NONE, then no code gets generated.
drh6f82e852015-06-06 20:12:09 +0000380**
381** This routine makes its own copy of zAff so that the caller is free
382** to modify zAff after this routine returns.
383*/
384static void codeApplyAffinity(Parse *pParse, int base, int n, char *zAff){
385 Vdbe *v = pParse->pVdbe;
386 if( zAff==0 ){
387 assert( pParse->db->mallocFailed );
388 return;
389 }
390 assert( v!=0 );
391
drh96fb16e2019-08-06 14:37:24 +0000392 /* Adjust base and n to skip over SQLITE_AFF_BLOB and SQLITE_AFF_NONE
393 ** entries at the beginning and end of the affinity string.
drh6f82e852015-06-06 20:12:09 +0000394 */
drh96fb16e2019-08-06 14:37:24 +0000395 assert( SQLITE_AFF_NONE<SQLITE_AFF_BLOB );
396 while( n>0 && zAff[0]<=SQLITE_AFF_BLOB ){
drh6f82e852015-06-06 20:12:09 +0000397 n--;
398 base++;
399 zAff++;
400 }
drh96fb16e2019-08-06 14:37:24 +0000401 while( n>1 && zAff[n-1]<=SQLITE_AFF_BLOB ){
drh6f82e852015-06-06 20:12:09 +0000402 n--;
403 }
404
405 /* Code the OP_Affinity opcode if there is anything left to do. */
406 if( n>0 ){
drh9b34abe2016-01-16 15:12:35 +0000407 sqlite3VdbeAddOp4(v, OP_Affinity, base, n, 0, zAff, n);
drh6f82e852015-06-06 20:12:09 +0000408 }
409}
410
danb7ca2172016-08-26 17:54:46 +0000411/*
412** Expression pRight, which is the RHS of a comparison operation, is
413** either a vector of n elements or, if n==1, a scalar expression.
414** Before the comparison operation, affinity zAff is to be applied
415** to the pRight values. This function modifies characters within the
416** affinity string to SQLITE_AFF_BLOB if either:
417**
418** * the comparison will be performed with no affinity, or
419** * the affinity change in zAff is guaranteed not to change the value.
420*/
421static void updateRangeAffinityStr(
danb7ca2172016-08-26 17:54:46 +0000422 Expr *pRight, /* RHS of comparison */
423 int n, /* Number of vector elements in comparison */
424 char *zAff /* Affinity string to modify */
425){
426 int i;
427 for(i=0; i<n; i++){
428 Expr *p = sqlite3VectorFieldSubexpr(pRight, i);
429 if( sqlite3CompareAffinity(p, zAff[i])==SQLITE_AFF_BLOB
430 || sqlite3ExprNeedsNoAffinityChange(p, zAff[i])
431 ){
432 zAff[i] = SQLITE_AFF_BLOB;
433 }
434 }
435}
drh6f82e852015-06-06 20:12:09 +0000436
drh24102432017-11-17 21:01:04 +0000437
438/*
439** pX is an expression of the form: (vector) IN (SELECT ...)
440** In other words, it is a vector IN operator with a SELECT clause on the
441** LHS. But not all terms in the vector are indexable and the terms might
442** not be in the correct order for indexing.
drh9b1ecb62017-11-17 17:32:40 +0000443**
drh24102432017-11-17 21:01:04 +0000444** This routine makes a copy of the input pX expression and then adjusts
445** the vector on the LHS with corresponding changes to the SELECT so that
446** the vector contains only index terms and those terms are in the correct
447** order. The modified IN expression is returned. The caller is responsible
448** for deleting the returned expression.
449**
450** Example:
451**
452** CREATE TABLE t1(a,b,c,d,e,f);
453** CREATE INDEX t1x1 ON t1(e,c);
454** SELECT * FROM t1 WHERE (a,b,c,d,e) IN (SELECT v,w,x,y,z FROM t2)
455** \_______________________________________/
456** The pX expression
457**
458** Since only columns e and c can be used with the index, in that order,
459** the modified IN expression that is returned will be:
460**
461** (e,c) IN (SELECT z,x FROM t2)
462**
463** The reduced pX is different from the original (obviously) and thus is
464** only used for indexing, to improve performance. The original unaltered
465** IN expression must also be run on each output row for correctness.
drh9b1ecb62017-11-17 17:32:40 +0000466*/
drh24102432017-11-17 21:01:04 +0000467static Expr *removeUnindexableInClauseTerms(
468 Parse *pParse, /* The parsing context */
469 int iEq, /* Look at loop terms starting here */
470 WhereLoop *pLoop, /* The current loop */
471 Expr *pX /* The IN expression to be reduced */
472){
473 sqlite3 *db = pParse->db;
dan69843342019-12-22 17:32:25 +0000474 Expr *pNew;
dan69843342019-12-22 17:32:25 +0000475 pNew = sqlite3ExprDup(db, pX, 0);
drh24102432017-11-17 21:01:04 +0000476 if( db->mallocFailed==0 ){
drha4eeccd2021-10-07 17:43:30 +0000477 ExprList *pOrigRhs; /* Original unmodified RHS */
478 ExprList *pOrigLhs; /* Original unmodified LHS */
drh24102432017-11-17 21:01:04 +0000479 ExprList *pRhs = 0; /* New RHS after modifications */
480 ExprList *pLhs = 0; /* New LHS after mods */
481 int i; /* Loop counter */
482 Select *pSelect; /* Pointer to the SELECT on the RHS */
483
drha4eeccd2021-10-07 17:43:30 +0000484 assert( ExprUseXSelect(pNew) );
485 pOrigRhs = pNew->x.pSelect->pEList;
486 assert( pNew->pLeft!=0 );
487 assert( ExprUseXList(pNew->pLeft) );
488 pOrigLhs = pNew->pLeft->x.pList;
drh24102432017-11-17 21:01:04 +0000489 for(i=iEq; i<pLoop->nLTerm; i++){
490 if( pLoop->aLTerm[i]->pExpr==pX ){
drh220f0d62021-10-15 17:06:16 +0000491 int iField;
492 assert( (pLoop->aLTerm[i]->eOperator & (WO_OR|WO_AND))==0 );
493 iField = pLoop->aLTerm[i]->u.x.iField - 1;
drhc6e519f2018-11-03 13:11:24 +0000494 if( pOrigRhs->a[iField].pExpr==0 ) continue; /* Duplicate PK column */
drh24102432017-11-17 21:01:04 +0000495 pRhs = sqlite3ExprListAppend(pParse, pRhs, pOrigRhs->a[iField].pExpr);
496 pOrigRhs->a[iField].pExpr = 0;
497 assert( pOrigLhs->a[iField].pExpr!=0 );
498 pLhs = sqlite3ExprListAppend(pParse, pLhs, pOrigLhs->a[iField].pExpr);
499 pOrigLhs->a[iField].pExpr = 0;
500 }
drh9b1ecb62017-11-17 17:32:40 +0000501 }
drh24102432017-11-17 21:01:04 +0000502 sqlite3ExprListDelete(db, pOrigRhs);
503 sqlite3ExprListDelete(db, pOrigLhs);
504 pNew->pLeft->x.pList = pLhs;
505 pNew->x.pSelect->pEList = pRhs;
506 if( pLhs && pLhs->nExpr==1 ){
507 /* Take care here not to generate a TK_VECTOR containing only a
508 ** single value. Since the parser never creates such a vector, some
509 ** of the subroutines do not handle this case. */
510 Expr *p = pLhs->a[0].pExpr;
511 pLhs->a[0].pExpr = 0;
512 sqlite3ExprDelete(db, pNew->pLeft);
513 pNew->pLeft = p;
514 }
515 pSelect = pNew->x.pSelect;
516 if( pSelect->pOrderBy ){
517 /* If the SELECT statement has an ORDER BY clause, zero the
518 ** iOrderByCol variables. These are set to non-zero when an
519 ** ORDER BY term exactly matches one of the terms of the
520 ** result-set. Since the result-set of the SELECT statement may
521 ** have been modified or reordered, these variables are no longer
522 ** set correctly. Since setting them is just an optimization,
523 ** it's easiest just to zero them here. */
524 ExprList *pOrderBy = pSelect->pOrderBy;
525 for(i=0; i<pOrderBy->nExpr; i++){
526 pOrderBy->a[i].u.x.iOrderByCol = 0;
527 }
528 }
529
530#if 0
531 printf("For indexing, change the IN expr:\n");
532 sqlite3TreeViewExpr(0, pX, 0);
533 printf("Into:\n");
534 sqlite3TreeViewExpr(0, pNew, 0);
535#endif
drh9b1ecb62017-11-17 17:32:40 +0000536 }
drh24102432017-11-17 21:01:04 +0000537 return pNew;
drh9b1ecb62017-11-17 17:32:40 +0000538}
drh9b1ecb62017-11-17 17:32:40 +0000539
540
drh6f82e852015-06-06 20:12:09 +0000541/*
542** Generate code for a single equality term of the WHERE clause. An equality
543** term can be either X=expr or X IN (...). pTerm is the term to be
544** coded.
545**
drh099a0f52016-09-06 15:25:53 +0000546** The current value for the constraint is left in a register, the index
547** of which is returned. An attempt is made store the result in iTarget but
548** this is only guaranteed for TK_ISNULL and TK_IN constraints. If the
549** constraint is a TK_EQ or TK_IS, then the current value might be left in
550** some other register and it is the caller's responsibility to compensate.
drh6f82e852015-06-06 20:12:09 +0000551**
drh4602b8e2016-08-19 18:28:00 +0000552** For a constraint of the form X=expr, the expression is evaluated in
553** straight-line code. For constraints of the form X IN (...)
drh6f82e852015-06-06 20:12:09 +0000554** this routine sets up a loop that will iterate over all values of X.
555*/
556static int codeEqualityTerm(
557 Parse *pParse, /* The parsing context */
558 WhereTerm *pTerm, /* The term of the WHERE clause to be coded */
559 WhereLevel *pLevel, /* The level of the FROM clause we are working on */
560 int iEq, /* Index of the equality term within this level */
561 int bRev, /* True for reverse-order IN operations */
562 int iTarget /* Attempt to leave results in this register */
563){
564 Expr *pX = pTerm->pExpr;
565 Vdbe *v = pParse->pVdbe;
566 int iReg; /* Register holding results */
567
dan8da209b2016-07-26 18:06:08 +0000568 assert( pLevel->pWLoop->aLTerm[iEq]==pTerm );
drh6f82e852015-06-06 20:12:09 +0000569 assert( iTarget>0 );
570 if( pX->op==TK_EQ || pX->op==TK_IS ){
drhfc7f27b2016-08-20 00:07:01 +0000571 iReg = sqlite3ExprCodeTarget(pParse, pX->pRight, iTarget);
drh6f82e852015-06-06 20:12:09 +0000572 }else if( pX->op==TK_ISNULL ){
573 iReg = iTarget;
574 sqlite3VdbeAddOp2(v, OP_Null, 0, iReg);
575#ifndef SQLITE_OMIT_SUBQUERY
576 }else{
drhac6b47d2016-08-24 00:51:48 +0000577 int eType = IN_INDEX_NOOP;
drh6f82e852015-06-06 20:12:09 +0000578 int iTab;
579 struct InLoop *pIn;
580 WhereLoop *pLoop = pLevel->pWLoop;
dan8da209b2016-07-26 18:06:08 +0000581 int i;
582 int nEq = 0;
583 int *aiMap = 0;
drh6f82e852015-06-06 20:12:09 +0000584
585 if( (pLoop->wsFlags & WHERE_VIRTUALTABLE)==0
586 && pLoop->u.btree.pIndex!=0
587 && pLoop->u.btree.pIndex->aSortOrder[iEq]
588 ){
589 testcase( iEq==0 );
590 testcase( bRev );
591 bRev = !bRev;
592 }
593 assert( pX->op==TK_IN );
594 iReg = iTarget;
dan8da209b2016-07-26 18:06:08 +0000595
596 for(i=0; i<iEq; i++){
597 if( pLoop->aLTerm[i] && pLoop->aLTerm[i]->pExpr==pX ){
598 disableTerm(pLevel, pTerm);
599 return iTarget;
600 }
601 }
602 for(i=iEq;i<pLoop->nLTerm; i++){
drh24102432017-11-17 21:01:04 +0000603 assert( pLoop->aLTerm[i]!=0 );
604 if( pLoop->aLTerm[i]->pExpr==pX ) nEq++;
dan8da209b2016-07-26 18:06:08 +0000605 }
606
drh2c041312018-12-24 02:34:49 +0000607 iTab = 0;
drha4eeccd2021-10-07 17:43:30 +0000608 if( !ExprUseXSelect(pX) || pX->x.pSelect->pEList->nExpr==1 ){
drh2c041312018-12-24 02:34:49 +0000609 eType = sqlite3FindInIndex(pParse, pX, IN_INDEX_LOOP, 0, 0, &iTab);
dan8da209b2016-07-26 18:06:08 +0000610 }else{
611 sqlite3 *db = pParse->db;
drh24102432017-11-17 21:01:04 +0000612 pX = removeUnindexableInClauseTerms(pParse, iEq, pLoop, pX);
drh9b1ecb62017-11-17 17:32:40 +0000613
drhac6b47d2016-08-24 00:51:48 +0000614 if( !db->mallocFailed ){
drh24102432017-11-17 21:01:04 +0000615 aiMap = (int*)sqlite3DbMallocZero(pParse->db, sizeof(int)*nEq);
drh2c041312018-12-24 02:34:49 +0000616 eType = sqlite3FindInIndex(pParse, pX, IN_INDEX_LOOP, 0, aiMap, &iTab);
617 pTerm->pExpr->iTable = iTab;
drhac6b47d2016-08-24 00:51:48 +0000618 }
drh24102432017-11-17 21:01:04 +0000619 sqlite3ExprDelete(db, pX);
620 pX = pTerm->pExpr;
dan8da209b2016-07-26 18:06:08 +0000621 }
622
drh6f82e852015-06-06 20:12:09 +0000623 if( eType==IN_INDEX_INDEX_DESC ){
624 testcase( bRev );
625 bRev = !bRev;
626 }
drh6f82e852015-06-06 20:12:09 +0000627 sqlite3VdbeAddOp2(v, bRev ? OP_Last : OP_Rewind, iTab, 0);
628 VdbeCoverageIf(v, bRev);
629 VdbeCoverageIf(v, !bRev);
dan8da209b2016-07-26 18:06:08 +0000630
drh04756292021-10-14 19:28:28 +0000631 assert( (pLoop->wsFlags & WHERE_MULTI_OR)==0 );
drh6f82e852015-06-06 20:12:09 +0000632 pLoop->wsFlags |= WHERE_IN_ABLE;
633 if( pLevel->u.in.nIn==0 ){
drhec4ccdb2018-12-29 02:26:59 +0000634 pLevel->addrNxt = sqlite3VdbeMakeLabel(pParse);
drh6f82e852015-06-06 20:12:09 +0000635 }
drh46f0f4e2020-09-29 15:32:54 +0000636 if( iEq>0 && (pLoop->wsFlags & WHERE_IN_SEEKSCAN)==0 ){
drhfa17e132020-09-01 01:52:03 +0000637 pLoop->wsFlags |= WHERE_IN_EARLYOUT;
638 }
dan8da209b2016-07-26 18:06:08 +0000639
640 i = pLevel->u.in.nIn;
641 pLevel->u.in.nIn += nEq;
drh6f82e852015-06-06 20:12:09 +0000642 pLevel->u.in.aInLoop =
drhf8bdcfa2022-04-09 03:06:01 +0000643 sqlite3WhereRealloc(pTerm->pWC->pWInfo,
644 pLevel->u.in.aInLoop,
645 sizeof(pLevel->u.in.aInLoop[0])*pLevel->u.in.nIn);
drh6f82e852015-06-06 20:12:09 +0000646 pIn = pLevel->u.in.aInLoop;
647 if( pIn ){
dan8da209b2016-07-26 18:06:08 +0000648 int iMap = 0; /* Index in aiMap[] */
649 pIn += i;
dan7887d7f2016-08-24 12:22:17 +0000650 for(i=iEq;i<pLoop->nLTerm; i++){
dan8da209b2016-07-26 18:06:08 +0000651 if( pLoop->aLTerm[i]->pExpr==pX ){
danedc35372016-09-16 16:30:57 +0000652 int iOut = iReg + i - iEq;
dan8da209b2016-07-26 18:06:08 +0000653 if( eType==IN_INDEX_ROWID ){
danedc35372016-09-16 16:30:57 +0000654 pIn->addrInTop = sqlite3VdbeAddOp2(v, OP_Rowid, iTab, iOut);
dan8da209b2016-07-26 18:06:08 +0000655 }else{
656 int iCol = aiMap ? aiMap[iMap++] : 0;
dan8da209b2016-07-26 18:06:08 +0000657 pIn->addrInTop = sqlite3VdbeAddOp3(v,OP_Column,iTab, iCol, iOut);
658 }
drh03181c82016-08-18 19:04:57 +0000659 sqlite3VdbeAddOp1(v, OP_IsNull, iOut); VdbeCoverage(v);
dan8da209b2016-07-26 18:06:08 +0000660 if( i==iEq ){
661 pIn->iCur = iTab;
drhf1949b62018-06-07 17:32:59 +0000662 pIn->eEndLoopOp = bRev ? OP_Prev : OP_Next;
dan74ebaad2020-01-04 16:55:57 +0000663 if( iEq>0 ){
drh86d0ea72018-06-05 15:16:25 +0000664 pIn->iBase = iReg - i;
665 pIn->nPrefix = i;
666 }else{
667 pIn->nPrefix = 0;
668 }
dan8da209b2016-07-26 18:06:08 +0000669 }else{
670 pIn->eEndLoopOp = OP_Noop;
671 }
dan7887d7f2016-08-24 12:22:17 +0000672 pIn++;
dan8da209b2016-07-26 18:06:08 +0000673 }
drh6f82e852015-06-06 20:12:09 +0000674 }
drh67306cb2020-10-01 14:36:15 +0000675 testcase( iEq>0
676 && (pLoop->wsFlags & WHERE_IN_SEEKSCAN)==0
677 && (pLoop->wsFlags & WHERE_VIRTUALTABLE)!=0 );
678 if( iEq>0
679 && (pLoop->wsFlags & (WHERE_IN_SEEKSCAN|WHERE_VIRTUALTABLE))==0
680 ){
drhfa17e132020-09-01 01:52:03 +0000681 sqlite3VdbeAddOp3(v, OP_SeekHit, pLevel->iIdxCur, 0, iEq);
682 }
drh6f82e852015-06-06 20:12:09 +0000683 }else{
684 pLevel->u.in.nIn = 0;
685 }
dan8da209b2016-07-26 18:06:08 +0000686 sqlite3DbFree(pParse->db, aiMap);
drh6f82e852015-06-06 20:12:09 +0000687#endif
688 }
drh67656ac2021-05-04 23:21:35 +0000689
690 /* As an optimization, try to disable the WHERE clause term that is
691 ** driving the index as it will always be true. The correct answer is
692 ** obtained regardless, but we might get the answer with fewer CPU cycles
693 ** by omitting the term.
694 **
695 ** But do not disable the term unless we are certain that the term is
696 ** not a transitive constraint. For an example of where that does not
697 ** work, see https://sqlite.org/forum/forumpost/eb8613976a (2021-05-04)
698 */
699 if( (pLevel->pWLoop->wsFlags & WHERE_TRANSCONS)==0
700 || (pTerm->eOperator & WO_EQUIV)==0
701 ){
702 disableTerm(pLevel, pTerm);
703 }
704
drh6f82e852015-06-06 20:12:09 +0000705 return iReg;
706}
707
708/*
709** Generate code that will evaluate all == and IN constraints for an
710** index scan.
711**
712** For example, consider table t1(a,b,c,d,e,f) with index i1(a,b,c).
713** Suppose the WHERE clause is this: a==5 AND b IN (1,2,3) AND c>5 AND c<10
714** The index has as many as three equality constraints, but in this
715** example, the third "c" value is an inequality. So only two
716** constraints are coded. This routine will generate code to evaluate
717** a==5 and b IN (1,2,3). The current values for a and b will be stored
718** in consecutive registers and the index of the first register is returned.
719**
720** In the example above nEq==2. But this subroutine works for any value
721** of nEq including 0. If nEq==0, this routine is nearly a no-op.
722** The only thing it does is allocate the pLevel->iMem memory cell and
723** compute the affinity string.
724**
725** The nExtraReg parameter is 0 or 1. It is 0 if all WHERE clause constraints
726** are == or IN and are covered by the nEq. nExtraReg is 1 if there is
727** an inequality constraint (such as the "c>=5 AND c<10" in the example) that
728** occurs after the nEq quality constraints.
729**
730** This routine allocates a range of nEq+nExtraReg memory cells and returns
731** the index of the first memory cell in that range. The code that
732** calls this routine will use that memory range to store keys for
733** start and termination conditions of the loop.
734** key value of the loop. If one or more IN operators appear, then
735** this routine allocates an additional nEq memory cells for internal
736** use.
737**
738** Before returning, *pzAff is set to point to a buffer containing a
739** copy of the column affinity string of the index allocated using
740** sqlite3DbMalloc(). Except, entries in the copy of the string associated
741** with equality constraints that use BLOB or NONE affinity are set to
742** SQLITE_AFF_BLOB. This is to deal with SQL such as the following:
743**
744** CREATE TABLE t1(a TEXT PRIMARY KEY, b);
745** SELECT ... FROM t1 AS t2, t1 WHERE t1.a = t2.b;
746**
747** In the example above, the index on t1(a) has TEXT affinity. But since
748** the right hand side of the equality constraint (t2.b) has BLOB/NONE affinity,
749** no conversion should be attempted before using a t2.b value as part of
750** a key to search the index. Hence the first byte in the returned affinity
751** string in this example would be set to SQLITE_AFF_BLOB.
752*/
753static int codeAllEqualityTerms(
754 Parse *pParse, /* Parsing context */
755 WhereLevel *pLevel, /* Which nested loop of the FROM we are coding */
756 int bRev, /* Reverse the order of IN operators */
757 int nExtraReg, /* Number of extra registers to allocate */
758 char **pzAff /* OUT: Set to point to affinity string */
759){
760 u16 nEq; /* The number of == or IN constraints to code */
761 u16 nSkip; /* Number of left-most columns to skip */
762 Vdbe *v = pParse->pVdbe; /* The vm under construction */
763 Index *pIdx; /* The index being used for this loop */
764 WhereTerm *pTerm; /* A single constraint term */
765 WhereLoop *pLoop; /* The WhereLoop object */
766 int j; /* Loop counter */
767 int regBase; /* Base register */
768 int nReg; /* Number of registers to allocate */
769 char *zAff; /* Affinity string to return */
770
771 /* This module is only called on query plans that use an index. */
772 pLoop = pLevel->pWLoop;
773 assert( (pLoop->wsFlags & WHERE_VIRTUALTABLE)==0 );
774 nEq = pLoop->u.btree.nEq;
775 nSkip = pLoop->nSkip;
776 pIdx = pLoop->u.btree.pIndex;
777 assert( pIdx!=0 );
778
779 /* Figure out how many memory cells we will need then allocate them.
780 */
781 regBase = pParse->nMem + 1;
782 nReg = pLoop->u.btree.nEq + nExtraReg;
783 pParse->nMem += nReg;
784
drhe9107692015-08-25 19:20:04 +0000785 zAff = sqlite3DbStrDup(pParse->db,sqlite3IndexAffinityStr(pParse->db,pIdx));
drh4df86af2016-02-04 11:48:00 +0000786 assert( zAff!=0 || pParse->db->mallocFailed );
drh6f82e852015-06-06 20:12:09 +0000787
788 if( nSkip ){
789 int iIdxCur = pLevel->iIdxCur;
drh31536302021-04-21 23:13:26 +0000790 sqlite3VdbeAddOp3(v, OP_Null, 0, regBase, regBase+nSkip-1);
drh6f82e852015-06-06 20:12:09 +0000791 sqlite3VdbeAddOp1(v, (bRev?OP_Last:OP_Rewind), iIdxCur);
792 VdbeCoverageIf(v, bRev==0);
793 VdbeCoverageIf(v, bRev!=0);
794 VdbeComment((v, "begin skip-scan on %s", pIdx->zName));
795 j = sqlite3VdbeAddOp0(v, OP_Goto);
drh56945692022-03-02 21:04:10 +0000796 assert( pLevel->addrSkip==0 );
drh6f82e852015-06-06 20:12:09 +0000797 pLevel->addrSkip = sqlite3VdbeAddOp4Int(v, (bRev?OP_SeekLT:OP_SeekGT),
798 iIdxCur, 0, regBase, nSkip);
799 VdbeCoverageIf(v, bRev==0);
800 VdbeCoverageIf(v, bRev!=0);
801 sqlite3VdbeJumpHere(v, j);
802 for(j=0; j<nSkip; j++){
803 sqlite3VdbeAddOp3(v, OP_Column, iIdxCur, j, regBase+j);
drh4b92f982015-09-29 17:20:14 +0000804 testcase( pIdx->aiColumn[j]==XN_EXPR );
drhe63e8a62015-09-18 18:09:28 +0000805 VdbeComment((v, "%s", explainIndexColumnName(pIdx, j)));
drh6f82e852015-06-06 20:12:09 +0000806 }
807 }
808
809 /* Evaluate the equality constraints
810 */
811 assert( zAff==0 || (int)strlen(zAff)>=nEq );
812 for(j=nSkip; j<nEq; j++){
813 int r1;
814 pTerm = pLoop->aLTerm[j];
815 assert( pTerm!=0 );
816 /* The following testcase is true for indices with redundant columns.
817 ** Ex: CREATE INDEX i1 ON t1(a,b,a); SELECT * FROM t1 WHERE a=0 AND b=0; */
818 testcase( (pTerm->wtFlags & TERM_CODED)!=0 );
819 testcase( pTerm->wtFlags & TERM_VIRTUAL );
820 r1 = codeEqualityTerm(pParse, pTerm, pLevel, j, bRev, regBase+j);
821 if( r1!=regBase+j ){
822 if( nReg==1 ){
823 sqlite3ReleaseTempReg(pParse, regBase);
824 regBase = r1;
825 }else{
drhe9de6522021-05-28 12:48:31 +0000826 sqlite3VdbeAddOp2(v, OP_Copy, r1, regBase+j);
drh6f82e852015-06-06 20:12:09 +0000827 }
828 }
drhe482fde2022-01-21 16:41:11 +0000829 }
830 for(j=nSkip; j<nEq; j++){
831 pTerm = pLoop->aLTerm[j];
drhc097e122016-09-07 13:30:40 +0000832 if( pTerm->eOperator & WO_IN ){
833 if( pTerm->pExpr->flags & EP_xIsSelect ){
834 /* No affinity ever needs to be (or should be) applied to a value
835 ** from the RHS of an "? IN (SELECT ...)" expression. The
836 ** sqlite3FindInIndex() routine has already ensured that the
837 ** affinity of the comparison has been applied to the value. */
838 if( zAff ) zAff[j] = SQLITE_AFF_BLOB;
839 }
840 }else if( (pTerm->eOperator & WO_ISNULL)==0 ){
841 Expr *pRight = pTerm->pExpr->pRight;
842 if( (pTerm->wtFlags & TERM_IS)==0 && sqlite3ExprCanBeNull(pRight) ){
843 sqlite3VdbeAddOp2(v, OP_IsNull, regBase+j, pLevel->addrBrk);
844 VdbeCoverage(v);
845 }
drh0c7d3d32022-01-24 16:47:12 +0000846 if( pParse->nErr==0 ){
847 assert( pParse->db->mallocFailed==0 );
drhc097e122016-09-07 13:30:40 +0000848 if( sqlite3CompareAffinity(pRight, zAff[j])==SQLITE_AFF_BLOB ){
849 zAff[j] = SQLITE_AFF_BLOB;
dan27189602016-09-03 15:31:20 +0000850 }
drhc097e122016-09-07 13:30:40 +0000851 if( sqlite3ExprNeedsNoAffinityChange(pRight, zAff[j]) ){
852 zAff[j] = SQLITE_AFF_BLOB;
drh6f82e852015-06-06 20:12:09 +0000853 }
854 }
855 }
856 }
857 *pzAff = zAff;
858 return regBase;
859}
860
drh41d2e662015-12-01 21:23:07 +0000861#ifndef SQLITE_LIKE_DOESNT_MATCH_BLOBS
drh6f82e852015-06-06 20:12:09 +0000862/*
drh44aebff2016-05-02 10:25:42 +0000863** If the most recently coded instruction is a constant range constraint
864** (a string literal) that originated from the LIKE optimization, then
865** set P3 and P5 on the OP_String opcode so that the string will be cast
866** to a BLOB at appropriate times.
drh6f82e852015-06-06 20:12:09 +0000867**
868** The LIKE optimization trys to evaluate "x LIKE 'abc%'" as a range
869** expression: "x>='ABC' AND x<'abd'". But this requires that the range
870** scan loop run twice, once for strings and a second time for BLOBs.
871** The OP_String opcodes on the second pass convert the upper and lower
mistachkine234cfd2016-07-10 19:35:10 +0000872** bound string constants to blobs. This routine makes the necessary changes
drh6f82e852015-06-06 20:12:09 +0000873** to the OP_String opcodes for that to happen.
drh41d2e662015-12-01 21:23:07 +0000874**
875** Except, of course, if SQLITE_LIKE_DOESNT_MATCH_BLOBS is defined, then
876** only the one pass through the string space is required, so this routine
877** becomes a no-op.
drh6f82e852015-06-06 20:12:09 +0000878*/
879static void whereLikeOptimizationStringFixup(
880 Vdbe *v, /* prepared statement under construction */
881 WhereLevel *pLevel, /* The loop that contains the LIKE operator */
882 WhereTerm *pTerm /* The upper or lower bound just coded */
883){
884 if( pTerm->wtFlags & TERM_LIKEOPT ){
885 VdbeOp *pOp;
886 assert( pLevel->iLikeRepCntr>0 );
887 pOp = sqlite3VdbeGetOp(v, -1);
888 assert( pOp!=0 );
889 assert( pOp->opcode==OP_String8
890 || pTerm->pWC->pWInfo->pParse->db->mallocFailed );
drh44aebff2016-05-02 10:25:42 +0000891 pOp->p3 = (int)(pLevel->iLikeRepCntr>>1); /* Register holding counter */
892 pOp->p5 = (u8)(pLevel->iLikeRepCntr&1); /* ASC or DESC */
drh6f82e852015-06-06 20:12:09 +0000893 }
894}
drh41d2e662015-12-01 21:23:07 +0000895#else
896# define whereLikeOptimizationStringFixup(A,B,C)
897#endif
drh6f82e852015-06-06 20:12:09 +0000898
drhbec24762015-08-13 20:07:13 +0000899#ifdef SQLITE_ENABLE_CURSOR_HINTS
drh2f2b0272015-08-14 18:50:04 +0000900/*
901** Information is passed from codeCursorHint() down to individual nodes of
902** the expression tree (by sqlite3WalkExpr()) using an instance of this
903** structure.
904*/
905struct CCurHint {
906 int iTabCur; /* Cursor for the main table */
907 int iIdxCur; /* Cursor for the index, if pIdx!=0. Unused otherwise */
908 Index *pIdx; /* The index used to access the table */
909};
910
911/*
912** This function is called for every node of an expression that is a candidate
913** for a cursor hint on an index cursor. For TK_COLUMN nodes that reference
914** the table CCurHint.iTabCur, verify that the same column can be
915** accessed through the index. If it cannot, then set pWalker->eCode to 1.
916*/
917static int codeCursorHintCheckExpr(Walker *pWalker, Expr *pExpr){
918 struct CCurHint *pHint = pWalker->u.pCCurHint;
919 assert( pHint->pIdx!=0 );
920 if( pExpr->op==TK_COLUMN
921 && pExpr->iTable==pHint->iTabCur
drhb9bcf7c2019-10-19 13:29:10 +0000922 && sqlite3TableColumnToIndex(pHint->pIdx, pExpr->iColumn)<0
drh2f2b0272015-08-14 18:50:04 +0000923 ){
924 pWalker->eCode = 1;
925 }
926 return WRC_Continue;
927}
928
dane6912fd2016-06-17 19:27:13 +0000929/*
930** Test whether or not expression pExpr, which was part of a WHERE clause,
931** should be included in the cursor-hint for a table that is on the rhs
932** of a LEFT JOIN. Set Walker.eCode to non-zero before returning if the
933** expression is not suitable.
934**
935** An expression is unsuitable if it might evaluate to non NULL even if
936** a TK_COLUMN node that does affect the value of the expression is set
937** to NULL. For example:
938**
939** col IS NULL
940** col IS NOT NULL
941** coalesce(col, 1)
942** CASE WHEN col THEN 0 ELSE 1 END
943*/
944static int codeCursorHintIsOrFunction(Walker *pWalker, Expr *pExpr){
dan2b693d62016-06-20 17:22:06 +0000945 if( pExpr->op==TK_IS
dane6912fd2016-06-17 19:27:13 +0000946 || pExpr->op==TK_ISNULL || pExpr->op==TK_ISNOT
947 || pExpr->op==TK_NOTNULL || pExpr->op==TK_CASE
948 ){
949 pWalker->eCode = 1;
dan2b693d62016-06-20 17:22:06 +0000950 }else if( pExpr->op==TK_FUNCTION ){
951 int d1;
drh1d42ea72017-07-27 20:24:29 +0000952 char d2[4];
dan2b693d62016-06-20 17:22:06 +0000953 if( 0==sqlite3IsLikeFunction(pWalker->pParse->db, pExpr, &d1, d2) ){
954 pWalker->eCode = 1;
955 }
dane6912fd2016-06-17 19:27:13 +0000956 }
dan2b693d62016-06-20 17:22:06 +0000957
dane6912fd2016-06-17 19:27:13 +0000958 return WRC_Continue;
959}
960
drhbec24762015-08-13 20:07:13 +0000961
962/*
963** This function is called on every node of an expression tree used as an
964** argument to the OP_CursorHint instruction. If the node is a TK_COLUMN
drh2f2b0272015-08-14 18:50:04 +0000965** that accesses any table other than the one identified by
966** CCurHint.iTabCur, then do the following:
drhbec24762015-08-13 20:07:13 +0000967**
968** 1) allocate a register and code an OP_Column instruction to read
969** the specified column into the new register, and
970**
971** 2) transform the expression node to a TK_REGISTER node that reads
972** from the newly populated register.
drh2f2b0272015-08-14 18:50:04 +0000973**
974** Also, if the node is a TK_COLUMN that does access the table idenified
975** by pCCurHint.iTabCur, and an index is being used (which we will
976** know because CCurHint.pIdx!=0) then transform the TK_COLUMN into
977** an access of the index rather than the original table.
drhbec24762015-08-13 20:07:13 +0000978*/
979static int codeCursorHintFixExpr(Walker *pWalker, Expr *pExpr){
980 int rc = WRC_Continue;
drh2f2b0272015-08-14 18:50:04 +0000981 struct CCurHint *pHint = pWalker->u.pCCurHint;
danbe312ae2018-09-10 19:27:12 +0000982 if( pExpr->op==TK_COLUMN ){
drh2f2b0272015-08-14 18:50:04 +0000983 if( pExpr->iTable!=pHint->iTabCur ){
drh2f2b0272015-08-14 18:50:04 +0000984 int reg = ++pWalker->pParse->nMem; /* Register for column value */
dane3e79212018-09-11 13:38:35 +0000985 sqlite3ExprCode(pWalker->pParse, pExpr, reg);
drh2f2b0272015-08-14 18:50:04 +0000986 pExpr->op = TK_REGISTER;
987 pExpr->iTable = reg;
988 }else if( pHint->pIdx!=0 ){
989 pExpr->iTable = pHint->iIdxCur;
drhb9bcf7c2019-10-19 13:29:10 +0000990 pExpr->iColumn = sqlite3TableColumnToIndex(pHint->pIdx, pExpr->iColumn);
drh2f2b0272015-08-14 18:50:04 +0000991 assert( pExpr->iColumn>=0 );
992 }
drhbec24762015-08-13 20:07:13 +0000993 }else if( pExpr->op==TK_AGG_FUNCTION ){
994 /* An aggregate function in the WHERE clause of a query means this must
995 ** be a correlated sub-query, and expression pExpr is an aggregate from
996 ** the parent context. Do not walk the function arguments in this case.
997 **
998 ** todo: It should be possible to replace this node with a TK_REGISTER
999 ** expression, as the result of the expression must be stored in a
1000 ** register at this point. The same holds for TK_AGG_COLUMN nodes. */
1001 rc = WRC_Prune;
1002 }
1003 return rc;
1004}
1005
1006/*
1007** Insert an OP_CursorHint instruction if it is appropriate to do so.
1008*/
1009static void codeCursorHint(
drh76012942021-02-21 21:04:54 +00001010 SrcItem *pTabItem, /* FROM clause item */
drhb413a542015-08-17 17:19:28 +00001011 WhereInfo *pWInfo, /* The where clause */
1012 WhereLevel *pLevel, /* Which loop to provide hints for */
1013 WhereTerm *pEndRange /* Hint this end-of-scan boundary term if not NULL */
drhbec24762015-08-13 20:07:13 +00001014){
1015 Parse *pParse = pWInfo->pParse;
1016 sqlite3 *db = pParse->db;
1017 Vdbe *v = pParse->pVdbe;
drhbec24762015-08-13 20:07:13 +00001018 Expr *pExpr = 0;
drh2f2b0272015-08-14 18:50:04 +00001019 WhereLoop *pLoop = pLevel->pWLoop;
drhbec24762015-08-13 20:07:13 +00001020 int iCur;
1021 WhereClause *pWC;
1022 WhereTerm *pTerm;
drhb413a542015-08-17 17:19:28 +00001023 int i, j;
drh2f2b0272015-08-14 18:50:04 +00001024 struct CCurHint sHint;
1025 Walker sWalker;
drhbec24762015-08-13 20:07:13 +00001026
1027 if( OptimizationDisabled(db, SQLITE_CursorHints) ) return;
drh2f2b0272015-08-14 18:50:04 +00001028 iCur = pLevel->iTabCur;
1029 assert( iCur==pWInfo->pTabList->a[pLevel->iFrom].iCursor );
1030 sHint.iTabCur = iCur;
1031 sHint.iIdxCur = pLevel->iIdxCur;
1032 sHint.pIdx = pLoop->u.btree.pIndex;
1033 memset(&sWalker, 0, sizeof(sWalker));
1034 sWalker.pParse = pParse;
1035 sWalker.u.pCCurHint = &sHint;
drhbec24762015-08-13 20:07:13 +00001036 pWC = &pWInfo->sWC;
drh132f96f2021-12-08 16:07:22 +00001037 for(i=0; i<pWC->nBase; i++){
drhbec24762015-08-13 20:07:13 +00001038 pTerm = &pWC->a[i];
1039 if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
1040 if( pTerm->prereqAll & pLevel->notReady ) continue;
danb324cf72016-06-17 14:33:32 +00001041
1042 /* Any terms specified as part of the ON(...) clause for any LEFT
1043 ** JOIN for which the current table is not the rhs are omitted
1044 ** from the cursor-hint.
1045 **
dane6912fd2016-06-17 19:27:13 +00001046 ** If this table is the rhs of a LEFT JOIN, "IS" or "IS NULL" terms
1047 ** that were specified as part of the WHERE clause must be excluded.
1048 ** This is to address the following:
danb324cf72016-06-17 14:33:32 +00001049 **
1050 ** SELECT ... t1 LEFT JOIN t2 ON (t1.a=t2.b) WHERE t2.c IS NULL;
1051 **
dane6912fd2016-06-17 19:27:13 +00001052 ** Say there is a single row in t2 that matches (t1.a=t2.b), but its
1053 ** t2.c values is not NULL. If the (t2.c IS NULL) constraint is
1054 ** pushed down to the cursor, this row is filtered out, causing
1055 ** SQLite to synthesize a row of NULL values. Which does match the
1056 ** WHERE clause, and so the query returns a row. Which is incorrect.
1057 **
1058 ** For the same reason, WHERE terms such as:
1059 **
1060 ** WHERE 1 = (t2.c IS NULL)
1061 **
1062 ** are also excluded. See codeCursorHintIsOrFunction() for details.
danb324cf72016-06-17 14:33:32 +00001063 */
1064 if( pTabItem->fg.jointype & JT_LEFT ){
dane6912fd2016-06-17 19:27:13 +00001065 Expr *pExpr = pTerm->pExpr;
1066 if( !ExprHasProperty(pExpr, EP_FromJoin)
drh796588a2022-02-05 21:49:47 +00001067 || pExpr->w.iRightJoinTable!=pTabItem->iCursor
danb324cf72016-06-17 14:33:32 +00001068 ){
dane6912fd2016-06-17 19:27:13 +00001069 sWalker.eCode = 0;
1070 sWalker.xExprCallback = codeCursorHintIsOrFunction;
1071 sqlite3WalkExpr(&sWalker, pTerm->pExpr);
1072 if( sWalker.eCode ) continue;
danb324cf72016-06-17 14:33:32 +00001073 }
1074 }else{
1075 if( ExprHasProperty(pTerm->pExpr, EP_FromJoin) ) continue;
1076 }
drhb413a542015-08-17 17:19:28 +00001077
1078 /* All terms in pWLoop->aLTerm[] except pEndRange are used to initialize
drhbcf40a72015-08-18 15:58:05 +00001079 ** the cursor. These terms are not needed as hints for a pure range
1080 ** scan (that has no == terms) so omit them. */
1081 if( pLoop->u.btree.nEq==0 && pTerm!=pEndRange ){
1082 for(j=0; j<pLoop->nLTerm && pLoop->aLTerm[j]!=pTerm; j++){}
1083 if( j<pLoop->nLTerm ) continue;
drhb413a542015-08-17 17:19:28 +00001084 }
1085
1086 /* No subqueries or non-deterministic functions allowed */
drhbec24762015-08-13 20:07:13 +00001087 if( sqlite3ExprContainsSubquery(pTerm->pExpr) ) continue;
drhb413a542015-08-17 17:19:28 +00001088
1089 /* For an index scan, make sure referenced columns are actually in
1090 ** the index. */
drh2f2b0272015-08-14 18:50:04 +00001091 if( sHint.pIdx!=0 ){
1092 sWalker.eCode = 0;
1093 sWalker.xExprCallback = codeCursorHintCheckExpr;
1094 sqlite3WalkExpr(&sWalker, pTerm->pExpr);
1095 if( sWalker.eCode ) continue;
1096 }
drhb413a542015-08-17 17:19:28 +00001097
1098 /* If we survive all prior tests, that means this term is worth hinting */
drhd5c851c2019-04-19 13:38:34 +00001099 pExpr = sqlite3ExprAnd(pParse, pExpr, sqlite3ExprDup(db, pTerm->pExpr, 0));
drhbec24762015-08-13 20:07:13 +00001100 }
1101 if( pExpr!=0 ){
drhbec24762015-08-13 20:07:13 +00001102 sWalker.xExprCallback = codeCursorHintFixExpr;
drhbec24762015-08-13 20:07:13 +00001103 sqlite3WalkExpr(&sWalker, pExpr);
drh2f2b0272015-08-14 18:50:04 +00001104 sqlite3VdbeAddOp4(v, OP_CursorHint,
1105 (sHint.pIdx ? sHint.iIdxCur : sHint.iTabCur), 0, 0,
1106 (const char*)pExpr, P4_EXPR);
drhbec24762015-08-13 20:07:13 +00001107 }
1108}
1109#else
danb324cf72016-06-17 14:33:32 +00001110# define codeCursorHint(A,B,C,D) /* No-op */
drhbec24762015-08-13 20:07:13 +00001111#endif /* SQLITE_ENABLE_CURSOR_HINTS */
drh6f82e852015-06-06 20:12:09 +00001112
1113/*
dande892d92016-01-29 19:29:45 +00001114** Cursor iCur is open on an intkey b-tree (a table). Register iRowid contains
1115** a rowid value just read from cursor iIdxCur, open on index pIdx. This
1116** function generates code to do a deferred seek of cursor iCur to the
1117** rowid stored in register iRowid.
1118**
1119** Normally, this is just:
1120**
drh170ad682017-06-02 15:44:22 +00001121** OP_DeferredSeek $iCur $iRowid
dande892d92016-01-29 19:29:45 +00001122**
drh7fd6a772022-02-25 13:29:56 +00001123** Which causes a seek on $iCur to the row with rowid $iRowid.
1124**
dande892d92016-01-29 19:29:45 +00001125** However, if the scan currently being coded is a branch of an OR-loop and
drh7fd6a772022-02-25 13:29:56 +00001126** the statement currently being coded is a SELECT, then additional information
1127** is added that might allow OP_Column to omit the seek and instead do its
1128** lookup on the index, thus avoiding an expensive seek operation. To
1129** enable this optimization, the P3 of OP_DeferredSeek is set to iIdxCur
1130** and P4 is set to an array of integers containing one entry for each column
1131** in the table. For each table column, if the column is the i'th
1132** column of the index, then the corresponding array entry is set to (i+1).
1133** If the column does not appear in the index at all, the array entry is set
1134** to 0. The OP_Column opcode can check this array to see if the column it
1135** wants is in the index and if it is, it will substitute the index cursor
1136** and column number and continue with those new values, rather than seeking
1137** the table cursor.
dande892d92016-01-29 19:29:45 +00001138*/
1139static void codeDeferredSeek(
1140 WhereInfo *pWInfo, /* Where clause context */
1141 Index *pIdx, /* Index scan is using */
1142 int iCur, /* Cursor for IPK b-tree */
dande892d92016-01-29 19:29:45 +00001143 int iIdxCur /* Index cursor */
1144){
1145 Parse *pParse = pWInfo->pParse; /* Parse context */
1146 Vdbe *v = pParse->pVdbe; /* Vdbe to generate code within */
1147
1148 assert( iIdxCur>0 );
1149 assert( pIdx->aiColumn[pIdx->nColumn-1]==-1 );
1150
drhbe3da242019-12-29 00:52:41 +00001151 pWInfo->bDeferredSeek = 1;
drh170ad682017-06-02 15:44:22 +00001152 sqlite3VdbeAddOp3(v, OP_DeferredSeek, iIdxCur, 0, iCur);
drhce943bc2016-05-19 18:56:33 +00001153 if( (pWInfo->wctrlFlags & WHERE_OR_SUBCLAUSE)
dancddb6ba2016-02-01 13:58:56 +00001154 && DbMaskAllZero(sqlite3ParseToplevel(pParse)->writeMask)
dande892d92016-01-29 19:29:45 +00001155 ){
1156 int i;
1157 Table *pTab = pIdx->pTable;
drhabc38152020-07-22 13:38:04 +00001158 u32 *ai = (u32*)sqlite3DbMallocZero(pParse->db, sizeof(u32)*(pTab->nCol+1));
dande892d92016-01-29 19:29:45 +00001159 if( ai ){
drhb1702022016-01-30 00:45:18 +00001160 ai[0] = pTab->nCol;
dande892d92016-01-29 19:29:45 +00001161 for(i=0; i<pIdx->nColumn-1; i++){
drh4fb24c82019-11-06 17:31:18 +00001162 int x1, x2;
dande892d92016-01-29 19:29:45 +00001163 assert( pIdx->aiColumn[i]<pTab->nCol );
drh4fb24c82019-11-06 17:31:18 +00001164 x1 = pIdx->aiColumn[i];
1165 x2 = sqlite3TableColumnToStorage(pTab, x1);
1166 testcase( x1!=x2 );
mistachkinbde3a4f2019-11-06 19:25:45 +00001167 if( x1>=0 ) ai[x2+1] = i+1;
dande892d92016-01-29 19:29:45 +00001168 }
1169 sqlite3VdbeChangeP4(v, -1, (char*)ai, P4_INTARRAY);
1170 }
1171 }
1172}
1173
dan553168c2016-08-01 20:14:31 +00001174/*
1175** If the expression passed as the second argument is a vector, generate
1176** code to write the first nReg elements of the vector into an array
1177** of registers starting with iReg.
1178**
1179** If the expression is not a vector, then nReg must be passed 1. In
1180** this case, generate code to evaluate the expression and leave the
1181** result in register iReg.
1182*/
dan71c57db2016-07-09 20:23:55 +00001183static void codeExprOrVector(Parse *pParse, Expr *p, int iReg, int nReg){
1184 assert( nReg>0 );
dand03024d2017-09-09 19:41:12 +00001185 if( p && sqlite3ExprIsVector(p) ){
danf9b2e052016-08-02 17:45:00 +00001186#ifndef SQLITE_OMIT_SUBQUERY
drha4eeccd2021-10-07 17:43:30 +00001187 if( ExprUseXSelect(p) ){
danf9b2e052016-08-02 17:45:00 +00001188 Vdbe *v = pParse->pVdbe;
drh85bcdce2018-12-23 21:27:29 +00001189 int iSelect;
1190 assert( p->op==TK_SELECT );
1191 iSelect = sqlite3CodeSubselect(pParse, p);
danf9b2e052016-08-02 17:45:00 +00001192 sqlite3VdbeAddOp3(v, OP_Copy, iSelect, iReg, nReg-1);
1193 }else
1194#endif
1195 {
1196 int i;
drha4eeccd2021-10-07 17:43:30 +00001197 const ExprList *pList;
1198 assert( ExprUseXList(p) );
1199 pList = p->x.pList;
dan71c57db2016-07-09 20:23:55 +00001200 assert( nReg<=pList->nExpr );
1201 for(i=0; i<nReg; i++){
1202 sqlite3ExprCode(pParse, pList->a[i].pExpr, iReg+i);
1203 }
dan71c57db2016-07-09 20:23:55 +00001204 }
1205 }else{
dan151446e2021-05-26 14:32:33 +00001206 assert( nReg==1 || pParse->nErr );
dan71c57db2016-07-09 20:23:55 +00001207 sqlite3ExprCode(pParse, p, iReg);
1208 }
1209}
1210
drheac5fc02017-04-11 01:01:27 +00001211/* An instance of the IdxExprTrans object carries information about a
1212** mapping from an expression on table columns into a column in an index
1213** down through the Walker.
1214*/
drhaca19e12017-04-07 19:41:31 +00001215typedef struct IdxExprTrans {
1216 Expr *pIdxExpr; /* The index expression */
1217 int iTabCur; /* The cursor of the corresponding table */
1218 int iIdxCur; /* The cursor for the index */
1219 int iIdxCol; /* The column for the index */
drhc7476732019-10-24 20:29:25 +00001220 int iTabCol; /* The column for the table */
drh36e678b2020-01-02 00:45:38 +00001221 WhereInfo *pWInfo; /* Complete WHERE clause information */
1222 sqlite3 *db; /* Database connection (for malloc()) */
drhaca19e12017-04-07 19:41:31 +00001223} IdxExprTrans;
1224
drh36e678b2020-01-02 00:45:38 +00001225/*
1226** Preserve pExpr on the WhereETrans list of the WhereInfo.
1227*/
1228static void preserveExpr(IdxExprTrans *pTrans, Expr *pExpr){
1229 WhereExprMod *pNew;
1230 pNew = sqlite3DbMallocRaw(pTrans->db, sizeof(*pNew));
1231 if( pNew==0 ) return;
1232 pNew->pNext = pTrans->pWInfo->pExprMods;
1233 pTrans->pWInfo->pExprMods = pNew;
1234 pNew->pExpr = pExpr;
1235 memcpy(&pNew->orig, pExpr, sizeof(*pExpr));
1236}
1237
drheac5fc02017-04-11 01:01:27 +00001238/* The walker node callback used to transform matching expressions into
1239** a reference to an index column for an index on an expression.
1240**
1241** If pExpr matches, then transform it into a reference to the index column
1242** that contains the value of pExpr.
1243*/
drhaca19e12017-04-07 19:41:31 +00001244static int whereIndexExprTransNode(Walker *p, Expr *pExpr){
1245 IdxExprTrans *pX = p->u.pIdxTrans;
dan5aa550c2017-06-24 18:10:29 +00001246 if( sqlite3ExprCompare(0, pExpr, pX->pIdxExpr, pX->iTabCur)==0 ){
drh36e678b2020-01-02 00:45:38 +00001247 preserveExpr(pX, pExpr);
danb6ce71b2019-08-20 11:43:44 +00001248 pExpr->affExpr = sqlite3ExprAffinity(pExpr);
drhaca19e12017-04-07 19:41:31 +00001249 pExpr->op = TK_COLUMN;
1250 pExpr->iTable = pX->iIdxCur;
1251 pExpr->iColumn = pX->iIdxCol;
drh6c1c85c2019-12-22 18:55:04 +00001252 testcase( ExprHasProperty(pExpr, EP_Skip) );
1253 testcase( ExprHasProperty(pExpr, EP_Unlikely) );
drh477572b2021-10-07 20:46:29 +00001254 ExprClearProperty(pExpr, EP_Skip|EP_Unlikely|EP_WinFunc|EP_Subrtn);
1255 pExpr->y.pTab = 0;
drhaca19e12017-04-07 19:41:31 +00001256 return WRC_Prune;
1257 }else{
1258 return WRC_Continue;
1259 }
1260}
1261
drhc7476732019-10-24 20:29:25 +00001262#ifndef SQLITE_OMIT_GENERATED_COLUMNS
1263/* A walker node callback that translates a column reference to a table
1264** into a corresponding column reference of an index.
1265*/
1266static int whereIndexExprTransColumn(Walker *p, Expr *pExpr){
1267 if( pExpr->op==TK_COLUMN ){
1268 IdxExprTrans *pX = p->u.pIdxTrans;
1269 if( pExpr->iTable==pX->iTabCur && pExpr->iColumn==pX->iTabCol ){
drh477572b2021-10-07 20:46:29 +00001270 assert( ExprUseYTab(pExpr) && pExpr->y.pTab!=0 );
drh36e678b2020-01-02 00:45:38 +00001271 preserveExpr(pX, pExpr);
drh57f7ece2019-11-21 18:28:44 +00001272 pExpr->affExpr = sqlite3TableColumnAffinity(pExpr->y.pTab,pExpr->iColumn);
drhc7476732019-10-24 20:29:25 +00001273 pExpr->iTable = pX->iIdxCur;
1274 pExpr->iColumn = pX->iIdxCol;
drh4485ac12019-10-24 21:02:06 +00001275 pExpr->y.pTab = 0;
drhc7476732019-10-24 20:29:25 +00001276 }
1277 }
1278 return WRC_Continue;
1279}
1280#endif /* SQLITE_OMIT_GENERATED_COLUMNS */
1281
drhaca19e12017-04-07 19:41:31 +00001282/*
drhf49759b2017-08-25 19:51:51 +00001283** For an indexes on expression X, locate every instance of expression X
1284** in pExpr and change that subexpression into a reference to the appropriate
1285** column of the index.
drhc7476732019-10-24 20:29:25 +00001286**
1287** 2019-10-24: Updated to also translate references to a VIRTUAL column in
1288** the table into references to the corresponding (stored) column of the
1289** index.
drhaca19e12017-04-07 19:41:31 +00001290*/
1291static void whereIndexExprTrans(
1292 Index *pIdx, /* The Index */
1293 int iTabCur, /* Cursor of the table that is being indexed */
1294 int iIdxCur, /* Cursor of the index itself */
1295 WhereInfo *pWInfo /* Transform expressions in this WHERE clause */
1296){
1297 int iIdxCol; /* Column number of the index */
1298 ExprList *aColExpr; /* Expressions that are indexed */
drhc7476732019-10-24 20:29:25 +00001299 Table *pTab;
drhaca19e12017-04-07 19:41:31 +00001300 Walker w;
1301 IdxExprTrans x;
1302 aColExpr = pIdx->aColExpr;
drhc7476732019-10-24 20:29:25 +00001303 if( aColExpr==0 && !pIdx->bHasVCol ){
1304 /* The index does not reference any expressions or virtual columns
1305 ** so no translations are needed. */
1306 return;
1307 }
1308 pTab = pIdx->pTable;
drhaca19e12017-04-07 19:41:31 +00001309 memset(&w, 0, sizeof(w));
drhaca19e12017-04-07 19:41:31 +00001310 w.u.pIdxTrans = &x;
1311 x.iTabCur = iTabCur;
1312 x.iIdxCur = iIdxCur;
drh36e678b2020-01-02 00:45:38 +00001313 x.pWInfo = pWInfo;
1314 x.db = pWInfo->pParse->db;
drhc7476732019-10-24 20:29:25 +00001315 for(iIdxCol=0; iIdxCol<pIdx->nColumn; iIdxCol++){
1316 i16 iRef = pIdx->aiColumn[iIdxCol];
1317 if( iRef==XN_EXPR ){
drh7d4c94b2021-10-04 22:34:38 +00001318 assert( aColExpr!=0 && aColExpr->a[iIdxCol].pExpr!=0 );
drhc7476732019-10-24 20:29:25 +00001319 x.pIdxExpr = aColExpr->a[iIdxCol].pExpr;
drhe86f3402019-12-26 00:20:56 +00001320 if( sqlite3ExprIsConstant(x.pIdxExpr) ) continue;
drhc7476732019-10-24 20:29:25 +00001321 w.xExprCallback = whereIndexExprTransNode;
1322#ifndef SQLITE_OMIT_GENERATED_COLUMNS
drhed0c3482019-12-20 22:46:41 +00001323 }else if( iRef>=0
1324 && (pTab->aCol[iRef].colFlags & COLFLAG_VIRTUAL)!=0
drh65b40092021-08-05 15:27:19 +00001325 && ((pTab->aCol[iRef].colFlags & COLFLAG_HASCOLL)==0
1326 || sqlite3StrICmp(sqlite3ColumnColl(&pTab->aCol[iRef]),
1327 sqlite3StrBINARY)==0)
drhed0c3482019-12-20 22:46:41 +00001328 ){
1329 /* Check to see if there are direct references to generated columns
1330 ** that are contained in the index. Pulling the generated column
1331 ** out of the index is an optimization only - the main table is always
1332 ** available if the index cannot be used. To avoid unnecessary
1333 ** complication, omit this optimization if the collating sequence for
1334 ** the column is non-standard */
drhc7476732019-10-24 20:29:25 +00001335 x.iTabCol = iRef;
1336 w.xExprCallback = whereIndexExprTransColumn;
1337#endif /* SQLITE_OMIT_GENERATED_COLUMNS */
1338 }else{
1339 continue;
1340 }
drhaca19e12017-04-07 19:41:31 +00001341 x.iIdxCol = iIdxCol;
drhaca19e12017-04-07 19:41:31 +00001342 sqlite3WalkExpr(&w, pWInfo->pWhere);
1343 sqlite3WalkExprList(&w, pWInfo->pOrderBy);
1344 sqlite3WalkExprList(&w, pWInfo->pResultSet);
1345 }
1346}
drhaca19e12017-04-07 19:41:31 +00001347
dande892d92016-01-29 19:29:45 +00001348/*
drh610f11d2019-03-18 10:30:00 +00001349** The pTruth expression is always true because it is the WHERE clause
drhb531aa82019-03-01 18:07:05 +00001350** a partial index that is driving a query loop. Look through all of the
1351** WHERE clause terms on the query, and if any of those terms must be
1352** true because pTruth is true, then mark those WHERE clause terms as
1353** coded.
1354*/
1355static void whereApplyPartialIndexConstraints(
1356 Expr *pTruth,
1357 int iTabCur,
1358 WhereClause *pWC
1359){
1360 int i;
1361 WhereTerm *pTerm;
1362 while( pTruth->op==TK_AND ){
1363 whereApplyPartialIndexConstraints(pTruth->pLeft, iTabCur, pWC);
1364 pTruth = pTruth->pRight;
1365 }
1366 for(i=0, pTerm=pWC->a; i<pWC->nTerm; i++, pTerm++){
1367 Expr *pExpr;
1368 if( pTerm->wtFlags & TERM_CODED ) continue;
1369 pExpr = pTerm->pExpr;
1370 if( sqlite3ExprCompare(0, pExpr, pTruth, iTabCur)==0 ){
1371 pTerm->wtFlags |= TERM_CODED;
1372 }
1373 }
1374}
1375
drh35685d32021-12-05 00:45:55 +00001376/*
drh6ae49e62021-12-05 20:19:47 +00001377** This routine is called right after An OP_Filter has been generated and
1378** before the corresponding index search has been performed. This routine
1379** checks to see if there are additional Bloom filters in inner loops that
1380** can be checked prior to doing the index lookup. If there are available
1381** inner-loop Bloom filters, then evaluate those filters now, before the
1382** index lookup. The idea is that a Bloom filter check is way faster than
1383** an index lookup, and the Bloom filter might return false, meaning that
1384** the index lookup can be skipped.
1385**
1386** We know that an inner loop uses a Bloom filter because it has the
1387** WhereLevel.regFilter set. If an inner-loop Bloom filter is checked,
drh5a4ac1c2021-12-09 19:42:52 +00001388** then clear the WhereLevel.regFilter value to prevent the Bloom filter
drh6ae49e62021-12-05 20:19:47 +00001389** from being checked a second time when the inner loop is evaluated.
drh35685d32021-12-05 00:45:55 +00001390*/
1391static SQLITE_NOINLINE void filterPullDown(
1392 Parse *pParse, /* Parsing context */
1393 WhereInfo *pWInfo, /* Complete information about the WHERE clause */
1394 int iLevel, /* Which level of pWInfo->a[] should be coded */
1395 int addrNxt, /* Jump here to bypass inner loops */
1396 Bitmask notReady /* Loops that are not ready */
1397){
1398 while( ++iLevel < pWInfo->nLevel ){
1399 WhereLevel *pLevel = &pWInfo->a[iLevel];
1400 WhereLoop *pLoop = pLevel->pWLoop;
drh6ae49e62021-12-05 20:19:47 +00001401 if( pLevel->regFilter==0 ) continue;
drh56945692022-03-02 21:04:10 +00001402 if( pLevel->pWLoop->nSkip ) continue;
drh27a9e1f2021-12-10 17:36:16 +00001403 /* ,--- Because sqlite3ConstructBloomFilter() has will not have set
drha11c5e22021-12-09 18:44:03 +00001404 ** vvvvv--' pLevel->regFilter if this were true. */
1405 if( NEVER(pLoop->prereq & notReady) ) continue;
drh35685d32021-12-05 00:45:55 +00001406 if( pLoop->wsFlags & WHERE_IPK ){
1407 WhereTerm *pTerm = pLoop->aLTerm[0];
drh7e910f62021-12-09 01:28:15 +00001408 int regRowid;
drh35685d32021-12-05 00:45:55 +00001409 assert( pTerm!=0 );
1410 assert( pTerm->pExpr!=0 );
1411 testcase( pTerm->wtFlags & TERM_VIRTUAL );
drh7e910f62021-12-09 01:28:15 +00001412 regRowid = sqlite3GetTempReg(pParse);
1413 regRowid = codeEqualityTerm(pParse, pTerm, pLevel, 0, 0, regRowid);
drh35685d32021-12-05 00:45:55 +00001414 sqlite3VdbeAddOp4Int(pParse->pVdbe, OP_Filter, pLevel->regFilter,
1415 addrNxt, regRowid, 1);
1416 VdbeCoverage(pParse->pVdbe);
1417 }else{
1418 u16 nEq = pLoop->u.btree.nEq;
1419 int r1;
1420 char *zStartAff;
1421
1422 assert( pLoop->wsFlags & WHERE_INDEXED );
drhdc56dc92021-12-11 17:10:58 +00001423 assert( (pLoop->wsFlags & WHERE_COLUMN_IN)==0 );
drh35685d32021-12-05 00:45:55 +00001424 r1 = codeAllEqualityTerms(pParse,pLevel,0,0,&zStartAff);
1425 codeApplyAffinity(pParse, r1, nEq, zStartAff);
1426 sqlite3DbFree(pParse->db, zStartAff);
1427 sqlite3VdbeAddOp4Int(pParse->pVdbe, OP_Filter, pLevel->regFilter,
1428 addrNxt, r1, nEq);
1429 VdbeCoverage(pParse->pVdbe);
1430 }
drh6ae49e62021-12-05 20:19:47 +00001431 pLevel->regFilter = 0;
drh35685d32021-12-05 00:45:55 +00001432 }
1433}
drh35685d32021-12-05 00:45:55 +00001434
drhb531aa82019-03-01 18:07:05 +00001435/*
drh6f82e852015-06-06 20:12:09 +00001436** Generate code for the start of the iLevel-th loop in the WHERE clause
1437** implementation described by pWInfo.
1438*/
1439Bitmask sqlite3WhereCodeOneLoopStart(
drh47df8a22018-12-25 00:15:37 +00001440 Parse *pParse, /* Parsing context */
1441 Vdbe *v, /* Prepared statement under construction */
drh6f82e852015-06-06 20:12:09 +00001442 WhereInfo *pWInfo, /* Complete information about the WHERE clause */
1443 int iLevel, /* Which level of pWInfo->a[] should be coded */
drh47df8a22018-12-25 00:15:37 +00001444 WhereLevel *pLevel, /* The current level pointer */
drh6f82e852015-06-06 20:12:09 +00001445 Bitmask notReady /* Which tables are currently available */
1446){
1447 int j, k; /* Loop counters */
1448 int iCur; /* The VDBE cursor for the table */
1449 int addrNxt; /* Where to jump to continue with the next IN case */
drh6f82e852015-06-06 20:12:09 +00001450 int bRev; /* True if we need to scan in reverse order */
drh6f82e852015-06-06 20:12:09 +00001451 WhereLoop *pLoop; /* The WhereLoop object being coded */
1452 WhereClause *pWC; /* Decomposition of the entire WHERE clause */
1453 WhereTerm *pTerm; /* A WHERE clause term */
drh6f82e852015-06-06 20:12:09 +00001454 sqlite3 *db; /* Database connection */
drh76012942021-02-21 21:04:54 +00001455 SrcItem *pTabItem; /* FROM clause term being coded */
drh6f82e852015-06-06 20:12:09 +00001456 int addrBrk; /* Jump here to break out of the loop */
drh3a3b4202017-02-15 22:36:15 +00001457 int addrHalt; /* addrBrk for the outermost loop */
drh6f82e852015-06-06 20:12:09 +00001458 int addrCont; /* Jump here to continue with next cycle */
1459 int iRowidReg = 0; /* Rowid is stored in this register, if not zero */
1460 int iReleaseReg = 0; /* Temp register to free before returning */
dan6f654a42017-04-28 19:59:55 +00001461 Index *pIdx = 0; /* Index used by loop (if any) */
danebc63012017-07-10 14:33:00 +00001462 int iLoop; /* Iteration of constraint generator loop */
drh6f82e852015-06-06 20:12:09 +00001463
drh6f82e852015-06-06 20:12:09 +00001464 pWC = &pWInfo->sWC;
1465 db = pParse->db;
drh6f82e852015-06-06 20:12:09 +00001466 pLoop = pLevel->pWLoop;
1467 pTabItem = &pWInfo->pTabList->a[pLevel->iFrom];
1468 iCur = pTabItem->iCursor;
1469 pLevel->notReady = notReady & ~sqlite3WhereGetMask(&pWInfo->sMaskSet, iCur);
1470 bRev = (pWInfo->revMask>>iLevel)&1;
drh6f82e852015-06-06 20:12:09 +00001471 VdbeModuleComment((v, "Begin WHERE-loop%d: %s",iLevel,pTabItem->pTab->zName));
drh118efd12019-12-28 14:07:22 +00001472#if WHERETRACE_ENABLED /* 0x20800 */
1473 if( sqlite3WhereTrace & 0x800 ){
drha4b2df52019-12-28 16:20:23 +00001474 sqlite3DebugPrintf("Coding level %d of %d: notReady=%llx iFrom=%d\n",
1475 iLevel, pWInfo->nLevel, (u64)notReady, pLevel->iFrom);
drh118efd12019-12-28 14:07:22 +00001476 sqlite3WhereLoopPrint(pLoop, pWC);
1477 }
1478 if( sqlite3WhereTrace & 0x20000 ){
drhf1bb31e2019-12-28 14:33:26 +00001479 if( iLevel==0 ){
1480 sqlite3DebugPrintf("WHERE clause being coded:\n");
1481 sqlite3TreeViewExpr(0, pWInfo->pWhere, 0);
1482 }
1483 sqlite3DebugPrintf("All WHERE-clause terms before coding:\n");
drh118efd12019-12-28 14:07:22 +00001484 sqlite3WhereClausePrint(pWC);
1485 }
1486#endif
drh6f82e852015-06-06 20:12:09 +00001487
1488 /* Create labels for the "break" and "continue" instructions
1489 ** for the current loop. Jump to addrBrk to break out of a loop.
1490 ** Jump to cont to go immediately to the next iteration of the
1491 ** loop.
1492 **
1493 ** When there is an IN operator, we also have a "addrNxt" label that
1494 ** means to continue with the next IN value combination. When
1495 ** there are no IN operators in the constraints, the "addrNxt" label
1496 ** is the same as "addrBrk".
1497 */
drhec4ccdb2018-12-29 02:26:59 +00001498 addrBrk = pLevel->addrBrk = pLevel->addrNxt = sqlite3VdbeMakeLabel(pParse);
1499 addrCont = pLevel->addrCont = sqlite3VdbeMakeLabel(pParse);
drh6f82e852015-06-06 20:12:09 +00001500
1501 /* If this is the right table of a LEFT OUTER JOIN, allocate and
1502 ** initialize a memory cell that records if this table matches any
1503 ** row of the left table of the join.
1504 */
dan820fcd22018-04-24 18:53:24 +00001505 assert( (pWInfo->wctrlFlags & WHERE_OR_SUBCLAUSE)
1506 || pLevel->iFrom>0 || (pTabItem[0].fg.jointype & JT_LEFT)==0
1507 );
drh8a48b9c2015-08-19 15:20:00 +00001508 if( pLevel->iFrom>0 && (pTabItem[0].fg.jointype & JT_LEFT)!=0 ){
drh6f82e852015-06-06 20:12:09 +00001509 pLevel->iLeftJoin = ++pParse->nMem;
1510 sqlite3VdbeAddOp2(v, OP_Integer, 0, pLevel->iLeftJoin);
1511 VdbeComment((v, "init LEFT JOIN no-match flag"));
1512 }
1513
drh3a3b4202017-02-15 22:36:15 +00001514 /* Compute a safe address to jump to if we discover that the table for
1515 ** this loop is empty and can never contribute content. */
1516 for(j=iLevel; j>0 && pWInfo->a[j].iLeftJoin==0; j--){}
1517 addrHalt = pWInfo->a[j].addrBrk;
1518
drh6f82e852015-06-06 20:12:09 +00001519 /* Special case of a FROM clause subquery implemented as a co-routine */
drh8a48b9c2015-08-19 15:20:00 +00001520 if( pTabItem->fg.viaCoroutine ){
drh6f82e852015-06-06 20:12:09 +00001521 int regYield = pTabItem->regReturn;
1522 sqlite3VdbeAddOp3(v, OP_InitCoroutine, regYield, 0, pTabItem->addrFillSub);
1523 pLevel->p2 = sqlite3VdbeAddOp2(v, OP_Yield, regYield, addrBrk);
1524 VdbeCoverage(v);
drhfef37762018-07-10 19:48:35 +00001525 VdbeComment((v, "next row of %s", pTabItem->pTab->zName));
drh6f82e852015-06-06 20:12:09 +00001526 pLevel->op = OP_Goto;
1527 }else
1528
1529#ifndef SQLITE_OMIT_VIRTUALTABLE
1530 if( (pLoop->wsFlags & WHERE_VIRTUALTABLE)!=0 ){
1531 /* Case 1: The table is a virtual-table. Use the VFilter and VNext
1532 ** to access the data.
1533 */
1534 int iReg; /* P3 Value for OP_VFilter */
1535 int addrNotFound;
1536 int nConstraint = pLoop->nLTerm;
1537
drh6f82e852015-06-06 20:12:09 +00001538 iReg = sqlite3GetTempRange(pParse, nConstraint+2);
1539 addrNotFound = pLevel->addrBrk;
1540 for(j=0; j<nConstraint; j++){
1541 int iTarget = iReg+j+2;
1542 pTerm = pLoop->aLTerm[j];
drh599d5762016-03-08 01:11:51 +00001543 if( NEVER(pTerm==0) ) continue;
drh6f82e852015-06-06 20:12:09 +00001544 if( pTerm->eOperator & WO_IN ){
drh0fe7e7d2022-02-01 14:58:29 +00001545 if( SMASKBIT32(j) & pLoop->u.vtab.mHandleIn ){
1546 int iTab = pParse->nTab++;
1547 int iCache = ++pParse->nMem;
1548 sqlite3CodeRhsOfIN(pParse, pTerm->pExpr, iTab);
1549 sqlite3VdbeAddOp3(v, OP_VInitIn, iTab, iTarget, iCache);
1550 }else{
1551 codeEqualityTerm(pParse, pTerm, pLevel, j, bRev, iTarget);
1552 addrNotFound = pLevel->addrNxt;
1553 }
drh6f82e852015-06-06 20:12:09 +00001554 }else{
dan6256c1c2016-08-08 20:15:41 +00001555 Expr *pRight = pTerm->pExpr->pRight;
drhfc7f27b2016-08-20 00:07:01 +00001556 codeExprOrVector(pParse, pRight, iTarget, 1);
drh8f2c0b52022-01-27 21:18:14 +00001557 if( pTerm->eMatchOp==SQLITE_INDEX_CONSTRAINT_OFFSET
1558 && pLoop->u.vtab.bOmitOffset
1559 ){
1560 assert( pTerm->eOperator==WO_AUX );
1561 assert( pWInfo->pLimit!=0 );
1562 assert( pWInfo->pLimit->iOffset>0 );
1563 sqlite3VdbeAddOp2(v, OP_Integer, 0, pWInfo->pLimit->iOffset);
1564 VdbeComment((v,"Zero OFFSET counter"));
1565 }
drh6f82e852015-06-06 20:12:09 +00001566 }
1567 }
1568 sqlite3VdbeAddOp2(v, OP_Integer, pLoop->u.vtab.idxNum, iReg);
1569 sqlite3VdbeAddOp2(v, OP_Integer, nConstraint, iReg+1);
1570 sqlite3VdbeAddOp4(v, OP_VFilter, iCur, addrNotFound, iReg,
1571 pLoop->u.vtab.idxStr,
drh861b1302016-12-07 20:22:31 +00001572 pLoop->u.vtab.needFree ? P4_DYNAMIC : P4_STATIC);
drh6f82e852015-06-06 20:12:09 +00001573 VdbeCoverage(v);
1574 pLoop->u.vtab.needFree = 0;
drhbc2e9512020-09-17 11:32:14 +00001575 /* An OOM inside of AddOp4(OP_VFilter) instruction above might have freed
1576 ** the u.vtab.idxStr. NULL it out to prevent a use-after-free */
1577 if( db->mallocFailed ) pLoop->u.vtab.idxStr = 0;
drh6f82e852015-06-06 20:12:09 +00001578 pLevel->p1 = iCur;
dan354474a2015-09-29 10:11:26 +00001579 pLevel->op = pWInfo->eOnePass ? OP_Noop : OP_VNext;
drh6f82e852015-06-06 20:12:09 +00001580 pLevel->p2 = sqlite3VdbeCurrentAddr(v);
drh04756292021-10-14 19:28:28 +00001581 assert( (pLoop->wsFlags & WHERE_MULTI_OR)==0 );
drh6d6ea422022-03-07 14:51:29 +00001582
1583 for(j=0; j<nConstraint; j++){
drhdbc49162016-03-02 03:28:07 +00001584 pTerm = pLoop->aLTerm[j];
1585 if( j<16 && (pLoop->u.vtab.omitMask>>j)&1 ){
1586 disableTerm(pLevel, pTerm);
drh6d6ea422022-03-07 14:51:29 +00001587 continue;
1588 }
1589 if( (pTerm->eOperator & WO_IN)!=0
1590 && (SMASKBIT32(j) & pLoop->u.vtab.mHandleIn)==0
1591 && !db->mallocFailed
1592 ){
drhdbc49162016-03-02 03:28:07 +00001593 Expr *pCompare; /* The comparison operator */
1594 Expr *pRight; /* RHS of the comparison */
1595 VdbeOp *pOp; /* Opcode to access the value of the IN constraint */
drh6d6ea422022-03-07 14:51:29 +00001596 int iIn; /* IN loop corresponding to the j-th constraint */
drhdbc49162016-03-02 03:28:07 +00001597
1598 /* Reload the constraint value into reg[iReg+j+2]. The same value
1599 ** was loaded into the same register prior to the OP_VFilter, but
1600 ** the xFilter implementation might have changed the datatype or
drh6d6ea422022-03-07 14:51:29 +00001601 ** encoding of the value in the register, so it *must* be reloaded.
1602 */
1603 for(iIn=0; ALWAYS(iIn<pLevel->u.in.nIn); iIn++){
drh68748ec2019-10-14 20:32:31 +00001604 pOp = sqlite3VdbeGetOp(v, pLevel->u.in.aInLoop[iIn].addrInTop);
drh6d6ea422022-03-07 14:51:29 +00001605 if( (pOp->opcode==OP_Column && pOp->p3==iReg+j+2)
1606 || (pOp->opcode==OP_Rowid && pOp->p2==iReg+j+2)
1607 ){
1608 testcase( pOp->opcode==OP_Rowid );
1609 sqlite3VdbeAddOp3(v, pOp->opcode, pOp->p1, pOp->p2, pOp->p3);
1610 break;
1611 }
drhdbc49162016-03-02 03:28:07 +00001612 }
1613
1614 /* Generate code that will continue to the next row if
drh6d6ea422022-03-07 14:51:29 +00001615 ** the IN constraint is not satisfied
1616 */
drhabfd35e2016-12-06 22:47:23 +00001617 pCompare = sqlite3PExpr(pParse, TK_EQ, 0, 0);
drh6d6ea422022-03-07 14:51:29 +00001618 if( !db->mallocFailed ){
1619 int iFld = pTerm->u.x.iField;
1620 Expr *pLeft = pTerm->pExpr->pLeft;
1621 assert( pLeft!=0 );
1622 if( iFld>0 ){
1623 assert( pLeft->op==TK_VECTOR );
1624 assert( ExprUseXList(pLeft) );
1625 assert( iFld<=pLeft->x.pList->nExpr );
1626 pCompare->pLeft = pLeft->x.pList->a[iFld-1].pExpr;
1627 }else{
1628 pCompare->pLeft = pLeft;
1629 }
drhdbc49162016-03-02 03:28:07 +00001630 pCompare->pRight = pRight = sqlite3Expr(db, TK_REGISTER, 0);
drh237b2b72016-03-07 19:08:27 +00001631 if( pRight ){
1632 pRight->iTable = iReg+j+2;
dand03f77a2020-01-29 15:03:01 +00001633 sqlite3ExprIfFalse(
1634 pParse, pCompare, pLevel->addrCont, SQLITE_JUMPIFNULL
1635 );
drh237b2b72016-03-07 19:08:27 +00001636 }
drhdbc49162016-03-02 03:28:07 +00001637 pCompare->pLeft = 0;
drhdbc49162016-03-02 03:28:07 +00001638 }
drh6d6ea422022-03-07 14:51:29 +00001639 sqlite3ExprDelete(db, pCompare);
drhdbc49162016-03-02 03:28:07 +00001640 }
1641 }
drh6d6ea422022-03-07 14:51:29 +00001642
drhba26faa2016-04-09 18:04:28 +00001643 /* These registers need to be preserved in case there is an IN operator
1644 ** loop. So we could deallocate the registers here (and potentially
1645 ** reuse them later) if (pLoop->wsFlags & WHERE_IN_ABLE)==0. But it seems
1646 ** simpler and safer to simply not reuse the registers.
1647 **
1648 ** sqlite3ReleaseTempRange(pParse, iReg, nConstraint+2);
1649 */
drh6f82e852015-06-06 20:12:09 +00001650 }else
1651#endif /* SQLITE_OMIT_VIRTUALTABLE */
1652
1653 if( (pLoop->wsFlags & WHERE_IPK)!=0
1654 && (pLoop->wsFlags & (WHERE_COLUMN_IN|WHERE_COLUMN_EQ))!=0
1655 ){
1656 /* Case 2: We can directly reference a single row using an
1657 ** equality comparison against the ROWID field. Or
1658 ** we reference multiple rows using a "rowid IN (...)"
1659 ** construct.
1660 */
1661 assert( pLoop->u.btree.nEq==1 );
1662 pTerm = pLoop->aLTerm[0];
1663 assert( pTerm!=0 );
1664 assert( pTerm->pExpr!=0 );
drh6f82e852015-06-06 20:12:09 +00001665 testcase( pTerm->wtFlags & TERM_VIRTUAL );
1666 iReleaseReg = ++pParse->nMem;
1667 iRowidReg = codeEqualityTerm(pParse, pTerm, pLevel, 0, bRev, iReleaseReg);
1668 if( iRowidReg!=iReleaseReg ) sqlite3ReleaseTempReg(pParse, iReleaseReg);
1669 addrNxt = pLevel->addrNxt;
drh2db144c2021-12-01 16:31:02 +00001670 if( pLevel->regFilter ){
1671 sqlite3VdbeAddOp4Int(v, OP_Filter, pLevel->regFilter, addrNxt,
1672 iRowidReg, 1);
drh067c60c2021-12-04 18:45:08 +00001673 VdbeCoverage(v);
drh35685d32021-12-05 00:45:55 +00001674 filterPullDown(pParse, pWInfo, iLevel, addrNxt, notReady);
drh2db144c2021-12-01 16:31:02 +00001675 }
drheeb95652016-05-26 20:56:38 +00001676 sqlite3VdbeAddOp3(v, OP_SeekRowid, iCur, addrNxt, iRowidReg);
drh6f82e852015-06-06 20:12:09 +00001677 VdbeCoverage(v);
drh6f82e852015-06-06 20:12:09 +00001678 pLevel->op = OP_Noop;
1679 }else if( (pLoop->wsFlags & WHERE_IPK)!=0
1680 && (pLoop->wsFlags & WHERE_COLUMN_RANGE)!=0
1681 ){
1682 /* Case 3: We have an inequality comparison against the ROWID field.
1683 */
1684 int testOp = OP_Noop;
1685 int start;
1686 int memEndValue = 0;
1687 WhereTerm *pStart, *pEnd;
1688
drh6f82e852015-06-06 20:12:09 +00001689 j = 0;
1690 pStart = pEnd = 0;
1691 if( pLoop->wsFlags & WHERE_BTM_LIMIT ) pStart = pLoop->aLTerm[j++];
1692 if( pLoop->wsFlags & WHERE_TOP_LIMIT ) pEnd = pLoop->aLTerm[j++];
1693 assert( pStart!=0 || pEnd!=0 );
1694 if( bRev ){
1695 pTerm = pStart;
1696 pStart = pEnd;
1697 pEnd = pTerm;
1698 }
danb324cf72016-06-17 14:33:32 +00001699 codeCursorHint(pTabItem, pWInfo, pLevel, pEnd);
drh6f82e852015-06-06 20:12:09 +00001700 if( pStart ){
1701 Expr *pX; /* The expression that defines the start bound */
1702 int r1, rTemp; /* Registers for holding the start boundary */
dan19ff12d2016-07-29 20:58:19 +00001703 int op; /* Cursor seek operation */
drh6f82e852015-06-06 20:12:09 +00001704
1705 /* The following constant maps TK_xx codes into corresponding
1706 ** seek opcodes. It depends on a particular ordering of TK_xx
1707 */
1708 const u8 aMoveOp[] = {
1709 /* TK_GT */ OP_SeekGT,
1710 /* TK_LE */ OP_SeekLE,
1711 /* TK_LT */ OP_SeekLT,
1712 /* TK_GE */ OP_SeekGE
1713 };
1714 assert( TK_LE==TK_GT+1 ); /* Make sure the ordering.. */
1715 assert( TK_LT==TK_GT+2 ); /* ... of the TK_xx values... */
1716 assert( TK_GE==TK_GT+3 ); /* ... is correcct. */
1717
1718 assert( (pStart->wtFlags & TERM_VNULL)==0 );
1719 testcase( pStart->wtFlags & TERM_VIRTUAL );
1720 pX = pStart->pExpr;
1721 assert( pX!=0 );
1722 testcase( pStart->leftCursor!=iCur ); /* transitive constraints */
dan625015e2016-07-30 16:39:28 +00001723 if( sqlite3ExprIsVector(pX->pRight) ){
dan19ff12d2016-07-29 20:58:19 +00001724 r1 = rTemp = sqlite3GetTempReg(pParse);
1725 codeExprOrVector(pParse, pX->pRight, r1, 1);
drh4d1c6842018-02-13 18:48:08 +00001726 testcase( pX->op==TK_GT );
1727 testcase( pX->op==TK_GE );
1728 testcase( pX->op==TK_LT );
1729 testcase( pX->op==TK_LE );
1730 op = aMoveOp[((pX->op - TK_GT - 1) & 0x3) | 0x1];
1731 assert( pX->op!=TK_GT || op==OP_SeekGE );
1732 assert( pX->op!=TK_GE || op==OP_SeekGE );
1733 assert( pX->op!=TK_LT || op==OP_SeekLE );
1734 assert( pX->op!=TK_LE || op==OP_SeekLE );
dan19ff12d2016-07-29 20:58:19 +00001735 }else{
1736 r1 = sqlite3ExprCodeTemp(pParse, pX->pRight, &rTemp);
1737 disableTerm(pLevel, pStart);
1738 op = aMoveOp[(pX->op - TK_GT)];
1739 }
1740 sqlite3VdbeAddOp3(v, op, iCur, addrBrk, r1);
drh6f82e852015-06-06 20:12:09 +00001741 VdbeComment((v, "pk"));
1742 VdbeCoverageIf(v, pX->op==TK_GT);
1743 VdbeCoverageIf(v, pX->op==TK_LE);
1744 VdbeCoverageIf(v, pX->op==TK_LT);
1745 VdbeCoverageIf(v, pX->op==TK_GE);
drh6f82e852015-06-06 20:12:09 +00001746 sqlite3ReleaseTempReg(pParse, rTemp);
drh6f82e852015-06-06 20:12:09 +00001747 }else{
drh3a3b4202017-02-15 22:36:15 +00001748 sqlite3VdbeAddOp2(v, bRev ? OP_Last : OP_Rewind, iCur, addrHalt);
drh6f82e852015-06-06 20:12:09 +00001749 VdbeCoverageIf(v, bRev==0);
1750 VdbeCoverageIf(v, bRev!=0);
1751 }
1752 if( pEnd ){
1753 Expr *pX;
1754 pX = pEnd->pExpr;
1755 assert( pX!=0 );
1756 assert( (pEnd->wtFlags & TERM_VNULL)==0 );
1757 testcase( pEnd->leftCursor!=iCur ); /* Transitive constraints */
1758 testcase( pEnd->wtFlags & TERM_VIRTUAL );
1759 memEndValue = ++pParse->nMem;
dan19ff12d2016-07-29 20:58:19 +00001760 codeExprOrVector(pParse, pX->pRight, memEndValue, 1);
dan625015e2016-07-30 16:39:28 +00001761 if( 0==sqlite3ExprIsVector(pX->pRight)
1762 && (pX->op==TK_LT || pX->op==TK_GT)
1763 ){
drh6f82e852015-06-06 20:12:09 +00001764 testOp = bRev ? OP_Le : OP_Ge;
1765 }else{
1766 testOp = bRev ? OP_Lt : OP_Gt;
1767 }
dan553168c2016-08-01 20:14:31 +00001768 if( 0==sqlite3ExprIsVector(pX->pRight) ){
1769 disableTerm(pLevel, pEnd);
1770 }
drh6f82e852015-06-06 20:12:09 +00001771 }
1772 start = sqlite3VdbeCurrentAddr(v);
1773 pLevel->op = bRev ? OP_Prev : OP_Next;
1774 pLevel->p1 = iCur;
1775 pLevel->p2 = start;
1776 assert( pLevel->p5==0 );
1777 if( testOp!=OP_Noop ){
1778 iRowidReg = ++pParse->nMem;
1779 sqlite3VdbeAddOp2(v, OP_Rowid, iCur, iRowidReg);
drh6f82e852015-06-06 20:12:09 +00001780 sqlite3VdbeAddOp3(v, testOp, memEndValue, addrBrk, iRowidReg);
1781 VdbeCoverageIf(v, testOp==OP_Le);
1782 VdbeCoverageIf(v, testOp==OP_Lt);
1783 VdbeCoverageIf(v, testOp==OP_Ge);
1784 VdbeCoverageIf(v, testOp==OP_Gt);
1785 sqlite3VdbeChangeP5(v, SQLITE_AFF_NUMERIC | SQLITE_JUMPIFNULL);
1786 }
1787 }else if( pLoop->wsFlags & WHERE_INDEXED ){
1788 /* Case 4: A scan using an index.
1789 **
1790 ** The WHERE clause may contain zero or more equality
1791 ** terms ("==" or "IN" operators) that refer to the N
1792 ** left-most columns of the index. It may also contain
1793 ** inequality constraints (>, <, >= or <=) on the indexed
1794 ** column that immediately follows the N equalities. Only
1795 ** the right-most column can be an inequality - the rest must
1796 ** use the "==" and "IN" operators. For example, if the
1797 ** index is on (x,y,z), then the following clauses are all
1798 ** optimized:
1799 **
1800 ** x=5
1801 ** x=5 AND y=10
1802 ** x=5 AND y<10
1803 ** x=5 AND y>5 AND y<10
1804 ** x=5 AND y=5 AND z<=10
1805 **
1806 ** The z<10 term of the following cannot be used, only
1807 ** the x=5 term:
1808 **
1809 ** x=5 AND z<10
1810 **
1811 ** N may be zero if there are inequality constraints.
1812 ** If there are no inequality constraints, then N is at
1813 ** least one.
1814 **
1815 ** This case is also used when there are no WHERE clause
1816 ** constraints but an index is selected anyway, in order
1817 ** to force the output order to conform to an ORDER BY.
1818 */
1819 static const u8 aStartOp[] = {
1820 0,
1821 0,
1822 OP_Rewind, /* 2: (!start_constraints && startEq && !bRev) */
1823 OP_Last, /* 3: (!start_constraints && startEq && bRev) */
1824 OP_SeekGT, /* 4: (start_constraints && !startEq && !bRev) */
1825 OP_SeekLT, /* 5: (start_constraints && !startEq && bRev) */
1826 OP_SeekGE, /* 6: (start_constraints && startEq && !bRev) */
1827 OP_SeekLE /* 7: (start_constraints && startEq && bRev) */
1828 };
1829 static const u8 aEndOp[] = {
1830 OP_IdxGE, /* 0: (end_constraints && !bRev && !endEq) */
1831 OP_IdxGT, /* 1: (end_constraints && !bRev && endEq) */
1832 OP_IdxLE, /* 2: (end_constraints && bRev && !endEq) */
1833 OP_IdxLT, /* 3: (end_constraints && bRev && endEq) */
1834 };
1835 u16 nEq = pLoop->u.btree.nEq; /* Number of == or IN terms */
dan71c57db2016-07-09 20:23:55 +00001836 u16 nBtm = pLoop->u.btree.nBtm; /* Length of BTM vector */
1837 u16 nTop = pLoop->u.btree.nTop; /* Length of TOP vector */
drh6f82e852015-06-06 20:12:09 +00001838 int regBase; /* Base register holding constraint values */
1839 WhereTerm *pRangeStart = 0; /* Inequality constraint at range start */
1840 WhereTerm *pRangeEnd = 0; /* Inequality constraint at range end */
1841 int startEq; /* True if range start uses ==, >= or <= */
1842 int endEq; /* True if range end uses ==, >= or <= */
1843 int start_constraints; /* Start of range is constrained */
1844 int nConstraint; /* Number of constraint terms */
drh6f82e852015-06-06 20:12:09 +00001845 int iIdxCur; /* The VDBE cursor for the index */
1846 int nExtraReg = 0; /* Number of extra registers needed */
1847 int op; /* Instruction opcode */
1848 char *zStartAff; /* Affinity for start of range constraint */
danb7ca2172016-08-26 17:54:46 +00001849 char *zEndAff = 0; /* Affinity for end of range constraint */
drh6f82e852015-06-06 20:12:09 +00001850 u8 bSeekPastNull = 0; /* True to seek past initial nulls */
1851 u8 bStopAtNull = 0; /* Add condition to terminate at NULLs */
drh47df8a22018-12-25 00:15:37 +00001852 int omitTable; /* True if we use the index only */
drh74e1b862019-08-23 13:08:49 +00001853 int regBignull = 0; /* big-null flag register */
drh04e70ce2020-10-02 11:55:07 +00001854 int addrSeekScan = 0; /* Opcode of the OP_SeekScan, if any */
drh6f82e852015-06-06 20:12:09 +00001855
1856 pIdx = pLoop->u.btree.pIndex;
1857 iIdxCur = pLevel->iIdxCur;
1858 assert( nEq>=pLoop->nSkip );
1859
drh6f82e852015-06-06 20:12:09 +00001860 /* Find any inequality constraint terms for the start and end
1861 ** of the range.
1862 */
1863 j = nEq;
1864 if( pLoop->wsFlags & WHERE_BTM_LIMIT ){
1865 pRangeStart = pLoop->aLTerm[j++];
dan71c57db2016-07-09 20:23:55 +00001866 nExtraReg = MAX(nExtraReg, pLoop->u.btree.nBtm);
drh6f82e852015-06-06 20:12:09 +00001867 /* Like optimization range constraints always occur in pairs */
1868 assert( (pRangeStart->wtFlags & TERM_LIKEOPT)==0 ||
1869 (pLoop->wsFlags & WHERE_TOP_LIMIT)!=0 );
1870 }
1871 if( pLoop->wsFlags & WHERE_TOP_LIMIT ){
1872 pRangeEnd = pLoop->aLTerm[j++];
dan71c57db2016-07-09 20:23:55 +00001873 nExtraReg = MAX(nExtraReg, pLoop->u.btree.nTop);
drh41d2e662015-12-01 21:23:07 +00001874#ifndef SQLITE_LIKE_DOESNT_MATCH_BLOBS
drh6f82e852015-06-06 20:12:09 +00001875 if( (pRangeEnd->wtFlags & TERM_LIKEOPT)!=0 ){
1876 assert( pRangeStart!=0 ); /* LIKE opt constraints */
1877 assert( pRangeStart->wtFlags & TERM_LIKEOPT ); /* occur in pairs */
drh44aebff2016-05-02 10:25:42 +00001878 pLevel->iLikeRepCntr = (u32)++pParse->nMem;
1879 sqlite3VdbeAddOp2(v, OP_Integer, 1, (int)pLevel->iLikeRepCntr);
drh6f82e852015-06-06 20:12:09 +00001880 VdbeComment((v, "LIKE loop counter"));
1881 pLevel->addrLikeRep = sqlite3VdbeCurrentAddr(v);
drh44aebff2016-05-02 10:25:42 +00001882 /* iLikeRepCntr actually stores 2x the counter register number. The
1883 ** bottom bit indicates whether the search order is ASC or DESC. */
1884 testcase( bRev );
1885 testcase( pIdx->aSortOrder[nEq]==SQLITE_SO_DESC );
1886 assert( (bRev & ~1)==0 );
1887 pLevel->iLikeRepCntr <<=1;
1888 pLevel->iLikeRepCntr |= bRev ^ (pIdx->aSortOrder[nEq]==SQLITE_SO_DESC);
drh6f82e852015-06-06 20:12:09 +00001889 }
drh41d2e662015-12-01 21:23:07 +00001890#endif
drh48590fc2016-10-10 13:29:15 +00001891 if( pRangeStart==0 ){
1892 j = pIdx->aiColumn[nEq];
1893 if( (j>=0 && pIdx->pTable->aCol[j].notNull==0) || j==XN_EXPR ){
1894 bSeekPastNull = 1;
1895 }
drh6f82e852015-06-06 20:12:09 +00001896 }
1897 }
1898 assert( pRangeEnd==0 || (pRangeEnd->wtFlags & TERM_VNULL)==0 );
1899
dan15750a22019-08-16 21:07:19 +00001900 /* If the WHERE_BIGNULL_SORT flag is set, then index column nEq uses
1901 ** a non-default "big-null" sort (either ASC NULLS LAST or DESC NULLS
1902 ** FIRST). In both cases separate ordered scans are made of those
1903 ** index entries for which the column is null and for those for which
1904 ** it is not. For an ASC sort, the non-NULL entries are scanned first.
1905 ** For DESC, NULL entries are scanned first.
1906 */
dan15750a22019-08-16 21:07:19 +00001907 if( (pLoop->wsFlags & (WHERE_TOP_LIMIT|WHERE_BTM_LIMIT))==0
1908 && (pLoop->wsFlags & WHERE_BIGNULL_SORT)!=0
1909 ){
1910 assert( bSeekPastNull==0 && nExtraReg==0 && nBtm==0 && nTop==0 );
1911 assert( pRangeEnd==0 && pRangeStart==0 );
dan4adb1d02019-12-28 18:08:39 +00001912 testcase( pLoop->nSkip>0 );
dan15750a22019-08-16 21:07:19 +00001913 nExtraReg = 1;
1914 bSeekPastNull = 1;
1915 pLevel->regBignull = regBignull = ++pParse->nMem;
drh7f05d522020-03-02 01:16:33 +00001916 if( pLevel->iLeftJoin ){
1917 sqlite3VdbeAddOp2(v, OP_Integer, 0, regBignull);
1918 }
dancc491f42019-08-17 17:55:54 +00001919 pLevel->addrBignull = sqlite3VdbeMakeLabel(pParse);
dan15750a22019-08-16 21:07:19 +00001920 }
1921
drh6f82e852015-06-06 20:12:09 +00001922 /* If we are doing a reverse order scan on an ascending index, or
1923 ** a forward order scan on a descending index, interchange the
1924 ** start and end terms (pRangeStart and pRangeEnd).
1925 */
drh7ffb16b2021-05-12 22:15:44 +00001926 if( (nEq<pIdx->nColumn && bRev==(pIdx->aSortOrder[nEq]==SQLITE_SO_ASC)) ){
drh6f82e852015-06-06 20:12:09 +00001927 SWAP(WhereTerm *, pRangeEnd, pRangeStart);
1928 SWAP(u8, bSeekPastNull, bStopAtNull);
dan71c57db2016-07-09 20:23:55 +00001929 SWAP(u8, nBtm, nTop);
drh6f82e852015-06-06 20:12:09 +00001930 }
1931
dandf1b52e2021-01-27 17:15:06 +00001932 if( iLevel>0 && (pLoop->wsFlags & WHERE_IN_SEEKSCAN)!=0 ){
1933 /* In case OP_SeekScan is used, ensure that the index cursor does not
1934 ** point to a valid row for the first iteration of this loop. */
1935 sqlite3VdbeAddOp1(v, OP_NullRow, iIdxCur);
1936 }
1937
drhbcf40a72015-08-18 15:58:05 +00001938 /* Generate code to evaluate all constraint terms using == or IN
1939 ** and store the values of those terms in an array of registers
1940 ** starting at regBase.
1941 */
danb324cf72016-06-17 14:33:32 +00001942 codeCursorHint(pTabItem, pWInfo, pLevel, pRangeEnd);
drhbcf40a72015-08-18 15:58:05 +00001943 regBase = codeAllEqualityTerms(pParse,pLevel,bRev,nExtraReg,&zStartAff);
1944 assert( zStartAff==0 || sqlite3Strlen30(zStartAff)>=nEq );
danb7ca2172016-08-26 17:54:46 +00001945 if( zStartAff && nTop ){
1946 zEndAff = sqlite3DbStrDup(db, &zStartAff[nEq]);
1947 }
dancc491f42019-08-17 17:55:54 +00001948 addrNxt = (regBignull ? pLevel->addrBignull : pLevel->addrNxt);
drhbcf40a72015-08-18 15:58:05 +00001949
drh6f82e852015-06-06 20:12:09 +00001950 testcase( pRangeStart && (pRangeStart->eOperator & WO_LE)!=0 );
1951 testcase( pRangeStart && (pRangeStart->eOperator & WO_GE)!=0 );
1952 testcase( pRangeEnd && (pRangeEnd->eOperator & WO_LE)!=0 );
1953 testcase( pRangeEnd && (pRangeEnd->eOperator & WO_GE)!=0 );
1954 startEq = !pRangeStart || pRangeStart->eOperator & (WO_LE|WO_GE);
1955 endEq = !pRangeEnd || pRangeEnd->eOperator & (WO_LE|WO_GE);
1956 start_constraints = pRangeStart || nEq>0;
1957
1958 /* Seek the index cursor to the start of the range. */
1959 nConstraint = nEq;
1960 if( pRangeStart ){
1961 Expr *pRight = pRangeStart->pExpr->pRight;
dan71c57db2016-07-09 20:23:55 +00001962 codeExprOrVector(pParse, pRight, regBase+nEq, nBtm);
drh6f82e852015-06-06 20:12:09 +00001963 whereLikeOptimizationStringFixup(v, pLevel, pRangeStart);
drh395a60d2020-09-30 17:32:22 +00001964 if( (pRangeStart->wtFlags & TERM_VNULL)==0
drh6f82e852015-06-06 20:12:09 +00001965 && sqlite3ExprCanBeNull(pRight)
1966 ){
1967 sqlite3VdbeAddOp2(v, OP_IsNull, regBase+nEq, addrNxt);
1968 VdbeCoverage(v);
1969 }
1970 if( zStartAff ){
drhe3c6b612016-10-05 20:10:32 +00001971 updateRangeAffinityStr(pRight, nBtm, &zStartAff[nEq]);
drh6f82e852015-06-06 20:12:09 +00001972 }
dan71c57db2016-07-09 20:23:55 +00001973 nConstraint += nBtm;
drh6f82e852015-06-06 20:12:09 +00001974 testcase( pRangeStart->wtFlags & TERM_VIRTUAL );
dan625015e2016-07-30 16:39:28 +00001975 if( sqlite3ExprIsVector(pRight)==0 ){
dan71c57db2016-07-09 20:23:55 +00001976 disableTerm(pLevel, pRangeStart);
1977 }else{
1978 startEq = 1;
1979 }
drh426f4ab2016-07-26 04:31:14 +00001980 bSeekPastNull = 0;
drh6f82e852015-06-06 20:12:09 +00001981 }else if( bSeekPastNull ){
drh6f82e852015-06-06 20:12:09 +00001982 startEq = 0;
drh0086e072019-08-23 16:12:20 +00001983 sqlite3VdbeAddOp2(v, OP_Null, 0, regBase+nEq);
drh6f82e852015-06-06 20:12:09 +00001984 start_constraints = 1;
drh0086e072019-08-23 16:12:20 +00001985 nConstraint++;
dan15750a22019-08-16 21:07:19 +00001986 }else if( regBignull ){
1987 sqlite3VdbeAddOp2(v, OP_Null, 0, regBase+nEq);
1988 start_constraints = 1;
1989 nConstraint++;
drh6f82e852015-06-06 20:12:09 +00001990 }
1991 codeApplyAffinity(pParse, regBase, nConstraint - bSeekPastNull, zStartAff);
drh0bf2ad62016-02-22 21:19:54 +00001992 if( pLoop->nSkip>0 && nConstraint==pLoop->nSkip ){
1993 /* The skip-scan logic inside the call to codeAllEqualityConstraints()
1994 ** above has already left the cursor sitting on the correct row,
1995 ** so no further seeking is needed */
1996 }else{
dan15750a22019-08-16 21:07:19 +00001997 if( regBignull ){
drhec3dda52019-08-23 13:32:03 +00001998 sqlite3VdbeAddOp2(v, OP_Integer, 1, regBignull);
drha31d3552019-08-23 17:09:02 +00001999 VdbeComment((v, "NULL-scan pass ctr"));
dan15750a22019-08-16 21:07:19 +00002000 }
drh2db144c2021-12-01 16:31:02 +00002001 if( pLevel->regFilter ){
2002 sqlite3VdbeAddOp4Int(v, OP_Filter, pLevel->regFilter, addrNxt,
drh770dade2021-12-04 14:24:30 +00002003 regBase, nEq);
drh067c60c2021-12-04 18:45:08 +00002004 VdbeCoverage(v);
drh35685d32021-12-05 00:45:55 +00002005 filterPullDown(pParse, pWInfo, iLevel, addrNxt, notReady);
drh2db144c2021-12-01 16:31:02 +00002006 }
dan15750a22019-08-16 21:07:19 +00002007
drha6d2f8e2016-02-22 20:52:26 +00002008 op = aStartOp[(start_constraints<<2) + (startEq<<1) + bRev];
2009 assert( op!=0 );
drh7d14ffe2020-10-02 13:48:57 +00002010 if( (pLoop->wsFlags & WHERE_IN_SEEKSCAN)!=0 && op==OP_SeekGE ){
drh68cf0ac2020-09-28 19:51:54 +00002011 assert( regBignull==0 );
drh4f65b3b2020-09-30 18:03:22 +00002012 /* TUNING: The OP_SeekScan opcode seeks to reduce the number
2013 ** of expensive seek operations by replacing a single seek with
2014 ** 1 or more step operations. The question is, how many steps
2015 ** should we try before giving up and going with a seek. The cost
2016 ** of a seek is proportional to the logarithm of the of the number
2017 ** of entries in the tree, so basing the number of steps to try
2018 ** on the estimated number of rows in the btree seems like a good
2019 ** guess. */
drh04e70ce2020-10-02 11:55:07 +00002020 addrSeekScan = sqlite3VdbeAddOp1(v, OP_SeekScan,
2021 (pIdx->aiRowLogEst[0]+9)/10);
drh4f65b3b2020-09-30 18:03:22 +00002022 VdbeCoverage(v);
drh68cf0ac2020-09-28 19:51:54 +00002023 }
drha6d2f8e2016-02-22 20:52:26 +00002024 sqlite3VdbeAddOp4Int(v, op, iIdxCur, addrNxt, regBase, nConstraint);
2025 VdbeCoverage(v);
2026 VdbeCoverageIf(v, op==OP_Rewind); testcase( op==OP_Rewind );
2027 VdbeCoverageIf(v, op==OP_Last); testcase( op==OP_Last );
2028 VdbeCoverageIf(v, op==OP_SeekGT); testcase( op==OP_SeekGT );
2029 VdbeCoverageIf(v, op==OP_SeekGE); testcase( op==OP_SeekGE );
2030 VdbeCoverageIf(v, op==OP_SeekLE); testcase( op==OP_SeekLE );
2031 VdbeCoverageIf(v, op==OP_SeekLT); testcase( op==OP_SeekLT );
danddd74212019-08-02 18:43:59 +00002032
drh0086e072019-08-23 16:12:20 +00002033 assert( bSeekPastNull==0 || bStopAtNull==0 );
dan15750a22019-08-16 21:07:19 +00002034 if( regBignull ){
drh0086e072019-08-23 16:12:20 +00002035 assert( bSeekPastNull==1 || bStopAtNull==1 );
drh5f6a4ea2019-08-23 17:00:22 +00002036 assert( bSeekPastNull==!bStopAtNull );
drh0086e072019-08-23 16:12:20 +00002037 assert( bStopAtNull==startEq );
danddd74212019-08-02 18:43:59 +00002038 sqlite3VdbeAddOp2(v, OP_Goto, 0, sqlite3VdbeCurrentAddr(v)+2);
drh0086e072019-08-23 16:12:20 +00002039 op = aStartOp[(nConstraint>1)*4 + 2 + bRev];
2040 sqlite3VdbeAddOp4Int(v, op, iIdxCur, addrNxt, regBase,
2041 nConstraint-startEq);
2042 VdbeCoverage(v);
2043 VdbeCoverageIf(v, op==OP_Rewind); testcase( op==OP_Rewind );
2044 VdbeCoverageIf(v, op==OP_Last); testcase( op==OP_Last );
2045 VdbeCoverageIf(v, op==OP_SeekGE); testcase( op==OP_SeekGE );
2046 VdbeCoverageIf(v, op==OP_SeekLE); testcase( op==OP_SeekLE );
2047 assert( op==OP_Rewind || op==OP_Last || op==OP_SeekGE || op==OP_SeekLE);
danddd74212019-08-02 18:43:59 +00002048 }
drha6d2f8e2016-02-22 20:52:26 +00002049 }
drh0bf2ad62016-02-22 21:19:54 +00002050
drh6f82e852015-06-06 20:12:09 +00002051 /* Load the value for the inequality constraint at the end of the
2052 ** range (if any).
2053 */
2054 nConstraint = nEq;
drh5d742e32021-11-02 20:52:20 +00002055 assert( pLevel->p2==0 );
drh6f82e852015-06-06 20:12:09 +00002056 if( pRangeEnd ){
2057 Expr *pRight = pRangeEnd->pExpr->pRight;
drh5d742e32021-11-02 20:52:20 +00002058 if( addrSeekScan ){
2059 /* For a seek-scan that has a range on the lowest term of the index,
2060 ** we have to make the top of the loop be code that sets the end
2061 ** condition of the range. Otherwise, the OP_SeekScan might jump
2062 ** over that initialization, leaving the range-end value set to the
2063 ** range-start value, resulting in a wrong answer.
2064 ** See ticket 5981a8c041a3c2f3 (2021-11-02).
2065 */
2066 pLevel->p2 = sqlite3VdbeCurrentAddr(v);
2067 }
dan71c57db2016-07-09 20:23:55 +00002068 codeExprOrVector(pParse, pRight, regBase+nEq, nTop);
drh6f82e852015-06-06 20:12:09 +00002069 whereLikeOptimizationStringFixup(v, pLevel, pRangeEnd);
drh395a60d2020-09-30 17:32:22 +00002070 if( (pRangeEnd->wtFlags & TERM_VNULL)==0
drh6f82e852015-06-06 20:12:09 +00002071 && sqlite3ExprCanBeNull(pRight)
2072 ){
2073 sqlite3VdbeAddOp2(v, OP_IsNull, regBase+nEq, addrNxt);
2074 VdbeCoverage(v);
2075 }
drh0c36fca2016-08-26 18:17:08 +00002076 if( zEndAff ){
drhe3c6b612016-10-05 20:10:32 +00002077 updateRangeAffinityStr(pRight, nTop, zEndAff);
drh0c36fca2016-08-26 18:17:08 +00002078 codeApplyAffinity(pParse, regBase+nEq, nTop, zEndAff);
2079 }else{
2080 assert( pParse->db->mallocFailed );
2081 }
dan71c57db2016-07-09 20:23:55 +00002082 nConstraint += nTop;
drh6f82e852015-06-06 20:12:09 +00002083 testcase( pRangeEnd->wtFlags & TERM_VIRTUAL );
dan71c57db2016-07-09 20:23:55 +00002084
dan625015e2016-07-30 16:39:28 +00002085 if( sqlite3ExprIsVector(pRight)==0 ){
dan71c57db2016-07-09 20:23:55 +00002086 disableTerm(pLevel, pRangeEnd);
2087 }else{
2088 endEq = 1;
2089 }
drh6f82e852015-06-06 20:12:09 +00002090 }else if( bStopAtNull ){
dan15750a22019-08-16 21:07:19 +00002091 if( regBignull==0 ){
2092 sqlite3VdbeAddOp2(v, OP_Null, 0, regBase+nEq);
2093 endEq = 0;
2094 }
drh6f82e852015-06-06 20:12:09 +00002095 nConstraint++;
2096 }
2097 sqlite3DbFree(db, zStartAff);
danb7ca2172016-08-26 17:54:46 +00002098 sqlite3DbFree(db, zEndAff);
drh6f82e852015-06-06 20:12:09 +00002099
2100 /* Top of the loop body */
drh5d742e32021-11-02 20:52:20 +00002101 if( pLevel->p2==0 ) pLevel->p2 = sqlite3VdbeCurrentAddr(v);
drh6f82e852015-06-06 20:12:09 +00002102
2103 /* Check if the index cursor is past the end of the range. */
2104 if( nConstraint ){
dan15750a22019-08-16 21:07:19 +00002105 if( regBignull ){
drh5f6a4ea2019-08-23 17:00:22 +00002106 /* Except, skip the end-of-range check while doing the NULL-scan */
drhec3dda52019-08-23 13:32:03 +00002107 sqlite3VdbeAddOp2(v, OP_IfNot, regBignull, sqlite3VdbeCurrentAddr(v)+3);
drha31d3552019-08-23 17:09:02 +00002108 VdbeComment((v, "If NULL-scan 2nd pass"));
drh505ae9d2019-08-22 21:13:56 +00002109 VdbeCoverage(v);
dan15750a22019-08-16 21:07:19 +00002110 }
drh6f82e852015-06-06 20:12:09 +00002111 op = aEndOp[bRev*2 + endEq];
2112 sqlite3VdbeAddOp4Int(v, op, iIdxCur, addrNxt, regBase, nConstraint);
2113 testcase( op==OP_IdxGT ); VdbeCoverageIf(v, op==OP_IdxGT );
2114 testcase( op==OP_IdxGE ); VdbeCoverageIf(v, op==OP_IdxGE );
2115 testcase( op==OP_IdxLT ); VdbeCoverageIf(v, op==OP_IdxLT );
2116 testcase( op==OP_IdxLE ); VdbeCoverageIf(v, op==OP_IdxLE );
drh04e70ce2020-10-02 11:55:07 +00002117 if( addrSeekScan ) sqlite3VdbeJumpHere(v, addrSeekScan);
drh6f82e852015-06-06 20:12:09 +00002118 }
dan15750a22019-08-16 21:07:19 +00002119 if( regBignull ){
drh5f6a4ea2019-08-23 17:00:22 +00002120 /* During a NULL-scan, check to see if we have reached the end of
2121 ** the NULLs */
2122 assert( bSeekPastNull==!bStopAtNull );
2123 assert( bSeekPastNull+bStopAtNull==1 );
2124 assert( nConstraint+bSeekPastNull>0 );
drhec3dda52019-08-23 13:32:03 +00002125 sqlite3VdbeAddOp2(v, OP_If, regBignull, sqlite3VdbeCurrentAddr(v)+2);
drha31d3552019-08-23 17:09:02 +00002126 VdbeComment((v, "If NULL-scan 1st pass"));
drh505ae9d2019-08-22 21:13:56 +00002127 VdbeCoverage(v);
drh5f6a4ea2019-08-23 17:00:22 +00002128 op = aEndOp[bRev*2 + bSeekPastNull];
2129 sqlite3VdbeAddOp4Int(v, op, iIdxCur, addrNxt, regBase,
2130 nConstraint+bSeekPastNull);
2131 testcase( op==OP_IdxGT ); VdbeCoverageIf(v, op==OP_IdxGT );
2132 testcase( op==OP_IdxGE ); VdbeCoverageIf(v, op==OP_IdxGE );
2133 testcase( op==OP_IdxLT ); VdbeCoverageIf(v, op==OP_IdxLT );
2134 testcase( op==OP_IdxLE ); VdbeCoverageIf(v, op==OP_IdxLE );
dan15750a22019-08-16 21:07:19 +00002135 }
drh6f82e852015-06-06 20:12:09 +00002136
drhf761d932020-09-29 01:48:46 +00002137 if( (pLoop->wsFlags & WHERE_IN_EARLYOUT)!=0 ){
drhfa17e132020-09-01 01:52:03 +00002138 sqlite3VdbeAddOp3(v, OP_SeekHit, iIdxCur, nEq, nEq);
drh8c2b6d72018-06-05 20:45:20 +00002139 }
2140
drh6f82e852015-06-06 20:12:09 +00002141 /* Seek the table cursor, if required */
drh47df8a22018-12-25 00:15:37 +00002142 omitTable = (pLoop->wsFlags & WHERE_IDX_ONLY)!=0
2143 && (pWInfo->wctrlFlags & WHERE_OR_SUBCLAUSE)==0;
drh6f82e852015-06-06 20:12:09 +00002144 if( omitTable ){
2145 /* pIdx is a covering index. No need to access the main table. */
2146 }else if( HasRowid(pIdx->pTable) ){
drh68c0c712020-08-14 20:04:26 +00002147 codeDeferredSeek(pWInfo, pIdx, iCur, iIdxCur);
drh6f82e852015-06-06 20:12:09 +00002148 }else if( iCur!=iIdxCur ){
2149 Index *pPk = sqlite3PrimaryKeyIndex(pIdx->pTable);
2150 iRowidReg = sqlite3GetTempRange(pParse, pPk->nKeyCol);
2151 for(j=0; j<pPk->nKeyCol; j++){
drhb9bcf7c2019-10-19 13:29:10 +00002152 k = sqlite3TableColumnToIndex(pIdx, pPk->aiColumn[j]);
drh6f82e852015-06-06 20:12:09 +00002153 sqlite3VdbeAddOp3(v, OP_Column, iIdxCur, k, iRowidReg+j);
2154 }
2155 sqlite3VdbeAddOp4Int(v, OP_NotFound, iCur, addrCont,
2156 iRowidReg, pPk->nKeyCol); VdbeCoverage(v);
2157 }
2158
drhdb535392019-11-03 00:07:41 +00002159 if( pLevel->iLeftJoin==0 ){
2160 /* If pIdx is an index on one or more expressions, then look through
2161 ** all the expressions in pWInfo and try to transform matching expressions
2162 ** into reference to index columns. Also attempt to translate references
2163 ** to virtual columns in the table into references to (stored) columns
2164 ** of the index.
2165 **
2166 ** Do not do this for the RHS of a LEFT JOIN. This is because the
2167 ** expression may be evaluated after OP_NullRow has been executed on
2168 ** the cursor. In this case it is important to do the full evaluation,
2169 ** as the result of the expression may not be NULL, even if all table
2170 ** column values are. https://www.sqlite.org/src/info/7fa8049685b50b5a
2171 **
2172 ** Also, do not do this when processing one index an a multi-index
2173 ** OR clause, since the transformation will become invalid once we
2174 ** move forward to the next index.
2175 ** https://sqlite.org/src/info/4e8e4857d32d401f
2176 */
2177 if( (pWInfo->wctrlFlags & WHERE_OR_SUBCLAUSE)==0 ){
2178 whereIndexExprTrans(pIdx, iCur, iIdxCur, pWInfo);
2179 }
2180
2181 /* If a partial index is driving the loop, try to eliminate WHERE clause
2182 ** terms from the query that must be true due to the WHERE clause of
2183 ** the partial index.
2184 **
2185 ** 2019-11-02 ticket 623eff57e76d45f6: This optimization does not work
2186 ** for a LEFT JOIN.
2187 */
2188 if( pIdx->pPartIdxWhere ){
2189 whereApplyPartialIndexConstraints(pIdx->pPartIdxWhere, iCur, pWC);
2190 }
2191 }else{
drhdb535392019-11-03 00:07:41 +00002192 testcase( pIdx->pPartIdxWhere );
drh06fc2452019-11-04 12:49:15 +00002193 /* The following assert() is not a requirement, merely an observation:
2194 ** The OR-optimization doesn't work for the right hand table of
2195 ** a LEFT JOIN: */
2196 assert( (pWInfo->wctrlFlags & WHERE_OR_SUBCLAUSE)==0 );
dan4da04f72018-04-24 14:05:14 +00002197 }
drhdb535392019-11-03 00:07:41 +00002198
dan71c57db2016-07-09 20:23:55 +00002199 /* Record the instruction used to terminate the loop. */
drh6f82e852015-06-06 20:12:09 +00002200 if( pLoop->wsFlags & WHERE_ONEROW ){
2201 pLevel->op = OP_Noop;
2202 }else if( bRev ){
2203 pLevel->op = OP_Prev;
2204 }else{
2205 pLevel->op = OP_Next;
2206 }
2207 pLevel->p1 = iIdxCur;
2208 pLevel->p3 = (pLoop->wsFlags&WHERE_UNQ_WANTED)!=0 ? 1:0;
2209 if( (pLoop->wsFlags & WHERE_CONSTRAINT)==0 ){
2210 pLevel->p5 = SQLITE_STMTSTATUS_FULLSCAN_STEP;
2211 }else{
2212 assert( pLevel->p5==0 );
2213 }
dan6f654a42017-04-28 19:59:55 +00002214 if( omitTable ) pIdx = 0;
drh6f82e852015-06-06 20:12:09 +00002215 }else
2216
2217#ifndef SQLITE_OMIT_OR_OPTIMIZATION
2218 if( pLoop->wsFlags & WHERE_MULTI_OR ){
2219 /* Case 5: Two or more separately indexed terms connected by OR
2220 **
2221 ** Example:
2222 **
2223 ** CREATE TABLE t1(a,b,c,d);
2224 ** CREATE INDEX i1 ON t1(a);
2225 ** CREATE INDEX i2 ON t1(b);
2226 ** CREATE INDEX i3 ON t1(c);
2227 **
2228 ** SELECT * FROM t1 WHERE a=5 OR b=7 OR (c=11 AND d=13)
2229 **
2230 ** In the example, there are three indexed terms connected by OR.
2231 ** The top of the loop looks like this:
2232 **
2233 ** Null 1 # Zero the rowset in reg 1
2234 **
2235 ** Then, for each indexed term, the following. The arguments to
2236 ** RowSetTest are such that the rowid of the current row is inserted
2237 ** into the RowSet. If it is already present, control skips the
2238 ** Gosub opcode and jumps straight to the code generated by WhereEnd().
2239 **
2240 ** sqlite3WhereBegin(<term>)
2241 ** RowSetTest # Insert rowid into rowset
2242 ** Gosub 2 A
2243 ** sqlite3WhereEnd()
2244 **
2245 ** Following the above, code to terminate the loop. Label A, the target
2246 ** of the Gosub above, jumps to the instruction right after the Goto.
2247 **
2248 ** Null 1 # Zero the rowset in reg 1
2249 ** Goto B # The loop is finished.
2250 **
2251 ** A: <loop body> # Return data, whatever.
2252 **
2253 ** Return 2 # Jump back to the Gosub
2254 **
2255 ** B: <after the loop>
2256 **
2257 ** Added 2014-05-26: If the table is a WITHOUT ROWID table, then
2258 ** use an ephemeral index instead of a RowSet to record the primary
2259 ** keys of the rows we have already seen.
2260 **
2261 */
2262 WhereClause *pOrWc; /* The OR-clause broken out into subterms */
2263 SrcList *pOrTab; /* Shortened table list or OR-clause generation */
2264 Index *pCov = 0; /* Potential covering index (or NULL) */
2265 int iCovCur = pParse->nTab++; /* Cursor used for index scans (if any) */
2266
2267 int regReturn = ++pParse->nMem; /* Register used with OP_Gosub */
2268 int regRowset = 0; /* Register for RowSet object */
2269 int regRowid = 0; /* Register holding rowid */
drhec4ccdb2018-12-29 02:26:59 +00002270 int iLoopBody = sqlite3VdbeMakeLabel(pParse);/* Start of loop body */
drh6f82e852015-06-06 20:12:09 +00002271 int iRetInit; /* Address of regReturn init */
2272 int untestedTerms = 0; /* Some terms not completely tested */
2273 int ii; /* Loop counter */
drh6f82e852015-06-06 20:12:09 +00002274 Expr *pAndExpr = 0; /* An ".. AND (...)" expression */
2275 Table *pTab = pTabItem->pTab;
dan145b4ea2016-07-29 18:12:12 +00002276
drh6f82e852015-06-06 20:12:09 +00002277 pTerm = pLoop->aLTerm[0];
2278 assert( pTerm!=0 );
2279 assert( pTerm->eOperator & WO_OR );
2280 assert( (pTerm->wtFlags & TERM_ORINFO)!=0 );
2281 pOrWc = &pTerm->u.pOrInfo->wc;
2282 pLevel->op = OP_Return;
2283 pLevel->p1 = regReturn;
2284
2285 /* Set up a new SrcList in pOrTab containing the table being scanned
2286 ** by this loop in the a[0] slot and all notReady tables in a[1..] slots.
2287 ** This becomes the SrcList in the recursive call to sqlite3WhereBegin().
2288 */
2289 if( pWInfo->nLevel>1 ){
2290 int nNotReady; /* The number of notReady tables */
drh76012942021-02-21 21:04:54 +00002291 SrcItem *origSrc; /* Original list of tables */
drh6f82e852015-06-06 20:12:09 +00002292 nNotReady = pWInfo->nLevel - iLevel - 1;
2293 pOrTab = sqlite3StackAllocRaw(db,
2294 sizeof(*pOrTab)+ nNotReady*sizeof(pOrTab->a[0]));
2295 if( pOrTab==0 ) return notReady;
2296 pOrTab->nAlloc = (u8)(nNotReady + 1);
2297 pOrTab->nSrc = pOrTab->nAlloc;
2298 memcpy(pOrTab->a, pTabItem, sizeof(*pTabItem));
2299 origSrc = pWInfo->pTabList->a;
2300 for(k=1; k<=nNotReady; k++){
2301 memcpy(&pOrTab->a[k], &origSrc[pLevel[k].iFrom], sizeof(pOrTab->a[k]));
2302 }
2303 }else{
2304 pOrTab = pWInfo->pTabList;
2305 }
2306
2307 /* Initialize the rowset register to contain NULL. An SQL NULL is
2308 ** equivalent to an empty rowset. Or, create an ephemeral index
2309 ** capable of holding primary keys in the case of a WITHOUT ROWID.
2310 **
2311 ** Also initialize regReturn to contain the address of the instruction
2312 ** immediately following the OP_Return at the bottom of the loop. This
2313 ** is required in a few obscure LEFT JOIN cases where control jumps
2314 ** over the top of the loop into the body of it. In this case the
2315 ** correct response for the end-of-loop code (the OP_Return) is to
2316 ** fall through to the next instruction, just as an OP_Next does if
2317 ** called on an uninitialized cursor.
2318 */
2319 if( (pWInfo->wctrlFlags & WHERE_DUPLICATES_OK)==0 ){
2320 if( HasRowid(pTab) ){
2321 regRowset = ++pParse->nMem;
2322 sqlite3VdbeAddOp2(v, OP_Null, 0, regRowset);
2323 }else{
2324 Index *pPk = sqlite3PrimaryKeyIndex(pTab);
2325 regRowset = pParse->nTab++;
2326 sqlite3VdbeAddOp2(v, OP_OpenEphemeral, regRowset, pPk->nKeyCol);
2327 sqlite3VdbeSetP4KeyInfo(pParse, pPk);
2328 }
2329 regRowid = ++pParse->nMem;
2330 }
2331 iRetInit = sqlite3VdbeAddOp2(v, OP_Integer, 0, regReturn);
2332
2333 /* If the original WHERE clause is z of the form: (x1 OR x2 OR ...) AND y
drh02e3e042022-02-04 13:05:29 +00002334 ** Then for every term xN, evaluate as the subexpression: xN AND y
drh6f82e852015-06-06 20:12:09 +00002335 ** That way, terms in y that are factored into the disjunction will
2336 ** be picked up by the recursive calls to sqlite3WhereBegin() below.
2337 **
2338 ** Actually, each subexpression is converted to "xN AND w" where w is
2339 ** the "interesting" terms of z - terms that did not originate in the
2340 ** ON or USING clause of a LEFT JOIN, and terms that are usable as
2341 ** indices.
2342 **
2343 ** This optimization also only applies if the (x1 OR x2 OR ...) term
2344 ** is not contained in the ON clause of a LEFT JOIN.
2345 ** See ticket http://www.sqlite.org/src/info/f2369304e4
drh02e3e042022-02-04 13:05:29 +00002346 **
2347 ** 2022-02-04: Do not push down slices of a row-value comparison.
2348 ** In other words, "w" or "y" may not be a slice of a vector. Otherwise,
2349 ** the initialization of the right-hand operand of the vector comparison
2350 ** might not occur, or might occur only in an OR branch that is not
2351 ** taken. dbsqlfuzz 80a9fade844b4fb43564efc972bcb2c68270f5d1.
drhc9bcc5a2022-03-03 15:59:22 +00002352 **
2353 ** 2022-03-03: Do not push down expressions that involve subqueries.
2354 ** The subquery might get coded as a subroutine. Any table-references
2355 ** in the subquery might be resolved to index-references for the index on
2356 ** the OR branch in which the subroutine is coded. But if the subroutine
2357 ** is invoked from a different OR branch that uses a different index, such
2358 ** index-references will not work. tag-20220303a
2359 ** https://sqlite.org/forum/forumpost/36937b197273d403
drh6f82e852015-06-06 20:12:09 +00002360 */
2361 if( pWC->nTerm>1 ){
2362 int iTerm;
2363 for(iTerm=0; iTerm<pWC->nTerm; iTerm++){
2364 Expr *pExpr = pWC->a[iTerm].pExpr;
2365 if( &pWC->a[iTerm] == pTerm ) continue;
drh3b83f0c2016-01-29 16:57:06 +00002366 testcase( pWC->a[iTerm].wtFlags & TERM_VIRTUAL );
2367 testcase( pWC->a[iTerm].wtFlags & TERM_CODED );
drh02e3e042022-02-04 13:05:29 +00002368 testcase( pWC->a[iTerm].wtFlags & TERM_SLICE );
2369 if( (pWC->a[iTerm].wtFlags & (TERM_VIRTUAL|TERM_CODED|TERM_SLICE))!=0 ){
2370 continue;
2371 }
drh07559b22022-03-03 19:40:21 +00002372 if( (pWC->a[iTerm].eOperator & WO_ALL)==0 ) continue;
drhc9bcc5a2022-03-03 15:59:22 +00002373 if( ExprHasProperty(pExpr, EP_Subquery) ) continue; /* tag-20220303a */
drh6f82e852015-06-06 20:12:09 +00002374 pExpr = sqlite3ExprDup(db, pExpr, 0);
drhd5c851c2019-04-19 13:38:34 +00002375 pAndExpr = sqlite3ExprAnd(pParse, pAndExpr, pExpr);
drh6f82e852015-06-06 20:12:09 +00002376 }
2377 if( pAndExpr ){
drhf1722ba2019-04-05 20:56:46 +00002378 /* The extra 0x10000 bit on the opcode is masked off and does not
2379 ** become part of the new Expr.op. However, it does make the
2380 ** op==TK_AND comparison inside of sqlite3PExpr() false, and this
drh93ffb502021-05-18 19:10:10 +00002381 ** prevents sqlite3PExpr() from applying the AND short-circuit
drhf1722ba2019-04-05 20:56:46 +00002382 ** optimization, which we do not want here. */
2383 pAndExpr = sqlite3PExpr(pParse, TK_AND|0x10000, 0, pAndExpr);
drh6f82e852015-06-06 20:12:09 +00002384 }
2385 }
2386
2387 /* Run a separate WHERE clause for each term of the OR clause. After
2388 ** eliminating duplicates from other WHERE clauses, the action for each
2389 ** sub-WHERE clause is to to invoke the main loop body as a subroutine.
2390 */
drh5d72d922018-05-04 00:39:43 +00002391 ExplainQueryPlan((pParse, 1, "MULTI-INDEX OR"));
drh6f82e852015-06-06 20:12:09 +00002392 for(ii=0; ii<pOrWc->nTerm; ii++){
2393 WhereTerm *pOrTerm = &pOrWc->a[ii];
2394 if( pOrTerm->leftCursor==iCur || (pOrTerm->eOperator & WO_AND)!=0 ){
2395 WhereInfo *pSubWInfo; /* Info for single OR-term scan */
2396 Expr *pOrExpr = pOrTerm->pExpr; /* Current OR clause term */
drh93ffb502021-05-18 19:10:10 +00002397 Expr *pDelete; /* Local copy of OR clause term */
drh728e0f92015-10-10 14:41:28 +00002398 int jmp1 = 0; /* Address of jump operation */
drh3b8eb082020-01-12 22:38:17 +00002399 testcase( (pTabItem[0].fg.jointype & JT_LEFT)!=0
2400 && !ExprHasProperty(pOrExpr, EP_FromJoin)
2401 ); /* See TH3 vtab25.400 and ticket 614b25314c766238 */
drh93ffb502021-05-18 19:10:10 +00002402 pDelete = pOrExpr = sqlite3ExprDup(db, pOrExpr, 0);
2403 if( db->mallocFailed ){
2404 sqlite3ExprDelete(db, pDelete);
2405 continue;
2406 }
dan820fcd22018-04-24 18:53:24 +00002407 if( pAndExpr ){
drh6f82e852015-06-06 20:12:09 +00002408 pAndExpr->pLeft = pOrExpr;
2409 pOrExpr = pAndExpr;
2410 }
2411 /* Loop through table entries that match term pOrTerm. */
drhbd462bc2018-12-24 20:21:06 +00002412 ExplainQueryPlan((pParse, 1, "INDEX %d", ii+1));
drh6f82e852015-06-06 20:12:09 +00002413 WHERETRACE(0xffff, ("Subplan for OR-clause:\n"));
drh895bab32022-01-27 16:14:50 +00002414 pSubWInfo = sqlite3WhereBegin(pParse, pOrTab, pOrExpr, 0, 0, 0,
drh68c0c712020-08-14 20:04:26 +00002415 WHERE_OR_SUBCLAUSE, iCovCur);
drh0c7d3d32022-01-24 16:47:12 +00002416 assert( pSubWInfo || pParse->nErr );
drh6f82e852015-06-06 20:12:09 +00002417 if( pSubWInfo ){
2418 WhereLoop *pSubLoop;
2419 int addrExplain = sqlite3WhereExplainOneScan(
drhe2188f02018-05-07 11:37:34 +00002420 pParse, pOrTab, &pSubWInfo->a[0], 0
drh6f82e852015-06-06 20:12:09 +00002421 );
2422 sqlite3WhereAddScanStatus(v, pOrTab, &pSubWInfo->a[0], addrExplain);
2423
2424 /* This is the sub-WHERE clause body. First skip over
2425 ** duplicate rows from prior sub-WHERE clauses, and record the
2426 ** rowid (or PRIMARY KEY) for the current row so that the same
2427 ** row will be skipped in subsequent sub-WHERE clauses.
2428 */
2429 if( (pWInfo->wctrlFlags & WHERE_DUPLICATES_OK)==0 ){
drh6f82e852015-06-06 20:12:09 +00002430 int iSet = ((ii==pOrWc->nTerm-1)?-1:ii);
2431 if( HasRowid(pTab) ){
drh6df9c4b2019-10-18 12:52:08 +00002432 sqlite3ExprCodeGetColumnOfTable(v, pTab, iCur, -1, regRowid);
drh728e0f92015-10-10 14:41:28 +00002433 jmp1 = sqlite3VdbeAddOp4Int(v, OP_RowSetTest, regRowset, 0,
drh8c607192018-08-04 15:53:55 +00002434 regRowid, iSet);
drh6f82e852015-06-06 20:12:09 +00002435 VdbeCoverage(v);
2436 }else{
2437 Index *pPk = sqlite3PrimaryKeyIndex(pTab);
2438 int nPk = pPk->nKeyCol;
2439 int iPk;
drh8c607192018-08-04 15:53:55 +00002440 int r;
drh6f82e852015-06-06 20:12:09 +00002441
2442 /* Read the PK into an array of temp registers. */
2443 r = sqlite3GetTempRange(pParse, nPk);
2444 for(iPk=0; iPk<nPk; iPk++){
2445 int iCol = pPk->aiColumn[iPk];
drh6df9c4b2019-10-18 12:52:08 +00002446 sqlite3ExprCodeGetColumnOfTable(v, pTab, iCur, iCol,r+iPk);
drh6f82e852015-06-06 20:12:09 +00002447 }
2448
2449 /* Check if the temp table already contains this key. If so,
2450 ** the row has already been included in the result set and
2451 ** can be ignored (by jumping past the Gosub below). Otherwise,
2452 ** insert the key into the temp table and proceed with processing
2453 ** the row.
2454 **
2455 ** Use some of the same optimizations as OP_RowSetTest: If iSet
2456 ** is zero, assume that the key cannot already be present in
2457 ** the temp table. And if iSet is -1, assume that there is no
2458 ** need to insert the key into the temp table, as it will never
2459 ** be tested for. */
2460 if( iSet ){
drh728e0f92015-10-10 14:41:28 +00002461 jmp1 = sqlite3VdbeAddOp4Int(v, OP_Found, regRowset, 0, r, nPk);
drh6f82e852015-06-06 20:12:09 +00002462 VdbeCoverage(v);
2463 }
2464 if( iSet>=0 ){
2465 sqlite3VdbeAddOp3(v, OP_MakeRecord, r, nPk, regRowid);
drh9b4eaeb2016-11-09 00:10:33 +00002466 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, regRowset, regRowid,
2467 r, nPk);
drh6f82e852015-06-06 20:12:09 +00002468 if( iSet ) sqlite3VdbeChangeP5(v, OPFLAG_USESEEKRESULT);
2469 }
2470
2471 /* Release the array of temp registers */
2472 sqlite3ReleaseTempRange(pParse, r, nPk);
2473 }
2474 }
2475
2476 /* Invoke the main loop body as a subroutine */
2477 sqlite3VdbeAddOp2(v, OP_Gosub, regReturn, iLoopBody);
2478
2479 /* Jump here (skipping the main loop body subroutine) if the
2480 ** current sub-WHERE row is a duplicate from prior sub-WHEREs. */
drh728e0f92015-10-10 14:41:28 +00002481 if( jmp1 ) sqlite3VdbeJumpHere(v, jmp1);
drh6f82e852015-06-06 20:12:09 +00002482
2483 /* The pSubWInfo->untestedTerms flag means that this OR term
2484 ** contained one or more AND term from a notReady table. The
2485 ** terms from the notReady table could not be tested and will
2486 ** need to be tested later.
2487 */
2488 if( pSubWInfo->untestedTerms ) untestedTerms = 1;
2489
2490 /* If all of the OR-connected terms are optimized using the same
2491 ** index, and the index is opened using the same cursor number
2492 ** by each call to sqlite3WhereBegin() made by this loop, it may
2493 ** be possible to use that index as a covering index.
2494 **
2495 ** If the call to sqlite3WhereBegin() above resulted in a scan that
2496 ** uses an index, and this is either the first OR-connected term
2497 ** processed or the index is the same as that used by all previous
2498 ** terms, set pCov to the candidate covering index. Otherwise, set
2499 ** pCov to NULL to indicate that no candidate covering index will
2500 ** be available.
2501 */
2502 pSubLoop = pSubWInfo->a[0].pWLoop;
2503 assert( (pSubLoop->wsFlags & WHERE_AUTO_INDEX)==0 );
2504 if( (pSubLoop->wsFlags & WHERE_INDEXED)!=0
2505 && (ii==0 || pSubLoop->u.btree.pIndex==pCov)
2506 && (HasRowid(pTab) || !IsPrimaryKeyIndex(pSubLoop->u.btree.pIndex))
2507 ){
2508 assert( pSubWInfo->a[0].iIdxCur==iCovCur );
2509 pCov = pSubLoop->u.btree.pIndex;
drh6f82e852015-06-06 20:12:09 +00002510 }else{
2511 pCov = 0;
2512 }
drh68c0c712020-08-14 20:04:26 +00002513 if( sqlite3WhereUsesDeferredSeek(pSubWInfo) ){
2514 pWInfo->bDeferredSeek = 1;
2515 }
drh6f82e852015-06-06 20:12:09 +00002516
2517 /* Finish the loop through table entries that match term pOrTerm. */
2518 sqlite3WhereEnd(pSubWInfo);
drhbd462bc2018-12-24 20:21:06 +00002519 ExplainQueryPlanPop(pParse);
drh6f82e852015-06-06 20:12:09 +00002520 }
drh93ffb502021-05-18 19:10:10 +00002521 sqlite3ExprDelete(db, pDelete);
drh6f82e852015-06-06 20:12:09 +00002522 }
2523 }
drh5d72d922018-05-04 00:39:43 +00002524 ExplainQueryPlanPop(pParse);
drh04756292021-10-14 19:28:28 +00002525 assert( pLevel->pWLoop==pLoop );
2526 assert( (pLoop->wsFlags & WHERE_MULTI_OR)!=0 );
2527 assert( (pLoop->wsFlags & WHERE_IN_ABLE)==0 );
2528 pLevel->u.pCoveringIdx = pCov;
drh6f82e852015-06-06 20:12:09 +00002529 if( pCov ) pLevel->iIdxCur = iCovCur;
2530 if( pAndExpr ){
2531 pAndExpr->pLeft = 0;
2532 sqlite3ExprDelete(db, pAndExpr);
2533 }
2534 sqlite3VdbeChangeP1(v, iRetInit, sqlite3VdbeCurrentAddr(v));
drh076e85f2015-09-03 13:46:12 +00002535 sqlite3VdbeGoto(v, pLevel->addrBrk);
drh6f82e852015-06-06 20:12:09 +00002536 sqlite3VdbeResolveLabel(v, iLoopBody);
2537
drhe603ab02022-04-07 19:06:31 +00002538 /* Set the P2 operand of the OP_Return opcode that will end the current
2539 ** loop to point to this spot, which is the top of the next containing
2540 ** loop. The byte-code formatter will use that P2 value as a hint to
2541 ** indent everything in between the this point and the final OP_Return.
2542 ** See tag-20220407a in vdbe.c and shell.c */
2543 assert( pLevel->op==OP_Return );
2544 pLevel->p2 = sqlite3VdbeCurrentAddr(v);
2545
drhdd2d9a32019-05-07 17:47:43 +00002546 if( pWInfo->nLevel>1 ){ sqlite3StackFree(db, pOrTab); }
drh6f82e852015-06-06 20:12:09 +00002547 if( !untestedTerms ) disableTerm(pLevel, pTerm);
2548 }else
2549#endif /* SQLITE_OMIT_OR_OPTIMIZATION */
2550
2551 {
2552 /* Case 6: There is no usable index. We must do a complete
2553 ** scan of the entire table.
2554 */
2555 static const u8 aStep[] = { OP_Next, OP_Prev };
2556 static const u8 aStart[] = { OP_Rewind, OP_Last };
2557 assert( bRev==0 || bRev==1 );
drh8a48b9c2015-08-19 15:20:00 +00002558 if( pTabItem->fg.isRecursive ){
drh6f82e852015-06-06 20:12:09 +00002559 /* Tables marked isRecursive have only a single row that is stored in
2560 ** a pseudo-cursor. No need to Rewind or Next such cursors. */
2561 pLevel->op = OP_Noop;
2562 }else{
danb324cf72016-06-17 14:33:32 +00002563 codeCursorHint(pTabItem, pWInfo, pLevel, 0);
drh6f82e852015-06-06 20:12:09 +00002564 pLevel->op = aStep[bRev];
2565 pLevel->p1 = iCur;
drh3a3b4202017-02-15 22:36:15 +00002566 pLevel->p2 = 1 + sqlite3VdbeAddOp2(v, aStart[bRev], iCur, addrHalt);
drh6f82e852015-06-06 20:12:09 +00002567 VdbeCoverageIf(v, bRev==0);
2568 VdbeCoverageIf(v, bRev!=0);
2569 pLevel->p5 = SQLITE_STMTSTATUS_FULLSCAN_STEP;
2570 }
2571 }
2572
2573#ifdef SQLITE_ENABLE_STMT_SCANSTATUS
2574 pLevel->addrVisit = sqlite3VdbeCurrentAddr(v);
2575#endif
2576
2577 /* Insert code to test every subexpression that can be completely
2578 ** computed using the current set of tables.
dan6f654a42017-04-28 19:59:55 +00002579 **
danebc63012017-07-10 14:33:00 +00002580 ** This loop may run between one and three times, depending on the
2581 ** constraints to be generated. The value of stack variable iLoop
2582 ** determines the constraints coded by each iteration, as follows:
2583 **
2584 ** iLoop==1: Code only expressions that are entirely covered by pIdx.
2585 ** iLoop==2: Code remaining expressions that do not contain correlated
2586 ** sub-queries.
2587 ** iLoop==3: Code all remaining expressions.
2588 **
2589 ** An effort is made to skip unnecessary iterations of the loop.
drh6ab3eb52017-04-29 14:56:55 +00002590 */
danebc63012017-07-10 14:33:00 +00002591 iLoop = (pIdx ? 1 : 2);
drh6ab3eb52017-04-29 14:56:55 +00002592 do{
danebc63012017-07-10 14:33:00 +00002593 int iNext = 0; /* Next value for iLoop */
dan6f654a42017-04-28 19:59:55 +00002594 for(pTerm=pWC->a, j=pWC->nTerm; j>0; j--, pTerm++){
2595 Expr *pE;
2596 int skipLikeAddr = 0;
2597 testcase( pTerm->wtFlags & TERM_VIRTUAL );
2598 testcase( pTerm->wtFlags & TERM_CODED );
2599 if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
2600 if( (pTerm->prereqAll & pLevel->notReady)!=0 ){
2601 testcase( pWInfo->untestedTerms==0
2602 && (pWInfo->wctrlFlags & WHERE_OR_SUBCLAUSE)!=0 );
2603 pWInfo->untestedTerms = 1;
2604 continue;
2605 }
2606 pE = pTerm->pExpr;
2607 assert( pE!=0 );
drha76ac882022-04-08 19:20:12 +00002608 if( (pTabItem->fg.jointype & (JT_LEFT|JT_LTORJ))
2609 && !ExprHasProperty(pE,EP_FromJoin)
2610 ){
dan6f654a42017-04-28 19:59:55 +00002611 continue;
2612 }
danebc63012017-07-10 14:33:00 +00002613
dan8674ec52017-07-10 14:39:42 +00002614 if( iLoop==1 && !sqlite3ExprCoveredByIndex(pE, pLevel->iTabCur, pIdx) ){
danebc63012017-07-10 14:33:00 +00002615 iNext = 2;
dan6f654a42017-04-28 19:59:55 +00002616 continue;
2617 }
dand3930b12017-07-10 15:17:30 +00002618 if( iLoop<3 && (pTerm->wtFlags & TERM_VARSELECT) ){
danebc63012017-07-10 14:33:00 +00002619 if( iNext==0 ) iNext = 3;
2620 continue;
2621 }
2622
drh4de33532018-04-02 00:16:36 +00002623 if( (pTerm->wtFlags & TERM_LIKECOND)!=0 ){
dan6f654a42017-04-28 19:59:55 +00002624 /* If the TERM_LIKECOND flag is set, that means that the range search
2625 ** is sufficient to guarantee that the LIKE operator is true, so we
2626 ** can skip the call to the like(A,B) function. But this only works
2627 ** for strings. So do not skip the call to the function on the pass
2628 ** that compares BLOBs. */
drh41d2e662015-12-01 21:23:07 +00002629#ifdef SQLITE_LIKE_DOESNT_MATCH_BLOBS
dan6f654a42017-04-28 19:59:55 +00002630 continue;
drh41d2e662015-12-01 21:23:07 +00002631#else
dan6f654a42017-04-28 19:59:55 +00002632 u32 x = pLevel->iLikeRepCntr;
drh4de33532018-04-02 00:16:36 +00002633 if( x>0 ){
2634 skipLikeAddr = sqlite3VdbeAddOp1(v, (x&1)?OP_IfNot:OP_If,(int)(x>>1));
drh6f883592019-03-30 20:37:04 +00002635 VdbeCoverageIf(v, (x&1)==1);
2636 VdbeCoverageIf(v, (x&1)==0);
drh4de33532018-04-02 00:16:36 +00002637 }
drh41d2e662015-12-01 21:23:07 +00002638#endif
dan6f654a42017-04-28 19:59:55 +00002639 }
drh66a0bf32017-07-10 16:38:14 +00002640#ifdef WHERETRACE_ENABLED /* 0xffff */
2641 if( sqlite3WhereTrace ){
2642 VdbeNoopComment((v, "WhereTerm[%d] (%p) priority=%d",
2643 pWC->nTerm-j, pTerm, iLoop));
2644 }
drh118efd12019-12-28 14:07:22 +00002645 if( sqlite3WhereTrace & 0x800 ){
2646 sqlite3DebugPrintf("Coding auxiliary constraint:\n");
2647 sqlite3WhereTermPrint(pTerm, pWC->nTerm-j);
2648 }
drh66a0bf32017-07-10 16:38:14 +00002649#endif
dan6f654a42017-04-28 19:59:55 +00002650 sqlite3ExprIfFalse(pParse, pE, addrCont, SQLITE_JUMPIFNULL);
2651 if( skipLikeAddr ) sqlite3VdbeJumpHere(v, skipLikeAddr);
2652 pTerm->wtFlags |= TERM_CODED;
drh6f82e852015-06-06 20:12:09 +00002653 }
danebc63012017-07-10 14:33:00 +00002654 iLoop = iNext;
2655 }while( iLoop>0 );
drh6f82e852015-06-06 20:12:09 +00002656
2657 /* Insert code to test for implied constraints based on transitivity
2658 ** of the "==" operator.
2659 **
2660 ** Example: If the WHERE clause contains "t1.a=t2.b" and "t2.b=123"
2661 ** and we are coding the t1 loop and the t2 loop has not yet coded,
2662 ** then we cannot use the "t1.a=t2.b" constraint, but we can code
2663 ** the implied "t1.a=123" constraint.
2664 */
drh132f96f2021-12-08 16:07:22 +00002665 for(pTerm=pWC->a, j=pWC->nBase; j>0; j--, pTerm++){
drhcb43a932016-10-03 01:21:51 +00002666 Expr *pE, sEAlt;
drh6f82e852015-06-06 20:12:09 +00002667 WhereTerm *pAlt;
2668 if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
2669 if( (pTerm->eOperator & (WO_EQ|WO_IS))==0 ) continue;
2670 if( (pTerm->eOperator & WO_EQUIV)==0 ) continue;
2671 if( pTerm->leftCursor!=iCur ) continue;
drha76ac882022-04-08 19:20:12 +00002672 if( pTabItem->fg.jointype & (JT_LEFT|JT_LTORJ) ) continue;
drh6f82e852015-06-06 20:12:09 +00002673 pE = pTerm->pExpr;
drh118efd12019-12-28 14:07:22 +00002674#ifdef WHERETRACE_ENABLED /* 0x800 */
2675 if( sqlite3WhereTrace & 0x800 ){
2676 sqlite3DebugPrintf("Coding transitive constraint:\n");
2677 sqlite3WhereTermPrint(pTerm, pWC->nTerm-j);
2678 }
2679#endif
drhf1bb31e2019-12-28 14:33:26 +00002680 assert( !ExprHasProperty(pE, EP_FromJoin) );
drh6f82e852015-06-06 20:12:09 +00002681 assert( (pTerm->prereqRight & pLevel->notReady)!=0 );
drh220f0d62021-10-15 17:06:16 +00002682 assert( (pTerm->eOperator & (WO_OR|WO_AND))==0 );
drh75fa2662020-09-28 15:49:43 +00002683 pAlt = sqlite3WhereFindTerm(pWC, iCur, pTerm->u.x.leftColumn, notReady,
drh6f82e852015-06-06 20:12:09 +00002684 WO_EQ|WO_IN|WO_IS, 0);
2685 if( pAlt==0 ) continue;
2686 if( pAlt->wtFlags & (TERM_CODED) ) continue;
dana916b572018-01-23 16:38:57 +00002687 if( (pAlt->eOperator & WO_IN)
drha4eeccd2021-10-07 17:43:30 +00002688 && ExprUseXSelect(pAlt->pExpr)
drha599e152018-12-24 14:30:11 +00002689 && (pAlt->pExpr->x.pSelect->pEList->nExpr>1)
dana916b572018-01-23 16:38:57 +00002690 ){
2691 continue;
2692 }
drh6f82e852015-06-06 20:12:09 +00002693 testcase( pAlt->eOperator & WO_EQ );
2694 testcase( pAlt->eOperator & WO_IS );
2695 testcase( pAlt->eOperator & WO_IN );
2696 VdbeModuleComment((v, "begin transitive constraint"));
drhcb43a932016-10-03 01:21:51 +00002697 sEAlt = *pAlt->pExpr;
2698 sEAlt.pLeft = pE->pLeft;
2699 sqlite3ExprIfFalse(pParse, &sEAlt, addrCont, SQLITE_JUMPIFNULL);
dan240e36c2021-04-05 16:20:59 +00002700 pAlt->wtFlags |= TERM_CODED;
drh6f82e852015-06-06 20:12:09 +00002701 }
2702
2703 /* For a LEFT OUTER JOIN, generate code that will record the fact that
2704 ** at least one row of the right table has matched the left table.
2705 */
2706 if( pLevel->iLeftJoin ){
2707 pLevel->addrFirst = sqlite3VdbeCurrentAddr(v);
2708 sqlite3VdbeAddOp2(v, OP_Integer, 1, pLevel->iLeftJoin);
2709 VdbeComment((v, "record LEFT JOIN hit"));
drh132f96f2021-12-08 16:07:22 +00002710 for(pTerm=pWC->a, j=0; j<pWC->nBase; j++, pTerm++){
drh6f82e852015-06-06 20:12:09 +00002711 testcase( pTerm->wtFlags & TERM_VIRTUAL );
2712 testcase( pTerm->wtFlags & TERM_CODED );
2713 if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
2714 if( (pTerm->prereqAll & pLevel->notReady)!=0 ){
2715 assert( pWInfo->untestedTerms );
2716 continue;
2717 }
2718 assert( pTerm->pExpr );
2719 sqlite3ExprIfFalse(pParse, pTerm->pExpr, addrCont, SQLITE_JUMPIFNULL);
2720 pTerm->wtFlags |= TERM_CODED;
2721 }
2722 }
2723
drhc2308ad2022-04-09 03:16:26 +00002724 /* For a RIGHT OUTER JOIN, record the fact that the current row has
2725 ** been matched at least once.
2726 */
2727 if( pLevel->iRJMatch ){
2728 Table *pTab;
2729 int nPk;
2730 int r;
2731 int jmp1 = 0;
2732
2733 pTab = pWInfo->pTabList->a[pLevel->iFrom].pTab;
2734 if( HasRowid(pTab) ){
2735 r = sqlite3GetTempRange(pParse, 2);
2736 sqlite3ExprCodeGetColumnOfTable(v, pTab, pLevel->iTabCur, -1, r+1);
2737 nPk = 1;
2738 }else{
2739 int iPk;
2740 Index *pPk = sqlite3PrimaryKeyIndex(pTab);
2741 nPk = pPk->nKeyCol;
2742 r = sqlite3GetTempRange(pParse, nPk+1);
2743 for(iPk=0; iPk<nPk; iPk++){
2744 int iCol = pPk->aiColumn[iPk];
2745 sqlite3ExprCodeGetColumnOfTable(v, pTab, iCur, iCol,r+1+iPk);
2746 }
2747 }
2748 jmp1 = sqlite3VdbeAddOp4Int(v, OP_Found, pLevel->iRJMatch, 0, r+1, nPk);
2749 VdbeCoverage(v);
2750 sqlite3VdbeAddOp3(v, OP_MakeRecord, r+1, nPk, r);
2751 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, pLevel->iRJMatch, r, r+1, nPk);
2752 sqlite3VdbeChangeP5(v, OPFLAG_USESEEKRESULT);
2753 sqlite3VdbeJumpHere(v, jmp1);
2754
2755 /* Release the array of temp registers */
2756 sqlite3ReleaseTempRange(pParse, r, nPk+1);
2757 }
2758
drh118efd12019-12-28 14:07:22 +00002759#if WHERETRACE_ENABLED /* 0x20800 */
2760 if( sqlite3WhereTrace & 0x20000 ){
drhf1bb31e2019-12-28 14:33:26 +00002761 sqlite3DebugPrintf("All WHERE-clause terms after coding level %d:\n",
2762 iLevel);
drh118efd12019-12-28 14:07:22 +00002763 sqlite3WhereClausePrint(pWC);
2764 }
2765 if( sqlite3WhereTrace & 0x800 ){
2766 sqlite3DebugPrintf("End Coding level %d: notReady=%llx\n",
2767 iLevel, (u64)pLevel->notReady);
2768 }
2769#endif
drh6f82e852015-06-06 20:12:09 +00002770 return pLevel->notReady;
2771}