blob: a438db5301ded8b3844e286119afa2c71ef9c794 [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);
dan8da209b2016-07-26 18:06:08 +0000613 }else{
614 sqlite3 *db = pParse->db;
drh24102432017-11-17 21:01:04 +0000615 pX = removeUnindexableInClauseTerms(pParse, iEq, pLoop, pX);
drh9b1ecb62017-11-17 17:32:40 +0000616
drhac6b47d2016-08-24 00:51:48 +0000617 if( !db->mallocFailed ){
drh24102432017-11-17 21:01:04 +0000618 aiMap = (int*)sqlite3DbMallocZero(pParse->db, sizeof(int)*nEq);
drh2c041312018-12-24 02:34:49 +0000619 eType = sqlite3FindInIndex(pParse, pX, IN_INDEX_LOOP, 0, aiMap, &iTab);
620 pTerm->pExpr->iTable = iTab;
drhac6b47d2016-08-24 00:51:48 +0000621 }
drh24102432017-11-17 21:01:04 +0000622 sqlite3ExprDelete(db, pX);
623 pX = pTerm->pExpr;
dan8da209b2016-07-26 18:06:08 +0000624 }
625
drh6f82e852015-06-06 20:12:09 +0000626 if( eType==IN_INDEX_INDEX_DESC ){
627 testcase( bRev );
628 bRev = !bRev;
629 }
drh6f82e852015-06-06 20:12:09 +0000630 sqlite3VdbeAddOp2(v, bRev ? OP_Last : OP_Rewind, iTab, 0);
631 VdbeCoverageIf(v, bRev);
632 VdbeCoverageIf(v, !bRev);
dan8da209b2016-07-26 18:06:08 +0000633
drh04756292021-10-14 19:28:28 +0000634 assert( (pLoop->wsFlags & WHERE_MULTI_OR)==0 );
drh6f82e852015-06-06 20:12:09 +0000635 pLoop->wsFlags |= WHERE_IN_ABLE;
636 if( pLevel->u.in.nIn==0 ){
drhec4ccdb2018-12-29 02:26:59 +0000637 pLevel->addrNxt = sqlite3VdbeMakeLabel(pParse);
drh6f82e852015-06-06 20:12:09 +0000638 }
drh46f0f4e2020-09-29 15:32:54 +0000639 if( iEq>0 && (pLoop->wsFlags & WHERE_IN_SEEKSCAN)==0 ){
drhfa17e132020-09-01 01:52:03 +0000640 pLoop->wsFlags |= WHERE_IN_EARLYOUT;
641 }
dan8da209b2016-07-26 18:06:08 +0000642
643 i = pLevel->u.in.nIn;
644 pLevel->u.in.nIn += nEq;
drh6f82e852015-06-06 20:12:09 +0000645 pLevel->u.in.aInLoop =
drhf8bdcfa2022-04-09 03:06:01 +0000646 sqlite3WhereRealloc(pTerm->pWC->pWInfo,
647 pLevel->u.in.aInLoop,
648 sizeof(pLevel->u.in.aInLoop[0])*pLevel->u.in.nIn);
drh6f82e852015-06-06 20:12:09 +0000649 pIn = pLevel->u.in.aInLoop;
650 if( pIn ){
dan8da209b2016-07-26 18:06:08 +0000651 int iMap = 0; /* Index in aiMap[] */
652 pIn += i;
dan7887d7f2016-08-24 12:22:17 +0000653 for(i=iEq;i<pLoop->nLTerm; i++){
dan8da209b2016-07-26 18:06:08 +0000654 if( pLoop->aLTerm[i]->pExpr==pX ){
danedc35372016-09-16 16:30:57 +0000655 int iOut = iReg + i - iEq;
dan8da209b2016-07-26 18:06:08 +0000656 if( eType==IN_INDEX_ROWID ){
danedc35372016-09-16 16:30:57 +0000657 pIn->addrInTop = sqlite3VdbeAddOp2(v, OP_Rowid, iTab, iOut);
dan8da209b2016-07-26 18:06:08 +0000658 }else{
659 int iCol = aiMap ? aiMap[iMap++] : 0;
dan8da209b2016-07-26 18:06:08 +0000660 pIn->addrInTop = sqlite3VdbeAddOp3(v,OP_Column,iTab, iCol, iOut);
661 }
drh03181c82016-08-18 19:04:57 +0000662 sqlite3VdbeAddOp1(v, OP_IsNull, iOut); VdbeCoverage(v);
dan8da209b2016-07-26 18:06:08 +0000663 if( i==iEq ){
664 pIn->iCur = iTab;
drhf1949b62018-06-07 17:32:59 +0000665 pIn->eEndLoopOp = bRev ? OP_Prev : OP_Next;
dan74ebaad2020-01-04 16:55:57 +0000666 if( iEq>0 ){
drh86d0ea72018-06-05 15:16:25 +0000667 pIn->iBase = iReg - i;
668 pIn->nPrefix = i;
669 }else{
670 pIn->nPrefix = 0;
671 }
dan8da209b2016-07-26 18:06:08 +0000672 }else{
673 pIn->eEndLoopOp = OP_Noop;
674 }
dan7887d7f2016-08-24 12:22:17 +0000675 pIn++;
dan8da209b2016-07-26 18:06:08 +0000676 }
drh6f82e852015-06-06 20:12:09 +0000677 }
drh67306cb2020-10-01 14:36:15 +0000678 testcase( iEq>0
679 && (pLoop->wsFlags & WHERE_IN_SEEKSCAN)==0
680 && (pLoop->wsFlags & WHERE_VIRTUALTABLE)!=0 );
681 if( iEq>0
682 && (pLoop->wsFlags & (WHERE_IN_SEEKSCAN|WHERE_VIRTUALTABLE))==0
683 ){
drhfa17e132020-09-01 01:52:03 +0000684 sqlite3VdbeAddOp3(v, OP_SeekHit, pLevel->iIdxCur, 0, iEq);
685 }
drh6f82e852015-06-06 20:12:09 +0000686 }else{
687 pLevel->u.in.nIn = 0;
688 }
dan8da209b2016-07-26 18:06:08 +0000689 sqlite3DbFree(pParse->db, aiMap);
drh6f82e852015-06-06 20:12:09 +0000690#endif
691 }
drh67656ac2021-05-04 23:21:35 +0000692
693 /* As an optimization, try to disable the WHERE clause term that is
694 ** driving the index as it will always be true. The correct answer is
695 ** obtained regardless, but we might get the answer with fewer CPU cycles
696 ** by omitting the term.
697 **
698 ** But do not disable the term unless we are certain that the term is
699 ** not a transitive constraint. For an example of where that does not
700 ** work, see https://sqlite.org/forum/forumpost/eb8613976a (2021-05-04)
701 */
702 if( (pLevel->pWLoop->wsFlags & WHERE_TRANSCONS)==0
703 || (pTerm->eOperator & WO_EQUIV)==0
704 ){
705 disableTerm(pLevel, pTerm);
706 }
707
drh6f82e852015-06-06 20:12:09 +0000708 return iReg;
709}
710
711/*
712** Generate code that will evaluate all == and IN constraints for an
713** index scan.
714**
715** For example, consider table t1(a,b,c,d,e,f) with index i1(a,b,c).
716** Suppose the WHERE clause is this: a==5 AND b IN (1,2,3) AND c>5 AND c<10
717** The index has as many as three equality constraints, but in this
718** example, the third "c" value is an inequality. So only two
719** constraints are coded. This routine will generate code to evaluate
720** a==5 and b IN (1,2,3). The current values for a and b will be stored
721** in consecutive registers and the index of the first register is returned.
722**
723** In the example above nEq==2. But this subroutine works for any value
724** of nEq including 0. If nEq==0, this routine is nearly a no-op.
725** The only thing it does is allocate the pLevel->iMem memory cell and
726** compute the affinity string.
727**
728** The nExtraReg parameter is 0 or 1. It is 0 if all WHERE clause constraints
729** are == or IN and are covered by the nEq. nExtraReg is 1 if there is
730** an inequality constraint (such as the "c>=5 AND c<10" in the example) that
731** occurs after the nEq quality constraints.
732**
733** This routine allocates a range of nEq+nExtraReg memory cells and returns
734** the index of the first memory cell in that range. The code that
735** calls this routine will use that memory range to store keys for
736** start and termination conditions of the loop.
737** key value of the loop. If one or more IN operators appear, then
738** this routine allocates an additional nEq memory cells for internal
739** use.
740**
741** Before returning, *pzAff is set to point to a buffer containing a
742** copy of the column affinity string of the index allocated using
743** sqlite3DbMalloc(). Except, entries in the copy of the string associated
744** with equality constraints that use BLOB or NONE affinity are set to
745** SQLITE_AFF_BLOB. This is to deal with SQL such as the following:
746**
747** CREATE TABLE t1(a TEXT PRIMARY KEY, b);
748** SELECT ... FROM t1 AS t2, t1 WHERE t1.a = t2.b;
749**
750** In the example above, the index on t1(a) has TEXT affinity. But since
751** the right hand side of the equality constraint (t2.b) has BLOB/NONE affinity,
752** no conversion should be attempted before using a t2.b value as part of
753** a key to search the index. Hence the first byte in the returned affinity
754** string in this example would be set to SQLITE_AFF_BLOB.
755*/
756static int codeAllEqualityTerms(
757 Parse *pParse, /* Parsing context */
758 WhereLevel *pLevel, /* Which nested loop of the FROM we are coding */
759 int bRev, /* Reverse the order of IN operators */
760 int nExtraReg, /* Number of extra registers to allocate */
761 char **pzAff /* OUT: Set to point to affinity string */
762){
763 u16 nEq; /* The number of == or IN constraints to code */
764 u16 nSkip; /* Number of left-most columns to skip */
765 Vdbe *v = pParse->pVdbe; /* The vm under construction */
766 Index *pIdx; /* The index being used for this loop */
767 WhereTerm *pTerm; /* A single constraint term */
768 WhereLoop *pLoop; /* The WhereLoop object */
769 int j; /* Loop counter */
770 int regBase; /* Base register */
771 int nReg; /* Number of registers to allocate */
772 char *zAff; /* Affinity string to return */
773
774 /* This module is only called on query plans that use an index. */
775 pLoop = pLevel->pWLoop;
776 assert( (pLoop->wsFlags & WHERE_VIRTUALTABLE)==0 );
777 nEq = pLoop->u.btree.nEq;
778 nSkip = pLoop->nSkip;
779 pIdx = pLoop->u.btree.pIndex;
780 assert( pIdx!=0 );
781
782 /* Figure out how many memory cells we will need then allocate them.
783 */
784 regBase = pParse->nMem + 1;
785 nReg = pLoop->u.btree.nEq + nExtraReg;
786 pParse->nMem += nReg;
787
drhe9107692015-08-25 19:20:04 +0000788 zAff = sqlite3DbStrDup(pParse->db,sqlite3IndexAffinityStr(pParse->db,pIdx));
drh4df86af2016-02-04 11:48:00 +0000789 assert( zAff!=0 || pParse->db->mallocFailed );
drh6f82e852015-06-06 20:12:09 +0000790
791 if( nSkip ){
792 int iIdxCur = pLevel->iIdxCur;
drh31536302021-04-21 23:13:26 +0000793 sqlite3VdbeAddOp3(v, OP_Null, 0, regBase, regBase+nSkip-1);
drh6f82e852015-06-06 20:12:09 +0000794 sqlite3VdbeAddOp1(v, (bRev?OP_Last:OP_Rewind), iIdxCur);
795 VdbeCoverageIf(v, bRev==0);
796 VdbeCoverageIf(v, bRev!=0);
797 VdbeComment((v, "begin skip-scan on %s", pIdx->zName));
798 j = sqlite3VdbeAddOp0(v, OP_Goto);
drh56945692022-03-02 21:04:10 +0000799 assert( pLevel->addrSkip==0 );
drh6f82e852015-06-06 20:12:09 +0000800 pLevel->addrSkip = sqlite3VdbeAddOp4Int(v, (bRev?OP_SeekLT:OP_SeekGT),
801 iIdxCur, 0, regBase, nSkip);
802 VdbeCoverageIf(v, bRev==0);
803 VdbeCoverageIf(v, bRev!=0);
804 sqlite3VdbeJumpHere(v, j);
805 for(j=0; j<nSkip; j++){
806 sqlite3VdbeAddOp3(v, OP_Column, iIdxCur, j, regBase+j);
drh4b92f982015-09-29 17:20:14 +0000807 testcase( pIdx->aiColumn[j]==XN_EXPR );
drhe63e8a62015-09-18 18:09:28 +0000808 VdbeComment((v, "%s", explainIndexColumnName(pIdx, j)));
drh6f82e852015-06-06 20:12:09 +0000809 }
810 }
811
812 /* Evaluate the equality constraints
813 */
814 assert( zAff==0 || (int)strlen(zAff)>=nEq );
815 for(j=nSkip; j<nEq; j++){
816 int r1;
817 pTerm = pLoop->aLTerm[j];
818 assert( pTerm!=0 );
819 /* The following testcase is true for indices with redundant columns.
820 ** Ex: CREATE INDEX i1 ON t1(a,b,a); SELECT * FROM t1 WHERE a=0 AND b=0; */
821 testcase( (pTerm->wtFlags & TERM_CODED)!=0 );
822 testcase( pTerm->wtFlags & TERM_VIRTUAL );
823 r1 = codeEqualityTerm(pParse, pTerm, pLevel, j, bRev, regBase+j);
824 if( r1!=regBase+j ){
825 if( nReg==1 ){
826 sqlite3ReleaseTempReg(pParse, regBase);
827 regBase = r1;
828 }else{
drhe9de6522021-05-28 12:48:31 +0000829 sqlite3VdbeAddOp2(v, OP_Copy, r1, regBase+j);
drh6f82e852015-06-06 20:12:09 +0000830 }
831 }
drhe482fde2022-01-21 16:41:11 +0000832 }
833 for(j=nSkip; j<nEq; j++){
834 pTerm = pLoop->aLTerm[j];
drhc097e122016-09-07 13:30:40 +0000835 if( pTerm->eOperator & WO_IN ){
836 if( pTerm->pExpr->flags & EP_xIsSelect ){
837 /* No affinity ever needs to be (or should be) applied to a value
838 ** from the RHS of an "? IN (SELECT ...)" expression. The
839 ** sqlite3FindInIndex() routine has already ensured that the
840 ** affinity of the comparison has been applied to the value. */
841 if( zAff ) zAff[j] = SQLITE_AFF_BLOB;
842 }
843 }else if( (pTerm->eOperator & WO_ISNULL)==0 ){
844 Expr *pRight = pTerm->pExpr->pRight;
845 if( (pTerm->wtFlags & TERM_IS)==0 && sqlite3ExprCanBeNull(pRight) ){
846 sqlite3VdbeAddOp2(v, OP_IsNull, regBase+j, pLevel->addrBrk);
847 VdbeCoverage(v);
848 }
drh0c7d3d32022-01-24 16:47:12 +0000849 if( pParse->nErr==0 ){
850 assert( pParse->db->mallocFailed==0 );
drhc097e122016-09-07 13:30:40 +0000851 if( sqlite3CompareAffinity(pRight, zAff[j])==SQLITE_AFF_BLOB ){
852 zAff[j] = SQLITE_AFF_BLOB;
dan27189602016-09-03 15:31:20 +0000853 }
drhc097e122016-09-07 13:30:40 +0000854 if( sqlite3ExprNeedsNoAffinityChange(pRight, zAff[j]) ){
855 zAff[j] = SQLITE_AFF_BLOB;
drh6f82e852015-06-06 20:12:09 +0000856 }
857 }
858 }
859 }
860 *pzAff = zAff;
861 return regBase;
862}
863
drh41d2e662015-12-01 21:23:07 +0000864#ifndef SQLITE_LIKE_DOESNT_MATCH_BLOBS
drh6f82e852015-06-06 20:12:09 +0000865/*
drh44aebff2016-05-02 10:25:42 +0000866** If the most recently coded instruction is a constant range constraint
867** (a string literal) that originated from the LIKE optimization, then
868** set P3 and P5 on the OP_String opcode so that the string will be cast
869** to a BLOB at appropriate times.
drh6f82e852015-06-06 20:12:09 +0000870**
871** The LIKE optimization trys to evaluate "x LIKE 'abc%'" as a range
872** expression: "x>='ABC' AND x<'abd'". But this requires that the range
873** scan loop run twice, once for strings and a second time for BLOBs.
874** The OP_String opcodes on the second pass convert the upper and lower
mistachkine234cfd2016-07-10 19:35:10 +0000875** bound string constants to blobs. This routine makes the necessary changes
drh6f82e852015-06-06 20:12:09 +0000876** to the OP_String opcodes for that to happen.
drh41d2e662015-12-01 21:23:07 +0000877**
878** Except, of course, if SQLITE_LIKE_DOESNT_MATCH_BLOBS is defined, then
879** only the one pass through the string space is required, so this routine
880** becomes a no-op.
drh6f82e852015-06-06 20:12:09 +0000881*/
882static void whereLikeOptimizationStringFixup(
883 Vdbe *v, /* prepared statement under construction */
884 WhereLevel *pLevel, /* The loop that contains the LIKE operator */
885 WhereTerm *pTerm /* The upper or lower bound just coded */
886){
887 if( pTerm->wtFlags & TERM_LIKEOPT ){
888 VdbeOp *pOp;
889 assert( pLevel->iLikeRepCntr>0 );
890 pOp = sqlite3VdbeGetOp(v, -1);
891 assert( pOp!=0 );
892 assert( pOp->opcode==OP_String8
893 || pTerm->pWC->pWInfo->pParse->db->mallocFailed );
drh44aebff2016-05-02 10:25:42 +0000894 pOp->p3 = (int)(pLevel->iLikeRepCntr>>1); /* Register holding counter */
895 pOp->p5 = (u8)(pLevel->iLikeRepCntr&1); /* ASC or DESC */
drh6f82e852015-06-06 20:12:09 +0000896 }
897}
drh41d2e662015-12-01 21:23:07 +0000898#else
899# define whereLikeOptimizationStringFixup(A,B,C)
900#endif
drh6f82e852015-06-06 20:12:09 +0000901
drhbec24762015-08-13 20:07:13 +0000902#ifdef SQLITE_ENABLE_CURSOR_HINTS
drh2f2b0272015-08-14 18:50:04 +0000903/*
904** Information is passed from codeCursorHint() down to individual nodes of
905** the expression tree (by sqlite3WalkExpr()) using an instance of this
906** structure.
907*/
908struct CCurHint {
909 int iTabCur; /* Cursor for the main table */
910 int iIdxCur; /* Cursor for the index, if pIdx!=0. Unused otherwise */
911 Index *pIdx; /* The index used to access the table */
912};
913
914/*
915** This function is called for every node of an expression that is a candidate
916** for a cursor hint on an index cursor. For TK_COLUMN nodes that reference
917** the table CCurHint.iTabCur, verify that the same column can be
918** accessed through the index. If it cannot, then set pWalker->eCode to 1.
919*/
920static int codeCursorHintCheckExpr(Walker *pWalker, Expr *pExpr){
921 struct CCurHint *pHint = pWalker->u.pCCurHint;
922 assert( pHint->pIdx!=0 );
923 if( pExpr->op==TK_COLUMN
924 && pExpr->iTable==pHint->iTabCur
drhb9bcf7c2019-10-19 13:29:10 +0000925 && sqlite3TableColumnToIndex(pHint->pIdx, pExpr->iColumn)<0
drh2f2b0272015-08-14 18:50:04 +0000926 ){
927 pWalker->eCode = 1;
928 }
929 return WRC_Continue;
930}
931
dane6912fd2016-06-17 19:27:13 +0000932/*
933** Test whether or not expression pExpr, which was part of a WHERE clause,
934** should be included in the cursor-hint for a table that is on the rhs
935** of a LEFT JOIN. Set Walker.eCode to non-zero before returning if the
936** expression is not suitable.
937**
938** An expression is unsuitable if it might evaluate to non NULL even if
939** a TK_COLUMN node that does affect the value of the expression is set
940** to NULL. For example:
941**
942** col IS NULL
943** col IS NOT NULL
944** coalesce(col, 1)
945** CASE WHEN col THEN 0 ELSE 1 END
946*/
947static int codeCursorHintIsOrFunction(Walker *pWalker, Expr *pExpr){
dan2b693d62016-06-20 17:22:06 +0000948 if( pExpr->op==TK_IS
dane6912fd2016-06-17 19:27:13 +0000949 || pExpr->op==TK_ISNULL || pExpr->op==TK_ISNOT
950 || pExpr->op==TK_NOTNULL || pExpr->op==TK_CASE
951 ){
952 pWalker->eCode = 1;
dan2b693d62016-06-20 17:22:06 +0000953 }else if( pExpr->op==TK_FUNCTION ){
954 int d1;
drh1d42ea72017-07-27 20:24:29 +0000955 char d2[4];
dan2b693d62016-06-20 17:22:06 +0000956 if( 0==sqlite3IsLikeFunction(pWalker->pParse->db, pExpr, &d1, d2) ){
957 pWalker->eCode = 1;
958 }
dane6912fd2016-06-17 19:27:13 +0000959 }
dan2b693d62016-06-20 17:22:06 +0000960
dane6912fd2016-06-17 19:27:13 +0000961 return WRC_Continue;
962}
963
drhbec24762015-08-13 20:07:13 +0000964
965/*
966** This function is called on every node of an expression tree used as an
967** argument to the OP_CursorHint instruction. If the node is a TK_COLUMN
drh2f2b0272015-08-14 18:50:04 +0000968** that accesses any table other than the one identified by
969** CCurHint.iTabCur, then do the following:
drhbec24762015-08-13 20:07:13 +0000970**
971** 1) allocate a register and code an OP_Column instruction to read
972** the specified column into the new register, and
973**
974** 2) transform the expression node to a TK_REGISTER node that reads
975** from the newly populated register.
drh2f2b0272015-08-14 18:50:04 +0000976**
977** Also, if the node is a TK_COLUMN that does access the table idenified
978** by pCCurHint.iTabCur, and an index is being used (which we will
979** know because CCurHint.pIdx!=0) then transform the TK_COLUMN into
980** an access of the index rather than the original table.
drhbec24762015-08-13 20:07:13 +0000981*/
982static int codeCursorHintFixExpr(Walker *pWalker, Expr *pExpr){
983 int rc = WRC_Continue;
drh2f2b0272015-08-14 18:50:04 +0000984 struct CCurHint *pHint = pWalker->u.pCCurHint;
danbe312ae2018-09-10 19:27:12 +0000985 if( pExpr->op==TK_COLUMN ){
drh2f2b0272015-08-14 18:50:04 +0000986 if( pExpr->iTable!=pHint->iTabCur ){
drh2f2b0272015-08-14 18:50:04 +0000987 int reg = ++pWalker->pParse->nMem; /* Register for column value */
dane3e79212018-09-11 13:38:35 +0000988 sqlite3ExprCode(pWalker->pParse, pExpr, reg);
drh2f2b0272015-08-14 18:50:04 +0000989 pExpr->op = TK_REGISTER;
990 pExpr->iTable = reg;
991 }else if( pHint->pIdx!=0 ){
992 pExpr->iTable = pHint->iIdxCur;
drhb9bcf7c2019-10-19 13:29:10 +0000993 pExpr->iColumn = sqlite3TableColumnToIndex(pHint->pIdx, pExpr->iColumn);
drh2f2b0272015-08-14 18:50:04 +0000994 assert( pExpr->iColumn>=0 );
995 }
drhbec24762015-08-13 20:07:13 +0000996 }else if( pExpr->op==TK_AGG_FUNCTION ){
997 /* An aggregate function in the WHERE clause of a query means this must
998 ** be a correlated sub-query, and expression pExpr is an aggregate from
999 ** the parent context. Do not walk the function arguments in this case.
1000 **
1001 ** todo: It should be possible to replace this node with a TK_REGISTER
1002 ** expression, as the result of the expression must be stored in a
1003 ** register at this point. The same holds for TK_AGG_COLUMN nodes. */
1004 rc = WRC_Prune;
1005 }
1006 return rc;
1007}
1008
1009/*
1010** Insert an OP_CursorHint instruction if it is appropriate to do so.
1011*/
1012static void codeCursorHint(
drh76012942021-02-21 21:04:54 +00001013 SrcItem *pTabItem, /* FROM clause item */
drhb413a542015-08-17 17:19:28 +00001014 WhereInfo *pWInfo, /* The where clause */
1015 WhereLevel *pLevel, /* Which loop to provide hints for */
1016 WhereTerm *pEndRange /* Hint this end-of-scan boundary term if not NULL */
drhbec24762015-08-13 20:07:13 +00001017){
1018 Parse *pParse = pWInfo->pParse;
1019 sqlite3 *db = pParse->db;
1020 Vdbe *v = pParse->pVdbe;
drhbec24762015-08-13 20:07:13 +00001021 Expr *pExpr = 0;
drh2f2b0272015-08-14 18:50:04 +00001022 WhereLoop *pLoop = pLevel->pWLoop;
drhbec24762015-08-13 20:07:13 +00001023 int iCur;
1024 WhereClause *pWC;
1025 WhereTerm *pTerm;
drhb413a542015-08-17 17:19:28 +00001026 int i, j;
drh2f2b0272015-08-14 18:50:04 +00001027 struct CCurHint sHint;
1028 Walker sWalker;
drhbec24762015-08-13 20:07:13 +00001029
1030 if( OptimizationDisabled(db, SQLITE_CursorHints) ) return;
drh2f2b0272015-08-14 18:50:04 +00001031 iCur = pLevel->iTabCur;
1032 assert( iCur==pWInfo->pTabList->a[pLevel->iFrom].iCursor );
1033 sHint.iTabCur = iCur;
1034 sHint.iIdxCur = pLevel->iIdxCur;
1035 sHint.pIdx = pLoop->u.btree.pIndex;
1036 memset(&sWalker, 0, sizeof(sWalker));
1037 sWalker.pParse = pParse;
1038 sWalker.u.pCCurHint = &sHint;
drhbec24762015-08-13 20:07:13 +00001039 pWC = &pWInfo->sWC;
drh132f96f2021-12-08 16:07:22 +00001040 for(i=0; i<pWC->nBase; i++){
drhbec24762015-08-13 20:07:13 +00001041 pTerm = &pWC->a[i];
1042 if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
1043 if( pTerm->prereqAll & pLevel->notReady ) continue;
danb324cf72016-06-17 14:33:32 +00001044
1045 /* Any terms specified as part of the ON(...) clause for any LEFT
1046 ** JOIN for which the current table is not the rhs are omitted
1047 ** from the cursor-hint.
1048 **
dane6912fd2016-06-17 19:27:13 +00001049 ** If this table is the rhs of a LEFT JOIN, "IS" or "IS NULL" terms
1050 ** that were specified as part of the WHERE clause must be excluded.
1051 ** This is to address the following:
danb324cf72016-06-17 14:33:32 +00001052 **
1053 ** SELECT ... t1 LEFT JOIN t2 ON (t1.a=t2.b) WHERE t2.c IS NULL;
1054 **
dane6912fd2016-06-17 19:27:13 +00001055 ** Say there is a single row in t2 that matches (t1.a=t2.b), but its
1056 ** t2.c values is not NULL. If the (t2.c IS NULL) constraint is
1057 ** pushed down to the cursor, this row is filtered out, causing
1058 ** SQLite to synthesize a row of NULL values. Which does match the
1059 ** WHERE clause, and so the query returns a row. Which is incorrect.
1060 **
1061 ** For the same reason, WHERE terms such as:
1062 **
1063 ** WHERE 1 = (t2.c IS NULL)
1064 **
1065 ** are also excluded. See codeCursorHintIsOrFunction() for details.
danb324cf72016-06-17 14:33:32 +00001066 */
1067 if( pTabItem->fg.jointype & JT_LEFT ){
dane6912fd2016-06-17 19:27:13 +00001068 Expr *pExpr = pTerm->pExpr;
1069 if( !ExprHasProperty(pExpr, EP_FromJoin)
drhd1985262022-04-11 11:25:28 +00001070 || pExpr->w.iJoin!=pTabItem->iCursor
danb324cf72016-06-17 14:33:32 +00001071 ){
dane6912fd2016-06-17 19:27:13 +00001072 sWalker.eCode = 0;
1073 sWalker.xExprCallback = codeCursorHintIsOrFunction;
1074 sqlite3WalkExpr(&sWalker, pTerm->pExpr);
1075 if( sWalker.eCode ) continue;
danb324cf72016-06-17 14:33:32 +00001076 }
1077 }else{
1078 if( ExprHasProperty(pTerm->pExpr, EP_FromJoin) ) continue;
1079 }
drhb413a542015-08-17 17:19:28 +00001080
1081 /* All terms in pWLoop->aLTerm[] except pEndRange are used to initialize
drhbcf40a72015-08-18 15:58:05 +00001082 ** the cursor. These terms are not needed as hints for a pure range
1083 ** scan (that has no == terms) so omit them. */
1084 if( pLoop->u.btree.nEq==0 && pTerm!=pEndRange ){
1085 for(j=0; j<pLoop->nLTerm && pLoop->aLTerm[j]!=pTerm; j++){}
1086 if( j<pLoop->nLTerm ) continue;
drhb413a542015-08-17 17:19:28 +00001087 }
1088
1089 /* No subqueries or non-deterministic functions allowed */
drhbec24762015-08-13 20:07:13 +00001090 if( sqlite3ExprContainsSubquery(pTerm->pExpr) ) continue;
drhb413a542015-08-17 17:19:28 +00001091
1092 /* For an index scan, make sure referenced columns are actually in
1093 ** the index. */
drh2f2b0272015-08-14 18:50:04 +00001094 if( sHint.pIdx!=0 ){
1095 sWalker.eCode = 0;
1096 sWalker.xExprCallback = codeCursorHintCheckExpr;
1097 sqlite3WalkExpr(&sWalker, pTerm->pExpr);
1098 if( sWalker.eCode ) continue;
1099 }
drhb413a542015-08-17 17:19:28 +00001100
1101 /* If we survive all prior tests, that means this term is worth hinting */
drhd5c851c2019-04-19 13:38:34 +00001102 pExpr = sqlite3ExprAnd(pParse, pExpr, sqlite3ExprDup(db, pTerm->pExpr, 0));
drhbec24762015-08-13 20:07:13 +00001103 }
1104 if( pExpr!=0 ){
drhbec24762015-08-13 20:07:13 +00001105 sWalker.xExprCallback = codeCursorHintFixExpr;
drhbec24762015-08-13 20:07:13 +00001106 sqlite3WalkExpr(&sWalker, pExpr);
drh2f2b0272015-08-14 18:50:04 +00001107 sqlite3VdbeAddOp4(v, OP_CursorHint,
1108 (sHint.pIdx ? sHint.iIdxCur : sHint.iTabCur), 0, 0,
1109 (const char*)pExpr, P4_EXPR);
drhbec24762015-08-13 20:07:13 +00001110 }
1111}
1112#else
danb324cf72016-06-17 14:33:32 +00001113# define codeCursorHint(A,B,C,D) /* No-op */
drhbec24762015-08-13 20:07:13 +00001114#endif /* SQLITE_ENABLE_CURSOR_HINTS */
drh6f82e852015-06-06 20:12:09 +00001115
1116/*
dande892d92016-01-29 19:29:45 +00001117** Cursor iCur is open on an intkey b-tree (a table). Register iRowid contains
1118** a rowid value just read from cursor iIdxCur, open on index pIdx. This
1119** function generates code to do a deferred seek of cursor iCur to the
1120** rowid stored in register iRowid.
1121**
1122** Normally, this is just:
1123**
drh170ad682017-06-02 15:44:22 +00001124** OP_DeferredSeek $iCur $iRowid
dande892d92016-01-29 19:29:45 +00001125**
drh7fd6a772022-02-25 13:29:56 +00001126** Which causes a seek on $iCur to the row with rowid $iRowid.
1127**
dande892d92016-01-29 19:29:45 +00001128** However, if the scan currently being coded is a branch of an OR-loop and
drh7fd6a772022-02-25 13:29:56 +00001129** the statement currently being coded is a SELECT, then additional information
1130** is added that might allow OP_Column to omit the seek and instead do its
1131** lookup on the index, thus avoiding an expensive seek operation. To
1132** enable this optimization, the P3 of OP_DeferredSeek is set to iIdxCur
1133** and P4 is set to an array of integers containing one entry for each column
1134** in the table. For each table column, if the column is the i'th
1135** column of the index, then the corresponding array entry is set to (i+1).
1136** If the column does not appear in the index at all, the array entry is set
1137** to 0. The OP_Column opcode can check this array to see if the column it
1138** wants is in the index and if it is, it will substitute the index cursor
1139** and column number and continue with those new values, rather than seeking
1140** the table cursor.
dande892d92016-01-29 19:29:45 +00001141*/
1142static void codeDeferredSeek(
1143 WhereInfo *pWInfo, /* Where clause context */
1144 Index *pIdx, /* Index scan is using */
1145 int iCur, /* Cursor for IPK b-tree */
dande892d92016-01-29 19:29:45 +00001146 int iIdxCur /* Index cursor */
1147){
1148 Parse *pParse = pWInfo->pParse; /* Parse context */
1149 Vdbe *v = pParse->pVdbe; /* Vdbe to generate code within */
1150
1151 assert( iIdxCur>0 );
1152 assert( pIdx->aiColumn[pIdx->nColumn-1]==-1 );
1153
drhbe3da242019-12-29 00:52:41 +00001154 pWInfo->bDeferredSeek = 1;
drh170ad682017-06-02 15:44:22 +00001155 sqlite3VdbeAddOp3(v, OP_DeferredSeek, iIdxCur, 0, iCur);
drhc5837192022-04-11 14:26:37 +00001156 if( (pWInfo->wctrlFlags & (WHERE_OR_SUBCLAUSE|WHERE_RIGHT_JOIN))
dancddb6ba2016-02-01 13:58:56 +00001157 && DbMaskAllZero(sqlite3ParseToplevel(pParse)->writeMask)
dande892d92016-01-29 19:29:45 +00001158 ){
1159 int i;
1160 Table *pTab = pIdx->pTable;
drhabc38152020-07-22 13:38:04 +00001161 u32 *ai = (u32*)sqlite3DbMallocZero(pParse->db, sizeof(u32)*(pTab->nCol+1));
dande892d92016-01-29 19:29:45 +00001162 if( ai ){
drhb1702022016-01-30 00:45:18 +00001163 ai[0] = pTab->nCol;
dande892d92016-01-29 19:29:45 +00001164 for(i=0; i<pIdx->nColumn-1; i++){
drh4fb24c82019-11-06 17:31:18 +00001165 int x1, x2;
dande892d92016-01-29 19:29:45 +00001166 assert( pIdx->aiColumn[i]<pTab->nCol );
drh4fb24c82019-11-06 17:31:18 +00001167 x1 = pIdx->aiColumn[i];
1168 x2 = sqlite3TableColumnToStorage(pTab, x1);
1169 testcase( x1!=x2 );
mistachkinbde3a4f2019-11-06 19:25:45 +00001170 if( x1>=0 ) ai[x2+1] = i+1;
dande892d92016-01-29 19:29:45 +00001171 }
1172 sqlite3VdbeChangeP4(v, -1, (char*)ai, P4_INTARRAY);
1173 }
1174 }
1175}
1176
dan553168c2016-08-01 20:14:31 +00001177/*
1178** If the expression passed as the second argument is a vector, generate
1179** code to write the first nReg elements of the vector into an array
1180** of registers starting with iReg.
1181**
1182** If the expression is not a vector, then nReg must be passed 1. In
1183** this case, generate code to evaluate the expression and leave the
1184** result in register iReg.
1185*/
dan71c57db2016-07-09 20:23:55 +00001186static void codeExprOrVector(Parse *pParse, Expr *p, int iReg, int nReg){
1187 assert( nReg>0 );
dand03024d2017-09-09 19:41:12 +00001188 if( p && sqlite3ExprIsVector(p) ){
danf9b2e052016-08-02 17:45:00 +00001189#ifndef SQLITE_OMIT_SUBQUERY
drha4eeccd2021-10-07 17:43:30 +00001190 if( ExprUseXSelect(p) ){
danf9b2e052016-08-02 17:45:00 +00001191 Vdbe *v = pParse->pVdbe;
drh85bcdce2018-12-23 21:27:29 +00001192 int iSelect;
1193 assert( p->op==TK_SELECT );
1194 iSelect = sqlite3CodeSubselect(pParse, p);
danf9b2e052016-08-02 17:45:00 +00001195 sqlite3VdbeAddOp3(v, OP_Copy, iSelect, iReg, nReg-1);
1196 }else
1197#endif
1198 {
1199 int i;
drha4eeccd2021-10-07 17:43:30 +00001200 const ExprList *pList;
1201 assert( ExprUseXList(p) );
1202 pList = p->x.pList;
dan71c57db2016-07-09 20:23:55 +00001203 assert( nReg<=pList->nExpr );
1204 for(i=0; i<nReg; i++){
1205 sqlite3ExprCode(pParse, pList->a[i].pExpr, iReg+i);
1206 }
dan71c57db2016-07-09 20:23:55 +00001207 }
1208 }else{
dan151446e2021-05-26 14:32:33 +00001209 assert( nReg==1 || pParse->nErr );
dan71c57db2016-07-09 20:23:55 +00001210 sqlite3ExprCode(pParse, p, iReg);
1211 }
1212}
1213
drheac5fc02017-04-11 01:01:27 +00001214/* An instance of the IdxExprTrans object carries information about a
1215** mapping from an expression on table columns into a column in an index
1216** down through the Walker.
1217*/
drhaca19e12017-04-07 19:41:31 +00001218typedef struct IdxExprTrans {
1219 Expr *pIdxExpr; /* The index expression */
1220 int iTabCur; /* The cursor of the corresponding table */
1221 int iIdxCur; /* The cursor for the index */
1222 int iIdxCol; /* The column for the index */
drhc7476732019-10-24 20:29:25 +00001223 int iTabCol; /* The column for the table */
drh36e678b2020-01-02 00:45:38 +00001224 WhereInfo *pWInfo; /* Complete WHERE clause information */
1225 sqlite3 *db; /* Database connection (for malloc()) */
drhaca19e12017-04-07 19:41:31 +00001226} IdxExprTrans;
1227
drh36e678b2020-01-02 00:45:38 +00001228/*
1229** Preserve pExpr on the WhereETrans list of the WhereInfo.
1230*/
1231static void preserveExpr(IdxExprTrans *pTrans, Expr *pExpr){
1232 WhereExprMod *pNew;
1233 pNew = sqlite3DbMallocRaw(pTrans->db, sizeof(*pNew));
1234 if( pNew==0 ) return;
1235 pNew->pNext = pTrans->pWInfo->pExprMods;
1236 pTrans->pWInfo->pExprMods = pNew;
1237 pNew->pExpr = pExpr;
1238 memcpy(&pNew->orig, pExpr, sizeof(*pExpr));
1239}
1240
drheac5fc02017-04-11 01:01:27 +00001241/* The walker node callback used to transform matching expressions into
1242** a reference to an index column for an index on an expression.
1243**
1244** If pExpr matches, then transform it into a reference to the index column
1245** that contains the value of pExpr.
1246*/
drhaca19e12017-04-07 19:41:31 +00001247static int whereIndexExprTransNode(Walker *p, Expr *pExpr){
1248 IdxExprTrans *pX = p->u.pIdxTrans;
dan5aa550c2017-06-24 18:10:29 +00001249 if( sqlite3ExprCompare(0, pExpr, pX->pIdxExpr, pX->iTabCur)==0 ){
drh36e678b2020-01-02 00:45:38 +00001250 preserveExpr(pX, pExpr);
danb6ce71b2019-08-20 11:43:44 +00001251 pExpr->affExpr = sqlite3ExprAffinity(pExpr);
drhaca19e12017-04-07 19:41:31 +00001252 pExpr->op = TK_COLUMN;
1253 pExpr->iTable = pX->iIdxCur;
1254 pExpr->iColumn = pX->iIdxCol;
drh6c1c85c2019-12-22 18:55:04 +00001255 testcase( ExprHasProperty(pExpr, EP_Skip) );
1256 testcase( ExprHasProperty(pExpr, EP_Unlikely) );
drh477572b2021-10-07 20:46:29 +00001257 ExprClearProperty(pExpr, EP_Skip|EP_Unlikely|EP_WinFunc|EP_Subrtn);
1258 pExpr->y.pTab = 0;
drhaca19e12017-04-07 19:41:31 +00001259 return WRC_Prune;
1260 }else{
1261 return WRC_Continue;
1262 }
1263}
1264
drhc7476732019-10-24 20:29:25 +00001265#ifndef SQLITE_OMIT_GENERATED_COLUMNS
1266/* A walker node callback that translates a column reference to a table
1267** into a corresponding column reference of an index.
1268*/
1269static int whereIndexExprTransColumn(Walker *p, Expr *pExpr){
1270 if( pExpr->op==TK_COLUMN ){
1271 IdxExprTrans *pX = p->u.pIdxTrans;
1272 if( pExpr->iTable==pX->iTabCur && pExpr->iColumn==pX->iTabCol ){
drh477572b2021-10-07 20:46:29 +00001273 assert( ExprUseYTab(pExpr) && pExpr->y.pTab!=0 );
drh36e678b2020-01-02 00:45:38 +00001274 preserveExpr(pX, pExpr);
drh57f7ece2019-11-21 18:28:44 +00001275 pExpr->affExpr = sqlite3TableColumnAffinity(pExpr->y.pTab,pExpr->iColumn);
drhc7476732019-10-24 20:29:25 +00001276 pExpr->iTable = pX->iIdxCur;
1277 pExpr->iColumn = pX->iIdxCol;
drh4485ac12019-10-24 21:02:06 +00001278 pExpr->y.pTab = 0;
drhc7476732019-10-24 20:29:25 +00001279 }
1280 }
1281 return WRC_Continue;
1282}
1283#endif /* SQLITE_OMIT_GENERATED_COLUMNS */
1284
drhaca19e12017-04-07 19:41:31 +00001285/*
drhf49759b2017-08-25 19:51:51 +00001286** For an indexes on expression X, locate every instance of expression X
1287** in pExpr and change that subexpression into a reference to the appropriate
1288** column of the index.
drhc7476732019-10-24 20:29:25 +00001289**
1290** 2019-10-24: Updated to also translate references to a VIRTUAL column in
1291** the table into references to the corresponding (stored) column of the
1292** index.
drhaca19e12017-04-07 19:41:31 +00001293*/
1294static void whereIndexExprTrans(
1295 Index *pIdx, /* The Index */
1296 int iTabCur, /* Cursor of the table that is being indexed */
1297 int iIdxCur, /* Cursor of the index itself */
1298 WhereInfo *pWInfo /* Transform expressions in this WHERE clause */
1299){
1300 int iIdxCol; /* Column number of the index */
1301 ExprList *aColExpr; /* Expressions that are indexed */
drhc7476732019-10-24 20:29:25 +00001302 Table *pTab;
drhaca19e12017-04-07 19:41:31 +00001303 Walker w;
1304 IdxExprTrans x;
1305 aColExpr = pIdx->aColExpr;
drhc7476732019-10-24 20:29:25 +00001306 if( aColExpr==0 && !pIdx->bHasVCol ){
1307 /* The index does not reference any expressions or virtual columns
1308 ** so no translations are needed. */
1309 return;
1310 }
1311 pTab = pIdx->pTable;
drhaca19e12017-04-07 19:41:31 +00001312 memset(&w, 0, sizeof(w));
drhaca19e12017-04-07 19:41:31 +00001313 w.u.pIdxTrans = &x;
1314 x.iTabCur = iTabCur;
1315 x.iIdxCur = iIdxCur;
drh36e678b2020-01-02 00:45:38 +00001316 x.pWInfo = pWInfo;
1317 x.db = pWInfo->pParse->db;
drhc7476732019-10-24 20:29:25 +00001318 for(iIdxCol=0; iIdxCol<pIdx->nColumn; iIdxCol++){
1319 i16 iRef = pIdx->aiColumn[iIdxCol];
1320 if( iRef==XN_EXPR ){
drh7d4c94b2021-10-04 22:34:38 +00001321 assert( aColExpr!=0 && aColExpr->a[iIdxCol].pExpr!=0 );
drhc7476732019-10-24 20:29:25 +00001322 x.pIdxExpr = aColExpr->a[iIdxCol].pExpr;
drhe86f3402019-12-26 00:20:56 +00001323 if( sqlite3ExprIsConstant(x.pIdxExpr) ) continue;
drhc7476732019-10-24 20:29:25 +00001324 w.xExprCallback = whereIndexExprTransNode;
1325#ifndef SQLITE_OMIT_GENERATED_COLUMNS
drhed0c3482019-12-20 22:46:41 +00001326 }else if( iRef>=0
1327 && (pTab->aCol[iRef].colFlags & COLFLAG_VIRTUAL)!=0
drh65b40092021-08-05 15:27:19 +00001328 && ((pTab->aCol[iRef].colFlags & COLFLAG_HASCOLL)==0
1329 || sqlite3StrICmp(sqlite3ColumnColl(&pTab->aCol[iRef]),
1330 sqlite3StrBINARY)==0)
drhed0c3482019-12-20 22:46:41 +00001331 ){
1332 /* Check to see if there are direct references to generated columns
1333 ** that are contained in the index. Pulling the generated column
1334 ** out of the index is an optimization only - the main table is always
1335 ** available if the index cannot be used. To avoid unnecessary
1336 ** complication, omit this optimization if the collating sequence for
1337 ** the column is non-standard */
drhc7476732019-10-24 20:29:25 +00001338 x.iTabCol = iRef;
1339 w.xExprCallback = whereIndexExprTransColumn;
1340#endif /* SQLITE_OMIT_GENERATED_COLUMNS */
1341 }else{
1342 continue;
1343 }
drhaca19e12017-04-07 19:41:31 +00001344 x.iIdxCol = iIdxCol;
drhaca19e12017-04-07 19:41:31 +00001345 sqlite3WalkExpr(&w, pWInfo->pWhere);
1346 sqlite3WalkExprList(&w, pWInfo->pOrderBy);
1347 sqlite3WalkExprList(&w, pWInfo->pResultSet);
1348 }
1349}
drhaca19e12017-04-07 19:41:31 +00001350
dande892d92016-01-29 19:29:45 +00001351/*
drh610f11d2019-03-18 10:30:00 +00001352** The pTruth expression is always true because it is the WHERE clause
drhb531aa82019-03-01 18:07:05 +00001353** a partial index that is driving a query loop. Look through all of the
1354** WHERE clause terms on the query, and if any of those terms must be
1355** true because pTruth is true, then mark those WHERE clause terms as
1356** coded.
1357*/
1358static void whereApplyPartialIndexConstraints(
1359 Expr *pTruth,
1360 int iTabCur,
1361 WhereClause *pWC
1362){
1363 int i;
1364 WhereTerm *pTerm;
1365 while( pTruth->op==TK_AND ){
1366 whereApplyPartialIndexConstraints(pTruth->pLeft, iTabCur, pWC);
1367 pTruth = pTruth->pRight;
1368 }
1369 for(i=0, pTerm=pWC->a; i<pWC->nTerm; i++, pTerm++){
1370 Expr *pExpr;
1371 if( pTerm->wtFlags & TERM_CODED ) continue;
1372 pExpr = pTerm->pExpr;
1373 if( sqlite3ExprCompare(0, pExpr, pTruth, iTabCur)==0 ){
1374 pTerm->wtFlags |= TERM_CODED;
1375 }
1376 }
1377}
1378
drh35685d32021-12-05 00:45:55 +00001379/*
drh6ae49e62021-12-05 20:19:47 +00001380** This routine is called right after An OP_Filter has been generated and
1381** before the corresponding index search has been performed. This routine
1382** checks to see if there are additional Bloom filters in inner loops that
1383** can be checked prior to doing the index lookup. If there are available
1384** inner-loop Bloom filters, then evaluate those filters now, before the
1385** index lookup. The idea is that a Bloom filter check is way faster than
1386** an index lookup, and the Bloom filter might return false, meaning that
1387** the index lookup can be skipped.
1388**
1389** We know that an inner loop uses a Bloom filter because it has the
1390** WhereLevel.regFilter set. If an inner-loop Bloom filter is checked,
drh5a4ac1c2021-12-09 19:42:52 +00001391** then clear the WhereLevel.regFilter value to prevent the Bloom filter
drh6ae49e62021-12-05 20:19:47 +00001392** from being checked a second time when the inner loop is evaluated.
drh35685d32021-12-05 00:45:55 +00001393*/
1394static SQLITE_NOINLINE void filterPullDown(
1395 Parse *pParse, /* Parsing context */
1396 WhereInfo *pWInfo, /* Complete information about the WHERE clause */
1397 int iLevel, /* Which level of pWInfo->a[] should be coded */
1398 int addrNxt, /* Jump here to bypass inner loops */
1399 Bitmask notReady /* Loops that are not ready */
1400){
1401 while( ++iLevel < pWInfo->nLevel ){
1402 WhereLevel *pLevel = &pWInfo->a[iLevel];
1403 WhereLoop *pLoop = pLevel->pWLoop;
drh6ae49e62021-12-05 20:19:47 +00001404 if( pLevel->regFilter==0 ) continue;
drh56945692022-03-02 21:04:10 +00001405 if( pLevel->pWLoop->nSkip ) continue;
drh27a9e1f2021-12-10 17:36:16 +00001406 /* ,--- Because sqlite3ConstructBloomFilter() has will not have set
drha11c5e22021-12-09 18:44:03 +00001407 ** vvvvv--' pLevel->regFilter if this were true. */
1408 if( NEVER(pLoop->prereq & notReady) ) continue;
drh35685d32021-12-05 00:45:55 +00001409 if( pLoop->wsFlags & WHERE_IPK ){
1410 WhereTerm *pTerm = pLoop->aLTerm[0];
drh7e910f62021-12-09 01:28:15 +00001411 int regRowid;
drh35685d32021-12-05 00:45:55 +00001412 assert( pTerm!=0 );
1413 assert( pTerm->pExpr!=0 );
1414 testcase( pTerm->wtFlags & TERM_VIRTUAL );
drh7e910f62021-12-09 01:28:15 +00001415 regRowid = sqlite3GetTempReg(pParse);
1416 regRowid = codeEqualityTerm(pParse, pTerm, pLevel, 0, 0, regRowid);
drh35685d32021-12-05 00:45:55 +00001417 sqlite3VdbeAddOp4Int(pParse->pVdbe, OP_Filter, pLevel->regFilter,
1418 addrNxt, regRowid, 1);
1419 VdbeCoverage(pParse->pVdbe);
1420 }else{
1421 u16 nEq = pLoop->u.btree.nEq;
1422 int r1;
1423 char *zStartAff;
1424
1425 assert( pLoop->wsFlags & WHERE_INDEXED );
drhdc56dc92021-12-11 17:10:58 +00001426 assert( (pLoop->wsFlags & WHERE_COLUMN_IN)==0 );
drh35685d32021-12-05 00:45:55 +00001427 r1 = codeAllEqualityTerms(pParse,pLevel,0,0,&zStartAff);
1428 codeApplyAffinity(pParse, r1, nEq, zStartAff);
1429 sqlite3DbFree(pParse->db, zStartAff);
1430 sqlite3VdbeAddOp4Int(pParse->pVdbe, OP_Filter, pLevel->regFilter,
1431 addrNxt, r1, nEq);
1432 VdbeCoverage(pParse->pVdbe);
1433 }
drh6ae49e62021-12-05 20:19:47 +00001434 pLevel->regFilter = 0;
drh35685d32021-12-05 00:45:55 +00001435 }
1436}
drh35685d32021-12-05 00:45:55 +00001437
drhb531aa82019-03-01 18:07:05 +00001438/*
drh6f82e852015-06-06 20:12:09 +00001439** Generate code for the start of the iLevel-th loop in the WHERE clause
1440** implementation described by pWInfo.
1441*/
1442Bitmask sqlite3WhereCodeOneLoopStart(
drh47df8a22018-12-25 00:15:37 +00001443 Parse *pParse, /* Parsing context */
1444 Vdbe *v, /* Prepared statement under construction */
drh6f82e852015-06-06 20:12:09 +00001445 WhereInfo *pWInfo, /* Complete information about the WHERE clause */
1446 int iLevel, /* Which level of pWInfo->a[] should be coded */
drh47df8a22018-12-25 00:15:37 +00001447 WhereLevel *pLevel, /* The current level pointer */
drh6f82e852015-06-06 20:12:09 +00001448 Bitmask notReady /* Which tables are currently available */
1449){
1450 int j, k; /* Loop counters */
1451 int iCur; /* The VDBE cursor for the table */
1452 int addrNxt; /* Where to jump to continue with the next IN case */
drh6f82e852015-06-06 20:12:09 +00001453 int bRev; /* True if we need to scan in reverse order */
drh6f82e852015-06-06 20:12:09 +00001454 WhereLoop *pLoop; /* The WhereLoop object being coded */
1455 WhereClause *pWC; /* Decomposition of the entire WHERE clause */
1456 WhereTerm *pTerm; /* A WHERE clause term */
drh6f82e852015-06-06 20:12:09 +00001457 sqlite3 *db; /* Database connection */
drh76012942021-02-21 21:04:54 +00001458 SrcItem *pTabItem; /* FROM clause term being coded */
drh6f82e852015-06-06 20:12:09 +00001459 int addrBrk; /* Jump here to break out of the loop */
drh3a3b4202017-02-15 22:36:15 +00001460 int addrHalt; /* addrBrk for the outermost loop */
drh6f82e852015-06-06 20:12:09 +00001461 int addrCont; /* Jump here to continue with next cycle */
1462 int iRowidReg = 0; /* Rowid is stored in this register, if not zero */
1463 int iReleaseReg = 0; /* Temp register to free before returning */
dan6f654a42017-04-28 19:59:55 +00001464 Index *pIdx = 0; /* Index used by loop (if any) */
danebc63012017-07-10 14:33:00 +00001465 int iLoop; /* Iteration of constraint generator loop */
drh6f82e852015-06-06 20:12:09 +00001466
drh6f82e852015-06-06 20:12:09 +00001467 pWC = &pWInfo->sWC;
1468 db = pParse->db;
drh6f82e852015-06-06 20:12:09 +00001469 pLoop = pLevel->pWLoop;
1470 pTabItem = &pWInfo->pTabList->a[pLevel->iFrom];
1471 iCur = pTabItem->iCursor;
1472 pLevel->notReady = notReady & ~sqlite3WhereGetMask(&pWInfo->sMaskSet, iCur);
1473 bRev = (pWInfo->revMask>>iLevel)&1;
drh6f82e852015-06-06 20:12:09 +00001474 VdbeModuleComment((v, "Begin WHERE-loop%d: %s",iLevel,pTabItem->pTab->zName));
drh118efd12019-12-28 14:07:22 +00001475#if WHERETRACE_ENABLED /* 0x20800 */
1476 if( sqlite3WhereTrace & 0x800 ){
drha4b2df52019-12-28 16:20:23 +00001477 sqlite3DebugPrintf("Coding level %d of %d: notReady=%llx iFrom=%d\n",
1478 iLevel, pWInfo->nLevel, (u64)notReady, pLevel->iFrom);
drh118efd12019-12-28 14:07:22 +00001479 sqlite3WhereLoopPrint(pLoop, pWC);
1480 }
1481 if( sqlite3WhereTrace & 0x20000 ){
drhf1bb31e2019-12-28 14:33:26 +00001482 if( iLevel==0 ){
1483 sqlite3DebugPrintf("WHERE clause being coded:\n");
1484 sqlite3TreeViewExpr(0, pWInfo->pWhere, 0);
1485 }
1486 sqlite3DebugPrintf("All WHERE-clause terms before coding:\n");
drh118efd12019-12-28 14:07:22 +00001487 sqlite3WhereClausePrint(pWC);
1488 }
1489#endif
drh6f82e852015-06-06 20:12:09 +00001490
1491 /* Create labels for the "break" and "continue" instructions
1492 ** for the current loop. Jump to addrBrk to break out of a loop.
1493 ** Jump to cont to go immediately to the next iteration of the
1494 ** loop.
1495 **
1496 ** When there is an IN operator, we also have a "addrNxt" label that
1497 ** means to continue with the next IN value combination. When
1498 ** there are no IN operators in the constraints, the "addrNxt" label
1499 ** is the same as "addrBrk".
1500 */
drhec4ccdb2018-12-29 02:26:59 +00001501 addrBrk = pLevel->addrBrk = pLevel->addrNxt = sqlite3VdbeMakeLabel(pParse);
1502 addrCont = pLevel->addrCont = sqlite3VdbeMakeLabel(pParse);
drh6f82e852015-06-06 20:12:09 +00001503
1504 /* If this is the right table of a LEFT OUTER JOIN, allocate and
1505 ** initialize a memory cell that records if this table matches any
1506 ** row of the left table of the join.
1507 */
drhc5837192022-04-11 14:26:37 +00001508 assert( (pWInfo->wctrlFlags & (WHERE_OR_SUBCLAUSE|WHERE_RIGHT_JOIN))
dan820fcd22018-04-24 18:53:24 +00001509 || pLevel->iFrom>0 || (pTabItem[0].fg.jointype & JT_LEFT)==0
1510 );
drh8a48b9c2015-08-19 15:20:00 +00001511 if( pLevel->iFrom>0 && (pTabItem[0].fg.jointype & JT_LEFT)!=0 ){
drh6f82e852015-06-06 20:12:09 +00001512 pLevel->iLeftJoin = ++pParse->nMem;
1513 sqlite3VdbeAddOp2(v, OP_Integer, 0, pLevel->iLeftJoin);
1514 VdbeComment((v, "init LEFT JOIN no-match flag"));
1515 }
1516
drh3a3b4202017-02-15 22:36:15 +00001517 /* Compute a safe address to jump to if we discover that the table for
1518 ** this loop is empty and can never contribute content. */
1519 for(j=iLevel; j>0 && pWInfo->a[j].iLeftJoin==0; j--){}
1520 addrHalt = pWInfo->a[j].addrBrk;
1521
drh6f82e852015-06-06 20:12:09 +00001522 /* Special case of a FROM clause subquery implemented as a co-routine */
drh8a48b9c2015-08-19 15:20:00 +00001523 if( pTabItem->fg.viaCoroutine ){
drh6f82e852015-06-06 20:12:09 +00001524 int regYield = pTabItem->regReturn;
1525 sqlite3VdbeAddOp3(v, OP_InitCoroutine, regYield, 0, pTabItem->addrFillSub);
1526 pLevel->p2 = sqlite3VdbeAddOp2(v, OP_Yield, regYield, addrBrk);
1527 VdbeCoverage(v);
drhfef37762018-07-10 19:48:35 +00001528 VdbeComment((v, "next row of %s", pTabItem->pTab->zName));
drh6f82e852015-06-06 20:12:09 +00001529 pLevel->op = OP_Goto;
1530 }else
1531
1532#ifndef SQLITE_OMIT_VIRTUALTABLE
1533 if( (pLoop->wsFlags & WHERE_VIRTUALTABLE)!=0 ){
1534 /* Case 1: The table is a virtual-table. Use the VFilter and VNext
1535 ** to access the data.
1536 */
1537 int iReg; /* P3 Value for OP_VFilter */
1538 int addrNotFound;
1539 int nConstraint = pLoop->nLTerm;
1540
drh6f82e852015-06-06 20:12:09 +00001541 iReg = sqlite3GetTempRange(pParse, nConstraint+2);
1542 addrNotFound = pLevel->addrBrk;
1543 for(j=0; j<nConstraint; j++){
1544 int iTarget = iReg+j+2;
1545 pTerm = pLoop->aLTerm[j];
drh599d5762016-03-08 01:11:51 +00001546 if( NEVER(pTerm==0) ) continue;
drh6f82e852015-06-06 20:12:09 +00001547 if( pTerm->eOperator & WO_IN ){
drh0fe7e7d2022-02-01 14:58:29 +00001548 if( SMASKBIT32(j) & pLoop->u.vtab.mHandleIn ){
1549 int iTab = pParse->nTab++;
1550 int iCache = ++pParse->nMem;
1551 sqlite3CodeRhsOfIN(pParse, pTerm->pExpr, iTab);
1552 sqlite3VdbeAddOp3(v, OP_VInitIn, iTab, iTarget, iCache);
1553 }else{
1554 codeEqualityTerm(pParse, pTerm, pLevel, j, bRev, iTarget);
1555 addrNotFound = pLevel->addrNxt;
1556 }
drh6f82e852015-06-06 20:12:09 +00001557 }else{
dan6256c1c2016-08-08 20:15:41 +00001558 Expr *pRight = pTerm->pExpr->pRight;
drhfc7f27b2016-08-20 00:07:01 +00001559 codeExprOrVector(pParse, pRight, iTarget, 1);
drh8f2c0b52022-01-27 21:18:14 +00001560 if( pTerm->eMatchOp==SQLITE_INDEX_CONSTRAINT_OFFSET
1561 && pLoop->u.vtab.bOmitOffset
1562 ){
1563 assert( pTerm->eOperator==WO_AUX );
1564 assert( pWInfo->pLimit!=0 );
1565 assert( pWInfo->pLimit->iOffset>0 );
1566 sqlite3VdbeAddOp2(v, OP_Integer, 0, pWInfo->pLimit->iOffset);
1567 VdbeComment((v,"Zero OFFSET counter"));
1568 }
drh6f82e852015-06-06 20:12:09 +00001569 }
1570 }
1571 sqlite3VdbeAddOp2(v, OP_Integer, pLoop->u.vtab.idxNum, iReg);
1572 sqlite3VdbeAddOp2(v, OP_Integer, nConstraint, iReg+1);
1573 sqlite3VdbeAddOp4(v, OP_VFilter, iCur, addrNotFound, iReg,
1574 pLoop->u.vtab.idxStr,
drh861b1302016-12-07 20:22:31 +00001575 pLoop->u.vtab.needFree ? P4_DYNAMIC : P4_STATIC);
drh6f82e852015-06-06 20:12:09 +00001576 VdbeCoverage(v);
1577 pLoop->u.vtab.needFree = 0;
drhbc2e9512020-09-17 11:32:14 +00001578 /* An OOM inside of AddOp4(OP_VFilter) instruction above might have freed
1579 ** the u.vtab.idxStr. NULL it out to prevent a use-after-free */
1580 if( db->mallocFailed ) pLoop->u.vtab.idxStr = 0;
drh6f82e852015-06-06 20:12:09 +00001581 pLevel->p1 = iCur;
dan354474a2015-09-29 10:11:26 +00001582 pLevel->op = pWInfo->eOnePass ? OP_Noop : OP_VNext;
drh6f82e852015-06-06 20:12:09 +00001583 pLevel->p2 = sqlite3VdbeCurrentAddr(v);
drh04756292021-10-14 19:28:28 +00001584 assert( (pLoop->wsFlags & WHERE_MULTI_OR)==0 );
drh6d6ea422022-03-07 14:51:29 +00001585
1586 for(j=0; j<nConstraint; j++){
drhdbc49162016-03-02 03:28:07 +00001587 pTerm = pLoop->aLTerm[j];
1588 if( j<16 && (pLoop->u.vtab.omitMask>>j)&1 ){
1589 disableTerm(pLevel, pTerm);
drh6d6ea422022-03-07 14:51:29 +00001590 continue;
1591 }
1592 if( (pTerm->eOperator & WO_IN)!=0
1593 && (SMASKBIT32(j) & pLoop->u.vtab.mHandleIn)==0
1594 && !db->mallocFailed
1595 ){
drhdbc49162016-03-02 03:28:07 +00001596 Expr *pCompare; /* The comparison operator */
1597 Expr *pRight; /* RHS of the comparison */
1598 VdbeOp *pOp; /* Opcode to access the value of the IN constraint */
drh6d6ea422022-03-07 14:51:29 +00001599 int iIn; /* IN loop corresponding to the j-th constraint */
drhdbc49162016-03-02 03:28:07 +00001600
1601 /* Reload the constraint value into reg[iReg+j+2]. The same value
1602 ** was loaded into the same register prior to the OP_VFilter, but
1603 ** the xFilter implementation might have changed the datatype or
drh6d6ea422022-03-07 14:51:29 +00001604 ** encoding of the value in the register, so it *must* be reloaded.
1605 */
1606 for(iIn=0; ALWAYS(iIn<pLevel->u.in.nIn); iIn++){
drh68748ec2019-10-14 20:32:31 +00001607 pOp = sqlite3VdbeGetOp(v, pLevel->u.in.aInLoop[iIn].addrInTop);
drh6d6ea422022-03-07 14:51:29 +00001608 if( (pOp->opcode==OP_Column && pOp->p3==iReg+j+2)
1609 || (pOp->opcode==OP_Rowid && pOp->p2==iReg+j+2)
1610 ){
1611 testcase( pOp->opcode==OP_Rowid );
1612 sqlite3VdbeAddOp3(v, pOp->opcode, pOp->p1, pOp->p2, pOp->p3);
1613 break;
1614 }
drhdbc49162016-03-02 03:28:07 +00001615 }
1616
1617 /* Generate code that will continue to the next row if
drh6d6ea422022-03-07 14:51:29 +00001618 ** the IN constraint is not satisfied
1619 */
drhabfd35e2016-12-06 22:47:23 +00001620 pCompare = sqlite3PExpr(pParse, TK_EQ, 0, 0);
drh6d6ea422022-03-07 14:51:29 +00001621 if( !db->mallocFailed ){
1622 int iFld = pTerm->u.x.iField;
1623 Expr *pLeft = pTerm->pExpr->pLeft;
1624 assert( pLeft!=0 );
1625 if( iFld>0 ){
1626 assert( pLeft->op==TK_VECTOR );
1627 assert( ExprUseXList(pLeft) );
1628 assert( iFld<=pLeft->x.pList->nExpr );
1629 pCompare->pLeft = pLeft->x.pList->a[iFld-1].pExpr;
1630 }else{
1631 pCompare->pLeft = pLeft;
1632 }
drhdbc49162016-03-02 03:28:07 +00001633 pCompare->pRight = pRight = sqlite3Expr(db, TK_REGISTER, 0);
drh237b2b72016-03-07 19:08:27 +00001634 if( pRight ){
1635 pRight->iTable = iReg+j+2;
dand03f77a2020-01-29 15:03:01 +00001636 sqlite3ExprIfFalse(
1637 pParse, pCompare, pLevel->addrCont, SQLITE_JUMPIFNULL
1638 );
drh237b2b72016-03-07 19:08:27 +00001639 }
drhdbc49162016-03-02 03:28:07 +00001640 pCompare->pLeft = 0;
drhdbc49162016-03-02 03:28:07 +00001641 }
drh6d6ea422022-03-07 14:51:29 +00001642 sqlite3ExprDelete(db, pCompare);
drhdbc49162016-03-02 03:28:07 +00001643 }
1644 }
drh6d6ea422022-03-07 14:51:29 +00001645
drhba26faa2016-04-09 18:04:28 +00001646 /* These registers need to be preserved in case there is an IN operator
1647 ** loop. So we could deallocate the registers here (and potentially
1648 ** reuse them later) if (pLoop->wsFlags & WHERE_IN_ABLE)==0. But it seems
1649 ** simpler and safer to simply not reuse the registers.
1650 **
1651 ** sqlite3ReleaseTempRange(pParse, iReg, nConstraint+2);
1652 */
drh6f82e852015-06-06 20:12:09 +00001653 }else
1654#endif /* SQLITE_OMIT_VIRTUALTABLE */
1655
1656 if( (pLoop->wsFlags & WHERE_IPK)!=0
1657 && (pLoop->wsFlags & (WHERE_COLUMN_IN|WHERE_COLUMN_EQ))!=0
1658 ){
1659 /* Case 2: We can directly reference a single row using an
1660 ** equality comparison against the ROWID field. Or
1661 ** we reference multiple rows using a "rowid IN (...)"
1662 ** construct.
1663 */
1664 assert( pLoop->u.btree.nEq==1 );
1665 pTerm = pLoop->aLTerm[0];
1666 assert( pTerm!=0 );
1667 assert( pTerm->pExpr!=0 );
drh6f82e852015-06-06 20:12:09 +00001668 testcase( pTerm->wtFlags & TERM_VIRTUAL );
1669 iReleaseReg = ++pParse->nMem;
1670 iRowidReg = codeEqualityTerm(pParse, pTerm, pLevel, 0, bRev, iReleaseReg);
1671 if( iRowidReg!=iReleaseReg ) sqlite3ReleaseTempReg(pParse, iReleaseReg);
1672 addrNxt = pLevel->addrNxt;
drh2db144c2021-12-01 16:31:02 +00001673 if( pLevel->regFilter ){
1674 sqlite3VdbeAddOp4Int(v, OP_Filter, pLevel->regFilter, addrNxt,
1675 iRowidReg, 1);
drh067c60c2021-12-04 18:45:08 +00001676 VdbeCoverage(v);
drh35685d32021-12-05 00:45:55 +00001677 filterPullDown(pParse, pWInfo, iLevel, addrNxt, notReady);
drh2db144c2021-12-01 16:31:02 +00001678 }
drheeb95652016-05-26 20:56:38 +00001679 sqlite3VdbeAddOp3(v, OP_SeekRowid, iCur, addrNxt, iRowidReg);
drh6f82e852015-06-06 20:12:09 +00001680 VdbeCoverage(v);
drh6f82e852015-06-06 20:12:09 +00001681 pLevel->op = OP_Noop;
1682 }else if( (pLoop->wsFlags & WHERE_IPK)!=0
1683 && (pLoop->wsFlags & WHERE_COLUMN_RANGE)!=0
1684 ){
1685 /* Case 3: We have an inequality comparison against the ROWID field.
1686 */
1687 int testOp = OP_Noop;
1688 int start;
1689 int memEndValue = 0;
1690 WhereTerm *pStart, *pEnd;
1691
drh6f82e852015-06-06 20:12:09 +00001692 j = 0;
1693 pStart = pEnd = 0;
1694 if( pLoop->wsFlags & WHERE_BTM_LIMIT ) pStart = pLoop->aLTerm[j++];
1695 if( pLoop->wsFlags & WHERE_TOP_LIMIT ) pEnd = pLoop->aLTerm[j++];
1696 assert( pStart!=0 || pEnd!=0 );
1697 if( bRev ){
1698 pTerm = pStart;
1699 pStart = pEnd;
1700 pEnd = pTerm;
1701 }
danb324cf72016-06-17 14:33:32 +00001702 codeCursorHint(pTabItem, pWInfo, pLevel, pEnd);
drh6f82e852015-06-06 20:12:09 +00001703 if( pStart ){
1704 Expr *pX; /* The expression that defines the start bound */
1705 int r1, rTemp; /* Registers for holding the start boundary */
dan19ff12d2016-07-29 20:58:19 +00001706 int op; /* Cursor seek operation */
drh6f82e852015-06-06 20:12:09 +00001707
1708 /* The following constant maps TK_xx codes into corresponding
1709 ** seek opcodes. It depends on a particular ordering of TK_xx
1710 */
1711 const u8 aMoveOp[] = {
1712 /* TK_GT */ OP_SeekGT,
1713 /* TK_LE */ OP_SeekLE,
1714 /* TK_LT */ OP_SeekLT,
1715 /* TK_GE */ OP_SeekGE
1716 };
1717 assert( TK_LE==TK_GT+1 ); /* Make sure the ordering.. */
1718 assert( TK_LT==TK_GT+2 ); /* ... of the TK_xx values... */
1719 assert( TK_GE==TK_GT+3 ); /* ... is correcct. */
1720
1721 assert( (pStart->wtFlags & TERM_VNULL)==0 );
1722 testcase( pStart->wtFlags & TERM_VIRTUAL );
1723 pX = pStart->pExpr;
1724 assert( pX!=0 );
1725 testcase( pStart->leftCursor!=iCur ); /* transitive constraints */
dan625015e2016-07-30 16:39:28 +00001726 if( sqlite3ExprIsVector(pX->pRight) ){
dan19ff12d2016-07-29 20:58:19 +00001727 r1 = rTemp = sqlite3GetTempReg(pParse);
1728 codeExprOrVector(pParse, pX->pRight, r1, 1);
drh4d1c6842018-02-13 18:48:08 +00001729 testcase( pX->op==TK_GT );
1730 testcase( pX->op==TK_GE );
1731 testcase( pX->op==TK_LT );
1732 testcase( pX->op==TK_LE );
1733 op = aMoveOp[((pX->op - TK_GT - 1) & 0x3) | 0x1];
1734 assert( pX->op!=TK_GT || op==OP_SeekGE );
1735 assert( pX->op!=TK_GE || op==OP_SeekGE );
1736 assert( pX->op!=TK_LT || op==OP_SeekLE );
1737 assert( pX->op!=TK_LE || op==OP_SeekLE );
dan19ff12d2016-07-29 20:58:19 +00001738 }else{
1739 r1 = sqlite3ExprCodeTemp(pParse, pX->pRight, &rTemp);
1740 disableTerm(pLevel, pStart);
1741 op = aMoveOp[(pX->op - TK_GT)];
1742 }
1743 sqlite3VdbeAddOp3(v, op, iCur, addrBrk, r1);
drh6f82e852015-06-06 20:12:09 +00001744 VdbeComment((v, "pk"));
1745 VdbeCoverageIf(v, pX->op==TK_GT);
1746 VdbeCoverageIf(v, pX->op==TK_LE);
1747 VdbeCoverageIf(v, pX->op==TK_LT);
1748 VdbeCoverageIf(v, pX->op==TK_GE);
drh6f82e852015-06-06 20:12:09 +00001749 sqlite3ReleaseTempReg(pParse, rTemp);
drh6f82e852015-06-06 20:12:09 +00001750 }else{
drh3a3b4202017-02-15 22:36:15 +00001751 sqlite3VdbeAddOp2(v, bRev ? OP_Last : OP_Rewind, iCur, addrHalt);
drh6f82e852015-06-06 20:12:09 +00001752 VdbeCoverageIf(v, bRev==0);
1753 VdbeCoverageIf(v, bRev!=0);
1754 }
1755 if( pEnd ){
1756 Expr *pX;
1757 pX = pEnd->pExpr;
1758 assert( pX!=0 );
1759 assert( (pEnd->wtFlags & TERM_VNULL)==0 );
1760 testcase( pEnd->leftCursor!=iCur ); /* Transitive constraints */
1761 testcase( pEnd->wtFlags & TERM_VIRTUAL );
1762 memEndValue = ++pParse->nMem;
dan19ff12d2016-07-29 20:58:19 +00001763 codeExprOrVector(pParse, pX->pRight, memEndValue, 1);
dan625015e2016-07-30 16:39:28 +00001764 if( 0==sqlite3ExprIsVector(pX->pRight)
1765 && (pX->op==TK_LT || pX->op==TK_GT)
1766 ){
drh6f82e852015-06-06 20:12:09 +00001767 testOp = bRev ? OP_Le : OP_Ge;
1768 }else{
1769 testOp = bRev ? OP_Lt : OP_Gt;
1770 }
dan553168c2016-08-01 20:14:31 +00001771 if( 0==sqlite3ExprIsVector(pX->pRight) ){
1772 disableTerm(pLevel, pEnd);
1773 }
drh6f82e852015-06-06 20:12:09 +00001774 }
1775 start = sqlite3VdbeCurrentAddr(v);
1776 pLevel->op = bRev ? OP_Prev : OP_Next;
1777 pLevel->p1 = iCur;
1778 pLevel->p2 = start;
1779 assert( pLevel->p5==0 );
1780 if( testOp!=OP_Noop ){
1781 iRowidReg = ++pParse->nMem;
1782 sqlite3VdbeAddOp2(v, OP_Rowid, iCur, iRowidReg);
drh6f82e852015-06-06 20:12:09 +00001783 sqlite3VdbeAddOp3(v, testOp, memEndValue, addrBrk, iRowidReg);
1784 VdbeCoverageIf(v, testOp==OP_Le);
1785 VdbeCoverageIf(v, testOp==OP_Lt);
1786 VdbeCoverageIf(v, testOp==OP_Ge);
1787 VdbeCoverageIf(v, testOp==OP_Gt);
1788 sqlite3VdbeChangeP5(v, SQLITE_AFF_NUMERIC | SQLITE_JUMPIFNULL);
1789 }
1790 }else if( pLoop->wsFlags & WHERE_INDEXED ){
1791 /* Case 4: A scan using an index.
1792 **
1793 ** The WHERE clause may contain zero or more equality
1794 ** terms ("==" or "IN" operators) that refer to the N
1795 ** left-most columns of the index. It may also contain
1796 ** inequality constraints (>, <, >= or <=) on the indexed
1797 ** column that immediately follows the N equalities. Only
1798 ** the right-most column can be an inequality - the rest must
1799 ** use the "==" and "IN" operators. For example, if the
1800 ** index is on (x,y,z), then the following clauses are all
1801 ** optimized:
1802 **
1803 ** x=5
1804 ** x=5 AND y=10
1805 ** x=5 AND y<10
1806 ** x=5 AND y>5 AND y<10
1807 ** x=5 AND y=5 AND z<=10
1808 **
1809 ** The z<10 term of the following cannot be used, only
1810 ** the x=5 term:
1811 **
1812 ** x=5 AND z<10
1813 **
1814 ** N may be zero if there are inequality constraints.
1815 ** If there are no inequality constraints, then N is at
1816 ** least one.
1817 **
1818 ** This case is also used when there are no WHERE clause
1819 ** constraints but an index is selected anyway, in order
1820 ** to force the output order to conform to an ORDER BY.
1821 */
1822 static const u8 aStartOp[] = {
1823 0,
1824 0,
1825 OP_Rewind, /* 2: (!start_constraints && startEq && !bRev) */
1826 OP_Last, /* 3: (!start_constraints && startEq && bRev) */
1827 OP_SeekGT, /* 4: (start_constraints && !startEq && !bRev) */
1828 OP_SeekLT, /* 5: (start_constraints && !startEq && bRev) */
1829 OP_SeekGE, /* 6: (start_constraints && startEq && !bRev) */
1830 OP_SeekLE /* 7: (start_constraints && startEq && bRev) */
1831 };
1832 static const u8 aEndOp[] = {
1833 OP_IdxGE, /* 0: (end_constraints && !bRev && !endEq) */
1834 OP_IdxGT, /* 1: (end_constraints && !bRev && endEq) */
1835 OP_IdxLE, /* 2: (end_constraints && bRev && !endEq) */
1836 OP_IdxLT, /* 3: (end_constraints && bRev && endEq) */
1837 };
1838 u16 nEq = pLoop->u.btree.nEq; /* Number of == or IN terms */
dan71c57db2016-07-09 20:23:55 +00001839 u16 nBtm = pLoop->u.btree.nBtm; /* Length of BTM vector */
1840 u16 nTop = pLoop->u.btree.nTop; /* Length of TOP vector */
drh6f82e852015-06-06 20:12:09 +00001841 int regBase; /* Base register holding constraint values */
1842 WhereTerm *pRangeStart = 0; /* Inequality constraint at range start */
1843 WhereTerm *pRangeEnd = 0; /* Inequality constraint at range end */
1844 int startEq; /* True if range start uses ==, >= or <= */
1845 int endEq; /* True if range end uses ==, >= or <= */
1846 int start_constraints; /* Start of range is constrained */
1847 int nConstraint; /* Number of constraint terms */
drh6f82e852015-06-06 20:12:09 +00001848 int iIdxCur; /* The VDBE cursor for the index */
1849 int nExtraReg = 0; /* Number of extra registers needed */
1850 int op; /* Instruction opcode */
1851 char *zStartAff; /* Affinity for start of range constraint */
danb7ca2172016-08-26 17:54:46 +00001852 char *zEndAff = 0; /* Affinity for end of range constraint */
drh6f82e852015-06-06 20:12:09 +00001853 u8 bSeekPastNull = 0; /* True to seek past initial nulls */
1854 u8 bStopAtNull = 0; /* Add condition to terminate at NULLs */
drh47df8a22018-12-25 00:15:37 +00001855 int omitTable; /* True if we use the index only */
drh74e1b862019-08-23 13:08:49 +00001856 int regBignull = 0; /* big-null flag register */
drh04e70ce2020-10-02 11:55:07 +00001857 int addrSeekScan = 0; /* Opcode of the OP_SeekScan, if any */
drh6f82e852015-06-06 20:12:09 +00001858
1859 pIdx = pLoop->u.btree.pIndex;
1860 iIdxCur = pLevel->iIdxCur;
1861 assert( nEq>=pLoop->nSkip );
1862
drh6f82e852015-06-06 20:12:09 +00001863 /* Find any inequality constraint terms for the start and end
1864 ** of the range.
1865 */
1866 j = nEq;
1867 if( pLoop->wsFlags & WHERE_BTM_LIMIT ){
1868 pRangeStart = pLoop->aLTerm[j++];
dan71c57db2016-07-09 20:23:55 +00001869 nExtraReg = MAX(nExtraReg, pLoop->u.btree.nBtm);
drh6f82e852015-06-06 20:12:09 +00001870 /* Like optimization range constraints always occur in pairs */
1871 assert( (pRangeStart->wtFlags & TERM_LIKEOPT)==0 ||
1872 (pLoop->wsFlags & WHERE_TOP_LIMIT)!=0 );
1873 }
1874 if( pLoop->wsFlags & WHERE_TOP_LIMIT ){
1875 pRangeEnd = pLoop->aLTerm[j++];
dan71c57db2016-07-09 20:23:55 +00001876 nExtraReg = MAX(nExtraReg, pLoop->u.btree.nTop);
drh41d2e662015-12-01 21:23:07 +00001877#ifndef SQLITE_LIKE_DOESNT_MATCH_BLOBS
drh6f82e852015-06-06 20:12:09 +00001878 if( (pRangeEnd->wtFlags & TERM_LIKEOPT)!=0 ){
1879 assert( pRangeStart!=0 ); /* LIKE opt constraints */
1880 assert( pRangeStart->wtFlags & TERM_LIKEOPT ); /* occur in pairs */
drh44aebff2016-05-02 10:25:42 +00001881 pLevel->iLikeRepCntr = (u32)++pParse->nMem;
1882 sqlite3VdbeAddOp2(v, OP_Integer, 1, (int)pLevel->iLikeRepCntr);
drh6f82e852015-06-06 20:12:09 +00001883 VdbeComment((v, "LIKE loop counter"));
1884 pLevel->addrLikeRep = sqlite3VdbeCurrentAddr(v);
drh44aebff2016-05-02 10:25:42 +00001885 /* iLikeRepCntr actually stores 2x the counter register number. The
1886 ** bottom bit indicates whether the search order is ASC or DESC. */
1887 testcase( bRev );
1888 testcase( pIdx->aSortOrder[nEq]==SQLITE_SO_DESC );
1889 assert( (bRev & ~1)==0 );
1890 pLevel->iLikeRepCntr <<=1;
1891 pLevel->iLikeRepCntr |= bRev ^ (pIdx->aSortOrder[nEq]==SQLITE_SO_DESC);
drh6f82e852015-06-06 20:12:09 +00001892 }
drh41d2e662015-12-01 21:23:07 +00001893#endif
drh48590fc2016-10-10 13:29:15 +00001894 if( pRangeStart==0 ){
1895 j = pIdx->aiColumn[nEq];
1896 if( (j>=0 && pIdx->pTable->aCol[j].notNull==0) || j==XN_EXPR ){
1897 bSeekPastNull = 1;
1898 }
drh6f82e852015-06-06 20:12:09 +00001899 }
1900 }
1901 assert( pRangeEnd==0 || (pRangeEnd->wtFlags & TERM_VNULL)==0 );
1902
dan15750a22019-08-16 21:07:19 +00001903 /* If the WHERE_BIGNULL_SORT flag is set, then index column nEq uses
1904 ** a non-default "big-null" sort (either ASC NULLS LAST or DESC NULLS
1905 ** FIRST). In both cases separate ordered scans are made of those
1906 ** index entries for which the column is null and for those for which
1907 ** it is not. For an ASC sort, the non-NULL entries are scanned first.
1908 ** For DESC, NULL entries are scanned first.
1909 */
dan15750a22019-08-16 21:07:19 +00001910 if( (pLoop->wsFlags & (WHERE_TOP_LIMIT|WHERE_BTM_LIMIT))==0
1911 && (pLoop->wsFlags & WHERE_BIGNULL_SORT)!=0
1912 ){
1913 assert( bSeekPastNull==0 && nExtraReg==0 && nBtm==0 && nTop==0 );
1914 assert( pRangeEnd==0 && pRangeStart==0 );
dan4adb1d02019-12-28 18:08:39 +00001915 testcase( pLoop->nSkip>0 );
dan15750a22019-08-16 21:07:19 +00001916 nExtraReg = 1;
1917 bSeekPastNull = 1;
1918 pLevel->regBignull = regBignull = ++pParse->nMem;
drh7f05d522020-03-02 01:16:33 +00001919 if( pLevel->iLeftJoin ){
1920 sqlite3VdbeAddOp2(v, OP_Integer, 0, regBignull);
1921 }
dancc491f42019-08-17 17:55:54 +00001922 pLevel->addrBignull = sqlite3VdbeMakeLabel(pParse);
dan15750a22019-08-16 21:07:19 +00001923 }
1924
drh6f82e852015-06-06 20:12:09 +00001925 /* If we are doing a reverse order scan on an ascending index, or
1926 ** a forward order scan on a descending index, interchange the
1927 ** start and end terms (pRangeStart and pRangeEnd).
1928 */
drh7ffb16b2021-05-12 22:15:44 +00001929 if( (nEq<pIdx->nColumn && bRev==(pIdx->aSortOrder[nEq]==SQLITE_SO_ASC)) ){
drh6f82e852015-06-06 20:12:09 +00001930 SWAP(WhereTerm *, pRangeEnd, pRangeStart);
1931 SWAP(u8, bSeekPastNull, bStopAtNull);
dan71c57db2016-07-09 20:23:55 +00001932 SWAP(u8, nBtm, nTop);
drh6f82e852015-06-06 20:12:09 +00001933 }
1934
dandf1b52e2021-01-27 17:15:06 +00001935 if( iLevel>0 && (pLoop->wsFlags & WHERE_IN_SEEKSCAN)!=0 ){
1936 /* In case OP_SeekScan is used, ensure that the index cursor does not
1937 ** point to a valid row for the first iteration of this loop. */
1938 sqlite3VdbeAddOp1(v, OP_NullRow, iIdxCur);
1939 }
1940
drhbcf40a72015-08-18 15:58:05 +00001941 /* Generate code to evaluate all constraint terms using == or IN
1942 ** and store the values of those terms in an array of registers
1943 ** starting at regBase.
1944 */
danb324cf72016-06-17 14:33:32 +00001945 codeCursorHint(pTabItem, pWInfo, pLevel, pRangeEnd);
drhbcf40a72015-08-18 15:58:05 +00001946 regBase = codeAllEqualityTerms(pParse,pLevel,bRev,nExtraReg,&zStartAff);
1947 assert( zStartAff==0 || sqlite3Strlen30(zStartAff)>=nEq );
danb7ca2172016-08-26 17:54:46 +00001948 if( zStartAff && nTop ){
1949 zEndAff = sqlite3DbStrDup(db, &zStartAff[nEq]);
1950 }
dancc491f42019-08-17 17:55:54 +00001951 addrNxt = (regBignull ? pLevel->addrBignull : pLevel->addrNxt);
drhbcf40a72015-08-18 15:58:05 +00001952
drh6f82e852015-06-06 20:12:09 +00001953 testcase( pRangeStart && (pRangeStart->eOperator & WO_LE)!=0 );
1954 testcase( pRangeStart && (pRangeStart->eOperator & WO_GE)!=0 );
1955 testcase( pRangeEnd && (pRangeEnd->eOperator & WO_LE)!=0 );
1956 testcase( pRangeEnd && (pRangeEnd->eOperator & WO_GE)!=0 );
1957 startEq = !pRangeStart || pRangeStart->eOperator & (WO_LE|WO_GE);
1958 endEq = !pRangeEnd || pRangeEnd->eOperator & (WO_LE|WO_GE);
1959 start_constraints = pRangeStart || nEq>0;
1960
1961 /* Seek the index cursor to the start of the range. */
1962 nConstraint = nEq;
1963 if( pRangeStart ){
1964 Expr *pRight = pRangeStart->pExpr->pRight;
dan71c57db2016-07-09 20:23:55 +00001965 codeExprOrVector(pParse, pRight, regBase+nEq, nBtm);
drh6f82e852015-06-06 20:12:09 +00001966 whereLikeOptimizationStringFixup(v, pLevel, pRangeStart);
drh395a60d2020-09-30 17:32:22 +00001967 if( (pRangeStart->wtFlags & TERM_VNULL)==0
drh6f82e852015-06-06 20:12:09 +00001968 && sqlite3ExprCanBeNull(pRight)
1969 ){
1970 sqlite3VdbeAddOp2(v, OP_IsNull, regBase+nEq, addrNxt);
1971 VdbeCoverage(v);
1972 }
1973 if( zStartAff ){
drhe3c6b612016-10-05 20:10:32 +00001974 updateRangeAffinityStr(pRight, nBtm, &zStartAff[nEq]);
drh6f82e852015-06-06 20:12:09 +00001975 }
dan71c57db2016-07-09 20:23:55 +00001976 nConstraint += nBtm;
drh6f82e852015-06-06 20:12:09 +00001977 testcase( pRangeStart->wtFlags & TERM_VIRTUAL );
dan625015e2016-07-30 16:39:28 +00001978 if( sqlite3ExprIsVector(pRight)==0 ){
dan71c57db2016-07-09 20:23:55 +00001979 disableTerm(pLevel, pRangeStart);
1980 }else{
1981 startEq = 1;
1982 }
drh426f4ab2016-07-26 04:31:14 +00001983 bSeekPastNull = 0;
drh6f82e852015-06-06 20:12:09 +00001984 }else if( bSeekPastNull ){
drh6f82e852015-06-06 20:12:09 +00001985 startEq = 0;
drh0086e072019-08-23 16:12:20 +00001986 sqlite3VdbeAddOp2(v, OP_Null, 0, regBase+nEq);
drh6f82e852015-06-06 20:12:09 +00001987 start_constraints = 1;
drh0086e072019-08-23 16:12:20 +00001988 nConstraint++;
dan15750a22019-08-16 21:07:19 +00001989 }else if( regBignull ){
1990 sqlite3VdbeAddOp2(v, OP_Null, 0, regBase+nEq);
1991 start_constraints = 1;
1992 nConstraint++;
drh6f82e852015-06-06 20:12:09 +00001993 }
1994 codeApplyAffinity(pParse, regBase, nConstraint - bSeekPastNull, zStartAff);
drh0bf2ad62016-02-22 21:19:54 +00001995 if( pLoop->nSkip>0 && nConstraint==pLoop->nSkip ){
1996 /* The skip-scan logic inside the call to codeAllEqualityConstraints()
1997 ** above has already left the cursor sitting on the correct row,
1998 ** so no further seeking is needed */
1999 }else{
dan15750a22019-08-16 21:07:19 +00002000 if( regBignull ){
drhec3dda52019-08-23 13:32:03 +00002001 sqlite3VdbeAddOp2(v, OP_Integer, 1, regBignull);
drha31d3552019-08-23 17:09:02 +00002002 VdbeComment((v, "NULL-scan pass ctr"));
dan15750a22019-08-16 21:07:19 +00002003 }
drh2db144c2021-12-01 16:31:02 +00002004 if( pLevel->regFilter ){
2005 sqlite3VdbeAddOp4Int(v, OP_Filter, pLevel->regFilter, addrNxt,
drh770dade2021-12-04 14:24:30 +00002006 regBase, nEq);
drh067c60c2021-12-04 18:45:08 +00002007 VdbeCoverage(v);
drh35685d32021-12-05 00:45:55 +00002008 filterPullDown(pParse, pWInfo, iLevel, addrNxt, notReady);
drh2db144c2021-12-01 16:31:02 +00002009 }
dan15750a22019-08-16 21:07:19 +00002010
drha6d2f8e2016-02-22 20:52:26 +00002011 op = aStartOp[(start_constraints<<2) + (startEq<<1) + bRev];
2012 assert( op!=0 );
drh7d14ffe2020-10-02 13:48:57 +00002013 if( (pLoop->wsFlags & WHERE_IN_SEEKSCAN)!=0 && op==OP_SeekGE ){
drh68cf0ac2020-09-28 19:51:54 +00002014 assert( regBignull==0 );
drh4f65b3b2020-09-30 18:03:22 +00002015 /* TUNING: The OP_SeekScan opcode seeks to reduce the number
2016 ** of expensive seek operations by replacing a single seek with
2017 ** 1 or more step operations. The question is, how many steps
2018 ** should we try before giving up and going with a seek. The cost
2019 ** of a seek is proportional to the logarithm of the of the number
2020 ** of entries in the tree, so basing the number of steps to try
2021 ** on the estimated number of rows in the btree seems like a good
2022 ** guess. */
drh04e70ce2020-10-02 11:55:07 +00002023 addrSeekScan = sqlite3VdbeAddOp1(v, OP_SeekScan,
2024 (pIdx->aiRowLogEst[0]+9)/10);
drh4f65b3b2020-09-30 18:03:22 +00002025 VdbeCoverage(v);
drh68cf0ac2020-09-28 19:51:54 +00002026 }
drha6d2f8e2016-02-22 20:52:26 +00002027 sqlite3VdbeAddOp4Int(v, op, iIdxCur, addrNxt, regBase, nConstraint);
2028 VdbeCoverage(v);
2029 VdbeCoverageIf(v, op==OP_Rewind); testcase( op==OP_Rewind );
2030 VdbeCoverageIf(v, op==OP_Last); testcase( op==OP_Last );
2031 VdbeCoverageIf(v, op==OP_SeekGT); testcase( op==OP_SeekGT );
2032 VdbeCoverageIf(v, op==OP_SeekGE); testcase( op==OP_SeekGE );
2033 VdbeCoverageIf(v, op==OP_SeekLE); testcase( op==OP_SeekLE );
2034 VdbeCoverageIf(v, op==OP_SeekLT); testcase( op==OP_SeekLT );
danddd74212019-08-02 18:43:59 +00002035
drh0086e072019-08-23 16:12:20 +00002036 assert( bSeekPastNull==0 || bStopAtNull==0 );
dan15750a22019-08-16 21:07:19 +00002037 if( regBignull ){
drh0086e072019-08-23 16:12:20 +00002038 assert( bSeekPastNull==1 || bStopAtNull==1 );
drh5f6a4ea2019-08-23 17:00:22 +00002039 assert( bSeekPastNull==!bStopAtNull );
drh0086e072019-08-23 16:12:20 +00002040 assert( bStopAtNull==startEq );
danddd74212019-08-02 18:43:59 +00002041 sqlite3VdbeAddOp2(v, OP_Goto, 0, sqlite3VdbeCurrentAddr(v)+2);
drh0086e072019-08-23 16:12:20 +00002042 op = aStartOp[(nConstraint>1)*4 + 2 + bRev];
2043 sqlite3VdbeAddOp4Int(v, op, iIdxCur, addrNxt, regBase,
2044 nConstraint-startEq);
2045 VdbeCoverage(v);
2046 VdbeCoverageIf(v, op==OP_Rewind); testcase( op==OP_Rewind );
2047 VdbeCoverageIf(v, op==OP_Last); testcase( op==OP_Last );
2048 VdbeCoverageIf(v, op==OP_SeekGE); testcase( op==OP_SeekGE );
2049 VdbeCoverageIf(v, op==OP_SeekLE); testcase( op==OP_SeekLE );
2050 assert( op==OP_Rewind || op==OP_Last || op==OP_SeekGE || op==OP_SeekLE);
danddd74212019-08-02 18:43:59 +00002051 }
drha6d2f8e2016-02-22 20:52:26 +00002052 }
drh0bf2ad62016-02-22 21:19:54 +00002053
drh6f82e852015-06-06 20:12:09 +00002054 /* Load the value for the inequality constraint at the end of the
2055 ** range (if any).
2056 */
2057 nConstraint = nEq;
drh5d742e32021-11-02 20:52:20 +00002058 assert( pLevel->p2==0 );
drh6f82e852015-06-06 20:12:09 +00002059 if( pRangeEnd ){
2060 Expr *pRight = pRangeEnd->pExpr->pRight;
drh5d742e32021-11-02 20:52:20 +00002061 if( addrSeekScan ){
2062 /* For a seek-scan that has a range on the lowest term of the index,
2063 ** we have to make the top of the loop be code that sets the end
2064 ** condition of the range. Otherwise, the OP_SeekScan might jump
2065 ** over that initialization, leaving the range-end value set to the
2066 ** range-start value, resulting in a wrong answer.
2067 ** See ticket 5981a8c041a3c2f3 (2021-11-02).
2068 */
2069 pLevel->p2 = sqlite3VdbeCurrentAddr(v);
2070 }
dan71c57db2016-07-09 20:23:55 +00002071 codeExprOrVector(pParse, pRight, regBase+nEq, nTop);
drh6f82e852015-06-06 20:12:09 +00002072 whereLikeOptimizationStringFixup(v, pLevel, pRangeEnd);
drh395a60d2020-09-30 17:32:22 +00002073 if( (pRangeEnd->wtFlags & TERM_VNULL)==0
drh6f82e852015-06-06 20:12:09 +00002074 && sqlite3ExprCanBeNull(pRight)
2075 ){
2076 sqlite3VdbeAddOp2(v, OP_IsNull, regBase+nEq, addrNxt);
2077 VdbeCoverage(v);
2078 }
drh0c36fca2016-08-26 18:17:08 +00002079 if( zEndAff ){
drhe3c6b612016-10-05 20:10:32 +00002080 updateRangeAffinityStr(pRight, nTop, zEndAff);
drh0c36fca2016-08-26 18:17:08 +00002081 codeApplyAffinity(pParse, regBase+nEq, nTop, zEndAff);
2082 }else{
2083 assert( pParse->db->mallocFailed );
2084 }
dan71c57db2016-07-09 20:23:55 +00002085 nConstraint += nTop;
drh6f82e852015-06-06 20:12:09 +00002086 testcase( pRangeEnd->wtFlags & TERM_VIRTUAL );
dan71c57db2016-07-09 20:23:55 +00002087
dan625015e2016-07-30 16:39:28 +00002088 if( sqlite3ExprIsVector(pRight)==0 ){
dan71c57db2016-07-09 20:23:55 +00002089 disableTerm(pLevel, pRangeEnd);
2090 }else{
2091 endEq = 1;
2092 }
drh6f82e852015-06-06 20:12:09 +00002093 }else if( bStopAtNull ){
dan15750a22019-08-16 21:07:19 +00002094 if( regBignull==0 ){
2095 sqlite3VdbeAddOp2(v, OP_Null, 0, regBase+nEq);
2096 endEq = 0;
2097 }
drh6f82e852015-06-06 20:12:09 +00002098 nConstraint++;
2099 }
2100 sqlite3DbFree(db, zStartAff);
danb7ca2172016-08-26 17:54:46 +00002101 sqlite3DbFree(db, zEndAff);
drh6f82e852015-06-06 20:12:09 +00002102
2103 /* Top of the loop body */
drh5d742e32021-11-02 20:52:20 +00002104 if( pLevel->p2==0 ) pLevel->p2 = sqlite3VdbeCurrentAddr(v);
drh6f82e852015-06-06 20:12:09 +00002105
2106 /* Check if the index cursor is past the end of the range. */
2107 if( nConstraint ){
dan15750a22019-08-16 21:07:19 +00002108 if( regBignull ){
drh5f6a4ea2019-08-23 17:00:22 +00002109 /* Except, skip the end-of-range check while doing the NULL-scan */
drhec3dda52019-08-23 13:32:03 +00002110 sqlite3VdbeAddOp2(v, OP_IfNot, regBignull, sqlite3VdbeCurrentAddr(v)+3);
drha31d3552019-08-23 17:09:02 +00002111 VdbeComment((v, "If NULL-scan 2nd pass"));
drh505ae9d2019-08-22 21:13:56 +00002112 VdbeCoverage(v);
dan15750a22019-08-16 21:07:19 +00002113 }
drh6f82e852015-06-06 20:12:09 +00002114 op = aEndOp[bRev*2 + endEq];
2115 sqlite3VdbeAddOp4Int(v, op, iIdxCur, addrNxt, regBase, nConstraint);
2116 testcase( op==OP_IdxGT ); VdbeCoverageIf(v, op==OP_IdxGT );
2117 testcase( op==OP_IdxGE ); VdbeCoverageIf(v, op==OP_IdxGE );
2118 testcase( op==OP_IdxLT ); VdbeCoverageIf(v, op==OP_IdxLT );
2119 testcase( op==OP_IdxLE ); VdbeCoverageIf(v, op==OP_IdxLE );
drh04e70ce2020-10-02 11:55:07 +00002120 if( addrSeekScan ) sqlite3VdbeJumpHere(v, addrSeekScan);
drh6f82e852015-06-06 20:12:09 +00002121 }
dan15750a22019-08-16 21:07:19 +00002122 if( regBignull ){
drh5f6a4ea2019-08-23 17:00:22 +00002123 /* During a NULL-scan, check to see if we have reached the end of
2124 ** the NULLs */
2125 assert( bSeekPastNull==!bStopAtNull );
2126 assert( bSeekPastNull+bStopAtNull==1 );
2127 assert( nConstraint+bSeekPastNull>0 );
drhec3dda52019-08-23 13:32:03 +00002128 sqlite3VdbeAddOp2(v, OP_If, regBignull, sqlite3VdbeCurrentAddr(v)+2);
drha31d3552019-08-23 17:09:02 +00002129 VdbeComment((v, "If NULL-scan 1st pass"));
drh505ae9d2019-08-22 21:13:56 +00002130 VdbeCoverage(v);
drh5f6a4ea2019-08-23 17:00:22 +00002131 op = aEndOp[bRev*2 + bSeekPastNull];
2132 sqlite3VdbeAddOp4Int(v, op, iIdxCur, addrNxt, regBase,
2133 nConstraint+bSeekPastNull);
2134 testcase( op==OP_IdxGT ); VdbeCoverageIf(v, op==OP_IdxGT );
2135 testcase( op==OP_IdxGE ); VdbeCoverageIf(v, op==OP_IdxGE );
2136 testcase( op==OP_IdxLT ); VdbeCoverageIf(v, op==OP_IdxLT );
2137 testcase( op==OP_IdxLE ); VdbeCoverageIf(v, op==OP_IdxLE );
dan15750a22019-08-16 21:07:19 +00002138 }
drh6f82e852015-06-06 20:12:09 +00002139
drhf761d932020-09-29 01:48:46 +00002140 if( (pLoop->wsFlags & WHERE_IN_EARLYOUT)!=0 ){
drhfa17e132020-09-01 01:52:03 +00002141 sqlite3VdbeAddOp3(v, OP_SeekHit, iIdxCur, nEq, nEq);
drh8c2b6d72018-06-05 20:45:20 +00002142 }
2143
drh6f82e852015-06-06 20:12:09 +00002144 /* Seek the table cursor, if required */
drh47df8a22018-12-25 00:15:37 +00002145 omitTable = (pLoop->wsFlags & WHERE_IDX_ONLY)!=0
drhc5837192022-04-11 14:26:37 +00002146 && (pWInfo->wctrlFlags & (WHERE_OR_SUBCLAUSE|WHERE_RIGHT_JOIN))==0;
drh6f82e852015-06-06 20:12:09 +00002147 if( omitTable ){
2148 /* pIdx is a covering index. No need to access the main table. */
2149 }else if( HasRowid(pIdx->pTable) ){
drh68c0c712020-08-14 20:04:26 +00002150 codeDeferredSeek(pWInfo, pIdx, iCur, iIdxCur);
drh6f82e852015-06-06 20:12:09 +00002151 }else if( iCur!=iIdxCur ){
2152 Index *pPk = sqlite3PrimaryKeyIndex(pIdx->pTable);
2153 iRowidReg = sqlite3GetTempRange(pParse, pPk->nKeyCol);
2154 for(j=0; j<pPk->nKeyCol; j++){
drhb9bcf7c2019-10-19 13:29:10 +00002155 k = sqlite3TableColumnToIndex(pIdx, pPk->aiColumn[j]);
drh6f82e852015-06-06 20:12:09 +00002156 sqlite3VdbeAddOp3(v, OP_Column, iIdxCur, k, iRowidReg+j);
2157 }
2158 sqlite3VdbeAddOp4Int(v, OP_NotFound, iCur, addrCont,
2159 iRowidReg, pPk->nKeyCol); VdbeCoverage(v);
2160 }
2161
drhdb535392019-11-03 00:07:41 +00002162 if( pLevel->iLeftJoin==0 ){
2163 /* If pIdx is an index on one or more expressions, then look through
2164 ** all the expressions in pWInfo and try to transform matching expressions
2165 ** into reference to index columns. Also attempt to translate references
2166 ** to virtual columns in the table into references to (stored) columns
2167 ** of the index.
2168 **
2169 ** Do not do this for the RHS of a LEFT JOIN. This is because the
2170 ** expression may be evaluated after OP_NullRow has been executed on
2171 ** the cursor. In this case it is important to do the full evaluation,
2172 ** as the result of the expression may not be NULL, even if all table
2173 ** column values are. https://www.sqlite.org/src/info/7fa8049685b50b5a
2174 **
2175 ** Also, do not do this when processing one index an a multi-index
2176 ** OR clause, since the transformation will become invalid once we
2177 ** move forward to the next index.
2178 ** https://sqlite.org/src/info/4e8e4857d32d401f
2179 */
drhc5837192022-04-11 14:26:37 +00002180 if( (pWInfo->wctrlFlags & (WHERE_OR_SUBCLAUSE|WHERE_RIGHT_JOIN))==0 ){
drhdb535392019-11-03 00:07:41 +00002181 whereIndexExprTrans(pIdx, iCur, iIdxCur, pWInfo);
2182 }
2183
2184 /* If a partial index is driving the loop, try to eliminate WHERE clause
2185 ** terms from the query that must be true due to the WHERE clause of
2186 ** the partial index.
2187 **
2188 ** 2019-11-02 ticket 623eff57e76d45f6: This optimization does not work
2189 ** for a LEFT JOIN.
2190 */
2191 if( pIdx->pPartIdxWhere ){
2192 whereApplyPartialIndexConstraints(pIdx->pPartIdxWhere, iCur, pWC);
2193 }
2194 }else{
drhdb535392019-11-03 00:07:41 +00002195 testcase( pIdx->pPartIdxWhere );
drh06fc2452019-11-04 12:49:15 +00002196 /* The following assert() is not a requirement, merely an observation:
2197 ** The OR-optimization doesn't work for the right hand table of
2198 ** a LEFT JOIN: */
drhc5837192022-04-11 14:26:37 +00002199 assert( (pWInfo->wctrlFlags & (WHERE_OR_SUBCLAUSE|WHERE_RIGHT_JOIN))==0 );
dan4da04f72018-04-24 14:05:14 +00002200 }
drhdb535392019-11-03 00:07:41 +00002201
dan71c57db2016-07-09 20:23:55 +00002202 /* Record the instruction used to terminate the loop. */
drh6f82e852015-06-06 20:12:09 +00002203 if( pLoop->wsFlags & WHERE_ONEROW ){
2204 pLevel->op = OP_Noop;
2205 }else if( bRev ){
2206 pLevel->op = OP_Prev;
2207 }else{
2208 pLevel->op = OP_Next;
2209 }
2210 pLevel->p1 = iIdxCur;
2211 pLevel->p3 = (pLoop->wsFlags&WHERE_UNQ_WANTED)!=0 ? 1:0;
2212 if( (pLoop->wsFlags & WHERE_CONSTRAINT)==0 ){
2213 pLevel->p5 = SQLITE_STMTSTATUS_FULLSCAN_STEP;
2214 }else{
2215 assert( pLevel->p5==0 );
2216 }
dan6f654a42017-04-28 19:59:55 +00002217 if( omitTable ) pIdx = 0;
drh6f82e852015-06-06 20:12:09 +00002218 }else
2219
2220#ifndef SQLITE_OMIT_OR_OPTIMIZATION
2221 if( pLoop->wsFlags & WHERE_MULTI_OR ){
2222 /* Case 5: Two or more separately indexed terms connected by OR
2223 **
2224 ** Example:
2225 **
2226 ** CREATE TABLE t1(a,b,c,d);
2227 ** CREATE INDEX i1 ON t1(a);
2228 ** CREATE INDEX i2 ON t1(b);
2229 ** CREATE INDEX i3 ON t1(c);
2230 **
2231 ** SELECT * FROM t1 WHERE a=5 OR b=7 OR (c=11 AND d=13)
2232 **
2233 ** In the example, there are three indexed terms connected by OR.
2234 ** The top of the loop looks like this:
2235 **
2236 ** Null 1 # Zero the rowset in reg 1
2237 **
2238 ** Then, for each indexed term, the following. The arguments to
2239 ** RowSetTest are such that the rowid of the current row is inserted
2240 ** into the RowSet. If it is already present, control skips the
2241 ** Gosub opcode and jumps straight to the code generated by WhereEnd().
2242 **
2243 ** sqlite3WhereBegin(<term>)
2244 ** RowSetTest # Insert rowid into rowset
2245 ** Gosub 2 A
2246 ** sqlite3WhereEnd()
2247 **
2248 ** Following the above, code to terminate the loop. Label A, the target
2249 ** of the Gosub above, jumps to the instruction right after the Goto.
2250 **
2251 ** Null 1 # Zero the rowset in reg 1
2252 ** Goto B # The loop is finished.
2253 **
2254 ** A: <loop body> # Return data, whatever.
2255 **
2256 ** Return 2 # Jump back to the Gosub
2257 **
2258 ** B: <after the loop>
2259 **
2260 ** Added 2014-05-26: If the table is a WITHOUT ROWID table, then
2261 ** use an ephemeral index instead of a RowSet to record the primary
2262 ** keys of the rows we have already seen.
2263 **
2264 */
2265 WhereClause *pOrWc; /* The OR-clause broken out into subterms */
2266 SrcList *pOrTab; /* Shortened table list or OR-clause generation */
2267 Index *pCov = 0; /* Potential covering index (or NULL) */
2268 int iCovCur = pParse->nTab++; /* Cursor used for index scans (if any) */
2269
2270 int regReturn = ++pParse->nMem; /* Register used with OP_Gosub */
2271 int regRowset = 0; /* Register for RowSet object */
2272 int regRowid = 0; /* Register holding rowid */
drhec4ccdb2018-12-29 02:26:59 +00002273 int iLoopBody = sqlite3VdbeMakeLabel(pParse);/* Start of loop body */
drh6f82e852015-06-06 20:12:09 +00002274 int iRetInit; /* Address of regReturn init */
2275 int untestedTerms = 0; /* Some terms not completely tested */
2276 int ii; /* Loop counter */
drh6f82e852015-06-06 20:12:09 +00002277 Expr *pAndExpr = 0; /* An ".. AND (...)" expression */
2278 Table *pTab = pTabItem->pTab;
dan145b4ea2016-07-29 18:12:12 +00002279
drh6f82e852015-06-06 20:12:09 +00002280 pTerm = pLoop->aLTerm[0];
2281 assert( pTerm!=0 );
2282 assert( pTerm->eOperator & WO_OR );
2283 assert( (pTerm->wtFlags & TERM_ORINFO)!=0 );
2284 pOrWc = &pTerm->u.pOrInfo->wc;
2285 pLevel->op = OP_Return;
2286 pLevel->p1 = regReturn;
2287
2288 /* Set up a new SrcList in pOrTab containing the table being scanned
2289 ** by this loop in the a[0] slot and all notReady tables in a[1..] slots.
2290 ** This becomes the SrcList in the recursive call to sqlite3WhereBegin().
2291 */
2292 if( pWInfo->nLevel>1 ){
2293 int nNotReady; /* The number of notReady tables */
drh76012942021-02-21 21:04:54 +00002294 SrcItem *origSrc; /* Original list of tables */
drh6f82e852015-06-06 20:12:09 +00002295 nNotReady = pWInfo->nLevel - iLevel - 1;
2296 pOrTab = sqlite3StackAllocRaw(db,
2297 sizeof(*pOrTab)+ nNotReady*sizeof(pOrTab->a[0]));
2298 if( pOrTab==0 ) return notReady;
2299 pOrTab->nAlloc = (u8)(nNotReady + 1);
2300 pOrTab->nSrc = pOrTab->nAlloc;
2301 memcpy(pOrTab->a, pTabItem, sizeof(*pTabItem));
2302 origSrc = pWInfo->pTabList->a;
2303 for(k=1; k<=nNotReady; k++){
2304 memcpy(&pOrTab->a[k], &origSrc[pLevel[k].iFrom], sizeof(pOrTab->a[k]));
2305 }
2306 }else{
2307 pOrTab = pWInfo->pTabList;
2308 }
2309
2310 /* Initialize the rowset register to contain NULL. An SQL NULL is
2311 ** equivalent to an empty rowset. Or, create an ephemeral index
2312 ** capable of holding primary keys in the case of a WITHOUT ROWID.
2313 **
2314 ** Also initialize regReturn to contain the address of the instruction
2315 ** immediately following the OP_Return at the bottom of the loop. This
2316 ** is required in a few obscure LEFT JOIN cases where control jumps
2317 ** over the top of the loop into the body of it. In this case the
2318 ** correct response for the end-of-loop code (the OP_Return) is to
2319 ** fall through to the next instruction, just as an OP_Next does if
2320 ** called on an uninitialized cursor.
2321 */
2322 if( (pWInfo->wctrlFlags & WHERE_DUPLICATES_OK)==0 ){
2323 if( HasRowid(pTab) ){
2324 regRowset = ++pParse->nMem;
2325 sqlite3VdbeAddOp2(v, OP_Null, 0, regRowset);
2326 }else{
2327 Index *pPk = sqlite3PrimaryKeyIndex(pTab);
2328 regRowset = pParse->nTab++;
2329 sqlite3VdbeAddOp2(v, OP_OpenEphemeral, regRowset, pPk->nKeyCol);
2330 sqlite3VdbeSetP4KeyInfo(pParse, pPk);
2331 }
2332 regRowid = ++pParse->nMem;
2333 }
2334 iRetInit = sqlite3VdbeAddOp2(v, OP_Integer, 0, regReturn);
2335
2336 /* If the original WHERE clause is z of the form: (x1 OR x2 OR ...) AND y
drh02e3e042022-02-04 13:05:29 +00002337 ** Then for every term xN, evaluate as the subexpression: xN AND y
drh6f82e852015-06-06 20:12:09 +00002338 ** That way, terms in y that are factored into the disjunction will
2339 ** be picked up by the recursive calls to sqlite3WhereBegin() below.
2340 **
2341 ** Actually, each subexpression is converted to "xN AND w" where w is
2342 ** the "interesting" terms of z - terms that did not originate in the
2343 ** ON or USING clause of a LEFT JOIN, and terms that are usable as
2344 ** indices.
2345 **
2346 ** This optimization also only applies if the (x1 OR x2 OR ...) term
2347 ** is not contained in the ON clause of a LEFT JOIN.
2348 ** See ticket http://www.sqlite.org/src/info/f2369304e4
drh02e3e042022-02-04 13:05:29 +00002349 **
2350 ** 2022-02-04: Do not push down slices of a row-value comparison.
2351 ** In other words, "w" or "y" may not be a slice of a vector. Otherwise,
2352 ** the initialization of the right-hand operand of the vector comparison
2353 ** might not occur, or might occur only in an OR branch that is not
2354 ** taken. dbsqlfuzz 80a9fade844b4fb43564efc972bcb2c68270f5d1.
drhc9bcc5a2022-03-03 15:59:22 +00002355 **
2356 ** 2022-03-03: Do not push down expressions that involve subqueries.
2357 ** The subquery might get coded as a subroutine. Any table-references
2358 ** in the subquery might be resolved to index-references for the index on
2359 ** the OR branch in which the subroutine is coded. But if the subroutine
2360 ** is invoked from a different OR branch that uses a different index, such
2361 ** index-references will not work. tag-20220303a
2362 ** https://sqlite.org/forum/forumpost/36937b197273d403
drh6f82e852015-06-06 20:12:09 +00002363 */
2364 if( pWC->nTerm>1 ){
2365 int iTerm;
2366 for(iTerm=0; iTerm<pWC->nTerm; iTerm++){
2367 Expr *pExpr = pWC->a[iTerm].pExpr;
2368 if( &pWC->a[iTerm] == pTerm ) continue;
drh3b83f0c2016-01-29 16:57:06 +00002369 testcase( pWC->a[iTerm].wtFlags & TERM_VIRTUAL );
2370 testcase( pWC->a[iTerm].wtFlags & TERM_CODED );
drh02e3e042022-02-04 13:05:29 +00002371 testcase( pWC->a[iTerm].wtFlags & TERM_SLICE );
2372 if( (pWC->a[iTerm].wtFlags & (TERM_VIRTUAL|TERM_CODED|TERM_SLICE))!=0 ){
2373 continue;
2374 }
drh07559b22022-03-03 19:40:21 +00002375 if( (pWC->a[iTerm].eOperator & WO_ALL)==0 ) continue;
drhc9bcc5a2022-03-03 15:59:22 +00002376 if( ExprHasProperty(pExpr, EP_Subquery) ) continue; /* tag-20220303a */
drh6f82e852015-06-06 20:12:09 +00002377 pExpr = sqlite3ExprDup(db, pExpr, 0);
drhd5c851c2019-04-19 13:38:34 +00002378 pAndExpr = sqlite3ExprAnd(pParse, pAndExpr, pExpr);
drh6f82e852015-06-06 20:12:09 +00002379 }
2380 if( pAndExpr ){
drhf1722ba2019-04-05 20:56:46 +00002381 /* The extra 0x10000 bit on the opcode is masked off and does not
2382 ** become part of the new Expr.op. However, it does make the
2383 ** op==TK_AND comparison inside of sqlite3PExpr() false, and this
drh93ffb502021-05-18 19:10:10 +00002384 ** prevents sqlite3PExpr() from applying the AND short-circuit
drhf1722ba2019-04-05 20:56:46 +00002385 ** optimization, which we do not want here. */
2386 pAndExpr = sqlite3PExpr(pParse, TK_AND|0x10000, 0, pAndExpr);
drh6f82e852015-06-06 20:12:09 +00002387 }
2388 }
2389
2390 /* Run a separate WHERE clause for each term of the OR clause. After
2391 ** eliminating duplicates from other WHERE clauses, the action for each
2392 ** sub-WHERE clause is to to invoke the main loop body as a subroutine.
2393 */
drh5d72d922018-05-04 00:39:43 +00002394 ExplainQueryPlan((pParse, 1, "MULTI-INDEX OR"));
drh6f82e852015-06-06 20:12:09 +00002395 for(ii=0; ii<pOrWc->nTerm; ii++){
2396 WhereTerm *pOrTerm = &pOrWc->a[ii];
2397 if( pOrTerm->leftCursor==iCur || (pOrTerm->eOperator & WO_AND)!=0 ){
2398 WhereInfo *pSubWInfo; /* Info for single OR-term scan */
2399 Expr *pOrExpr = pOrTerm->pExpr; /* Current OR clause term */
drh93ffb502021-05-18 19:10:10 +00002400 Expr *pDelete; /* Local copy of OR clause term */
drh728e0f92015-10-10 14:41:28 +00002401 int jmp1 = 0; /* Address of jump operation */
drh3b8eb082020-01-12 22:38:17 +00002402 testcase( (pTabItem[0].fg.jointype & JT_LEFT)!=0
2403 && !ExprHasProperty(pOrExpr, EP_FromJoin)
2404 ); /* See TH3 vtab25.400 and ticket 614b25314c766238 */
drh93ffb502021-05-18 19:10:10 +00002405 pDelete = pOrExpr = sqlite3ExprDup(db, pOrExpr, 0);
2406 if( db->mallocFailed ){
2407 sqlite3ExprDelete(db, pDelete);
2408 continue;
2409 }
dan820fcd22018-04-24 18:53:24 +00002410 if( pAndExpr ){
drh6f82e852015-06-06 20:12:09 +00002411 pAndExpr->pLeft = pOrExpr;
2412 pOrExpr = pAndExpr;
2413 }
2414 /* Loop through table entries that match term pOrTerm. */
drhbd462bc2018-12-24 20:21:06 +00002415 ExplainQueryPlan((pParse, 1, "INDEX %d", ii+1));
drh6f82e852015-06-06 20:12:09 +00002416 WHERETRACE(0xffff, ("Subplan for OR-clause:\n"));
drh895bab32022-01-27 16:14:50 +00002417 pSubWInfo = sqlite3WhereBegin(pParse, pOrTab, pOrExpr, 0, 0, 0,
drh68c0c712020-08-14 20:04:26 +00002418 WHERE_OR_SUBCLAUSE, iCovCur);
drh0c7d3d32022-01-24 16:47:12 +00002419 assert( pSubWInfo || pParse->nErr );
drh6f82e852015-06-06 20:12:09 +00002420 if( pSubWInfo ){
2421 WhereLoop *pSubLoop;
2422 int addrExplain = sqlite3WhereExplainOneScan(
drhe2188f02018-05-07 11:37:34 +00002423 pParse, pOrTab, &pSubWInfo->a[0], 0
drh6f82e852015-06-06 20:12:09 +00002424 );
2425 sqlite3WhereAddScanStatus(v, pOrTab, &pSubWInfo->a[0], addrExplain);
2426
2427 /* This is the sub-WHERE clause body. First skip over
2428 ** duplicate rows from prior sub-WHERE clauses, and record the
2429 ** rowid (or PRIMARY KEY) for the current row so that the same
2430 ** row will be skipped in subsequent sub-WHERE clauses.
2431 */
2432 if( (pWInfo->wctrlFlags & WHERE_DUPLICATES_OK)==0 ){
drh6f82e852015-06-06 20:12:09 +00002433 int iSet = ((ii==pOrWc->nTerm-1)?-1:ii);
2434 if( HasRowid(pTab) ){
drh6df9c4b2019-10-18 12:52:08 +00002435 sqlite3ExprCodeGetColumnOfTable(v, pTab, iCur, -1, regRowid);
drh728e0f92015-10-10 14:41:28 +00002436 jmp1 = sqlite3VdbeAddOp4Int(v, OP_RowSetTest, regRowset, 0,
drh8c607192018-08-04 15:53:55 +00002437 regRowid, iSet);
drh6f82e852015-06-06 20:12:09 +00002438 VdbeCoverage(v);
2439 }else{
2440 Index *pPk = sqlite3PrimaryKeyIndex(pTab);
2441 int nPk = pPk->nKeyCol;
2442 int iPk;
drh8c607192018-08-04 15:53:55 +00002443 int r;
drh6f82e852015-06-06 20:12:09 +00002444
2445 /* Read the PK into an array of temp registers. */
2446 r = sqlite3GetTempRange(pParse, nPk);
2447 for(iPk=0; iPk<nPk; iPk++){
2448 int iCol = pPk->aiColumn[iPk];
drh6df9c4b2019-10-18 12:52:08 +00002449 sqlite3ExprCodeGetColumnOfTable(v, pTab, iCur, iCol,r+iPk);
drh6f82e852015-06-06 20:12:09 +00002450 }
2451
2452 /* Check if the temp table already contains this key. If so,
2453 ** the row has already been included in the result set and
2454 ** can be ignored (by jumping past the Gosub below). Otherwise,
2455 ** insert the key into the temp table and proceed with processing
2456 ** the row.
2457 **
2458 ** Use some of the same optimizations as OP_RowSetTest: If iSet
2459 ** is zero, assume that the key cannot already be present in
2460 ** the temp table. And if iSet is -1, assume that there is no
2461 ** need to insert the key into the temp table, as it will never
2462 ** be tested for. */
2463 if( iSet ){
drh728e0f92015-10-10 14:41:28 +00002464 jmp1 = sqlite3VdbeAddOp4Int(v, OP_Found, regRowset, 0, r, nPk);
drh6f82e852015-06-06 20:12:09 +00002465 VdbeCoverage(v);
2466 }
2467 if( iSet>=0 ){
2468 sqlite3VdbeAddOp3(v, OP_MakeRecord, r, nPk, regRowid);
drh9b4eaeb2016-11-09 00:10:33 +00002469 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, regRowset, regRowid,
2470 r, nPk);
drh6f82e852015-06-06 20:12:09 +00002471 if( iSet ) sqlite3VdbeChangeP5(v, OPFLAG_USESEEKRESULT);
2472 }
2473
2474 /* Release the array of temp registers */
2475 sqlite3ReleaseTempRange(pParse, r, nPk);
2476 }
2477 }
2478
2479 /* Invoke the main loop body as a subroutine */
2480 sqlite3VdbeAddOp2(v, OP_Gosub, regReturn, iLoopBody);
2481
2482 /* Jump here (skipping the main loop body subroutine) if the
2483 ** current sub-WHERE row is a duplicate from prior sub-WHEREs. */
drh728e0f92015-10-10 14:41:28 +00002484 if( jmp1 ) sqlite3VdbeJumpHere(v, jmp1);
drh6f82e852015-06-06 20:12:09 +00002485
2486 /* The pSubWInfo->untestedTerms flag means that this OR term
2487 ** contained one or more AND term from a notReady table. The
2488 ** terms from the notReady table could not be tested and will
2489 ** need to be tested later.
2490 */
2491 if( pSubWInfo->untestedTerms ) untestedTerms = 1;
2492
2493 /* If all of the OR-connected terms are optimized using the same
2494 ** index, and the index is opened using the same cursor number
2495 ** by each call to sqlite3WhereBegin() made by this loop, it may
2496 ** be possible to use that index as a covering index.
2497 **
2498 ** If the call to sqlite3WhereBegin() above resulted in a scan that
2499 ** uses an index, and this is either the first OR-connected term
2500 ** processed or the index is the same as that used by all previous
2501 ** terms, set pCov to the candidate covering index. Otherwise, set
2502 ** pCov to NULL to indicate that no candidate covering index will
2503 ** be available.
2504 */
2505 pSubLoop = pSubWInfo->a[0].pWLoop;
2506 assert( (pSubLoop->wsFlags & WHERE_AUTO_INDEX)==0 );
2507 if( (pSubLoop->wsFlags & WHERE_INDEXED)!=0
2508 && (ii==0 || pSubLoop->u.btree.pIndex==pCov)
2509 && (HasRowid(pTab) || !IsPrimaryKeyIndex(pSubLoop->u.btree.pIndex))
2510 ){
2511 assert( pSubWInfo->a[0].iIdxCur==iCovCur );
2512 pCov = pSubLoop->u.btree.pIndex;
drh6f82e852015-06-06 20:12:09 +00002513 }else{
2514 pCov = 0;
2515 }
drh68c0c712020-08-14 20:04:26 +00002516 if( sqlite3WhereUsesDeferredSeek(pSubWInfo) ){
2517 pWInfo->bDeferredSeek = 1;
2518 }
drh6f82e852015-06-06 20:12:09 +00002519
2520 /* Finish the loop through table entries that match term pOrTerm. */
2521 sqlite3WhereEnd(pSubWInfo);
drhbd462bc2018-12-24 20:21:06 +00002522 ExplainQueryPlanPop(pParse);
drh6f82e852015-06-06 20:12:09 +00002523 }
drh93ffb502021-05-18 19:10:10 +00002524 sqlite3ExprDelete(db, pDelete);
drh6f82e852015-06-06 20:12:09 +00002525 }
2526 }
drh5d72d922018-05-04 00:39:43 +00002527 ExplainQueryPlanPop(pParse);
drh04756292021-10-14 19:28:28 +00002528 assert( pLevel->pWLoop==pLoop );
2529 assert( (pLoop->wsFlags & WHERE_MULTI_OR)!=0 );
2530 assert( (pLoop->wsFlags & WHERE_IN_ABLE)==0 );
2531 pLevel->u.pCoveringIdx = pCov;
drh6f82e852015-06-06 20:12:09 +00002532 if( pCov ) pLevel->iIdxCur = iCovCur;
2533 if( pAndExpr ){
2534 pAndExpr->pLeft = 0;
2535 sqlite3ExprDelete(db, pAndExpr);
2536 }
2537 sqlite3VdbeChangeP1(v, iRetInit, sqlite3VdbeCurrentAddr(v));
drh076e85f2015-09-03 13:46:12 +00002538 sqlite3VdbeGoto(v, pLevel->addrBrk);
drh6f82e852015-06-06 20:12:09 +00002539 sqlite3VdbeResolveLabel(v, iLoopBody);
2540
drhe603ab02022-04-07 19:06:31 +00002541 /* Set the P2 operand of the OP_Return opcode that will end the current
2542 ** loop to point to this spot, which is the top of the next containing
2543 ** loop. The byte-code formatter will use that P2 value as a hint to
2544 ** indent everything in between the this point and the final OP_Return.
2545 ** See tag-20220407a in vdbe.c and shell.c */
2546 assert( pLevel->op==OP_Return );
2547 pLevel->p2 = sqlite3VdbeCurrentAddr(v);
2548
drhdd2d9a32019-05-07 17:47:43 +00002549 if( pWInfo->nLevel>1 ){ sqlite3StackFree(db, pOrTab); }
drh6f82e852015-06-06 20:12:09 +00002550 if( !untestedTerms ) disableTerm(pLevel, pTerm);
2551 }else
2552#endif /* SQLITE_OMIT_OR_OPTIMIZATION */
2553
2554 {
2555 /* Case 6: There is no usable index. We must do a complete
2556 ** scan of the entire table.
2557 */
2558 static const u8 aStep[] = { OP_Next, OP_Prev };
2559 static const u8 aStart[] = { OP_Rewind, OP_Last };
2560 assert( bRev==0 || bRev==1 );
drh8a48b9c2015-08-19 15:20:00 +00002561 if( pTabItem->fg.isRecursive ){
drh6f82e852015-06-06 20:12:09 +00002562 /* Tables marked isRecursive have only a single row that is stored in
2563 ** a pseudo-cursor. No need to Rewind or Next such cursors. */
2564 pLevel->op = OP_Noop;
2565 }else{
danb324cf72016-06-17 14:33:32 +00002566 codeCursorHint(pTabItem, pWInfo, pLevel, 0);
drh6f82e852015-06-06 20:12:09 +00002567 pLevel->op = aStep[bRev];
2568 pLevel->p1 = iCur;
drh3a3b4202017-02-15 22:36:15 +00002569 pLevel->p2 = 1 + sqlite3VdbeAddOp2(v, aStart[bRev], iCur, addrHalt);
drh6f82e852015-06-06 20:12:09 +00002570 VdbeCoverageIf(v, bRev==0);
2571 VdbeCoverageIf(v, bRev!=0);
2572 pLevel->p5 = SQLITE_STMTSTATUS_FULLSCAN_STEP;
2573 }
2574 }
2575
2576#ifdef SQLITE_ENABLE_STMT_SCANSTATUS
2577 pLevel->addrVisit = sqlite3VdbeCurrentAddr(v);
2578#endif
2579
2580 /* Insert code to test every subexpression that can be completely
2581 ** computed using the current set of tables.
dan6f654a42017-04-28 19:59:55 +00002582 **
danebc63012017-07-10 14:33:00 +00002583 ** This loop may run between one and three times, depending on the
2584 ** constraints to be generated. The value of stack variable iLoop
2585 ** determines the constraints coded by each iteration, as follows:
2586 **
2587 ** iLoop==1: Code only expressions that are entirely covered by pIdx.
2588 ** iLoop==2: Code remaining expressions that do not contain correlated
2589 ** sub-queries.
2590 ** iLoop==3: Code all remaining expressions.
2591 **
2592 ** An effort is made to skip unnecessary iterations of the loop.
drh6ab3eb52017-04-29 14:56:55 +00002593 */
danebc63012017-07-10 14:33:00 +00002594 iLoop = (pIdx ? 1 : 2);
drh6ab3eb52017-04-29 14:56:55 +00002595 do{
danebc63012017-07-10 14:33:00 +00002596 int iNext = 0; /* Next value for iLoop */
dan6f654a42017-04-28 19:59:55 +00002597 for(pTerm=pWC->a, j=pWC->nTerm; j>0; j--, pTerm++){
2598 Expr *pE;
2599 int skipLikeAddr = 0;
2600 testcase( pTerm->wtFlags & TERM_VIRTUAL );
2601 testcase( pTerm->wtFlags & TERM_CODED );
2602 if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
2603 if( (pTerm->prereqAll & pLevel->notReady)!=0 ){
2604 testcase( pWInfo->untestedTerms==0
2605 && (pWInfo->wctrlFlags & WHERE_OR_SUBCLAUSE)!=0 );
2606 pWInfo->untestedTerms = 1;
2607 continue;
2608 }
2609 pE = pTerm->pExpr;
2610 assert( pE!=0 );
drha76ac882022-04-08 19:20:12 +00002611 if( (pTabItem->fg.jointype & (JT_LEFT|JT_LTORJ))
2612 && !ExprHasProperty(pE,EP_FromJoin)
2613 ){
dan6f654a42017-04-28 19:59:55 +00002614 continue;
2615 }
danebc63012017-07-10 14:33:00 +00002616
dan8674ec52017-07-10 14:39:42 +00002617 if( iLoop==1 && !sqlite3ExprCoveredByIndex(pE, pLevel->iTabCur, pIdx) ){
danebc63012017-07-10 14:33:00 +00002618 iNext = 2;
dan6f654a42017-04-28 19:59:55 +00002619 continue;
2620 }
dand3930b12017-07-10 15:17:30 +00002621 if( iLoop<3 && (pTerm->wtFlags & TERM_VARSELECT) ){
danebc63012017-07-10 14:33:00 +00002622 if( iNext==0 ) iNext = 3;
2623 continue;
2624 }
2625
drh4de33532018-04-02 00:16:36 +00002626 if( (pTerm->wtFlags & TERM_LIKECOND)!=0 ){
dan6f654a42017-04-28 19:59:55 +00002627 /* If the TERM_LIKECOND flag is set, that means that the range search
2628 ** is sufficient to guarantee that the LIKE operator is true, so we
2629 ** can skip the call to the like(A,B) function. But this only works
2630 ** for strings. So do not skip the call to the function on the pass
2631 ** that compares BLOBs. */
drh41d2e662015-12-01 21:23:07 +00002632#ifdef SQLITE_LIKE_DOESNT_MATCH_BLOBS
dan6f654a42017-04-28 19:59:55 +00002633 continue;
drh41d2e662015-12-01 21:23:07 +00002634#else
dan6f654a42017-04-28 19:59:55 +00002635 u32 x = pLevel->iLikeRepCntr;
drh4de33532018-04-02 00:16:36 +00002636 if( x>0 ){
2637 skipLikeAddr = sqlite3VdbeAddOp1(v, (x&1)?OP_IfNot:OP_If,(int)(x>>1));
drh6f883592019-03-30 20:37:04 +00002638 VdbeCoverageIf(v, (x&1)==1);
2639 VdbeCoverageIf(v, (x&1)==0);
drh4de33532018-04-02 00:16:36 +00002640 }
drh41d2e662015-12-01 21:23:07 +00002641#endif
dan6f654a42017-04-28 19:59:55 +00002642 }
drh66a0bf32017-07-10 16:38:14 +00002643#ifdef WHERETRACE_ENABLED /* 0xffff */
2644 if( sqlite3WhereTrace ){
2645 VdbeNoopComment((v, "WhereTerm[%d] (%p) priority=%d",
2646 pWC->nTerm-j, pTerm, iLoop));
2647 }
drh118efd12019-12-28 14:07:22 +00002648 if( sqlite3WhereTrace & 0x800 ){
2649 sqlite3DebugPrintf("Coding auxiliary constraint:\n");
2650 sqlite3WhereTermPrint(pTerm, pWC->nTerm-j);
2651 }
drh66a0bf32017-07-10 16:38:14 +00002652#endif
dan6f654a42017-04-28 19:59:55 +00002653 sqlite3ExprIfFalse(pParse, pE, addrCont, SQLITE_JUMPIFNULL);
2654 if( skipLikeAddr ) sqlite3VdbeJumpHere(v, skipLikeAddr);
2655 pTerm->wtFlags |= TERM_CODED;
drh6f82e852015-06-06 20:12:09 +00002656 }
danebc63012017-07-10 14:33:00 +00002657 iLoop = iNext;
2658 }while( iLoop>0 );
drh6f82e852015-06-06 20:12:09 +00002659
2660 /* Insert code to test for implied constraints based on transitivity
2661 ** of the "==" operator.
2662 **
2663 ** Example: If the WHERE clause contains "t1.a=t2.b" and "t2.b=123"
2664 ** and we are coding the t1 loop and the t2 loop has not yet coded,
2665 ** then we cannot use the "t1.a=t2.b" constraint, but we can code
2666 ** the implied "t1.a=123" constraint.
2667 */
drh132f96f2021-12-08 16:07:22 +00002668 for(pTerm=pWC->a, j=pWC->nBase; j>0; j--, pTerm++){
drhcb43a932016-10-03 01:21:51 +00002669 Expr *pE, sEAlt;
drh6f82e852015-06-06 20:12:09 +00002670 WhereTerm *pAlt;
2671 if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
2672 if( (pTerm->eOperator & (WO_EQ|WO_IS))==0 ) continue;
2673 if( (pTerm->eOperator & WO_EQUIV)==0 ) continue;
2674 if( pTerm->leftCursor!=iCur ) continue;
drha76ac882022-04-08 19:20:12 +00002675 if( pTabItem->fg.jointype & (JT_LEFT|JT_LTORJ) ) continue;
drh6f82e852015-06-06 20:12:09 +00002676 pE = pTerm->pExpr;
drh118efd12019-12-28 14:07:22 +00002677#ifdef WHERETRACE_ENABLED /* 0x800 */
2678 if( sqlite3WhereTrace & 0x800 ){
2679 sqlite3DebugPrintf("Coding transitive constraint:\n");
2680 sqlite3WhereTermPrint(pTerm, pWC->nTerm-j);
2681 }
2682#endif
drhf1bb31e2019-12-28 14:33:26 +00002683 assert( !ExprHasProperty(pE, EP_FromJoin) );
drh6f82e852015-06-06 20:12:09 +00002684 assert( (pTerm->prereqRight & pLevel->notReady)!=0 );
drh220f0d62021-10-15 17:06:16 +00002685 assert( (pTerm->eOperator & (WO_OR|WO_AND))==0 );
drh75fa2662020-09-28 15:49:43 +00002686 pAlt = sqlite3WhereFindTerm(pWC, iCur, pTerm->u.x.leftColumn, notReady,
drh6f82e852015-06-06 20:12:09 +00002687 WO_EQ|WO_IN|WO_IS, 0);
2688 if( pAlt==0 ) continue;
2689 if( pAlt->wtFlags & (TERM_CODED) ) continue;
dana916b572018-01-23 16:38:57 +00002690 if( (pAlt->eOperator & WO_IN)
drha4eeccd2021-10-07 17:43:30 +00002691 && ExprUseXSelect(pAlt->pExpr)
drha599e152018-12-24 14:30:11 +00002692 && (pAlt->pExpr->x.pSelect->pEList->nExpr>1)
dana916b572018-01-23 16:38:57 +00002693 ){
2694 continue;
2695 }
drh6f82e852015-06-06 20:12:09 +00002696 testcase( pAlt->eOperator & WO_EQ );
2697 testcase( pAlt->eOperator & WO_IS );
2698 testcase( pAlt->eOperator & WO_IN );
2699 VdbeModuleComment((v, "begin transitive constraint"));
drhcb43a932016-10-03 01:21:51 +00002700 sEAlt = *pAlt->pExpr;
2701 sEAlt.pLeft = pE->pLeft;
2702 sqlite3ExprIfFalse(pParse, &sEAlt, addrCont, SQLITE_JUMPIFNULL);
dan240e36c2021-04-05 16:20:59 +00002703 pAlt->wtFlags |= TERM_CODED;
drh6f82e852015-06-06 20:12:09 +00002704 }
2705
2706 /* For a LEFT OUTER JOIN, generate code that will record the fact that
2707 ** at least one row of the right table has matched the left table.
2708 */
2709 if( pLevel->iLeftJoin ){
2710 pLevel->addrFirst = sqlite3VdbeCurrentAddr(v);
2711 sqlite3VdbeAddOp2(v, OP_Integer, 1, pLevel->iLeftJoin);
2712 VdbeComment((v, "record LEFT JOIN hit"));
drh132f96f2021-12-08 16:07:22 +00002713 for(pTerm=pWC->a, j=0; j<pWC->nBase; j++, pTerm++){
drh6f82e852015-06-06 20:12:09 +00002714 testcase( pTerm->wtFlags & TERM_VIRTUAL );
2715 testcase( pTerm->wtFlags & TERM_CODED );
2716 if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
2717 if( (pTerm->prereqAll & pLevel->notReady)!=0 ){
2718 assert( pWInfo->untestedTerms );
2719 continue;
2720 }
2721 assert( pTerm->pExpr );
2722 sqlite3ExprIfFalse(pParse, pTerm->pExpr, addrCont, SQLITE_JUMPIFNULL);
2723 pTerm->wtFlags |= TERM_CODED;
2724 }
2725 }
2726
drhc2308ad2022-04-09 03:16:26 +00002727 /* For a RIGHT OUTER JOIN, record the fact that the current row has
2728 ** been matched at least once.
2729 */
drh7c1734b2022-04-09 12:27:20 +00002730 if( pLevel->pRJ ){
drhc2308ad2022-04-09 03:16:26 +00002731 Table *pTab;
2732 int nPk;
2733 int r;
2734 int jmp1 = 0;
drh7c1734b2022-04-09 12:27:20 +00002735 WhereRightJoin *pRJ = pLevel->pRJ;
drhc2308ad2022-04-09 03:16:26 +00002736
drh7c1734b2022-04-09 12:27:20 +00002737 /* pTab is the right-hand table of the RIGHT JOIN. Generate code that
2738 ** will record that the current row of that table has been matched at
2739 ** least once. This is accomplished by storing the PK for the row in
2740 ** both the iMatch index and the regBloom Bloom filter.
2741 */
drhc2308ad2022-04-09 03:16:26 +00002742 pTab = pWInfo->pTabList->a[pLevel->iFrom].pTab;
2743 if( HasRowid(pTab) ){
2744 r = sqlite3GetTempRange(pParse, 2);
2745 sqlite3ExprCodeGetColumnOfTable(v, pTab, pLevel->iTabCur, -1, r+1);
2746 nPk = 1;
2747 }else{
2748 int iPk;
2749 Index *pPk = sqlite3PrimaryKeyIndex(pTab);
2750 nPk = pPk->nKeyCol;
2751 r = sqlite3GetTempRange(pParse, nPk+1);
2752 for(iPk=0; iPk<nPk; iPk++){
2753 int iCol = pPk->aiColumn[iPk];
2754 sqlite3ExprCodeGetColumnOfTable(v, pTab, iCur, iCol,r+1+iPk);
2755 }
2756 }
drh7c1734b2022-04-09 12:27:20 +00002757 jmp1 = sqlite3VdbeAddOp4Int(v, OP_Found, pRJ->iMatch, 0, r+1, nPk);
drhc2308ad2022-04-09 03:16:26 +00002758 VdbeCoverage(v);
2759 sqlite3VdbeAddOp3(v, OP_MakeRecord, r+1, nPk, r);
drh7c1734b2022-04-09 12:27:20 +00002760 sqlite3VdbeAddOp4Int(v, OP_IdxInsert, pRJ->iMatch, r, r+1, nPk);
2761 sqlite3VdbeAddOp4Int(v, OP_FilterAdd, pRJ->regBloom, 0, r+1, nPk);
drhc2308ad2022-04-09 03:16:26 +00002762 sqlite3VdbeChangeP5(v, OPFLAG_USESEEKRESULT);
2763 sqlite3VdbeJumpHere(v, jmp1);
drhc2308ad2022-04-09 03:16:26 +00002764 sqlite3ReleaseTempRange(pParse, r, nPk+1);
drh7c1734b2022-04-09 12:27:20 +00002765
2766 /* Create a subroutine used to process all interior loops and code
2767 ** of the RIGHT JOIN. During normal operation, the subroutine will
2768 ** be in-line with the rest of the code. But at the end, a separate
2769 ** loop will run that invokes this subroutine for unmatched rows
2770 ** of pTab, with all tables to left begin set to NULL.
2771 */
2772 sqlite3VdbeAddOp2(v, OP_BeginSubrtn, 0, pRJ->regReturn);
2773 pRJ->addrSubrtn = sqlite3VdbeCurrentAddr(v);
drhc2308ad2022-04-09 03:16:26 +00002774 }
2775
drh118efd12019-12-28 14:07:22 +00002776#if WHERETRACE_ENABLED /* 0x20800 */
2777 if( sqlite3WhereTrace & 0x20000 ){
drhf1bb31e2019-12-28 14:33:26 +00002778 sqlite3DebugPrintf("All WHERE-clause terms after coding level %d:\n",
2779 iLevel);
drh118efd12019-12-28 14:07:22 +00002780 sqlite3WhereClausePrint(pWC);
2781 }
2782 if( sqlite3WhereTrace & 0x800 ){
2783 sqlite3DebugPrintf("End Coding level %d: notReady=%llx\n",
2784 iLevel, (u64)pLevel->notReady);
2785 }
2786#endif
drh6f82e852015-06-06 20:12:09 +00002787 return pLevel->notReady;
2788}
drh949e2ab2022-04-12 18:04:29 +00002789
2790/*
2791** Generate the code for the loop that finds all non-matched terms
2792** for a RIGHT JOIN.
2793*/
2794SQLITE_NOINLINE void sqlite3WhereRightJoinLoop(
2795 WhereInfo *pWInfo,
2796 int iLevel,
2797 WhereLevel *pLevel
2798){
2799 Parse *pParse = pWInfo->pParse;
2800 Vdbe *v = pParse->pVdbe;
2801 WhereRightJoin *pRJ = pLevel->pRJ;
2802 Expr *pSubWhere = 0;
2803 WhereClause *pWC = &pWInfo->sWC;
2804 WhereInfo *pSubWInfo;
2805 WhereLoop *pLoop = pLevel->pWLoop;
2806 SrcItem *pTabItem = &pWInfo->pTabList->a[pLevel->iFrom];
2807 SrcList sFrom;
2808 Bitmask mAll = 0;
2809 int k;
2810
2811 for(k=0; k<iLevel; k++){
2812 int iIdxCur;
2813 mAll |= pWInfo->a[k].pWLoop->maskSelf;
2814 sqlite3VdbeAddOp1(v, OP_NullRow, pWInfo->a[k].iTabCur);
2815 iIdxCur = pWInfo->a[k].iIdxCur;
2816 if( iIdxCur ){
2817 sqlite3VdbeAddOp1(v, OP_NullRow, iIdxCur);
2818 }
2819 }
2820 mAll |= pLoop->maskSelf;
2821 for(k=0; k<pWC->nTerm; k++){
2822 WhereTerm *pTerm = &pWC->a[k];
2823 if( pTerm->wtFlags & TERM_VIRTUAL ) break;
2824 if( pTerm->prereqAll & ~mAll ) continue;
2825 if( ExprHasProperty(pTerm->pExpr, EP_FromJoin|EP_InnerJoin) ) continue;
2826 pSubWhere = sqlite3ExprAnd(pParse, pSubWhere,
2827 sqlite3ExprDup(pParse->db, pTerm->pExpr, 0));
2828 }
2829 sFrom.nSrc = 1;
2830 sFrom.nAlloc = 1;
2831 memcpy(&sFrom.a[0], pTabItem, sizeof(SrcItem));
2832 sFrom.a[0].fg.jointype = 0;
2833 ExplainQueryPlan((pParse, 1, "RIGHT-JOIN %s", pTabItem->pTab->zName));
2834 pSubWInfo = sqlite3WhereBegin(pParse, &sFrom, pSubWhere, 0, 0, 0,
2835 WHERE_RIGHT_JOIN, 0);
2836 if( pSubWInfo ){
2837 int iCur = pLevel->iTabCur;
2838 int r = ++pParse->nMem;
2839 int nPk;
2840 int jmp;
2841 int addrCont = sqlite3WhereContinueLabel(pSubWInfo);
2842 Table *pTab = pTabItem->pTab;
2843 if( HasRowid(pTab) ){
2844 sqlite3ExprCodeGetColumnOfTable(v, pTab, iCur, -1, r);
2845 nPk = 1;
2846 }else{
2847 int iPk;
2848 Index *pPk = sqlite3PrimaryKeyIndex(pTab);
2849 nPk = pPk->nKeyCol;
2850 pParse->nMem += nPk - 1;
2851 for(iPk=0; iPk<nPk; iPk++){
2852 int iCol = pPk->aiColumn[iPk];
2853 sqlite3ExprCodeGetColumnOfTable(v, pTab, iCur, iCol,r+iPk);
2854 }
2855 }
2856 jmp = sqlite3VdbeAddOp4Int(v, OP_Filter, pRJ->regBloom, 0, r, nPk);
drh146e64d2022-04-13 01:52:32 +00002857 VdbeCoverage(v);
drh949e2ab2022-04-12 18:04:29 +00002858 sqlite3VdbeAddOp4Int(v, OP_Found, pRJ->iMatch, addrCont, r, nPk);
drh146e64d2022-04-13 01:52:32 +00002859 VdbeCoverage(v);
drh949e2ab2022-04-12 18:04:29 +00002860 sqlite3VdbeJumpHere(v, jmp);
2861 sqlite3VdbeAddOp2(v, OP_Gosub, pRJ->regReturn, pRJ->addrSubrtn);
2862 sqlite3WhereEnd(pSubWInfo);
2863 }
2864 sqlite3ExprDelete(pParse->db, pSubWhere);
2865 ExplainQueryPlanPop(pParse);
2866}