blob: d8fe6da85feaa51b78393ffb8c40e8124bb43700 [file] [log] [blame]
drh75897232000-05-29 14:26:00 +00001/*
drhb19a2bc2001-09-16 00:13:26 +00002** 2001 September 15
drh75897232000-05-29 14:26:00 +00003**
drhb19a2bc2001-09-16 00:13:26 +00004** The author disclaims copyright to this source code. In place of
5** a legal notice, here is a blessing:
drh75897232000-05-29 14:26:00 +00006**
drhb19a2bc2001-09-16 00:13:26 +00007** 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.
drh75897232000-05-29 14:26:00 +000010**
11*************************************************************************
12** This module contains C code that generates VDBE code used to process
drh51669862004-12-18 18:40:26 +000013** the WHERE clause of SQL statements. This module is reponsible for
14** generating the code that loops through a table looking for applicable
15** rows. Indices are selected and used to speed the search when doing
16** so is applicable. Because this module is responsible for selecting
17** indices, you might also think of this module as the "query optimizer".
drh75897232000-05-29 14:26:00 +000018**
drhf2d315d2007-01-25 16:56:06 +000019** $Id: where.c,v 1.236 2007/01/25 16:56:07 drh Exp $
drh75897232000-05-29 14:26:00 +000020*/
21#include "sqliteInt.h"
22
23/*
drh0aa74ed2005-07-16 13:33:20 +000024** The number of bits in a Bitmask. "BMS" means "BitMask Size".
25*/
drh29dda4a2005-07-21 18:23:20 +000026#define BMS (sizeof(Bitmask)*8)
drh0aa74ed2005-07-16 13:33:20 +000027
28/*
29** Determine the number of elements in an array.
30*/
31#define ARRAYSIZE(X) (sizeof(X)/sizeof(X[0]))
32
drh51147ba2005-07-23 22:59:55 +000033/*
34** Trace output macros
35*/
36#if defined(SQLITE_TEST) || defined(SQLITE_DEBUG)
37int sqlite3_where_trace = 0;
38# define TRACE(X) if(sqlite3_where_trace) sqlite3DebugPrintf X
39#else
40# define TRACE(X)
41#endif
42
drh0fcef5e2005-07-19 17:38:22 +000043/* Forward reference
44*/
45typedef struct WhereClause WhereClause;
drh0aa74ed2005-07-16 13:33:20 +000046
47/*
drh75897232000-05-29 14:26:00 +000048** The query generator uses an array of instances of this structure to
49** help it analyze the subexpressions of the WHERE clause. Each WHERE
50** clause subexpression is separated from the others by an AND operator.
drh51669862004-12-18 18:40:26 +000051**
drh0fcef5e2005-07-19 17:38:22 +000052** All WhereTerms are collected into a single WhereClause structure.
53** The following identity holds:
drh51669862004-12-18 18:40:26 +000054**
drh0fcef5e2005-07-19 17:38:22 +000055** WhereTerm.pWC->a[WhereTerm.idx] == WhereTerm
drh51669862004-12-18 18:40:26 +000056**
drh0fcef5e2005-07-19 17:38:22 +000057** When a term is of the form:
58**
59** X <op> <expr>
60**
61** where X is a column name and <op> is one of certain operators,
62** then WhereTerm.leftCursor and WhereTerm.leftColumn record the
drh51147ba2005-07-23 22:59:55 +000063** cursor number and column number for X. WhereTerm.operator records
64** the <op> using a bitmask encoding defined by WO_xxx below. The
65** use of a bitmask encoding for the operator allows us to search
66** quickly for terms that match any of several different operators.
drh0fcef5e2005-07-19 17:38:22 +000067**
68** prereqRight and prereqAll record sets of cursor numbers,
drh51669862004-12-18 18:40:26 +000069** but they do so indirectly. A single ExprMaskSet structure translates
70** cursor number into bits and the translated bit is stored in the prereq
71** fields. The translation is used in order to maximize the number of
72** bits that will fit in a Bitmask. The VDBE cursor numbers might be
73** spread out over the non-negative integers. For example, the cursor
74** numbers might be 3, 8, 9, 10, 20, 23, 41, and 45. The ExprMaskSet
75** translates these sparse cursor numbers into consecutive integers
76** beginning with 0 in order to make the best possible use of the available
77** bits in the Bitmask. So, in the example above, the cursor numbers
78** would be mapped into integers 0 through 7.
drh75897232000-05-29 14:26:00 +000079*/
drh0aa74ed2005-07-16 13:33:20 +000080typedef struct WhereTerm WhereTerm;
81struct WhereTerm {
drh0fcef5e2005-07-19 17:38:22 +000082 Expr *pExpr; /* Pointer to the subexpression */
drh45b1ee42005-08-02 17:48:22 +000083 i16 iParent; /* Disable pWC->a[iParent] when this term disabled */
drh0fcef5e2005-07-19 17:38:22 +000084 i16 leftCursor; /* Cursor number of X in "X <op> <expr>" */
85 i16 leftColumn; /* Column number of X in "X <op> <expr>" */
drhb52076c2006-01-23 13:22:09 +000086 u16 eOperator; /* A WO_xx value describing <op> */
drh6c30be82005-07-29 15:10:17 +000087 u8 flags; /* Bit flags. See below */
drh45b1ee42005-08-02 17:48:22 +000088 u8 nChild; /* Number of children that must disable us */
drh0fcef5e2005-07-19 17:38:22 +000089 WhereClause *pWC; /* The clause this term is part of */
90 Bitmask prereqRight; /* Bitmask of tables used by pRight */
drh51669862004-12-18 18:40:26 +000091 Bitmask prereqAll; /* Bitmask of tables referenced by p */
drh75897232000-05-29 14:26:00 +000092};
93
94/*
drh0aa74ed2005-07-16 13:33:20 +000095** Allowed values of WhereTerm.flags
96*/
drh6c30be82005-07-29 15:10:17 +000097#define TERM_DYNAMIC 0x01 /* Need to call sqlite3ExprDelete(pExpr) */
98#define TERM_VIRTUAL 0x02 /* Added by the optimizer. Do not code */
99#define TERM_CODED 0x04 /* This term is already coded */
drh45b1ee42005-08-02 17:48:22 +0000100#define TERM_COPIED 0x08 /* Has a child */
drh6c30be82005-07-29 15:10:17 +0000101#define TERM_OR_OK 0x10 /* Used during OR-clause processing */
drh0aa74ed2005-07-16 13:33:20 +0000102
103/*
104** An instance of the following structure holds all information about a
105** WHERE clause. Mostly this is a container for one or more WhereTerms.
106*/
drh0aa74ed2005-07-16 13:33:20 +0000107struct WhereClause {
drhfe05af82005-07-21 03:14:59 +0000108 Parse *pParse; /* The parser context */
drh0aa74ed2005-07-16 13:33:20 +0000109 int nTerm; /* Number of terms */
110 int nSlot; /* Number of entries in a[] */
drh51147ba2005-07-23 22:59:55 +0000111 WhereTerm *a; /* Each a[] describes a term of the WHERE cluase */
112 WhereTerm aStatic[10]; /* Initial static space for a[] */
drhe23399f2005-07-22 00:31:39 +0000113};
114
115/*
drh6a3ea0e2003-05-02 14:32:12 +0000116** An instance of the following structure keeps track of a mapping
drh0aa74ed2005-07-16 13:33:20 +0000117** between VDBE cursor numbers and bits of the bitmasks in WhereTerm.
drh51669862004-12-18 18:40:26 +0000118**
119** The VDBE cursor numbers are small integers contained in
120** SrcList_item.iCursor and Expr.iTable fields. For any given WHERE
121** clause, the cursor numbers might not begin with 0 and they might
122** contain gaps in the numbering sequence. But we want to make maximum
123** use of the bits in our bitmasks. This structure provides a mapping
124** from the sparse cursor numbers into consecutive integers beginning
125** with 0.
126**
127** If ExprMaskSet.ix[A]==B it means that The A-th bit of a Bitmask
128** corresponds VDBE cursor number B. The A-th bit of a bitmask is 1<<A.
129**
130** For example, if the WHERE clause expression used these VDBE
131** cursors: 4, 5, 8, 29, 57, 73. Then the ExprMaskSet structure
132** would map those cursor numbers into bits 0 through 5.
133**
134** Note that the mapping is not necessarily ordered. In the example
135** above, the mapping might go like this: 4->3, 5->1, 8->2, 29->0,
136** 57->5, 73->4. Or one of 719 other combinations might be used. It
137** does not really matter. What is important is that sparse cursor
138** numbers all get mapped into bit numbers that begin with 0 and contain
139** no gaps.
drh6a3ea0e2003-05-02 14:32:12 +0000140*/
141typedef struct ExprMaskSet ExprMaskSet;
142struct ExprMaskSet {
drh1398ad32005-01-19 23:24:50 +0000143 int n; /* Number of assigned cursor values */
144 int ix[sizeof(Bitmask)*8]; /* Cursor assigned to each bit */
drh6a3ea0e2003-05-02 14:32:12 +0000145};
146
drh0aa74ed2005-07-16 13:33:20 +0000147
drh6a3ea0e2003-05-02 14:32:12 +0000148/*
drh51147ba2005-07-23 22:59:55 +0000149** Bitmasks for the operators that indices are able to exploit. An
150** OR-ed combination of these values can be used when searching for
151** terms in the where clause.
152*/
153#define WO_IN 1
drha6110402005-07-28 20:51:19 +0000154#define WO_EQ 2
drh51147ba2005-07-23 22:59:55 +0000155#define WO_LT (WO_EQ<<(TK_LT-TK_EQ))
156#define WO_LE (WO_EQ<<(TK_LE-TK_EQ))
157#define WO_GT (WO_EQ<<(TK_GT-TK_EQ))
158#define WO_GE (WO_EQ<<(TK_GE-TK_EQ))
drh7f375902006-06-13 17:38:59 +0000159#define WO_MATCH 64
drh50b39962006-10-28 00:28:09 +0000160#define WO_ISNULL 128
drh51147ba2005-07-23 22:59:55 +0000161
162/*
drhf2d315d2007-01-25 16:56:06 +0000163** Value for flags returned by bestIndex().
164**
165** The least significant byte is reserved as a mask for WO_ values above.
166** The WhereLevel.flags field is usually set to WO_IN|WO_EQ|WO_ISNULL.
167** But if the table is the right table of a left join, WhereLevel.flags
168** is set to WO_IN|WO_EQ. The WhereLevel.flags field can then be used as
169** the "op" parameter to findTerm when we are resolving equality constraints.
170** ISNULL constraints will then not be used on the right table of a left
171** join. Tickets #2177 and #2189.
drh51147ba2005-07-23 22:59:55 +0000172*/
drhf2d315d2007-01-25 16:56:06 +0000173#define WHERE_ROWID_EQ 0x000100 /* rowid=EXPR or rowid IN (...) */
174#define WHERE_ROWID_RANGE 0x000200 /* rowid<EXPR and/or rowid>EXPR */
175#define WHERE_COLUMN_EQ 0x001000 /* x=EXPR or x IN (...) */
176#define WHERE_COLUMN_RANGE 0x002000 /* x<EXPR and/or x>EXPR */
177#define WHERE_COLUMN_IN 0x004000 /* x IN (...) */
178#define WHERE_TOP_LIMIT 0x010000 /* x<EXPR or x<=EXPR constraint */
179#define WHERE_BTM_LIMIT 0x020000 /* x>EXPR or x>=EXPR constraint */
180#define WHERE_IDX_ONLY 0x080000 /* Use index only - omit table */
181#define WHERE_ORDERBY 0x100000 /* Output will appear in correct order */
182#define WHERE_REVERSE 0x200000 /* Scan in reverse order */
183#define WHERE_UNIQUE 0x400000 /* Selects no more than one row */
184#define WHERE_VIRTUALTABLE 0x800000 /* Use virtual-table processing */
drh51147ba2005-07-23 22:59:55 +0000185
186/*
drh0aa74ed2005-07-16 13:33:20 +0000187** Initialize a preallocated WhereClause structure.
drh75897232000-05-29 14:26:00 +0000188*/
drhfe05af82005-07-21 03:14:59 +0000189static void whereClauseInit(WhereClause *pWC, Parse *pParse){
190 pWC->pParse = pParse;
drh0aa74ed2005-07-16 13:33:20 +0000191 pWC->nTerm = 0;
192 pWC->nSlot = ARRAYSIZE(pWC->aStatic);
193 pWC->a = pWC->aStatic;
194}
195
196/*
197** Deallocate a WhereClause structure. The WhereClause structure
198** itself is not freed. This routine is the inverse of whereClauseInit().
199*/
200static void whereClauseClear(WhereClause *pWC){
201 int i;
202 WhereTerm *a;
203 for(i=pWC->nTerm-1, a=pWC->a; i>=0; i--, a++){
204 if( a->flags & TERM_DYNAMIC ){
drh0fcef5e2005-07-19 17:38:22 +0000205 sqlite3ExprDelete(a->pExpr);
drh0aa74ed2005-07-16 13:33:20 +0000206 }
207 }
208 if( pWC->a!=pWC->aStatic ){
209 sqliteFree(pWC->a);
210 }
211}
212
213/*
214** Add a new entries to the WhereClause structure. Increase the allocated
215** space as necessary.
drh9eb20282005-08-24 03:52:18 +0000216**
217** WARNING: This routine might reallocate the space used to store
218** WhereTerms. All pointers to WhereTerms should be invalided after
219** calling this routine. Such pointers may be reinitialized by referencing
220** the pWC->a[] array.
drh0aa74ed2005-07-16 13:33:20 +0000221*/
drh9eb20282005-08-24 03:52:18 +0000222static int whereClauseInsert(WhereClause *pWC, Expr *p, int flags){
drh0aa74ed2005-07-16 13:33:20 +0000223 WhereTerm *pTerm;
drh9eb20282005-08-24 03:52:18 +0000224 int idx;
drh0aa74ed2005-07-16 13:33:20 +0000225 if( pWC->nTerm>=pWC->nSlot ){
226 WhereTerm *pOld = pWC->a;
227 pWC->a = sqliteMalloc( sizeof(pWC->a[0])*pWC->nSlot*2 );
drh0fcef5e2005-07-19 17:38:22 +0000228 if( pWC->a==0 ) return 0;
drh0aa74ed2005-07-16 13:33:20 +0000229 memcpy(pWC->a, pOld, sizeof(pWC->a[0])*pWC->nTerm);
230 if( pOld!=pWC->aStatic ){
231 sqliteFree(pOld);
232 }
233 pWC->nSlot *= 2;
234 }
drh9eb20282005-08-24 03:52:18 +0000235 pTerm = &pWC->a[idx = pWC->nTerm];
drh0fcef5e2005-07-19 17:38:22 +0000236 pWC->nTerm++;
237 pTerm->pExpr = p;
drh0aa74ed2005-07-16 13:33:20 +0000238 pTerm->flags = flags;
drh0fcef5e2005-07-19 17:38:22 +0000239 pTerm->pWC = pWC;
drh45b1ee42005-08-02 17:48:22 +0000240 pTerm->iParent = -1;
drh9eb20282005-08-24 03:52:18 +0000241 return idx;
drh0aa74ed2005-07-16 13:33:20 +0000242}
drh75897232000-05-29 14:26:00 +0000243
244/*
drh51669862004-12-18 18:40:26 +0000245** This routine identifies subexpressions in the WHERE clause where
drhb6fb62d2005-09-20 08:47:20 +0000246** each subexpression is separated by the AND operator or some other
drh6c30be82005-07-29 15:10:17 +0000247** operator specified in the op parameter. The WhereClause structure
248** is filled with pointers to subexpressions. For example:
drh75897232000-05-29 14:26:00 +0000249**
drh51669862004-12-18 18:40:26 +0000250** WHERE a=='hello' AND coalesce(b,11)<10 AND (c+12!=d OR c==22)
251** \________/ \_______________/ \________________/
252** slot[0] slot[1] slot[2]
253**
254** The original WHERE clause in pExpr is unaltered. All this routine
drh51147ba2005-07-23 22:59:55 +0000255** does is make slot[] entries point to substructure within pExpr.
drh51669862004-12-18 18:40:26 +0000256**
drh51147ba2005-07-23 22:59:55 +0000257** In the previous sentence and in the diagram, "slot[]" refers to
258** the WhereClause.a[] array. This array grows as needed to contain
259** all terms of the WHERE clause.
drh75897232000-05-29 14:26:00 +0000260*/
drh6c30be82005-07-29 15:10:17 +0000261static void whereSplit(WhereClause *pWC, Expr *pExpr, int op){
drh0aa74ed2005-07-16 13:33:20 +0000262 if( pExpr==0 ) return;
drh6c30be82005-07-29 15:10:17 +0000263 if( pExpr->op!=op ){
drh0aa74ed2005-07-16 13:33:20 +0000264 whereClauseInsert(pWC, pExpr, 0);
drh75897232000-05-29 14:26:00 +0000265 }else{
drh6c30be82005-07-29 15:10:17 +0000266 whereSplit(pWC, pExpr->pLeft, op);
267 whereSplit(pWC, pExpr->pRight, op);
drh75897232000-05-29 14:26:00 +0000268 }
drh75897232000-05-29 14:26:00 +0000269}
270
271/*
drh6a3ea0e2003-05-02 14:32:12 +0000272** Initialize an expression mask set
273*/
274#define initMaskSet(P) memset(P, 0, sizeof(*P))
275
276/*
drh1398ad32005-01-19 23:24:50 +0000277** Return the bitmask for the given cursor number. Return 0 if
278** iCursor is not in the set.
drh6a3ea0e2003-05-02 14:32:12 +0000279*/
drh51669862004-12-18 18:40:26 +0000280static Bitmask getMask(ExprMaskSet *pMaskSet, int iCursor){
drh6a3ea0e2003-05-02 14:32:12 +0000281 int i;
282 for(i=0; i<pMaskSet->n; i++){
drh51669862004-12-18 18:40:26 +0000283 if( pMaskSet->ix[i]==iCursor ){
284 return ((Bitmask)1)<<i;
285 }
drh6a3ea0e2003-05-02 14:32:12 +0000286 }
drh6a3ea0e2003-05-02 14:32:12 +0000287 return 0;
288}
289
290/*
drh1398ad32005-01-19 23:24:50 +0000291** Create a new mask for cursor iCursor.
drh0fcef5e2005-07-19 17:38:22 +0000292**
293** There is one cursor per table in the FROM clause. The number of
294** tables in the FROM clause is limited by a test early in the
drhb6fb62d2005-09-20 08:47:20 +0000295** sqlite3WhereBegin() routine. So we know that the pMaskSet->ix[]
drh0fcef5e2005-07-19 17:38:22 +0000296** array will never overflow.
drh1398ad32005-01-19 23:24:50 +0000297*/
298static void createMask(ExprMaskSet *pMaskSet, int iCursor){
drh0fcef5e2005-07-19 17:38:22 +0000299 assert( pMaskSet->n < ARRAYSIZE(pMaskSet->ix) );
300 pMaskSet->ix[pMaskSet->n++] = iCursor;
drh1398ad32005-01-19 23:24:50 +0000301}
302
303/*
drh75897232000-05-29 14:26:00 +0000304** This routine walks (recursively) an expression tree and generates
305** a bitmask indicating which tables are used in that expression
drh6a3ea0e2003-05-02 14:32:12 +0000306** tree.
drh75897232000-05-29 14:26:00 +0000307**
308** In order for this routine to work, the calling function must have
drh626a8792005-01-17 22:08:19 +0000309** previously invoked sqlite3ExprResolveNames() on the expression. See
drh75897232000-05-29 14:26:00 +0000310** the header comment on that routine for additional information.
drh626a8792005-01-17 22:08:19 +0000311** The sqlite3ExprResolveNames() routines looks for column names and
drh6a3ea0e2003-05-02 14:32:12 +0000312** sets their opcodes to TK_COLUMN and their Expr.iTable fields to
drh51147ba2005-07-23 22:59:55 +0000313** the VDBE cursor number of the table. This routine just has to
314** translate the cursor numbers into bitmask values and OR all
315** the bitmasks together.
drh75897232000-05-29 14:26:00 +0000316*/
drhf5b11382005-09-17 13:07:13 +0000317static Bitmask exprListTableUsage(ExprMaskSet*, ExprList*);
318static Bitmask exprSelectTableUsage(ExprMaskSet*, Select*);
drh51669862004-12-18 18:40:26 +0000319static Bitmask exprTableUsage(ExprMaskSet *pMaskSet, Expr *p){
320 Bitmask mask = 0;
drh75897232000-05-29 14:26:00 +0000321 if( p==0 ) return 0;
drh967e8b72000-06-21 13:59:10 +0000322 if( p->op==TK_COLUMN ){
drh8feb4b12004-07-19 02:12:14 +0000323 mask = getMask(pMaskSet, p->iTable);
drh8feb4b12004-07-19 02:12:14 +0000324 return mask;
drh75897232000-05-29 14:26:00 +0000325 }
danielk1977b3bce662005-01-29 08:32:43 +0000326 mask = exprTableUsage(pMaskSet, p->pRight);
327 mask |= exprTableUsage(pMaskSet, p->pLeft);
328 mask |= exprListTableUsage(pMaskSet, p->pList);
drhf5b11382005-09-17 13:07:13 +0000329 mask |= exprSelectTableUsage(pMaskSet, p->pSelect);
danielk1977b3bce662005-01-29 08:32:43 +0000330 return mask;
331}
332static Bitmask exprListTableUsage(ExprMaskSet *pMaskSet, ExprList *pList){
333 int i;
334 Bitmask mask = 0;
335 if( pList ){
336 for(i=0; i<pList->nExpr; i++){
337 mask |= exprTableUsage(pMaskSet, pList->a[i].pExpr);
drhdd579122002-04-02 01:58:57 +0000338 }
339 }
drh75897232000-05-29 14:26:00 +0000340 return mask;
341}
drhf5b11382005-09-17 13:07:13 +0000342static Bitmask exprSelectTableUsage(ExprMaskSet *pMaskSet, Select *pS){
343 Bitmask mask;
344 if( pS==0 ){
345 mask = 0;
346 }else{
347 mask = exprListTableUsage(pMaskSet, pS->pEList);
348 mask |= exprListTableUsage(pMaskSet, pS->pGroupBy);
349 mask |= exprListTableUsage(pMaskSet, pS->pOrderBy);
350 mask |= exprTableUsage(pMaskSet, pS->pWhere);
351 mask |= exprTableUsage(pMaskSet, pS->pHaving);
352 }
353 return mask;
354}
drh75897232000-05-29 14:26:00 +0000355
356/*
drh487ab3c2001-11-08 00:45:21 +0000357** Return TRUE if the given operator is one of the operators that is
drh51669862004-12-18 18:40:26 +0000358** allowed for an indexable WHERE clause term. The allowed operators are
drhc27a1ce2002-06-14 20:58:45 +0000359** "=", "<", ">", "<=", ">=", and "IN".
drh487ab3c2001-11-08 00:45:21 +0000360*/
361static int allowedOp(int op){
drhfe05af82005-07-21 03:14:59 +0000362 assert( TK_GT>TK_EQ && TK_GT<TK_GE );
363 assert( TK_LT>TK_EQ && TK_LT<TK_GE );
364 assert( TK_LE>TK_EQ && TK_LE<TK_GE );
365 assert( TK_GE==TK_EQ+4 );
drh50b39962006-10-28 00:28:09 +0000366 return op==TK_IN || (op>=TK_EQ && op<=TK_GE) || op==TK_ISNULL;
drh487ab3c2001-11-08 00:45:21 +0000367}
368
369/*
drh51669862004-12-18 18:40:26 +0000370** Swap two objects of type T.
drh193bd772004-07-20 18:23:14 +0000371*/
372#define SWAP(TYPE,A,B) {TYPE t=A; A=B; B=t;}
373
374/*
drh0fcef5e2005-07-19 17:38:22 +0000375** Commute a comparision operator. Expressions of the form "X op Y"
376** are converted into "Y op X".
drh193bd772004-07-20 18:23:14 +0000377*/
drh0fcef5e2005-07-19 17:38:22 +0000378static void exprCommute(Expr *pExpr){
drhfe05af82005-07-21 03:14:59 +0000379 assert( allowedOp(pExpr->op) && pExpr->op!=TK_IN );
drh0fcef5e2005-07-19 17:38:22 +0000380 SWAP(CollSeq*,pExpr->pRight->pColl,pExpr->pLeft->pColl);
381 SWAP(Expr*,pExpr->pRight,pExpr->pLeft);
382 if( pExpr->op>=TK_GT ){
383 assert( TK_LT==TK_GT+2 );
384 assert( TK_GE==TK_LE+2 );
385 assert( TK_GT>TK_EQ );
386 assert( TK_GT<TK_LE );
387 assert( pExpr->op>=TK_GT && pExpr->op<=TK_GE );
388 pExpr->op = ((pExpr->op-TK_GT)^2)+TK_GT;
drh193bd772004-07-20 18:23:14 +0000389 }
drh193bd772004-07-20 18:23:14 +0000390}
391
392/*
drhfe05af82005-07-21 03:14:59 +0000393** Translate from TK_xx operator to WO_xx bitmask.
394*/
395static int operatorMask(int op){
drh51147ba2005-07-23 22:59:55 +0000396 int c;
drhfe05af82005-07-21 03:14:59 +0000397 assert( allowedOp(op) );
398 if( op==TK_IN ){
drh51147ba2005-07-23 22:59:55 +0000399 c = WO_IN;
drh50b39962006-10-28 00:28:09 +0000400 }else if( op==TK_ISNULL ){
401 c = WO_ISNULL;
drhfe05af82005-07-21 03:14:59 +0000402 }else{
drh51147ba2005-07-23 22:59:55 +0000403 c = WO_EQ<<(op-TK_EQ);
drhfe05af82005-07-21 03:14:59 +0000404 }
drh50b39962006-10-28 00:28:09 +0000405 assert( op!=TK_ISNULL || c==WO_ISNULL );
drh51147ba2005-07-23 22:59:55 +0000406 assert( op!=TK_IN || c==WO_IN );
407 assert( op!=TK_EQ || c==WO_EQ );
408 assert( op!=TK_LT || c==WO_LT );
409 assert( op!=TK_LE || c==WO_LE );
410 assert( op!=TK_GT || c==WO_GT );
411 assert( op!=TK_GE || c==WO_GE );
412 return c;
drhfe05af82005-07-21 03:14:59 +0000413}
414
415/*
416** Search for a term in the WHERE clause that is of the form "X <op> <expr>"
417** where X is a reference to the iColumn of table iCur and <op> is one of
418** the WO_xx operator codes specified by the op parameter.
419** Return a pointer to the term. Return 0 if not found.
420*/
421static WhereTerm *findTerm(
422 WhereClause *pWC, /* The WHERE clause to be searched */
423 int iCur, /* Cursor number of LHS */
424 int iColumn, /* Column number of LHS */
425 Bitmask notReady, /* RHS must not overlap with this mask */
drh51147ba2005-07-23 22:59:55 +0000426 u16 op, /* Mask of WO_xx values describing operator */
drhfe05af82005-07-21 03:14:59 +0000427 Index *pIdx /* Must be compatible with this index, if not NULL */
428){
429 WhereTerm *pTerm;
430 int k;
431 for(pTerm=pWC->a, k=pWC->nTerm; k; k--, pTerm++){
432 if( pTerm->leftCursor==iCur
433 && (pTerm->prereqRight & notReady)==0
434 && pTerm->leftColumn==iColumn
drhb52076c2006-01-23 13:22:09 +0000435 && (pTerm->eOperator & op)!=0
drhfe05af82005-07-21 03:14:59 +0000436 ){
drh50b39962006-10-28 00:28:09 +0000437 if( iCur>=0 && pIdx && pTerm->eOperator!=WO_ISNULL ){
drhfe05af82005-07-21 03:14:59 +0000438 Expr *pX = pTerm->pExpr;
439 CollSeq *pColl;
440 char idxaff;
danielk1977f0113002006-01-24 12:09:17 +0000441 int j;
drhfe05af82005-07-21 03:14:59 +0000442 Parse *pParse = pWC->pParse;
443
444 idxaff = pIdx->pTable->aCol[iColumn].affinity;
445 if( !sqlite3IndexAffinityOk(pX, idxaff) ) continue;
446 pColl = sqlite3ExprCollSeq(pParse, pX->pLeft);
447 if( !pColl ){
448 if( pX->pRight ){
449 pColl = sqlite3ExprCollSeq(pParse, pX->pRight);
450 }
451 if( !pColl ){
452 pColl = pParse->db->pDfltColl;
453 }
454 }
danielk1977f0113002006-01-24 12:09:17 +0000455 for(j=0; j<pIdx->nColumn && pIdx->aiColumn[j]!=iColumn; j++){}
456 assert( j<pIdx->nColumn );
457 if( sqlite3StrICmp(pColl->zName, pIdx->azColl[j]) ) continue;
drhfe05af82005-07-21 03:14:59 +0000458 }
459 return pTerm;
460 }
461 }
462 return 0;
463}
464
drh6c30be82005-07-29 15:10:17 +0000465/* Forward reference */
drh9eb20282005-08-24 03:52:18 +0000466static void exprAnalyze(SrcList*, ExprMaskSet*, WhereClause*, int);
drh6c30be82005-07-29 15:10:17 +0000467
468/*
469** Call exprAnalyze on all terms in a WHERE clause.
470**
471**
472*/
473static void exprAnalyzeAll(
474 SrcList *pTabList, /* the FROM clause */
475 ExprMaskSet *pMaskSet, /* table masks */
476 WhereClause *pWC /* the WHERE clause to be analyzed */
477){
drh6c30be82005-07-29 15:10:17 +0000478 int i;
drh9eb20282005-08-24 03:52:18 +0000479 for(i=pWC->nTerm-1; i>=0; i--){
480 exprAnalyze(pTabList, pMaskSet, pWC, i);
drh6c30be82005-07-29 15:10:17 +0000481 }
482}
483
drhd2687b72005-08-12 22:56:09 +0000484#ifndef SQLITE_OMIT_LIKE_OPTIMIZATION
485/*
486** Check to see if the given expression is a LIKE or GLOB operator that
487** can be optimized using inequality constraints. Return TRUE if it is
488** so and false if not.
489**
490** In order for the operator to be optimizible, the RHS must be a string
491** literal that does not begin with a wildcard.
492*/
493static int isLikeOrGlob(
drh55ef4d92005-08-14 01:20:37 +0000494 sqlite3 *db, /* The database */
drhd2687b72005-08-12 22:56:09 +0000495 Expr *pExpr, /* Test this expression */
496 int *pnPattern, /* Number of non-wildcard prefix characters */
497 int *pisComplete /* True if the only wildcard is % in the last character */
498){
499 const char *z;
500 Expr *pRight, *pLeft;
drh55ef4d92005-08-14 01:20:37 +0000501 ExprList *pList;
drhd2687b72005-08-12 22:56:09 +0000502 int c, cnt;
drhd64fe2f2005-08-28 17:00:23 +0000503 int noCase;
drh55ef4d92005-08-14 01:20:37 +0000504 char wc[3];
drhd64fe2f2005-08-28 17:00:23 +0000505 CollSeq *pColl;
506
507 if( !sqlite3IsLikeFunction(db, pExpr, &noCase, wc) ){
drhd2687b72005-08-12 22:56:09 +0000508 return 0;
509 }
drh55ef4d92005-08-14 01:20:37 +0000510 pList = pExpr->pList;
511 pRight = pList->a[0].pExpr;
drhd2687b72005-08-12 22:56:09 +0000512 if( pRight->op!=TK_STRING ){
513 return 0;
514 }
drh55ef4d92005-08-14 01:20:37 +0000515 pLeft = pList->a[1].pExpr;
drhd2687b72005-08-12 22:56:09 +0000516 if( pLeft->op!=TK_COLUMN ){
517 return 0;
518 }
drhd64fe2f2005-08-28 17:00:23 +0000519 pColl = pLeft->pColl;
520 if( pColl==0 ){
521 pColl = db->pDfltColl;
522 }
523 if( (pColl->type!=SQLITE_COLL_BINARY || noCase) &&
524 (pColl->type!=SQLITE_COLL_NOCASE || !noCase) ){
525 return 0;
526 }
drhd2687b72005-08-12 22:56:09 +0000527 sqlite3DequoteExpr(pRight);
danielk197700fd9572005-12-07 06:27:43 +0000528 z = (char *)pRight->token.z;
drh55ef4d92005-08-14 01:20:37 +0000529 for(cnt=0; (c=z[cnt])!=0 && c!=wc[0] && c!=wc[1] && c!=wc[2]; cnt++){}
drhd2687b72005-08-12 22:56:09 +0000530 if( cnt==0 || 255==(u8)z[cnt] ){
531 return 0;
532 }
drh55ef4d92005-08-14 01:20:37 +0000533 *pisComplete = z[cnt]==wc[0] && z[cnt+1]==0;
drhd2687b72005-08-12 22:56:09 +0000534 *pnPattern = cnt;
535 return 1;
536}
537#endif /* SQLITE_OMIT_LIKE_OPTIMIZATION */
538
drhedb193b2006-06-27 13:20:21 +0000539
540#ifndef SQLITE_OMIT_VIRTUALTABLE
drhfe05af82005-07-21 03:14:59 +0000541/*
drh7f375902006-06-13 17:38:59 +0000542** Check to see if the given expression is of the form
543**
544** column MATCH expr
545**
546** If it is then return TRUE. If not, return FALSE.
547*/
548static int isMatchOfColumn(
549 Expr *pExpr /* Test this expression */
550){
551 ExprList *pList;
552
553 if( pExpr->op!=TK_FUNCTION ){
554 return 0;
555 }
drhedb193b2006-06-27 13:20:21 +0000556 if( pExpr->token.n!=5 ||
557 sqlite3StrNICmp((const char*)pExpr->token.z,"match",5)!=0 ){
drh7f375902006-06-13 17:38:59 +0000558 return 0;
559 }
560 pList = pExpr->pList;
561 if( pList->nExpr!=2 ){
562 return 0;
563 }
564 if( pList->a[1].pExpr->op != TK_COLUMN ){
565 return 0;
566 }
567 return 1;
568}
drhedb193b2006-06-27 13:20:21 +0000569#endif /* SQLITE_OMIT_VIRTUALTABLE */
drh7f375902006-06-13 17:38:59 +0000570
571/*
drh54a167d2005-11-26 14:08:07 +0000572** If the pBase expression originated in the ON or USING clause of
573** a join, then transfer the appropriate markings over to derived.
574*/
575static void transferJoinMarkings(Expr *pDerived, Expr *pBase){
576 pDerived->flags |= pBase->flags & EP_FromJoin;
577 pDerived->iRightJoinTable = pBase->iRightJoinTable;
578}
579
580
581/*
drh0aa74ed2005-07-16 13:33:20 +0000582** The input to this routine is an WhereTerm structure with only the
drh51147ba2005-07-23 22:59:55 +0000583** "pExpr" field filled in. The job of this routine is to analyze the
drh0aa74ed2005-07-16 13:33:20 +0000584** subexpression and populate all the other fields of the WhereTerm
drh75897232000-05-29 14:26:00 +0000585** structure.
drh51147ba2005-07-23 22:59:55 +0000586**
587** If the expression is of the form "<expr> <op> X" it gets commuted
588** to the standard form of "X <op> <expr>". If the expression is of
589** the form "X <op> Y" where both X and Y are columns, then the original
590** expression is unchanged and a new virtual expression of the form
drhb6fb62d2005-09-20 08:47:20 +0000591** "Y <op> X" is added to the WHERE clause and analyzed separately.
drh75897232000-05-29 14:26:00 +0000592*/
drh0fcef5e2005-07-19 17:38:22 +0000593static void exprAnalyze(
594 SrcList *pSrc, /* the FROM clause */
595 ExprMaskSet *pMaskSet, /* table masks */
drh9eb20282005-08-24 03:52:18 +0000596 WhereClause *pWC, /* the WHERE clause */
597 int idxTerm /* Index of the term to be analyzed */
drh0fcef5e2005-07-19 17:38:22 +0000598){
drh9eb20282005-08-24 03:52:18 +0000599 WhereTerm *pTerm = &pWC->a[idxTerm];
drh0fcef5e2005-07-19 17:38:22 +0000600 Expr *pExpr = pTerm->pExpr;
601 Bitmask prereqLeft;
602 Bitmask prereqAll;
drhd2687b72005-08-12 22:56:09 +0000603 int nPattern;
604 int isComplete;
drh50b39962006-10-28 00:28:09 +0000605 int op;
drh0fcef5e2005-07-19 17:38:22 +0000606
danielk19779e128002006-01-18 16:51:35 +0000607 if( sqlite3MallocFailed() ) return;
drh0fcef5e2005-07-19 17:38:22 +0000608 prereqLeft = exprTableUsage(pMaskSet, pExpr->pLeft);
drh50b39962006-10-28 00:28:09 +0000609 op = pExpr->op;
610 if( op==TK_IN ){
drhf5b11382005-09-17 13:07:13 +0000611 assert( pExpr->pRight==0 );
612 pTerm->prereqRight = exprListTableUsage(pMaskSet, pExpr->pList)
613 | exprSelectTableUsage(pMaskSet, pExpr->pSelect);
drh50b39962006-10-28 00:28:09 +0000614 }else if( op==TK_ISNULL ){
615 pTerm->prereqRight = 0;
drhf5b11382005-09-17 13:07:13 +0000616 }else{
617 pTerm->prereqRight = exprTableUsage(pMaskSet, pExpr->pRight);
618 }
drh22d6a532005-09-19 21:05:48 +0000619 prereqAll = exprTableUsage(pMaskSet, pExpr);
620 if( ExprHasProperty(pExpr, EP_FromJoin) ){
621 prereqAll |= getMask(pMaskSet, pExpr->iRightJoinTable);
622 }
623 pTerm->prereqAll = prereqAll;
drh0fcef5e2005-07-19 17:38:22 +0000624 pTerm->leftCursor = -1;
drh45b1ee42005-08-02 17:48:22 +0000625 pTerm->iParent = -1;
drhb52076c2006-01-23 13:22:09 +0000626 pTerm->eOperator = 0;
drh50b39962006-10-28 00:28:09 +0000627 if( allowedOp(op) && (pTerm->prereqRight & prereqLeft)==0 ){
drh0fcef5e2005-07-19 17:38:22 +0000628 Expr *pLeft = pExpr->pLeft;
629 Expr *pRight = pExpr->pRight;
630 if( pLeft->op==TK_COLUMN ){
631 pTerm->leftCursor = pLeft->iTable;
632 pTerm->leftColumn = pLeft->iColumn;
drh50b39962006-10-28 00:28:09 +0000633 pTerm->eOperator = operatorMask(op);
drh75897232000-05-29 14:26:00 +0000634 }
drh0fcef5e2005-07-19 17:38:22 +0000635 if( pRight && pRight->op==TK_COLUMN ){
636 WhereTerm *pNew;
637 Expr *pDup;
638 if( pTerm->leftCursor>=0 ){
drh9eb20282005-08-24 03:52:18 +0000639 int idxNew;
drh0fcef5e2005-07-19 17:38:22 +0000640 pDup = sqlite3ExprDup(pExpr);
drh28f45912006-10-18 23:26:38 +0000641 if( sqlite3MallocFailed() ){
642 sqliteFree(pDup);
643 return;
644 }
drh9eb20282005-08-24 03:52:18 +0000645 idxNew = whereClauseInsert(pWC, pDup, TERM_VIRTUAL|TERM_DYNAMIC);
646 if( idxNew==0 ) return;
647 pNew = &pWC->a[idxNew];
648 pNew->iParent = idxTerm;
649 pTerm = &pWC->a[idxTerm];
drh45b1ee42005-08-02 17:48:22 +0000650 pTerm->nChild = 1;
651 pTerm->flags |= TERM_COPIED;
drh0fcef5e2005-07-19 17:38:22 +0000652 }else{
653 pDup = pExpr;
654 pNew = pTerm;
655 }
656 exprCommute(pDup);
657 pLeft = pDup->pLeft;
658 pNew->leftCursor = pLeft->iTable;
659 pNew->leftColumn = pLeft->iColumn;
660 pNew->prereqRight = prereqLeft;
661 pNew->prereqAll = prereqAll;
drhb52076c2006-01-23 13:22:09 +0000662 pNew->eOperator = operatorMask(pDup->op);
drh75897232000-05-29 14:26:00 +0000663 }
664 }
drhed378002005-07-28 23:12:08 +0000665
drhd2687b72005-08-12 22:56:09 +0000666#ifndef SQLITE_OMIT_BETWEEN_OPTIMIZATION
drhed378002005-07-28 23:12:08 +0000667 /* If a term is the BETWEEN operator, create two new virtual terms
668 ** that define the range that the BETWEEN implements.
669 */
670 else if( pExpr->op==TK_BETWEEN ){
671 ExprList *pList = pExpr->pList;
672 int i;
673 static const u8 ops[] = {TK_GE, TK_LE};
674 assert( pList!=0 );
675 assert( pList->nExpr==2 );
676 for(i=0; i<2; i++){
677 Expr *pNewExpr;
drh9eb20282005-08-24 03:52:18 +0000678 int idxNew;
drhed378002005-07-28 23:12:08 +0000679 pNewExpr = sqlite3Expr(ops[i], sqlite3ExprDup(pExpr->pLeft),
680 sqlite3ExprDup(pList->a[i].pExpr), 0);
drh9eb20282005-08-24 03:52:18 +0000681 idxNew = whereClauseInsert(pWC, pNewExpr, TERM_VIRTUAL|TERM_DYNAMIC);
682 exprAnalyze(pSrc, pMaskSet, pWC, idxNew);
683 pTerm = &pWC->a[idxTerm];
684 pWC->a[idxNew].iParent = idxTerm;
drhed378002005-07-28 23:12:08 +0000685 }
drh45b1ee42005-08-02 17:48:22 +0000686 pTerm->nChild = 2;
drhed378002005-07-28 23:12:08 +0000687 }
drhd2687b72005-08-12 22:56:09 +0000688#endif /* SQLITE_OMIT_BETWEEN_OPTIMIZATION */
drhed378002005-07-28 23:12:08 +0000689
danielk19771576cd92006-01-14 08:02:28 +0000690#if !defined(SQLITE_OMIT_OR_OPTIMIZATION) && !defined(SQLITE_OMIT_SUBQUERY)
drh6c30be82005-07-29 15:10:17 +0000691 /* Attempt to convert OR-connected terms into an IN operator so that
drhf5b11382005-09-17 13:07:13 +0000692 ** they can make use of indices. Example:
693 **
694 ** x = expr1 OR expr2 = x OR x = expr3
695 **
696 ** is converted into
697 **
698 ** x IN (expr1,expr2,expr3)
danielk19771576cd92006-01-14 08:02:28 +0000699 **
700 ** This optimization must be omitted if OMIT_SUBQUERY is defined because
701 ** the compiler for the the IN operator is part of sub-queries.
drh6c30be82005-07-29 15:10:17 +0000702 */
703 else if( pExpr->op==TK_OR ){
704 int ok;
705 int i, j;
706 int iColumn, iCursor;
707 WhereClause sOr;
708 WhereTerm *pOrTerm;
709
710 assert( (pTerm->flags & TERM_DYNAMIC)==0 );
drh9eb20282005-08-24 03:52:18 +0000711 whereClauseInit(&sOr, pWC->pParse);
drh6c30be82005-07-29 15:10:17 +0000712 whereSplit(&sOr, pExpr, TK_OR);
713 exprAnalyzeAll(pSrc, pMaskSet, &sOr);
714 assert( sOr.nTerm>0 );
715 j = 0;
716 do{
717 iColumn = sOr.a[j].leftColumn;
718 iCursor = sOr.a[j].leftCursor;
719 ok = iCursor>=0;
720 for(i=sOr.nTerm-1, pOrTerm=sOr.a; i>=0 && ok; i--, pOrTerm++){
drhb52076c2006-01-23 13:22:09 +0000721 if( pOrTerm->eOperator!=WO_EQ ){
drh6c30be82005-07-29 15:10:17 +0000722 goto or_not_possible;
723 }
724 if( pOrTerm->leftCursor==iCursor && pOrTerm->leftColumn==iColumn ){
725 pOrTerm->flags |= TERM_OR_OK;
drh45b1ee42005-08-02 17:48:22 +0000726 }else if( (pOrTerm->flags & TERM_COPIED)!=0 ||
drh6c30be82005-07-29 15:10:17 +0000727 ((pOrTerm->flags & TERM_VIRTUAL)!=0 &&
drh45b1ee42005-08-02 17:48:22 +0000728 (sOr.a[pOrTerm->iParent].flags & TERM_OR_OK)!=0) ){
drh6c30be82005-07-29 15:10:17 +0000729 pOrTerm->flags &= ~TERM_OR_OK;
730 }else{
731 ok = 0;
732 }
733 }
drh45b1ee42005-08-02 17:48:22 +0000734 }while( !ok && (sOr.a[j++].flags & TERM_COPIED)!=0 && j<sOr.nTerm );
drh6c30be82005-07-29 15:10:17 +0000735 if( ok ){
736 ExprList *pList = 0;
737 Expr *pNew, *pDup;
drh38276582006-11-06 15:10:05 +0000738 Expr *pLeft = 0;
drh6c30be82005-07-29 15:10:17 +0000739 for(i=sOr.nTerm-1, pOrTerm=sOr.a; i>=0 && ok; i--, pOrTerm++){
740 if( (pOrTerm->flags & TERM_OR_OK)==0 ) continue;
741 pDup = sqlite3ExprDup(pOrTerm->pExpr->pRight);
742 pList = sqlite3ExprListAppend(pList, pDup, 0);
drh38276582006-11-06 15:10:05 +0000743 pLeft = pOrTerm->pExpr->pLeft;
drh6c30be82005-07-29 15:10:17 +0000744 }
drh38276582006-11-06 15:10:05 +0000745 assert( pLeft!=0 );
746 pDup = sqlite3ExprDup(pLeft);
drh6c30be82005-07-29 15:10:17 +0000747 pNew = sqlite3Expr(TK_IN, pDup, 0, 0);
drh53f733c2005-09-16 02:38:09 +0000748 if( pNew ){
drh9a5f7472005-11-26 14:24:40 +0000749 int idxNew;
drh54a167d2005-11-26 14:08:07 +0000750 transferJoinMarkings(pNew, pExpr);
drh53f733c2005-09-16 02:38:09 +0000751 pNew->pList = pList;
drh9a5f7472005-11-26 14:24:40 +0000752 idxNew = whereClauseInsert(pWC, pNew, TERM_VIRTUAL|TERM_DYNAMIC);
753 exprAnalyze(pSrc, pMaskSet, pWC, idxNew);
754 pTerm = &pWC->a[idxTerm];
755 pWC->a[idxNew].iParent = idxTerm;
756 pTerm->nChild = 1;
drh53f733c2005-09-16 02:38:09 +0000757 }else{
758 sqlite3ExprListDelete(pList);
759 }
drh6c30be82005-07-29 15:10:17 +0000760 }
761or_not_possible:
762 whereClauseClear(&sOr);
763 }
drhd2687b72005-08-12 22:56:09 +0000764#endif /* SQLITE_OMIT_OR_OPTIMIZATION */
765
766#ifndef SQLITE_OMIT_LIKE_OPTIMIZATION
767 /* Add constraints to reduce the search space on a LIKE or GLOB
768 ** operator.
769 */
drh9eb20282005-08-24 03:52:18 +0000770 if( isLikeOrGlob(pWC->pParse->db, pExpr, &nPattern, &isComplete) ){
drhd2687b72005-08-12 22:56:09 +0000771 Expr *pLeft, *pRight;
772 Expr *pStr1, *pStr2;
773 Expr *pNewExpr1, *pNewExpr2;
drh9eb20282005-08-24 03:52:18 +0000774 int idxNew1, idxNew2;
775
drhd2687b72005-08-12 22:56:09 +0000776 pLeft = pExpr->pList->a[1].pExpr;
777 pRight = pExpr->pList->a[0].pExpr;
778 pStr1 = sqlite3Expr(TK_STRING, 0, 0, 0);
779 if( pStr1 ){
780 sqlite3TokenCopy(&pStr1->token, &pRight->token);
781 pStr1->token.n = nPattern;
782 }
783 pStr2 = sqlite3ExprDup(pStr1);
784 if( pStr2 ){
785 assert( pStr2->token.dyn );
786 ++*(u8*)&pStr2->token.z[nPattern-1];
787 }
788 pNewExpr1 = sqlite3Expr(TK_GE, sqlite3ExprDup(pLeft), pStr1, 0);
drh9eb20282005-08-24 03:52:18 +0000789 idxNew1 = whereClauseInsert(pWC, pNewExpr1, TERM_VIRTUAL|TERM_DYNAMIC);
790 exprAnalyze(pSrc, pMaskSet, pWC, idxNew1);
drhd2687b72005-08-12 22:56:09 +0000791 pNewExpr2 = sqlite3Expr(TK_LT, sqlite3ExprDup(pLeft), pStr2, 0);
drh9eb20282005-08-24 03:52:18 +0000792 idxNew2 = whereClauseInsert(pWC, pNewExpr2, TERM_VIRTUAL|TERM_DYNAMIC);
793 exprAnalyze(pSrc, pMaskSet, pWC, idxNew2);
794 pTerm = &pWC->a[idxTerm];
drhd2687b72005-08-12 22:56:09 +0000795 if( isComplete ){
drh9eb20282005-08-24 03:52:18 +0000796 pWC->a[idxNew1].iParent = idxTerm;
797 pWC->a[idxNew2].iParent = idxTerm;
drhd2687b72005-08-12 22:56:09 +0000798 pTerm->nChild = 2;
799 }
800 }
801#endif /* SQLITE_OMIT_LIKE_OPTIMIZATION */
drh7f375902006-06-13 17:38:59 +0000802
803#ifndef SQLITE_OMIT_VIRTUALTABLE
804 /* Add a WO_MATCH auxiliary term to the constraint set if the
805 ** current expression is of the form: column MATCH expr.
806 ** This information is used by the xBestIndex methods of
807 ** virtual tables. The native query optimizer does not attempt
808 ** to do anything with MATCH functions.
809 */
810 if( isMatchOfColumn(pExpr) ){
811 int idxNew;
812 Expr *pRight, *pLeft;
813 WhereTerm *pNewTerm;
814 Bitmask prereqColumn, prereqExpr;
815
816 pRight = pExpr->pList->a[0].pExpr;
817 pLeft = pExpr->pList->a[1].pExpr;
818 prereqExpr = exprTableUsage(pMaskSet, pRight);
819 prereqColumn = exprTableUsage(pMaskSet, pLeft);
820 if( (prereqExpr & prereqColumn)==0 ){
drh1a90e092006-06-14 22:07:10 +0000821 Expr *pNewExpr;
822 pNewExpr = sqlite3Expr(TK_MATCH, 0, sqlite3ExprDup(pRight), 0);
823 idxNew = whereClauseInsert(pWC, pNewExpr, TERM_VIRTUAL|TERM_DYNAMIC);
drh7f375902006-06-13 17:38:59 +0000824 pNewTerm = &pWC->a[idxNew];
825 pNewTerm->prereqRight = prereqExpr;
826 pNewTerm->leftCursor = pLeft->iTable;
827 pNewTerm->leftColumn = pLeft->iColumn;
828 pNewTerm->eOperator = WO_MATCH;
829 pNewTerm->iParent = idxTerm;
drhd2ca60d2006-06-27 02:36:58 +0000830 pTerm = &pWC->a[idxTerm];
drh7f375902006-06-13 17:38:59 +0000831 pTerm->nChild = 1;
832 pTerm->flags |= TERM_COPIED;
833 pNewTerm->prereqAll = pTerm->prereqAll;
834 }
835 }
836#endif /* SQLITE_OMIT_VIRTUALTABLE */
drh75897232000-05-29 14:26:00 +0000837}
838
drh0fcef5e2005-07-19 17:38:22 +0000839
drh75897232000-05-29 14:26:00 +0000840/*
drh51669862004-12-18 18:40:26 +0000841** This routine decides if pIdx can be used to satisfy the ORDER BY
842** clause. If it can, it returns 1. If pIdx cannot satisfy the
843** ORDER BY clause, this routine returns 0.
844**
845** pOrderBy is an ORDER BY clause from a SELECT statement. pTab is the
846** left-most table in the FROM clause of that same SELECT statement and
847** the table has a cursor number of "base". pIdx is an index on pTab.
848**
849** nEqCol is the number of columns of pIdx that are used as equality
850** constraints. Any of these columns may be missing from the ORDER BY
851** clause and the match can still be a success.
852**
drh51669862004-12-18 18:40:26 +0000853** All terms of the ORDER BY that match against the index must be either
854** ASC or DESC. (Terms of the ORDER BY clause past the end of a UNIQUE
855** index do not need to satisfy this constraint.) The *pbRev value is
856** set to 1 if the ORDER BY clause is all DESC and it is set to 0 if
857** the ORDER BY clause is all ASC.
858*/
859static int isSortingIndex(
860 Parse *pParse, /* Parsing context */
861 Index *pIdx, /* The index we are testing */
drh74161702006-02-24 02:53:49 +0000862 int base, /* Cursor number for the table to be sorted */
drh51669862004-12-18 18:40:26 +0000863 ExprList *pOrderBy, /* The ORDER BY clause */
864 int nEqCol, /* Number of index columns with == constraints */
865 int *pbRev /* Set to 1 if ORDER BY is DESC */
866){
drhb46b5772005-08-29 16:40:52 +0000867 int i, j; /* Loop counters */
drh85eeb692005-12-21 03:16:42 +0000868 int sortOrder = 0; /* XOR of index and ORDER BY sort direction */
drhb46b5772005-08-29 16:40:52 +0000869 int nTerm; /* Number of ORDER BY terms */
870 struct ExprList_item *pTerm; /* A term of the ORDER BY clause */
drh51669862004-12-18 18:40:26 +0000871 sqlite3 *db = pParse->db;
872
873 assert( pOrderBy!=0 );
874 nTerm = pOrderBy->nExpr;
875 assert( nTerm>0 );
876
877 /* Match terms of the ORDER BY clause against columns of
878 ** the index.
drhcc192542006-12-20 03:24:19 +0000879 **
880 ** Note that indices have pIdx->nColumn regular columns plus
881 ** one additional column containing the rowid. The rowid column
882 ** of the index is also allowed to match against the ORDER BY
883 ** clause.
drh51669862004-12-18 18:40:26 +0000884 */
drhcc192542006-12-20 03:24:19 +0000885 for(i=j=0, pTerm=pOrderBy->a; j<nTerm && i<=pIdx->nColumn; i++){
drh51669862004-12-18 18:40:26 +0000886 Expr *pExpr; /* The expression of the ORDER BY pTerm */
887 CollSeq *pColl; /* The collating sequence of pExpr */
drh85eeb692005-12-21 03:16:42 +0000888 int termSortOrder; /* Sort order for this term */
drhcc192542006-12-20 03:24:19 +0000889 int iColumn; /* The i-th column of the index. -1 for rowid */
890 int iSortOrder; /* 1 for DESC, 0 for ASC on the i-th index term */
891 const char *zColl; /* Name of the collating sequence for i-th index term */
drh51669862004-12-18 18:40:26 +0000892
893 pExpr = pTerm->pExpr;
894 if( pExpr->op!=TK_COLUMN || pExpr->iTable!=base ){
895 /* Can not use an index sort on anything that is not a column in the
896 ** left-most table of the FROM clause */
897 return 0;
898 }
899 pColl = sqlite3ExprCollSeq(pParse, pExpr);
drhcc192542006-12-20 03:24:19 +0000900 if( !pColl ){
901 pColl = db->pDfltColl;
902 }
903 if( i<pIdx->nColumn ){
904 iColumn = pIdx->aiColumn[i];
905 if( iColumn==pIdx->pTable->iPKey ){
906 iColumn = -1;
907 }
908 iSortOrder = pIdx->aSortOrder[i];
909 zColl = pIdx->azColl[i];
910 }else{
911 iColumn = -1;
912 iSortOrder = 0;
913 zColl = pColl->zName;
914 }
915 if( pExpr->iColumn!=iColumn || sqlite3StrICmp(pColl->zName, zColl) ){
drh9012bcb2004-12-19 00:11:35 +0000916 /* Term j of the ORDER BY clause does not match column i of the index */
917 if( i<nEqCol ){
drh51669862004-12-18 18:40:26 +0000918 /* If an index column that is constrained by == fails to match an
919 ** ORDER BY term, that is OK. Just ignore that column of the index
920 */
921 continue;
922 }else{
923 /* If an index column fails to match and is not constrained by ==
924 ** then the index cannot satisfy the ORDER BY constraint.
925 */
926 return 0;
927 }
928 }
danielk1977b3bf5562006-01-10 17:58:23 +0000929 assert( pIdx->aSortOrder!=0 );
drh85eeb692005-12-21 03:16:42 +0000930 assert( pTerm->sortOrder==0 || pTerm->sortOrder==1 );
drhcc192542006-12-20 03:24:19 +0000931 assert( iSortOrder==0 || iSortOrder==1 );
932 termSortOrder = iSortOrder ^ pTerm->sortOrder;
drh51669862004-12-18 18:40:26 +0000933 if( i>nEqCol ){
drh85eeb692005-12-21 03:16:42 +0000934 if( termSortOrder!=sortOrder ){
drh51669862004-12-18 18:40:26 +0000935 /* Indices can only be used if all ORDER BY terms past the
936 ** equality constraints are all either DESC or ASC. */
937 return 0;
938 }
939 }else{
drh85eeb692005-12-21 03:16:42 +0000940 sortOrder = termSortOrder;
drh51669862004-12-18 18:40:26 +0000941 }
942 j++;
943 pTerm++;
drhcc192542006-12-20 03:24:19 +0000944 if( iColumn<0 ){
945 /* If the indexed column is the primary key and everything matches
946 ** so far, then we are assured that the index can be used to sort
947 ** because the primary key is unique and so none of the other columns
948 ** will make any difference
949 */
950 j = nTerm;
951 }
drh51669862004-12-18 18:40:26 +0000952 }
953
drhcc192542006-12-20 03:24:19 +0000954 *pbRev = sortOrder!=0;
drh8718f522005-08-13 16:13:04 +0000955 if( j>=nTerm ){
drhcc192542006-12-20 03:24:19 +0000956 /* All terms of the ORDER BY clause are covered by this index so
957 ** this index can be used for sorting. */
958 return 1;
959 }
960 if( j==pIdx->nColumn && pIdx->onError!=OE_None ){
961 /* All terms of this index match some prefix of the ORDER BY clause
962 ** and this index is UNIQUE, so this index can be used for sorting. */
drh51669862004-12-18 18:40:26 +0000963 return 1;
964 }
965 return 0;
966}
967
968/*
drhb6c29892004-11-22 19:12:19 +0000969** Check table to see if the ORDER BY clause in pOrderBy can be satisfied
970** by sorting in order of ROWID. Return true if so and set *pbRev to be
971** true for reverse ROWID and false for forward ROWID order.
972*/
973static int sortableByRowid(
974 int base, /* Cursor number for table to be sorted */
975 ExprList *pOrderBy, /* The ORDER BY clause */
976 int *pbRev /* Set to 1 if ORDER BY is DESC */
977){
978 Expr *p;
979
980 assert( pOrderBy!=0 );
981 assert( pOrderBy->nExpr>0 );
982 p = pOrderBy->a[0].pExpr;
drhcc192542006-12-20 03:24:19 +0000983 if( p->op==TK_COLUMN && p->iTable==base && p->iColumn==-1 ){
drhb6c29892004-11-22 19:12:19 +0000984 *pbRev = pOrderBy->a[0].sortOrder;
985 return 1;
986 }
987 return 0;
988}
989
drhfe05af82005-07-21 03:14:59 +0000990/*
drhb6fb62d2005-09-20 08:47:20 +0000991** Prepare a crude estimate of the logarithm of the input value.
drh28c4cf42005-07-27 20:41:43 +0000992** The results need not be exact. This is only used for estimating
993** the total cost of performing operatings with O(logN) or O(NlogN)
994** complexity. Because N is just a guess, it is no great tragedy if
995** logN is a little off.
drh28c4cf42005-07-27 20:41:43 +0000996*/
997static double estLog(double N){
drhb37df7b2005-10-13 02:09:49 +0000998 double logN = 1;
999 double x = 10;
drh28c4cf42005-07-27 20:41:43 +00001000 while( N>x ){
drhb37df7b2005-10-13 02:09:49 +00001001 logN += 1;
drh28c4cf42005-07-27 20:41:43 +00001002 x *= 10;
1003 }
1004 return logN;
1005}
1006
drh6d209d82006-06-27 01:54:26 +00001007/*
1008** Two routines for printing the content of an sqlite3_index_info
1009** structure. Used for testing and debugging only. If neither
1010** SQLITE_TEST or SQLITE_DEBUG are defined, then these routines
1011** are no-ops.
1012*/
1013#if !defined(SQLITE_OMIT_VIRTUALTABLE) && \
1014 (defined(SQLITE_TEST) || defined(SQLITE_DEBUG))
1015static void TRACE_IDX_INPUTS(sqlite3_index_info *p){
1016 int i;
1017 if( !sqlite3_where_trace ) return;
1018 for(i=0; i<p->nConstraint; i++){
1019 sqlite3DebugPrintf(" constraint[%d]: col=%d termid=%d op=%d usabled=%d\n",
1020 i,
1021 p->aConstraint[i].iColumn,
1022 p->aConstraint[i].iTermOffset,
1023 p->aConstraint[i].op,
1024 p->aConstraint[i].usable);
1025 }
1026 for(i=0; i<p->nOrderBy; i++){
1027 sqlite3DebugPrintf(" orderby[%d]: col=%d desc=%d\n",
1028 i,
1029 p->aOrderBy[i].iColumn,
1030 p->aOrderBy[i].desc);
1031 }
1032}
1033static void TRACE_IDX_OUTPUTS(sqlite3_index_info *p){
1034 int i;
1035 if( !sqlite3_where_trace ) return;
1036 for(i=0; i<p->nConstraint; i++){
1037 sqlite3DebugPrintf(" usage[%d]: argvIdx=%d omit=%d\n",
1038 i,
1039 p->aConstraintUsage[i].argvIndex,
1040 p->aConstraintUsage[i].omit);
1041 }
1042 sqlite3DebugPrintf(" idxNum=%d\n", p->idxNum);
1043 sqlite3DebugPrintf(" idxStr=%s\n", p->idxStr);
1044 sqlite3DebugPrintf(" orderByConsumed=%d\n", p->orderByConsumed);
1045 sqlite3DebugPrintf(" estimatedCost=%g\n", p->estimatedCost);
1046}
1047#else
1048#define TRACE_IDX_INPUTS(A)
1049#define TRACE_IDX_OUTPUTS(A)
1050#endif
1051
drh9eff6162006-06-12 21:59:13 +00001052#ifndef SQLITE_OMIT_VIRTUALTABLE
1053/*
drh7f375902006-06-13 17:38:59 +00001054** Compute the best index for a virtual table.
1055**
1056** The best index is computed by the xBestIndex method of the virtual
1057** table module. This routine is really just a wrapper that sets up
1058** the sqlite3_index_info structure that is used to communicate with
1059** xBestIndex.
1060**
1061** In a join, this routine might be called multiple times for the
1062** same virtual table. The sqlite3_index_info structure is created
1063** and initialized on the first invocation and reused on all subsequent
1064** invocations. The sqlite3_index_info structure is also used when
1065** code is generated to access the virtual table. The whereInfoDelete()
1066** routine takes care of freeing the sqlite3_index_info structure after
1067** everybody has finished with it.
drh9eff6162006-06-12 21:59:13 +00001068*/
1069static double bestVirtualIndex(
1070 Parse *pParse, /* The parsing context */
1071 WhereClause *pWC, /* The WHERE clause */
1072 struct SrcList_item *pSrc, /* The FROM clause term to search */
1073 Bitmask notReady, /* Mask of cursors that are not available */
1074 ExprList *pOrderBy, /* The order by clause */
1075 int orderByUsable, /* True if we can potential sort */
1076 sqlite3_index_info **ppIdxInfo /* Index information passed to xBestIndex */
1077){
1078 Table *pTab = pSrc->pTab;
1079 sqlite3_index_info *pIdxInfo;
1080 struct sqlite3_index_constraint *pIdxCons;
1081 struct sqlite3_index_orderby *pIdxOrderBy;
1082 struct sqlite3_index_constraint_usage *pUsage;
1083 WhereTerm *pTerm;
1084 int i, j;
1085 int nOrderBy;
danielk197774cdba42006-06-19 12:02:58 +00001086 int rc;
drh9eff6162006-06-12 21:59:13 +00001087
1088 /* If the sqlite3_index_info structure has not been previously
1089 ** allocated and initialized for this virtual table, then allocate
1090 ** and initialize it now
1091 */
1092 pIdxInfo = *ppIdxInfo;
1093 if( pIdxInfo==0 ){
1094 WhereTerm *pTerm;
1095 int nTerm;
drh6d209d82006-06-27 01:54:26 +00001096 TRACE(("Recomputing index info for %s...\n", pTab->zName));
drh9eff6162006-06-12 21:59:13 +00001097
1098 /* Count the number of possible WHERE clause constraints referring
1099 ** to this virtual table */
1100 for(i=nTerm=0, pTerm=pWC->a; i<pWC->nTerm; i++, pTerm++){
1101 if( pTerm->leftCursor != pSrc->iCursor ) continue;
1102 if( pTerm->eOperator==WO_IN ) continue;
1103 nTerm++;
1104 }
1105
1106 /* If the ORDER BY clause contains only columns in the current
1107 ** virtual table then allocate space for the aOrderBy part of
1108 ** the sqlite3_index_info structure.
1109 */
1110 nOrderBy = 0;
1111 if( pOrderBy ){
1112 for(i=0; i<pOrderBy->nExpr; i++){
1113 Expr *pExpr = pOrderBy->a[i].pExpr;
1114 if( pExpr->op!=TK_COLUMN || pExpr->iTable!=pSrc->iCursor ) break;
1115 }
1116 if( i==pOrderBy->nExpr ){
1117 nOrderBy = pOrderBy->nExpr;
1118 }
1119 }
1120
1121 /* Allocate the sqlite3_index_info structure
1122 */
1123 pIdxInfo = sqliteMalloc( sizeof(*pIdxInfo)
1124 + (sizeof(*pIdxCons) + sizeof(*pUsage))*nTerm
1125 + sizeof(*pIdxOrderBy)*nOrderBy );
1126 if( pIdxInfo==0 ){
1127 sqlite3ErrorMsg(pParse, "out of memory");
1128 return 0.0;
1129 }
1130 *ppIdxInfo = pIdxInfo;
1131
1132 /* Initialize the structure. The sqlite3_index_info structure contains
1133 ** many fields that are declared "const" to prevent xBestIndex from
1134 ** changing them. We have to do some funky casting in order to
1135 ** initialize those fields.
1136 */
1137 pIdxCons = (struct sqlite3_index_constraint*)&pIdxInfo[1];
1138 pIdxOrderBy = (struct sqlite3_index_orderby*)&pIdxCons[nTerm];
1139 pUsage = (struct sqlite3_index_constraint_usage*)&pIdxOrderBy[nOrderBy];
1140 *(int*)&pIdxInfo->nConstraint = nTerm;
1141 *(int*)&pIdxInfo->nOrderBy = nOrderBy;
1142 *(struct sqlite3_index_constraint**)&pIdxInfo->aConstraint = pIdxCons;
1143 *(struct sqlite3_index_orderby**)&pIdxInfo->aOrderBy = pIdxOrderBy;
1144 *(struct sqlite3_index_constraint_usage**)&pIdxInfo->aConstraintUsage =
1145 pUsage;
1146
1147 for(i=j=0, pTerm=pWC->a; i<pWC->nTerm; i++, pTerm++){
1148 if( pTerm->leftCursor != pSrc->iCursor ) continue;
1149 if( pTerm->eOperator==WO_IN ) continue;
1150 pIdxCons[j].iColumn = pTerm->leftColumn;
1151 pIdxCons[j].iTermOffset = i;
1152 pIdxCons[j].op = pTerm->eOperator;
drh7f375902006-06-13 17:38:59 +00001153 /* The direct assignment in the previous line is possible only because
1154 ** the WO_ and SQLITE_INDEX_CONSTRAINT_ codes are identical. The
1155 ** following asserts verify this fact. */
drh9eff6162006-06-12 21:59:13 +00001156 assert( WO_EQ==SQLITE_INDEX_CONSTRAINT_EQ );
1157 assert( WO_LT==SQLITE_INDEX_CONSTRAINT_LT );
1158 assert( WO_LE==SQLITE_INDEX_CONSTRAINT_LE );
1159 assert( WO_GT==SQLITE_INDEX_CONSTRAINT_GT );
1160 assert( WO_GE==SQLITE_INDEX_CONSTRAINT_GE );
drh7f375902006-06-13 17:38:59 +00001161 assert( WO_MATCH==SQLITE_INDEX_CONSTRAINT_MATCH );
1162 assert( pTerm->eOperator & (WO_EQ|WO_LT|WO_LE|WO_GT|WO_GE|WO_MATCH) );
drh9eff6162006-06-12 21:59:13 +00001163 j++;
1164 }
1165 for(i=0; i<nOrderBy; i++){
1166 Expr *pExpr = pOrderBy->a[i].pExpr;
1167 pIdxOrderBy[i].iColumn = pExpr->iColumn;
1168 pIdxOrderBy[i].desc = pOrderBy->a[i].sortOrder;
1169 }
1170 }
1171
drh7f375902006-06-13 17:38:59 +00001172 /* At this point, the sqlite3_index_info structure that pIdxInfo points
1173 ** to will have been initialized, either during the current invocation or
1174 ** during some prior invocation. Now we just have to customize the
1175 ** details of pIdxInfo for the current invocation and pass it to
1176 ** xBestIndex.
1177 */
1178
drh9eff6162006-06-12 21:59:13 +00001179 /* The module name must be defined */
1180 assert( pTab->azModuleArg && pTab->azModuleArg[0] );
1181 if( pTab->pVtab==0 ){
1182 sqlite3ErrorMsg(pParse, "undefined module %s for table %s",
1183 pTab->azModuleArg[0], pTab->zName);
1184 return 0.0;
1185 }
1186
1187 /* Set the aConstraint[].usable fields and initialize all
drh7f375902006-06-13 17:38:59 +00001188 ** output variables to zero.
1189 **
1190 ** aConstraint[].usable is true for constraints where the right-hand
1191 ** side contains only references to tables to the left of the current
1192 ** table. In other words, if the constraint is of the form:
1193 **
1194 ** column = expr
1195 **
1196 ** and we are evaluating a join, then the constraint on column is
1197 ** only valid if all tables referenced in expr occur to the left
1198 ** of the table containing column.
1199 **
1200 ** The aConstraints[] array contains entries for all constraints
1201 ** on the current table. That way we only have to compute it once
1202 ** even though we might try to pick the best index multiple times.
1203 ** For each attempt at picking an index, the order of tables in the
1204 ** join might be different so we have to recompute the usable flag
1205 ** each time.
drh9eff6162006-06-12 21:59:13 +00001206 */
1207 pIdxCons = *(struct sqlite3_index_constraint**)&pIdxInfo->aConstraint;
1208 pUsage = pIdxInfo->aConstraintUsage;
1209 for(i=0; i<pIdxInfo->nConstraint; i++, pIdxCons++){
1210 j = pIdxCons->iTermOffset;
1211 pTerm = &pWC->a[j];
1212 pIdxCons->usable = (pTerm->prereqRight & notReady)==0;
1213 }
1214 memset(pUsage, 0, sizeof(pUsage[0])*pIdxInfo->nConstraint);
drh4be8b512006-06-13 23:51:34 +00001215 if( pIdxInfo->needToFreeIdxStr ){
1216 sqlite3_free(pIdxInfo->idxStr);
1217 }
1218 pIdxInfo->idxStr = 0;
1219 pIdxInfo->idxNum = 0;
1220 pIdxInfo->needToFreeIdxStr = 0;
drh9eff6162006-06-12 21:59:13 +00001221 pIdxInfo->orderByConsumed = 0;
danielk197793626f42006-06-20 13:07:27 +00001222 pIdxInfo->estimatedCost = SQLITE_BIG_DBL / 2.0;
drh9eff6162006-06-12 21:59:13 +00001223 nOrderBy = pIdxInfo->nOrderBy;
1224 if( pIdxInfo->nOrderBy && !orderByUsable ){
drha967e882006-06-13 01:04:52 +00001225 *(int*)&pIdxInfo->nOrderBy = 0;
drh9eff6162006-06-12 21:59:13 +00001226 }
danielk197774cdba42006-06-19 12:02:58 +00001227
1228 sqlite3SafetyOff(pParse->db);
drh6d209d82006-06-27 01:54:26 +00001229 TRACE(("xBestIndex for %s\n", pTab->zName));
1230 TRACE_IDX_INPUTS(pIdxInfo);
danielk1977be718892006-06-23 08:05:19 +00001231 rc = pTab->pVtab->pModule->xBestIndex(pTab->pVtab, pIdxInfo);
drh6d209d82006-06-27 01:54:26 +00001232 TRACE_IDX_OUTPUTS(pIdxInfo);
danielk197774cdba42006-06-19 12:02:58 +00001233 if( rc!=SQLITE_OK ){
danielk1977be718892006-06-23 08:05:19 +00001234 if( rc==SQLITE_NOMEM ){
1235 sqlite3FailedMalloc();
1236 }else {
1237 sqlite3ErrorMsg(pParse, "%s", sqlite3ErrStr(rc));
1238 }
1239 sqlite3SafetyOn(pParse->db);
1240 }else{
1241 rc = sqlite3SafetyOn(pParse->db);
danielk197774cdba42006-06-19 12:02:58 +00001242 }
drha967e882006-06-13 01:04:52 +00001243 *(int*)&pIdxInfo->nOrderBy = nOrderBy;
drh9eff6162006-06-12 21:59:13 +00001244 return pIdxInfo->estimatedCost;
1245}
1246#endif /* SQLITE_OMIT_VIRTUALTABLE */
1247
drh28c4cf42005-07-27 20:41:43 +00001248/*
drh51147ba2005-07-23 22:59:55 +00001249** Find the best index for accessing a particular table. Return a pointer
1250** to the index, flags that describe how the index should be used, the
drha6110402005-07-28 20:51:19 +00001251** number of equality constraints, and the "cost" for this index.
drh51147ba2005-07-23 22:59:55 +00001252**
1253** The lowest cost index wins. The cost is an estimate of the amount of
1254** CPU and disk I/O need to process the request using the selected index.
1255** Factors that influence cost include:
1256**
1257** * The estimated number of rows that will be retrieved. (The
1258** fewer the better.)
1259**
1260** * Whether or not sorting must occur.
1261**
1262** * Whether or not there must be separate lookups in the
1263** index and in the main table.
1264**
drhfe05af82005-07-21 03:14:59 +00001265*/
1266static double bestIndex(
1267 Parse *pParse, /* The parsing context */
1268 WhereClause *pWC, /* The WHERE clause */
1269 struct SrcList_item *pSrc, /* The FROM clause term to search */
1270 Bitmask notReady, /* Mask of cursors that are not available */
1271 ExprList *pOrderBy, /* The order by clause */
1272 Index **ppIndex, /* Make *ppIndex point to the best index */
drh51147ba2005-07-23 22:59:55 +00001273 int *pFlags, /* Put flags describing this choice in *pFlags */
1274 int *pnEq /* Put the number of == or IN constraints here */
drhfe05af82005-07-21 03:14:59 +00001275){
1276 WhereTerm *pTerm;
drh51147ba2005-07-23 22:59:55 +00001277 Index *bestIdx = 0; /* Index that gives the lowest cost */
drhb37df7b2005-10-13 02:09:49 +00001278 double lowestCost; /* The cost of using bestIdx */
drh51147ba2005-07-23 22:59:55 +00001279 int bestFlags = 0; /* Flags associated with bestIdx */
1280 int bestNEq = 0; /* Best value for nEq */
1281 int iCur = pSrc->iCursor; /* The cursor of the table to be accessed */
1282 Index *pProbe; /* An index we are evaluating */
1283 int rev; /* True to scan in reverse order */
1284 int flags; /* Flags associated with pProbe */
1285 int nEq; /* Number of == or IN constraints */
drhc49de5d2007-01-19 01:06:01 +00001286 int eqTermMask; /* Mask of valid equality operators */
drh51147ba2005-07-23 22:59:55 +00001287 double cost; /* Cost of using pProbe */
drhfe05af82005-07-21 03:14:59 +00001288
drh51147ba2005-07-23 22:59:55 +00001289 TRACE(("bestIndex: tbl=%s notReady=%x\n", pSrc->pTab->zName, notReady));
drhb37df7b2005-10-13 02:09:49 +00001290 lowestCost = SQLITE_BIG_DBL;
drh4dd238a2006-03-28 23:55:57 +00001291 pProbe = pSrc->pTab->pIndex;
1292
1293 /* If the table has no indices and there are no terms in the where
1294 ** clause that refer to the ROWID, then we will never be able to do
1295 ** anything other than a full table scan on this table. We might as
1296 ** well put it first in the join order. That way, perhaps it can be
1297 ** referenced by other tables in the join.
1298 */
1299 if( pProbe==0 &&
1300 findTerm(pWC, iCur, -1, 0, WO_EQ|WO_IN|WO_LT|WO_LE|WO_GT|WO_GE,0)==0 &&
1301 (pOrderBy==0 || !sortableByRowid(iCur, pOrderBy, &rev)) ){
1302 *pFlags = 0;
1303 *ppIndex = 0;
1304 *pnEq = 0;
1305 return 0.0;
1306 }
drh51147ba2005-07-23 22:59:55 +00001307
1308 /* Check for a rowid=EXPR or rowid IN (...) constraints
drhfe05af82005-07-21 03:14:59 +00001309 */
1310 pTerm = findTerm(pWC, iCur, -1, notReady, WO_EQ|WO_IN, 0);
1311 if( pTerm ){
drha6110402005-07-28 20:51:19 +00001312 Expr *pExpr;
drhfe05af82005-07-21 03:14:59 +00001313 *ppIndex = 0;
drh51147ba2005-07-23 22:59:55 +00001314 bestFlags = WHERE_ROWID_EQ;
drhb52076c2006-01-23 13:22:09 +00001315 if( pTerm->eOperator & WO_EQ ){
drh28c4cf42005-07-27 20:41:43 +00001316 /* Rowid== is always the best pick. Look no further. Because only
1317 ** a single row is generated, output is always in sorted order */
drh943af3c2005-07-29 19:43:58 +00001318 *pFlags = WHERE_ROWID_EQ | WHERE_UNIQUE;
drh51147ba2005-07-23 22:59:55 +00001319 *pnEq = 1;
drh51147ba2005-07-23 22:59:55 +00001320 TRACE(("... best is rowid\n"));
1321 return 0.0;
drha6110402005-07-28 20:51:19 +00001322 }else if( (pExpr = pTerm->pExpr)->pList!=0 ){
drh28c4cf42005-07-27 20:41:43 +00001323 /* Rowid IN (LIST): cost is NlogN where N is the number of list
1324 ** elements. */
drha6110402005-07-28 20:51:19 +00001325 lowestCost = pExpr->pList->nExpr;
drh28c4cf42005-07-27 20:41:43 +00001326 lowestCost *= estLog(lowestCost);
drhfe05af82005-07-21 03:14:59 +00001327 }else{
drh28c4cf42005-07-27 20:41:43 +00001328 /* Rowid IN (SELECT): cost is NlogN where N is the number of rows
1329 ** in the result of the inner select. We have no way to estimate
1330 ** that value so make a wild guess. */
drhb37df7b2005-10-13 02:09:49 +00001331 lowestCost = 200;
drhfe05af82005-07-21 03:14:59 +00001332 }
drh3adc9ce2005-07-28 16:51:51 +00001333 TRACE(("... rowid IN cost: %.9g\n", lowestCost));
drhfe05af82005-07-21 03:14:59 +00001334 }
1335
drh28c4cf42005-07-27 20:41:43 +00001336 /* Estimate the cost of a table scan. If we do not know how many
1337 ** entries are in the table, use 1 million as a guess.
drhfe05af82005-07-21 03:14:59 +00001338 */
drhb37df7b2005-10-13 02:09:49 +00001339 cost = pProbe ? pProbe->aiRowEst[0] : 1000000;
drh3adc9ce2005-07-28 16:51:51 +00001340 TRACE(("... table scan base cost: %.9g\n", cost));
drh28c4cf42005-07-27 20:41:43 +00001341 flags = WHERE_ROWID_RANGE;
1342
1343 /* Check for constraints on a range of rowids in a table scan.
1344 */
drhfe05af82005-07-21 03:14:59 +00001345 pTerm = findTerm(pWC, iCur, -1, notReady, WO_LT|WO_LE|WO_GT|WO_GE, 0);
1346 if( pTerm ){
drh51147ba2005-07-23 22:59:55 +00001347 if( findTerm(pWC, iCur, -1, notReady, WO_LT|WO_LE, 0) ){
1348 flags |= WHERE_TOP_LIMIT;
drhb37df7b2005-10-13 02:09:49 +00001349 cost /= 3; /* Guess that rowid<EXPR eliminates two-thirds or rows */
drhfe05af82005-07-21 03:14:59 +00001350 }
drh51147ba2005-07-23 22:59:55 +00001351 if( findTerm(pWC, iCur, -1, notReady, WO_GT|WO_GE, 0) ){
1352 flags |= WHERE_BTM_LIMIT;
drhb37df7b2005-10-13 02:09:49 +00001353 cost /= 3; /* Guess that rowid>EXPR eliminates two-thirds of rows */
drhfe05af82005-07-21 03:14:59 +00001354 }
drh3adc9ce2005-07-28 16:51:51 +00001355 TRACE(("... rowid range reduces cost to %.9g\n", cost));
drh51147ba2005-07-23 22:59:55 +00001356 }else{
1357 flags = 0;
1358 }
drh28c4cf42005-07-27 20:41:43 +00001359
1360 /* If the table scan does not satisfy the ORDER BY clause, increase
1361 ** the cost by NlogN to cover the expense of sorting. */
1362 if( pOrderBy ){
1363 if( sortableByRowid(iCur, pOrderBy, &rev) ){
1364 flags |= WHERE_ORDERBY|WHERE_ROWID_RANGE;
1365 if( rev ){
1366 flags |= WHERE_REVERSE;
1367 }
1368 }else{
1369 cost += cost*estLog(cost);
drh3adc9ce2005-07-28 16:51:51 +00001370 TRACE(("... sorting increases cost to %.9g\n", cost));
drh51147ba2005-07-23 22:59:55 +00001371 }
drh51147ba2005-07-23 22:59:55 +00001372 }
1373 if( cost<lowestCost ){
1374 lowestCost = cost;
drhfe05af82005-07-21 03:14:59 +00001375 bestFlags = flags;
1376 }
1377
drhc49de5d2007-01-19 01:06:01 +00001378 /* If the pSrc table is the right table of a LEFT JOIN then we may not
1379 ** use an index to satisfy IS NULL constraints on that table. This is
1380 ** because columns might end up being NULL if the table does not match -
1381 ** a circumstance which the index cannot help us discover. Ticket #2177.
1382 */
1383 if( (pSrc->jointype & JT_LEFT)!=0 ){
1384 eqTermMask = WO_EQ|WO_IN;
1385 }else{
1386 eqTermMask = WO_EQ|WO_IN|WO_ISNULL;
1387 }
1388
drhfe05af82005-07-21 03:14:59 +00001389 /* Look at each index.
1390 */
drh51147ba2005-07-23 22:59:55 +00001391 for(; pProbe; pProbe=pProbe->pNext){
1392 int i; /* Loop counter */
drhb37df7b2005-10-13 02:09:49 +00001393 double inMultiplier = 1;
drh51147ba2005-07-23 22:59:55 +00001394
1395 TRACE(("... index %s:\n", pProbe->zName));
drhfe05af82005-07-21 03:14:59 +00001396
1397 /* Count the number of columns in the index that are satisfied
1398 ** by x=EXPR constraints or x IN (...) constraints.
1399 */
drh51147ba2005-07-23 22:59:55 +00001400 flags = 0;
drhfe05af82005-07-21 03:14:59 +00001401 for(i=0; i<pProbe->nColumn; i++){
1402 int j = pProbe->aiColumn[i];
drhc49de5d2007-01-19 01:06:01 +00001403 pTerm = findTerm(pWC, iCur, j, notReady, eqTermMask, pProbe);
drhfe05af82005-07-21 03:14:59 +00001404 if( pTerm==0 ) break;
drh51147ba2005-07-23 22:59:55 +00001405 flags |= WHERE_COLUMN_EQ;
drhb52076c2006-01-23 13:22:09 +00001406 if( pTerm->eOperator & WO_IN ){
drha6110402005-07-28 20:51:19 +00001407 Expr *pExpr = pTerm->pExpr;
drh51147ba2005-07-23 22:59:55 +00001408 flags |= WHERE_COLUMN_IN;
drha6110402005-07-28 20:51:19 +00001409 if( pExpr->pSelect!=0 ){
drhffe0f892006-05-11 13:26:25 +00001410 inMultiplier *= 25;
drha6110402005-07-28 20:51:19 +00001411 }else if( pExpr->pList!=0 ){
drhb37df7b2005-10-13 02:09:49 +00001412 inMultiplier *= pExpr->pList->nExpr + 1;
drhfe05af82005-07-21 03:14:59 +00001413 }
1414 }
1415 }
drh28c4cf42005-07-27 20:41:43 +00001416 cost = pProbe->aiRowEst[i] * inMultiplier * estLog(inMultiplier);
drh51147ba2005-07-23 22:59:55 +00001417 nEq = i;
drh943af3c2005-07-29 19:43:58 +00001418 if( pProbe->onError!=OE_None && (flags & WHERE_COLUMN_IN)==0
1419 && nEq==pProbe->nColumn ){
1420 flags |= WHERE_UNIQUE;
1421 }
drh3adc9ce2005-07-28 16:51:51 +00001422 TRACE(("...... nEq=%d inMult=%.9g cost=%.9g\n", nEq, inMultiplier, cost));
drhfe05af82005-07-21 03:14:59 +00001423
drh51147ba2005-07-23 22:59:55 +00001424 /* Look for range constraints
drhfe05af82005-07-21 03:14:59 +00001425 */
drh51147ba2005-07-23 22:59:55 +00001426 if( nEq<pProbe->nColumn ){
1427 int j = pProbe->aiColumn[nEq];
1428 pTerm = findTerm(pWC, iCur, j, notReady, WO_LT|WO_LE|WO_GT|WO_GE, pProbe);
1429 if( pTerm ){
drha6110402005-07-28 20:51:19 +00001430 flags |= WHERE_COLUMN_RANGE;
drh51147ba2005-07-23 22:59:55 +00001431 if( findTerm(pWC, iCur, j, notReady, WO_LT|WO_LE, pProbe) ){
1432 flags |= WHERE_TOP_LIMIT;
drhb37df7b2005-10-13 02:09:49 +00001433 cost /= 3;
drh51147ba2005-07-23 22:59:55 +00001434 }
1435 if( findTerm(pWC, iCur, j, notReady, WO_GT|WO_GE, pProbe) ){
1436 flags |= WHERE_BTM_LIMIT;
drhb37df7b2005-10-13 02:09:49 +00001437 cost /= 3;
drh51147ba2005-07-23 22:59:55 +00001438 }
drh3adc9ce2005-07-28 16:51:51 +00001439 TRACE(("...... range reduces cost to %.9g\n", cost));
drh51147ba2005-07-23 22:59:55 +00001440 }
1441 }
1442
drh28c4cf42005-07-27 20:41:43 +00001443 /* Add the additional cost of sorting if that is a factor.
drh51147ba2005-07-23 22:59:55 +00001444 */
drh28c4cf42005-07-27 20:41:43 +00001445 if( pOrderBy ){
1446 if( (flags & WHERE_COLUMN_IN)==0 &&
drh74161702006-02-24 02:53:49 +00001447 isSortingIndex(pParse,pProbe,iCur,pOrderBy,nEq,&rev) ){
drh28c4cf42005-07-27 20:41:43 +00001448 if( flags==0 ){
1449 flags = WHERE_COLUMN_RANGE;
1450 }
1451 flags |= WHERE_ORDERBY;
1452 if( rev ){
1453 flags |= WHERE_REVERSE;
1454 }
1455 }else{
1456 cost += cost*estLog(cost);
drh3adc9ce2005-07-28 16:51:51 +00001457 TRACE(("...... orderby increases cost to %.9g\n", cost));
drh51147ba2005-07-23 22:59:55 +00001458 }
drhfe05af82005-07-21 03:14:59 +00001459 }
1460
1461 /* Check to see if we can get away with using just the index without
drh51147ba2005-07-23 22:59:55 +00001462 ** ever reading the table. If that is the case, then halve the
1463 ** cost of this index.
drhfe05af82005-07-21 03:14:59 +00001464 */
drh51147ba2005-07-23 22:59:55 +00001465 if( flags && pSrc->colUsed < (((Bitmask)1)<<(BMS-1)) ){
drhfe05af82005-07-21 03:14:59 +00001466 Bitmask m = pSrc->colUsed;
1467 int j;
1468 for(j=0; j<pProbe->nColumn; j++){
1469 int x = pProbe->aiColumn[j];
1470 if( x<BMS-1 ){
1471 m &= ~(((Bitmask)1)<<x);
1472 }
1473 }
1474 if( m==0 ){
1475 flags |= WHERE_IDX_ONLY;
drhb37df7b2005-10-13 02:09:49 +00001476 cost /= 2;
drh3adc9ce2005-07-28 16:51:51 +00001477 TRACE(("...... idx-only reduces cost to %.9g\n", cost));
drhfe05af82005-07-21 03:14:59 +00001478 }
1479 }
1480
drh51147ba2005-07-23 22:59:55 +00001481 /* If this index has achieved the lowest cost so far, then use it.
drhfe05af82005-07-21 03:14:59 +00001482 */
drh51147ba2005-07-23 22:59:55 +00001483 if( cost < lowestCost ){
drhfe05af82005-07-21 03:14:59 +00001484 bestIdx = pProbe;
drh51147ba2005-07-23 22:59:55 +00001485 lowestCost = cost;
drha6110402005-07-28 20:51:19 +00001486 assert( flags!=0 );
drhfe05af82005-07-21 03:14:59 +00001487 bestFlags = flags;
drh51147ba2005-07-23 22:59:55 +00001488 bestNEq = nEq;
drhfe05af82005-07-21 03:14:59 +00001489 }
1490 }
1491
drhfe05af82005-07-21 03:14:59 +00001492 /* Report the best result
1493 */
1494 *ppIndex = bestIdx;
drh3adc9ce2005-07-28 16:51:51 +00001495 TRACE(("best index is %s, cost=%.9g, flags=%x, nEq=%d\n",
drh51147ba2005-07-23 22:59:55 +00001496 bestIdx ? bestIdx->zName : "(none)", lowestCost, bestFlags, bestNEq));
drhf2d315d2007-01-25 16:56:06 +00001497 *pFlags = bestFlags | eqTermMask;
drh51147ba2005-07-23 22:59:55 +00001498 *pnEq = bestNEq;
1499 return lowestCost;
drhfe05af82005-07-21 03:14:59 +00001500}
1501
drhb6c29892004-11-22 19:12:19 +00001502
1503/*
drh2ffb1182004-07-19 19:14:01 +00001504** Disable a term in the WHERE clause. Except, do not disable the term
1505** if it controls a LEFT OUTER JOIN and it did not originate in the ON
1506** or USING clause of that join.
1507**
1508** Consider the term t2.z='ok' in the following queries:
1509**
1510** (1) SELECT * FROM t1 LEFT JOIN t2 ON t1.a=t2.x WHERE t2.z='ok'
1511** (2) SELECT * FROM t1 LEFT JOIN t2 ON t1.a=t2.x AND t2.z='ok'
1512** (3) SELECT * FROM t1, t2 WHERE t1.a=t2.x AND t2.z='ok'
1513**
drh23bf66d2004-12-14 03:34:34 +00001514** The t2.z='ok' is disabled in the in (2) because it originates
drh2ffb1182004-07-19 19:14:01 +00001515** in the ON clause. The term is disabled in (3) because it is not part
1516** of a LEFT OUTER JOIN. In (1), the term is not disabled.
1517**
1518** Disabling a term causes that term to not be tested in the inner loop
drhb6fb62d2005-09-20 08:47:20 +00001519** of the join. Disabling is an optimization. When terms are satisfied
1520** by indices, we disable them to prevent redundant tests in the inner
1521** loop. We would get the correct results if nothing were ever disabled,
1522** but joins might run a little slower. The trick is to disable as much
1523** as we can without disabling too much. If we disabled in (1), we'd get
1524** the wrong answer. See ticket #813.
drh2ffb1182004-07-19 19:14:01 +00001525*/
drh0fcef5e2005-07-19 17:38:22 +00001526static void disableTerm(WhereLevel *pLevel, WhereTerm *pTerm){
1527 if( pTerm
1528 && (pTerm->flags & TERM_CODED)==0
1529 && (pLevel->iLeftJoin==0 || ExprHasProperty(pTerm->pExpr, EP_FromJoin))
1530 ){
1531 pTerm->flags |= TERM_CODED;
drh45b1ee42005-08-02 17:48:22 +00001532 if( pTerm->iParent>=0 ){
1533 WhereTerm *pOther = &pTerm->pWC->a[pTerm->iParent];
1534 if( (--pOther->nChild)==0 ){
drhed378002005-07-28 23:12:08 +00001535 disableTerm(pLevel, pOther);
1536 }
drh0fcef5e2005-07-19 17:38:22 +00001537 }
drh2ffb1182004-07-19 19:14:01 +00001538 }
1539}
1540
1541/*
drh50b39962006-10-28 00:28:09 +00001542** Generate code that builds a probe for an index.
drh94a11212004-09-25 13:12:14 +00001543**
drh50b39962006-10-28 00:28:09 +00001544** There should be nColumn values on the stack. The index
1545** to be probed is pIdx. Pop the values from the stack and
1546** replace them all with a single record that is the index
1547** problem.
drh94a11212004-09-25 13:12:14 +00001548*/
danielk1977327bd592006-01-13 13:01:19 +00001549static void buildIndexProbe(
drh0660e262006-10-27 14:06:57 +00001550 Vdbe *v, /* Generate code into this VM */
1551 int nColumn, /* The number of columns to check for NULL */
drh0660e262006-10-27 14:06:57 +00001552 Index *pIdx /* Index that we will be searching */
danielk1977327bd592006-01-13 13:01:19 +00001553){
drh94a11212004-09-25 13:12:14 +00001554 sqlite3VdbeAddOp(v, OP_MakeRecord, nColumn, 0);
1555 sqlite3IndexAffinityStr(v, pIdx);
1556}
1557
drhe8b97272005-07-19 22:22:12 +00001558
1559/*
drh51147ba2005-07-23 22:59:55 +00001560** Generate code for a single equality term of the WHERE clause. An equality
1561** term can be either X=expr or X IN (...). pTerm is the term to be
1562** coded.
1563**
1564** The current value for the constraint is left on the top of the stack.
1565**
1566** For a constraint of the form X=expr, the expression is evaluated and its
1567** result is left on the stack. For constraints of the form X IN (...)
1568** this routine sets up a loop that will iterate over all values of X.
drh94a11212004-09-25 13:12:14 +00001569*/
1570static void codeEqualityTerm(
1571 Parse *pParse, /* The parsing context */
drhe23399f2005-07-22 00:31:39 +00001572 WhereTerm *pTerm, /* The term of the WHERE clause to be coded */
drh94a11212004-09-25 13:12:14 +00001573 int brk, /* Jump here to abandon the loop */
1574 WhereLevel *pLevel /* When level of the FROM clause we are working on */
1575){
drh0fcef5e2005-07-19 17:38:22 +00001576 Expr *pX = pTerm->pExpr;
drh50b39962006-10-28 00:28:09 +00001577 Vdbe *v = pParse->pVdbe;
1578 if( pX->op==TK_EQ ){
drh94a11212004-09-25 13:12:14 +00001579 sqlite3ExprCode(pParse, pX->pRight);
drh50b39962006-10-28 00:28:09 +00001580 }else if( pX->op==TK_ISNULL ){
1581 sqlite3VdbeAddOp(v, OP_Null, 0, 0);
danielk1977b3bce662005-01-29 08:32:43 +00001582#ifndef SQLITE_OMIT_SUBQUERY
drh94a11212004-09-25 13:12:14 +00001583 }else{
danielk1977b3bce662005-01-29 08:32:43 +00001584 int iTab;
drhe23399f2005-07-22 00:31:39 +00001585 int *aIn;
danielk1977b3bce662005-01-29 08:32:43 +00001586
drh50b39962006-10-28 00:28:09 +00001587 assert( pX->op==TK_IN );
danielk1977b3bce662005-01-29 08:32:43 +00001588 sqlite3CodeSubselect(pParse, pX);
1589 iTab = pX->iTable;
drhffe0f892006-05-11 13:26:25 +00001590 sqlite3VdbeAddOp(v, OP_Rewind, iTab, 0);
danielk1977b3bce662005-01-29 08:32:43 +00001591 VdbeComment((v, "# %.*s", pX->span.n, pX->span.z));
drhe23399f2005-07-22 00:31:39 +00001592 pLevel->nIn++;
danielk1977e7259292006-01-13 06:33:23 +00001593 sqliteReallocOrFree((void**)&pLevel->aInLoop,
drhffe0f892006-05-11 13:26:25 +00001594 sizeof(pLevel->aInLoop[0])*2*pLevel->nIn);
drh53f733c2005-09-16 02:38:09 +00001595 aIn = pLevel->aInLoop;
drhe23399f2005-07-22 00:31:39 +00001596 if( aIn ){
drhffe0f892006-05-11 13:26:25 +00001597 aIn += pLevel->nIn*2 - 2;
1598 aIn[0] = iTab;
1599 aIn[1] = sqlite3VdbeAddOp(v, OP_Column, iTab, 0);
drha6110402005-07-28 20:51:19 +00001600 }else{
1601 pLevel->nIn = 0;
drhe23399f2005-07-22 00:31:39 +00001602 }
danielk1977b3bce662005-01-29 08:32:43 +00001603#endif
drh94a11212004-09-25 13:12:14 +00001604 }
drh0fcef5e2005-07-19 17:38:22 +00001605 disableTerm(pLevel, pTerm);
drh94a11212004-09-25 13:12:14 +00001606}
1607
drh51147ba2005-07-23 22:59:55 +00001608/*
1609** Generate code that will evaluate all == and IN constraints for an
1610** index. The values for all constraints are left on the stack.
1611**
1612** For example, consider table t1(a,b,c,d,e,f) with index i1(a,b,c).
1613** Suppose the WHERE clause is this: a==5 AND b IN (1,2,3) AND c>5 AND c<10
1614** The index has as many as three equality constraints, but in this
1615** example, the third "c" value is an inequality. So only two
1616** constraints are coded. This routine will generate code to evaluate
1617** a==5 and b IN (1,2,3). The current values for a and b will be left
1618** on the stack - a is the deepest and b the shallowest.
1619**
1620** In the example above nEq==2. But this subroutine works for any value
1621** of nEq including 0. If nEq==0, this routine is nearly a no-op.
1622** The only thing it does is allocate the pLevel->iMem memory cell.
1623**
1624** This routine always allocates at least one memory cell and puts
1625** the address of that memory cell in pLevel->iMem. The code that
1626** calls this routine will use pLevel->iMem to store the termination
1627** key value of the loop. If one or more IN operators appear, then
1628** this routine allocates an additional nEq memory cells for internal
1629** use.
1630*/
1631static void codeAllEqualityTerms(
1632 Parse *pParse, /* Parsing context */
1633 WhereLevel *pLevel, /* Which nested loop of the FROM we are coding */
1634 WhereClause *pWC, /* The WHERE clause */
1635 Bitmask notReady, /* Which parts of FROM have not yet been coded */
1636 int brk /* Jump here to end the loop */
1637){
1638 int nEq = pLevel->nEq; /* The number of == or IN constraints to code */
1639 int termsInMem = 0; /* If true, store value in mem[] cells */
1640 Vdbe *v = pParse->pVdbe; /* The virtual machine under construction */
1641 Index *pIdx = pLevel->pIdx; /* The index being used for this loop */
1642 int iCur = pLevel->iTabCur; /* The cursor of the table */
1643 WhereTerm *pTerm; /* A single constraint term */
1644 int j; /* Loop counter */
1645
1646 /* Figure out how many memory cells we will need then allocate them.
1647 ** We always need at least one used to store the loop terminator
1648 ** value. If there are IN operators we'll need one for each == or
1649 ** IN constraint.
1650 */
1651 pLevel->iMem = pParse->nMem++;
1652 if( pLevel->flags & WHERE_COLUMN_IN ){
1653 pParse->nMem += pLevel->nEq;
1654 termsInMem = 1;
1655 }
1656
1657 /* Evaluate the equality constraints
1658 */
drhc49de5d2007-01-19 01:06:01 +00001659 assert( pIdx->nColumn>=nEq );
1660 for(j=0; j<nEq; j++){
drh51147ba2005-07-23 22:59:55 +00001661 int k = pIdx->aiColumn[j];
drhf2d315d2007-01-25 16:56:06 +00001662 pTerm = findTerm(pWC, iCur, k, notReady, pLevel->flags, pIdx);
drh51147ba2005-07-23 22:59:55 +00001663 if( pTerm==0 ) break;
1664 assert( (pTerm->flags & TERM_CODED)==0 );
1665 codeEqualityTerm(pParse, pTerm, brk, pLevel);
drh50b39962006-10-28 00:28:09 +00001666 if( (pTerm->eOperator & WO_ISNULL)==0 ){
1667 sqlite3VdbeAddOp(v, OP_IsNull, termsInMem ? -1 : -(j+1), brk);
1668 }
drh51147ba2005-07-23 22:59:55 +00001669 if( termsInMem ){
1670 sqlite3VdbeAddOp(v, OP_MemStore, pLevel->iMem+j+1, 1);
1671 }
1672 }
drh51147ba2005-07-23 22:59:55 +00001673
1674 /* Make sure all the constraint values are on the top of the stack
1675 */
1676 if( termsInMem ){
1677 for(j=0; j<nEq; j++){
1678 sqlite3VdbeAddOp(v, OP_MemLoad, pLevel->iMem+j+1, 0);
1679 }
1680 }
1681}
1682
drh549c8b62005-09-19 13:15:23 +00001683#if defined(SQLITE_TEST)
drh84bfda42005-07-15 13:05:21 +00001684/*
1685** The following variable holds a text description of query plan generated
1686** by the most recent call to sqlite3WhereBegin(). Each call to WhereBegin
1687** overwrites the previous. This information is used for testing and
1688** analysis only.
1689*/
1690char sqlite3_query_plan[BMS*2*40]; /* Text of the join */
1691static int nQPlan = 0; /* Next free slow in _query_plan[] */
1692
1693#endif /* SQLITE_TEST */
1694
1695
drh9eff6162006-06-12 21:59:13 +00001696/*
1697** Free a WhereInfo structure
1698*/
1699static void whereInfoFree(WhereInfo *pWInfo){
1700 if( pWInfo ){
1701 int i;
1702 for(i=0; i<pWInfo->nLevel; i++){
drh4be8b512006-06-13 23:51:34 +00001703 sqlite3_index_info *pInfo = pWInfo->a[i].pIdxInfo;
1704 if( pInfo ){
1705 if( pInfo->needToFreeIdxStr ){
1706 sqlite3_free(pInfo->idxStr);
1707 }
1708 sqliteFree(pInfo);
danielk1977be8a7832006-06-13 15:00:54 +00001709 }
drh9eff6162006-06-12 21:59:13 +00001710 }
1711 sqliteFree(pWInfo);
1712 }
1713}
1714
drh94a11212004-09-25 13:12:14 +00001715
1716/*
drhe3184742002-06-19 14:27:05 +00001717** Generate the beginning of the loop used for WHERE clause processing.
drhacf3b982005-01-03 01:27:18 +00001718** The return value is a pointer to an opaque structure that contains
drh75897232000-05-29 14:26:00 +00001719** information needed to terminate the loop. Later, the calling routine
danielk19774adee202004-05-08 08:23:19 +00001720** should invoke sqlite3WhereEnd() with the return value of this function
drh75897232000-05-29 14:26:00 +00001721** in order to complete the WHERE clause processing.
1722**
1723** If an error occurs, this routine returns NULL.
drhc27a1ce2002-06-14 20:58:45 +00001724**
1725** The basic idea is to do a nested loop, one loop for each table in
1726** the FROM clause of a select. (INSERT and UPDATE statements are the
1727** same as a SELECT with only a single table in the FROM clause.) For
1728** example, if the SQL is this:
1729**
1730** SELECT * FROM t1, t2, t3 WHERE ...;
1731**
1732** Then the code generated is conceptually like the following:
1733**
1734** foreach row1 in t1 do \ Code generated
danielk19774adee202004-05-08 08:23:19 +00001735** foreach row2 in t2 do |-- by sqlite3WhereBegin()
drhc27a1ce2002-06-14 20:58:45 +00001736** foreach row3 in t3 do /
1737** ...
1738** end \ Code generated
danielk19774adee202004-05-08 08:23:19 +00001739** end |-- by sqlite3WhereEnd()
drhc27a1ce2002-06-14 20:58:45 +00001740** end /
1741**
drh29dda4a2005-07-21 18:23:20 +00001742** Note that the loops might not be nested in the order in which they
1743** appear in the FROM clause if a different order is better able to make
drh51147ba2005-07-23 22:59:55 +00001744** use of indices. Note also that when the IN operator appears in
1745** the WHERE clause, it might result in additional nested loops for
1746** scanning through all values on the right-hand side of the IN.
drh29dda4a2005-07-21 18:23:20 +00001747**
drhc27a1ce2002-06-14 20:58:45 +00001748** There are Btree cursors associated with each table. t1 uses cursor
drh6a3ea0e2003-05-02 14:32:12 +00001749** number pTabList->a[0].iCursor. t2 uses the cursor pTabList->a[1].iCursor.
1750** And so forth. This routine generates code to open those VDBE cursors
danielk19774adee202004-05-08 08:23:19 +00001751** and sqlite3WhereEnd() generates the code to close them.
drhc27a1ce2002-06-14 20:58:45 +00001752**
drhe6f85e72004-12-25 01:03:13 +00001753** The code that sqlite3WhereBegin() generates leaves the cursors named
1754** in pTabList pointing at their appropriate entries. The [...] code
drhf0863fe2005-06-12 21:35:51 +00001755** can use OP_Column and OP_Rowid opcodes on these cursors to extract
drhe6f85e72004-12-25 01:03:13 +00001756** data from the various tables of the loop.
1757**
drhc27a1ce2002-06-14 20:58:45 +00001758** If the WHERE clause is empty, the foreach loops must each scan their
1759** entire tables. Thus a three-way join is an O(N^3) operation. But if
1760** the tables have indices and there are terms in the WHERE clause that
1761** refer to those indices, a complete table scan can be avoided and the
1762** code will run much faster. Most of the work of this routine is checking
1763** to see if there are indices that can be used to speed up the loop.
1764**
1765** Terms of the WHERE clause are also used to limit which rows actually
1766** make it to the "..." in the middle of the loop. After each "foreach",
1767** terms of the WHERE clause that use only terms in that loop and outer
1768** loops are evaluated and if false a jump is made around all subsequent
1769** inner loops (or around the "..." if the test occurs within the inner-
1770** most loop)
1771**
1772** OUTER JOINS
1773**
1774** An outer join of tables t1 and t2 is conceptally coded as follows:
1775**
1776** foreach row1 in t1 do
1777** flag = 0
1778** foreach row2 in t2 do
1779** start:
1780** ...
1781** flag = 1
1782** end
drhe3184742002-06-19 14:27:05 +00001783** if flag==0 then
1784** move the row2 cursor to a null row
1785** goto start
1786** fi
drhc27a1ce2002-06-14 20:58:45 +00001787** end
1788**
drhe3184742002-06-19 14:27:05 +00001789** ORDER BY CLAUSE PROCESSING
1790**
1791** *ppOrderBy is a pointer to the ORDER BY clause of a SELECT statement,
1792** if there is one. If there is no ORDER BY clause or if this routine
1793** is called from an UPDATE or DELETE statement, then ppOrderBy is NULL.
1794**
1795** If an index can be used so that the natural output order of the table
1796** scan is correct for the ORDER BY clause, then that index is used and
1797** *ppOrderBy is set to NULL. This is an optimization that prevents an
1798** unnecessary sort of the result set if an index appropriate for the
1799** ORDER BY clause already exists.
1800**
1801** If the where clause loops cannot be arranged to provide the correct
1802** output order, then the *ppOrderBy is unchanged.
drh75897232000-05-29 14:26:00 +00001803*/
danielk19774adee202004-05-08 08:23:19 +00001804WhereInfo *sqlite3WhereBegin(
danielk1977ed326d72004-11-16 15:50:19 +00001805 Parse *pParse, /* The parser context */
1806 SrcList *pTabList, /* A list of all tables to be scanned */
1807 Expr *pWhere, /* The WHERE clause */
drhf8db1bc2005-04-22 02:38:37 +00001808 ExprList **ppOrderBy /* An ORDER BY clause, or NULL */
drh75897232000-05-29 14:26:00 +00001809){
1810 int i; /* Loop counter */
1811 WhereInfo *pWInfo; /* Will become the return value of this function */
1812 Vdbe *v = pParse->pVdbe; /* The virtual database engine */
drhd4f5ee22003-07-16 00:54:31 +00001813 int brk, cont = 0; /* Addresses used during code generation */
drhfe05af82005-07-21 03:14:59 +00001814 Bitmask notReady; /* Cursors that are not yet positioned */
drh0aa74ed2005-07-16 13:33:20 +00001815 WhereTerm *pTerm; /* A single term in the WHERE clause */
1816 ExprMaskSet maskSet; /* The expression mask set */
drh0aa74ed2005-07-16 13:33:20 +00001817 WhereClause wc; /* The WHERE clause is divided into these terms */
drh9012bcb2004-12-19 00:11:35 +00001818 struct SrcList_item *pTabItem; /* A single entry from pTabList */
1819 WhereLevel *pLevel; /* A single level in the pWInfo list */
drh29dda4a2005-07-21 18:23:20 +00001820 int iFrom; /* First unused FROM clause element */
drh943af3c2005-07-29 19:43:58 +00001821 int andFlags; /* AND-ed combination of all wc.a[].flags */
drh75897232000-05-29 14:26:00 +00001822
drh29dda4a2005-07-21 18:23:20 +00001823 /* The number of tables in the FROM clause is limited by the number of
drh1398ad32005-01-19 23:24:50 +00001824 ** bits in a Bitmask
1825 */
drh29dda4a2005-07-21 18:23:20 +00001826 if( pTabList->nSrc>BMS ){
1827 sqlite3ErrorMsg(pParse, "at most %d tables in a join", BMS);
drh1398ad32005-01-19 23:24:50 +00001828 return 0;
1829 }
1830
drh83dcb1a2002-06-28 01:02:38 +00001831 /* Split the WHERE clause into separate subexpressions where each
drh29dda4a2005-07-21 18:23:20 +00001832 ** subexpression is separated by an AND operator.
drh83dcb1a2002-06-28 01:02:38 +00001833 */
drh6a3ea0e2003-05-02 14:32:12 +00001834 initMaskSet(&maskSet);
drhfe05af82005-07-21 03:14:59 +00001835 whereClauseInit(&wc, pParse);
drh6c30be82005-07-29 15:10:17 +00001836 whereSplit(&wc, pWhere, TK_AND);
drh1398ad32005-01-19 23:24:50 +00001837
drh75897232000-05-29 14:26:00 +00001838 /* Allocate and initialize the WhereInfo structure that will become the
1839 ** return value.
1840 */
drhad3cab52002-05-24 02:04:32 +00001841 pWInfo = sqliteMalloc( sizeof(WhereInfo) + pTabList->nSrc*sizeof(WhereLevel));
danielk19779e128002006-01-18 16:51:35 +00001842 if( sqlite3MallocFailed() ){
drhe23399f2005-07-22 00:31:39 +00001843 goto whereBeginNoMem;
drh75897232000-05-29 14:26:00 +00001844 }
danielk197770b6d572006-06-19 04:49:34 +00001845 pWInfo->nLevel = pTabList->nSrc;
drh75897232000-05-29 14:26:00 +00001846 pWInfo->pParse = pParse;
1847 pWInfo->pTabList = pTabList;
danielk19774adee202004-05-08 08:23:19 +00001848 pWInfo->iBreak = sqlite3VdbeMakeLabel(v);
drh08192d52002-04-30 19:20:28 +00001849
1850 /* Special case: a WHERE clause that is constant. Evaluate the
1851 ** expression and either jump over all of the code or fall thru.
1852 */
danielk19774adee202004-05-08 08:23:19 +00001853 if( pWhere && (pTabList->nSrc==0 || sqlite3ExprIsConstant(pWhere)) ){
1854 sqlite3ExprIfFalse(pParse, pWhere, pWInfo->iBreak, 1);
drhdf199a22002-06-14 22:38:41 +00001855 pWhere = 0;
drh08192d52002-04-30 19:20:28 +00001856 }
drh75897232000-05-29 14:26:00 +00001857
drh29dda4a2005-07-21 18:23:20 +00001858 /* Analyze all of the subexpressions. Note that exprAnalyze() might
1859 ** add new virtual terms onto the end of the WHERE clause. We do not
1860 ** want to analyze these virtual terms, so start analyzing at the end
drhb6fb62d2005-09-20 08:47:20 +00001861 ** and work forward so that the added virtual terms are never processed.
drh75897232000-05-29 14:26:00 +00001862 */
drh1398ad32005-01-19 23:24:50 +00001863 for(i=0; i<pTabList->nSrc; i++){
1864 createMask(&maskSet, pTabList->a[i].iCursor);
1865 }
drh6c30be82005-07-29 15:10:17 +00001866 exprAnalyzeAll(pTabList, &maskSet, &wc);
danielk19779e128002006-01-18 16:51:35 +00001867 if( sqlite3MallocFailed() ){
drh0bbaa1b2005-08-19 19:14:12 +00001868 goto whereBeginNoMem;
1869 }
drh75897232000-05-29 14:26:00 +00001870
drh29dda4a2005-07-21 18:23:20 +00001871 /* Chose the best index to use for each table in the FROM clause.
1872 **
drh51147ba2005-07-23 22:59:55 +00001873 ** This loop fills in the following fields:
1874 **
1875 ** pWInfo->a[].pIdx The index to use for this level of the loop.
1876 ** pWInfo->a[].flags WHERE_xxx flags associated with pIdx
1877 ** pWInfo->a[].nEq The number of == and IN constraints
1878 ** pWInfo->a[].iFrom When term of the FROM clause is being coded
1879 ** pWInfo->a[].iTabCur The VDBE cursor for the database table
1880 ** pWInfo->a[].iIdxCur The VDBE cursor for the index
1881 **
1882 ** This loop also figures out the nesting order of tables in the FROM
1883 ** clause.
drh75897232000-05-29 14:26:00 +00001884 */
drhfe05af82005-07-21 03:14:59 +00001885 notReady = ~(Bitmask)0;
drh9012bcb2004-12-19 00:11:35 +00001886 pTabItem = pTabList->a;
1887 pLevel = pWInfo->a;
drh943af3c2005-07-29 19:43:58 +00001888 andFlags = ~0;
drh3dec2232005-09-10 15:28:09 +00001889 TRACE(("*** Optimizer Start ***\n"));
drh29dda4a2005-07-21 18:23:20 +00001890 for(i=iFrom=0, pLevel=pWInfo->a; i<pTabList->nSrc; i++, pLevel++){
1891 Index *pIdx; /* Index for FROM table at pTabItem */
1892 int flags; /* Flags asssociated with pIdx */
drh51147ba2005-07-23 22:59:55 +00001893 int nEq; /* Number of == or IN constraints */
1894 double cost; /* The cost for pIdx */
drh29dda4a2005-07-21 18:23:20 +00001895 int j; /* For looping over FROM tables */
1896 Index *pBest = 0; /* The best index seen so far */
1897 int bestFlags = 0; /* Flags associated with pBest */
drh51147ba2005-07-23 22:59:55 +00001898 int bestNEq = 0; /* nEq associated with pBest */
drhb37df7b2005-10-13 02:09:49 +00001899 double lowestCost; /* Cost of the pBest */
drh02afc862006-01-20 18:10:57 +00001900 int bestJ = 0; /* The value of j */
drh29dda4a2005-07-21 18:23:20 +00001901 Bitmask m; /* Bitmask value for j or bestJ */
drh570b9352006-02-01 02:45:02 +00001902 int once = 0; /* True when first table is seen */
drh6d209d82006-06-27 01:54:26 +00001903 sqlite3_index_info *pIndex; /* Current virtual index */
drh29dda4a2005-07-21 18:23:20 +00001904
drhb37df7b2005-10-13 02:09:49 +00001905 lowestCost = SQLITE_BIG_DBL;
drh29dda4a2005-07-21 18:23:20 +00001906 for(j=iFrom, pTabItem=&pTabList->a[j]; j<pTabList->nSrc; j++, pTabItem++){
drhdf26fd52006-06-06 11:45:54 +00001907 int doNotReorder; /* True if this table should not be reordered */
1908
drh61dfc312006-12-16 16:25:15 +00001909 doNotReorder = (pTabItem->jointype & (JT_LEFT|JT_CROSS))!=0;
drhdf26fd52006-06-06 11:45:54 +00001910 if( once && doNotReorder ) break;
drh29dda4a2005-07-21 18:23:20 +00001911 m = getMask(&maskSet, pTabItem->iCursor);
1912 if( (m & notReady)==0 ){
1913 if( j==iFrom ) iFrom++;
1914 continue;
1915 }
drh9eff6162006-06-12 21:59:13 +00001916 assert( pTabItem->pTab );
1917#ifndef SQLITE_OMIT_VIRTUALTABLE
drh4cbdda92006-06-14 19:00:20 +00001918 if( IsVirtual(pTabItem->pTab) ){
drh6d209d82006-06-27 01:54:26 +00001919 sqlite3_index_info **ppIdxInfo = &pWInfo->a[j].pIdxInfo;
drh9eff6162006-06-12 21:59:13 +00001920 cost = bestVirtualIndex(pParse, &wc, pTabItem, notReady,
1921 ppOrderBy ? *ppOrderBy : 0, i==0,
drh6d209d82006-06-27 01:54:26 +00001922 ppIdxInfo);
drh9eff6162006-06-12 21:59:13 +00001923 flags = WHERE_VIRTUALTABLE;
drh6d209d82006-06-27 01:54:26 +00001924 pIndex = *ppIdxInfo;
danielk197793626f42006-06-20 13:07:27 +00001925 if( pIndex && pIndex->orderByConsumed ){
drh1a90e092006-06-14 22:07:10 +00001926 flags = WHERE_VIRTUALTABLE | WHERE_ORDERBY;
1927 }
drh9eff6162006-06-12 21:59:13 +00001928 pIdx = 0;
1929 nEq = 0;
1930 }else
1931#endif
1932 {
1933 cost = bestIndex(pParse, &wc, pTabItem, notReady,
1934 (i==0 && ppOrderBy) ? *ppOrderBy : 0,
1935 &pIdx, &flags, &nEq);
drh9861a9f2006-06-27 02:33:40 +00001936 pIndex = 0;
drh9eff6162006-06-12 21:59:13 +00001937 }
drh51147ba2005-07-23 22:59:55 +00001938 if( cost<lowestCost ){
drh570b9352006-02-01 02:45:02 +00001939 once = 1;
drh51147ba2005-07-23 22:59:55 +00001940 lowestCost = cost;
drh29dda4a2005-07-21 18:23:20 +00001941 pBest = pIdx;
1942 bestFlags = flags;
drh51147ba2005-07-23 22:59:55 +00001943 bestNEq = nEq;
drh29dda4a2005-07-21 18:23:20 +00001944 bestJ = j;
drh6d209d82006-06-27 01:54:26 +00001945 pLevel->pBestIdx = pIndex;
drh29dda4a2005-07-21 18:23:20 +00001946 }
drhdf26fd52006-06-06 11:45:54 +00001947 if( doNotReorder ) break;
drh29dda4a2005-07-21 18:23:20 +00001948 }
drh3dec2232005-09-10 15:28:09 +00001949 TRACE(("*** Optimizer choose table %d for loop %d\n", bestJ,
1950 pLevel-pWInfo->a));
drh943af3c2005-07-29 19:43:58 +00001951 if( (bestFlags & WHERE_ORDERBY)!=0 ){
drhfe05af82005-07-21 03:14:59 +00001952 *ppOrderBy = 0;
drhc4a3c772001-04-04 11:48:57 +00001953 }
drh943af3c2005-07-29 19:43:58 +00001954 andFlags &= bestFlags;
drh29dda4a2005-07-21 18:23:20 +00001955 pLevel->flags = bestFlags;
drhfe05af82005-07-21 03:14:59 +00001956 pLevel->pIdx = pBest;
drh51147ba2005-07-23 22:59:55 +00001957 pLevel->nEq = bestNEq;
drhe23399f2005-07-22 00:31:39 +00001958 pLevel->aInLoop = 0;
1959 pLevel->nIn = 0;
drhfe05af82005-07-21 03:14:59 +00001960 if( pBest ){
drh9012bcb2004-12-19 00:11:35 +00001961 pLevel->iIdxCur = pParse->nTab++;
drhfe05af82005-07-21 03:14:59 +00001962 }else{
1963 pLevel->iIdxCur = -1;
drh6b563442001-11-07 16:48:26 +00001964 }
drh29dda4a2005-07-21 18:23:20 +00001965 notReady &= ~getMask(&maskSet, pTabList->a[bestJ].iCursor);
1966 pLevel->iFrom = bestJ;
drh75897232000-05-29 14:26:00 +00001967 }
drh3dec2232005-09-10 15:28:09 +00001968 TRACE(("*** Optimizer Finished ***\n"));
drh75897232000-05-29 14:26:00 +00001969
drh943af3c2005-07-29 19:43:58 +00001970 /* If the total query only selects a single row, then the ORDER BY
1971 ** clause is irrelevant.
1972 */
1973 if( (andFlags & WHERE_UNIQUE)!=0 && ppOrderBy ){
1974 *ppOrderBy = 0;
1975 }
1976
drh9012bcb2004-12-19 00:11:35 +00001977 /* Open all tables in the pTabList and any indices selected for
1978 ** searching those tables.
1979 */
1980 sqlite3CodeVerifySchema(pParse, -1); /* Insert the cookie verifier Goto */
drh29dda4a2005-07-21 18:23:20 +00001981 for(i=0, pLevel=pWInfo->a; i<pTabList->nSrc; i++, pLevel++){
danielk1977da184232006-01-05 11:34:32 +00001982 Table *pTab; /* Table to open */
1983 Index *pIx; /* Index used to access pTab (if any) */
1984 int iDb; /* Index of database containing table/index */
drh9012bcb2004-12-19 00:11:35 +00001985 int iIdxCur = pLevel->iIdxCur;
1986
drhecc92422005-09-10 16:46:12 +00001987#ifndef SQLITE_OMIT_EXPLAIN
1988 if( pParse->explain==2 ){
1989 char *zMsg;
1990 struct SrcList_item *pItem = &pTabList->a[pLevel->iFrom];
1991 zMsg = sqlite3MPrintf("TABLE %s", pItem->zName);
1992 if( pItem->zAlias ){
1993 zMsg = sqlite3MPrintf("%z AS %s", zMsg, pItem->zAlias);
1994 }
1995 if( (pIx = pLevel->pIdx)!=0 ){
1996 zMsg = sqlite3MPrintf("%z WITH INDEX %s", zMsg, pIx->zName);
drh36d64932005-11-21 12:46:27 +00001997 }else if( pLevel->flags & (WHERE_ROWID_EQ|WHERE_ROWID_RANGE) ){
drh32daab62005-11-21 12:48:24 +00001998 zMsg = sqlite3MPrintf("%z USING PRIMARY KEY", zMsg);
drhecc92422005-09-10 16:46:12 +00001999 }
drh9eff6162006-06-12 21:59:13 +00002000#ifndef SQLITE_OMIT_VIRTUALTABLE
drh6d209d82006-06-27 01:54:26 +00002001 else if( pLevel->pBestIdx ){
2002 sqlite3_index_info *pBestIdx = pLevel->pBestIdx;
danielk197765fd59f2006-06-24 11:51:33 +00002003 zMsg = sqlite3MPrintf("%z VIRTUAL TABLE INDEX %d:%s", zMsg,
drh6d209d82006-06-27 01:54:26 +00002004 pBestIdx->idxNum, pBestIdx->idxStr);
drh9eff6162006-06-12 21:59:13 +00002005 }
2006#endif
drhe2b39092006-04-21 09:38:36 +00002007 if( pLevel->flags & WHERE_ORDERBY ){
2008 zMsg = sqlite3MPrintf("%z ORDER BY", zMsg);
2009 }
drhecc92422005-09-10 16:46:12 +00002010 sqlite3VdbeOp3(v, OP_Explain, i, pLevel->iFrom, zMsg, P3_DYNAMIC);
2011 }
2012#endif /* SQLITE_OMIT_EXPLAIN */
drh29dda4a2005-07-21 18:23:20 +00002013 pTabItem = &pTabList->a[pLevel->iFrom];
drh9012bcb2004-12-19 00:11:35 +00002014 pTab = pTabItem->pTab;
danielk1977da184232006-01-05 11:34:32 +00002015 iDb = sqlite3SchemaToIndex(pParse->db, pTab->pSchema);
drhb9bb7c12006-06-11 23:41:55 +00002016 if( pTab->isEphem || pTab->pSelect ) continue;
drh9eff6162006-06-12 21:59:13 +00002017#ifndef SQLITE_OMIT_VIRTUALTABLE
drh6d209d82006-06-27 01:54:26 +00002018 if( pLevel->pBestIdx ){
danielk197793626f42006-06-20 13:07:27 +00002019 int iCur = pTabItem->iCursor;
2020 sqlite3VdbeOp3(v, OP_VOpen, iCur, 0, (const char*)pTab->pVtab, P3_VTAB);
drh9eff6162006-06-12 21:59:13 +00002021 }else
2022#endif
drhfe05af82005-07-21 03:14:59 +00002023 if( (pLevel->flags & WHERE_IDX_ONLY)==0 ){
danielk1977c00da102006-01-07 13:21:04 +00002024 sqlite3OpenTable(pParse, pTabItem->iCursor, iDb, pTab, OP_OpenRead);
danielk19779792eef2006-01-13 15:58:43 +00002025 if( pTab->nCol<(sizeof(Bitmask)*8) ){
2026 Bitmask b = pTabItem->colUsed;
2027 int n = 0;
drh74161702006-02-24 02:53:49 +00002028 for(; b; b=b>>1, n++){}
danielk19779792eef2006-01-13 15:58:43 +00002029 sqlite3VdbeChangeP2(v, sqlite3VdbeCurrentAddr(v)-1, n);
2030 assert( n<=pTab->nCol );
2031 }
danielk1977c00da102006-01-07 13:21:04 +00002032 }else{
2033 sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
drh9012bcb2004-12-19 00:11:35 +00002034 }
2035 pLevel->iTabCur = pTabItem->iCursor;
2036 if( (pIx = pLevel->pIdx)!=0 ){
danielk1977b3bf5562006-01-10 17:58:23 +00002037 KeyInfo *pKey = sqlite3IndexKeyinfo(pParse, pIx);
danielk1977da184232006-01-05 11:34:32 +00002038 assert( pIx->pSchema==pTab->pSchema );
2039 sqlite3VdbeAddOp(v, OP_Integer, iDb, 0);
drh29dda4a2005-07-21 18:23:20 +00002040 VdbeComment((v, "# %s", pIx->zName));
drh9012bcb2004-12-19 00:11:35 +00002041 sqlite3VdbeOp3(v, OP_OpenRead, iIdxCur, pIx->tnum,
danielk1977b3bf5562006-01-10 17:58:23 +00002042 (char*)pKey, P3_KEYINFO_HANDOFF);
drh9012bcb2004-12-19 00:11:35 +00002043 }
drh50b39962006-10-28 00:28:09 +00002044 if( (pLevel->flags & (WHERE_IDX_ONLY|WHERE_COLUMN_RANGE))!=0 ){
2045 /* Only call OP_SetNumColumns on the index if we might later use
2046 ** OP_Column on the index. */
drh9012bcb2004-12-19 00:11:35 +00002047 sqlite3VdbeAddOp(v, OP_SetNumColumns, iIdxCur, pIx->nColumn+1);
2048 }
danielk1977da184232006-01-05 11:34:32 +00002049 sqlite3CodeVerifySchema(pParse, iDb);
drh9012bcb2004-12-19 00:11:35 +00002050 }
2051 pWInfo->iTop = sqlite3VdbeCurrentAddr(v);
2052
drh29dda4a2005-07-21 18:23:20 +00002053 /* Generate the code to do the search. Each iteration of the for
2054 ** loop below generates code for a single nested loop of the VM
2055 ** program.
drh75897232000-05-29 14:26:00 +00002056 */
drhfe05af82005-07-21 03:14:59 +00002057 notReady = ~(Bitmask)0;
drh29dda4a2005-07-21 18:23:20 +00002058 for(i=0, pLevel=pWInfo->a; i<pTabList->nSrc; i++, pLevel++){
drhfe05af82005-07-21 03:14:59 +00002059 int j;
drh9012bcb2004-12-19 00:11:35 +00002060 int iCur = pTabItem->iCursor; /* The VDBE cursor for the table */
2061 Index *pIdx; /* The index we will be using */
2062 int iIdxCur; /* The VDBE cursor for the index */
2063 int omitTable; /* True if we use the index only */
drh29dda4a2005-07-21 18:23:20 +00002064 int bRev; /* True if we need to scan in reverse order */
drh9012bcb2004-12-19 00:11:35 +00002065
drh29dda4a2005-07-21 18:23:20 +00002066 pTabItem = &pTabList->a[pLevel->iFrom];
2067 iCur = pTabItem->iCursor;
drh9012bcb2004-12-19 00:11:35 +00002068 pIdx = pLevel->pIdx;
2069 iIdxCur = pLevel->iIdxCur;
drh29dda4a2005-07-21 18:23:20 +00002070 bRev = (pLevel->flags & WHERE_REVERSE)!=0;
drhfe05af82005-07-21 03:14:59 +00002071 omitTable = (pLevel->flags & WHERE_IDX_ONLY)!=0;
drh75897232000-05-29 14:26:00 +00002072
drh29dda4a2005-07-21 18:23:20 +00002073 /* Create labels for the "break" and "continue" instructions
2074 ** for the current loop. Jump to brk to break out of a loop.
2075 ** Jump to cont to go immediately to the next iteration of the
2076 ** loop.
2077 */
2078 brk = pLevel->brk = sqlite3VdbeMakeLabel(v);
2079 cont = pLevel->cont = sqlite3VdbeMakeLabel(v);
2080
drhad2d8302002-05-24 20:31:36 +00002081 /* If this is the right table of a LEFT OUTER JOIN, allocate and
drh174b6192002-12-03 02:22:52 +00002082 ** initialize a memory cell that records if this table matches any
drhc27a1ce2002-06-14 20:58:45 +00002083 ** row of the left table of the join.
drhad2d8302002-05-24 20:31:36 +00002084 */
drh61dfc312006-12-16 16:25:15 +00002085 if( pLevel->iFrom>0 && (pTabItem[0].jointype & JT_LEFT)!=0 ){
drhad2d8302002-05-24 20:31:36 +00002086 if( !pParse->nMem ) pParse->nMem++;
2087 pLevel->iLeftJoin = pParse->nMem++;
drhd654be82005-09-20 17:42:23 +00002088 sqlite3VdbeAddOp(v, OP_MemInt, 0, pLevel->iLeftJoin);
drhad6d9462004-09-19 02:15:24 +00002089 VdbeComment((v, "# init LEFT JOIN no-match flag"));
drhad2d8302002-05-24 20:31:36 +00002090 }
2091
drh9eff6162006-06-12 21:59:13 +00002092#ifndef SQLITE_OMIT_VIRTUALTABLE
drh6d209d82006-06-27 01:54:26 +00002093 if( pLevel->pBestIdx ){
drh7f375902006-06-13 17:38:59 +00002094 /* Case 0: The table is a virtual-table. Use the VFilter and VNext
2095 ** to access the data.
2096 */
drh9861a9f2006-06-27 02:33:40 +00002097 int j;
drh6d209d82006-06-27 01:54:26 +00002098 sqlite3_index_info *pBestIdx = pLevel->pBestIdx;
2099 int nConstraint = pBestIdx->nConstraint;
drh4be8b512006-06-13 23:51:34 +00002100 struct sqlite3_index_constraint_usage *aUsage =
drh6d209d82006-06-27 01:54:26 +00002101 pBestIdx->aConstraintUsage;
drh4be8b512006-06-13 23:51:34 +00002102 const struct sqlite3_index_constraint *aConstraint =
drh6d209d82006-06-27 01:54:26 +00002103 pBestIdx->aConstraint;
drh4be8b512006-06-13 23:51:34 +00002104
drh9861a9f2006-06-27 02:33:40 +00002105 for(j=1; j<=nConstraint; j++){
2106 int k;
2107 for(k=0; k<nConstraint; k++){
2108 if( aUsage[k].argvIndex==j ){
danielk19773851a652006-06-27 12:16:56 +00002109 int iTerm = aConstraint[k].iTermOffset;
drh9861a9f2006-06-27 02:33:40 +00002110 sqlite3ExprCode(pParse, wc.a[iTerm].pExpr->pRight);
drh9eff6162006-06-12 21:59:13 +00002111 break;
2112 }
2113 }
drh9861a9f2006-06-27 02:33:40 +00002114 if( k==nConstraint ) break;
drh9eff6162006-06-12 21:59:13 +00002115 }
drh9861a9f2006-06-27 02:33:40 +00002116 sqlite3VdbeAddOp(v, OP_Integer, j-1, 0);
drh6d209d82006-06-27 01:54:26 +00002117 sqlite3VdbeAddOp(v, OP_Integer, pBestIdx->idxNum, 0);
2118 sqlite3VdbeOp3(v, OP_VFilter, iCur, brk, pBestIdx->idxStr,
2119 pBestIdx->needToFreeIdxStr ? P3_MPRINTF : P3_STATIC);
2120 pBestIdx->needToFreeIdxStr = 0;
drh9861a9f2006-06-27 02:33:40 +00002121 for(j=0; j<pBestIdx->nConstraint; j++){
2122 if( aUsage[j].omit ){
2123 int iTerm = aConstraint[j].iTermOffset;
2124 disableTerm(pLevel, &wc.a[iTerm]);
drh9eff6162006-06-12 21:59:13 +00002125 }
2126 }
2127 pLevel->op = OP_VNext;
drha967e882006-06-13 01:04:52 +00002128 pLevel->p1 = iCur;
2129 pLevel->p2 = sqlite3VdbeCurrentAddr(v);
drh9eff6162006-06-12 21:59:13 +00002130 }else
2131#endif /* SQLITE_OMIT_VIRTUALTABLE */
2132
drhfe05af82005-07-21 03:14:59 +00002133 if( pLevel->flags & WHERE_ROWID_EQ ){
drh8aff1012001-12-22 14:49:24 +00002134 /* Case 1: We can directly reference a single row using an
drhc27a1ce2002-06-14 20:58:45 +00002135 ** equality comparison against the ROWID field. Or
2136 ** we reference multiple rows using a "rowid IN (...)"
2137 ** construct.
drhc4a3c772001-04-04 11:48:57 +00002138 */
drhfe05af82005-07-21 03:14:59 +00002139 pTerm = findTerm(&wc, iCur, -1, notReady, WO_EQ|WO_IN, 0);
2140 assert( pTerm!=0 );
drh0fcef5e2005-07-19 17:38:22 +00002141 assert( pTerm->pExpr!=0 );
2142 assert( pTerm->leftCursor==iCur );
drh9012bcb2004-12-19 00:11:35 +00002143 assert( omitTable==0 );
drh94a11212004-09-25 13:12:14 +00002144 codeEqualityTerm(pParse, pTerm, brk, pLevel);
danielk19774adee202004-05-08 08:23:19 +00002145 sqlite3VdbeAddOp(v, OP_MustBeInt, 1, brk);
danielk19774adee202004-05-08 08:23:19 +00002146 sqlite3VdbeAddOp(v, OP_NotExists, iCur, brk);
tpoindex7a9b1612005-01-03 18:13:18 +00002147 VdbeComment((v, "pk"));
drh6b563442001-11-07 16:48:26 +00002148 pLevel->op = OP_Noop;
drhfe05af82005-07-21 03:14:59 +00002149 }else if( pLevel->flags & WHERE_ROWID_RANGE ){
drh51147ba2005-07-23 22:59:55 +00002150 /* Case 2: We have an inequality comparison against the ROWID field.
drh8aff1012001-12-22 14:49:24 +00002151 */
2152 int testOp = OP_Noop;
2153 int start;
drhfe05af82005-07-21 03:14:59 +00002154 WhereTerm *pStart, *pEnd;
drh8aff1012001-12-22 14:49:24 +00002155
drh9012bcb2004-12-19 00:11:35 +00002156 assert( omitTable==0 );
drha6110402005-07-28 20:51:19 +00002157 pStart = findTerm(&wc, iCur, -1, notReady, WO_GT|WO_GE, 0);
2158 pEnd = findTerm(&wc, iCur, -1, notReady, WO_LT|WO_LE, 0);
drhfe05af82005-07-21 03:14:59 +00002159 if( bRev ){
2160 pTerm = pStart;
2161 pStart = pEnd;
2162 pEnd = pTerm;
2163 }
2164 if( pStart ){
drh94a11212004-09-25 13:12:14 +00002165 Expr *pX;
drhfe05af82005-07-21 03:14:59 +00002166 pX = pStart->pExpr;
drh94a11212004-09-25 13:12:14 +00002167 assert( pX!=0 );
drhfe05af82005-07-21 03:14:59 +00002168 assert( pStart->leftCursor==iCur );
drh94a11212004-09-25 13:12:14 +00002169 sqlite3ExprCode(pParse, pX->pRight);
danielk1977d0a69322005-02-02 01:10:44 +00002170 sqlite3VdbeAddOp(v, OP_ForceInt, pX->op==TK_LE || pX->op==TK_GT, brk);
drhb6c29892004-11-22 19:12:19 +00002171 sqlite3VdbeAddOp(v, bRev ? OP_MoveLt : OP_MoveGe, iCur, brk);
tpoindex7a9b1612005-01-03 18:13:18 +00002172 VdbeComment((v, "pk"));
drhfe05af82005-07-21 03:14:59 +00002173 disableTerm(pLevel, pStart);
drh8aff1012001-12-22 14:49:24 +00002174 }else{
drhb6c29892004-11-22 19:12:19 +00002175 sqlite3VdbeAddOp(v, bRev ? OP_Last : OP_Rewind, iCur, brk);
drh8aff1012001-12-22 14:49:24 +00002176 }
drhfe05af82005-07-21 03:14:59 +00002177 if( pEnd ){
drh94a11212004-09-25 13:12:14 +00002178 Expr *pX;
drhfe05af82005-07-21 03:14:59 +00002179 pX = pEnd->pExpr;
drh94a11212004-09-25 13:12:14 +00002180 assert( pX!=0 );
drhfe05af82005-07-21 03:14:59 +00002181 assert( pEnd->leftCursor==iCur );
drh94a11212004-09-25 13:12:14 +00002182 sqlite3ExprCode(pParse, pX->pRight);
drh8aff1012001-12-22 14:49:24 +00002183 pLevel->iMem = pParse->nMem++;
danielk19774adee202004-05-08 08:23:19 +00002184 sqlite3VdbeAddOp(v, OP_MemStore, pLevel->iMem, 1);
drh94a11212004-09-25 13:12:14 +00002185 if( pX->op==TK_LT || pX->op==TK_GT ){
drhb6c29892004-11-22 19:12:19 +00002186 testOp = bRev ? OP_Le : OP_Ge;
drh8aff1012001-12-22 14:49:24 +00002187 }else{
drhb6c29892004-11-22 19:12:19 +00002188 testOp = bRev ? OP_Lt : OP_Gt;
drh8aff1012001-12-22 14:49:24 +00002189 }
drhfe05af82005-07-21 03:14:59 +00002190 disableTerm(pLevel, pEnd);
drh8aff1012001-12-22 14:49:24 +00002191 }
danielk19774adee202004-05-08 08:23:19 +00002192 start = sqlite3VdbeCurrentAddr(v);
drhb6c29892004-11-22 19:12:19 +00002193 pLevel->op = bRev ? OP_Prev : OP_Next;
drh6a3ea0e2003-05-02 14:32:12 +00002194 pLevel->p1 = iCur;
drh8aff1012001-12-22 14:49:24 +00002195 pLevel->p2 = start;
2196 if( testOp!=OP_Noop ){
drhf0863fe2005-06-12 21:35:51 +00002197 sqlite3VdbeAddOp(v, OP_Rowid, iCur, 0);
danielk19774adee202004-05-08 08:23:19 +00002198 sqlite3VdbeAddOp(v, OP_MemLoad, pLevel->iMem, 0);
drh8a512562005-11-14 22:29:05 +00002199 sqlite3VdbeAddOp(v, testOp, SQLITE_AFF_NUMERIC, brk);
drh8aff1012001-12-22 14:49:24 +00002200 }
drhfe05af82005-07-21 03:14:59 +00002201 }else if( pLevel->flags & WHERE_COLUMN_RANGE ){
drh51147ba2005-07-23 22:59:55 +00002202 /* Case 3: The WHERE clause term that refers to the right-most
drhc27a1ce2002-06-14 20:58:45 +00002203 ** column of the index is an inequality. For example, if
2204 ** the index is on (x,y,z) and the WHERE clause is of the
2205 ** form "x=5 AND y<10" then this case is used. Only the
2206 ** right-most column can be an inequality - the rest must
drh51147ba2005-07-23 22:59:55 +00002207 ** use the "==" and "IN" operators.
drhe3184742002-06-19 14:27:05 +00002208 **
2209 ** This case is also used when there are no WHERE clause
2210 ** constraints but an index is selected anyway, in order
2211 ** to force the output order to conform to an ORDER BY.
drh487ab3c2001-11-08 00:45:21 +00002212 */
drh487ab3c2001-11-08 00:45:21 +00002213 int start;
drh51147ba2005-07-23 22:59:55 +00002214 int nEq = pLevel->nEq;
drh85eeb692005-12-21 03:16:42 +00002215 int topEq=0; /* True if top limit uses ==. False is strictly < */
2216 int btmEq=0; /* True if btm limit uses ==. False if strictly > */
2217 int topOp, btmOp; /* Operators for the top and bottom search bounds */
drh487ab3c2001-11-08 00:45:21 +00002218 int testOp;
drhfe05af82005-07-21 03:14:59 +00002219 int topLimit = (pLevel->flags & WHERE_TOP_LIMIT)!=0;
2220 int btmLimit = (pLevel->flags & WHERE_BTM_LIMIT)!=0;
drh487ab3c2001-11-08 00:45:21 +00002221
drh51147ba2005-07-23 22:59:55 +00002222 /* Generate code to evaluate all constraint terms using == or IN
2223 ** and level the values of those terms on the stack.
drh487ab3c2001-11-08 00:45:21 +00002224 */
drh51147ba2005-07-23 22:59:55 +00002225 codeAllEqualityTerms(pParse, pLevel, &wc, notReady, brk);
drh487ab3c2001-11-08 00:45:21 +00002226
drhc27a1ce2002-06-14 20:58:45 +00002227 /* Duplicate the equality term values because they will all be
drh487ab3c2001-11-08 00:45:21 +00002228 ** used twice: once to make the termination key and once to make the
2229 ** start key.
2230 */
drh51147ba2005-07-23 22:59:55 +00002231 for(j=0; j<nEq; j++){
2232 sqlite3VdbeAddOp(v, OP_Dup, nEq-1, 0);
drh487ab3c2001-11-08 00:45:21 +00002233 }
2234
drh85eeb692005-12-21 03:16:42 +00002235 /* Figure out what comparison operators to use for top and bottom
2236 ** search bounds. For an ascending index, the bottom bound is a > or >=
2237 ** operator and the top bound is a < or <= operator. For a descending
2238 ** index the operators are reversed.
2239 */
danielk1977b3bf5562006-01-10 17:58:23 +00002240 if( pIdx->aSortOrder[nEq]==SQLITE_SO_ASC ){
drh85eeb692005-12-21 03:16:42 +00002241 topOp = WO_LT|WO_LE;
2242 btmOp = WO_GT|WO_GE;
2243 }else{
2244 topOp = WO_GT|WO_GE;
2245 btmOp = WO_LT|WO_LE;
2246 SWAP(int, topLimit, btmLimit);
2247 }
2248
drh487ab3c2001-11-08 00:45:21 +00002249 /* Generate the termination key. This is the key value that
2250 ** will end the search. There is no termination key if there
drhc27a1ce2002-06-14 20:58:45 +00002251 ** are no equality terms and no "X<..." term.
drhc045ec52002-12-04 20:01:06 +00002252 **
2253 ** 2002-Dec-04: On a reverse-order scan, the so-called "termination"
2254 ** key computed here really ends up being the start key.
drh487ab3c2001-11-08 00:45:21 +00002255 */
drhfe05af82005-07-21 03:14:59 +00002256 if( topLimit ){
drhe8b97272005-07-19 22:22:12 +00002257 Expr *pX;
drhfe05af82005-07-21 03:14:59 +00002258 int k = pIdx->aiColumn[j];
drh85eeb692005-12-21 03:16:42 +00002259 pTerm = findTerm(&wc, iCur, k, notReady, topOp, pIdx);
drhe8b97272005-07-19 22:22:12 +00002260 assert( pTerm!=0 );
2261 pX = pTerm->pExpr;
2262 assert( (pTerm->flags & TERM_CODED)==0 );
2263 sqlite3ExprCode(pParse, pX->pRight);
drh50b39962006-10-28 00:28:09 +00002264 sqlite3VdbeAddOp(v, OP_IsNull, -(nEq+1), brk);
drhb52076c2006-01-23 13:22:09 +00002265 topEq = pTerm->eOperator & (WO_LE|WO_GE);
drhe8b97272005-07-19 22:22:12 +00002266 disableTerm(pLevel, pTerm);
drh487ab3c2001-11-08 00:45:21 +00002267 testOp = OP_IdxGE;
2268 }else{
drh51147ba2005-07-23 22:59:55 +00002269 testOp = nEq>0 ? OP_IdxGE : OP_Noop;
drh85eeb692005-12-21 03:16:42 +00002270 topEq = 1;
drh487ab3c2001-11-08 00:45:21 +00002271 }
2272 if( testOp!=OP_Noop ){
drh51147ba2005-07-23 22:59:55 +00002273 int nCol = nEq + topLimit;
drh487ab3c2001-11-08 00:45:21 +00002274 pLevel->iMem = pParse->nMem++;
drh50b39962006-10-28 00:28:09 +00002275 buildIndexProbe(v, nCol, pIdx);
drhfe05af82005-07-21 03:14:59 +00002276 if( bRev ){
drh85eeb692005-12-21 03:16:42 +00002277 int op = topEq ? OP_MoveLe : OP_MoveLt;
drh9012bcb2004-12-19 00:11:35 +00002278 sqlite3VdbeAddOp(v, op, iIdxCur, brk);
drhc045ec52002-12-04 20:01:06 +00002279 }else{
danielk19774adee202004-05-08 08:23:19 +00002280 sqlite3VdbeAddOp(v, OP_MemStore, pLevel->iMem, 1);
drhc045ec52002-12-04 20:01:06 +00002281 }
drhfe05af82005-07-21 03:14:59 +00002282 }else if( bRev ){
drh9012bcb2004-12-19 00:11:35 +00002283 sqlite3VdbeAddOp(v, OP_Last, iIdxCur, brk);
drh487ab3c2001-11-08 00:45:21 +00002284 }
2285
2286 /* Generate the start key. This is the key that defines the lower
drhc27a1ce2002-06-14 20:58:45 +00002287 ** bound on the search. There is no start key if there are no
2288 ** equality terms and if there is no "X>..." term. In
drh487ab3c2001-11-08 00:45:21 +00002289 ** that case, generate a "Rewind" instruction in place of the
2290 ** start key search.
drhc045ec52002-12-04 20:01:06 +00002291 **
2292 ** 2002-Dec-04: In the case of a reverse-order search, the so-called
2293 ** "start" key really ends up being used as the termination key.
drh487ab3c2001-11-08 00:45:21 +00002294 */
drhfe05af82005-07-21 03:14:59 +00002295 if( btmLimit ){
drhe8b97272005-07-19 22:22:12 +00002296 Expr *pX;
drhfe05af82005-07-21 03:14:59 +00002297 int k = pIdx->aiColumn[j];
drh85eeb692005-12-21 03:16:42 +00002298 pTerm = findTerm(&wc, iCur, k, notReady, btmOp, pIdx);
drhe8b97272005-07-19 22:22:12 +00002299 assert( pTerm!=0 );
2300 pX = pTerm->pExpr;
2301 assert( (pTerm->flags & TERM_CODED)==0 );
2302 sqlite3ExprCode(pParse, pX->pRight);
drh50b39962006-10-28 00:28:09 +00002303 sqlite3VdbeAddOp(v, OP_IsNull, -(nEq+1), brk);
drhb52076c2006-01-23 13:22:09 +00002304 btmEq = pTerm->eOperator & (WO_LE|WO_GE);
drhe8b97272005-07-19 22:22:12 +00002305 disableTerm(pLevel, pTerm);
drh7900ead2001-11-12 13:51:43 +00002306 }else{
drh85eeb692005-12-21 03:16:42 +00002307 btmEq = 1;
drh487ab3c2001-11-08 00:45:21 +00002308 }
drh51147ba2005-07-23 22:59:55 +00002309 if( nEq>0 || btmLimit ){
2310 int nCol = nEq + btmLimit;
drh50b39962006-10-28 00:28:09 +00002311 buildIndexProbe(v, nCol, pIdx);
drhfe05af82005-07-21 03:14:59 +00002312 if( bRev ){
drhc045ec52002-12-04 20:01:06 +00002313 pLevel->iMem = pParse->nMem++;
danielk19774adee202004-05-08 08:23:19 +00002314 sqlite3VdbeAddOp(v, OP_MemStore, pLevel->iMem, 1);
drhc045ec52002-12-04 20:01:06 +00002315 testOp = OP_IdxLT;
2316 }else{
drh85eeb692005-12-21 03:16:42 +00002317 int op = btmEq ? OP_MoveGe : OP_MoveGt;
drh9012bcb2004-12-19 00:11:35 +00002318 sqlite3VdbeAddOp(v, op, iIdxCur, brk);
drhc045ec52002-12-04 20:01:06 +00002319 }
drhfe05af82005-07-21 03:14:59 +00002320 }else if( bRev ){
drhc045ec52002-12-04 20:01:06 +00002321 testOp = OP_Noop;
drh487ab3c2001-11-08 00:45:21 +00002322 }else{
drh9012bcb2004-12-19 00:11:35 +00002323 sqlite3VdbeAddOp(v, OP_Rewind, iIdxCur, brk);
drh487ab3c2001-11-08 00:45:21 +00002324 }
2325
2326 /* Generate the the top of the loop. If there is a termination
2327 ** key we have to test for that key and abort at the top of the
2328 ** loop.
2329 */
danielk19774adee202004-05-08 08:23:19 +00002330 start = sqlite3VdbeCurrentAddr(v);
drh487ab3c2001-11-08 00:45:21 +00002331 if( testOp!=OP_Noop ){
danielk19774adee202004-05-08 08:23:19 +00002332 sqlite3VdbeAddOp(v, OP_MemLoad, pLevel->iMem, 0);
drh9012bcb2004-12-19 00:11:35 +00002333 sqlite3VdbeAddOp(v, testOp, iIdxCur, brk);
drh85eeb692005-12-21 03:16:42 +00002334 if( (topEq && !bRev) || (!btmEq && bRev) ){
danielk19773d1bfea2004-05-14 11:00:53 +00002335 sqlite3VdbeChangeP3(v, -1, "+", P3_STATIC);
2336 }
drh487ab3c2001-11-08 00:45:21 +00002337 }
drh50b39962006-10-28 00:28:09 +00002338 if( topLimit | btmLimit ){
2339 sqlite3VdbeAddOp(v, OP_Column, iIdxCur, nEq);
2340 sqlite3VdbeAddOp(v, OP_IsNull, 1, cont);
2341 }
drhe6f85e72004-12-25 01:03:13 +00002342 if( !omitTable ){
drhf0863fe2005-06-12 21:35:51 +00002343 sqlite3VdbeAddOp(v, OP_IdxRowid, iIdxCur, 0);
drhe6f85e72004-12-25 01:03:13 +00002344 sqlite3VdbeAddOp(v, OP_MoveGe, iCur, 0);
drh487ab3c2001-11-08 00:45:21 +00002345 }
2346
2347 /* Record the instruction used to terminate the loop.
2348 */
drhfe05af82005-07-21 03:14:59 +00002349 pLevel->op = bRev ? OP_Prev : OP_Next;
drh9012bcb2004-12-19 00:11:35 +00002350 pLevel->p1 = iIdxCur;
drh487ab3c2001-11-08 00:45:21 +00002351 pLevel->p2 = start;
drh51147ba2005-07-23 22:59:55 +00002352 }else if( pLevel->flags & WHERE_COLUMN_EQ ){
2353 /* Case 4: There is an index and all terms of the WHERE clause that
2354 ** refer to the index using the "==" or "IN" operators.
2355 */
2356 int start;
2357 int nEq = pLevel->nEq;
2358
2359 /* Generate code to evaluate all constraint terms using == or IN
drh8b3d9902005-08-19 00:14:42 +00002360 ** and leave the values of those terms on the stack.
drh51147ba2005-07-23 22:59:55 +00002361 */
2362 codeAllEqualityTerms(pParse, pLevel, &wc, notReady, brk);
2363
2364 /* Generate a single key that will be used to both start and terminate
2365 ** the search
2366 */
drh50b39962006-10-28 00:28:09 +00002367 buildIndexProbe(v, nEq, pIdx);
drh51147ba2005-07-23 22:59:55 +00002368 sqlite3VdbeAddOp(v, OP_MemStore, pLevel->iMem, 0);
2369
2370 /* Generate code (1) to move to the first matching element of the table.
2371 ** Then generate code (2) that jumps to "brk" after the cursor is past
2372 ** the last matching element of the table. The code (1) is executed
2373 ** once to initialize the search, the code (2) is executed before each
2374 ** iteration of the scan to see if the scan has finished. */
2375 if( bRev ){
2376 /* Scan in reverse order */
2377 sqlite3VdbeAddOp(v, OP_MoveLe, iIdxCur, brk);
2378 start = sqlite3VdbeAddOp(v, OP_MemLoad, pLevel->iMem, 0);
2379 sqlite3VdbeAddOp(v, OP_IdxLT, iIdxCur, brk);
2380 pLevel->op = OP_Prev;
2381 }else{
2382 /* Scan in the forward order */
2383 sqlite3VdbeAddOp(v, OP_MoveGe, iIdxCur, brk);
2384 start = sqlite3VdbeAddOp(v, OP_MemLoad, pLevel->iMem, 0);
2385 sqlite3VdbeOp3(v, OP_IdxGE, iIdxCur, brk, "+", P3_STATIC);
2386 pLevel->op = OP_Next;
2387 }
drh51147ba2005-07-23 22:59:55 +00002388 if( !omitTable ){
2389 sqlite3VdbeAddOp(v, OP_IdxRowid, iIdxCur, 0);
2390 sqlite3VdbeAddOp(v, OP_MoveGe, iCur, 0);
2391 }
2392 pLevel->p1 = iIdxCur;
2393 pLevel->p2 = start;
drhfe05af82005-07-21 03:14:59 +00002394 }else{
2395 /* Case 5: There is no usable index. We must do a complete
2396 ** scan of the entire table.
2397 */
drhfe05af82005-07-21 03:14:59 +00002398 assert( omitTable==0 );
drha6110402005-07-28 20:51:19 +00002399 assert( bRev==0 );
2400 pLevel->op = OP_Next;
drhfe05af82005-07-21 03:14:59 +00002401 pLevel->p1 = iCur;
drha6110402005-07-28 20:51:19 +00002402 pLevel->p2 = 1 + sqlite3VdbeAddOp(v, OP_Rewind, iCur, brk);
drh75897232000-05-29 14:26:00 +00002403 }
drhfe05af82005-07-21 03:14:59 +00002404 notReady &= ~getMask(&maskSet, iCur);
drh75897232000-05-29 14:26:00 +00002405
2406 /* Insert code to test every subexpression that can be completely
2407 ** computed using the current set of tables.
2408 */
drh0fcef5e2005-07-19 17:38:22 +00002409 for(pTerm=wc.a, j=wc.nTerm; j>0; j--, pTerm++){
2410 Expr *pE;
2411 if( pTerm->flags & (TERM_VIRTUAL|TERM_CODED) ) continue;
drhfe05af82005-07-21 03:14:59 +00002412 if( (pTerm->prereqAll & notReady)!=0 ) continue;
drh0fcef5e2005-07-19 17:38:22 +00002413 pE = pTerm->pExpr;
2414 assert( pE!=0 );
drh392e5972005-07-08 14:14:22 +00002415 if( pLevel->iLeftJoin && !ExprHasProperty(pE, EP_FromJoin) ){
drh1f162302002-10-27 19:35:33 +00002416 continue;
2417 }
drh392e5972005-07-08 14:14:22 +00002418 sqlite3ExprIfFalse(pParse, pE, cont, 1);
drh0fcef5e2005-07-19 17:38:22 +00002419 pTerm->flags |= TERM_CODED;
drh75897232000-05-29 14:26:00 +00002420 }
drhad2d8302002-05-24 20:31:36 +00002421
2422 /* For a LEFT OUTER JOIN, generate code that will record the fact that
2423 ** at least one row of the right table has matched the left table.
2424 */
2425 if( pLevel->iLeftJoin ){
danielk19774adee202004-05-08 08:23:19 +00002426 pLevel->top = sqlite3VdbeCurrentAddr(v);
drhd654be82005-09-20 17:42:23 +00002427 sqlite3VdbeAddOp(v, OP_MemInt, 1, pLevel->iLeftJoin);
drhad6d9462004-09-19 02:15:24 +00002428 VdbeComment((v, "# record LEFT JOIN hit"));
drh0aa74ed2005-07-16 13:33:20 +00002429 for(pTerm=wc.a, j=0; j<wc.nTerm; j++, pTerm++){
drh0fcef5e2005-07-19 17:38:22 +00002430 if( pTerm->flags & (TERM_VIRTUAL|TERM_CODED) ) continue;
drhfe05af82005-07-21 03:14:59 +00002431 if( (pTerm->prereqAll & notReady)!=0 ) continue;
drh0fcef5e2005-07-19 17:38:22 +00002432 assert( pTerm->pExpr );
2433 sqlite3ExprIfFalse(pParse, pTerm->pExpr, cont, 1);
2434 pTerm->flags |= TERM_CODED;
drh1cc093c2002-06-24 22:01:57 +00002435 }
drhad2d8302002-05-24 20:31:36 +00002436 }
drh75897232000-05-29 14:26:00 +00002437 }
drh7ec764a2005-07-21 03:48:20 +00002438
2439#ifdef SQLITE_TEST /* For testing and debugging use only */
2440 /* Record in the query plan information about the current table
2441 ** and the index used to access it (if any). If the table itself
2442 ** is not used, its name is just '{}'. If no index is used
2443 ** the index is listed as "{}". If the primary key is used the
2444 ** index name is '*'.
2445 */
2446 for(i=0; i<pTabList->nSrc; i++){
2447 char *z;
2448 int n;
drh7ec764a2005-07-21 03:48:20 +00002449 pLevel = &pWInfo->a[i];
drh29dda4a2005-07-21 18:23:20 +00002450 pTabItem = &pTabList->a[pLevel->iFrom];
drh7ec764a2005-07-21 03:48:20 +00002451 z = pTabItem->zAlias;
2452 if( z==0 ) z = pTabItem->pTab->zName;
2453 n = strlen(z);
2454 if( n+nQPlan < sizeof(sqlite3_query_plan)-10 ){
2455 if( pLevel->flags & WHERE_IDX_ONLY ){
2456 strcpy(&sqlite3_query_plan[nQPlan], "{}");
2457 nQPlan += 2;
2458 }else{
2459 strcpy(&sqlite3_query_plan[nQPlan], z);
2460 nQPlan += n;
2461 }
2462 sqlite3_query_plan[nQPlan++] = ' ';
2463 }
2464 if( pLevel->flags & (WHERE_ROWID_EQ|WHERE_ROWID_RANGE) ){
2465 strcpy(&sqlite3_query_plan[nQPlan], "* ");
2466 nQPlan += 2;
2467 }else if( pLevel->pIdx==0 ){
2468 strcpy(&sqlite3_query_plan[nQPlan], "{} ");
2469 nQPlan += 3;
2470 }else{
2471 n = strlen(pLevel->pIdx->zName);
2472 if( n+nQPlan < sizeof(sqlite3_query_plan)-2 ){
2473 strcpy(&sqlite3_query_plan[nQPlan], pLevel->pIdx->zName);
2474 nQPlan += n;
2475 sqlite3_query_plan[nQPlan++] = ' ';
2476 }
2477 }
2478 }
2479 while( nQPlan>0 && sqlite3_query_plan[nQPlan-1]==' ' ){
2480 sqlite3_query_plan[--nQPlan] = 0;
2481 }
2482 sqlite3_query_plan[nQPlan] = 0;
2483 nQPlan = 0;
2484#endif /* SQLITE_TEST // Testing and debugging use only */
2485
drh29dda4a2005-07-21 18:23:20 +00002486 /* Record the continuation address in the WhereInfo structure. Then
2487 ** clean up and return.
2488 */
drh75897232000-05-29 14:26:00 +00002489 pWInfo->iContinue = cont;
drh0aa74ed2005-07-16 13:33:20 +00002490 whereClauseClear(&wc);
drh75897232000-05-29 14:26:00 +00002491 return pWInfo;
drhe23399f2005-07-22 00:31:39 +00002492
2493 /* Jump here if malloc fails */
2494whereBeginNoMem:
2495 whereClauseClear(&wc);
drh9eff6162006-06-12 21:59:13 +00002496 whereInfoFree(pWInfo);
drhe23399f2005-07-22 00:31:39 +00002497 return 0;
drh75897232000-05-29 14:26:00 +00002498}
2499
2500/*
drhc27a1ce2002-06-14 20:58:45 +00002501** Generate the end of the WHERE loop. See comments on
danielk19774adee202004-05-08 08:23:19 +00002502** sqlite3WhereBegin() for additional information.
drh75897232000-05-29 14:26:00 +00002503*/
danielk19774adee202004-05-08 08:23:19 +00002504void sqlite3WhereEnd(WhereInfo *pWInfo){
drh75897232000-05-29 14:26:00 +00002505 Vdbe *v = pWInfo->pParse->pVdbe;
drh19a775c2000-06-05 18:54:46 +00002506 int i;
drh6b563442001-11-07 16:48:26 +00002507 WhereLevel *pLevel;
drhad3cab52002-05-24 02:04:32 +00002508 SrcList *pTabList = pWInfo->pTabList;
drh19a775c2000-06-05 18:54:46 +00002509
drh9012bcb2004-12-19 00:11:35 +00002510 /* Generate loop termination code.
2511 */
drhad3cab52002-05-24 02:04:32 +00002512 for(i=pTabList->nSrc-1; i>=0; i--){
drh6b563442001-11-07 16:48:26 +00002513 pLevel = &pWInfo->a[i];
danielk19774adee202004-05-08 08:23:19 +00002514 sqlite3VdbeResolveLabel(v, pLevel->cont);
drh6b563442001-11-07 16:48:26 +00002515 if( pLevel->op!=OP_Noop ){
danielk19774adee202004-05-08 08:23:19 +00002516 sqlite3VdbeAddOp(v, pLevel->op, pLevel->p1, pLevel->p2);
drh19a775c2000-06-05 18:54:46 +00002517 }
danielk19774adee202004-05-08 08:23:19 +00002518 sqlite3VdbeResolveLabel(v, pLevel->brk);
drhe23399f2005-07-22 00:31:39 +00002519 if( pLevel->nIn ){
2520 int *a;
2521 int j;
drhffe0f892006-05-11 13:26:25 +00002522 for(j=pLevel->nIn, a=&pLevel->aInLoop[j*2-2]; j>0; j--, a-=2){
2523 sqlite3VdbeAddOp(v, OP_Next, a[0], a[1]);
2524 sqlite3VdbeJumpHere(v, a[1]-1);
drhe23399f2005-07-22 00:31:39 +00002525 }
2526 sqliteFree(pLevel->aInLoop);
drhd99f7062002-06-08 23:25:08 +00002527 }
drhad2d8302002-05-24 20:31:36 +00002528 if( pLevel->iLeftJoin ){
2529 int addr;
drhd654be82005-09-20 17:42:23 +00002530 addr = sqlite3VdbeAddOp(v, OP_IfMemPos, pLevel->iLeftJoin, 0);
danielk19774adee202004-05-08 08:23:19 +00002531 sqlite3VdbeAddOp(v, OP_NullRow, pTabList->a[i].iCursor, 0);
drh9012bcb2004-12-19 00:11:35 +00002532 if( pLevel->iIdxCur>=0 ){
2533 sqlite3VdbeAddOp(v, OP_NullRow, pLevel->iIdxCur, 0);
drh7f09b3e2002-08-13 13:15:49 +00002534 }
danielk19774adee202004-05-08 08:23:19 +00002535 sqlite3VdbeAddOp(v, OP_Goto, 0, pLevel->top);
drhd654be82005-09-20 17:42:23 +00002536 sqlite3VdbeJumpHere(v, addr);
drhad2d8302002-05-24 20:31:36 +00002537 }
drh19a775c2000-06-05 18:54:46 +00002538 }
drh9012bcb2004-12-19 00:11:35 +00002539
2540 /* The "break" point is here, just past the end of the outer loop.
2541 ** Set it.
2542 */
danielk19774adee202004-05-08 08:23:19 +00002543 sqlite3VdbeResolveLabel(v, pWInfo->iBreak);
drh9012bcb2004-12-19 00:11:35 +00002544
drh29dda4a2005-07-21 18:23:20 +00002545 /* Close all of the cursors that were opened by sqlite3WhereBegin.
drh9012bcb2004-12-19 00:11:35 +00002546 */
drh29dda4a2005-07-21 18:23:20 +00002547 for(i=0, pLevel=pWInfo->a; i<pTabList->nSrc; i++, pLevel++){
2548 struct SrcList_item *pTabItem = &pTabList->a[pLevel->iFrom];
drh9012bcb2004-12-19 00:11:35 +00002549 Table *pTab = pTabItem->pTab;
drh5cf590c2003-04-24 01:45:04 +00002550 assert( pTab!=0 );
drhb9bb7c12006-06-11 23:41:55 +00002551 if( pTab->isEphem || pTab->pSelect ) continue;
drhfe05af82005-07-21 03:14:59 +00002552 if( (pLevel->flags & WHERE_IDX_ONLY)==0 ){
drh9012bcb2004-12-19 00:11:35 +00002553 sqlite3VdbeAddOp(v, OP_Close, pTabItem->iCursor, 0);
2554 }
drh6b563442001-11-07 16:48:26 +00002555 if( pLevel->pIdx!=0 ){
drh9012bcb2004-12-19 00:11:35 +00002556 sqlite3VdbeAddOp(v, OP_Close, pLevel->iIdxCur, 0);
2557 }
2558
drhacf3b982005-01-03 01:27:18 +00002559 /* Make cursor substitutions for cases where we want to use
drh9012bcb2004-12-19 00:11:35 +00002560 ** just the index and never reference the table.
2561 **
2562 ** Calls to the code generator in between sqlite3WhereBegin and
2563 ** sqlite3WhereEnd will have created code that references the table
2564 ** directly. This loop scans all that code looking for opcodes
2565 ** that reference the table and converts them into opcodes that
2566 ** reference the index.
2567 */
drhfe05af82005-07-21 03:14:59 +00002568 if( pLevel->flags & WHERE_IDX_ONLY ){
danielk1977f0113002006-01-24 12:09:17 +00002569 int k, j, last;
drh9012bcb2004-12-19 00:11:35 +00002570 VdbeOp *pOp;
2571 Index *pIdx = pLevel->pIdx;
2572
2573 assert( pIdx!=0 );
2574 pOp = sqlite3VdbeGetOp(v, pWInfo->iTop);
2575 last = sqlite3VdbeCurrentAddr(v);
danielk1977f0113002006-01-24 12:09:17 +00002576 for(k=pWInfo->iTop; k<last; k++, pOp++){
drh9012bcb2004-12-19 00:11:35 +00002577 if( pOp->p1!=pLevel->iTabCur ) continue;
2578 if( pOp->opcode==OP_Column ){
2579 pOp->p1 = pLevel->iIdxCur;
2580 for(j=0; j<pIdx->nColumn; j++){
2581 if( pOp->p2==pIdx->aiColumn[j] ){
2582 pOp->p2 = j;
2583 break;
2584 }
2585 }
drhf0863fe2005-06-12 21:35:51 +00002586 }else if( pOp->opcode==OP_Rowid ){
drh9012bcb2004-12-19 00:11:35 +00002587 pOp->p1 = pLevel->iIdxCur;
drhf0863fe2005-06-12 21:35:51 +00002588 pOp->opcode = OP_IdxRowid;
danielk19776c18b6e2005-01-30 09:17:58 +00002589 }else if( pOp->opcode==OP_NullRow ){
2590 pOp->opcode = OP_Noop;
drh9012bcb2004-12-19 00:11:35 +00002591 }
2592 }
drh6b563442001-11-07 16:48:26 +00002593 }
drh19a775c2000-06-05 18:54:46 +00002594 }
drh9012bcb2004-12-19 00:11:35 +00002595
2596 /* Final cleanup
2597 */
drh9eff6162006-06-12 21:59:13 +00002598 whereInfoFree(pWInfo);
drh75897232000-05-29 14:26:00 +00002599 return;
2600}