blob: 24d7c63109b63236fe543627b0b60c443eb00a75 [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**
drh0660e262006-10-27 14:06:57 +000019** $Id: where.c,v 1.230 2006/10/27 14:06:59 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
drh51147ba2005-07-23 22:59:55 +0000160
161/*
162** Value for flags returned by bestIndex()
163*/
164#define WHERE_ROWID_EQ 0x0001 /* rowid=EXPR or rowid IN (...) */
165#define WHERE_ROWID_RANGE 0x0002 /* rowid<EXPR and/or rowid>EXPR */
166#define WHERE_COLUMN_EQ 0x0010 /* x=EXPR or x IN (...) */
167#define WHERE_COLUMN_RANGE 0x0020 /* x<EXPR and/or x>EXPR */
168#define WHERE_COLUMN_IN 0x0040 /* x IN (...) */
169#define WHERE_TOP_LIMIT 0x0100 /* x<EXPR or x<=EXPR constraint */
170#define WHERE_BTM_LIMIT 0x0200 /* x>EXPR or x>=EXPR constraint */
171#define WHERE_IDX_ONLY 0x0800 /* Use index only - omit table */
172#define WHERE_ORDERBY 0x1000 /* Output will appear in correct order */
173#define WHERE_REVERSE 0x2000 /* Scan in reverse order */
drh943af3c2005-07-29 19:43:58 +0000174#define WHERE_UNIQUE 0x4000 /* Selects no more than one row */
drh9eff6162006-06-12 21:59:13 +0000175#define WHERE_VIRTUALTABLE 0x8000 /* Use virtual-table processing */
drh51147ba2005-07-23 22:59:55 +0000176
177/*
drh0aa74ed2005-07-16 13:33:20 +0000178** Initialize a preallocated WhereClause structure.
drh75897232000-05-29 14:26:00 +0000179*/
drhfe05af82005-07-21 03:14:59 +0000180static void whereClauseInit(WhereClause *pWC, Parse *pParse){
181 pWC->pParse = pParse;
drh0aa74ed2005-07-16 13:33:20 +0000182 pWC->nTerm = 0;
183 pWC->nSlot = ARRAYSIZE(pWC->aStatic);
184 pWC->a = pWC->aStatic;
185}
186
187/*
188** Deallocate a WhereClause structure. The WhereClause structure
189** itself is not freed. This routine is the inverse of whereClauseInit().
190*/
191static void whereClauseClear(WhereClause *pWC){
192 int i;
193 WhereTerm *a;
194 for(i=pWC->nTerm-1, a=pWC->a; i>=0; i--, a++){
195 if( a->flags & TERM_DYNAMIC ){
drh0fcef5e2005-07-19 17:38:22 +0000196 sqlite3ExprDelete(a->pExpr);
drh0aa74ed2005-07-16 13:33:20 +0000197 }
198 }
199 if( pWC->a!=pWC->aStatic ){
200 sqliteFree(pWC->a);
201 }
202}
203
204/*
205** Add a new entries to the WhereClause structure. Increase the allocated
206** space as necessary.
drh9eb20282005-08-24 03:52:18 +0000207**
208** WARNING: This routine might reallocate the space used to store
209** WhereTerms. All pointers to WhereTerms should be invalided after
210** calling this routine. Such pointers may be reinitialized by referencing
211** the pWC->a[] array.
drh0aa74ed2005-07-16 13:33:20 +0000212*/
drh9eb20282005-08-24 03:52:18 +0000213static int whereClauseInsert(WhereClause *pWC, Expr *p, int flags){
drh0aa74ed2005-07-16 13:33:20 +0000214 WhereTerm *pTerm;
drh9eb20282005-08-24 03:52:18 +0000215 int idx;
drh0aa74ed2005-07-16 13:33:20 +0000216 if( pWC->nTerm>=pWC->nSlot ){
217 WhereTerm *pOld = pWC->a;
218 pWC->a = sqliteMalloc( sizeof(pWC->a[0])*pWC->nSlot*2 );
drh0fcef5e2005-07-19 17:38:22 +0000219 if( pWC->a==0 ) return 0;
drh0aa74ed2005-07-16 13:33:20 +0000220 memcpy(pWC->a, pOld, sizeof(pWC->a[0])*pWC->nTerm);
221 if( pOld!=pWC->aStatic ){
222 sqliteFree(pOld);
223 }
224 pWC->nSlot *= 2;
225 }
drh9eb20282005-08-24 03:52:18 +0000226 pTerm = &pWC->a[idx = pWC->nTerm];
drh0fcef5e2005-07-19 17:38:22 +0000227 pWC->nTerm++;
228 pTerm->pExpr = p;
drh0aa74ed2005-07-16 13:33:20 +0000229 pTerm->flags = flags;
drh0fcef5e2005-07-19 17:38:22 +0000230 pTerm->pWC = pWC;
drh45b1ee42005-08-02 17:48:22 +0000231 pTerm->iParent = -1;
drh9eb20282005-08-24 03:52:18 +0000232 return idx;
drh0aa74ed2005-07-16 13:33:20 +0000233}
drh75897232000-05-29 14:26:00 +0000234
235/*
drh51669862004-12-18 18:40:26 +0000236** This routine identifies subexpressions in the WHERE clause where
drhb6fb62d2005-09-20 08:47:20 +0000237** each subexpression is separated by the AND operator or some other
drh6c30be82005-07-29 15:10:17 +0000238** operator specified in the op parameter. The WhereClause structure
239** is filled with pointers to subexpressions. For example:
drh75897232000-05-29 14:26:00 +0000240**
drh51669862004-12-18 18:40:26 +0000241** WHERE a=='hello' AND coalesce(b,11)<10 AND (c+12!=d OR c==22)
242** \________/ \_______________/ \________________/
243** slot[0] slot[1] slot[2]
244**
245** The original WHERE clause in pExpr is unaltered. All this routine
drh51147ba2005-07-23 22:59:55 +0000246** does is make slot[] entries point to substructure within pExpr.
drh51669862004-12-18 18:40:26 +0000247**
drh51147ba2005-07-23 22:59:55 +0000248** In the previous sentence and in the diagram, "slot[]" refers to
249** the WhereClause.a[] array. This array grows as needed to contain
250** all terms of the WHERE clause.
drh75897232000-05-29 14:26:00 +0000251*/
drh6c30be82005-07-29 15:10:17 +0000252static void whereSplit(WhereClause *pWC, Expr *pExpr, int op){
drh0aa74ed2005-07-16 13:33:20 +0000253 if( pExpr==0 ) return;
drh6c30be82005-07-29 15:10:17 +0000254 if( pExpr->op!=op ){
drh0aa74ed2005-07-16 13:33:20 +0000255 whereClauseInsert(pWC, pExpr, 0);
drh75897232000-05-29 14:26:00 +0000256 }else{
drh6c30be82005-07-29 15:10:17 +0000257 whereSplit(pWC, pExpr->pLeft, op);
258 whereSplit(pWC, pExpr->pRight, op);
drh75897232000-05-29 14:26:00 +0000259 }
drh75897232000-05-29 14:26:00 +0000260}
261
262/*
drh6a3ea0e2003-05-02 14:32:12 +0000263** Initialize an expression mask set
264*/
265#define initMaskSet(P) memset(P, 0, sizeof(*P))
266
267/*
drh1398ad32005-01-19 23:24:50 +0000268** Return the bitmask for the given cursor number. Return 0 if
269** iCursor is not in the set.
drh6a3ea0e2003-05-02 14:32:12 +0000270*/
drh51669862004-12-18 18:40:26 +0000271static Bitmask getMask(ExprMaskSet *pMaskSet, int iCursor){
drh6a3ea0e2003-05-02 14:32:12 +0000272 int i;
273 for(i=0; i<pMaskSet->n; i++){
drh51669862004-12-18 18:40:26 +0000274 if( pMaskSet->ix[i]==iCursor ){
275 return ((Bitmask)1)<<i;
276 }
drh6a3ea0e2003-05-02 14:32:12 +0000277 }
drh6a3ea0e2003-05-02 14:32:12 +0000278 return 0;
279}
280
281/*
drh1398ad32005-01-19 23:24:50 +0000282** Create a new mask for cursor iCursor.
drh0fcef5e2005-07-19 17:38:22 +0000283**
284** There is one cursor per table in the FROM clause. The number of
285** tables in the FROM clause is limited by a test early in the
drhb6fb62d2005-09-20 08:47:20 +0000286** sqlite3WhereBegin() routine. So we know that the pMaskSet->ix[]
drh0fcef5e2005-07-19 17:38:22 +0000287** array will never overflow.
drh1398ad32005-01-19 23:24:50 +0000288*/
289static void createMask(ExprMaskSet *pMaskSet, int iCursor){
drh0fcef5e2005-07-19 17:38:22 +0000290 assert( pMaskSet->n < ARRAYSIZE(pMaskSet->ix) );
291 pMaskSet->ix[pMaskSet->n++] = iCursor;
drh1398ad32005-01-19 23:24:50 +0000292}
293
294/*
drh75897232000-05-29 14:26:00 +0000295** This routine walks (recursively) an expression tree and generates
296** a bitmask indicating which tables are used in that expression
drh6a3ea0e2003-05-02 14:32:12 +0000297** tree.
drh75897232000-05-29 14:26:00 +0000298**
299** In order for this routine to work, the calling function must have
drh626a8792005-01-17 22:08:19 +0000300** previously invoked sqlite3ExprResolveNames() on the expression. See
drh75897232000-05-29 14:26:00 +0000301** the header comment on that routine for additional information.
drh626a8792005-01-17 22:08:19 +0000302** The sqlite3ExprResolveNames() routines looks for column names and
drh6a3ea0e2003-05-02 14:32:12 +0000303** sets their opcodes to TK_COLUMN and their Expr.iTable fields to
drh51147ba2005-07-23 22:59:55 +0000304** the VDBE cursor number of the table. This routine just has to
305** translate the cursor numbers into bitmask values and OR all
306** the bitmasks together.
drh75897232000-05-29 14:26:00 +0000307*/
drhf5b11382005-09-17 13:07:13 +0000308static Bitmask exprListTableUsage(ExprMaskSet*, ExprList*);
309static Bitmask exprSelectTableUsage(ExprMaskSet*, Select*);
drh51669862004-12-18 18:40:26 +0000310static Bitmask exprTableUsage(ExprMaskSet *pMaskSet, Expr *p){
311 Bitmask mask = 0;
drh75897232000-05-29 14:26:00 +0000312 if( p==0 ) return 0;
drh967e8b72000-06-21 13:59:10 +0000313 if( p->op==TK_COLUMN ){
drh8feb4b12004-07-19 02:12:14 +0000314 mask = getMask(pMaskSet, p->iTable);
drh8feb4b12004-07-19 02:12:14 +0000315 return mask;
drh75897232000-05-29 14:26:00 +0000316 }
danielk1977b3bce662005-01-29 08:32:43 +0000317 mask = exprTableUsage(pMaskSet, p->pRight);
318 mask |= exprTableUsage(pMaskSet, p->pLeft);
319 mask |= exprListTableUsage(pMaskSet, p->pList);
drhf5b11382005-09-17 13:07:13 +0000320 mask |= exprSelectTableUsage(pMaskSet, p->pSelect);
danielk1977b3bce662005-01-29 08:32:43 +0000321 return mask;
322}
323static Bitmask exprListTableUsage(ExprMaskSet *pMaskSet, ExprList *pList){
324 int i;
325 Bitmask mask = 0;
326 if( pList ){
327 for(i=0; i<pList->nExpr; i++){
328 mask |= exprTableUsage(pMaskSet, pList->a[i].pExpr);
drhdd579122002-04-02 01:58:57 +0000329 }
330 }
drh75897232000-05-29 14:26:00 +0000331 return mask;
332}
drhf5b11382005-09-17 13:07:13 +0000333static Bitmask exprSelectTableUsage(ExprMaskSet *pMaskSet, Select *pS){
334 Bitmask mask;
335 if( pS==0 ){
336 mask = 0;
337 }else{
338 mask = exprListTableUsage(pMaskSet, pS->pEList);
339 mask |= exprListTableUsage(pMaskSet, pS->pGroupBy);
340 mask |= exprListTableUsage(pMaskSet, pS->pOrderBy);
341 mask |= exprTableUsage(pMaskSet, pS->pWhere);
342 mask |= exprTableUsage(pMaskSet, pS->pHaving);
343 }
344 return mask;
345}
drh75897232000-05-29 14:26:00 +0000346
347/*
drh487ab3c2001-11-08 00:45:21 +0000348** Return TRUE if the given operator is one of the operators that is
drh51669862004-12-18 18:40:26 +0000349** allowed for an indexable WHERE clause term. The allowed operators are
drhc27a1ce2002-06-14 20:58:45 +0000350** "=", "<", ">", "<=", ">=", and "IN".
drh487ab3c2001-11-08 00:45:21 +0000351*/
352static int allowedOp(int op){
drhfe05af82005-07-21 03:14:59 +0000353 assert( TK_GT>TK_EQ && TK_GT<TK_GE );
354 assert( TK_LT>TK_EQ && TK_LT<TK_GE );
355 assert( TK_LE>TK_EQ && TK_LE<TK_GE );
356 assert( TK_GE==TK_EQ+4 );
drh9a432672004-10-04 13:38:09 +0000357 return op==TK_IN || (op>=TK_EQ && op<=TK_GE);
drh487ab3c2001-11-08 00:45:21 +0000358}
359
360/*
drh51669862004-12-18 18:40:26 +0000361** Swap two objects of type T.
drh193bd772004-07-20 18:23:14 +0000362*/
363#define SWAP(TYPE,A,B) {TYPE t=A; A=B; B=t;}
364
365/*
drh0fcef5e2005-07-19 17:38:22 +0000366** Commute a comparision operator. Expressions of the form "X op Y"
367** are converted into "Y op X".
drh193bd772004-07-20 18:23:14 +0000368*/
drh0fcef5e2005-07-19 17:38:22 +0000369static void exprCommute(Expr *pExpr){
drhfe05af82005-07-21 03:14:59 +0000370 assert( allowedOp(pExpr->op) && pExpr->op!=TK_IN );
drh0fcef5e2005-07-19 17:38:22 +0000371 SWAP(CollSeq*,pExpr->pRight->pColl,pExpr->pLeft->pColl);
372 SWAP(Expr*,pExpr->pRight,pExpr->pLeft);
373 if( pExpr->op>=TK_GT ){
374 assert( TK_LT==TK_GT+2 );
375 assert( TK_GE==TK_LE+2 );
376 assert( TK_GT>TK_EQ );
377 assert( TK_GT<TK_LE );
378 assert( pExpr->op>=TK_GT && pExpr->op<=TK_GE );
379 pExpr->op = ((pExpr->op-TK_GT)^2)+TK_GT;
drh193bd772004-07-20 18:23:14 +0000380 }
drh193bd772004-07-20 18:23:14 +0000381}
382
383/*
drhfe05af82005-07-21 03:14:59 +0000384** Translate from TK_xx operator to WO_xx bitmask.
385*/
386static int operatorMask(int op){
drh51147ba2005-07-23 22:59:55 +0000387 int c;
drhfe05af82005-07-21 03:14:59 +0000388 assert( allowedOp(op) );
389 if( op==TK_IN ){
drh51147ba2005-07-23 22:59:55 +0000390 c = WO_IN;
drhfe05af82005-07-21 03:14:59 +0000391 }else{
drh51147ba2005-07-23 22:59:55 +0000392 c = WO_EQ<<(op-TK_EQ);
drhfe05af82005-07-21 03:14:59 +0000393 }
drh51147ba2005-07-23 22:59:55 +0000394 assert( op!=TK_IN || c==WO_IN );
395 assert( op!=TK_EQ || c==WO_EQ );
396 assert( op!=TK_LT || c==WO_LT );
397 assert( op!=TK_LE || c==WO_LE );
398 assert( op!=TK_GT || c==WO_GT );
399 assert( op!=TK_GE || c==WO_GE );
400 return c;
drhfe05af82005-07-21 03:14:59 +0000401}
402
403/*
404** Search for a term in the WHERE clause that is of the form "X <op> <expr>"
405** where X is a reference to the iColumn of table iCur and <op> is one of
406** the WO_xx operator codes specified by the op parameter.
407** Return a pointer to the term. Return 0 if not found.
408*/
409static WhereTerm *findTerm(
410 WhereClause *pWC, /* The WHERE clause to be searched */
411 int iCur, /* Cursor number of LHS */
412 int iColumn, /* Column number of LHS */
413 Bitmask notReady, /* RHS must not overlap with this mask */
drh51147ba2005-07-23 22:59:55 +0000414 u16 op, /* Mask of WO_xx values describing operator */
drhfe05af82005-07-21 03:14:59 +0000415 Index *pIdx /* Must be compatible with this index, if not NULL */
416){
417 WhereTerm *pTerm;
418 int k;
419 for(pTerm=pWC->a, k=pWC->nTerm; k; k--, pTerm++){
420 if( pTerm->leftCursor==iCur
421 && (pTerm->prereqRight & notReady)==0
422 && pTerm->leftColumn==iColumn
drhb52076c2006-01-23 13:22:09 +0000423 && (pTerm->eOperator & op)!=0
drhfe05af82005-07-21 03:14:59 +0000424 ){
425 if( iCur>=0 && pIdx ){
426 Expr *pX = pTerm->pExpr;
427 CollSeq *pColl;
428 char idxaff;
danielk1977f0113002006-01-24 12:09:17 +0000429 int j;
drhfe05af82005-07-21 03:14:59 +0000430 Parse *pParse = pWC->pParse;
431
432 idxaff = pIdx->pTable->aCol[iColumn].affinity;
433 if( !sqlite3IndexAffinityOk(pX, idxaff) ) continue;
434 pColl = sqlite3ExprCollSeq(pParse, pX->pLeft);
435 if( !pColl ){
436 if( pX->pRight ){
437 pColl = sqlite3ExprCollSeq(pParse, pX->pRight);
438 }
439 if( !pColl ){
440 pColl = pParse->db->pDfltColl;
441 }
442 }
danielk1977f0113002006-01-24 12:09:17 +0000443 for(j=0; j<pIdx->nColumn && pIdx->aiColumn[j]!=iColumn; j++){}
444 assert( j<pIdx->nColumn );
445 if( sqlite3StrICmp(pColl->zName, pIdx->azColl[j]) ) continue;
drhfe05af82005-07-21 03:14:59 +0000446 }
447 return pTerm;
448 }
449 }
450 return 0;
451}
452
drh6c30be82005-07-29 15:10:17 +0000453/* Forward reference */
drh9eb20282005-08-24 03:52:18 +0000454static void exprAnalyze(SrcList*, ExprMaskSet*, WhereClause*, int);
drh6c30be82005-07-29 15:10:17 +0000455
456/*
457** Call exprAnalyze on all terms in a WHERE clause.
458**
459**
460*/
461static void exprAnalyzeAll(
462 SrcList *pTabList, /* the FROM clause */
463 ExprMaskSet *pMaskSet, /* table masks */
464 WhereClause *pWC /* the WHERE clause to be analyzed */
465){
drh6c30be82005-07-29 15:10:17 +0000466 int i;
drh9eb20282005-08-24 03:52:18 +0000467 for(i=pWC->nTerm-1; i>=0; i--){
468 exprAnalyze(pTabList, pMaskSet, pWC, i);
drh6c30be82005-07-29 15:10:17 +0000469 }
470}
471
drhd2687b72005-08-12 22:56:09 +0000472#ifndef SQLITE_OMIT_LIKE_OPTIMIZATION
473/*
474** Check to see if the given expression is a LIKE or GLOB operator that
475** can be optimized using inequality constraints. Return TRUE if it is
476** so and false if not.
477**
478** In order for the operator to be optimizible, the RHS must be a string
479** literal that does not begin with a wildcard.
480*/
481static int isLikeOrGlob(
drh55ef4d92005-08-14 01:20:37 +0000482 sqlite3 *db, /* The database */
drhd2687b72005-08-12 22:56:09 +0000483 Expr *pExpr, /* Test this expression */
484 int *pnPattern, /* Number of non-wildcard prefix characters */
485 int *pisComplete /* True if the only wildcard is % in the last character */
486){
487 const char *z;
488 Expr *pRight, *pLeft;
drh55ef4d92005-08-14 01:20:37 +0000489 ExprList *pList;
drhd2687b72005-08-12 22:56:09 +0000490 int c, cnt;
drhd64fe2f2005-08-28 17:00:23 +0000491 int noCase;
drh55ef4d92005-08-14 01:20:37 +0000492 char wc[3];
drhd64fe2f2005-08-28 17:00:23 +0000493 CollSeq *pColl;
494
495 if( !sqlite3IsLikeFunction(db, pExpr, &noCase, wc) ){
drhd2687b72005-08-12 22:56:09 +0000496 return 0;
497 }
drh55ef4d92005-08-14 01:20:37 +0000498 pList = pExpr->pList;
499 pRight = pList->a[0].pExpr;
drhd2687b72005-08-12 22:56:09 +0000500 if( pRight->op!=TK_STRING ){
501 return 0;
502 }
drh55ef4d92005-08-14 01:20:37 +0000503 pLeft = pList->a[1].pExpr;
drhd2687b72005-08-12 22:56:09 +0000504 if( pLeft->op!=TK_COLUMN ){
505 return 0;
506 }
drhd64fe2f2005-08-28 17:00:23 +0000507 pColl = pLeft->pColl;
508 if( pColl==0 ){
509 pColl = db->pDfltColl;
510 }
511 if( (pColl->type!=SQLITE_COLL_BINARY || noCase) &&
512 (pColl->type!=SQLITE_COLL_NOCASE || !noCase) ){
513 return 0;
514 }
drhd2687b72005-08-12 22:56:09 +0000515 sqlite3DequoteExpr(pRight);
danielk197700fd9572005-12-07 06:27:43 +0000516 z = (char *)pRight->token.z;
drh55ef4d92005-08-14 01:20:37 +0000517 for(cnt=0; (c=z[cnt])!=0 && c!=wc[0] && c!=wc[1] && c!=wc[2]; cnt++){}
drhd2687b72005-08-12 22:56:09 +0000518 if( cnt==0 || 255==(u8)z[cnt] ){
519 return 0;
520 }
drh55ef4d92005-08-14 01:20:37 +0000521 *pisComplete = z[cnt]==wc[0] && z[cnt+1]==0;
drhd2687b72005-08-12 22:56:09 +0000522 *pnPattern = cnt;
523 return 1;
524}
525#endif /* SQLITE_OMIT_LIKE_OPTIMIZATION */
526
drhedb193b2006-06-27 13:20:21 +0000527
528#ifndef SQLITE_OMIT_VIRTUALTABLE
drhfe05af82005-07-21 03:14:59 +0000529/*
drh7f375902006-06-13 17:38:59 +0000530** Check to see if the given expression is of the form
531**
532** column MATCH expr
533**
534** If it is then return TRUE. If not, return FALSE.
535*/
536static int isMatchOfColumn(
537 Expr *pExpr /* Test this expression */
538){
539 ExprList *pList;
540
541 if( pExpr->op!=TK_FUNCTION ){
542 return 0;
543 }
drhedb193b2006-06-27 13:20:21 +0000544 if( pExpr->token.n!=5 ||
545 sqlite3StrNICmp((const char*)pExpr->token.z,"match",5)!=0 ){
drh7f375902006-06-13 17:38:59 +0000546 return 0;
547 }
548 pList = pExpr->pList;
549 if( pList->nExpr!=2 ){
550 return 0;
551 }
552 if( pList->a[1].pExpr->op != TK_COLUMN ){
553 return 0;
554 }
555 return 1;
556}
drhedb193b2006-06-27 13:20:21 +0000557#endif /* SQLITE_OMIT_VIRTUALTABLE */
drh7f375902006-06-13 17:38:59 +0000558
559/*
drh54a167d2005-11-26 14:08:07 +0000560** If the pBase expression originated in the ON or USING clause of
561** a join, then transfer the appropriate markings over to derived.
562*/
563static void transferJoinMarkings(Expr *pDerived, Expr *pBase){
564 pDerived->flags |= pBase->flags & EP_FromJoin;
565 pDerived->iRightJoinTable = pBase->iRightJoinTable;
566}
567
568
569/*
drh0aa74ed2005-07-16 13:33:20 +0000570** The input to this routine is an WhereTerm structure with only the
drh51147ba2005-07-23 22:59:55 +0000571** "pExpr" field filled in. The job of this routine is to analyze the
drh0aa74ed2005-07-16 13:33:20 +0000572** subexpression and populate all the other fields of the WhereTerm
drh75897232000-05-29 14:26:00 +0000573** structure.
drh51147ba2005-07-23 22:59:55 +0000574**
575** If the expression is of the form "<expr> <op> X" it gets commuted
576** to the standard form of "X <op> <expr>". If the expression is of
577** the form "X <op> Y" where both X and Y are columns, then the original
578** expression is unchanged and a new virtual expression of the form
drhb6fb62d2005-09-20 08:47:20 +0000579** "Y <op> X" is added to the WHERE clause and analyzed separately.
drh75897232000-05-29 14:26:00 +0000580*/
drh0fcef5e2005-07-19 17:38:22 +0000581static void exprAnalyze(
582 SrcList *pSrc, /* the FROM clause */
583 ExprMaskSet *pMaskSet, /* table masks */
drh9eb20282005-08-24 03:52:18 +0000584 WhereClause *pWC, /* the WHERE clause */
585 int idxTerm /* Index of the term to be analyzed */
drh0fcef5e2005-07-19 17:38:22 +0000586){
drh9eb20282005-08-24 03:52:18 +0000587 WhereTerm *pTerm = &pWC->a[idxTerm];
drh0fcef5e2005-07-19 17:38:22 +0000588 Expr *pExpr = pTerm->pExpr;
589 Bitmask prereqLeft;
590 Bitmask prereqAll;
drhd2687b72005-08-12 22:56:09 +0000591 int nPattern;
592 int isComplete;
drh0fcef5e2005-07-19 17:38:22 +0000593
danielk19779e128002006-01-18 16:51:35 +0000594 if( sqlite3MallocFailed() ) return;
drh0fcef5e2005-07-19 17:38:22 +0000595 prereqLeft = exprTableUsage(pMaskSet, pExpr->pLeft);
drhf5b11382005-09-17 13:07:13 +0000596 if( pExpr->op==TK_IN ){
597 assert( pExpr->pRight==0 );
598 pTerm->prereqRight = exprListTableUsage(pMaskSet, pExpr->pList)
599 | exprSelectTableUsage(pMaskSet, pExpr->pSelect);
600 }else{
601 pTerm->prereqRight = exprTableUsage(pMaskSet, pExpr->pRight);
602 }
drh22d6a532005-09-19 21:05:48 +0000603 prereqAll = exprTableUsage(pMaskSet, pExpr);
604 if( ExprHasProperty(pExpr, EP_FromJoin) ){
605 prereqAll |= getMask(pMaskSet, pExpr->iRightJoinTable);
606 }
607 pTerm->prereqAll = prereqAll;
drh0fcef5e2005-07-19 17:38:22 +0000608 pTerm->leftCursor = -1;
drh45b1ee42005-08-02 17:48:22 +0000609 pTerm->iParent = -1;
drhb52076c2006-01-23 13:22:09 +0000610 pTerm->eOperator = 0;
drh0fcef5e2005-07-19 17:38:22 +0000611 if( allowedOp(pExpr->op) && (pTerm->prereqRight & prereqLeft)==0 ){
612 Expr *pLeft = pExpr->pLeft;
613 Expr *pRight = pExpr->pRight;
614 if( pLeft->op==TK_COLUMN ){
615 pTerm->leftCursor = pLeft->iTable;
616 pTerm->leftColumn = pLeft->iColumn;
drhb52076c2006-01-23 13:22:09 +0000617 pTerm->eOperator = operatorMask(pExpr->op);
drh75897232000-05-29 14:26:00 +0000618 }
drh0fcef5e2005-07-19 17:38:22 +0000619 if( pRight && pRight->op==TK_COLUMN ){
620 WhereTerm *pNew;
621 Expr *pDup;
622 if( pTerm->leftCursor>=0 ){
drh9eb20282005-08-24 03:52:18 +0000623 int idxNew;
drh0fcef5e2005-07-19 17:38:22 +0000624 pDup = sqlite3ExprDup(pExpr);
drh28f45912006-10-18 23:26:38 +0000625 if( sqlite3MallocFailed() ){
626 sqliteFree(pDup);
627 return;
628 }
drh9eb20282005-08-24 03:52:18 +0000629 idxNew = whereClauseInsert(pWC, pDup, TERM_VIRTUAL|TERM_DYNAMIC);
630 if( idxNew==0 ) return;
631 pNew = &pWC->a[idxNew];
632 pNew->iParent = idxTerm;
633 pTerm = &pWC->a[idxTerm];
drh45b1ee42005-08-02 17:48:22 +0000634 pTerm->nChild = 1;
635 pTerm->flags |= TERM_COPIED;
drh0fcef5e2005-07-19 17:38:22 +0000636 }else{
637 pDup = pExpr;
638 pNew = pTerm;
639 }
640 exprCommute(pDup);
641 pLeft = pDup->pLeft;
642 pNew->leftCursor = pLeft->iTable;
643 pNew->leftColumn = pLeft->iColumn;
644 pNew->prereqRight = prereqLeft;
645 pNew->prereqAll = prereqAll;
drhb52076c2006-01-23 13:22:09 +0000646 pNew->eOperator = operatorMask(pDup->op);
drh75897232000-05-29 14:26:00 +0000647 }
648 }
drhed378002005-07-28 23:12:08 +0000649
drhd2687b72005-08-12 22:56:09 +0000650#ifndef SQLITE_OMIT_BETWEEN_OPTIMIZATION
drhed378002005-07-28 23:12:08 +0000651 /* If a term is the BETWEEN operator, create two new virtual terms
652 ** that define the range that the BETWEEN implements.
653 */
654 else if( pExpr->op==TK_BETWEEN ){
655 ExprList *pList = pExpr->pList;
656 int i;
657 static const u8 ops[] = {TK_GE, TK_LE};
658 assert( pList!=0 );
659 assert( pList->nExpr==2 );
660 for(i=0; i<2; i++){
661 Expr *pNewExpr;
drh9eb20282005-08-24 03:52:18 +0000662 int idxNew;
drhed378002005-07-28 23:12:08 +0000663 pNewExpr = sqlite3Expr(ops[i], sqlite3ExprDup(pExpr->pLeft),
664 sqlite3ExprDup(pList->a[i].pExpr), 0);
drh9eb20282005-08-24 03:52:18 +0000665 idxNew = whereClauseInsert(pWC, pNewExpr, TERM_VIRTUAL|TERM_DYNAMIC);
666 exprAnalyze(pSrc, pMaskSet, pWC, idxNew);
667 pTerm = &pWC->a[idxTerm];
668 pWC->a[idxNew].iParent = idxTerm;
drhed378002005-07-28 23:12:08 +0000669 }
drh45b1ee42005-08-02 17:48:22 +0000670 pTerm->nChild = 2;
drhed378002005-07-28 23:12:08 +0000671 }
drhd2687b72005-08-12 22:56:09 +0000672#endif /* SQLITE_OMIT_BETWEEN_OPTIMIZATION */
drhed378002005-07-28 23:12:08 +0000673
danielk19771576cd92006-01-14 08:02:28 +0000674#if !defined(SQLITE_OMIT_OR_OPTIMIZATION) && !defined(SQLITE_OMIT_SUBQUERY)
drh6c30be82005-07-29 15:10:17 +0000675 /* Attempt to convert OR-connected terms into an IN operator so that
drhf5b11382005-09-17 13:07:13 +0000676 ** they can make use of indices. Example:
677 **
678 ** x = expr1 OR expr2 = x OR x = expr3
679 **
680 ** is converted into
681 **
682 ** x IN (expr1,expr2,expr3)
danielk19771576cd92006-01-14 08:02:28 +0000683 **
684 ** This optimization must be omitted if OMIT_SUBQUERY is defined because
685 ** the compiler for the the IN operator is part of sub-queries.
drh6c30be82005-07-29 15:10:17 +0000686 */
687 else if( pExpr->op==TK_OR ){
688 int ok;
689 int i, j;
690 int iColumn, iCursor;
691 WhereClause sOr;
692 WhereTerm *pOrTerm;
693
694 assert( (pTerm->flags & TERM_DYNAMIC)==0 );
drh9eb20282005-08-24 03:52:18 +0000695 whereClauseInit(&sOr, pWC->pParse);
drh6c30be82005-07-29 15:10:17 +0000696 whereSplit(&sOr, pExpr, TK_OR);
697 exprAnalyzeAll(pSrc, pMaskSet, &sOr);
698 assert( sOr.nTerm>0 );
699 j = 0;
700 do{
701 iColumn = sOr.a[j].leftColumn;
702 iCursor = sOr.a[j].leftCursor;
703 ok = iCursor>=0;
704 for(i=sOr.nTerm-1, pOrTerm=sOr.a; i>=0 && ok; i--, pOrTerm++){
drhb52076c2006-01-23 13:22:09 +0000705 if( pOrTerm->eOperator!=WO_EQ ){
drh6c30be82005-07-29 15:10:17 +0000706 goto or_not_possible;
707 }
708 if( pOrTerm->leftCursor==iCursor && pOrTerm->leftColumn==iColumn ){
709 pOrTerm->flags |= TERM_OR_OK;
drh45b1ee42005-08-02 17:48:22 +0000710 }else if( (pOrTerm->flags & TERM_COPIED)!=0 ||
drh6c30be82005-07-29 15:10:17 +0000711 ((pOrTerm->flags & TERM_VIRTUAL)!=0 &&
drh45b1ee42005-08-02 17:48:22 +0000712 (sOr.a[pOrTerm->iParent].flags & TERM_OR_OK)!=0) ){
drh6c30be82005-07-29 15:10:17 +0000713 pOrTerm->flags &= ~TERM_OR_OK;
714 }else{
715 ok = 0;
716 }
717 }
drh45b1ee42005-08-02 17:48:22 +0000718 }while( !ok && (sOr.a[j++].flags & TERM_COPIED)!=0 && j<sOr.nTerm );
drh6c30be82005-07-29 15:10:17 +0000719 if( ok ){
720 ExprList *pList = 0;
721 Expr *pNew, *pDup;
722 for(i=sOr.nTerm-1, pOrTerm=sOr.a; i>=0 && ok; i--, pOrTerm++){
723 if( (pOrTerm->flags & TERM_OR_OK)==0 ) continue;
724 pDup = sqlite3ExprDup(pOrTerm->pExpr->pRight);
725 pList = sqlite3ExprListAppend(pList, pDup, 0);
726 }
727 pDup = sqlite3Expr(TK_COLUMN, 0, 0, 0);
728 if( pDup ){
729 pDup->iTable = iCursor;
730 pDup->iColumn = iColumn;
731 }
732 pNew = sqlite3Expr(TK_IN, pDup, 0, 0);
drh53f733c2005-09-16 02:38:09 +0000733 if( pNew ){
drh9a5f7472005-11-26 14:24:40 +0000734 int idxNew;
drh54a167d2005-11-26 14:08:07 +0000735 transferJoinMarkings(pNew, pExpr);
drh53f733c2005-09-16 02:38:09 +0000736 pNew->pList = pList;
drh9a5f7472005-11-26 14:24:40 +0000737 idxNew = whereClauseInsert(pWC, pNew, TERM_VIRTUAL|TERM_DYNAMIC);
738 exprAnalyze(pSrc, pMaskSet, pWC, idxNew);
739 pTerm = &pWC->a[idxTerm];
740 pWC->a[idxNew].iParent = idxTerm;
741 pTerm->nChild = 1;
drh53f733c2005-09-16 02:38:09 +0000742 }else{
743 sqlite3ExprListDelete(pList);
744 }
drh6c30be82005-07-29 15:10:17 +0000745 }
746or_not_possible:
747 whereClauseClear(&sOr);
748 }
drhd2687b72005-08-12 22:56:09 +0000749#endif /* SQLITE_OMIT_OR_OPTIMIZATION */
750
751#ifndef SQLITE_OMIT_LIKE_OPTIMIZATION
752 /* Add constraints to reduce the search space on a LIKE or GLOB
753 ** operator.
754 */
drh9eb20282005-08-24 03:52:18 +0000755 if( isLikeOrGlob(pWC->pParse->db, pExpr, &nPattern, &isComplete) ){
drhd2687b72005-08-12 22:56:09 +0000756 Expr *pLeft, *pRight;
757 Expr *pStr1, *pStr2;
758 Expr *pNewExpr1, *pNewExpr2;
drh9eb20282005-08-24 03:52:18 +0000759 int idxNew1, idxNew2;
760
drhd2687b72005-08-12 22:56:09 +0000761 pLeft = pExpr->pList->a[1].pExpr;
762 pRight = pExpr->pList->a[0].pExpr;
763 pStr1 = sqlite3Expr(TK_STRING, 0, 0, 0);
764 if( pStr1 ){
765 sqlite3TokenCopy(&pStr1->token, &pRight->token);
766 pStr1->token.n = nPattern;
767 }
768 pStr2 = sqlite3ExprDup(pStr1);
769 if( pStr2 ){
770 assert( pStr2->token.dyn );
771 ++*(u8*)&pStr2->token.z[nPattern-1];
772 }
773 pNewExpr1 = sqlite3Expr(TK_GE, sqlite3ExprDup(pLeft), pStr1, 0);
drh9eb20282005-08-24 03:52:18 +0000774 idxNew1 = whereClauseInsert(pWC, pNewExpr1, TERM_VIRTUAL|TERM_DYNAMIC);
775 exprAnalyze(pSrc, pMaskSet, pWC, idxNew1);
drhd2687b72005-08-12 22:56:09 +0000776 pNewExpr2 = sqlite3Expr(TK_LT, sqlite3ExprDup(pLeft), pStr2, 0);
drh9eb20282005-08-24 03:52:18 +0000777 idxNew2 = whereClauseInsert(pWC, pNewExpr2, TERM_VIRTUAL|TERM_DYNAMIC);
778 exprAnalyze(pSrc, pMaskSet, pWC, idxNew2);
779 pTerm = &pWC->a[idxTerm];
drhd2687b72005-08-12 22:56:09 +0000780 if( isComplete ){
drh9eb20282005-08-24 03:52:18 +0000781 pWC->a[idxNew1].iParent = idxTerm;
782 pWC->a[idxNew2].iParent = idxTerm;
drhd2687b72005-08-12 22:56:09 +0000783 pTerm->nChild = 2;
784 }
785 }
786#endif /* SQLITE_OMIT_LIKE_OPTIMIZATION */
drh7f375902006-06-13 17:38:59 +0000787
788#ifndef SQLITE_OMIT_VIRTUALTABLE
789 /* Add a WO_MATCH auxiliary term to the constraint set if the
790 ** current expression is of the form: column MATCH expr.
791 ** This information is used by the xBestIndex methods of
792 ** virtual tables. The native query optimizer does not attempt
793 ** to do anything with MATCH functions.
794 */
795 if( isMatchOfColumn(pExpr) ){
796 int idxNew;
797 Expr *pRight, *pLeft;
798 WhereTerm *pNewTerm;
799 Bitmask prereqColumn, prereqExpr;
800
801 pRight = pExpr->pList->a[0].pExpr;
802 pLeft = pExpr->pList->a[1].pExpr;
803 prereqExpr = exprTableUsage(pMaskSet, pRight);
804 prereqColumn = exprTableUsage(pMaskSet, pLeft);
805 if( (prereqExpr & prereqColumn)==0 ){
drh1a90e092006-06-14 22:07:10 +0000806 Expr *pNewExpr;
807 pNewExpr = sqlite3Expr(TK_MATCH, 0, sqlite3ExprDup(pRight), 0);
808 idxNew = whereClauseInsert(pWC, pNewExpr, TERM_VIRTUAL|TERM_DYNAMIC);
drh7f375902006-06-13 17:38:59 +0000809 pNewTerm = &pWC->a[idxNew];
810 pNewTerm->prereqRight = prereqExpr;
811 pNewTerm->leftCursor = pLeft->iTable;
812 pNewTerm->leftColumn = pLeft->iColumn;
813 pNewTerm->eOperator = WO_MATCH;
814 pNewTerm->iParent = idxTerm;
drhd2ca60d2006-06-27 02:36:58 +0000815 pTerm = &pWC->a[idxTerm];
drh7f375902006-06-13 17:38:59 +0000816 pTerm->nChild = 1;
817 pTerm->flags |= TERM_COPIED;
818 pNewTerm->prereqAll = pTerm->prereqAll;
819 }
820 }
821#endif /* SQLITE_OMIT_VIRTUALTABLE */
drh75897232000-05-29 14:26:00 +0000822}
823
drh0fcef5e2005-07-19 17:38:22 +0000824
drh75897232000-05-29 14:26:00 +0000825/*
drh51669862004-12-18 18:40:26 +0000826** This routine decides if pIdx can be used to satisfy the ORDER BY
827** clause. If it can, it returns 1. If pIdx cannot satisfy the
828** ORDER BY clause, this routine returns 0.
829**
830** pOrderBy is an ORDER BY clause from a SELECT statement. pTab is the
831** left-most table in the FROM clause of that same SELECT statement and
832** the table has a cursor number of "base". pIdx is an index on pTab.
833**
834** nEqCol is the number of columns of pIdx that are used as equality
835** constraints. Any of these columns may be missing from the ORDER BY
836** clause and the match can still be a success.
837**
drh51669862004-12-18 18:40:26 +0000838** All terms of the ORDER BY that match against the index must be either
839** ASC or DESC. (Terms of the ORDER BY clause past the end of a UNIQUE
840** index do not need to satisfy this constraint.) The *pbRev value is
841** set to 1 if the ORDER BY clause is all DESC and it is set to 0 if
842** the ORDER BY clause is all ASC.
843*/
844static int isSortingIndex(
845 Parse *pParse, /* Parsing context */
846 Index *pIdx, /* The index we are testing */
drh74161702006-02-24 02:53:49 +0000847 int base, /* Cursor number for the table to be sorted */
drh51669862004-12-18 18:40:26 +0000848 ExprList *pOrderBy, /* The ORDER BY clause */
849 int nEqCol, /* Number of index columns with == constraints */
850 int *pbRev /* Set to 1 if ORDER BY is DESC */
851){
drhb46b5772005-08-29 16:40:52 +0000852 int i, j; /* Loop counters */
drh85eeb692005-12-21 03:16:42 +0000853 int sortOrder = 0; /* XOR of index and ORDER BY sort direction */
drhb46b5772005-08-29 16:40:52 +0000854 int nTerm; /* Number of ORDER BY terms */
855 struct ExprList_item *pTerm; /* A term of the ORDER BY clause */
drh51669862004-12-18 18:40:26 +0000856 sqlite3 *db = pParse->db;
857
858 assert( pOrderBy!=0 );
859 nTerm = pOrderBy->nExpr;
860 assert( nTerm>0 );
861
862 /* Match terms of the ORDER BY clause against columns of
863 ** the index.
864 */
865 for(i=j=0, pTerm=pOrderBy->a; j<nTerm && i<pIdx->nColumn; i++){
866 Expr *pExpr; /* The expression of the ORDER BY pTerm */
867 CollSeq *pColl; /* The collating sequence of pExpr */
drh85eeb692005-12-21 03:16:42 +0000868 int termSortOrder; /* Sort order for this term */
drh51669862004-12-18 18:40:26 +0000869
870 pExpr = pTerm->pExpr;
871 if( pExpr->op!=TK_COLUMN || pExpr->iTable!=base ){
872 /* Can not use an index sort on anything that is not a column in the
873 ** left-most table of the FROM clause */
874 return 0;
875 }
876 pColl = sqlite3ExprCollSeq(pParse, pExpr);
877 if( !pColl ) pColl = db->pDfltColl;
danielk1977b3bf5562006-01-10 17:58:23 +0000878 if( pExpr->iColumn!=pIdx->aiColumn[i] ||
879 sqlite3StrICmp(pColl->zName, pIdx->azColl[i]) ){
drh9012bcb2004-12-19 00:11:35 +0000880 /* Term j of the ORDER BY clause does not match column i of the index */
881 if( i<nEqCol ){
drh51669862004-12-18 18:40:26 +0000882 /* If an index column that is constrained by == fails to match an
883 ** ORDER BY term, that is OK. Just ignore that column of the index
884 */
885 continue;
886 }else{
887 /* If an index column fails to match and is not constrained by ==
888 ** then the index cannot satisfy the ORDER BY constraint.
889 */
890 return 0;
891 }
892 }
danielk1977b3bf5562006-01-10 17:58:23 +0000893 assert( pIdx->aSortOrder!=0 );
drh85eeb692005-12-21 03:16:42 +0000894 assert( pTerm->sortOrder==0 || pTerm->sortOrder==1 );
danielk1977b3bf5562006-01-10 17:58:23 +0000895 assert( pIdx->aSortOrder[i]==0 || pIdx->aSortOrder[i]==1 );
896 termSortOrder = pIdx->aSortOrder[i] ^ pTerm->sortOrder;
drh51669862004-12-18 18:40:26 +0000897 if( i>nEqCol ){
drh85eeb692005-12-21 03:16:42 +0000898 if( termSortOrder!=sortOrder ){
drh51669862004-12-18 18:40:26 +0000899 /* Indices can only be used if all ORDER BY terms past the
900 ** equality constraints are all either DESC or ASC. */
901 return 0;
902 }
903 }else{
drh85eeb692005-12-21 03:16:42 +0000904 sortOrder = termSortOrder;
drh51669862004-12-18 18:40:26 +0000905 }
906 j++;
907 pTerm++;
908 }
909
910 /* The index can be used for sorting if all terms of the ORDER BY clause
drh8718f522005-08-13 16:13:04 +0000911 ** are covered.
drh51669862004-12-18 18:40:26 +0000912 */
drh8718f522005-08-13 16:13:04 +0000913 if( j>=nTerm ){
drh85eeb692005-12-21 03:16:42 +0000914 *pbRev = sortOrder!=0;
drh51669862004-12-18 18:40:26 +0000915 return 1;
916 }
917 return 0;
918}
919
920/*
drhb6c29892004-11-22 19:12:19 +0000921** Check table to see if the ORDER BY clause in pOrderBy can be satisfied
922** by sorting in order of ROWID. Return true if so and set *pbRev to be
923** true for reverse ROWID and false for forward ROWID order.
924*/
925static int sortableByRowid(
926 int base, /* Cursor number for table to be sorted */
927 ExprList *pOrderBy, /* The ORDER BY clause */
928 int *pbRev /* Set to 1 if ORDER BY is DESC */
929){
930 Expr *p;
931
932 assert( pOrderBy!=0 );
933 assert( pOrderBy->nExpr>0 );
934 p = pOrderBy->a[0].pExpr;
drha21c8492005-09-01 17:47:51 +0000935 if( pOrderBy->nExpr==1 && p->op==TK_COLUMN && p->iTable==base
936 && p->iColumn==-1 ){
drhb6c29892004-11-22 19:12:19 +0000937 *pbRev = pOrderBy->a[0].sortOrder;
938 return 1;
939 }
940 return 0;
941}
942
drhfe05af82005-07-21 03:14:59 +0000943/*
drhb6fb62d2005-09-20 08:47:20 +0000944** Prepare a crude estimate of the logarithm of the input value.
drh28c4cf42005-07-27 20:41:43 +0000945** The results need not be exact. This is only used for estimating
946** the total cost of performing operatings with O(logN) or O(NlogN)
947** complexity. Because N is just a guess, it is no great tragedy if
948** logN is a little off.
drh28c4cf42005-07-27 20:41:43 +0000949*/
950static double estLog(double N){
drhb37df7b2005-10-13 02:09:49 +0000951 double logN = 1;
952 double x = 10;
drh28c4cf42005-07-27 20:41:43 +0000953 while( N>x ){
drhb37df7b2005-10-13 02:09:49 +0000954 logN += 1;
drh28c4cf42005-07-27 20:41:43 +0000955 x *= 10;
956 }
957 return logN;
958}
959
drh6d209d82006-06-27 01:54:26 +0000960/*
961** Two routines for printing the content of an sqlite3_index_info
962** structure. Used for testing and debugging only. If neither
963** SQLITE_TEST or SQLITE_DEBUG are defined, then these routines
964** are no-ops.
965*/
966#if !defined(SQLITE_OMIT_VIRTUALTABLE) && \
967 (defined(SQLITE_TEST) || defined(SQLITE_DEBUG))
968static void TRACE_IDX_INPUTS(sqlite3_index_info *p){
969 int i;
970 if( !sqlite3_where_trace ) return;
971 for(i=0; i<p->nConstraint; i++){
972 sqlite3DebugPrintf(" constraint[%d]: col=%d termid=%d op=%d usabled=%d\n",
973 i,
974 p->aConstraint[i].iColumn,
975 p->aConstraint[i].iTermOffset,
976 p->aConstraint[i].op,
977 p->aConstraint[i].usable);
978 }
979 for(i=0; i<p->nOrderBy; i++){
980 sqlite3DebugPrintf(" orderby[%d]: col=%d desc=%d\n",
981 i,
982 p->aOrderBy[i].iColumn,
983 p->aOrderBy[i].desc);
984 }
985}
986static void TRACE_IDX_OUTPUTS(sqlite3_index_info *p){
987 int i;
988 if( !sqlite3_where_trace ) return;
989 for(i=0; i<p->nConstraint; i++){
990 sqlite3DebugPrintf(" usage[%d]: argvIdx=%d omit=%d\n",
991 i,
992 p->aConstraintUsage[i].argvIndex,
993 p->aConstraintUsage[i].omit);
994 }
995 sqlite3DebugPrintf(" idxNum=%d\n", p->idxNum);
996 sqlite3DebugPrintf(" idxStr=%s\n", p->idxStr);
997 sqlite3DebugPrintf(" orderByConsumed=%d\n", p->orderByConsumed);
998 sqlite3DebugPrintf(" estimatedCost=%g\n", p->estimatedCost);
999}
1000#else
1001#define TRACE_IDX_INPUTS(A)
1002#define TRACE_IDX_OUTPUTS(A)
1003#endif
1004
drh9eff6162006-06-12 21:59:13 +00001005#ifndef SQLITE_OMIT_VIRTUALTABLE
1006/*
drh7f375902006-06-13 17:38:59 +00001007** Compute the best index for a virtual table.
1008**
1009** The best index is computed by the xBestIndex method of the virtual
1010** table module. This routine is really just a wrapper that sets up
1011** the sqlite3_index_info structure that is used to communicate with
1012** xBestIndex.
1013**
1014** In a join, this routine might be called multiple times for the
1015** same virtual table. The sqlite3_index_info structure is created
1016** and initialized on the first invocation and reused on all subsequent
1017** invocations. The sqlite3_index_info structure is also used when
1018** code is generated to access the virtual table. The whereInfoDelete()
1019** routine takes care of freeing the sqlite3_index_info structure after
1020** everybody has finished with it.
drh9eff6162006-06-12 21:59:13 +00001021*/
1022static double bestVirtualIndex(
1023 Parse *pParse, /* The parsing context */
1024 WhereClause *pWC, /* The WHERE clause */
1025 struct SrcList_item *pSrc, /* The FROM clause term to search */
1026 Bitmask notReady, /* Mask of cursors that are not available */
1027 ExprList *pOrderBy, /* The order by clause */
1028 int orderByUsable, /* True if we can potential sort */
1029 sqlite3_index_info **ppIdxInfo /* Index information passed to xBestIndex */
1030){
1031 Table *pTab = pSrc->pTab;
1032 sqlite3_index_info *pIdxInfo;
1033 struct sqlite3_index_constraint *pIdxCons;
1034 struct sqlite3_index_orderby *pIdxOrderBy;
1035 struct sqlite3_index_constraint_usage *pUsage;
1036 WhereTerm *pTerm;
1037 int i, j;
1038 int nOrderBy;
danielk197774cdba42006-06-19 12:02:58 +00001039 int rc;
drh9eff6162006-06-12 21:59:13 +00001040
1041 /* If the sqlite3_index_info structure has not been previously
1042 ** allocated and initialized for this virtual table, then allocate
1043 ** and initialize it now
1044 */
1045 pIdxInfo = *ppIdxInfo;
1046 if( pIdxInfo==0 ){
1047 WhereTerm *pTerm;
1048 int nTerm;
drh6d209d82006-06-27 01:54:26 +00001049 TRACE(("Recomputing index info for %s...\n", pTab->zName));
drh9eff6162006-06-12 21:59:13 +00001050
1051 /* Count the number of possible WHERE clause constraints referring
1052 ** to this virtual table */
1053 for(i=nTerm=0, pTerm=pWC->a; i<pWC->nTerm; i++, pTerm++){
1054 if( pTerm->leftCursor != pSrc->iCursor ) continue;
1055 if( pTerm->eOperator==WO_IN ) continue;
1056 nTerm++;
1057 }
1058
1059 /* If the ORDER BY clause contains only columns in the current
1060 ** virtual table then allocate space for the aOrderBy part of
1061 ** the sqlite3_index_info structure.
1062 */
1063 nOrderBy = 0;
1064 if( pOrderBy ){
1065 for(i=0; i<pOrderBy->nExpr; i++){
1066 Expr *pExpr = pOrderBy->a[i].pExpr;
1067 if( pExpr->op!=TK_COLUMN || pExpr->iTable!=pSrc->iCursor ) break;
1068 }
1069 if( i==pOrderBy->nExpr ){
1070 nOrderBy = pOrderBy->nExpr;
1071 }
1072 }
1073
1074 /* Allocate the sqlite3_index_info structure
1075 */
1076 pIdxInfo = sqliteMalloc( sizeof(*pIdxInfo)
1077 + (sizeof(*pIdxCons) + sizeof(*pUsage))*nTerm
1078 + sizeof(*pIdxOrderBy)*nOrderBy );
1079 if( pIdxInfo==0 ){
1080 sqlite3ErrorMsg(pParse, "out of memory");
1081 return 0.0;
1082 }
1083 *ppIdxInfo = pIdxInfo;
1084
1085 /* Initialize the structure. The sqlite3_index_info structure contains
1086 ** many fields that are declared "const" to prevent xBestIndex from
1087 ** changing them. We have to do some funky casting in order to
1088 ** initialize those fields.
1089 */
1090 pIdxCons = (struct sqlite3_index_constraint*)&pIdxInfo[1];
1091 pIdxOrderBy = (struct sqlite3_index_orderby*)&pIdxCons[nTerm];
1092 pUsage = (struct sqlite3_index_constraint_usage*)&pIdxOrderBy[nOrderBy];
1093 *(int*)&pIdxInfo->nConstraint = nTerm;
1094 *(int*)&pIdxInfo->nOrderBy = nOrderBy;
1095 *(struct sqlite3_index_constraint**)&pIdxInfo->aConstraint = pIdxCons;
1096 *(struct sqlite3_index_orderby**)&pIdxInfo->aOrderBy = pIdxOrderBy;
1097 *(struct sqlite3_index_constraint_usage**)&pIdxInfo->aConstraintUsage =
1098 pUsage;
1099
1100 for(i=j=0, pTerm=pWC->a; i<pWC->nTerm; i++, pTerm++){
1101 if( pTerm->leftCursor != pSrc->iCursor ) continue;
1102 if( pTerm->eOperator==WO_IN ) continue;
1103 pIdxCons[j].iColumn = pTerm->leftColumn;
1104 pIdxCons[j].iTermOffset = i;
1105 pIdxCons[j].op = pTerm->eOperator;
drh7f375902006-06-13 17:38:59 +00001106 /* The direct assignment in the previous line is possible only because
1107 ** the WO_ and SQLITE_INDEX_CONSTRAINT_ codes are identical. The
1108 ** following asserts verify this fact. */
drh9eff6162006-06-12 21:59:13 +00001109 assert( WO_EQ==SQLITE_INDEX_CONSTRAINT_EQ );
1110 assert( WO_LT==SQLITE_INDEX_CONSTRAINT_LT );
1111 assert( WO_LE==SQLITE_INDEX_CONSTRAINT_LE );
1112 assert( WO_GT==SQLITE_INDEX_CONSTRAINT_GT );
1113 assert( WO_GE==SQLITE_INDEX_CONSTRAINT_GE );
drh7f375902006-06-13 17:38:59 +00001114 assert( WO_MATCH==SQLITE_INDEX_CONSTRAINT_MATCH );
1115 assert( pTerm->eOperator & (WO_EQ|WO_LT|WO_LE|WO_GT|WO_GE|WO_MATCH) );
drh9eff6162006-06-12 21:59:13 +00001116 j++;
1117 }
1118 for(i=0; i<nOrderBy; i++){
1119 Expr *pExpr = pOrderBy->a[i].pExpr;
1120 pIdxOrderBy[i].iColumn = pExpr->iColumn;
1121 pIdxOrderBy[i].desc = pOrderBy->a[i].sortOrder;
1122 }
1123 }
1124
drh7f375902006-06-13 17:38:59 +00001125 /* At this point, the sqlite3_index_info structure that pIdxInfo points
1126 ** to will have been initialized, either during the current invocation or
1127 ** during some prior invocation. Now we just have to customize the
1128 ** details of pIdxInfo for the current invocation and pass it to
1129 ** xBestIndex.
1130 */
1131
drh9eff6162006-06-12 21:59:13 +00001132 /* The module name must be defined */
1133 assert( pTab->azModuleArg && pTab->azModuleArg[0] );
1134 if( pTab->pVtab==0 ){
1135 sqlite3ErrorMsg(pParse, "undefined module %s for table %s",
1136 pTab->azModuleArg[0], pTab->zName);
1137 return 0.0;
1138 }
1139
1140 /* Set the aConstraint[].usable fields and initialize all
drh7f375902006-06-13 17:38:59 +00001141 ** output variables to zero.
1142 **
1143 ** aConstraint[].usable is true for constraints where the right-hand
1144 ** side contains only references to tables to the left of the current
1145 ** table. In other words, if the constraint is of the form:
1146 **
1147 ** column = expr
1148 **
1149 ** and we are evaluating a join, then the constraint on column is
1150 ** only valid if all tables referenced in expr occur to the left
1151 ** of the table containing column.
1152 **
1153 ** The aConstraints[] array contains entries for all constraints
1154 ** on the current table. That way we only have to compute it once
1155 ** even though we might try to pick the best index multiple times.
1156 ** For each attempt at picking an index, the order of tables in the
1157 ** join might be different so we have to recompute the usable flag
1158 ** each time.
drh9eff6162006-06-12 21:59:13 +00001159 */
1160 pIdxCons = *(struct sqlite3_index_constraint**)&pIdxInfo->aConstraint;
1161 pUsage = pIdxInfo->aConstraintUsage;
1162 for(i=0; i<pIdxInfo->nConstraint; i++, pIdxCons++){
1163 j = pIdxCons->iTermOffset;
1164 pTerm = &pWC->a[j];
1165 pIdxCons->usable = (pTerm->prereqRight & notReady)==0;
1166 }
1167 memset(pUsage, 0, sizeof(pUsage[0])*pIdxInfo->nConstraint);
drh4be8b512006-06-13 23:51:34 +00001168 if( pIdxInfo->needToFreeIdxStr ){
1169 sqlite3_free(pIdxInfo->idxStr);
1170 }
1171 pIdxInfo->idxStr = 0;
1172 pIdxInfo->idxNum = 0;
1173 pIdxInfo->needToFreeIdxStr = 0;
drh9eff6162006-06-12 21:59:13 +00001174 pIdxInfo->orderByConsumed = 0;
danielk197793626f42006-06-20 13:07:27 +00001175 pIdxInfo->estimatedCost = SQLITE_BIG_DBL / 2.0;
drh9eff6162006-06-12 21:59:13 +00001176 nOrderBy = pIdxInfo->nOrderBy;
1177 if( pIdxInfo->nOrderBy && !orderByUsable ){
drha967e882006-06-13 01:04:52 +00001178 *(int*)&pIdxInfo->nOrderBy = 0;
drh9eff6162006-06-12 21:59:13 +00001179 }
danielk197774cdba42006-06-19 12:02:58 +00001180
1181 sqlite3SafetyOff(pParse->db);
drh6d209d82006-06-27 01:54:26 +00001182 TRACE(("xBestIndex for %s\n", pTab->zName));
1183 TRACE_IDX_INPUTS(pIdxInfo);
danielk1977be718892006-06-23 08:05:19 +00001184 rc = pTab->pVtab->pModule->xBestIndex(pTab->pVtab, pIdxInfo);
drh6d209d82006-06-27 01:54:26 +00001185 TRACE_IDX_OUTPUTS(pIdxInfo);
danielk197774cdba42006-06-19 12:02:58 +00001186 if( rc!=SQLITE_OK ){
danielk1977be718892006-06-23 08:05:19 +00001187 if( rc==SQLITE_NOMEM ){
1188 sqlite3FailedMalloc();
1189 }else {
1190 sqlite3ErrorMsg(pParse, "%s", sqlite3ErrStr(rc));
1191 }
1192 sqlite3SafetyOn(pParse->db);
1193 }else{
1194 rc = sqlite3SafetyOn(pParse->db);
danielk197774cdba42006-06-19 12:02:58 +00001195 }
drha967e882006-06-13 01:04:52 +00001196 *(int*)&pIdxInfo->nOrderBy = nOrderBy;
drh9eff6162006-06-12 21:59:13 +00001197 return pIdxInfo->estimatedCost;
1198}
1199#endif /* SQLITE_OMIT_VIRTUALTABLE */
1200
drh28c4cf42005-07-27 20:41:43 +00001201/*
drh51147ba2005-07-23 22:59:55 +00001202** Find the best index for accessing a particular table. Return a pointer
1203** to the index, flags that describe how the index should be used, the
drha6110402005-07-28 20:51:19 +00001204** number of equality constraints, and the "cost" for this index.
drh51147ba2005-07-23 22:59:55 +00001205**
1206** The lowest cost index wins. The cost is an estimate of the amount of
1207** CPU and disk I/O need to process the request using the selected index.
1208** Factors that influence cost include:
1209**
1210** * The estimated number of rows that will be retrieved. (The
1211** fewer the better.)
1212**
1213** * Whether or not sorting must occur.
1214**
1215** * Whether or not there must be separate lookups in the
1216** index and in the main table.
1217**
drhfe05af82005-07-21 03:14:59 +00001218*/
1219static double bestIndex(
1220 Parse *pParse, /* The parsing context */
1221 WhereClause *pWC, /* The WHERE clause */
1222 struct SrcList_item *pSrc, /* The FROM clause term to search */
1223 Bitmask notReady, /* Mask of cursors that are not available */
1224 ExprList *pOrderBy, /* The order by clause */
1225 Index **ppIndex, /* Make *ppIndex point to the best index */
drh51147ba2005-07-23 22:59:55 +00001226 int *pFlags, /* Put flags describing this choice in *pFlags */
1227 int *pnEq /* Put the number of == or IN constraints here */
drhfe05af82005-07-21 03:14:59 +00001228){
1229 WhereTerm *pTerm;
drh51147ba2005-07-23 22:59:55 +00001230 Index *bestIdx = 0; /* Index that gives the lowest cost */
drhb37df7b2005-10-13 02:09:49 +00001231 double lowestCost; /* The cost of using bestIdx */
drh51147ba2005-07-23 22:59:55 +00001232 int bestFlags = 0; /* Flags associated with bestIdx */
1233 int bestNEq = 0; /* Best value for nEq */
1234 int iCur = pSrc->iCursor; /* The cursor of the table to be accessed */
1235 Index *pProbe; /* An index we are evaluating */
1236 int rev; /* True to scan in reverse order */
1237 int flags; /* Flags associated with pProbe */
1238 int nEq; /* Number of == or IN constraints */
1239 double cost; /* Cost of using pProbe */
drhfe05af82005-07-21 03:14:59 +00001240
drh51147ba2005-07-23 22:59:55 +00001241 TRACE(("bestIndex: tbl=%s notReady=%x\n", pSrc->pTab->zName, notReady));
drhb37df7b2005-10-13 02:09:49 +00001242 lowestCost = SQLITE_BIG_DBL;
drh4dd238a2006-03-28 23:55:57 +00001243 pProbe = pSrc->pTab->pIndex;
1244
1245 /* If the table has no indices and there are no terms in the where
1246 ** clause that refer to the ROWID, then we will never be able to do
1247 ** anything other than a full table scan on this table. We might as
1248 ** well put it first in the join order. That way, perhaps it can be
1249 ** referenced by other tables in the join.
1250 */
1251 if( pProbe==0 &&
1252 findTerm(pWC, iCur, -1, 0, WO_EQ|WO_IN|WO_LT|WO_LE|WO_GT|WO_GE,0)==0 &&
1253 (pOrderBy==0 || !sortableByRowid(iCur, pOrderBy, &rev)) ){
1254 *pFlags = 0;
1255 *ppIndex = 0;
1256 *pnEq = 0;
1257 return 0.0;
1258 }
drh51147ba2005-07-23 22:59:55 +00001259
1260 /* Check for a rowid=EXPR or rowid IN (...) constraints
drhfe05af82005-07-21 03:14:59 +00001261 */
1262 pTerm = findTerm(pWC, iCur, -1, notReady, WO_EQ|WO_IN, 0);
1263 if( pTerm ){
drha6110402005-07-28 20:51:19 +00001264 Expr *pExpr;
drhfe05af82005-07-21 03:14:59 +00001265 *ppIndex = 0;
drh51147ba2005-07-23 22:59:55 +00001266 bestFlags = WHERE_ROWID_EQ;
drhb52076c2006-01-23 13:22:09 +00001267 if( pTerm->eOperator & WO_EQ ){
drh28c4cf42005-07-27 20:41:43 +00001268 /* Rowid== is always the best pick. Look no further. Because only
1269 ** a single row is generated, output is always in sorted order */
drh943af3c2005-07-29 19:43:58 +00001270 *pFlags = WHERE_ROWID_EQ | WHERE_UNIQUE;
drh51147ba2005-07-23 22:59:55 +00001271 *pnEq = 1;
drh51147ba2005-07-23 22:59:55 +00001272 TRACE(("... best is rowid\n"));
1273 return 0.0;
drha6110402005-07-28 20:51:19 +00001274 }else if( (pExpr = pTerm->pExpr)->pList!=0 ){
drh28c4cf42005-07-27 20:41:43 +00001275 /* Rowid IN (LIST): cost is NlogN where N is the number of list
1276 ** elements. */
drha6110402005-07-28 20:51:19 +00001277 lowestCost = pExpr->pList->nExpr;
drh28c4cf42005-07-27 20:41:43 +00001278 lowestCost *= estLog(lowestCost);
drhfe05af82005-07-21 03:14:59 +00001279 }else{
drh28c4cf42005-07-27 20:41:43 +00001280 /* Rowid IN (SELECT): cost is NlogN where N is the number of rows
1281 ** in the result of the inner select. We have no way to estimate
1282 ** that value so make a wild guess. */
drhb37df7b2005-10-13 02:09:49 +00001283 lowestCost = 200;
drhfe05af82005-07-21 03:14:59 +00001284 }
drh3adc9ce2005-07-28 16:51:51 +00001285 TRACE(("... rowid IN cost: %.9g\n", lowestCost));
drhfe05af82005-07-21 03:14:59 +00001286 }
1287
drh28c4cf42005-07-27 20:41:43 +00001288 /* Estimate the cost of a table scan. If we do not know how many
1289 ** entries are in the table, use 1 million as a guess.
drhfe05af82005-07-21 03:14:59 +00001290 */
drhb37df7b2005-10-13 02:09:49 +00001291 cost = pProbe ? pProbe->aiRowEst[0] : 1000000;
drh3adc9ce2005-07-28 16:51:51 +00001292 TRACE(("... table scan base cost: %.9g\n", cost));
drh28c4cf42005-07-27 20:41:43 +00001293 flags = WHERE_ROWID_RANGE;
1294
1295 /* Check for constraints on a range of rowids in a table scan.
1296 */
drhfe05af82005-07-21 03:14:59 +00001297 pTerm = findTerm(pWC, iCur, -1, notReady, WO_LT|WO_LE|WO_GT|WO_GE, 0);
1298 if( pTerm ){
drh51147ba2005-07-23 22:59:55 +00001299 if( findTerm(pWC, iCur, -1, notReady, WO_LT|WO_LE, 0) ){
1300 flags |= WHERE_TOP_LIMIT;
drhb37df7b2005-10-13 02:09:49 +00001301 cost /= 3; /* Guess that rowid<EXPR eliminates two-thirds or rows */
drhfe05af82005-07-21 03:14:59 +00001302 }
drh51147ba2005-07-23 22:59:55 +00001303 if( findTerm(pWC, iCur, -1, notReady, WO_GT|WO_GE, 0) ){
1304 flags |= WHERE_BTM_LIMIT;
drhb37df7b2005-10-13 02:09:49 +00001305 cost /= 3; /* Guess that rowid>EXPR eliminates two-thirds of rows */
drhfe05af82005-07-21 03:14:59 +00001306 }
drh3adc9ce2005-07-28 16:51:51 +00001307 TRACE(("... rowid range reduces cost to %.9g\n", cost));
drh51147ba2005-07-23 22:59:55 +00001308 }else{
1309 flags = 0;
1310 }
drh28c4cf42005-07-27 20:41:43 +00001311
1312 /* If the table scan does not satisfy the ORDER BY clause, increase
1313 ** the cost by NlogN to cover the expense of sorting. */
1314 if( pOrderBy ){
1315 if( sortableByRowid(iCur, pOrderBy, &rev) ){
1316 flags |= WHERE_ORDERBY|WHERE_ROWID_RANGE;
1317 if( rev ){
1318 flags |= WHERE_REVERSE;
1319 }
1320 }else{
1321 cost += cost*estLog(cost);
drh3adc9ce2005-07-28 16:51:51 +00001322 TRACE(("... sorting increases cost to %.9g\n", cost));
drh51147ba2005-07-23 22:59:55 +00001323 }
drh51147ba2005-07-23 22:59:55 +00001324 }
1325 if( cost<lowestCost ){
1326 lowestCost = cost;
drhfe05af82005-07-21 03:14:59 +00001327 bestFlags = flags;
1328 }
1329
1330 /* Look at each index.
1331 */
drh51147ba2005-07-23 22:59:55 +00001332 for(; pProbe; pProbe=pProbe->pNext){
1333 int i; /* Loop counter */
drhb37df7b2005-10-13 02:09:49 +00001334 double inMultiplier = 1;
drh51147ba2005-07-23 22:59:55 +00001335
1336 TRACE(("... index %s:\n", pProbe->zName));
drhfe05af82005-07-21 03:14:59 +00001337
1338 /* Count the number of columns in the index that are satisfied
1339 ** by x=EXPR constraints or x IN (...) constraints.
1340 */
drh51147ba2005-07-23 22:59:55 +00001341 flags = 0;
drhfe05af82005-07-21 03:14:59 +00001342 for(i=0; i<pProbe->nColumn; i++){
1343 int j = pProbe->aiColumn[i];
1344 pTerm = findTerm(pWC, iCur, j, notReady, WO_EQ|WO_IN, pProbe);
1345 if( pTerm==0 ) break;
drh51147ba2005-07-23 22:59:55 +00001346 flags |= WHERE_COLUMN_EQ;
drhb52076c2006-01-23 13:22:09 +00001347 if( pTerm->eOperator & WO_IN ){
drha6110402005-07-28 20:51:19 +00001348 Expr *pExpr = pTerm->pExpr;
drh51147ba2005-07-23 22:59:55 +00001349 flags |= WHERE_COLUMN_IN;
drha6110402005-07-28 20:51:19 +00001350 if( pExpr->pSelect!=0 ){
drhffe0f892006-05-11 13:26:25 +00001351 inMultiplier *= 25;
drha6110402005-07-28 20:51:19 +00001352 }else if( pExpr->pList!=0 ){
drhb37df7b2005-10-13 02:09:49 +00001353 inMultiplier *= pExpr->pList->nExpr + 1;
drhfe05af82005-07-21 03:14:59 +00001354 }
1355 }
1356 }
drh28c4cf42005-07-27 20:41:43 +00001357 cost = pProbe->aiRowEst[i] * inMultiplier * estLog(inMultiplier);
drh51147ba2005-07-23 22:59:55 +00001358 nEq = i;
drh943af3c2005-07-29 19:43:58 +00001359 if( pProbe->onError!=OE_None && (flags & WHERE_COLUMN_IN)==0
1360 && nEq==pProbe->nColumn ){
1361 flags |= WHERE_UNIQUE;
1362 }
drh3adc9ce2005-07-28 16:51:51 +00001363 TRACE(("...... nEq=%d inMult=%.9g cost=%.9g\n", nEq, inMultiplier, cost));
drhfe05af82005-07-21 03:14:59 +00001364
drh51147ba2005-07-23 22:59:55 +00001365 /* Look for range constraints
drhfe05af82005-07-21 03:14:59 +00001366 */
drh51147ba2005-07-23 22:59:55 +00001367 if( nEq<pProbe->nColumn ){
1368 int j = pProbe->aiColumn[nEq];
1369 pTerm = findTerm(pWC, iCur, j, notReady, WO_LT|WO_LE|WO_GT|WO_GE, pProbe);
1370 if( pTerm ){
drha6110402005-07-28 20:51:19 +00001371 flags |= WHERE_COLUMN_RANGE;
drh51147ba2005-07-23 22:59:55 +00001372 if( findTerm(pWC, iCur, j, notReady, WO_LT|WO_LE, pProbe) ){
1373 flags |= WHERE_TOP_LIMIT;
drhb37df7b2005-10-13 02:09:49 +00001374 cost /= 3;
drh51147ba2005-07-23 22:59:55 +00001375 }
1376 if( findTerm(pWC, iCur, j, notReady, WO_GT|WO_GE, pProbe) ){
1377 flags |= WHERE_BTM_LIMIT;
drhb37df7b2005-10-13 02:09:49 +00001378 cost /= 3;
drh51147ba2005-07-23 22:59:55 +00001379 }
drh3adc9ce2005-07-28 16:51:51 +00001380 TRACE(("...... range reduces cost to %.9g\n", cost));
drh51147ba2005-07-23 22:59:55 +00001381 }
1382 }
1383
drh28c4cf42005-07-27 20:41:43 +00001384 /* Add the additional cost of sorting if that is a factor.
drh51147ba2005-07-23 22:59:55 +00001385 */
drh28c4cf42005-07-27 20:41:43 +00001386 if( pOrderBy ){
1387 if( (flags & WHERE_COLUMN_IN)==0 &&
drh74161702006-02-24 02:53:49 +00001388 isSortingIndex(pParse,pProbe,iCur,pOrderBy,nEq,&rev) ){
drh28c4cf42005-07-27 20:41:43 +00001389 if( flags==0 ){
1390 flags = WHERE_COLUMN_RANGE;
1391 }
1392 flags |= WHERE_ORDERBY;
1393 if( rev ){
1394 flags |= WHERE_REVERSE;
1395 }
1396 }else{
1397 cost += cost*estLog(cost);
drh3adc9ce2005-07-28 16:51:51 +00001398 TRACE(("...... orderby increases cost to %.9g\n", cost));
drh51147ba2005-07-23 22:59:55 +00001399 }
drhfe05af82005-07-21 03:14:59 +00001400 }
1401
1402 /* Check to see if we can get away with using just the index without
drh51147ba2005-07-23 22:59:55 +00001403 ** ever reading the table. If that is the case, then halve the
1404 ** cost of this index.
drhfe05af82005-07-21 03:14:59 +00001405 */
drh51147ba2005-07-23 22:59:55 +00001406 if( flags && pSrc->colUsed < (((Bitmask)1)<<(BMS-1)) ){
drhfe05af82005-07-21 03:14:59 +00001407 Bitmask m = pSrc->colUsed;
1408 int j;
1409 for(j=0; j<pProbe->nColumn; j++){
1410 int x = pProbe->aiColumn[j];
1411 if( x<BMS-1 ){
1412 m &= ~(((Bitmask)1)<<x);
1413 }
1414 }
1415 if( m==0 ){
1416 flags |= WHERE_IDX_ONLY;
drhb37df7b2005-10-13 02:09:49 +00001417 cost /= 2;
drh3adc9ce2005-07-28 16:51:51 +00001418 TRACE(("...... idx-only reduces cost to %.9g\n", cost));
drhfe05af82005-07-21 03:14:59 +00001419 }
1420 }
1421
drh51147ba2005-07-23 22:59:55 +00001422 /* If this index has achieved the lowest cost so far, then use it.
drhfe05af82005-07-21 03:14:59 +00001423 */
drh51147ba2005-07-23 22:59:55 +00001424 if( cost < lowestCost ){
drhfe05af82005-07-21 03:14:59 +00001425 bestIdx = pProbe;
drh51147ba2005-07-23 22:59:55 +00001426 lowestCost = cost;
drha6110402005-07-28 20:51:19 +00001427 assert( flags!=0 );
drhfe05af82005-07-21 03:14:59 +00001428 bestFlags = flags;
drh51147ba2005-07-23 22:59:55 +00001429 bestNEq = nEq;
drhfe05af82005-07-21 03:14:59 +00001430 }
1431 }
1432
drhfe05af82005-07-21 03:14:59 +00001433 /* Report the best result
1434 */
1435 *ppIndex = bestIdx;
drh3adc9ce2005-07-28 16:51:51 +00001436 TRACE(("best index is %s, cost=%.9g, flags=%x, nEq=%d\n",
drh51147ba2005-07-23 22:59:55 +00001437 bestIdx ? bestIdx->zName : "(none)", lowestCost, bestFlags, bestNEq));
drhfe05af82005-07-21 03:14:59 +00001438 *pFlags = bestFlags;
drh51147ba2005-07-23 22:59:55 +00001439 *pnEq = bestNEq;
1440 return lowestCost;
drhfe05af82005-07-21 03:14:59 +00001441}
1442
drhb6c29892004-11-22 19:12:19 +00001443
1444/*
drh2ffb1182004-07-19 19:14:01 +00001445** Disable a term in the WHERE clause. Except, do not disable the term
1446** if it controls a LEFT OUTER JOIN and it did not originate in the ON
1447** or USING clause of that join.
1448**
1449** Consider the term t2.z='ok' in the following queries:
1450**
1451** (1) SELECT * FROM t1 LEFT JOIN t2 ON t1.a=t2.x WHERE t2.z='ok'
1452** (2) SELECT * FROM t1 LEFT JOIN t2 ON t1.a=t2.x AND t2.z='ok'
1453** (3) SELECT * FROM t1, t2 WHERE t1.a=t2.x AND t2.z='ok'
1454**
drh23bf66d2004-12-14 03:34:34 +00001455** The t2.z='ok' is disabled in the in (2) because it originates
drh2ffb1182004-07-19 19:14:01 +00001456** in the ON clause. The term is disabled in (3) because it is not part
1457** of a LEFT OUTER JOIN. In (1), the term is not disabled.
1458**
1459** Disabling a term causes that term to not be tested in the inner loop
drhb6fb62d2005-09-20 08:47:20 +00001460** of the join. Disabling is an optimization. When terms are satisfied
1461** by indices, we disable them to prevent redundant tests in the inner
1462** loop. We would get the correct results if nothing were ever disabled,
1463** but joins might run a little slower. The trick is to disable as much
1464** as we can without disabling too much. If we disabled in (1), we'd get
1465** the wrong answer. See ticket #813.
drh2ffb1182004-07-19 19:14:01 +00001466*/
drh0fcef5e2005-07-19 17:38:22 +00001467static void disableTerm(WhereLevel *pLevel, WhereTerm *pTerm){
1468 if( pTerm
1469 && (pTerm->flags & TERM_CODED)==0
1470 && (pLevel->iLeftJoin==0 || ExprHasProperty(pTerm->pExpr, EP_FromJoin))
1471 ){
1472 pTerm->flags |= TERM_CODED;
drh45b1ee42005-08-02 17:48:22 +00001473 if( pTerm->iParent>=0 ){
1474 WhereTerm *pOther = &pTerm->pWC->a[pTerm->iParent];
1475 if( (--pOther->nChild)==0 ){
drhed378002005-07-28 23:12:08 +00001476 disableTerm(pLevel, pOther);
1477 }
drh0fcef5e2005-07-19 17:38:22 +00001478 }
drh2ffb1182004-07-19 19:14:01 +00001479 }
1480}
1481
1482/*
drh94a11212004-09-25 13:12:14 +00001483** Generate code that builds a probe for an index. Details:
1484**
1485** * Check the top nColumn entries on the stack. If any
1486** of those entries are NULL, jump immediately to brk,
1487** which is the loop exit, since no index entry will match
danielk1977327bd592006-01-13 13:01:19 +00001488** if any part of the key is NULL. Pop (nColumn+nExtra)
1489** elements from the stack.
drh94a11212004-09-25 13:12:14 +00001490**
1491** * Construct a probe entry from the top nColumn entries in
danielk1977327bd592006-01-13 13:01:19 +00001492** the stack with affinities appropriate for index pIdx.
1493** Only nColumn elements are popped from the stack in this case
1494** (by OP_MakeRecord).
1495**
drh94a11212004-09-25 13:12:14 +00001496*/
danielk1977327bd592006-01-13 13:01:19 +00001497static void buildIndexProbe(
drh0660e262006-10-27 14:06:57 +00001498 Vdbe *v, /* Generate code into this VM */
1499 int nColumn, /* The number of columns to check for NULL */
1500 int nExtra, /* Number of extra values beyond nColumn */
1501 int brk, /* Jump to here if no match is possible */
1502 Index *pIdx /* Index that we will be searching */
danielk1977327bd592006-01-13 13:01:19 +00001503){
drh94a11212004-09-25 13:12:14 +00001504 sqlite3VdbeAddOp(v, OP_NotNull, -nColumn, sqlite3VdbeCurrentAddr(v)+3);
danielk1977327bd592006-01-13 13:01:19 +00001505 sqlite3VdbeAddOp(v, OP_Pop, nColumn+nExtra, 0);
drh94a11212004-09-25 13:12:14 +00001506 sqlite3VdbeAddOp(v, OP_Goto, 0, brk);
1507 sqlite3VdbeAddOp(v, OP_MakeRecord, nColumn, 0);
1508 sqlite3IndexAffinityStr(v, pIdx);
1509}
1510
drhe8b97272005-07-19 22:22:12 +00001511
1512/*
drh51147ba2005-07-23 22:59:55 +00001513** Generate code for a single equality term of the WHERE clause. An equality
1514** term can be either X=expr or X IN (...). pTerm is the term to be
1515** coded.
1516**
1517** The current value for the constraint is left on the top of the stack.
1518**
1519** For a constraint of the form X=expr, the expression is evaluated and its
1520** result is left on the stack. For constraints of the form X IN (...)
1521** this routine sets up a loop that will iterate over all values of X.
drh94a11212004-09-25 13:12:14 +00001522*/
1523static void codeEqualityTerm(
1524 Parse *pParse, /* The parsing context */
drhe23399f2005-07-22 00:31:39 +00001525 WhereTerm *pTerm, /* The term of the WHERE clause to be coded */
drh94a11212004-09-25 13:12:14 +00001526 int brk, /* Jump here to abandon the loop */
1527 WhereLevel *pLevel /* When level of the FROM clause we are working on */
1528){
drh0fcef5e2005-07-19 17:38:22 +00001529 Expr *pX = pTerm->pExpr;
drh94a11212004-09-25 13:12:14 +00001530 if( pX->op!=TK_IN ){
1531 assert( pX->op==TK_EQ );
1532 sqlite3ExprCode(pParse, pX->pRight);
danielk1977b3bce662005-01-29 08:32:43 +00001533#ifndef SQLITE_OMIT_SUBQUERY
drh94a11212004-09-25 13:12:14 +00001534 }else{
danielk1977b3bce662005-01-29 08:32:43 +00001535 int iTab;
drhe23399f2005-07-22 00:31:39 +00001536 int *aIn;
drh94a11212004-09-25 13:12:14 +00001537 Vdbe *v = pParse->pVdbe;
danielk1977b3bce662005-01-29 08:32:43 +00001538
1539 sqlite3CodeSubselect(pParse, pX);
1540 iTab = pX->iTable;
drhffe0f892006-05-11 13:26:25 +00001541 sqlite3VdbeAddOp(v, OP_Rewind, iTab, 0);
danielk1977b3bce662005-01-29 08:32:43 +00001542 VdbeComment((v, "# %.*s", pX->span.n, pX->span.z));
drhe23399f2005-07-22 00:31:39 +00001543 pLevel->nIn++;
danielk1977e7259292006-01-13 06:33:23 +00001544 sqliteReallocOrFree((void**)&pLevel->aInLoop,
drhffe0f892006-05-11 13:26:25 +00001545 sizeof(pLevel->aInLoop[0])*2*pLevel->nIn);
drh53f733c2005-09-16 02:38:09 +00001546 aIn = pLevel->aInLoop;
drhe23399f2005-07-22 00:31:39 +00001547 if( aIn ){
drhffe0f892006-05-11 13:26:25 +00001548 aIn += pLevel->nIn*2 - 2;
1549 aIn[0] = iTab;
1550 aIn[1] = sqlite3VdbeAddOp(v, OP_Column, iTab, 0);
drha6110402005-07-28 20:51:19 +00001551 }else{
1552 pLevel->nIn = 0;
drhe23399f2005-07-22 00:31:39 +00001553 }
danielk1977b3bce662005-01-29 08:32:43 +00001554#endif
drh94a11212004-09-25 13:12:14 +00001555 }
drh0fcef5e2005-07-19 17:38:22 +00001556 disableTerm(pLevel, pTerm);
drh94a11212004-09-25 13:12:14 +00001557}
1558
drh51147ba2005-07-23 22:59:55 +00001559/*
1560** Generate code that will evaluate all == and IN constraints for an
1561** index. The values for all constraints are left on the stack.
1562**
1563** For example, consider table t1(a,b,c,d,e,f) with index i1(a,b,c).
1564** Suppose the WHERE clause is this: a==5 AND b IN (1,2,3) AND c>5 AND c<10
1565** The index has as many as three equality constraints, but in this
1566** example, the third "c" value is an inequality. So only two
1567** constraints are coded. This routine will generate code to evaluate
1568** a==5 and b IN (1,2,3). The current values for a and b will be left
1569** on the stack - a is the deepest and b the shallowest.
1570**
1571** In the example above nEq==2. But this subroutine works for any value
1572** of nEq including 0. If nEq==0, this routine is nearly a no-op.
1573** The only thing it does is allocate the pLevel->iMem memory cell.
1574**
1575** This routine always allocates at least one memory cell and puts
1576** the address of that memory cell in pLevel->iMem. The code that
1577** calls this routine will use pLevel->iMem to store the termination
1578** key value of the loop. If one or more IN operators appear, then
1579** this routine allocates an additional nEq memory cells for internal
1580** use.
1581*/
1582static void codeAllEqualityTerms(
1583 Parse *pParse, /* Parsing context */
1584 WhereLevel *pLevel, /* Which nested loop of the FROM we are coding */
1585 WhereClause *pWC, /* The WHERE clause */
1586 Bitmask notReady, /* Which parts of FROM have not yet been coded */
1587 int brk /* Jump here to end the loop */
1588){
1589 int nEq = pLevel->nEq; /* The number of == or IN constraints to code */
1590 int termsInMem = 0; /* If true, store value in mem[] cells */
1591 Vdbe *v = pParse->pVdbe; /* The virtual machine under construction */
1592 Index *pIdx = pLevel->pIdx; /* The index being used for this loop */
1593 int iCur = pLevel->iTabCur; /* The cursor of the table */
1594 WhereTerm *pTerm; /* A single constraint term */
1595 int j; /* Loop counter */
1596
1597 /* Figure out how many memory cells we will need then allocate them.
1598 ** We always need at least one used to store the loop terminator
1599 ** value. If there are IN operators we'll need one for each == or
1600 ** IN constraint.
1601 */
1602 pLevel->iMem = pParse->nMem++;
1603 if( pLevel->flags & WHERE_COLUMN_IN ){
1604 pParse->nMem += pLevel->nEq;
1605 termsInMem = 1;
1606 }
1607
1608 /* Evaluate the equality constraints
1609 */
drh8b3d9902005-08-19 00:14:42 +00001610 for(j=0; j<pIdx->nColumn; j++){
drh51147ba2005-07-23 22:59:55 +00001611 int k = pIdx->aiColumn[j];
1612 pTerm = findTerm(pWC, iCur, k, notReady, WO_EQ|WO_IN, pIdx);
1613 if( pTerm==0 ) break;
1614 assert( (pTerm->flags & TERM_CODED)==0 );
1615 codeEqualityTerm(pParse, pTerm, brk, pLevel);
drh0660e262006-10-27 14:06:57 +00001616#if 0 /* WORK IN PROGRESS */
1617 sqlite3VdbeAddOp(v, OP_IsNull, termsInMem ? -1 : -(j+1), brk);
1618#endif
drh51147ba2005-07-23 22:59:55 +00001619 if( termsInMem ){
1620 sqlite3VdbeAddOp(v, OP_MemStore, pLevel->iMem+j+1, 1);
1621 }
1622 }
1623 assert( j==nEq );
1624
1625 /* Make sure all the constraint values are on the top of the stack
1626 */
1627 if( termsInMem ){
1628 for(j=0; j<nEq; j++){
1629 sqlite3VdbeAddOp(v, OP_MemLoad, pLevel->iMem+j+1, 0);
1630 }
1631 }
1632}
1633
drh549c8b62005-09-19 13:15:23 +00001634#if defined(SQLITE_TEST)
drh84bfda42005-07-15 13:05:21 +00001635/*
1636** The following variable holds a text description of query plan generated
1637** by the most recent call to sqlite3WhereBegin(). Each call to WhereBegin
1638** overwrites the previous. This information is used for testing and
1639** analysis only.
1640*/
1641char sqlite3_query_plan[BMS*2*40]; /* Text of the join */
1642static int nQPlan = 0; /* Next free slow in _query_plan[] */
1643
1644#endif /* SQLITE_TEST */
1645
1646
drh9eff6162006-06-12 21:59:13 +00001647/*
1648** Free a WhereInfo structure
1649*/
1650static void whereInfoFree(WhereInfo *pWInfo){
1651 if( pWInfo ){
1652 int i;
1653 for(i=0; i<pWInfo->nLevel; i++){
drh4be8b512006-06-13 23:51:34 +00001654 sqlite3_index_info *pInfo = pWInfo->a[i].pIdxInfo;
1655 if( pInfo ){
1656 if( pInfo->needToFreeIdxStr ){
1657 sqlite3_free(pInfo->idxStr);
1658 }
1659 sqliteFree(pInfo);
danielk1977be8a7832006-06-13 15:00:54 +00001660 }
drh9eff6162006-06-12 21:59:13 +00001661 }
1662 sqliteFree(pWInfo);
1663 }
1664}
1665
drh94a11212004-09-25 13:12:14 +00001666
1667/*
drhe3184742002-06-19 14:27:05 +00001668** Generate the beginning of the loop used for WHERE clause processing.
drhacf3b982005-01-03 01:27:18 +00001669** The return value is a pointer to an opaque structure that contains
drh75897232000-05-29 14:26:00 +00001670** information needed to terminate the loop. Later, the calling routine
danielk19774adee202004-05-08 08:23:19 +00001671** should invoke sqlite3WhereEnd() with the return value of this function
drh75897232000-05-29 14:26:00 +00001672** in order to complete the WHERE clause processing.
1673**
1674** If an error occurs, this routine returns NULL.
drhc27a1ce2002-06-14 20:58:45 +00001675**
1676** The basic idea is to do a nested loop, one loop for each table in
1677** the FROM clause of a select. (INSERT and UPDATE statements are the
1678** same as a SELECT with only a single table in the FROM clause.) For
1679** example, if the SQL is this:
1680**
1681** SELECT * FROM t1, t2, t3 WHERE ...;
1682**
1683** Then the code generated is conceptually like the following:
1684**
1685** foreach row1 in t1 do \ Code generated
danielk19774adee202004-05-08 08:23:19 +00001686** foreach row2 in t2 do |-- by sqlite3WhereBegin()
drhc27a1ce2002-06-14 20:58:45 +00001687** foreach row3 in t3 do /
1688** ...
1689** end \ Code generated
danielk19774adee202004-05-08 08:23:19 +00001690** end |-- by sqlite3WhereEnd()
drhc27a1ce2002-06-14 20:58:45 +00001691** end /
1692**
drh29dda4a2005-07-21 18:23:20 +00001693** Note that the loops might not be nested in the order in which they
1694** appear in the FROM clause if a different order is better able to make
drh51147ba2005-07-23 22:59:55 +00001695** use of indices. Note also that when the IN operator appears in
1696** the WHERE clause, it might result in additional nested loops for
1697** scanning through all values on the right-hand side of the IN.
drh29dda4a2005-07-21 18:23:20 +00001698**
drhc27a1ce2002-06-14 20:58:45 +00001699** There are Btree cursors associated with each table. t1 uses cursor
drh6a3ea0e2003-05-02 14:32:12 +00001700** number pTabList->a[0].iCursor. t2 uses the cursor pTabList->a[1].iCursor.
1701** And so forth. This routine generates code to open those VDBE cursors
danielk19774adee202004-05-08 08:23:19 +00001702** and sqlite3WhereEnd() generates the code to close them.
drhc27a1ce2002-06-14 20:58:45 +00001703**
drhe6f85e72004-12-25 01:03:13 +00001704** The code that sqlite3WhereBegin() generates leaves the cursors named
1705** in pTabList pointing at their appropriate entries. The [...] code
drhf0863fe2005-06-12 21:35:51 +00001706** can use OP_Column and OP_Rowid opcodes on these cursors to extract
drhe6f85e72004-12-25 01:03:13 +00001707** data from the various tables of the loop.
1708**
drhc27a1ce2002-06-14 20:58:45 +00001709** If the WHERE clause is empty, the foreach loops must each scan their
1710** entire tables. Thus a three-way join is an O(N^3) operation. But if
1711** the tables have indices and there are terms in the WHERE clause that
1712** refer to those indices, a complete table scan can be avoided and the
1713** code will run much faster. Most of the work of this routine is checking
1714** to see if there are indices that can be used to speed up the loop.
1715**
1716** Terms of the WHERE clause are also used to limit which rows actually
1717** make it to the "..." in the middle of the loop. After each "foreach",
1718** terms of the WHERE clause that use only terms in that loop and outer
1719** loops are evaluated and if false a jump is made around all subsequent
1720** inner loops (or around the "..." if the test occurs within the inner-
1721** most loop)
1722**
1723** OUTER JOINS
1724**
1725** An outer join of tables t1 and t2 is conceptally coded as follows:
1726**
1727** foreach row1 in t1 do
1728** flag = 0
1729** foreach row2 in t2 do
1730** start:
1731** ...
1732** flag = 1
1733** end
drhe3184742002-06-19 14:27:05 +00001734** if flag==0 then
1735** move the row2 cursor to a null row
1736** goto start
1737** fi
drhc27a1ce2002-06-14 20:58:45 +00001738** end
1739**
drhe3184742002-06-19 14:27:05 +00001740** ORDER BY CLAUSE PROCESSING
1741**
1742** *ppOrderBy is a pointer to the ORDER BY clause of a SELECT statement,
1743** if there is one. If there is no ORDER BY clause or if this routine
1744** is called from an UPDATE or DELETE statement, then ppOrderBy is NULL.
1745**
1746** If an index can be used so that the natural output order of the table
1747** scan is correct for the ORDER BY clause, then that index is used and
1748** *ppOrderBy is set to NULL. This is an optimization that prevents an
1749** unnecessary sort of the result set if an index appropriate for the
1750** ORDER BY clause already exists.
1751**
1752** If the where clause loops cannot be arranged to provide the correct
1753** output order, then the *ppOrderBy is unchanged.
drh75897232000-05-29 14:26:00 +00001754*/
danielk19774adee202004-05-08 08:23:19 +00001755WhereInfo *sqlite3WhereBegin(
danielk1977ed326d72004-11-16 15:50:19 +00001756 Parse *pParse, /* The parser context */
1757 SrcList *pTabList, /* A list of all tables to be scanned */
1758 Expr *pWhere, /* The WHERE clause */
drhf8db1bc2005-04-22 02:38:37 +00001759 ExprList **ppOrderBy /* An ORDER BY clause, or NULL */
drh75897232000-05-29 14:26:00 +00001760){
1761 int i; /* Loop counter */
1762 WhereInfo *pWInfo; /* Will become the return value of this function */
1763 Vdbe *v = pParse->pVdbe; /* The virtual database engine */
drhd4f5ee22003-07-16 00:54:31 +00001764 int brk, cont = 0; /* Addresses used during code generation */
drhfe05af82005-07-21 03:14:59 +00001765 Bitmask notReady; /* Cursors that are not yet positioned */
drh0aa74ed2005-07-16 13:33:20 +00001766 WhereTerm *pTerm; /* A single term in the WHERE clause */
1767 ExprMaskSet maskSet; /* The expression mask set */
drh0aa74ed2005-07-16 13:33:20 +00001768 WhereClause wc; /* The WHERE clause is divided into these terms */
drh9012bcb2004-12-19 00:11:35 +00001769 struct SrcList_item *pTabItem; /* A single entry from pTabList */
1770 WhereLevel *pLevel; /* A single level in the pWInfo list */
drh29dda4a2005-07-21 18:23:20 +00001771 int iFrom; /* First unused FROM clause element */
drh943af3c2005-07-29 19:43:58 +00001772 int andFlags; /* AND-ed combination of all wc.a[].flags */
drh75897232000-05-29 14:26:00 +00001773
drh29dda4a2005-07-21 18:23:20 +00001774 /* The number of tables in the FROM clause is limited by the number of
drh1398ad32005-01-19 23:24:50 +00001775 ** bits in a Bitmask
1776 */
drh29dda4a2005-07-21 18:23:20 +00001777 if( pTabList->nSrc>BMS ){
1778 sqlite3ErrorMsg(pParse, "at most %d tables in a join", BMS);
drh1398ad32005-01-19 23:24:50 +00001779 return 0;
1780 }
1781
drh83dcb1a2002-06-28 01:02:38 +00001782 /* Split the WHERE clause into separate subexpressions where each
drh29dda4a2005-07-21 18:23:20 +00001783 ** subexpression is separated by an AND operator.
drh83dcb1a2002-06-28 01:02:38 +00001784 */
drh6a3ea0e2003-05-02 14:32:12 +00001785 initMaskSet(&maskSet);
drhfe05af82005-07-21 03:14:59 +00001786 whereClauseInit(&wc, pParse);
drh6c30be82005-07-29 15:10:17 +00001787 whereSplit(&wc, pWhere, TK_AND);
drh1398ad32005-01-19 23:24:50 +00001788
drh75897232000-05-29 14:26:00 +00001789 /* Allocate and initialize the WhereInfo structure that will become the
1790 ** return value.
1791 */
drhad3cab52002-05-24 02:04:32 +00001792 pWInfo = sqliteMalloc( sizeof(WhereInfo) + pTabList->nSrc*sizeof(WhereLevel));
danielk19779e128002006-01-18 16:51:35 +00001793 if( sqlite3MallocFailed() ){
drhe23399f2005-07-22 00:31:39 +00001794 goto whereBeginNoMem;
drh75897232000-05-29 14:26:00 +00001795 }
danielk197770b6d572006-06-19 04:49:34 +00001796 pWInfo->nLevel = pTabList->nSrc;
drh75897232000-05-29 14:26:00 +00001797 pWInfo->pParse = pParse;
1798 pWInfo->pTabList = pTabList;
danielk19774adee202004-05-08 08:23:19 +00001799 pWInfo->iBreak = sqlite3VdbeMakeLabel(v);
drh08192d52002-04-30 19:20:28 +00001800
1801 /* Special case: a WHERE clause that is constant. Evaluate the
1802 ** expression and either jump over all of the code or fall thru.
1803 */
danielk19774adee202004-05-08 08:23:19 +00001804 if( pWhere && (pTabList->nSrc==0 || sqlite3ExprIsConstant(pWhere)) ){
1805 sqlite3ExprIfFalse(pParse, pWhere, pWInfo->iBreak, 1);
drhdf199a22002-06-14 22:38:41 +00001806 pWhere = 0;
drh08192d52002-04-30 19:20:28 +00001807 }
drh75897232000-05-29 14:26:00 +00001808
drh29dda4a2005-07-21 18:23:20 +00001809 /* Analyze all of the subexpressions. Note that exprAnalyze() might
1810 ** add new virtual terms onto the end of the WHERE clause. We do not
1811 ** want to analyze these virtual terms, so start analyzing at the end
drhb6fb62d2005-09-20 08:47:20 +00001812 ** and work forward so that the added virtual terms are never processed.
drh75897232000-05-29 14:26:00 +00001813 */
drh1398ad32005-01-19 23:24:50 +00001814 for(i=0; i<pTabList->nSrc; i++){
1815 createMask(&maskSet, pTabList->a[i].iCursor);
1816 }
drh6c30be82005-07-29 15:10:17 +00001817 exprAnalyzeAll(pTabList, &maskSet, &wc);
danielk19779e128002006-01-18 16:51:35 +00001818 if( sqlite3MallocFailed() ){
drh0bbaa1b2005-08-19 19:14:12 +00001819 goto whereBeginNoMem;
1820 }
drh75897232000-05-29 14:26:00 +00001821
drh29dda4a2005-07-21 18:23:20 +00001822 /* Chose the best index to use for each table in the FROM clause.
1823 **
drh51147ba2005-07-23 22:59:55 +00001824 ** This loop fills in the following fields:
1825 **
1826 ** pWInfo->a[].pIdx The index to use for this level of the loop.
1827 ** pWInfo->a[].flags WHERE_xxx flags associated with pIdx
1828 ** pWInfo->a[].nEq The number of == and IN constraints
1829 ** pWInfo->a[].iFrom When term of the FROM clause is being coded
1830 ** pWInfo->a[].iTabCur The VDBE cursor for the database table
1831 ** pWInfo->a[].iIdxCur The VDBE cursor for the index
1832 **
1833 ** This loop also figures out the nesting order of tables in the FROM
1834 ** clause.
drh75897232000-05-29 14:26:00 +00001835 */
drhfe05af82005-07-21 03:14:59 +00001836 notReady = ~(Bitmask)0;
drh9012bcb2004-12-19 00:11:35 +00001837 pTabItem = pTabList->a;
1838 pLevel = pWInfo->a;
drh943af3c2005-07-29 19:43:58 +00001839 andFlags = ~0;
drh3dec2232005-09-10 15:28:09 +00001840 TRACE(("*** Optimizer Start ***\n"));
drh29dda4a2005-07-21 18:23:20 +00001841 for(i=iFrom=0, pLevel=pWInfo->a; i<pTabList->nSrc; i++, pLevel++){
1842 Index *pIdx; /* Index for FROM table at pTabItem */
1843 int flags; /* Flags asssociated with pIdx */
drh51147ba2005-07-23 22:59:55 +00001844 int nEq; /* Number of == or IN constraints */
1845 double cost; /* The cost for pIdx */
drh29dda4a2005-07-21 18:23:20 +00001846 int j; /* For looping over FROM tables */
1847 Index *pBest = 0; /* The best index seen so far */
1848 int bestFlags = 0; /* Flags associated with pBest */
drh51147ba2005-07-23 22:59:55 +00001849 int bestNEq = 0; /* nEq associated with pBest */
drhb37df7b2005-10-13 02:09:49 +00001850 double lowestCost; /* Cost of the pBest */
drh02afc862006-01-20 18:10:57 +00001851 int bestJ = 0; /* The value of j */
drh29dda4a2005-07-21 18:23:20 +00001852 Bitmask m; /* Bitmask value for j or bestJ */
drh570b9352006-02-01 02:45:02 +00001853 int once = 0; /* True when first table is seen */
drh6d209d82006-06-27 01:54:26 +00001854 sqlite3_index_info *pIndex; /* Current virtual index */
drh29dda4a2005-07-21 18:23:20 +00001855
drhb37df7b2005-10-13 02:09:49 +00001856 lowestCost = SQLITE_BIG_DBL;
drh29dda4a2005-07-21 18:23:20 +00001857 for(j=iFrom, pTabItem=&pTabList->a[j]; j<pTabList->nSrc; j++, pTabItem++){
drhdf26fd52006-06-06 11:45:54 +00001858 int doNotReorder; /* True if this table should not be reordered */
1859
1860 doNotReorder = (pTabItem->jointype & (JT_LEFT|JT_CROSS))!=0
1861 || (j>0 && (pTabItem[-1].jointype & (JT_LEFT|JT_CROSS))!=0);
1862 if( once && doNotReorder ) break;
drh29dda4a2005-07-21 18:23:20 +00001863 m = getMask(&maskSet, pTabItem->iCursor);
1864 if( (m & notReady)==0 ){
1865 if( j==iFrom ) iFrom++;
1866 continue;
1867 }
drh9eff6162006-06-12 21:59:13 +00001868 assert( pTabItem->pTab );
1869#ifndef SQLITE_OMIT_VIRTUALTABLE
drh4cbdda92006-06-14 19:00:20 +00001870 if( IsVirtual(pTabItem->pTab) ){
drh6d209d82006-06-27 01:54:26 +00001871 sqlite3_index_info **ppIdxInfo = &pWInfo->a[j].pIdxInfo;
drh9eff6162006-06-12 21:59:13 +00001872 cost = bestVirtualIndex(pParse, &wc, pTabItem, notReady,
1873 ppOrderBy ? *ppOrderBy : 0, i==0,
drh6d209d82006-06-27 01:54:26 +00001874 ppIdxInfo);
drh9eff6162006-06-12 21:59:13 +00001875 flags = WHERE_VIRTUALTABLE;
drh6d209d82006-06-27 01:54:26 +00001876 pIndex = *ppIdxInfo;
danielk197793626f42006-06-20 13:07:27 +00001877 if( pIndex && pIndex->orderByConsumed ){
drh1a90e092006-06-14 22:07:10 +00001878 flags = WHERE_VIRTUALTABLE | WHERE_ORDERBY;
1879 }
drh9eff6162006-06-12 21:59:13 +00001880 pIdx = 0;
1881 nEq = 0;
1882 }else
1883#endif
1884 {
1885 cost = bestIndex(pParse, &wc, pTabItem, notReady,
1886 (i==0 && ppOrderBy) ? *ppOrderBy : 0,
1887 &pIdx, &flags, &nEq);
drh9861a9f2006-06-27 02:33:40 +00001888 pIndex = 0;
drh9eff6162006-06-12 21:59:13 +00001889 }
drh51147ba2005-07-23 22:59:55 +00001890 if( cost<lowestCost ){
drh570b9352006-02-01 02:45:02 +00001891 once = 1;
drh51147ba2005-07-23 22:59:55 +00001892 lowestCost = cost;
drh29dda4a2005-07-21 18:23:20 +00001893 pBest = pIdx;
1894 bestFlags = flags;
drh51147ba2005-07-23 22:59:55 +00001895 bestNEq = nEq;
drh29dda4a2005-07-21 18:23:20 +00001896 bestJ = j;
drh6d209d82006-06-27 01:54:26 +00001897 pLevel->pBestIdx = pIndex;
drh29dda4a2005-07-21 18:23:20 +00001898 }
drhdf26fd52006-06-06 11:45:54 +00001899 if( doNotReorder ) break;
drh29dda4a2005-07-21 18:23:20 +00001900 }
drh3dec2232005-09-10 15:28:09 +00001901 TRACE(("*** Optimizer choose table %d for loop %d\n", bestJ,
1902 pLevel-pWInfo->a));
drh943af3c2005-07-29 19:43:58 +00001903 if( (bestFlags & WHERE_ORDERBY)!=0 ){
drhfe05af82005-07-21 03:14:59 +00001904 *ppOrderBy = 0;
drhc4a3c772001-04-04 11:48:57 +00001905 }
drh943af3c2005-07-29 19:43:58 +00001906 andFlags &= bestFlags;
drh29dda4a2005-07-21 18:23:20 +00001907 pLevel->flags = bestFlags;
drhfe05af82005-07-21 03:14:59 +00001908 pLevel->pIdx = pBest;
drh51147ba2005-07-23 22:59:55 +00001909 pLevel->nEq = bestNEq;
drhe23399f2005-07-22 00:31:39 +00001910 pLevel->aInLoop = 0;
1911 pLevel->nIn = 0;
drhfe05af82005-07-21 03:14:59 +00001912 if( pBest ){
drh9012bcb2004-12-19 00:11:35 +00001913 pLevel->iIdxCur = pParse->nTab++;
drhfe05af82005-07-21 03:14:59 +00001914 }else{
1915 pLevel->iIdxCur = -1;
drh6b563442001-11-07 16:48:26 +00001916 }
drh29dda4a2005-07-21 18:23:20 +00001917 notReady &= ~getMask(&maskSet, pTabList->a[bestJ].iCursor);
1918 pLevel->iFrom = bestJ;
drh75897232000-05-29 14:26:00 +00001919 }
drh3dec2232005-09-10 15:28:09 +00001920 TRACE(("*** Optimizer Finished ***\n"));
drh75897232000-05-29 14:26:00 +00001921
drh943af3c2005-07-29 19:43:58 +00001922 /* If the total query only selects a single row, then the ORDER BY
1923 ** clause is irrelevant.
1924 */
1925 if( (andFlags & WHERE_UNIQUE)!=0 && ppOrderBy ){
1926 *ppOrderBy = 0;
1927 }
1928
drh9012bcb2004-12-19 00:11:35 +00001929 /* Open all tables in the pTabList and any indices selected for
1930 ** searching those tables.
1931 */
1932 sqlite3CodeVerifySchema(pParse, -1); /* Insert the cookie verifier Goto */
drh29dda4a2005-07-21 18:23:20 +00001933 for(i=0, pLevel=pWInfo->a; i<pTabList->nSrc; i++, pLevel++){
danielk1977da184232006-01-05 11:34:32 +00001934 Table *pTab; /* Table to open */
1935 Index *pIx; /* Index used to access pTab (if any) */
1936 int iDb; /* Index of database containing table/index */
drh9012bcb2004-12-19 00:11:35 +00001937 int iIdxCur = pLevel->iIdxCur;
1938
drhecc92422005-09-10 16:46:12 +00001939#ifndef SQLITE_OMIT_EXPLAIN
1940 if( pParse->explain==2 ){
1941 char *zMsg;
1942 struct SrcList_item *pItem = &pTabList->a[pLevel->iFrom];
1943 zMsg = sqlite3MPrintf("TABLE %s", pItem->zName);
1944 if( pItem->zAlias ){
1945 zMsg = sqlite3MPrintf("%z AS %s", zMsg, pItem->zAlias);
1946 }
1947 if( (pIx = pLevel->pIdx)!=0 ){
1948 zMsg = sqlite3MPrintf("%z WITH INDEX %s", zMsg, pIx->zName);
drh36d64932005-11-21 12:46:27 +00001949 }else if( pLevel->flags & (WHERE_ROWID_EQ|WHERE_ROWID_RANGE) ){
drh32daab62005-11-21 12:48:24 +00001950 zMsg = sqlite3MPrintf("%z USING PRIMARY KEY", zMsg);
drhecc92422005-09-10 16:46:12 +00001951 }
drh9eff6162006-06-12 21:59:13 +00001952#ifndef SQLITE_OMIT_VIRTUALTABLE
drh6d209d82006-06-27 01:54:26 +00001953 else if( pLevel->pBestIdx ){
1954 sqlite3_index_info *pBestIdx = pLevel->pBestIdx;
danielk197765fd59f2006-06-24 11:51:33 +00001955 zMsg = sqlite3MPrintf("%z VIRTUAL TABLE INDEX %d:%s", zMsg,
drh6d209d82006-06-27 01:54:26 +00001956 pBestIdx->idxNum, pBestIdx->idxStr);
drh9eff6162006-06-12 21:59:13 +00001957 }
1958#endif
drhe2b39092006-04-21 09:38:36 +00001959 if( pLevel->flags & WHERE_ORDERBY ){
1960 zMsg = sqlite3MPrintf("%z ORDER BY", zMsg);
1961 }
drhecc92422005-09-10 16:46:12 +00001962 sqlite3VdbeOp3(v, OP_Explain, i, pLevel->iFrom, zMsg, P3_DYNAMIC);
1963 }
1964#endif /* SQLITE_OMIT_EXPLAIN */
drh29dda4a2005-07-21 18:23:20 +00001965 pTabItem = &pTabList->a[pLevel->iFrom];
drh9012bcb2004-12-19 00:11:35 +00001966 pTab = pTabItem->pTab;
danielk1977da184232006-01-05 11:34:32 +00001967 iDb = sqlite3SchemaToIndex(pParse->db, pTab->pSchema);
drhb9bb7c12006-06-11 23:41:55 +00001968 if( pTab->isEphem || pTab->pSelect ) continue;
drh9eff6162006-06-12 21:59:13 +00001969#ifndef SQLITE_OMIT_VIRTUALTABLE
drh6d209d82006-06-27 01:54:26 +00001970 if( pLevel->pBestIdx ){
danielk197793626f42006-06-20 13:07:27 +00001971 int iCur = pTabItem->iCursor;
1972 sqlite3VdbeOp3(v, OP_VOpen, iCur, 0, (const char*)pTab->pVtab, P3_VTAB);
drh9eff6162006-06-12 21:59:13 +00001973 }else
1974#endif
drhfe05af82005-07-21 03:14:59 +00001975 if( (pLevel->flags & WHERE_IDX_ONLY)==0 ){
danielk1977c00da102006-01-07 13:21:04 +00001976 sqlite3OpenTable(pParse, pTabItem->iCursor, iDb, pTab, OP_OpenRead);
danielk19779792eef2006-01-13 15:58:43 +00001977 if( pTab->nCol<(sizeof(Bitmask)*8) ){
1978 Bitmask b = pTabItem->colUsed;
1979 int n = 0;
drh74161702006-02-24 02:53:49 +00001980 for(; b; b=b>>1, n++){}
danielk19779792eef2006-01-13 15:58:43 +00001981 sqlite3VdbeChangeP2(v, sqlite3VdbeCurrentAddr(v)-1, n);
1982 assert( n<=pTab->nCol );
1983 }
danielk1977c00da102006-01-07 13:21:04 +00001984 }else{
1985 sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
drh9012bcb2004-12-19 00:11:35 +00001986 }
1987 pLevel->iTabCur = pTabItem->iCursor;
1988 if( (pIx = pLevel->pIdx)!=0 ){
danielk1977b3bf5562006-01-10 17:58:23 +00001989 KeyInfo *pKey = sqlite3IndexKeyinfo(pParse, pIx);
danielk1977da184232006-01-05 11:34:32 +00001990 assert( pIx->pSchema==pTab->pSchema );
1991 sqlite3VdbeAddOp(v, OP_Integer, iDb, 0);
drh29dda4a2005-07-21 18:23:20 +00001992 VdbeComment((v, "# %s", pIx->zName));
drh9012bcb2004-12-19 00:11:35 +00001993 sqlite3VdbeOp3(v, OP_OpenRead, iIdxCur, pIx->tnum,
danielk1977b3bf5562006-01-10 17:58:23 +00001994 (char*)pKey, P3_KEYINFO_HANDOFF);
drh9012bcb2004-12-19 00:11:35 +00001995 }
drhfe05af82005-07-21 03:14:59 +00001996 if( (pLevel->flags & WHERE_IDX_ONLY)!=0 ){
drh9012bcb2004-12-19 00:11:35 +00001997 sqlite3VdbeAddOp(v, OP_SetNumColumns, iIdxCur, pIx->nColumn+1);
1998 }
danielk1977da184232006-01-05 11:34:32 +00001999 sqlite3CodeVerifySchema(pParse, iDb);
drh9012bcb2004-12-19 00:11:35 +00002000 }
2001 pWInfo->iTop = sqlite3VdbeCurrentAddr(v);
2002
drh29dda4a2005-07-21 18:23:20 +00002003 /* Generate the code to do the search. Each iteration of the for
2004 ** loop below generates code for a single nested loop of the VM
2005 ** program.
drh75897232000-05-29 14:26:00 +00002006 */
drhfe05af82005-07-21 03:14:59 +00002007 notReady = ~(Bitmask)0;
drh29dda4a2005-07-21 18:23:20 +00002008 for(i=0, pLevel=pWInfo->a; i<pTabList->nSrc; i++, pLevel++){
drhfe05af82005-07-21 03:14:59 +00002009 int j;
drh9012bcb2004-12-19 00:11:35 +00002010 int iCur = pTabItem->iCursor; /* The VDBE cursor for the table */
2011 Index *pIdx; /* The index we will be using */
2012 int iIdxCur; /* The VDBE cursor for the index */
2013 int omitTable; /* True if we use the index only */
drh29dda4a2005-07-21 18:23:20 +00002014 int bRev; /* True if we need to scan in reverse order */
drh9012bcb2004-12-19 00:11:35 +00002015
drh29dda4a2005-07-21 18:23:20 +00002016 pTabItem = &pTabList->a[pLevel->iFrom];
2017 iCur = pTabItem->iCursor;
drh9012bcb2004-12-19 00:11:35 +00002018 pIdx = pLevel->pIdx;
2019 iIdxCur = pLevel->iIdxCur;
drh29dda4a2005-07-21 18:23:20 +00002020 bRev = (pLevel->flags & WHERE_REVERSE)!=0;
drhfe05af82005-07-21 03:14:59 +00002021 omitTable = (pLevel->flags & WHERE_IDX_ONLY)!=0;
drh75897232000-05-29 14:26:00 +00002022
drh29dda4a2005-07-21 18:23:20 +00002023 /* Create labels for the "break" and "continue" instructions
2024 ** for the current loop. Jump to brk to break out of a loop.
2025 ** Jump to cont to go immediately to the next iteration of the
2026 ** loop.
2027 */
2028 brk = pLevel->brk = sqlite3VdbeMakeLabel(v);
2029 cont = pLevel->cont = sqlite3VdbeMakeLabel(v);
2030
drhad2d8302002-05-24 20:31:36 +00002031 /* If this is the right table of a LEFT OUTER JOIN, allocate and
drh174b6192002-12-03 02:22:52 +00002032 ** initialize a memory cell that records if this table matches any
drhc27a1ce2002-06-14 20:58:45 +00002033 ** row of the left table of the join.
drhad2d8302002-05-24 20:31:36 +00002034 */
drh29dda4a2005-07-21 18:23:20 +00002035 if( pLevel->iFrom>0 && (pTabItem[-1].jointype & JT_LEFT)!=0 ){
drhad2d8302002-05-24 20:31:36 +00002036 if( !pParse->nMem ) pParse->nMem++;
2037 pLevel->iLeftJoin = pParse->nMem++;
drhd654be82005-09-20 17:42:23 +00002038 sqlite3VdbeAddOp(v, OP_MemInt, 0, pLevel->iLeftJoin);
drhad6d9462004-09-19 02:15:24 +00002039 VdbeComment((v, "# init LEFT JOIN no-match flag"));
drhad2d8302002-05-24 20:31:36 +00002040 }
2041
drh9eff6162006-06-12 21:59:13 +00002042#ifndef SQLITE_OMIT_VIRTUALTABLE
drh6d209d82006-06-27 01:54:26 +00002043 if( pLevel->pBestIdx ){
drh7f375902006-06-13 17:38:59 +00002044 /* Case 0: The table is a virtual-table. Use the VFilter and VNext
2045 ** to access the data.
2046 */
drh9861a9f2006-06-27 02:33:40 +00002047 int j;
drh6d209d82006-06-27 01:54:26 +00002048 sqlite3_index_info *pBestIdx = pLevel->pBestIdx;
2049 int nConstraint = pBestIdx->nConstraint;
drh4be8b512006-06-13 23:51:34 +00002050 struct sqlite3_index_constraint_usage *aUsage =
drh6d209d82006-06-27 01:54:26 +00002051 pBestIdx->aConstraintUsage;
drh4be8b512006-06-13 23:51:34 +00002052 const struct sqlite3_index_constraint *aConstraint =
drh6d209d82006-06-27 01:54:26 +00002053 pBestIdx->aConstraint;
drh4be8b512006-06-13 23:51:34 +00002054
drh9861a9f2006-06-27 02:33:40 +00002055 for(j=1; j<=nConstraint; j++){
2056 int k;
2057 for(k=0; k<nConstraint; k++){
2058 if( aUsage[k].argvIndex==j ){
danielk19773851a652006-06-27 12:16:56 +00002059 int iTerm = aConstraint[k].iTermOffset;
drh9861a9f2006-06-27 02:33:40 +00002060 sqlite3ExprCode(pParse, wc.a[iTerm].pExpr->pRight);
drh9eff6162006-06-12 21:59:13 +00002061 break;
2062 }
2063 }
drh9861a9f2006-06-27 02:33:40 +00002064 if( k==nConstraint ) break;
drh9eff6162006-06-12 21:59:13 +00002065 }
drh9861a9f2006-06-27 02:33:40 +00002066 sqlite3VdbeAddOp(v, OP_Integer, j-1, 0);
drh6d209d82006-06-27 01:54:26 +00002067 sqlite3VdbeAddOp(v, OP_Integer, pBestIdx->idxNum, 0);
2068 sqlite3VdbeOp3(v, OP_VFilter, iCur, brk, pBestIdx->idxStr,
2069 pBestIdx->needToFreeIdxStr ? P3_MPRINTF : P3_STATIC);
2070 pBestIdx->needToFreeIdxStr = 0;
drh9861a9f2006-06-27 02:33:40 +00002071 for(j=0; j<pBestIdx->nConstraint; j++){
2072 if( aUsage[j].omit ){
2073 int iTerm = aConstraint[j].iTermOffset;
2074 disableTerm(pLevel, &wc.a[iTerm]);
drh9eff6162006-06-12 21:59:13 +00002075 }
2076 }
2077 pLevel->op = OP_VNext;
drha967e882006-06-13 01:04:52 +00002078 pLevel->p1 = iCur;
2079 pLevel->p2 = sqlite3VdbeCurrentAddr(v);
drh9eff6162006-06-12 21:59:13 +00002080 }else
2081#endif /* SQLITE_OMIT_VIRTUALTABLE */
2082
drhfe05af82005-07-21 03:14:59 +00002083 if( pLevel->flags & WHERE_ROWID_EQ ){
drh8aff1012001-12-22 14:49:24 +00002084 /* Case 1: We can directly reference a single row using an
drhc27a1ce2002-06-14 20:58:45 +00002085 ** equality comparison against the ROWID field. Or
2086 ** we reference multiple rows using a "rowid IN (...)"
2087 ** construct.
drhc4a3c772001-04-04 11:48:57 +00002088 */
drhfe05af82005-07-21 03:14:59 +00002089 pTerm = findTerm(&wc, iCur, -1, notReady, WO_EQ|WO_IN, 0);
2090 assert( pTerm!=0 );
drh0fcef5e2005-07-19 17:38:22 +00002091 assert( pTerm->pExpr!=0 );
2092 assert( pTerm->leftCursor==iCur );
drh9012bcb2004-12-19 00:11:35 +00002093 assert( omitTable==0 );
drh94a11212004-09-25 13:12:14 +00002094 codeEqualityTerm(pParse, pTerm, brk, pLevel);
danielk19774adee202004-05-08 08:23:19 +00002095 sqlite3VdbeAddOp(v, OP_MustBeInt, 1, brk);
danielk19774adee202004-05-08 08:23:19 +00002096 sqlite3VdbeAddOp(v, OP_NotExists, iCur, brk);
tpoindex7a9b1612005-01-03 18:13:18 +00002097 VdbeComment((v, "pk"));
drh6b563442001-11-07 16:48:26 +00002098 pLevel->op = OP_Noop;
drhfe05af82005-07-21 03:14:59 +00002099 }else if( pLevel->flags & WHERE_ROWID_RANGE ){
drh51147ba2005-07-23 22:59:55 +00002100 /* Case 2: We have an inequality comparison against the ROWID field.
drh8aff1012001-12-22 14:49:24 +00002101 */
2102 int testOp = OP_Noop;
2103 int start;
drhfe05af82005-07-21 03:14:59 +00002104 WhereTerm *pStart, *pEnd;
drh8aff1012001-12-22 14:49:24 +00002105
drh9012bcb2004-12-19 00:11:35 +00002106 assert( omitTable==0 );
drha6110402005-07-28 20:51:19 +00002107 pStart = findTerm(&wc, iCur, -1, notReady, WO_GT|WO_GE, 0);
2108 pEnd = findTerm(&wc, iCur, -1, notReady, WO_LT|WO_LE, 0);
drhfe05af82005-07-21 03:14:59 +00002109 if( bRev ){
2110 pTerm = pStart;
2111 pStart = pEnd;
2112 pEnd = pTerm;
2113 }
2114 if( pStart ){
drh94a11212004-09-25 13:12:14 +00002115 Expr *pX;
drhfe05af82005-07-21 03:14:59 +00002116 pX = pStart->pExpr;
drh94a11212004-09-25 13:12:14 +00002117 assert( pX!=0 );
drhfe05af82005-07-21 03:14:59 +00002118 assert( pStart->leftCursor==iCur );
drh94a11212004-09-25 13:12:14 +00002119 sqlite3ExprCode(pParse, pX->pRight);
danielk1977d0a69322005-02-02 01:10:44 +00002120 sqlite3VdbeAddOp(v, OP_ForceInt, pX->op==TK_LE || pX->op==TK_GT, brk);
drhb6c29892004-11-22 19:12:19 +00002121 sqlite3VdbeAddOp(v, bRev ? OP_MoveLt : OP_MoveGe, iCur, brk);
tpoindex7a9b1612005-01-03 18:13:18 +00002122 VdbeComment((v, "pk"));
drhfe05af82005-07-21 03:14:59 +00002123 disableTerm(pLevel, pStart);
drh8aff1012001-12-22 14:49:24 +00002124 }else{
drhb6c29892004-11-22 19:12:19 +00002125 sqlite3VdbeAddOp(v, bRev ? OP_Last : OP_Rewind, iCur, brk);
drh8aff1012001-12-22 14:49:24 +00002126 }
drhfe05af82005-07-21 03:14:59 +00002127 if( pEnd ){
drh94a11212004-09-25 13:12:14 +00002128 Expr *pX;
drhfe05af82005-07-21 03:14:59 +00002129 pX = pEnd->pExpr;
drh94a11212004-09-25 13:12:14 +00002130 assert( pX!=0 );
drhfe05af82005-07-21 03:14:59 +00002131 assert( pEnd->leftCursor==iCur );
drh94a11212004-09-25 13:12:14 +00002132 sqlite3ExprCode(pParse, pX->pRight);
drh8aff1012001-12-22 14:49:24 +00002133 pLevel->iMem = pParse->nMem++;
danielk19774adee202004-05-08 08:23:19 +00002134 sqlite3VdbeAddOp(v, OP_MemStore, pLevel->iMem, 1);
drh94a11212004-09-25 13:12:14 +00002135 if( pX->op==TK_LT || pX->op==TK_GT ){
drhb6c29892004-11-22 19:12:19 +00002136 testOp = bRev ? OP_Le : OP_Ge;
drh8aff1012001-12-22 14:49:24 +00002137 }else{
drhb6c29892004-11-22 19:12:19 +00002138 testOp = bRev ? OP_Lt : OP_Gt;
drh8aff1012001-12-22 14:49:24 +00002139 }
drhfe05af82005-07-21 03:14:59 +00002140 disableTerm(pLevel, pEnd);
drh8aff1012001-12-22 14:49:24 +00002141 }
danielk19774adee202004-05-08 08:23:19 +00002142 start = sqlite3VdbeCurrentAddr(v);
drhb6c29892004-11-22 19:12:19 +00002143 pLevel->op = bRev ? OP_Prev : OP_Next;
drh6a3ea0e2003-05-02 14:32:12 +00002144 pLevel->p1 = iCur;
drh8aff1012001-12-22 14:49:24 +00002145 pLevel->p2 = start;
2146 if( testOp!=OP_Noop ){
drhf0863fe2005-06-12 21:35:51 +00002147 sqlite3VdbeAddOp(v, OP_Rowid, iCur, 0);
danielk19774adee202004-05-08 08:23:19 +00002148 sqlite3VdbeAddOp(v, OP_MemLoad, pLevel->iMem, 0);
drh8a512562005-11-14 22:29:05 +00002149 sqlite3VdbeAddOp(v, testOp, SQLITE_AFF_NUMERIC, brk);
drh8aff1012001-12-22 14:49:24 +00002150 }
drhfe05af82005-07-21 03:14:59 +00002151 }else if( pLevel->flags & WHERE_COLUMN_RANGE ){
drh51147ba2005-07-23 22:59:55 +00002152 /* Case 3: The WHERE clause term that refers to the right-most
drhc27a1ce2002-06-14 20:58:45 +00002153 ** column of the index is an inequality. For example, if
2154 ** the index is on (x,y,z) and the WHERE clause is of the
2155 ** form "x=5 AND y<10" then this case is used. Only the
2156 ** right-most column can be an inequality - the rest must
drh51147ba2005-07-23 22:59:55 +00002157 ** use the "==" and "IN" operators.
drhe3184742002-06-19 14:27:05 +00002158 **
2159 ** This case is also used when there are no WHERE clause
2160 ** constraints but an index is selected anyway, in order
2161 ** to force the output order to conform to an ORDER BY.
drh487ab3c2001-11-08 00:45:21 +00002162 */
drh487ab3c2001-11-08 00:45:21 +00002163 int start;
drh51147ba2005-07-23 22:59:55 +00002164 int nEq = pLevel->nEq;
drh85eeb692005-12-21 03:16:42 +00002165 int topEq=0; /* True if top limit uses ==. False is strictly < */
2166 int btmEq=0; /* True if btm limit uses ==. False if strictly > */
2167 int topOp, btmOp; /* Operators for the top and bottom search bounds */
drh487ab3c2001-11-08 00:45:21 +00002168 int testOp;
drh0b2f3162005-12-21 18:36:45 +00002169 int nNotNull; /* Number of rows of index that must be non-NULL */
drhfe05af82005-07-21 03:14:59 +00002170 int topLimit = (pLevel->flags & WHERE_TOP_LIMIT)!=0;
2171 int btmLimit = (pLevel->flags & WHERE_BTM_LIMIT)!=0;
drh487ab3c2001-11-08 00:45:21 +00002172
drh51147ba2005-07-23 22:59:55 +00002173 /* Generate code to evaluate all constraint terms using == or IN
2174 ** and level the values of those terms on the stack.
drh487ab3c2001-11-08 00:45:21 +00002175 */
drh51147ba2005-07-23 22:59:55 +00002176 codeAllEqualityTerms(pParse, pLevel, &wc, notReady, brk);
drh487ab3c2001-11-08 00:45:21 +00002177
drhc27a1ce2002-06-14 20:58:45 +00002178 /* Duplicate the equality term values because they will all be
drh487ab3c2001-11-08 00:45:21 +00002179 ** used twice: once to make the termination key and once to make the
2180 ** start key.
2181 */
drh51147ba2005-07-23 22:59:55 +00002182 for(j=0; j<nEq; j++){
2183 sqlite3VdbeAddOp(v, OP_Dup, nEq-1, 0);
drh487ab3c2001-11-08 00:45:21 +00002184 }
2185
drh85eeb692005-12-21 03:16:42 +00002186 /* Figure out what comparison operators to use for top and bottom
2187 ** search bounds. For an ascending index, the bottom bound is a > or >=
2188 ** operator and the top bound is a < or <= operator. For a descending
2189 ** index the operators are reversed.
2190 */
drh0b2f3162005-12-21 18:36:45 +00002191 nNotNull = nEq + topLimit;
danielk1977b3bf5562006-01-10 17:58:23 +00002192 if( pIdx->aSortOrder[nEq]==SQLITE_SO_ASC ){
drh85eeb692005-12-21 03:16:42 +00002193 topOp = WO_LT|WO_LE;
2194 btmOp = WO_GT|WO_GE;
2195 }else{
2196 topOp = WO_GT|WO_GE;
2197 btmOp = WO_LT|WO_LE;
2198 SWAP(int, topLimit, btmLimit);
2199 }
2200
drh487ab3c2001-11-08 00:45:21 +00002201 /* Generate the termination key. This is the key value that
2202 ** will end the search. There is no termination key if there
drhc27a1ce2002-06-14 20:58:45 +00002203 ** are no equality terms and no "X<..." term.
drhc045ec52002-12-04 20:01:06 +00002204 **
2205 ** 2002-Dec-04: On a reverse-order scan, the so-called "termination"
2206 ** key computed here really ends up being the start key.
drh487ab3c2001-11-08 00:45:21 +00002207 */
drhfe05af82005-07-21 03:14:59 +00002208 if( topLimit ){
drhe8b97272005-07-19 22:22:12 +00002209 Expr *pX;
drhfe05af82005-07-21 03:14:59 +00002210 int k = pIdx->aiColumn[j];
drh85eeb692005-12-21 03:16:42 +00002211 pTerm = findTerm(&wc, iCur, k, notReady, topOp, pIdx);
drhe8b97272005-07-19 22:22:12 +00002212 assert( pTerm!=0 );
2213 pX = pTerm->pExpr;
2214 assert( (pTerm->flags & TERM_CODED)==0 );
2215 sqlite3ExprCode(pParse, pX->pRight);
drhb52076c2006-01-23 13:22:09 +00002216 topEq = pTerm->eOperator & (WO_LE|WO_GE);
drhe8b97272005-07-19 22:22:12 +00002217 disableTerm(pLevel, pTerm);
drh487ab3c2001-11-08 00:45:21 +00002218 testOp = OP_IdxGE;
2219 }else{
drh51147ba2005-07-23 22:59:55 +00002220 testOp = nEq>0 ? OP_IdxGE : OP_Noop;
drh85eeb692005-12-21 03:16:42 +00002221 topEq = 1;
drh487ab3c2001-11-08 00:45:21 +00002222 }
2223 if( testOp!=OP_Noop ){
drh51147ba2005-07-23 22:59:55 +00002224 int nCol = nEq + topLimit;
drh487ab3c2001-11-08 00:45:21 +00002225 pLevel->iMem = pParse->nMem++;
danielk1977327bd592006-01-13 13:01:19 +00002226 buildIndexProbe(v, nCol, nEq, brk, pIdx);
drhfe05af82005-07-21 03:14:59 +00002227 if( bRev ){
drh85eeb692005-12-21 03:16:42 +00002228 int op = topEq ? OP_MoveLe : OP_MoveLt;
drh9012bcb2004-12-19 00:11:35 +00002229 sqlite3VdbeAddOp(v, op, iIdxCur, brk);
drhc045ec52002-12-04 20:01:06 +00002230 }else{
danielk19774adee202004-05-08 08:23:19 +00002231 sqlite3VdbeAddOp(v, OP_MemStore, pLevel->iMem, 1);
drhc045ec52002-12-04 20:01:06 +00002232 }
drhfe05af82005-07-21 03:14:59 +00002233 }else if( bRev ){
drh9012bcb2004-12-19 00:11:35 +00002234 sqlite3VdbeAddOp(v, OP_Last, iIdxCur, brk);
drh487ab3c2001-11-08 00:45:21 +00002235 }
2236
2237 /* Generate the start key. This is the key that defines the lower
drhc27a1ce2002-06-14 20:58:45 +00002238 ** bound on the search. There is no start key if there are no
2239 ** equality terms and if there is no "X>..." term. In
drh487ab3c2001-11-08 00:45:21 +00002240 ** that case, generate a "Rewind" instruction in place of the
2241 ** start key search.
drhc045ec52002-12-04 20:01:06 +00002242 **
2243 ** 2002-Dec-04: In the case of a reverse-order search, the so-called
2244 ** "start" key really ends up being used as the termination key.
drh487ab3c2001-11-08 00:45:21 +00002245 */
drhfe05af82005-07-21 03:14:59 +00002246 if( btmLimit ){
drhe8b97272005-07-19 22:22:12 +00002247 Expr *pX;
drhfe05af82005-07-21 03:14:59 +00002248 int k = pIdx->aiColumn[j];
drh85eeb692005-12-21 03:16:42 +00002249 pTerm = findTerm(&wc, iCur, k, notReady, btmOp, pIdx);
drhe8b97272005-07-19 22:22:12 +00002250 assert( pTerm!=0 );
2251 pX = pTerm->pExpr;
2252 assert( (pTerm->flags & TERM_CODED)==0 );
2253 sqlite3ExprCode(pParse, pX->pRight);
drhb52076c2006-01-23 13:22:09 +00002254 btmEq = pTerm->eOperator & (WO_LE|WO_GE);
drhe8b97272005-07-19 22:22:12 +00002255 disableTerm(pLevel, pTerm);
drh7900ead2001-11-12 13:51:43 +00002256 }else{
drh85eeb692005-12-21 03:16:42 +00002257 btmEq = 1;
drh487ab3c2001-11-08 00:45:21 +00002258 }
drh51147ba2005-07-23 22:59:55 +00002259 if( nEq>0 || btmLimit ){
2260 int nCol = nEq + btmLimit;
danielk1977327bd592006-01-13 13:01:19 +00002261 buildIndexProbe(v, nCol, 0, brk, pIdx);
drhfe05af82005-07-21 03:14:59 +00002262 if( bRev ){
drhc045ec52002-12-04 20:01:06 +00002263 pLevel->iMem = pParse->nMem++;
danielk19774adee202004-05-08 08:23:19 +00002264 sqlite3VdbeAddOp(v, OP_MemStore, pLevel->iMem, 1);
drhc045ec52002-12-04 20:01:06 +00002265 testOp = OP_IdxLT;
2266 }else{
drh85eeb692005-12-21 03:16:42 +00002267 int op = btmEq ? OP_MoveGe : OP_MoveGt;
drh9012bcb2004-12-19 00:11:35 +00002268 sqlite3VdbeAddOp(v, op, iIdxCur, brk);
drhc045ec52002-12-04 20:01:06 +00002269 }
drhfe05af82005-07-21 03:14:59 +00002270 }else if( bRev ){
drhc045ec52002-12-04 20:01:06 +00002271 testOp = OP_Noop;
drh487ab3c2001-11-08 00:45:21 +00002272 }else{
drh9012bcb2004-12-19 00:11:35 +00002273 sqlite3VdbeAddOp(v, OP_Rewind, iIdxCur, brk);
drh487ab3c2001-11-08 00:45:21 +00002274 }
2275
2276 /* Generate the the top of the loop. If there is a termination
2277 ** key we have to test for that key and abort at the top of the
2278 ** loop.
2279 */
danielk19774adee202004-05-08 08:23:19 +00002280 start = sqlite3VdbeCurrentAddr(v);
drh487ab3c2001-11-08 00:45:21 +00002281 if( testOp!=OP_Noop ){
danielk19774adee202004-05-08 08:23:19 +00002282 sqlite3VdbeAddOp(v, OP_MemLoad, pLevel->iMem, 0);
drh9012bcb2004-12-19 00:11:35 +00002283 sqlite3VdbeAddOp(v, testOp, iIdxCur, brk);
drh85eeb692005-12-21 03:16:42 +00002284 if( (topEq && !bRev) || (!btmEq && bRev) ){
danielk19773d1bfea2004-05-14 11:00:53 +00002285 sqlite3VdbeChangeP3(v, -1, "+", P3_STATIC);
2286 }
drh487ab3c2001-11-08 00:45:21 +00002287 }
drh9012bcb2004-12-19 00:11:35 +00002288 sqlite3VdbeAddOp(v, OP_RowKey, iIdxCur, 0);
drh0b2f3162005-12-21 18:36:45 +00002289 sqlite3VdbeAddOp(v, OP_IdxIsNull, nNotNull, cont);
drhe6f85e72004-12-25 01:03:13 +00002290 if( !omitTable ){
drhf0863fe2005-06-12 21:35:51 +00002291 sqlite3VdbeAddOp(v, OP_IdxRowid, iIdxCur, 0);
drhe6f85e72004-12-25 01:03:13 +00002292 sqlite3VdbeAddOp(v, OP_MoveGe, iCur, 0);
drh487ab3c2001-11-08 00:45:21 +00002293 }
2294
2295 /* Record the instruction used to terminate the loop.
2296 */
drhfe05af82005-07-21 03:14:59 +00002297 pLevel->op = bRev ? OP_Prev : OP_Next;
drh9012bcb2004-12-19 00:11:35 +00002298 pLevel->p1 = iIdxCur;
drh487ab3c2001-11-08 00:45:21 +00002299 pLevel->p2 = start;
drh51147ba2005-07-23 22:59:55 +00002300 }else if( pLevel->flags & WHERE_COLUMN_EQ ){
2301 /* Case 4: There is an index and all terms of the WHERE clause that
2302 ** refer to the index using the "==" or "IN" operators.
2303 */
2304 int start;
2305 int nEq = pLevel->nEq;
2306
2307 /* Generate code to evaluate all constraint terms using == or IN
drh8b3d9902005-08-19 00:14:42 +00002308 ** and leave the values of those terms on the stack.
drh51147ba2005-07-23 22:59:55 +00002309 */
2310 codeAllEqualityTerms(pParse, pLevel, &wc, notReady, brk);
2311
2312 /* Generate a single key that will be used to both start and terminate
2313 ** the search
2314 */
danielk1977327bd592006-01-13 13:01:19 +00002315 buildIndexProbe(v, nEq, 0, brk, pIdx);
drh51147ba2005-07-23 22:59:55 +00002316 sqlite3VdbeAddOp(v, OP_MemStore, pLevel->iMem, 0);
2317
2318 /* Generate code (1) to move to the first matching element of the table.
2319 ** Then generate code (2) that jumps to "brk" after the cursor is past
2320 ** the last matching element of the table. The code (1) is executed
2321 ** once to initialize the search, the code (2) is executed before each
2322 ** iteration of the scan to see if the scan has finished. */
2323 if( bRev ){
2324 /* Scan in reverse order */
2325 sqlite3VdbeAddOp(v, OP_MoveLe, iIdxCur, brk);
2326 start = sqlite3VdbeAddOp(v, OP_MemLoad, pLevel->iMem, 0);
2327 sqlite3VdbeAddOp(v, OP_IdxLT, iIdxCur, brk);
2328 pLevel->op = OP_Prev;
2329 }else{
2330 /* Scan in the forward order */
2331 sqlite3VdbeAddOp(v, OP_MoveGe, iIdxCur, brk);
2332 start = sqlite3VdbeAddOp(v, OP_MemLoad, pLevel->iMem, 0);
2333 sqlite3VdbeOp3(v, OP_IdxGE, iIdxCur, brk, "+", P3_STATIC);
2334 pLevel->op = OP_Next;
2335 }
2336 sqlite3VdbeAddOp(v, OP_RowKey, iIdxCur, 0);
2337 sqlite3VdbeAddOp(v, OP_IdxIsNull, nEq, cont);
2338 if( !omitTable ){
2339 sqlite3VdbeAddOp(v, OP_IdxRowid, iIdxCur, 0);
2340 sqlite3VdbeAddOp(v, OP_MoveGe, iCur, 0);
2341 }
2342 pLevel->p1 = iIdxCur;
2343 pLevel->p2 = start;
drhfe05af82005-07-21 03:14:59 +00002344 }else{
2345 /* Case 5: There is no usable index. We must do a complete
2346 ** scan of the entire table.
2347 */
drhfe05af82005-07-21 03:14:59 +00002348 assert( omitTable==0 );
drha6110402005-07-28 20:51:19 +00002349 assert( bRev==0 );
2350 pLevel->op = OP_Next;
drhfe05af82005-07-21 03:14:59 +00002351 pLevel->p1 = iCur;
drha6110402005-07-28 20:51:19 +00002352 pLevel->p2 = 1 + sqlite3VdbeAddOp(v, OP_Rewind, iCur, brk);
drh75897232000-05-29 14:26:00 +00002353 }
drhfe05af82005-07-21 03:14:59 +00002354 notReady &= ~getMask(&maskSet, iCur);
drh75897232000-05-29 14:26:00 +00002355
2356 /* Insert code to test every subexpression that can be completely
2357 ** computed using the current set of tables.
2358 */
drh0fcef5e2005-07-19 17:38:22 +00002359 for(pTerm=wc.a, j=wc.nTerm; j>0; j--, pTerm++){
2360 Expr *pE;
2361 if( pTerm->flags & (TERM_VIRTUAL|TERM_CODED) ) continue;
drhfe05af82005-07-21 03:14:59 +00002362 if( (pTerm->prereqAll & notReady)!=0 ) continue;
drh0fcef5e2005-07-19 17:38:22 +00002363 pE = pTerm->pExpr;
2364 assert( pE!=0 );
drh392e5972005-07-08 14:14:22 +00002365 if( pLevel->iLeftJoin && !ExprHasProperty(pE, EP_FromJoin) ){
drh1f162302002-10-27 19:35:33 +00002366 continue;
2367 }
drh392e5972005-07-08 14:14:22 +00002368 sqlite3ExprIfFalse(pParse, pE, cont, 1);
drh0fcef5e2005-07-19 17:38:22 +00002369 pTerm->flags |= TERM_CODED;
drh75897232000-05-29 14:26:00 +00002370 }
drhad2d8302002-05-24 20:31:36 +00002371
2372 /* For a LEFT OUTER JOIN, generate code that will record the fact that
2373 ** at least one row of the right table has matched the left table.
2374 */
2375 if( pLevel->iLeftJoin ){
danielk19774adee202004-05-08 08:23:19 +00002376 pLevel->top = sqlite3VdbeCurrentAddr(v);
drhd654be82005-09-20 17:42:23 +00002377 sqlite3VdbeAddOp(v, OP_MemInt, 1, pLevel->iLeftJoin);
drhad6d9462004-09-19 02:15:24 +00002378 VdbeComment((v, "# record LEFT JOIN hit"));
drh0aa74ed2005-07-16 13:33:20 +00002379 for(pTerm=wc.a, j=0; j<wc.nTerm; j++, pTerm++){
drh0fcef5e2005-07-19 17:38:22 +00002380 if( pTerm->flags & (TERM_VIRTUAL|TERM_CODED) ) continue;
drhfe05af82005-07-21 03:14:59 +00002381 if( (pTerm->prereqAll & notReady)!=0 ) continue;
drh0fcef5e2005-07-19 17:38:22 +00002382 assert( pTerm->pExpr );
2383 sqlite3ExprIfFalse(pParse, pTerm->pExpr, cont, 1);
2384 pTerm->flags |= TERM_CODED;
drh1cc093c2002-06-24 22:01:57 +00002385 }
drhad2d8302002-05-24 20:31:36 +00002386 }
drh75897232000-05-29 14:26:00 +00002387 }
drh7ec764a2005-07-21 03:48:20 +00002388
2389#ifdef SQLITE_TEST /* For testing and debugging use only */
2390 /* Record in the query plan information about the current table
2391 ** and the index used to access it (if any). If the table itself
2392 ** is not used, its name is just '{}'. If no index is used
2393 ** the index is listed as "{}". If the primary key is used the
2394 ** index name is '*'.
2395 */
2396 for(i=0; i<pTabList->nSrc; i++){
2397 char *z;
2398 int n;
drh7ec764a2005-07-21 03:48:20 +00002399 pLevel = &pWInfo->a[i];
drh29dda4a2005-07-21 18:23:20 +00002400 pTabItem = &pTabList->a[pLevel->iFrom];
drh7ec764a2005-07-21 03:48:20 +00002401 z = pTabItem->zAlias;
2402 if( z==0 ) z = pTabItem->pTab->zName;
2403 n = strlen(z);
2404 if( n+nQPlan < sizeof(sqlite3_query_plan)-10 ){
2405 if( pLevel->flags & WHERE_IDX_ONLY ){
2406 strcpy(&sqlite3_query_plan[nQPlan], "{}");
2407 nQPlan += 2;
2408 }else{
2409 strcpy(&sqlite3_query_plan[nQPlan], z);
2410 nQPlan += n;
2411 }
2412 sqlite3_query_plan[nQPlan++] = ' ';
2413 }
2414 if( pLevel->flags & (WHERE_ROWID_EQ|WHERE_ROWID_RANGE) ){
2415 strcpy(&sqlite3_query_plan[nQPlan], "* ");
2416 nQPlan += 2;
2417 }else if( pLevel->pIdx==0 ){
2418 strcpy(&sqlite3_query_plan[nQPlan], "{} ");
2419 nQPlan += 3;
2420 }else{
2421 n = strlen(pLevel->pIdx->zName);
2422 if( n+nQPlan < sizeof(sqlite3_query_plan)-2 ){
2423 strcpy(&sqlite3_query_plan[nQPlan], pLevel->pIdx->zName);
2424 nQPlan += n;
2425 sqlite3_query_plan[nQPlan++] = ' ';
2426 }
2427 }
2428 }
2429 while( nQPlan>0 && sqlite3_query_plan[nQPlan-1]==' ' ){
2430 sqlite3_query_plan[--nQPlan] = 0;
2431 }
2432 sqlite3_query_plan[nQPlan] = 0;
2433 nQPlan = 0;
2434#endif /* SQLITE_TEST // Testing and debugging use only */
2435
drh29dda4a2005-07-21 18:23:20 +00002436 /* Record the continuation address in the WhereInfo structure. Then
2437 ** clean up and return.
2438 */
drh75897232000-05-29 14:26:00 +00002439 pWInfo->iContinue = cont;
drh0aa74ed2005-07-16 13:33:20 +00002440 whereClauseClear(&wc);
drh75897232000-05-29 14:26:00 +00002441 return pWInfo;
drhe23399f2005-07-22 00:31:39 +00002442
2443 /* Jump here if malloc fails */
2444whereBeginNoMem:
2445 whereClauseClear(&wc);
drh9eff6162006-06-12 21:59:13 +00002446 whereInfoFree(pWInfo);
drhe23399f2005-07-22 00:31:39 +00002447 return 0;
drh75897232000-05-29 14:26:00 +00002448}
2449
2450/*
drhc27a1ce2002-06-14 20:58:45 +00002451** Generate the end of the WHERE loop. See comments on
danielk19774adee202004-05-08 08:23:19 +00002452** sqlite3WhereBegin() for additional information.
drh75897232000-05-29 14:26:00 +00002453*/
danielk19774adee202004-05-08 08:23:19 +00002454void sqlite3WhereEnd(WhereInfo *pWInfo){
drh75897232000-05-29 14:26:00 +00002455 Vdbe *v = pWInfo->pParse->pVdbe;
drh19a775c2000-06-05 18:54:46 +00002456 int i;
drh6b563442001-11-07 16:48:26 +00002457 WhereLevel *pLevel;
drhad3cab52002-05-24 02:04:32 +00002458 SrcList *pTabList = pWInfo->pTabList;
drh19a775c2000-06-05 18:54:46 +00002459
drh9012bcb2004-12-19 00:11:35 +00002460 /* Generate loop termination code.
2461 */
drhad3cab52002-05-24 02:04:32 +00002462 for(i=pTabList->nSrc-1; i>=0; i--){
drh6b563442001-11-07 16:48:26 +00002463 pLevel = &pWInfo->a[i];
danielk19774adee202004-05-08 08:23:19 +00002464 sqlite3VdbeResolveLabel(v, pLevel->cont);
drh6b563442001-11-07 16:48:26 +00002465 if( pLevel->op!=OP_Noop ){
danielk19774adee202004-05-08 08:23:19 +00002466 sqlite3VdbeAddOp(v, pLevel->op, pLevel->p1, pLevel->p2);
drh19a775c2000-06-05 18:54:46 +00002467 }
danielk19774adee202004-05-08 08:23:19 +00002468 sqlite3VdbeResolveLabel(v, pLevel->brk);
drhe23399f2005-07-22 00:31:39 +00002469 if( pLevel->nIn ){
2470 int *a;
2471 int j;
drhffe0f892006-05-11 13:26:25 +00002472 for(j=pLevel->nIn, a=&pLevel->aInLoop[j*2-2]; j>0; j--, a-=2){
2473 sqlite3VdbeAddOp(v, OP_Next, a[0], a[1]);
2474 sqlite3VdbeJumpHere(v, a[1]-1);
drhe23399f2005-07-22 00:31:39 +00002475 }
2476 sqliteFree(pLevel->aInLoop);
drhd99f7062002-06-08 23:25:08 +00002477 }
drhad2d8302002-05-24 20:31:36 +00002478 if( pLevel->iLeftJoin ){
2479 int addr;
drhd654be82005-09-20 17:42:23 +00002480 addr = sqlite3VdbeAddOp(v, OP_IfMemPos, pLevel->iLeftJoin, 0);
danielk19774adee202004-05-08 08:23:19 +00002481 sqlite3VdbeAddOp(v, OP_NullRow, pTabList->a[i].iCursor, 0);
drh9012bcb2004-12-19 00:11:35 +00002482 if( pLevel->iIdxCur>=0 ){
2483 sqlite3VdbeAddOp(v, OP_NullRow, pLevel->iIdxCur, 0);
drh7f09b3e2002-08-13 13:15:49 +00002484 }
danielk19774adee202004-05-08 08:23:19 +00002485 sqlite3VdbeAddOp(v, OP_Goto, 0, pLevel->top);
drhd654be82005-09-20 17:42:23 +00002486 sqlite3VdbeJumpHere(v, addr);
drhad2d8302002-05-24 20:31:36 +00002487 }
drh19a775c2000-06-05 18:54:46 +00002488 }
drh9012bcb2004-12-19 00:11:35 +00002489
2490 /* The "break" point is here, just past the end of the outer loop.
2491 ** Set it.
2492 */
danielk19774adee202004-05-08 08:23:19 +00002493 sqlite3VdbeResolveLabel(v, pWInfo->iBreak);
drh9012bcb2004-12-19 00:11:35 +00002494
drh29dda4a2005-07-21 18:23:20 +00002495 /* Close all of the cursors that were opened by sqlite3WhereBegin.
drh9012bcb2004-12-19 00:11:35 +00002496 */
drh29dda4a2005-07-21 18:23:20 +00002497 for(i=0, pLevel=pWInfo->a; i<pTabList->nSrc; i++, pLevel++){
2498 struct SrcList_item *pTabItem = &pTabList->a[pLevel->iFrom];
drh9012bcb2004-12-19 00:11:35 +00002499 Table *pTab = pTabItem->pTab;
drh5cf590c2003-04-24 01:45:04 +00002500 assert( pTab!=0 );
drhb9bb7c12006-06-11 23:41:55 +00002501 if( pTab->isEphem || pTab->pSelect ) continue;
drhfe05af82005-07-21 03:14:59 +00002502 if( (pLevel->flags & WHERE_IDX_ONLY)==0 ){
drh9012bcb2004-12-19 00:11:35 +00002503 sqlite3VdbeAddOp(v, OP_Close, pTabItem->iCursor, 0);
2504 }
drh6b563442001-11-07 16:48:26 +00002505 if( pLevel->pIdx!=0 ){
drh9012bcb2004-12-19 00:11:35 +00002506 sqlite3VdbeAddOp(v, OP_Close, pLevel->iIdxCur, 0);
2507 }
2508
drhacf3b982005-01-03 01:27:18 +00002509 /* Make cursor substitutions for cases where we want to use
drh9012bcb2004-12-19 00:11:35 +00002510 ** just the index and never reference the table.
2511 **
2512 ** Calls to the code generator in between sqlite3WhereBegin and
2513 ** sqlite3WhereEnd will have created code that references the table
2514 ** directly. This loop scans all that code looking for opcodes
2515 ** that reference the table and converts them into opcodes that
2516 ** reference the index.
2517 */
drhfe05af82005-07-21 03:14:59 +00002518 if( pLevel->flags & WHERE_IDX_ONLY ){
danielk1977f0113002006-01-24 12:09:17 +00002519 int k, j, last;
drh9012bcb2004-12-19 00:11:35 +00002520 VdbeOp *pOp;
2521 Index *pIdx = pLevel->pIdx;
2522
2523 assert( pIdx!=0 );
2524 pOp = sqlite3VdbeGetOp(v, pWInfo->iTop);
2525 last = sqlite3VdbeCurrentAddr(v);
danielk1977f0113002006-01-24 12:09:17 +00002526 for(k=pWInfo->iTop; k<last; k++, pOp++){
drh9012bcb2004-12-19 00:11:35 +00002527 if( pOp->p1!=pLevel->iTabCur ) continue;
2528 if( pOp->opcode==OP_Column ){
2529 pOp->p1 = pLevel->iIdxCur;
2530 for(j=0; j<pIdx->nColumn; j++){
2531 if( pOp->p2==pIdx->aiColumn[j] ){
2532 pOp->p2 = j;
2533 break;
2534 }
2535 }
drhf0863fe2005-06-12 21:35:51 +00002536 }else if( pOp->opcode==OP_Rowid ){
drh9012bcb2004-12-19 00:11:35 +00002537 pOp->p1 = pLevel->iIdxCur;
drhf0863fe2005-06-12 21:35:51 +00002538 pOp->opcode = OP_IdxRowid;
danielk19776c18b6e2005-01-30 09:17:58 +00002539 }else if( pOp->opcode==OP_NullRow ){
2540 pOp->opcode = OP_Noop;
drh9012bcb2004-12-19 00:11:35 +00002541 }
2542 }
drh6b563442001-11-07 16:48:26 +00002543 }
drh19a775c2000-06-05 18:54:46 +00002544 }
drh9012bcb2004-12-19 00:11:35 +00002545
2546 /* Final cleanup
2547 */
drh9eff6162006-06-12 21:59:13 +00002548 whereInfoFree(pWInfo);
drh75897232000-05-29 14:26:00 +00002549 return;
2550}