blob: accc14086687853336381539c61111ace95ecf54 [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
24/*
25** This routine is a helper for explainIndexRange() below
26**
27** pStr holds the text of an expression that we are building up one term
28** at a time. This routine adds a new term to the end of the expression.
29** Terms are separated by AND so add the "AND" text for second and subsequent
30** terms only.
31*/
32static void explainAppendTerm(
33 StrAccum *pStr, /* The text expression being built */
34 int iTerm, /* Index of this term. First is zero */
35 const char *zColumn, /* Name of the column */
36 const char *zOp /* Name of the operator */
37){
38 if( iTerm ) sqlite3StrAccumAppend(pStr, " AND ", 5);
39 sqlite3StrAccumAppendAll(pStr, zColumn);
40 sqlite3StrAccumAppend(pStr, zOp, 1);
41 sqlite3StrAccumAppend(pStr, "?", 1);
42}
43
44/*
drhc7c46802015-08-27 20:33:38 +000045** Return the name of the i-th column of the pIdx index.
46*/
47static const char *explainIndexColumnName(Index *pIdx, int i){
48 i = pIdx->aiColumn[i];
drh4b92f982015-09-29 17:20:14 +000049 if( i==XN_EXPR ) return "<expr>";
50 if( i==XN_ROWID ) return "rowid";
drhc7c46802015-08-27 20:33:38 +000051 return pIdx->pTable->aCol[i].zName;
52}
53
54/*
drh6f82e852015-06-06 20:12:09 +000055** Argument pLevel describes a strategy for scanning table pTab. This
56** function appends text to pStr that describes the subset of table
57** rows scanned by the strategy in the form of an SQL expression.
58**
59** For example, if the query:
60**
61** SELECT * FROM t1 WHERE a=1 AND b>2;
62**
63** is run and there is an index on (a, b), then this function returns a
64** string similar to:
65**
66** "a=? AND b>?"
67*/
drh8faee872015-09-19 18:08:13 +000068static void explainIndexRange(StrAccum *pStr, WhereLoop *pLoop){
drh6f82e852015-06-06 20:12:09 +000069 Index *pIndex = pLoop->u.btree.pIndex;
70 u16 nEq = pLoop->u.btree.nEq;
71 u16 nSkip = pLoop->nSkip;
72 int i, j;
drh6f82e852015-06-06 20:12:09 +000073
74 if( nEq==0 && (pLoop->wsFlags&(WHERE_BTM_LIMIT|WHERE_TOP_LIMIT))==0 ) return;
75 sqlite3StrAccumAppend(pStr, " (", 2);
76 for(i=0; i<nEq; i++){
drhc7c46802015-08-27 20:33:38 +000077 const char *z = explainIndexColumnName(pIndex, i);
drh2ed0d802015-09-02 16:51:37 +000078 if( i ) sqlite3StrAccumAppend(pStr, " AND ", 5);
drh5f4a6862016-01-30 12:50:25 +000079 sqlite3XPrintf(pStr, i>=nSkip ? "%s=?" : "ANY(%s)", z);
drh6f82e852015-06-06 20:12:09 +000080 }
81
82 j = i;
83 if( pLoop->wsFlags&WHERE_BTM_LIMIT ){
drhc7c46802015-08-27 20:33:38 +000084 const char *z = explainIndexColumnName(pIndex, i);
drh6f82e852015-06-06 20:12:09 +000085 explainAppendTerm(pStr, i++, z, ">");
86 }
87 if( pLoop->wsFlags&WHERE_TOP_LIMIT ){
drhc7c46802015-08-27 20:33:38 +000088 const char *z = explainIndexColumnName(pIndex, j);
drh6f82e852015-06-06 20:12:09 +000089 explainAppendTerm(pStr, i, z, "<");
90 }
91 sqlite3StrAccumAppend(pStr, ")", 1);
92}
93
94/*
95** This function is a no-op unless currently processing an EXPLAIN QUERY PLAN
96** command, or if either SQLITE_DEBUG or SQLITE_ENABLE_STMT_SCANSTATUS was
97** defined at compile-time. If it is not a no-op, a single OP_Explain opcode
98** is added to the output to describe the table scan strategy in pLevel.
99**
100** If an OP_Explain opcode is added to the VM, its address is returned.
101** Otherwise, if no OP_Explain is coded, zero is returned.
102*/
103int sqlite3WhereExplainOneScan(
104 Parse *pParse, /* Parse context */
105 SrcList *pTabList, /* Table list this loop refers to */
106 WhereLevel *pLevel, /* Scan to write OP_Explain opcode for */
107 int iLevel, /* Value for "level" column of output */
108 int iFrom, /* Value for "from" column of output */
109 u16 wctrlFlags /* Flags passed to sqlite3WhereBegin() */
110){
111 int ret = 0;
112#if !defined(SQLITE_DEBUG) && !defined(SQLITE_ENABLE_STMT_SCANSTATUS)
113 if( pParse->explain==2 )
114#endif
115 {
116 struct SrcList_item *pItem = &pTabList->a[pLevel->iFrom];
117 Vdbe *v = pParse->pVdbe; /* VM being constructed */
118 sqlite3 *db = pParse->db; /* Database handle */
119 int iId = pParse->iSelectId; /* Select id (left-most output column) */
120 int isSearch; /* True for a SEARCH. False for SCAN. */
121 WhereLoop *pLoop; /* The controlling WhereLoop object */
122 u32 flags; /* Flags that describe this loop */
123 char *zMsg; /* Text to add to EQP output */
124 StrAccum str; /* EQP output string */
125 char zBuf[100]; /* Initial space for EQP output string */
126
127 pLoop = pLevel->pWLoop;
128 flags = pLoop->wsFlags;
129 if( (flags&WHERE_MULTI_OR) || (wctrlFlags&WHERE_ONETABLE_ONLY) ) return 0;
130
131 isSearch = (flags&(WHERE_BTM_LIMIT|WHERE_TOP_LIMIT))!=0
132 || ((flags&WHERE_VIRTUALTABLE)==0 && (pLoop->u.btree.nEq>0))
133 || (wctrlFlags&(WHERE_ORDERBY_MIN|WHERE_ORDERBY_MAX));
134
135 sqlite3StrAccumInit(&str, db, zBuf, sizeof(zBuf), SQLITE_MAX_LENGTH);
136 sqlite3StrAccumAppendAll(&str, isSearch ? "SEARCH" : "SCAN");
137 if( pItem->pSelect ){
drh5f4a6862016-01-30 12:50:25 +0000138 sqlite3XPrintf(&str, " SUBQUERY %d", pItem->iSelectId);
drh6f82e852015-06-06 20:12:09 +0000139 }else{
drh5f4a6862016-01-30 12:50:25 +0000140 sqlite3XPrintf(&str, " TABLE %s", pItem->zName);
drh6f82e852015-06-06 20:12:09 +0000141 }
142
143 if( pItem->zAlias ){
drh5f4a6862016-01-30 12:50:25 +0000144 sqlite3XPrintf(&str, " AS %s", pItem->zAlias);
drh6f82e852015-06-06 20:12:09 +0000145 }
146 if( (flags & (WHERE_IPK|WHERE_VIRTUALTABLE))==0 ){
147 const char *zFmt = 0;
148 Index *pIdx;
149
150 assert( pLoop->u.btree.pIndex!=0 );
151 pIdx = pLoop->u.btree.pIndex;
152 assert( !(flags&WHERE_AUTO_INDEX) || (flags&WHERE_IDX_ONLY) );
153 if( !HasRowid(pItem->pTab) && IsPrimaryKeyIndex(pIdx) ){
154 if( isSearch ){
155 zFmt = "PRIMARY KEY";
156 }
157 }else if( flags & WHERE_PARTIALIDX ){
158 zFmt = "AUTOMATIC PARTIAL COVERING INDEX";
159 }else if( flags & WHERE_AUTO_INDEX ){
160 zFmt = "AUTOMATIC COVERING INDEX";
161 }else if( flags & WHERE_IDX_ONLY ){
162 zFmt = "COVERING INDEX %s";
163 }else{
164 zFmt = "INDEX %s";
165 }
166 if( zFmt ){
167 sqlite3StrAccumAppend(&str, " USING ", 7);
drh5f4a6862016-01-30 12:50:25 +0000168 sqlite3XPrintf(&str, zFmt, pIdx->zName);
drh8faee872015-09-19 18:08:13 +0000169 explainIndexRange(&str, pLoop);
drh6f82e852015-06-06 20:12:09 +0000170 }
171 }else if( (flags & WHERE_IPK)!=0 && (flags & WHERE_CONSTRAINT)!=0 ){
drhd37bea52015-09-02 15:37:50 +0000172 const char *zRangeOp;
drh6f82e852015-06-06 20:12:09 +0000173 if( flags&(WHERE_COLUMN_EQ|WHERE_COLUMN_IN) ){
drhd37bea52015-09-02 15:37:50 +0000174 zRangeOp = "=";
drh6f82e852015-06-06 20:12:09 +0000175 }else if( (flags&WHERE_BOTH_LIMIT)==WHERE_BOTH_LIMIT ){
drhd37bea52015-09-02 15:37:50 +0000176 zRangeOp = ">? AND rowid<";
drh6f82e852015-06-06 20:12:09 +0000177 }else if( flags&WHERE_BTM_LIMIT ){
drhd37bea52015-09-02 15:37:50 +0000178 zRangeOp = ">";
drh6f82e852015-06-06 20:12:09 +0000179 }else{
180 assert( flags&WHERE_TOP_LIMIT);
drhd37bea52015-09-02 15:37:50 +0000181 zRangeOp = "<";
drh6f82e852015-06-06 20:12:09 +0000182 }
drh5f4a6862016-01-30 12:50:25 +0000183 sqlite3XPrintf(&str, " USING INTEGER PRIMARY KEY (rowid%s?)",zRangeOp);
drh6f82e852015-06-06 20:12:09 +0000184 }
185#ifndef SQLITE_OMIT_VIRTUALTABLE
186 else if( (flags & WHERE_VIRTUALTABLE)!=0 ){
drh5f4a6862016-01-30 12:50:25 +0000187 sqlite3XPrintf(&str, " VIRTUAL TABLE INDEX %d:%s",
drh6f82e852015-06-06 20:12:09 +0000188 pLoop->u.vtab.idxNum, pLoop->u.vtab.idxStr);
189 }
190#endif
191#ifdef SQLITE_EXPLAIN_ESTIMATED_ROWS
192 if( pLoop->nOut>=10 ){
drh5f4a6862016-01-30 12:50:25 +0000193 sqlite3XPrintf(&str, " (~%llu rows)", sqlite3LogEstToInt(pLoop->nOut));
drh6f82e852015-06-06 20:12:09 +0000194 }else{
195 sqlite3StrAccumAppend(&str, " (~1 row)", 9);
196 }
197#endif
198 zMsg = sqlite3StrAccumFinish(&str);
199 ret = sqlite3VdbeAddOp4(v, OP_Explain, iId, iLevel, iFrom, zMsg,P4_DYNAMIC);
200 }
201 return ret;
202}
203#endif /* SQLITE_OMIT_EXPLAIN */
204
205#ifdef SQLITE_ENABLE_STMT_SCANSTATUS
206/*
207** Configure the VM passed as the first argument with an
208** sqlite3_stmt_scanstatus() entry corresponding to the scan used to
209** implement level pLvl. Argument pSrclist is a pointer to the FROM
210** clause that the scan reads data from.
211**
212** If argument addrExplain is not 0, it must be the address of an
213** OP_Explain instruction that describes the same loop.
214*/
215void sqlite3WhereAddScanStatus(
216 Vdbe *v, /* Vdbe to add scanstatus entry to */
217 SrcList *pSrclist, /* FROM clause pLvl reads data from */
218 WhereLevel *pLvl, /* Level to add scanstatus() entry for */
219 int addrExplain /* Address of OP_Explain (or 0) */
220){
221 const char *zObj = 0;
222 WhereLoop *pLoop = pLvl->pWLoop;
223 if( (pLoop->wsFlags & WHERE_VIRTUALTABLE)==0 && pLoop->u.btree.pIndex!=0 ){
224 zObj = pLoop->u.btree.pIndex->zName;
225 }else{
226 zObj = pSrclist->a[pLvl->iFrom].zName;
227 }
228 sqlite3VdbeScanStatus(
229 v, addrExplain, pLvl->addrBody, pLvl->addrVisit, pLoop->nOut, zObj
230 );
231}
232#endif
233
234
235/*
236** Disable a term in the WHERE clause. Except, do not disable the term
237** if it controls a LEFT OUTER JOIN and it did not originate in the ON
238** or USING clause of that join.
239**
240** Consider the term t2.z='ok' in the following queries:
241**
242** (1) SELECT * FROM t1 LEFT JOIN t2 ON t1.a=t2.x WHERE t2.z='ok'
243** (2) SELECT * FROM t1 LEFT JOIN t2 ON t1.a=t2.x AND t2.z='ok'
244** (3) SELECT * FROM t1, t2 WHERE t1.a=t2.x AND t2.z='ok'
245**
246** The t2.z='ok' is disabled in the in (2) because it originates
247** in the ON clause. The term is disabled in (3) because it is not part
248** of a LEFT OUTER JOIN. In (1), the term is not disabled.
249**
250** Disabling a term causes that term to not be tested in the inner loop
251** of the join. Disabling is an optimization. When terms are satisfied
252** by indices, we disable them to prevent redundant tests in the inner
253** loop. We would get the correct results if nothing were ever disabled,
254** but joins might run a little slower. The trick is to disable as much
255** as we can without disabling too much. If we disabled in (1), we'd get
256** the wrong answer. See ticket #813.
257**
258** If all the children of a term are disabled, then that term is also
259** automatically disabled. In this way, terms get disabled if derived
260** virtual terms are tested first. For example:
261**
262** x GLOB 'abc*' AND x>='abc' AND x<'acd'
263** \___________/ \______/ \_____/
264** parent child1 child2
265**
266** Only the parent term was in the original WHERE clause. The child1
267** and child2 terms were added by the LIKE optimization. If both of
268** the virtual child terms are valid, then testing of the parent can be
269** skipped.
270**
271** Usually the parent term is marked as TERM_CODED. But if the parent
272** term was originally TERM_LIKE, then the parent gets TERM_LIKECOND instead.
273** The TERM_LIKECOND marking indicates that the term should be coded inside
274** a conditional such that is only evaluated on the second pass of a
275** LIKE-optimization loop, when scanning BLOBs instead of strings.
276*/
277static void disableTerm(WhereLevel *pLevel, WhereTerm *pTerm){
278 int nLoop = 0;
279 while( pTerm
280 && (pTerm->wtFlags & TERM_CODED)==0
281 && (pLevel->iLeftJoin==0 || ExprHasProperty(pTerm->pExpr, EP_FromJoin))
282 && (pLevel->notReady & pTerm->prereqAll)==0
283 ){
284 if( nLoop && (pTerm->wtFlags & TERM_LIKE)!=0 ){
285 pTerm->wtFlags |= TERM_LIKECOND;
286 }else{
287 pTerm->wtFlags |= TERM_CODED;
288 }
289 if( pTerm->iParent<0 ) break;
290 pTerm = &pTerm->pWC->a[pTerm->iParent];
291 pTerm->nChild--;
292 if( pTerm->nChild!=0 ) break;
293 nLoop++;
294 }
295}
296
297/*
298** Code an OP_Affinity opcode to apply the column affinity string zAff
299** to the n registers starting at base.
300**
301** As an optimization, SQLITE_AFF_BLOB entries (which are no-ops) at the
302** beginning and end of zAff are ignored. If all entries in zAff are
303** SQLITE_AFF_BLOB, then no code gets generated.
304**
305** This routine makes its own copy of zAff so that the caller is free
306** to modify zAff after this routine returns.
307*/
308static void codeApplyAffinity(Parse *pParse, int base, int n, char *zAff){
309 Vdbe *v = pParse->pVdbe;
310 if( zAff==0 ){
311 assert( pParse->db->mallocFailed );
312 return;
313 }
314 assert( v!=0 );
315
316 /* Adjust base and n to skip over SQLITE_AFF_BLOB entries at the beginning
317 ** and end of the affinity string.
318 */
319 while( n>0 && zAff[0]==SQLITE_AFF_BLOB ){
320 n--;
321 base++;
322 zAff++;
323 }
324 while( n>1 && zAff[n-1]==SQLITE_AFF_BLOB ){
325 n--;
326 }
327
328 /* Code the OP_Affinity opcode if there is anything left to do. */
329 if( n>0 ){
drh9b34abe2016-01-16 15:12:35 +0000330 sqlite3VdbeAddOp4(v, OP_Affinity, base, n, 0, zAff, n);
drh6f82e852015-06-06 20:12:09 +0000331 sqlite3ExprCacheAffinityChange(pParse, base, n);
332 }
333}
334
335
336/*
337** Generate code for a single equality term of the WHERE clause. An equality
338** term can be either X=expr or X IN (...). pTerm is the term to be
339** coded.
340**
341** The current value for the constraint is left in register iReg.
342**
343** For a constraint of the form X=expr, the expression is evaluated and its
344** result is left on the stack. For constraints of the form X IN (...)
345** this routine sets up a loop that will iterate over all values of X.
346*/
347static int codeEqualityTerm(
348 Parse *pParse, /* The parsing context */
349 WhereTerm *pTerm, /* The term of the WHERE clause to be coded */
350 WhereLevel *pLevel, /* The level of the FROM clause we are working on */
351 int iEq, /* Index of the equality term within this level */
352 int bRev, /* True for reverse-order IN operations */
353 int iTarget /* Attempt to leave results in this register */
354){
355 Expr *pX = pTerm->pExpr;
356 Vdbe *v = pParse->pVdbe;
357 int iReg; /* Register holding results */
358
359 assert( iTarget>0 );
360 if( pX->op==TK_EQ || pX->op==TK_IS ){
361 iReg = sqlite3ExprCodeTarget(pParse, pX->pRight, iTarget);
362 }else if( pX->op==TK_ISNULL ){
363 iReg = iTarget;
364 sqlite3VdbeAddOp2(v, OP_Null, 0, iReg);
365#ifndef SQLITE_OMIT_SUBQUERY
366 }else{
367 int eType;
368 int iTab;
369 struct InLoop *pIn;
370 WhereLoop *pLoop = pLevel->pWLoop;
371
372 if( (pLoop->wsFlags & WHERE_VIRTUALTABLE)==0
373 && pLoop->u.btree.pIndex!=0
374 && pLoop->u.btree.pIndex->aSortOrder[iEq]
375 ){
376 testcase( iEq==0 );
377 testcase( bRev );
378 bRev = !bRev;
379 }
380 assert( pX->op==TK_IN );
381 iReg = iTarget;
382 eType = sqlite3FindInIndex(pParse, pX, IN_INDEX_LOOP, 0);
383 if( eType==IN_INDEX_INDEX_DESC ){
384 testcase( bRev );
385 bRev = !bRev;
386 }
387 iTab = pX->iTable;
388 sqlite3VdbeAddOp2(v, bRev ? OP_Last : OP_Rewind, iTab, 0);
389 VdbeCoverageIf(v, bRev);
390 VdbeCoverageIf(v, !bRev);
391 assert( (pLoop->wsFlags & WHERE_MULTI_OR)==0 );
392 pLoop->wsFlags |= WHERE_IN_ABLE;
393 if( pLevel->u.in.nIn==0 ){
394 pLevel->addrNxt = sqlite3VdbeMakeLabel(v);
395 }
396 pLevel->u.in.nIn++;
397 pLevel->u.in.aInLoop =
398 sqlite3DbReallocOrFree(pParse->db, pLevel->u.in.aInLoop,
399 sizeof(pLevel->u.in.aInLoop[0])*pLevel->u.in.nIn);
400 pIn = pLevel->u.in.aInLoop;
401 if( pIn ){
402 pIn += pLevel->u.in.nIn - 1;
403 pIn->iCur = iTab;
404 if( eType==IN_INDEX_ROWID ){
405 pIn->addrInTop = sqlite3VdbeAddOp2(v, OP_Rowid, iTab, iReg);
406 }else{
407 pIn->addrInTop = sqlite3VdbeAddOp3(v, OP_Column, iTab, 0, iReg);
408 }
409 pIn->eEndLoopOp = bRev ? OP_PrevIfOpen : OP_NextIfOpen;
410 sqlite3VdbeAddOp1(v, OP_IsNull, iReg); VdbeCoverage(v);
411 }else{
412 pLevel->u.in.nIn = 0;
413 }
414#endif
415 }
416 disableTerm(pLevel, pTerm);
417 return iReg;
418}
419
420/*
421** Generate code that will evaluate all == and IN constraints for an
422** index scan.
423**
424** For example, consider table t1(a,b,c,d,e,f) with index i1(a,b,c).
425** Suppose the WHERE clause is this: a==5 AND b IN (1,2,3) AND c>5 AND c<10
426** The index has as many as three equality constraints, but in this
427** example, the third "c" value is an inequality. So only two
428** constraints are coded. This routine will generate code to evaluate
429** a==5 and b IN (1,2,3). The current values for a and b will be stored
430** in consecutive registers and the index of the first register is returned.
431**
432** In the example above nEq==2. But this subroutine works for any value
433** of nEq including 0. If nEq==0, this routine is nearly a no-op.
434** The only thing it does is allocate the pLevel->iMem memory cell and
435** compute the affinity string.
436**
437** The nExtraReg parameter is 0 or 1. It is 0 if all WHERE clause constraints
438** are == or IN and are covered by the nEq. nExtraReg is 1 if there is
439** an inequality constraint (such as the "c>=5 AND c<10" in the example) that
440** occurs after the nEq quality constraints.
441**
442** This routine allocates a range of nEq+nExtraReg memory cells and returns
443** the index of the first memory cell in that range. The code that
444** calls this routine will use that memory range to store keys for
445** start and termination conditions of the loop.
446** key value of the loop. If one or more IN operators appear, then
447** this routine allocates an additional nEq memory cells for internal
448** use.
449**
450** Before returning, *pzAff is set to point to a buffer containing a
451** copy of the column affinity string of the index allocated using
452** sqlite3DbMalloc(). Except, entries in the copy of the string associated
453** with equality constraints that use BLOB or NONE affinity are set to
454** SQLITE_AFF_BLOB. This is to deal with SQL such as the following:
455**
456** CREATE TABLE t1(a TEXT PRIMARY KEY, b);
457** SELECT ... FROM t1 AS t2, t1 WHERE t1.a = t2.b;
458**
459** In the example above, the index on t1(a) has TEXT affinity. But since
460** the right hand side of the equality constraint (t2.b) has BLOB/NONE affinity,
461** no conversion should be attempted before using a t2.b value as part of
462** a key to search the index. Hence the first byte in the returned affinity
463** string in this example would be set to SQLITE_AFF_BLOB.
464*/
465static int codeAllEqualityTerms(
466 Parse *pParse, /* Parsing context */
467 WhereLevel *pLevel, /* Which nested loop of the FROM we are coding */
468 int bRev, /* Reverse the order of IN operators */
469 int nExtraReg, /* Number of extra registers to allocate */
470 char **pzAff /* OUT: Set to point to affinity string */
471){
472 u16 nEq; /* The number of == or IN constraints to code */
473 u16 nSkip; /* Number of left-most columns to skip */
474 Vdbe *v = pParse->pVdbe; /* The vm under construction */
475 Index *pIdx; /* The index being used for this loop */
476 WhereTerm *pTerm; /* A single constraint term */
477 WhereLoop *pLoop; /* The WhereLoop object */
478 int j; /* Loop counter */
479 int regBase; /* Base register */
480 int nReg; /* Number of registers to allocate */
481 char *zAff; /* Affinity string to return */
482
483 /* This module is only called on query plans that use an index. */
484 pLoop = pLevel->pWLoop;
485 assert( (pLoop->wsFlags & WHERE_VIRTUALTABLE)==0 );
486 nEq = pLoop->u.btree.nEq;
487 nSkip = pLoop->nSkip;
488 pIdx = pLoop->u.btree.pIndex;
489 assert( pIdx!=0 );
490
491 /* Figure out how many memory cells we will need then allocate them.
492 */
493 regBase = pParse->nMem + 1;
494 nReg = pLoop->u.btree.nEq + nExtraReg;
495 pParse->nMem += nReg;
496
drhe9107692015-08-25 19:20:04 +0000497 zAff = sqlite3DbStrDup(pParse->db,sqlite3IndexAffinityStr(pParse->db,pIdx));
drh4df86af2016-02-04 11:48:00 +0000498 assert( zAff!=0 || pParse->db->mallocFailed );
drh6f82e852015-06-06 20:12:09 +0000499
500 if( nSkip ){
501 int iIdxCur = pLevel->iIdxCur;
502 sqlite3VdbeAddOp1(v, (bRev?OP_Last:OP_Rewind), iIdxCur);
503 VdbeCoverageIf(v, bRev==0);
504 VdbeCoverageIf(v, bRev!=0);
505 VdbeComment((v, "begin skip-scan on %s", pIdx->zName));
506 j = sqlite3VdbeAddOp0(v, OP_Goto);
507 pLevel->addrSkip = sqlite3VdbeAddOp4Int(v, (bRev?OP_SeekLT:OP_SeekGT),
508 iIdxCur, 0, regBase, nSkip);
509 VdbeCoverageIf(v, bRev==0);
510 VdbeCoverageIf(v, bRev!=0);
511 sqlite3VdbeJumpHere(v, j);
512 for(j=0; j<nSkip; j++){
513 sqlite3VdbeAddOp3(v, OP_Column, iIdxCur, j, regBase+j);
drh4b92f982015-09-29 17:20:14 +0000514 testcase( pIdx->aiColumn[j]==XN_EXPR );
drhe63e8a62015-09-18 18:09:28 +0000515 VdbeComment((v, "%s", explainIndexColumnName(pIdx, j)));
drh6f82e852015-06-06 20:12:09 +0000516 }
517 }
518
519 /* Evaluate the equality constraints
520 */
521 assert( zAff==0 || (int)strlen(zAff)>=nEq );
522 for(j=nSkip; j<nEq; j++){
523 int r1;
524 pTerm = pLoop->aLTerm[j];
525 assert( pTerm!=0 );
526 /* The following testcase is true for indices with redundant columns.
527 ** Ex: CREATE INDEX i1 ON t1(a,b,a); SELECT * FROM t1 WHERE a=0 AND b=0; */
528 testcase( (pTerm->wtFlags & TERM_CODED)!=0 );
529 testcase( pTerm->wtFlags & TERM_VIRTUAL );
530 r1 = codeEqualityTerm(pParse, pTerm, pLevel, j, bRev, regBase+j);
531 if( r1!=regBase+j ){
532 if( nReg==1 ){
533 sqlite3ReleaseTempReg(pParse, regBase);
534 regBase = r1;
535 }else{
536 sqlite3VdbeAddOp2(v, OP_SCopy, r1, regBase+j);
537 }
538 }
539 testcase( pTerm->eOperator & WO_ISNULL );
540 testcase( pTerm->eOperator & WO_IN );
541 if( (pTerm->eOperator & (WO_ISNULL|WO_IN))==0 ){
542 Expr *pRight = pTerm->pExpr->pRight;
543 if( (pTerm->wtFlags & TERM_IS)==0 && sqlite3ExprCanBeNull(pRight) ){
544 sqlite3VdbeAddOp2(v, OP_IsNull, regBase+j, pLevel->addrBrk);
545 VdbeCoverage(v);
546 }
547 if( zAff ){
548 if( sqlite3CompareAffinity(pRight, zAff[j])==SQLITE_AFF_BLOB ){
549 zAff[j] = SQLITE_AFF_BLOB;
550 }
551 if( sqlite3ExprNeedsNoAffinityChange(pRight, zAff[j]) ){
552 zAff[j] = SQLITE_AFF_BLOB;
553 }
554 }
555 }
556 }
557 *pzAff = zAff;
558 return regBase;
559}
560
drh41d2e662015-12-01 21:23:07 +0000561#ifndef SQLITE_LIKE_DOESNT_MATCH_BLOBS
drh6f82e852015-06-06 20:12:09 +0000562/*
563** If the most recently coded instruction is a constant range contraint
564** that originated from the LIKE optimization, then change the P3 to be
565** pLoop->iLikeRepCntr and set P5.
566**
567** The LIKE optimization trys to evaluate "x LIKE 'abc%'" as a range
568** expression: "x>='ABC' AND x<'abd'". But this requires that the range
569** scan loop run twice, once for strings and a second time for BLOBs.
570** The OP_String opcodes on the second pass convert the upper and lower
571** bound string contants to blobs. This routine makes the necessary changes
572** to the OP_String opcodes for that to happen.
drh41d2e662015-12-01 21:23:07 +0000573**
574** Except, of course, if SQLITE_LIKE_DOESNT_MATCH_BLOBS is defined, then
575** only the one pass through the string space is required, so this routine
576** becomes a no-op.
drh6f82e852015-06-06 20:12:09 +0000577*/
578static void whereLikeOptimizationStringFixup(
579 Vdbe *v, /* prepared statement under construction */
580 WhereLevel *pLevel, /* The loop that contains the LIKE operator */
581 WhereTerm *pTerm /* The upper or lower bound just coded */
582){
583 if( pTerm->wtFlags & TERM_LIKEOPT ){
584 VdbeOp *pOp;
585 assert( pLevel->iLikeRepCntr>0 );
586 pOp = sqlite3VdbeGetOp(v, -1);
587 assert( pOp!=0 );
588 assert( pOp->opcode==OP_String8
589 || pTerm->pWC->pWInfo->pParse->db->mallocFailed );
590 pOp->p3 = pLevel->iLikeRepCntr;
591 pOp->p5 = 1;
592 }
593}
drh41d2e662015-12-01 21:23:07 +0000594#else
595# define whereLikeOptimizationStringFixup(A,B,C)
596#endif
drh6f82e852015-06-06 20:12:09 +0000597
drhbec24762015-08-13 20:07:13 +0000598#ifdef SQLITE_ENABLE_CURSOR_HINTS
drh2f2b0272015-08-14 18:50:04 +0000599/*
600** Information is passed from codeCursorHint() down to individual nodes of
601** the expression tree (by sqlite3WalkExpr()) using an instance of this
602** structure.
603*/
604struct CCurHint {
605 int iTabCur; /* Cursor for the main table */
606 int iIdxCur; /* Cursor for the index, if pIdx!=0. Unused otherwise */
607 Index *pIdx; /* The index used to access the table */
608};
609
610/*
611** This function is called for every node of an expression that is a candidate
612** for a cursor hint on an index cursor. For TK_COLUMN nodes that reference
613** the table CCurHint.iTabCur, verify that the same column can be
614** accessed through the index. If it cannot, then set pWalker->eCode to 1.
615*/
616static int codeCursorHintCheckExpr(Walker *pWalker, Expr *pExpr){
617 struct CCurHint *pHint = pWalker->u.pCCurHint;
618 assert( pHint->pIdx!=0 );
619 if( pExpr->op==TK_COLUMN
620 && pExpr->iTable==pHint->iTabCur
621 && sqlite3ColumnOfIndex(pHint->pIdx, pExpr->iColumn)<0
622 ){
623 pWalker->eCode = 1;
624 }
625 return WRC_Continue;
626}
627
drhbec24762015-08-13 20:07:13 +0000628
629/*
630** This function is called on every node of an expression tree used as an
631** argument to the OP_CursorHint instruction. If the node is a TK_COLUMN
drh2f2b0272015-08-14 18:50:04 +0000632** that accesses any table other than the one identified by
633** CCurHint.iTabCur, then do the following:
drhbec24762015-08-13 20:07:13 +0000634**
635** 1) allocate a register and code an OP_Column instruction to read
636** the specified column into the new register, and
637**
638** 2) transform the expression node to a TK_REGISTER node that reads
639** from the newly populated register.
drh2f2b0272015-08-14 18:50:04 +0000640**
641** Also, if the node is a TK_COLUMN that does access the table idenified
642** by pCCurHint.iTabCur, and an index is being used (which we will
643** know because CCurHint.pIdx!=0) then transform the TK_COLUMN into
644** an access of the index rather than the original table.
drhbec24762015-08-13 20:07:13 +0000645*/
646static int codeCursorHintFixExpr(Walker *pWalker, Expr *pExpr){
647 int rc = WRC_Continue;
drh2f2b0272015-08-14 18:50:04 +0000648 struct CCurHint *pHint = pWalker->u.pCCurHint;
649 if( pExpr->op==TK_COLUMN ){
650 if( pExpr->iTable!=pHint->iTabCur ){
651 Vdbe *v = pWalker->pParse->pVdbe;
652 int reg = ++pWalker->pParse->nMem; /* Register for column value */
653 sqlite3ExprCodeGetColumnOfTable(
654 v, pExpr->pTab, pExpr->iTable, pExpr->iColumn, reg
655 );
656 pExpr->op = TK_REGISTER;
657 pExpr->iTable = reg;
658 }else if( pHint->pIdx!=0 ){
659 pExpr->iTable = pHint->iIdxCur;
660 pExpr->iColumn = sqlite3ColumnOfIndex(pHint->pIdx, pExpr->iColumn);
661 assert( pExpr->iColumn>=0 );
662 }
drhbec24762015-08-13 20:07:13 +0000663 }else if( pExpr->op==TK_AGG_FUNCTION ){
664 /* An aggregate function in the WHERE clause of a query means this must
665 ** be a correlated sub-query, and expression pExpr is an aggregate from
666 ** the parent context. Do not walk the function arguments in this case.
667 **
668 ** todo: It should be possible to replace this node with a TK_REGISTER
669 ** expression, as the result of the expression must be stored in a
670 ** register at this point. The same holds for TK_AGG_COLUMN nodes. */
671 rc = WRC_Prune;
672 }
673 return rc;
674}
675
676/*
677** Insert an OP_CursorHint instruction if it is appropriate to do so.
678*/
679static void codeCursorHint(
drhb413a542015-08-17 17:19:28 +0000680 WhereInfo *pWInfo, /* The where clause */
681 WhereLevel *pLevel, /* Which loop to provide hints for */
682 WhereTerm *pEndRange /* Hint this end-of-scan boundary term if not NULL */
drhbec24762015-08-13 20:07:13 +0000683){
684 Parse *pParse = pWInfo->pParse;
685 sqlite3 *db = pParse->db;
686 Vdbe *v = pParse->pVdbe;
drhbec24762015-08-13 20:07:13 +0000687 Expr *pExpr = 0;
drh2f2b0272015-08-14 18:50:04 +0000688 WhereLoop *pLoop = pLevel->pWLoop;
drhbec24762015-08-13 20:07:13 +0000689 int iCur;
690 WhereClause *pWC;
691 WhereTerm *pTerm;
drhb413a542015-08-17 17:19:28 +0000692 int i, j;
drh2f2b0272015-08-14 18:50:04 +0000693 struct CCurHint sHint;
694 Walker sWalker;
drhbec24762015-08-13 20:07:13 +0000695
696 if( OptimizationDisabled(db, SQLITE_CursorHints) ) return;
drh2f2b0272015-08-14 18:50:04 +0000697 iCur = pLevel->iTabCur;
698 assert( iCur==pWInfo->pTabList->a[pLevel->iFrom].iCursor );
699 sHint.iTabCur = iCur;
700 sHint.iIdxCur = pLevel->iIdxCur;
701 sHint.pIdx = pLoop->u.btree.pIndex;
702 memset(&sWalker, 0, sizeof(sWalker));
703 sWalker.pParse = pParse;
704 sWalker.u.pCCurHint = &sHint;
drhbec24762015-08-13 20:07:13 +0000705 pWC = &pWInfo->sWC;
706 for(i=0; i<pWC->nTerm; i++){
707 pTerm = &pWC->a[i];
708 if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
709 if( pTerm->prereqAll & pLevel->notReady ) continue;
710 if( ExprHasProperty(pTerm->pExpr, EP_FromJoin) ) continue;
drhb413a542015-08-17 17:19:28 +0000711
712 /* All terms in pWLoop->aLTerm[] except pEndRange are used to initialize
drhbcf40a72015-08-18 15:58:05 +0000713 ** the cursor. These terms are not needed as hints for a pure range
714 ** scan (that has no == terms) so omit them. */
715 if( pLoop->u.btree.nEq==0 && pTerm!=pEndRange ){
716 for(j=0; j<pLoop->nLTerm && pLoop->aLTerm[j]!=pTerm; j++){}
717 if( j<pLoop->nLTerm ) continue;
drhb413a542015-08-17 17:19:28 +0000718 }
719
720 /* No subqueries or non-deterministic functions allowed */
drhbec24762015-08-13 20:07:13 +0000721 if( sqlite3ExprContainsSubquery(pTerm->pExpr) ) continue;
drhb413a542015-08-17 17:19:28 +0000722
723 /* For an index scan, make sure referenced columns are actually in
724 ** the index. */
drh2f2b0272015-08-14 18:50:04 +0000725 if( sHint.pIdx!=0 ){
726 sWalker.eCode = 0;
727 sWalker.xExprCallback = codeCursorHintCheckExpr;
728 sqlite3WalkExpr(&sWalker, pTerm->pExpr);
729 if( sWalker.eCode ) continue;
730 }
drhb413a542015-08-17 17:19:28 +0000731
732 /* If we survive all prior tests, that means this term is worth hinting */
drhbec24762015-08-13 20:07:13 +0000733 pExpr = sqlite3ExprAnd(db, pExpr, sqlite3ExprDup(db, pTerm->pExpr, 0));
734 }
735 if( pExpr!=0 ){
drhbec24762015-08-13 20:07:13 +0000736 sWalker.xExprCallback = codeCursorHintFixExpr;
drhbec24762015-08-13 20:07:13 +0000737 sqlite3WalkExpr(&sWalker, pExpr);
drh2f2b0272015-08-14 18:50:04 +0000738 sqlite3VdbeAddOp4(v, OP_CursorHint,
739 (sHint.pIdx ? sHint.iIdxCur : sHint.iTabCur), 0, 0,
740 (const char*)pExpr, P4_EXPR);
drhbec24762015-08-13 20:07:13 +0000741 }
742}
743#else
drhb413a542015-08-17 17:19:28 +0000744# define codeCursorHint(A,B,C) /* No-op */
drhbec24762015-08-13 20:07:13 +0000745#endif /* SQLITE_ENABLE_CURSOR_HINTS */
drh6f82e852015-06-06 20:12:09 +0000746
747/*
dande892d92016-01-29 19:29:45 +0000748** Cursor iCur is open on an intkey b-tree (a table). Register iRowid contains
749** a rowid value just read from cursor iIdxCur, open on index pIdx. This
750** function generates code to do a deferred seek of cursor iCur to the
751** rowid stored in register iRowid.
752**
753** Normally, this is just:
754**
755** OP_Seek $iCur $iRowid
756**
757** However, if the scan currently being coded is a branch of an OR-loop and
758** the statement currently being coded is a SELECT, then P3 of the OP_Seek
759** is set to iIdxCur and P4 is set to point to an array of integers
760** containing one entry for each column of the table cursor iCur is open
761** on. For each table column, if the column is the i'th column of the
762** index, then the corresponding array entry is set to (i+1). If the column
763** does not appear in the index at all, the array entry is set to 0.
764*/
765static void codeDeferredSeek(
766 WhereInfo *pWInfo, /* Where clause context */
767 Index *pIdx, /* Index scan is using */
768 int iCur, /* Cursor for IPK b-tree */
dande892d92016-01-29 19:29:45 +0000769 int iIdxCur /* Index cursor */
770){
771 Parse *pParse = pWInfo->pParse; /* Parse context */
772 Vdbe *v = pParse->pVdbe; /* Vdbe to generate code within */
773
774 assert( iIdxCur>0 );
775 assert( pIdx->aiColumn[pIdx->nColumn-1]==-1 );
776
drh784c1b92016-01-30 16:59:56 +0000777 sqlite3VdbeAddOp3(v, OP_Seek, iIdxCur, 0, iCur);
dande892d92016-01-29 19:29:45 +0000778 if( (pWInfo->wctrlFlags & WHERE_FORCE_TABLE)
dancddb6ba2016-02-01 13:58:56 +0000779 && DbMaskAllZero(sqlite3ParseToplevel(pParse)->writeMask)
dande892d92016-01-29 19:29:45 +0000780 ){
781 int i;
782 Table *pTab = pIdx->pTable;
drhb1702022016-01-30 00:45:18 +0000783 int *ai = (int*)sqlite3DbMallocZero(pParse->db, sizeof(int)*(pTab->nCol+1));
dande892d92016-01-29 19:29:45 +0000784 if( ai ){
drhb1702022016-01-30 00:45:18 +0000785 ai[0] = pTab->nCol;
dande892d92016-01-29 19:29:45 +0000786 for(i=0; i<pIdx->nColumn-1; i++){
787 assert( pIdx->aiColumn[i]<pTab->nCol );
drhb1702022016-01-30 00:45:18 +0000788 if( pIdx->aiColumn[i]>=0 ) ai[pIdx->aiColumn[i]+1] = i+1;
dande892d92016-01-29 19:29:45 +0000789 }
790 sqlite3VdbeChangeP4(v, -1, (char*)ai, P4_INTARRAY);
791 }
792 }
793}
794
795/*
drh6f82e852015-06-06 20:12:09 +0000796** Generate code for the start of the iLevel-th loop in the WHERE clause
797** implementation described by pWInfo.
798*/
799Bitmask sqlite3WhereCodeOneLoopStart(
800 WhereInfo *pWInfo, /* Complete information about the WHERE clause */
801 int iLevel, /* Which level of pWInfo->a[] should be coded */
802 Bitmask notReady /* Which tables are currently available */
803){
804 int j, k; /* Loop counters */
805 int iCur; /* The VDBE cursor for the table */
806 int addrNxt; /* Where to jump to continue with the next IN case */
807 int omitTable; /* True if we use the index only */
808 int bRev; /* True if we need to scan in reverse order */
809 WhereLevel *pLevel; /* The where level to be coded */
810 WhereLoop *pLoop; /* The WhereLoop object being coded */
811 WhereClause *pWC; /* Decomposition of the entire WHERE clause */
812 WhereTerm *pTerm; /* A WHERE clause term */
813 Parse *pParse; /* Parsing context */
814 sqlite3 *db; /* Database connection */
815 Vdbe *v; /* The prepared stmt under constructions */
816 struct SrcList_item *pTabItem; /* FROM clause term being coded */
817 int addrBrk; /* Jump here to break out of the loop */
818 int addrCont; /* Jump here to continue with next cycle */
819 int iRowidReg = 0; /* Rowid is stored in this register, if not zero */
820 int iReleaseReg = 0; /* Temp register to free before returning */
821
822 pParse = pWInfo->pParse;
823 v = pParse->pVdbe;
824 pWC = &pWInfo->sWC;
825 db = pParse->db;
826 pLevel = &pWInfo->a[iLevel];
827 pLoop = pLevel->pWLoop;
828 pTabItem = &pWInfo->pTabList->a[pLevel->iFrom];
829 iCur = pTabItem->iCursor;
830 pLevel->notReady = notReady & ~sqlite3WhereGetMask(&pWInfo->sMaskSet, iCur);
831 bRev = (pWInfo->revMask>>iLevel)&1;
832 omitTable = (pLoop->wsFlags & WHERE_IDX_ONLY)!=0
833 && (pWInfo->wctrlFlags & WHERE_FORCE_TABLE)==0;
834 VdbeModuleComment((v, "Begin WHERE-loop%d: %s",iLevel,pTabItem->pTab->zName));
835
836 /* Create labels for the "break" and "continue" instructions
837 ** for the current loop. Jump to addrBrk to break out of a loop.
838 ** Jump to cont to go immediately to the next iteration of the
839 ** loop.
840 **
841 ** When there is an IN operator, we also have a "addrNxt" label that
842 ** means to continue with the next IN value combination. When
843 ** there are no IN operators in the constraints, the "addrNxt" label
844 ** is the same as "addrBrk".
845 */
846 addrBrk = pLevel->addrBrk = pLevel->addrNxt = sqlite3VdbeMakeLabel(v);
847 addrCont = pLevel->addrCont = sqlite3VdbeMakeLabel(v);
848
849 /* If this is the right table of a LEFT OUTER JOIN, allocate and
850 ** initialize a memory cell that records if this table matches any
851 ** row of the left table of the join.
852 */
drh8a48b9c2015-08-19 15:20:00 +0000853 if( pLevel->iFrom>0 && (pTabItem[0].fg.jointype & JT_LEFT)!=0 ){
drh6f82e852015-06-06 20:12:09 +0000854 pLevel->iLeftJoin = ++pParse->nMem;
855 sqlite3VdbeAddOp2(v, OP_Integer, 0, pLevel->iLeftJoin);
856 VdbeComment((v, "init LEFT JOIN no-match flag"));
857 }
858
859 /* Special case of a FROM clause subquery implemented as a co-routine */
drh8a48b9c2015-08-19 15:20:00 +0000860 if( pTabItem->fg.viaCoroutine ){
drh6f82e852015-06-06 20:12:09 +0000861 int regYield = pTabItem->regReturn;
862 sqlite3VdbeAddOp3(v, OP_InitCoroutine, regYield, 0, pTabItem->addrFillSub);
863 pLevel->p2 = sqlite3VdbeAddOp2(v, OP_Yield, regYield, addrBrk);
864 VdbeCoverage(v);
865 VdbeComment((v, "next row of \"%s\"", pTabItem->pTab->zName));
866 pLevel->op = OP_Goto;
867 }else
868
869#ifndef SQLITE_OMIT_VIRTUALTABLE
870 if( (pLoop->wsFlags & WHERE_VIRTUALTABLE)!=0 ){
871 /* Case 1: The table is a virtual-table. Use the VFilter and VNext
872 ** to access the data.
873 */
874 int iReg; /* P3 Value for OP_VFilter */
875 int addrNotFound;
876 int nConstraint = pLoop->nLTerm;
877
878 sqlite3ExprCachePush(pParse);
879 iReg = sqlite3GetTempRange(pParse, nConstraint+2);
880 addrNotFound = pLevel->addrBrk;
881 for(j=0; j<nConstraint; j++){
882 int iTarget = iReg+j+2;
883 pTerm = pLoop->aLTerm[j];
884 if( pTerm==0 ) continue;
885 if( pTerm->eOperator & WO_IN ){
886 codeEqualityTerm(pParse, pTerm, pLevel, j, bRev, iTarget);
887 addrNotFound = pLevel->addrNxt;
888 }else{
889 sqlite3ExprCode(pParse, pTerm->pExpr->pRight, iTarget);
890 }
891 }
892 sqlite3VdbeAddOp2(v, OP_Integer, pLoop->u.vtab.idxNum, iReg);
893 sqlite3VdbeAddOp2(v, OP_Integer, nConstraint, iReg+1);
894 sqlite3VdbeAddOp4(v, OP_VFilter, iCur, addrNotFound, iReg,
895 pLoop->u.vtab.idxStr,
896 pLoop->u.vtab.needFree ? P4_MPRINTF : P4_STATIC);
897 VdbeCoverage(v);
898 pLoop->u.vtab.needFree = 0;
899 for(j=0; j<nConstraint && j<16; j++){
900 if( (pLoop->u.vtab.omitMask>>j)&1 ){
901 disableTerm(pLevel, pLoop->aLTerm[j]);
902 }
903 }
drh6f82e852015-06-06 20:12:09 +0000904 pLevel->p1 = iCur;
dan354474a2015-09-29 10:11:26 +0000905 pLevel->op = pWInfo->eOnePass ? OP_Noop : OP_VNext;
drh6f82e852015-06-06 20:12:09 +0000906 pLevel->p2 = sqlite3VdbeCurrentAddr(v);
907 sqlite3ReleaseTempRange(pParse, iReg, nConstraint+2);
908 sqlite3ExprCachePop(pParse);
909 }else
910#endif /* SQLITE_OMIT_VIRTUALTABLE */
911
912 if( (pLoop->wsFlags & WHERE_IPK)!=0
913 && (pLoop->wsFlags & (WHERE_COLUMN_IN|WHERE_COLUMN_EQ))!=0
914 ){
915 /* Case 2: We can directly reference a single row using an
916 ** equality comparison against the ROWID field. Or
917 ** we reference multiple rows using a "rowid IN (...)"
918 ** construct.
919 */
920 assert( pLoop->u.btree.nEq==1 );
921 pTerm = pLoop->aLTerm[0];
922 assert( pTerm!=0 );
923 assert( pTerm->pExpr!=0 );
924 assert( omitTable==0 );
925 testcase( pTerm->wtFlags & TERM_VIRTUAL );
926 iReleaseReg = ++pParse->nMem;
927 iRowidReg = codeEqualityTerm(pParse, pTerm, pLevel, 0, bRev, iReleaseReg);
928 if( iRowidReg!=iReleaseReg ) sqlite3ReleaseTempReg(pParse, iReleaseReg);
929 addrNxt = pLevel->addrNxt;
930 sqlite3VdbeAddOp2(v, OP_MustBeInt, iRowidReg, addrNxt); VdbeCoverage(v);
931 sqlite3VdbeAddOp3(v, OP_NotExists, iCur, addrNxt, iRowidReg);
932 VdbeCoverage(v);
933 sqlite3ExprCacheAffinityChange(pParse, iRowidReg, 1);
934 sqlite3ExprCacheStore(pParse, iCur, -1, iRowidReg);
935 VdbeComment((v, "pk"));
936 pLevel->op = OP_Noop;
937 }else if( (pLoop->wsFlags & WHERE_IPK)!=0
938 && (pLoop->wsFlags & WHERE_COLUMN_RANGE)!=0
939 ){
940 /* Case 3: We have an inequality comparison against the ROWID field.
941 */
942 int testOp = OP_Noop;
943 int start;
944 int memEndValue = 0;
945 WhereTerm *pStart, *pEnd;
946
947 assert( omitTable==0 );
948 j = 0;
949 pStart = pEnd = 0;
950 if( pLoop->wsFlags & WHERE_BTM_LIMIT ) pStart = pLoop->aLTerm[j++];
951 if( pLoop->wsFlags & WHERE_TOP_LIMIT ) pEnd = pLoop->aLTerm[j++];
952 assert( pStart!=0 || pEnd!=0 );
953 if( bRev ){
954 pTerm = pStart;
955 pStart = pEnd;
956 pEnd = pTerm;
957 }
drhb413a542015-08-17 17:19:28 +0000958 codeCursorHint(pWInfo, pLevel, pEnd);
drh6f82e852015-06-06 20:12:09 +0000959 if( pStart ){
960 Expr *pX; /* The expression that defines the start bound */
961 int r1, rTemp; /* Registers for holding the start boundary */
962
963 /* The following constant maps TK_xx codes into corresponding
964 ** seek opcodes. It depends on a particular ordering of TK_xx
965 */
966 const u8 aMoveOp[] = {
967 /* TK_GT */ OP_SeekGT,
968 /* TK_LE */ OP_SeekLE,
969 /* TK_LT */ OP_SeekLT,
970 /* TK_GE */ OP_SeekGE
971 };
972 assert( TK_LE==TK_GT+1 ); /* Make sure the ordering.. */
973 assert( TK_LT==TK_GT+2 ); /* ... of the TK_xx values... */
974 assert( TK_GE==TK_GT+3 ); /* ... is correcct. */
975
976 assert( (pStart->wtFlags & TERM_VNULL)==0 );
977 testcase( pStart->wtFlags & TERM_VIRTUAL );
978 pX = pStart->pExpr;
979 assert( pX!=0 );
980 testcase( pStart->leftCursor!=iCur ); /* transitive constraints */
981 r1 = sqlite3ExprCodeTemp(pParse, pX->pRight, &rTemp);
982 sqlite3VdbeAddOp3(v, aMoveOp[pX->op-TK_GT], iCur, addrBrk, r1);
983 VdbeComment((v, "pk"));
984 VdbeCoverageIf(v, pX->op==TK_GT);
985 VdbeCoverageIf(v, pX->op==TK_LE);
986 VdbeCoverageIf(v, pX->op==TK_LT);
987 VdbeCoverageIf(v, pX->op==TK_GE);
988 sqlite3ExprCacheAffinityChange(pParse, r1, 1);
989 sqlite3ReleaseTempReg(pParse, rTemp);
990 disableTerm(pLevel, pStart);
991 }else{
992 sqlite3VdbeAddOp2(v, bRev ? OP_Last : OP_Rewind, iCur, addrBrk);
993 VdbeCoverageIf(v, bRev==0);
994 VdbeCoverageIf(v, bRev!=0);
995 }
996 if( pEnd ){
997 Expr *pX;
998 pX = pEnd->pExpr;
999 assert( pX!=0 );
1000 assert( (pEnd->wtFlags & TERM_VNULL)==0 );
1001 testcase( pEnd->leftCursor!=iCur ); /* Transitive constraints */
1002 testcase( pEnd->wtFlags & TERM_VIRTUAL );
1003 memEndValue = ++pParse->nMem;
1004 sqlite3ExprCode(pParse, pX->pRight, memEndValue);
1005 if( pX->op==TK_LT || pX->op==TK_GT ){
1006 testOp = bRev ? OP_Le : OP_Ge;
1007 }else{
1008 testOp = bRev ? OP_Lt : OP_Gt;
1009 }
1010 disableTerm(pLevel, pEnd);
1011 }
1012 start = sqlite3VdbeCurrentAddr(v);
1013 pLevel->op = bRev ? OP_Prev : OP_Next;
1014 pLevel->p1 = iCur;
1015 pLevel->p2 = start;
1016 assert( pLevel->p5==0 );
1017 if( testOp!=OP_Noop ){
1018 iRowidReg = ++pParse->nMem;
1019 sqlite3VdbeAddOp2(v, OP_Rowid, iCur, iRowidReg);
1020 sqlite3ExprCacheStore(pParse, iCur, -1, iRowidReg);
1021 sqlite3VdbeAddOp3(v, testOp, memEndValue, addrBrk, iRowidReg);
1022 VdbeCoverageIf(v, testOp==OP_Le);
1023 VdbeCoverageIf(v, testOp==OP_Lt);
1024 VdbeCoverageIf(v, testOp==OP_Ge);
1025 VdbeCoverageIf(v, testOp==OP_Gt);
1026 sqlite3VdbeChangeP5(v, SQLITE_AFF_NUMERIC | SQLITE_JUMPIFNULL);
1027 }
1028 }else if( pLoop->wsFlags & WHERE_INDEXED ){
1029 /* Case 4: A scan using an index.
1030 **
1031 ** The WHERE clause may contain zero or more equality
1032 ** terms ("==" or "IN" operators) that refer to the N
1033 ** left-most columns of the index. It may also contain
1034 ** inequality constraints (>, <, >= or <=) on the indexed
1035 ** column that immediately follows the N equalities. Only
1036 ** the right-most column can be an inequality - the rest must
1037 ** use the "==" and "IN" operators. For example, if the
1038 ** index is on (x,y,z), then the following clauses are all
1039 ** optimized:
1040 **
1041 ** x=5
1042 ** x=5 AND y=10
1043 ** x=5 AND y<10
1044 ** x=5 AND y>5 AND y<10
1045 ** x=5 AND y=5 AND z<=10
1046 **
1047 ** The z<10 term of the following cannot be used, only
1048 ** the x=5 term:
1049 **
1050 ** x=5 AND z<10
1051 **
1052 ** N may be zero if there are inequality constraints.
1053 ** If there are no inequality constraints, then N is at
1054 ** least one.
1055 **
1056 ** This case is also used when there are no WHERE clause
1057 ** constraints but an index is selected anyway, in order
1058 ** to force the output order to conform to an ORDER BY.
1059 */
1060 static const u8 aStartOp[] = {
1061 0,
1062 0,
1063 OP_Rewind, /* 2: (!start_constraints && startEq && !bRev) */
1064 OP_Last, /* 3: (!start_constraints && startEq && bRev) */
1065 OP_SeekGT, /* 4: (start_constraints && !startEq && !bRev) */
1066 OP_SeekLT, /* 5: (start_constraints && !startEq && bRev) */
1067 OP_SeekGE, /* 6: (start_constraints && startEq && !bRev) */
1068 OP_SeekLE /* 7: (start_constraints && startEq && bRev) */
1069 };
1070 static const u8 aEndOp[] = {
1071 OP_IdxGE, /* 0: (end_constraints && !bRev && !endEq) */
1072 OP_IdxGT, /* 1: (end_constraints && !bRev && endEq) */
1073 OP_IdxLE, /* 2: (end_constraints && bRev && !endEq) */
1074 OP_IdxLT, /* 3: (end_constraints && bRev && endEq) */
1075 };
1076 u16 nEq = pLoop->u.btree.nEq; /* Number of == or IN terms */
1077 int regBase; /* Base register holding constraint values */
1078 WhereTerm *pRangeStart = 0; /* Inequality constraint at range start */
1079 WhereTerm *pRangeEnd = 0; /* Inequality constraint at range end */
1080 int startEq; /* True if range start uses ==, >= or <= */
1081 int endEq; /* True if range end uses ==, >= or <= */
1082 int start_constraints; /* Start of range is constrained */
1083 int nConstraint; /* Number of constraint terms */
1084 Index *pIdx; /* The index we will be using */
1085 int iIdxCur; /* The VDBE cursor for the index */
1086 int nExtraReg = 0; /* Number of extra registers needed */
1087 int op; /* Instruction opcode */
1088 char *zStartAff; /* Affinity for start of range constraint */
1089 char cEndAff = 0; /* Affinity for end of range constraint */
1090 u8 bSeekPastNull = 0; /* True to seek past initial nulls */
1091 u8 bStopAtNull = 0; /* Add condition to terminate at NULLs */
1092
1093 pIdx = pLoop->u.btree.pIndex;
1094 iIdxCur = pLevel->iIdxCur;
1095 assert( nEq>=pLoop->nSkip );
1096
1097 /* If this loop satisfies a sort order (pOrderBy) request that
1098 ** was passed to this function to implement a "SELECT min(x) ..."
1099 ** query, then the caller will only allow the loop to run for
1100 ** a single iteration. This means that the first row returned
1101 ** should not have a NULL value stored in 'x'. If column 'x' is
1102 ** the first one after the nEq equality constraints in the index,
1103 ** this requires some special handling.
1104 */
1105 assert( pWInfo->pOrderBy==0
1106 || pWInfo->pOrderBy->nExpr==1
1107 || (pWInfo->wctrlFlags&WHERE_ORDERBY_MIN)==0 );
1108 if( (pWInfo->wctrlFlags&WHERE_ORDERBY_MIN)!=0
1109 && pWInfo->nOBSat>0
1110 && (pIdx->nKeyCol>nEq)
1111 ){
1112 assert( pLoop->nSkip==0 );
1113 bSeekPastNull = 1;
1114 nExtraReg = 1;
1115 }
1116
1117 /* Find any inequality constraint terms for the start and end
1118 ** of the range.
1119 */
1120 j = nEq;
1121 if( pLoop->wsFlags & WHERE_BTM_LIMIT ){
1122 pRangeStart = pLoop->aLTerm[j++];
1123 nExtraReg = 1;
1124 /* Like optimization range constraints always occur in pairs */
1125 assert( (pRangeStart->wtFlags & TERM_LIKEOPT)==0 ||
1126 (pLoop->wsFlags & WHERE_TOP_LIMIT)!=0 );
1127 }
1128 if( pLoop->wsFlags & WHERE_TOP_LIMIT ){
1129 pRangeEnd = pLoop->aLTerm[j++];
1130 nExtraReg = 1;
drh41d2e662015-12-01 21:23:07 +00001131#ifndef SQLITE_LIKE_DOESNT_MATCH_BLOBS
drh6f82e852015-06-06 20:12:09 +00001132 if( (pRangeEnd->wtFlags & TERM_LIKEOPT)!=0 ){
1133 assert( pRangeStart!=0 ); /* LIKE opt constraints */
1134 assert( pRangeStart->wtFlags & TERM_LIKEOPT ); /* occur in pairs */
1135 pLevel->iLikeRepCntr = ++pParse->nMem;
1136 testcase( bRev );
1137 testcase( pIdx->aSortOrder[nEq]==SQLITE_SO_DESC );
1138 sqlite3VdbeAddOp2(v, OP_Integer,
1139 bRev ^ (pIdx->aSortOrder[nEq]==SQLITE_SO_DESC),
1140 pLevel->iLikeRepCntr);
1141 VdbeComment((v, "LIKE loop counter"));
1142 pLevel->addrLikeRep = sqlite3VdbeCurrentAddr(v);
1143 }
drh41d2e662015-12-01 21:23:07 +00001144#endif
drh6f82e852015-06-06 20:12:09 +00001145 if( pRangeStart==0
1146 && (j = pIdx->aiColumn[nEq])>=0
1147 && pIdx->pTable->aCol[j].notNull==0
1148 ){
1149 bSeekPastNull = 1;
1150 }
1151 }
1152 assert( pRangeEnd==0 || (pRangeEnd->wtFlags & TERM_VNULL)==0 );
1153
drh6f82e852015-06-06 20:12:09 +00001154 /* If we are doing a reverse order scan on an ascending index, or
1155 ** a forward order scan on a descending index, interchange the
1156 ** start and end terms (pRangeStart and pRangeEnd).
1157 */
1158 if( (nEq<pIdx->nKeyCol && bRev==(pIdx->aSortOrder[nEq]==SQLITE_SO_ASC))
1159 || (bRev && pIdx->nKeyCol==nEq)
1160 ){
1161 SWAP(WhereTerm *, pRangeEnd, pRangeStart);
1162 SWAP(u8, bSeekPastNull, bStopAtNull);
1163 }
1164
drhbcf40a72015-08-18 15:58:05 +00001165 /* Generate code to evaluate all constraint terms using == or IN
1166 ** and store the values of those terms in an array of registers
1167 ** starting at regBase.
1168 */
1169 codeCursorHint(pWInfo, pLevel, pRangeEnd);
1170 regBase = codeAllEqualityTerms(pParse,pLevel,bRev,nExtraReg,&zStartAff);
1171 assert( zStartAff==0 || sqlite3Strlen30(zStartAff)>=nEq );
1172 if( zStartAff ) cEndAff = zStartAff[nEq];
1173 addrNxt = pLevel->addrNxt;
1174
drh6f82e852015-06-06 20:12:09 +00001175 testcase( pRangeStart && (pRangeStart->eOperator & WO_LE)!=0 );
1176 testcase( pRangeStart && (pRangeStart->eOperator & WO_GE)!=0 );
1177 testcase( pRangeEnd && (pRangeEnd->eOperator & WO_LE)!=0 );
1178 testcase( pRangeEnd && (pRangeEnd->eOperator & WO_GE)!=0 );
1179 startEq = !pRangeStart || pRangeStart->eOperator & (WO_LE|WO_GE);
1180 endEq = !pRangeEnd || pRangeEnd->eOperator & (WO_LE|WO_GE);
1181 start_constraints = pRangeStart || nEq>0;
1182
1183 /* Seek the index cursor to the start of the range. */
1184 nConstraint = nEq;
1185 if( pRangeStart ){
1186 Expr *pRight = pRangeStart->pExpr->pRight;
1187 sqlite3ExprCode(pParse, pRight, regBase+nEq);
1188 whereLikeOptimizationStringFixup(v, pLevel, pRangeStart);
1189 if( (pRangeStart->wtFlags & TERM_VNULL)==0
1190 && sqlite3ExprCanBeNull(pRight)
1191 ){
1192 sqlite3VdbeAddOp2(v, OP_IsNull, regBase+nEq, addrNxt);
1193 VdbeCoverage(v);
1194 }
1195 if( zStartAff ){
1196 if( sqlite3CompareAffinity(pRight, zStartAff[nEq])==SQLITE_AFF_BLOB){
1197 /* Since the comparison is to be performed with no conversions
1198 ** applied to the operands, set the affinity to apply to pRight to
1199 ** SQLITE_AFF_BLOB. */
1200 zStartAff[nEq] = SQLITE_AFF_BLOB;
1201 }
1202 if( sqlite3ExprNeedsNoAffinityChange(pRight, zStartAff[nEq]) ){
1203 zStartAff[nEq] = SQLITE_AFF_BLOB;
1204 }
1205 }
1206 nConstraint++;
1207 testcase( pRangeStart->wtFlags & TERM_VIRTUAL );
1208 }else if( bSeekPastNull ){
1209 sqlite3VdbeAddOp2(v, OP_Null, 0, regBase+nEq);
1210 nConstraint++;
1211 startEq = 0;
1212 start_constraints = 1;
1213 }
1214 codeApplyAffinity(pParse, regBase, nConstraint - bSeekPastNull, zStartAff);
drh0bf2ad62016-02-22 21:19:54 +00001215 if( pLoop->nSkip>0 && nConstraint==pLoop->nSkip ){
1216 /* The skip-scan logic inside the call to codeAllEqualityConstraints()
1217 ** above has already left the cursor sitting on the correct row,
1218 ** so no further seeking is needed */
1219 }else{
drha6d2f8e2016-02-22 20:52:26 +00001220 op = aStartOp[(start_constraints<<2) + (startEq<<1) + bRev];
1221 assert( op!=0 );
1222 sqlite3VdbeAddOp4Int(v, op, iIdxCur, addrNxt, regBase, nConstraint);
1223 VdbeCoverage(v);
1224 VdbeCoverageIf(v, op==OP_Rewind); testcase( op==OP_Rewind );
1225 VdbeCoverageIf(v, op==OP_Last); testcase( op==OP_Last );
1226 VdbeCoverageIf(v, op==OP_SeekGT); testcase( op==OP_SeekGT );
1227 VdbeCoverageIf(v, op==OP_SeekGE); testcase( op==OP_SeekGE );
1228 VdbeCoverageIf(v, op==OP_SeekLE); testcase( op==OP_SeekLE );
1229 VdbeCoverageIf(v, op==OP_SeekLT); testcase( op==OP_SeekLT );
1230 }
drh0bf2ad62016-02-22 21:19:54 +00001231
drh6f82e852015-06-06 20:12:09 +00001232 /* Load the value for the inequality constraint at the end of the
1233 ** range (if any).
1234 */
1235 nConstraint = nEq;
1236 if( pRangeEnd ){
1237 Expr *pRight = pRangeEnd->pExpr->pRight;
1238 sqlite3ExprCacheRemove(pParse, regBase+nEq, 1);
1239 sqlite3ExprCode(pParse, pRight, regBase+nEq);
1240 whereLikeOptimizationStringFixup(v, pLevel, pRangeEnd);
1241 if( (pRangeEnd->wtFlags & TERM_VNULL)==0
1242 && sqlite3ExprCanBeNull(pRight)
1243 ){
1244 sqlite3VdbeAddOp2(v, OP_IsNull, regBase+nEq, addrNxt);
1245 VdbeCoverage(v);
1246 }
1247 if( sqlite3CompareAffinity(pRight, cEndAff)!=SQLITE_AFF_BLOB
1248 && !sqlite3ExprNeedsNoAffinityChange(pRight, cEndAff)
1249 ){
1250 codeApplyAffinity(pParse, regBase+nEq, 1, &cEndAff);
1251 }
1252 nConstraint++;
1253 testcase( pRangeEnd->wtFlags & TERM_VIRTUAL );
1254 }else if( bStopAtNull ){
1255 sqlite3VdbeAddOp2(v, OP_Null, 0, regBase+nEq);
1256 endEq = 0;
1257 nConstraint++;
1258 }
1259 sqlite3DbFree(db, zStartAff);
1260
1261 /* Top of the loop body */
1262 pLevel->p2 = sqlite3VdbeCurrentAddr(v);
1263
1264 /* Check if the index cursor is past the end of the range. */
1265 if( nConstraint ){
1266 op = aEndOp[bRev*2 + endEq];
1267 sqlite3VdbeAddOp4Int(v, op, iIdxCur, addrNxt, regBase, nConstraint);
1268 testcase( op==OP_IdxGT ); VdbeCoverageIf(v, op==OP_IdxGT );
1269 testcase( op==OP_IdxGE ); VdbeCoverageIf(v, op==OP_IdxGE );
1270 testcase( op==OP_IdxLT ); VdbeCoverageIf(v, op==OP_IdxLT );
1271 testcase( op==OP_IdxLE ); VdbeCoverageIf(v, op==OP_IdxLE );
1272 }
1273
1274 /* Seek the table cursor, if required */
1275 disableTerm(pLevel, pRangeStart);
1276 disableTerm(pLevel, pRangeEnd);
1277 if( omitTable ){
1278 /* pIdx is a covering index. No need to access the main table. */
1279 }else if( HasRowid(pIdx->pTable) ){
drhb0264ee2015-09-14 14:45:50 +00001280 if( pWInfo->eOnePass!=ONEPASS_OFF ){
drh784c1b92016-01-30 16:59:56 +00001281 iRowidReg = ++pParse->nMem;
1282 sqlite3VdbeAddOp2(v, OP_IdxRowid, iIdxCur, iRowidReg);
1283 sqlite3ExprCacheStore(pParse, iCur, -1, iRowidReg);
danc6157e12015-09-14 09:23:47 +00001284 sqlite3VdbeAddOp3(v, OP_NotExists, iCur, 0, iRowidReg);
drh66336f32015-09-14 14:08:25 +00001285 VdbeCoverage(v);
danc6157e12015-09-14 09:23:47 +00001286 }else{
drh784c1b92016-01-30 16:59:56 +00001287 codeDeferredSeek(pWInfo, pIdx, iCur, iIdxCur);
danc6157e12015-09-14 09:23:47 +00001288 }
drh6f82e852015-06-06 20:12:09 +00001289 }else if( iCur!=iIdxCur ){
1290 Index *pPk = sqlite3PrimaryKeyIndex(pIdx->pTable);
1291 iRowidReg = sqlite3GetTempRange(pParse, pPk->nKeyCol);
1292 for(j=0; j<pPk->nKeyCol; j++){
1293 k = sqlite3ColumnOfIndex(pIdx, pPk->aiColumn[j]);
1294 sqlite3VdbeAddOp3(v, OP_Column, iIdxCur, k, iRowidReg+j);
1295 }
1296 sqlite3VdbeAddOp4Int(v, OP_NotFound, iCur, addrCont,
1297 iRowidReg, pPk->nKeyCol); VdbeCoverage(v);
1298 }
1299
1300 /* Record the instruction used to terminate the loop. Disable
1301 ** WHERE clause terms made redundant by the index range scan.
1302 */
1303 if( pLoop->wsFlags & WHERE_ONEROW ){
1304 pLevel->op = OP_Noop;
1305 }else if( bRev ){
1306 pLevel->op = OP_Prev;
1307 }else{
1308 pLevel->op = OP_Next;
1309 }
1310 pLevel->p1 = iIdxCur;
1311 pLevel->p3 = (pLoop->wsFlags&WHERE_UNQ_WANTED)!=0 ? 1:0;
1312 if( (pLoop->wsFlags & WHERE_CONSTRAINT)==0 ){
1313 pLevel->p5 = SQLITE_STMTSTATUS_FULLSCAN_STEP;
1314 }else{
1315 assert( pLevel->p5==0 );
1316 }
1317 }else
1318
1319#ifndef SQLITE_OMIT_OR_OPTIMIZATION
1320 if( pLoop->wsFlags & WHERE_MULTI_OR ){
1321 /* Case 5: Two or more separately indexed terms connected by OR
1322 **
1323 ** Example:
1324 **
1325 ** CREATE TABLE t1(a,b,c,d);
1326 ** CREATE INDEX i1 ON t1(a);
1327 ** CREATE INDEX i2 ON t1(b);
1328 ** CREATE INDEX i3 ON t1(c);
1329 **
1330 ** SELECT * FROM t1 WHERE a=5 OR b=7 OR (c=11 AND d=13)
1331 **
1332 ** In the example, there are three indexed terms connected by OR.
1333 ** The top of the loop looks like this:
1334 **
1335 ** Null 1 # Zero the rowset in reg 1
1336 **
1337 ** Then, for each indexed term, the following. The arguments to
1338 ** RowSetTest are such that the rowid of the current row is inserted
1339 ** into the RowSet. If it is already present, control skips the
1340 ** Gosub opcode and jumps straight to the code generated by WhereEnd().
1341 **
1342 ** sqlite3WhereBegin(<term>)
1343 ** RowSetTest # Insert rowid into rowset
1344 ** Gosub 2 A
1345 ** sqlite3WhereEnd()
1346 **
1347 ** Following the above, code to terminate the loop. Label A, the target
1348 ** of the Gosub above, jumps to the instruction right after the Goto.
1349 **
1350 ** Null 1 # Zero the rowset in reg 1
1351 ** Goto B # The loop is finished.
1352 **
1353 ** A: <loop body> # Return data, whatever.
1354 **
1355 ** Return 2 # Jump back to the Gosub
1356 **
1357 ** B: <after the loop>
1358 **
1359 ** Added 2014-05-26: If the table is a WITHOUT ROWID table, then
1360 ** use an ephemeral index instead of a RowSet to record the primary
1361 ** keys of the rows we have already seen.
1362 **
1363 */
1364 WhereClause *pOrWc; /* The OR-clause broken out into subterms */
1365 SrcList *pOrTab; /* Shortened table list or OR-clause generation */
1366 Index *pCov = 0; /* Potential covering index (or NULL) */
1367 int iCovCur = pParse->nTab++; /* Cursor used for index scans (if any) */
1368
1369 int regReturn = ++pParse->nMem; /* Register used with OP_Gosub */
1370 int regRowset = 0; /* Register for RowSet object */
1371 int regRowid = 0; /* Register holding rowid */
1372 int iLoopBody = sqlite3VdbeMakeLabel(v); /* Start of loop body */
1373 int iRetInit; /* Address of regReturn init */
1374 int untestedTerms = 0; /* Some terms not completely tested */
1375 int ii; /* Loop counter */
1376 u16 wctrlFlags; /* Flags for sub-WHERE clause */
1377 Expr *pAndExpr = 0; /* An ".. AND (...)" expression */
1378 Table *pTab = pTabItem->pTab;
1379
1380 pTerm = pLoop->aLTerm[0];
1381 assert( pTerm!=0 );
1382 assert( pTerm->eOperator & WO_OR );
1383 assert( (pTerm->wtFlags & TERM_ORINFO)!=0 );
1384 pOrWc = &pTerm->u.pOrInfo->wc;
1385 pLevel->op = OP_Return;
1386 pLevel->p1 = regReturn;
1387
1388 /* Set up a new SrcList in pOrTab containing the table being scanned
1389 ** by this loop in the a[0] slot and all notReady tables in a[1..] slots.
1390 ** This becomes the SrcList in the recursive call to sqlite3WhereBegin().
1391 */
1392 if( pWInfo->nLevel>1 ){
1393 int nNotReady; /* The number of notReady tables */
1394 struct SrcList_item *origSrc; /* Original list of tables */
1395 nNotReady = pWInfo->nLevel - iLevel - 1;
1396 pOrTab = sqlite3StackAllocRaw(db,
1397 sizeof(*pOrTab)+ nNotReady*sizeof(pOrTab->a[0]));
1398 if( pOrTab==0 ) return notReady;
1399 pOrTab->nAlloc = (u8)(nNotReady + 1);
1400 pOrTab->nSrc = pOrTab->nAlloc;
1401 memcpy(pOrTab->a, pTabItem, sizeof(*pTabItem));
1402 origSrc = pWInfo->pTabList->a;
1403 for(k=1; k<=nNotReady; k++){
1404 memcpy(&pOrTab->a[k], &origSrc[pLevel[k].iFrom], sizeof(pOrTab->a[k]));
1405 }
1406 }else{
1407 pOrTab = pWInfo->pTabList;
1408 }
1409
1410 /* Initialize the rowset register to contain NULL. An SQL NULL is
1411 ** equivalent to an empty rowset. Or, create an ephemeral index
1412 ** capable of holding primary keys in the case of a WITHOUT ROWID.
1413 **
1414 ** Also initialize regReturn to contain the address of the instruction
1415 ** immediately following the OP_Return at the bottom of the loop. This
1416 ** is required in a few obscure LEFT JOIN cases where control jumps
1417 ** over the top of the loop into the body of it. In this case the
1418 ** correct response for the end-of-loop code (the OP_Return) is to
1419 ** fall through to the next instruction, just as an OP_Next does if
1420 ** called on an uninitialized cursor.
1421 */
1422 if( (pWInfo->wctrlFlags & WHERE_DUPLICATES_OK)==0 ){
1423 if( HasRowid(pTab) ){
1424 regRowset = ++pParse->nMem;
1425 sqlite3VdbeAddOp2(v, OP_Null, 0, regRowset);
1426 }else{
1427 Index *pPk = sqlite3PrimaryKeyIndex(pTab);
1428 regRowset = pParse->nTab++;
1429 sqlite3VdbeAddOp2(v, OP_OpenEphemeral, regRowset, pPk->nKeyCol);
1430 sqlite3VdbeSetP4KeyInfo(pParse, pPk);
1431 }
1432 regRowid = ++pParse->nMem;
1433 }
1434 iRetInit = sqlite3VdbeAddOp2(v, OP_Integer, 0, regReturn);
1435
1436 /* If the original WHERE clause is z of the form: (x1 OR x2 OR ...) AND y
1437 ** Then for every term xN, evaluate as the subexpression: xN AND z
1438 ** That way, terms in y that are factored into the disjunction will
1439 ** be picked up by the recursive calls to sqlite3WhereBegin() below.
1440 **
1441 ** Actually, each subexpression is converted to "xN AND w" where w is
1442 ** the "interesting" terms of z - terms that did not originate in the
1443 ** ON or USING clause of a LEFT JOIN, and terms that are usable as
1444 ** indices.
1445 **
1446 ** This optimization also only applies if the (x1 OR x2 OR ...) term
1447 ** is not contained in the ON clause of a LEFT JOIN.
1448 ** See ticket http://www.sqlite.org/src/info/f2369304e4
1449 */
1450 if( pWC->nTerm>1 ){
1451 int iTerm;
1452 for(iTerm=0; iTerm<pWC->nTerm; iTerm++){
1453 Expr *pExpr = pWC->a[iTerm].pExpr;
1454 if( &pWC->a[iTerm] == pTerm ) continue;
1455 if( ExprHasProperty(pExpr, EP_FromJoin) ) continue;
drh3b83f0c2016-01-29 16:57:06 +00001456 testcase( pWC->a[iTerm].wtFlags & TERM_VIRTUAL );
1457 testcase( pWC->a[iTerm].wtFlags & TERM_CODED );
1458 if( (pWC->a[iTerm].wtFlags & (TERM_VIRTUAL|TERM_CODED))!=0 ) continue;
drh6f82e852015-06-06 20:12:09 +00001459 if( (pWC->a[iTerm].eOperator & WO_ALL)==0 ) continue;
1460 testcase( pWC->a[iTerm].wtFlags & TERM_ORINFO );
1461 pExpr = sqlite3ExprDup(db, pExpr, 0);
1462 pAndExpr = sqlite3ExprAnd(db, pAndExpr, pExpr);
1463 }
1464 if( pAndExpr ){
drh1167d322015-10-28 20:01:45 +00001465 pAndExpr = sqlite3PExpr(pParse, TK_AND|TKFLG_DONTFOLD, 0, pAndExpr, 0);
drh6f82e852015-06-06 20:12:09 +00001466 }
1467 }
1468
1469 /* Run a separate WHERE clause for each term of the OR clause. After
1470 ** eliminating duplicates from other WHERE clauses, the action for each
1471 ** sub-WHERE clause is to to invoke the main loop body as a subroutine.
1472 */
1473 wctrlFlags = WHERE_OMIT_OPEN_CLOSE
1474 | WHERE_FORCE_TABLE
1475 | WHERE_ONETABLE_ONLY
1476 | WHERE_NO_AUTOINDEX;
1477 for(ii=0; ii<pOrWc->nTerm; ii++){
1478 WhereTerm *pOrTerm = &pOrWc->a[ii];
1479 if( pOrTerm->leftCursor==iCur || (pOrTerm->eOperator & WO_AND)!=0 ){
1480 WhereInfo *pSubWInfo; /* Info for single OR-term scan */
1481 Expr *pOrExpr = pOrTerm->pExpr; /* Current OR clause term */
drh728e0f92015-10-10 14:41:28 +00001482 int jmp1 = 0; /* Address of jump operation */
drh6f82e852015-06-06 20:12:09 +00001483 if( pAndExpr && !ExprHasProperty(pOrExpr, EP_FromJoin) ){
1484 pAndExpr->pLeft = pOrExpr;
1485 pOrExpr = pAndExpr;
1486 }
1487 /* Loop through table entries that match term pOrTerm. */
1488 WHERETRACE(0xffff, ("Subplan for OR-clause:\n"));
1489 pSubWInfo = sqlite3WhereBegin(pParse, pOrTab, pOrExpr, 0, 0,
1490 wctrlFlags, iCovCur);
1491 assert( pSubWInfo || pParse->nErr || db->mallocFailed );
1492 if( pSubWInfo ){
1493 WhereLoop *pSubLoop;
1494 int addrExplain = sqlite3WhereExplainOneScan(
1495 pParse, pOrTab, &pSubWInfo->a[0], iLevel, pLevel->iFrom, 0
1496 );
1497 sqlite3WhereAddScanStatus(v, pOrTab, &pSubWInfo->a[0], addrExplain);
1498
1499 /* This is the sub-WHERE clause body. First skip over
1500 ** duplicate rows from prior sub-WHERE clauses, and record the
1501 ** rowid (or PRIMARY KEY) for the current row so that the same
1502 ** row will be skipped in subsequent sub-WHERE clauses.
1503 */
1504 if( (pWInfo->wctrlFlags & WHERE_DUPLICATES_OK)==0 ){
1505 int r;
1506 int iSet = ((ii==pOrWc->nTerm-1)?-1:ii);
1507 if( HasRowid(pTab) ){
1508 r = sqlite3ExprCodeGetColumn(pParse, pTab, -1, iCur, regRowid, 0);
drh728e0f92015-10-10 14:41:28 +00001509 jmp1 = sqlite3VdbeAddOp4Int(v, OP_RowSetTest, regRowset, 0,
1510 r,iSet);
drh6f82e852015-06-06 20:12:09 +00001511 VdbeCoverage(v);
1512 }else{
1513 Index *pPk = sqlite3PrimaryKeyIndex(pTab);
1514 int nPk = pPk->nKeyCol;
1515 int iPk;
1516
1517 /* Read the PK into an array of temp registers. */
1518 r = sqlite3GetTempRange(pParse, nPk);
1519 for(iPk=0; iPk<nPk; iPk++){
1520 int iCol = pPk->aiColumn[iPk];
drhce78bc62015-10-15 19:21:51 +00001521 sqlite3ExprCodeGetColumnToReg(pParse, pTab, iCol, iCur, r+iPk);
drh6f82e852015-06-06 20:12:09 +00001522 }
1523
1524 /* Check if the temp table already contains this key. If so,
1525 ** the row has already been included in the result set and
1526 ** can be ignored (by jumping past the Gosub below). Otherwise,
1527 ** insert the key into the temp table and proceed with processing
1528 ** the row.
1529 **
1530 ** Use some of the same optimizations as OP_RowSetTest: If iSet
1531 ** is zero, assume that the key cannot already be present in
1532 ** the temp table. And if iSet is -1, assume that there is no
1533 ** need to insert the key into the temp table, as it will never
1534 ** be tested for. */
1535 if( iSet ){
drh728e0f92015-10-10 14:41:28 +00001536 jmp1 = sqlite3VdbeAddOp4Int(v, OP_Found, regRowset, 0, r, nPk);
drh6f82e852015-06-06 20:12:09 +00001537 VdbeCoverage(v);
1538 }
1539 if( iSet>=0 ){
1540 sqlite3VdbeAddOp3(v, OP_MakeRecord, r, nPk, regRowid);
1541 sqlite3VdbeAddOp3(v, OP_IdxInsert, regRowset, regRowid, 0);
1542 if( iSet ) sqlite3VdbeChangeP5(v, OPFLAG_USESEEKRESULT);
1543 }
1544
1545 /* Release the array of temp registers */
1546 sqlite3ReleaseTempRange(pParse, r, nPk);
1547 }
1548 }
1549
1550 /* Invoke the main loop body as a subroutine */
1551 sqlite3VdbeAddOp2(v, OP_Gosub, regReturn, iLoopBody);
1552
1553 /* Jump here (skipping the main loop body subroutine) if the
1554 ** current sub-WHERE row is a duplicate from prior sub-WHEREs. */
drh728e0f92015-10-10 14:41:28 +00001555 if( jmp1 ) sqlite3VdbeJumpHere(v, jmp1);
drh6f82e852015-06-06 20:12:09 +00001556
1557 /* The pSubWInfo->untestedTerms flag means that this OR term
1558 ** contained one or more AND term from a notReady table. The
1559 ** terms from the notReady table could not be tested and will
1560 ** need to be tested later.
1561 */
1562 if( pSubWInfo->untestedTerms ) untestedTerms = 1;
1563
1564 /* If all of the OR-connected terms are optimized using the same
1565 ** index, and the index is opened using the same cursor number
1566 ** by each call to sqlite3WhereBegin() made by this loop, it may
1567 ** be possible to use that index as a covering index.
1568 **
1569 ** If the call to sqlite3WhereBegin() above resulted in a scan that
1570 ** uses an index, and this is either the first OR-connected term
1571 ** processed or the index is the same as that used by all previous
1572 ** terms, set pCov to the candidate covering index. Otherwise, set
1573 ** pCov to NULL to indicate that no candidate covering index will
1574 ** be available.
1575 */
1576 pSubLoop = pSubWInfo->a[0].pWLoop;
1577 assert( (pSubLoop->wsFlags & WHERE_AUTO_INDEX)==0 );
1578 if( (pSubLoop->wsFlags & WHERE_INDEXED)!=0
1579 && (ii==0 || pSubLoop->u.btree.pIndex==pCov)
1580 && (HasRowid(pTab) || !IsPrimaryKeyIndex(pSubLoop->u.btree.pIndex))
1581 ){
1582 assert( pSubWInfo->a[0].iIdxCur==iCovCur );
1583 pCov = pSubLoop->u.btree.pIndex;
1584 wctrlFlags |= WHERE_REOPEN_IDX;
1585 }else{
1586 pCov = 0;
1587 }
1588
1589 /* Finish the loop through table entries that match term pOrTerm. */
1590 sqlite3WhereEnd(pSubWInfo);
1591 }
1592 }
1593 }
1594 pLevel->u.pCovidx = pCov;
1595 if( pCov ) pLevel->iIdxCur = iCovCur;
1596 if( pAndExpr ){
1597 pAndExpr->pLeft = 0;
1598 sqlite3ExprDelete(db, pAndExpr);
1599 }
1600 sqlite3VdbeChangeP1(v, iRetInit, sqlite3VdbeCurrentAddr(v));
drh076e85f2015-09-03 13:46:12 +00001601 sqlite3VdbeGoto(v, pLevel->addrBrk);
drh6f82e852015-06-06 20:12:09 +00001602 sqlite3VdbeResolveLabel(v, iLoopBody);
1603
1604 if( pWInfo->nLevel>1 ) sqlite3StackFree(db, pOrTab);
1605 if( !untestedTerms ) disableTerm(pLevel, pTerm);
1606 }else
1607#endif /* SQLITE_OMIT_OR_OPTIMIZATION */
1608
1609 {
1610 /* Case 6: There is no usable index. We must do a complete
1611 ** scan of the entire table.
1612 */
1613 static const u8 aStep[] = { OP_Next, OP_Prev };
1614 static const u8 aStart[] = { OP_Rewind, OP_Last };
1615 assert( bRev==0 || bRev==1 );
drh8a48b9c2015-08-19 15:20:00 +00001616 if( pTabItem->fg.isRecursive ){
drh6f82e852015-06-06 20:12:09 +00001617 /* Tables marked isRecursive have only a single row that is stored in
1618 ** a pseudo-cursor. No need to Rewind or Next such cursors. */
1619 pLevel->op = OP_Noop;
1620 }else{
drhb413a542015-08-17 17:19:28 +00001621 codeCursorHint(pWInfo, pLevel, 0);
drh6f82e852015-06-06 20:12:09 +00001622 pLevel->op = aStep[bRev];
1623 pLevel->p1 = iCur;
1624 pLevel->p2 = 1 + sqlite3VdbeAddOp2(v, aStart[bRev], iCur, addrBrk);
1625 VdbeCoverageIf(v, bRev==0);
1626 VdbeCoverageIf(v, bRev!=0);
1627 pLevel->p5 = SQLITE_STMTSTATUS_FULLSCAN_STEP;
1628 }
1629 }
1630
1631#ifdef SQLITE_ENABLE_STMT_SCANSTATUS
1632 pLevel->addrVisit = sqlite3VdbeCurrentAddr(v);
1633#endif
1634
1635 /* Insert code to test every subexpression that can be completely
1636 ** computed using the current set of tables.
1637 */
1638 for(pTerm=pWC->a, j=pWC->nTerm; j>0; j--, pTerm++){
1639 Expr *pE;
1640 int skipLikeAddr = 0;
1641 testcase( pTerm->wtFlags & TERM_VIRTUAL );
1642 testcase( pTerm->wtFlags & TERM_CODED );
1643 if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
1644 if( (pTerm->prereqAll & pLevel->notReady)!=0 ){
1645 testcase( pWInfo->untestedTerms==0
1646 && (pWInfo->wctrlFlags & WHERE_ONETABLE_ONLY)!=0 );
1647 pWInfo->untestedTerms = 1;
1648 continue;
1649 }
1650 pE = pTerm->pExpr;
1651 assert( pE!=0 );
1652 if( pLevel->iLeftJoin && !ExprHasProperty(pE, EP_FromJoin) ){
1653 continue;
1654 }
1655 if( pTerm->wtFlags & TERM_LIKECOND ){
drh41d2e662015-12-01 21:23:07 +00001656#ifdef SQLITE_LIKE_DOESNT_MATCH_BLOBS
1657 continue;
1658#else
drh6f82e852015-06-06 20:12:09 +00001659 assert( pLevel->iLikeRepCntr>0 );
1660 skipLikeAddr = sqlite3VdbeAddOp1(v, OP_IfNot, pLevel->iLikeRepCntr);
1661 VdbeCoverage(v);
drh41d2e662015-12-01 21:23:07 +00001662#endif
drh6f82e852015-06-06 20:12:09 +00001663 }
1664 sqlite3ExprIfFalse(pParse, pE, addrCont, SQLITE_JUMPIFNULL);
1665 if( skipLikeAddr ) sqlite3VdbeJumpHere(v, skipLikeAddr);
1666 pTerm->wtFlags |= TERM_CODED;
1667 }
1668
1669 /* Insert code to test for implied constraints based on transitivity
1670 ** of the "==" operator.
1671 **
1672 ** Example: If the WHERE clause contains "t1.a=t2.b" and "t2.b=123"
1673 ** and we are coding the t1 loop and the t2 loop has not yet coded,
1674 ** then we cannot use the "t1.a=t2.b" constraint, but we can code
1675 ** the implied "t1.a=123" constraint.
1676 */
1677 for(pTerm=pWC->a, j=pWC->nTerm; j>0; j--, pTerm++){
1678 Expr *pE, *pEAlt;
1679 WhereTerm *pAlt;
1680 if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
1681 if( (pTerm->eOperator & (WO_EQ|WO_IS))==0 ) continue;
1682 if( (pTerm->eOperator & WO_EQUIV)==0 ) continue;
1683 if( pTerm->leftCursor!=iCur ) continue;
1684 if( pLevel->iLeftJoin ) continue;
1685 pE = pTerm->pExpr;
1686 assert( !ExprHasProperty(pE, EP_FromJoin) );
1687 assert( (pTerm->prereqRight & pLevel->notReady)!=0 );
1688 pAlt = sqlite3WhereFindTerm(pWC, iCur, pTerm->u.leftColumn, notReady,
1689 WO_EQ|WO_IN|WO_IS, 0);
1690 if( pAlt==0 ) continue;
1691 if( pAlt->wtFlags & (TERM_CODED) ) continue;
1692 testcase( pAlt->eOperator & WO_EQ );
1693 testcase( pAlt->eOperator & WO_IS );
1694 testcase( pAlt->eOperator & WO_IN );
1695 VdbeModuleComment((v, "begin transitive constraint"));
1696 pEAlt = sqlite3StackAllocRaw(db, sizeof(*pEAlt));
1697 if( pEAlt ){
1698 *pEAlt = *pAlt->pExpr;
1699 pEAlt->pLeft = pE->pLeft;
1700 sqlite3ExprIfFalse(pParse, pEAlt, addrCont, SQLITE_JUMPIFNULL);
1701 sqlite3StackFree(db, pEAlt);
1702 }
1703 }
1704
1705 /* For a LEFT OUTER JOIN, generate code that will record the fact that
1706 ** at least one row of the right table has matched the left table.
1707 */
1708 if( pLevel->iLeftJoin ){
1709 pLevel->addrFirst = sqlite3VdbeCurrentAddr(v);
1710 sqlite3VdbeAddOp2(v, OP_Integer, 1, pLevel->iLeftJoin);
1711 VdbeComment((v, "record LEFT JOIN hit"));
1712 sqlite3ExprCacheClear(pParse);
1713 for(pTerm=pWC->a, j=0; j<pWC->nTerm; j++, pTerm++){
1714 testcase( pTerm->wtFlags & TERM_VIRTUAL );
1715 testcase( pTerm->wtFlags & TERM_CODED );
1716 if( pTerm->wtFlags & (TERM_VIRTUAL|TERM_CODED) ) continue;
1717 if( (pTerm->prereqAll & pLevel->notReady)!=0 ){
1718 assert( pWInfo->untestedTerms );
1719 continue;
1720 }
1721 assert( pTerm->pExpr );
1722 sqlite3ExprIfFalse(pParse, pTerm->pExpr, addrCont, SQLITE_JUMPIFNULL);
1723 pTerm->wtFlags |= TERM_CODED;
1724 }
1725 }
1726
1727 return pLevel->notReady;
1728}