blob: d4470ac4dfae28214b6041b436ea60060ca17724 [file] [log] [blame]
drh6f82e852015-06-06 20:12:09 +00001/*
2** 2015-06-06
3**
4** The author disclaims copyright to this source code. In place of
5** a legal notice, here is a blessing:
6**
7** May you do good and not evil.
8** May you find forgiveness for yourself and forgive others.
9** May you share freely, never taking more than you give.
10**
11*************************************************************************
12** This module contains C code that generates VDBE code used to process
13** the WHERE clause of SQL statements.
14**
15** This file was split off from where.c on 2015-06-06 in order to reduce the
16** size of where.c and make it easier to edit. This file contains the routines
17** that actually generate the bulk of the WHERE loop code. The original where.c
18** file retains the code that does query planning and analysis.
19*/
20#include "sqliteInt.h"
21#include "whereInt.h"
22
23#ifndef SQLITE_OMIT_EXPLAIN
dan1d9bc9b2016-08-08 18:42:08 +000024
25/*
26** Return the name of the i-th column of the pIdx index.
27*/
28static const char *explainIndexColumnName(Index *pIdx, int i){
29 i = pIdx->aiColumn[i];
30 if( i==XN_EXPR ) return "<expr>";
31 if( i==XN_ROWID ) return "rowid";
drhcf9d36d2021-08-02 18:03:43 +000032 return pIdx->pTable->aCol[i].zCnName;
dan1d9bc9b2016-08-08 18:42:08 +000033}
34
drh6f82e852015-06-06 20:12:09 +000035/*
36** This routine is a helper for explainIndexRange() below
37**
38** pStr holds the text of an expression that we are building up one term
39** at a time. This routine adds a new term to the end of the expression.
40** Terms are separated by AND so add the "AND" text for second and subsequent
41** terms only.
42*/
43static void explainAppendTerm(
44 StrAccum *pStr, /* The text expression being built */
dan1d9bc9b2016-08-08 18:42:08 +000045 Index *pIdx, /* Index to read column names from */
46 int nTerm, /* Number of terms */
47 int iTerm, /* Zero-based index of first term. */
48 int bAnd, /* Non-zero to append " AND " */
drh6f82e852015-06-06 20:12:09 +000049 const char *zOp /* Name of the operator */
50){
dan1d9bc9b2016-08-08 18:42:08 +000051 int i;
drh6f82e852015-06-06 20:12:09 +000052
dan1d9bc9b2016-08-08 18:42:08 +000053 assert( nTerm>=1 );
drh0cdbe1a2018-05-09 13:46:26 +000054 if( bAnd ) sqlite3_str_append(pStr, " AND ", 5);
dan1d9bc9b2016-08-08 18:42:08 +000055
drh0cdbe1a2018-05-09 13:46:26 +000056 if( nTerm>1 ) sqlite3_str_append(pStr, "(", 1);
dan1d9bc9b2016-08-08 18:42:08 +000057 for(i=0; i<nTerm; i++){
drh0cdbe1a2018-05-09 13:46:26 +000058 if( i ) sqlite3_str_append(pStr, ",", 1);
59 sqlite3_str_appendall(pStr, explainIndexColumnName(pIdx, iTerm+i));
dan1d9bc9b2016-08-08 18:42:08 +000060 }
drh0cdbe1a2018-05-09 13:46:26 +000061 if( nTerm>1 ) sqlite3_str_append(pStr, ")", 1);
dan1d9bc9b2016-08-08 18:42:08 +000062
drh0cdbe1a2018-05-09 13:46:26 +000063 sqlite3_str_append(pStr, zOp, 1);
dan1d9bc9b2016-08-08 18:42:08 +000064
drh0cdbe1a2018-05-09 13:46:26 +000065 if( nTerm>1 ) sqlite3_str_append(pStr, "(", 1);
dan1d9bc9b2016-08-08 18:42:08 +000066 for(i=0; i<nTerm; i++){
drh0cdbe1a2018-05-09 13:46:26 +000067 if( i ) sqlite3_str_append(pStr, ",", 1);
68 sqlite3_str_append(pStr, "?", 1);
dan1d9bc9b2016-08-08 18:42:08 +000069 }
drh0cdbe1a2018-05-09 13:46:26 +000070 if( nTerm>1 ) sqlite3_str_append(pStr, ")", 1);
drhc7c46802015-08-27 20:33:38 +000071}
72
73/*
drh6f82e852015-06-06 20:12:09 +000074** Argument pLevel describes a strategy for scanning table pTab. This
75** function appends text to pStr that describes the subset of table
76** rows scanned by the strategy in the form of an SQL expression.
77**
78** For example, if the query:
79**
80** SELECT * FROM t1 WHERE a=1 AND b>2;
81**
82** is run and there is an index on (a, b), then this function returns a
83** string similar to:
84**
85** "a=? AND b>?"
86*/
drh8faee872015-09-19 18:08:13 +000087static void explainIndexRange(StrAccum *pStr, WhereLoop *pLoop){
drh6f82e852015-06-06 20:12:09 +000088 Index *pIndex = pLoop->u.btree.pIndex;
89 u16 nEq = pLoop->u.btree.nEq;
90 u16 nSkip = pLoop->nSkip;
91 int i, j;
drh6f82e852015-06-06 20:12:09 +000092
93 if( nEq==0 && (pLoop->wsFlags&(WHERE_BTM_LIMIT|WHERE_TOP_LIMIT))==0 ) return;
drh0cdbe1a2018-05-09 13:46:26 +000094 sqlite3_str_append(pStr, " (", 2);
drh6f82e852015-06-06 20:12:09 +000095 for(i=0; i<nEq; i++){
drhc7c46802015-08-27 20:33:38 +000096 const char *z = explainIndexColumnName(pIndex, i);
drh0cdbe1a2018-05-09 13:46:26 +000097 if( i ) sqlite3_str_append(pStr, " AND ", 5);
98 sqlite3_str_appendf(pStr, i>=nSkip ? "%s=?" : "ANY(%s)", z);
drh6f82e852015-06-06 20:12:09 +000099 }
100
101 j = i;
102 if( pLoop->wsFlags&WHERE_BTM_LIMIT ){
dan1d9bc9b2016-08-08 18:42:08 +0000103 explainAppendTerm(pStr, pIndex, pLoop->u.btree.nBtm, j, i, ">");
104 i = 1;
drh6f82e852015-06-06 20:12:09 +0000105 }
106 if( pLoop->wsFlags&WHERE_TOP_LIMIT ){
dan1d9bc9b2016-08-08 18:42:08 +0000107 explainAppendTerm(pStr, pIndex, pLoop->u.btree.nTop, j, i, "<");
drh6f82e852015-06-06 20:12:09 +0000108 }
drh0cdbe1a2018-05-09 13:46:26 +0000109 sqlite3_str_append(pStr, ")", 1);
drh6f82e852015-06-06 20:12:09 +0000110}
111
112/*
113** This function is a no-op unless currently processing an EXPLAIN QUERY PLAN
114** command, or if either SQLITE_DEBUG or SQLITE_ENABLE_STMT_SCANSTATUS was
115** defined at compile-time. If it is not a no-op, a single OP_Explain opcode
116** is added to the output to describe the table scan strategy in pLevel.
117**
118** If an OP_Explain opcode is added to the VM, its address is returned.
119** Otherwise, if no OP_Explain is coded, zero is returned.
120*/
121int sqlite3WhereExplainOneScan(
122 Parse *pParse, /* Parse context */
123 SrcList *pTabList, /* Table list this loop refers to */
124 WhereLevel *pLevel, /* Scan to write OP_Explain opcode for */
drh6f82e852015-06-06 20:12:09 +0000125 u16 wctrlFlags /* Flags passed to sqlite3WhereBegin() */
126){
127 int ret = 0;
128#if !defined(SQLITE_DEBUG) && !defined(SQLITE_ENABLE_STMT_SCANSTATUS)
drhef7231b2017-12-21 21:41:13 +0000129 if( sqlite3ParseToplevel(pParse)->explain==2 )
drh6f82e852015-06-06 20:12:09 +0000130#endif
131 {
drh76012942021-02-21 21:04:54 +0000132 SrcItem *pItem = &pTabList->a[pLevel->iFrom];
drh6f82e852015-06-06 20:12:09 +0000133 Vdbe *v = pParse->pVdbe; /* VM being constructed */
134 sqlite3 *db = pParse->db; /* Database handle */
drh6f82e852015-06-06 20:12:09 +0000135 int isSearch; /* True for a SEARCH. False for SCAN. */
136 WhereLoop *pLoop; /* The controlling WhereLoop object */
137 u32 flags; /* Flags that describe this loop */
138 char *zMsg; /* Text to add to EQP output */
139 StrAccum str; /* EQP output string */
140 char zBuf[100]; /* Initial space for EQP output string */
141
142 pLoop = pLevel->pWLoop;
143 flags = pLoop->wsFlags;
drhce943bc2016-05-19 18:56:33 +0000144 if( (flags&WHERE_MULTI_OR) || (wctrlFlags&WHERE_OR_SUBCLAUSE) ) return 0;
drh6f82e852015-06-06 20:12:09 +0000145
146 isSearch = (flags&(WHERE_BTM_LIMIT|WHERE_TOP_LIMIT))!=0
147 || ((flags&WHERE_VIRTUALTABLE)==0 && (pLoop->u.btree.nEq>0))
148 || (wctrlFlags&(WHERE_ORDERBY_MIN|WHERE_ORDERBY_MAX));
149
150 sqlite3StrAccumInit(&str, db, zBuf, sizeof(zBuf), SQLITE_MAX_LENGTH);
drha9799932021-03-19 13:00:28 +0000151 str.printfFlags = SQLITE_PRINTF_INTERNAL;
drh2f2091b2021-03-20 15:46:01 +0000152 sqlite3_str_appendf(&str, "%s %S", isSearch ? "SEARCH" : "SCAN", pItem);
drh6f82e852015-06-06 20:12:09 +0000153 if( (flags & (WHERE_IPK|WHERE_VIRTUALTABLE))==0 ){
154 const char *zFmt = 0;
155 Index *pIdx;
156
157 assert( pLoop->u.btree.pIndex!=0 );
158 pIdx = pLoop->u.btree.pIndex;
159 assert( !(flags&WHERE_AUTO_INDEX) || (flags&WHERE_IDX_ONLY) );
160 if( !HasRowid(pItem->pTab) && IsPrimaryKeyIndex(pIdx) ){
161 if( isSearch ){
162 zFmt = "PRIMARY KEY";
163 }
164 }else if( flags & WHERE_PARTIALIDX ){
165 zFmt = "AUTOMATIC PARTIAL COVERING INDEX";
166 }else if( flags & WHERE_AUTO_INDEX ){
167 zFmt = "AUTOMATIC COVERING INDEX";
168 }else if( flags & WHERE_IDX_ONLY ){
169 zFmt = "COVERING INDEX %s";
170 }else{
171 zFmt = "INDEX %s";
172 }
173 if( zFmt ){
drh0cdbe1a2018-05-09 13:46:26 +0000174 sqlite3_str_append(&str, " USING ", 7);
175 sqlite3_str_appendf(&str, zFmt, pIdx->zName);
drh8faee872015-09-19 18:08:13 +0000176 explainIndexRange(&str, pLoop);
drh6f82e852015-06-06 20:12:09 +0000177 }
178 }else if( (flags & WHERE_IPK)!=0 && (flags & WHERE_CONSTRAINT)!=0 ){
drh3bd7cd72021-12-06 23:07:59 +0000179 char cRangeOp;
180#if 0 /* Better output, but breaks many tests */
181 const Table *pTab = pItem->pTab;
182 const char *zRowid = pTab->iPKey>=0 ? pTab->aCol[pTab->iPKey].zCnName:
183 "rowid";
184#else
185 const char *zRowid = "rowid";
186#endif
187 sqlite3_str_appendf(&str, " USING INTEGER PRIMARY KEY (%s", zRowid);
drh6f82e852015-06-06 20:12:09 +0000188 if( flags&(WHERE_COLUMN_EQ|WHERE_COLUMN_IN) ){
drh3bd7cd72021-12-06 23:07:59 +0000189 cRangeOp = '=';
drh6f82e852015-06-06 20:12:09 +0000190 }else if( (flags&WHERE_BOTH_LIMIT)==WHERE_BOTH_LIMIT ){
drh3bd7cd72021-12-06 23:07:59 +0000191 sqlite3_str_appendf(&str, ">? AND %s", zRowid);
192 cRangeOp = '<';
drh6f82e852015-06-06 20:12:09 +0000193 }else if( flags&WHERE_BTM_LIMIT ){
drh3bd7cd72021-12-06 23:07:59 +0000194 cRangeOp = '>';
drh6f82e852015-06-06 20:12:09 +0000195 }else{
196 assert( flags&WHERE_TOP_LIMIT);
drh3bd7cd72021-12-06 23:07:59 +0000197 cRangeOp = '<';
drh6f82e852015-06-06 20:12:09 +0000198 }
drh3bd7cd72021-12-06 23:07:59 +0000199 sqlite3_str_appendf(&str, "%c?)", cRangeOp);
drh6f82e852015-06-06 20:12:09 +0000200 }
201#ifndef SQLITE_OMIT_VIRTUALTABLE
202 else if( (flags & WHERE_VIRTUALTABLE)!=0 ){
drh0cdbe1a2018-05-09 13:46:26 +0000203 sqlite3_str_appendf(&str, " VIRTUAL TABLE INDEX %d:%s",
drh6f82e852015-06-06 20:12:09 +0000204 pLoop->u.vtab.idxNum, pLoop->u.vtab.idxStr);
205 }
206#endif
drhc5837192022-04-11 14:26:37 +0000207 if( pItem->fg.jointype & JT_LEFT ){
208 sqlite3_str_appendf(&str, " LEFT-JOIN");
209 }
drh6f82e852015-06-06 20:12:09 +0000210#ifdef SQLITE_EXPLAIN_ESTIMATED_ROWS
211 if( pLoop->nOut>=10 ){
drh0cdbe1a2018-05-09 13:46:26 +0000212 sqlite3_str_appendf(&str, " (~%llu rows)",
213 sqlite3LogEstToInt(pLoop->nOut));
drh6f82e852015-06-06 20:12:09 +0000214 }else{
drh0cdbe1a2018-05-09 13:46:26 +0000215 sqlite3_str_append(&str, " (~1 row)", 9);
drh6f82e852015-06-06 20:12:09 +0000216 }
217#endif
218 zMsg = sqlite3StrAccumFinish(&str);
drhbd462bc2018-12-24 20:21:06 +0000219 sqlite3ExplainBreakpoint("",zMsg);
drhe2ca99c2018-05-02 00:33:43 +0000220 ret = sqlite3VdbeAddOp4(v, OP_Explain, sqlite3VdbeCurrentAddr(v),
221 pParse->addrExplain, 0, zMsg,P4_DYNAMIC);
drh6f82e852015-06-06 20:12:09 +0000222 }
223 return ret;
224}
drh6ae49e62021-12-05 20:19:47 +0000225
226/*
227** Add a single OP_Explain opcode that describes a Bloom filter.
228**
229** Or if not processing EXPLAIN QUERY PLAN and not in a SQLITE_DEBUG and/or
230** SQLITE_ENABLE_STMT_SCANSTATUS build, then OP_Explain opcodes are not
231** required and this routine is a no-op.
232**
233** If an OP_Explain opcode is added to the VM, its address is returned.
234** Otherwise, if no OP_Explain is coded, zero is returned.
235*/
236int sqlite3WhereExplainBloomFilter(
237 const Parse *pParse, /* Parse context */
238 const WhereInfo *pWInfo, /* WHERE clause */
239 const WhereLevel *pLevel /* Bloom filter on this level */
240){
241 int ret = 0;
drha11c5e22021-12-09 18:44:03 +0000242 SrcItem *pItem = &pWInfo->pTabList->a[pLevel->iFrom];
243 Vdbe *v = pParse->pVdbe; /* VM being constructed */
244 sqlite3 *db = pParse->db; /* Database handle */
245 char *zMsg; /* Text to add to EQP output */
246 int i; /* Loop counter */
247 WhereLoop *pLoop; /* The where loop */
248 StrAccum str; /* EQP output string */
249 char zBuf[100]; /* Initial space for EQP output string */
drh6ae49e62021-12-05 20:19:47 +0000250
drha11c5e22021-12-09 18:44:03 +0000251 sqlite3StrAccumInit(&str, db, zBuf, sizeof(zBuf), SQLITE_MAX_LENGTH);
252 str.printfFlags = SQLITE_PRINTF_INTERNAL;
253 sqlite3_str_appendf(&str, "BLOOM FILTER ON %S (", pItem);
254 pLoop = pLevel->pWLoop;
255 if( pLoop->wsFlags & WHERE_IPK ){
256 const Table *pTab = pItem->pTab;
257 if( pTab->iPKey>=0 ){
258 sqlite3_str_appendf(&str, "%s=?", pTab->aCol[pTab->iPKey].zCnName);
drh3bd7cd72021-12-06 23:07:59 +0000259 }else{
drha11c5e22021-12-09 18:44:03 +0000260 sqlite3_str_appendf(&str, "rowid=?");
drh6ae49e62021-12-05 20:19:47 +0000261 }
drha11c5e22021-12-09 18:44:03 +0000262 }else{
263 for(i=pLoop->nSkip; i<pLoop->u.btree.nEq; i++){
264 const char *z = explainIndexColumnName(pLoop->u.btree.pIndex, i);
265 if( i>pLoop->nSkip ) sqlite3_str_append(&str, " AND ", 5);
266 sqlite3_str_appendf(&str, "%s=?", z);
267 }
drh6ae49e62021-12-05 20:19:47 +0000268 }
drha11c5e22021-12-09 18:44:03 +0000269 sqlite3_str_append(&str, ")", 1);
270 zMsg = sqlite3StrAccumFinish(&str);
271 ret = sqlite3VdbeAddOp4(v, OP_Explain, sqlite3VdbeCurrentAddr(v),
272 pParse->addrExplain, 0, zMsg,P4_DYNAMIC);
drh6ae49e62021-12-05 20:19:47 +0000273 return ret;
274}
drh6f82e852015-06-06 20:12:09 +0000275#endif /* SQLITE_OMIT_EXPLAIN */
276
277#ifdef SQLITE_ENABLE_STMT_SCANSTATUS
278/*
279** Configure the VM passed as the first argument with an
280** sqlite3_stmt_scanstatus() entry corresponding to the scan used to
281** implement level pLvl. Argument pSrclist is a pointer to the FROM
282** clause that the scan reads data from.
283**
284** If argument addrExplain is not 0, it must be the address of an
285** OP_Explain instruction that describes the same loop.
286*/
287void sqlite3WhereAddScanStatus(
288 Vdbe *v, /* Vdbe to add scanstatus entry to */
289 SrcList *pSrclist, /* FROM clause pLvl reads data from */
290 WhereLevel *pLvl, /* Level to add scanstatus() entry for */
291 int addrExplain /* Address of OP_Explain (or 0) */
292){
293 const char *zObj = 0;
294 WhereLoop *pLoop = pLvl->pWLoop;
295 if( (pLoop->wsFlags & WHERE_VIRTUALTABLE)==0 && pLoop->u.btree.pIndex!=0 ){
296 zObj = pLoop->u.btree.pIndex->zName;
297 }else{
298 zObj = pSrclist->a[pLvl->iFrom].zName;
299 }
300 sqlite3VdbeScanStatus(
301 v, addrExplain, pLvl->addrBody, pLvl->addrVisit, pLoop->nOut, zObj
302 );
303}
304#endif
305
306
307/*
308** Disable a term in the WHERE clause. Except, do not disable the term
309** if it controls a LEFT OUTER JOIN and it did not originate in the ON
310** or USING clause of that join.
311**
312** Consider the term t2.z='ok' in the following queries:
313**
314** (1) SELECT * FROM t1 LEFT JOIN t2 ON t1.a=t2.x WHERE t2.z='ok'
315** (2) SELECT * FROM t1 LEFT JOIN t2 ON t1.a=t2.x AND t2.z='ok'
316** (3) SELECT * FROM t1, t2 WHERE t1.a=t2.x AND t2.z='ok'
317**
318** The t2.z='ok' is disabled in the in (2) because it originates
319** in the ON clause. The term is disabled in (3) because it is not part
320** of a LEFT OUTER JOIN. In (1), the term is not disabled.
321**
322** Disabling a term causes that term to not be tested in the inner loop
323** of the join. Disabling is an optimization. When terms are satisfied
324** by indices, we disable them to prevent redundant tests in the inner
325** loop. We would get the correct results if nothing were ever disabled,
326** but joins might run a little slower. The trick is to disable as much
327** as we can without disabling too much. If we disabled in (1), we'd get
328** the wrong answer. See ticket #813.
329**
330** If all the children of a term are disabled, then that term is also
331** automatically disabled. In this way, terms get disabled if derived
332** virtual terms are tested first. For example:
333**
334** x GLOB 'abc*' AND x>='abc' AND x<'acd'
335** \___________/ \______/ \_____/
336** parent child1 child2
337**
338** Only the parent term was in the original WHERE clause. The child1
339** and child2 terms were added by the LIKE optimization. If both of
340** the virtual child terms are valid, then testing of the parent can be
341** skipped.
342**
343** Usually the parent term is marked as TERM_CODED. But if the parent
344** term was originally TERM_LIKE, then the parent gets TERM_LIKECOND instead.
345** The TERM_LIKECOND marking indicates that the term should be coded inside
346** a conditional such that is only evaluated on the second pass of a
347** LIKE-optimization loop, when scanning BLOBs instead of strings.
348*/
349static void disableTerm(WhereLevel *pLevel, WhereTerm *pTerm){
350 int nLoop = 0;
drh9d9c41e2017-10-31 03:40:15 +0000351 assert( pTerm!=0 );
352 while( (pTerm->wtFlags & TERM_CODED)==0
drh6f82e852015-06-06 20:12:09 +0000353 && (pLevel->iLeftJoin==0 || ExprHasProperty(pTerm->pExpr, EP_FromJoin))
354 && (pLevel->notReady & pTerm->prereqAll)==0
355 ){
356 if( nLoop && (pTerm->wtFlags & TERM_LIKE)!=0 ){
357 pTerm->wtFlags |= TERM_LIKECOND;
358 }else{
359 pTerm->wtFlags |= TERM_CODED;
360 }
drh23634892021-05-04 18:24:56 +0000361#ifdef WHERETRACE_ENABLED
362 if( sqlite3WhereTrace & 0x20000 ){
363 sqlite3DebugPrintf("DISABLE-");
364 sqlite3WhereTermPrint(pTerm, (int)(pTerm - (pTerm->pWC->a)));
365 }
366#endif
drh6f82e852015-06-06 20:12:09 +0000367 if( pTerm->iParent<0 ) break;
368 pTerm = &pTerm->pWC->a[pTerm->iParent];
drh9d9c41e2017-10-31 03:40:15 +0000369 assert( pTerm!=0 );
drh6f82e852015-06-06 20:12:09 +0000370 pTerm->nChild--;
371 if( pTerm->nChild!=0 ) break;
372 nLoop++;
373 }
374}
375
376/*
377** Code an OP_Affinity opcode to apply the column affinity string zAff
378** to the n registers starting at base.
379**
drh96fb16e2019-08-06 14:37:24 +0000380** As an optimization, SQLITE_AFF_BLOB and SQLITE_AFF_NONE entries (which
381** are no-ops) at the beginning and end of zAff are ignored. If all entries
382** in zAff are SQLITE_AFF_BLOB or SQLITE_AFF_NONE, then no code gets generated.
drh6f82e852015-06-06 20:12:09 +0000383**
384** This routine makes its own copy of zAff so that the caller is free
385** to modify zAff after this routine returns.
386*/
387static void codeApplyAffinity(Parse *pParse, int base, int n, char *zAff){
388 Vdbe *v = pParse->pVdbe;
389 if( zAff==0 ){
390 assert( pParse->db->mallocFailed );
391 return;
392 }
393 assert( v!=0 );
394
drh96fb16e2019-08-06 14:37:24 +0000395 /* Adjust base and n to skip over SQLITE_AFF_BLOB and SQLITE_AFF_NONE
396 ** entries at the beginning and end of the affinity string.
drh6f82e852015-06-06 20:12:09 +0000397 */
drh96fb16e2019-08-06 14:37:24 +0000398 assert( SQLITE_AFF_NONE<SQLITE_AFF_BLOB );
399 while( n>0 && zAff[0]<=SQLITE_AFF_BLOB ){
drh6f82e852015-06-06 20:12:09 +0000400 n--;
401 base++;
402 zAff++;
403 }
drh96fb16e2019-08-06 14:37:24 +0000404 while( n>1 && zAff[n-1]<=SQLITE_AFF_BLOB ){
drh6f82e852015-06-06 20:12:09 +0000405 n--;
406 }
407
408 /* Code the OP_Affinity opcode if there is anything left to do. */
409 if( n>0 ){
drh9b34abe2016-01-16 15:12:35 +0000410 sqlite3VdbeAddOp4(v, OP_Affinity, base, n, 0, zAff, n);
drh6f82e852015-06-06 20:12:09 +0000411 }
412}
413
danb7ca2172016-08-26 17:54:46 +0000414/*
415** Expression pRight, which is the RHS of a comparison operation, is
416** either a vector of n elements or, if n==1, a scalar expression.
417** Before the comparison operation, affinity zAff is to be applied
418** to the pRight values. This function modifies characters within the
419** affinity string to SQLITE_AFF_BLOB if either:
420**
421** * the comparison will be performed with no affinity, or
422** * the affinity change in zAff is guaranteed not to change the value.
423*/
424static void updateRangeAffinityStr(
danb7ca2172016-08-26 17:54:46 +0000425 Expr *pRight, /* RHS of comparison */
426 int n, /* Number of vector elements in comparison */
427 char *zAff /* Affinity string to modify */
428){
429 int i;
430 for(i=0; i<n; i++){
431 Expr *p = sqlite3VectorFieldSubexpr(pRight, i);
432 if( sqlite3CompareAffinity(p, zAff[i])==SQLITE_AFF_BLOB
433 || sqlite3ExprNeedsNoAffinityChange(p, zAff[i])
434 ){
435 zAff[i] = SQLITE_AFF_BLOB;
436 }
437 }
438}
drh6f82e852015-06-06 20:12:09 +0000439
drh24102432017-11-17 21:01:04 +0000440
441/*
442** pX is an expression of the form: (vector) IN (SELECT ...)
443** In other words, it is a vector IN operator with a SELECT clause on the
444** LHS. But not all terms in the vector are indexable and the terms might
445** not be in the correct order for indexing.
drh9b1ecb62017-11-17 17:32:40 +0000446**
drh24102432017-11-17 21:01:04 +0000447** This routine makes a copy of the input pX expression and then adjusts
448** the vector on the LHS with corresponding changes to the SELECT so that
449** the vector contains only index terms and those terms are in the correct
450** order. The modified IN expression is returned. The caller is responsible
451** for deleting the returned expression.
452**
453** Example:
454**
455** CREATE TABLE t1(a,b,c,d,e,f);
456** CREATE INDEX t1x1 ON t1(e,c);
457** SELECT * FROM t1 WHERE (a,b,c,d,e) IN (SELECT v,w,x,y,z FROM t2)
458** \_______________________________________/
459** The pX expression
460**
461** Since only columns e and c can be used with the index, in that order,
462** the modified IN expression that is returned will be:
463**
464** (e,c) IN (SELECT z,x FROM t2)
465**
466** The reduced pX is different from the original (obviously) and thus is
467** only used for indexing, to improve performance. The original unaltered
468** IN expression must also be run on each output row for correctness.
drh9b1ecb62017-11-17 17:32:40 +0000469*/
drh24102432017-11-17 21:01:04 +0000470static Expr *removeUnindexableInClauseTerms(
471 Parse *pParse, /* The parsing context */
472 int iEq, /* Look at loop terms starting here */
473 WhereLoop *pLoop, /* The current loop */
474 Expr *pX /* The IN expression to be reduced */
475){
476 sqlite3 *db = pParse->db;
dan69843342019-12-22 17:32:25 +0000477 Expr *pNew;
dan69843342019-12-22 17:32:25 +0000478 pNew = sqlite3ExprDup(db, pX, 0);
drh24102432017-11-17 21:01:04 +0000479 if( db->mallocFailed==0 ){
drha4eeccd2021-10-07 17:43:30 +0000480 ExprList *pOrigRhs; /* Original unmodified RHS */
481 ExprList *pOrigLhs; /* Original unmodified LHS */
drh24102432017-11-17 21:01:04 +0000482 ExprList *pRhs = 0; /* New RHS after modifications */
483 ExprList *pLhs = 0; /* New LHS after mods */
484 int i; /* Loop counter */
485 Select *pSelect; /* Pointer to the SELECT on the RHS */
486
drha4eeccd2021-10-07 17:43:30 +0000487 assert( ExprUseXSelect(pNew) );
488 pOrigRhs = pNew->x.pSelect->pEList;
489 assert( pNew->pLeft!=0 );
490 assert( ExprUseXList(pNew->pLeft) );
491 pOrigLhs = pNew->pLeft->x.pList;
drh24102432017-11-17 21:01:04 +0000492 for(i=iEq; i<pLoop->nLTerm; i++){
493 if( pLoop->aLTerm[i]->pExpr==pX ){
drh220f0d62021-10-15 17:06:16 +0000494 int iField;
495 assert( (pLoop->aLTerm[i]->eOperator & (WO_OR|WO_AND))==0 );
496 iField = pLoop->aLTerm[i]->u.x.iField - 1;
drhc6e519f2018-11-03 13:11:24 +0000497 if( pOrigRhs->a[iField].pExpr==0 ) continue; /* Duplicate PK column */
drh24102432017-11-17 21:01:04 +0000498 pRhs = sqlite3ExprListAppend(pParse, pRhs, pOrigRhs->a[iField].pExpr);
499 pOrigRhs->a[iField].pExpr = 0;
500 assert( pOrigLhs->a[iField].pExpr!=0 );
501 pLhs = sqlite3ExprListAppend(pParse, pLhs, pOrigLhs->a[iField].pExpr);
502 pOrigLhs->a[iField].pExpr = 0;
503 }
drh9b1ecb62017-11-17 17:32:40 +0000504 }
drh24102432017-11-17 21:01:04 +0000505 sqlite3ExprListDelete(db, pOrigRhs);
506 sqlite3ExprListDelete(db, pOrigLhs);
507 pNew->pLeft->x.pList = pLhs;
508 pNew->x.pSelect->pEList = pRhs;
509 if( pLhs && pLhs->nExpr==1 ){
510 /* Take care here not to generate a TK_VECTOR containing only a
511 ** single value. Since the parser never creates such a vector, some
512 ** of the subroutines do not handle this case. */
513 Expr *p = pLhs->a[0].pExpr;
514 pLhs->a[0].pExpr = 0;
515 sqlite3ExprDelete(db, pNew->pLeft);
516 pNew->pLeft = p;
517 }
518 pSelect = pNew->x.pSelect;
519 if( pSelect->pOrderBy ){
520 /* If the SELECT statement has an ORDER BY clause, zero the
521 ** iOrderByCol variables. These are set to non-zero when an
522 ** ORDER BY term exactly matches one of the terms of the
523 ** result-set. Since the result-set of the SELECT statement may
524 ** have been modified or reordered, these variables are no longer
525 ** set correctly. Since setting them is just an optimization,
526 ** it's easiest just to zero them here. */
527 ExprList *pOrderBy = pSelect->pOrderBy;
528 for(i=0; i<pOrderBy->nExpr; i++){
529 pOrderBy->a[i].u.x.iOrderByCol = 0;
530 }
531 }
532
533#if 0
534 printf("For indexing, change the IN expr:\n");
535 sqlite3TreeViewExpr(0, pX, 0);
536 printf("Into:\n");
537 sqlite3TreeViewExpr(0, pNew, 0);
538#endif
drh9b1ecb62017-11-17 17:32:40 +0000539 }
drh24102432017-11-17 21:01:04 +0000540 return pNew;
drh9b1ecb62017-11-17 17:32:40 +0000541}
drh9b1ecb62017-11-17 17:32:40 +0000542
543
drh6f82e852015-06-06 20:12:09 +0000544/*
545** Generate code for a single equality term of the WHERE clause. An equality
546** term can be either X=expr or X IN (...). pTerm is the term to be
547** coded.
548**
drh099a0f52016-09-06 15:25:53 +0000549** The current value for the constraint is left in a register, the index
550** of which is returned. An attempt is made store the result in iTarget but
551** this is only guaranteed for TK_ISNULL and TK_IN constraints. If the
552** constraint is a TK_EQ or TK_IS, then the current value might be left in
553** some other register and it is the caller's responsibility to compensate.
drh6f82e852015-06-06 20:12:09 +0000554**
drh4602b8e2016-08-19 18:28:00 +0000555** For a constraint of the form X=expr, the expression is evaluated in
556** straight-line code. For constraints of the form X IN (...)
drh6f82e852015-06-06 20:12:09 +0000557** this routine sets up a loop that will iterate over all values of X.
558*/
559static int codeEqualityTerm(
560 Parse *pParse, /* The parsing context */
561 WhereTerm *pTerm, /* The term of the WHERE clause to be coded */
562 WhereLevel *pLevel, /* The level of the FROM clause we are working on */
563 int iEq, /* Index of the equality term within this level */
564 int bRev, /* True for reverse-order IN operations */
565 int iTarget /* Attempt to leave results in this register */
566){
567 Expr *pX = pTerm->pExpr;
568 Vdbe *v = pParse->pVdbe;
569 int iReg; /* Register holding results */
570
dan8da209b2016-07-26 18:06:08 +0000571 assert( pLevel->pWLoop->aLTerm[iEq]==pTerm );
drh6f82e852015-06-06 20:12:09 +0000572 assert( iTarget>0 );
573 if( pX->op==TK_EQ || pX->op==TK_IS ){
drhfc7f27b2016-08-20 00:07:01 +0000574 iReg = sqlite3ExprCodeTarget(pParse, pX->pRight, iTarget);
drh6f82e852015-06-06 20:12:09 +0000575 }else if( pX->op==TK_ISNULL ){
576 iReg = iTarget;
577 sqlite3VdbeAddOp2(v, OP_Null, 0, iReg);
578#ifndef SQLITE_OMIT_SUBQUERY
579 }else{
drhac6b47d2016-08-24 00:51:48 +0000580 int eType = IN_INDEX_NOOP;
drh6f82e852015-06-06 20:12:09 +0000581 int iTab;
582 struct InLoop *pIn;
583 WhereLoop *pLoop = pLevel->pWLoop;
dan8da209b2016-07-26 18:06:08 +0000584 int i;
585 int nEq = 0;
586 int *aiMap = 0;
drh6f82e852015-06-06 20:12:09 +0000587
588 if( (pLoop->wsFlags & WHERE_VIRTUALTABLE)==0
589 && pLoop->u.btree.pIndex!=0
590 && pLoop->u.btree.pIndex->aSortOrder[iEq]
591 ){
592 testcase( iEq==0 );
593 testcase( bRev );
594 bRev = !bRev;
595 }
596 assert( pX->op==TK_IN );
597 iReg = iTarget;
dan8da209b2016-07-26 18:06:08 +0000598
599 for(i=0; i<iEq; i++){
600 if( pLoop->aLTerm[i] && pLoop->aLTerm[i]->pExpr==pX ){
601 disableTerm(pLevel, pTerm);
602 return iTarget;
603 }
604 }
605 for(i=iEq;i<pLoop->nLTerm; i++){
drh24102432017-11-17 21:01:04 +0000606 assert( pLoop->aLTerm[i]!=0 );
607 if( pLoop->aLTerm[i]->pExpr==pX ) nEq++;
dan8da209b2016-07-26 18:06:08 +0000608 }
609
drh2c041312018-12-24 02:34:49 +0000610 iTab = 0;
drha4eeccd2021-10-07 17:43:30 +0000611 if( !ExprUseXSelect(pX) || pX->x.pSelect->pEList->nExpr==1 ){
drh2c041312018-12-24 02:34:49 +0000612 eType = sqlite3FindInIndex(pParse, pX, IN_INDEX_LOOP, 0, 0, &iTab);
drha25bbaf2022-04-30 00:06:52 +0000613 }else{
614 Expr *pExpr = pTerm->pExpr;
drh3a45d302022-05-02 14:32:56 +0000615 if( pExpr->iTable==0 || !ExprHasProperty(pExpr, EP_Subrtn) ){
drha25bbaf2022-04-30 00:06:52 +0000616 sqlite3 *db = pParse->db;
617 pX = removeUnindexableInClauseTerms(pParse, iEq, pLoop, pX);
618 if( !db->mallocFailed ){
619 aiMap = (int*)sqlite3DbMallocZero(pParse->db, sizeof(int)*nEq);
620 eType = sqlite3FindInIndex(pParse, pX, IN_INDEX_LOOP, 0, aiMap,&iTab);
621 pExpr->iTable = iTab;
drha25bbaf2022-04-30 00:06:52 +0000622 }
623 sqlite3ExprDelete(db, pX);
624 }else{
drh74973642022-04-30 18:40:22 +0000625 aiMap = (int*)sqlite3DbMallocZero(pParse->db, sizeof(int)*nEq);
drh3a45d302022-05-02 14:32:56 +0000626 eType = sqlite3FindInIndex(pParse, pX, IN_INDEX_LOOP|IN_INDEX_REUSE_CUR, 0, aiMap,&iTab);
drha25bbaf2022-04-30 00:06:52 +0000627 iTab = pExpr->iTable;
drhac6b47d2016-08-24 00:51:48 +0000628 }
drha25bbaf2022-04-30 00:06:52 +0000629 pX = pExpr;
dan8da209b2016-07-26 18:06:08 +0000630 }
631
drh6f82e852015-06-06 20:12:09 +0000632 if( eType==IN_INDEX_INDEX_DESC ){
633 testcase( bRev );
634 bRev = !bRev;
635 }
drh6f82e852015-06-06 20:12:09 +0000636 sqlite3VdbeAddOp2(v, bRev ? OP_Last : OP_Rewind, iTab, 0);
637 VdbeCoverageIf(v, bRev);
638 VdbeCoverageIf(v, !bRev);
dan8da209b2016-07-26 18:06:08 +0000639
drh04756292021-10-14 19:28:28 +0000640 assert( (pLoop->wsFlags & WHERE_MULTI_OR)==0 );
drh6f82e852015-06-06 20:12:09 +0000641 pLoop->wsFlags |= WHERE_IN_ABLE;
642 if( pLevel->u.in.nIn==0 ){
drhec4ccdb2018-12-29 02:26:59 +0000643 pLevel->addrNxt = sqlite3VdbeMakeLabel(pParse);
drh6f82e852015-06-06 20:12:09 +0000644 }
drh46f0f4e2020-09-29 15:32:54 +0000645 if( iEq>0 && (pLoop->wsFlags & WHERE_IN_SEEKSCAN)==0 ){
drhfa17e132020-09-01 01:52:03 +0000646 pLoop->wsFlags |= WHERE_IN_EARLYOUT;
647 }
dan8da209b2016-07-26 18:06:08 +0000648
649 i = pLevel->u.in.nIn;
650 pLevel->u.in.nIn += nEq;
drh6f82e852015-06-06 20:12:09 +0000651 pLevel->u.in.aInLoop =
drhf8bdcfa2022-04-09 03:06:01 +0000652 sqlite3WhereRealloc(pTerm->pWC->pWInfo,
653 pLevel->u.in.aInLoop,
654 sizeof(pLevel->u.in.aInLoop[0])*pLevel->u.in.nIn);
drh6f82e852015-06-06 20:12:09 +0000655 pIn = pLevel->u.in.aInLoop;
656 if( pIn ){
dan8da209b2016-07-26 18:06:08 +0000657 int iMap = 0; /* Index in aiMap[] */
658 pIn += i;
dan7887d7f2016-08-24 12:22:17 +0000659 for(i=iEq;i<pLoop->nLTerm; i++){
dan8da209b2016-07-26 18:06:08 +0000660 if( pLoop->aLTerm[i]->pExpr==pX ){
danedc35372016-09-16 16:30:57 +0000661 int iOut = iReg + i - iEq;
dan8da209b2016-07-26 18:06:08 +0000662 if( eType==IN_INDEX_ROWID ){
danedc35372016-09-16 16:30:57 +0000663 pIn->addrInTop = sqlite3VdbeAddOp2(v, OP_Rowid, iTab, iOut);
dan8da209b2016-07-26 18:06:08 +0000664 }else{
665 int iCol = aiMap ? aiMap[iMap++] : 0;
dan8da209b2016-07-26 18:06:08 +0000666 pIn->addrInTop = sqlite3VdbeAddOp3(v,OP_Column,iTab, iCol, iOut);
667 }
drh03181c82016-08-18 19:04:57 +0000668 sqlite3VdbeAddOp1(v, OP_IsNull, iOut); VdbeCoverage(v);
dan8da209b2016-07-26 18:06:08 +0000669 if( i==iEq ){
670 pIn->iCur = iTab;
drhf1949b62018-06-07 17:32:59 +0000671 pIn->eEndLoopOp = bRev ? OP_Prev : OP_Next;
dan74ebaad2020-01-04 16:55:57 +0000672 if( iEq>0 ){
drh86d0ea72018-06-05 15:16:25 +0000673 pIn->iBase = iReg - i;
674 pIn->nPrefix = i;
675 }else{
676 pIn->nPrefix = 0;
677 }
dan8da209b2016-07-26 18:06:08 +0000678 }else{
679 pIn->eEndLoopOp = OP_Noop;
680 }
dan7887d7f2016-08-24 12:22:17 +0000681 pIn++;
dan8da209b2016-07-26 18:06:08 +0000682 }
drh6f82e852015-06-06 20:12:09 +0000683 }
drh67306cb2020-10-01 14:36:15 +0000684 testcase( iEq>0
685 && (pLoop->wsFlags & WHERE_IN_SEEKSCAN)==0
686 && (pLoop->wsFlags & WHERE_VIRTUALTABLE)!=0 );
687 if( iEq>0
688 && (pLoop->wsFlags & (WHERE_IN_SEEKSCAN|WHERE_VIRTUALTABLE))==0
689 ){
drhfa17e132020-09-01 01:52:03 +0000690 sqlite3VdbeAddOp3(v, OP_SeekHit, pLevel->iIdxCur, 0, iEq);
691 }
drh6f82e852015-06-06 20:12:09 +0000692 }else{
693 pLevel->u.in.nIn = 0;
694 }
dan8da209b2016-07-26 18:06:08 +0000695 sqlite3DbFree(pParse->db, aiMap);
drh6f82e852015-06-06 20:12:09 +0000696#endif
697 }
drh67656ac2021-05-04 23:21:35 +0000698
699 /* As an optimization, try to disable the WHERE clause term that is
700 ** driving the index as it will always be true. The correct answer is
701 ** obtained regardless, but we might get the answer with fewer CPU cycles
702 ** by omitting the term.
703 **
704 ** But do not disable the term unless we are certain that the term is
705 ** not a transitive constraint. For an example of where that does not
706 ** work, see https://sqlite.org/forum/forumpost/eb8613976a (2021-05-04)
707 */
708 if( (pLevel->pWLoop->wsFlags & WHERE_TRANSCONS)==0
709 || (pTerm->eOperator & WO_EQUIV)==0
710 ){
711 disableTerm(pLevel, pTerm);
712 }
713
drh6f82e852015-06-06 20:12:09 +0000714 return iReg;
715}
716
717/*
718** Generate code that will evaluate all == and IN constraints for an
719** index scan.
720**
721** For example, consider table t1(a,b,c,d,e,f) with index i1(a,b,c).
722** Suppose the WHERE clause is this: a==5 AND b IN (1,2,3) AND c>5 AND c<10
723** The index has as many as three equality constraints, but in this
724** example, the third "c" value is an inequality. So only two
725** constraints are coded. This routine will generate code to evaluate
726** a==5 and b IN (1,2,3). The current values for a and b will be stored
727** in consecutive registers and the index of the first register is returned.
728**
729** In the example above nEq==2. But this subroutine works for any value
730** of nEq including 0. If nEq==0, this routine is nearly a no-op.
731** The only thing it does is allocate the pLevel->iMem memory cell and
732** compute the affinity string.
733**
734** The nExtraReg parameter is 0 or 1. It is 0 if all WHERE clause constraints
735** are == or IN and are covered by the nEq. nExtraReg is 1 if there is
736** an inequality constraint (such as the "c>=5 AND c<10" in the example) that
737** occurs after the nEq quality constraints.
738**
739** This routine allocates a range of nEq+nExtraReg memory cells and returns
740** the index of the first memory cell in that range. The code that
741** calls this routine will use that memory range to store keys for
742** start and termination conditions of the loop.
743** key value of the loop. If one or more IN operators appear, then
744** this routine allocates an additional nEq memory cells for internal
745** use.
746**
747** Before returning, *pzAff is set to point to a buffer containing a
748** copy of the column affinity string of the index allocated using
749** sqlite3DbMalloc(). Except, entries in the copy of the string associated
750** with equality constraints that use BLOB or NONE affinity are set to
751** SQLITE_AFF_BLOB. This is to deal with SQL such as the following:
752**
753** CREATE TABLE t1(a TEXT PRIMARY KEY, b);
754** SELECT ... FROM t1 AS t2, t1 WHERE t1.a = t2.b;
755**
756** In the example above, the index on t1(a) has TEXT affinity. But since
757** the right hand side of the equality constraint (t2.b) has BLOB/NONE affinity,
758** no conversion should be attempted before using a t2.b value as part of
759** a key to search the index. Hence the first byte in the returned affinity
760** string in this example would be set to SQLITE_AFF_BLOB.
761*/
762static int codeAllEqualityTerms(
763 Parse *pParse, /* Parsing context */
764 WhereLevel *pLevel, /* Which nested loop of the FROM we are coding */
765 int bRev, /* Reverse the order of IN operators */
766 int nExtraReg, /* Number of extra registers to allocate */
767 char **pzAff /* OUT: Set to point to affinity string */
768){
769 u16 nEq; /* The number of == or IN constraints to code */
770 u16 nSkip; /* Number of left-most columns to skip */
771 Vdbe *v = pParse->pVdbe; /* The vm under construction */
772 Index *pIdx; /* The index being used for this loop */
773 WhereTerm *pTerm; /* A single constraint term */
774 WhereLoop *pLoop; /* The WhereLoop object */
775 int j; /* Loop counter */
776 int regBase; /* Base register */
777 int nReg; /* Number of registers to allocate */
778 char *zAff; /* Affinity string to return */
779
780 /* This module is only called on query plans that use an index. */
781 pLoop = pLevel->pWLoop;
782 assert( (pLoop->wsFlags & WHERE_VIRTUALTABLE)==0 );
783 nEq = pLoop->u.btree.nEq;
784 nSkip = pLoop->nSkip;
785 pIdx = pLoop->u.btree.pIndex;
786 assert( pIdx!=0 );
787
788 /* Figure out how many memory cells we will need then allocate them.
789 */
790 regBase = pParse->nMem + 1;
791 nReg = pLoop->u.btree.nEq + nExtraReg;
792 pParse->nMem += nReg;
793
drhe9107692015-08-25 19:20:04 +0000794 zAff = sqlite3DbStrDup(pParse->db,sqlite3IndexAffinityStr(pParse->db,pIdx));
drh4df86af2016-02-04 11:48:00 +0000795 assert( zAff!=0 || pParse->db->mallocFailed );
drh6f82e852015-06-06 20:12:09 +0000796
797 if( nSkip ){
798 int iIdxCur = pLevel->iIdxCur;
drh31536302021-04-21 23:13:26 +0000799 sqlite3VdbeAddOp3(v, OP_Null, 0, regBase, regBase+nSkip-1);
drh6f82e852015-06-06 20:12:09 +0000800 sqlite3VdbeAddOp1(v, (bRev?OP_Last:OP_Rewind), iIdxCur);
801 VdbeCoverageIf(v, bRev==0);
802 VdbeCoverageIf(v, bRev!=0);
803 VdbeComment((v, "begin skip-scan on %s", pIdx->zName));
804 j = sqlite3VdbeAddOp0(v, OP_Goto);
drh56945692022-03-02 21:04:10 +0000805 assert( pLevel->addrSkip==0 );
drh6f82e852015-06-06 20:12:09 +0000806 pLevel->addrSkip = sqlite3VdbeAddOp4Int(v, (bRev?OP_SeekLT:OP_SeekGT),
807 iIdxCur, 0, regBase, nSkip);
808 VdbeCoverageIf(v, bRev==0);
809 VdbeCoverageIf(v, bRev!=0);
810 sqlite3VdbeJumpHere(v, j);
811 for(j=0; j<nSkip; j++){
812 sqlite3VdbeAddOp3(v, OP_Column, iIdxCur, j, regBase+j);
drh4b92f982015-09-29 17:20:14 +0000813 testcase( pIdx->aiColumn[j]==XN_EXPR );
drhe63e8a62015-09-18 18:09:28 +0000814 VdbeComment((v, "%s", explainIndexColumnName(pIdx, j)));
drh6f82e852015-06-06 20:12:09 +0000815 }
816 }
817
818 /* Evaluate the equality constraints
819 */
820 assert( zAff==0 || (int)strlen(zAff)>=nEq );
821 for(j=nSkip; j<nEq; j++){
822 int r1;
823 pTerm = pLoop->aLTerm[j];
824 assert( pTerm!=0 );
825 /* The following testcase is true for indices with redundant columns.
826 ** Ex: CREATE INDEX i1 ON t1(a,b,a); SELECT * FROM t1 WHERE a=0 AND b=0; */
827 testcase( (pTerm->wtFlags & TERM_CODED)!=0 );
828 testcase( pTerm->wtFlags & TERM_VIRTUAL );
829 r1 = codeEqualityTerm(pParse, pTerm, pLevel, j, bRev, regBase+j);
830 if( r1!=regBase+j ){
831 if( nReg==1 ){
832 sqlite3ReleaseTempReg(pParse, regBase);
833 regBase = r1;
834 }else{
drhe9de6522021-05-28 12:48:31 +0000835 sqlite3VdbeAddOp2(v, OP_Copy, r1, regBase+j);
drh6f82e852015-06-06 20:12:09 +0000836 }
837 }
drhe482fde2022-01-21 16:41:11 +0000838 }
839 for(j=nSkip; j<nEq; j++){
840 pTerm = pLoop->aLTerm[j];
drhc097e122016-09-07 13:30:40 +0000841 if( pTerm->eOperator & WO_IN ){
842 if( pTerm->pExpr->flags & EP_xIsSelect ){
843 /* No affinity ever needs to be (or should be) applied to a value
844 ** from the RHS of an "? IN (SELECT ...)" expression. The
845 ** sqlite3FindInIndex() routine has already ensured that the
846 ** affinity of the comparison has been applied to the value. */
847 if( zAff ) zAff[j] = SQLITE_AFF_BLOB;
848 }
849 }else if( (pTerm->eOperator & WO_ISNULL)==0 ){
850 Expr *pRight = pTerm->pExpr->pRight;
851 if( (pTerm->wtFlags & TERM_IS)==0 && sqlite3ExprCanBeNull(pRight) ){
852 sqlite3VdbeAddOp2(v, OP_IsNull, regBase+j, pLevel->addrBrk);
853 VdbeCoverage(v);
854 }
drh0c7d3d32022-01-24 16:47:12 +0000855 if( pParse->nErr==0 ){
856 assert( pParse->db->mallocFailed==0 );
drhc097e122016-09-07 13:30:40 +0000857 if( sqlite3CompareAffinity(pRight, zAff[j])==SQLITE_AFF_BLOB ){
858 zAff[j] = SQLITE_AFF_BLOB;
dan27189602016-09-03 15:31:20 +0000859 }
drhc097e122016-09-07 13:30:40 +0000860 if( sqlite3ExprNeedsNoAffinityChange(pRight, zAff[j]) ){
861 zAff[j] = SQLITE_AFF_BLOB;
drh6f82e852015-06-06 20:12:09 +0000862 }
863 }
864 }
865 }
866 *pzAff = zAff;
867 return regBase;
868}
869
drh41d2e662015-12-01 21:23:07 +0000870#ifndef SQLITE_LIKE_DOESNT_MATCH_BLOBS
drh6f82e852015-06-06 20:12:09 +0000871/*
drh44aebff2016-05-02 10:25:42 +0000872** If the most recently coded instruction is a constant range constraint
873** (a string literal) that originated from the LIKE optimization, then
874** set P3 and P5 on the OP_String opcode so that the string will be cast
875** to a BLOB at appropriate times.
drh6f82e852015-06-06 20:12:09 +0000876**
877** The LIKE optimization trys to evaluate "x LIKE 'abc%'" as a range
878** expression: "x>='ABC' AND x<'abd'". But this requires that the range
879** scan loop run twice, once for strings and a second time for BLOBs.
880** The OP_String opcodes on the second pass convert the upper and lower
mistachkine234cfd2016-07-10 19:35:10 +0000881** bound string constants to blobs. This routine makes the necessary changes
drh6f82e852015-06-06 20:12:09 +0000882** to the OP_String opcodes for that to happen.
drh41d2e662015-12-01 21:23:07 +0000883**
884** Except, of course, if SQLITE_LIKE_DOESNT_MATCH_BLOBS is defined, then
885** only the one pass through the string space is required, so this routine
886** becomes a no-op.
drh6f82e852015-06-06 20:12:09 +0000887*/
888static void whereLikeOptimizationStringFixup(
889 Vdbe *v, /* prepared statement under construction */
890 WhereLevel *pLevel, /* The loop that contains the LIKE operator */
891 WhereTerm *pTerm /* The upper or lower bound just coded */
892){
893 if( pTerm->wtFlags & TERM_LIKEOPT ){
894 VdbeOp *pOp;
895 assert( pLevel->iLikeRepCntr>0 );
896 pOp = sqlite3VdbeGetOp(v, -1);
897 assert( pOp!=0 );
898 assert( pOp->opcode==OP_String8
899 || pTerm->pWC->pWInfo->pParse->db->mallocFailed );
drh44aebff2016-05-02 10:25:42 +0000900 pOp->p3 = (int)(pLevel->iLikeRepCntr>>1); /* Register holding counter */
901 pOp->p5 = (u8)(pLevel->iLikeRepCntr&1); /* ASC or DESC */
drh6f82e852015-06-06 20:12:09 +0000902 }
903}
drh41d2e662015-12-01 21:23:07 +0000904#else
905# define whereLikeOptimizationStringFixup(A,B,C)
906#endif
drh6f82e852015-06-06 20:12:09 +0000907
drhbec24762015-08-13 20:07:13 +0000908#ifdef SQLITE_ENABLE_CURSOR_HINTS
drh2f2b0272015-08-14 18:50:04 +0000909/*
910** Information is passed from codeCursorHint() down to individual nodes of
911** the expression tree (by sqlite3WalkExpr()) using an instance of this
912** structure.
913*/
914struct CCurHint {
915 int iTabCur; /* Cursor for the main table */
916 int iIdxCur; /* Cursor for the index, if pIdx!=0. Unused otherwise */
917 Index *pIdx; /* The index used to access the table */
918};
919
920/*
921** This function is called for every node of an expression that is a candidate
922** for a cursor hint on an index cursor. For TK_COLUMN nodes that reference
923** the table CCurHint.iTabCur, verify that the same column can be
924** accessed through the index. If it cannot, then set pWalker->eCode to 1.
925*/
926static int codeCursorHintCheckExpr(Walker *pWalker, Expr *pExpr){
927 struct CCurHint *pHint = pWalker->u.pCCurHint;
928 assert( pHint->pIdx!=0 );
929 if( pExpr->op==TK_COLUMN
930 && pExpr->iTable==pHint->iTabCur
drhb9bcf7c2019-10-19 13:29:10 +0000931 && sqlite3TableColumnToIndex(pHint->pIdx, pExpr->iColumn)<0
drh2f2b0272015-08-14 18:50:04 +0000932 ){
933 pWalker->eCode = 1;
934 }
935 return WRC_Continue;
936}
937
dane6912fd2016-06-17 19:27:13 +0000938/*
939** Test whether or not expression pExpr, which was part of a WHERE clause,
940** should be included in the cursor-hint for a table that is on the rhs
941** of a LEFT JOIN. Set Walker.eCode to non-zero before returning if the
942** expression is not suitable.
943**
944** An expression is unsuitable if it might evaluate to non NULL even if
945** a TK_COLUMN node that does affect the value of the expression is set
946** to NULL. For example:
947**
948** col IS NULL
949** col IS NOT NULL
950** coalesce(col, 1)
951** CASE WHEN col THEN 0 ELSE 1 END
952*/
953static int codeCursorHintIsOrFunction(Walker *pWalker, Expr *pExpr){
dan2b693d62016-06-20 17:22:06 +0000954 if( pExpr->op==TK_IS
dane6912fd2016-06-17 19:27:13 +0000955 || pExpr->op==TK_ISNULL || pExpr->op==TK_ISNOT
956 || pExpr->op==TK_NOTNULL || pExpr->op==TK_CASE
957 ){
958 pWalker->eCode = 1;
dan2b693d62016-06-20 17:22:06 +0000959 }else if( pExpr->op==TK_FUNCTION ){
960 int d1;
drh1d42ea72017-07-27 20:24:29 +0000961 char d2[4];
dan2b693d62016-06-20 17:22:06 +0000962 if( 0==sqlite3IsLikeFunction(pWalker->pParse->db, pExpr, &d1, d2) ){
963 pWalker->eCode = 1;
964 }
dane6912fd2016-06-17 19:27:13 +0000965 }
dan2b693d62016-06-20 17:22:06 +0000966
dane6912fd2016-06-17 19:27:13 +0000967 return WRC_Continue;
968}
969
drhbec24762015-08-13 20:07:13 +0000970
971/*
972** This function is called on every node of an expression tree used as an
973** argument to the OP_CursorHint instruction. If the node is a TK_COLUMN
drh2f2b0272015-08-14 18:50:04 +0000974** that accesses any table other than the one identified by
975** CCurHint.iTabCur, then do the following:
drhbec24762015-08-13 20:07:13 +0000976**
977** 1) allocate a register and code an OP_Column instruction to read
978** the specified column into the new register, and
979**
980** 2) transform the expression node to a TK_REGISTER node that reads
981** from the newly populated register.
drh2f2b0272015-08-14 18:50:04 +0000982**
983** Also, if the node is a TK_COLUMN that does access the table idenified
984** by pCCurHint.iTabCur, and an index is being used (which we will
985** know because CCurHint.pIdx!=0) then transform the TK_COLUMN into
986** an access of the index rather than the original table.
drhbec24762015-08-13 20:07:13 +0000987*/
988static int codeCursorHintFixExpr(Walker *pWalker, Expr *pExpr){
989 int rc = WRC_Continue;
drh2f2b0272015-08-14 18:50:04 +0000990 struct CCurHint *pHint = pWalker->u.pCCurHint;
danbe312ae2018-09-10 19:27:12 +0000991 if( pExpr->op==TK_COLUMN ){
drh2f2b0272015-08-14 18:50:04 +0000992 if( pExpr->iTable!=pHint->iTabCur ){
drh2f2b0272015-08-14 18:50:04 +0000993 int reg = ++pWalker->pParse->nMem; /* Register for column value */
dane3e79212018-09-11 13:38:35 +0000994 sqlite3ExprCode(pWalker->pParse, pExpr, reg);
drh2f2b0272015-08-14 18:50:04 +0000995 pExpr->op = TK_REGISTER;
996 pExpr->iTable = reg;
997 }else if( pHint->pIdx!=0 ){
998 pExpr->iTable = pHint->iIdxCur;
drhb9bcf7c2019-10-19 13:29:10 +0000999 pExpr->iColumn = sqlite3TableColumnToIndex(pHint->pIdx, pExpr->iColumn);
drh2f2b0272015-08-14 18:50:04 +00001000 assert( pExpr->iColumn>=0 );
1001 }
drhbec24762015-08-13 20:07:13 +00001002 }else if( pExpr->op==TK_AGG_FUNCTION ){
1003 /* An aggregate function in the WHERE clause of a query means this must
1004 ** be a correlated sub-query, and expression pExpr is an aggregate from
1005 ** the parent context. Do not walk the function arguments in this case.
1006 **
1007 ** todo: It should be possible to replace this node with a TK_REGISTER
1008 ** expression, as the result of the expression must be stored in a
1009 ** register at this point. The same holds for TK_AGG_COLUMN nodes. */
1010 rc = WRC_Prune;
1011 }
1012 return rc;
1013}
1014
1015/*
1016** Insert an OP_CursorHint instruction if it is appropriate to do so.
1017*/
1018static void codeCursorHint(
drh76012942021-02-21 21:04:54 +00001019 SrcItem *pTabItem, /* FROM clause item */
drhb413a542015-08-17 17:19:28 +00001020 WhereInfo *pWInfo, /* The where clause */
1021 WhereLevel *pLevel, /* Which loop to provide hints for */
1022 WhereTerm *pEndRange /* Hint this end-of-scan boundary term if not NULL */
drhbec24762015-08-13 20:07:13 +00001023){
1024 Parse *pParse = pWInfo->pParse;
1025 sqlite3 *db = pParse->db;
1026 Vdbe *v = pParse->pVdbe;
drhbec24762015-08-13 20:07:13 +00001027 Expr *pExpr = 0;
drh2f2b0272015-08-14 18:50:04 +00001028 WhereLoop *pLoop = pLevel->pWLoop;
drhbec24762015-08-13 20:07:13 +00001029 int iCur;
1030 WhereClause *pWC;
1031 WhereTerm *pTerm;
drhb413a542015-08-17 17:19:28 +00001032 int i, j;
drh2f2b0272015-08-14 18:50:04 +00001033 struct CCurHint sHint;
1034 Walker sWalker;
drhbec24762015-08-13 20:07:13 +00001035
1036 if( OptimizationDisabled(db, SQLITE_CursorHints) ) return;
drh2f2b0272015-08-14 18:50:04 +00001037 iCur = pLevel->iTabCur;
1038 assert( iCur==pWInfo->pTabList->a[pLevel->iFrom].iCursor );
1039 sHint.iTabCur = iCur;
1040 sHint.iIdxCur = pLevel->iIdxCur;
1041 sHint.pIdx = pLoop->u.btree.pIndex;
1042 memset(&sWalker, 0, sizeof(sWalker));
1043 sWalker.pParse = pParse;
1044 sWalker.u.pCCurHint = &sHint;
drhbec24762015-08-13 20:07:13 +00001045 pWC = &pWInfo->sWC;
drh132f96f2021-12-08 16:07:22 +00001046 for(i=0; i<pWC->nBase; i++){
drhbec24762015-08-13 20:07:13 +00001047 pTerm = &pWC->a[i];
1048 if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
1049 if( pTerm->prereqAll & pLevel->notReady ) continue;
danb324cf72016-06-17 14:33:32 +00001050
1051 /* Any terms specified as part of the ON(...) clause for any LEFT
1052 ** JOIN for which the current table is not the rhs are omitted
1053 ** from the cursor-hint.
1054 **
dane6912fd2016-06-17 19:27:13 +00001055 ** If this table is the rhs of a LEFT JOIN, "IS" or "IS NULL" terms
1056 ** that were specified as part of the WHERE clause must be excluded.
1057 ** This is to address the following:
danb324cf72016-06-17 14:33:32 +00001058 **
1059 ** SELECT ... t1 LEFT JOIN t2 ON (t1.a=t2.b) WHERE t2.c IS NULL;
1060 **
dane6912fd2016-06-17 19:27:13 +00001061 ** Say there is a single row in t2 that matches (t1.a=t2.b), but its
1062 ** t2.c values is not NULL. If the (t2.c IS NULL) constraint is
1063 ** pushed down to the cursor, this row is filtered out, causing
1064 ** SQLite to synthesize a row of NULL values. Which does match the
1065 ** WHERE clause, and so the query returns a row. Which is incorrect.
1066 **
1067 ** For the same reason, WHERE terms such as:
1068 **
1069 ** WHERE 1 = (t2.c IS NULL)
1070 **
1071 ** are also excluded. See codeCursorHintIsOrFunction() for details.
danb324cf72016-06-17 14:33:32 +00001072 */
1073 if( pTabItem->fg.jointype & JT_LEFT ){
dane6912fd2016-06-17 19:27:13 +00001074 Expr *pExpr = pTerm->pExpr;
1075 if( !ExprHasProperty(pExpr, EP_FromJoin)
drhd1985262022-04-11 11:25:28 +00001076 || pExpr->w.iJoin!=pTabItem->iCursor
danb324cf72016-06-17 14:33:32 +00001077 ){
dane6912fd2016-06-17 19:27:13 +00001078 sWalker.eCode = 0;
1079 sWalker.xExprCallback = codeCursorHintIsOrFunction;
1080 sqlite3WalkExpr(&sWalker, pTerm->pExpr);
1081 if( sWalker.eCode ) continue;
danb324cf72016-06-17 14:33:32 +00001082 }
1083 }else{
1084 if( ExprHasProperty(pTerm->pExpr, EP_FromJoin) ) continue;
1085 }
drhb413a542015-08-17 17:19:28 +00001086
1087 /* All terms in pWLoop->aLTerm[] except pEndRange are used to initialize
drhbcf40a72015-08-18 15:58:05 +00001088 ** the cursor. These terms are not needed as hints for a pure range
1089 ** scan (that has no == terms) so omit them. */
1090 if( pLoop->u.btree.nEq==0 && pTerm!=pEndRange ){
1091 for(j=0; j<pLoop->nLTerm && pLoop->aLTerm[j]!=pTerm; j++){}
1092 if( j<pLoop->nLTerm ) continue;
drhb413a542015-08-17 17:19:28 +00001093 }
1094
1095 /* No subqueries or non-deterministic functions allowed */
drhbec24762015-08-13 20:07:13 +00001096 if( sqlite3ExprContainsSubquery(pTerm->pExpr) ) continue;
drhb413a542015-08-17 17:19:28 +00001097
1098 /* For an index scan, make sure referenced columns are actually in
1099 ** the index. */
drh2f2b0272015-08-14 18:50:04 +00001100 if( sHint.pIdx!=0 ){
1101 sWalker.eCode = 0;
1102 sWalker.xExprCallback = codeCursorHintCheckExpr;
1103 sqlite3WalkExpr(&sWalker, pTerm->pExpr);
1104 if( sWalker.eCode ) continue;
1105 }
drhb413a542015-08-17 17:19:28 +00001106
1107 /* If we survive all prior tests, that means this term is worth hinting */
drhd5c851c2019-04-19 13:38:34 +00001108 pExpr = sqlite3ExprAnd(pParse, pExpr, sqlite3ExprDup(db, pTerm->pExpr, 0));
drhbec24762015-08-13 20:07:13 +00001109 }
1110 if( pExpr!=0 ){
drhbec24762015-08-13 20:07:13 +00001111 sWalker.xExprCallback = codeCursorHintFixExpr;
drhbec24762015-08-13 20:07:13 +00001112 sqlite3WalkExpr(&sWalker, pExpr);
drh2f2b0272015-08-14 18:50:04 +00001113 sqlite3VdbeAddOp4(v, OP_CursorHint,
1114 (sHint.pIdx ? sHint.iIdxCur : sHint.iTabCur), 0, 0,
1115 (const char*)pExpr, P4_EXPR);
drhbec24762015-08-13 20:07:13 +00001116 }
1117}
1118#else
danb324cf72016-06-17 14:33:32 +00001119# define codeCursorHint(A,B,C,D) /* No-op */
drhbec24762015-08-13 20:07:13 +00001120#endif /* SQLITE_ENABLE_CURSOR_HINTS */
drh6f82e852015-06-06 20:12:09 +00001121
1122/*
dande892d92016-01-29 19:29:45 +00001123** Cursor iCur is open on an intkey b-tree (a table). Register iRowid contains
1124** a rowid value just read from cursor iIdxCur, open on index pIdx. This
1125** function generates code to do a deferred seek of cursor iCur to the
1126** rowid stored in register iRowid.
1127**
1128** Normally, this is just:
1129**
drh170ad682017-06-02 15:44:22 +00001130** OP_DeferredSeek $iCur $iRowid
dande892d92016-01-29 19:29:45 +00001131**
drh7fd6a772022-02-25 13:29:56 +00001132** Which causes a seek on $iCur to the row with rowid $iRowid.
1133**
dande892d92016-01-29 19:29:45 +00001134** However, if the scan currently being coded is a branch of an OR-loop and
drh7fd6a772022-02-25 13:29:56 +00001135** the statement currently being coded is a SELECT, then additional information
1136** is added that might allow OP_Column to omit the seek and instead do its
1137** lookup on the index, thus avoiding an expensive seek operation. To
1138** enable this optimization, the P3 of OP_DeferredSeek is set to iIdxCur
1139** and P4 is set to an array of integers containing one entry for each column
1140** in the table. For each table column, if the column is the i'th
1141** column of the index, then the corresponding array entry is set to (i+1).
1142** If the column does not appear in the index at all, the array entry is set
1143** to 0. The OP_Column opcode can check this array to see if the column it
1144** wants is in the index and if it is, it will substitute the index cursor
1145** and column number and continue with those new values, rather than seeking
1146** the table cursor.
dande892d92016-01-29 19:29:45 +00001147*/
1148static void codeDeferredSeek(
1149 WhereInfo *pWInfo, /* Where clause context */
1150 Index *pIdx, /* Index scan is using */
1151 int iCur, /* Cursor for IPK b-tree */
dande892d92016-01-29 19:29:45 +00001152 int iIdxCur /* Index cursor */
1153){
1154 Parse *pParse = pWInfo->pParse; /* Parse context */
1155 Vdbe *v = pParse->pVdbe; /* Vdbe to generate code within */
1156
1157 assert( iIdxCur>0 );
1158 assert( pIdx->aiColumn[pIdx->nColumn-1]==-1 );
1159
drhbe3da242019-12-29 00:52:41 +00001160 pWInfo->bDeferredSeek = 1;
drh170ad682017-06-02 15:44:22 +00001161 sqlite3VdbeAddOp3(v, OP_DeferredSeek, iIdxCur, 0, iCur);
drhc5837192022-04-11 14:26:37 +00001162 if( (pWInfo->wctrlFlags & (WHERE_OR_SUBCLAUSE|WHERE_RIGHT_JOIN))
dancddb6ba2016-02-01 13:58:56 +00001163 && DbMaskAllZero(sqlite3ParseToplevel(pParse)->writeMask)
dande892d92016-01-29 19:29:45 +00001164 ){
1165 int i;
1166 Table *pTab = pIdx->pTable;
drhabc38152020-07-22 13:38:04 +00001167 u32 *ai = (u32*)sqlite3DbMallocZero(pParse->db, sizeof(u32)*(pTab->nCol+1));
dande892d92016-01-29 19:29:45 +00001168 if( ai ){
drhb1702022016-01-30 00:45:18 +00001169 ai[0] = pTab->nCol;
dande892d92016-01-29 19:29:45 +00001170 for(i=0; i<pIdx->nColumn-1; i++){
drh4fb24c82019-11-06 17:31:18 +00001171 int x1, x2;
dande892d92016-01-29 19:29:45 +00001172 assert( pIdx->aiColumn[i]<pTab->nCol );
drh4fb24c82019-11-06 17:31:18 +00001173 x1 = pIdx->aiColumn[i];
1174 x2 = sqlite3TableColumnToStorage(pTab, x1);
1175 testcase( x1!=x2 );
mistachkinbde3a4f2019-11-06 19:25:45 +00001176 if( x1>=0 ) ai[x2+1] = i+1;
dande892d92016-01-29 19:29:45 +00001177 }
1178 sqlite3VdbeChangeP4(v, -1, (char*)ai, P4_INTARRAY);
1179 }
1180 }
1181}
1182
dan553168c2016-08-01 20:14:31 +00001183/*
1184** If the expression passed as the second argument is a vector, generate
1185** code to write the first nReg elements of the vector into an array
1186** of registers starting with iReg.
1187**
1188** If the expression is not a vector, then nReg must be passed 1. In
1189** this case, generate code to evaluate the expression and leave the
1190** result in register iReg.
1191*/
dan71c57db2016-07-09 20:23:55 +00001192static void codeExprOrVector(Parse *pParse, Expr *p, int iReg, int nReg){
1193 assert( nReg>0 );
dand03024d2017-09-09 19:41:12 +00001194 if( p && sqlite3ExprIsVector(p) ){
danf9b2e052016-08-02 17:45:00 +00001195#ifndef SQLITE_OMIT_SUBQUERY
drha4eeccd2021-10-07 17:43:30 +00001196 if( ExprUseXSelect(p) ){
danf9b2e052016-08-02 17:45:00 +00001197 Vdbe *v = pParse->pVdbe;
drh85bcdce2018-12-23 21:27:29 +00001198 int iSelect;
1199 assert( p->op==TK_SELECT );
1200 iSelect = sqlite3CodeSubselect(pParse, p);
danf9b2e052016-08-02 17:45:00 +00001201 sqlite3VdbeAddOp3(v, OP_Copy, iSelect, iReg, nReg-1);
1202 }else
1203#endif
1204 {
1205 int i;
drha4eeccd2021-10-07 17:43:30 +00001206 const ExprList *pList;
1207 assert( ExprUseXList(p) );
1208 pList = p->x.pList;
dan71c57db2016-07-09 20:23:55 +00001209 assert( nReg<=pList->nExpr );
1210 for(i=0; i<nReg; i++){
1211 sqlite3ExprCode(pParse, pList->a[i].pExpr, iReg+i);
1212 }
dan71c57db2016-07-09 20:23:55 +00001213 }
1214 }else{
dan151446e2021-05-26 14:32:33 +00001215 assert( nReg==1 || pParse->nErr );
dan71c57db2016-07-09 20:23:55 +00001216 sqlite3ExprCode(pParse, p, iReg);
1217 }
1218}
1219
drheac5fc02017-04-11 01:01:27 +00001220/* An instance of the IdxExprTrans object carries information about a
1221** mapping from an expression on table columns into a column in an index
1222** down through the Walker.
1223*/
drhaca19e12017-04-07 19:41:31 +00001224typedef struct IdxExprTrans {
1225 Expr *pIdxExpr; /* The index expression */
1226 int iTabCur; /* The cursor of the corresponding table */
1227 int iIdxCur; /* The cursor for the index */
1228 int iIdxCol; /* The column for the index */
drhc7476732019-10-24 20:29:25 +00001229 int iTabCol; /* The column for the table */
drh36e678b2020-01-02 00:45:38 +00001230 WhereInfo *pWInfo; /* Complete WHERE clause information */
1231 sqlite3 *db; /* Database connection (for malloc()) */
drhaca19e12017-04-07 19:41:31 +00001232} IdxExprTrans;
1233
drh36e678b2020-01-02 00:45:38 +00001234/*
1235** Preserve pExpr on the WhereETrans list of the WhereInfo.
1236*/
1237static void preserveExpr(IdxExprTrans *pTrans, Expr *pExpr){
1238 WhereExprMod *pNew;
1239 pNew = sqlite3DbMallocRaw(pTrans->db, sizeof(*pNew));
1240 if( pNew==0 ) return;
1241 pNew->pNext = pTrans->pWInfo->pExprMods;
1242 pTrans->pWInfo->pExprMods = pNew;
1243 pNew->pExpr = pExpr;
1244 memcpy(&pNew->orig, pExpr, sizeof(*pExpr));
1245}
1246
drheac5fc02017-04-11 01:01:27 +00001247/* The walker node callback used to transform matching expressions into
1248** a reference to an index column for an index on an expression.
1249**
1250** If pExpr matches, then transform it into a reference to the index column
1251** that contains the value of pExpr.
1252*/
drhaca19e12017-04-07 19:41:31 +00001253static int whereIndexExprTransNode(Walker *p, Expr *pExpr){
1254 IdxExprTrans *pX = p->u.pIdxTrans;
dan5aa550c2017-06-24 18:10:29 +00001255 if( sqlite3ExprCompare(0, pExpr, pX->pIdxExpr, pX->iTabCur)==0 ){
drh2aa10862022-04-30 12:35:51 +00001256 pExpr = sqlite3ExprSkipCollate(pExpr);
drh36e678b2020-01-02 00:45:38 +00001257 preserveExpr(pX, pExpr);
danb6ce71b2019-08-20 11:43:44 +00001258 pExpr->affExpr = sqlite3ExprAffinity(pExpr);
drhaca19e12017-04-07 19:41:31 +00001259 pExpr->op = TK_COLUMN;
1260 pExpr->iTable = pX->iIdxCur;
1261 pExpr->iColumn = pX->iIdxCol;
drh6c1c85c2019-12-22 18:55:04 +00001262 testcase( ExprHasProperty(pExpr, EP_Skip) );
1263 testcase( ExprHasProperty(pExpr, EP_Unlikely) );
drh477572b2021-10-07 20:46:29 +00001264 ExprClearProperty(pExpr, EP_Skip|EP_Unlikely|EP_WinFunc|EP_Subrtn);
1265 pExpr->y.pTab = 0;
drhaca19e12017-04-07 19:41:31 +00001266 return WRC_Prune;
1267 }else{
1268 return WRC_Continue;
1269 }
1270}
1271
drhc7476732019-10-24 20:29:25 +00001272#ifndef SQLITE_OMIT_GENERATED_COLUMNS
1273/* A walker node callback that translates a column reference to a table
1274** into a corresponding column reference of an index.
1275*/
1276static int whereIndexExprTransColumn(Walker *p, Expr *pExpr){
1277 if( pExpr->op==TK_COLUMN ){
1278 IdxExprTrans *pX = p->u.pIdxTrans;
1279 if( pExpr->iTable==pX->iTabCur && pExpr->iColumn==pX->iTabCol ){
drh477572b2021-10-07 20:46:29 +00001280 assert( ExprUseYTab(pExpr) && pExpr->y.pTab!=0 );
drh36e678b2020-01-02 00:45:38 +00001281 preserveExpr(pX, pExpr);
drh57f7ece2019-11-21 18:28:44 +00001282 pExpr->affExpr = sqlite3TableColumnAffinity(pExpr->y.pTab,pExpr->iColumn);
drhc7476732019-10-24 20:29:25 +00001283 pExpr->iTable = pX->iIdxCur;
1284 pExpr->iColumn = pX->iIdxCol;
drh4485ac12019-10-24 21:02:06 +00001285 pExpr->y.pTab = 0;
drhc7476732019-10-24 20:29:25 +00001286 }
1287 }
1288 return WRC_Continue;
1289}
1290#endif /* SQLITE_OMIT_GENERATED_COLUMNS */
1291
drhaca19e12017-04-07 19:41:31 +00001292/*
drhf49759b2017-08-25 19:51:51 +00001293** For an indexes on expression X, locate every instance of expression X
1294** in pExpr and change that subexpression into a reference to the appropriate
1295** column of the index.
drhc7476732019-10-24 20:29:25 +00001296**
1297** 2019-10-24: Updated to also translate references to a VIRTUAL column in
1298** the table into references to the corresponding (stored) column of the
1299** index.
drhaca19e12017-04-07 19:41:31 +00001300*/
1301static void whereIndexExprTrans(
1302 Index *pIdx, /* The Index */
1303 int iTabCur, /* Cursor of the table that is being indexed */
1304 int iIdxCur, /* Cursor of the index itself */
1305 WhereInfo *pWInfo /* Transform expressions in this WHERE clause */
1306){
1307 int iIdxCol; /* Column number of the index */
1308 ExprList *aColExpr; /* Expressions that are indexed */
drhc7476732019-10-24 20:29:25 +00001309 Table *pTab;
drhaca19e12017-04-07 19:41:31 +00001310 Walker w;
1311 IdxExprTrans x;
1312 aColExpr = pIdx->aColExpr;
drhc7476732019-10-24 20:29:25 +00001313 if( aColExpr==0 && !pIdx->bHasVCol ){
1314 /* The index does not reference any expressions or virtual columns
1315 ** so no translations are needed. */
1316 return;
1317 }
1318 pTab = pIdx->pTable;
drhaca19e12017-04-07 19:41:31 +00001319 memset(&w, 0, sizeof(w));
drhaca19e12017-04-07 19:41:31 +00001320 w.u.pIdxTrans = &x;
1321 x.iTabCur = iTabCur;
1322 x.iIdxCur = iIdxCur;
drh36e678b2020-01-02 00:45:38 +00001323 x.pWInfo = pWInfo;
1324 x.db = pWInfo->pParse->db;
drhc7476732019-10-24 20:29:25 +00001325 for(iIdxCol=0; iIdxCol<pIdx->nColumn; iIdxCol++){
1326 i16 iRef = pIdx->aiColumn[iIdxCol];
1327 if( iRef==XN_EXPR ){
drh7d4c94b2021-10-04 22:34:38 +00001328 assert( aColExpr!=0 && aColExpr->a[iIdxCol].pExpr!=0 );
drhc7476732019-10-24 20:29:25 +00001329 x.pIdxExpr = aColExpr->a[iIdxCol].pExpr;
drhe86f3402019-12-26 00:20:56 +00001330 if( sqlite3ExprIsConstant(x.pIdxExpr) ) continue;
drhc7476732019-10-24 20:29:25 +00001331 w.xExprCallback = whereIndexExprTransNode;
1332#ifndef SQLITE_OMIT_GENERATED_COLUMNS
drhed0c3482019-12-20 22:46:41 +00001333 }else if( iRef>=0
1334 && (pTab->aCol[iRef].colFlags & COLFLAG_VIRTUAL)!=0
drh65b40092021-08-05 15:27:19 +00001335 && ((pTab->aCol[iRef].colFlags & COLFLAG_HASCOLL)==0
1336 || sqlite3StrICmp(sqlite3ColumnColl(&pTab->aCol[iRef]),
1337 sqlite3StrBINARY)==0)
drhed0c3482019-12-20 22:46:41 +00001338 ){
1339 /* Check to see if there are direct references to generated columns
1340 ** that are contained in the index. Pulling the generated column
1341 ** out of the index is an optimization only - the main table is always
1342 ** available if the index cannot be used. To avoid unnecessary
1343 ** complication, omit this optimization if the collating sequence for
1344 ** the column is non-standard */
drhc7476732019-10-24 20:29:25 +00001345 x.iTabCol = iRef;
1346 w.xExprCallback = whereIndexExprTransColumn;
1347#endif /* SQLITE_OMIT_GENERATED_COLUMNS */
1348 }else{
1349 continue;
1350 }
drhaca19e12017-04-07 19:41:31 +00001351 x.iIdxCol = iIdxCol;
drhaca19e12017-04-07 19:41:31 +00001352 sqlite3WalkExpr(&w, pWInfo->pWhere);
1353 sqlite3WalkExprList(&w, pWInfo->pOrderBy);
1354 sqlite3WalkExprList(&w, pWInfo->pResultSet);
1355 }
1356}
drhaca19e12017-04-07 19:41:31 +00001357
dande892d92016-01-29 19:29:45 +00001358/*
drh610f11d2019-03-18 10:30:00 +00001359** The pTruth expression is always true because it is the WHERE clause
drhb531aa82019-03-01 18:07:05 +00001360** a partial index that is driving a query loop. Look through all of the
1361** WHERE clause terms on the query, and if any of those terms must be
1362** true because pTruth is true, then mark those WHERE clause terms as
1363** coded.
1364*/
1365static void whereApplyPartialIndexConstraints(
1366 Expr *pTruth,
1367 int iTabCur,
1368 WhereClause *pWC
1369){
1370 int i;
1371 WhereTerm *pTerm;
1372 while( pTruth->op==TK_AND ){
1373 whereApplyPartialIndexConstraints(pTruth->pLeft, iTabCur, pWC);
1374 pTruth = pTruth->pRight;
1375 }
1376 for(i=0, pTerm=pWC->a; i<pWC->nTerm; i++, pTerm++){
1377 Expr *pExpr;
1378 if( pTerm->wtFlags & TERM_CODED ) continue;
1379 pExpr = pTerm->pExpr;
1380 if( sqlite3ExprCompare(0, pExpr, pTruth, iTabCur)==0 ){
1381 pTerm->wtFlags |= TERM_CODED;
1382 }
1383 }
1384}
1385
drh35685d32021-12-05 00:45:55 +00001386/*
drh6ae49e62021-12-05 20:19:47 +00001387** This routine is called right after An OP_Filter has been generated and
1388** before the corresponding index search has been performed. This routine
1389** checks to see if there are additional Bloom filters in inner loops that
1390** can be checked prior to doing the index lookup. If there are available
1391** inner-loop Bloom filters, then evaluate those filters now, before the
1392** index lookup. The idea is that a Bloom filter check is way faster than
1393** an index lookup, and the Bloom filter might return false, meaning that
1394** the index lookup can be skipped.
1395**
1396** We know that an inner loop uses a Bloom filter because it has the
1397** WhereLevel.regFilter set. If an inner-loop Bloom filter is checked,
drh5a4ac1c2021-12-09 19:42:52 +00001398** then clear the WhereLevel.regFilter value to prevent the Bloom filter
drh6ae49e62021-12-05 20:19:47 +00001399** from being checked a second time when the inner loop is evaluated.
drh35685d32021-12-05 00:45:55 +00001400*/
1401static SQLITE_NOINLINE void filterPullDown(
1402 Parse *pParse, /* Parsing context */
1403 WhereInfo *pWInfo, /* Complete information about the WHERE clause */
1404 int iLevel, /* Which level of pWInfo->a[] should be coded */
1405 int addrNxt, /* Jump here to bypass inner loops */
1406 Bitmask notReady /* Loops that are not ready */
1407){
1408 while( ++iLevel < pWInfo->nLevel ){
1409 WhereLevel *pLevel = &pWInfo->a[iLevel];
1410 WhereLoop *pLoop = pLevel->pWLoop;
drh6ae49e62021-12-05 20:19:47 +00001411 if( pLevel->regFilter==0 ) continue;
drh56945692022-03-02 21:04:10 +00001412 if( pLevel->pWLoop->nSkip ) continue;
drh27a9e1f2021-12-10 17:36:16 +00001413 /* ,--- Because sqlite3ConstructBloomFilter() has will not have set
drha11c5e22021-12-09 18:44:03 +00001414 ** vvvvv--' pLevel->regFilter if this were true. */
1415 if( NEVER(pLoop->prereq & notReady) ) continue;
drh35685d32021-12-05 00:45:55 +00001416 if( pLoop->wsFlags & WHERE_IPK ){
1417 WhereTerm *pTerm = pLoop->aLTerm[0];
drh7e910f62021-12-09 01:28:15 +00001418 int regRowid;
drh35685d32021-12-05 00:45:55 +00001419 assert( pTerm!=0 );
1420 assert( pTerm->pExpr!=0 );
1421 testcase( pTerm->wtFlags & TERM_VIRTUAL );
drh7e910f62021-12-09 01:28:15 +00001422 regRowid = sqlite3GetTempReg(pParse);
1423 regRowid = codeEqualityTerm(pParse, pTerm, pLevel, 0, 0, regRowid);
drh35685d32021-12-05 00:45:55 +00001424 sqlite3VdbeAddOp4Int(pParse->pVdbe, OP_Filter, pLevel->regFilter,
1425 addrNxt, regRowid, 1);
1426 VdbeCoverage(pParse->pVdbe);
1427 }else{
1428 u16 nEq = pLoop->u.btree.nEq;
1429 int r1;
1430 char *zStartAff;
1431
1432 assert( pLoop->wsFlags & WHERE_INDEXED );
drhdc56dc92021-12-11 17:10:58 +00001433 assert( (pLoop->wsFlags & WHERE_COLUMN_IN)==0 );
drh35685d32021-12-05 00:45:55 +00001434 r1 = codeAllEqualityTerms(pParse,pLevel,0,0,&zStartAff);
1435 codeApplyAffinity(pParse, r1, nEq, zStartAff);
1436 sqlite3DbFree(pParse->db, zStartAff);
1437 sqlite3VdbeAddOp4Int(pParse->pVdbe, OP_Filter, pLevel->regFilter,
1438 addrNxt, r1, nEq);
1439 VdbeCoverage(pParse->pVdbe);
1440 }
drh6ae49e62021-12-05 20:19:47 +00001441 pLevel->regFilter = 0;
drh35685d32021-12-05 00:45:55 +00001442 }
1443}
drh35685d32021-12-05 00:45:55 +00001444
drhb531aa82019-03-01 18:07:05 +00001445/*
drh6f82e852015-06-06 20:12:09 +00001446** Generate code for the start of the iLevel-th loop in the WHERE clause
1447** implementation described by pWInfo.
1448*/
1449Bitmask sqlite3WhereCodeOneLoopStart(
drh47df8a22018-12-25 00:15:37 +00001450 Parse *pParse, /* Parsing context */
1451 Vdbe *v, /* Prepared statement under construction */
drh6f82e852015-06-06 20:12:09 +00001452 WhereInfo *pWInfo, /* Complete information about the WHERE clause */
1453 int iLevel, /* Which level of pWInfo->a[] should be coded */
drh47df8a22018-12-25 00:15:37 +00001454 WhereLevel *pLevel, /* The current level pointer */
drh6f82e852015-06-06 20:12:09 +00001455 Bitmask notReady /* Which tables are currently available */
1456){
1457 int j, k; /* Loop counters */
1458 int iCur; /* The VDBE cursor for the table */
1459 int addrNxt; /* Where to jump to continue with the next IN case */
drh6f82e852015-06-06 20:12:09 +00001460 int bRev; /* True if we need to scan in reverse order */
drh6f82e852015-06-06 20:12:09 +00001461 WhereLoop *pLoop; /* The WhereLoop object being coded */
1462 WhereClause *pWC; /* Decomposition of the entire WHERE clause */
1463 WhereTerm *pTerm; /* A WHERE clause term */
drh6f82e852015-06-06 20:12:09 +00001464 sqlite3 *db; /* Database connection */
drh76012942021-02-21 21:04:54 +00001465 SrcItem *pTabItem; /* FROM clause term being coded */
drh6f82e852015-06-06 20:12:09 +00001466 int addrBrk; /* Jump here to break out of the loop */
drh3a3b4202017-02-15 22:36:15 +00001467 int addrHalt; /* addrBrk for the outermost loop */
drh6f82e852015-06-06 20:12:09 +00001468 int addrCont; /* Jump here to continue with next cycle */
1469 int iRowidReg = 0; /* Rowid is stored in this register, if not zero */
1470 int iReleaseReg = 0; /* Temp register to free before returning */
dan6f654a42017-04-28 19:59:55 +00001471 Index *pIdx = 0; /* Index used by loop (if any) */
danebc63012017-07-10 14:33:00 +00001472 int iLoop; /* Iteration of constraint generator loop */
drh6f82e852015-06-06 20:12:09 +00001473
drh6f82e852015-06-06 20:12:09 +00001474 pWC = &pWInfo->sWC;
1475 db = pParse->db;
drh6f82e852015-06-06 20:12:09 +00001476 pLoop = pLevel->pWLoop;
1477 pTabItem = &pWInfo->pTabList->a[pLevel->iFrom];
1478 iCur = pTabItem->iCursor;
1479 pLevel->notReady = notReady & ~sqlite3WhereGetMask(&pWInfo->sMaskSet, iCur);
1480 bRev = (pWInfo->revMask>>iLevel)&1;
drh6f82e852015-06-06 20:12:09 +00001481 VdbeModuleComment((v, "Begin WHERE-loop%d: %s",iLevel,pTabItem->pTab->zName));
drh118efd12019-12-28 14:07:22 +00001482#if WHERETRACE_ENABLED /* 0x20800 */
1483 if( sqlite3WhereTrace & 0x800 ){
drha4b2df52019-12-28 16:20:23 +00001484 sqlite3DebugPrintf("Coding level %d of %d: notReady=%llx iFrom=%d\n",
1485 iLevel, pWInfo->nLevel, (u64)notReady, pLevel->iFrom);
drh118efd12019-12-28 14:07:22 +00001486 sqlite3WhereLoopPrint(pLoop, pWC);
1487 }
1488 if( sqlite3WhereTrace & 0x20000 ){
drhf1bb31e2019-12-28 14:33:26 +00001489 if( iLevel==0 ){
1490 sqlite3DebugPrintf("WHERE clause being coded:\n");
1491 sqlite3TreeViewExpr(0, pWInfo->pWhere, 0);
1492 }
1493 sqlite3DebugPrintf("All WHERE-clause terms before coding:\n");
drh118efd12019-12-28 14:07:22 +00001494 sqlite3WhereClausePrint(pWC);
1495 }
1496#endif
drh6f82e852015-06-06 20:12:09 +00001497
1498 /* Create labels for the "break" and "continue" instructions
1499 ** for the current loop. Jump to addrBrk to break out of a loop.
1500 ** Jump to cont to go immediately to the next iteration of the
1501 ** loop.
1502 **
1503 ** When there is an IN operator, we also have a "addrNxt" label that
1504 ** means to continue with the next IN value combination. When
1505 ** there are no IN operators in the constraints, the "addrNxt" label
1506 ** is the same as "addrBrk".
1507 */
drhec4ccdb2018-12-29 02:26:59 +00001508 addrBrk = pLevel->addrBrk = pLevel->addrNxt = sqlite3VdbeMakeLabel(pParse);
1509 addrCont = pLevel->addrCont = sqlite3VdbeMakeLabel(pParse);
drh6f82e852015-06-06 20:12:09 +00001510
1511 /* If this is the right table of a LEFT OUTER JOIN, allocate and
1512 ** initialize a memory cell that records if this table matches any
1513 ** row of the left table of the join.
1514 */
drhc5837192022-04-11 14:26:37 +00001515 assert( (pWInfo->wctrlFlags & (WHERE_OR_SUBCLAUSE|WHERE_RIGHT_JOIN))
dan820fcd22018-04-24 18:53:24 +00001516 || pLevel->iFrom>0 || (pTabItem[0].fg.jointype & JT_LEFT)==0
1517 );
drh8a48b9c2015-08-19 15:20:00 +00001518 if( pLevel->iFrom>0 && (pTabItem[0].fg.jointype & JT_LEFT)!=0 ){
drh6f82e852015-06-06 20:12:09 +00001519 pLevel->iLeftJoin = ++pParse->nMem;
1520 sqlite3VdbeAddOp2(v, OP_Integer, 0, pLevel->iLeftJoin);
1521 VdbeComment((v, "init LEFT JOIN no-match flag"));
1522 }
1523
drh3a3b4202017-02-15 22:36:15 +00001524 /* Compute a safe address to jump to if we discover that the table for
1525 ** this loop is empty and can never contribute content. */
drhd875c7e2022-04-18 10:26:50 +00001526 for(j=iLevel; j>0; j--){
1527 if( pWInfo->a[j].iLeftJoin ) break;
1528 if( pWInfo->a[j].pRJ ) break;
1529 }
drh3a3b4202017-02-15 22:36:15 +00001530 addrHalt = pWInfo->a[j].addrBrk;
1531
drh6f82e852015-06-06 20:12:09 +00001532 /* Special case of a FROM clause subquery implemented as a co-routine */
drh8a48b9c2015-08-19 15:20:00 +00001533 if( pTabItem->fg.viaCoroutine ){
drh6f82e852015-06-06 20:12:09 +00001534 int regYield = pTabItem->regReturn;
1535 sqlite3VdbeAddOp3(v, OP_InitCoroutine, regYield, 0, pTabItem->addrFillSub);
1536 pLevel->p2 = sqlite3VdbeAddOp2(v, OP_Yield, regYield, addrBrk);
1537 VdbeCoverage(v);
drhfef37762018-07-10 19:48:35 +00001538 VdbeComment((v, "next row of %s", pTabItem->pTab->zName));
drh6f82e852015-06-06 20:12:09 +00001539 pLevel->op = OP_Goto;
1540 }else
1541
1542#ifndef SQLITE_OMIT_VIRTUALTABLE
1543 if( (pLoop->wsFlags & WHERE_VIRTUALTABLE)!=0 ){
1544 /* Case 1: The table is a virtual-table. Use the VFilter and VNext
1545 ** to access the data.
1546 */
1547 int iReg; /* P3 Value for OP_VFilter */
1548 int addrNotFound;
1549 int nConstraint = pLoop->nLTerm;
1550
drh6f82e852015-06-06 20:12:09 +00001551 iReg = sqlite3GetTempRange(pParse, nConstraint+2);
1552 addrNotFound = pLevel->addrBrk;
1553 for(j=0; j<nConstraint; j++){
1554 int iTarget = iReg+j+2;
1555 pTerm = pLoop->aLTerm[j];
drh599d5762016-03-08 01:11:51 +00001556 if( NEVER(pTerm==0) ) continue;
drh6f82e852015-06-06 20:12:09 +00001557 if( pTerm->eOperator & WO_IN ){
drh0fe7e7d2022-02-01 14:58:29 +00001558 if( SMASKBIT32(j) & pLoop->u.vtab.mHandleIn ){
1559 int iTab = pParse->nTab++;
1560 int iCache = ++pParse->nMem;
1561 sqlite3CodeRhsOfIN(pParse, pTerm->pExpr, iTab);
1562 sqlite3VdbeAddOp3(v, OP_VInitIn, iTab, iTarget, iCache);
1563 }else{
1564 codeEqualityTerm(pParse, pTerm, pLevel, j, bRev, iTarget);
1565 addrNotFound = pLevel->addrNxt;
1566 }
drh6f82e852015-06-06 20:12:09 +00001567 }else{
dan6256c1c2016-08-08 20:15:41 +00001568 Expr *pRight = pTerm->pExpr->pRight;
drhfc7f27b2016-08-20 00:07:01 +00001569 codeExprOrVector(pParse, pRight, iTarget, 1);
drh8f2c0b52022-01-27 21:18:14 +00001570 if( pTerm->eMatchOp==SQLITE_INDEX_CONSTRAINT_OFFSET
1571 && pLoop->u.vtab.bOmitOffset
1572 ){
1573 assert( pTerm->eOperator==WO_AUX );
1574 assert( pWInfo->pLimit!=0 );
1575 assert( pWInfo->pLimit->iOffset>0 );
1576 sqlite3VdbeAddOp2(v, OP_Integer, 0, pWInfo->pLimit->iOffset);
1577 VdbeComment((v,"Zero OFFSET counter"));
1578 }
drh6f82e852015-06-06 20:12:09 +00001579 }
1580 }
1581 sqlite3VdbeAddOp2(v, OP_Integer, pLoop->u.vtab.idxNum, iReg);
1582 sqlite3VdbeAddOp2(v, OP_Integer, nConstraint, iReg+1);
1583 sqlite3VdbeAddOp4(v, OP_VFilter, iCur, addrNotFound, iReg,
1584 pLoop->u.vtab.idxStr,
drh861b1302016-12-07 20:22:31 +00001585 pLoop->u.vtab.needFree ? P4_DYNAMIC : P4_STATIC);
drh6f82e852015-06-06 20:12:09 +00001586 VdbeCoverage(v);
1587 pLoop->u.vtab.needFree = 0;
drhbc2e9512020-09-17 11:32:14 +00001588 /* An OOM inside of AddOp4(OP_VFilter) instruction above might have freed
1589 ** the u.vtab.idxStr. NULL it out to prevent a use-after-free */
1590 if( db->mallocFailed ) pLoop->u.vtab.idxStr = 0;
drh6f82e852015-06-06 20:12:09 +00001591 pLevel->p1 = iCur;
dan354474a2015-09-29 10:11:26 +00001592 pLevel->op = pWInfo->eOnePass ? OP_Noop : OP_VNext;
drh6f82e852015-06-06 20:12:09 +00001593 pLevel->p2 = sqlite3VdbeCurrentAddr(v);
drh04756292021-10-14 19:28:28 +00001594 assert( (pLoop->wsFlags & WHERE_MULTI_OR)==0 );
drh6d6ea422022-03-07 14:51:29 +00001595
1596 for(j=0; j<nConstraint; j++){
drhdbc49162016-03-02 03:28:07 +00001597 pTerm = pLoop->aLTerm[j];
1598 if( j<16 && (pLoop->u.vtab.omitMask>>j)&1 ){
1599 disableTerm(pLevel, pTerm);
drh6d6ea422022-03-07 14:51:29 +00001600 continue;
1601 }
1602 if( (pTerm->eOperator & WO_IN)!=0
1603 && (SMASKBIT32(j) & pLoop->u.vtab.mHandleIn)==0
1604 && !db->mallocFailed
1605 ){
drhdbc49162016-03-02 03:28:07 +00001606 Expr *pCompare; /* The comparison operator */
1607 Expr *pRight; /* RHS of the comparison */
1608 VdbeOp *pOp; /* Opcode to access the value of the IN constraint */
drh6d6ea422022-03-07 14:51:29 +00001609 int iIn; /* IN loop corresponding to the j-th constraint */
drhdbc49162016-03-02 03:28:07 +00001610
1611 /* Reload the constraint value into reg[iReg+j+2]. The same value
1612 ** was loaded into the same register prior to the OP_VFilter, but
1613 ** the xFilter implementation might have changed the datatype or
drh6d6ea422022-03-07 14:51:29 +00001614 ** encoding of the value in the register, so it *must* be reloaded.
1615 */
1616 for(iIn=0; ALWAYS(iIn<pLevel->u.in.nIn); iIn++){
drh68748ec2019-10-14 20:32:31 +00001617 pOp = sqlite3VdbeGetOp(v, pLevel->u.in.aInLoop[iIn].addrInTop);
drh6d6ea422022-03-07 14:51:29 +00001618 if( (pOp->opcode==OP_Column && pOp->p3==iReg+j+2)
1619 || (pOp->opcode==OP_Rowid && pOp->p2==iReg+j+2)
1620 ){
1621 testcase( pOp->opcode==OP_Rowid );
1622 sqlite3VdbeAddOp3(v, pOp->opcode, pOp->p1, pOp->p2, pOp->p3);
1623 break;
1624 }
drhdbc49162016-03-02 03:28:07 +00001625 }
1626
1627 /* Generate code that will continue to the next row if
drh6d6ea422022-03-07 14:51:29 +00001628 ** the IN constraint is not satisfied
1629 */
drhabfd35e2016-12-06 22:47:23 +00001630 pCompare = sqlite3PExpr(pParse, TK_EQ, 0, 0);
drh6d6ea422022-03-07 14:51:29 +00001631 if( !db->mallocFailed ){
1632 int iFld = pTerm->u.x.iField;
1633 Expr *pLeft = pTerm->pExpr->pLeft;
1634 assert( pLeft!=0 );
1635 if( iFld>0 ){
1636 assert( pLeft->op==TK_VECTOR );
1637 assert( ExprUseXList(pLeft) );
1638 assert( iFld<=pLeft->x.pList->nExpr );
1639 pCompare->pLeft = pLeft->x.pList->a[iFld-1].pExpr;
1640 }else{
1641 pCompare->pLeft = pLeft;
1642 }
drhdbc49162016-03-02 03:28:07 +00001643 pCompare->pRight = pRight = sqlite3Expr(db, TK_REGISTER, 0);
drh237b2b72016-03-07 19:08:27 +00001644 if( pRight ){
1645 pRight->iTable = iReg+j+2;
dand03f77a2020-01-29 15:03:01 +00001646 sqlite3ExprIfFalse(
1647 pParse, pCompare, pLevel->addrCont, SQLITE_JUMPIFNULL
1648 );
drh237b2b72016-03-07 19:08:27 +00001649 }
drhdbc49162016-03-02 03:28:07 +00001650 pCompare->pLeft = 0;
drhdbc49162016-03-02 03:28:07 +00001651 }
drh6d6ea422022-03-07 14:51:29 +00001652 sqlite3ExprDelete(db, pCompare);
drhdbc49162016-03-02 03:28:07 +00001653 }
1654 }
drh6d6ea422022-03-07 14:51:29 +00001655
drhba26faa2016-04-09 18:04:28 +00001656 /* These registers need to be preserved in case there is an IN operator
1657 ** loop. So we could deallocate the registers here (and potentially
1658 ** reuse them later) if (pLoop->wsFlags & WHERE_IN_ABLE)==0. But it seems
1659 ** simpler and safer to simply not reuse the registers.
1660 **
1661 ** sqlite3ReleaseTempRange(pParse, iReg, nConstraint+2);
1662 */
drh6f82e852015-06-06 20:12:09 +00001663 }else
1664#endif /* SQLITE_OMIT_VIRTUALTABLE */
1665
1666 if( (pLoop->wsFlags & WHERE_IPK)!=0
1667 && (pLoop->wsFlags & (WHERE_COLUMN_IN|WHERE_COLUMN_EQ))!=0
1668 ){
1669 /* Case 2: We can directly reference a single row using an
1670 ** equality comparison against the ROWID field. Or
1671 ** we reference multiple rows using a "rowid IN (...)"
1672 ** construct.
1673 */
1674 assert( pLoop->u.btree.nEq==1 );
1675 pTerm = pLoop->aLTerm[0];
1676 assert( pTerm!=0 );
1677 assert( pTerm->pExpr!=0 );
drh6f82e852015-06-06 20:12:09 +00001678 testcase( pTerm->wtFlags & TERM_VIRTUAL );
1679 iReleaseReg = ++pParse->nMem;
1680 iRowidReg = codeEqualityTerm(pParse, pTerm, pLevel, 0, bRev, iReleaseReg);
1681 if( iRowidReg!=iReleaseReg ) sqlite3ReleaseTempReg(pParse, iReleaseReg);
1682 addrNxt = pLevel->addrNxt;
drh2db144c2021-12-01 16:31:02 +00001683 if( pLevel->regFilter ){
1684 sqlite3VdbeAddOp4Int(v, OP_Filter, pLevel->regFilter, addrNxt,
1685 iRowidReg, 1);
drh067c60c2021-12-04 18:45:08 +00001686 VdbeCoverage(v);
drh35685d32021-12-05 00:45:55 +00001687 filterPullDown(pParse, pWInfo, iLevel, addrNxt, notReady);
drh2db144c2021-12-01 16:31:02 +00001688 }
drheeb95652016-05-26 20:56:38 +00001689 sqlite3VdbeAddOp3(v, OP_SeekRowid, iCur, addrNxt, iRowidReg);
drh6f82e852015-06-06 20:12:09 +00001690 VdbeCoverage(v);
drh6f82e852015-06-06 20:12:09 +00001691 pLevel->op = OP_Noop;
1692 }else if( (pLoop->wsFlags & WHERE_IPK)!=0
1693 && (pLoop->wsFlags & WHERE_COLUMN_RANGE)!=0
1694 ){
1695 /* Case 3: We have an inequality comparison against the ROWID field.
1696 */
1697 int testOp = OP_Noop;
1698 int start;
1699 int memEndValue = 0;
1700 WhereTerm *pStart, *pEnd;
1701
drh6f82e852015-06-06 20:12:09 +00001702 j = 0;
1703 pStart = pEnd = 0;
1704 if( pLoop->wsFlags & WHERE_BTM_LIMIT ) pStart = pLoop->aLTerm[j++];
1705 if( pLoop->wsFlags & WHERE_TOP_LIMIT ) pEnd = pLoop->aLTerm[j++];
1706 assert( pStart!=0 || pEnd!=0 );
1707 if( bRev ){
1708 pTerm = pStart;
1709 pStart = pEnd;
1710 pEnd = pTerm;
1711 }
danb324cf72016-06-17 14:33:32 +00001712 codeCursorHint(pTabItem, pWInfo, pLevel, pEnd);
drh6f82e852015-06-06 20:12:09 +00001713 if( pStart ){
1714 Expr *pX; /* The expression that defines the start bound */
1715 int r1, rTemp; /* Registers for holding the start boundary */
dan19ff12d2016-07-29 20:58:19 +00001716 int op; /* Cursor seek operation */
drh6f82e852015-06-06 20:12:09 +00001717
1718 /* The following constant maps TK_xx codes into corresponding
1719 ** seek opcodes. It depends on a particular ordering of TK_xx
1720 */
1721 const u8 aMoveOp[] = {
1722 /* TK_GT */ OP_SeekGT,
1723 /* TK_LE */ OP_SeekLE,
1724 /* TK_LT */ OP_SeekLT,
1725 /* TK_GE */ OP_SeekGE
1726 };
1727 assert( TK_LE==TK_GT+1 ); /* Make sure the ordering.. */
1728 assert( TK_LT==TK_GT+2 ); /* ... of the TK_xx values... */
1729 assert( TK_GE==TK_GT+3 ); /* ... is correcct. */
1730
1731 assert( (pStart->wtFlags & TERM_VNULL)==0 );
1732 testcase( pStart->wtFlags & TERM_VIRTUAL );
1733 pX = pStart->pExpr;
1734 assert( pX!=0 );
1735 testcase( pStart->leftCursor!=iCur ); /* transitive constraints */
dan625015e2016-07-30 16:39:28 +00001736 if( sqlite3ExprIsVector(pX->pRight) ){
dan19ff12d2016-07-29 20:58:19 +00001737 r1 = rTemp = sqlite3GetTempReg(pParse);
1738 codeExprOrVector(pParse, pX->pRight, r1, 1);
drh4d1c6842018-02-13 18:48:08 +00001739 testcase( pX->op==TK_GT );
1740 testcase( pX->op==TK_GE );
1741 testcase( pX->op==TK_LT );
1742 testcase( pX->op==TK_LE );
1743 op = aMoveOp[((pX->op - TK_GT - 1) & 0x3) | 0x1];
1744 assert( pX->op!=TK_GT || op==OP_SeekGE );
1745 assert( pX->op!=TK_GE || op==OP_SeekGE );
1746 assert( pX->op!=TK_LT || op==OP_SeekLE );
1747 assert( pX->op!=TK_LE || op==OP_SeekLE );
dan19ff12d2016-07-29 20:58:19 +00001748 }else{
1749 r1 = sqlite3ExprCodeTemp(pParse, pX->pRight, &rTemp);
1750 disableTerm(pLevel, pStart);
1751 op = aMoveOp[(pX->op - TK_GT)];
1752 }
1753 sqlite3VdbeAddOp3(v, op, iCur, addrBrk, r1);
drh6f82e852015-06-06 20:12:09 +00001754 VdbeComment((v, "pk"));
1755 VdbeCoverageIf(v, pX->op==TK_GT);
1756 VdbeCoverageIf(v, pX->op==TK_LE);
1757 VdbeCoverageIf(v, pX->op==TK_LT);
1758 VdbeCoverageIf(v, pX->op==TK_GE);
drh6f82e852015-06-06 20:12:09 +00001759 sqlite3ReleaseTempReg(pParse, rTemp);
drh6f82e852015-06-06 20:12:09 +00001760 }else{
drh3a3b4202017-02-15 22:36:15 +00001761 sqlite3VdbeAddOp2(v, bRev ? OP_Last : OP_Rewind, iCur, addrHalt);
drh6f82e852015-06-06 20:12:09 +00001762 VdbeCoverageIf(v, bRev==0);
1763 VdbeCoverageIf(v, bRev!=0);
1764 }
1765 if( pEnd ){
1766 Expr *pX;
1767 pX = pEnd->pExpr;
1768 assert( pX!=0 );
1769 assert( (pEnd->wtFlags & TERM_VNULL)==0 );
1770 testcase( pEnd->leftCursor!=iCur ); /* Transitive constraints */
1771 testcase( pEnd->wtFlags & TERM_VIRTUAL );
1772 memEndValue = ++pParse->nMem;
dan19ff12d2016-07-29 20:58:19 +00001773 codeExprOrVector(pParse, pX->pRight, memEndValue, 1);
dan625015e2016-07-30 16:39:28 +00001774 if( 0==sqlite3ExprIsVector(pX->pRight)
1775 && (pX->op==TK_LT || pX->op==TK_GT)
1776 ){
drh6f82e852015-06-06 20:12:09 +00001777 testOp = bRev ? OP_Le : OP_Ge;
1778 }else{
1779 testOp = bRev ? OP_Lt : OP_Gt;
1780 }
dan553168c2016-08-01 20:14:31 +00001781 if( 0==sqlite3ExprIsVector(pX->pRight) ){
1782 disableTerm(pLevel, pEnd);
1783 }
drh6f82e852015-06-06 20:12:09 +00001784 }
1785 start = sqlite3VdbeCurrentAddr(v);
1786 pLevel->op = bRev ? OP_Prev : OP_Next;
1787 pLevel->p1 = iCur;
1788 pLevel->p2 = start;
1789 assert( pLevel->p5==0 );
1790 if( testOp!=OP_Noop ){
1791 iRowidReg = ++pParse->nMem;
1792 sqlite3VdbeAddOp2(v, OP_Rowid, iCur, iRowidReg);
drh6f82e852015-06-06 20:12:09 +00001793 sqlite3VdbeAddOp3(v, testOp, memEndValue, addrBrk, iRowidReg);
1794 VdbeCoverageIf(v, testOp==OP_Le);
1795 VdbeCoverageIf(v, testOp==OP_Lt);
1796 VdbeCoverageIf(v, testOp==OP_Ge);
1797 VdbeCoverageIf(v, testOp==OP_Gt);
1798 sqlite3VdbeChangeP5(v, SQLITE_AFF_NUMERIC | SQLITE_JUMPIFNULL);
1799 }
1800 }else if( pLoop->wsFlags & WHERE_INDEXED ){
1801 /* Case 4: A scan using an index.
1802 **
1803 ** The WHERE clause may contain zero or more equality
1804 ** terms ("==" or "IN" operators) that refer to the N
1805 ** left-most columns of the index. It may also contain
1806 ** inequality constraints (>, <, >= or <=) on the indexed
1807 ** column that immediately follows the N equalities. Only
1808 ** the right-most column can be an inequality - the rest must
1809 ** use the "==" and "IN" operators. For example, if the
1810 ** index is on (x,y,z), then the following clauses are all
1811 ** optimized:
1812 **
1813 ** x=5
1814 ** x=5 AND y=10
1815 ** x=5 AND y<10
1816 ** x=5 AND y>5 AND y<10
1817 ** x=5 AND y=5 AND z<=10
1818 **
1819 ** The z<10 term of the following cannot be used, only
1820 ** the x=5 term:
1821 **
1822 ** x=5 AND z<10
1823 **
1824 ** N may be zero if there are inequality constraints.
1825 ** If there are no inequality constraints, then N is at
1826 ** least one.
1827 **
1828 ** This case is also used when there are no WHERE clause
1829 ** constraints but an index is selected anyway, in order
1830 ** to force the output order to conform to an ORDER BY.
1831 */
1832 static const u8 aStartOp[] = {
1833 0,
1834 0,
1835 OP_Rewind, /* 2: (!start_constraints && startEq && !bRev) */
1836 OP_Last, /* 3: (!start_constraints && startEq && bRev) */
1837 OP_SeekGT, /* 4: (start_constraints && !startEq && !bRev) */
1838 OP_SeekLT, /* 5: (start_constraints && !startEq && bRev) */
1839 OP_SeekGE, /* 6: (start_constraints && startEq && !bRev) */
1840 OP_SeekLE /* 7: (start_constraints && startEq && bRev) */
1841 };
1842 static const u8 aEndOp[] = {
1843 OP_IdxGE, /* 0: (end_constraints && !bRev && !endEq) */
1844 OP_IdxGT, /* 1: (end_constraints && !bRev && endEq) */
1845 OP_IdxLE, /* 2: (end_constraints && bRev && !endEq) */
1846 OP_IdxLT, /* 3: (end_constraints && bRev && endEq) */
1847 };
1848 u16 nEq = pLoop->u.btree.nEq; /* Number of == or IN terms */
dan71c57db2016-07-09 20:23:55 +00001849 u16 nBtm = pLoop->u.btree.nBtm; /* Length of BTM vector */
1850 u16 nTop = pLoop->u.btree.nTop; /* Length of TOP vector */
drh6f82e852015-06-06 20:12:09 +00001851 int regBase; /* Base register holding constraint values */
1852 WhereTerm *pRangeStart = 0; /* Inequality constraint at range start */
1853 WhereTerm *pRangeEnd = 0; /* Inequality constraint at range end */
1854 int startEq; /* True if range start uses ==, >= or <= */
1855 int endEq; /* True if range end uses ==, >= or <= */
1856 int start_constraints; /* Start of range is constrained */
1857 int nConstraint; /* Number of constraint terms */
drh6f82e852015-06-06 20:12:09 +00001858 int iIdxCur; /* The VDBE cursor for the index */
1859 int nExtraReg = 0; /* Number of extra registers needed */
1860 int op; /* Instruction opcode */
1861 char *zStartAff; /* Affinity for start of range constraint */
danb7ca2172016-08-26 17:54:46 +00001862 char *zEndAff = 0; /* Affinity for end of range constraint */
drh6f82e852015-06-06 20:12:09 +00001863 u8 bSeekPastNull = 0; /* True to seek past initial nulls */
1864 u8 bStopAtNull = 0; /* Add condition to terminate at NULLs */
drh47df8a22018-12-25 00:15:37 +00001865 int omitTable; /* True if we use the index only */
drh74e1b862019-08-23 13:08:49 +00001866 int regBignull = 0; /* big-null flag register */
drh04e70ce2020-10-02 11:55:07 +00001867 int addrSeekScan = 0; /* Opcode of the OP_SeekScan, if any */
drh6f82e852015-06-06 20:12:09 +00001868
1869 pIdx = pLoop->u.btree.pIndex;
1870 iIdxCur = pLevel->iIdxCur;
1871 assert( nEq>=pLoop->nSkip );
1872
drh6f82e852015-06-06 20:12:09 +00001873 /* Find any inequality constraint terms for the start and end
1874 ** of the range.
1875 */
1876 j = nEq;
1877 if( pLoop->wsFlags & WHERE_BTM_LIMIT ){
1878 pRangeStart = pLoop->aLTerm[j++];
dan71c57db2016-07-09 20:23:55 +00001879 nExtraReg = MAX(nExtraReg, pLoop->u.btree.nBtm);
drh6f82e852015-06-06 20:12:09 +00001880 /* Like optimization range constraints always occur in pairs */
1881 assert( (pRangeStart->wtFlags & TERM_LIKEOPT)==0 ||
1882 (pLoop->wsFlags & WHERE_TOP_LIMIT)!=0 );
1883 }
1884 if( pLoop->wsFlags & WHERE_TOP_LIMIT ){
1885 pRangeEnd = pLoop->aLTerm[j++];
dan71c57db2016-07-09 20:23:55 +00001886 nExtraReg = MAX(nExtraReg, pLoop->u.btree.nTop);
drh41d2e662015-12-01 21:23:07 +00001887#ifndef SQLITE_LIKE_DOESNT_MATCH_BLOBS
drh6f82e852015-06-06 20:12:09 +00001888 if( (pRangeEnd->wtFlags & TERM_LIKEOPT)!=0 ){
1889 assert( pRangeStart!=0 ); /* LIKE opt constraints */
1890 assert( pRangeStart->wtFlags & TERM_LIKEOPT ); /* occur in pairs */
drh44aebff2016-05-02 10:25:42 +00001891 pLevel->iLikeRepCntr = (u32)++pParse->nMem;
1892 sqlite3VdbeAddOp2(v, OP_Integer, 1, (int)pLevel->iLikeRepCntr);
drh6f82e852015-06-06 20:12:09 +00001893 VdbeComment((v, "LIKE loop counter"));
1894 pLevel->addrLikeRep = sqlite3VdbeCurrentAddr(v);
drh44aebff2016-05-02 10:25:42 +00001895 /* iLikeRepCntr actually stores 2x the counter register number. The
1896 ** bottom bit indicates whether the search order is ASC or DESC. */
1897 testcase( bRev );
1898 testcase( pIdx->aSortOrder[nEq]==SQLITE_SO_DESC );
1899 assert( (bRev & ~1)==0 );
1900 pLevel->iLikeRepCntr <<=1;
1901 pLevel->iLikeRepCntr |= bRev ^ (pIdx->aSortOrder[nEq]==SQLITE_SO_DESC);
drh6f82e852015-06-06 20:12:09 +00001902 }
drh41d2e662015-12-01 21:23:07 +00001903#endif
drh48590fc2016-10-10 13:29:15 +00001904 if( pRangeStart==0 ){
1905 j = pIdx->aiColumn[nEq];
1906 if( (j>=0 && pIdx->pTable->aCol[j].notNull==0) || j==XN_EXPR ){
1907 bSeekPastNull = 1;
1908 }
drh6f82e852015-06-06 20:12:09 +00001909 }
1910 }
1911 assert( pRangeEnd==0 || (pRangeEnd->wtFlags & TERM_VNULL)==0 );
1912
dan15750a22019-08-16 21:07:19 +00001913 /* If the WHERE_BIGNULL_SORT flag is set, then index column nEq uses
1914 ** a non-default "big-null" sort (either ASC NULLS LAST or DESC NULLS
1915 ** FIRST). In both cases separate ordered scans are made of those
1916 ** index entries for which the column is null and for those for which
1917 ** it is not. For an ASC sort, the non-NULL entries are scanned first.
1918 ** For DESC, NULL entries are scanned first.
1919 */
dan15750a22019-08-16 21:07:19 +00001920 if( (pLoop->wsFlags & (WHERE_TOP_LIMIT|WHERE_BTM_LIMIT))==0
1921 && (pLoop->wsFlags & WHERE_BIGNULL_SORT)!=0
1922 ){
1923 assert( bSeekPastNull==0 && nExtraReg==0 && nBtm==0 && nTop==0 );
1924 assert( pRangeEnd==0 && pRangeStart==0 );
dan4adb1d02019-12-28 18:08:39 +00001925 testcase( pLoop->nSkip>0 );
dan15750a22019-08-16 21:07:19 +00001926 nExtraReg = 1;
1927 bSeekPastNull = 1;
1928 pLevel->regBignull = regBignull = ++pParse->nMem;
drh7f05d522020-03-02 01:16:33 +00001929 if( pLevel->iLeftJoin ){
1930 sqlite3VdbeAddOp2(v, OP_Integer, 0, regBignull);
1931 }
dancc491f42019-08-17 17:55:54 +00001932 pLevel->addrBignull = sqlite3VdbeMakeLabel(pParse);
dan15750a22019-08-16 21:07:19 +00001933 }
1934
drh6f82e852015-06-06 20:12:09 +00001935 /* If we are doing a reverse order scan on an ascending index, or
1936 ** a forward order scan on a descending index, interchange the
1937 ** start and end terms (pRangeStart and pRangeEnd).
1938 */
drh7ffb16b2021-05-12 22:15:44 +00001939 if( (nEq<pIdx->nColumn && bRev==(pIdx->aSortOrder[nEq]==SQLITE_SO_ASC)) ){
drh6f82e852015-06-06 20:12:09 +00001940 SWAP(WhereTerm *, pRangeEnd, pRangeStart);
1941 SWAP(u8, bSeekPastNull, bStopAtNull);
dan71c57db2016-07-09 20:23:55 +00001942 SWAP(u8, nBtm, nTop);
drh6f82e852015-06-06 20:12:09 +00001943 }
1944
dandf1b52e2021-01-27 17:15:06 +00001945 if( iLevel>0 && (pLoop->wsFlags & WHERE_IN_SEEKSCAN)!=0 ){
1946 /* In case OP_SeekScan is used, ensure that the index cursor does not
1947 ** point to a valid row for the first iteration of this loop. */
1948 sqlite3VdbeAddOp1(v, OP_NullRow, iIdxCur);
1949 }
1950
drhbcf40a72015-08-18 15:58:05 +00001951 /* Generate code to evaluate all constraint terms using == or IN
1952 ** and store the values of those terms in an array of registers
1953 ** starting at regBase.
1954 */
danb324cf72016-06-17 14:33:32 +00001955 codeCursorHint(pTabItem, pWInfo, pLevel, pRangeEnd);
drhbcf40a72015-08-18 15:58:05 +00001956 regBase = codeAllEqualityTerms(pParse,pLevel,bRev,nExtraReg,&zStartAff);
1957 assert( zStartAff==0 || sqlite3Strlen30(zStartAff)>=nEq );
danb7ca2172016-08-26 17:54:46 +00001958 if( zStartAff && nTop ){
1959 zEndAff = sqlite3DbStrDup(db, &zStartAff[nEq]);
1960 }
dancc491f42019-08-17 17:55:54 +00001961 addrNxt = (regBignull ? pLevel->addrBignull : pLevel->addrNxt);
drhbcf40a72015-08-18 15:58:05 +00001962
drh6f82e852015-06-06 20:12:09 +00001963 testcase( pRangeStart && (pRangeStart->eOperator & WO_LE)!=0 );
1964 testcase( pRangeStart && (pRangeStart->eOperator & WO_GE)!=0 );
1965 testcase( pRangeEnd && (pRangeEnd->eOperator & WO_LE)!=0 );
1966 testcase( pRangeEnd && (pRangeEnd->eOperator & WO_GE)!=0 );
1967 startEq = !pRangeStart || pRangeStart->eOperator & (WO_LE|WO_GE);
1968 endEq = !pRangeEnd || pRangeEnd->eOperator & (WO_LE|WO_GE);
1969 start_constraints = pRangeStart || nEq>0;
1970
1971 /* Seek the index cursor to the start of the range. */
1972 nConstraint = nEq;
1973 if( pRangeStart ){
1974 Expr *pRight = pRangeStart->pExpr->pRight;
dan71c57db2016-07-09 20:23:55 +00001975 codeExprOrVector(pParse, pRight, regBase+nEq, nBtm);
drh6f82e852015-06-06 20:12:09 +00001976 whereLikeOptimizationStringFixup(v, pLevel, pRangeStart);
drh395a60d2020-09-30 17:32:22 +00001977 if( (pRangeStart->wtFlags & TERM_VNULL)==0
drh6f82e852015-06-06 20:12:09 +00001978 && sqlite3ExprCanBeNull(pRight)
1979 ){
1980 sqlite3VdbeAddOp2(v, OP_IsNull, regBase+nEq, addrNxt);
1981 VdbeCoverage(v);
1982 }
1983 if( zStartAff ){
drhe3c6b612016-10-05 20:10:32 +00001984 updateRangeAffinityStr(pRight, nBtm, &zStartAff[nEq]);
drh6f82e852015-06-06 20:12:09 +00001985 }
dan71c57db2016-07-09 20:23:55 +00001986 nConstraint += nBtm;
drh6f82e852015-06-06 20:12:09 +00001987 testcase( pRangeStart->wtFlags & TERM_VIRTUAL );
dan625015e2016-07-30 16:39:28 +00001988 if( sqlite3ExprIsVector(pRight)==0 ){
dan71c57db2016-07-09 20:23:55 +00001989 disableTerm(pLevel, pRangeStart);
1990 }else{
1991 startEq = 1;
1992 }
drh426f4ab2016-07-26 04:31:14 +00001993 bSeekPastNull = 0;
drh6f82e852015-06-06 20:12:09 +00001994 }else if( bSeekPastNull ){
drh6f82e852015-06-06 20:12:09 +00001995 startEq = 0;
drh0086e072019-08-23 16:12:20 +00001996 sqlite3VdbeAddOp2(v, OP_Null, 0, regBase+nEq);
drh6f82e852015-06-06 20:12:09 +00001997 start_constraints = 1;
drh0086e072019-08-23 16:12:20 +00001998 nConstraint++;
dan15750a22019-08-16 21:07:19 +00001999 }else if( regBignull ){
2000 sqlite3VdbeAddOp2(v, OP_Null, 0, regBase+nEq);
2001 start_constraints = 1;
2002 nConstraint++;
drh6f82e852015-06-06 20:12:09 +00002003 }
2004 codeApplyAffinity(pParse, regBase, nConstraint - bSeekPastNull, zStartAff);
drh0bf2ad62016-02-22 21:19:54 +00002005 if( pLoop->nSkip>0 && nConstraint==pLoop->nSkip ){
2006 /* The skip-scan logic inside the call to codeAllEqualityConstraints()
2007 ** above has already left the cursor sitting on the correct row,
2008 ** so no further seeking is needed */
2009 }else{
dan15750a22019-08-16 21:07:19 +00002010 if( regBignull ){
drhec3dda52019-08-23 13:32:03 +00002011 sqlite3VdbeAddOp2(v, OP_Integer, 1, regBignull);
drha31d3552019-08-23 17:09:02 +00002012 VdbeComment((v, "NULL-scan pass ctr"));
dan15750a22019-08-16 21:07:19 +00002013 }
drh2db144c2021-12-01 16:31:02 +00002014 if( pLevel->regFilter ){
2015 sqlite3VdbeAddOp4Int(v, OP_Filter, pLevel->regFilter, addrNxt,
drh770dade2021-12-04 14:24:30 +00002016 regBase, nEq);
drh067c60c2021-12-04 18:45:08 +00002017 VdbeCoverage(v);
drh35685d32021-12-05 00:45:55 +00002018 filterPullDown(pParse, pWInfo, iLevel, addrNxt, notReady);
drh2db144c2021-12-01 16:31:02 +00002019 }
dan15750a22019-08-16 21:07:19 +00002020
drha6d2f8e2016-02-22 20:52:26 +00002021 op = aStartOp[(start_constraints<<2) + (startEq<<1) + bRev];
2022 assert( op!=0 );
drh7d14ffe2020-10-02 13:48:57 +00002023 if( (pLoop->wsFlags & WHERE_IN_SEEKSCAN)!=0 && op==OP_SeekGE ){
drh68cf0ac2020-09-28 19:51:54 +00002024 assert( regBignull==0 );
drh4f65b3b2020-09-30 18:03:22 +00002025 /* TUNING: The OP_SeekScan opcode seeks to reduce the number
2026 ** of expensive seek operations by replacing a single seek with
2027 ** 1 or more step operations. The question is, how many steps
2028 ** should we try before giving up and going with a seek. The cost
2029 ** of a seek is proportional to the logarithm of the of the number
2030 ** of entries in the tree, so basing the number of steps to try
2031 ** on the estimated number of rows in the btree seems like a good
2032 ** guess. */
drh04e70ce2020-10-02 11:55:07 +00002033 addrSeekScan = sqlite3VdbeAddOp1(v, OP_SeekScan,
2034 (pIdx->aiRowLogEst[0]+9)/10);
drh4f65b3b2020-09-30 18:03:22 +00002035 VdbeCoverage(v);
drh68cf0ac2020-09-28 19:51:54 +00002036 }
drha6d2f8e2016-02-22 20:52:26 +00002037 sqlite3VdbeAddOp4Int(v, op, iIdxCur, addrNxt, regBase, nConstraint);
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_SeekGT); testcase( op==OP_SeekGT );
2042 VdbeCoverageIf(v, op==OP_SeekGE); testcase( op==OP_SeekGE );
2043 VdbeCoverageIf(v, op==OP_SeekLE); testcase( op==OP_SeekLE );
2044 VdbeCoverageIf(v, op==OP_SeekLT); testcase( op==OP_SeekLT );
danddd74212019-08-02 18:43:59 +00002045
drh0086e072019-08-23 16:12:20 +00002046 assert( bSeekPastNull==0 || bStopAtNull==0 );
dan15750a22019-08-16 21:07:19 +00002047 if( regBignull ){
drh0086e072019-08-23 16:12:20 +00002048 assert( bSeekPastNull==1 || bStopAtNull==1 );
drh5f6a4ea2019-08-23 17:00:22 +00002049 assert( bSeekPastNull==!bStopAtNull );
drh0086e072019-08-23 16:12:20 +00002050 assert( bStopAtNull==startEq );
danddd74212019-08-02 18:43:59 +00002051 sqlite3VdbeAddOp2(v, OP_Goto, 0, sqlite3VdbeCurrentAddr(v)+2);
drh0086e072019-08-23 16:12:20 +00002052 op = aStartOp[(nConstraint>1)*4 + 2 + bRev];
2053 sqlite3VdbeAddOp4Int(v, op, iIdxCur, addrNxt, regBase,
2054 nConstraint-startEq);
2055 VdbeCoverage(v);
2056 VdbeCoverageIf(v, op==OP_Rewind); testcase( op==OP_Rewind );
2057 VdbeCoverageIf(v, op==OP_Last); testcase( op==OP_Last );
2058 VdbeCoverageIf(v, op==OP_SeekGE); testcase( op==OP_SeekGE );
2059 VdbeCoverageIf(v, op==OP_SeekLE); testcase( op==OP_SeekLE );
2060 assert( op==OP_Rewind || op==OP_Last || op==OP_SeekGE || op==OP_SeekLE);
danddd74212019-08-02 18:43:59 +00002061 }
drha6d2f8e2016-02-22 20:52:26 +00002062 }
drh0bf2ad62016-02-22 21:19:54 +00002063
drh6f82e852015-06-06 20:12:09 +00002064 /* Load the value for the inequality constraint at the end of the
2065 ** range (if any).
2066 */
2067 nConstraint = nEq;
drh5d742e32021-11-02 20:52:20 +00002068 assert( pLevel->p2==0 );
drh6f82e852015-06-06 20:12:09 +00002069 if( pRangeEnd ){
2070 Expr *pRight = pRangeEnd->pExpr->pRight;
drh5d742e32021-11-02 20:52:20 +00002071 if( addrSeekScan ){
2072 /* For a seek-scan that has a range on the lowest term of the index,
2073 ** we have to make the top of the loop be code that sets the end
2074 ** condition of the range. Otherwise, the OP_SeekScan might jump
2075 ** over that initialization, leaving the range-end value set to the
2076 ** range-start value, resulting in a wrong answer.
2077 ** See ticket 5981a8c041a3c2f3 (2021-11-02).
2078 */
2079 pLevel->p2 = sqlite3VdbeCurrentAddr(v);
2080 }
dan71c57db2016-07-09 20:23:55 +00002081 codeExprOrVector(pParse, pRight, regBase+nEq, nTop);
drh6f82e852015-06-06 20:12:09 +00002082 whereLikeOptimizationStringFixup(v, pLevel, pRangeEnd);
drh395a60d2020-09-30 17:32:22 +00002083 if( (pRangeEnd->wtFlags & TERM_VNULL)==0
drh6f82e852015-06-06 20:12:09 +00002084 && sqlite3ExprCanBeNull(pRight)
2085 ){
2086 sqlite3VdbeAddOp2(v, OP_IsNull, regBase+nEq, addrNxt);
2087 VdbeCoverage(v);
2088 }
drh0c36fca2016-08-26 18:17:08 +00002089 if( zEndAff ){
drhe3c6b612016-10-05 20:10:32 +00002090 updateRangeAffinityStr(pRight, nTop, zEndAff);
drh0c36fca2016-08-26 18:17:08 +00002091 codeApplyAffinity(pParse, regBase+nEq, nTop, zEndAff);
2092 }else{
2093 assert( pParse->db->mallocFailed );
2094 }
dan71c57db2016-07-09 20:23:55 +00002095 nConstraint += nTop;
drh6f82e852015-06-06 20:12:09 +00002096 testcase( pRangeEnd->wtFlags & TERM_VIRTUAL );
dan71c57db2016-07-09 20:23:55 +00002097
dan625015e2016-07-30 16:39:28 +00002098 if( sqlite3ExprIsVector(pRight)==0 ){
dan71c57db2016-07-09 20:23:55 +00002099 disableTerm(pLevel, pRangeEnd);
2100 }else{
2101 endEq = 1;
2102 }
drh6f82e852015-06-06 20:12:09 +00002103 }else if( bStopAtNull ){
dan15750a22019-08-16 21:07:19 +00002104 if( regBignull==0 ){
2105 sqlite3VdbeAddOp2(v, OP_Null, 0, regBase+nEq);
2106 endEq = 0;
2107 }
drh6f82e852015-06-06 20:12:09 +00002108 nConstraint++;
2109 }
2110 sqlite3DbFree(db, zStartAff);
danb7ca2172016-08-26 17:54:46 +00002111 sqlite3DbFree(db, zEndAff);
drh6f82e852015-06-06 20:12:09 +00002112
2113 /* Top of the loop body */
drh5d742e32021-11-02 20:52:20 +00002114 if( pLevel->p2==0 ) pLevel->p2 = sqlite3VdbeCurrentAddr(v);
drh6f82e852015-06-06 20:12:09 +00002115
2116 /* Check if the index cursor is past the end of the range. */
2117 if( nConstraint ){
dan15750a22019-08-16 21:07:19 +00002118 if( regBignull ){
drh5f6a4ea2019-08-23 17:00:22 +00002119 /* Except, skip the end-of-range check while doing the NULL-scan */
drhec3dda52019-08-23 13:32:03 +00002120 sqlite3VdbeAddOp2(v, OP_IfNot, regBignull, sqlite3VdbeCurrentAddr(v)+3);
drha31d3552019-08-23 17:09:02 +00002121 VdbeComment((v, "If NULL-scan 2nd pass"));
drh505ae9d2019-08-22 21:13:56 +00002122 VdbeCoverage(v);
dan15750a22019-08-16 21:07:19 +00002123 }
drh6f82e852015-06-06 20:12:09 +00002124 op = aEndOp[bRev*2 + endEq];
2125 sqlite3VdbeAddOp4Int(v, op, iIdxCur, addrNxt, regBase, nConstraint);
2126 testcase( op==OP_IdxGT ); VdbeCoverageIf(v, op==OP_IdxGT );
2127 testcase( op==OP_IdxGE ); VdbeCoverageIf(v, op==OP_IdxGE );
2128 testcase( op==OP_IdxLT ); VdbeCoverageIf(v, op==OP_IdxLT );
2129 testcase( op==OP_IdxLE ); VdbeCoverageIf(v, op==OP_IdxLE );
drh04e70ce2020-10-02 11:55:07 +00002130 if( addrSeekScan ) sqlite3VdbeJumpHere(v, addrSeekScan);
drh6f82e852015-06-06 20:12:09 +00002131 }
dan15750a22019-08-16 21:07:19 +00002132 if( regBignull ){
drh5f6a4ea2019-08-23 17:00:22 +00002133 /* During a NULL-scan, check to see if we have reached the end of
2134 ** the NULLs */
2135 assert( bSeekPastNull==!bStopAtNull );
2136 assert( bSeekPastNull+bStopAtNull==1 );
2137 assert( nConstraint+bSeekPastNull>0 );
drhec3dda52019-08-23 13:32:03 +00002138 sqlite3VdbeAddOp2(v, OP_If, regBignull, sqlite3VdbeCurrentAddr(v)+2);
drha31d3552019-08-23 17:09:02 +00002139 VdbeComment((v, "If NULL-scan 1st pass"));
drh505ae9d2019-08-22 21:13:56 +00002140 VdbeCoverage(v);
drh5f6a4ea2019-08-23 17:00:22 +00002141 op = aEndOp[bRev*2 + bSeekPastNull];
2142 sqlite3VdbeAddOp4Int(v, op, iIdxCur, addrNxt, regBase,
2143 nConstraint+bSeekPastNull);
2144 testcase( op==OP_IdxGT ); VdbeCoverageIf(v, op==OP_IdxGT );
2145 testcase( op==OP_IdxGE ); VdbeCoverageIf(v, op==OP_IdxGE );
2146 testcase( op==OP_IdxLT ); VdbeCoverageIf(v, op==OP_IdxLT );
2147 testcase( op==OP_IdxLE ); VdbeCoverageIf(v, op==OP_IdxLE );
dan15750a22019-08-16 21:07:19 +00002148 }
drh6f82e852015-06-06 20:12:09 +00002149
drhf761d932020-09-29 01:48:46 +00002150 if( (pLoop->wsFlags & WHERE_IN_EARLYOUT)!=0 ){
drhfa17e132020-09-01 01:52:03 +00002151 sqlite3VdbeAddOp3(v, OP_SeekHit, iIdxCur, nEq, nEq);
drh8c2b6d72018-06-05 20:45:20 +00002152 }
2153
drh6f82e852015-06-06 20:12:09 +00002154 /* Seek the table cursor, if required */
drh47df8a22018-12-25 00:15:37 +00002155 omitTable = (pLoop->wsFlags & WHERE_IDX_ONLY)!=0
drhc5837192022-04-11 14:26:37 +00002156 && (pWInfo->wctrlFlags & (WHERE_OR_SUBCLAUSE|WHERE_RIGHT_JOIN))==0;
drh6f82e852015-06-06 20:12:09 +00002157 if( omitTable ){
2158 /* pIdx is a covering index. No need to access the main table. */
2159 }else if( HasRowid(pIdx->pTable) ){
drh68c0c712020-08-14 20:04:26 +00002160 codeDeferredSeek(pWInfo, pIdx, iCur, iIdxCur);
drh6f82e852015-06-06 20:12:09 +00002161 }else if( iCur!=iIdxCur ){
2162 Index *pPk = sqlite3PrimaryKeyIndex(pIdx->pTable);
2163 iRowidReg = sqlite3GetTempRange(pParse, pPk->nKeyCol);
2164 for(j=0; j<pPk->nKeyCol; j++){
drhb9bcf7c2019-10-19 13:29:10 +00002165 k = sqlite3TableColumnToIndex(pIdx, pPk->aiColumn[j]);
drh6f82e852015-06-06 20:12:09 +00002166 sqlite3VdbeAddOp3(v, OP_Column, iIdxCur, k, iRowidReg+j);
2167 }
2168 sqlite3VdbeAddOp4Int(v, OP_NotFound, iCur, addrCont,
2169 iRowidReg, pPk->nKeyCol); VdbeCoverage(v);
2170 }
2171
drhdb535392019-11-03 00:07:41 +00002172 if( pLevel->iLeftJoin==0 ){
2173 /* If pIdx is an index on one or more expressions, then look through
2174 ** all the expressions in pWInfo and try to transform matching expressions
2175 ** into reference to index columns. Also attempt to translate references
2176 ** to virtual columns in the table into references to (stored) columns
2177 ** of the index.
2178 **
2179 ** Do not do this for the RHS of a LEFT JOIN. This is because the
2180 ** expression may be evaluated after OP_NullRow has been executed on
2181 ** the cursor. In this case it is important to do the full evaluation,
2182 ** as the result of the expression may not be NULL, even if all table
2183 ** column values are. https://www.sqlite.org/src/info/7fa8049685b50b5a
2184 **
2185 ** Also, do not do this when processing one index an a multi-index
2186 ** OR clause, since the transformation will become invalid once we
2187 ** move forward to the next index.
2188 ** https://sqlite.org/src/info/4e8e4857d32d401f
2189 */
drhc5837192022-04-11 14:26:37 +00002190 if( (pWInfo->wctrlFlags & (WHERE_OR_SUBCLAUSE|WHERE_RIGHT_JOIN))==0 ){
drhdb535392019-11-03 00:07:41 +00002191 whereIndexExprTrans(pIdx, iCur, iIdxCur, pWInfo);
2192 }
2193
2194 /* If a partial index is driving the loop, try to eliminate WHERE clause
2195 ** terms from the query that must be true due to the WHERE clause of
2196 ** the partial index.
2197 **
2198 ** 2019-11-02 ticket 623eff57e76d45f6: This optimization does not work
2199 ** for a LEFT JOIN.
2200 */
2201 if( pIdx->pPartIdxWhere ){
2202 whereApplyPartialIndexConstraints(pIdx->pPartIdxWhere, iCur, pWC);
2203 }
2204 }else{
drhdb535392019-11-03 00:07:41 +00002205 testcase( pIdx->pPartIdxWhere );
drh06fc2452019-11-04 12:49:15 +00002206 /* The following assert() is not a requirement, merely an observation:
2207 ** The OR-optimization doesn't work for the right hand table of
2208 ** a LEFT JOIN: */
drhc5837192022-04-11 14:26:37 +00002209 assert( (pWInfo->wctrlFlags & (WHERE_OR_SUBCLAUSE|WHERE_RIGHT_JOIN))==0 );
dan4da04f72018-04-24 14:05:14 +00002210 }
drhdb535392019-11-03 00:07:41 +00002211
dan71c57db2016-07-09 20:23:55 +00002212 /* Record the instruction used to terminate the loop. */
drh6f82e852015-06-06 20:12:09 +00002213 if( pLoop->wsFlags & WHERE_ONEROW ){
2214 pLevel->op = OP_Noop;
2215 }else if( bRev ){
2216 pLevel->op = OP_Prev;
2217 }else{
2218 pLevel->op = OP_Next;
2219 }
2220 pLevel->p1 = iIdxCur;
2221 pLevel->p3 = (pLoop->wsFlags&WHERE_UNQ_WANTED)!=0 ? 1:0;
2222 if( (pLoop->wsFlags & WHERE_CONSTRAINT)==0 ){
2223 pLevel->p5 = SQLITE_STMTSTATUS_FULLSCAN_STEP;
2224 }else{
2225 assert( pLevel->p5==0 );
2226 }
dan6f654a42017-04-28 19:59:55 +00002227 if( omitTable ) pIdx = 0;
drh6f82e852015-06-06 20:12:09 +00002228 }else
2229
2230#ifndef SQLITE_OMIT_OR_OPTIMIZATION
2231 if( pLoop->wsFlags & WHERE_MULTI_OR ){
2232 /* Case 5: Two or more separately indexed terms connected by OR
2233 **
2234 ** Example:
2235 **
2236 ** CREATE TABLE t1(a,b,c,d);
2237 ** CREATE INDEX i1 ON t1(a);
2238 ** CREATE INDEX i2 ON t1(b);
2239 ** CREATE INDEX i3 ON t1(c);
2240 **
2241 ** SELECT * FROM t1 WHERE a=5 OR b=7 OR (c=11 AND d=13)
2242 **
2243 ** In the example, there are three indexed terms connected by OR.
2244 ** The top of the loop looks like this:
2245 **
2246 ** Null 1 # Zero the rowset in reg 1
2247 **
2248 ** Then, for each indexed term, the following. The arguments to
2249 ** RowSetTest are such that the rowid of the current row is inserted
2250 ** into the RowSet. If it is already present, control skips the
2251 ** Gosub opcode and jumps straight to the code generated by WhereEnd().
2252 **
2253 ** sqlite3WhereBegin(<term>)
2254 ** RowSetTest # Insert rowid into rowset
2255 ** Gosub 2 A
2256 ** sqlite3WhereEnd()
2257 **
2258 ** Following the above, code to terminate the loop. Label A, the target
2259 ** of the Gosub above, jumps to the instruction right after the Goto.
2260 **
2261 ** Null 1 # Zero the rowset in reg 1
2262 ** Goto B # The loop is finished.
2263 **
2264 ** A: <loop body> # Return data, whatever.
2265 **
2266 ** Return 2 # Jump back to the Gosub
2267 **
2268 ** B: <after the loop>
2269 **
2270 ** Added 2014-05-26: If the table is a WITHOUT ROWID table, then
2271 ** use an ephemeral index instead of a RowSet to record the primary
2272 ** keys of the rows we have already seen.
2273 **
2274 */
2275 WhereClause *pOrWc; /* The OR-clause broken out into subterms */
2276 SrcList *pOrTab; /* Shortened table list or OR-clause generation */
2277 Index *pCov = 0; /* Potential covering index (or NULL) */
2278 int iCovCur = pParse->nTab++; /* Cursor used for index scans (if any) */
2279
2280 int regReturn = ++pParse->nMem; /* Register used with OP_Gosub */
2281 int regRowset = 0; /* Register for RowSet object */
2282 int regRowid = 0; /* Register holding rowid */
drhec4ccdb2018-12-29 02:26:59 +00002283 int iLoopBody = sqlite3VdbeMakeLabel(pParse);/* Start of loop body */
drh6f82e852015-06-06 20:12:09 +00002284 int iRetInit; /* Address of regReturn init */
2285 int untestedTerms = 0; /* Some terms not completely tested */
2286 int ii; /* Loop counter */
drh6f82e852015-06-06 20:12:09 +00002287 Expr *pAndExpr = 0; /* An ".. AND (...)" expression */
2288 Table *pTab = pTabItem->pTab;
dan145b4ea2016-07-29 18:12:12 +00002289
drh6f82e852015-06-06 20:12:09 +00002290 pTerm = pLoop->aLTerm[0];
2291 assert( pTerm!=0 );
2292 assert( pTerm->eOperator & WO_OR );
2293 assert( (pTerm->wtFlags & TERM_ORINFO)!=0 );
2294 pOrWc = &pTerm->u.pOrInfo->wc;
2295 pLevel->op = OP_Return;
2296 pLevel->p1 = regReturn;
2297
2298 /* Set up a new SrcList in pOrTab containing the table being scanned
2299 ** by this loop in the a[0] slot and all notReady tables in a[1..] slots.
2300 ** This becomes the SrcList in the recursive call to sqlite3WhereBegin().
2301 */
2302 if( pWInfo->nLevel>1 ){
2303 int nNotReady; /* The number of notReady tables */
drh76012942021-02-21 21:04:54 +00002304 SrcItem *origSrc; /* Original list of tables */
drh6f82e852015-06-06 20:12:09 +00002305 nNotReady = pWInfo->nLevel - iLevel - 1;
2306 pOrTab = sqlite3StackAllocRaw(db,
2307 sizeof(*pOrTab)+ nNotReady*sizeof(pOrTab->a[0]));
2308 if( pOrTab==0 ) return notReady;
2309 pOrTab->nAlloc = (u8)(nNotReady + 1);
2310 pOrTab->nSrc = pOrTab->nAlloc;
2311 memcpy(pOrTab->a, pTabItem, sizeof(*pTabItem));
2312 origSrc = pWInfo->pTabList->a;
2313 for(k=1; k<=nNotReady; k++){
2314 memcpy(&pOrTab->a[k], &origSrc[pLevel[k].iFrom], sizeof(pOrTab->a[k]));
2315 }
2316 }else{
2317 pOrTab = pWInfo->pTabList;
2318 }
2319
2320 /* Initialize the rowset register to contain NULL. An SQL NULL is
2321 ** equivalent to an empty rowset. Or, create an ephemeral index
2322 ** capable of holding primary keys in the case of a WITHOUT ROWID.
2323 **
2324 ** Also initialize regReturn to contain the address of the instruction
2325 ** immediately following the OP_Return at the bottom of the loop. This
2326 ** is required in a few obscure LEFT JOIN cases where control jumps
2327 ** over the top of the loop into the body of it. In this case the
2328 ** correct response for the end-of-loop code (the OP_Return) is to
2329 ** fall through to the next instruction, just as an OP_Next does if
2330 ** called on an uninitialized cursor.
2331 */
2332 if( (pWInfo->wctrlFlags & WHERE_DUPLICATES_OK)==0 ){
2333 if( HasRowid(pTab) ){
2334 regRowset = ++pParse->nMem;
2335 sqlite3VdbeAddOp2(v, OP_Null, 0, regRowset);
2336 }else{
2337 Index *pPk = sqlite3PrimaryKeyIndex(pTab);
2338 regRowset = pParse->nTab++;
2339 sqlite3VdbeAddOp2(v, OP_OpenEphemeral, regRowset, pPk->nKeyCol);
2340 sqlite3VdbeSetP4KeyInfo(pParse, pPk);
2341 }
2342 regRowid = ++pParse->nMem;
2343 }
2344 iRetInit = sqlite3VdbeAddOp2(v, OP_Integer, 0, regReturn);
2345
2346 /* If the original WHERE clause is z of the form: (x1 OR x2 OR ...) AND y
drh02e3e042022-02-04 13:05:29 +00002347 ** Then for every term xN, evaluate as the subexpression: xN AND y
drh6f82e852015-06-06 20:12:09 +00002348 ** That way, terms in y that are factored into the disjunction will
2349 ** be picked up by the recursive calls to sqlite3WhereBegin() below.
2350 **
2351 ** Actually, each subexpression is converted to "xN AND w" where w is
2352 ** the "interesting" terms of z - terms that did not originate in the
2353 ** ON or USING clause of a LEFT JOIN, and terms that are usable as
2354 ** indices.
2355 **
2356 ** This optimization also only applies if the (x1 OR x2 OR ...) term
2357 ** is not contained in the ON clause of a LEFT JOIN.
2358 ** See ticket http://www.sqlite.org/src/info/f2369304e4
drh02e3e042022-02-04 13:05:29 +00002359 **
2360 ** 2022-02-04: Do not push down slices of a row-value comparison.
2361 ** In other words, "w" or "y" may not be a slice of a vector. Otherwise,
2362 ** the initialization of the right-hand operand of the vector comparison
2363 ** might not occur, or might occur only in an OR branch that is not
2364 ** taken. dbsqlfuzz 80a9fade844b4fb43564efc972bcb2c68270f5d1.
drhc9bcc5a2022-03-03 15:59:22 +00002365 **
2366 ** 2022-03-03: Do not push down expressions that involve subqueries.
2367 ** The subquery might get coded as a subroutine. Any table-references
2368 ** in the subquery might be resolved to index-references for the index on
2369 ** the OR branch in which the subroutine is coded. But if the subroutine
2370 ** is invoked from a different OR branch that uses a different index, such
2371 ** index-references will not work. tag-20220303a
2372 ** https://sqlite.org/forum/forumpost/36937b197273d403
drh6f82e852015-06-06 20:12:09 +00002373 */
2374 if( pWC->nTerm>1 ){
2375 int iTerm;
2376 for(iTerm=0; iTerm<pWC->nTerm; iTerm++){
2377 Expr *pExpr = pWC->a[iTerm].pExpr;
2378 if( &pWC->a[iTerm] == pTerm ) continue;
drh3b83f0c2016-01-29 16:57:06 +00002379 testcase( pWC->a[iTerm].wtFlags & TERM_VIRTUAL );
2380 testcase( pWC->a[iTerm].wtFlags & TERM_CODED );
drh02e3e042022-02-04 13:05:29 +00002381 testcase( pWC->a[iTerm].wtFlags & TERM_SLICE );
2382 if( (pWC->a[iTerm].wtFlags & (TERM_VIRTUAL|TERM_CODED|TERM_SLICE))!=0 ){
2383 continue;
2384 }
drh07559b22022-03-03 19:40:21 +00002385 if( (pWC->a[iTerm].eOperator & WO_ALL)==0 ) continue;
drhc9bcc5a2022-03-03 15:59:22 +00002386 if( ExprHasProperty(pExpr, EP_Subquery) ) continue; /* tag-20220303a */
drh6f82e852015-06-06 20:12:09 +00002387 pExpr = sqlite3ExprDup(db, pExpr, 0);
drhd5c851c2019-04-19 13:38:34 +00002388 pAndExpr = sqlite3ExprAnd(pParse, pAndExpr, pExpr);
drh6f82e852015-06-06 20:12:09 +00002389 }
2390 if( pAndExpr ){
drhf1722ba2019-04-05 20:56:46 +00002391 /* The extra 0x10000 bit on the opcode is masked off and does not
2392 ** become part of the new Expr.op. However, it does make the
2393 ** op==TK_AND comparison inside of sqlite3PExpr() false, and this
drh93ffb502021-05-18 19:10:10 +00002394 ** prevents sqlite3PExpr() from applying the AND short-circuit
drhf1722ba2019-04-05 20:56:46 +00002395 ** optimization, which we do not want here. */
2396 pAndExpr = sqlite3PExpr(pParse, TK_AND|0x10000, 0, pAndExpr);
drh6f82e852015-06-06 20:12:09 +00002397 }
2398 }
2399
2400 /* Run a separate WHERE clause for each term of the OR clause. After
2401 ** eliminating duplicates from other WHERE clauses, the action for each
2402 ** sub-WHERE clause is to to invoke the main loop body as a subroutine.
2403 */
drh5d72d922018-05-04 00:39:43 +00002404 ExplainQueryPlan((pParse, 1, "MULTI-INDEX OR"));
drh6f82e852015-06-06 20:12:09 +00002405 for(ii=0; ii<pOrWc->nTerm; ii++){
2406 WhereTerm *pOrTerm = &pOrWc->a[ii];
2407 if( pOrTerm->leftCursor==iCur || (pOrTerm->eOperator & WO_AND)!=0 ){
2408 WhereInfo *pSubWInfo; /* Info for single OR-term scan */
2409 Expr *pOrExpr = pOrTerm->pExpr; /* Current OR clause term */
drh93ffb502021-05-18 19:10:10 +00002410 Expr *pDelete; /* Local copy of OR clause term */
drh728e0f92015-10-10 14:41:28 +00002411 int jmp1 = 0; /* Address of jump operation */
drh3b8eb082020-01-12 22:38:17 +00002412 testcase( (pTabItem[0].fg.jointype & JT_LEFT)!=0
2413 && !ExprHasProperty(pOrExpr, EP_FromJoin)
2414 ); /* See TH3 vtab25.400 and ticket 614b25314c766238 */
drh93ffb502021-05-18 19:10:10 +00002415 pDelete = pOrExpr = sqlite3ExprDup(db, pOrExpr, 0);
2416 if( db->mallocFailed ){
2417 sqlite3ExprDelete(db, pDelete);
2418 continue;
2419 }
dan820fcd22018-04-24 18:53:24 +00002420 if( pAndExpr ){
drh6f82e852015-06-06 20:12:09 +00002421 pAndExpr->pLeft = pOrExpr;
2422 pOrExpr = pAndExpr;
2423 }
2424 /* Loop through table entries that match term pOrTerm. */
drhbd462bc2018-12-24 20:21:06 +00002425 ExplainQueryPlan((pParse, 1, "INDEX %d", ii+1));
drh6f82e852015-06-06 20:12:09 +00002426 WHERETRACE(0xffff, ("Subplan for OR-clause:\n"));
drh895bab32022-01-27 16:14:50 +00002427 pSubWInfo = sqlite3WhereBegin(pParse, pOrTab, pOrExpr, 0, 0, 0,
drh68c0c712020-08-14 20:04:26 +00002428 WHERE_OR_SUBCLAUSE, iCovCur);
drh0c7d3d32022-01-24 16:47:12 +00002429 assert( pSubWInfo || pParse->nErr );
drh6f82e852015-06-06 20:12:09 +00002430 if( pSubWInfo ){
2431 WhereLoop *pSubLoop;
2432 int addrExplain = sqlite3WhereExplainOneScan(
drhe2188f02018-05-07 11:37:34 +00002433 pParse, pOrTab, &pSubWInfo->a[0], 0
drh6f82e852015-06-06 20:12:09 +00002434 );
2435 sqlite3WhereAddScanStatus(v, pOrTab, &pSubWInfo->a[0], addrExplain);
2436
2437 /* This is the sub-WHERE clause body. First skip over
2438 ** duplicate rows from prior sub-WHERE clauses, and record the
2439 ** rowid (or PRIMARY KEY) for the current row so that the same
2440 ** row will be skipped in subsequent sub-WHERE clauses.
2441 */
2442 if( (pWInfo->wctrlFlags & WHERE_DUPLICATES_OK)==0 ){
drh6f82e852015-06-06 20:12:09 +00002443 int iSet = ((ii==pOrWc->nTerm-1)?-1:ii);
2444 if( HasRowid(pTab) ){
drh6df9c4b2019-10-18 12:52:08 +00002445 sqlite3ExprCodeGetColumnOfTable(v, pTab, iCur, -1, regRowid);
drh728e0f92015-10-10 14:41:28 +00002446 jmp1 = sqlite3VdbeAddOp4Int(v, OP_RowSetTest, regRowset, 0,
drh8c607192018-08-04 15:53:55 +00002447 regRowid, iSet);
drh6f82e852015-06-06 20:12:09 +00002448 VdbeCoverage(v);
2449 }else{
2450 Index *pPk = sqlite3PrimaryKeyIndex(pTab);
2451 int nPk = pPk->nKeyCol;
2452 int iPk;
drh8c607192018-08-04 15:53:55 +00002453 int r;
drh6f82e852015-06-06 20:12:09 +00002454
2455 /* Read the PK into an array of temp registers. */
2456 r = sqlite3GetTempRange(pParse, nPk);
2457 for(iPk=0; iPk<nPk; iPk++){
2458 int iCol = pPk->aiColumn[iPk];
drh6df9c4b2019-10-18 12:52:08 +00002459 sqlite3ExprCodeGetColumnOfTable(v, pTab, iCur, iCol,r+iPk);
drh6f82e852015-06-06 20:12:09 +00002460 }
2461
2462 /* Check if the temp table already contains this key. If so,
2463 ** the row has already been included in the result set and
2464 ** can be ignored (by jumping past the Gosub below). Otherwise,
2465 ** insert the key into the temp table and proceed with processing
2466 ** the row.
2467 **
2468 ** Use some of the same optimizations as OP_RowSetTest: If iSet
2469 ** is zero, assume that the key cannot already be present in
2470 ** the temp table. And if iSet is -1, assume that there is no
2471 ** need to insert the key into the temp table, as it will never
2472 ** be tested for. */
2473 if( iSet ){
drh728e0f92015-10-10 14:41:28 +00002474 jmp1 = sqlite3VdbeAddOp4Int(v, OP_Found, regRowset, 0, r, nPk);
drh6f82e852015-06-06 20:12:09 +00002475 VdbeCoverage(v);
2476 }
2477 if( iSet>=0 ){
2478 sqlite3VdbeAddOp3(v, OP_MakeRecord, r, nPk, regRowid);
drh9b4eaeb2016-11-09 00:10:33 +00002479 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, regRowset, regRowid,
2480 r, nPk);
drh6f82e852015-06-06 20:12:09 +00002481 if( iSet ) sqlite3VdbeChangeP5(v, OPFLAG_USESEEKRESULT);
2482 }
2483
2484 /* Release the array of temp registers */
2485 sqlite3ReleaseTempRange(pParse, r, nPk);
2486 }
2487 }
2488
2489 /* Invoke the main loop body as a subroutine */
2490 sqlite3VdbeAddOp2(v, OP_Gosub, regReturn, iLoopBody);
2491
2492 /* Jump here (skipping the main loop body subroutine) if the
2493 ** current sub-WHERE row is a duplicate from prior sub-WHEREs. */
drh728e0f92015-10-10 14:41:28 +00002494 if( jmp1 ) sqlite3VdbeJumpHere(v, jmp1);
drh6f82e852015-06-06 20:12:09 +00002495
2496 /* The pSubWInfo->untestedTerms flag means that this OR term
2497 ** contained one or more AND term from a notReady table. The
2498 ** terms from the notReady table could not be tested and will
2499 ** need to be tested later.
2500 */
2501 if( pSubWInfo->untestedTerms ) untestedTerms = 1;
2502
2503 /* If all of the OR-connected terms are optimized using the same
2504 ** index, and the index is opened using the same cursor number
2505 ** by each call to sqlite3WhereBegin() made by this loop, it may
2506 ** be possible to use that index as a covering index.
2507 **
2508 ** If the call to sqlite3WhereBegin() above resulted in a scan that
2509 ** uses an index, and this is either the first OR-connected term
2510 ** processed or the index is the same as that used by all previous
2511 ** terms, set pCov to the candidate covering index. Otherwise, set
2512 ** pCov to NULL to indicate that no candidate covering index will
2513 ** be available.
2514 */
2515 pSubLoop = pSubWInfo->a[0].pWLoop;
2516 assert( (pSubLoop->wsFlags & WHERE_AUTO_INDEX)==0 );
2517 if( (pSubLoop->wsFlags & WHERE_INDEXED)!=0
2518 && (ii==0 || pSubLoop->u.btree.pIndex==pCov)
2519 && (HasRowid(pTab) || !IsPrimaryKeyIndex(pSubLoop->u.btree.pIndex))
2520 ){
2521 assert( pSubWInfo->a[0].iIdxCur==iCovCur );
2522 pCov = pSubLoop->u.btree.pIndex;
drh6f82e852015-06-06 20:12:09 +00002523 }else{
2524 pCov = 0;
2525 }
drh68c0c712020-08-14 20:04:26 +00002526 if( sqlite3WhereUsesDeferredSeek(pSubWInfo) ){
2527 pWInfo->bDeferredSeek = 1;
2528 }
drh6f82e852015-06-06 20:12:09 +00002529
2530 /* Finish the loop through table entries that match term pOrTerm. */
2531 sqlite3WhereEnd(pSubWInfo);
drhbd462bc2018-12-24 20:21:06 +00002532 ExplainQueryPlanPop(pParse);
drh6f82e852015-06-06 20:12:09 +00002533 }
drh93ffb502021-05-18 19:10:10 +00002534 sqlite3ExprDelete(db, pDelete);
drh6f82e852015-06-06 20:12:09 +00002535 }
2536 }
drh5d72d922018-05-04 00:39:43 +00002537 ExplainQueryPlanPop(pParse);
drh04756292021-10-14 19:28:28 +00002538 assert( pLevel->pWLoop==pLoop );
2539 assert( (pLoop->wsFlags & WHERE_MULTI_OR)!=0 );
2540 assert( (pLoop->wsFlags & WHERE_IN_ABLE)==0 );
2541 pLevel->u.pCoveringIdx = pCov;
drh6f82e852015-06-06 20:12:09 +00002542 if( pCov ) pLevel->iIdxCur = iCovCur;
2543 if( pAndExpr ){
2544 pAndExpr->pLeft = 0;
2545 sqlite3ExprDelete(db, pAndExpr);
2546 }
2547 sqlite3VdbeChangeP1(v, iRetInit, sqlite3VdbeCurrentAddr(v));
drh076e85f2015-09-03 13:46:12 +00002548 sqlite3VdbeGoto(v, pLevel->addrBrk);
drh6f82e852015-06-06 20:12:09 +00002549 sqlite3VdbeResolveLabel(v, iLoopBody);
2550
drhe603ab02022-04-07 19:06:31 +00002551 /* Set the P2 operand of the OP_Return opcode that will end the current
2552 ** loop to point to this spot, which is the top of the next containing
2553 ** loop. The byte-code formatter will use that P2 value as a hint to
2554 ** indent everything in between the this point and the final OP_Return.
2555 ** See tag-20220407a in vdbe.c and shell.c */
2556 assert( pLevel->op==OP_Return );
2557 pLevel->p2 = sqlite3VdbeCurrentAddr(v);
2558
drhdd2d9a32019-05-07 17:47:43 +00002559 if( pWInfo->nLevel>1 ){ sqlite3StackFree(db, pOrTab); }
drh6f82e852015-06-06 20:12:09 +00002560 if( !untestedTerms ) disableTerm(pLevel, pTerm);
2561 }else
2562#endif /* SQLITE_OMIT_OR_OPTIMIZATION */
2563
2564 {
2565 /* Case 6: There is no usable index. We must do a complete
2566 ** scan of the entire table.
2567 */
2568 static const u8 aStep[] = { OP_Next, OP_Prev };
2569 static const u8 aStart[] = { OP_Rewind, OP_Last };
2570 assert( bRev==0 || bRev==1 );
drh8a48b9c2015-08-19 15:20:00 +00002571 if( pTabItem->fg.isRecursive ){
drh6f82e852015-06-06 20:12:09 +00002572 /* Tables marked isRecursive have only a single row that is stored in
2573 ** a pseudo-cursor. No need to Rewind or Next such cursors. */
2574 pLevel->op = OP_Noop;
2575 }else{
danb324cf72016-06-17 14:33:32 +00002576 codeCursorHint(pTabItem, pWInfo, pLevel, 0);
drh6f82e852015-06-06 20:12:09 +00002577 pLevel->op = aStep[bRev];
2578 pLevel->p1 = iCur;
drh3a3b4202017-02-15 22:36:15 +00002579 pLevel->p2 = 1 + sqlite3VdbeAddOp2(v, aStart[bRev], iCur, addrHalt);
drh6f82e852015-06-06 20:12:09 +00002580 VdbeCoverageIf(v, bRev==0);
2581 VdbeCoverageIf(v, bRev!=0);
2582 pLevel->p5 = SQLITE_STMTSTATUS_FULLSCAN_STEP;
2583 }
2584 }
2585
2586#ifdef SQLITE_ENABLE_STMT_SCANSTATUS
2587 pLevel->addrVisit = sqlite3VdbeCurrentAddr(v);
2588#endif
2589
2590 /* Insert code to test every subexpression that can be completely
2591 ** computed using the current set of tables.
dan6f654a42017-04-28 19:59:55 +00002592 **
danebc63012017-07-10 14:33:00 +00002593 ** This loop may run between one and three times, depending on the
2594 ** constraints to be generated. The value of stack variable iLoop
2595 ** determines the constraints coded by each iteration, as follows:
2596 **
2597 ** iLoop==1: Code only expressions that are entirely covered by pIdx.
2598 ** iLoop==2: Code remaining expressions that do not contain correlated
2599 ** sub-queries.
2600 ** iLoop==3: Code all remaining expressions.
2601 **
2602 ** An effort is made to skip unnecessary iterations of the loop.
drh6ab3eb52017-04-29 14:56:55 +00002603 */
danebc63012017-07-10 14:33:00 +00002604 iLoop = (pIdx ? 1 : 2);
drh6ab3eb52017-04-29 14:56:55 +00002605 do{
danebc63012017-07-10 14:33:00 +00002606 int iNext = 0; /* Next value for iLoop */
dan6f654a42017-04-28 19:59:55 +00002607 for(pTerm=pWC->a, j=pWC->nTerm; j>0; j--, pTerm++){
2608 Expr *pE;
2609 int skipLikeAddr = 0;
2610 testcase( pTerm->wtFlags & TERM_VIRTUAL );
2611 testcase( pTerm->wtFlags & TERM_CODED );
2612 if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
2613 if( (pTerm->prereqAll & pLevel->notReady)!=0 ){
2614 testcase( pWInfo->untestedTerms==0
2615 && (pWInfo->wctrlFlags & WHERE_OR_SUBCLAUSE)!=0 );
2616 pWInfo->untestedTerms = 1;
2617 continue;
2618 }
2619 pE = pTerm->pExpr;
2620 assert( pE!=0 );
drha76ac882022-04-08 19:20:12 +00002621 if( (pTabItem->fg.jointype & (JT_LEFT|JT_LTORJ))
2622 && !ExprHasProperty(pE,EP_FromJoin)
2623 ){
dan6f654a42017-04-28 19:59:55 +00002624 continue;
2625 }
danebc63012017-07-10 14:33:00 +00002626
dan8674ec52017-07-10 14:39:42 +00002627 if( iLoop==1 && !sqlite3ExprCoveredByIndex(pE, pLevel->iTabCur, pIdx) ){
danebc63012017-07-10 14:33:00 +00002628 iNext = 2;
dan6f654a42017-04-28 19:59:55 +00002629 continue;
2630 }
dand3930b12017-07-10 15:17:30 +00002631 if( iLoop<3 && (pTerm->wtFlags & TERM_VARSELECT) ){
danebc63012017-07-10 14:33:00 +00002632 if( iNext==0 ) iNext = 3;
2633 continue;
2634 }
2635
drh4de33532018-04-02 00:16:36 +00002636 if( (pTerm->wtFlags & TERM_LIKECOND)!=0 ){
dan6f654a42017-04-28 19:59:55 +00002637 /* If the TERM_LIKECOND flag is set, that means that the range search
2638 ** is sufficient to guarantee that the LIKE operator is true, so we
2639 ** can skip the call to the like(A,B) function. But this only works
2640 ** for strings. So do not skip the call to the function on the pass
2641 ** that compares BLOBs. */
drh41d2e662015-12-01 21:23:07 +00002642#ifdef SQLITE_LIKE_DOESNT_MATCH_BLOBS
dan6f654a42017-04-28 19:59:55 +00002643 continue;
drh41d2e662015-12-01 21:23:07 +00002644#else
dan6f654a42017-04-28 19:59:55 +00002645 u32 x = pLevel->iLikeRepCntr;
drh4de33532018-04-02 00:16:36 +00002646 if( x>0 ){
2647 skipLikeAddr = sqlite3VdbeAddOp1(v, (x&1)?OP_IfNot:OP_If,(int)(x>>1));
drh6f883592019-03-30 20:37:04 +00002648 VdbeCoverageIf(v, (x&1)==1);
2649 VdbeCoverageIf(v, (x&1)==0);
drh4de33532018-04-02 00:16:36 +00002650 }
drh41d2e662015-12-01 21:23:07 +00002651#endif
dan6f654a42017-04-28 19:59:55 +00002652 }
drh66a0bf32017-07-10 16:38:14 +00002653#ifdef WHERETRACE_ENABLED /* 0xffff */
2654 if( sqlite3WhereTrace ){
2655 VdbeNoopComment((v, "WhereTerm[%d] (%p) priority=%d",
2656 pWC->nTerm-j, pTerm, iLoop));
2657 }
drh118efd12019-12-28 14:07:22 +00002658 if( sqlite3WhereTrace & 0x800 ){
2659 sqlite3DebugPrintf("Coding auxiliary constraint:\n");
2660 sqlite3WhereTermPrint(pTerm, pWC->nTerm-j);
2661 }
drh66a0bf32017-07-10 16:38:14 +00002662#endif
dan6f654a42017-04-28 19:59:55 +00002663 sqlite3ExprIfFalse(pParse, pE, addrCont, SQLITE_JUMPIFNULL);
2664 if( skipLikeAddr ) sqlite3VdbeJumpHere(v, skipLikeAddr);
2665 pTerm->wtFlags |= TERM_CODED;
drh6f82e852015-06-06 20:12:09 +00002666 }
danebc63012017-07-10 14:33:00 +00002667 iLoop = iNext;
2668 }while( iLoop>0 );
drh6f82e852015-06-06 20:12:09 +00002669
2670 /* Insert code to test for implied constraints based on transitivity
2671 ** of the "==" operator.
2672 **
2673 ** Example: If the WHERE clause contains "t1.a=t2.b" and "t2.b=123"
2674 ** and we are coding the t1 loop and the t2 loop has not yet coded,
2675 ** then we cannot use the "t1.a=t2.b" constraint, but we can code
2676 ** the implied "t1.a=123" constraint.
2677 */
drh132f96f2021-12-08 16:07:22 +00002678 for(pTerm=pWC->a, j=pWC->nBase; j>0; j--, pTerm++){
drhcb43a932016-10-03 01:21:51 +00002679 Expr *pE, sEAlt;
drh6f82e852015-06-06 20:12:09 +00002680 WhereTerm *pAlt;
2681 if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
2682 if( (pTerm->eOperator & (WO_EQ|WO_IS))==0 ) continue;
2683 if( (pTerm->eOperator & WO_EQUIV)==0 ) continue;
2684 if( pTerm->leftCursor!=iCur ) continue;
drha76ac882022-04-08 19:20:12 +00002685 if( pTabItem->fg.jointype & (JT_LEFT|JT_LTORJ) ) continue;
drh6f82e852015-06-06 20:12:09 +00002686 pE = pTerm->pExpr;
drh118efd12019-12-28 14:07:22 +00002687#ifdef WHERETRACE_ENABLED /* 0x800 */
2688 if( sqlite3WhereTrace & 0x800 ){
2689 sqlite3DebugPrintf("Coding transitive constraint:\n");
2690 sqlite3WhereTermPrint(pTerm, pWC->nTerm-j);
2691 }
2692#endif
drhf1bb31e2019-12-28 14:33:26 +00002693 assert( !ExprHasProperty(pE, EP_FromJoin) );
drh6f82e852015-06-06 20:12:09 +00002694 assert( (pTerm->prereqRight & pLevel->notReady)!=0 );
drh220f0d62021-10-15 17:06:16 +00002695 assert( (pTerm->eOperator & (WO_OR|WO_AND))==0 );
drh75fa2662020-09-28 15:49:43 +00002696 pAlt = sqlite3WhereFindTerm(pWC, iCur, pTerm->u.x.leftColumn, notReady,
drh6f82e852015-06-06 20:12:09 +00002697 WO_EQ|WO_IN|WO_IS, 0);
2698 if( pAlt==0 ) continue;
2699 if( pAlt->wtFlags & (TERM_CODED) ) continue;
dana916b572018-01-23 16:38:57 +00002700 if( (pAlt->eOperator & WO_IN)
drha4eeccd2021-10-07 17:43:30 +00002701 && ExprUseXSelect(pAlt->pExpr)
drha599e152018-12-24 14:30:11 +00002702 && (pAlt->pExpr->x.pSelect->pEList->nExpr>1)
dana916b572018-01-23 16:38:57 +00002703 ){
2704 continue;
2705 }
drh6f82e852015-06-06 20:12:09 +00002706 testcase( pAlt->eOperator & WO_EQ );
2707 testcase( pAlt->eOperator & WO_IS );
2708 testcase( pAlt->eOperator & WO_IN );
2709 VdbeModuleComment((v, "begin transitive constraint"));
drhcb43a932016-10-03 01:21:51 +00002710 sEAlt = *pAlt->pExpr;
2711 sEAlt.pLeft = pE->pLeft;
2712 sqlite3ExprIfFalse(pParse, &sEAlt, addrCont, SQLITE_JUMPIFNULL);
dan240e36c2021-04-05 16:20:59 +00002713 pAlt->wtFlags |= TERM_CODED;
drh6f82e852015-06-06 20:12:09 +00002714 }
2715
drhc2308ad2022-04-09 03:16:26 +00002716 /* For a RIGHT OUTER JOIN, record the fact that the current row has
2717 ** been matched at least once.
2718 */
drh7c1734b2022-04-09 12:27:20 +00002719 if( pLevel->pRJ ){
drhc2308ad2022-04-09 03:16:26 +00002720 Table *pTab;
2721 int nPk;
2722 int r;
2723 int jmp1 = 0;
drh7c1734b2022-04-09 12:27:20 +00002724 WhereRightJoin *pRJ = pLevel->pRJ;
drhc2308ad2022-04-09 03:16:26 +00002725
drh7c1734b2022-04-09 12:27:20 +00002726 /* pTab is the right-hand table of the RIGHT JOIN. Generate code that
2727 ** will record that the current row of that table has been matched at
2728 ** least once. This is accomplished by storing the PK for the row in
2729 ** both the iMatch index and the regBloom Bloom filter.
2730 */
drhc2308ad2022-04-09 03:16:26 +00002731 pTab = pWInfo->pTabList->a[pLevel->iFrom].pTab;
2732 if( HasRowid(pTab) ){
2733 r = sqlite3GetTempRange(pParse, 2);
2734 sqlite3ExprCodeGetColumnOfTable(v, pTab, pLevel->iTabCur, -1, r+1);
2735 nPk = 1;
2736 }else{
2737 int iPk;
2738 Index *pPk = sqlite3PrimaryKeyIndex(pTab);
2739 nPk = pPk->nKeyCol;
2740 r = sqlite3GetTempRange(pParse, nPk+1);
2741 for(iPk=0; iPk<nPk; iPk++){
2742 int iCol = pPk->aiColumn[iPk];
2743 sqlite3ExprCodeGetColumnOfTable(v, pTab, iCur, iCol,r+1+iPk);
2744 }
2745 }
drh7c1734b2022-04-09 12:27:20 +00002746 jmp1 = sqlite3VdbeAddOp4Int(v, OP_Found, pRJ->iMatch, 0, r+1, nPk);
drhc2308ad2022-04-09 03:16:26 +00002747 VdbeCoverage(v);
drh2e1bcc92022-04-18 16:10:07 +00002748 VdbeComment((v, "match against %s", pTab->zName));
drhc2308ad2022-04-09 03:16:26 +00002749 sqlite3VdbeAddOp3(v, OP_MakeRecord, r+1, nPk, r);
drh7c1734b2022-04-09 12:27:20 +00002750 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, pRJ->iMatch, r, r+1, nPk);
2751 sqlite3VdbeAddOp4Int(v, OP_FilterAdd, pRJ->regBloom, 0, r+1, nPk);
drhc2308ad2022-04-09 03:16:26 +00002752 sqlite3VdbeChangeP5(v, OPFLAG_USESEEKRESULT);
2753 sqlite3VdbeJumpHere(v, jmp1);
drhc2308ad2022-04-09 03:16:26 +00002754 sqlite3ReleaseTempRange(pParse, r, nPk+1);
drh2e1bcc92022-04-18 16:10:07 +00002755 }
drh7c1734b2022-04-09 12:27:20 +00002756
drh2e1bcc92022-04-18 16:10:07 +00002757 /* For a LEFT OUTER JOIN, generate code that will record the fact that
2758 ** at least one row of the right table has matched the left table.
2759 */
2760 if( pLevel->iLeftJoin ){
2761 pLevel->addrFirst = sqlite3VdbeCurrentAddr(v);
2762 sqlite3VdbeAddOp2(v, OP_Integer, 1, pLevel->iLeftJoin);
2763 VdbeComment((v, "record LEFT JOIN hit"));
2764 for(pTerm=pWC->a, j=0; j<pWC->nBase; j++, pTerm++){
2765 testcase( pTerm->wtFlags & TERM_VIRTUAL );
2766 testcase( pTerm->wtFlags & TERM_CODED );
2767 if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
2768 if( (pTerm->prereqAll & pLevel->notReady)!=0 ){
2769 assert( pWInfo->untestedTerms );
2770 continue;
2771 }
2772 if( pTabItem->fg.jointype & JT_LTORJ ) continue;
2773 assert( pTerm->pExpr );
2774 sqlite3ExprIfFalse(pParse, pTerm->pExpr, addrCont, SQLITE_JUMPIFNULL);
2775 pTerm->wtFlags |= TERM_CODED;
2776 }
2777 }
2778
2779 if( pLevel->pRJ ){
drh7c1734b2022-04-09 12:27:20 +00002780 /* Create a subroutine used to process all interior loops and code
2781 ** of the RIGHT JOIN. During normal operation, the subroutine will
2782 ** be in-line with the rest of the code. But at the end, a separate
2783 ** loop will run that invokes this subroutine for unmatched rows
2784 ** of pTab, with all tables to left begin set to NULL.
2785 */
drh2e1bcc92022-04-18 16:10:07 +00002786 WhereRightJoin *pRJ = pLevel->pRJ;
drh7c1734b2022-04-09 12:27:20 +00002787 sqlite3VdbeAddOp2(v, OP_BeginSubrtn, 0, pRJ->regReturn);
2788 pRJ->addrSubrtn = sqlite3VdbeCurrentAddr(v);
drh2c31c002022-04-14 16:34:07 +00002789 assert( pParse->withinRJSubrtn < 255 );
2790 pParse->withinRJSubrtn++;
drhc2308ad2022-04-09 03:16:26 +00002791 }
2792
drh118efd12019-12-28 14:07:22 +00002793#if WHERETRACE_ENABLED /* 0x20800 */
2794 if( sqlite3WhereTrace & 0x20000 ){
drhf1bb31e2019-12-28 14:33:26 +00002795 sqlite3DebugPrintf("All WHERE-clause terms after coding level %d:\n",
2796 iLevel);
drh118efd12019-12-28 14:07:22 +00002797 sqlite3WhereClausePrint(pWC);
2798 }
2799 if( sqlite3WhereTrace & 0x800 ){
2800 sqlite3DebugPrintf("End Coding level %d: notReady=%llx\n",
2801 iLevel, (u64)pLevel->notReady);
2802 }
2803#endif
drh6f82e852015-06-06 20:12:09 +00002804 return pLevel->notReady;
2805}
drh949e2ab2022-04-12 18:04:29 +00002806
2807/*
2808** Generate the code for the loop that finds all non-matched terms
2809** for a RIGHT JOIN.
2810*/
2811SQLITE_NOINLINE void sqlite3WhereRightJoinLoop(
2812 WhereInfo *pWInfo,
2813 int iLevel,
2814 WhereLevel *pLevel
2815){
2816 Parse *pParse = pWInfo->pParse;
2817 Vdbe *v = pParse->pVdbe;
2818 WhereRightJoin *pRJ = pLevel->pRJ;
2819 Expr *pSubWhere = 0;
2820 WhereClause *pWC = &pWInfo->sWC;
2821 WhereInfo *pSubWInfo;
2822 WhereLoop *pLoop = pLevel->pWLoop;
2823 SrcItem *pTabItem = &pWInfo->pTabList->a[pLevel->iFrom];
2824 SrcList sFrom;
2825 Bitmask mAll = 0;
2826 int k;
2827
drhf7ecd952022-04-13 16:46:35 +00002828 ExplainQueryPlan((pParse, 1, "RIGHT-JOIN %s", pTabItem->pTab->zName));
drhb77c3122022-04-23 18:04:31 +00002829 sqlite3VdbeNoJumpsOutsideSubrtn(v, pRJ->addrSubrtn, pRJ->endSubrtn,
2830 pRJ->regReturn);
drh7348ca42022-04-18 16:20:59 +00002831 for(k=0; k<iLevel; k++){
2832 int iIdxCur;
2833 mAll |= pWInfo->a[k].pWLoop->maskSelf;
2834 sqlite3VdbeAddOp1(v, OP_NullRow, pWInfo->a[k].iTabCur);
2835 iIdxCur = pWInfo->a[k].iIdxCur;
2836 if( iIdxCur ){
2837 sqlite3VdbeAddOp1(v, OP_NullRow, iIdxCur);
drh949e2ab2022-04-12 18:04:29 +00002838 }
drh7348ca42022-04-18 16:20:59 +00002839 }
2840 if( (pTabItem->fg.jointype & JT_LTORJ)==0 ){
drh2e1bcc92022-04-18 16:10:07 +00002841 mAll |= pLoop->maskSelf;
2842 for(k=0; k<pWC->nTerm; k++){
2843 WhereTerm *pTerm = &pWC->a[k];
2844 if( pTerm->wtFlags & TERM_VIRTUAL ) break;
2845 if( pTerm->prereqAll & ~mAll ) continue;
2846 if( ExprHasProperty(pTerm->pExpr, EP_FromJoin|EP_InnerJoin) ) continue;
2847 pSubWhere = sqlite3ExprAnd(pParse, pSubWhere,
2848 sqlite3ExprDup(pParse->db, pTerm->pExpr, 0));
2849 }
drh949e2ab2022-04-12 18:04:29 +00002850 }
2851 sFrom.nSrc = 1;
2852 sFrom.nAlloc = 1;
2853 memcpy(&sFrom.a[0], pTabItem, sizeof(SrcItem));
2854 sFrom.a[0].fg.jointype = 0;
drh503ad9c2022-04-21 14:48:40 +00002855 assert( pParse->withinRJSubrtn < 100 );
2856 pParse->withinRJSubrtn++;
drh949e2ab2022-04-12 18:04:29 +00002857 pSubWInfo = sqlite3WhereBegin(pParse, &sFrom, pSubWhere, 0, 0, 0,
2858 WHERE_RIGHT_JOIN, 0);
2859 if( pSubWInfo ){
2860 int iCur = pLevel->iTabCur;
2861 int r = ++pParse->nMem;
2862 int nPk;
2863 int jmp;
2864 int addrCont = sqlite3WhereContinueLabel(pSubWInfo);
2865 Table *pTab = pTabItem->pTab;
2866 if( HasRowid(pTab) ){
2867 sqlite3ExprCodeGetColumnOfTable(v, pTab, iCur, -1, r);
2868 nPk = 1;
2869 }else{
2870 int iPk;
2871 Index *pPk = sqlite3PrimaryKeyIndex(pTab);
2872 nPk = pPk->nKeyCol;
2873 pParse->nMem += nPk - 1;
2874 for(iPk=0; iPk<nPk; iPk++){
2875 int iCol = pPk->aiColumn[iPk];
2876 sqlite3ExprCodeGetColumnOfTable(v, pTab, iCur, iCol,r+iPk);
2877 }
2878 }
2879 jmp = sqlite3VdbeAddOp4Int(v, OP_Filter, pRJ->regBloom, 0, r, nPk);
drh146e64d2022-04-13 01:52:32 +00002880 VdbeCoverage(v);
drh949e2ab2022-04-12 18:04:29 +00002881 sqlite3VdbeAddOp4Int(v, OP_Found, pRJ->iMatch, addrCont, r, nPk);
drh146e64d2022-04-13 01:52:32 +00002882 VdbeCoverage(v);
drh949e2ab2022-04-12 18:04:29 +00002883 sqlite3VdbeJumpHere(v, jmp);
2884 sqlite3VdbeAddOp2(v, OP_Gosub, pRJ->regReturn, pRJ->addrSubrtn);
2885 sqlite3WhereEnd(pSubWInfo);
2886 }
2887 sqlite3ExprDelete(pParse->db, pSubWhere);
2888 ExplainQueryPlanPop(pParse);
drh503ad9c2022-04-21 14:48:40 +00002889 assert( pParse->withinRJSubrtn>0 );
2890 pParse->withinRJSubrtn--;
drh949e2ab2022-04-12 18:04:29 +00002891}