blob: d1f0635e7acda4b3f0f7761f50317ee7ec7a6cd7 [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 =
643 sqlite3DbReallocOrFree(pParse->db, pLevel->u.in.aInLoop,
644 sizeof(pLevel->u.in.aInLoop[0])*pLevel->u.in.nIn);
645 pIn = pLevel->u.in.aInLoop;
646 if( pIn ){
dan8da209b2016-07-26 18:06:08 +0000647 int iMap = 0; /* Index in aiMap[] */
648 pIn += i;
dan7887d7f2016-08-24 12:22:17 +0000649 for(i=iEq;i<pLoop->nLTerm; i++){
dan8da209b2016-07-26 18:06:08 +0000650 if( pLoop->aLTerm[i]->pExpr==pX ){
danedc35372016-09-16 16:30:57 +0000651 int iOut = iReg + i - iEq;
dan8da209b2016-07-26 18:06:08 +0000652 if( eType==IN_INDEX_ROWID ){
danedc35372016-09-16 16:30:57 +0000653 pIn->addrInTop = sqlite3VdbeAddOp2(v, OP_Rowid, iTab, iOut);
dan8da209b2016-07-26 18:06:08 +0000654 }else{
655 int iCol = aiMap ? aiMap[iMap++] : 0;
dan8da209b2016-07-26 18:06:08 +0000656 pIn->addrInTop = sqlite3VdbeAddOp3(v,OP_Column,iTab, iCol, iOut);
657 }
drh03181c82016-08-18 19:04:57 +0000658 sqlite3VdbeAddOp1(v, OP_IsNull, iOut); VdbeCoverage(v);
dan8da209b2016-07-26 18:06:08 +0000659 if( i==iEq ){
660 pIn->iCur = iTab;
drhf1949b62018-06-07 17:32:59 +0000661 pIn->eEndLoopOp = bRev ? OP_Prev : OP_Next;
dan74ebaad2020-01-04 16:55:57 +0000662 if( iEq>0 ){
drh86d0ea72018-06-05 15:16:25 +0000663 pIn->iBase = iReg - i;
664 pIn->nPrefix = i;
665 }else{
666 pIn->nPrefix = 0;
667 }
dan8da209b2016-07-26 18:06:08 +0000668 }else{
669 pIn->eEndLoopOp = OP_Noop;
670 }
dan7887d7f2016-08-24 12:22:17 +0000671 pIn++;
dan8da209b2016-07-26 18:06:08 +0000672 }
drh6f82e852015-06-06 20:12:09 +0000673 }
drh67306cb2020-10-01 14:36:15 +0000674 testcase( iEq>0
675 && (pLoop->wsFlags & WHERE_IN_SEEKSCAN)==0
676 && (pLoop->wsFlags & WHERE_VIRTUALTABLE)!=0 );
677 if( iEq>0
678 && (pLoop->wsFlags & (WHERE_IN_SEEKSCAN|WHERE_VIRTUALTABLE))==0
679 ){
drhfa17e132020-09-01 01:52:03 +0000680 sqlite3VdbeAddOp3(v, OP_SeekHit, pLevel->iIdxCur, 0, iEq);
681 }
drh6f82e852015-06-06 20:12:09 +0000682 }else{
683 pLevel->u.in.nIn = 0;
684 }
dan8da209b2016-07-26 18:06:08 +0000685 sqlite3DbFree(pParse->db, aiMap);
drh6f82e852015-06-06 20:12:09 +0000686#endif
687 }
drh67656ac2021-05-04 23:21:35 +0000688
689 /* As an optimization, try to disable the WHERE clause term that is
690 ** driving the index as it will always be true. The correct answer is
691 ** obtained regardless, but we might get the answer with fewer CPU cycles
692 ** by omitting the term.
693 **
694 ** But do not disable the term unless we are certain that the term is
695 ** not a transitive constraint. For an example of where that does not
696 ** work, see https://sqlite.org/forum/forumpost/eb8613976a (2021-05-04)
697 */
698 if( (pLevel->pWLoop->wsFlags & WHERE_TRANSCONS)==0
699 || (pTerm->eOperator & WO_EQUIV)==0
700 ){
701 disableTerm(pLevel, pTerm);
702 }
703
drh6f82e852015-06-06 20:12:09 +0000704 return iReg;
705}
706
707/*
708** Generate code that will evaluate all == and IN constraints for an
709** index scan.
710**
711** For example, consider table t1(a,b,c,d,e,f) with index i1(a,b,c).
712** Suppose the WHERE clause is this: a==5 AND b IN (1,2,3) AND c>5 AND c<10
713** The index has as many as three equality constraints, but in this
714** example, the third "c" value is an inequality. So only two
715** constraints are coded. This routine will generate code to evaluate
716** a==5 and b IN (1,2,3). The current values for a and b will be stored
717** in consecutive registers and the index of the first register is returned.
718**
719** In the example above nEq==2. But this subroutine works for any value
720** of nEq including 0. If nEq==0, this routine is nearly a no-op.
721** The only thing it does is allocate the pLevel->iMem memory cell and
722** compute the affinity string.
723**
724** The nExtraReg parameter is 0 or 1. It is 0 if all WHERE clause constraints
725** are == or IN and are covered by the nEq. nExtraReg is 1 if there is
726** an inequality constraint (such as the "c>=5 AND c<10" in the example) that
727** occurs after the nEq quality constraints.
728**
729** This routine allocates a range of nEq+nExtraReg memory cells and returns
730** the index of the first memory cell in that range. The code that
731** calls this routine will use that memory range to store keys for
732** start and termination conditions of the loop.
733** key value of the loop. If one or more IN operators appear, then
734** this routine allocates an additional nEq memory cells for internal
735** use.
736**
737** Before returning, *pzAff is set to point to a buffer containing a
738** copy of the column affinity string of the index allocated using
739** sqlite3DbMalloc(). Except, entries in the copy of the string associated
740** with equality constraints that use BLOB or NONE affinity are set to
741** SQLITE_AFF_BLOB. This is to deal with SQL such as the following:
742**
743** CREATE TABLE t1(a TEXT PRIMARY KEY, b);
744** SELECT ... FROM t1 AS t2, t1 WHERE t1.a = t2.b;
745**
746** In the example above, the index on t1(a) has TEXT affinity. But since
747** the right hand side of the equality constraint (t2.b) has BLOB/NONE affinity,
748** no conversion should be attempted before using a t2.b value as part of
749** a key to search the index. Hence the first byte in the returned affinity
750** string in this example would be set to SQLITE_AFF_BLOB.
751*/
752static int codeAllEqualityTerms(
753 Parse *pParse, /* Parsing context */
754 WhereLevel *pLevel, /* Which nested loop of the FROM we are coding */
755 int bRev, /* Reverse the order of IN operators */
756 int nExtraReg, /* Number of extra registers to allocate */
757 char **pzAff /* OUT: Set to point to affinity string */
758){
759 u16 nEq; /* The number of == or IN constraints to code */
760 u16 nSkip; /* Number of left-most columns to skip */
761 Vdbe *v = pParse->pVdbe; /* The vm under construction */
762 Index *pIdx; /* The index being used for this loop */
763 WhereTerm *pTerm; /* A single constraint term */
764 WhereLoop *pLoop; /* The WhereLoop object */
765 int j; /* Loop counter */
766 int regBase; /* Base register */
767 int nReg; /* Number of registers to allocate */
768 char *zAff; /* Affinity string to return */
769
770 /* This module is only called on query plans that use an index. */
771 pLoop = pLevel->pWLoop;
772 assert( (pLoop->wsFlags & WHERE_VIRTUALTABLE)==0 );
773 nEq = pLoop->u.btree.nEq;
774 nSkip = pLoop->nSkip;
775 pIdx = pLoop->u.btree.pIndex;
776 assert( pIdx!=0 );
777
778 /* Figure out how many memory cells we will need then allocate them.
779 */
780 regBase = pParse->nMem + 1;
781 nReg = pLoop->u.btree.nEq + nExtraReg;
782 pParse->nMem += nReg;
783
drhe9107692015-08-25 19:20:04 +0000784 zAff = sqlite3DbStrDup(pParse->db,sqlite3IndexAffinityStr(pParse->db,pIdx));
drh4df86af2016-02-04 11:48:00 +0000785 assert( zAff!=0 || pParse->db->mallocFailed );
drh6f82e852015-06-06 20:12:09 +0000786
787 if( nSkip ){
788 int iIdxCur = pLevel->iIdxCur;
drh31536302021-04-21 23:13:26 +0000789 sqlite3VdbeAddOp3(v, OP_Null, 0, regBase, regBase+nSkip-1);
drh6f82e852015-06-06 20:12:09 +0000790 sqlite3VdbeAddOp1(v, (bRev?OP_Last:OP_Rewind), iIdxCur);
791 VdbeCoverageIf(v, bRev==0);
792 VdbeCoverageIf(v, bRev!=0);
793 VdbeComment((v, "begin skip-scan on %s", pIdx->zName));
794 j = sqlite3VdbeAddOp0(v, OP_Goto);
drh56945692022-03-02 21:04:10 +0000795 assert( pLevel->addrSkip==0 );
drh6f82e852015-06-06 20:12:09 +0000796 pLevel->addrSkip = sqlite3VdbeAddOp4Int(v, (bRev?OP_SeekLT:OP_SeekGT),
797 iIdxCur, 0, regBase, nSkip);
798 VdbeCoverageIf(v, bRev==0);
799 VdbeCoverageIf(v, bRev!=0);
800 sqlite3VdbeJumpHere(v, j);
801 for(j=0; j<nSkip; j++){
802 sqlite3VdbeAddOp3(v, OP_Column, iIdxCur, j, regBase+j);
drh4b92f982015-09-29 17:20:14 +0000803 testcase( pIdx->aiColumn[j]==XN_EXPR );
drhe63e8a62015-09-18 18:09:28 +0000804 VdbeComment((v, "%s", explainIndexColumnName(pIdx, j)));
drh6f82e852015-06-06 20:12:09 +0000805 }
806 }
807
808 /* Evaluate the equality constraints
809 */
810 assert( zAff==0 || (int)strlen(zAff)>=nEq );
811 for(j=nSkip; j<nEq; j++){
812 int r1;
813 pTerm = pLoop->aLTerm[j];
814 assert( pTerm!=0 );
815 /* The following testcase is true for indices with redundant columns.
816 ** Ex: CREATE INDEX i1 ON t1(a,b,a); SELECT * FROM t1 WHERE a=0 AND b=0; */
817 testcase( (pTerm->wtFlags & TERM_CODED)!=0 );
818 testcase( pTerm->wtFlags & TERM_VIRTUAL );
819 r1 = codeEqualityTerm(pParse, pTerm, pLevel, j, bRev, regBase+j);
820 if( r1!=regBase+j ){
821 if( nReg==1 ){
822 sqlite3ReleaseTempReg(pParse, regBase);
823 regBase = r1;
824 }else{
drhe9de6522021-05-28 12:48:31 +0000825 sqlite3VdbeAddOp2(v, OP_Copy, r1, regBase+j);
drh6f82e852015-06-06 20:12:09 +0000826 }
827 }
drhe482fde2022-01-21 16:41:11 +0000828 }
829 for(j=nSkip; j<nEq; j++){
830 pTerm = pLoop->aLTerm[j];
drhc097e122016-09-07 13:30:40 +0000831 if( pTerm->eOperator & WO_IN ){
832 if( pTerm->pExpr->flags & EP_xIsSelect ){
833 /* No affinity ever needs to be (or should be) applied to a value
834 ** from the RHS of an "? IN (SELECT ...)" expression. The
835 ** sqlite3FindInIndex() routine has already ensured that the
836 ** affinity of the comparison has been applied to the value. */
837 if( zAff ) zAff[j] = SQLITE_AFF_BLOB;
838 }
839 }else if( (pTerm->eOperator & WO_ISNULL)==0 ){
840 Expr *pRight = pTerm->pExpr->pRight;
841 if( (pTerm->wtFlags & TERM_IS)==0 && sqlite3ExprCanBeNull(pRight) ){
842 sqlite3VdbeAddOp2(v, OP_IsNull, regBase+j, pLevel->addrBrk);
843 VdbeCoverage(v);
844 }
drh0c7d3d32022-01-24 16:47:12 +0000845 if( pParse->nErr==0 ){
846 assert( pParse->db->mallocFailed==0 );
drhc097e122016-09-07 13:30:40 +0000847 if( sqlite3CompareAffinity(pRight, zAff[j])==SQLITE_AFF_BLOB ){
848 zAff[j] = SQLITE_AFF_BLOB;
dan27189602016-09-03 15:31:20 +0000849 }
drhc097e122016-09-07 13:30:40 +0000850 if( sqlite3ExprNeedsNoAffinityChange(pRight, zAff[j]) ){
851 zAff[j] = SQLITE_AFF_BLOB;
drh6f82e852015-06-06 20:12:09 +0000852 }
853 }
854 }
855 }
856 *pzAff = zAff;
857 return regBase;
858}
859
drh41d2e662015-12-01 21:23:07 +0000860#ifndef SQLITE_LIKE_DOESNT_MATCH_BLOBS
drh6f82e852015-06-06 20:12:09 +0000861/*
drh44aebff2016-05-02 10:25:42 +0000862** If the most recently coded instruction is a constant range constraint
863** (a string literal) that originated from the LIKE optimization, then
864** set P3 and P5 on the OP_String opcode so that the string will be cast
865** to a BLOB at appropriate times.
drh6f82e852015-06-06 20:12:09 +0000866**
867** The LIKE optimization trys to evaluate "x LIKE 'abc%'" as a range
868** expression: "x>='ABC' AND x<'abd'". But this requires that the range
869** scan loop run twice, once for strings and a second time for BLOBs.
870** The OP_String opcodes on the second pass convert the upper and lower
mistachkine234cfd2016-07-10 19:35:10 +0000871** bound string constants to blobs. This routine makes the necessary changes
drh6f82e852015-06-06 20:12:09 +0000872** to the OP_String opcodes for that to happen.
drh41d2e662015-12-01 21:23:07 +0000873**
874** Except, of course, if SQLITE_LIKE_DOESNT_MATCH_BLOBS is defined, then
875** only the one pass through the string space is required, so this routine
876** becomes a no-op.
drh6f82e852015-06-06 20:12:09 +0000877*/
878static void whereLikeOptimizationStringFixup(
879 Vdbe *v, /* prepared statement under construction */
880 WhereLevel *pLevel, /* The loop that contains the LIKE operator */
881 WhereTerm *pTerm /* The upper or lower bound just coded */
882){
883 if( pTerm->wtFlags & TERM_LIKEOPT ){
884 VdbeOp *pOp;
885 assert( pLevel->iLikeRepCntr>0 );
886 pOp = sqlite3VdbeGetOp(v, -1);
887 assert( pOp!=0 );
888 assert( pOp->opcode==OP_String8
889 || pTerm->pWC->pWInfo->pParse->db->mallocFailed );
drh44aebff2016-05-02 10:25:42 +0000890 pOp->p3 = (int)(pLevel->iLikeRepCntr>>1); /* Register holding counter */
891 pOp->p5 = (u8)(pLevel->iLikeRepCntr&1); /* ASC or DESC */
drh6f82e852015-06-06 20:12:09 +0000892 }
893}
drh41d2e662015-12-01 21:23:07 +0000894#else
895# define whereLikeOptimizationStringFixup(A,B,C)
896#endif
drh6f82e852015-06-06 20:12:09 +0000897
drhbec24762015-08-13 20:07:13 +0000898#ifdef SQLITE_ENABLE_CURSOR_HINTS
drh2f2b0272015-08-14 18:50:04 +0000899/*
900** Information is passed from codeCursorHint() down to individual nodes of
901** the expression tree (by sqlite3WalkExpr()) using an instance of this
902** structure.
903*/
904struct CCurHint {
905 int iTabCur; /* Cursor for the main table */
906 int iIdxCur; /* Cursor for the index, if pIdx!=0. Unused otherwise */
907 Index *pIdx; /* The index used to access the table */
908};
909
910/*
911** This function is called for every node of an expression that is a candidate
912** for a cursor hint on an index cursor. For TK_COLUMN nodes that reference
913** the table CCurHint.iTabCur, verify that the same column can be
914** accessed through the index. If it cannot, then set pWalker->eCode to 1.
915*/
916static int codeCursorHintCheckExpr(Walker *pWalker, Expr *pExpr){
917 struct CCurHint *pHint = pWalker->u.pCCurHint;
918 assert( pHint->pIdx!=0 );
919 if( pExpr->op==TK_COLUMN
920 && pExpr->iTable==pHint->iTabCur
drhb9bcf7c2019-10-19 13:29:10 +0000921 && sqlite3TableColumnToIndex(pHint->pIdx, pExpr->iColumn)<0
drh2f2b0272015-08-14 18:50:04 +0000922 ){
923 pWalker->eCode = 1;
924 }
925 return WRC_Continue;
926}
927
dane6912fd2016-06-17 19:27:13 +0000928/*
929** Test whether or not expression pExpr, which was part of a WHERE clause,
930** should be included in the cursor-hint for a table that is on the rhs
931** of a LEFT JOIN. Set Walker.eCode to non-zero before returning if the
932** expression is not suitable.
933**
934** An expression is unsuitable if it might evaluate to non NULL even if
935** a TK_COLUMN node that does affect the value of the expression is set
936** to NULL. For example:
937**
938** col IS NULL
939** col IS NOT NULL
940** coalesce(col, 1)
941** CASE WHEN col THEN 0 ELSE 1 END
942*/
943static int codeCursorHintIsOrFunction(Walker *pWalker, Expr *pExpr){
dan2b693d62016-06-20 17:22:06 +0000944 if( pExpr->op==TK_IS
dane6912fd2016-06-17 19:27:13 +0000945 || pExpr->op==TK_ISNULL || pExpr->op==TK_ISNOT
946 || pExpr->op==TK_NOTNULL || pExpr->op==TK_CASE
947 ){
948 pWalker->eCode = 1;
dan2b693d62016-06-20 17:22:06 +0000949 }else if( pExpr->op==TK_FUNCTION ){
950 int d1;
drh1d42ea72017-07-27 20:24:29 +0000951 char d2[4];
dan2b693d62016-06-20 17:22:06 +0000952 if( 0==sqlite3IsLikeFunction(pWalker->pParse->db, pExpr, &d1, d2) ){
953 pWalker->eCode = 1;
954 }
dane6912fd2016-06-17 19:27:13 +0000955 }
dan2b693d62016-06-20 17:22:06 +0000956
dane6912fd2016-06-17 19:27:13 +0000957 return WRC_Continue;
958}
959
drhbec24762015-08-13 20:07:13 +0000960
961/*
962** This function is called on every node of an expression tree used as an
963** argument to the OP_CursorHint instruction. If the node is a TK_COLUMN
drh2f2b0272015-08-14 18:50:04 +0000964** that accesses any table other than the one identified by
965** CCurHint.iTabCur, then do the following:
drhbec24762015-08-13 20:07:13 +0000966**
967** 1) allocate a register and code an OP_Column instruction to read
968** the specified column into the new register, and
969**
970** 2) transform the expression node to a TK_REGISTER node that reads
971** from the newly populated register.
drh2f2b0272015-08-14 18:50:04 +0000972**
973** Also, if the node is a TK_COLUMN that does access the table idenified
974** by pCCurHint.iTabCur, and an index is being used (which we will
975** know because CCurHint.pIdx!=0) then transform the TK_COLUMN into
976** an access of the index rather than the original table.
drhbec24762015-08-13 20:07:13 +0000977*/
978static int codeCursorHintFixExpr(Walker *pWalker, Expr *pExpr){
979 int rc = WRC_Continue;
drh2f2b0272015-08-14 18:50:04 +0000980 struct CCurHint *pHint = pWalker->u.pCCurHint;
danbe312ae2018-09-10 19:27:12 +0000981 if( pExpr->op==TK_COLUMN ){
drh2f2b0272015-08-14 18:50:04 +0000982 if( pExpr->iTable!=pHint->iTabCur ){
drh2f2b0272015-08-14 18:50:04 +0000983 int reg = ++pWalker->pParse->nMem; /* Register for column value */
dane3e79212018-09-11 13:38:35 +0000984 sqlite3ExprCode(pWalker->pParse, pExpr, reg);
drh2f2b0272015-08-14 18:50:04 +0000985 pExpr->op = TK_REGISTER;
986 pExpr->iTable = reg;
987 }else if( pHint->pIdx!=0 ){
988 pExpr->iTable = pHint->iIdxCur;
drhb9bcf7c2019-10-19 13:29:10 +0000989 pExpr->iColumn = sqlite3TableColumnToIndex(pHint->pIdx, pExpr->iColumn);
drh2f2b0272015-08-14 18:50:04 +0000990 assert( pExpr->iColumn>=0 );
991 }
drhbec24762015-08-13 20:07:13 +0000992 }else if( pExpr->op==TK_AGG_FUNCTION ){
993 /* An aggregate function in the WHERE clause of a query means this must
994 ** be a correlated sub-query, and expression pExpr is an aggregate from
995 ** the parent context. Do not walk the function arguments in this case.
996 **
997 ** todo: It should be possible to replace this node with a TK_REGISTER
998 ** expression, as the result of the expression must be stored in a
999 ** register at this point. The same holds for TK_AGG_COLUMN nodes. */
1000 rc = WRC_Prune;
1001 }
1002 return rc;
1003}
1004
1005/*
1006** Insert an OP_CursorHint instruction if it is appropriate to do so.
1007*/
1008static void codeCursorHint(
drh76012942021-02-21 21:04:54 +00001009 SrcItem *pTabItem, /* FROM clause item */
drhb413a542015-08-17 17:19:28 +00001010 WhereInfo *pWInfo, /* The where clause */
1011 WhereLevel *pLevel, /* Which loop to provide hints for */
1012 WhereTerm *pEndRange /* Hint this end-of-scan boundary term if not NULL */
drhbec24762015-08-13 20:07:13 +00001013){
1014 Parse *pParse = pWInfo->pParse;
1015 sqlite3 *db = pParse->db;
1016 Vdbe *v = pParse->pVdbe;
drhbec24762015-08-13 20:07:13 +00001017 Expr *pExpr = 0;
drh2f2b0272015-08-14 18:50:04 +00001018 WhereLoop *pLoop = pLevel->pWLoop;
drhbec24762015-08-13 20:07:13 +00001019 int iCur;
1020 WhereClause *pWC;
1021 WhereTerm *pTerm;
drhb413a542015-08-17 17:19:28 +00001022 int i, j;
drh2f2b0272015-08-14 18:50:04 +00001023 struct CCurHint sHint;
1024 Walker sWalker;
drhbec24762015-08-13 20:07:13 +00001025
1026 if( OptimizationDisabled(db, SQLITE_CursorHints) ) return;
drh2f2b0272015-08-14 18:50:04 +00001027 iCur = pLevel->iTabCur;
1028 assert( iCur==pWInfo->pTabList->a[pLevel->iFrom].iCursor );
1029 sHint.iTabCur = iCur;
1030 sHint.iIdxCur = pLevel->iIdxCur;
1031 sHint.pIdx = pLoop->u.btree.pIndex;
1032 memset(&sWalker, 0, sizeof(sWalker));
1033 sWalker.pParse = pParse;
1034 sWalker.u.pCCurHint = &sHint;
drhbec24762015-08-13 20:07:13 +00001035 pWC = &pWInfo->sWC;
drh132f96f2021-12-08 16:07:22 +00001036 for(i=0; i<pWC->nBase; i++){
drhbec24762015-08-13 20:07:13 +00001037 pTerm = &pWC->a[i];
1038 if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
1039 if( pTerm->prereqAll & pLevel->notReady ) continue;
danb324cf72016-06-17 14:33:32 +00001040
1041 /* Any terms specified as part of the ON(...) clause for any LEFT
1042 ** JOIN for which the current table is not the rhs are omitted
1043 ** from the cursor-hint.
1044 **
dane6912fd2016-06-17 19:27:13 +00001045 ** If this table is the rhs of a LEFT JOIN, "IS" or "IS NULL" terms
1046 ** that were specified as part of the WHERE clause must be excluded.
1047 ** This is to address the following:
danb324cf72016-06-17 14:33:32 +00001048 **
1049 ** SELECT ... t1 LEFT JOIN t2 ON (t1.a=t2.b) WHERE t2.c IS NULL;
1050 **
dane6912fd2016-06-17 19:27:13 +00001051 ** Say there is a single row in t2 that matches (t1.a=t2.b), but its
1052 ** t2.c values is not NULL. If the (t2.c IS NULL) constraint is
1053 ** pushed down to the cursor, this row is filtered out, causing
1054 ** SQLite to synthesize a row of NULL values. Which does match the
1055 ** WHERE clause, and so the query returns a row. Which is incorrect.
1056 **
1057 ** For the same reason, WHERE terms such as:
1058 **
1059 ** WHERE 1 = (t2.c IS NULL)
1060 **
1061 ** are also excluded. See codeCursorHintIsOrFunction() for details.
danb324cf72016-06-17 14:33:32 +00001062 */
1063 if( pTabItem->fg.jointype & JT_LEFT ){
dane6912fd2016-06-17 19:27:13 +00001064 Expr *pExpr = pTerm->pExpr;
1065 if( !ExprHasProperty(pExpr, EP_FromJoin)
drh796588a2022-02-05 21:49:47 +00001066 || pExpr->w.iRightJoinTable!=pTabItem->iCursor
danb324cf72016-06-17 14:33:32 +00001067 ){
dane6912fd2016-06-17 19:27:13 +00001068 sWalker.eCode = 0;
1069 sWalker.xExprCallback = codeCursorHintIsOrFunction;
1070 sqlite3WalkExpr(&sWalker, pTerm->pExpr);
1071 if( sWalker.eCode ) continue;
danb324cf72016-06-17 14:33:32 +00001072 }
1073 }else{
1074 if( ExprHasProperty(pTerm->pExpr, EP_FromJoin) ) continue;
1075 }
drhb413a542015-08-17 17:19:28 +00001076
1077 /* All terms in pWLoop->aLTerm[] except pEndRange are used to initialize
drhbcf40a72015-08-18 15:58:05 +00001078 ** the cursor. These terms are not needed as hints for a pure range
1079 ** scan (that has no == terms) so omit them. */
1080 if( pLoop->u.btree.nEq==0 && pTerm!=pEndRange ){
1081 for(j=0; j<pLoop->nLTerm && pLoop->aLTerm[j]!=pTerm; j++){}
1082 if( j<pLoop->nLTerm ) continue;
drhb413a542015-08-17 17:19:28 +00001083 }
1084
1085 /* No subqueries or non-deterministic functions allowed */
drhbec24762015-08-13 20:07:13 +00001086 if( sqlite3ExprContainsSubquery(pTerm->pExpr) ) continue;
drhb413a542015-08-17 17:19:28 +00001087
1088 /* For an index scan, make sure referenced columns are actually in
1089 ** the index. */
drh2f2b0272015-08-14 18:50:04 +00001090 if( sHint.pIdx!=0 ){
1091 sWalker.eCode = 0;
1092 sWalker.xExprCallback = codeCursorHintCheckExpr;
1093 sqlite3WalkExpr(&sWalker, pTerm->pExpr);
1094 if( sWalker.eCode ) continue;
1095 }
drhb413a542015-08-17 17:19:28 +00001096
1097 /* If we survive all prior tests, that means this term is worth hinting */
drhd5c851c2019-04-19 13:38:34 +00001098 pExpr = sqlite3ExprAnd(pParse, pExpr, sqlite3ExprDup(db, pTerm->pExpr, 0));
drhbec24762015-08-13 20:07:13 +00001099 }
1100 if( pExpr!=0 ){
drhbec24762015-08-13 20:07:13 +00001101 sWalker.xExprCallback = codeCursorHintFixExpr;
drhbec24762015-08-13 20:07:13 +00001102 sqlite3WalkExpr(&sWalker, pExpr);
drh2f2b0272015-08-14 18:50:04 +00001103 sqlite3VdbeAddOp4(v, OP_CursorHint,
1104 (sHint.pIdx ? sHint.iIdxCur : sHint.iTabCur), 0, 0,
1105 (const char*)pExpr, P4_EXPR);
drhbec24762015-08-13 20:07:13 +00001106 }
1107}
1108#else
danb324cf72016-06-17 14:33:32 +00001109# define codeCursorHint(A,B,C,D) /* No-op */
drhbec24762015-08-13 20:07:13 +00001110#endif /* SQLITE_ENABLE_CURSOR_HINTS */
drh6f82e852015-06-06 20:12:09 +00001111
1112/*
dande892d92016-01-29 19:29:45 +00001113** Cursor iCur is open on an intkey b-tree (a table). Register iRowid contains
1114** a rowid value just read from cursor iIdxCur, open on index pIdx. This
1115** function generates code to do a deferred seek of cursor iCur to the
1116** rowid stored in register iRowid.
1117**
1118** Normally, this is just:
1119**
drh170ad682017-06-02 15:44:22 +00001120** OP_DeferredSeek $iCur $iRowid
dande892d92016-01-29 19:29:45 +00001121**
drh7fd6a772022-02-25 13:29:56 +00001122** Which causes a seek on $iCur to the row with rowid $iRowid.
1123**
dande892d92016-01-29 19:29:45 +00001124** However, if the scan currently being coded is a branch of an OR-loop and
drh7fd6a772022-02-25 13:29:56 +00001125** the statement currently being coded is a SELECT, then additional information
1126** is added that might allow OP_Column to omit the seek and instead do its
1127** lookup on the index, thus avoiding an expensive seek operation. To
1128** enable this optimization, the P3 of OP_DeferredSeek is set to iIdxCur
1129** and P4 is set to an array of integers containing one entry for each column
1130** in the table. For each table column, if the column is the i'th
1131** column of the index, then the corresponding array entry is set to (i+1).
1132** If the column does not appear in the index at all, the array entry is set
1133** to 0. The OP_Column opcode can check this array to see if the column it
1134** wants is in the index and if it is, it will substitute the index cursor
1135** and column number and continue with those new values, rather than seeking
1136** the table cursor.
dande892d92016-01-29 19:29:45 +00001137*/
1138static void codeDeferredSeek(
1139 WhereInfo *pWInfo, /* Where clause context */
1140 Index *pIdx, /* Index scan is using */
1141 int iCur, /* Cursor for IPK b-tree */
dande892d92016-01-29 19:29:45 +00001142 int iIdxCur /* Index cursor */
1143){
1144 Parse *pParse = pWInfo->pParse; /* Parse context */
1145 Vdbe *v = pParse->pVdbe; /* Vdbe to generate code within */
1146
1147 assert( iIdxCur>0 );
1148 assert( pIdx->aiColumn[pIdx->nColumn-1]==-1 );
1149
drhbe3da242019-12-29 00:52:41 +00001150 pWInfo->bDeferredSeek = 1;
drh170ad682017-06-02 15:44:22 +00001151 sqlite3VdbeAddOp3(v, OP_DeferredSeek, iIdxCur, 0, iCur);
drhce943bc2016-05-19 18:56:33 +00001152 if( (pWInfo->wctrlFlags & WHERE_OR_SUBCLAUSE)
dancddb6ba2016-02-01 13:58:56 +00001153 && DbMaskAllZero(sqlite3ParseToplevel(pParse)->writeMask)
dande892d92016-01-29 19:29:45 +00001154 ){
1155 int i;
1156 Table *pTab = pIdx->pTable;
drhabc38152020-07-22 13:38:04 +00001157 u32 *ai = (u32*)sqlite3DbMallocZero(pParse->db, sizeof(u32)*(pTab->nCol+1));
dande892d92016-01-29 19:29:45 +00001158 if( ai ){
drhb1702022016-01-30 00:45:18 +00001159 ai[0] = pTab->nCol;
dande892d92016-01-29 19:29:45 +00001160 for(i=0; i<pIdx->nColumn-1; i++){
drh4fb24c82019-11-06 17:31:18 +00001161 int x1, x2;
dande892d92016-01-29 19:29:45 +00001162 assert( pIdx->aiColumn[i]<pTab->nCol );
drh4fb24c82019-11-06 17:31:18 +00001163 x1 = pIdx->aiColumn[i];
1164 x2 = sqlite3TableColumnToStorage(pTab, x1);
1165 testcase( x1!=x2 );
mistachkinbde3a4f2019-11-06 19:25:45 +00001166 if( x1>=0 ) ai[x2+1] = i+1;
dande892d92016-01-29 19:29:45 +00001167 }
1168 sqlite3VdbeChangeP4(v, -1, (char*)ai, P4_INTARRAY);
1169 }
1170 }
1171}
1172
dan553168c2016-08-01 20:14:31 +00001173/*
1174** If the expression passed as the second argument is a vector, generate
1175** code to write the first nReg elements of the vector into an array
1176** of registers starting with iReg.
1177**
1178** If the expression is not a vector, then nReg must be passed 1. In
1179** this case, generate code to evaluate the expression and leave the
1180** result in register iReg.
1181*/
dan71c57db2016-07-09 20:23:55 +00001182static void codeExprOrVector(Parse *pParse, Expr *p, int iReg, int nReg){
1183 assert( nReg>0 );
dand03024d2017-09-09 19:41:12 +00001184 if( p && sqlite3ExprIsVector(p) ){
danf9b2e052016-08-02 17:45:00 +00001185#ifndef SQLITE_OMIT_SUBQUERY
drha4eeccd2021-10-07 17:43:30 +00001186 if( ExprUseXSelect(p) ){
danf9b2e052016-08-02 17:45:00 +00001187 Vdbe *v = pParse->pVdbe;
drh85bcdce2018-12-23 21:27:29 +00001188 int iSelect;
1189 assert( p->op==TK_SELECT );
1190 iSelect = sqlite3CodeSubselect(pParse, p);
danf9b2e052016-08-02 17:45:00 +00001191 sqlite3VdbeAddOp3(v, OP_Copy, iSelect, iReg, nReg-1);
1192 }else
1193#endif
1194 {
1195 int i;
drha4eeccd2021-10-07 17:43:30 +00001196 const ExprList *pList;
1197 assert( ExprUseXList(p) );
1198 pList = p->x.pList;
dan71c57db2016-07-09 20:23:55 +00001199 assert( nReg<=pList->nExpr );
1200 for(i=0; i<nReg; i++){
1201 sqlite3ExprCode(pParse, pList->a[i].pExpr, iReg+i);
1202 }
dan71c57db2016-07-09 20:23:55 +00001203 }
1204 }else{
dan151446e2021-05-26 14:32:33 +00001205 assert( nReg==1 || pParse->nErr );
dan71c57db2016-07-09 20:23:55 +00001206 sqlite3ExprCode(pParse, p, iReg);
1207 }
1208}
1209
drheac5fc02017-04-11 01:01:27 +00001210/* An instance of the IdxExprTrans object carries information about a
1211** mapping from an expression on table columns into a column in an index
1212** down through the Walker.
1213*/
drhaca19e12017-04-07 19:41:31 +00001214typedef struct IdxExprTrans {
1215 Expr *pIdxExpr; /* The index expression */
1216 int iTabCur; /* The cursor of the corresponding table */
1217 int iIdxCur; /* The cursor for the index */
1218 int iIdxCol; /* The column for the index */
drhc7476732019-10-24 20:29:25 +00001219 int iTabCol; /* The column for the table */
drh36e678b2020-01-02 00:45:38 +00001220 WhereInfo *pWInfo; /* Complete WHERE clause information */
1221 sqlite3 *db; /* Database connection (for malloc()) */
drhaca19e12017-04-07 19:41:31 +00001222} IdxExprTrans;
1223
drh36e678b2020-01-02 00:45:38 +00001224/*
1225** Preserve pExpr on the WhereETrans list of the WhereInfo.
1226*/
1227static void preserveExpr(IdxExprTrans *pTrans, Expr *pExpr){
1228 WhereExprMod *pNew;
1229 pNew = sqlite3DbMallocRaw(pTrans->db, sizeof(*pNew));
1230 if( pNew==0 ) return;
1231 pNew->pNext = pTrans->pWInfo->pExprMods;
1232 pTrans->pWInfo->pExprMods = pNew;
1233 pNew->pExpr = pExpr;
1234 memcpy(&pNew->orig, pExpr, sizeof(*pExpr));
1235}
1236
drheac5fc02017-04-11 01:01:27 +00001237/* The walker node callback used to transform matching expressions into
1238** a reference to an index column for an index on an expression.
1239**
1240** If pExpr matches, then transform it into a reference to the index column
1241** that contains the value of pExpr.
1242*/
drhaca19e12017-04-07 19:41:31 +00001243static int whereIndexExprTransNode(Walker *p, Expr *pExpr){
1244 IdxExprTrans *pX = p->u.pIdxTrans;
dan5aa550c2017-06-24 18:10:29 +00001245 if( sqlite3ExprCompare(0, pExpr, pX->pIdxExpr, pX->iTabCur)==0 ){
drh36e678b2020-01-02 00:45:38 +00001246 preserveExpr(pX, pExpr);
danb6ce71b2019-08-20 11:43:44 +00001247 pExpr->affExpr = sqlite3ExprAffinity(pExpr);
drhaca19e12017-04-07 19:41:31 +00001248 pExpr->op = TK_COLUMN;
1249 pExpr->iTable = pX->iIdxCur;
1250 pExpr->iColumn = pX->iIdxCol;
drh6c1c85c2019-12-22 18:55:04 +00001251 testcase( ExprHasProperty(pExpr, EP_Skip) );
1252 testcase( ExprHasProperty(pExpr, EP_Unlikely) );
drh477572b2021-10-07 20:46:29 +00001253 ExprClearProperty(pExpr, EP_Skip|EP_Unlikely|EP_WinFunc|EP_Subrtn);
1254 pExpr->y.pTab = 0;
drhaca19e12017-04-07 19:41:31 +00001255 return WRC_Prune;
1256 }else{
1257 return WRC_Continue;
1258 }
1259}
1260
drhc7476732019-10-24 20:29:25 +00001261#ifndef SQLITE_OMIT_GENERATED_COLUMNS
1262/* A walker node callback that translates a column reference to a table
1263** into a corresponding column reference of an index.
1264*/
1265static int whereIndexExprTransColumn(Walker *p, Expr *pExpr){
1266 if( pExpr->op==TK_COLUMN ){
1267 IdxExprTrans *pX = p->u.pIdxTrans;
1268 if( pExpr->iTable==pX->iTabCur && pExpr->iColumn==pX->iTabCol ){
drh477572b2021-10-07 20:46:29 +00001269 assert( ExprUseYTab(pExpr) && pExpr->y.pTab!=0 );
drh36e678b2020-01-02 00:45:38 +00001270 preserveExpr(pX, pExpr);
drh57f7ece2019-11-21 18:28:44 +00001271 pExpr->affExpr = sqlite3TableColumnAffinity(pExpr->y.pTab,pExpr->iColumn);
drhc7476732019-10-24 20:29:25 +00001272 pExpr->iTable = pX->iIdxCur;
1273 pExpr->iColumn = pX->iIdxCol;
drh4485ac12019-10-24 21:02:06 +00001274 pExpr->y.pTab = 0;
drhc7476732019-10-24 20:29:25 +00001275 }
1276 }
1277 return WRC_Continue;
1278}
1279#endif /* SQLITE_OMIT_GENERATED_COLUMNS */
1280
drhaca19e12017-04-07 19:41:31 +00001281/*
drhf49759b2017-08-25 19:51:51 +00001282** For an indexes on expression X, locate every instance of expression X
1283** in pExpr and change that subexpression into a reference to the appropriate
1284** column of the index.
drhc7476732019-10-24 20:29:25 +00001285**
1286** 2019-10-24: Updated to also translate references to a VIRTUAL column in
1287** the table into references to the corresponding (stored) column of the
1288** index.
drhaca19e12017-04-07 19:41:31 +00001289*/
1290static void whereIndexExprTrans(
1291 Index *pIdx, /* The Index */
1292 int iTabCur, /* Cursor of the table that is being indexed */
1293 int iIdxCur, /* Cursor of the index itself */
1294 WhereInfo *pWInfo /* Transform expressions in this WHERE clause */
1295){
1296 int iIdxCol; /* Column number of the index */
1297 ExprList *aColExpr; /* Expressions that are indexed */
drhc7476732019-10-24 20:29:25 +00001298 Table *pTab;
drhaca19e12017-04-07 19:41:31 +00001299 Walker w;
1300 IdxExprTrans x;
1301 aColExpr = pIdx->aColExpr;
drhc7476732019-10-24 20:29:25 +00001302 if( aColExpr==0 && !pIdx->bHasVCol ){
1303 /* The index does not reference any expressions or virtual columns
1304 ** so no translations are needed. */
1305 return;
1306 }
1307 pTab = pIdx->pTable;
drhaca19e12017-04-07 19:41:31 +00001308 memset(&w, 0, sizeof(w));
drhaca19e12017-04-07 19:41:31 +00001309 w.u.pIdxTrans = &x;
1310 x.iTabCur = iTabCur;
1311 x.iIdxCur = iIdxCur;
drh36e678b2020-01-02 00:45:38 +00001312 x.pWInfo = pWInfo;
1313 x.db = pWInfo->pParse->db;
drhc7476732019-10-24 20:29:25 +00001314 for(iIdxCol=0; iIdxCol<pIdx->nColumn; iIdxCol++){
1315 i16 iRef = pIdx->aiColumn[iIdxCol];
1316 if( iRef==XN_EXPR ){
drh7d4c94b2021-10-04 22:34:38 +00001317 assert( aColExpr!=0 && aColExpr->a[iIdxCol].pExpr!=0 );
drhc7476732019-10-24 20:29:25 +00001318 x.pIdxExpr = aColExpr->a[iIdxCol].pExpr;
drhe86f3402019-12-26 00:20:56 +00001319 if( sqlite3ExprIsConstant(x.pIdxExpr) ) continue;
drhc7476732019-10-24 20:29:25 +00001320 w.xExprCallback = whereIndexExprTransNode;
1321#ifndef SQLITE_OMIT_GENERATED_COLUMNS
drhed0c3482019-12-20 22:46:41 +00001322 }else if( iRef>=0
1323 && (pTab->aCol[iRef].colFlags & COLFLAG_VIRTUAL)!=0
drh65b40092021-08-05 15:27:19 +00001324 && ((pTab->aCol[iRef].colFlags & COLFLAG_HASCOLL)==0
1325 || sqlite3StrICmp(sqlite3ColumnColl(&pTab->aCol[iRef]),
1326 sqlite3StrBINARY)==0)
drhed0c3482019-12-20 22:46:41 +00001327 ){
1328 /* Check to see if there are direct references to generated columns
1329 ** that are contained in the index. Pulling the generated column
1330 ** out of the index is an optimization only - the main table is always
1331 ** available if the index cannot be used. To avoid unnecessary
1332 ** complication, omit this optimization if the collating sequence for
1333 ** the column is non-standard */
drhc7476732019-10-24 20:29:25 +00001334 x.iTabCol = iRef;
1335 w.xExprCallback = whereIndexExprTransColumn;
1336#endif /* SQLITE_OMIT_GENERATED_COLUMNS */
1337 }else{
1338 continue;
1339 }
drhaca19e12017-04-07 19:41:31 +00001340 x.iIdxCol = iIdxCol;
drhaca19e12017-04-07 19:41:31 +00001341 sqlite3WalkExpr(&w, pWInfo->pWhere);
1342 sqlite3WalkExprList(&w, pWInfo->pOrderBy);
1343 sqlite3WalkExprList(&w, pWInfo->pResultSet);
1344 }
1345}
drhaca19e12017-04-07 19:41:31 +00001346
dande892d92016-01-29 19:29:45 +00001347/*
drh610f11d2019-03-18 10:30:00 +00001348** The pTruth expression is always true because it is the WHERE clause
drhb531aa82019-03-01 18:07:05 +00001349** a partial index that is driving a query loop. Look through all of the
1350** WHERE clause terms on the query, and if any of those terms must be
1351** true because pTruth is true, then mark those WHERE clause terms as
1352** coded.
1353*/
1354static void whereApplyPartialIndexConstraints(
1355 Expr *pTruth,
1356 int iTabCur,
1357 WhereClause *pWC
1358){
1359 int i;
1360 WhereTerm *pTerm;
1361 while( pTruth->op==TK_AND ){
1362 whereApplyPartialIndexConstraints(pTruth->pLeft, iTabCur, pWC);
1363 pTruth = pTruth->pRight;
1364 }
1365 for(i=0, pTerm=pWC->a; i<pWC->nTerm; i++, pTerm++){
1366 Expr *pExpr;
1367 if( pTerm->wtFlags & TERM_CODED ) continue;
1368 pExpr = pTerm->pExpr;
1369 if( sqlite3ExprCompare(0, pExpr, pTruth, iTabCur)==0 ){
1370 pTerm->wtFlags |= TERM_CODED;
1371 }
1372 }
1373}
1374
drh35685d32021-12-05 00:45:55 +00001375/*
drh6ae49e62021-12-05 20:19:47 +00001376** This routine is called right after An OP_Filter has been generated and
1377** before the corresponding index search has been performed. This routine
1378** checks to see if there are additional Bloom filters in inner loops that
1379** can be checked prior to doing the index lookup. If there are available
1380** inner-loop Bloom filters, then evaluate those filters now, before the
1381** index lookup. The idea is that a Bloom filter check is way faster than
1382** an index lookup, and the Bloom filter might return false, meaning that
1383** the index lookup can be skipped.
1384**
1385** We know that an inner loop uses a Bloom filter because it has the
1386** WhereLevel.regFilter set. If an inner-loop Bloom filter is checked,
drh5a4ac1c2021-12-09 19:42:52 +00001387** then clear the WhereLevel.regFilter value to prevent the Bloom filter
drh6ae49e62021-12-05 20:19:47 +00001388** from being checked a second time when the inner loop is evaluated.
drh35685d32021-12-05 00:45:55 +00001389*/
1390static SQLITE_NOINLINE void filterPullDown(
1391 Parse *pParse, /* Parsing context */
1392 WhereInfo *pWInfo, /* Complete information about the WHERE clause */
1393 int iLevel, /* Which level of pWInfo->a[] should be coded */
1394 int addrNxt, /* Jump here to bypass inner loops */
1395 Bitmask notReady /* Loops that are not ready */
1396){
1397 while( ++iLevel < pWInfo->nLevel ){
1398 WhereLevel *pLevel = &pWInfo->a[iLevel];
1399 WhereLoop *pLoop = pLevel->pWLoop;
drh6ae49e62021-12-05 20:19:47 +00001400 if( pLevel->regFilter==0 ) continue;
drh56945692022-03-02 21:04:10 +00001401 if( pLevel->pWLoop->nSkip ) continue;
drh27a9e1f2021-12-10 17:36:16 +00001402 /* ,--- Because sqlite3ConstructBloomFilter() has will not have set
drha11c5e22021-12-09 18:44:03 +00001403 ** vvvvv--' pLevel->regFilter if this were true. */
1404 if( NEVER(pLoop->prereq & notReady) ) continue;
drh35685d32021-12-05 00:45:55 +00001405 if( pLoop->wsFlags & WHERE_IPK ){
1406 WhereTerm *pTerm = pLoop->aLTerm[0];
drh7e910f62021-12-09 01:28:15 +00001407 int regRowid;
drh35685d32021-12-05 00:45:55 +00001408 assert( pTerm!=0 );
1409 assert( pTerm->pExpr!=0 );
1410 testcase( pTerm->wtFlags & TERM_VIRTUAL );
drh7e910f62021-12-09 01:28:15 +00001411 regRowid = sqlite3GetTempReg(pParse);
1412 regRowid = codeEqualityTerm(pParse, pTerm, pLevel, 0, 0, regRowid);
drh35685d32021-12-05 00:45:55 +00001413 sqlite3VdbeAddOp4Int(pParse->pVdbe, OP_Filter, pLevel->regFilter,
1414 addrNxt, regRowid, 1);
1415 VdbeCoverage(pParse->pVdbe);
1416 }else{
1417 u16 nEq = pLoop->u.btree.nEq;
1418 int r1;
1419 char *zStartAff;
1420
1421 assert( pLoop->wsFlags & WHERE_INDEXED );
drhdc56dc92021-12-11 17:10:58 +00001422 assert( (pLoop->wsFlags & WHERE_COLUMN_IN)==0 );
drh35685d32021-12-05 00:45:55 +00001423 r1 = codeAllEqualityTerms(pParse,pLevel,0,0,&zStartAff);
1424 codeApplyAffinity(pParse, r1, nEq, zStartAff);
1425 sqlite3DbFree(pParse->db, zStartAff);
1426 sqlite3VdbeAddOp4Int(pParse->pVdbe, OP_Filter, pLevel->regFilter,
1427 addrNxt, r1, nEq);
1428 VdbeCoverage(pParse->pVdbe);
1429 }
drh6ae49e62021-12-05 20:19:47 +00001430 pLevel->regFilter = 0;
drh35685d32021-12-05 00:45:55 +00001431 }
1432}
drh35685d32021-12-05 00:45:55 +00001433
drhb531aa82019-03-01 18:07:05 +00001434/*
drh6f82e852015-06-06 20:12:09 +00001435** Generate code for the start of the iLevel-th loop in the WHERE clause
1436** implementation described by pWInfo.
1437*/
1438Bitmask sqlite3WhereCodeOneLoopStart(
drh47df8a22018-12-25 00:15:37 +00001439 Parse *pParse, /* Parsing context */
1440 Vdbe *v, /* Prepared statement under construction */
drh6f82e852015-06-06 20:12:09 +00001441 WhereInfo *pWInfo, /* Complete information about the WHERE clause */
1442 int iLevel, /* Which level of pWInfo->a[] should be coded */
drh47df8a22018-12-25 00:15:37 +00001443 WhereLevel *pLevel, /* The current level pointer */
drh6f82e852015-06-06 20:12:09 +00001444 Bitmask notReady /* Which tables are currently available */
1445){
1446 int j, k; /* Loop counters */
1447 int iCur; /* The VDBE cursor for the table */
1448 int addrNxt; /* Where to jump to continue with the next IN case */
drh6f82e852015-06-06 20:12:09 +00001449 int bRev; /* True if we need to scan in reverse order */
drh6f82e852015-06-06 20:12:09 +00001450 WhereLoop *pLoop; /* The WhereLoop object being coded */
1451 WhereClause *pWC; /* Decomposition of the entire WHERE clause */
1452 WhereTerm *pTerm; /* A WHERE clause term */
drh6f82e852015-06-06 20:12:09 +00001453 sqlite3 *db; /* Database connection */
drh76012942021-02-21 21:04:54 +00001454 SrcItem *pTabItem; /* FROM clause term being coded */
drh6f82e852015-06-06 20:12:09 +00001455 int addrBrk; /* Jump here to break out of the loop */
drh3a3b4202017-02-15 22:36:15 +00001456 int addrHalt; /* addrBrk for the outermost loop */
drh6f82e852015-06-06 20:12:09 +00001457 int addrCont; /* Jump here to continue with next cycle */
1458 int iRowidReg = 0; /* Rowid is stored in this register, if not zero */
1459 int iReleaseReg = 0; /* Temp register to free before returning */
dan6f654a42017-04-28 19:59:55 +00001460 Index *pIdx = 0; /* Index used by loop (if any) */
danebc63012017-07-10 14:33:00 +00001461 int iLoop; /* Iteration of constraint generator loop */
drh6f82e852015-06-06 20:12:09 +00001462
drh6f82e852015-06-06 20:12:09 +00001463 pWC = &pWInfo->sWC;
1464 db = pParse->db;
drh6f82e852015-06-06 20:12:09 +00001465 pLoop = pLevel->pWLoop;
1466 pTabItem = &pWInfo->pTabList->a[pLevel->iFrom];
1467 iCur = pTabItem->iCursor;
1468 pLevel->notReady = notReady & ~sqlite3WhereGetMask(&pWInfo->sMaskSet, iCur);
1469 bRev = (pWInfo->revMask>>iLevel)&1;
drh6f82e852015-06-06 20:12:09 +00001470 VdbeModuleComment((v, "Begin WHERE-loop%d: %s",iLevel,pTabItem->pTab->zName));
drh118efd12019-12-28 14:07:22 +00001471#if WHERETRACE_ENABLED /* 0x20800 */
1472 if( sqlite3WhereTrace & 0x800 ){
drha4b2df52019-12-28 16:20:23 +00001473 sqlite3DebugPrintf("Coding level %d of %d: notReady=%llx iFrom=%d\n",
1474 iLevel, pWInfo->nLevel, (u64)notReady, pLevel->iFrom);
drh118efd12019-12-28 14:07:22 +00001475 sqlite3WhereLoopPrint(pLoop, pWC);
1476 }
1477 if( sqlite3WhereTrace & 0x20000 ){
drhf1bb31e2019-12-28 14:33:26 +00001478 if( iLevel==0 ){
1479 sqlite3DebugPrintf("WHERE clause being coded:\n");
1480 sqlite3TreeViewExpr(0, pWInfo->pWhere, 0);
1481 }
1482 sqlite3DebugPrintf("All WHERE-clause terms before coding:\n");
drh118efd12019-12-28 14:07:22 +00001483 sqlite3WhereClausePrint(pWC);
1484 }
1485#endif
drh6f82e852015-06-06 20:12:09 +00001486
1487 /* Create labels for the "break" and "continue" instructions
1488 ** for the current loop. Jump to addrBrk to break out of a loop.
1489 ** Jump to cont to go immediately to the next iteration of the
1490 ** loop.
1491 **
1492 ** When there is an IN operator, we also have a "addrNxt" label that
1493 ** means to continue with the next IN value combination. When
1494 ** there are no IN operators in the constraints, the "addrNxt" label
1495 ** is the same as "addrBrk".
1496 */
drhec4ccdb2018-12-29 02:26:59 +00001497 addrBrk = pLevel->addrBrk = pLevel->addrNxt = sqlite3VdbeMakeLabel(pParse);
1498 addrCont = pLevel->addrCont = sqlite3VdbeMakeLabel(pParse);
drh6f82e852015-06-06 20:12:09 +00001499
1500 /* If this is the right table of a LEFT OUTER JOIN, allocate and
1501 ** initialize a memory cell that records if this table matches any
1502 ** row of the left table of the join.
1503 */
dan820fcd22018-04-24 18:53:24 +00001504 assert( (pWInfo->wctrlFlags & WHERE_OR_SUBCLAUSE)
1505 || pLevel->iFrom>0 || (pTabItem[0].fg.jointype & JT_LEFT)==0
1506 );
drh8a48b9c2015-08-19 15:20:00 +00001507 if( pLevel->iFrom>0 && (pTabItem[0].fg.jointype & JT_LEFT)!=0 ){
drh6f82e852015-06-06 20:12:09 +00001508 pLevel->iLeftJoin = ++pParse->nMem;
1509 sqlite3VdbeAddOp2(v, OP_Integer, 0, pLevel->iLeftJoin);
1510 VdbeComment((v, "init LEFT JOIN no-match flag"));
1511 }
1512
drh3a3b4202017-02-15 22:36:15 +00001513 /* Compute a safe address to jump to if we discover that the table for
1514 ** this loop is empty and can never contribute content. */
1515 for(j=iLevel; j>0 && pWInfo->a[j].iLeftJoin==0; j--){}
1516 addrHalt = pWInfo->a[j].addrBrk;
1517
drh6f82e852015-06-06 20:12:09 +00001518 /* Special case of a FROM clause subquery implemented as a co-routine */
drh8a48b9c2015-08-19 15:20:00 +00001519 if( pTabItem->fg.viaCoroutine ){
drh6f82e852015-06-06 20:12:09 +00001520 int regYield = pTabItem->regReturn;
1521 sqlite3VdbeAddOp3(v, OP_InitCoroutine, regYield, 0, pTabItem->addrFillSub);
1522 pLevel->p2 = sqlite3VdbeAddOp2(v, OP_Yield, regYield, addrBrk);
1523 VdbeCoverage(v);
drhfef37762018-07-10 19:48:35 +00001524 VdbeComment((v, "next row of %s", pTabItem->pTab->zName));
drh6f82e852015-06-06 20:12:09 +00001525 pLevel->op = OP_Goto;
1526 }else
1527
1528#ifndef SQLITE_OMIT_VIRTUALTABLE
1529 if( (pLoop->wsFlags & WHERE_VIRTUALTABLE)!=0 ){
1530 /* Case 1: The table is a virtual-table. Use the VFilter and VNext
1531 ** to access the data.
1532 */
1533 int iReg; /* P3 Value for OP_VFilter */
1534 int addrNotFound;
1535 int nConstraint = pLoop->nLTerm;
drhdbc49162016-03-02 03:28:07 +00001536 int iIn; /* Counter for IN constraints */
drh6f82e852015-06-06 20:12:09 +00001537
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 );
1582 if( pLoop->wsFlags & WHERE_IN_ABLE ){
1583 iIn = pLevel->u.in.nIn;
1584 }else{
1585 iIn = 0;
1586 }
drhdbc49162016-03-02 03:28:07 +00001587 for(j=nConstraint-1; j>=0; j--){
drh0fe7e7d2022-02-01 14:58:29 +00001588 int bIn; /* True to generate byte code to loop over RHS IN values */
drhdbc49162016-03-02 03:28:07 +00001589 pTerm = pLoop->aLTerm[j];
drh0fe7e7d2022-02-01 14:58:29 +00001590 if( (pTerm->eOperator & WO_IN)!=0
1591 && (SMASKBIT32(j) & pLoop->u.vtab.mHandleIn)==0
1592 ){
1593 bIn = 1;
1594 }else{
1595 bIn = 0;
1596 }
1597 if( bIn ) iIn--;
drhdbc49162016-03-02 03:28:07 +00001598 if( j<16 && (pLoop->u.vtab.omitMask>>j)&1 ){
1599 disableTerm(pLevel, pTerm);
drh0fe7e7d2022-02-01 14:58:29 +00001600 }else if( bIn && sqlite3ExprVectorSize(pTerm->pExpr->pLeft)==1 ){
drhdbc49162016-03-02 03:28:07 +00001601 Expr *pCompare; /* The comparison operator */
1602 Expr *pRight; /* RHS of the comparison */
1603 VdbeOp *pOp; /* Opcode to access the value of the IN constraint */
1604
1605 /* Reload the constraint value into reg[iReg+j+2]. The same value
1606 ** was loaded into the same register prior to the OP_VFilter, but
1607 ** the xFilter implementation might have changed the datatype or
1608 ** encoding of the value in the register, so it *must* be reloaded. */
1609 assert( pLevel->u.in.aInLoop!=0 || db->mallocFailed );
drhfb826b82016-03-08 00:39:58 +00001610 if( !db->mallocFailed ){
drh68748ec2019-10-14 20:32:31 +00001611 assert( iIn>=0 && iIn<pLevel->u.in.nIn );
1612 pOp = sqlite3VdbeGetOp(v, pLevel->u.in.aInLoop[iIn].addrInTop);
drhdbc49162016-03-02 03:28:07 +00001613 assert( pOp->opcode==OP_Column || pOp->opcode==OP_Rowid );
1614 assert( pOp->opcode!=OP_Column || pOp->p3==iReg+j+2 );
1615 assert( pOp->opcode!=OP_Rowid || pOp->p2==iReg+j+2 );
1616 testcase( pOp->opcode==OP_Rowid );
1617 sqlite3VdbeAddOp3(v, pOp->opcode, pOp->p1, pOp->p2, pOp->p3);
1618 }
1619
1620 /* Generate code that will continue to the next row if
1621 ** the IN constraint is not satisfied */
drhabfd35e2016-12-06 22:47:23 +00001622 pCompare = sqlite3PExpr(pParse, TK_EQ, 0, 0);
drhdbc49162016-03-02 03:28:07 +00001623 assert( pCompare!=0 || db->mallocFailed );
1624 if( pCompare ){
1625 pCompare->pLeft = pTerm->pExpr->pLeft;
1626 pCompare->pRight = pRight = sqlite3Expr(db, TK_REGISTER, 0);
drh237b2b72016-03-07 19:08:27 +00001627 if( pRight ){
1628 pRight->iTable = iReg+j+2;
dand03f77a2020-01-29 15:03:01 +00001629 sqlite3ExprIfFalse(
1630 pParse, pCompare, pLevel->addrCont, SQLITE_JUMPIFNULL
1631 );
drh237b2b72016-03-07 19:08:27 +00001632 }
drhdbc49162016-03-02 03:28:07 +00001633 pCompare->pLeft = 0;
1634 sqlite3ExprDelete(db, pCompare);
1635 }
1636 }
1637 }
drh68748ec2019-10-14 20:32:31 +00001638 assert( iIn==0 || db->mallocFailed );
drhba26faa2016-04-09 18:04:28 +00001639 /* These registers need to be preserved in case there is an IN operator
1640 ** loop. So we could deallocate the registers here (and potentially
1641 ** reuse them later) if (pLoop->wsFlags & WHERE_IN_ABLE)==0. But it seems
1642 ** simpler and safer to simply not reuse the registers.
1643 **
1644 ** sqlite3ReleaseTempRange(pParse, iReg, nConstraint+2);
1645 */
drh6f82e852015-06-06 20:12:09 +00001646 }else
1647#endif /* SQLITE_OMIT_VIRTUALTABLE */
1648
1649 if( (pLoop->wsFlags & WHERE_IPK)!=0
1650 && (pLoop->wsFlags & (WHERE_COLUMN_IN|WHERE_COLUMN_EQ))!=0
1651 ){
1652 /* Case 2: We can directly reference a single row using an
1653 ** equality comparison against the ROWID field. Or
1654 ** we reference multiple rows using a "rowid IN (...)"
1655 ** construct.
1656 */
1657 assert( pLoop->u.btree.nEq==1 );
1658 pTerm = pLoop->aLTerm[0];
1659 assert( pTerm!=0 );
1660 assert( pTerm->pExpr!=0 );
drh6f82e852015-06-06 20:12:09 +00001661 testcase( pTerm->wtFlags & TERM_VIRTUAL );
1662 iReleaseReg = ++pParse->nMem;
1663 iRowidReg = codeEqualityTerm(pParse, pTerm, pLevel, 0, bRev, iReleaseReg);
1664 if( iRowidReg!=iReleaseReg ) sqlite3ReleaseTempReg(pParse, iReleaseReg);
1665 addrNxt = pLevel->addrNxt;
drh2db144c2021-12-01 16:31:02 +00001666 if( pLevel->regFilter ){
1667 sqlite3VdbeAddOp4Int(v, OP_Filter, pLevel->regFilter, addrNxt,
1668 iRowidReg, 1);
drh067c60c2021-12-04 18:45:08 +00001669 VdbeCoverage(v);
drh35685d32021-12-05 00:45:55 +00001670 filterPullDown(pParse, pWInfo, iLevel, addrNxt, notReady);
drh2db144c2021-12-01 16:31:02 +00001671 }
drheeb95652016-05-26 20:56:38 +00001672 sqlite3VdbeAddOp3(v, OP_SeekRowid, iCur, addrNxt, iRowidReg);
drh6f82e852015-06-06 20:12:09 +00001673 VdbeCoverage(v);
drh6f82e852015-06-06 20:12:09 +00001674 pLevel->op = OP_Noop;
1675 }else if( (pLoop->wsFlags & WHERE_IPK)!=0
1676 && (pLoop->wsFlags & WHERE_COLUMN_RANGE)!=0
1677 ){
1678 /* Case 3: We have an inequality comparison against the ROWID field.
1679 */
1680 int testOp = OP_Noop;
1681 int start;
1682 int memEndValue = 0;
1683 WhereTerm *pStart, *pEnd;
1684
drh6f82e852015-06-06 20:12:09 +00001685 j = 0;
1686 pStart = pEnd = 0;
1687 if( pLoop->wsFlags & WHERE_BTM_LIMIT ) pStart = pLoop->aLTerm[j++];
1688 if( pLoop->wsFlags & WHERE_TOP_LIMIT ) pEnd = pLoop->aLTerm[j++];
1689 assert( pStart!=0 || pEnd!=0 );
1690 if( bRev ){
1691 pTerm = pStart;
1692 pStart = pEnd;
1693 pEnd = pTerm;
1694 }
danb324cf72016-06-17 14:33:32 +00001695 codeCursorHint(pTabItem, pWInfo, pLevel, pEnd);
drh6f82e852015-06-06 20:12:09 +00001696 if( pStart ){
1697 Expr *pX; /* The expression that defines the start bound */
1698 int r1, rTemp; /* Registers for holding the start boundary */
dan19ff12d2016-07-29 20:58:19 +00001699 int op; /* Cursor seek operation */
drh6f82e852015-06-06 20:12:09 +00001700
1701 /* The following constant maps TK_xx codes into corresponding
1702 ** seek opcodes. It depends on a particular ordering of TK_xx
1703 */
1704 const u8 aMoveOp[] = {
1705 /* TK_GT */ OP_SeekGT,
1706 /* TK_LE */ OP_SeekLE,
1707 /* TK_LT */ OP_SeekLT,
1708 /* TK_GE */ OP_SeekGE
1709 };
1710 assert( TK_LE==TK_GT+1 ); /* Make sure the ordering.. */
1711 assert( TK_LT==TK_GT+2 ); /* ... of the TK_xx values... */
1712 assert( TK_GE==TK_GT+3 ); /* ... is correcct. */
1713
1714 assert( (pStart->wtFlags & TERM_VNULL)==0 );
1715 testcase( pStart->wtFlags & TERM_VIRTUAL );
1716 pX = pStart->pExpr;
1717 assert( pX!=0 );
1718 testcase( pStart->leftCursor!=iCur ); /* transitive constraints */
dan625015e2016-07-30 16:39:28 +00001719 if( sqlite3ExprIsVector(pX->pRight) ){
dan19ff12d2016-07-29 20:58:19 +00001720 r1 = rTemp = sqlite3GetTempReg(pParse);
1721 codeExprOrVector(pParse, pX->pRight, r1, 1);
drh4d1c6842018-02-13 18:48:08 +00001722 testcase( pX->op==TK_GT );
1723 testcase( pX->op==TK_GE );
1724 testcase( pX->op==TK_LT );
1725 testcase( pX->op==TK_LE );
1726 op = aMoveOp[((pX->op - TK_GT - 1) & 0x3) | 0x1];
1727 assert( pX->op!=TK_GT || op==OP_SeekGE );
1728 assert( pX->op!=TK_GE || op==OP_SeekGE );
1729 assert( pX->op!=TK_LT || op==OP_SeekLE );
1730 assert( pX->op!=TK_LE || op==OP_SeekLE );
dan19ff12d2016-07-29 20:58:19 +00001731 }else{
1732 r1 = sqlite3ExprCodeTemp(pParse, pX->pRight, &rTemp);
1733 disableTerm(pLevel, pStart);
1734 op = aMoveOp[(pX->op - TK_GT)];
1735 }
1736 sqlite3VdbeAddOp3(v, op, iCur, addrBrk, r1);
drh6f82e852015-06-06 20:12:09 +00001737 VdbeComment((v, "pk"));
1738 VdbeCoverageIf(v, pX->op==TK_GT);
1739 VdbeCoverageIf(v, pX->op==TK_LE);
1740 VdbeCoverageIf(v, pX->op==TK_LT);
1741 VdbeCoverageIf(v, pX->op==TK_GE);
drh6f82e852015-06-06 20:12:09 +00001742 sqlite3ReleaseTempReg(pParse, rTemp);
drh6f82e852015-06-06 20:12:09 +00001743 }else{
drh3a3b4202017-02-15 22:36:15 +00001744 sqlite3VdbeAddOp2(v, bRev ? OP_Last : OP_Rewind, iCur, addrHalt);
drh6f82e852015-06-06 20:12:09 +00001745 VdbeCoverageIf(v, bRev==0);
1746 VdbeCoverageIf(v, bRev!=0);
1747 }
1748 if( pEnd ){
1749 Expr *pX;
1750 pX = pEnd->pExpr;
1751 assert( pX!=0 );
1752 assert( (pEnd->wtFlags & TERM_VNULL)==0 );
1753 testcase( pEnd->leftCursor!=iCur ); /* Transitive constraints */
1754 testcase( pEnd->wtFlags & TERM_VIRTUAL );
1755 memEndValue = ++pParse->nMem;
dan19ff12d2016-07-29 20:58:19 +00001756 codeExprOrVector(pParse, pX->pRight, memEndValue, 1);
dan625015e2016-07-30 16:39:28 +00001757 if( 0==sqlite3ExprIsVector(pX->pRight)
1758 && (pX->op==TK_LT || pX->op==TK_GT)
1759 ){
drh6f82e852015-06-06 20:12:09 +00001760 testOp = bRev ? OP_Le : OP_Ge;
1761 }else{
1762 testOp = bRev ? OP_Lt : OP_Gt;
1763 }
dan553168c2016-08-01 20:14:31 +00001764 if( 0==sqlite3ExprIsVector(pX->pRight) ){
1765 disableTerm(pLevel, pEnd);
1766 }
drh6f82e852015-06-06 20:12:09 +00001767 }
1768 start = sqlite3VdbeCurrentAddr(v);
1769 pLevel->op = bRev ? OP_Prev : OP_Next;
1770 pLevel->p1 = iCur;
1771 pLevel->p2 = start;
1772 assert( pLevel->p5==0 );
1773 if( testOp!=OP_Noop ){
1774 iRowidReg = ++pParse->nMem;
1775 sqlite3VdbeAddOp2(v, OP_Rowid, iCur, iRowidReg);
drh6f82e852015-06-06 20:12:09 +00001776 sqlite3VdbeAddOp3(v, testOp, memEndValue, addrBrk, iRowidReg);
1777 VdbeCoverageIf(v, testOp==OP_Le);
1778 VdbeCoverageIf(v, testOp==OP_Lt);
1779 VdbeCoverageIf(v, testOp==OP_Ge);
1780 VdbeCoverageIf(v, testOp==OP_Gt);
1781 sqlite3VdbeChangeP5(v, SQLITE_AFF_NUMERIC | SQLITE_JUMPIFNULL);
1782 }
1783 }else if( pLoop->wsFlags & WHERE_INDEXED ){
1784 /* Case 4: A scan using an index.
1785 **
1786 ** The WHERE clause may contain zero or more equality
1787 ** terms ("==" or "IN" operators) that refer to the N
1788 ** left-most columns of the index. It may also contain
1789 ** inequality constraints (>, <, >= or <=) on the indexed
1790 ** column that immediately follows the N equalities. Only
1791 ** the right-most column can be an inequality - the rest must
1792 ** use the "==" and "IN" operators. For example, if the
1793 ** index is on (x,y,z), then the following clauses are all
1794 ** optimized:
1795 **
1796 ** x=5
1797 ** x=5 AND y=10
1798 ** x=5 AND y<10
1799 ** x=5 AND y>5 AND y<10
1800 ** x=5 AND y=5 AND z<=10
1801 **
1802 ** The z<10 term of the following cannot be used, only
1803 ** the x=5 term:
1804 **
1805 ** x=5 AND z<10
1806 **
1807 ** N may be zero if there are inequality constraints.
1808 ** If there are no inequality constraints, then N is at
1809 ** least one.
1810 **
1811 ** This case is also used when there are no WHERE clause
1812 ** constraints but an index is selected anyway, in order
1813 ** to force the output order to conform to an ORDER BY.
1814 */
1815 static const u8 aStartOp[] = {
1816 0,
1817 0,
1818 OP_Rewind, /* 2: (!start_constraints && startEq && !bRev) */
1819 OP_Last, /* 3: (!start_constraints && startEq && bRev) */
1820 OP_SeekGT, /* 4: (start_constraints && !startEq && !bRev) */
1821 OP_SeekLT, /* 5: (start_constraints && !startEq && bRev) */
1822 OP_SeekGE, /* 6: (start_constraints && startEq && !bRev) */
1823 OP_SeekLE /* 7: (start_constraints && startEq && bRev) */
1824 };
1825 static const u8 aEndOp[] = {
1826 OP_IdxGE, /* 0: (end_constraints && !bRev && !endEq) */
1827 OP_IdxGT, /* 1: (end_constraints && !bRev && endEq) */
1828 OP_IdxLE, /* 2: (end_constraints && bRev && !endEq) */
1829 OP_IdxLT, /* 3: (end_constraints && bRev && endEq) */
1830 };
1831 u16 nEq = pLoop->u.btree.nEq; /* Number of == or IN terms */
dan71c57db2016-07-09 20:23:55 +00001832 u16 nBtm = pLoop->u.btree.nBtm; /* Length of BTM vector */
1833 u16 nTop = pLoop->u.btree.nTop; /* Length of TOP vector */
drh6f82e852015-06-06 20:12:09 +00001834 int regBase; /* Base register holding constraint values */
1835 WhereTerm *pRangeStart = 0; /* Inequality constraint at range start */
1836 WhereTerm *pRangeEnd = 0; /* Inequality constraint at range end */
1837 int startEq; /* True if range start uses ==, >= or <= */
1838 int endEq; /* True if range end uses ==, >= or <= */
1839 int start_constraints; /* Start of range is constrained */
1840 int nConstraint; /* Number of constraint terms */
drh6f82e852015-06-06 20:12:09 +00001841 int iIdxCur; /* The VDBE cursor for the index */
1842 int nExtraReg = 0; /* Number of extra registers needed */
1843 int op; /* Instruction opcode */
1844 char *zStartAff; /* Affinity for start of range constraint */
danb7ca2172016-08-26 17:54:46 +00001845 char *zEndAff = 0; /* Affinity for end of range constraint */
drh6f82e852015-06-06 20:12:09 +00001846 u8 bSeekPastNull = 0; /* True to seek past initial nulls */
1847 u8 bStopAtNull = 0; /* Add condition to terminate at NULLs */
drh47df8a22018-12-25 00:15:37 +00001848 int omitTable; /* True if we use the index only */
drh74e1b862019-08-23 13:08:49 +00001849 int regBignull = 0; /* big-null flag register */
drh04e70ce2020-10-02 11:55:07 +00001850 int addrSeekScan = 0; /* Opcode of the OP_SeekScan, if any */
drh6f82e852015-06-06 20:12:09 +00001851
1852 pIdx = pLoop->u.btree.pIndex;
1853 iIdxCur = pLevel->iIdxCur;
1854 assert( nEq>=pLoop->nSkip );
1855
drh6f82e852015-06-06 20:12:09 +00001856 /* Find any inequality constraint terms for the start and end
1857 ** of the range.
1858 */
1859 j = nEq;
1860 if( pLoop->wsFlags & WHERE_BTM_LIMIT ){
1861 pRangeStart = pLoop->aLTerm[j++];
dan71c57db2016-07-09 20:23:55 +00001862 nExtraReg = MAX(nExtraReg, pLoop->u.btree.nBtm);
drh6f82e852015-06-06 20:12:09 +00001863 /* Like optimization range constraints always occur in pairs */
1864 assert( (pRangeStart->wtFlags & TERM_LIKEOPT)==0 ||
1865 (pLoop->wsFlags & WHERE_TOP_LIMIT)!=0 );
1866 }
1867 if( pLoop->wsFlags & WHERE_TOP_LIMIT ){
1868 pRangeEnd = pLoop->aLTerm[j++];
dan71c57db2016-07-09 20:23:55 +00001869 nExtraReg = MAX(nExtraReg, pLoop->u.btree.nTop);
drh41d2e662015-12-01 21:23:07 +00001870#ifndef SQLITE_LIKE_DOESNT_MATCH_BLOBS
drh6f82e852015-06-06 20:12:09 +00001871 if( (pRangeEnd->wtFlags & TERM_LIKEOPT)!=0 ){
1872 assert( pRangeStart!=0 ); /* LIKE opt constraints */
1873 assert( pRangeStart->wtFlags & TERM_LIKEOPT ); /* occur in pairs */
drh44aebff2016-05-02 10:25:42 +00001874 pLevel->iLikeRepCntr = (u32)++pParse->nMem;
1875 sqlite3VdbeAddOp2(v, OP_Integer, 1, (int)pLevel->iLikeRepCntr);
drh6f82e852015-06-06 20:12:09 +00001876 VdbeComment((v, "LIKE loop counter"));
1877 pLevel->addrLikeRep = sqlite3VdbeCurrentAddr(v);
drh44aebff2016-05-02 10:25:42 +00001878 /* iLikeRepCntr actually stores 2x the counter register number. The
1879 ** bottom bit indicates whether the search order is ASC or DESC. */
1880 testcase( bRev );
1881 testcase( pIdx->aSortOrder[nEq]==SQLITE_SO_DESC );
1882 assert( (bRev & ~1)==0 );
1883 pLevel->iLikeRepCntr <<=1;
1884 pLevel->iLikeRepCntr |= bRev ^ (pIdx->aSortOrder[nEq]==SQLITE_SO_DESC);
drh6f82e852015-06-06 20:12:09 +00001885 }
drh41d2e662015-12-01 21:23:07 +00001886#endif
drh48590fc2016-10-10 13:29:15 +00001887 if( pRangeStart==0 ){
1888 j = pIdx->aiColumn[nEq];
1889 if( (j>=0 && pIdx->pTable->aCol[j].notNull==0) || j==XN_EXPR ){
1890 bSeekPastNull = 1;
1891 }
drh6f82e852015-06-06 20:12:09 +00001892 }
1893 }
1894 assert( pRangeEnd==0 || (pRangeEnd->wtFlags & TERM_VNULL)==0 );
1895
dan15750a22019-08-16 21:07:19 +00001896 /* If the WHERE_BIGNULL_SORT flag is set, then index column nEq uses
1897 ** a non-default "big-null" sort (either ASC NULLS LAST or DESC NULLS
1898 ** FIRST). In both cases separate ordered scans are made of those
1899 ** index entries for which the column is null and for those for which
1900 ** it is not. For an ASC sort, the non-NULL entries are scanned first.
1901 ** For DESC, NULL entries are scanned first.
1902 */
dan15750a22019-08-16 21:07:19 +00001903 if( (pLoop->wsFlags & (WHERE_TOP_LIMIT|WHERE_BTM_LIMIT))==0
1904 && (pLoop->wsFlags & WHERE_BIGNULL_SORT)!=0
1905 ){
1906 assert( bSeekPastNull==0 && nExtraReg==0 && nBtm==0 && nTop==0 );
1907 assert( pRangeEnd==0 && pRangeStart==0 );
dan4adb1d02019-12-28 18:08:39 +00001908 testcase( pLoop->nSkip>0 );
dan15750a22019-08-16 21:07:19 +00001909 nExtraReg = 1;
1910 bSeekPastNull = 1;
1911 pLevel->regBignull = regBignull = ++pParse->nMem;
drh7f05d522020-03-02 01:16:33 +00001912 if( pLevel->iLeftJoin ){
1913 sqlite3VdbeAddOp2(v, OP_Integer, 0, regBignull);
1914 }
dancc491f42019-08-17 17:55:54 +00001915 pLevel->addrBignull = sqlite3VdbeMakeLabel(pParse);
dan15750a22019-08-16 21:07:19 +00001916 }
1917
drh6f82e852015-06-06 20:12:09 +00001918 /* If we are doing a reverse order scan on an ascending index, or
1919 ** a forward order scan on a descending index, interchange the
1920 ** start and end terms (pRangeStart and pRangeEnd).
1921 */
drh7ffb16b2021-05-12 22:15:44 +00001922 if( (nEq<pIdx->nColumn && bRev==(pIdx->aSortOrder[nEq]==SQLITE_SO_ASC)) ){
drh6f82e852015-06-06 20:12:09 +00001923 SWAP(WhereTerm *, pRangeEnd, pRangeStart);
1924 SWAP(u8, bSeekPastNull, bStopAtNull);
dan71c57db2016-07-09 20:23:55 +00001925 SWAP(u8, nBtm, nTop);
drh6f82e852015-06-06 20:12:09 +00001926 }
1927
dandf1b52e2021-01-27 17:15:06 +00001928 if( iLevel>0 && (pLoop->wsFlags & WHERE_IN_SEEKSCAN)!=0 ){
1929 /* In case OP_SeekScan is used, ensure that the index cursor does not
1930 ** point to a valid row for the first iteration of this loop. */
1931 sqlite3VdbeAddOp1(v, OP_NullRow, iIdxCur);
1932 }
1933
drhbcf40a72015-08-18 15:58:05 +00001934 /* Generate code to evaluate all constraint terms using == or IN
1935 ** and store the values of those terms in an array of registers
1936 ** starting at regBase.
1937 */
danb324cf72016-06-17 14:33:32 +00001938 codeCursorHint(pTabItem, pWInfo, pLevel, pRangeEnd);
drhbcf40a72015-08-18 15:58:05 +00001939 regBase = codeAllEqualityTerms(pParse,pLevel,bRev,nExtraReg,&zStartAff);
1940 assert( zStartAff==0 || sqlite3Strlen30(zStartAff)>=nEq );
danb7ca2172016-08-26 17:54:46 +00001941 if( zStartAff && nTop ){
1942 zEndAff = sqlite3DbStrDup(db, &zStartAff[nEq]);
1943 }
dancc491f42019-08-17 17:55:54 +00001944 addrNxt = (regBignull ? pLevel->addrBignull : pLevel->addrNxt);
drhbcf40a72015-08-18 15:58:05 +00001945
drh6f82e852015-06-06 20:12:09 +00001946 testcase( pRangeStart && (pRangeStart->eOperator & WO_LE)!=0 );
1947 testcase( pRangeStart && (pRangeStart->eOperator & WO_GE)!=0 );
1948 testcase( pRangeEnd && (pRangeEnd->eOperator & WO_LE)!=0 );
1949 testcase( pRangeEnd && (pRangeEnd->eOperator & WO_GE)!=0 );
1950 startEq = !pRangeStart || pRangeStart->eOperator & (WO_LE|WO_GE);
1951 endEq = !pRangeEnd || pRangeEnd->eOperator & (WO_LE|WO_GE);
1952 start_constraints = pRangeStart || nEq>0;
1953
1954 /* Seek the index cursor to the start of the range. */
1955 nConstraint = nEq;
1956 if( pRangeStart ){
1957 Expr *pRight = pRangeStart->pExpr->pRight;
dan71c57db2016-07-09 20:23:55 +00001958 codeExprOrVector(pParse, pRight, regBase+nEq, nBtm);
drh6f82e852015-06-06 20:12:09 +00001959 whereLikeOptimizationStringFixup(v, pLevel, pRangeStart);
drh395a60d2020-09-30 17:32:22 +00001960 if( (pRangeStart->wtFlags & TERM_VNULL)==0
drh6f82e852015-06-06 20:12:09 +00001961 && sqlite3ExprCanBeNull(pRight)
1962 ){
1963 sqlite3VdbeAddOp2(v, OP_IsNull, regBase+nEq, addrNxt);
1964 VdbeCoverage(v);
1965 }
1966 if( zStartAff ){
drhe3c6b612016-10-05 20:10:32 +00001967 updateRangeAffinityStr(pRight, nBtm, &zStartAff[nEq]);
drh6f82e852015-06-06 20:12:09 +00001968 }
dan71c57db2016-07-09 20:23:55 +00001969 nConstraint += nBtm;
drh6f82e852015-06-06 20:12:09 +00001970 testcase( pRangeStart->wtFlags & TERM_VIRTUAL );
dan625015e2016-07-30 16:39:28 +00001971 if( sqlite3ExprIsVector(pRight)==0 ){
dan71c57db2016-07-09 20:23:55 +00001972 disableTerm(pLevel, pRangeStart);
1973 }else{
1974 startEq = 1;
1975 }
drh426f4ab2016-07-26 04:31:14 +00001976 bSeekPastNull = 0;
drh6f82e852015-06-06 20:12:09 +00001977 }else if( bSeekPastNull ){
drh6f82e852015-06-06 20:12:09 +00001978 startEq = 0;
drh0086e072019-08-23 16:12:20 +00001979 sqlite3VdbeAddOp2(v, OP_Null, 0, regBase+nEq);
drh6f82e852015-06-06 20:12:09 +00001980 start_constraints = 1;
drh0086e072019-08-23 16:12:20 +00001981 nConstraint++;
dan15750a22019-08-16 21:07:19 +00001982 }else if( regBignull ){
1983 sqlite3VdbeAddOp2(v, OP_Null, 0, regBase+nEq);
1984 start_constraints = 1;
1985 nConstraint++;
drh6f82e852015-06-06 20:12:09 +00001986 }
1987 codeApplyAffinity(pParse, regBase, nConstraint - bSeekPastNull, zStartAff);
drh0bf2ad62016-02-22 21:19:54 +00001988 if( pLoop->nSkip>0 && nConstraint==pLoop->nSkip ){
1989 /* The skip-scan logic inside the call to codeAllEqualityConstraints()
1990 ** above has already left the cursor sitting on the correct row,
1991 ** so no further seeking is needed */
1992 }else{
dan15750a22019-08-16 21:07:19 +00001993 if( regBignull ){
drhec3dda52019-08-23 13:32:03 +00001994 sqlite3VdbeAddOp2(v, OP_Integer, 1, regBignull);
drha31d3552019-08-23 17:09:02 +00001995 VdbeComment((v, "NULL-scan pass ctr"));
dan15750a22019-08-16 21:07:19 +00001996 }
drh2db144c2021-12-01 16:31:02 +00001997 if( pLevel->regFilter ){
1998 sqlite3VdbeAddOp4Int(v, OP_Filter, pLevel->regFilter, addrNxt,
drh770dade2021-12-04 14:24:30 +00001999 regBase, nEq);
drh067c60c2021-12-04 18:45:08 +00002000 VdbeCoverage(v);
drh35685d32021-12-05 00:45:55 +00002001 filterPullDown(pParse, pWInfo, iLevel, addrNxt, notReady);
drh2db144c2021-12-01 16:31:02 +00002002 }
dan15750a22019-08-16 21:07:19 +00002003
drha6d2f8e2016-02-22 20:52:26 +00002004 op = aStartOp[(start_constraints<<2) + (startEq<<1) + bRev];
2005 assert( op!=0 );
drh7d14ffe2020-10-02 13:48:57 +00002006 if( (pLoop->wsFlags & WHERE_IN_SEEKSCAN)!=0 && op==OP_SeekGE ){
drh68cf0ac2020-09-28 19:51:54 +00002007 assert( regBignull==0 );
drh4f65b3b2020-09-30 18:03:22 +00002008 /* TUNING: The OP_SeekScan opcode seeks to reduce the number
2009 ** of expensive seek operations by replacing a single seek with
2010 ** 1 or more step operations. The question is, how many steps
2011 ** should we try before giving up and going with a seek. The cost
2012 ** of a seek is proportional to the logarithm of the of the number
2013 ** of entries in the tree, so basing the number of steps to try
2014 ** on the estimated number of rows in the btree seems like a good
2015 ** guess. */
drh04e70ce2020-10-02 11:55:07 +00002016 addrSeekScan = sqlite3VdbeAddOp1(v, OP_SeekScan,
2017 (pIdx->aiRowLogEst[0]+9)/10);
drh4f65b3b2020-09-30 18:03:22 +00002018 VdbeCoverage(v);
drh68cf0ac2020-09-28 19:51:54 +00002019 }
drha6d2f8e2016-02-22 20:52:26 +00002020 sqlite3VdbeAddOp4Int(v, op, iIdxCur, addrNxt, regBase, nConstraint);
2021 VdbeCoverage(v);
2022 VdbeCoverageIf(v, op==OP_Rewind); testcase( op==OP_Rewind );
2023 VdbeCoverageIf(v, op==OP_Last); testcase( op==OP_Last );
2024 VdbeCoverageIf(v, op==OP_SeekGT); testcase( op==OP_SeekGT );
2025 VdbeCoverageIf(v, op==OP_SeekGE); testcase( op==OP_SeekGE );
2026 VdbeCoverageIf(v, op==OP_SeekLE); testcase( op==OP_SeekLE );
2027 VdbeCoverageIf(v, op==OP_SeekLT); testcase( op==OP_SeekLT );
danddd74212019-08-02 18:43:59 +00002028
drh0086e072019-08-23 16:12:20 +00002029 assert( bSeekPastNull==0 || bStopAtNull==0 );
dan15750a22019-08-16 21:07:19 +00002030 if( regBignull ){
drh0086e072019-08-23 16:12:20 +00002031 assert( bSeekPastNull==1 || bStopAtNull==1 );
drh5f6a4ea2019-08-23 17:00:22 +00002032 assert( bSeekPastNull==!bStopAtNull );
drh0086e072019-08-23 16:12:20 +00002033 assert( bStopAtNull==startEq );
danddd74212019-08-02 18:43:59 +00002034 sqlite3VdbeAddOp2(v, OP_Goto, 0, sqlite3VdbeCurrentAddr(v)+2);
drh0086e072019-08-23 16:12:20 +00002035 op = aStartOp[(nConstraint>1)*4 + 2 + bRev];
2036 sqlite3VdbeAddOp4Int(v, op, iIdxCur, addrNxt, regBase,
2037 nConstraint-startEq);
2038 VdbeCoverage(v);
2039 VdbeCoverageIf(v, op==OP_Rewind); testcase( op==OP_Rewind );
2040 VdbeCoverageIf(v, op==OP_Last); testcase( op==OP_Last );
2041 VdbeCoverageIf(v, op==OP_SeekGE); testcase( op==OP_SeekGE );
2042 VdbeCoverageIf(v, op==OP_SeekLE); testcase( op==OP_SeekLE );
2043 assert( op==OP_Rewind || op==OP_Last || op==OP_SeekGE || op==OP_SeekLE);
danddd74212019-08-02 18:43:59 +00002044 }
drha6d2f8e2016-02-22 20:52:26 +00002045 }
drh0bf2ad62016-02-22 21:19:54 +00002046
drh6f82e852015-06-06 20:12:09 +00002047 /* Load the value for the inequality constraint at the end of the
2048 ** range (if any).
2049 */
2050 nConstraint = nEq;
drh5d742e32021-11-02 20:52:20 +00002051 assert( pLevel->p2==0 );
drh6f82e852015-06-06 20:12:09 +00002052 if( pRangeEnd ){
2053 Expr *pRight = pRangeEnd->pExpr->pRight;
drh5d742e32021-11-02 20:52:20 +00002054 if( addrSeekScan ){
2055 /* For a seek-scan that has a range on the lowest term of the index,
2056 ** we have to make the top of the loop be code that sets the end
2057 ** condition of the range. Otherwise, the OP_SeekScan might jump
2058 ** over that initialization, leaving the range-end value set to the
2059 ** range-start value, resulting in a wrong answer.
2060 ** See ticket 5981a8c041a3c2f3 (2021-11-02).
2061 */
2062 pLevel->p2 = sqlite3VdbeCurrentAddr(v);
2063 }
dan71c57db2016-07-09 20:23:55 +00002064 codeExprOrVector(pParse, pRight, regBase+nEq, nTop);
drh6f82e852015-06-06 20:12:09 +00002065 whereLikeOptimizationStringFixup(v, pLevel, pRangeEnd);
drh395a60d2020-09-30 17:32:22 +00002066 if( (pRangeEnd->wtFlags & TERM_VNULL)==0
drh6f82e852015-06-06 20:12:09 +00002067 && sqlite3ExprCanBeNull(pRight)
2068 ){
2069 sqlite3VdbeAddOp2(v, OP_IsNull, regBase+nEq, addrNxt);
2070 VdbeCoverage(v);
2071 }
drh0c36fca2016-08-26 18:17:08 +00002072 if( zEndAff ){
drhe3c6b612016-10-05 20:10:32 +00002073 updateRangeAffinityStr(pRight, nTop, zEndAff);
drh0c36fca2016-08-26 18:17:08 +00002074 codeApplyAffinity(pParse, regBase+nEq, nTop, zEndAff);
2075 }else{
2076 assert( pParse->db->mallocFailed );
2077 }
dan71c57db2016-07-09 20:23:55 +00002078 nConstraint += nTop;
drh6f82e852015-06-06 20:12:09 +00002079 testcase( pRangeEnd->wtFlags & TERM_VIRTUAL );
dan71c57db2016-07-09 20:23:55 +00002080
dan625015e2016-07-30 16:39:28 +00002081 if( sqlite3ExprIsVector(pRight)==0 ){
dan71c57db2016-07-09 20:23:55 +00002082 disableTerm(pLevel, pRangeEnd);
2083 }else{
2084 endEq = 1;
2085 }
drh6f82e852015-06-06 20:12:09 +00002086 }else if( bStopAtNull ){
dan15750a22019-08-16 21:07:19 +00002087 if( regBignull==0 ){
2088 sqlite3VdbeAddOp2(v, OP_Null, 0, regBase+nEq);
2089 endEq = 0;
2090 }
drh6f82e852015-06-06 20:12:09 +00002091 nConstraint++;
2092 }
2093 sqlite3DbFree(db, zStartAff);
danb7ca2172016-08-26 17:54:46 +00002094 sqlite3DbFree(db, zEndAff);
drh6f82e852015-06-06 20:12:09 +00002095
2096 /* Top of the loop body */
drh5d742e32021-11-02 20:52:20 +00002097 if( pLevel->p2==0 ) pLevel->p2 = sqlite3VdbeCurrentAddr(v);
drh6f82e852015-06-06 20:12:09 +00002098
2099 /* Check if the index cursor is past the end of the range. */
2100 if( nConstraint ){
dan15750a22019-08-16 21:07:19 +00002101 if( regBignull ){
drh5f6a4ea2019-08-23 17:00:22 +00002102 /* Except, skip the end-of-range check while doing the NULL-scan */
drhec3dda52019-08-23 13:32:03 +00002103 sqlite3VdbeAddOp2(v, OP_IfNot, regBignull, sqlite3VdbeCurrentAddr(v)+3);
drha31d3552019-08-23 17:09:02 +00002104 VdbeComment((v, "If NULL-scan 2nd pass"));
drh505ae9d2019-08-22 21:13:56 +00002105 VdbeCoverage(v);
dan15750a22019-08-16 21:07:19 +00002106 }
drh6f82e852015-06-06 20:12:09 +00002107 op = aEndOp[bRev*2 + endEq];
2108 sqlite3VdbeAddOp4Int(v, op, iIdxCur, addrNxt, regBase, nConstraint);
2109 testcase( op==OP_IdxGT ); VdbeCoverageIf(v, op==OP_IdxGT );
2110 testcase( op==OP_IdxGE ); VdbeCoverageIf(v, op==OP_IdxGE );
2111 testcase( op==OP_IdxLT ); VdbeCoverageIf(v, op==OP_IdxLT );
2112 testcase( op==OP_IdxLE ); VdbeCoverageIf(v, op==OP_IdxLE );
drh04e70ce2020-10-02 11:55:07 +00002113 if( addrSeekScan ) sqlite3VdbeJumpHere(v, addrSeekScan);
drh6f82e852015-06-06 20:12:09 +00002114 }
dan15750a22019-08-16 21:07:19 +00002115 if( regBignull ){
drh5f6a4ea2019-08-23 17:00:22 +00002116 /* During a NULL-scan, check to see if we have reached the end of
2117 ** the NULLs */
2118 assert( bSeekPastNull==!bStopAtNull );
2119 assert( bSeekPastNull+bStopAtNull==1 );
2120 assert( nConstraint+bSeekPastNull>0 );
drhec3dda52019-08-23 13:32:03 +00002121 sqlite3VdbeAddOp2(v, OP_If, regBignull, sqlite3VdbeCurrentAddr(v)+2);
drha31d3552019-08-23 17:09:02 +00002122 VdbeComment((v, "If NULL-scan 1st pass"));
drh505ae9d2019-08-22 21:13:56 +00002123 VdbeCoverage(v);
drh5f6a4ea2019-08-23 17:00:22 +00002124 op = aEndOp[bRev*2 + bSeekPastNull];
2125 sqlite3VdbeAddOp4Int(v, op, iIdxCur, addrNxt, regBase,
2126 nConstraint+bSeekPastNull);
2127 testcase( op==OP_IdxGT ); VdbeCoverageIf(v, op==OP_IdxGT );
2128 testcase( op==OP_IdxGE ); VdbeCoverageIf(v, op==OP_IdxGE );
2129 testcase( op==OP_IdxLT ); VdbeCoverageIf(v, op==OP_IdxLT );
2130 testcase( op==OP_IdxLE ); VdbeCoverageIf(v, op==OP_IdxLE );
dan15750a22019-08-16 21:07:19 +00002131 }
drh6f82e852015-06-06 20:12:09 +00002132
drhf761d932020-09-29 01:48:46 +00002133 if( (pLoop->wsFlags & WHERE_IN_EARLYOUT)!=0 ){
drhfa17e132020-09-01 01:52:03 +00002134 sqlite3VdbeAddOp3(v, OP_SeekHit, iIdxCur, nEq, nEq);
drh8c2b6d72018-06-05 20:45:20 +00002135 }
2136
drh6f82e852015-06-06 20:12:09 +00002137 /* Seek the table cursor, if required */
drh47df8a22018-12-25 00:15:37 +00002138 omitTable = (pLoop->wsFlags & WHERE_IDX_ONLY)!=0
2139 && (pWInfo->wctrlFlags & WHERE_OR_SUBCLAUSE)==0;
drh6f82e852015-06-06 20:12:09 +00002140 if( omitTable ){
2141 /* pIdx is a covering index. No need to access the main table. */
2142 }else if( HasRowid(pIdx->pTable) ){
drh68c0c712020-08-14 20:04:26 +00002143 codeDeferredSeek(pWInfo, pIdx, iCur, iIdxCur);
drh6f82e852015-06-06 20:12:09 +00002144 }else if( iCur!=iIdxCur ){
2145 Index *pPk = sqlite3PrimaryKeyIndex(pIdx->pTable);
2146 iRowidReg = sqlite3GetTempRange(pParse, pPk->nKeyCol);
2147 for(j=0; j<pPk->nKeyCol; j++){
drhb9bcf7c2019-10-19 13:29:10 +00002148 k = sqlite3TableColumnToIndex(pIdx, pPk->aiColumn[j]);
drh6f82e852015-06-06 20:12:09 +00002149 sqlite3VdbeAddOp3(v, OP_Column, iIdxCur, k, iRowidReg+j);
2150 }
2151 sqlite3VdbeAddOp4Int(v, OP_NotFound, iCur, addrCont,
2152 iRowidReg, pPk->nKeyCol); VdbeCoverage(v);
2153 }
2154
drhdb535392019-11-03 00:07:41 +00002155 if( pLevel->iLeftJoin==0 ){
2156 /* If pIdx is an index on one or more expressions, then look through
2157 ** all the expressions in pWInfo and try to transform matching expressions
2158 ** into reference to index columns. Also attempt to translate references
2159 ** to virtual columns in the table into references to (stored) columns
2160 ** of the index.
2161 **
2162 ** Do not do this for the RHS of a LEFT JOIN. This is because the
2163 ** expression may be evaluated after OP_NullRow has been executed on
2164 ** the cursor. In this case it is important to do the full evaluation,
2165 ** as the result of the expression may not be NULL, even if all table
2166 ** column values are. https://www.sqlite.org/src/info/7fa8049685b50b5a
2167 **
2168 ** Also, do not do this when processing one index an a multi-index
2169 ** OR clause, since the transformation will become invalid once we
2170 ** move forward to the next index.
2171 ** https://sqlite.org/src/info/4e8e4857d32d401f
2172 */
2173 if( (pWInfo->wctrlFlags & WHERE_OR_SUBCLAUSE)==0 ){
2174 whereIndexExprTrans(pIdx, iCur, iIdxCur, pWInfo);
2175 }
2176
2177 /* If a partial index is driving the loop, try to eliminate WHERE clause
2178 ** terms from the query that must be true due to the WHERE clause of
2179 ** the partial index.
2180 **
2181 ** 2019-11-02 ticket 623eff57e76d45f6: This optimization does not work
2182 ** for a LEFT JOIN.
2183 */
2184 if( pIdx->pPartIdxWhere ){
2185 whereApplyPartialIndexConstraints(pIdx->pPartIdxWhere, iCur, pWC);
2186 }
2187 }else{
drhdb535392019-11-03 00:07:41 +00002188 testcase( pIdx->pPartIdxWhere );
drh06fc2452019-11-04 12:49:15 +00002189 /* The following assert() is not a requirement, merely an observation:
2190 ** The OR-optimization doesn't work for the right hand table of
2191 ** a LEFT JOIN: */
2192 assert( (pWInfo->wctrlFlags & WHERE_OR_SUBCLAUSE)==0 );
dan4da04f72018-04-24 14:05:14 +00002193 }
drhdb535392019-11-03 00:07:41 +00002194
dan71c57db2016-07-09 20:23:55 +00002195 /* Record the instruction used to terminate the loop. */
drh6f82e852015-06-06 20:12:09 +00002196 if( pLoop->wsFlags & WHERE_ONEROW ){
2197 pLevel->op = OP_Noop;
2198 }else if( bRev ){
2199 pLevel->op = OP_Prev;
2200 }else{
2201 pLevel->op = OP_Next;
2202 }
2203 pLevel->p1 = iIdxCur;
2204 pLevel->p3 = (pLoop->wsFlags&WHERE_UNQ_WANTED)!=0 ? 1:0;
2205 if( (pLoop->wsFlags & WHERE_CONSTRAINT)==0 ){
2206 pLevel->p5 = SQLITE_STMTSTATUS_FULLSCAN_STEP;
2207 }else{
2208 assert( pLevel->p5==0 );
2209 }
dan6f654a42017-04-28 19:59:55 +00002210 if( omitTable ) pIdx = 0;
drh6f82e852015-06-06 20:12:09 +00002211 }else
2212
2213#ifndef SQLITE_OMIT_OR_OPTIMIZATION
2214 if( pLoop->wsFlags & WHERE_MULTI_OR ){
2215 /* Case 5: Two or more separately indexed terms connected by OR
2216 **
2217 ** Example:
2218 **
2219 ** CREATE TABLE t1(a,b,c,d);
2220 ** CREATE INDEX i1 ON t1(a);
2221 ** CREATE INDEX i2 ON t1(b);
2222 ** CREATE INDEX i3 ON t1(c);
2223 **
2224 ** SELECT * FROM t1 WHERE a=5 OR b=7 OR (c=11 AND d=13)
2225 **
2226 ** In the example, there are three indexed terms connected by OR.
2227 ** The top of the loop looks like this:
2228 **
2229 ** Null 1 # Zero the rowset in reg 1
2230 **
2231 ** Then, for each indexed term, the following. The arguments to
2232 ** RowSetTest are such that the rowid of the current row is inserted
2233 ** into the RowSet. If it is already present, control skips the
2234 ** Gosub opcode and jumps straight to the code generated by WhereEnd().
2235 **
2236 ** sqlite3WhereBegin(<term>)
2237 ** RowSetTest # Insert rowid into rowset
2238 ** Gosub 2 A
2239 ** sqlite3WhereEnd()
2240 **
2241 ** Following the above, code to terminate the loop. Label A, the target
2242 ** of the Gosub above, jumps to the instruction right after the Goto.
2243 **
2244 ** Null 1 # Zero the rowset in reg 1
2245 ** Goto B # The loop is finished.
2246 **
2247 ** A: <loop body> # Return data, whatever.
2248 **
2249 ** Return 2 # Jump back to the Gosub
2250 **
2251 ** B: <after the loop>
2252 **
2253 ** Added 2014-05-26: If the table is a WITHOUT ROWID table, then
2254 ** use an ephemeral index instead of a RowSet to record the primary
2255 ** keys of the rows we have already seen.
2256 **
2257 */
2258 WhereClause *pOrWc; /* The OR-clause broken out into subterms */
2259 SrcList *pOrTab; /* Shortened table list or OR-clause generation */
2260 Index *pCov = 0; /* Potential covering index (or NULL) */
2261 int iCovCur = pParse->nTab++; /* Cursor used for index scans (if any) */
2262
2263 int regReturn = ++pParse->nMem; /* Register used with OP_Gosub */
2264 int regRowset = 0; /* Register for RowSet object */
2265 int regRowid = 0; /* Register holding rowid */
drhec4ccdb2018-12-29 02:26:59 +00002266 int iLoopBody = sqlite3VdbeMakeLabel(pParse);/* Start of loop body */
drh6f82e852015-06-06 20:12:09 +00002267 int iRetInit; /* Address of regReturn init */
2268 int untestedTerms = 0; /* Some terms not completely tested */
2269 int ii; /* Loop counter */
drh6f82e852015-06-06 20:12:09 +00002270 Expr *pAndExpr = 0; /* An ".. AND (...)" expression */
2271 Table *pTab = pTabItem->pTab;
dan145b4ea2016-07-29 18:12:12 +00002272
drh6f82e852015-06-06 20:12:09 +00002273 pTerm = pLoop->aLTerm[0];
2274 assert( pTerm!=0 );
2275 assert( pTerm->eOperator & WO_OR );
2276 assert( (pTerm->wtFlags & TERM_ORINFO)!=0 );
2277 pOrWc = &pTerm->u.pOrInfo->wc;
2278 pLevel->op = OP_Return;
2279 pLevel->p1 = regReturn;
2280
2281 /* Set up a new SrcList in pOrTab containing the table being scanned
2282 ** by this loop in the a[0] slot and all notReady tables in a[1..] slots.
2283 ** This becomes the SrcList in the recursive call to sqlite3WhereBegin().
2284 */
2285 if( pWInfo->nLevel>1 ){
2286 int nNotReady; /* The number of notReady tables */
drh76012942021-02-21 21:04:54 +00002287 SrcItem *origSrc; /* Original list of tables */
drh6f82e852015-06-06 20:12:09 +00002288 nNotReady = pWInfo->nLevel - iLevel - 1;
2289 pOrTab = sqlite3StackAllocRaw(db,
2290 sizeof(*pOrTab)+ nNotReady*sizeof(pOrTab->a[0]));
2291 if( pOrTab==0 ) return notReady;
2292 pOrTab->nAlloc = (u8)(nNotReady + 1);
2293 pOrTab->nSrc = pOrTab->nAlloc;
2294 memcpy(pOrTab->a, pTabItem, sizeof(*pTabItem));
2295 origSrc = pWInfo->pTabList->a;
2296 for(k=1; k<=nNotReady; k++){
2297 memcpy(&pOrTab->a[k], &origSrc[pLevel[k].iFrom], sizeof(pOrTab->a[k]));
2298 }
2299 }else{
2300 pOrTab = pWInfo->pTabList;
2301 }
2302
2303 /* Initialize the rowset register to contain NULL. An SQL NULL is
2304 ** equivalent to an empty rowset. Or, create an ephemeral index
2305 ** capable of holding primary keys in the case of a WITHOUT ROWID.
2306 **
2307 ** Also initialize regReturn to contain the address of the instruction
2308 ** immediately following the OP_Return at the bottom of the loop. This
2309 ** is required in a few obscure LEFT JOIN cases where control jumps
2310 ** over the top of the loop into the body of it. In this case the
2311 ** correct response for the end-of-loop code (the OP_Return) is to
2312 ** fall through to the next instruction, just as an OP_Next does if
2313 ** called on an uninitialized cursor.
2314 */
2315 if( (pWInfo->wctrlFlags & WHERE_DUPLICATES_OK)==0 ){
2316 if( HasRowid(pTab) ){
2317 regRowset = ++pParse->nMem;
2318 sqlite3VdbeAddOp2(v, OP_Null, 0, regRowset);
2319 }else{
2320 Index *pPk = sqlite3PrimaryKeyIndex(pTab);
2321 regRowset = pParse->nTab++;
2322 sqlite3VdbeAddOp2(v, OP_OpenEphemeral, regRowset, pPk->nKeyCol);
2323 sqlite3VdbeSetP4KeyInfo(pParse, pPk);
2324 }
2325 regRowid = ++pParse->nMem;
2326 }
2327 iRetInit = sqlite3VdbeAddOp2(v, OP_Integer, 0, regReturn);
2328
2329 /* If the original WHERE clause is z of the form: (x1 OR x2 OR ...) AND y
drh02e3e042022-02-04 13:05:29 +00002330 ** Then for every term xN, evaluate as the subexpression: xN AND y
drh6f82e852015-06-06 20:12:09 +00002331 ** That way, terms in y that are factored into the disjunction will
2332 ** be picked up by the recursive calls to sqlite3WhereBegin() below.
2333 **
2334 ** Actually, each subexpression is converted to "xN AND w" where w is
2335 ** the "interesting" terms of z - terms that did not originate in the
2336 ** ON or USING clause of a LEFT JOIN, and terms that are usable as
2337 ** indices.
2338 **
2339 ** This optimization also only applies if the (x1 OR x2 OR ...) term
2340 ** is not contained in the ON clause of a LEFT JOIN.
2341 ** See ticket http://www.sqlite.org/src/info/f2369304e4
drh02e3e042022-02-04 13:05:29 +00002342 **
2343 ** 2022-02-04: Do not push down slices of a row-value comparison.
2344 ** In other words, "w" or "y" may not be a slice of a vector. Otherwise,
2345 ** the initialization of the right-hand operand of the vector comparison
2346 ** might not occur, or might occur only in an OR branch that is not
2347 ** taken. dbsqlfuzz 80a9fade844b4fb43564efc972bcb2c68270f5d1.
drhc9bcc5a2022-03-03 15:59:22 +00002348 **
2349 ** 2022-03-03: Do not push down expressions that involve subqueries.
2350 ** The subquery might get coded as a subroutine. Any table-references
2351 ** in the subquery might be resolved to index-references for the index on
2352 ** the OR branch in which the subroutine is coded. But if the subroutine
2353 ** is invoked from a different OR branch that uses a different index, such
2354 ** index-references will not work. tag-20220303a
2355 ** https://sqlite.org/forum/forumpost/36937b197273d403
drh6f82e852015-06-06 20:12:09 +00002356 */
2357 if( pWC->nTerm>1 ){
2358 int iTerm;
2359 for(iTerm=0; iTerm<pWC->nTerm; iTerm++){
2360 Expr *pExpr = pWC->a[iTerm].pExpr;
2361 if( &pWC->a[iTerm] == pTerm ) continue;
drh3b83f0c2016-01-29 16:57:06 +00002362 testcase( pWC->a[iTerm].wtFlags & TERM_VIRTUAL );
2363 testcase( pWC->a[iTerm].wtFlags & TERM_CODED );
drh02e3e042022-02-04 13:05:29 +00002364 testcase( pWC->a[iTerm].wtFlags & TERM_SLICE );
2365 if( (pWC->a[iTerm].wtFlags & (TERM_VIRTUAL|TERM_CODED|TERM_SLICE))!=0 ){
2366 continue;
2367 }
drh07559b22022-03-03 19:40:21 +00002368 if( (pWC->a[iTerm].eOperator & WO_ALL)==0 ) continue;
drhc9bcc5a2022-03-03 15:59:22 +00002369 if( ExprHasProperty(pExpr, EP_Subquery) ) continue; /* tag-20220303a */
drh6f82e852015-06-06 20:12:09 +00002370 pExpr = sqlite3ExprDup(db, pExpr, 0);
drhd5c851c2019-04-19 13:38:34 +00002371 pAndExpr = sqlite3ExprAnd(pParse, pAndExpr, pExpr);
drh6f82e852015-06-06 20:12:09 +00002372 }
2373 if( pAndExpr ){
drhf1722ba2019-04-05 20:56:46 +00002374 /* The extra 0x10000 bit on the opcode is masked off and does not
2375 ** become part of the new Expr.op. However, it does make the
2376 ** op==TK_AND comparison inside of sqlite3PExpr() false, and this
drh93ffb502021-05-18 19:10:10 +00002377 ** prevents sqlite3PExpr() from applying the AND short-circuit
drhf1722ba2019-04-05 20:56:46 +00002378 ** optimization, which we do not want here. */
2379 pAndExpr = sqlite3PExpr(pParse, TK_AND|0x10000, 0, pAndExpr);
drh6f82e852015-06-06 20:12:09 +00002380 }
2381 }
2382
2383 /* Run a separate WHERE clause for each term of the OR clause. After
2384 ** eliminating duplicates from other WHERE clauses, the action for each
2385 ** sub-WHERE clause is to to invoke the main loop body as a subroutine.
2386 */
drh5d72d922018-05-04 00:39:43 +00002387 ExplainQueryPlan((pParse, 1, "MULTI-INDEX OR"));
drh6f82e852015-06-06 20:12:09 +00002388 for(ii=0; ii<pOrWc->nTerm; ii++){
2389 WhereTerm *pOrTerm = &pOrWc->a[ii];
2390 if( pOrTerm->leftCursor==iCur || (pOrTerm->eOperator & WO_AND)!=0 ){
2391 WhereInfo *pSubWInfo; /* Info for single OR-term scan */
2392 Expr *pOrExpr = pOrTerm->pExpr; /* Current OR clause term */
drh93ffb502021-05-18 19:10:10 +00002393 Expr *pDelete; /* Local copy of OR clause term */
drh728e0f92015-10-10 14:41:28 +00002394 int jmp1 = 0; /* Address of jump operation */
drh3b8eb082020-01-12 22:38:17 +00002395 testcase( (pTabItem[0].fg.jointype & JT_LEFT)!=0
2396 && !ExprHasProperty(pOrExpr, EP_FromJoin)
2397 ); /* See TH3 vtab25.400 and ticket 614b25314c766238 */
drh93ffb502021-05-18 19:10:10 +00002398 pDelete = pOrExpr = sqlite3ExprDup(db, pOrExpr, 0);
2399 if( db->mallocFailed ){
2400 sqlite3ExprDelete(db, pDelete);
2401 continue;
2402 }
dan820fcd22018-04-24 18:53:24 +00002403 if( pAndExpr ){
drh6f82e852015-06-06 20:12:09 +00002404 pAndExpr->pLeft = pOrExpr;
2405 pOrExpr = pAndExpr;
2406 }
2407 /* Loop through table entries that match term pOrTerm. */
drhbd462bc2018-12-24 20:21:06 +00002408 ExplainQueryPlan((pParse, 1, "INDEX %d", ii+1));
drh6f82e852015-06-06 20:12:09 +00002409 WHERETRACE(0xffff, ("Subplan for OR-clause:\n"));
drh895bab32022-01-27 16:14:50 +00002410 pSubWInfo = sqlite3WhereBegin(pParse, pOrTab, pOrExpr, 0, 0, 0,
drh68c0c712020-08-14 20:04:26 +00002411 WHERE_OR_SUBCLAUSE, iCovCur);
drh0c7d3d32022-01-24 16:47:12 +00002412 assert( pSubWInfo || pParse->nErr );
drh6f82e852015-06-06 20:12:09 +00002413 if( pSubWInfo ){
2414 WhereLoop *pSubLoop;
2415 int addrExplain = sqlite3WhereExplainOneScan(
drhe2188f02018-05-07 11:37:34 +00002416 pParse, pOrTab, &pSubWInfo->a[0], 0
drh6f82e852015-06-06 20:12:09 +00002417 );
2418 sqlite3WhereAddScanStatus(v, pOrTab, &pSubWInfo->a[0], addrExplain);
2419
2420 /* This is the sub-WHERE clause body. First skip over
2421 ** duplicate rows from prior sub-WHERE clauses, and record the
2422 ** rowid (or PRIMARY KEY) for the current row so that the same
2423 ** row will be skipped in subsequent sub-WHERE clauses.
2424 */
2425 if( (pWInfo->wctrlFlags & WHERE_DUPLICATES_OK)==0 ){
drh6f82e852015-06-06 20:12:09 +00002426 int iSet = ((ii==pOrWc->nTerm-1)?-1:ii);
2427 if( HasRowid(pTab) ){
drh6df9c4b2019-10-18 12:52:08 +00002428 sqlite3ExprCodeGetColumnOfTable(v, pTab, iCur, -1, regRowid);
drh728e0f92015-10-10 14:41:28 +00002429 jmp1 = sqlite3VdbeAddOp4Int(v, OP_RowSetTest, regRowset, 0,
drh8c607192018-08-04 15:53:55 +00002430 regRowid, iSet);
drh6f82e852015-06-06 20:12:09 +00002431 VdbeCoverage(v);
2432 }else{
2433 Index *pPk = sqlite3PrimaryKeyIndex(pTab);
2434 int nPk = pPk->nKeyCol;
2435 int iPk;
drh8c607192018-08-04 15:53:55 +00002436 int r;
drh6f82e852015-06-06 20:12:09 +00002437
2438 /* Read the PK into an array of temp registers. */
2439 r = sqlite3GetTempRange(pParse, nPk);
2440 for(iPk=0; iPk<nPk; iPk++){
2441 int iCol = pPk->aiColumn[iPk];
drh6df9c4b2019-10-18 12:52:08 +00002442 sqlite3ExprCodeGetColumnOfTable(v, pTab, iCur, iCol,r+iPk);
drh6f82e852015-06-06 20:12:09 +00002443 }
2444
2445 /* Check if the temp table already contains this key. If so,
2446 ** the row has already been included in the result set and
2447 ** can be ignored (by jumping past the Gosub below). Otherwise,
2448 ** insert the key into the temp table and proceed with processing
2449 ** the row.
2450 **
2451 ** Use some of the same optimizations as OP_RowSetTest: If iSet
2452 ** is zero, assume that the key cannot already be present in
2453 ** the temp table. And if iSet is -1, assume that there is no
2454 ** need to insert the key into the temp table, as it will never
2455 ** be tested for. */
2456 if( iSet ){
drh728e0f92015-10-10 14:41:28 +00002457 jmp1 = sqlite3VdbeAddOp4Int(v, OP_Found, regRowset, 0, r, nPk);
drh6f82e852015-06-06 20:12:09 +00002458 VdbeCoverage(v);
2459 }
2460 if( iSet>=0 ){
2461 sqlite3VdbeAddOp3(v, OP_MakeRecord, r, nPk, regRowid);
drh9b4eaeb2016-11-09 00:10:33 +00002462 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, regRowset, regRowid,
2463 r, nPk);
drh6f82e852015-06-06 20:12:09 +00002464 if( iSet ) sqlite3VdbeChangeP5(v, OPFLAG_USESEEKRESULT);
2465 }
2466
2467 /* Release the array of temp registers */
2468 sqlite3ReleaseTempRange(pParse, r, nPk);
2469 }
2470 }
2471
2472 /* Invoke the main loop body as a subroutine */
2473 sqlite3VdbeAddOp2(v, OP_Gosub, regReturn, iLoopBody);
2474
2475 /* Jump here (skipping the main loop body subroutine) if the
2476 ** current sub-WHERE row is a duplicate from prior sub-WHEREs. */
drh728e0f92015-10-10 14:41:28 +00002477 if( jmp1 ) sqlite3VdbeJumpHere(v, jmp1);
drh6f82e852015-06-06 20:12:09 +00002478
2479 /* The pSubWInfo->untestedTerms flag means that this OR term
2480 ** contained one or more AND term from a notReady table. The
2481 ** terms from the notReady table could not be tested and will
2482 ** need to be tested later.
2483 */
2484 if( pSubWInfo->untestedTerms ) untestedTerms = 1;
2485
2486 /* If all of the OR-connected terms are optimized using the same
2487 ** index, and the index is opened using the same cursor number
2488 ** by each call to sqlite3WhereBegin() made by this loop, it may
2489 ** be possible to use that index as a covering index.
2490 **
2491 ** If the call to sqlite3WhereBegin() above resulted in a scan that
2492 ** uses an index, and this is either the first OR-connected term
2493 ** processed or the index is the same as that used by all previous
2494 ** terms, set pCov to the candidate covering index. Otherwise, set
2495 ** pCov to NULL to indicate that no candidate covering index will
2496 ** be available.
2497 */
2498 pSubLoop = pSubWInfo->a[0].pWLoop;
2499 assert( (pSubLoop->wsFlags & WHERE_AUTO_INDEX)==0 );
2500 if( (pSubLoop->wsFlags & WHERE_INDEXED)!=0
2501 && (ii==0 || pSubLoop->u.btree.pIndex==pCov)
2502 && (HasRowid(pTab) || !IsPrimaryKeyIndex(pSubLoop->u.btree.pIndex))
2503 ){
2504 assert( pSubWInfo->a[0].iIdxCur==iCovCur );
2505 pCov = pSubLoop->u.btree.pIndex;
drh6f82e852015-06-06 20:12:09 +00002506 }else{
2507 pCov = 0;
2508 }
drh68c0c712020-08-14 20:04:26 +00002509 if( sqlite3WhereUsesDeferredSeek(pSubWInfo) ){
2510 pWInfo->bDeferredSeek = 1;
2511 }
drh6f82e852015-06-06 20:12:09 +00002512
2513 /* Finish the loop through table entries that match term pOrTerm. */
2514 sqlite3WhereEnd(pSubWInfo);
drhbd462bc2018-12-24 20:21:06 +00002515 ExplainQueryPlanPop(pParse);
drh6f82e852015-06-06 20:12:09 +00002516 }
drh93ffb502021-05-18 19:10:10 +00002517 sqlite3ExprDelete(db, pDelete);
drh6f82e852015-06-06 20:12:09 +00002518 }
2519 }
drh5d72d922018-05-04 00:39:43 +00002520 ExplainQueryPlanPop(pParse);
drh04756292021-10-14 19:28:28 +00002521 assert( pLevel->pWLoop==pLoop );
2522 assert( (pLoop->wsFlags & WHERE_MULTI_OR)!=0 );
2523 assert( (pLoop->wsFlags & WHERE_IN_ABLE)==0 );
2524 pLevel->u.pCoveringIdx = pCov;
drh6f82e852015-06-06 20:12:09 +00002525 if( pCov ) pLevel->iIdxCur = iCovCur;
2526 if( pAndExpr ){
2527 pAndExpr->pLeft = 0;
2528 sqlite3ExprDelete(db, pAndExpr);
2529 }
2530 sqlite3VdbeChangeP1(v, iRetInit, sqlite3VdbeCurrentAddr(v));
drh076e85f2015-09-03 13:46:12 +00002531 sqlite3VdbeGoto(v, pLevel->addrBrk);
drh6f82e852015-06-06 20:12:09 +00002532 sqlite3VdbeResolveLabel(v, iLoopBody);
2533
drhdd2d9a32019-05-07 17:47:43 +00002534 if( pWInfo->nLevel>1 ){ sqlite3StackFree(db, pOrTab); }
drh6f82e852015-06-06 20:12:09 +00002535 if( !untestedTerms ) disableTerm(pLevel, pTerm);
2536 }else
2537#endif /* SQLITE_OMIT_OR_OPTIMIZATION */
2538
2539 {
2540 /* Case 6: There is no usable index. We must do a complete
2541 ** scan of the entire table.
2542 */
2543 static const u8 aStep[] = { OP_Next, OP_Prev };
2544 static const u8 aStart[] = { OP_Rewind, OP_Last };
2545 assert( bRev==0 || bRev==1 );
drh8a48b9c2015-08-19 15:20:00 +00002546 if( pTabItem->fg.isRecursive ){
drh6f82e852015-06-06 20:12:09 +00002547 /* Tables marked isRecursive have only a single row that is stored in
2548 ** a pseudo-cursor. No need to Rewind or Next such cursors. */
2549 pLevel->op = OP_Noop;
2550 }else{
danb324cf72016-06-17 14:33:32 +00002551 codeCursorHint(pTabItem, pWInfo, pLevel, 0);
drh6f82e852015-06-06 20:12:09 +00002552 pLevel->op = aStep[bRev];
2553 pLevel->p1 = iCur;
drh3a3b4202017-02-15 22:36:15 +00002554 pLevel->p2 = 1 + sqlite3VdbeAddOp2(v, aStart[bRev], iCur, addrHalt);
drh6f82e852015-06-06 20:12:09 +00002555 VdbeCoverageIf(v, bRev==0);
2556 VdbeCoverageIf(v, bRev!=0);
2557 pLevel->p5 = SQLITE_STMTSTATUS_FULLSCAN_STEP;
2558 }
2559 }
2560
2561#ifdef SQLITE_ENABLE_STMT_SCANSTATUS
2562 pLevel->addrVisit = sqlite3VdbeCurrentAddr(v);
2563#endif
2564
2565 /* Insert code to test every subexpression that can be completely
2566 ** computed using the current set of tables.
dan6f654a42017-04-28 19:59:55 +00002567 **
danebc63012017-07-10 14:33:00 +00002568 ** This loop may run between one and three times, depending on the
2569 ** constraints to be generated. The value of stack variable iLoop
2570 ** determines the constraints coded by each iteration, as follows:
2571 **
2572 ** iLoop==1: Code only expressions that are entirely covered by pIdx.
2573 ** iLoop==2: Code remaining expressions that do not contain correlated
2574 ** sub-queries.
2575 ** iLoop==3: Code all remaining expressions.
2576 **
2577 ** An effort is made to skip unnecessary iterations of the loop.
drh6ab3eb52017-04-29 14:56:55 +00002578 */
danebc63012017-07-10 14:33:00 +00002579 iLoop = (pIdx ? 1 : 2);
drh6ab3eb52017-04-29 14:56:55 +00002580 do{
danebc63012017-07-10 14:33:00 +00002581 int iNext = 0; /* Next value for iLoop */
dan6f654a42017-04-28 19:59:55 +00002582 for(pTerm=pWC->a, j=pWC->nTerm; j>0; j--, pTerm++){
2583 Expr *pE;
2584 int skipLikeAddr = 0;
2585 testcase( pTerm->wtFlags & TERM_VIRTUAL );
2586 testcase( pTerm->wtFlags & TERM_CODED );
2587 if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
2588 if( (pTerm->prereqAll & pLevel->notReady)!=0 ){
2589 testcase( pWInfo->untestedTerms==0
2590 && (pWInfo->wctrlFlags & WHERE_OR_SUBCLAUSE)!=0 );
2591 pWInfo->untestedTerms = 1;
2592 continue;
2593 }
2594 pE = pTerm->pExpr;
2595 assert( pE!=0 );
dan820fcd22018-04-24 18:53:24 +00002596 if( (pTabItem->fg.jointype&JT_LEFT) && !ExprHasProperty(pE,EP_FromJoin) ){
dan6f654a42017-04-28 19:59:55 +00002597 continue;
2598 }
danebc63012017-07-10 14:33:00 +00002599
dan8674ec52017-07-10 14:39:42 +00002600 if( iLoop==1 && !sqlite3ExprCoveredByIndex(pE, pLevel->iTabCur, pIdx) ){
danebc63012017-07-10 14:33:00 +00002601 iNext = 2;
dan6f654a42017-04-28 19:59:55 +00002602 continue;
2603 }
dand3930b12017-07-10 15:17:30 +00002604 if( iLoop<3 && (pTerm->wtFlags & TERM_VARSELECT) ){
danebc63012017-07-10 14:33:00 +00002605 if( iNext==0 ) iNext = 3;
2606 continue;
2607 }
2608
drh4de33532018-04-02 00:16:36 +00002609 if( (pTerm->wtFlags & TERM_LIKECOND)!=0 ){
dan6f654a42017-04-28 19:59:55 +00002610 /* If the TERM_LIKECOND flag is set, that means that the range search
2611 ** is sufficient to guarantee that the LIKE operator is true, so we
2612 ** can skip the call to the like(A,B) function. But this only works
2613 ** for strings. So do not skip the call to the function on the pass
2614 ** that compares BLOBs. */
drh41d2e662015-12-01 21:23:07 +00002615#ifdef SQLITE_LIKE_DOESNT_MATCH_BLOBS
dan6f654a42017-04-28 19:59:55 +00002616 continue;
drh41d2e662015-12-01 21:23:07 +00002617#else
dan6f654a42017-04-28 19:59:55 +00002618 u32 x = pLevel->iLikeRepCntr;
drh4de33532018-04-02 00:16:36 +00002619 if( x>0 ){
2620 skipLikeAddr = sqlite3VdbeAddOp1(v, (x&1)?OP_IfNot:OP_If,(int)(x>>1));
drh6f883592019-03-30 20:37:04 +00002621 VdbeCoverageIf(v, (x&1)==1);
2622 VdbeCoverageIf(v, (x&1)==0);
drh4de33532018-04-02 00:16:36 +00002623 }
drh41d2e662015-12-01 21:23:07 +00002624#endif
dan6f654a42017-04-28 19:59:55 +00002625 }
drh66a0bf32017-07-10 16:38:14 +00002626#ifdef WHERETRACE_ENABLED /* 0xffff */
2627 if( sqlite3WhereTrace ){
2628 VdbeNoopComment((v, "WhereTerm[%d] (%p) priority=%d",
2629 pWC->nTerm-j, pTerm, iLoop));
2630 }
drh118efd12019-12-28 14:07:22 +00002631 if( sqlite3WhereTrace & 0x800 ){
2632 sqlite3DebugPrintf("Coding auxiliary constraint:\n");
2633 sqlite3WhereTermPrint(pTerm, pWC->nTerm-j);
2634 }
drh66a0bf32017-07-10 16:38:14 +00002635#endif
dan6f654a42017-04-28 19:59:55 +00002636 sqlite3ExprIfFalse(pParse, pE, addrCont, SQLITE_JUMPIFNULL);
2637 if( skipLikeAddr ) sqlite3VdbeJumpHere(v, skipLikeAddr);
2638 pTerm->wtFlags |= TERM_CODED;
drh6f82e852015-06-06 20:12:09 +00002639 }
danebc63012017-07-10 14:33:00 +00002640 iLoop = iNext;
2641 }while( iLoop>0 );
drh6f82e852015-06-06 20:12:09 +00002642
2643 /* Insert code to test for implied constraints based on transitivity
2644 ** of the "==" operator.
2645 **
2646 ** Example: If the WHERE clause contains "t1.a=t2.b" and "t2.b=123"
2647 ** and we are coding the t1 loop and the t2 loop has not yet coded,
2648 ** then we cannot use the "t1.a=t2.b" constraint, but we can code
2649 ** the implied "t1.a=123" constraint.
2650 */
drh132f96f2021-12-08 16:07:22 +00002651 for(pTerm=pWC->a, j=pWC->nBase; j>0; j--, pTerm++){
drhcb43a932016-10-03 01:21:51 +00002652 Expr *pE, sEAlt;
drh6f82e852015-06-06 20:12:09 +00002653 WhereTerm *pAlt;
2654 if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
2655 if( (pTerm->eOperator & (WO_EQ|WO_IS))==0 ) continue;
2656 if( (pTerm->eOperator & WO_EQUIV)==0 ) continue;
2657 if( pTerm->leftCursor!=iCur ) continue;
drha4b2df52019-12-28 16:20:23 +00002658 if( pTabItem->fg.jointype & JT_LEFT ) continue;
drh6f82e852015-06-06 20:12:09 +00002659 pE = pTerm->pExpr;
drh118efd12019-12-28 14:07:22 +00002660#ifdef WHERETRACE_ENABLED /* 0x800 */
2661 if( sqlite3WhereTrace & 0x800 ){
2662 sqlite3DebugPrintf("Coding transitive constraint:\n");
2663 sqlite3WhereTermPrint(pTerm, pWC->nTerm-j);
2664 }
2665#endif
drhf1bb31e2019-12-28 14:33:26 +00002666 assert( !ExprHasProperty(pE, EP_FromJoin) );
drh6f82e852015-06-06 20:12:09 +00002667 assert( (pTerm->prereqRight & pLevel->notReady)!=0 );
drh220f0d62021-10-15 17:06:16 +00002668 assert( (pTerm->eOperator & (WO_OR|WO_AND))==0 );
drh75fa2662020-09-28 15:49:43 +00002669 pAlt = sqlite3WhereFindTerm(pWC, iCur, pTerm->u.x.leftColumn, notReady,
drh6f82e852015-06-06 20:12:09 +00002670 WO_EQ|WO_IN|WO_IS, 0);
2671 if( pAlt==0 ) continue;
2672 if( pAlt->wtFlags & (TERM_CODED) ) continue;
dana916b572018-01-23 16:38:57 +00002673 if( (pAlt->eOperator & WO_IN)
drha4eeccd2021-10-07 17:43:30 +00002674 && ExprUseXSelect(pAlt->pExpr)
drha599e152018-12-24 14:30:11 +00002675 && (pAlt->pExpr->x.pSelect->pEList->nExpr>1)
dana916b572018-01-23 16:38:57 +00002676 ){
2677 continue;
2678 }
drh6f82e852015-06-06 20:12:09 +00002679 testcase( pAlt->eOperator & WO_EQ );
2680 testcase( pAlt->eOperator & WO_IS );
2681 testcase( pAlt->eOperator & WO_IN );
2682 VdbeModuleComment((v, "begin transitive constraint"));
drhcb43a932016-10-03 01:21:51 +00002683 sEAlt = *pAlt->pExpr;
2684 sEAlt.pLeft = pE->pLeft;
2685 sqlite3ExprIfFalse(pParse, &sEAlt, addrCont, SQLITE_JUMPIFNULL);
dan240e36c2021-04-05 16:20:59 +00002686 pAlt->wtFlags |= TERM_CODED;
drh6f82e852015-06-06 20:12:09 +00002687 }
2688
2689 /* For a LEFT OUTER JOIN, generate code that will record the fact that
2690 ** at least one row of the right table has matched the left table.
2691 */
2692 if( pLevel->iLeftJoin ){
2693 pLevel->addrFirst = sqlite3VdbeCurrentAddr(v);
2694 sqlite3VdbeAddOp2(v, OP_Integer, 1, pLevel->iLeftJoin);
2695 VdbeComment((v, "record LEFT JOIN hit"));
drh132f96f2021-12-08 16:07:22 +00002696 for(pTerm=pWC->a, j=0; j<pWC->nBase; j++, pTerm++){
drh6f82e852015-06-06 20:12:09 +00002697 testcase( pTerm->wtFlags & TERM_VIRTUAL );
2698 testcase( pTerm->wtFlags & TERM_CODED );
2699 if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
2700 if( (pTerm->prereqAll & pLevel->notReady)!=0 ){
2701 assert( pWInfo->untestedTerms );
2702 continue;
2703 }
2704 assert( pTerm->pExpr );
2705 sqlite3ExprIfFalse(pParse, pTerm->pExpr, addrCont, SQLITE_JUMPIFNULL);
2706 pTerm->wtFlags |= TERM_CODED;
2707 }
2708 }
2709
drh118efd12019-12-28 14:07:22 +00002710#if WHERETRACE_ENABLED /* 0x20800 */
2711 if( sqlite3WhereTrace & 0x20000 ){
drhf1bb31e2019-12-28 14:33:26 +00002712 sqlite3DebugPrintf("All WHERE-clause terms after coding level %d:\n",
2713 iLevel);
drh118efd12019-12-28 14:07:22 +00002714 sqlite3WhereClausePrint(pWC);
2715 }
2716 if( sqlite3WhereTrace & 0x800 ){
2717 sqlite3DebugPrintf("End Coding level %d: notReady=%llx\n",
2718 iLevel, (u64)pLevel->notReady);
2719 }
2720#endif
drh6f82e852015-06-06 20:12:09 +00002721 return pLevel->notReady;
2722}